{ "PropertyTypes": { "AWS::ACMPCA::Certificate.ApiPassthrough": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.ApiPassthrough`\n\nContains X.509 certificate information to be placed in an issued certificate. An\n`APIPassthrough` or `APICSRPassthrough` template variant must\nbe selected, or else this parameter is ignored.\nIf conflicting or duplicate certificate information is supplied from other sources,\nAWS Private CA applies [order of\noperation rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) to determine what information is used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html", "Properties": { "Extensions": { "MarkdownDocumentation": "`Extensions`\n\nSpecifies X.509 extension information for a certificate.\n*Required*: No\n*Type*: [Extensions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html#cfn-acmpca-certificate-apipassthrough-extensions", "UpdateType": "Immutable", "Required": false, "Type": "Extensions" }, "Subject": { "MarkdownDocumentation": "`Subject`\n\nContains information about the certificate subject. The Subject field in the\ncertificate identifies the entity that owns or controls the public key in the\ncertificate. The entity can be a user, computer, device, or service. The Subject must\ncontain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished\nnames (RDNs). The RDNs are separated by commas in the certificate.\n*Required*: No\n*Type*: [Subject](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html#cfn-acmpca-certificate-apipassthrough-subject", "UpdateType": "Immutable", "Required": false, "Type": "Subject" } } }, "AWS::ACMPCA::Certificate.CustomAttribute": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.CustomAttribute`\n\nDefines the X.500 relative distinguished name (RDN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html#cfn-acmpca-certificate-customattribute-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ObjectIdentifier": { "MarkdownDocumentation": "`ObjectIdentifier`\n\nSpecifies the object identifier (OID) of the attribute type of the relative\ndistinguished name (RDN).\n*Required*: Yes\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html#cfn-acmpca-certificate-customattribute-objectidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ACMPCA::Certificate.CustomExtension": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.CustomExtension`\n\nSpecifies the X.509 extension information for a certificate.\nExtensions present in `CustomExtensions` follow the\n`ApiPassthrough`[template\nrules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nSpecifies the base64-encoded value of the X.509 extension.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Critical": { "MarkdownDocumentation": "`Critical`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-critical", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ObjectIdentifier": { "MarkdownDocumentation": "`ObjectIdentifier`\n\nSpecifies the object identifier (OID) of the X.509 extension. For more information,\nsee the [Global OID reference database.](https://oidref.com/2.5.29)\n*Required*: Yes\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-objectidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ACMPCA::Certificate.EdiPartyName": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.EdiPartyName`\n\nDescribes an Electronic Data Interchange (EDI) entity as described in as defined in\n[Subject Alternative\nName](https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-edipartyname.html", "Properties": { "PartyName": { "MarkdownDocumentation": "`PartyName`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-edipartyname.html#cfn-acmpca-certificate-edipartyname-partyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NameAssigner": { "MarkdownDocumentation": "`NameAssigner`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-edipartyname.html#cfn-acmpca-certificate-edipartyname-nameassigner", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ACMPCA::Certificate.ExtendedKeyUsage": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.ExtendedKeyUsage`\n\nSpecifies additional purposes for which the certified public key may be used other\nthan basic purposes indicated in the `KeyUsage` extension.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html", "Properties": { "ExtendedKeyUsageType": { "MarkdownDocumentation": "`ExtendedKeyUsageType`\n\nSpecifies a standard `ExtendedKeyUsage` as defined as in [RFC\n5280](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12).\n*Required*: No\n*Type*: String\n*Allowed values*: `SERVER_AUTH | CLIENT_AUTH |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SERVER_AUTH", "CLIENT_AUTH", "CODE_SIGNING", "EMAIL_PROTECTION", "TIME_STAMPING", "OCSP_SIGNING", "SMART_CARD_LOGIN", "DOCUMENT_SIGNING", "CERTIFICATE_TRANSPARENCY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusagetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExtendedKeyUsageObjectIdentifier": { "MarkdownDocumentation": "`ExtendedKeyUsageObjectIdentifier`\n\nSpecifies a custom `ExtendedKeyUsage` with an object identifier\n(OID).\n*Required*: No\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusageobjectidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ACMPCA::Certificate.Extensions": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.Extensions`\n\nContains X.509 extension information for a certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html", "Properties": { "CustomExtensions": { "MarkdownDocumentation": "`CustomExtensions`\n\nContains a sequence of one or more X.509 extensions, each of which consists of an\nobject identifier (OID), a base64-encoded value, and the critical flag. For more\ninformation, see the [Global OID reference\ndatabase.](https://oidref.com/2.5.29)\n*Required*: No\n*Type*: Array of [CustomExtension](./aws-properties-acmpca-certificate-customextension.html)\n*Minimum*: `1`\n*Maximum*: `150`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-customextensions", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "CustomExtension", "DuplicatesAllowed": true }, "CertificatePolicies": { "MarkdownDocumentation": "`CertificatePolicies`\n\nContains a sequence of one or more policy information terms, each of which consists of\nan object identifier (OID) and optional qualifiers. For more information, see NIST's\ndefinition of [Object\nIdentifier (OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).\nIn an end-entity certificate, these terms indicate the policy under which the\ncertificate was issued and the purposes for which it may be used. In a CA certificate,\nthese terms limit the set of policies for certification paths that include this\ncertificate.\n*Required*: No\n*Type*: Array of [PolicyInformation](./aws-properties-acmpca-certificate-policyinformation.html)\n*Minimum*: `1`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-certificatepolicies", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "PolicyInformation", "DuplicatesAllowed": true }, "KeyUsage": { "MarkdownDocumentation": "`KeyUsage`\n\nDefines one or more purposes for which the key contained in the certificate can be\nused. Default value for each option is false.\n*Required*: No\n*Type*: [KeyUsage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-keyusage", "UpdateType": "Immutable", "Required": false, "Type": "KeyUsage" }, "SubjectAlternativeNames": { "MarkdownDocumentation": "`SubjectAlternativeNames`\n\nThe subject alternative name extension allows identities to be bound to the subject of\nthe certificate. These identities may be included in addition to or in place of the\nidentity in the subject field of the certificate.\n*Required*: No\n*Type*: Array of [GeneralName](./aws-properties-acmpca-certificate-generalname.html)\n*Minimum*: `1`\n*Maximum*: `150`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-subjectalternativenames", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "GeneralName", "DuplicatesAllowed": true }, "ExtendedKeyUsage": { "MarkdownDocumentation": "`ExtendedKeyUsage`\n\nSpecifies additional purposes for which the certified public key may be used other\nthan basic purposes indicated in the `KeyUsage` extension.\n*Required*: No\n*Type*: [Array](./aws-properties-acmpca-certificate-extendedkeyusage.html) of [ExtendedKeyUsage](./aws-properties-acmpca-certificate-extendedkeyusage.html)\n*Minimum*: `1`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-extendedkeyusage", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ExtendedKeyUsage", "DuplicatesAllowed": true } } }, "AWS::ACMPCA::Certificate.GeneralName": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.GeneralName`\n\nDescribes an ASN.1 X.400 `GeneralName` as defined in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280). Only one of\nthe following naming options should be provided. Providing more than one option results\nin an `InvalidArgsException` error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html", "Properties": { "UniformResourceIdentifier": { "MarkdownDocumentation": "`UniformResourceIdentifier`\n\nRepresents `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-uniformresourceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DnsName": { "MarkdownDocumentation": "`DnsName`\n\nRepresents `GeneralName` as a DNS name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-dnsname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EdiPartyName": { "MarkdownDocumentation": "`EdiPartyName`\n\nRepresents `GeneralName` as an `EdiPartyName` object.\n*Required*: No\n*Type*: [EdiPartyName](./aws-properties-acmpca-certificate-edipartyname.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-edipartyname", "UpdateType": "Immutable", "Required": false, "Type": "EdiPartyName" }, "RegisteredId": { "MarkdownDocumentation": "`RegisteredId`\n\nRepresents `GeneralName` as an object identifier (OID).\n*Required*: No\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-registeredid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Rfc822Name": { "MarkdownDocumentation": "`Rfc822Name`\n\nRepresents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email\naddress.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-rfc822name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OtherName": { "MarkdownDocumentation": "`OtherName`\n\nRepresents `GeneralName` using an `OtherName` object.\n*Required*: No\n*Type*: [OtherName](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-othername", "UpdateType": "Immutable", "Required": false, "Type": "OtherName" }, "IpAddress": { "MarkdownDocumentation": "`IpAddress`\n\nRepresents `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-ipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DirectoryName": { "MarkdownDocumentation": "`DirectoryName`\n\nContains information about the certificate subject. The certificate can be one issued\nby your private certificate authority (CA) or it can be your private CA certificate. The\nSubject field in the certificate identifies the entity that owns or controls the public\nkey in the certificate. The entity can be a user, computer, device, or service. The\nSubject must contain an X.500 distinguished name (DN). A DN is a sequence of relative\ndistinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN\nmust be unique for each entity, but your private CA can issue more than one certificate\nwith the same DN to the same entity.\n*Required*: No\n*Type*: [Subject](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html#cfn-acmpca-certificate-generalname-directoryname", "UpdateType": "Immutable", "Required": false, "Type": "Subject" } } }, "AWS::ACMPCA::Certificate.KeyUsage": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.KeyUsage`\n\nDefines one or more purposes for which the key contained in the certificate can be\nused. Default value for each option is false.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html", "Properties": { "KeyEncipherment": { "MarkdownDocumentation": "`KeyEncipherment`\n\nKey can be used to encipher data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-keyencipherment", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DataEncipherment": { "MarkdownDocumentation": "`DataEncipherment`\n\nKey can be used to decipher data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-dataencipherment", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DigitalSignature": { "MarkdownDocumentation": "`DigitalSignature`\n\nKey can be used for digital signing.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-digitalsignature", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyCertSign": { "MarkdownDocumentation": "`KeyCertSign`\n\nKey can be used to sign certificates.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-keycertsign", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DecipherOnly": { "MarkdownDocumentation": "`DecipherOnly`\n\nKey can be used only to decipher data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-decipheronly", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyAgreement": { "MarkdownDocumentation": "`KeyAgreement`\n\nKey can be used in a key-agreement protocol.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-keyagreement", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "NonRepudiation": { "MarkdownDocumentation": "`NonRepudiation`\n\nKey can be used for non-repudiation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-nonrepudiation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "CRLSign": { "MarkdownDocumentation": "`CRLSign`\n\nKey can be used to sign CRLs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-crlsign", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EncipherOnly": { "MarkdownDocumentation": "`EncipherOnly`\n\nKey can be used only to encipher data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html#cfn-acmpca-certificate-keyusage-encipheronly", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ACMPCA::Certificate.OtherName": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.OtherName`\n\nDefines a custom ASN.1 X.400 `GeneralName` using an object identifier (OID)\nand value. The OID must satisfy the regular expression shown below. For more\ninformation, see NIST's definition of [Object Identifier\n(OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-othername.html", "Properties": { "TypeId": { "MarkdownDocumentation": "`TypeId`\n\nSpecifies an OID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-othername.html#cfn-acmpca-certificate-othername-typeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nSpecifies an OID value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-othername.html#cfn-acmpca-certificate-othername-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ACMPCA::Certificate.PolicyInformation": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.PolicyInformation`\n\nDefines the X.509 `CertificatePolicies` extension.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html", "Properties": { "CertPolicyId": { "MarkdownDocumentation": "`CertPolicyId`\n\nSpecifies the object identifier (OID) of the certificate policy under which the\ncertificate was issued. For more information, see NIST's definition of [Object Identifier\n(OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).\n*Required*: Yes\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html#cfn-acmpca-certificate-policyinformation-certpolicyid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyQualifiers": { "MarkdownDocumentation": "`PolicyQualifiers`\n\nModifies the given `CertPolicyId` with a qualifier. AWS Private CA supports the\ncertification practice statement (CPS) qualifier.\n*Required*: No\n*Type*: Array of [PolicyQualifierInfo](./aws-properties-acmpca-certificate-policyqualifierinfo.html)\n*Minimum*: `1`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html#cfn-acmpca-certificate-policyinformation-policyqualifiers", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "PolicyQualifierInfo", "DuplicatesAllowed": true } } }, "AWS::ACMPCA::Certificate.PolicyQualifierInfo": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.PolicyQualifierInfo`\n\nModifies the `CertPolicyId` of a `PolicyInformation` object with\na qualifier. AWS Private CA supports the certification practice statement (CPS)\nqualifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html", "Properties": { "Qualifier": { "MarkdownDocumentation": "`Qualifier`\n\nDefines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier\nin this field.\n*Required*: Yes\n*Type*: [Qualifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html#cfn-acmpca-certificate-policyqualifierinfo-qualifier", "UpdateType": "Immutable", "Required": true, "Type": "Qualifier" }, "PolicyQualifierId": { "MarkdownDocumentation": "`PolicyQualifierId`\n\nIdentifies 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)\n", "RefReturnValue": "", "AllowedValues": [ "CPS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html#cfn-acmpca-certificate-policyqualifierinfo-policyqualifierid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ACMPCA::Certificate.Qualifier": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.Qualifier`\n\nDefines a `PolicyInformation` qualifier. AWS Private CA supports the [certification\npractice statement (CPS) qualifier](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC 5280.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html", "Properties": { "CpsUri": { "MarkdownDocumentation": "`CpsUri`\n\nContains a pointer to a certification practice statement (CPS) published by the\nCA.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html#cfn-acmpca-certificate-qualifier-cpsuri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ACMPCA::Certificate.Subject": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.Subject`\n\nContains information about the certificate subject. The `Subject` field in\nthe certificate identifies the entity that owns or controls the public key in the\ncertificate. 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\ndistinguished names (RDNs). The RDNs are separated by commas in the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html", "Properties": { "Organization": { "MarkdownDocumentation": "`Organization`\n\nLegal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-organization", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OrganizationalUnit": { "MarkdownDocumentation": "`OrganizationalUnit`\n\nA subdivision or unit of the organization (such as sales or finance) with which the\ncertificate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-organizationalunit", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Locality": { "MarkdownDocumentation": "`Locality`\n\nThe locality (such as a city or town) in which the certificate subject is\nlocated.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-locality", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nA title such as Mr. or Ms., which is pre-pended to the name to refer formally to the\ncertificate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-title", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GivenName": { "MarkdownDocumentation": "`GivenName`\n\nFirst 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-givenname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GenerationQualifier": { "MarkdownDocumentation": "`GenerationQualifier`\n\nTypically a qualifier appended to the name of an individual. Examples include Jr. for\njunior, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-generationqualifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Initials": { "MarkdownDocumentation": "`Initials`\n\nConcatenation that typically contains the first letter of the **GivenName**, the first letter of the middle name if one exists, and the\nfirst 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-initials", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CustomAttributes": { "MarkdownDocumentation": "`CustomAttributes`\n\nContains a sequence of one or more X.500 relative distinguished names (RDNs), each of\nwhich consists of an object identifier (OID) and a value. For more information, see\nNIST\u2019s definition of [Object Identifier (OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).\n###### Note\nCustom attributes cannot be used in combination with standard attributes.\n*Required*: No\n*Type*: Array of [CustomAttribute](./aws-properties-acmpca-certificate-customattribute.html)\n*Minimum*: `1`\n*Maximum*: `150`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-customattributes", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "CustomAttribute", "DuplicatesAllowed": true }, "SerialNumber": { "MarkdownDocumentation": "`SerialNumber`\n\nThe certificate serial number.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9'()+-.?:/= ]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-serialnumber", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nState in which the subject of the certificate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-state", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Country": { "MarkdownDocumentation": "`Country`\n\nTwo-digit code that specifies the country in which the certificate subject\nlocated.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z]{2}`\n*Minimum*: `2`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-country", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Surname": { "MarkdownDocumentation": "`Surname`\n\nFamily name. In the US and the UK, for example, the surname of an individual is\nordered last. In Asian cultures the surname is typically ordered first.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-surname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DistinguishedNameQualifier": { "MarkdownDocumentation": "`DistinguishedNameQualifier`\n\nDisambiguating information for the certificate subject.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9'()+-.?:/= ]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-distinguishednamequalifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CommonName": { "MarkdownDocumentation": "`CommonName`\n\nFor CA and end-entity certificates in a private PKI, the common name (CN) can be any\nstring within the length limit.\nNote: In publicly trusted certificates, the common name must be a fully qualified\ndomain 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-commonname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Pseudonym": { "MarkdownDocumentation": "`Pseudonym`\n\nTypically a shortened version of a longer **GivenName**.\nFor example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth,\nLiz, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-subject-pseudonym", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ACMPCA::Certificate.Validity": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate.Validity`\n\nLength of time for which the certificate issued by your private certificate authority\n(CA), or by the private CA itself, is valid in days, months, or years. You can issue a\ncertificate by calling the `IssueCertificate` operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies whether the `Value` parameter represents days, months, or\nyears.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `END_DATE | ABSOLUTE | DAYS ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "END_DATE", "ABSOLUTE", "DAYS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html#cfn-acmpca-certificate-validity-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA long integer interpreted according to the value of `Type`, below.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html#cfn-acmpca-certificate-validity-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::ACMPCA::CertificateAuthority.AccessDescription": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.AccessDescription`\n\nProvides access information used by the `authorityInfoAccess` and\n`subjectInfoAccess` extensions described in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html", "Properties": { "AccessMethod": { "MarkdownDocumentation": "`AccessMethod`\n\nThe type and format of `AccessDescription` information.\n*Required*: Yes\n*Type*: [AccessMethod](./aws-properties-acmpca-certificateauthority-accessmethod.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html#cfn-acmpca-certificateauthority-accessdescription-accessmethod", "UpdateType": "Immutable", "Required": true, "Type": "AccessMethod" }, "AccessLocation": { "MarkdownDocumentation": "`AccessLocation`\n\nThe location of `AccessDescription` information.\n*Required*: Yes\n*Type*: [GeneralName](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html#cfn-acmpca-certificateauthority-accessdescription-accesslocation", "UpdateType": "Immutable", "Required": true, "Type": "GeneralName" } } }, "AWS::ACMPCA::CertificateAuthority.AccessMethod": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.AccessMethod`\n\nDescribes the type and format of extension access. Only one of\n`CustomObjectIdentifier` or `AccessMethodType` may be\nprovided. Providing both results in `InvalidArgsException`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessmethod.html", "Properties": { "CustomObjectIdentifier": { "MarkdownDocumentation": "`CustomObjectIdentifier`\n\nAn object identifier (OID) specifying the `AccessMethod`. The OID must\nsatisfy the regular expression shown below. For more information, see NIST's definition\nof [Object Identifier\n(OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).\n*Required*: No\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessmethod.html#cfn-acmpca-certificateauthority-accessmethod-customobjectidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AccessMethodType": { "MarkdownDocumentation": "`AccessMethodType`\n\nSpecifies the `AccessMethod`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CA_REPOSITORY | RESOURCE_PK...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CA_REPOSITORY", "RESOURCE_PKI_MANIFEST", "RESOURCE_PKI_NOTIFY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessmethod.html#cfn-acmpca-certificateauthority-accessmethod-accessmethodtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ACMPCA::CertificateAuthority.CrlConfiguration": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.CrlConfiguration`\n\nContains configuration information for a certificate revocation list (CRL). Your\nprivate certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You\ncan enable CRLs for your new or an existing private CA by setting the **Enabled** parameter to `true`. Your private CA\nwrites CRLs to an S3 bucket that you specify in the **S3BucketName** parameter. You can hide the name of your bucket by\nspecifying a value for the **CustomCname** parameter. Your\nprivate CA by default copies the CNAME or the S3 bucket name to the **CRL\nDistribution Points** extension of each certificate it issues. If you want to configure\nthis default behavior to be something different, you can set the **CrlDistributionPointExtensionConfiguration**\nparameter. Your S3 bucket policy must give write permission to AWS Private CA.\nAWS Private CA assets that are stored in Amazon S3 can be protected with\nencryption. For more information, see [Encrypting Your\nCRLs](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption).\nYour private CA uses the value in the **ExpirationInDays** parameter to calculate the **nextUpdate** field in the CRL. The CRL is refreshed prior to a\ncertificate's expiration date or when a certificate is revoked. When a certificate is\nrevoked, it appears in the CRL until the certificate expires, and then in one additional\nCRL after expiration, and it always appears in the audit report.\nA CRL is typically updated approximately 30 minutes after a certificate is revoked. If\nfor any reason a CRL update fails, AWS Private CA makes further attempts\nevery 15 minutes.\nCRLs contain the following fields:\n* **Version**: The current version number defined in\n RFC 5280 is V2. The integer value is 0x1.\n* **Signature Algorithm**: The name of the algorithm\n used to sign the CRL.\n* **Issuer**: The X.500 distinguished name of your\n private CA that issued the CRL.\n* **Last Update**: The issue date and time of this\n CRL.\n* **Next Update**: The day and time by which the next\n CRL will be issued.\n* **Revoked Certificates**: List of revoked\n certificates. Each list item contains the following information.\n \n + **Serial Number**: The serial number, in\n hexadecimal format, of the revoked certificate.\n + **Revocation Date**: Date and time the\n certificate was revoked.\n + **CRL Entry Extensions**: Optional\n extensions for the CRL entry.\n \n - **X509v3 CRL Reason Code**: Reason\n the certificate was revoked.\n* **CRL Extensions**: Optional extensions for the\n CRL.\n \n + **X509v3 Authority Key Identifier**:\n Identifies the public key associated with the private key used to sign\n the certificate.\n + **X509v3 CRL Number:**: Decimal sequence\n number for the CRL.\n* **Signature Algorithm**: Algorithm used by your\n private CA to sign the CRL.\n* **Signature Value**: Signature computed over the\n CRL.\nCertificate revocation lists created by AWS Private CA are DER-encoded.\nYou can use the following OpenSSL command to list a CRL.\n`openssl crl -inform DER -text -in crl_path -noout`\nFor more information, see [Planning a certificate revocation\nlist (CRL)](https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html) in the *AWS Private Certificate Authority User Guide*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html", "Properties": { "CrlDistributionPointExtensionConfiguration": { "MarkdownDocumentation": "`CrlDistributionPointExtensionConfiguration`\n\nConfigures the default behavior of the CRL Distribution Point extension for certificates issued by your CA. If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL.\n*Required*: No\n*Type*: [CrlDistributionPointExtensionConfiguration](./aws-properties-acmpca-certificateauthority-crldistributionpointextensionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-crldistributionpointextensionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CrlDistributionPointExtensionConfiguration" }, "CustomCname": { "MarkdownDocumentation": "`CustomCname`\n\nName inserted into the certificate **CRL Distribution\nPoints** extension that enables the use of an alias for the CRL\ndistribution point. Use this value if you don't want the name of your S3 bucket to be\npublic.\n###### Note\nThe content of a Canonical Name (CNAME) record must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the\nuse of special characters in URIs. Additionally, the value of the CNAME must not\ninclude a protocol prefix such as \"http://\" or \"https://\".\n*Required*: No\n*Type*: String\n*Pattern*: `[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-customcname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3ObjectAcl": { "MarkdownDocumentation": "`S3ObjectAcl`\n\nDetermines whether the CRL will be publicly readable or privately held in the CRL\nAmazon S3 bucket. If you choose PUBLIC\\_READ, the CRL will be accessible over the public\ninternet. If you choose BUCKET\\_OWNER\\_FULL\\_CONTROL, only the owner of the CRL S3 bucket\ncan access the CRL, and your PKI clients may need an alternative method of\naccess.\nIf no value is specified, the default is PUBLIC\\_READ.\n*Note:* This default can cause CA creation to fail in some\ncircumstances. If you have have enabled the Block Public Access (BPA) feature in your S3\naccount, then you must specify the value of this parameter as\n`BUCKET_OWNER_FULL_CONTROL`, and not doing so results in an error. If you\nhave disabled BPA in S3, then you can specify either\n`BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the\nvalue.\nFor more information, see [Blocking public access to\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-s3objectacl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrlType": { "MarkdownDocumentation": "`CrlType`\n\nSpecifies the type of CRL. This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see [AWS Private CA quotas](https://docs.aws.amazon.com/general/latest/gr/pca.html#limits_pca).\n* `COMPLETE` - The default setting. AWS Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that AWS Private CA issues is bound to a specific CRL through the CRL distribution point (CDP) defined in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280).\n* `PARTITIONED` - Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue.\n \n ###### Important\n \n When using partitioned CRLs, you must validate that the CRL's associated\n issuing distribution point (IDP) URI matches the certi\ufb01cate's CDP URI to ensure\n the right CRL has been fetched. AWS Private CA marks the IDP extension as critical,\n which your client must be able to process.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-crltype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExpirationInDays": { "MarkdownDocumentation": "`ExpirationInDays`\n\nValidity 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-expirationindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nBoolean value that specifies whether certificate revocation lists (CRLs) are enabled.\nYou can use this value to enable certificate revocation for a new CA when you call the\n`CreateCertificateAuthority` operation or for an existing CA when you\ncall the `UpdateCertificateAuthority` operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nName of the S3 bucket that contains the CRL. If you do not provide a value for the\n**CustomCname** argument, the name of your S3 bucket\nis placed into the **CRL Distribution Points** extension of\nthe 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\npolicy](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies) that allows AWS Private CA to write the CRL to your bucket.\n###### Note\nThe `S3BucketName` parameter must conform to the [S3\nbucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[-a-zA-Z0-9._/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-s3bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomPath": { "MarkdownDocumentation": "`CustomPath`\n\nDesignates a custom file path in S3 for CRL(s). For example, `http:////.crl`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-custompath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ACMPCA::CertificateAuthority.CrlDistributionPointExtensionConfiguration": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.CrlDistributionPointExtensionConfiguration`\n\nContains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA. This extension\ncontains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension\nomitted or not in certificates issued by your CA, you can set the **OmitExtension** parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crldistributionpointextensionconfiguration.html", "Properties": { "OmitExtension": { "MarkdownDocumentation": "`OmitExtension`\n\nConfigures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to `true`, then the CDP extension will\nnot be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.\n###### Note\nOnly set this if you have another way to distribute the CRL Distribution Points for certificates issued by your CA, such as the Matter Distributed Compliance Ledger.\nThis configuration cannot be enabled with a custom CNAME set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crldistributionpointextensionconfiguration.html#cfn-acmpca-certificateauthority-crldistributionpointextensionconfiguration-omitextension", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::ACMPCA::CertificateAuthority.CsrExtensions": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.CsrExtensions`\n\nDescribes the certificate extensions to be added to the certificate signing request\n(CSR).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html", "Properties": { "KeyUsage": { "MarkdownDocumentation": "`KeyUsage`\n\nIndicates the purpose of the certificate and of the key contained in the\ncertificate.\n*Required*: No\n*Type*: [KeyUsage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html#cfn-acmpca-certificateauthority-csrextensions-keyusage", "UpdateType": "Immutable", "Required": false, "Type": "KeyUsage" }, "SubjectInformationAccess": { "MarkdownDocumentation": "`SubjectInformationAccess`\n\nFor CA certificates, provides a path to additional information pertaining to the CA,\nsuch as revocation and policy. For more information, see [Subject\nInformation Access](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2) in RFC 5280.\n*Required*: No\n*Type*: Array of [AccessDescription](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html#cfn-acmpca-certificateauthority-csrextensions-subjectinformationaccess", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AccessDescription", "DuplicatesAllowed": true } } }, "AWS::ACMPCA::CertificateAuthority.CustomAttribute": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.CustomAttribute`\n\nDefines the X.500 relative distinguished name (RDN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html#cfn-acmpca-certificateauthority-customattribute-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ObjectIdentifier": { "MarkdownDocumentation": "`ObjectIdentifier`\n\nSpecifies the object identifier (OID) of the attribute type of the relative\ndistinguished name (RDN).\n*Required*: Yes\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html#cfn-acmpca-certificateauthority-customattribute-objectidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ACMPCA::CertificateAuthority.EdiPartyName": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.EdiPartyName`\n\nDescribes an Electronic Data Interchange (EDI) entity as described in as defined in\n[Subject Alternative\nName](https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-edipartyname.html", "Properties": { "PartyName": { "MarkdownDocumentation": "`PartyName`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-edipartyname.html#cfn-acmpca-certificateauthority-edipartyname-partyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NameAssigner": { "MarkdownDocumentation": "`NameAssigner`\n\nSpecifies the name assigner.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-edipartyname.html#cfn-acmpca-certificateauthority-edipartyname-nameassigner", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ACMPCA::CertificateAuthority.GeneralName": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.GeneralName`\n\nDescribes an ASN.1 X.400 `GeneralName` as defined in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280). Only one of\nthe following naming options should be provided. Providing more than one option results\nin an `InvalidArgsException` error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html", "Properties": { "UniformResourceIdentifier": { "MarkdownDocumentation": "`UniformResourceIdentifier`\n\nRepresents `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-uniformresourceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DnsName": { "MarkdownDocumentation": "`DnsName`\n\nRepresents `GeneralName` as a DNS name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-dnsname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EdiPartyName": { "MarkdownDocumentation": "`EdiPartyName`\n\nRepresents `GeneralName` as an `EdiPartyName` object.\n*Required*: No\n*Type*: [EdiPartyName](./aws-properties-acmpca-certificateauthority-edipartyname.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-edipartyname", "UpdateType": "Immutable", "Required": false, "Type": "EdiPartyName" }, "RegisteredId": { "MarkdownDocumentation": "`RegisteredId`\n\nRepresents `GeneralName` as an object identifier (OID).\n*Required*: No\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-registeredid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Rfc822Name": { "MarkdownDocumentation": "`Rfc822Name`\n\nRepresents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email\naddress.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-rfc822name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OtherName": { "MarkdownDocumentation": "`OtherName`\n\nRepresents `GeneralName` using an `OtherName` object.\n*Required*: No\n*Type*: [OtherName](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-othername", "UpdateType": "Immutable", "Required": false, "Type": "OtherName" }, "IpAddress": { "MarkdownDocumentation": "`IpAddress`\n\nRepresents `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-ipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DirectoryName": { "MarkdownDocumentation": "`DirectoryName`\n\nContains information about the certificate subject. The certificate can be one issued\nby your private certificate authority (CA) or it can be your private CA certificate. The\nSubject field in the certificate identifies the entity that owns or controls the public\nkey in the certificate. The entity can be a user, computer, device, or service. The\nSubject must contain an X.500 distinguished name (DN). A DN is a sequence of relative\ndistinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN\nmust be unique for each entity, but your private CA can issue more than one certificate\nwith the same DN to the same entity.\n*Required*: No\n*Type*: [Subject](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-directoryname", "UpdateType": "Immutable", "Required": false, "Type": "Subject" } } }, "AWS::ACMPCA::CertificateAuthority.KeyUsage": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.KeyUsage`\n\nDefines one or more purposes for which the key contained in the certificate can be\nused. Default value for each option is false.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html", "Properties": { "KeyEncipherment": { "MarkdownDocumentation": "`KeyEncipherment`\n\nKey can be used to encipher data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keyencipherment", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DataEncipherment": { "MarkdownDocumentation": "`DataEncipherment`\n\nKey can be used to decipher data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-dataencipherment", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DigitalSignature": { "MarkdownDocumentation": "`DigitalSignature`\n\nKey can be used for digital signing.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-digitalsignature", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyCertSign": { "MarkdownDocumentation": "`KeyCertSign`\n\nKey can be used to sign certificates.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keycertsign", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DecipherOnly": { "MarkdownDocumentation": "`DecipherOnly`\n\nKey can be used only to decipher data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-decipheronly", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyAgreement": { "MarkdownDocumentation": "`KeyAgreement`\n\nKey can be used in a key-agreement protocol.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keyagreement", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "NonRepudiation": { "MarkdownDocumentation": "`NonRepudiation`\n\nKey can be used for non-repudiation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-nonrepudiation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "CRLSign": { "MarkdownDocumentation": "`CRLSign`\n\nKey can be used to sign CRLs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-crlsign", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EncipherOnly": { "MarkdownDocumentation": "`EncipherOnly`\n\nKey can be used only to encipher data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-encipheronly", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ACMPCA::CertificateAuthority.OcspConfiguration": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.OcspConfiguration`\n\nContains information to enable and configure Online Certificate Status Protocol (OCSP)\nfor validating certificate revocation status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-ocspconfiguration.html", "Properties": { "OcspCustomCname": { "MarkdownDocumentation": "`OcspCustomCname`\n\nBy default, AWS Private CA injects an Amazon domain into certificates being\nvalidated by the Online Certificate Status Protocol (OCSP). A customer can alternatively\nuse this object to define a CNAME specifying a customized OCSP domain.\n###### Note\nThe content of a Canonical Name (CNAME) record must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the\nuse of special characters in URIs. Additionally, the value of the CNAME must not\ninclude a protocol prefix such as \"http://\" or \"https://\".\n*Required*: No\n*Type*: String\n*Pattern*: `[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-ocspconfiguration.html#cfn-acmpca-certificateauthority-ocspconfiguration-ocspcustomcname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nFlag enabling use of the Online Certificate Status Protocol (OCSP) for validating\ncertificate revocation status.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-ocspconfiguration.html#cfn-acmpca-certificateauthority-ocspconfiguration-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::ACMPCA::CertificateAuthority.OtherName": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.OtherName`\n\nDefines a custom ASN.1 X.400 `GeneralName` using an object identifier (OID)\nand value. The OID must satisfy the regular expression shown below. For more\ninformation, see NIST's definition of [Object Identifier\n(OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html", "Properties": { "TypeId": { "MarkdownDocumentation": "`TypeId`\n\nSpecifies an OID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html#cfn-acmpca-certificateauthority-othername-typeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nSpecifies an OID value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html#cfn-acmpca-certificateauthority-othername-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ACMPCA::CertificateAuthority.RevocationConfiguration": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.RevocationConfiguration`\n\nCertificate 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)\ncan configure Online Certificate Status Protocol (OCSP) support and/or maintain a\ncertificate revocation list (CRL). OCSP returns validation information about\ncertificates as requested by clients, and a CRL contains an updated list of certificates\nrevoked 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\nReference* and [Setting up a certificate\nrevocation method](https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) in the *AWS Private CA User\nGuide*.\nThe following requirements and constraints apply to revocation configurations.\n* A configuration disabling CRLs or OCSP must contain only the\n `Enabled=False` parameter, and will fail if other parameters\n such as `CustomCname` or `ExpirationInDays` are\n included.\n* In a CRL configuration, the `S3BucketName` parameter must\n conform to the [Amazon S3 bucket\n naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\n* A configuration containing a custom Canonical Name (CNAME) parameter for\n CRLs or OCSP must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions\n on the use of special characters in a CNAME.\n* In a CRL or OCSP configuration, the value of a CNAME parameter must not\n include a protocol prefix such as \"http://\" or \"https://\".\n* To revoke a certificate, delete the resource from your template, and call the AWS Private CA[RevokeCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) API and specify the resource's certificate authority ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html", "Properties": { "OcspConfiguration": { "MarkdownDocumentation": "`OcspConfiguration`\n\nConfiguration of Online Certificate Status Protocol (OCSP) support, if any, maintained\nby your private CA.\n*Required*: No\n*Type*: [OcspConfiguration](./aws-properties-acmpca-certificateauthority-ocspconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html#cfn-acmpca-certificateauthority-revocationconfiguration-ocspconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "OcspConfiguration" }, "CrlConfiguration": { "MarkdownDocumentation": "`CrlConfiguration`\n\nConfiguration of the certificate revocation list (CRL), if any, maintained by your\nprivate CA.\n*Required*: No\n*Type*: [CrlConfiguration](./aws-properties-acmpca-certificateauthority-crlconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html#cfn-acmpca-certificateauthority-revocationconfiguration-crlconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CrlConfiguration" } } }, "AWS::ACMPCA::CertificateAuthority.Subject": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority.Subject`\n\nASN1 subject for the certificate authority.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html", "Properties": { "Organization": { "MarkdownDocumentation": "`Organization`\n\nLegal name of the organization with which the certificate subject is\naffiliated.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-organization", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OrganizationalUnit": { "MarkdownDocumentation": "`OrganizationalUnit`\n\nA subdivision or unit of the organization (such as sales or finance) with which the\ncertificate subject is affiliated.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-organizationalunit", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Locality": { "MarkdownDocumentation": "`Locality`\n\nThe locality (such as a city or town) in which the certificate subject is\nlocated.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-locality", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nA personal title such as Mr.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-title", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GivenName": { "MarkdownDocumentation": "`GivenName`\n\nFirst 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-givenname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GenerationQualifier": { "MarkdownDocumentation": "`GenerationQualifier`\n\nTypically a qualifier appended to the name of an individual. Examples include Jr. for\njunior, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-generationqualifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Initials": { "MarkdownDocumentation": "`Initials`\n\nConcatenation that typically contains the first letter of the GivenName, the first\nletter of the middle name if one exists, and the first letter of the SurName.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-initials", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CustomAttributes": { "MarkdownDocumentation": "`CustomAttributes`\n\nContains a sequence of one or more X.500 relative distinguished names (RDNs), each of\nwhich consists of an object identifier (OID) and a value. For more information, see\nNIST\u2019s definition of [Object Identifier (OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).\n###### Note\nCustom attributes cannot be used in combination with standard attributes.\n*Required*: No\n*Type*: Array of [CustomAttribute](./aws-properties-acmpca-certificateauthority-customattribute.html)\n*Minimum*: `1`\n*Maximum*: `150`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-customattributes", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "CustomAttribute", "DuplicatesAllowed": true }, "SerialNumber": { "MarkdownDocumentation": "`SerialNumber`\n\nThe certificate serial number.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-serialnumber", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nState in which the subject of the certificate is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-state", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Country": { "MarkdownDocumentation": "`Country`\n\nTwo-digit code that specifies the country in which the certificate subject\nlocated.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-country", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Surname": { "MarkdownDocumentation": "`Surname`\n\nFamily 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-surname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DistinguishedNameQualifier": { "MarkdownDocumentation": "`DistinguishedNameQualifier`\n\nDisambiguating 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-distinguishednamequalifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CommonName": { "MarkdownDocumentation": "`CommonName`\n\nFully 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-commonname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Pseudonym": { "MarkdownDocumentation": "`Pseudonym`\n\nTypically a shortened version of a longer GivenName. For example, Jonathan is often\nshortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html#cfn-acmpca-certificateauthority-subject-pseudonym", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AIOps::InvestigationGroup.ChatbotNotificationChannel": { "MarkdownDocumentation": "`AWS::AIOps::InvestigationGroup.ChatbotNotificationChannel`\n\nUse this structure to integrate CloudWatch investigations with chat applications. This\nstructure is a string array. For the first string, specify the ARN of an Amazon SNS\ntopic. For the array of strings, specify the ARNs of one or more chat applications configurations that you want to associate with that topic. For more\ninformation about these configuration ARNs, see [Getting started with Amazon Q in chat applications](https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html) and [Resource type defined by AWS Chatbot](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-chatbotnotificationchannel.html", "Properties": { "SNSTopicArn": { "MarkdownDocumentation": "`SNSTopicArn`\n\nReturns the ARN of an Amazon SNS topic used for third-party chat integrations.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-chatbotnotificationchannel.html#cfn-aiops-investigationgroup-chatbotnotificationchannel-snstopicarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ChatConfigurationArns": { "MarkdownDocumentation": "`ChatConfigurationArns`\n\nReturns the Amazon Resource Name (ARN) of any third-party chat integrations configured\nfor the account.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-chatbotnotificationchannel.html#cfn-aiops-investigationgroup-chatbotnotificationchannel-chatconfigurationarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::AIOps::InvestigationGroup.CrossAccountConfiguration": { "MarkdownDocumentation": "`AWS::AIOps::InvestigationGroup.CrossAccountConfiguration`\n\nThis structure contains information about the cross-account configuration in the account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-crossaccountconfiguration.html", "Properties": { "SourceRoleArn": { "MarkdownDocumentation": "`SourceRoleArn`\n\nThe ARN of an existing role which will be used to do investigations on your behalf.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-crossaccountconfiguration.html#cfn-aiops-investigationgroup-crossaccountconfiguration-sourcerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AIOps::InvestigationGroup.EncryptionConfigMap": { "MarkdownDocumentation": "`AWS::AIOps::InvestigationGroup.EncryptionConfigMap`\n\nUse this structure if you want to use a customer managed AWS KMS key to\nencrypt your investigation data. If you omit this parameter, CloudWatch investigations will use an AWS key to encrypt the data. For more information, see [Encryption of investigation data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-KMS).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-encryptionconfigmap.html", "Properties": { "EncryptionConfigurationType": { "MarkdownDocumentation": "`EncryptionConfigurationType`\n\nDisplays whether investigation data is encrypted by a customer managed key or an AWS owned key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-encryptionconfigmap.html#cfn-aiops-investigationgroup-encryptionconfigmap-encryptionconfigurationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nIf the investigation group uses a customer managed key for encryption, this field\ndisplays the ID of that 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-encryptionconfigmap.html#cfn-aiops-investigationgroup-encryptionconfigmap-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::APS::AnomalyDetector.AnomalyDetectorConfiguration": { "MarkdownDocumentation": "`AWS::APS::AnomalyDetector.AnomalyDetectorConfiguration`\n\nThe configuration for the anomaly detection algorithm.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-anomalydetectorconfiguration.html", "Properties": { "RandomCutForest": { "MarkdownDocumentation": "`RandomCutForest`\n\nThe Random Cut Forest algorithm configuration for anomaly detection.\n*Required*: Yes\n*Type*: [RandomCutForestConfiguration](./aws-properties-aps-anomalydetector-randomcutforestconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-anomalydetectorconfiguration.html#cfn-aps-anomalydetector-anomalydetectorconfiguration-randomcutforest", "UpdateType": "Mutable", "Required": true, "Type": "RandomCutForestConfiguration" } } }, "AWS::APS::AnomalyDetector.IgnoreNearExpected": { "MarkdownDocumentation": "`AWS::APS::AnomalyDetector.IgnoreNearExpected`\n\nConfiguration for threshold settings that determine when values near expected values\nshould be ignored during anomaly detection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-ignorenearexpected.html", "Properties": { "Amount": { "MarkdownDocumentation": "`Amount`\n\nThe absolute amount by which values can differ from expected values before being\nconsidered anomalous.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-ignorenearexpected.html#cfn-aps-anomalydetector-ignorenearexpected-amount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Ratio": { "MarkdownDocumentation": "`Ratio`\n\nThe ratio by which values can differ from expected values before being considered\nanomalous.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-ignorenearexpected.html#cfn-aps-anomalydetector-ignorenearexpected-ratio", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::APS::AnomalyDetector.Label": { "MarkdownDocumentation": "`AWS::APS::AnomalyDetector.Label`\n\nThe Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-label.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for this label.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-label.html#cfn-aps-anomalydetector-label-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-label.html#cfn-aps-anomalydetector-label-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::APS::AnomalyDetector.MissingDataAction": { "MarkdownDocumentation": "`AWS::APS::AnomalyDetector.MissingDataAction`\n\nSpecifies the action to take when data is missing during anomaly detection\nevaluation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-missingdataaction.html", "Properties": { "MarkAsAnomaly": { "MarkdownDocumentation": "`MarkAsAnomaly`\n\nMarks missing data points as anomalies.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-missingdataaction.html#cfn-aps-anomalydetector-missingdataaction-markasanomaly", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Skip": { "MarkdownDocumentation": "`Skip`\n\nSkips evaluation when data is missing.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-missingdataaction.html#cfn-aps-anomalydetector-missingdataaction-skip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::APS::AnomalyDetector.RandomCutForestConfiguration": { "MarkdownDocumentation": "`AWS::APS::AnomalyDetector.RandomCutForestConfiguration`\n\nConfiguration for the Random Cut Forest algorithm used for anomaly detection in\ntime-series data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html", "Properties": { "SampleSize": { "MarkdownDocumentation": "`SampleSize`\n\nThe number of data points sampled from the input stream for the Random Cut Forest\nalgorithm. The default number is 256 consecutive data points.\n*Required*: No\n*Type*: Integer\n*Minimum*: `256`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-samplesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Query": { "MarkdownDocumentation": "`Query`\n\nThe Prometheus query used to retrieve the time-series data for anomaly\ndetection.\n###### Important\nRandom Cut Forest queries must be wrapped by a supported PromQL aggregation\noperator. For more information, see [Aggregation operators](https://prometheus.io/docs/prometheus/latest/querying/operators/#aggregation-operators) on the *Prometheus docs*\nwebsite.\n**Supported PromQL aggregation operators**:\n`avg`, `count`, `group`, `max`,\n`min`, `quantile`, `stddev`,\n`stdvar`, and `sum`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-query", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ShingleSize": { "MarkdownDocumentation": "`ShingleSize`\n\nThe number of consecutive data points used to create a shingle for the Random Cut\nForest algorithm. The default number is 8 consecutive data points.\n*Required*: No\n*Type*: Integer\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-shinglesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IgnoreNearExpectedFromBelow": { "MarkdownDocumentation": "`IgnoreNearExpectedFromBelow`\n\nConfiguration for ignoring values that are near expected values from below during\nanomaly detection.\n*Required*: No\n*Type*: [IgnoreNearExpected](./aws-properties-aps-anomalydetector-ignorenearexpected.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-ignorenearexpectedfrombelow", "UpdateType": "Mutable", "Required": false, "Type": "IgnoreNearExpected" }, "IgnoreNearExpectedFromAbove": { "MarkdownDocumentation": "`IgnoreNearExpectedFromAbove`\n\nConfiguration for ignoring values that are near expected values from above during\nanomaly detection.\n*Required*: No\n*Type*: [IgnoreNearExpected](./aws-properties-aps-anomalydetector-ignorenearexpected.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-anomalydetector-randomcutforestconfiguration.html#cfn-aps-anomalydetector-randomcutforestconfiguration-ignorenearexpectedfromabove", "UpdateType": "Mutable", "Required": false, "Type": "IgnoreNearExpected" } } }, "AWS::APS::Scraper.AmpConfiguration": { "MarkdownDocumentation": "`AWS::APS::Scraper.AmpConfiguration`\n\nThe `AmpConfiguration` structure defines the Amazon Managed Service for\nPrometheus instance a scraper should send metrics to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-ampconfiguration.html", "Properties": { "WorkspaceArn": { "MarkdownDocumentation": "`WorkspaceArn`\n\nARN of the Amazon Managed Service for Prometheus workspace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-ampconfiguration.html#cfn-aps-scraper-ampconfiguration-workspacearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::APS::Scraper.CloudWatchLogDestination": { "MarkdownDocumentation": "`AWS::APS::Scraper.CloudWatchLogDestination`\n\nThe `CloudWatchLogDestination` property type specifies Property description not available. for an [AWS::APS::Scraper](./aws-resource-aps-scraper.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-cloudwatchlogdestination.html", "Properties": { "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nProperty description not available.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-cloudwatchlogdestination.html#cfn-aps-scraper-cloudwatchlogdestination-loggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::APS::Scraper.ComponentConfig": { "MarkdownDocumentation": "`AWS::APS::Scraper.ComponentConfig`\n\nConfiguration settings for a scraper component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-componentconfig.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nConfiguration options for the scraper component.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-componentconfig.html#cfn-aps-scraper-componentconfig-options", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::APS::Scraper.Destination": { "MarkdownDocumentation": "`AWS::APS::Scraper.Destination`\n\nWhere to send the metrics from a scraper.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-destination.html", "Properties": { "AmpConfiguration": { "MarkdownDocumentation": "`AmpConfiguration`\n\nThe Amazon Managed Service for Prometheus workspace to send metrics to.\n*Required*: No\n*Type*: [AmpConfiguration](./aws-properties-aps-scraper-ampconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-destination.html#cfn-aps-scraper-destination-ampconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "AmpConfiguration" } } }, "AWS::APS::Scraper.EksConfiguration": { "MarkdownDocumentation": "`AWS::APS::Scraper.EksConfiguration`\n\nThe `EksConfiguration` structure describes the connection to the Amazon EKS\ncluster from which a scraper collects metrics.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-eksconfiguration.html", "Properties": { "ClusterArn": { "MarkdownDocumentation": "`ClusterArn`\n\nARN of the Amazon EKS cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-eksconfiguration.html#cfn-aps-scraper-eksconfiguration-clusterarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of the security group IDs for the Amazon EKS cluster VPC configuration.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-eksconfiguration.html#cfn-aps-scraper-eksconfiguration-securitygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of subnet IDs for the Amazon EKS cluster VPC configuration.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-eksconfiguration.html#cfn-aps-scraper-eksconfiguration-subnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::APS::Scraper.RoleConfiguration": { "MarkdownDocumentation": "`AWS::APS::Scraper.RoleConfiguration`\n\nThe role configuration in an Amazon Managed Service for Prometheus scraper.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-roleconfiguration.html", "Properties": { "TargetRoleArn": { "MarkdownDocumentation": "`TargetRoleArn`\n\nThe ARN of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-roleconfiguration.html#cfn-aps-scraper-roleconfiguration-targetrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceRoleArn": { "MarkdownDocumentation": "`SourceRoleArn`\n\nThe ARN of the source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-roleconfiguration.html#cfn-aps-scraper-roleconfiguration-sourcerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::APS::Scraper.ScrapeConfiguration": { "MarkdownDocumentation": "`AWS::APS::Scraper.ScrapeConfiguration`\n\nA scrape configuration for a scraper, base 64 encoded. For more information, see\n[Scraper configuration](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration) in the *Amazon Managed Service for\nPrometheus User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scrapeconfiguration.html", "Properties": { "ConfigurationBlob": { "MarkdownDocumentation": "`ConfigurationBlob`\n\nThe base 64 encoded scrape configuration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scrapeconfiguration.html#cfn-aps-scraper-scrapeconfiguration-configurationblob", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::APS::Scraper.ScraperComponent": { "MarkdownDocumentation": "`AWS::APS::Scraper.ScraperComponent`\n\nA component of a Amazon Managed Service for Prometheus scraper that can be configured for\nlogging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scrapercomponent.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the scraper component.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SERVICE_DISCOVERY | COLLECT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SERVICE_DISCOVERY", "COLLECTOR", "EXPORTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scrapercomponent.html#cfn-aps-scraper-scrapercomponent-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Config": { "MarkdownDocumentation": "`Config`\n\nThe configuration settings for the scraper component.\n*Required*: No\n*Type*: [ComponentConfig](./aws-properties-aps-scraper-componentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scrapercomponent.html#cfn-aps-scraper-scrapercomponent-config", "UpdateType": "Mutable", "Required": false, "Type": "ComponentConfig" } } }, "AWS::APS::Scraper.ScraperLoggingConfiguration": { "MarkdownDocumentation": "`AWS::APS::Scraper.ScraperLoggingConfiguration`\n\nThe `ScraperLoggingConfiguration` property type specifies Property description not available. for an [AWS::APS::Scraper](./aws-resource-aps-scraper.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scraperloggingconfiguration.html", "Properties": { "LoggingDestination": { "MarkdownDocumentation": "`LoggingDestination`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ScraperLoggingDestination](./aws-properties-aps-scraper-scraperloggingdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scraperloggingconfiguration.html#cfn-aps-scraper-scraperloggingconfiguration-loggingdestination", "UpdateType": "Mutable", "Required": true, "Type": "ScraperLoggingDestination" }, "ScraperComponents": { "MarkdownDocumentation": "`ScraperComponents`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [ScraperComponent](./aws-properties-aps-scraper-scrapercomponent.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scraperloggingconfiguration.html#cfn-aps-scraper-scraperloggingconfiguration-scrapercomponents", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ScraperComponent", "DuplicatesAllowed": false } } }, "AWS::APS::Scraper.ScraperLoggingDestination": { "MarkdownDocumentation": "`AWS::APS::Scraper.ScraperLoggingDestination`\n\nThe destination where scraper logs are sent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scraperloggingdestination.html", "Properties": { "CloudWatchLogs": { "MarkdownDocumentation": "`CloudWatchLogs`\n\nThe CloudWatch Logs configuration for the scraper logging destination.\n*Required*: No\n*Type*: [CloudWatchLogDestination](./aws-properties-aps-scraper-cloudwatchlogdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scraperloggingdestination.html#cfn-aps-scraper-scraperloggingdestination-cloudwatchlogs", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLogDestination" } } }, "AWS::APS::Scraper.Source": { "MarkdownDocumentation": "`AWS::APS::Scraper.Source`\n\nThe source of collected metrics for a scraper.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-source.html", "Properties": { "EksConfiguration": { "MarkdownDocumentation": "`EksConfiguration`\n\nThe Amazon EKS cluster from which a scraper collects metrics.\n*Required*: No\n*Type*: [EksConfiguration](./aws-properties-aps-scraper-eksconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-source.html#cfn-aps-scraper-source-eksconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EksConfiguration" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [VpcConfiguration](./aws-properties-aps-scraper-vpcconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-source.html#cfn-aps-scraper-source-vpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfiguration" } } }, "AWS::APS::Scraper.VpcConfiguration": { "MarkdownDocumentation": "`AWS::APS::Scraper.VpcConfiguration`\n\nThe `VpcConfiguration` property type specifies Property description not available. for an [AWS::APS::Scraper](./aws-resource-aps-scraper.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-vpcconfiguration.html", "Properties": { "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-vpcconfiguration.html#cfn-aps-scraper-vpcconfiguration-securitygroupids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-vpcconfiguration.html#cfn-aps-scraper-vpcconfiguration-subnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::APS::Workspace.CloudWatchLogDestination": { "MarkdownDocumentation": "`AWS::APS::Workspace.CloudWatchLogDestination`\n\nConfiguration details for logging to CloudWatch Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-cloudwatchlogdestination.html", "Properties": { "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe ARN of the CloudWatch log group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-cloudwatchlogdestination.html#cfn-aps-workspace-cloudwatchlogdestination-loggrouparn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::APS::Workspace.Label": { "MarkdownDocumentation": "`AWS::APS::Workspace.Label`\n\nA label is a name:value pair used to add context to ingested metrics. This structure\ndefines the name and value for one label that is used in a label set. You can set\ningestion limits on time series that match defined label sets, to help prevent a\nworkspace from being overwhelmed with unexpected spikes in time series ingestion.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-label.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for this label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-label.html#cfn-aps-workspace-label-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for this label.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-label.html#cfn-aps-workspace-label-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::APS::Workspace.LimitsPerLabelSet": { "MarkdownDocumentation": "`AWS::APS::Workspace.LimitsPerLabelSet`\n\nThis defines a label set for the workspace, and defines the ingestion limit for active\ntime series that match that label set. Each label name in a label set must be\nunique.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-limitsperlabelset.html", "Properties": { "Limits": { "MarkdownDocumentation": "`Limits`\n\nThis structure contains the information about the limits that apply to time series\nthat match this label set.\n*Required*: Yes\n*Type*: [LimitsPerLabelSetEntry](./aws-properties-aps-workspace-limitsperlabelsetentry.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-limitsperlabelset.html#cfn-aps-workspace-limitsperlabelset-limits", "UpdateType": "Mutable", "Required": true, "Type": "LimitsPerLabelSetEntry" }, "LabelSet": { "MarkdownDocumentation": "`LabelSet`\n\nThis defines one label set that will have an enforced ingestion limit. You can set\ningestion limits on time series that match defined label sets, to help prevent a\nworkspace from being overwhelmed with unexpected spikes in time series ingestion.\nLabel values accept all UTF-8 characters with one exception. If the label name is\nmetric name label `__name__`, then the\n*metric* part of the name must conform to the following pattern:\n`[a-zA-Z_:][a-zA-Z0-9_:]*`\n*Required*: Yes\n*Type*: Array of [Label](./aws-properties-aps-workspace-label.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-limitsperlabelset.html#cfn-aps-workspace-limitsperlabelset-labelset", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Label", "DuplicatesAllowed": false } } }, "AWS::APS::Workspace.LimitsPerLabelSetEntry": { "MarkdownDocumentation": "`AWS::APS::Workspace.LimitsPerLabelSetEntry`\n\nThis structure contains the limits that apply to time series that match one label\nset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-limitsperlabelsetentry.html", "Properties": { "MaxSeries": { "MarkdownDocumentation": "`MaxSeries`\n\nThe maximum number of active series that can be ingested that match this label set.\nSetting this to 0 causes no label set limit to be enforced, but it does cause Amazon Managed Service for Prometheus to vend label set metrics to CloudWatch\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-limitsperlabelsetentry.html#cfn-aps-workspace-limitsperlabelsetentry-maxseries", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::APS::Workspace.LoggingConfiguration": { "MarkdownDocumentation": "`AWS::APS::Workspace.LoggingConfiguration`\n\nContains information about the rules and alerting logging configuration for the\nworkspace.\n###### Note\nThese logging configurations are only for rules and alerting logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingconfiguration.html", "Properties": { "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe ARN of the CloudWatch log group to which the vended log data will be published.\nThis log group must exist prior to calling this operation.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingconfiguration.html#cfn-aps-workspace-loggingconfiguration-loggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::APS::Workspace.LoggingDestination": { "MarkdownDocumentation": "`AWS::APS::Workspace.LoggingDestination`\n\nThe logging destination in an Amazon Managed Service for Prometheus workspace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingdestination.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nFiltering criteria that determine which queries are logged.\n*Required*: Yes\n*Type*: [LoggingFilter](./aws-properties-aps-workspace-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingdestination.html#cfn-aps-workspace-loggingdestination-filters", "UpdateType": "Mutable", "Required": true, "Type": "LoggingFilter" }, "CloudWatchLogs": { "MarkdownDocumentation": "`CloudWatchLogs`\n\nConfiguration details for logging to CloudWatch Logs.\n*Required*: Yes\n*Type*: [CloudWatchLogDestination](./aws-properties-aps-workspace-cloudwatchlogdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingdestination.html#cfn-aps-workspace-loggingdestination-cloudwatchlogs", "UpdateType": "Mutable", "Required": true, "Type": "CloudWatchLogDestination" } } }, "AWS::APS::Workspace.LoggingFilter": { "MarkdownDocumentation": "`AWS::APS::Workspace.LoggingFilter`\n\nFiltering criteria that determine which queries are logged.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingfilter.html", "Properties": { "QspThreshold": { "MarkdownDocumentation": "`QspThreshold`\n\nThe Query Samples Processed (QSP) threshold above which queries will be logged.\nQueries processing more samples than this threshold will be captured in logs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingfilter.html#cfn-aps-workspace-loggingfilter-qspthreshold", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::APS::Workspace.QueryLoggingConfiguration": { "MarkdownDocumentation": "`AWS::APS::Workspace.QueryLoggingConfiguration`\n\nThe query logging configuration in an Amazon Managed Service for Prometheus\nworkspace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-queryloggingconfiguration.html", "Properties": { "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nDefines a destination and its associated filtering criteria for query logging.\n*Required*: Yes\n*Type*: Array of [LoggingDestination](./aws-properties-aps-workspace-loggingdestination.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-queryloggingconfiguration.html#cfn-aps-workspace-queryloggingconfiguration-destinations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "LoggingDestination", "DuplicatesAllowed": true } } }, "AWS::APS::Workspace.WorkspaceConfiguration": { "MarkdownDocumentation": "`AWS::APS::Workspace.WorkspaceConfiguration`\n\nUse this structure to define label sets and the ingestion limits for time series that\nmatch label sets, and to specify the retention period of the workspace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-workspaceconfiguration.html", "Properties": { "RetentionPeriodInDays": { "MarkdownDocumentation": "`RetentionPeriodInDays`\n\nSpecifies how many days that metrics will be retained in the workspace.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-workspaceconfiguration.html#cfn-aps-workspace-workspaceconfiguration-retentionperiodindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LimitsPerLabelSets": { "MarkdownDocumentation": "`LimitsPerLabelSets`\n\nThis is an array of structures, where each structure defines a label set for the\nworkspace, and defines the ingestion limit for active time series for each of those\nlabel sets. Each label name in a label set must be unique.\n*Required*: No\n*Type*: Array of [LimitsPerLabelSet](./aws-properties-aps-workspace-limitsperlabelset.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-workspaceconfiguration.html#cfn-aps-workspace-workspaceconfiguration-limitsperlabelsets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LimitsPerLabelSet", "DuplicatesAllowed": false } } }, "AWS::ARCRegionSwitch::Plan.ArcRoutingControlConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.ArcRoutingControlConfiguration`\n\nConfiguration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html", "Properties": { "RegionAndRoutingControls": { "MarkdownDocumentation": "`RegionAndRoutingControls`\n\nThe Region and ARC routing controls for the configuration.\n*Required*: Yes\n*Type*: Object of Array\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-regionandroutingcontrols", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe timeout value specified for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.Asg": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Asg`\n\nConfiguration for an Amazon EC2 Auto Scaling group used in a Region switch plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-asg.html", "Properties": { "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-asg.html#cfn-arcregionswitch-plan-asg-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-asg.html#cfn-arcregionswitch-plan-asg-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the EC2 Auto Scaling group.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z-]*:autoscaling:[a-z0-9-]+:\\d{12}:autoScalingGroup:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:autoScalingGroupName/[\\S\\s]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-asg.html#cfn-arcregionswitch-plan-asg-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.AssociatedAlarm": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.AssociatedAlarm`\n\nAn Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to\ntrigger automatic execution of the plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html", "Properties": { "ResourceIdentifier": { "MarkdownDocumentation": "`ResourceIdentifier`\n\nThe resource identifier for alarms that you associate with a plan.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html#cfn-arcregionswitch-plan-associatedalarm-resourceidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html#cfn-arcregionswitch-plan-associatedalarm-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AlarmType": { "MarkdownDocumentation": "`AlarmType`\n\nThe alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `applicationHealth | trigger...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "applicationHealth", "trigger" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html#cfn-arcregionswitch-plan-associatedalarm-alarmtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html#cfn-arcregionswitch-plan-associatedalarm-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.CustomActionLambdaConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.CustomActionLambdaConfiguration`\n\nConfiguration for AWS Lambda functions that perform custom actions during a Region switch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html", "Properties": { "Lambdas": { "MarkdownDocumentation": "`Lambdas`\n\nThe AWS Lambda functions for the execution block.\n*Required*: Yes\n*Type*: [Array](./aws-properties-arcregionswitch-plan-lambdas.html) of [Lambdas](./aws-properties-arcregionswitch-plan-lambdas.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-lambdas", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Lambdas", "DuplicatesAllowed": true }, "RetryIntervalMinutes": { "MarkdownDocumentation": "`RetryIntervalMinutes`\n\nThe retry interval specified.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-retryintervalminutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe timeout value specified for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "RegionToRun": { "MarkdownDocumentation": "`RegionToRun`\n\nThe AWS Region for the function to run in.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `activatingRegion | deactiva...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "activatingRegion", "deactivatingRegion" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-regiontorun", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Ungraceful": { "MarkdownDocumentation": "`Ungraceful`\n\nThe settings for ungraceful execution.\n*Required*: No\n*Type*: [LambdaUngraceful](./aws-properties-arcregionswitch-plan-lambdaungraceful.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-ungraceful", "UpdateType": "Mutable", "Required": false, "Type": "LambdaUngraceful" } } }, "AWS::ARCRegionSwitch::Plan.DocumentDbConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.DocumentDbConfiguration`\n\nConfiguration for Amazon DocumentDB global clusters used in a Region switch plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html", "Properties": { "DatabaseClusterArns": { "MarkdownDocumentation": "`DatabaseClusterArns`\n\nThe database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-databaseclusterarns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe timeout value specified for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Behavior": { "MarkdownDocumentation": "`Behavior`\n\nThe behavior for a global cluster, that is, only allow switchover or also allow failover.\n*Required*: Yes\n*Type*:\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-behavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ungraceful": { "MarkdownDocumentation": "`Ungraceful`\n\nThe settings for ungraceful execution.\n*Required*: No\n*Type*: [DocumentDbUngraceful](./aws-properties-arcregionswitch-plan-documentdbungraceful.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-ungraceful", "UpdateType": "Mutable", "Required": false, "Type": "DocumentDbUngraceful" }, "GlobalClusterIdentifier": { "MarkdownDocumentation": "`GlobalClusterIdentifier`\n\nThe global cluster identifier for a DocumentDB global cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-globalclusteridentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.DocumentDbUngraceful": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.DocumentDbUngraceful`\n\nConfiguration for handling failures when performing operations on DocumentDB global clusters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbungraceful.html", "Properties": { "Ungraceful": { "MarkdownDocumentation": "`Ungraceful`\n\nThe settings for ungraceful execution.\n*Required*: No\n*Type*: String\n*Allowed values*: `failover`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "failover" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbungraceful.html#cfn-arcregionswitch-plan-documentdbungraceful-ungraceful", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.Ec2AsgCapacityIncreaseConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Ec2AsgCapacityIncreaseConfiguration`\n\nConfiguration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html", "Properties": { "Asgs": { "MarkdownDocumentation": "`Asgs`\n\nThe EC2 Auto Scaling groups for the configuration.\n*Required*: Yes\n*Type*: Array of [Asg](./aws-properties-arcregionswitch-plan-asg.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-asgs", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Asg", "DuplicatesAllowed": true }, "CapacityMonitoringApproach": { "MarkdownDocumentation": "`CapacityMonitoringApproach`\n\nThe monitoring approach that you specify EC2 Auto Scaling groups for the configuration.\n*Required*: No\n*Type*:\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-capacitymonitoringapproach", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe timeout value specified for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Ungraceful": { "MarkdownDocumentation": "`Ungraceful`\n\nThe settings for ungraceful execution.\n*Required*: No\n*Type*: [Ec2Ungraceful](./aws-properties-arcregionswitch-plan-ec2ungraceful.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-ungraceful", "UpdateType": "Mutable", "Required": false, "Type": "Ec2Ungraceful" }, "TargetPercent": { "MarkdownDocumentation": "`TargetPercent`\n\nThe target percentage that you specify for EC2 Auto Scaling groups.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-targetpercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ARCRegionSwitch::Plan.Ec2Ungraceful": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Ec2Ungraceful`\n\nConfiguration for handling failures when performing operations on EC2 resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2ungraceful.html", "Properties": { "MinimumSuccessPercentage": { "MarkdownDocumentation": "`MinimumSuccessPercentage`\n\nThe minimum success percentage that you specify for EC2 Auto Scaling groups.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `99`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2ungraceful.html#cfn-arcregionswitch-plan-ec2ungraceful-minimumsuccesspercentage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::ARCRegionSwitch::Plan.EcsCapacityIncreaseConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.EcsCapacityIncreaseConfiguration`\n\nThe configuration for an AWS ECS capacity increase.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html", "Properties": { "Services": { "MarkdownDocumentation": "`Services`\n\nThe services specified for the configuration.\n*Required*: Yes\n*Type*: Array of [Service](./aws-properties-arcregionswitch-plan-service.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-services", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Service", "DuplicatesAllowed": true }, "CapacityMonitoringApproach": { "MarkdownDocumentation": "`CapacityMonitoringApproach`\n\nThe monitoring approach specified for the configuration, for example, `Most_Recent`.\n*Required*: No\n*Type*:\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-capacitymonitoringapproach", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe timeout value specified for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Ungraceful": { "MarkdownDocumentation": "`Ungraceful`\n\nThe settings for ungraceful execution.\n*Required*: No\n*Type*: [EcsUngraceful](./aws-properties-arcregionswitch-plan-ecsungraceful.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-ungraceful", "UpdateType": "Mutable", "Required": false, "Type": "EcsUngraceful" }, "TargetPercent": { "MarkdownDocumentation": "`TargetPercent`\n\nThe target percentage specified for the configuration.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-targetpercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ARCRegionSwitch::Plan.EcsUngraceful": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.EcsUngraceful`\n\nThe settings for ungraceful execution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecsungraceful.html", "Properties": { "MinimumSuccessPercentage": { "MarkdownDocumentation": "`MinimumSuccessPercentage`\n\nThe minimum success percentage specified for the configuration.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `99`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecsungraceful.html#cfn-arcregionswitch-plan-ecsungraceful-minimumsuccesspercentage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::ARCRegionSwitch::Plan.EksCluster": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.EksCluster`\n\nThe AWS EKS cluster execution block configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ekscluster.html", "Properties": { "ClusterArn": { "MarkdownDocumentation": "`ClusterArn`\n\nThe Amazon Resource Name (ARN) of an AWS EKS cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z-]*:eks:[a-z0-9-]+:\\d{12}:cluster/[a-zA-Z0-9][a-zA-Z0-9-_]{0,99}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ekscluster.html#cfn-arcregionswitch-plan-ekscluster-clusterarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ekscluster.html#cfn-arcregionswitch-plan-ekscluster-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ekscluster.html#cfn-arcregionswitch-plan-ekscluster-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.EksResourceScalingConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.EksResourceScalingConfiguration`\n\nThe AWS EKS resource scaling configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html", "Properties": { "KubernetesResourceType": { "MarkdownDocumentation": "`KubernetesResourceType`\n\nThe Kubernetes resource type for the configuration.\n*Required*: Yes\n*Type*: [KubernetesResourceType](./aws-properties-arcregionswitch-plan-kubernetesresourcetype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-kubernetesresourcetype", "UpdateType": "Mutable", "Required": true, "Type": "KubernetesResourceType" }, "CapacityMonitoringApproach": { "MarkdownDocumentation": "`CapacityMonitoringApproach`\n\nThe monitoring approach for the configuration, that is, whether it was sampled in the last\n24 hours or autoscaled in the last 24 hours.\n*Required*: No\n*Type*:\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-capacitymonitoringapproach", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "EksClusters": { "MarkdownDocumentation": "`EksClusters`\n\nThe clusters for the configuration.\n*Required*: No\n*Type*: Array of [EksCluster](./aws-properties-arcregionswitch-plan-ekscluster.html)\n*Minimum*: `2`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-eksclusters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EksCluster", "DuplicatesAllowed": true }, "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe timeout value specified for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ScalingResources": { "MarkdownDocumentation": "`ScalingResources`\n\nThe scaling resources for the configuration.\n*Required*: No\n*Type*: Array of Object\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-scalingresources", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Ungraceful": { "MarkdownDocumentation": "`Ungraceful`\n\nThe settings for ungraceful execution.\n*Required*: No\n*Type*: [EksResourceScalingUngraceful](./aws-properties-arcregionswitch-plan-eksresourcescalingungraceful.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-ungraceful", "UpdateType": "Mutable", "Required": false, "Type": "EksResourceScalingUngraceful" }, "TargetPercent": { "MarkdownDocumentation": "`TargetPercent`\n\nThe target percentage for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-targetpercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ARCRegionSwitch::Plan.EksResourceScalingUngraceful": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.EksResourceScalingUngraceful`\n\nThe ungraceful settings for AWS EKS resource scaling.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingungraceful.html", "Properties": { "MinimumSuccessPercentage": { "MarkdownDocumentation": "`MinimumSuccessPercentage`\n\nThe minimum success percentage for the configuration.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `99`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingungraceful.html#cfn-arcregionswitch-plan-eksresourcescalingungraceful-minimumsuccesspercentage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::ARCRegionSwitch::Plan.ExecutionApprovalConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.ExecutionApprovalConfiguration`\n\nConfiguration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionapprovalconfiguration.html", "Properties": { "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe timeout value specified for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionapprovalconfiguration.html#cfn-arcregionswitch-plan-executionapprovalconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ApprovalRole": { "MarkdownDocumentation": "`ApprovalRole`\n\nThe IAM approval role for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionapprovalconfiguration.html#cfn-arcregionswitch-plan-executionapprovalconfiguration-approvalrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.ExecutionBlockConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.ExecutionBlockConfiguration`\n\nExecution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html", "Properties": { "GlobalAuroraConfig": { "MarkdownDocumentation": "`GlobalAuroraConfig`\n\nAn Aurora Global Database execution block.\n*Required*: No\n*Type*: [GlobalAuroraConfiguration](./aws-properties-arcregionswitch-plan-globalauroraconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-globalauroraconfig", "UpdateType": "Mutable", "Required": false, "Type": "GlobalAuroraConfiguration" }, "Route53HealthCheckConfig": { "MarkdownDocumentation": "`Route53HealthCheckConfig`\n\nThe Amazon Route 53 health check configuration.\n*Required*: No\n*Type*: [Route53HealthCheckConfiguration](./aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-route53healthcheckconfig", "UpdateType": "Mutable", "Required": false, "Type": "Route53HealthCheckConfiguration" }, "ArcRoutingControlConfig": { "MarkdownDocumentation": "`ArcRoutingControlConfig`\n\nAn ARC routing control execution block.\n*Required*: No\n*Type*: [ArcRoutingControlConfiguration](./aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-arcroutingcontrolconfig", "UpdateType": "Mutable", "Required": false, "Type": "ArcRoutingControlConfiguration" }, "DocumentDbConfig": { "MarkdownDocumentation": "`DocumentDbConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [DocumentDbConfiguration](./aws-properties-arcregionswitch-plan-documentdbconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-documentdbconfig", "UpdateType": "Mutable", "Required": false, "Type": "DocumentDbConfiguration" }, "ParallelConfig": { "MarkdownDocumentation": "`ParallelConfig`\n\nA parallel configuration execution block.\n*Required*: No\n*Type*: [ParallelExecutionBlockConfiguration](./aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-parallelconfig", "UpdateType": "Mutable", "Required": false, "Type": "ParallelExecutionBlockConfiguration" }, "EksResourceScalingConfig": { "MarkdownDocumentation": "`EksResourceScalingConfig`\n\nAn AWS EKS resource scaling execution block.\n*Required*: No\n*Type*: [EksResourceScalingConfiguration](./aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-eksresourcescalingconfig", "UpdateType": "Mutable", "Required": false, "Type": "EksResourceScalingConfiguration" }, "EcsCapacityIncreaseConfig": { "MarkdownDocumentation": "`EcsCapacityIncreaseConfig`\n\nThe capacity increase specified for the configuration.\n*Required*: No\n*Type*: [EcsCapacityIncreaseConfiguration](./aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-ecscapacityincreaseconfig", "UpdateType": "Mutable", "Required": false, "Type": "EcsCapacityIncreaseConfiguration" }, "CustomActionLambdaConfig": { "MarkdownDocumentation": "`CustomActionLambdaConfig`\n\nAn AWS Lambda execution block.\n*Required*: No\n*Type*: [CustomActionLambdaConfiguration](./aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-customactionlambdaconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionLambdaConfiguration" }, "ExecutionApprovalConfig": { "MarkdownDocumentation": "`ExecutionApprovalConfig`\n\nA manual approval execution block.\n*Required*: No\n*Type*: [ExecutionApprovalConfiguration](./aws-properties-arcregionswitch-plan-executionapprovalconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-executionapprovalconfig", "UpdateType": "Mutable", "Required": false, "Type": "ExecutionApprovalConfiguration" }, "Ec2AsgCapacityIncreaseConfig": { "MarkdownDocumentation": "`Ec2AsgCapacityIncreaseConfig`\n\nAn EC2 Auto Scaling group execution block.\n*Required*: No\n*Type*: [Ec2AsgCapacityIncreaseConfiguration](./aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-ec2asgcapacityincreaseconfig", "UpdateType": "Mutable", "Required": false, "Type": "Ec2AsgCapacityIncreaseConfiguration" }, "RegionSwitchPlanConfig": { "MarkdownDocumentation": "`RegionSwitchPlanConfig`\n\nA Region switch plan execution block.\n*Required*: No\n*Type*: [RegionSwitchPlanConfiguration](./aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html#cfn-arcregionswitch-plan-executionblockconfiguration-regionswitchplanconfig", "UpdateType": "Mutable", "Required": false, "Type": "RegionSwitchPlanConfiguration" } } }, "AWS::ARCRegionSwitch::Plan.GlobalAuroraConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.GlobalAuroraConfiguration`\n\nConfiguration for Amazon Aurora global databases used in a Region switch plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html", "Properties": { "DatabaseClusterArns": { "MarkdownDocumentation": "`DatabaseClusterArns`\n\nThe database cluster Amazon Resource Names (ARNs) for a global database.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-databaseclusterarns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe timeout value specified for the configuration.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Behavior": { "MarkdownDocumentation": "`Behavior`\n\nThe behavior for a global database, that is, only allow switchover or also allow failover.\n*Required*: Yes\n*Type*:\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-behavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ungraceful": { "MarkdownDocumentation": "`Ungraceful`\n\nThe settings for ungraceful execution.\n*Required*: No\n*Type*: [GlobalAuroraUngraceful](./aws-properties-arcregionswitch-plan-globalauroraungraceful.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-ungraceful", "UpdateType": "Mutable", "Required": false, "Type": "GlobalAuroraUngraceful" }, "GlobalClusterIdentifier": { "MarkdownDocumentation": "`GlobalClusterIdentifier`\n\nThe global cluster identifier for a global database.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-globalclusteridentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.GlobalAuroraUngraceful": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.GlobalAuroraUngraceful`\n\nConfiguration for handling failures when performing operations on Aurora global databases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraungraceful.html", "Properties": { "Ungraceful": { "MarkdownDocumentation": "`Ungraceful`\n\nThe settings for ungraceful execution.\n*Required*: No\n*Type*: String\n*Allowed values*: `failover`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "failover" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraungraceful.html#cfn-arcregionswitch-plan-globalauroraungraceful-ungraceful", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.KubernetesResourceType": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.KubernetesResourceType`\n\nDefines the type of Kubernetes resource to scale in an Amazon EKS cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesresourcetype.html", "Properties": { "ApiVersion": { "MarkdownDocumentation": "`ApiVersion`\n\nThe API version type for the Kubernetes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesresourcetype.html#cfn-arcregionswitch-plan-kubernetesresourcetype-apiversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Kind": { "MarkdownDocumentation": "`Kind`\n\nThe kind for the Kubernetes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesresourcetype.html#cfn-arcregionswitch-plan-kubernetesresourcetype-kind", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.LambdaUngraceful": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.LambdaUngraceful`\n\nConfiguration for handling failures when invoking Lambda functions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdaungraceful.html", "Properties": { "Behavior": { "MarkdownDocumentation": "`Behavior`\n\nThe ungraceful behavior for a Lambda function, which must be set to `skip`.\n*Required*: No\n*Type*:\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdaungraceful.html#cfn-arcregionswitch-plan-lambdaungraceful-behavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::ARCRegionSwitch::Plan.Lambdas": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Lambdas`\n\nConfiguration for AWS Lambda functions used in a Region switch plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdas.html", "Properties": { "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdas.html#cfn-arcregionswitch-plan-lambdas-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdas.html#cfn-arcregionswitch-plan-lambdas-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdas.html#cfn-arcregionswitch-plan-lambdas-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.ParallelExecutionBlockConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.ParallelExecutionBlockConfiguration`\n\nConfiguration for steps that should be executed in parallel during a Region switch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration.html", "Properties": { "Steps": { "MarkdownDocumentation": "`Steps`\n\nThe steps for a parallel execution block.\n*Required*: Yes\n*Type*: Array of [Step](./aws-properties-arcregionswitch-plan-step.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration.html#cfn-arcregionswitch-plan-parallelexecutionblockconfiguration-steps", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Step", "DuplicatesAllowed": true } } }, "AWS::ARCRegionSwitch::Plan.RegionSwitchPlanConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.RegionSwitchPlanConfiguration`\n\nConfiguration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html", "Properties": { "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the plan configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.ReportConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.ReportConfiguration`\n\nConfiguration for automatic report generation for plan executions. When configured, Region switch automatically generates a report after each plan execution that includes execution events, plan configuration, and CloudWatch alarm states.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-reportconfiguration.html", "Properties": { "ReportOutput": { "MarkdownDocumentation": "`ReportOutput`\n\nThe output configuration for the report.\n*Required*: No\n*Type*: Array of [ReportOutputConfiguration](./aws-properties-arcregionswitch-plan-reportoutputconfiguration.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-reportconfiguration.html#cfn-arcregionswitch-plan-reportconfiguration-reportoutput", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReportOutputConfiguration", "DuplicatesAllowed": true } } }, "AWS::ARCRegionSwitch::Plan.ReportOutputConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.ReportOutputConfiguration`\n\nConfiguration for report output destinations used in a Region switch plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-reportoutputconfiguration.html", "Properties": { "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nConfiguration for delivering reports to an Amazon S3 bucket.\n*Required*: Yes\n*Type*: [S3ReportOutputConfiguration](./aws-properties-arcregionswitch-plan-s3reportoutputconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-reportoutputconfiguration.html#cfn-arcregionswitch-plan-reportoutputconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3ReportOutputConfiguration" } } }, "AWS::ARCRegionSwitch::Plan.Route53HealthCheckConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Route53HealthCheckConfiguration`\n\nThe Amazon Route 53 health check configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html", "Properties": { "RecordName": { "MarkdownDocumentation": "`RecordName`\n\nThe Amazon Route 53 health check configuration record name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe Amazon Route 53 health check configuration time out (in minutes).\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nThe Amazon Route 53 health check configuration hosted zone ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-hostedzoneid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RecordSets": { "MarkdownDocumentation": "`RecordSets`\n\nThe Amazon Route 53 health check configuration record sets.\n*Required*: No\n*Type*: Array of [Route53ResourceRecordSet](./aws-properties-arcregionswitch-plan-route53resourcerecordset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordsets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Route53ResourceRecordSet", "DuplicatesAllowed": true } } }, "AWS::ARCRegionSwitch::Plan.Route53ResourceRecordSet": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Route53ResourceRecordSet`\n\nThe Amazon Route 53 record set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53resourcerecordset.html", "Properties": { "Region": { "MarkdownDocumentation": "`Region`\n\nThe Amazon Route 53 record set Region.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53resourcerecordset.html#cfn-arcregionswitch-plan-route53resourcerecordset-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RecordSetIdentifier": { "MarkdownDocumentation": "`RecordSetIdentifier`\n\nThe Amazon Route 53 record set identifier.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53resourcerecordset.html#cfn-arcregionswitch-plan-route53resourcerecordset-recordsetidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.S3ReportOutputConfiguration": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.S3ReportOutputConfiguration`\n\nConfiguration for delivering generated reports to an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-s3reportoutputconfiguration.html", "Properties": { "BucketPath": { "MarkdownDocumentation": "`BucketPath`\n\nThe S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:s3://)?[a-z0-9][a-z0-9-]{1,61}[a-z0-9](?:/[^/ ][^/]*)*/?$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-s3reportoutputconfiguration.html#cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketOwner": { "MarkdownDocumentation": "`BucketOwner`\n\nThe AWS account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-s3reportoutputconfiguration.html#cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.Service": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Service`\n\nThe service for a cross account role.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html", "Properties": { "ClusterArn": { "MarkdownDocumentation": "`ClusterArn`\n\nThe cluster Amazon Resource Name (ARN) for a service.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z-]*:ecs:[a-z0-9-]+:\\d{12}:cluster/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html#cfn-arcregionswitch-plan-service-clusterarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (secret key) for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html#cfn-arcregionswitch-plan-service-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceArn": { "MarkdownDocumentation": "`ServiceArn`\n\nThe Amazon Resource Name (ARN) for a service.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z-]*:ecs:[a-z0-9-]+:\\d{12}:service/[a-zA-Z0-9_-]+/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html#cfn-arcregionswitch-plan-service-servicearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrossAccountRole": { "MarkdownDocumentation": "`CrossAccountRole`\n\nThe cross account role for a service.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html#cfn-arcregionswitch-plan-service-crossaccountrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.Step": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Step`\n\nRepresents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of a step in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionBlockType": { "MarkdownDocumentation": "`ExecutionBlockType`\n\nThe type of an execution block in a workflow.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CustomActionLambda | Manual...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CustomActionLambda", "ManualApproval", "AuroraGlobalDatabase", "EC2AutoScaling", "ARCRoutingControl", "ARCRegionSwitchPlan", "Parallel", "ECSServiceScaling", "EKSResourceScaling", "Route53HealthCheck", "DocumentDb" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-executionblocktype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExecutionBlockConfiguration": { "MarkdownDocumentation": "`ExecutionBlockConfiguration`\n\nThe configuration for an execution block in a workflow.\n*Required*: Yes\n*Type*: [ExecutionBlockConfiguration](./aws-properties-arcregionswitch-plan-executionblockconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-executionblockconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ExecutionBlockConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a step in a workflow.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.Trigger": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Trigger`\n\nDefines a condition that can automatically trigger the execution of a Region switch plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html", "Properties": { "TargetRegion": { "MarkdownDocumentation": "`TargetRegion`\n\nThe AWS Region for a trigger.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-targetregion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nThe action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `activate | deactivate...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "activate", "deactivate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MinDelayMinutesBetweenExecutions": { "MarkdownDocumentation": "`MinDelayMinutesBetweenExecutions`\n\nThe minimum time, in minutes, that must elapse between automatic executions of the plan.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-mindelayminutesbetweenexecutions", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe conditions that must be met for the trigger to fire.\n*Required*: Yes\n*Type*: Array of [TriggerCondition](./aws-properties-arcregionswitch-plan-triggercondition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-conditions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TriggerCondition", "DuplicatesAllowed": true } } }, "AWS::ARCRegionSwitch::Plan.TriggerCondition": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.TriggerCondition`\n\nDefines a condition that must be met for a trigger to fire.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-triggercondition.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nThe condition that must be met. Valid values include ALARM and OK.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `red | green...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "red", "green" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-triggercondition.html#cfn-arcregionswitch-plan-triggercondition-condition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AssociatedAlarmName": { "MarkdownDocumentation": "`AssociatedAlarmName`\n\nThe name of the CloudWatch alarm associated with the condition.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-triggercondition.html#cfn-arcregionswitch-plan-triggercondition-associatedalarmname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ARCRegionSwitch::Plan.Workflow": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan.Workflow`\n\nRepresents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html", "Properties": { "Steps": { "MarkdownDocumentation": "`Steps`\n\nThe steps that make up the workflow.\n*Required*: No\n*Type*: Array of [Step](./aws-properties-arcregionswitch-plan-step.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-steps", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Step", "DuplicatesAllowed": true }, "WorkflowTargetAction": { "MarkdownDocumentation": "`WorkflowTargetAction`\n\nThe action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `activate | deactivate...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "activate", "deactivate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowtargetaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "WorkflowDescription": { "MarkdownDocumentation": "`WorkflowDescription`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WorkflowTargetRegion": { "MarkdownDocumentation": "`WorkflowTargetRegion`\n\nThe AWS Region that the workflow targets.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowtargetregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ARCZonalShift::ZonalAutoshiftConfiguration.ControlCondition": { "MarkdownDocumentation": "`AWS::ARCZonalShift::ZonalAutoshiftConfiguration.ControlCondition`\n\nA control condition is an alarm that you specify for a practice run. When you configure practice runs\nwith zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch\nto use with the practice run. The alarms that you specify are an\n*outcome alarm*, to monitor application health during practice runs and,\noptionally, a *blocking alarm*, to block practice runs from starting or to interrupt\na practice run in progress.\nControl condition alarms do not apply for autoshifts.\nFor more information, see\n[Considerations when you configure zonal autoshift](https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html) in the ARC Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arczonalshift-zonalautoshiftconfiguration-controlcondition.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the\nonly valid value is `CLOUDWATCH`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]*$`\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arczonalshift-zonalautoshiftconfiguration-controlcondition.html#cfn-arczonalshift-zonalautoshiftconfiguration-controlcondition-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AlarmIdentifier": { "MarkdownDocumentation": "`AlarmIdentifier`\n\nThe Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arczonalshift-zonalautoshiftconfiguration-controlcondition.html#cfn-arczonalshift-zonalautoshiftconfiguration-controlcondition-alarmidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ARCZonalShift::ZonalAutoshiftConfiguration.PracticeRunConfiguration": { "MarkdownDocumentation": "`AWS::ARCZonalShift::ZonalAutoshiftConfiguration.PracticeRunConfiguration`\n\nA practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice\nrun, as well as any blocked dates or blocked windows for the practice run.\nWhen a resource has a practice run configuation, ARC\nstarts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice\nruns help you to make sure that your application can continue to operate normally with the loss of one\nAvailability Zone.\nYou can update or delete a practice run configuration. When you delete a practice run configuration, zonal\nautoshift is disabled for the resource. A practice run configuration is required when zonal autoshift is enabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration.html", "Properties": { "BlockedDates": { "MarkdownDocumentation": "`BlockedDates`\n\nAn array of one or more dates that you can specify when AWS does not start practice runs for a resource.\nDates are in UTC.\nSpecify blocked dates in the format `YYYY-MM-DD`, separated by spaces.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `10 | 0`\n*Maximum*: `10 | 15`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration-blockeddates", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "OutcomeAlarms": { "MarkdownDocumentation": "`OutcomeAlarms`\n\nThe alarm that you specify to monitor the health of your application during practice runs. When the outcome alarm\ngoes into an `ALARM` state, the practice run is ended and the outcome is set to `FAILED`.\n*Required*: Yes\n*Type*: Array of [ControlCondition](./aws-properties-arczonalshift-zonalautoshiftconfiguration-controlcondition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration-outcomealarms", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ControlCondition", "DuplicatesAllowed": true }, "BlockingAlarms": { "MarkdownDocumentation": "`BlockingAlarms`\n\nAn optional alarm that you can specify that blocks practice runs when the alarm is in an `ALARM` state.\nWhen a blocking alarm goes into an `ALARM` state, it prevents practice runs from being started, and ends practice runs that are in progress.\n*Required*: No\n*Type*: Array of [ControlCondition](./aws-properties-arczonalshift-zonalautoshiftconfiguration-controlcondition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration-blockingalarms", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ControlCondition", "DuplicatesAllowed": true }, "BlockedWindows": { "MarkdownDocumentation": "`BlockedWindows`\n\nAn array of one or more days and times that you can specify when ARC does not start practice runs for a resource. Days\nand times are in UTC.\nSpecify blocked windows in the format `DAY:HH:MM-DAY:HH:MM`, separated by spaces. For example,\n`MON:18:30-MON:19:30 TUE:18:30-TUE:19:30`.\n###### Important\nBlocked windows have to start and end on the same day. Windows that span multiple days aren't supported.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `19 | 0`\n*Maximum*: `19 | 15`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration-blockedwindows", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::AccessAnalyzer::Analyzer.AnalysisRule": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.AnalysisRule`\n\nContains information about analysis rules for the analyzer. Analysis rules determine\nwhich entities will generate findings based on the criteria you define when you create the\nrule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analysisrule.html", "Properties": { "Exclusions": { "MarkdownDocumentation": "`Exclusions`\n\nA list of rules for the analyzer containing criteria to exclude from analysis. Entities\nthat meet the rule criteria will not generate findings.\n*Required*: No\n*Type*: Array of [AnalysisRuleCriteria](./aws-properties-accessanalyzer-analyzer-analysisrulecriteria.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analysisrule.html#cfn-accessanalyzer-analyzer-analysisrule-exclusions", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "AnalysisRuleCriteria", "DuplicatesAllowed": true } } }, "AWS::AccessAnalyzer::Analyzer.AnalysisRuleCriteria": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.AnalysisRuleCriteria`\n\nThe criteria for an analysis rule for an analyzer. The criteria determine which entities\nwill generate findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analysisrulecriteria.html", "Properties": { "AccountIds": { "MarkdownDocumentation": "`AccountIds`\n\nA list of AWS account IDs to apply to the analysis rule criteria. The accounts cannot\ninclude the organization analyzer owner account. Account IDs can only be applied to the\nanalysis rule criteria for organization-level analyzers. The list cannot include more than\n2,000 account IDs.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analysisrulecriteria.html#cfn-accessanalyzer-analyzer-analysisrulecriteria-accountids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nAn array of key-value pairs to match for your resources. You can use the set of Unicode\nletters, digits, whitespace, `_`, `.`, `/`,\n`=`, `+`, and `-`.\nFor the tag key, you can specify a value that is 1 to 128 characters in length and\ncannot be prefixed with `aws:`.\nFor the tag value, you can specify a value that is 0 to 256 characters in length. If the\nspecified tag value is 0 characters, the rule is applied to all principals with the\nspecified tag key.\n*Required*: No\n*Type*: Array of Array\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analysisrulecriteria.html#cfn-accessanalyzer-analyzer-analysisrulecriteria-resourcetags", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Json" } } }, "AWS::AccessAnalyzer::Analyzer.AnalyzerConfiguration": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.AnalyzerConfiguration`\n\nContains information about the configuration of an analyzer for an AWS organization or\naccount.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analyzerconfiguration.html", "Properties": { "InternalAccessConfiguration": { "MarkdownDocumentation": "`InternalAccessConfiguration`\n\nSpecifies the configuration of an internal access analyzer for an AWS\norganization or account. This configuration determines how the analyzer evaluates access\nwithin your AWS environment.\n*Required*: No\n*Type*: [InternalAccessConfiguration](./aws-properties-accessanalyzer-analyzer-internalaccessconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analyzerconfiguration.html#cfn-accessanalyzer-analyzer-analyzerconfiguration-internalaccessconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "InternalAccessConfiguration" }, "UnusedAccessConfiguration": { "MarkdownDocumentation": "`UnusedAccessConfiguration`\n\nSpecifies the configuration of an unused access analyzer for an AWS organization or\naccount.\n*Required*: No\n*Type*: [UnusedAccessConfiguration](./aws-properties-accessanalyzer-analyzer-unusedaccessconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analyzerconfiguration.html#cfn-accessanalyzer-analyzer-analyzerconfiguration-unusedaccessconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "UnusedAccessConfiguration" } } }, "AWS::AccessAnalyzer::Analyzer.ArchiveRule": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.ArchiveRule`\n\nContains information about an archive rule. Archive rules automatically archive new\nfindings that meet the criteria you define when you create the rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe criteria for the rule.\n*Required*: Yes\n*Type*: [Array](./aws-properties-accessanalyzer-analyzer-filter.html) of [Filter](./aws-properties-accessanalyzer-analyzer-filter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html#cfn-accessanalyzer-analyzer-archiverule-filter", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": true }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nThe name of the rule to create.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z][A-Za-z0-9_.-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html#cfn-accessanalyzer-analyzer-archiverule-rulename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AccessAnalyzer::Analyzer.Filter": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.Filter`\n\nThe criteria that defines the archive rule.\nTo learn about filter keys that you can use to create an archive rule, see [AWS Identity and Access Management Access Analyzer filter keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) in the\n*AWS Identity and Access Management User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html", "Properties": { "Exists": { "MarkdownDocumentation": "`Exists`\n\nAn \"exists\" condition to match for the rule.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-exists", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Contains": { "MarkdownDocumentation": "`Contains`\n\nA \"contains\" condition to match for the rule.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-contains", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Neq": { "MarkdownDocumentation": "`Neq`\n\nA \"not equal\" condition to match for the rule.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-neq", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Eq": { "MarkdownDocumentation": "`Eq`\n\nAn \"equals\" condition to match for the rule.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-eq", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Property": { "MarkdownDocumentation": "`Property`\n\nThe property used to define the criteria in the filter for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-property", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AccessAnalyzer::Analyzer.InternalAccessAnalysisRule": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.InternalAccessAnalysisRule`\n\nContains information about analysis rules for the internal access analyzer. Analysis\nrules determine which entities will generate findings based on the criteria you define\nwhen you create the rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-internalaccessanalysisrule.html", "Properties": { "Inclusions": { "MarkdownDocumentation": "`Inclusions`\n\nA list of rules for the internal access analyzer containing criteria to include in\nanalysis. Only resources that meet the rule criteria will generate findings.\n*Required*: No\n*Type*: Array of [InternalAccessAnalysisRuleCriteria](./aws-properties-accessanalyzer-analyzer-internalaccessanalysisrulecriteria.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-internalaccessanalysisrule.html#cfn-accessanalyzer-analyzer-internalaccessanalysisrule-inclusions", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "InternalAccessAnalysisRuleCriteria", "DuplicatesAllowed": true } } }, "AWS::AccessAnalyzer::Analyzer.InternalAccessAnalysisRuleCriteria": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.InternalAccessAnalysisRuleCriteria`\n\nThe criteria for an analysis rule for an internal access analyzer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-internalaccessanalysisrulecriteria.html", "Properties": { "ResourceTypes": { "MarkdownDocumentation": "`ResourceTypes`\n\nA list of resource types to apply to the internal access analysis rule criteria. The\nanalyzer will only generate findings for resources of these types. These resource types\nare currently supported for internal access analyzers:\n* `AWS::S3::Bucket`\n* `AWS::RDS::DBSnapshot`\n* `AWS::RDS::DBClusterSnapshot`\n* `AWS::S3Express::DirectoryBucket`\n* `AWS::DynamoDB::Table`\n* `AWS::DynamoDB::Stream`\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-internalaccessanalysisrulecriteria.html#cfn-accessanalyzer-analyzer-internalaccessanalysisrulecriteria-resourcetypes", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AccountIds": { "MarkdownDocumentation": "`AccountIds`\n\nA list of AWS account IDs to apply to the internal access analysis rule\ncriteria. Account IDs can only be applied to the analysis rule criteria for\norganization-level analyzers.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-internalaccessanalysisrulecriteria.html#cfn-accessanalyzer-analyzer-internalaccessanalysisrulecriteria-accountids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ResourceArns": { "MarkdownDocumentation": "`ResourceArns`\n\nA list of resource ARNs to apply to the internal access analysis rule criteria. The\nanalyzer will only generate findings for resources that match these ARNs.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-internalaccessanalysisrulecriteria.html#cfn-accessanalyzer-analyzer-internalaccessanalysisrulecriteria-resourcearns", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::AccessAnalyzer::Analyzer.InternalAccessConfiguration": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.InternalAccessConfiguration`\n\nSpecifies the configuration of an internal access analyzer for an AWS\norganization or account. This configuration determines how the analyzer evaluates\ninternal access within your AWS environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-internalaccessconfiguration.html", "Properties": { "InternalAccessAnalysisRule": { "MarkdownDocumentation": "`InternalAccessAnalysisRule`\n\nContains information about analysis rules for the internal access analyzer. These\nrules determine which resources and access patterns will be analyzed.\n*Required*: No\n*Type*: [InternalAccessAnalysisRule](./aws-properties-accessanalyzer-analyzer-internalaccessanalysisrule.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-internalaccessconfiguration.html#cfn-accessanalyzer-analyzer-internalaccessconfiguration-internalaccessanalysisrule", "UpdateType": "Conditional", "Required": false, "Type": "InternalAccessAnalysisRule" } } }, "AWS::AccessAnalyzer::Analyzer.UnusedAccessConfiguration": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer.UnusedAccessConfiguration`\n\nContains information about an unused access analyzer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-unusedaccessconfiguration.html", "Properties": { "UnusedAccessAge": { "MarkdownDocumentation": "`UnusedAccessAge`\n\nThe specified access age in days for which to generate findings for unused access. For\nexample, if you specify 90 days, the analyzer will generate findings for IAM entities\nwithin the accounts of the selected organization for any access that hasn't been used in 90\nor more days since the analyzer's last scan. You can choose a value between 1 and 365\ndays.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `365`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-unusedaccessconfiguration.html#cfn-accessanalyzer-analyzer-unusedaccessconfiguration-unusedaccessage", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "AnalysisRule": { "MarkdownDocumentation": "`AnalysisRule`\n\nContains information about analysis rules for the analyzer. Analysis rules determine\nwhich entities will generate findings based on the criteria you define when you create the\nrule.\n*Required*: No\n*Type*: [AnalysisRule](./aws-properties-accessanalyzer-analyzer-analysisrule.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-unusedaccessconfiguration.html#cfn-accessanalyzer-analyzer-unusedaccessconfiguration-analysisrule", "UpdateType": "Conditional", "Required": false, "Type": "AnalysisRule" } } }, "AWS::AmazonMQ::Broker.ConfigurationId": { "MarkdownDocumentation": "`AWS::AmazonMQ::Broker.ConfigurationId`\n\nA list of information about the configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html", "Properties": { "Revision": { "MarkdownDocumentation": "`Revision`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-revision", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Id": { "MarkdownDocumentation": "`Id`\n\nRequired. The unique ID that Amazon MQ generates for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmazonMQ::Broker.EncryptionOptions": { "MarkdownDocumentation": "`AWS::AmazonMQ::Broker.EncryptionOptions`\n\nEncryption options for the broker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe customer master key (CMK) to use for the A AWS KMS (KMS).\nThis key is used to encrypt your data at rest. If not provided, Amazon MQ will use a\ndefault CMK to encrypt your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html#cfn-amazonmq-broker-encryptionoptions-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UseAwsOwnedKey": { "MarkdownDocumentation": "`UseAwsOwnedKey`\n\nEnables the use of an AWS owned CMK using AWS KMS (KMS). Set to `true` by default, if no value is provided, for example,\nfor RabbitMQ brokers.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html#cfn-amazonmq-broker-encryptionoptions-useawsownedkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::AmazonMQ::Broker.LdapServerMetadata": { "MarkdownDocumentation": "`AWS::AmazonMQ::Broker.LdapServerMetadata`\n\nOptional. The metadata of the LDAP server used to authenticate and authorize\nconnections to the broker. Does not apply to RabbitMQ brokers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html", "Properties": { "Hosts": { "MarkdownDocumentation": "`Hosts`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-hosts", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UserRoleName": { "MarkdownDocumentation": "`UserRoleName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-userrolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserSearchMatching": { "MarkdownDocumentation": "`UserSearchMatching`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-usersearchmatching", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleName": { "MarkdownDocumentation": "`RoleName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-rolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserBase": { "MarkdownDocumentation": "`UserBase`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-userbase", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UserSearchSubtree": { "MarkdownDocumentation": "`UserSearchSubtree`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-usersearchsubtree", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleSearchMatching": { "MarkdownDocumentation": "`RoleSearchMatching`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-rolesearchmatching", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServiceAccountUsername": { "MarkdownDocumentation": "`ServiceAccountUsername`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-serviceaccountusername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleBase": { "MarkdownDocumentation": "`RoleBase`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-rolebase", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServiceAccountPassword": { "MarkdownDocumentation": "`ServiceAccountPassword`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-serviceaccountpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleSearchSubtree": { "MarkdownDocumentation": "`RoleSearchSubtree`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-rolesearchsubtree", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AmazonMQ::Broker.LogList": { "MarkdownDocumentation": "`AWS::AmazonMQ::Broker.LogList`\n\nThe list of information about logs to be enabled for the specified broker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html", "Properties": { "Audit": { "MarkdownDocumentation": "`Audit`\n\nEnables audit logging. Every user management action made using JMX or the ActiveMQ\nWeb Console is logged. Does not apply to RabbitMQ brokers.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-audit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "General": { "MarkdownDocumentation": "`General`\n\nEnables general 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-general", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AmazonMQ::Broker.MaintenanceWindow": { "MarkdownDocumentation": "`AWS::AmazonMQ::Broker.MaintenanceWindow`\n\nThe parameters that determine the WeeklyStartTime.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html", "Properties": { "DayOfWeek": { "MarkdownDocumentation": "`DayOfWeek`\n\nRequired. The day of the week.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MONDAY | TUESDAY | WEDNESDA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-dayofweek", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeOfDay": { "MarkdownDocumentation": "`TimeOfDay`\n\nRequired. The time, in 24-hour format.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]{1,2}:[0-9]{2}(:[0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timeofday", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeZone": { "MarkdownDocumentation": "`TimeZone`\n\nThe time zone, UTC by default, in either the Country/City format, or the UTC\noffset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timezone", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmazonMQ::Broker.TagsEntry": { "MarkdownDocumentation": "`AWS::AmazonMQ::Broker.TagsEntry`\n\nCreate tags when creating the broker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmazonMQ::Broker.User": { "MarkdownDocumentation": "`AWS::AmazonMQ::Broker.User`\n\nThe list of broker users (persons or applications) who can access queues and topics.\nFor Amazon MQ for RabbitMQ brokers, one and only one administrative user is\naccepted and created when a broker is first provisioned. All subsequent broker users are created by making\nRabbitMQ API calls directly to brokers or via the RabbitMQ web console.\nWhen OAuth 2.0 is enabled, the broker accepts one or no users.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html", "Properties": { "ReplicationUser": { "MarkdownDocumentation": "`ReplicationUser`\n\nDefines if this user is intended for CRDR replication purposes.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-replicationuser", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Username": { "MarkdownDocumentation": "`Username`\n\nThe username of the broker user. The following restrictions apply to broker usernames:\n* For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . \\_ ~).\n This value must be 2-100 characters long.\n* For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . \\_).\n This value must not contain a tilde (~) character. Amazon MQ prohibts using `guest` as a valid usename.\n This value must be 2-100 characters long.\n###### Important\nDo not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames.\nBroker usernames are accessible to other AWS services, including CloudWatch Logs. Broker usernames are not intended to be\nused for private or sensitive data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_.~-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe list of groups (20 maximum) to which the ActiveMQ user belongs. This value can\ncontain only alphanumeric characters, dashes, periods, underscores, and tildes (- . \\_\n~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ConsoleAccess": { "MarkdownDocumentation": "`ConsoleAccess`\n\nEnables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-consoleaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Password": { "MarkdownDocumentation": "`Password`\n\nRequired. The password of the user. This value must be at least 12 characters\nlong, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^,:=]+$`\n*Minimum*: `12`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmazonMQ::Configuration.TagsEntry": { "MarkdownDocumentation": "`AWS::AmazonMQ::Configuration.TagsEntry`\n\nThe list of all tags associated with this configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html#cfn-amazonmq-configuration-tagsentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html#cfn-amazonmq-configuration-tagsentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmazonMQ::ConfigurationAssociation.ConfigurationId": { "MarkdownDocumentation": "`AWS::AmazonMQ::ConfigurationAssociation.ConfigurationId`\n\nA list of information about the configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html", "Properties": { "Revision": { "MarkdownDocumentation": "`Revision`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html#cfn-amazonmq-configurationassociation-configurationid-revision", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Id": { "MarkdownDocumentation": "`Id`\n\nRequired. The unique ID that Amazon MQ generates for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html#cfn-amazonmq-configurationassociation-configurationid-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Amplify::App.AutoBranchCreationConfig": { "MarkdownDocumentation": "`AWS::Amplify::App.AutoBranchCreationConfig`\n\nUse the AutoBranchCreationConfig property type to automatically create branches that\nmatch a certain pattern.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html", "Properties": { "EnvironmentVariables": { "MarkdownDocumentation": "`EnvironmentVariables`\n\nThe environment variables for the autocreated branch.\n*Required*: No\n*Type*: Array of [EnvironmentVariable](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-environmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentVariable", "DuplicatesAllowed": true }, "AutoBranchCreationPatterns": { "MarkdownDocumentation": "`AutoBranchCreationPatterns`\n\nAutomated branch creation glob patterns for the Amplify app.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-autobranchcreationpatterns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnableAutoBranchCreation": { "MarkdownDocumentation": "`EnableAutoBranchCreation`\n\nEnables 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableautobranchcreation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PullRequestEnvironmentName": { "MarkdownDocumentation": "`PullRequestEnvironmentName`\n\nIf pull request previews are enabled, you can use this property to specify a dedicated\nbackend environment for your previews. For example, you could specify an environment named\n`prod`, `test`, or `dev` that you initialized with the\nAmplify CLI.\nTo enable pull request previews, set the `EnablePullRequestPreview` property\nto `true`.\nIf you don't specify an environment, Amplify Hosting provides backend support for each\npreview by automatically provisioning a temporary backend environment. Amplify deletes this\nenvironment when the pull request is closed.\nFor more information about creating backend environments, see [Feature Branch\nDeployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting\nUser Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-pullrequestenvironmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnablePullRequestPreview": { "MarkdownDocumentation": "`EnablePullRequestPreview`\n\nSets whether pull request previews are enabled for each branch that Amplify Hosting\nautomatically creates for your app. Amplify creates previews by deploying your app to a unique\nURL whenever a pull request is opened for the branch. Development and QA teams can use this\npreview to test the pull request before it's merged into a production or integration\nbranch.\nTo provide backend support for your preview, Amplify Hosting automatically provisions a\ntemporary backend environment that it deletes when the pull request is closed. If you want to\nspecify a dedicated backend environment for your previews, use the\n`PullRequestEnvironmentName` property.\nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enablepullrequestpreview", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableAutoBuild": { "MarkdownDocumentation": "`EnableAutoBuild`\n\nEnables 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableautobuild", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnablePerformanceMode": { "MarkdownDocumentation": "`EnablePerformanceMode`\n\nEnables performance mode for the branch.\nPerformance mode optimizes for faster hosting performance by keeping content cached at\nthe edge for a longer interval. When performance mode is enabled, hosting configuration\nor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableperformancemode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BuildSpec": { "MarkdownDocumentation": "`BuildSpec`\n\nThe build specification (build spec) for the autocreated branch.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `25000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-buildspec", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Stage": { "MarkdownDocumentation": "`Stage`\n\nStage for the auto created branch.\n*Required*: No\n*Type*: String\n*Allowed values*: `EXPERIMENTAL | BETA | PULL_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXPERIMENTAL", "BETA", "PULL_REQUEST", "PRODUCTION", "DEVELOPMENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-stage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BasicAuthConfig": { "MarkdownDocumentation": "`BasicAuthConfig`\n\nSets password protection for your auto created branch.\n*Required*: No\n*Type*: [BasicAuthConfig](./aws-properties-amplify-app-basicauthconfig.html)\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-basicauthconfig", "UpdateType": "Mutable", "Required": false, "Type": "BasicAuthConfig" }, "Framework": { "MarkdownDocumentation": "`Framework`\n\nThe framework for the autocreated branch.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-framework", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Amplify::App.BasicAuthConfig": { "MarkdownDocumentation": "`AWS::Amplify::App.BasicAuthConfig`\n\nUse the BasicAuthConfig property type to set password protection at an app level to all\nyour branches.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe user name for basic authorization.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-username", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableBasicAuth": { "MarkdownDocumentation": "`EnableBasicAuth`\n\nEnables basic authorization for the Amplify app's branches.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-enablebasicauth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password for basic authorization.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-password", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Amplify::App.CacheConfig": { "MarkdownDocumentation": "`AWS::Amplify::App.CacheConfig`\n\nDescribes the cache configuration for an Amplify app.\nFor more information about how Amplify applies an optimal cache\nconfiguration for your app based on the type of content that is being served, see [Managing cache configuration](https://docs.aws.amazon.com/amplify/latest/userguide/managing-cache-configuration) in the *Amplify User\nguide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-cacheconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of cache configuration to use for an Amplify app.\nThe `AMPLIFY_MANAGED` cache configuration automatically applies an\noptimized cache configuration for your app based on its platform, routing rules, and\nrewrite rules.\nThe `AMPLIFY_MANAGED_NO_COOKIES` cache configuration type is the same as\n`AMPLIFY_MANAGED`, except that it excludes all cookies from the cache\nkey. This is the default setting.\n*Required*: No\n*Type*: String\n*Allowed values*: `AMPLIFY_MANAGED | AMPLIFY_M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AMPLIFY_MANAGED", "AMPLIFY_MANAGED_NO_COOKIES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-cacheconfig.html#cfn-amplify-app-cacheconfig-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Amplify::App.CustomRule": { "MarkdownDocumentation": "`AWS::Amplify::App.CustomRule`\n\nThe CustomRule property type allows you to specify redirects, rewrites, and reverse\nproxies. Redirects enable a web app to reroute navigation from one URL to another.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nThe condition for a URL rewrite or redirect rule, such as a country code.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-condition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Status": { "MarkdownDocumentation": "`Status`\n\nThe status code for a URL rewrite or redirect rule.\n200\nRepresents a 200 rewrite rule.\n\n301\nRepresents a 301 (moved pemanently) redirect rule. This and all future requests\nshould be directed to the target URL.\n\n302\nRepresents a 302 temporary redirect rule.\n\n404\nRepresents a 404 redirect rule.\n\n404-200\nRepresents a 404 rewrite rule.\n\n*Required*: No\n*Type*: String\n*Pattern*: `.{3,7}`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Target": { "MarkdownDocumentation": "`Target`\n\nThe target pattern for a URL rewrite or redirect rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-target", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source pattern for a URL rewrite or redirect rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-source", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Amplify::App.EnvironmentVariable": { "MarkdownDocumentation": "`AWS::Amplify::App.EnvironmentVariable`\n\nEnvironment variables are key-value pairs that are available at build time. Set\nenvironment variables for all branches in your app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe environment variable value.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).*`\n*Maximum*: `5500`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html#cfn-amplify-app-environmentvariable-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe environment variable name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html#cfn-amplify-app-environmentvariable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Amplify::App.JobConfig": { "MarkdownDocumentation": "`AWS::Amplify::App.JobConfig`\n\nDescribes the configuration details that apply to the jobs for an Amplify app.\nUse `JobConfig` to apply configuration to jobs, such as customizing the build instance size when you create or\nupdate an Amplify app. For more information about customizable build\ninstances, see [Custom build instances](https://docs.aws.amazon.com/amplify/latest/userguide/custom-build-instance.html) in the *Amplify User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-jobconfig.html", "Properties": { "BuildComputeType": { "MarkdownDocumentation": "`BuildComputeType`\n\nSpecifies the size of the build instance. Amplify supports three\ninstance sizes: `STANDARD_8GB`, `LARGE_16GB`, and\n`XLARGE_72GB`. If you don't specify a value, Amplify uses\nthe `STANDARD_8GB` default.\nThe following list describes the CPU, memory, and storage capacity for each build\ninstance type:\nSTANDARD\\_8GB\n* vCPUs: 4\n* Memory: 8 GiB\n* Disk space: 128 GB\n\nLARGE\\_16GB\n* vCPUs: 8\n* Memory: 16 GiB\n* Disk space: 128 GB\n\nXLARGE\\_72GB\n* vCPUs: 36\n* Memory: 72 GiB\n* Disk space: 256 GB\n\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STANDARD_8GB | LARGE_16GB |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD_8GB", "LARGE_16GB", "XLARGE_72GB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-jobconfig.html#cfn-amplify-app-jobconfig-buildcomputetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Amplify::Branch.Backend": { "MarkdownDocumentation": "`AWS::Amplify::Branch.Backend`\n\nDescribes the backend associated with an Amplify\n`Branch`.\nThis property is available to Amplify Gen 2 apps only. When you deploy\nan application with Amplify Gen 2, you provision the app's backend infrastructure using\nTypescript code.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-backend.html", "Properties": { "StackArn": { "MarkdownDocumentation": "`StackArn`\n\nThe Amazon Resource Name (ARN) for the CloudFormation stack.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-backend.html#cfn-amplify-branch-backend-stackarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Amplify::Branch.BasicAuthConfig": { "MarkdownDocumentation": "`AWS::Amplify::Branch.BasicAuthConfig`\n\nUse the BasicAuthConfig property type to set password protection for a specific\nbranch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnableBasicAuth": { "MarkdownDocumentation": "`EnableBasicAuth`\n\nEnables basic authorization 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-enablebasicauth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password for basic authorization.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Amplify::Branch.EnvironmentVariable": { "MarkdownDocumentation": "`AWS::Amplify::Branch.EnvironmentVariable`\n\nThe EnvironmentVariable property type sets environment variables for a specific branch.\nEnvironment variables are key-value pairs that are available at build time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe environment variable value.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).*`\n*Maximum*: `5500`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html#cfn-amplify-branch-environmentvariable-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe environment variable name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html#cfn-amplify-branch-environmentvariable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Amplify::Domain.Certificate": { "MarkdownDocumentation": "`AWS::Amplify::Domain.Certificate`\n\nDescribes the SSL/TLS certificate for the domain association. This can be your own\ncustom certificate or the default certificate that Amplify provisions for\nyou.\nIf you are updating your domain to use a different certificate,\n`Certificate` points to the new certificate that is being created instead\nof the current active certificate. Otherwise, `Certificate` points to the\ncurrent active certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificate.html", "Properties": { "CertificateType": { "MarkdownDocumentation": "`CertificateType`\n\nThe type of SSL/TLS certificate that you want to use.\nSpecify `AMPLIFY_MANAGED` to use the default certificate that Amplify\nprovisions for you.\nSpecify `CUSTOM` to use your own certificate that you have already added to\nAWS Certificate Manager in your AWS account. Make sure you request (or\nimport) the certificate in the US East (N. Virginia) Region (us-east-1). For more\ninformation about using ACM, see [Importing certificates into\nAWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User\nguide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `AMPLIFY_MANAGED | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AMPLIFY_MANAGED", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificate.html#cfn-amplify-domain-certificate-certificatetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateVerificationDNSRecord": { "MarkdownDocumentation": "`CertificateVerificationDNSRecord`\n\nThe DNS record for certificate verification.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificate.html#cfn-amplify-domain-certificate-certificateverificationdnsrecord", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon resource name (ARN) for a custom certificate that you have already added to\nAWS Certificate Manager in your AWS account.\nThis field is required only when the certificate type is `CUSTOM`.\n*Required*: No\n*Type*: String\n*Pattern*: `\"^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$\"`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificate.html#cfn-amplify-domain-certificate-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Amplify::Domain.CertificateSettings": { "MarkdownDocumentation": "`AWS::Amplify::Domain.CertificateSettings`\n\nThe type of SSL/TLS certificate to use for your custom domain. If a certificate type\nisn't specified, Amplify uses the default `AMPLIFY_MANAGED`\ncertificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificatesettings.html", "Properties": { "CertificateType": { "MarkdownDocumentation": "`CertificateType`\n\nThe certificate type.\nSpecify `AMPLIFY_MANAGED` to use the default certificate that Amplify\nprovisions for you.\nSpecify `CUSTOM` to use your own certificate that you have already added to\nAWS Certificate Manager in your AWS account. Make sure you request (or\nimport) the certificate in the US East (N. Virginia) Region (us-east-1). For more\ninformation about using ACM, see [Importing certificates into\nAWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User\nguide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `AMPLIFY_MANAGED | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AMPLIFY_MANAGED", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificatesettings.html#cfn-amplify-domain-certificatesettings-certificatetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomCertificateArn": { "MarkdownDocumentation": "`CustomCertificateArn`\n\nThe Amazon resource name (ARN) for the custom certificate that you have already added\nto AWS Certificate Manager in your AWS account.\nThis field is required only when the certificate type is `CUSTOM`.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificatesettings.html#cfn-amplify-domain-certificatesettings-customcertificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Amplify::Domain.SubDomainSetting": { "MarkdownDocumentation": "`AWS::Amplify::Domain.SubDomainSetting`\n\nThe SubDomainSetting property type enables you to connect a subdomain (for example,\nexample.exampledomain.com) to a specific branch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html", "Properties": { "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe prefix setting for the subdomain.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-prefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BranchName": { "MarkdownDocumentation": "`BranchName`\n\nThe branch name setting for the subdomain.\n*Length Constraints:* Minimum length of 1. Maximum length of\n255.\n*Pattern:* (?s).+\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-branchname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.ActionParameters": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ActionParameters`\n\nRepresents the event action configuration for an element of a `Component` or\n`ComponentChild`. Use for the workflow feature in Amplify Studio\nthat allows you to bind events and actions to components. `ActionParameters`\ndefines the action that is performed when an event occurs on the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of navigation action. Valid values are `url` and `anchor`.\nThis value is required for a navigation action.\n*Required*: No\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-type", "UpdateType": "Mutable", "Required": false, "Type": "ComponentProperty" }, "Anchor": { "MarkdownDocumentation": "`Anchor`\n\nThe HTML anchor link to the location to open. Specify this value for a navigation\naction.\n*Required*: No\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-anchor", "UpdateType": "Mutable", "Required": false, "Type": "ComponentProperty" }, "Target": { "MarkdownDocumentation": "`Target`\n\nThe element within the same component to modify when the action occurs.\n*Required*: No\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-target", "UpdateType": "Mutable", "Required": false, "Type": "ComponentProperty" }, "Fields": { "MarkdownDocumentation": "`Fields`\n\nA dictionary of key-value pairs mapping Amplify Studio properties to fields\nin a data model. Use when the action performs an operation on an Amplify\nDataStore model.\n*Required*: No\n*Type*: Object of [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-fields", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ComponentProperty" }, "State": { "MarkdownDocumentation": "`State`\n\nA key-value pair that specifies the state property name and its initial value.\n*Required*: No\n*Type*: [MutationActionSetStateParameter](./aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-state", "UpdateType": "Mutable", "Required": false, "Type": "MutationActionSetStateParameter" }, "Model": { "MarkdownDocumentation": "`Model`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-model", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe unique ID of the component that the `ActionParameters` apply to.\n*Required*: No\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-id", "UpdateType": "Mutable", "Required": false, "Type": "ComponentProperty" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL to the location to open. Specify this value for a navigation action.\n*Required*: No\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-url", "UpdateType": "Mutable", "Required": false, "Type": "ComponentProperty" }, "Global": { "MarkdownDocumentation": "`Global`\n\nSpecifies whether the user should be signed out globally. Specify this value for an auth\nsign out action.\n*Required*: No\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-global", "UpdateType": "Mutable", "Required": false, "Type": "ComponentProperty" } } }, "AWS::AmplifyUIBuilder::Component.ComponentBindingPropertiesValue": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentBindingPropertiesValue`\n\nThe `ComponentBindingPropertiesValue` property specifies the data binding configuration for a component at runtime. You can use\n`ComponentBindingPropertiesValue` to add exposed properties to a component to\nallow different values to be entered when a component is reused in different places in an\napp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe default value of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe property 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BindingProperties": { "MarkdownDocumentation": "`BindingProperties`\n\nDescribes the properties to customize with data at runtime.\n*Required*: No\n*Type*: [ComponentBindingPropertiesValueProperties](./aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-bindingproperties", "UpdateType": "Mutable", "Required": false, "Type": "ComponentBindingPropertiesValueProperties" } } }, "AWS::AmplifyUIBuilder::Component.ComponentBindingPropertiesValueProperties": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentBindingPropertiesValueProperties`\n\nThe `ComponentBindingPropertiesValueProperties` property specifies the data\nbinding configuration for a specific property using data stored in AWS. For\nAWS connected properties, you can bind a property to data stored in an\nAmazon S3 bucket, an Amplify DataStore model or an authenticated user\nattribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field to bind the data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe default value to assign to the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-bucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserAttribute": { "MarkdownDocumentation": "`UserAttribute`\n\nAn authenticated user 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-userattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Model": { "MarkdownDocumentation": "`Model`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-model", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Predicates": { "MarkdownDocumentation": "`Predicates`\n\nA list of predicates for binding a component's properties to data.\n*Required*: No\n*Type*: Array of [Predicate](./aws-properties-amplifyuibuilder-component-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-predicates", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Predicate", "DuplicatesAllowed": true }, "SlotName": { "MarkdownDocumentation": "`SlotName`\n\nThe name of a component 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-slotname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe storage key for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.ComponentChild": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentChild`\n\nThe `ComponentChild` property specifies a nested UI configuration within a\nparent `Component`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html", "Properties": { "ComponentType": { "MarkdownDocumentation": "`ComponentType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-componenttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Events": { "MarkdownDocumentation": "`Events`\n\nDescribes the events that can be raised on the child component. Use for the workflow\nfeature in Amplify Studio that allows you to bind events and actions to\ncomponents.\n*Required*: No\n*Type*: Object of [ComponentEvent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-events", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ComponentEvent" }, "SourceId": { "MarkdownDocumentation": "`SourceId`\n\nThe unique ID of the child 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-sourceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Children": { "MarkdownDocumentation": "`Children`\n\nThe list of `ComponentChild` instances for this component.\n*Required*: No\n*Type*: Array of [ComponentChild](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-children", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ComponentChild", "DuplicatesAllowed": true }, "Properties": { "MarkdownDocumentation": "`Properties`\n\nDescribes the properties of the child component. You can't specify `tags` as a\nvalid property for `properties`.\n*Required*: Yes\n*Type*: Object of [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-properties", "UpdateType": "Mutable", "Required": true, "Type": "Map", "ItemType": "ComponentProperty" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.ComponentConditionProperty": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentConditionProperty`\n\nThe `ComponentConditionProperty` property specifies a conditional expression\nfor setting a component property. Use `ComponentConditionProperty` to set a\nproperty to different values conditionally, based on the value of another property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe operator to use to perform the evaluation, such as `eq` to represent\nequals.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Field": { "MarkdownDocumentation": "`Field`\n\nThe name of a field. Specify this when the property is a data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Operand": { "MarkdownDocumentation": "`Operand`\n\nThe value of the property to evaluate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OperandType": { "MarkdownDocumentation": "`OperandType`\n\nThe type of the property to evaluate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operandtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Else": { "MarkdownDocumentation": "`Else`\n\nThe value to assign to the property if the condition is not met.\n*Required*: No\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-else", "UpdateType": "Mutable", "Required": false, "Type": "ComponentProperty" }, "Then": { "MarkdownDocumentation": "`Then`\n\nThe value to assign to the property if the condition is met.\n*Required*: No\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-then", "UpdateType": "Mutable", "Required": false, "Type": "ComponentProperty" }, "Property": { "MarkdownDocumentation": "`Property`\n\nThe name of the conditional 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-property", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.ComponentDataConfiguration": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentDataConfiguration`\n\nThe `ComponentDataConfiguration` property specifies the configuration for\nbinding a component's properties to data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html", "Properties": { "Model": { "MarkdownDocumentation": "`Model`\n\nThe name of the data model to use to bind data to a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-model", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Sort": { "MarkdownDocumentation": "`Sort`\n\nDescribes how to sort the component's properties.\n*Required*: No\n*Type*: Array of [SortProperty](./aws-properties-amplifyuibuilder-component-sortproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-sort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SortProperty", "DuplicatesAllowed": true }, "Identifiers": { "MarkdownDocumentation": "`Identifiers`\n\nA list of IDs to use to bind data to a component. Use this property to bind specifically\nchosen data, rather than data retrieved from a query.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-identifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Predicate": { "MarkdownDocumentation": "`Predicate`\n\nRepresents the conditional logic to use when binding data to a component. Use this\nproperty to retrieve only a subset of the data in a collection.\n*Required*: No\n*Type*: [Predicate](./aws-properties-amplifyuibuilder-component-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-predicate", "UpdateType": "Mutable", "Required": false, "Type": "Predicate" } } }, "AWS::AmplifyUIBuilder::Component.ComponentEvent": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentEvent`\n\nThe `ComponentEvent` property specifies the configuration of an event. You can bind an event and a corresponding\naction to a `Component` or a `ComponentChild`. A button click\nis an example of an event.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action to perform when a specific event is raised.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nDescribes information about the action.\n*Required*: No\n*Type*: [ActionParameters](./aws-properties-amplifyuibuilder-component-actionparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-parameters", "UpdateType": "Mutable", "Required": false, "Type": "ActionParameters" }, "BindingEvent": { "MarkdownDocumentation": "`BindingEvent`\n\nBinds an event to an action on a component. When you specify a `bindingEvent`,\nthe event is called when the action is performed.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-bindingevent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.ComponentProperty": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentProperty`\n\nThe `ComponentProperty` property specifies the configuration for all of a\ncomponent's properties. Use `ComponentProperty` to specify the values to render or\nbind by default.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nThe conditional expression to use to assign a value to the component property.\n*Required*: No\n*Type*: [ComponentConditionProperty](./aws-properties-amplifyuibuilder-component-componentconditionproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-condition", "UpdateType": "Mutable", "Required": false, "Type": "ComponentConditionProperty" }, "UserAttribute": { "MarkdownDocumentation": "`UserAttribute`\n\nAn authenticated user attribute to use to assign a value to the component 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-userattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImportedValue": { "MarkdownDocumentation": "`ImportedValue`\n\nThe default value assigned to the property when the component is imported into an\napp.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-importedvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BindingProperties": { "MarkdownDocumentation": "`BindingProperties`\n\nThe information to bind the component property to data at runtime.\n*Required*: No\n*Type*: [ComponentPropertyBindingProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-bindingproperties", "UpdateType": "Mutable", "Required": false, "Type": "ComponentPropertyBindingProperties" }, "Bindings": { "MarkdownDocumentation": "`Bindings`\n\nThe information to bind the component property to form data.\n*Required*: No\n*Type*: Object of [FormBindingElement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-bindings", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "FormBindingElement" }, "Configured": { "MarkdownDocumentation": "`Configured`\n\nSpecifies whether the user configured the property in Amplify Studio after\nimporting 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-configured", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Concat": { "MarkdownDocumentation": "`Concat`\n\nA list of component properties to concatenate to create the value to assign to this\ncomponent property.\n*Required*: No\n*Type*: Array of [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-concat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ComponentProperty", "DuplicatesAllowed": true }, "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe default value to assign to the component 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to assign to the component 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Model": { "MarkdownDocumentation": "`Model`\n\nThe data model to use to assign a value to the component 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-model", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CollectionBindingProperties": { "MarkdownDocumentation": "`CollectionBindingProperties`\n\nThe information to bind the component property to data at runtime. Use this for collection\ncomponents.\n*Required*: No\n*Type*: [ComponentPropertyBindingProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-collectionbindingproperties", "UpdateType": "Mutable", "Required": false, "Type": "ComponentPropertyBindingProperties" }, "Event": { "MarkdownDocumentation": "`Event`\n\nAn event that occurs in your app. Use this for workflow data binding.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-event", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComponentName": { "MarkdownDocumentation": "`ComponentName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-componentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Property": { "MarkdownDocumentation": "`Property`\n\nThe name of the component's property 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-property", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.ComponentPropertyBindingProperties": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentPropertyBindingProperties`\n\nThe `ComponentPropertyBindingProperties` property specifies a component\nproperty to associate with a binding property. This enables exposed properties on the top\nlevel component to propagate data to the component's property values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe data field to bind the property 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html#cfn-amplifyuibuilder-component-componentpropertybindingproperties-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Property": { "MarkdownDocumentation": "`Property`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html#cfn-amplifyuibuilder-component-componentpropertybindingproperties-property", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.ComponentVariant": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.ComponentVariant`\n\nThe `ComponentVariant` property specifies the style configuration of a unique\nvariation of a main component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariant.html", "Properties": { "VariantValues": { "MarkdownDocumentation": "`VariantValues`\n\nThe combination of variants that comprise this variant.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariant.html#cfn-amplifyuibuilder-component-componentvariant-variantvalues", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nThe properties of the component variant that can be overriden when customizing an instance\nof the component. You can't specify `tags` as a valid property for\n`overrides`.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariant.html#cfn-amplifyuibuilder-component-componentvariant-overrides", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::AmplifyUIBuilder::Component.FormBindingElement": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.FormBindingElement`\n\nDescribes how to bind a component property to form data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html", "Properties": { "Element": { "MarkdownDocumentation": "`Element`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html#cfn-amplifyuibuilder-component-formbindingelement-element", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Property": { "MarkdownDocumentation": "`Property`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html#cfn-amplifyuibuilder-component-formbindingelement-property", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.MutationActionSetStateParameter": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.MutationActionSetStateParameter`\n\nRepresents the state configuration when an action modifies a property of another element\nwithin the same component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html", "Properties": { "Set": { "MarkdownDocumentation": "`Set`\n\nThe state configuration to assign to the property.\n*Required*: Yes\n*Type*: [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-set", "UpdateType": "Mutable", "Required": true, "Type": "ComponentProperty" }, "ComponentName": { "MarkdownDocumentation": "`ComponentName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-componentname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Property": { "MarkdownDocumentation": "`Property`\n\nThe name of the component property to apply the state configuration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-property", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.Predicate": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.Predicate`\n\nThe `Predicate` property specifies information for generating Amplify DataStore queries. Use `Predicate` to retrieve a subset of the\ndata in a collection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe operator to use to perform the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-operator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Field": { "MarkdownDocumentation": "`Field`\n\nThe field to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Or": { "MarkdownDocumentation": "`Or`\n\nA list of predicates to combine logically.\n*Required*: No\n*Type*: Array of [Predicate](./aws-properties-amplifyuibuilder-component-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-or", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Predicate", "DuplicatesAllowed": true }, "And": { "MarkdownDocumentation": "`And`\n\nA list of predicates to combine logically.\n*Required*: No\n*Type*: Array of [Predicate](./aws-properties-amplifyuibuilder-component-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-and", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Predicate", "DuplicatesAllowed": true }, "Operand": { "MarkdownDocumentation": "`Operand`\n\nThe value to use when performing the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-operand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OperandType": { "MarkdownDocumentation": "`OperandType`\n\nThe type of value to use when performing the evaluation.\n*Required*: No\n*Type*: String\n*Pattern*: `^boolean|string|number$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-operandtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Component.SortProperty": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component.SortProperty`\n\nThe `SortProperty` property specifies how to sort the data that you bind to a\ncomponent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-sortproperty.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-sortproperty.html#cfn-amplifyuibuilder-component-sortproperty-field", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe direction of the sort, either ascending or descending.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-sortproperty.html#cfn-amplifyuibuilder-component-sortproperty-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Form.FieldConfig": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FieldConfig`\n\nThe `FieldConfig` property specifies the configuration information for a field in a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html", "Properties": { "Validations": { "MarkdownDocumentation": "`Validations`\n\nThe validations to perform on the value in the field.\n*Required*: No\n*Type*: Array of [FieldValidationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-validations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldValidationConfiguration", "DuplicatesAllowed": true }, "InputType": { "MarkdownDocumentation": "`InputType`\n\nDescribes the configuration for the default input value to display for a field.\n*Required*: No\n*Type*: [FieldInputConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-inputtype", "UpdateType": "Mutable", "Required": false, "Type": "FieldInputConfig" }, "Position": { "MarkdownDocumentation": "`Position`\n\nSpecifies the field position.\n*Required*: No\n*Type*: [FieldPosition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-position", "UpdateType": "Mutable", "Required": false, "Type": "FieldPosition" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Excluded": { "MarkdownDocumentation": "`Excluded`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-excluded", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AmplifyUIBuilder::Form.FieldInputConfig": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FieldInputConfig`\n\nThe `FieldInputConfig` property specifies the configuration for the default input values to display for a field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html", "Properties": { "ReadOnly": { "MarkdownDocumentation": "`ReadOnly`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-readonly", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Placeholder": { "MarkdownDocumentation": "`Placeholder`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-placeholder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileUploaderConfig": { "MarkdownDocumentation": "`FileUploaderConfig`\n\nThe configuration for the file uploader field.\n*Required*: No\n*Type*: [FileUploaderFieldConfig](./aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-fileuploaderconfig", "UpdateType": "Mutable", "Required": false, "Type": "FileUploaderFieldConfig" }, "IsArray": { "MarkdownDocumentation": "`IsArray`\n\nSpecifies whether to render the field as an array. This property is ignored if the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-isarray", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ValueMappings": { "MarkdownDocumentation": "`ValueMappings`\n\nThe information to use to customize the input fields with data at runtime.\n*Required*: No\n*Type*: [ValueMappings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-valuemappings", "UpdateType": "Mutable", "Required": false, "Type": "ValueMappings" }, "DefaultCountryCode": { "MarkdownDocumentation": "`DefaultCountryCode`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultcountrycode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxValue": { "MarkdownDocumentation": "`MaxValue`\n\nThe maximum value to display for the field.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-maxvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Step": { "MarkdownDocumentation": "`Step`\n\nThe stepping increment for a numeric value in a field.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-step", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DescriptiveText": { "MarkdownDocumentation": "`DescriptiveText`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-descriptivetext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Required": { "MarkdownDocumentation": "`Required`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-required", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MinValue": { "MarkdownDocumentation": "`MinValue`\n\nThe minimum value to display for the field.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-minvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultChecked": { "MarkdownDocumentation": "`DefaultChecked`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultchecked", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AmplifyUIBuilder::Form.FieldPosition": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FieldPosition`\n\nThe `FieldPosition` property specifies the field position.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html", "Properties": { "Below": { "MarkdownDocumentation": "`Below`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-below", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RightOf": { "MarkdownDocumentation": "`RightOf`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-rightof", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Fixed": { "MarkdownDocumentation": "`Fixed`\n\nThe field position is fixed and doesn't change in relation to other fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `first`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "first" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-fixed", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Form.FieldValidationConfiguration": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FieldValidationConfiguration`\n\nThe `FieldValidationConfiguration` property specifies the validation configuration for a field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValidationMessage": { "MarkdownDocumentation": "`ValidationMessage`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-validationmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StrValues": { "MarkdownDocumentation": "`StrValues`\n\nThe validation to perform on a string value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-strvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NumValues": { "MarkdownDocumentation": "`NumValues`\n\nThe validation to perform on a number value.\n*Required*: No\n*Type*: Array of Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-numvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true } } }, "AWS::AmplifyUIBuilder::Form.FileUploaderFieldConfig": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FileUploaderFieldConfig`\n\nDescribes the configuration for the file uploader field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html", "Properties": { "IsResumable": { "MarkdownDocumentation": "`IsResumable`\n\nAllows the file upload operation to be paused and resumed. The default value is\n`false`.\nWhen `isResumable` is set to `true`, the file uploader uses a\nmultipart upload to break the files into chunks before upload. The progress of the upload\nisn't continuous, because the file uploader uploads a chunk at a time.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-isresumable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ShowThumbnails": { "MarkdownDocumentation": "`ShowThumbnails`\n\nSpecifies whether to display or hide the image preview after selecting a file for upload.\nThe default value is `true` to display the image preview.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-showthumbnails", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AcceptedFileTypes": { "MarkdownDocumentation": "`AcceptedFileTypes`\n\nThe file types that are allowed to be uploaded by the file uploader. Provide this\ninformation in an array of strings specifying the valid file extensions.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-acceptedfiletypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxFileCount": { "MarkdownDocumentation": "`MaxFileCount`\n\nSpecifies the maximum number of files that can be selected to upload. The default value is\nan unlimited number of files.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-maxfilecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MaxSize": { "MarkdownDocumentation": "`MaxSize`\n\nThe maximum file size in bytes that the file uploader will accept. The default value is an\nunlimited file size.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-maxsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "AccessLevel": { "MarkdownDocumentation": "`AccessLevel`\n\nThe access level to assign to the uploaded files in the Amazon S3 bucket where\nthey are stored. The valid values for this property are `private`,\n`protected`, or `public`. For detailed information about the\npermissions associated with each access level, see [File access\nlevels](https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/) in the *Amplify documentation*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `public | protected | privat...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "public", "protected", "private" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-accesslevel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Form.FormButton": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormButton`\n\nThe `FormButton` property specifies the configuration for a button UI element that is a part of a form.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html", "Properties": { "Position": { "MarkdownDocumentation": "`Position`\n\nThe position of the button.\n*Required*: No\n*Type*: [FieldPosition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-position", "UpdateType": "Mutable", "Required": false, "Type": "FieldPosition" }, "Children": { "MarkdownDocumentation": "`Children`\n\nDescribes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-children", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Excluded": { "MarkdownDocumentation": "`Excluded`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-excluded", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AmplifyUIBuilder::Form.FormCTA": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormCTA`\n\nThe `FormCTA` property specifies the call to action button configuration for the form.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html", "Properties": { "Position": { "MarkdownDocumentation": "`Position`\n\nThe position of the button.\n*Required*: No\n*Type*: String\n*Allowed values*: `top | bottom | top_and_bott...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "top", "bottom", "top_and_bottom" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cancel": { "MarkdownDocumentation": "`Cancel`\n\nDisplays a cancel button.\n*Required*: No\n*Type*: [FormButton](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-cancel", "UpdateType": "Mutable", "Required": false, "Type": "FormButton" }, "Submit": { "MarkdownDocumentation": "`Submit`\n\nDisplays a submit button.\n*Required*: No\n*Type*: [FormButton](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-submit", "UpdateType": "Mutable", "Required": false, "Type": "FormButton" }, "Clear": { "MarkdownDocumentation": "`Clear`\n\nDisplays a clear button.\n*Required*: No\n*Type*: [FormButton](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-clear", "UpdateType": "Mutable", "Required": false, "Type": "FormButton" } } }, "AWS::AmplifyUIBuilder::Form.FormDataTypeConfig": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormDataTypeConfig`\n\nThe `FormDataTypeConfig` property specifies the data type configuration for the data source associated with a form.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html", "Properties": { "DataSourceType": { "MarkdownDocumentation": "`DataSourceType`\n\nThe data source type, either an Amplify DataStore model or a custom data type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DataStore | Custom...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DataStore", "Custom" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html#cfn-amplifyuibuilder-form-formdatatypeconfig-datasourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataTypeName": { "MarkdownDocumentation": "`DataTypeName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html#cfn-amplifyuibuilder-form-formdatatypeconfig-datatypename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Form.FormInputBindingPropertiesValue": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormInputBindingPropertiesValue`\n\nRepresents the data binding configuration for a form's input fields at runtime.You can use\n`FormInputBindingPropertiesValue` to add exposed properties to a form to allow\ndifferent values to be entered when a form is reused in different places in an app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalue.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe property 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalue.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalue-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BindingProperties": { "MarkdownDocumentation": "`BindingProperties`\n\nDescribes the properties to customize with data at runtime.\n*Required*: No\n*Type*: [FormInputBindingPropertiesValueProperties](./aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalue.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalue-bindingproperties", "UpdateType": "Mutable", "Required": false, "Type": "FormInputBindingPropertiesValueProperties" } } }, "AWS::AmplifyUIBuilder::Form.FormInputBindingPropertiesValueProperties": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormInputBindingPropertiesValueProperties`\n\nRepresents the data binding configuration for a specific property using data stored in\nAWS. For AWS connected properties, you can bind a property to\ndata stored in an Amplify DataStore model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties.html", "Properties": { "Model": { "MarkdownDocumentation": "`Model`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties-model", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Form.FormInputValueProperty": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormInputValueProperty`\n\nThe `FormInputValueProperty` property specifies the configuration for an input field on a form. Use\n`FormInputValueProperty` to specify the values to render or bind by\ndefault.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html", "Properties": { "Concat": { "MarkdownDocumentation": "`Concat`\n\nA list of form properties to concatenate to create the value to assign to this field\nproperty.\n*Required*: No\n*Type*: Array of [FormInputValueProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-concat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FormInputValueProperty", "DuplicatesAllowed": true }, "BindingProperties": { "MarkdownDocumentation": "`BindingProperties`\n\nThe information to bind fields to data at runtime.\n*Required*: No\n*Type*: [FormInputValuePropertyBindingProperties](./aws-properties-amplifyuibuilder-form-forminputvaluepropertybindingproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-bindingproperties", "UpdateType": "Mutable", "Required": false, "Type": "FormInputValuePropertyBindingProperties" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Form.FormInputValuePropertyBindingProperties": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormInputValuePropertyBindingProperties`\n\nAssociates a form property to a binding property. This enables exposed properties on the\ntop level form to propagate data to the form's property values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvaluepropertybindingproperties.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe data field to bind the property 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvaluepropertybindingproperties.html#cfn-amplifyuibuilder-form-forminputvaluepropertybindingproperties-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Property": { "MarkdownDocumentation": "`Property`\n\nThe form 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvaluepropertybindingproperties.html#cfn-amplifyuibuilder-form-forminputvaluepropertybindingproperties-property", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Form.FormStyle": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormStyle`\n\nThe `FormStyle` property specifies the configuration for the form's style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html", "Properties": { "VerticalGap": { "MarkdownDocumentation": "`VerticalGap`\n\nThe spacing for the vertical gap.\n*Required*: No\n*Type*: [FormStyleConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-verticalgap", "UpdateType": "Mutable", "Required": false, "Type": "FormStyleConfig" }, "OuterPadding": { "MarkdownDocumentation": "`OuterPadding`\n\nThe size of the outer padding for the form.\n*Required*: No\n*Type*: [FormStyleConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-outerpadding", "UpdateType": "Mutable", "Required": false, "Type": "FormStyleConfig" }, "HorizontalGap": { "MarkdownDocumentation": "`HorizontalGap`\n\nThe spacing for the horizontal gap.\n*Required*: No\n*Type*: [FormStyleConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-horizontalgap", "UpdateType": "Mutable", "Required": false, "Type": "FormStyleConfig" } } }, "AWS::AmplifyUIBuilder::Form.FormStyleConfig": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.FormStyleConfig`\n\nThe `FormStyleConfig` property specifies the configuration settings for the form's style properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html#cfn-amplifyuibuilder-form-formstyleconfig-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TokenReference": { "MarkdownDocumentation": "`TokenReference`\n\nA reference to a design token to use to bind the form's style properties to an existing\ntheme.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html#cfn-amplifyuibuilder-form-formstyleconfig-tokenreference", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AmplifyUIBuilder::Form.SectionalElement": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.SectionalElement`\n\nThe `SectionalElement` property specifies the configuration information for a visual helper element for a form. A sectional\nelement can be a header, a text block, or a divider. These elements are static and not\nassociated with any data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of sectional element. Valid values are `Heading`, `Text`,\nand `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nSpecifies the position of the text in a field for a `Text` sectional\nelement.\n*Required*: No\n*Type*: [FieldPosition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-position", "UpdateType": "Mutable", "Required": false, "Type": "FieldPosition" }, "Text": { "MarkdownDocumentation": "`Text`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-text", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Level": { "MarkdownDocumentation": "`Level`\n\nSpecifies the size of the font for a `Heading` sectional element. Valid values\nare `1 | 2 | 3 | 4 | 5 | 6`.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-level", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Orientation": { "MarkdownDocumentation": "`Orientation`\n\nSpecifies the orientation for a `Divider` sectional element. Valid values are\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-orientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Excluded": { "MarkdownDocumentation": "`Excluded`\n\nExcludes a sectional element that was generated by default for a specified data\nmodel.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-excluded", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AmplifyUIBuilder::Form.ValueMapping": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.ValueMapping`\n\nThe `ValueMapping` property specifies the association between a complex object and a display value. Use `ValueMapping` to store\nhow to represent complex objects when they are displayed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html", "Properties": { "DisplayValue": { "MarkdownDocumentation": "`DisplayValue`\n\nThe value to display for the complex object.\n*Required*: No\n*Type*: [FormInputValueProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html#cfn-amplifyuibuilder-form-valuemapping-displayvalue", "UpdateType": "Mutable", "Required": false, "Type": "FormInputValueProperty" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe complex object.\n*Required*: Yes\n*Type*: [FormInputValueProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html#cfn-amplifyuibuilder-form-valuemapping-value", "UpdateType": "Mutable", "Required": true, "Type": "FormInputValueProperty" } } }, "AWS::AmplifyUIBuilder::Form.ValueMappings": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form.ValueMappings`\n\nThe `ValueMappings` property specifies the data binding configuration for a value map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html", "Properties": { "BindingProperties": { "MarkdownDocumentation": "`BindingProperties`\n\nThe information to bind fields to data at runtime.\n*Required*: No\n*Type*: Object of [FormInputBindingPropertiesValue](./aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html#cfn-amplifyuibuilder-form-valuemappings-bindingproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "FormInputBindingPropertiesValue" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value and display value pairs.\n*Required*: Yes\n*Type*: Array of [ValueMapping](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html#cfn-amplifyuibuilder-form-valuemappings-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ValueMapping", "DuplicatesAllowed": true } } }, "AWS::AmplifyUIBuilder::Theme.ThemeValue": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Theme.ThemeValue`\n\nThe `ThemeValue` property specifies the configuration of a theme's\nproperties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a theme 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalue.html#cfn-amplifyuibuilder-theme-themevalue-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Children": { "MarkdownDocumentation": "`Children`\n\nA list of key-value pairs that define the theme's properties.\n*Required*: No\n*Type*: Array of [ThemeValues](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalue.html#cfn-amplifyuibuilder-theme-themevalue-children", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ThemeValues", "DuplicatesAllowed": true } } }, "AWS::AmplifyUIBuilder::Theme.ThemeValues": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Theme.ThemeValues`\n\nThe `ThemeValues` property specifies key-value pair that defines a property of a theme.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalues.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the property.\n*Required*: No\n*Type*: [ThemeValue](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalues.html#cfn-amplifyuibuilder-theme-themevalues-value", "UpdateType": "Mutable", "Required": false, "Type": "ThemeValue" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalues.html#cfn-amplifyuibuilder-theme-themevalues-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::ApiKey.StageKey": { "MarkdownDocumentation": "`AWS::ApiGateway::ApiKey.StageKey`\n\n`StageKey` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html", "Properties": { "StageName": { "MarkdownDocumentation": "`StageName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::Deployment.AccessLogSetting": { "MarkdownDocumentation": "`AWS::ApiGateway::Deployment.AccessLogSetting`\n\nThe `AccessLogSetting` property type specifies settings for logging access in this stage.\n`AccessLogSetting` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-format", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-destinationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::Deployment.CanarySetting": { "MarkdownDocumentation": "`AWS::ApiGateway::Deployment.CanarySetting`\n\nThe `CanarySetting` property type specifies settings for the canary deployment in this stage.\n`CanarySetting` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html", "Properties": { "StageVariableOverrides": { "MarkdownDocumentation": "`StageVariableOverrides`\n\nStage 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-stagevariableoverrides", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "PercentTraffic": { "MarkdownDocumentation": "`PercentTraffic`\n\nThe percent (0-100) of traffic diverted to a canary deployment.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-percenttraffic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "UseStageCache": { "MarkdownDocumentation": "`UseStageCache`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-usestagecache", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ApiGateway::Deployment.DeploymentCanarySettings": { "MarkdownDocumentation": "`AWS::ApiGateway::Deployment.DeploymentCanarySettings`\n\nThe `DeploymentCanarySettings` property type specifies settings for the canary deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html", "Properties": { "StageVariableOverrides": { "MarkdownDocumentation": "`StageVariableOverrides`\n\nA 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-stagevariableoverrides", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "PercentTraffic": { "MarkdownDocumentation": "`PercentTraffic`\n\nThe percentage (0.0-100.0) of traffic routed to the canary deployment.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-percenttraffic", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "UseStageCache": { "MarkdownDocumentation": "`UseStageCache`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-usestagecache", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ApiGateway::Deployment.MethodSetting": { "MarkdownDocumentation": "`AWS::ApiGateway::Deployment.MethodSetting`\n\nThe `MethodSetting` property type configures settings for all methods in a stage. If you modify this property type, you must create a new deployment for your API.\nThe `MethodSettings` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of `MethodSetting` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html", "Properties": { "CacheTtlInSeconds": { "MarkdownDocumentation": "`CacheTtlInSeconds`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachettlinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LoggingLevel": { "MarkdownDocumentation": "`LoggingLevel`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-logginglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourcePath": { "MarkdownDocumentation": "`ResourcePath`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-resourcepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CacheDataEncrypted": { "MarkdownDocumentation": "`CacheDataEncrypted`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachedataencrypted", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DataTraceEnabled": { "MarkdownDocumentation": "`DataTraceEnabled`\n\nSpecifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-datatraceenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ThrottlingBurstLimit": { "MarkdownDocumentation": "`ThrottlingBurstLimit`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-throttlingburstlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CachingEnabled": { "MarkdownDocumentation": "`CachingEnabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MetricsEnabled": { "MarkdownDocumentation": "`MetricsEnabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-metricsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "HttpMethod": { "MarkdownDocumentation": "`HttpMethod`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-httpmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThrottlingRateLimit": { "MarkdownDocumentation": "`ThrottlingRateLimit`\n\nSpecifies the throttling rate limit.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-throttlingratelimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ApiGateway::Deployment.StageDescription": { "MarkdownDocumentation": "`AWS::ApiGateway::Deployment.StageDescription`\n\n`StageDescription` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html", "Properties": { "CacheTtlInSeconds": { "MarkdownDocumentation": "`CacheTtlInSeconds`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachettlinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoggingLevel": { "MarkdownDocumentation": "`LoggingLevel`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-logginglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CanarySetting": { "MarkdownDocumentation": "`CanarySetting`\n\nSpecifies settings for the canary deployment in this stage.\n*Required*: No\n*Type*: [CanarySetting](./aws-properties-apigateway-deployment-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-canarysetting", "UpdateType": "Mutable", "Required": false, "Type": "CanarySetting" }, "ThrottlingRateLimit": { "MarkdownDocumentation": "`ThrottlingRateLimit`\n\nThe target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingratelimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ClientCertificateId": { "MarkdownDocumentation": "`ClientCertificateId`\n\nThe identifier 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Variables": { "MarkdownDocumentation": "`Variables`\n\nA 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "DocumentationVersion": { "MarkdownDocumentation": "`DocumentationVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CacheDataEncrypted": { "MarkdownDocumentation": "`CacheDataEncrypted`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachedataencrypted", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DataTraceEnabled": { "MarkdownDocumentation": "`DataTraceEnabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-datatraceenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ThrottlingBurstLimit": { "MarkdownDocumentation": "`ThrottlingBurstLimit`\n\nThe target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingburstlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CachingEnabled": { "MarkdownDocumentation": "`CachingEnabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TracingEnabled": { "MarkdownDocumentation": "`TracingEnabled`\n\nSpecifies whether active tracing with X-ray 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tracingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MethodSettings": { "MarkdownDocumentation": "`MethodSettings`\n\nConfigures settings for all of the stage's methods.\n*Required*: No\n*Type*: Array of [MethodSetting](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MethodSetting", "DuplicatesAllowed": false }, "AccessLogSetting": { "MarkdownDocumentation": "`AccessLogSetting`\n\nSpecifies settings for logging access in this stage.\n*Required*: No\n*Type*: [AccessLogSetting](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-accesslogsetting", "UpdateType": "Mutable", "Required": false, "Type": "AccessLogSetting" }, "CacheClusterSize": { "MarkdownDocumentation": "`CacheClusterSize`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricsEnabled": { "MarkdownDocumentation": "`MetricsEnabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-metricsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of arbitrary tags (key-value pairs) to associate with the stage.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apigateway-deployment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "CacheClusterEnabled": { "MarkdownDocumentation": "`CacheClusterEnabled`\n\nSpecifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set `CachingEnabled` to `true` for a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ApiGateway::DocumentationPart.Location": { "MarkdownDocumentation": "`AWS::ApiGateway::DocumentationPart.Location`\n\nThe `Location` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. `Location` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n###### Note\nFor more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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 | MODEL | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Method": { "MarkdownDocumentation": "`Method`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::DomainName.EndpointConfiguration": { "MarkdownDocumentation": "`AWS::ApiGateway::DomainName.EndpointConfiguration`\n\nThe `EndpointConfiguration` property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.\n`EndpointConfiguration` is a property of the [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address types that can invoke this DomainName. Use `ipv4` to allow only IPv4 addresses to invoke this DomainName,\nor use `dualstack` to allow both IPv4 and IPv6 addresses to invoke this DomainName. For the `PRIVATE` endpoint type, only\n`dualstack` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Types": { "MarkdownDocumentation": "`Types`\n\nA 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-types", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ApiGateway::DomainName.MutualTlsAuthentication": { "MarkdownDocumentation": "`AWS::ApiGateway::DomainName.MutualTlsAuthentication`\n\nThe mutual TLS authentication configuration for a custom domain name. If specified, API Gateway\nperforms two-way authentication between the client and the server. Clients must present a\ntrusted certificate to access your API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html", "Properties": { "TruststoreVersion": { "MarkdownDocumentation": "`TruststoreVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TruststoreUri": { "MarkdownDocumentation": "`TruststoreUri`\n\nAn Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example\n`s3://bucket-name/key-name`. The truststore can contain certificates from public or private\ncertificate authorities. To update the truststore, upload a new version to S3, and then update\nyour custom domain name to use the new version. To update the truststore, you must have\npermissions 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreuri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::DomainNameV2.EndpointConfiguration": { "MarkdownDocumentation": "`AWS::ApiGateway::DomainNameV2.EndpointConfiguration`\n\nThe endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address types that can invoke an API (RestApi) or a DomainName. Use `ipv4` to allow only IPv4 addresses to\ninvoke an API or DomainName, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the\n`PRIVATE` endpoint type, only `dualstack` is supported.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | dualstack...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "dualstack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-ipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Types": { "MarkdownDocumentation": "`Types`\n\nA 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*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-types", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ApiGateway::Method.Integration": { "MarkdownDocumentation": "`AWS::ApiGateway::Method.Integration`\n\n`Integration` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html", "Properties": { "CacheNamespace": { "MarkdownDocumentation": "`CacheNamespace`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-cachenamespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionType": { "MarkdownDocumentation": "`ConnectionType`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "INTERNET", "VPC_LINK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-connectiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegrationResponses": { "MarkdownDocumentation": "`IntegrationResponses`\n\nSpecifies the integration's responses.\n*Required*: No\n*Type*: Array of [IntegrationResponse](./aws-properties-apigateway-method-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-integrationresponses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IntegrationResponse", "DuplicatesAllowed": false }, "IntegrationHttpMethod": { "MarkdownDocumentation": "`IntegrationHttpMethod`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-integrationhttpmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseTransferMode": { "MarkdownDocumentation": "`ResponseTransferMode`\n\nThe response transfer mode of the integration. Use `STREAM` to have API Gateway stream response your back to you or use `BUFFERED` to have API Gateway wait to receive the complete response before beginning transmission.\n*Required*: No\n*Type*: String\n*Allowed values*: `BUFFERED | STREAM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BUFFERED", "STREAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Uri": { "MarkdownDocumentation": "`Uri`\n\nSpecifies 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\naccording to the RFC-3986 specification for standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name.\nFor `AWS` or `AWS_PROXY` integrations, the URI is of\nthe form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`.\nHere, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the\nintegrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by\ncertain AWS service for fast host-name lookup. action can be used for an AWS service\naction-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing\n{service\\_api} refers to a supported action {name} plus any required input parameters.\nAlternatively, path can be used for an AWS service path-based API. The ensuing service\\_api\nrefers to the path to an AWS service resource, including the region of the integrated AWS\nservice, if applicable. For example, for integration with the S3 API of GetObject, the uri can\nbe either `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}` or\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PassthroughBehavior": { "MarkdownDocumentation": "`PassthroughBehavior`\n\nSpecifies how the method request body of an unmapped content type will be passed through\nthe integration request to the back end without transformation. A content type is unmapped if\nno mapping template is defined in the integration or the content type does not match any of\nthe mapped content types, as specified in `requestTemplates`. The valid value is one of the\nfollowing: `WHEN_NO_MATCH`: passes the method request body through the integration request to\nthe back end without transformation when the method request content type does not match any\ncontent type associated with the mapping templates defined in the integration request.\n`WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back\nend without transformation when no mapping template is defined in the integration request. If\na template is defined when this option is selected, the method request of an unmapped\ncontent-type will be rejected with an HTTP 415 Unsupported Media Type response. `NEVER`: rejects\nthe method request with an HTTP 415 Unsupported Media Type response when either the method\nrequest content type does not match any content type associated with the mapping templates\ndefined in the integration request or no mapping template is defined in the integration\nrequest.\n*Required*: No\n*Type*: String\n*Allowed values*: `WHEN_NO_MATCH | WHEN_NO_TEM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WHEN_NO_MATCH", "WHEN_NO_TEMPLATES", "NEVER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-passthroughbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestParameters": { "MarkdownDocumentation": "`RequestParameters`\n\nA 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-requestparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ConnectionId": { "MarkdownDocumentation": "`ConnectionId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-connectionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies 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*: Yes\n*Type*: String\n*Allowed values*: `AWS | AWS_PROXY | HTTP | HT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS", "AWS_PROXY", "HTTP", "HTTP_PROXY", "MOCK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CacheKeyParameters": { "MarkdownDocumentation": "`CacheKeyParameters`\n\nA 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "IntegrationTarget": { "MarkdownDocumentation": "`IntegrationTarget`\n\nThe ALB or NLB listener to send the request to. Only supported for private integrations that use VPC links V2.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-integrationtarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentHandling": { "MarkdownDocumentation": "`ContentHandling`\n\nSpecifies 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...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-contenthandling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestTemplates": { "MarkdownDocumentation": "`RequestTemplates`\n\nRepresents 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-requesttemplates", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "TimeoutInMillis": { "MarkdownDocumentation": "`TimeoutInMillis`\n\nCustom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.\n*Required*: No\n*Type*: Integer\n*Minimum*: `50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-timeoutinmillis", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Credentials": { "MarkdownDocumentation": "`Credentials`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-credentials", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::Method.IntegrationResponse": { "MarkdownDocumentation": "`AWS::ApiGateway::Method.IntegrationResponse`\n\n`IntegrationResponse` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html", "Properties": { "ResponseTemplates": { "MarkdownDocumentation": "`ResponseTemplates`\n\nSpecifies 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-responsetemplates", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "SelectionPattern": { "MarkdownDocumentation": "`SelectionPattern`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-selectionpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentHandling": { "MarkdownDocumentation": "`ContentHandling`\n\nSpecifies 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...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseParameters": { "MarkdownDocumentation": "`ResponseParameters`\n\nA key-value map specifying response parameters that are passed to the method response from the back end.\nThe 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-responseparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html#cfn-apigateway-method-integrationresponse-statuscode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApiGateway::Method.MethodResponse": { "MarkdownDocumentation": "`AWS::ApiGateway::Method.MethodResponse`\n\nRepresents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-methodresponse.html", "Properties": { "ResponseParameters": { "MarkdownDocumentation": "`ResponseParameters`\n\nA 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResponseModels": { "MarkdownDocumentation": "`ResponseModels`\n\nSpecifies 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ApiGateway::RestApi.EndpointConfiguration": { "MarkdownDocumentation": "`AWS::ApiGateway::RestApi.EndpointConfiguration`\n\nThe `EndpointConfiguration` property type specifies the endpoint types and IP address types of a REST API.\n`EndpointConfiguration` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address types that can invoke an API (RestApi). Use `ipv4` to allow only IPv4 addresses to\ninvoke an API, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke an API. For the\n`PRIVATE` endpoint type, only `dualstack` is supported.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | dualstack...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "dualstack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Types": { "MarkdownDocumentation": "`Types`\n\nA 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "VpcEndpointIds": { "MarkdownDocumentation": "`VpcEndpointIds`\n\nA 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ApiGateway::RestApi.S3Location": { "MarkdownDocumentation": "`AWS::ApiGateway::RestApi.S3Location`\n\n`S3Location` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.\n###### Note\nOn January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ETag": { "MarkdownDocumentation": "`ETag`\n\nThe Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-etag", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nFor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe file name of the OpenAPI file (Amazon S3 object 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::Stage.AccessLogSetting": { "MarkdownDocumentation": "`AWS::ApiGateway::Stage.AccessLogSetting`\n\nThe `AccessLogSetting` property type specifies settings for logging access in this stage.\n`AccessLogSetting` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-format", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nThe 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-`. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-destinationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::Stage.CanarySetting": { "MarkdownDocumentation": "`AWS::ApiGateway::Stage.CanarySetting`\n\nConfiguration settings of a canary deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html", "Properties": { "DeploymentId": { "MarkdownDocumentation": "`DeploymentId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-deploymentid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StageVariableOverrides": { "MarkdownDocumentation": "`StageVariableOverrides`\n\nStage 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-stagevariableoverrides", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "PercentTraffic": { "MarkdownDocumentation": "`PercentTraffic`\n\nThe percent (0-100) of traffic diverted to a canary deployment.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-percenttraffic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "UseStageCache": { "MarkdownDocumentation": "`UseStageCache`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-usestagecache", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ApiGateway::Stage.MethodSetting": { "MarkdownDocumentation": "`AWS::ApiGateway::Stage.MethodSetting`\n\nThe `MethodSetting` property type configures settings for all methods in a stage.\nThe `MethodSettings` property of the `AWS::ApiGateway::Stage` resource contains a list of `MethodSetting` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html", "Properties": { "CacheTtlInSeconds": { "MarkdownDocumentation": "`CacheTtlInSeconds`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LoggingLevel": { "MarkdownDocumentation": "`LoggingLevel`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-logginglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourcePath": { "MarkdownDocumentation": "`ResourcePath`\n\nThe 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`.\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CacheDataEncrypted": { "MarkdownDocumentation": "`CacheDataEncrypted`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DataTraceEnabled": { "MarkdownDocumentation": "`DataTraceEnabled`\n\nSpecifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ThrottlingBurstLimit": { "MarkdownDocumentation": "`ThrottlingBurstLimit`\n\nSpecifies the throttling burst limit.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingburstlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CachingEnabled": { "MarkdownDocumentation": "`CachingEnabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MetricsEnabled": { "MarkdownDocumentation": "`MetricsEnabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-metricsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "HttpMethod": { "MarkdownDocumentation": "`HttpMethod`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThrottlingRateLimit": { "MarkdownDocumentation": "`ThrottlingRateLimit`\n\nSpecifies the throttling rate limit.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingratelimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ApiGateway::UsagePlan.ApiStage": { "MarkdownDocumentation": "`AWS::ApiGateway::UsagePlan.ApiStage`\n\nAPI stage name of the associated API stage in a usage plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html", "Properties": { "Stage": { "MarkdownDocumentation": "`Stage`\n\nAPI 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nAPI 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Throttle": { "MarkdownDocumentation": "`Throttle`\n\nMap containing method level throttling information for API stage in a usage plan.\n*Required*: No\n*Type*: Object of [ThrottleSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-throttle", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ThrottleSettings" } } }, "AWS::ApiGateway::UsagePlan.QuotaSettings": { "MarkdownDocumentation": "`AWS::ApiGateway::UsagePlan.QuotaSettings`\n\n`QuotaSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.\nIn some cases clients can exceed the targets that you set. Don\u2019t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs\nand [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html", "Properties": { "Period": { "MarkdownDocumentation": "`Period`\n\nThe time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".\n*Required*: No\n*Type*: String\n*Allowed values*: `DAY | WEEK | MONTH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAY", "WEEK", "MONTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-period", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nThe target maximum number of requests that can be made in a given 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Offset": { "MarkdownDocumentation": "`Offset`\n\nThe number of requests subtracted from the given limit in the initial 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-offset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ApiGateway::UsagePlan.ThrottleSettings": { "MarkdownDocumentation": "`AWS::ApiGateway::UsagePlan.ThrottleSettings`\n\n`ThrottleSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html", "Properties": { "BurstLimit": { "MarkdownDocumentation": "`BurstLimit`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RateLimit": { "MarkdownDocumentation": "`RateLimit`\n\nThe API target request rate limit.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ApiGatewayV2::Api.BodyS3Location": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Api.BodyS3Location`\n\nThe `BodyS3Location` property specifies an S3 location from which to\nimport an OpenAPI definition. Supported only for HTTP APIs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html", "Properties": { "Etag": { "MarkdownDocumentation": "`Etag`\n\nThe Etag of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-etag", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe S3 bucket that contains the OpenAPI definition to import. Required if you specify a `BodyS3Location` for an API.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the S3 object. Required if you specify a `BodyS3Location` for an API.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGatewayV2::Api.Cors": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Api.Cors`\n\nThe `Cors` property specifies a CORS configuration for an API.\nSupported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html", "Properties": { "AllowOrigins": { "MarkdownDocumentation": "`AllowOrigins`\n\nRepresents a collection of allowed origins. Supported only for HTTP APIs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-alloworigins", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowCredentials": { "MarkdownDocumentation": "`AllowCredentials`\n\nSpecifies whether credentials are included in the CORS request. Supported only for HTTP APIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowcredentials", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExposeHeaders": { "MarkdownDocumentation": "`ExposeHeaders`\n\nRepresents a collection of exposed headers. Supported only for HTTP APIs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-exposeheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowHeaders": { "MarkdownDocumentation": "`AllowHeaders`\n\nRepresents a collection of allowed headers. Supported only for HTTP APIs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxAge": { "MarkdownDocumentation": "`MaxAge`\n\nThe number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-maxage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AllowMethods": { "MarkdownDocumentation": "`AllowMethods`\n\nRepresents a collection of allowed HTTP methods. Supported only for HTTP APIs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowmethods", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.AccessLogSettings": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.AccessLogSettings`\n\nThe `AccessLogSettings` property overrides the access log settings for an API Gateway-managed stage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings.html", "Properties": { "Format": { "Required": false, "MarkdownDocumentation": "`Format`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings-format", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DestinationArn": { "Required": false, "MarkdownDocumentation": "`DestinationArn`\n\nThe ARN of the CloudWatch Logs log group to receive access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings-destinationarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.IntegrationOverrides": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.IntegrationOverrides`\n\nThe `IntegrationOverrides` property overrides the integration settings for\nan API Gateway-managed integration. If you remove this property, API Gateway restores the default values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html", "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe description of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PayloadFormatVersion": { "Required": false, "MarkdownDocumentation": "`PayloadFormatVersion`\n\nSpecifies the format of the payload sent to an integration. Required for HTTP\nAPIs. For HTTP APIs, supported values for Lambda proxy integrations are\n`1.0` and `2.0`. For all other integrations,\n`1.0` is the only supported value. To learn more, see\n[Working with AWS Lambda proxy integrations for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-payloadformatversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimeoutInMillis": { "Required": false, "MarkdownDocumentation": "`TimeoutInMillis`\n\nCustom timeout between 50 and 29,000 milliseconds for WebSocket APIs and\nbetween 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29\nseconds for WebSocket APIs and 30 seconds for HTTP APIs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-timeoutinmillis", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "IntegrationMethod": { "Required": false, "MarkdownDocumentation": "`IntegrationMethod`\n\nSpecifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to `POST`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-integrationmethod", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.RouteOverrides": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.RouteOverrides`\n\nThe `RouteOverrides` property overrides the route configuration for an API\nGateway-managed route. If you remove this property, API Gateway restores the default values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html", "Properties": { "Target": { "Required": false, "MarkdownDocumentation": "`Target`\n\nFor HTTP integrations, specify a fully qualified URL.\nFor Lambda integrations, specify a function ARN. The type of the integration will be\nHTTP\\_PROXY or AWS\\_PROXY, respectively.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-target", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthorizerId": { "Required": false, "MarkdownDocumentation": "`AuthorizerId`\n\nThe identifier of the `Authorizer` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizerid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OperationName": { "Required": false, "MarkdownDocumentation": "`OperationName`\n\nThe operation name for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-operationname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthorizationScopes": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AuthorizationScopes`\n\nThe authorization scopes supported by this route.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizationscopes", "UpdateType": "Mutable" }, "AuthorizationType": { "Required": false, "MarkdownDocumentation": "`AuthorizationType`\n\nThe authorization type for the route. To learn more, see [AuthorizationType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizationtype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.RouteSettings": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.RouteSettings`\n\nThe `RouteSettings` property overrides the route settings for an API Gateway-managed route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html", "Properties": { "LoggingLevel": { "Required": false, "MarkdownDocumentation": "`LoggingLevel`\n\nSpecifies the logging level for this route: `INFO`, `ERROR`, or `OFF`. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-logginglevel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DataTraceEnabled": { "Required": false, "MarkdownDocumentation": "`DataTraceEnabled`\n\nSpecifies whether (`true`) or not (`false`) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-datatraceenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ThrottlingBurstLimit": { "Required": false, "MarkdownDocumentation": "`ThrottlingBurstLimit`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-throttlingburstlimit", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DetailedMetricsEnabled": { "Required": false, "MarkdownDocumentation": "`DetailedMetricsEnabled`\n\nSpecifies whether detailed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-detailedmetricsenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ThrottlingRateLimit": { "Required": false, "MarkdownDocumentation": "`ThrottlingRateLimit`\n\nSpecifies the throttling rate limit.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routesettings-throttlingratelimit", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.StageOverrides": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.StageOverrides`\n\nThe `StageOverrides` property overrides the stage configuration for an API\nGateway-managed stage. If you remove this property, API Gateway restores the default values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html", "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe description for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AccessLogSettings": { "Type": "AccessLogSettings", "Required": false, "MarkdownDocumentation": "`AccessLogSettings`\n\nSettings for logging access in a stage.\n*Required*: No\n*Type*: [AccessLogSettings](./aws-properties-apigatewayv2-apigatewaymanagedoverrides-accesslogsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-accesslogsettings", "UpdateType": "Mutable" }, "AutoDeploy": { "Required": false, "MarkdownDocumentation": "`AutoDeploy`\n\nSpecifies whether updates to an API automatically trigger a new deployment. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-autodeploy", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "RouteSettings": { "Required": false, "MarkdownDocumentation": "`RouteSettings`\n\nRoute settings for the stage.\n*Required*: No\n*Type*: [Json](./aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-routesettings", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "StageVariables": { "Required": false, "MarkdownDocumentation": "`StageVariables`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-stagevariables", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "DefaultRouteSettings": { "Type": "RouteSettings", "Required": false, "MarkdownDocumentation": "`DefaultRouteSettings`\n\nThe default route settings for the stage.\n*Required*: No\n*Type*: [RouteSettings](./aws-properties-apigatewayv2-apigatewaymanagedoverrides-routesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-defaultroutesettings", "UpdateType": "Mutable" } } }, "AWS::ApiGatewayV2::Authorizer.JWTConfiguration": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Authorizer.JWTConfiguration`\n\nThe `JWTConfiguration` property specifies the configuration of a JWT\nauthorizer. Required for the `JWT` authorizer type. Supported only for\nHTTP APIs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html", "Properties": { "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nThe base domain of the identity provider that issues JSON Web Tokens. For example,\nan Amazon Cognito user pool has the following format:\n`https://cognito-idp.{region}.amazonaws.com/{userPoolId}`.\nRequired for the `JWT` authorizer type. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html#cfn-apigatewayv2-authorizer-jwtconfiguration-issuer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Audience": { "MarkdownDocumentation": "`Audience`\n\nA list of the intended recipients of the JWT. A valid JWT must provide an\n`aud` that matches at least one entry in this list. See [RFC 7519](https://tools.ietf.org/html/rfc7519#section-4.1.3).\nRequired for the `JWT` authorizer type. Supported only for HTTP APIs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html#cfn-apigatewayv2-authorizer-jwtconfiguration-audience", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ApiGatewayV2::DomainName.DomainNameConfiguration": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::DomainName.DomainNameConfiguration`\n\nThe `DomainNameConfiguration` property type specifies the configuration\nfor an API's domain name.\n`DomainNameConfiguration` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html", "Properties": { "OwnershipVerificationCertificateArn": { "MarkdownDocumentation": "`OwnershipVerificationCertificateArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ownershipverificationcertificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address types that can invoke the domain name. Use `ipv4` to allow only IPv4 addresses to\ninvoke your domain name, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke your domain\nname.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityPolicy": { "MarkdownDocumentation": "`SecurityPolicy`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-securitypolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointType": { "MarkdownDocumentation": "`EndpointType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-endpointtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateName": { "MarkdownDocumentation": "`CertificateName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGatewayV2::DomainName.MutualTlsAuthentication": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::DomainName.MutualTlsAuthentication`\n\nIf specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-mutualtlsauthentication.html", "Properties": { "TruststoreVersion": { "MarkdownDocumentation": "`TruststoreVersion`\n\nThe version of the S3 object that contains your truststore. To\nspecify 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-mutualtlsauthentication.html#cfn-apigatewayv2-domainname-mutualtlsauthentication-truststoreversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TruststoreUri": { "MarkdownDocumentation": "`TruststoreUri`\n\nAn Amazon S3 URL that specifies the truststore for mutual TLS\nauthentication, for example, `s3://bucket-name/key-name`.\nThe truststore can contain certificates from public or private certificate\nauthorities. To update the truststore, upload a new version to S3, and then\nupdate your custom domain name to use the new version. To update the truststore,\nyou 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-mutualtlsauthentication.html#cfn-apigatewayv2-domainname-mutualtlsauthentication-truststoreuri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGatewayV2::Integration.ResponseParameter": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Integration.ResponseParameter`\n\nSupported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend\nintegration before returning the response to clients. Specify a key-value map from a selection key to response\nparameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key\nmust match the pattern `:
.` or\n`overwrite.statuscode`. The action can be `append`, `overwrite` or\n`remove`. The value can be a static value, or map to response data, stage variables, or context\nvariables that are evaluated at runtime. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameter.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nSpecifies the location of the response to modify, and how to modify it. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameter.html#cfn-apigatewayv2-integration-responseparameter-destination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nSpecifies the data to update the parameter with. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameter.html#cfn-apigatewayv2-integration-responseparameter-source", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGatewayV2::Integration.ResponseParameterMap": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Integration.ResponseParameterMap`\n\nThe `ResponseParameterMap` property type specifies Property description not available. for an [AWS::ApiGatewayV2::Integration](./aws-resource-apigatewayv2-integration.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparametermap.html", "Properties": { "ResponseParameters": { "MarkdownDocumentation": "`ResponseParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [ResponseParameter](./aws-properties-apigatewayv2-integration-responseparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparametermap.html#cfn-apigatewayv2-integration-responseparametermap-responseparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResponseParameter", "DuplicatesAllowed": true } } }, "AWS::ApiGatewayV2::Integration.TlsConfig": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Integration.TlsConfig`\n\nThe `TlsConfig` property specifies the TLS configuration for a private\nintegration. If you specify a TLS configuration, private integration traffic uses the\nHTTPS protocol. Supported only for HTTP APIs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html", "Properties": { "ServerNameToVerify": { "MarkdownDocumentation": "`ServerNameToVerify`\n\nIf you specify a server name, API Gateway uses it to verify the hostname on\nthe integration's certificate. The server name is also included in the TLS\nhandshake to support Server Name Indication (SNI) or virtual hosting.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html#cfn-apigatewayv2-integration-tlsconfig-servernametoverify", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGatewayV2::RouteResponse.ParameterConstraints": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RouteResponse.ParameterConstraints`\n\nSpecifies whether the parameter is required.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html", "Properties": { "Required": { "MarkdownDocumentation": "`Required`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html#cfn-apigatewayv2-routeresponse-parameterconstraints-required", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::ApiGatewayV2::RoutingRule.Action": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RoutingRule.Action`\n\nRepresents a routing rule action. The only supported action is `invokeApi`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-action.html", "Properties": { "InvokeApi": { "MarkdownDocumentation": "`InvokeApi`\n\nRepresents an InvokeApi action.\n*Required*: Yes\n*Type*: [ActionInvokeApi](./aws-properties-apigatewayv2-routingrule-actioninvokeapi.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-action.html#cfn-apigatewayv2-routingrule-action-invokeapi", "UpdateType": "Mutable", "Required": true, "Type": "ActionInvokeApi" } } }, "AWS::ApiGatewayV2::RoutingRule.ActionInvokeApi": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RoutingRule.ActionInvokeApi`\n\nRepresents an InvokeApi action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-actioninvokeapi.html", "Properties": { "StripBasePath": { "MarkdownDocumentation": "`StripBasePath`\n\nThe strip base path setting. When true, API Gateway strips the incoming matched base path when forwarding the request to the target API.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-actioninvokeapi.html#cfn-apigatewayv2-routingrule-actioninvokeapi-stripbasepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Stage": { "MarkdownDocumentation": "`Stage`\n\nThe name of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-actioninvokeapi.html#cfn-apigatewayv2-routingrule-actioninvokeapi-stage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API identifier of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-actioninvokeapi.html#cfn-apigatewayv2-routingrule-actioninvokeapi-apiid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApiGatewayV2::RoutingRule.Condition": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RoutingRule.Condition`\n\nRepresents a condition. Conditions can contain up to two `matchHeaders` conditions and one `matchBasePaths` conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html", "Properties": { "MatchBasePaths": { "MarkdownDocumentation": "`MatchBasePaths`\n\nThe base path to be matched.\n*Required*: No\n*Type*: [MatchBasePaths](./aws-properties-apigatewayv2-routingrule-matchbasepaths.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html#cfn-apigatewayv2-routingrule-condition-matchbasepaths", "UpdateType": "Mutable", "Required": false, "Type": "MatchBasePaths" }, "MatchHeaders": { "MarkdownDocumentation": "`MatchHeaders`\n\nThe headers to be matched.\n*Required*: No\n*Type*: [MatchHeaders](./aws-properties-apigatewayv2-routingrule-matchheaders.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html#cfn-apigatewayv2-routingrule-condition-matchheaders", "UpdateType": "Mutable", "Required": false, "Type": "MatchHeaders" } } }, "AWS::ApiGatewayV2::RoutingRule.MatchBasePaths": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RoutingRule.MatchBasePaths`\n\nRepresents a `MatchBasePaths` condition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchbasepaths.html", "Properties": { "AnyOf": { "MarkdownDocumentation": "`AnyOf`\n\nThe string of the case sensitive base path to be matched.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchbasepaths.html#cfn-apigatewayv2-routingrule-matchbasepaths-anyof", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ApiGatewayV2::RoutingRule.MatchHeaderValue": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RoutingRule.MatchHeaderValue`\n\nRepresents a `MatchHeaderValue`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheadervalue.html", "Properties": { "ValueGlob": { "MarkdownDocumentation": "`ValueGlob`\n\nThe case sensitive header glob value to be matched against entire header value. The header glob value must be less than 128 characters and the only allowed characters are `a-z`, `A-Z`, `0-9`, and the following special characters: `*?-!#$%&'.^_`|~`. Wildcard matching is supported for header glob values but must be for `*prefix-match`, `suffix-match*`, or `*infix*-match`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheadervalue.html#cfn-apigatewayv2-routingrule-matchheadervalue-valueglob", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Header": { "MarkdownDocumentation": "`Header`\n\nThe case insensitive header name to be matched. The header name must be less than 40 characters and the only allowed characters are `a-z`, `A-Z`, `0-9`, and the following special 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheadervalue.html#cfn-apigatewayv2-routingrule-matchheadervalue-header", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApiGatewayV2::RoutingRule.MatchHeaders": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RoutingRule.MatchHeaders`\n\nRepresents a `MatchHeaders` condition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheaders.html", "Properties": { "AnyOf": { "MarkdownDocumentation": "`AnyOf`\n\nThe header name and header value glob to be matched. The matchHeaders condition is matched if any of the header name and header value globs are matched.\n*Required*: Yes\n*Type*: Array of [MatchHeaderValue](./aws-properties-apigatewayv2-routingrule-matchheadervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheaders.html#cfn-apigatewayv2-routingrule-matchheaders-anyof", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MatchHeaderValue", "DuplicatesAllowed": true } } }, "AWS::ApiGatewayV2::Stage.AccessLogSettings": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Stage.AccessLogSettings`\n\nSettings for logging access in a stage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html", "Properties": { "Format": { "Required": false, "MarkdownDocumentation": "`Format`\n\nA single line format of the access logs of data, as specified by selected $context variables. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-format", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DestinationArn": { "Required": false, "MarkdownDocumentation": "`DestinationArn`\n\nThe ARN of the CloudWatch Logs log group to receive access logs. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-destinationarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::ApiGatewayV2::Stage.RouteSettings": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Stage.RouteSettings`\n\nRepresents a collection of route settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html", "Properties": { "LoggingLevel": { "Required": false, "MarkdownDocumentation": "`LoggingLevel`\n\nSpecifies the logging level for this route: `INFO`, `ERROR`, or `OFF`. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-logginglevel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DataTraceEnabled": { "Required": false, "MarkdownDocumentation": "`DataTraceEnabled`\n\nSpecifies whether (`true`) or not (`false`) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-datatraceenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ThrottlingBurstLimit": { "Required": false, "MarkdownDocumentation": "`ThrottlingBurstLimit`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingburstlimit", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DetailedMetricsEnabled": { "Required": false, "MarkdownDocumentation": "`DetailedMetricsEnabled`\n\nSpecifies whether detailed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-detailedmetricsenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ThrottlingRateLimit": { "Required": false, "MarkdownDocumentation": "`ThrottlingRateLimit`\n\nSpecifies the throttling rate limit.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingratelimit", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::AppConfig::Application.Tags": { "MarkdownDocumentation": "`AWS::AppConfig::Application.Tags`\n\nMetadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which\nyou define.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-application-tags.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value can be up to 256 characters.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-application-tags.html#cfn-appconfig-application-tags-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key-value string map. The valid character set is `[a-zA-Z+-=._:/]`. The tag\nkey can be up to 128 characters and must not start with `aws:`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-application-tags.html#cfn-appconfig-application-tags-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppConfig::ConfigurationProfile.Tags": { "MarkdownDocumentation": "`AWS::AppConfig::ConfigurationProfile.Tags`\n\nMetadata to assign to the configuration profile. Tags help organize and categorize your\nAWS AppConfig resources. Each tag consists of a key and an optional value, both of\nwhich you define.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value can be up to 256 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html#cfn-appconfig-configurationprofile-tags-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key-value string map. The valid character set is `[a-zA-Z+-=._:/]`. The tag\nkey can be up to 128 characters and must not start with `aws:`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html#cfn-appconfig-configurationprofile-tags-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppConfig::ConfigurationProfile.Validators": { "MarkdownDocumentation": "`AWS::AppConfig::ConfigurationProfile.Validators`\n\nA validator provides a syntactic or semantic check to ensure the configuration that you\nwant to deploy functions as intended. To validate your application configuration data, you\nprovide a schema or an AWS Lambda function that runs against the configuration. The\nconfiguration deployment or update can only proceed when the configuration data is valid.\nFor more information, see [About validators](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-profile.html#appconfig-creating-configuration-and-profile-validators) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nAWS AppConfig supports validators of type `JSON_SCHEMA` and\n`LAMBDA`\n*Required*: No\n*Type*: String\n*Allowed values*: `JSON_SCHEMA | LAMBDA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JSON_SCHEMA", "LAMBDA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html#cfn-appconfig-configurationprofile-validators-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nEither the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda\nfunction.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `32768`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html#cfn-appconfig-configurationprofile-validators-content", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppConfig::Deployment.DynamicExtensionParameters": { "MarkdownDocumentation": "`AWS::AppConfig::Deployment.DynamicExtensionParameters`\n\nA map of dynamic extension parameter names to values to pass to associated extensions\nwith `PRE_START_DEPLOYMENT` actions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-dynamicextensionparameters.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nThe parameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-dynamicextensionparameters.html#cfn-appconfig-deployment-dynamicextensionparameters-parametervalue", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExtensionReference": { "MarkdownDocumentation": "`ExtensionReference`\n\nThe ARN or ID of the extension for which you are inserting a dynamic parameter.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-dynamicextensionparameters.html#cfn-appconfig-deployment-dynamicextensionparameters-extensionreference", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-dynamicextensionparameters.html#cfn-appconfig-deployment-dynamicextensionparameters-parametername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppConfig::Environment.Monitor": { "MarkdownDocumentation": "`AWS::AppConfig::Environment.Monitor`\n\nAmazon CloudWatch alarms to monitor during the deployment process.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitor.html", "Properties": { "AlarmArn": { "MarkdownDocumentation": "`AlarmArn`\n\nAmazon Resource Name (ARN) of the Amazon CloudWatch alarm.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitor.html#cfn-appconfig-environment-monitor-alarmarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AlarmRoleArn": { "MarkdownDocumentation": "`AlarmRoleArn`\n\nARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor\n`AlarmArn`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitor.html#cfn-appconfig-environment-monitor-alarmrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppConfig::Extension.Parameter": { "MarkdownDocumentation": "`AWS::AppConfig::Extension.Parameter`\n\nA value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered\nin an extension when invoked. Parameter values are specified in an extension association.\nFor more information about extensions, see [Extending\nworkflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-parameter.html", "Properties": { "Dynamic": { "MarkdownDocumentation": "`Dynamic`\n\nIndicates whether this parameter's value can be supplied at the extension's action point\ninstead of during extension association. Dynamic parameters can't be marked\n`Required`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-parameter.html#cfn-appconfig-extension-parameter-dynamic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Description": { "MarkdownDocumentation": "`Description`\n\nInformation about the parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-parameter.html#cfn-appconfig-extension-parameter-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Required": { "MarkdownDocumentation": "`Required`\n\nA parameter value must be specified in the extension association.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-parameter.html#cfn-appconfig-extension-parameter-required", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::AppFlow::Connector.ConnectorProvisioningConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Connector.ConnectorProvisioningConfig`\n\nContains information about the configuration of the connector being registered.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-connectorprovisioningconfig.html", "Properties": { "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nContains information about the configuration of the lambda which is being registered as\nthe connector.\n*Required*: No\n*Type*: [LambdaConnectorProvisioningConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-connectorprovisioningconfig.html#cfn-appflow-connector-connectorprovisioningconfig-lambda", "UpdateType": "Mutable", "Required": false, "Type": "LambdaConnectorProvisioningConfig" } } }, "AWS::AppFlow::Connector.LambdaConnectorProvisioningConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Connector.LambdaConnectorProvisioningConfig`\n\nContains information about the configuration of the lambda which is being registered as\nthe connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-lambdaconnectorprovisioningconfig.html", "Properties": { "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nLambda ARN of the connector being registered.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:*:.*:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-lambdaconnectorprovisioningconfig.html#cfn-appflow-connector-lambdaconnectorprovisioningconfig-lambdaarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.AmplitudeConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.AmplitudeConnectorProfileCredentials`\n\nThe connector-specific credentials required when using Amplitude.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-amplitudeconnectorprofilecredentials.html", "Properties": { "SecretKey": { "MarkdownDocumentation": "`SecretKey`\n\nThe Secret Access Key portion of the credentials.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-amplitudeconnectorprofilecredentials.html#cfn-appflow-connectorprofile-amplitudeconnectorprofilecredentials-secretkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApiKey": { "MarkdownDocumentation": "`ApiKey`\n\nA unique alphanumeric identifier used to authenticate a user, developer, or calling\nprogram to your API.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-amplitudeconnectorprofilecredentials.html#cfn-appflow-connectorprofile-amplitudeconnectorprofilecredentials-apikey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.ApiKeyCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ApiKeyCredentials`\n\nThe API key credentials required for API key authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html", "Properties": { "ApiSecretKey": { "MarkdownDocumentation": "`ApiSecretKey`\n\nThe API secret key required for API key authentication.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html#cfn-appflow-connectorprofile-apikeycredentials-apisecretkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiKey": { "MarkdownDocumentation": "`ApiKey`\n\nThe API key required for API key authentication.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html#cfn-appflow-connectorprofile-apikeycredentials-apikey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.BasicAuthCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.BasicAuthCredentials`\n\nThe basic auth credentials required for basic authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe username to use to connect to a resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html#cfn-appflow-connectorprofile-basicauthcredentials-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password to use to connect to a resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html#cfn-appflow-connectorprofile-basicauthcredentials-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest`\n\nUsed by select connectors for which the OAuth workflow is supported, such as Salesforce,\nGoogle Analytics, Marketo, Zendesk, and Slack.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html", "Properties": { "AuthCode": { "MarkdownDocumentation": "`AuthCode`\n\nThe code provided by the connector when it has been authenticated via the connected app.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html#cfn-appflow-connectorprofile-connectoroauthrequest-authcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RedirectUri": { "MarkdownDocumentation": "`RedirectUri`\n\nThe URL to which the authentication server redirects the browser after authorization has\nbeen granted.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html#cfn-appflow-connectorprofile-connectoroauthrequest-redirecturi", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig`\n\nDefines the connector-specific configuration and credentials for the connector profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileconfig.html", "Properties": { "ConnectorProfileCredentials": { "MarkdownDocumentation": "`ConnectorProfileCredentials`\n\nThe connector-specific credentials required by each connector.\n*Required*: No\n*Type*: [ConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileconfig.html#cfn-appflow-connectorprofile-connectorprofileconfig-connectorprofilecredentials", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorProfileCredentials" }, "ConnectorProfileProperties": { "MarkdownDocumentation": "`ConnectorProfileProperties`\n\nThe connector-specific properties of the profile configuration.\n*Required*: No\n*Type*: [ConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileconfig.html#cfn-appflow-connectorprofile-connectorprofileconfig-connectorprofileproperties", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorProfileProperties" } } }, "AWS::AppFlow::ConnectorProfile.ConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ConnectorProfileCredentials`\n\nThe connector-specific credentials required by a connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html", "Properties": { "Amplitude": { "MarkdownDocumentation": "`Amplitude`\n\nThe connector-specific credentials required when using Amplitude.\n*Required*: No\n*Type*: [AmplitudeConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-amplitude", "UpdateType": "Mutable", "Required": false, "Type": "AmplitudeConnectorProfileCredentials" }, "GoogleAnalytics": { "MarkdownDocumentation": "`GoogleAnalytics`\n\nThe connector-specific credentials required when using Google Analytics.\n*Required*: No\n*Type*: [GoogleAnalyticsConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-googleanalytics", "UpdateType": "Mutable", "Required": false, "Type": "GoogleAnalyticsConnectorProfileCredentials" }, "ServiceNow": { "MarkdownDocumentation": "`ServiceNow`\n\nThe connector-specific credentials required when using ServiceNow.\n*Required*: No\n*Type*: [ServiceNowConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-servicenow", "UpdateType": "Mutable", "Required": false, "Type": "ServiceNowConnectorProfileCredentials" }, "CustomConnector": { "MarkdownDocumentation": "`CustomConnector`\n\nThe connector-specific profile credentials that are required when using the custom\nconnector.\n*Required*: No\n*Type*: [CustomConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-customconnector", "UpdateType": "Mutable", "Required": false, "Type": "CustomConnectorProfileCredentials" }, "SAPOData": { "MarkdownDocumentation": "`SAPOData`\n\nThe connector-specific profile credentials required when using SAPOData.\n*Required*: No\n*Type*: [SAPODataConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-sapodata", "UpdateType": "Mutable", "Required": false, "Type": "SAPODataConnectorProfileCredentials" }, "Pardot": { "MarkdownDocumentation": "`Pardot`\n\nThe connector-specific credentials required when using Salesforce Pardot.\n*Required*: No\n*Type*: [PardotConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-pardot", "UpdateType": "Mutable", "Required": false, "Type": "PardotConnectorProfileCredentials" }, "Veeva": { "MarkdownDocumentation": "`Veeva`\n\nThe connector-specific credentials required when using Veeva.\n*Required*: No\n*Type*: [VeevaConnectorProfileCredentials](./aws-properties-appflow-connectorprofile-veevaconnectorprofilecredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-veeva", "UpdateType": "Mutable", "Required": false, "Type": "VeevaConnectorProfileCredentials" }, "Trendmicro": { "MarkdownDocumentation": "`Trendmicro`\n\nThe connector-specific credentials required when using Trend Micro.\n*Required*: No\n*Type*: [TrendmicroConnectorProfileCredentials](./aws-properties-appflow-connectorprofile-trendmicroconnectorprofilecredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-trendmicro", "UpdateType": "Mutable", "Required": false, "Type": "TrendmicroConnectorProfileCredentials" }, "Datadog": { "MarkdownDocumentation": "`Datadog`\n\nThe connector-specific credentials required when using Datadog.\n*Required*: No\n*Type*: [DatadogConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-datadog", "UpdateType": "Mutable", "Required": false, "Type": "DatadogConnectorProfileCredentials" }, "Marketo": { "MarkdownDocumentation": "`Marketo`\n\nThe connector-specific credentials required when using Marketo.\n*Required*: No\n*Type*: [MarketoConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-marketo", "UpdateType": "Mutable", "Required": false, "Type": "MarketoConnectorProfileCredentials" }, "Redshift": { "MarkdownDocumentation": "`Redshift`\n\nThe connector-specific credentials required when using Amazon Redshift.\n*Required*: No\n*Type*: [RedshiftConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-redshift", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftConnectorProfileCredentials" }, "Singular": { "MarkdownDocumentation": "`Singular`\n\nThe connector-specific credentials required when using Singular.\n*Required*: No\n*Type*: [SingularConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-singular", "UpdateType": "Mutable", "Required": false, "Type": "SingularConnectorProfileCredentials" }, "Slack": { "MarkdownDocumentation": "`Slack`\n\nThe connector-specific credentials required when using Slack.\n*Required*: No\n*Type*: [SlackConnectorProfileCredentials](./aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-slack", "UpdateType": "Mutable", "Required": false, "Type": "SlackConnectorProfileCredentials" }, "Snowflake": { "MarkdownDocumentation": "`Snowflake`\n\nThe connector-specific credentials required when using Snowflake.\n*Required*: No\n*Type*: [SnowflakeConnectorProfileCredentials](./aws-properties-appflow-connectorprofile-snowflakeconnectorprofilecredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-snowflake", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeConnectorProfileCredentials" }, "Dynatrace": { "MarkdownDocumentation": "`Dynatrace`\n\nThe connector-specific credentials required when using Dynatrace.\n*Required*: No\n*Type*: [DynatraceConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-dynatrace", "UpdateType": "Mutable", "Required": false, "Type": "DynatraceConnectorProfileCredentials" }, "Zendesk": { "MarkdownDocumentation": "`Zendesk`\n\nThe connector-specific credentials required when using Zendesk.\n*Required*: No\n*Type*: [ZendeskConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-zendesk", "UpdateType": "Mutable", "Required": false, "Type": "ZendeskConnectorProfileCredentials" }, "InforNexus": { "MarkdownDocumentation": "`InforNexus`\n\nThe connector-specific credentials required when using Infor Nexus.\n*Required*: No\n*Type*: [InforNexusConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-infornexus", "UpdateType": "Mutable", "Required": false, "Type": "InforNexusConnectorProfileCredentials" }, "Salesforce": { "MarkdownDocumentation": "`Salesforce`\n\nThe connector-specific credentials required when using Salesforce.\n*Required*: No\n*Type*: [SalesforceConnectorProfileCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-salesforce", "UpdateType": "Mutable", "Required": false, "Type": "SalesforceConnectorProfileCredentials" } } }, "AWS::AppFlow::ConnectorProfile.ConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ConnectorProfileProperties`\n\nThe connector-specific profile properties required by each connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html", "Properties": { "ServiceNow": { "MarkdownDocumentation": "`ServiceNow`\n\nThe connector-specific properties required by serviceNow.\n*Required*: No\n*Type*: [ServiceNowConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-servicenow", "UpdateType": "Mutable", "Required": false, "Type": "ServiceNowConnectorProfileProperties" }, "CustomConnector": { "MarkdownDocumentation": "`CustomConnector`\n\nThe properties required by the custom connector.\n*Required*: No\n*Type*: [CustomConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-customconnector", "UpdateType": "Mutable", "Required": false, "Type": "CustomConnectorProfileProperties" }, "SAPOData": { "MarkdownDocumentation": "`SAPOData`\n\nThe connector-specific profile properties required when using SAPOData.\n*Required*: No\n*Type*: [SAPODataConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-sapodata", "UpdateType": "Mutable", "Required": false, "Type": "SAPODataConnectorProfileProperties" }, "Pardot": { "MarkdownDocumentation": "`Pardot`\n\nThe connector-specific properties required by Salesforce Pardot.\n*Required*: No\n*Type*: [PardotConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-pardot", "UpdateType": "Mutable", "Required": false, "Type": "PardotConnectorProfileProperties" }, "Veeva": { "MarkdownDocumentation": "`Veeva`\n\nThe connector-specific properties required by Veeva.\n*Required*: No\n*Type*: [VeevaConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-veeva", "UpdateType": "Mutable", "Required": false, "Type": "VeevaConnectorProfileProperties" }, "Datadog": { "MarkdownDocumentation": "`Datadog`\n\nThe connector-specific properties required by Datadog.\n*Required*: No\n*Type*: [DatadogConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-datadog", "UpdateType": "Mutable", "Required": false, "Type": "DatadogConnectorProfileProperties" }, "Marketo": { "MarkdownDocumentation": "`Marketo`\n\nThe connector-specific properties required by Marketo.\n*Required*: No\n*Type*: [MarketoConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-marketo", "UpdateType": "Mutable", "Required": false, "Type": "MarketoConnectorProfileProperties" }, "Redshift": { "MarkdownDocumentation": "`Redshift`\n\nThe connector-specific properties required by Amazon Redshift.\n*Required*: No\n*Type*: [RedshiftConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-redshift", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftConnectorProfileProperties" }, "Slack": { "MarkdownDocumentation": "`Slack`\n\nThe connector-specific properties required by Slack.\n*Required*: No\n*Type*: [SlackConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-slack", "UpdateType": "Mutable", "Required": false, "Type": "SlackConnectorProfileProperties" }, "Snowflake": { "MarkdownDocumentation": "`Snowflake`\n\nThe connector-specific properties required by Snowflake.\n*Required*: No\n*Type*: [SnowflakeConnectorProfileProperties](./aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-snowflake", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeConnectorProfileProperties" }, "Dynatrace": { "MarkdownDocumentation": "`Dynatrace`\n\nThe connector-specific properties required by Dynatrace.\n*Required*: No\n*Type*: [DynatraceConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-dynatrace", "UpdateType": "Mutable", "Required": false, "Type": "DynatraceConnectorProfileProperties" }, "Zendesk": { "MarkdownDocumentation": "`Zendesk`\n\nThe connector-specific properties required by Zendesk.\n*Required*: No\n*Type*: [ZendeskConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-zendesk", "UpdateType": "Mutable", "Required": false, "Type": "ZendeskConnectorProfileProperties" }, "InforNexus": { "MarkdownDocumentation": "`InforNexus`\n\nThe connector-specific properties required by Infor Nexus.\n*Required*: No\n*Type*: [InforNexusConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-infornexus", "UpdateType": "Mutable", "Required": false, "Type": "InforNexusConnectorProfileProperties" }, "Salesforce": { "MarkdownDocumentation": "`Salesforce`\n\nThe connector-specific properties required by Salesforce.\n*Required*: No\n*Type*: [SalesforceConnectorProfileProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-salesforce", "UpdateType": "Mutable", "Required": false, "Type": "SalesforceConnectorProfileProperties" } } }, "AWS::AppFlow::ConnectorProfile.CustomAuthCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.CustomAuthCredentials`\n\nThe custom credentials required for custom authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customauthcredentials.html", "Properties": { "CredentialsMap": { "MarkdownDocumentation": "`CredentialsMap`\n\nA map that holds custom authentication credentials.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\w]{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customauthcredentials.html#cfn-appflow-connectorprofile-customauthcredentials-credentialsmap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "CustomAuthenticationType": { "MarkdownDocumentation": "`CustomAuthenticationType`\n\nThe custom authentication type that the connector uses.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customauthcredentials.html#cfn-appflow-connectorprofile-customauthcredentials-customauthenticationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.CustomConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.CustomConnectorProfileCredentials`\n\nThe connector-specific profile credentials that are required when using the custom\nconnector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html", "Properties": { "Basic": { "MarkdownDocumentation": "`Basic`\n\nThe basic credentials that are required for the authentication of the user.\n*Required*: No\n*Type*: [BasicAuthCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-basic", "UpdateType": "Mutable", "Required": false, "Type": "BasicAuthCredentials" }, "ApiKey": { "MarkdownDocumentation": "`ApiKey`\n\nThe API keys required for the authentication of the user.\n*Required*: No\n*Type*: [ApiKeyCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-apikey", "UpdateType": "Mutable", "Required": false, "Type": "ApiKeyCredentials" }, "Oauth2": { "MarkdownDocumentation": "`Oauth2`\n\nThe OAuth 2.0 credentials required for the authentication of the user.\n*Required*: No\n*Type*: [OAuth2Credentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-oauth2", "UpdateType": "Mutable", "Required": false, "Type": "OAuth2Credentials" }, "Custom": { "MarkdownDocumentation": "`Custom`\n\nIf the connector uses the custom authentication mechanism, this holds the required\ncredentials.\n*Required*: No\n*Type*: [CustomAuthCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-custom", "UpdateType": "Mutable", "Required": false, "Type": "CustomAuthCredentials" }, "AuthenticationType": { "MarkdownDocumentation": "`AuthenticationType`\n\nThe authentication type that the custom connector uses for authenticating while creating a\nconnector profile.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OAUTH2 | APIKEY | BASIC | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OAUTH2", "APIKEY", "BASIC", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-authenticationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.CustomConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.CustomConnectorProfileProperties`\n\nThe profile properties required by the custom connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofileproperties.html", "Properties": { "OAuth2Properties": { "MarkdownDocumentation": "`OAuth2Properties`\n\nThe OAuth 2.0 properties required for OAuth 2.0 authentication.\n*Required*: No\n*Type*: [OAuth2Properties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofileproperties.html#cfn-appflow-connectorprofile-customconnectorprofileproperties-oauth2properties", "UpdateType": "Mutable", "Required": false, "Type": "OAuth2Properties" }, "ProfileProperties": { "MarkdownDocumentation": "`ProfileProperties`\n\nA map of properties that are required to create a profile for the custom connector.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\w]{1,256}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofileproperties.html#cfn-appflow-connectorprofile-customconnectorprofileproperties-profileproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileCredentials`\n\nThe connector-specific credentials required by Datadog.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofilecredentials.html", "Properties": { "ApplicationKey": { "MarkdownDocumentation": "`ApplicationKey`\n\nApplication keys, in conjunction with your API key, give you full access to Datadog\u2019s\nprogrammatic API. Application keys are associated with the user account that created them. The\napplication key is used to log all requests made to the API.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofilecredentials.html#cfn-appflow-connectorprofile-datadogconnectorprofilecredentials-applicationkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApiKey": { "MarkdownDocumentation": "`ApiKey`\n\nA unique alphanumeric identifier used to authenticate a user, developer, or calling\nprogram to your API.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofilecredentials.html#cfn-appflow-connectorprofile-datadogconnectorprofilecredentials-apikey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileProperties`\n\nThe connector-specific profile properties required by Datadog.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Datadog resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofileproperties.html#cfn-appflow-connectorprofile-datadogconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.DynatraceConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.DynatraceConnectorProfileCredentials`\n\nThe connector-specific profile credentials required by Dynatrace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-dynatraceconnectorprofilecredentials.html", "Properties": { "ApiToken": { "MarkdownDocumentation": "`ApiToken`\n\nThe API tokens used by Dynatrace API to authenticate various API calls.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-dynatraceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-dynatraceconnectorprofilecredentials-apitoken", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.DynatraceConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.DynatraceConnectorProfileProperties`\n\nThe connector-specific profile properties required by Dynatrace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-dynatraceconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Dynatrace resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-dynatraceconnectorprofileproperties.html#cfn-appflow-connectorprofile-dynatraceconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.GoogleAnalyticsConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.GoogleAnalyticsConnectorProfileCredentials`\n\nThe connector-specific profile credentials required by Google Analytics.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html", "Properties": { "RefreshToken": { "MarkdownDocumentation": "`RefreshToken`\n\nThe credentials used to acquire new access tokens. This is required only for OAuth2\naccess tokens, and is not required for OAuth1 access tokens.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-refreshtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe client secret used by the OAuth client to authenticate to the authorization server.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-clientsecret", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe credentials used to access protected Google Analytics resources.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe identifier for the desired client.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-clientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConnectorOAuthRequest": { "MarkdownDocumentation": "`ConnectorOAuthRequest`\n\nUsed by select connectors for which the OAuth workflow is supported, such as Salesforce,\nGoogle Analytics, Marketo, Zendesk, and Slack.\n*Required*: No\n*Type*: [ConnectorOAuthRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-connectoroauthrequest", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOAuthRequest" } } }, "AWS::AppFlow::ConnectorProfile.InforNexusConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.InforNexusConnectorProfileCredentials`\n\nThe connector-specific profile credentials required by Infor Nexus.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html", "Properties": { "AccessKeyId": { "MarkdownDocumentation": "`AccessKeyId`\n\nThe Access Key portion of the credentials.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-accesskeyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UserId": { "MarkdownDocumentation": "`UserId`\n\nThe identifier for the user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-userid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretAccessKey": { "MarkdownDocumentation": "`SecretAccessKey`\n\nThe secret key used to sign requests.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-secretaccesskey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Datakey": { "MarkdownDocumentation": "`Datakey`\n\nThe encryption keys used to encrypt data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-datakey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.InforNexusConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.InforNexusConnectorProfileProperties`\n\nThe connector-specific profile properties required by Infor Nexus.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Infor Nexus resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofileproperties.html#cfn-appflow-connectorprofile-infornexusconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.MarketoConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.MarketoConnectorProfileCredentials`\n\nThe connector-specific profile credentials required by Marketo.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html", "Properties": { "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe client secret used by the OAuth client to authenticate to the authorization server.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-clientsecret", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe credentials used to access protected Marketo resources.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe identifier for the desired client.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-clientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConnectorOAuthRequest": { "MarkdownDocumentation": "`ConnectorOAuthRequest`\n\nUsed by select connectors for which the OAuth workflow is supported, such as Salesforce,\nGoogle Analytics, Marketo, Zendesk, and Slack.\n*Required*: No\n*Type*: [ConnectorOAuthRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-connectoroauthrequest", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOAuthRequest" } } }, "AWS::AppFlow::ConnectorProfile.MarketoConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.MarketoConnectorProfileProperties`\n\nThe connector-specific profile properties required when using Marketo.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Marketo resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofileproperties.html#cfn-appflow-connectorprofile-marketoconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.OAuth2Credentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.OAuth2Credentials`\n\nThe OAuth 2.0 credentials required for OAuth 2.0 authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html", "Properties": { "OAuthRequest": { "MarkdownDocumentation": "`OAuthRequest`\n\nProperty description not available.\n*Required*: No\n*Type*: [ConnectorOAuthRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-oauthrequest", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOAuthRequest" }, "RefreshToken": { "MarkdownDocumentation": "`RefreshToken`\n\nThe refresh token used to refresh an expired access token.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-refreshtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe client secret used by the OAuth client to authenticate to the authorization\nserver.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-clientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe access token used to access the connector on your behalf.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe identifier for the desired client.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-clientid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.OAuth2Properties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.OAuth2Properties`\n\nThe OAuth 2.0 properties required for OAuth 2.0 authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html", "Properties": { "TokenUrlCustomProperties": { "MarkdownDocumentation": "`TokenUrlCustomProperties`\n\nAssociates your token URL with a map of properties that you define. Use this parameter to\nprovide any additional details that the connector requires to authenticate your\nrequest.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\w]{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html#cfn-appflow-connectorprofile-oauth2properties-tokenurlcustomproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "TokenUrl": { "MarkdownDocumentation": "`TokenUrl`\n\nThe token URL required for OAuth 2.0 authentication.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html#cfn-appflow-connectorprofile-oauth2properties-tokenurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OAuth2GrantType": { "MarkdownDocumentation": "`OAuth2GrantType`\n\nThe OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLIENT_CREDENTIALS | AUTHOR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "JWT_BEARER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html#cfn-appflow-connectorprofile-oauth2properties-oauth2granttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.OAuthCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.OAuthCredentials`\n\nThe OAuth credentials required for OAuth type authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html", "Properties": { "RefreshToken": { "MarkdownDocumentation": "`RefreshToken`\n\nThe refresh token used to refresh expired access token.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-refreshtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe access token used to access protected SAPOData resources.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe client secret used by the OAuth client to authenticate to the authorization server.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-clientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe identifier for the desired client.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-clientid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectorOAuthRequest": { "MarkdownDocumentation": "`ConnectorOAuthRequest`\n\nProperty description not available.\n*Required*: No\n*Type*: [ConnectorOAuthRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-connectoroauthrequest", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOAuthRequest" } } }, "AWS::AppFlow::ConnectorProfile.OAuthProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.OAuthProperties`\n\nThe OAuth properties required for OAuth type authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html", "Properties": { "AuthCodeUrl": { "MarkdownDocumentation": "`AuthCodeUrl`\n\nThe authorization code url required to redirect to SAP Login Page to fetch authorization\ncode for OAuth type authentication.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html#cfn-appflow-connectorprofile-oauthproperties-authcodeurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TokenUrl": { "MarkdownDocumentation": "`TokenUrl`\n\nThe token url required to fetch access/refresh tokens using authorization code and also\nto refresh expired access token using refresh token.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html#cfn-appflow-connectorprofile-oauthproperties-tokenurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OAuthScopes": { "MarkdownDocumentation": "`OAuthScopes`\n\nThe OAuth scopes required for OAuth type authentication.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html#cfn-appflow-connectorprofile-oauthproperties-oauthscopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::AppFlow::ConnectorProfile.PardotConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.PardotConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Salesforce Pardot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html", "Properties": { "RefreshToken": { "MarkdownDocumentation": "`RefreshToken`\n\nThe credentials used to acquire new access tokens.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-refreshtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe credentials used to access protected Salesforce Pardot resources.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientCredentialsArn": { "MarkdownDocumentation": "`ClientCredentialsArn`\n\nThe secret manager ARN, which contains the client ID and client secret of the connected\napp.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws:secretsmanager:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-clientcredentialsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectorOAuthRequest": { "MarkdownDocumentation": "`ConnectorOAuthRequest`\n\nProperty description not available.\n*Required*: No\n*Type*: [ConnectorOAuthRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-connectoroauthrequest", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOAuthRequest" } } }, "AWS::AppFlow::ConnectorProfile.PardotConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.PardotConnectorProfileProperties`\n\nThe connector-specific profile properties required when using Salesforce Pardot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Salesforce Pardot resource.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IsSandboxEnvironment": { "MarkdownDocumentation": "`IsSandboxEnvironment`\n\nIndicates whether the connector profile applies to a sandbox or production\nenvironment.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-issandboxenvironment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BusinessUnitId": { "MarkdownDocumentation": "`BusinessUnitId`\n\nThe business unit id of Salesforce Pardot instance.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\n*Maximum*: `18`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-businessunitid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Amazon Redshift.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofilecredentials.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe name of the user.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofilecredentials.html#cfn-appflow-connectorprofile-redshiftconnectorprofilecredentials-username", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password that corresponds to the user name.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofilecredentials.html#cfn-appflow-connectorprofile-redshiftconnectorprofilecredentials-password", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileProperties`\n\nThe connector-specific profile properties when using Amazon Redshift.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html", "Properties": { "DatabaseUrl": { "MarkdownDocumentation": "`DatabaseUrl`\n\nThe JDBC URL of the Amazon Redshift cluster.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databaseurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nA name for the associated Amazon S3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IsRedshiftServerless": { "MarkdownDocumentation": "`IsRedshiftServerless`\n\nIndicates whether the connector profile defines a connection to an Amazon Redshift\nServerless 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-isredshiftserverless", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DataApiRoleArn": { "MarkdownDocumentation": "`DataApiRoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more\ninformation, and for the polices that you attach to this role, see [Allow Amazon AppFlow to access Amazon Redshift databases with the Data\nAPI](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift).\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-dataapirolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of an Amazon Redshift database.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WorkgroupName": { "MarkdownDocumentation": "`WorkgroupName`\n\nThe name of an Amazon Redshift workgroup.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-workgroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nThe object key for the destination bucket in which Amazon AppFlow places the files.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterIdentifier": { "MarkdownDocumentation": "`ClusterIdentifier`\n\nThe unique ID that's assigned to an Amazon Redshift cluster.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-clusteridentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift\nread-only access to Amazon S3. For more information, and for the polices that you\nattach 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*Pattern*: `arn:aws:iam:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.SAPODataConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SAPODataConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using SAPOData.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html", "Properties": { "BasicAuthCredentials": { "MarkdownDocumentation": "`BasicAuthCredentials`\n\nThe SAPOData basic authentication credentials.\n*Required*: No\n*Type*: [BasicAuthCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html#cfn-appflow-connectorprofile-sapodataconnectorprofilecredentials-basicauthcredentials", "UpdateType": "Mutable", "Required": false, "Type": "BasicAuthCredentials" }, "OAuthCredentials": { "MarkdownDocumentation": "`OAuthCredentials`\n\nThe SAPOData OAuth type authentication credentials.\n*Required*: No\n*Type*: [OAuthCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html#cfn-appflow-connectorprofile-sapodataconnectorprofilecredentials-oauthcredentials", "UpdateType": "Mutable", "Required": false, "Type": "OAuthCredentials" } } }, "AWS::AppFlow::ConnectorProfile.SAPODataConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SAPODataConnectorProfileProperties`\n\nThe connector-specific profile properties required when using SAPOData.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html", "Properties": { "ApplicationServicePath": { "MarkdownDocumentation": "`ApplicationServicePath`\n\nThe application path to catalog service.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-applicationservicepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationHostUrl": { "MarkdownDocumentation": "`ApplicationHostUrl`\n\nThe location of the SAPOData resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-applicationhosturl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OAuthProperties": { "MarkdownDocumentation": "`OAuthProperties`\n\nThe SAPOData OAuth properties required for OAuth type authentication.\n*Required*: No\n*Type*: [OAuthProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-oauthproperties", "UpdateType": "Mutable", "Required": false, "Type": "OAuthProperties" }, "DisableSSO": { "MarkdownDocumentation": "`DisableSSO`\n\nIf you set this parameter to `true`, Amazon AppFlow bypasses the single\nsign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.\nWhether you need this option depends on the types of credentials that you applied to your\nSAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO\ncan prevent Amazon AppFlow from connecting to your account with your username and\npassword. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect\nsuccessfully. However, if your profile uses OAuth credentials, this parameter has no\naffect.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-disablesso", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LogonLanguage": { "MarkdownDocumentation": "`LogonLanguage`\n\nThe logon language of SAPOData instance.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-logonlanguage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateLinkServiceName": { "MarkdownDocumentation": "`PrivateLinkServiceName`\n\nThe SAPOData Private Link service name to be used for private data transfers.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-privatelinkservicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PortNumber": { "MarkdownDocumentation": "`PortNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-portnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ClientNumber": { "MarkdownDocumentation": "`ClientNumber`\n\nThe client number for the client creating the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d{3}$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-clientnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.SalesforceConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SalesforceConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Salesforce.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html", "Properties": { "JwtToken": { "MarkdownDocumentation": "`JwtToken`\n\nA JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce\nrecords.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_.+/=]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-jwttoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RefreshToken": { "MarkdownDocumentation": "`RefreshToken`\n\nThe credentials used to acquire new access tokens.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-refreshtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe credentials used to access protected Salesforce resources.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientCredentialsArn": { "MarkdownDocumentation": "`ClientCredentialsArn`\n\nThe secret manager ARN, which contains the client ID and client secret of the connected\napp.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws:secretsmanager:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-clientcredentialsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectorOAuthRequest": { "MarkdownDocumentation": "`ConnectorOAuthRequest`\n\nUsed by select connectors for which the OAuth workflow is supported, such as Salesforce,\nGoogle Analytics, Marketo, Zendesk, and Slack.\n*Required*: No\n*Type*: [ConnectorOAuthRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-connectoroauthrequest", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOAuthRequest" }, "OAuth2GrantType": { "MarkdownDocumentation": "`OAuth2GrantType`\n\nSpecifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an\naccess token from Salesforce. Amazon AppFlow requires an access token each time it\nattempts to access your Salesforce records.\nYou can specify one of the following values:\nAUTHORIZATION\\_CODE\nAmazon AppFlow passes an authorization code when it requests the access token\nfrom Salesforce. Amazon AppFlow receives the authorization code from Salesforce\nafter you log in to your Salesforce account and authorize Amazon AppFlow to access\nyour records.\n\nJWT\\_BEARER\nAmazon AppFlow passes a JSON web token (JWT) when it requests the access token\nfrom Salesforce. You provide the JWT to Amazon AppFlow when you define the\nconnection to your Salesforce account. When you use this grant type, you don't need to\nlog in to your Salesforce account to authorize Amazon AppFlow to access your\nrecords.\n\n###### Note\nThe CLIENT\\_CREDENTIALS value is not supported for Salesforce.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLIENT_CREDENTIALS | AUTHOR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "JWT_BEARER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-oauth2granttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.SalesforceConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SalesforceConnectorProfileProperties`\n\nThe connector-specific profile properties required when using Salesforce.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Salesforce resource.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "isSandboxEnvironment": { "MarkdownDocumentation": "`isSandboxEnvironment`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-issandboxenvironment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "usePrivateLinkForMetadataAndAuthorization": { "MarkdownDocumentation": "`usePrivateLinkForMetadataAndAuthorization`\n\nIf the connection mode for the connector profile is private, this parameter sets whether\nAmazon AppFlow uses the private network to send metadata and authorization calls to\nSalesforce. Amazon AppFlow sends private calls through AWS PrivateLink. These\ncalls travel through AWS infrastructure without being exposed to the public\ninternet.\nSet either of the following values:\ntrue\nAmazon AppFlow sends all calls to Salesforce over the private network.\nThese private calls are:\n* Calls to get metadata about your Salesforce records. This metadata describes\n your Salesforce objects and their fields.\n* Calls to get or refresh access tokens that allow Amazon AppFlow to access\n your Salesforce records.\n* Calls to transfer your Salesforce records as part of a flow run.\n\nfalse\nThe default value. Amazon AppFlow sends some calls to Salesforce privately and\nother calls over the public internet.\nThe public calls are:\n* Calls to get metadata about your Salesforce records.\n* Calls to get or refresh access tokens.\nThe private calls are:\n* Calls to transfer your Salesforce records as part of a flow run.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-useprivatelinkformetadataandauthorization", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AppFlow::ConnectorProfile.ServiceNowConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ServiceNowConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using ServiceNow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe name of the user.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.html#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-username", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OAuth2Credentials": { "MarkdownDocumentation": "`OAuth2Credentials`\n\nThe OAuth 2.0 credentials required to authenticate the user.\n*Required*: No\n*Type*: [OAuth2Credentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.html#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-oauth2credentials", "UpdateType": "Mutable", "Required": false, "Type": "OAuth2Credentials" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password that corresponds to the user name.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.html#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-password", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.ServiceNowConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ServiceNowConnectorProfileProperties`\n\nThe connector-specific profile properties required when using ServiceNow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the ServiceNow resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofileproperties.html#cfn-appflow-connectorprofile-servicenowconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.SingularConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SingularConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Singular.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-singularconnectorprofilecredentials.html", "Properties": { "ApiKey": { "MarkdownDocumentation": "`ApiKey`\n\nA unique alphanumeric identifier used to authenticate a user, developer, or calling\nprogram to your API.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-singularconnectorprofilecredentials.html#cfn-appflow-connectorprofile-singularconnectorprofilecredentials-apikey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.SlackConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SlackConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Slack.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html", "Properties": { "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe client secret used by the OAuth client to authenticate to the authorization server.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-clientsecret", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe credentials used to access protected Slack resources.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe identifier for the client.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-clientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConnectorOAuthRequest": { "MarkdownDocumentation": "`ConnectorOAuthRequest`\n\nUsed by select connectors for which the OAuth workflow is supported, such as Salesforce,\nGoogle Analytics, Marketo, Zendesk, and Slack.\n*Required*: No\n*Type*: [ConnectorOAuthRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-connectoroauthrequest", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOAuthRequest" } } }, "AWS::AppFlow::ConnectorProfile.SlackConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SlackConnectorProfileProperties`\n\nThe connector-specific profile properties required when using Slack.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Slack resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofileproperties.html#cfn-appflow-connectorprofile-slackconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.SnowflakeConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SnowflakeConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Snowflake.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofilecredentials.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe name of the user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofilecredentials.html#cfn-appflow-connectorprofile-snowflakeconnectorprofilecredentials-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password that corresponds to the user name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofilecredentials.html#cfn-appflow-connectorprofile-snowflakeconnectorprofilecredentials-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.SnowflakeConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.SnowflakeConnectorProfileProperties`\n\nThe connector-specific profile properties required when using Snowflake.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html", "Properties": { "Warehouse": { "MarkdownDocumentation": "`Warehouse`\n\nThe name of the Snowflake warehouse.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\w/!@#+=.-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-warehouse", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the Amazon S3 bucket associated with Snowflake.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PrivateLinkServiceName": { "MarkdownDocumentation": "`PrivateLinkServiceName`\n\nThe Snowflake Private Link service name to be used for private data transfers.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-privatelinkservicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Stage": { "MarkdownDocumentation": "`Stage`\n\nThe name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: <\nDatabase>< Schema>.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-stage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe AWS Region of the Snowflake account.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nThe bucket path that refers to the Amazon S3 bucket associated with Snowflake.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccountName": { "MarkdownDocumentation": "`AccountName`\n\nThe name of the account.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-accountname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.TrendmicroConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.TrendmicroConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Trend Micro.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-trendmicroconnectorprofilecredentials.html", "Properties": { "ApiSecretKey": { "MarkdownDocumentation": "`ApiSecretKey`\n\nThe Secret Access Key portion of the credentials.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-trendmicroconnectorprofilecredentials.html#cfn-appflow-connectorprofile-trendmicroconnectorprofilecredentials-apisecretkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.VeevaConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.VeevaConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Veeva.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofilecredentials.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe name of the user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofilecredentials.html#cfn-appflow-connectorprofile-veevaconnectorprofilecredentials-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password that corresponds to the user name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofilecredentials.html#cfn-appflow-connectorprofile-veevaconnectorprofilecredentials-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.VeevaConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.VeevaConnectorProfileProperties`\n\nThe connector-specific profile properties required when using Veeva.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Veeva resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofileproperties.html#cfn-appflow-connectorprofile-veevaconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::ConnectorProfile.ZendeskConnectorProfileCredentials": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ZendeskConnectorProfileCredentials`\n\nThe connector-specific profile credentials required when using Zendesk.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html", "Properties": { "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe client secret used by the OAuth client to authenticate to the authorization server.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientsecret", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe credentials used to access protected Zendesk resources.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe identifier for the desired client.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConnectorOAuthRequest": { "MarkdownDocumentation": "`ConnectorOAuthRequest`\n\nUsed by select connectors for which the OAuth workflow is supported, such as Salesforce,\nGoogle Analytics, Marketo, Zendesk, and Slack.\n*Required*: No\n*Type*: [ConnectorOAuthRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-connectoroauthrequest", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOAuthRequest" } } }, "AWS::AppFlow::ConnectorProfile.ZendeskConnectorProfileProperties": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile.ZendeskConnectorProfileProperties`\n\nThe connector-specific profile properties required when using Zendesk.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofileproperties.html", "Properties": { "InstanceUrl": { "MarkdownDocumentation": "`InstanceUrl`\n\nThe location of the Zendesk resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofileproperties.html#cfn-appflow-connectorprofile-zendeskconnectorprofileproperties-instanceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.AggregationConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.AggregationConfig`\n\nThe aggregation settings that you can use to customize the output format of your flow\ndata.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-aggregationconfig.html", "Properties": { "TargetFileSize": { "MarkdownDocumentation": "`TargetFileSize`\n\nThe desired file size, in MB, for each output file that Amazon AppFlow writes to the\nflow destination. For each file, Amazon AppFlow attempts to achieve the size that you\nspecify. The actual file sizes might differ from this target based on the number and size of\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-aggregationconfig.html#cfn-appflow-flow-aggregationconfig-targetfilesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AggregationType": { "MarkdownDocumentation": "`AggregationType`\n\nSpecifies whether Amazon AppFlow aggregates the flow records into a single file, or\nleave 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)", "RefReturnValue": "", "AllowedValues": [ "None", "SingleFile" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-aggregationconfig.html#cfn-appflow-flow-aggregationconfig-aggregationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.AmplitudeSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.AmplitudeSourceProperties`\n\nThe properties that are applied when Amplitude is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-amplitudesourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Amplitude flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-amplitudesourceproperties.html#cfn-appflow-flow-amplitudesourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.ConnectorOperator": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.ConnectorOperator`\n\nThe operation to be performed on the provided source fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html", "Properties": { "Amplitude": { "MarkdownDocumentation": "`Amplitude`\n\nThe 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)\n", "RefReturnValue": "", "AllowedValues": [ "BETWEEN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-amplitude", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3": { "MarkdownDocumentation": "`S3`\n\nThe operation to be performed on the provided Amazon S3 source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | LESS_THAN | GR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "LESS_THAN", "GREATER_THAN", "BETWEEN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-s3", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GoogleAnalytics": { "MarkdownDocumentation": "`GoogleAnalytics`\n\nThe operation to be performed on the provided Google Analytics source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | BETWEEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "BETWEEN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-googleanalytics", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceNow": { "MarkdownDocumentation": "`ServiceNow`\n\nThe operation to be performed on the provided ServiceNow source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | LESS_THAN | CO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "LESS_THAN", "CONTAINS", "GREATER_THAN", "BETWEEN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-servicenow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomConnector": { "MarkdownDocumentation": "`CustomConnector`\n\nOperators supported by the custom connector.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | LESS_THAN | GR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "LESS_THAN", "GREATER_THAN", "CONTAINS", "BETWEEN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-customconnector", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SAPOData": { "MarkdownDocumentation": "`SAPOData`\n\nThe operation to be performed on the provided SAPOData source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | LESS_THAN | CO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "LESS_THAN", "CONTAINS", "GREATER_THAN", "BETWEEN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-sapodata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Pardot": { "MarkdownDocumentation": "`Pardot`\n\nThe operation to be performed on the provided Salesforce Pardot source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | EQUAL_TO | NO_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "EQUAL_TO", "NO_OP", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-pardot", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Veeva": { "MarkdownDocumentation": "`Veeva`\n\nThe operation to be performed on the provided Veeva source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | LESS_THAN | GR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "LESS_THAN", "GREATER_THAN", "BETWEEN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-veeva", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trendmicro": { "MarkdownDocumentation": "`Trendmicro`\n\nThe operation to be performed on the provided Trend Micro source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | EQUAL_TO | ADD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-trendmicro", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Datadog": { "MarkdownDocumentation": "`Datadog`\n\nThe operation to be performed on the provided Datadog source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | BETWEEN | EQUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "BETWEEN", "EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-datadog", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Marketo": { "MarkdownDocumentation": "`Marketo`\n\nThe operation to be performed on the provided Marketo source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | LESS_THAN | GR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "LESS_THAN", "GREATER_THAN", "BETWEEN", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-marketo", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Singular": { "MarkdownDocumentation": "`Singular`\n\nThe operation to be performed on the provided Singular source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | EQUAL_TO | ADD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-singular", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Slack": { "MarkdownDocumentation": "`Slack`\n\nThe operation to be performed on the provided Slack source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | BETWEEN | EQUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "BETWEEN", "EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-slack", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dynatrace": { "MarkdownDocumentation": "`Dynatrace`\n\nThe operation to be performed on the provided Dynatrace source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | BETWEEN | EQUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "BETWEEN", "EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-dynatrace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Zendesk": { "MarkdownDocumentation": "`Zendesk`\n\nThe operation to be performed on the provided Zendesk source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | GREATER_THAN |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "GREATER_THAN", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-zendesk", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InforNexus": { "MarkdownDocumentation": "`InforNexus`\n\nThe operation to be performed on the provided Infor Nexus source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | BETWEEN | EQUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "BETWEEN", "EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-infornexus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Salesforce": { "MarkdownDocumentation": "`Salesforce`\n\nThe operation to be performed on the provided Salesforce source fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROJECTION | LESS_THAN | CO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECTION", "LESS_THAN", "CONTAINS", "GREATER_THAN", "BETWEEN", "LESS_THAN_OR_EQUAL_TO", "GREATER_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO", "ADDITION", "MULTIPLICATION", "DIVISION", "SUBTRACTION", "MASK_ALL", "MASK_FIRST_N", "MASK_LAST_N", "VALIDATE_NON_NULL", "VALIDATE_NON_ZERO", "VALIDATE_NON_NEGATIVE", "VALIDATE_NUMERIC", "NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-connectoroperator.html#cfn-appflow-flow-connectoroperator-salesforce", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.CustomConnectorDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.CustomConnectorDestinationProperties`\n\nThe properties that are applied when the custom connector is being used as a\ndestination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html", "Properties": { "IdFieldNames": { "MarkdownDocumentation": "`IdFieldNames`\n\nThe name of the field that Amazon AppFlow uses as an ID when performing a write\noperation such as update, delete, or upsert.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html#cfn-appflow-flow-customconnectordestinationproperties-idfieldnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EntityName": { "MarkdownDocumentation": "`EntityName`\n\nThe entity specified in the custom connector as a destination in the flow.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html#cfn-appflow-flow-customconnectordestinationproperties-entityname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "WriteOperationType": { "MarkdownDocumentation": "`WriteOperationType`\n\nSpecifies the type of write operation to be performed in the custom connector when it's\nused as destination.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSERT | UPSERT | UPDATE | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSERT", "UPSERT", "UPDATE", "DELETE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html#cfn-appflow-flow-customconnectordestinationproperties-writeoperationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ErrorHandlingConfig": { "MarkdownDocumentation": "`ErrorHandlingConfig`\n\nThe settings that determine how Amazon AppFlow handles an error when placing data in\nthe custom connector as destination.\n*Required*: No\n*Type*: [ErrorHandlingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html#cfn-appflow-flow-customconnectordestinationproperties-errorhandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ErrorHandlingConfig" }, "CustomProperties": { "MarkdownDocumentation": "`CustomProperties`\n\nThe custom properties that are specific to the connector when it's used as a destination\nin the flow.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\w]{1,2048}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html#cfn-appflow-flow-customconnectordestinationproperties-customproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::AppFlow::Flow.CustomConnectorSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.CustomConnectorSourceProperties`\n\nThe properties that are applied when the custom connector is being used as a\nsource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html", "Properties": { "EntityName": { "MarkdownDocumentation": "`EntityName`\n\nThe entity specified in the custom connector as a source in the flow.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html#cfn-appflow-flow-customconnectorsourceproperties-entityname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataTransferApi": { "MarkdownDocumentation": "`DataTransferApi`\n\nThe API of the connector application that Amazon AppFlow uses to transfer your\ndata.\n*Required*: No\n*Type*: [DataTransferApi](./aws-properties-appflow-flow-datatransferapi.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html#cfn-appflow-flow-customconnectorsourceproperties-datatransferapi", "UpdateType": "Mutable", "Required": false, "Type": "DataTransferApi" }, "CustomProperties": { "MarkdownDocumentation": "`CustomProperties`\n\nCustom properties that are required to use the custom connector as a source.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\w]{1,2048}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html#cfn-appflow-flow-customconnectorsourceproperties-customproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::AppFlow::Flow.DataTransferApi": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.DataTransferApi`\n\nThe API of the connector application that Amazon AppFlow uses to transfer your\ndata.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datatransferapi.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nYou can specify one of the following types:\nAUTOMATIC\nThe default. Optimizes a flow for datasets that fluctuate in size from small to\nlarge. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type\nbased on the amount of data that the run transfers.\n\nSYNC\nA synchronous API. This type of API optimizes a flow for small to medium-sized\ndatasets.\n\nASYNC\nAn asynchronous API. This type of API optimizes a flow for large datasets.\n\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SYNC | ASYNC | AUTOMATIC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SYNC", "ASYNC", "AUTOMATIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datatransferapi.html#cfn-appflow-flow-datatransferapi-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the connector application API.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w/-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datatransferapi.html#cfn-appflow-flow-datatransferapi-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.DatadogSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.DatadogSourceProperties`\n\nThe properties that are applied when Datadog is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datadogsourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Datadog flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datadogsourceproperties.html#cfn-appflow-flow-datadogsourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.DestinationConnectorProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.DestinationConnectorProperties`\n\nThis stores the information that is required to query a particular connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nThe properties required to query Amazon S3.\n*Required*: No\n*Type*: [S3DestinationProperties](./aws-properties-appflow-flow-s3destinationproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3DestinationProperties" }, "CustomConnector": { "MarkdownDocumentation": "`CustomConnector`\n\nThe properties that are required to query the custom Connector.\n*Required*: No\n*Type*: [CustomConnectorDestinationProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-customconnector", "UpdateType": "Mutable", "Required": false, "Type": "CustomConnectorDestinationProperties" }, "Upsolver": { "MarkdownDocumentation": "`Upsolver`\n\nThe properties required to query Upsolver.\n*Required*: No\n*Type*: [UpsolverDestinationProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-upsolver", "UpdateType": "Mutable", "Required": false, "Type": "UpsolverDestinationProperties" }, "SAPOData": { "MarkdownDocumentation": "`SAPOData`\n\nThe properties required to query SAPOData.\n*Required*: No\n*Type*: [SAPODataDestinationProperties](./aws-properties-appflow-flow-sapodatadestinationproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-sapodata", "UpdateType": "Mutable", "Required": false, "Type": "SAPODataDestinationProperties" }, "Snowflake": { "MarkdownDocumentation": "`Snowflake`\n\nThe properties required to query Snowflake.\n*Required*: No\n*Type*: [SnowflakeDestinationProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-snowflake", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeDestinationProperties" }, "LookoutMetrics": { "MarkdownDocumentation": "`LookoutMetrics`\n\nThe properties required to query Amazon Lookout for Metrics.\n*Required*: No\n*Type*: [LookoutMetricsDestinationProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-lookoutmetrics", "UpdateType": "Mutable", "Required": false, "Type": "LookoutMetricsDestinationProperties" }, "EventBridge": { "MarkdownDocumentation": "`EventBridge`\n\nThe properties required to query Amazon EventBridge.\n*Required*: No\n*Type*: [EventBridgeDestinationProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-eventbridge", "UpdateType": "Mutable", "Required": false, "Type": "EventBridgeDestinationProperties" }, "Zendesk": { "MarkdownDocumentation": "`Zendesk`\n\nThe properties required to query Zendesk.\n*Required*: No\n*Type*: [ZendeskDestinationProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-zendesk", "UpdateType": "Mutable", "Required": false, "Type": "ZendeskDestinationProperties" }, "Marketo": { "MarkdownDocumentation": "`Marketo`\n\nThe properties required to query Marketo.\n*Required*: No\n*Type*: [MarketoDestinationProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-marketo", "UpdateType": "Mutable", "Required": false, "Type": "MarketoDestinationProperties" }, "Redshift": { "MarkdownDocumentation": "`Redshift`\n\nThe properties required to query Amazon Redshift.\n*Required*: No\n*Type*: [RedshiftDestinationProperties](./aws-properties-appflow-flow-redshiftdestinationproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-redshift", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftDestinationProperties" }, "Salesforce": { "MarkdownDocumentation": "`Salesforce`\n\nThe properties required to query Salesforce.\n*Required*: No\n*Type*: [SalesforceDestinationProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html#cfn-appflow-flow-destinationconnectorproperties-salesforce", "UpdateType": "Mutable", "Required": false, "Type": "SalesforceDestinationProperties" } } }, "AWS::AppFlow::Flow.DestinationFlowConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.DestinationFlowConfig`\n\nContains information about the configuration of destination connectors present in the\nflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationflowconfig.html", "Properties": { "ConnectorProfileName": { "MarkdownDocumentation": "`ConnectorProfileName`\n\nThe name of the connector profile. This name must be unique for each connector profile in\nthe AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w/!@#+=.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationflowconfig.html#cfn-appflow-flow-destinationflowconfig-connectorprofilename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiVersion": { "MarkdownDocumentation": "`ApiVersion`\n\nThe API version that the destination connector uses.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationflowconfig.html#cfn-appflow-flow-destinationflowconfig-apiversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectorType": { "MarkdownDocumentation": "`ConnectorType`\n\nThe type of destination connector, such as Sales force, Amazon S3, and so on.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SAPOData | Salesforce | Par...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SAPOData", "Salesforce", "Pardot", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "CustomConnector", "EventBridge", "Upsolver", "LookoutMetrics" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationflowconfig.html#cfn-appflow-flow-destinationflowconfig-connectortype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DestinationConnectorProperties": { "MarkdownDocumentation": "`DestinationConnectorProperties`\n\nThis stores the information that is required to query a particular connector.\n*Required*: Yes\n*Type*: [DestinationConnectorProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationflowconfig.html#cfn-appflow-flow-destinationflowconfig-destinationconnectorproperties", "UpdateType": "Mutable", "Required": true, "Type": "DestinationConnectorProperties" } } }, "AWS::AppFlow::Flow.DynatraceSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.DynatraceSourceProperties`\n\nThe properties that are applied when Dynatrace is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-dynatracesourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Dynatrace flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-dynatracesourceproperties.html#cfn-appflow-flow-dynatracesourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.ErrorHandlingConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.ErrorHandlingConfig`\n\nThe settings that determine how Amazon AppFlow handles an error when placing data in\nthe destination. For example, this setting would determine if the flow should fail after one\ninsertion error, or continue and attempt to insert every record regardless of the initial\nfailure. `ErrorHandlingConfig` is a part of the destination connector details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nSpecifies the name of the Amazon S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html#cfn-appflow-flow-errorhandlingconfig-bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nSpecifies the Amazon S3 bucket prefix.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html#cfn-appflow-flow-errorhandlingconfig-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FailOnFirstError": { "MarkdownDocumentation": "`FailOnFirstError`\n\nSpecifies if the flow should fail after the first instance of a failure when attempting\nto place data in the destination.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html#cfn-appflow-flow-errorhandlingconfig-failonfirsterror", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AppFlow::Flow.EventBridgeDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.EventBridgeDestinationProperties`\n\nThe properties that are applied when Amazon EventBridge is being used as a\ndestination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-eventbridgedestinationproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Amazon EventBridge flow destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-eventbridgedestinationproperties.html#cfn-appflow-flow-eventbridgedestinationproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ErrorHandlingConfig": { "MarkdownDocumentation": "`ErrorHandlingConfig`\n\nThe object specified in the Amplitude flow source.\n*Required*: No\n*Type*: [ErrorHandlingConfig](./aws-properties-appflow-flow-errorhandlingconfig.html)\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-eventbridgedestinationproperties.html#cfn-appflow-flow-eventbridgedestinationproperties-errorhandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ErrorHandlingConfig" } } }, "AWS::AppFlow::Flow.GlueDataCatalog": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.GlueDataCatalog`\n\nThe `GlueDataCatalog` property type specifies Property description not available. for an [AWS::AppFlow::Flow](./aws-resource-appflow-flow.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-gluedatacatalog.html", "Properties": { "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-gluedatacatalog.html#cfn-appflow-flow-gluedatacatalog-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-gluedatacatalog.html#cfn-appflow-flow-gluedatacatalog-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TablePrefix": { "MarkdownDocumentation": "`TablePrefix`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-gluedatacatalog.html#cfn-appflow-flow-gluedatacatalog-tableprefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.GoogleAnalyticsSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.GoogleAnalyticsSourceProperties`\n\nThe properties that are applied when Google Analytics is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-googleanalyticssourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Google Analytics flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-googleanalyticssourceproperties.html#cfn-appflow-flow-googleanalyticssourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.IncrementalPullConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.IncrementalPullConfig`\n\nSpecifies the configuration used when importing incremental records from the source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-incrementalpullconfig.html", "Properties": { "DatetimeTypeFieldName": { "MarkdownDocumentation": "`DatetimeTypeFieldName`\n\nA field that specifies the date time or timestamp field as the criteria to use when\nimporting incremental records from the source.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-incrementalpullconfig.html#cfn-appflow-flow-incrementalpullconfig-datetimetypefieldname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.InforNexusSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.InforNexusSourceProperties`\n\nThe properties that are applied when Infor Nexus is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-infornexussourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Infor Nexus flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-infornexussourceproperties.html#cfn-appflow-flow-infornexussourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.LookoutMetricsDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.LookoutMetricsDestinationProperties`\n\nThe properties that are applied when Amazon Lookout for Metrics is used as a destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-lookoutmetricsdestinationproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Amazon Lookout for Metrics flow destination.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-lookoutmetricsdestinationproperties.html#cfn-appflow-flow-lookoutmetricsdestinationproperties-object", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.MarketoDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.MarketoDestinationProperties`\n\nThe properties that Amazon AppFlow applies when you use Marketo as a flow\ndestination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-marketodestinationproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Marketo flow destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-marketodestinationproperties.html#cfn-appflow-flow-marketodestinationproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ErrorHandlingConfig": { "MarkdownDocumentation": "`ErrorHandlingConfig`\n\nThe settings that determine how Amazon AppFlow handles an error when placing data in\nthe destination. For example, this setting would determine if the flow should fail after one\ninsertion error, or continue and attempt to insert every record regardless of the initial\nfailure. `ErrorHandlingConfig` is a part of the destination connector details.\n*Required*: No\n*Type*: [ErrorHandlingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-marketodestinationproperties.html#cfn-appflow-flow-marketodestinationproperties-errorhandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ErrorHandlingConfig" } } }, "AWS::AppFlow::Flow.MarketoSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.MarketoSourceProperties`\n\nThe properties that are applied when Marketo is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-marketosourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Marketo flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-marketosourceproperties.html#cfn-appflow-flow-marketosourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.MetadataCatalogConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.MetadataCatalogConfig`\n\nSpecifies the configuration that Amazon AppFlow uses when it catalogs your data. When\nAmazon AppFlow catalogs your data, it stores metadata in a data catalog.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-metadatacatalogconfig.html", "Properties": { "GlueDataCatalog": { "MarkdownDocumentation": "`GlueDataCatalog`\n\nSpecifies the configuration that Amazon AppFlow uses when it catalogs your data with\nthe AWS Glue Data Catalog.\n*Required*: No\n*Type*: [GlueDataCatalog](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-metadatacatalogconfig.html#cfn-appflow-flow-metadatacatalogconfig-gluedatacatalog", "UpdateType": "Mutable", "Required": false, "Type": "GlueDataCatalog" } } }, "AWS::AppFlow::Flow.PardotSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.PardotSourceProperties`\n\nThe properties that are applied when Salesforce Pardot is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-pardotsourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Salesforce Pardot flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-pardotsourceproperties.html#cfn-appflow-flow-pardotsourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.PrefixConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.PrefixConfig`\n\nSpecifies elements that Amazon AppFlow includes in the file and folder names in the flow\ndestination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html", "Properties": { "PrefixType": { "MarkdownDocumentation": "`PrefixType`\n\nDetermines the format of the prefix, and whether it applies to the file name, file path,\nor both.\n*Required*: No\n*Type*: String\n*Allowed values*: `FILENAME | PATH | PATH_AND_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILENAME", "PATH", "PATH_AND_FILENAME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html#cfn-appflow-flow-prefixconfig-prefixtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PathPrefixHierarchy": { "MarkdownDocumentation": "`PathPrefixHierarchy`\n\nSpecifies whether the destination file path includes either or both of the following\nelements:\nEXECUTION\\_ID\nThe ID that Amazon AppFlow assigns to the flow run.\n\nSCHEMA\\_VERSION\nThe version number of your data schema. Amazon AppFlow assigns this version\nnumber. The version number increases by one when you change any of the following\nsettings in your flow configuration:\n* Source-to-destination field mappings\n* Field data types\n* Partition keys\n\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html#cfn-appflow-flow-prefixconfig-pathprefixhierarchy", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PrefixFormat": { "MarkdownDocumentation": "`PrefixFormat`\n\nDetermines the level of granularity for the date and time that's included in the prefix.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | MONTH | DAY | HOUR |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "MONTH", "DAY", "HOUR", "MINUTE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html#cfn-appflow-flow-prefixconfig-prefixformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.RedshiftDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.RedshiftDestinationProperties`\n\nThe properties that are applied when Amazon Redshift is being used as a destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-redshiftdestinationproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Amazon Redshift flow destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-redshiftdestinationproperties.html#cfn-appflow-flow-redshiftdestinationproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nThe object key for the bucket in which Amazon AppFlow places the destination files.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-redshiftdestinationproperties.html#cfn-appflow-flow-redshiftdestinationproperties-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntermediateBucketName": { "MarkdownDocumentation": "`IntermediateBucketName`\n\nThe intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-redshiftdestinationproperties.html#cfn-appflow-flow-redshiftdestinationproperties-intermediatebucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ErrorHandlingConfig": { "MarkdownDocumentation": "`ErrorHandlingConfig`\n\nThe settings that determine how Amazon AppFlow handles an error when placing data in\nthe Amazon Redshift destination. For example, this setting would determine if the flow\nshould fail after one insertion error, or continue and attempt to insert every record\nregardless of the initial failure. `ErrorHandlingConfig` is a part of the\ndestination connector details.\n*Required*: No\n*Type*: [ErrorHandlingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-redshiftdestinationproperties.html#cfn-appflow-flow-redshiftdestinationproperties-errorhandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ErrorHandlingConfig" } } }, "AWS::AppFlow::Flow.S3DestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.S3DestinationProperties`\n\nThe properties that are applied when Amazon S3 is used as a destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3destinationproperties.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe Amazon S3 bucket name in which Amazon AppFlow places the transferred\ndata.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3destinationproperties.html#cfn-appflow-flow-s3destinationproperties-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nThe object key for the destination bucket in which Amazon AppFlow places the files.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3destinationproperties.html#cfn-appflow-flow-s3destinationproperties-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3OutputFormatConfig": { "MarkdownDocumentation": "`S3OutputFormatConfig`\n\nThe configuration that determines how Amazon AppFlow should format the flow output\ndata when Amazon S3 is used as the destination.\n*Required*: No\n*Type*: [S3OutputFormatConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3destinationproperties.html#cfn-appflow-flow-s3destinationproperties-s3outputformatconfig", "UpdateType": "Mutable", "Required": false, "Type": "S3OutputFormatConfig" } } }, "AWS::AppFlow::Flow.S3InputFormatConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.S3InputFormatConfig`\n\nWhen you use Amazon S3 as the source, the configuration format that you provide\nthe flow input data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3inputformatconfig.html", "Properties": { "S3InputFileType": { "MarkdownDocumentation": "`S3InputFileType`\n\nThe 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)\n", "RefReturnValue": "", "AllowedValues": [ "CSV", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3inputformatconfig.html#cfn-appflow-flow-s3inputformatconfig-s3inputfiletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.S3OutputFormatConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.S3OutputFormatConfig`\n\nThe configuration that determines how Amazon AppFlow should format the flow output\ndata when Amazon S3 is used as the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3outputformatconfig.html", "Properties": { "PrefixConfig": { "MarkdownDocumentation": "`PrefixConfig`\n\nDetermines 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3outputformatconfig.html#cfn-appflow-flow-s3outputformatconfig-prefixconfig", "UpdateType": "Mutable", "Required": false, "Type": "PrefixConfig" }, "FileType": { "MarkdownDocumentation": "`FileType`\n\nIndicates 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)", "RefReturnValue": "", "AllowedValues": [ "CSV", "JSON", "PARQUET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3outputformatconfig.html#cfn-appflow-flow-s3outputformatconfig-filetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AggregationConfig": { "MarkdownDocumentation": "`AggregationConfig`\n\nThe aggregation settings that you can use to customize the output format of your flow\ndata.\n*Required*: No\n*Type*: [AggregationConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3outputformatconfig.html#cfn-appflow-flow-s3outputformatconfig-aggregationconfig", "UpdateType": "Mutable", "Required": false, "Type": "AggregationConfig" }, "PreserveSourceDataTyping": { "MarkdownDocumentation": "`PreserveSourceDataTyping`\n\nIf your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.\n* `true`: Amazon AppFlow preserves the data types when it writes to\n Amazon S3. For example, an integer or `1` in your source data is\n still an integer in your output.\n* `false`: Amazon AppFlow converts all of the source data into strings\n when it writes to Amazon S3. For example, an integer of `1` in your\n source data becomes the string `\"1\"` in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3outputformatconfig.html#cfn-appflow-flow-s3outputformatconfig-preservesourcedatatyping", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AppFlow::Flow.S3SourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.S3SourceProperties`\n\nThe properties that are applied when Amazon S3 is being used as the flow source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3sourceproperties.html", "Properties": { "S3InputFormatConfig": { "MarkdownDocumentation": "`S3InputFormatConfig`\n\nWhen you use Amazon S3 as the source, the configuration format that you provide\nthe flow input data.\n*Required*: No\n*Type*: [S3InputFormatConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3sourceproperties.html#cfn-appflow-flow-s3sourceproperties-s3inputformatconfig", "UpdateType": "Mutable", "Required": false, "Type": "S3InputFormatConfig" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe Amazon S3 bucket name where the source files are stored.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3sourceproperties.html#cfn-appflow-flow-s3sourceproperties-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nThe object key for the Amazon S3 bucket in which the source files are stored.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3sourceproperties.html#cfn-appflow-flow-s3sourceproperties-bucketprefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.SAPODataDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SAPODataDestinationProperties`\n\nThe properties that are applied when using SAPOData as a flow destination\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatadestinationproperties.html", "Properties": { "IdFieldNames": { "MarkdownDocumentation": "`IdFieldNames`\n\nA list of field names that can be used as an ID field when performing a write operation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatadestinationproperties.html#cfn-appflow-flow-sapodatadestinationproperties-idfieldnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ObjectPath": { "MarkdownDocumentation": "`ObjectPath`\n\nThe object path specified in the SAPOData flow destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatadestinationproperties.html#cfn-appflow-flow-sapodatadestinationproperties-objectpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "WriteOperationType": { "MarkdownDocumentation": "`WriteOperationType`\n\nThe possible write operations in the destination connector. When this value is not\nprovided, this defaults to the `INSERT` operation.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSERT | UPSERT | UPDATE | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSERT", "UPSERT", "UPDATE", "DELETE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatadestinationproperties.html#cfn-appflow-flow-sapodatadestinationproperties-writeoperationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ErrorHandlingConfig": { "MarkdownDocumentation": "`ErrorHandlingConfig`\n\nThe settings that determine how Amazon AppFlow handles an error when placing data in\nthe destination. For example, this setting would determine if the flow should fail after one\ninsertion error, or continue and attempt to insert every record regardless of the initial\nfailure. `ErrorHandlingConfig` is a part of the destination connector details.\n*Required*: No\n*Type*: [ErrorHandlingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatadestinationproperties.html#cfn-appflow-flow-sapodatadestinationproperties-errorhandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ErrorHandlingConfig" }, "SuccessResponseHandlingConfig": { "MarkdownDocumentation": "`SuccessResponseHandlingConfig`\n\nDetermines how Amazon AppFlow handles the success response that it gets from the\nconnector after placing data.\nFor example, this setting would determine where to write the response from a destination\nconnector upon a successful insert operation.\n*Required*: No\n*Type*: [SuccessResponseHandlingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatadestinationproperties.html#cfn-appflow-flow-sapodatadestinationproperties-successresponsehandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "SuccessResponseHandlingConfig" } } }, "AWS::AppFlow::Flow.SAPODataPaginationConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SAPODataPaginationConfig`\n\nSets the page size for each *concurrent process* that transfers OData\nrecords from your SAP instance. A concurrent process is query that retrieves a batch of\nrecords as part of a flow run. Amazon AppFlow can run multiple concurrent processes in\nparallel to transfer data faster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatapaginationconfig.html", "Properties": { "maxPageSize": { "MarkdownDocumentation": "`maxPageSize`\n\nThe maximum number of records that Amazon AppFlow receives in each page of the\nresponse from your SAP application. For transfers of OData records, the maximum page size is\n3,000. For transfers of data that comes from an ODP provider, the maximum page size\nis 10,000.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatapaginationconfig.html#cfn-appflow-flow-sapodatapaginationconfig-maxpagesize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::AppFlow::Flow.SAPODataParallelismConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SAPODataParallelismConfig`\n\nSets the number of *concurrent processes* that transfer OData records\nfrom your SAP instance. A concurrent process is query that retrieves a batch of records as\npart of a flow run. Amazon AppFlow can run multiple concurrent processes in parallel to\ntransfer data faster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodataparallelismconfig.html", "Properties": { "maxParallelism": { "MarkdownDocumentation": "`maxParallelism`\n\nThe maximum number of processes that Amazon AppFlow runs at the same time when it\nretrieves your data from your SAP application.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodataparallelismconfig.html#cfn-appflow-flow-sapodataparallelismconfig-maxparallelism", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::AppFlow::Flow.SAPODataSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SAPODataSourceProperties`\n\nThe properties that are applied when using SAPOData as a flow source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html", "Properties": { "ObjectPath": { "MarkdownDocumentation": "`ObjectPath`\n\nThe object path specified in the SAPOData flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html#cfn-appflow-flow-sapodatasourceproperties-objectpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "paginationConfig": { "MarkdownDocumentation": "`paginationConfig`\n\nSets the page size for each concurrent process that transfers OData records from your SAP\ninstance.\n*Required*: No\n*Type*: [SAPODataPaginationConfig](./aws-properties-appflow-flow-sapodatapaginationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html#cfn-appflow-flow-sapodatasourceproperties-paginationconfig", "UpdateType": "Mutable", "Required": false, "Type": "SAPODataPaginationConfig" }, "parallelismConfig": { "MarkdownDocumentation": "`parallelismConfig`\n\nSets the number of concurrent processes that transfers OData records from your SAP\ninstance.\n*Required*: No\n*Type*: [SAPODataParallelismConfig](./aws-properties-appflow-flow-sapodataparallelismconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html#cfn-appflow-flow-sapodatasourceproperties-parallelismconfig", "UpdateType": "Mutable", "Required": false, "Type": "SAPODataParallelismConfig" } } }, "AWS::AppFlow::Flow.SalesforceDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SalesforceDestinationProperties`\n\nThe properties that are applied when Salesforce is being used as a destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcedestinationproperties.html", "Properties": { "IdFieldNames": { "MarkdownDocumentation": "`IdFieldNames`\n\nThe name of the field that Amazon AppFlow uses as an ID when performing a write\noperation such as update or delete.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcedestinationproperties.html#cfn-appflow-flow-salesforcedestinationproperties-idfieldnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "WriteOperationType": { "MarkdownDocumentation": "`WriteOperationType`\n\nThis specifies the type of write operation to be performed in Salesforce. When the value\nis `UPSERT`, then `idFieldNames` is required.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSERT | UPSERT | UPDATE | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSERT", "UPSERT", "UPDATE", "DELETE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcedestinationproperties.html#cfn-appflow-flow-salesforcedestinationproperties-writeoperationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataTransferApi": { "MarkdownDocumentation": "`DataTransferApi`\n\nSpecifies which Salesforce API is used by Amazon AppFlow when your flow transfers\ndata to Salesforce.\nAUTOMATIC\nThe default. Amazon AppFlow selects which API to use based on the number of\nrecords that your flow transfers to Salesforce. If your flow transfers fewer than 1,000\nrecords, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000\nrecords or more, Amazon AppFlow uses Salesforce Bulk API 2.0.\nEach of these Salesforce APIs structures data differently. If Amazon AppFlow\nselects the API automatically, be aware that, for recurring flows, the data output might\nvary from one flow run to the next. For example, if a flow runs daily, it might use REST\nAPI on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to\ntransfer 1,100 records. For each of these flow runs, the respective Salesforce API\nformats the data differently. Some of the differences include how dates are formatted\nand null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound\nfields.\nBy choosing this option, you optimize flow performance for both small and large data\ntransfers, but the tradeoff is inconsistent formatting in the output.\n\nBULKV2\nAmazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous\ndata transfers, and it's optimal for large sets of data. By choosing this option, you\nensure that your flow writes consistent output, but you optimize performance only for\nlarge data transfers.\nNote that Bulk API 2.0 does not transfer Salesforce compound fields.\n\nREST\\_SYNC\nAmazon AppFlow uses only Salesforce REST API. By choosing this option, you\nensure that your flow writes consistent output, but you decrease performance for large\ndata transfers that are better suited for Bulk API 2.0. In some cases, if your flow\nattempts to transfer a vary large set of data, it might fail with a timed out\nerror.\n\n*Required*: No\n*Type*: [String](./aws-properties-appflow-flow-datatransferapi.html)\n*Allowed values*: `AUTOMATIC | BULKV2 | REST_S...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "BULKV2", "REST_SYNC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcedestinationproperties.html#cfn-appflow-flow-salesforcedestinationproperties-datatransferapi", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Salesforce flow destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcedestinationproperties.html#cfn-appflow-flow-salesforcedestinationproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ErrorHandlingConfig": { "MarkdownDocumentation": "`ErrorHandlingConfig`\n\nThe settings that determine how Amazon AppFlow handles an error when placing data in\nthe Salesforce destination. For example, this setting would determine if the flow should fail\nafter one insertion error, or continue and attempt to insert every record regardless of the\ninitial failure. `ErrorHandlingConfig` is a part of the destination connector\ndetails.\n*Required*: No\n*Type*: [ErrorHandlingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcedestinationproperties.html#cfn-appflow-flow-salesforcedestinationproperties-errorhandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ErrorHandlingConfig" } } }, "AWS::AppFlow::Flow.SalesforceSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SalesforceSourceProperties`\n\nThe properties that are applied when Salesforce is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcesourceproperties.html", "Properties": { "IncludeDeletedRecords": { "MarkdownDocumentation": "`IncludeDeletedRecords`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcesourceproperties.html#cfn-appflow-flow-salesforcesourceproperties-includedeletedrecords", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DataTransferApi": { "MarkdownDocumentation": "`DataTransferApi`\n\nSpecifies which Salesforce API is used by Amazon AppFlow when your flow transfers\ndata from Salesforce.\nAUTOMATIC\nThe default. Amazon AppFlow selects which API to use based on the number of\nrecords that your flow transfers from Salesforce. If your flow transfers fewer than\n1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers\n1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.\nEach of these Salesforce APIs structures data differently. If Amazon AppFlow\nselects the API automatically, be aware that, for recurring flows, the data output might\nvary from one flow run to the next. For example, if a flow runs daily, it might use REST\nAPI on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next\nday to transfer 1,100,000 records. For each of these flow runs, the respective\nSalesforce API formats the data differently. Some of the differences include how dates\nare formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer\nSalesforce compound fields.\nBy choosing this option, you optimize flow performance for both small and large data\ntransfers, but the tradeoff is inconsistent formatting in the output.\n\nBULKV2\nAmazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous\ndata transfers, and it's optimal for large sets of data. By choosing this option, you\nensure that your flow writes consistent output, but you optimize performance only for\nlarge data transfers.\nNote that Bulk API 2.0 does not transfer Salesforce compound fields.\n\nREST\\_SYNC\nAmazon AppFlow uses only Salesforce REST API. By choosing this option, you\nensure that your flow writes consistent output, but you decrease performance for large\ndata transfers that are better suited for Bulk API 2.0. In some cases, if your flow\nattempts to transfer a vary large set of data, it might fail wituh a timed out\nerror.\n\n*Required*: No\n*Type*: [String](./aws-properties-appflow-flow-datatransferapi.html)\n*Allowed values*: `AUTOMATIC | BULKV2 | REST_S...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "BULKV2", "REST_SYNC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcesourceproperties.html#cfn-appflow-flow-salesforcesourceproperties-datatransferapi", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Salesforce flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcesourceproperties.html#cfn-appflow-flow-salesforcesourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnableDynamicFieldUpdate": { "MarkdownDocumentation": "`EnableDynamicFieldUpdate`\n\nThe flag that enables dynamic fetching of new (recently added) fields in the Salesforce\nobjects 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcesourceproperties.html#cfn-appflow-flow-salesforcesourceproperties-enabledynamicfieldupdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AppFlow::Flow.ScheduledTriggerProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.ScheduledTriggerProperties`\n\nSpecifies the configuration details of a schedule-triggered flow as defined by the user.\nCurrently, these settings only apply to the `Scheduled` trigger type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html", "Properties": { "ScheduleEndTime": { "MarkdownDocumentation": "`ScheduleEndTime`\n\nThe time at which the scheduled flow ends. The time is formatted as a timestamp that\nfollows the ISO 8601 standard, such as `2022-04-27T13:00:00-07:00`.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-scheduleendtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nThe scheduling expression that determines the rate at which the schedule will run, for\nexample `rate(5minutes)`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-scheduleexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FirstExecutionFrom": { "MarkdownDocumentation": "`FirstExecutionFrom`\n\nSpecifies the date range for the records to import from the connector in the first flow\nrun.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-firstexecutionfrom", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "TimeZone": { "MarkdownDocumentation": "`TimeZone`\n\nSpecifies the time zone used when referring to the dates and times of a scheduled flow,\nsuch as `America/New_York`. This time zone is only a descriptive label. It doesn't\naffect how Amazon AppFlow interprets the timestamps that you specify to schedule the\nflow.\nIf you want to schedule a flow by using times in a particular time zone, indicate the time\nzone as a UTC offset in your timestamps. For example, the UTC offsets for the\n`America/New_York` timezone are `-04:00` EDT and `-05:00\nEST`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-timezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScheduleStartTime": { "MarkdownDocumentation": "`ScheduleStartTime`\n\nThe time at which the scheduled flow starts. The time is formatted as a timestamp that\nfollows the ISO 8601 standard, such as `2022-04-26T13:00:00-07:00`.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-schedulestarttime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "DataPullMode": { "MarkdownDocumentation": "`DataPullMode`\n\nSpecifies whether a scheduled flow has an incremental data transfer or a complete data\ntransfer for each flow run.\n*Required*: No\n*Type*: String\n*Allowed values*: `Incremental | Complete...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Incremental", "Complete" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-datapullmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScheduleOffset": { "MarkdownDocumentation": "`ScheduleOffset`\n\nSpecifies the optional offset that is added to the time interval for a schedule-triggered\nflow.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `36000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-scheduleoffset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FlowErrorDeactivationThreshold": { "MarkdownDocumentation": "`FlowErrorDeactivationThreshold`\n\nDefines how many times a scheduled flow fails consecutively before Amazon AppFlow\ndeactivates it.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-flowerrordeactivationthreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AppFlow::Flow.ServiceNowSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.ServiceNowSourceProperties`\n\nThe properties that are applied when ServiceNow is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-servicenowsourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the ServiceNow flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-servicenowsourceproperties.html#cfn-appflow-flow-servicenowsourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.SingularSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SingularSourceProperties`\n\nThe properties that are applied when Singular is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-singularsourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Singular flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-singularsourceproperties.html#cfn-appflow-flow-singularsourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.SlackSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SlackSourceProperties`\n\nThe properties that are applied when Slack is being used as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-slacksourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Slack flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-slacksourceproperties.html#cfn-appflow-flow-slacksourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.SnowflakeDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SnowflakeDestinationProperties`\n\nThe properties that are applied when Snowflake is being used as a destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-snowflakedestinationproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Snowflake flow destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-snowflakedestinationproperties.html#cfn-appflow-flow-snowflakedestinationproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nThe object key for the destination bucket in which Amazon AppFlow places the files.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-snowflakedestinationproperties.html#cfn-appflow-flow-snowflakedestinationproperties-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntermediateBucketName": { "MarkdownDocumentation": "`IntermediateBucketName`\n\nThe intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-snowflakedestinationproperties.html#cfn-appflow-flow-snowflakedestinationproperties-intermediatebucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ErrorHandlingConfig": { "MarkdownDocumentation": "`ErrorHandlingConfig`\n\nThe settings that determine how Amazon AppFlow handles an error when placing data in\nthe Snowflake destination. For example, this setting would determine if the flow should fail\nafter one insertion error, or continue and attempt to insert every record regardless of the\ninitial failure. `ErrorHandlingConfig` is a part of the destination connector\ndetails.\n*Required*: No\n*Type*: [ErrorHandlingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-snowflakedestinationproperties.html#cfn-appflow-flow-snowflakedestinationproperties-errorhandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ErrorHandlingConfig" } } }, "AWS::AppFlow::Flow.SourceConnectorProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SourceConnectorProperties`\n\nSpecifies the information that is required to query a particular connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html", "Properties": { "Amplitude": { "MarkdownDocumentation": "`Amplitude`\n\nSpecifies the information that is required for querying Amplitude.\n*Required*: No\n*Type*: [AmplitudeSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-amplitude", "UpdateType": "Mutable", "Required": false, "Type": "AmplitudeSourceProperties" }, "S3": { "MarkdownDocumentation": "`S3`\n\nSpecifies the information that is required for querying Amazon S3.\n*Required*: No\n*Type*: [S3SourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3SourceProperties" }, "GoogleAnalytics": { "MarkdownDocumentation": "`GoogleAnalytics`\n\nSpecifies the information that is required for querying Google Analytics.\n*Required*: No\n*Type*: [GoogleAnalyticsSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-googleanalytics", "UpdateType": "Mutable", "Required": false, "Type": "GoogleAnalyticsSourceProperties" }, "ServiceNow": { "MarkdownDocumentation": "`ServiceNow`\n\nSpecifies the information that is required for querying ServiceNow.\n*Required*: No\n*Type*: [ServiceNowSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-servicenow", "UpdateType": "Mutable", "Required": false, "Type": "ServiceNowSourceProperties" }, "CustomConnector": { "MarkdownDocumentation": "`CustomConnector`\n\nThe properties that are applied when the custom connector is being used as a\nsource.\n*Required*: No\n*Type*: [CustomConnectorSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-customconnector", "UpdateType": "Mutable", "Required": false, "Type": "CustomConnectorSourceProperties" }, "SAPOData": { "MarkdownDocumentation": "`SAPOData`\n\nThe properties that are applied when using SAPOData as a flow source.\n*Required*: No\n*Type*: [SAPODataSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-sapodata", "UpdateType": "Mutable", "Required": false, "Type": "SAPODataSourceProperties" }, "Pardot": { "MarkdownDocumentation": "`Pardot`\n\nSpecifies the information that is required for querying Salesforce Pardot.\n*Required*: No\n*Type*: [PardotSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-pardot", "UpdateType": "Mutable", "Required": false, "Type": "PardotSourceProperties" }, "Veeva": { "MarkdownDocumentation": "`Veeva`\n\nSpecifies the information that is required for querying Veeva.\n*Required*: No\n*Type*: [VeevaSourceProperties](./aws-properties-appflow-flow-veevasourceproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-veeva", "UpdateType": "Mutable", "Required": false, "Type": "VeevaSourceProperties" }, "Trendmicro": { "MarkdownDocumentation": "`Trendmicro`\n\nSpecifies the information that is required for querying Trend Micro.\n*Required*: No\n*Type*: [TrendmicroSourceProperties](./aws-properties-appflow-flow-trendmicrosourceproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-trendmicro", "UpdateType": "Mutable", "Required": false, "Type": "TrendmicroSourceProperties" }, "Datadog": { "MarkdownDocumentation": "`Datadog`\n\nSpecifies the information that is required for querying Datadog.\n*Required*: No\n*Type*: [DatadogSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-datadog", "UpdateType": "Mutable", "Required": false, "Type": "DatadogSourceProperties" }, "Marketo": { "MarkdownDocumentation": "`Marketo`\n\nSpecifies the information that is required for querying Marketo.\n*Required*: No\n*Type*: [MarketoSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-marketo", "UpdateType": "Mutable", "Required": false, "Type": "MarketoSourceProperties" }, "Singular": { "MarkdownDocumentation": "`Singular`\n\nSpecifies the information that is required for querying Singular.\n*Required*: No\n*Type*: [SingularSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-singular", "UpdateType": "Mutable", "Required": false, "Type": "SingularSourceProperties" }, "Slack": { "MarkdownDocumentation": "`Slack`\n\nSpecifies the information that is required for querying Slack.\n*Required*: No\n*Type*: [SlackSourceProperties](./aws-properties-appflow-flow-slacksourceproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-slack", "UpdateType": "Mutable", "Required": false, "Type": "SlackSourceProperties" }, "Dynatrace": { "MarkdownDocumentation": "`Dynatrace`\n\nSpecifies the information that is required for querying Dynatrace.\n*Required*: No\n*Type*: [DynatraceSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-dynatrace", "UpdateType": "Mutable", "Required": false, "Type": "DynatraceSourceProperties" }, "Zendesk": { "MarkdownDocumentation": "`Zendesk`\n\nSpecifies the information that is required for querying Zendesk.\n*Required*: No\n*Type*: [ZendeskSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-zendesk", "UpdateType": "Mutable", "Required": false, "Type": "ZendeskSourceProperties" }, "InforNexus": { "MarkdownDocumentation": "`InforNexus`\n\nSpecifies the information that is required for querying Infor Nexus.\n*Required*: No\n*Type*: [InforNexusSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-infornexus", "UpdateType": "Mutable", "Required": false, "Type": "InforNexusSourceProperties" }, "Salesforce": { "MarkdownDocumentation": "`Salesforce`\n\nSpecifies the information that is required for querying Salesforce.\n*Required*: No\n*Type*: [SalesforceSourceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceconnectorproperties.html#cfn-appflow-flow-sourceconnectorproperties-salesforce", "UpdateType": "Mutable", "Required": false, "Type": "SalesforceSourceProperties" } } }, "AWS::AppFlow::Flow.SourceFlowConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SourceFlowConfig`\n\nContains information about the configuration of the source connector used in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html", "Properties": { "ConnectorProfileName": { "MarkdownDocumentation": "`ConnectorProfileName`\n\nThe name of the connector profile. This name must be unique for each connector profile in\nthe AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w/!@#+=.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-connectorprofilename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiVersion": { "MarkdownDocumentation": "`ApiVersion`\n\nThe API version of the connector when it's used as a source in the flow.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-apiversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceConnectorProperties": { "MarkdownDocumentation": "`SourceConnectorProperties`\n\nSpecifies the information that is required to query a particular source connector.\n*Required*: Yes\n*Type*: [SourceConnectorProperties](./aws-properties-appflow-flow-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-sourceconnectorproperties", "UpdateType": "Mutable", "Required": true, "Type": "SourceConnectorProperties" }, "ConnectorType": { "MarkdownDocumentation": "`ConnectorType`\n\nThe type of connector, such as Salesforce, Amplitude, and so on.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SAPOData | Salesforce | Par...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SAPOData", "Salesforce", "Pardot", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "CustomConnector", "EventBridge", "Upsolver", "LookoutMetrics" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-connectortype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IncrementalPullConfig": { "MarkdownDocumentation": "`IncrementalPullConfig`\n\nDefines the configuration for a scheduled incremental data pull. If a valid configuration\nis provided, the fields specified in the configuration are used when querying for the\nincremental data pull.\n*Required*: No\n*Type*: [IncrementalPullConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html#cfn-appflow-flow-sourceflowconfig-incrementalpullconfig", "UpdateType": "Mutable", "Required": false, "Type": "IncrementalPullConfig" } } }, "AWS::AppFlow::Flow.SuccessResponseHandlingConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.SuccessResponseHandlingConfig`\n\nDetermines how Amazon AppFlow handles the success response that it gets from the\nconnector after placing data.\nFor example, this setting would determine where to write the response from the destination\nconnector upon a successful insert operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-successresponsehandlingconfig.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the Amazon S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-successresponsehandlingconfig.html#cfn-appflow-flow-successresponsehandlingconfig-bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nThe Amazon S3 bucket prefix.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-successresponsehandlingconfig.html#cfn-appflow-flow-successresponsehandlingconfig-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.Task": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.Task`\n\nA class for modeling different type of tasks. Task implementation varies based on the\n`TaskType`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-task.html", "Properties": { "SourceFields": { "MarkdownDocumentation": "`SourceFields`\n\nThe source fields to which a particular task is applied.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-task.html#cfn-appflow-flow-task-sourcefields", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DestinationField": { "MarkdownDocumentation": "`DestinationField`\n\nA field in a destination connector, or a field value against which Amazon AppFlow\nvalidates a source field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-task.html#cfn-appflow-flow-task-destinationfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectorOperator": { "MarkdownDocumentation": "`ConnectorOperator`\n\nThe operation to be performed on the provided source fields.\n*Required*: No\n*Type*: [ConnectorOperator](./aws-properties-appflow-flow-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-task.html#cfn-appflow-flow-task-connectoroperator", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorOperator" }, "TaskType": { "MarkdownDocumentation": "`TaskType`\n\nSpecifies the particular task implementation that Amazon AppFlow performs.\n*Allowed values*: `Arithmetic` | `Filter` | ...`\n`Map` | `Map_all` | `Mask` | `Merge` |\n`Truncate` | `Validate`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Arithmetic | Filter | Map | Map_all | Mask | Merge | Passthrough | Truncate | Validate | Partition`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Arithmetic`", "`Filter` ", "" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-task.html#cfn-appflow-flow-task-tasktype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TaskProperties": { "MarkdownDocumentation": "`TaskProperties`\n\nA map used to store task-related information. The execution service looks for particular\ninformation based on the `TaskType`.\n*Required*: No\n*Type*: Array of [TaskPropertiesObject](./aws-properties-appflow-flow-taskpropertiesobject.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-task.html#cfn-appflow-flow-task-taskproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TaskPropertiesObject", "DuplicatesAllowed": true } } }, "AWS::AppFlow::Flow.TaskPropertiesObject": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.TaskPropertiesObject`\n\nA map used to store task-related information. The execution service looks for particular\ninformation based on the `TaskType`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-taskpropertiesobject.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe task property value.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-taskpropertiesobject.html#cfn-appflow-flow-taskpropertiesobject-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe task property key.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VALUE | VALUES | DATA_TYPE ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VALUE", "VALUES", "DATA_TYPE", "UPPER_BOUND", "LOWER_BOUND", "SOURCE_DATA_TYPE", "DESTINATION_DATA_TYPE", "VALIDATION_ACTION", "MASK_VALUE", "MASK_LENGTH", "TRUNCATE_LENGTH", "MATH_OPERATION_FIELDS_ORDER", "CONCAT_FORMAT", "SUBFIELD_CATEGORY_MAP", "EXCLUDE_SOURCE_FIELDS_LIST", "INCLUDE_NEW_FIELDS", "ORDERED_PARTITION_KEYS_LIST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-taskpropertiesobject.html#cfn-appflow-flow-taskpropertiesobject-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.TrendmicroSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.TrendmicroSourceProperties`\n\nThe properties that are applied when using Trend Micro as a flow source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-trendmicrosourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Trend Micro flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-trendmicrosourceproperties.html#cfn-appflow-flow-trendmicrosourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppFlow::Flow.TriggerConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.TriggerConfig`\n\nThe trigger settings that determine how and when Amazon AppFlow runs the specified\nflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-triggerconfig.html", "Properties": { "TriggerType": { "MarkdownDocumentation": "`TriggerType`\n\nSpecifies the type of flow trigger. This can be `OnDemand`,\n`Scheduled`, or `Event`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Scheduled | Event | OnDeman...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Scheduled", "Event", "OnDemand" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-triggerconfig.html#cfn-appflow-flow-triggerconfig-triggertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TriggerProperties": { "MarkdownDocumentation": "`TriggerProperties`\n\nSpecifies the configuration details of a schedule-triggered flow as defined by the user.\nCurrently, these settings only apply to the `Scheduled` trigger type.\n*Required*: No\n*Type*: [ScheduledTriggerProperties](./aws-properties-appflow-flow-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-triggerconfig.html#cfn-appflow-flow-triggerconfig-triggerproperties", "UpdateType": "Mutable", "Required": false, "Type": "ScheduledTriggerProperties" } } }, "AWS::AppFlow::Flow.UpsolverDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.UpsolverDestinationProperties`\n\nThe properties that are applied when Upsolver is used as a destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolverdestinationproperties.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe Upsolver Amazon S3 bucket name in which Amazon AppFlow places the\ntransferred data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(upsolver-appflow)\\S*`\n*Minimum*: `16`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolverdestinationproperties.html#cfn-appflow-flow-upsolverdestinationproperties-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nThe object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolverdestinationproperties.html#cfn-appflow-flow-upsolverdestinationproperties-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3OutputFormatConfig": { "MarkdownDocumentation": "`S3OutputFormatConfig`\n\nThe configuration that determines how data is formatted when Upsolver is used as the flow\ndestination.\n*Required*: Yes\n*Type*: [UpsolverS3OutputFormatConfig](./aws-properties-appflow-flow-upsolvers3outputformatconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolverdestinationproperties.html#cfn-appflow-flow-upsolverdestinationproperties-s3outputformatconfig", "UpdateType": "Mutable", "Required": true, "Type": "UpsolverS3OutputFormatConfig" } } }, "AWS::AppFlow::Flow.UpsolverS3OutputFormatConfig": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.UpsolverS3OutputFormatConfig`\n\nThe configuration that determines how Amazon AppFlow formats the flow output data\nwhen Upsolver is used as the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolvers3outputformatconfig.html", "Properties": { "PrefixConfig": { "MarkdownDocumentation": "`PrefixConfig`\n\nSpecifies elements that Amazon AppFlow includes in the file and folder names in the flow\ndestination.\n*Required*: Yes\n*Type*: [PrefixConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolvers3outputformatconfig.html#cfn-appflow-flow-upsolvers3outputformatconfig-prefixconfig", "UpdateType": "Mutable", "Required": true, "Type": "PrefixConfig" }, "FileType": { "MarkdownDocumentation": "`FileType`\n\nIndicates the file type that Amazon AppFlow places in the Upsolver Amazon S3\nbucket.\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)", "RefReturnValue": "", "AllowedValues": [ "CSV", "JSON", "PARQUET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolvers3outputformatconfig.html#cfn-appflow-flow-upsolvers3outputformatconfig-filetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AggregationConfig": { "MarkdownDocumentation": "`AggregationConfig`\n\nThe aggregation settings that you can use to customize the output format of your flow\ndata.\n*Required*: No\n*Type*: [AggregationConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolvers3outputformatconfig.html#cfn-appflow-flow-upsolvers3outputformatconfig-aggregationconfig", "UpdateType": "Mutable", "Required": false, "Type": "AggregationConfig" } } }, "AWS::AppFlow::Flow.VeevaSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.VeevaSourceProperties`\n\nThe properties that are applied when using Veeva as a flow source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-veevasourceproperties.html", "Properties": { "IncludeAllVersions": { "MarkdownDocumentation": "`IncludeAllVersions`\n\nBoolean 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-veevasourceproperties.html#cfn-appflow-flow-veevasourceproperties-includeallversions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IncludeRenditions": { "MarkdownDocumentation": "`IncludeRenditions`\n\nBoolean 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-veevasourceproperties.html#cfn-appflow-flow-veevasourceproperties-includerenditions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DocumentType": { "MarkdownDocumentation": "`DocumentType`\n\nThe document type specified in the Veeva document extract flow.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\w_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-veevasourceproperties.html#cfn-appflow-flow-veevasourceproperties-documenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Veeva flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-veevasourceproperties.html#cfn-appflow-flow-veevasourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IncludeSourceFiles": { "MarkdownDocumentation": "`IncludeSourceFiles`\n\nBoolean 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-veevasourceproperties.html#cfn-appflow-flow-veevasourceproperties-includesourcefiles", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AppFlow::Flow.ZendeskDestinationProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.ZendeskDestinationProperties`\n\nThe properties that are applied when Zendesk is used as a destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html", "Properties": { "IdFieldNames": { "MarkdownDocumentation": "`IdFieldNames`\n\nA list of field names that can be used as an ID field when performing a write operation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html#cfn-appflow-flow-zendeskdestinationproperties-idfieldnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "WriteOperationType": { "MarkdownDocumentation": "`WriteOperationType`\n\nThe possible write operations in the destination connector. When this value is not\nprovided, this defaults to the `INSERT` operation.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSERT | UPSERT | UPDATE | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSERT", "UPSERT", "UPDATE", "DELETE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html#cfn-appflow-flow-zendeskdestinationproperties-writeoperationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Zendesk flow destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html#cfn-appflow-flow-zendeskdestinationproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ErrorHandlingConfig": { "MarkdownDocumentation": "`ErrorHandlingConfig`\n\nThe settings that determine how Amazon AppFlow handles an error when placing data in\nthe destination. For example, this setting would determine if the flow should fail after one\ninsertion error, or continue and attempt to insert every record regardless of the initial\nfailure. `ErrorHandlingConfig` is a part of the destination connector details.\n*Required*: No\n*Type*: [ErrorHandlingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html#cfn-appflow-flow-zendeskdestinationproperties-errorhandlingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ErrorHandlingConfig" } } }, "AWS::AppFlow::Flow.ZendeskSourceProperties": { "MarkdownDocumentation": "`AWS::AppFlow::Flow.ZendeskSourceProperties`\n\nThe properties that are applied when using Zendesk as a flow source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendesksourceproperties.html", "Properties": { "Object": { "MarkdownDocumentation": "`Object`\n\nThe object specified in the Zendesk flow source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendesksourceproperties.html#cfn-appflow-flow-zendesksourceproperties-object", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppMesh::GatewayRoute.GatewayRouteHostnameMatch": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GatewayRouteHostnameMatch`\n\nAn object representing the gateway route host name to match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html", "Properties": { "Suffix": { "Required": false, "MarkdownDocumentation": "`Suffix`\n\nThe specified ending characters of the host name to match on.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html#cfn-appmesh-gatewayroute-gatewayroutehostnamematch-suffix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe exact host name to match on.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html#cfn-appmesh-gatewayroute-gatewayroutehostnamematch-exact", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GatewayRouteHostnameRewrite": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GatewayRouteHostnameRewrite`\n\nAn object representing the gateway route host name to rewrite.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html", "Properties": { "DefaultTargetHostname": { "Required": false, "MarkdownDocumentation": "`DefaultTargetHostname`\n\nThe default target host name to write to.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html#cfn-appmesh-gatewayroute-gatewayroutehostnamerewrite-defaulttargethostname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GatewayRouteMetadataMatch": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GatewayRouteMetadataMatch`\n\nAn object representing the method header to be matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html", "Properties": { "Suffix": { "Required": false, "MarkdownDocumentation": "`Suffix`\n\nThe specified ending characters of the method header to match on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-suffix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Regex": { "Required": false, "MarkdownDocumentation": "`Regex`\n\nThe regex used to match the method header.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-regex", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe exact method header to be matched on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-exact", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Prefix": { "Required": false, "MarkdownDocumentation": "`Prefix`\n\nThe specified beginning characters of the method header to be matched on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-prefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Range": { "Type": "GatewayRouteRangeMatch", "Required": false, "MarkdownDocumentation": "`Range`\n\nAn object that represents the range of values to match on.\n*Required*: No\n*Type*: [GatewayRouteRangeMatch](./aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-range", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GatewayRouteRangeMatch": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GatewayRouteRangeMatch`\n\nAn object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html", "Properties": { "Start": { "Required": true, "MarkdownDocumentation": "`Start`\n\nThe start of the range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html#cfn-appmesh-gatewayroute-gatewayrouterangematch-start", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "End": { "Required": true, "MarkdownDocumentation": "`End`\n\nThe end of the range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html#cfn-appmesh-gatewayroute-gatewayrouterangematch-end", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GatewayRouteSpec": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GatewayRouteSpec`\n\nAn object that represents a gateway route specification. Specify one gateway route\ntype.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html", "Properties": { "HttpRoute": { "Type": "HttpGatewayRoute", "Required": false, "MarkdownDocumentation": "`HttpRoute`\n\nAn object that represents the specification of an HTTP gateway route.\n*Required*: No\n*Type*: [HttpGatewayRoute](./aws-properties-appmesh-gatewayroute-httpgatewayroute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-httproute", "UpdateType": "Mutable" }, "Priority": { "Required": false, "MarkdownDocumentation": "`Priority`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-priority", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Http2Route": { "Type": "HttpGatewayRoute", "Required": false, "MarkdownDocumentation": "`Http2Route`\n\nAn object that represents the specification of an HTTP/2 gateway route.\n*Required*: No\n*Type*: [HttpGatewayRoute](./aws-properties-appmesh-gatewayroute-httpgatewayroute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-http2route", "UpdateType": "Mutable" }, "GrpcRoute": { "Type": "GrpcGatewayRoute", "Required": false, "MarkdownDocumentation": "`GrpcRoute`\n\nAn object that represents the specification of a gRPC gateway route.\n*Required*: No\n*Type*: [GrpcGatewayRoute](./aws-properties-appmesh-gatewayroute-grpcgatewayroute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-grpcroute", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GatewayRouteTarget": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GatewayRouteTarget`\n\nAn object that represents a gateway route target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html", "Properties": { "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html#cfn-appmesh-gatewayroute-gatewayroutetarget-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "VirtualService": { "Type": "GatewayRouteVirtualService", "Required": true, "MarkdownDocumentation": "`VirtualService`\n\nAn object that represents a virtual service gateway route target.\n*Required*: Yes\n*Type*: [GatewayRouteVirtualService](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html#cfn-appmesh-gatewayroute-gatewayroutetarget-virtualservice", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GatewayRouteVirtualService": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GatewayRouteVirtualService`\n\nAn object that represents the virtual service that traffic is routed to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.html", "Properties": { "VirtualServiceName": { "Required": true, "MarkdownDocumentation": "`VirtualServiceName`\n\nThe name of the virtual service that traffic is routed to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.html#cfn-appmesh-gatewayroute-gatewayroutevirtualservice-virtualservicename", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GrpcGatewayRoute": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GrpcGatewayRoute`\n\nAn object that represents a gRPC gateway route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html", "Properties": { "Action": { "Type": "GrpcGatewayRouteAction", "Required": true, "MarkdownDocumentation": "`Action`\n\nAn object that represents the action to take if a match is determined.\n*Required*: Yes\n*Type*: [GrpcGatewayRouteAction](./aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html#cfn-appmesh-gatewayroute-grpcgatewayroute-action", "UpdateType": "Mutable" }, "Match": { "Type": "GrpcGatewayRouteMatch", "Required": true, "MarkdownDocumentation": "`Match`\n\nAn object that represents the criteria for determining a request match.\n*Required*: Yes\n*Type*: [GrpcGatewayRouteMatch](./aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html#cfn-appmesh-gatewayroute-grpcgatewayroute-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GrpcGatewayRouteAction": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GrpcGatewayRouteAction`\n\nAn object that represents the action to take if a match is determined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html", "Properties": { "Target": { "Type": "GatewayRouteTarget", "Required": true, "MarkdownDocumentation": "`Target`\n\nAn object that represents the target that traffic is routed to when a request matches the gateway route.\n*Required*: Yes\n*Type*: [GatewayRouteTarget](./aws-properties-appmesh-gatewayroute-gatewayroutetarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html#cfn-appmesh-gatewayroute-grpcgatewayrouteaction-target", "UpdateType": "Mutable" }, "Rewrite": { "Type": "GrpcGatewayRouteRewrite", "Required": false, "MarkdownDocumentation": "`Rewrite`\n\nThe gateway route action to rewrite.\n*Required*: No\n*Type*: [GrpcGatewayRouteRewrite](./aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html#cfn-appmesh-gatewayroute-grpcgatewayrouteaction-rewrite", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GrpcGatewayRouteMatch": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GrpcGatewayRouteMatch`\n\nAn object that represents the criteria for determining a request match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html", "Properties": { "ServiceName": { "Required": false, "MarkdownDocumentation": "`ServiceName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-servicename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Hostname": { "Type": "GatewayRouteHostnameMatch", "Required": false, "MarkdownDocumentation": "`Hostname`\n\nThe gateway route host name to be matched on.\n*Required*: No\n*Type*: [GatewayRouteHostnameMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-hostname", "UpdateType": "Mutable" }, "Metadata": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Metadata`\n\nThe gateway route metadata to be matched on.\n*Required*: No\n*Type*: Array of [GrpcGatewayRouteMetadata](./aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-metadata", "ItemType": "GrpcGatewayRouteMetadata", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GrpcGatewayRouteMetadata": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GrpcGatewayRouteMetadata`\n\nAn object representing the metadata of the gateway route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html", "Properties": { "Invert": { "Required": false, "MarkdownDocumentation": "`Invert`\n\nSpecify `True` to match anything except the match criteria. The default value\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-invert", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA name for the gateway route metadata.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Match": { "Type": "GatewayRouteMetadataMatch", "Required": false, "MarkdownDocumentation": "`Match`\n\nThe criteria for determining a metadata match.\n*Required*: No\n*Type*: [GatewayRouteMetadataMatch](./aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.GrpcGatewayRouteRewrite": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.GrpcGatewayRouteRewrite`\n\nAn object that represents the gateway route to rewrite.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.html", "Properties": { "Hostname": { "Type": "GatewayRouteHostnameRewrite", "Required": false, "MarkdownDocumentation": "`Hostname`\n\nThe host name of the gateway route to rewrite.\n*Required*: No\n*Type*: [GatewayRouteHostnameRewrite](./aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.html#cfn-appmesh-gatewayroute-grpcgatewayrouterewrite-hostname", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpGatewayRoute": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpGatewayRoute`\n\nAn object that represents an HTTP gateway route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html", "Properties": { "Action": { "Type": "HttpGatewayRouteAction", "Required": true, "MarkdownDocumentation": "`Action`\n\nAn object that represents the action to take if a match is determined.\n*Required*: Yes\n*Type*: [HttpGatewayRouteAction](./aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html#cfn-appmesh-gatewayroute-httpgatewayroute-action", "UpdateType": "Mutable" }, "Match": { "Type": "HttpGatewayRouteMatch", "Required": true, "MarkdownDocumentation": "`Match`\n\nAn object that represents the criteria for determining a request match.\n*Required*: Yes\n*Type*: [HttpGatewayRouteMatch](./aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html#cfn-appmesh-gatewayroute-httpgatewayroute-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpGatewayRouteAction": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpGatewayRouteAction`\n\nAn object that represents the action to take if a match is determined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html", "Properties": { "Target": { "Type": "GatewayRouteTarget", "Required": true, "MarkdownDocumentation": "`Target`\n\nAn object that represents the target that traffic is routed to when a request matches the gateway route.\n*Required*: Yes\n*Type*: [GatewayRouteTarget](./aws-properties-appmesh-gatewayroute-gatewayroutetarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html#cfn-appmesh-gatewayroute-httpgatewayrouteaction-target", "UpdateType": "Mutable" }, "Rewrite": { "Type": "HttpGatewayRouteRewrite", "Required": false, "MarkdownDocumentation": "`Rewrite`\n\nThe gateway route action to rewrite.\n*Required*: No\n*Type*: [HttpGatewayRouteRewrite](./aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html#cfn-appmesh-gatewayroute-httpgatewayrouteaction-rewrite", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpGatewayRouteHeader": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpGatewayRouteHeader`\n\nAn object that represents the HTTP header in the gateway route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html", "Properties": { "Invert": { "Required": false, "MarkdownDocumentation": "`Invert`\n\nSpecify `True` to match anything except the match criteria. The default value\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-invert", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA name for the HTTP header in the gateway route that will be matched on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Match": { "Type": "HttpGatewayRouteHeaderMatch", "Required": false, "MarkdownDocumentation": "`Match`\n\nAn object that represents the method and value to match with the header value sent in a\nrequest. Specify one match method.\n*Required*: No\n*Type*: [HttpGatewayRouteHeaderMatch](./aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpGatewayRouteHeaderMatch": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpGatewayRouteHeaderMatch`\n\nAn object that represents the method and value to match with the header value sent in a\nrequest. Specify one match method.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html", "Properties": { "Suffix": { "Required": false, "MarkdownDocumentation": "`Suffix`\n\nThe value sent by the client must end with the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-suffix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Regex": { "Required": false, "MarkdownDocumentation": "`Regex`\n\nThe value sent by the client must include the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-regex", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe value sent by the client must match the specified value exactly.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-exact", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Prefix": { "Required": false, "MarkdownDocumentation": "`Prefix`\n\nThe value sent by the client must begin with the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-prefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Range": { "Type": "GatewayRouteRangeMatch", "Required": false, "MarkdownDocumentation": "`Range`\n\nAn object that represents the range of values to match on.\n*Required*: No\n*Type*: [GatewayRouteRangeMatch](./aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-range", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpGatewayRouteMatch": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpGatewayRouteMatch`\n\nAn object that represents the criteria for determining a request match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html", "Properties": { "Path": { "Type": "HttpPathMatch", "Required": false, "MarkdownDocumentation": "`Path`\n\nThe path to match on.\n*Required*: No\n*Type*: [HttpPathMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-path", "UpdateType": "Mutable" }, "Headers": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Headers`\n\nThe client request headers to match on.\n*Required*: No\n*Type*: Array of [HttpGatewayRouteHeader](./aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-headers", "ItemType": "HttpGatewayRouteHeader", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Hostname": { "Type": "GatewayRouteHostnameMatch", "Required": false, "MarkdownDocumentation": "`Hostname`\n\nThe host name to match on.\n*Required*: No\n*Type*: [GatewayRouteHostnameMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-hostname", "UpdateType": "Mutable" }, "Prefix": { "Required": false, "MarkdownDocumentation": "`Prefix`\n\nSpecifies the path to match requests with. This parameter must always start with\n`/`, which by itself matches all requests to the virtual service name. You\ncan also match for path-based routing of requests. For example, if your virtual service\nname is `my-service.local` and you want the route to match requests to\n`my-service.local/metrics`, your prefix should be\n`/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-prefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Method": { "Required": false, "MarkdownDocumentation": "`Method`\n\nThe method to match on.\n*Required*: No\n*Type*: String\n*Allowed values*: `GET | HEAD | POST | PUT | D...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-method", "PrimitiveType": "String", "UpdateType": "Mutable" }, "QueryParameters": { "Type": "List", "Required": false, "MarkdownDocumentation": "`QueryParameters`\n\nThe query parameter to match on.\n*Required*: No\n*Type*: Array of [QueryParameter](./aws-properties-appmesh-gatewayroute-queryparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-queryparameters", "ItemType": "QueryParameter", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpGatewayRoutePathRewrite": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpGatewayRoutePathRewrite`\n\nAn object that represents the path to rewrite.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.html", "Properties": { "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe exact path to rewrite.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.html#cfn-appmesh-gatewayroute-httpgatewayroutepathrewrite-exact", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpGatewayRoutePrefixRewrite": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpGatewayRoutePrefixRewrite`\n\nAn object representing the beginning characters of the route to rewrite.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html", "Properties": { "Value": { "Required": false, "MarkdownDocumentation": "`Value`\n\nThe value used to replace the incoming route prefix when rewritten.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouteprefixrewrite-value", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DefaultPrefix": { "Required": false, "MarkdownDocumentation": "`DefaultPrefix`\n\nThe default prefix used to replace the incoming route prefix when rewritten.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouteprefixrewrite-defaultprefix", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpGatewayRouteRewrite": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpGatewayRouteRewrite`\n\nAn object representing the gateway route to rewrite.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html", "Properties": { "Path": { "Type": "HttpGatewayRoutePathRewrite", "Required": false, "MarkdownDocumentation": "`Path`\n\nThe path to rewrite.\n*Required*: No\n*Type*: [HttpGatewayRoutePathRewrite](./aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-path", "UpdateType": "Mutable" }, "Hostname": { "Type": "GatewayRouteHostnameRewrite", "Required": false, "MarkdownDocumentation": "`Hostname`\n\nThe host name to rewrite.\n*Required*: No\n*Type*: [GatewayRouteHostnameRewrite](./aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-hostname", "UpdateType": "Mutable" }, "Prefix": { "Type": "HttpGatewayRoutePrefixRewrite", "Required": false, "MarkdownDocumentation": "`Prefix`\n\nThe specified beginning characters to rewrite.\n*Required*: No\n*Type*: [HttpGatewayRoutePrefixRewrite](./aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-prefix", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpPathMatch": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpPathMatch`\n\nAn object representing the path to match in the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html", "Properties": { "Regex": { "Required": false, "MarkdownDocumentation": "`Regex`\n\nThe regex used to match the path.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html#cfn-appmesh-gatewayroute-httppathmatch-regex", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe exact path to match on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html#cfn-appmesh-gatewayroute-httppathmatch-exact", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.HttpQueryParameterMatch": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.HttpQueryParameterMatch`\n\nAn object representing the query parameter to match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpqueryparametermatch.html", "Properties": { "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe exact query parameter to match 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpqueryparametermatch.html#cfn-appmesh-gatewayroute-httpqueryparametermatch-exact", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::GatewayRoute.QueryParameter": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute.QueryParameter`\n\nAn object that represents the query parameter in the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html", "Properties": { "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA name for the query parameter that will be matched 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html#cfn-appmesh-gatewayroute-queryparameter-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Match": { "Type": "HttpQueryParameterMatch", "Required": false, "MarkdownDocumentation": "`Match`\n\nThe query parameter to match on.\n*Required*: No\n*Type*: [HttpQueryParameterMatch](./aws-properties-appmesh-gatewayroute-httpqueryparametermatch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html#cfn-appmesh-gatewayroute-queryparameter-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Mesh.EgressFilter": { "MarkdownDocumentation": "`AWS::AppMesh::Mesh.EgressFilter`\n\nAn object that represents the egress filter rules for a service mesh.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe egress filter type. By default, the type is `DROP_ALL`, which allows\negress only from virtual nodes to other defined resources in the service mesh (and any\ntraffic to `*.amazonaws.com` for AWS API calls). You can set the\negress filter type to `ALLOW_ALL` to allow egress to any endpoint inside or\noutside of the service mesh.\n###### Note\nIf you specify any backends on a virtual node when using `ALLOW_ALL`, you\nmust specifiy all egress for that virtual node as backends. Otherwise,\n`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)", "RefReturnValue": "", "AllowedValues": [ "ALLOW_ALL", "DROP_ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html#cfn-appmesh-mesh-egressfilter-type", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Mesh.MeshServiceDiscovery": { "MarkdownDocumentation": "`AWS::AppMesh::Mesh.MeshServiceDiscovery`\n\nAn object that represents the service discovery information for a service mesh.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshservicediscovery.html", "Properties": { "IpPreference": { "Required": false, "MarkdownDocumentation": "`IpPreference`\n\nThe IP version to use to control traffic within the mesh.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPv6_PREFERRED | IPv4_PREFE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshservicediscovery.html#cfn-appmesh-mesh-meshservicediscovery-ippreference", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Mesh.MeshSpec": { "MarkdownDocumentation": "`AWS::AppMesh::Mesh.MeshSpec`\n\nAn object that represents the specification of a service mesh.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html", "Properties": { "EgressFilter": { "Type": "EgressFilter", "Required": false, "MarkdownDocumentation": "`EgressFilter`\n\nThe egress filter rules for the service mesh.\n*Required*: No\n*Type*: [EgressFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html#cfn-appmesh-mesh-meshspec-egressfilter", "UpdateType": "Mutable" }, "ServiceDiscovery": { "Type": "MeshServiceDiscovery", "Required": false, "MarkdownDocumentation": "`ServiceDiscovery`\n\nAn object that represents the service discovery information for a service mesh.\n*Required*: No\n*Type*: [MeshServiceDiscovery](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html#cfn-appmesh-mesh-meshspec-servicediscovery", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.Duration": { "MarkdownDocumentation": "`AWS::AppMesh::Route.Duration`\n\nAn object that represents a duration of time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html", "Properties": { "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html#cfn-appmesh-route-duration-value", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Unit": { "Required": true, "MarkdownDocumentation": "`Unit`\n\nA unit of time.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `s | ms`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "s", "ms" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html#cfn-appmesh-route-duration-unit", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.GrpcRetryPolicy": { "MarkdownDocumentation": "`AWS::AppMesh::Route.GrpcRetryPolicy`\n\nAn object that represents a retry policy. Specify at least one value for at least one of the types of `RetryEvents`, a value for `maxRetries`, and a value for `perRetryTimeout`.\nBoth `server-error` and `gateway-error` under `httpRetryEvents` include the Envoy `reset` policy. For more information on the\n`reset` policy, see the [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html", "Properties": { "MaxRetries": { "Required": true, "MarkdownDocumentation": "`MaxRetries`\n\nThe maximum number of retry attempts.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-maxretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "PerRetryTimeout": { "Type": "Duration", "Required": true, "MarkdownDocumentation": "`PerRetryTimeout`\n\nThe timeout for each retry attempt.\n*Required*: Yes\n*Type*: [Duration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-perretrytimeout", "UpdateType": "Mutable" }, "GrpcRetryEvents": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`GrpcRetryEvents`\n\nSpecify at least one of the valid values.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-grpcretryevents", "UpdateType": "Mutable" }, "HttpRetryEvents": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`HttpRetryEvents`\n\nSpecify at least one of the following values.\n* **server-error** \u2013 HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511\n* **gateway-error** \u2013 HTTP status codes 502,\n 503, and 504\n* **client-error** \u2013 HTTP status code 409\n* **stream-error** \u2013 Retry on refused\n stream\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-httpretryevents", "UpdateType": "Mutable" }, "TcpRetryEvents": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`TcpRetryEvents`\n\nSpecify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-tcpretryevents", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.GrpcRoute": { "MarkdownDocumentation": "`AWS::AppMesh::Route.GrpcRoute`\n\nAn object that represents a gRPC route type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html", "Properties": { "Action": { "Type": "GrpcRouteAction", "Required": true, "MarkdownDocumentation": "`Action`\n\nAn object that represents the action to take if a match is determined.\n*Required*: Yes\n*Type*: [GrpcRouteAction](./aws-properties-appmesh-route-grpcrouteaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html#cfn-appmesh-route-grpcroute-action", "UpdateType": "Mutable" }, "Timeout": { "Type": "GrpcTimeout", "Required": false, "MarkdownDocumentation": "`Timeout`\n\nAn object that represents types of timeouts.\n*Required*: No\n*Type*: [GrpcTimeout](./aws-properties-appmesh-route-grpctimeout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html#cfn-appmesh-route-grpcroute-timeout", "UpdateType": "Mutable" }, "RetryPolicy": { "Type": "GrpcRetryPolicy", "Required": false, "MarkdownDocumentation": "`RetryPolicy`\n\nAn object that represents a retry policy.\n*Required*: No\n*Type*: [GrpcRetryPolicy](./aws-properties-appmesh-route-grpcretrypolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html#cfn-appmesh-route-grpcroute-retrypolicy", "UpdateType": "Mutable" }, "Match": { "Type": "GrpcRouteMatch", "Required": true, "MarkdownDocumentation": "`Match`\n\nAn object that represents the criteria for determining a request match.\n*Required*: Yes\n*Type*: [GrpcRouteMatch](./aws-properties-appmesh-route-grpcroutematch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html#cfn-appmesh-route-grpcroute-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.GrpcRouteAction": { "MarkdownDocumentation": "`AWS::AppMesh::Route.GrpcRouteAction`\n\nAn object that represents the action to take if a match is determined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcrouteaction.html", "Properties": { "WeightedTargets": { "Type": "List", "Required": true, "MarkdownDocumentation": "`WeightedTargets`\n\nAn object that represents the targets that traffic is routed to when a request matches the route.\n*Required*: Yes\n*Type*: Array of [WeightedTarget](./aws-properties-appmesh-route-weightedtarget.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcrouteaction.html#cfn-appmesh-route-grpcrouteaction-weightedtargets", "ItemType": "WeightedTarget", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.GrpcRouteMatch": { "MarkdownDocumentation": "`AWS::AppMesh::Route.GrpcRouteMatch`\n\nAn object that represents the criteria for determining a request match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html", "Properties": { "ServiceName": { "Required": false, "MarkdownDocumentation": "`ServiceName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html#cfn-appmesh-route-grpcroutematch-servicename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html#cfn-appmesh-route-grpcroutematch-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Metadata": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Metadata`\n\nAn object that represents the data to match from the request.\n*Required*: No\n*Type*: Array of [GrpcRouteMetadata](./aws-properties-appmesh-route-grpcroutemetadata.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html#cfn-appmesh-route-grpcroutematch-metadata", "ItemType": "GrpcRouteMetadata", "UpdateType": "Mutable" }, "MethodName": { "Required": false, "MarkdownDocumentation": "`MethodName`\n\nThe method name to match from the request. If you specify a name, you must also specify\na `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html#cfn-appmesh-route-grpcroutematch-methodname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.GrpcRouteMetadata": { "MarkdownDocumentation": "`AWS::AppMesh::Route.GrpcRouteMetadata`\n\nAn object that represents the match metadata for the route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html", "Properties": { "Invert": { "Required": false, "MarkdownDocumentation": "`Invert`\n\nSpecify `True` to match anything except the match criteria. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html#cfn-appmesh-route-grpcroutemetadata-invert", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the route.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html#cfn-appmesh-route-grpcroutemetadata-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Match": { "Type": "GrpcRouteMetadataMatchMethod", "Required": false, "MarkdownDocumentation": "`Match`\n\nAn object that represents the data to match from the request.\n*Required*: No\n*Type*: [GrpcRouteMetadataMatchMethod](./aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html#cfn-appmesh-route-grpcroutemetadata-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.GrpcRouteMetadataMatchMethod": { "MarkdownDocumentation": "`AWS::AppMesh::Route.GrpcRouteMetadataMatchMethod`\n\nAn object that represents the match method. Specify one of the match values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html", "Properties": { "Suffix": { "Required": false, "MarkdownDocumentation": "`Suffix`\n\nThe value sent by the client must end with the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-suffix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Regex": { "Required": false, "MarkdownDocumentation": "`Regex`\n\nThe value sent by the client must include the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-regex", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe value sent by the client must match the specified value exactly.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-exact", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Prefix": { "Required": false, "MarkdownDocumentation": "`Prefix`\n\nThe value sent by the client must begin with the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-prefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Range": { "Type": "MatchRange", "Required": false, "MarkdownDocumentation": "`Range`\n\nAn object that represents the range of values to match on.\n*Required*: No\n*Type*: [MatchRange](./aws-properties-appmesh-route-matchrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html#cfn-appmesh-route-grpcroutemetadatamatchmethod-range", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.GrpcTimeout": { "MarkdownDocumentation": "`AWS::AppMesh::Route.GrpcTimeout`\n\nAn object that represents types of timeouts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpctimeout.html", "Properties": { "PerRequest": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`PerRequest`\n\nAn 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\nresource 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\nseconds for the source and destination virtual node and the route.\n*Required*: No\n*Type*: [Duration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpctimeout.html#cfn-appmesh-route-grpctimeout-perrequest", "UpdateType": "Mutable" }, "Idle": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`Idle`\n\nAn 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpctimeout.html#cfn-appmesh-route-grpctimeout-idle", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HeaderMatchMethod": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HeaderMatchMethod`\n\nAn object that represents the method and value to match with the header value sent in a\nrequest. Specify one match method.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html", "Properties": { "Suffix": { "Required": false, "MarkdownDocumentation": "`Suffix`\n\nThe value sent by the client must end with the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-suffix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Regex": { "Required": false, "MarkdownDocumentation": "`Regex`\n\nThe value sent by the client must include the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-regex", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe value sent by the client must match the specified value exactly.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-exact", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Prefix": { "Required": false, "MarkdownDocumentation": "`Prefix`\n\nThe value sent by the client must begin with the specified characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-prefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Range": { "Type": "MatchRange", "Required": false, "MarkdownDocumentation": "`Range`\n\nAn object that represents the range of values to match on.\n*Required*: No\n*Type*: [MatchRange](./aws-properties-appmesh-route-matchrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html#cfn-appmesh-route-headermatchmethod-range", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HttpPathMatch": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HttpPathMatch`\n\nAn object representing the path to match in the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httppathmatch.html", "Properties": { "Regex": { "Required": false, "MarkdownDocumentation": "`Regex`\n\nThe regex used to match the path.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httppathmatch.html#cfn-appmesh-route-httppathmatch-regex", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe exact path to match on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httppathmatch.html#cfn-appmesh-route-httppathmatch-exact", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HttpQueryParameterMatch": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HttpQueryParameterMatch`\n\nAn object representing the query parameter to match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpqueryparametermatch.html", "Properties": { "Exact": { "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe exact query parameter to match 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpqueryparametermatch.html#cfn-appmesh-route-httpqueryparametermatch-exact", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HttpRetryPolicy": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HttpRetryPolicy`\n\nAn object that represents a retry policy. Specify at least one value for at least one of the types of `RetryEvents`, a value for `maxRetries`, and a value for `perRetryTimeout`.\nBoth `server-error` and `gateway-error` under `httpRetryEvents` include the Envoy `reset` policy. For more information on the\n`reset` policy, see the [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html", "Properties": { "MaxRetries": { "Required": true, "MarkdownDocumentation": "`MaxRetries`\n\nThe maximum number of retry attempts.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-maxretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "PerRetryTimeout": { "Type": "Duration", "Required": true, "MarkdownDocumentation": "`PerRetryTimeout`\n\nThe timeout for each retry attempt.\n*Required*: Yes\n*Type*: [Duration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-perretrytimeout", "UpdateType": "Mutable" }, "HttpRetryEvents": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`HttpRetryEvents`\n\nSpecify at least one of the following values.\n* **server-error** \u2013 HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511\n* **gateway-error** \u2013 HTTP status codes 502,\n 503, and 504\n* **client-error** \u2013 HTTP status code 409\n* **stream-error** \u2013 Retry on refused\n stream\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-httpretryevents", "UpdateType": "Mutable" }, "TcpRetryEvents": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`TcpRetryEvents`\n\nSpecify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-tcpretryevents", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HttpRoute": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HttpRoute`\n\nAn object that represents an HTTP or HTTP/2 route type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html", "Properties": { "Action": { "Type": "HttpRouteAction", "Required": true, "MarkdownDocumentation": "`Action`\n\nAn object that represents the action to take if a match is determined.\n*Required*: Yes\n*Type*: [HttpRouteAction](./aws-properties-appmesh-route-httprouteaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-action", "UpdateType": "Mutable" }, "Timeout": { "Type": "HttpTimeout", "Required": false, "MarkdownDocumentation": "`Timeout`\n\nAn object that represents types of timeouts.\n*Required*: No\n*Type*: [HttpTimeout](./aws-properties-appmesh-route-httptimeout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-timeout", "UpdateType": "Mutable" }, "RetryPolicy": { "Type": "HttpRetryPolicy", "Required": false, "MarkdownDocumentation": "`RetryPolicy`\n\nAn object that represents a retry policy.\n*Required*: No\n*Type*: [HttpRetryPolicy](./aws-properties-appmesh-route-httpretrypolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-retrypolicy", "UpdateType": "Mutable" }, "Match": { "Type": "HttpRouteMatch", "Required": true, "MarkdownDocumentation": "`Match`\n\nAn object that represents the criteria for determining a request match.\n*Required*: Yes\n*Type*: [HttpRouteMatch](./aws-properties-appmesh-route-httproutematch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html#cfn-appmesh-route-httproute-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HttpRouteAction": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HttpRouteAction`\n\nAn object that represents the action to take if a match is determined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteaction.html", "Properties": { "WeightedTargets": { "Type": "List", "Required": true, "MarkdownDocumentation": "`WeightedTargets`\n\nAn object that represents the targets that traffic is routed to when a request matches the route.\n*Required*: Yes\n*Type*: Array of [WeightedTarget](./aws-properties-appmesh-route-weightedtarget.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteaction.html#cfn-appmesh-route-httprouteaction-weightedtargets", "ItemType": "WeightedTarget", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HttpRouteHeader": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HttpRouteHeader`\n\nAn object that represents the HTTP header in the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html", "Properties": { "Invert": { "Required": false, "MarkdownDocumentation": "`Invert`\n\nSpecify `True` to match anything except the match criteria. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html#cfn-appmesh-route-httprouteheader-invert", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA name for the HTTP header in the client request that will be matched on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html#cfn-appmesh-route-httprouteheader-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Match": { "Type": "HeaderMatchMethod", "Required": false, "MarkdownDocumentation": "`Match`\n\nThe `HeaderMatchMethod` object.\n*Required*: No\n*Type*: [HeaderMatchMethod](./aws-properties-appmesh-route-headermatchmethod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html#cfn-appmesh-route-httprouteheader-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HttpRouteMatch": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HttpRouteMatch`\n\nAn object that represents the requirements for a route to match HTTP requests for a\nvirtual router.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html", "Properties": { "Path": { "Type": "HttpPathMatch", "Required": false, "MarkdownDocumentation": "`Path`\n\nThe client request path to match on.\n*Required*: No\n*Type*: [HttpPathMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-path", "UpdateType": "Mutable" }, "Scheme": { "Required": false, "MarkdownDocumentation": "`Scheme`\n\nThe client request scheme to match on. Specify only one. Applicable only for HTTP2\nroutes.\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)", "RefReturnValue": "", "AllowedValues": [ "http", "https" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-scheme", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Headers": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Headers`\n\nThe client request headers to match on.\n*Required*: No\n*Type*: Array of [HttpRouteHeader](./aws-properties-appmesh-route-httprouteheader.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-headers", "ItemType": "HttpRouteHeader", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Prefix": { "Required": false, "MarkdownDocumentation": "`Prefix`\n\nSpecifies the path to match requests with. This parameter must always start with\n`/`, which by itself matches all requests to the virtual service name. You\ncan also match for path-based routing of requests. For example, if your virtual service\nname is `my-service.local` and you want the route to match requests to\n`my-service.local/metrics`, your prefix should be\n`/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-prefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Method": { "Required": false, "MarkdownDocumentation": "`Method`\n\nThe client request method to match on. Specify only one.\n*Required*: No\n*Type*: String\n*Allowed values*: `GET | HEAD | POST | PUT | D...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-method", "PrimitiveType": "String", "UpdateType": "Mutable" }, "QueryParameters": { "Type": "List", "Required": false, "MarkdownDocumentation": "`QueryParameters`\n\nThe client request query parameters to match on.\n*Required*: No\n*Type*: Array of [QueryParameter](./aws-properties-appmesh-route-queryparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-queryparameters", "ItemType": "QueryParameter", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.HttpTimeout": { "MarkdownDocumentation": "`AWS::AppMesh::Route.HttpTimeout`\n\nAn object that represents types of timeouts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httptimeout.html", "Properties": { "PerRequest": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`PerRequest`\n\nAn 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\nresource 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\nseconds for the source and destination virtual node and the route.\n*Required*: No\n*Type*: [Duration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httptimeout.html#cfn-appmesh-route-httptimeout-perrequest", "UpdateType": "Mutable" }, "Idle": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`Idle`\n\nAn 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httptimeout.html#cfn-appmesh-route-httptimeout-idle", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.MatchRange": { "MarkdownDocumentation": "`AWS::AppMesh::Route.MatchRange`\n\nAn object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-matchrange.html", "Properties": { "Start": { "Required": true, "MarkdownDocumentation": "`Start`\n\nThe start of the range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-matchrange.html#cfn-appmesh-route-matchrange-start", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "End": { "Required": true, "MarkdownDocumentation": "`End`\n\nThe end of the range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-matchrange.html#cfn-appmesh-route-matchrange-end", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.QueryParameter": { "MarkdownDocumentation": "`AWS::AppMesh::Route.QueryParameter`\n\nAn object that represents the query parameter in the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-queryparameter.html", "Properties": { "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA name for the query parameter that will be matched 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-queryparameter.html#cfn-appmesh-route-queryparameter-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Match": { "Type": "HttpQueryParameterMatch", "Required": false, "MarkdownDocumentation": "`Match`\n\nThe query parameter to match on.\n*Required*: No\n*Type*: [HttpQueryParameterMatch](./aws-properties-appmesh-route-httpqueryparametermatch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-queryparameter.html#cfn-appmesh-route-queryparameter-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.RouteSpec": { "MarkdownDocumentation": "`AWS::AppMesh::Route.RouteSpec`\n\nAn object that represents a route specification. Specify one route type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html", "Properties": { "HttpRoute": { "Type": "HttpRoute", "Required": false, "MarkdownDocumentation": "`HttpRoute`\n\nAn object that represents the specification of an HTTP route.\n*Required*: No\n*Type*: [HttpRoute](./aws-properties-appmesh-route-httproute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-httproute", "UpdateType": "Mutable" }, "Priority": { "Required": false, "MarkdownDocumentation": "`Priority`\n\nThe priority for the route. Routes are matched based on the specified value, where 0 is\nthe highest priority.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-priority", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Http2Route": { "Type": "HttpRoute", "Required": false, "MarkdownDocumentation": "`Http2Route`\n\nAn object that represents the specification of an HTTP/2 route.\n*Required*: No\n*Type*: [HttpRoute](./aws-properties-appmesh-route-httproute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-http2route", "UpdateType": "Mutable" }, "GrpcRoute": { "Type": "GrpcRoute", "Required": false, "MarkdownDocumentation": "`GrpcRoute`\n\nAn object that represents the specification of a gRPC route.\n*Required*: No\n*Type*: [GrpcRoute](./aws-properties-appmesh-route-grpcroute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-grpcroute", "UpdateType": "Mutable" }, "TcpRoute": { "Type": "TcpRoute", "Required": false, "MarkdownDocumentation": "`TcpRoute`\n\nAn object that represents the specification of a TCP route.\n*Required*: No\n*Type*: [TcpRoute](./aws-properties-appmesh-route-tcproute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-tcproute", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.TcpRoute": { "MarkdownDocumentation": "`AWS::AppMesh::Route.TcpRoute`\n\nAn object that represents a TCP route type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html", "Properties": { "Action": { "Type": "TcpRouteAction", "Required": true, "MarkdownDocumentation": "`Action`\n\nThe action to take if a match is determined.\n*Required*: Yes\n*Type*: [TcpRouteAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html#cfn-appmesh-route-tcproute-action", "UpdateType": "Mutable" }, "Timeout": { "Type": "TcpTimeout", "Required": false, "MarkdownDocumentation": "`Timeout`\n\nAn object that represents types of timeouts.\n*Required*: No\n*Type*: [TcpTimeout](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html#cfn-appmesh-route-tcproute-timeout", "UpdateType": "Mutable" }, "Match": { "Type": "TcpRouteMatch", "Required": false, "MarkdownDocumentation": "`Match`\n\nAn object that represents the criteria for determining a request match.\n*Required*: No\n*Type*: [TcpRouteMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html#cfn-appmesh-route-tcproute-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.TcpRouteAction": { "MarkdownDocumentation": "`AWS::AppMesh::Route.TcpRouteAction`\n\nAn object that represents the action to take if a match is determined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html", "Properties": { "WeightedTargets": { "Type": "List", "Required": true, "MarkdownDocumentation": "`WeightedTargets`\n\nAn object that represents the targets that traffic is routed to when a request matches the route.\n*Required*: Yes\n*Type*: Array of [WeightedTarget](./aws-properties-appmesh-route-weightedtarget.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html#cfn-appmesh-route-tcprouteaction-weightedtargets", "ItemType": "WeightedTarget", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.TcpRouteMatch": { "MarkdownDocumentation": "`AWS::AppMesh::Route.TcpRouteMatch`\n\nAn object representing the TCP route to match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproutematch.html", "Properties": { "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproutematch.html#cfn-appmesh-route-tcproutematch-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.TcpTimeout": { "MarkdownDocumentation": "`AWS::AppMesh::Route.TcpTimeout`\n\nAn object that represents types of timeouts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcptimeout.html", "Properties": { "Idle": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`Idle`\n\nAn 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcptimeout.html#cfn-appmesh-route-tcptimeout-idle", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route.WeightedTarget": { "MarkdownDocumentation": "`AWS::AppMesh::Route.WeightedTarget`\n\nAn object that represents a target and its relative weight. Traffic is distributed\nacross targets according to their relative weight. For example, a weighted target with a\nrelative weight of 50 receives five times as much traffic as one with a relative weight of\n10. The total weight for all targets combined must be less than or equal to 100.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html", "Properties": { "VirtualNode": { "Required": true, "MarkdownDocumentation": "`VirtualNode`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html#cfn-appmesh-route-weightedtarget-virtualnode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html#cfn-appmesh-route-weightedtarget-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Weight": { "Required": true, "MarkdownDocumentation": "`Weight`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html#cfn-appmesh-route-weightedtarget-weight", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.JsonFormatRef": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.JsonFormatRef`\n\nAn object that represents the key value pairs for the JSON.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-jsonformatref.html", "Properties": { "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-jsonformatref.html#cfn-appmesh-virtualgateway-jsonformatref-value", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Key": { "Required": true, "MarkdownDocumentation": "`Key`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-jsonformatref.html#cfn-appmesh-virtualgateway-jsonformatref-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.LoggingFormat": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.LoggingFormat`\n\nAn object that represents the format for the logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-loggingformat.html", "Properties": { "Text": { "Required": false, "MarkdownDocumentation": "`Text`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-loggingformat.html#cfn-appmesh-virtualgateway-loggingformat-text", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Json": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Json`\n\nThe logging format for JSON.\n*Required*: No\n*Type*: Array of [JsonFormatRef](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-loggingformat.html#cfn-appmesh-virtualgateway-loggingformat-json", "ItemType": "JsonFormatRef", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.SubjectAlternativeNameMatchers": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.SubjectAlternativeNameMatchers`\n\nAn object that represents the methods by which a subject alternative name on a peer\nTransport Layer Security (TLS) certificate can be matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-subjectalternativenamematchers.html", "Properties": { "Exact": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe values sent must match the specified values exactly.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-subjectalternativenamematchers.html#cfn-appmesh-virtualgateway-subjectalternativenamematchers-exact", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.SubjectAlternativeNames": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.SubjectAlternativeNames`\n\nAn object that represents the subject alternative names secured by the\ncertificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-subjectalternativenames.html", "Properties": { "Match": { "Type": "SubjectAlternativeNameMatchers", "Required": true, "MarkdownDocumentation": "`Match`\n\nAn object that represents the criteria for determining a SANs match.\n*Required*: Yes\n*Type*: [SubjectAlternativeNameMatchers](./aws-properties-appmesh-virtualgateway-subjectalternativenamematchers.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-subjectalternativenames.html#cfn-appmesh-virtualgateway-subjectalternativenames-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayAccessLog": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayAccessLog`\n\nThe access log configuration for a virtual gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayaccesslog.html", "Properties": { "File": { "Type": "VirtualGatewayFileAccessLog", "Required": false, "MarkdownDocumentation": "`File`\n\nThe file object to send virtual gateway access logs to.\n*Required*: No\n*Type*: [VirtualGatewayFileAccessLog](./aws-properties-appmesh-virtualgateway-virtualgatewayfileaccesslog.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayaccesslog.html#cfn-appmesh-virtualgateway-virtualgatewayaccesslog-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayBackendDefaults": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayBackendDefaults`\n\nAn object that represents the default properties for a backend.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaybackenddefaults.html", "Properties": { "ClientPolicy": { "Type": "VirtualGatewayClientPolicy", "Required": false, "MarkdownDocumentation": "`ClientPolicy`\n\nA reference to an object that represents a client policy.\n*Required*: No\n*Type*: [VirtualGatewayClientPolicy](./aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaybackenddefaults.html#cfn-appmesh-virtualgateway-virtualgatewaybackenddefaults-clientpolicy", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayClientPolicy": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayClientPolicy`\n\nAn object that represents a client policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicy.html", "Properties": { "TLS": { "Type": "VirtualGatewayClientPolicyTls", "Required": false, "MarkdownDocumentation": "`TLS`\n\nA reference to an object that represents a Transport Layer Security (TLS) client policy.\n*Required*: No\n*Type*: [VirtualGatewayClientPolicyTls](./aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicytls.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicy.html#cfn-appmesh-virtualgateway-virtualgatewayclientpolicy-tls", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayClientPolicyTls": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayClientPolicyTls`\n\nAn object that represents a Transport Layer Security (TLS) client policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicytls.html", "Properties": { "Validation": { "Type": "VirtualGatewayTlsValidationContext", "Required": true, "MarkdownDocumentation": "`Validation`\n\nA reference to an object that represents a Transport Layer Security (TLS) validation context.\n*Required*: Yes\n*Type*: [VirtualGatewayTlsValidationContext](./aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicytls.html#cfn-appmesh-virtualgateway-virtualgatewayclientpolicytls-validation", "UpdateType": "Mutable" }, "Enforce": { "Required": false, "MarkdownDocumentation": "`Enforce`\n\nWhether the policy is enforced. The default is `True`, if a value isn't\nspecified.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicytls.html#cfn-appmesh-virtualgateway-virtualgatewayclientpolicytls-enforce", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Ports": { "PrimitiveItemType": "Integer", "Type": "List", "Required": false, "MarkdownDocumentation": "`Ports`\n\nOne or more ports that the policy is enforced for.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicytls.html#cfn-appmesh-virtualgateway-virtualgatewayclientpolicytls-ports", "UpdateType": "Mutable" }, "Certificate": { "Type": "VirtualGatewayClientTlsCertificate", "Required": false, "MarkdownDocumentation": "`Certificate`\n\nA reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS)\ncertificate.\n*Required*: No\n*Type*: [VirtualGatewayClientTlsCertificate](./aws-properties-appmesh-virtualgateway-virtualgatewayclienttlscertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclientpolicytls.html#cfn-appmesh-virtualgateway-virtualgatewayclientpolicytls-certificate", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayClientTlsCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayClientTlsCertificate`\n\nAn object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclienttlscertificate.html", "Properties": { "SDS": { "Type": "VirtualGatewayListenerTlsSdsCertificate", "Required": false, "MarkdownDocumentation": "`SDS`\n\nA reference to an object that represents a virtual gateway's client's Secret Discovery\nService certificate.\n*Required*: No\n*Type*: [VirtualGatewayListenerTlsSdsCertificate](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlssdscertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclienttlscertificate.html#cfn-appmesh-virtualgateway-virtualgatewayclienttlscertificate-sds", "UpdateType": "Mutable" }, "File": { "Type": "VirtualGatewayListenerTlsFileCertificate", "Required": false, "MarkdownDocumentation": "`File`\n\nAn object that represents a local file certificate. The certificate must meet specific\nrequirements and you must have proxy authorization enabled. For more information, see\n [Transport Layer Security (TLS)](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html).\n*Required*: No\n*Type*: [VirtualGatewayListenerTlsFileCertificate](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsfilecertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayclienttlscertificate.html#cfn-appmesh-virtualgateway-virtualgatewayclienttlscertificate-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayConnectionPool`\n\nAn object that represents the type of virtual gateway connection pool.\nOnly one protocol is used at a time and should be the same protocol as the one chosen\nunder port mapping.\nIf not present the default value for `maxPendingRequests` is\n`2147483647`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayconnectionpool.html", "Properties": { "HTTP2": { "Type": "VirtualGatewayHttp2ConnectionPool", "Required": false, "MarkdownDocumentation": "`HTTP2`\n\nAn object that represents a type of connection pool.\n*Required*: No\n*Type*: [VirtualGatewayHttp2ConnectionPool](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayconnectionpool.html#cfn-appmesh-virtualgateway-virtualgatewayconnectionpool-http2", "UpdateType": "Mutable" }, "HTTP": { "Type": "VirtualGatewayHttpConnectionPool", "Required": false, "MarkdownDocumentation": "`HTTP`\n\nAn object that represents a type of connection pool.\n*Required*: No\n*Type*: [VirtualGatewayHttpConnectionPool](./aws-properties-appmesh-virtualgateway-virtualgatewayhttpconnectionpool.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayconnectionpool.html#cfn-appmesh-virtualgateway-virtualgatewayconnectionpool-http", "UpdateType": "Mutable" }, "GRPC": { "Type": "VirtualGatewayGrpcConnectionPool", "Required": false, "MarkdownDocumentation": "`GRPC`\n\nAn object that represents a type of connection pool.\n*Required*: No\n*Type*: [VirtualGatewayGrpcConnectionPool](./aws-properties-appmesh-virtualgateway-virtualgatewaygrpcconnectionpool.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayconnectionpool.html#cfn-appmesh-virtualgateway-virtualgatewayconnectionpool-grpc", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayFileAccessLog": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayFileAccessLog`\n\nAn object that represents an access log file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayfileaccesslog.html", "Properties": { "Path": { "Required": true, "MarkdownDocumentation": "`Path`\n\nThe file path to write access logs to. You can use `/dev/stdout` to send\naccess logs to standard out and configure your Envoy container to use a log driver, such as\n`awslogs`, to export the access logs to a log storage service such as Amazon\nCloudWatch Logs. You can also specify a path in the Envoy container's file system to write\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayfileaccesslog.html#cfn-appmesh-virtualgateway-virtualgatewayfileaccesslog-path", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Format": { "Type": "LoggingFormat", "Required": false, "MarkdownDocumentation": "`Format`\n\nThe specified format for the virtual gateway access logs. It can be either\n`json_format` or `text_format`.\n*Required*: No\n*Type*: [LoggingFormat](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayfileaccesslog.html#cfn-appmesh-virtualgateway-virtualgatewayfileaccesslog-format", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayGrpcConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayGrpcConnectionPool`\n\nAn object that represents a type of connection pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaygrpcconnectionpool.html", "Properties": { "MaxRequests": { "Required": true, "MarkdownDocumentation": "`MaxRequests`\n\nMaximum number of inflight requests Envoy can concurrently support across hosts in\nupstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaygrpcconnectionpool.html#cfn-appmesh-virtualgateway-virtualgatewaygrpcconnectionpool-maxrequests", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayHealthCheckPolicy": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayHealthCheckPolicy`\n\nAn object that represents the health check policy for a virtual gateway's\nlistener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html", "Properties": { "Path": { "Required": false, "MarkdownDocumentation": "`Path`\n\nThe destination path for the health check request. This value is only used if the\nspecified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html#cfn-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy-path", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UnhealthyThreshold": { "Required": true, "MarkdownDocumentation": "`UnhealthyThreshold`\n\nThe number of consecutive failed health checks that must occur before declaring a\nvirtual gateway unhealthy.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html#cfn-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy-unhealthythreshold", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe destination port for the health check request. This port must match the port defined\nin the [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-portmapping) for the listener.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html#cfn-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "HealthyThreshold": { "Required": true, "MarkdownDocumentation": "`HealthyThreshold`\n\nThe number of consecutive successful health checks that must occur before declaring the\nlistener healthy.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html#cfn-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy-healthythreshold", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TimeoutMillis": { "Required": true, "MarkdownDocumentation": "`TimeoutMillis`\n\nThe amount of time to wait when receiving a response from the health check, in\nmilliseconds.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html#cfn-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy-timeoutmillis", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Protocol": { "Required": true, "MarkdownDocumentation": "`Protocol`\n\nThe protocol for the health check request. If you specify `grpc`, then your\nservice must conform to the [GRPC Health\nChecking Protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `http | http2 | grpc...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "http", "http2", "grpc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html#cfn-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy-protocol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IntervalMillis": { "Required": true, "MarkdownDocumentation": "`IntervalMillis`\n\nThe time period in milliseconds between each health check execution.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html#cfn-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy-intervalmillis", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayHttp2ConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayHttp2ConnectionPool`\n\nAn object that represents a type of connection pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhttp2connectionpool.html", "Properties": { "MaxRequests": { "Required": true, "MarkdownDocumentation": "`MaxRequests`\n\nMaximum number of inflight requests Envoy can concurrently support across hosts in\nupstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhttp2connectionpool.html#cfn-appmesh-virtualgateway-virtualgatewayhttp2connectionpool-maxrequests", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayHttpConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayHttpConnectionPool`\n\nAn object that represents a type of connection pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhttpconnectionpool.html", "Properties": { "MaxConnections": { "Required": true, "MarkdownDocumentation": "`MaxConnections`\n\nMaximum number of outbound TCP connections Envoy can establish concurrently with all\nhosts in upstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhttpconnectionpool.html#cfn-appmesh-virtualgateway-virtualgatewayhttpconnectionpool-maxconnections", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MaxPendingRequests": { "Required": false, "MarkdownDocumentation": "`MaxPendingRequests`\n\nNumber of overflowing requests after `max_connections` Envoy will queue to\nupstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhttpconnectionpool.html#cfn-appmesh-virtualgateway-virtualgatewayhttpconnectionpool-maxpendingrequests", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayListener": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayListener`\n\nAn object that represents a listener for a virtual gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html", "Properties": { "ConnectionPool": { "Type": "VirtualGatewayConnectionPool", "Required": false, "MarkdownDocumentation": "`ConnectionPool`\n\nThe connection pool information for the listener.\n*Required*: No\n*Type*: [VirtualGatewayConnectionPool](./aws-properties-appmesh-virtualgateway-virtualgatewayconnectionpool.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html#cfn-appmesh-virtualgateway-virtualgatewaylistener-connectionpool", "UpdateType": "Mutable" }, "HealthCheck": { "Type": "VirtualGatewayHealthCheckPolicy", "Required": false, "MarkdownDocumentation": "`HealthCheck`\n\nThe health check information for the listener.\n*Required*: No\n*Type*: [VirtualGatewayHealthCheckPolicy](./aws-properties-appmesh-virtualgateway-virtualgatewayhealthcheckpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html#cfn-appmesh-virtualgateway-virtualgatewaylistener-healthcheck", "UpdateType": "Mutable" }, "TLS": { "Type": "VirtualGatewayListenerTls", "Required": false, "MarkdownDocumentation": "`TLS`\n\nA reference to an object that represents the Transport Layer Security (TLS) properties for the listener.\n*Required*: No\n*Type*: [VirtualGatewayListenerTls](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertls.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html#cfn-appmesh-virtualgateway-virtualgatewaylistener-tls", "UpdateType": "Mutable" }, "PortMapping": { "Type": "VirtualGatewayPortMapping", "Required": true, "MarkdownDocumentation": "`PortMapping`\n\nThe port mapping information for the listener.\n*Required*: Yes\n*Type*: [VirtualGatewayPortMapping](./aws-properties-appmesh-virtualgateway-virtualgatewayportmapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html#cfn-appmesh-virtualgateway-virtualgatewaylistener-portmapping", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTls": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTls`\n\nAn object that represents the Transport Layer Security (TLS) properties for a listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertls.html", "Properties": { "Validation": { "Type": "VirtualGatewayListenerTlsValidationContext", "Required": false, "MarkdownDocumentation": "`Validation`\n\nA reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation\ncontext.\n*Required*: No\n*Type*: [VirtualGatewayListenerTlsValidationContext](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertls.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertls-validation", "UpdateType": "Mutable" }, "Mode": { "Required": true, "MarkdownDocumentation": "`Mode`\n\nSpecify one of the following modes.\n* STRICT \u2013 Listener only accepts connections with TLS\n enabled.\n* PERMISSIVE \u2013 Listener accepts connections with or\n without TLS enabled.\n* DISABLED \u2013 Listener only accepts connections without\n TLS.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRICT | PERMISSIVE | DISAB...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRICT", "PERMISSIVE", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertls.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertls-mode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Certificate": { "Type": "VirtualGatewayListenerTlsCertificate", "Required": true, "MarkdownDocumentation": "`Certificate`\n\nAn object that represents a Transport Layer Security (TLS) certificate.\n*Required*: Yes\n*Type*: [VirtualGatewayListenerTlsCertificate](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlscertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertls.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertls-certificate", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsAcmCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsAcmCertificate`\n\nAn object that represents an AWS Certificate Manager certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsacmcertificate.html", "Properties": { "CertificateArn": { "Required": true, "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see [Transport Layer Security (TLS)](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsacmcertificate.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlsacmcertificate-certificatearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsCertificate`\n\nAn object that represents a listener's Transport Layer Security (TLS) certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlscertificate.html", "Properties": { "SDS": { "Type": "VirtualGatewayListenerTlsSdsCertificate", "Required": false, "MarkdownDocumentation": "`SDS`\n\nA reference to an object that represents a virtual gateway's listener's Secret Discovery\nService certificate.\n*Required*: No\n*Type*: [VirtualGatewayListenerTlsSdsCertificate](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlssdscertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlscertificate.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlscertificate-sds", "UpdateType": "Mutable" }, "ACM": { "Type": "VirtualGatewayListenerTlsAcmCertificate", "Required": false, "MarkdownDocumentation": "`ACM`\n\nA reference to an object that represents an AWS Certificate Manager certificate.\n*Required*: No\n*Type*: [VirtualGatewayListenerTlsAcmCertificate](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsacmcertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlscertificate.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlscertificate-acm", "UpdateType": "Mutable" }, "File": { "Type": "VirtualGatewayListenerTlsFileCertificate", "Required": false, "MarkdownDocumentation": "`File`\n\nA reference to an object that represents a local file certificate.\n*Required*: No\n*Type*: [VirtualGatewayListenerTlsFileCertificate](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsfilecertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlscertificate.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlscertificate-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsFileCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsFileCertificate`\n\nAn object that represents a local file certificate.\nThe certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see [Transport Layer Security (TLS)](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsfilecertificate.html", "Properties": { "PrivateKey": { "Required": true, "MarkdownDocumentation": "`PrivateKey`\n\nThe private key for a certificate stored on the file system of the mesh endpoint that\nthe proxy is running on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsfilecertificate.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlsfilecertificate-privatekey", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CertificateChain": { "Required": true, "MarkdownDocumentation": "`CertificateChain`\n\nThe certificate chain for the certificate.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsfilecertificate.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlsfilecertificate-certificatechain", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsSdsCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsSdsCertificate`\n\nAn object that represents the virtual gateway's listener's Secret Discovery Service\ncertificate.The proxy must be configured with a local SDS provider via a Unix Domain\nSocket. See App Mesh[TLS\ndocumentation](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) for more info.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlssdscertificate.html", "Properties": { "SecretName": { "Required": true, "MarkdownDocumentation": "`SecretName`\n\nA reference to an object that represents the name of the secret secret requested from\nthe Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or\ncertificate chain.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlssdscertificate.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlssdscertificate-secretname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsValidationContext": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsValidationContext`\n\nAn object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation\ncontext.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontext.html", "Properties": { "SubjectAlternativeNames": { "Type": "SubjectAlternativeNames", "Required": false, "MarkdownDocumentation": "`SubjectAlternativeNames`\n\nA reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS)\nvalidation context.\n*Required*: No\n*Type*: [SubjectAlternativeNames](./aws-properties-appmesh-virtualgateway-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontext.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontext-subjectalternativenames", "UpdateType": "Mutable" }, "Trust": { "Type": "VirtualGatewayListenerTlsValidationContextTrust", "Required": true, "MarkdownDocumentation": "`Trust`\n\nA reference to where to retrieve the trust chain when validating a peer\u2019s Transport Layer Security (TLS)\ncertificate.\n*Required*: Yes\n*Type*: [VirtualGatewayListenerTlsValidationContextTrust](./aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontexttrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontext.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontext-trust", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsValidationContextTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsValidationContextTrust`\n\nAn object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context\ntrust.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontexttrust.html", "Properties": { "SDS": { "Type": "VirtualGatewayTlsValidationContextSdsTrust", "Required": false, "MarkdownDocumentation": "`SDS`\n\nA reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret\nDiscovery Service validation context trust.\n*Required*: No\n*Type*: [VirtualGatewayTlsValidationContextSdsTrust](./aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextsdstrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontexttrust.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontexttrust-sds", "UpdateType": "Mutable" }, "File": { "Type": "VirtualGatewayTlsValidationContextFileTrust", "Required": false, "MarkdownDocumentation": "`File`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust for a local file.\n*Required*: No\n*Type*: [VirtualGatewayTlsValidationContextFileTrust](./aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextfiletrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontexttrust.html#cfn-appmesh-virtualgateway-virtualgatewaylistenertlsvalidationcontexttrust-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayLogging": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayLogging`\n\nAn object that represents logging information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylogging.html", "Properties": { "AccessLog": { "Type": "VirtualGatewayAccessLog", "Required": false, "MarkdownDocumentation": "`AccessLog`\n\nThe access log configuration.\n*Required*: No\n*Type*: [VirtualGatewayAccessLog](./aws-properties-appmesh-virtualgateway-virtualgatewayaccesslog.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylogging.html#cfn-appmesh-virtualgateway-virtualgatewaylogging-accesslog", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayPortMapping": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayPortMapping`\n\nAn object that represents a port mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayportmapping.html", "Properties": { "Port": { "Required": true, "MarkdownDocumentation": "`Port`\n\nThe port used for the port mapping. Specify one protocol.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayportmapping.html#cfn-appmesh-virtualgateway-virtualgatewayportmapping-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Protocol": { "Required": true, "MarkdownDocumentation": "`Protocol`\n\nThe protocol used for the port mapping.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `http | http2 | grpc...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "http", "http2", "grpc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayportmapping.html#cfn-appmesh-virtualgateway-virtualgatewayportmapping-protocol", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewaySpec": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewaySpec`\n\nAn object that represents the specification of a service mesh resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayspec.html", "Properties": { "Logging": { "Type": "VirtualGatewayLogging", "Required": false, "MarkdownDocumentation": "`Logging`\n\nAn object that represents logging information.\n*Required*: No\n*Type*: [VirtualGatewayLogging](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayspec.html#cfn-appmesh-virtualgateway-virtualgatewayspec-logging", "UpdateType": "Mutable" }, "Listeners": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Listeners`\n\nThe listeners that the mesh endpoint is expected to receive inbound traffic from. You\ncan specify one listener.\n*Required*: Yes\n*Type*: Array of [VirtualGatewayListener](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayspec.html#cfn-appmesh-virtualgateway-virtualgatewayspec-listeners", "ItemType": "VirtualGatewayListener", "UpdateType": "Mutable" }, "BackendDefaults": { "Type": "VirtualGatewayBackendDefaults", "Required": false, "MarkdownDocumentation": "`BackendDefaults`\n\nA reference to an object that represents the defaults for backends.\n*Required*: No\n*Type*: [VirtualGatewayBackendDefaults](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayspec.html#cfn-appmesh-virtualgateway-virtualgatewayspec-backenddefaults", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContext": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContext`\n\nAn object that represents a Transport Layer Security (TLS) validation context.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontext.html", "Properties": { "SubjectAlternativeNames": { "Type": "SubjectAlternativeNames", "Required": false, "MarkdownDocumentation": "`SubjectAlternativeNames`\n\nA reference to an object that represents the SANs for a virtual gateway's listener's\nTransport Layer Security (TLS) validation context.\n*Required*: No\n*Type*: [SubjectAlternativeNames](./aws-properties-appmesh-virtualgateway-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontext.html#cfn-appmesh-virtualgateway-virtualgatewaytlsvalidationcontext-subjectalternativenames", "UpdateType": "Mutable" }, "Trust": { "Type": "VirtualGatewayTlsValidationContextTrust", "Required": true, "MarkdownDocumentation": "`Trust`\n\nA reference to where to retrieve the trust chain when validating a peer\u2019s Transport Layer Security (TLS)\ncertificate.\n*Required*: Yes\n*Type*: [VirtualGatewayTlsValidationContextTrust](./aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontexttrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontext.html#cfn-appmesh-virtualgateway-virtualgatewaytlsvalidationcontext-trust", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextAcmTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextAcmTrust`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certificate Manager\ncertificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextacmtrust.html", "Properties": { "CertificateAuthorityArns": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`CertificateAuthorityArns`\n\nOne or more ACM Amazon Resource Name (ARN)s.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextacmtrust.html#cfn-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextacmtrust-certificateauthorityarns", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextFileTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextFileTrust`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust for a local file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextfiletrust.html", "Properties": { "CertificateChain": { "Required": true, "MarkdownDocumentation": "`CertificateChain`\n\nThe certificate trust chain for a certificate stored on the file system of the virtual\nnode that the proxy is running on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextfiletrust.html#cfn-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextfiletrust-certificatechain", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextSdsTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextSdsTrust`\n\nAn object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service\nvalidation context trust. The proxy must be configured with a local SDS provider via a Unix\nDomain Socket. See App Mesh\n[TLS\ndocumentation](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) for more info.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextsdstrust.html", "Properties": { "SecretName": { "Required": true, "MarkdownDocumentation": "`SecretName`\n\nA reference to an object that represents the name of the secret for a virtual gateway's\nTransport Layer Security (TLS) Secret Discovery Service validation context trust.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextsdstrust.html#cfn-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextsdstrust-secretname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextTrust`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontexttrust.html", "Properties": { "SDS": { "Type": "VirtualGatewayTlsValidationContextSdsTrust", "Required": false, "MarkdownDocumentation": "`SDS`\n\nA reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery\nService validation context trust.\n*Required*: No\n*Type*: [VirtualGatewayTlsValidationContextSdsTrust](./aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextsdstrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontexttrust.html#cfn-appmesh-virtualgateway-virtualgatewaytlsvalidationcontexttrust-sds", "UpdateType": "Mutable" }, "ACM": { "Type": "VirtualGatewayTlsValidationContextAcmTrust", "Required": false, "MarkdownDocumentation": "`ACM`\n\nA reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certificate Manager certificate.\n*Required*: No\n*Type*: [VirtualGatewayTlsValidationContextAcmTrust](./aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextacmtrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontexttrust.html#cfn-appmesh-virtualgateway-virtualgatewaytlsvalidationcontexttrust-acm", "UpdateType": "Mutable" }, "File": { "Type": "VirtualGatewayTlsValidationContextFileTrust", "Required": false, "MarkdownDocumentation": "`File`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust for a local file.\n*Required*: No\n*Type*: [VirtualGatewayTlsValidationContextFileTrust](./aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontextfiletrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaytlsvalidationcontexttrust.html#cfn-appmesh-virtualgateway-virtualgatewaytlsvalidationcontexttrust-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.AccessLog": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.AccessLog`\n\nAn object that represents the access logging information for a virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-accesslog.html", "Properties": { "File": { "Type": "FileAccessLog", "Required": false, "MarkdownDocumentation": "`File`\n\nThe file object to send virtual node access logs to.\n*Required*: No\n*Type*: [FileAccessLog](./aws-properties-appmesh-virtualnode-fileaccesslog.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-accesslog.html#cfn-appmesh-virtualnode-accesslog-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute`\n\nAn object that represents the AWS Cloud Map attribute information for your\nvirtual node.\n###### Note\nAWS Cloud Map is not available in the eu-south-1 Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapinstanceattribute.html", "Properties": { "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nThe value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is\nreturned.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([a-zA-Z0-9!-~][ a-zA-Z0-9!-~]*){0,1}[a-zA-Z0-9!-~]{0,1}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapinstanceattribute.html#cfn-appmesh-virtualnode-awscloudmapinstanceattribute-value", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Key": { "Required": true, "MarkdownDocumentation": "`Key`\n\nThe name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is\nreturned.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9!-~]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapinstanceattribute.html#cfn-appmesh-virtualnode-awscloudmapinstanceattribute-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery`\n\nAn object that represents the AWS Cloud Map service discovery information for\nyour virtual node.\n###### Note\nAWS Cloud Map is not available in the eu-south-1 Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html", "Properties": { "NamespaceName": { "Required": true, "MarkdownDocumentation": "`NamespaceName`\n\nThe HTTP 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html#cfn-appmesh-virtualnode-awscloudmapservicediscovery-namespacename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ServiceName": { "Required": true, "MarkdownDocumentation": "`ServiceName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html#cfn-appmesh-virtualnode-awscloudmapservicediscovery-servicename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IpPreference": { "Required": false, "MarkdownDocumentation": "`IpPreference`\n\nThe preferred IP version that this virtual node uses. Setting the IP preference on the\nvirtual node only overrides the IP preference set for the mesh on this specific\nnode.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPv6_PREFERRED | IPv4_PREFE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html#cfn-appmesh-virtualnode-awscloudmapservicediscovery-ippreference", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Attributes": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Attributes`\n\nA string map that contains attributes with values that you can use to filter instances\nby any custom attribute that you specified when you registered the instance. Only instances\nthat match all of the specified key/value pairs will be returned.\n*Required*: No\n*Type*: Array of [AwsCloudMapInstanceAttribute](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html#cfn-appmesh-virtualnode-awscloudmapservicediscovery-attributes", "ItemType": "AwsCloudMapInstanceAttribute", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.Backend": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.Backend`\n\nAn object that represents the backends that a virtual node is expected to send outbound\ntraffic to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html", "Properties": { "VirtualService": { "Type": "VirtualServiceBackend", "Required": false, "MarkdownDocumentation": "`VirtualService`\n\nSpecifies a virtual service to use as a backend.\n*Required*: No\n*Type*: [VirtualServiceBackend](./aws-properties-appmesh-virtualnode-virtualservicebackend.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html#cfn-appmesh-virtualnode-backend-virtualservice", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.BackendDefaults": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.BackendDefaults`\n\nAn object that represents the default properties for a backend.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backenddefaults.html", "Properties": { "ClientPolicy": { "Type": "ClientPolicy", "Required": false, "MarkdownDocumentation": "`ClientPolicy`\n\nA reference to an object that represents a client policy.\n*Required*: No\n*Type*: [ClientPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backenddefaults.html#cfn-appmesh-virtualnode-backenddefaults-clientpolicy", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ClientPolicy": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ClientPolicy`\n\nAn object that represents a client policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicy.html", "Properties": { "TLS": { "Type": "ClientPolicyTls", "Required": false, "MarkdownDocumentation": "`TLS`\n\nA reference to an object that represents a Transport Layer Security (TLS) client policy.\n*Required*: No\n*Type*: [ClientPolicyTls](./aws-properties-appmesh-virtualnode-clientpolicytls.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicy.html#cfn-appmesh-virtualnode-clientpolicy-tls", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ClientPolicyTls": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ClientPolicyTls`\n\nA reference to an object that represents a Transport Layer Security (TLS) client policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html", "Properties": { "Validation": { "Type": "TlsValidationContext", "Required": true, "MarkdownDocumentation": "`Validation`\n\nA reference to an object that represents a TLS validation context.\n*Required*: Yes\n*Type*: [TlsValidationContext](./aws-properties-appmesh-virtualnode-tlsvalidationcontext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html#cfn-appmesh-virtualnode-clientpolicytls-validation", "UpdateType": "Mutable" }, "Enforce": { "Required": false, "MarkdownDocumentation": "`Enforce`\n\nWhether the policy is enforced. The default is `True`, if a value isn't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html#cfn-appmesh-virtualnode-clientpolicytls-enforce", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Ports": { "PrimitiveItemType": "Integer", "Type": "List", "Required": false, "MarkdownDocumentation": "`Ports`\n\nOne or more ports that the policy is enforced for.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html#cfn-appmesh-virtualnode-clientpolicytls-ports", "UpdateType": "Mutable" }, "Certificate": { "Type": "ClientTlsCertificate", "Required": false, "MarkdownDocumentation": "`Certificate`\n\nA reference to an object that represents a client's TLS certificate.\n*Required*: No\n*Type*: [ClientTlsCertificate](./aws-properties-appmesh-virtualnode-clienttlscertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicytls.html#cfn-appmesh-virtualnode-clientpolicytls-certificate", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ClientTlsCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ClientTlsCertificate`\n\nAn object that represents the client's certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clienttlscertificate.html", "Properties": { "SDS": { "Type": "ListenerTlsSdsCertificate", "Required": false, "MarkdownDocumentation": "`SDS`\n\nA reference to an object that represents a client's TLS Secret Discovery Service\ncertificate.\n*Required*: No\n*Type*: [ListenerTlsSdsCertificate](./aws-properties-appmesh-virtualnode-listenertlssdscertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clienttlscertificate.html#cfn-appmesh-virtualnode-clienttlscertificate-sds", "UpdateType": "Mutable" }, "File": { "Type": "ListenerTlsFileCertificate", "Required": false, "MarkdownDocumentation": "`File`\n\nAn object that represents a local file certificate. The certificate must meet specific\nrequirements and you must have proxy authorization enabled. For more information, see\n[Transport Layer Security (TLS)](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html).\n*Required*: No\n*Type*: [ListenerTlsFileCertificate](./aws-properties-appmesh-virtualnode-listenertlsfilecertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clienttlscertificate.html#cfn-appmesh-virtualnode-clienttlscertificate-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.DnsServiceDiscovery": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.DnsServiceDiscovery`\n\nAn object that represents the DNS service discovery information for your virtual\nnode.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-dnsservicediscovery.html", "Properties": { "IpPreference": { "Required": false, "MarkdownDocumentation": "`IpPreference`\n\nThe preferred IP version that this virtual node uses. Setting the IP preference on the\nvirtual node only overrides the IP preference set for the mesh on this specific\nnode.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPv6_PREFERRED | IPv4_PREFE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-dnsservicediscovery.html#cfn-appmesh-virtualnode-dnsservicediscovery-ippreference", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Hostname": { "Required": true, "MarkdownDocumentation": "`Hostname`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-dnsservicediscovery.html#cfn-appmesh-virtualnode-dnsservicediscovery-hostname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResponseType": { "Required": false, "MarkdownDocumentation": "`ResponseType`\n\nSpecifies the DNS response type for the virtual node.\n*Required*: No\n*Type*: String\n*Allowed values*: `LOADBALANCER | ENDPOINTS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOADBALANCER", "ENDPOINTS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-dnsservicediscovery.html#cfn-appmesh-virtualnode-dnsservicediscovery-responsetype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.Duration": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.Duration`\n\nAn object that represents a duration of time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-duration.html", "Properties": { "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-duration.html#cfn-appmesh-virtualnode-duration-value", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Unit": { "Required": true, "MarkdownDocumentation": "`Unit`\n\nA unit of time.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `s | ms`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "s", "ms" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-duration.html#cfn-appmesh-virtualnode-duration-unit", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.FileAccessLog": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.FileAccessLog`\n\nAn object that represents an access log file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-fileaccesslog.html", "Properties": { "Path": { "Required": true, "MarkdownDocumentation": "`Path`\n\nThe file path to write access logs to. You can use `/dev/stdout` to send\naccess logs to standard out and configure your Envoy container to use a log driver, such as\n`awslogs`, to export the access logs to a log storage service such as Amazon\nCloudWatch Logs. You can also specify a path in the Envoy container's file system to write\nthe files to disk.\n###### Note\nThe Envoy process must have write permissions to the path that you specify here.\nOtherwise, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-fileaccesslog.html#cfn-appmesh-virtualnode-fileaccesslog-path", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Format": { "Type": "LoggingFormat", "Required": false, "MarkdownDocumentation": "`Format`\n\nThe specified format for the logs. The format is either `json_format` or\n`text_format`.\n*Required*: No\n*Type*: [LoggingFormat](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-fileaccesslog.html#cfn-appmesh-virtualnode-fileaccesslog-format", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.GrpcTimeout": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.GrpcTimeout`\n\nAn object that represents types of timeouts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-grpctimeout.html", "Properties": { "PerRequest": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`PerRequest`\n\nAn 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\nresource 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\nseconds for the source and destination virtual node and the route.\n*Required*: No\n*Type*: [Duration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-grpctimeout.html#cfn-appmesh-virtualnode-grpctimeout-perrequest", "UpdateType": "Mutable" }, "Idle": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`Idle`\n\nAn 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-grpctimeout.html#cfn-appmesh-virtualnode-grpctimeout-idle", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.HealthCheck": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.HealthCheck`\n\nAn object that represents the health check policy for a virtual node's listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html", "Properties": { "Path": { "Required": false, "MarkdownDocumentation": "`Path`\n\nThe destination path for the health check request. This value is only used if the\nspecified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-path", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UnhealthyThreshold": { "Required": true, "MarkdownDocumentation": "`UnhealthyThreshold`\n\nThe number of consecutive failed health checks that must occur before declaring a\nvirtual node unhealthy.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-unhealthythreshold", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe destination port for the health check request. This port must match the port defined\nin the [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-portmapping) for the listener.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "HealthyThreshold": { "Required": true, "MarkdownDocumentation": "`HealthyThreshold`\n\nThe number of consecutive successful health checks that must occur before declaring\nlistener healthy.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-healthythreshold", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TimeoutMillis": { "Required": true, "MarkdownDocumentation": "`TimeoutMillis`\n\nThe amount of time to wait when receiving a response from the health check, in\nmilliseconds.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-timeoutmillis", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Protocol": { "Required": true, "MarkdownDocumentation": "`Protocol`\n\nThe protocol for the health check request. If you specify `grpc`, then your\nservice must conform to the [GRPC Health\nChecking Protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `http | tcp | http2 | grpc...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "http", "tcp", "http2", "grpc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-protocol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IntervalMillis": { "Required": true, "MarkdownDocumentation": "`IntervalMillis`\n\nThe time period in milliseconds between each health check execution.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-intervalmillis", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.HttpTimeout": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.HttpTimeout`\n\nAn object that represents types of timeouts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-httptimeout.html", "Properties": { "PerRequest": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`PerRequest`\n\nAn 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\nresource 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\nseconds for the source and destination virtual node and the route.\n*Required*: No\n*Type*: [Duration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-httptimeout.html#cfn-appmesh-virtualnode-httptimeout-perrequest", "UpdateType": "Mutable" }, "Idle": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`Idle`\n\nAn 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-httptimeout.html#cfn-appmesh-virtualnode-httptimeout-idle", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.JsonFormatRef": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.JsonFormatRef`\n\nAn object that represents the key value pairs for the JSON.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-jsonformatref.html", "Properties": { "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-jsonformatref.html#cfn-appmesh-virtualnode-jsonformatref-value", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Key": { "Required": true, "MarkdownDocumentation": "`Key`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-jsonformatref.html#cfn-appmesh-virtualnode-jsonformatref-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.Listener": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.Listener`\n\nAn object that represents a listener for a virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html", "Properties": { "ConnectionPool": { "Type": "VirtualNodeConnectionPool", "Required": false, "MarkdownDocumentation": "`ConnectionPool`\n\nThe connection pool information for the listener.\n*Required*: No\n*Type*: [VirtualNodeConnectionPool](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-connectionpool", "UpdateType": "Mutable" }, "Timeout": { "Type": "ListenerTimeout", "Required": false, "MarkdownDocumentation": "`Timeout`\n\nAn object that represents timeouts for different protocols.\n*Required*: No\n*Type*: [ListenerTimeout](./aws-properties-appmesh-virtualnode-listenertimeout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-timeout", "UpdateType": "Mutable" }, "HealthCheck": { "Type": "HealthCheck", "Required": false, "MarkdownDocumentation": "`HealthCheck`\n\nThe health check information for the listener.\n*Required*: No\n*Type*: [HealthCheck](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-healthcheck", "UpdateType": "Mutable" }, "TLS": { "Type": "ListenerTls", "Required": false, "MarkdownDocumentation": "`TLS`\n\nA reference to an object that represents the Transport Layer Security (TLS) properties for a listener.\n*Required*: No\n*Type*: [ListenerTls](./aws-properties-appmesh-virtualnode-listenertls.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-tls", "UpdateType": "Mutable" }, "PortMapping": { "Type": "PortMapping", "Required": true, "MarkdownDocumentation": "`PortMapping`\n\nThe port mapping information for the listener.\n*Required*: Yes\n*Type*: [PortMapping](./aws-properties-appmesh-virtualnode-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-portmapping", "UpdateType": "Mutable" }, "OutlierDetection": { "Type": "OutlierDetection", "Required": false, "MarkdownDocumentation": "`OutlierDetection`\n\nThe outlier detection information for the listener.\n*Required*: No\n*Type*: [OutlierDetection](./aws-properties-appmesh-virtualnode-outlierdetection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html#cfn-appmesh-virtualnode-listener-outlierdetection", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ListenerTimeout": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ListenerTimeout`\n\nAn object that represents timeouts for different protocols.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertimeout.html", "Properties": { "TCP": { "Type": "TcpTimeout", "Required": false, "MarkdownDocumentation": "`TCP`\n\nAn object that represents types of timeouts.\n*Required*: No\n*Type*: [TcpTimeout](./aws-properties-appmesh-virtualnode-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertimeout.html#cfn-appmesh-virtualnode-listenertimeout-tcp", "UpdateType": "Mutable" }, "HTTP2": { "Type": "HttpTimeout", "Required": false, "MarkdownDocumentation": "`HTTP2`\n\nAn object that represents types of timeouts.\n*Required*: No\n*Type*: [HttpTimeout](./aws-properties-appmesh-virtualnode-httptimeout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertimeout.html#cfn-appmesh-virtualnode-listenertimeout-http2", "UpdateType": "Mutable" }, "HTTP": { "Type": "HttpTimeout", "Required": false, "MarkdownDocumentation": "`HTTP`\n\nAn object that represents types of timeouts.\n*Required*: No\n*Type*: [HttpTimeout](./aws-properties-appmesh-virtualnode-httptimeout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertimeout.html#cfn-appmesh-virtualnode-listenertimeout-http", "UpdateType": "Mutable" }, "GRPC": { "Type": "GrpcTimeout", "Required": false, "MarkdownDocumentation": "`GRPC`\n\nAn object that represents types of timeouts.\n*Required*: No\n*Type*: [GrpcTimeout](./aws-properties-appmesh-virtualnode-grpctimeout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertimeout.html#cfn-appmesh-virtualnode-listenertimeout-grpc", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ListenerTls": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ListenerTls`\n\nAn object that represents the Transport Layer Security (TLS) properties for a listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertls.html", "Properties": { "Validation": { "Type": "ListenerTlsValidationContext", "Required": false, "MarkdownDocumentation": "`Validation`\n\nA reference to an object that represents a listener's Transport Layer Security (TLS) validation context.\n*Required*: No\n*Type*: [ListenerTlsValidationContext](./aws-properties-appmesh-virtualnode-listenertlsvalidationcontext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertls.html#cfn-appmesh-virtualnode-listenertls-validation", "UpdateType": "Mutable" }, "Mode": { "Required": true, "MarkdownDocumentation": "`Mode`\n\nSpecify one of the following modes.\n* STRICT \u2013 Listener only accepts connections with TLS\n enabled.\n* PERMISSIVE \u2013 Listener accepts connections with or\n without TLS enabled.\n* DISABLED \u2013 Listener only accepts connections without\n TLS.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRICT | PERMISSIVE | DISAB...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRICT", "PERMISSIVE", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertls.html#cfn-appmesh-virtualnode-listenertls-mode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Certificate": { "Type": "ListenerTlsCertificate", "Required": true, "MarkdownDocumentation": "`Certificate`\n\nA reference to an object that represents a listener's Transport Layer Security (TLS) certificate.\n*Required*: Yes\n*Type*: [ListenerTlsCertificate](./aws-properties-appmesh-virtualnode-listenertlscertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertls.html#cfn-appmesh-virtualnode-listenertls-certificate", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ListenerTlsAcmCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ListenerTlsAcmCertificate`\n\nAn object that represents an AWS Certificate Manager certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsacmcertificate.html", "Properties": { "CertificateArn": { "Required": true, "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see [Transport Layer Security (TLS)](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsacmcertificate.html#cfn-appmesh-virtualnode-listenertlsacmcertificate-certificatearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ListenerTlsCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ListenerTlsCertificate`\n\nAn object that represents a listener's Transport Layer Security (TLS) certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlscertificate.html", "Properties": { "SDS": { "Type": "ListenerTlsSdsCertificate", "Required": false, "MarkdownDocumentation": "`SDS`\n\nA reference to an object that represents a listener's Secret Discovery Service\ncertificate.\n*Required*: No\n*Type*: [ListenerTlsSdsCertificate](./aws-properties-appmesh-virtualnode-listenertlssdscertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlscertificate.html#cfn-appmesh-virtualnode-listenertlscertificate-sds", "UpdateType": "Mutable" }, "ACM": { "Type": "ListenerTlsAcmCertificate", "Required": false, "MarkdownDocumentation": "`ACM`\n\nA reference to an object that represents an AWS Certificate Manager certificate.\n*Required*: No\n*Type*: [ListenerTlsAcmCertificate](./aws-properties-appmesh-virtualnode-listenertlsacmcertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlscertificate.html#cfn-appmesh-virtualnode-listenertlscertificate-acm", "UpdateType": "Mutable" }, "File": { "Type": "ListenerTlsFileCertificate", "Required": false, "MarkdownDocumentation": "`File`\n\nA reference to an object that represents a local file certificate.\n*Required*: No\n*Type*: [ListenerTlsFileCertificate](./aws-properties-appmesh-virtualnode-listenertlsfilecertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlscertificate.html#cfn-appmesh-virtualnode-listenertlscertificate-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ListenerTlsFileCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ListenerTlsFileCertificate`\n\nAn object that represents a local file certificate.\nThe certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see [Transport Layer Security (TLS)](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsfilecertificate.html", "Properties": { "PrivateKey": { "Required": true, "MarkdownDocumentation": "`PrivateKey`\n\nThe private key for a certificate stored on the file system of the virtual node that the\nproxy is running on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsfilecertificate.html#cfn-appmesh-virtualnode-listenertlsfilecertificate-privatekey", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CertificateChain": { "Required": true, "MarkdownDocumentation": "`CertificateChain`\n\nThe certificate chain for the certificate.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsfilecertificate.html#cfn-appmesh-virtualnode-listenertlsfilecertificate-certificatechain", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ListenerTlsSdsCertificate": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ListenerTlsSdsCertificate`\n\nAn object that represents the listener's Secret Discovery Service certificate. The proxy\nmust be configured with a local SDS provider via a Unix Domain Socket. See App Mesh\n[TLS\ndocumentation](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) for more info.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlssdscertificate.html", "Properties": { "SecretName": { "Required": true, "MarkdownDocumentation": "`SecretName`\n\nA reference to an object that represents the name of the secret requested from the\nSecret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or\ncertificate chain.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlssdscertificate.html#cfn-appmesh-virtualnode-listenertlssdscertificate-secretname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ListenerTlsValidationContext": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ListenerTlsValidationContext`\n\nAn object that represents a listener's Transport Layer Security (TLS) validation context.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsvalidationcontext.html", "Properties": { "SubjectAlternativeNames": { "Type": "SubjectAlternativeNames", "Required": false, "MarkdownDocumentation": "`SubjectAlternativeNames`\n\nA reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation\ncontext.\n*Required*: No\n*Type*: [SubjectAlternativeNames](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsvalidationcontext.html#cfn-appmesh-virtualnode-listenertlsvalidationcontext-subjectalternativenames", "UpdateType": "Mutable" }, "Trust": { "Type": "ListenerTlsValidationContextTrust", "Required": true, "MarkdownDocumentation": "`Trust`\n\nA reference to where to retrieve the trust chain when validating a peer\u2019s Transport Layer Security (TLS)\ncertificate.\n*Required*: Yes\n*Type*: [ListenerTlsValidationContextTrust](./aws-properties-appmesh-virtualnode-listenertlsvalidationcontexttrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsvalidationcontext.html#cfn-appmesh-virtualnode-listenertlsvalidationcontext-trust", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ListenerTlsValidationContextTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ListenerTlsValidationContextTrust`\n\nAn object that represents a listener's Transport Layer Security (TLS) validation context trust.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsvalidationcontexttrust.html", "Properties": { "SDS": { "Type": "TlsValidationContextSdsTrust", "Required": false, "MarkdownDocumentation": "`SDS`\n\nA reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service\nvalidation context trust.\n*Required*: No\n*Type*: [TlsValidationContextSdsTrust](./aws-properties-appmesh-virtualnode-tlsvalidationcontextsdstrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsvalidationcontexttrust.html#cfn-appmesh-virtualnode-listenertlsvalidationcontexttrust-sds", "UpdateType": "Mutable" }, "File": { "Type": "TlsValidationContextFileTrust", "Required": false, "MarkdownDocumentation": "`File`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust for a local file.\n*Required*: No\n*Type*: [TlsValidationContextFileTrust](./aws-properties-appmesh-virtualnode-tlsvalidationcontextfiletrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listenertlsvalidationcontexttrust.html#cfn-appmesh-virtualnode-listenertlsvalidationcontexttrust-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.Logging": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.Logging`\n\nAn object that represents the logging information for a virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-logging.html", "Properties": { "AccessLog": { "Type": "AccessLog", "Required": false, "MarkdownDocumentation": "`AccessLog`\n\nThe access log configuration for a virtual node.\n*Required*: No\n*Type*: [AccessLog](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-logging.html#cfn-appmesh-virtualnode-logging-accesslog", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.LoggingFormat": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.LoggingFormat`\n\nAn object that represents the format for the logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-loggingformat.html", "Properties": { "Text": { "Required": false, "MarkdownDocumentation": "`Text`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-loggingformat.html#cfn-appmesh-virtualnode-loggingformat-text", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Json": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Json`\n\nThe logging format for JSON.\n*Required*: No\n*Type*: Array of [JsonFormatRef](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-loggingformat.html#cfn-appmesh-virtualnode-loggingformat-json", "ItemType": "JsonFormatRef", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.OutlierDetection": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.OutlierDetection`\n\nAn object that represents the outlier detection for a virtual node's listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-outlierdetection.html", "Properties": { "MaxEjectionPercent": { "Required": true, "MarkdownDocumentation": "`MaxEjectionPercent`\n\nMaximum percentage of hosts in load balancing pool for upstream service that can be\nejected. Will eject at least one host regardless of the value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-outlierdetection.html#cfn-appmesh-virtualnode-outlierdetection-maxejectionpercent", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "BaseEjectionDuration": { "Type": "Duration", "Required": true, "MarkdownDocumentation": "`BaseEjectionDuration`\n\nThe base amount of time for which a host is ejected.\n*Required*: Yes\n*Type*: [Duration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-outlierdetection.html#cfn-appmesh-virtualnode-outlierdetection-baseejectionduration", "UpdateType": "Mutable" }, "MaxServerErrors": { "Required": true, "MarkdownDocumentation": "`MaxServerErrors`\n\nNumber of consecutive `5xx` errors required for ejection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-outlierdetection.html#cfn-appmesh-virtualnode-outlierdetection-maxservererrors", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Interval": { "Type": "Duration", "Required": true, "MarkdownDocumentation": "`Interval`\n\nThe time interval between ejection sweep analysis.\n*Required*: Yes\n*Type*: [Duration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-outlierdetection.html#cfn-appmesh-virtualnode-outlierdetection-interval", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.PortMapping": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.PortMapping`\n\nAn object representing a virtual node or virtual router listener port mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-portmapping.html", "Properties": { "Port": { "Required": true, "MarkdownDocumentation": "`Port`\n\nThe port used for the port mapping.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-portmapping.html#cfn-appmesh-virtualnode-portmapping-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Protocol": { "Required": true, "MarkdownDocumentation": "`Protocol`\n\nThe protocol used for the port mapping. Specify `http`, `http2`,\n`grpc`, or `tcp`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `http | tcp | http2 | grpc...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "http", "tcp", "http2", "grpc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-portmapping.html#cfn-appmesh-virtualnode-portmapping-protocol", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.ServiceDiscovery": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.ServiceDiscovery`\n\nAn object that represents the service discovery information for a virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-servicediscovery.html", "Properties": { "DNS": { "Type": "DnsServiceDiscovery", "Required": false, "MarkdownDocumentation": "`DNS`\n\nSpecifies the DNS information for the virtual node.\n*Required*: No\n*Type*: [DnsServiceDiscovery](./aws-properties-appmesh-virtualnode-dnsservicediscovery.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-servicediscovery.html#cfn-appmesh-virtualnode-servicediscovery-dns", "UpdateType": "Mutable" }, "AWSCloudMap": { "Type": "AwsCloudMapServiceDiscovery", "Required": false, "MarkdownDocumentation": "`AWSCloudMap`\n\nSpecifies any AWS Cloud Map information for the virtual node.\n*Required*: No\n*Type*: [AwsCloudMapServiceDiscovery](./aws-properties-appmesh-virtualnode-awscloudmapservicediscovery.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-servicediscovery.html#cfn-appmesh-virtualnode-servicediscovery-awscloudmap", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.SubjectAlternativeNameMatchers": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.SubjectAlternativeNameMatchers`\n\nAn object that represents the methods by which a subject alternative name on a peer\nTransport Layer Security (TLS) certificate can be matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenamematchers.html", "Properties": { "Exact": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Exact`\n\nThe values sent must match the specified values exactly.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenamematchers.html#cfn-appmesh-virtualnode-subjectalternativenamematchers-exact", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.SubjectAlternativeNames": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.SubjectAlternativeNames`\n\nAn object that represents the subject alternative names secured by the\ncertificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenames.html", "Properties": { "Match": { "Type": "SubjectAlternativeNameMatchers", "Required": true, "MarkdownDocumentation": "`Match`\n\nAn object that represents the criteria for determining a SANs match.\n*Required*: Yes\n*Type*: [SubjectAlternativeNameMatchers](./aws-properties-appmesh-virtualnode-subjectalternativenamematchers.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenames.html#cfn-appmesh-virtualnode-subjectalternativenames-match", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.TcpTimeout": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.TcpTimeout`\n\nAn object that represents types of timeouts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tcptimeout.html", "Properties": { "Idle": { "Type": "Duration", "Required": false, "MarkdownDocumentation": "`Idle`\n\nAn 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tcptimeout.html#cfn-appmesh-virtualnode-tcptimeout-idle", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.TlsValidationContext": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.TlsValidationContext`\n\nAn object that represents how the proxy will validate its peer during Transport Layer Security (TLS)\nnegotiation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontext.html", "Properties": { "SubjectAlternativeNames": { "Type": "SubjectAlternativeNames", "Required": false, "MarkdownDocumentation": "`SubjectAlternativeNames`\n\nA reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you\ndon't specify SANs on the *terminating* mesh endpoint, the Envoy proxy\nfor that node doesn't verify the SAN on a peer client certificate. If you don't specify\nSANs on the *originating* mesh endpoint, the SAN on the certificate\nprovided by the terminating endpoint must match the mesh endpoint service discovery\nconfiguration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the\nSAN since the name doesn't match the service discovery name.\n*Required*: No\n*Type*: [SubjectAlternativeNames](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontext.html#cfn-appmesh-virtualnode-tlsvalidationcontext-subjectalternativenames", "UpdateType": "Mutable" }, "Trust": { "Type": "TlsValidationContextTrust", "Required": true, "MarkdownDocumentation": "`Trust`\n\nA reference to where to retrieve the trust chain when validating a peer\u2019s Transport Layer Security (TLS)\ncertificate.\n*Required*: Yes\n*Type*: [TlsValidationContextTrust](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontext.html#cfn-appmesh-virtualnode-tlsvalidationcontext-trust", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.TlsValidationContextAcmTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.TlsValidationContextAcmTrust`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certificate Manager\ncertificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextacmtrust.html", "Properties": { "CertificateAuthorityArns": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`CertificateAuthorityArns`\n\nOne or more ACM Amazon Resource Name (ARN)s.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextacmtrust.html#cfn-appmesh-virtualnode-tlsvalidationcontextacmtrust-certificateauthorityarns", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.TlsValidationContextFileTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.TlsValidationContextFileTrust`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust for a local file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextfiletrust.html", "Properties": { "CertificateChain": { "Required": true, "MarkdownDocumentation": "`CertificateChain`\n\nThe certificate trust chain for a certificate stored on the file system of the virtual\nnode that the proxy is running on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextfiletrust.html#cfn-appmesh-virtualnode-tlsvalidationcontextfiletrust-certificatechain", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.TlsValidationContextSdsTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.TlsValidationContextSdsTrust`\n\nAn object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. The\nproxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh\n[TLS\ndocumentation](https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) for more info.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextsdstrust.html", "Properties": { "SecretName": { "Required": true, "MarkdownDocumentation": "`SecretName`\n\nA reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret\nDiscovery Service validation context trust.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontextsdstrust.html#cfn-appmesh-virtualnode-tlsvalidationcontextsdstrust-secretname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.TlsValidationContextTrust": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.TlsValidationContextTrust`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontexttrust.html", "Properties": { "SDS": { "Type": "TlsValidationContextSdsTrust", "Required": false, "MarkdownDocumentation": "`SDS`\n\nA reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation\ncontext trust.\n*Required*: No\n*Type*: [TlsValidationContextSdsTrust](./aws-properties-appmesh-virtualnode-tlsvalidationcontextsdstrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontexttrust.html#cfn-appmesh-virtualnode-tlsvalidationcontexttrust-sds", "UpdateType": "Mutable" }, "ACM": { "Type": "TlsValidationContextAcmTrust", "Required": false, "MarkdownDocumentation": "`ACM`\n\nA reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certificate Manager certificate.\n*Required*: No\n*Type*: [TlsValidationContextAcmTrust](./aws-properties-appmesh-virtualnode-tlsvalidationcontextacmtrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontexttrust.html#cfn-appmesh-virtualnode-tlsvalidationcontexttrust-acm", "UpdateType": "Mutable" }, "File": { "Type": "TlsValidationContextFileTrust", "Required": false, "MarkdownDocumentation": "`File`\n\nAn object that represents a Transport Layer Security (TLS) validation context trust for a local file.\n*Required*: No\n*Type*: [TlsValidationContextFileTrust](./aws-properties-appmesh-virtualnode-tlsvalidationcontextfiletrust.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontexttrust.html#cfn-appmesh-virtualnode-tlsvalidationcontexttrust-file", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.VirtualNodeConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.VirtualNodeConnectionPool`\n\nAn object that represents the type of virtual node connection pool.\nOnly one protocol is used at a time and should be the same protocol as the one chosen\nunder port mapping.\nIf not present the default value for `maxPendingRequests` is\n`2147483647`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodeconnectionpool.html", "Properties": { "TCP": { "Type": "VirtualNodeTcpConnectionPool", "Required": false, "MarkdownDocumentation": "`TCP`\n\nAn object that represents a type of connection pool.\n*Required*: No\n*Type*: [VirtualNodeTcpConnectionPool](./aws-properties-appmesh-virtualnode-virtualnodetcpconnectionpool.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodeconnectionpool.html#cfn-appmesh-virtualnode-virtualnodeconnectionpool-tcp", "UpdateType": "Mutable" }, "HTTP2": { "Type": "VirtualNodeHttp2ConnectionPool", "Required": false, "MarkdownDocumentation": "`HTTP2`\n\nAn object that represents a type of connection pool.\n*Required*: No\n*Type*: [VirtualNodeHttp2ConnectionPool](./aws-properties-appmesh-virtualnode-virtualnodehttp2connectionpool.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodeconnectionpool.html#cfn-appmesh-virtualnode-virtualnodeconnectionpool-http2", "UpdateType": "Mutable" }, "HTTP": { "Type": "VirtualNodeHttpConnectionPool", "Required": false, "MarkdownDocumentation": "`HTTP`\n\nAn object that represents a type of connection pool.\n*Required*: No\n*Type*: [VirtualNodeHttpConnectionPool](./aws-properties-appmesh-virtualnode-virtualnodehttpconnectionpool.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodeconnectionpool.html#cfn-appmesh-virtualnode-virtualnodeconnectionpool-http", "UpdateType": "Mutable" }, "GRPC": { "Type": "VirtualNodeGrpcConnectionPool", "Required": false, "MarkdownDocumentation": "`GRPC`\n\nAn object that represents a type of connection pool.\n*Required*: No\n*Type*: [VirtualNodeGrpcConnectionPool](./aws-properties-appmesh-virtualnode-virtualnodegrpcconnectionpool.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodeconnectionpool.html#cfn-appmesh-virtualnode-virtualnodeconnectionpool-grpc", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.VirtualNodeGrpcConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.VirtualNodeGrpcConnectionPool`\n\nAn object that represents a type of connection pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodegrpcconnectionpool.html", "Properties": { "MaxRequests": { "Required": true, "MarkdownDocumentation": "`MaxRequests`\n\nMaximum number of inflight requests Envoy can concurrently support across hosts in\nupstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodegrpcconnectionpool.html#cfn-appmesh-virtualnode-virtualnodegrpcconnectionpool-maxrequests", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.VirtualNodeHttp2ConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.VirtualNodeHttp2ConnectionPool`\n\nAn object that represents a type of connection pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodehttp2connectionpool.html", "Properties": { "MaxRequests": { "Required": true, "MarkdownDocumentation": "`MaxRequests`\n\nMaximum number of inflight requests Envoy can concurrently support across hosts in\nupstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodehttp2connectionpool.html#cfn-appmesh-virtualnode-virtualnodehttp2connectionpool-maxrequests", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.VirtualNodeHttpConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.VirtualNodeHttpConnectionPool`\n\nAn object that represents a type of connection pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodehttpconnectionpool.html", "Properties": { "MaxConnections": { "Required": true, "MarkdownDocumentation": "`MaxConnections`\n\nMaximum number of outbound TCP connections Envoy can establish concurrently with all\nhosts in upstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodehttpconnectionpool.html#cfn-appmesh-virtualnode-virtualnodehttpconnectionpool-maxconnections", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MaxPendingRequests": { "Required": false, "MarkdownDocumentation": "`MaxPendingRequests`\n\nNumber of overflowing requests after `max_connections` Envoy will queue to\nupstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodehttpconnectionpool.html#cfn-appmesh-virtualnode-virtualnodehttpconnectionpool-maxpendingrequests", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.VirtualNodeSpec": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.VirtualNodeSpec`\n\nAn object that represents the specification of a virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html", "Properties": { "Logging": { "Type": "Logging", "Required": false, "MarkdownDocumentation": "`Logging`\n\nThe inbound and outbound access logging information for the virtual node.\n*Required*: No\n*Type*: [Logging](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-logging", "UpdateType": "Mutable" }, "Backends": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Backends`\n\nThe backends that the virtual node is expected to send outbound traffic to.\n###### Important\nApp Mesh doesn't validate the existence of those virtual services specified in\nbackends. This is to prevent a cyclic dependency between virtual nodes and virtual\nservices creation. Make sure the virtual service name is correct. The virtual service\ncan be created afterwards if it doesn't already exist.\n*Required*: No\n*Type*: Array of [Backend](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-backends", "ItemType": "Backend", "UpdateType": "Mutable" }, "Listeners": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Listeners`\n\nThe listener that the virtual node is expected to receive inbound traffic from. You can\nspecify one listener.\n*Required*: No\n*Type*: Array of [Listener](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-listeners", "ItemType": "Listener", "UpdateType": "Mutable" }, "BackendDefaults": { "Type": "BackendDefaults", "Required": false, "MarkdownDocumentation": "`BackendDefaults`\n\nA reference to an object that represents the defaults for backends.\n*Required*: No\n*Type*: [BackendDefaults](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-backenddefaults", "UpdateType": "Mutable" }, "ServiceDiscovery": { "Type": "ServiceDiscovery", "Required": false, "MarkdownDocumentation": "`ServiceDiscovery`\n\nThe service discovery information for the virtual node. If your virtual node does not\nexpect ingress traffic, you can omit this parameter. If you specify a\n`listener`, then you must specify service discovery information.\n*Required*: No\n*Type*: [ServiceDiscovery](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodespec.html#cfn-appmesh-virtualnode-virtualnodespec-servicediscovery", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.VirtualNodeTcpConnectionPool": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.VirtualNodeTcpConnectionPool`\n\nAn object that represents a type of connection pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodetcpconnectionpool.html", "Properties": { "MaxConnections": { "Required": true, "MarkdownDocumentation": "`MaxConnections`\n\nMaximum number of outbound TCP connections Envoy can establish concurrently with all\nhosts in upstream cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodetcpconnectionpool.html#cfn-appmesh-virtualnode-virtualnodetcpconnectionpool-maxconnections", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode.VirtualServiceBackend": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode.VirtualServiceBackend`\n\nAn object that represents a virtual service backend for a virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualservicebackend.html", "Properties": { "ClientPolicy": { "Type": "ClientPolicy", "Required": false, "MarkdownDocumentation": "`ClientPolicy`\n\nA reference to an object that represents the client policy for a backend.\n*Required*: No\n*Type*: [ClientPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualservicebackend.html#cfn-appmesh-virtualnode-virtualservicebackend-clientpolicy", "UpdateType": "Mutable" }, "VirtualServiceName": { "Required": true, "MarkdownDocumentation": "`VirtualServiceName`\n\nThe name of the virtual service that is acting as a virtual node backend.\n###### Important\nApp Mesh doesn't validate the existence of those virtual services specified in\nbackends. This is to prevent a cyclic dependency between virtual nodes and virtual\nservices creation. Make sure the virtual service name is correct. The virtual service\ncan 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualservicebackend.html#cfn-appmesh-virtualnode-virtualservicebackend-virtualservicename", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualRouter.PortMapping": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualRouter.PortMapping`\n\nAn object representing a virtual router listener port mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html", "Properties": { "Port": { "Required": true, "MarkdownDocumentation": "`Port`\n\nThe port used for the port mapping.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html#cfn-appmesh-virtualrouter-portmapping-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Protocol": { "Required": true, "MarkdownDocumentation": "`Protocol`\n\nThe protocol used for the port mapping. Specify one protocol.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `http | tcp | http2 | grpc...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "http", "tcp", "http2", "grpc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html#cfn-appmesh-virtualrouter-portmapping-protocol", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualRouter.VirtualRouterListener": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualRouter.VirtualRouterListener`\n\nAn object that represents a virtual router listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html", "Properties": { "PortMapping": { "Type": "PortMapping", "Required": true, "MarkdownDocumentation": "`PortMapping`\n\nThe port mapping information for the listener.\n*Required*: Yes\n*Type*: [PortMapping](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html#cfn-appmesh-virtualrouter-virtualrouterlistener-portmapping", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualRouter.VirtualRouterSpec": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualRouter.VirtualRouterSpec`\n\nAn object that represents the specification of a virtual router.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterspec.html", "Properties": { "Listeners": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Listeners`\n\nThe listeners that the virtual router is expected to receive inbound traffic\nfrom.\n*Required*: Yes\n*Type*: Array of [VirtualRouterListener](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterspec.html#cfn-appmesh-virtualrouter-virtualrouterspec-listeners", "ItemType": "VirtualRouterListener", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualService.VirtualNodeServiceProvider": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualService.VirtualNodeServiceProvider`\n\nAn object that represents a virtual node service provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualnodeserviceprovider.html", "Properties": { "VirtualNodeName": { "Required": true, "MarkdownDocumentation": "`VirtualNodeName`\n\nThe name of the virtual node that is acting as a service provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualnodeserviceprovider.html#cfn-appmesh-virtualservice-virtualnodeserviceprovider-virtualnodename", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualService.VirtualRouterServiceProvider": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualService.VirtualRouterServiceProvider`\n\nAn object that represents a virtual node service provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualrouterserviceprovider.html", "Properties": { "VirtualRouterName": { "Required": true, "MarkdownDocumentation": "`VirtualRouterName`\n\nThe name of the virtual router that is acting as a service provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualrouterserviceprovider.html#cfn-appmesh-virtualservice-virtualrouterserviceprovider-virtualroutername", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualService.VirtualServiceProvider": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualService.VirtualServiceProvider`\n\nAn object that represents the provider for a virtual service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html", "Properties": { "VirtualNode": { "Type": "VirtualNodeServiceProvider", "Required": false, "MarkdownDocumentation": "`VirtualNode`\n\nThe virtual node associated with a virtual service.\n*Required*: No\n*Type*: [VirtualNodeServiceProvider](./aws-properties-appmesh-virtualservice-virtualnodeserviceprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html#cfn-appmesh-virtualservice-virtualserviceprovider-virtualnode", "UpdateType": "Mutable" }, "VirtualRouter": { "Type": "VirtualRouterServiceProvider", "Required": false, "MarkdownDocumentation": "`VirtualRouter`\n\nThe virtual router associated with a virtual service.\n*Required*: No\n*Type*: [VirtualRouterServiceProvider](./aws-properties-appmesh-virtualservice-virtualrouterserviceprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html#cfn-appmesh-virtualservice-virtualserviceprovider-virtualrouter", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualService.VirtualServiceSpec": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualService.VirtualServiceSpec`\n\nAn object that represents the specification of a virtual service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualservicespec.html", "Properties": { "Provider": { "Type": "VirtualServiceProvider", "Required": false, "MarkdownDocumentation": "`Provider`\n\nThe App Mesh object that is acting as the provider for a virtual service. You\ncan specify a single virtual node or virtual router.\n*Required*: No\n*Type*: [VirtualServiceProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualservicespec.html#cfn-appmesh-virtualservice-virtualservicespec-provider", "UpdateType": "Mutable" } } }, "AWS::AppRunner::ObservabilityConfiguration.TraceConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::ObservabilityConfiguration.TraceConfiguration`\n\nDescribes the configuration of the tracing feature within an AWS App Runner observability configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-observabilityconfiguration-traceconfiguration.html", "Properties": { "Vendor": { "MarkdownDocumentation": "`Vendor`\n\nThe 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)\n", "RefReturnValue": "", "AllowedValues": [ "AWSXRAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-observabilityconfiguration-traceconfiguration.html#cfn-apprunner-observabilityconfiguration-traceconfiguration-vendor", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.AuthenticationConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.AuthenticationConfiguration`\n\nDescribes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html", "Properties": { "AccessRoleArn": { "MarkdownDocumentation": "`AccessRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories\n(but not for ECR Public repositories).\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::[0-9]{12}:role/[\\w+=,.@-]{1,64}`\n*Minimum*: `29`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html#cfn-apprunner-service-authenticationconfiguration-accessrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionArn": { "MarkdownDocumentation": "`ConnectionArn`\n\nThe Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code\nrepositories.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html#cfn-apprunner-service-authenticationconfiguration-connectionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.CodeConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.CodeConfiguration`\n\nDescribes the configuration that AWS App Runner uses to build and run an App Runner service from a source code repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html", "Properties": { "ConfigurationSource": { "MarkdownDocumentation": "`ConfigurationSource`\n\nThe 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\n ignores `CodeConfigurationValues`.\n* `API` \u2013 App Runner uses configuration values provided in `CodeConfigurationValues` and ignores the\n `apprunner.yaml` file in the source code repository.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `REPOSITORY | API...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REPOSITORY", "API" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html#cfn-apprunner-service-codeconfiguration-configurationsource", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CodeConfigurationValues": { "MarkdownDocumentation": "`CodeConfigurationValues`\n\nThe basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a\n`apprunner.yaml` file in the source code repository (or ignoring the file if it exists).\n*Required*: No\n*Type*: [CodeConfigurationValues](./aws-properties-apprunner-service-codeconfigurationvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html#cfn-apprunner-service-codeconfiguration-codeconfigurationvalues", "UpdateType": "Mutable", "Required": false, "Type": "CodeConfigurationValues" } } }, "AWS::AppRunner::Service.CodeConfigurationValues": { "MarkdownDocumentation": "`AWS::AppRunner::Service.CodeConfigurationValues`\n\nDescribes the basic configuration needed for building and running an AWS App Runner service. This type doesn't support the full set of possible\nconfiguration options. Fur full configuration capabilities, use a `apprunner.yaml` file in the source code repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html", "Properties": { "RuntimeEnvironmentSecrets": { "MarkdownDocumentation": "`RuntimeEnvironmentSecrets`\n\nAn array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported\nvalues 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\nParameter Store.\n###### Note\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\n 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*: Array of [KeyValuePair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentsecrets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValuePair", "DuplicatesAllowed": true }, "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nA runtime environment type for building and running an App Runner service.\nIt represents a\nprogramming language runtime.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PYTHON_3 | NODEJS_12 | NODE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PYTHON_3", "NODEJS_12", "NODEJS_14", "CORRETTO_8", "CORRETTO_11", "NODEJS_16", "GO_1", "DOTNET_6", "PHP_81", "RUBY_31", "PYTHON_311", "NODEJS_18", "NODEJS_22" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StartCommand": { "MarkdownDocumentation": "`StartCommand`\n\nThe command App Runner runs to start your\napplication.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-startcommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuntimeEnvironmentVariables": { "MarkdownDocumentation": "`RuntimeEnvironmentVariables`\n\nThe environment variables that are available to your running AWS App Runner service. An array of key-value pairs.\n*Required*: No\n*Type*: Array of [KeyValuePair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValuePair", "DuplicatesAllowed": true }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port that your application listens to in the container.\nDefault: `8080`\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `0`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BuildCommand": { "MarkdownDocumentation": "`BuildCommand`\n\nThe command App Runner runs to build your\napplication.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-buildcommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.CodeRepository": { "MarkdownDocumentation": "`AWS::AppRunner::Service.CodeRepository`\n\nDescribes a source code repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html", "Properties": { "SourceCodeVersion": { "MarkdownDocumentation": "`SourceCodeVersion`\n\nThe version that should be used within the source code repository.\n*Required*: Yes\n*Type*: [SourceCodeVersion](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-sourcecodeversion", "UpdateType": "Mutable", "Required": true, "Type": "SourceCodeVersion" }, "CodeConfiguration": { "MarkdownDocumentation": "`CodeConfiguration`\n\nConfiguration for building and running the service from a source code repository.\n###### Note\n`CodeConfiguration` is required only for `CreateService` request.\n*Required*: No\n*Type*: [CodeConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-codeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CodeConfiguration" }, "SourceDirectory": { "MarkdownDocumentation": "`SourceDirectory`\n\nThe path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute\nfrom root and, if not specified, defaults to the repository root.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\x00]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-sourcedirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RepositoryUrl": { "MarkdownDocumentation": "`RepositoryUrl`\n\nThe location of the repository that contains the source code.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `0`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-repositoryurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.EgressConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.EgressConfiguration`\n\nDescribes configuration settings related to outbound network traffic of an AWS App Runner service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html", "Properties": { "VpcConnectorArn": { "MarkdownDocumentation": "`VpcConnectorArn`\n\nThe Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when `EgressType =\nVPC`.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}`\n*Minimum*: `44`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html#cfn-apprunner-service-egressconfiguration-vpcconnectorarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EgressType": { "MarkdownDocumentation": "`EgressType`\n\nThe type of egress configuration.\nSet to `DEFAULT` for access to resources hosted on public networks.\nSet to `VPC` to associate your service to a custom VPC specified by `VpcConnectorArn`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEFAULT | VPC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "VPC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html#cfn-apprunner-service-egressconfiguration-egresstype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.EncryptionConfiguration`\n\nDescribes a custom encryption key that AWS App Runner uses to encrypt copies of the source repository and service logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-encryptionconfiguration.html", "Properties": { "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nThe ARN of the KMS key that's used for encryption.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:kms:[a-z\\-]+-[0-9]{1}:[0-9]{12}:key\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-encryptionconfiguration.html#cfn-apprunner-service-encryptionconfiguration-kmskey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.HealthCheckConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.HealthCheckConfiguration`\n\nDescribes the settings for the health check that AWS App Runner performs to monitor the health of a service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe URL that health check requests are sent to.\n`Path` is only applicable when you set `Protocol` to `HTTP`.\nDefault: `\"/\"`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UnhealthyThreshold": { "MarkdownDocumentation": "`UnhealthyThreshold`\n\nThe number of consecutive checks that must fail before App Runner decides that the service is unhealthy.\nDefault: `5`\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-unhealthythreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nThe time, in seconds, to wait for a health check response before deciding it failed.\nDefault: `2`\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-timeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HealthyThreshold": { "MarkdownDocumentation": "`HealthyThreshold`\n\nThe number of consecutive checks that must succeed before App Runner decides that the service is healthy.\nDefault: `1`\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-healthythreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe IP protocol that App Runner uses to perform health checks for your service.\nIf you set `Protocol` to `HTTP`, App Runner sends health check requests to the HTTP path specified by `Path`.\nDefault: `TCP`\n*Required*: No\n*Type*: String\n*Allowed values*: `TCP | HTTP`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "TCP", "HTTP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interval": { "MarkdownDocumentation": "`Interval`\n\nThe time interval, in seconds, between health checks.\nDefault: `5`\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-interval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AppRunner::Service.ImageConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.ImageConfiguration`\n\nDescribes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html", "Properties": { "RuntimeEnvironmentSecrets": { "MarkdownDocumentation": "`RuntimeEnvironmentSecrets`\n\nAn array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported\nvalues 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\nParameter Store.\n###### Note\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\n 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*: Array of [KeyValuePair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-runtimeenvironmentsecrets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValuePair", "DuplicatesAllowed": true }, "StartCommand": { "MarkdownDocumentation": "`StartCommand`\n\nAn 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\ncommand.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-startcommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuntimeEnvironmentVariables": { "MarkdownDocumentation": "`RuntimeEnvironmentVariables`\n\nEnvironment variables that are available to your running App Runner service. An array of key-value pairs.\n*Required*: No\n*Type*: Array of [KeyValuePair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-runtimeenvironmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValuePair", "DuplicatesAllowed": true }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port that your application listens to in the container.\nDefault: `8080`\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `0`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.ImageRepository": { "MarkdownDocumentation": "`AWS::AppRunner::Service.ImageRepository`\n\nDescribes a source image repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html", "Properties": { "ImageIdentifier": { "MarkdownDocumentation": "`ImageIdentifier`\n\nThe 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*Pattern*: `([0-9]{12}.dkr.ecr.[a-z\\-]+-[0-9]{1}.amazonaws.com\\/.*)|(^public\\.ecr\\.aws\\/.+\\/.+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imageidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImageConfiguration": { "MarkdownDocumentation": "`ImageConfiguration`\n\nConfiguration for running the identified image.\n*Required*: No\n*Type*: [ImageConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imageconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ImageConfiguration" }, "ImageRepositoryType": { "MarkdownDocumentation": "`ImageRepositoryType`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "ECR", "ECR_PUBLIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imagerepositorytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.IngressConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.IngressConfiguration`\n\nNetwork configuration settings for inbound network traffic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html", "Properties": { "IsPubliclyAccessible": { "MarkdownDocumentation": "`IsPubliclyAccessible`\n\nSpecifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to `True`. To make the service\nprivately 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html#cfn-apprunner-service-ingressconfiguration-ispubliclyaccessible", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::AppRunner::Service.InstanceConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.InstanceConfiguration`\n\nDescribes the runtime configuration of an AWS App Runner service instance (scaling unit).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html", "Properties": { "InstanceRoleArn": { "MarkdownDocumentation": "`InstanceRoleArn`\n\nThe 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\nany AWS APIs.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::[0-9]{12}:role/[\\w+=,.@-]{1,64}`\n*Minimum*: `29`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-instancerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe amount of memory, in MB or GB, reserved for each instance of your App Runner service.\nDefault: `2 GB`\n*Required*: No\n*Type*: String\n*Pattern*: `512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-memory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe number of CPU units reserved for each instance of your App Runner service.\nDefault: `1 vCPU`\n*Required*: No\n*Type*: String\n*Pattern*: `256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU`\n*Minimum*: `3`\n*Maximum*: `9`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-cpu", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.KeyValuePair": { "MarkdownDocumentation": "`AWS::AppRunner::Service.KeyValuePair`\n\nDescribes a key-value pair, which is a string-to-string mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html#cfn-apprunner-service-keyvaluepair-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe key name string to map to a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html#cfn-apprunner-service-keyvaluepair-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.NetworkConfiguration`\n\nDescribes configuration settings related to network traffic of an AWS App Runner service. Consists of embedded objects for each configurable network\nfeature.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nApp Runner provides you with the option to choose between *IPv4* and *dual stack* (IPv4 and IPv6)\nfor your incoming public network configuration. This is an optional parameter.\nIf you do not specify an `IpAddressType`, it defaults to select IPv4.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | DUAL_STACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "DUAL_STACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html#cfn-apprunner-service-networkconfiguration-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EgressConfiguration": { "MarkdownDocumentation": "`EgressConfiguration`\n\nNetwork configuration settings for outbound message traffic.\n*Required*: No\n*Type*: [EgressConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html#cfn-apprunner-service-networkconfiguration-egressconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EgressConfiguration" }, "IngressConfiguration": { "MarkdownDocumentation": "`IngressConfiguration`\n\nNetwork configuration settings for inbound message traffic.\n*Required*: No\n*Type*: [IngressConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html#cfn-apprunner-service-networkconfiguration-ingressconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IngressConfiguration" } } }, "AWS::AppRunner::Service.ServiceObservabilityConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.ServiceObservabilityConfiguration`\n\nDescribes the observability configuration of an AWS App Runner service. These are additional observability features, like tracing, that you choose to\nenable. They're configured in a separate resource that you associate with your service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html", "Properties": { "ObservabilityEnabled": { "MarkdownDocumentation": "`ObservabilityEnabled`\n\nWhen `true`, an observability configuration resource is associated with the service, and an `ObservabilityConfigurationArn` is\nspecified.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html#cfn-apprunner-service-serviceobservabilityconfiguration-observabilityenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "ObservabilityConfigurationArn": { "MarkdownDocumentation": "`ObservabilityConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when\n`ObservabilityEnabled` is `true`.\nSpecify an ARN with a name and a revision number to associate that revision. For example:\n`arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3`\nSpecify just the name to associate the latest revision. For example:\n`arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing`\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html#cfn-apprunner-service-serviceobservabilityconfiguration-observabilityconfigurationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.SourceCodeVersion": { "MarkdownDocumentation": "`AWS::AppRunner::Service.SourceCodeVersion`\n\nIdentifies a version of code that AWS App Runner refers to within a source code repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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)\n", "RefReturnValue": "", "AllowedValues": [ "BRANCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html#cfn-apprunner-service-sourcecodeversion-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA source code version.\nFor a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `0`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html#cfn-apprunner-service-sourcecodeversion-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppRunner::Service.SourceConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::Service.SourceConfiguration`\n\nDescribes the source deployed to an AWS App Runner service. It can be a code or an image repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html", "Properties": { "AuthenticationConfiguration": { "MarkdownDocumentation": "`AuthenticationConfiguration`\n\nDescribes the resources that are needed to authenticate access to some source repositories.\n*Required*: No\n*Type*: [AuthenticationConfiguration](./aws-properties-apprunner-service-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-authenticationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AuthenticationConfiguration" }, "CodeRepository": { "MarkdownDocumentation": "`CodeRepository`\n\nThe description of a source code\nrepository.\nYou must provide either this member or `ImageRepository` (but not both).\n*Required*: No\n*Type*: [CodeRepository](./aws-properties-apprunner-service-coderepository.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-coderepository", "UpdateType": "Mutable", "Required": false, "Type": "CodeRepository" }, "ImageRepository": { "MarkdownDocumentation": "`ImageRepository`\n\nThe description of a source image\nrepository.\nYou must provide either this member or `CodeRepository` (but not both).\n*Required*: No\n*Type*: [ImageRepository](./aws-properties-apprunner-service-imagerepository.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-imagerepository", "UpdateType": "Mutable", "Required": false, "Type": "ImageRepository" }, "AutoDeploymentsEnabled": { "MarkdownDocumentation": "`AutoDeploymentsEnabled`\n\nIf `true`, continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source\ncode commit or new image version) starts a deployment.\nDefault: App Runner sets to `false` for a source image that uses an ECR Public repository or an ECR repository that's in an AWS account other than the one that the service is in. App Runner sets to `true` in all other cases (which currently include a source code\nrepository or a source image using a same-account ECR 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-autodeploymentsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AppRunner::VpcIngressConnection.IngressVpcConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::VpcIngressConnection.IngressVpcConfiguration`\n\nSpecifications for the customer\u2019s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC that is used for the VPC endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `0`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration.html#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration-vpcid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe ID of the VPC endpoint that your App Runner service connects to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `0`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration.html#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration-vpcendpointid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppStream::AppBlock.S3Location": { "MarkdownDocumentation": "`AWS::AppStream::AppBlock.S3Location`\n\nThe S3 location of the app block.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.html", "Properties": { "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nThe S3 bucket of the app block.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.html#cfn-appstream-appblock-s3location-s3bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3Key": { "MarkdownDocumentation": "`S3Key`\n\nThe S3 key of the S3 object of the virtual hard disk.\nThis is required when it's used by `SetupScriptDetails` and\n`PostSetupScriptDetails`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.html#cfn-appstream-appblock-s3location-s3key", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppStream::AppBlock.ScriptDetails": { "MarkdownDocumentation": "`AWS::AppStream::AppBlock.ScriptDetails`\n\nThe details of the script.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html", "Properties": { "TimeoutInSeconds": { "MarkdownDocumentation": "`TimeoutInSeconds`\n\nThe run timeout, in seconds, for the script.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-timeoutinseconds", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "ScriptS3Location": { "MarkdownDocumentation": "`ScriptS3Location`\n\nThe S3 object location of the script.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-appstream-appblock-s3location.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-scripts3location", "UpdateType": "Immutable", "Required": true, "Type": "S3Location" }, "ExecutablePath": { "MarkdownDocumentation": "`ExecutablePath`\n\nThe run path for the script.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-executablepath", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ExecutableParameters": { "MarkdownDocumentation": "`ExecutableParameters`\n\nThe parameters used in the run path for the script.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-executableparameters", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppStream::AppBlockBuilder.AccessEndpoint": { "MarkdownDocumentation": "`AWS::AppStream::AppBlockBuilder.AccessEndpoint`\n\nDescribes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-accessendpoint.html", "Properties": { "EndpointType": { "MarkdownDocumentation": "`EndpointType`\n\nThe type of interface endpoint.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STREAMING`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "STREAMING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-accessendpoint.html#cfn-appstream-appblockbuilder-accessendpoint-endpointtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VpceId": { "MarkdownDocumentation": "`VpceId`\n\nThe identifier (ID) of the VPC in which the interface endpoint is used.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-accessendpoint.html#cfn-appstream-appblockbuilder-accessendpoint-vpceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppStream::AppBlockBuilder.VpcConfig": { "MarkdownDocumentation": "`AWS::AppStream::AppBlockBuilder.VpcConfig`\n\nDescribes VPC configuration information for fleets and image builders.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-vpcconfig.html", "Properties": { "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe identifiers of the security groups for the fleet or image builder.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-vpcconfig.html#cfn-appstream-appblockbuilder-vpcconfig-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-vpcconfig.html#cfn-appstream-appblockbuilder-vpcconfig-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::AppStream::Application.S3Location": { "MarkdownDocumentation": "`AWS::AppStream::Application.S3Location`\n\nThe S3 location of the application icon.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-application-s3location.html", "Properties": { "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nThe S3 bucket of the S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-application-s3location.html#cfn-appstream-application-s3location-s3bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3Key": { "MarkdownDocumentation": "`S3Key`\n\nThe S3 key of the S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-application-s3location.html#cfn-appstream-application-s3location-s3key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppStream::DirectoryConfig.CertificateBasedAuthProperties": { "MarkdownDocumentation": "`AWS::AppStream::DirectoryConfig.CertificateBasedAuthProperties`\n\nThe certificate-based authentication properties used to authenticate SAML 2.0 Identity\nProvider (IdP) user identities to Active Directory domain-joined streaming instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe 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\ndomain password if certificate-based authentication is unsuccessful, or to unlock a\ndesktop lock screen. **Enabled\\_no\\_directory\\_login\\_fallback** enables certificate-based\nauthentication, but does not allow users to log in using their AD domain password. Users\nwill be disconnected to re-authenticate using certificates.\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLED | ENABLED | ENABLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED", "ENABLED_NO_DIRECTORY_LOGIN_FALLBACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html#cfn-appstream-directoryconfig-certificatebasedauthproperties-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateAuthorityArn": { "MarkdownDocumentation": "`CertificateAuthorityArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html#cfn-appstream-directoryconfig-certificatebasedauthproperties-certificateauthorityarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AppStream::DirectoryConfig.ServiceAccountCredentials": { "MarkdownDocumentation": "`AWS::AppStream::DirectoryConfig.ServiceAccountCredentials`\n\nThe credentials for the service account used by the streaming instance to connect to the directory.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html", "Properties": { "AccountName": { "MarkdownDocumentation": "`AccountName`\n\nThe user name of the account. This account must have the following privileges: create computer objects,\njoin computers to the domain, and change/reset the password on descendant computer objects for the\norganizational 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html#cfn-appstream-directoryconfig-serviceaccountcredentials-accountname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AccountPassword": { "MarkdownDocumentation": "`AccountPassword`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html#cfn-appstream-directoryconfig-serviceaccountcredentials-accountpassword", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppStream::Entitlement.Attribute": { "MarkdownDocumentation": "`AWS::AppStream::Entitlement.Attribute`\n\nAn attribute that belongs to an entitlement. Application entitlements work by matching a\nsupported SAML 2.0 attribute name to a value when a user identity federates to an AppStream\n2.0 SAML application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nA value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.html#cfn-appstream-entitlement-attribute-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user\nidentity federates to an AppStream 2.0 SAML application.\nThe following are supported values:\n* roles\n* department\n* organization\n* groups\n* title\n* costCenter\n* userType\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.html#cfn-appstream-entitlement-attribute-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppStream::Fleet.ComputeCapacity": { "MarkdownDocumentation": "`AWS::AppStream::Fleet.ComputeCapacity`\n\nThe desired capacity for a fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-computecapacity.html", "Properties": { "DesiredInstances": { "Required": false, "MarkdownDocumentation": "`DesiredInstances`\n\nThe desired number of streaming instances.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-computecapacity.html#cfn-appstream-fleet-computecapacity-desiredinstances", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DesiredSessions": { "Required": false, "MarkdownDocumentation": "`DesiredSessions`\n\nThe desired capacity in terms of number of user sessions, for the multi-session fleet.\nThis is not allowed for single-session fleets.\nWhen you create a fleet, you must set define either the DesiredSessions or\nDesiredInstances attribute, based on the type of fleet you create. You can\u2019t define both\nattributes or leave both attributes blank.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-computecapacity.html#cfn-appstream-fleet-computecapacity-desiredsessions", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::AppStream::Fleet.DomainJoinInfo": { "MarkdownDocumentation": "`AWS::AppStream::Fleet.DomainJoinInfo`\n\nThe name of the directory and organizational unit (OU) to use to join a fleet to a Microsoft Active Directory domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.html", "Properties": { "OrganizationalUnitDistinguishedName": { "Required": false, "MarkdownDocumentation": "`OrganizationalUnitDistinguishedName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.html#cfn-appstream-fleet-domainjoininfo-organizationalunitdistinguishedname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DirectoryName": { "Required": false, "MarkdownDocumentation": "`DirectoryName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.html#cfn-appstream-fleet-domainjoininfo-directoryname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppStream::Fleet.S3Location": { "MarkdownDocumentation": "`AWS::AppStream::Fleet.S3Location`\n\nDescribes the S3 location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-s3location.html", "Properties": { "S3Bucket": { "Required": true, "MarkdownDocumentation": "`S3Bucket`\n\nThe S3 bucket of the S3 object.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z\\.\\-]*(?/ is the final portion of\n the load balancer ARN\n* targetgroup// is the final portion\n 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\nthe [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*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingCustomizedCapacityMetric": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingCustomizedCapacityMetric`\n\nRepresents a CloudWatch metric of your choosing for a predictive scaling policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric.html", "Properties": { "MetricDataQueries": { "MarkdownDocumentation": "`MetricDataQueries`\n\nOne or more metric data queries to provide data points for a metric specification.\n*Required*: Yes\n*Type*: Array of [PredictiveScalingMetricDataQuery](./aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric-metricdataqueries", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PredictiveScalingMetricDataQuery", "DuplicatesAllowed": false } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingCustomizedLoadMetric": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingCustomizedLoadMetric`\n\nThe customized load metric specification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedloadmetric.html", "Properties": { "MetricDataQueries": { "MarkdownDocumentation": "`MetricDataQueries`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [PredictiveScalingMetricDataQuery](./aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedloadmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingcustomizedloadmetric-metricdataqueries", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PredictiveScalingMetricDataQuery", "DuplicatesAllowed": false } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingCustomizedScalingMetric": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingCustomizedScalingMetric`\n\nThe `PredictiveScalingCustomizedScalingMetric` property type specifies Property description not available. for an [AWS::ApplicationAutoScaling::ScalingPolicy](./aws-resource-applicationautoscaling-scalingpolicy.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric.html", "Properties": { "MetricDataQueries": { "MarkdownDocumentation": "`MetricDataQueries`\n\nOne or more metric data queries to provide data points for a metric specification.\n*Required*: Yes\n*Type*: Array of [PredictiveScalingMetricDataQuery](./aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric-metricdataqueries", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PredictiveScalingMetricDataQuery", "DuplicatesAllowed": false } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetric": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetric`\n\nDescribes the scaling metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetric.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetric-metricname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nDescribes the dimensions of the metric.\n*Required*: No\n*Type*: Array of [PredictiveScalingMetricDimension](./aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdimension.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetric-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PredictiveScalingMetricDimension", "DuplicatesAllowed": true }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetric-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetricDataQuery": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetricDataQuery`\n\nThe metric data to return. Also defines whether this call is returning data for one\nmetric only, or whether it is performing a math expression on the values of returned\nmetric statistics to create a new time series. A time series is a series of data points,\neach of which is associated with a timestamp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html", "Properties": { "ReturnData": { "MarkdownDocumentation": "`ReturnData`\n\nIndicates whether to return the timestamps and raw data values of this metric.\nIf you use any math expressions, specify `true` for this value for only the\nfinal math expression that the metric specification is based on. You must specify\n`false` for `ReturnData` for all the other metrics and\nexpressions used in the metric specification.\nIf you are only retrieving metrics and not performing any math expressions, do not\nspecify anything for `ReturnData`. This sets it to its default\n(`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-returndata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe math expression to perform on the returned data, if this object is performing a\nmath expression. This expression can use the `Id` of the other metrics to\nrefer to those metrics, and can also use the `Id` of other expressions to use\nthe result of those expressions.\nConditional: Within each `MetricDataQuery` object, you must specify either\n`Expression` or `MetricStat`, but not both.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Label": { "MarkdownDocumentation": "`Label`\n\nA human-readable label for this metric or expression. This is especially useful if\nthis is a math expression, so that you know what the value represents.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricStat": { "MarkdownDocumentation": "`MetricStat`\n\nInformation about the metric data to return.\nConditional: Within each `MetricDataQuery` object, you must specify either\n`Expression` or `MetricStat`, but not both.\n*Required*: No\n*Type*: [PredictiveScalingMetricStat](./aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-metricstat", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingMetricStat" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA short name that identifies the object's results in the response. This name must be\nunique among all `MetricDataQuery` objects specified for a single scaling\npolicy. If you are performing math expressions on this set of data, this name represents\nthat data and can serve as a variable in the mathematical expression. The valid\ncharacters are letters, numbers, and underscores. The first character must be a\nlowercase letter.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdataquery-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetricDimension": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetricDimension`\n\nDescribes the dimension of a metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdimension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the dimension.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdimension.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdimension-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the dimension.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricdimension.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricdimension-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetricSpecification": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetricSpecification`\n\nThis structure specifies the metrics and target utilization settings for a predictive\nscaling policy.\nYou must specify either a metric pair, or a load metric and a scaling metric\nindividually. Specifying a metric pair instead of individual metrics provides a simpler\nway to configure metrics for a scaling policy. You choose the metric pair, and the\npolicy automatically knows the correct sum and average statistics to use for the load\nmetric and the scaling metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html", "Properties": { "CustomizedLoadMetricSpecification": { "MarkdownDocumentation": "`CustomizedLoadMetricSpecification`\n\nThe customized load metric specification.\n*Required*: No\n*Type*: [PredictiveScalingCustomizedLoadMetric](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-customizedloadmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingCustomizedLoadMetric" }, "PredefinedLoadMetricSpecification": { "MarkdownDocumentation": "`PredefinedLoadMetricSpecification`\n\nThe predefined load metric specification.\n*Required*: No\n*Type*: [PredictiveScalingPredefinedLoadMetric](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedloadmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingPredefinedLoadMetric" }, "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nSpecifies the target utilization.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "PredefinedScalingMetricSpecification": { "MarkdownDocumentation": "`PredefinedScalingMetricSpecification`\n\nThe predefined scaling metric specification.\n*Required*: No\n*Type*: [PredictiveScalingPredefinedScalingMetric](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedscalingmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingPredefinedScalingMetric" }, "CustomizedCapacityMetricSpecification": { "MarkdownDocumentation": "`CustomizedCapacityMetricSpecification`\n\nThe customized capacity metric specification.\n*Required*: No\n*Type*: [PredictiveScalingCustomizedCapacityMetric](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-customizedcapacitymetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingCustomizedCapacityMetric" }, "CustomizedScalingMetricSpecification": { "MarkdownDocumentation": "`CustomizedScalingMetricSpecification`\n\nThe customized scaling metric specification.\n*Required*: No\n*Type*: [PredictiveScalingCustomizedScalingMetric](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-customizedscalingmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingCustomizedScalingMetric" }, "PredefinedMetricPairSpecification": { "MarkdownDocumentation": "`PredefinedMetricPairSpecification`\n\nThe predefined metric pair specification that determines the appropriate scaling metric and load metric to use.\n*Required*: No\n*Type*: [PredictiveScalingPredefinedMetricPair](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedmetricpairspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingPredefinedMetricPair" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetricStat": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingMetricStat`\n\nThis structure defines the CloudWatch metric to return, along with the statistic and unit.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html", "Properties": { "Stat": { "MarkdownDocumentation": "`Stat`\n\nThe statistic to return. It can include any CloudWatch statistic or extended statistic. For\na list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*.\nThe most commonly used metrics for predictive scaling are `Average` and\n`Sum`.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricstat-stat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nThe CloudWatch metric to return, including the metric name, namespace, and dimensions. To\nget the exact metric name, namespace, and dimensions, inspect the [Metric](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*: No\n*Type*: [PredictiveScalingMetric](./aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricstat-metric", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingMetric" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit to use for the returned data points. For a complete list of the units that\nCloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)\ndata type in the *Amazon CloudWatch API Reference*.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingmetricstat-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingPolicyConfiguration": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingPolicyConfiguration`\n\nRepresents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html", "Properties": { "MaxCapacityBreachBehavior": { "MarkdownDocumentation": "`MaxCapacityBreachBehavior`\n\nDefines the behavior that should be applied if the forecast capacity approaches or\nexceeds the maximum capacity. Defaults to\n`HonorMaxCapacity` if not specified.\n*Required*: No\n*Type*: String\n*Allowed values*: `HonorMaxCapacity | Increase...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HonorMaxCapacity", "IncreaseMaxCapacity" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-maxcapacitybreachbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxCapacityBuffer": { "MarkdownDocumentation": "`MaxCapacityBuffer`\n\nThe size of the capacity buffer to use when the forecast capacity is close to or\nexceeds the maximum capacity. The value is specified as a percentage relative to the\nforecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\nsuch that if the forecast capacity is 50, and the maximum capacity is 40, then the\neffective maximum capacity is 55.\nRequired if the `MaxCapacityBreachBehavior` property is set to\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-maxcapacitybuffer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe predictive scaling mode. Defaults to `ForecastOnly` if not specified.\n*Required*: No\n*Type*: String\n*Allowed values*: `ForecastOnly | ForecastAndS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ForecastOnly", "ForecastAndScale" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricSpecifications": { "MarkdownDocumentation": "`MetricSpecifications`\n\nThis 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\nis, you can specify a target value and a single metric pair, or a target value and one\nscaling metric and one load metric.\n*Required*: Yes\n*Type*: Array of [PredictiveScalingMetricSpecification](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-metricspecifications", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PredictiveScalingMetricSpecification", "DuplicatesAllowed": false }, "SchedulingBufferTime": { "MarkdownDocumentation": "`SchedulingBufferTime`\n\nThe amount of time, in seconds, that the start time can be advanced.\nThe value must be less than the forecast interval duration of 3600 seconds (60\nminutes). Defaults to 300 seconds if not specified.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration-schedulingbuffertime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingPredefinedLoadMetric": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingPredefinedLoadMetric`\n\nDescribes a load metric for a predictive scaling policy.\nWhen returned in the output of `DescribePolicies`, it indicates that a\npredictive scaling policy uses individually specified load and scaling metrics instead\nof a metric pair.\nThe following predefined metrics are available for predictive scaling:\n* `ECSServiceAverageCPUUtilization`\n* `ECSServiceAverageMemoryUtilization`\n* `ECSServiceCPUUtilization`\n* `ECSServiceMemoryUtilization`\n* `ECSServiceTotalCPUUtilization`\n* `ECSServiceTotalMemoryUtilization`\n* `ALBRequestCount`\n* `ALBRequestCountPerTarget`\n* `TotalALBRequestCount`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html", "Properties": { "PredefinedMetricType": { "MarkdownDocumentation": "`PredefinedMetricType`\n\nThe metric type.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric-predefinedmetrictype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceLabel": { "MarkdownDocumentation": "`ResourceLabel`\n\nA label that uniquely identifies a target group.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedloadmetric-resourcelabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingPredefinedMetricPair": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingPredefinedMetricPair`\n\nRepresents a metric pair for a predictive scaling policy.\nThe following predefined metrics are available for predictive scaling:\n* `ECSServiceAverageCPUUtilization`\n* `ECSServiceAverageMemoryUtilization`\n* `ECSServiceCPUUtilization`\n* `ECSServiceMemoryUtilization`\n* `ECSServiceTotalCPUUtilization`\n* `ECSServiceTotalMemoryUtilization`\n* `ALBRequestCount`\n* `ALBRequestCountPerTarget`\n* `TotalALBRequestCount`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html", "Properties": { "PredefinedMetricType": { "MarkdownDocumentation": "`PredefinedMetricType`\n\nIndicates which metrics to use. There are two different types of metrics for each\nmetric type: one is a load metric and one is a scaling metric.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair-predefinedmetrictype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceLabel": { "MarkdownDocumentation": "`ResourceLabel`\n\nA label that uniquely identifies a specific target group from which to determine\nthe total and average request count.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedmetricpair-resourcelabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingPredefinedScalingMetric": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.PredictiveScalingPredefinedScalingMetric`\n\nDescribes a scaling metric for a predictive scaling policy.\nWhen returned in the output of `DescribePolicies`, it indicates that a\npredictive scaling policy uses individually specified load and scaling metrics instead\nof a metric pair.\nThe following predefined metrics are available for predictive scaling:\n* `ECSServiceAverageCPUUtilization`\n* `ECSServiceAverageMemoryUtilization`\n* `ECSServiceCPUUtilization`\n* `ECSServiceMemoryUtilization`\n* `ECSServiceTotalCPUUtilization`\n* `ECSServiceTotalMemoryUtilization`\n* `ALBRequestCount`\n* `ALBRequestCountPerTarget`\n* `TotalALBRequestCount`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html", "Properties": { "PredefinedMetricType": { "MarkdownDocumentation": "`PredefinedMetricType`\n\nThe metric type.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric-predefinedmetrictype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceLabel": { "MarkdownDocumentation": "`ResourceLabel`\n\nA label that uniquely identifies a specific target group from which to determine\nthe average request count.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric-resourcelabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.StepAdjustment": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.StepAdjustment`\n\n`StepAdjustment` specifies a step adjustment for the `StepAdjustments`\nproperty of the [AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html) property\ntype.\nFor the following examples, suppose that you have an alarm with a breach threshold of 50:\n* To trigger a step adjustment when the metric is greater than or equal to 50 and less\n than 60, specify a lower bound of 0 and an upper bound of 10.\n* To trigger a step adjustment when the metric is greater than 40 and less than or equal\n to 50, specify a lower bound of -10 and an upper bound of 0.\nFor more information, see [Step adjustments](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#as-scaling-steps) in the *Application Auto Scaling User\nGuide*.\nYou can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#aws-resource-applicationautoscaling-scalingpolicy--examples) section of the `AWS::ApplicationAutoScaling::ScalingPolicy`\ndocumentation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html", "Properties": { "MetricIntervalUpperBound": { "MarkdownDocumentation": "`MetricIntervalUpperBound`\n\nThe upper bound for the difference between the alarm threshold and the CloudWatch metric.\nIf the metric value is above the breach threshold, the upper bound is exclusive (the metric\nmust be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric\nmust be less than or equal to the threshold plus the upper bound). A null value indicates\npositive infinity.\nYou must specify at least one upper or lower bound.\n*Required*: Conditional\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-metricintervalupperbound", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MetricIntervalLowerBound": { "MarkdownDocumentation": "`MetricIntervalLowerBound`\n\nThe lower bound for the difference between the alarm threshold and the CloudWatch metric.\nIf the metric value is above the breach threshold, the lower bound is inclusive (the metric\nmust be greater than or equal to the threshold plus the lower bound). Otherwise, it is\nexclusive (the metric must be greater than the threshold plus the lower bound). A null value\nindicates negative infinity.\nYou must specify at least one upper or lower bound.\n*Required*: Conditional\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-metricintervallowerbound", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ScalingAdjustment": { "MarkdownDocumentation": "`ScalingAdjustment`\n\nThe amount by which to scale. The adjustment is based on the value that you specified in\nthe `AdjustmentType` property (either an absolute number or a percentage). A\npositive value adds to the current capacity and a negative number subtracts from the current\ncapacity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepadjustment-scalingadjustment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration`\n\n`StepScalingPolicyConfiguration` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a step scaling\npolicy configuration for Application Auto Scaling.\nFor more information, see [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html", "Properties": { "MetricAggregationType": { "MarkdownDocumentation": "`MetricAggregationType`\n\nThe aggregation type for the CloudWatch metrics. Valid values are `Minimum`,\n`Maximum`, and `Average`. If the aggregation type is null, the\nvalue is treated as `Average`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Average | Minimum | Maximum...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Average", "Minimum", "Maximum" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-metricaggregationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cooldown": { "MarkdownDocumentation": "`Cooldown`\n\nThe amount of time, in seconds, to wait for a previous scaling activity to take effect. If\nnot specified, the default value is 300. For more information, see [Cooldown period](https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) in the *Application Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-cooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StepAdjustments": { "MarkdownDocumentation": "`StepAdjustments`\n\nA set of adjustments that enable you to scale based on the size of the alarm\nbreach.\nAt least one step adjustment is required if you are adding a new step scaling policy\nconfiguration.\n*Required*: No\n*Type*: Array of [StepAdjustment](./aws-properties-applicationautoscaling-scalingpolicy-stepadjustment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustments", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StepAdjustment", "DuplicatesAllowed": false }, "MinAdjustmentMagnitude": { "MarkdownDocumentation": "`MinAdjustmentMagnitude`\n\nThe minimum value to scale by when the adjustment type is\n`PercentChangeInCapacity`. For example, suppose that you create a step\nscaling policy to scale out an Amazon ECS service by 25 percent and you specify a\n`MinAdjustmentMagnitude` of 2. If the service has 4 tasks and the scaling\npolicy is performed, 25 percent of 4 is 1. However, because you specified a\n`MinAdjustmentMagnitude` of 2, Application Auto Scaling scales out the service by 2\ntasks.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-minadjustmentmagnitude", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AdjustmentType": { "MarkdownDocumentation": "`AdjustmentType`\n\nSpecifies whether the `ScalingAdjustment` value in the\n`StepAdjustment` property is an absolute number or a percentage of the current\ncapacity.\n*Required*: No\n*Type*: String\n*Allowed values*: `ChangeInCapacity | PercentC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ChangeInCapacity", "PercentChangeInCapacity", "ExactCapacity" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-adjustmenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetric": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetric`\n\nRepresents a specific metric for a target tracking scaling policy for Application Auto\nScaling.\nMetric is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html) property\ntype.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetric-metricname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions for the metric. For the list of available dimensions, see the AWS\ndocumentation available from the table in [AWS\nservices that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User\nGuide*.\nConditional: If you published your metric with dimensions, you must specify the same\ndimensions in your scaling policy.\n*Required*: No\n*Type*: Array of [TargetTrackingMetricDimension](./aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdimension.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetric-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetTrackingMetricDimension", "DuplicatesAllowed": true }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric. For more information, see the table in [AWS\nservices that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetric-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricDataQuery": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricDataQuery`\n\nThe metric data to return. Also defines whether this call is returning data for one metric\nonly, or whether it is performing a math expression on the values of returned metric\nstatistics to create a new time series. A time series is a series of data points, each of\nwhich is associated with a timestamp.\nYou can call for a single metric or perform math expressions on multiple metrics. Any\nexpressions used in a metric specification must eventually return a single time series.\nFor more information and examples, see [Create a target tracking scaling policy for Application Auto Scaling using metric\nmath](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the *Application Auto Scaling User Guide*.\n`TargetTrackingMetricDataQuery` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property\ntype.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html", "Properties": { "ReturnData": { "MarkdownDocumentation": "`ReturnData`\n\nIndicates whether to return the timestamps and raw data values of this metric.\nIf you use any math expressions, specify `true` for this value for only the\nfinal math expression that the metric specification is based on. You must specify\n`false` for `ReturnData` for all the other metrics and expressions\nused in the metric specification.\nIf you are only retrieving metrics and not performing any math expressions, do not\nspecify anything for `ReturnData`. This sets it to its default\n(`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-returndata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe math expression to perform on the returned data, if this object is performing a math\nexpression. This expression can use the `Id` of the other metrics to refer to\nthose metrics, and can also use the `Id` of other expressions to use the result\nof those expressions.\nConditional: Within each `TargetTrackingMetricDataQuery` object, you must\nspecify either `Expression` or `MetricStat`, but not both.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Label": { "MarkdownDocumentation": "`Label`\n\nA human-readable label for this metric or expression. This is especially useful if this\nis a math expression, so that you know what the value represents.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricStat": { "MarkdownDocumentation": "`MetricStat`\n\nInformation about the metric data to return.\nConditional: Within each `MetricDataQuery` object, you must specify either\n`Expression` or `MetricStat`, but not both.\n*Required*: No\n*Type*: [TargetTrackingMetricStat](./aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-metricstat", "UpdateType": "Mutable", "Required": false, "Type": "TargetTrackingMetricStat" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA short name that identifies the object's results in the response. This name must be\nunique among all `MetricDataQuery` objects specified for a single scaling\npolicy. If you are performing math expressions on this set of data, this name represents\nthat data and can serve as a variable in the mathematical expression. The valid characters\nare letters, numbers, and underscores. The first character must be a lowercase letter.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricDimension": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricDimension`\n\n`TargetTrackingMetricDimension` specifies a name/value pair that is part of the\nidentity of a CloudWatch metric for the `Dimensions` property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html) property type.\nDuplicate dimensions are not allowed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdimension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the dimension.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdimension.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdimension-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the dimension.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdimension.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricdimension-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricStat": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingMetricStat`\n\nThis structure defines the CloudWatch metric to return, along with the statistic and\nunit.\n`TargetTrackingMetricStat` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html) property\ntype.\nFor more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html", "Properties": { "Stat": { "MarkdownDocumentation": "`Stat`\n\nThe statistic to return. It can include any CloudWatch statistic or extended statistic. For a\nlist of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*.\nThe most commonly used metric for scaling is `Average`.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricstat-stat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nThe CloudWatch metric to return, including the metric name, namespace, and dimensions. To get\nthe exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is\nreturned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).\n*Required*: No\n*Type*: [TargetTrackingMetric](./aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricstat-metric", "UpdateType": "Mutable", "Required": false, "Type": "TargetTrackingMetric" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit to use for the returned data points. For a complete list of the units that CloudWatch\nsupports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data\ntype in the *Amazon CloudWatch API Reference*.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-applicationautoscaling-scalingpolicy-targettrackingmetricstat-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration`\n\n`TargetTrackingScalingPolicyConfiguration` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a target\ntracking scaling policy configuration for Application Auto Scaling. Use a target tracking\nscaling policy to adjust the capacity of the specified scalable target in response to actual\nworkloads, so that resource utilization remains at or near the target utilization value.\nFor more information, see [Target\ntracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) in the *Application Auto Scaling User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html", "Properties": { "ScaleOutCooldown": { "MarkdownDocumentation": "`ScaleOutCooldown`\n\nThe amount of time, in seconds, to wait for a previous scale-out activity to take effect.\nFor more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleoutcooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nThe target value for the metric. Although this property accepts numbers of type Double, it\nwon't accept values that are either too small or too large. Values must be in the range of\n-2^360 to 2^360. The value must be a valid number based on the choice of metric. For example,\nif the metric is CPU utilization, then the target value is a percent value that represents how\nmuch of the CPU can be used before scaling out.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "CustomizedMetricSpecification": { "MarkdownDocumentation": "`CustomizedMetricSpecification`\n\nA customized metric. You can specify either a predefined metric or a customized\nmetric.\n*Required*: No\n*Type*: [CustomizedMetricSpecification](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-customizedmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "CustomizedMetricSpecification" }, "DisableScaleIn": { "MarkdownDocumentation": "`DisableScaleIn`\n\nIndicates whether scale in by the target tracking scaling policy is disabled. If the\nvalue is `true`, scale in is disabled and the target tracking scaling policy\nwon't remove capacity from the scalable target. Otherwise, scale in is enabled and the\ntarget tracking scaling policy can remove capacity from the scalable target. The default\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-disablescalein", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ScaleInCooldown": { "MarkdownDocumentation": "`ScaleInCooldown`\n\nThe amount of time, in seconds, after a scale-in activity completes before another\nscale-in activity can start. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleincooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PredefinedMetricSpecification": { "MarkdownDocumentation": "`PredefinedMetricSpecification`\n\nA predefined metric. You can specify either a predefined metric or a customized\nmetric.\n*Required*: No\n*Type*: [PredefinedMetricSpecification](./aws-properties-applicationautoscaling-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-predefinedmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredefinedMetricSpecification" } } }, "AWS::ApplicationInsights::Application.Alarm": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.Alarm`\n\nThe `AWS::ApplicationInsights::Application Alarm` property type defines a CloudWatch alarm to be monitored for the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-alarm.html", "Properties": { "AlarmName": { "MarkdownDocumentation": "`AlarmName`\n\nThe name of the CloudWatch alarm to be monitored for the component.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-alarm.html#cfn-applicationinsights-application-alarm-alarmname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Severity": { "MarkdownDocumentation": "`Severity`\n\nIndicates the degree of outage when the alarm goes off.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIGH | MEDIUM | LOW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIGH", "MEDIUM", "LOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-alarm.html#cfn-applicationinsights-application-alarm-severity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.AlarmMetric": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.AlarmMetric`\n\nThe `AWS::ApplicationInsights::Application AlarmMetric` property type defines a metric to monitor for the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-alarmmetric.html", "Properties": { "AlarmMetricName": { "MarkdownDocumentation": "`AlarmMetricName`\n\nThe name of the metric to be monitored for the component. For metrics supported by Application Insights, see [Logs and metrics supported by Amazon CloudWatch Application Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/appinsights-logs-and-metrics.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-alarmmetric.html#cfn-applicationinsights-application-alarmmetric-alarmmetricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.ComponentConfiguration": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.ComponentConfiguration`\n\nThe `AWS::ApplicationInsights::Application ComponentConfiguration` property type defines the configuration settings of the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentconfiguration.html", "Properties": { "SubComponentTypeConfigurations": { "MarkdownDocumentation": "`SubComponentTypeConfigurations`\n\nSub-component configurations of the component.\n*Required*: No\n*Type*: Array of [SubComponentTypeConfiguration](./aws-properties-applicationinsights-application-subcomponenttypeconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentconfiguration.html#cfn-applicationinsights-application-componentconfiguration-subcomponenttypeconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SubComponentTypeConfiguration", "DuplicatesAllowed": true }, "ConfigurationDetails": { "MarkdownDocumentation": "`ConfigurationDetails`\n\nThe configuration settings.\n*Required*: No\n*Type*: [ConfigurationDetails](./aws-properties-applicationinsights-application-configurationdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentconfiguration.html#cfn-applicationinsights-application-componentconfiguration-configurationdetails", "UpdateType": "Mutable", "Required": false, "Type": "ConfigurationDetails" } } }, "AWS::ApplicationInsights::Application.ComponentMonitoringSetting": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.ComponentMonitoringSetting`\n\nThe `AWS::ApplicationInsights::Application ComponentMonitoringSetting` property type defines the monitoring setting of the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html", "Properties": { "CustomComponentConfiguration": { "MarkdownDocumentation": "`CustomComponentConfiguration`\n\nCustomized monitoring settings. Required if CUSTOM mode is configured in `ComponentConfigurationMode`.\n*Required*: No\n*Type*: [ComponentConfiguration](./aws-properties-applicationinsights-application-componentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-customcomponentconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComponentConfiguration" }, "Tier": { "MarkdownDocumentation": "`Tier`\n\nThe tier of the application component. Supported tiers include\n`DOT_NET_CORE`, `DOT_NET_WORKER`, `DOT_NET_WEB`,\n`SQL_SERVER`, `SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP`,\n`SQL_SERVER_FAILOVER_CLUSTER_INSTANCE`, `MYSQL`,\n`POSTGRESQL`, `JAVA_JMX`, `ORACLE`,\n`SAP_HANA_MULTI_NODE`, `SAP_HANA_SINGLE_NODE`,\n`SAP_HANA_HIGH_AVAILABILITY`, `SHAREPOINT`.\n`ACTIVE_DIRECTORY`, and `DEFAULT`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-tier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ComponentConfigurationMode": { "MarkdownDocumentation": "`ComponentConfigurationMode`\n\nComponent monitoring can be configured in one of the following three modes:\n* `DEFAULT`: The component will be configured with the recommended default monitoring settings of the selected `Tier`.\n* `CUSTOM`: The component will be configured with the customized monitoring settings\n that are specified in `CustomComponentConfiguration`. If used,\n `CustomComponentConfiguration` must be provided.\n* `DEFAULT_WITH_OVERWRITE`: The component will be configured with the recommended\n default monitoring settings of the selected `Tier`, and merged with\n customized overwrite settings that are specified in\n `DefaultOverwriteComponentConfiguration`. If used,\n `DefaultOverwriteComponentConfiguration` must be provided.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEFAULT | DEFAULT_WITH_OVER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "DEFAULT_WITH_OVERWRITE", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentconfigurationmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultOverwriteComponentConfiguration": { "MarkdownDocumentation": "`DefaultOverwriteComponentConfiguration`\n\nCustomized overwrite monitoring settings. Required if CUSTOM mode is configured in `ComponentConfigurationMode`.\n*Required*: No\n*Type*: [ComponentConfiguration](./aws-properties-applicationinsights-application-componentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-defaultoverwritecomponentconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComponentConfiguration" }, "ComponentName": { "MarkdownDocumentation": "`ComponentName`\n\nThe name of the component. Either the component ARN or the component name is required.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\d\\w\\-_.+]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComponentARN": { "MarkdownDocumentation": "`ComponentARN`\n\nThe ARN of the component. Either the component ARN or the component name is required.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$`\n*Minimum*: `20`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.ConfigurationDetails": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.ConfigurationDetails`\n\nThe `AWS::ApplicationInsights::Application ConfigurationDetails` property type specifies the configuration settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html", "Properties": { "NetWeaverPrometheusExporter": { "MarkdownDocumentation": "`NetWeaverPrometheusExporter`\n\nProperty description not available.\n*Required*: No\n*Type*: [NetWeaverPrometheusExporter](./aws-properties-applicationinsights-application-netweaverprometheusexporter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-netweaverprometheusexporter", "UpdateType": "Mutable", "Required": false, "Type": "NetWeaverPrometheusExporter" }, "WindowsEvents": { "MarkdownDocumentation": "`WindowsEvents`\n\nA list of Windows Events to monitor for the component. Only Amazon EC2 instances\nrunning on Windows can use `WindowsEvents`.\n*Required*: No\n*Type*: Array of [WindowsEvent](./aws-properties-applicationinsights-application-windowsevent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-windowsevents", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "WindowsEvent", "DuplicatesAllowed": true }, "AlarmMetrics": { "MarkdownDocumentation": "`AlarmMetrics`\n\nA list of metrics to monitor for the component. All component types can use `AlarmMetrics`.\n*Required*: No\n*Type*: Array of [AlarmMetric](./aws-properties-applicationinsights-application-alarmmetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-alarmmetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AlarmMetric", "DuplicatesAllowed": true }, "Alarms": { "MarkdownDocumentation": "`Alarms`\n\nA list of alarms to monitor for the component. All component types can use\n`Alarm`.\n*Required*: No\n*Type*: Array of [Alarm](./aws-properties-applicationinsights-application-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-alarms", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Alarm", "DuplicatesAllowed": true }, "SQLServerPrometheusExporter": { "MarkdownDocumentation": "`SQLServerPrometheusExporter`\n\nProperty description not available.\n*Required*: No\n*Type*: [SQLServerPrometheusExporter](./aws-properties-applicationinsights-application-sqlserverprometheusexporter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-sqlserverprometheusexporter", "UpdateType": "Mutable", "Required": false, "Type": "SQLServerPrometheusExporter" }, "HAClusterPrometheusExporter": { "MarkdownDocumentation": "`HAClusterPrometheusExporter`\n\nThe HA cluster Prometheus Exporter settings.\n*Required*: No\n*Type*: [HAClusterPrometheusExporter](./aws-properties-applicationinsights-application-haclusterprometheusexporter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-haclusterprometheusexporter", "UpdateType": "Mutable", "Required": false, "Type": "HAClusterPrometheusExporter" }, "HANAPrometheusExporter": { "MarkdownDocumentation": "`HANAPrometheusExporter`\n\nThe HANA DB Prometheus Exporter settings.\n*Required*: No\n*Type*: [HANAPrometheusExporter](./aws-properties-applicationinsights-application-hanaprometheusexporter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-hanaprometheusexporter", "UpdateType": "Mutable", "Required": false, "Type": "HANAPrometheusExporter" }, "Logs": { "MarkdownDocumentation": "`Logs`\n\nA list of logs to monitor for the component. Only Amazon EC2 instances can use\n`Logs`.\n*Required*: No\n*Type*: Array of [Log](./aws-properties-applicationinsights-application-log.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-logs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Log", "DuplicatesAllowed": true }, "Processes": { "MarkdownDocumentation": "`Processes`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Process](./aws-properties-applicationinsights-application-process.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-processes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Process", "DuplicatesAllowed": true }, "JMXPrometheusExporter": { "MarkdownDocumentation": "`JMXPrometheusExporter`\n\nA list of Java metrics to monitor for the component.\n*Required*: No\n*Type*: [JMXPrometheusExporter](./aws-properties-applicationinsights-application-jmxprometheusexporter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-jmxprometheusexporter", "UpdateType": "Mutable", "Required": false, "Type": "JMXPrometheusExporter" } } }, "AWS::ApplicationInsights::Application.CustomComponent": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.CustomComponent`\n\nThe `AWS::ApplicationInsights::Application CustomComponent` property type describes a custom component by grouping similar standalone instances to monitor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-customcomponent.html", "Properties": { "ResourceList": { "MarkdownDocumentation": "`ResourceList`\n\nThe list of resource ARNs that belong to the component.\n*Required*: Yes\n*Type*: Array of String\n*Maximum*: `300`\n*Minimum*: `20 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-customcomponent.html#cfn-applicationinsights-application-customcomponent-resourcelist", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ComponentName": { "MarkdownDocumentation": "`ComponentName`\n\nThe name of the component.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\d\\w\\-_.+]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-customcomponent.html#cfn-applicationinsights-application-customcomponent-componentname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.HAClusterPrometheusExporter": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.HAClusterPrometheusExporter`\n\nThe `AWS::ApplicationInsights::Application HAClusterPrometheusExporter`\nproperty type defines the HA cluster Prometheus Exporter settings. For more information,\nsee the [component configuration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config-sections.html#component-configuration-prometheus) in the CloudWatch Application Insights\ndocumentation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-haclusterprometheusexporter.html", "Properties": { "PrometheusPort": { "MarkdownDocumentation": "`PrometheusPort`\n\nThe target port to which Prometheus sends metrics. If not specified, the default port 9668 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-haclusterprometheusexporter.html#cfn-applicationinsights-application-haclusterprometheusexporter-prometheusport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.HANAPrometheusExporter": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.HANAPrometheusExporter`\n\nThe `AWS::ApplicationInsights::Application HANAPrometheusExporter` property\ntype defines the HANA DB Prometheus Exporter settings. For more information, see the\n[component configuration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config-sections.html#component-configuration-prometheus) in the CloudWatch Application Insights\ndocumentation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html", "Properties": { "HANAPort": { "MarkdownDocumentation": "`HANAPort`\n\nThe HANA database port by which the exporter will query HANA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-hanaport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PrometheusPort": { "MarkdownDocumentation": "`PrometheusPort`\n\nThe target port to which Prometheus sends metrics. If not specified, the default port 9668 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-prometheusport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HANASecretName": { "MarkdownDocumentation": "`HANASecretName`\n\nThe AWS Secrets Manager secret that stores HANA monitoring user credentials. The HANA Prometheus exporter uses these credentials to connect to the database and query HANA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-hanasecretname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HANASID": { "MarkdownDocumentation": "`HANASID`\n\nThe three-character SAP system ID (SID) of the SAP HANA system.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-hanasid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AgreeToInstallHANADBClient": { "MarkdownDocumentation": "`AgreeToInstallHANADBClient`\n\nDesignates whether you agree to install the HANA DB client.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-agreetoinstallhanadbclient", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::ApplicationInsights::Application.JMXPrometheusExporter": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.JMXPrometheusExporter`\n\nThe `AWS::ApplicationInsights::Application JMXPrometheusExporter` property type\ndefines the JMXPrometheus Exporter configuration. For more information, see the\n[component configuration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config-sections.html#component-configuration-prometheus) in the CloudWatch Application Insights\ndocumentation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-jmxprometheusexporter.html", "Properties": { "PrometheusPort": { "MarkdownDocumentation": "`PrometheusPort`\n\nThe target port to send Prometheus metrics to. If not specified, the default port `9404` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-jmxprometheusexporter.html#cfn-applicationinsights-application-jmxprometheusexporter-prometheusport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JMXURL": { "MarkdownDocumentation": "`JMXURL`\n\nThe complete JMX URL to connect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-jmxprometheusexporter.html#cfn-applicationinsights-application-jmxprometheusexporter-jmxurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostPort": { "MarkdownDocumentation": "`HostPort`\n\nThe host and port to connect to through remote JMX. Only one of `jmxURL` and `hostPort` can be\nspecified.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-jmxprometheusexporter.html#cfn-applicationinsights-application-jmxprometheusexporter-hostport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.Log": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.Log`\n\nThe `AWS::ApplicationInsights::Application Log` property type specifies a log to monitor for the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html", "Properties": { "LogType": { "MarkdownDocumentation": "`LogType`\n\nThe log type decides the log patterns against which Application Insights analyzes the\nlog. The log type is selected from the following: `SQL_SERVER`,\n`MYSQL`, `MYSQL_SLOW_QUERY`, `POSTGRESQL`,\n`ORACLE_ALERT`, `ORACLE_LISTENER`, `IIS`,\n`APPLICATION`, `WINDOWS_EVENTS`,\n`WINDOWS_EVENTS_ACTIVE_DIRECTORY`, `WINDOWS_EVENTS_DNS` ,\n`WINDOWS_EVENTS_IIS` , `WINDOWS_EVENTS_SHAREPOINT`,\n`SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP`,\n`SQL_SERVER_FAILOVER_CLUSTER_INSTANCE`, `STEP_FUNCTION`,\n`API_GATEWAY_ACCESS`, `API_GATEWAY_EXECUTION`,\n`SAP_HANA_LOGS`, `SAP_HANA_TRACE`,\n`SAP_HANA_HIGH_AVAILABILITY`, and `DEFAULT`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-logtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Encoding": { "MarkdownDocumentation": "`Encoding`\n\nThe type of encoding of the logs to be monitored. The specified encoding should be included in the list of CloudWatch agent supported encodings. If not provided, CloudWatch Application Insights uses the default encoding type for the log type:\n* `APPLICATION/DEFAULT`: utf-8 encoding\n* `SQL_SERVER`: utf-16 encoding\n* `IIS`: ascii encoding\n*Required*: No\n*Type*: String\n*Allowed values*: `utf-8 | utf-16 | ascii...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "utf-8", "utf-16", "ascii" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-encoding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe CloudWatch log group name to be associated with the monitored log.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-loggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogPath": { "MarkdownDocumentation": "`LogPath`\n\nThe path of the logs to be monitored. The log path must be an absolute Windows or Linux system file path. For more information, see [CloudWatch Agent Configuration File: Logs Section](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html#CloudWatch-Agent-Configuration-File-Logssection).\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z]:\\\\[\\\\\\S|*\\S]?.*|/[^\"']*)$`\n*Minimum*: `1`\n*Maximum*: `260`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-logpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PatternSet": { "MarkdownDocumentation": "`PatternSet`\n\nThe log pattern set.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9.-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-patternset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.LogPattern": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.LogPattern`\n\nThe `AWS::ApplicationInsights::Application LogPattern` property type\nspecifies an object that defines the log patterns that belong to a\n`LogPatternSet`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpattern.html", "Properties": { "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nA regular expression that defines the log pattern. A log pattern can contain up to 50\ncharacters, and it cannot be empty.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpattern.html#cfn-applicationinsights-application-logpattern-pattern", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Rank": { "MarkdownDocumentation": "`Rank`\n\nThe rank of the log pattern.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpattern.html#cfn-applicationinsights-application-logpattern-rank", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "PatternName": { "MarkdownDocumentation": "`PatternName`\n\nThe name of the log pattern. A log pattern name can contain up to 50 characters, and\nit cannot be empty. The characters can be Unicode letters, digits, or one of the\nfollowing symbols: period, dash, underscore.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9.-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpattern.html#cfn-applicationinsights-application-logpattern-patternname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.LogPatternSet": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.LogPatternSet`\n\nThe `AWS::ApplicationInsights::Application LogPatternSet` property type specifies the log pattern set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpatternset.html", "Properties": { "PatternSetName": { "MarkdownDocumentation": "`PatternSetName`\n\nThe name of the log pattern. A log pattern name can contain up to 30 characters, and\nit cannot be empty. The characters can be Unicode letters, digits, or one of the\nfollowing symbols: period, dash, underscore.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9.-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpatternset.html#cfn-applicationinsights-application-logpatternset-patternsetname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogPatterns": { "MarkdownDocumentation": "`LogPatterns`\n\nA list of objects that define the log patterns that belong to `LogPatternSet`.\n*Required*: Yes\n*Type*: Array of [LogPattern](./aws-properties-applicationinsights-application-logpattern.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpatternset.html#cfn-applicationinsights-application-logpatternset-logpatterns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "LogPattern", "DuplicatesAllowed": true } } }, "AWS::ApplicationInsights::Application.NetWeaverPrometheusExporter": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.NetWeaverPrometheusExporter`\n\nThe `NetWeaverPrometheusExporter` property type specifies Property description not available. for an [AWS::ApplicationInsights::Application](./aws-resource-applicationinsights-application.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-netweaverprometheusexporter.html", "Properties": { "PrometheusPort": { "MarkdownDocumentation": "`PrometheusPort`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-netweaverprometheusexporter.html#cfn-applicationinsights-application-netweaverprometheusexporter-prometheusport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceNumbers": { "MarkdownDocumentation": "`InstanceNumbers`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-netweaverprometheusexporter.html#cfn-applicationinsights-application-netweaverprometheusexporter-instancenumbers", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SAPSID": { "MarkdownDocumentation": "`SAPSID`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-netweaverprometheusexporter.html#cfn-applicationinsights-application-netweaverprometheusexporter-sapsid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.Process": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.Process`\n\nThe `Process` property type specifies Property description not available. for an [AWS::ApplicationInsights::Application](./aws-resource-applicationinsights-application.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-process.html", "Properties": { "ProcessName": { "MarkdownDocumentation": "`ProcessName`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_,-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-process.html#cfn-applicationinsights-application-process-processname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AlarmMetrics": { "MarkdownDocumentation": "`AlarmMetrics`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [AlarmMetric](./aws-properties-applicationinsights-application-alarmmetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-process.html#cfn-applicationinsights-application-process-alarmmetrics", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AlarmMetric", "DuplicatesAllowed": true } } }, "AWS::ApplicationInsights::Application.SQLServerPrometheusExporter": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.SQLServerPrometheusExporter`\n\nThe `SQLServerPrometheusExporter` property type specifies Property description not available. for an [AWS::ApplicationInsights::Application](./aws-resource-applicationinsights-application.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-sqlserverprometheusexporter.html", "Properties": { "PrometheusPort": { "MarkdownDocumentation": "`PrometheusPort`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-sqlserverprometheusexporter.html#cfn-applicationinsights-application-sqlserverprometheusexporter-prometheusport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SQLSecretName": { "MarkdownDocumentation": "`SQLSecretName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-sqlserverprometheusexporter.html#cfn-applicationinsights-application-sqlserverprometheusexporter-sqlsecretname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationInsights::Application.SubComponentConfigurationDetails": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.SubComponentConfigurationDetails`\n\nThe `AWS::ApplicationInsights::Application SubComponentConfigurationDetails` property type specifies the configuration settings of the sub-components.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html", "Properties": { "WindowsEvents": { "MarkdownDocumentation": "`WindowsEvents`\n\nA list of Windows Events to monitor for the component. Only Amazon EC2 instances running\non Windows can use `WindowsEvents`.\n*Required*: No\n*Type*: Array of [WindowsEvent](./aws-properties-applicationinsights-application-windowsevent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html#cfn-applicationinsights-application-subcomponentconfigurationdetails-windowsevents", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "WindowsEvent", "DuplicatesAllowed": true }, "AlarmMetrics": { "MarkdownDocumentation": "`AlarmMetrics`\n\nA list of metrics to monitor for the component. All component types can use `AlarmMetrics`.\n*Required*: No\n*Type*: Array of [AlarmMetric](./aws-properties-applicationinsights-application-alarmmetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html#cfn-applicationinsights-application-subcomponentconfigurationdetails-alarmmetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AlarmMetric", "DuplicatesAllowed": true }, "Logs": { "MarkdownDocumentation": "`Logs`\n\nA list of logs to monitor for the component. Only Amazon EC2 instances can use\n`Logs`.\n*Required*: No\n*Type*: Array of [Log](./aws-properties-applicationinsights-application-log.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html#cfn-applicationinsights-application-subcomponentconfigurationdetails-logs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Log", "DuplicatesAllowed": true }, "Processes": { "MarkdownDocumentation": "`Processes`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Process](./aws-properties-applicationinsights-application-process.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html#cfn-applicationinsights-application-subcomponentconfigurationdetails-processes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Process", "DuplicatesAllowed": true } } }, "AWS::ApplicationInsights::Application.SubComponentTypeConfiguration": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.SubComponentTypeConfiguration`\n\nThe `AWS::ApplicationInsights::Application SubComponentTypeConfiguration` property type specifies the sub-component configurations for a component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponenttypeconfiguration.html", "Properties": { "SubComponentType": { "MarkdownDocumentation": "`SubComponentType`\n\nThe sub-component type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS::EC2::Instance | AWS::E...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS::EC2::Instance", "AWS::EC2::Volume" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponenttypeconfiguration.html#cfn-applicationinsights-application-subcomponenttypeconfiguration-subcomponenttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubComponentConfigurationDetails": { "MarkdownDocumentation": "`SubComponentConfigurationDetails`\n\nThe configuration settings of the sub-components.\n*Required*: Yes\n*Type*: [SubComponentConfigurationDetails](./aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponenttypeconfiguration.html#cfn-applicationinsights-application-subcomponenttypeconfiguration-subcomponentconfigurationdetails", "UpdateType": "Mutable", "Required": true, "Type": "SubComponentConfigurationDetails" } } }, "AWS::ApplicationInsights::Application.WindowsEvent": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application.WindowsEvent`\n\nThe `AWS::ApplicationInsights::Application WindowsEvent` property type specifies a Windows Event to monitor for the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html", "Properties": { "EventLevels": { "MarkdownDocumentation": "`EventLevels`\n\nThe levels of event to log. You must specify each level to log. Possible values include `INFORMATION`, `WARNING`, `ERROR`, `CRITICAL`, and `VERBOSE`. This field is required for each type of Windows Event to log.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html#cfn-applicationinsights-application-windowsevent-eventlevels", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe CloudWatch log group name to be associated with the monitored log.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html#cfn-applicationinsights-application-windowsevent-loggroupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EventName": { "MarkdownDocumentation": "`EventName`\n\nThe type of Windows Events to log, equivalent to the Windows Event log channel name. For\nexample, System, Security, CustomEventName, and so on. This field is required for each\ntype of Windows event to log.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_ \\\\/-]+$`\n*Minimum*: `1`\n*Maximum*: `260`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html#cfn-applicationinsights-application-windowsevent-eventname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PatternSet": { "MarkdownDocumentation": "`PatternSet`\n\nThe log pattern set.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9.-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html#cfn-applicationinsights-application-windowsevent-patternset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::GroupingConfiguration.GroupingAttributeDefinition": { "MarkdownDocumentation": "`AWS::ApplicationSignals::GroupingConfiguration.GroupingAttributeDefinition`\n\nA structure that defines how services should be grouped based on specific attributes. This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html", "Properties": { "GroupingName": { "MarkdownDocumentation": "`GroupingName`\n\nThe friendly name for this grouping attribute, such as `BusinessUnit` or `Environment`. This name is used to identify the grouping in the console and APIs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-groupingname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GroupingSourceKeys": { "MarkdownDocumentation": "`GroupingSourceKeys`\n\nAn array of source keys used to derive the grouping attribute value from telemetry data, AWS tags, or other sources. For example, [\"business\\_unit\", \"team\"] would look for values in those fields.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-groupingsourcekeys", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DefaultGroupingValue": { "MarkdownDocumentation": "`DefaultGroupingValue`\n\nThe default value to use for this grouping attribute when no value can be derived from the source keys. This ensures all services have a grouping value even if the source data is missing.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-defaultgroupingvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.BurnRateConfiguration": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.BurnRateConfiguration`\n\nThis object defines the length of the look-back window used to calculate one burn rate metric\nfor this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of\nexactly 1 indicates that the SLO goal will be met exactly.\nFor example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:\n*burn rate = error rate over the look-back window / (100% - attainment goal percentage)*\nFor more information about burn rates, see [Calculate burn rates](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-burn).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-burnrateconfiguration.html", "Properties": { "LookBackWindowMinutes": { "MarkdownDocumentation": "`LookBackWindowMinutes`\n\nThe number of minutes to use as the look-back window.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `10080`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-burnrateconfiguration.html#cfn-applicationsignals-servicelevelobjective-burnrateconfiguration-lookbackwindowminutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.CalendarInterval": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.CalendarInterval`\n\nIf the interval for this service level objective is a calendar interval, this structure contains the interval specifications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html", "Properties": { "DurationUnit": { "MarkdownDocumentation": "`DurationUnit`\n\nSpecifies the calendar interval unit.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MINUTE | HOUR | DAY | MONTH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MINUTE", "HOUR", "DAY", "MONTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html#cfn-applicationsignals-servicelevelobjective-calendarinterval-durationunit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe date and time when you want the first interval to start. Be sure to choose a time that configures the\nintervals the way that you want. For example, if you want weekly intervals\nstarting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.\nWhen used in a raw HTTP Query API, it is formatted as\nbe epoch time in seconds. For example: `1698778057`\nAs soon as one calendar interval ends, another automatically begins.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `946684800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html#cfn-applicationsignals-servicelevelobjective-calendarinterval-starttime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Duration": { "MarkdownDocumentation": "`Duration`\n\nSpecifies the duration of each calendar interval. For example, if `Duration` is `1` and\n`DurationUnit` is `MONTH`, each interval is one month, aligned with the calendar.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html#cfn-applicationsignals-servicelevelobjective-calendarinterval-duration", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.DependencyConfig": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.DependencyConfig`\n\nIdentifies the dependency using the `DependencyKeyAttributes` and `DependencyOperationName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dependencyconfig.html", "Properties": { "DependencyKeyAttributes": { "MarkdownDocumentation": "`DependencyKeyAttributes`\n\nIf this SLO is related to a metric collected by Application Signals, you must use this field to specify which dependency the SLO metric is related to.\n* `Type` designates the type of object this is.\n* `ResourceType` specifies the type of the resource. This field is used only\n when the value of the `Type` field is `Resource` or `AWS::Resource`.\n* `Name` specifies the name of the object. This is used only if the value of the `Type` field\n is `Service`, `RemoteService`, or `AWS::Service`.\n* `Identifier` identifies the resource objects of this resource.\n This is used only if the value of the `Type` field\n is `Resource` or `AWS::Resource`.\n* `Environment` specifies the location where this object is hosted, or what it belongs to.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dependencyconfig.html#cfn-applicationsignals-servicelevelobjective-dependencyconfig-dependencykeyattributes", "UpdateType": "Mutable", "Required": true, "Type": "Map", "PrimitiveItemType": "String" }, "DependencyOperationName": { "MarkdownDocumentation": "`DependencyOperationName`\n\nWhen the SLO monitors a specific operation of the dependency, this field specifies the name of that operation in the dependency.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dependencyconfig.html#cfn-applicationsignals-servicelevelobjective-dependencyconfig-dependencyoperationname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.Dimension": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.Dimension`\n\nA dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique\nidentifier for a metric, whenever you add a unique name/value pair to one of\nyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n`InstanceId` as a dimension name, and the actual instance ID as the value for that dimension.\nYou\ncan assign up to 30 dimensions to a metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dimension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the dimension. Dimension values must contain only ASCII characters and must include\nat least one non-whitespace character. ASCII\ncontrol characters are not supported as part of dimension values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dimension.html#cfn-applicationsignals-servicelevelobjective-dimension-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the dimension. Dimension names must contain only ASCII characters, must include\nat least one non-whitespace character, and cannot start with a colon (`:`).\nASCII\ncontrol characters are not supported as part of dimension names.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-dimension.html#cfn-applicationsignals-servicelevelobjective-dimension-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.ExclusionWindow": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.ExclusionWindow`\n\nThe time window to be excluded from the SLO performance metrics.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html", "Properties": { "Window": { "MarkdownDocumentation": "`Window`\n\nThe time exclusion window.\n*Required*: Yes\n*Type*: [Window](./aws-properties-applicationsignals-servicelevelobjective-window.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html#cfn-applicationsignals-servicelevelobjective-exclusionwindow-window", "UpdateType": "Mutable", "Required": true, "Type": "Window" }, "RecurrenceRule": { "MarkdownDocumentation": "`RecurrenceRule`\n\nThe recurrence rule for the time exclusion window.\n*Required*: No\n*Type*: [RecurrenceRule](./aws-properties-applicationsignals-servicelevelobjective-recurrencerule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html#cfn-applicationsignals-servicelevelobjective-exclusionwindow-recurrencerule", "UpdateType": "Mutable", "Required": false, "Type": "RecurrenceRule" }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe start time of the time exclusion 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html#cfn-applicationsignals-servicelevelobjective-exclusionwindow-starttime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Reason": { "MarkdownDocumentation": "`Reason`\n\nThe reason for the time exclusion windows. For example, maintenance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html#cfn-applicationsignals-servicelevelobjective-exclusionwindow-reason", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.Goal": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.Goal`\n\nThis structure contains the attributes that determine the goal of an SLO. This includes\nthe time period for evaluation and the attainment threshold.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-goal.html", "Properties": { "WarningThreshold": { "MarkdownDocumentation": "`WarningThreshold`\n\nThe percentage of remaining budget over total budget that you want to get warnings for.\nIf you omit this parameter, the default of 50.0 is used.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-goal.html#cfn-applicationsignals-servicelevelobjective-goal-warningthreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "AttainmentGoal": { "MarkdownDocumentation": "`AttainmentGoal`\n\nThe threshold that determines if the goal is being met.\nIf this is a period-based SLO, the attainment goal is the\npercentage of good periods that meet the threshold requirements to the total periods within the interval.\nFor example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the\nperiods to be in healthy state.\nIf this is a request-based SLO, the attainment goal is the percentage of requests that must be\nsuccessful to meet the attainment goal.\nIf you omit this parameter, 99 is used\nto represent 99% as the attainment goal.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-goal.html#cfn-applicationsignals-servicelevelobjective-goal-attainmentgoal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Interval": { "MarkdownDocumentation": "`Interval`\n\nThe time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.\nIf you omit this parameter, a rolling interval of 7 days is used.\n*Required*: No\n*Type*: [Interval](./aws-properties-applicationsignals-servicelevelobjective-interval.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-goal.html#cfn-applicationsignals-servicelevelobjective-goal-interval", "UpdateType": "Mutable", "Required": false, "Type": "Interval" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.Interval": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.Interval`\n\nThe time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-interval.html", "Properties": { "RollingInterval": { "MarkdownDocumentation": "`RollingInterval`\n\nIf the interval is a rolling interval, this structure contains the interval specifications.\n*Required*: No\n*Type*: [RollingInterval](./aws-properties-applicationsignals-servicelevelobjective-rollinginterval.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-interval.html#cfn-applicationsignals-servicelevelobjective-interval-rollinginterval", "UpdateType": "Mutable", "Required": false, "Type": "RollingInterval" }, "CalendarInterval": { "MarkdownDocumentation": "`CalendarInterval`\n\nIf the interval is a calendar interval, this structure contains the interval specifications.\n*Required*: No\n*Type*: [CalendarInterval](./aws-properties-applicationsignals-servicelevelobjective-calendarinterval.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-interval.html#cfn-applicationsignals-servicelevelobjective-interval-calendarinterval", "UpdateType": "Mutable", "Required": false, "Type": "CalendarInterval" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.Metric": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.Metric`\n\nThis structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric to use.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-metricname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nAn array of one or more dimensions to use to define the metric that you want to use.\nFor more information, see\n[Dimensions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension).\n*Required*: No\n*Type*: Array of [Dimension](./aws-properties-applicationsignals-servicelevelobjective-dimension.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Dimension", "DuplicatesAllowed": true }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric. For more information, see\n[Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace).\n*Required*: No\n*Type*: String\n*Pattern*: `.*[^:].*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.MetricDataQuery": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.MetricDataQuery`\n\nUse this structure to define a metric or metric math expression that you want to use as for a service level objective.\nEach `MetricDataQuery` in the `MetricDataQueries` array specifies either a metric to retrieve, or a metric math expression\nto be performed on retrieved metrics. A single `MetricDataQueries` array can include as many as 20 `MetricDataQuery` structures in the array.\nThe 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that\ncontain the `Expression` parameter to perform a math expression. Of those `Expression` structures,\nexactly one must have true as the value for `ReturnData`. The result of this expression used for the SLO.\nFor more information about metric math expressions, see\n[Use metric math](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html).\nWithin each `MetricDataQuery` object, you must specify either\n`Expression` or `MetricStat` but not both.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html", "Properties": { "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThe ID of the account where this metric is located. If you are performing this operation in a monitoring account,\nuse this to specify which source account to retrieve this metric from.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-accountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReturnData": { "MarkdownDocumentation": "`ReturnData`\n\nUse this only if you are using a metric math expression for the SLO.\nSpecify `true` for `ReturnData` for only the one expression result to use as the alarm. For all\nother metrics and expressions in the same `CreateServiceLevelObjective` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-returndata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThis field can contain a metric math expression to be performed on the other metrics that\nyou are retrieving within this `MetricDataQueries` structure.\nA math expression\ncan use the `Id` of the other metrics or queries to refer to those metrics, and can also use\nthe `Id` of other\nexpressions to use the result of those expressions. For more information about metric math expressions, see\n[Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the\n*Amazon CloudWatch User Guide*.\nWithin each `MetricDataQuery` object, you must specify either\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricStat": { "MarkdownDocumentation": "`MetricStat`\n\nA metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.\nWithin one `MetricDataQuery` object, you must specify either\n`Expression` or `MetricStat` but not both.\n*Required*: No\n*Type*: [MetricStat](./aws-properties-applicationsignals-servicelevelobjective-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-metricstat", "UpdateType": "Mutable", "Required": false, "Type": "MetricStat" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA short name used to tie this object to the results in the response. This `Id` must be unique\nwithin a `MetricDataQueries` array. If you are performing math expressions on this set of data,\nthis name represents that data and can serve as a variable in the metric math expression. The valid characters\nare 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.MetricStat": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.MetricStat`\n\nThis structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html", "Properties": { "Stat": { "MarkdownDocumentation": "`Stat`\n\nThe statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics,\nsee [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html#cfn-applicationsignals-servicelevelobjective-metricstat-stat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can\nbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\nat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\nare those metrics stored by a `PutMetricData` call that includes a `StorageResolution` of 1 second.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html#cfn-applicationsignals-servicelevelobjective-metricstat-period", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nThe metric to use as the service level indicator, including the metric name, namespace, and dimensions.\n*Required*: Yes\n*Type*: [Metric](./aws-properties-applicationsignals-servicelevelobjective-metric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html#cfn-applicationsignals-servicelevelobjective-metricstat-metric", "UpdateType": "Mutable", "Required": true, "Type": "Metric" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nIf you omit `Unit` then all data that was collected with any unit is returned, along with the corresponding units that were specified\nwhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\nIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.\n*Required*: No\n*Type*: String\n*Allowed values*: `Microseconds | Milliseconds...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.html#cfn-applicationsignals-servicelevelobjective-metricstat-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.MonitoredRequestCountMetric": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.MonitoredRequestCountMetric`\n\nThis structure defines the metric that is used as the \"good request\" or \"bad request\"\nvalue for a request-based SLO.\nThis value observed for the metric defined in\n`TotalRequestCountMetric` is divided by the number found for\n`MonitoredRequestCountMetric` to determine the percentage of successful requests that\nthis SLO tracks.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-monitoredrequestcountmetric.html", "Properties": { "GoodCountMetric": { "MarkdownDocumentation": "`GoodCountMetric`\n\nIf you want to count \"good requests\" to determine the percentage of successful requests for this\nrequest-based SLO, specify the metric to use as \"good requests\" in this structure.\n*Required*: No\n*Type*: Array of [MetricDataQuery](./aws-properties-applicationsignals-servicelevelobjective-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-monitoredrequestcountmetric.html#cfn-applicationsignals-servicelevelobjective-monitoredrequestcountmetric-goodcountmetric", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDataQuery", "DuplicatesAllowed": true }, "BadCountMetric": { "MarkdownDocumentation": "`BadCountMetric`\n\nIf you want to count \"bad requests\" to determine the percentage of successful requests for this\nrequest-based SLO, specify the metric to use as \"bad requests\" in this structure.\n*Required*: No\n*Type*: Array of [MetricDataQuery](./aws-properties-applicationsignals-servicelevelobjective-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-monitoredrequestcountmetric.html#cfn-applicationsignals-servicelevelobjective-monitoredrequestcountmetric-badcountmetric", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDataQuery", "DuplicatesAllowed": true } } }, "AWS::ApplicationSignals::ServiceLevelObjective.RecurrenceRule": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.RecurrenceRule`\n\nThe recurrence rule for the time exclusion window.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-recurrencerule.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe following two rules are supported:\n* rate(value unit) - The value must be a positive integer and the unit can be hour|day|month.\n* cron - An expression which consists of six fields separated by white spaces: (minutes hours day\\_of\\_month month day\\_of\\_week year).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-recurrencerule.html#cfn-applicationsignals-servicelevelobjective-recurrencerule-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.RequestBasedSli": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.RequestBasedSli`\n\nThis structure contains information about the performance metric that a request-based SLO monitors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe arithmetic operation used when comparing the specified metric to the\nthreshold.\n*Required*: No\n*Type*: String\n*Allowed values*: `GreaterThanOrEqualTo | Less...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GreaterThanOrEqualTo", "LessThanOrEqualTo", "LessThan", "GreaterThan" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-comparisonoperator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestBasedSliMetric": { "MarkdownDocumentation": "`RequestBasedSliMetric`\n\nA structure that contains information about the metric that the SLO monitors.\n*Required*: Yes\n*Type*: [RequestBasedSliMetric](./aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-requestbasedslimetric", "UpdateType": "Mutable", "Required": true, "Type": "RequestBasedSliMetric" }, "MetricThreshold": { "MarkdownDocumentation": "`MetricThreshold`\n\nThis value is the threshold that\nthe observed metric values of the SLI metric are compared to.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-metricthreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.RequestBasedSliMetric": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.RequestBasedSliMetric`\n\nThis structure contains the information about the metric that is used for a request-based SLO.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html", "Properties": { "MonitoredRequestCountMetric": { "MarkdownDocumentation": "`MonitoredRequestCountMetric`\n\nUse this structure to define the metric that you want to use as the \"good request\" or \"bad request\"\nvalue for a request-based SLO.\nThis value observed for the metric defined in\n`TotalRequestCountMetric` will be divided by the number found for\n`MonitoredRequestCountMetric` to determine the percentage of successful requests that\nthis SLO tracks.\n*Required*: No\n*Type*: [MonitoredRequestCountMetric](./aws-properties-applicationsignals-servicelevelobjective-monitoredrequestcountmetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-monitoredrequestcountmetric", "UpdateType": "Mutable", "Required": false, "Type": "MonitoredRequestCountMetric" }, "OperationName": { "MarkdownDocumentation": "`OperationName`\n\nIf the SLO monitors a specific operation of the service, this field displays that operation name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-operationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalRequestCountMetric": { "MarkdownDocumentation": "`TotalRequestCountMetric`\n\nThis structure defines the metric that is used as the \"total requests\" number for a request-based SLO.\nThe number observed for this metric is divided by the number of \"good requests\" or \"bad requests\" that is\nobserved for the metric defined in\n`MonitoredRequestCountMetric`.\n*Required*: No\n*Type*: Array of [MetricDataQuery](./aws-properties-applicationsignals-servicelevelobjective-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-totalrequestcountmetric", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDataQuery", "DuplicatesAllowed": true }, "KeyAttributes": { "MarkdownDocumentation": "`KeyAttributes`\n\nThis is a string-to-string map that contains information about the type of object that this SLO is related to. It can\ninclude the following fields.\n* `Type` designates the type of object that this SLO is related to.\n* `ResourceType` specifies the type of the resource. This field is used only\n when the value of the `Type` field is `Resource` or `AWS::Resource`.\n* `Name` specifies the name of the object. This is used only if the value of the `Type` field\n is `Service`, `RemoteService`, or `AWS::Service`.\n* `Identifier` identifies the resource objects of this resource.\n This is used only if the value of the `Type` field\n is `Resource` or `AWS::Resource`.\n* `Environment` specifies the location where this object is hosted, or what it belongs to.\n* `AwsAccountId` allows you to create an SLO for an object that exists in another account.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-keyattributes", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "MetricType": { "MarkdownDocumentation": "`MetricType`\n\nIf the SLO monitors either the `LATENCY` or `AVAILABILITY` metric that Application Signals\ncollects, this field displays which of those metrics is used.\n*Required*: No\n*Type*: String\n*Allowed values*: `LATENCY | AVAILABILITY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LATENCY", "AVAILABILITY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-metrictype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DependencyConfig": { "MarkdownDocumentation": "`DependencyConfig`\n\nIdentifies the dependency using the `DependencyKeyAttributes` and `DependencyOperationName`.\n*Required*: No\n*Type*: [DependencyConfig](./aws-properties-applicationsignals-servicelevelobjective-dependencyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-dependencyconfig", "UpdateType": "Mutable", "Required": false, "Type": "DependencyConfig" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.RollingInterval": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.RollingInterval`\n\nIf the interval for this SLO is a rolling interval, this structure contains the interval specifications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-rollinginterval.html", "Properties": { "DurationUnit": { "MarkdownDocumentation": "`DurationUnit`\n\nSpecifies the rolling interval unit.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MINUTE | HOUR | DAY | MONTH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MINUTE", "HOUR", "DAY", "MONTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-rollinginterval.html#cfn-applicationsignals-servicelevelobjective-rollinginterval-durationunit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Duration": { "MarkdownDocumentation": "`Duration`\n\nSpecifies the duration of each rolling interval. For example, if `Duration` is `7` and\n`DurationUnit` is `DAY`, each rolling interval is seven 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-rollinginterval.html#cfn-applicationsignals-servicelevelobjective-rollinginterval-duration", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.Sli": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.Sli`\n\nThis structure specifies the information about the service and the performance metric that an SLO is to monitor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-sli.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe arithmetic operation to use when comparing the specified metric to the threshold.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GreaterThanOrEqualTo | Less...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GreaterThanOrEqualTo", "LessThanOrEqualTo", "LessThan", "GreaterThan" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-sli.html#cfn-applicationsignals-servicelevelobjective-sli-comparisonoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SliMetric": { "MarkdownDocumentation": "`SliMetric`\n\nUse this structure to specify the metric to be used for the SLO.\n*Required*: Yes\n*Type*: [SliMetric](./aws-properties-applicationsignals-servicelevelobjective-slimetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-sli.html#cfn-applicationsignals-servicelevelobjective-sli-slimetric", "UpdateType": "Mutable", "Required": true, "Type": "SliMetric" }, "MetricThreshold": { "MarkdownDocumentation": "`MetricThreshold`\n\nThe value that the SLI metric is compared to.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-sli.html#cfn-applicationsignals-servicelevelobjective-sli-metricthreshold", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.SliMetric": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.SliMetric`\n\nUse this structure to specify the metric to be used for the SLO.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html", "Properties": { "Statistic": { "MarkdownDocumentation": "`Statistic`\n\nThe statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic.\nFor more information about statistics,\nsee [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html).\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-statistic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OperationName": { "MarkdownDocumentation": "`OperationName`\n\nIf the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-operationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KeyAttributes": { "MarkdownDocumentation": "`KeyAttributes`\n\nIf this SLO is related to a metric collected by Application Signals, you must use this field to specify which service\nthe SLO metric is related to. To do so, you must specify at least the `Type`,\n`Name`, and `Environment` attributes.\nThis is a string-to-string map. It can\ninclude the following fields.\n* `Type` designates the type of object this is.\n* `ResourceType` specifies the type of the resource. This field is used only\n when the value of the `Type` field is `Resource` or `AWS::Resource`.\n* `Name` specifies the name of the object. This is used only if the value of the `Type` field\n is `Service`, `RemoteService`, or `AWS::Service`.\n* `Identifier` identifies the resource objects of this resource.\n This is used only if the value of the `Type` field\n is `Resource` or `AWS::Resource`.\n* `Environment` specifies the location where this object is hosted, or what it belongs to.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-keyattributes", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "MetricType": { "MarkdownDocumentation": "`MetricType`\n\nIf the SLO is to monitor either the `LATENCY` or `AVAILABILITY` metric that Application Signals collects, use this field to specify which of those metrics is used.\n*Required*: No\n*Type*: String\n*Allowed values*: `LATENCY | AVAILABILITY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LATENCY", "AVAILABILITY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-metrictype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PeriodSeconds": { "MarkdownDocumentation": "`PeriodSeconds`\n\nThe number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-periodseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MetricDataQueries": { "MarkdownDocumentation": "`MetricDataQueries`\n\nIf this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.\n*Required*: No\n*Type*: Array of [MetricDataQuery](./aws-properties-applicationsignals-servicelevelobjective-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-metricdataqueries", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDataQuery", "DuplicatesAllowed": true }, "DependencyConfig": { "MarkdownDocumentation": "`DependencyConfig`\n\nIdentifies the dependency using the `DependencyKeyAttributes` and `DependencyOperationName`.\n*Required*: No\n*Type*: [DependencyConfig](./aws-properties-applicationsignals-servicelevelobjective-dependencyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-slimetric.html#cfn-applicationsignals-servicelevelobjective-slimetric-dependencyconfig", "UpdateType": "Mutable", "Required": false, "Type": "DependencyConfig" } } }, "AWS::ApplicationSignals::ServiceLevelObjective.Window": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective.Window`\n\nThe start and end time of the time exclusion window.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-window.html", "Properties": { "DurationUnit": { "MarkdownDocumentation": "`DurationUnit`\n\nThe unit of measurement to use during the time window exclusion.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MINUTE | HOUR | DAY | MONTH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MINUTE", "HOUR", "DAY", "MONTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-window.html#cfn-applicationsignals-servicelevelobjective-window-durationunit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Duration": { "MarkdownDocumentation": "`Duration`\n\nThe start and end time of the time exclusion window.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-window.html#cfn-applicationsignals-servicelevelobjective-window-duration", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Athena::CapacityReservation.CapacityAssignment": { "MarkdownDocumentation": "`AWS::Athena::CapacityReservation.CapacityAssignment`\n\nA mapping between one or more workgroups and a capacity reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-capacityreservation-capacityassignment.html", "Properties": { "WorkgroupNames": { "MarkdownDocumentation": "`WorkgroupNames`\n\nThe list of workgroup names for the capacity assignment.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-capacityreservation-capacityassignment.html#cfn-athena-capacityreservation-capacityassignment-workgroupnames", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Athena::CapacityReservation.CapacityAssignmentConfiguration": { "MarkdownDocumentation": "`AWS::Athena::CapacityReservation.CapacityAssignmentConfiguration`\n\nAssigns Athena workgroups (and hence their queries) to capacity\nreservations. A capacity reservation can have only one capacity assignment\nconfiguration, but the capacity assignment configuration can be made up of multiple\nindividual assignments. Each assignment specifies how Athena queries can\nconsume capacity from the capacity reservation that their workgroup is mapped to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-capacityreservation-capacityassignmentconfiguration.html", "Properties": { "CapacityAssignments": { "MarkdownDocumentation": "`CapacityAssignments`\n\nThe list of assignments that make up the capacity assignment configuration.\n*Required*: Yes\n*Type*: Array of [CapacityAssignment](./aws-properties-athena-capacityreservation-capacityassignment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-capacityreservation-capacityassignmentconfiguration.html#cfn-athena-capacityreservation-capacityassignmentconfiguration-capacityassignments", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CapacityAssignment", "DuplicatesAllowed": true } } }, "AWS::Athena::WorkGroup.AclConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.AclConfiguration`\n\nIndicates that an Amazon S3 canned ACL should be set to control ownership of\nstored query results, including data files inserted by Athena as the result\nof statements like CTAS or INSERT INTO. When Athena stores query results in\nAmazon S3, the canned ACL is set with the `x-amz-acl` request\nheader. For more information about S3 Object Ownership, see [Object Ownership settings](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview) in the *Amazon S3 User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-aclconfiguration.html", "Properties": { "S3AclOption": { "MarkdownDocumentation": "`S3AclOption`\n\nThe Amazon S3 canned ACL that Athena should specify when storing\nquery results, including data files inserted by Athena as the result\nof statements like CTAS or INSERT INTO. Currently the only supported canned ACL is\n`BUCKET_OWNER_FULL_CONTROL`. If a query runs in a workgroup and the\nworkgroup overrides client-side settings, then the Amazon S3 canned ACL\nspecified in the workgroup's settings is used for all queries that run in the workgroup.\nFor more information about Amazon S3 canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BUCKET_OWNER_FULL_CONTROL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BUCKET_OWNER_FULL_CONTROL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-aclconfiguration.html#cfn-athena-workgroup-aclconfiguration-s3acloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.Classification": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.Classification`\n\nA classification refers to a set of specific configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-classification.html", "Properties": { "Properties": { "MarkdownDocumentation": "`Properties`\n\nA set of properties specified within a configuration classification.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-classification.html#cfn-athena-workgroup-classification-properties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the configuration classification.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-classification.html#cfn-athena-workgroup-classification-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.CloudWatchLoggingConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.CloudWatchLoggingConfiguration`\n\nConfiguration settings for delivering logs to Amazon CloudWatch log groups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html", "Properties": { "LogGroup": { "MarkdownDocumentation": "`LogGroup`\n\nThe name of the log group in Amazon CloudWatch Logs where you want to publish\nyour logs.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html#cfn-athena-workgroup-cloudwatchloggingconfiguration-loggroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables CloudWatch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html#cfn-athena-workgroup-cloudwatchloggingconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LogStreamNamePrefix": { "MarkdownDocumentation": "`LogStreamNamePrefix`\n\nPrefix for the CloudWatch log stream name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^:*]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html#cfn-athena-workgroup-cloudwatchloggingconfiguration-logstreamnameprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogTypes": { "MarkdownDocumentation": "`LogTypes`\n\nThe types of logs that you want to publish to CloudWatch.\n*Required*: No\n*Type*: Object of Array\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html#cfn-athena-workgroup-cloudwatchloggingconfiguration-logtypes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::Athena::WorkGroup.CustomerContentEncryptionConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.CustomerContentEncryptionConfiguration`\n\nSpecifies the customer managed KMS key that is used to encrypt the user's data stores\nin Athena. When an AWS managed key is used, this value is\nnull. This setting does not apply to Athena SQL workgroups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-customercontentencryptionconfiguration.html", "Properties": { "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nThe customer managed KMS key that is used to encrypt the user's data stores in Athena.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:kms:([a-z0-9\\-]+):\\d{12}:key/?[a-zA-Z_0-9+=,.@\\-_/]+$|^arn:aws[a-z\\-]*:kms:([a-z0-9\\-]+):\\d{12}:alias/?[a-zA-Z_0-9+=,.@\\-_/]+$|^alias/[a-zA-Z0-9/_-]+$|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-customercontentencryptionconfiguration.html#cfn-athena-workgroup-customercontentencryptionconfiguration-kmskey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.EncryptionConfiguration`\n\nIf query results are encrypted in Amazon S3, indicates the encryption option used (for\nexample, `SSE_KMS` or `CSE_KMS`) and key information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html", "Properties": { "EncryptionOption": { "MarkdownDocumentation": "`EncryptionOption`\n\nIndicates whether Amazon S3 server-side encryption with Amazon S3-managed keys\n(`SSE_S3`), server-side encryption with KMS-managed keys\n(`SSE_KMS`), or client-side encryption with KMS-managed keys\n(`CSE_KMS`) is used.\nIf a query runs in a workgroup and the workgroup overrides client-side settings, then\nthe workgroup's setting for encryption is used. It specifies whether query results must\nbe encrypted, for all queries that run in this workgroup.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SSE_S3 | SSE_KMS | 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)", "RefReturnValue": "", "AllowedValues": [ "SSE_S3", "SSE_KMS", "CSE_KMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html#cfn-athena-workgroup-encryptionconfiguration-encryptionoption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nFor `SSE_KMS` and `CSE_KMS`, this is the KMS key ARN or\nID.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html#cfn-athena-workgroup-encryptionconfiguration-kmskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.EngineConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.EngineConfiguration`\n\nThe engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when\nrunning in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).\nTo specify DPU values for PC queries the WG containing EngineConfiguration should have the following values:\nThe name of the Classifications should be `athena-query-engine-properties`, with the only allowed properties as `max-dpu-count` and `min-dpu-count`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html", "Properties": { "SparkProperties": { "MarkdownDocumentation": "`SparkProperties`\n\nSpecifies custom jar files and Spark properties for use cases like cluster encryption,\ntable formats, and general Spark tuning.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-sparkproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Classifications": { "MarkdownDocumentation": "`Classifications`\n\nThe configuration classifications that can be specified for the engine.\n*Required*: No\n*Type*: Array of [Classification](./aws-properties-athena-workgroup-classification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-classifications", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Classification", "DuplicatesAllowed": true }, "MaxConcurrentDpus": { "MarkdownDocumentation": "`MaxConcurrentDpus`\n\nThe maximum number of DPUs that can run concurrently.\n*Required*: No\n*Type*: Integer\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-maxconcurrentdpus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CoordinatorDpuSize": { "MarkdownDocumentation": "`CoordinatorDpuSize`\n\nThe number of DPUs to use for the coordinator. A coordinator is a special executor\nthat orchestrates processing work and manages other executors in a notebook session. The\ndefault is 1.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-coordinatordpusize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DefaultExecutorDpuSize": { "MarkdownDocumentation": "`DefaultExecutorDpuSize`\n\nThe default number of DPUs to use for executors. An executor is the smallest unit of\ncompute that a notebook session can request from Athena. The default is\n1.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-defaultexecutordpusize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AdditionalConfigs": { "MarkdownDocumentation": "`AdditionalConfigs`\n\nContains additional notebook engine `MAP` parameter\nmappings in the form of key-value pairs. To specify an Athena notebook that\nthe Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named\n`NotebookId` to `AdditionalConfigs` that has the value of the\nAthena notebook ID.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-additionalconfigs", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::Athena::WorkGroup.EngineVersion": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.EngineVersion`\n\nThe Athena engine version for running queries, or the PySpark engine\nversion for running sessions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineversion.html", "Properties": { "SelectedEngineVersion": { "MarkdownDocumentation": "`SelectedEngineVersion`\n\nThe engine version requested by the user. Possible values are determined by the output\nof `ListEngineVersions`, including AUTO. The default is AUTO.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineversion.html#cfn-athena-workgroup-engineversion-selectedengineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EffectiveEngineVersion": { "MarkdownDocumentation": "`EffectiveEngineVersion`\n\nRead only. The engine version on which the query runs. If the user requests a valid\nengine version other than Auto, the effective engine version is the same as the engine\nversion that the user requested. If the user requests Auto, the effective engine version\nis chosen by Athena. When a request to update the engine version is made by\na `CreateWorkGroup` or `UpdateWorkGroup` operation, the\n`EffectiveEngineVersion` field is ignored.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineversion.html#cfn-athena-workgroup-engineversion-effectiveengineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.ManagedLoggingConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.ManagedLoggingConfiguration`\n\nConfiguration settings for delivering logs to Amazon S3 buckets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedloggingconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables mamanged log persistence.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedloggingconfiguration.html#cfn-athena-workgroup-managedloggingconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nThe KMS key ARN to encrypt the logs stored in managed log persistence.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:kms:([a-z0-9\\-]+):\\d{12}:key/?[a-zA-Z_0-9+=,.@\\-_/]+$|^arn:aws[a-z\\-]*:kms:([a-z0-9\\-]+):\\d{12}:alias/?[a-zA-Z_0-9+=,.@\\-_/]+$|^alias/[a-zA-Z0-9/_-]+$|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedloggingconfiguration.html#cfn-athena-workgroup-managedloggingconfiguration-kmskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.ManagedQueryResultsConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.ManagedQueryResultsConfiguration`\n\nThe configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedqueryresultsconfiguration.html", "Properties": { "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nIf you encrypt query and calculation results in Athena owned storage, this field\nindicates the encryption option (for example, SSE\\_KMS or CSE\\_KMS) and key\ninformation.\n*Required*: No\n*Type*: [ManagedStorageEncryptionConfiguration](./aws-properties-athena-workgroup-managedstorageencryptionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedqueryresultsconfiguration.html#cfn-athena-workgroup-managedqueryresultsconfiguration-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ManagedStorageEncryptionConfiguration" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIf set to true, allows you to store query results in Athena owned storage. If set to\nfalse, workgroup member stores query results in location specified under\n`ResultConfiguration$OutputLocation`. The default is false. A workgroup\ncannot have the `ResultConfiguration$OutputLocation` parameter when you set\nthis field 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedqueryresultsconfiguration.html#cfn-athena-workgroup-managedqueryresultsconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Athena::WorkGroup.ManagedStorageEncryptionConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.ManagedStorageEncryptionConfiguration`\n\nThe `ManagedStorageEncryptionConfiguration` property type specifies Property description not available. for an [AWS::Athena::WorkGroup](./aws-resource-athena-workgroup.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedstorageencryptionconfiguration.html", "Properties": { "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedstorageencryptionconfiguration.html#cfn-athena-workgroup-managedstorageencryptionconfiguration-kmskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.MonitoringConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.MonitoringConfiguration`\n\nContains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets,\nAmazon CloudWatch log groups etc.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-monitoringconfiguration.html", "Properties": { "S3LoggingConfiguration": { "MarkdownDocumentation": "`S3LoggingConfiguration`\n\nConfiguration settings for delivering logs to Amazon S3 buckets.\n*Required*: No\n*Type*: [S3LoggingConfiguration](./aws-properties-athena-workgroup-s3loggingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-monitoringconfiguration.html#cfn-athena-workgroup-monitoringconfiguration-s3loggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "S3LoggingConfiguration" }, "ManagedLoggingConfiguration": { "MarkdownDocumentation": "`ManagedLoggingConfiguration`\n\nConfiguration settings for managed log persistence.\n*Required*: No\n*Type*: [ManagedLoggingConfiguration](./aws-properties-athena-workgroup-managedloggingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-monitoringconfiguration.html#cfn-athena-workgroup-monitoringconfiguration-managedloggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ManagedLoggingConfiguration" }, "CloudWatchLoggingConfiguration": { "MarkdownDocumentation": "`CloudWatchLoggingConfiguration`\n\nConfiguration settings for delivering logs to Amazon CloudWatch log groups.\n*Required*: No\n*Type*: [CloudWatchLoggingConfiguration](./aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-monitoringconfiguration.html#cfn-athena-workgroup-monitoringconfiguration-cloudwatchloggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingConfiguration" } } }, "AWS::Athena::WorkGroup.ResultConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.ResultConfiguration`\n\nThe location in Amazon S3 where query and calculation results are stored and\nthe encryption option, if any, used for query and calculation results. These are known\nas \"client-side settings\". If workgroup settings override client-side settings, then the\nquery uses the workgroup settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html", "Properties": { "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nIf query results are encrypted in Amazon S3, indicates the encryption option used (for\nexample, `SSE_KMS` or `CSE_KMS`) and key information. This is a\nclient-side setting. If workgroup settings override client-side settings, then the query\nuses the encryption configuration that is specified for the workgroup, and also uses the\nlocation for storing query results specified in the workgroup. See [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration) and [Override client-side\nsettings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-athena-workgroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfiguration" }, "OutputLocation": { "MarkdownDocumentation": "`OutputLocation`\n\nThe location in Amazon S3 where your query results are stored, such as\n`s3://path/to/query/bucket/`. To run a query, you must specify the query\nresults location using either a client-side setting for individual queries or a location\nspecified by the workgroup. If workgroup settings override client-side settings, then\nthe query uses the location specified for the workgroup. If no query location is set,\nAthena issues an error. For more information, see [Work with query results and recent\nqueries](https://docs.aws.amazon.com/athena/latest/ug/querying.html) and [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-outputlocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AclConfiguration": { "MarkdownDocumentation": "`AclConfiguration`\n\nIndicates that an Amazon S3 canned ACL should be set to control ownership of stored\nquery results. Currently the only supported canned ACL is\n`BUCKET_OWNER_FULL_CONTROL`. This is a client-side setting. If workgroup\nsettings override client-side settings, then the query uses the ACL configuration that\nis specified for the workgroup, and also uses the location for storing query results\nspecified in the workgroup. See [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration).\n*Required*: No\n*Type*: [AclConfiguration](./aws-properties-athena-workgroup-aclconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-aclconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AclConfiguration" }, "ExpectedBucketOwner": { "MarkdownDocumentation": "`ExpectedBucketOwner`\n\nThe account ID that you expect to be the owner of the Amazon S3 bucket specified by\n`ResultConfiguration:OutputLocation`. If set, Athena uses the value for\n`ExpectedBucketOwner` when it makes Amazon S3 calls to your specified\noutput location. If the `ExpectedBucketOwner` account ID does not match the\nactual owner of the Amazon S3 bucket, the call fails with a permissions error.\nThis is a client-side setting. If workgroup settings override client-side settings,\nthen the query uses the `ExpectedBucketOwner` setting that is specified for\nthe workgroup, and also uses the location for storing query results specified in the\nworkgroup. See [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration).\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]+$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-expectedbucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.S3LoggingConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.S3LoggingConfiguration`\n\nConfiguration settings for delivering logs to Amazon S3 buckets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-s3loggingconfiguration.html", "Properties": { "LogLocation": { "MarkdownDocumentation": "`LogLocation`\n\nThe Amazon S3 destination URI for log publishing.\n*Required*: No\n*Type*: String\n*Pattern*: `^s3://[a-z0-9][a-z0-9\\-]*[a-z0-9](/.*)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-s3loggingconfiguration.html#cfn-athena-workgroup-s3loggingconfiguration-loglocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables S3 log delivery.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-s3loggingconfiguration.html#cfn-athena-workgroup-s3loggingconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nThe KMS key ARN to encrypt the logs published to the given Amazon S3 destination.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:kms:([a-z0-9\\-]+):\\d{12}:key/?[a-zA-Z_0-9+=,.@\\-_/]+$|^arn:aws[a-z\\-]*:kms:([a-z0-9\\-]+):\\d{12}:alias/?[a-zA-Z_0-9+=,.@\\-_/]+$|^alias/[a-zA-Z0-9/_-]+$|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-s3loggingconfiguration.html#cfn-athena-workgroup-s3loggingconfiguration-kmskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup.WorkGroupConfiguration": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup.WorkGroupConfiguration`\n\nThe configuration of the workgroup, which includes the location in Amazon S3 where\nquery results are stored, the encryption option, if any, used for query results, whether\nAmazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of\nbytes scanned (cutoff) per query, if it is specified. The [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration) option determines whether workgroup\nsettings override client-side query settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html", "Properties": { "EnforceWorkGroupConfiguration": { "MarkdownDocumentation": "`EnforceWorkGroupConfiguration`\n\nIf set to \"true\", the settings for the workgroup override client-side settings. If set\nto \"false\", client-side settings are used. For more information, see [Override client-side settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe engine version that all queries running on the workgroup use.\n*Required*: No\n*Type*: [EngineVersion](./aws-properties-athena-workgroup-engineversion.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-engineversion", "UpdateType": "Mutable", "Required": false, "Type": "EngineVersion" }, "PublishCloudWatchMetricsEnabled": { "MarkdownDocumentation": "`PublishCloudWatchMetricsEnabled`\n\nIndicates that the Amazon CloudWatch metrics are enabled for the workgroup.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-publishcloudwatchmetricsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ResultConfiguration": { "MarkdownDocumentation": "`ResultConfiguration`\n\nSpecifies the location in Amazon S3 where query results are stored and the encryption\noption, if any, used for query results. For more information, see [Work with query results\nand recent queries](https://docs.aws.amazon.com/athena/latest/ug/querying.html).\n*Required*: No\n*Type*: [ResultConfiguration](./aws-properties-athena-workgroup-resultconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-resultconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ResultConfiguration" }, "AdditionalConfiguration": { "MarkdownDocumentation": "`AdditionalConfiguration`\n\nSpecifies a user defined JSON string that is passed to the session engine.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-additionalconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EngineConfiguration": { "MarkdownDocumentation": "`EngineConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [EngineConfiguration](./aws-properties-athena-workgroup-engineconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-engineconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EngineConfiguration" }, "CustomerContentEncryptionConfiguration": { "MarkdownDocumentation": "`CustomerContentEncryptionConfiguration`\n\nSpecifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.\n*Required*: No\n*Type*: [CustomerContentEncryptionConfiguration](./aws-properties-athena-workgroup-customercontentencryptionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-customercontentencryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomerContentEncryptionConfiguration" }, "BytesScannedCutoffPerQuery": { "MarkdownDocumentation": "`BytesScannedCutoffPerQuery`\n\nThe upper limit (cutoff) for the amount of bytes a single query in a workgroup is\nallowed to scan. No default is defined.\n###### Note\nThis property currently supports integer types. Support for long values is\nplanned.\n*Required*: No\n*Type*: Integer\n*Minimum*: `10000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-bytesscannedcutoffperquery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "MonitoringConfiguration": { "MarkdownDocumentation": "`MonitoringConfiguration`\n\nContains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets,\nAmazon CloudWatch log groups etc.\n*Required*: No\n*Type*: [MonitoringConfiguration](./aws-properties-athena-workgroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-monitoringconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MonitoringConfiguration" }, "RequesterPaysEnabled": { "MarkdownDocumentation": "`RequesterPaysEnabled`\n\nIf set to `true`, allows members assigned to a workgroup to reference\nAmazon S3 Requester Pays buckets in queries. If set to `false`, workgroup\nmembers cannot query data from Requester Pays buckets, and queries that retrieve data\nfrom Requester Pays buckets cause an error. The default is `false`. For more\ninformation about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html)\nin the *Amazon Simple Storage 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-requesterpaysenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ManagedQueryResultsConfiguration": { "MarkdownDocumentation": "`ManagedQueryResultsConfiguration`\n\nThe configuration for storing results in Athena owned storage, which includes whether\nthis feature is enabled; whether encryption configuration, if any, is used for\nencrypting query results.\n*Required*: No\n*Type*: [ManagedQueryResultsConfiguration](./aws-properties-athena-workgroup-managedqueryresultsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-managedqueryresultsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ManagedQueryResultsConfiguration" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nRole used to access user resources in an Athena for Apache Spark session. This\nproperty applies only to Spark-enabled workgroups in Athena.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-executionrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AuditManager::Assessment.AWSAccount": { "MarkdownDocumentation": "`AWS::AuditManager::Assessment.AWSAccount`\n\nThe `AWSAccount` property type specifies the wrapper of the AWS account details, such as account ID, email address, and so on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-awsaccount.html", "Properties": { "EmailAddress": { "MarkdownDocumentation": "`EmailAddress`\n\nThe email address that's associated with the AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*@.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-awsaccount.html#cfn-auditmanager-assessment-awsaccount-emailaddress", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe identifier for the AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-awsaccount.html#cfn-auditmanager-assessment-awsaccount-id", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\u007E]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-awsaccount.html#cfn-auditmanager-assessment-awsaccount-name", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::AuditManager::Assessment.AWSService": { "MarkdownDocumentation": "`AWS::AuditManager::Assessment.AWSService`\n\nThe `AWSService` property type specifies an AWS service\nsuch as Amazon S3, AWS CloudTrail, and so on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-awsservice.html", "Properties": { "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe name of the AWS service.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-\\s().]+$`\n*Minimum*: `1`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-awsservice.html#cfn-auditmanager-assessment-awsservice-servicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AuditManager::Assessment.AssessmentReportsDestination": { "MarkdownDocumentation": "`AWS::AuditManager::Assessment.AssessmentReportsDestination`\n\nThe `AssessmentReportsDestination` property type specifies the location in\nwhich AWS Audit Manager saves assessment reports for the given assessment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-assessmentreportsdestination.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination bucket where Audit Manager stores assessment reports.\n*Required*: No\n*Type*: String\n*Pattern*: `^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\=\\+\\@\\:\\s\\,\\?\\/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-assessmentreportsdestination.html#cfn-auditmanager-assessment-assessmentreportsdestination-destination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationType": { "MarkdownDocumentation": "`DestinationType`\n\nThe destination type, such as Amazon S3.\n*Required*: No\n*Type*: String\n*Allowed values*: `S3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "S3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-assessmentreportsdestination.html#cfn-auditmanager-assessment-assessmentreportsdestination-destinationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AuditManager::Assessment.Delegation": { "MarkdownDocumentation": "`AWS::AuditManager::Assessment.Delegation`\n\nThe `Delegation` property type specifies the assignment of a control set to a delegate for review.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the delegation.\n*Required*: No\n*Type*: String\n*Allowed values*: `IN_PROGRESS | UNDER_REVIEW ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Comment": { "MarkdownDocumentation": "`Comment`\n\nThe comment that's related to the delegation.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\W\\s\\S]*$`\n*Maximum*: `350`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedBy": { "MarkdownDocumentation": "`CreatedBy`\n\nThe user or role that created the delegation.\n*Minimum*: `1`\n*Maximum*: `100`\n*Pattern*: `^[a-zA-Z0-9-_()\\\\[\\\\]\\\\s]+$`\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:.*:*:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-createdby", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleType": { "MarkdownDocumentation": "`RoleType`\n\nThe type of customer persona.\n###### Note\nIn `CreateAssessment`, `roleType` can only be\n`PROCESS_OWNER`.\nIn `UpdateSettings`, `roleType` can only be\n`PROCESS_OWNER`.\nIn `BatchCreateDelegationByAssessment`, `roleType` can only be\n`RESOURCE_OWNER`.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROCESS_OWNER | RESOURCE_OW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROCESS_OWNER", "RESOURCE_OWNER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-roletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssessmentId": { "MarkdownDocumentation": "`AssessmentId`\n\nThe identifier for the assessment that's associated with the delegation.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-assessmentid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreationTime": { "MarkdownDocumentation": "`CreationTime`\n\nSpecifies when the delegation was created.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-creationtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "LastUpdated": { "MarkdownDocumentation": "`LastUpdated`\n\nSpecifies when the delegation was last updated.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-lastupdated", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe unique identifier for the delegation.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssessmentName": { "MarkdownDocumentation": "`AssessmentName`\n\nThe name of the assessment that's associated with the delegation.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_\\.]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-assessmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:.*:iam:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ControlSetId": { "MarkdownDocumentation": "`ControlSetId`\n\nThe identifier for the control set that's associated with the delegation.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\W\\s\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-controlsetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AuditManager::Assessment.Role": { "MarkdownDocumentation": "`AWS::AuditManager::Assessment.Role`\n\nThe `Role` property type specifies the wrapper that contains AWS Audit Manager role information, such as the role type and IAM Amazon\nResource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-role.html", "Properties": { "RoleType": { "MarkdownDocumentation": "`RoleType`\n\nThe type of customer persona.\n###### Note\nIn `CreateAssessment`, `roleType` can only be\n`PROCESS_OWNER`.\nIn `UpdateSettings`, `roleType` can only be\n`PROCESS_OWNER`.\nIn `BatchCreateDelegationByAssessment`, `roleType` can only be\n`RESOURCE_OWNER`.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROCESS_OWNER | RESOURCE_OW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROCESS_OWNER", "RESOURCE_OWNER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-role.html#cfn-auditmanager-assessment-role-roletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:.*:iam:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-role.html#cfn-auditmanager-assessment-role-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AuditManager::Assessment.Scope": { "MarkdownDocumentation": "`AWS::AuditManager::Assessment.Scope`\n\nThe `Scope` property type specifies the wrapper that contains the AWS accounts and services that are in scope for the assessment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-scope.html", "Properties": { "AwsAccounts": { "MarkdownDocumentation": "`AwsAccounts`\n\nThe AWS accounts that are included in the scope of the assessment.\n*Required*: No\n*Type*: Array of [AWSAccount](./aws-properties-auditmanager-assessment-awsaccount.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-scope.html#cfn-auditmanager-assessment-scope-awsaccounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AWSAccount", "DuplicatesAllowed": true }, "AwsServices": { "MarkdownDocumentation": "`AwsServices`\n\nThe AWS services that are included in the scope of the assessment.\n###### Important\nThis API parameter is no longer supported. If you use this parameter to specify one\nor more AWS services, Audit Manager ignores this input. Instead, the\nvalue for `awsServices` will show as empty.\n*Required*: No\n*Type*: Array of [AWSService](./aws-properties-auditmanager-assessment-awsservice.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-scope.html#cfn-auditmanager-assessment-scope-awsservices", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AWSService", "DuplicatesAllowed": true } } }, "AWS::AutoScaling::AutoScalingGroup.AcceleratorCountRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.AcceleratorCountRequest`\n\n`AcceleratorCountRequest` is a property of the `InstanceRequirements`\nproperty of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum number of accelerators for an instance type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-acceleratorcountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum value.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-acceleratorcountrequest.html#cfn-autoscaling-autoscalinggroup-acceleratorcountrequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum value.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-acceleratorcountrequest.html#cfn-autoscaling-autoscalinggroup-acceleratorcountrequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::AutoScalingGroup.AcceleratorTotalMemoryMiBRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.AcceleratorTotalMemoryMiBRequest`\n\n`AcceleratorTotalMemoryMiBRequest` is a property of the\n`InstanceRequirements` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum total memory size for the accelerators for an instance type,\nin MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-acceleratortotalmemorymibrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe memory minimum in MiB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-acceleratortotalmemorymibrequest.html#cfn-autoscaling-autoscalinggroup-acceleratortotalmemorymibrequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe memory maximum in MiB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-acceleratortotalmemorymibrequest.html#cfn-autoscaling-autoscalinggroup-acceleratortotalmemorymibrequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::AutoScalingGroup.AvailabilityZoneDistribution": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.AvailabilityZoneDistribution`\n\n`AvailabilityZoneDistribution` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html)\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-availabilityzonedistribution.html", "Properties": { "CapacityDistributionStrategy": { "MarkdownDocumentation": "`CapacityDistributionStrategy`\n\nIf launches fail in an Availability Zone, the following strategies are available. The default is `balanced-best-effort`.\n* `balanced-only` - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution.\n* `balanced-best-effort` - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead.\n*Required*: No\n*Type*: String\n*Allowed values*: `balanced-best-effort | bala...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "balanced-best-effort", "balanced-only" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-availabilityzonedistribution.html#cfn-autoscaling-autoscalinggroup-availabilityzonedistribution-capacitydistributionstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.AvailabilityZoneImpairmentPolicy": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.AvailabilityZoneImpairmentPolicy`\n\nDescribes an Availability Zone impairment policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-availabilityzoneimpairmentpolicy.html", "Properties": { "ZonalShiftEnabled": { "MarkdownDocumentation": "`ZonalShiftEnabled`\n\nIf `true`, enable zonal shift for your Auto Scaling group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-availabilityzoneimpairmentpolicy.html#cfn-autoscaling-autoscalinggroup-availabilityzoneimpairmentpolicy-zonalshiftenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "ImpairedZoneHealthCheckBehavior": { "MarkdownDocumentation": "`ImpairedZoneHealthCheckBehavior`\n\nSpecifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select `Replace unhealthy`, instances that appear unhealthy will be replaced in all Availability Zones.\nIf you select `Ignore unhealthy`, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see [Auto Scaling group zonal shift](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-zonal-shift.html)\nin the *Amazon EC2 Auto Scaling User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IgnoreUnhealthy | ReplaceUn...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IgnoreUnhealthy", "ReplaceUnhealthy" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-availabilityzoneimpairmentpolicy.html#cfn-autoscaling-autoscalinggroup-availabilityzoneimpairmentpolicy-impairedzonehealthcheckbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.BaselineEbsBandwidthMbpsRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.BaselineEbsBandwidthMbpsRequest`\n\n`BaselineEbsBandwidthMbpsRequest` is a property of the\n`InstanceRequirements` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum baseline bandwidth performance for an instance type, in\nMbps.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-baselineebsbandwidthmbpsrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum value in Mbps.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-baselineebsbandwidthmbpsrequest.html#cfn-autoscaling-autoscalinggroup-baselineebsbandwidthmbpsrequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum value in Mbps.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-baselineebsbandwidthmbpsrequest.html#cfn-autoscaling-autoscalinggroup-baselineebsbandwidthmbpsrequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::AutoScalingGroup.BaselinePerformanceFactorsRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.BaselinePerformanceFactorsRequest`\n\nThe baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Auto Scaling uses\nthis baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application.\nCurrently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying `c6i` uses the CPU performance of the `c6i`\nfamily as the baseline reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-baselineperformancefactorsrequest.html", "Properties": { "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe CPU performance to consider, using an instance family as the baseline reference.\n*Required*: No\n*Type*: [CpuPerformanceFactorRequest](./aws-properties-autoscaling-autoscalinggroup-cpuperformancefactorrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-baselineperformancefactorsrequest.html#cfn-autoscaling-autoscalinggroup-baselineperformancefactorsrequest-cpu", "UpdateType": "Conditional", "Required": false, "Type": "CpuPerformanceFactorRequest" } } }, "AWS::AutoScaling::AutoScalingGroup.CapacityReservationSpecification": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.CapacityReservationSpecification`\n\nDescribes the Capacity Reservation preference and targeting options. If you specify `open` or `none` for `CapacityReservationPreference`, do not specify a `CapacityReservationTarget`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationspecification.html", "Properties": { "CapacityReservationPreference": { "MarkdownDocumentation": "`CapacityReservationPreference`\n\nThe capacity reservation preference. The following options are available:\n* `capacity-reservations-only` - Auto Scaling will only launch instances into a Capacity Reservation or Capacity Reservation resource group. If capacity isn't available, instances will fail to launch.\n* `capacity-reservations-first` - Auto Scaling will try to launch instances into a Capacity Reservation or Capacity Reservation resource group first. If capacity isn't available, instances will run in On-Demand capacity.\n* `none` - Auto Scaling will not launch instances into a Capacity Reservation. Instances will run in On-Demand capacity.\n* `default` - Auto Scaling uses the Capacity Reservation preference from your launch template or an open Capacity Reservation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `capacity-reservations-only ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "capacity-reservations-only", "capacity-reservations-first", "none", "default" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationspecification.html#cfn-autoscaling-autoscalinggroup-capacityreservationspecification-capacityreservationpreference", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CapacityReservationTarget": { "MarkdownDocumentation": "`CapacityReservationTarget`\n\nDescribes a target Capacity Reservation or Capacity Reservation resource group.\n*Required*: No\n*Type*: [CapacityReservationTarget](./aws-properties-autoscaling-autoscalinggroup-capacityreservationtarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationspecification.html#cfn-autoscaling-autoscalinggroup-capacityreservationspecification-capacityreservationtarget", "UpdateType": "Mutable", "Required": false, "Type": "CapacityReservationTarget" } } }, "AWS::AutoScaling::AutoScalingGroup.CapacityReservationTarget": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.CapacityReservationTarget`\n\nThe target for the Capacity Reservation. Specify Capacity Reservations IDs or Capacity Reservation resource group ARNs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationtarget.html", "Properties": { "CapacityReservationIds": { "MarkdownDocumentation": "`CapacityReservationIds`\n\nThe Capacity Reservation IDs to launch instances into.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationtarget.html#cfn-autoscaling-autoscalinggroup-capacityreservationtarget-capacityreservationids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "CapacityReservationResourceGroupArns": { "MarkdownDocumentation": "`CapacityReservationResourceGroupArns`\n\nThe resource group ARNs of the Capacity Reservation to launch instances into.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-capacityreservationtarget.html#cfn-autoscaling-autoscalinggroup-capacityreservationtarget-capacityreservationresourcegrouparns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::AutoScaling::AutoScalingGroup.CpuPerformanceFactorRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.CpuPerformanceFactorRequest`\n\nThe CPU performance to consider, using an instance family as the baseline reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-cpuperformancefactorrequest.html", "Properties": { "References": { "MarkdownDocumentation": "`References`\n\nSpecify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the\nreferenced instance family, regardless of CPU manufacturer or architecture differences.\n###### Note\nCurrently only one instance family can be specified in the list.\n*Required*: No\n*Type*: Array of [PerformanceFactorReferenceRequest](./aws-properties-autoscaling-autoscalinggroup-performancefactorreferencerequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-cpuperformancefactorrequest.html#cfn-autoscaling-autoscalinggroup-cpuperformancefactorrequest-references", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "PerformanceFactorReferenceRequest", "DuplicatesAllowed": false } } }, "AWS::AutoScaling::AutoScalingGroup.InstanceLifecyclePolicy": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.InstanceLifecyclePolicy`\n\nThe instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance\ntransitions through its lifecycle states. Configure retention triggers to specify when instances should\nmove to a `Retained` state instead of automatic termination.\nFor more information, see\n[Control instance retention with instance lifecycle policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-lifecycle-policy.html)\nin the *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancelifecyclepolicy.html", "Properties": { "RetentionTriggers": { "MarkdownDocumentation": "`RetentionTriggers`\n\nSpecifies the conditions that trigger instance retention behavior. These triggers determine when instances\nshould move to a `Retained` state instead of automatic termination. This allows you to maintain\ncontrol over instance management when lifecycles transition and operations fail.\n*Required*: No\n*Type*: [RetentionTriggers](./aws-properties-autoscaling-autoscalinggroup-retentiontriggers.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancelifecyclepolicy.html#cfn-autoscaling-autoscalinggroup-instancelifecyclepolicy-retentiontriggers", "UpdateType": "Mutable", "Required": false, "Type": "RetentionTriggers" } } }, "AWS::AutoScaling::AutoScalingGroup.InstanceMaintenancePolicy": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.InstanceMaintenancePolicy`\n\n`InstanceMaintenancePolicy` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\nFor more information, see [Instance\nmaintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancemaintenancepolicy.html", "Properties": { "MaxHealthyPercentage": { "MarkdownDocumentation": "`MaxHealthyPercentage`\n\nSpecifies the upper threshold as a percentage of the desired capacity of the Auto Scaling\ngroup. It represents the maximum percentage of the group that can be in service and\nhealthy, or pending, to support your workload when replacing instances. Value range is\n100 to 200. To clear a previously set value, specify a value of `-1`.\nBoth `MinHealthyPercentage` and `MaxHealthyPercentage` must be\nspecified, and the difference between them cannot be greater than 100. A large range\nincreases the number of instances that can be replaced at the same time.\n*Required*: No\n*Type*: Integer\n*Minimum*: `-1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancemaintenancepolicy.html#cfn-autoscaling-autoscalinggroup-instancemaintenancepolicy-maxhealthypercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinHealthyPercentage": { "MarkdownDocumentation": "`MinHealthyPercentage`\n\nSpecifies the lower threshold as a percentage of the desired capacity of the Auto Scaling\ngroup. It represents the minimum percentage of the group to keep in service, healthy,\nand ready to use to support your workload when replacing instances. Value range is 0 to\n100. To clear a previously set value, specify a value of `-1`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancemaintenancepolicy.html#cfn-autoscaling-autoscalinggroup-instancemaintenancepolicy-minhealthypercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::AutoScalingGroup.InstanceRequirements": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.InstanceRequirements`\n\nThe attributes for the instance types for a mixed instances policy. Amazon EC2 Auto\nScaling uses your specified requirements to identify instance types. Then, it uses your\nOn-Demand and Spot allocation strategies to launch instances from these instance types.\nWhen you specify multiple attributes, you get instance types that satisfy all of the\nspecified attributes. If you specify multiple values for an attribute, you get instance types\nthat satisfy any of the specified values.\nTo limit the list of instance types from which Amazon EC2 Auto Scaling can identify\nmatching instance types, you can use one of the following parameters, but not both in the same\nrequest:\n* `AllowedInstanceTypes` - The instance types to include in the list. All other\n instance types are ignored, even if they match your specified attributes.\n* `ExcludedInstanceTypes` - The instance types to exclude from the list, even if\n they match your specified attributes.\n###### Note\nYou must specify `VCpuCount` and `MemoryMiB`. All other attributes\nare optional. Any unspecified optional attribute is set to its default.\nFor an example template, see [Configure Amazon EC2\nAuto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\nFor more information, see [Creating an Auto\nScaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon\nEC2 Auto Scaling User Guide*. For help determining which instance types match your\nattributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User\nGuide for Linux Instances*.\n`InstanceRequirements` is a property of the `LaunchTemplateOverrides`\nproperty of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html", "Properties": { "InstanceGenerations": { "MarkdownDocumentation": "`InstanceGenerations`\n\nIndicates whether current or previous generation instance types are included.\n* For current generation instance types, specify `current`. The\n current generation includes EC2 instance types currently recommended for use.\n This typically includes the latest two to three generations in each instance\n family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in\n the *Amazon EC2 User Guide*.\n* For previous generation instance types, specify `previous`.\nDefault: Any current or previous generation\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-instancegenerations", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AcceleratorTypes": { "MarkdownDocumentation": "`AcceleratorTypes`\n\nLists the accelerator types that must be on an instance type.\n* For instance types with GPU accelerators, specify `gpu`.\n* For instance types with FPGA accelerators, specify `fpga`.\n* For instance types with inference accelerators, specify\n `inference`.\nDefault: Any accelerator type\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-acceleratortypes", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MemoryGiBPerVCpu": { "MarkdownDocumentation": "`MemoryGiBPerVCpu`\n\nThe minimum and maximum amount of memory per vCPU for an instance type, in GiB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [MemoryGiBPerVCpuRequest](./aws-properties-autoscaling-autoscalinggroup-memorygibpervcpurequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-memorygibpervcpu", "UpdateType": "Conditional", "Required": false, "Type": "MemoryGiBPerVCpuRequest" }, "AcceleratorManufacturers": { "MarkdownDocumentation": "`AcceleratorManufacturers`\n\nIndicates whether instance types must have accelerators by specific\nmanufacturers.\n* For instance types with NVIDIA devices, specify `nvidia`.\n* For instance types with AMD devices, specify `amd`.\n* For instance types with AWS devices, specify\n `amazon-web-services`.\n* For instance types with Xilinx devices, specify `xilinx`.\nDefault: Any manufacturer\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-acceleratormanufacturers", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "VCpuCount": { "MarkdownDocumentation": "`VCpuCount`\n\nThe minimum and maximum number of vCPUs for an instance type.\n*Required*: Yes\n*Type*: [VCpuCountRequest](./aws-properties-autoscaling-autoscalinggroup-vcpucountrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-vcpucount", "UpdateType": "Conditional", "Required": true, "Type": "VCpuCountRequest" }, "LocalStorage": { "MarkdownDocumentation": "`LocalStorage`\n\nIndicates whether instance types with instance store volumes are included, excluded,\nor required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in\nthe *Amazon EC2 User Guide*.\nDefault: `included`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | excluded | requi...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "excluded", "required" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-localstorage", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "CpuManufacturers": { "MarkdownDocumentation": "`CpuManufacturers`\n\nLists which specific CPU manufacturers to include.\n* For instance types with Intel CPUs, specify `intel`.\n* For instance types with AMD CPUs, specify `amd`.\n* For instance types with AWS CPUs, specify\n `amazon-web-services`.\n* For instance types with Apple CPUs, specify\n `apple`.\n###### Note\nDon't confuse the CPU hardware manufacturer with the CPU hardware architecture.\nInstances will be launched with a compatible CPU architecture based on the Amazon\nMachine Image (AMI) that you specify in your launch template.\nDefault: Any manufacturer\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-cpumanufacturers", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "BareMetal": { "MarkdownDocumentation": "`BareMetal`\n\nIndicates whether bare metal instance types are included, excluded, or\nrequired.\nDefault: `excluded`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | excluded | requi...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "excluded", "required" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-baremetal", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "RequireHibernateSupport": { "MarkdownDocumentation": "`RequireHibernateSupport`\n\nIndicates whether instance types must provide On-Demand Instance hibernation\nsupport.\nDefault: `false`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-requirehibernatesupport", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "MarkdownDocumentation": "`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`\n\n[Price protection] The price protection threshold for Spot Instances, as a percentage\nof an identified On-Demand price. The identified On-Demand price is the price of the\nlowest priced current generation C, M, or R instance type with your specified\nattributes. If no current generation C, M, or R instance type matches your attributes,\nthen the identified price is from either the lowest priced current generation instance\ntypes or, failing that, the lowest priced previous generation instance types that match\nyour attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\nexclude instance types whose price exceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\nIf you set `DesiredCapacityType` to `vcpu` or\n`memory-mib`, the price protection threshold is based on the per-vCPU or\nper-memory price instead of the per instance price.\n###### Note\nOnly one of `SpotMaxPricePercentageOverLowestPrice` or\n`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If\nyou don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\nto consistently select from a wide range of instance types. To indicate no price\nprotection threshold for Spot Instances, meaning you want to consider all instance\ntypes that match your attributes, include one of these parameters and specify a high\nvalue, such as `999999`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-maxspotpriceaspercentageofoptimalondemandprice", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "OnDemandMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`OnDemandMaxPricePercentageOverLowestPrice`\n\n[Price protection] The price protection threshold for On-Demand Instances, as a\npercentage higher than an identified On-Demand price. The identified On-Demand price is\nthe price of the lowest priced current generation C, M, or R instance type with your\nspecified attributes. If no current generation C, M, or R instance type matches your\nattributes, then the identified price is from either the lowest priced current\ngeneration instance types or, failing that, the lowest priced previous generation\ninstance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with\nyour attributes, we will exclude instance types whose price exceeds your specified\nthreshold.\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\nTo turn off price protection, specify a high value, such as `999999`.\nIf you set `DesiredCapacityType` to `vcpu` or\n`memory-mib`, the price protection threshold is applied based on the\nper-vCPU or per-memory price instead of the per instance price.\nDefault: `20`\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-ondemandmaxpricepercentageoverlowestprice", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "MemoryMiB": { "MarkdownDocumentation": "`MemoryMiB`\n\nThe minimum and maximum instance memory size for an instance type, in MiB.\n*Required*: Yes\n*Type*: [MemoryMiBRequest](./aws-properties-autoscaling-autoscalinggroup-memorymibrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-memorymib", "UpdateType": "Conditional", "Required": true, "Type": "MemoryMiBRequest" }, "LocalStorageTypes": { "MarkdownDocumentation": "`LocalStorageTypes`\n\nIndicates the type of local storage that is required.\n* For instance types with hard disk drive (HDD) storage, specify\n `hdd`.\n* For instance types with solid state drive (SSD) storage, specify\n `ssd`.\nDefault: Any local storage type\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-localstoragetypes", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NetworkInterfaceCount": { "MarkdownDocumentation": "`NetworkInterfaceCount`\n\nThe minimum and maximum number of network interfaces for an instance type.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [NetworkInterfaceCountRequest](./aws-properties-autoscaling-autoscalinggroup-networkinterfacecountrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-networkinterfacecount", "UpdateType": "Conditional", "Required": false, "Type": "NetworkInterfaceCountRequest" }, "ExcludedInstanceTypes": { "MarkdownDocumentation": "`ExcludedInstanceTypes`\n\nThe instance types to exclude. You can use strings with one or more wild cards,\nrepresented by an asterisk (`*`), to exclude an instance family, type, size,\nor generation. The following are examples: `m5.8xlarge`, `c5*.*`,\n`m5a.*`, `r*`, `*3*`.\nFor example, if you specify `c5*`, you are excluding the entire C5 instance\nfamily, which includes all C5a and C5n instance types. If you specify\n`m5a.*`, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n\ninstance types.\n###### Note\nIf you specify `ExcludedInstanceTypes`, you can't specify\n`AllowedInstanceTypes`.\nDefault: No excluded instance types\n*Required*: No\n*Type*: Array of String\n*Maximum*: `400`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-excludedinstancetypes", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AllowedInstanceTypes": { "MarkdownDocumentation": "`AllowedInstanceTypes`\n\nThe instance types to apply your specified attributes against. All other instance\ntypes are ignored, even if they match your specified attributes.\nYou can use strings with one or more wild cards, represented by an asterisk\n(`*`), to allow an instance type, size, or generation. The following are\nexamples: `m5.8xlarge`, `c5*.*`, `m5a.*`,\n`r*`, `*3*`.\nFor example, if you specify `c5*`, Amazon EC2 Auto Scaling will allow the entire C5\ninstance family, which includes all C5a and C5n instance types. If you specify\n`m5a.*`, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n\ninstance types.\n###### Note\nIf you specify `AllowedInstanceTypes`, you can't specify\n`ExcludedInstanceTypes`.\nDefault: All instance types\n*Required*: No\n*Type*: Array of String\n*Maximum*: `400`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-allowedinstancetypes", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AcceleratorCount": { "MarkdownDocumentation": "`AcceleratorCount`\n\nThe minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia\nchips) for an instance type.\nTo exclude accelerator-enabled instance types, set `Max` to\n`0`.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [AcceleratorCountRequest](./aws-properties-autoscaling-autoscalinggroup-acceleratorcountrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-acceleratorcount", "UpdateType": "Conditional", "Required": false, "Type": "AcceleratorCountRequest" }, "NetworkBandwidthGbps": { "MarkdownDocumentation": "`NetworkBandwidthGbps`\n\nThe minimum and maximum amount of network bandwidth, in gigabits per second\n(Gbps).\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [NetworkBandwidthGbpsRequest](./aws-properties-autoscaling-autoscalinggroup-networkbandwidthgbpsrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-networkbandwidthgbps", "UpdateType": "Conditional", "Required": false, "Type": "NetworkBandwidthGbpsRequest" }, "BaselinePerformanceFactors": { "MarkdownDocumentation": "`BaselinePerformanceFactors`\n\nThe baseline performance factors for the instance requirements.\n*Required*: No\n*Type*: [BaselinePerformanceFactorsRequest](./aws-properties-autoscaling-autoscalinggroup-baselineperformancefactorsrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-baselineperformancefactors", "UpdateType": "Conditional", "Required": false, "Type": "BaselinePerformanceFactorsRequest" }, "BaselineEbsBandwidthMbps": { "MarkdownDocumentation": "`BaselineEbsBandwidthMbps`\n\nThe minimum and maximum baseline bandwidth performance for an instance type, in Mbps.\nFor more information, see [Amazon EBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html)\nin the *Amazon EC2 User Guide*.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [BaselineEbsBandwidthMbpsRequest](./aws-properties-autoscaling-autoscalinggroup-baselineebsbandwidthmbpsrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-baselineebsbandwidthmbps", "UpdateType": "Conditional", "Required": false, "Type": "BaselineEbsBandwidthMbpsRequest" }, "SpotMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`SpotMaxPricePercentageOverLowestPrice`\n\n[Price protection] The price protection threshold for Spot Instances, as a percentage\nhigher than an identified Spot price. The identified Spot price is the price of the\nlowest priced current generation C, M, or R instance type with your specified\nattributes. If no current generation C, M, or R instance type matches your attributes,\nthen the identified price is from either the lowest priced current generation instance\ntypes or, failing that, the lowest priced previous generation instance types that match\nyour attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\nexclude instance types whose price exceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\nIf you set `DesiredCapacityType` to `vcpu` or\n`memory-mib`, the price protection threshold is based on the per-vCPU or\nper-memory price instead of the per instance price.\n###### Note\nOnly one of `SpotMaxPricePercentageOverLowestPrice` or\n`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If\nyou don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\nto consistently select from a wide range of instance types. To indicate no price\nprotection threshold for Spot Instances, meaning you want to consider all instance\ntypes that match your attributes, include one of these parameters and specify a high\nvalue, such as `999999`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-spotmaxpricepercentageoverlowestprice", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "AcceleratorNames": { "MarkdownDocumentation": "`AcceleratorNames`\n\nLists the accelerators that must be on an instance type.\n* For instance types with NVIDIA A100 GPUs, specify `a100`.\n* For instance types with NVIDIA V100 GPUs, specify `v100`.\n* For instance types with NVIDIA K80 GPUs, specify `k80`.\n* For instance types with NVIDIA T4 GPUs, specify `t4`.\n* For instance types with NVIDIA M60 GPUs, specify `m60`.\n* For instance types with AMD Radeon Pro V520 GPUs, specify\n `radeon-pro-v520`.\n* For instance types with Xilinx VU9P FPGAs, specify `vu9p`.\nDefault: Any accelerator\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-acceleratornames", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AcceleratorTotalMemoryMiB": { "MarkdownDocumentation": "`AcceleratorTotalMemoryMiB`\n\nThe minimum and maximum total memory size for the accelerators on an instance type, in\nMiB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [AcceleratorTotalMemoryMiBRequest](./aws-properties-autoscaling-autoscalinggroup-acceleratortotalmemorymibrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-acceleratortotalmemorymib", "UpdateType": "Conditional", "Required": false, "Type": "AcceleratorTotalMemoryMiBRequest" }, "BurstablePerformance": { "MarkdownDocumentation": "`BurstablePerformance`\n\nIndicates whether burstable performance instance types are included, excluded, or\nrequired. For more information, see [Burstable\nperformance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*.\nDefault: `excluded`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | excluded | requi...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "excluded", "required" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-burstableperformance", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "TotalLocalStorageGB": { "MarkdownDocumentation": "`TotalLocalStorageGB`\n\nThe minimum and maximum total local storage size for an instance type, in GB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [TotalLocalStorageGBRequest](./aws-properties-autoscaling-autoscalinggroup-totallocalstoragegbrequest.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html#cfn-autoscaling-autoscalinggroup-instancerequirements-totallocalstoragegb", "UpdateType": "Conditional", "Required": false, "Type": "TotalLocalStorageGBRequest" } } }, "AWS::AutoScaling::AutoScalingGroup.InstancesDistribution": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.InstancesDistribution`\n\nUse this structure to specify the distribution of On-Demand Instances and Spot Instances\nand the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed\ninstances policy.\nFor more information, see [Auto Scaling\ngroups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2\nAuto Scaling User Guide*.\n`InstancesDistribution` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html", "Properties": { "OnDemandAllocationStrategy": { "MarkdownDocumentation": "`OnDemandAllocationStrategy`\n\nThe allocation strategy to apply to your On-Demand Instances when they are launched.\nPossible instance types are determined by the launch template overrides that you\nspecify.\nThe following lists the valid values:\nlowest-price\nUses price to determine which instance types are the highest priority, launching the\nlowest priced instance types within an Availability Zone first. This is the default\nvalue for Auto Scaling groups that specify `InstanceRequirements`.\n\nprioritized\nYou set the order of instance types for the launch template overrides from highest\nto lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches\nyour highest priority instance types first. If all your On-Demand capacity cannot be\nfulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling\nlaunches the remaining capacity using the second priority instance type, and so on. This\nis the default value for Auto Scaling groups that don't specify\n`InstanceRequirements` and cannot be used for groups that do.\n\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-ondemandallocationstrategy", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "OnDemandBaseCapacity": { "MarkdownDocumentation": "`OnDemandBaseCapacity`\n\nThe minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\nInstances. This base portion is launched first as your group scales.\nThis number has the same unit of measurement as the group's desired capacity. If you\nchange the default unit of measurement (number of instances) by specifying weighted\ncapacity values in your launch template overrides list, or by changing the default\ndesired capacity type setting of the group, you must specify this number using the same\nunit of measurement.\nDefault: 0\n###### Note\nAn update to this setting means a gradual replacement of instances to adjust the\ncurrent On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new\ninstances before terminating the previous ones.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-ondemandbasecapacity", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "OnDemandPercentageAboveBaseCapacity": { "MarkdownDocumentation": "`OnDemandPercentageAboveBaseCapacity`\n\nControls the percentages of On-Demand Instances and Spot Instances for your additional\ncapacity beyond `OnDemandBaseCapacity`. Expressed as a number (for example,\n20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand\nInstances are used.\nDefault: 100\n###### Note\nAn update to this setting means a gradual replacement of instances to adjust the\ncurrent On-Demand and Spot Instance levels for your additional capacity higher than\nthe base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before\nterminating the previous ones.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-ondemandpercentageabovebasecapacity", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "SpotInstancePools": { "MarkdownDocumentation": "`SpotInstancePools`\n\nThe number of Spot Instance pools across which to allocate your Spot Instances. The\nSpot pools are determined from the different instance types in the overrides. Valid only\nwhen the `SpotAllocationStrategy` is `lowest-price`. Value must be\nin the range of 1\u201320.\nDefault: 2\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-spotinstancepools", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "SpotAllocationStrategy": { "MarkdownDocumentation": "`SpotAllocationStrategy`\n\nThe allocation strategy to apply to your Spot Instances when they are launched. Possible\ninstance types are determined by the launch template overrides that you specify.\nThe following lists the valid values:\ncapacity-optimized\nRequests Spot Instances using pools that are optimally chosen based on the available\nSpot capacity. This strategy has the lowest risk of interruption. To give certain\ninstance types a higher chance of launching first, use\n`capacity-optimized-prioritized`.\n\ncapacity-optimized-prioritized\nYou set the order of instance types for the launch template overrides from highest\nto lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the\ninstance type priorities on a best effort basis but optimizes for capacity first. Note\nthat if the On-Demand allocation strategy is set to `prioritized`, the same\npriority is applied when fulfilling On-Demand capacity. This is not a valid value for\nAuto Scaling groups that specify `InstanceRequirements`.\n\nlowest-price\nRequests Spot Instances using the lowest priced pools within an Availability Zone,\nacross the number of Spot pools that you specify for the `SpotInstancePools`\nproperty. To ensure that your desired capacity is met, you might receive Spot Instances\nfrom several pools. This is the default value, but it might lead to high interruption\nrates because this strategy only considers instance price and not available\ncapacity.\n\nprice-capacity-optimized (recommended)\nThe price and capacity optimized allocation strategy looks at both price and\ncapacity to select the Spot Instance pools that are the least likely to be interrupted\nand have the lowest possible price.\n\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-spotallocationstrategy", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SpotMaxPrice": { "MarkdownDocumentation": "`SpotMaxPrice`\n\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. If\nyour maximum price is lower than the Spot price for the instance types that you\nselected, your Spot Instances are not launched. We do not recommend specifying a maximum\nprice because it can lead to increased interruptions. When Spot Instances launch, you\npay the current Spot price. To remove a maximum price that you previously set, include\nthe property but specify an empty string (\"\") for the value.\n###### Important\nIf you specify a maximum price, your instances will be interrupted more frequently\nthan if you do not specify one.\nValid Range: Minimum value of 0.001\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html#cfn-autoscaling-autoscalinggroup-instancesdistribution-spotmaxprice", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.LaunchTemplate": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.LaunchTemplate`\n\nUse this structure to specify the launch templates and instance types (overrides) for a\nmixed instances policy.\n`LaunchTemplate` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html", "Properties": { "LaunchTemplateSpecification": { "MarkdownDocumentation": "`LaunchTemplateSpecification`\n\nThe launch template.\n*Required*: Yes\n*Type*: [LaunchTemplateSpecification](./aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html#cfn-autoscaling-autoscalinggroup-launchtemplate-launchtemplatespecification", "UpdateType": "Conditional", "Required": true, "Type": "LaunchTemplateSpecification" }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nAny properties that you specify override the same properties in the launch\ntemplate.\n*Required*: No\n*Type*: Array of [LaunchTemplateOverrides](./aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html#cfn-autoscaling-autoscalinggroup-launchtemplate-overrides", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "LaunchTemplateOverrides", "DuplicatesAllowed": true } } }, "AWS::AutoScaling::AutoScalingGroup.LaunchTemplateOverrides": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.LaunchTemplateOverrides`\n\nUse this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling\ngroup has a mixed instances policy:\n* Override the instance type that is specified in the launch template.\n* Use multiple instance types.\nSpecify the instance types that you want, or define your instance requirements instead and\nlet Amazon EC2 Auto Scaling provision the available instance types that meet your\nrequirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance\ntypes to choose from when fulfilling Spot and On-Demand capacities. You can view which\ninstance types are matched before you apply the instance requirements to your Auto Scaling\ngroup.\nAfter you define your instance requirements, you don't have to keep updating these\nsettings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the\ninstance requirements of the Auto Scaling group to determine whether a new EC2 instance type\ncan be used.\n`LaunchTemplateOverrides` is a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html", "Properties": { "LaunchTemplateSpecification": { "MarkdownDocumentation": "`LaunchTemplateSpecification`\n\nProvides a launch template for the specified instance type or set of instance\nrequirements. For example, some instance types might require a launch template with a\ndifferent AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in\nthe `LaunchTemplate` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\nYou can specify up to 20 launch templates per Auto Scaling group. The launch templates\nspecified in the overrides and in the `LaunchTemplate` definition count\ntowards this limit.\n*Required*: No\n*Type*: [LaunchTemplateSpecification](./aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-launchtemplatespecification", "UpdateType": "Conditional", "Required": false, "Type": "LaunchTemplateSpecification" }, "WeightedCapacity": { "MarkdownDocumentation": "`WeightedCapacity`\n\nIf you provide a list of instance types to use, you can specify the number of capacity\nunits provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or\nother relative performance characteristic. When a Spot or On-Demand Instance is launched, the\ncapacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances\nuntil the desired capacity is totally fulfilled, even if this results in an overage. For\nexample, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can\nonly launch an instance with a `WeightedCapacity` of five units, the instance is\nlaunched, and the desired capacity is exceeded by three units. For more information, see\n[Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon\nEC2 Auto Scaling User Guide*. Value must be in the range of 1-999.\nIf you specify a value for `WeightedCapacity` for one instance type, you must\nspecify a value for `WeightedCapacity` for all of them.\n###### Important\nEvery Auto Scaling group has three size parameters (`DesiredCapacity`,\n`MaxSize`, and `MinSize`). Usually, you set these sizes based on a\nspecific number of instances. However, if you configure a mixed instances policy that\ndefines weights for the instance types, you must specify these sizes with the same units\nthat you use for weighting 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-weightedcapacity", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nThe ID of the Amazon Machine Image (AMI) to use for instances launched with this override. When\nusing Instance Refresh with `ReplaceRootVolume` strategy, this specifies the AMI for root volume\nreplacement operations.\nFor `ReplaceRootVolume` operations:\n* All overrides in the `MixedInstancesPolicy` must specify an ImageId\n* The AMI must contain only a single root volume\n* Root volume replacement doesn't support multi-volume AMIs\n*Required*: No\n*Type*: String\n*Pattern*: `^ami-[a-z0-9]{1,17}$`\n*Minimum*: `5`\n*Maximum*: `21`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-imageid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "InstanceRequirements": { "MarkdownDocumentation": "`InstanceRequirements`\n\nThe instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify\ninstance types. Then, it uses your On-Demand and Spot allocation strategies to launch\ninstances from these instance types.\nYou can specify up to four separate sets of instance requirements per Auto Scaling group. This\nis useful for provisioning instances from different Amazon Machine Images (AMIs) in the\nsame Auto Scaling group. To do this, create the AMIs and create a new launch template for each\nAMI. Then, create a compatible set of instance requirements for each launch template.\n###### Note\nIf you specify `InstanceRequirements`, you can't specify\n`InstanceType`.\n*Required*: No\n*Type*: [InstanceRequirements](./aws-properties-autoscaling-autoscalinggroup-instancerequirements.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-instancerequirements", "UpdateType": "Conditional", "Required": false, "Type": "InstanceRequirements" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type, such as `m3.xlarge`. You must specify an instance type\nthat is supported in your requested Region and Availability Zones. For more information,\nsee [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\nYou can specify up to 40 instance types per Auto Scaling group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html#cfn-autoscaling-autoscalinggroup-launchtemplateoverrides-instancetype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification`\n\nSpecifies a launch template to use when provisioning EC2 instances for an Auto Scaling\ngroup.\nYou must specify the following:\n* The ID or the name of the launch template, but not both.\n* The version of the launch template.\n`LaunchTemplateSpecification` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types.\nFor information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an\nAuto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User\nGuide*.\nFor examples of launch templates, see [Create launch\ntemplates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-launch-templates.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html", "Properties": { "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nThe name of the launch template.\nYou must specify the `LaunchTemplateName` or the `LaunchTemplateID`,\nbut not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-launchtemplatename", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version number of the launch template.\nSpecifying `$Latest` or `$Default` for the template version number\nis not supported. However, you can specify `LatestVersionNumber` or\n`DefaultVersionNumber` using the `Fn::GetAtt` intrinsic function. For\nmore information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).\n###### Note\nFor an example of using the `Fn::GetAtt` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the `AWS::AutoScaling::AutoScalingGroup`\nresource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-version", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nThe ID of the launch template.\nYou must specify the `LaunchTemplateID` or the `LaunchTemplateName`,\nbut not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html#cfn-autoscaling-autoscalinggroup-launchtemplatespecification-launchtemplateid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecification": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecification`\n\n`LifecycleHookSpecification` specifies a lifecycle hook for the\n`LifecycleHookSpecificationList` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. A lifecycle hook specifies actions to\nperform when Amazon EC2 Auto Scaling launches or terminates instances.\nFor more information, see [Amazon EC2 Auto Scaling lifecycle\nhooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a\nsample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples) section of the `AWS::AutoScaling::LifecycleHook`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html", "Properties": { "LifecycleHookName": { "MarkdownDocumentation": "`LifecycleHookName`\n\nThe name of the lifecycle hook.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9\\-_\\/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-lifecyclehookname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LifecycleTransition": { "MarkdownDocumentation": "`LifecycleTransition`\n\nThe lifecycle transition. For Auto Scaling groups, there are two major lifecycle\ntransitions.\n* To create a lifecycle hook for scale-out events, specify\n `autoscaling:EC2_INSTANCE_LAUNCHING`.\n* To create a lifecycle hook for scale-in events, specify\n `autoscaling:EC2_INSTANCE_TERMINATING`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-lifecycletransition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HeartbeatTimeout": { "MarkdownDocumentation": "`HeartbeatTimeout`\n\nThe maximum time, in seconds, that can elapse before the lifecycle hook times out. The\nrange is from `30` to `7200` seconds. The default value is\n`3600` seconds (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-heartbeattimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NotificationMetadata": { "MarkdownDocumentation": "`NotificationMetadata`\n\nAdditional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\nthe notification target.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007e]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-notificationmetadata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultResult": { "MarkdownDocumentation": "`DefaultResult`\n\nThe action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\nunexpected failure occurs. The default value is `ABANDON`.\nValid values: `CONTINUE` | `ABANDON`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-defaultresult", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NotificationTargetARN": { "MarkdownDocumentation": "`NotificationTargetARN`\n\nThe Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends\nnotifications to when an instance is in a wait state for the lifecycle hook. You can\nspecify an Amazon SNS topic or an Amazon SQS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-notificationtargetarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe ARN of the IAM role that allows the Auto Scaling group to publish to the specified\nnotification target. For information about creating this role, see [Prepare to\nadd a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.MemoryGiBPerVCpuRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.MemoryGiBPerVCpuRequest`\n\n`MemoryGiBPerVCpuRequest` is a property of the `InstanceRequirements`\nproperty of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum amount of memory per vCPU for an instance type, in\nGiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-memorygibpervcpurequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe memory minimum in GiB.\n*Required*: No\n*Type*: Number\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-memorygibpervcpurequest.html#cfn-autoscaling-autoscalinggroup-memorygibpervcpurequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe memory maximum in GiB.\n*Required*: No\n*Type*: Number\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-memorygibpervcpurequest.html#cfn-autoscaling-autoscalinggroup-memorygibpervcpurequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Double" } } }, "AWS::AutoScaling::AutoScalingGroup.MemoryMiBRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.MemoryMiBRequest`\n\n`MemoryMiBRequest` is a property of the `InstanceRequirements` property\nof the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum instance memory size for an instance type, in MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-memorymibrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe memory minimum in MiB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-memorymibrequest.html#cfn-autoscaling-autoscalinggroup-memorymibrequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe memory maximum in MiB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-memorymibrequest.html#cfn-autoscaling-autoscalinggroup-memorymibrequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::AutoScalingGroup.MetricsCollection": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.MetricsCollection`\n\n`MetricsCollection` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource that describes the group metrics that\nan Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group\nrather than any of its instances.\nFor more information, see [Monitor CloudWatch metrics for\nyour Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User\nGuide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the `AWS::AutoScaling::AutoScalingGroup`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-metricscollection.html", "Properties": { "Metrics": { "MarkdownDocumentation": "`Metrics`\n\nIdentifies the metrics to enable.\nYou can specify one or more of the following metrics:\n* `GroupMinSize`\n* `GroupMaxSize`\n* `GroupDesiredCapacity`\n* `GroupInServiceInstances`\n* `GroupPendingInstances`\n* `GroupStandbyInstances`\n* `GroupTerminatingInstances`\n* `GroupTotalInstances`\n* `GroupInServiceCapacity`\n* `GroupPendingCapacity`\n* `GroupStandbyCapacity`\n* `GroupTerminatingCapacity`\n* `GroupTotalCapacity`\n* `WarmPoolDesiredCapacity`\n* `WarmPoolWarmedCapacity`\n* `WarmPoolPendingCapacity`\n* `WarmPoolTerminatingCapacity`\n* `WarmPoolTotalCapacity`\n* `GroupAndWarmPoolDesiredCapacity`\n* `GroupAndWarmPoolTotalCapacity`\nIf you specify `Granularity` and don't specify any metrics, all metrics are\nenabled.\nFor more information, see [Amazon CloudWatch metrics for\nAmazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-metricscollection.html#cfn-autoscaling-autoscalinggroup-metricscollection-metrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Granularity": { "MarkdownDocumentation": "`Granularity`\n\nThe frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is\n`1Minute`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-metricscollection.html#cfn-autoscaling-autoscalinggroup-metricscollection-granularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.MixedInstancesPolicy": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.MixedInstancesPolicy`\n\nUse this structure to launch multiple instance types and On-Demand Instances and Spot\nInstances within a single Auto Scaling group.\nA mixed instances policy contains information that Amazon EC2 Auto Scaling can use to\nlaunch instances and help optimize your costs. For more information, see [Auto Scaling\ngroups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2\nAuto Scaling User Guide*.\nYou can create a mixed instances policy for new and existing Auto Scaling groups. You must\nuse a launch template to configure the policy. You cannot use a launch configuration.\nThere are key differences between Spot Instances and On-Demand Instances:\n* The price for Spot Instances varies based on demand\n* Amazon EC2 can terminate an individual Spot Instance as the availability of, or price\n for, Spot Instances changes\nWhen a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a\nreplacement instance to maintain the desired capacity for the group.\n`MixedInstancesPolicy` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html", "Properties": { "InstancesDistribution": { "MarkdownDocumentation": "`InstancesDistribution`\n\nThe instances distribution.\n*Required*: No\n*Type*: [InstancesDistribution](./aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html#cfn-autoscaling-autoscalinggroup-mixedinstancespolicy-instancesdistribution", "UpdateType": "Conditional", "Required": false, "Type": "InstancesDistribution" }, "LaunchTemplate": { "MarkdownDocumentation": "`LaunchTemplate`\n\nOne or more launch templates and the instance types (overrides) that are used to\nlaunch EC2 instances to fulfill On-Demand and Spot capacities.\n*Required*: Yes\n*Type*: [LaunchTemplate](./aws-properties-autoscaling-autoscalinggroup-launchtemplate.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html#cfn-autoscaling-autoscalinggroup-mixedinstancespolicy-launchtemplate", "UpdateType": "Conditional", "Required": true, "Type": "LaunchTemplate" } } }, "AWS::AutoScaling::AutoScalingGroup.NetworkBandwidthGbpsRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.NetworkBandwidthGbpsRequest`\n\n`NetworkBandwidthGbpsRequest` is a property of the\n`InstanceRequirements` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum network bandwidth for an instance type, in Gbps.\n###### Note\nSetting the minimum bandwidth does not guarantee that your instance will achieve the\nminimum bandwidth. Amazon EC2 will identify instance types that support the specified\nminimum bandwidth, but the actual bandwidth of your instance might go below the specified\nminimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux\nInstances*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-networkbandwidthgbpsrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of network bandwidth, in gigabits per second (Gbps).\n*Required*: No\n*Type*: Number\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-networkbandwidthgbpsrequest.html#cfn-autoscaling-autoscalinggroup-networkbandwidthgbpsrequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of network bandwidth, in gigabits per second (Gbps).\n*Required*: No\n*Type*: Number\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-networkbandwidthgbpsrequest.html#cfn-autoscaling-autoscalinggroup-networkbandwidthgbpsrequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Double" } } }, "AWS::AutoScaling::AutoScalingGroup.NetworkInterfaceCountRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.NetworkInterfaceCountRequest`\n\n`NetworkInterfaceCountRequest` is a property of the\n`InstanceRequirements` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum number of network interfaces for an instance type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-networkinterfacecountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of network interfaces.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-networkinterfacecountrequest.html#cfn-autoscaling-autoscalinggroup-networkinterfacecountrequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of network interfaces.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-networkinterfacecountrequest.html#cfn-autoscaling-autoscalinggroup-networkinterfacecountrequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::AutoScalingGroup.NotificationConfiguration": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.NotificationConfiguration`\n\nA structure that specifies an Amazon SNS notification configuration for the\n`NotificationConfigurations` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\nFor an example template snippet, see [Configure Amazon EC2\nAuto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\nFor more information, see [Get Amazon SNS notifications\nwhen your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-notificationconfiguration.html", "Properties": { "TopicARN": { "MarkdownDocumentation": "`TopicARN`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-notificationconfiguration.html#cfn-autoscaling-autoscalinggroup-notificationconfiguration-topicarn", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NotificationTypes": { "MarkdownDocumentation": "`NotificationTypes`\n\nA list of event types that send a notification. Event types can include any of the\nfollowing types.\n*Allowed values*:\n* `autoscaling:EC2_INSTANCE_LAUNCH`\n* `autoscaling:EC2_INSTANCE_LAUNCH_ERROR`\n* `autoscaling:EC2_INSTANCE_TERMINATE`\n* `autoscaling:EC2_INSTANCE_TERMINATE_ERROR`\n* `autoscaling:TEST_NOTIFICATION`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-notificationconfiguration.html#cfn-autoscaling-autoscalinggroup-notificationconfiguration-notificationtypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::AutoScaling::AutoScalingGroup.PerformanceFactorReferenceRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.PerformanceFactorReferenceRequest`\n\nSpecify an instance family to use as the baseline reference for CPU performance. All instance types that All instance types that match your specified attributes will be compared against the CPU performance of the\nreferenced instance family, regardless of CPU manufacturer or architecture differences.\n###### Note\nCurrently only one instance family can be specified in the list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-performancefactorreferencerequest.html", "Properties": { "InstanceFamily": { "MarkdownDocumentation": "`InstanceFamily`\n\nThe instance family to use as a baseline reference.\n###### Note\nMake sure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance `c6i.large`, the\ninstance family is `c6i`, not `c6`. For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in\n*Amazon EC2 Instance Types*.\nThe following instance types are *not supported* for performance protection.\n* `c1`\n* `g3| g3s`\n* `hpc7g`\n* `m1| m2`\n* `mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro`\n* `p3dn | p4d | p5`\n* `t1`\n* `u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb`\nIf you performance protection by specifying a supported instance family, the returned instance types will exclude the preceding unsupported instance families.\nIf you specify an unsupported instance family as a value for baseline performance, the API returns an empty response.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-performancefactorreferencerequest.html#cfn-autoscaling-autoscalinggroup-performancefactorreferencerequest-instancefamily", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.RetentionTriggers": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.RetentionTriggers`\n\nDefines the specific triggers that cause instances to be retained in a Retained state rather than terminated. Each trigger corresponds to a different failure scenario during the instance lifecycle. This allows fine-grained control over when to preserve instances for manual intervention.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-retentiontriggers.html", "Properties": { "TerminateHookAbandon": { "MarkdownDocumentation": "`TerminateHookAbandon`\n\nSpecifies the action when a termination lifecycle hook is abandoned due to failure, timeout, or explicit abandonment (calling CompleteLifecycleAction).\nSet to `Retain` to move instances to a `Retained` state. Set to `Terminate` for default termination behavior.\nRetained instances don't count toward desired capacity and remain until you call `TerminateInstanceInAutoScalingGroup`.\n*Required*: No\n*Type*: String\n*Allowed values*: `retain | terminate...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "retain", "terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-retentiontriggers.html#cfn-autoscaling-autoscalinggroup-retentiontriggers-terminatehookabandon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.TagProperty": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.TagProperty`\n\nA structure that specifies a tag for the `Tags` property of [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\nFor more information, see [Tag Auto Scaling groups and\ninstances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. You can\nfind a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the `AWS::AutoScaling::AutoScalingGroup`\nresource.\nCloudFormation adds the following tags to all Auto Scaling groups and associated\ninstances:\n* aws:cloudformation:stack-name\n* aws:cloudformation:stack-id\n* aws:cloudformation:logical-id\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-tagproperty.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-tagproperty.html#cfn-autoscaling-autoscalinggroup-tagproperty-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-tagproperty.html#cfn-autoscaling-autoscalinggroup-tagproperty-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PropagateAtLaunch": { "MarkdownDocumentation": "`PropagateAtLaunch`\n\nSet to `true` if you want CloudFormation to copy the tag to EC2 instances that\nare launched as part of the Auto Scaling group. Set to `false` if you want the tag\nattached only to the Auto Scaling group and not copied to any instances launched as part of\nthe Auto Scaling group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-tagproperty.html#cfn-autoscaling-autoscalinggroup-tagproperty-propagateatlaunch", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::AutoScaling::AutoScalingGroup.TotalLocalStorageGBRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.TotalLocalStorageGBRequest`\n\n`TotalLocalStorageGBRequest` is a property of the `InstanceRequirements`\nproperty of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum total local storage size for an instance type, in GB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-totallocalstoragegbrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe storage minimum in GB.\n*Required*: No\n*Type*: Number\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-totallocalstoragegbrequest.html#cfn-autoscaling-autoscalinggroup-totallocalstoragegbrequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe storage maximum in GB.\n*Required*: No\n*Type*: Number\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-totallocalstoragegbrequest.html#cfn-autoscaling-autoscalinggroup-totallocalstoragegbrequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Double" } } }, "AWS::AutoScaling::AutoScalingGroup.TrafficSourceIdentifier": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.TrafficSourceIdentifier`\n\nIdentifying information for a traffic source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-trafficsourceidentifier.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nProvides additional context for the value of `Identifier`.\nThe following lists the valid values:\n* `elb` if `Identifier` is the name of a Classic Load Balancer.\n* `elbv2` if `Identifier` is the ARN of an Application Load Balancer, Gateway Load Balancer,\n or Network Load Balancer target group.\n* `vpc-lattice` if `Identifier` is the ARN of a VPC Lattice\n target group.\nRequired if the identifier is the name of a Classic Load Balancer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `511`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-trafficsourceidentifier.html#cfn-autoscaling-autoscalinggroup-trafficsourceidentifier-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nIdentifies the traffic source.\nFor Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name\n(ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name\nof the Classic Load Balancer in this account and Region.\nFor example:\n* Application Load Balancer ARN:\n `arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456`\n* Classic Load Balancer name: `my-classic-load-balancer`\n* VPC Lattice ARN:\n `arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456`\nTo get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a\nClassic Load Balancer, use the Elastic Load Balancing [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) and [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operations.\nTo get the ARN of a target group for VPC Lattice, use the VPC Lattice [GetTargetGroup](https://docs.aws.amazon.com/vpc-lattice/latest/APIReference/API_GetTargetGroup.html) API operation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `511`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-trafficsourceidentifier.html#cfn-autoscaling-autoscalinggroup-trafficsourceidentifier-identifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AutoScaling::AutoScalingGroup.VCpuCountRequest": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup.VCpuCountRequest`\n\n`VCpuCountRequest` is a property of the `InstanceRequirements` property\nof the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that\ndescribes the minimum and maximum number of vCPUs for an instance type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-vcpucountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of vCPUs.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-vcpucountrequest.html#cfn-autoscaling-autoscalinggroup-vcpucountrequest-min", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of vCPUs.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-vcpucountrequest.html#cfn-autoscaling-autoscalinggroup-vcpucountrequest-max", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::LaunchConfiguration.BlockDevice": { "MarkdownDocumentation": "`AWS::AutoScaling::LaunchConfiguration.BlockDevice`\n\n`BlockDevice` is a property of the `EBS` property of the [AWS::AutoScaling::LaunchConfiguration BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevicemapping.html) property type that\ndescribes an Amazon EBS volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html", "Properties": { "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe snapshot ID of the volume to use.\nYou must specify either a `VolumeSize` or a `SnapshotId`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-snapshotid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the\n*Amazon EBS User Guide*.\nValid values: `standard` | `io1` | `gp2` |\n`st1` | `sc1` | `gp3`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-volumetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nSpecifies whether the volume should be encrypted. Encrypted EBS volumes can only be\nattached to instances that support Amazon EBS encryption. For more information, see [Requirements for Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html) in the *Amazon EBS User Guide*. If your AMI uses encrypted volumes, you\ncan also only launch it on supported instance types.\n###### Note\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\nvolume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\na launch configuration.\nIf you enable encryption by default, the EBS volumes that you create are always\nencrypted, either using the AWS managed KMS key or a customer-managed KMS key,\nregardless of whether the snapshot was encrypted.\nFor more information, see [Use AWS KMS keys to encrypt Amazon EBS volumes](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-data-protection.html#encryption) in the\n*Amazon EC2 Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-encrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Throughput": { "MarkdownDocumentation": "`Throughput`\n\nThe throughput (MiBps) to provision for a `gp3` volume.\n*Required*: No\n*Type*: Integer\n*Minimum*: `125`\n*Maximum*: `1000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-throughput", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of input/output (I/O) operations per second (IOPS) to provision for the volume.\nFor `gp3` and `io1` volumes, this represents the number of IOPS that are\nprovisioned for the volume. For `gp2` volumes, this represents the baseline\nperformance of the volume and the rate at which the volume accumulates I/O credits for\nbursting.\nThe following are the supported values for each volume type:\n* `gp3`: 3,000-16,000 IOPS\n* `io1`: 100-64,000 IOPS\nFor `io1` volumes, we guarantee 64,000 IOPS only for [Instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). Other instance families guarantee performance\nup to 32,000 IOPS.\n`Iops` is supported when the volume type is `gp3` or `io1`\nand required only when the volume type is `io1`. (Not used with\n`standard`, `gp2`, `st1`, or `sc1` volumes.)\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-iops", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nThe volume size, in GiBs. The following are the supported volumes sizes for each\nvolume type:\n* `gp2` and `gp3`: 1-16,384\n* `io1`: 4-16,384\n* `st1` and `sc1`: 125-16,384\n* `standard`: 1-1,024\nYou must specify either a `SnapshotId` or a `VolumeSize`. If you\nspecify both `SnapshotId` and `VolumeSize`, the volume size must\nbe equal or greater than the size of the snapshot.\n*Required*: Conditional\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `16384`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-volumesize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nIndicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-deleteontermination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AutoScaling::LaunchConfiguration.BlockDeviceMapping": { "MarkdownDocumentation": "`AWS::AutoScaling::LaunchConfiguration.BlockDeviceMapping`\n\n`BlockDeviceMapping` specifies a block device mapping for the\n`BlockDeviceMappings` property of the [AWS::AutoScaling::LaunchConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html) resource.\nEach instance that is launched has an associated root device volume, either an Amazon EBS\nvolume or an instance store volume. You can use block device mappings to specify additional\nEBS volumes or instance store volumes to attach to an instance when it is launched.\nFor more information, see [Example block device mapping](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#block-device-mapping-ex) in the *Amazon EC2 User Guide for Linux\nInstances*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevicemapping.html", "Properties": { "Ebs": { "MarkdownDocumentation": "`Ebs`\n\nInformation to attach an EBS volume to an instance at launch.\n*Required*: No\n*Type*: [BlockDevice](./aws-properties-autoscaling-launchconfiguration-blockdevice.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevicemapping.html#cfn-autoscaling-launchconfiguration-blockdevicemapping-ebs", "UpdateType": "Immutable", "Required": false, "Type": "BlockDevice" }, "NoDevice": { "MarkdownDocumentation": "`NoDevice`\n\nSetting this value to `true` prevents a volume that is included in the\nblock device mapping of the AMI from being mapped to the specified device name at\nlaunch.\nIf `NoDevice` is `true` for the root device, instances might\nfail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevicemapping.html#cfn-autoscaling-launchconfiguration-blockdevicemapping-nodevice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "VirtualName": { "MarkdownDocumentation": "`VirtualName`\n\nThe name of the instance store volume (virtual device) to attach to an instance at\nlaunch. The name must be in the form ephemeral*X* where\n*X* is a number starting from zero (0), for example,\n`ephemeral0`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevicemapping.html#cfn-autoscaling-launchconfiguration-blockdevicemapping-virtualname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe device name assigned to the volume (for example, `/dev/sdh` or\n`xvdh`). For more information, see [Device naming on Linux\ninstances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html) in the *Amazon EC2 User Guide*.\n###### Note\nTo define a block device mapping, set the device name and exactly one of the\nfollowing properties: `Ebs`, `NoDevice`, or\n`VirtualName`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevicemapping.html#cfn-autoscaling-launchconfiguration-blockdevicemapping-devicename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AutoScaling::LaunchConfiguration.MetadataOptions": { "MarkdownDocumentation": "`AWS::AutoScaling::LaunchConfiguration.MetadataOptions`\n\n`MetadataOptions` is a property of [AWS::AutoScaling::LaunchConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html) that describes metadata options for the\ninstances.\nFor more information, see [Configure the instance metadata options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) in the *Amazon EC2 Auto Scaling\nUser Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-metadataoptions.html", "Properties": { "HttpPutResponseHopLimit": { "MarkdownDocumentation": "`HttpPutResponseHopLimit`\n\nThe desired HTTP PUT response hop limit for instance metadata requests. The larger the\nnumber, the further instance metadata requests can travel.\nDefault: 1\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-metadataoptions.html#cfn-autoscaling-launchconfiguration-metadataoptions-httpputresponsehoplimit", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "HttpTokens": { "MarkdownDocumentation": "`HttpTokens`\n\nThe state of token usage for your instance metadata requests. If the parameter is not\nspecified in the request, the default state is `optional`.\nIf the state is `optional`, you can choose to retrieve instance metadata\nwith or without a signed token header on your request. If you retrieve the IAM role\ncredentials without a token, the version 1.0 role credentials are returned. If you\nretrieve the IAM role credentials using a valid signed token, the version 2.0 role\ncredentials are returned.\nIf the state is `required`, you must send a signed token header with any\ninstance metadata retrieval requests. In this state, retrieving the IAM role credentials\nalways returns the version 2.0 credentials; the version 1.0 credentials are not\navailable.\n*Required*: No\n*Type*: String\n*Allowed values*: `optional | required...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "optional", "required" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-metadataoptions.html#cfn-autoscaling-launchconfiguration-metadataoptions-httptokens", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HttpEndpoint": { "MarkdownDocumentation": "`HttpEndpoint`\n\nThis parameter enables or disables the HTTP metadata endpoint on your instances. If\nthe parameter is not specified, the default state is `enabled`.\n###### Note\nIf you specify a value of `disabled`, you will not be able to access\nyour instance metadata.\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)", "RefReturnValue": "", "AllowedValues": [ "disabled", "enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-metadataoptions.html#cfn-autoscaling-launchconfiguration-metadataoptions-httpendpoint", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.CustomizedMetricSpecification": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.CustomizedMetricSpecification`\n\nContains customized metric specification information for a target tracking scaling policy\nfor Amazon EC2 Auto Scaling.\nTo create your customized metric specification:\n* Add values for each required property from CloudWatch. You can use an existing metric,\n or a new metric that you create. To use your own metric, you must first publish the metric\n to CloudWatch. For more information, see [Publish Custom\n Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide*.\n* Choose a metric that changes proportionally with capacity. The value of the metric\n should increase or decrease in inverse proportion to the number of capacity units. That\n is, the value of the metric should decrease when capacity increases.\nFor more information about CloudWatch, see [Amazon CloudWatch\nConcepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html).\n`CustomizedMetricSpecification` is a property of the [AWS::AutoScaling::ScalingPolicy TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric. To get the exact metric name, namespace, and dimensions,\ninspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object\nthat is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-metricname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Metrics": { "MarkdownDocumentation": "`Metrics`\n\nThe metrics to include in the target tracking scaling policy, as a metric data query.\nThis can include both raw metric and metric math expressions.\n*Required*: No\n*Type*: Array of [TargetTrackingMetricDataQuery](./aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-metrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetTrackingMetricDataQuery", "DuplicatesAllowed": false }, "Statistic": { "MarkdownDocumentation": "`Statistic`\n\nThe statistic of the metric.\n*Required*: No\n*Type*: String\n*Allowed values*: `Average | Minimum | Maximum...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Average", "Minimum", "Maximum", "SampleCount", "Sum" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-statistic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions of the metric.\nConditional: If you published your metric with dimensions, you must specify the same\ndimensions in your scaling policy.\n*Required*: No\n*Type*: Array of [MetricDimension](./aws-properties-autoscaling-scalingpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDimension", "DuplicatesAllowed": false }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n[Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-period", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit of the metric. For a complete list of the units that CloudWatch supports, see the\n[MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)\ndata 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.Metric": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.Metric`\n\nRepresents a specific metric.\n`Metric` is a property of the [AWS::AutoScaling::ScalingPolicy MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metric.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metric.html#cfn-autoscaling-scalingpolicy-metric-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions for the metric. For the list of available dimensions, see the AWS\ndocumentation available from the table in [AWS\nservices that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User\nGuide*.\nConditional: If you published your metric with dimensions, you must specify the same\ndimensions in your scaling policy.\n*Required*: No\n*Type*: Array of [MetricDimension](./aws-properties-autoscaling-scalingpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metric.html#cfn-autoscaling-scalingpolicy-metric-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDimension", "DuplicatesAllowed": false }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric. For more information, see the table in [AWS\nservices that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User\nGuide*.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metric.html#cfn-autoscaling-scalingpolicy-metric-namespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.MetricDataQuery": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.MetricDataQuery`\n\nThe metric data to return. Also defines whether this call is returning data for one metric\nonly, or whether it is performing a math expression on the values of returned metric\nstatistics to create a new time series. A time series is a series of data points, each of\nwhich is associated with a timestamp.\n`MetricDataQuery` is a property of the following property types:\n* [AWS::AutoScaling::ScalingPolicy PredictiveScalingCustomizedScalingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric.html)\n* [AWS::AutoScaling::ScalingPolicy PredictiveScalingCustomizedLoadMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedloadmetric.html)\n* [AWS::AutoScaling::ScalingPolicy PredictiveScalingCustomizedCapacityMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric.html)\nPredictive scaling uses the time series data received from CloudWatch to understand how to\nschedule capacity based on your historical workload patterns.\nYou can call for a single metric or perform math expressions on multiple metrics. Any\nexpressions used in a metric specification must eventually return a single time series.\nFor more information and examples, see [Advanced predictive scaling policy configurations using custom metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html", "Properties": { "ReturnData": { "MarkdownDocumentation": "`ReturnData`\n\nIndicates whether to return the timestamps and raw data values of this metric.\nIf you use any math expressions, specify `true` for this value for only the\nfinal math expression that the metric specification is based on. You must specify\n`false` for `ReturnData` for all the other metrics and\nexpressions used in the metric specification.\nIf you are only retrieving metrics and not performing any math expressions, do not\nspecify anything for `ReturnData`. This sets it to its default\n(`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-returndata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe math expression to perform on the returned data, if this object is performing a\nmath expression. This expression can use the `Id` of the other metrics to\nrefer to those metrics, and can also use the `Id` of other expressions to use\nthe result of those expressions.\nConditional: Within each `MetricDataQuery` object, you must specify either\n`Expression` or `MetricStat`, but not both.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Label": { "MarkdownDocumentation": "`Label`\n\nA human-readable label for this metric or expression. This is especially useful if\nthis is a math expression, so that you know what the value represents.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Maximum*: `2047`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricStat": { "MarkdownDocumentation": "`MetricStat`\n\nInformation about the metric data to return.\nConditional: Within each `MetricDataQuery` object, you must specify either\n`Expression` or `MetricStat`, but not both.\n*Required*: No\n*Type*: [MetricStat](./aws-properties-autoscaling-scalingpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-metricstat", "UpdateType": "Mutable", "Required": false, "Type": "MetricStat" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA short name that identifies the object's results in the response. This name must be\nunique among all `MetricDataQuery` objects specified for a single scaling\npolicy. If you are performing math expressions on this set of data, this name represents\nthat data and can serve as a variable in the mathematical expression. The valid\ncharacters are letters, numbers, and underscores. The first character must be a\nlowercase letter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.MetricDimension": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.MetricDimension`\n\n`MetricDimension` specifies a name/value pair that is part of the identity of a\nCloudWatch metric for the `Dimensions` property of the [AWS::AutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html) property type.\nDuplicate dimensions are not allowed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdimension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdimension.html#cfn-autoscaling-scalingpolicy-metricdimension-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdimension.html#cfn-autoscaling-scalingpolicy-metricdimension-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.MetricStat": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.MetricStat`\n\n`MetricStat` is a property of the [AWS::AutoScaling::ScalingPolicy MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html) property type.\nThis structure defines the CloudWatch metric to return, along with the statistic and\nunit.\nFor more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html", "Properties": { "Stat": { "MarkdownDocumentation": "`Stat`\n\nThe statistic to return. It can include any CloudWatch statistic or extended statistic. For\na list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*.\nThe most commonly used metrics for predictive scaling are `Average` and\n`Sum`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html#cfn-autoscaling-scalingpolicy-metricstat-stat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nThe CloudWatch metric to return, including the metric name, namespace, and dimensions. To\nget the exact metric name, namespace, and dimensions, inspect the [Metric](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*: [Metric](./aws-properties-autoscaling-scalingpolicy-metric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html#cfn-autoscaling-scalingpolicy-metricstat-metric", "UpdateType": "Mutable", "Required": true, "Type": "Metric" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit to use for the returned data points. For a complete list of the units that\nCloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)\ndata 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html#cfn-autoscaling-scalingpolicy-metricstat-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.PredefinedMetricSpecification": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredefinedMetricSpecification`\n\nContains predefined metric specification information for a target tracking scaling policy\nfor Amazon EC2 Auto Scaling.\n`PredefinedMetricSpecification` is a property of the [AWS::AutoScaling::ScalingPolicy TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html", "Properties": { "PredefinedMetricType": { "MarkdownDocumentation": "`PredefinedMetricType`\n\nThe metric type. The following predefined metrics are available:\n* `ASGAverageCPUUtilization` - Average CPU utilization of the Auto Scaling\n group.\n* `ASGAverageNetworkIn` - Average number of bytes received on all\n network interfaces by the Auto Scaling group.\n* `ASGAverageNetworkOut` - Average number of bytes sent out on all\n network interfaces by the Auto Scaling group.\n* `ALBRequestCountPerTarget` - Average Application Load Balancer request count per target\n for your Auto Scaling group.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASGAverageCPUUtilization | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "ALBRequestCountPerTarget" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-predefinedmetrictype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceLabel": { "MarkdownDocumentation": "`ResourceLabel`\n\nA label that uniquely identifies a specific Application Load Balancer target group\nfrom which to determine the average request count served by your Auto Scaling group. You can't\nspecify 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\nand the final portion of the target group ARN into a single value, separated by a forward\nslash (/). 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\n the load balancer ARN\n* targetgroup// is the final portion\n 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\nthe [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration`\n\n`PredictiveScalingConfiguration` is a property of the [AWS::AutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html) resource that specifies a predictive scaling policy\nfor Amazon EC2 Auto Scaling.\nFor more information, see [Predictive\nscaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html", "Properties": { "MaxCapacityBreachBehavior": { "MarkdownDocumentation": "`MaxCapacityBreachBehavior`\n\nDefines the behavior that should be applied if the forecast capacity approaches or\nexceeds the maximum capacity of the Auto Scaling group. Defaults to\n`HonorMaxCapacity` if not specified.\nThe following are possible values:\n* `HonorMaxCapacity` - Amazon EC2 Auto Scaling can't increase the maximum capacity\n of the group when the forecast capacity is close to or exceeds the maximum\n capacity.\n* `IncreaseMaxCapacity` - Amazon EC2 Auto Scaling can increase the maximum capacity\n of the group when the forecast capacity is close to or exceeds the maximum\n capacity. The upper limit is determined by the forecasted capacity and the value\n for `MaxCapacityBuffer`.\n###### Important\nUse caution when allowing the maximum capacity to be automatically increased. This\ncan lead to more instances being launched than intended if the increased maximum\ncapacity is not monitored and managed. The increased maximum capacity then becomes\nthe new normal maximum capacity for the Auto Scaling group until you manually update\nit. The maximum capacity does not automatically decrease back to the original\nmaximum.\n*Required*: No\n*Type*: String\n*Allowed values*: `HonorMaxCapacity | Increase...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HonorMaxCapacity", "IncreaseMaxCapacity" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-maxcapacitybreachbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxCapacityBuffer": { "MarkdownDocumentation": "`MaxCapacityBuffer`\n\nThe size of the capacity buffer to use when the forecast capacity is close to or\nexceeds the maximum capacity. The value is specified as a percentage relative to the\nforecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\nsuch that if the forecast capacity is 50, and the maximum capacity is 40, then the\neffective maximum capacity is 55.\nIf set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but\nnot exceed forecast capacity.\nRequired if the `MaxCapacityBreachBehavior` property is set to\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-maxcapacitybuffer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe predictive scaling mode. Defaults to `ForecastOnly` if not\nspecified.\n*Required*: No\n*Type*: String\n*Allowed values*: `ForecastAndScale | Forecast...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ForecastAndScale", "ForecastOnly" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricSpecifications": { "MarkdownDocumentation": "`MetricSpecifications`\n\nThis structure includes the metrics and target utilization to use for predictive\nscaling.\nThis is an array, but we currently only support a single metric specification. That\nis, you can specify a target value and a single metric pair, or a target value and one\nscaling metric and one load metric.\n*Required*: Yes\n*Type*: Array of [PredictiveScalingMetricSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-metricspecifications", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PredictiveScalingMetricSpecification", "DuplicatesAllowed": false }, "SchedulingBufferTime": { "MarkdownDocumentation": "`SchedulingBufferTime`\n\nThe amount of time, in seconds, by which the instance launch time can be advanced. For\nexample, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch\ninstances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The\nintention is to give resources time to be provisioned. It can take a few minutes to\nlaunch an EC2 instance. The actual amount of time required depends on several factors,\nsuch 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\nminutes). 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration-schedulingbuffertime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::ScalingPolicy.PredictiveScalingCustomizedCapacityMetric": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredictiveScalingCustomizedCapacityMetric`\n\nContains capacity metric information for the\n`CustomizedCapacityMetricSpecification` property of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) property\ntype.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric.html", "Properties": { "MetricDataQueries": { "MarkdownDocumentation": "`MetricDataQueries`\n\nOne or more metric data queries to provide the data points for a capacity metric. Use\nmultiple metric data queries only if you are performing a math expression on returned\ndata.\n*Required*: Yes\n*Type*: Array of [MetricDataQuery](./aws-properties-autoscaling-scalingpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric.html#cfn-autoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric-metricdataqueries", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MetricDataQuery", "DuplicatesAllowed": false } } }, "AWS::AutoScaling::ScalingPolicy.PredictiveScalingCustomizedLoadMetric": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredictiveScalingCustomizedLoadMetric`\n\nContains load metric information for the `CustomizedLoadMetricSpecification`\nproperty of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) property\ntype.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedloadmetric.html", "Properties": { "MetricDataQueries": { "MarkdownDocumentation": "`MetricDataQueries`\n\nOne or more metric data queries to provide the data points for a load metric. Use\nmultiple metric data queries only if you are performing a math expression on returned\ndata.\n*Required*: Yes\n*Type*: Array of [MetricDataQuery](./aws-properties-autoscaling-scalingpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedloadmetric.html#cfn-autoscaling-scalingpolicy-predictivescalingcustomizedloadmetric-metricdataqueries", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MetricDataQuery", "DuplicatesAllowed": false } } }, "AWS::AutoScaling::ScalingPolicy.PredictiveScalingCustomizedScalingMetric": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredictiveScalingCustomizedScalingMetric`\n\nContains scaling metric information for the\n`CustomizedScalingMetricSpecification` property of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) property\ntype.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric.html", "Properties": { "MetricDataQueries": { "MarkdownDocumentation": "`MetricDataQueries`\n\nOne or more metric data queries to provide the data points for a scaling metric. Use\nmultiple metric data queries only if you are performing a math expression on returned\ndata.\n*Required*: Yes\n*Type*: Array of [MetricDataQuery](./aws-properties-autoscaling-scalingpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric.html#cfn-autoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric-metricdataqueries", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MetricDataQuery", "DuplicatesAllowed": false } } }, "AWS::AutoScaling::ScalingPolicy.PredictiveScalingMetricSpecification": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredictiveScalingMetricSpecification`\n\nA structure that specifies a metric specification for the\n`MetricSpecifications` property of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html) property\ntype.\nYou must specify either a metric pair, or a load metric and a scaling metric individually.\nSpecifying a metric pair instead of individual metrics provides a simpler way to configure\nmetrics for a scaling policy. You choose the metric pair, and the policy automatically knows\nthe correct sum and average statistics to use for the load metric and the scaling\nmetric.\nExample\n* You create a predictive scaling policy and specify `ALBRequestCount` as the\n value for the metric pair and `1000.0` as the target value. For this type of\n metric, you must provide the metric dimension for the corresponding target group, so you\n also provide a resource label for the Application Load Balancer target group that is\n attached to your Auto Scaling group.\n* The number of requests the target group receives per minute provides the load metric,\n and the request count averaged between the members of the target group provides the\n scaling metric. In CloudWatch, this refers to the `RequestCount` and\n `RequestCountPerTarget` metrics, respectively.\n* For optimal use of predictive scaling, you adhere to the best practice of using a\n dynamic scaling policy to automatically scale between the minimum capacity and maximum\n capacity in response to real-time changes in resource utilization.\n* Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days\n and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data\n is required.)\n* After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or\n increase the capacity of your Auto Scaling group in each hour of the forecast period so\n that the average number of requests received by each instance is as close to 1000 requests\n per minute as possible at all times.\nFor information about using custom metrics with predictive scaling, see [Advanced predictive scaling policy configurations using custom metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html", "Properties": { "CustomizedLoadMetricSpecification": { "MarkdownDocumentation": "`CustomizedLoadMetricSpecification`\n\nThe customized load metric specification.\n*Required*: No\n*Type*: [PredictiveScalingCustomizedLoadMetric](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-autoscaling-scalingpolicy-predictivescalingmetricspecification-customizedloadmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingCustomizedLoadMetric" }, "PredefinedLoadMetricSpecification": { "MarkdownDocumentation": "`PredefinedLoadMetricSpecification`\n\nThe predefined load metric specification.\n*Required*: No\n*Type*: [PredictiveScalingPredefinedLoadMetric](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-autoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedloadmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingPredefinedLoadMetric" }, "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nSpecifies the target utilization.\n###### Note\nSome metrics are based on a count instead of a percentage, such as the request\ncount for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\nspecifies one of these metrics, specify the target utilization as the optimal\naverage request or message count per instance during any one-minute interval.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-autoscaling-scalingpolicy-predictivescalingmetricspecification-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "PredefinedScalingMetricSpecification": { "MarkdownDocumentation": "`PredefinedScalingMetricSpecification`\n\nThe predefined scaling metric specification.\n*Required*: No\n*Type*: [PredictiveScalingPredefinedScalingMetric](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-autoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedscalingmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingPredefinedScalingMetric" }, "CustomizedCapacityMetricSpecification": { "MarkdownDocumentation": "`CustomizedCapacityMetricSpecification`\n\nThe customized capacity metric specification.\n*Required*: No\n*Type*: [PredictiveScalingCustomizedCapacityMetric](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-autoscaling-scalingpolicy-predictivescalingmetricspecification-customizedcapacitymetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingCustomizedCapacityMetric" }, "CustomizedScalingMetricSpecification": { "MarkdownDocumentation": "`CustomizedScalingMetricSpecification`\n\nThe customized scaling metric specification.\n*Required*: No\n*Type*: [PredictiveScalingCustomizedScalingMetric](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-autoscaling-scalingpolicy-predictivescalingmetricspecification-customizedscalingmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingCustomizedScalingMetric" }, "PredefinedMetricPairSpecification": { "MarkdownDocumentation": "`PredefinedMetricPairSpecification`\n\nThe predefined metric pair specification from which Amazon EC2 Auto Scaling determines the\nappropriate scaling metric and load metric to use.\n*Required*: No\n*Type*: [PredictiveScalingPredefinedMetricPair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html#cfn-autoscaling-scalingpolicy-predictivescalingmetricspecification-predefinedmetricpairspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingPredefinedMetricPair" } } }, "AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedLoadMetric": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedLoadMetric`\n\nContains load metric information for the `PredefinedLoadMetricSpecification`\nproperty of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) property\ntype.\n###### Important\nDoes not apply to policies that use a *metric pair* for the metric\nspecification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html", "Properties": { "PredefinedMetricType": { "MarkdownDocumentation": "`PredefinedMetricType`\n\nThe metric type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASGTotalCPUUtilization | AS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ASGTotalCPUUtilization", "ASGTotalNetworkIn", "ASGTotalNetworkOut", "ALBTargetGroupRequestCount" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html#cfn-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric-predefinedmetrictype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceLabel": { "MarkdownDocumentation": "`ResourceLabel`\n\nA label that uniquely identifies a specific Application Load Balancer target group from which to determine\nthe request count served by your Auto Scaling group. You can't specify a resource label unless\nthe target group is attached to the Auto Scaling group.\nYou create the resource label by appending the final portion of the load balancer ARN\nand the final portion of the target group ARN into a single value, separated by a forward\nslash (/). 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\n the load balancer ARN\n* targetgroup// is the final portion\n 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\nthe [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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html#cfn-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric-resourcelabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedMetricPair": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedMetricPair`\n\nContains metric pair information for the `PredefinedMetricPairSpecification`\nproperty of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) property\ntype.\nFor more information, see [Predictive\nscaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html", "Properties": { "PredefinedMetricType": { "MarkdownDocumentation": "`PredefinedMetricType`\n\nIndicates which metrics to use. There are two different types of metrics for each\nmetric type: one is a load metric and one is a scaling metric. For example, if the\nmetric type is `ASGCPUUtilization`, the Auto Scaling group's total CPU metric is used\nas the load metric, and the average CPU metric is used for the scaling metric.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASGCPUUtilization | ASGNetw...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ASGCPUUtilization", "ASGNetworkIn", "ASGNetworkOut", "ALBRequestCount" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html#cfn-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair-predefinedmetrictype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceLabel": { "MarkdownDocumentation": "`ResourceLabel`\n\nA label that uniquely identifies a specific Application Load Balancer target group from\nwhich to determine the total and average request count served by your Auto Scaling group. You\ncan't specify a resource label unless the target group is attached to the Auto Scaling\ngroup.\nYou create the resource label by appending the final portion of the load balancer ARN and\nthe final portion of the target group ARN into a single value, separated by a forward slash\n(/). 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\n load balancer ARN\n* targetgroup// is the final portion of\n 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\n[DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html#cfn-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair-resourcelabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedScalingMetric": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedScalingMetric`\n\nContains scaling metric information for the\n`PredefinedScalingMetricSpecification` property of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) property\ntype.\n###### Important\nDoes not apply to policies that use a *metric pair* for the metric\nspecification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html", "Properties": { "PredefinedMetricType": { "MarkdownDocumentation": "`PredefinedMetricType`\n\nThe metric type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASGAverageCPUUtilization | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "ALBRequestCountPerTarget" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html#cfn-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric-predefinedmetrictype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceLabel": { "MarkdownDocumentation": "`ResourceLabel`\n\nA label that uniquely identifies a specific Application Load Balancer target group from which to determine\nthe average request count served by your Auto Scaling group. You can't specify a resource label\nunless 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\nand the final portion of the target group ARN into a single value, separated by a forward\nslash (/). 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\n the load balancer ARN\n* targetgroup// is the final portion\n 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\nthe [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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html#cfn-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric-resourcelabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.StepAdjustment": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.StepAdjustment`\n\n`StepAdjustment` specifies a step adjustment for the `StepAdjustments`\nproperty of the [AWS::AutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html) resource.\nFor the following examples, suppose that you have an alarm with a breach threshold of 50:\n* To trigger a step adjustment when the metric is greater than or equal to 50 and less\n than 60, specify a lower bound of 0 and an upper bound of 10.\n* To trigger a step adjustment when the metric is greater than 40 and less than or equal\n to 50, specify a lower bound of -10 and an upper bound of 0.\nThere are a few rules for the step adjustments for your step policy:\n* The ranges of your step adjustments can't overlap or have a gap.\n* At most one step adjustment can have a null lower bound. If one step adjustment has a\n negative lower bound, then there must be a step adjustment with a null lower bound.\n* At most one step adjustment can have a null upper bound. If one step adjustment has a\n positive upper bound, then there must be a step adjustment with a null upper bound.\n* The upper and lower bound can't be null in the same step adjustment.\nFor more information, see [Step\nadjustments](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps) in the *Amazon EC2 Auto Scaling User Guide*.\nYou can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#aws-resource-autoscaling-scalingpolicy--examples) section of the `AWS::AutoScaling::ScalingPolicy`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustment.html", "Properties": { "MetricIntervalUpperBound": { "MarkdownDocumentation": "`MetricIntervalUpperBound`\n\nThe upper bound for the difference between the alarm threshold and the CloudWatch metric. If\nthe metric value is above the breach threshold, the upper bound is exclusive (the metric\nmust be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\nmetric must be less than or equal to the threshold plus the upper bound). A null value\nindicates positive infinity.\nThe upper bound must be greater than the lower bound.\n*Required*: Conditional\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustment.html#cfn-autoscaling-scalingpolicy-stepadjustment-metricintervalupperbound", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MetricIntervalLowerBound": { "MarkdownDocumentation": "`MetricIntervalLowerBound`\n\nThe lower bound for the difference between the alarm threshold and the CloudWatch metric. If\nthe metric value is above the breach threshold, the lower bound is inclusive (the metric\nmust be greater than or equal to the threshold plus the lower bound). Otherwise, it is\nexclusive (the metric must be greater than the threshold plus the lower bound). A null\nvalue indicates negative infinity.\n*Required*: Conditional\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustment.html#cfn-autoscaling-scalingpolicy-stepadjustment-metricintervallowerbound", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ScalingAdjustment": { "MarkdownDocumentation": "`ScalingAdjustment`\n\nThe amount by which to scale, based on the specified adjustment type. A positive value\nadds to the current capacity while a negative number removes from the current capacity.\nFor exact capacity, you must specify a non-negative 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustment.html#cfn-autoscaling-scalingpolicy-stepadjustment-scalingadjustment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration`\n\n`TargetTrackingConfiguration` is a property of the [AWS::AutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html) resource that specifies a target tracking scaling\npolicy configuration for Amazon EC2 Auto Scaling.\nFor more information about scaling policies, see [Dynamic scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html", "Properties": { "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nThe target value for the metric.\n###### Note\nSome metrics are based on a count instead of a percentage, such as the request\ncount for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\nspecifies one of these metrics, specify the target utilization as the optimal\naverage request or message count per instance during any one-minute interval.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "CustomizedMetricSpecification": { "MarkdownDocumentation": "`CustomizedMetricSpecification`\n\nA customized metric. You must specify either a predefined metric or a customized\nmetric.\n*Required*: Conditional\n*Type*: [CustomizedMetricSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-customizedmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "CustomizedMetricSpecification" }, "DisableScaleIn": { "MarkdownDocumentation": "`DisableScaleIn`\n\nIndicates whether scaling in by the target tracking scaling policy is disabled. If\nscaling in is disabled, the target tracking scaling policy doesn't remove instances from\nthe Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-disablescalein", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PredefinedMetricSpecification": { "MarkdownDocumentation": "`PredefinedMetricSpecification`\n\nA predefined metric. You must specify either a predefined metric or a customized\nmetric.\n*Required*: Conditional\n*Type*: [PredefinedMetricSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-predefinedmetricspecification", "UpdateType": "Mutable", "Required": false, "Type": "PredefinedMetricSpecification" } } }, "AWS::AutoScaling::ScalingPolicy.TargetTrackingMetricDataQuery": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.TargetTrackingMetricDataQuery`\n\nThe metric data to return. Also defines whether this call is returning data for one\nmetric only, or whether it is performing a math expression on the values of returned\nmetric statistics to create a new time series. A time series is a series of data points,\neach of which is associated with a timestamp.\nYou can use `TargetTrackingMetricDataQuery` structures with a\n[PutScalingPolicy](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PutScalingPolicy.html) operation when you specify a\n[TargetTrackingConfiguration](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html)\nin the request.\nYou can call for a single metric or perform math expressions on multiple\nmetrics. Any expressions used in a metric specification must eventually return a single\ntime series.\nFor more information, see the [Create a target tracking scaling policy for Amazon EC2 Auto Scaling using metric math](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-target-tracking-metric-math.html) in\nthe *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html", "Properties": { "ReturnData": { "MarkdownDocumentation": "`ReturnData`\n\nIndicates whether to return the timestamps and raw data values of this metric.\nIf you use any math expressions, specify `true` for this value for only the\nfinal math expression that the metric specification is based on. You must specify\n`false` for `ReturnData` for all the other metrics and\nexpressions used in the metric specification.\nIf you are only retrieving metrics and not performing any math expressions, do not\nspecify anything for `ReturnData`. This sets it to its default\n(`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-autoscaling-scalingpolicy-targettrackingmetricdataquery-returndata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe math expression to perform on the returned data, if this object is performing a\nmath expression. This expression can use the `Id` of the other metrics to\nrefer to those metrics, and can also use the `Id` of other expressions to use\nthe result of those expressions.\nConditional: Within each `TargetTrackingMetricDataQuery` object, you must\nspecify either `Expression` or `MetricStat`, but not both.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `2047`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-autoscaling-scalingpolicy-targettrackingmetricdataquery-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Label": { "MarkdownDocumentation": "`Label`\n\nA human-readable label for this metric or expression. This is especially useful if\nthis is a math expression, so that you know what the value represents.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Maximum*: `2047`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-autoscaling-scalingpolicy-targettrackingmetricdataquery-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricStat": { "MarkdownDocumentation": "`MetricStat`\n\nInformation about the metric data to return.\nConditional: Within each `TargetTrackingMetricDataQuery` object, you must\nspecify either `Expression` or `MetricStat`, but not both.\n*Required*: No\n*Type*: [TargetTrackingMetricStat](./aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-autoscaling-scalingpolicy-targettrackingmetricdataquery-metricstat", "UpdateType": "Mutable", "Required": false, "Type": "TargetTrackingMetricStat" }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n[Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-autoscaling-scalingpolicy-targettrackingmetricdataquery-period", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA short name that identifies the object's results in the response. This name must be\nunique among all `TargetTrackingMetricDataQuery` objects specified for a\nsingle scaling policy. If you are performing math expressions on this set of data, this\nname represents that data and can serve as a variable in the mathematical expression.\nThe valid characters are letters, numbers, and underscores. The first character must be\na lowercase letter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricdataquery.html#cfn-autoscaling-scalingpolicy-targettrackingmetricdataquery-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy.TargetTrackingMetricStat": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy.TargetTrackingMetricStat`\n\nThis structure defines the CloudWatch metric to return, along with the statistic and\nunit.\n`TargetTrackingMetricStat` is a property of the\n[TargetTrackingMetricDataQuery](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingMetricDataQuery.html)\nobject.\nFor more information about the CloudWatch terminology below, see [Amazon CloudWatch\nconcepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html", "Properties": { "Stat": { "MarkdownDocumentation": "`Stat`\n\nThe statistic to return. It can include any CloudWatch statistic or extended statistic. For\na list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*.\nThe most commonly used metric for scaling is `Average`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-autoscaling-scalingpolicy-targettrackingmetricstat-stat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n[Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-autoscaling-scalingpolicy-targettrackingmetricstat-period", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nThe metric to use.\n*Required*: Yes\n*Type*: [Metric](./aws-properties-autoscaling-scalingpolicy-metric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-autoscaling-scalingpolicy-targettrackingmetricstat-metric", "UpdateType": "Mutable", "Required": true, "Type": "Metric" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit to use for the returned data points. For a complete list of the units that\nCloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)\ndata 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-autoscaling-scalingpolicy-targettrackingmetricstat-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::WarmPool.InstanceReusePolicy": { "MarkdownDocumentation": "`AWS::AutoScaling::WarmPool.InstanceReusePolicy`\n\nA structure that specifies an instance reuse policy for the\n`InstanceReusePolicy` property of the [AWS::AutoScaling::WarmPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html) resource.\nFor more information, see [Warm pools for Amazon EC2\nAuto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-warmpool-instancereusepolicy.html", "Properties": { "ReuseOnScaleIn": { "MarkdownDocumentation": "`ReuseOnScaleIn`\n\nSpecifies whether instances in the Auto Scaling group can be returned to the warm pool on\nscale 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-warmpool-instancereusepolicy.html#cfn-autoscaling-warmpool-instancereusepolicy-reuseonscalein", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AutoScalingPlans::ScalingPlan.ApplicationSource": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.ApplicationSource`\n\n`ApplicationSource` is a property of [ScalingPlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html) that specifies the application source to use with a scaling plan. You can create one scaling plan per application source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html", "Properties": { "CloudFormationStackARN": { "Required": false, "MarkdownDocumentation": "`CloudFormationStackARN`\n\nThe Amazon Resource Name (ARN) of a CloudFormation stack.\nYou must specify either a `CloudFormationStackARN` or\n`TagFilters`.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-cloudformationstackarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TagFilters": { "Type": "List", "Required": false, "MarkdownDocumentation": "`TagFilters`\n\nA set of tag filters (keys and values). Each tag filter specified must contain a key\nwith values as optional. Each scaling plan can include up to 50 keys, and each key can\ninclude up to 20 values.\nTags are part of the syntax that you use to specify the resources you want returned when\nconfiguring a scaling plan from the AWS Auto Scaling console. You do not need to\nspecify valid tag filter values when you create a scaling plan with CloudFormation. The\n`Key` and `Values` properties can accept any value as long as the\ncombination of values is unique across scaling plans. However, if you also want to use the\nAWS Auto Scaling console to edit the scaling plan, then you must specify valid\nvalues.\nYou must specify either a `CloudFormationStackARN` or\n`TagFilters`.\n*Required*: No\n*Type*: Array of [TagFilter](./aws-properties-autoscalingplans-scalingplan-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-tagfilters", "ItemType": "TagFilter", "UpdateType": "Mutable" } } }, "AWS::AutoScalingPlans::ScalingPlan.CustomizedLoadMetricSpecification": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.CustomizedLoadMetricSpecification`\n\n`CustomizedLoadMetricSpecification` is a subproperty of [ScalingInstruction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html) that specifies a customized load metric for predictive\nscaling to use with a scaling plan.\nFor predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the `Sum` and `Average` statistics\nthat CloudWatch computes from metric data.\nWhen you choose a load metric, make sure that the required `Sum` and\n`Average` statistics for your metric are available in CloudWatch and that\nthey provide relevant data for predictive scaling. The `Sum` statistic must\nrepresent the total load on the resource, and the `Average` statistic must\nrepresent the average load per capacity unit of the resource. For example, there is a\nmetric that counts the number of requests processed by your Auto Scaling group. If the\n`Sum` statistic represents the total request count processed by the group,\nthen the `Average` statistic for the specified metric must represent the average\nrequest count processed by each instance of the group.\nIf you publish your own metrics, you can aggregate the data points at a given interval\nand then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling\ngenerates the forecast, it sums up all the metric data points that occurred within each\nhour to match the granularity period that is used in the forecast (60 minutes).\nFor information about terminology, available metrics, or how to publish new metrics, see\n[Amazon CloudWatch\nConcepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*.\nAfter creating your scaling plan, you can use the AWS Auto Scaling console to\nvisualize forecasts for the specified metric. For more information, see [View\nscaling information for a resource](https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) in the *Scaling Plans User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html", "Properties": { "MetricName": { "Required": true, "MarkdownDocumentation": "`MetricName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-metricname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Statistic": { "Required": true, "MarkdownDocumentation": "`Statistic`\n\nThe statistic of the metric.\n*Allowed Values*: `Sum`\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-statistic", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Dimensions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions of the metric.\nConditional: If you published your metric with dimensions, you must specify the same\ndimensions in your customized load metric specification.\n*Required*: No\n*Type*: Array of [MetricDimension](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-dimensions", "ItemType": "MetricDimension", "UpdateType": "Mutable" }, "Unit": { "Required": false, "MarkdownDocumentation": "`Unit`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-unit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Namespace": { "Required": true, "MarkdownDocumentation": "`Namespace`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedloadmetricspecification-namespace", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AutoScalingPlans::ScalingPlan.CustomizedScalingMetricSpecification": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.CustomizedScalingMetricSpecification`\n\n`CustomizedScalingMetricSpecification` is a subproperty of [TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html) that specifies a customized scaling metric for a\ntarget tracking configuration to use with a scaling plan.\nTo create your customized scaling metric specification:\n* Add values for each required property from CloudWatch. You can use an existing\n metric, or a new metric that you create. To use your own metric, you must first\n publish the metric to CloudWatch. For more information, see [Publish Custom\n Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide*.\n* Choose a metric that changes proportionally with capacity. The value of the metric\n should increase or decrease in inverse proportion to the number of capacity units.\n That is, the value of the metric should decrease when capacity increases.\nFor information about terminology, available metrics, or how to publish new metrics, see\n[Amazon CloudWatch\nConcepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html", "Properties": { "MetricName": { "Required": true, "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric. To get the exact metric name, namespace, and dimensions, inspect\nthe [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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-metricname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Statistic": { "Required": true, "MarkdownDocumentation": "`Statistic`\n\nThe statistic of the metric.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Average | Minimum | Maximum...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Average", "Minimum", "Maximum", "SampleCount", "Sum" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-statistic", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Dimensions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions of the metric.\nConditional: If you published your metric with dimensions, you must specify the same\ndimensions in your scaling policy.\n*Required*: No\n*Type*: Array of [MetricDimension](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-dimensions", "ItemType": "MetricDimension", "UpdateType": "Mutable" }, "Unit": { "Required": false, "MarkdownDocumentation": "`Unit`\n\nThe unit of the metric. For a complete list of the units that CloudWatch supports, see the\n[MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data\ntype 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-unit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Namespace": { "Required": true, "MarkdownDocumentation": "`Namespace`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-namespace", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AutoScalingPlans::ScalingPlan.MetricDimension": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.MetricDimension`\n\n`MetricDimension` is a subproperty of [CustomizedScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html) that specifies a dimension for a\ncustomized metric to use with a scaling plan.\nDimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric.\nDuplicate dimensions are not allowed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html", "Properties": { "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nThe value 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-value", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AutoScalingPlans::ScalingPlan.PredefinedLoadMetricSpecification": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.PredefinedLoadMetricSpecification`\n\n`PredefinedLoadMetricSpecification` is a subproperty of\n[ScalingInstruction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html)\nthat specifies a predefined load metric for predictive\nscaling to use with a scaling plan.\nAfter creating your scaling plan, you can use the AWS Auto Scaling console to\nvisualize forecasts for the specified metric. For more information, see [View\nscaling information for a resource](https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) in the *Scaling Plans User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html", "Properties": { "PredefinedLoadMetricType": { "Required": true, "MarkdownDocumentation": "`PredefinedLoadMetricType`\n\nThe metric type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASGTotalCPUUtilization | AS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ASGTotalCPUUtilization", "ASGTotalNetworkIn", "ASGTotalNetworkOut", "ALBTargetGroupRequestCount" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-predefinedloadmetrictype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResourceLabel": { "Required": false, "MarkdownDocumentation": "`ResourceLabel`\n\nIdentifies the resource associated with the metric type. You can't specify a resource\nlabel unless the metric type is `ALBTargetGroupRequestCount` and there is a\ntarget group for an Application Load Balancer attached to the Auto Scaling group.\nYou create the resource label by appending the final portion of the load balancer ARN\nand the final portion of the target group ARN into a single value, separated by a forward\nslash (/). The format is\napp///targetgroup//,\nwhere:\n* app// is the final portion of\n the load balancer ARN\n* targetgroup// is the final portion\n of the target group ARN.\nThis is an example:\napp/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.\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\nthe [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*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedloadmetricspecification-resourcelabel", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AutoScalingPlans::ScalingPlan.PredefinedScalingMetricSpecification": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.PredefinedScalingMetricSpecification`\n\n`PredefinedScalingMetricSpecification` is a subproperty of [TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html) that specifies a customized scaling metric for a\ntarget tracking configuration to use with a scaling plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html", "Properties": { "ResourceLabel": { "Required": false, "MarkdownDocumentation": "`ResourceLabel`\n\nIdentifies the resource associated with the metric type. You can't specify a resource\nlabel unless the metric type is `ALBRequestCountPerTarget` and there is a target\ngroup for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or\nECS service.\nYou create the resource label by appending the final portion of the load balancer ARN\nand the final portion of the target group ARN into a single value, separated by a forward\nslash (/). The format is\napp///targetgroup//,\nwhere:\n* app// is the final portion of\n the load balancer ARN\n* targetgroup// is the final portion\n of the target group ARN.\nThis is an example:\napp/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.\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\nthe [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*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-resourcelabel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PredefinedScalingMetricType": { "Required": true, "MarkdownDocumentation": "`PredefinedScalingMetricType`\n\nThe metric type. The `ALBRequestCountPerTarget` metric type applies only to\nAuto Scaling groups, Spot Fleet requests, and ECS services.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASGAverageCPUUtilization | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "DynamoDBReadCapacityUtilization", "DynamoDBWriteCapacityUtilization", "ECSServiceAverageCPUUtilization", "ECSServiceAverageMemoryUtilization", "ALBRequestCountPerTarget", "RDSReaderAverageCPUUtilization", "RDSReaderAverageDatabaseConnections", "EC2SpotFleetRequestAverageCPUUtilization", "EC2SpotFleetRequestAverageNetworkIn", "EC2SpotFleetRequestAverageNetworkOut" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-predefinedscalingmetrictype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AutoScalingPlans::ScalingPlan.ScalingInstruction": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.ScalingInstruction`\n\n`ScalingInstruction` is a property of [ScalingPlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html) that specifies the scaling instruction for a scalable resource in a\nscaling plan. Each scaling instruction applies to one resource.\nAWS Auto Scaling creates target tracking scaling policies based on the scaling\ninstructions. Target tracking scaling policies adjust the capacity of your scalable\nresource as required to maintain resource utilization at the target value that you\nspecified.\nAWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto\nScaling groups using a subset of properties, including the load metric, the scaling metric,\nthe target value for the scaling metric, the predictive scaling mode (forecast and scale or\nforecast only), and the desired behavior when the forecast capacity exceeds the maximum\ncapacity of the resource. With predictive scaling, AWS Auto Scaling generates\nforecasts with traffic predictions for the two days ahead and schedules scaling actions\nthat proactively add and remove resource capacity to match the forecast.\n###### Important\nWe recommend waiting a minimum of 24 hours after creating an Auto Scaling group to\nconfigure predictive scaling. At minimum, there must be 24 hours of historical data to\ngenerate a forecast. For more information, see [Best practices for scaling plans](https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-best-practices.html) in the *Scaling Plans User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html", "Properties": { "DisableDynamicScaling": { "Required": false, "MarkdownDocumentation": "`DisableDynamicScaling`\n\nControls whether dynamic scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling\ncreates target tracking scaling policies based on the specified target tracking\nconfigurations.\nThe default is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-disabledynamicscaling", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ServiceNamespace": { "Required": true, "MarkdownDocumentation": "`ServiceNamespace`\n\nThe namespace of the AWS service.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `autoscaling | ecs | ec2 | r...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "autoscaling", "ecs", "ec2", "rds", "dynamodb" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-servicenamespace", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PredictiveScalingMaxCapacityBehavior": { "Required": false, "MarkdownDocumentation": "`PredictiveScalingMaxCapacityBehavior`\n\nDefines the behavior that should be applied if the forecast capacity approaches or\nexceeds the maximum capacity specified for the resource. The default value is\n`SetForecastCapacityToMaxCapacity`.\nThe following are possible values:\n* `SetForecastCapacityToMaxCapacity` - AWS Auto Scaling cannot scale\n resource capacity higher than the maximum capacity. The maximum capacity is enforced\n as a hard limit.\n* `SetMaxCapacityToForecastCapacity` - AWS Auto Scaling can scale\n resource capacity higher than the maximum capacity to equal but not exceed forecast\n capacity.\n* `SetMaxCapacityAboveForecastCapacity` - AWS Auto Scaling can scale\n resource capacity higher than the maximum capacity by a specified buffer value. The\n intention is to give the target tracking scaling policy extra capacity if unexpected\n traffic occurs.\nValid only when configuring predictive scaling.\n*Required*: No\n*Type*: String\n*Allowed values*: `SetForecastCapacityToMaxCap...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SetForecastCapacityToMaxCapacity", "SetMaxCapacityToForecastCapacity", "SetMaxCapacityAboveForecastCapacity" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ScalableDimension": { "Required": true, "MarkdownDocumentation": "`ScalableDimension`\n\nThe scalable dimension associated with the resource.\n* `autoscaling:autoScalingGroup:DesiredCapacity` - The desired capacity of an Auto Scaling group.\n* `ecs:service:DesiredCount` - The desired task count of an ECS service.\n* `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet request.\n* `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table.\n* `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table.\n* `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index.\n* `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index.\n* `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `autoscaling:autoScalingGrou...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "autoscaling:autoScalingGroup:DesiredCapacity", "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "rds:cluster:ReadReplicaCount", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalabledimension", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ScalingPolicyUpdateBehavior": { "Required": false, "MarkdownDocumentation": "`ScalingPolicyUpdateBehavior`\n\nControls whether a resource's externally created scaling policies are deleted and new target tracking scaling policies created. The default value is\n`KeepExternalPolicies`.\nValid only when configuring dynamic scaling.\n*Required*: No\n*Type*: String\n*Allowed values*: `KeepExternalPolicies | Repl...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KeepExternalPolicies", "ReplaceExternalPolicies" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalingpolicyupdatebehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MinCapacity": { "Required": true, "MarkdownDocumentation": "`MinCapacity`\n\nThe minimum capacity of the resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-mincapacity", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TargetTrackingConfigurations": { "Type": "List", "Required": true, "MarkdownDocumentation": "`TargetTrackingConfigurations`\n\nThe target tracking configurations (up to 10). Each of these structures must specify a\nunique scaling metric and a target value for the metric.\n*Required*: Yes\n*Type*: Array of [TargetTrackingConfiguration](./aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-targettrackingconfigurations", "ItemType": "TargetTrackingConfiguration", "UpdateType": "Mutable" }, "PredictiveScalingMaxCapacityBuffer": { "Required": false, "MarkdownDocumentation": "`PredictiveScalingMaxCapacityBuffer`\n\nThe size of the capacity buffer to use when the forecast capacity is close to or exceeds\nthe maximum capacity. The value is specified as a percentage relative to the forecast\ncapacity. For example, if the buffer is 10, this means a 10 percent buffer. With a 10\npercent buffer, if the forecast capacity is 50, and the maximum capacity is 40, then the\neffective maximum capacity is 55.\nValid only when configuring predictive scaling. Required if **PredictiveScalingMaxCapacityBehavior** is set to\n`SetMaxCapacityAboveForecastCapacity`, and cannot be used otherwise.\nThe range is 1-100.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmaxcapacitybuffer", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CustomizedLoadMetricSpecification": { "Type": "CustomizedLoadMetricSpecification", "Required": false, "MarkdownDocumentation": "`CustomizedLoadMetricSpecification`\n\nThe customized load metric to use for predictive scaling. This property or a **PredefinedLoadMetricSpecification** is required when configuring\npredictive scaling, and cannot be used otherwise.\n*Required*: Conditional\n*Type*: [CustomizedLoadMetricSpecification](./aws-properties-autoscalingplans-scalingplan-customizedloadmetricspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-customizedloadmetricspecification", "UpdateType": "Mutable" }, "PredefinedLoadMetricSpecification": { "Type": "PredefinedLoadMetricSpecification", "Required": false, "MarkdownDocumentation": "`PredefinedLoadMetricSpecification`\n\nThe predefined load metric to use for predictive scaling. This property or a **CustomizedLoadMetricSpecification** is required when configuring\npredictive scaling, and cannot be used otherwise.\n*Required*: Conditional\n*Type*: [PredefinedLoadMetricSpecification](./aws-properties-autoscalingplans-scalingplan-predefinedloadmetricspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predefinedloadmetricspecification", "UpdateType": "Mutable" }, "ResourceId": { "Required": true, "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the resource. This string consists of the resource type and unique\nidentifier.\n* Auto Scaling group - The resource type is `autoScalingGroup` and the unique identifier is the\n name of the Auto Scaling group. Example: `autoScalingGroup/my-asg`.\n* ECS service - The resource type is `service` and the unique identifier is the cluster name\n and service name. Example: `service/default/sample-webapp`.\n* Spot Fleet request - The resource type is `spot-fleet-request` and the unique identifier is the\n Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.\n* DynamoDB table - The resource type is `table` and the unique identifier is the resource ID.\n Example: `table/my-table`.\n* DynamoDB global secondary index - The resource type is `index` and the unique identifier is the resource ID.\n Example: `table/my-table/index/my-table-index`.\n* Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name.\n Example: `cluster:my-db-cluster`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-resourceid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ScheduledActionBufferTime": { "Required": false, "MarkdownDocumentation": "`ScheduledActionBufferTime`\n\nThe amount of time, in seconds, to buffer the run time of scheduled scaling actions when\nscaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer\ntime is 5 minutes, then the run time of the corresponding scheduled scaling action will be\n9:55 AM. The intention is to give resources time to be provisioned. For example, it can\ntake a few minutes to launch an EC2 instance. The actual amount of time required depends on\nseveral factors, such as the size of the instance and whether there are startup scripts to\ncomplete.\nThe value must be less than the forecast interval duration of 3600 seconds (60 minutes).\nThe default is 300 seconds.\nValid only when configuring predictive scaling.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scheduledactionbuffertime", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MaxCapacity": { "Required": true, "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum capacity of the resource. The exception to this upper limit is if you\nspecify a non-default setting for **PredictiveScalingMaxCapacityBehavior**.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-maxcapacity", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "PredictiveScalingMode": { "Required": false, "MarkdownDocumentation": "`PredictiveScalingMode`\n\nThe predictive scaling mode. The default value is `ForecastAndScale`.\nOtherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled\nscaling actions based on the capacity forecast.\n*Required*: No\n*Type*: String\n*Allowed values*: `ForecastAndScale | Forecast...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ForecastAndScale", "ForecastOnly" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-predictivescalingmode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AutoScalingPlans::ScalingPlan.TagFilter": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.TagFilter`\n\n`TagFilter` is a subproperty of [ApplicationSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html) that specifies a tag for an application source to use\nwith a scaling plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html", "Properties": { "Values": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Values`\n\nThe tag values (0 to 20).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-values", "UpdateType": "Mutable" }, "Key": { "Required": true, "MarkdownDocumentation": "`Key`\n\nThe tag key.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AutoScalingPlans::ScalingPlan.TargetTrackingConfiguration": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan.TargetTrackingConfiguration`\n\n`TargetTrackingConfiguration` is a subproperty of [ScalingInstruction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html) that specifies a target tracking configuration for a scalable resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html", "Properties": { "ScaleOutCooldown": { "Required": false, "MarkdownDocumentation": "`ScaleOutCooldown`\n\nThe amount of time, in seconds, after a scale-out activity completes before another\nscale-out activity can start. This value is not used if the scalable resource is an Auto\nScaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleoutcooldown", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TargetValue": { "Required": true, "MarkdownDocumentation": "`TargetValue`\n\nThe target value for the metric. Although this property accepts numbers of type Double,\nit won't accept values that are either too small or too large. Values must be in the range\nof -2^360 to 2^360.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-targetvalue", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "PredefinedScalingMetricSpecification": { "Type": "PredefinedScalingMetricSpecification", "Required": false, "MarkdownDocumentation": "`PredefinedScalingMetricSpecification`\n\nA predefined metric. You can specify either a predefined metric or a customized\nmetric.\n*Required*: No\n*Type*: [PredefinedScalingMetricSpecification](./aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-predefinedscalingmetricspecification", "UpdateType": "Mutable" }, "DisableScaleIn": { "Required": false, "MarkdownDocumentation": "`DisableScaleIn`\n\nIndicates whether scale in by the target tracking scaling policy is disabled. If the\nvalue is `true`, scale in is disabled and the target tracking scaling policy\ndoesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the\ntarget tracking scaling policy can remove capacity from the scalable resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-disablescalein", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ScaleInCooldown": { "Required": false, "MarkdownDocumentation": "`ScaleInCooldown`\n\nThe amount of time, in seconds, after a scale-in activity completes before another scale\nin activity can start. This value is not used if the scalable resource is an Auto Scaling\ngroup.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleincooldown", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "EstimatedInstanceWarmup": { "Required": false, "MarkdownDocumentation": "`EstimatedInstanceWarmup`\n\nThe estimated time, in seconds, until a newly launched instance can contribute to the\nCloudWatch metrics. This value is used only if the resource is an Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-estimatedinstancewarmup", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CustomizedScalingMetricSpecification": { "Type": "CustomizedScalingMetricSpecification", "Required": false, "MarkdownDocumentation": "`CustomizedScalingMetricSpecification`\n\nA customized metric. You can specify either a predefined metric or a customized metric.\n*Required*: No\n*Type*: [CustomizedScalingMetricSpecification](./aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-customizedscalingmetricspecification", "UpdateType": "Mutable" } } }, "AWS::B2BI::Capability.CapabilityConfiguration": { "MarkdownDocumentation": "`AWS::B2BI::Capability.CapabilityConfiguration`\n\nA capability object. Currently, only EDI (electronic data interchange) capabilities are supported.\nA trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-capabilityconfiguration.html", "Properties": { "Edi": { "MarkdownDocumentation": "`Edi`\n\nAn EDI (electronic data interchange) configuration object.\n*Required*: Yes\n*Type*: [EdiConfiguration](./aws-properties-b2bi-capability-ediconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-capabilityconfiguration.html#cfn-b2bi-capability-capabilityconfiguration-edi", "UpdateType": "Mutable", "Required": true, "Type": "EdiConfiguration" } } }, "AWS::B2BI::Capability.EdiConfiguration": { "MarkdownDocumentation": "`AWS::B2BI::Capability.EdiConfiguration`\n\nSpecifies the details for the EDI (electronic data interchange) transformation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nReturns the type of the capability. Currently, only `edi` is supported.\n*Required*: Yes\n*Type*: [EdiType](./aws-properties-b2bi-capability-editype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-type", "UpdateType": "Mutable", "Required": true, "Type": "EdiType" }, "InputLocation": { "MarkdownDocumentation": "`InputLocation`\n\nContains the Amazon S3 bucket and prefix for the location of the input file, which is\ncontained in an `S3Location` object.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-b2bi-capability-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-inputlocation", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" }, "TransformerId": { "MarkdownDocumentation": "`TransformerId`\n\nReturns the system-assigned unique identifier for the transformer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-transformerid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OutputLocation": { "MarkdownDocumentation": "`OutputLocation`\n\nContains the Amazon S3 bucket and prefix for the location of the output file, which is\ncontained in an `S3Location` object.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-b2bi-capability-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-outputlocation", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" }, "CapabilityDirection": { "MarkdownDocumentation": "`CapabilityDirection`\n\nSpecifies whether this is capability is for inbound or outbound transformations.\n*Required*: No\n*Type*: String\n*Allowed values*: `INBOUND | OUTBOUND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INBOUND", "OUTBOUND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html#cfn-b2bi-capability-ediconfiguration-capabilitydirection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Capability.EdiType": { "MarkdownDocumentation": "`AWS::B2BI::Capability.EdiType`\n\nThe `EdiType` property type specifies Property description not available. for an [AWS::B2BI::Capability](./aws-resource-b2bi-capability.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-editype.html", "Properties": { "X12Details": { "MarkdownDocumentation": "`X12Details`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [X12Details](./aws-properties-b2bi-capability-x12details.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-editype.html#cfn-b2bi-capability-editype-x12details", "UpdateType": "Mutable", "Required": true, "Type": "X12Details" } } }, "AWS::B2BI::Capability.S3Location": { "MarkdownDocumentation": "`AWS::B2BI::Capability.S3Location`\n\nSpecifies the details for the Amazon S3 file location that is being used with AWS B2B Data Interchange. File\nlocations in Amazon S3 are identified using a combination of the bucket and key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nSpecifies the name of the Amazon S3 bucket.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html#cfn-b2bi-capability-s3location-bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nSpecifies the Amazon S3 key for the file location.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-s3location.html#cfn-b2bi-capability-s3location-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Capability.X12Details": { "MarkdownDocumentation": "`AWS::B2BI::Capability.X12Details`\n\nA structure that contains the X12 transaction set and version. The X12 structure is used\nwhen the system transforms an EDI (electronic data interchange) file.\n###### Note\nIf an EDI input file contains more than one transaction, each transaction must have\nthe same transaction set and version, for example 214/4010. If not, the transformer\ncannot parse the file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-x12details.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nReturns the version to use for the specified X12 transaction set.\n*Required*: No\n*Type*: String\n*Allowed values*: `VERSION_4010 | VERSION_4030...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VERSION_4010", "VERSION_4030", "VERSION_4050", "VERSION_4060", "VERSION_5010", "VERSION_5010_HIPAA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-x12details.html#cfn-b2bi-capability-x12details-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransactionSet": { "MarkdownDocumentation": "`TransactionSet`\n\nReturns an enumerated type where each value identifies an X12 transaction set.\nTransaction sets are maintained by the X12 Accredited Standards Committee.\n*Required*: No\n*Type*: String\n*Allowed values*: `X12_100 | X12_101 | X12_102...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "X12_100", "X12_101", "X12_102", "X12_103", "X12_104", "X12_105", "X12_106", "X12_107", "X12_108", "X12_109", "X12_110", "X12_111", "X12_112", "X12_113", "X12_120", "X12_121", "X12_124", "X12_125", "X12_126", "X12_127", "X12_128", "X12_129", "X12_130", "X12_131", "X12_132", "X12_133", "X12_135", "X12_138", "X12_139", "X12_140", "X12_141", "X12_142", "X12_143", "X12_144", "X12_146", "X12_147", "X12_148", "X12_149", "X12_150", "X12_151", "X12_152", "X12_153", "X12_154", "X12_155", "X12_157", "X12_158", "X12_159", "X12_160", "X12_161", "X12_163", "X12_170", "X12_175", "X12_176", "X12_179", "X12_180", "X12_185", "X12_186", "X12_187", "X12_188", "X12_189", "X12_190", "X12_191", "X12_194", "X12_195", "X12_196", "X12_197", "X12_198", "X12_199", "X12_200", "X12_201", "X12_202", "X12_203", "X12_204", "X12_205", "X12_206", "X12_210", "X12_211", "X12_212", "X12_213", "X12_214", "X12_215", "X12_216", "X12_217", "X12_218", "X12_219", "X12_220", "X12_222", "X12_223", "X12_224", "X12_225", "X12_227", "X12_228", "X12_240", "X12_242", "X12_244", "X12_245", "X12_248", "X12_249", "X12_250", "X12_251", "X12_252", "X12_255", "X12_256", "X12_259", "X12_260", "X12_261", "X12_262", "X12_263", "X12_264", "X12_265", "X12_266", "X12_267", "X12_268", "X12_269", "X12_270", "X12_271", "X12_272", "X12_273", "X12_274", "X12_275", "X12_276", "X12_277", "X12_278", "X12_280", "X12_283", "X12_284", "X12_285", "X12_286", "X12_288", "X12_290", "X12_300", "X12_301", "X12_303", "X12_304", "X12_309", "X12_310", "X12_311", "X12_312", "X12_313", "X12_315", "X12_317", "X12_319", "X12_322", "X12_323", "X12_324", "X12_325", "X12_326", "X12_350", "X12_352", "X12_353", "X12_354", "X12_355", "X12_356", "X12_357", "X12_358", "X12_361", "X12_362", "X12_404", "X12_410", "X12_412", "X12_414", "X12_417", "X12_418", "X12_419", "X12_420", "X12_421", "X12_422", "X12_423", "X12_424", "X12_425", "X12_426", "X12_429", "X12_431", "X12_432", "X12_433", "X12_434", "X12_435", "X12_436", "X12_437", "X12_440", "X12_451", "X12_452", "X12_453", "X12_455", "X12_456", "X12_460", "X12_463", "X12_466", "X12_468", "X12_470", "X12_475", "X12_485", "X12_486", "X12_490", "X12_492", "X12_494", "X12_500", "X12_501", "X12_503", "X12_504", "X12_511", "X12_517", "X12_521", "X12_527", "X12_536", "X12_540", "X12_561", "X12_567", "X12_568", "X12_601", "X12_602", "X12_620", "X12_625", "X12_650", "X12_715", "X12_753", "X12_754", "X12_805", "X12_806", "X12_810", "X12_811", "X12_812", "X12_813", "X12_814", "X12_815", "X12_816", "X12_818", "X12_819", "X12_820", "X12_821", "X12_822", "X12_823", "X12_824", "X12_826", "X12_827", "X12_828", "X12_829", "X12_830", "X12_831", "X12_832", "X12_833", "X12_834", "X12_835", "X12_836", "X12_837", "X12_838", "X12_839", "X12_840", "X12_841", "X12_842", "X12_843", "X12_844", "X12_845", "X12_846", "X12_847", "X12_848", "X12_849", "X12_850", "X12_851", "X12_852", "X12_853", "X12_854", "X12_855", "X12_856", "X12_857", "X12_858", "X12_859", "X12_860", "X12_861", "X12_862", "X12_863", "X12_864", "X12_865", "X12_866", "X12_867", "X12_868", "X12_869", "X12_870", "X12_871", "X12_872", "X12_873", "X12_874", "X12_875", "X12_876", "X12_877", "X12_878", "X12_879", "X12_880", "X12_881", "X12_882", "X12_883", "X12_884", "X12_885", "X12_886", "X12_887", "X12_888", "X12_889", "X12_891", "X12_893", "X12_894", "X12_895", "X12_896", "X12_920", "X12_924", "X12_925", "X12_926", "X12_928", "X12_940", "X12_943", "X12_944", "X12_945", "X12_947", "X12_980", "X12_990", "X12_993", "X12_996", "X12_997", "X12_998", "X12_999", "X12_270_X279", "X12_271_X279", "X12_275_X210", "X12_275_X211", "X12_276_X212", "X12_277_X212", "X12_277_X214", "X12_277_X364", "X12_278_X217", "X12_820_X218", "X12_820_X306", "X12_824_X186", "X12_834_X220", "X12_834_X307", "X12_834_X318", "X12_835_X221", "X12_837_X222", "X12_837_X223", "X12_837_X224", "X12_837_X291", "X12_837_X292", "X12_837_X298", "X12_999_X231" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-x12details.html#cfn-b2bi-capability-x12details-transactionset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Partnership.CapabilityOptions": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.CapabilityOptions`\n\nContains the details for an Outbound EDI capability.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html", "Properties": { "InboundEdi": { "MarkdownDocumentation": "`InboundEdi`\n\nA structure that contains the inbound EDI options for the capability.\n*Required*: No\n*Type*: [InboundEdiOptions](./aws-properties-b2bi-partnership-inboundedioptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html#cfn-b2bi-partnership-capabilityoptions-inboundedi", "UpdateType": "Mutable", "Required": false, "Type": "InboundEdiOptions" }, "OutboundEdi": { "MarkdownDocumentation": "`OutboundEdi`\n\nA structure that contains the outbound EDI options.\n*Required*: No\n*Type*: [OutboundEdiOptions](./aws-properties-b2bi-partnership-outboundedioptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html#cfn-b2bi-partnership-capabilityoptions-outboundedi", "UpdateType": "Mutable", "Required": false, "Type": "OutboundEdiOptions" } } }, "AWS::B2BI::Partnership.InboundEdiOptions": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.InboundEdiOptions`\n\nContains options for processing inbound EDI files. These options allow for customizing\nhow incoming EDI documents are processed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-inboundedioptions.html", "Properties": { "X12": { "MarkdownDocumentation": "`X12`\n\nA structure that contains X12-specific options for processing inbound X12 EDI\nfiles.\n*Required*: No\n*Type*: [X12InboundEdiOptions](./aws-properties-b2bi-partnership-x12inboundedioptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-inboundedioptions.html#cfn-b2bi-partnership-inboundedioptions-x12", "UpdateType": "Mutable", "Required": false, "Type": "X12InboundEdiOptions" } } }, "AWS::B2BI::Partnership.OutboundEdiOptions": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.OutboundEdiOptions`\n\nA container for outbound EDI options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-outboundedioptions.html", "Properties": { "X12": { "MarkdownDocumentation": "`X12`\n\nA structure that contains an X12 envelope structure.\n*Required*: Yes\n*Type*: [X12Envelope](./aws-properties-b2bi-partnership-x12envelope.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-outboundedioptions.html#cfn-b2bi-partnership-outboundedioptions-x12", "UpdateType": "Mutable", "Required": true, "Type": "X12Envelope" } } }, "AWS::B2BI::Partnership.WrapOptions": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.WrapOptions`\n\nContains options for wrapping (line folding) in X12 EDI files. Wrapping controls how\nlong lines are handled in the EDI output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html", "Properties": { "LineLength": { "MarkdownDocumentation": "`LineLength`\n\nSpecifies the maximum length of a line before wrapping occurs. This value is used when\n`wrapBy` is set to `LINE_LENGTH`.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-linelength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "WrapBy": { "MarkdownDocumentation": "`WrapBy`\n\nSpecifies the method used for wrapping lines in the EDI output. Valid values:\n* `SEGMENT`: Wraps by segment.\n* `ONE_LINE`: Indicates that the entire content is on a single\n line.\n \n ###### Note\n \n When you specify `ONE_LINE`, do not provide either the line length\n nor the line terminator value.\n* `LINE_LENGTH`: Wraps by character count, as specified by\n `lineLength` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEGMENT | ONE_LINE | LINE_L...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEGMENT", "ONE_LINE", "LINE_LENGTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-wrapby", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineTerminator": { "MarkdownDocumentation": "`LineTerminator`\n\nSpecifies the character sequence used to terminate lines when wrapping. Valid\nvalues:\n* `CRLF`: carriage return and line feed\n* `LF`: line feed)\n* `CR`: carriage return\n*Required*: No\n*Type*: String\n*Allowed values*: `CRLF | LF | CR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CRLF", "LF", "CR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-wrapoptions.html#cfn-b2bi-partnership-wrapoptions-lineterminator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Partnership.X12AcknowledgmentOptions": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.X12AcknowledgmentOptions`\n\nContains options for configuring X12 acknowledgments. These options control how\nfunctional and technical acknowledgments are handled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.html", "Properties": { "TechnicalAcknowledgment": { "MarkdownDocumentation": "`TechnicalAcknowledgment`\n\nSpecifies whether technical acknowledgments (TA1) should be generated for incoming X12\ninterchanges. Valid values are `DO_NOT_GENERATE` and\n`GENERATE_ALL_SEGMENTS` and.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DO_NOT_GENERATE | GENERATE_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DO_NOT_GENERATE", "GENERATE_ALL_SEGMENTS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.html#cfn-b2bi-partnership-x12acknowledgmentoptions-technicalacknowledgment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FunctionalAcknowledgment": { "MarkdownDocumentation": "`FunctionalAcknowledgment`\n\nSpecifies whether functional acknowledgments (997/999) should be generated for incoming\nX12 transactions. Valid values are `DO_NOT_GENERATE`,\n`GENERATE_ALL_SEGMENTS` and\n`GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP`.\nIf you choose `GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP`, AWS B2B Data Interchange\nskips the AK2\\_Loop when generating an acknowledgment document.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DO_NOT_GENERATE | GENERATE_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DO_NOT_GENERATE", "GENERATE_ALL_SEGMENTS", "GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12acknowledgmentoptions.html#cfn-b2bi-partnership-x12acknowledgmentoptions-functionalacknowledgment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::B2BI::Partnership.X12ControlNumbers": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.X12ControlNumbers`\n\nContains configuration for X12 control numbers used in X12 EDI generation. Control\nnumbers are used to uniquely identify interchanges, functional groups, and transaction\nsets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html", "Properties": { "StartingFunctionalGroupControlNumber": { "MarkdownDocumentation": "`StartingFunctionalGroupControlNumber`\n\nSpecifies the starting functional group control number (GS06) to use for X12 EDI\ngeneration. This number is incremented for each new functional group. For the GS\n(functional group) envelope, AWS B2B Data Interchange generates a functional\ngroup control number that is unique to the sender ID, receiver ID, and functional\nidentifier code combination.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `999999999`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startingfunctionalgroupcontrolnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StartingInterchangeControlNumber": { "MarkdownDocumentation": "`StartingInterchangeControlNumber`\n\nSpecifies the starting interchange control number (ISA13) to use for X12 EDI generation.\nThis number is incremented for each new interchange. For the ISA (interchange) envelope,\nAWS B2B Data Interchange generates an interchange control number that is\nunique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `999999999`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startinginterchangecontrolnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StartingTransactionSetControlNumber": { "MarkdownDocumentation": "`StartingTransactionSetControlNumber`\n\nSpecifies the starting transaction set control number (ST02) to use for X12 EDI\ngeneration. This number is incremented for each new transaction set.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `999999999`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12controlnumbers.html#cfn-b2bi-partnership-x12controlnumbers-startingtransactionsetcontrolnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::B2BI::Partnership.X12Delimiters": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.X12Delimiters`\n\nIn X12 EDI messages, delimiters are used to mark the end of segments or elements, and\nare defined in the interchange control header. The delimiters are part of the message's\nsyntax and divide up its different elements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html", "Properties": { "SegmentTerminator": { "MarkdownDocumentation": "`SegmentTerminator`\n\nThe segment terminator. The default value is `~` (tilde).\n*Required*: No\n*Type*: String\n*Pattern*: `^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-segmentterminator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComponentSeparator": { "MarkdownDocumentation": "`ComponentSeparator`\n\nThe component, or sub-element, separator. The default value is `:`\n(colon).\n*Required*: No\n*Type*: String\n*Pattern*: `^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-componentseparator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataElementSeparator": { "MarkdownDocumentation": "`DataElementSeparator`\n\nThe data element separator. The default value is `*` (asterisk).\n*Required*: No\n*Type*: String\n*Pattern*: `^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html#cfn-b2bi-partnership-x12delimiters-dataelementseparator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Partnership.X12Envelope": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.X12Envelope`\n\nA wrapper structure for an X12 definition object.\nthe X12 envelope ensures the integrity of the data and the efficiency of the information\nexchange. The X12 message structure has hierarchical levels. From highest to the lowest,\nthey are:\n* Interchange Envelope\n* Functional Group\n* Transaction Set\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html", "Properties": { "WrapOptions": { "MarkdownDocumentation": "`WrapOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [WrapOptions](./aws-properties-b2bi-partnership-wrapoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html#cfn-b2bi-partnership-x12envelope-wrapoptions", "UpdateType": "Mutable", "Required": false, "Type": "WrapOptions" }, "Common": { "MarkdownDocumentation": "`Common`\n\nA container for the X12 outbound EDI headers.\n*Required*: No\n*Type*: [X12OutboundEdiHeaders](./aws-properties-b2bi-partnership-x12outboundediheaders.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html#cfn-b2bi-partnership-x12envelope-common", "UpdateType": "Mutable", "Required": false, "Type": "X12OutboundEdiHeaders" } } }, "AWS::B2BI::Partnership.X12FunctionalGroupHeaders": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.X12FunctionalGroupHeaders`\n\nPart of the X12 message structure. These are the functional group headers for the X12\nEDI object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html", "Properties": { "ApplicationSenderCode": { "MarkdownDocumentation": "`ApplicationSenderCode`\n\nA value representing the code used to identify the party transmitting a message, at\nposition GS-02.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9 ]*$`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-applicationsendercode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationReceiverCode": { "MarkdownDocumentation": "`ApplicationReceiverCode`\n\nA value representing the code used to identify the party receiving a message, at\nposition GS-03.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9 ]*$`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-applicationreceivercode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponsibleAgencyCode": { "MarkdownDocumentation": "`ResponsibleAgencyCode`\n\nA code that identifies the issuer of the standard, at position GS-07.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html#cfn-b2bi-partnership-x12functionalgroupheaders-responsibleagencycode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Partnership.X12InboundEdiOptions": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.X12InboundEdiOptions`\n\nContains options specific to processing inbound X12 EDI files.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12inboundedioptions.html", "Properties": { "AcknowledgmentOptions": { "MarkdownDocumentation": "`AcknowledgmentOptions`\n\nSpecifies acknowledgment options for inbound X12 EDI files. These options control how\nfunctional and technical acknowledgments are handled.\n*Required*: No\n*Type*: [X12AcknowledgmentOptions](./aws-properties-b2bi-partnership-x12acknowledgmentoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12inboundedioptions.html#cfn-b2bi-partnership-x12inboundedioptions-acknowledgmentoptions", "UpdateType": "Mutable", "Required": false, "Type": "X12AcknowledgmentOptions" } } }, "AWS::B2BI::Partnership.X12InterchangeControlHeaders": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.X12InterchangeControlHeaders`\n\nIn X12, the Interchange Control Header is the first segment of an EDI document and is\npart of the Interchange Envelope. It contains information about the sender and receiver,\nthe date and time of transmission, and the X12 version being used. It also includes\ndelivery information, such as the sender and receiver IDs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html", "Properties": { "ReceiverId": { "MarkdownDocumentation": "`ReceiverId`\n\nLocated at position ISA-08 in the header. This value (along with the\n`receiverIdQualifier`) identifies the intended recipient of the interchange.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9 ]*$`\n*Minimum*: `15`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiverid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AcknowledgmentRequestedCode": { "MarkdownDocumentation": "`AcknowledgmentRequestedCode`\n\nLocated at position ISA-14 in the header. The value \"1\" indicates that the sender is\nrequesting an interchange acknowledgment at receipt of the interchange. The value \"0\" is\nused otherwise.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-acknowledgmentrequestedcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SenderIdQualifier": { "MarkdownDocumentation": "`SenderIdQualifier`\n\nLocated at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID\nand qualifier uniquely identify the sending trading partner.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderidqualifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UsageIndicatorCode": { "MarkdownDocumentation": "`UsageIndicatorCode`\n\nLocated at position ISA-15 in the header. Specifies how this interchange is being\nused:\n* `T` indicates this interchange is for testing.\n* `P` indicates this interchange is for production.\n* `I` indicates this interchange is informational.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-usageindicatorcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RepetitionSeparator": { "MarkdownDocumentation": "`RepetitionSeparator`\n\nLocated at position ISA-11 in the header. This string makes it easier when you need to\ngroup similar adjacent element values together without using extra segments.\n###### Note\nThis parameter is only honored for version greater than 401\n(`VERSION_4010` and higher).\nFor versions less than 401, this field is called [StandardsId](https://www.stedi.com/edi/x12-004010/segment/ISA#ISA-11), in\nwhich case our service sets the value to `U`.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-repetitionseparator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SenderId": { "MarkdownDocumentation": "`SenderId`\n\nLocated at position ISA-06 in the header. This value (along with the\n`senderIdQualifier`) identifies the sender of the interchange.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9 ]*$`\n*Minimum*: `15`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-senderid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReceiverIdQualifier": { "MarkdownDocumentation": "`ReceiverIdQualifier`\n\nLocated at position ISA-07 in the header. Qualifier for the receiver ID. Together, the\nID and qualifier uniquely identify the receiving trading partner.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html#cfn-b2bi-partnership-x12interchangecontrolheaders-receiveridqualifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Partnership.X12OutboundEdiHeaders": { "MarkdownDocumentation": "`AWS::B2BI::Partnership.X12OutboundEdiHeaders`\n\nA structure containing the details for an outbound EDI object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html", "Properties": { "Delimiters": { "MarkdownDocumentation": "`Delimiters`\n\nThe delimiters, for example semicolon (`;`), that separates sections of the\nheaders for the X12 object.\n*Required*: No\n*Type*: [X12Delimiters](./aws-properties-b2bi-partnership-x12delimiters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-delimiters", "UpdateType": "Mutable", "Required": false, "Type": "X12Delimiters" }, "ControlNumbers": { "MarkdownDocumentation": "`ControlNumbers`\n\nSpecifies control number configuration for outbound X12 EDI headers. These settings\ndetermine the starting values for interchange, functional group, and transaction set\ncontrol numbers.\n*Required*: No\n*Type*: [X12ControlNumbers](./aws-properties-b2bi-partnership-x12controlnumbers.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-controlnumbers", "UpdateType": "Mutable", "Required": false, "Type": "X12ControlNumbers" }, "FunctionalGroupHeaders": { "MarkdownDocumentation": "`FunctionalGroupHeaders`\n\nThe functional group headers for the X12 object.\n*Required*: No\n*Type*: [X12FunctionalGroupHeaders](./aws-properties-b2bi-partnership-x12functionalgroupheaders.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-functionalgroupheaders", "UpdateType": "Mutable", "Required": false, "Type": "X12FunctionalGroupHeaders" }, "InterchangeControlHeaders": { "MarkdownDocumentation": "`InterchangeControlHeaders`\n\nIn X12 EDI messages, delimiters are used to mark the end of segments or elements, and\nare defined in the interchange control header.\n*Required*: No\n*Type*: [X12InterchangeControlHeaders](./aws-properties-b2bi-partnership-x12interchangecontrolheaders.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-interchangecontrolheaders", "UpdateType": "Mutable", "Required": false, "Type": "X12InterchangeControlHeaders" }, "ValidateEdi": { "MarkdownDocumentation": "`ValidateEdi`\n\nSpecifies whether or not to validate the EDI for this X12 object: `TRUE` or\n`FALSE`. When enabled, this performs both standard EDI validation and applies\nany configured custom validation rules including element length constraints, code list\nvalidations, and element requirement checks. Validation results are returned in the\nresponse validation messages.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-validateedi", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Gs05TimeFormat": { "MarkdownDocumentation": "`Gs05TimeFormat`\n\nSpecifies the time format in the GS05 element (time) of the functional group header. The\nfollowing formats use 24-hour clock time:\n* `HHMM` - Hours and minutes\n* `HHMMSS` - Hours, minutes, and seconds\n* `HHMMSSDD` - Hours, minutes, seconds, and decimal seconds\nWhere:\n* `HH` - Hours (00-23)\n* `MM` - Minutes (00-59)\n* `SS` - Seconds (00-59)\n* `DD` - Hundredths of seconds (00-99)\n*Required*: No\n*Type*: String\n*Allowed values*: `HHMM | HHMMSS | HHMMSSDD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HHMM", "HHMMSS", "HHMMSSDD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-gs05timeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.AdvancedOptions": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.AdvancedOptions`\n\nA structure that contains advanced options for EDI processing. Currently, only X12\nadvanced options are supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-advancedoptions.html", "Properties": { "X12": { "MarkdownDocumentation": "`X12`\n\nA structure that contains X12-specific advanced options, such as split options for\nprocessing X12 EDI files.\n*Required*: No\n*Type*: [X12AdvancedOptions](./aws-properties-b2bi-transformer-x12advancedoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-advancedoptions.html#cfn-b2bi-transformer-advancedoptions-x12", "UpdateType": "Mutable", "Required": false, "Type": "X12AdvancedOptions" } } }, "AWS::B2BI::Transformer.FormatOptions": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.FormatOptions`\n\nA structure that contains the X12 transaction set and version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-formatoptions.html", "Properties": { "X12": { "MarkdownDocumentation": "`X12`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [X12Details](./aws-properties-b2bi-transformer-x12details.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-formatoptions.html#cfn-b2bi-transformer-formatoptions-x12", "UpdateType": "Mutable", "Required": true, "Type": "X12Details" } } }, "AWS::B2BI::Transformer.InputConversion": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.InputConversion`\n\nContains the input formatting options for an inbound transformer (takes an X12-formatted\nEDI document as input and converts it to JSON or XML.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.html", "Properties": { "AdvancedOptions": { "MarkdownDocumentation": "`AdvancedOptions`\n\nSpecifies advanced options for the input conversion process. These options provide\nadditional control over how EDI files are processed during transformation.\n*Required*: No\n*Type*: [AdvancedOptions](./aws-properties-b2bi-transformer-advancedoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.html#cfn-b2bi-transformer-inputconversion-advancedoptions", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedOptions" }, "FormatOptions": { "MarkdownDocumentation": "`FormatOptions`\n\nA structure that contains the formatting options for an inbound transformer.\n*Required*: No\n*Type*: [FormatOptions](./aws-properties-b2bi-transformer-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.html#cfn-b2bi-transformer-inputconversion-formatoptions", "UpdateType": "Mutable", "Required": false, "Type": "FormatOptions" }, "FromFormat": { "MarkdownDocumentation": "`FromFormat`\n\nThe format for the transformer input: currently on `X12` is supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `X12`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "X12" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.html#cfn-b2bi-transformer-inputconversion-fromformat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.Mapping": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.Mapping`\n\nSpecifies the mapping template for the transformer. This template is used to map the\nparsed EDI file using JSONata or XSLT.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-mapping.html", "Properties": { "TemplateLanguage": { "MarkdownDocumentation": "`TemplateLanguage`\n\nThe transformation language for the template, either XSLT or JSONATA.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `XSLT | JSONATA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "XSLT", "JSONATA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-mapping.html#cfn-b2bi-transformer-mapping-templatelanguage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Template": { "MarkdownDocumentation": "`Template`\n\nA string that represents the mapping template, in the transformation language specified\nin `templateLanguage`.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `350000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-mapping.html#cfn-b2bi-transformer-mapping-template", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.OutputConversion": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.OutputConversion`\n\nContains the formatting options for an outbound transformer (takes JSON or XML as input\nand converts it to an EDI document (currently only X12 format is supported).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.html", "Properties": { "AdvancedOptions": { "MarkdownDocumentation": "`AdvancedOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [AdvancedOptions](./aws-properties-b2bi-transformer-advancedoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.html#cfn-b2bi-transformer-outputconversion-advancedoptions", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedOptions" }, "ToFormat": { "MarkdownDocumentation": "`ToFormat`\n\nThe format for the output from an outbound transformer: only X12 is currently\nsupported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `X12`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "X12" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.html#cfn-b2bi-transformer-outputconversion-toformat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FormatOptions": { "MarkdownDocumentation": "`FormatOptions`\n\nA structure that contains the X12 transaction set and version for the transformer\noutput.\n*Required*: No\n*Type*: [FormatOptions](./aws-properties-b2bi-transformer-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.html#cfn-b2bi-transformer-outputconversion-formatoptions", "UpdateType": "Mutable", "Required": false, "Type": "FormatOptions" } } }, "AWS::B2BI::Transformer.SampleDocumentKeys": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.SampleDocumentKeys`\n\nAn array of the Amazon S3 keys used to identify the location for your sample\ndocuments.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.html", "Properties": { "Input": { "MarkdownDocumentation": "`Input`\n\nAn array of keys for your input sample documents.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.html#cfn-b2bi-transformer-sampledocumentkeys-input", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Output": { "MarkdownDocumentation": "`Output`\n\nAn array of keys for your output sample documents.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.html#cfn-b2bi-transformer-sampledocumentkeys-output", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.SampleDocuments": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.SampleDocuments`\n\nDescribes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocuments.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nContains the Amazon S3 bucket that is used to hold your sample documents.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocuments.html#cfn-b2bi-transformer-sampledocuments-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Keys": { "MarkdownDocumentation": "`Keys`\n\nContains an array of the Amazon S3 keys used to identify the location for your\nsample documents.\n*Required*: Yes\n*Type*: Array of [SampleDocumentKeys](./aws-properties-b2bi-transformer-sampledocumentkeys.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocuments.html#cfn-b2bi-transformer-sampledocuments-keys", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SampleDocumentKeys", "DuplicatesAllowed": true } } }, "AWS::B2BI::Transformer.X12AdvancedOptions": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.X12AdvancedOptions`\n\nContains advanced options specific to X12 EDI processing, such as splitting large X12\nfiles into smaller units.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12advancedoptions.html", "Properties": { "ValidationOptions": { "MarkdownDocumentation": "`ValidationOptions`\n\nSpecifies validation options for X12 EDI processing. These options control how\nvalidation rules are applied during EDI document processing, including custom validation\nrules for element length constraints, code list validations, and element requirement\nchecks.\n*Required*: No\n*Type*: [X12ValidationOptions](./aws-properties-b2bi-transformer-x12validationoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12advancedoptions.html#cfn-b2bi-transformer-x12advancedoptions-validationoptions", "UpdateType": "Mutable", "Required": false, "Type": "X12ValidationOptions" }, "SplitOptions": { "MarkdownDocumentation": "`SplitOptions`\n\nSpecifies options for splitting X12 EDI files. These options control how large X12 files\nare divided into smaller, more manageable units.\n*Required*: No\n*Type*: [X12SplitOptions](./aws-properties-b2bi-transformer-x12splitoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12advancedoptions.html#cfn-b2bi-transformer-x12advancedoptions-splitoptions", "UpdateType": "Mutable", "Required": false, "Type": "X12SplitOptions" } } }, "AWS::B2BI::Transformer.X12CodeListValidationRule": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.X12CodeListValidationRule`\n\nCode list validation rule configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12codelistvalidationrule.html", "Properties": { "CodesToAdd": { "MarkdownDocumentation": "`CodesToAdd`\n\nSpecifies a list of code values to add to the element's allowed values. These codes will\nbe considered valid for the specified element in addition to the standard codes defined by\nthe X12 specification.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12codelistvalidationrule.html#cfn-b2bi-transformer-x12codelistvalidationrule-codestoadd", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CodesToRemove": { "MarkdownDocumentation": "`CodesToRemove`\n\nSpecifies a list of code values to remove from the element's allowed values. These codes\nwill be considered invalid for the specified element, even if they are part of the standard\ncodes defined by the X12 specification.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12codelistvalidationrule.html#cfn-b2bi-transformer-x12codelistvalidationrule-codestoremove", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ElementId": { "MarkdownDocumentation": "`ElementId`\n\nSpecifies the four-digit element ID to which the code list modifications apply. This\nidentifies which X12 element will have its allowed code values modified.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]{4}$`\n*Minimum*: `4`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12codelistvalidationrule.html#cfn-b2bi-transformer-x12codelistvalidationrule-elementid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.X12Details": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.X12Details`\n\nA structure that contains the X12 transaction set and version. The X12 structure is used\nwhen the system transforms an EDI (electronic data interchange) file.\n###### Note\nIf an EDI input file contains more than one transaction, each transaction must have\nthe same transaction set and version, for example 214/4010. If not, the transformer\ncannot parse the file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12details.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nReturns the version to use for the specified X12 transaction set.\n*Required*: No\n*Type*: String\n*Allowed values*: `VERSION_4010 | VERSION_4030...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VERSION_4010", "VERSION_4030", "VERSION_4050", "VERSION_4060", "VERSION_5010", "VERSION_5010_HIPAA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12details.html#cfn-b2bi-transformer-x12details-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransactionSet": { "MarkdownDocumentation": "`TransactionSet`\n\nReturns an enumerated type where each value identifies an X12 transaction set.\nTransaction sets are maintained by the X12 Accredited Standards Committee.\n*Required*: No\n*Type*: String\n*Allowed values*: `X12_100 | X12_101 | X12_102...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "X12_100", "X12_101", "X12_102", "X12_103", "X12_104", "X12_105", "X12_106", "X12_107", "X12_108", "X12_109", "X12_110", "X12_111", "X12_112", "X12_113", "X12_120", "X12_121", "X12_124", "X12_125", "X12_126", "X12_127", "X12_128", "X12_129", "X12_130", "X12_131", "X12_132", "X12_133", "X12_135", "X12_138", "X12_139", "X12_140", "X12_141", "X12_142", "X12_143", "X12_144", "X12_146", "X12_147", "X12_148", "X12_149", "X12_150", "X12_151", "X12_152", "X12_153", "X12_154", "X12_155", "X12_157", "X12_158", "X12_159", "X12_160", "X12_161", "X12_163", "X12_170", "X12_175", "X12_176", "X12_179", "X12_180", "X12_185", "X12_186", "X12_187", "X12_188", "X12_189", "X12_190", "X12_191", "X12_194", "X12_195", "X12_196", "X12_197", "X12_198", "X12_199", "X12_200", "X12_201", "X12_202", "X12_203", "X12_204", "X12_205", "X12_206", "X12_210", "X12_211", "X12_212", "X12_213", "X12_214", "X12_215", "X12_216", "X12_217", "X12_218", "X12_219", "X12_220", "X12_222", "X12_223", "X12_224", "X12_225", "X12_227", "X12_228", "X12_240", "X12_242", "X12_244", "X12_245", "X12_248", "X12_249", "X12_250", "X12_251", "X12_252", "X12_255", "X12_256", "X12_259", "X12_260", "X12_261", "X12_262", "X12_263", "X12_264", "X12_265", "X12_266", "X12_267", "X12_268", "X12_269", "X12_270", "X12_271", "X12_272", "X12_273", "X12_274", "X12_275", "X12_276", "X12_277", "X12_278", "X12_280", "X12_283", "X12_284", "X12_285", "X12_286", "X12_288", "X12_290", "X12_300", "X12_301", "X12_303", "X12_304", "X12_309", "X12_310", "X12_311", "X12_312", "X12_313", "X12_315", "X12_317", "X12_319", "X12_322", "X12_323", "X12_324", "X12_325", "X12_326", "X12_350", "X12_352", "X12_353", "X12_354", "X12_355", "X12_356", "X12_357", "X12_358", "X12_361", "X12_362", "X12_404", "X12_410", "X12_412", "X12_414", "X12_417", "X12_418", "X12_419", "X12_420", "X12_421", "X12_422", "X12_423", "X12_424", "X12_425", "X12_426", "X12_429", "X12_431", "X12_432", "X12_433", "X12_434", "X12_435", "X12_436", "X12_437", "X12_440", "X12_451", "X12_452", "X12_453", "X12_455", "X12_456", "X12_460", "X12_463", "X12_466", "X12_468", "X12_470", "X12_475", "X12_485", "X12_486", "X12_490", "X12_492", "X12_494", "X12_500", "X12_501", "X12_503", "X12_504", "X12_511", "X12_517", "X12_521", "X12_527", "X12_536", "X12_540", "X12_561", "X12_567", "X12_568", "X12_601", "X12_602", "X12_620", "X12_625", "X12_650", "X12_715", "X12_753", "X12_754", "X12_805", "X12_806", "X12_810", "X12_811", "X12_812", "X12_813", "X12_814", "X12_815", "X12_816", "X12_818", "X12_819", "X12_820", "X12_821", "X12_822", "X12_823", "X12_824", "X12_826", "X12_827", "X12_828", "X12_829", "X12_830", "X12_831", "X12_832", "X12_833", "X12_834", "X12_835", "X12_836", "X12_837", "X12_838", "X12_839", "X12_840", "X12_841", "X12_842", "X12_843", "X12_844", "X12_845", "X12_846", "X12_847", "X12_848", "X12_849", "X12_850", "X12_851", "X12_852", "X12_853", "X12_854", "X12_855", "X12_856", "X12_857", "X12_858", "X12_859", "X12_860", "X12_861", "X12_862", "X12_863", "X12_864", "X12_865", "X12_866", "X12_867", "X12_868", "X12_869", "X12_870", "X12_871", "X12_872", "X12_873", "X12_874", "X12_875", "X12_876", "X12_877", "X12_878", "X12_879", "X12_880", "X12_881", "X12_882", "X12_883", "X12_884", "X12_885", "X12_886", "X12_887", "X12_888", "X12_889", "X12_891", "X12_893", "X12_894", "X12_895", "X12_896", "X12_920", "X12_924", "X12_925", "X12_926", "X12_928", "X12_940", "X12_943", "X12_944", "X12_945", "X12_947", "X12_980", "X12_990", "X12_993", "X12_996", "X12_997", "X12_998", "X12_999", "X12_270_X279", "X12_271_X279", "X12_275_X210", "X12_275_X211", "X12_276_X212", "X12_277_X212", "X12_277_X214", "X12_277_X364", "X12_278_X217", "X12_820_X218", "X12_820_X306", "X12_824_X186", "X12_834_X220", "X12_834_X307", "X12_834_X318", "X12_835_X221", "X12_837_X222", "X12_837_X223", "X12_837_X224", "X12_837_X291", "X12_837_X292", "X12_837_X298", "X12_999_X231" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12details.html#cfn-b2bi-transformer-x12details-transactionset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.X12ElementLengthValidationRule": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.X12ElementLengthValidationRule`\n\nDefines a validation rule that specifies custom length constraints for a specific X12\nelement. This rule allows you to override the standard minimum and maximum length\nrequirements for an element, enabling validation of trading partner-specific length\nrequirements that may differ from the X12 specification. Both minimum and maximum length\nvalues must be specified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementlengthvalidationrule.html", "Properties": { "MinLength": { "MarkdownDocumentation": "`MinLength`\n\nSpecifies the minimum required length for the identified element. This value defines the\nlower limit for the element's content length.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `1000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementlengthvalidationrule.html#cfn-b2bi-transformer-x12elementlengthvalidationrule-minlength", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MaxLength": { "MarkdownDocumentation": "`MaxLength`\n\nSpecifies the maximum allowed length for the identified element. This value defines the\nupper limit for the element's content length.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `1000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementlengthvalidationrule.html#cfn-b2bi-transformer-x12elementlengthvalidationrule-maxlength", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "ElementId": { "MarkdownDocumentation": "`ElementId`\n\nSpecifies the four-digit element ID to which the length constraints will be applied.\nThis identifies which X12 element will have its length requirements modified.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]{4}$`\n*Minimum*: `4`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementlengthvalidationrule.html#cfn-b2bi-transformer-x12elementlengthvalidationrule-elementid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.X12ElementRequirementValidationRule": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.X12ElementRequirementValidationRule`\n\nDefines a validation rule that modifies the requirement status of a specific X12 element\nwithin a segment. This rule allows you to make optional elements mandatory or mandatory\nelements optional, providing flexibility to accommodate different trading partner\nrequirements and business rules. The rule targets a specific element position within a\nsegment and sets its requirement status to either OPTIONAL or MANDATORY.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementrequirementvalidationrule.html", "Properties": { "Requirement": { "MarkdownDocumentation": "`Requirement`\n\nSpecifies the requirement status for the element at the specified position. Valid values\nare OPTIONAL (the element may be omitted) or MANDATORY (the element must be\npresent).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OPTIONAL | MANDATORY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OPTIONAL", "MANDATORY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementrequirementvalidationrule.html#cfn-b2bi-transformer-x12elementrequirementvalidationrule-requirement", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ElementPosition": { "MarkdownDocumentation": "`ElementPosition`\n\nSpecifies the position of the element within an X12 segment for which the requirement\nstatus will be modified. The format follows the pattern of segment identifier followed by\nelement position (e.g., \"ST-01\" for the first element of the ST segment).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+(?:-\\d{2})(?:-\\d{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12elementrequirementvalidationrule.html#cfn-b2bi-transformer-x12elementrequirementvalidationrule-elementposition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.X12SplitOptions": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.X12SplitOptions`\n\nContains options for splitting X12 EDI files into smaller units. This is useful for\nprocessing large EDI files more efficiently.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12splitoptions.html", "Properties": { "SplitBy": { "MarkdownDocumentation": "`SplitBy`\n\nSpecifies the method used to split X12 EDI files. Valid values include\n`TRANSACTION` (split by individual transaction sets), or `NONE`\n(no splitting).\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | TRANSACTION...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "TRANSACTION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12splitoptions.html#cfn-b2bi-transformer-x12splitoptions-splitby", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::B2BI::Transformer.X12ValidationOptions": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.X12ValidationOptions`\n\nContains configuration options for X12 EDI validation. This structure allows you to\nspecify custom validation rules that will be applied during EDI document processing,\nincluding element length constraints, code list modifications, and element requirement\nchanges. These validation options provide flexibility to accommodate trading\npartner-specific requirements while maintaining EDI compliance. The validation rules are\napplied in addition to standard X12 validation to ensure documents meet both standard and\ncustom requirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationoptions.html", "Properties": { "ValidationRules": { "MarkdownDocumentation": "`ValidationRules`\n\nSpecifies a list of validation rules to apply during EDI document processing. These\nrules can include code list modifications, element length constraints, and element\nrequirement changes.\n*Required*: No\n*Type*: Array of [X12ValidationRule](./aws-properties-b2bi-transformer-x12validationrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationoptions.html#cfn-b2bi-transformer-x12validationoptions-validationrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "X12ValidationRule", "DuplicatesAllowed": true } } }, "AWS::B2BI::Transformer.X12ValidationRule": { "MarkdownDocumentation": "`AWS::B2BI::Transformer.X12ValidationRule`\n\nRepresents a single validation rule that can be applied during X12 EDI processing. This\nis a union type that can contain one of several specific validation rule types: code list\nvalidation rules for modifying allowed element codes, element length validation rules for\nenforcing custom length constraints, or element requirement validation rules for changing\nmandatory/optional status. Each validation rule targets specific aspects of EDI document\nvalidation to ensure compliance with trading partner requirements and business\nrules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationrule.html", "Properties": { "ElementRequirementValidationRule": { "MarkdownDocumentation": "`ElementRequirementValidationRule`\n\nSpecifies an element requirement validation rule that modifies whether a specific X12\nelement is required or optional within a segment. This rule provides flexibility to\naccommodate different trading partner requirements for element presence.\n*Required*: No\n*Type*: [X12ElementRequirementValidationRule](./aws-properties-b2bi-transformer-x12elementrequirementvalidationrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationrule.html#cfn-b2bi-transformer-x12validationrule-elementrequirementvalidationrule", "UpdateType": "Mutable", "Required": false, "Type": "X12ElementRequirementValidationRule" }, "CodeListValidationRule": { "MarkdownDocumentation": "`CodeListValidationRule`\n\nSpecifies a code list validation rule that modifies the allowed code values for a\nspecific X12 element. This rule enables you to customize which codes are considered valid\nfor an element, allowing for trading partner-specific code requirements.\n*Required*: No\n*Type*: [X12CodeListValidationRule](./aws-properties-b2bi-transformer-x12codelistvalidationrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationrule.html#cfn-b2bi-transformer-x12validationrule-codelistvalidationrule", "UpdateType": "Mutable", "Required": false, "Type": "X12CodeListValidationRule" }, "ElementLengthValidationRule": { "MarkdownDocumentation": "`ElementLengthValidationRule`\n\nSpecifies an element length validation rule that defines custom length constraints for a\nspecific X12 element. This rule allows you to enforce minimum and maximum length\nrequirements that may differ from the standard X12 specification.\n*Required*: No\n*Type*: [X12ElementLengthValidationRule](./aws-properties-b2bi-transformer-x12elementlengthvalidationrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-x12validationrule.html#cfn-b2bi-transformer-x12validationrule-elementlengthvalidationrule", "UpdateType": "Mutable", "Required": false, "Type": "X12ElementLengthValidationRule" } } }, "AWS::Backup::BackupPlan.AdvancedBackupSettingResourceType": { "MarkdownDocumentation": "`AWS::Backup::BackupPlan.AdvancedBackupSettingResourceType`\n\nSpecifies an object containing resource type and backup options. This is only supported\nfor Windows VSS backups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-advancedbackupsettingresourcetype.html", "Properties": { "BackupOptions": { "MarkdownDocumentation": "`BackupOptions`\n\nThe backup option for the resource. Each option is a key-value pair. This option is only\navailable for Windows VSS backup jobs.\nValid values:\nSet to `\"WindowsVSS\":\"enabled\"` to enable the `WindowsVSS` backup\noption and create a Windows VSS backup.\nSet to `\"WindowsVSS\":\"disabled\"` to create a regular backup. The\n`WindowsVSS` option is not enabled by default.\nIf you specify an invalid option, you get an `InvalidParameterValueException`\nexception.\nFor more information about Windows VSS backups, see [Creating a VSS-Enabled Windows\nBackup](https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-advancedbackupsettingresourcetype.html#cfn-backup-backupplan-advancedbackupsettingresourcetype-backupoptions", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe name of a resource type. The only supported resource type is EC2.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-advancedbackupsettingresourcetype.html#cfn-backup-backupplan-advancedbackupsettingresourcetype-resourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Backup::BackupPlan.BackupPlanResourceType": { "MarkdownDocumentation": "`AWS::Backup::BackupPlan.BackupPlanResourceType`\n\nSpecifies an object containing properties used to create a backup plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html", "Properties": { "BackupPlanName": { "MarkdownDocumentation": "`BackupPlanName`\n\nThe display name of a backup plan.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html#cfn-backup-backupplan-backupplanresourcetype-backupplanname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AdvancedBackupSettings": { "MarkdownDocumentation": "`AdvancedBackupSettings`\n\nA list of backup options for each resource type.\n*Required*: No\n*Type*: Array of [AdvancedBackupSettingResourceType](./aws-properties-backup-backupplan-advancedbackupsettingresourcetype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html#cfn-backup-backupplan-backupplanresourcetype-advancedbackupsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AdvancedBackupSettingResourceType", "DuplicatesAllowed": true }, "BackupPlanRule": { "MarkdownDocumentation": "`BackupPlanRule`\n\nAn array of `BackupRule` objects, each of which specifies a scheduled task\nthat is used to back up a selection of resources.\n*Required*: Yes\n*Type*: Array of [BackupRuleResourceType](./aws-properties-backup-backupplan-backupruleresourcetype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html#cfn-backup-backupplan-backupplanresourcetype-backupplanrule", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "BackupRuleResourceType", "DuplicatesAllowed": true } } }, "AWS::Backup::BackupPlan.BackupRuleResourceType": { "MarkdownDocumentation": "`AWS::Backup::BackupPlan.BackupRuleResourceType`\n\nSpecifies an object containing properties used to schedule a task to back up a selection\nof resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html", "Properties": { "CompletionWindowMinutes": { "MarkdownDocumentation": "`CompletionWindowMinutes`\n\nA value in minutes after a backup job is successfully started before it must be\ncompleted or it is canceled by AWS Backup.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-completionwindowminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-scheduleexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RecoveryPointTags": { "MarkdownDocumentation": "`RecoveryPointTags`\n\nThe tags to assign to the resources.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-recoverypointtags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "CopyActions": { "MarkdownDocumentation": "`CopyActions`\n\nAn array of CopyAction objects, which contains the details of the copy operation.\n*Required*: No\n*Type*: Array of [CopyActionResourceType](./aws-properties-backup-backupplan-copyactionresourcetype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-copyactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CopyActionResourceType", "DuplicatesAllowed": true }, "EnableContinuousBackup": { "MarkdownDocumentation": "`EnableContinuousBackup`\n\nEnables continuous backup and point-in-time restores (PITR).\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-enablecontinuousbackup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Lifecycle": { "MarkdownDocumentation": "`Lifecycle`\n\nThe lifecycle defines when a protected resource is transitioned to cold storage and when\nit expires. AWS Backup transitions and expires backups automatically according to\nthe lifecycle that you define.\n*Required*: No\n*Type*: [LifecycleResourceType](./aws-properties-backup-backupplan-lifecycleresourcetype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-lifecycle", "UpdateType": "Mutable", "Required": false, "Type": "LifecycleResourceType" }, "IndexActions": { "MarkdownDocumentation": "`IndexActions`\n\nThere can up to one IndexAction in each BackupRule, as each backup\ncan have 0 or 1 backup index associated with it.\nWithin the array is ResourceTypes. Only 1 resource type will\nbe accepted for each BackupRule. Valid values:\n* `EBS` for Amazon Elastic Block Store\n* `S3` for Amazon Simple Storage Service (Amazon S3)\n*Required*: No\n*Type*: Array of [IndexActionsResourceType](./aws-properties-backup-backupplan-indexactionsresourcetype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-indexactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IndexActionsResourceType", "DuplicatesAllowed": true }, "TargetBackupVault": { "MarkdownDocumentation": "`TargetBackupVault`\n\nThe name of a logical container where backups are stored. Backup vaults are identified\nby 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\nhyphens.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-targetbackupvault", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StartWindowMinutes": { "MarkdownDocumentation": "`StartWindowMinutes`\n\nAn optional value that specifies a period of time in minutes after a backup is scheduled\nbefore 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*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-startwindowminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ScheduleExpressionTimezone": { "MarkdownDocumentation": "`ScheduleExpressionTimezone`\n\nThis is the timezone in which the schedule expression is set. By default,\nScheduleExpressions are in UTC. You can modify this to a specified timezone.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-scheduleexpressiontimezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetLogicallyAirGappedBackupVaultArn": { "MarkdownDocumentation": "`TargetLogicallyAirGappedBackupVaultArn`\n\nThe ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-targetlogicallyairgappedbackupvaultarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-rulename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Backup::BackupPlan.CopyActionResourceType": { "MarkdownDocumentation": "`AWS::Backup::BackupPlan.CopyActionResourceType`\n\nCopies backups created by a backup rule to another vault.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-copyactionresourcetype.html", "Properties": { "Lifecycle": { "MarkdownDocumentation": "`Lifecycle`\n\nDefines when a protected resource is transitioned to cold storage and when it expires.\nAWS Backup transitions and expires backups automatically according to the\nlifecycle that you define. If you do not specify a lifecycle, AWS Backup applies\nthe lifecycle policy of the source backup to the destination backup.\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\ndays.\n*Required*: No\n*Type*: [LifecycleResourceType](./aws-properties-backup-backupplan-lifecycleresourcetype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-copyactionresourcetype.html#cfn-backup-backupplan-copyactionresourcetype-lifecycle", "UpdateType": "Mutable", "Required": false, "Type": "LifecycleResourceType" }, "DestinationBackupVaultArn": { "MarkdownDocumentation": "`DestinationBackupVaultArn`\n\nAn Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for\nthe copied backup. For example,\n`arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.`\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-copyactionresourcetype.html#cfn-backup-backupplan-copyactionresourcetype-destinationbackupvaultarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Backup::BackupPlan.IndexActionsResourceType": { "MarkdownDocumentation": "`AWS::Backup::BackupPlan.IndexActionsResourceType`\n\nSpecifies index actions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-indexactionsresourcetype.html", "Properties": { "ResourceTypes": { "MarkdownDocumentation": "`ResourceTypes`\n\n0 or 1 index action will be accepted for each BackupRule.\nValid values:\n* `EBS` for Amazon Elastic Block Store\n* `S3` for Amazon Simple Storage Service (Amazon S3)\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-indexactionsresourcetype.html#cfn-backup-backupplan-indexactionsresourcetype-resourcetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Backup::BackupPlan.LifecycleResourceType": { "MarkdownDocumentation": "`AWS::Backup::BackupPlan.LifecycleResourceType`\n\nSpecifies an object containing an array of `Transition` objects that\ndetermine how long in days before a recovery point transitions to cold storage or is\ndeleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html", "Properties": { "OptInToArchiveForSupportedResources": { "MarkdownDocumentation": "`OptInToArchiveForSupportedResources`\n\nIf the value is true, your backup plan transitions supported resources to\narchive (cold) storage tier in accordance with your lifecycle settings.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html#cfn-backup-backupplan-lifecycleresourcetype-optintoarchiveforsupportedresources", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DeleteAfterDays": { "MarkdownDocumentation": "`DeleteAfterDays`\n\nThe number of days after creation that a recovery point is deleted. This value must be\nat least 90 days after the number of days specified in `MoveToColdStorageAfterDays`.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html#cfn-backup-backupplan-lifecycleresourcetype-deleteafterdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MoveToColdStorageAfterDays": { "MarkdownDocumentation": "`MoveToColdStorageAfterDays`\n\nThe number of days after creation that a recovery point is moved to cold\nstorage.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html#cfn-backup-backupplan-lifecycleresourcetype-movetocoldstorageafterdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Backup::BackupSelection.BackupSelectionResourceType": { "MarkdownDocumentation": "`AWS::Backup::BackupSelection.BackupSelectionResourceType`\n\nSpecifies an object containing properties used to assign a set of resources to a backup\nplan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html", "Properties": { "ListOfTags": { "MarkdownDocumentation": "`ListOfTags`\n\nA list of conditions that you define to assign resources to your backup plans using\ntags. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\",\n\"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\n LEAST ONE condition (using OR logic).\n* `ListOfTags` only supports `StringEquals`.\n `Conditions` supports `StringEquals`,\n `StringLike`, `StringNotEquals`, and\n `StringNotLike`.\n*Required*: No\n*Type*: Array of [ConditionResourceType](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-listoftags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ConditionResourceType", "DuplicatesAllowed": true }, "NotResources": { "MarkdownDocumentation": "`NotResources`\n\nA list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number\nof 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\nselection strategy, such as assigning only one or a few resource types or refining your\nresource selection using tags.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-notresources", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SelectionName": { "MarkdownDocumentation": "`SelectionName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-selectionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe ARN of the IAM role that AWS Backup uses to authenticate when backing up\nthe target resource; for example,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-iamrolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Resources": { "MarkdownDocumentation": "`Resources`\n\nAn array of strings that contain Amazon Resource Names (ARNs) of resources to assign to\na backup plan.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-resources", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nA list of conditions that you define to assign resources to your backup plans using\ntags. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\",\n\"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\n ALL conditions (using AND logic).\n* `Conditions` supports `StringEquals`,\n `StringLike`, `StringNotEquals`, and\n `StringNotLike`. `ListOfTags` only supports\n `StringEquals`.\n*Required*: No\n*Type*: [Conditions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-conditions", "UpdateType": "Immutable", "Required": false, "Type": "Conditions" } } }, "AWS::Backup::BackupSelection.ConditionParameter": { "MarkdownDocumentation": "`AWS::Backup::BackupSelection.ConditionParameter`\n\nIncludes information about tags you define to assign tagged resources to a backup\nplan.\nInclude the prefix `aws:ResourceTag` in your tags.\nFor example, `\"aws:ResourceTag/TagKey1\": \"Value1\"`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html", "Properties": { "ConditionValue": { "MarkdownDocumentation": "`ConditionValue`\n\nThe value in a key-value pair. For example, in the tag `Department:\nAccounting`, `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html#cfn-backup-backupselection-conditionparameter-conditionvalue", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConditionKey": { "MarkdownDocumentation": "`ConditionKey`\n\nThe key in a key-value pair. For example, in the tag `Department:\nAccounting`, `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html#cfn-backup-backupselection-conditionparameter-conditionkey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Backup::BackupSelection.ConditionResourceType": { "MarkdownDocumentation": "`AWS::Backup::BackupSelection.ConditionResourceType`\n\nSpecifies an object that contains an array of triplets made up of a condition type (such\nas `STRINGEQUALS`), a key, and a value. Conditions are used to filter resources\nin a selection that is assigned to a backup plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html", "Properties": { "ConditionValue": { "MarkdownDocumentation": "`ConditionValue`\n\nThe value in a key-value pair. For example, in `\"Department\": \"accounting\"`,\n`\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditionvalue", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ConditionKey": { "MarkdownDocumentation": "`ConditionKey`\n\nThe key in a key-value pair. For example, in `\"Department\": \"accounting\"`,\n`\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditionkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ConditionType": { "MarkdownDocumentation": "`ConditionType`\n\nAn operation, such as `STRINGEQUALS`, that is applied to a key-value pair\nused 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditiontype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Backup::BackupSelection.Conditions": { "MarkdownDocumentation": "`AWS::Backup::BackupSelection.Conditions`\n\nContains information about which resources to include or exclude from a backup plan\nusing their tags. Conditions are case sensitive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html", "Properties": { "StringEquals": { "MarkdownDocumentation": "`StringEquals`\n\nFilters the values of your tagged resources for only those resources that you tagged\nwith the same value. Also called \"exact matching.\"\n*Required*: No\n*Type*: Array of [ConditionParameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html#cfn-backup-backupselection-conditions-stringequals", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ConditionParameter", "DuplicatesAllowed": true }, "StringNotLike": { "MarkdownDocumentation": "`StringNotLike`\n\nFilters the values of your tagged resources for non-matching tag values with the use of\na wildcard character (\\*) anywhere in the string.\n*Required*: No\n*Type*: Array of [ConditionParameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html#cfn-backup-backupselection-conditions-stringnotlike", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ConditionParameter", "DuplicatesAllowed": true }, "StringLike": { "MarkdownDocumentation": "`StringLike`\n\nFilters the values of your tagged resources for matching tag values with the use of a\nwildcard character (\\*) anywhere in the string. For example, \"prod\\*\" or \"\\*rod\\*\" matches the\ntag value \"production\".\n*Required*: No\n*Type*: Array of [ConditionParameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html#cfn-backup-backupselection-conditions-stringlike", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ConditionParameter", "DuplicatesAllowed": true }, "StringNotEquals": { "MarkdownDocumentation": "`StringNotEquals`\n\nFilters the values of your tagged resources for only those resources that you tagged\nthat do not have the same value. Also called \"negated matching.\"\n*Required*: No\n*Type*: Array of [ConditionParameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html#cfn-backup-backupselection-conditions-stringnotequals", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ConditionParameter", "DuplicatesAllowed": true } } }, "AWS::Backup::BackupVault.LockConfigurationType": { "MarkdownDocumentation": "`AWS::Backup::BackupVault.LockConfigurationType`\n\nThe `LockConfigurationType` property type specifies configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-lockconfigurationtype.html", "Properties": { "ChangeableForDays": { "MarkdownDocumentation": "`ChangeableForDays`\n\nThe AWS Backup Vault Lock configuration that specifies the number of days\nbefore the lock date. For example, setting `ChangeableForDays` to 30 on Jan. 1,\n2022 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\neffect and becomes immutable. Therefore, you must set `ChangeableForDays` to 3\nor greater.\nBefore the lock date, you can delete Vault Lock from the vault using\n`DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration\nusing `PutBackupVaultLockConfiguration`. On and after the lock date, the Vault\nLock becomes immutable and cannot be changed or deleted.\nIf this parameter is not specified, you can delete Vault Lock from the vault using\n`DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration\nusing `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-lockconfigurationtype.html#cfn-backup-backupvault-lockconfigurationtype-changeablefordays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxRetentionDays": { "MarkdownDocumentation": "`MaxRetentionDays`\n\nThe AWS Backup Vault Lock configuration that specifies the maximum retention\nperiod that the vault retains its recovery points. This setting can be useful if, for\nexample, your organization's policies require you to destroy certain data after retaining\nit for four years (1460 days).\nIf this parameter is not included, Vault Lock does not enforce a maximum retention\nperiod on the recovery points in the vault. If this parameter is included without a value,\nVault Lock will not enforce a maximum retention period.\nIf this parameter is specified, any backup or copy job to the vault must have a\nlifecycle policy with a retention period equal to or shorter than the maximum retention\nperiod. If the job's retention period is longer than that maximum retention period, then\nthe vault fails the backup or copy job, and you should either modify your lifecycle\nsettings or use a different vault. Recovery points already saved in the vault prior to\nVault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-lockconfigurationtype.html#cfn-backup-backupvault-lockconfigurationtype-maxretentiondays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinRetentionDays": { "MarkdownDocumentation": "`MinRetentionDays`\n\nThe AWS Backup Vault Lock configuration that specifies the minimum retention\nperiod that the vault retains its recovery points. This setting can be useful if, for\nexample, your organization's policies require you to retain certain data for at least seven\nyears (2555 days).\nIf this parameter is not specified, Vault Lock will not enforce a minimum retention\nperiod.\nIf this parameter is specified, any backup or copy job to the vault must have a\nlifecycle policy with a retention period equal to or longer than the minimum retention\nperiod. If the job's retention period is shorter than that minimum retention period, then\nthe vault fails that backup or copy job, and you should either modify your lifecycle\nsettings or use a different vault. Recovery points already saved in the vault prior to\nVault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-lockconfigurationtype.html#cfn-backup-backupvault-lockconfigurationtype-minretentiondays", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Backup::BackupVault.NotificationObjectType": { "MarkdownDocumentation": "`AWS::Backup::BackupVault.NotificationObjectType`\n\nSpecifies an object containing SNS event notification properties for the target backup\nvault.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html", "Properties": { "SNSTopicArn": { "MarkdownDocumentation": "`SNSTopicArn`\n\nAn ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS)\ntopic; for example, `arn:aws:sns:us-west-2:111122223333:MyTopic`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html#cfn-backup-backupvault-notificationobjecttype-snstopicarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BackupVaultEvents": { "MarkdownDocumentation": "`BackupVaultEvents`\n\nAn array of events that indicate the status of jobs to back up resources to the backup\nvault. 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\nGuide*.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html#cfn-backup-backupvault-notificationobjecttype-backupvaultevents", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Backup::Framework.ControlInputParameter": { "MarkdownDocumentation": "`AWS::Backup::Framework.ControlInputParameter`\n\nThe parameters for a control. A control can have zero, one, or more than one\nparameter. An example of a control with two parameters is: \"backup plan frequency is at\nleast `daily` and the retention period is at least `1 year`\". The\nfirst parameter is `daily`. The second parameter is `1 year`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html#cfn-backup-framework-controlinputparameter-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html#cfn-backup-framework-controlinputparameter-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Backup::Framework.ControlScope": { "MarkdownDocumentation": "`AWS::Backup::Framework.ControlScope`\n\nA framework consists of one or more controls. Each control has its own control scope.\nThe control scope can include one or more resource types, a combination of a tag key and\nvalue, or a combination of one resource type and one resource ID. If no scope is specified,\nevaluations for the rule are triggered when any resource in your recording group changes in\nconfiguration.\n###### Note\nTo set a control scope that includes all of a particular resource, leave the\n`ControlScope` empty or do not pass it when calling\n`CreateFramework`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html", "Properties": { "ComplianceResourceTypes": { "MarkdownDocumentation": "`ComplianceResourceTypes`\n\nDescribes whether the control scope includes one or more types of resources, such as\n`EFS` or `RDS`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html#cfn-backup-framework-controlscope-complianceresourcetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tag key-value pair applied to those AWS resources that you want to\ntrigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag\nvalue is optional, but it cannot be an empty string if you are creating or editing a\nframework from the console (though the value can be an empty string when included\nin a CloudFormation template).\nThe structure to assign a tag is:\n`[{\"Key\":\"string\",\"Value\":\"string\"}]`.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-backup-framework-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html#cfn-backup-framework-controlscope-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ComplianceResourceIds": { "MarkdownDocumentation": "`ComplianceResourceIds`\n\nThe ID of the only AWS resource that you want your control scope to\ncontain.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html#cfn-backup-framework-controlscope-complianceresourceids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Backup::Framework.FrameworkControl": { "MarkdownDocumentation": "`AWS::Backup::Framework.FrameworkControl`\n\nContains detailed information about all of the controls of a framework. Each framework\nmust contain at least one control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html", "Properties": { "ControlName": { "MarkdownDocumentation": "`ControlName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ControlInputParameters": { "MarkdownDocumentation": "`ControlInputParameters`\n\nThe name/value pairs.\n*Required*: No\n*Type*: Array of [ControlInputParameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlinputparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ControlInputParameter", "DuplicatesAllowed": false }, "ControlScope": { "MarkdownDocumentation": "`ControlScope`\n\nThe scope of a control. The control scope defines what the control will evaluate. Three\nexamples of control scopes are: a specific backup plan, all backup plans with a specific\ntag, or all backup plans.\nFor more information, see [`ControlScope`.](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html)\n*Required*: No\n*Type*: [ControlScope](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlscope", "UpdateType": "Mutable", "Required": false, "Type": "ControlScope" } } }, "AWS::Backup::LogicallyAirGappedBackupVault.NotificationObjectType": { "MarkdownDocumentation": "`AWS::Backup::LogicallyAirGappedBackupVault.NotificationObjectType`\n\nThe `NotificationObjectType` property type specifies Property description not available. for an [AWS::Backup::LogicallyAirGappedBackupVault](./aws-resource-backup-logicallyairgappedbackupvault.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html", "Properties": { "SNSTopicArn": { "MarkdownDocumentation": "`SNSTopicArn`\n\nThe Amazon Resource Name (ARN) that specifies the topic for a backup vault\u2019s events; for\nexample, `arn:aws:sns:us-west-2:111122223333:MyVaultTopic`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html#cfn-backup-logicallyairgappedbackupvault-notificationobjecttype-snstopicarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BackupVaultEvents": { "MarkdownDocumentation": "`BackupVaultEvents`\n\nAn array of events that indicate the status of jobs to back up resources to the backup\nvault.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html#cfn-backup-logicallyairgappedbackupvault-notificationobjecttype-backupvaultevents", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Backup::ReportPlan.ReportDeliveryChannel": { "MarkdownDocumentation": "`AWS::Backup::ReportPlan.ReportDeliveryChannel`\n\nContains information from your report plan about where to deliver your reports,\nspecifically your Amazon S3 bucket name, S3 key prefix, and the formats of your\nreports.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html", "Properties": { "S3KeyPrefix": { "MarkdownDocumentation": "`S3KeyPrefix`\n\nThe prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path:\ns3://your-bucket-name/`prefix`/Backup/us-west-2/year/month/day/report-name.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html#cfn-backup-reportplan-reportdeliverychannel-s3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Formats": { "MarkdownDocumentation": "`Formats`\n\nThe format of your reports: `CSV`, `JSON`, or both. If\nnot specified, the default format is `CSV`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html#cfn-backup-reportplan-reportdeliverychannel-formats", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html#cfn-backup-reportplan-reportdeliverychannel-s3bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Backup::ReportPlan.ReportSetting": { "MarkdownDocumentation": "`AWS::Backup::ReportPlan.ReportSetting`\n\nContains detailed information about a report setting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html", "Properties": { "FrameworkArns": { "MarkdownDocumentation": "`FrameworkArns`\n\nThe Amazon Resource Names (ARNs) of the frameworks a report covers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html#cfn-backup-reportplan-reportsetting-frameworkarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ReportTemplate": { "MarkdownDocumentation": "`ReportTemplate`\n\nIdentifies the report template for the report. Reports are built using a report\ntemplate. The report templates are:\n`RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\nCOPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html#cfn-backup-reportplan-reportsetting-reporttemplate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OrganizationUnits": { "MarkdownDocumentation": "`OrganizationUnits`\n\nThese are the Organizational Units to be included in the report.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html#cfn-backup-reportplan-reportsetting-organizationunits", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Regions": { "MarkdownDocumentation": "`Regions`\n\nThese are the Regions to be included in the report.\nUse the wildcard as the string value to include all Regions.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html#cfn-backup-reportplan-reportsetting-regions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Accounts": { "MarkdownDocumentation": "`Accounts`\n\nThese are the accounts to be included in the report.\nUse string value of `ROOT` to include all organizational units.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html#cfn-backup-reportplan-reportsetting-accounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Backup::RestoreTestingPlan.RestoreTestingRecoveryPointSelection": { "MarkdownDocumentation": "`AWS::Backup::RestoreTestingPlan.RestoreTestingRecoveryPointSelection`\n\n`RecoveryPointSelection` has five parameters (three required and two\noptional). The values you specify determine which recovery point is included in the restore\ntest. You must indicate with `Algorithm` if you want the latest recovery point\nwithin your `SelectionWindowDays` or if you want a random recovery point, and\nyou must indicate through `IncludeVaults` from which vaults the recovery points\ncan be chosen.\n`Algorithm` (*required*) Valid values:\n\"`LATEST_WITHIN_WINDOW`\" or \"`RANDOM_WITHIN_WINDOW`\".\n`Recovery point types` (*required*) Valid values:\n\"`SNAPSHOT`\" and/or \"`CONTINUOUS`\". Include `SNAPSHOT`\nto restore only snapshot recovery points; include `CONTINUOUS` to restore\ncontinuous recovery points (point in time restore / PITR); use both to restore either a\nsnapshot or a continuous recovery point. The recovery point will be determined by the value\nfor `Algorithm`.\n`IncludeVaults` (*required*). You must include one or more\nbackup vaults. Use the wildcard [\"\\*\"] or specific ARNs.\n`SelectionWindowDays` (*optional*) Value must be an\ninteger (in days) from 1 to 365. If not included, the value defaults to\n`30`.\n`ExcludeVaults` (*optional*). You can choose to input one\nor more specific backup vault ARNs to exclude those vaults' contents from restore\neligibility. Or, you can include a list of selectors. If this parameter and its value are\nnot included, it defaults to empty list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html", "Properties": { "SelectionWindowDays": { "MarkdownDocumentation": "`SelectionWindowDays`\n\nAccepted values are integers from 1 to 365.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-selectionwindowdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RecoveryPointTypes": { "MarkdownDocumentation": "`RecoveryPointTypes`\n\nThese are the types of recovery points.\nInclude `SNAPSHOT`\nto restore only snapshot recovery points; include `CONTINUOUS` to restore\ncontinuous recovery points (point in time restore / PITR); use both to restore either a\nsnapshot or a continuous recovery point. The recovery point will be determined by the value\nfor `Algorithm`.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-recoverypointtypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IncludeVaults": { "MarkdownDocumentation": "`IncludeVaults`\n\nAccepted values include wildcard [\"\\*\"] or by specific ARNs or\nARN wilcard replacement\n[\"arn:aws:backup:us-west-2:123456789012:backup-vault:asdf\", ...]\n[\"arn:aws:backup:\\*:\\*:backup-vault:asdf-\\*\", ...]\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-includevaults", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExcludeVaults": { "MarkdownDocumentation": "`ExcludeVaults`\n\nAccepted values include specific ARNs or list of selectors.\nDefaults to empty list if not listed.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-excludevaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Algorithm": { "MarkdownDocumentation": "`Algorithm`\n\nAcceptable values include \"LATEST\\_WITHIN\\_WINDOW\" or\n\"RANDOM\\_WITHIN\\_WINDOW\"\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LATEST_WITHIN_WINDOW | RAND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LATEST_WITHIN_WINDOW", "RANDOM_WITHIN_WINDOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-algorithm", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Backup::RestoreTestingSelection.KeyValue": { "MarkdownDocumentation": "`AWS::Backup::RestoreTestingSelection.KeyValue`\n\nPair of two related strings. Allowed characters\nare letters, white space, and numbers that can be\nrepresented in UTF-8 and the following characters:\n `+ - = . _ : /`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-keyvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-keyvalue.html#cfn-backup-restoretestingselection-keyvalue-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-keyvalue.html#cfn-backup-restoretestingselection-keyvalue-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Backup::RestoreTestingSelection.ProtectedResourceConditions": { "MarkdownDocumentation": "`AWS::Backup::RestoreTestingSelection.ProtectedResourceConditions`\n\nThe conditions that you define for resources in\nyour restore testing plan using tags.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-protectedresourceconditions.html", "Properties": { "StringEquals": { "MarkdownDocumentation": "`StringEquals`\n\nFilters the values of your tagged resources for only\nthose resources that you tagged with the same value.\nAlso called \"exact matching.\"\n*Required*: No\n*Type*: Array of [KeyValue](./aws-properties-backup-restoretestingselection-keyvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-protectedresourceconditions.html#cfn-backup-restoretestingselection-protectedresourceconditions-stringequals", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValue", "DuplicatesAllowed": true }, "StringNotEquals": { "MarkdownDocumentation": "`StringNotEquals`\n\nFilters the values of your tagged resources for only\nthose resources that you tagged that do not have the same value.\nAlso called \"negated matching.\"\n*Required*: No\n*Type*: Array of [KeyValue](./aws-properties-backup-restoretestingselection-keyvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-protectedresourceconditions.html#cfn-backup-restoretestingselection-protectedresourceconditions-stringnotequals", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValue", "DuplicatesAllowed": true } } }, "AWS::Batch::ComputeEnvironment.ComputeResources": { "MarkdownDocumentation": "`AWS::Batch::ComputeEnvironment.ComputeResources`\n\nDetails about the compute resources managed by the compute environment. This parameter is\nrequired for managed compute environments. For more information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)\nin the *AWS Batch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html", "Properties": { "SpotIamFleetRole": { "MarkdownDocumentation": "`SpotIamFleetRole`\n\nThe Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a `SPOT` compute\nenvironment. This role is required if the allocation strategy set to `BEST_FIT` or if\nthe allocation strategy isn't specified. For more information, see [Amazon EC2 spot fleet role](https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in the\n*AWS Batch User Guide*.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.\n\n###### Important\nTo tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use\nthe newer **AmazonEC2SpotFleetTaggingRole** managed policy. The\npreviously recommended **AmazonEC2SpotFleetRole** managed policy\ndoesn't have the required permissions to tag Spot Instances. For more information, see [Spot instances\nnot tagged on creation](https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag) in the *AWS Batch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-spotiamfleetrole", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaxvCpus": { "MarkdownDocumentation": "`MaxvCpus`\n\nThe maximum number of Amazon EC2 vCPUs that an environment can reach.\n###### Note\nWith `BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and\n`SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using On-Demand or Spot\nInstances, and the `BEST_FIT` strategy using Spot Instances, AWS Batch might need to\nexceed `maxvCpus` to meet your capacity requirements. In this event, AWS Batch never\nexceeds `maxvCpus` by more than a single instance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Ec2Configuration": { "MarkdownDocumentation": "`Ec2Configuration`\n\nProvides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the\ncompute environment. If `Ec2Configuration` isn't specified, the default is\n`ECS_AL2`.\nWhen updating a compute environment, changing this setting requires an infrastructure update\nof the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the\n*AWS Batch User Guide*. To remove the Amazon EC2 configuration and any custom AMI ID\nspecified in `imageIdOverride`, set this value to an empty string.\nOne or two values can be provided.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.\n*Required*: No\n*Type*: Array of [Ec2ConfigurationObject](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "Ec2ConfigurationObject", "DuplicatesAllowed": true }, "BidPercentage": { "MarkdownDocumentation": "`BidPercentage`\n\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand\nprice for that instance type before instances are launched. For example, if your maximum\npercentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that\nAmazon EC2 instance. You always pay the lowest (market) price and never more than your maximum\npercentage. For most use cases, we recommend leaving this field empty.\nWhen updating a compute environment, changing the bid percentage requires an infrastructure\nupdate 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\n*AWS Batch User Guide*.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe Amazon EC2 security groups that are associated with instances launched in the compute\nenvironment. This parameter is required for Fargate compute resources, where it can contain up\nto 5 security groups. For Fargate compute resources, providing an empty list is handled as if\nthis parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an\nempty list removes the security groups from the compute resource.\nWhen updating a compute environment, changing the Amazon EC2 security groups requires an\ninfrastructure update of the compute environment. For more information, see [Updating compute\nenvironments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide*.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllocationStrategy": { "MarkdownDocumentation": "`AllocationStrategy`\n\nThe allocation strategy to use for the compute resource if not enough instances of the\nbest fitting instance type can be allocated. This might be because of availability of the\ninstance type in the Region or [Amazon EC2 service\nlimits](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\nthe *AWS Batch User Guide*.\nWhen updating a compute environment, changing the allocation strategy requires an\ninfrastructure 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\nwhen updating a compute environment.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources, and\nshouldn't be specified.\n\nBEST\\_FIT (default)\nAWS Batch selects an instance type that best fits the needs of the\njobs with a preference for the lowest-cost instance type. If additional instances\nof the selected instance type aren't available, AWS Batch waits for\nthe additional instances to be available. If there aren't enough instances\navailable, or if the user is reaching [Amazon EC2 service\nlimits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) then additional jobs aren't run until the currently running jobs\nhave completed. This allocation strategy keeps costs lower but can limit scaling.\nIf you are using Spot Fleets with `BEST_FIT` then the Spot Fleet IAM\nrole must be specified.\n\nBEST\\_FIT\\_PROGRESSIVE\nAWS Batch will select additional instance types that are large\nenough to meet the requirements of the jobs in the queue, with a preference for\ninstance types with a lower cost per unit vCPU. If additional instances of the\npreviously selected instance types aren't available, AWS Batch will\nselect new instance types.\n\nSPOT\\_CAPACITY\\_OPTIMIZED\nAWS Batch will select one or more instance types that are large\nenough to meet the requirements of the jobs in the queue, with a preference for\ninstance types that are less likely to be interrupted. This allocation strategy is\nonly available for Spot Instance compute resources.\n\nSPOT\\_PRICE\\_CAPACITY\\_OPTIMIZED\nThe price and capacity optimized allocation strategy looks at both price and\ncapacity to select the Spot Instance pools that are the least likely to be\ninterrupted and have the lowest possible price. This allocation strategy is only\navailable for Spot Instance compute resources.\n###### Note\nWe recommend that you use `SPOT_PRICE_CAPACITY_OPTIMIZED` rather\nthan `SPOT_CAPACITY_OPTIMIZED` in most instances.\n\nWith `BEST_FIT_PROGRESSIVE`, `SPOT_CAPACITY_OPTIMIZED`, and\n`SPOT_PRICE_CAPACITY_OPTIMIZED` allocation strategies using On-Demand or Spot\nInstances, and the `BEST_FIT` strategy using Spot Instances, AWS Batch might need to go above `maxvCpus` to meet your capacity\nrequirements. In this event, AWS Batch never exceeds `maxvCpus`\nby more than a single instance.\n*Required*: No\n*Type*: String\n*Allowed values*: `BEST_FIT_PROGRESSIVE | SPOT...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BEST_FIT_PROGRESSIVE", "SPOT_CAPACITY_OPTIMIZED", "SPOT_PRICE_CAPACITY_OPTIMIZED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe VPC subnets where the compute resources are launched. Fargate compute resources can\ncontain up to 16 subnets. For Fargate compute resources, providing an empty list will be\nhandled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources,\nproviding an empty list removes the VPC subnets from the compute resource. For more information,\nsee [VPCs and\nsubnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the *Amazon VPC User Guide*.\nWhen updating a compute environment, changing the VPC subnets requires an infrastructure\nupdate 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\n*AWS Batch User Guide*.\n###### Note\nAWS Batch on Amazon EC2 and AWS Batch on Amazon EKS support Local Zones. For more information, see [Local\nZones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones) in the *Amazon EC2 User Guide for Linux Instances*, [Amazon EKS and AWS Local\nZones](https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html) in the *Amazon EKS User Guide* and [Amazon ECS\nclusters in Local Zones, Wavelength Zones, and AWS Outposts](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones) in the *Amazon ECS\nDeveloper Guide*.\nAWS Batch on Fargate doesn't currently support Local Zones.\n*Required*: Yes\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets", "UpdateType": "Conditional", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of compute environment: `EC2`, `SPOT`,\n`FARGATE`, or `FARGATE_SPOT`. For more information, see [Compute\nenvironments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the *AWS Batch User Guide*.\nIf you choose `SPOT`, you must also specify an Amazon EC2 Spot Fleet role\nwith the `spotIamFleetRole` parameter. For more information, see [Amazon EC2\nspot fleet role](https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in the *AWS Batch User Guide*.\nWhen updating compute environment, changing the type of a compute environment requires\nan 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*.\nWhen updating the type of a compute environment, changing between `EC2` and\n`SPOT` or between `FARGATE` and `FARGATE_SPOT` will\ninitiate an infrastructure update, but if you switch between `EC2` and\n`FARGATE`, CloudFormation will create a new compute environment.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EC2 | SPOT | FARGATE | FARG...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EC2", "SPOT", "FARGATE", "FARGATE_SPOT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "MinvCpus": { "MarkdownDocumentation": "`MinvCpus`\n\nThe minimum number of vCPUs that an environment should maintain (even if the compute environment\nis `DISABLED`).\n###### Note\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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UpdateToLatestImageVersion": { "MarkdownDocumentation": "`UpdateToLatestImageVersion`\n\nSpecifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when\nthe compute environment has an infrastructure update. The default value is\n`false`.\n###### Note\nAn AMI ID can either be specified in the `imageId` or\n`imageIdOverride` parameters or be determined by the launch template that's\nspecified in the `launchTemplate` parameter. If an AMI ID is specified any of these\nways, this parameter is ignored. For more information about to update AMI IDs during an\ninfrastructure update, see [Updating\nthe AMI ID](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami) in the *AWS Batch User Guide*.\nWhen updating a compute environment, changing this setting requires an infrastructure update\nof the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the\n*AWS Batch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LaunchTemplate": { "MarkdownDocumentation": "`LaunchTemplate`\n\nThe launch template to use for your compute resources. Any other compute resource\nparameters that you specify in a [CreateComputeEnvironment](https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html) API operation override the same parameters in the\nlaunch template. You must specify either the launch template ID or launch template name in\nthe request, but not both. For more information, see [Launch Template Support](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in\nthe *AWS Batch User Guide*. Removing the launch template from a compute environment will not remove the\nAMI specified in the launch template. In order to update the AMI specified in a launch\ntemplate, the `updateToLatestImageVersion` parameter must be set to\n`true`.\nWhen updating a compute environment, changing the launch template requires an\ninfrastructure 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*.\n###### Note\nThis parameter isn't applicable to jobs running on Fargate resources, and shouldn't\nbe specified.\n*Required*: No\n*Type*: [LaunchTemplateSpecification](./aws-properties-batch-computeenvironment-launchtemplatespecification.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate", "UpdateType": "Conditional", "Required": false, "Type": "LaunchTemplateSpecification" }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nThe Amazon Machine Image (AMI) ID used for instances launched in the compute environment.\nThis parameter is overridden by the `imageIdOverride` member of the\n`Ec2Configuration` structure. To remove the custom AMI ID and use the default AMI ID,\nset this value to an empty string.\nWhen updating a compute environment, changing the AMI ID requires an infrastructure update\nof the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the\n*AWS Batch User Guide*.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.\n\n###### Note\nThe AMI that you choose for a compute environment must match the architecture of the instance types that\nyou intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\nthe compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\nAmazon ECS-optimized Amazon Linux 2 AMI. For more information, see [Amazon ECS-optimized\nAmazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "InstanceRole": { "MarkdownDocumentation": "`InstanceRole`\n\nThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.\nRequired for Amazon EC2 instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance\nprofile. For example, `ecsInstanceRole` or\n`arn:aws:iam:::instance-profile/ecsInstanceRole`.\nFor more information, see [Amazon ECS instance role](https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) in the *AWS Batch User Guide*.\nWhen updating a compute environment, changing this setting requires an infrastructure update\nof the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the\n*AWS Batch User Guide*.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "InstanceTypes": { "MarkdownDocumentation": "`InstanceTypes`\n\nThe instances types that can be launched. You can specify instance families to launch any\ninstance type within those families (for example, `c5` or `p3`), or you can\nspecify specific sizes within a family (such as `c5.8xlarge`).\nAWS Batch can select the instance type for you if you choose one of the following:\n* `optimal` to select instance types (from the `c4`, `m4`,\n `r4`, `c5`, `m5`, and `r5`\n instance families) that match the demand of your job queues.\n* `default_x86_64` to choose x86 based instance types (from the `m6i`,\n `c6i`, `r6i`, and `c7i` instance families) that matches the resource demands of the job queue.\n* `default_arm64` to choose x86 based instance types (from the `m6g`,\n `c6g`, `r6g`, and `c7g` instance families) that matches the resource demands of the job queue.\n###### Note\nStarting on 11/01/2025 the behavior of `optimal` is going to be changed to match\n`default_x86_64`. During the change your instance families could be updated to a\nnewer generation. You do not need to perform any actions for the upgrade to happen. For more\ninformation about change, see [Optimal instance type configuration to receive automatic instance family\nupdates](https://docs.aws.amazon.com/batch/latest/userguide/optimal-default-instance-troubleshooting.html).\n\n###### Note\nInstance family availability varies by AWS Region. For example, some AWS Regions may not have any fourth generation instance families but have fifth and\nsixth generation instance families.\nWhen using `default_x86_64` or `default_arm64` instance bundles,\nAWS Batch selects instance families based on a balance of cost-effectiveness and performance.\nWhile newer generation instances often provide better price-performance, AWS Batch may choose an\nearlier generation instance family if it provides the optimal combination of availability, cost,\nand performance for your workload. For example, in an AWS Region where both c6i\nand c7i instances are available, AWS Batch might select c6i instances if they offer better\ncost-effectiveness for your specific job requirements. For more information on AWS Batch instance\ntypes and AWS Region availability, see [Instance\ntype compute table](https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html) in the *AWS Batch User Guide*.\nAWS Batch periodically updates your instances in default bundles to newer,\nmore cost-effective options. Updates happen automatically without requiring any\naction from you. Your workloads continue running during updates with no interruption\n\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.\n\n###### Note\nWhen you create a compute environment, the instance types that you select for the compute environment must\nshare the same architecture. For example, you can't mix x86 and ARM instances in the same compute\nenvironment.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Ec2KeyPair": { "MarkdownDocumentation": "`Ec2KeyPair`\n\nThe Amazon EC2 key pair that's used for instances launched in the compute environment. You can\nuse this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this\nvalue to an empty string.\nWhen updating a compute environment, changing the Amazon EC2 key pair requires an infrastructure\nupdate 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\n*AWS Batch User Guide*.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "PlacementGroup": { "MarkdownDocumentation": "`PlacementGroup`\n\nThe Amazon EC2 placement group to associate with your compute resources. If you intend to submit\nmulti-node parallel jobs to your compute environment, you should consider creating a cluster\nplacement group and associate it with your compute resources. This keeps your multi-node parallel\njob on a logical grouping of instances within a single Availability Zone with high network flow\npotential. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the\n*Amazon EC2 User Guide for Linux Instances*.\nWhen updating a compute environment, changing the placement group requires an infrastructure\nupdate 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\n*AWS Batch User Guide*.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pair tags to be applied to Amazon EC2 resources that are launched in the compute\nenvironment. For AWS Batch, these take the form of `\"String1\": \"String2\"`, where\n`String1` is the tag key and `String2` is the tag value (for example,\n`{ \"Name\": \"Batch Instance - C4OnDemand\" }`). This is helpful for recognizing your\nBatch instances in the Amazon EC2 console. These tags aren't seen when using the AWS Batch`ListTagsForResource` API operation.\nWhen updating a compute environment, changing this setting requires an infrastructure update\nof the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the\n*AWS Batch User Guide*.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.*`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags", "UpdateType": "Conditional", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "DesiredvCpus": { "MarkdownDocumentation": "`DesiredvCpus`\n\nThe desired number of vCPUS in the compute environment. AWS Batch modifies this value between\nthe minimum and maximum values based on job queue demand.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.\n\n###### Note\nAWS Batch doesn't support changing the desired number of vCPUs of an existing compute\nenvironment. Don't specify this parameter for compute environments using Amazon EKS clusters.\n\n###### Note\nWhen you update the `desiredvCpus` setting, the value must be between the\n`minvCpus` and `maxvCpus` values.\nAdditionally, the updated `desiredvCpus` value must be greater than or equal to\nthe current `desiredvCpus` value. For more information, see [Troubleshooting\nAWS Batch](https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-desiredvcpus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Batch::ComputeEnvironment.Ec2ConfigurationObject": { "MarkdownDocumentation": "`AWS::Batch::ComputeEnvironment.Ec2ConfigurationObject`\n\nProvides information used to select Amazon Machine Images (AMIs) for instances in the\ncompute environment. If `Ec2Configuration` isn't specified, the default is\n`ECS_AL2` ([Amazon Linux 2](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami)).\n###### Note\nThis object isn't applicable to jobs that are running on Fargate resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html", "Properties": { "ImageIdOverride": { "MarkdownDocumentation": "`ImageIdOverride`\n\nThe AMI ID used for instances launched in the compute environment that match the image type.\nThis setting overrides the `imageId` set in the `computeResource`\nobject.\n###### Note\nThe AMI that you choose for a compute environment must match the architecture of the instance types that\nyou intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\nthe compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\nAmazon ECS-optimized Amazon Linux 2 AMI. For more information, see [Amazon ECS-optimized\nAmazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imageidoverride", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "ImageKubernetesVersion": { "MarkdownDocumentation": "`ImageKubernetesVersion`\n\nThe Kubernetes version for the compute environment. If you don't specify a value, the latest\nversion that AWS Batch supports is used.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imagekubernetesversion", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "ImageType": { "MarkdownDocumentation": "`ImageType`\n\nThe image type to match with the instance type to select an AMI. The supported values are\ndifferent for `ECS` and `EKS` resources.\nECS\nIf the `imageIdOverride` parameter isn't specified, then a recent [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) (`ECS_AL2`) is used. If a new image type is\nspecified in an update, but neither an `imageId` nor a `imageIdOverride`\nparameter is specified, then the latest Amazon ECS optimized AMI for that image type that's\nsupported by AWS Batch is used.\n###### Important\nAWS will end support for Amazon ECS optimized AL2-optimized and AL2-accelerated AMIs. Starting in January 2026, AWS Batch will change\nthe default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023.\nWe recommend migrating AWS Batch Amazon ECS compute environments to Amazon Linux 2023 to maintain\noptimal performance and security. For more information on upgrading from AL2 to AL2023, see [How to migrate\nfrom ECS AL2 to ECS AL2023](https://docs.aws.amazon.com/batch/latest/userguide/ecs-migration-2023.html) in the *AWS Batch User Guide*.\n\nECS\\_AL2\n[Amazon Linux\n2](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami): Default for all non-GPU instance families.\n\nECS\\_AL2\\_NVIDIA\n[Amazon Linux 2\n(GPU)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami): Default for all GPU instance families (for example `P4` and\n`G4`) and can be used for all non AWS Graviton-based instance types.\n\nECS\\_AL2023\n[Amazon Linux 2023](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html): AWS Batch\nsupports Amazon Linux 2023.\n###### Note\nAmazon Linux 2023 does not support `A1` instances.\n\nECS\\_AL2023\\_NVIDIA\n[Amazon Linux 2023\n(GPU)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami): For all GPU instance families and can be used for all non AWS Graviton-based instance types.\n###### Note\nECS\\_AL2023\\_NVIDIA doesn't support `p3` and `g3` instance types.\n\n\nEKS\nIf the `imageIdOverride` parameter isn't specified, then a recent [Amazon EKS-optimized Amazon Linux 2023\nAMI](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) (`EKS_AL2023`) is used. If a new image type is specified in an update,\nbut neither an `imageId` nor a `imageIdOverride` parameter is specified,\nthen the latest Amazon EKS optimized AMI for that image type that AWS Batch supports is used.\n###### Important\nAmazon Linux 2023 AMIs are the\ndefault on AWS Batch for Amazon EKS.\nAWS will end\nsupport for Amazon EKS AL2-optimized and AL2-accelerated AMIs, starting 11/26/25. You can continue\nusing AWS Batch-provided Amazon EKS optimized Amazon Linux 2 AMIs on your Amazon EKS compute\nenvironments beyond the 11/26/25 end-of-support date, these compute environments will no\nlonger receive any new software updates, security patches, or bug fixes from\nAWS. For more information on upgrading from AL2 to AL2023, see [How to upgrade from EKS AL2 to EKS AL2023](https://docs.aws.amazon.com/batch/latest/userguide/eks-migration-2023.html) in the *AWS Batch User Guide*.\n\nEKS\\_AL2\n[Amazon\nLinux 2](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html): Used for non-GPU instance families.\n\nEKS\\_AL2\\_NVIDIA\n[Amazon\nLinux 2 (accelerated)](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html): Used for GPU instance families (for example,\n`P4` and `G4`) and can be used for all non AWS Graviton-based\ninstance types.\n\nEKS\\_AL2023\n[Amazon\nLinux 2023](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html): Default for non-GPU instance families.\n###### Note\nAmazon Linux 2023 does not support `A1` instances.\n\nEKS\\_AL2023\\_NVIDIA\n[Amazon\nLinux 2023 (accelerated)](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html): Default for GPU instance families and can be used for all non AWS\nGraviton-based instance types.\n\n\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imagetype", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::ComputeEnvironment.EksConfiguration": { "MarkdownDocumentation": "`AWS::Batch::ComputeEnvironment.EksConfiguration`\n\nConfiguration for the Amazon EKS cluster that supports the AWS Batch compute environment. The\ncluster must exist before the compute environment can be created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-eksconfiguration.html", "Properties": { "EksClusterArn": { "MarkdownDocumentation": "`EksClusterArn`\n\nThe Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is\n`arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-eksconfiguration.html#cfn-batch-computeenvironment-eksconfiguration-eksclusterarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KubernetesNamespace": { "MarkdownDocumentation": "`KubernetesNamespace`\n\nThe namespace of the Amazon EKS cluster. AWS Batch manages pods in this namespace. The value\ncan't left empty or null. It must be fewer than 64 characters long, can't be set to\n`default`, can't start with \"`kube-`,\" and must match this regular\nexpression: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`. For more information, see [Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) in the Kubernetes documentation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-eksconfiguration.html#cfn-batch-computeenvironment-eksconfiguration-kubernetesnamespace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification": { "MarkdownDocumentation": "`AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification`\n\nAn object that represents a launch template that's associated with a compute resource. You\nmust specify either the launch template ID or launch template name in the request, but not\nboth.\nIf security groups are specified using both the `securityGroupIds` parameter of\n`CreateComputeEnvironment` and the launch template, the values in the\n`securityGroupIds` parameter of `CreateComputeEnvironment` will be\nused.\n###### Note\nThis object isn't applicable to jobs that are running on Fargate resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html", "Properties": { "UserdataType": { "MarkdownDocumentation": "`UserdataType`\n\nThe EKS node initialization process to use. You only need to specify this value if you are\nusing a custom AMI. The default value is `EKS_BOOTSTRAP_SH`. If\n*imageType* is a custom AMI based on EKS\\_AL2023 or EKS\\_AL2023\\_NVIDIA then you\nmust choose `EKS_NODEADM`.\n*Required*: No\n*Type*: String\n*Allowed values*: `EKS_BOOTSTRAP_SH | EKS_NODE...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EKS_BOOTSTRAP_SH", "EKS_NODEADM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-userdatatype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nThe name of the launch template.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-launchtemplatename", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version number of the launch template,\n`$Default`, or `$Latest`.\nIf the value is `$Default`, the default version of the launch template is used. If the value is `$Latest`, the latest version of the launch template is used.\n###### Important\nIf the AMI ID that's used in a compute environment is from the launch template, the AMI\nisn't changed when the compute environment is updated. It's only changed if the\n`updateToLatestImageVersion` parameter for the compute environment is set to\n`true`. During an infrastructure update, if either `$Default` or\n`$Latest` is specified, AWS Batch re-evaluates the launch template version, and it\nmight use a different version of the launch template. This is the case even if the launch\ntemplate isn't specified in the update. When updating a compute environment, changing the launch\ntemplate requires an infrastructure update of the compute environment. For more information, see\n[Updating compute\nenvironments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide*.\nDefault: `$Default`\nLatest: `$Latest`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-version", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nA launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.\nYou can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.\n###### Note\nTo unset all override templates for a compute environment, you can pass an empty array to the [UpdateComputeEnvironment.overrides](https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html) parameter, or not include the `overrides` parameter when submitting the `UpdateComputeEnvironment` API operation.\n*Required*: No\n*Type*: Array of [LaunchTemplateSpecificationOverride](./aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-overrides", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "LaunchTemplateSpecificationOverride", "DuplicatesAllowed": true }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nThe ID of the launch template.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-launchtemplateid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::ComputeEnvironment.LaunchTemplateSpecificationOverride": { "MarkdownDocumentation": "`AWS::Batch::ComputeEnvironment.LaunchTemplateSpecificationOverride`\n\nAn object that represents a launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not\nboth.\nIf security groups are specified using both the `securityGroupIds` parameter of\n`CreateComputeEnvironment` and the launch template, the values in the\n`securityGroupIds` parameter of `CreateComputeEnvironment` will be\nused.\nYou can define up to ten (10) overrides for each compute environment.\n###### Note\nThis object isn't applicable to jobs that are running on Fargate resources.\n###### Note\nTo unset all override templates for a compute environment, you can pass an empty array to the [UpdateComputeEnvironment.overrides](https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html) parameter, or not include the `overrides` parameter when submitting the `UpdateComputeEnvironment` API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html", "Properties": { "TargetInstanceTypes": { "MarkdownDocumentation": "`TargetInstanceTypes`\n\nThe instance type or family that this override launch template should be applied to.\nThis parameter is required when defining a launch template override.\nInformation included in this parameter must meet the following requirements:\n* Must be a valid Amazon EC2 instance type or family.\n* The following AWS Batch`InstanceTypes` are not allowed: `optimal`, `default_x86_64`, and `default_arm64`.\n* `targetInstanceTypes` can target only instance types and families that are included within the [`ComputeResource.instanceTypes`](https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes) set. `targetInstanceTypes` doesn't need to include all of the instances from the `instanceType` set, but at least a subset. For example, if `ComputeResource.instanceTypes` includes `[m5, g5]`, `targetInstanceTypes` can include `[m5.2xlarge]` and `[m5.large]` but not `[c5.large]`.\n* `targetInstanceTypes` included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-targetinstancetypes", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UserdataType": { "MarkdownDocumentation": "`UserdataType`\n\nThe EKS node initialization process to use. You only need to specify this value if you are\nusing a custom AMI. The default value is `EKS_BOOTSTRAP_SH`. If\n*imageType* is a custom AMI based on EKS\\_AL2023 or EKS\\_AL2023\\_NVIDIA then you\nmust choose `EKS_NODEADM`.\n*Required*: No\n*Type*: String\n*Allowed values*: `EKS_BOOTSTRAP_SH | EKS_NODE...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EKS_BOOTSTRAP_SH", "EKS_NODEADM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-userdatatype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nThe name of the launch template.\n**Note:** If you specify the `launchTemplateName` you can't specify the `launchTemplateId` as well.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-launchtemplatename", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version number of the launch template,\n`$Default`, or `$Latest`.\nIf the value is `$Default`, the default version of the launch template is used. If the value is `$Latest`, the latest version of the launch template is used.\n###### Important\nIf the AMI ID that's used in a compute environment is from the launch template, the AMI\nisn't changed when the compute environment is updated. It's only changed if the\n`updateToLatestImageVersion` parameter for the compute environment is set to\n`true`. During an infrastructure update, if either `$Default` or `$Latest` is specified, AWS Batch re-evaluates the launch template version, and it\nmight use a different version of the launch template. This is the case even if the launch\ntemplate isn't specified in the update. When updating a compute environment, changing the launch\ntemplate requires an infrastructure update of the compute environment. For more information, see\n[Updating compute\nenvironments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide*.\nDefault: `$Default`\nLatest: `$Latest`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-version", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nThe ID of the launch template.\n**Note:** If you specify the `launchTemplateId` you can't specify the `launchTemplateName` as well.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecificationoverride.html#cfn-batch-computeenvironment-launchtemplatespecificationoverride-launchtemplateid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::ComputeEnvironment.UpdatePolicy": { "MarkdownDocumentation": "`AWS::Batch::ComputeEnvironment.UpdatePolicy`\n\nSpecifies the infrastructure update policy for the Amazon EC2 compute environment. For more information\nabout infrastructure updates, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the\n*AWS Batch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-updatepolicy.html", "Properties": { "JobExecutionTimeoutMinutes": { "MarkdownDocumentation": "`JobExecutionTimeoutMinutes`\n\nSpecifies the job timeout (in minutes) when the compute environment infrastructure is\nupdated. The default value is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-updatepolicy.html#cfn-batch-computeenvironment-updatepolicy-jobexecutiontimeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TerminateJobsOnUpdate": { "MarkdownDocumentation": "`TerminateJobsOnUpdate`\n\nSpecifies whether jobs are automatically terminated when the compute environment\ninfrastructure is updated. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-updatepolicy.html#cfn-batch-computeenvironment-updatepolicy-terminatejobsonupdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Batch::JobDefinition.ConsumableResourceProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.ConsumableResourceProperties`\n\nContains a list of consumable resources required by a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-consumableresourceproperties.html", "Properties": { "ConsumableResourceList": { "MarkdownDocumentation": "`ConsumableResourceList`\n\nThe list of consumable resources required by a job.\n*Required*: Yes\n*Type*: Array of [ConsumableResourceRequirement](./aws-properties-batch-jobdefinition-consumableresourcerequirement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-consumableresourceproperties.html#cfn-batch-jobdefinition-consumableresourceproperties-consumableresourcelist", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ConsumableResourceRequirement", "DuplicatesAllowed": false } } }, "AWS::Batch::JobDefinition.ConsumableResourceRequirement": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.ConsumableResourceRequirement`\n\nInformation about a consumable resource required to run a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-consumableresourcerequirement.html", "Properties": { "ConsumableResource": { "MarkdownDocumentation": "`ConsumableResource`\n\nThe name or ARN of the consumable resource.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-consumableresourcerequirement.html#cfn-batch-jobdefinition-consumableresourcerequirement-consumableresource", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Quantity": { "MarkdownDocumentation": "`Quantity`\n\nThe quantity of the consumable resource that is needed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-consumableresourcerequirement.html#cfn-batch-jobdefinition-consumableresourcerequirement-quantity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Long" } } }, "AWS::Batch::JobDefinition.ContainerProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.ContainerProperties`\n\nContainer properties are used for Amazon ECS based job definitions. These properties to describe the\ncontainer that's launched as part of a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html", "Properties": { "RepositoryCredentials": { "MarkdownDocumentation": "`RepositoryCredentials`\n\nThe private repository authentication credentials to use.\n*Required*: No\n*Type*: [RepositoryCredentials](./aws-properties-batch-jobdefinition-repositorycredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-repositorycredentials", "UpdateType": "Mutable", "Required": false, "Type": "RepositoryCredentials" }, "User": { "MarkdownDocumentation": "`User`\n\nThe user name to use inside the container. This parameter maps to `User` in the\n[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 `--user`\noption to [docker run](https://docs.docker.com/engine/reference/run/).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-user", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Secrets": { "MarkdownDocumentation": "`Secrets`\n\nThe secrets for the container. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the\n*AWS Batch User Guide*.\n*Required*: No\n*Type*: Array of [Secret](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-secrets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Secret", "DuplicatesAllowed": true }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThis parameter is deprecated, use `resourceRequirements` to specify the memory\nrequirements for the job definition. It's not supported for jobs running on Fargate resources.\nFor jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a\ncontainer. If your container attempts to exceed the specified number, it's terminated. You must\nspecify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be\nspecified in several places. It must be specified for each node at least once.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-memory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Privileged": { "MarkdownDocumentation": "`Privileged`\n\nWhen this parameter is true, the container is given elevated permissions on the host\ncontainer instance (similar to the `root` user). This parameter maps to\n`Privileged` in the [Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the\n[Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--privileged` option to [docker run](https://docs.docker.com/engine/reference/run/). The default value is false.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources and\nshouldn't be provided, or specified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-privileged", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableExecuteCommand": { "MarkdownDocumentation": "`EnableExecuteCommand`\n\nDetermines whether execute command functionality is turned on for this task. If `true`, execute\ncommand functionality is turned on all the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-enableexecutecommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LinuxParameters": { "MarkdownDocumentation": "`LinuxParameters`\n\nLinux-specific modifications that are applied to the container, such as details for device\nmappings.\n*Required*: No\n*Type*: [LinuxParameters](./aws-properties-batch-jobdefinition-linuxparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-linuxparameters", "UpdateType": "Mutable", "Required": false, "Type": "LinuxParameters" }, "FargatePlatformConfiguration": { "MarkdownDocumentation": "`FargatePlatformConfiguration`\n\nThe platform configuration for jobs that are running on Fargate resources. Jobs that are\nrunning on Amazon EC2 resources must not specify this parameter.\n*Required*: No\n*Type*: [FargatePlatformConfiguration](./aws-properties-batch-jobdefinition-fargateplatformconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-fargateplatformconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FargatePlatformConfiguration" }, "JobRoleArn": { "MarkdownDocumentation": "`JobRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more\ninformation, see [IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-jobrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReadonlyRootFilesystem": { "MarkdownDocumentation": "`ReadonlyRootFilesystem`\n\nWhen this parameter is true, the container is given read-only access to its root file\nsystem. This parameter maps to `ReadonlyRootfs` in the\n[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\n`--read-only` option to `docker 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-readonlyrootfilesystem", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Vcpus": { "MarkdownDocumentation": "`Vcpus`\n\nThis parameter is deprecated, use `resourceRequirements` to specify the vCPU\nrequirements for the job definition. It's not supported for jobs running on Fargate resources.\nFor jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the\njob.\nEach vCPU is equivalent to 1,024 CPU shares. This parameter maps to `CpuShares`\nin 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\n`--cpu-shares` option to [docker run](https://docs.docker.com/engine/reference/run/). The\nnumber of vCPUs must be specified but can be specified in several places. You must specify it at\nleast once for each node.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-vcpus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Image": { "MarkdownDocumentation": "`Image`\n\nRequired. The image used to start a container. This string is passed directly to the\nDocker daemon. Images in the Docker Hub registry are available by default. Other repositories are\nspecified with\n`repository-url/image:tag`.\nIt can be 255 characters long. It can contain uppercase and lowercase letters, numbers,\nhyphens (-), underscores (\\_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to `Image` in the\n[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 `IMAGE`\nparameter of [docker run](https://docs.docker.com/engine/reference/run/).\n###### Note\nDocker image architecture must match the processor architecture of the compute resources\nthat they're scheduled on. For example, ARM-based Docker images can only run on ARM-based\ncompute resources.\n\n* Images in Amazon ECR Public repositories use the full `registry/repository[:tag]` or\n `registry/repository[@digest]` naming conventions. For example,\n `public.ecr.aws/registry_alias/my-web-app:latest`.\n* Images in Amazon ECR repositories use the full registry and repository URI (for example,\n `123456789012.dkr.ecr..amazonaws.com/`).\n* Images in official repositories on Docker Hub use a single name (for example,\n `ubuntu` or `mongo`).\n* Images in other repositories on Docker Hub are qualified with an organization name (for\n example, `amazon/amazon-ecs-agent`).\n* Images in other online repositories are qualified further by a domain name (for example,\n `quay.io/assemblyline/ubuntu`).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-image", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceRequirements": { "MarkdownDocumentation": "`ResourceRequirements`\n\nThe type and amount of resources to assign to a container. The supported resources include\n`GPU`, `MEMORY`, and `VCPU`.\n*Required*: No\n*Type*: Array of [ResourceRequirement](./aws-properties-batch-jobdefinition-resourcerequirement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-resourcerequirements", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceRequirement", "DuplicatesAllowed": true }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe log configuration specification for the container.\nThis parameter maps to `LogConfig` in the [Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container)\nsection of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--log-driver` option to [docker run](https://docs.docker.com/engine/reference/run/). By default, containers use the same logging\ndriver that the Docker daemon uses. However the container might use a different logging driver\nthan the Docker daemon by specifying a log driver with this parameter in the container\ndefinition. To use a different logging driver for a container, the log system must be configured\nproperly on the container instance (or on a different log server for remote logging options). For\nmore information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/)\nin the Docker documentation.\n###### Note\nAWS Batch currently supports a subset of the logging drivers available to the Docker daemon\n(shown in the [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html) data type).\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\ncontainer instance. To check the Docker Remote API version on your container instance, log in to your\ncontainer instance and run the following command: `sudo docker version | grep \"Server API version\"`\n###### Note\nThe Amazon ECS container agent running on a container instance must register the logging drivers\navailable on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment\nvariable before containers placed on that instance can use these log configuration options. For\nmore information, see [Amazon ECS container agent\nconfiguration](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](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogConfiguration" }, "MountPoints": { "MarkdownDocumentation": "`MountPoints`\n\nThe mount points for data volumes in your container. This parameter maps to\n`Volumes` 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/)\nand the `--volume` option to [docker\nrun](https://docs.docker.com/engine/reference/run/).\n*Required*: No\n*Type*: Array of [MountPoint](./aws-properties-batch-jobdefinition-mountpoint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-mountpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MountPoint", "DuplicatesAllowed": true }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate\nresources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)\nin the *AWS Batch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-executionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuntimePlatform": { "MarkdownDocumentation": "`RuntimePlatform`\n\nAn object that represents the compute environment architecture for AWS Batch jobs on\nFargate.\n*Required*: No\n*Type*: [RuntimePlatform](./aws-properties-batch-jobdefinition-runtimeplatform.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-runtimeplatform", "UpdateType": "Mutable", "Required": false, "Type": "RuntimePlatform" }, "Volumes": { "MarkdownDocumentation": "`Volumes`\n\nA list of data volumes used in a job.\n*Required*: No\n*Type*: Array of [Volume](./aws-properties-batch-jobdefinition-volume.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-volumes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Volume", "DuplicatesAllowed": true }, "Command": { "MarkdownDocumentation": "`Command`\n\nThe command that's passed to the container. This parameter maps to `Cmd` in the\n[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 `COMMAND`\nparameter to [docker run](https://docs.docker.com/engine/reference/run/). For more information, see\n.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-command", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nThe environment variables to pass to a container. This parameter maps to `Env` in\nthe [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\n`--env` option to [docker run](https://docs.docker.com/engine/reference/run/).\n###### Important\nWe don't recommend using plaintext environment variables for sensitive information, such as\ncredential data.\n\n###### Note\nEnvironment variables cannot start with \"`AWS_BATCH`\". This naming\nconvention is reserved for variables that AWS Batch sets.\n*Required*: No\n*Type*: [Array](./aws-properties-batch-jobdefinition-environment.html) of [Environment](./aws-properties-batch-jobdefinition-environment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-environment", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Environment", "DuplicatesAllowed": true }, "Ulimits": { "MarkdownDocumentation": "`Ulimits`\n\nA list of `ulimits` to set in the container. This parameter maps to\n`Ulimits` 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/)\nand the `--ulimit` option to [docker\nrun](https://docs.docker.com/engine/reference/run/).\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources and\nshouldn't be provided.\n*Required*: No\n*Type*: Array of [Ulimit](./aws-properties-batch-jobdefinition-ulimit.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-ulimits", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ulimit", "DuplicatesAllowed": true }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for jobs that are running on Fargate resources. Jobs that are\nrunning on Amazon EC2 resources must not specify this parameter.\n*Required*: No\n*Type*: [NetworkConfiguration](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NetworkConfiguration" }, "EphemeralStorage": { "MarkdownDocumentation": "`EphemeralStorage`\n\nThe amount of ephemeral storage to allocate for the task. This parameter is used to expand\nthe total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\nAWS Fargate.\n*Required*: No\n*Type*: [EphemeralStorage](./aws-properties-batch-jobdefinition-ephemeralstorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-ephemeralstorage", "UpdateType": "Mutable", "Required": false, "Type": "EphemeralStorage" } } }, "AWS::Batch::JobDefinition.Device": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.Device`\n\nAn object that represents a container instance host device.\n###### Note\nThis object isn't applicable to jobs that are running on Fargate resources and shouldn't\nbe provided.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html", "Properties": { "HostPath": { "MarkdownDocumentation": "`HostPath`\n\nThe path for the device on the host container 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-hostpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nThe explicit permissions to provide to the container for the device. By default, the\ncontainer has permissions for `read`, `write`, and `mknod` for\nthe device.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ContainerPath": { "MarkdownDocumentation": "`ContainerPath`\n\nThe path inside the container that's used to expose the host device. By default, the\n`hostPath` value 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-containerpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EFSAuthorizationConfig": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EFSAuthorizationConfig`\n\nThe authorization configuration details for the Amazon EFS file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsauthorizationconfig.html", "Properties": { "Iam": { "MarkdownDocumentation": "`Iam`\n\nWhether or not to use the AWS Batch job IAM role defined in a job definition when mounting the\nAmazon EFS file system. If enabled, transit encryption must be enabled in the\n`EFSVolumeConfiguration`. If this parameter is omitted, the default value of\n`DISABLED` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints) in\nthe *AWS Batch User Guide*. EFS IAM authorization requires that\n`TransitEncryption` be `ENABLED` and that a `JobRoleArn` is\nspecified.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsauthorizationconfig.html#cfn-batch-jobdefinition-efsauthorizationconfig-iam", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessPointId": { "MarkdownDocumentation": "`AccessPointId`\n\nThe Amazon EFS access point ID to use. If an access point is specified, the root directory value\nspecified in the `EFSVolumeConfiguration` must either be omitted or set to\n`/` which enforces the path set on the EFS access point. If an access point is used,\ntransit encryption must be enabled in the `EFSVolumeConfiguration`. For more\ninformation, see [Working\nwith 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsauthorizationconfig.html#cfn-batch-jobdefinition-efsauthorizationconfig-accesspointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EFSVolumeConfiguration": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EFSVolumeConfiguration`\n\nThis is used when you're using an Amazon Elastic File System file system for job storage. For more\ninformation, see [Amazon EFS\nVolumes](https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html) in the *AWS Batch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsvolumeconfiguration.html", "Properties": { "TransitEncryption": { "MarkdownDocumentation": "`TransitEncryption`\n\nDetermines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and\nthe Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If\nthis parameter is omitted, the default value of `DISABLED` is used. For more\ninformation, 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*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsvolumeconfiguration.html#cfn-batch-jobdefinition-efsvolumeconfiguration-transitencryption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizationConfig": { "MarkdownDocumentation": "`AuthorizationConfig`\n\nThe authorization configuration details for the Amazon EFS file system.\n*Required*: No\n*Type*: [EFSAuthorizationConfig](./aws-properties-batch-jobdefinition-efsauthorizationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsvolumeconfiguration.html#cfn-batch-jobdefinition-efsvolumeconfiguration-authorizationconfig", "UpdateType": "Mutable", "Required": false, "Type": "EFSAuthorizationConfig" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe Amazon EFS file system ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsvolumeconfiguration.html#cfn-batch-jobdefinition-efsvolumeconfiguration-filesystemid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RootDirectory": { "MarkdownDocumentation": "`RootDirectory`\n\nThe directory within the Amazon EFS file system to mount as the root directory inside the host.\nIf this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying\n`/` has the same effect as omitting this parameter. The maximum length is 4,096\ncharacters.\n###### Important\nIf an EFS access point is specified in the `authorizationConfig`, the root\ndirectory parameter must either be omitted or set to `/`, which enforces the path set\non the Amazon EFS access point.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsvolumeconfiguration.html#cfn-batch-jobdefinition-efsvolumeconfiguration-rootdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransitEncryptionPort": { "MarkdownDocumentation": "`TransitEncryptionPort`\n\nThe port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If\nyou don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS\nmount helper uses. The value must be between 0 and 65,535. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the\n*Amazon Elastic File System 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-efsvolumeconfiguration.html#cfn-batch-jobdefinition-efsvolumeconfiguration-transitencryptionport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Batch::JobDefinition.EcsProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EcsProperties`\n\nAn object that contains the properties for the Amazon ECS resources of a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecsproperties.html", "Properties": { "TaskProperties": { "MarkdownDocumentation": "`TaskProperties`\n\nAn object that contains the properties for the Amazon ECS task definition of a job.\n###### Note\nThis object is currently limited to one task element. However, the task element can run up to 10 containers.\n*Required*: Yes\n*Type*: Array of [EcsTaskProperties](./aws-properties-batch-jobdefinition-ecstaskproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecsproperties.html#cfn-batch-jobdefinition-ecsproperties-taskproperties", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "EcsTaskProperties", "DuplicatesAllowed": true } } }, "AWS::Batch::JobDefinition.EcsTaskProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EcsTaskProperties`\n\nThe properties for a task definition that describes the container and volume definitions of\nan Amazon ECS task. You can specify which Docker images to use, the required resources, and other\nconfigurations related to launching the task definition through an Amazon ECS service or task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html", "Properties": { "PlatformVersion": { "MarkdownDocumentation": "`PlatformVersion`\n\nThe Fargate platform version where the jobs are running. A platform version is specified\nonly for jobs that are running on Fargate resources. If one isn't specified, the\n`LATEST` platform version is used by default. This uses a recent, approved version of\nthe Fargate platform for compute resources. For more information, see [AWS Fargate\nplatform 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-platformversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate\nresources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)\nin the *AWS Batch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-executionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuntimePlatform": { "MarkdownDocumentation": "`RuntimePlatform`\n\nAn object that represents the compute environment architecture for AWS Batch jobs on\nFargate.\n*Required*: No\n*Type*: [RuntimePlatform](./aws-properties-batch-jobdefinition-runtimeplatform.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-runtimeplatform", "UpdateType": "Mutable", "Required": false, "Type": "RuntimePlatform" }, "TaskRoleArn": { "MarkdownDocumentation": "`TaskRoleArn`\n\nThe Amazon Resource Name (ARN) that's associated with the Amazon ECS task.\n###### Note\nThis is object is comparable to [ContainerProperties:jobRoleArn](https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-taskrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpcMode": { "MarkdownDocumentation": "`IpcMode`\n\nThe IPC resource namespace to use for the containers in the task. The valid values are\n`host`, `task`, or `none`.\nIf `host` is specified, all containers within the tasks that specified the\n`host` IPC mode on the same container instance share the same IPC resources with the\nhost Amazon EC2 instance.\nIf `task` is specified, all containers within the specified `task`\nshare the same IPC resources.\nIf `none` is specified, the IPC resources within the containers of a task are\nprivate, and are not shared with other containers in a task or on the container instance.\nIf no value is specified, then the IPC resource namespace sharing depends on the Docker\ndaemon setting on the container instance. For more information, see [IPC settings](https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in\nthe Docker run 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-ipcmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Volumes": { "MarkdownDocumentation": "`Volumes`\n\nA list of volumes that are associated with the job.\n*Required*: No\n*Type*: Array of [Volume](./aws-properties-batch-jobdefinition-volume.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-volumes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Volume", "DuplicatesAllowed": true }, "EnableExecuteCommand": { "MarkdownDocumentation": "`EnableExecuteCommand`\n\nDetermines whether execute command functionality is turned on for this task. If `true`, execute\ncommand functionality is turned on all the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-enableexecutecommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Containers": { "MarkdownDocumentation": "`Containers`\n\nThis object is a list of containers.\n*Required*: No\n*Type*: Array of [TaskContainerProperties](./aws-properties-batch-jobdefinition-taskcontainerproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-containers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TaskContainerProperties", "DuplicatesAllowed": true }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for jobs that are running on Fargate resources. Jobs that are\nrunning on Amazon EC2 resources must not specify this parameter.\n*Required*: No\n*Type*: [NetworkConfiguration](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NetworkConfiguration" }, "PidMode": { "MarkdownDocumentation": "`PidMode`\n\nThe process namespace to use for the containers in the task. The valid values are\n`host` or `task`. For example, monitoring sidecars might need\n`pidMode` to access information about other containers running in the same\ntask.\nIf `host` is specified, all containers within the tasks that specified the\n`host` PID mode on the same container instance share the process namespace with the\nhost Amazon EC2 instance.\nIf `task` is specified, all containers within the specified task share the same\nprocess namespace.\nIf no value is specified, the default is a private namespace for each container. For more\ninformation, see [PID settings](https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker run 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-pidmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EphemeralStorage": { "MarkdownDocumentation": "`EphemeralStorage`\n\nThe amount of ephemeral storage to allocate for the task. This parameter is used to expand\nthe total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\nAWS Fargate.\n*Required*: No\n*Type*: [EphemeralStorage](./aws-properties-batch-jobdefinition-ephemeralstorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecstaskproperties.html#cfn-batch-jobdefinition-ecstaskproperties-ephemeralstorage", "UpdateType": "Mutable", "Required": false, "Type": "EphemeralStorage" } } }, "AWS::Batch::JobDefinition.EksContainer": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksContainer`\n\nEKS container properties are used in job definitions for Amazon EKS based job definitions to\ndescribe the properties for a container node in the pod that's launched as part of a job. This\ncan't be specified for Amazon ECS based job definitions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html", "Properties": { "Args": { "MarkdownDocumentation": "`Args`\n\nAn array of arguments to the entrypoint. If this isn't specified, the `CMD` of\nthe container image is used. This corresponds to the `args` member in the [Entrypoint](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) portion of the [Pod](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/)\nin Kubernetes. Environment variable references are expanded using the container's environment.\nIf the referenced environment variable doesn't exist, the reference in the command isn't\nchanged. For example, if the reference is to \"`$(NAME1)`\" and the `NAME1`\nenvironment variable doesn't exist, the command string will remain \"`$(NAME1)`.\"\n`$$` is replaced with `$`, and the resulting string isn't expanded. For\nexample, `$$(VAR_NAME)` is passed as `$(VAR_NAME)` whether or not the\n`VAR_NAME` environment variable exists. For more information, see [Dockerfile reference: CMD](https://docs.docker.com/engine/reference/builder/#cmd)\nand [Define a command and arguments for a pod](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-args", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VolumeMounts": { "MarkdownDocumentation": "`VolumeMounts`\n\nThe volume mounts for the container. AWS Batch supports `emptyDir`,\n`hostPath`, and `secret` volume types. For more information about volumes\nand volume mounts in Kubernetes, see [Volumes](https://kubernetes.io/docs/concepts/storage/volumes/) in the *Kubernetes documentation*.\n*Required*: No\n*Type*: Array of [EksContainerVolumeMount](./aws-properties-batch-jobdefinition-ekscontainervolumemount.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-volumemounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EksContainerVolumeMount", "DuplicatesAllowed": true }, "ImagePullPolicy": { "MarkdownDocumentation": "`ImagePullPolicy`\n\nThe image pull policy for the container. Supported values are `Always`,\n`IfNotPresent`, and `Never`. This parameter defaults to\n`IfNotPresent`. However, if the `:latest` tag is specified, it defaults to\n`Always`. For more information, see [Updating\nimages](https://kubernetes.io/docs/concepts/containers/images/#updating-images) in the *Kubernetes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-imagepullpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Command": { "MarkdownDocumentation": "`Command`\n\nThe entrypoint for the container. This isn't run within a shell. If this isn't specified,\nthe `ENTRYPOINT` of the container image is used. Environment variable references are\nexpanded using the container's environment.\nIf the referenced environment variable doesn't exist, the reference in the command isn't\nchanged. For example, if the reference is to \"`$(NAME1)`\" and the `NAME1`\nenvironment variable doesn't exist, the command string will remain \"`$(NAME1)`.\"\n`$$` is replaced with `$` and the resulting string isn't expanded. For\nexample, `$$(VAR_NAME)` will be passed as `$(VAR_NAME)` whether or not the\n`VAR_NAME` environment variable exists. The entrypoint can't be updated. For more\ninformation, see [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) in the *Dockerfile reference* and [Define a command and arguments for a container](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) and [Entrypoint](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) in the *Kubernetes documentation*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-command", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SecurityContext": { "MarkdownDocumentation": "`SecurityContext`\n\nThe security context for a job. For more information, see [Configure a\nsecurity context for a pod or container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: [EksContainerSecurityContext](./aws-properties-batch-jobdefinition-ekscontainersecuritycontext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-securitycontext", "UpdateType": "Mutable", "Required": false, "Type": "EksContainerSecurityContext" }, "Resources": { "MarkdownDocumentation": "`Resources`\n\nThe type and amount of resources to assign to a container. The supported resources include\n`memory`, `cpu`, and `nvidia.com/gpu`. For more information,\nsee [Resource management for pods and containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: [EksContainerResourceRequirements](./aws-properties-batch-jobdefinition-ekscontainerresourcerequirements.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-resources", "UpdateType": "Mutable", "Required": false, "Type": "EksContainerResourceRequirements" }, "Image": { "MarkdownDocumentation": "`Image`\n\nThe Docker image used to start the container.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-image", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Env": { "MarkdownDocumentation": "`Env`\n\nThe environment variables to pass to a container.\n###### Note\nEnvironment variables cannot start with \"`AWS_BATCH`\". This naming\nconvention is reserved for variables that AWS Batch sets.\n*Required*: No\n*Type*: Array of [EksContainerEnvironmentVariable](./aws-properties-batch-jobdefinition-ekscontainerenvironmentvariable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-env", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EksContainerEnvironmentVariable", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the container. If the name isn't specified, the default name\n\"`Default`\" is used. Each container in a pod must have a unique 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainer.html#cfn-batch-jobdefinition-ekscontainer-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EksContainerEnvironmentVariable": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksContainerEnvironmentVariable`\n\nAn environment variable.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainerenvironmentvariable.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainerenvironmentvariable.html#cfn-batch-jobdefinition-ekscontainerenvironmentvariable-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the environment variable.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainerenvironmentvariable.html#cfn-batch-jobdefinition-ekscontainerenvironmentvariable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EksContainerResourceRequirements": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksContainerResourceRequirements`\n\nThe type and amount of resources to assign to a container. The supported resources include\n`memory`, `cpu`, and `nvidia.com/gpu`. For more information,\nsee [Resource management for pods and containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) in the *Kubernetes\ndocumentation*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainerresourcerequirements.html", "Properties": { "Limits": { "MarkdownDocumentation": "`Limits`\n\nThe type and quantity of the resources to reserve for the container. The values vary based\non the `name` that's specified. Resources can be requested using either the\n`limits` or the `requests` objects.\nmemory\nThe memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\"\nsuffix. If your container attempts to exceed the memory specified, the container is\nterminated. You must specify at least 4 MiB of memory for a job. `memory` can be\nspecified in `limits`, `requests`, or both. If `memory` is\nspecified in both places, then the value that's specified in `limits` must be equal\nto the value that's specified in `requests`.\n###### Note\nTo maximize your resource utilization, provide your jobs with as much memory as possible\nfor the specific instance type that you are using. To learn how, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the\n*AWS Batch User Guide*.\n\ncpu\nThe number of CPUs that's reserved for the container. Values must be an even multiple of\n`0.25`. `cpu` can be specified in `limits`,\n`requests`, or both. If `cpu` is specified in both places, then the\nvalue that's specified in `limits` must be at least as large as the value that's\nspecified in `requests`.\n\nnvidia.com/gpu\nThe number of GPUs that's reserved for the container. Values must be a whole integer.\n`memory` can be specified in `limits`, `requests`, or both.\nIf `memory` is specified in both places, then the value that's specified in\n`limits` must be equal to the value that's specified in\n`requests`.\n\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainerresourcerequirements.html#cfn-batch-jobdefinition-ekscontainerresourcerequirements-limits", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Requests": { "MarkdownDocumentation": "`Requests`\n\nThe type and quantity of the resources to request for the container. The values vary based\non the `name` that's specified. Resources can be requested by using either the\n`limits` or the `requests` objects.\nmemory\nThe memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\"\nsuffix. If your container attempts to exceed the memory specified, the container is\nterminated. You must specify at least 4 MiB of memory for a job. `memory` can be\nspecified in `limits`, `requests`, or both. If `memory` is\nspecified in both, then the value that's specified in `limits` must be equal to the\nvalue that's specified in `requests`.\n###### Note\nIf you're trying to maximize your resource utilization by providing your jobs as much\nmemory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the\n*AWS Batch User Guide*.\n\ncpu\nThe number of CPUs that are reserved for the container. Values must be an even multiple\nof `0.25`. `cpu` can be specified in `limits`,\n`requests`, or both. If `cpu` is specified in both, then the value\nthat's specified in `limits` must be at least as large as the value that's\nspecified in `requests`.\n\nnvidia.com/gpu\nThe number of GPUs that are reserved for the container. Values must be a whole integer.\n`nvidia.com/gpu` can be specified in `limits`, `requests`,\nor both. If `nvidia.com/gpu` is specified in both, then the value that's specified\nin `limits` must be equal to the value that's specified in\n`requests`.\n\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainerresourcerequirements.html#cfn-batch-jobdefinition-ekscontainerresourcerequirements-requests", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::Batch::JobDefinition.EksContainerSecurityContext": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksContainerSecurityContext`\n\nThe security context for a job. For more information, see [Configure a\nsecurity context for a pod or container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) in the *Kubernetes\ndocumentation*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainersecuritycontext.html", "Properties": { "RunAsUser": { "MarkdownDocumentation": "`RunAsUser`\n\nWhen this parameter is specified, the container is run as the specified user ID\n(`uid`). If this parameter isn't specified, the default is the user that's specified\nin the image metadata. This parameter maps to `RunAsUser` and `MustRanAs`\npolicy in the [Users\nand groups pod security policies](https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainersecuritycontext.html#cfn-batch-jobdefinition-ekscontainersecuritycontext-runasuser", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AllowPrivilegeEscalation": { "MarkdownDocumentation": "`AllowPrivilegeEscalation`\n\nWhether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent\nprocess. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainersecuritycontext.html#cfn-batch-jobdefinition-ekscontainersecuritycontext-allowprivilegeescalation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RunAsNonRoot": { "MarkdownDocumentation": "`RunAsNonRoot`\n\nWhen this parameter is specified, the container is run as a user with a `uid`\nother than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to\n`RunAsUser` and `MustRunAsNonRoot` policy in the [Users\nand groups pod security policies](https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainersecuritycontext.html#cfn-batch-jobdefinition-ekscontainersecuritycontext-runasnonroot", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Privileged": { "MarkdownDocumentation": "`Privileged`\n\nWhen this parameter is `true`, the container is given elevated permissions on the\nhost container instance. The level of permissions are similar to the `root` user\npermissions. The default value is `false`. This parameter maps to\n`privileged` policy in the [Privileged\npod security policies](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privileged) in the *Kubernetes documentation*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainersecuritycontext.html#cfn-batch-jobdefinition-ekscontainersecuritycontext-privileged", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ReadOnlyRootFilesystem": { "MarkdownDocumentation": "`ReadOnlyRootFilesystem`\n\nWhen this parameter is `true`, the container is given read-only access to its\nroot file system. The default value is `false`. This parameter maps to\n`ReadOnlyRootFilesystem` policy in the [Volumes and file systems pod security policies](https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainersecuritycontext.html#cfn-batch-jobdefinition-ekscontainersecuritycontext-readonlyrootfilesystem", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RunAsGroup": { "MarkdownDocumentation": "`RunAsGroup`\n\nWhen this parameter is specified, the container is run as the specified group ID\n(`gid`). If this parameter isn't specified, the default is the group that's specified\nin the image metadata. This parameter maps to `RunAsGroup` and `MustRunAs`\npolicy in the [Users\nand groups pod security policies](https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainersecuritycontext.html#cfn-batch-jobdefinition-ekscontainersecuritycontext-runasgroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Batch::JobDefinition.EksContainerVolumeMount": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksContainerVolumeMount`\n\nThe volume mounts for a container for an Amazon EKS job. For more information about volumes and\nvolume mounts in Kubernetes, see [Volumes](https://kubernetes.io/docs/concepts/storage/volumes/) in the *Kubernetes documentation*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html", "Properties": { "MountPath": { "MarkdownDocumentation": "`MountPath`\n\nThe path on the container where the volume is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html#cfn-batch-jobdefinition-ekscontainervolumemount-mountpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReadOnly": { "MarkdownDocumentation": "`ReadOnly`\n\nIf this value is `true`, the container has read-only access to the volume.\nOtherwise, the container can write to the volume. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html#cfn-batch-jobdefinition-ekscontainervolumemount-readonly", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SubPath": { "MarkdownDocumentation": "`SubPath`\n\nA sub-path inside the referenced volume instead of its root.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html#cfn-batch-jobdefinition-ekscontainervolumemount-subpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name the volume mount. This must match the name of one of the volumes in the\npod.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html#cfn-batch-jobdefinition-ekscontainervolumemount-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EksEmptyDir": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksEmptyDir`\n\nSpecifies the configuration of a Kubernetes `emptyDir` volume. An\n`emptyDir` volume is first created when a pod is assigned to a node. It exists as\nlong as that pod is running on that node. The `emptyDir` volume is initially empty.\nAll containers in the pod can read and write the files in the `emptyDir` volume.\nHowever, the `emptyDir` volume can be mounted at the same or different paths in each\ncontainer. When a pod is removed from a node for any reason, the data in the\n`emptyDir` is deleted permanently. For more information, see [emptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) in the\n*Kubernetes documentation*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksemptydir.html", "Properties": { "Medium": { "MarkdownDocumentation": "`Medium`\n\nThe medium to store the volume. The default value is an empty string, which uses the storage\nof the node.\n\"\"\n**(Default)** Use the disk storage of the node.\n\n\"Memory\"\nUse the `tmpfs` volume that's backed by the RAM of the node. Contents of the\nvolume are lost when the node reboots, and any storage on the volume counts against the\ncontainer's memory limit.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksemptydir.html#cfn-batch-jobdefinition-eksemptydir-medium", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SizeLimit": { "MarkdownDocumentation": "`SizeLimit`\n\nThe maximum size of the volume. By default, there's no maximum size defined.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksemptydir.html#cfn-batch-jobdefinition-eksemptydir-sizelimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EksHostPath": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksHostPath`\n\nSpecifies the configuration of a Kubernetes `hostPath` volume. A `hostPath`\nvolume mounts an existing file or directory from the host node's filesystem into your pod. For\nmore information, see [hostPath](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) in the *Kubernetes documentation*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekshostpath.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe path of the file or directory on the host to mount into containers on the pod.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekshostpath.html#cfn-batch-jobdefinition-ekshostpath-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EksMetadata": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksMetadata`\n\nDescribes and uniquely identifies Kubernetes resources. For example, the compute environment that\na pod runs in or the `jobID` for a job running in the pod. For more information, see\n[Understanding Kubernetes Objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) in the *Kubernetes documentation*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksmetadata.html", "Properties": { "Annotations": { "MarkdownDocumentation": "`Annotations`\n\nKey-value pairs used to attach arbitrary, non-identifying metadata to Kubernetes objects.\nValid annotation keys have two segments: an optional prefix and a name, separated by a\nslash (/).\n* The prefix is optional and must be 253 characters or less. If specified, the prefix\n must be a DNS subdomain\u2212 a series of DNS labels separated by dots (.), and it must\n end with a slash (/).\n* The name segment is required and must be 63 characters or less. It can include alphanumeric\n characters ([a-z0-9A-Z]), dashes (-), underscores (\\_), and dots (.), but must begin and end\n with an alphanumeric character.\n###### Note\nAnnotation values must be 255 characters or less.\nAnnotations can be added or modified at any time. Each resource can have multiple annotations.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksmetadata.html#cfn-batch-jobdefinition-eksmetadata-annotations", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Labels": { "MarkdownDocumentation": "`Labels`\n\nKey-value pairs used to identify, sort, and organize cube resources. Can contain up to 63\nuppercase letters, lowercase letters, numbers, hyphens (-), and underscores (\\_). Labels can be\nadded or modified at any time. Each resource can have multiple labels, but each key must be\nunique for a given object.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksmetadata.html#cfn-batch-jobdefinition-eksmetadata-labels", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the Amazon EKS cluster. In Kubernetes, namespaces provide a mechanism for isolating\ngroups of resources within a single cluster. Names of resources need to be unique within a namespace,\nbut not across namespaces. AWS Batch places Batch Job pods in this namespace. If this field is provided,\nthe value can't be empty or null. It must meet the following requirements:\n* 1-63 characters long\n* Can't be set to default\n* Can't start with `kube`\n* Must match the following regular expression:\n `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`\nFor more information, see\n[Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) in the *Kubernetes documentation*. This namespace can be\ndifferent from the `kubernetesNamespace` set in the compute environment's\n`EksConfiguration`, but must have identical role-based access control (RBAC) roles as\nthe compute environment's `kubernetesNamespace`. For multi-node parallel jobs,\nthe same value must be provided across all the node ranges.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksmetadata.html#cfn-batch-jobdefinition-eksmetadata-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EksPersistentVolumeClaim": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksPersistentVolumeClaim`\n\nA `persistentVolumeClaim` volume is used to mount a [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)\ninto a Pod. PersistentVolumeClaims are a way for users to \"claim\" durable storage without knowing\nthe details of the particular cloud environment. See the information about [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)\nin the *Kubernetes documentation*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspersistentvolumeclaim.html", "Properties": { "ReadOnly": { "MarkdownDocumentation": "`ReadOnly`\n\nAn optional boolean value indicating if the mount is read only. Default is false. For more\ninformation, see [Read Only Mounts](https://kubernetes.io/docs/concepts/storage/volumes/#read-only-mounts) in the *Kubernetes documentation*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspersistentvolumeclaim.html#cfn-batch-jobdefinition-ekspersistentvolumeclaim-readonly", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ClaimName": { "MarkdownDocumentation": "`ClaimName`\n\nThe name of the `persistentVolumeClaim` bounded to a `persistentVolume`.\nFor more information, see [Persistent Volume Claims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) in the *Kubernetes documentation*.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspersistentvolumeclaim.html#cfn-batch-jobdefinition-ekspersistentvolumeclaim-claimname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EksPodProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksPodProperties`\n\nThe properties for the pod.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html", "Properties": { "InitContainers": { "MarkdownDocumentation": "`InitContainers`\n\nThese containers run before application containers, always runs to completion, and must\ncomplete successfully before the next container starts. These containers are registered with the\nAmazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.\nFor more information, see [Init\nContainers](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) in the *Kubernetes documentation*.\n###### Note\nThis object is limited to 10 elements.\n*Required*: No\n*Type*: Array of [EksContainer](./aws-properties-batch-jobdefinition-ekscontainer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-initcontainers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EksContainer", "DuplicatesAllowed": true }, "Volumes": { "MarkdownDocumentation": "`Volumes`\n\nSpecifies the volumes for a job definition that uses Amazon EKS resources.\n*Required*: No\n*Type*: Array of [EksVolume](./aws-properties-batch-jobdefinition-eksvolume.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-volumes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EksVolume", "DuplicatesAllowed": true }, "DnsPolicy": { "MarkdownDocumentation": "`DnsPolicy`\n\nThe DNS policy for the pod. The default value is `ClusterFirst`. If the\n`hostNetwork` parameter is not specified, the default is\n`ClusterFirstWithHostNet`. `ClusterFirst` indicates that any DNS query\nthat does not match the configured cluster domain suffix is forwarded to the upstream nameserver\ninherited from the node. For more information, see [Pod's DNS policy](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) in the *Kubernetes documentation*.\nValid values: `Default` | `ClusterFirst` |\n`ClusterFirstWithHostNet`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-dnspolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Containers": { "MarkdownDocumentation": "`Containers`\n\nThe properties of the container that's used on the Amazon EKS pod.\n###### Note\nThis object is limited to 10 elements.\n*Required*: No\n*Type*: Array of [EksContainer](./aws-properties-batch-jobdefinition-ekscontainer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-containers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EksContainer", "DuplicatesAllowed": true }, "Metadata": { "MarkdownDocumentation": "`Metadata`\n\nMetadata about the Kubernetes pod. For more information, see [Understanding Kubernetes Objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: [EksMetadata](./aws-properties-batch-jobdefinition-eksmetadata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-metadata", "UpdateType": "Mutable", "Required": false, "Type": "EksMetadata" }, "ServiceAccountName": { "MarkdownDocumentation": "`ServiceAccountName`\n\nThe name of the service account that's used to run the pod. For more information, see\n[Kubernetes service\naccounts](https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html) and [Configure a Kubernetes service account\nto assume an IAM role](https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) in the *Amazon EKS User Guide* and [Configure service accounts for pods](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) in the *Kubernetes\ndocumentation*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-serviceaccountname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImagePullSecrets": { "MarkdownDocumentation": "`ImagePullSecrets`\n\nReferences a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain\naccess to pull an images from a private registry.\n`ImagePullSecret$name` is required when this object is used.\n*Required*: No\n*Type*: Array of [ImagePullSecret](./aws-properties-batch-jobdefinition-imagepullsecret.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-imagepullsecrets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ImagePullSecret", "DuplicatesAllowed": true }, "HostNetwork": { "MarkdownDocumentation": "`HostNetwork`\n\nIndicates if the pod uses the hosts' network IP address. The default value is\n`true`. Setting this to `false` enables the Kubernetes pod networking model.\nMost AWS Batch workloads are egress-only and don't require the overhead of IP allocation for each\npod for incoming connections. For more information, see [Host\nnamespaces](https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces) and [Pod networking](https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking)\nin the *Kubernetes documentation*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-hostnetwork", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ShareProcessNamespace": { "MarkdownDocumentation": "`ShareProcessNamespace`\n\nIndicates if the processes in a container are shared, or visible, to other containers in the\nsame pod. For more information, see [Share\nProcess Namespace between Containers in a Pod](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/).\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekspodproperties.html#cfn-batch-jobdefinition-ekspodproperties-shareprocessnamespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Batch::JobDefinition.EksProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksProperties`\n\nAn object that contains the properties for the Kubernetes resources of a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksproperties.html", "Properties": { "PodProperties": { "MarkdownDocumentation": "`PodProperties`\n\nThe properties for the Kubernetes pod resources of a job.\n*Required*: No\n*Type*: [EksPodProperties](./aws-properties-batch-jobdefinition-ekspodproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksproperties.html#cfn-batch-jobdefinition-eksproperties-podproperties", "UpdateType": "Mutable", "Required": false, "Type": "EksPodProperties" } } }, "AWS::Batch::JobDefinition.EksSecret": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksSecret`\n\nSpecifies the configuration of a Kubernetes `secret` volume. For more information, see\n[secret](https://kubernetes.io/docs/concepts/storage/volumes/#secret) in the\n*Kubernetes documentation*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekssecret.html", "Properties": { "SecretName": { "MarkdownDocumentation": "`SecretName`\n\nThe name of the secret. The name must be allowed as a DNS subdomain name. For more\ninformation, see [DNS subdomain names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) in the *Kubernetes documentation*.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekssecret.html#cfn-batch-jobdefinition-ekssecret-secretname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Optional": { "MarkdownDocumentation": "`Optional`\n\nSpecifies whether the secret or the secret's keys must be defined.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekssecret.html#cfn-batch-jobdefinition-ekssecret-optional", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Batch::JobDefinition.EksVolume": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EksVolume`\n\nSpecifies an Amazon EKS volume for a job definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksvolume.html", "Properties": { "Secret": { "MarkdownDocumentation": "`Secret`\n\nSpecifies the configuration of a Kubernetes `secret` volume. For more information, see\n[secret](https://kubernetes.io/docs/concepts/storage/volumes/#secret) in the\n*Kubernetes documentation*.\n*Required*: No\n*Type*: [EksSecret](./aws-properties-batch-jobdefinition-ekssecret.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksvolume.html#cfn-batch-jobdefinition-eksvolume-secret", "UpdateType": "Mutable", "Required": false, "Type": "EksSecret" }, "EmptyDir": { "MarkdownDocumentation": "`EmptyDir`\n\nSpecifies the configuration of a Kubernetes `emptyDir` volume. For more information,\nsee [emptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir)\nin the *Kubernetes documentation*.\n*Required*: No\n*Type*: [EksEmptyDir](./aws-properties-batch-jobdefinition-eksemptydir.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksvolume.html#cfn-batch-jobdefinition-eksvolume-emptydir", "UpdateType": "Mutable", "Required": false, "Type": "EksEmptyDir" }, "HostPath": { "MarkdownDocumentation": "`HostPath`\n\nSpecifies the configuration of a Kubernetes `hostPath` volume. For more information,\nsee [hostPath](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath)\nin the *Kubernetes documentation*.\n*Required*: No\n*Type*: [EksHostPath](./aws-properties-batch-jobdefinition-ekshostpath.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksvolume.html#cfn-batch-jobdefinition-eksvolume-hostpath", "UpdateType": "Mutable", "Required": false, "Type": "EksHostPath" }, "PersistentVolumeClaim": { "MarkdownDocumentation": "`PersistentVolumeClaim`\n\nSpecifies the configuration of a Kubernetes `persistentVolumeClaim` bounded to a\n`persistentVolume`. For more information, see [Persistent Volume Claims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) in the *Kubernetes documentation*.\n*Required*: No\n*Type*: [EksPersistentVolumeClaim](./aws-properties-batch-jobdefinition-ekspersistentvolumeclaim.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksvolume.html#cfn-batch-jobdefinition-eksvolume-persistentvolumeclaim", "UpdateType": "Mutable", "Required": false, "Type": "EksPersistentVolumeClaim" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the volume. The name must be allowed as a DNS subdomain name. For more\ninformation, see [DNS subdomain names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) in the *Kubernetes documentation*.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-eksvolume.html#cfn-batch-jobdefinition-eksvolume-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.Environment": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.Environment`\n\nThe Environment property type specifies environment variables to use in a job\ndefinition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.EphemeralStorage": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EphemeralStorage`\n\nThe amount of ephemeral storage to allocate for the task. This parameter is used to expand\nthe total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\nAWS Fargate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ephemeralstorage.html", "Properties": { "SizeInGiB": { "MarkdownDocumentation": "`SizeInGiB`\n\nThe total amount, in GiB, of ephemeral storage to set for the task. The minimum supported\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ephemeralstorage.html#cfn-batch-jobdefinition-ephemeralstorage-sizeingib", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Batch::JobDefinition.EvaluateOnExit": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.EvaluateOnExit`\n\nSpecifies an array of up to 5 conditions to be met, and an action to take\n(`RETRY` or `EXIT`) if all conditions are met. If none of the\n`EvaluateOnExit` conditions in a `RetryStrategy` match, then the job is\nretried.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nSpecifies the action to take if all of the specified conditions\n(`onStatusReason`, `onReason`, and `onExitCode`) are met. The\nvalues aren't case sensitive.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RETRY | EXIT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RETRY", "EXIT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OnExitCode": { "MarkdownDocumentation": "`OnExitCode`\n\nContains a glob pattern to match against the decimal representation of the\n`ExitCode` returned for a job. The pattern can be up to 512 characters long. It can\ncontain only numbers, and can end with an asterisk (\\*) so that only the start of the string needs\nto be an exact match.\nThe string can contain up to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onexitcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OnReason": { "MarkdownDocumentation": "`OnReason`\n\nContains a glob pattern to match against the `Reason` returned for a job. The\npattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons\n(:), and white space (including spaces and tabs). It can optionally end with an asterisk (\\*) so\nthat only the start of the string needs to be an exact 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onreason", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OnStatusReason": { "MarkdownDocumentation": "`OnStatusReason`\n\nContains a glob pattern to match against the `StatusReason` returned for a job.\nThe pattern can contain up to 512 characters. It can contain letters, numbers, periods (.),\ncolons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (\\*)\nso that only the start of the string needs to be an exact 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onstatusreason", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.FargatePlatformConfiguration": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.FargatePlatformConfiguration`\n\nThe platform configuration for jobs that are running on Fargate resources. Jobs that run\non Amazon EC2 resources must not specify this parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-fargateplatformconfiguration.html", "Properties": { "PlatformVersion": { "MarkdownDocumentation": "`PlatformVersion`\n\nThe AWS Fargate platform version where the jobs are running. A platform version is\nspecified only for jobs that are running on Fargate resources. If one isn't specified, the\n`LATEST` platform version is used by default. This uses a recent, approved version of\nthe AWS Fargate platform for compute resources. For more information, see [AWS Fargate\nplatform 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-fargateplatformconfiguration.html#cfn-batch-jobdefinition-fargateplatformconfiguration-platformversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.FirelensConfiguration": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.FirelensConfiguration`\n\nThe FireLens configuration for the container. This is used to specify and configure a\nlog router for container logs. For more information, see [Custom log](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) routing in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-firelensconfiguration.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nThe options to use when configuring the log router. This field is optional and can be\nused to specify a custom configuration file or to add additional metadata, such as the\ntask, task definition, cluster, and container instance details to the log event. If\nspecified, the syntax to use is\n`\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}`.\nFor more information, see [Creating a task definition that uses a FireLens configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef)\nin the *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-firelensconfiguration.html#cfn-batch-jobdefinition-firelensconfiguration-options", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe log router to use. The valid values are `fluentd` or `fluentbit`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `fluentd | fluentbit...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "fluentd", "fluentbit" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-firelensconfiguration.html#cfn-batch-jobdefinition-firelensconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.Host": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.Host`\n\nDetermine whether your data volume persists on the host container instance and where it's\nstored. If this parameter is empty, then the Docker daemon assigns a host path for your data\nvolume. However, the data isn't guaranteed to persist after the containers that are associated\nwith it stop running.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-host.html", "Properties": { "SourcePath": { "MarkdownDocumentation": "`SourcePath`\n\nThe path on the host container instance that's presented to the container. If this parameter\nis empty, then the Docker daemon has assigned a host path for you. If this parameter contains a\nfile location, then the data volume persists at the specified location on the host container\ninstance until you delete it manually. If the source path location doesn't exist on the host\ncontainer instance, the Docker daemon creates it. If the location does exist, the contents of the\nsource path folder are exported.\n###### Note\nThis parameter isn't applicable to jobs that run on Fargate resources. Don't provide this\nfor these 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-host.html#cfn-batch-jobdefinition-host-sourcepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.ImagePullSecret": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.ImagePullSecret`\n\nReferences a Kubernetes secret resource. This name of the secret must start and end with an\nalphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and\ncan't contain more than 253 characters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-imagepullsecret.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nProvides a unique identifier for the `ImagePullSecret`. This object is required\nwhen `EksPodProperties$imagePullSecrets` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-imagepullsecret.html#cfn-batch-jobdefinition-imagepullsecret-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.JobTimeout": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.JobTimeout`\n\nAn object that represents a job timeout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-jobtimeout.html", "Properties": { "AttemptDurationSeconds": { "MarkdownDocumentation": "`AttemptDurationSeconds`\n\nThe job timeout time (in seconds) that's measured from the job attempt's\n`startedAt` timestamp. After this time passes, AWS Batch terminates your jobs if they\naren't finished. The minimum value for the timeout is 60 seconds.\nFor array jobs, the timeout applies to the child jobs, not to the parent array job.\nFor multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the\nindividual nodes.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-jobtimeout.html#cfn-batch-jobdefinition-jobtimeout-attemptdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Batch::JobDefinition.LinuxParameters": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.LinuxParameters`\n\nLinux-specific modifications that are applied to the container, such as details for device\nmappings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html", "Properties": { "Swappiness": { "MarkdownDocumentation": "`Swappiness`\n\nYou can use this parameter to tune a container's memory swappiness behavior. A\n`swappiness` value of `0` causes swapping to not occur unless absolutely\nnecessary. A `swappiness` value of `100` causes pages to be swapped\naggressively. Valid values are whole numbers between `0` and `100`. If the\n`swappiness` parameter isn't specified, a default value of `60` is used.\nIf a value isn't specified for `maxSwap`, then this parameter is ignored. If\n`maxSwap` is set to 0, the container doesn't use swap. This parameter maps to the\n`--memory-swappiness` option to [docker\nrun](https://docs.docker.com/engine/reference/run/).\nConsider the following when you use a per-container swap configuration.\n* Swap space must be enabled and allocated on the container instance for the containers to\n use.\n \n ###### Note\n \n By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the\n instance to use this feature. For more information, see [Instance store swap\n volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html) in the *Amazon EC2 User Guide for Linux Instances* or [How do I\n allocate memory to work as swap space in an Amazon EC2 instance by using a swap\n file?](https://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/)\n* The swap space parameters are only supported for job definitions using EC2\n resources.\n* If the `maxSwap` and `swappiness` parameters are omitted from a job\n definition, each container has a default `swappiness` value of 60. Moreover, the\n total swap usage is limited to two times the memory reservation of the container.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't\nprovide it for these jobs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-swappiness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tmpfs": { "MarkdownDocumentation": "`Tmpfs`\n\nThe container path, mount options, and size (in MiB) of the `tmpfs` mount. This\nparameter maps to the `--tmpfs` option to [docker\nrun](https://docs.docker.com/engine/reference/run/).\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't\nprovide this parameter for this resource type.\n*Required*: No\n*Type*: [Array](./aws-properties-batch-jobdefinition-tmpfs.html) of [Tmpfs](./aws-properties-batch-jobdefinition-tmpfs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-tmpfs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tmpfs", "DuplicatesAllowed": true }, "SharedMemorySize": { "MarkdownDocumentation": "`SharedMemorySize`\n\nThe value for the size (in MiB) of the `/dev/shm` volume. This parameter maps to\nthe `--shm-size` option to [docker\nrun](https://docs.docker.com/engine/reference/run/).\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't\nprovide it for these jobs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-sharedmemorysize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Devices": { "MarkdownDocumentation": "`Devices`\n\nAny of the host devices to expose to the container. This parameter maps to\n`Devices` 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/)\nand the `--device` option to [docker\nrun](https://docs.docker.com/engine/reference/run/).\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't\nprovide it for these jobs.\n*Required*: No\n*Type*: Array of [Device](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-devices", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Device", "DuplicatesAllowed": true }, "InitProcessEnabled": { "MarkdownDocumentation": "`InitProcessEnabled`\n\nIf true, run an `init` process inside the container that forwards signals and\nreaps processes. This parameter maps to the `--init` option to [docker run](https://docs.docker.com/engine/reference/run/). This parameter requires version 1.25 of the Docker Remote API or greater on your\ncontainer instance. To check the Docker Remote API version on your container instance, log in to your\ncontainer instance and run the following command: `sudo docker version | grep \"Server API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-initprocessenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxSwap": { "MarkdownDocumentation": "`MaxSwap`\n\nThe total amount of swap memory (in MiB) a container can use. This parameter is translated\nto the `--memory-swap` option to [docker\nrun](https://docs.docker.com/engine/reference/run/) where the value is the sum of the container memory plus the `maxSwap`\nvalue. For more information, see [`--memory-swap` details](https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details) in the Docker documentation.\nIf a `maxSwap` value of `0` is specified, the container doesn't use\nswap. Accepted values are `0` or any positive integer. If the `maxSwap`\nparameter is omitted, the container doesn't use the swap configuration for the container instance\non which it runs. A `maxSwap` value must be set for the `swappiness`\nparameter to be used.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't\nprovide it for these jobs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-maxswap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Batch::JobDefinition.LogConfiguration": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.LogConfiguration`\n\nLog configuration options to send to a custom log driver for the container.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-logconfiguration.html", "Properties": { "SecretOptions": { "MarkdownDocumentation": "`SecretOptions`\n\nThe secrets to pass to the log configuration. For more information, see [Specifying sensitive\ndata](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide*.\n*Required*: No\n*Type*: Array of [Secret](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-logconfiguration.html#cfn-batch-jobdefinition-logconfiguration-secretoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Secret", "DuplicatesAllowed": true }, "Options": { "MarkdownDocumentation": "`Options`\n\nThe configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your\ncontainer instance. To check the Docker Remote API version on your container instance, log in to your\ncontainer instance and run the following command: `sudo docker version | grep \"Server API version\"`\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-logconfiguration.html#cfn-batch-jobdefinition-logconfiguration-options", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "LogDriver": { "MarkdownDocumentation": "`LogDriver`\n\nThe log driver to use for the container. The valid values that are listed for this parameter\nare log drivers that the Amazon ECS container agent can communicate with by default.\nThe supported log drivers are `awsfirelens`, `awslogs`, `fluentd`, `gelf`,\n`json-file`, `journald`, `logentries`, `syslog`, and\n`splunk`.\n###### Note\nJobs that are running on Fargate resources are restricted to the `awslogs` and\n`splunk` log drivers.\n\nawsfirelens\nSpecifies the firelens logging driver. For more information on configuring Firelens, see\n[Send\nAmazon ECS logs to an AWS service or AWS Partner](https://docs.aws.amazon.com//AmazonECS/latest/developerguide/using_firelens.html) in the\n*Amazon Elastic Container Service Developer Guide*.\n\nawslogs\nSpecifies the Amazon CloudWatch Logs logging driver. For more information, see [Using the awslogs log driver](https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html)\nin the *AWS Batch User Guide* and [Amazon CloudWatch Logs logging\ndriver](https://docs.docker.com/config/containers/logging/awslogs/) in the Docker documentation.\n\nfluentd\nSpecifies the Fluentd logging driver. For more information including usage and options,\nsee [Fluentd logging\ndriver](https://docs.docker.com/config/containers/logging/fluentd/) in the *Docker documentation*.\n\ngelf\nSpecifies the Graylog Extended Format (GELF) logging driver. For more information\nincluding usage and options, see [Graylog Extended Format logging\ndriver](https://docs.docker.com/config/containers/logging/gelf/) in the *Docker documentation*.\n\njournald\nSpecifies the journald logging driver. For more information including usage and options,\nsee [Journald logging\ndriver](https://docs.docker.com/config/containers/logging/journald/) in the *Docker documentation*.\n\njson-file\nSpecifies the JSON file logging driver. For more information including usage and options,\nsee [JSON File\nlogging driver](https://docs.docker.com/config/containers/logging/json-file/) in the *Docker documentation*.\n\nsplunk\nSpecifies the Splunk logging driver. For more information including usage and options,\nsee [Splunk logging\ndriver](https://docs.docker.com/config/containers/logging/splunk/) in the *Docker documentation*.\n\nsyslog\nSpecifies the syslog logging driver. For more information including usage and options,\nsee [Syslog logging\ndriver](https://docs.docker.com/config/containers/logging/syslog/) in the *Docker documentation*.\n\n###### Note\nIf you have a custom driver that's not listed earlier that you want to work with the Amazon ECS\ncontainer agent, 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\nwork with that driver. We encourage you to submit pull requests for changes that you want to\nhave included. However, Amazon Web Services doesn't currently support running modified copies of this\nsoftware.\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\ncontainer instance. To check the Docker Remote API version on your container instance, log in to your\ncontainer instance and run the following command: `sudo docker version | grep \"Server API version\"`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `json-file | syslog | journa...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-logconfiguration.html#cfn-batch-jobdefinition-logconfiguration-logdriver", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.MountPoint": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.MountPoint`\n\nDetails for a Docker volume mount point that's used in a job's container properties. This\nparameter maps to `Volumes` in the [Create a\ncontainer](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate) section of the *Docker Remote API* and the\n`--volume` option to docker run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoint.html", "Properties": { "ReadOnly": { "MarkdownDocumentation": "`ReadOnly`\n\nIf this value is `true`, the container has read-only access to the volume.\nOtherwise, the container can write to the volume. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoint.html#cfn-batch-jobdefinition-mountpoint-readonly", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SourceVolume": { "MarkdownDocumentation": "`SourceVolume`\n\nThe name of the volume to mount.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoint.html#cfn-batch-jobdefinition-mountpoint-sourcevolume", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContainerPath": { "MarkdownDocumentation": "`ContainerPath`\n\nThe path on the container where the host volume is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoint.html#cfn-batch-jobdefinition-mountpoint-containerpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.MultiNodeContainerProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.MultiNodeContainerProperties`\n\nContainer properties are used for Amazon ECS based job definitions. These properties to describe the\ncontainer that's launched as part of a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html", "Properties": { "RepositoryCredentials": { "MarkdownDocumentation": "`RepositoryCredentials`\n\nThe private repository authentication credentials to use.\n*Required*: No\n*Type*: [RepositoryCredentials](./aws-properties-batch-jobdefinition-repositorycredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-repositorycredentials", "UpdateType": "Mutable", "Required": false, "Type": "RepositoryCredentials" }, "User": { "MarkdownDocumentation": "`User`\n\nThe user name to use inside the container. This parameter maps to `User` in the\n[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 `--user`\noption to [docker run](https://docs.docker.com/engine/reference/run/).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-user", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Secrets": { "MarkdownDocumentation": "`Secrets`\n\nThe secrets for the container. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the\n*AWS Batch User Guide*.\n*Required*: No\n*Type*: Array of [Secret](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-secrets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Secret", "DuplicatesAllowed": true }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThis parameter is deprecated, use `resourceRequirements` to specify the memory\nrequirements for the job definition. It's not supported for jobs running on Fargate resources.\nFor jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a\ncontainer. If your container attempts to exceed the specified number, it's terminated. You must\nspecify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be\nspecified in several places. It must be specified for each node at least once.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-memory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Privileged": { "MarkdownDocumentation": "`Privileged`\n\nWhen this parameter is true, the container is given elevated permissions on the host\ncontainer instance (similar to the `root` user). This parameter maps to\n`Privileged` in the [Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the\n[Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--privileged` option to [docker run](https://docs.docker.com/engine/reference/run/). The default value is false.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources and\nshouldn't be provided, or specified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-privileged", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableExecuteCommand": { "MarkdownDocumentation": "`EnableExecuteCommand`\n\nDetermines whether execute command functionality is turned on for this task. If `true`, execute\ncommand functionality is turned on all the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-enableexecutecommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LinuxParameters": { "MarkdownDocumentation": "`LinuxParameters`\n\nLinux-specific modifications that are applied to the container, such as details for device\nmappings.\n*Required*: No\n*Type*: [LinuxParameters](./aws-properties-batch-jobdefinition-linuxparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-linuxparameters", "UpdateType": "Mutable", "Required": false, "Type": "LinuxParameters" }, "JobRoleArn": { "MarkdownDocumentation": "`JobRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more\ninformation, see [IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-jobrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReadonlyRootFilesystem": { "MarkdownDocumentation": "`ReadonlyRootFilesystem`\n\nWhen this parameter is true, the container is given read-only access to its root file\nsystem. This parameter maps to `ReadonlyRootfs` in the\n[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\n`--read-only` option to `docker 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-readonlyrootfilesystem", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Vcpus": { "MarkdownDocumentation": "`Vcpus`\n\nThis parameter is deprecated, use `resourceRequirements` to specify the vCPU\nrequirements for the job definition. It's not supported for jobs running on Fargate resources.\nFor jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the\njob.\nEach vCPU is equivalent to 1,024 CPU shares. This parameter maps to `CpuShares`\nin 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\n`--cpu-shares` option to [docker run](https://docs.docker.com/engine/reference/run/). The\nnumber of vCPUs must be specified but can be specified in several places. You must specify it at\nleast once for each node.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-vcpus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Image": { "MarkdownDocumentation": "`Image`\n\nRequired. The image used to start a container. This string is passed directly to the\nDocker daemon. Images in the Docker Hub registry are available by default. Other repositories are\nspecified with\n`repository-url/image:tag`.\nIt can be 255 characters long. It can contain uppercase and lowercase letters, numbers,\nhyphens (-), underscores (\\_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to `Image` in the\n[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 `IMAGE`\nparameter of [docker run](https://docs.docker.com/engine/reference/run/).\n###### Note\nDocker image architecture must match the processor architecture of the compute resources\nthat they're scheduled on. For example, ARM-based Docker images can only run on ARM-based\ncompute resources.\n\n* Images in Amazon ECR Public repositories use the full `registry/repository[:tag]` or\n `registry/repository[@digest]` naming conventions. For example,\n `public.ecr.aws/registry_alias/my-web-app:latest`.\n* Images in Amazon ECR repositories use the full registry and repository URI (for example,\n `123456789012.dkr.ecr..amazonaws.com/`).\n* Images in official repositories on Docker Hub use a single name (for example,\n `ubuntu` or `mongo`).\n* Images in other repositories on Docker Hub are qualified with an organization name (for\n example, `amazon/amazon-ecs-agent`).\n* Images in other online repositories are qualified further by a domain name (for example,\n `quay.io/assemblyline/ubuntu`).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-image", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceRequirements": { "MarkdownDocumentation": "`ResourceRequirements`\n\nThe type and amount of resources to assign to a container. The supported resources include\n`GPU`, `MEMORY`, and `VCPU`.\n*Required*: No\n*Type*: Array of [ResourceRequirement](./aws-properties-batch-jobdefinition-resourcerequirement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-resourcerequirements", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceRequirement", "DuplicatesAllowed": true }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe log configuration specification for the container.\nThis parameter maps to `LogConfig` in the [Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container)\nsection of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--log-driver` option to [docker run](https://docs.docker.com/engine/reference/run/). By default, containers use the same logging\ndriver that the Docker daemon uses. However the container might use a different logging driver\nthan the Docker daemon by specifying a log driver with this parameter in the container\ndefinition. To use a different logging driver for a container, the log system must be configured\nproperly on the container instance (or on a different log server for remote logging options). For\nmore information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/)\nin the Docker documentation.\n###### Note\nAWS Batch currently supports a subset of the logging drivers available to the Docker daemon\n(shown in the [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html) data type).\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\ncontainer instance. To check the Docker Remote API version on your container instance, log in to your\ncontainer instance and run the following command: `sudo docker version | grep \"Server API version\"`\n###### Note\nThe Amazon ECS container agent running on a container instance must register the logging drivers\navailable on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment\nvariable before containers placed on that instance can use these log configuration options. For\nmore information, see [Amazon ECS container agent\nconfiguration](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](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogConfiguration" }, "MountPoints": { "MarkdownDocumentation": "`MountPoints`\n\nThe mount points for data volumes in your container.\nThis parameter maps to `Volumes` in the [Create a\ncontainer](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker\nRemote API](https://docs.docker.com/engine/api/v1.35/) and the --volume option to [docker\nrun](https://docs.docker.com/engine/reference/run/#security-configuration).\nWindows containers can mount whole directories on the same drive as\n`$env:ProgramData`. Windows containers can't mount directories on a different drive,\nand mount point can't be across drives.\n*Required*: No\n*Type*: Array of [MountPoint](./aws-properties-batch-jobdefinition-mountpoint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-mountpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MountPoint", "DuplicatesAllowed": true }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate\nresources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)\nin the *AWS Batch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-executionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuntimePlatform": { "MarkdownDocumentation": "`RuntimePlatform`\n\nAn object that represents the compute environment architecture for AWS Batch jobs on\nFargate.\n*Required*: No\n*Type*: [RuntimePlatform](./aws-properties-batch-jobdefinition-runtimeplatform.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-runtimeplatform", "UpdateType": "Mutable", "Required": false, "Type": "RuntimePlatform" }, "Volumes": { "MarkdownDocumentation": "`Volumes`\n\nA list of data volumes used in a job.\n*Required*: No\n*Type*: Array of [Volume](./aws-properties-batch-jobdefinition-volume.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-volumes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Volume", "DuplicatesAllowed": true }, "Command": { "MarkdownDocumentation": "`Command`\n\nThe command that's passed to the container. This parameter maps to `Cmd` in the\n[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 `COMMAND`\nparameter to [docker run](https://docs.docker.com/engine/reference/run/). For more information, see\n.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-command", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nThe environment variables to pass to a container. This parameter maps to `Env` in\nthe [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\n`--env` option to [docker run](https://docs.docker.com/engine/reference/run/).\n###### Important\nWe don't recommend using plaintext environment variables for sensitive information, such as\ncredential data.\n\n###### Note\nEnvironment variables cannot start with \"`AWS_BATCH`\". This naming\nconvention is reserved for variables that AWS Batch sets.\n*Required*: No\n*Type*: [Array](./aws-properties-batch-jobdefinition-environment.html) of [Environment](./aws-properties-batch-jobdefinition-environment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-environment", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Environment", "DuplicatesAllowed": true }, "Ulimits": { "MarkdownDocumentation": "`Ulimits`\n\nA list of `ulimits` to set in the container. This parameter maps to\n`Ulimits` 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/)\nand the `--ulimit` option to [docker\nrun](https://docs.docker.com/engine/reference/run/).\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources and\nshouldn't be provided.\n*Required*: No\n*Type*: Array of [Ulimit](./aws-properties-batch-jobdefinition-ulimit.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-ulimits", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ulimit", "DuplicatesAllowed": true }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type to use for a multi-node parallel job. All node groups in a multi-node\nparallel job must use the same instance type.\n###### Note\nThis parameter isn't applicable to single-node container jobs or jobs that run on Fargate\nresources, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-instancetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EphemeralStorage": { "MarkdownDocumentation": "`EphemeralStorage`\n\nThe amount of ephemeral storage to allocate for the task. This parameter is used to expand\nthe total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\nAWS Fargate.\n*Required*: No\n*Type*: [EphemeralStorage](./aws-properties-batch-jobdefinition-ephemeralstorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodecontainerproperties.html#cfn-batch-jobdefinition-multinodecontainerproperties-ephemeralstorage", "UpdateType": "Mutable", "Required": false, "Type": "EphemeralStorage" } } }, "AWS::Batch::JobDefinition.MultiNodeEcsProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.MultiNodeEcsProperties`\n\nAn object that contains the properties for the Amazon ECS resources of a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecsproperties.html", "Properties": { "TaskProperties": { "MarkdownDocumentation": "`TaskProperties`\n\nAn object that contains the properties for the Amazon ECS task definition of a job.\n###### Note\nThis object is currently limited to one task element. However, the task element can run up to 10 containers.\n*Required*: Yes\n*Type*: Array of [MultiNodeEcsTaskProperties](./aws-properties-batch-jobdefinition-multinodeecstaskproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecsproperties.html#cfn-batch-jobdefinition-multinodeecsproperties-taskproperties", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MultiNodeEcsTaskProperties", "DuplicatesAllowed": true } } }, "AWS::Batch::JobDefinition.MultiNodeEcsTaskProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.MultiNodeEcsTaskProperties`\n\nThe properties for a task definition that describes the container and volume definitions of\nan Amazon ECS task. You can specify which Docker images to use, the required resources, and other\nconfigurations related to launching the task definition through an Amazon ECS service or task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html", "Properties": { "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate\nresources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)\nin the *AWS Batch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-executionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TaskRoleArn": { "MarkdownDocumentation": "`TaskRoleArn`\n\nThe Amazon Resource Name (ARN) that's associated with the Amazon ECS task.\n###### Note\nThis is object is comparable to [ContainerProperties:jobRoleArn](https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-taskrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpcMode": { "MarkdownDocumentation": "`IpcMode`\n\nThe IPC resource namespace to use for the containers in the task. The valid values are\n`host`, `task`, or `none`.\nIf `host` is specified, all containers within the tasks that specified the\n`host` IPC mode on the same container instance share the same IPC resources with the\nhost Amazon EC2 instance.\nIf `task` is specified, all containers within the specified `task`\nshare the same IPC resources.\nIf `none` is specified, the IPC resources within the containers of a task are\nprivate, and are not shared with other containers in a task or on the container instance.\nIf no value is specified, then the IPC resource namespace sharing depends on the Docker\ndaemon setting on the container instance. For more information, see [IPC settings](https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in\nthe Docker run 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-ipcmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Volumes": { "MarkdownDocumentation": "`Volumes`\n\nA list of volumes that are associated with the job.\n*Required*: No\n*Type*: Array of [Volume](./aws-properties-batch-jobdefinition-volume.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-volumes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Volume", "DuplicatesAllowed": true }, "EnableExecuteCommand": { "MarkdownDocumentation": "`EnableExecuteCommand`\n\nDetermines whether execute command functionality is turned on for this task. If `true`, execute\ncommand functionality is turned on all the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-enableexecutecommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Containers": { "MarkdownDocumentation": "`Containers`\n\nThis object is a list of containers.\n*Required*: No\n*Type*: Array of [TaskContainerProperties](./aws-properties-batch-jobdefinition-taskcontainerproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-containers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TaskContainerProperties", "DuplicatesAllowed": true }, "PidMode": { "MarkdownDocumentation": "`PidMode`\n\nThe process namespace to use for the containers in the task. The valid values are\n`host` or `task`. For example, monitoring sidecars might need\n`pidMode` to access information about other containers running in the same\ntask.\nIf `host` is specified, all containers within the tasks that specified the\n`host` PID mode on the same container instance share the process namespace with the\nhost Amazon EC2 instance.\nIf `task` is specified, all containers within the specified task share the same\nprocess namespace.\nIf no value is specified, the default is a private namespace for each container. For more\ninformation, see [PID settings](https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker run 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-multinodeecstaskproperties.html#cfn-batch-jobdefinition-multinodeecstaskproperties-pidmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.NetworkConfiguration`\n\nThe network configuration for jobs that are running on Fargate resources. Jobs that are\nrunning on Amazon EC2 resources must not specify this parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-networkconfiguration.html", "Properties": { "AssignPublicIp": { "MarkdownDocumentation": "`AssignPublicIp`\n\nIndicates whether the job has a public IP address. For a job that's running on Fargate\nresources in a private subnet to send outbound traffic to the internet (for example, to pull\ncontainer images), the private subnet requires a NAT gateway be attached to route requests to the\ninternet. For more information, see [Amazon ECS task networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the\n*Amazon Elastic Container Service Developer Guide*. The default value is \"`DISABLED`\".\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-networkconfiguration.html#cfn-batch-jobdefinition-networkconfiguration-assignpublicip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.NodeProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.NodeProperties`\n\nAn object that represents the node properties of a multi-node parallel job.\n###### Note\nNode properties can't be specified for Amazon EKS based job definitions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html", "Properties": { "MainNode": { "MarkdownDocumentation": "`MainNode`\n\nSpecifies the node index for the main node of a multi-node parallel job. This node index\nvalue must be fewer than the number of nodes.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-mainnode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "NodeRangeProperties": { "MarkdownDocumentation": "`NodeRangeProperties`\n\nA list of node ranges and their properties that are associated with a multi-node parallel\njob.\n*Required*: Yes\n*Type*: Array of [NodeRangeProperty](./aws-properties-batch-jobdefinition-noderangeproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-noderangeproperties", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "NodeRangeProperty", "DuplicatesAllowed": true }, "NumNodes": { "MarkdownDocumentation": "`NumNodes`\n\nThe number of nodes that are associated with a multi-node parallel job.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-numnodes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Batch::JobDefinition.NodeRangeProperty": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.NodeRangeProperty`\n\nThis is an object that represents the properties of the node range for a multi-node parallel\njob.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html", "Properties": { "Container": { "MarkdownDocumentation": "`Container`\n\nThe container details for the node range.\n*Required*: No\n*Type*: [MultiNodeContainerProperties](./aws-properties-batch-jobdefinition-multinodecontainerproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-container", "UpdateType": "Mutable", "Required": false, "Type": "MultiNodeContainerProperties" }, "TargetNodes": { "MarkdownDocumentation": "`TargetNodes`\n\nThe range of nodes, using node index values. A range of `0:3` indicates nodes\nwith index values of `0` through `3`. If the starting range value is\nomitted (`:n`), then `0` is used to start the range. If the ending range\nvalue is omitted (`n:`), then the highest possible node index is used to end the\nrange. Your accumulative node ranges must account for all nodes (`0:n`). You can nest\nnode ranges (for example, `0:10` and `4:5`). In this case, the\n`4:5` range properties override the `0:10` properties.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-targetnodes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EcsProperties": { "MarkdownDocumentation": "`EcsProperties`\n\nThis is an object that represents the properties of the node range for a multi-node parallel\njob.\n*Required*: No\n*Type*: [MultiNodeEcsProperties](./aws-properties-batch-jobdefinition-multinodeecsproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-ecsproperties", "UpdateType": "Mutable", "Required": false, "Type": "MultiNodeEcsProperties" }, "InstanceTypes": { "MarkdownDocumentation": "`InstanceTypes`\n\nThe instance types of the underlying host infrastructure of a multi-node parallel\njob.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources.\nIn addition, this list object is currently limited to one element.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-instancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EksProperties": { "MarkdownDocumentation": "`EksProperties`\n\nThis is an object that represents the properties of the node range for a multi-node parallel job.\n*Required*: No\n*Type*: [EksProperties](./aws-properties-batch-jobdefinition-eksproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-eksproperties", "UpdateType": "Mutable", "Required": false, "Type": "EksProperties" }, "ConsumableResourceProperties": { "MarkdownDocumentation": "`ConsumableResourceProperties`\n\nContains a list of consumable resources required by a job.\n*Required*: No\n*Type*: [ConsumableResourceProperties](./aws-properties-batch-jobdefinition-consumableresourceproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-consumableresourceproperties", "UpdateType": "Mutable", "Required": false, "Type": "ConsumableResourceProperties" } } }, "AWS::Batch::JobDefinition.RepositoryCredentials": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.RepositoryCredentials`\n\nThe repository credentials for private registry authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-repositorycredentials.html", "Properties": { "CredentialsParameter": { "MarkdownDocumentation": "`CredentialsParameter`\n\nThe Amazon Resource Name (ARN) of the secret containing the private repository\ncredentials.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-repositorycredentials.html#cfn-batch-jobdefinition-repositorycredentials-credentialsparameter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.ResourceRequirement": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.ResourceRequirement`\n\nThe type and amount of a resource to assign to a container. The supported resources include\n`GPU`, `MEMORY`, and `VCPU`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of resource to assign to a container. The supported resources include\n`GPU`, `MEMORY`, and `VCPU`.\n*Required*: No\n*Type*: String\n*Allowed values*: `GPU | VCPU | MEMORY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GPU", "VCPU", "MEMORY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html#cfn-batch-jobdefinition-resourcerequirement-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe quantity of the specified resource to reserve for the container. The values vary based\non the `type` specified.\ntype=\"GPU\"\nThe number of physical GPUs to reserve for the container. Make sure that the number of\nGPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the\ncompute resource that the job is launched on.\n###### Note\nGPUs aren't available for jobs that are running on Fargate resources.\n\ntype=\"MEMORY\"\nThe memory hard limit (in MiB) present to the container. This parameter is supported for\njobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory\nspecified, the container is terminated. This parameter maps to `Memory` in the\n[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\n`--memory` option to [docker run](https://docs.docker.com/engine/reference/run/). You\nmust specify at least 4 MiB of memory for a job. This is required but can be specified in\nseveral places for multi-node parallel (MNP) jobs. It must be specified for each node at least\nonce. This parameter maps to `Memory` in the [Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container)\nsection 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/).\n###### Note\nIf you're trying to maximize your resource utilization by providing your jobs as much\nmemory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the\n*AWS Batch User Guide*.\nFor jobs that are running on Fargate resources, then `value` is the hard\nlimit (in MiB), and must match one of the supported values and the `VCPU` values\nmust be one of the values supported for that memory value.\nvalue = 512\n`VCPU` = 0.25\n\nvalue = 1024\n`VCPU` = 0.25 or 0.5\n\nvalue = 2048\n`VCPU` = 0.25, 0.5, or 1\n\nvalue = 3072\n`VCPU` = 0.5, or 1\n\nvalue = 4096\n`VCPU` = 0.5, 1, or 2\n\nvalue = 5120, 6144, or 7168\n`VCPU` = 1 or 2\n\nvalue = 8192\n`VCPU` = 1, 2, or 4\n\nvalue = 9216, 10240, 11264, 12288, 13312, 14336, or 15360\n`VCPU` = 2 or 4\n\nvalue = 16384\n`VCPU` = 2, 4, or 8\n\nvalue = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720\n`VCPU` = 4\n\nvalue = 20480, 24576, or 28672\n`VCPU` = 4 or 8\n\nvalue = 36864, 45056, 53248, or 61440\n`VCPU` = 8\n\nvalue = 32768, 40960, 49152, or 57344\n`VCPU` = 8 or 16\n\nvalue = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n`VCPU` = 16\n\n\ntype=\"VCPU\"\nThe number of vCPUs reserved for the container. This parameter maps to\n`CpuShares` in the [Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the\n[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.\nFor Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified\nin 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\ninformation about Fargate quotas, see [AWS Fargate quotas](https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate)\nin the *AWS General Reference*.\nFor jobs that are running on Fargate resources, then `value` must match one\nof the supported values and the `MEMORY` values must be one of the values supported\nfor that `VCPU` value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and\n16\nvalue = 0.25\n`MEMORY` = 512, 1024, or 2048\n\nvalue = 0.5\n`MEMORY` = 1024, 2048, 3072, or 4096\n\nvalue = 1\n`MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192\n\nvalue = 2\n`MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384\n\nvalue = 4\n`MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720\n\nvalue = 8\n`MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n\nvalue = 16\n`MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html#cfn-batch-jobdefinition-resourcerequirement-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.ResourceRetentionPolicy": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.ResourceRetentionPolicy`\n\nSpecifies the resource retention policy settings for a job definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourceretentionpolicy.html", "Properties": { "SkipDeregisterOnUpdate": { "MarkdownDocumentation": "`SkipDeregisterOnUpdate`\n\nSpecifies whether the previous revision of the job definition is retained in an active status after\nUPDATE events for the resource. The default value is `false`. When the property is set to\n`false`, the previous revision of the job definition is de-registered after a new revision\nis created. When the property is set to `true`, the previous revision of the job definition\nis not de-registered.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourceretentionpolicy.html#cfn-batch-jobdefinition-resourceretentionpolicy-skipderegisteronupdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Batch::JobDefinition.RetryStrategy": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.RetryStrategy`\n\nThe retry strategy that's associated with a job. For more information, see [Automated job retries](https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) in the\n*AWS Batch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html", "Properties": { "EvaluateOnExit": { "MarkdownDocumentation": "`EvaluateOnExit`\n\nArray of up to 5 objects that specify the conditions where jobs are retried or failed. If\nthis parameter is specified, then the `attempts` parameter must also be specified. If\nnone of the listed conditions match, then the job is retried.\n*Required*: No\n*Type*: [Array](./aws-properties-batch-jobdefinition-evaluateonexit.html) of [EvaluateOnExit](./aws-properties-batch-jobdefinition-evaluateonexit.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-evaluateonexit", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EvaluateOnExit", "DuplicatesAllowed": true }, "Attempts": { "MarkdownDocumentation": "`Attempts`\n\nThe number of times to move a job to the `RUNNABLE` status. You can specify\nbetween 1 and 10 attempts. If the value of `attempts` is greater than one, the job is\nretried 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-attempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Batch::JobDefinition.RuntimePlatform": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.RuntimePlatform`\n\nAn object that represents the compute environment architecture for AWS Batch jobs on\nFargate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-runtimeplatform.html", "Properties": { "OperatingSystemFamily": { "MarkdownDocumentation": "`OperatingSystemFamily`\n\nThe operating system for the compute environment. Valid values are:\n`LINUX` (default), `WINDOWS_SERVER_2019_CORE`,\n`WINDOWS_SERVER_2019_FULL`, `WINDOWS_SERVER_2022_CORE`, and\n`WINDOWS_SERVER_2022_FULL`.\n###### Note\nThe following parameters can\u2019t be set for Windows containers: `linuxParameters`,\n`privileged`, `user`, `ulimits`,\n`readonlyRootFilesystem`, and `efsVolumeConfiguration`.\n\n###### Note\nThe AWS Batch Scheduler checks the compute environments that are attached to the job queue before\nregistering a task definition with Fargate. In this scenario, the job queue is where the job is\nsubmitted. If the job requires a Windows container and the first compute environment is `LINUX`,\nthe compute environment is skipped and the next compute environment is checked until a Windows-based\ncompute environment is found.\n\n###### Note\nFargate Spot is not supported on Windows-based containers on Fargate.\nA job queue will be blocked if a Windows job is submitted to a job\nqueue with only Fargate Spot compute environments. However, you can attach both `FARGATE` and\n`FARGATE_SPOT` compute environments to the same job 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-runtimeplatform.html#cfn-batch-jobdefinition-runtimeplatform-operatingsystemfamily", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CpuArchitecture": { "MarkdownDocumentation": "`CpuArchitecture`\n\nThe vCPU architecture. The default value is `X86_64`. Valid values are\n`X86_64` and `ARM64`.\n###### Note\nThis parameter must be set to `X86_64` for Windows containers.\n\n###### Note\nFargate Spot is not supported on Windows-based containers on\nFargate. A job queue will be blocked if a Windows job is\nsubmitted to a job queue with only Fargate Spot compute environments. However, you can attach\nboth `FARGATE` and `FARGATE_SPOT` compute environments to the same job\nqueue.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-runtimeplatform.html#cfn-batch-jobdefinition-runtimeplatform-cpuarchitecture", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.Secret": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.Secret`\n\nAn object that represents the secret to expose to your container. Secrets can be exposed to\na container in the following ways:\n* To inject sensitive data into your containers as environment variables, use the\n `secrets` container definition parameter.\n* To reference sensitive information in the log configuration of a container, use the\n `secretOptions` container definition parameter.\nFor more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the\n*AWS Batch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html", "Properties": { "ValueFrom": { "MarkdownDocumentation": "`ValueFrom`\n\nThe secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of\nthe AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.\n###### Note\nIf the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you're\nlaunching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter\nexists 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html#cfn-batch-jobdefinition-secret-valuefrom", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html#cfn-batch-jobdefinition-secret-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.TaskContainerDependency": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.TaskContainerDependency`\n\nA list of containers that this task depends on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerdependency.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nThe dependency condition of the container. The following are the available conditions and\ntheir behavior:\n* `START` - This condition emulates the behavior of links and volumes today. It\n validates that a dependent container is started before permitting other containers to start.\n* `COMPLETE` - This condition validates that a dependent container runs to\n completion (exits) before permitting other containers to start. This can be useful for\n nonessential containers that run a script and then exit. This condition can't be set on an\n essential container.\n* `SUCCESS` - This condition is the same as `COMPLETE`, but it also\n requires that the container exits with a zero status. This condition can't be set on an\n essential container.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerdependency.html#cfn-batch-jobdefinition-taskcontainerdependency-condition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContainerName": { "MarkdownDocumentation": "`ContainerName`\n\nA unique identifier for the container.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerdependency.html#cfn-batch-jobdefinition-taskcontainerdependency-containername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.TaskContainerProperties": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.TaskContainerProperties`\n\nContainer properties are used for Amazon ECS-based job definitions. These properties to describe\nthe container that's launched as part of a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html", "Properties": { "RepositoryCredentials": { "MarkdownDocumentation": "`RepositoryCredentials`\n\nThe private repository authentication credentials to use.\n*Required*: No\n*Type*: [RepositoryCredentials](./aws-properties-batch-jobdefinition-repositorycredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-repositorycredentials", "UpdateType": "Mutable", "Required": false, "Type": "RepositoryCredentials" }, "User": { "MarkdownDocumentation": "`User`\n\nThe user to use inside the container. This parameter maps to User in the Create a container\nsection of the Docker Remote API and the --user option to docker run.\n###### Note\nWhen running tasks using the `host` network mode, don't run containers using the\n`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\nGID, you must specify it as a positive integer.\n* `user`\n* `user:group`\n* `uid`\n* `uid:gid`\n* `user:gi`\n* `uid:group`\n###### Note\nThis parameter is not supported for Windows containers.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-user", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Secrets": { "MarkdownDocumentation": "`Secrets`\n\nThe secrets to pass to the container. For more information, see [Specifying Sensitive\nData](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*: Array of [Secret](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-secrets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Secret", "DuplicatesAllowed": true }, "Privileged": { "MarkdownDocumentation": "`Privileged`\n\nWhen this parameter is `true`, the container is given elevated privileges on the\nhost container instance (similar to the `root` user). This parameter maps to\n`Privileged` in the [Create a\ncontainer](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker\nRemote API](https://docs.docker.com/engine/api/v1.35/) and the `--privileged` option to [docker\nrun](https://docs.docker.com/engine/reference/run/#security-configuration).\n###### Note\nThis parameter is not supported for Windows containers or tasks run on Fargate.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-privileged", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LinuxParameters": { "MarkdownDocumentation": "`LinuxParameters`\n\nLinux-specific modifications that are applied to the container, such as Linux kernel\ncapabilities. For more information, see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).\n*Required*: No\n*Type*: [LinuxParameters](./aws-properties-batch-jobdefinition-linuxparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-linuxparameters", "UpdateType": "Mutable", "Required": false, "Type": "LinuxParameters" }, "ReadonlyRootFilesystem": { "MarkdownDocumentation": "`ReadonlyRootFilesystem`\n\nWhen this parameter is true, the container is given read-only access to its root file\nsystem. This parameter maps to `ReadonlyRootfs` in the [Create a\ncontainer](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker\nRemote API](https://docs.docker.com/engine/api/v1.35/) and the `--read-only` option to [docker\nrun](https://docs.docker.com/engine/reference/run/#security-configuration).\n###### Note\nThis parameter is not supported for Windows containers.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-readonlyrootfilesystem", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Image": { "MarkdownDocumentation": "`Image`\n\nThe image used to start a container. This string is passed directly to the Docker daemon. By\ndefault, images in the Docker Hub registry are available. Other repositories are specified with\neither `repository-url/image:tag` or `repository-url/image@digest`. Up to\n255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward\nslashes, and number signs are allowed. This parameter maps to `Image` in the [Create a\ncontainer](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker\nRemote API](https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of the [*docker\nrun*](https://docs.docker.com/engine/reference/run/#security-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-image", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe log configuration specification for the container.\nThis parameter maps to `LogConfig` in the [Create a\ncontainer](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker\nRemote API](https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker\nrun](https://docs.docker.com/engine/reference/run/#security-configuration).\nBy default, containers use the same logging driver that the Docker daemon uses. However the\ncontainer can use a different logging driver than the Docker daemon by specifying a log driver\nwith this parameter in the container definition. To use a different logging driver for a\ncontainer, the log system must be configured properly on the container instance (or on a\ndifferent log server for remote logging options). For more information about the options for\ndifferent supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) \nin the *Docker documentation*.\n###### Note\nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon\n(shown in the `LogConfiguration` data type). Additional log drivers may be available\nin future releases of the Amazon ECS container agent.\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container\ninstance. To check the Docker Remote API version on your container instance, log in to your\ncontainer instance and run the following command: sudo docker version `--format\n'{{.Server.APIVersion}}'`\n###### Note\nThe Amazon ECS container agent running on a container instance must register the logging drivers\navailable on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment\nvariable before containers placed on that instance can use these log configuration options. For\nmore information, see [Amazon ECS container agent\nconfiguration](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](./aws-properties-batch-jobdefinition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogConfiguration" }, "Essential": { "MarkdownDocumentation": "`Essential`\n\nIf the essential parameter of a container is marked as `true`, and that container\nfails or stops for any reason, all other containers that are part of the task are stopped. If the\n`essential` parameter of a container is marked as false, its failure doesn't affect\nthe rest of the containers in a task. If this parameter is omitted, a container is assumed to be\nessential.\nAll jobs must have at least one essential container. If you have an application that's\ncomposed of multiple containers, group containers that are used for a common purpose into\ncomponents, and separate the different components into multiple task definitions. For more\ninformation, see [Application\nArchitecture](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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-essential", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ResourceRequirements": { "MarkdownDocumentation": "`ResourceRequirements`\n\nThe type and amount of a resource to assign to a container. The only supported resource is a\nGPU.\n*Required*: No\n*Type*: Array of [ResourceRequirement](./aws-properties-batch-jobdefinition-resourcerequirement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-resourcerequirements", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceRequirement", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a container. The name can be used as a unique identifier to target your\n`dependsOn` and `Overrides` objects.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MountPoints": { "MarkdownDocumentation": "`MountPoints`\n\nThe mount points for data volumes in your container.\nThis parameter maps to `Volumes` in the [Create a\ncontainer](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker\nRemote API](https://docs.docker.com/engine/api/v1.35/) and the --volume option to [docker\nrun](https://docs.docker.com/engine/reference/run/#security-configuration).\nWindows containers can mount whole directories on the same drive as\n`$env:ProgramData`. Windows containers can't mount directories on a different drive,\nand mount point can't be across drives.\n*Required*: No\n*Type*: Array of [MountPoint](./aws-properties-batch-jobdefinition-mountpoint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-mountpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MountPoint", "DuplicatesAllowed": true }, "FirelensConfiguration": { "MarkdownDocumentation": "`FirelensConfiguration`\n\nThe FireLens configuration for the container. This is used to specify and configure a\nlog router for container logs. For more information, see [Custom log](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) routing in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: [FirelensConfiguration](./aws-properties-batch-jobdefinition-firelensconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-firelensconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FirelensConfiguration" }, "DependsOn": { "MarkdownDocumentation": "`DependsOn`\n\nA list of containers that this container depends on.\n*Required*: No\n*Type*: Array of [TaskContainerDependency](./aws-properties-batch-jobdefinition-taskcontainerdependency.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-dependson", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TaskContainerDependency", "DuplicatesAllowed": true }, "Command": { "MarkdownDocumentation": "`Command`\n\nThe command that's passed to the container. This parameter maps to `Cmd` in the\n[Create a\ncontainer](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker\nRemote API](https://docs.docker.com/engine/api/v1.23/) and the `COMMAND` parameter to [docker run](https://docs.docker.com/engine/reference/run/). For more information,\nsee [Dockerfile reference:\nCMD](https://docs.docker.com/engine/reference/builder/#cmd).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-command", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nThe environment variables to pass to a container. This parameter maps to Env in the [Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container)\nsection of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/)\nand the `--env` parameter to [docker run](https://docs.docker.com/engine/reference/run/).\n###### Important\nWe don't recommend using plaintext environment variables for sensitive information, such as\ncredential data.\n\n###### Note\nEnvironment variables cannot start with `AWS_BATCH`. This naming convention is\nreserved for variables that AWS Batch sets.\n*Required*: No\n*Type*: [Array](./aws-properties-batch-jobdefinition-environment.html) of [Environment](./aws-properties-batch-jobdefinition-environment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-environment", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Environment", "DuplicatesAllowed": true }, "Ulimits": { "MarkdownDocumentation": "`Ulimits`\n\nA list of `ulimits` to set in the container. If a `ulimit` value is\nspecified in a task definition, it overrides the default values set by Docker. This parameter\nmaps to `Ulimits` in the [Create a\ncontainer](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker\nRemote API](https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker\nrun](https://docs.docker.com/engine/reference/run/#security-configuration).\nAmazon ECS tasks hosted on Fargate use the default resource limit values set by the operating\nsystem with the exception of the nofile resource limit parameter which Fargate overrides. The\n`nofile` resource limit sets a restriction on the number of open files that a\ncontainer can use. The default `nofile` soft limit is `1024` and the\ndefault hard limit is `65535`.\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container\ninstance. To check the Docker Remote API version on your container instance, log in to your\ncontainer instance and run the following command: sudo docker version `--format\n'{{.Server.APIVersion}}'`\n###### Note\nThis parameter is not supported for Windows containers.\n*Required*: No\n*Type*: Array of [Ulimit](./aws-properties-batch-jobdefinition-ulimit.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-ulimits", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ulimit", "DuplicatesAllowed": true } } }, "AWS::Batch::JobDefinition.Tmpfs": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.Tmpfs`\n\nThe container path, mount options, and size of the `tmpfs` mount.\n###### Note\nThis object isn't applicable to jobs that are running on Fargate resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html", "Properties": { "Size": { "MarkdownDocumentation": "`Size`\n\nThe size (in MiB) of the `tmpfs` volume.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-size", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ContainerPath": { "MarkdownDocumentation": "`ContainerPath`\n\nThe absolute file path in the container where the `tmpfs` volume is\nmounted.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-containerpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MountOptions": { "MarkdownDocumentation": "`MountOptions`\n\nThe list of `tmpfs` volume mount options.\nValid values: \"`defaults`\" | \"`ro`\" | \"`rw`\" |\n\"`suid`\" | \"`nosuid`\" | \"`dev`\" | \"`nodev`\" |\n\"`exec`\" | \"`noexec`\" | \"`sync`\" | \"`async`\" |\n\"`dirsync`\" | \"`remount`\" | \"`mand`\" | \"`nomand`\" |\n\"`atime`\" | \"`noatime`\" | \"`diratime`\" |\n\"`nodiratime`\" | \"`bind`\" | \"`rbind\" | \"unbindable\" | \"runbindable\" |\n\"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime`\" |\n\"`norelatime`\" | \"`strictatime`\" | \"`nostrictatime`\" |\n\"`mode`\" | \"`uid`\" | \"`gid`\" | \"`nr_inodes`\" |\n\"`nr_blocks`\" | \"`mpol`\"\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-mountoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Batch::JobDefinition.Ulimit": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.Ulimit`\n\nThe `ulimit` settings to pass to the container. For more information, see\n[Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html).\n###### Note\nThis object isn't applicable to jobs that are running on Fargate resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html", "Properties": { "SoftLimit": { "MarkdownDocumentation": "`SoftLimit`\n\nThe soft limit for the `ulimit` type.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-softlimit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "HardLimit": { "MarkdownDocumentation": "`HardLimit`\n\nThe hard limit for the `ulimit` type.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-hardlimit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe `type` of the `ulimit`. Valid values are: `core` |\n`cpu` | `data` | `fsize` | `locks` |\n`memlock` | `msgqueue` | `nice` | `nofile` |\n`nproc` | `rss` | `rtprio` | `rttime` |\n`sigpending` | `stack`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobDefinition.Volume": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition.Volume`\n\nA data volume that's used in a job's container properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volume.html", "Properties": { "Host": { "MarkdownDocumentation": "`Host`\n\nThe contents of the `host` parameter determine whether your data volume persists\non the host container instance and where it's stored. If the host parameter is empty, then the\nDocker daemon assigns a host path for your data volume. However, the data isn't guaranteed to\npersist after the containers that are associated with it stop running.\n###### Note\nThis parameter isn't applicable to jobs that are running on Fargate resources and\nshouldn't be provided.\n*Required*: No\n*Type*: [Host](./aws-properties-batch-jobdefinition-host.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volume.html#cfn-batch-jobdefinition-volume-host", "UpdateType": "Mutable", "Required": false, "Type": "Host" }, "EfsVolumeConfiguration": { "MarkdownDocumentation": "`EfsVolumeConfiguration`\n\nThis parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs\nthat are running on Fargate resources must specify a `platformVersion` of at least\n`1.4.0`.\n*Required*: No\n*Type*: [EFSVolumeConfiguration](./aws-properties-batch-jobdefinition-efsvolumeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volume.html#cfn-batch-jobdefinition-volume-efsvolumeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EFSVolumeConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,\nnumbers, hyphens (-), and underscores (\\_). This name is referenced in the\n`sourceVolume` parameter of container definition `mountPoints`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volume.html#cfn-batch-jobdefinition-volume-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::JobQueue.ComputeEnvironmentOrder": { "MarkdownDocumentation": "`AWS::Batch::JobQueue.ComputeEnvironmentOrder`\n\nThe order that compute environments are tried in for job placement within a queue. Compute\nenvironments are tried in ascending order. For example, if two compute environments are\nassociated with a job queue, the compute environment with a lower order integer value is tried\nfor job placement first. Compute environments must be in the `VALID` state before you\ncan associate them with a job queue. All of the compute environments must be either EC2\n(`EC2` or `SPOT`) or Fargate (`FARGATE` or\n`FARGATE_SPOT`); Amazon EC2 and Fargate compute environments can't be mixed.\n###### Note\nAll compute environments that are associated with a job queue must share the same\narchitecture. AWS Batch doesn't support mixing compute environment architecture types in a single\njob queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html", "Properties": { "ComputeEnvironment": { "MarkdownDocumentation": "`ComputeEnvironment`\n\nThe Amazon Resource Name (ARN) of the compute environment.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-computeenvironment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Order": { "MarkdownDocumentation": "`Order`\n\nThe order of the compute environment. Compute environments are tried in ascending order. For\nexample, if two compute environments are associated with a job queue, the compute environment\nwith a lower `order` integer value is tried for job placement 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-order", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Batch::JobQueue.JobStateTimeLimitAction": { "MarkdownDocumentation": "`AWS::Batch::JobQueue.JobStateTimeLimitAction`\n\nSpecifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action to take when a job is at the head of the job queue in the specified state for the specified period of\ntime. The only supported value is `CANCEL`, which will cancel the job.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CANCEL | TERMINATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CANCEL", "TERMINATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaxTimeSeconds": { "MarkdownDocumentation": "`MaxTimeSeconds`\n\nThe approximate amount of time, in seconds, that must pass with the job in the specified state before the action\nis taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `600`\n*Maximum*: `86400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-maxtimeseconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the job needed to trigger the action. The only supported value is `RUNNABLE`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RUNNABLE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "RUNNABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-state", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Reason": { "MarkdownDocumentation": "`Reason`\n\nThe reason to log for the action being taken.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-reason", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::JobQueue.ServiceEnvironmentOrder": { "MarkdownDocumentation": "`AWS::Batch::JobQueue.ServiceEnvironmentOrder`\n\nSpecifies the order of a service environment for a job queue. This determines the priority order when multiple service environments are associated with the same job queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-serviceenvironmentorder.html", "Properties": { "Order": { "MarkdownDocumentation": "`Order`\n\nThe order of the service environment. Job queues with a higher priority are evaluated first when associated with the same service environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-serviceenvironmentorder.html#cfn-batch-jobqueue-serviceenvironmentorder-order", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ServiceEnvironment": { "MarkdownDocumentation": "`ServiceEnvironment`\n\nThe name or ARN of the service environment.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-serviceenvironmentorder.html#cfn-batch-jobqueue-serviceenvironmentorder-serviceenvironment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Batch::SchedulingPolicy.FairsharePolicy": { "MarkdownDocumentation": "`AWS::Batch::SchedulingPolicy.FairsharePolicy`\n\nThe fair-share scheduling policy details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html", "Properties": { "ShareDistribution": { "MarkdownDocumentation": "`ShareDistribution`\n\nAn array of `SharedIdentifier` objects that contain the weights for the\nshare identifiers for the fair-share policy. Share identifiers that aren't included have a\ndefault weight of `1.0`.\n*Required*: No\n*Type*: Array of [ShareAttributes](./aws-properties-batch-schedulingpolicy-shareattributes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-sharedistribution", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ShareAttributes", "DuplicatesAllowed": true }, "ShareDecaySeconds": { "MarkdownDocumentation": "`ShareDecaySeconds`\n\nThe amount of time (in seconds) to use to calculate a fair-share percentage for each\nshare identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds).\nThe maximum supported value is 604800 (1 week).\nThe decay allows for more recently run jobs to have more weight than jobs that ran earlier.\nConsider adjusting this number if you have jobs that (on average) run longer than ten minutes,\nor a large difference in job count or job run times between share identifiers, and the allocation\nof resources doesn't meet your needs.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `604800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-sharedecayseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputeReservation": { "MarkdownDocumentation": "`ComputeReservation`\n\nA value used to reserve some of the available maximum vCPU for share identifiers that\naren't already used.\nThe reserved ratio is\n`(computeReservation/100)^ActiveFairShares`\nwhere `ActiveFairShares` is the number of active share\nidentifiers.\nFor example, a `computeReservation` value of 50 indicates that AWS Batch reserves\n50% of the maximum available vCPU if there's only one share identifier. It reserves 25% if\nthere are two share identifiers. It reserves 12.5% if there are three share\nidentifiers. A `computeReservation` value of 25 indicates that AWS Batch should reserve\n25% of the maximum available vCPU if there's only one share identifier, 6.25% if there are\ntwo fair share identifiers, and 1.56% if there are three share identifiers.\nThe minimum value is 0 and the maximum value is 99.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `99`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-fairsharepolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy-computereservation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Batch::SchedulingPolicy.ShareAttributes": { "MarkdownDocumentation": "`AWS::Batch::SchedulingPolicy.ShareAttributes`\n\nSpecifies the weights for the share identifiers for the fair-share policy. Share\nidentifiers that aren't included have a default weight of `1.0`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-shareattributes.html", "Properties": { "WeightFactor": { "MarkdownDocumentation": "`WeightFactor`\n\nThe weight factor for the share identifier. The default value is 1.0. A lower value has\na higher priority for compute resources. For example, jobs that use a share identifier with a\nweight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share\nidentifier with a weight factor of 1.\nThe smallest supported value is 0.0001, and the largest supported value is 999.9999.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-shareattributes.html#cfn-batch-schedulingpolicy-shareattributes-weightfactor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ShareIdentifier": { "MarkdownDocumentation": "`ShareIdentifier`\n\nA share identifier or share identifier prefix. If the string ends with an asterisk\n(\\*), this entry specifies the weight factor to use for share identifiers that start with\nthat prefix. The list of share identifiers in a fair-share policy can't overlap. For\nexample, you can't have one that specifies a `shareIdentifier` of `UserA*`\nand another that specifies a `shareIdentifier` of `UserA1`.\nThere can be no more than 500 share identifiers active in a job queue.\nThe string is limited to 255 alphanumeric characters, and can be followed by an asterisk\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-shareattributes.html#cfn-batch-schedulingpolicy-shareattributes-shareidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Batch::ServiceEnvironment.CapacityLimit": { "MarkdownDocumentation": "`AWS::Batch::ServiceEnvironment.CapacityLimit`\n\nDefines the capacity limit for a service environment. This structure specifies the maximum amount of resources that can be used by service jobs in the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-serviceenvironment-capacitylimit.html", "Properties": { "CapacityUnit": { "MarkdownDocumentation": "`CapacityUnit`\n\nThe unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For `SAGEMAKER_TRAINING` jobs, use `NUM_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-serviceenvironment-capacitylimit.html#cfn-batch-serviceenvironment-capacitylimit-capacityunit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum capacity available for the service environment. This value represents the maximum amount resources that can be allocated to service jobs.\nFor example, `maxCapacity=50`, `capacityUnit=NUM_INSTANCES`. This indicates that the\nmaximum number of instances that can be run on this service environment is 50. You could\nthen run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that\nrequires 10 instances, it will wait in the queue.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-serviceenvironment-capacitylimit.html#cfn-batch-serviceenvironment-capacitylimit-maxcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Bedrock::Agent.APISchema": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.APISchema`\n\nContains details about the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html).\nYou can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nContains details about the S3 object containing the OpenAPI schema for the action group.\n*Required*: No\n*Type*: [S3Identifier](./aws-properties-bedrock-agent-s3identifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3Identifier" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nThe JSON or YAML-formatted payload defining the OpenAPI schema for the action 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-payload", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.ActionGroupExecutor": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.ActionGroupExecutor`\n\nContains details about the Lambda function containing the business logic that is carried out upon invoking the action or the\ncustom control method for handling the information elicited from the user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html", "Properties": { "CustomControl": { "MarkdownDocumentation": "`CustomControl`\n\nTo return the action group invocation results directly in the `InvokeInlineAgent` response, specify `RETURN_CONTROL`.\n*Required*: No\n*Type*: String\n*Allowed values*: `RETURN_CONTROL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RETURN_CONTROL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html#cfn-bedrock-agent-actiongroupexecutor-customcontrol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nThe Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z0-9-]{1,20}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html#cfn-bedrock-agent-actiongroupexecutor-lambda", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.AgentActionGroup": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.AgentActionGroup`\n\nContains details of the inline agent's action group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the action group.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiSchema": { "MarkdownDocumentation": "`ApiSchema`\n\nContains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted\npayload defining the schema. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html).\n*Required*: No\n*Type*: [APISchema](./aws-properties-bedrock-agent-apischema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-apischema", "UpdateType": "Mutable", "Required": false, "Type": "APISchema" }, "FunctionSchema": { "MarkdownDocumentation": "`FunctionSchema`\n\nContains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.\n*Required*: No\n*Type*: [FunctionSchema](./aws-properties-bedrock-agent-functionschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-functionschema", "UpdateType": "Mutable", "Required": false, "Type": "FunctionSchema" }, "SkipResourceInUseCheckOnDelete": { "MarkdownDocumentation": "`SkipResourceInUseCheckOnDelete`\n\nSpecifies whether to delete the resource even if it's in use. By default, this value\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-skipresourceinusecheckondelete", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ParentActionGroupSignature": { "MarkdownDocumentation": "`ParentActionGroupSignature`\n\nIf this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task. The `description`, `apiSchema`, and `actionGroupExecutor` fields must be blank for this action group.\nDuring orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an [Observation](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) reprompting the user for more information.\n*Required*: No\n*Type*: String\n*Allowed values*: `AMAZON.UserInput | AMAZON.C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AMAZON.UserInput", "AMAZON.CodeInterpreter" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-parentactiongroupsignature", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ActionGroupExecutor": { "MarkdownDocumentation": "`ActionGroupExecutor`\n\nThe Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking\nthe action or the custom control method for handling the information elicited from the user.\n*Required*: No\n*Type*: [ActionGroupExecutor](./aws-properties-bedrock-agent-actiongroupexecutor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupexecutor", "UpdateType": "Mutable", "Required": false, "Type": "ActionGroupExecutor" }, "ActionGroupName": { "MarkdownDocumentation": "`ActionGroupName`\n\nThe name of the action group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionGroupState": { "MarkdownDocumentation": "`ActionGroupState`\n\nSpecifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.AgentCollaborator": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.AgentCollaborator`\n\nAn agent collaborator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html", "Properties": { "AgentDescriptor": { "MarkdownDocumentation": "`AgentDescriptor`\n\nThe collaborator's agent descriptor.\n*Required*: Yes\n*Type*: [AgentDescriptor](./aws-properties-bedrock-agent-agentdescriptor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html#cfn-bedrock-agent-agentcollaborator-agentdescriptor", "UpdateType": "Mutable", "Required": true, "Type": "AgentDescriptor" }, "CollaborationInstruction": { "MarkdownDocumentation": "`CollaborationInstruction`\n\nThe collaborator's instructions.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html#cfn-bedrock-agent-agentcollaborator-collaborationinstruction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RelayConversationHistory": { "MarkdownDocumentation": "`RelayConversationHistory`\n\nThe collaborator's relay conversation history.\n*Required*: No\n*Type*: String\n*Allowed values*: `TO_COLLABORATOR | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TO_COLLABORATOR", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html#cfn-bedrock-agent-agentcollaborator-relayconversationhistory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CollaboratorName": { "MarkdownDocumentation": "`CollaboratorName`\n\nThe collaborator's collaborator name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([0-9a-zA-Z][_-]?){1,100}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html#cfn-bedrock-agent-agentcollaborator-collaboratorname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.AgentDescriptor": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.AgentDescriptor`\n\nAn agent descriptor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentdescriptor.html", "Properties": { "AliasArn": { "MarkdownDocumentation": "`AliasArn`\n\nThe agent's alias ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentdescriptor.html#cfn-bedrock-agent-agentdescriptor-aliasarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.AgentKnowledgeBase": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.AgentKnowledgeBase`\n\nContains details about a knowledge base that is associated with an agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the association between the agent and the knowledge base.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KnowledgeBaseState": { "MarkdownDocumentation": "`KnowledgeBaseState`\n\nSpecifies whether to use the knowledge base or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-knowledgebasestate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KnowledgeBaseId": { "MarkdownDocumentation": "`KnowledgeBaseId`\n\nThe unique identifier of the association between the agent and the knowledge base.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z]{10}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-knowledgebaseid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.CustomOrchestration": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.CustomOrchestration`\n\nContains details of the custom orchestration configured for the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-customorchestration.html", "Properties": { "Executor": { "MarkdownDocumentation": "`Executor`\n\nThe structure of the executor invoking the actions in custom orchestration.\n*Required*: No\n*Type*: [OrchestrationExecutor](./aws-properties-bedrock-agent-orchestrationexecutor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-customorchestration.html#cfn-bedrock-agent-customorchestration-executor", "UpdateType": "Mutable", "Required": false, "Type": "OrchestrationExecutor" } } }, "AWS::Bedrock::Agent.Function": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.Function`\n\nDefines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.\nThis data type is used in the following API operations:\n* [CreateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax)\n* [CreateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax)\n* [UpdateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax)\n* [UpdateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax)\n* [GetAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the function and its purpose.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters that the agent elicits from the user to fulfill the function.\n*Required*: No\n*Type*: Object of [ParameterDetail](./aws-properties-bedrock-agent-parameterdetail.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ParameterDetail" }, "RequireConfirmation": { "MarkdownDocumentation": "`RequireConfirmation`\n\nContains information if user confirmation is required to invoke the function.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-requireconfirmation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the function.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.FunctionSchema": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.FunctionSchema`\n\nContains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-functionschema.html", "Properties": { "Functions": { "MarkdownDocumentation": "`Functions`\n\nA list of functions that each define an action in the action group.\n*Required*: Yes\n*Type*: Array of [Function](./aws-properties-bedrock-agent-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-functionschema.html#cfn-bedrock-agent-functionschema-functions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Function", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Agent.GuardrailConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.GuardrailConfiguration`\n\nConfiguration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-guardrailconfiguration.html", "Properties": { "GuardrailIdentifier": { "MarkdownDocumentation": "`GuardrailIdentifier`\n\nThe identifier for the guardrail.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-guardrailconfiguration.html#cfn-bedrock-agent-guardrailconfiguration-guardrailidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GuardrailVersion": { "MarkdownDocumentation": "`GuardrailVersion`\n\nThe version of the guardrail.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([0-9]{1,8})|(DRAFT))$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-guardrailconfiguration.html#cfn-bedrock-agent-guardrailconfiguration-guardrailversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.InferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.InferenceConfiguration`\n\nBase inference parameters to pass to a model in a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html). For more information,\nsee [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).\nIf you need to pass additional parameters that the model\nsupports, use the `additionalModelRequestFields` request field in the call to `Converse`\nor `ConverseStream`.\nFor more information, see [Model parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html", "Properties": { "TopK": { "MarkdownDocumentation": "`TopK`\n\nWhile generating a response, the model determines the probability of the following token at each point of generation. The value that you set for `topK` is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set `topK` to 50, the model selects the next token from among the top 50 most likely choices.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-topk", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Temperature": { "MarkdownDocumentation": "`Temperature`\n\nThe likelihood of the model selecting higher-probability options while generating a\nresponse. A lower value makes the model more likely to choose higher-probability options,\nwhile a higher value makes the model more likely to choose lower-probability\noptions.\nThe default value is the default value for the model that\nyou are using. For more information, see [Inference parameters for foundation\nmodels](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-temperature", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MaximumLength": { "MarkdownDocumentation": "`MaximumLength`\n\nThe maximum number of tokens allowed in the generated response.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-maximumlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StopSequences": { "MarkdownDocumentation": "`StopSequences`\n\nA list of stop sequences. A stop sequence is a sequence of characters that causes the\nmodel to stop generating the response.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-stopsequences", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TopP": { "MarkdownDocumentation": "`TopP`\n\nThe percentage of most-likely candidates that the model considers for the next token. For\nexample, if you choose a value of 0.8 for `topP`, the model selects from the top 80% of the\nprobability distribution of tokens that could be next in the sequence.\nThe default value is the default value for the model that you are using. For more information, see\n[Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-topp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::Agent.MemoryConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.MemoryConfiguration`\n\nDetails of the memory configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memoryconfiguration.html", "Properties": { "SessionSummaryConfiguration": { "MarkdownDocumentation": "`SessionSummaryConfiguration`\n\nContains the configuration for SESSION\\_SUMMARY memory type enabled for the agent.\n*Required*: No\n*Type*: [SessionSummaryConfiguration](./aws-properties-bedrock-agent-sessionsummaryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memoryconfiguration.html#cfn-bedrock-agent-memoryconfiguration-sessionsummaryconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SessionSummaryConfiguration" }, "EnabledMemoryTypes": { "MarkdownDocumentation": "`EnabledMemoryTypes`\n\nThe type of memory that is stored.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memoryconfiguration.html#cfn-bedrock-agent-memoryconfiguration-enabledmemorytypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "StorageDays": { "MarkdownDocumentation": "`StorageDays`\n\nThe number of days the agent is configured to retain the conversational context.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memoryconfiguration.html#cfn-bedrock-agent-memoryconfiguration-storagedays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::Agent.OrchestrationExecutor": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.OrchestrationExecutor`\n\nThe structure of the executor invoking the actions in custom orchestration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-orchestrationexecutor.html", "Properties": { "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nThe Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z0-9-]{1,20}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-orchestrationexecutor.html#cfn-bedrock-agent-orchestrationexecutor-lambda", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.ParameterDetail": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.ParameterDetail`\n\nContains details about a parameter in a function for an action group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe data type of the parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `string | number | integer |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "string", "number", "integer", "boolean", "array" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Required": { "MarkdownDocumentation": "`Required`\n\nWhether the parameter is required for the agent to complete the function for action group invocation.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-required", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Bedrock::Agent.PromptConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.PromptConfiguration`\n\nContains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html", "Properties": { "PromptType": { "MarkdownDocumentation": "`PromptType`\n\nThe step in the agent sequence that this prompt configuration applies to.\n*Required*: No\n*Type*: String\n*Allowed values*: `PRE_PROCESSING | ORCHESTRAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "ROUTING_CLASSIFIER", "MEMORY_SUMMARIZATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-prompttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PromptState": { "MarkdownDocumentation": "`PromptState`\n\nSpecifies whether to allow the inline agent to carry out the step specified in the `promptType`. If you set this value to `DISABLED`, the agent skips that step. The default state for each `promptType` is as follows.\n* `PRE_PROCESSING` \u2013 `ENABLED`\n* `ORCHESTRATION` \u2013 `ENABLED`\n* `KNOWLEDGE_BASE_RESPONSE_GENERATION` \u2013 `ENABLED`\n* `POST_PROCESSING` \u2013 `DISABLED`\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-promptstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdditionalModelRequestFields": { "MarkdownDocumentation": "`AdditionalModelRequestFields`\n\nIf the Converse or ConverseStream operations support the model,\n`additionalModelRequestFields` contains additional inference parameters,\nbeyond the base set of inference parameters in the `inferenceConfiguration`\nfield.\nFor more information, see [Inference request parameters\nand response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-additionalmodelrequestfields", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "BasePromptTemplate": { "MarkdownDocumentation": "`BasePromptTemplate`\n\nDefines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see [Prompt template placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html). For more information, see [Configure the prompt templates](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html).\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-baseprompttemplate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FoundationModel": { "MarkdownDocumentation": "`FoundationModel`\n\nThe agent's foundation model.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-foundationmodel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InferenceConfiguration": { "MarkdownDocumentation": "`InferenceConfiguration`\n\nContains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType`. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).\n*Required*: No\n*Type*: [InferenceConfiguration](./aws-properties-bedrock-agent-inferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-inferenceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InferenceConfiguration" }, "PromptCreationMode": { "MarkdownDocumentation": "`PromptCreationMode`\n\nSpecifies whether to override the default prompt template for this `promptType`. Set this value to `OVERRIDDEN` to use the prompt that you provide in the `basePromptTemplate`. If you leave it as `DEFAULT`, the agent uses a default prompt template.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | OVERRIDDEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "OVERRIDDEN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-promptcreationmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParserMode": { "MarkdownDocumentation": "`ParserMode`\n\nSpecifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`. If you set the field as `OVERRIDDEN`, the `overrideLambda` field in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) must be specified with the ARN of a Lambda function.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | OVERRIDDEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "OVERRIDDEN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-parsermode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.PromptOverrideConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.PromptOverrideConfiguration`\n\nContains configurations to override prompts in different parts of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html", "Properties": { "PromptConfigurations": { "MarkdownDocumentation": "`PromptConfigurations`\n\nContains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).\n*Required*: Yes\n*Type*: Array of [PromptConfiguration](./aws-properties-bedrock-agent-promptconfiguration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html#cfn-bedrock-agent-promptoverrideconfiguration-promptconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PromptConfiguration", "DuplicatesAllowed": true }, "OverrideLambda": { "MarkdownDocumentation": "`OverrideLambda`\n\nThe ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the `promptConfigurations` must contain a `parserMode` value that is set to `OVERRIDDEN`. For more information, see [Parser Lambda function in Amazon Bedrock Agents](https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z0-9-]{1,20}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html#cfn-bedrock-agent-promptoverrideconfiguration-overridelambda", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.S3Identifier": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.S3Identifier`\n\nThe identifier information for an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-s3identifier.html", "Properties": { "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nThe name of the S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-s3identifier.html#cfn-bedrock-agent-s3identifier-s3bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3ObjectKey": { "MarkdownDocumentation": "`S3ObjectKey`\n\nThe S3 object key for the S3 resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-s3identifier.html#cfn-bedrock-agent-s3identifier-s3objectkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Agent.SessionSummaryConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Agent.SessionSummaryConfiguration`\n\nConfiguration for SESSION\\_SUMMARY memory type enabled for the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-sessionsummaryconfiguration.html", "Properties": { "MaxRecentSessions": { "MarkdownDocumentation": "`MaxRecentSessions`\n\nMaximum number of recent session summaries to include in the agent's prompt context.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-sessionsummaryconfiguration.html#cfn-bedrock-agent-sessionsummaryconfiguration-maxrecentsessions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::AgentAlias.AgentAliasHistoryEvent": { "MarkdownDocumentation": "`AWS::Bedrock::AgentAlias.AgentAliasHistoryEvent`\n\nContains details about the history of the alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliashistoryevent.html", "Properties": { "StartDate": { "MarkdownDocumentation": "`StartDate`\n\nThe date that the alias began being associated to the version in the `routingConfiguration` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliashistoryevent.html#cfn-bedrock-agentalias-agentaliashistoryevent-startdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoutingConfiguration": { "MarkdownDocumentation": "`RoutingConfiguration`\n\nContains details about the version of the agent with which the alias is associated.\n*Required*: No\n*Type*: Array of [AgentAliasRoutingConfigurationListItem](./aws-properties-bedrock-agentalias-agentaliasroutingconfigurationlistitem.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliashistoryevent.html#cfn-bedrock-agentalias-agentaliashistoryevent-routingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AgentAliasRoutingConfigurationListItem", "DuplicatesAllowed": true }, "EndDate": { "MarkdownDocumentation": "`EndDate`\n\nThe date that the alias stopped being associated to the version in the `routingConfiguration` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliashistoryevent.html#cfn-bedrock-agentalias-agentaliashistoryevent-enddate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::AgentAlias.AgentAliasRoutingConfigurationListItem": { "MarkdownDocumentation": "`AWS::Bedrock::AgentAlias.AgentAliasRoutingConfigurationListItem`\n\nContains details about the routing configuration of the alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliasroutingconfigurationlistitem.html", "Properties": { "AgentVersion": { "MarkdownDocumentation": "`AgentVersion`\n\nThe version of the agent with which the alias is associated.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agentalias-agentaliasroutingconfigurationlistitem.html#cfn-bedrock-agentalias-agentaliasroutingconfigurationlistitem-agentversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::ApplicationInferenceProfile.InferenceProfileModel": { "MarkdownDocumentation": "`AWS::Bedrock::ApplicationInferenceProfile.InferenceProfileModel`\n\nContains information about a model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-applicationinferenceprofile-inferenceprofilemodel.html", "Properties": { "ModelArn": { "MarkdownDocumentation": "`ModelArn`\n\nThe Amazon Resource Name (ARN) of the model.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-applicationinferenceprofile-inferenceprofilemodel.html#cfn-bedrock-applicationinferenceprofile-inferenceprofilemodel-modelarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::ApplicationInferenceProfile.InferenceProfileModelSource": { "MarkdownDocumentation": "`AWS::Bedrock::ApplicationInferenceProfile.InferenceProfileModelSource`\n\nContains information about the model or system-defined inference profile that is the source for an inference profile..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-applicationinferenceprofile-inferenceprofilemodelsource.html", "Properties": { "CopyFrom": { "MarkdownDocumentation": "`CopyFrom`\n\nThe ARN of the model or system-defined inference profile that is the source for the inference profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|foundation-model)/[a-zA-Z0-9-:.]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-applicationinferenceprofile-inferenceprofilemodelsource.html#cfn-bedrock-applicationinferenceprofile-inferenceprofilemodelsource-copyfrom", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinition": { "MarkdownDocumentation": "`AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinition`\n\nThe complete policy definition containing rules, variables, and types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinition.html", "Properties": { "Variables": { "MarkdownDocumentation": "`Variables`\n\nThe variables used within the policy definition.\n*Required*: No\n*Type*: Array of [PolicyDefinitionVariable](./aws-properties-bedrock-automatedreasoningpolicy-policydefinitionvariable.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinition.html#cfn-bedrock-automatedreasoningpolicy-policydefinition-variables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PolicyDefinitionVariable", "DuplicatesAllowed": true }, "Types": { "MarkdownDocumentation": "`Types`\n\nThe custom types defined within the policy definition.\n*Required*: No\n*Type*: Array of [PolicyDefinitionType](./aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontype.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinition.html#cfn-bedrock-automatedreasoningpolicy-policydefinition-types", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PolicyDefinitionType", "DuplicatesAllowed": true }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of the policy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinition.html#cfn-bedrock-automatedreasoningpolicy-policydefinition-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe collection of rules that define the policy logic.\n*Required*: No\n*Type*: Array of [PolicyDefinitionRule](./aws-properties-bedrock-automatedreasoningpolicy-policydefinitionrule.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinition.html#cfn-bedrock-automatedreasoningpolicy-policydefinition-rules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PolicyDefinitionRule", "DuplicatesAllowed": true } } }, "AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinitionRule": { "MarkdownDocumentation": "`AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinitionRule`\n\nA rule within the policy definition that defines logical constraints.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitionrule.html", "Properties": { "AlternateExpression": { "MarkdownDocumentation": "`AlternateExpression`\n\nAn alternative expression for the policy rule.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitionrule.html#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-alternateexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe logical expression that defines the rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitionrule.html#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe unique identifier for the policy definition rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z][0-9A-Z]{11}$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitionrule.html#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinitionType": { "MarkdownDocumentation": "`AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinitionType`\n\nA custom type definition within the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontype.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the custom type defined in the policy.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontype.html#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe possible values for a custom type defined in the policy.\n*Required*: Yes\n*Type*: Array of [PolicyDefinitionTypeValue](./aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontypevalue.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontype.html#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PolicyDefinitionTypeValue", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a custom type defined in the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z][A-Za-z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontype.html#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinitionTypeValue": { "MarkdownDocumentation": "`AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinitionTypeValue`\n\nA value associated with a custom type in the policy definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontypevalue.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the policy definition type value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontypevalue.html#cfn-bedrock-automatedreasoningpolicy-policydefinitiontypevalue-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value associated with a policy definition type.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z][A-Za-z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontypevalue.html#cfn-bedrock-automatedreasoningpolicy-policydefinitiontypevalue-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinitionVariable": { "MarkdownDocumentation": "`AWS::Bedrock::AutomatedReasoningPolicy.PolicyDefinitionVariable`\n\nA variable defined within the policy that can be used in rules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitionvariable.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe data type of a variable defined in the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z][A-Za-z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitionvariable.html#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of a variable defined in the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitionvariable.html#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a variable defined in the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z][A-Za-z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-automatedreasoningpolicy-policydefinitionvariable.html#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.BedrockDataAutomationConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.BedrockDataAutomationConfiguration`\n\nContains configurations for using Amazon Bedrock Data Automation as the parser for ingesting your data sources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockdataautomationconfiguration.html", "Properties": { "ParsingModality": { "MarkdownDocumentation": "`ParsingModality`\n\nSpecifies whether to enable parsing of multimodal data, including both text and/or images.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTIMODAL`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "MULTIMODAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockdataautomationconfiguration.html#cfn-bedrock-datasource-bedrockdataautomationconfiguration-parsingmodality", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.BedrockFoundationModelConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.BedrockFoundationModelConfiguration`\n\nSettings for a foundation model used to parse documents for a data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html", "Properties": { "ModelArn": { "MarkdownDocumentation": "`ModelArn`\n\nThe ARN of the foundation model to use for parsing.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-modelarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ParsingModality": { "MarkdownDocumentation": "`ParsingModality`\n\nSpecifies whether to enable parsing of multimodal data, including both text and/or images.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTIMODAL`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "MULTIMODAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-parsingmodality", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ParsingPrompt": { "MarkdownDocumentation": "`ParsingPrompt`\n\nInstructions for interpreting the contents of a document.\n*Required*: No\n*Type*: [ParsingPrompt](./aws-properties-bedrock-datasource-parsingprompt.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-parsingprompt", "UpdateType": "Immutable", "Required": false, "Type": "ParsingPrompt" } } }, "AWS::Bedrock::DataSource.BedrockFoundationModelContextEnrichmentConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.BedrockFoundationModelContextEnrichmentConfiguration`\n\nContext enrichment configuration is used to provide additional context to the RAG application\nusing Amazon Bedrock foundation models.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration.html", "Properties": { "EnrichmentStrategyConfiguration": { "MarkdownDocumentation": "`EnrichmentStrategyConfiguration`\n\nThe enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses\nAmazon Bedrock foundation models to perform chunk entity extraction.\n*Required*: Yes\n*Type*: [EnrichmentStrategyConfiguration](./aws-properties-bedrock-datasource-enrichmentstrategyconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration-enrichmentstrategyconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "EnrichmentStrategyConfiguration" }, "ModelArn": { "MarkdownDocumentation": "`ModelArn`\n\nThe Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration-modelarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.ChunkingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.ChunkingConfiguration`\n\nDetails about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html", "Properties": { "ChunkingStrategy": { "MarkdownDocumentation": "`ChunkingStrategy`\n\nKnowledge base can split your source data into chunks. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for `NONE`, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.\n* `FIXED_SIZE` \u2013 Amazon Bedrock splits your source data into chunks of the approximate size that you set in the `fixedSizeChunkingConfiguration`.\n* `HIERARCHICAL` \u2013 Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.\n* `SEMANTIC` \u2013 Split documents into chunks based on groups of similar content derived with natural language processing.\n* `NONE` \u2013 Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIXED_SIZE | NONE | HIERARC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-chunkingstrategy", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FixedSizeChunkingConfiguration": { "MarkdownDocumentation": "`FixedSizeChunkingConfiguration`\n\nConfigurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE`, exclude this field.\n*Required*: No\n*Type*: [FixedSizeChunkingConfiguration](./aws-properties-bedrock-datasource-fixedsizechunkingconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-fixedsizechunkingconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "FixedSizeChunkingConfiguration" }, "SemanticChunkingConfiguration": { "MarkdownDocumentation": "`SemanticChunkingConfiguration`\n\nSettings for semantic document chunking for a data source. Semantic chunking splits\na document into into smaller documents based on groups of similar content derived from the text\nwith natural language processing.\n*Required*: No\n*Type*: [SemanticChunkingConfiguration](./aws-properties-bedrock-datasource-semanticchunkingconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-semanticchunkingconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "SemanticChunkingConfiguration" }, "HierarchicalChunkingConfiguration": { "MarkdownDocumentation": "`HierarchicalChunkingConfiguration`\n\nSettings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\ninto layers of chunks where the first layer contains large chunks, and the second layer contains smaller\nchunks derived from the first layer.\n*Required*: No\n*Type*: [HierarchicalChunkingConfiguration](./aws-properties-bedrock-datasource-hierarchicalchunkingconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-hierarchicalchunkingconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "HierarchicalChunkingConfiguration" } } }, "AWS::Bedrock::DataSource.ConfluenceCrawlerConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.ConfluenceCrawlerConfiguration`\n\nThe configuration of the Confluence content. For example, configuring specific\ntypes of Confluence content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencecrawlerconfiguration.html", "Properties": { "FilterConfiguration": { "MarkdownDocumentation": "`FilterConfiguration`\n\nThe configuration of filtering the Confluence content. For example, configuring\nregular expression patterns to include or exclude certain content.\n*Required*: No\n*Type*: [CrawlFilterConfiguration](./aws-properties-bedrock-datasource-crawlfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencecrawlerconfiguration.html#cfn-bedrock-datasource-confluencecrawlerconfiguration-filterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CrawlFilterConfiguration" } } }, "AWS::Bedrock::DataSource.ConfluenceDataSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.ConfluenceDataSourceConfiguration`\n\nThe configuration information to connect to Confluence as your data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencedatasourceconfiguration.html", "Properties": { "SourceConfiguration": { "MarkdownDocumentation": "`SourceConfiguration`\n\nThe endpoint information to connect to your Confluence data source.\n*Required*: Yes\n*Type*: [ConfluenceSourceConfiguration](./aws-properties-bedrock-datasource-confluencesourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencedatasourceconfiguration.html#cfn-bedrock-datasource-confluencedatasourceconfiguration-sourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ConfluenceSourceConfiguration" }, "CrawlerConfiguration": { "MarkdownDocumentation": "`CrawlerConfiguration`\n\nThe configuration of the Confluence content. For example, configuring\nspecific types of Confluence content.\n*Required*: No\n*Type*: [ConfluenceCrawlerConfiguration](./aws-properties-bedrock-datasource-confluencecrawlerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencedatasourceconfiguration.html#cfn-bedrock-datasource-confluencedatasourceconfiguration-crawlerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ConfluenceCrawlerConfiguration" } } }, "AWS::Bedrock::DataSource.ConfluenceSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.ConfluenceSourceConfiguration`\n\nThe endpoint information to connect to your Confluence data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencesourceconfiguration.html", "Properties": { "HostUrl": { "MarkdownDocumentation": "`HostUrl`\n\nThe Confluence host URL or instance URL.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https://[A-Za-z0-9][^\\s]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencesourceconfiguration.html#cfn-bedrock-datasource-confluencesourceconfiguration-hosturl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HostType": { "MarkdownDocumentation": "`HostType`\n\nThe supported host type, whether online/cloud or server/on-premises.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SAAS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "SAAS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencesourceconfiguration.html#cfn-bedrock-datasource-confluencesourceconfiguration-hosttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nThe supported authentication type to authenticate and connect to your\nConfluence instance.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BASIC | OAUTH2_CLIENT_CREDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "OAUTH2_CLIENT_CREDENTIALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencesourceconfiguration.html#cfn-bedrock-datasource-confluencesourceconfiguration-authtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CredentialsSecretArn": { "MarkdownDocumentation": "`CredentialsSecretArn`\n\nThe Amazon Resource Name of an AWS Secrets Manager secret that\nstores your authentication credentials for your Confluence instance URL.\nFor more information on the key-value pairs that must be included in\nyour secret, depending on your authentication type, see\n[Confluence connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-confluencesourceconfiguration.html#cfn-bedrock-datasource-confluencesourceconfiguration-credentialssecretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.ContextEnrichmentConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.ContextEnrichmentConfiguration`\n\nContext enrichment configuration is used to provide additional context to the RAG application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-contextenrichmentconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe method used for context enrichment. It must be Amazon Bedrock foundation models.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BEDROCK_FOUNDATION_MODEL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BEDROCK_FOUNDATION_MODEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-contextenrichmentconfiguration.html#cfn-bedrock-datasource-contextenrichmentconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BedrockFoundationModelConfiguration": { "MarkdownDocumentation": "`BedrockFoundationModelConfiguration`\n\nThe configuration of the Amazon Bedrock foundation model used for context enrichment.\n*Required*: No\n*Type*: [BedrockFoundationModelContextEnrichmentConfiguration](./aws-properties-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-contextenrichmentconfiguration.html#cfn-bedrock-datasource-contextenrichmentconfiguration-bedrockfoundationmodelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BedrockFoundationModelContextEnrichmentConfiguration" } } }, "AWS::Bedrock::DataSource.CrawlFilterConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.CrawlFilterConfiguration`\n\nThe configuration of filtering the data source content. For example,\nconfiguring regular expression patterns to include or exclude certain content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-crawlfilterconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of filtering that you want to apply to certain objects or content of the\ndata source. For example, the `PATTERN` type is regular expression patterns\nyou can apply to filter your content.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PATTERN`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "PATTERN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-crawlfilterconfiguration.html#cfn-bedrock-datasource-crawlfilterconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PatternObjectFilter": { "MarkdownDocumentation": "`PatternObjectFilter`\n\nThe configuration of filtering certain objects or content types of the data source.\n*Required*: No\n*Type*: [PatternObjectFilterConfiguration](./aws-properties-bedrock-datasource-patternobjectfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-crawlfilterconfiguration.html#cfn-bedrock-datasource-crawlfilterconfiguration-patternobjectfilter", "UpdateType": "Mutable", "Required": false, "Type": "PatternObjectFilterConfiguration" } } }, "AWS::Bedrock::DataSource.CustomTransformationConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.CustomTransformationConfiguration`\n\nSettings for customizing steps in the data source content ingestion pipeline.\nYou can configure the data source to process documents with a Lambda function after\nthey are parsed and converted into chunks. When you add a post-chunking transformation,\nthe service stores chunked documents in an S3 bucket and invokes a Lambda function to process\nthem.\nTo process chunked documents with a Lambda function, define an S3 bucket path for input\nand output objects, and a transformation that specifies the Lambda function to invoke. You can\nuse the Lambda function to customize how chunks are split, and the metadata for each chunk.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-customtransformationconfiguration.html", "Properties": { "IntermediateStorage": { "MarkdownDocumentation": "`IntermediateStorage`\n\nAn S3 bucket path for input and output objects.\n*Required*: Yes\n*Type*: [IntermediateStorage](./aws-properties-bedrock-datasource-intermediatestorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-customtransformationconfiguration.html#cfn-bedrock-datasource-customtransformationconfiguration-intermediatestorage", "UpdateType": "Mutable", "Required": true, "Type": "IntermediateStorage" }, "Transformations": { "MarkdownDocumentation": "`Transformations`\n\nA Lambda function that processes documents.\n*Required*: Yes\n*Type*: Array of [Transformation](./aws-properties-bedrock-datasource-transformation.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-customtransformationconfiguration.html#cfn-bedrock-datasource-customtransformationconfiguration-transformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Transformation", "DuplicatesAllowed": true } } }, "AWS::Bedrock::DataSource.DataSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.DataSourceConfiguration`\n\nThe connection configuration for the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of data source.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `S3 | CONFLUENCE | SALESFORC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "S3", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "WEB", "CUSTOM", "REDSHIFT_METADATA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html#cfn-bedrock-datasource-datasourceconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nThe configuration information to connect to Amazon S3 as your data source.\n*Required*: No\n*Type*: [S3DataSourceConfiguration](./aws-properties-bedrock-datasource-s3datasourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html#cfn-bedrock-datasource-datasourceconfiguration-s3configuration", "UpdateType": "Mutable", "Required": false, "Type": "S3DataSourceConfiguration" }, "SalesforceConfiguration": { "MarkdownDocumentation": "`SalesforceConfiguration`\n\nThe configuration information to connect to Salesforce as your data source.\n###### Note\nSalesforce data source connector is in preview release and is subject to change.\n*Required*: No\n*Type*: [SalesforceDataSourceConfiguration](./aws-properties-bedrock-datasource-salesforcedatasourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html#cfn-bedrock-datasource-datasourceconfiguration-salesforceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SalesforceDataSourceConfiguration" }, "ConfluenceConfiguration": { "MarkdownDocumentation": "`ConfluenceConfiguration`\n\nThe configuration information to connect to Confluence as your data source.\n###### Note\nConfluence data source connector is in preview release and is subject to change.\n*Required*: No\n*Type*: [ConfluenceDataSourceConfiguration](./aws-properties-bedrock-datasource-confluencedatasourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html#cfn-bedrock-datasource-datasourceconfiguration-confluenceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ConfluenceDataSourceConfiguration" }, "SharePointConfiguration": { "MarkdownDocumentation": "`SharePointConfiguration`\n\nThe configuration information to connect to SharePoint as your data source.\n###### Note\nSharePoint data source connector is in preview release and is subject to change.\n*Required*: No\n*Type*: [SharePointDataSourceConfiguration](./aws-properties-bedrock-datasource-sharepointdatasourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html#cfn-bedrock-datasource-datasourceconfiguration-sharepointconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SharePointDataSourceConfiguration" }, "WebConfiguration": { "MarkdownDocumentation": "`WebConfiguration`\n\nThe configuration of web URLs to crawl for your data source.\nYou should be authorized to crawl the URLs.\n###### Note\nCrawling web URLs as your data source is in preview release\nand is subject to change.\n*Required*: No\n*Type*: [WebDataSourceConfiguration](./aws-properties-bedrock-datasource-webdatasourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html#cfn-bedrock-datasource-datasourceconfiguration-webconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WebDataSourceConfiguration" } } }, "AWS::Bedrock::DataSource.EnrichmentStrategyConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.EnrichmentStrategyConfiguration`\n\nThe strategy used for performing context enrichment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-enrichmentstrategyconfiguration.html", "Properties": { "Method": { "MarkdownDocumentation": "`Method`\n\nThe method used for the context enrichment strategy.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CHUNK_ENTITY_EXTRACTION...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CHUNK_ENTITY_EXTRACTION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-enrichmentstrategyconfiguration.html#cfn-bedrock-datasource-enrichmentstrategyconfiguration-method", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.FixedSizeChunkingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.FixedSizeChunkingConfiguration`\n\nConfigurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE`, exclude this field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-fixedsizechunkingconfiguration.html", "Properties": { "OverlapPercentage": { "MarkdownDocumentation": "`OverlapPercentage`\n\nThe percentage of overlap between adjacent chunks of a data source.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `99`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-fixedsizechunkingconfiguration.html#cfn-bedrock-datasource-fixedsizechunkingconfiguration-overlappercentage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "MaxTokens": { "MarkdownDocumentation": "`MaxTokens`\n\nThe maximum number of tokens to include in a chunk.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-fixedsizechunkingconfiguration.html#cfn-bedrock-datasource-fixedsizechunkingconfiguration-maxtokens", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Bedrock::DataSource.HierarchicalChunkingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.HierarchicalChunkingConfiguration`\n\nSettings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\ninto layers of chunks where the first layer contains large chunks, and the second layer contains smaller\nchunks derived from the first layer.\nYou configure the number of tokens to overlap, or repeat across adjacent chunks. For example,\nif you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of\nthe second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-hierarchicalchunkingconfiguration.html", "Properties": { "OverlapTokens": { "MarkdownDocumentation": "`OverlapTokens`\n\nThe number of tokens to repeat across chunks in the same layer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-hierarchicalchunkingconfiguration.html#cfn-bedrock-datasource-hierarchicalchunkingconfiguration-overlaptokens", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "LevelConfigurations": { "MarkdownDocumentation": "`LevelConfigurations`\n\nToken settings for each layer.\n*Required*: Yes\n*Type*: Array of [HierarchicalChunkingLevelConfiguration](./aws-properties-bedrock-datasource-hierarchicalchunkinglevelconfiguration.html)\n*Minimum*: `2`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-hierarchicalchunkingconfiguration.html#cfn-bedrock-datasource-hierarchicalchunkingconfiguration-levelconfigurations", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "HierarchicalChunkingLevelConfiguration", "DuplicatesAllowed": true } } }, "AWS::Bedrock::DataSource.HierarchicalChunkingLevelConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.HierarchicalChunkingLevelConfiguration`\n\nToken settings for a layer in a hierarchical chunking configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-hierarchicalchunkinglevelconfiguration.html", "Properties": { "MaxTokens": { "MarkdownDocumentation": "`MaxTokens`\n\nThe maximum number of tokens that a chunk can contain in this layer.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `8192`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-hierarchicalchunkinglevelconfiguration.html#cfn-bedrock-datasource-hierarchicalchunkinglevelconfiguration-maxtokens", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Bedrock::DataSource.IntermediateStorage": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.IntermediateStorage`\n\nA location for storing content from data sources temporarily as it is processed by\ncustom components in the ingestion pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-intermediatestorage.html", "Properties": { "S3Location": { "MarkdownDocumentation": "`S3Location`\n\nAn S3 bucket path.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-bedrock-datasource-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-intermediatestorage.html#cfn-bedrock-datasource-intermediatestorage-s3location", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" } } }, "AWS::Bedrock::DataSource.ParsingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.ParsingConfiguration`\n\nSettings for parsing document contents. If you exclude this field, the default parser converts the contents of each\ndocument into text before splitting it into chunks. Specify the parsing strategy to use in the `parsingStrategy` field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see [Parsing options for your data source](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html).\n###### Note\nIf you specify `BEDROCK_DATA_AUTOMATION` or `BEDROCK_FOUNDATION_MODEL` and it fails to parse a file, the Amazon Bedrock default parser will be used instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-parsingconfiguration.html", "Properties": { "BedrockDataAutomationConfiguration": { "MarkdownDocumentation": "`BedrockDataAutomationConfiguration`\n\nIf you specify `BEDROCK_DATA_AUTOMATION` as the parsing strategy for ingesting your data source, use this object to modify configurations for using the Amazon Bedrock Data Automation parser.\n*Required*: No\n*Type*: [BedrockDataAutomationConfiguration](./aws-properties-bedrock-datasource-bedrockdataautomationconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-parsingconfiguration.html#cfn-bedrock-datasource-parsingconfiguration-bedrockdataautomationconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "BedrockDataAutomationConfiguration" }, "BedrockFoundationModelConfiguration": { "MarkdownDocumentation": "`BedrockFoundationModelConfiguration`\n\nIf you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents.\n*Required*: No\n*Type*: [BedrockFoundationModelConfiguration](./aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-parsingconfiguration.html#cfn-bedrock-datasource-parsingconfiguration-bedrockfoundationmodelconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "BedrockFoundationModelConfiguration" }, "ParsingStrategy": { "MarkdownDocumentation": "`ParsingStrategy`\n\nThe parsing strategy for the data source.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BEDROCK_FOUNDATION_MODEL | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "BEDROCK_FOUNDATION_MODEL", "BEDROCK_DATA_AUTOMATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-parsingconfiguration.html#cfn-bedrock-datasource-parsingconfiguration-parsingstrategy", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.ParsingPrompt": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.ParsingPrompt`\n\nInstructions for interpreting the contents of a document.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-parsingprompt.html", "Properties": { "ParsingPromptText": { "MarkdownDocumentation": "`ParsingPromptText`\n\nInstructions for interpreting the contents of a document.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `10000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-parsingprompt.html#cfn-bedrock-datasource-parsingprompt-parsingprompttext", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.PatternObjectFilter": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.PatternObjectFilter`\n\nThe specific filters applied to your data source content. You can filter out or\ninclude certain content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-patternobjectfilter.html", "Properties": { "ObjectType": { "MarkdownDocumentation": "`ObjectType`\n\nThe supported object type or content type of the data source.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-patternobjectfilter.html#cfn-bedrock-datasource-patternobjectfilter-objecttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InclusionFilters": { "MarkdownDocumentation": "`InclusionFilters`\n\nA list of one or more inclusion regular expression patterns to include certain\nobject types that adhere to the pattern. If you specify an inclusion and exclusion\nfilter/pattern and both match a document, the exclusion filter takes precedence\nand the document isn\u2019t crawled.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1000 | 25`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-patternobjectfilter.html#cfn-bedrock-datasource-patternobjectfilter-inclusionfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExclusionFilters": { "MarkdownDocumentation": "`ExclusionFilters`\n\nA list of one or more exclusion regular expression patterns to exclude certain\nobject types that adhere to the pattern. If you specify an inclusion and exclusion\nfilter/pattern and both match a document, the exclusion filter takes precedence\nand the document isn\u2019t crawled.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1000 | 25`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-patternobjectfilter.html#cfn-bedrock-datasource-patternobjectfilter-exclusionfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Bedrock::DataSource.PatternObjectFilterConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.PatternObjectFilterConfiguration`\n\nThe configuration of filtering certain objects or content types of the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-patternobjectfilterconfiguration.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe configuration of specific filters applied to your data source content. You can\nfilter out or include certain content.\n*Required*: Yes\n*Type*: Array of [PatternObjectFilter](./aws-properties-bedrock-datasource-patternobjectfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-patternobjectfilterconfiguration.html#cfn-bedrock-datasource-patternobjectfilterconfiguration-filters", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PatternObjectFilter", "DuplicatesAllowed": true } } }, "AWS::Bedrock::DataSource.S3DataSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.S3DataSourceConfiguration`\n\nThe configuration information to connect to Amazon S3 as your data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html", "Properties": { "BucketArn": { "MarkdownDocumentation": "`BucketArn`\n\nThe Amazon Resource Name (ARN) of the S3 bucket that contains your data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html#cfn-bedrock-datasource-s3datasourceconfiguration-bucketarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketOwnerAccountId": { "MarkdownDocumentation": "`BucketOwnerAccountId`\n\nThe account ID for the owner of the S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html#cfn-bedrock-datasource-s3datasourceconfiguration-bucketowneraccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InclusionPrefixes": { "MarkdownDocumentation": "`InclusionPrefixes`\n\nA list of S3 prefixes to include certain files or content. This field is an array with\na maximum of one item, which can contain a string that has a maximum length of 300\ncharacters. For more information, see [Organizing objects using\nprefixes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html).\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `300 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html#cfn-bedrock-datasource-s3datasourceconfiguration-inclusionprefixes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Bedrock::DataSource.S3Location": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.S3Location`\n\nA storage location in an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3location.html", "Properties": { "URI": { "MarkdownDocumentation": "`URI`\n\nAn object URI starting with `s3://`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^s3://.{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3location.html#cfn-bedrock-datasource-s3location-uri", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.SalesforceCrawlerConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.SalesforceCrawlerConfiguration`\n\nThe configuration of the Salesforce content. For example, configuring\nspecific types of Salesforce content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcecrawlerconfiguration.html", "Properties": { "FilterConfiguration": { "MarkdownDocumentation": "`FilterConfiguration`\n\nThe configuration of filtering the Salesforce content. For example,\nconfiguring regular expression patterns to include or exclude certain\ncontent.\n*Required*: No\n*Type*: [CrawlFilterConfiguration](./aws-properties-bedrock-datasource-crawlfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcecrawlerconfiguration.html#cfn-bedrock-datasource-salesforcecrawlerconfiguration-filterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CrawlFilterConfiguration" } } }, "AWS::Bedrock::DataSource.SalesforceDataSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.SalesforceDataSourceConfiguration`\n\nThe configuration information to connect to Salesforce as your data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcedatasourceconfiguration.html", "Properties": { "SourceConfiguration": { "MarkdownDocumentation": "`SourceConfiguration`\n\nThe endpoint information to connect to your Salesforce data source.\n*Required*: Yes\n*Type*: [SalesforceSourceConfiguration](./aws-properties-bedrock-datasource-salesforcesourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcedatasourceconfiguration.html#cfn-bedrock-datasource-salesforcedatasourceconfiguration-sourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "SalesforceSourceConfiguration" }, "CrawlerConfiguration": { "MarkdownDocumentation": "`CrawlerConfiguration`\n\nThe configuration of the Salesforce content. For example, configuring\nspecific types of Salesforce content.\n*Required*: No\n*Type*: [SalesforceCrawlerConfiguration](./aws-properties-bedrock-datasource-salesforcecrawlerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcedatasourceconfiguration.html#cfn-bedrock-datasource-salesforcedatasourceconfiguration-crawlerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SalesforceCrawlerConfiguration" } } }, "AWS::Bedrock::DataSource.SalesforceSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.SalesforceSourceConfiguration`\n\nThe endpoint information to connect to your Salesforce data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcesourceconfiguration.html", "Properties": { "HostUrl": { "MarkdownDocumentation": "`HostUrl`\n\nThe Salesforce host URL or instance URL.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https://[A-Za-z0-9][^\\s]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcesourceconfiguration.html#cfn-bedrock-datasource-salesforcesourceconfiguration-hosturl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nThe supported authentication type to authenticate and connect to your\nSalesforce instance.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OAUTH2_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)", "RefReturnValue": "", "AllowedValues": [ "OAUTH2_CLIENT_CREDENTIALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcesourceconfiguration.html#cfn-bedrock-datasource-salesforcesourceconfiguration-authtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CredentialsSecretArn": { "MarkdownDocumentation": "`CredentialsSecretArn`\n\nThe Amazon Resource Name of an AWS Secrets Manager secret that\nstores your authentication credentials for your Salesforce instance URL.\nFor more information on the key-value pairs that must be included in\nyour secret, depending on your authentication type, see\n[Salesforce connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-salesforcesourceconfiguration.html#cfn-bedrock-datasource-salesforcesourceconfiguration-credentialssecretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.SeedUrl": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.SeedUrl`\n\nThe seed or starting point URL.\nYou should be authorized to crawl the URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-seedurl.html", "Properties": { "Url": { "MarkdownDocumentation": "`Url`\n\nA seed or starting point URL.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https?://[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-seedurl.html#cfn-bedrock-datasource-seedurl-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.SemanticChunkingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.SemanticChunkingConfiguration`\n\nSettings for semantic document chunking for a data source. Semantic chunking splits\na document into into smaller documents based on groups of similar content derived from the text\nwith natural language processing.\nWith semantic chunking, each sentence is compared to the next to determine how similar they are.\nYou specify a threshold in the form of a percentile, where adjacent sentences that are less similar than\nthat percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to\n90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences,\n100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These\nchunks are further split if they exceed the max token size.\nYou must also specify a buffer size, which determines whether sentences are compared in isolation, or\nwithin a moving context window that includes the previous and following sentence. For example, if you set\nthe buffer size to `1`, the embedding for sentence 10 is derived from sentences 9, 10, and 11\ncombined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-semanticchunkingconfiguration.html", "Properties": { "BufferSize": { "MarkdownDocumentation": "`BufferSize`\n\nThe buffer size.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-semanticchunkingconfiguration.html#cfn-bedrock-datasource-semanticchunkingconfiguration-buffersize", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "MaxTokens": { "MarkdownDocumentation": "`MaxTokens`\n\nThe maximum number of tokens that a chunk can contain.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-semanticchunkingconfiguration.html#cfn-bedrock-datasource-semanticchunkingconfiguration-maxtokens", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "BreakpointPercentileThreshold": { "MarkdownDocumentation": "`BreakpointPercentileThreshold`\n\nThe dissimilarity threshold for splitting chunks.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `50`\n*Maximum*: `99`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-semanticchunkingconfiguration.html#cfn-bedrock-datasource-semanticchunkingconfiguration-breakpointpercentilethreshold", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Bedrock::DataSource.ServerSideEncryptionConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.ServerSideEncryptionConfiguration`\n\nContains the configuration for server-side encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-serversideencryptionconfiguration.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-serversideencryptionconfiguration.html#cfn-bedrock-datasource-serversideencryptionconfiguration-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.SharePointCrawlerConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.SharePointCrawlerConfiguration`\n\nThe configuration of the SharePoint content. For example, configuring\nspecific types of SharePoint content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointcrawlerconfiguration.html", "Properties": { "FilterConfiguration": { "MarkdownDocumentation": "`FilterConfiguration`\n\nThe configuration of filtering the SharePoint content. For example,\nconfiguring regular expression patterns to include or exclude certain content.\n*Required*: No\n*Type*: [CrawlFilterConfiguration](./aws-properties-bedrock-datasource-crawlfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointcrawlerconfiguration.html#cfn-bedrock-datasource-sharepointcrawlerconfiguration-filterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CrawlFilterConfiguration" } } }, "AWS::Bedrock::DataSource.SharePointDataSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.SharePointDataSourceConfiguration`\n\nThe configuration information to connect to SharePoint as your data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointdatasourceconfiguration.html", "Properties": { "SourceConfiguration": { "MarkdownDocumentation": "`SourceConfiguration`\n\nThe endpoint information to connect to your SharePoint data source.\n*Required*: Yes\n*Type*: [SharePointSourceConfiguration](./aws-properties-bedrock-datasource-sharepointsourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointdatasourceconfiguration.html#cfn-bedrock-datasource-sharepointdatasourceconfiguration-sourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "SharePointSourceConfiguration" }, "CrawlerConfiguration": { "MarkdownDocumentation": "`CrawlerConfiguration`\n\nThe configuration of the SharePoint content. For example, configuring\nspecific types of SharePoint content.\n*Required*: No\n*Type*: [SharePointCrawlerConfiguration](./aws-properties-bedrock-datasource-sharepointcrawlerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointdatasourceconfiguration.html#cfn-bedrock-datasource-sharepointdatasourceconfiguration-crawlerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SharePointCrawlerConfiguration" } } }, "AWS::Bedrock::DataSource.SharePointSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.SharePointSourceConfiguration`\n\nThe endpoint information to connect to your SharePoint data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointsourceconfiguration.html", "Properties": { "SiteUrls": { "MarkdownDocumentation": "`SiteUrls`\n\nA list of one or more SharePoint site URLs.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointsourceconfiguration.html#cfn-bedrock-datasource-sharepointsourceconfiguration-siteurls", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "HostType": { "MarkdownDocumentation": "`HostType`\n\nThe supported host type, whether online/cloud or server/on-premises.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ONLINE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ONLINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointsourceconfiguration.html#cfn-bedrock-datasource-sharepointsourceconfiguration-hosttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TenantId": { "MarkdownDocumentation": "`TenantId`\n\nThe identifier of your Microsoft 365 tenant.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointsourceconfiguration.html#cfn-bedrock-datasource-sharepointsourceconfiguration-tenantid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nThe supported authentication type to authenticate and connect\nto your SharePoint site/sites.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OAUTH2_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)", "RefReturnValue": "", "AllowedValues": [ "OAUTH2_CLIENT_CREDENTIALS", "OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointsourceconfiguration.html#cfn-bedrock-datasource-sharepointsourceconfiguration-authtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CredentialsSecretArn": { "MarkdownDocumentation": "`CredentialsSecretArn`\n\nThe Amazon Resource Name of an AWS Secrets Manager secret that\nstores your authentication credentials for your SharePoint site/sites.\nFor more information on the key-value pairs that must be included in\nyour secret, depending on your authentication type, see\n[SharePoint connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointsourceconfiguration.html#cfn-bedrock-datasource-sharepointsourceconfiguration-credentialssecretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe domain of your SharePoint instance or site URL/URLs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-sharepointsourceconfiguration.html#cfn-bedrock-datasource-sharepointsourceconfiguration-domain", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.Transformation": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.Transformation`\n\nA custom processing step for documents moving through a data source ingestion pipeline. To\nprocess documents after they have been converted into chunks, set the step to apply to\n`POST_CHUNKING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-transformation.html", "Properties": { "StepToApply": { "MarkdownDocumentation": "`StepToApply`\n\nWhen the service applies the transformation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `POST_CHUNKING...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POST_CHUNKING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-transformation.html#cfn-bedrock-datasource-transformation-steptoapply", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TransformationFunction": { "MarkdownDocumentation": "`TransformationFunction`\n\nA Lambda function that processes documents.\n*Required*: Yes\n*Type*: [TransformationFunction](./aws-properties-bedrock-datasource-transformationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-transformation.html#cfn-bedrock-datasource-transformation-transformationfunction", "UpdateType": "Mutable", "Required": true, "Type": "TransformationFunction" } } }, "AWS::Bedrock::DataSource.TransformationFunction": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.TransformationFunction`\n\nA Lambda function that processes documents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-transformationfunction.html", "Properties": { "TransformationLambdaConfiguration": { "MarkdownDocumentation": "`TransformationLambdaConfiguration`\n\nThe Lambda function.\n*Required*: Yes\n*Type*: [TransformationLambdaConfiguration](./aws-properties-bedrock-datasource-transformationlambdaconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-transformationfunction.html#cfn-bedrock-datasource-transformationfunction-transformationlambdaconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "TransformationLambdaConfiguration" } } }, "AWS::Bedrock::DataSource.TransformationLambdaConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.TransformationLambdaConfiguration`\n\nA Lambda function that processes documents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-transformationlambdaconfiguration.html", "Properties": { "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe function's ARN identifier.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-transformationlambdaconfiguration.html#cfn-bedrock-datasource-transformationlambdaconfiguration-lambdaarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.UrlConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.UrlConfiguration`\n\nThe configuration of web URLs that you want to crawl.\nYou should be authorized to crawl the URLs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-urlconfiguration.html", "Properties": { "SeedUrls": { "MarkdownDocumentation": "`SeedUrls`\n\nOne or more seed or starting point URLs.\n*Required*: Yes\n*Type*: Array of [SeedUrl](./aws-properties-bedrock-datasource-seedurl.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-urlconfiguration.html#cfn-bedrock-datasource-urlconfiguration-seedurls", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SeedUrl", "DuplicatesAllowed": true } } }, "AWS::Bedrock::DataSource.VectorIngestionConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.VectorIngestionConfiguration`\n\nContains details about how to ingest the documents in a data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-vectoringestionconfiguration.html", "Properties": { "ParsingConfiguration": { "MarkdownDocumentation": "`ParsingConfiguration`\n\nConfigurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used.\n*Required*: No\n*Type*: [ParsingConfiguration](./aws-properties-bedrock-datasource-parsingconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-vectoringestionconfiguration.html#cfn-bedrock-datasource-vectoringestionconfiguration-parsingconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "ParsingConfiguration" }, "ContextEnrichmentConfiguration": { "MarkdownDocumentation": "`ContextEnrichmentConfiguration`\n\nThe context enrichment configuration used for ingestion of the data into the vector\nstore.\n*Required*: No\n*Type*: [ContextEnrichmentConfiguration](./aws-properties-bedrock-datasource-contextenrichmentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-vectoringestionconfiguration.html#cfn-bedrock-datasource-vectoringestionconfiguration-contextenrichmentconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ContextEnrichmentConfiguration" }, "CustomTransformationConfiguration": { "MarkdownDocumentation": "`CustomTransformationConfiguration`\n\nA custom document transformer for parsed data source documents.\n*Required*: No\n*Type*: [CustomTransformationConfiguration](./aws-properties-bedrock-datasource-customtransformationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-vectoringestionconfiguration.html#cfn-bedrock-datasource-vectoringestionconfiguration-customtransformationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomTransformationConfiguration" }, "ChunkingConfiguration": { "MarkdownDocumentation": "`ChunkingConfiguration`\n\nDetails about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.\n*Required*: No\n*Type*: [ChunkingConfiguration](./aws-properties-bedrock-datasource-chunkingconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-vectoringestionconfiguration.html#cfn-bedrock-datasource-vectoringestionconfiguration-chunkingconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "ChunkingConfiguration" } } }, "AWS::Bedrock::DataSource.WebCrawlerConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.WebCrawlerConfiguration`\n\nThe configuration of web URLs that you want to crawl.\nYou should be authorized to crawl the URLs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html", "Properties": { "InclusionFilters": { "MarkdownDocumentation": "`InclusionFilters`\n\nA list of one or more inclusion regular expression patterns to include\ncertain URLs. If you specify an inclusion and exclusion filter/pattern\nand both match a URL, the exclusion filter takes precedence and the web\ncontent of the URL isn\u2019t crawled.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1000 | 25`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html#cfn-bedrock-datasource-webcrawlerconfiguration-inclusionfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UserAgentHeader": { "MarkdownDocumentation": "`UserAgentHeader`\n\nA string used for identifying the crawler or bot when it accesses a web server. The user agent header value\nconsists of the `bedrockbot`, UUID, and a user agent suffix for your crawler (if one is provided).\nBy default, it is set to `bedrockbot_UUID`. You can optionally append a custom\nsuffix to `bedrockbot_UUID` to allowlist a specific user agent permitted to access your source URLs.\n*Required*: No\n*Type*: String\n*Minimum*: `61`\n*Maximum*: `86`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html#cfn-bedrock-datasource-webcrawlerconfiguration-useragentheader", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrawlerLimits": { "MarkdownDocumentation": "`CrawlerLimits`\n\nThe configuration of crawl limits for the web URLs.\n*Required*: No\n*Type*: [WebCrawlerLimits](./aws-properties-bedrock-datasource-webcrawlerlimits.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html#cfn-bedrock-datasource-webcrawlerconfiguration-crawlerlimits", "UpdateType": "Mutable", "Required": false, "Type": "WebCrawlerLimits" }, "ExclusionFilters": { "MarkdownDocumentation": "`ExclusionFilters`\n\nA list of one or more exclusion regular expression patterns to exclude\ncertain URLs. If you specify an inclusion and exclusion filter/pattern\nand both match a URL, the exclusion filter takes precedence and the web\ncontent of the URL isn\u2019t crawled.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1000 | 25`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html#cfn-bedrock-datasource-webcrawlerconfiguration-exclusionfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope of what is crawled for your URLs.\nYou can choose to crawl only web pages that belong to the same host or primary\ndomain. For example, only web pages that contain the seed URL\n\"https://docs.aws.amazon.com/bedrock/latest/userguide/\" and no other domains.\nYou can choose to include sub domains in addition to the host or primary domain.\nFor example, web pages that contain \"aws.amazon.com\" can also include sub domain\n\"docs.aws.amazon.com\".\n*Required*: No\n*Type*: String\n*Allowed values*: `HOST_ONLY | SUBDOMAINS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HOST_ONLY", "SUBDOMAINS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html#cfn-bedrock-datasource-webcrawlerconfiguration-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserAgent": { "MarkdownDocumentation": "`UserAgent`\n\nReturns the user agent suffix for your web crawler.\n*Required*: No\n*Type*: String\n*Minimum*: `15`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerconfiguration.html#cfn-bedrock-datasource-webcrawlerconfiguration-useragent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::DataSource.WebCrawlerLimits": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.WebCrawlerLimits`\n\nThe rate limits for the URLs that you want to crawl.\nYou should be authorized to crawl the URLs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerlimits.html", "Properties": { "RateLimit": { "MarkdownDocumentation": "`RateLimit`\n\nThe max rate at which pages are crawled, up to 300 per minute per host.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerlimits.html#cfn-bedrock-datasource-webcrawlerlimits-ratelimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxPages": { "MarkdownDocumentation": "`MaxPages`\n\nThe max number of web pages crawled from your source URLs, up to 25,000 pages. If\nthe web pages exceed this limit, the data source sync will fail and no web pages will be ingested.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webcrawlerlimits.html#cfn-bedrock-datasource-webcrawlerlimits-maxpages", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Bedrock::DataSource.WebDataSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.WebDataSourceConfiguration`\n\nThe configuration details for the web data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webdatasourceconfiguration.html", "Properties": { "SourceConfiguration": { "MarkdownDocumentation": "`SourceConfiguration`\n\nThe source configuration details for the web data source.\n*Required*: Yes\n*Type*: [WebSourceConfiguration](./aws-properties-bedrock-datasource-websourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webdatasourceconfiguration.html#cfn-bedrock-datasource-webdatasourceconfiguration-sourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "WebSourceConfiguration" }, "CrawlerConfiguration": { "MarkdownDocumentation": "`CrawlerConfiguration`\n\nThe Web Crawler configuration details for the web data source.\n*Required*: No\n*Type*: [WebCrawlerConfiguration](./aws-properties-bedrock-datasource-webcrawlerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-webdatasourceconfiguration.html#cfn-bedrock-datasource-webdatasourceconfiguration-crawlerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WebCrawlerConfiguration" } } }, "AWS::Bedrock::DataSource.WebSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource.WebSourceConfiguration`\n\nThe configuration of the URL/URLs for the web content that you want\nto crawl. You should be authorized to crawl the URLs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-websourceconfiguration.html", "Properties": { "UrlConfiguration": { "MarkdownDocumentation": "`UrlConfiguration`\n\nThe configuration of the URL/URLs.\n*Required*: Yes\n*Type*: [UrlConfiguration](./aws-properties-bedrock-datasource-urlconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-websourceconfiguration.html#cfn-bedrock-datasource-websourceconfiguration-urlconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "UrlConfiguration" } } }, "AWS::Bedrock::Flow.AgentFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.AgentFlowNodeConfiguration`\n\nDefines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-agentflownodeconfiguration.html", "Properties": { "AgentAliasArn": { "MarkdownDocumentation": "`AgentAliasArn`\n\nThe Amazon Resource Name (ARN) of the alias of the agent to invoke.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-agentflownodeconfiguration.html#cfn-bedrock-flow-agentflownodeconfiguration-agentaliasarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.ConditionFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.ConditionFlowNodeConfiguration`\n\nDefines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-conditionflownodeconfiguration.html", "Properties": { "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nAn array of conditions. Each member contains the name of a condition and an expression that defines the condition.\n*Required*: Yes\n*Type*: Array of [FlowCondition](./aws-properties-bedrock-flow-flowcondition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-conditionflownodeconfiguration.html#cfn-bedrock-flow-conditionflownodeconfiguration-conditions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FlowCondition", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Flow.FieldForReranking": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FieldForReranking`\n\nSpecifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-fieldforreranking.html", "Properties": { "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the metadata field to be used during the reranking process.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-fieldforreranking.html#cfn-bedrock-flow-fieldforreranking-fieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.FlowCondition": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowCondition`\n\nDefines a condition in the condition node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowcondition.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nDefines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowcondition.html#cfn-bedrock-flow-flowcondition-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the condition that you can reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowcondition.html#cfn-bedrock-flow-flowcondition-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.FlowConditionalConnectionConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowConditionalConnectionConfiguration`\n\nThe configuration of a connection between a condition node and another node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconditionalconnectionconfiguration.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nThe condition that triggers this connection. For more information about how to write conditions, see the **Condition** node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconditionalconnectionconfiguration.html#cfn-bedrock-flow-flowconditionalconnectionconfiguration-condition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.FlowConnection": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowConnection`\n\nContains information about a connection between two nodes in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnection.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nWhether the source node that the connection begins from is a condition node (`Conditional`) or not (`Data`).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Data | Conditional...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Data", "Conditional" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnection.html#cfn-bedrock-flow-flowconnection-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Target": { "MarkdownDocumentation": "`Target`\n\nThe node that the connection ends at.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnection.html#cfn-bedrock-flow-flowconnection-target", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration of the connection.\n*Required*: No\n*Type*: [FlowConnectionConfiguration](./aws-properties-bedrock-flow-flowconnectionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnection.html#cfn-bedrock-flow-flowconnection-configuration", "UpdateType": "Mutable", "Required": false, "Type": "FlowConnectionConfiguration" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe node that the connection starts at.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnection.html#cfn-bedrock-flow-flowconnection-source", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the connection that you can reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnection.html#cfn-bedrock-flow-flowconnection-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.FlowConnectionConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowConnectionConfiguration`\n\nThe configuration of the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnectionconfiguration.html", "Properties": { "Data": { "MarkdownDocumentation": "`Data`\n\nThe configuration of a connection originating from a node that isn't a Condition node.\n*Required*: No\n*Type*: [FlowDataConnectionConfiguration](./aws-properties-bedrock-flow-flowdataconnectionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnectionconfiguration.html#cfn-bedrock-flow-flowconnectionconfiguration-data", "UpdateType": "Mutable", "Required": false, "Type": "FlowDataConnectionConfiguration" }, "Conditional": { "MarkdownDocumentation": "`Conditional`\n\nThe configuration of a connection originating from a Condition node.\n*Required*: No\n*Type*: [FlowConditionalConnectionConfiguration](./aws-properties-bedrock-flow-flowconditionalconnectionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowconnectionconfiguration.html#cfn-bedrock-flow-flowconnectionconfiguration-conditional", "UpdateType": "Mutable", "Required": false, "Type": "FlowConditionalConnectionConfiguration" } } }, "AWS::Bedrock::Flow.FlowDataConnectionConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowDataConnectionConfiguration`\n\nThe configuration of a connection originating from a node that isn't a Condition node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdataconnectionconfiguration.html", "Properties": { "SourceOutput": { "MarkdownDocumentation": "`SourceOutput`\n\nThe name of the output in the source node that the connection begins from.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdataconnectionconfiguration.html#cfn-bedrock-flow-flowdataconnectionconfiguration-sourceoutput", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetInput": { "MarkdownDocumentation": "`TargetInput`\n\nThe name of the input in the target node that the connection ends at.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdataconnectionconfiguration.html#cfn-bedrock-flow-flowdataconnectionconfiguration-targetinput", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.FlowDefinition": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowDefinition`\n\nThe definition of the nodes and connections between nodes in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html", "Properties": { "Connections": { "MarkdownDocumentation": "`Connections`\n\nAn array of connection definitions in the flow.\n*Required*: No\n*Type*: Array of [FlowConnection](./aws-properties-bedrock-flow-flowconnection.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html#cfn-bedrock-flow-flowdefinition-connections", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FlowConnection", "DuplicatesAllowed": true }, "Nodes": { "MarkdownDocumentation": "`Nodes`\n\nAn array of node definitions in the flow.\n*Required*: No\n*Type*: Array of [FlowNode](./aws-properties-bedrock-flow-flownode.html)\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html#cfn-bedrock-flow-flowdefinition-nodes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FlowNode", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Flow.FlowNode": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowNode`\n\nContains configurations about a node in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownode.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of node. This value must match the name of the key that you provide in the configuration you provide in the `FlowNodeConfiguration` field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Input | Output | KnowledgeB...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Input", "Output", "KnowledgeBase", "Condition", "Lex", "Prompt", "LambdaFunction", "Agent", "Storage", "Retrieval", "Iterator", "Collector", "InlineCode", "Loop", "LoopInput", "LoopController" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownode.html#cfn-bedrock-flow-flownode-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nContains configurations for the node.\n*Required*: No\n*Type*: [FlowNodeConfiguration](./aws-properties-bedrock-flow-flownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownode.html#cfn-bedrock-flow-flownode-configuration", "UpdateType": "Mutable", "Required": false, "Type": "FlowNodeConfiguration" }, "Outputs": { "MarkdownDocumentation": "`Outputs`\n\nA list of objects, each of which contains information about an output from the node.\n*Required*: No\n*Type*: Array of [FlowNodeOutput](./aws-properties-bedrock-flow-flownodeoutput.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownode.html#cfn-bedrock-flow-flownode-outputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FlowNodeOutput", "DuplicatesAllowed": true }, "Inputs": { "MarkdownDocumentation": "`Inputs`\n\nAn array of objects, each of which contains information about an input into the node.\n*Required*: No\n*Type*: Array of [FlowNodeInput](./aws-properties-bedrock-flow-flownodeinput.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownode.html#cfn-bedrock-flow-flownode-inputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FlowNodeInput", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the node.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownode.html#cfn-bedrock-flow-flownode-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.FlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowNodeConfiguration`\n\nContains configurations for a node in your flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nContains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.\n*Required*: No\n*Type*: [ConditionFlowNodeConfiguration](./aws-properties-bedrock-flow-conditionflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-condition", "UpdateType": "Mutable", "Required": false, "Type": "ConditionFlowNodeConfiguration" }, "Retrieval": { "MarkdownDocumentation": "`Retrieval`\n\nContains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.\n*Required*: No\n*Type*: [RetrievalFlowNodeConfiguration](./aws-properties-bedrock-flow-retrievalflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-retrieval", "UpdateType": "Mutable", "Required": false, "Type": "RetrievalFlowNodeConfiguration" }, "Loop": { "MarkdownDocumentation": "`Loop`\n\nContains configurations for a DoWhile loop in your flow.\n*Required*: No\n*Type*: [LoopFlowNodeConfiguration](./aws-properties-bedrock-flow-loopflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-loop", "UpdateType": "Mutable", "Required": false, "Type": "LoopFlowNodeConfiguration" }, "Agent": { "MarkdownDocumentation": "`Agent`\n\nContains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.\n*Required*: No\n*Type*: [AgentFlowNodeConfiguration](./aws-properties-bedrock-flow-agentflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-agent", "UpdateType": "Mutable", "Required": false, "Type": "AgentFlowNodeConfiguration" }, "LambdaFunction": { "MarkdownDocumentation": "`LambdaFunction`\n\nContains configurations for a Lambda function node in your flow. Invokes an AWS Lambda function.\n*Required*: No\n*Type*: [LambdaFunctionFlowNodeConfiguration](./aws-properties-bedrock-flow-lambdafunctionflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-lambdafunction", "UpdateType": "Mutable", "Required": false, "Type": "LambdaFunctionFlowNodeConfiguration" }, "InlineCode": { "MarkdownDocumentation": "`InlineCode`\n\nContains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.\n*Required*: No\n*Type*: [InlineCodeFlowNodeConfiguration](./aws-properties-bedrock-flow-inlinecodeflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-inlinecode", "UpdateType": "Mutable", "Required": false, "Type": "InlineCodeFlowNodeConfiguration" }, "LoopController": { "MarkdownDocumentation": "`LoopController`\n\nContains controller node configurations for a DoWhile loop in your flow.\n*Required*: No\n*Type*: [LoopControllerFlowNodeConfiguration](./aws-properties-bedrock-flow-loopcontrollerflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-loopcontroller", "UpdateType": "Mutable", "Required": false, "Type": "LoopControllerFlowNodeConfiguration" }, "Input": { "MarkdownDocumentation": "`Input`\n\nContains configurations for an input flow node in your flow. The first node in the flow. `inputs` can't be specified for this node.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-input", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Storage": { "MarkdownDocumentation": "`Storage`\n\nContains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.\n*Required*: No\n*Type*: [StorageFlowNodeConfiguration](./aws-properties-bedrock-flow-storageflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-storage", "UpdateType": "Mutable", "Required": false, "Type": "StorageFlowNodeConfiguration" }, "KnowledgeBase": { "MarkdownDocumentation": "`KnowledgeBase`\n\nContains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.\n*Required*: No\n*Type*: [KnowledgeBaseFlowNodeConfiguration](./aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-knowledgebase", "UpdateType": "Mutable", "Required": false, "Type": "KnowledgeBaseFlowNodeConfiguration" }, "Output": { "MarkdownDocumentation": "`Output`\n\nContains configurations for an output flow node in your flow. The last node in the flow. `outputs` can't be specified for this node.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-output", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Iterator": { "MarkdownDocumentation": "`Iterator`\n\nContains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-iterator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Collector": { "MarkdownDocumentation": "`Collector`\n\nContains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-collector", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LoopInput": { "MarkdownDocumentation": "`LoopInput`\n\nContains input node configurations for a DoWhile loop in your flow.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-loopinput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Prompt": { "MarkdownDocumentation": "`Prompt`\n\nContains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.\n*Required*: No\n*Type*: [PromptFlowNodeConfiguration](./aws-properties-bedrock-flow-promptflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-prompt", "UpdateType": "Mutable", "Required": false, "Type": "PromptFlowNodeConfiguration" }, "Lex": { "MarkdownDocumentation": "`Lex`\n\nContains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.\n*Required*: No\n*Type*: [LexFlowNodeConfiguration](./aws-properties-bedrock-flow-lexflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeconfiguration.html#cfn-bedrock-flow-flownodeconfiguration-lex", "UpdateType": "Mutable", "Required": false, "Type": "LexFlowNodeConfiguration" } } }, "AWS::Bedrock::Flow.FlowNodeInput": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowNodeInput`\n\nContains configurations for an input in an Amazon Bedrock Flows node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeinput.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the data type of the input. If the input doesn't match this type at runtime,\na validation error will be thrown.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `String | Number | Boolean |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "String", "Number", "Boolean", "Object", "Array" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeinput.html#cfn-bedrock-flow-flownodeinput-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nSpecifies how input data flows between iterations in a DoWhile\nloop.\n* `LoopCondition` - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define\n the condition that determines if the loop should continue.\n* `ReturnValueToLoopStart` - Defines data to pass back to the start\n of the loop's next iteration. Use this category for variables that you\n want to update for each loop iteration.\n* `ExitLoop` - Defines the value that's available once the loop ends.\n Use this category to expose loop results to nodes outside the loop.\n*Required*: No\n*Type*: String\n*Allowed values*: `LoopCondition | ReturnValue...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LoopCondition", "ReturnValueToLoopStart", "ExitLoop" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeinput.html#cfn-bedrock-flow-flownodeinput-category", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nAn expression that formats the input for the node. For an explanation of how to create expressions, see [Expressions in Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeinput.html#cfn-bedrock-flow-flownodeinput-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nSpecifies a name for the input that you can reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeinput.html#cfn-bedrock-flow-flownodeinput-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.FlowNodeOutput": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowNodeOutput`\n\nContains configurations for an output from a node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeoutput.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `String | Number | Boolean |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "String", "Number", "Boolean", "Object", "Array" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeoutput.html#cfn-bedrock-flow-flownodeoutput-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the output that you can reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flownodeoutput.html#cfn-bedrock-flow-flownodeoutput-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.FlowValidation": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.FlowValidation`\n\nContains information about validation of the flow.\nThis data type is used in the following API operations:\n* [GetFlow response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html#API_agent_GetFlow_ResponseSyntax)\n* [GetFlowVersion response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowvalidation.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nA message describing the validation error.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowvalidation.html#cfn-bedrock-flow-flowvalidation-message", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.GuardrailConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.GuardrailConfiguration`\n\nConfiguration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-guardrailconfiguration.html", "Properties": { "GuardrailIdentifier": { "MarkdownDocumentation": "`GuardrailIdentifier`\n\nThe identifier for the guardrail.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-guardrailconfiguration.html#cfn-bedrock-flow-guardrailconfiguration-guardrailidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GuardrailVersion": { "MarkdownDocumentation": "`GuardrailVersion`\n\nThe version of the guardrail.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([0-9]{1,8})|(DRAFT))$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-guardrailconfiguration.html#cfn-bedrock-flow-guardrailconfiguration-guardrailversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.InlineCodeFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.InlineCodeFlowNodeConfiguration`\n\nContains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-inlinecodeflownodeconfiguration.html", "Properties": { "Language": { "MarkdownDocumentation": "`Language`\n\nThe programming language used by your inline code node.\nThe code must be valid in the programming `language` that you specify. Currently, only Python 3 (`Python_3`) is supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `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)\n", "RefReturnValue": "", "AllowedValues": [ "Python_3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-inlinecodeflownodeconfiguration.html#cfn-bedrock-flow-inlinecodeflownodeconfiguration-language", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.\nThe code must be valid in the programming `language` that you specify.\n*Required*: Yes\n*Type*: String\n*Maximum*: `5000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-inlinecodeflownodeconfiguration.html#cfn-bedrock-flow-inlinecodeflownodeconfiguration-code", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.KnowledgeBaseFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.KnowledgeBaseFlowNodeConfiguration`\n\nContains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html", "Properties": { "OrchestrationConfiguration": { "MarkdownDocumentation": "`OrchestrationConfiguration`\n\nThe configuration for orchestrating the retrieval and generation process in the knowledge base node.\n*Required*: No\n*Type*: [KnowledgeBaseOrchestrationConfiguration](./aws-properties-bedrock-flow-knowledgebaseorchestrationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-orchestrationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "KnowledgeBaseOrchestrationConfiguration" }, "GuardrailConfiguration": { "MarkdownDocumentation": "`GuardrailConfiguration`\n\nContains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.\n*Required*: No\n*Type*: [GuardrailConfiguration](./aws-properties-bedrock-flow-guardrailconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-guardrailconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GuardrailConfiguration" }, "InferenceConfiguration": { "MarkdownDocumentation": "`InferenceConfiguration`\n\nContains inference configurations for the prompt.\n*Required*: No\n*Type*: [PromptInferenceConfiguration](./aws-properties-bedrock-flow-promptinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-inferenceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PromptInferenceConfiguration" }, "KnowledgeBaseId": { "MarkdownDocumentation": "`KnowledgeBaseId`\n\nThe unique identifier of the knowledge base to query.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-knowledgebaseid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PromptTemplate": { "MarkdownDocumentation": "`PromptTemplate`\n\nA custom prompt template to use with the knowledge base for generating responses.\n*Required*: No\n*Type*: [KnowledgeBasePromptTemplate](./aws-properties-bedrock-flow-knowledgebaseprompttemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-prompttemplate", "UpdateType": "Mutable", "Required": false, "Type": "KnowledgeBasePromptTemplate" }, "RerankingConfiguration": { "MarkdownDocumentation": "`RerankingConfiguration`\n\nThe configuration for reranking the retrieved results from the knowledge base to improve relevance.\n*Required*: No\n*Type*: [VectorSearchRerankingConfiguration](./aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-rerankingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "VectorSearchRerankingConfiguration" }, "NumberOfResults": { "MarkdownDocumentation": "`NumberOfResults`\n\nThe number of results to retrieve from the knowledge base.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-numberofresults", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-modelid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.KnowledgeBaseOrchestrationConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.KnowledgeBaseOrchestrationConfiguration`\n\nConfigures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseorchestrationconfiguration.html", "Properties": { "InferenceConfig": { "MarkdownDocumentation": "`InferenceConfig`\n\nContains inference configurations for the prompt.\n*Required*: No\n*Type*: [PromptInferenceConfiguration](./aws-properties-bedrock-flow-promptinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseorchestrationconfiguration.html#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-inferenceconfig", "UpdateType": "Mutable", "Required": false, "Type": "PromptInferenceConfiguration" }, "AdditionalModelRequestFields": { "MarkdownDocumentation": "`AdditionalModelRequestFields`\n\nThe additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseorchestrationconfiguration.html#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-additionalmodelrequestfields", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "PerformanceConfig": { "MarkdownDocumentation": "`PerformanceConfig`\n\nThe performance configuration options for the knowledge base retrieval and generation process.\n*Required*: No\n*Type*: [PerformanceConfiguration](./aws-properties-bedrock-flow-performanceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseorchestrationconfiguration.html#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-performanceconfig", "UpdateType": "Mutable", "Required": false, "Type": "PerformanceConfiguration" }, "PromptTemplate": { "MarkdownDocumentation": "`PromptTemplate`\n\nA custom prompt template for orchestrating the retrieval and generation process.\n*Required*: No\n*Type*: [KnowledgeBasePromptTemplate](./aws-properties-bedrock-flow-knowledgebaseprompttemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseorchestrationconfiguration.html#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-prompttemplate", "UpdateType": "Mutable", "Required": false, "Type": "KnowledgeBasePromptTemplate" } } }, "AWS::Bedrock::Flow.KnowledgeBasePromptTemplate": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.KnowledgeBasePromptTemplate`\n\nDefines a custom prompt template for orchestrating the retrieval and generation process.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseprompttemplate.html", "Properties": { "TextPromptTemplate": { "MarkdownDocumentation": "`TextPromptTemplate`\n\nThe text of the prompt template.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-knowledgebaseprompttemplate.html#cfn-bedrock-flow-knowledgebaseprompttemplate-textprompttemplate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.LambdaFunctionFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.LambdaFunctionFlowNodeConfiguration`\n\nContains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-lambdafunctionflownodeconfiguration.html", "Properties": { "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe Amazon Resource Name (ARN) of the Lambda function to invoke.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-lambdafunctionflownodeconfiguration.html#cfn-bedrock-flow-lambdafunctionflownodeconfiguration-lambdaarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.LexFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.LexFlowNodeConfiguration`\n\nContains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-lexflownodeconfiguration.html", "Properties": { "BotAliasArn": { "MarkdownDocumentation": "`BotAliasArn`\n\nThe Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$`\n*Maximum*: `78`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-lexflownodeconfiguration.html#cfn-bedrock-flow-lexflownodeconfiguration-botaliasarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LocaleId": { "MarkdownDocumentation": "`LocaleId`\n\nThe Region to invoke the Amazon Lex bot in.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-lexflownodeconfiguration.html#cfn-bedrock-flow-lexflownodeconfiguration-localeid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.LoopControllerFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.LoopControllerFlowNodeConfiguration`\n\nContains configurations for the controller node of a DoWhile loop in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-loopcontrollerflownodeconfiguration.html", "Properties": { "ContinueCondition": { "MarkdownDocumentation": "`ContinueCondition`\n\nSpecifies the condition that determines when the flow exits the DoWhile loop. The loop\nexecutes until this condition evaluates to true.\n*Required*: Yes\n*Type*: [FlowCondition](./aws-properties-bedrock-flow-flowcondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-loopcontrollerflownodeconfiguration.html#cfn-bedrock-flow-loopcontrollerflownodeconfiguration-continuecondition", "UpdateType": "Mutable", "Required": true, "Type": "FlowCondition" }, "MaxIterations": { "MarkdownDocumentation": "`MaxIterations`\n\nSpecifies the maximum number of times the DoWhile loop can iterate before the flow\nexits the loop.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-loopcontrollerflownodeconfiguration.html#cfn-bedrock-flow-loopcontrollerflownodeconfiguration-maxiterations", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::Flow.LoopFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.LoopFlowNodeConfiguration`\n\nContains configurations for the nodes of a DoWhile loop in your flow.\nA DoWhile loop is made up of the following nodes:\n* `Loop` - The container node that holds the loop's flow definition. This node encompasses the entire loop structure.\n* `LoopInput` - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations.\n* Body nodes - The processing nodes that execute within each loop iteration.\n These can be nodes for handling data in your flow, such as a prompt or Lambda\n function nodes. Some node types aren't supported inside a DoWhile loop body. For\n more information, see [LoopIncompatibleNodeTypeFlowValidationDetails](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.html).\n* `LoopController` - The node that evaluates whether the loop should continue or exit based on a condition.\nThese nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-loopflownodeconfiguration.html", "Properties": { "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe definition of the DoWhile loop nodes and connections between nodes in the flow.\n*Required*: Yes\n*Type*: [FlowDefinition](./aws-properties-bedrock-flow-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-loopflownodeconfiguration.html#cfn-bedrock-flow-loopflownodeconfiguration-definition", "UpdateType": "Mutable", "Required": true, "Type": "FlowDefinition" } } }, "AWS::Bedrock::Flow.MetadataConfigurationForReranking": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.MetadataConfigurationForReranking`\n\nConfiguration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html", "Properties": { "SelectiveModeConfiguration": { "MarkdownDocumentation": "`SelectiveModeConfiguration`\n\nConfiguration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.\n*Required*: No\n*Type*: [RerankingMetadataSelectiveModeConfiguration](./aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html#cfn-bedrock-flow-metadataconfigurationforreranking-selectivemodeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RerankingMetadataSelectiveModeConfiguration" }, "SelectionMode": { "MarkdownDocumentation": "`SelectionMode`\n\nThe mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SELECTIVE | ALL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SELECTIVE", "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html#cfn-bedrock-flow-metadataconfigurationforreranking-selectionmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.PerformanceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PerformanceConfiguration`\n\nPerformance settings for a model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-performanceconfiguration.html", "Properties": { "Latency": { "MarkdownDocumentation": "`Latency`\n\nTo use a latency-optimized version of the model, set to `optimized`.\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | optimized...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "optimized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-performanceconfiguration.html#cfn-bedrock-flow-performanceconfiguration-latency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.PromptFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PromptFlowNodeConfiguration`\n\nContains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodeconfiguration.html", "Properties": { "GuardrailConfiguration": { "MarkdownDocumentation": "`GuardrailConfiguration`\n\nContains configurations for a guardrail to apply to the prompt in this node and the response generated from it.\n*Required*: No\n*Type*: [GuardrailConfiguration](./aws-properties-bedrock-flow-guardrailconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodeconfiguration.html#cfn-bedrock-flow-promptflownodeconfiguration-guardrailconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GuardrailConfiguration" }, "SourceConfiguration": { "MarkdownDocumentation": "`SourceConfiguration`\n\nSpecifies whether the prompt is from Prompt management or defined inline.\n*Required*: Yes\n*Type*: [PromptFlowNodeSourceConfiguration](./aws-properties-bedrock-flow-promptflownodesourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodeconfiguration.html#cfn-bedrock-flow-promptflownodeconfiguration-sourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PromptFlowNodeSourceConfiguration" } } }, "AWS::Bedrock::Flow.PromptFlowNodeInlineConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PromptFlowNodeInlineConfiguration`\n\nContains configurations for a prompt defined inline in the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodeinlineconfiguration.html", "Properties": { "InferenceConfiguration": { "MarkdownDocumentation": "`InferenceConfiguration`\n\nContains inference configurations for the prompt.\n*Required*: No\n*Type*: [PromptInferenceConfiguration](./aws-properties-bedrock-flow-promptinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodeinlineconfiguration.html#cfn-bedrock-flow-promptflownodeinlineconfiguration-inferenceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PromptInferenceConfiguration" }, "TemplateConfiguration": { "MarkdownDocumentation": "`TemplateConfiguration`\n\nContains a prompt and variables in the prompt that can be replaced with values at runtime.\n*Required*: Yes\n*Type*: [PromptTemplateConfiguration](./aws-properties-bedrock-flow-prompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodeinlineconfiguration.html#cfn-bedrock-flow-promptflownodeinlineconfiguration-templateconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PromptTemplateConfiguration" }, "TemplateType": { "MarkdownDocumentation": "`TemplateType`\n\nThe type of prompt template.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEXT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "TEXT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodeinlineconfiguration.html#cfn-bedrock-flow-promptflownodeinlineconfiguration-templatetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to run inference with.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodeinlineconfiguration.html#cfn-bedrock-flow-promptflownodeinlineconfiguration-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.PromptFlowNodeResourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PromptFlowNodeResourceConfiguration`\n\nContains configurations for a prompt from Prompt management to use in a node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownoderesourceconfiguration.html", "Properties": { "PromptArn": { "MarkdownDocumentation": "`PromptArn`\n\nThe Amazon Resource Name (ARN) of the prompt from Prompt management.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownoderesourceconfiguration.html#cfn-bedrock-flow-promptflownoderesourceconfiguration-promptarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.PromptFlowNodeSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PromptFlowNodeSourceConfiguration`\n\nContains configurations for a prompt and whether it is from Prompt management or defined inline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodesourceconfiguration.html", "Properties": { "Resource": { "MarkdownDocumentation": "`Resource`\n\nContains configurations for a prompt from Prompt management.\n*Required*: No\n*Type*: [PromptFlowNodeResourceConfiguration](./aws-properties-bedrock-flow-promptflownoderesourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodesourceconfiguration.html#cfn-bedrock-flow-promptflownodesourceconfiguration-resource", "UpdateType": "Mutable", "Required": false, "Type": "PromptFlowNodeResourceConfiguration" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nContains configurations for a prompt that is defined inline\n*Required*: No\n*Type*: [PromptFlowNodeInlineConfiguration](./aws-properties-bedrock-flow-promptflownodeinlineconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptflownodesourceconfiguration.html#cfn-bedrock-flow-promptflownodesourceconfiguration-inline", "UpdateType": "Mutable", "Required": false, "Type": "PromptFlowNodeInlineConfiguration" } } }, "AWS::Bedrock::Flow.PromptInferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PromptInferenceConfiguration`\n\nContains inference configurations for the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptinferenceconfiguration.html", "Properties": { "Text": { "MarkdownDocumentation": "`Text`\n\nContains inference configurations for a text prompt.\n*Required*: Yes\n*Type*: [PromptModelInferenceConfiguration](./aws-properties-bedrock-flow-promptmodelinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptinferenceconfiguration.html#cfn-bedrock-flow-promptinferenceconfiguration-text", "UpdateType": "Mutable", "Required": true, "Type": "PromptModelInferenceConfiguration" } } }, "AWS::Bedrock::Flow.PromptInputVariable": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PromptInputVariable`\n\nContains information about a variable in the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptinputvariable.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the variable.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptinputvariable.html#cfn-bedrock-flow-promptinputvariable-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.PromptModelInferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PromptModelInferenceConfiguration`\n\nContains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptmodelinferenceconfiguration.html", "Properties": { "Temperature": { "MarkdownDocumentation": "`Temperature`\n\nControls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptmodelinferenceconfiguration.html#cfn-bedrock-flow-promptmodelinferenceconfiguration-temperature", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StopSequences": { "MarkdownDocumentation": "`StopSequences`\n\nA list of strings that define sequences after which the model will stop generating.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptmodelinferenceconfiguration.html#cfn-bedrock-flow-promptmodelinferenceconfiguration-stopsequences", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxTokens": { "MarkdownDocumentation": "`MaxTokens`\n\nThe maximum number of tokens to return in the response.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptmodelinferenceconfiguration.html#cfn-bedrock-flow-promptmodelinferenceconfiguration-maxtokens", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "TopP": { "MarkdownDocumentation": "`TopP`\n\nThe percentage of most-likely candidates that the model considers for the next token.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-promptmodelinferenceconfiguration.html#cfn-bedrock-flow-promptmodelinferenceconfiguration-topp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::Flow.PromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.PromptTemplateConfiguration`\n\nContains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-prompttemplateconfiguration.html", "Properties": { "Text": { "MarkdownDocumentation": "`Text`\n\nContains configurations for the text in a message for a prompt.\n*Required*: Yes\n*Type*: [TextPromptTemplateConfiguration](./aws-properties-bedrock-flow-textprompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-prompttemplateconfiguration.html#cfn-bedrock-flow-prompttemplateconfiguration-text", "UpdateType": "Mutable", "Required": true, "Type": "TextPromptTemplateConfiguration" } } }, "AWS::Bedrock::Flow.RerankingMetadataSelectiveModeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.RerankingMetadataSelectiveModeConfiguration`\n\nConfiguration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html", "Properties": { "FieldsToInclude": { "MarkdownDocumentation": "`FieldsToInclude`\n\nA list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.\n*Required*: No\n*Type*: Array of [FieldForReranking](./aws-properties-bedrock-flow-fieldforreranking.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoinclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldForReranking", "DuplicatesAllowed": true }, "FieldsToExclude": { "MarkdownDocumentation": "`FieldsToExclude`\n\nA list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.\n*Required*: No\n*Type*: Array of [FieldForReranking](./aws-properties-bedrock-flow-fieldforreranking.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoexclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldForReranking", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Flow.RetrievalFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.RetrievalFlowNodeConfiguration`\n\nContains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-retrievalflownodeconfiguration.html", "Properties": { "ServiceConfiguration": { "MarkdownDocumentation": "`ServiceConfiguration`\n\nContains configurations for the service to use for retrieving data to return as the output from the node.\n*Required*: Yes\n*Type*: [RetrievalFlowNodeServiceConfiguration](./aws-properties-bedrock-flow-retrievalflownodeserviceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-retrievalflownodeconfiguration.html#cfn-bedrock-flow-retrievalflownodeconfiguration-serviceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "RetrievalFlowNodeServiceConfiguration" } } }, "AWS::Bedrock::Flow.RetrievalFlowNodeS3Configuration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.RetrievalFlowNodeS3Configuration`\n\nContains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-retrievalflownodes3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the Amazon S3 bucket from which to retrieve data.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-retrievalflownodes3configuration.html#cfn-bedrock-flow-retrievalflownodes3configuration-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.RetrievalFlowNodeServiceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.RetrievalFlowNodeServiceConfiguration`\n\nContains configurations for the service to use for retrieving data to return as the output from the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-retrievalflownodeserviceconfiguration.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nContains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.\n*Required*: No\n*Type*: [RetrievalFlowNodeS3Configuration](./aws-properties-bedrock-flow-retrievalflownodes3configuration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-retrievalflownodeserviceconfiguration.html#cfn-bedrock-flow-retrievalflownodeserviceconfiguration-s3", "UpdateType": "Mutable", "Required": false, "Type": "RetrievalFlowNodeS3Configuration" } } }, "AWS::Bedrock::Flow.S3Location": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.S3Location`\n\nThe S3 location of the flow definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe S3 bucket containing the flow definition.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-s3location.html#cfn-bedrock-flow-s3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe Amazon S3 location from which to retrieve data for an S3 retrieve node or\nto which to store data for an S3 storage node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-s3location.html#cfn-bedrock-flow-s3location-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe object key for the S3 location containing the definition.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-s3location.html#cfn-bedrock-flow-s3location-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.StorageFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.StorageFlowNodeConfiguration`\n\nContains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-storageflownodeconfiguration.html", "Properties": { "ServiceConfiguration": { "MarkdownDocumentation": "`ServiceConfiguration`\n\nContains configurations for the service to use for storing the input into the node.\n*Required*: Yes\n*Type*: [StorageFlowNodeServiceConfiguration](./aws-properties-bedrock-flow-storageflownodeserviceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-storageflownodeconfiguration.html#cfn-bedrock-flow-storageflownodeconfiguration-serviceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "StorageFlowNodeServiceConfiguration" } } }, "AWS::Bedrock::Flow.StorageFlowNodeS3Configuration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.StorageFlowNodeS3Configuration`\n\nContains configurations for the Amazon S3 location in which to store the input into the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-storageflownodes3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the Amazon S3 bucket in which to store the input into the node.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-storageflownodes3configuration.html#cfn-bedrock-flow-storageflownodes3configuration-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.StorageFlowNodeServiceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.StorageFlowNodeServiceConfiguration`\n\nContains configurations for the service to use for storing the input into the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-storageflownodeserviceconfiguration.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nContains configurations for the Amazon S3 location in which to store the input into the node.\n*Required*: No\n*Type*: [StorageFlowNodeS3Configuration](./aws-properties-bedrock-flow-storageflownodes3configuration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-storageflownodeserviceconfiguration.html#cfn-bedrock-flow-storageflownodeserviceconfiguration-s3", "UpdateType": "Mutable", "Required": false, "Type": "StorageFlowNodeS3Configuration" } } }, "AWS::Bedrock::Flow.TextPromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.TextPromptTemplateConfiguration`\n\nContains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-textprompttemplateconfiguration.html", "Properties": { "InputVariables": { "MarkdownDocumentation": "`InputVariables`\n\nAn array of the variables in the prompt template.\n*Required*: No\n*Type*: Array of [PromptInputVariable](./aws-properties-bedrock-flow-promptinputvariable.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-textprompttemplateconfiguration.html#cfn-bedrock-flow-textprompttemplateconfiguration-inputvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptInputVariable", "DuplicatesAllowed": true }, "Text": { "MarkdownDocumentation": "`Text`\n\nThe message for the prompt.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `200000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-textprompttemplateconfiguration.html#cfn-bedrock-flow-textprompttemplateconfiguration-text", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Flow.VectorSearchBedrockRerankingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.VectorSearchBedrockRerankingConfiguration`\n\nConfiguration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html", "Properties": { "NumberOfRerankedResults": { "MarkdownDocumentation": "`NumberOfRerankedResults`\n\nThe maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MetadataConfiguration": { "MarkdownDocumentation": "`MetadataConfiguration`\n\nConfiguration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.\n*Required*: No\n*Type*: [MetadataConfigurationForReranking](./aws-properties-bedrock-flow-metadataconfigurationforreranking.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-metadataconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MetadataConfigurationForReranking" }, "ModelConfiguration": { "MarkdownDocumentation": "`ModelConfiguration`\n\nConfiguration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.\n*Required*: Yes\n*Type*: [VectorSearchBedrockRerankingModelConfiguration](./aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-modelconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "VectorSearchBedrockRerankingModelConfiguration" } } }, "AWS::Bedrock::Flow.VectorSearchBedrockRerankingModelConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.VectorSearchBedrockRerankingModelConfiguration`\n\nConfiguration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html", "Properties": { "ModelArn": { "MarkdownDocumentation": "`ModelArn`\n\nThe Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-modelarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AdditionalModelRequestFields": { "MarkdownDocumentation": "`AdditionalModelRequestFields`\n\nA list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::Bedrock::Flow.VectorSearchRerankingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Flow.VectorSearchRerankingConfiguration`\n\nConfiguration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BEDROCK_RERANKING_MODEL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BEDROCK_RERANKING_MODEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchrerankingconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BedrockRerankingConfiguration": { "MarkdownDocumentation": "`BedrockRerankingConfiguration`\n\nConfiguration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.\n*Required*: No\n*Type*: [VectorSearchBedrockRerankingConfiguration](./aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "VectorSearchBedrockRerankingConfiguration" } } }, "AWS::Bedrock::FlowAlias.FlowAliasConcurrencyConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowAlias.FlowAliasConcurrencyConfiguration`\n\nDetermines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowalias-flowaliasconcurrencyconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of concurrency to use for parallel node execution. Specify one of the following options:\n* `Automatic` - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.\n* `Manual` - You specify which nodes can be executed in parallel.\n*Required*: Yes\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)", "RefReturnValue": "", "AllowedValues": [ "Automatic", "Manual" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowalias-flowaliasconcurrencyconfiguration.html#cfn-bedrock-flowalias-flowaliasconcurrencyconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaxConcurrency": { "MarkdownDocumentation": "`MaxConcurrency`\n\nThe maximum number of nodes that can be executed concurrently in the flow.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowalias-flowaliasconcurrencyconfiguration.html#cfn-bedrock-flowalias-flowaliasconcurrencyconfiguration-maxconcurrency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::FlowAlias.FlowAliasRoutingConfigurationListItem": { "MarkdownDocumentation": "`AWS::Bedrock::FlowAlias.FlowAliasRoutingConfigurationListItem`\n\nContains information about a version that the alias maps to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowalias-flowaliasroutingconfigurationlistitem.html", "Properties": { "FlowVersion": { "MarkdownDocumentation": "`FlowVersion`\n\nThe version that the alias maps to.\n*Required*: No\n*Type*: String\n*Pattern*: `^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowalias-flowaliasroutingconfigurationlistitem.html#cfn-bedrock-flowalias-flowaliasroutingconfigurationlistitem-flowversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.AgentFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.AgentFlowNodeConfiguration`\n\nDefines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-agentflownodeconfiguration.html", "Properties": { "AgentAliasArn": { "MarkdownDocumentation": "`AgentAliasArn`\n\nThe Amazon Resource Name (ARN) of the alias of the agent to invoke.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-agentflownodeconfiguration.html#cfn-bedrock-flowversion-agentflownodeconfiguration-agentaliasarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.ConditionFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.ConditionFlowNodeConfiguration`\n\nDefines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-conditionflownodeconfiguration.html", "Properties": { "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nAn array of conditions. Each member contains the name of a condition and an expression that defines the condition.\n*Required*: Yes\n*Type*: Array of [FlowCondition](./aws-properties-bedrock-flowversion-flowcondition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-conditionflownodeconfiguration.html#cfn-bedrock-flowversion-conditionflownodeconfiguration-conditions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FlowCondition", "DuplicatesAllowed": true } } }, "AWS::Bedrock::FlowVersion.FieldForReranking": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FieldForReranking`\n\nSpecifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-fieldforreranking.html", "Properties": { "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the metadata field to be used during the reranking process.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-fieldforreranking.html#cfn-bedrock-flowversion-fieldforreranking-fieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.FlowCondition": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowCondition`\n\nDefines a condition in the condition node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowcondition.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nDefines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowcondition.html#cfn-bedrock-flowversion-flowcondition-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the condition that you can reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowcondition.html#cfn-bedrock-flowversion-flowcondition-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.FlowConditionalConnectionConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowConditionalConnectionConfiguration`\n\nThe configuration of a connection between a condition node and another node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconditionalconnectionconfiguration.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nThe condition that triggers this connection. For more information about how to write conditions, see the **Condition** node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconditionalconnectionconfiguration.html#cfn-bedrock-flowversion-flowconditionalconnectionconfiguration-condition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.FlowConnection": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowConnection`\n\nContains information about a connection between two nodes in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnection.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nWhether the source node that the connection begins from is a condition node (`Conditional`) or not (`Data`).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Data | Conditional...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Data", "Conditional" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnection.html#cfn-bedrock-flowversion-flowconnection-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Target": { "MarkdownDocumentation": "`Target`\n\nThe node that the connection ends at.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnection.html#cfn-bedrock-flowversion-flowconnection-target", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration of the connection.\n*Required*: No\n*Type*: [FlowConnectionConfiguration](./aws-properties-bedrock-flowversion-flowconnectionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnection.html#cfn-bedrock-flowversion-flowconnection-configuration", "UpdateType": "Mutable", "Required": false, "Type": "FlowConnectionConfiguration" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe node that the connection starts at.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnection.html#cfn-bedrock-flowversion-flowconnection-source", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the connection that you can reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnection.html#cfn-bedrock-flowversion-flowconnection-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.FlowConnectionConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowConnectionConfiguration`\n\nThe configuration of the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnectionconfiguration.html", "Properties": { "Data": { "MarkdownDocumentation": "`Data`\n\nThe configuration of a connection originating from a node that isn't a Condition node.\n*Required*: No\n*Type*: [FlowDataConnectionConfiguration](./aws-properties-bedrock-flowversion-flowdataconnectionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnectionconfiguration.html#cfn-bedrock-flowversion-flowconnectionconfiguration-data", "UpdateType": "Mutable", "Required": false, "Type": "FlowDataConnectionConfiguration" }, "Conditional": { "MarkdownDocumentation": "`Conditional`\n\nThe configuration of a connection originating from a Condition node.\n*Required*: No\n*Type*: [FlowConditionalConnectionConfiguration](./aws-properties-bedrock-flowversion-flowconditionalconnectionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowconnectionconfiguration.html#cfn-bedrock-flowversion-flowconnectionconfiguration-conditional", "UpdateType": "Mutable", "Required": false, "Type": "FlowConditionalConnectionConfiguration" } } }, "AWS::Bedrock::FlowVersion.FlowDataConnectionConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowDataConnectionConfiguration`\n\nThe configuration of a connection originating from a node that isn't a Condition node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdataconnectionconfiguration.html", "Properties": { "SourceOutput": { "MarkdownDocumentation": "`SourceOutput`\n\nThe name of the output in the source node that the connection begins from.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdataconnectionconfiguration.html#cfn-bedrock-flowversion-flowdataconnectionconfiguration-sourceoutput", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetInput": { "MarkdownDocumentation": "`TargetInput`\n\nThe name of the input in the target node that the connection ends at.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdataconnectionconfiguration.html#cfn-bedrock-flowversion-flowdataconnectionconfiguration-targetinput", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.FlowDefinition": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowDefinition`\n\nThe definition of the nodes and connections between nodes in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdefinition.html", "Properties": { "Connections": { "MarkdownDocumentation": "`Connections`\n\nAn array of connection definitions in the flow.\n*Required*: No\n*Type*: Array of [FlowConnection](./aws-properties-bedrock-flowversion-flowconnection.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdefinition.html#cfn-bedrock-flowversion-flowdefinition-connections", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FlowConnection", "DuplicatesAllowed": true }, "Nodes": { "MarkdownDocumentation": "`Nodes`\n\nAn array of node definitions in the flow.\n*Required*: No\n*Type*: Array of [FlowNode](./aws-properties-bedrock-flowversion-flownode.html)\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdefinition.html#cfn-bedrock-flowversion-flowdefinition-nodes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FlowNode", "DuplicatesAllowed": true } } }, "AWS::Bedrock::FlowVersion.FlowNode": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowNode`\n\nContains configurations about a node in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownode.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of node. This value must match the name of the key that you provide in the configuration you provide in the `FlowNodeConfiguration` field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Input | Output | KnowledgeB...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Input", "Output", "KnowledgeBase", "Condition", "Lex", "Prompt", "LambdaFunction", "Agent", "Iterator", "Collector", "Storage", "Retrieval", "InlineCode", "Loop", "LoopInput", "LoopController" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownode.html#cfn-bedrock-flowversion-flownode-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nContains configurations for the node.\n*Required*: No\n*Type*: [FlowNodeConfiguration](./aws-properties-bedrock-flowversion-flownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownode.html#cfn-bedrock-flowversion-flownode-configuration", "UpdateType": "Mutable", "Required": false, "Type": "FlowNodeConfiguration" }, "Outputs": { "MarkdownDocumentation": "`Outputs`\n\nA list of objects, each of which contains information about an output from the node.\n*Required*: No\n*Type*: Array of [FlowNodeOutput](./aws-properties-bedrock-flowversion-flownodeoutput.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownode.html#cfn-bedrock-flowversion-flownode-outputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FlowNodeOutput", "DuplicatesAllowed": true }, "Inputs": { "MarkdownDocumentation": "`Inputs`\n\nAn array of objects, each of which contains information about an input into the node.\n*Required*: No\n*Type*: Array of [FlowNodeInput](./aws-properties-bedrock-flowversion-flownodeinput.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownode.html#cfn-bedrock-flowversion-flownode-inputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FlowNodeInput", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the node.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownode.html#cfn-bedrock-flowversion-flownode-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.FlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowNodeConfiguration`\n\nContains configurations for a node in your flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nContains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.\n*Required*: No\n*Type*: [ConditionFlowNodeConfiguration](./aws-properties-bedrock-flowversion-conditionflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-condition", "UpdateType": "Mutable", "Required": false, "Type": "ConditionFlowNodeConfiguration" }, "Retrieval": { "MarkdownDocumentation": "`Retrieval`\n\nContains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.\n*Required*: No\n*Type*: [RetrievalFlowNodeConfiguration](./aws-properties-bedrock-flowversion-retrievalflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-retrieval", "UpdateType": "Mutable", "Required": false, "Type": "RetrievalFlowNodeConfiguration" }, "Loop": { "MarkdownDocumentation": "`Loop`\n\nContains configurations for a DoWhile loop in your flow.\n*Required*: No\n*Type*: [LoopFlowNodeConfiguration](./aws-properties-bedrock-flowversion-loopflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-loop", "UpdateType": "Mutable", "Required": false, "Type": "LoopFlowNodeConfiguration" }, "Agent": { "MarkdownDocumentation": "`Agent`\n\nContains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.\n*Required*: No\n*Type*: [AgentFlowNodeConfiguration](./aws-properties-bedrock-flowversion-agentflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-agent", "UpdateType": "Mutable", "Required": false, "Type": "AgentFlowNodeConfiguration" }, "LambdaFunction": { "MarkdownDocumentation": "`LambdaFunction`\n\nContains configurations for a Lambda function node in your flow. Invokes an AWS Lambda function.\n*Required*: No\n*Type*: [LambdaFunctionFlowNodeConfiguration](./aws-properties-bedrock-flowversion-lambdafunctionflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-lambdafunction", "UpdateType": "Mutable", "Required": false, "Type": "LambdaFunctionFlowNodeConfiguration" }, "InlineCode": { "MarkdownDocumentation": "`InlineCode`\n\nContains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.\n*Required*: No\n*Type*: [InlineCodeFlowNodeConfiguration](./aws-properties-bedrock-flowversion-inlinecodeflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-inlinecode", "UpdateType": "Mutable", "Required": false, "Type": "InlineCodeFlowNodeConfiguration" }, "LoopController": { "MarkdownDocumentation": "`LoopController`\n\nContains controller node configurations for a DoWhile loop in your flow.\n*Required*: No\n*Type*: [LoopControllerFlowNodeConfiguration](./aws-properties-bedrock-flowversion-loopcontrollerflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-loopcontroller", "UpdateType": "Mutable", "Required": false, "Type": "LoopControllerFlowNodeConfiguration" }, "Input": { "MarkdownDocumentation": "`Input`\n\nContains configurations for an input flow node in your flow. The first node in the flow. `inputs` can't be specified for this node.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-input", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Storage": { "MarkdownDocumentation": "`Storage`\n\nContains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.\n*Required*: No\n*Type*: [StorageFlowNodeConfiguration](./aws-properties-bedrock-flowversion-storageflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-storage", "UpdateType": "Mutable", "Required": false, "Type": "StorageFlowNodeConfiguration" }, "KnowledgeBase": { "MarkdownDocumentation": "`KnowledgeBase`\n\nContains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.\n*Required*: No\n*Type*: [KnowledgeBaseFlowNodeConfiguration](./aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-knowledgebase", "UpdateType": "Mutable", "Required": false, "Type": "KnowledgeBaseFlowNodeConfiguration" }, "Output": { "MarkdownDocumentation": "`Output`\n\nContains configurations for an output flow node in your flow. The last node in the flow. `outputs` can't be specified for this node.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-output", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Iterator": { "MarkdownDocumentation": "`Iterator`\n\nContains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-iterator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Collector": { "MarkdownDocumentation": "`Collector`\n\nContains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-collector", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LoopInput": { "MarkdownDocumentation": "`LoopInput`\n\nContains input node configurations for a DoWhile loop in your flow.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-loopinput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Prompt": { "MarkdownDocumentation": "`Prompt`\n\nContains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.\n*Required*: No\n*Type*: [PromptFlowNodeConfiguration](./aws-properties-bedrock-flowversion-promptflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-prompt", "UpdateType": "Mutable", "Required": false, "Type": "PromptFlowNodeConfiguration" }, "Lex": { "MarkdownDocumentation": "`Lex`\n\nContains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.\n*Required*: No\n*Type*: [LexFlowNodeConfiguration](./aws-properties-bedrock-flowversion-lexflownodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeconfiguration.html#cfn-bedrock-flowversion-flownodeconfiguration-lex", "UpdateType": "Mutable", "Required": false, "Type": "LexFlowNodeConfiguration" } } }, "AWS::Bedrock::FlowVersion.FlowNodeInput": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowNodeInput`\n\nContains configurations for an input in an Amazon Bedrock Flows node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeinput.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the data type of the input. If the input doesn't match this type at runtime,\na validation error will be thrown.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `String | Number | Boolean |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "String", "Number", "Boolean", "Object", "Array" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeinput.html#cfn-bedrock-flowversion-flownodeinput-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nAn expression that formats the input for the node. For an explanation of how to create expressions, see [Expressions in Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeinput.html#cfn-bedrock-flowversion-flownodeinput-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nSpecifies a name for the input that you can reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeinput.html#cfn-bedrock-flowversion-flownodeinput-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.FlowNodeOutput": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.FlowNodeOutput`\n\nContains configurations for an output from a node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeoutput.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `String | Number | Boolean |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "String", "Number", "Boolean", "Object", "Array" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeoutput.html#cfn-bedrock-flowversion-flownodeoutput-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the output that you can reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flownodeoutput.html#cfn-bedrock-flowversion-flownodeoutput-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.GuardrailConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.GuardrailConfiguration`\n\nConfiguration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-guardrailconfiguration.html", "Properties": { "GuardrailIdentifier": { "MarkdownDocumentation": "`GuardrailIdentifier`\n\nThe identifier for the guardrail.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-guardrailconfiguration.html#cfn-bedrock-flowversion-guardrailconfiguration-guardrailidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GuardrailVersion": { "MarkdownDocumentation": "`GuardrailVersion`\n\nThe version of the guardrail.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([0-9]{1,8})|(DRAFT))$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-guardrailconfiguration.html#cfn-bedrock-flowversion-guardrailconfiguration-guardrailversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.InlineCodeFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.InlineCodeFlowNodeConfiguration`\n\nContains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-inlinecodeflownodeconfiguration.html", "Properties": { "Language": { "MarkdownDocumentation": "`Language`\n\nThe programming language used by your inline code node.\nThe code must be valid in the programming `language` that you specify. Currently, only Python 3 (`Python_3`) is supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `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)\n", "RefReturnValue": "", "AllowedValues": [ "Python_3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-inlinecodeflownodeconfiguration.html#cfn-bedrock-flowversion-inlinecodeflownodeconfiguration-language", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.\nThe code must be valid in the programming `language` that you specify.\n*Required*: Yes\n*Type*: String\n*Maximum*: `5000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-inlinecodeflownodeconfiguration.html#cfn-bedrock-flowversion-inlinecodeflownodeconfiguration-code", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.KnowledgeBaseFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.KnowledgeBaseFlowNodeConfiguration`\n\nContains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html", "Properties": { "OrchestrationConfiguration": { "MarkdownDocumentation": "`OrchestrationConfiguration`\n\nThe configuration for orchestrating the retrieval and generation process in the knowledge base node.\n*Required*: No\n*Type*: [KnowledgeBaseOrchestrationConfiguration](./aws-properties-bedrock-flowversion-knowledgebaseorchestrationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-orchestrationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "KnowledgeBaseOrchestrationConfiguration" }, "GuardrailConfiguration": { "MarkdownDocumentation": "`GuardrailConfiguration`\n\nContains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.\n*Required*: No\n*Type*: [GuardrailConfiguration](./aws-properties-bedrock-flowversion-guardrailconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-guardrailconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GuardrailConfiguration" }, "InferenceConfiguration": { "MarkdownDocumentation": "`InferenceConfiguration`\n\nContains inference configurations for the prompt.\n*Required*: No\n*Type*: [PromptInferenceConfiguration](./aws-properties-bedrock-flowversion-promptinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-inferenceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PromptInferenceConfiguration" }, "KnowledgeBaseId": { "MarkdownDocumentation": "`KnowledgeBaseId`\n\nThe unique identifier of the knowledge base to query.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-knowledgebaseid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PromptTemplate": { "MarkdownDocumentation": "`PromptTemplate`\n\nA custom prompt template to use with the knowledge base for generating responses.\n*Required*: No\n*Type*: [KnowledgeBasePromptTemplate](./aws-properties-bedrock-flowversion-knowledgebaseprompttemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-prompttemplate", "UpdateType": "Mutable", "Required": false, "Type": "KnowledgeBasePromptTemplate" }, "RerankingConfiguration": { "MarkdownDocumentation": "`RerankingConfiguration`\n\nThe configuration for reranking the retrieved results from the knowledge base to improve relevance.\n*Required*: No\n*Type*: [VectorSearchRerankingConfiguration](./aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-rerankingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "VectorSearchRerankingConfiguration" }, "NumberOfResults": { "MarkdownDocumentation": "`NumberOfResults`\n\nThe number of results to retrieve from the knowledge base.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-numberofresults", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.html#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-modelid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.KnowledgeBaseOrchestrationConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.KnowledgeBaseOrchestrationConfiguration`\n\nConfigures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseorchestrationconfiguration.html", "Properties": { "InferenceConfig": { "MarkdownDocumentation": "`InferenceConfig`\n\nContains inference configurations for the prompt.\n*Required*: No\n*Type*: [PromptInferenceConfiguration](./aws-properties-bedrock-flowversion-promptinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseorchestrationconfiguration.html#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-inferenceconfig", "UpdateType": "Mutable", "Required": false, "Type": "PromptInferenceConfiguration" }, "AdditionalModelRequestFields": { "MarkdownDocumentation": "`AdditionalModelRequestFields`\n\nThe additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseorchestrationconfiguration.html#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-additionalmodelrequestfields", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "PerformanceConfig": { "MarkdownDocumentation": "`PerformanceConfig`\n\nThe performance configuration options for the knowledge base retrieval and generation process.\n*Required*: No\n*Type*: [PerformanceConfiguration](./aws-properties-bedrock-flowversion-performanceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseorchestrationconfiguration.html#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-performanceconfig", "UpdateType": "Mutable", "Required": false, "Type": "PerformanceConfiguration" }, "PromptTemplate": { "MarkdownDocumentation": "`PromptTemplate`\n\nA custom prompt template for orchestrating the retrieval and generation process.\n*Required*: No\n*Type*: [KnowledgeBasePromptTemplate](./aws-properties-bedrock-flowversion-knowledgebaseprompttemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseorchestrationconfiguration.html#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-prompttemplate", "UpdateType": "Mutable", "Required": false, "Type": "KnowledgeBasePromptTemplate" } } }, "AWS::Bedrock::FlowVersion.KnowledgeBasePromptTemplate": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.KnowledgeBasePromptTemplate`\n\nDefines a custom prompt template for orchestrating the retrieval and generation process.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseprompttemplate.html", "Properties": { "TextPromptTemplate": { "MarkdownDocumentation": "`TextPromptTemplate`\n\nThe text of the prompt template.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-knowledgebaseprompttemplate.html#cfn-bedrock-flowversion-knowledgebaseprompttemplate-textprompttemplate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.LambdaFunctionFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.LambdaFunctionFlowNodeConfiguration`\n\nContains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-lambdafunctionflownodeconfiguration.html", "Properties": { "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe Amazon Resource Name (ARN) of the Lambda function to invoke.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-lambdafunctionflownodeconfiguration.html#cfn-bedrock-flowversion-lambdafunctionflownodeconfiguration-lambdaarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.LexFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.LexFlowNodeConfiguration`\n\nContains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-lexflownodeconfiguration.html", "Properties": { "BotAliasArn": { "MarkdownDocumentation": "`BotAliasArn`\n\nThe Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$`\n*Maximum*: `78`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-lexflownodeconfiguration.html#cfn-bedrock-flowversion-lexflownodeconfiguration-botaliasarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LocaleId": { "MarkdownDocumentation": "`LocaleId`\n\nThe Region to invoke the Amazon Lex bot in.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-lexflownodeconfiguration.html#cfn-bedrock-flowversion-lexflownodeconfiguration-localeid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.LoopControllerFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.LoopControllerFlowNodeConfiguration`\n\nContains configurations for the controller node of a DoWhile loop in the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-loopcontrollerflownodeconfiguration.html", "Properties": { "ContinueCondition": { "MarkdownDocumentation": "`ContinueCondition`\n\nSpecifies the condition that determines when the flow exits the DoWhile loop. The loop\nexecutes until this condition evaluates to true.\n*Required*: Yes\n*Type*: [FlowCondition](./aws-properties-bedrock-flowversion-flowcondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-loopcontrollerflownodeconfiguration.html#cfn-bedrock-flowversion-loopcontrollerflownodeconfiguration-continuecondition", "UpdateType": "Mutable", "Required": true, "Type": "FlowCondition" }, "MaxIterations": { "MarkdownDocumentation": "`MaxIterations`\n\nSpecifies the maximum number of times the DoWhile loop can iterate before the flow\nexits the loop.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-loopcontrollerflownodeconfiguration.html#cfn-bedrock-flowversion-loopcontrollerflownodeconfiguration-maxiterations", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::FlowVersion.LoopFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.LoopFlowNodeConfiguration`\n\nContains configurations for the nodes of a DoWhile loop in your flow.\nA DoWhile loop is made up of the following nodes:\n* `Loop` - The container node that holds the loop's flow definition. This node encompasses the entire loop structure.\n* `LoopInput` - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations.\n* Body nodes - The processing nodes that execute within each loop iteration.\n These can be nodes for handling data in your flow, such as a prompt or Lambda\n function nodes. Some node types aren't supported inside a DoWhile loop body. For\n more information, see [LoopIncompatibleNodeTypeFlowValidationDetails](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.html).\n* `LoopController` - The node that evaluates whether the loop should continue or exit based on a condition.\nThese nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-loopflownodeconfiguration.html", "Properties": { "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe definition of the DoWhile loop nodes and connections between nodes in the flow.\n*Required*: Yes\n*Type*: [FlowDefinition](./aws-properties-bedrock-flowversion-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-loopflownodeconfiguration.html#cfn-bedrock-flowversion-loopflownodeconfiguration-definition", "UpdateType": "Mutable", "Required": true, "Type": "FlowDefinition" } } }, "AWS::Bedrock::FlowVersion.MetadataConfigurationForReranking": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.MetadataConfigurationForReranking`\n\nConfiguration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html", "Properties": { "SelectiveModeConfiguration": { "MarkdownDocumentation": "`SelectiveModeConfiguration`\n\nConfiguration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.\n*Required*: No\n*Type*: [RerankingMetadataSelectiveModeConfiguration](./aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectivemodeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RerankingMetadataSelectiveModeConfiguration" }, "SelectionMode": { "MarkdownDocumentation": "`SelectionMode`\n\nThe mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SELECTIVE | ALL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SELECTIVE", "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectionmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.PerformanceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PerformanceConfiguration`\n\nPerformance settings for a model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-performanceconfiguration.html", "Properties": { "Latency": { "MarkdownDocumentation": "`Latency`\n\nTo use a latency-optimized version of the model, set to `optimized`.\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | optimized...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "optimized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-performanceconfiguration.html#cfn-bedrock-flowversion-performanceconfiguration-latency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.PromptFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PromptFlowNodeConfiguration`\n\nContains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodeconfiguration.html", "Properties": { "GuardrailConfiguration": { "MarkdownDocumentation": "`GuardrailConfiguration`\n\nContains configurations for a guardrail to apply to the prompt in this node and the response generated from it.\n*Required*: No\n*Type*: [GuardrailConfiguration](./aws-properties-bedrock-flowversion-guardrailconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodeconfiguration.html#cfn-bedrock-flowversion-promptflownodeconfiguration-guardrailconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GuardrailConfiguration" }, "SourceConfiguration": { "MarkdownDocumentation": "`SourceConfiguration`\n\nSpecifies whether the prompt is from Prompt management or defined inline.\n*Required*: Yes\n*Type*: [PromptFlowNodeSourceConfiguration](./aws-properties-bedrock-flowversion-promptflownodesourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodeconfiguration.html#cfn-bedrock-flowversion-promptflownodeconfiguration-sourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PromptFlowNodeSourceConfiguration" } } }, "AWS::Bedrock::FlowVersion.PromptFlowNodeInlineConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PromptFlowNodeInlineConfiguration`\n\nContains configurations for a prompt defined inline in the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodeinlineconfiguration.html", "Properties": { "InferenceConfiguration": { "MarkdownDocumentation": "`InferenceConfiguration`\n\nContains inference configurations for the prompt.\n*Required*: No\n*Type*: [PromptInferenceConfiguration](./aws-properties-bedrock-flowversion-promptinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodeinlineconfiguration.html#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-inferenceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PromptInferenceConfiguration" }, "TemplateConfiguration": { "MarkdownDocumentation": "`TemplateConfiguration`\n\nContains a prompt and variables in the prompt that can be replaced with values at runtime.\n*Required*: Yes\n*Type*: [PromptTemplateConfiguration](./aws-properties-bedrock-flowversion-prompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodeinlineconfiguration.html#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-templateconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PromptTemplateConfiguration" }, "TemplateType": { "MarkdownDocumentation": "`TemplateType`\n\nThe type of prompt template.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEXT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "TEXT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodeinlineconfiguration.html#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-templatetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to run inference with.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodeinlineconfiguration.html#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.PromptFlowNodeResourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PromptFlowNodeResourceConfiguration`\n\nContains configurations for a prompt from Prompt management to use in a node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownoderesourceconfiguration.html", "Properties": { "PromptArn": { "MarkdownDocumentation": "`PromptArn`\n\nThe Amazon Resource Name (ARN) of the prompt from Prompt management.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownoderesourceconfiguration.html#cfn-bedrock-flowversion-promptflownoderesourceconfiguration-promptarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.PromptFlowNodeSourceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PromptFlowNodeSourceConfiguration`\n\nContains configurations for a prompt and whether it is from Prompt management or defined inline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodesourceconfiguration.html", "Properties": { "Resource": { "MarkdownDocumentation": "`Resource`\n\nContains configurations for a prompt from Prompt management.\n*Required*: No\n*Type*: [PromptFlowNodeResourceConfiguration](./aws-properties-bedrock-flowversion-promptflownoderesourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodesourceconfiguration.html#cfn-bedrock-flowversion-promptflownodesourceconfiguration-resource", "UpdateType": "Mutable", "Required": false, "Type": "PromptFlowNodeResourceConfiguration" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nContains configurations for a prompt that is defined inline\n*Required*: No\n*Type*: [PromptFlowNodeInlineConfiguration](./aws-properties-bedrock-flowversion-promptflownodeinlineconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptflownodesourceconfiguration.html#cfn-bedrock-flowversion-promptflownodesourceconfiguration-inline", "UpdateType": "Mutable", "Required": false, "Type": "PromptFlowNodeInlineConfiguration" } } }, "AWS::Bedrock::FlowVersion.PromptInferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PromptInferenceConfiguration`\n\nContains inference configurations for the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptinferenceconfiguration.html", "Properties": { "Text": { "MarkdownDocumentation": "`Text`\n\nContains inference configurations for a text prompt.\n*Required*: Yes\n*Type*: [PromptModelInferenceConfiguration](./aws-properties-bedrock-flowversion-promptmodelinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptinferenceconfiguration.html#cfn-bedrock-flowversion-promptinferenceconfiguration-text", "UpdateType": "Mutable", "Required": true, "Type": "PromptModelInferenceConfiguration" } } }, "AWS::Bedrock::FlowVersion.PromptInputVariable": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PromptInputVariable`\n\nContains information about a variable in the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptinputvariable.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the variable.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptinputvariable.html#cfn-bedrock-flowversion-promptinputvariable-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.PromptModelInferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PromptModelInferenceConfiguration`\n\nContains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptmodelinferenceconfiguration.html", "Properties": { "Temperature": { "MarkdownDocumentation": "`Temperature`\n\nControls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptmodelinferenceconfiguration.html#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-temperature", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StopSequences": { "MarkdownDocumentation": "`StopSequences`\n\nA list of strings that define sequences after which the model will stop generating.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptmodelinferenceconfiguration.html#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-stopsequences", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxTokens": { "MarkdownDocumentation": "`MaxTokens`\n\nThe maximum number of tokens to return in the response.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptmodelinferenceconfiguration.html#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-maxtokens", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "TopP": { "MarkdownDocumentation": "`TopP`\n\nThe percentage of most-likely candidates that the model considers for the next token.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-promptmodelinferenceconfiguration.html#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-topp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::FlowVersion.PromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.PromptTemplateConfiguration`\n\nContains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-prompttemplateconfiguration.html", "Properties": { "Text": { "MarkdownDocumentation": "`Text`\n\nContains configurations for the text in a message for a prompt.\n*Required*: Yes\n*Type*: [TextPromptTemplateConfiguration](./aws-properties-bedrock-flowversion-textprompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-prompttemplateconfiguration.html#cfn-bedrock-flowversion-prompttemplateconfiguration-text", "UpdateType": "Mutable", "Required": true, "Type": "TextPromptTemplateConfiguration" } } }, "AWS::Bedrock::FlowVersion.RerankingMetadataSelectiveModeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.RerankingMetadataSelectiveModeConfiguration`\n\nConfiguration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html", "Properties": { "FieldsToInclude": { "MarkdownDocumentation": "`FieldsToInclude`\n\nA list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.\n*Required*: No\n*Type*: Array of [FieldForReranking](./aws-properties-bedrock-flowversion-fieldforreranking.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoinclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldForReranking", "DuplicatesAllowed": true }, "FieldsToExclude": { "MarkdownDocumentation": "`FieldsToExclude`\n\nA list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.\n*Required*: No\n*Type*: Array of [FieldForReranking](./aws-properties-bedrock-flowversion-fieldforreranking.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoexclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldForReranking", "DuplicatesAllowed": true } } }, "AWS::Bedrock::FlowVersion.RetrievalFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.RetrievalFlowNodeConfiguration`\n\nContains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-retrievalflownodeconfiguration.html", "Properties": { "ServiceConfiguration": { "MarkdownDocumentation": "`ServiceConfiguration`\n\nContains configurations for the service to use for retrieving data to return as the output from the node.\n*Required*: Yes\n*Type*: [RetrievalFlowNodeServiceConfiguration](./aws-properties-bedrock-flowversion-retrievalflownodeserviceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-retrievalflownodeconfiguration.html#cfn-bedrock-flowversion-retrievalflownodeconfiguration-serviceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "RetrievalFlowNodeServiceConfiguration" } } }, "AWS::Bedrock::FlowVersion.RetrievalFlowNodeS3Configuration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.RetrievalFlowNodeS3Configuration`\n\nContains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-retrievalflownodes3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the Amazon S3 bucket from which to retrieve data.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-retrievalflownodes3configuration.html#cfn-bedrock-flowversion-retrievalflownodes3configuration-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.RetrievalFlowNodeServiceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.RetrievalFlowNodeServiceConfiguration`\n\nContains configurations for the service to use for retrieving data to return as the output from the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-retrievalflownodeserviceconfiguration.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nContains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.\n*Required*: No\n*Type*: [RetrievalFlowNodeS3Configuration](./aws-properties-bedrock-flowversion-retrievalflownodes3configuration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-retrievalflownodeserviceconfiguration.html#cfn-bedrock-flowversion-retrievalflownodeserviceconfiguration-s3", "UpdateType": "Mutable", "Required": false, "Type": "RetrievalFlowNodeS3Configuration" } } }, "AWS::Bedrock::FlowVersion.StorageFlowNodeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.StorageFlowNodeConfiguration`\n\nContains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-storageflownodeconfiguration.html", "Properties": { "ServiceConfiguration": { "MarkdownDocumentation": "`ServiceConfiguration`\n\nContains configurations for the service to use for storing the input into the node.\n*Required*: Yes\n*Type*: [StorageFlowNodeServiceConfiguration](./aws-properties-bedrock-flowversion-storageflownodeserviceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-storageflownodeconfiguration.html#cfn-bedrock-flowversion-storageflownodeconfiguration-serviceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "StorageFlowNodeServiceConfiguration" } } }, "AWS::Bedrock::FlowVersion.StorageFlowNodeS3Configuration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.StorageFlowNodeS3Configuration`\n\nContains configurations for the Amazon S3 location in which to store the input into the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-storageflownodes3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the Amazon S3 bucket in which to store the input into the node.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-storageflownodes3configuration.html#cfn-bedrock-flowversion-storageflownodes3configuration-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.StorageFlowNodeServiceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.StorageFlowNodeServiceConfiguration`\n\nContains configurations for the service to use for storing the input into the node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-storageflownodeserviceconfiguration.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nContains configurations for the Amazon S3 location in which to store the input into the node.\n*Required*: No\n*Type*: [StorageFlowNodeS3Configuration](./aws-properties-bedrock-flowversion-storageflownodes3configuration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-storageflownodeserviceconfiguration.html#cfn-bedrock-flowversion-storageflownodeserviceconfiguration-s3", "UpdateType": "Mutable", "Required": false, "Type": "StorageFlowNodeS3Configuration" } } }, "AWS::Bedrock::FlowVersion.TextPromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.TextPromptTemplateConfiguration`\n\nContains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-textprompttemplateconfiguration.html", "Properties": { "InputVariables": { "MarkdownDocumentation": "`InputVariables`\n\nAn array of the variables in the prompt template.\n*Required*: No\n*Type*: Array of [PromptInputVariable](./aws-properties-bedrock-flowversion-promptinputvariable.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-textprompttemplateconfiguration.html#cfn-bedrock-flowversion-textprompttemplateconfiguration-inputvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptInputVariable", "DuplicatesAllowed": true }, "Text": { "MarkdownDocumentation": "`Text`\n\nThe message for the prompt.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `200000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-textprompttemplateconfiguration.html#cfn-bedrock-flowversion-textprompttemplateconfiguration-text", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::FlowVersion.VectorSearchBedrockRerankingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.VectorSearchBedrockRerankingConfiguration`\n\nConfiguration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html", "Properties": { "NumberOfRerankedResults": { "MarkdownDocumentation": "`NumberOfRerankedResults`\n\nThe maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MetadataConfiguration": { "MarkdownDocumentation": "`MetadataConfiguration`\n\nConfiguration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.\n*Required*: No\n*Type*: [MetadataConfigurationForReranking](./aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-metadataconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MetadataConfigurationForReranking" }, "ModelConfiguration": { "MarkdownDocumentation": "`ModelConfiguration`\n\nConfiguration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.\n*Required*: Yes\n*Type*: [VectorSearchBedrockRerankingModelConfiguration](./aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-modelconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "VectorSearchBedrockRerankingModelConfiguration" } } }, "AWS::Bedrock::FlowVersion.VectorSearchBedrockRerankingModelConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.VectorSearchBedrockRerankingModelConfiguration`\n\nConfiguration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html", "Properties": { "ModelArn": { "MarkdownDocumentation": "`ModelArn`\n\nThe Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-modelarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AdditionalModelRequestFields": { "MarkdownDocumentation": "`AdditionalModelRequestFields`\n\nA list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::Bedrock::FlowVersion.VectorSearchRerankingConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion.VectorSearchRerankingConfiguration`\n\nConfiguration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BEDROCK_RERANKING_MODEL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BEDROCK_RERANKING_MODEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BedrockRerankingConfiguration": { "MarkdownDocumentation": "`BedrockRerankingConfiguration`\n\nConfiguration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.\n*Required*: No\n*Type*: [VectorSearchBedrockRerankingConfiguration](./aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "VectorSearchBedrockRerankingConfiguration" } } }, "AWS::Bedrock::Guardrail.AutomatedReasoningPolicyConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.AutomatedReasoningPolicyConfig`\n\nConfiguration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-automatedreasoningpolicyconfig.html", "Properties": { "Policies": { "MarkdownDocumentation": "`Policies`\n\nThe list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `15 | 1`\n*Maximum*: `2048 | 2`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-automatedreasoningpolicyconfig.html#cfn-bedrock-guardrail-automatedreasoningpolicyconfig-policies", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ConfidenceThreshold": { "MarkdownDocumentation": "`ConfidenceThreshold`\n\nThe minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-automatedreasoningpolicyconfig.html#cfn-bedrock-guardrail-automatedreasoningpolicyconfig-confidencethreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::Guardrail.ContentFilterConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.ContentFilterConfig`\n\nContains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.\n* **Hate** \u2013 Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).\n* **Insults** \u2013 Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.\n* **Sexual** \u2013 Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.\n* **Violence** \u2013 Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.\nContent filtering depends on the confidence classification of user inputs and FM\nresponses across each of the four harmful categories. All input and output statements are\nclassified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\nharmful category. For example, if a statement is classified as\n*Hate* with HIGH confidence, the likelihood of the statement\nrepresenting hateful content is high. A single statement can be classified across\nmultiple categories with varying confidence levels. For example, a single statement\ncan be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence.\nFor more information, see [Guardrails content filters](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html", "Properties": { "OutputStrength": { "MarkdownDocumentation": "`OutputStrength`\n\nThe strength of the content filter to apply to model responses. As you\nincrease the filter strength, the likelihood of filtering harmful content increases\nand the probability of seeing harmful content in your application reduces.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | LOW | MEDIUM | HIGH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputstrength", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe harmful category that the content filter is applied to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SEXUAL | VIOLENCE | HATE | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputEnabled": { "MarkdownDocumentation": "`InputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the input. When disabled, you aren't\ncharged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InputAction": { "MarkdownDocumentation": "`InputAction`\n\nSpecifies the action to take when harmful content is detected. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the\n trace response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputAction": { "MarkdownDocumentation": "`OutputAction`\n\nSpecifies the action to take when harmful content is detected in the output. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputStrength": { "MarkdownDocumentation": "`InputStrength`\n\nThe strength of the content filter to apply to prompts. As you\nincrease the filter strength, the likelihood of filtering harmful content increases\nand the probability of seeing harmful content in your application reduces.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | LOW | MEDIUM | HIGH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputstrength", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputModalities": { "MarkdownDocumentation": "`InputModalities`\n\nThe input modalities selected for the guardrail content filter configuration.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputmodalities", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "OutputEnabled": { "MarkdownDocumentation": "`OutputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the output. When disabled, you\naren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "OutputModalities": { "MarkdownDocumentation": "`OutputModalities`\n\nThe output modalities selected for the guardrail content filter configuration.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputmodalities", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Guardrail.ContentFiltersTierConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.ContentFiltersTierConfig`\n\nThe tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterstierconfig.html", "Properties": { "TierName": { "MarkdownDocumentation": "`TierName`\n\nThe tier that your guardrail uses for content filters. Valid values include:\n* `CLASSIC` tier \u2013 Provides established guardrails functionality supporting English, French, and Spanish languages.\n* `STANDARD` tier \u2013 Provides a more robust solution than the `CLASSIC` tier and has more comprehensive language support. This tier requires that your guardrail use [cross-Region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLASSIC | STANDARD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLASSIC", "STANDARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterstierconfig.html#cfn-bedrock-guardrail-contentfilterstierconfig-tiername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Guardrail.ContentPolicyConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.ContentPolicyConfig`\n\nContains details about how to handle harmful content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html", "Properties": { "ContentFiltersTierConfig": { "MarkdownDocumentation": "`ContentFiltersTierConfig`\n\nThe tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.\n*Required*: No\n*Type*: [ContentFiltersTierConfig](./aws-properties-bedrock-guardrail-contentfilterstierconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html#cfn-bedrock-guardrail-contentpolicyconfig-contentfilterstierconfig", "UpdateType": "Mutable", "Required": false, "Type": "ContentFiltersTierConfig" }, "FiltersConfig": { "MarkdownDocumentation": "`FiltersConfig`\n\nContains the type of the content filter and how strongly it should apply to prompts and model responses.\n*Required*: Yes\n*Type*: Array of [ContentFilterConfig](./aws-properties-bedrock-guardrail-contentfilterconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html#cfn-bedrock-guardrail-contentpolicyconfig-filtersconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ContentFilterConfig", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Guardrail.ContextualGroundingFilterConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.ContextualGroundingFilterConfig`\n\nThe filter configuration details for the guardrails contextual grounding filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe filter details for the guardrails contextual grounding filter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GROUNDING | RELEVANCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GROUNDING", "RELEVANCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nSpecifies the action to take when content fails the contextual grounding evaluation. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\nThe threshold details for the guardrails contextual grounding filter.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-threshold", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::Bedrock::Guardrail.ContextualGroundingPolicyConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.ContextualGroundingPolicyConfig`\n\nThe policy configuration details for the guardrails contextual grounding policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingpolicyconfig.html", "Properties": { "FiltersConfig": { "MarkdownDocumentation": "`FiltersConfig`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [ContextualGroundingFilterConfig](./aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingpolicyconfig.html#cfn-bedrock-guardrail-contextualgroundingpolicyconfig-filtersconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ContextualGroundingFilterConfig", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Guardrail.GuardrailCrossRegionConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.GuardrailCrossRegionConfig`\n\nThe system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.\nFor more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html", "Properties": { "GuardrailProfileArn": { "MarkdownDocumentation": "`GuardrailProfileArn`\n\nThe Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current AWS Region. For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$`\n*Minimum*: `15`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html#cfn-bedrock-guardrail-guardrailcrossregionconfig-guardrailprofilearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Guardrail.ManagedWordsConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.ManagedWordsConfig`\n\nThe managed word list to configure for the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe managed word type to configure for the guardrail.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PROFANITY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "PROFANITY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputEnabled": { "MarkdownDocumentation": "`InputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the input. When disabled, you\naren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-inputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InputAction": { "MarkdownDocumentation": "`InputAction`\n\nSpecifies the action to take when harmful content is detected in the input. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-inputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputAction": { "MarkdownDocumentation": "`OutputAction`\n\nSpecifies the action to take when harmful content is detected in the output. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-outputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputEnabled": { "MarkdownDocumentation": "`OutputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the output. When disabled, you\naren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-outputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Bedrock::Guardrail.PiiEntityConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.PiiEntityConfig`\n\nThe PII entity to configure for the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nConfigure guardrail type when the PII entity is detected.\nThe following PIIs are used to block or mask sensitive information:\n* **General**\n \n + **ADDRESS**\n \n A physical address, such as \"100 Main Street, Anytown, USA\"\n or \"Suite #12, Building 123\". An address can include information\n such as the street, building, location, city, state, country, county,\n zip code, precinct, and neighborhood.\n + **AGE**\n \n An individual's age, including the quantity and unit of time. For\n example, in the phrase \"I am 40 years old,\" Guardrails recognizes \"40 years\"\n as an age.\n + **NAME**\n \n An individual's name. This entity type does not include titles, such as\n Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that\n are part of organizations or addresses. For example, guardrails recognizes\n the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe\n Street\" as an address.\n + **EMAIL**\n \n An email address, such as *marymajor@email.com*.\n + **PHONE**\n \n A phone number. This entity type also includes fax and pager numbers.\n + **USERNAME**\n \n A user name that identifies an account, such as a login name, screen name,\n nick name, or handle.\n + **PASSWORD**\n \n An alphanumeric string that is used as a password, such as\n \"\\**very20special#pass\\**\".\n + **DRIVER\\_ID**\n \n The number assigned to a driver's license, which is an official\n document permitting an individual to operate one or more motorized\n vehicles on a public road. A driver's license number consists of\n alphanumeric characters.\n + **LICENSE\\_PLATE**\n \n A license plate for a vehicle is issued by the state or country where\n the vehicle is registered. The format for passenger vehicles is typically\n five to eight digits, consisting of upper-case letters and numbers. The\n format varies depending on the location of the issuing state or country.\n + **VEHICLE\\_IDENTIFICATION\\_NUMBER**\n \n A Vehicle Identification Number (VIN) uniquely identifies a vehicle.\n VIN content and format are defined in the *ISO 3779* specification.\n Each country has specific codes and formats for VINs.\n* **Finance**\n \n + **CREDIT\\_DEBIT\\_CARD\\_CVV**\n \n A three-digit card verification code (CVV) that is present on VISA,\n MasterCard, and Discover credit and debit cards. For American Express\n credit or debit cards, the CVV is a four-digit numeric code.\n + **CREDIT\\_DEBIT\\_CARD\\_EXPIRY**\n \n The expiration date for a credit or debit card. This number is usually\n four digits long and is often formatted as *month/year* or\n *MM/YY*. Guardrails recognizes expiration dates such as\n *01/21*, *01/2021*, and *Jan 2021*.\n + **CREDIT\\_DEBIT\\_CARD\\_NUMBER**\n \n The number for a credit or debit card. These numbers can vary from 13 to 16\n digits in length. However, Amazon Comprehend also recognizes credit or debit\n card numbers when only the last four digits are present.\n + **PIN**\n \n A four-digit personal identification number (PIN) with which you can\n access your bank account.\n + **INTERNATIONAL\\_BANK\\_ACCOUNT\\_NUMBER**\n \n An International Bank Account Number has specific formats in each country.\n For more information, see [www.iban.com/structure](https://www.iban.com/structure).\n + **SWIFT\\_CODE**\n \n A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify\n a particular bank or branch. Banks use these codes for money transfers such as\n international wire transfers.\n \n SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific\n branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the\n head or primary office.\n* **IT**\n \n + **IP\\_ADDRESS**\n \n An IPv4 address, such as *198.51.100.0*.\n + **MAC\\_ADDRESS**\n \n A *media access control* (MAC) address is a unique identifier\n assigned to a network interface controller (NIC).\n + **URL**\n \n A web address, such as *www.example.com*.\n + **AWS\\_ACCESS\\_KEY**\n \n A unique identifier that's associated with a secret access key;\n you use the access key ID and secret access key to sign programmatic\n AWS requests cryptographically.\n + **AWS\\_SECRET\\_KEY**\n \n A unique identifier that's associated with an access key. You use the\n access key ID and secret access key to sign programmatic AWS\n requests cryptographically.\n* **USA specific**\n \n + **US\\_BANK\\_ACCOUNT\\_NUMBER**\n \n A US bank account number, which is typically 10 to 12 digits long.\n + **US\\_BANK\\_ROUTING\\_NUMBER**\n \n A US bank account routing number. These are typically nine digits long,\n + **US\\_INDIVIDUAL\\_TAX\\_IDENTIFICATION\\_NUMBER**\n \n A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number\n that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN\n can be formatted with a space or a dash after the third and forth digits.\n + **US\\_PASSPORT\\_NUMBER**\n \n A US passport number. Passport numbers range from six to nine alphanumeric\n characters.\n + **US\\_SOCIAL\\_SECURITY\\_NUMBER**\n \n A US Social Security Number (SSN) is a nine-digit number that is issued to\n US citizens, permanent residents, and temporary working residents.\n* **Canada specific**\n \n + **CA\\_HEALTH\\_NUMBER**\n \n A Canadian Health Service Number is a 10-digit unique identifier,\n required for individuals to access healthcare benefits.\n + **CA\\_SOCIAL\\_INSURANCE\\_NUMBER**\n \n A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier,\n required for individuals to access government programs and benefits.\n \n The SIN is formatted as three groups of three digits, such as\n *123-456-789*. A SIN can be validated through a simple\n check-digit process called the [Luhn algorithm](https://www.wikipedia.org/wiki/Luhn_algorithm).\n* **UK Specific**\n \n + **UK\\_NATIONAL\\_HEALTH\\_SERVICE\\_NUMBER**\n \n A UK National Health Service Number is a 10-17 digit number,\n such as *485 777 3456*. The current system formats the 10-digit\n number with spaces after the third and sixth digits. The final digit is an\n error-detecting checksum.\n + **UK\\_NATIONAL\\_INSURANCE\\_NUMBER**\n \n A UK National Insurance Number (NINO) provides individuals with access to National\n Insurance (social security) benefits. It is also used for some purposes in the UK\n tax system.\n \n The number is nine digits long and starts with two letters, followed by six\n numbers and one letter. A NINO can be formatted with a space or a dash after\n the two letters and after the second, forth, and sixth digits.\n + **UK\\_UNIQUE\\_TAXPAYER\\_REFERENCE\\_NUMBER**\n \n A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.\n* **Custom**\n \n + **Regex filter** - You can use\n a regular expressions to define patterns for a guardrail to recognize\n and act upon such as serial number, booking ID etc..\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ADDRESS | AGE | AWS_ACCESS_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nConfigure guardrail action when the PII entity is detected.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BLOCK | ANONYMIZE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "ANONYMIZE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputEnabled": { "MarkdownDocumentation": "`InputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the input. When disabled, you aren't\ncharged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-inputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InputAction": { "MarkdownDocumentation": "`InputAction`\n\nSpecifies the action to take when harmful content is detected in the input. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `ANONYMIZE` \u2013 Mask the content and replace it with identifier\n tags.\n* `NONE` \u2013 Take no action but return detection information in the\n trace response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | ANONYMIZE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "ANONYMIZE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-inputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputAction": { "MarkdownDocumentation": "`OutputAction`\n\nSpecifies the action to take when harmful content is detected in the output. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `ANONYMIZE` \u2013 Mask the content and replace it with identifier\n tags.\n* `NONE` \u2013 Take no action but return detection information in the\n trace response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | ANONYMIZE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "ANONYMIZE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-outputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputEnabled": { "MarkdownDocumentation": "`OutputEnabled`\n\nIndicates whether guardrail evaluation is enabled on the output. When disabled, you\naren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-outputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Bedrock::Guardrail.RegexConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.RegexConfig`\n\nThe regular expression to configure for the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html", "Properties": { "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nThe regular expression pattern to configure for the guardrail.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-pattern", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nThe guardrail action to configure when matching regular expression is detected.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BLOCK | ANONYMIZE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "ANONYMIZE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputEnabled": { "MarkdownDocumentation": "`InputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the input. When disabled, you aren't\ncharged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the regular expression to configure for the guardrail.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputAction": { "MarkdownDocumentation": "`InputAction`\n\nSpecifies the action to take when harmful content is detected in the input. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | ANONYMIZE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "ANONYMIZE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputAction": { "MarkdownDocumentation": "`OutputAction`\n\nSpecifies the action to take when harmful content is detected in the output. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | ANONYMIZE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "ANONYMIZE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputEnabled": { "MarkdownDocumentation": "`OutputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the output. When disabled, you\naren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the regular expression to configure for the guardrail.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Guardrail.SensitiveInformationPolicyConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.SensitiveInformationPolicyConfig`\n\nContains details about PII entities and regular expressions to configure for the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html", "Properties": { "RegexesConfig": { "MarkdownDocumentation": "`RegexesConfig`\n\nA list of regular expressions to configure to the guardrail.\n*Required*: No\n*Type*: Array of [RegexConfig](./aws-properties-bedrock-guardrail-regexconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-regexesconfig", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RegexConfig", "DuplicatesAllowed": true }, "PiiEntitiesConfig": { "MarkdownDocumentation": "`PiiEntitiesConfig`\n\nA list of PII entities to configure to the guardrail.\n*Required*: No\n*Type*: Array of [PiiEntityConfig](./aws-properties-bedrock-guardrail-piientityconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-piientitiesconfig", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PiiEntityConfig", "DuplicatesAllowed": false } } }, "AWS::Bedrock::Guardrail.TopicConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.TopicConfig`\n\nDetails about topics for the guardrail to identify and deny.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies to deny the topic.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputEnabled": { "MarkdownDocumentation": "`InputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the input. When disabled, you aren't\ncharged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InputAction": { "MarkdownDocumentation": "`InputAction`\n\nSpecifies the action to take when harmful content is detected in the input. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-inputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputAction": { "MarkdownDocumentation": "`OutputAction`\n\nSpecifies the action to take when harmful content is detected in the output. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nA definition of the topic to deny.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-definition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OutputEnabled": { "MarkdownDocumentation": "`OutputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the output. When disabled, you\naren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-outputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Examples": { "MarkdownDocumentation": "`Examples`\n\nA list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `100`\n*Minimum*: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-examples", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the topic to deny.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z-_ !?.]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Guardrail.TopicPolicyConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.TopicPolicyConfig`\n\nContains details about topics that the guardrail should identify and deny.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html", "Properties": { "TopicsTierConfig": { "MarkdownDocumentation": "`TopicsTierConfig`\n\nThe tier that your guardrail uses for denied topic filters.\n*Required*: No\n*Type*: [TopicsTierConfig](./aws-properties-bedrock-guardrail-topicstierconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html#cfn-bedrock-guardrail-topicpolicyconfig-topicstierconfig", "UpdateType": "Mutable", "Required": false, "Type": "TopicsTierConfig" }, "TopicsConfig": { "MarkdownDocumentation": "`TopicsConfig`\n\nA list of policies related to topics that the guardrail should deny.\n*Required*: Yes\n*Type*: Array of [TopicConfig](./aws-properties-bedrock-guardrail-topicconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html#cfn-bedrock-guardrail-topicpolicyconfig-topicsconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TopicConfig", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Guardrail.TopicsTierConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.TopicsTierConfig`\n\nThe tier that your guardrail uses for denied topic filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicstierconfig.html", "Properties": { "TierName": { "MarkdownDocumentation": "`TierName`\n\nThe tier that your guardrail uses for denied topic filters. Valid values include:\n* `CLASSIC` tier \u2013 Provides established guardrails functionality supporting English, French, and Spanish languages.\n* `STANDARD` tier \u2013 Provides a more robust solution than the `CLASSIC` tier and has more comprehensive language support. This tier requires that your guardrail use [cross-Region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLASSIC | STANDARD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLASSIC", "STANDARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicstierconfig.html#cfn-bedrock-guardrail-topicstierconfig-tiername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Guardrail.WordConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.WordConfig`\n\nA word to configure for the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html", "Properties": { "InputEnabled": { "MarkdownDocumentation": "`InputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the intput. When disabled, you\naren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InputAction": { "MarkdownDocumentation": "`InputAction`\n\nSpecifies the action to take when harmful content is detected in the input. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputAction": { "MarkdownDocumentation": "`OutputAction`\n\nSpecifies the action to take when harmful content is detected in the output. Supported values include:\n* `BLOCK` \u2013 Block the content and replace it with blocked\n messaging.\n* `NONE` \u2013 Take no action but return detection information in the trace\n response.\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputEnabled": { "MarkdownDocumentation": "`OutputEnabled`\n\nSpecifies whether to enable guardrail evaluation on the output. When disabled, you\naren't charged for the evaluation. The evaluation doesn't appear in the response.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Text": { "MarkdownDocumentation": "`Text`\n\nText of the word configured for the guardrail to block.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-text", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Guardrail.WordPolicyConfig": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail.WordPolicyConfig`\n\nContains details about the word policy to configured for the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html", "Properties": { "ManagedWordListsConfig": { "MarkdownDocumentation": "`ManagedWordListsConfig`\n\nA list of managed words to configure for the guardrail.\n*Required*: No\n*Type*: Array of [ManagedWordsConfig](./aws-properties-bedrock-guardrail-managedwordsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html#cfn-bedrock-guardrail-wordpolicyconfig-managedwordlistsconfig", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ManagedWordsConfig", "DuplicatesAllowed": true }, "WordsConfig": { "MarkdownDocumentation": "`WordsConfig`\n\nA list of words to configure for the guardrail.\n*Required*: No\n*Type*: Array of [WordConfig](./aws-properties-bedrock-guardrail-wordconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html#cfn-bedrock-guardrail-wordpolicyconfig-wordsconfig", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "WordConfig", "DuplicatesAllowed": true } } }, "AWS::Bedrock::IntelligentPromptRouter.PromptRouterTargetModel": { "MarkdownDocumentation": "`AWS::Bedrock::IntelligentPromptRouter.PromptRouterTargetModel`\n\nThe target model for a prompt router.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-intelligentpromptrouter-promptroutertargetmodel.html", "Properties": { "ModelArn": { "MarkdownDocumentation": "`ModelArn`\n\nThe target model's ARN.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-intelligentpromptrouter-promptroutertargetmodel.html#cfn-bedrock-intelligentpromptrouter-promptroutertargetmodel-modelarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::IntelligentPromptRouter.RoutingCriteria": { "MarkdownDocumentation": "`AWS::Bedrock::IntelligentPromptRouter.RoutingCriteria`\n\nRouting criteria for a prompt router.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-intelligentpromptrouter-routingcriteria.html", "Properties": { "ResponseQualityDifference": { "MarkdownDocumentation": "`ResponseQualityDifference`\n\nThe criteria's response quality difference.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-intelligentpromptrouter-routingcriteria.html#cfn-bedrock-intelligentpromptrouter-routingcriteria-responsequalitydifference", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::Bedrock::KnowledgeBase.AudioConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.AudioConfiguration`\n\nConfiguration settings for processing audio content in multimodal knowledge bases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-audioconfiguration.html", "Properties": { "SegmentationConfiguration": { "MarkdownDocumentation": "`SegmentationConfiguration`\n\nConfiguration for segmenting audio content during processing.\n*Required*: Yes\n*Type*: [AudioSegmentationConfiguration](./aws-properties-bedrock-knowledgebase-audiosegmentationconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-audioconfiguration.html#cfn-bedrock-knowledgebase-audioconfiguration-segmentationconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "AudioSegmentationConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.AudioSegmentationConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.AudioSegmentationConfiguration`\n\nConfiguration for segmenting audio content during multimodal knowledge base ingestion. Determines how audio files are divided into chunks for processing.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-audiosegmentationconfiguration.html", "Properties": { "FixedLengthDuration": { "MarkdownDocumentation": "`FixedLengthDuration`\n\nThe duration in seconds for each audio segment. Audio files will be divided into chunks of this length for processing.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-audiosegmentationconfiguration.html#cfn-bedrock-knowledgebase-audiosegmentationconfiguration-fixedlengthduration", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Bedrock::KnowledgeBase.BedrockEmbeddingModelConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.BedrockEmbeddingModelConfiguration`\n\nThe vector configuration details for the Bedrock embeddings model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html", "Properties": { "EmbeddingDataType": { "MarkdownDocumentation": "`EmbeddingDataType`\n\nThe data type for the vectors when using a model to convert text into vector\nembeddings. The model must support the specified data type for vector embeddings.\nFloating-point (float32) is the default data type, and is supported by most models\nfor vector embeddings. See [Supported embeddings\nmodels](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html) for information on the available models and their vector data types.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLOAT32 | BINARY...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FLOAT32", "BINARY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-embeddingdatatype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Video": { "MarkdownDocumentation": "`Video`\n\nConfiguration settings for processing video content in multimodal knowledge bases.\n*Required*: No\n*Type*: Array of [VideoConfiguration](./aws-properties-bedrock-knowledgebase-videoconfiguration.html)\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-video", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "VideoConfiguration", "DuplicatesAllowed": true }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions details for the vector configuration used on the Bedrock embeddings model.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `4096`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-dimensions", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Audio": { "MarkdownDocumentation": "`Audio`\n\nConfiguration settings for processing audio content in multimodal knowledge bases.\n*Required*: No\n*Type*: Array of [AudioConfiguration](./aws-properties-bedrock-knowledgebase-audioconfiguration.html)\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-audio", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AudioConfiguration", "DuplicatesAllowed": true } } }, "AWS::Bedrock::KnowledgeBase.CuratedQuery": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.CuratedQuery`\n\nContains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-curatedquery.html", "Properties": { "NaturalLanguage": { "MarkdownDocumentation": "`NaturalLanguage`\n\nAn example natural language query.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-curatedquery.html#cfn-bedrock-knowledgebase-curatedquery-naturallanguage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Sql": { "MarkdownDocumentation": "`Sql`\n\nThe SQL equivalent of the natural language query.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-curatedquery.html#cfn-bedrock-knowledgebase-curatedquery-sql", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.EmbeddingModelConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.EmbeddingModelConfiguration`\n\nThe configuration details for the embeddings model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-embeddingmodelconfiguration.html", "Properties": { "BedrockEmbeddingModelConfiguration": { "MarkdownDocumentation": "`BedrockEmbeddingModelConfiguration`\n\nThe vector configuration details on the Bedrock embeddings model.\n*Required*: No\n*Type*: [BedrockEmbeddingModelConfiguration](./aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-embeddingmodelconfiguration.html#cfn-bedrock-knowledgebase-embeddingmodelconfiguration-bedrockembeddingmodelconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "BedrockEmbeddingModelConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.KendraKnowledgeBaseConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.KendraKnowledgeBaseConfiguration`\n\nSettings for an Amazon Kendra knowledge base.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-kendraknowledgebaseconfiguration.html", "Properties": { "KendraIndexArn": { "MarkdownDocumentation": "`KendraIndexArn`\n\nThe ARN of the Amazon Kendra index.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):kendra:[a-z0-9-]{1,20}:([0-9]{12}|):index/([a-zA-Z0-9][a-zA-Z0-9-]{35}|[a-zA-Z0-9][a-zA-Z0-9-]{35}-[a-zA-Z0-9][a-zA-Z0-9-]{35})$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-kendraknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-kendraknowledgebaseconfiguration-kendraindexarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.KnowledgeBaseConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.KnowledgeBaseConfiguration`\n\nConfigurations to apply to a knowledge base attached to the agent during query. For more information, see [Knowledge base retrieval configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html#session-state-kb).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of data that the data source is converted into for the knowledge base.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VECTOR | KENDRA | SQL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "VECTOR", "KENDRA", "SQL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SqlKnowledgeBaseConfiguration": { "MarkdownDocumentation": "`SqlKnowledgeBaseConfiguration`\n\nSpecifies configurations for a knowledge base connected to an SQL database.\n*Required*: No\n*Type*: [SqlKnowledgeBaseConfiguration](./aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-sqlknowledgebaseconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SqlKnowledgeBaseConfiguration" }, "KendraKnowledgeBaseConfiguration": { "MarkdownDocumentation": "`KendraKnowledgeBaseConfiguration`\n\nSettings for an Amazon Kendra knowledge base.\n*Required*: No\n*Type*: [KendraKnowledgeBaseConfiguration](./aws-properties-bedrock-knowledgebase-kendraknowledgebaseconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-kendraknowledgebaseconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "KendraKnowledgeBaseConfiguration" }, "VectorKnowledgeBaseConfiguration": { "MarkdownDocumentation": "`VectorKnowledgeBaseConfiguration`\n\nContains details about the model that's used to convert the data source into vector embeddings.\n*Required*: No\n*Type*: [VectorKnowledgeBaseConfiguration](./aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-vectorknowledgebaseconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "VectorKnowledgeBaseConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.MongoDbAtlasConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.MongoDbAtlasConfiguration`\n\nContains details about the storage configuration of the knowledge base in MongoDB Atlas.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html", "Properties": { "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint URL of your MongoDB Atlas cluster for your knowledge base.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]+\\.mongodb\\.net$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-endpoint", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CollectionName": { "MarkdownDocumentation": "`CollectionName`\n\nThe collection name of the knowledge base in MongoDB Atlas.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-collectionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VectorIndexName": { "MarkdownDocumentation": "`VectorIndexName`\n\nThe name of the MongoDB Atlas vector search index.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-vectorindexname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FieldMapping": { "MarkdownDocumentation": "`FieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n*Required*: Yes\n*Type*: [MongoDbAtlasFieldMapping](./aws-properties-bedrock-knowledgebase-mongodbatlasfieldmapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-fieldmapping", "UpdateType": "Immutable", "Required": true, "Type": "MongoDbAtlasFieldMapping" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe database name in your MongoDB Atlas cluster for your knowledge base.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EndpointServiceName": { "MarkdownDocumentation": "`EndpointServiceName`\n\nThe name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-endpointservicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CredentialsSecretArn": { "MarkdownDocumentation": "`CredentialsSecretArn`\n\nThe Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that contains user credentials for your MongoDB Atlas cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-credentialssecretarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TextIndexName": { "MarkdownDocumentation": "`TextIndexName`\n\nThe name of the text search index in the MongoDB collection. This is required for using the hybrid search\nfeature.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-textindexname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.MongoDbAtlasFieldMapping": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.MongoDbAtlasFieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasfieldmapping.html", "Properties": { "VectorField": { "MarkdownDocumentation": "`VectorField`\n\nThe name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasfieldmapping.html#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-vectorfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nThe name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasfieldmapping.html#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-textfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MetadataField": { "MarkdownDocumentation": "`MetadataField`\n\nThe name of the field in which Amazon Bedrock stores metadata about the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasfieldmapping.html#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-metadatafield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.NeptuneAnalyticsConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.NeptuneAnalyticsConfiguration`\n\nContains details about the storage configuration of the knowledge base in\nAmazon Neptune Analytics. For more information, see [Create a vector index\nin Amazon Neptune Analytics](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsconfiguration.html", "Properties": { "GraphArn": { "MarkdownDocumentation": "`GraphArn`\n\nThe Amazon Resource Name (ARN) of the Neptune Analytics vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):neptune-graph:[a-zA-Z0-9-]*:[0-9]{12}:graph\\/g-[a-zA-Z0-9]{10}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsconfiguration.html#cfn-bedrock-knowledgebase-neptuneanalyticsconfiguration-grapharn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FieldMapping": { "MarkdownDocumentation": "`FieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n*Required*: Yes\n*Type*: [NeptuneAnalyticsFieldMapping](./aws-properties-bedrock-knowledgebase-neptuneanalyticsfieldmapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsconfiguration.html#cfn-bedrock-knowledgebase-neptuneanalyticsconfiguration-fieldmapping", "UpdateType": "Immutable", "Required": true, "Type": "NeptuneAnalyticsFieldMapping" } } }, "AWS::Bedrock::KnowledgeBase.NeptuneAnalyticsFieldMapping": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.NeptuneAnalyticsFieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsfieldmapping.html", "Properties": { "TextField": { "MarkdownDocumentation": "`TextField`\n\nThe name of the field in which Amazon Bedrock stores the raw text from your data. The text\nis split according to the chunking strategy you choose.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsfieldmapping.html#cfn-bedrock-knowledgebase-neptuneanalyticsfieldmapping-textfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MetadataField": { "MarkdownDocumentation": "`MetadataField`\n\nThe name of the field in which Amazon Bedrock stores metadata about the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsfieldmapping.html#cfn-bedrock-knowledgebase-neptuneanalyticsfieldmapping-metadatafield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.OpenSearchManagedClusterConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.OpenSearchManagedClusterConfiguration`\n\nContains details about the Managed Cluster configuration of the knowledge base in Amazon OpenSearch Service. For more information,\nsee [Create a vector index in OpenSearch Managed Cluster](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterconfiguration.html", "Properties": { "DomainEndpoint": { "MarkdownDocumentation": "`DomainEndpoint`\n\nThe endpoint URL the OpenSearch domain.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https://.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterconfiguration.html#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-domainendpoint", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VectorIndexName": { "MarkdownDocumentation": "`VectorIndexName`\n\nThe name of the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?![\\-_+.])[a-z0-9][a-z0-9\\-_\\.]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterconfiguration.html#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-vectorindexname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FieldMapping": { "MarkdownDocumentation": "`FieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n*Required*: Yes\n*Type*: [OpenSearchManagedClusterFieldMapping](./aws-properties-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterconfiguration.html#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-fieldmapping", "UpdateType": "Immutable", "Required": true, "Type": "OpenSearchManagedClusterFieldMapping" }, "DomainArn": { "MarkdownDocumentation": "`DomainArn`\n\nThe Amazon Resource Name (ARN) of the OpenSearch domain.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:es:([a-z]{2,}-){2,}\\d:\\d{12}:domain/[a-z][a-z0-9-]{3,28}$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterconfiguration.html#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-domainarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.OpenSearchManagedClusterFieldMapping": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.OpenSearchManagedClusterFieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping.html", "Properties": { "VectorField": { "MarkdownDocumentation": "`VectorField`\n\nThe name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping.html#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-vectorfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nThe name of the field in which Amazon Bedrock stores the raw text from your data. The text\nis split according to the chunking strategy you choose.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping.html#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-textfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MetadataField": { "MarkdownDocumentation": "`MetadataField`\n\nThe name of the field in which Amazon Bedrock stores metadata about the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping.html#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-metadatafield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.OpenSearchServerlessConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.OpenSearchServerlessConfiguration`\n\nContains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html", "Properties": { "CollectionArn": { "MarkdownDocumentation": "`CollectionArn`\n\nThe Amazon Resource Name (ARN) of the OpenSearch Service vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov|-iso):aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-collectionarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VectorIndexName": { "MarkdownDocumentation": "`VectorIndexName`\n\nThe name of the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-vectorindexname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FieldMapping": { "MarkdownDocumentation": "`FieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n*Required*: Yes\n*Type*: [OpenSearchServerlessFieldMapping](./aws-properties-bedrock-knowledgebase-opensearchserverlessfieldmapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-fieldmapping", "UpdateType": "Immutable", "Required": true, "Type": "OpenSearchServerlessFieldMapping" } } }, "AWS::Bedrock::KnowledgeBase.OpenSearchServerlessFieldMapping": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.OpenSearchServerlessFieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessfieldmapping.html", "Properties": { "VectorField": { "MarkdownDocumentation": "`VectorField`\n\nThe name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessfieldmapping.html#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-vectorfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nThe name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessfieldmapping.html#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-textfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MetadataField": { "MarkdownDocumentation": "`MetadataField`\n\nThe name of the field in which Amazon Bedrock stores metadata about the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessfieldmapping.html#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-metadatafield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.PineconeConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.PineconeConfiguration`\n\nContains details about the storage configuration of the knowledge base in Pinecone. For more information, see [Create a vector index in Pinecone](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-pineconeconfiguration.html", "Properties": { "FieldMapping": { "MarkdownDocumentation": "`FieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n*Required*: Yes\n*Type*: [PineconeFieldMapping](./aws-properties-bedrock-knowledgebase-pineconefieldmapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-pineconeconfiguration.html#cfn-bedrock-knowledgebase-pineconeconfiguration-fieldmapping", "UpdateType": "Immutable", "Required": true, "Type": "PineconeFieldMapping" }, "CredentialsSecretArn": { "MarkdownDocumentation": "`CredentialsSecretArn`\n\nThe Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-pineconeconfiguration.html#cfn-bedrock-knowledgebase-pineconeconfiguration-credentialssecretarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ConnectionString": { "MarkdownDocumentation": "`ConnectionString`\n\nThe endpoint URL for your index management page.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-pineconeconfiguration.html#cfn-bedrock-knowledgebase-pineconeconfiguration-connectionstring", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace to be used to write new data to your database.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-pineconeconfiguration.html#cfn-bedrock-knowledgebase-pineconeconfiguration-namespace", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.PineconeFieldMapping": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.PineconeFieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-pineconefieldmapping.html", "Properties": { "TextField": { "MarkdownDocumentation": "`TextField`\n\nThe name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-pineconefieldmapping.html#cfn-bedrock-knowledgebase-pineconefieldmapping-textfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MetadataField": { "MarkdownDocumentation": "`MetadataField`\n\nThe name of the field in which Amazon Bedrock stores metadata about the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-pineconefieldmapping.html#cfn-bedrock-knowledgebase-pineconefieldmapping-metadatafield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.QueryGenerationColumn": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.QueryGenerationColumn`\n\nContains information about a column in the current table for the query engine to consider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcolumn.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the column that helps the query engine understand the contents of the column.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcolumn.html#cfn-bedrock-knowledgebase-querygenerationcolumn-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inclusion": { "MarkdownDocumentation": "`Inclusion`\n\nSpecifies whether to include or exclude the column during query generation. If you specify `EXCLUDE`, the column will be ignored. If you specify `INCLUDE`, all other columns in the table will be ignored.\n*Required*: No\n*Type*: String\n*Allowed values*: `INCLUDE | EXCLUDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCLUDE", "EXCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcolumn.html#cfn-bedrock-knowledgebase-querygenerationcolumn-inclusion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the column for which the other fields in this object apply.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcolumn.html#cfn-bedrock-knowledgebase-querygenerationcolumn-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.QueryGenerationConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.QueryGenerationConfiguration`\n\nContains configurations for query generation. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationconfiguration.html", "Properties": { "GenerationContext": { "MarkdownDocumentation": "`GenerationContext`\n\nSpecifies configurations for context to use during query generation.\n*Required*: No\n*Type*: [QueryGenerationContext](./aws-properties-bedrock-knowledgebase-querygenerationcontext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationconfiguration.html#cfn-bedrock-knowledgebase-querygenerationconfiguration-generationcontext", "UpdateType": "Mutable", "Required": false, "Type": "QueryGenerationContext" }, "ExecutionTimeoutSeconds": { "MarkdownDocumentation": "`ExecutionTimeoutSeconds`\n\nThe time after which query generation will time out.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationconfiguration.html#cfn-bedrock-knowledgebase-querygenerationconfiguration-executiontimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Bedrock::KnowledgeBase.QueryGenerationContext": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.QueryGenerationContext`\n\n>Contains configurations for context to use during query generation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html", "Properties": { "CuratedQueries": { "MarkdownDocumentation": "`CuratedQueries`\n\nAn array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.\n*Required*: No\n*Type*: Array of [CuratedQuery](./aws-properties-bedrock-knowledgebase-curatedquery.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html#cfn-bedrock-knowledgebase-querygenerationcontext-curatedqueries", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CuratedQuery", "DuplicatesAllowed": true }, "Tables": { "MarkdownDocumentation": "`Tables`\n\nAn array of objects, each of which defines information about a table in the database.\n*Required*: No\n*Type*: Array of [QueryGenerationTable](./aws-properties-bedrock-knowledgebase-querygenerationtable.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html#cfn-bedrock-knowledgebase-querygenerationcontext-tables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "QueryGenerationTable", "DuplicatesAllowed": true } } }, "AWS::Bedrock::KnowledgeBase.QueryGenerationTable": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.QueryGenerationTable`\n\nContains information about a table for the query engine to consider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the table that helps the query engine understand the contents of the table.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inclusion": { "MarkdownDocumentation": "`Inclusion`\n\nSpecifies whether to include or exclude the table during query generation. If you specify `EXCLUDE`, the table will be ignored. If you specify `INCLUDE`, all other tables will be ignored.\n*Required*: No\n*Type*: String\n*Allowed values*: `INCLUDE | EXCLUDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCLUDE", "EXCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-inclusion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nAn array of objects, each of which defines information about a column in the table.\n*Required*: No\n*Type*: Array of [QueryGenerationColumn](./aws-properties-bedrock-knowledgebase-querygenerationcolumn.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "QueryGenerationColumn", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the table for which the other fields in this object apply.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.RdsConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RdsConfiguration`\n\nContains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the table in the database.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\.\\-]+$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-tablename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FieldMapping": { "MarkdownDocumentation": "`FieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n*Required*: Yes\n*Type*: [RdsFieldMapping](./aws-properties-bedrock-knowledgebase-rdsfieldmapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-fieldmapping", "UpdateType": "Immutable", "Required": true, "Type": "RdsFieldMapping" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of your Amazon RDS database.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-]+$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CredentialsSecretArn": { "MarkdownDocumentation": "`CredentialsSecretArn`\n\nThe Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-credentialssecretarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.RdsFieldMapping": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RdsFieldMapping`\n\nContains the names of the fields to which to map information about the vector store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsfieldmapping.html", "Properties": { "PrimaryKeyField": { "MarkdownDocumentation": "`PrimaryKeyField`\n\nThe name of the field in which Amazon Bedrock stores the ID for each entry.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-]+$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsfieldmapping.html#cfn-bedrock-knowledgebase-rdsfieldmapping-primarykeyfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VectorField": { "MarkdownDocumentation": "`VectorField`\n\nThe name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-]+$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsfieldmapping.html#cfn-bedrock-knowledgebase-rdsfieldmapping-vectorfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nThe name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-]+$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsfieldmapping.html#cfn-bedrock-knowledgebase-rdsfieldmapping-textfield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CustomMetadataField": { "MarkdownDocumentation": "`CustomMetadataField`\n\nProvide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from\nyour data source.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-]+$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsfieldmapping.html#cfn-bedrock-knowledgebase-rdsfieldmapping-custommetadatafield", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MetadataField": { "MarkdownDocumentation": "`MetadataField`\n\nThe name of the field in which Amazon Bedrock stores metadata about the vector store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-]+$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsfieldmapping.html#cfn-bedrock-knowledgebase-rdsfieldmapping-metadatafield", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.RedshiftConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftConfiguration`\n\nContains configurations for an Amazon Redshift database. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftconfiguration.html", "Properties": { "QueryEngineConfiguration": { "MarkdownDocumentation": "`QueryEngineConfiguration`\n\nSpecifies configurations for an Amazon Redshift query engine.\n*Required*: Yes\n*Type*: [RedshiftQueryEngineConfiguration](./aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftconfiguration.html#cfn-bedrock-knowledgebase-redshiftconfiguration-queryengineconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "RedshiftQueryEngineConfiguration" }, "StorageConfigurations": { "MarkdownDocumentation": "`StorageConfigurations`\n\nSpecifies configurations for Amazon Redshift database storage.\n*Required*: Yes\n*Type*: Array of [RedshiftQueryEngineStorageConfiguration](./aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html)\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftconfiguration.html#cfn-bedrock-knowledgebase-redshiftconfiguration-storageconfigurations", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "RedshiftQueryEngineStorageConfiguration", "DuplicatesAllowed": true }, "QueryGenerationConfiguration": { "MarkdownDocumentation": "`QueryGenerationConfiguration`\n\nSpecifies configurations for generating queries.\n*Required*: No\n*Type*: [QueryGenerationConfiguration](./aws-properties-bedrock-knowledgebase-querygenerationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftconfiguration.html#cfn-bedrock-knowledgebase-redshiftconfiguration-querygenerationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "QueryGenerationConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.RedshiftProvisionedAuthConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftProvisionedAuthConfiguration`\n\nContains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the `type` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of authentication to use.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IAM | USERNAME_PASSWORD | U...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IAM", "USERNAME_PASSWORD", "USERNAME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DatabaseUser": { "MarkdownDocumentation": "`DatabaseUser`\n\nThe database username for authentication to an Amazon Redshift provisioned data warehouse.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-databaseuser", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UsernamePasswordSecretArn": { "MarkdownDocumentation": "`UsernamePasswordSecretArn`\n\nThe ARN of an Secrets Manager secret for authentication.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-usernamepasswordsecretarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.RedshiftProvisionedConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftProvisionedConfiguration`\n\nContains configurations for a provisioned Amazon Redshift query engine.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedconfiguration.html", "Properties": { "AuthConfiguration": { "MarkdownDocumentation": "`AuthConfiguration`\n\nSpecifies configurations for authentication to Amazon Redshift.\n*Required*: Yes\n*Type*: [RedshiftProvisionedAuthConfiguration](./aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedconfiguration-authconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "RedshiftProvisionedAuthConfiguration" }, "ClusterIdentifier": { "MarkdownDocumentation": "`ClusterIdentifier`\n\nThe ID of the Amazon Redshift cluster.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedconfiguration-clusteridentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.RedshiftQueryEngineAwsDataCatalogStorageConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftQueryEngineAwsDataCatalogStorageConfiguration`\n\nContains configurations for storage in AWS Glue Data Catalog.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration.html", "Properties": { "TableNames": { "MarkdownDocumentation": "`TableNames`\n\nA list of names of the tables to use.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration-tablenames", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Bedrock::KnowledgeBase.RedshiftQueryEngineConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftQueryEngineConfiguration`\n\nContains configurations for an Amazon Redshift query engine. Specify the type of query engine in `type` and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of query engine.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SERVERLESS | PROVISIONED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SERVERLESS", "PROVISIONED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProvisionedConfiguration": { "MarkdownDocumentation": "`ProvisionedConfiguration`\n\nSpecifies configurations for a provisioned Amazon Redshift query engine.\n*Required*: No\n*Type*: [RedshiftProvisionedConfiguration](./aws-properties-bedrock-knowledgebase-redshiftprovisionedconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-provisionedconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "RedshiftProvisionedConfiguration" }, "ServerlessConfiguration": { "MarkdownDocumentation": "`ServerlessConfiguration`\n\nSpecifies configurations for a serverless Amazon Redshift query engine.\n*Required*: No\n*Type*: [RedshiftServerlessConfiguration](./aws-properties-bedrock-knowledgebase-redshiftserverlessconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-serverlessconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "RedshiftServerlessConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.RedshiftQueryEngineRedshiftStorageConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftQueryEngineRedshiftStorageConfiguration`\n\nContains configurations for storage in Amazon Redshift.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration.html", "Properties": { "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the Amazon Redshift database.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.RedshiftQueryEngineStorageConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftQueryEngineStorageConfiguration`\n\nContains configurations for Amazon Redshift data storage. Specify the data storage service to use in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe data storage service to use.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `REDSHIFT | AWS_DATA_CATALOG...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "REDSHIFT", "AWS_DATA_CATALOG" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RedshiftConfiguration": { "MarkdownDocumentation": "`RedshiftConfiguration`\n\nSpecifies configurations for storage in Amazon Redshift.\n*Required*: No\n*Type*: [RedshiftQueryEngineRedshiftStorageConfiguration](./aws-properties-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-redshiftconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "RedshiftQueryEngineRedshiftStorageConfiguration" }, "AwsDataCatalogConfiguration": { "MarkdownDocumentation": "`AwsDataCatalogConfiguration`\n\nSpecifies configurations for storage in AWS Glue Data Catalog.\n*Required*: No\n*Type*: [RedshiftQueryEngineAwsDataCatalogStorageConfiguration](./aws-properties-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.html#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-awsdatacatalogconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "RedshiftQueryEngineAwsDataCatalogStorageConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.RedshiftServerlessAuthConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftServerlessAuthConfiguration`\n\nSpecifies configurations for authentication to a Redshift Serverless. Specify the type of authentication to use in the `type` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessauthconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of authentication to use.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IAM | USERNAME_PASSWORD...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IAM", "USERNAME_PASSWORD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftserverlessauthconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UsernamePasswordSecretArn": { "MarkdownDocumentation": "`UsernamePasswordSecretArn`\n\nThe ARN of an Secrets Manager secret for authentication.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftserverlessauthconfiguration-usernamepasswordsecretarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.RedshiftServerlessConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.RedshiftServerlessConfiguration`\n\nContains configurations for authentication to Amazon Redshift Serverless.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessconfiguration.html", "Properties": { "WorkgroupArn": { "MarkdownDocumentation": "`WorkgroupArn`\n\nThe ARN of the Amazon Redshift workgroup.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessconfiguration.html#cfn-bedrock-knowledgebase-redshiftserverlessconfiguration-workgrouparn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AuthConfiguration": { "MarkdownDocumentation": "`AuthConfiguration`\n\nSpecifies configurations for authentication to an Amazon Redshift provisioned data warehouse.\n*Required*: Yes\n*Type*: [RedshiftServerlessAuthConfiguration](./aws-properties-bedrock-knowledgebase-redshiftserverlessauthconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftserverlessconfiguration.html#cfn-bedrock-knowledgebase-redshiftserverlessconfiguration-authconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "RedshiftServerlessAuthConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.S3Location": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.S3Location`\n\nA storage location in an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3location.html", "Properties": { "URI": { "MarkdownDocumentation": "`URI`\n\nAn object URI starting with `s3://`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^s3://.{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3location.html#cfn-bedrock-knowledgebase-s3location-uri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.S3VectorsConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.S3VectorsConfiguration`\n\nContains the storage configuration of the knowledge base for S3 vectors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html#cfn-bedrock-knowledgebase-s3vectorsconfiguration-indexname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VectorBucketArn": { "MarkdownDocumentation": "`VectorBucketArn`\n\nThe Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html#cfn-bedrock-knowledgebase-s3vectorsconfiguration-vectorbucketarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IndexArn": { "MarkdownDocumentation": "`IndexArn`\n\nThe Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html#cfn-bedrock-knowledgebase-s3vectorsconfiguration-indexarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::KnowledgeBase.SqlKnowledgeBaseConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.SqlKnowledgeBaseConfiguration`\n\nContains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of SQL database to connect to the knowledge base.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `REDSHIFT`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "REDSHIFT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RedshiftConfiguration": { "MarkdownDocumentation": "`RedshiftConfiguration`\n\nSpecifies configurations for a knowledge base connected to an Amazon Redshift database.\n*Required*: No\n*Type*: [RedshiftConfiguration](./aws-properties-bedrock-knowledgebase-redshiftconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-redshiftconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.StorageConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.StorageConfiguration`\n\nContains the storage configuration of the knowledge base.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html", "Properties": { "S3VectorsConfiguration": { "MarkdownDocumentation": "`S3VectorsConfiguration`\n\nThe configuration settings for storing knowledge base data using S3 vectors. This includes vector index information and S3 bucket details for vector storage.\n*Required*: No\n*Type*: [S3VectorsConfiguration](./aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html#cfn-bedrock-knowledgebase-storageconfiguration-s3vectorsconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "S3VectorsConfiguration" }, "OpensearchManagedClusterConfiguration": { "MarkdownDocumentation": "`OpensearchManagedClusterConfiguration`\n\nContains details about the storage configuration of the knowledge base in OpenSearch Managed\nCluster. For more information, see [Create\na vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html).\n*Required*: No\n*Type*: [OpenSearchManagedClusterConfiguration](./aws-properties-bedrock-knowledgebase-opensearchmanagedclusterconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html#cfn-bedrock-knowledgebase-storageconfiguration-opensearchmanagedclusterconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "OpenSearchManagedClusterConfiguration" }, "OpensearchServerlessConfiguration": { "MarkdownDocumentation": "`OpensearchServerlessConfiguration`\n\nContains the storage configuration of the knowledge base in Amazon OpenSearch Service.\n*Required*: No\n*Type*: [OpenSearchServerlessConfiguration](./aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html#cfn-bedrock-knowledgebase-storageconfiguration-opensearchserverlessconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "OpenSearchServerlessConfiguration" }, "NeptuneAnalyticsConfiguration": { "MarkdownDocumentation": "`NeptuneAnalyticsConfiguration`\n\nContains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information,\nsee [Create a\nvector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html).\n*Required*: No\n*Type*: [NeptuneAnalyticsConfiguration](./aws-properties-bedrock-knowledgebase-neptuneanalyticsconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html#cfn-bedrock-knowledgebase-storageconfiguration-neptuneanalyticsconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "NeptuneAnalyticsConfiguration" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe vector store service in which the knowledge base is stored.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OPENSEARCH_SERVERLESS | PIN...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "OPENSEARCH_SERVERLESS", "PINECONE", "RDS", "MONGO_DB_ATLAS", "NEPTUNE_ANALYTICS", "S3_VECTORS", "OPENSEARCH_MANAGED_CLUSTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html#cfn-bedrock-knowledgebase-storageconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MongoDbAtlasConfiguration": { "MarkdownDocumentation": "`MongoDbAtlasConfiguration`\n\nContains the storage configuration of the knowledge base in MongoDB Atlas.\n*Required*: No\n*Type*: [MongoDbAtlasConfiguration](./aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html#cfn-bedrock-knowledgebase-storageconfiguration-mongodbatlasconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "MongoDbAtlasConfiguration" }, "RdsConfiguration": { "MarkdownDocumentation": "`RdsConfiguration`\n\nContains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html).\n*Required*: No\n*Type*: [RdsConfiguration](./aws-properties-bedrock-knowledgebase-rdsconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html#cfn-bedrock-knowledgebase-storageconfiguration-rdsconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "RdsConfiguration" }, "PineconeConfiguration": { "MarkdownDocumentation": "`PineconeConfiguration`\n\nContains the storage configuration of the knowledge base in Pinecone.\n*Required*: No\n*Type*: [PineconeConfiguration](./aws-properties-bedrock-knowledgebase-pineconeconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-storageconfiguration.html#cfn-bedrock-knowledgebase-storageconfiguration-pineconeconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "PineconeConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.SupplementalDataStorageConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.SupplementalDataStorageConfiguration`\n\nSpecifies configurations for the storage location of multimedia content (images, audio, and video) extracted from multimodal documents in your data source. This content can be retrieved and returned to the end user with timestamp references for audio and video segments.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-supplementaldatastorageconfiguration.html", "Properties": { "SupplementalDataStorageLocations": { "MarkdownDocumentation": "`SupplementalDataStorageLocations`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [SupplementalDataStorageLocation](./aws-properties-bedrock-knowledgebase-supplementaldatastoragelocation.html)\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-supplementaldatastorageconfiguration.html#cfn-bedrock-knowledgebase-supplementaldatastorageconfiguration-supplementaldatastoragelocations", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "SupplementalDataStorageLocation", "DuplicatesAllowed": true } } }, "AWS::Bedrock::KnowledgeBase.SupplementalDataStorageLocation": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.SupplementalDataStorageLocation`\n\nContains information about a storage location for multimedia content (images, audio, and video) extracted from multimodal documents in your data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-supplementaldatastoragelocation.html", "Properties": { "SupplementalDataStorageLocationType": { "MarkdownDocumentation": "`SupplementalDataStorageLocationType`\n\nProperty description not available.\n*Required*: Yes\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)\n", "RefReturnValue": "", "AllowedValues": [ "S3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-supplementaldatastoragelocation.html#cfn-bedrock-knowledgebase-supplementaldatastoragelocation-supplementaldatastoragelocationtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3Location": { "MarkdownDocumentation": "`S3Location`\n\nContains information about the Amazon S3 location for the extracted multimedia content.\n*Required*: No\n*Type*: [S3Location](./aws-properties-bedrock-knowledgebase-s3location.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-supplementaldatastoragelocation.html#cfn-bedrock-knowledgebase-supplementaldatastoragelocation-s3location", "UpdateType": "Immutable", "Required": false, "Type": "S3Location" } } }, "AWS::Bedrock::KnowledgeBase.VectorKnowledgeBaseConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.VectorKnowledgeBaseConfiguration`\n\nContains details about the model used to create vector embeddings for the knowledge base.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html", "Properties": { "EmbeddingModelConfiguration": { "MarkdownDocumentation": "`EmbeddingModelConfiguration`\n\nThe embeddings model configuration details for the vector model used in Knowledge Base.\n*Required*: No\n*Type*: [EmbeddingModelConfiguration](./aws-properties-bedrock-knowledgebase-embeddingmodelconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-embeddingmodelconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EmbeddingModelConfiguration" }, "EmbeddingModelArn": { "MarkdownDocumentation": "`EmbeddingModelArn`\n\nThe Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]+)?:[a-z0-9-]+:[a-z0-9-]{1,20}:[0-9]{0,12}:[a-zA-Z0-9-:/._+]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-embeddingmodelarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SupplementalDataStorageConfiguration": { "MarkdownDocumentation": "`SupplementalDataStorageConfiguration`\n\nIf you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using [RetrieveAndGenerate](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html).\n*Required*: No\n*Type*: [SupplementalDataStorageConfiguration](./aws-properties-bedrock-knowledgebase-supplementaldatastorageconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-supplementaldatastorageconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "SupplementalDataStorageConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.VideoConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.VideoConfiguration`\n\nConfiguration settings for processing video content in multimodal knowledge bases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-videoconfiguration.html", "Properties": { "SegmentationConfiguration": { "MarkdownDocumentation": "`SegmentationConfiguration`\n\nConfiguration for segmenting video content during processing.\n*Required*: Yes\n*Type*: [VideoSegmentationConfiguration](./aws-properties-bedrock-knowledgebase-videosegmentationconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-videoconfiguration.html#cfn-bedrock-knowledgebase-videoconfiguration-segmentationconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "VideoSegmentationConfiguration" } } }, "AWS::Bedrock::KnowledgeBase.VideoSegmentationConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase.VideoSegmentationConfiguration`\n\nConfiguration for segmenting video content during multimodal knowledge base ingestion. Determines how video files are divided into chunks for processing.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-videosegmentationconfiguration.html", "Properties": { "FixedLengthDuration": { "MarkdownDocumentation": "`FixedLengthDuration`\n\nThe duration in seconds for each video segment. Video files will be divided into chunks of this length for processing.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-videosegmentationconfiguration.html#cfn-bedrock-knowledgebase-videosegmentationconfiguration-fixedlengthduration", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Bedrock::Prompt.CachePointBlock": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.CachePointBlock`\n\nDefines a section of content to be cached for reuse in subsequent API calls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-cachepointblock.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of cache point within the CachePointBlock.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `default`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "default" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-cachepointblock.html#cfn-bedrock-prompt-cachepointblock-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.ChatPromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.ChatPromptTemplateConfiguration`\n\nContains configurations to use a prompt in a conversational format. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html", "Properties": { "Messages": { "MarkdownDocumentation": "`Messages`\n\nContains messages in the chat for the prompt.\n*Required*: Yes\n*Type*: Array of [Message](./aws-properties-bedrock-prompt-message.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html#cfn-bedrock-prompt-chatprompttemplateconfiguration-messages", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Message", "DuplicatesAllowed": true }, "InputVariables": { "MarkdownDocumentation": "`InputVariables`\n\nAn array of the variables in the prompt template.\n*Required*: No\n*Type*: Array of [PromptInputVariable](./aws-properties-bedrock-prompt-promptinputvariable.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html#cfn-bedrock-prompt-chatprompttemplateconfiguration-inputvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptInputVariable", "DuplicatesAllowed": true }, "ToolConfiguration": { "MarkdownDocumentation": "`ToolConfiguration`\n\nConfiguration information for the tools that the model can use when generating a response.\n*Required*: No\n*Type*: [ToolConfiguration](./aws-properties-bedrock-prompt-toolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html#cfn-bedrock-prompt-chatprompttemplateconfiguration-toolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ToolConfiguration" }, "System": { "MarkdownDocumentation": "`System`\n\nContains system prompts to provide context to the model or to describe how it should behave.\n*Required*: No\n*Type*: Array of [SystemContentBlock](./aws-properties-bedrock-prompt-systemcontentblock.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html#cfn-bedrock-prompt-chatprompttemplateconfiguration-system", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SystemContentBlock", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Prompt.ContentBlock": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.ContentBlock`\n\nA block of content for a message that you pass to, or receive from, a model with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-contentblock.html", "Properties": { "CachePoint": { "MarkdownDocumentation": "`CachePoint`\n\nCachePoint to include in the message.\n*Required*: No\n*Type*: [CachePointBlock](./aws-properties-bedrock-prompt-cachepointblock.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-contentblock.html#cfn-bedrock-prompt-contentblock-cachepoint", "UpdateType": "Mutable", "Required": false, "Type": "CachePointBlock" }, "Text": { "MarkdownDocumentation": "`Text`\n\nText to include in the message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-contentblock.html#cfn-bedrock-prompt-contentblock-text", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.Message": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.Message`\n\nA message input, or returned from, a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-message.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe role that the message plays in the message.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `user | assistant...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "user", "assistant" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-message.html#cfn-bedrock-prompt-message-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe message content. Note the following restrictions:\n* You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.\n* You can include up to five documents. Each document's size must be no more than 4.5 MB.\n* If you include a `ContentBlock` with a `document` field in the array, you must also include a `ContentBlock` with a `text` field.\n* You can only include images and documents if the `role` is `user`.\n*Required*: Yes\n*Type*: Array of [ContentBlock](./aws-properties-bedrock-prompt-contentblock.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-message.html#cfn-bedrock-prompt-message-content", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ContentBlock", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Prompt.PromptAgentResource": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.PromptAgentResource`\n\nContains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and [Automate tasks in your application using conversational agents](https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptagentresource.html", "Properties": { "AgentIdentifier": { "MarkdownDocumentation": "`AgentIdentifier`\n\nThe ARN of the agent with which to use the prompt.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptagentresource.html#cfn-bedrock-prompt-promptagentresource-agentidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.PromptGenAiResource": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.PromptGenAiResource`\n\nContains specifications for a generative AI resource with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptgenairesource.html", "Properties": { "Agent": { "MarkdownDocumentation": "`Agent`\n\nSpecifies an Amazon Bedrock agent with which to use the prompt.\n*Required*: Yes\n*Type*: [PromptAgentResource](./aws-properties-bedrock-prompt-promptagentresource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptgenairesource.html#cfn-bedrock-prompt-promptgenairesource-agent", "UpdateType": "Mutable", "Required": true, "Type": "PromptAgentResource" } } }, "AWS::Bedrock::Prompt.PromptInferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.PromptInferenceConfiguration`\n\nContains inference configurations for the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptinferenceconfiguration.html", "Properties": { "Text": { "MarkdownDocumentation": "`Text`\n\nContains inference configurations for a text prompt.\n*Required*: Yes\n*Type*: [PromptModelInferenceConfiguration](./aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptinferenceconfiguration.html#cfn-bedrock-prompt-promptinferenceconfiguration-text", "UpdateType": "Mutable", "Required": true, "Type": "PromptModelInferenceConfiguration" } } }, "AWS::Bedrock::Prompt.PromptInputVariable": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.PromptInputVariable`\n\nContains information about a variable in the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptinputvariable.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the variable.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptinputvariable.html#cfn-bedrock-prompt-promptinputvariable-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.PromptMetadataEntry": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.PromptMetadataEntry`\n\nContains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmetadataentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a metadata tag for a prompt variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmetadataentry.html#cfn-bedrock-prompt-promptmetadataentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of a metadata tag for a prompt variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmetadataentry.html#cfn-bedrock-prompt-promptmetadataentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.PromptModelInferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.PromptModelInferenceConfiguration`\n\nContains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html", "Properties": { "Temperature": { "MarkdownDocumentation": "`Temperature`\n\nControls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html#cfn-bedrock-prompt-promptmodelinferenceconfiguration-temperature", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StopSequences": { "MarkdownDocumentation": "`StopSequences`\n\nA list of strings that define sequences after which the model will stop generating.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html#cfn-bedrock-prompt-promptmodelinferenceconfiguration-stopsequences", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxTokens": { "MarkdownDocumentation": "`MaxTokens`\n\nThe maximum number of tokens to return in the response.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html#cfn-bedrock-prompt-promptmodelinferenceconfiguration-maxtokens", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "TopP": { "MarkdownDocumentation": "`TopP`\n\nThe percentage of most-likely candidates that the model considers for the next token.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html#cfn-bedrock-prompt-promptmodelinferenceconfiguration-topp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::Prompt.PromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.PromptTemplateConfiguration`\n\nContains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-prompttemplateconfiguration.html", "Properties": { "Chat": { "MarkdownDocumentation": "`Chat`\n\nContains configurations to use the prompt in a conversational format.\n*Required*: No\n*Type*: [ChatPromptTemplateConfiguration](./aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-prompttemplateconfiguration.html#cfn-bedrock-prompt-prompttemplateconfiguration-chat", "UpdateType": "Mutable", "Required": false, "Type": "ChatPromptTemplateConfiguration" }, "Text": { "MarkdownDocumentation": "`Text`\n\nContains configurations for the text in a message for a prompt.\n*Required*: No\n*Type*: [TextPromptTemplateConfiguration](./aws-properties-bedrock-prompt-textprompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-prompttemplateconfiguration.html#cfn-bedrock-prompt-prompttemplateconfiguration-text", "UpdateType": "Mutable", "Required": false, "Type": "TextPromptTemplateConfiguration" } } }, "AWS::Bedrock::Prompt.PromptVariant": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.PromptVariant`\n\nContains details about a variant of the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html", "Properties": { "AdditionalModelRequestFields": { "MarkdownDocumentation": "`AdditionalModelRequestFields`\n\nContains model-specific inference configurations that aren't in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-additionalmodelrequestfields", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "InferenceConfiguration": { "MarkdownDocumentation": "`InferenceConfiguration`\n\nContains inference configurations for the prompt variant.\n*Required*: No\n*Type*: [PromptInferenceConfiguration](./aws-properties-bedrock-prompt-promptinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-inferenceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PromptInferenceConfiguration" }, "Metadata": { "MarkdownDocumentation": "`Metadata`\n\nAn array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.\n*Required*: No\n*Type*: Array of [PromptMetadataEntry](./aws-properties-bedrock-prompt-promptmetadataentry.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-metadata", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptMetadataEntry", "DuplicatesAllowed": true }, "GenAiResource": { "MarkdownDocumentation": "`GenAiResource`\n\nSpecifies a generative AI resource with which to use the prompt.\n*Required*: No\n*Type*: [PromptGenAiResource](./aws-properties-bedrock-prompt-promptgenairesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-genairesource", "UpdateType": "Mutable", "Required": false, "Type": "PromptGenAiResource" }, "TemplateConfiguration": { "MarkdownDocumentation": "`TemplateConfiguration`\n\nContains configurations for the prompt template.\n*Required*: Yes\n*Type*: [PromptTemplateConfiguration](./aws-properties-bedrock-prompt-prompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-templateconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PromptTemplateConfiguration" }, "TemplateType": { "MarkdownDocumentation": "`TemplateType`\n\nThe type of prompt template to use.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEXT | CHAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TEXT", "CHAT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-templatetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) with which to run inference on the prompt.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-modelid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the prompt variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.SpecificToolChoice": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.SpecificToolChoice`\n\nThe model must request a specific tool. For example, `{\"tool\" : {\"name\" : \"Your\ntool name\"}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html)\nin the Amazon Bedrock User Guide\n###### Note\nThis field is only supported by Anthropic Claude 3 models.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-specifictoolchoice.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the tool that the model must request.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-specifictoolchoice.html#cfn-bedrock-prompt-specifictoolchoice-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.SystemContentBlock": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.SystemContentBlock`\n\nContains configurations for instructions to provide the model for how to handle input.\nTo learn more, see [Using the Converse\nAPI](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-systemcontentblock.html", "Properties": { "CachePoint": { "MarkdownDocumentation": "`CachePoint`\n\nCachePoint to include in the system prompt.\n*Required*: No\n*Type*: [CachePointBlock](./aws-properties-bedrock-prompt-cachepointblock.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-systemcontentblock.html#cfn-bedrock-prompt-systemcontentblock-cachepoint", "UpdateType": "Mutable", "Required": false, "Type": "CachePointBlock" }, "Text": { "MarkdownDocumentation": "`Text`\n\nA system prompt for the model.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-systemcontentblock.html#cfn-bedrock-prompt-systemcontentblock-text", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.TextPromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.TextPromptTemplateConfiguration`\n\nContains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html", "Properties": { "InputVariables": { "MarkdownDocumentation": "`InputVariables`\n\nAn array of the variables in the prompt template.\n*Required*: No\n*Type*: Array of [PromptInputVariable](./aws-properties-bedrock-prompt-promptinputvariable.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-inputvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptInputVariable", "DuplicatesAllowed": true }, "TextS3Location": { "MarkdownDocumentation": "`TextS3Location`\n\nThe Amazon S3location of the prompt text.\n*Required*: No\n*Type*: [TextS3Location](./aws-properties-bedrock-prompt-texts3location.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-texts3location", "UpdateType": "Mutable", "Required": false, "Type": "TextS3Location" }, "CachePoint": { "MarkdownDocumentation": "`CachePoint`\n\nA cache checkpoint within a template configuration.\n*Required*: No\n*Type*: [CachePointBlock](./aws-properties-bedrock-prompt-cachepointblock.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-cachepoint", "UpdateType": "Mutable", "Required": false, "Type": "CachePointBlock" }, "Text": { "MarkdownDocumentation": "`Text`\n\nThe message for the prompt.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `200000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-text", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.TextS3Location": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.TextS3Location`\n\nThe Amazon S3location of the prompt text.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-texts3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe Amazon S3bucket containing the prompt text.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-texts3location.html#cfn-bedrock-prompt-texts3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of the Amazon S3location to use.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-texts3location.html#cfn-bedrock-prompt-texts3location-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe object key for the Amazon S3 location.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-texts3location.html#cfn-bedrock-prompt-texts3location-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::Prompt.Tool": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.Tool`\n\nInformation about a tool that you can use with the Converse API. For more information,\nsee [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-tool.html", "Properties": { "CachePoint": { "MarkdownDocumentation": "`CachePoint`\n\nCachePoint to include in the tool configuration.\n*Required*: No\n*Type*: [CachePointBlock](./aws-properties-bedrock-prompt-cachepointblock.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-tool.html#cfn-bedrock-prompt-tool-cachepoint", "UpdateType": "Mutable", "Required": false, "Type": "CachePointBlock" }, "ToolSpec": { "MarkdownDocumentation": "`ToolSpec`\n\nThe specfication for the tool.\n*Required*: No\n*Type*: [ToolSpecification](./aws-properties-bedrock-prompt-toolspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-tool.html#cfn-bedrock-prompt-tool-toolspec", "UpdateType": "Mutable", "Required": false, "Type": "ToolSpecification" } } }, "AWS::Bedrock::Prompt.ToolChoice": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.ToolChoice`\n\nDetermines which tools the model should request in a call to `Converse` or\n`ConverseStream`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html", "Properties": { "Auto": { "MarkdownDocumentation": "`Auto`\n\n(Default). The Model automatically decides if a tool should be called or whether to generate text instead.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-auto", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Any": { "MarkdownDocumentation": "`Any`\n\nThe model must request at least one tool (no text is generated).\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-any", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Tool": { "MarkdownDocumentation": "`Tool`\n\nThe Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.\n*Required*: No\n*Type*: [SpecificToolChoice](./aws-properties-bedrock-prompt-specifictoolchoice.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-tool", "UpdateType": "Mutable", "Required": false, "Type": "SpecificToolChoice" } } }, "AWS::Bedrock::Prompt.ToolConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.ToolConfiguration`\n\nConfiguration information for the tools that you pass to a model. For more information,\nsee [Tool use\n(function calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolconfiguration.html", "Properties": { "ToolChoice": { "MarkdownDocumentation": "`ToolChoice`\n\nIf supported by model, forces the model to request a tool.\n*Required*: No\n*Type*: [ToolChoice](./aws-properties-bedrock-prompt-toolchoice.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolconfiguration.html#cfn-bedrock-prompt-toolconfiguration-toolchoice", "UpdateType": "Mutable", "Required": false, "Type": "ToolChoice" }, "Tools": { "MarkdownDocumentation": "`Tools`\n\nAn array of tools that you want to pass to a model.\n*Required*: Yes\n*Type*: Array of [Tool](./aws-properties-bedrock-prompt-tool.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolconfiguration.html#cfn-bedrock-prompt-toolconfiguration-tools", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Tool", "DuplicatesAllowed": true } } }, "AWS::Bedrock::Prompt.ToolInputSchema": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.ToolInputSchema`\n\nThe schema for the tool. The top level schema type must be `object`. For more\ninformation, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolinputschema.html", "Properties": { "Json": { "MarkdownDocumentation": "`Json`\n\nThe JSON schema for the tool. For more information, see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolinputschema.html#cfn-bedrock-prompt-toolinputschema-json", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::Bedrock::Prompt.ToolSpecification": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt.ToolSpecification`\n\nThe specification for the tool. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html)\nin the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the tool.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputSchema": { "MarkdownDocumentation": "`InputSchema`\n\nThe input schema for the tool in JSON format.\n*Required*: Yes\n*Type*: [ToolInputSchema](./aws-properties-bedrock-prompt-toolinputschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-inputschema", "UpdateType": "Mutable", "Required": true, "Type": "ToolInputSchema" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the tool.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.CachePointBlock": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.CachePointBlock`\n\nDefines a section of content to be cached for reuse in subsequent API calls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-cachepointblock.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of cache point within the CachePointBlock.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `default`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "default" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-cachepointblock.html#cfn-bedrock-promptversion-cachepointblock-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.ChatPromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.ChatPromptTemplateConfiguration`\n\nContains configurations to use a prompt in a conversational format. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html", "Properties": { "Messages": { "MarkdownDocumentation": "`Messages`\n\nContains messages in the chat for the prompt.\n*Required*: Yes\n*Type*: Array of [Message](./aws-properties-bedrock-promptversion-message.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-messages", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Message", "DuplicatesAllowed": true }, "InputVariables": { "MarkdownDocumentation": "`InputVariables`\n\nAn array of the variables in the prompt template.\n*Required*: No\n*Type*: Array of [PromptInputVariable](./aws-properties-bedrock-promptversion-promptinputvariable.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-inputvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptInputVariable", "DuplicatesAllowed": true }, "ToolConfiguration": { "MarkdownDocumentation": "`ToolConfiguration`\n\nConfiguration information for the tools that the model can use when generating a response.\n*Required*: No\n*Type*: [ToolConfiguration](./aws-properties-bedrock-promptversion-toolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-toolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ToolConfiguration" }, "System": { "MarkdownDocumentation": "`System`\n\nContains system prompts to provide context to the model or to describe how it should behave.\n*Required*: No\n*Type*: Array of [SystemContentBlock](./aws-properties-bedrock-promptversion-systemcontentblock.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-system", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SystemContentBlock", "DuplicatesAllowed": true } } }, "AWS::Bedrock::PromptVersion.ContentBlock": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.ContentBlock`\n\nA block of content for a message that you pass to, or receive from, a model with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-contentblock.html", "Properties": { "CachePoint": { "MarkdownDocumentation": "`CachePoint`\n\nCachePoint to include in the message.\n*Required*: No\n*Type*: [CachePointBlock](./aws-properties-bedrock-promptversion-cachepointblock.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-contentblock.html#cfn-bedrock-promptversion-contentblock-cachepoint", "UpdateType": "Mutable", "Required": false, "Type": "CachePointBlock" }, "Text": { "MarkdownDocumentation": "`Text`\n\nText to include in the message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-contentblock.html#cfn-bedrock-promptversion-contentblock-text", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.Message": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.Message`\n\nA message input, or returned from, a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-message.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe role that the message plays in the message.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `user | assistant...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "user", "assistant" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-message.html#cfn-bedrock-promptversion-message-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe message content. Note the following restrictions:\n* You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.\n* You can include up to five documents. Each document's size must be no more than 4.5 MB.\n* If you include a `ContentBlock` with a `document` field in the array, you must also include a `ContentBlock` with a `text` field.\n* You can only include images and documents if the `role` is `user`.\n*Required*: Yes\n*Type*: Array of [ContentBlock](./aws-properties-bedrock-promptversion-contentblock.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-message.html#cfn-bedrock-promptversion-message-content", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ContentBlock", "DuplicatesAllowed": true } } }, "AWS::Bedrock::PromptVersion.PromptAgentResource": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.PromptAgentResource`\n\nContains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and [Automate tasks in your application using conversational agents](https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptagentresource.html", "Properties": { "AgentIdentifier": { "MarkdownDocumentation": "`AgentIdentifier`\n\nThe ARN of the agent with which to use the prompt.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptagentresource.html#cfn-bedrock-promptversion-promptagentresource-agentidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.PromptGenAiResource": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.PromptGenAiResource`\n\nContains specifications for a generative AI resource with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptgenairesource.html", "Properties": { "Agent": { "MarkdownDocumentation": "`Agent`\n\nSpecifies an Amazon Bedrock agent with which to use the prompt.\n*Required*: Yes\n*Type*: [PromptAgentResource](./aws-properties-bedrock-promptversion-promptagentresource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptgenairesource.html#cfn-bedrock-promptversion-promptgenairesource-agent", "UpdateType": "Mutable", "Required": true, "Type": "PromptAgentResource" } } }, "AWS::Bedrock::PromptVersion.PromptInferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.PromptInferenceConfiguration`\n\nContains inference configurations for the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptinferenceconfiguration.html", "Properties": { "Text": { "MarkdownDocumentation": "`Text`\n\nContains inference configurations for a text prompt.\n*Required*: Yes\n*Type*: [PromptModelInferenceConfiguration](./aws-properties-bedrock-promptversion-promptmodelinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptinferenceconfiguration.html#cfn-bedrock-promptversion-promptinferenceconfiguration-text", "UpdateType": "Mutable", "Required": true, "Type": "PromptModelInferenceConfiguration" } } }, "AWS::Bedrock::PromptVersion.PromptInputVariable": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.PromptInputVariable`\n\nContains information about a variable in the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptinputvariable.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the variable.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptinputvariable.html#cfn-bedrock-promptversion-promptinputvariable-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.PromptMetadataEntry": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.PromptMetadataEntry`\n\nContains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptmetadataentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a metadata tag for a prompt variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptmetadataentry.html#cfn-bedrock-promptversion-promptmetadataentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of a metadata tag for a prompt variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptmetadataentry.html#cfn-bedrock-promptversion-promptmetadataentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.PromptModelInferenceConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.PromptModelInferenceConfiguration`\n\nContains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptmodelinferenceconfiguration.html", "Properties": { "Temperature": { "MarkdownDocumentation": "`Temperature`\n\nControls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptmodelinferenceconfiguration.html#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-temperature", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StopSequences": { "MarkdownDocumentation": "`StopSequences`\n\nA list of strings that define sequences after which the model will stop generating.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptmodelinferenceconfiguration.html#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-stopsequences", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxTokens": { "MarkdownDocumentation": "`MaxTokens`\n\nThe maximum number of tokens to return in the response.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptmodelinferenceconfiguration.html#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-maxtokens", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "TopP": { "MarkdownDocumentation": "`TopP`\n\nThe percentage of most-likely candidates that the model considers for the next token.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptmodelinferenceconfiguration.html#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-topp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Bedrock::PromptVersion.PromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.PromptTemplateConfiguration`\n\nContains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-prompttemplateconfiguration.html", "Properties": { "Chat": { "MarkdownDocumentation": "`Chat`\n\nContains configurations to use the prompt in a conversational format.\n*Required*: No\n*Type*: [ChatPromptTemplateConfiguration](./aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-prompttemplateconfiguration.html#cfn-bedrock-promptversion-prompttemplateconfiguration-chat", "UpdateType": "Mutable", "Required": false, "Type": "ChatPromptTemplateConfiguration" }, "Text": { "MarkdownDocumentation": "`Text`\n\nContains configurations for the text in a message for a prompt.\n*Required*: No\n*Type*: [TextPromptTemplateConfiguration](./aws-properties-bedrock-promptversion-textprompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-prompttemplateconfiguration.html#cfn-bedrock-promptversion-prompttemplateconfiguration-text", "UpdateType": "Mutable", "Required": false, "Type": "TextPromptTemplateConfiguration" } } }, "AWS::Bedrock::PromptVersion.PromptVariant": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.PromptVariant`\n\nContains details about a variant of the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html", "Properties": { "AdditionalModelRequestFields": { "MarkdownDocumentation": "`AdditionalModelRequestFields`\n\nContains model-specific inference configurations that aren't in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-additionalmodelrequestfields", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "InferenceConfiguration": { "MarkdownDocumentation": "`InferenceConfiguration`\n\nContains inference configurations for the prompt variant.\n*Required*: No\n*Type*: [PromptInferenceConfiguration](./aws-properties-bedrock-promptversion-promptinferenceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-inferenceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PromptInferenceConfiguration" }, "Metadata": { "MarkdownDocumentation": "`Metadata`\n\nAn array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.\n*Required*: No\n*Type*: Array of [PromptMetadataEntry](./aws-properties-bedrock-promptversion-promptmetadataentry.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-metadata", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptMetadataEntry", "DuplicatesAllowed": true }, "GenAiResource": { "MarkdownDocumentation": "`GenAiResource`\n\nSpecifies a generative AI resource with which to use the prompt.\n*Required*: No\n*Type*: [PromptGenAiResource](./aws-properties-bedrock-promptversion-promptgenairesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-genairesource", "UpdateType": "Mutable", "Required": false, "Type": "PromptGenAiResource" }, "TemplateConfiguration": { "MarkdownDocumentation": "`TemplateConfiguration`\n\nContains configurations for the prompt template.\n*Required*: Yes\n*Type*: [PromptTemplateConfiguration](./aws-properties-bedrock-promptversion-prompttemplateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-templateconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PromptTemplateConfiguration" }, "TemplateType": { "MarkdownDocumentation": "`TemplateType`\n\nThe type of prompt template to use.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEXT | CHAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TEXT", "CHAT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-templatetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) with which to run inference on the prompt.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-modelid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the prompt variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.SpecificToolChoice": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.SpecificToolChoice`\n\nThe model must request a specific tool. For example, `{\"tool\" : {\"name\" : \"Your\ntool name\"}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html)\nin the Amazon Bedrock User Guide\n###### Note\nThis field is only supported by Anthropic Claude 3 models.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-specifictoolchoice.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the tool that the model must request.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-specifictoolchoice.html#cfn-bedrock-promptversion-specifictoolchoice-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.SystemContentBlock": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.SystemContentBlock`\n\nContains configurations for instructions to provide the model for how to handle input.\nTo learn more, see [Using the Converse\nAPI](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-systemcontentblock.html", "Properties": { "CachePoint": { "MarkdownDocumentation": "`CachePoint`\n\nCachePoint to include in the system prompt.\n*Required*: No\n*Type*: [CachePointBlock](./aws-properties-bedrock-promptversion-cachepointblock.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-systemcontentblock.html#cfn-bedrock-promptversion-systemcontentblock-cachepoint", "UpdateType": "Mutable", "Required": false, "Type": "CachePointBlock" }, "Text": { "MarkdownDocumentation": "`Text`\n\nA system prompt for the model.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-systemcontentblock.html#cfn-bedrock-promptversion-systemcontentblock-text", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.TextPromptTemplateConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.TextPromptTemplateConfiguration`\n\nContains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-textprompttemplateconfiguration.html", "Properties": { "InputVariables": { "MarkdownDocumentation": "`InputVariables`\n\nAn array of the variables in the prompt template.\n*Required*: No\n*Type*: Array of [PromptInputVariable](./aws-properties-bedrock-promptversion-promptinputvariable.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-textprompttemplateconfiguration.html#cfn-bedrock-promptversion-textprompttemplateconfiguration-inputvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptInputVariable", "DuplicatesAllowed": true }, "CachePoint": { "MarkdownDocumentation": "`CachePoint`\n\nA cache checkpoint within a template configuration.\n*Required*: No\n*Type*: [CachePointBlock](./aws-properties-bedrock-promptversion-cachepointblock.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-textprompttemplateconfiguration.html#cfn-bedrock-promptversion-textprompttemplateconfiguration-cachepoint", "UpdateType": "Mutable", "Required": false, "Type": "CachePointBlock" }, "Text": { "MarkdownDocumentation": "`Text`\n\nThe message for the prompt.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `200000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-textprompttemplateconfiguration.html#cfn-bedrock-promptversion-textprompttemplateconfiguration-text", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Bedrock::PromptVersion.Tool": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.Tool`\n\nInformation about a tool that you can use with the Converse API. For more information,\nsee [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-tool.html", "Properties": { "CachePoint": { "MarkdownDocumentation": "`CachePoint`\n\nCachePoint to include in the tool configuration.\n*Required*: No\n*Type*: [CachePointBlock](./aws-properties-bedrock-promptversion-cachepointblock.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-tool.html#cfn-bedrock-promptversion-tool-cachepoint", "UpdateType": "Mutable", "Required": false, "Type": "CachePointBlock" }, "ToolSpec": { "MarkdownDocumentation": "`ToolSpec`\n\nThe specfication for the tool.\n*Required*: No\n*Type*: [ToolSpecification](./aws-properties-bedrock-promptversion-toolspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-tool.html#cfn-bedrock-promptversion-tool-toolspec", "UpdateType": "Mutable", "Required": false, "Type": "ToolSpecification" } } }, "AWS::Bedrock::PromptVersion.ToolChoice": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.ToolChoice`\n\nDetermines which tools the model should request in a call to `Converse` or\n`ConverseStream`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html", "Properties": { "Auto": { "MarkdownDocumentation": "`Auto`\n\n(Default). The Model automatically decides if a tool should be called or whether to generate text instead.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-auto", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Any": { "MarkdownDocumentation": "`Any`\n\nThe model must request at least one tool (no text is generated).\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-any", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Tool": { "MarkdownDocumentation": "`Tool`\n\nThe Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.\n*Required*: No\n*Type*: [SpecificToolChoice](./aws-properties-bedrock-promptversion-specifictoolchoice.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-tool", "UpdateType": "Mutable", "Required": false, "Type": "SpecificToolChoice" } } }, "AWS::Bedrock::PromptVersion.ToolConfiguration": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.ToolConfiguration`\n\nConfiguration information for the tools that you pass to a model. For more information,\nsee [Tool use\n(function calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolconfiguration.html", "Properties": { "ToolChoice": { "MarkdownDocumentation": "`ToolChoice`\n\nIf supported by model, forces the model to request a tool.\n*Required*: No\n*Type*: [ToolChoice](./aws-properties-bedrock-promptversion-toolchoice.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolconfiguration.html#cfn-bedrock-promptversion-toolconfiguration-toolchoice", "UpdateType": "Mutable", "Required": false, "Type": "ToolChoice" }, "Tools": { "MarkdownDocumentation": "`Tools`\n\nAn array of tools that you want to pass to a model.\n*Required*: Yes\n*Type*: Array of [Tool](./aws-properties-bedrock-promptversion-tool.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolconfiguration.html#cfn-bedrock-promptversion-toolconfiguration-tools", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Tool", "DuplicatesAllowed": true } } }, "AWS::Bedrock::PromptVersion.ToolInputSchema": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.ToolInputSchema`\n\nThe schema for the tool. The top level schema type must be `object`. For more\ninformation, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolinputschema.html", "Properties": { "Json": { "MarkdownDocumentation": "`Json`\n\nThe JSON schema for the tool. For more information, see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolinputschema.html#cfn-bedrock-promptversion-toolinputschema-json", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::Bedrock::PromptVersion.ToolSpecification": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion.ToolSpecification`\n\nThe specification for the tool. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html)\nin the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolspecification.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the tool.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolspecification.html#cfn-bedrock-promptversion-toolspecification-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputSchema": { "MarkdownDocumentation": "`InputSchema`\n\nThe input schema for the tool in JSON format.\n*Required*: Yes\n*Type*: [ToolInputSchema](./aws-properties-bedrock-promptversion-toolinputschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolspecification.html#cfn-bedrock-promptversion-toolspecification-inputschema", "UpdateType": "Mutable", "Required": true, "Type": "ToolInputSchema" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the tool.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolspecification.html#cfn-bedrock-promptversion-toolspecification-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::BrowserCustom.BrowserNetworkConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::BrowserCustom.BrowserNetworkConfiguration`\n\nThe network configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html", "Properties": { "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-bedrockagentcore-browsercustom-vpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-vpcconfig", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfig" }, "NetworkMode": { "MarkdownDocumentation": "`NetworkMode`\n\nThe network mode.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PUBLIC | VPC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PUBLIC", "VPC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-networkmode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::BrowserCustom.BrowserSigning": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::BrowserCustom.BrowserSigning`\n\nThe `BrowserSigning` property type specifies Property description not available. for an [AWS::BedrockAgentCore::BrowserCustom](./aws-resource-bedrockagentcore-browsercustom.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsersigning.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsersigning.html#cfn-bedrockagentcore-browsercustom-browsersigning-enabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::BedrockAgentCore::BrowserCustom.RecordingConfig": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::BrowserCustom.RecordingConfig`\n\nThe recording configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-recordingconfig.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nThe recording configuration for a browser. This structure defines how browser sessions\nare recorded.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-recordingconfig.html#cfn-bedrockagentcore-browsercustom-recordingconfig-enabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "S3Location": { "MarkdownDocumentation": "`S3Location`\n\nThe S3 location.\n*Required*: No\n*Type*: [S3Location](./aws-properties-bedrockagentcore-browsercustom-s3location.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-recordingconfig.html#cfn-bedrockagentcore-browsercustom-recordingconfig-s3location", "UpdateType": "Immutable", "Required": false, "Type": "S3Location" } } }, "AWS::BedrockAgentCore::BrowserCustom.S3Location": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::BrowserCustom.S3Location`\n\nThe S3 location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe S3 location bucket name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-s3location.html#cfn-bedrockagentcore-browsercustom-s3location-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe S3 location object prefix.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-s3location.html#cfn-bedrockagentcore-browsercustom-s3location-prefix", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::BrowserCustom.VpcConfig": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::BrowserCustom.VpcConfig`\n\nThe `VpcConfig` property type specifies Property description not available. for an [AWS::BedrockAgentCore::BrowserCustom](./aws-resource-bedrockagentcore-browsercustom.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-vpcconfig.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-vpcconfig.html#cfn-bedrockagentcore-browsercustom-vpcconfig-securitygroups", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-vpcconfig.html#cfn-bedrockagentcore-browsercustom-vpcconfig-subnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::BedrockAgentCore::CodeInterpreterCustom.CodeInterpreterNetworkConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::CodeInterpreterCustom.CodeInterpreterNetworkConfiguration`\n\nThe network configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html", "Properties": { "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-vpcconfig", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfig" }, "NetworkMode": { "MarkdownDocumentation": "`NetworkMode`\n\nThe network mode.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PUBLIC | SANDBOX | VPC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PUBLIC", "SANDBOX", "VPC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-networkmode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::CodeInterpreterCustom.VpcConfig": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::CodeInterpreterCustom.VpcConfig`\n\nThe `VpcConfig` property type specifies Property description not available. for an [AWS::BedrockAgentCore::CodeInterpreterCustom](./aws-resource-bedrockagentcore-codeinterpretercustom.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-securitygroups", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-subnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::BedrockAgentCore::Gateway.AuthorizerConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.AuthorizerConfiguration`\n\nThe `AuthorizerConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Gateway](./aws-resource-bedrockagentcore-gateway.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizerconfiguration.html", "Properties": { "CustomJWTAuthorizer": { "MarkdownDocumentation": "`CustomJWTAuthorizer`\n\nThe authorizer configuration for the gateway.\n*Required*: Yes\n*Type*: [CustomJWTAuthorizerConfiguration](./aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizerconfiguration.html#cfn-bedrockagentcore-gateway-authorizerconfiguration-customjwtauthorizer", "UpdateType": "Mutable", "Required": true, "Type": "CustomJWTAuthorizerConfiguration" } } }, "AWS::BedrockAgentCore::Gateway.CustomJWTAuthorizerConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.CustomJWTAuthorizerConfiguration`\n\nThe `CustomJWTAuthorizerConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Gateway](./aws-resource-bedrockagentcore-gateway.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html", "Properties": { "DiscoveryUrl": { "MarkdownDocumentation": "`DiscoveryUrl`\n\nThe discovery URL for the authorizer configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.+/\\.well-known/openid-configuration$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-discoveryurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AllowedAudience": { "MarkdownDocumentation": "`AllowedAudience`\n\nThe allowed audience authorized for the gateway target.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedaudience", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedClients": { "MarkdownDocumentation": "`AllowedClients`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedclients", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::BedrockAgentCore::Gateway.GatewayInterceptorConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.GatewayInterceptorConfiguration`\n\nThe `GatewayInterceptorConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Gateway](./aws-resource-bedrockagentcore-gateway.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html", "Properties": { "InterceptionPoints": { "MarkdownDocumentation": "`InterceptionPoints`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptionpoints", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Interceptor": { "MarkdownDocumentation": "`Interceptor`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [InterceptorConfiguration](./aws-properties-bedrockagentcore-gateway-interceptorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptor", "UpdateType": "Mutable", "Required": true, "Type": "InterceptorConfiguration" }, "InputConfiguration": { "MarkdownDocumentation": "`InputConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [InterceptorInputConfiguration](./aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-inputconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InterceptorInputConfiguration" } } }, "AWS::BedrockAgentCore::Gateway.GatewayProtocolConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.GatewayProtocolConfiguration`\n\nThe protocol configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.html", "Properties": { "Mcp": { "MarkdownDocumentation": "`Mcp`\n\nThe gateway protocol configuration for MCP.\n*Required*: Yes\n*Type*: [MCPGatewayConfiguration](./aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.html#cfn-bedrockagentcore-gateway-gatewayprotocolconfiguration-mcp", "UpdateType": "Mutable", "Required": true, "Type": "MCPGatewayConfiguration" } } }, "AWS::BedrockAgentCore::Gateway.InterceptorConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.InterceptorConfiguration`\n\nThe `InterceptorConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Gateway](./aws-resource-bedrockagentcore-gateway.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorconfiguration.html", "Properties": { "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [LambdaInterceptorConfiguration](./aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorconfiguration.html#cfn-bedrockagentcore-gateway-interceptorconfiguration-lambda", "UpdateType": "Mutable", "Required": true, "Type": "LambdaInterceptorConfiguration" } } }, "AWS::BedrockAgentCore::Gateway.InterceptorInputConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.InterceptorInputConfiguration`\n\nThe `InterceptorInputConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Gateway](./aws-resource-bedrockagentcore-gateway.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration.html", "Properties": { "PassRequestHeaders": { "MarkdownDocumentation": "`PassRequestHeaders`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration.html#cfn-bedrockagentcore-gateway-interceptorinputconfiguration-passrequestheaders", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::BedrockAgentCore::Gateway.LambdaInterceptorConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.LambdaInterceptorConfiguration`\n\nThe `LambdaInterceptorConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Gateway](./aws-resource-bedrockagentcore-gateway.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\\d{1}):(\\d{12}):function:([a-zA-Z0-9-_.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\n*Minimum*: `1`\n*Maximum*: `170`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration.html#cfn-bedrockagentcore-gateway-lambdainterceptorconfiguration-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Gateway.MCPGatewayConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.MCPGatewayConfiguration`\n\nThe gateway configuration for MCP.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html", "Properties": { "SupportedVersions": { "MarkdownDocumentation": "`SupportedVersions`\n\nThe supported versions for the MCP configuration for the gateway target.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-supportedversions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Instructions": { "MarkdownDocumentation": "`Instructions`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-instructions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SearchType": { "MarkdownDocumentation": "`SearchType`\n\nThe MCP gateway configuration search type.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEMANTIC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "SEMANTIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-searchtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Gateway.WorkloadIdentityDetails": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway.WorkloadIdentityDetails`\n\nThe workload identity details for the gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-workloadidentitydetails.html", "Properties": { "WorkloadIdentityArn": { "MarkdownDocumentation": "`WorkloadIdentityArn`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-workloadidentitydetails.html#cfn-bedrockagentcore-gateway-workloadidentitydetails-workloadidentityarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::GatewayTarget.ApiKeyCredentialProvider": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.ApiKeyCredentialProvider`\n\nThe API key credential provider for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html", "Properties": { "ProviderArn": { "MarkdownDocumentation": "`ProviderArn`\n\nThe provider ARN for the gateway target.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:([^:]*):([^:]*):([^:]*):([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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CredentialLocation": { "MarkdownDocumentation": "`CredentialLocation`\n\nThe credential location for the gateway target.\n*Required*: No\n*Type*: String\n*Allowed values*: `HEADER | QUERY_PARAMETER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HEADER", "QUERY_PARAMETER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CredentialPrefix": { "MarkdownDocumentation": "`CredentialPrefix`\n\nThe API key credential provider for the gateway target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CredentialParameterName": { "MarkdownDocumentation": "`CredentialParameterName`\n\nThe credential parameter name for the provider for the gateway target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::GatewayTarget.ApiSchemaConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.ApiSchemaConfiguration`\n\nThe API schema configuration for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nThe API schema configuration.\n*Required*: No\n*Type*: [S3Configuration](./aws-properties-bedrockagentcore-gatewaytarget-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3Configuration" }, "InlinePayload": { "MarkdownDocumentation": "`InlinePayload`\n\nThe inline payload for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-inlinepayload", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::GatewayTarget.CredentialProvider": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.CredentialProvider`\n\nThe `CredentialProvider` property type specifies Property description not available. for an [AWS::BedrockAgentCore::GatewayTarget](./aws-resource-bedrockagentcore-gatewaytarget.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html", "Properties": { "OauthCredentialProvider": { "MarkdownDocumentation": "`OauthCredentialProvider`\n\nThe OAuth credential provider for the gateway target.\n*Required*: No\n*Type*: [OAuthCredentialProvider](./aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-oauthcredentialprovider", "UpdateType": "Mutable", "Required": false, "Type": "OAuthCredentialProvider" }, "ApiKeyCredentialProvider": { "MarkdownDocumentation": "`ApiKeyCredentialProvider`\n\nThe API key credential provider.\n*Required*: No\n*Type*: [ApiKeyCredentialProvider](./aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-apikeycredentialprovider", "UpdateType": "Mutable", "Required": false, "Type": "ApiKeyCredentialProvider" } } }, "AWS::BedrockAgentCore::GatewayTarget.CredentialProviderConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.CredentialProviderConfiguration`\n\nThe credential provider configuration for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html", "Properties": { "CredentialProvider": { "MarkdownDocumentation": "`CredentialProvider`\n\nThe credential provider for the gateway target.\n*Required*: No\n*Type*: [CredentialProvider](./aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider", "UpdateType": "Mutable", "Required": false, "Type": "CredentialProvider" }, "CredentialProviderType": { "MarkdownDocumentation": "`CredentialProviderType`\n\nThe credential provider type for the gateway target.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GATEWAY_IAM_ROLE | OAUTH | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GATEWAY_IAM_ROLE", "OAUTH", "API_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::GatewayTarget.McpLambdaTargetConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.McpLambdaTargetConfiguration`\n\nThe Lambda target configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html", "Properties": { "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe ARN of the Lambda target configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\\d{1}):(\\d{12}):function:([a-zA-Z0-9-_.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\n*Minimum*: `1`\n*Maximum*: `170`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-lambdaarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ToolSchema": { "MarkdownDocumentation": "`ToolSchema`\n\nThe tool schema configuration for the gateway target MCP configuration for Lambda.\n*Required*: Yes\n*Type*: [ToolSchema](./aws-properties-bedrockagentcore-gatewaytarget-toolschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-toolschema", "UpdateType": "Mutable", "Required": true, "Type": "ToolSchema" } } }, "AWS::BedrockAgentCore::GatewayTarget.McpServerTargetConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.McpServerTargetConfiguration`\n\nThe `McpServerTargetConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::GatewayTarget](./aws-resource-bedrockagentcore-gatewaytarget.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html", "Properties": { "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-endpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::GatewayTarget.McpTargetConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.McpTargetConfiguration`\n\nThe MCP target configuration for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html", "Properties": { "McpServer": { "MarkdownDocumentation": "`McpServer`\n\nProperty description not available.\n*Required*: No\n*Type*: [McpServerTargetConfiguration](./aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-mcpserver", "UpdateType": "Mutable", "Required": false, "Type": "McpServerTargetConfiguration" }, "OpenApiSchema": { "MarkdownDocumentation": "`OpenApiSchema`\n\nThe OpenApi schema for the gateway target MCP configuration.\n*Required*: No\n*Type*: [ApiSchemaConfiguration](./aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-openapischema", "UpdateType": "Mutable", "Required": false, "Type": "ApiSchemaConfiguration" }, "SmithyModel": { "MarkdownDocumentation": "`SmithyModel`\n\nThe target configuration for the Smithy model target.\n*Required*: No\n*Type*: [ApiSchemaConfiguration](./aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-smithymodel", "UpdateType": "Mutable", "Required": false, "Type": "ApiSchemaConfiguration" }, "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nThe Lambda MCP configuration for the gateway target.\n*Required*: No\n*Type*: [McpLambdaTargetConfiguration](./aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-lambda", "UpdateType": "Mutable", "Required": false, "Type": "McpLambdaTargetConfiguration" } } }, "AWS::BedrockAgentCore::GatewayTarget.OAuthCredentialProvider": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.OAuthCredentialProvider`\n\nThe OAuth credential provider for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html", "Properties": { "DefaultReturnUrl": { "MarkdownDocumentation": "`DefaultReturnUrl`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `\\w+:(\\/?\\/?)[^\\s]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-defaultreturnurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProviderArn": { "MarkdownDocumentation": "`ProviderArn`\n\nThe provider ARN for the gateway target.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:([^:]*):([^:]*):([^:]*):([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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Scopes": { "MarkdownDocumentation": "`Scopes`\n\nThe OAuth credential provider scopes.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `64 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "GrantType": { "MarkdownDocumentation": "`GrantType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTHORIZATION_CODE | CLIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-granttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomParameters": { "MarkdownDocumentation": "`CustomParameters`\n\nThe OAuth credential provider.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::BedrockAgentCore::GatewayTarget.S3Configuration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.S3Configuration`\n\nThe S3 configuration for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html", "Properties": { "BucketOwnerAccountId": { "MarkdownDocumentation": "`BucketOwnerAccountId`\n\nThe S3 configuration bucket owner account ID for the gateway target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Uri": { "MarkdownDocumentation": "`Uri`\n\nThe configuration URI for the gateway target.\n*Required*: No\n*Type*: String\n*Pattern*: `^s3://.{1,2043}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::GatewayTarget.SchemaDefinition": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.SchemaDefinition`\n\nThe schema definition for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe scheme definition type for the gateway target.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `string | number | object | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "string", "number", "object", "array", "boolean", "integer" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe workload identity details for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Required": { "MarkdownDocumentation": "`Required`\n\nThe schema definition.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-required", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Items": { "MarkdownDocumentation": "`Items`\n\nProperty description not available.\n*Required*: No\n*Type*: [SchemaDefinition](./aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-items", "UpdateType": "Mutable", "Required": false, "Type": "SchemaDefinition" }, "Properties": { "MarkdownDocumentation": "`Properties`\n\nThe schema definition properties for the gateway target.\n*Required*: No\n*Type*: Object of [SchemaDefinition](./aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "SchemaDefinition" } } }, "AWS::BedrockAgentCore::GatewayTarget.TargetConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.TargetConfiguration`\n\nThe target configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html", "Properties": { "Mcp": { "MarkdownDocumentation": "`Mcp`\n\nThe target configuration definition for MCP.\n*Required*: Yes\n*Type*: [McpTargetConfiguration](./aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration-mcp", "UpdateType": "Mutable", "Required": true, "Type": "McpTargetConfiguration" } } }, "AWS::BedrockAgentCore::GatewayTarget.ToolDefinition": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.ToolDefinition`\n\nThe tool definition for the gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html", "Properties": { "OutputSchema": { "MarkdownDocumentation": "`OutputSchema`\n\nThe tool definition output schema for the gateway target.\n*Required*: No\n*Type*: [SchemaDefinition](./aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema", "UpdateType": "Mutable", "Required": false, "Type": "SchemaDefinition" }, "Description": { "MarkdownDocumentation": "`Description`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputSchema": { "MarkdownDocumentation": "`InputSchema`\n\nThe input schema for the gateway target.\n*Required*: Yes\n*Type*: [SchemaDefinition](./aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema", "UpdateType": "Mutable", "Required": true, "Type": "SchemaDefinition" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe tool 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::GatewayTarget.ToolSchema": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget.ToolSchema`\n\nThe tool schema for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nThe S3 tool schema for the gateway target.\n*Required*: No\n*Type*: [S3Configuration](./aws-properties-bedrockagentcore-gatewaytarget-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3Configuration" }, "InlinePayload": { "MarkdownDocumentation": "`InlinePayload`\n\nThe inline payload for the gateway target.\n*Required*: No\n*Type*: Array of [ToolDefinition](./aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-inlinepayload", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ToolDefinition", "DuplicatesAllowed": true } } }, "AWS::BedrockAgentCore::Memory.CustomConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.CustomConfigurationInput`\n\nThe memory configuration input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html", "Properties": { "SummaryOverride": { "MarkdownDocumentation": "`SummaryOverride`\n\nThe memory configuration override.\n*Required*: No\n*Type*: [SummaryOverride](./aws-properties-bedrockagentcore-memory-summaryoverride.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-summaryoverride", "UpdateType": "Mutable", "Required": false, "Type": "SummaryOverride" }, "UserPreferenceOverride": { "MarkdownDocumentation": "`UserPreferenceOverride`\n\nThe memory user preference override.\n*Required*: No\n*Type*: [UserPreferenceOverride](./aws-properties-bedrockagentcore-memory-userpreferenceoverride.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-userpreferenceoverride", "UpdateType": "Mutable", "Required": false, "Type": "UserPreferenceOverride" }, "EpisodicOverride": { "MarkdownDocumentation": "`EpisodicOverride`\n\nProperty description not available.\n*Required*: No\n*Type*: [EpisodicOverride](./aws-properties-bedrockagentcore-memory-episodicoverride.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-episodicoverride", "UpdateType": "Mutable", "Required": false, "Type": "EpisodicOverride" }, "SemanticOverride": { "MarkdownDocumentation": "`SemanticOverride`\n\nThe memory override configuration.\n*Required*: No\n*Type*: [SemanticOverride](./aws-properties-bedrockagentcore-memory-semanticoverride.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-semanticoverride", "UpdateType": "Mutable", "Required": false, "Type": "SemanticOverride" }, "SelfManagedConfiguration": { "MarkdownDocumentation": "`SelfManagedConfiguration`\n\nThe custom configuration input.\n*Required*: No\n*Type*: [SelfManagedConfiguration](./aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-selfmanagedconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SelfManagedConfiguration" } } }, "AWS::BedrockAgentCore::Memory.CustomMemoryStrategy": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.CustomMemoryStrategy`\n\nThe memory strategy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe memory strategy status.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATING | ACTIVE | DELETIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATING", "ACTIVE", "DELETING", "FAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespaces": { "MarkdownDocumentation": "`Namespaces`\n\nThe memory strategy namespaces.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-namespaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe memory strategy type.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEMANTIC | SUMMARIZATION | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "CUSTOM", "EPISODIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe memory strategy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe memory strategy configuration.\n*Required*: No\n*Type*: [CustomConfigurationInput](./aws-properties-bedrockagentcore-memory-customconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-configuration", "UpdateType": "Mutable", "Required": false, "Type": "CustomConfigurationInput" }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-createdat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StrategyId": { "MarkdownDocumentation": "`StrategyId`\n\nThe memory strategy ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`\n*Minimum*: `12`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-strategyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpdatedAt": { "MarkdownDocumentation": "`UpdatedAt`\n\nThe memory strategy update date and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-updatedat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe memory strategy name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.EpisodicMemoryStrategy": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.EpisodicMemoryStrategy`\n\nThe `EpisodicMemoryStrategy` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Memory](./aws-resource-bedrockagentcore-memory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATING | ACTIVE | DELETIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATING", "ACTIVE", "DELETING", "FAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespaces": { "MarkdownDocumentation": "`Namespaces`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-namespaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEMANTIC | SUMMARIZATION | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "CUSTOM", "EPISODIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReflectionConfiguration": { "MarkdownDocumentation": "`ReflectionConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [EpisodicReflectionConfigurationInput](./aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-reflectionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EpisodicReflectionConfigurationInput" }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-createdat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StrategyId": { "MarkdownDocumentation": "`StrategyId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`\n*Minimum*: `12`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-strategyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpdatedAt": { "MarkdownDocumentation": "`UpdatedAt`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-updatedat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.EpisodicOverride": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.EpisodicOverride`\n\nThe `EpisodicOverride` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Memory](./aws-resource-bedrockagentcore-memory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverride.html", "Properties": { "Consolidation": { "MarkdownDocumentation": "`Consolidation`\n\nProperty description not available.\n*Required*: No\n*Type*: [EpisodicOverrideConsolidationConfigurationInput](./aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverride.html#cfn-bedrockagentcore-memory-episodicoverride-consolidation", "UpdateType": "Mutable", "Required": false, "Type": "EpisodicOverrideConsolidationConfigurationInput" }, "Extraction": { "MarkdownDocumentation": "`Extraction`\n\nProperty description not available.\n*Required*: No\n*Type*: [EpisodicOverrideExtractionConfigurationInput](./aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverride.html#cfn-bedrockagentcore-memory-episodicoverride-extraction", "UpdateType": "Mutable", "Required": false, "Type": "EpisodicOverrideExtractionConfigurationInput" }, "Reflection": { "MarkdownDocumentation": "`Reflection`\n\nProperty description not available.\n*Required*: No\n*Type*: [EpisodicOverrideReflectionConfigurationInput](./aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverride.html#cfn-bedrockagentcore-memory-episodicoverride-reflection", "UpdateType": "Mutable", "Required": false, "Type": "EpisodicOverrideReflectionConfigurationInput" } } }, "AWS::BedrockAgentCore::Memory.EpisodicOverrideConsolidationConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.EpisodicOverrideConsolidationConfigurationInput`\n\nThe `EpisodicOverrideConsolidationConfigurationInput` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Memory](./aws-resource-bedrockagentcore-memory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput.html", "Properties": { "AppendToPrompt": { "MarkdownDocumentation": "`AppendToPrompt`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-appendtoprompt", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.EpisodicOverrideExtractionConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.EpisodicOverrideExtractionConfigurationInput`\n\nThe `EpisodicOverrideExtractionConfigurationInput` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Memory](./aws-resource-bedrockagentcore-memory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput.html", "Properties": { "AppendToPrompt": { "MarkdownDocumentation": "`AppendToPrompt`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-appendtoprompt", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.EpisodicOverrideReflectionConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.EpisodicOverrideReflectionConfigurationInput`\n\nThe `EpisodicOverrideReflectionConfigurationInput` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Memory](./aws-resource-bedrockagentcore-memory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html", "Properties": { "Namespaces": { "MarkdownDocumentation": "`Namespaces`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AppendToPrompt": { "MarkdownDocumentation": "`AppendToPrompt`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-appendtoprompt", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.EpisodicReflectionConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.EpisodicReflectionConfigurationInput`\n\nThe `EpisodicReflectionConfigurationInput` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Memory](./aws-resource-bedrockagentcore-memory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput.html", "Properties": { "Namespaces": { "MarkdownDocumentation": "`Namespaces`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespaces", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::BedrockAgentCore::Memory.InvocationConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.InvocationConfigurationInput`\n\nThe memory invocation configuration input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html", "Properties": { "TopicArn": { "MarkdownDocumentation": "`TopicArn`\n\nThe memory trigger condition topic Amazon Resource Name (ARN).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html#cfn-bedrockagentcore-memory-invocationconfigurationinput-topicarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PayloadDeliveryBucketName": { "MarkdownDocumentation": "`PayloadDeliveryBucketName`\n\nThe message invocation configuration information for the bucket name.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html#cfn-bedrockagentcore-memory-invocationconfigurationinput-payloaddeliverybucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.MemoryStrategy": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.MemoryStrategy`\n\nThe memory strategy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html", "Properties": { "SummaryMemoryStrategy": { "MarkdownDocumentation": "`SummaryMemoryStrategy`\n\nThe memory strategy summary.\n*Required*: No\n*Type*: [SummaryMemoryStrategy](./aws-properties-bedrockagentcore-memory-summarymemorystrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-summarymemorystrategy", "UpdateType": "Mutable", "Required": false, "Type": "SummaryMemoryStrategy" }, "CustomMemoryStrategy": { "MarkdownDocumentation": "`CustomMemoryStrategy`\n\nThe memory strategy.\n*Required*: No\n*Type*: [CustomMemoryStrategy](./aws-properties-bedrockagentcore-memory-custommemorystrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-custommemorystrategy", "UpdateType": "Mutable", "Required": false, "Type": "CustomMemoryStrategy" }, "SemanticMemoryStrategy": { "MarkdownDocumentation": "`SemanticMemoryStrategy`\n\nThe memory strategy.\n*Required*: No\n*Type*: [SemanticMemoryStrategy](./aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-semanticmemorystrategy", "UpdateType": "Mutable", "Required": false, "Type": "SemanticMemoryStrategy" }, "UserPreferenceMemoryStrategy": { "MarkdownDocumentation": "`UserPreferenceMemoryStrategy`\n\nThe memory strategy.\n*Required*: No\n*Type*: [UserPreferenceMemoryStrategy](./aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-userpreferencememorystrategy", "UpdateType": "Mutable", "Required": false, "Type": "UserPreferenceMemoryStrategy" }, "EpisodicMemoryStrategy": { "MarkdownDocumentation": "`EpisodicMemoryStrategy`\n\nProperty description not available.\n*Required*: No\n*Type*: [EpisodicMemoryStrategy](./aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-episodicmemorystrategy", "UpdateType": "Mutable", "Required": false, "Type": "EpisodicMemoryStrategy" } } }, "AWS::BedrockAgentCore::Memory.MessageBasedTriggerInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.MessageBasedTriggerInput`\n\nThe message based trigger input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-messagebasedtriggerinput.html", "Properties": { "MessageCount": { "MarkdownDocumentation": "`MessageCount`\n\nThe memory trigger condition input for the message based trigger message count.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-messagebasedtriggerinput.html#cfn-bedrockagentcore-memory-messagebasedtriggerinput-messagecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::BedrockAgentCore::Memory.SelfManagedConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.SelfManagedConfiguration`\n\nThe self managed configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html", "Properties": { "TriggerConditions": { "MarkdownDocumentation": "`TriggerConditions`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [TriggerConditionInput](./aws-properties-bedrockagentcore-memory-triggerconditioninput.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-triggerconditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TriggerConditionInput", "DuplicatesAllowed": true }, "InvocationConfiguration": { "MarkdownDocumentation": "`InvocationConfiguration`\n\nThe self managed configuration.\n*Required*: No\n*Type*: [InvocationConfigurationInput](./aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-invocationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InvocationConfigurationInput" }, "HistoricalContextWindowSize": { "MarkdownDocumentation": "`HistoricalContextWindowSize`\n\nThe memory configuration for self managed.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-historicalcontextwindowsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::BedrockAgentCore::Memory.SemanticMemoryStrategy": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.SemanticMemoryStrategy`\n\nThe memory strategy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATING | ACTIVE | DELETIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATING", "ACTIVE", "DELETING", "FAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespaces": { "MarkdownDocumentation": "`Namespaces`\n\nThe memory strategy namespaces.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-namespaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe memory strategy type.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEMANTIC | SUMMARIZATION | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "CUSTOM", "EPISODIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe memory strategy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-createdat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StrategyId": { "MarkdownDocumentation": "`StrategyId`\n\nThe memory strategy ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`\n*Minimum*: `12`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-strategyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpdatedAt": { "MarkdownDocumentation": "`UpdatedAt`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-updatedat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe memory strategy name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.SemanticOverride": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.SemanticOverride`\n\nThe memory override.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverride.html", "Properties": { "Consolidation": { "MarkdownDocumentation": "`Consolidation`\n\nThe memory override consolidation.\n*Required*: No\n*Type*: [SemanticOverrideConsolidationConfigurationInput](./aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverride.html#cfn-bedrockagentcore-memory-semanticoverride-consolidation", "UpdateType": "Mutable", "Required": false, "Type": "SemanticOverrideConsolidationConfigurationInput" }, "Extraction": { "MarkdownDocumentation": "`Extraction`\n\nThe memory override extraction.\n*Required*: No\n*Type*: [SemanticOverrideExtractionConfigurationInput](./aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverride.html#cfn-bedrockagentcore-memory-semanticoverride-extraction", "UpdateType": "Mutable", "Required": false, "Type": "SemanticOverrideExtractionConfigurationInput" } } }, "AWS::BedrockAgentCore::Memory.SemanticOverrideConsolidationConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.SemanticOverrideConsolidationConfigurationInput`\n\nThe memory override configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html", "Properties": { "AppendToPrompt": { "MarkdownDocumentation": "`AppendToPrompt`\n\nThe override configuration.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-appendtoprompt", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe memory override model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.SemanticOverrideExtractionConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.SemanticOverrideExtractionConfigurationInput`\n\nThe memory override configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html", "Properties": { "AppendToPrompt": { "MarkdownDocumentation": "`AppendToPrompt`\n\nThe extraction configuration.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-appendtoprompt", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe memory override configuration model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.SummaryMemoryStrategy": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.SummaryMemoryStrategy`\n\nThe memory strategy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe memory strategy status.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATING | ACTIVE | DELETIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATING", "ACTIVE", "DELETING", "FAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespaces": { "MarkdownDocumentation": "`Namespaces`\n\nThe summary memory strategy.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-namespaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe memory strategy type.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEMANTIC | SUMMARIZATION | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "CUSTOM", "EPISODIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe memory strategy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-createdat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StrategyId": { "MarkdownDocumentation": "`StrategyId`\n\nThe memory strategy ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`\n*Minimum*: `12`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-strategyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpdatedAt": { "MarkdownDocumentation": "`UpdatedAt`\n\nThe memory strategy update date and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-updatedat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe memory strategy name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.SummaryOverride": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.SummaryOverride`\n\nThe memory summary override.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverride.html", "Properties": { "Consolidation": { "MarkdownDocumentation": "`Consolidation`\n\nThe memory override consolidation.\n*Required*: No\n*Type*: [SummaryOverrideConsolidationConfigurationInput](./aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverride.html#cfn-bedrockagentcore-memory-summaryoverride-consolidation", "UpdateType": "Mutable", "Required": false, "Type": "SummaryOverrideConsolidationConfigurationInput" } } }, "AWS::BedrockAgentCore::Memory.SummaryOverrideConsolidationConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.SummaryOverrideConsolidationConfigurationInput`\n\nThe consolidation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html", "Properties": { "AppendToPrompt": { "MarkdownDocumentation": "`AppendToPrompt`\n\nThe memory override configuration.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-appendtoprompt", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe memory override configuration model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.TimeBasedTriggerInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.TimeBasedTriggerInput`\n\nThe memory trigger condition input for the time based trigger.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-timebasedtriggerinput.html", "Properties": { "IdleSessionTimeout": { "MarkdownDocumentation": "`IdleSessionTimeout`\n\nThe memory trigger condition input for the session timeout.\n*Required*: No\n*Type*: Integer\n*Minimum*: `10`\n*Maximum*: `3000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-timebasedtriggerinput.html#cfn-bedrockagentcore-memory-timebasedtriggerinput-idlesessiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::BedrockAgentCore::Memory.TokenBasedTriggerInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.TokenBasedTriggerInput`\n\nThe token based trigger input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput.html", "Properties": { "TokenCount": { "MarkdownDocumentation": "`TokenCount`\n\nThe token based trigger token count.\n*Required*: No\n*Type*: Integer\n*Minimum*: `100`\n*Maximum*: `500000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput.html#cfn-bedrockagentcore-memory-tokenbasedtriggerinput-tokencount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::BedrockAgentCore::Memory.TriggerConditionInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.TriggerConditionInput`\n\nThe memory trigger condition input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html", "Properties": { "MessageBasedTrigger": { "MarkdownDocumentation": "`MessageBasedTrigger`\n\nThe memory trigger condition input for the message based trigger.\n*Required*: No\n*Type*: [MessageBasedTriggerInput](./aws-properties-bedrockagentcore-memory-messagebasedtriggerinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-messagebasedtrigger", "UpdateType": "Mutable", "Required": false, "Type": "MessageBasedTriggerInput" }, "TokenBasedTrigger": { "MarkdownDocumentation": "`TokenBasedTrigger`\n\nThe trigger condition information for a token based trigger.\n*Required*: No\n*Type*: [TokenBasedTriggerInput](./aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-tokenbasedtrigger", "UpdateType": "Mutable", "Required": false, "Type": "TokenBasedTriggerInput" }, "TimeBasedTrigger": { "MarkdownDocumentation": "`TimeBasedTrigger`\n\nThe memory trigger condition input.\n*Required*: No\n*Type*: [TimeBasedTriggerInput](./aws-properties-bedrockagentcore-memory-timebasedtriggerinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-timebasedtrigger", "UpdateType": "Mutable", "Required": false, "Type": "TimeBasedTriggerInput" } } }, "AWS::BedrockAgentCore::Memory.UserPreferenceMemoryStrategy": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.UserPreferenceMemoryStrategy`\n\nThe memory strategy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe memory strategy status.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATING | ACTIVE | DELETIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATING", "ACTIVE", "DELETING", "FAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespaces": { "MarkdownDocumentation": "`Namespaces`\n\nThe memory namespaces.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe memory strategy type.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEMANTIC | SUMMARIZATION | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEMANTIC", "SUMMARIZATION", "USER_PREFERENCE", "CUSTOM", "EPISODIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe memory strategy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-createdat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StrategyId": { "MarkdownDocumentation": "`StrategyId`\n\nThe memory strategy ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$`\n*Minimum*: `12`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-strategyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpdatedAt": { "MarkdownDocumentation": "`UpdatedAt`\n\nThe memory strategy update date and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-updatedat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe memory strategy name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.UserPreferenceOverride": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.UserPreferenceOverride`\n\nThe memory user preference override.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverride.html", "Properties": { "Consolidation": { "MarkdownDocumentation": "`Consolidation`\n\nThe memory override consolidation information.\n*Required*: No\n*Type*: [UserPreferenceOverrideConsolidationConfigurationInput](./aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverride.html#cfn-bedrockagentcore-memory-userpreferenceoverride-consolidation", "UpdateType": "Mutable", "Required": false, "Type": "UserPreferenceOverrideConsolidationConfigurationInput" }, "Extraction": { "MarkdownDocumentation": "`Extraction`\n\nThe memory user preferences for extraction.\n*Required*: No\n*Type*: [UserPreferenceOverrideExtractionConfigurationInput](./aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverride.html#cfn-bedrockagentcore-memory-userpreferenceoverride-extraction", "UpdateType": "Mutable", "Required": false, "Type": "UserPreferenceOverrideExtractionConfigurationInput" } } }, "AWS::BedrockAgentCore::Memory.UserPreferenceOverrideConsolidationConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.UserPreferenceOverrideConsolidationConfigurationInput`\n\nThe configuration input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html", "Properties": { "AppendToPrompt": { "MarkdownDocumentation": "`AppendToPrompt`\n\nThe memory configuration.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-appendtoprompt", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe memory override configuration model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Memory.UserPreferenceOverrideExtractionConfigurationInput": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory.UserPreferenceOverrideExtractionConfigurationInput`\n\nThe memory override configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html", "Properties": { "AppendToPrompt": { "MarkdownDocumentation": "`AppendToPrompt`\n\nThe extraction configuration.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-appendtoprompt", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ModelId": { "MarkdownDocumentation": "`ModelId`\n\nThe memory override for the model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-modelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Runtime.AgentRuntimeArtifact": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.AgentRuntimeArtifact`\n\nThe artifact of the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html", "Properties": { "CodeConfiguration": { "MarkdownDocumentation": "`CodeConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [CodeConfiguration](./aws-properties-bedrockagentcore-runtime-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html#cfn-bedrockagentcore-runtime-agentruntimeartifact-codeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CodeConfiguration" }, "ContainerConfiguration": { "MarkdownDocumentation": "`ContainerConfiguration`\n\nRepresentation of a container configuration.\n*Required*: No\n*Type*: [ContainerConfiguration](./aws-properties-bedrockagentcore-runtime-containerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html#cfn-bedrockagentcore-runtime-agentruntimeartifact-containerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ContainerConfiguration" } } }, "AWS::BedrockAgentCore::Runtime.AuthorizerConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.AuthorizerConfiguration`\n\nThe authorizer configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-authorizerconfiguration.html", "Properties": { "CustomJWTAuthorizer": { "MarkdownDocumentation": "`CustomJWTAuthorizer`\n\nRepresents inbound authorization configuration options used to authenticate incoming\nrequests.\n*Required*: No\n*Type*: [CustomJWTAuthorizerConfiguration](./aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-authorizerconfiguration.html#cfn-bedrockagentcore-runtime-authorizerconfiguration-customjwtauthorizer", "UpdateType": "Mutable", "Required": false, "Type": "CustomJWTAuthorizerConfiguration" } } }, "AWS::BedrockAgentCore::Runtime.Code": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.Code`\n\nThe `Code` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](./aws-resource-bedrockagentcore-runtime.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-code.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nProperty description not available.\n*Required*: No\n*Type*: [S3Location](./aws-properties-bedrockagentcore-runtime-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-code.html#cfn-bedrockagentcore-runtime-code-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" } } }, "AWS::BedrockAgentCore::Runtime.CodeConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.CodeConfiguration`\n\nThe `CodeConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](./aws-resource-bedrockagentcore-runtime.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html", "Properties": { "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PYTHON_3_10 | PYTHON_3_11 |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PYTHON_3_10", "PYTHON_3_11", "PYTHON_3_12", "PYTHON_3_13" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-runtime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EntryPoint": { "MarkdownDocumentation": "`EntryPoint`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-entrypoint", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Code": { "MarkdownDocumentation": "`Code`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [Code](./aws-properties-bedrockagentcore-runtime-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-code", "UpdateType": "Mutable", "Required": true, "Type": "Code" } } }, "AWS::BedrockAgentCore::Runtime.ContainerConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.ContainerConfiguration`\n\nThe container configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-containerconfiguration.html", "Properties": { "ContainerUri": { "MarkdownDocumentation": "`ContainerUri`\n\nThe container Uri.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\d{12}\\.dkr\\.ecr\\.([a-z0-9-]+)\\.amazonaws\\.com/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)([:@]\\S+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-containerconfiguration.html#cfn-bedrockagentcore-runtime-containerconfiguration-containeruri", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Runtime.CustomJWTAuthorizerConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.CustomJWTAuthorizerConfiguration`\n\nThe `CustomJWTAuthorizerConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](./aws-resource-bedrockagentcore-runtime.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html", "Properties": { "DiscoveryUrl": { "MarkdownDocumentation": "`DiscoveryUrl`\n\nThe configuration authorization.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.+/\\.well-known/openid-configuration$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-discoveryurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AllowedAudience": { "MarkdownDocumentation": "`AllowedAudience`\n\nRepresents inbound authorization configuration options used to authenticate incoming\nrequests.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedaudience", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedClients": { "MarkdownDocumentation": "`AllowedClients`\n\nRepresents individual client IDs that are validated in the incoming JWT token\nvalidation process.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedclients", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::BedrockAgentCore::Runtime.LifecycleConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.LifecycleConfiguration`\n\nThe `LifecycleConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](./aws-resource-bedrockagentcore-runtime.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html", "Properties": { "MaxLifetime": { "MarkdownDocumentation": "`MaxLifetime`\n\nProperty description not available.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `28800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html#cfn-bedrockagentcore-runtime-lifecycleconfiguration-maxlifetime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IdleRuntimeSessionTimeout": { "MarkdownDocumentation": "`IdleRuntimeSessionTimeout`\n\nProperty description not available.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `28800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html#cfn-bedrockagentcore-runtime-lifecycleconfiguration-idleruntimesessiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::BedrockAgentCore::Runtime.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.NetworkConfiguration`\n\nThe network configuration for the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-networkconfiguration.html", "Properties": { "NetworkModeConfig": { "MarkdownDocumentation": "`NetworkModeConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-bedrockagentcore-runtime-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-networkconfiguration.html#cfn-bedrockagentcore-runtime-networkconfiguration-networkmodeconfig", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfig" }, "NetworkMode": { "MarkdownDocumentation": "`NetworkMode`\n\nThe network mode.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PUBLIC | VPC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PUBLIC", "VPC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-networkconfiguration.html#cfn-bedrockagentcore-runtime-networkconfiguration-networkmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Runtime.RequestHeaderConfiguration": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.RequestHeaderConfiguration`\n\nThe `RequestHeaderConfiguration` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](./aws-resource-bedrockagentcore-runtime.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-requestheaderconfiguration.html", "Properties": { "RequestHeaderAllowlist": { "MarkdownDocumentation": "`RequestHeaderAllowlist`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-requestheaderconfiguration.html#cfn-bedrockagentcore-runtime-requestheaderconfiguration-requestheaderallowlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::BedrockAgentCore::Runtime.S3Location": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.S3Location`\n\nThe `S3Location` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](./aws-resource-bedrockagentcore-runtime.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html", "Properties": { "VersionId": { "MarkdownDocumentation": "`VersionId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-versionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-prefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::BedrockAgentCore::Runtime.VpcConfig": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.VpcConfig`\n\nThe `VpcConfig` property type specifies Property description not available. for an [AWS::BedrockAgentCore::Runtime](./aws-resource-bedrockagentcore-runtime.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-vpcconfig.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-vpcconfig.html#cfn-bedrockagentcore-runtime-vpcconfig-securitygroups", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-vpcconfig.html#cfn-bedrockagentcore-runtime-vpcconfig-subnets", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::BedrockAgentCore::Runtime.WorkloadIdentityDetails": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime.WorkloadIdentityDetails`\n\nThe workload identity details for the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-workloadidentitydetails.html", "Properties": { "WorkloadIdentityArn": { "MarkdownDocumentation": "`WorkloadIdentityArn`\n\nThe Amazon Resource Name (ARN) for the workload identity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-workloadidentitydetails.html#cfn-bedrockagentcore-runtime-workloadidentitydetails-workloadidentityarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Budgets::Budget.AutoAdjustData": { "MarkdownDocumentation": "`AWS::Budgets::Budget.AutoAdjustData`\n\nDetermine the budget amount for an auto-adjusting budget.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-autoadjustdata.html", "Properties": { "AutoAdjustType": { "Required": true, "MarkdownDocumentation": "`AutoAdjustType`\n\nThe string that defines whether your budget auto-adjusts based on historical or forecasted data.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HISTORICAL | FORECAST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HISTORICAL", "FORECAST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-autoadjustdata.html#cfn-budgets-budget-autoadjustdata-autoadjusttype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HistoricalOptions": { "Type": "HistoricalOptions", "Required": false, "MarkdownDocumentation": "`HistoricalOptions`\n\nThe parameters that define or describe the historical data that your auto-adjusting budget is based on.\n*Required*: No\n*Type*: [HistoricalOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-autoadjustdata.html#cfn-budgets-budget-autoadjustdata-historicaloptions", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.BudgetData": { "MarkdownDocumentation": "`AWS::Budgets::Budget.BudgetData`\n\nRepresents the output of the `CreateBudget` operation. The content consists\nof the detailed metadata and data file information, and the current status of the\n`budget` object.\nThis is the Amazon Resource Name (ARN) pattern for a budget:\n`arn:aws:budgets::AccountId:budget/budgetName`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html", "Properties": { "Metrics": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Metrics`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-metrics", "UpdateType": "Mutable" }, "BudgetLimit": { "Type": "Spend", "Required": false, "MarkdownDocumentation": "`BudgetLimit`\n\nThe total amount of cost, usage, RI utilization, RI coverage, Savings Plans\nutilization, 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\nSavings Plans utilization or coverage budgets. RI and Savings Plans utilization or\ncoverage budgets default to `100`. This is the only valid value for RI or\nSavings Plans utilization or coverage budgets. You can't use `BudgetLimit`\nwith `PlannedBudgetLimits` for `CreateBudget` and\n`UpdateBudget` actions.\n*Required*: No\n*Type*: [Spend](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetlimit", "UpdateType": "Mutable" }, "TimePeriod": { "Type": "TimePeriod", "Required": false, "MarkdownDocumentation": "`TimePeriod`\n\nThe period of time that is covered by a budget. The period has a start date and an end\ndate. 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\ndate, the start date defaults to the start of the chosen time period (MONTHLY, QUARTERLY, or\nANNUALLY). For example, if you create your budget on January 24, 2019, choose\n`MONTHLY`, and don't set a start date, the start date defaults to\n`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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeperiod", "UpdateType": "Mutable" }, "BillingViewArn": { "Required": false, "MarkdownDocumentation": "`BillingViewArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-billingviewarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AutoAdjustData": { "Type": "AutoAdjustData", "Required": false, "MarkdownDocumentation": "`AutoAdjustData`\n\nDetermine the budget amount for an auto-adjusting budget.\n*Required*: No\n*Type*: [AutoAdjustData](./aws-properties-budgets-budget-autoadjustdata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-autoadjustdata", "UpdateType": "Mutable" }, "TimeUnit": { "Required": true, "MarkdownDocumentation": "`TimeUnit`\n\nThe length of time until a budget resets the actual and forecasted spend. `DAILY` is available only for\n`RI_UTILIZATION` and `RI_COVERAGE` budgets.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DAILY | MONTHLY | QUARTERLY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAILY", "MONTHLY", "QUARTERLY", "ANNUALLY", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PlannedBudgetLimits": { "Required": false, "MarkdownDocumentation": "`PlannedBudgetLimits`\n\nA map containing multiple `BudgetLimit`, including current or future\nlimits.\n`PlannedBudgetLimits` is available for cost or usage budget and supports\nboth monthly and quarterly `TimeUnit`.\nFor monthly budgets, provide 12 months of `PlannedBudgetLimits` values.\nThis must start from the current month and include the next 11 months. The\n`key` is the start of the month, `UTC` in epoch seconds.\nFor quarterly budgets, provide four quarters of `PlannedBudgetLimits` value\nentries in standard calendar quarter increments. This must start from the current\nquarter and include the next three quarters. The `key` is the start of the\nquarter, `UTC` in epoch seconds.\nIf the planned budget expires before 12 months for monthly or four quarters for\nquarterly, provide the `PlannedBudgetLimits` values only for the remaining\nperiods.\nIf the budget begins at a date in the future, provide `PlannedBudgetLimits`\nvalues from the start date of the budget.\nAfter all of the `BudgetLimit` values in `PlannedBudgetLimits`\nare used, the budget continues to use the last limit as the `BudgetLimit`. At\nthat point, the planned budget provides the same experience as a fixed budget.\n`DescribeBudget` and `DescribeBudgets` response along with\n`PlannedBudgetLimits` also contain `BudgetLimit` representing\nthe current month or quarter limit present in `PlannedBudgetLimits`. This\nonly applies to budgets that are created with `PlannedBudgetLimits`. Budgets\nthat are created without `PlannedBudgetLimits` only contain\n`BudgetLimit`. They don't contain\n`PlannedBudgetLimits`.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-plannedbudgetlimits", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "CostFilters": { "Required": false, "MarkdownDocumentation": "`CostFilters`\n\nThe cost filters, such as `Region`, `Service`,\n`LinkedAccount`, `Tag`, or `CostCategory`, that are\napplied to a budget.\nAWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costfilters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "FilterExpression": { "Type": "Expression", "Required": false, "MarkdownDocumentation": "`FilterExpression`\n\nProperty description not available.\n*Required*: No\n*Type*: [Expression](./aws-properties-budgets-budget-expression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-filterexpression", "UpdateType": "Mutable" }, "BudgetName": { "Required": false, "MarkdownDocumentation": "`BudgetName`\n\nThe name of a budget. The value must be unique within an account. `BudgetName` can't include\n`:` and `\\` characters. If you don't include value for `BudgetName` in the template,\nBilling and Cost Management assigns your budget a randomly generated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CostTypes": { "Type": "CostTypes", "Required": false, "MarkdownDocumentation": "`CostTypes`\n\nThe types of costs that are included in this `COST` budget.\n`USAGE`, `RI_UTILIZATION`, `RI_COVERAGE`,\n`SAVINGS_PLANS_UTILIZATION`, and `SAVINGS_PLANS_COVERAGE`\nbudgets do not have `CostTypes`.\n*Required*: No\n*Type*: [CostTypes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costtypes", "UpdateType": "Mutable" }, "BudgetType": { "Required": true, "MarkdownDocumentation": "`BudgetType`\n\nSpecifies whether this budget tracks costs, usage, RI utilization, RI coverage,\nSavings Plans utilization, or Savings Plans coverage.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `USAGE | COST | RI_UTILIZATI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_COVERAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgettype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.CostCategoryValues": { "MarkdownDocumentation": "`AWS::Budgets::Budget.CostCategoryValues`\n\nThe cost category values used for filtering the costs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costcategoryvalues.html", "Properties": { "MatchOptions": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`MatchOptions`\n\nThe match options that you can use to filter your results.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costcategoryvalues.html#cfn-budgets-budget-costcategoryvalues-matchoptions", "UpdateType": "Mutable" }, "Values": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Values`\n\nThe specific value of the cost category.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costcategoryvalues.html#cfn-budgets-budget-costcategoryvalues-values", "UpdateType": "Mutable" }, "Key": { "Required": false, "MarkdownDocumentation": "`Key`\n\nThe unique name of the cost category.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costcategoryvalues.html#cfn-budgets-budget-costcategoryvalues-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.CostTypes": { "MarkdownDocumentation": "`AWS::Budgets::Budget.CostTypes`\n\nThe types of cost that are included in a `COST` budget, such as tax and\nsubscriptions.\n`USAGE`, `RI_UTILIZATION`, `RI_COVERAGE`,\n`SAVINGS_PLANS_UTILIZATION`, and `SAVINGS_PLANS_COVERAGE`\nbudgets don't have `CostTypes`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html", "Properties": { "IncludeSupport": { "Required": false, "MarkdownDocumentation": "`IncludeSupport`\n\nSpecifies whether a budget includes support subscription fees.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includesupport", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeOtherSubscription": { "Required": false, "MarkdownDocumentation": "`IncludeOtherSubscription`\n\nSpecifies whether a budget includes non-RI subscription costs.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includeothersubscription", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeTax": { "Required": false, "MarkdownDocumentation": "`IncludeTax`\n\nSpecifies whether a budget includes taxes.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includetax", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeSubscription": { "Required": false, "MarkdownDocumentation": "`IncludeSubscription`\n\nSpecifies whether a budget includes subscriptions.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includesubscription", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "UseBlended": { "Required": false, "MarkdownDocumentation": "`UseBlended`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-useblended", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeUpfront": { "Required": false, "MarkdownDocumentation": "`IncludeUpfront`\n\nSpecifies whether a budget includes upfront RI costs.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includeupfront", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeDiscount": { "Required": false, "MarkdownDocumentation": "`IncludeDiscount`\n\nSpecifies whether a budget includes discounts.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includediscount", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeCredit": { "Required": false, "MarkdownDocumentation": "`IncludeCredit`\n\nSpecifies whether a budget includes credits.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includecredit", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeRecurring": { "Required": false, "MarkdownDocumentation": "`IncludeRecurring`\n\nSpecifies whether a budget includes recurring fees such as monthly RI fees.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includerecurring", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "UseAmortized": { "Required": false, "MarkdownDocumentation": "`UseAmortized`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-useamortized", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeRefund": { "Required": false, "MarkdownDocumentation": "`IncludeRefund`\n\nSpecifies whether a budget includes refunds.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includerefund", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.Expression": { "MarkdownDocumentation": "`AWS::Budgets::Budget.Expression`\n\nUse Expression to filter in various Budgets APIs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expression.html", "Properties": { "Not": { "Type": "Expression", "Required": false, "MarkdownDocumentation": "`Not`\n\nReturn results that don't match a Dimension object.\n*Required*: No\n*Type*: [Expression](./aws-properties-budgets-budget-expression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expression.html#cfn-budgets-budget-expression-not", "UpdateType": "Mutable" }, "Or": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Or`\n\nReturn results that match either Dimension object.\n*Required*: No\n*Type*: Array of [Expression](./aws-properties-budgets-budget-expression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expression.html#cfn-budgets-budget-expression-or", "ItemType": "Expression", "UpdateType": "Mutable" }, "And": { "Type": "List", "Required": false, "MarkdownDocumentation": "`And`\n\nReturn results that match both Dimension objects.\n*Required*: No\n*Type*: Array of [Expression](./aws-properties-budgets-budget-expression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expression.html#cfn-budgets-budget-expression-and", "ItemType": "Expression", "UpdateType": "Mutable" }, "Dimensions": { "Type": "ExpressionDimensionValues", "Required": false, "MarkdownDocumentation": "`Dimensions`\n\nThe specific Dimension to use for Expression.\n*Required*: No\n*Type*: [ExpressionDimensionValues](./aws-properties-budgets-budget-expressiondimensionvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expression.html#cfn-budgets-budget-expression-dimensions", "UpdateType": "Mutable" }, "CostCategories": { "Type": "CostCategoryValues", "Required": false, "MarkdownDocumentation": "`CostCategories`\n\nThe filter that's based on CostCategoryValues.\n*Required*: No\n*Type*: [CostCategoryValues](./aws-properties-budgets-budget-costcategoryvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expression.html#cfn-budgets-budget-expression-costcategories", "UpdateType": "Mutable" }, "Tags": { "Type": "TagValues", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe specific Tag to use for Expression.\n*Required*: No\n*Type*: [TagValues](./aws-properties-budgets-budget-tagvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expression.html#cfn-budgets-budget-expression-tags", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.ExpressionDimensionValues": { "MarkdownDocumentation": "`AWS::Budgets::Budget.ExpressionDimensionValues`\n\nContains the specifications for the filters to use for your request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expressiondimensionvalues.html", "Properties": { "MatchOptions": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`MatchOptions`\n\nThe match options that you can use to filter your results. You can specify only one of these\nvalues in the array.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expressiondimensionvalues.html#cfn-budgets-budget-expressiondimensionvalues-matchoptions", "UpdateType": "Mutable" }, "Values": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Values`\n\nThe metadata values you can specify to filter upon, so that the results all match at least\none of the specified values.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expressiondimensionvalues.html#cfn-budgets-budget-expressiondimensionvalues-values", "UpdateType": "Mutable" }, "Key": { "Required": false, "MarkdownDocumentation": "`Key`\n\nThe name of the dimension that you want to filter on.\n*Required*: No\n*Type*: String\n*Allowed values*: `AZ | INSTANCE_TYPE | LINKED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "LINKED_ACCOUNT_NAME", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "SERVICE_CODE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "OPERATING_SYSTEM", "TENANCY", "SCOPE", "PLATFORM", "SUBSCRIPTION_ID", "LEGAL_ENTITY_NAME", "INVOICING_ENTITY", "DEPLOYMENT_OPTION", "DATABASE_ENGINE", "CACHE_ENGINE", "INSTANCE_TYPE_FAMILY", "BILLING_ENTITY", "RESERVATION_ID", "RESOURCE_ID", "RIGHTSIZING_TYPE", "SAVINGS_PLANS_TYPE", "SAVINGS_PLAN_ARN", "PAYMENT_OPTION", "RESERVATION_MODIFIED", "TAG_KEY", "COST_CATEGORY_NAME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-expressiondimensionvalues.html#cfn-budgets-budget-expressiondimensionvalues-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.HistoricalOptions": { "MarkdownDocumentation": "`AWS::Budgets::Budget.HistoricalOptions`\n\nThe parameters that define or describe the historical data that your auto-adjusting budget is based on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-historicaloptions.html", "Properties": { "BudgetAdjustmentPeriod": { "Required": true, "MarkdownDocumentation": "`BudgetAdjustmentPeriod`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-historicaloptions.html#cfn-budgets-budget-historicaloptions-budgetadjustmentperiod", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.Notification": { "MarkdownDocumentation": "`AWS::Budgets::Budget.Notification`\n\nA notification that's associated with a budget. A budget can have up to ten\nnotifications.\nEach notification must have at least one subscriber. A notification can have one SNS\nsubscriber and up to 10 email subscribers, for a total of 11 subscribers.\nFor example, if you have a budget for 200 dollars and you want to be notified when you\ngo over 160 dollars, create a notification with the following parameters:\n* A notificationType of `ACTUAL`\n* A `thresholdType` of `PERCENTAGE`\n* A `comparisonOperator` of `GREATER_THAN`\n* A notification `threshold` of `80`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html", "Properties": { "ComparisonOperator": { "Required": true, "MarkdownDocumentation": "`ComparisonOperator`\n\nThe comparison that's used for this notification.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GREATER_THAN | LESS_THAN | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "GREATER_THAN", "LESS_THAN", "EQUAL_TO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-comparisonoperator", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NotificationType": { "Required": true, "MarkdownDocumentation": "`NotificationType`\n\nSpecifies whether the notification is for how much you have spent\n(`ACTUAL`) or for how much that you're forecasted to spend\n(`FORECASTED`).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ACTUAL | FORECASTED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ACTUAL", "FORECASTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-notificationtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Threshold": { "Required": true, "MarkdownDocumentation": "`Threshold`\n\nThe threshold that's associated with a notification. Thresholds are always a\npercentage, and many customers find value being alerted between 50% - 200% of the\nbudgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted\namount.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-threshold", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "ThresholdType": { "Required": false, "MarkdownDocumentation": "`ThresholdType`\n\nThe type of threshold for a notification. For `ABSOLUTE_VALUE` thresholds,\nAWS notifies you when you go over or are forecasted to go over your\ntotal cost threshold. For\n`PERCENTAGE` thresholds, AWS notifies you when you go over\nor are forecasted to go over a certain percentage of your forecasted spend. For example,\nif you have a budget for 200 dollars and you have a `PERCENTAGE` threshold of\n80%, AWS notifies you when you go over 160 dollars.\n*Required*: No\n*Type*: String\n*Allowed values*: `PERCENTAGE | ABSOLUTE_VALUE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PERCENTAGE", "ABSOLUTE_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-thresholdtype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.NotificationWithSubscribers": { "MarkdownDocumentation": "`AWS::Budgets::Budget.NotificationWithSubscribers`\n\nA notification with subscribers. A notification can have one SNS subscriber and up to\n10 email subscribers, for a total of 11 subscribers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html", "Properties": { "Subscribers": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Subscribers`\n\nA list of subscribers who are subscribed to this notification.\n*Required*: Yes\n*Type*: Array of [Subscriber](./aws-properties-budgets-budget-subscriber.html)\n*Minimum*: `1`\n*Maximum*: `11`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html#cfn-budgets-budget-notificationwithsubscribers-subscribers", "ItemType": "Subscriber", "UpdateType": "Mutable" }, "Notification": { "Type": "Notification", "Required": true, "MarkdownDocumentation": "`Notification`\n\nThe notification that's associated with a budget.\n*Required*: Yes\n*Type*: [Notification](./aws-properties-budgets-budget-notification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html#cfn-budgets-budget-notificationwithsubscribers-notification", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.ResourceTag": { "MarkdownDocumentation": "`AWS::Budgets::Budget.ResourceTag`\n\nThe tag structure that contains a tag key and value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-resourcetag.html", "Properties": { "Value": { "Required": false, "MarkdownDocumentation": "`Value`\n\nThe value that's associated with the tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-resourcetag.html#cfn-budgets-budget-resourcetag-value", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Key": { "Required": true, "MarkdownDocumentation": "`Key`\n\nThe key that's associated with the tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-resourcetag.html#cfn-budgets-budget-resourcetag-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.Spend": { "MarkdownDocumentation": "`AWS::Budgets::Budget.Spend`\n\nThe amount of cost or usage that's measured for a budget.\n*Cost example:* A `Spend` for `3 USD` of\ncosts has the following parameters:\n* An `Amount` of `3`\n* A `Unit` of `USD`\n*Usage example:* A `Spend` for `3 GB` of S3\nusage has the following parameters:\n* An `Amount` of `3`\n* A `Unit` of `GB`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html", "Properties": { "Amount": { "Required": true, "MarkdownDocumentation": "`Amount`\n\nThe cost or usage amount that's associated with a budget forecast, actual spend, or\nbudget threshold.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html#cfn-budgets-budget-spend-amount", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "Unit": { "Required": true, "MarkdownDocumentation": "`Unit`\n\nThe unit of measurement that's used for the budget forecast, actual spend, or budget\nthreshold.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html#cfn-budgets-budget-spend-unit", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.Subscriber": { "MarkdownDocumentation": "`AWS::Budgets::Budget.Subscriber`\n\nThe `Subscriber` property type specifies who to notify for a Billing and Cost Management budget notification.\nThe subscriber consists of a subscription type, and either an Amazon SNS topic or an email address.\nFor example, an email subscriber would have the following parameters:\n* A `subscriptionType` of `EMAIL`\n* An `address` of `example@example.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html", "Properties": { "SubscriptionType": { "Required": true, "MarkdownDocumentation": "`SubscriptionType`\n\nThe type of notification that AWS sends to a subscriber.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SNS | EMAIL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SNS", "EMAIL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-subscriptiontype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Address": { "Required": true, "MarkdownDocumentation": "`Address`\n\nThe address that AWS sends budget notifications to, either an SNS topic\nor an email.\nWhen you create a subscriber, the value of `Address` can't contain line\nbreaks.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-address", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.TagValues": { "MarkdownDocumentation": "`AWS::Budgets::Budget.TagValues`\n\nThe values that are available for a tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-tagvalues.html", "Properties": { "MatchOptions": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`MatchOptions`\n\nThe match options that you can use to filter your results.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-tagvalues.html#cfn-budgets-budget-tagvalues-matchoptions", "UpdateType": "Mutable" }, "Values": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Values`\n\nThe specific value of the tag.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-tagvalues.html#cfn-budgets-budget-tagvalues-values", "UpdateType": "Mutable" }, "Key": { "Required": false, "MarkdownDocumentation": "`Key`\n\nThe key for the tag.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\S\\s]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-tagvalues.html#cfn-budgets-budget-tagvalues-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::Budget.TimePeriod": { "MarkdownDocumentation": "`AWS::Budgets::Budget.TimePeriod`\n\nThe period of time that is covered by a budget. The period has a start date and an end\ndate. The start date must come before the end date. There are no restrictions on the end date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html", "Properties": { "Start": { "Required": false, "MarkdownDocumentation": "`Start`\n\nThe start date for a budget. If you created your budget and didn't specify a start\ndate, the start date defaults to the start of the chosen time period (MONTHLY, QUARTERLY, or\nANNUALLY). For example, if you create your budget on January 24, 2019, choose\n`MONTHLY`, and don't set a start date, the start date defaults to\n`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.\nValid values depend on the value of `BudgetType`:\n* If `BudgetType` is `COST` or `USAGE`: Valid values are\n `MONTHLY`, `QUARTERLY`, and `ANNUALLY`.\n* If `BudgetType` is `RI_UTILIZATION` or `RI_COVERAGE`: Valid values are\n `DAILY`, `MONTHLY`, `QUARTERLY`, and `ANNUALLY`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-start", "PrimitiveType": "String", "UpdateType": "Mutable" }, "End": { "Required": false, "MarkdownDocumentation": "`End`\n\nThe end date for a budget. If you didn't specify an end date, AWS set\nyour end date to `06/15/87 00:00 UTC`. The defaults are the same for the\nAWS Billing and Cost Management console and the API.\nAfter the end date, AWS deletes the budget and all the associated\nnotifications and subscribers. You can change your end date with the\n`UpdateBudget` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-end", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Budgets::BudgetsAction.ActionThreshold": { "MarkdownDocumentation": "`AWS::Budgets::BudgetsAction.ActionThreshold`\n\nThe trigger threshold of the action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-actionthreshold.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of threshold for a notification.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PERCENTAGE | ABSOLUTE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PERCENTAGE", "ABSOLUTE_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-actionthreshold.html#cfn-budgets-budgetsaction-actionthreshold-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe threshold of a notification.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-actionthreshold.html#cfn-budgets-budgetsaction-actionthreshold-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::Budgets::BudgetsAction.Definition": { "MarkdownDocumentation": "`AWS::Budgets::BudgetsAction.Definition`\n\nThe definition is where you specify all of the type-specific parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html", "Properties": { "SsmActionDefinition": { "MarkdownDocumentation": "`SsmActionDefinition`\n\nThe Amazon EC2 Systems Manager (SSM) action definition details.\n*Required*: No\n*Type*: [SsmActionDefinition](./aws-properties-budgets-budgetsaction-ssmactiondefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html#cfn-budgets-budgetsaction-definition-ssmactiondefinition", "UpdateType": "Mutable", "Required": false, "Type": "SsmActionDefinition" }, "IamActionDefinition": { "MarkdownDocumentation": "`IamActionDefinition`\n\nThe AWS Identity and Access Management (IAM) action definition details.\n*Required*: No\n*Type*: [IamActionDefinition](./aws-properties-budgets-budgetsaction-iamactiondefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html#cfn-budgets-budgetsaction-definition-iamactiondefinition", "UpdateType": "Mutable", "Required": false, "Type": "IamActionDefinition" }, "ScpActionDefinition": { "MarkdownDocumentation": "`ScpActionDefinition`\n\nThe service control policies (SCP) action definition details.\n*Required*: No\n*Type*: [ScpActionDefinition](./aws-properties-budgets-budgetsaction-scpactiondefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-definition.html#cfn-budgets-budgetsaction-definition-scpactiondefinition", "UpdateType": "Mutable", "Required": false, "Type": "ScpActionDefinition" } } }, "AWS::Budgets::BudgetsAction.IamActionDefinition": { "MarkdownDocumentation": "`AWS::Budgets::BudgetsAction.IamActionDefinition`\n\nThe AWS Identity and Access Management (IAM) action definition details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html", "Properties": { "PolicyArn": { "MarkdownDocumentation": "`PolicyArn`\n\nThe Amazon Resource Name (ARN) of the policy to be attached.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-cn|-us-gov|-iso|-iso-[a-z]{1})?:iam::(\\d{12}|aws):policy(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$`\n*Minimum*: `25`\n*Maximum*: `684`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-policyarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nA list of groups to be attached. There must be at least one group.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Roles": { "MarkdownDocumentation": "`Roles`\n\nA list of roles to be attached. There must be at least one role.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-roles", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Users": { "MarkdownDocumentation": "`Users`\n\nA list of users to be attached. There must be at least one user.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-iamactiondefinition.html#cfn-budgets-budgetsaction-iamactiondefinition-users", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Budgets::BudgetsAction.ResourceTag": { "MarkdownDocumentation": "`AWS::Budgets::BudgetsAction.ResourceTag`\n\nThe tag structure that contains a tag key and value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-resourcetag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value that's associated with the tag.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-resourcetag.html#cfn-budgets-budgetsaction-resourcetag-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key that's associated with the tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-resourcetag.html#cfn-budgets-budgetsaction-resourcetag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Budgets::BudgetsAction.ScpActionDefinition": { "MarkdownDocumentation": "`AWS::Budgets::BudgetsAction.ScpActionDefinition`\n\nThe service control policies (SCP) action definition details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html", "Properties": { "TargetIds": { "MarkdownDocumentation": "`TargetIds`\n\nA list of target IDs.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html#cfn-budgets-budgetsaction-scpactiondefinition-targetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PolicyId": { "MarkdownDocumentation": "`PolicyId`\n\nThe policy ID attached.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^p-[0-9a-zA-Z_]{8,128}$`\n*Minimum*: `10`\n*Maximum*: `130`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-scpactiondefinition.html#cfn-budgets-budgetsaction-scpactiondefinition-policyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Budgets::BudgetsAction.SsmActionDefinition": { "MarkdownDocumentation": "`AWS::Budgets::BudgetsAction.SsmActionDefinition`\n\nThe Amazon EC2 Systems Manager (SSM) action definition details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html", "Properties": { "Region": { "MarkdownDocumentation": "`Region`\n\nThe Region to run the (SSM) document.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\w{2}-\\w+(-\\w+)?-\\d$`\n*Minimum*: `9`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InstanceIds": { "MarkdownDocumentation": "`InstanceIds`\n\nThe EC2 and RDS instance IDs.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-instanceids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subtype": { "MarkdownDocumentation": "`Subtype`\n\nThe action subType.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STOP_EC2_INSTANCES | STOP_R...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-ssmactiondefinition.html#cfn-budgets-budgetsaction-ssmactiondefinition-subtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Budgets::BudgetsAction.Subscriber": { "MarkdownDocumentation": "`AWS::Budgets::BudgetsAction.Subscriber`\n\nThe subscriber to a budget notification. The subscriber consists of a subscription\ntype and either an Amazon SNS topic or an email address.\nFor example, an email subscriber has the following parameters:\n* A `subscriptionType` of `EMAIL`\n* An `address` of `example@example.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of notification that AWS sends to a subscriber.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SNS | EMAIL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SNS", "EMAIL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html#cfn-budgets-budgetsaction-subscriber-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Address": { "MarkdownDocumentation": "`Address`\n\nThe address that AWS sends budget notifications to, either an SNS topic\nor an email.\nWhen you create a subscriber, the value of `Address` can't contain line\nbreaks.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budgetsaction-subscriber.html#cfn-budgets-budgetsaction-subscriber-address", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CE::AnomalyMonitor.ResourceTag": { "MarkdownDocumentation": "`AWS::CE::AnomalyMonitor.ResourceTag`\n\nThe tag structure that contains a tag key and value.\n###### Note\nTagging is supported only for the following Cost Explorer resource types:\n[`AnomalyMonitor`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html), [`AnomalySubscription`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html), [`CostCategory`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalymonitor-resourcetag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value that's associated with the tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalymonitor-resourcetag.html#cfn-ce-anomalymonitor-resourcetag-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key that's associated with the tag.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!aws:).*$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalymonitor-resourcetag.html#cfn-ce-anomalymonitor-resourcetag-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CE::AnomalySubscription.ResourceTag": { "MarkdownDocumentation": "`AWS::CE::AnomalySubscription.ResourceTag`\n\nThe tag structure that contains a tag key and value.\n###### Note\nTagging is supported only for the following Cost Explorer resource types:\n[`AnomalyMonitor`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html), [`AnomalySubscription`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html), [`CostCategory`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-resourcetag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value that's associated with the tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-resourcetag.html#cfn-ce-anomalysubscription-resourcetag-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key that's associated with the tag.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!aws:).*$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-resourcetag.html#cfn-ce-anomalysubscription-resourcetag-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CE::AnomalySubscription.Subscriber": { "MarkdownDocumentation": "`AWS::CE::AnomalySubscription.Subscriber`\n\nThe recipient of `AnomalySubscription` notifications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-subscriber.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nIndicates if the subscriber accepts the notifications.\n*Required*: No\n*Type*: String\n*Allowed values*: `CONFIRMED | DECLINED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONFIRMED", "DECLINED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-subscriber.html#cfn-ce-anomalysubscription-subscriber-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe notification delivery channel.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EMAIL | SNS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EMAIL", "SNS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-subscriber.html#cfn-ce-anomalysubscription-subscriber-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Address": { "MarkdownDocumentation": "`Address`\n\nThe email address or SNS Topic Amazon Resource Name (ARN), depending on the\n`Type`.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-subscriber.html#cfn-ce-anomalysubscription-subscriber-address", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CE::CostCategory.ResourceTag": { "MarkdownDocumentation": "`AWS::CE::CostCategory.ResourceTag`\n\nThe tag structure that contains a tag key and value.\n###### Note\nTagging is supported only for the following Cost Explorer resource types:\n[`AnomalyMonitor`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html), [`AnomalySubscription`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html), [`CostCategory`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-costcategory-resourcetag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value that's associated with the tag.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-costcategory-resourcetag.html#cfn-ce-costcategory-resourcetag-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key that's associated with the tag.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!aws:).*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-costcategory-resourcetag.html#cfn-ce-costcategory-resourcetag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cassandra::Keyspace.ReplicationSpecification": { "MarkdownDocumentation": "`AWS::Cassandra::Keyspace.ReplicationSpecification`\n\nYou can use `ReplicationSpecification`\nto configure the `ReplicationStrategy` of a keyspace in Amazon Keyspaces.\nThe `ReplicationSpecification` property applies automatically to all tables in the keyspace.\nTo review the permissions that are required to add a new Region to a single-Region keyspace,\nsee [Configure the IAM permissions required\nto add an AWS Region to a keyspace](https://docs.aws.amazon.com/keyspaces/latest/devguide/howitworks_replication_permissions_addReplica.html)\nin the *Amazon Keyspaces Developer Guide*.\nFor more information about multi-Region replication, see [Multi-Region replication](https://docs.aws.amazon.com/keyspaces/latest/devguide/multiRegion-replication.html)\nin the *Amazon Keyspaces Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-keyspace-replicationspecification.html", "Properties": { "ReplicationStrategy": { "MarkdownDocumentation": "`ReplicationStrategy`\n\nThe options are:\n* `SINGLE_REGION` (optional)\n* `MULTI_REGION`\nIf no value is specified, the default is `SINGLE_REGION`. If `MULTI_REGION` is specified, `RegionList` is required.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_REGION | MULTI_REGIO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_REGION", "MULTI_REGION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-keyspace-replicationspecification.html#cfn-cassandra-keyspace-replicationspecification-replicationstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RegionList": { "MarkdownDocumentation": "`RegionList`\n\nSpecifies the AWS Regions that the\nkeyspace is replicated in.\nYou must specify at least two Regions, including the Region that the keyspace is being created in.\nTo specify a Region [that's disabled by\ndefault](https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#rande-manage-enable), you must first enable the Region. For more information, see\n[Multi-Region replication in\nAWS Regions disabled by default](https://docs.aws.amazon.com/keyspaces/latest/devguide/multiRegion-replication_how-it-works.html#howitworks_mrr_opt_in) in the *Amazon Keyspaces Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `af-south-1 | ap-east-1 | ap...`\n*Minimum*: `2`\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)", "RefReturnValue": "", "AllowedValues": [ "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-keyspace-replicationspecification.html#cfn-cassandra-keyspace-replicationspecification-regionlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Cassandra::Table.AutoScalingSetting": { "MarkdownDocumentation": "`AWS::Cassandra::Table.AutoScalingSetting`\n\nThe optional auto scaling settings for a table with provisioned throughput capacity.\nTo turn on auto scaling for a table in `throughputMode:PROVISIONED`,\nyou must specify the following parameters.\nConfigure the minimum and maximum capacity units. The auto scaling policy ensures that capacity never goes below the\nminimum or above the maximum range.\n* `minimumUnits`: The minimum level of throughput the table should always be ready to support. The value must be between 1\n and the max throughput per second quota for your account (40,000 by default).\n* `maximumUnits`: The maximum level of throughput the table should always be ready to\n support. The value must be between 1 and the max throughput per second quota for your\n account (40,000 by default).\n* `scalingPolicy`: Amazon Keyspaces supports the `target tracking` scaling policy.\n The auto scaling target is a percentage of the provisioned capacity of the table.\nFor more information, see [Managing throughput capacity automatically with Amazon Keyspaces auto scaling](https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html) in the *Amazon Keyspaces Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html", "Properties": { "MaximumUnits": { "MarkdownDocumentation": "`MaximumUnits`\n\nManage costs by specifying the maximum amount of throughput to provision. The value must be between 1\nand the max throughput per second quota for your account (40,000 by default).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-maximumunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ScalingPolicy": { "MarkdownDocumentation": "`ScalingPolicy`\n\nAmazon Keyspaces supports the `target tracking` auto scaling policy. With this policy, Amazon Keyspaces auto scaling\nensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You\ndefine the target value as a percentage between 20 and 90.\n*Required*: No\n*Type*: [ScalingPolicy](./aws-properties-cassandra-table-scalingpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-scalingpolicy", "UpdateType": "Mutable", "Required": false, "Type": "ScalingPolicy" }, "MinimumUnits": { "MarkdownDocumentation": "`MinimumUnits`\n\nThe minimum level of throughput the table should always be ready to support. The value must be between 1\nand the max throughput per second quota for your account (40,000 by default).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-minimumunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AutoScalingDisabled": { "MarkdownDocumentation": "`AutoScalingDisabled`\n\nThis optional parameter enables auto scaling for the table if set 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-autoscalingdisabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Cassandra::Table.AutoScalingSpecification": { "MarkdownDocumentation": "`AWS::Cassandra::Table.AutoScalingSpecification`\n\nThe optional auto scaling capacity settings for a table in provisioned capacity mode.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingspecification.html", "Properties": { "ReadCapacityAutoScaling": { "MarkdownDocumentation": "`ReadCapacityAutoScaling`\n\nThe auto scaling settings for the table's read capacity.\n*Required*: No\n*Type*: [AutoScalingSetting](./aws-properties-cassandra-table-autoscalingsetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingspecification.html#cfn-cassandra-table-autoscalingspecification-readcapacityautoscaling", "UpdateType": "Mutable", "Required": false, "Type": "AutoScalingSetting" }, "WriteCapacityAutoScaling": { "MarkdownDocumentation": "`WriteCapacityAutoScaling`\n\nThe auto scaling settings for the table's write capacity.\n*Required*: No\n*Type*: [AutoScalingSetting](./aws-properties-cassandra-table-autoscalingsetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingspecification.html#cfn-cassandra-table-autoscalingspecification-writecapacityautoscaling", "UpdateType": "Mutable", "Required": false, "Type": "AutoScalingSetting" } } }, "AWS::Cassandra::Table.BillingMode": { "MarkdownDocumentation": "`AWS::Cassandra::Table.BillingMode`\n\nDetermines the billing mode for the table - on-demand or provisioned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-billingmode.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe billing mode for the table:\n* On-demand mode - `ON_DEMAND`\n* Provisioned mode - `PROVISIONED`\n \n ###### Note\n \n If you choose `PROVISIONED` mode, then you also need to specify\n provisioned throughput (read and write capacity) for the table.\nValid values: `ON_DEMAND` | `PROVISIONED`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PROVISIONED | ON_DEMAND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROVISIONED", "ON_DEMAND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-billingmode.html#cfn-cassandra-table-billingmode-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProvisionedThroughput": { "MarkdownDocumentation": "`ProvisionedThroughput`\n\nThe provisioned read capacity and write capacity for the table. For more information,\nsee [Provisioned throughput capacity mode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html#ReadWriteCapacityMode.Provisioned)\nin the *Amazon Keyspaces Developer Guide*.\n*Required*: No\n*Type*: [ProvisionedThroughput](./aws-properties-cassandra-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-billingmode.html#cfn-cassandra-table-billingmode-provisionedthroughput", "UpdateType": "Mutable", "Required": false, "Type": "ProvisionedThroughput" } } }, "AWS::Cassandra::Table.CdcSpecification": { "MarkdownDocumentation": "`AWS::Cassandra::Table.CdcSpecification`\n\nThe settings for the CDC stream of a table. For more information about CDC streams, see [Working with change data capture (CDC) streams in Amazon Keyspaces](https://docs.aws.amazon.com/keyspaces/latest/devguide/cdc.html) in the *Amazon Keyspaces Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-cdcspecification.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the CDC stream. You can enable or disable a stream for a table.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-cdcspecification.html#cfn-cassandra-table-cdcspecification-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ViewType": { "MarkdownDocumentation": "`ViewType`\n\nThe view type specifies the changes Amazon Keyspaces records for each changed row in the stream.\nAfter you create the stream, you can't make changes to this selection.\nThe options are:\n* `NEW_AND_OLD_IMAGES` - both versions of the row, before and after the change. This is the default.\n* `NEW_IMAGE` - the version of the row after the change.\n* `OLD_IMAGE` - the version of the row before the change.\n* `KEYS_ONLY` - the partition and clustering keys of the row that was changed.\n*Required*: No\n*Type*: String\n*Allowed values*: `NEW_IMAGE | OLD_IMAGE | KEY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_IMAGE", "OLD_IMAGE", "KEYS_ONLY", "NEW_AND_OLD_IMAGES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-cdcspecification.html#cfn-cassandra-table-cdcspecification-viewtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags (key-value pairs) that you want to apply to the stream.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cassandra-table-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-cdcspecification.html#cfn-cassandra-table-cdcspecification-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } } }, "AWS::Cassandra::Table.ClusteringKeyColumn": { "MarkdownDocumentation": "`AWS::Cassandra::Table.ClusteringKeyColumn`\n\nDefines an individual column within the clustering key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-clusteringkeycolumn.html", "Properties": { "OrderBy": { "MarkdownDocumentation": "`OrderBy`\n\nThe order in which this column's data is stored:\n* `ASC` (default) - The column's data is stored in ascending\n order.\n* `DESC` - The column's data is stored in descending order.\n*Required*: No\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-clusteringkeycolumn.html#cfn-cassandra-table-clusteringkeycolumn-orderby", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe name and data type of this clustering key column.\n*Required*: Yes\n*Type*: [Column](./aws-properties-cassandra-table-column.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-clusteringkeycolumn.html#cfn-cassandra-table-clusteringkeycolumn-column", "UpdateType": "Immutable", "Required": true, "Type": "Column" } } }, "AWS::Cassandra::Table.Column": { "MarkdownDocumentation": "`AWS::Cassandra::Table.Column`\n\nThe name and data type of an individual column in a table. In addition to the data type, you can also use the\nfollowing two keywords:\n* `STATIC` if the table has a clustering column. Static columns store values that are\n shared by all rows in the same partition.\n* `FROZEN` for collection data types. In frozen collections the values of the collection\n are serialized into a single immutable value, and Amazon Keyspaces treats them like a `BLOB`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-column.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe 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\n*Amazon Keyspaces Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-column.html#cfn-cassandra-table-column-columnname", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "ColumnType": { "MarkdownDocumentation": "`ColumnType`\n\nThe 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)\nin the *Amazon Keyspaces 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-column.html#cfn-cassandra-table-column-columntype", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cassandra::Table.EncryptionSpecification": { "MarkdownDocumentation": "`AWS::Cassandra::Table.EncryptionSpecification`\n\nSpecifies the encryption at rest option selected for the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-encryptionspecification.html", "Properties": { "EncryptionType": { "MarkdownDocumentation": "`EncryptionType`\n\nThe 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 \n ###### Important\n \n If you choose `CUSTOMER_MANAGED_KMS_KEY`, a `kms_key_identifier` in the format of a\n key ARN is required.\nValid values: `CUSTOMER_MANAGED_KMS_KEY` | `AWS_OWNED_KMS_KEY`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS_OWNED_KMS_KEY | CUSTOME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-encryptionspecification.html#cfn-cassandra-table-encryptionspecification-encryptiontype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyIdentifier": { "MarkdownDocumentation": "`KmsKeyIdentifier`\n\nRequires a `kms_key_identifier` in the format of a\nkey 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-encryptionspecification.html#cfn-cassandra-table-encryptionspecification-kmskeyidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cassandra::Table.ProvisionedThroughput": { "MarkdownDocumentation": "`AWS::Cassandra::Table.ProvisionedThroughput`\n\nThe provisioned throughput for the table, which consists of\n`ReadCapacityUnits` and `WriteCapacityUnits`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-provisionedthroughput.html", "Properties": { "WriteCapacityUnits": { "MarkdownDocumentation": "`WriteCapacityUnits`\n\nThe amount of write capacity that's provisioned for the table. For more information,\nsee [Read/write capacity\nmode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the *Amazon Keyspaces Developer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-provisionedthroughput.html#cfn-cassandra-table-provisionedthroughput-writecapacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ReadCapacityUnits": { "MarkdownDocumentation": "`ReadCapacityUnits`\n\nThe amount of read capacity that's provisioned for the table. For more information,\nsee [Read/write capacity\nmode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the *Amazon Keyspaces Developer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-provisionedthroughput.html#cfn-cassandra-table-provisionedthroughput-readcapacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Cassandra::Table.ReplicaSpecification": { "MarkdownDocumentation": "`AWS::Cassandra::Table.ReplicaSpecification`\n\nThe AWS Region specific settings of a multi-Region table.\nFor a multi-Region table, you can configure the table's read capacity differently per AWS Region. You can do this by configuring the following parameters.\n* `region`: The Region where these settings are applied. (Required)\n* `readCapacityUnits`: The provisioned read capacity units. (Optional)\n* `readCapacityAutoScaling`: The read capacity auto scaling settings for the table. (Optional)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-replicaspecification.html", "Properties": { "ReadCapacityUnits": { "MarkdownDocumentation": "`ReadCapacityUnits`\n\nThe provisioned read capacity units for the multi-Region table in the specified AWS Region.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-replicaspecification.html#cfn-cassandra-table-replicaspecification-readcapacityunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe AWS Region.\n*Required*: Yes\n*Type*: String\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-replicaspecification.html#cfn-cassandra-table-replicaspecification-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ReadCapacityAutoScaling": { "MarkdownDocumentation": "`ReadCapacityAutoScaling`\n\nThe read capacity auto scaling settings for the multi-Region\ntable in the specified AWS Region.\n*Required*: No\n*Type*: [AutoScalingSetting](./aws-properties-cassandra-table-autoscalingsetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-replicaspecification.html#cfn-cassandra-table-replicaspecification-readcapacityautoscaling", "UpdateType": "Mutable", "Required": false, "Type": "AutoScalingSetting" } } }, "AWS::Cassandra::Table.ScalingPolicy": { "MarkdownDocumentation": "`AWS::Cassandra::Table.ScalingPolicy`\n\nAmazon Keyspaces supports the `target tracking` auto scaling policy. With this policy, Amazon Keyspaces auto scaling\nensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You\ndefine the target value as a percentage between 20 and 90.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-scalingpolicy.html", "Properties": { "TargetTrackingScalingPolicyConfiguration": { "MarkdownDocumentation": "`TargetTrackingScalingPolicyConfiguration`\n\nThe auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.\n*Required*: No\n*Type*: [TargetTrackingScalingPolicyConfiguration](./aws-properties-cassandra-table-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-scalingpolicy.html#cfn-cassandra-table-scalingpolicy-targettrackingscalingpolicyconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TargetTrackingScalingPolicyConfiguration" } } }, "AWS::Cassandra::Table.TargetTrackingScalingPolicyConfiguration": { "MarkdownDocumentation": "`AWS::Cassandra::Table.TargetTrackingScalingPolicyConfiguration`\n\nAmazon Keyspaces supports the `target tracking` auto scaling policy for a provisioned table. This policy\nscales a table based on the ratio of consumed to provisioned capacity.\nThe auto scaling target is a percentage of the provisioned capacity of the table.\n* `targetTrackingScalingPolicyConfiguration`: To define the target tracking policy, you must define the target value.\n \n + `targetValue`: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of\n consumed capacity to provisioned capacity stays at or near this value. You\n define `targetValue` as a percentage. A `double` between 20 and 90. (Required)\n + `disableScaleIn`: A `boolean` that specifies if `scale-in` is\n disabled or enabled for the table. This parameter is disabled by default.\n To turn on `scale-in`, set the `boolean` value to\n `FALSE`. This means that capacity for a table can be\n automatically scaled down on your behalf. (Optional)\n + `scaleInCooldown`: A cooldown period in seconds between scaling activities that lets the table stabilize\n before another scale in activity starts. If no value is provided, the default is 0. (Optional)\n + `scaleOutCooldown`: A cooldown period in seconds between scaling activities that lets the table stabilize\n before another scale out activity starts. If no value is provided, the default is 0. (Optional)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html", "Properties": { "ScaleOutCooldown": { "MarkdownDocumentation": "`ScaleOutCooldown`\n\nSpecifies a scale out cool down period.\nA cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html#cfn-cassandra-table-targettrackingscalingpolicyconfiguration-scaleoutcooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nSpecifies the target value for the target tracking auto scaling policy.\nAmazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization\nrate, and then back down when it falls below the target. This ensures that the ratio of\nconsumed capacity to provisioned capacity stays at or near this value. You\ndefine `targetValue` as a percentage. An `integer` between 20 and 90.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html#cfn-cassandra-table-targettrackingscalingpolicyconfiguration-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DisableScaleIn": { "MarkdownDocumentation": "`DisableScaleIn`\n\nSpecifies if `scale-in` is enabled.\nWhen auto scaling automatically decreases capacity for a table,\nthe table *scales in*. When scaling policies are set, they can't\nscale in the table lower than its minimum capacity.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html#cfn-cassandra-table-targettrackingscalingpolicyconfiguration-disablescalein", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ScaleInCooldown": { "MarkdownDocumentation": "`ScaleInCooldown`\n\nSpecifies a `scale-in` cool down period.\nA cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-targettrackingscalingpolicyconfiguration.html#cfn-cassandra-table-targettrackingscalingpolicyconfiguration-scaleincooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Cassandra::Table.WarmThroughput": { "MarkdownDocumentation": "`AWS::Cassandra::Table.WarmThroughput`\n\nThe `WarmThroughput` property type specifies Property description not available. for an [AWS::Cassandra::Table](./aws-resource-cassandra-table.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-warmthroughput.html", "Properties": { "ReadUnitsPerSecond": { "MarkdownDocumentation": "`ReadUnitsPerSecond`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-warmthroughput.html#cfn-cassandra-table-warmthroughput-readunitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "WriteUnitsPerSecond": { "MarkdownDocumentation": "`WriteUnitsPerSecond`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-warmthroughput.html#cfn-cassandra-table-warmthroughput-writeunitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Cassandra::Type.Field": { "MarkdownDocumentation": "`AWS::Cassandra::Type.Field`\n\nThe name and data type of an individual field in a user-defined type (UDT).\nIn addition to a Cassandra data type, you can also use another UDT. When you nest another UDT or collection data type, you have to\ndeclare them with the `FROZEN` keyword.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-type-field.html", "Properties": { "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the field.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-type-field.html#cfn-cassandra-type-field-fieldname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FieldType": { "MarkdownDocumentation": "`FieldType`\n\nThe data type of the field. This can be any Cassandra data type or another user-defined 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-type-field.html#cfn-cassandra-type-field-fieldtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CertificateManager::Account.ExpiryEventsConfiguration": { "MarkdownDocumentation": "`AWS::CertificateManager::Account.ExpiryEventsConfiguration`\n\nObject containing expiration events options associated with an AWS account. For more information, see [ExpiryEventsConfiguration](https://docs.aws.amazon.com/acm/latest/APIReference/API_ExpiryEventsConfiguration.html) in the API reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-account-expiryeventsconfiguration.html", "Properties": { "DaysBeforeExpiry": { "MarkdownDocumentation": "`DaysBeforeExpiry`\n\nThis option specifies the number of days prior to certificate expiration when ACM\nstarts generating `EventBridge` events. ACM sends one event per day per\ncertificate until the certificate expires. By default, accounts receive events starting\n45 days before certificate expiration.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-account-expiryeventsconfiguration.html#cfn-certificatemanager-account-expiryeventsconfiguration-daysbeforeexpiry", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::CertificateManager::Certificate.DomainValidationOption": { "MarkdownDocumentation": "`AWS::CertificateManager::Certificate.DomainValidationOption`\n\n`DomainValidationOption` is a property of the [AWS::CertificateManager::Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html) resource that specifies the AWS Certificate Manager (ACM) certificate domain to validate. Depending on\nthe chosen validation method, ACM checks the domain's DNS record for a validation CNAME,\nor it attempts to send a validation email message to the domain owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html", "Properties": { "DomainName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoptions-domainname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nThe `HostedZoneId` option, which is available if you are using Route 53 as\nyour domain registrar, causes ACM to add your CNAME to the domain record. Your list of\n`DomainValidationOptions` must contain one and only one of the\ndomain-validation options, and the `HostedZoneId` can be used only when\n`DNS` is specified as your validation method.\nUse the Route 53 `ListHostedZones` API to discover IDs for available hosted\nzones.\nThis option is required for publicly trusted certificates.\n###### Note\nThe `ListHostedZones` API returns IDs in the format\n\"/hostedzone/Z111111QQQQQQQ\", but CloudFormation requires the IDs to be in the\nformat \"Z111111QQQQQQQ\".\nWhen you change your `DomainValidationOptions`, a new resource is\ncreated.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-hostedzoneid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ValidationDomain": { "MarkdownDocumentation": "`ValidationDomain`\n\nThe domain name to which you want ACM to send validation emails. This domain name is\nthe suffix of the email addresses that you want ACM to use. This must be the same as the\n`DomainName` value or a superdomain of the `DomainName` value.\nFor example, if you request a certificate for `testing.example.com`, you can\nspecify `example.com` as this value. In that case, ACM sends domain\nvalidation emails to the following five addresses:\n* admin@example.com\n* administrator@example.com\n* hostmaster@example.com\n* postmaster@example.com\n* webmaster@example.com\n*Required*: No\n*Type*: String\n*Pattern*: `(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])`\n*Minimum*: `1`\n*Maximum*: `253`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-validationdomain", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Chatbot::CustomAction.CustomActionAttachment": { "MarkdownDocumentation": "`AWS::Chatbot::CustomAction.CustomActionAttachment`\n\n###### Note\nAWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)\n`Type` attribute values remain unchanged.\nDefines when a custom action button should be attached to a notification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html", "Properties": { "Variables": { "MarkdownDocumentation": "`Variables`\n\nThe variables to extract from the notification.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html#cfn-chatbot-customaction-customactionattachment-variables", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "NotificationType": { "MarkdownDocumentation": "`NotificationType`\n\nThe type of notification that the custom action should be attached to.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html#cfn-chatbot-customaction-customactionattachment-notificationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Criteria": { "MarkdownDocumentation": "`Criteria`\n\nThe criteria for when a button should be shown based on values in the notification.\n*Required*: No\n*Type*: Array of [CustomActionAttachmentCriteria](./aws-properties-chatbot-customaction-customactionattachmentcriteria.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html#cfn-chatbot-customaction-customactionattachment-criteria", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomActionAttachmentCriteria", "DuplicatesAllowed": true }, "ButtonText": { "MarkdownDocumentation": "`ButtonText`\n\nThe text of the button that appears on the notification.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S\\s]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html#cfn-chatbot-customaction-customactionattachment-buttontext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Chatbot::CustomAction.CustomActionAttachmentCriteria": { "MarkdownDocumentation": "`AWS::Chatbot::CustomAction.CustomActionAttachmentCriteria`\n\n###### Note\nAWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)\n`Type` attribute values remain unchanged.\nA criteria for when a button should be shown based on values in the notification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachmentcriteria.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe operation to perform on the named variable.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HAS_VALUE | EQUALS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HAS_VALUE", "EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachmentcriteria.html#cfn-chatbot-customaction-customactionattachmentcriteria-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VariableName": { "MarkdownDocumentation": "`VariableName`\n\nThe name of the variable to operate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachmentcriteria.html#cfn-chatbot-customaction-customactionattachmentcriteria-variablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA value that is compared with the actual value of the variable based on the behavior of the operator.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachmentcriteria.html#cfn-chatbot-customaction-customactionattachmentcriteria-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Chatbot::CustomAction.CustomActionDefinition": { "MarkdownDocumentation": "`AWS::Chatbot::CustomAction.CustomActionDefinition`\n\n###### Note\nAWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)\n`Type` attribute values remain unchanged.\nThe definition of the command to run when invoked as an alias or as an action button.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactiondefinition.html", "Properties": { "CommandText": { "MarkdownDocumentation": "`CommandText`\n\nThe command string to run which may include variables by prefixing with a dollar sign ($).\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactiondefinition.html#cfn-chatbot-customaction-customactiondefinition-commandtext", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::AnalysisTemplate.AnalysisParameter": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.AnalysisParameter`\n\nOptional. The member who can query can provide this placeholder for a literal data value\nin an analysis template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nOptional. The default value that is applied in the analysis template. The member who can\nquery can override this value in the query editor.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `250`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-defaultvalue", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SMALLINT | INTEGER | BIGINT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter. The name must use only alphanumeric, underscore (\\_), or\nhyphen (-) characters but cannot start or end with a hyphen.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-zA-Z_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::AnalysisTemplate.AnalysisSchema": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.AnalysisSchema`\n\nA relation within an analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisschema.html", "Properties": { "ReferencedTables": { "MarkdownDocumentation": "`ReferencedTables`\n\nThe tables referenced in the analysis schema.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisschema.html#cfn-cleanrooms-analysistemplate-analysisschema-referencedtables", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::AnalysisTemplate.AnalysisSource": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.AnalysisSource`\n\nThe structure that defines the body of the analysis template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html", "Properties": { "Artifacts": { "MarkdownDocumentation": "`Artifacts`\n\nThe artifacts of the analysis source.\n*Required*: No\n*Type*: [AnalysisTemplateArtifacts](./aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html#cfn-cleanrooms-analysistemplate-analysissource-artifacts", "UpdateType": "Immutable", "Required": false, "Type": "AnalysisTemplateArtifacts" }, "Text": { "MarkdownDocumentation": "`Text`\n\nThe query text.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `90000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html#cfn-cleanrooms-analysistemplate-analysissource-text", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CleanRooms::AnalysisTemplate.AnalysisSourceMetadata": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.AnalysisSourceMetadata`\n\nThe analysis source metadata.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissourcemetadata.html", "Properties": { "Artifacts": { "MarkdownDocumentation": "`Artifacts`\n\nThe artifacts of the analysis source metadata.\n*Required*: Yes\n*Type*: [AnalysisTemplateArtifactMetadata](./aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissourcemetadata.html#cfn-cleanrooms-analysistemplate-analysissourcemetadata-artifacts", "UpdateType": "Mutable", "Required": true, "Type": "AnalysisTemplateArtifactMetadata" } } }, "AWS::CleanRooms::AnalysisTemplate.AnalysisTemplateArtifact": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.AnalysisTemplateArtifact`\n\nThe analysis template artifact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.html", "Properties": { "Location": { "MarkdownDocumentation": "`Location`\n\nThe artifact location.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-cleanrooms-analysistemplate-s3location.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.html#cfn-cleanrooms-analysistemplate-analysistemplateartifact-location", "UpdateType": "Immutable", "Required": true, "Type": "S3Location" } } }, "AWS::CleanRooms::AnalysisTemplate.AnalysisTemplateArtifactMetadata": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.AnalysisTemplateArtifactMetadata`\n\nThe analysis template artifact metadata.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html", "Properties": { "EntryPointHash": { "MarkdownDocumentation": "`EntryPointHash`\n\nThe hash of the entry point for the analysis template artifact metadata.\n*Required*: Yes\n*Type*: [Hash](./aws-properties-cleanrooms-analysistemplate-hash.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-entrypointhash", "UpdateType": "Mutable", "Required": true, "Type": "Hash" }, "AdditionalArtifactHashes": { "MarkdownDocumentation": "`AdditionalArtifactHashes`\n\nAdditional artifact hashes for the analysis template.\n*Required*: No\n*Type*: Array of [Hash](./aws-properties-cleanrooms-analysistemplate-hash.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-additionalartifacthashes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Hash", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::AnalysisTemplate.AnalysisTemplateArtifacts": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.AnalysisTemplateArtifacts`\n\nThe analysis template artifacts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html", "Properties": { "AdditionalArtifacts": { "MarkdownDocumentation": "`AdditionalArtifacts`\n\nAdditional artifacts for the analysis template.\n*Required*: No\n*Type*: Array of [AnalysisTemplateArtifact](./aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.html)\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-additionalartifacts", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AnalysisTemplateArtifact", "DuplicatesAllowed": true }, "EntryPoint": { "MarkdownDocumentation": "`EntryPoint`\n\nThe entry point for the analysis template artifacts.\n*Required*: Yes\n*Type*: [AnalysisTemplateArtifact](./aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-entrypoint", "UpdateType": "Immutable", "Required": true, "Type": "AnalysisTemplateArtifact" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe role ARN for the analysis template artifacts.\n*Required*: Yes\n*Type*: String\n*Minimum*: `32`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::AnalysisTemplate.ColumnClassificationDetails": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.ColumnClassificationDetails`\n\nContains classification information for data columns, including mappings that specify how columns should be handled during synthetic data generation and privacy analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-columnclassificationdetails.html", "Properties": { "ColumnMapping": { "MarkdownDocumentation": "`ColumnMapping`\n\nA mapping that defines the classification of data columns for synthetic data generation and specifies how each column should be handled during the privacy-preserving data synthesis process.\n*Required*: Yes\n*Type*: Array of [SyntheticDataColumnProperties](./aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html)\n*Minimum*: `5`\n*Maximum*: `1000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-columnclassificationdetails.html#cfn-cleanrooms-analysistemplate-columnclassificationdetails-columnmapping", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "SyntheticDataColumnProperties", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::AnalysisTemplate.ErrorMessageConfiguration": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.ErrorMessageConfiguration`\n\nA structure that defines the level of detail included in error messages returned by PySpark jobs. This configuration allows you to control the verbosity of error messages to help with troubleshooting PySpark jobs while maintaining appropriate security controls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-errormessageconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe level of detail for error messages returned by the PySpark job. When set to DETAILED, error messages include more information to help troubleshoot issues with your PySpark job.\nBecause this setting may expose sensitive data, it is recommended for development and testing environments.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DETAILED`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "DETAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-errormessageconfiguration.html#cfn-cleanrooms-analysistemplate-errormessageconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::AnalysisTemplate.Hash": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.Hash`\n\nHash\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-hash.html", "Properties": { "Sha256": { "MarkdownDocumentation": "`Sha256`\n\nThe SHA-256 hash 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-hash.html#cfn-cleanrooms-analysistemplate-hash-sha256", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CleanRooms::AnalysisTemplate.MLSyntheticDataParameters": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.MLSyntheticDataParameters`\n\nParameters that control the generation of synthetic data for machine learning, including\nprivacy settings and column classification details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html", "Properties": { "ColumnClassification": { "MarkdownDocumentation": "`ColumnClassification`\n\nClassification details for data columns that specify how each column should be treated during synthetic data generation.\n*Required*: Yes\n*Type*: [ColumnClassificationDetails](./aws-properties-cleanrooms-analysistemplate-columnclassificationdetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-columnclassification", "UpdateType": "Immutable", "Required": true, "Type": "ColumnClassificationDetails" }, "Epsilon": { "MarkdownDocumentation": "`Epsilon`\n\nThe epsilon value for differential privacy when generating synthetic data. Lower values provide stronger privacy guarantees but may reduce data utility.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-epsilon", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" }, "MaxMembershipInferenceAttackScore": { "MarkdownDocumentation": "`MaxMembershipInferenceAttackScore`\n\nThe maximum acceptable score for membership inference attack vulnerability. Synthetic data generation fails if the score for the resulting data exceeds this threshold.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-maxmembershipinferenceattackscore", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::CleanRooms::AnalysisTemplate.S3Location": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.S3Location`\n\nThe S3 location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe bucket name.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.html#cfn-cleanrooms-analysistemplate-s3location-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe object key.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9!_.*'()-/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.html#cfn-cleanrooms-analysistemplate-s3location-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::AnalysisTemplate.SyntheticDataColumnProperties": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.SyntheticDataColumnProperties`\n\nProperties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the data column as it appears in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9_](([a-z0-9_]+-)*([a-z0-9_]+))?$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columnname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ColumnType": { "MarkdownDocumentation": "`ColumnType`\n\nThe data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CATEGORICAL | NUMERICAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CATEGORICAL", "NUMERICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columntype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IsPredictiveValue": { "MarkdownDocumentation": "`IsPredictiveValue`\n\nIndicates if this column contains predictive values that should be treated as target variables in machine learning models. This affects how the synthetic data generation preserves statistical relationships.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-ispredictivevalue", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::AnalysisTemplate.SyntheticDataParameters": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate.SyntheticDataParameters`\n\nThe parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdataparameters.html", "Properties": { "MlSyntheticDataParameters": { "MarkdownDocumentation": "`MlSyntheticDataParameters`\n\nThe machine learning-specific parameters for synthetic data generation.\n*Required*: Yes\n*Type*: [MLSyntheticDataParameters](./aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdataparameters.html#cfn-cleanrooms-analysistemplate-syntheticdataparameters-mlsyntheticdataparameters", "UpdateType": "Immutable", "Required": true, "Type": "MLSyntheticDataParameters" } } }, "AWS::CleanRooms::Collaboration.DataEncryptionMetadata": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.DataEncryptionMetadata`\n\nThe settings for client-side encryption for cryptographic computing.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html", "Properties": { "AllowCleartext": { "MarkdownDocumentation": "`AllowCleartext`\n\nIndicates whether encrypted tables can contain cleartext data (`TRUE`) or are\nto cryptographically process every column (`FALSE`).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowcleartext", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "PreserveNulls": { "MarkdownDocumentation": "`PreserveNulls`\n\nIndicates whether NULL values are to be copied as NULL to encrypted tables\n(`TRUE`) or cryptographically processed (`FALSE`).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-preservenulls", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "AllowJoinsOnColumnsWithDifferentNames": { "MarkdownDocumentation": "`AllowJoinsOnColumnsWithDifferentNames`\n\nIndicates whether Fingerprint columns can be joined on any other Fingerprint column with\na different name (`TRUE`) or can only be joined on Fingerprint columns of the\nsame name (`FALSE`).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowjoinsoncolumnswithdifferentnames", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "AllowDuplicates": { "MarkdownDocumentation": "`AllowDuplicates`\n\nIndicates whether Fingerprint columns can contain duplicate entries (`TRUE`)\nor are to contain only non-repeated values (`FALSE`).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowduplicates", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Collaboration.JobComputePaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.JobComputePaymentConfig`\n\nAn object representing the collaboration member's payment responsibilities\nset by the collaboration creator for query and job compute costs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-jobcomputepaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates whether the collaboration creator has configured the collaboration\nmember to pay for query and job compute costs (`TRUE`) or has not configured the\ncollaboration member to pay for query and job compute costs (`FALSE`).\nExactly one member can be configured to pay for query and job compute costs. An error\nis returned if the collaboration creator sets a `TRUE` value for more\nthan one member in the collaboration.\nAn error is returned if the collaboration creator sets a\n`FALSE` value for the member who can run queries and jobs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-jobcomputepaymentconfig.html#cfn-cleanrooms-collaboration-jobcomputepaymentconfig-isresponsible", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Collaboration.MLMemberAbilities": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.MLMemberAbilities`\n\nThe ML member abilities for a collaboration member.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlmemberabilities.html", "Properties": { "CustomMLMemberAbilities": { "MarkdownDocumentation": "`CustomMLMemberAbilities`\n\nThe custom ML member abilities for a collaboration member.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlmemberabilities.html#cfn-cleanrooms-collaboration-mlmemberabilities-custommlmemberabilities", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CleanRooms::Collaboration.MLPaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.MLPaymentConfig`\n\nAn object representing the collaboration member's machine learning payment responsibilities set by the\ncollaboration creator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlpaymentconfig.html", "Properties": { "ModelInference": { "MarkdownDocumentation": "`ModelInference`\n\nThe payment responsibilities accepted by the member for model inference.\n*Required*: No\n*Type*: [ModelInferencePaymentConfig](./aws-properties-cleanrooms-collaboration-modelinferencepaymentconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlpaymentconfig.html#cfn-cleanrooms-collaboration-mlpaymentconfig-modelinference", "UpdateType": "Immutable", "Required": false, "Type": "ModelInferencePaymentConfig" }, "SyntheticDataGeneration": { "MarkdownDocumentation": "`SyntheticDataGeneration`\n\nThe payment configuration for machine learning synthetic data generation.\n*Required*: No\n*Type*: [SyntheticDataGenerationPaymentConfig](./aws-properties-cleanrooms-collaboration-syntheticdatagenerationpaymentconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlpaymentconfig.html#cfn-cleanrooms-collaboration-mlpaymentconfig-syntheticdatageneration", "UpdateType": "Immutable", "Required": false, "Type": "SyntheticDataGenerationPaymentConfig" }, "ModelTraining": { "MarkdownDocumentation": "`ModelTraining`\n\nThe payment responsibilities accepted by the member for model training.\n*Required*: No\n*Type*: [ModelTrainingPaymentConfig](./aws-properties-cleanrooms-collaboration-modeltrainingpaymentconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-mlpaymentconfig.html#cfn-cleanrooms-collaboration-mlpaymentconfig-modeltraining", "UpdateType": "Immutable", "Required": false, "Type": "ModelTrainingPaymentConfig" } } }, "AWS::CleanRooms::Collaboration.MemberSpecification": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.MemberSpecification`\n\nBasic metadata used to construct a new member.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html", "Properties": { "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThe identifier used to reference members of the collaboration. Currently only supports\nAWS account ID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\d+$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-accountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MLMemberAbilities": { "MarkdownDocumentation": "`MLMemberAbilities`\n\nThe ML abilities granted to the collaboration member.\n*Required*: No\n*Type*: [MLMemberAbilities](./aws-properties-cleanrooms-collaboration-mlmemberabilities.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-mlmemberabilities", "UpdateType": "Immutable", "Required": false, "Type": "MLMemberAbilities" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe member's display name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-displayname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MemberAbilities": { "MarkdownDocumentation": "`MemberAbilities`\n\nThe abilities granted to the collaboration member.\n*Allowed Values*: `CAN_QUERY` | `CAN_RECEIVE_RESULTS`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-memberabilities", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PaymentConfiguration": { "MarkdownDocumentation": "`PaymentConfiguration`\n\nThe collaboration member's payment responsibilities set by the collaboration creator.\nIf the collaboration creator hasn't speci\ufb01ed anyone as the member paying for query\ncompute costs, then the member who can query is the default payer.\n*Required*: No\n*Type*: [PaymentConfiguration](./aws-properties-cleanrooms-collaboration-paymentconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-paymentconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "PaymentConfiguration" } } }, "AWS::CleanRooms::Collaboration.ModelInferencePaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.ModelInferencePaymentConfig`\n\nAn object representing the collaboration member's model inference payment responsibilities set by the\ncollaboration creator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-modelinferencepaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates whether the collaboration creator has configured the collaboration member to\npay for model inference costs (`TRUE`) or has not configured the collaboration\nmember to pay for model inference costs (`FALSE`).\nExactly one member can be configured to pay for model inference costs. An error is\nreturned if the collaboration creator sets a `TRUE` value for more than one\nmember in the collaboration.\nIf the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if\nthe collaboration creator sets a `FALSE` value for the member who can\nquery.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-modelinferencepaymentconfig.html#cfn-cleanrooms-collaboration-modelinferencepaymentconfig-isresponsible", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Collaboration.ModelTrainingPaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.ModelTrainingPaymentConfig`\n\nAn object representing the collaboration member's model training payment responsibilities set by the\ncollaboration creator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-modeltrainingpaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates whether the collaboration creator has configured the collaboration member to\npay for model training costs (`TRUE`) or has not configured the collaboration\nmember to pay for model training costs (`FALSE`).\nExactly one member can be configured to pay for model training costs. An error is\nreturned if the collaboration creator sets a `TRUE` value for more than one\nmember in the collaboration.\nIf the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if\nthe collaboration creator sets a `FALSE` value for the member who can\nquery.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-modeltrainingpaymentconfig.html#cfn-cleanrooms-collaboration-modeltrainingpaymentconfig-isresponsible", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Collaboration.PaymentConfiguration": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.PaymentConfiguration`\n\nAn object representing the collaboration member's payment responsibilities set by the\ncollaboration creator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html", "Properties": { "JobCompute": { "MarkdownDocumentation": "`JobCompute`\n\nThe compute configuration for the job.\n*Required*: No\n*Type*: [JobComputePaymentConfig](./aws-properties-cleanrooms-collaboration-jobcomputepaymentconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html#cfn-cleanrooms-collaboration-paymentconfiguration-jobcompute", "UpdateType": "Immutable", "Required": false, "Type": "JobComputePaymentConfig" }, "QueryCompute": { "MarkdownDocumentation": "`QueryCompute`\n\nThe collaboration member's payment responsibilities set by the collaboration creator for\nquery compute costs.\n*Required*: Yes\n*Type*: [QueryComputePaymentConfig](./aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html#cfn-cleanrooms-collaboration-paymentconfiguration-querycompute", "UpdateType": "Immutable", "Required": true, "Type": "QueryComputePaymentConfig" }, "MachineLearning": { "MarkdownDocumentation": "`MachineLearning`\n\nAn object representing the collaboration member's machine learning payment responsibilities set by the\ncollaboration creator.\n*Required*: No\n*Type*: [MLPaymentConfig](./aws-properties-cleanrooms-collaboration-mlpaymentconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html#cfn-cleanrooms-collaboration-paymentconfiguration-machinelearning", "UpdateType": "Immutable", "Required": false, "Type": "MLPaymentConfig" } } }, "AWS::CleanRooms::Collaboration.QueryComputePaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.QueryComputePaymentConfig`\n\nAn object representing the collaboration member's payment responsibilities set by the\ncollaboration creator for query compute costs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates whether the collaboration creator has configured the collaboration member to\npay for query compute costs (`TRUE`) or has not configured the collaboration\nmember to pay for query compute costs (`FALSE`).\nExactly one member can be configured to pay for query compute costs. An error is\nreturned if the collaboration creator sets a `TRUE` value for more than one\nmember in the collaboration.\nIf the collaboration creator hasn't specified anyone as the member paying for query\ncompute costs, then the member who can query is the default payer. An error is returned if\nthe collaboration creator sets a `FALSE` value for the member who can\nquery.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.html#cfn-cleanrooms-collaboration-querycomputepaymentconfig-isresponsible", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Collaboration.SyntheticDataGenerationPaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration.SyntheticDataGenerationPaymentConfig`\n\nPayment configuration for synthetic data generation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-syntheticdatagenerationpaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates who is responsible for paying for synthetic data generation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-syntheticdatagenerationpaymentconfig.html#cfn-cleanrooms-collaboration-syntheticdatagenerationpaymentconfig-isresponsible", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::ConfiguredTable.AggregateColumn": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.AggregateColumn`\n\nColumn in configured table that can be used in aggregate function in query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregatecolumn.html", "Properties": { "Function": { "MarkdownDocumentation": "`Function`\n\nAggregation function that can be applied to aggregate column in query.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SUM | SUM_DISTINCT | COUNT ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregatecolumn.html#cfn-cleanrooms-configuredtable-aggregatecolumn-function", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnNames": { "MarkdownDocumentation": "`ColumnNames`\n\nColumn names in configured table of aggregate columns.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregatecolumn.html#cfn-cleanrooms-configuredtable-aggregatecolumn-columnnames", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTable.AggregationConstraint": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.AggregationConstraint`\n\nConstraint on query output removing output rows that do not meet a minimum number of\ndistinct values of a specified column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregationconstraint.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nColumn in aggregation constraint for which there must be a minimum number of distinct\nvalues in an output row for it to be in the query output.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregationconstraint.html#cfn-cleanrooms-configuredtable-aggregationconstraint-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nThe minimum number of distinct values that an output row must be an aggregation of.\nMinimum threshold of distinct values for a specified column that must exist in an output\nrow for it to be in the query output.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregationconstraint.html#cfn-cleanrooms-configuredtable-aggregationconstraint-minimum", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of aggregation the constraint allows. The only valid value is currently\n`COUNT\\_DISTINCT`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `COUNT_DISTINCT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT_DISTINCT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregationconstraint.html#cfn-cleanrooms-configuredtable-aggregationconstraint-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::ConfiguredTable.AnalysisRule": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.AnalysisRule`\n\nA specification about how data from the configured table can be used in a query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrule.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nA policy that describes the associated data usage limitations.\n*Required*: Yes\n*Type*: [ConfiguredTableAnalysisRulePolicy](./aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrule.html#cfn-cleanrooms-configuredtable-analysisrule-policy", "UpdateType": "Mutable", "Required": true, "Type": "ConfiguredTableAnalysisRulePolicy" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of analysis rule.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AGGREGATION | LIST | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AGGREGATION", "LIST", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrule.html#cfn-cleanrooms-configuredtable-analysisrule-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::ConfiguredTable.AnalysisRuleAggregation": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.AnalysisRuleAggregation`\n\nA type of analysis rule that enables query structure and specified queries that produce\naggregate statistics.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html", "Properties": { "AllowedJoinOperators": { "MarkdownDocumentation": "`AllowedJoinOperators`\n\nWhich logical operators (if any) are to be used in an INNER JOIN match condition.\nDefault is `AND`.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-allowedjoinoperators", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ScalarFunctions": { "MarkdownDocumentation": "`ScalarFunctions`\n\nSet of scalar functions that are allowed to be used on dimension columns and the output\nof aggregation of metrics.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-scalarfunctions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AdditionalAnalyses": { "MarkdownDocumentation": "`AdditionalAnalyses`\n\nAn indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.\nThe `additionalAnalyses` parameter is currently supported for the list\nanalysis rule (`AnalysisRuleList`) and the custom analysis rule\n(`AnalysisRuleCustom`).\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOWED | REQUIRED | NOT_AL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOWED", "REQUIRED", "NOT_ALLOWED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-additionalanalyses", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputConstraints": { "MarkdownDocumentation": "`OutputConstraints`\n\nColumns that must meet a specific threshold value (after an aggregation function is\napplied to it) for each output row to be returned.\n*Required*: Yes\n*Type*: Array of [AggregationConstraint](./aws-properties-cleanrooms-configuredtable-aggregationconstraint.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-outputconstraints", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AggregationConstraint", "DuplicatesAllowed": true }, "DimensionColumns": { "MarkdownDocumentation": "`DimensionColumns`\n\nThe columns that query runners are allowed to select, group by, or filter by.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-dimensioncolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "JoinColumns": { "MarkdownDocumentation": "`JoinColumns`\n\nColumns in configured table that can be used in join statements and/or as aggregate\ncolumns. They can never be outputted directly.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-joincolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "JoinRequired": { "MarkdownDocumentation": "`JoinRequired`\n\nControl that requires member who runs query to do a join with their configured table\nand/or other configured table in query.\n*Required*: No\n*Type*: String\n*Allowed values*: `QUERY_RUNNER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "QUERY_RUNNER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-joinrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AggregateColumns": { "MarkdownDocumentation": "`AggregateColumns`\n\nThe columns that query runners are allowed to use in aggregation queries.\n*Required*: Yes\n*Type*: Array of [AggregateColumn](./aws-properties-cleanrooms-configuredtable-aggregatecolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-aggregatecolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AggregateColumn", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTable.AnalysisRuleCustom": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.AnalysisRuleCustom`\n\nA type of analysis rule that enables the table owner to approve custom SQL queries on\ntheir configured tables. It supports differential privacy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html", "Properties": { "AdditionalAnalyses": { "MarkdownDocumentation": "`AdditionalAnalyses`\n\nAn indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOWED | REQUIRED | NOT_AL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOWED", "REQUIRED", "NOT_ALLOWED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-additionalanalyses", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllowedAnalysisProviders": { "MarkdownDocumentation": "`AllowedAnalysisProviders`\n\nThe IDs of the AWS accounts that are allowed to query by the custom analysis rule. Required when\n`allowedAnalyses` is `ANY_QUERY`.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-allowedanalysisproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DifferentialPrivacy": { "MarkdownDocumentation": "`DifferentialPrivacy`\n\nThe differential privacy configuration.\n*Required*: No\n*Type*: [DifferentialPrivacy](./aws-properties-cleanrooms-configuredtable-differentialprivacy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-differentialprivacy", "UpdateType": "Mutable", "Required": false, "Type": "DifferentialPrivacy" }, "AllowedAnalyses": { "MarkdownDocumentation": "`AllowedAnalyses`\n\nThe ARN of the analysis templates that are allowed by the custom analysis rule.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-allowedanalyses", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DisallowedOutputColumns": { "MarkdownDocumentation": "`DisallowedOutputColumns`\n\nA list of columns that aren't allowed to be shown in the query output.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-disallowedoutputcolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTable.AnalysisRuleList": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.AnalysisRuleList`\n\nA type of analysis rule that enables row-level analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html", "Properties": { "AllowedJoinOperators": { "MarkdownDocumentation": "`AllowedJoinOperators`\n\nThe logical operators (if any) that are to be used in an INNER JOIN match condition.\nDefault is `AND`.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html#cfn-cleanrooms-configuredtable-analysisrulelist-allowedjoinoperators", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ListColumns": { "MarkdownDocumentation": "`ListColumns`\n\nColumns that can be listed in the output.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html#cfn-cleanrooms-configuredtable-analysisrulelist-listcolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AdditionalAnalyses": { "MarkdownDocumentation": "`AdditionalAnalyses`\n\nAn indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOWED | REQUIRED | NOT_AL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOWED", "REQUIRED", "NOT_ALLOWED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html#cfn-cleanrooms-configuredtable-analysisrulelist-additionalanalyses", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JoinColumns": { "MarkdownDocumentation": "`JoinColumns`\n\nColumns that can be used to join a configured table with the table of the member who can\nquery and other members' configured tables.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html#cfn-cleanrooms-configuredtable-analysisrulelist-joincolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTable.AthenaTableReference": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.AthenaTableReference`\n\nA reference to a table within Athena.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html", "Properties": { "WorkGroup": { "MarkdownDocumentation": "`WorkGroup`\n\nThe workgroup of the Athena table reference.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-workgroup", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe table reference.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe database name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe AWS Region where the Athena table is located. This parameter is required to uniquely identify and access tables across different Regions.\n*Required*: No\n*Type*: String\n*Allowed values*: `us-west-1 | us-west-2 | us-...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1", "ap-east-2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputLocation": { "MarkdownDocumentation": "`OutputLocation`\n\nThe output location for the Athena table.\n*Required*: No\n*Type*: String\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-outputlocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CleanRooms::ConfiguredTable.ConfiguredTableAnalysisRulePolicy": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.ConfiguredTableAnalysisRulePolicy`\n\nControls on the query specifications that can be run on a configured table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicy.html", "Properties": { "V1": { "MarkdownDocumentation": "`V1`\n\nControls on the query specifications that can be run on a configured table.\n*Required*: Yes\n*Type*: [ConfiguredTableAnalysisRulePolicyV1](./aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicy.html#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicy-v1", "UpdateType": "Mutable", "Required": true, "Type": "ConfiguredTableAnalysisRulePolicyV1" } } }, "AWS::CleanRooms::ConfiguredTable.ConfiguredTableAnalysisRulePolicyV1": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.ConfiguredTableAnalysisRulePolicyV1`\n\nControls on the query specifications that can be run on a configured table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nAnalysis rule type that enables only aggregation queries on a configured table.\n*Required*: No\n*Type*: [AnalysisRuleAggregation](./aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-aggregation", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisRuleAggregation" }, "List": { "MarkdownDocumentation": "`List`\n\nAnalysis rule type that enables only list queries on a configured table.\n*Required*: No\n*Type*: [AnalysisRuleList](./aws-properties-cleanrooms-configuredtable-analysisrulelist.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-list", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisRuleList" }, "Custom": { "MarkdownDocumentation": "`Custom`\n\nAnalysis rule type that enables custom SQL queries on a configured table.\n*Required*: No\n*Type*: [AnalysisRuleCustom](./aws-properties-cleanrooms-configuredtable-analysisrulecustom.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-custom", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisRuleCustom" } } }, "AWS::CleanRooms::ConfiguredTable.DifferentialPrivacy": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.DifferentialPrivacy`\n\nThe analysis method allowed for the configured tables.\n`DIRECT_QUERY` allows SQL queries to be run directly on this table.\n`DIRECT_JOB` allows PySpark jobs to be run directly on this table.\n`MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-differentialprivacy.html", "Properties": { "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe name of the column, such as user\\_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.\n*Required*: Yes\n*Type*: Array of [DifferentialPrivacyColumn](./aws-properties-cleanrooms-configuredtable-differentialprivacycolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-differentialprivacy.html#cfn-cleanrooms-configuredtable-differentialprivacy-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DifferentialPrivacyColumn", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTable.DifferentialPrivacyColumn": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.DifferentialPrivacyColumn`\n\nSpecifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-differentialprivacycolumn.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the column, such as user\\_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-differentialprivacycolumn.html#cfn-cleanrooms-configuredtable-differentialprivacycolumn-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::ConfiguredTable.GlueTableReference": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.GlueTableReference`\n\nA reference to a table within an AWS Glue data catalog.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the AWS Glue table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html#cfn-cleanrooms-configuredtable-gluetablereference-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the database the AWS Glue table belongs to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html#cfn-cleanrooms-configuredtable-gluetablereference-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe AWS Region where the AWS Glue table is located. This parameter is required to uniquely identify and access tables across different Regions.\n*Required*: No\n*Type*: String\n*Allowed values*: `us-west-1 | us-west-2 | us-...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "us-west-1", "us-west-2", "us-east-1", "us-east-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-5", "ap-southeast-4", "ap-southeast-7", "ap-south-1", "ap-northeast-3", "ap-northeast-1", "ap-northeast-2", "ca-central-1", "ca-west-1", "eu-south-1", "eu-west-3", "eu-south-2", "eu-central-2", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "me-south-1", "me-central-1", "il-central-1", "sa-east-1", "mx-central-1", "ap-east-2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html#cfn-cleanrooms-configuredtable-gluetablereference-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CleanRooms::ConfiguredTable.SnowflakeTableReference": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.SnowflakeTableReference`\n\nA reference to a table within Snowflake.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe secret ARN of the Snowflake table reference.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the Snowflake table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableSchema": { "MarkdownDocumentation": "`TableSchema`\n\nThe schema of the Snowflake table.\n*Required*: Yes\n*Type*: [SnowflakeTableSchema](./aws-properties-cleanrooms-configuredtable-snowflaketableschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-tableschema", "UpdateType": "Mutable", "Required": true, "Type": "SnowflakeTableSchema" }, "AccountIdentifier": { "MarkdownDocumentation": "`AccountIdentifier`\n\nThe account identifier for the Snowflake table reference.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-accountidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the database the Snowflake table belongs to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SchemaName": { "MarkdownDocumentation": "`SchemaName`\n\nThe schema name of the Snowflake table reference.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketablereference.html#cfn-cleanrooms-configuredtable-snowflaketablereference-schemaname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::ConfiguredTable.SnowflakeTableSchema": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.SnowflakeTableSchema`\n\nThe schema of a Snowflake table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschema.html", "Properties": { "V1": { "MarkdownDocumentation": "`V1`\n\nThe schema of a Snowflake table.\n*Required*: Yes\n*Type*: Array of [SnowflakeTableSchemaV1](./aws-properties-cleanrooms-configuredtable-snowflaketableschemav1.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschema.html#cfn-cleanrooms-configuredtable-snowflaketableschema-v1", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SnowflakeTableSchemaV1", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTable.SnowflakeTableSchemaV1": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.SnowflakeTableSchemaV1`\n\nThe Snowflake table schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschemav1.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe column name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschemav1.html#cfn-cleanrooms-configuredtable-snowflaketableschemav1-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnType": { "MarkdownDocumentation": "`ColumnType`\n\nThe column's data type. Supported data types: `ARRAY`, `BIGINT`,\n`BOOLEAN`, `CHAR`, `DATE`,\n`DECIMAL`, `DOUBLE`, `DOUBLE PRECISION`,\n`FLOAT`, `FLOAT4`, `INT`, `INTEGER`,\n`MAP`, `NUMERIC`, `NUMBER`, `REAL`,\n`SMALLINT`, `STRING`, `TIMESTAMP`,\n`TIMESTAMP_LTZ`, `TIMESTAMP_NTZ`, `DATETIME`,\n`TINYINT`, `VARCHAR`, `TEXT`, `CHARACTER`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-snowflaketableschemav1.html#cfn-cleanrooms-configuredtable-snowflaketableschemav1-columntype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::ConfiguredTable.TableReference": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable.TableReference`\n\nA pointer to the dataset that underlies this table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html", "Properties": { "Glue": { "MarkdownDocumentation": "`Glue`\n\nIf present, a reference to the AWS Glue table referred to by this table\nreference.\n*Required*: No\n*Type*: [GlueTableReference](./aws-properties-cleanrooms-configuredtable-gluetablereference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html#cfn-cleanrooms-configuredtable-tablereference-glue", "UpdateType": "Mutable", "Required": false, "Type": "GlueTableReference" }, "Snowflake": { "MarkdownDocumentation": "`Snowflake`\n\nIf present, a reference to the Snowflake table referred to by this table reference.\n*Required*: No\n*Type*: [SnowflakeTableReference](./aws-properties-cleanrooms-configuredtable-snowflaketablereference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html#cfn-cleanrooms-configuredtable-tablereference-snowflake", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeTableReference" }, "Athena": { "MarkdownDocumentation": "`Athena`\n\nIf present, a reference to the Athena table referred to by this table reference.\n*Required*: No\n*Type*: [AthenaTableReference](./aws-properties-cleanrooms-configuredtable-athenatablereference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html#cfn-cleanrooms-configuredtable-tablereference-athena", "UpdateType": "Mutable", "Required": false, "Type": "AthenaTableReference" } } }, "AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRule": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRule`\n\nAn analysis rule for a configured table association. This analysis rule specifies how\ndata from the table can be used within its associated collaboration. In the console, the\n`ConfiguredTableAssociationAnalysisRule` is referred to as the\n*collaboration analysis rule*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe policy of the configured table association analysis rule.\n*Required*: Yes\n*Type*: [ConfiguredTableAssociationAnalysisRulePolicy](./aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-policy", "UpdateType": "Mutable", "Required": true, "Type": "ConfiguredTableAssociationAnalysisRulePolicy" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the configured table association analysis rule.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AGGREGATION | LIST | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AGGREGATION", "LIST", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregation": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregation`\n\nThe configured table association analysis rule applied to a configured table with the aggregation analysis rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.html", "Properties": { "AllowedResultReceivers": { "MarkdownDocumentation": "`AllowedResultReceivers`\n\nThe list of collaboration members who are allowed to receive results of queries run\nwith this configured table.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedresultreceivers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedAdditionalAnalyses": { "MarkdownDocumentation": "`AllowedAdditionalAnalyses`\n\nThe list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.\nThe `allowedAdditionalAnalyses` parameter is currently supported for the list\nanalysis rule (`AnalysisRuleList`) and the custom analysis rule\n(`AnalysisRuleCustom`).\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedadditionalanalyses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustom": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustom`\n\nThe configured table association analysis rule applied to a configured table with the custom analysis rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.html", "Properties": { "AllowedResultReceivers": { "MarkdownDocumentation": "`AllowedResultReceivers`\n\nThe list of collaboration members who are allowed to receive results of queries run\nwith this configured table.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedresultreceivers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedAdditionalAnalyses": { "MarkdownDocumentation": "`AllowedAdditionalAnalyses`\n\nThe list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedadditionalanalyses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleList": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleList`\n\nThe configured table association analysis rule applied to a configured table with the list analysis rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.html", "Properties": { "AllowedResultReceivers": { "MarkdownDocumentation": "`AllowedResultReceivers`\n\nThe list of collaboration members who are allowed to receive results of queries run\nwith this configured table.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedresultreceivers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedAdditionalAnalyses": { "MarkdownDocumentation": "`AllowedAdditionalAnalyses`\n\nThe list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedadditionalanalyses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicy": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicy`\n\nControls on the query specifications that can be run on an associated configured table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy.html", "Properties": { "V1": { "MarkdownDocumentation": "`V1`\n\nThe policy for the configured table association analysis rule.\n*Required*: Yes\n*Type*: [ConfiguredTableAssociationAnalysisRulePolicyV1](./aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy-v1", "UpdateType": "Mutable", "Required": true, "Type": "ConfiguredTableAssociationAnalysisRulePolicyV1" } } }, "AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1`\n\nControls on the query specifications that can be run on an associated configured table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nAnalysis rule type that enables only aggregation queries on a configured table.\n*Required*: No\n*Type*: [ConfiguredTableAssociationAnalysisRuleAggregation](./aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-aggregation", "UpdateType": "Mutable", "Required": false, "Type": "ConfiguredTableAssociationAnalysisRuleAggregation" }, "List": { "MarkdownDocumentation": "`List`\n\nAnalysis rule type that enables only list queries on a configured table.\n*Required*: No\n*Type*: [ConfiguredTableAssociationAnalysisRuleList](./aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-list", "UpdateType": "Mutable", "Required": false, "Type": "ConfiguredTableAssociationAnalysisRuleList" }, "Custom": { "MarkdownDocumentation": "`Custom`\n\nAnalysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.\n*Required*: No\n*Type*: [ConfiguredTableAssociationAnalysisRuleCustom](./aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-custom", "UpdateType": "Mutable", "Required": false, "Type": "ConfiguredTableAssociationAnalysisRuleCustom" } } }, "AWS::CleanRooms::IdMappingTable.IdMappingTableInputReferenceConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::IdMappingTable.IdMappingTableInputReferenceConfig`\n\nProvides the input reference configuration for the ID mapping table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig.html", "Properties": { "InputReferenceArn": { "MarkdownDocumentation": "`InputReferenceArn`\n\nThe Amazon Resource Name (ARN) of the referenced resource in AWS Entity Resolution. Valid values are ID mapping workflow ARNs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig.html#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig-inputreferencearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ManageResourcePolicies": { "MarkdownDocumentation": "`ManageResourcePolicies`\n\nWhen `TRUE`, AWS Clean Rooms manages permissions for the ID mapping table resource.\nWhen `FALSE`, the resource owner manages permissions for the ID mapping table resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig.html#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig-manageresourcepolicies", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::IdMappingTable.IdMappingTableInputReferenceProperties": { "MarkdownDocumentation": "`AWS::CleanRooms::IdMappingTable.IdMappingTableInputReferenceProperties`\n\nThe input reference properties for the ID mapping table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceproperties.html", "Properties": { "IdMappingTableInputSource": { "MarkdownDocumentation": "`IdMappingTableInputSource`\n\nThe input source of the ID mapping table.\n*Required*: Yes\n*Type*: [Array](./aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.html) of [IdMappingTableInputSource](./aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceproperties.html#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceproperties-idmappingtableinputsource", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "IdMappingTableInputSource", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::IdMappingTable.IdMappingTableInputSource": { "MarkdownDocumentation": "`AWS::CleanRooms::IdMappingTable.IdMappingTableInputSource`\n\nThe input source of the ID mapping table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the input source of the ID mapping table.\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)", "RefReturnValue": "", "AllowedValues": [ "SOURCE", "TARGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.html#cfn-cleanrooms-idmappingtable-idmappingtableinputsource-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IdNamespaceAssociationId": { "MarkdownDocumentation": "`IdNamespaceAssociationId`\n\nThe unique identifier of the ID namespace association.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.html#cfn-cleanrooms-idmappingtable-idmappingtableinputsource-idnamespaceassociationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::IdNamespaceAssociation.IdMappingConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::IdNamespaceAssociation.IdMappingConfig`\n\nThe configuration settings for the ID mapping table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idmappingconfig.html", "Properties": { "AllowUseAsDimensionColumn": { "MarkdownDocumentation": "`AllowUseAsDimensionColumn`\n\nAn indicator as to whether you can use your column as a dimension column in the ID mapping table (`TRUE`) or not (`FALSE`).\nDefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idmappingconfig.html#cfn-cleanrooms-idnamespaceassociation-idmappingconfig-allowuseasdimensioncolumn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::IdNamespaceAssociation.IdNamespaceAssociationInputReferenceConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::IdNamespaceAssociation.IdNamespaceAssociationInputReferenceConfig`\n\nProvides the information for the ID namespace association input reference configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig.html", "Properties": { "InputReferenceArn": { "MarkdownDocumentation": "`InputReferenceArn`\n\nThe Amazon Resource Name (ARN) of the AWS Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig.html#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig-inputreferencearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ManageResourcePolicies": { "MarkdownDocumentation": "`ManageResourcePolicies`\n\nWhen `TRUE`, AWS Clean Rooms manages permissions for the ID namespace association resource.\nWhen `FALSE`, the resource owner manages permissions for the ID namespace association resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig.html#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig-manageresourcepolicies", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::IdNamespaceAssociation.IdNamespaceAssociationInputReferenceProperties": { "MarkdownDocumentation": "`AWS::CleanRooms::IdNamespaceAssociation.IdNamespaceAssociationInputReferenceProperties`\n\nProvides the information for the ID namespace association input reference properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties.html", "Properties": { "IdNamespaceType": { "MarkdownDocumentation": "`IdNamespaceType`\n\nThe ID namespace type for this ID namespace association.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "SOURCE", "TARGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties.html#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties-idnamespacetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdMappingWorkflowsSupported": { "MarkdownDocumentation": "`IdMappingWorkflowsSupported`\n\nDefines how ID mapping workflows are supported for this ID namespace association.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties.html#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties-idmappingworkflowssupported", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Json", "DuplicatesAllowed": true } } }, "AWS::CleanRooms::Membership.MembershipJobComputePaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipJobComputePaymentConfig`\n\nAn object representing the payment responsibilities accepted by the\ncollaboration member for query and job compute costs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipjobcomputepaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates whether the collaboration member has accepted to pay for job\ncompute costs (`TRUE`) or has not accepted to pay for query and job compute costs\n(`FALSE`).\nThere is only one member who pays for queries and jobs.\nAn error message is returned for the following reasons:\n* If you set the value to `FALSE` but you are responsible to\n pay for query and job compute costs.\n* If you set the value to `TRUE` but you are not responsible to\n pay for query and job compute costs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipjobcomputepaymentconfig.html#cfn-cleanrooms-membership-membershipjobcomputepaymentconfig-isresponsible", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Membership.MembershipMLPaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipMLPaymentConfig`\n\nAn object representing the collaboration member's machine learning payment responsibilities set by the\ncollaboration creator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmlpaymentconfig.html", "Properties": { "ModelInference": { "MarkdownDocumentation": "`ModelInference`\n\nThe payment responsibilities accepted by the member for model inference.\n*Required*: No\n*Type*: [MembershipModelInferencePaymentConfig](./aws-properties-cleanrooms-membership-membershipmodelinferencepaymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmlpaymentconfig.html#cfn-cleanrooms-membership-membershipmlpaymentconfig-modelinference", "UpdateType": "Mutable", "Required": false, "Type": "MembershipModelInferencePaymentConfig" }, "SyntheticDataGeneration": { "MarkdownDocumentation": "`SyntheticDataGeneration`\n\nThe payment configuration for synthetic data generation for this machine learning membership.\n*Required*: No\n*Type*: [MembershipSyntheticDataGenerationPaymentConfig](./aws-properties-cleanrooms-membership-membershipsyntheticdatagenerationpaymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmlpaymentconfig.html#cfn-cleanrooms-membership-membershipmlpaymentconfig-syntheticdatageneration", "UpdateType": "Mutable", "Required": false, "Type": "MembershipSyntheticDataGenerationPaymentConfig" }, "ModelTraining": { "MarkdownDocumentation": "`ModelTraining`\n\nThe payment responsibilities accepted by the member for model training.\n*Required*: No\n*Type*: [MembershipModelTrainingPaymentConfig](./aws-properties-cleanrooms-membership-membershipmodeltrainingpaymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmlpaymentconfig.html#cfn-cleanrooms-membership-membershipmlpaymentconfig-modeltraining", "UpdateType": "Mutable", "Required": false, "Type": "MembershipModelTrainingPaymentConfig" } } }, "AWS::CleanRooms::Membership.MembershipModelInferencePaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipModelInferencePaymentConfig`\n\nAn object representing the collaboration member's model inference payment responsibilities set by the\ncollaboration creator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmodelinferencepaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates whether the collaboration member has accepted to pay for model inference costs\n(`TRUE`) or has not accepted to pay for model inference costs\n(`FALSE`).\nIf the collaboration creator has not specified anyone to pay for model inference costs,\nthen the member who can query is the default payer.\nAn error message is returned for the following reasons:\n* If you set the value to `FALSE` but you are responsible to pay for\n model inference costs.\n* If you set the value to `TRUE` but you are not responsible to pay for\n model inference costs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmodelinferencepaymentconfig.html#cfn-cleanrooms-membership-membershipmodelinferencepaymentconfig-isresponsible", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Membership.MembershipModelTrainingPaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipModelTrainingPaymentConfig`\n\nAn object representing the collaboration member's model training payment responsibilities set by the\ncollaboration creator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmodeltrainingpaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates whether the collaboration member has accepted to pay for model training costs\n(`TRUE`) or has not accepted to pay for model training costs\n(`FALSE`).\nIf the collaboration creator has not specified anyone to pay for model training costs,\nthen the member who can query is the default payer.\nAn error message is returned for the following reasons:\n* If you set the value to `FALSE` but you are responsible to pay for\n model training costs.\n* If you set the value to `TRUE` but you are not responsible to pay for\n model training costs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmodeltrainingpaymentconfig.html#cfn-cleanrooms-membership-membershipmodeltrainingpaymentconfig-isresponsible", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Membership.MembershipPaymentConfiguration": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipPaymentConfiguration`\n\nAn object representing the payment responsibilities accepted by the collaboration\nmember.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.html", "Properties": { "JobCompute": { "MarkdownDocumentation": "`JobCompute`\n\nThe payment responsibilities accepted by the collaboration member for job compute\ncosts.\n*Required*: No\n*Type*: [MembershipJobComputePaymentConfig](./aws-properties-cleanrooms-membership-membershipjobcomputepaymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.html#cfn-cleanrooms-membership-membershippaymentconfiguration-jobcompute", "UpdateType": "Mutable", "Required": false, "Type": "MembershipJobComputePaymentConfig" }, "QueryCompute": { "MarkdownDocumentation": "`QueryCompute`\n\nThe payment responsibilities accepted by the collaboration member for query compute\ncosts.\n*Required*: Yes\n*Type*: [MembershipQueryComputePaymentConfig](./aws-properties-cleanrooms-membership-membershipquerycomputepaymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.html#cfn-cleanrooms-membership-membershippaymentconfiguration-querycompute", "UpdateType": "Mutable", "Required": true, "Type": "MembershipQueryComputePaymentConfig" }, "MachineLearning": { "MarkdownDocumentation": "`MachineLearning`\n\nThe payment responsibilities accepted by the collaboration member for machine learning\ncosts.\n*Required*: No\n*Type*: [MembershipMLPaymentConfig](./aws-properties-cleanrooms-membership-membershipmlpaymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.html#cfn-cleanrooms-membership-membershippaymentconfiguration-machinelearning", "UpdateType": "Mutable", "Required": false, "Type": "MembershipMLPaymentConfig" } } }, "AWS::CleanRooms::Membership.MembershipProtectedJobOutputConfiguration": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipProtectedJobOutputConfiguration`\n\nContains configurations for protected job results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjoboutputconfiguration.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nContains the configuration to write the job results to S3.\n*Required*: Yes\n*Type*: [ProtectedJobS3OutputConfigurationInput](./aws-properties-cleanrooms-membership-protectedjobs3outputconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjoboutputconfiguration.html#cfn-cleanrooms-membership-membershipprotectedjoboutputconfiguration-s3", "UpdateType": "Mutable", "Required": true, "Type": "ProtectedJobS3OutputConfigurationInput" } } }, "AWS::CleanRooms::Membership.MembershipProtectedJobResultConfiguration": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipProtectedJobResultConfiguration`\n\nContains configurations for protected job results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjobresultconfiguration.html", "Properties": { "OutputConfiguration": { "MarkdownDocumentation": "`OutputConfiguration`\n\nThe output configuration for a protected job result.\n*Required*: Yes\n*Type*: [MembershipProtectedJobOutputConfiguration](./aws-properties-cleanrooms-membership-membershipprotectedjoboutputconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjobresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedjobresultconfiguration-outputconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "MembershipProtectedJobOutputConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe unique ARN for an IAM role that is used by AWS Clean Rooms to write protected\njob results to the result location, given by the member who can receive results.\n*Required*: Yes\n*Type*: String\n*Minimum*: `32`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjobresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedjobresultconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CleanRooms::Membership.MembershipProtectedQueryOutputConfiguration": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipProtectedQueryOutputConfiguration`\n\nContains configurations for protected query results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryoutputconfiguration.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nRequired configuration for a protected query with an `s3` output type.\n*Required*: Yes\n*Type*: [ProtectedQueryS3OutputConfiguration](./aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryoutputconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryoutputconfiguration-s3", "UpdateType": "Mutable", "Required": true, "Type": "ProtectedQueryS3OutputConfiguration" } } }, "AWS::CleanRooms::Membership.MembershipProtectedQueryResultConfiguration": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipProtectedQueryResultConfiguration`\n\nContains configurations for protected query results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.html", "Properties": { "OutputConfiguration": { "MarkdownDocumentation": "`OutputConfiguration`\n\nConfiguration for protected query results.\n*Required*: Yes\n*Type*: [MembershipProtectedQueryOutputConfiguration](./aws-properties-cleanrooms-membership-membershipprotectedqueryoutputconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-outputconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "MembershipProtectedQueryOutputConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe unique ARN for an IAM role that is used by AWS Clean Rooms to write protected\nquery results to the result location, given by the member who can receive results.\n*Required*: No\n*Type*: String\n*Minimum*: `32`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CleanRooms::Membership.MembershipQueryComputePaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipQueryComputePaymentConfig`\n\nAn object representing the payment responsibilities accepted by the collaboration member\nfor query compute costs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipquerycomputepaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates whether the collaboration member has accepted to pay for query compute costs\n(`TRUE`) or has not accepted to pay for query compute costs\n(`FALSE`).\nIf the collaboration creator has not specified anyone to pay for query compute costs,\nthen the member who can query is the default payer.\nAn error message is returned for the following reasons:\n* If you set the value to `FALSE` but you are responsible to pay for\n query compute costs.\n* If you set the value to `TRUE` but you are not responsible to pay for\n query compute costs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipquerycomputepaymentconfig.html#cfn-cleanrooms-membership-membershipquerycomputepaymentconfig-isresponsible", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Membership.MembershipSyntheticDataGenerationPaymentConfig": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.MembershipSyntheticDataGenerationPaymentConfig`\n\nConfiguration for payment for synthetic data generation in a membership.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipsyntheticdatagenerationpaymentconfig.html", "Properties": { "IsResponsible": { "MarkdownDocumentation": "`IsResponsible`\n\nIndicates if this membership is responsible for paying for synthetic data generation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipsyntheticdatagenerationpaymentconfig.html#cfn-cleanrooms-membership-membershipsyntheticdatagenerationpaymentconfig-isresponsible", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::Membership.ProtectedJobS3OutputConfigurationInput": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.ProtectedJobS3OutputConfigurationInput`\n\nContains input information for protected jobs with an S3 output type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedjobs3outputconfigurationinput.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe S3 bucket for job output.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedjobs3outputconfigurationinput.html#cfn-cleanrooms-membership-protectedjobs3outputconfigurationinput-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyPrefix": { "MarkdownDocumentation": "`KeyPrefix`\n\nThe S3 prefix to unload the protected job results.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w!.=*/-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedjobs3outputconfigurationinput.html#cfn-cleanrooms-membership-protectedjobs3outputconfigurationinput-keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CleanRooms::Membership.ProtectedQueryS3OutputConfiguration": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership.ProtectedQueryS3OutputConfiguration`\n\nContains the configuration to write the query results to S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe S3 bucket to unload the protected query results.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResultFormat": { "MarkdownDocumentation": "`ResultFormat`\n\nIntended file format of the result.\n*Required*: Yes\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)", "RefReturnValue": "", "AllowedValues": [ "CSV", "PARQUET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-resultformat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyPrefix": { "MarkdownDocumentation": "`KeyPrefix`\n\nThe S3 prefix to unload the protected query results.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w!.=*/-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SingleFileOutput": { "MarkdownDocumentation": "`SingleFileOutput`\n\nIndicates whether files should be output as a single file (`TRUE`) or output\nas multiple files (`FALSE`). This parameter is only supported for analyses with\nthe Spark analytics engine.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-singlefileoutput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::CleanRooms::PrivacyBudgetTemplate.BudgetParameter": { "MarkdownDocumentation": "`AWS::CleanRooms::PrivacyBudgetTemplate.BudgetParameter`\n\nIndividual budget parameter configuration that defines specific budget allocation settings for access budgets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of budget parameter being configured.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CALENDAR_DAY | CALENDAR_MON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_WEEK", "LIFETIME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.html#cfn-cleanrooms-privacybudgettemplate-budgetparameter-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Budget": { "MarkdownDocumentation": "`Budget`\n\nThe budget allocation amount for this specific parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.html#cfn-cleanrooms-privacybudgettemplate-budgetparameter-budget", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "AutoRefresh": { "MarkdownDocumentation": "`AutoRefresh`\n\nWhether this individual budget parameter automatically refreshes when the budget period resets.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.html#cfn-cleanrooms-privacybudgettemplate-budgetparameter-autorefresh", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CleanRooms::PrivacyBudgetTemplate.Parameters": { "MarkdownDocumentation": "`AWS::CleanRooms::PrivacyBudgetTemplate.Parameters`\n\nSpecifies the epsilon and noise parameters for the privacy budget template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-parameters.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-parameters.html#cfn-cleanrooms-privacybudgettemplate-parameters-resourcearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BudgetParameters": { "MarkdownDocumentation": "`BudgetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [BudgetParameter](./aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-parameters.html#cfn-cleanrooms-privacybudgettemplate-parameters-budgetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BudgetParameter", "DuplicatesAllowed": true }, "Epsilon": { "MarkdownDocumentation": "`Epsilon`\n\nThe epsilon value that you want to use.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-parameters.html#cfn-cleanrooms-privacybudgettemplate-parameters-epsilon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UsersNoisePerQuery": { "MarkdownDocumentation": "`UsersNoisePerQuery`\n\nNoise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.\n*Required*: No\n*Type*: Integer\n*Minimum*: `10`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-parameters.html#cfn-cleanrooms-privacybudgettemplate-parameters-usersnoiseperquery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::CleanRoomsML::TrainingDataset.ColumnSchema": { "MarkdownDocumentation": "`AWS::CleanRoomsML::TrainingDataset.ColumnSchema`\n\nMetadata for a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-columnschema.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of a column.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-columnschema.html#cfn-cleanroomsml-trainingdataset-columnschema-columnname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ColumnTypes": { "MarkdownDocumentation": "`ColumnTypes`\n\nThe data type of column.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-columnschema.html#cfn-cleanroomsml-trainingdataset-columnschema-columntypes", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CleanRoomsML::TrainingDataset.DataSource": { "MarkdownDocumentation": "`AWS::CleanRoomsML::TrainingDataset.DataSource`\n\nDefines information about the Glue data source that contains the training data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-datasource.html", "Properties": { "GlueDataSource": { "MarkdownDocumentation": "`GlueDataSource`\n\nA GlueDataSource object that defines the catalog ID, database name, and table name for\nthe training data.\n*Required*: Yes\n*Type*: [GlueDataSource](./aws-properties-cleanroomsml-trainingdataset-gluedatasource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-datasource.html#cfn-cleanroomsml-trainingdataset-datasource-gluedatasource", "UpdateType": "Immutable", "Required": true, "Type": "GlueDataSource" } } }, "AWS::CleanRoomsML::TrainingDataset.Dataset": { "MarkdownDocumentation": "`AWS::CleanRoomsML::TrainingDataset.Dataset`\n\nDefines where the training dataset is located, what type of data it contains, and how to\naccess the data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-dataset.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nWhat type of information is found in the dataset.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INTERACTIONS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "INTERACTIONS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-dataset.html#cfn-cleanroomsml-trainingdataset-dataset-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InputConfig": { "MarkdownDocumentation": "`InputConfig`\n\nA DatasetInputConfig object that defines the data source and schema mapping.\n*Required*: Yes\n*Type*: [DatasetInputConfig](./aws-properties-cleanroomsml-trainingdataset-datasetinputconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-dataset.html#cfn-cleanroomsml-trainingdataset-dataset-inputconfig", "UpdateType": "Immutable", "Required": true, "Type": "DatasetInputConfig" } } }, "AWS::CleanRoomsML::TrainingDataset.DatasetInputConfig": { "MarkdownDocumentation": "`AWS::CleanRoomsML::TrainingDataset.DatasetInputConfig`\n\nDefines the Glue data source and schema mapping information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-datasetinputconfig.html", "Properties": { "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe schema information for the training data.\n*Required*: Yes\n*Type*: Array of [ColumnSchema](./aws-properties-cleanroomsml-trainingdataset-columnschema.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-datasetinputconfig.html#cfn-cleanroomsml-trainingdataset-datasetinputconfig-schema", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "ColumnSchema", "DuplicatesAllowed": true }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nA DataSource object that specifies the Glue data source for the training data.\n*Required*: Yes\n*Type*: [DataSource](./aws-properties-cleanroomsml-trainingdataset-datasource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-datasetinputconfig.html#cfn-cleanroomsml-trainingdataset-datasetinputconfig-datasource", "UpdateType": "Immutable", "Required": true, "Type": "DataSource" } } }, "AWS::CleanRoomsML::TrainingDataset.GlueDataSource": { "MarkdownDocumentation": "`AWS::CleanRoomsML::TrainingDataset.GlueDataSource`\n\nDefines the Glue data source that contains the training data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-gluedatasource.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe Glue table that contains the training data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-gluedatasource.html#cfn-cleanroomsml-trainingdataset-gluedatasource-tablename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe Glue database that contains the training data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-gluedatasource.html#cfn-cleanroomsml-trainingdataset-gluedatasource-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe Glue catalog that contains the training data.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-gluedatasource.html#cfn-cleanroomsml-trainingdataset-gluedatasource-catalogid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cloud9::EnvironmentEC2.Repository": { "MarkdownDocumentation": "`AWS::Cloud9::EnvironmentEC2.Repository`\n\nThe `Repository` property type specifies an AWS CodeCommit source code repository to be cloned into an AWS Cloud9 development environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloud9-environmentec2-repository.html", "Properties": { "PathComponent": { "Required": true, "MarkdownDocumentation": "`PathComponent`\n\nThe path within the development environment's default file system location to clone the AWS CodeCommit repository into. For example, `/REPOSITORY_NAME` would clone the repository into the `/home/USER_NAME/environment/REPOSITORY_NAME` directory in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloud9-environmentec2-repository.html#cfn-cloud9-environmentec2-repository-pathcomponent", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RepositoryUrl": { "Required": true, "MarkdownDocumentation": "`RepositoryUrl`\n\nThe clone URL of the AWS CodeCommit repository to be cloned. For example, for an AWS CodeCommit repository this might be `https://git-codecommit.us-east-2.amazonaws.com/v1/repos/REPOSITORY_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloud9-environmentec2-repository.html#cfn-cloud9-environmentec2-repository-repositoryurl", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CloudFormation::GuardHook.HookTarget": { "MarkdownDocumentation": "`AWS::CloudFormation::GuardHook.HookTarget`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-hooktarget.html", "Properties": { "InvocationPoint": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-hooktarget.html#cfn-cloudformation-guardhook-hooktarget-invocationpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-hooktarget.html#cfn-cloudformation-guardhook-hooktarget-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-hooktarget.html#cfn-cloudformation-guardhook-hooktarget-targetname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFormation::GuardHook.Options": { "MarkdownDocumentation": "`AWS::CloudFormation::GuardHook.Options`\n\nSpecifies the input parameters for a Guard Hook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-options.html", "Properties": { "InputParams": { "MarkdownDocumentation": "`InputParams`\n\nSpecifies the S3 location where your input parameters are located.\n*Required*: No\n*Type*: [S3Location](./aws-properties-cloudformation-guardhook-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-options.html#cfn-cloudformation-guardhook-options-inputparams", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" } } }, "AWS::CloudFormation::GuardHook.S3Location": { "MarkdownDocumentation": "`AWS::CloudFormation::GuardHook.S3Location`\n\nSpecifies the S3 location where your Guard rules or input\nparameters are located.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html", "Properties": { "VersionId": { "MarkdownDocumentation": "`VersionId`\n\nFor S3 buckets with versioning enabled, specifies the unique ID of the S3 object\nversion to download your Guard rules or input parameters\nfrom.\nThe Guard Hook downloads files from S3 every time the Hook is\ninvoked. To prevent accidental changes or deletions, we recommend using a version when\nconfiguring your Guard Hook.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-versionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Uri": { "MarkdownDocumentation": "`Uri`\n\nSpecifies the S3 path to the file that contains your Guard\nrules or input parameters (in the form `s3:///`).\nFor Guard rules, the object stored in S3 must have one of the\nfollowing file extensions: `.guard`, `.zip`, or\n`.tar.gz`.\nFor input parameters, the object stored in S3 must have one of the following file\nextensions: `.yaml`, `.json`, `.zip`, or\n`.tar.gz`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-uri", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFormation::GuardHook.StackFilters": { "MarkdownDocumentation": "`AWS::CloudFormation::GuardHook.StackFilters`\n\nThe `StackFilters` property type specifies stack level filters for a\nHook.\nThe `StackNames` or `StackRoles` properties are optional.\nHowever, you must specify at least one of these properties.\nFor more information, see [CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html", "Properties": { "FilteringCriteria": { "MarkdownDocumentation": "`FilteringCriteria`\n\nThe filtering criteria.\n* All stack names and stack roles (`All`): The Hook will only be\n invoked when all specified filters match.\n* Any stack names and stack roles (`Any`): The Hook will be invoked\n if at least one of the specified filters match.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL | ANY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL", "ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-filteringcriteria", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StackNames": { "MarkdownDocumentation": "`StackNames`\n\nIncludes or excludes specific stacks from Hook invocations.\n*Required*: No\n*Type*: [StackNames](./aws-properties-cloudformation-guardhook-stacknames.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-stacknames", "UpdateType": "Mutable", "Required": false, "Type": "StackNames" }, "StackRoles": { "MarkdownDocumentation": "`StackRoles`\n\nIncludes or excludes specific stacks from Hook invocations based on their associated\nIAM roles.\n*Required*: No\n*Type*: [StackRoles](./aws-properties-cloudformation-guardhook-stackroles.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-stackroles", "UpdateType": "Mutable", "Required": false, "Type": "StackRoles" } } }, "AWS::CloudFormation::GuardHook.StackNames": { "MarkdownDocumentation": "`AWS::CloudFormation::GuardHook.StackNames`\n\nSpecifies the stack names for the `StackFilters` property type to include\nor exclude specific stacks from Hook invocations.\nFor more information, see [CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stacknames.html", "Properties": { "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nThe stack names to exclude. All stacks except those listed here will invoke the\nHook.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stacknames.html#cfn-cloudformation-guardhook-stacknames-exclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Include": { "MarkdownDocumentation": "`Include`\n\nThe stack names to include. Only the stacks specified in this list will invoke the\nHook.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stacknames.html#cfn-cloudformation-guardhook-stacknames-include", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudFormation::GuardHook.StackRoles": { "MarkdownDocumentation": "`AWS::CloudFormation::GuardHook.StackRoles`\n\nSpecifies the stack roles for the `StackFilters` property type to include\nor exclude specific stacks from Hook invocations based on their associated IAM\nroles.\nFor more information, see [CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html", "Properties": { "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nThe IAM role ARNs for stacks you want to exclude. The Hook will be invoked on all\nstacks except those initiated by the specified roles.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html#cfn-cloudformation-guardhook-stackroles-exclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Include": { "MarkdownDocumentation": "`Include`\n\nThe IAM role ARNs to target stacks associated with these roles. Only stack operations\ninitiated by these roles will invoke the Hook.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html#cfn-cloudformation-guardhook-stackroles-include", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudFormation::GuardHook.TargetFilters": { "MarkdownDocumentation": "`AWS::CloudFormation::GuardHook.TargetFilters`\n\nThe `TargetFilters` property type specifies the target filters for the\nHook.\nFor more information, see [CloudFormation Hook target filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-target-filtering.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html", "Properties": { "Actions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "TargetNames": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-targetnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Targets": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HookTarget", "DuplicatesAllowed": false }, "InvocationPoints": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-invocationpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudFormation::HookVersion.LoggingConfig": { "MarkdownDocumentation": "`AWS::CloudFormation::HookVersion.LoggingConfig`\n\nThe `LoggingConfig` property type specifies logging configuration\ninformation for an extension.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html", "Properties": { "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the\nextension's handlers.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\.\\-_/#A-Za-z0-9]+$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-loggroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogRoleArn": { "MarkdownDocumentation": "`LogRoleArn`\n\nThe Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log\nentries to CloudWatch Logs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-logrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFormation::LambdaHook.HookTarget": { "MarkdownDocumentation": "`AWS::CloudFormation::LambdaHook.HookTarget`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-hooktarget.html", "Properties": { "InvocationPoint": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-hooktarget.html#cfn-cloudformation-lambdahook-hooktarget-invocationpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-hooktarget.html#cfn-cloudformation-lambdahook-hooktarget-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-hooktarget.html#cfn-cloudformation-lambdahook-hooktarget-targetname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFormation::LambdaHook.StackFilters": { "MarkdownDocumentation": "`AWS::CloudFormation::LambdaHook.StackFilters`\n\nThe `StackFilters` property type specifies stack level filters for a\nHook.\nThe `StackNames` or `StackRoles` properties are optional.\nHowever, you must specify at least one of these properties.\nFor more information, see [CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackfilters.html", "Properties": { "FilteringCriteria": { "MarkdownDocumentation": "`FilteringCriteria`\n\nThe filtering criteria.\n* All stack names and stack roles (`All`): The Hook will only be\n invoked when all specified filters match.\n* Any stack names and stack roles (`Any`): The Hook will be invoked\n if at least one of the specified filters match.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL | ANY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL", "ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackfilters.html#cfn-cloudformation-lambdahook-stackfilters-filteringcriteria", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StackNames": { "MarkdownDocumentation": "`StackNames`\n\nIncludes or excludes specific stacks from Hook invocations.\n*Required*: No\n*Type*: [StackNames](./aws-properties-cloudformation-lambdahook-stacknames.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackfilters.html#cfn-cloudformation-lambdahook-stackfilters-stacknames", "UpdateType": "Mutable", "Required": false, "Type": "StackNames" }, "StackRoles": { "MarkdownDocumentation": "`StackRoles`\n\nIncludes or excludes specific stacks from Hook invocations based on their associated\nIAM roles.\n*Required*: No\n*Type*: [StackRoles](./aws-properties-cloudformation-lambdahook-stackroles.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackfilters.html#cfn-cloudformation-lambdahook-stackfilters-stackroles", "UpdateType": "Mutable", "Required": false, "Type": "StackRoles" } } }, "AWS::CloudFormation::LambdaHook.StackNames": { "MarkdownDocumentation": "`AWS::CloudFormation::LambdaHook.StackNames`\n\nSpecifies the stack names for the `StackFilters` property type to include\nor exclude specific stacks from Hook invocations.\nFor more information, see [CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stacknames.html", "Properties": { "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nThe stack names to exclude. All stacks except those listed here will invoke the\nHook.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stacknames.html#cfn-cloudformation-lambdahook-stacknames-exclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Include": { "MarkdownDocumentation": "`Include`\n\nThe stack names to include. Only the stacks specified in this list will invoke the\nHook.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stacknames.html#cfn-cloudformation-lambdahook-stacknames-include", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudFormation::LambdaHook.StackRoles": { "MarkdownDocumentation": "`AWS::CloudFormation::LambdaHook.StackRoles`\n\nSpecifies the stack roles for the `StackFilters` property type to include\nor exclude specific stacks from Hook invocations based on their associated IAM\nroles.\nFor more information, see [CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackroles.html", "Properties": { "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nThe IAM role ARNs for stacks you want to exclude. The Hook will be invoked on all\nstacks except those initiated by the specified roles.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackroles.html#cfn-cloudformation-lambdahook-stackroles-exclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Include": { "MarkdownDocumentation": "`Include`\n\nThe IAM role ARNs to target stacks associated with these roles. Only stack operations\ninitiated by these roles will invoke the Hook.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackroles.html#cfn-cloudformation-lambdahook-stackroles-include", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudFormation::LambdaHook.TargetFilters": { "MarkdownDocumentation": "`AWS::CloudFormation::LambdaHook.TargetFilters`\n\nThe `TargetFilters` property type specifies the target filters for the\nHook.\nFor more information, see [CloudFormation Hook target filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-target-filtering.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html", "Properties": { "Actions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html#cfn-cloudformation-lambdahook-targetfilters-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "TargetNames": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html#cfn-cloudformation-lambdahook-targetfilters-targetnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Targets": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html#cfn-cloudformation-lambdahook-targetfilters-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HookTarget", "DuplicatesAllowed": false }, "InvocationPoints": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html#cfn-cloudformation-lambdahook-targetfilters-invocationpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudFormation::ResourceVersion.LoggingConfig": { "MarkdownDocumentation": "`AWS::CloudFormation::ResourceVersion.LoggingConfig`\n\nLogging configuration information for a resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html", "Properties": { "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe Amazon CloudWatch logs group to which CloudFormation sends error logging\ninformation when invoking the type's handlers.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\.\\-_/#A-Za-z0-9]+$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-loggroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogRoleArn": { "MarkdownDocumentation": "`LogRoleArn`\n\nThe ARN of the role that CloudFormation should assume when sending log\nentries to CloudWatch logs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-logrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFormation::StackSet.AutoDeployment": { "MarkdownDocumentation": "`AWS::CloudFormation::StackSet.AutoDeployment`\n\nDescribes whether StackSets automatically deploys to AWS Organizations accounts\nthat are added to a target organization or organizational unit (OU). For more\ninformation, see [Enable or disable automatic deployments for StackSets in AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html) in the *CloudFormation User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html", "Properties": { "DependsOn": { "MarkdownDocumentation": "`DependsOn`\n\nA list of StackSet ARNs that this StackSet depends on for auto-deployment operations.\nWhen auto-deployment is triggered, operations will be sequenced to ensure all dependencies\ncomplete successfully before this StackSet's operation begins.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-dependson", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIf set to `true`, StackSets automatically deploys additional stack\ninstances to AWS Organizations accounts that are added to a target organization or\norganizational unit (OU) in the specified Regions. If an account is removed from a\ntarget organization or OU, StackSets deletes stack instances from the account in the\nspecified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RetainStacksOnAccountRemoval": { "MarkdownDocumentation": "`RetainStacksOnAccountRemoval`\n\nIf set to `true`, stack resources are retained when an account is removed\nfrom a target organization or OU. If set to `false`, stack resources are\ndeleted. Specify only if `Enabled` is set to `True`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-retainstacksonaccountremoval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::CloudFormation::StackSet.DeploymentTargets": { "MarkdownDocumentation": "`AWS::CloudFormation::StackSet.DeploymentTargets`\n\nThe AWS Organizations accounts or AWS accounts to deploy stacks to\nin the specified Regions.\nWhen deploying to AWS Organizations accounts with `SERVICE_MANAGED`\npermissions:\n* You must specify the `OrganizationalUnitIds` property.\n* If you specify organizational units (OUs) for\n `OrganizationalUnitIds` and use either the `Accounts`\n or `AccountsUrl` property, you must also specify the\n `AccountFilterType` property.\nWhen deploying to AWS accounts with `SELF_MANAGED`\npermissions:\n* You must specify either the `Accounts` or `AccountsUrl`\n property, but not both.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html", "Properties": { "AccountFilterType": { "MarkdownDocumentation": "`AccountFilterType`\n\nRefines which accounts to deploy stacks to by specifying how to use the\n`Accounts` and `OrganizationalUnitIds` properties\ntogether.\nThe following values determine how CloudFormation selects target\naccounts:\n* `INTERSECTION`: StackSet deploys to the accounts specified in the\n `Accounts` property.\n* `DIFFERENCE`: StackSet deploys to the OU, excluding the accounts\n specified in the `Accounts` property.\n* `UNION`: StackSet deploys to the OU, and the accounts specified in\n the `Accounts` property. `UNION` is not supported for\n create operations when using StackSet as a resource or the\n `CreateStackInstances` API.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | UNION | INTERSECTION...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "UNION", "INTERSECTION", "DIFFERENCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountfiltertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Accounts": { "MarkdownDocumentation": "`Accounts`\n\nThe account IDs of the AWS accounts. If you have many account numbers,\nyou can provide those accounts using the `AccountsUrl` property\ninstead.\n*Pattern*: `^[0-9]{12}$`\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AccountsUrl": { "MarkdownDocumentation": "`AccountsUrl`\n\nThe Amazon S3 URL path to a file that contains a list of AWS account IDs. The file\nformat must be either `.csv` or `.txt`, and the data can be comma-separated\nor new-line-separated. There is currently a 10MB limit for the data (approximately 800,000\naccounts).\nThis property serves the same purpose as `Accounts` but allows you to specify a\nlarge number of accounts.\n*Required*: No\n*Type*: String\n*Pattern*: `(s3://|http(s?)://).+`\n*Minimum*: `1`\n*Maximum*: `5120`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountsurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OrganizationalUnitIds": { "MarkdownDocumentation": "`OrganizationalUnitIds`\n\nThe organization root ID or organizational unit (OU) IDs.\n*Pattern*:\n`^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$`\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-organizationalunitids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudFormation::StackSet.ManagedExecution": { "MarkdownDocumentation": "`AWS::CloudFormation::StackSet.ManagedExecution`\n\nDescribes whether StackSets performs non-conflicting operations concurrently and queues\nconflicting operations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html", "Properties": { "Active": { "MarkdownDocumentation": "`Active`\n\nWhen `true`, CloudFormation performs non-conflicting operations concurrently and\nqueues conflicting operations. After conflicting operations finish, CloudFormation starts queued\noperations in request order.\n###### Note\nIf there are already running or queued operations, CloudFormation queues all incoming\noperations even if they are non-conflicting.\nYou can't modify your StackSet's execution configuration while there are running or queued\noperations for that StackSet.\nWhen `false` (default), StackSets performs one operation at a time in request\norder.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html#cfn-cloudformation-stackset-managedexecution-active", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::CloudFormation::StackSet.OperationPreferences": { "MarkdownDocumentation": "`AWS::CloudFormation::StackSet.OperationPreferences`\n\nThe user-specified preferences for how CloudFormation performs a StackSet\noperation. For more information on maximum concurrent accounts and failure tolerance,\nsee [StackSet operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) in the *CloudFormation User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html", "Properties": { "MaxConcurrentPercentage": { "MarkdownDocumentation": "`MaxConcurrentPercentage`\n\nThe maximum percentage of accounts in which to perform this operation at one\ntime.\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases\nwhere rounding down would result is zero. In this case, CloudFormation sets the\nnumber as one instead.\nNote that this setting lets you specify the *maximum* for\noperations. For large deployments, under certain circumstances the actual number of\naccounts acted upon concurrently may be lower due to service throttling.\nConditional: You must specify either `MaxConcurrentCount` or\n`MaxConcurrentPercentage`, but not both.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentpercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RegionConcurrencyType": { "MarkdownDocumentation": "`RegionConcurrencyType`\n\nThe concurrency type of deploying StackSets operations in Regions, could be in parallel or\none Region at a time.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEQUENTIAL | PARALLEL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEQUENTIAL", "PARALLEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionconcurrencytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxConcurrentCount": { "MarkdownDocumentation": "`MaxConcurrentCount`\n\nThe maximum number of accounts in which to perform this operation at one time. This is\ndependent on the value of `FailureToleranceCount`.\n`MaxConcurrentCount` is at most one more than the\n`FailureToleranceCount`.\nNote that this setting lets you specify the *maximum* for\noperations. For large deployments, under certain circumstances the actual number of\naccounts acted upon concurrently may be lower due to service throttling.\nConditional: You must specify either `MaxConcurrentCount` or\n`MaxConcurrentPercentage`, but not both.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "FailureTolerancePercentage": { "MarkdownDocumentation": "`FailureTolerancePercentage`\n\nThe percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a\nRegion, CloudFormation doesn't attempt the operation in any subsequent\nRegions.\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds *down* to the next whole number.\nConditional: You must specify either `FailureToleranceCount` or\n`FailureTolerancePercentage`, but not both.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancepercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ConcurrencyMode": { "MarkdownDocumentation": "`ConcurrencyMode`\n\nSpecifies how the concurrency level behaves during the operation execution.\n* `STRICT_FAILURE_TOLERANCE`: This option dynamically lowers the concurrency\n level to ensure the number of failed accounts never exceeds the value of\n `FailureToleranceCount` +1. The initial actual concurrency is set to the lower of\n either the value of the `MaxConcurrentCount`, or the value of\n `FailureToleranceCount` +1. The actual concurrency is then reduced proportionally\n by the number of failures. This is the default behavior.\n \n If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior\n is similar.\n* `SOFT_FAILURE_TOLERANCE`: This option decouples\n `FailureToleranceCount` from the actual concurrency. This allows StackSet\n operations to run at the concurrency level set by the `MaxConcurrentCount` value, or\n `MaxConcurrentPercentage`, regardless of the number of failures.\n*Required*: No\n*Type*: String\n*Allowed values*: `STRICT_FAILURE_TOLERANCE | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRICT_FAILURE_TOLERANCE", "SOFT_FAILURE_TOLERANCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-concurrencymode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FailureToleranceCount": { "MarkdownDocumentation": "`FailureToleranceCount`\n\nThe number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a\nRegion, CloudFormation doesn't attempt the operation in any subsequent\nRegions.\nConditional: You must specify either `FailureToleranceCount` or\n`FailureTolerancePercentage` (but not both).\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RegionOrder": { "MarkdownDocumentation": "`RegionOrder`\n\nThe order of the Regions where you want to perform the stack operation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionorder", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CloudFormation::StackSet.Parameter": { "MarkdownDocumentation": "`AWS::CloudFormation::StackSet.Parameter`\n\nThe Parameter data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nThe input value associated with the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterKey": { "MarkdownDocumentation": "`ParameterKey`\n\nThe key associated with the parameter. If you don't specify a key and value for a\nparticular parameter, CloudFormation uses the default value that's specified in\nyour template.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parameterkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFormation::StackSet.StackInstances": { "MarkdownDocumentation": "`AWS::CloudFormation::StackSet.StackInstances`\n\nStack instances in some specific accounts and Regions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html", "Properties": { "ParameterOverrides": { "MarkdownDocumentation": "`ParameterOverrides`\n\nA list of StackSet parameters whose values you want to override in the selected stack\ninstances.\n*Required*: No\n*Type*: Array of [Parameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-parameteroverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Parameter", "DuplicatesAllowed": false }, "DeploymentTargets": { "MarkdownDocumentation": "`DeploymentTargets`\n\nThe AWS Organizations accounts or AWS accounts to deploy stacks to\nin the specified Regions.\n*Required*: Yes\n*Type*: [DeploymentTargets](./aws-properties-cloudformation-stackset-deploymenttargets.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-deploymenttargets", "UpdateType": "Mutable", "Required": true, "Type": "DeploymentTargets" }, "Regions": { "MarkdownDocumentation": "`Regions`\n\nThe names of one or more Regions where you want to create stack instances using the\nspecified AWS accounts.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-regions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudFormation::TypeActivation.LoggingConfig": { "MarkdownDocumentation": "`AWS::CloudFormation::TypeActivation.LoggingConfig`\n\nContains logging configuration information for an extension.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html", "Properties": { "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the\nextension's handlers.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\.\\-_/#A-Za-z0-9]+$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-loggroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogRoleArn": { "MarkdownDocumentation": "`LogRoleArn`\n\nThe Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log\nentries to CloudWatch Logs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-logrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::AnycastIpList.AnycastIpList": { "MarkdownDocumentation": "`AWS::CloudFront::AnycastIpList.AnycastIpList`\n\nAn Anycast static IP list. For more information, see [Request Anycast static IPs to use for allowlisting](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/request-static-ips.html) in the *Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address type for the Anycast static IP list.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | dualstack...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "dualstack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the Anycast static IP list. Valid values: `Deployed`, `Deploying`, or `Failed`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IpCount": { "MarkdownDocumentation": "`IpCount`\n\nThe number of IP addresses in the Anycast static IP list.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-ipcount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "AnycastIps": { "MarkdownDocumentation": "`AnycastIps`\n\nThe static IP addresses that are allocated to the Anycast static IP list.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-anycastips", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LastModifiedTime": { "MarkdownDocumentation": "`LastModifiedTime`\n\nThe last time the Anycast static IP list was 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-lastmodifiedtime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the Anycast static IP list.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the Anycast static IP list.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IpamCidrConfigResults": { "MarkdownDocumentation": "`IpamCidrConfigResults`\n\nThe results for the IPAM CIDRs that defines a specific IP address range, IPAM pool, and associated Anycast IP address.\n*Required*: No\n*Type*: Array of [IpamCidrConfigResult](./aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-ipamcidrconfigresults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpamCidrConfigResult", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Anycast static IP list.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_]{1,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-anycastiplist.html#cfn-cloudfront-anycastiplist-anycastiplist-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::AnycastIpList.IpamCidrConfig": { "MarkdownDocumentation": "`AWS::CloudFront::AnycastIpList.IpamCidrConfig`\n\nConfiguration for an IPAM CIDR that defines a specific IP address range, IPAM pool, and associated Anycast IP address.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-ipamcidrconfig.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR that specifies the IP address range for this IPAM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-ipamcidrconfig.html#cfn-cloudfront-anycastiplist-ipamcidrconfig-cidr", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IpamPoolArn": { "MarkdownDocumentation": "`IpamPoolArn`\n\nThe Amazon Resource Name (ARN) of the IPAM pool that the CIDR block is assigned 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-ipamcidrconfig.html#cfn-cloudfront-anycastiplist-ipamcidrconfig-ipampoolarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::AnycastIpList.IpamCidrConfigResult": { "MarkdownDocumentation": "`AWS::CloudFront::AnycastIpList.IpamCidrConfigResult`\n\nThe result for the IPAM CIDR that defines a specific IP address range, IPAM pool, and associated Anycast IP address.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe current status of the IPAM CIDR configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `provisioned | failed-provis...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "provisioned", "failed-provision", "provisioning", "deprovisioned", "failed-deprovision", "deprovisioning", "advertised", "failed-advertise", "advertising", "withdrawn", "failed-withdraw", "withdrawing" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult.html#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AnycastIp": { "MarkdownDocumentation": "`AnycastIp`\n\nThe specified Anycast IP address allocated from the IPAM pool for this CIDR 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult.html#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-anycastip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR that specifies the IP address range for this IPAM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult.html#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-cidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpamPoolArn": { "MarkdownDocumentation": "`IpamPoolArn`\n\nThe Amazon Resource Name (ARN) of the IPAM pool that the CIDR block is assigned 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-ipamcidrconfigresult.html#cfn-cloudfront-anycastiplist-ipamcidrconfigresult-ipampoolarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::AnycastIpList.Tags": { "MarkdownDocumentation": "`AWS::CloudFront::AnycastIpList.Tags`\n\nA complex type that contains zero or more `Tag` elements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-tags.html", "Properties": { "Items": { "MarkdownDocumentation": "`Items`\n\nA complex type that contains `Tag` elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudfront-anycastiplist-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-anycastiplist-tags.html#cfn-cloudfront-anycastiplist-tags-items", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::CloudFront::CachePolicy.CachePolicyConfig": { "MarkdownDocumentation": "`AWS::CloudFront::CachePolicy.CachePolicyConfig`\n\nA cache policy configuration.\nThis configuration determines the following:\n* The values that CloudFront includes in the cache key. These values can include HTTP\n headers, cookies, and URL query strings. CloudFront uses the cache key to find an\n object in its cache that it can return to the viewer.\n* The default, minimum, and maximum time to live (TTL) values that you want\n objects to stay in the CloudFront cache.\n \n ###### Important\n \n If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the `Cache-Control: no-cache`, `no-store`, or `private` directives are present in the origin headers.\nThe headers, cookies, and query strings that are included in the cache key are also included\nin requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a\nvalid object in its cache that matches the request's cache key. If you want to send\nvalues to the origin but *not* include them in the cache key, use\n`OriginRequestPolicy`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA comment to describe the cache policy. The comment cannot be longer than 128\ncharacters.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html#cfn-cloudfront-cachepolicy-cachepolicyconfig-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinTTL": { "MarkdownDocumentation": "`MinTTL`\n\nThe minimum amount of time, in seconds, that you want objects to stay in the CloudFront\ncache before CloudFront sends another request to the origin to see if the object has been\nupdated. 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\n*Amazon CloudFront Developer Guide*.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html#cfn-cloudfront-cachepolicy-cachepolicyconfig-minttl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MaxTTL": { "MarkdownDocumentation": "`MaxTTL`\n\nThe maximum amount of time, in seconds, that objects stay in the CloudFront cache before\nCloudFront sends another request to the origin to see if the object has been updated. CloudFront\nuses this value only when the origin sends `Cache-Control` or\n`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\n*Amazon CloudFront Developer Guide*.\nThe default value for this field is 31536000 seconds (one year). If the value of\n`MinTTL` or `DefaultTTL` is more than 31536000 seconds, then\nthe default value for this field is the same as the value of\n`DefaultTTL`.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html#cfn-cloudfront-cachepolicy-cachepolicyconfig-maxttl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "ParametersInCacheKeyAndForwardedToOrigin": { "MarkdownDocumentation": "`ParametersInCacheKeyAndForwardedToOrigin`\n\nThe HTTP headers, cookies, and URL query strings to include in the cache key. The values\nincluded in the cache key are also included in requests that CloudFront sends to the\norigin.\n*Required*: Yes\n*Type*: [ParametersInCacheKeyAndForwardedToOrigin](./aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html#cfn-cloudfront-cachepolicy-cachepolicyconfig-parametersincachekeyandforwardedtoorigin", "UpdateType": "Mutable", "Required": true, "Type": "ParametersInCacheKeyAndForwardedToOrigin" }, "DefaultTTL": { "MarkdownDocumentation": "`DefaultTTL`\n\nThe default amount of time, in seconds, that you want objects to stay in the CloudFront\ncache before CloudFront sends another request to the origin to see if the object has been\nupdated. CloudFront uses this value as the object's time to live (TTL) only when the origin\ndoes *not* send `Cache-Control` or `Expires`\nheaders 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\n*Amazon CloudFront Developer Guide*.\nThe default value for this field is 86400 seconds (one day). If the value of\n`MinTTL` is more than 86400 seconds, then the default value for this\nfield is the same as the value of `MinTTL`.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html#cfn-cloudfront-cachepolicy-cachepolicyconfig-defaultttl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html#cfn-cloudfront-cachepolicy-cachepolicyconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::CachePolicy.CookiesConfig": { "MarkdownDocumentation": "`AWS::CloudFront::CachePolicy.CookiesConfig`\n\nAn object that determines whether any cookies in viewer requests (and if so, which cookies)\nare included in the cache key and in requests that CloudFront sends to the origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cookiesconfig.html", "Properties": { "Cookies": { "MarkdownDocumentation": "`Cookies`\n\nContains a list of cookie names.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cookiesconfig.html#cfn-cloudfront-cachepolicy-cookiesconfig-cookies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CookieBehavior": { "MarkdownDocumentation": "`CookieBehavior`\n\nDetermines whether any cookies in viewer requests are included in the cache key and in\nrequests that CloudFront sends to the origin. Valid values are:\n* `none` \u2013 No cookies in viewer requests are included in the cache key or in\n requests that CloudFront sends to the origin. Even when this field is set to\n `none`, any cookies that are listed in an\n `OriginRequestPolicy`*are* included in origin\n requests.\n* `whitelist` \u2013 Only the cookies in viewer requests that are listed in the\n `CookieNames` type are included in the cache key and in requests that\n CloudFront sends to the origin.\n* `allExcept` \u2013 All cookies in viewer requests are included in the cache key and\n in requests that CloudFront sends to the origin, ***except*** for those that are listed in the\n `CookieNames` type, which are not included.\n* `all` \u2013 All cookies in viewer requests are included in the cache key and in\n requests that CloudFront sends to the origin.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(none|whitelist|allExcept|all)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cookiesconfig.html#cfn-cloudfront-cachepolicy-cookiesconfig-cookiebehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::CachePolicy.HeadersConfig": { "MarkdownDocumentation": "`AWS::CloudFront::CachePolicy.HeadersConfig`\n\nAn object that determines whether any HTTP headers (and if so, which headers) are included\nin the cache key and in requests that CloudFront sends to the origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-headersconfig.html", "Properties": { "Headers": { "MarkdownDocumentation": "`Headers`\n\nContains a list of HTTP header names.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-headersconfig.html#cfn-cloudfront-cachepolicy-headersconfig-headers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "HeaderBehavior": { "MarkdownDocumentation": "`HeaderBehavior`\n\nDetermines whether any HTTP headers are included in the cache key and in requests that CloudFront\nsends to the origin. Valid values are:\n* `none` \u2013 No HTTP headers are included in the cache key or in requests that CloudFront\n sends to the origin. Even when this field is set to `none`, any\n headers that are listed in an `OriginRequestPolicy`*are* included in origin requests.\n* `whitelist` \u2013 Only the HTTP headers that are listed in the `Headers`\n type are included in the cache key and in requests that CloudFront sends to the\n origin.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-headersconfig.html#cfn-cloudfront-cachepolicy-headersconfig-headerbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::CachePolicy.ParametersInCacheKeyAndForwardedToOrigin": { "MarkdownDocumentation": "`AWS::CloudFront::CachePolicy.ParametersInCacheKeyAndForwardedToOrigin`\n\nThis object determines the values that CloudFront includes in the cache key. These values\ncan include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to\nfind an object in its cache that it can return to the viewer.\nThe headers, cookies, and query strings that are included in the cache key are also included\nin requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an\nobject in its cache that matches the request's cache key. If you want to send values to\nthe origin but *not* include them in the cache key, use\n`OriginRequestPolicy`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.html", "Properties": { "EnableAcceptEncodingBrotli": { "MarkdownDocumentation": "`EnableAcceptEncodingBrotli`\n\nA flag that can affect whether the `Accept-Encoding` HTTP header is\nincluded 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\nboth of these fields is `true`*and* the viewer request includes the `Accept-Encoding`\nheader, then CloudFront does the following:\n* Normalizes the value of the viewer's `Accept-Encoding`\n 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\n 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\n*Amazon CloudFront Developer Guide*.\nIf you set this value to `true`, and this cache behavior also has an origin\nrequest policy attached, do not include the `Accept-Encoding` header in the\norigin request policy. CloudFront always includes the `Accept-Encoding` header in\norigin requests when the value of this field is `true`, so including this\nheader in an origin request policy has no effect.\nIf both of these fields are `false`, then CloudFront treats the\n`Accept-Encoding` header the same as any other HTTP header in the viewer\nrequest. By default, it's not included in the cache key and it's not included in origin\nrequests. In this case, you can manually add `Accept-Encoding` to the headers\nwhitelist 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.html#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-enableacceptencodingbrotli", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "HeadersConfig": { "MarkdownDocumentation": "`HeadersConfig`\n\nAn object that determines whether any HTTP headers (and if so, which headers) are included\nin the cache key and in requests that CloudFront sends to the origin.\n*Required*: Yes\n*Type*: [HeadersConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.html#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-headersconfig", "UpdateType": "Mutable", "Required": true, "Type": "HeadersConfig" }, "CookiesConfig": { "MarkdownDocumentation": "`CookiesConfig`\n\nAn object that determines whether any cookies in viewer requests (and if so, which cookies)\nare included in the cache key and in requests that CloudFront sends to the origin.\n*Required*: Yes\n*Type*: [CookiesConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.html#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-cookiesconfig", "UpdateType": "Mutable", "Required": true, "Type": "CookiesConfig" }, "EnableAcceptEncodingGzip": { "MarkdownDocumentation": "`EnableAcceptEncodingGzip`\n\nA flag that can affect whether the `Accept-Encoding` HTTP header is\nincluded 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\nboth of these fields is `true`*and* the viewer request includes the `Accept-Encoding`\nheader, then CloudFront does the following:\n* Normalizes the value of the viewer's `Accept-Encoding`\n 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\n 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\n*Amazon CloudFront Developer Guide*.\nIf you set this value to `true`, and this cache behavior also has an origin\nrequest policy attached, do not include the `Accept-Encoding` header in the\norigin request policy. CloudFront always includes the `Accept-Encoding` header in\norigin requests when the value of this field is `true`, so including this\nheader in an origin request policy has no effect.\nIf both of these fields are `false`, then CloudFront treats the\n`Accept-Encoding` header the same as any other HTTP header in the viewer\nrequest. By default, it's not included in the cache key and it's not included in origin\nrequests. In this case, you can manually add `Accept-Encoding` to the headers\nwhitelist 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.html#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-enableacceptencodinggzip", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "QueryStringsConfig": { "MarkdownDocumentation": "`QueryStringsConfig`\n\nAn object that determines whether any URL query strings in viewer requests (and if so, which\nquery strings) are included in the cache key and in requests that CloudFront sends to the\norigin.\n*Required*: Yes\n*Type*: [QueryStringsConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin.html#cfn-cloudfront-cachepolicy-parametersincachekeyandforwardedtoorigin-querystringsconfig", "UpdateType": "Mutable", "Required": true, "Type": "QueryStringsConfig" } } }, "AWS::CloudFront::CachePolicy.QueryStringsConfig": { "MarkdownDocumentation": "`AWS::CloudFront::CachePolicy.QueryStringsConfig`\n\nAn object that determines whether any URL query strings in viewer requests (and if so, which\nquery strings) are included in the cache key and in requests that CloudFront sends to the\norigin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-querystringsconfig.html", "Properties": { "QueryStrings": { "MarkdownDocumentation": "`QueryStrings`\n\nContains a list of query string names.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-querystringsconfig.html#cfn-cloudfront-cachepolicy-querystringsconfig-querystrings", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "QueryStringBehavior": { "MarkdownDocumentation": "`QueryStringBehavior`\n\nDetermines whether any URL query strings in viewer requests are included in the cache key\nand in requests that CloudFront sends to the origin. Valid values are:\n* `none` \u2013 No query strings in viewer requests are included in the cache key or\n in requests that CloudFront sends to the origin. Even when this field is set to\n `none`, any query strings that are listed in an\n `OriginRequestPolicy`*are* included in origin\n requests.\n* `whitelist` \u2013 Only the query strings in viewer requests that are listed in the\n `QueryStringNames` type are included in the cache key and in requests\n that CloudFront sends to the origin.\n* `allExcept` \u2013 All query strings in viewer requests are included in the cache\n key and in requests that CloudFront sends to the origin, ***except*** those that are listed in the\n `QueryStringNames` type, which are not included.\n* `all` \u2013 All query strings in viewer requests are included in the cache key and\n in requests that CloudFront sends to the origin.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(none|whitelist|allExcept|all)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-querystringsconfig.html#cfn-cloudfront-cachepolicy-querystringsconfig-querystringbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig": { "MarkdownDocumentation": "`AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig`\n\nOrigin access identity configuration. Send a `GET` request to the\n`/CloudFront API version/CloudFront/identity ID/config`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA comment to describe the origin access identity. The comment cannot be longer than\n128 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.html#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-comment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::ConnectionFunction.ConnectionFunctionConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ConnectionFunction.ConnectionFunctionConfig`\n\nContains configuration information about a CloudFront function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-connectionfunction-connectionfunctionconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-connectionfunction-connectionfunctionconfig.html#cfn-cloudfront-connectionfunction-connectionfunctionconfig-comment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nThe function's runtime environment version.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `cloudfront-js-2.0...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "cloudfront-js-2.0" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-connectionfunction-connectionfunctionconfig.html#cfn-cloudfront-connectionfunction-connectionfunctionconfig-runtime", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KeyValueStoreAssociations": { "MarkdownDocumentation": "`KeyValueStoreAssociations`\n\nThe configuration for the key value store associations.\n*Required*: No\n*Type*: Array of [KeyValueStoreAssociation](./aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-connectionfunction-connectionfunctionconfig.html#cfn-cloudfront-connectionfunction-connectionfunctionconfig-keyvaluestoreassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValueStoreAssociation", "DuplicatesAllowed": false } } }, "AWS::CloudFront::ConnectionFunction.KeyValueStoreAssociation": { "MarkdownDocumentation": "`AWS::CloudFront::ConnectionFunction.KeyValueStoreAssociation`\n\nThe key value store association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation.html", "Properties": { "KeyValueStoreARN": { "MarkdownDocumentation": "`KeyValueStoreARN`\n\nThe Amazon Resource Name (ARN) of the key value store association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws:cloudfront::[0-9]{12}:key-value-store\\/[0-9a-fA-F-]{36}`\n*Minimum*: `0`\n*Maximum*: `85`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-connectionfunction-keyvaluestoreassociation.html#cfn-cloudfront-connectionfunction-keyvaluestoreassociation-keyvaluestorearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::ContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfig`\n\nContains the configuration for a continuous deployment policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of traffic configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `SingleWeight | SingleHeader...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SingleWeight", "SingleHeader" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SingleHeaderPolicyConfig": { "MarkdownDocumentation": "`SingleHeaderPolicyConfig`\n\nThis configuration determines which HTTP requests are sent to the staging\ndistribution. If the HTTP request contains a header and value that matches what you\nspecify here, the request is sent to the staging distribution. Otherwise the request is\nsent to the primary distribution.\n*Required*: No\n*Type*: [SingleHeaderPolicyConfig](./aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-singleheaderpolicyconfig", "UpdateType": "Mutable", "Required": false, "Type": "SingleHeaderPolicyConfig" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nA Boolean that indicates whether this continuous deployment policy is enabled (in\neffect). When this value is `true`, this policy is enabled and in effect.\nWhen this value is `false`, this policy is not enabled and has no\neffect.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "StagingDistributionDnsNames": { "MarkdownDocumentation": "`StagingDistributionDnsNames`\n\nThe CloudFront domain name of the staging distribution. For example:\n`d111111abcdef8.cloudfront.net`.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-stagingdistributiondnsnames", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "TrafficConfig": { "MarkdownDocumentation": "`TrafficConfig`\n\nContains the parameters for routing production traffic from your primary to staging\ndistributions.\n*Required*: No\n*Type*: [TrafficConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-trafficconfig", "UpdateType": "Mutable", "Required": false, "Type": "TrafficConfig" }, "SingleWeightPolicyConfig": { "MarkdownDocumentation": "`SingleWeightPolicyConfig`\n\nThis configuration determines the percentage of HTTP requests that are sent to the\nstaging distribution.\n*Required*: No\n*Type*: [SingleWeightPolicyConfig](./aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig-singleweightpolicyconfig", "UpdateType": "Mutable", "Required": false, "Type": "SingleWeightPolicyConfig" } } }, "AWS::CloudFront::ContinuousDeploymentPolicy.SessionStickinessConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ContinuousDeploymentPolicy.SessionStickinessConfig`\n\nSession stickiness provides the ability to define multiple requests from a single\nviewer as a single session. This prevents the potentially inconsistent experience of\nsending some of a given user's requests to your staging distribution, while others are\nsent to your primary distribution. Define the session duration using TTL values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.html", "Properties": { "IdleTTL": { "MarkdownDocumentation": "`IdleTTL`\n\nThe amount of time after which you want sessions to cease if no requests are\nreceived. Allowed values are 300\u20133600 seconds (5\u201360 minutes).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `300`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.html#cfn-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-idlettl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "MaximumTTL": { "MarkdownDocumentation": "`MaximumTTL`\n\nThe maximum amount of time to consider requests from the viewer as being part of the same\nsession. Allowed values are 300\u20133600 seconds (5\u201360 minutes).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `300`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.html#cfn-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig-maximumttl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderConfig`\n\nDetermines which HTTP requests are sent to the staging distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig.html", "Properties": { "Header": { "MarkdownDocumentation": "`Header`\n\nThe request header name that you want CloudFront to send to your staging\ndistribution. The header must contain the prefix `aws-cf-cd-`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig.html#cfn-cloudfront-continuousdeploymentpolicy-singleheaderconfig-header", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe request header value.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1783`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig.html#cfn-cloudfront-continuousdeploymentpolicy-singleheaderconfig-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderPolicyConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderPolicyConfig`\n\nDefines a single header policy for a CloudFront distribution.\n###### Note\nThis property is legacy. We recommend that you use [TrafficConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html) and specify the [SingleHeaderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleheaderconfig) property instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig.html", "Properties": { "Header": { "MarkdownDocumentation": "`Header`\n\nThe name of the HTTP header that CloudFront uses to configure for the single header policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-header", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nSpecifies the value to assign to the header for a single header policy.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1783`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-singleheaderpolicyconfig-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightConfig`\n\nThis configuration determines the percentage of HTTP requests that are sent to the\nstaging distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig.html", "Properties": { "SessionStickinessConfig": { "MarkdownDocumentation": "`SessionStickinessConfig`\n\nSession stickiness provides the ability to define multiple requests from a single\nviewer as a single session. This prevents the potentially inconsistent experience of\nsending some of a given user's requests to your staging distribution, while others are\nsent to your primary distribution. Define the session duration using TTL values.\n*Required*: No\n*Type*: [SessionStickinessConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig.html#cfn-cloudfront-continuousdeploymentpolicy-singleweightconfig-sessionstickinessconfig", "UpdateType": "Mutable", "Required": false, "Type": "SessionStickinessConfig" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe percentage of traffic to send to a staging distribution, expressed as a decimal\nnumber between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig.html#cfn-cloudfront-continuousdeploymentpolicy-singleweightconfig-weight", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightPolicyConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightPolicyConfig`\n\nConfigure a policy that CloudFront uses to route requests to different origins or use different cache settings, based on the weight assigned to each option.\n###### Note\nThis property is legacy. We recommend that you use [TrafficConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html) and specify the [SingleWeightConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleweightconfig) property instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig.html", "Properties": { "SessionStickinessConfig": { "MarkdownDocumentation": "`SessionStickinessConfig`\n\nEnable session stickiness for the associated origin or cache settings.\n*Required*: No\n*Type*: [SessionStickinessConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-sessionstickinessconfig", "UpdateType": "Mutable", "Required": false, "Type": "SessionStickinessConfig" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe percentage of requests that CloudFront will use to send to an associated origin or cache settings.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig.html#cfn-cloudfront-continuousdeploymentpolicy-singleweightpolicyconfig-weight", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::CloudFront::ContinuousDeploymentPolicy.TrafficConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ContinuousDeploymentPolicy.TrafficConfig`\n\nThe traffic configuration of your continuous deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html", "Properties": { "SingleWeightConfig": { "MarkdownDocumentation": "`SingleWeightConfig`\n\nContains the percentage of traffic to send to the staging distribution.\n*Required*: No\n*Type*: [SingleWeightConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleweightconfig", "UpdateType": "Mutable", "Required": false, "Type": "SingleWeightConfig" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of traffic configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SingleWeight | SingleHeader...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SingleWeight", "SingleHeader" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SingleHeaderConfig": { "MarkdownDocumentation": "`SingleHeaderConfig`\n\nDetermines which HTTP requests are sent to the staging distribution.\n*Required*: No\n*Type*: [SingleHeaderConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html#cfn-cloudfront-continuousdeploymentpolicy-trafficconfig-singleheaderconfig", "UpdateType": "Mutable", "Required": false, "Type": "SingleHeaderConfig" } } }, "AWS::CloudFront::Distribution.CacheBehavior": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.CacheBehavior`\n\nA complex type that describes how CloudFront processes requests.\nYou must create at least as many cache behaviors (including the default cache\nbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\nEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\nyou have two origins and only the default cache behavior, the default cache behavior\nwill cause CloudFront to get objects from one of the origins, but the other origin is never\nused.\nFor the current quota (formerly known as limit) on the number of cache behaviors that\nyou can add to a distribution, see [Quotas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) in the\n*Amazon CloudFront Developer Guide*.\nIf you don't want to specify any cache behaviors, include only an empty\n`CacheBehaviors` element. Don't specify an empty individual\n`CacheBehavior` element, because this is invalid. For more information,\nsee [CacheBehaviors](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html).\nTo delete all cache behaviors in an existing distribution, update the distribution\nconfiguration and include only an empty `CacheBehaviors` element.\nTo add, change, or remove one or more cache behaviors, update the distribution\nconfiguration and specify all of the cache behaviors that you want to include in the\nupdated distribution.\n###### Important\nIf your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the `Cache-Control: no-cache`, `no-store`, or `private` directives are present in the origin headers.\nFor more information about cache behaviors, see [Cache Behavior Settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) in the *Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html", "Properties": { "Compress": { "MarkdownDocumentation": "`Compress`\n\nWhether you want CloudFront to automatically compress certain files for this cache behavior.\nIf so, specify true; if not, specify false. For more information, see [Serving\nCompressed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-compress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FunctionAssociations": { "MarkdownDocumentation": "`FunctionAssociations`\n\nA list of CloudFront functions that are associated with this cache behavior. CloudFront functions\nmust be published to the `LIVE` stage to associate them with a cache\nbehavior.\n*Required*: No\n*Type*: Array of [FunctionAssociation](./aws-properties-cloudfront-distribution-functionassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-functionassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FunctionAssociation", "DuplicatesAllowed": true }, "LambdaFunctionAssociations": { "MarkdownDocumentation": "`LambdaFunctionAssociations`\n\nA complex type that contains zero or more Lambda@Edge function associations for a\ncache behavior.\n*Required*: No\n*Type*: Array of [LambdaFunctionAssociation](./aws-properties-cloudfront-distribution-lambdafunctionassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-lambdafunctionassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LambdaFunctionAssociation", "DuplicatesAllowed": true }, "TargetOriginId": { "MarkdownDocumentation": "`TargetOriginId`\n\nThe value of `ID` for the origin that you want CloudFront to route requests to\nwhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-targetoriginid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ViewerProtocolPolicy": { "MarkdownDocumentation": "`ViewerProtocolPolicy`\n\nThe protocol that viewers can use to access the files in the origin specified by\n`TargetOriginId` when a request matches the path pattern in\n`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\n returns an HTTP status code of 301 (Moved Permanently) to the viewer along with\n 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\n 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\n*Amazon CloudFront Developer Guide*.\n###### Note\nThe only way to guarantee that viewers retrieve an object that was fetched from\nthe origin using HTTPS is never to use any other protocol to fetch the object. If\nyou have recently changed from HTTP to HTTPS, we recommend that you clear your\nobjects' cache because cached objects are protocol agnostic. That means that an edge\nlocation will return an object from the cache regardless of whether the current\nrequest protocol matches the protocol used previously. For more information, see\n[Managing Cache\nExpiration](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 | re...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "allow-all", "https-only", "redirect-to-https" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-viewerprotocolpolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResponseHeadersPolicyId": { "MarkdownDocumentation": "`ResponseHeadersPolicyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-responseheaderspolicyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GrpcConfig": { "MarkdownDocumentation": "`GrpcConfig`\n\nThe gRPC configuration for your cache behavior.\n*Required*: No\n*Type*: [GrpcConfig](./aws-properties-cloudfront-distribution-grpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-grpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "GrpcConfig" }, "RealtimeLogConfigArn": { "MarkdownDocumentation": "`RealtimeLogConfigArn`\n\nThe Amazon Resource Name (ARN) of the real-time log configuration that is attached to\nthis cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-realtimelogconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustedSigners": { "MarkdownDocumentation": "`TrustedSigners`\n\n###### Important\nWe recommend using `TrustedKeyGroups` instead of\n`TrustedSigners`.\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or\nsigned cookies.\nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed\ncookies for all requests that match the cache behavior. The URLs or cookies must be\nsigned with the private key of a CloudFront key pair in the trusted signer's AWS account.\nThe signed URL or cookie contains information about which public key CloudFront should use to\nverify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-trustedsigners", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DefaultTTL": { "MarkdownDocumentation": "`DefaultTTL`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThis field is deprecated. We recommend that you use the `DefaultTTL` field\nin 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\n*Amazon CloudFront Developer Guide*.\nThe default amount of time that you want objects to stay in CloudFront caches before CloudFront\nforwards another request to your origin to determine whether the object has been\nupdated. The value that you specify applies only when your origin does not add HTTP\nheaders such as `Cache-Control max-age`, `Cache-Control s-maxage`,\nand `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\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-defaultttl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FieldLevelEncryptionId": { "MarkdownDocumentation": "`FieldLevelEncryptionId`\n\nThe value of `ID` for the field-level encryption configuration that you\nwant 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-fieldlevelencryptionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustedKeyGroups": { "MarkdownDocumentation": "`TrustedKeyGroups`\n\nA list of key groups that CloudFront can use to validate signed URLs or signed\ncookies.\nWhen a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\ncookies for all requests that match the cache behavior. The URLs or cookies must be\nsigned with a private key whose corresponding public key is in the key group. The signed\nURL or cookie contains information about which public key CloudFront should use to verify the\nsignature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-trustedkeygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedMethods": { "MarkdownDocumentation": "`AllowedMethods`\n\nA complex type that controls which HTTP methods CloudFront processes and forwards to your\nAmazon 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\n `OPTIONS` requests.\n* CloudFront forwards `GET, HEAD, OPTIONS, PUT, PATCH, POST`, and\n `DELETE` requests.\nIf you pick the third choice, you may need to restrict access to your Amazon S3 bucket or\nto your custom origin so users can't perform operations that you don't want them to. For\nexample, you might not want users to have permissions to delete objects from your\norigin.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-allowedmethods", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PathPattern": { "MarkdownDocumentation": "`PathPattern`\n\nThe pattern (for example, `images/*.jpg`) that specifies which requests to\napply the behavior to. When CloudFront receives a viewer request, the requested path is\ncompared with path patterns in the order in which cache behaviors are listed in the\ndistribution.\n###### Note\nYou can optionally include a slash (`/`) at the beginning of the path\npattern. For example, `/images/*.jpg`. CloudFront behavior is the same with or\nwithout the leading `/`.\nThe path pattern for the default cache behavior is `*` and cannot be\nchanged. If the request for an object does not match the path pattern for any cache\nbehaviors, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-pathpattern", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CachedMethods": { "MarkdownDocumentation": "`CachedMethods`\n\nA complex type that controls whether CloudFront caches the response to requests using the\nspecified HTTP methods. There are two choices:\n* CloudFront caches responses to `GET` and `HEAD`\n requests.\n* CloudFront caches responses to `GET`, `HEAD`, and\n `OPTIONS` requests.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward\nAccess-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for\nthe responses to be cached correctly.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-cachedmethods", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SmoothStreaming": { "MarkdownDocumentation": "`SmoothStreaming`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nIndicates whether you want to distribute media files in the Microsoft Smooth Streaming\nformat using the origin that is associated with this cache behavior. If so, specify\n`true`; if not, specify `false`. If you specify\n`true` for `SmoothStreaming`, you can still distribute other\ncontent using this cache behavior if the content matches the value of\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-smoothstreaming", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ForwardedValues": { "MarkdownDocumentation": "`ForwardedValues`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the\n*Amazon CloudFront Developer Guide*.\nIf you want to include values in the cache key, use a cache policy. For more\ninformation, 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\n*Amazon CloudFront Developer Guide*.\nIf you want to send values to the origin but not include them in the cache key, use an\norigin 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) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the\n*Amazon CloudFront Developer Guide*.\nA `CacheBehavior` must include either a `CachePolicyId` or\n`ForwardedValues`. We recommend that you use a\n`CachePolicyId`.\nA complex type that specifies how CloudFront handles query strings, cookies, and HTTP\nheaders.\n*Required*: Conditional\n*Type*: [ForwardedValues](./aws-properties-cloudfront-distribution-forwardedvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-forwardedvalues", "UpdateType": "Mutable", "Required": false, "Type": "ForwardedValues" }, "OriginRequestPolicyId": { "MarkdownDocumentation": "`OriginRequestPolicyId`\n\nThe unique identifier of the origin request policy that is attached to this cache\nbehavior. 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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-originrequestpolicyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinTTL": { "MarkdownDocumentation": "`MinTTL`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThis field is deprecated. We recommend that you use the `MinTTL` field in a\ncache 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\n*Amazon CloudFront Developer Guide*.\nThe minimum amount of time that you want objects to stay in CloudFront caches before CloudFront\nforwards another request to your origin to determine whether the object has been\nupdated. For more information, see [Managing How Long\nContent Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\nYou must specify `0` for `MinTTL` if you configure CloudFront to\nforward all headers to your origin (under `Headers`, if you specify\n`1` for `Quantity` and `*` for\n`Name`).\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-minttl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "CachePolicyId": { "MarkdownDocumentation": "`CachePolicyId`\n\nThe unique identifier of the cache policy that is attached to this cache behavior. For\nmore 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\n*Amazon CloudFront Developer Guide*.\nA `CacheBehavior` must include either a `CachePolicyId` or\n`ForwardedValues`. We recommend that you use a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-cachepolicyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxTTL": { "MarkdownDocumentation": "`MaxTTL`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThis field is deprecated. We recommend that you use the `MaxTTL` field in a\ncache 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\n*Amazon CloudFront Developer Guide*.\nThe maximum amount of time that you want objects to stay in CloudFront caches before CloudFront\nforwards another request to your origin to determine whether the object has been\nupdated. The value that you specify applies only when your origin adds HTTP headers such\nas `Cache-Control max-age`, `Cache-Control s-maxage`, and\n`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\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-maxttl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::CloudFront::Distribution.ConnectionFunctionAssociation": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.ConnectionFunctionAssociation`\n\nA connection function association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-connectionfunctionassociation.html", "Properties": { "Id": { "MarkdownDocumentation": "`Id`\n\nThe association's ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-connectionfunctionassociation.html#cfn-cloudfront-distribution-connectionfunctionassociation-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.Cookies": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.Cookies`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field.\nIf you want to include cookies in the cache key, use a cache policy. For more\ninformation, 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\nan 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\n*Amazon CloudFront Developer Guide*.\nA complex type that specifies whether you want CloudFront to forward cookies to the origin\nand, if so, which ones. For more information about forwarding cookies to the origin, see\n[How CloudFront Forwards, Caches,\nand Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html", "Properties": { "WhitelistedNames": { "MarkdownDocumentation": "`WhitelistedNames`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field.\nIf you want to include cookies in the cache key, use a cache policy. For more\ninformation, 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\nan 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\n*Amazon CloudFront Developer Guide*.\nRequired if you specify `whitelist` for the value of `Forward`.\nA complex type that specifies how many different cookies you want CloudFront to forward to the\norigin for this cache behavior and, if you want to forward selected cookies, the names\nof those cookies.\nIf you specify `all` or `none` for the value of\n`Forward`, omit `WhitelistedNames`. If you change the value of\n`Forward` from `whitelist` to `all` or\n`none` and you don't delete the `WhitelistedNames` element and\nits child elements, CloudFront deletes them automatically.\nFor the current limit on the number of cookie names that you can whitelist for each\ncache behavior, see [CloudFront\nLimits](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *AWS General Reference*.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html#cfn-cloudfront-distribution-cookies-whitelistednames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Forward": { "MarkdownDocumentation": "`Forward`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field.\nIf you want to include cookies in the cache key, use a cache policy. For more\ninformation, 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\norigin 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\n*Amazon CloudFront Developer Guide*.\nSpecifies which cookies to forward to the origin for this cache behavior: all, none,\nor the list of cookies specified in the `WhitelistedNames` complex\ntype.\nAmazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an\nAmazon S3 origin, specify none for the `Forward` element.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | whitelist | all...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "whitelist", "all" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html#cfn-cloudfront-distribution-cookies-forward", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.CustomErrorResponse": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.CustomErrorResponse`\n\nA complex type that controls:\n* Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom\n 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\nError Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html", "Properties": { "ResponseCode": { "MarkdownDocumentation": "`ResponseCode`\n\nThe HTTP status code that you want CloudFront to return to the viewer along with the custom\nerror page. There are a variety of reasons that you might want CloudFront to return a status\ncode different from the status code that your origin returned to CloudFront, for\nexample:\n* Some Internet devices (some firewalls and corporate proxies, for example)\n intercept HTTP 4xx and 5xx and prevent the response from being returned to the\n viewer. If you substitute `200`, the response typically won't be\n intercepted.\n* If you don't care about distinguishing among different client errors or server\n errors, you can specify `400` or `500` as the\n `ResponseCode` for all 4xx or 5xx errors.\n* You might want to return a `200` status code (OK) and static\n 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\nfor `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsecode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ErrorCachingMinTTL": { "MarkdownDocumentation": "`ErrorCachingMinTTL`\n\nThe minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status\ncode specified in `ErrorCode`. When this time period has elapsed, CloudFront\nqueries your origin to see whether the problem that caused the error has been resolved\nand the requested object is now available.\nFor more information, see [Customizing\nError Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcachingminttl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ErrorCode": { "MarkdownDocumentation": "`ErrorCode`\n\nThe HTTP status code for which you want to specify a custom error page and/or a\ncaching 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ResponsePagePath": { "MarkdownDocumentation": "`ResponsePagePath`\n\nThe path to the custom error page that you want CloudFront to return to a viewer when your\norigin returns the HTTP status code specified by `ErrorCode`, for example,\n`/4xx-errors/403-forbidden.html`. If you want to store your objects and\nyour custom error pages in different locations, your distribution must include a cache\nbehavior for which the following is true:\n* The value of `PathPattern` matches the path to your custom error\n messages. For example, suppose you saved custom error pages for 4xx errors in an\n Amazon S3 bucket in a directory named `/4xx-errors`. Your distribution\n must include a cache behavior for which the path pattern routes requests for\n your custom error pages to that location, for example,\n `/4xx-errors/*`.\n* The value of `TargetOriginId` specifies the value of the\n `ID` element for the origin that contains your custom error\n pages.\nIf you specify a value for `ResponsePagePath`, you must also specify a\nvalue for `ResponseCode`.\nWe recommend that you store custom error pages in an Amazon S3 bucket. If you store custom\nerror pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get\nthe files that you want to return to viewers because the origin server is\nunavailable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsepagepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.CustomOriginConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.CustomOriginConfig`\n\nA custom origin. A custom origin is any origin that is *not* an\nAmazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with\nstatic website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)*is* a custom origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nSpecifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose `dualstack` to help optimize reliability.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dualstack...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dualstack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OriginReadTimeout": { "MarkdownDocumentation": "`OriginReadTimeout`\n\nSpecifies how long, in seconds, CloudFront waits for a response from the origin. This is\nalso known as the *origin response timeout*. The minimum timeout is 1\nsecond, the maximum is 120 seconds, and the default (if you don't specify otherwise) is\n30 seconds.\nFor more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originreadtimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HTTPSPort": { "MarkdownDocumentation": "`HTTPSPort`\n\nThe HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpsport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginKeepaliveTimeout": { "MarkdownDocumentation": "`OriginKeepaliveTimeout`\n\nSpecifies how long, in seconds, CloudFront persists its connection to the origin. The\nminimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't\nspecify otherwise) is 5 seconds.\nFor more information, see [Keep-alive timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginSSLProtocols": { "MarkdownDocumentation": "`OriginSSLProtocols`\n\nSpecifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin\nover HTTPS. Valid values include `SSLv3`, `TLSv1`,\n`TLSv1.1`, and `TLSv1.2`.\nFor more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originsslprotocols", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "HTTPPort": { "MarkdownDocumentation": "`HTTPPort`\n\nThe HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the\norigin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginProtocolPolicy": { "MarkdownDocumentation": "`OriginProtocolPolicy`\n\nSpecifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid\nvalues are:\n* `http-only` \u2013 CloudFront always uses HTTP to connect to the\n origin.\n* `match-viewer` \u2013 CloudFront connects to the origin using the same\n protocol that the viewer used to connect to CloudFront.\n* `https-only` \u2013 CloudFront always uses HTTPS to connect to the\n origin.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `http-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)", "RefReturnValue": "", "AllowedValues": [ "http-only", "match-viewer", "https-only" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.DefaultCacheBehavior": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.DefaultCacheBehavior`\n\nA complex type that describes the default cache behavior if you don't specify a\n`CacheBehavior` element or if request URLs don't match any of the values\nof `PathPattern` in `CacheBehavior` elements. You must create\nexactly one default cache behavior.\n###### Important\nIf your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the `Cache-Control: no-cache`, `no-store`, or `private` directives are present in the origin headers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html", "Properties": { "Compress": { "MarkdownDocumentation": "`Compress`\n\nWhether you want CloudFront to automatically compress certain files for this cache behavior.\nIf so, specify `true`; if not, specify `false`. For more\ninformation, see [Serving\nCompressed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-compress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FunctionAssociations": { "MarkdownDocumentation": "`FunctionAssociations`\n\nA list of CloudFront functions that are associated with this cache behavior. Your functions\nmust be published to the `LIVE` stage to associate them with a cache\nbehavior.\n*Required*: No\n*Type*: Array of [FunctionAssociation](./aws-properties-cloudfront-distribution-functionassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-functionassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FunctionAssociation", "DuplicatesAllowed": true }, "LambdaFunctionAssociations": { "MarkdownDocumentation": "`LambdaFunctionAssociations`\n\nA complex type that contains zero or more Lambda@Edge function associations for a\ncache behavior.\n*Required*: No\n*Type*: Array of [LambdaFunctionAssociation](./aws-properties-cloudfront-distribution-lambdafunctionassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-lambdafunctionassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LambdaFunctionAssociation", "DuplicatesAllowed": true }, "TargetOriginId": { "MarkdownDocumentation": "`TargetOriginId`\n\nThe value of `ID` for the origin that you want CloudFront to route requests to\nwhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-targetoriginid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ViewerProtocolPolicy": { "MarkdownDocumentation": "`ViewerProtocolPolicy`\n\nThe protocol that viewers can use to access the files in the origin specified by\n`TargetOriginId` when a request matches the path pattern in\n`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\n returns an HTTP status code of 301 (Moved Permanently) to the viewer along with\n 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\n 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\n*Amazon CloudFront Developer Guide*.\n###### Note\nThe only way to guarantee that viewers retrieve an object that was fetched from\nthe origin using HTTPS is never to use any other protocol to fetch the object. If\nyou have recently changed from HTTP to HTTPS, we recommend that you clear your\nobjects' cache because cached objects are protocol agnostic. That means that an edge\nlocation will return an object from the cache regardless of whether the current\nrequest protocol matches the protocol used previously. For more information, see\n[Managing Cache\nExpiration](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 | re...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "allow-all", "https-only", "redirect-to-https" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-viewerprotocolpolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResponseHeadersPolicyId": { "MarkdownDocumentation": "`ResponseHeadersPolicyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-responseheaderspolicyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GrpcConfig": { "MarkdownDocumentation": "`GrpcConfig`\n\nThe gRPC configuration for your cache behavior.\n*Required*: No\n*Type*: [GrpcConfig](./aws-properties-cloudfront-distribution-grpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-grpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "GrpcConfig" }, "RealtimeLogConfigArn": { "MarkdownDocumentation": "`RealtimeLogConfigArn`\n\nThe Amazon Resource Name (ARN) of the real-time log configuration that is attached to\nthis cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-realtimelogconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustedSigners": { "MarkdownDocumentation": "`TrustedSigners`\n\n###### Important\nWe recommend using `TrustedKeyGroups` instead of\n`TrustedSigners`.\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or\nsigned cookies.\nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed\ncookies for all requests that match the cache behavior. The URLs or cookies must be\nsigned with the private key of a CloudFront key pair in a trusted signer's AWS account. The\nsigned URL or cookie contains information about which public key CloudFront should use to\nverify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-trustedsigners", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DefaultTTL": { "MarkdownDocumentation": "`DefaultTTL`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThis field is deprecated. We recommend that you use the `DefaultTTL` field\nin 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\n*Amazon CloudFront Developer Guide*.\nThe default amount of time that you want objects to stay in CloudFront caches before CloudFront\nforwards another request to your origin to determine whether the object has been\nupdated. The value that you specify applies only when your origin does not add HTTP\nheaders such as `Cache-Control max-age`, `Cache-Control s-maxage`,\nand `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\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-defaultttl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FieldLevelEncryptionId": { "MarkdownDocumentation": "`FieldLevelEncryptionId`\n\nThe value of `ID` for the field-level encryption configuration that you\nwant CloudFront to use for encrypting specific fields of data for the default cache\nbehavior.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-fieldlevelencryptionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustedKeyGroups": { "MarkdownDocumentation": "`TrustedKeyGroups`\n\nA list of key groups that CloudFront can use to validate signed URLs or signed\ncookies.\nWhen a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\ncookies for all requests that match the cache behavior. The URLs or cookies must be\nsigned with a private key whose corresponding public key is in the key group. The signed\nURL or cookie contains information about which public key CloudFront should use to verify the\nsignature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-trustedkeygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedMethods": { "MarkdownDocumentation": "`AllowedMethods`\n\nA complex type that controls which HTTP methods CloudFront processes and forwards to your\nAmazon 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\n `OPTIONS` requests.\n* CloudFront forwards `GET, HEAD, OPTIONS, PUT, PATCH, POST`, and\n `DELETE` requests.\nIf you pick the third choice, you may need to restrict access to your Amazon S3 bucket or\nto your custom origin so users can't perform operations that you don't want them to. For\nexample, you might not want users to have permissions to delete objects from your\norigin.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-allowedmethods", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CachedMethods": { "MarkdownDocumentation": "`CachedMethods`\n\nA complex type that controls whether CloudFront caches the response to requests using the\nspecified HTTP methods. There are two choices:\n* CloudFront caches responses to `GET` and `HEAD`\n requests.\n* CloudFront caches responses to `GET`, `HEAD`, and\n `OPTIONS` requests.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward\nAccess-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for\nthe responses to be cached correctly.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-cachedmethods", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SmoothStreaming": { "MarkdownDocumentation": "`SmoothStreaming`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nIndicates whether you want to distribute media files in the Microsoft Smooth Streaming\nformat using the origin that is associated with this cache behavior. If so, specify\n`true`; if not, specify `false`. If you specify\n`true` for `SmoothStreaming`, you can still distribute other\ncontent using this cache behavior if the content matches the value of\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-smoothstreaming", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ForwardedValues": { "MarkdownDocumentation": "`ForwardedValues`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the\n*Amazon CloudFront Developer Guide*.\nIf you want to include values in the cache key, use a cache policy. For more\ninformation, 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\n*Amazon CloudFront Developer Guide*.\nIf you want to send values to the origin but not include them in the cache key, use an\norigin 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) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the\n*Amazon CloudFront Developer Guide*.\nA `DefaultCacheBehavior` must include either a `CachePolicyId`\nor `ForwardedValues`. We recommend that you use a\n`CachePolicyId`.\nA complex type that specifies how CloudFront handles query strings, cookies, and HTTP\nheaders.\n*Required*: Conditional\n*Type*: [ForwardedValues](./aws-properties-cloudfront-distribution-forwardedvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-forwardedvalues", "UpdateType": "Mutable", "Required": false, "Type": "ForwardedValues" }, "OriginRequestPolicyId": { "MarkdownDocumentation": "`OriginRequestPolicyId`\n\nThe unique identifier of the origin request policy that is attached to the default\ncache 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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-originrequestpolicyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinTTL": { "MarkdownDocumentation": "`MinTTL`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThis field is deprecated. We recommend that you use the `MinTTL` field in a\ncache 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\n*Amazon CloudFront Developer Guide*.\nThe minimum amount of time that you want objects to stay in CloudFront caches before CloudFront\nforwards another request to your origin to determine whether the object has been\nupdated. For more information, see [Managing How Long\nContent Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the\n*Amazon CloudFront Developer Guide*.\nYou must specify `0` for `MinTTL` if you configure CloudFront to\nforward all headers to your origin (under `Headers`, if you specify\n`1` for `Quantity` and `*` for\n`Name`).\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-minttl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "CachePolicyId": { "MarkdownDocumentation": "`CachePolicyId`\n\nThe unique identifier of the cache policy that is attached to the default cache\nbehavior. 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\n*Amazon CloudFront Developer Guide*.\nA `DefaultCacheBehavior` must include either a `CachePolicyId`\nor `ForwardedValues`. We recommend that you use a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-cachepolicyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxTTL": { "MarkdownDocumentation": "`MaxTTL`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThis field is deprecated. We recommend that you use the `MaxTTL` field in a\ncache 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\n*Amazon CloudFront Developer Guide*.\nThe maximum amount of time that you want objects to stay in CloudFront caches before CloudFront\nforwards another request to your origin to determine whether the object has been\nupdated. The value that you specify applies only when your origin adds HTTP headers such\nas `Cache-Control max-age`, `Cache-Control s-maxage`, and\n`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\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-maxttl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::CloudFront::Distribution.Definition": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.Definition`\n\nThe `Definition` property type specifies Property description not available. for an [AWS::CloudFront::Distribution](./aws-resource-cloudfront-distribution.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-definition.html", "Properties": { "StringSchema": { "MarkdownDocumentation": "`StringSchema`\n\nProperty description not available.\n*Required*: No\n*Type*: [StringSchema](./aws-properties-cloudfront-distribution-stringschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-definition.html#cfn-cloudfront-distribution-definition-stringschema", "UpdateType": "Mutable", "Required": false, "Type": "StringSchema" } } }, "AWS::CloudFront::Distribution.DistributionConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.DistributionConfig`\n\nA distribution configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html", "Properties": { "PriceClass": { "MarkdownDocumentation": "`PriceClass`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThe price class that corresponds with the maximum price that you want to pay for CloudFront\nservice. If you specify `PriceClass_All`, CloudFront responds to requests for your\nobjects from all CloudFront edge locations.\nIf you specify a price class other than `PriceClass_All`, CloudFront serves your\nobjects from the CloudFront edge location that has the lowest latency among the edge locations\nin your price class. Viewers who are in or near regions that are excluded from your\nspecified price class may encounter slower performance.\nFor more information about price classes, see [Choosing the Price\nClass for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*.\nFor information about CloudFront pricing, including how price classes (such as Price Class\n100) map to CloudFront regions, see [Amazon CloudFront\nPricing](https://aws.amazon.com/cloudfront/pricing/).\n*Required*: No\n*Type*: String\n*Allowed values*: `PriceClass_100 | PriceClass...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PriceClass_100", "PriceClass_200", "PriceClass_All", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-priceclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Staging": { "MarkdownDocumentation": "`Staging`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nA Boolean that indicates whether this is a staging distribution. When this value is\n`true`, this is a staging distribution. When this value is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-staging", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CustomErrorResponses": { "MarkdownDocumentation": "`CustomErrorResponses`\n\nA complex type that controls the following:\n* Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom\n 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\nError Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of [CustomErrorResponse](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-customerrorresponses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomErrorResponse", "DuplicatesAllowed": true }, "ContinuousDeploymentPolicyId": { "MarkdownDocumentation": "`ContinuousDeploymentPolicyId`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThe identifier of a continuous deployment policy. For more information, see\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-continuousdeploymentpolicyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OriginGroups": { "MarkdownDocumentation": "`OriginGroups`\n\nA complex type that contains information about origin groups for this distribution.\nSpecify a value for either the `Origins` or `OriginGroups` property.\n*Required*: Conditional\n*Type*: [OriginGroups](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-origingroups", "UpdateType": "Mutable", "Required": false, "Type": "OriginGroups" }, "ConnectionFunctionAssociation": { "MarkdownDocumentation": "`ConnectionFunctionAssociation`\n\nThe distribution's connection function association.\n*Required*: No\n*Type*: [ConnectionFunctionAssociation](./aws-properties-cloudfront-distribution-connectionfunctionassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-connectionfunctionassociation", "UpdateType": "Mutable", "Required": false, "Type": "ConnectionFunctionAssociation" }, "IPV6Enabled": { "MarkdownDocumentation": "`IPV6Enabled`\n\n###### Note\nTo use this field for a multi-tenant distribution, use a connection group instead. For more information, see [ConnectionGroup](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ConnectionGroup.html).\nIf you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your\ndistribution, specify `true`. If you specify `false`, CloudFront\nresponds to IPv6 DNS requests with the DNS response code `NOERROR` and with\nno IP addresses. This allows viewers to submit a second request, for an IPv4 address for\nyour distribution.\nIn general, you should enable IPv6 if you have users on IPv6 networks who want to\naccess your content. However, if you're using signed URLs or signed cookies to restrict\naccess to your content, and if you're using a custom policy that includes the\n`IpAddress` parameter to restrict the IP addresses that can access your\ncontent, don't enable IPv6. If you want to restrict access to some content by IP address\nand not restrict access to other content (or restrict access but not by IP address), you\ncan 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\n*Amazon CloudFront Developer Guide*.\nIf you're using an Amazon Route\u00a053 AWS Integration alias resource record set to route traffic to your CloudFront\ndistribution, you need to create a second alias resource record set when both of the\nfollowing 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\nTraffic 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\n*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\nservice, you don't need to make any changes. A CNAME record will route traffic to your\ndistribution 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-ipv6enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TenantConfig": { "MarkdownDocumentation": "`TenantConfig`\n\n###### Note\nThis field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nA distribution tenant configuration.\n*Required*: No\n*Type*: [TenantConfig](./aws-properties-cloudfront-distribution-tenantconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-tenantconfig", "UpdateType": "Mutable", "Required": false, "Type": "TenantConfig" }, "CNAMEs": { "MarkdownDocumentation": "`CNAMEs`\n\nAn alias for the CloudFront distribution's domain name.\n###### Note\nThis property is legacy. We recommend that you use [Aliases](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases) instead.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-cnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ViewerMtlsConfig": { "MarkdownDocumentation": "`ViewerMtlsConfig`\n\nThe distribution's viewer mTLS configuration.\n*Required*: No\n*Type*: [ViewerMtlsConfig](./aws-properties-cloudfront-distribution-viewermtlsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-viewermtlsconfig", "UpdateType": "Mutable", "Required": false, "Type": "ViewerMtlsConfig" }, "HttpVersion": { "MarkdownDocumentation": "`HttpVersion`\n\n(Optional) Specify the HTTP version(s) that you want viewers to use to\ncommunicate with CloudFront. The default value for new distributions is\n`http1.1`.\nFor viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and\nmust support Server Name Indication (SNI).\nFor viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server\nName Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the\nviewer to switch networks without losing connection. For more information\nabout connection migration, see [Connection Migration](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more\ninformation about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and\nCloudFront](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 | http3 | h...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "http1.1", "http2", "http3", "http2and3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-httpversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Restrictions": { "MarkdownDocumentation": "`Restrictions`\n\nA complex type that identifies ways in which you want to restrict distribution of your\ncontent.\n*Required*: No\n*Type*: [Restrictions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions", "UpdateType": "Mutable", "Required": false, "Type": "Restrictions" }, "CacheBehaviors": { "MarkdownDocumentation": "`CacheBehaviors`\n\nA complex type that contains zero or more `CacheBehavior` elements.\n*Required*: No\n*Type*: Array of [CacheBehavior](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-cachebehaviors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CacheBehavior", "DuplicatesAllowed": true }, "Logging": { "MarkdownDocumentation": "`Logging`\n\nA complex type that controls whether access logs are written for the\ndistribution.\nFor more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in\nthe *Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: [Logging](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-logging", "UpdateType": "Mutable", "Required": false, "Type": "Logging" }, "Comment": { "MarkdownDocumentation": "`Comment`\n\nA comment to describe the distribution. The comment cannot be longer than\n128 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultRootObject": { "MarkdownDocumentation": "`DefaultRootObject`\n\nWhen a viewer requests the root URL for your distribution, the default root object is the\nobject that you want CloudFront to request from your origin. For example, if your root URL is\n`https://www.example.com`, you can specify CloudFront to return the\n`index.html` file as the default root object. You can specify a default\nroot object so that viewers see a specific file or object, instead of another object in\nyour distribution (for example,\n`https://www.example.com/product-description.html`). A default root\nobject avoids exposing the contents of your distribution.\nYou can specify the object name or a path to the object name (for example,\n`index.html` or `exampleFolderName/index.html`). Your string\ncan't begin with a forward slash (`/`). Only specify the object name or the\npath to the object.\nIf you don't want to specify a default root object when you create a distribution,\ninclude an empty `DefaultRootObject` element.\nTo delete the default root object from an existing distribution, update the\ndistribution configuration and include an empty `DefaultRootObject`\nelement.\nTo replace the default root object, update the distribution configuration and specify\nthe new object.\nFor more information about the default root object, see [Specify 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultrootobject", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Origins": { "MarkdownDocumentation": "`Origins`\n\nA complex type that contains information about origins for this distribution.\nSpecify a value for either the `Origins` or `OriginGroups` property.\n*Required*: Conditional\n*Type*: Array of [Origin](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-origins", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Origin", "DuplicatesAllowed": true }, "ViewerCertificate": { "MarkdownDocumentation": "`ViewerCertificate`\n\nA complex type that determines the distribution's SSL/TLS configuration for\ncommunicating with viewers.\n*Required*: No\n*Type*: [ViewerCertificate](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-viewercertificate", "UpdateType": "Mutable", "Required": false, "Type": "ViewerCertificate" }, "AnycastIpListId": { "MarkdownDocumentation": "`AnycastIpListId`\n\n###### Note\nTo use this field for a multi-tenant distribution, use a connection group instead. For more information, see [ConnectionGroup](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ConnectionGroup.html).\nID of the Anycast static IP list that is associated with the distribution.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-anycastiplistid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomOrigin": { "MarkdownDocumentation": "`CustomOrigin`\n\nThe user-defined HTTP server that serves as the origin for content that CloudFront distributes.\n###### Note\nThis property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.\n*Required*: No\n*Type*: [LegacyCustomOrigin](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-customorigin", "UpdateType": "Mutable", "Required": false, "Type": "LegacyCustomOrigin" }, "S3Origin": { "MarkdownDocumentation": "`S3Origin`\n\nThe origin as an Amazon S3 bucket.\n###### Note\nThis property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.\n*Required*: No\n*Type*: [LegacyS3Origin](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-s3origin", "UpdateType": "Mutable", "Required": false, "Type": "LegacyS3Origin" }, "DefaultCacheBehavior": { "MarkdownDocumentation": "`DefaultCacheBehavior`\n\nA complex type that describes the default cache behavior if you don't specify a\n`CacheBehavior` element or if files don't match any of the values of\n`PathPattern` in `CacheBehavior` elements. You must create\nexactly one default cache behavior.\n*Required*: Yes\n*Type*: [DefaultCacheBehavior](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultcachebehavior", "UpdateType": "Mutable", "Required": true, "Type": "DefaultCacheBehavior" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nFrom 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Aliases": { "MarkdownDocumentation": "`Aliases`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nA complex type that contains information about CNAMEs (alternate domain names), if\nany, for this distribution.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ConnectionMode": { "MarkdownDocumentation": "`ConnectionMode`\n\nThis field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).\n*Required*: No\n*Type*: String\n*Allowed values*: `direct | tenant-only...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "direct", "tenant-only" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-connectionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WebACLId": { "MarkdownDocumentation": "`WebACLId`\n\n###### Note\nMulti-tenant distributions only support AWS WAF V2 web ACLs.\nA unique identifier that specifies the AWS WAF web ACL, if any, to associate with this\ndistribution. To specify a web ACL created using the latest version of AWS WAF, use the\nACL ARN, for example\n`arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.\nTo specify a web ACL created using AWS WAF Classic, use the ACL ID, for example\n`a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.\nAWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\nthat are forwarded to CloudFront, and lets you control access to your content. Based on\nconditions that you specify, such as the IP addresses that requests originate from or\nthe values of query strings, CloudFront responds to requests either with the requested content\nor with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a\ncustom error page when a request is blocked. For more information about AWS WAF, see the\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-webaclid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.ForwardedValues": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.ForwardedValues`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field.\nIf you want to include values in the cache key, use a cache policy. For more\ninformation, 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 values to the origin but not include them in the cache key, use an\norigin 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\n*Amazon CloudFront Developer Guide*.\nA complex type that specifies how CloudFront handles query strings, cookies, and HTTP\nheaders.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html", "Properties": { "Cookies": { "MarkdownDocumentation": "`Cookies`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field.\nIf you want to include cookies in the cache key, use a cache policy. For more\ninformation, 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\nan 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\n*Amazon CloudFront Developer Guide*.\nA complex type that specifies whether you want CloudFront to forward cookies to the origin\nand, if so, which ones. For more information about forwarding cookies to the origin, see\n[How CloudFront Forwards, Caches,\nand Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: [Cookies](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-cookies", "UpdateType": "Mutable", "Required": false, "Type": "Cookies" }, "Headers": { "MarkdownDocumentation": "`Headers`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field.\nIf you want to include headers in the cache key, use a cache policy. For more\ninformation, 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 headers to the origin but not include them in the cache key, use\nan 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\n*Amazon CloudFront Developer Guide*.\nA complex type that specifies the `Headers`, if any, that you want CloudFront to\nforward to the origin for this cache behavior (whitelisted headers). For the headers\nthat you specify, CloudFront also caches separate versions of a specified object that is based\non the header values in viewer requests.\nFor more information, see [Caching Content\nBased on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-headers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field.\nIf you want to include query strings in the cache key, use a cache policy. For more\ninformation, 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 query strings to the origin but not include them in the cache key,\nuse 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\n*Amazon CloudFront Developer Guide*.\nIndicates whether you want CloudFront to forward query strings to the origin that is\nassociated with this cache behavior and cache based on the query string parameters. CloudFront\nbehavior depends on the value of `QueryString` and on the values that you\nspecify for `QueryStringCacheKeys`, if any:\nIf you specify true for `QueryString` and you don't specify any values for\n`QueryStringCacheKeys`, CloudFront forwards all query string parameters to the\norigin and caches based on all query string parameters. Depending on how many query\nstring parameters and values you have, this can adversely affect performance because\nCloudFront must forward more requests to the origin.\nIf you specify true for `QueryString` and you specify one or more values\nfor `QueryStringCacheKeys`, CloudFront forwards all query string parameters to the\norigin, but it only caches based on the query string parameters that you specify.\nIf you specify false for `QueryString`, CloudFront doesn't forward any query\nstring parameters to the origin, and doesn't cache based on query string\nparameters.\nFor more information, see [Configuring\nCloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the\n*Amazon CloudFront Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-querystring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "QueryStringCacheKeys": { "MarkdownDocumentation": "`QueryStringCacheKeys`\n\nThis field is deprecated. We recommend that you use a cache policy or an origin\nrequest policy instead of this field.\nIf you want to include query strings in the cache key, use a cache policy. For more\ninformation, 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 query strings to the origin but not include them in the cache key,\nuse 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\n*Amazon CloudFront Developer Guide*.\nA complex type that contains information about the query string parameters that you\nwant CloudFront to use for caching for this cache behavior.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-querystringcachekeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CloudFront::Distribution.FunctionAssociation": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.FunctionAssociation`\n\nA CloudFront function that is associated with a cache behavior in a CloudFront\ndistribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-functionassociation.html", "Properties": { "FunctionARN": { "MarkdownDocumentation": "`FunctionARN`\n\nThe Amazon Resource Name (ARN) of the function.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws:cloudfront::[0-9]{12}:function\\/[a-zA-Z0-9-_]{1,64}`\n*Minimum*: `0`\n*Maximum*: `108`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-functionassociation.html#cfn-cloudfront-distribution-functionassociation-functionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventType": { "MarkdownDocumentation": "`EventType`\n\nThe event type of the function, either `viewer-request` or\n`viewer-response`. You cannot use origin-facing event types\n(`origin-request` and `origin-response`) with a CloudFront\nfunction.\n*Required*: No\n*Type*: String\n*Allowed values*: `viewer-request | viewer-res...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "viewer-request", "viewer-response", "origin-request", "origin-response" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-functionassociation.html#cfn-cloudfront-distribution-functionassociation-eventtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.GeoRestriction": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.GeoRestriction`\n\nA complex type that controls the countries in which your content is distributed. CloudFront\ndetermines 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html", "Properties": { "Locations": { "MarkdownDocumentation": "`Locations`\n\nA complex type that contains a `Location` element for each country in\nwhich you want CloudFront either to distribute your content (`whitelist`) or not\ndistribute your content (`blacklist`).\nThe `Location` element is a two-letter, uppercase country code for a\ncountry that you want to include in your `blacklist` or\n`whitelist`. Include one `Location` element for each\ncountry.\nCloudFront and `MaxMind` both use `ISO 3166` country codes. For the\ncurrent list of countries and the corresponding codes, see `ISO\n3166-1-alpha-2` code on the *International Organization for\nStandardization* website. You can also refer to the country list on the\nCloudFront console, which includes both country names and codes.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-locations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RestrictionType": { "MarkdownDocumentation": "`RestrictionType`\n\nThe 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\n not restricted by client geo location.\n* `blacklist`: The `Location` elements specify the\n countries in which you don't want CloudFront to distribute your content.\n* `whitelist`: The `Location` elements specify the\n countries in which you want CloudFront to distribute your content.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `blacklist | whitelist | non...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "blacklist", "whitelist", "none" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-restrictiontype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.GrpcConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.GrpcConfig`\n\nAmazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on\nHTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads,\nmaking it suitable for applications that require low latency communications.\nTo enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported `HTTP` versions and allow `HTTP` methods, including `POST`.\nFor more information, see [Using gRPC with CloudFront distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-using-grpc.html) in the\n*Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-grpcconfig.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables your CloudFront distribution to receive gRPC requests and to proxy them directly to your\norigins.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-grpcconfig.html#cfn-cloudfront-distribution-grpcconfig-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::Distribution.LambdaFunctionAssociation": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.LambdaFunctionAssociation`\n\nA complex type that contains a Lambda@Edge function association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html", "Properties": { "IncludeBody": { "MarkdownDocumentation": "`IncludeBody`\n\nA flag that allows a Lambda@Edge function to have read access to the body content. For\nmore 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\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-includebody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EventType": { "MarkdownDocumentation": "`EventType`\n\nSpecifies the event type that triggers a Lambda@Edge function invocation. You can\nspecify the following values:\n* `viewer-request`: The function executes when CloudFront receives a\n request from a viewer and before it checks to see whether the requested object\n is in the edge cache.\n* `origin-request`: The function executes only when CloudFront sends a\n request to your origin. When the requested object is in the edge cache, the\n function doesn't execute.\n* `origin-response`: The function executes after CloudFront receives a\n response from the origin and before it caches the object in the response. When\n the requested object is in the edge cache, the function doesn't execute.\n* `viewer-response`: The function executes before CloudFront returns the\n requested object to the viewer. The function executes regardless of whether the\n object was already in the edge cache.\n \n If the origin returns an HTTP status code other than HTTP 200 (OK), the\n function doesn't execute.\n*Required*: No\n*Type*: String\n*Allowed values*: `viewer-request | viewer-res...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "viewer-request", "viewer-response", "origin-request", "origin-response" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-eventtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LambdaFunctionARN": { "MarkdownDocumentation": "`LambdaFunctionARN`\n\nThe ARN of the Lambda@Edge function. You must specify the ARN of a function version;\nyou 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-lambdafunctionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.LegacyCustomOrigin": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.LegacyCustomOrigin`\n\nA custom origin. A custom origin is any origin that is *not* an\nAmazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with\nstatic website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)*is* a custom origin.\n###### Note\nThis property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html", "Properties": { "HTTPSPort": { "MarkdownDocumentation": "`HTTPSPort`\n\nThe HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html#cfn-cloudfront-distribution-legacycustomorigin-httpsport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginSSLProtocols": { "MarkdownDocumentation": "`OriginSSLProtocols`\n\nThe minimum SSL/TLS protocol version that CloudFront uses when communicating with your origin server over HTTPs.\nFor more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the\n*Amazon CloudFront Developer Guide*.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html#cfn-cloudfront-distribution-legacycustomorigin-originsslprotocols", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DNSName": { "MarkdownDocumentation": "`DNSName`\n\nThe domain name assigned to your CloudFront 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html#cfn-cloudfront-distribution-legacycustomorigin-dnsname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HTTPPort": { "MarkdownDocumentation": "`HTTPPort`\n\nThe HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the\norigin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html#cfn-cloudfront-distribution-legacycustomorigin-httpport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginProtocolPolicy": { "MarkdownDocumentation": "`OriginProtocolPolicy`\n\nSpecifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html#cfn-cloudfront-distribution-legacycustomorigin-originprotocolpolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.LegacyS3Origin": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.LegacyS3Origin`\n\nThe origin as an Amazon S3 bucket.\n###### Note\nThis property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html", "Properties": { "OriginAccessIdentity": { "MarkdownDocumentation": "`OriginAccessIdentity`\n\nThe CloudFront origin access identity to associate with the distribution. Use an origin\naccess identity to configure the distribution so that end users can only access objects\nin an Amazon S3 through CloudFront.\n###### Note\nThis property is legacy. We recommend that you use [OriginAccessControl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html#cfn-cloudfront-distribution-legacys3origin-originaccessidentity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DNSName": { "MarkdownDocumentation": "`DNSName`\n\nThe domain name assigned to your CloudFront 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html#cfn-cloudfront-distribution-legacys3origin-dnsname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.Logging": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.Logging`\n\nA complex type that specifies whether access logs are written for the distribution.\n###### Note\nIf you already enabled standard logging (legacy) and you want to enable standard logging\n(v2) to send your access logs to Amazon S3, we recommend that you specify a\n*different* Amazon S3 bucket or use a *separate\npath* in the same bucket (for example, use a log prefix or\npartitioning). This helps you keep track of which log files are associated with\nwhich logging subscription and prevents log files from overwriting each other. For\nmore information, see [Standard logging (access logs)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the\n*Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html", "Properties": { "IncludeCookies": { "MarkdownDocumentation": "`IncludeCookies`\n\nSpecifies whether you want CloudFront to include cookies in access logs, specify\n`true` for `IncludeCookies`. If you choose to include cookies\nin logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for\nthis distribution. If you don't want to include cookies when you create a distribution\nor if you want to disable include cookies for an existing distribution, specify\n`false` for `IncludeCookies`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-includecookies", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe Amazon S3 bucket to store the access logs in, for example,\n`amzn-s3-demo-bucket.s3.amazonaws.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-bucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nAn optional string that you want CloudFront to prefix to the access log\n`filenames` for this distribution, for example, `myprefix/`.\nIf you want to enable logging, but you don't want to specify a prefix, you still must\ninclude 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.Origin": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.Origin`\n\nAn origin.\nAn origin is the location where content is stored, and from which CloudFront gets content to\nserve to viewers. To specify an origin:\n* Use `S3OriginConfig` to specify an Amazon S3 bucket that is not\n configured with static website hosting.\n* Use `VpcOriginConfig` to specify a VPC origin.\n* Use `CustomOriginConfig` to specify all other kinds of origins,\n including:\n \n + An Amazon S3 bucket that is configured with static website hosting\n + An Elastic Load Balancing load balancer\n + An AWS Elemental MediaPackage endpoint\n + An AWS Elemental MediaStore container\n + Any other HTTP server, running on an Amazon EC2 instance or any other kind\n of host\nFor the current maximum number of origins that you can specify per distribution, see\n[General Quotas on Web Distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions) in the\n*Amazon CloudFront Developer Guide* (quotas were formerly referred to as\nlimits).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html", "Properties": { "ConnectionTimeout": { "MarkdownDocumentation": "`ConnectionTimeout`\n\nThe number of seconds that CloudFront waits when trying to establish a connection to the\norigin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if\nyou 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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-connectiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginAccessControlId": { "MarkdownDocumentation": "`OriginAccessControlId`\n\nThe 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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-originaccesscontrolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionAttempts": { "MarkdownDocumentation": "`ConnectionAttempts`\n\nThe number of times that CloudFront attempts to connect to the origin. The minimum number is\n1, 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\nhosting), this value also specifies the number of times that CloudFront attempts to get a\nresponse 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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-connectionattempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginCustomHeaders": { "MarkdownDocumentation": "`OriginCustomHeaders`\n\nA list of HTTP header names and values that CloudFront adds to the requests that it sends to\nthe 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\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of [OriginCustomHeader](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-origincustomheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OriginCustomHeader", "DuplicatesAllowed": true }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-domainname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OriginShield": { "MarkdownDocumentation": "`OriginShield`\n\nCloudFront Origin Shield. Using Origin Shield can help reduce the load on your\norigin.\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-originshield", "UpdateType": "Mutable", "Required": false, "Type": "OriginShield" }, "S3OriginConfig": { "MarkdownDocumentation": "`S3OriginConfig`\n\nUse this type to specify an origin that is an Amazon S3 bucket that is not configured with\nstatic website hosting. To specify any other type of origin, including an Amazon S3 bucket\nthat is configured with static website hosting, use the `CustomOriginConfig`\ntype instead.\n*Required*: Conditional\n*Type*: [S3OriginConfig](./aws-properties-cloudfront-distribution-s3originconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-s3originconfig", "UpdateType": "Mutable", "Required": false, "Type": "S3OriginConfig" }, "VpcOriginConfig": { "MarkdownDocumentation": "`VpcOriginConfig`\n\nThe VPC origin configuration.\n*Required*: No\n*Type*: [VpcOriginConfig](./aws-properties-cloudfront-distribution-vpcoriginconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-vpcoriginconfig", "UpdateType": "Mutable", "Required": false, "Type": "VpcOriginConfig" }, "OriginPath": { "MarkdownDocumentation": "`OriginPath`\n\nAn optional path that CloudFront appends to the origin domain name when CloudFront requests\ncontent 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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-originpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseCompletionTimeout": { "MarkdownDocumentation": "`ResponseCompletionTimeout`\n\nThe time (in seconds) that a request from CloudFront to the origin can stay open and wait\nfor a response. If the complete response isn't received from the origin by this time,\nCloudFront ends the connection.\nThe value for `ResponseCompletionTimeout` must be equal to or greater than\nthe value for `OriginReadTimeout`. If you don't set a value for\n`ResponseCompletionTimeout`, CloudFront doesn't enforce a maximum value.\nFor more information, see [Response completion timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#response-completion-timeout) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-responsecompletiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA unique identifier for the origin. This value must be unique within the\ndistribution.\nUse this value to specify the `TargetOriginId` in a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomOriginConfig": { "MarkdownDocumentation": "`CustomOriginConfig`\n\nUse this type to specify an origin that is not an Amazon S3 bucket, with one exception. If\nthe Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3\nbucket is not configured with static website hosting, use the\n`S3OriginConfig` type instead.\n*Required*: Conditional\n*Type*: [CustomOriginConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-customoriginconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomOriginConfig" } } }, "AWS::CloudFront::Distribution.OriginCustomHeader": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.OriginCustomHeader`\n\nA complex type that contains `HeaderName` and `HeaderValue`\nelements, if any, for this distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html", "Properties": { "HeaderValue": { "MarkdownDocumentation": "`HeaderValue`\n\nThe value for the header that you specified in the `HeaderName`\nfield.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html#cfn-cloudfront-distribution-origincustomheader-headervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HeaderName": { "MarkdownDocumentation": "`HeaderName`\n\nThe name of a header that you want CloudFront to send to your origin. For more information,\nsee [Adding\nCustom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html#cfn-cloudfront-distribution-origincustomheader-headername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.OriginGroup": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.OriginGroup`\n\nAn origin group includes two origins (a primary origin and a secondary origin to failover\nto) and a failover criteria that you specify. You create an origin group to support\norigin failover in CloudFront. When you create or update a distribution, you can specify the\norigin group instead of a single origin, and CloudFront will failover from the primary origin\nto the secondary origin under the failover conditions that you've chosen.\nOptionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html", "Properties": { "SelectionCriteria": { "MarkdownDocumentation": "`SelectionCriteria`\n\nThe selection criteria for the origin group. For more information, see [Create an origin group](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/high_availability_origin_failover.html#concept_origin_groups.creating) in the *Amazon CloudFront\nDeveloper Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | media-quality-bas...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "media-quality-based" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-selectioncriteria", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe origin group's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FailoverCriteria": { "MarkdownDocumentation": "`FailoverCriteria`\n\nA complex type that contains information about the failover criteria for an origin\ngroup.\n*Required*: Yes\n*Type*: [OriginGroupFailoverCriteria](./aws-properties-cloudfront-distribution-origingroupfailovercriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-failovercriteria", "UpdateType": "Mutable", "Required": true, "Type": "OriginGroupFailoverCriteria" }, "Members": { "MarkdownDocumentation": "`Members`\n\nA complex type that contains information about the origins in an origin group.\n*Required*: Yes\n*Type*: [OriginGroupMembers](./aws-properties-cloudfront-distribution-origingroupmembers.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-members", "UpdateType": "Mutable", "Required": true, "Type": "OriginGroupMembers" } } }, "AWS::CloudFront::Distribution.OriginGroupFailoverCriteria": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.OriginGroupFailoverCriteria`\n\nA complex data type that includes information about the failover criteria for an\norigin group, including the status codes for which CloudFront will failover from the\nprimary origin to the second origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupfailovercriteria.html", "Properties": { "StatusCodes": { "MarkdownDocumentation": "`StatusCodes`\n\nThe status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.\n*Required*: Yes\n*Type*: [StatusCodes](./aws-properties-cloudfront-distribution-statuscodes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupfailovercriteria.html#cfn-cloudfront-distribution-origingroupfailovercriteria-statuscodes", "UpdateType": "Mutable", "Required": true, "Type": "StatusCodes" } } }, "AWS::CloudFront::Distribution.OriginGroupMember": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.OriginGroupMember`\n\nAn origin in an origin group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmember.html", "Properties": { "OriginId": { "MarkdownDocumentation": "`OriginId`\n\nThe ID for an origin in an origin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmember.html#cfn-cloudfront-distribution-origingroupmember-originid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.OriginGroupMembers": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.OriginGroupMembers`\n\nA complex data type for the origins included in an origin group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmembers.html", "Properties": { "Quantity": { "MarkdownDocumentation": "`Quantity`\n\nThe number of origins in an origin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmembers.html#cfn-cloudfront-distribution-origingroupmembers-quantity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Items": { "MarkdownDocumentation": "`Items`\n\nItems (origins) in an origin group.\n*Required*: Yes\n*Type*: Array of [OriginGroupMember](./aws-properties-cloudfront-distribution-origingroupmember.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroupmembers.html#cfn-cloudfront-distribution-origingroupmembers-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "OriginGroupMember", "DuplicatesAllowed": true } } }, "AWS::CloudFront::Distribution.OriginGroups": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.OriginGroups`\n\nA complex data type for the origin groups specified for a distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroups.html", "Properties": { "Quantity": { "MarkdownDocumentation": "`Quantity`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroups.html#cfn-cloudfront-distribution-origingroups-quantity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Items": { "MarkdownDocumentation": "`Items`\n\nThe items (origin groups) in a distribution.\n*Required*: No\n*Type*: Array of [OriginGroup](./aws-properties-cloudfront-distribution-origingroup.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroups.html#cfn-cloudfront-distribution-origingroups-items", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OriginGroup", "DuplicatesAllowed": true } } }, "AWS::CloudFront::Distribution.OriginShield": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.OriginShield`\n\nCloudFront Origin Shield.\nUsing Origin Shield can help reduce the load on your origin. For more information, see\n[Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the\n*Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-originshield.html", "Properties": { "OriginShieldRegion": { "MarkdownDocumentation": "`OriginShieldRegion`\n\nThe AWS Region for Origin Shield.\nSpecify the AWS Region that has the lowest latency to your origin. To specify a\nregion, use the region code, not the region name. For example, specify the US East\n(Ohio) region as `us-east-2`.\nWhen you enable CloudFront Origin Shield, you must specify the AWS Region for Origin\nShield. For the list of AWS Regions that you can specify, and for help choosing the\nbest 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\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-z]{2}-[a-z]+-\\d`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-originshield.html#cfn-cloudfront-distribution-originshield-originshieldregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nA flag that specifies whether Origin Shield is enabled.\nWhen it's enabled, CloudFront routes all requests through Origin Shield, which can help\nprotect your origin. When it's disabled, CloudFront might send requests directly to your\norigin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-originshield.html#cfn-cloudfront-distribution-originshield-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::Distribution.ParameterDefinition": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.ParameterDefinition`\n\nA list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-parameterdefinition.html", "Properties": { "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe value that you assigned to the parameter.\n*Required*: Yes\n*Type*: [Definition](./aws-properties-cloudfront-distribution-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-parameterdefinition.html#cfn-cloudfront-distribution-parameterdefinition-definition", "UpdateType": "Mutable", "Required": true, "Type": "Definition" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-parameterdefinition.html#cfn-cloudfront-distribution-parameterdefinition-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.Restrictions": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.Restrictions`\n\nA complex type that identifies ways in which you want to restrict distribution of your\ncontent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-restrictions.html", "Properties": { "GeoRestriction": { "MarkdownDocumentation": "`GeoRestriction`\n\nA complex type that controls the countries in which your content is distributed. CloudFront\ndetermines 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-restrictions.html#cfn-cloudfront-distribution-restrictions-georestriction", "UpdateType": "Mutable", "Required": true, "Type": "GeoRestriction" } } }, "AWS::CloudFront::Distribution.S3OriginConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.S3OriginConfig`\n\nA complex type that contains information about the Amazon S3 origin. If the origin is a\ncustom origin or an S3 bucket that is configured as a website endpoint, use the\n`CustomOriginConfig` element instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-s3originconfig.html", "Properties": { "OriginReadTimeout": { "MarkdownDocumentation": "`OriginReadTimeout`\n\nSpecifies how long, in seconds, CloudFront waits for a response from the origin. This is\nalso known as the *origin response timeout*. The minimum timeout is 1\nsecond, the maximum is 120 seconds, and the default (if you don't specify otherwise) is\n30 seconds.\nFor more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-s3originconfig.html#cfn-cloudfront-distribution-s3originconfig-originreadtimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginAccessIdentity": { "MarkdownDocumentation": "`OriginAccessIdentity`\n\n###### Note\nIf you're using origin access control (OAC) instead of origin access identity,\nspecify an empty `OriginAccessIdentity` element. For more information,\nsee [Restricting access to an AWS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the\n*Amazon CloudFront Developer Guide*.\nThe CloudFront origin access identity to associate with the origin. Use an origin access\nidentity to configure the origin so that viewers can *only* access\nobjects in an Amazon S3 bucket through CloudFront. The format of the value is:\n`origin-access-identity/cloudfront/ID-of-origin-access-identity`\nThe `ID-of-origin-access-identity` is the value that CloudFront\nreturned in the `ID` element when you created the origin access\nidentity.\nIf you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3\nURL, specify an empty `OriginAccessIdentity` element.\nTo delete the origin access identity from an existing distribution, update the\ndistribution configuration and include an empty `OriginAccessIdentity`\nelement.\nTo replace the origin access identity, update the distribution configuration and\nspecify the new origin access identity.\nFor more information about the origin access identity, see [Serving Private\nContent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-s3originconfig.html#cfn-cloudfront-distribution-s3originconfig-originaccessidentity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.StatusCodes": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.StatusCodes`\n\nA complex data type for the status codes that you specify that, when returned by a\nprimary origin, trigger CloudFront to failover to a second origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-statuscodes.html", "Properties": { "Quantity": { "MarkdownDocumentation": "`Quantity`\n\nThe number of status codes.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-statuscodes.html#cfn-cloudfront-distribution-statuscodes-quantity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Items": { "MarkdownDocumentation": "`Items`\n\nThe items (status codes) for an origin group.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-statuscodes.html#cfn-cloudfront-distribution-statuscodes-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true } } }, "AWS::CloudFront::Distribution.StringSchema": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.StringSchema`\n\nThe `StringSchema` property type specifies Property description not available. for an [AWS::CloudFront::Distribution](./aws-resource-cloudfront-distribution.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-stringschema.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-stringschema.html#cfn-cloudfront-distribution-stringschema-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-stringschema.html#cfn-cloudfront-distribution-stringschema-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Required": { "MarkdownDocumentation": "`Required`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-stringschema.html#cfn-cloudfront-distribution-stringschema-required", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::Distribution.TenantConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.TenantConfig`\n\n###### Note\nThis field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\nThe configuration for a distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-tenantconfig.html", "Properties": { "ParameterDefinitions": { "MarkdownDocumentation": "`ParameterDefinitions`\n\nThe parameters that you specify for a distribution tenant.\n*Required*: No\n*Type*: Array of [ParameterDefinition](./aws-properties-cloudfront-distribution-parameterdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-tenantconfig.html#cfn-cloudfront-distribution-tenantconfig-parameterdefinitions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ParameterDefinition", "DuplicatesAllowed": true } } }, "AWS::CloudFront::Distribution.TrustStoreConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.TrustStoreConfig`\n\nA trust store configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-truststoreconfig.html", "Properties": { "TrustStoreId": { "MarkdownDocumentation": "`TrustStoreId`\n\nThe trust store 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-truststoreconfig.html#cfn-cloudfront-distribution-truststoreconfig-truststoreid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IgnoreCertificateExpiry": { "MarkdownDocumentation": "`IgnoreCertificateExpiry`\n\nThe configuration to use to ignore certificate expiration.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-truststoreconfig.html#cfn-cloudfront-distribution-truststoreconfig-ignorecertificateexpiry", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AdvertiseTrustStoreCaNames": { "MarkdownDocumentation": "`AdvertiseTrustStoreCaNames`\n\nThe configuration to use to advertise trust store CA names.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-truststoreconfig.html#cfn-cloudfront-distribution-truststoreconfig-advertisetruststorecanames", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::Distribution.ViewerCertificate": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.ViewerCertificate`\n\nA complex type that determines the distribution's SSL/TLS configuration for\ncommunicating with viewers.\nIf the distribution doesn't use `Aliases` (also known as alternate domain\nnames or CNAMEs)\u2014that is, if the distribution uses the CloudFront domain name such as\n`d111111abcdef8.cloudfront.net`\u2014set\n`CloudFrontDefaultCertificate` to `true` and leave all other\nfields empty.\nIf the distribution uses `Aliases` (alternate domain names or CNAMEs), use\nthe fields in this type to specify the following settings:\n* Which viewers the distribution accepts HTTPS connections from: only viewers\n that support [server name indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers\n including those that don't support SNI.\n \n + To accept HTTPS connections from only viewers that support SNI, set\n `SSLSupportMethod` to `sni-only`. This is\n recommended. Most browsers and clients support SNI.\n (In CloudFormation, the field name is `SslSupportMethod`.\n Note the different capitalization.)\n + To accept HTTPS connections from all viewers, including those that\n don't support SNI, set `SSLSupportMethod` to\n `vip`. This is not recommended, and results in additional\n monthly charges from CloudFront. (In CloudFormation,\n the field name is `SslSupportMethod`. Note the different\n capitalization.)\n* The minimum SSL/TLS protocol version that the distribution can use to\n communicate with viewers. To specify a minimum version, choose a value for\n `MinimumProtocolVersion`. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the\n *Amazon CloudFront Developer Guide*.\n* The location of the SSL/TLS certificate, [AWS Certificate Manager\n (ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [AWS Identity and Access Management (IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by\n setting a value in one of the following fields (not both):\n \n + `ACMCertificateArn` (In CloudFormation,\n this field name is `AcmCertificateArn`. Note the\n different capitalization.)\n + `IAMCertificateId` (In CloudFormation,\n this field name is `IamCertificateId`. Note the different\n capitalization.)\nAll distributions support HTTPS connections from viewers. To require viewers to use\nHTTPS only, or to redirect them from HTTP to HTTPS, use\n`ViewerProtocolPolicy` in the `CacheBehavior` or\n`DefaultCacheBehavior`. To specify how CloudFront should use SSL/TLS to\ncommunicate with your custom origin, use `CustomOriginConfig`.\nFor more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the\n*Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html", "Properties": { "IamCertificateId": { "MarkdownDocumentation": "`IamCertificateId`\n\n###### Note\nThis field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n\n###### Note\nIn CloudFormation, this field name is `IamCertificateId`. Note the\ndifferent capitalization.\nIf the distribution uses `Aliases` (alternate domain names or CNAMEs) and\nthe 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\n`MinimumProtocolVersion` and `SSLSupportMethod`. (In CloudFormation, the field name is `SslSupportMethod`. Note\nthe different capitalization.)\n*Required*: Conditional\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-iamcertificateid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SslSupportMethod": { "MarkdownDocumentation": "`SslSupportMethod`\n\n###### Note\nIn CloudFormation, this field name is `SslSupportMethod`. Note the\ndifferent capitalization.\nIf the distribution uses `Aliases` (alternate domain names or CNAMEs),\nspecify which viewers the distribution accepts HTTPS connections from.\n* `sni-only` \u2013 The distribution accepts HTTPS connections from only\n viewers that support [server name\n indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients\n support SNI.\n* `vip` \u2013 The distribution accepts HTTPS connections from all viewers\n including those that don't support SNI. This is not recommended, and results in\n additional monthly charges from CloudFront.\n* `static-ip` - Do not specify this value unless your distribution\n has been enabled for this feature by the CloudFront team. If you have a use case\n that requires static IP addresses for a distribution, contact CloudFront through\n the [Support Center](https://console.aws.amazon.com/support/home).\nIf the distribution uses the CloudFront domain name such as\n`d111111abcdef8.cloudfront.net`, don't set a value for this field.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `sni-only | vip | static-ip...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "sni-only", "vip", "static-ip" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-sslsupportmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinimumProtocolVersion": { "MarkdownDocumentation": "`MinimumProtocolVersion`\n\nIf the distribution uses `Aliases` (alternate domain names or CNAMEs),\nspecify the security policy that you want CloudFront to use for HTTPS connections with\nviewers. The security policy determines two settings:\n* The minimum SSL/TLS protocol that CloudFront can use to communicate with\n viewers.\n* The ciphers that CloudFront can use to encrypt the content that it returns to\n 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\nCloudFront](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*.\n###### Note\nOn the CloudFront console, this setting is called **Security\nPolicy**.\nWhen you're using SNI only (you set `SSLSupportMethod` to\n`sni-only`), you must specify `TLSv1` or higher. (In CloudFormation, the field name is `SslSupportMethod`. Note\nthe different capitalization.)\nIf the distribution uses the CloudFront domain name such as\n`d111111abcdef8.cloudfront.net` (you set\n`CloudFrontDefaultCertificate` to `true`), CloudFront automatically\nsets the security policy to `TLSv1` regardless of the value that you set\nhere.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `SSLv3 | TLSv1 | 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)", "RefReturnValue": "", "AllowedValues": [ "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021", "TLSv1.3_2025", "TLSv1.2_2025" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-minimumprotocolversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudFrontDefaultCertificate": { "MarkdownDocumentation": "`CloudFrontDefaultCertificate`\n\nIf the distribution uses the CloudFront domain name such as\n`d111111abcdef8.cloudfront.net`, set this field to\n`true`.\nIf the distribution uses `Aliases` (alternate domain names or CNAMEs), omit this field and specify values for the following fields:\n* `AcmCertificateArn` or `IamCertificateId` (specify a\n value for one, not both)\n* `MinimumProtocolVersion`\n* `SslSupportMethod`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-cloudfrontdefaultcertificate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AcmCertificateArn": { "MarkdownDocumentation": "`AcmCertificateArn`\n\n###### Note\nIn CloudFormation, this field name is `AcmCertificateArn`. Note the\ndifferent capitalization.\nIf the distribution uses `Aliases` (alternate domain names or CNAMEs) and\nthe 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\n(ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East\n(N. Virginia) Region (`us-east-1`).\nIf you specify an ACM certificate ARN, you must also specify values for\n`MinimumProtocolVersion` and `SSLSupportMethod`. (In CloudFormation, the field name is `SslSupportMethod`. Note\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-acmcertificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Distribution.ViewerMtlsConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.ViewerMtlsConfig`\n\nA viewer mTLS configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewermtlsconfig.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe viewer mTLS mode.\n*Required*: No\n*Type*: String\n*Allowed values*: `required | optional...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "required", "optional" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewermtlsconfig.html#cfn-cloudfront-distribution-viewermtlsconfig-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustStoreConfig": { "MarkdownDocumentation": "`TrustStoreConfig`\n\nThe trust store configuration associated with the viewer mTLS configuration.\n*Required*: No\n*Type*: [TrustStoreConfig](./aws-properties-cloudfront-distribution-truststoreconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewermtlsconfig.html#cfn-cloudfront-distribution-viewermtlsconfig-truststoreconfig", "UpdateType": "Mutable", "Required": false, "Type": "TrustStoreConfig" } } }, "AWS::CloudFront::Distribution.VpcOriginConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution.VpcOriginConfig`\n\nAn Amazon CloudFront VPC origin configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-vpcoriginconfig.html", "Properties": { "OriginReadTimeout": { "MarkdownDocumentation": "`OriginReadTimeout`\n\nSpecifies how long, in seconds, CloudFront waits for a response from the origin. This is\nalso known as the *origin response timeout*. The minimum timeout is 1\nsecond, the maximum is 120 seconds, and the default (if you don't specify otherwise) is\n30 seconds.\nFor more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-vpcoriginconfig.html#cfn-cloudfront-distribution-vpcoriginconfig-originreadtimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VpcOriginId": { "MarkdownDocumentation": "`VpcOriginId`\n\nThe VPC origin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-vpcoriginconfig.html#cfn-cloudfront-distribution-vpcoriginconfig-vpcoriginid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OriginKeepaliveTimeout": { "MarkdownDocumentation": "`OriginKeepaliveTimeout`\n\nSpecifies how long, in seconds, CloudFront persists its connection to the origin. The\nminimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't\nspecify otherwise) is 5 seconds.\nFor more information, see [Keep-alive timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-vpcoriginconfig.html#cfn-cloudfront-distribution-vpcoriginconfig-originkeepalivetimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OwnerAccountId": { "MarkdownDocumentation": "`OwnerAccountId`\n\nThe account ID of the AWS account that owns the VPC origin.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-vpcoriginconfig.html#cfn-cloudfront-distribution-vpcoriginconfig-owneraccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::DistributionTenant.Certificate": { "MarkdownDocumentation": "`AWS::CloudFront::DistributionTenant.Certificate`\n\nThe AWS Certificate Manager (ACM) certificate associated with your distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-certificate.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the ACM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-certificate.html#cfn-cloudfront-distributiontenant-certificate-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::DistributionTenant.Customizations": { "MarkdownDocumentation": "`AWS::CloudFront::DistributionTenant.Customizations`\n\nCustomizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and AWS WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-customizations.html", "Properties": { "WebAcl": { "MarkdownDocumentation": "`WebAcl`\n\nThe AWS WAF web ACL.\n*Required*: No\n*Type*: [WebAclCustomization](./aws-properties-cloudfront-distributiontenant-webaclcustomization.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-customizations.html#cfn-cloudfront-distributiontenant-customizations-webacl", "UpdateType": "Mutable", "Required": false, "Type": "WebAclCustomization" }, "GeoRestrictions": { "MarkdownDocumentation": "`GeoRestrictions`\n\nThe geographic restrictions.\n*Required*: No\n*Type*: [GeoRestrictionCustomization](./aws-properties-cloudfront-distributiontenant-georestrictioncustomization.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-customizations.html#cfn-cloudfront-distributiontenant-customizations-georestrictions", "UpdateType": "Mutable", "Required": false, "Type": "GeoRestrictionCustomization" }, "Certificate": { "MarkdownDocumentation": "`Certificate`\n\nThe AWS Certificate Manager (ACM) certificate.\n*Required*: No\n*Type*: [Certificate](./aws-properties-cloudfront-distributiontenant-certificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-customizations.html#cfn-cloudfront-distributiontenant-customizations-certificate", "UpdateType": "Mutable", "Required": false, "Type": "Certificate" } } }, "AWS::CloudFront::DistributionTenant.DomainResult": { "MarkdownDocumentation": "`AWS::CloudFront::DistributionTenant.DomainResult`\n\nThe details about the domain result.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-domainresult.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nWhether the domain is 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)", "RefReturnValue": "", "AllowedValues": [ "active", "inactive" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-domainresult.html#cfn-cloudfront-distributiontenant-domainresult-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe specified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-domainresult.html#cfn-cloudfront-distributiontenant-domainresult-domain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::DistributionTenant.GeoRestrictionCustomization": { "MarkdownDocumentation": "`AWS::CloudFront::DistributionTenant.GeoRestrictionCustomization`\n\nThe customizations that you specified for the distribution tenant for geographic restrictions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-georestrictioncustomization.html", "Properties": { "Locations": { "MarkdownDocumentation": "`Locations`\n\nThe locations for geographic restrictions.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-georestrictioncustomization.html#cfn-cloudfront-distributiontenant-georestrictioncustomization-locations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RestrictionType": { "MarkdownDocumentation": "`RestrictionType`\n\nThe method that you want to use to restrict distribution of your content by\ncountry:\n* `none`: No geographic restriction is enabled, meaning access to content is\n not restricted by client geo location.\n* `blacklist`: The `Location` elements specify the\n countries in which you don't want CloudFront to distribute your content.\n* `whitelist`: The `Location` elements specify the\n countries in which you want CloudFront to distribute your content.\n*Required*: No\n*Type*: String\n*Allowed values*: `blacklist | whitelist | non...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "blacklist", "whitelist", "none" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-georestrictioncustomization.html#cfn-cloudfront-distributiontenant-georestrictioncustomization-restrictiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::DistributionTenant.ManagedCertificateRequest": { "MarkdownDocumentation": "`AWS::CloudFront::DistributionTenant.ManagedCertificateRequest`\n\nAn object that represents the request for the Amazon CloudFront managed ACM certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-managedcertificaterequest.html", "Properties": { "CertificateTransparencyLoggingPreference": { "MarkdownDocumentation": "`CertificateTransparencyLoggingPreference`\n\nYou can opt out of certificate transparency logging by specifying the `disabled`\noption. Opt in by specifying `enabled`. For more information, see [Certificate\nTransparency Logging](https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency) in the *AWS Certificate Manager User\nGuide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `enabled | disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enabled", "disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-managedcertificaterequest.html#cfn-cloudfront-distributiontenant-managedcertificaterequest-certificatetransparencyloggingpreference", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValidationTokenHost": { "MarkdownDocumentation": "`ValidationTokenHost`\n\nSpecify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.\n* For `cloudfront`, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.\n* For `self-hosted`, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.\n*Required*: No\n*Type*: String\n*Allowed values*: `cloudfront | self-hosted...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "cloudfront", "self-hosted" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-managedcertificaterequest.html#cfn-cloudfront-distributiontenant-managedcertificaterequest-validationtokenhost", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrimaryDomainName": { "MarkdownDocumentation": "`PrimaryDomainName`\n\nThe primary domain name associated with the CloudFront managed ACM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-managedcertificaterequest.html#cfn-cloudfront-distributiontenant-managedcertificaterequest-primarydomainname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::DistributionTenant.Parameter": { "MarkdownDocumentation": "`AWS::CloudFront::DistributionTenant.Parameter`\n\nA list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-parameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe parameter value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-parameter.html#cfn-cloudfront-distributiontenant-parameter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe parameter name.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-parameter.html#cfn-cloudfront-distributiontenant-parameter-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::DistributionTenant.WebAclCustomization": { "MarkdownDocumentation": "`AWS::CloudFront::DistributionTenant.WebAclCustomization`\n\nThe AWS WAF web ACL customization specified for the distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-webaclcustomization.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action for the AWS WAF web ACL customization. You can specify `override` to specify a separate AWS WAF web ACL for the distribution tenant. If you specify `disable`, the distribution tenant won't have AWS WAF web ACL protections and won't inherit from the multi-tenant distribution.\n*Required*: No\n*Type*: String\n*Allowed values*: `override | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "override", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-webaclcustomization.html#cfn-cloudfront-distributiontenant-webaclcustomization-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the AWS WAF web 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-webaclcustomization.html#cfn-cloudfront-distributiontenant-webaclcustomization-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Function.FunctionConfig": { "MarkdownDocumentation": "`AWS::CloudFront::Function.FunctionConfig`\n\nContains configuration information about a CloudFront function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionconfig.html#cfn-cloudfront-function-functionconfig-comment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nThe function's runtime environment version.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `cloudfront-js-1.0 | cloudfr...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "cloudfront-js-1.0", "cloudfront-js-2.0" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionconfig.html#cfn-cloudfront-function-functionconfig-runtime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyValueStoreAssociations": { "MarkdownDocumentation": "`KeyValueStoreAssociations`\n\nThe configuration for the key value store associations.\n*Required*: No\n*Type*: Array of [KeyValueStoreAssociation](./aws-properties-cloudfront-function-keyvaluestoreassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionconfig.html#cfn-cloudfront-function-functionconfig-keyvaluestoreassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValueStoreAssociation", "DuplicatesAllowed": false } } }, "AWS::CloudFront::Function.FunctionMetadata": { "MarkdownDocumentation": "`AWS::CloudFront::Function.FunctionMetadata`\n\nContains metadata about a CloudFront function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionmetadata.html", "Properties": { "FunctionARN": { "MarkdownDocumentation": "`FunctionARN`\n\nThe Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the\nfunction.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionmetadata.html#cfn-cloudfront-function-functionmetadata-functionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFront::Function.KeyValueStoreAssociation": { "MarkdownDocumentation": "`AWS::CloudFront::Function.KeyValueStoreAssociation`\n\nThe key value store association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-keyvaluestoreassociation.html", "Properties": { "KeyValueStoreARN": { "MarkdownDocumentation": "`KeyValueStoreARN`\n\nThe Amazon Resource Name (ARN) of the key value store association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws:cloudfront::[0-9]{12}:key-value-store\\/[0-9a-fA-F-]{36}`\n*Minimum*: `0`\n*Maximum*: `85`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-keyvaluestoreassociation.html#cfn-cloudfront-function-keyvaluestoreassociation-keyvaluestorearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::KeyGroup.KeyGroupConfig": { "MarkdownDocumentation": "`AWS::CloudFront::KeyGroup.KeyGroupConfig`\n\nA key group configuration.\nA key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keygroup-keygroupconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA comment to describe the key group. The comment cannot be longer than 128\ncharacters.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keygroup-keygroupconfig.html#cfn-cloudfront-keygroup-keygroupconfig-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Items": { "MarkdownDocumentation": "`Items`\n\nA list of the identifiers of the public keys in the key group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keygroup-keygroupconfig.html#cfn-cloudfront-keygroup-keygroupconfig-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keygroup-keygroupconfig.html#cfn-cloudfront-keygroup-keygroupconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::KeyValueStore.ImportSource": { "MarkdownDocumentation": "`AWS::CloudFront::KeyValueStore.ImportSource`\n\nThe import source for the key value store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keyvaluestore-importsource.html", "Properties": { "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe Amazon Resource Name (ARN) of the import source for the key value store.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keyvaluestore-importsource.html#cfn-cloudfront-keyvaluestore-importsource-sourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceType": { "MarkdownDocumentation": "`SourceType`\n\nThe source type of the import source for the key value store.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `S3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "S3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keyvaluestore-importsource.html#cfn-cloudfront-keyvaluestore-importsource-sourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::MonitoringSubscription.MonitoringSubscription": { "MarkdownDocumentation": "`AWS::CloudFront::MonitoringSubscription.MonitoringSubscription`\n\nA monitoring subscription. This structure contains information about whether\nadditional CloudWatch metrics are enabled for a given CloudFront distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-monitoringsubscription.html", "Properties": { "RealtimeMetricsSubscriptionConfig": { "MarkdownDocumentation": "`RealtimeMetricsSubscriptionConfig`\n\nA subscription configuration for additional CloudWatch metrics.\n*Required*: No\n*Type*: [RealtimeMetricsSubscriptionConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-monitoringsubscription.html#cfn-cloudfront-monitoringsubscription-monitoringsubscription-realtimemetricssubscriptionconfig", "UpdateType": "Mutable", "Required": false, "Type": "RealtimeMetricsSubscriptionConfig" } } }, "AWS::CloudFront::MonitoringSubscription.RealtimeMetricsSubscriptionConfig": { "MarkdownDocumentation": "`AWS::CloudFront::MonitoringSubscription.RealtimeMetricsSubscriptionConfig`\n\nA subscription configuration for additional CloudWatch metrics.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig.html", "Properties": { "RealtimeMetricsSubscriptionStatus": { "MarkdownDocumentation": "`RealtimeMetricsSubscriptionStatus`\n\nA flag that indicates whether additional CloudWatch metrics are enabled for a given\nCloudFront distribution.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Enabled | Disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig.html#cfn-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig-realtimemetricssubscriptionstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::OriginAccessControl.OriginAccessControlConfig": { "MarkdownDocumentation": "`AWS::CloudFront::OriginAccessControl.OriginAccessControlConfig`\n\nCreates a new origin access control in CloudFront. After you create an origin access\ncontrol, you can add it to an origin in a CloudFront distribution so that CloudFront sends\nauthenticated (signed) requests to the origin.\nThis makes it possible to block public access to the origin, allowing viewers (users) to\naccess the origin's content only through CloudFront.\nFor more information about using a CloudFront origin access control, see [Restricting access to an AWS origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the\n*Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html", "Properties": { "SigningBehavior": { "MarkdownDocumentation": "`SigningBehavior`\n\nSpecifies which requests CloudFront signs (adds authentication information to). Specify\n`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\n*Amazon CloudFront Developer Guide*.\nThis field can have one of the following values:\n* `always` \u2013 CloudFront signs all origin requests, overwriting the\n `Authorization` header from the viewer request if one\n exists.\n* `never` \u2013 CloudFront doesn't sign any origin requests. This value turns\n off origin access control for all origins in all distributions that use this\n origin access control.\n* `no-override` \u2013 If the viewer request doesn't contain the\n `Authorization` header, then CloudFront signs the origin request. If\n the viewer request contains the `Authorization` header, then CloudFront\n doesn't sign the origin request and instead passes along the\n `Authorization` header from the viewer request. **WARNING: To pass along the `Authorization` header\n from the viewer request, you *must* add the\n `Authorization` header to a [cache policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) for all cache behaviors that\n use origins associated with this origin access control.**\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(never|no-override|always)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OriginAccessControlOriginType": { "MarkdownDocumentation": "`OriginAccessControlOriginType`\n\nThe type of origin that this origin access control is for.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(s3|mediastore|lambda|mediapackagev2)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-originaccesscontrolorigintype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SigningProtocol": { "MarkdownDocumentation": "`SigningProtocol`\n\nThe signing protocol of the origin access control, which determines how CloudFront signs\n(authenticates) requests. The only valid value is `sigv4`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(sigv4)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-signingprotocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name to identify the origin access control. You can specify up to 64 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::OriginRequestPolicy.CookiesConfig": { "MarkdownDocumentation": "`AWS::CloudFront::OriginRequestPolicy.CookiesConfig`\n\nAn object that determines whether any cookies in viewer requests (and if so, which\ncookies) are included in requests that CloudFront sends to the origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-cookiesconfig.html", "Properties": { "Cookies": { "MarkdownDocumentation": "`Cookies`\n\nContains a list of cookie names.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-cookiesconfig.html#cfn-cloudfront-originrequestpolicy-cookiesconfig-cookies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CookieBehavior": { "MarkdownDocumentation": "`CookieBehavior`\n\nDetermines whether cookies in viewer requests are included in requests that CloudFront sends\nto the origin. Valid values are:\n* `none` \u2013 No cookies in viewer requests are included in requests that CloudFront sends\n to the origin. Even when this field is set to `none`, any cookies\n that are listed in a `CachePolicy`*are* included\n in origin requests.\n* `whitelist` \u2013 Only the cookies in viewer requests that are listed in the\n `CookieNames` type are included in requests that CloudFront sends to the\n origin.\n* `all` \u2013 All cookies in viewer requests are included in requests\n that CloudFront sends to the origin.\n* `allExcept` \u2013 All cookies in viewer requests are included in\n requests that CloudFront sends to the origin, ***except*** for those listed in the `CookieNames`\n type, which are not included.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(none|whitelist|all|allExcept)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-cookiesconfig.html#cfn-cloudfront-originrequestpolicy-cookiesconfig-cookiebehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::OriginRequestPolicy.HeadersConfig": { "MarkdownDocumentation": "`AWS::CloudFront::OriginRequestPolicy.HeadersConfig`\n\nAn object that determines whether any HTTP headers (and if so, which headers) are\nincluded in requests that CloudFront sends to the origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-headersconfig.html", "Properties": { "Headers": { "MarkdownDocumentation": "`Headers`\n\nContains a list of HTTP header names.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-headersconfig.html#cfn-cloudfront-originrequestpolicy-headersconfig-headers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "HeaderBehavior": { "MarkdownDocumentation": "`HeaderBehavior`\n\nDetermines whether any HTTP headers are included in requests that CloudFront sends to the\norigin. Valid values are:\n* `none` \u2013 No HTTP headers in viewer requests are included in requests that CloudFront\n sends to the origin. Even when this field is set to `none`, any\n headers that are listed in a `CachePolicy`*are*\n included in origin requests.\n* `whitelist` \u2013 Only the HTTP headers that are listed in the `Headers`\n type are included in requests that CloudFront sends to the origin.\n* `allViewer` \u2013 All HTTP headers in viewer requests are included in\n requests that CloudFront sends to the origin.\n* `allViewerAndWhitelistCloudFront` \u2013 All HTTP headers in viewer\n requests and the additional CloudFront headers that are listed in the\n `Headers` type are included in requests that CloudFront sends to the\n origin. The additional headers are added by CloudFront.\n* `allExcept` \u2013 All HTTP headers in viewer requests are included in\n requests that CloudFront sends to the origin, ***except*** for those listed in the `Headers` type,\n which are not included.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-headersconfig.html#cfn-cloudfront-originrequestpolicy-headersconfig-headerbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::OriginRequestPolicy.OriginRequestPolicyConfig": { "MarkdownDocumentation": "`AWS::CloudFront::OriginRequestPolicy.OriginRequestPolicyConfig`\n\nAn origin request policy configuration.\nThis configuration determines the values that CloudFront includes in requests that it sends\nto the origin. Each request that CloudFront sends to the origin includes the following:\n* The request body and the URL path (without the domain name) from the viewer\n request.\n* The headers that CloudFront automatically includes in every origin request,\n including `Host`, `User-Agent`, and\n `X-Amz-Cf-Id`.\n* All HTTP headers, cookies, and URL query strings that are specified in the\n cache policy or the origin request policy. These can include items from the\n viewer request and, in the case of headers, additional ones that are added by\n CloudFront.\nCloudFront sends a request when it can't find an object in its cache that matches the\nrequest. If you want to send values to the origin and also include them in the cache\nkey, use `CachePolicy`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA comment to describe the origin request policy. The comment cannot be longer than 128\ncharacters.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.html#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HeadersConfig": { "MarkdownDocumentation": "`HeadersConfig`\n\nThe HTTP headers to include in origin requests. These can include headers from viewer\nrequests and additional headers added by CloudFront.\n*Required*: Yes\n*Type*: [HeadersConfig](./aws-properties-cloudfront-originrequestpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.html#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-headersconfig", "UpdateType": "Mutable", "Required": true, "Type": "HeadersConfig" }, "CookiesConfig": { "MarkdownDocumentation": "`CookiesConfig`\n\nThe cookies from viewer requests to include in origin requests.\n*Required*: Yes\n*Type*: [CookiesConfig](./aws-properties-cloudfront-originrequestpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.html#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-cookiesconfig", "UpdateType": "Mutable", "Required": true, "Type": "CookiesConfig" }, "QueryStringsConfig": { "MarkdownDocumentation": "`QueryStringsConfig`\n\nThe URL query strings from viewer requests to include in origin requests.\n*Required*: Yes\n*Type*: [QueryStringsConfig](./aws-properties-cloudfront-originrequestpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.html#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-querystringsconfig", "UpdateType": "Mutable", "Required": true, "Type": "QueryStringsConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA unique name to identify the origin request 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.html#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::OriginRequestPolicy.QueryStringsConfig": { "MarkdownDocumentation": "`AWS::CloudFront::OriginRequestPolicy.QueryStringsConfig`\n\nAn object that determines whether any URL query strings in viewer requests (and if so,\nwhich query strings) are included in requests that CloudFront sends to the origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-querystringsconfig.html", "Properties": { "QueryStrings": { "MarkdownDocumentation": "`QueryStrings`\n\nContains a list of query string names.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-querystringsconfig.html#cfn-cloudfront-originrequestpolicy-querystringsconfig-querystrings", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "QueryStringBehavior": { "MarkdownDocumentation": "`QueryStringBehavior`\n\nDetermines whether any URL query strings in viewer requests are included in requests\nthat CloudFront sends to the origin. Valid values are:\n* `none` \u2013 No query strings in viewer requests are included in requests that CloudFront\n sends to the origin. Even when this field is set to `none`, any query\n strings that are listed in a `CachePolicy`*are*\n included in origin requests.\n* `whitelist` \u2013 Only the query strings in viewer requests that are listed in the\n `QueryStringNames` type are included in requests that CloudFront sends to\n the origin.\n* `all` \u2013 All query strings in viewer requests are included in requests that CloudFront\n sends to the origin.\n* `allExcept` \u2013 All query strings in viewer requests are included in\n requests that CloudFront sends to the origin, ***except*** for those listed in the\n `QueryStringNames` type, which are not included.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(none|whitelist|all|allExcept)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-querystringsconfig.html#cfn-cloudfront-originrequestpolicy-querystringsconfig-querystringbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::PublicKey.PublicKeyConfig": { "MarkdownDocumentation": "`AWS::CloudFront::PublicKey.PublicKeyConfig`\n\nConfiguration 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).\nCloudFront supports signed URLs and signed cookies with RSA 2048 or ECDSA 256 key signatures. Field-level encryption is only compatible with RSA 2048 key signatures.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-publickey-publickeyconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA comment to describe the public key. The comment cannot be longer than 128\ncharacters.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-publickey-publickeyconfig.html#cfn-cloudfront-publickey-publickeyconfig-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CallerReference": { "MarkdownDocumentation": "`CallerReference`\n\nA string included in the request to help make sure that the request can't be\nreplayed.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-publickey-publickeyconfig.html#cfn-cloudfront-publickey-publickeyconfig-callerreference", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EncodedKey": { "MarkdownDocumentation": "`EncodedKey`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-publickey-publickeyconfig.html#cfn-cloudfront-publickey-publickeyconfig-encodedkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-publickey-publickeyconfig.html#cfn-cloudfront-publickey-publickeyconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::RealtimeLogConfig.EndPoint": { "MarkdownDocumentation": "`AWS::CloudFront::RealtimeLogConfig.EndPoint`\n\nContains information about the Amazon Kinesis data stream where you are sending real-time\nlog data for this real-time log configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-endpoint.html", "Properties": { "KinesisStreamConfig": { "MarkdownDocumentation": "`KinesisStreamConfig`\n\nContains information about the Amazon Kinesis data stream where you are sending real-time\nlog data in a real-time log configuration.\n*Required*: Yes\n*Type*: [KinesisStreamConfig](./aws-properties-cloudfront-realtimelogconfig-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-endpoint.html#cfn-cloudfront-realtimelogconfig-endpoint-kinesisstreamconfig", "UpdateType": "Mutable", "Required": true, "Type": "KinesisStreamConfig" }, "StreamType": { "MarkdownDocumentation": "`StreamType`\n\nThe type of data stream where you are sending real-time log data. The only valid value\nis `Kinesis`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-endpoint.html#cfn-cloudfront-realtimelogconfig-endpoint-streamtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::RealtimeLogConfig.KinesisStreamConfig": { "MarkdownDocumentation": "`AWS::CloudFront::RealtimeLogConfig.KinesisStreamConfig`\n\nContains information about the Amazon Kinesis data stream where you are sending real-time\nlog data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig.html", "Properties": { "StreamArn": { "MarkdownDocumentation": "`StreamArn`\n\nThe Amazon Resource Name (ARN) of the Kinesis data stream where you are sending\nreal-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig.html#cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-streamarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to\nsend real-time log data to your Kinesis data stream.\nFor more information the IAM role, see [Real-time log configuration IAM role](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig.html#cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::ResponseHeadersPolicy.AccessControlAllowHeaders": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.AccessControlAllowHeaders`\n\nA list of HTTP header names that CloudFront includes as values for the\n`Access-Control-Allow-Headers` HTTP response header.\nFor more information about the `Access-Control-Allow-Headers` HTTP response\nheader, see [Access-Control-Allow-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders.html", "Properties": { "Items": { "MarkdownDocumentation": "`Items`\n\nThe list of HTTP header names. You can specify `*` to allow all\nheaders.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders.html#cfn-cloudfront-responseheaderspolicy-accesscontrolallowheaders-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CloudFront::ResponseHeadersPolicy.AccessControlAllowMethods": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.AccessControlAllowMethods`\n\nA list of HTTP methods that CloudFront includes as values for the\n`Access-Control-Allow-Methods` HTTP response header.\nFor more information about the `Access-Control-Allow-Methods` HTTP response\nheader, see [Access-Control-Allow-Methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods.html", "Properties": { "Items": { "MarkdownDocumentation": "`Items`\n\nThe list of HTTP methods. Valid values are:\n* `GET`\n* `DELETE`\n* `HEAD`\n* `OPTIONS`\n* `PATCH`\n* `POST`\n* `PUT`\n* `ALL`\n`ALL` is a special value that includes all of the listed HTTP\nmethods.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods.html#cfn-cloudfront-responseheaderspolicy-accesscontrolallowmethods-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CloudFront::ResponseHeadersPolicy.AccessControlAllowOrigins": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.AccessControlAllowOrigins`\n\nA list of origins (domain names) that CloudFront can use as the value for the\n`Access-Control-Allow-Origin` HTTP response header.\nFor more information about the `Access-Control-Allow-Origin` HTTP response\nheader, see [Access-Control-Allow-Origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins.html", "Properties": { "Items": { "MarkdownDocumentation": "`Items`\n\nThe list of origins (domain names). You can specify `*` to allow all\norigins.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins.html#cfn-cloudfront-responseheaderspolicy-accesscontrolalloworigins-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CloudFront::ResponseHeadersPolicy.AccessControlExposeHeaders": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.AccessControlExposeHeaders`\n\nA list of HTTP headers that CloudFront includes as values for the\n`Access-Control-Expose-Headers` HTTP response header.\nFor more information about the `Access-Control-Expose-Headers` HTTP\nresponse header, see [Access-Control-Expose-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders.html", "Properties": { "Items": { "MarkdownDocumentation": "`Items`\n\nThe list of HTTP headers. You can specify `*` to expose all headers.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders.html#cfn-cloudfront-responseheaderspolicy-accesscontrolexposeheaders-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CloudFront::ResponseHeadersPolicy.ContentSecurityPolicy": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.ContentSecurityPolicy`\n\nThe policy directives and their values that CloudFront includes as values for the\n`Content-Security-Policy` HTTP response header.\nFor more information about the `Content-Security-Policy` HTTP response\nheader, see [Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy.html", "Properties": { "ContentSecurityPolicy": { "MarkdownDocumentation": "`ContentSecurityPolicy`\n\nThe policy directives and their values that CloudFront includes as values for the\n`Content-Security-Policy` HTTP response header.\n*Required*: Yes\n*Type*: [String](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy.html#cfn-cloudfront-responseheaderspolicy-contentsecuritypolicy-contentsecuritypolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Override": { "MarkdownDocumentation": "`Override`\n\nA Boolean that determines whether CloudFront overrides the\n`Content-Security-Policy` HTTP response header received from the origin\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy.html#cfn-cloudfront-responseheaderspolicy-contentsecuritypolicy-override", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::ResponseHeadersPolicy.ContentTypeOptions": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.ContentTypeOptions`\n\nDetermines whether CloudFront includes the `X-Content-Type-Options` HTTP response\nheader with its value set to `nosniff`.\nFor more information about the `X-Content-Type-Options` HTTP response\nheader, 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions.html", "Properties": { "Override": { "MarkdownDocumentation": "`Override`\n\nA Boolean that determines whether CloudFront overrides the\n`X-Content-Type-Options` HTTP response header received from the origin\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions.html#cfn-cloudfront-responseheaderspolicy-contenttypeoptions-override", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::ResponseHeadersPolicy.CorsConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.CorsConfig`\n\nA configuration for a set of HTTP response headers that are used for cross-origin\nresource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for\nCORS requests that match a cache behavior associated with this response headers\npolicy.\nFor more information about CORS, see [Cross-Origin Resource\nSharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html", "Properties": { "AccessControlAllowCredentials": { "MarkdownDocumentation": "`AccessControlAllowCredentials`\n\nA Boolean that CloudFront uses as the value for the\n`Access-Control-Allow-Credentials` HTTP response header.\nFor more information about the `Access-Control-Allow-Credentials` HTTP\nresponse header, see [Access-Control-Allow-Credentials](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials) in the MDN Web Docs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowcredentials", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "AccessControlAllowHeaders": { "MarkdownDocumentation": "`AccessControlAllowHeaders`\n\nA list of HTTP header names that CloudFront includes as values for the\n`Access-Control-Allow-Headers` HTTP response header.\nFor more information about the `Access-Control-Allow-Headers` HTTP response\nheader, see [Access-Control-Allow-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) in the MDN Web Docs.\n*Required*: Yes\n*Type*: [AccessControlAllowHeaders](./aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowheaders.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowheaders", "UpdateType": "Mutable", "Required": true, "Type": "AccessControlAllowHeaders" }, "OriginOverride": { "MarkdownDocumentation": "`OriginOverride`\n\nA Boolean that determines whether CloudFront overrides HTTP response headers received from\nthe origin with the ones 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-originoverride", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "AccessControlAllowMethods": { "MarkdownDocumentation": "`AccessControlAllowMethods`\n\nA list of HTTP methods that CloudFront includes as values for the\n`Access-Control-Allow-Methods` HTTP response header.\nFor more information about the `Access-Control-Allow-Methods` HTTP response\nheader, see [Access-Control-Allow-Methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) in the MDN Web Docs.\n*Required*: Yes\n*Type*: [AccessControlAllowMethods](./aws-properties-cloudfront-responseheaderspolicy-accesscontrolallowmethods.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowmethods", "UpdateType": "Mutable", "Required": true, "Type": "AccessControlAllowMethods" }, "AccessControlExposeHeaders": { "MarkdownDocumentation": "`AccessControlExposeHeaders`\n\nA list of HTTP headers that CloudFront includes as values for the\n`Access-Control-Expose-Headers` HTTP response header.\nFor more information about the `Access-Control-Expose-Headers` HTTP\nresponse header, see [Access-Control-Expose-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) in the MDN Web Docs.\n*Required*: No\n*Type*: [AccessControlExposeHeaders](./aws-properties-cloudfront-responseheaderspolicy-accesscontrolexposeheaders.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolexposeheaders", "UpdateType": "Mutable", "Required": false, "Type": "AccessControlExposeHeaders" }, "AccessControlAllowOrigins": { "MarkdownDocumentation": "`AccessControlAllowOrigins`\n\nA list of origins (domain names) that CloudFront can use as the value for the\n`Access-Control-Allow-Origin` HTTP response header.\nFor more information about the `Access-Control-Allow-Origin` HTTP response\nheader, see [Access-Control-Allow-Origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) in the MDN Web Docs.\n*Required*: Yes\n*Type*: [AccessControlAllowOrigins](./aws-properties-cloudfront-responseheaderspolicy-accesscontrolalloworigins.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolalloworigins", "UpdateType": "Mutable", "Required": true, "Type": "AccessControlAllowOrigins" }, "AccessControlMaxAgeSec": { "MarkdownDocumentation": "`AccessControlMaxAgeSec`\n\nA number that CloudFront uses as the value for the `Access-Control-Max-Age` HTTP\nresponse header.\nFor more information about the `Access-Control-Max-Age` HTTP response\nheader, see [Access-Control-Max-Age](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age) in the MDN Web Docs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolmaxagesec", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::CloudFront::ResponseHeadersPolicy.CustomHeader": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.CustomHeader`\n\nAn HTTP response header name and its value. CloudFront includes this header in HTTP\nresponses that it sends for requests that match a cache behavior that's associated with\nthis response headers policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-customheader.html", "Properties": { "Header": { "MarkdownDocumentation": "`Header`\n\nThe HTTP response 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-customheader.html#cfn-cloudfront-responseheaderspolicy-customheader-header", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the HTTP response header.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-customheader.html#cfn-cloudfront-responseheaderspolicy-customheader-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Override": { "MarkdownDocumentation": "`Override`\n\nA Boolean that determines whether CloudFront overrides a response header with the same name\nreceived from the origin with the header specified here.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-customheader.html#cfn-cloudfront-responseheaderspolicy-customheader-override", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::ResponseHeadersPolicy.CustomHeadersConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.CustomHeadersConfig`\n\nA list of HTTP response header names and their values. CloudFront includes these headers in\nHTTP responses that it sends for requests that match a cache behavior that's associated\nwith this response headers policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-customheadersconfig.html", "Properties": { "Items": { "MarkdownDocumentation": "`Items`\n\nThe list of HTTP response headers and their values.\n*Required*: Yes\n*Type*: Array of [CustomHeader](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-customheadersconfig.html#cfn-cloudfront-responseheaderspolicy-customheadersconfig-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CustomHeader", "DuplicatesAllowed": true } } }, "AWS::CloudFront::ResponseHeadersPolicy.FrameOptions": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.FrameOptions`\n\nDetermines whether CloudFront includes the `X-Frame-Options` HTTP response header\nand the header's value.\nFor more information about the `X-Frame-Options` HTTP response header, see\n[X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html", "Properties": { "FrameOption": { "MarkdownDocumentation": "`FrameOption`\n\nThe value of the `X-Frame-Options` HTTP response header. Valid values are\n`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*Pattern*: `^(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html#cfn-cloudfront-responseheaderspolicy-frameoptions-frameoption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Override": { "MarkdownDocumentation": "`Override`\n\nA Boolean that determines whether CloudFront overrides the `X-Frame-Options` HTTP\nresponse header received from the origin with the one specified in this response headers\npolicy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html#cfn-cloudfront-responseheaderspolicy-frameoptions-override", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::ResponseHeadersPolicy.ReferrerPolicy": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.ReferrerPolicy`\n\nDetermines whether CloudFront includes the `Referrer-Policy` HTTP response header\nand the header's value.\nFor more information about the `Referrer-Policy` HTTP response header, see\n[Referrer-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html", "Properties": { "Override": { "MarkdownDocumentation": "`Override`\n\nA Boolean that determines whether CloudFront overrides the `Referrer-Policy` HTTP\nresponse header received from the origin with the one specified in this response headers\npolicy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html#cfn-cloudfront-responseheaderspolicy-referrerpolicy-override", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "ReferrerPolicy": { "MarkdownDocumentation": "`ReferrerPolicy`\n\nThe value of the `Referrer-Policy` HTTP response header. Valid values\nare:\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](./aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html)\n*Pattern*: `^(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html#cfn-cloudfront-responseheaderspolicy-referrerpolicy-referrerpolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::ResponseHeadersPolicy.RemoveHeader": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.RemoveHeader`\n\nThe name of an HTTP header that CloudFront removes from HTTP responses to requests that match the\ncache behavior that this response headers policy is attached to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheader.html", "Properties": { "Header": { "MarkdownDocumentation": "`Header`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheader.html#cfn-cloudfront-responseheaderspolicy-removeheader-header", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::ResponseHeadersPolicy.RemoveHeadersConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.RemoveHeadersConfig`\n\nA list of HTTP header names that CloudFront removes from HTTP responses to requests that match the\ncache behavior that this response headers policy is attached to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig.html", "Properties": { "Items": { "MarkdownDocumentation": "`Items`\n\nThe list of HTTP header names.\n*Required*: Yes\n*Type*: Array of [RemoveHeader](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig.html#cfn-cloudfront-responseheaderspolicy-removeheadersconfig-items", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RemoveHeader", "DuplicatesAllowed": false } } }, "AWS::CloudFront::ResponseHeadersPolicy.ResponseHeadersPolicyConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.ResponseHeadersPolicyConfig`\n\nA response headers policy configuration.\nA response headers policy configuration contains metadata about the response headers policy,\nand configurations for sets of HTTP response headers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityHeadersConfig": { "MarkdownDocumentation": "`SecurityHeadersConfig`\n\nA configuration for a set of security-related HTTP response headers.\n*Required*: No\n*Type*: [SecurityHeadersConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-securityheadersconfig", "UpdateType": "Mutable", "Required": false, "Type": "SecurityHeadersConfig" }, "RemoveHeadersConfig": { "MarkdownDocumentation": "`RemoveHeadersConfig`\n\nA configuration for a set of HTTP headers to remove from the HTTP response.\n*Required*: No\n*Type*: [RemoveHeadersConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-removeheadersconfig", "UpdateType": "Mutable", "Required": false, "Type": "RemoveHeadersConfig" }, "CorsConfig": { "MarkdownDocumentation": "`CorsConfig`\n\nA configuration for a set of HTTP response headers that are used for cross-origin\nresource sharing (CORS).\n*Required*: No\n*Type*: [CorsConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-corsconfig", "UpdateType": "Mutable", "Required": false, "Type": "CorsConfig" }, "ServerTimingHeadersConfig": { "MarkdownDocumentation": "`ServerTimingHeadersConfig`\n\nA configuration for enabling the `Server-Timing` header in HTTP responses\nsent from CloudFront.\n*Required*: No\n*Type*: [ServerTimingHeadersConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-servertimingheadersconfig", "UpdateType": "Mutable", "Required": false, "Type": "ServerTimingHeadersConfig" }, "CustomHeadersConfig": { "MarkdownDocumentation": "`CustomHeadersConfig`\n\nA configuration for a set of custom HTTP response headers.\n*Required*: No\n*Type*: [CustomHeadersConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-customheadersconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomHeadersConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::ResponseHeadersPolicy.SecurityHeadersConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.SecurityHeadersConfig`\n\nA configuration for a set of security-related HTTP response headers. CloudFront adds these\nheaders to HTTP responses that it sends for requests that match a cache behavior\nassociated with this response headers policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html", "Properties": { "ContentSecurityPolicy": { "MarkdownDocumentation": "`ContentSecurityPolicy`\n\nThe policy directives and their values that CloudFront includes as values for the\n`Content-Security-Policy` HTTP response header.\nFor more information about the `Content-Security-Policy` HTTP response\nheader, 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-contentsecuritypolicy", "UpdateType": "Mutable", "Required": false, "Type": "ContentSecurityPolicy" }, "FrameOptions": { "MarkdownDocumentation": "`FrameOptions`\n\nDetermines whether CloudFront includes the `X-Frame-Options` HTTP response header\nand the header's value.\nFor more information about the `X-Frame-Options` HTTP response header, see\n[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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-frameoptions", "UpdateType": "Mutable", "Required": false, "Type": "FrameOptions" }, "ContentTypeOptions": { "MarkdownDocumentation": "`ContentTypeOptions`\n\nDetermines whether CloudFront includes the `X-Content-Type-Options` HTTP response\nheader with its value set to `nosniff`.\nFor more information about the `X-Content-Type-Options` HTTP response\nheader, 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-contenttypeoptions", "UpdateType": "Mutable", "Required": false, "Type": "ContentTypeOptions" }, "StrictTransportSecurity": { "MarkdownDocumentation": "`StrictTransportSecurity`\n\nDetermines whether CloudFront includes the `Strict-Transport-Security` HTTP\nresponse header and the header's value.\nFor more information about the `Strict-Transport-Security` HTTP response\nheader, see [Security headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#understanding-response-headers-policies-security) in the *Amazon CloudFront Developer Guide* and [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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-stricttransportsecurity", "UpdateType": "Mutable", "Required": false, "Type": "StrictTransportSecurity" }, "XSSProtection": { "MarkdownDocumentation": "`XSSProtection`\n\nDetermines whether CloudFront includes the `X-XSS-Protection` HTTP response\nheader and the header's value.\nFor more information about the `X-XSS-Protection` HTTP response header, see\n[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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-xssprotection", "UpdateType": "Mutable", "Required": false, "Type": "XSSProtection" }, "ReferrerPolicy": { "MarkdownDocumentation": "`ReferrerPolicy`\n\nDetermines whether CloudFront includes the `Referrer-Policy` HTTP response header\nand the header's value.\nFor more information about the `Referrer-Policy` HTTP response header, see\n[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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html#cfn-cloudfront-responseheaderspolicy-securityheadersconfig-referrerpolicy", "UpdateType": "Mutable", "Required": false, "Type": "ReferrerPolicy" } } }, "AWS::CloudFront::ResponseHeadersPolicy.ServerTimingHeadersConfig": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.ServerTimingHeadersConfig`\n\nA configuration for enabling the `Server-Timing` header in HTTP responses\nsent from CloudFront.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nA Boolean that determines whether CloudFront adds the `Server-Timing` header to\nHTTP responses that it sends in response to requests that match a cache behavior that's\nassociated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html#cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "SamplingRate": { "MarkdownDocumentation": "`SamplingRate`\n\nA number 0\u2013100 (inclusive) that specifies the percentage of responses that you want\nCloudFront to add the `Server-Timing` header to. When you set the sampling rate to\n100, CloudFront adds the `Server-Timing` header to the HTTP response for every\nrequest that matches the cache behavior that this response headers policy is attached\nto. When you set it to 50, CloudFront adds the header to 50% of the responses for requests\nthat match the cache behavior. You can set the sampling rate to any number 0\u2013100 with up\nto four decimal places.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html#cfn-cloudfront-responseheaderspolicy-servertimingheadersconfig-samplingrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::CloudFront::ResponseHeadersPolicy.StrictTransportSecurity": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.StrictTransportSecurity`\n\nDetermines whether CloudFront includes the `Strict-Transport-Security` HTTP\nresponse header and the header's value.\nFor more information about the `Strict-Transport-Security` HTTP response\nheader, see [Strict-Transport-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html", "Properties": { "Preload": { "MarkdownDocumentation": "`Preload`\n\nA Boolean that determines whether CloudFront includes the `preload` directive in\nthe `Strict-Transport-Security` HTTP response 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-preload", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AccessControlMaxAgeSec": { "MarkdownDocumentation": "`AccessControlMaxAgeSec`\n\nA number that CloudFront uses as the value for the `max-age` directive in the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-accesscontrolmaxagesec", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "IncludeSubdomains": { "MarkdownDocumentation": "`IncludeSubdomains`\n\nA Boolean that determines whether CloudFront includes the `includeSubDomains`\ndirective in the `Strict-Transport-Security` HTTP response 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-includesubdomains", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Override": { "MarkdownDocumentation": "`Override`\n\nA Boolean that determines whether CloudFront overrides the\n`Strict-Transport-Security` HTTP response header received from the origin\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html#cfn-cloudfront-responseheaderspolicy-stricttransportsecurity-override", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::ResponseHeadersPolicy.XSSProtection": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy.XSSProtection`\n\nDetermines whether CloudFront includes the `X-XSS-Protection` HTTP response\nheader and the header's value.\nFor more information about the `X-XSS-Protection` HTTP response header, see\n[X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html", "Properties": { "ReportUri": { "MarkdownDocumentation": "`ReportUri`\n\nA reporting URI, which CloudFront uses as the value of the `report` directive in\nthe `X-XSS-Protection` header.\nYou cannot specify a `ReportUri` when `ModeBlock` is\n`true`.\nFor more information about using a reporting URL, 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*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html#cfn-cloudfront-responseheaderspolicy-xssprotection-reporturi", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Override": { "MarkdownDocumentation": "`Override`\n\nA Boolean that determines whether CloudFront overrides the `X-XSS-Protection`\nHTTP response header received from the origin with the one specified in this response\nheaders 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html#cfn-cloudfront-responseheaderspolicy-xssprotection-override", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Protection": { "MarkdownDocumentation": "`Protection`\n\nA Boolean that determines the value of the `X-XSS-Protection` HTTP response\nheader. When this setting is `true`, the value of the\n`X-XSS-Protection` header is `1`. When this setting is\n`false`, the value of the `X-XSS-Protection` header is\n`0`.\nFor more information about these settings, see [X-XSS-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html#cfn-cloudfront-responseheaderspolicy-xssprotection-protection", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "ModeBlock": { "MarkdownDocumentation": "`ModeBlock`\n\nA Boolean that determines whether CloudFront includes the `mode=block` directive\nin the `X-XSS-Protection` header.\nFor more information about this directive, 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*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html#cfn-cloudfront-responseheaderspolicy-xssprotection-modeblock", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::CloudFront::StreamingDistribution.Logging": { "MarkdownDocumentation": "`AWS::CloudFront::StreamingDistribution.Logging`\n\nA complex type that controls whether access logs are written for the streaming\ndistribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html", "Properties": { "Bucket": { "Required": true, "MarkdownDocumentation": "`Bucket`\n\nThe Amazon S3 bucket to store the access logs in, for example,\n`amzn-s3-demo-bucket.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-bucket", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Enabled": { "Required": true, "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't\nwant to enable logging when you create a streaming distribution or if you want to\ndisable logging for an existing streaming distribution, specify `false` for\n`Enabled`, and specify `empty Bucket` and `Prefix`\nelements. If you specify `false` for `Enabled` but you specify\nvalues for `Bucket` and `Prefix`, the values are automatically\ndeleted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Prefix": { "Required": true, "MarkdownDocumentation": "`Prefix`\n\nAn optional string that you want CloudFront to prefix to the access log filenames for this\nstreaming distribution, for example, `myprefix/`. If you want to enable\nlogging, but you don't want to specify a prefix, you still must include an empty\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-prefix", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CloudFront::StreamingDistribution.S3Origin": { "MarkdownDocumentation": "`AWS::CloudFront::StreamingDistribution.S3Origin`\n\nA complex type that contains information about the Amazon S3 bucket from which you want\nCloudFront to get your media files for distribution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html", "Properties": { "DomainName": { "Required": true, "MarkdownDocumentation": "`DomainName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html#cfn-cloudfront-streamingdistribution-s3origin-domainname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OriginAccessIdentity": { "Required": true, "MarkdownDocumentation": "`OriginAccessIdentity`\n\nThe CloudFront origin access identity to associate with the distribution. Use an origin\naccess identity to configure the distribution so that end users can only access objects\nin an Amazon S3 bucket through CloudFront.\nIf you want end users to be able to access objects using either the CloudFront URL or the\nAmazon S3 URL, specify an empty `OriginAccessIdentity` element.\nTo delete the origin access identity from an existing distribution, update the\ndistribution configuration and include an empty `OriginAccessIdentity`\nelement.\nTo replace the origin access identity, update the distribution configuration and\nspecify 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\nthe *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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html#cfn-cloudfront-streamingdistribution-s3origin-originaccessidentity", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CloudFront::StreamingDistribution.StreamingDistributionConfig": { "MarkdownDocumentation": "`AWS::CloudFront::StreamingDistribution.StreamingDistributionConfig`\n\nThe RTMP distribution's configuration information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html", "Properties": { "Logging": { "Type": "Logging", "Required": false, "MarkdownDocumentation": "`Logging`\n\nA complex type that controls whether access logs are written for the streaming\ndistribution.\n*Required*: No\n*Type*: [Logging](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-logging", "UpdateType": "Mutable" }, "Comment": { "Required": true, "MarkdownDocumentation": "`Comment`\n\nAny 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-comment", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PriceClass": { "Required": false, "MarkdownDocumentation": "`PriceClass`\n\nA complex type that contains information about price class for this streaming\ndistribution.\n*Required*: No\n*Type*: String\n*Allowed values*: `PriceClass_100 | PriceClass...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PriceClass_100", "PriceClass_200", "PriceClass_All", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-priceclass", "PrimitiveType": "String", "UpdateType": "Mutable" }, "S3Origin": { "Type": "S3Origin", "Required": true, "MarkdownDocumentation": "`S3Origin`\n\nA complex type that contains information about the Amazon S3 bucket from which you want\nCloudFront to get your media files for distribution.\n*Required*: Yes\n*Type*: [S3Origin](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-s3origin", "UpdateType": "Mutable" }, "Enabled": { "Required": true, "MarkdownDocumentation": "`Enabled`\n\nWhether the streaming distribution is enabled to accept user requests for\ncontent.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Aliases": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Aliases`\n\nA complex type that contains information about CNAMEs (alternate domain names), if\nany, for this streaming distribution.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-aliases", "UpdateType": "Mutable" }, "TrustedSigners": { "Type": "TrustedSigners", "Required": true, "MarkdownDocumentation": "`TrustedSigners`\n\nA complex type that specifies any AWS accounts that you want to permit to create\nsigned URLs for private content. If you want the distribution to use signed URLs,\ninclude this element; if you want the distribution to use public URLs, remove this\nelement. For more information, see [Serving Private\nContent through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.\n*Required*: Yes\n*Type*: [TrustedSigners](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-trustedsigners", "UpdateType": "Mutable" } } }, "AWS::CloudFront::StreamingDistribution.TrustedSigners": { "MarkdownDocumentation": "`AWS::CloudFront::StreamingDistribution.TrustedSigners`\n\nA list of AWS accounts whose public keys CloudFront can use to verify the signatures of\nsigned URLs and signed cookies.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html", "Properties": { "Enabled": { "Required": true, "MarkdownDocumentation": "`Enabled`\n\nThis field is `true` if any of the AWS accounts in the list are configured as\ntrusted signers. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html#cfn-cloudfront-streamingdistribution-trustedsigners-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AwsAccountNumbers": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AwsAccountNumbers`\n\nAn AWS account number that contains active CloudFront key pairs that CloudFront can use to\nverify the signatures of signed URLs and signed cookies. If the AWS account that owns\nthe key pairs is the same account that owns the CloudFront distribution, the value of this\nfield is `self`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html#cfn-cloudfront-streamingdistribution-trustedsigners-awsaccountnumbers", "UpdateType": "Mutable" } } }, "AWS::CloudFront::TrustStore.CaCertificatesBundleS3Location": { "MarkdownDocumentation": "`AWS::CloudFront::TrustStore.CaCertificatesBundleS3Location`\n\nThe CA certificates bundle location in Amazon S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-truststore-cacertificatesbundles3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-truststore-cacertificatesbundles3location.html#cfn-cloudfront-truststore-cacertificatesbundles3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe location's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-truststore-cacertificatesbundles3location.html#cfn-cloudfront-truststore-cacertificatesbundles3location-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe location's Region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z]{2}-[a-z]+-\\d`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-truststore-cacertificatesbundles3location.html#cfn-cloudfront-truststore-cacertificatesbundles3location-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe location's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-truststore-cacertificatesbundles3location.html#cfn-cloudfront-truststore-cacertificatesbundles3location-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::TrustStore.CaCertificatesBundleSource": { "MarkdownDocumentation": "`AWS::CloudFront::TrustStore.CaCertificatesBundleSource`\n\nA CA certificates bundle source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-truststore-cacertificatesbundlesource.html", "Properties": { "CaCertificatesBundleS3Location": { "MarkdownDocumentation": "`CaCertificatesBundleS3Location`\n\nThe CA certificates bundle location in Amazon S3.\n*Required*: Yes\n*Type*: [CaCertificatesBundleS3Location](./aws-properties-cloudfront-truststore-cacertificatesbundles3location.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-truststore-cacertificatesbundlesource.html#cfn-cloudfront-truststore-cacertificatesbundlesource-cacertificatesbundles3location", "UpdateType": "Mutable", "Required": true, "Type": "CaCertificatesBundleS3Location" } } }, "AWS::CloudFront::VpcOrigin.VpcOriginEndpointConfig": { "MarkdownDocumentation": "`AWS::CloudFront::VpcOrigin.VpcOriginEndpointConfig`\n\nAn Amazon CloudFront VPC origin endpoint configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html", "Properties": { "HTTPSPort": { "MarkdownDocumentation": "`HTTPSPort`\n\nThe HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is `443`.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpsport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OriginSSLProtocols": { "MarkdownDocumentation": "`OriginSSLProtocols`\n\nSpecifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin\nover HTTPS. Valid values include `SSLv3`, `TLSv1`,\n`TLSv1.1`, and `TLSv1.2`.\nFor more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the\n*Amazon CloudFront Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originsslprotocols", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe ARN of the CloudFront VPC origin endpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HTTPPort": { "MarkdownDocumentation": "`HTTPPort`\n\nThe HTTP port for the CloudFront VPC origin endpoint configuration. The default value is `80`.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the CloudFront VPC origin endpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OriginProtocolPolicy": { "MarkdownDocumentation": "`OriginProtocolPolicy`\n\nThe origin protocol policy for the CloudFront VPC origin endpoint configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `http-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)", "RefReturnValue": "", "AllowedValues": [ "http-only", "match-viewer", "https-only" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originprotocolpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudTrail::Channel.Destination": { "MarkdownDocumentation": "`AWS::CloudTrail::Channel.Destination`\n\nContains information about the destination receiving events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is `EVENT_DATA_STORE`. For service-linked channels,\nthe value is `AWS_SERVICE`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "EVENT_DATA_STORE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html#cfn-cloudtrail-channel-destination-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Location": { "MarkdownDocumentation": "`Location`\n\nFor channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel.\nFor service-linked channels, the location is the name of the AWS service.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(^[a-zA-Z0-9._/\\-:]+$)`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html#cfn-cloudtrail-channel-destination-location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudTrail::Dashboard.Frequency": { "MarkdownDocumentation": "`AWS::CloudTrail::Dashboard.Frequency`\n\nSpecifies the frequency for a dashboard refresh schedule.\nFor a custom dashboard, you can schedule a refresh for every 1, 6, 12, or 24 hours, or every day.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-frequency.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the refresh schedule.\nFor custom dashboards, the following values are valid when the unit is `HOURS`: `1`, `6`, `12`, `24`\nFor custom dashboards, the only valid value when the unit is `DAYS` is `1`.\nFor the Highlights dashboard, the `Value` must be `6`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-frequency.html#cfn-cloudtrail-dashboard-frequency-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit to use for the refresh.\nFor custom dashboards, the unit can be `HOURS` or `DAYS`.\nFor the Highlights dashboard, the `Unit` must be `HOURS`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HOURS | DAYS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HOURS", "DAYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-frequency.html#cfn-cloudtrail-dashboard-frequency-unit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudTrail::Dashboard.RefreshSchedule": { "MarkdownDocumentation": "`AWS::CloudTrail::Dashboard.RefreshSchedule`\n\nThe schedule for a dashboard refresh.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-refreshschedule.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies whether the refresh schedule is enabled. Set the value to `ENABLED` to enable the refresh schedule, or to `DISABLED` to turn off the refresh schedule.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-refreshschedule.html#cfn-cloudtrail-dashboard-refreshschedule-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimeOfDay": { "MarkdownDocumentation": "`TimeOfDay`\n\nThe time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{2}:[0-9]{2}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-refreshschedule.html#cfn-cloudtrail-dashboard-refreshschedule-timeofday", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Frequency": { "MarkdownDocumentation": "`Frequency`\n\nThe frequency at which you want the dashboard refreshed.\n*Required*: No\n*Type*: [Frequency](./aws-properties-cloudtrail-dashboard-frequency.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-refreshschedule.html#cfn-cloudtrail-dashboard-refreshschedule-frequency", "UpdateType": "Mutable", "Required": false, "Type": "Frequency" } } }, "AWS::CloudTrail::Dashboard.Widget": { "MarkdownDocumentation": "`AWS::CloudTrail::Dashboard.Widget`\n\nContains information about a widget on a CloudTrail Lake dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-widget.html", "Properties": { "QueryStatement": { "MarkdownDocumentation": "`QueryStatement`\n\nThe query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.\n###### Note\nWhen a query uses `?` with `eventTime`, `?` must be surrounded by single quotes as follows: `'?'`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-widget.html#cfn-cloudtrail-dashboard-widget-querystatement", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "QueryParameters": { "MarkdownDocumentation": "`QueryParameters`\n\nThe optional query parameters. The following query parameters are valid: `$StartTime$`, `$EndTime$`, and `$Period$`.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-widget.html#cfn-cloudtrail-dashboard-widget-queryparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ViewProperties": { "MarkdownDocumentation": "`ViewProperties`\n\nThe view properties for the widget. For more information about view properties, see [View properties for widgets](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-widget-properties.html) in the *AWS CloudTrail User Guide*.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9._-]{3,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-widget.html#cfn-cloudtrail-dashboard-widget-viewproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::CloudTrail::EventDataStore.AdvancedEventSelector": { "MarkdownDocumentation": "`AWS::CloudTrail::EventDataStore.AdvancedEventSelector`\n\nAdvanced event selectors let you create fine-grained selectors for AWS CloudTrail management, data, and network activity events. They help you control costs by logging only those\nevents that are important to you. For more information about configuring advanced event selectors, see\nthe [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html), [Logging network activity events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html), and [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) topics in the *AWS CloudTrail User Guide*.\nYou cannot apply both event selectors and advanced event selectors to a trail.\n**Supported CloudTrail event record fields for management events**\n* `eventCategory` (required)\n* `eventSource`\n* `readOnly`\nThe following additional fields are available for event data stores:\n* `eventName`\n* `eventType`\n* `sessionCredentialFromConsole`\n* `userIdentity.arn`\n**Supported CloudTrail event record fields for data events**\n* `eventCategory` (required)\n* `eventName`\n* `eventSource`\n* `eventType`\n* `resources.ARN`\n* `resources.type` (required)\n* `readOnly`\n* `sessionCredentialFromConsole`\n* `userIdentity.arn`\n**Supported CloudTrail event record fields for network activity events**\n* `eventCategory` (required)\n* `eventSource` (required)\n* `eventName`\n* `errorCode` - The only valid value for `errorCode` is `VpceAccessDenied`.\n* `vpcEndpointId`\n###### Note\nFor event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS, the only supported field is\n`eventCategory`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html", "Properties": { "FieldSelectors": { "MarkdownDocumentation": "`FieldSelectors`\n\nContains all selector statements in an advanced event selector.\n*Required*: Yes\n*Type*: Array of [AdvancedFieldSelector](./aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html#cfn-cloudtrail-eventdatastore-advancedeventselector-fieldselectors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AdvancedFieldSelector", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nAn optional, descriptive name for an advanced event selector, such as \"Log data events\nfor only two S3 buckets\".\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html#cfn-cloudtrail-eventdatastore-advancedeventselector-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudTrail::EventDataStore.AdvancedFieldSelector": { "MarkdownDocumentation": "`AWS::CloudTrail::EventDataStore.AdvancedFieldSelector`\n\nA single selector statement in an advanced event selector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nA field in a CloudTrail event record on which to filter events to be logged. For\nevent data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS, the field is used only for\nselecting events as filtering is not supported.\nFor CloudTrail management events, supported fields include\n`eventCategory` (required), `eventSource`, and\n`readOnly`. The following additional fields are available for event data\nstores: `eventName`, `eventType`,\n`sessionCredentialFromConsole`, and `userIdentity.arn`.\nFor CloudTrail data events, supported fields include `eventCategory`\n(required), `eventName`, `eventSource`, `eventType`, `resources.type` (required),\n`readOnly`, `resources.ARN`, `sessionCredentialFromConsole`, and `userIdentity.arn`.\nFor CloudTrail network activity events, supported fields include `eventCategory` (required), `eventSource` (required), `eventName`,\n`errorCode`, and `vpcEndpointId`.\nFor event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS, the only supported field is\n`eventCategory`.\n###### Note\nSelectors don't support the use of wildcards like `*` . To match multiple values with a single condition,\nyou may use `StartsWith`, `EndsWith`, `NotStartsWith`, or `NotEndsWith` to explicitly match the beginning or end of the event field.\n\n* **`readOnly`** - This is an optional field that is only used for management events and data events. This field can be set to\n `Equals` with a value of `true` or `false`. If you do\n not add this field, CloudTrail logs both `read` and\n `write` events. A value of `true` logs only\n `read` events. A value of `false` logs only\n `write` events.\n* **`eventSource`** - This field is only used for management events, data events, and network activity events.\n \n For management events for trails, this is an optional field that can be set to `NotEquals``kms.amazonaws.com` to exclude KMS management events, or `NotEquals``rdsdata.amazonaws.com` to exclude RDS management events.\n \n For data events for trails, this is an optional field that you can use to include or\n exclude any event source and can use any operator.\n \n For management and data events for event data stores, this is an optional field that you can use to include or\n exclude any event source and can use any operator.\n \n For network activity events, this is a required field that only uses the\n `Equals` operator. Set this field to the event source for which you want to\n log network activity events. If you want to log network activity events for multiple\n event sources, you must create a separate field selector for each event\n source. For a list of services supporting network activity events, see [Logging network activity events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide*.\n* **`eventName`** - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with\n `eventName`. You can use it to \ufb01lter in or \ufb01lter out specific events. You can have\n multiple values for this \ufb01eld, separated by commas.\n* **`eventCategory`** - This field is required and\n must be set to `Equals`.\n \n + For CloudTrail management events, the value\n must be `Management`.\n + For CloudTrail data events, the value\n must be `Data`.\n + For CloudTrail network activity events, the value\n must be `NetworkActivity`.\n \n The following are used only for event data stores:\n \n + For CloudTrail Insights events, the value\n must be `Insight`.\n + For AWS Config\n configuration items, the value must be `ConfigurationItem`.\n + For Audit Manager evidence, the value must be `Evidence`.\n + For events outside of AWS, the value must be `ActivityAuditLog`.\n* **`eventType`** - For event data stores, this is an optional\n field available for event data stores to filter management and\n data events on the event type. For trails, this is an optional field to filter data events on the event type. For information about available event types, see\n [CloudTrail record contents](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type) in the *AWS CloudTrail user\n guide*.\n* **`errorCode`** - This \ufb01eld is only used to filter CloudTrail network activity events\n and is optional. This is the error code to filter on. Currently, the only valid `errorCode` is `VpceAccessDenied`.\n `errorCode` can only use the `Equals` operator.\n* **`sessionCredentialFromConsole`** - For event data stores, this\n is an optional field used to filter management and data events based on whether the events originated from an AWS Management Console session. For trails, this is an optional field used to filter data events. `sessionCredentialFromConsole` can only use the\n `Equals` and `NotEquals` operators.\n* **`resources.type`** - This \ufb01eld is\n required for CloudTrail data events. `resources.type` can only\n use the `Equals` operator.\n \n For a list of available resource types for data events, see [Data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events) in the *AWS CloudTrail User Guide*.\n \n You can have only one `resources.type` \ufb01eld per selector. To log events on more than one resource type, add another selector.\n* **`resources.ARN`** - The `resources.ARN` is an optional field for\n data events. You can use any\n operator with `resources.ARN`, but if you use `Equals` or\n `NotEquals`, the value must exactly match the ARN of a valid resource\n of the type you've speci\ufb01ed in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket,\n use the `StartsWith` operator, and include only the bucket ARN as the matching value.\n \n For more information about the ARN formats of data event\n resources, see [Actions, resources, and condition\n keys for AWS services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) in the *Service Authorization Reference*.\n \n ###### Note\n \n You can't use the `resources.ARN` field to filter resource types that do not have ARNs.\n* **`userIdentity.arn`** - For event data stores, this is an\n optional field used to filter management and data events for actions taken by specific IAM identities. For trails,\n this is an optional field used to filter data events. You can use any operator with\n `userIdentity.arn`. For more information on the userIdentity element,\n see [CloudTrail userIdentity element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html) in the *AWS CloudTrail User Guide*.\n* **`vpcEndpointId`** - This \ufb01eld is only used to filter CloudTrail network activity events\n and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with `vpcEndpointId`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([\\w|\\d|\\.|_]+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-field", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Equals": { "MarkdownDocumentation": "`Equals`\n\nAn operator that includes events that match the exact value of the event record field\nspecified as the value of `Field`. This is the only valid operator that you can\nuse with the `readOnly`, `eventCategory`, and\n`resources.type` fields.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-equals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotStartsWith": { "MarkdownDocumentation": "`NotStartsWith`\n\nAn operator that excludes events that match the first few characters of the event\nrecord field specified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notstartswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotEndsWith": { "MarkdownDocumentation": "`NotEndsWith`\n\nAn operator that excludes events that match the last few characters of the event record\nfield specified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notendswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "StartsWith": { "MarkdownDocumentation": "`StartsWith`\n\nAn operator that includes events that match the first few characters of the event record\nfield specified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-startswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EndsWith": { "MarkdownDocumentation": "`EndsWith`\n\nAn operator that includes events that match the last few characters of the event record\nfield specified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-endswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotEquals": { "MarkdownDocumentation": "`NotEquals`\n\nAn operator that excludes events that match the exact value of the event record field\nspecified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notequals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudTrail::EventDataStore.ContextKeySelector": { "MarkdownDocumentation": "`AWS::CloudTrail::EventDataStore.ContextKeySelector`\n\nAn object that contains information types to be included in CloudTrail enriched events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-contextkeyselector.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RequestContext | TagContext...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RequestContext", "TagContext" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-contextkeyselector.html#cfn-cloudtrail-eventdatastore-contextkeyselector-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Equals": { "MarkdownDocumentation": "`Equals`\n\nA list of keys defined by Type to be included in CloudTrail enriched events.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `128 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-contextkeyselector.html#cfn-cloudtrail-eventdatastore-contextkeyselector-equals", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudTrail::EventDataStore.InsightSelector": { "MarkdownDocumentation": "`AWS::CloudTrail::EventDataStore.InsightSelector`\n\nA JSON string that contains a list of Insights types that are logged on an event data store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html", "Properties": { "InsightType": { "MarkdownDocumentation": "`InsightType`\n\nThe type of Insights events to log on an event data store. `ApiCallRateInsight` and\n`ApiErrorRateInsight` are valid Insight types.\nThe `ApiCallRateInsight` Insights type analyzes write-only\nmanagement API calls that are aggregated per minute against a baseline API call volume.\nThe `ApiErrorRateInsight` Insights type analyzes management\nAPI calls that result in error codes. The error is shown if the API call is\nunsuccessful.\n*Required*: No\n*Type*: String\n*Allowed values*: `ApiCallRateInsight | ApiErr...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ApiCallRateInsight", "ApiErrorRateInsight" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html#cfn-cloudtrail-eventdatastore-insightselector-insighttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudTrail::Trail.AdvancedEventSelector": { "MarkdownDocumentation": "`AWS::CloudTrail::Trail.AdvancedEventSelector`\n\nAdvanced event selectors let you create fine-grained selectors for AWS CloudTrail management, data, and network activity events. They help you control costs by logging only those\nevents that are important to you. For more information about configuring advanced event selectors, see\nthe [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html), [Logging network activity events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html), and [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) topics in the *AWS CloudTrail User Guide*.\nYou cannot apply both event selectors and advanced event selectors to a trail.\n**Supported CloudTrail event record fields for management events**\n* `eventCategory` (required)\n* `eventSource`\n* `readOnly`\nThe following additional fields are available for event data stores:\n* `eventName`\n* `eventType`\n* `sessionCredentialFromConsole`\n* `userIdentity.arn`\n**Supported CloudTrail event record fields for data events**\n* `eventCategory` (required)\n* `eventName`\n* `eventSource`\n* `eventType`\n* `resources.ARN`\n* `resources.type` (required)\n* `readOnly`\n* `sessionCredentialFromConsole`\n* `userIdentity.arn`\n**Supported CloudTrail event record fields for network activity events**\n* `eventCategory` (required)\n* `eventSource` (required)\n* `eventName`\n* `errorCode` - The only valid value for `errorCode` is `VpceAccessDenied`.\n* `vpcEndpointId`\n###### Note\nFor event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS, the only supported field is\n`eventCategory`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedeventselector.html", "Properties": { "FieldSelectors": { "MarkdownDocumentation": "`FieldSelectors`\n\nContains all selector statements in an advanced event selector.\n*Required*: Yes\n*Type*: Array of [AdvancedFieldSelector](./aws-properties-cloudtrail-trail-advancedfieldselector.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedeventselector.html#cfn-cloudtrail-trail-advancedeventselector-fieldselectors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AdvancedFieldSelector", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nAn optional, descriptive name for an advanced event selector, such as \"Log data events\nfor only two S3 buckets\".\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedeventselector.html#cfn-cloudtrail-trail-advancedeventselector-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudTrail::Trail.AdvancedFieldSelector": { "MarkdownDocumentation": "`AWS::CloudTrail::Trail.AdvancedFieldSelector`\n\nA single selector statement in an advanced event selector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nA field in a CloudTrail event record on which to filter events to be logged. For\nevent data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS, the field is used only for\nselecting events as filtering is not supported.\nFor CloudTrail management events, supported fields include\n`eventCategory` (required), `eventSource`, and\n`readOnly`. The following additional fields are available for event data\nstores: `eventName`, `eventType`,\n`sessionCredentialFromConsole`, and `userIdentity.arn`.\nFor CloudTrail data events, supported fields include `eventCategory`\n(required), `eventName`, `eventSource`, `eventType`, `resources.type` (required),\n`readOnly`, `resources.ARN`, `sessionCredentialFromConsole`, and `userIdentity.arn`.\nFor CloudTrail network activity events, supported fields include `eventCategory` (required), `eventSource` (required), `eventName`,\n`errorCode`, and `vpcEndpointId`.\nFor event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS, the only supported field is\n`eventCategory`.\n###### Note\nSelectors don't support the use of wildcards like `*` . To match multiple values with a single condition,\nyou may use `StartsWith`, `EndsWith`, `NotStartsWith`, or `NotEndsWith` to explicitly match the beginning or end of the event field.\n\n* **`readOnly`** - This is an optional field that is only used for management events and data events. This field can be set to\n `Equals` with a value of `true` or `false`. If you do\n not add this field, CloudTrail logs both `read` and\n `write` events. A value of `true` logs only\n `read` events. A value of `false` logs only\n `write` events.\n* **`eventSource`** - This field is only used for management events, data events, and network activity events.\n \n For management events for trails, this is an optional field that can be set to `NotEquals``kms.amazonaws.com` to exclude KMS management events, or `NotEquals``rdsdata.amazonaws.com` to exclude RDS management events.\n \n For data events for trails, this is an optional field that you can use to include or\n exclude any event source and can use any operator.\n \n For management and data events for event data stores, this is an optional field that you can use to include or\n exclude any event source and can use any operator.\n \n For network activity events, this is a required field that only uses the\n `Equals` operator. Set this field to the event source for which you want to\n log network activity events. If you want to log network activity events for multiple\n event sources, you must create a separate field selector for each event\n source. For a list of services supporting network activity events, see [Logging network activity events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide*.\n* **`eventName`** - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with\n `eventName`. You can use it to \ufb01lter in or \ufb01lter out specific events. You can have\n multiple values for this \ufb01eld, separated by commas.\n* **`eventCategory`** - This field is required and\n must be set to `Equals`.\n \n + For CloudTrail management events, the value\n must be `Management`.\n + For CloudTrail data events, the value\n must be `Data`.\n + For CloudTrail network activity events, the value\n must be `NetworkActivity`.\n \n The following are used only for event data stores:\n \n + For CloudTrail Insights events, the value\n must be `Insight`.\n + For AWS Config\n configuration items, the value must be `ConfigurationItem`.\n + For Audit Manager evidence, the value must be `Evidence`.\n + For events outside of AWS, the value must be `ActivityAuditLog`.\n* **`eventType`** - For event data stores, this is an optional\n field available for event data stores to filter management and\n data events on the event type. For trails, this is an optional field to filter data events on the event type. For information about available event types, see\n [CloudTrail record contents](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type) in the *AWS CloudTrail user\n guide*.\n* **`errorCode`** - This \ufb01eld is only used to filter CloudTrail network activity events\n and is optional. This is the error code to filter on. Currently, the only valid `errorCode` is `VpceAccessDenied`.\n `errorCode` can only use the `Equals` operator.\n* **`sessionCredentialFromConsole`** - For event data stores, this\n is an optional field used to filter management and data events based on whether the events originated from an AWS Management Console session. For trails, this is an optional field used to filter data events. `sessionCredentialFromConsole` can only use the\n `Equals` and `NotEquals` operators.\n* **`resources.type`** - This \ufb01eld is\n required for CloudTrail data events. `resources.type` can only\n use the `Equals` operator.\n \n For a list of available resource types for data events, see [Data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events) in the *AWS CloudTrail User Guide*.\n \n You can have only one `resources.type` \ufb01eld per selector. To log events on more than one resource type, add another selector.\n* **`resources.ARN`** - The `resources.ARN` is an optional field for\n data events. You can use any\n operator with `resources.ARN`, but if you use `Equals` or\n `NotEquals`, the value must exactly match the ARN of a valid resource\n of the type you've speci\ufb01ed in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket,\n use the `StartsWith` operator, and include only the bucket ARN as the matching value.\n \n For more information about the ARN formats of data event\n resources, see [Actions, resources, and condition\n keys for AWS services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) in the *Service Authorization Reference*.\n \n ###### Note\n \n You can't use the `resources.ARN` field to filter resource types that do not have ARNs.\n* **`userIdentity.arn`** - For event data stores, this is an\n optional field used to filter management and data events for actions taken by specific IAM identities. For trails,\n this is an optional field used to filter data events. You can use any operator with\n `userIdentity.arn`. For more information on the userIdentity element,\n see [CloudTrail userIdentity element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html) in the *AWS CloudTrail User Guide*.\n* **`vpcEndpointId`** - This \ufb01eld is only used to filter CloudTrail network activity events\n and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with `vpcEndpointId`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([\\w|\\d|\\.|_]+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-field", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Equals": { "MarkdownDocumentation": "`Equals`\n\nAn operator that includes events that match the exact value of the event record field\nspecified as the value of `Field`. This is the only valid operator that you can\nuse with the `readOnly`, `eventCategory`, and\n`resources.type` fields.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-equals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotStartsWith": { "MarkdownDocumentation": "`NotStartsWith`\n\nAn operator that excludes events that match the first few characters of the event\nrecord field specified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-notstartswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotEndsWith": { "MarkdownDocumentation": "`NotEndsWith`\n\nAn operator that excludes events that match the last few characters of the event record\nfield specified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-notendswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "StartsWith": { "MarkdownDocumentation": "`StartsWith`\n\nAn operator that includes events that match the first few characters of the event record\nfield specified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-startswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EndsWith": { "MarkdownDocumentation": "`EndsWith`\n\nAn operator that includes events that match the last few characters of the event record\nfield specified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-endswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotEquals": { "MarkdownDocumentation": "`NotEquals`\n\nAn operator that excludes events that match the exact value of the event record field\nspecified as the value of `Field`.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-notequals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudTrail::Trail.AggregationConfiguration": { "MarkdownDocumentation": "`AWS::CloudTrail::Trail.AggregationConfiguration`\n\nAn object that contains configuration settings for aggregating events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-aggregationconfiguration.html", "Properties": { "EventCategory": { "MarkdownDocumentation": "`EventCategory`\n\nSpecifies the event category for which aggregation should be performed.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Data`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "Data" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-aggregationconfiguration.html#cfn-cloudtrail-trail-aggregationconfiguration-eventcategory", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Templates": { "MarkdownDocumentation": "`Templates`\n\nA list of aggregation templates that can be used to configure event aggregation.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-aggregationconfiguration.html#cfn-cloudtrail-trail-aggregationconfiguration-templates", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudTrail::Trail.DataResource": { "MarkdownDocumentation": "`AWS::CloudTrail::Trail.DataResource`\n\nYou can configure the `DataResource` in an `EventSelector` to log data events for the following three resource types:\n* `AWS::DynamoDB::Table`\n* `AWS::Lambda::Function`\n* `AWS::S3::Object`\nTo log data events for all other resource types including objects stored in\n[directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html), you must use [AdvancedEventSelectors](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html). You must also\nuse `AdvancedEventSelectors` if you want to filter on the `eventName` field.\nConfigure the `DataResource` to specify the resource type and resource ARNs for which you want to log data events.\n###### Note\nThe total number of allowed data resources is 250. This number can be distributed\nbetween 1 and 5 event selectors, but the total cannot exceed 250 across all\nselectors for the trail.\nThe following example demonstrates how logging works when you configure logging of all\ndata events for a general purpose bucket named `amzn-s3-demo-bucket1`. In this example, the CloudTrail user specified an empty prefix, and the option to log both `Read`\nand `Write` data events.\n1. A user uploads an image file to `amzn-s3-demo-bucket1`.\n2. The `PutObject` API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.\n3. A user uploads an object to an Amazon S3 bucket named\n `arn:aws:s3:::amzn-s3-demo-bucket1`.\n4. The `PutObject` API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn\u2019t log\n the event.\nThe following example demonstrates how logging works when you configure logging of\nAWS Lambda data events for a Lambda function named\n*MyLambdaFunction*, but not for all Lambda\nfunctions.\n1. A user runs a script that includes a call to the\n *MyLambdaFunction* function and the\n *MyOtherLambdaFunction* function.\n2. The `Invoke` API operation on *MyLambdaFunction* is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n *MyLambdaFunction*, any invocations of that function are\n logged. The trail processes and logs the event.\n3. The `Invoke` API operation on\n *MyOtherLambdaFunction* is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the `Invoke` operation for\n *MyOtherLambdaFunction* does not match the function specified\n for the trail. The trail doesn\u2019t log the event.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe resource type in which you want to log data events. You can specify the following\n*basic* event selector resource types:\n* `AWS::DynamoDB::Table`\n* `AWS::Lambda::Function`\n* `AWS::S3::Object`\nAdditional resource types are available through *advanced*\nevent selectors. For more\ninformation, see [AdvancedEventSelector](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html#cfn-cloudtrail-trail-dataresource-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Values": { "MarkdownDocumentation": "`Values`\n\nAn array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\nresource type.\n* To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as `arn:aws:s3`.\n \n ###### Note\n \n This also enables logging of data event activity performed by any user or role\n in your AWS account, even if that activity is performed on a bucket\n that belongs to another AWS account.\n* To log data events for all objects in an S3 bucket, specify the bucket and an\n empty object prefix such as `arn:aws:s3:::amzn-s3-demo-bucket1/`. The trail logs data\n events for all objects in this S3 bucket.\n* To log data events for specific objects, specify the S3 bucket and object prefix\n such as `arn:aws:s3:::amzn-s3-demo-bucket1/example-images`. The trail logs data events\n 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 \n ###### Note\n \n This also enables logging of `Invoke` activity performed by any user\n or role in your AWS account, even if that activity is performed on\n a function that belongs to another AWS account.\n* To log data events for a specific Lambda function, specify the\n function ARN.\n \n ###### Note\n \n Lambda function ARNs are exact. For example, if you specify a\n function ARN\n *arn:aws:lambda:us-west-2:111111111111:function:helloworld*,\n data events will only be logged for\n *arn:aws:lambda:us-west-2:111111111111:function:helloworld*.\n They will not be logged for\n *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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html#cfn-cloudtrail-trail-dataresource-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudTrail::Trail.EventSelector": { "MarkdownDocumentation": "`AWS::CloudTrail::Trail.EventSelector`\n\nUse event selectors to further specify the management and data event settings for your\ntrail. By default, trails created without specific event selectors will be configured to\nlog all read and write management events, and no data events. When an event occurs in your\naccount, CloudTrail evaluates the event selector for all trails. For each trail, if\nthe event matches any event selector, the trail processes and logs the event. If the event\ndoesn'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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html", "Properties": { "IncludeManagementEvents": { "MarkdownDocumentation": "`IncludeManagementEvents`\n\nSpecify if you want your event selector to include management events for your\ntrail.\nFor more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) in the *AWS CloudTrail User\nGuide*.\nBy default, the value is `true`.\nThe first copy of management events is free. You are charged for additional copies of\nmanagement events that you are logging on any subsequent trail in the same Region. For more\ninformation about CloudTrail pricing, see [AWS CloudTrail Pricing](https://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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-includemanagementevents", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ReadWriteType": { "MarkdownDocumentation": "`ReadWriteType`\n\nSpecify if you want your trail to log read-only events, write-only events, or all. For\nexample, the EC2 `GetConsoleOutput` is a read-only API operation and\n`RunInstances` is a write-only API operation.\nBy 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)", "RefReturnValue": "", "AllowedValues": [ "All", "ReadOnly", "WriteOnly" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-readwritetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExcludeManagementEventSources": { "MarkdownDocumentation": "`ExcludeManagementEventSources`\n\nAn optional list of service event sources from which you do not want management events\nto be logged on your trail. In this release, the list can be empty (disables the filter),\nor it can filter out AWS Key Management Service or Amazon RDS Data API events by\ncontaining `kms.amazonaws.com` or `rdsdata.amazonaws.com`. By\ndefault, `ExcludeManagementEventSources` is empty, and AWS KMS and\nAmazon RDS Data API events are logged to your trail. You can exclude management\nevent sources only in Regions that support the event source.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-excludemanagementeventsources", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "DataResources": { "MarkdownDocumentation": "`DataResources`\n\nCloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors.\nYou can specify up to 250 resources for an individual event selector, but the total number\nof data resources cannot exceed 250 across all event selectors in a trail. This limit does\nnot apply if you configure resource logging for all data events.\nFor more information, see [Data\nEvents](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\nGuide*.\n###### Note\nTo log data events for all other resource types including objects stored in\n[directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html), you must use [AdvancedEventSelectors](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html). You must also\nuse `AdvancedEventSelectors` if you want to filter on the `eventName` field.\n*Required*: Conditional\n*Type*: Array of [DataResource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-dataresources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataResource", "DuplicatesAllowed": false } } }, "AWS::CloudTrail::Trail.InsightSelector": { "MarkdownDocumentation": "`AWS::CloudTrail::Trail.InsightSelector`\n\nA JSON string that contains a list of Insights types that are logged on a trail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html", "Properties": { "InsightType": { "MarkdownDocumentation": "`InsightType`\n\nThe type of Insights events to log on a trail. `ApiCallRateInsight` and\n`ApiErrorRateInsight` are valid Insight types.\nThe `ApiCallRateInsight` Insights type analyzes write-only\nmanagement API calls that are aggregated per minute against a baseline API call volume.\nThe `ApiErrorRateInsight` Insights type analyzes management\nAPI calls that result in error codes. The error is shown if the API call is\nunsuccessful.\n*Required*: No\n*Type*: String\n*Allowed values*: `ApiCallRateInsight | ApiErr...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ApiCallRateInsight", "ApiErrorRateInsight" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html#cfn-cloudtrail-trail-insightselector-insighttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventCategories": { "MarkdownDocumentation": "`EventCategories`\n\nSelect the event category on which Insights should be enabled.\n* If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.\n* If EventCategories is provided, the given event categories will overwrite the existing ones. For example,\n if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html#cfn-cloudtrail-trail-insightselector-eventcategories", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudWatch::Alarm.Dimension": { "MarkdownDocumentation": "`AWS::CloudWatch::Alarm.Dimension`\n\nDimension is an embedded property of the `AWS::CloudWatch::Alarm` type. Dimensions\nare name/value pairs that can be associated with a CloudWatch metric. You can\nspecify a maximum of 30 dimensions for a given metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-dimension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-dimension.html#cfn-cloudwatch-alarm-dimension-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the dimension, from 1\u2013255 characters in length. This dimension\nname must have been included when\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-dimension.html#cfn-cloudwatch-alarm-dimension-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudWatch::Alarm.Metric": { "MarkdownDocumentation": "`AWS::CloudWatch::Alarm.Metric`\n\nThe `Metric` property type represents a specific metric. `Metric` is a property of the\n[MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-metricname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nThe metric dimensions that you want to be used for the metric that\nthe alarm will watch.\n*Required*: No\n*Type*: Array of [Dimension](./aws-properties-cloudwatch-alarm-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Dimension", "DuplicatesAllowed": true }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric that the alarm will watch.\n*Required*: No\n*Type*: String\n*Pattern*: `[^:].*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudWatch::Alarm.MetricDataQuery": { "MarkdownDocumentation": "`AWS::CloudWatch::Alarm.MetricDataQuery`\n\nThe `MetricDataQuery` property type specifies the metric data to return, and whether this call is\njust retrieving a batch set of data for one metric, or is performing a math expression on metric data.\nAny expression used must return a single time series. For more information, 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\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html", "Properties": { "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-accountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReturnData": { "MarkdownDocumentation": "`ReturnData`\n\nThis option indicates whether to return the\ntimestamps and raw data values of this metric.\nWhen you create an alarm based on a metric math expression, specify `True` for\nthis value for only the one math expression that the alarm is based on. You must specify\n`False` for `ReturnData` for all the other metrics and expressions\nused in the alarm.\nThis field is required.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-returndata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe math expression to be performed on the returned data, if this object is performing a math expression. This expression\ncan use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other\nexpressions to use the result of those expressions. For more information about metric math expressions, see\n[Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the\n*Amazon CloudWatch User Guide*.\nWithin each MetricDataQuery object, you must specify either\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Label": { "MarkdownDocumentation": "`Label`\n\nA human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know\nwhat the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If `Label` is omitted, CloudWatch\ngenerates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricStat": { "MarkdownDocumentation": "`MetricStat`\n\nThe metric to be returned, along with statistics, period, and units. Use this\nparameter only if this object is retrieving a metric and not performing a math\nexpression on returned data.\nWithin one MetricDataQuery object, you must specify either `Expression` or\n`MetricStat` but not both.\n*Required*: No\n*Type*: [MetricStat](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-metricstat", "UpdateType": "Mutable", "Required": false, "Type": "MetricStat" }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe granularity, in seconds, of the returned data points. For metrics with regular\nresolution, a period can be as short as one minute (60 seconds) and must be a multiple\nof 60. For high-resolution metrics that are collected at intervals of less than one\nminute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution\nmetrics are those metrics stored by a `PutMetricData` operation that includes\na `StorageResolution of 1 second`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-period", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA short name used to tie this object to the results in the response. This name must be\nunique within a single call to `GetMetricData`. If you are performing math\nexpressions on this set of data, this name represents that data and can serve as a\nvariable in the mathematical expression. The valid characters are letters, numbers, and\nunderscore. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudWatch::Alarm.MetricStat": { "MarkdownDocumentation": "`AWS::CloudWatch::Alarm.MetricStat`\n\nThis structure defines the metric to be returned, along with the statistics, period, and units.\n`MetricStat` is a property of the\n[MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html", "Properties": { "Stat": { "MarkdownDocumentation": "`Stat`\n\nThe statistic to return. It can include any CloudWatch statistic or extended statistic.\nFor a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-stat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe granularity, in seconds, of the returned data points. For metrics with regular\nresolution, a period can be as short as one minute (60 seconds) and must be a multiple\nof 60. For high-resolution metrics that are collected at intervals of less than one\nminute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution\nmetrics are those metrics stored by a `PutMetricData` call that includes a\n`StorageResolution` of 1 second.\nIf the `StartTime` parameter specifies a time stamp that is greater than\n3 hours ago, you must specify the period as follows or no data points in that time range\nis returned:\n* Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds\n (1 minute).\n* Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5\n minutes).\n* Start time greater than 63 days ago - Use a multiple of 3600 seconds (1\n hour).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-period", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nThe metric to return, including the metric name, namespace, and dimensions.\n*Required*: Yes\n*Type*: [Metric](./aws-properties-cloudwatch-alarm-metric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-metric", "UpdateType": "Mutable", "Required": true, "Type": "Metric" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit to use for the returned data points.\nValid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes,\nMegabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count,\nBytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second,\nKilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.\n*Required*: No\n*Type*: String\n*Allowed values*: `Seconds | Microseconds | Mi...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudWatch::AnomalyDetector.Configuration": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.Configuration`\n\nSpecifies details about how the anomaly detection model is to be trained, including time ranges to exclude\nwhen training and updating the model. The configuration can also include the time zone to use for the metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html", "Properties": { "MetricTimeZone": { "Required": false, "MarkdownDocumentation": "`MetricTimeZone`\n\nThe time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings\ntime changes if the metric is sensitive to such time changes.\nTo specify a time zone, use the name of the time zone as specified in the standard tz database. For more information,\nsee [tz database](https://en.wikipedia.org/wiki/Tz_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html#cfn-cloudwatch-anomalydetector-configuration-metrictimezone", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExcludedTimeRanges": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ExcludedTimeRanges`\n\nSpecifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated.\nUse this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when\nCloudWatch creates or updates the model.\n*Required*: No\n*Type*: Array of [Range](./aws-properties-cloudwatch-anomalydetector-range.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html#cfn-cloudwatch-anomalydetector-configuration-excludedtimeranges", "ItemType": "Range", "UpdateType": "Mutable" } } }, "AWS::CloudWatch::AnomalyDetector.Dimension": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.Dimension`\n\nA dimension is a name/value pair that is part of the identity of a metric. Because\ndimensions are part of the unique identifier for a metric, whenever you add a unique\nname/value pair to one of your metrics, you are creating a new variation of that metric.\nFor example, many Amazon EC2 metrics publish `InstanceId` as a\ndimension name, and the actual instance ID as the value for that dimension.\nYou can assign up to 30 dimensions to a metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html", "Properties": { "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nThe value of the dimension. Dimension values must contain only ASCII characters and\nmust include at least one non-whitespace character. ASCII control characters are not\nsupported as part of dimension values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html#cfn-cloudwatch-anomalydetector-dimension-value", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html#cfn-cloudwatch-anomalydetector-dimension-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::CloudWatch::AnomalyDetector.Metric": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.Metric`\n\nRepresents a specific metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html", "Properties": { "MetricName": { "Required": true, "MarkdownDocumentation": "`MetricName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-metricname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Dimensions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions for the metric.\n*Required*: No\n*Type*: Array of [Dimension](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-dimensions", "ItemType": "Dimension", "UpdateType": "Immutable" }, "Namespace": { "Required": true, "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^:].*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-namespace", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::CloudWatch::AnomalyDetector.MetricCharacteristics": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.MetricCharacteristics`\n\nThis object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metriccharacteristics.html", "Properties": { "PeriodicSpikes": { "Required": false, "MarkdownDocumentation": "`PeriodicSpikes`\n\nSet this parameter to true if values for this metric consistently include spikes that should not be considered to be anomalies. With this set to true,\nCloudWatch will expect to see spikes that occurred consistently during the model training period, and won't flag future similar spikes as anomalies.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metriccharacteristics.html#cfn-cloudwatch-anomalydetector-metriccharacteristics-periodicspikes", "PrimitiveType": "Boolean", "UpdateType": "Immutable" } } }, "AWS::CloudWatch::AnomalyDetector.MetricDataQueries": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.MetricDataQueries`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataqueries.html", "ItemType": "MetricDataQuery", "UpdateType": "Immutable" }, "AWS::CloudWatch::AnomalyDetector.MetricDataQuery": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.MetricDataQuery`\n\nThis structure is used in both `GetMetricData` and\n`PutMetricAlarm`. The supported use of this structure is different for\nthose two operations.\nWhen used in `GetMetricData`, it indicates the metric data to return, and\nwhether this call is just retrieving a batch set of data for one metric, or is\nperforming a Metrics Insights query or a math expression. A single\n`GetMetricData` call can include up to 500 `MetricDataQuery`\nstructures.\nWhen used in `PutMetricAlarm`, it enables you to create an alarm based on a\nmetric math expression. Each `MetricDataQuery` in the array specifies either\na metric to retrieve, or a math expression to be performed on retrieved metrics. A\nsingle `PutMetricAlarm` call can include up to 20\n`MetricDataQuery` structures in the array. The 20 structures can include\nas many as 10 structures that contain a `MetricStat` parameter to retrieve a\nmetric, and as many as 10 structures that contain the `Expression` parameter\nto perform a math expression. Of those `Expression` structures, one must have\n`true` as the value for `ReturnData`. The result of this\nexpression is the value the alarm watches.\nAny expression used in a `PutMetricAlarm` operation must return a single\ntime series. For more information, 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\nGuide*.\nSome of the parameters of this structure also have different uses whether you are\nusing this structure in a `GetMetricData` operation or a\n`PutMetricAlarm` operation. These differences are explained in the\nfollowing parameter list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html", "Properties": { "AccountId": { "Required": false, "MarkdownDocumentation": "`AccountId`\n\nThe ID of the account where the metrics are located.\nIf you are performing a `GetMetricData` operation in a monitoring account, use this to specify\nwhich account to retrieve this metric from.\nIf you are performing a `PutMetricAlarm` operation, use this to specify\nwhich 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-accountid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ReturnData": { "Required": false, "MarkdownDocumentation": "`ReturnData`\n\nWhen used in `GetMetricData`, this option indicates whether to return the\ntimestamps and raw data values of this metric. If you are performing this call just to\ndo math expressions and do not also need the raw data returned, you can specify\n`false`. If you omit this, the default of `true` is\nused.\nWhen used in `PutMetricAlarm`, specify `true` for the one\nexpression result to use as the alarm. For all other metrics and expressions in the same\n`PutMetricAlarm` operation, specify `ReturnData` as\nFalse.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-returndata", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Expression": { "Required": false, "MarkdownDocumentation": "`Expression`\n\nThis field can contain either a Metrics Insights query, or a metric math expression to\nbe performed on the returned data. For more information about Metrics Insights queries,\nsee [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon\nCloudWatch User Guide*.\nA math expression can use the `Id` of the other metrics or queries to refer\nto those metrics, and can also use the `Id` of other expressions to use the\nresult of those expressions. For more information about metric math expressions, see\n[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\nGuide*.\nWithin each MetricDataQuery object, you must specify either `Expression` or\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-expression", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MetricStat": { "Type": "MetricStat", "Required": false, "MarkdownDocumentation": "`MetricStat`\n\nThe metric to be returned, along with statistics, period, and units. Use this\nparameter only if this object is retrieving a metric and not performing a math\nexpression on returned data.\nWithin one MetricDataQuery object, you must specify either `Expression` or\n`MetricStat` but not both.\n*Required*: No\n*Type*: [MetricStat](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-metricstat", "UpdateType": "Immutable" }, "Label": { "Required": false, "MarkdownDocumentation": "`Label`\n\nA human-readable label for this metric or expression. This is especially useful if\nthis is an expression, so that you know what the value represents. If the metric or\nexpression is shown in a CloudWatch dashboard widget, the label is shown. If Label is\nomitted, CloudWatch generates a default.\nYou can put dynamic expressions into a label, so that it is more descriptive. For more\ninformation, see [Using Dynamic\nLabels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-label", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Period": { "Required": false, "MarkdownDocumentation": "`Period`\n\nThe granularity, in seconds, of the returned data points. For metrics with regular\nresolution, a period can be as short as one minute (60 seconds) and must be a multiple\nof 60. For high-resolution metrics that are collected at intervals of less than one\nminute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution\nmetrics are those metrics stored by a `PutMetricData` operation that includes\na `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-period", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA short name used to tie this object to the results in the response. This name must be\nunique within a single call to `GetMetricData`. If you are performing math\nexpressions on this set of data, this name represents that data and can serve as a\nvariable in the mathematical expression. The valid characters are letters, numbers, and\nunderscore. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-id", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::CloudWatch::AnomalyDetector.MetricMathAnomalyDetector": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.MetricMathAnomalyDetector`\n\nIndicates the CloudWatch math expression that provides the time series the anomaly\ndetector uses as input. The designated math expression must return a single time\nseries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricmathanomalydetector.html", "Properties": { "MetricDataQueries": { "Type": "List", "Required": false, "MarkdownDocumentation": "`MetricDataQueries`\n\nAn array of metric data query structures that enables you to create an anomaly\ndetector based on the result of a metric math expression. Each item in\n`MetricDataQueries` gets a metric or performs a math expression. One item\nin `MetricDataQueries` is the expression that provides the time series that\nthe anomaly detector uses as input. Designate the expression by setting\n`ReturnData` to `true` for this object in the array. For all\nother expressions and metrics, set `ReturnData` to `false`. The\ndesignated expression must return a single time series.\n*Required*: No\n*Type*: Array of [MetricDataQuery](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricmathanomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector-metricdataqueries", "ItemType": "MetricDataQuery", "UpdateType": "Immutable" } } }, "AWS::CloudWatch::AnomalyDetector.MetricStat": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.MetricStat`\n\nThis structure defines the metric to be returned, along with the statistics, period,\nand units.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html", "Properties": { "Stat": { "Required": true, "MarkdownDocumentation": "`Stat`\n\nThe statistic to return. It can include any CloudWatch statistic or extended\nstatistic.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-stat", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Period": { "Required": true, "MarkdownDocumentation": "`Period`\n\nThe granularity, in seconds, of the returned data points. For metrics with regular\nresolution, a period can be as short as one minute (60 seconds) and must be a multiple\nof 60. For high-resolution metrics that are collected at intervals of less than one\nminute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution\nmetrics are those metrics stored by a `PutMetricData` call that includes a\n`StorageResolution` of 1 second.\nIf the `StartTime` parameter specifies a time stamp that is greater than\n3 hours ago, you must specify the period as follows or no data points in that time range\nis returned:\n* Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds\n (1 minute).\n* Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5\n minutes).\n* Start time greater than 63 days ago - Use a multiple of 3600 seconds (1\n hour).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-period", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "Metric": { "Type": "Metric", "Required": true, "MarkdownDocumentation": "`Metric`\n\nThe metric to return, including the metric name, namespace, and dimensions.\n*Required*: Yes\n*Type*: [Metric](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-metric", "UpdateType": "Immutable" }, "Unit": { "Required": false, "MarkdownDocumentation": "`Unit`\n\nWhen you are using a `Put` operation, this defines what unit you want to\nuse when storing the metric.\nIn a `Get` operation, if you omit `Unit` then all data that\nwas collected with any unit is returned, along with the corresponding units that were\nspecified when the data was reported to CloudWatch. If you specify a unit, the operation\nreturns only data that was collected with that unit specified. If you specify a unit\nthat does not match the data collected, the results of the operation are null.\nCloudWatch does not perform unit conversions.\n*Required*: No\n*Type*: String\n*Allowed values*: `Seconds | Microseconds | Mi...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-unit", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::CloudWatch::AnomalyDetector.Range": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.Range`\n\nEach `Range` specifies one range of days or times to exclude from use for training or updating an\nanomaly detection model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html", "Properties": { "EndTime": { "Required": true, "MarkdownDocumentation": "`EndTime`\n\nThe end time of the range to exclude. The format is `yyyy-MM-dd'T'HH:mm:ss`. For example,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-endtime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StartTime": { "Required": true, "MarkdownDocumentation": "`StartTime`\n\nThe start time of the range to exclude. The format is `yyyy-MM-dd'T'HH:mm:ss`. For example,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-starttime", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CloudWatch::AnomalyDetector.SingleMetricAnomalyDetector": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector.SingleMetricAnomalyDetector`\n\nDesignates the CloudWatch metric and statistic that provides the time series the\nanomaly detector uses as input. If you have enabled unified cross-account observability,\nand this account is a monitoring account, the metric can be in the same account or a\nsource account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html", "Properties": { "MetricName": { "Required": false, "MarkdownDocumentation": "`MetricName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-metricname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AccountId": { "Required": false, "MarkdownDocumentation": "`AccountId`\n\nIf the CloudWatch metric that provides the time series that the anomaly detector uses as input is in another account, specify that account ID here. If you omit this parameter, the current account 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-accountid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Stat": { "Required": false, "MarkdownDocumentation": "`Stat`\n\nThe statistic to use for the metric and anomaly detection model.\n*Required*: No\n*Type*: String\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*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-stat", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Dimensions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Dimensions`\n\nThe metric dimensions to create the anomaly detection model for.\n*Required*: No\n*Type*: Array of [Dimension](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-dimensions", "ItemType": "Dimension", "UpdateType": "Immutable" }, "Namespace": { "Required": false, "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric to create the anomaly detection model for.\n*Required*: No\n*Type*: String\n*Pattern*: `[^:].*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-namespace", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::CloudWatch::InsightRule.Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::CloudWatch::InsightRule.Tags`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-insightrule-tags.html", "ItemType": "Tag", "UpdateType": "Mutable" }, "AWS::CloudWatch::MetricStream.MetricStreamFilter": { "MarkdownDocumentation": "`AWS::CloudWatch::MetricStream.MetricStreamFilter`\n\nThis structure contains a metric namespace and optionally, a list of metric names, to either include in a metric '\nstream or exclude from a metric stream.\nA metric stream's filters can include up to 1000 total names. This limit applies to the sum of namespace names\nand metric names in the filters. For example, this could include 10 metric namespace filters with\n99 metrics each, or 20 namespace filters with 49 metrics specified in each filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html", "Properties": { "MetricNames": { "MarkdownDocumentation": "`MetricNames`\n\nThe names of the metrics to either include or exclude from the metric stream.\nIf you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this\nfilter is specified as an exclude filter or an include filter.\nEach metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name\nmust contain at least one non-whitespace character.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `255 | 999`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html#cfn-cloudwatch-metricstream-metricstreamfilter-metricnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe name of the metric namespace in the filter.\nThe namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must\ncontain at least one non-whitespace character.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html#cfn-cloudwatch-metricstream-metricstreamfilter-namespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudWatch::MetricStream.MetricStreamStatisticsConfiguration": { "MarkdownDocumentation": "`AWS::CloudWatch::MetricStream.MetricStreamStatisticsConfiguration`\n\nThis structure specifies a list of additional statistics to stream, and the metrics to stream those\nadditional statistics for.\nAll metrics that match the combination of metric name and namespace will be streamed\nwith the additional statistics, no matter their dimensions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html", "Properties": { "IncludeMetrics": { "MarkdownDocumentation": "`IncludeMetrics`\n\nAn array that\ndefines the metrics that are to have additional statistics streamed.\n*Required*: Yes\n*Type*: Array of [MetricStreamStatisticsMetric](./aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html#cfn-cloudwatch-metricstream-metricstreamstatisticsconfiguration-includemetrics", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MetricStreamStatisticsMetric", "DuplicatesAllowed": false }, "AdditionalStatistics": { "MarkdownDocumentation": "`AdditionalStatistics`\n\nThe\nadditional statistics to stream for the metrics listed in `IncludeMetrics`.\n*Required*: Yes\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html#cfn-cloudwatch-metricstream-metricstreamstatisticsconfiguration-additionalstatistics", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CloudWatch::MetricStream.MetricStreamStatisticsMetric": { "MarkdownDocumentation": "`AWS::CloudWatch::MetricStream.MetricStreamStatisticsMetric`\n\nA structure that specifies the\nmetric name and namespace for one metric that is going to have additional statistics included in the stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html#cfn-cloudwatch-metricstream-metricstreamstatisticsmetric-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html#cfn-cloudwatch-metricstream-metricstreamstatisticsmetric-namespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodeArtifact::PackageGroup.OriginConfiguration": { "MarkdownDocumentation": "`AWS::CodeArtifact::PackageGroup.OriginConfiguration`\n\nThe `OriginConfiguration` property type specifies Property description not available. for an [AWS::CodeArtifact::PackageGroup](./aws-resource-codeartifact-packagegroup.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-originconfiguration.html", "Properties": { "Restrictions": { "MarkdownDocumentation": "`Restrictions`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [Restrictions](./aws-properties-codeartifact-packagegroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-originconfiguration.html#cfn-codeartifact-packagegroup-originconfiguration-restrictions", "UpdateType": "Mutable", "Required": true, "Type": "Restrictions" } } }, "AWS::CodeArtifact::PackageGroup.RestrictionType": { "MarkdownDocumentation": "`AWS::CodeArtifact::PackageGroup.RestrictionType`\n\nThe `RestrictionType` property type specifies Property description not available. for an [AWS::CodeArtifact::PackageGroup](./aws-resource-codeartifact-packagegroup.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictiontype.html", "Properties": { "Repositories": { "MarkdownDocumentation": "`Repositories`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictiontype.html#cfn-codeartifact-packagegroup-restrictiontype-repositories", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RestrictionMode": { "MarkdownDocumentation": "`RestrictionMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALLOW | BLOCK | ALLOW_SPECI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "BLOCK", "ALLOW_SPECIFIC_REPOSITORIES", "INHERIT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictiontype.html#cfn-codeartifact-packagegroup-restrictiontype-restrictionmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodeArtifact::PackageGroup.Restrictions": { "MarkdownDocumentation": "`AWS::CodeArtifact::PackageGroup.Restrictions`\n\nThe `Restrictions` property type specifies Property description not available. for an [AWS::CodeArtifact::PackageGroup](./aws-resource-codeartifact-packagegroup.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictions.html", "Properties": { "ExternalUpstream": { "MarkdownDocumentation": "`ExternalUpstream`\n\nProperty description not available.\n*Required*: No\n*Type*: [RestrictionType](./aws-properties-codeartifact-packagegroup-restrictiontype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictions.html#cfn-codeartifact-packagegroup-restrictions-externalupstream", "UpdateType": "Mutable", "Required": false, "Type": "RestrictionType" }, "Publish": { "MarkdownDocumentation": "`Publish`\n\nProperty description not available.\n*Required*: No\n*Type*: [RestrictionType](./aws-properties-codeartifact-packagegroup-restrictiontype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictions.html#cfn-codeartifact-packagegroup-restrictions-publish", "UpdateType": "Mutable", "Required": false, "Type": "RestrictionType" }, "InternalUpstream": { "MarkdownDocumentation": "`InternalUpstream`\n\nProperty description not available.\n*Required*: No\n*Type*: [RestrictionType](./aws-properties-codeartifact-packagegroup-restrictiontype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictions.html#cfn-codeartifact-packagegroup-restrictions-internalupstream", "UpdateType": "Mutable", "Required": false, "Type": "RestrictionType" } } }, "AWS::CodeBuild::Fleet.ComputeConfiguration": { "MarkdownDocumentation": "`AWS::CodeBuild::Fleet.ComputeConfiguration`\n\nContains compute attributes. These attributes only need be specified when your project's or fleet's `computeType` is set to `ATTRIBUTE_BASED_COMPUTE` or `CUSTOM_INSTANCE_TYPE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-computeconfiguration.html", "Properties": { "disk": { "MarkdownDocumentation": "`disk`\n\nThe amount of disk space of the instance type included in your fleet.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-computeconfiguration.html#cfn-codebuild-fleet-computeconfiguration-disk", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "memory": { "MarkdownDocumentation": "`memory`\n\nThe amount of memory of the instance type included in your fleet.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-computeconfiguration.html#cfn-codebuild-fleet-computeconfiguration-memory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "vCpu": { "MarkdownDocumentation": "`vCpu`\n\nThe number of vCPUs of the instance type included in your fleet.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-computeconfiguration.html#cfn-codebuild-fleet-computeconfiguration-vcpu", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "instanceType": { "MarkdownDocumentation": "`instanceType`\n\nThe EC2 instance type to be launched in your fleet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-computeconfiguration.html#cfn-codebuild-fleet-computeconfiguration-instancetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "machineType": { "MarkdownDocumentation": "`machineType`\n\nThe machine type of the instance type included in your fleet.\n*Required*: No\n*Type*: String\n*Allowed values*: `GENERAL | NVME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GENERAL", "NVME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-computeconfiguration.html#cfn-codebuild-fleet-computeconfiguration-machinetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodeBuild::Fleet.FleetProxyRule": { "MarkdownDocumentation": "`AWS::CodeBuild::Fleet.FleetProxyRule`\n\nInformation about the proxy rule for your reserved capacity instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-fleetproxyrule.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of proxy rule.\n*Required*: No\n*Type*: String\n*Allowed values*: `DOMAIN | IP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DOMAIN", "IP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-fleetproxyrule.html#cfn-codebuild-fleet-fleetproxyrule-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Effect": { "MarkdownDocumentation": "`Effect`\n\nThe behavior of the proxy rule.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOW | DENY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-fleetproxyrule.html#cfn-codebuild-fleet-fleetproxyrule-effect", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Entities": { "MarkdownDocumentation": "`Entities`\n\nThe destination of the proxy rule.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-fleetproxyrule.html#cfn-codebuild-fleet-fleetproxyrule-entities", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CodeBuild::Fleet.ProxyConfiguration": { "MarkdownDocumentation": "`AWS::CodeBuild::Fleet.ProxyConfiguration`\n\nInformation about the proxy configurations that apply network access control to your reserved capacity instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-proxyconfiguration.html", "Properties": { "DefaultBehavior": { "MarkdownDocumentation": "`DefaultBehavior`\n\nThe default behavior of outgoing traffic.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOW_ALL | DENY_ALL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW_ALL", "DENY_ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-proxyconfiguration.html#cfn-codebuild-fleet-proxyconfiguration-defaultbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OrderedProxyRules": { "MarkdownDocumentation": "`OrderedProxyRules`\n\nAn array of `FleetProxyRule` objects that represent the specified destination domains or IPs to allow or deny network access control to.\n*Required*: No\n*Type*: Array of [FleetProxyRule](./aws-properties-codebuild-fleet-fleetproxyrule.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-proxyconfiguration.html#cfn-codebuild-fleet-proxyconfiguration-orderedproxyrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FleetProxyRule", "DuplicatesAllowed": true } } }, "AWS::CodeBuild::Fleet.ScalingConfigurationInput": { "MarkdownDocumentation": "`AWS::CodeBuild::Fleet.ScalingConfigurationInput`\n\nThe scaling configuration input of a compute fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-scalingconfigurationinput.html", "Properties": { "TargetTrackingScalingConfigs": { "MarkdownDocumentation": "`TargetTrackingScalingConfigs`\n\nA list of `TargetTrackingScalingConfiguration` objects.\n*Required*: No\n*Type*: Array of [TargetTrackingScalingConfiguration](./aws-properties-codebuild-fleet-targettrackingscalingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-scalingconfigurationinput.html#cfn-codebuild-fleet-scalingconfigurationinput-targettrackingscalingconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetTrackingScalingConfiguration", "DuplicatesAllowed": true }, "ScalingType": { "MarkdownDocumentation": "`ScalingType`\n\nThe scaling type for a compute fleet.\n*Required*: No\n*Type*: String\n*Allowed values*: `TARGET_TRACKING_SCALING...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TARGET_TRACKING_SCALING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-scalingconfigurationinput.html#cfn-codebuild-fleet-scalingconfigurationinput-scalingtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum number of instances in the \ufb02eet when auto-scaling.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-scalingconfigurationinput.html#cfn-codebuild-fleet-scalingconfigurationinput-maxcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::CodeBuild::Fleet.TargetTrackingScalingConfiguration": { "MarkdownDocumentation": "`AWS::CodeBuild::Fleet.TargetTrackingScalingConfiguration`\n\nDefines when a new instance is auto-scaled into the compute fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-targettrackingscalingconfiguration.html", "Properties": { "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nThe value of `metricType` when to start scaling.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-targettrackingscalingconfiguration.html#cfn-codebuild-fleet-targettrackingscalingconfiguration-targetvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MetricType": { "MarkdownDocumentation": "`MetricType`\n\nThe metric type to determine auto-scaling.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLEET_UTILIZATION_RATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FLEET_UTILIZATION_RATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-targettrackingscalingconfiguration.html#cfn-codebuild-fleet-targettrackingscalingconfiguration-metrictype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodeBuild::Fleet.VpcConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::Fleet.VpcConfig`\n\nInformation about the VPC configuration that AWS CodeBuild accesses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-vpcconfig.html", "Properties": { "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nA list of one or more subnet IDs in your Amazon VPC.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-vpcconfig.html#cfn-codebuild-fleet-vpcconfig-subnets", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the Amazon VPC.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-vpcconfig.html#cfn-codebuild-fleet-vpcconfig-vpcid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of one or more security groups IDs in your Amazon VPC.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-vpcconfig.html#cfn-codebuild-fleet-vpcconfig-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CodeBuild::Project.Artifacts": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.Artifacts`\n\n`Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for\nartifacts generated by an AWS CodeBuild build.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html", "Properties": { "Path": { "Required": false, "MarkdownDocumentation": "`Path`\n\nAlong with `namespaceType` and `name`, the pattern that AWS CodeBuild\nuses to name and store the output artifact:\n* If `type` is set to `CODEPIPELINE`, CodePipeline ignores this\n value if specified. This is because CodePipeline manages its build output names instead\n of AWS CodeBuild.\n* If `type` is set to `NO_ARTIFACTS`, this value is\n ignored if specified, because no build output is produced.\n* If `type` is set to `S3`, this is the path to the output\n artifact. If `path` is not specified, `path` is not\n used.\nFor example, if `path` is set to `MyArtifacts`,\n`namespaceType` is set to `NONE`, and `name` is set\nto `MyArtifact.zip`, the output artifact is stored in the output bucket at\n`MyArtifacts/MyArtifact.zip`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-path", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of build output artifact. Valid values include:\n* `CODEPIPELINE`: The build project has build output generated\n through CodePipeline.\n \n ###### Note\n \n The `CODEPIPELINE` type is not supported for\n `secondaryArtifacts`.\n* `NO_ARTIFACTS`: The build project does not produce any build\n output.\n* `S3`: The build project stores build output in Amazon S3.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CODEPIPELINE | S3 | NO_ARTI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CODEPIPELINE", "S3", "NO_ARTIFACTS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ArtifactIdentifier": { "Required": false, "MarkdownDocumentation": "`ArtifactIdentifier`\n\nAn identifier for this artifact 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-artifactidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OverrideArtifactName": { "Required": false, "MarkdownDocumentation": "`OverrideArtifactName`\n\nIf set to true a name specified in the buildspec file overrides the artifact name.\nThe name specified in a buildspec file is calculated at build time and uses the Shell command language.\nFor example, you can append a date and time to your artifact name so that it is always unique.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-overrideartifactname", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Packaging": { "Required": false, "MarkdownDocumentation": "`Packaging`\n\nThe type of build output artifact to create:\n* If `type` is set to `CODEPIPELINE`, CodePipeline ignores this\n value if specified. This is because CodePipeline manages its build output artifacts\n instead of AWS CodeBuild.\n* If `type` is set to `NO_ARTIFACTS`, this value is\n ignored if specified, because no build output is produced.\n* If `type` is set to `S3`, valid values include:\n \n + `NONE`: AWS CodeBuild creates in the output bucket a folder that\n contains the build output. This is the default if `packaging`\n is not specified.\n + `ZIP`: AWS CodeBuild creates in the output bucket a ZIP file that\n contains the build output.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | ZIP`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "NONE", "ZIP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-packaging", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncryptionDisabled": { "Required": false, "MarkdownDocumentation": "`EncryptionDisabled`\n\nSet to true if you do not want your output artifacts encrypted. This option is valid\nonly if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an\n`invalidInputException` is thrown.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-encryptiondisabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Location": { "Required": false, "MarkdownDocumentation": "`Location`\n\nInformation about the build output artifact location:\n* If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this value\n if specified. This is because CodePipeline manages its build output locations instead of\n CodeBuild.\n* If `type` is set to `NO_ARTIFACTS`, this value is ignored if\n specified, because no build output is produced.\n* If `type` is set to `S3`, this is the name of the output\n bucket.\nIf you specify `CODEPIPELINE` or `NO_ARTIFACTS` for the `Type`\nproperty, don't specify this property. For all of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-location", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nAlong with `path` and `namespaceType`, the pattern that AWS CodeBuild uses\nto name and store the output artifact:\n* If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this value\n if specified. This is because CodePipeline manages its build output names instead of\n AWS CodeBuild.\n* If `type` is set to `NO_ARTIFACTS`, this value is ignored if\n specified, because no build output is produced.\n* If `type` is set to `S3`, this is the name of the output\n artifact object. If you set the name to be a forward slash (\"/\"), the artifact is\n stored in the root of the output bucket.\nFor example:\n* If `path` is set to `MyArtifacts`,\n `namespaceType` is set to `BUILD_ID`, and `name`\n is set to `MyArtifact.zip`, then the output artifact is stored in\n `MyArtifacts/build-ID/MyArtifact.zip`.\n* If `path` is empty, `namespaceType` is set to\n `NONE`, and `name` is set to \"`/`\", the output\n artifact is stored in the root of the output bucket.\n* If `path` is set to `MyArtifacts`,\n `namespaceType` is set to `BUILD_ID`, and `name`\n is set to \"`/`\", the output artifact is stored in\n `MyArtifacts/build-ID`.\nIf you specify `CODEPIPELINE` or `NO_ARTIFACTS` for the `Type`\nproperty, don't specify this property. For all of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NamespaceType": { "Required": false, "MarkdownDocumentation": "`NamespaceType`\n\nAlong with `path` and `name`, the pattern that AWS CodeBuild uses to\ndetermine the name and location to store the output artifact:\n* If `type` is set to `CODEPIPELINE`, CodePipeline ignores this\n value if specified. This is because CodePipeline manages its build output names instead\n of AWS CodeBuild.\n* If `type` is set to `NO_ARTIFACTS`, this value is\n ignored if specified, because no build output is produced.\n* If `type` is set to `S3`, valid values include:\n \n + `BUILD_ID`: Include the build ID in the location of the\n build output artifact.\n + `NONE`: Do not include the build ID. This is the default if\n `namespaceType` is not specified.\nFor example, if `path` is set to `MyArtifacts`,\n`namespaceType` is set to `BUILD_ID`, and `name` is\nset to `MyArtifact.zip`, the output artifact is stored in\n`MyArtifacts//MyArtifact.zip`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | BUILD_ID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "BUILD_ID" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-namespacetype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.BatchRestrictions": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.BatchRestrictions`\n\nSpecifies restrictions for the batch build.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html", "Properties": { "ComputeTypesAllowed": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ComputeTypesAllowed`\n\nAn array of strings that specify the compute types that are allowed for the batch\nbuild. See [Build environment\ncompute types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild User Guide* for these values.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html#cfn-codebuild-project-batchrestrictions-computetypesallowed", "UpdateType": "Mutable" }, "MaximumBuildsAllowed": { "Required": false, "MarkdownDocumentation": "`MaximumBuildsAllowed`\n\nSpecifies the maximum number of builds allowed.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html#cfn-codebuild-project-batchrestrictions-maximumbuildsallowed", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.BuildStatusConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.BuildStatusConfig`\n\nContains information that defines how the AWS CodeBuild build project reports the build status\nto the source provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html", "Properties": { "Context": { "Required": false, "MarkdownDocumentation": "`Context`\n\nSpecifies the context of the build status CodeBuild sends to the source provider. The\nusage of this parameter depends on the source provider.\nBitbucket\nThis parameter is used for the `name` parameter in the\nBitbucket commit status. For more information, see [build](https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) in the Bitbucket API documentation.\n\nGitHub/GitHub Enterprise Server\nThis parameter is used for the `context` parameter in the\nGitHub commit status. For more information, see [Create a commit status](https://developer.github.com/v3/repos/statuses/#create-a-commit-status) in the GitHub developer guide.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html#cfn-codebuild-project-buildstatusconfig-context", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TargetUrl": { "Required": false, "MarkdownDocumentation": "`TargetUrl`\n\nSpecifies the target url of the build status CodeBuild sends to the source provider. The\nusage of this parameter depends on the source provider.\nBitbucket\nThis parameter is used for the `url` parameter in the Bitbucket\ncommit status. For more information, see [build](https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) in the Bitbucket API documentation.\n\nGitHub/GitHub Enterprise Server\nThis parameter is used for the `target_url` parameter in the\nGitHub commit status. For more information, see [Create a commit status](https://developer.github.com/v3/repos/statuses/#create-a-commit-status) in the GitHub developer guide.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html#cfn-codebuild-project-buildstatusconfig-targeturl", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.CloudWatchLogsConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.CloudWatchLogsConfig`\n\n`CloudWatchLogs` is a property of the\n[AWS CodeBuild Project LogsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html) property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html", "Properties": { "Status": { "Required": true, "MarkdownDocumentation": "`Status`\n\nThe current status of the logs in CloudWatch Logs for a build project. Valid values are:\n* `ENABLED`: CloudWatch Logs are enabled for this build project.\n* `DISABLED`: CloudWatch Logs are not enabled for this build project.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-status", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GroupName": { "Required": false, "MarkdownDocumentation": "`GroupName`\n\nThe group name of the logs in CloudWatch Logs. For more information, see [Working\nwith Log Groups and Log Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-groupname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StreamName": { "Required": false, "MarkdownDocumentation": "`StreamName`\n\nThe prefix of the stream name of the CloudWatch Logs. For more information, see [Working\nwith Log Groups and Log Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-streamname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.DockerServer": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.DockerServer`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-dockerserver.html", "Properties": { "ComputeType": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-dockerserver.html#cfn-codebuild-project-dockerserver-computetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-dockerserver.html#cfn-codebuild-project-dockerserver-securitygroupids", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.Environment": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.Environment`\n\n`Environment` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies\nthe environment for an AWS CodeBuild project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of build environment to use for related builds.\n###### Note\nIf you're using compute fleets during project creation, `type` will be ignored.\nFor more information, see [Build environment compute types](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild\nuser guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WINDOWS_CONTAINER | LINUX_C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS_CONTAINER", "LINUX_CONTAINER", "LINUX_GPU_CONTAINER", "ARM_CONTAINER", "WINDOWS_SERVER_2019_CONTAINER", "WINDOWS_SERVER_2022_CONTAINER", "LINUX_LAMBDA_CONTAINER", "ARM_LAMBDA_CONTAINER", "LINUX_EC2", "ARM_EC2", "WINDOWS_EC2", "MAC_ARM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EnvironmentVariables": { "Type": "List", "Required": false, "MarkdownDocumentation": "`EnvironmentVariables`\n\nA set of environment variables to make available to builds for this build\nproject.\n*Required*: No\n*Type*: Array of [EnvironmentVariable](./aws-properties-codebuild-project-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-environmentvariables", "ItemType": "EnvironmentVariable", "UpdateType": "Mutable" }, "Fleet": { "Type": "ProjectFleet", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-fleet", "UpdateType": "Mutable" }, "PrivilegedMode": { "Required": false, "MarkdownDocumentation": "`PrivilegedMode`\n\nEnables running the Docker daemon inside a Docker container. Set to true only if the\nbuild project is used to build Docker images. Otherwise, a build that attempts\nto interact with the Docker daemon fails. The default setting is `false`.\nYou can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands\nto the install phase of your buildspec file:\nIf the operating system's base image is Ubuntu Linux:\n`- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&`\n`- timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"`\nIf the operating system's base image is Alpine Linux and the previous command does not work, add the `-t` argument\nto `timeout`:\n`- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&`\n`- timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"`\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-privilegedmode", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ImagePullCredentialsType": { "Required": false, "MarkdownDocumentation": "`ImagePullCredentialsType`\n\nThe type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\nvalues:\n* `CODEBUILD` specifies that AWS CodeBuild uses its own credentials.\n This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.\n* `SERVICE_ROLE` specifies that AWS CodeBuild uses your build project's service\n role.\nWhen you use a cross-account or private registry image, you must use SERVICE\\_ROLE\ncredentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.\n*Required*: No\n*Type*: String\n*Allowed values*: `CODEBUILD | SERVICE_ROLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CODEBUILD", "SERVICE_ROLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-imagepullcredentialstype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Image": { "Required": true, "MarkdownDocumentation": "`Image`\n\nThe image tag or image digest that identifies the Docker image to use for this build\nproject. Use the following formats:\n* For an image tag: `/:`. For\n example, in the Docker repository that CodeBuild uses to manage its Docker\n images, this would be `aws/codebuild/standard:4.0`.\n* For an image digest: `/@`.\n For example, to specify an image with the digest\n \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use\n `/@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf`.\nFor more information, see [Docker images provided by CodeBuild](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-available.html) in the *AWS CodeBuild user\nguide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-image", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RegistryCredential": { "Type": "RegistryCredential", "Required": false, "MarkdownDocumentation": "`RegistryCredential`\n\n`RegistryCredential` is a property of the [AWS::CodeBuild::Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment) property that specifies information about credentials that provide access to a private Docker registry. When this is set:\n* `imagePullCredentialsType` must be set to `SERVICE_ROLE`.\n* images cannot be curated or an Amazon ECR image.\n*Required*: No\n*Type*: [RegistryCredential](./aws-properties-codebuild-project-registrycredential.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-registrycredential", "UpdateType": "Mutable" }, "ComputeType": { "Required": true, "MarkdownDocumentation": "`ComputeType`\n\nThe type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values\ninclude:\n* `ATTRIBUTE_BASED_COMPUTE`: Specify the amount of vCPUs, memory, disk space, and the type of machine.\n \n ###### Note\n \n If you use `ATTRIBUTE_BASED_COMPUTE`, you must define your attributes by using `computeConfiguration`. AWS CodeBuild\n will select the cheapest instance that satisfies your specified attributes. For more information, see [Reserved capacity environment\n types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types) in the *AWS CodeBuild User Guide*.\n* `BUILD_GENERAL1_SMALL`: Use up to 4 GiB memory and 2 vCPUs for\n builds.\n* `BUILD_GENERAL1_MEDIUM`: Use up to 8 GiB memory and 4 vCPUs for\n builds.\n* `BUILD_GENERAL1_LARGE`: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.\n* `BUILD_GENERAL1_XLARGE`: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.\n* `BUILD_GENERAL1_2XLARGE`: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.\n* `BUILD_LAMBDA_1GB`: Use up to 1 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\n* `BUILD_LAMBDA_2GB`: Use up to 2 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\n* `BUILD_LAMBDA_4GB`: Use up to 4 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\n* `BUILD_LAMBDA_8GB`: Use up to 8 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\n* `BUILD_LAMBDA_10GB`: Use up to 10 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\nIf you use `BUILD_GENERAL1_SMALL`:\n* For environment type `LINUX_CONTAINER`, you can use up to 4 GiB\n memory and 2 vCPUs for builds.\n* For environment type `LINUX_GPU_CONTAINER`, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.\n* For environment type `ARM_CONTAINER`, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.\nIf you use `BUILD_GENERAL1_LARGE`:\n* For environment type `LINUX_CONTAINER`, you can use up to 16 GiB\n memory and 8 vCPUs for builds.\n* For environment type `LINUX_GPU_CONTAINER`, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.\n* For environment type `ARM_CONTAINER`, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.\nFor more information, see [On-demand environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types)\nin the *AWS CodeBuild 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-computetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DockerServer": { "Type": "DockerServer", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-dockerserver", "UpdateType": "Mutable" }, "Certificate": { "Required": false, "MarkdownDocumentation": "`Certificate`\n\nThe ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded\ncertificate for the build project. For more information, see [certificate](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate) in the\n*AWS CodeBuild 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-certificate", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.EnvironmentVariable": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.EnvironmentVariable`\n\n`EnvironmentVariable` is a property of the [AWS CodeBuild Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html)\nproperty type that specifies the name and value of an environment variable for an AWS CodeBuild\nproject environment. When you use the environment to run a build, these variables are available for your builds to use. `EnvironmentVariable`\ncontains a list of `EnvironmentVariable` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html", "Properties": { "Type": { "Required": false, "MarkdownDocumentation": "`Type`\n\nThe type of environment variable. Valid values include:\n* `PARAMETER_STORE`: An environment variable stored in Systems Manager\n Parameter Store. For environment variables of this type, specify the name of the parameter as the `value` of the\n EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter\n Store environment variables in the buildspec. To learn how to do so,\n see [env/parameter-store](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store) in the\n *AWS CodeBuild User Guide*.\n* `PLAINTEXT`: An environment variable in plain text format. This is\n the default value.\n* `SECRETS_MANAGER`: An environment variable stored in AWS Secrets Manager. For environment variables of this type,\n specify the name of the secret as the `value` of the EnvironmentVariable. The secret value will be substituted for the\n name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see\n [env/secrets-manager](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager) in the\n *AWS CodeBuild User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `PLAINTEXT | PARAMETER_STORE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PLAINTEXT", "PARAMETER_STORE", "SECRETS_MANAGER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nThe value of the environment variable.\n###### Important\nWe strongly discourage the use of `PLAINTEXT` environment variables to\nstore sensitive values, especially AWS secret key IDs.\n`PLAINTEXT` environment variables can be displayed in plain text\nusing the AWS CodeBuild console and the AWS CLI. For sensitive values, we recommend you use an\nenvironment variable of type `PARAMETER_STORE` or\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-value", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name or key of the environment variable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.FilterGroup": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::CodeBuild::Project.FilterGroup`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-filtergroup.html", "ItemType": "WebhookFilter", "UpdateType": "Mutable" }, "AWS::CodeBuild::Project.GitSubmodulesConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.GitSubmodulesConfig`\n\n`GitSubmodulesConfig` is a property of the [AWS CodeBuild Project Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html)\nproperty type that specifies information about the Git submodules configuration for the build project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-gitsubmodulesconfig.html", "Properties": { "FetchSubmodules": { "Required": true, "MarkdownDocumentation": "`FetchSubmodules`\n\nSet to true to fetch Git submodules for your AWS CodeBuild build project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-gitsubmodulesconfig.html#cfn-codebuild-project-gitsubmodulesconfig-fetchsubmodules", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.LogsConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.LogsConfig`\n\n`LogsConfig` is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource\nthat specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a\nspecified S3 bucket, or both.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html", "Properties": { "CloudWatchLogs": { "Type": "CloudWatchLogsConfig", "Required": false, "MarkdownDocumentation": "`CloudWatchLogs`\n\nInformation about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.\n*Required*: No\n*Type*: [CloudWatchLogsConfig](./aws-properties-codebuild-project-cloudwatchlogsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html#cfn-codebuild-project-logsconfig-cloudwatchlogs", "UpdateType": "Mutable" }, "S3Logs": { "Type": "S3LogsConfig", "Required": false, "MarkdownDocumentation": "`S3Logs`\n\nInformation about logs built to an S3 bucket for a build project. S3 logs are not\nenabled by default.\n*Required*: No\n*Type*: [S3LogsConfig](./aws-properties-codebuild-project-s3logsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html#cfn-codebuild-project-logsconfig-s3logs", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.ProjectBuildBatchConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.ProjectBuildBatchConfig`\n\nContains configuration information about a batch build project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html", "Properties": { "CombineArtifacts": { "Required": false, "MarkdownDocumentation": "`CombineArtifacts`\n\nSpecifies if the build artifacts for the batch build should be combined into a single\nartifact location.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-combineartifacts", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ServiceRole": { "Required": false, "MarkdownDocumentation": "`ServiceRole`\n\nSpecifies the service role ARN for the batch build project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-servicerole", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BatchReportMode": { "Required": false, "MarkdownDocumentation": "`BatchReportMode`\n\nSpecifies how build status reports are sent to the source provider for the batch build. This property is only used\nwhen the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise,\nand your project is configured to report build statuses to the source provider.\nREPORT\\_AGGREGATED\\_BATCH\n(Default) Aggregate all of the build statuses into a single status report.\n\nREPORT\\_INDIVIDUAL\\_BUILDS\nSend a separate status report for each individual build.\n\n*Required*: No\n*Type*: String\n*Allowed values*: `REPORT_INDIVIDUAL_BUILDS | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REPORT_INDIVIDUAL_BUILDS", "REPORT_AGGREGATED_BATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-batchreportmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimeoutInMins": { "Required": false, "MarkdownDocumentation": "`TimeoutInMins`\n\nSpecifies the maximum amount of time, in minutes, that the batch build must be completed in.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-timeoutinmins", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Restrictions": { "Type": "BatchRestrictions", "Required": false, "MarkdownDocumentation": "`Restrictions`\n\nA `BatchRestrictions` object that specifies the restrictions for the batch\nbuild.\n*Required*: No\n*Type*: [BatchRestrictions](./aws-properties-codebuild-project-batchrestrictions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-restrictions", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.ProjectCache": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.ProjectCache`\n\n`ProjectCache` is a property of the\n[AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html)\nresource that specifies information about the cache for the build project. If `ProjectCache` is not specified, then both of its properties\ndefault to `NO_CACHE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html", "Properties": { "Modes": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Modes`\n\nAn array of strings that specify the local cache modes. You can use one or more local\ncache modes at the same time. This is only used for `LOCAL` cache\ntypes.\nPossible values are:\nLOCAL\\_SOURCE\\_CACHE\nCaches Git metadata for primary and secondary sources. After the cache is\ncreated, subsequent builds pull only the change between commits. This mode\nis a good choice for projects with a clean working directory and a source\nthat is a large Git repository. If you choose this option and your project\ndoes not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the\noption is ignored.\n\nLOCAL\\_DOCKER\\_LAYER\\_CACHE\nCaches existing Docker layers. This mode is a good choice for projects\nthat build or pull large Docker images. It can prevent the performance\nissues caused by pulling large Docker images down from the network.\n###### Note\n* You can use a Docker layer cache in the Linux environment\n only.\n* The `privileged` flag must be set so that your\n project has the required Docker permissions.\n* You should consider the security implications before you use a\n Docker layer cache.\n\nLOCAL\\_CUSTOM\\_CACHE\nCaches directories you specify in the buildspec file. This mode is a good\nchoice if your build scenario is not suited to one of the other three local\ncache modes. If you use a custom cache:\n* Only directories can be specified for caching. You cannot specify\n individual files.\n* Symlinks are used to reference cached directories.\n* Cached directories are linked to your build before it downloads\n its project sources. Cached items are overridden if a source item\n has the same name. Directories are specified using cache paths in\n the buildspec file.\n\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-modes", "UpdateType": "Mutable" }, "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of cache used by the build project. Valid values include:\n* `NO_CACHE`: The build project does not use any cache.\n* `S3`: The build project reads and writes from and to S3.\n* `LOCAL`: The build project stores a cache locally on a build host\n that is only available to that build host.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NO_CACHE | S3 | LOCAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NO_CACHE", "S3", "LOCAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CacheNamespace": { "Required": false, "MarkdownDocumentation": "`CacheNamespace`\n\nDefines the scope of the cache. You can use this namespace to share a cache across\nmultiple projects. For more information, see [Cache sharing\nbetween projects](https://docs.aws.amazon.com/codebuild/latest/userguide/caching-s3.html#caching-s3-sharing) in the *AWS CodeBuild 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-cachenamespace", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Location": { "Required": false, "MarkdownDocumentation": "`Location`\n\nInformation about the cache location:\n* `NO_CACHE` or `LOCAL`: This value is ignored.\n* `S3`: This is the S3 bucket name/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-location", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.ProjectFileSystemLocation": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.ProjectFileSystemLocation`\n\nInformation about a file system created by Amazon Elastic File System (EFS). For more\ninformation, see [What Is\nAmazon Elastic File System?](https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html", "Properties": { "MountPoint": { "Required": true, "MarkdownDocumentation": "`MountPoint`\n\nThe location in the container where you mount the file system.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountpoint", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of the file system. The one supported type is `EFS`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EFS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "EFS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Identifier": { "Required": true, "MarkdownDocumentation": "`Identifier`\n\nThe name used to access a file system created by Amazon EFS. CodeBuild creates an\nenvironment variable by appending the `identifier` in all capital letters to\n`CODEBUILD_`. For example, if you specify `my_efs` for\n`identifier`, a new environment variable is create named\n`CODEBUILD_MY_EFS`.\nThe `identifier` is used to mount your file system.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-identifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MountOptions": { "Required": false, "MarkdownDocumentation": "`MountOptions`\n\nThe mount options for a file system created by Amazon EFS. The default mount options\nused by CodeBuild are\n`nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2`. For\nmore information, see [Recommended NFS Mount\nOptions](https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountoptions", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Location": { "Required": true, "MarkdownDocumentation": "`Location`\n\nA string that specifies the location of the file system created by Amazon EFS. Its\nformat is `efs-dns-name:/directory-path`. You can find the DNS name of file\nsystem when you view it in the Amazon EFS console. The directory path is a path to a\ndirectory in the file system that CodeBuild mounts. For example, if the DNS name of a\nfile system is `fs-abcd1234.efs.us-west-2.amazonaws.com`, and its mount\ndirectory is `my-efs-mount-directory`, then the `location` is\n`fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory`.\nThe directory path in the format `efs-dns-name:/directory-path` is\noptional. If you do not specify a directory path, the location is only the DNS name and\nCodeBuild mounts the entire file system.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-location", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.ProjectFleet": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.ProjectFleet`\n\nInformation about the compute fleet of the build project. For more\ninformation, see [Working\nwith reserved capacity in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/fleets.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfleet.html", "Properties": { "FleetArn": { "Required": false, "MarkdownDocumentation": "`FleetArn`\n\nSpecifies the compute fleet ARN for the build project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfleet.html#cfn-codebuild-project-projectfleet-fleetarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.ProjectSourceVersion": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.ProjectSourceVersion`\n\nA source identifier and its corresponding version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html", "Properties": { "SourceIdentifier": { "Required": true, "MarkdownDocumentation": "`SourceIdentifier`\n\nAn identifier for a source in the build project. The identifier can only contain\nalphanumeric characters and underscores, and must be less than 128 characters in length.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html#cfn-codebuild-project-projectsourceversion-sourceidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SourceVersion": { "Required": false, "MarkdownDocumentation": "`SourceVersion`\n\nThe source version for the corresponding source identifier. If specified, must be one\nof:\n* For CodeCommit: the commit ID, branch, or Git tag to use.\n* For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format `pr/pull-request-ID`\n (for example, `pr/25`). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.\n* For GitLab: the commit ID, branch, or Git tag to use.\n* For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.\n* For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.\nFor more information, see [Source Version Sample\nwith CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the *AWS CodeBuild 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html#cfn-codebuild-project-projectsourceversion-sourceversion", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.ProjectTriggers": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.ProjectTriggers`\n\n`ProjectTriggers` is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html)\nresource that specifies webhooks that trigger an AWS CodeBuild build.\n###### Note\nThe Webhook feature isn't available in AWS CloudFormation for GitHub Enterprise projects. Use the AWS CLI or AWS CodeBuild console to create the webhook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html", "Properties": { "FilterGroups": { "Type": "List", "Required": false, "MarkdownDocumentation": "`FilterGroups`\n\nA list of lists of `WebhookFilter` objects used to determine which webhook\nevents are triggered. At least one `WebhookFilter` in the array must specify `EVENT` as its type.\n*Required*: No\n*Type*: Array of Array\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-filtergroups", "ItemType": "FilterGroup", "UpdateType": "Mutable" }, "BuildType": { "Required": false, "MarkdownDocumentation": "`BuildType`\n\nSpecifies the type of build this webhook will trigger. Allowed values are:\nBUILD\nA single build\n\nBUILD\\_BATCH\nA batch build\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-buildtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Webhook": { "Required": false, "MarkdownDocumentation": "`Webhook`\n\nSpecifies whether or not to begin automatically rebuilding the source code every time a code change is pushed to the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-webhook", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ScopeConfiguration": { "Type": "ScopeConfiguration", "Required": false, "MarkdownDocumentation": "`ScopeConfiguration`\n\nContains configuration information about the scope for a webhook.\n*Required*: No\n*Type*: [ScopeConfiguration](./aws-properties-codebuild-project-scopeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-scopeconfiguration", "UpdateType": "Mutable" }, "PullRequestBuildPolicy": { "Type": "PullRequestBuildPolicy", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-pullrequestbuildpolicy", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.PullRequestBuildPolicy": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.PullRequestBuildPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-pullrequestbuildpolicy.html", "Properties": { "RequiresCommentApproval": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-pullrequestbuildpolicy.html#cfn-codebuild-project-pullrequestbuildpolicy-requirescommentapproval", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ApproverRoles": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-pullrequestbuildpolicy.html#cfn-codebuild-project-pullrequestbuildpolicy-approverroles", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.RegistryCredential": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.RegistryCredential`\n\n`RegistryCredential` is a property of the\n[AWS CodeBuild Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html) property type that specifies information about credentials that provide access to a private Docker registry. When this is set:\n* `imagePullCredentialsType` must be set to `SERVICE_ROLE`.\n* images cannot be curated or an Amazon ECR image.\nFor more information, see [Private Registry with\nAWS Secrets Manager Sample for AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html", "Properties": { "Credential": { "Required": true, "MarkdownDocumentation": "`Credential`\n\nThe Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.\n###### Note\nThe `credential` can use the name of the credentials only if they\nexist in your current AWS Region.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credential", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CredentialProvider": { "Required": true, "MarkdownDocumentation": "`CredentialProvider`\n\nThe service that created the credentials to access a private Docker registry. The\nvalid value, SECRETS\\_MANAGER, is for AWS Secrets Manager.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SECRETS_MANAGER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SECRETS_MANAGER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credentialprovider", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.S3LogsConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.S3LogsConfig`\n\n`S3Logs` is a property of the\n[AWS CodeBuild Project LogsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html) property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html", "Properties": { "Status": { "Required": true, "MarkdownDocumentation": "`Status`\n\nThe current status of the S3 build logs. Valid values are:\n* `ENABLED`: S3 build logs are enabled for this build project.\n* `DISABLED`: S3 build logs are not enabled for this build\n project.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-status", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncryptionDisabled": { "Required": false, "MarkdownDocumentation": "`EncryptionDisabled`\n\nSet to true if you do not want your S3 build log output encrypted. By default S3\nbuild logs 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-encryptiondisabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Location": { "Required": false, "MarkdownDocumentation": "`Location`\n\nThe ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket\nname is `my-bucket`, and your path prefix is `build-log`, then\nacceptable formats are `my-bucket/build-log` or\n`arn:aws:s3:::my-bucket/build-log`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-location", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.ScopeConfiguration": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.ScopeConfiguration`\n\nContains configuration information about the scope for a webhook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-scopeconfiguration.html", "Properties": { "Scope": { "Required": false, "MarkdownDocumentation": "`Scope`\n\nThe type of scope for a GitHub or GitLab webhook. The scope default is GITHUB\\_ORGANIZATION.\n*Required*: No\n*Type*: String\n*Allowed values*: `GITHUB_ORGANIZATION | GITHU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GITHUB_ORGANIZATION", "GITHUB_GLOBAL", "GITLAB_GROUP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-scopeconfiguration.html#cfn-codebuild-project-scopeconfiguration-scope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Domain": { "Required": false, "MarkdownDocumentation": "`Domain`\n\nThe domain of the GitHub Enterprise organization or the GitLab Self Managed group. Note that this parameter is only required if your project's source type is GITHUB\\_ENTERPRISE or GITLAB\\_SELF\\_MANAGED.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-scopeconfiguration.html#cfn-codebuild-project-scopeconfiguration-domain", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of either the enterprise or organization that will send webhook events to CodeBuild, depending on if the webhook is a global or organization webhook respectively.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-scopeconfiguration.html#cfn-codebuild-project-scopeconfiguration-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.Source": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.Source`\n\n`Source` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies\nthe source code settings for the project, such as the source code's repository type and location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of repository that contains the source code to be built. Valid values\ninclude:\n* `BITBUCKET`: The source code is in a Bitbucket repository.\n* `CODECOMMIT`: The source code is in an CodeCommit repository.\n* `CODEPIPELINE`: The source code settings are specified in the\n source action of a pipeline in CodePipeline.\n* `GITHUB`: The source code is in a GitHub repository.\n* `GITHUB_ENTERPRISE`: The source code is in a GitHub Enterprise\n Server repository.\n* `GITLAB`: The source code is in a GitLab repository.\n* `GITLAB_SELF_MANAGED`: The source code is in a self-managed GitLab repository.\n* `NO_SOURCE`: The project does not have input source code.\n* `S3`: The source code is in an Amazon S3 bucket.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CODECOMMIT | CODEPIPELINE |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CODECOMMIT", "CODEPIPELINE", "GITHUB", "GITLAB", "GITLAB_SELF_MANAGED", "S3", "BITBUCKET", "GITHUB_ENTERPRISE", "NO_SOURCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReportBuildStatus": { "Required": false, "MarkdownDocumentation": "`ReportBuildStatus`\n\nSet to true to report the status of a build's start and finish to your source provider.\nThis option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or\nBitbucket. If this is set and you use a different source provider, an `invalidInputException`\nis thrown.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-reportbuildstatus", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Auth": { "Type": "SourceAuth", "Required": false, "MarkdownDocumentation": "`Auth`\n\nInformation about the authorization settings for AWS CodeBuild to access the source code to be\nbuilt.\n*Required*: No\n*Type*: [SourceAuth](./aws-properties-codebuild-project-sourceauth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-auth", "UpdateType": "Mutable" }, "SourceIdentifier": { "Required": false, "MarkdownDocumentation": "`SourceIdentifier`\n\nAn identifier for this project source. The identifier can only contain\nalphanumeric characters and underscores, and must be less than 128 characters in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-sourceidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BuildSpec": { "Required": false, "MarkdownDocumentation": "`BuildSpec`\n\nThe build specification for the project. If this value is not provided, then the source code must contain a\nbuildspec file named `buildspec.yml` at the root level. If this value is provided, it can be either\na single string containing the entire build specification, or the path to an alternate buildspec file relative\nto the value of the built-in environment variable `CODEBUILD_SRC_DIR`. The alternate buildspec file\ncan have a name other than `buildspec.yml`, for example `myspec.yml` or\n`build_spec_qa.yml` or similar. For more information, see the [Build Spec Reference](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example) in the\n*AWS CodeBuild 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-buildspec", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GitCloneDepth": { "Required": false, "MarkdownDocumentation": "`GitCloneDepth`\n\nThe depth of history to download. Minimum value is 0. If this value is 0,\ngreater than 25, or not provided, then the full history is downloaded with each build project.\nIf your source type is Amazon S3, this value is not supported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitclonedepth", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "BuildStatusConfig": { "Type": "BuildStatusConfig", "Required": false, "MarkdownDocumentation": "`BuildStatusConfig`\n\nContains information that defines how the build project reports the build status to\nthe source provider. This option is only used when the source provider is\n`GITHUB`, `GITHUB_ENTERPRISE`, or\n`BITBUCKET`.\n*Required*: No\n*Type*: [BuildStatusConfig](./aws-properties-codebuild-project-buildstatusconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-buildstatusconfig", "UpdateType": "Mutable" }, "GitSubmodulesConfig": { "Type": "GitSubmodulesConfig", "Required": false, "MarkdownDocumentation": "`GitSubmodulesConfig`\n\nInformation about the Git submodules configuration for the build project.\n*Required*: No\n*Type*: [GitSubmodulesConfig](./aws-properties-codebuild-project-gitsubmodulesconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitsubmodulesconfig", "UpdateType": "Mutable" }, "InsecureSsl": { "Required": false, "MarkdownDocumentation": "`InsecureSsl`\n\nThis is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository.\nThe default value is `false`. `InsecureSsl` should be used for testing purposes only. It should not be used in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-insecuressl", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Location": { "Required": false, "MarkdownDocumentation": "`Location`\n\nInformation about the location of the source code to be built. Valid values\ninclude:\n* For source code settings that are specified in the source action of a pipeline\n in CodePipeline, `location` should not be specified. If it is specified,\n CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source\n action instead of this value.\n* For source code in an CodeCommit repository, the HTTPS clone URL to the repository\n that contains the source code and the buildspec file (for example,\n `https://git-codecommit..amazonaws.com/v1/repos/`).\n* For source code in an Amazon S3 input bucket, one of the following.\n \n + The path to the ZIP file that contains the source code (for example,\n `//.zip`).\n + The path to the folder that contains the source code (for example,\n `///`).\n* For source code in a GitHub repository, the HTTPS clone URL to the repository\n that contains the source and the buildspec file. You must connect your AWS account\n to your GitHub account. Use the AWS CodeBuild console to start creating a build\n project. When you use the console to connect (or reconnect) with GitHub, on the\n GitHub **Authorize application** page, for\n **Organization access**, choose **Request access** next to each repository you want to\n allow AWS CodeBuild to have access to, and then choose **Authorize\n application**. (After you have connected to your GitHub account,\n you do not need to finish creating the build project. You can leave the AWS CodeBuild\n console.) To instruct AWS CodeBuild to use this connection, in the `source`\n object, set the `auth` object's `type` value to\n `OAUTH`.\n* For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository\n that contains the source and the buildspec file. You must connect your AWS account\n to your GitLab account. Use the AWS CodeBuild console to start creating a build\n project. When you use the console to connect (or reconnect) with GitLab, on the\n Connections **Authorize application** page, choose **Authorize**. Then on the AWS CodeConnections**Create GitLab connection** page,\n choose **Connect to GitLab**. (After you have connected to your GitLab account,\n you do not need to finish creating the build project. You can leave the AWS CodeBuild\n console.) To instruct AWS CodeBuild to override the default connection and use this connection instead,\n set the `auth` object's `type` value to\n `CODECONNECTIONS` in the `source` object.\n* For source code in a Bitbucket repository, the HTTPS clone URL to the\n repository that contains the source and the buildspec file. You must connect\n your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start\n creating a build project. When you use the console to connect (or reconnect)\n with Bitbucket, on the Bitbucket **Confirm access to your\n account** page, choose **Grant\n access**. (After you have connected to your Bitbucket account, you\n do not need to finish creating the build project. You can leave the AWS CodeBuild\n console.) To instruct AWS CodeBuild to use this connection, in the `source`\n object, set the `auth` object's `type` value to\n `OAUTH`.\nIf you specify `CODEPIPELINE` for the `Type` property, don't specify this\nproperty. For all of the other types, you must specify `Location`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-location", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.SourceAuth": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.SourceAuth`\n\n`SourceAuth` is a property of the [AWS CodeBuild Project Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html) property type that specifies authorization settings for AWS CodeBuild to access the source code to be built.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe authorization type to use. Valid options are OAUTH, CODECONNECTIONS, or SECRETS\\_MANAGER.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OAUTH | CODECONNECTIONS | S...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OAUTH", "CODECONNECTIONS", "SECRETS_MANAGER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html#cfn-codebuild-project-sourceauth-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Resource": { "Required": false, "MarkdownDocumentation": "`Resource`\n\nThe resource value that applies to the specified authorization 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html#cfn-codebuild-project-sourceauth-resource", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.VpcConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.VpcConfig`\n\n`VpcConfig` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource\nthat enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see\n[Use AWS CodeBuild with Amazon Virtual Private Cloud](https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html) in\nthe *AWS CodeBuild User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html", "Properties": { "Subnets": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Subnets`\n\nA list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-subnets", "UpdateType": "Mutable" }, "VpcId": { "Required": false, "MarkdownDocumentation": "`VpcId`\n\nThe ID of the Amazon VPC.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-vpcid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-securitygroupids", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::Project.WebhookFilter": { "MarkdownDocumentation": "`AWS::CodeBuild::Project.WebhookFilter`\n\n`WebhookFilter` is a structure of the `FilterGroups` property on the\n[AWS CodeBuild Project ProjectTriggers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html)\nproperty type\nthat specifies which webhooks trigger an AWS CodeBuild build.\n###### Note\nThe Webhook feature isn't available in AWS CloudFormation for GitHub Enterprise projects. Use the AWS CLI or AWS CodeBuild console to create the webhook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html", "Properties": { "Pattern": { "Required": true, "MarkdownDocumentation": "`Pattern`\n\nFor a `WebHookFilter` that uses `EVENT` type, a comma-separated\nstring that specifies one or more events. For example, the webhook filter `PUSH,\nPULL_REQUEST_CREATED, PULL_REQUEST_UPDATED` allows all push, pull request\ncreated, and pull request updated events to trigger a build.\nFor a `WebHookFilter` that uses any of the other filter types, a regular\nexpression pattern. For example, a `WebHookFilter` that uses\n`HEAD_REF` for its `type` and the pattern\n`^refs/heads/` triggers a build when the head reference is a branch with\na reference name `refs/heads/branch-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-pattern", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of webhook filter. There are 11 webhook filter types: `EVENT`,\n`ACTOR_ACCOUNT_ID`, `HEAD_REF`, `BASE_REF`,\n`FILE_PATH`, `COMMIT_MESSAGE`, `TAG_NAME`, `RELEASE_NAME`,\n`REPOSITORY_NAME`, `ORGANIZATION_NAME`,\nand `WORKFLOW_NAME`.\n* EVENT\n \n + A webhook event triggers a build when the provided `pattern`\n matches one of nine event types: `PUSH`,\n `PULL_REQUEST_CREATED`, `PULL_REQUEST_UPDATED`,\n `PULL_REQUEST_CLOSED`, `PULL_REQUEST_REOPENED`,\n `PULL_REQUEST_MERGED`, `RELEASED`, `PRERELEASED`,\n and `WORKFLOW_JOB_QUEUED`. The `EVENT` patterns are\n specified as a comma-separated string. For example, `PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED` filters all push, pull\n request created, and pull request updated events.\n \n ###### Note\n \n Types `PULL_REQUEST_REOPENED` and `WORKFLOW_JOB_QUEUED`\n work with GitHub and GitHub Enterprise only. Types `RELEASED` and\n `PRERELEASED` work with GitHub only.\n* ACTOR\\_ACCOUNT\\_ID\n \n + A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression `pattern`.\n* HEAD\\_REF\n \n + A webhook event triggers a build when the head reference matches the\n regular expression `pattern`. For example,\n `refs/heads/branch-name` and `refs/tags/tag-name`.\n \n ###### Note\n \n Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.\n* BASE\\_REF\n \n + A webhook event triggers a build when the base reference matches the\n regular expression `pattern`. For example,\n `refs/heads/branch-name`.\n \n ###### Note\n \n Works with pull request events only.\n* FILE\\_PATH\n \n + A webhook triggers a build when the path of a changed file matches the\n regular expression `pattern`.\n \n ###### Note\n \n Works with push and pull request events only.\n* COMMIT\\_MESSAGE\n \n + A webhook triggers a build when the head commit message matches the\n regular expression `pattern`.\n \n ###### Note\n \n Works with push and pull request events only.\n* TAG\\_NAME\n \n + A webhook triggers a build when the tag name of the release matches the\n regular expression `pattern`.\n \n ###### Note\n \n Works with `RELEASED` and `PRERELEASED` events only.\n* RELEASE\\_NAME\n \n + A webhook triggers a build when the release name matches the\n regular expression `pattern`.\n \n ###### Note\n \n Works with `RELEASED` and `PRERELEASED` events only.\n* REPOSITORY\\_NAME\n \n + A webhook triggers a build when the repository name matches the\n regular expression `pattern`.\n \n ###### Note\n \n Works with GitHub global or organization webhooks only.\n* ORGANIZATION\\_NAME\n \n + A webhook triggers a build when the organization name matches the\n regular expression `pattern`.\n \n ###### Note\n \n Works with GitHub global webhooks only.\n* WORKFLOW\\_NAME\n \n + A webhook triggers a build when the workflow name matches the\n regular expression `pattern`.\n \n ###### Note\n \n Works with `WORKFLOW_JOB_QUEUED` events only.\n \n \n ###### Note\n \n For CodeBuild-hosted Buildkite runner builds, WORKFLOW\\_NAME\n filters will filter by pipeline name.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EVENT | BASE_REF | HEAD_REF...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME", "REPOSITORY_NAME", "ORGANIZATION_NAME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExcludeMatchedPattern": { "Required": false, "MarkdownDocumentation": "`ExcludeMatchedPattern`\n\nUsed to indicate that the `pattern` determines which webhook events do not\ntrigger a build. If true, then a webhook event that does not match the\n`pattern` triggers a build. If false, then a webhook event that matches\nthe `pattern` triggers a build.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-excludematchedpattern", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::ReportGroup.ReportExportConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::ReportGroup.ReportExportConfig`\n\nInformation about the location where the run of a report is exported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html", "Properties": { "S3Destination": { "Type": "S3ReportExportConfig", "Required": false, "MarkdownDocumentation": "`S3Destination`\n\nA `S3ReportExportConfig` object that contains information about the S3\nbucket where the run of a report is exported.\n*Required*: No\n*Type*: [S3ReportExportConfig](./aws-properties-codebuild-reportgroup-s3reportexportconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html#cfn-codebuild-reportgroup-reportexportconfig-s3destination", "UpdateType": "Mutable" }, "ExportConfigType": { "Required": true, "MarkdownDocumentation": "`ExportConfigType`\n\nThe export configuration type. Valid values are:\n* `S3`: The report results are exported to an S3 bucket.\n* `NO_EXPORT`: The report results are not exported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `S3 | NO_EXPORT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "S3", "NO_EXPORT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html#cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::ReportGroup.S3ReportExportConfig": { "MarkdownDocumentation": "`AWS::CodeBuild::ReportGroup.S3ReportExportConfig`\n\nInformation about the S3 bucket where the raw data of a report are exported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html", "Properties": { "Path": { "Required": false, "MarkdownDocumentation": "`Path`\n\nThe path to the exported report's raw data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-path", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Bucket": { "Required": true, "MarkdownDocumentation": "`Bucket`\n\nThe name of the S3 bucket where the raw data of a report are exported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-bucket", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Packaging": { "Required": false, "MarkdownDocumentation": "`Packaging`\n\nThe type of build output artifact to create. Valid values include:\n* `NONE`: CodeBuild creates the raw data in the output bucket. This\n is the default if packaging is not specified.\n* `ZIP`: CodeBuild creates a ZIP file with the raw data in the\n output bucket.\n*Required*: No\n*Type*: String\n*Allowed values*: `ZIP | NONE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ZIP", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-packaging", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncryptionKey": { "Required": false, "MarkdownDocumentation": "`EncryptionKey`\n\nThe encryption key for the report's encrypted raw data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BucketOwner": { "Required": false, "MarkdownDocumentation": "`BucketOwner`\n\nThe AWS account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket\nthat is owned by an account other than the account running the build.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-bucketowner", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncryptionDisabled": { "Required": false, "MarkdownDocumentation": "`EncryptionDisabled`\n\nA boolean value that specifies if the results of a report 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-encryptiondisabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::CodeCommit::Repository.Code": { "MarkdownDocumentation": "`AWS::CodeCommit::Repository.Code`\n\nInformation about code to be committed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-code.html", "Properties": { "S3": { "Type": "S3", "Required": true, "MarkdownDocumentation": "`S3`\n\nInformation about the Amazon S3 bucket that contains a ZIP file of code to\nbe committed to the repository. Changes to this property are ignored after initial\nresource creation.\n*Required*: Yes\n*Type*: [S3](./aws-properties-codecommit-repository-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-code.html#cfn-codecommit-repository-code-s3", "UpdateType": "Mutable" }, "BranchName": { "Required": false, "MarkdownDocumentation": "`BranchName`\n\nOptional. Specifies a branch name to be used as the default branch when importing code\ninto a repository on initial creation. If this property is not set, the name\n*main* will be used for the default branch for the repository.\nChanges to this property are ignored after initial resource creation. We recommend using\nthis parameter to set the name to *main* to align with the default\nbehavior of CodeCommit unless another name is needed.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-code.html#cfn-codecommit-repository-code-branchname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeCommit::Repository.RepositoryTrigger": { "MarkdownDocumentation": "`AWS::CodeCommit::Repository.RepositoryTrigger`\n\nInformation about a trigger for a repository.\n###### Note\nIf you want to receive notifications about repository events, consider using notifications instead of\ntriggers. For more information, see [Configuring\nnotifications for repository events](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-repository-email.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html", "Properties": { "Events": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`Events`\n\nThe repository events that cause the trigger to run actions in another service, such\nas sending a notification through Amazon SNS.\n###### Note\nThe valid value \"all\" cannot be used with any other values.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-events", "UpdateType": "Mutable" }, "Branches": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Branches`\n\nThe branches to be included in the trigger configuration. If you specify an empty\narray, the trigger applies to all branches.\n###### Note\nAlthough no content is required in the array, you must include the array itself.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-branches", "UpdateType": "Mutable" }, "CustomData": { "Required": false, "MarkdownDocumentation": "`CustomData`\n\nAny custom data associated with the trigger to be included in the information sent to\nthe target of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-customdata", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DestinationArn": { "Required": true, "MarkdownDocumentation": "`DestinationArn`\n\nThe ARN of the resource that is the target for a trigger (for example, the ARN of a\ntopic in Amazon SNS).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-destinationarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the trigger.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeCommit::Repository.S3": { "MarkdownDocumentation": "`AWS::CodeCommit::Repository.S3`\n\nInformation about the Amazon S3 bucket that contains the code that will be\ncommitted to the new repository. Changes to this property are ignored after initial\nresource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-s3.html", "Properties": { "ObjectVersion": { "Required": false, "MarkdownDocumentation": "`ObjectVersion`\n\nThe object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket. Changes to this property are ignored after initial resource creation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-s3.html#cfn-codecommit-repository-s3-objectversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Bucket": { "Required": true, "MarkdownDocumentation": "`Bucket`\n\nThe name of the Amazon S3 bucket that contains the ZIP file with the content\nthat will be committed to the new repository. This can be specified using the name of\nthe bucket in the AWS account. Changes to this property are ignored after\ninitial resource creation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-s3.html#cfn-codecommit-repository-s3-bucket", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Key": { "Required": true, "MarkdownDocumentation": "`Key`\n\nThe key to use for accessing the Amazon S3 bucket. Changes to this property\nare ignored after initial resource creation. For more information, see [Creating\nobject key names](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html) and [Uploading objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html) in the\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-s3.html#cfn-codecommit-repository-s3-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts`\n\n`MinimumHealthyHosts` is a property of the [DeploymentConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html) resource that defines how many instances must remain healthy\nduring an AWS CodeDeploy deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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\n 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\ninstances at a time. The deployment is successful if six or more instances are deployed to\nsuccessfully. Otherwise, the deployment fails. If a FLEET\\_PERCENT of 40 is specified, deploy\nto up to five instance at a time. The deployment is successful if four or more instance are\ndeployed to successfully. Otherwise, the deployment fails.\n###### Note\nIn a call to `GetDeploymentConfig`, CodeDeployDefault.OneAtATime returns a\nminimum healthy instance type of MOST\\_CONCURRENCY and a value of 1. This means a deployment\nto only one instance at a time. (You cannot set the type to MOST\\_CONCURRENCY, only to\nHOST\\_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\nduring the deployment. Although this allows one instance at a time to be taken offline for a\nnew deployment, it also means that if the deployment to the last instance fails, the overall\ndeployment is still successful.\nFor more information, see [AWS CodeDeploy Instance\nHealth](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*: `HOST_COUNT | FLEET_PERCENT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "HOST_COUNT", "FLEET_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHostsPerZone": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHostsPerZone`\n\nInformation about the minimum number of healthy instances per Availability\nZone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhostsperzone.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe `type` associated with the `MinimumHealthyHostsPerZone`\noption.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HOST_COUNT | FLEET_PERCENT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "HOST_COUNT", "FLEET_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhostsperzone.html#cfn-codedeploy-deploymentconfig-minimumhealthyhostsperzone-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe `value` associated with the `MinimumHealthyHostsPerZone`\noption.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhostsperzone.html#cfn-codedeploy-deploymentconfig-minimumhealthyhostsperzone-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::CodeDeploy::DeploymentConfig.TimeBasedCanary": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentConfig.TimeBasedCanary`\n\nA configuration that shifts traffic from one version of a Lambda function\nor Amazon ECS task set to another in two increments. The original and target\nLambda function versions or ECS task sets are specified in the\ndeployment's AppSpec file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html", "Properties": { "CanaryPercentage": { "MarkdownDocumentation": "`CanaryPercentage`\n\nThe percentage of traffic to shift in the first increment of a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html#cfn-codedeploy-deploymentconfig-timebasedcanary-canarypercentage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "CanaryInterval": { "MarkdownDocumentation": "`CanaryInterval`\n\nThe number of minutes between the first and second traffic shifts of a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html#cfn-codedeploy-deploymentconfig-timebasedcanary-canaryinterval", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::CodeDeploy::DeploymentConfig.TimeBasedLinear": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentConfig.TimeBasedLinear`\n\nA configuration that shifts traffic from one version of a Lambda function\nor ECS task set to another in equal increments, with an equal number of minutes between\neach increment. The original and target Lambda function versions or ECS task\nsets are specified in the deployment's AppSpec file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html", "Properties": { "LinearInterval": { "MarkdownDocumentation": "`LinearInterval`\n\nThe number of minutes between each incremental traffic shift of a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html#cfn-codedeploy-deploymentconfig-timebasedlinear-linearinterval", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "LinearPercentage": { "MarkdownDocumentation": "`LinearPercentage`\n\nThe percentage of traffic that is shifted at the start of each increment of a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html#cfn-codedeploy-deploymentconfig-timebasedlinear-linearpercentage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::CodeDeploy::DeploymentConfig.TrafficRoutingConfig": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentConfig.TrafficRoutingConfig`\n\nThe configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment,\nor from one Amazon ECS task set to another during an Amazon ECS\ndeployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-trafficroutingconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of traffic shifting (`TimeBasedCanary` or\n`TimeBasedLinear`) used by a deployment configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TimeBasedCanary | TimeBased...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TimeBasedCanary", "TimeBasedLinear", "TimeBasedFlexible", "AllAtOnce" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-trafficroutingconfig.html#cfn-codedeploy-deploymentconfig-trafficroutingconfig-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TimeBasedLinear": { "MarkdownDocumentation": "`TimeBasedLinear`\n\nA configuration that shifts traffic from one version of a Lambda function\nor Amazon ECS task set to another in equal increments, with an equal number of\nminutes between each increment. The original and target Lambda function\nversions or Amazon ECS task sets are specified in the deployment's AppSpec\nfile.\n*Required*: No\n*Type*: [TimeBasedLinear](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-trafficroutingconfig.html#cfn-codedeploy-deploymentconfig-trafficroutingconfig-timebasedlinear", "UpdateType": "Immutable", "Required": false, "Type": "TimeBasedLinear" }, "TimeBasedCanary": { "MarkdownDocumentation": "`TimeBasedCanary`\n\nA configuration that shifts traffic from one version of a Lambda function\nor ECS task set to another in two increments. The original and target Lambda\nfunction versions or ECS task sets are specified in the deployment's AppSpec\nfile.\n*Required*: No\n*Type*: [TimeBasedCanary](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-trafficroutingconfig.html#cfn-codedeploy-deploymentconfig-trafficroutingconfig-timebasedcanary", "UpdateType": "Immutable", "Required": false, "Type": "TimeBasedCanary" } } }, "AWS::CodeDeploy::DeploymentConfig.ZonalConfig": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentConfig.ZonalConfig`\n\nConfigure the `ZonalConfig` object if you want AWS CodeDeploy to\ndeploy your application to one [Availability Zone](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones) at a time, within an AWS Region. By\ndeploying to one Availability Zone at a time, you can expose your deployment to a\nprogressively larger audience as confidence in the deployment's performance and\nviability grows. If you don't configure the `ZonalConfig` object, CodeDeploy deploys your application to a random selection of hosts across a\nRegion.\nFor more information about the zonal configuration feature, see [zonal configuration](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-zonalconfig.html", "Properties": { "MonitorDurationInSeconds": { "MarkdownDocumentation": "`MonitorDurationInSeconds`\n\nThe period of time, in seconds, that CodeDeploy must wait after completing a\ndeployment to an Availability Zone. CodeDeploy will wait this amount of time\nbefore starting a deployment to the next Availability Zone. Consider adding a monitor\nduration to give the deployment some time to prove itself (or 'bake') in one\nAvailability Zone before it is released in the next zone. If you don't specify a\n`monitorDurationInSeconds`, CodeDeploy starts deploying to the\nnext Availability Zone immediately.\nFor more information about the zonal configuration feature, see [zonal configuration](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-zonalconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig-monitordurationinseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Long" }, "MinimumHealthyHostsPerZone": { "MarkdownDocumentation": "`MinimumHealthyHostsPerZone`\n\nThe number or percentage of instances that must remain available per Availability Zone\nduring a deployment. This option works in conjunction with the\n`MinimumHealthyHosts` option. For more information, see [About the minimum number of healthy hosts per Availability Zone](https://docs.aws.amazon.com//codedeploy/latest/userguide/instances-health.html#minimum-healthy-hosts-az) in the\n*CodeDeploy User Guide*.\nIf you don't specify the `minimumHealthyHostsPerZone` option, then CodeDeploy uses a default value of `0` percent.\nFor more information about the zonal configuration feature, see [zonal configuration](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User\nGuide*.\n*Required*: No\n*Type*: [MinimumHealthyHostsPerZone](./aws-properties-codedeploy-deploymentconfig-minimumhealthyhostsperzone.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-zonalconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig-minimumhealthyhostsperzone", "UpdateType": "Immutable", "Required": false, "Type": "MinimumHealthyHostsPerZone" }, "FirstZoneMonitorDurationInSeconds": { "MarkdownDocumentation": "`FirstZoneMonitorDurationInSeconds`\n\nThe period of time, in seconds, that CodeDeploy must wait after completing a\ndeployment to the *first* Availability Zone. CodeDeploy will\nwait this amount of time before starting a deployment to the second Availability Zone.\nYou might set this option if you want to allow extra bake time for the first\nAvailability Zone. If you don't specify a value for\n`firstZoneMonitorDurationInSeconds`, then CodeDeploy uses the\n`monitorDurationInSeconds` value for the first Availability Zone.\nFor more information about the zonal configuration feature, see [zonal configuration](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-zonalconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig-firstzonemonitordurationinseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Long" } } }, "AWS::CodeDeploy::DeploymentGroup.Alarm": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.Alarm`\n\nThe `Alarm` property type specifies a CloudWatch alarm to use for an\nAWS CodeDeploy deployment group. The `Alarm` property of the [CodeDeploy DeploymentGroup AlarmConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html) property contains a list of\n`Alarm` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the alarm. Maximum length is 255 characters. Each alarm name can be used\nonly 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html#cfn-codedeploy-deploymentgroup-alarm-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration`\n\nThe `AlarmConfiguration` property type configures CloudWatch alarms\nfor an AWS CodeDeploy deployment group. `AlarmConfiguration` is a\nproperty of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html", "Properties": { "Alarms": { "MarkdownDocumentation": "`Alarms`\n\nA list of alarms configured for the deployment or deployment group. A maximum of 10\nalarms can be added.\n*Required*: No\n*Type*: Array of [Alarm](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-alarms", "DuplicatesAllowed": false, "ItemType": "Alarm", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-enabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "IgnorePollAlarmFailure": { "MarkdownDocumentation": "`IgnorePollAlarmFailure`\n\nIndicates whether a deployment should continue if information about the current state of\nalarms cannot be retrieved from Amazon CloudWatch. The default value is\n`false`.\n* `true`: The deployment proceeds even if alarm status information can't be\n retrieved from CloudWatch.\n* `false`: The deployment stops if alarm status information can't be retrieved\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-ignorepollalarmfailure", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration`\n\nThe `AutoRollbackConfiguration` property type configures automatic rollback for\nan AWS CodeDeploy deployment group when a deployment is not completed successfully.\nFor more information, see [Automatic Rollbacks](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployments-rollback-and-redeploy.html#deployments-rollback-and-redeploy-automatic-rollbacks) in the *AWS CodeDeploy User\nGuide*.\n`AutoRollbackConfiguration` is a property of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether a defined automatic rollback configuration is currently\nenabled.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-enabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Events": { "MarkdownDocumentation": "`Events`\n\nThe event type or types that trigger a rollback. Valid values are\n`DEPLOYMENT_FAILURE`, `DEPLOYMENT_STOP_ON_ALARM`, or\n`DEPLOYMENT_STOP_ON_REQUEST`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-events", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.BlueGreenDeploymentConfiguration": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.BlueGreenDeploymentConfiguration`\n\nInformation about blue/green deployment options for a deployment group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html", "Properties": { "DeploymentReadyOption": { "MarkdownDocumentation": "`DeploymentReadyOption`\n\nInformation about the action to take when newly provisioned instances are ready to\nreceive traffic in a blue/green deployment.\n*Required*: No\n*Type*: [DeploymentReadyOption](./aws-properties-codedeploy-deploymentgroup-deploymentreadyoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-deploymentreadyoption", "Required": false, "Type": "DeploymentReadyOption", "UpdateType": "Mutable" }, "GreenFleetProvisioningOption": { "MarkdownDocumentation": "`GreenFleetProvisioningOption`\n\nInformation about how instances are provisioned for a replacement environment in a\nblue/green deployment.\n*Required*: No\n*Type*: [GreenFleetProvisioningOption](./aws-properties-codedeploy-deploymentgroup-greenfleetprovisioningoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-greenfleetprovisioningoption", "Required": false, "Type": "GreenFleetProvisioningOption", "UpdateType": "Mutable" }, "TerminateBlueInstancesOnDeploymentSuccess": { "MarkdownDocumentation": "`TerminateBlueInstancesOnDeploymentSuccess`\n\nInformation about whether to terminate instances in the original fleet during a\nblue/green deployment.\n*Required*: No\n*Type*: [BlueInstanceTerminationOption](./aws-properties-codedeploy-deploymentgroup-blueinstanceterminationoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-terminateblueinstancesondeploymentsuccess", "Required": false, "Type": "BlueInstanceTerminationOption", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.BlueInstanceTerminationOption": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.BlueInstanceTerminationOption`\n\nInformation about whether instances in the original environment are terminated when a\nblue/green deployment is successful. `BlueInstanceTerminationOption` does not\napply to Lambda deployments.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-blueinstanceterminationoption.html", "Properties": { "Action": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-blueinstanceterminationoption.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-blueinstanceterminationoption-action", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "TerminationWaitTimeInMinutes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-blueinstanceterminationoption.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-blueinstanceterminationoption-terminationwaittimeinminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.Deployment": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.Deployment`\n\n`Deployment` is a property of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource that specifies an AWS CodeDeploy application\nrevision to be deployed to instances in the deployment group. If you specify an application\nrevision, your target revision is deployed as soon as the provisioning process is complete.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html", "Properties": { "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "IgnoreApplicationStopFailures": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-ignoreapplicationstopfailures", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Revision": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision", "Required": true, "Type": "RevisionLocation", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.DeploymentReadyOption": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.DeploymentReadyOption`\n\nInformation about how traffic is rerouted to instances in a replacement environment in\na blue/green deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentreadyoption.html", "Properties": { "ActionOnTimeout": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentreadyoption.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-deploymentreadyoption-actionontimeout", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "WaitTimeInMinutes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentreadyoption.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-deploymentreadyoption-waittimeinminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.DeploymentStyle": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.DeploymentStyle`\n\nInformation about the type of deployment, either in-place or blue/green, you want to\nrun and whether to route deployment traffic behind a load balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html", "Properties": { "DeploymentOption": { "MarkdownDocumentation": "`DeploymentOption`\n\nIndicates whether to route deployment traffic behind a load balancer.\n###### Note\nAn Amazon EC2Application Load Balancer or Network Load Balancer is required for an Amazon ECS\ndeployment.\n*Required*: No\n*Type*: String\n*Allowed values*: `WITH_TRAFFIC_CONTROL | WITH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WITH_TRAFFIC_CONTROL", "WITHOUT_TRAFFIC_CONTROL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymentoption", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DeploymentType": { "MarkdownDocumentation": "`DeploymentType`\n\nIndicates whether to run an in-place or blue/green deployment.\n*Required*: No\n*Type*: String\n*Allowed values*: `IN_PLACE | BLUE_GREEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IN_PLACE", "BLUE_GREEN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymenttype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.EC2TagFilter": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.EC2TagFilter`\n\nInformation about an Amazon EC2 tag filter.\nFor more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see [Tagging Instances for Deployment\nGroups in AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) in the *AWS CodeDeploy User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html", "Properties": { "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-key", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe tag filter type:\n* `KEY_ONLY`: Key only.\n* `VALUE_ONLY`: Value only.\n* `KEY_AND_VALUE`: Key and value.\n*Required*: No\n*Type*: String\n*Allowed values*: `KEY_ONLY | VALUE_ONLY | KEY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-type", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-value", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.EC2TagSet": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.EC2TagSet`\n\nThe `EC2TagSet` property type specifies information about groups of tags\napplied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. `EC2TagSet` cannot be\nused in the same template as `EC2TagFilter`.\nFor information about using tags and tag groups to help manage your Amazon EC2\ninstances and on-premises instances, see [Tagging Instances for Deployment\nGroups in AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagset.html", "Properties": { "Ec2TagSetList": { "MarkdownDocumentation": "`Ec2TagSetList`\n\nThe Amazon EC2 tags that are already applied to Amazon EC2 instances\nthat you want to include in the deployment group. CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group.\nDuplicates are not allowed.\n*Required*: No\n*Type*: Array of [EC2TagSetListObject](./aws-properties-codedeploy-deploymentgroup-ec2tagsetlistobject.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagset.html#cfn-codedeploy-deploymentgroup-ec2tagset-ec2tagsetlist", "DuplicatesAllowed": false, "ItemType": "EC2TagSetListObject", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.EC2TagSetListObject": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.EC2TagSetListObject`\n\nThe `EC2TagSet` property type specifies information about groups of tags\napplied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same template\nas EC2TagFilters.\nFor more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see [Tagging Instances for Deployment\nGroups in AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) in the *AWS CodeDeploy User\nGuide*.\n`EC2TagSet` is a property of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagsetlistobject.html", "Properties": { "Ec2TagGroup": { "MarkdownDocumentation": "`Ec2TagGroup`\n\nA list that contains other lists of Amazon EC2 instance tag groups. For an\ninstance to be included in the deployment group, it must be identified by all of the tag\ngroups in the list.\n*Required*: No\n*Type*: Array of [EC2TagFilter](./aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagsetlistobject.html#cfn-codedeploy-deploymentgroup-ec2tagsetlistobject-ec2taggroup", "DuplicatesAllowed": false, "ItemType": "EC2TagFilter", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.ECSService": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.ECSService`\n\nContains the service and cluster names used to identify an Amazon ECS\ndeployment's target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ecsservice.html", "Properties": { "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the cluster that the Amazon ECS service is associated with.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ecsservice.html#cfn-codedeploy-deploymentgroup-ecsservice-clustername", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe name of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ecsservice.html#cfn-codedeploy-deploymentgroup-ecsservice-servicename", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.ELBInfo": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.ELBInfo`\n\nThe `ELBInfo` property type specifies information about the ELB load balancer used for an CodeDeploy deployment group.\nIf you specify the `ELBInfo` property, the\n`DeploymentStyle.DeploymentOption` property must be set to\n`WITH_TRAFFIC_CONTROL` for AWS CodeDeploy to route your traffic using\nthe specified load balancers.\n`ELBInfo` is a property of the [AWS CodeDeploy DeploymentGroup LoadBalancerInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nFor blue/green deployments, the name of the load balancer that is used to route traffic\nfrom original instances to replacement instances in a blue/green deployment. For in-place\ndeployments, the name of the load balancer that instances are deregistered from so they are\nnot serving traffic during a deployment, and then re-registered with after the deployment is\ncomplete.\n###### Note\nCloudFormation supports blue/green deployments on AWS Lambda compute\nplatforms 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html#cfn-codedeploy-deploymentgroup-elbinfo-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.GitHubLocation": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.GitHubLocation`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html", "Properties": { "CommitId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation-commitid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Repository": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation-repository", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.GreenFleetProvisioningOption": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.GreenFleetProvisioningOption`\n\nInformation about the instances that belong to the replacement environment in a\nblue/green deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-greenfleetprovisioningoption.html", "Properties": { "Action": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-greenfleetprovisioningoption.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-greenfleetprovisioningoption-action", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo`\n\nThe `LoadBalancerInfo` property type specifies information about the load\nbalancer or target group used for an AWS CodeDeploy deployment group. For more\ninformation, see [Integrating\nCodeDeploy with ELB](https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-elastic-load-balancing.html) in the *AWS CodeDeploy User Guide*.\nFor CloudFormation to use the properties specified in `LoadBalancerInfo`,\nthe `DeploymentStyle.DeploymentOption` property must be set to\n`WITH_TRAFFIC_CONTROL`. If `DeploymentStyle.DeploymentOption` is not\nset to `WITH_TRAFFIC_CONTROL`, CloudFormation ignores any settings specified\nin `LoadBalancerInfo`.\n###### Note\nCloudFormation supports blue/green deployments on the AWS Lambda\ncompute platform only.\n`LoadBalancerInfo` is a property of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html", "Properties": { "ElbInfoList": { "MarkdownDocumentation": "`ElbInfoList`\n\nAn array that contains information about the load balancers to use for load balancing\nin a deployment. If you're using Classic Load Balancers, specify those load balancers in\nthis array.\n###### Note\nYou can add up to 10 load balancers to the array.\n\n###### Note\nIf you're using Application Load Balancers or Network Load Balancers, use the\n`targetGroupInfoList` array instead of this one.\n*Required*: No\n*Type*: Array of [ELBInfo](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-elbinfolist", "DuplicatesAllowed": false, "ItemType": "ELBInfo", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "TargetGroupInfoList": { "MarkdownDocumentation": "`TargetGroupInfoList`\n\nAn array that contains information about the target groups to use for load balancing\nin a deployment. If you're using Application Load Balancers and Network Load Balancers,\nspecify their associated target groups in this array.\n###### Note\nYou can add up to 10 target groups to the array.\n\n###### Note\nIf you're using Classic Load Balancers, use the `elbInfoList` array\ninstead of this one.\n*Required*: Conditional\n*Type*: Array of [TargetGroupInfo](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgroupinfolist", "DuplicatesAllowed": false, "ItemType": "TargetGroupInfo", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "TargetGroupPairInfoList": { "MarkdownDocumentation": "`TargetGroupPairInfoList`\n\nThe target group pair information. This is an array of\n`TargeGroupPairInfo` objects with a maximum size of one.\n*Required*: No\n*Type*: Array of [TargetGroupPairInfo](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgrouppairinfolist", "DuplicatesAllowed": false, "ItemType": "TargetGroupPairInfo", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet`\n\nThe `OnPremisesTagSet` property type specifies a list containing other lists of\non-premises instance tag groups. In order for an instance to be included in the deployment\ngroup, it must be identified by all the tag groups in the list.\nFor more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see [Tagging Instances for Deployment\nGroups in AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) in the *AWS CodeDeploy User\nGuide*.\n`OnPremisesTagSet` is a property of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html", "Properties": { "OnPremisesTagSetList": { "MarkdownDocumentation": "`OnPremisesTagSetList`\n\nA list that contains other lists of on-premises instance tag groups. For an instance to be\nincluded in the deployment group, it must be identified by all of the tag groups in the\nlist.\nDuplicates are not allowed.\n*Required*: No\n*Type*: Array of [OnPremisesTagSetListObject](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html#cfn-codedeploy-deploymentgroup-onpremisestagset-onpremisestagsetlist", "DuplicatesAllowed": false, "ItemType": "OnPremisesTagSetListObject", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSetListObject": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSetListObject`\n\nThe `OnPremisesTagSetListObject` property type specifies lists of on-premises\ninstance tag groups. In order for an instance to be included in the deployment group, it must\nbe identified by all the tag groups in the list.\n`OnPremisesTagSetListObject` is a property of the [CodeDeploy DeploymentGroup OnPremisesTagSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagsetlistobject.html", "Properties": { "OnPremisesTagGroup": { "MarkdownDocumentation": "`OnPremisesTagGroup`\n\nInformation about groups of on-premises instance tags.\n*Required*: No\n*Type*: Array of [TagFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagsetlistobject.html#cfn-codedeploy-deploymentgroup-onpremisestagsetlistobject-onpremisestaggroup", "DuplicatesAllowed": false, "ItemType": "TagFilter", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.RevisionLocation": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.RevisionLocation`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html", "Properties": { "GitHubLocation": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation", "Required": false, "Type": "GitHubLocation", "UpdateType": "Mutable" }, "RevisionType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-revisiontype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "S3Location": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location", "Required": false, "Type": "S3Location", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.S3Location": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.S3Location`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-bucket", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "BundleType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-bundletype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ETag": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-etag", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Key": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-key", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Version": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-value", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.TagFilter": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.TagFilter`\n\n`TagFilter` is a property type of the [AWS::CodeDeploy::DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource that specifies which on-premises\ninstances to associate with the deployment group. To register on-premise instances with\nAWS CodeDeploy, see [Configure Existing On-Premises\nInstances by Using AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-on-premises.html) in the *AWS CodeDeploy User Guide*.\nFor more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see [Tagging Instances for Deployment\nGroups in AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) in the *AWS CodeDeploy User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html", "Properties": { "Key": { "MarkdownDocumentation": "`Key`\n\nThe on-premises instance tag filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-key", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe on-premises instance tag filter type:\n* KEY\\_ONLY: Key only.\n* VALUE\\_ONLY: Value only.\n* KEY\\_AND\\_VALUE: Key and value.\n*Required*: No\n*Type*: String\n*Allowed values*: `KEY_ONLY | VALUE_ONLY | KEY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-type", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe on-premises instance tag filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-value", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo`\n\nThe `TargetGroupInfo` property type specifies information about a target group\nin ELB to use in a deployment. Instances are registered as targets in a\ntarget group, and traffic is routed to the target group. For more information, see [TargetGroupInfo](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_TargetGroupInfo.html) in the *AWS CodeDeploy API Reference*\nIf you specify the `TargetGroupInfo` property, the\n`DeploymentStyle.DeploymentOption` property must be set to\n`WITH_TRAFFIC_CONTROL` for CodeDeploy to route your traffic using the\nspecified target groups.\n`TargetGroupInfo` is a property of the [LoadBalancerInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nFor blue/green deployments, the name of the target group that instances in the original\nenvironment are deregistered from, and instances in the replacement environment registered\nwith. For in-place deployments, the name of the target group that instances are deregistered\nfrom, so they are not serving traffic during a deployment, and then re-registered with after\nthe deployment completes. No duplicates allowed.\n###### Note\nCloudFormation supports blue/green deployments on AWS Lambda compute\nplatforms only.\nThis value cannot exceed 32 characters, so you should use the `Name` property\nof the target group, or the `TargetGroupName` attribute with the\n`Fn::GetAtt` intrinsic function, as shown in the following example. Don't use the\ngroup'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html#cfn-codedeploy-deploymentgroup-targetgroupinfo-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.TargetGroupPairInfo": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.TargetGroupPairInfo`\n\nInformation about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html", "Properties": { "ProdTrafficRoute": { "MarkdownDocumentation": "`ProdTrafficRoute`\n\nThe path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.\n*Required*: No\n*Type*: [TrafficRoute](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-prodtrafficroute", "Required": false, "Type": "TrafficRoute", "UpdateType": "Mutable" }, "TargetGroups": { "MarkdownDocumentation": "`TargetGroups`\n\nOne pair of target groups. One is associated with the original task set. The second\nis associated with the task set that serves traffic after the deployment is complete.\n*Required*: No\n*Type*: Array of [TargetGroupInfo](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-targetgroups", "DuplicatesAllowed": false, "ItemType": "TargetGroupInfo", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "TestTrafficRoute": { "MarkdownDocumentation": "`TestTrafficRoute`\n\nAn 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\ndeployment.\n*Required*: No\n*Type*: [TrafficRoute](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-testtrafficroute", "Required": false, "Type": "TrafficRoute", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.TrafficRoute": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.TrafficRoute`\n\nInformation about a listener. The listener contains the path used to route traffic\nthat is received from the load balancer to a target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html", "Properties": { "ListenerArns": { "MarkdownDocumentation": "`ListenerArns`\n\nThe Amazon Resource Name (ARN) of one listener. The listener identifies the route\nbetween a target group and a load balancer. This is an array of strings with a maximum\nsize of one.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html#cfn-codedeploy-deploymentgroup-trafficroute-listenerarns", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::CodeDeploy::DeploymentGroup.TriggerConfig": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup.TriggerConfig`\n\nInformation about notification triggers for the deployment group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html", "Properties": { "TriggerEvents": { "MarkdownDocumentation": "`TriggerEvents`\n\nThe event type or types that trigger notifications.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggerevents", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "TriggerName": { "MarkdownDocumentation": "`TriggerName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggername", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "TriggerTargetArn": { "MarkdownDocumentation": "`TriggerTargetArn`\n\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through\nwhich 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggertargetarn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CodeGuruProfiler::ProfilingGroup.AgentPermissions": { "MarkdownDocumentation": "`AWS::CodeGuruProfiler::ProfilingGroup.AgentPermissions`\n\nThe `AgentPermissions` property type specifies Property description not available. for an [AWS::CodeGuruProfiler::ProfilingGroup](./aws-resource-codeguruprofiler-profilinggroup.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-agentpermissions.html", "Properties": { "Principals": { "MarkdownDocumentation": "`Principals`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-agentpermissions.html#cfn-codeguruprofiler-profilinggroup-agentpermissions-principals", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::CodeGuruProfiler::ProfilingGroup.Channel": { "MarkdownDocumentation": "`AWS::CodeGuruProfiler::ProfilingGroup.Channel`\n\nNotification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-channel.html", "Properties": { "channelUri": { "MarkdownDocumentation": "`channelUri`\n\nThe channel URI.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws([-\\w]*):[a-z-]+:(([a-z]+-)+[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-channel.html#cfn-codeguruprofiler-profilinggroup-channel-channeluri", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "channelId": { "MarkdownDocumentation": "`channelId`\n\nThe channel ID.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-channel.html#cfn-codeguruprofiler-profilinggroup-channel-channelid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodePipeline::CustomActionType.ArtifactDetails": { "MarkdownDocumentation": "`AWS::CodePipeline::CustomActionType.ArtifactDetails`\n\nReturns information about the details of an artifact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html", "Properties": { "MinimumCount": { "MarkdownDocumentation": "`MinimumCount`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-minimumcount", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "MaximumCount": { "MarkdownDocumentation": "`MaximumCount`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-maximumcount", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::CodePipeline::CustomActionType.ConfigurationProperties": { "MarkdownDocumentation": "`AWS::CodePipeline::CustomActionType.ConfigurationProperties`\n\nThe configuration properties for the custom action.\n###### Note\nYou can refer to a name in the configuration properties of the custom action\nwithin the URL templates by following the format of {Config:name}, as long as the\nconfiguration property is both required and not secret. For more information, see\n[Create a\nCustom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html", "Properties": { "Secret": { "MarkdownDocumentation": "`Secret`\n\nWhether the configuration property is secret. Secrets are hidden from all calls\nexcept for `GetJobDetails`, `GetThirdPartyJobDetails`,\n`PollForJobs`, and `PollForThirdPartyJobs`.\nWhen updating a pipeline, passing \\* \\* \\* \\* \\* without changing any other values of\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-secret", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the configuration property.\n*Required*: No\n*Type*: String\n*Allowed values*: `String | Number | Boolean...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "String", "Number", "Boolean" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the action configuration property that is displayed to\nusers.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Required": { "MarkdownDocumentation": "`Required`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-required", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "Queryable": { "MarkdownDocumentation": "`Queryable`\n\nIndicates that the property is used with `PollForJobs`. When creating a\ncustom action, an action can have up to one queryable property. If it has one, that\nproperty must be both required and not secret.\nIf you create a pipeline with a custom action type, and that custom action contains\na queryable property, the value for that configuration property is subject to other\nrestrictions. The value must be less than or equal to twenty (20) characters. The value\ncan 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Key": { "MarkdownDocumentation": "`Key`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::CustomActionType.Settings": { "MarkdownDocumentation": "`AWS::CodePipeline::CustomActionType.Settings`\n\n`Settings` is a property of the `AWS::CodePipeline::CustomActionType`\nresource that provides URLs that users can access to view information about the CodePipeline\ncustom action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html", "Properties": { "EntityUrlTemplate": { "MarkdownDocumentation": "`EntityUrlTemplate`\n\nThe URL returned to the CodePipeline console that provides a deep link to the\nresources of the external system, such as the configuration page for a CodeDeploy\ndeployment group. This link is provided as part of the action display in the\npipeline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExecutionUrlTemplate": { "MarkdownDocumentation": "`ExecutionUrlTemplate`\n\nThe URL returned to the CodePipeline console that contains a link to the\ntop-level landing page for the external system, such as the console page for CodeDeploy.\nThis link is shown on the pipeline view page in the CodePipeline console and\nprovides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RevisionUrlTemplate": { "MarkdownDocumentation": "`RevisionUrlTemplate`\n\nThe URL returned to the CodePipeline console that contains a link to the page\nwhere 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-revisionurltemplate", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ThirdPartyConfigurationUrl": { "MarkdownDocumentation": "`ThirdPartyConfigurationUrl`\n\nThe URL of a sign-up page where users can sign up for an external service and\nperform 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-thirdpartyconfigurationurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.ActionDeclaration": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.ActionDeclaration`\n\nRepresents information about an action declaration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html", "Properties": { "ActionTypeId": { "MarkdownDocumentation": "`ActionTypeId`\n\nSpecifies the action type and the provider of the action.\n*Required*: Yes\n*Type*: [ActionTypeId](./aws-properties-codepipeline-pipeline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-actiontypeid", "UpdateType": "Mutable", "Required": true, "Type": "ActionTypeId" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe action's configuration. These are key-value pairs that specify input values for\nan 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\nconfiguration 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\nUser 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\n*AWS CloudFormation User Guide*.\nThe values can be represented in either JSON or YAML format. For example, the JSON\nconfiguration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-configuration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "OutputArtifacts": { "MarkdownDocumentation": "`OutputArtifacts`\n\nThe name or ID of the result of the action declaration, such as a test or build\nartifact. While the field is not a required parameter, most actions have an action\nconfiguration that requires a specified quantity of output artifacts. To refer to the action\nconfiguration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html)\nin the *AWS CodePipeline User Guide*.\n*Required*: No\n*Type*: Array of [OutputArtifact](./aws-properties-codepipeline-pipeline-outputartifact.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-outputartifacts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OutputArtifact", "DuplicatesAllowed": false }, "OutputVariables": { "MarkdownDocumentation": "`OutputVariables`\n\nThe list of variables that are to be exported from the compute action. This is\nspecifically CodeBuild environment variables as used for that action.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-outputvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe variable namespace associated with the action. All variables produced as output by\nthis action fall under this namespace.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM service role that performs the declared action. This is assumed\nthrough the roleArn for the pipeline.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe action declaration's name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnvironmentVariables": { "MarkdownDocumentation": "`EnvironmentVariables`\n\nThe environment variables for the action.\n*Required*: No\n*Type*: Array of [EnvironmentVariable](./aws-properties-codepipeline-pipeline-environmentvariable.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-environmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentVariable", "DuplicatesAllowed": false }, "InputArtifacts": { "MarkdownDocumentation": "`InputArtifacts`\n\nThe name or ID of the artifact consumed by the action, such as a test or build\nartifact. While the field is not a required parameter, most actions have an action\nconfiguration that requires a specified quantity of input artifacts. To refer to the action\nconfiguration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html)\nin the *AWS CodePipeline User Guide*.\n###### Note\nFor a CodeBuild action with multiple input artifacts, one of your input sources must be\ndesignated the PrimarySource. For more information, see the [CodeBuild action\nreference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User\nGuide*.\n*Required*: No\n*Type*: Array of [InputArtifact](./aws-properties-codepipeline-pipeline-inputartifact.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-inputartifacts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InputArtifact", "DuplicatesAllowed": false }, "Commands": { "MarkdownDocumentation": "`Commands`\n\nThe shell commands to run with your compute action in CodePipeline. All commands\nare supported except multi-line formats. While CodeBuild logs and permissions\nare used, you do not need to create any resources in CodeBuild.\n###### Note\nUsing compute time for this action will incur separate charges in AWS CodeBuild.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-commands", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RunOrder": { "MarkdownDocumentation": "`RunOrder`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-runorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TimeoutInMinutes": { "MarkdownDocumentation": "`TimeoutInMinutes`\n\nA timeout duration in minutes that can be applied against the ActionType\u2019s default\ntimeout value specified in [Quotas for AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html). This attribute is available only to the manual approval ActionType.\n*Required*: No\n*Type*: Integer\n*Minimum*: `5`\n*Maximum*: `86400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-timeoutinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::CodePipeline::Pipeline.ActionTypeId": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.ActionTypeId`\n\nRepresents information about an action type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html", "Properties": { "Owner": { "MarkdownDocumentation": "`Owner`\n\nThe creator of the action being called. There are three valid values for the\n`Owner` field in the action category section within your pipeline\nstructure: `AWS`, `ThirdParty`, and `Custom`. For more\ninformation, see [Valid Action Types and Providers in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html#cfn-codepipeline-pipeline-actiontypeid-owner", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nA category defines what kind of action can be taken in the stage, and constrains the\nprovider type for the action. Valid categories are limited to one of the values\nbelow.\n* `Source`\n* `Build`\n* `Test`\n* `Deploy`\n* `Invoke`\n* `Approval`\n* `Compute`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Source | Build | Test | Dep...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Source", "Build", "Test", "Deploy", "Invoke", "Approval", "Compute" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html#cfn-codepipeline-pipeline-actiontypeid-category", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nA string that describes the action 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html#cfn-codepipeline-pipeline-actiontypeid-version", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Provider": { "MarkdownDocumentation": "`Provider`\n\nThe provider of the service being called by the action. Valid providers are\ndetermined by the action category. For example, an action in the Deploy category type\nmight have a provider of CodeDeploy, which would be specified as\n`CodeDeploy`. For more information, see [Valid Action Types and Providers in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html#cfn-codepipeline-pipeline-actiontypeid-provider", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.ArtifactStore": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.ArtifactStore`\n\nThe S3 bucket where artifacts for the pipeline are stored.\n###### Note\nYou must include either `artifactStore` or\n`artifactStores` in your pipeline, but you cannot use both. If you\ncreate a cross-region action in your pipeline, you must use\n`artifactStores`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the artifact store, such as S3.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `S3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "S3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EncryptionKey": { "MarkdownDocumentation": "`EncryptionKey`\n\nThe encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined,\nthe default key for Amazon S3 is used. To see an example artifact store encryption key field,\nsee the example structure here: [AWS::CodePipeline::Pipeline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html).\n*Required*: No\n*Type*: [EncryptionKey](./aws-properties-codepipeline-pipeline-encryptionkey.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionKey" }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe S3 bucket used for storing the artifacts for a pipeline. You can specify the\nname of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline\nartifacts is created for you based on the name of the pipeline. You can use any S3\nbucket in the same AWS Region as the pipeline to store your pipeline\nartifacts.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\-\\.]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.ArtifactStoreMap": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.ArtifactStoreMap`\n\nA mapping of `artifactStore` objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for\neach cross-region action in the pipeline.\n###### Note\nYou must include either `artifactStore` or\n`artifactStores` in your pipeline, but you cannot use both. If you\ncreate a cross-region action in your pipeline, you must use\n`artifactStores`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html", "Properties": { "ArtifactStore": { "MarkdownDocumentation": "`ArtifactStore`\n\nRepresents information about the S3 bucket where artifacts are stored for the\npipeline.\n###### Note\nYou must include either `artifactStore` or\n`artifactStores` in your pipeline, but you cannot use both. If you\ncreate a cross-region action in your pipeline, you must use\n`artifactStores`.\n*Required*: Conditional\n*Type*: [ArtifactStore](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-artifactstore", "UpdateType": "Mutable", "Required": true, "Type": "ArtifactStore" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe action declaration's AWS Region, such as us-east-1.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.BeforeEntryConditions": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.BeforeEntryConditions`\n\nThe conditions for making checks for entry to a stage. For more information about\nconditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html)\nand [How do\nstage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-beforeentryconditions.html", "Properties": { "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe conditions that are configured as entry conditions.\n*Required*: No\n*Type*: Array of [Condition](./aws-properties-codepipeline-pipeline-condition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-beforeentryconditions.html#cfn-codepipeline-pipeline-beforeentryconditions-conditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Condition", "DuplicatesAllowed": false } } }, "AWS::CodePipeline::Pipeline.BlockerDeclaration": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.BlockerDeclaration`\n\nReserved for future use.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-blockerdeclaration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nReserved 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)\n", "RefReturnValue": "", "AllowedValues": [ "Schedule" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-blockerdeclaration.html#cfn-codepipeline-pipeline-blockerdeclaration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nReserved for future use.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-blockerdeclaration.html#cfn-codepipeline-pipeline-blockerdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.Condition": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.Condition`\n\nThe condition for the stage. A condition is made up of the rules and the result for\nthe condition. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html)\nand [How do\nstage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html).. For more information about rules, see the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-condition.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe rules that make up the condition.\n*Required*: No\n*Type*: Array of [RuleDeclaration](./aws-properties-codepipeline-pipeline-ruledeclaration.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-condition.html#cfn-codepipeline-pipeline-condition-rules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RuleDeclaration", "DuplicatesAllowed": false }, "Result": { "MarkdownDocumentation": "`Result`\n\nThe action to be done when the condition is met. For example, rolling back an\nexecution for a failure condition.\n*Required*: No\n*Type*: String\n*Allowed values*: `ROLLBACK | FAIL | RETRY | S...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROLLBACK", "FAIL", "RETRY", "SKIP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-condition.html#cfn-codepipeline-pipeline-condition-result", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.EncryptionKey": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.EncryptionKey`\n\nRepresents information about the key used to encrypt data in the artifact store, such\nas an AWS Key Management Service (AWS KMS) key.\n`EncryptionKey` is a property of the [ArtifactStore](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-encryptionkey.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of encryption key, such as an AWS KMS key. When creating or\nupdating 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-encryptionkey.html#cfn-codepipeline-pipeline-encryptionkey-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID used to identify the key. For an AWS KMS key, you can use the\nkey ID, the key ARN, or the alias ARN.\n###### Note\nAliases are recognized only in the account that created the AWS KMS\nkey. For cross-account actions, you can only use the key ID or key ARN to identify\nthe key. Cross-account actions involve using the role from the other account\n(AccountB), so specifying the key ID will use the key from the other account\n(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-encryptionkey.html#cfn-codepipeline-pipeline-encryptionkey-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.EnvironmentVariable": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.EnvironmentVariable`\n\nThe environment variables for the action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-environmentvariable.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of use for the environment variable value. The value can be either\n`PLAINTEXT` or `SECRETS_MANAGER`. If the value is `SECRETS_MANAGER`, provide the Secrets\nreference in the EnvironmentVariable value.\n*Required*: No\n*Type*: String\n*Allowed values*: `PLAINTEXT | SECRETS_MANAGER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PLAINTEXT", "SECRETS_MANAGER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-environmentvariable.html#cfn-codepipeline-pipeline-environmentvariable-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe environment variable value in the key-value pair.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-environmentvariable.html#cfn-codepipeline-pipeline-environmentvariable-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe environment variable name in the key-value pair.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-environmentvariable.html#cfn-codepipeline-pipeline-environmentvariable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.FailureConditions": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.FailureConditions`\n\nThe configuration that specifies the result, such as rollback, to occur upon stage\nfailure. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html)\nand [How do\nstage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-failureconditions.html", "Properties": { "RetryConfiguration": { "MarkdownDocumentation": "`RetryConfiguration`\n\nThe retry configuration specifies automatic retry for a failed stage, along with the\nconfigured retry mode.\n*Required*: No\n*Type*: [RetryConfiguration](./aws-properties-codepipeline-pipeline-retryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-failureconditions.html#cfn-codepipeline-pipeline-failureconditions-retryconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RetryConfiguration" }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe conditions that are configured as failure conditions. For more information about\nconditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html)\nand [How do\nstage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html).\n*Required*: No\n*Type*: Array of [Condition](./aws-properties-codepipeline-pipeline-condition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-failureconditions.html#cfn-codepipeline-pipeline-failureconditions-conditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Condition", "DuplicatesAllowed": false }, "Result": { "MarkdownDocumentation": "`Result`\n\nThe specified result for when the failure conditions are met, such as rolling back the\nstage.\n*Required*: No\n*Type*: String\n*Allowed values*: `ROLLBACK | RETRY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROLLBACK", "RETRY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-failureconditions.html#cfn-codepipeline-pipeline-failureconditions-result", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.GitBranchFilterCriteria": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.GitBranchFilterCriteria`\n\nThe Git repository branches specified as filter criteria to start the\npipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html", "Properties": { "Includes": { "MarkdownDocumentation": "`Includes`\n\nThe list of patterns of Git branches that, when a commit is pushed, are to be\nincluded as criteria that starts the pipeline.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html#cfn-codepipeline-pipeline-gitbranchfiltercriteria-includes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Excludes": { "MarkdownDocumentation": "`Excludes`\n\nThe list of patterns of Git branches that, when a commit is pushed, are to be\nexcluded from starting the pipeline.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html#cfn-codepipeline-pipeline-gitbranchfiltercriteria-excludes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CodePipeline::Pipeline.GitConfiguration": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.GitConfiguration`\n\nA type of trigger configuration for Git-based source actions.\n###### Note\nYou can specify the Git configuration trigger type for all third-party\nGit-based source actions that are supported by the\n`CodeStarSourceConnection` action type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html", "Properties": { "PullRequest": { "MarkdownDocumentation": "`PullRequest`\n\nThe field where the repository event that will start the pipeline is specified as\npull requests.\n*Required*: No\n*Type*: Array of [GitPullRequestFilter](./aws-properties-codepipeline-pipeline-gitpullrequestfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-pullrequest", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GitPullRequestFilter", "DuplicatesAllowed": false }, "Push": { "MarkdownDocumentation": "`Push`\n\nThe field where the repository event that will start the pipeline, such as pushing\nGit tags, is specified with details.\n*Required*: No\n*Type*: Array of [GitPushFilter](./aws-properties-codepipeline-pipeline-gitpushfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-push", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GitPushFilter", "DuplicatesAllowed": false }, "SourceActionName": { "MarkdownDocumentation": "`SourceActionName`\n\nThe name of the pipeline source action where the trigger configuration, such as Git\ntags, is specified. The trigger configuration will start the pipeline upon the specified\nchange only.\n###### Note\nYou can only specify one trigger configuration per source action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-sourceactionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.GitFilePathFilterCriteria": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.GitFilePathFilterCriteria`\n\nThe Git repository file paths specified as filter criteria to start the\npipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html", "Properties": { "Includes": { "MarkdownDocumentation": "`Includes`\n\nThe list of patterns of Git repository file paths that, when a commit is pushed,\nare to be included as criteria that starts the pipeline.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html#cfn-codepipeline-pipeline-gitfilepathfiltercriteria-includes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Excludes": { "MarkdownDocumentation": "`Excludes`\n\nThe list of patterns of Git repository file paths that, when a commit is pushed,\nare to be excluded from starting the pipeline.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html#cfn-codepipeline-pipeline-gitfilepathfiltercriteria-excludes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CodePipeline::Pipeline.GitPullRequestFilter": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.GitPullRequestFilter`\n\nThe event criteria for the pull request trigger configuration, such as the lists of\nbranches or file paths to include and exclude.\nThe following are valid values for the events for this filter:\n* CLOSED\n* OPEN\n* UPDATED\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpullrequestfilter.html", "Properties": { "FilePaths": { "MarkdownDocumentation": "`FilePaths`\n\nThe field that specifies to filter on file paths for the pull request trigger\nconfiguration.\n*Required*: No\n*Type*: [GitFilePathFilterCriteria](./aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpullrequestfilter.html#cfn-codepipeline-pipeline-gitpullrequestfilter-filepaths", "UpdateType": "Mutable", "Required": false, "Type": "GitFilePathFilterCriteria" }, "Events": { "MarkdownDocumentation": "`Events`\n\nThe field that specifies which pull request events to filter on (OPEN, UPDATED,\nCLOSED) for the trigger configuration.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpullrequestfilter.html#cfn-codepipeline-pipeline-gitpullrequestfilter-events", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Branches": { "MarkdownDocumentation": "`Branches`\n\nThe field that specifies to filter on branches for the pull request trigger\nconfiguration.\n*Required*: No\n*Type*: [GitBranchFilterCriteria](./aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpullrequestfilter.html#cfn-codepipeline-pipeline-gitpullrequestfilter-branches", "UpdateType": "Mutable", "Required": false, "Type": "GitBranchFilterCriteria" } } }, "AWS::CodePipeline::Pipeline.GitPushFilter": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.GitPushFilter`\n\nThe event criteria that specify when a specified repository event will start the\npipeline for the specified trigger configuration, such as the lists of Git tags to\ninclude and exclude.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html", "Properties": { "FilePaths": { "MarkdownDocumentation": "`FilePaths`\n\nThe field that specifies to filter on file paths for the push trigger\nconfiguration.\n*Required*: No\n*Type*: [GitFilePathFilterCriteria](./aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html#cfn-codepipeline-pipeline-gitpushfilter-filepaths", "UpdateType": "Mutable", "Required": false, "Type": "GitFilePathFilterCriteria" }, "Branches": { "MarkdownDocumentation": "`Branches`\n\nThe field that specifies to filter on branches for the push trigger\nconfiguration.\n*Required*: No\n*Type*: [GitBranchFilterCriteria](./aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html#cfn-codepipeline-pipeline-gitpushfilter-branches", "UpdateType": "Mutable", "Required": false, "Type": "GitBranchFilterCriteria" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe field that contains the details for the Git tags trigger\nconfiguration.\n*Required*: No\n*Type*: [GitTagFilterCriteria](./aws-properties-codepipeline-pipeline-gittagfiltercriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html#cfn-codepipeline-pipeline-gitpushfilter-tags", "UpdateType": "Mutable", "Required": false, "Type": "GitTagFilterCriteria" } } }, "AWS::CodePipeline::Pipeline.GitTagFilterCriteria": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.GitTagFilterCriteria`\n\nThe Git tags specified as filter criteria for whether a Git tag repository event\nwill start the pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gittagfiltercriteria.html", "Properties": { "Includes": { "MarkdownDocumentation": "`Includes`\n\nThe list of patterns of Git tags that, when pushed, are to be included as criteria\nthat starts the pipeline.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gittagfiltercriteria.html#cfn-codepipeline-pipeline-gittagfiltercriteria-includes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Excludes": { "MarkdownDocumentation": "`Excludes`\n\nThe list of patterns of Git tags that, when pushed, are to be excluded from\nstarting the pipeline.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gittagfiltercriteria.html#cfn-codepipeline-pipeline-gittagfiltercriteria-excludes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::CodePipeline::Pipeline.InputArtifact": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.InputArtifact`\n\nRepresents information about an artifact to be worked on, such as a test or build\nartifact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-inputartifact.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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\naction configuration for each action for details about artifact parameters. For example,\nthe S3 source action input artifact is a file name (or file path), and the files are\ngenerally 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\na preceding action, but the input artifact does not have to be the next action in strict\nsequence from the action that provided the output artifact. Actions in parallel can\ndeclare different output artifacts, which are in turn consumed by different following\nactions.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-inputartifact.html#cfn-codepipeline-pipeline-inputartifact-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.OutputArtifact": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.OutputArtifact`\n\nRepresents information about the output of an action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-outputartifact.html", "Properties": { "Files": { "MarkdownDocumentation": "`Files`\n\nThe files that you want to associate with the output artifact that will be exported\nfrom the compute action.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-outputartifact.html#cfn-codepipeline-pipeline-outputartifact-files", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the output of an artifact, such as \"My App\".\nThe output artifact name must exactly match the input artifact declared for a\ndownstream action. However, the downstream action's input artifact does not have to be the\nnext action in strict sequence from the action that provided the output artifact. Actions in\nparallel can declare different output artifacts, which are in turn consumed by different\nfollowing actions.\nOutput artifact names must be unique within a pipeline.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-outputartifact.html#cfn-codepipeline-pipeline-outputartifact-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.PipelineTriggerDeclaration": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.PipelineTriggerDeclaration`\n\nRepresents information about the specified trigger configuration, such as the\nfilter criteria and the source stage for the action that contains the trigger.\n###### Note\nThis is only supported for the `CodeStarSourceConnection` action\ntype.\n###### Note\nWhen a trigger configuration is specified, default change detection for\nrepository and branch commits is disabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-pipelinetriggerdeclaration.html", "Properties": { "GitConfiguration": { "MarkdownDocumentation": "`GitConfiguration`\n\nProvides the filter criteria and the source stage for the repository event that\nstarts the pipeline, such as Git tags.\n*Required*: No\n*Type*: [GitConfiguration](./aws-properties-codepipeline-pipeline-gitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-pipelinetriggerdeclaration.html#cfn-codepipeline-pipeline-pipelinetriggerdeclaration-gitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GitConfiguration" }, "ProviderType": { "MarkdownDocumentation": "`ProviderType`\n\nThe source provider for the event, such as connections configured for a repository\nwith Git tags, for the specified trigger configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CodeStarSourceConnection...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CodeStarSourceConnection" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-pipelinetriggerdeclaration.html#cfn-codepipeline-pipeline-pipelinetriggerdeclaration-providertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.RetryConfiguration": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.RetryConfiguration`\n\nThe retry configuration specifies automatic retry for a failed stage, along with the\nconfigured retry mode.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-retryconfiguration.html", "Properties": { "RetryMode": { "MarkdownDocumentation": "`RetryMode`\n\nThe method that you want to configure for automatic stage retry on stage failure. You\ncan specify to retry only failed action in the stage or all actions in the stage.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_ACTIONS | FAILED_ACTION...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_ACTIONS", "FAILED_ACTIONS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-retryconfiguration.html#cfn-codepipeline-pipeline-retryconfiguration-retrymode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.RuleDeclaration": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.RuleDeclaration`\n\nRepresents information about the rule to be created for an associated condition. An\nexample would be creating a new rule for an entry condition, such as a rule that checks\nfor a test result before allowing the run to enter the deployment stage. For more\ninformation about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html)\nand [How do\nstage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html). For more information about rules, see the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html", "Properties": { "RuleTypeId": { "MarkdownDocumentation": "`RuleTypeId`\n\nThe ID for the rule type, which is made up of the combined values for category, owner,\nprovider, and version.\n*Required*: No\n*Type*: [RuleTypeId](./aws-properties-codepipeline-pipeline-ruletypeid.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-ruletypeid", "UpdateType": "Mutable", "Required": false, "Type": "RuleTypeId" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe action configuration fields for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-configuration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "InputArtifacts": { "MarkdownDocumentation": "`InputArtifacts`\n\nThe input artifacts fields for the rule, such as specifying an input file for the\nrule.\n*Required*: No\n*Type*: Array of [InputArtifact](./aws-properties-codepipeline-pipeline-inputartifact.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-inputartifacts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InputArtifact", "DuplicatesAllowed": false }, "Commands": { "MarkdownDocumentation": "`Commands`\n\nThe shell commands to run with your commands rule in CodePipeline. All commands\nare supported except multi-line formats. While CodeBuild logs and permissions\nare used, you do not need to create any resources in CodeBuild.\n###### Note\nUsing compute time for this action will incur separate charges in AWS CodeBuild.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-commands", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe Region for the condition associated with the rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe pipeline role ARN associated with the rule.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule that is created for the condition, such as\n`VariableCheck`.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.RuleTypeId": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.RuleTypeId`\n\nThe ID for the rule type, which is made up of the combined values for category, owner,\nprovider, and version. For more information about conditions, see [Stage\nconditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html). For more information about rules, see the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html", "Properties": { "Owner": { "MarkdownDocumentation": "`Owner`\n\nThe creator of the rule being called. The valid value for the `Owner` field\nin the rule category is `AWS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `AWS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "AWS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-owner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nA category defines what kind of rule can be run in the stage, and constrains the\nprovider type for the rule. The valid category is `Rule`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Rule`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "Rule" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-category", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nA string that describes the rule version.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9A-Za-z_-]+`\n*Minimum*: `1`\n*Maximum*: `9`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Provider": { "MarkdownDocumentation": "`Provider`\n\nThe rule provider, such as the `DeploymentWindow` rule. For a list of rule\nprovider names, see the rules listed in the [AWS CodePipeline rule\nreference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9A-Za-z_-]+`\n*Minimum*: `1`\n*Maximum*: `35`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-provider", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.StageDeclaration": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.StageDeclaration`\n\nRepresents information about a stage and its definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html", "Properties": { "Blockers": { "MarkdownDocumentation": "`Blockers`\n\nReserved for future use.\n*Required*: No\n*Type*: Array of [BlockerDeclaration](./aws-properties-codepipeline-pipeline-blockerdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-blockers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BlockerDeclaration", "DuplicatesAllowed": false }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions included in a stage.\n*Required*: Yes\n*Type*: Array of [ActionDeclaration](./aws-properties-codepipeline-pipeline-actiondeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ActionDeclaration", "DuplicatesAllowed": false }, "BeforeEntry": { "MarkdownDocumentation": "`BeforeEntry`\n\nThe method to use when a stage allows entry. For example, configuring this field for\nconditions will allow entry to the stage when the conditions are met.\n*Required*: No\n*Type*: [BeforeEntryConditions](./aws-properties-codepipeline-pipeline-beforeentryconditions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-beforeentry", "UpdateType": "Mutable", "Required": false, "Type": "BeforeEntryConditions" }, "OnSuccess": { "MarkdownDocumentation": "`OnSuccess`\n\nThe method to use when a stage has succeeded. For example, configuring this field for\nconditions will allow the stage to succeed when the conditions are met.\n*Required*: No\n*Type*: [SuccessConditions](./aws-properties-codepipeline-pipeline-successconditions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-onsuccess", "UpdateType": "Mutable", "Required": false, "Type": "SuccessConditions" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the stage.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OnFailure": { "MarkdownDocumentation": "`OnFailure`\n\nThe method to use when a stage has not completed successfully. For example,\nconfiguring this field for rollback will roll back a failed stage automatically to the\nlast successful pipeline execution in the stage.\n*Required*: No\n*Type*: [FailureConditions](./aws-properties-codepipeline-pipeline-failureconditions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-onfailure", "UpdateType": "Mutable", "Required": false, "Type": "FailureConditions" } } }, "AWS::CodePipeline::Pipeline.StageTransition": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.StageTransition`\n\nThe name of the pipeline in which you want to disable the flow of artifacts from\none stage to another.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.html", "Properties": { "StageName": { "MarkdownDocumentation": "`StageName`\n\nThe name of the stage where you want to disable the inbound or outbound transition\nof artifacts.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.html#cfn-codepipeline-pipeline-stagetransition-stagename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Reason": { "MarkdownDocumentation": "`Reason`\n\nThe reason given to the user that a stage is disabled, such as waiting for manual\napproval or manual tests. This message is displayed in the pipeline console\nUI.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9!@ \\(\\)\\.\\*\\?\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.html#cfn-codepipeline-pipeline-stagetransition-reason", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline.SuccessConditions": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.SuccessConditions`\n\nThe conditions for making checks that, if met, succeed a stage. For more information\nabout conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html)\nand [How do\nstage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-successconditions.html", "Properties": { "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe conditions that are success conditions.\n*Required*: No\n*Type*: Array of [Condition](./aws-properties-codepipeline-pipeline-condition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-successconditions.html#cfn-codepipeline-pipeline-successconditions-conditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Condition", "DuplicatesAllowed": false } } }, "AWS::CodePipeline::Pipeline.VariableDeclaration": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline.VariableDeclaration`\n\nA variable declared at the pipeline level.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe value of a pipeline-level variable.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of a pipeline-level variable. It's used to add additional context\nabout the variable, and not being used at time when pipeline executes.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a pipeline-level variable.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Webhook.WebhookAuthConfiguration": { "MarkdownDocumentation": "`AWS::CodePipeline::Webhook.WebhookAuthConfiguration`\n\nThe authentication applied to incoming webhook trigger requests.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html", "Properties": { "AllowedIPRange": { "MarkdownDocumentation": "`AllowedIPRange`\n\nThe property used to configure acceptance of webhooks in an IP address range. For\nIP, only the `AllowedIPRange` property must be set. This property must be set\nto a valid CIDR range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-allowediprange", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecretToken": { "MarkdownDocumentation": "`SecretToken`\n\nThe property used to configure GitHub authentication. For GITHUB\\_HMAC, only the\n`SecretToken` property must be set.\n###### Important\nWhen creating CodePipeline webhooks, do not use your own credentials or\nreuse the same secret token across multiple webhooks. For optimal security, generate\na unique secret token for each webhook you create. The secret token is an arbitrary\nstring that you provide, which GitHub uses to compute and sign the webhook payloads\nsent to CodePipeline, for protecting the integrity and authenticity of the\nwebhook payloads. Using your own credentials or reusing the same token across\nmultiple webhooks can lead to security vulnerabilities.\n\n###### Note\nIf a secret token was provided, it will be redacted in the response.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-secrettoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Webhook.WebhookFilterRule": { "MarkdownDocumentation": "`AWS::CodePipeline::Webhook.WebhookFilterRule`\n\nThe event criteria that specify when a webhook notification is sent to your\nURL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html", "Properties": { "JsonPath": { "MarkdownDocumentation": "`JsonPath`\n\nA JsonPath expression that is applied to the body/payload of the webhook. The value\nselected by the JsonPath expression must match the value specified in the\n`MatchEquals` field. Otherwise, the request is ignored. For more\ninformation, see [Java JsonPath\nimplementation](https://github.com/json-path/JsonPath) in GitHub.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-jsonpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchEquals": { "MarkdownDocumentation": "`MatchEquals`\n\nThe value selected by the `JsonPath` expression must match what is\nsupplied in the `MatchEquals` field. Otherwise, the request is ignored.\nProperties from the target action configuration can be included as placeholders in this\nvalue by surrounding the action configuration key with curly brackets. For example, if\nthe value supplied here is \"refs/heads/{Branch}\" and the target action has an action\nconfiguration property called \"Branch\" with a value of \"main\", the\n`MatchEquals` value is evaluated as \"refs/heads/main\". For a list of\naction configuration properties for built-in action types, see [Pipeline Structure Reference Action Requirements](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements).\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-matchequals", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CodeStar::GitHubRepository.Code": { "MarkdownDocumentation": "`AWS::CodeStar::GitHubRepository.Code`\n\nThe `Code` property type specifies information about code to be\ncommitted.\n`Code` is a property of the `AWS::CodeStar::GitHubRepository`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-code.html", "Properties": { "S3": { "Type": "S3", "Required": true, "MarkdownDocumentation": "`S3`\n\nInformation about the Amazon S3 bucket that contains a ZIP file of code to be\ncommitted to the repository.\n*Required*: Yes\n*Type*: [S3](./aws-properties-codestar-githubrepository-s3.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-code.html#cfn-codestar-githubrepository-code-s3", "UpdateType": "Mutable" } } }, "AWS::CodeStar::GitHubRepository.S3": { "MarkdownDocumentation": "`AWS::CodeStar::GitHubRepository.S3`\n\nThe `S3` property type specifies information about the Amazon S3 bucket\nthat contains the code to be committed to the new repository.\n`S3` is a property of the `AWS::CodeStar::GitHubRepository`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html", "Properties": { "ObjectVersion": { "Required": false, "MarkdownDocumentation": "`ObjectVersion`\n\nThe object version of the ZIP file, if versioning is enabled for the Amazon S3\nbucket.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-objectversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Bucket": { "Required": true, "MarkdownDocumentation": "`Bucket`\n\nThe name of the Amazon S3 bucket that contains the ZIP file with the content to be\ncommitted to the new repository.\n*Required*: Yes\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-bucket", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Key": { "Required": true, "MarkdownDocumentation": "`Key`\n\nThe S3 object key or file name for the ZIP file.\n*Required*: Yes\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeStarNotifications::NotificationRule.Target": { "MarkdownDocumentation": "`AWS::CodeStarNotifications::NotificationRule.Target`\n\nInformation about the Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients associated with a notification rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html", "Properties": { "TargetType": { "MarkdownDocumentation": "`TargetType`\n\nThe target type. Can be an Amazon Simple Notification Service topic or Amazon Q Developer in chat applications client.\n* Amazon Simple Notification Service topics are specified as `SNS`.\n* Amazon Q Developer in chat applications clients are specified as `AWSChatbotSlack`.\n* Amazon Q Developer in chat applications clients for Microsoft Teams are specified as `AWSChatbotMicrosoftTeams`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html#cfn-codestarnotifications-notificationrule-target-targettype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetAddress": { "MarkdownDocumentation": "`TargetAddress`\n\nThe Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html#cfn-codestarnotifications-notificationrule-target-targetaddress", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::IdentityPool.CognitoIdentityProvider": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPool.CognitoIdentityProvider`\n\n`CognitoIdentityProvider` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that represents an Amazon Cognito user\npool and its client ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html", "Properties": { "ServerSideTokenCheck": { "MarkdownDocumentation": "`ServerSideTokenCheck`\n\nTRUE if server-side token validation is enabled for the identity provider\u2019s\ntoken.\nAfter you set the `ServerSideTokenCheck` to TRUE for an identity pool, that\nidentity pool checks with the integrated user pools to make sure the user has not been\nglobally signed out or deleted before the identity pool provides an OIDC token or\nAWS credentials for the user.\nIf the user is signed out or deleted, the identity pool returns a 400 Not Authorized\nerror.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-serversidetokencheck", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ProviderName": { "MarkdownDocumentation": "`ProviderName`\n\nThe provider name for an Amazon Cognito user pool. For example:\n`cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-providername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe client ID for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-clientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::IdentityPool.CognitoStreams": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPool.CognitoStreams`\n\n`CognitoStreams` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that defines configuration options for\nAmazon Cognito streams.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html", "Properties": { "StreamingStatus": { "MarkdownDocumentation": "`StreamingStatus`\n\nStatus of the Amazon Cognito streams. Valid values are: `ENABLED` or\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamingstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StreamName": { "MarkdownDocumentation": "`StreamName`\n\nThe name of the Amazon Cognito stream to receive updates. This stream must be in the\ndeveloper's account and in the same Region as the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the\nstream. This role must grant access to Amazon Cognito (cognito-sync) to invoke\n`PutRecord` on your Amazon Cognito 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::IdentityPool.PushSync": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPool.PushSync`\n\n`PushSync` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that defines the configuration options\nto be applied to an Amazon Cognito identity pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html", "Properties": { "ApplicationArns": { "MarkdownDocumentation": "`ApplicationArns`\n\nThe ARNs of the Amazon SNS platform applications that could be used by clients.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-applicationarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nAn IAM role configured to allow Amazon Cognito to call Amazon SNS on behalf of the\ndeveloper.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::IdentityPoolRoleAttachment.MappingRule": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPoolRoleAttachment.MappingRule`\n\nDefines how to map a claim to a role ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html", "Properties": { "MatchType": { "MarkdownDocumentation": "`MatchType`\n\nThe match condition that specifies how closely the claim value in the IdP token must\nmatch `Value`.\nValid values are: `Equals`, `Contains`, `StartsWith`,\nand `NotEqual`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-matchtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA brief string that the claim must match. For example, \"paid\" or \"yes\".\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Claim": { "MarkdownDocumentation": "`Claim`\n\nThe claim name that must be present in the token. For example: \"isAdmin\" or\n\"paid\".\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe Amazon Resource Name (ARN) of the role.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping`\n\nOne of a set of `RoleMappings`, a property of the [AWS::Cognito::IdentityPoolRoleAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html) resource that defines the\nrole-mapping attributes of an Amazon Cognito identity pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe role mapping type. Token will use `cognito:roles` and\n`cognito:preferred_role` claims from the Cognito identity provider token\nto map groups to roles. Rules will attempt to match claims from the token to map to a\nrole.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AmbiguousRoleResolution": { "MarkdownDocumentation": "`AmbiguousRoleResolution`\n\nIf you specify Token or Rules as the `Type`,\n`AmbiguousRoleResolution` is required.\nSpecifies the action to be taken if either no rules match the claim value for the\n`Rules` type, or there is no `cognito:preferred_role` claim\nand there are multiple `cognito:roles` matches for the `Token`\ntype.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-ambiguousroleresolution", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RulesConfiguration": { "MarkdownDocumentation": "`RulesConfiguration`\n\nThe rules to be used for mapping users to roles. If you specify \"Rules\" as the\nrole-mapping type, RulesConfiguration is required.\n*Required*: No\n*Type*: [RulesConfigurationType](./aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-rulesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RulesConfigurationType" }, "IdentityProvider": { "MarkdownDocumentation": "`IdentityProvider`\n\nIdentifier for the identity provider for which the role is mapped. For example:\n`graph.facebook.com` or\n`cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\n(http://cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id)`.\nThis is the identity provider that is used by the user for authentication.\nIf the identity provider property isn't provided, the key of the entry in the\n`RoleMappings` map is used as the identity 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-identityprovider", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::IdentityPoolRoleAttachment.RulesConfigurationType": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPoolRoleAttachment.RulesConfigurationType`\n\n`RulesConfigurationType` is a subproperty of the [RoleMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html) property that defines the rules to be used for mapping users to\nroles.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe rules. You can specify up to 25 rules per identity provider.\n*Required*: Yes\n*Type*: Array of [MappingRule](./aws-properties-cognito-identitypoolroleattachment-mappingrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html#cfn-cognito-identitypoolroleattachment-rulesconfigurationtype-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MappingRule", "DuplicatesAllowed": true } } }, "AWS::Cognito::LogDeliveryConfiguration.CloudWatchLogsConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::LogDeliveryConfiguration.CloudWatchLogsConfiguration`\n\nConfiguration for the CloudWatch log group destination of user pool detailed activity\nlogging, or of user activity log export with advanced security features.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration.html", "Properties": { "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs.\nThe log group must not be encrypted with AWS Key Management Service and must be in the same AWS account\nas your user pool.\nTo send logs to log groups with a resource policy of a size greater than 5120\ncharacters, configure a log group with a path that starts with\n`/aws/vendedlogs`. For more information, see [Enabling\nlogging from certain AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration.html#cfn-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration-loggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::LogDeliveryConfiguration.FirehoseConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::LogDeliveryConfiguration.FirehoseConfiguration`\n\nConfiguration for the Amazon Data Firehose stream destination of user activity log export with\nthreat protection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html", "Properties": { "StreamArn": { "MarkdownDocumentation": "`StreamArn`\n\nThe ARN of an Amazon Data Firehose stream that's the destination for threat protection log\nexport.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html#cfn-cognito-logdeliveryconfiguration-firehoseconfiguration-streamarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::LogDeliveryConfiguration.LogConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::LogDeliveryConfiguration.LogConfiguration`\n\nThe configuration of user event logs to an external AWS service like\nAmazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html", "Properties": { "FirehoseConfiguration": { "MarkdownDocumentation": "`FirehoseConfiguration`\n\nConfiguration for the Amazon Data Firehose stream destination of user activity log export with\nthreat protection.\n*Required*: No\n*Type*: [FirehoseConfiguration](./aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-firehoseconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FirehoseConfiguration" }, "EventSource": { "MarkdownDocumentation": "`EventSource`\n\nThe source of events that your user pool sends for logging. To send error-level logs\nabout user notification activity, set to `userNotification`. To send\ninfo-level logs about threat-protection user activity in user pools with the Plus\nfeature plan, set to `userAuthEvents`.\n*Required*: No\n*Type*: String\n*Allowed values*: `userNotification | userAuth...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "userNotification", "userAuthEvents" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-eventsource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nConfiguration for the Amazon S3 bucket destination of user activity log export with threat\nprotection.\n*Required*: No\n*Type*: [S3Configuration](./aws-properties-cognito-logdeliveryconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-s3configuration", "UpdateType": "Mutable", "Required": false, "Type": "S3Configuration" }, "CloudWatchLogsConfiguration": { "MarkdownDocumentation": "`CloudWatchLogsConfiguration`\n\nConfiguration for the CloudWatch log group destination of user pool detailed activity\nlogging, or of user activity log export with advanced security features.\n*Required*: No\n*Type*: [CloudWatchLogsConfiguration](./aws-properties-cognito-logdeliveryconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLogsConfiguration" }, "LogLevel": { "MarkdownDocumentation": "`LogLevel`\n\nThe `errorlevel` selection of logs that a user pool sends for detailed\nactivity logging. To send `userNotification` activity with [information\nabout message delivery](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html), choose `ERROR` with\n`CloudWatchLogsConfiguration`. To send `userAuthEvents`\nactivity with user logs from threat protection with the Plus feature plan, choose\n`INFO` with one of `CloudWatchLogsConfiguration`,\n`FirehoseConfiguration`, or `S3Configuration`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ERROR | INFO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ERROR", "INFO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-loglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::LogDeliveryConfiguration.S3Configuration": { "MarkdownDocumentation": "`AWS::Cognito::LogDeliveryConfiguration.S3Configuration`\n\nConfiguration for the Amazon S3 bucket destination of user activity log export with threat\nprotection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-s3configuration.html", "Properties": { "BucketArn": { "MarkdownDocumentation": "`BucketArn`\n\nThe ARN of an Amazon S3 bucket that's the destination for threat protection log\nexport.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:::[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-s3configuration.html#cfn-cognito-logdeliveryconfiguration-s3configuration-bucketarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::ManagedLoginBranding.AssetType": { "MarkdownDocumentation": "`AWS::Cognito::ManagedLoginBranding.AssetType`\n\nAn image file from a managed login branding style in a user pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html", "Properties": { "Extension": { "MarkdownDocumentation": "`Extension`\n\nThe file type of the image file.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ICO | JPEG | PNG | SVG | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ICO", "JPEG", "PNG", "SVG", "WEBP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-extension", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Bytes": { "MarkdownDocumentation": "`Bytes`\n\nThe image file, in Base64-encoded binary.\n*Required*: No\n*Type*: String\n*Maximum*: `1000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-bytes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe category that the image corresponds to in your managed login configuration.\nManaged login has asset categories for different types of logos, backgrounds, and\nicons.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FAVICON_ICO | FAVICON_SVG |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FAVICON_ICO", "FAVICON_SVG", "EMAIL_GRAPHIC", "SMS_GRAPHIC", "AUTH_APP_GRAPHIC", "PASSWORD_GRAPHIC", "PASSKEY_GRAPHIC", "PAGE_HEADER_LOGO", "PAGE_HEADER_BACKGROUND", "PAGE_FOOTER_LOGO", "PAGE_FOOTER_BACKGROUND", "PAGE_BACKGROUND", "FORM_BACKGROUND", "FORM_LOGO", "IDP_BUTTON_ICON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-category", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the asset.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\- ]+$`\n*Minimum*: `1`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-resourceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColorMode": { "MarkdownDocumentation": "`ColorMode`\n\nThe display-mode target of the asset: light, dark, or browser-adaptive. For example,\nAmazon Cognito displays a dark-mode image only when the browser or application is in dark mode,\nbut displays a browser-adaptive file in all contexts.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LIGHT | DARK | DYNAMIC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LIGHT", "DARK", "DYNAMIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-colormode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.AccountRecoverySetting": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.AccountRecoverySetting`\n\nThe available verified method a user can use to recover their password when they call\n`ForgotPassword`. You can use this setting to define a preferred method\nwhen a user has more than one method available. With this setting, SMS doesn't qualify\nfor a valid password recovery mechanism if the user also has SMS multi-factor\nauthentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\nbehavior to determine the recovery method where SMS is preferred through email.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-accountrecoverysetting.html", "Properties": { "RecoveryMechanisms": { "MarkdownDocumentation": "`RecoveryMechanisms`\n\nThe list of options and priorities for user message delivery in forgot-password\noperations. Sets or displays user pool preferences for email or SMS message priority,\nwhether users should fall back to a second delivery method, and whether passwords should\nonly be reset by administrators.\n*Required*: No\n*Type*: Array of [RecoveryOption](./aws-properties-cognito-userpool-recoveryoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-accountrecoverysetting.html#cfn-cognito-userpool-accountrecoverysetting-recoverymechanisms", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RecoveryOption", "DuplicatesAllowed": true } } }, "AWS::Cognito::UserPool.AdminCreateUserConfig": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.AdminCreateUserConfig`\n\nThe settings for administrator creation of users in a user pool. Contains settings for\nallowing user sign-up, customizing invitation messages to new users, and the amount of\ntime before temporary passwords expire.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html", "Properties": { "InviteMessageTemplate": { "MarkdownDocumentation": "`InviteMessageTemplate`\n\nThe template for the welcome message to new users. This template must include the\n`{####}` temporary password placeholder if you are creating users with\npasswords. If your users don't have passwords, you can omit the placeholder.\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-invitemessagetemplate", "UpdateType": "Mutable", "Required": false, "Type": "InviteMessageTemplate" }, "UnusedAccountValidityDays": { "MarkdownDocumentation": "`UnusedAccountValidityDays`\n\nThis parameter is no longer in use.\nThe password expiration limit in days for administrator-created users. When this time\nexpires, the user can't sign in with their temporary password. To reset the account\nafter that time limit, you must call `AdminCreateUser` again, specifying\n`RESEND` for the `MessageAction` parameter.\nThe default value for this parameter is 7.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-unusedaccountvaliditydays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AllowAdminCreateUserOnly": { "MarkdownDocumentation": "`AllowAdminCreateUserOnly`\n\nThe setting for allowing self-service sign-up. When `true`, only\nadministrators can create new user profiles. When `false`, users can register\nthemselves and create a new user profile with the `SignUp` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-allowadmincreateuseronly", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Cognito::UserPool.AdvancedSecurityAdditionalFlows": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.AdvancedSecurityAdditionalFlows`\n\nThreat protection configuration options for additional authentication types in your\nuser pool, including custom\nauthentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-advancedsecurityadditionalflows.html", "Properties": { "CustomAuthMode": { "MarkdownDocumentation": "`CustomAuthMode`\n\nThe operating mode of threat protection in custom authentication with [Custom\nauthentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `AUDIT | ENFORCED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUDIT", "ENFORCED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-advancedsecurityadditionalflows.html#cfn-cognito-userpool-advancedsecurityadditionalflows-customauthmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.CustomEmailSender": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.CustomEmailSender`\n\nThe configuration of a custom email sender Lambda trigger. This trigger routes all\nemail notifications from a user pool to a Lambda function that delivers the message using\ncustom logic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customemailsender.html", "Properties": { "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customemailsender.html#cfn-cognito-userpool-customemailsender-lambdaarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LambdaVersion": { "MarkdownDocumentation": "`LambdaVersion`\n\nThe user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.\nYou must use a `LambdaVersion` of `V1_0` with a custom sender\nfunction.\n*Required*: No\n*Type*: String\n*Allowed values*: `V1_0`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "V1_0" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customemailsender.html#cfn-cognito-userpool-customemailsender-lambdaversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.CustomSMSSender": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.CustomSMSSender`\n\nThe configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS\nnotifications from a user pool to a Lambda function that delivers the message using\ncustom logic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customsmssender.html", "Properties": { "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customsmssender.html#cfn-cognito-userpool-customsmssender-lambdaarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LambdaVersion": { "MarkdownDocumentation": "`LambdaVersion`\n\nThe user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.\nYou must use a `LambdaVersion` of `V1_0` with a custom sender\nfunction.\n*Required*: No\n*Type*: String\n*Allowed values*: `V1_0`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "V1_0" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customsmssender.html#cfn-cognito-userpool-customsmssender-lambdaversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.DeviceConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.DeviceConfiguration`\n\nThe device-remembering configuration for a user pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html", "Properties": { "DeviceOnlyRememberedOnUserPrompt": { "MarkdownDocumentation": "`DeviceOnlyRememberedOnUserPrompt`\n\nWhen true, Amazon Cognito doesn't automatically remember a user's device when your app sends a\n`ConfirmDevice` API request. In your app, create a prompt for your user\nto choose whether they want to remember their device. Return the user's choice in an\n`UpdateDeviceStatus` API request.\nWhen `DeviceOnlyRememberedOnUserPrompt` is `false`, Amazon\nCognito immediately remembers devices that you register in a `ConfirmDevice`\nAPI 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html#cfn-cognito-userpool-deviceconfiguration-deviceonlyrememberedonuserprompt", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ChallengeRequiredOnNewDevice": { "MarkdownDocumentation": "`ChallengeRequiredOnNewDevice`\n\nWhen true, a remembered device can sign in with device authentication instead of SMS\nand time-based one-time password (TOTP) factors for multi-factor authentication\n(MFA).\n###### Note\nWhether or not `ChallengeRequiredOnNewDevice` is true, users who sign\nin with devices that have not been confirmed or remembered must still provide a\nsecond 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html#cfn-cognito-userpool-deviceconfiguration-challengerequiredonnewdevice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Cognito::UserPool.EmailConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.EmailConfiguration`\n\nThe email configuration of your user pool. The email configuration type sets your\npreferred sending method, AWS Region, and sender for messages from your user\npool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html", "Properties": { "ReplyToEmailAddress": { "MarkdownDocumentation": "`ReplyToEmailAddress`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-replytoemailaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfigurationSet": { "MarkdownDocumentation": "`ConfigurationSet`\n\nThe set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A\nconfiguration set is applied to an email by including a reference to the configuration\nset in the headers of the email. Once applied, all of the rules in that configuration\nset are applied to the email. Configuration sets can be used to apply the following\ntypes of rules to emails:\nEvent publishing\nAmazon Simple Email Service can track the number of send, delivery, open, click, bounce, and\ncomplaint events for each email sent. Use event publishing to send\ninformation about these events to other AWS services such as and\nAmazon CloudWatch\n\nIP pool management\nWhen leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups\nof IP addresses, called dedicated IP pools. You can then associate the\ndedicated IP pools with configuration sets.\n\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-configurationset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EmailSendingAccount": { "MarkdownDocumentation": "`EmailSendingAccount`\n\nSpecifies whether Amazon Cognito uses its built-in functionality to send your users email\nmessages, or uses your Amazon Simple Email Service email configuration. Specify one of the following\nvalues:\nCOGNITO\\_DEFAULT\nWhen Amazon Cognito emails your users, it uses its built-in email functionality.\nWhen you use the default option, Amazon Cognito allows only a limited number of\nemails each day for your user pool. For typical production environments, the\ndefault email limit is less than the required delivery volume. To achieve a\nhigher delivery volume, specify DEVELOPER to use your Amazon SES email\nconfiguration.\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\nGuide*.\nThe default FROM address is `no-reply@verificationemail.com`.\nTo customize the FROM address, provide the Amazon Resource Name (ARN) of an\nAmazon SES verified email address for the `SourceArn`\nparameter.\n\nDEVELOPER\nWhen Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito\ncalls Amazon SES on your behalf to send email from your verified email address.\nWhen you use this option, the email delivery limits are the same limits that\napply 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\nfor the `SourceArn` parameter.\nBefore Amazon Cognito can email your users, it requires additional permissions to\ncall Amazon SES on your behalf. When you update your user pool with this option,\nAmazon Cognito creates a *service-linked role*, which is a type of\nrole in your AWS account. This role contains the permissions\nthat allow you to access Amazon SES and send email messages from your email\naddress. For more information about the service-linked role that Amazon Cognito\ncreates, see [Using Service-Linked Roles for Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) in the\n*Amazon Cognito Developer Guide*.\n\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)", "RefReturnValue": "", "AllowedValues": [ "COGNITO_DEFAULT", "DEVELOPER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-emailsendingaccount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe ARN of a verified email address or an address from a verified domain in Amazon SES. You\ncan set a `SourceArn` email from a verified domain only with an API request.\nYou can set a verified email address, but not an address in a verified domain, in the\nAmazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following\nways, depending on the value that you specify for the `EmailSendingAccount`\nparameter:\n* If you specify `COGNITO_DEFAULT`, Amazon Cognito uses this address as the\n custom FROM address when it emails your users using its built-in email\n account.\n* If you specify `DEVELOPER`, Amazon Cognito emails your users with this\n address by calling Amazon SES on your behalf.\nThe Region value of the `SourceArn` parameter must indicate a supported\nAWS Region of your user pool. Typically, the Region in the `SourceArn` and\nthe 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\nGuide](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html).\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-sourcearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "From": { "MarkdownDocumentation": "`From`\n\nEither the sender\u2019s email address or the sender\u2019s name with their email address. For\nexample, `testuser@example.com` or `Test User\n`. This address appears before the body of the\nemail.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-from", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.InviteMessageTemplate": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.InviteMessageTemplate`\n\nThe template for the welcome message to new users. This template must include the\n`{####}` temporary password placeholder if you are creating users with\npasswords. If your users don't have passwords, you can omit the placeholder.\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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html", "Properties": { "EmailMessage": { "MarkdownDocumentation": "`EmailMessage`\n\nThe 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*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*`\n*Minimum*: `6`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SMSMessage": { "MarkdownDocumentation": "`SMSMessage`\n\nThe message template for SMS messages.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\n*Minimum*: `6`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-smsmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EmailSubject": { "MarkdownDocumentation": "`EmailSubject`\n\nThe subject line for email messages. 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*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailsubject", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.LambdaConfig": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.LambdaConfig`\n\nA collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several\npossible stages of user pool operations. Triggers can modify the outcome of the\noperations that invoked them.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html", "Properties": { "CreateAuthChallenge": { "MarkdownDocumentation": "`CreateAuthChallenge`\n\nThe configuration of a create auth challenge Lambda trigger, one of three triggers in\nthe sequence of the [custom authentication challenge triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html).\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-createauthchallenge", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreSignUp": { "MarkdownDocumentation": "`PreSignUp`\n\nThe configuration of a [pre sign-up Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html) in a user pool. This trigger\nevaluates new users and can bypass confirmation, [link a federated user profile](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html), or block sign-up\nrequests.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-presignup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KMSKeyID": { "MarkdownDocumentation": "`KMSKeyID`\n\nThe ARN of an [KMS key](https://docs.aws.amazon.com//kms/latest/developerguide/concepts.html#master_keys). Amazon Cognito uses the key to encrypt codes and temporary passwords sent to\ncustom sender Lambda triggers.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserMigration": { "MarkdownDocumentation": "`UserMigration`\n\nThe configuration of a [migrate user Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html) in a user pool. This trigger\ncan create user profiles when users sign in or attempt to reset their password with\ncredentials that don't exist yet.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-usermigration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PostAuthentication": { "MarkdownDocumentation": "`PostAuthentication`\n\nThe configuration of a [post authentication Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html) in a user pool. This\ntrigger can take custom actions after a user signs in.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postauthentication", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VerifyAuthChallengeResponse": { "MarkdownDocumentation": "`VerifyAuthChallengeResponse`\n\nThe configuration of a verify auth challenge Lambda trigger, one of three triggers in\nthe sequence of the [custom authentication challenge triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html).\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-verifyauthchallengeresponse", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreAuthentication": { "MarkdownDocumentation": "`PreAuthentication`\n\nThe configuration of a [pre authentication trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html) in a user pool. This trigger\ncan evaluate and modify user sign-in events.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-preauthentication", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefineAuthChallenge": { "MarkdownDocumentation": "`DefineAuthChallenge`\n\nThe configuration of a define auth challenge Lambda trigger, one of three triggers in\nthe sequence of the [custom authentication challenge triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html).\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-defineauthchallenge", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreTokenGeneration": { "MarkdownDocumentation": "`PreTokenGeneration`\n\nThe legacy configuration of a [pre token generation Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html) in a user\npool.\nSet this parameter for legacy purposes. If you also set an ARN in\n`PreTokenGenerationConfig`, its value must be identical to\n`PreTokenGeneration`. For new instances of pre token generation triggers,\nset the `LambdaArn` of `PreTokenGenerationConfig`.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengeneration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomSMSSender": { "MarkdownDocumentation": "`CustomSMSSender`\n\nThe configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS\nnotifications from a user pool to a Lambda function that delivers the message using\ncustom logic.\n*Required*: No\n*Type*: [CustomSMSSender](./aws-properties-cognito-userpool-customsmssender.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-customsmssender", "UpdateType": "Mutable", "Required": false, "Type": "CustomSMSSender" }, "PostConfirmation": { "MarkdownDocumentation": "`PostConfirmation`\n\nThe configuration of a [post confirmation Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html) in a user pool. This\ntrigger can take custom actions after a user confirms their user account and their email\naddress or phone number.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postconfirmation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomMessage": { "MarkdownDocumentation": "`CustomMessage`\n\nA custom message Lambda trigger. This trigger is an opportunity to customize all SMS\nand email messages from your user pool. When a custom message trigger is active, your\nuser pool routes all messages to a Lambda function that returns a runtime-customized\nmessage subject and body for your user pool to deliver to a user.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-custommessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreTokenGenerationConfig": { "MarkdownDocumentation": "`PreTokenGenerationConfig`\n\nThe detailed configuration of a [pre token generation Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html) in a user pool. If\nyou also set an ARN in `PreTokenGeneration`, its value must be identical to\n`PreTokenGenerationConfig`.\n*Required*: No\n*Type*: [PreTokenGenerationConfig](./aws-properties-cognito-userpool-pretokengenerationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengenerationconfig", "UpdateType": "Mutable", "Required": false, "Type": "PreTokenGenerationConfig" }, "CustomEmailSender": { "MarkdownDocumentation": "`CustomEmailSender`\n\nThe configuration of a custom email sender Lambda trigger. This trigger routes all\nemail notifications from a user pool to a Lambda function that delivers the message using\ncustom logic.\n*Required*: No\n*Type*: [CustomEmailSender](./aws-properties-cognito-userpool-customemailsender.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-customemailsender", "UpdateType": "Mutable", "Required": false, "Type": "CustomEmailSender" } } }, "AWS::Cognito::UserPool.NumberAttributeConstraints": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.NumberAttributeConstraints`\n\nThe minimum and maximum values of an attribute that is of the number type, for example\n`custom:age`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html", "Properties": { "MinValue": { "MarkdownDocumentation": "`MinValue`\n\nThe minimum value of an attribute that is of the number data type.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-minvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxValue": { "MarkdownDocumentation": "`MaxValue`\n\nThe maximum length of a number attribute value. Must be a number less than or equal to\n`2^1023`, represented as a string with a length of 131072 characters or\nfewer.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-maxvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.PasswordPolicy": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.PasswordPolicy`\n\nThe password policy settings for a user pool, including complexity, history, and\nlength requirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html", "Properties": { "RequireNumbers": { "MarkdownDocumentation": "`RequireNumbers`\n\nThe requirement in a password policy that users must include at least one number in\ntheir 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirenumbers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MinimumLength": { "MarkdownDocumentation": "`MinimumLength`\n\nThe minimum length of the password in the policy that you have set. This value can't\nbe less than 6.\n*Required*: No\n*Type*: Integer\n*Minimum*: `6`\n*Maximum*: `99`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-minimumlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TemporaryPasswordValidityDays": { "MarkdownDocumentation": "`TemporaryPasswordValidityDays`\n\nThe number of days a temporary password is valid in the password policy. If the user\ndoesn't sign in during this time, an administrator must reset their password. Defaults\nto `7`. If you submit a value of `0`, Amazon Cognito treats it as a null\nvalue and sets `TemporaryPasswordValidityDays` to its default value.\n###### Note\nWhen you set `TemporaryPasswordValidityDays` for a user pool, you can\nno longer set a value for the legacy `UnusedAccountValidityDays`\nparameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-temporarypasswordvaliditydays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RequireUppercase": { "MarkdownDocumentation": "`RequireUppercase`\n\nThe requirement in a password policy that users must include at least one uppercase\nletter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requireuppercase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireLowercase": { "MarkdownDocumentation": "`RequireLowercase`\n\nThe requirement in a password policy that users must include at least one lowercase\nletter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirelowercase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireSymbols": { "MarkdownDocumentation": "`RequireSymbols`\n\nThe requirement in a password policy that users must include at least one symbol in\ntheir 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requiresymbols", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PasswordHistorySize": { "MarkdownDocumentation": "`PasswordHistorySize`\n\nThe number of previous passwords that you want Amazon Cognito to restrict each user\nfrom reusing. Users can't set a password that matches any of `n` previous\npasswords, where `n` is the value of `PasswordHistorySize`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `24`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-passwordhistorysize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Cognito::UserPool.Policies": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.Policies`\n\nA list of user pool policies. Contains the policy that sets password-complexity\nrequirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html", "Properties": { "PasswordPolicy": { "MarkdownDocumentation": "`PasswordPolicy`\n\nThe password policy settings for a user pool, including complexity, history, and\nlength requirements.\n*Required*: No\n*Type*: [PasswordPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-passwordpolicy", "UpdateType": "Mutable", "Required": false, "Type": "PasswordPolicy" }, "SignInPolicy": { "MarkdownDocumentation": "`SignInPolicy`\n\nThe policy for allowed types of authentication in a user pool. To activate this\nsetting, your user pool must be in the [Essentials tier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html) or higher.\n*Required*: No\n*Type*: [SignInPolicy](./aws-properties-cognito-userpool-signinpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-signinpolicy", "UpdateType": "Mutable", "Required": false, "Type": "SignInPolicy" } } }, "AWS::Cognito::UserPool.PreTokenGenerationConfig": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.PreTokenGenerationConfig`\n\nThe properties of a pre token generation Lambda trigger.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-pretokengenerationconfig.html", "Properties": { "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.\nThis parameter and the `PreTokenGeneration` property of\n`LambdaConfig` have the same value. For new instances of pre token\ngeneration triggers, set `LambdaArn`.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-pretokengenerationconfig.html#cfn-cognito-userpool-pretokengenerationconfig-lambdaarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LambdaVersion": { "MarkdownDocumentation": "`LambdaVersion`\n\nThe user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.\n*Required*: No\n*Type*: String\n*Allowed values*: `V1_0 | V2_0 | V3_0...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "V1_0", "V2_0", "V3_0" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-pretokengenerationconfig.html#cfn-cognito-userpool-pretokengenerationconfig-lambdaversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.RecoveryOption": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.RecoveryOption`\n\nA recovery option for a user. The `AccountRecoverySettingType` data type is\nan array of this object. Each `RecoveryOptionType` has a priority property\nthat determines whether it is a primary or secondary option.\nFor example, if `verified_email` has a priority of `1` and\n`verified_phone_number` has a priority of `2`, your user pool\nsends account-recovery messages to a verified email address but falls back to an SMS\nmessage if the user has a verified phone number. The `admin_only` option\nprevents self-service account recovery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html", "Properties": { "Priority": { "MarkdownDocumentation": "`Priority`\n\nYour priority preference for using the specified attribute in account recovery. The\nhighest priority is `1`.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html#cfn-cognito-userpool-recoveryoption-priority", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe recovery method that this object sets a recovery option for.\n*Required*: No\n*Type*: String\n*Allowed values*: `verified_email | verified_p...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "verified_email", "verified_phone_number", "admin_only" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html#cfn-cognito-userpool-recoveryoption-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.SchemaAttribute": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.SchemaAttribute`\n\nA list of the user attributes and their properties in your user pool. The attribute\nschema contains standard attributes, custom attributes with a `custom:`\nprefix, and developer attributes with a `dev:` prefix. For more information,\nsee [User pool\nattributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html).\nDeveloper-only `dev:` attributes are a legacy feature of user pools, and\nare read-only to all app clients. You can create and update developer-only attributes\nonly with IAM-authenticated API operations. Use app client read/write permissions\ninstead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html", "Properties": { "DeveloperOnlyAttribute": { "MarkdownDocumentation": "`DeveloperOnlyAttribute`\n\n###### Note\nYou should 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\nbe mutated for new use cases instead of using\n`DeveloperOnlyAttribute`.\nSpecifies whether the attribute type is developer only. This attribute can only be\nmodified by an administrator. Users won't be able to modify this attribute using their\naccess token. For example, `DeveloperOnlyAttribute` can be modified using\nAdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Mutable": { "MarkdownDocumentation": "`Mutable`\n\nSpecifies whether the value of the attribute can be changed.\nAny user pool attribute whose value you map from an IdP attribute must be mutable,\nwith a parameter value of `true`. Amazon Cognito updates mapped attributes when users\nsign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws\nan error when it attempts to update the attribute. For more information, see [Specifying Identity Provider Attribute Mappings for Your User\nPool](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-mutable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AttributeDataType": { "MarkdownDocumentation": "`AttributeDataType`\n\nThe data format of the values for your attribute. When you choose an\n`AttributeDataType`, Amazon Cognito validates the input against the data type. A\ncustom attribute value in your user's ID token is always a string, for example\n`\"custom:isMember\" : \"true\"` or `\"custom:YearsAsMember\" :\n\"12\"`.\n*Required*: No\n*Type*: String\n*Allowed values*: `String | Number | DateTime ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "String", "Number", "DateTime", "Boolean" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-attributedatatype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StringAttributeConstraints": { "MarkdownDocumentation": "`StringAttributeConstraints`\n\nSpecifies the constraints for an attribute of the string type.\n*Required*: No\n*Type*: [StringAttributeConstraints](./aws-properties-cognito-userpool-stringattributeconstraints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-stringattributeconstraints", "UpdateType": "Mutable", "Required": false, "Type": "StringAttributeConstraints" }, "Required": { "MarkdownDocumentation": "`Required`\n\nSpecifies whether a user pool attribute is required. If the attribute is required and\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-required", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NumberAttributeConstraints": { "MarkdownDocumentation": "`NumberAttributeConstraints`\n\nSpecifies the constraints for an attribute of the number type.\n*Required*: No\n*Type*: [NumberAttributeConstraints](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-numberattributeconstraints", "UpdateType": "Mutable", "Required": false, "Type": "NumberAttributeConstraints" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of your user pool attribute. When you create or update a user pool, adding a\nschema attribute creates a custom or developer-only attribute. When you add an attribute\nwith a `Name` value of `MyAttribute`, Amazon Cognito creates the custom\nattribute `custom:MyAttribute`. When `DeveloperOnlyAttribute` is\n`true`, Amazon Cognito creates your attribute as `dev:MyAttribute`. In\nan operation that describes a user pool, Amazon Cognito returns this value as `value`\nfor standard attributes, `custom:value` for custom attributes, and\n`dev:value` for developer-only attributes..\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.SignInPolicy": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.SignInPolicy`\n\nThe policy for allowed types of authentication in a user pool. To activate this\nsetting, your user pool must be in the [Essentials tier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html) or higher.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-signinpolicy.html", "Properties": { "AllowedFirstAuthFactors": { "MarkdownDocumentation": "`AllowedFirstAuthFactors`\n\nThe sign-in methods that a user pool supports as the first factor. You can permit\nusers to start authentication with a standard username and password, or with other\none-time password and hardware factors.\nSupports values of `EMAIL_OTP`, `SMS_OTP`,\n`WEB_AUTHN` and `PASSWORD`,\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-signinpolicy.html#cfn-cognito-userpool-signinpolicy-allowedfirstauthfactors", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Cognito::UserPool.SmsConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.SmsConfiguration`\n\nUser pool configuration for delivery of SMS messages with Amazon Simple Notification\nService. To send SMS messages with Amazon SNS in the AWS Region that you\nwant, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your\nAWS account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html", "Properties": { "SnsRegion": { "MarkdownDocumentation": "`SnsRegion`\n\nThe AWS Region to use with Amazon SNS integration. You can choose the same Region as your\nuser pool, or a supported **Legacy Amazon SNS alternate\nRegion**.\nAmazon Cognito resources in the Asia Pacific (Seoul) AWS Region must use your Amazon SNS\nconfiguration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snsregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID provides additional security for your IAM role. You can use an\n`ExternalId` with the IAM role that you use with Amazon SNS to send SMS\nmessages for your user pool. If you provide an `ExternalId`, your Amazon Cognito user\npool includes it in the request to assume your IAM role. You can configure the role\ntrust policy to require that Amazon Cognito, and any principal, provide the\n`ExternalID`. If you use the Amazon Cognito Management Console to create a role\nfor SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required\npermissions and a trust policy that demonstrates use of the\n`ExternalId`.\nFor more information about the `ExternalId` of a role, see [How to use an\nexternal ID when granting access to your AWS resources to a third\nparty](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnsCallerArn": { "MarkdownDocumentation": "`SnsCallerArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role\nin your AWS account that Amazon Cognito will use to send SMS messages. SMS\nmessages 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*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snscallerarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.StringAttributeConstraints": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.StringAttributeConstraints`\n\nThe minimum and maximum length values of an attribute that is of the string type, for\nexample `custom:department`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html", "Properties": { "MinLength": { "MarkdownDocumentation": "`MinLength`\n\nThe minimum length of a string attribute value.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-minlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxLength": { "MarkdownDocumentation": "`MaxLength`\n\nThe maximum length of a string attribute value. Must be a number less than or equal to\n`2^1023`, represented as a string with a length of 131072 characters or\nfewer.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-maxlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.UserAttributeUpdateSettings": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.UserAttributeUpdateSettings`\n\nThe settings for updates to user attributes. These settings include the property `AttributesRequireVerificationBeforeUpdate`,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html", "Properties": { "AttributesRequireVerificationBeforeUpdate": { "MarkdownDocumentation": "`AttributesRequireVerificationBeforeUpdate`\n\nRequires that your user verifies their email address, phone number, or both before\nAmazon Cognito updates the value of that attribute. When you update a user attribute\nthat has this option activated, Amazon Cognito sends a verification message to the new\nphone number or email address. Amazon Cognito doesn\u2019t change the value of the attribute\nuntil your user responds to the verification message and confirms the new value.\nWhen `AttributesRequireVerificationBeforeUpdate` is false, your user pool\ndoesn't require that your users verify attribute changes before Amazon Cognito updates\nthem. In a user pool where `AttributesRequireVerificationBeforeUpdate` is\nfalse, API operations that change attribute values can immediately update a user\u2019s\n`email` or `phone_number` attribute.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html#cfn-cognito-userpool-userattributeupdatesettings-attributesrequireverificationbeforeupdate", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Cognito::UserPool.UserPoolAddOns": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.UserPoolAddOns`\n\nUser pool add-ons. Contains settings for activation of threat protection. To log user\nsecurity information but take no action, set to `AUDIT`. To configure\nautomatic security responses to risky traffic to your user pool, set to\n`ENFORCED`.\nFor more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html). To activate this setting, your\nuser pool must be on the [Plus\ntier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html", "Properties": { "AdvancedSecurityAdditionalFlows": { "MarkdownDocumentation": "`AdvancedSecurityAdditionalFlows`\n\nThreat protection configuration options for additional authentication types in your\nuser pool, including custom\nauthentication.\n*Required*: No\n*Type*: [AdvancedSecurityAdditionalFlows](./aws-properties-cognito-userpool-advancedsecurityadditionalflows.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecurityadditionalflows", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedSecurityAdditionalFlows" }, "AdvancedSecurityMode": { "MarkdownDocumentation": "`AdvancedSecurityMode`\n\nThe operating mode of threat protection for standard authentication types in your user\npool, including username-password and secure remote password (SRP) authentication.\n*Required*: No\n*Type*: String\n*Allowed values*: `OFF | AUDIT | ENFORCED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OFF", "AUDIT", "ENFORCED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecuritymode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPool.UsernameConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.UsernameConfiguration`\n\nCase sensitivity of the username input for the selected sign-in option. When case\nsensitivity is set to `False` (case insensitive), users can sign in with any\ncombination of capital and lowercase letters. For example, `username`,\n`USERNAME`, or `UserName`, or for email,\n`email@example.com` or `EMaiL@eXamplE.Com`. For most use\ncases, set case sensitivity to `False` (case insensitive) as a best practice.\nWhen usernames and email addresses are case insensitive, Amazon Cognito treats any\nvariation in case as the same user, and prevents a case variation from being assigned to\nthe same attribute for a different user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html", "Properties": { "CaseSensitive": { "MarkdownDocumentation": "`CaseSensitive`\n\nSpecifies whether user name case sensitivity will be applied for all users in the user\npool through Amazon Cognito APIs. For most use cases, set case sensitivity to `False`\n(case insensitive) as a best practice. When usernames and email addresses are case\ninsensitive, users can sign in as the same user when they enter a different\ncapitalization of their user name.\nValid values include:\ntrue\nEnables case sensitivity for all username input. When this option is set\nto `true`, users must sign in using the exact capitalization of\ntheir given username, such as \u201cUserName\u201d. This is the default value.\n\nfalse\nEnables case insensitivity for all username input. For example, when this\noption is set to `false`, users can sign in using\n`username`, `USERNAME`, or `UserName`.\nThis option also enables both `preferred_username` and\n`email` alias to be case insensitive, in addition to the\n`username` attribute.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-usernameconfiguration.html#cfn-cognito-userpool-usernameconfiguration-casesensitive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Cognito::UserPool.VerificationMessageTemplate": { "MarkdownDocumentation": "`AWS::Cognito::UserPool.VerificationMessageTemplate`\n\nThe template for the verification message that your user pool delivers to users who\nset an email address or phone number attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html", "Properties": { "EmailMessageByLink": { "MarkdownDocumentation": "`EmailMessageByLink`\n\nThe email message template for sending a confirmation link to the user. You can set an\n`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\nmessages with your own Amazon SES configuration.\n*Required*: No\n*Type*: String\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*Minimum*: `6`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailmessagebylink", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EmailMessage": { "MarkdownDocumentation": "`EmailMessage`\n\nThe template for email messages that Amazon Cognito sends to your users. You can set an\n`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\nmessages with your own Amazon SES configuration.\n*Required*: No\n*Type*: String\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*Minimum*: `6`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SmsMessage": { "MarkdownDocumentation": "`SmsMessage`\n\nThe template for SMS messages that Amazon Cognito sends to your users.\n*Required*: No\n*Type*: String\n*Pattern*: `.*\\{####\\}.*`\n*Minimum*: `6`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-smsmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EmailSubject": { "MarkdownDocumentation": "`EmailSubject`\n\nThe subject line for the email message template. You can set an\n`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\nmessages with your own Amazon SES configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailsubject", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultEmailOption": { "MarkdownDocumentation": "`DefaultEmailOption`\n\nThe configuration of verification emails to contain a clickable link or a verification\ncode.\nFor link, your template body must contain link text in the format `{##Click\nhere##}`. \"Click here\" in the example is a customizable string. For code, your\ntemplate body must contain a code placeholder in the format `{####}`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CONFIRM_WITH_LINK | CONFIRM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-defaultemailoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EmailSubjectByLink": { "MarkdownDocumentation": "`EmailSubjectByLink`\n\nThe subject line for the email message template for sending a confirmation link to the\nuser. You can set an `EmailSubjectByLink` template only if the value of\n [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\nmessages with your own Amazon SES configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailsubjectbylink", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolClient.AnalyticsConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolClient.AnalyticsConfiguration`\n\nThe settings for Amazon Pinpoint analytics configuration. With an analytics\nconfiguration, your application can collect user-activity metrics for user notifications\nwith a Amazon Pinpoint campaign.\nAmazon Pinpoint isn't available in all AWS Regions. For a list of\navailable Regions, see [Amazon Cognito and Amazon Pinpoint Region availability](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html", "Properties": { "ApplicationArn": { "MarkdownDocumentation": "`ApplicationArn`\n\nThe Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to\nyour user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that\n`ApplicationArn` declares. You can also configure your application to\npass an endpoint ID in the `AnalyticsMetadata` parameter of sign-in\noperations. The endpoint ID is information about the destination for push\nnotifications\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-applicationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserDataShared": { "MarkdownDocumentation": "`UserDataShared`\n\nIf `UserDataShared` is `true`, Amazon Cognito includes user data in the\nevents 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-userdatashared", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe [external ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) of the role that Amazon Cognito assumes to send\nanalytics data to Amazon Pinpoint.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationId": { "MarkdownDocumentation": "`ApplicationId`\n\nYour Amazon Pinpoint project ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-applicationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish\nevents to Amazon Pinpoint analytics.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolClient.RefreshTokenRotation": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolClient.RefreshTokenRotation`\n\nThe configuration of your app client for refresh token rotation. When enabled, your\napp client issues new ID, access, and refresh tokens when users renew their sessions\nwith refresh tokens. When disabled, token refresh issues only ID and access\ntokens.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-refreshtokenrotation.html", "Properties": { "RetryGracePeriodSeconds": { "MarkdownDocumentation": "`RetryGracePeriodSeconds`\n\nWhen you request a token refresh with `GetTokensFromRefreshToken`, the\noriginal refresh token that you're rotating out can remain valid for a period of time of\nup to 60 seconds. This allows for client-side retries. When\n`RetryGracePeriodSeconds` is `0`, the grace period is disabled\nand a successful request immediately invalidates the submitted refresh token.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-refreshtokenrotation.html#cfn-cognito-userpoolclient-refreshtokenrotation-retrygraceperiodseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Feature": { "MarkdownDocumentation": "`Feature`\n\nThe state of refresh token rotation for the current app client.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-refreshtokenrotation.html#cfn-cognito-userpoolclient-refreshtokenrotation-feature", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolClient.TokenValidityUnits": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolClient.TokenValidityUnits`\n\nThe units that validity times are represented in. The default unit for refresh tokens\nis days, and the default for ID and access tokens are hours.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html", "Properties": { "IdToken": { "MarkdownDocumentation": "`IdToken`\n\nA time unit for the value that you set in the `IdTokenValidity` parameter.\nThe default `IdTokenValidity` time unit is `hours`.\n`IdTokenValidity` duration can range from five minutes to one day.\n*Required*: No\n*Type*: String\n*Allowed values*: `seconds | minutes | hours |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "seconds", "minutes", "hours", "days" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-idtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RefreshToken": { "MarkdownDocumentation": "`RefreshToken`\n\nA time unit for the value that you set in the `RefreshTokenValidity`\nparameter. The default `RefreshTokenValidity` time unit is `days`.\n`RefreshTokenValidity` duration can range from 60 minutes to 10\nyears.\n*Required*: No\n*Type*: String\n*Allowed values*: `seconds | minutes | hours |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "seconds", "minutes", "hours", "days" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-refreshtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nA time unit for the value that you set in the `AccessTokenValidity`\nparameter. The default `AccessTokenValidity` time unit is `hours`.\n`AccessTokenValidity` duration can range from five minutes to one\nday.\n*Required*: No\n*Type*: String\n*Allowed values*: `seconds | minutes | hours |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "seconds", "minutes", "hours", "days" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html#cfn-cognito-userpoolclient-tokenvalidityunits-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolDomain.CustomDomainConfigType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolDomain.CustomDomainConfigType`\n\nThe configuration for a hosted UI custom domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html", "Properties": { "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use\nthis certificate for the subdomain of your custom domain.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html#cfn-cognito-userpooldomain-customdomainconfigtype-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolResourceServer.ResourceServerScopeType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolResourceServer.ResourceServerScopeType`\n\nOne custom scope associated with a user pool resource server. This data type is a\nmember of `ResourceServerScopeType`. For more information, see [Scopes, M2M, and API authorization with resource servers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html", "Properties": { "ScopeName": { "MarkdownDocumentation": "`ScopeName`\n\nThe name of the scope. Amazon Cognito renders custom scopes in the format\n`resourceServerIdentifier/ScopeName`. For example, if this parameter is\n`exampleScope` in the resource server with the identifier\n`exampleResourceServer`, you request and receive the scope\n`exampleResourceServer/exampleScope`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\x21\\x23-\\x2E\\x30-\\x5B\\x5D-\\x7E]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ScopeDescription": { "MarkdownDocumentation": "`ScopeDescription`\n\nA friendly description of a custom scope.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.html#cfn-cognito-userpoolresourceserver-resourceserverscopetype-scopedescription", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType`\n\nThe automated response to a risk level for adaptive authentication in full-function,\nor `ENFORCED`, mode. You can assign an action to each risk level that\nadvanced security features evaluates.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html", "Properties": { "Notify": { "MarkdownDocumentation": "`Notify`\n\nDetermines whether Amazon Cognito sends a user a notification message when your user pools\nassesses a user's session at the associated risk level.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-notify", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "EventAction": { "MarkdownDocumentation": "`EventAction`\n\nThe action to take for the attempted account takeover action for the associated risk\nlevel. Valid values are as follows:\n* `BLOCK`: Block the request.\n* `MFA_IF_CONFIGURED`: Present an MFA challenge if possible. MFA is\n possible if the user pool has active MFA methods that the user can set up. For\n example, if the user pool only supports SMS message MFA but the user\n doesn't have a phone number attribute, MFA setup isn't possible. If MFA\n setup isn't possible, allow the request.\n* `MFA_REQUIRED`: Present an MFA challenge if possible. Block the\n request if a user hasn't set up MFA. To sign in with required MFA, users must\n have an email address or phone number attribute, or a registered TOTP\n factor.\n* `NO_ACTION`: Take no action. Permit sign-in.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BLOCK | MFA_IF_CONFIGURED |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-eventaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionsType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionsType`\n\nA list of account-takeover actions for each level of risk that Amazon Cognito might\nassess with advanced security features.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html", "Properties": { "HighAction": { "MarkdownDocumentation": "`HighAction`\n\nThe action that you assign to a high-risk assessment by threat protection.\n*Required*: No\n*Type*: [AccountTakeoverActionType](./aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-highaction", "UpdateType": "Mutable", "Required": false, "Type": "AccountTakeoverActionType" }, "LowAction": { "MarkdownDocumentation": "`LowAction`\n\nThe action that you assign to a low-risk assessment by threat protection.\n*Required*: No\n*Type*: [AccountTakeoverActionType](./aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-lowaction", "UpdateType": "Mutable", "Required": false, "Type": "AccountTakeoverActionType" }, "MediumAction": { "MarkdownDocumentation": "`MediumAction`\n\nThe action that you assign to a medium-risk assessment by threat protection.\n*Required*: No\n*Type*: [AccountTakeoverActionType](./aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-mediumaction", "UpdateType": "Mutable", "Required": false, "Type": "AccountTakeoverActionType" } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationType`\n\nThe settings for automated responses and notification templates for adaptive\nauthentication with advanced security features.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nA list of account-takeover actions for each level of risk that Amazon Cognito might assess with\nthreat protection.\n*Required*: Yes\n*Type*: [AccountTakeoverActionsType](./aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-actions", "UpdateType": "Mutable", "Required": true, "Type": "AccountTakeoverActionsType" }, "NotifyConfiguration": { "MarkdownDocumentation": "`NotifyConfiguration`\n\nThe settings for composing and sending an email message when threat protection\nassesses a risk level with adaptive authentication. When you choose to notify users in\n`AccountTakeoverRiskConfiguration`, Amazon Cognito sends an email message using\nthe method and template that you set with this data type.\n*Required*: No\n*Type*: [NotifyConfigurationType](./aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-notifyconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NotifyConfigurationType" } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsType`\n\nSettings for user pool actions when Amazon Cognito detects compromised credentials\nwith advanced security features in full-function `ENFORCED` mode.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html", "Properties": { "EventAction": { "MarkdownDocumentation": "`EventAction`\n\nThe action that Amazon Cognito takes when it detects compromised credentials.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BLOCK | 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)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "NO_ACTION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype-eventaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationType`\n\nSettings for compromised-credentials actions and authentication-event sources with\nadvanced security features in full-function `ENFORCED` mode.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nSettings for the actions that you want your user pool to take when Amazon Cognito detects\ncompromised credentials.\n*Required*: Yes\n*Type*: [CompromisedCredentialsActionsType](./aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-actions", "UpdateType": "Mutable", "Required": true, "Type": "CompromisedCredentialsActionsType" }, "EventFilter": { "MarkdownDocumentation": "`EventFilter`\n\nSettings for the sign-in activity where you want to configure compromised-credentials\nactions. Defaults to all events.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-eventfilter", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyConfigurationType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyConfigurationType`\n\nThe configuration for Amazon SES email messages that advanced security features sends\nto a user when your adaptive authentication automated response has a\n*Notify* action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html", "Properties": { "BlockEmail": { "MarkdownDocumentation": "`BlockEmail`\n\nThe template for the email message that your user pool sends when a detected risk\nevent is blocked.\n*Required*: No\n*Type*: [NotifyEmailType](./aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-blockemail", "UpdateType": "Mutable", "Required": false, "Type": "NotifyEmailType" }, "ReplyTo": { "MarkdownDocumentation": "`ReplyTo`\n\nThe reply-to email address of an email template. Can be an email address in the format\n`admin@example.com` or `Administrator\n`.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-replyto", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe Amazon Resource Name (ARN) of the identity that is associated with the sending\nauthorization policy. This identity permits Amazon Cognito to send for the email address\nspecified in the `From` parameter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-sourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NoActionEmail": { "MarkdownDocumentation": "`NoActionEmail`\n\nThe template for the email message that your user pool sends when no action is taken\nin response to a detected risk.\n*Required*: No\n*Type*: [NotifyEmailType](./aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-noactionemail", "UpdateType": "Mutable", "Required": false, "Type": "NotifyEmailType" }, "From": { "MarkdownDocumentation": "`From`\n\nThe email address that sends the email message. The address must be either\nindividually verified with Amazon Simple Email Service, or from a domain that has been verified with\nAmazon SES.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-from", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MfaEmail": { "MarkdownDocumentation": "`MfaEmail`\n\nThe template for the email message that your user pool sends when MFA is challenged in\nresponse to a detected risk.\n*Required*: No\n*Type*: [NotifyEmailType](./aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-mfaemail", "UpdateType": "Mutable", "Required": false, "Type": "NotifyEmailType" } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType`\n\nThe template for email messages that advanced security features sends to a user when\nyour threat protection automated response has a *Notify*\naction.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html", "Properties": { "TextBody": { "MarkdownDocumentation": "`TextBody`\n\nThe body of an email notification formatted in plaintext. Choose an\n`HtmlBody` or a `TextBody` to send an HTML-formatted or\nplaintext message, respectively.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]+`\n*Minimum*: `6`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-textbody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HtmlBody": { "MarkdownDocumentation": "`HtmlBody`\n\nThe body of an email notification formatted in HTML. Choose an `HtmlBody`\nor a `TextBody` to send an HTML-formatted or plaintext message,\nrespectively.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]+`\n*Minimum*: `6`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-htmlbody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Subject": { "MarkdownDocumentation": "`Subject`\n\nThe subject of the threat protection email notification.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-subject", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment.RiskExceptionConfigurationType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment.RiskExceptionConfigurationType`\n\nExceptions to the risk evaluation configuration, including always-allow and\nalways-block IP address ranges.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html", "Properties": { "BlockedIPRangeList": { "MarkdownDocumentation": "`BlockedIPRangeList`\n\nAn always-block IP address list. Overrides the risk decision and always blocks\nauthentication requests. This parameter is displayed and set in CIDR notation.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-blockediprangelist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SkippedIPRangeList": { "MarkdownDocumentation": "`SkippedIPRangeList`\n\nAn always-allow IP address list. Risk detection isn't performed on the IP addresses in\nthis range list. This parameter is displayed and set in CIDR notation.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-skippediprangelist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Cognito::UserPoolUser.AttributeType": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolUser.AttributeType`\n\nThe name and value of a user attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the attribute.\n*Required*: No\n*Type*: String\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the attribute.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Comprehend::DocumentClassifier.AugmentedManifestsListItem": { "MarkdownDocumentation": "`AWS::Comprehend::DocumentClassifier.AugmentedManifestsListItem`\n\nAn augmented manifest file that provides training data for your custom model. An augmented\nmanifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html", "Properties": { "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe Amazon S3 location of the augmented manifest file.\n*Required*: Yes\n*Type*: String\n*Pattern*: `s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-s3uri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AttributeNames": { "MarkdownDocumentation": "`AttributeNames`\n\nThe JSON attribute that contains the annotations for your training documents. The number\nof attribute names that you specify depends on whether your augmented manifest file is the\noutput of a single labeling job or a chained labeling job.\nIf your file is the output of a single labeling job, specify the LabelAttributeName key\nthat was used when the job was created in Ground Truth.\nIf your file is the output of a chained labeling job, specify the LabelAttributeName key\nfor one or more jobs in the chain. Each LabelAttributeName key provides the annotations from\nan individual job.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-attributenames", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Split": { "MarkdownDocumentation": "`Split`\n\nThe purpose of the data you've provided in the augmented manifest. You can either train or\ntest this data. If you don't specify, the default is train.\nTRAIN - all of the documents in the manifest will be used for training. If no test\ndocuments are provided, Amazon Comprehend will automatically reserve a portion of the training\ndocuments for testing.\nTEST - all of the documents in the manifest will be used for testing.\n*Required*: No\n*Type*: String\n*Allowed values*: `TRAIN | TEST...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TRAIN", "TEST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-split", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Comprehend::DocumentClassifier.DocumentClassifierDocuments": { "MarkdownDocumentation": "`AWS::Comprehend::DocumentClassifier.DocumentClassifierDocuments`\n\nThe location of the training documents. This parameter is required in a request to create a semi-structured document classification model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html", "Properties": { "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe S3 URI location of the training documents specified in the S3Uri CSV file.\n*Required*: Yes\n*Type*: String\n*Pattern*: `s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html#cfn-comprehend-documentclassifier-documentclassifierdocuments-s3uri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TestS3Uri": { "MarkdownDocumentation": "`TestS3Uri`\n\nThe S3 URI location of the test documents included in the TestS3Uri CSV file.\nThis field is not required if you do not specify a test CSV file.\n*Required*: No\n*Type*: String\n*Pattern*: `s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html#cfn-comprehend-documentclassifier-documentclassifierdocuments-tests3uri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Comprehend::DocumentClassifier.DocumentClassifierInputDataConfig": { "MarkdownDocumentation": "`AWS::Comprehend::DocumentClassifier.DocumentClassifierInputDataConfig`\n\nThe input properties for training a document classifier.\nFor more information on how the input file is formatted, see\n[Preparing training data](https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in the Comprehend Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html", "Properties": { "DocumentReaderConfig": { "MarkdownDocumentation": "`DocumentReaderConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [DocumentReaderConfig](./aws-properties-comprehend-documentclassifier-documentreaderconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documentreaderconfig", "UpdateType": "Immutable", "Required": false, "Type": "DocumentReaderConfig" }, "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API\nendpoint that you are calling. The URI can point to a single input file or it can provide the\nprefix for a collection of input files.\nFor example, if you use the URI `S3://bucketName/prefix`, if the prefix is a\nsingle file, Amazon Comprehend uses that file as input. If more than one file begins with the\nprefix, Amazon Comprehend uses all of them as input.\nThis parameter is required if you set `DataFormat` to\n`COMPREHEND_CSV`.\n*Required*: No\n*Type*: String\n*Pattern*: `s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-s3uri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Documents": { "MarkdownDocumentation": "`Documents`\n\nThe S3 location of the training documents.\nThis parameter is required in a request to create a native document model.\n*Required*: No\n*Type*: [DocumentClassifierDocuments](./aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documents", "UpdateType": "Immutable", "Required": false, "Type": "DocumentClassifierDocuments" }, "DataFormat": { "MarkdownDocumentation": "`DataFormat`\n\nThe format of your training data:\n* `COMPREHEND_CSV`: A two-column CSV file, where labels are provided in the\n first column, and documents are provided in the second. If you use this value, you must\n provide the `S3Uri` parameter in your request.\n* `AUGMENTED_MANIFEST`: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its associated labels.\n \n If you use this value, you must provide the `AugmentedManifests` parameter\n in your request.\nIf you don't specify a value, Amazon Comprehend uses `COMPREHEND_CSV` as the\ndefault.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMPREHEND_CSV | AUGMENTED_...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "COMPREHEND_CSV", "AUGMENTED_MANIFEST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-dataformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DocumentType": { "MarkdownDocumentation": "`DocumentType`\n\nThe type of input documents for training the model. Provide plain-text documents to create a plain-text model, and\nprovide semi-structured documents to create a native document model.\n*Required*: No\n*Type*: String\n*Allowed values*: `PLAIN_TEXT_DOCUMENT | SEMI_...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documenttype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AugmentedManifests": { "MarkdownDocumentation": "`AugmentedManifests`\n\nA list of augmented manifest files that provide training data for your custom model. An\naugmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\nTruth.\nThis parameter is required if you set `DataFormat` to\n`AUGMENTED_MANIFEST`.\n*Required*: No\n*Type*: Array of [AugmentedManifestsListItem](./aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-augmentedmanifests", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AugmentedManifestsListItem", "DuplicatesAllowed": false }, "LabelDelimiter": { "MarkdownDocumentation": "`LabelDelimiter`\n\nIndicates the delimiter used to separate each label for training a multi-label classifier.\nThe default delimiter between labels is a pipe (|). You can use a different character as a\ndelimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the\ntraining documents use a delimiter other than the default or the delimiter you specify, the\nlabels on that line will be combined to make a single unique label, such as\nLABELLABELLABEL.\n*Required*: No\n*Type*: String\n*Pattern*: `^[ ~!@#$%^*\\-_+=|\\\\:;\\t>?/]$`\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-labeldelimiter", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TestS3Uri": { "MarkdownDocumentation": "`TestS3Uri`\n\nThis specifies the Amazon S3 location that contains the test annotations for the document classifier.\nThe URI must be in the same AWS Region as the API endpoint that you are calling.\n*Required*: No\n*Type*: String\n*Pattern*: `s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-tests3uri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Comprehend::DocumentClassifier.DocumentClassifierOutputDataConfig": { "MarkdownDocumentation": "`AWS::Comprehend::DocumentClassifier.DocumentClassifierOutputDataConfig`\n\nProvide the location for output data from a custom classifier job. This field is mandatory\nif you are training a native document model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\noutput results from an analysis job. The KmsKeyId can be one of the following formats:\n* KMS Key ID: `\"1234abcd-12ab-34cd-56ef-1234567890ab\"`\n* Amazon Resource Name (ARN) of a KMS Key:\n `\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"`\n* KMS Key Alias: `\"alias/ExampleAlias\"`\n* ARN of a KMS Key Alias:\n `\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifieroutputdataconfig-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nWhen you use the `OutputDataConfig` object while creating a custom\nclassifier, you specify the Amazon S3 location where you want to write the confusion matrix\nand other output files.\nThe URI must be in the same Region as the API endpoint that you are calling. The location is\nused as the prefix for the actual location of this output file.\nWhen the custom classifier job is finished, the service creates the output file in a\ndirectory specific to the job. The `S3Uri` field contains the location of the\noutput file, called `output.tar.gz`. It is a compressed archive that contains the\nconfusion matrix.\n*Required*: No\n*Type*: String\n*Pattern*: `s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifieroutputdataconfig-s3uri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Comprehend::DocumentClassifier.DocumentReaderConfig": { "MarkdownDocumentation": "`AWS::Comprehend::DocumentClassifier.DocumentReaderConfig`\n\nProvides configuration parameters to override the default actions for extracting text from PDF documents and image files.\nBy default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:\n* **Word files** - Amazon Comprehend parser extracts the text.\n* **Digital PDF files** - Amazon Comprehend parser extracts the text.\n* **Image files and scanned PDF files** - Amazon Comprehend uses the Amazon Textract `DetectDocumentText`\n API to extract the text.\n`DocumentReaderConfig` does not apply to plain text files or Word files.\nFor image files and PDF documents, you can override these default actions using the fields listed below.\nFor more information, see [Setting text extraction options](https://docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html) in the Comprehend Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html", "Properties": { "FeatureTypes": { "MarkdownDocumentation": "`FeatureTypes`\n\nSpecifies the type of Amazon Textract features to apply. If you chose `TEXTRACT_ANALYZE_DOCUMENT`\nas the read action, you must specify one or both of the following values:\n* `TABLES` - Returns additional information about any tables that are detected in the input document.\n* `FORMS` - Returns additional information about any forms that are detected in the input document.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `TABLES | FORMS...`\n*Minimum*: `1`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TABLES", "FORMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-featuretypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "DocumentReadMode": { "MarkdownDocumentation": "`DocumentReadMode`\n\nDetermines the text extraction actions for PDF files. Enter one of the following values:\n* `SERVICE_DEFAULT` - use the Amazon Comprehend service defaults for PDF files.\n* `FORCE_DOCUMENT_READ_ACTION` - Amazon Comprehend uses the Textract API specified by\n DocumentReadAction for all PDF files, including digital PDF files.\n*Required*: No\n*Type*: String\n*Allowed values*: `SERVICE_DEFAULT | FORCE_DOC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-documentreadmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DocumentReadAction": { "MarkdownDocumentation": "`DocumentReadAction`\n\nThis field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.\nEnter one of the following values:\n* `TEXTRACT_DETECT_DOCUMENT_TEXT` - The Amazon Comprehend service uses the `DetectDocumentText`\n API operation.\n* `TEXTRACT_ANALYZE_DOCUMENT` - The Amazon Comprehend service uses the `AnalyzeDocument`\n API operation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEXTRACT_DETECT_DOCUMENT_TE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-documentreadaction", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Comprehend::DocumentClassifier.VpcConfig": { "MarkdownDocumentation": "`AWS::Comprehend::DocumentClassifier.VpcConfig`\n\nConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing\nthe resources you are using for the job. For more information, see [Amazon\nVPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html", "Properties": { "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe ID for each subnet being used in your private VPC. This subnet is a subset of the a\nrange of IPv4 addresses used by the VPC and is specific to a given availability zone in the\nVPC\u2019s Region. This ID number is preceded by \"subnet-\", for instance:\n\"subnet-04ccf456919e69055\". For more information, see [VPCs and\nSubnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html).\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `32 | 16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html#cfn-comprehend-documentclassifier-vpcconfig-subnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe ID number for a security group on an instance of your private VPC. Security groups on\nyour VPC function serve as a virtual firewall to control inbound and outbound traffic and\nprovides security for the resources that you\u2019ll be accessing on the VPC. This ID number is\npreceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see [Security\nGroups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html).\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `32 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html#cfn-comprehend-documentclassifier-vpcconfig-securitygroupids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Comprehend::Flywheel.DataSecurityConfig": { "MarkdownDocumentation": "`AWS::Comprehend::Flywheel.DataSecurityConfig`\n\nData security configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html", "Properties": { "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing\nthe resources you are using for the job. For more information, see [Amazon\nVPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-comprehend-flywheel-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html#cfn-comprehend-flywheel-datasecurityconfig-vpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfig" }, "VolumeKmsKeyId": { "MarkdownDocumentation": "`VolumeKmsKeyId`\n\nID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html#cfn-comprehend-flywheel-datasecurityconfig-volumekmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ModelKmsKeyId": { "MarkdownDocumentation": "`ModelKmsKeyId`\n\nID for the AWS KMS key that Amazon Comprehend uses to encrypt\ntrained custom models. The ModelKmsKeyId can be either of the following formats:\n* KMS Key ID: `\"1234abcd-12ab-34cd-56ef-1234567890ab\"`\n* Amazon Resource Name (ARN) of a KMS Key:\n `\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html#cfn-comprehend-flywheel-datasecurityconfig-modelkmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataLakeKmsKeyId": { "MarkdownDocumentation": "`DataLakeKmsKeyId`\n\nID for the AWS KMS key that Amazon Comprehend uses to encrypt the data in the data lake.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html#cfn-comprehend-flywheel-datasecurityconfig-datalakekmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Comprehend::Flywheel.DocumentClassificationConfig": { "MarkdownDocumentation": "`AWS::Comprehend::Flywheel.DocumentClassificationConfig`\n\nConfiguration required for a document classification model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-documentclassificationconfig.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nClassification mode indicates whether the documents are `MULTI_CLASS` or `MULTI_LABEL`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_CLASS | MULTI_LABEL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "MULTI_CLASS", "MULTI_LABEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-documentclassificationconfig.html#cfn-comprehend-flywheel-documentclassificationconfig-mode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Labels": { "MarkdownDocumentation": "`Labels`\n\nOne or more labels to associate with the custom classifier.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `5000 | 1000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-documentclassificationconfig.html#cfn-comprehend-flywheel-documentclassificationconfig-labels", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Comprehend::Flywheel.EntityRecognitionConfig": { "MarkdownDocumentation": "`AWS::Comprehend::Flywheel.EntityRecognitionConfig`\n\nConfiguration required for an entity recognition model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-entityrecognitionconfig.html", "Properties": { "EntityTypes": { "MarkdownDocumentation": "`EntityTypes`\n\nUp to 25 entity types that the model is trained to recognize.\n*Required*: No\n*Type*: Array of [EntityTypesListItem](./aws-properties-comprehend-flywheel-entitytypeslistitem.html)\n*Minimum*: `1`\n*Maximum*: `25`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-entityrecognitionconfig.html#cfn-comprehend-flywheel-entityrecognitionconfig-entitytypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "EntityTypesListItem", "DuplicatesAllowed": false } } }, "AWS::Comprehend::Flywheel.EntityTypesListItem": { "MarkdownDocumentation": "`AWS::Comprehend::Flywheel.EntityTypesListItem`\n\nAn entity type within a labeled training dataset that Amazon Comprehend uses to train a\ncustom entity recognizer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-entitytypeslistitem.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nAn entity type within a labeled training dataset that Amazon Comprehend uses to train a\ncustom entity recognizer.\nEntity types must not contain the following invalid characters: \\n (line break), \\\\n\n(escaped line break, \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t\n(escaped tab), and , (comma).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?![^\\n\\r\\t,]*\\\\n|\\\\r|\\\\t)[^\\n\\r\\t,]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-entitytypeslistitem.html#cfn-comprehend-flywheel-entitytypeslistitem-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Comprehend::Flywheel.TaskConfig": { "MarkdownDocumentation": "`AWS::Comprehend::Flywheel.TaskConfig`\n\nConfiguration about the model associated with a flywheel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-taskconfig.html", "Properties": { "LanguageCode": { "MarkdownDocumentation": "`LanguageCode`\n\nLanguage code for the language that the model supports.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `en | es | fr | it | de | pt...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "en", "es", "fr", "it", "de", "pt" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-taskconfig.html#cfn-comprehend-flywheel-taskconfig-languagecode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DocumentClassificationConfig": { "MarkdownDocumentation": "`DocumentClassificationConfig`\n\nConfiguration required for a document classification model.\n*Required*: No\n*Type*: [DocumentClassificationConfig](./aws-properties-comprehend-flywheel-documentclassificationconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-taskconfig.html#cfn-comprehend-flywheel-taskconfig-documentclassificationconfig", "UpdateType": "Immutable", "Required": false, "Type": "DocumentClassificationConfig" }, "EntityRecognitionConfig": { "MarkdownDocumentation": "`EntityRecognitionConfig`\n\nConfiguration required for an entity recognition model.\n*Required*: No\n*Type*: [EntityRecognitionConfig](./aws-properties-comprehend-flywheel-entityrecognitionconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-taskconfig.html#cfn-comprehend-flywheel-taskconfig-entityrecognitionconfig", "UpdateType": "Immutable", "Required": false, "Type": "EntityRecognitionConfig" } } }, "AWS::Comprehend::Flywheel.VpcConfig": { "MarkdownDocumentation": "`AWS::Comprehend::Flywheel.VpcConfig`\n\nConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing\nthe resources you are using for the job. For more information, see [Amazon\nVPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-vpcconfig.html", "Properties": { "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe ID for each subnet being used in your private VPC. This subnet is a subset of the a\nrange of IPv4 addresses used by the VPC and is specific to a given availability zone in the\nVPC\u2019s Region. This ID number is preceded by \"subnet-\", for instance:\n\"subnet-04ccf456919e69055\". For more information, see [VPCs and\nSubnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html).\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `32 | 16`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-vpcconfig.html#cfn-comprehend-flywheel-vpcconfig-subnets", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe ID number for a security group on an instance of your private VPC. Security groups on\nyour VPC function serve as a virtual firewall to control inbound and outbound traffic and\nprovides security for the resources that you\u2019ll be accessing on the VPC. This ID number is\npreceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see [Security\nGroups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html).\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `32 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-vpcconfig.html#cfn-comprehend-flywheel-vpcconfig-securitygroupids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Config::ConfigRule.Compliance": { "MarkdownDocumentation": "`AWS::Config::ConfigRule.Compliance`\n\nIndicates whether an AWS resource or AWS Config rule is\ncompliant and provides the number of contributors that affect the\ncompliance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-compliance.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nIndicates whether an AWS resource or AWS Config rule is\ncompliant.\nA resource is compliant if it complies with all of the AWS Config rules that evaluate it. A resource is noncompliant if it does\nnot comply with one or more of these rules.\nA rule is compliant if all of the resources that the rule\nevaluates comply with it. A rule is noncompliant if any of these\nresources do not comply.\nAWS Config returns the `INSUFFICIENT_DATA` value\nwhen no evaluation results are available for the AWS resource or AWS Config rule.\nFor the `Compliance` data type, AWS Config supports\nonly `COMPLIANT`, `NON_COMPLIANT`, and\n`INSUFFICIENT_DATA` values. AWS Config does not\nsupport the `NOT_APPLICABLE` value for the\n`Compliance` data type.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMPLIANT | NON_COMPLIANT |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-compliance.html#cfn-config-configrule-compliance-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Config::ConfigRule.CustomPolicyDetails": { "MarkdownDocumentation": "`AWS::Config::ConfigRule.CustomPolicyDetails`\n\nProvides the CustomPolicyDetails, the rule owner (`AWS` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules), the rule\nidentifier, and the events that cause the evaluation of your AWS\nresources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html", "Properties": { "EnableDebugLogDelivery": { "MarkdownDocumentation": "`EnableDebugLogDelivery`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html#cfn-config-configrule-custompolicydetails-enabledebuglogdelivery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PolicyText": { "MarkdownDocumentation": "`PolicyText`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html#cfn-config-configrule-custompolicydetails-policytext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyRuntime": { "MarkdownDocumentation": "`PolicyRuntime`\n\nThe 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\nRepository](https://github.com/aws-cloudformation/cloudformation-guard).\n*Required*: No\n*Type*: String\n*Pattern*: `guard\\-2\\.x\\.x`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html#cfn-config-configrule-custompolicydetails-policyruntime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Config::ConfigRule.EvaluationModeConfiguration": { "MarkdownDocumentation": "`AWS::Config::ConfigRule.EvaluationModeConfiguration`\n\nThe configuration object for AWS Config rule evaluation mode. The supported valid values are Detective or Proactive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-evaluationmodeconfiguration.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe mode of an evaluation. The valid values are Detective or Proactive.\n*Required*: No\n*Type*: String\n*Allowed values*: `DETECTIVE | PROACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DETECTIVE", "PROACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-evaluationmodeconfiguration.html#cfn-config-configrule-evaluationmodeconfiguration-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Config::ConfigRule.Scope": { "MarkdownDocumentation": "`AWS::Config::ConfigRule.Scope`\n\nDefines which resources trigger an evaluation for an AWS Config\nrule. The scope can include one or more resource types, a\ncombination of a tag key and value, or a combination of one resource\ntype and one resource ID. Specify a scope to constrain which\nresources trigger an evaluation for a rule. Otherwise, evaluations\nfor the rule are triggered when any resource in your recording group\nchanges in configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html", "Properties": { "ComplianceResourceId": { "MarkdownDocumentation": "`ComplianceResourceId`\n\nThe ID of the only AWS resource that you want to trigger an\nevaluation for the rule. If you specify a resource ID, you must\nspecify one resource type for\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagKey": { "MarkdownDocumentation": "`TagKey`\n\nThe tag key that is applied to only those AWS resources that\nyou want to trigger an evaluation for the rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComplianceResourceTypes": { "MarkdownDocumentation": "`ComplianceResourceTypes`\n\nThe resource types of only those AWS resources that you want to\ntrigger an evaluation for the rule. You can only specify one type if\nyou also specify a resource ID for\n`ComplianceResourceId`.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourcetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "TagValue": { "MarkdownDocumentation": "`TagValue`\n\nThe tag value applied to only those AWS resources that you want\nto trigger an evaluation for the rule. If you specify a value for\n`TagValue`, you must also specify a value for\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Config::ConfigRule.Source": { "MarkdownDocumentation": "`AWS::Config::ConfigRule.Source`\n\nProvides the CustomPolicyDetails, the rule owner (`AWS` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules), the rule\nidentifier, and the events that cause the evaluation of your AWS\nresources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html", "Properties": { "Owner": { "MarkdownDocumentation": "`Owner`\n\nIndicates whether AWS or the customer owns and manages the AWS Config rule.\nAWS 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*.\nAWS 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*: `CUSTOM_LAMBDA | AWS | CUSTO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CUSTOM_LAMBDA", "AWS", "CUSTOM_POLICY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-owner", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomPolicyDetails": { "MarkdownDocumentation": "`CustomPolicyDetails`\n\nProvides 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-custompolicydetails", "UpdateType": "Mutable", "Required": false, "Type": "CustomPolicyDetails" }, "SourceIdentifier": { "MarkdownDocumentation": "`SourceIdentifier`\n\nFor AWS Config Managed rules, a predefined identifier from a\nlist. For example, `IAM_PASSWORD_POLICY` is a managed\nrule. 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\n(ARN) of the rule's AWS Lambda function, such as\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-sourceidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceDetails": { "MarkdownDocumentation": "`SourceDetails`\n\nProvides 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*: Array of [SourceDetail](./aws-properties-config-configrule-sourcedetail.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-sourcedetails", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SourceDetail", "DuplicatesAllowed": false } } }, "AWS::Config::ConfigRule.SourceDetail": { "MarkdownDocumentation": "`AWS::Config::ConfigRule.SourceDetail`\n\nProvides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also\nprovides the frequency with which you want AWS Config to run\nevaluations for the rule if the trigger type is periodic. You can\nspecify the parameter values for `SourceDetail` only for\ncustom rules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-sourcedetail.html", "Properties": { "EventSource": { "MarkdownDocumentation": "`EventSource`\n\nThe source of the event, such as an AWS service, that triggers\nAWS 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)\n", "RefReturnValue": "", "AllowedValues": [ "aws.config" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-sourcedetail.html#cfn-config-configrule-sourcedetail-eventsource", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaximumExecutionFrequency": { "MarkdownDocumentation": "`MaximumExecutionFrequency`\n\nThe frequency at which you want AWS Config to run evaluations\nfor a custom rule with a periodic trigger. If you specify a value\nfor `MaximumExecutionFrequency`, then\n`MessageType` must use the\n`ScheduledNotification` value.\n###### Note\nBy default, rules with a periodic trigger are evaluated\nevery 24 hours. To change the frequency, specify a valid value\nfor the `MaximumExecutionFrequency`\nparameter.\nBased on the valid value you choose, AWS Config runs\nevaluations once for each valid value. For example, if you\nchoose `Three_Hours`, AWS Config runs evaluations\nonce every three hours. In this case, `Three_Hours`\nis the frequency of this rule.\n*Required*: No\n*Type*: String\n*Allowed values*: `One_Hour | Three_Hours | Si...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-sourcedetail.html#cfn-config-configrule-sourcedetail-maximumexecutionfrequency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MessageType": { "MarkdownDocumentation": "`MessageType`\n\nThe type of notification that triggers AWS Config to run an\nevaluation for a rule. You can specify the following notification\ntypes:\n* `ConfigurationItemChangeNotification` - Triggers\n an evaluation when AWS Config delivers a configuration item\n as a result of a resource change.\n* `OversizedConfigurationItemChangeNotification`\n - Triggers an evaluation when AWS Config delivers an\n oversized configuration item. AWS Config may generate this\n notification type when a resource changes and the\n notification exceeds the maximum size allowed by Amazon\n SNS.\n* `ScheduledNotification` - Triggers a\n periodic evaluation at the frequency specified for\n `MaximumExecutionFrequency`.\n* `ConfigurationSnapshotDeliveryCompleted` -\n Triggers a periodic evaluation when AWS Config delivers a\n configuration snapshot.\nIf you want your custom rule to be triggered by configuration\nchanges, specify two SourceDetail objects, one for\n`ConfigurationItemChangeNotification` and one for\n`OversizedConfigurationItemChangeNotification`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ConfigurationItemChangeNoti...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ConfigurationItemChangeNotification", "ConfigurationSnapshotDeliveryCompleted", "ScheduledNotification", "OversizedConfigurationItemChangeNotification" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-sourcedetail.html#cfn-config-configrule-sourcedetail-messagetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Config::ConfigurationAggregator.AccountAggregationSource": { "MarkdownDocumentation": "`AWS::Config::ConfigurationAggregator.AccountAggregationSource`\n\nA collection of accounts and regions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html", "Properties": { "AllAwsRegions": { "MarkdownDocumentation": "`AllAwsRegions`\n\nIf true, aggregate existing AWS Config regions and future\nregions.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-allawsregions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AwsRegions": { "MarkdownDocumentation": "`AwsRegions`\n\nThe source regions being aggregated.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-awsregions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AccountIds": { "MarkdownDocumentation": "`AccountIds`\n\nThe 12-digit account ID of the account being aggregated.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-accountids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Config::ConfigurationAggregator.OrganizationAggregationSource": { "MarkdownDocumentation": "`AWS::Config::ConfigurationAggregator.OrganizationAggregationSource`\n\nThis object contains regions to set up the aggregator and an IAM\nrole to retrieve organization details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html", "Properties": { "AllAwsRegions": { "MarkdownDocumentation": "`AllAwsRegions`\n\nIf true, aggregate existing AWS Config regions and future\nregions.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-allawsregions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AwsRegions": { "MarkdownDocumentation": "`AwsRegions`\n\nThe source regions being aggregated.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-awsregions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nARN of the IAM role used to retrieve AWS Organizations details\nassociated with the aggregator 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Config::ConfigurationRecorder.ExclusionByResourceTypes": { "MarkdownDocumentation": "`AWS::Config::ConfigurationRecorder.ExclusionByResourceTypes`\n\nSpecifies whether the configuration recorder excludes certain resource types from being recorded.\nUse the `ResourceTypes` field to enter a comma-separated list of resource types you want to exclude from recording.\nBy default, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder,\nincluding global resource types, AWS Config starts recording resources of that type automatically.\n###### Note\n**How to use the exclusion recording strategy**\nTo use this option, you must set the `useOnly`\nfield of [RecordingStrategy](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html)\nto `EXCLUSION_BY_RESOURCE_TYPES`.\nAWS Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.\n**Global resource types and the exclusion recording strategy** \nUnless specifically listed as exclusions,\n`AWS::RDS::GlobalCluster` will be recorded automatically in all supported AWS Config Regions were the configuration recorder is enabled.\nIAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where AWS Config was available before February 2022.\nYou cannot be record the global IAM resouce types in Regions supported by AWS Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\n* Asia Pacific (Hyderabad)\n* Asia Pacific (Melbourne)\n* Canada West (Calgary)\n* Europe (Spain)\n* Europe (Zurich)\n* Israel (Tel Aviv)\n* Middle East (UAE)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html", "Properties": { "ResourceTypes": { "MarkdownDocumentation": "`ResourceTypes`\n\nA comma-separated list of resource types to exclude from recording by the configuration recorder.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html#cfn-config-configurationrecorder-exclusionbyresourcetypes-resourcetypes", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": true, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::Config::ConfigurationRecorder.RecordingGroup": { "MarkdownDocumentation": "`AWS::Config::ConfigurationRecorder.RecordingGroup`\n\nSpecifies which resource types AWS Config\nrecords for configuration changes. By default, AWS Config records configuration changes for all current and future supported resource types in the AWS Region where you have enabled AWS Config,\nexcluding the global IAM resource types: IAM users, groups, roles, and customer managed policies.\nIn the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types.\nFor a list of supported resource types, see [Supported Resource Types](https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) in the *AWS Config developer guide*.\nIf you don't want AWS Config to record all current and future supported resource types (excluding the global IAM resource types), use one of the following recording strategies:\n1. **Record all current and future resource types with exclusions** (`EXCLUSION_BY_RESOURCE_TYPES`), or\n2. **Record specific resource types** (`INCLUSION_BY_RESOURCE_TYPES`).\nIf you use the recording strategy to **Record all current and future resource types** (`ALL_SUPPORTED_RESOURCE_TYPES`),\nyou can use the flag `IncludeGlobalResourceTypes` to include the global IAM resource types in your recording.\n###### Important\n**Aurora global clusters are recorded in all enabled Regions**\nThe `AWS::RDS::GlobalCluster` resource type\nwill be recorded in all supported AWS Config Regions where the configuration recorder is enabled.\nIf you do not want to record `AWS::RDS::GlobalCluster` in all enabled Regions, use the `EXCLUSION_BY_RESOURCE_TYPES` or `INCLUSION_BY_RESOURCE_TYPES` recording strategy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html", "Properties": { "AllSupported": { "MarkdownDocumentation": "`AllSupported`\n\nSpecifies whether AWS Config records configuration changes for all supported resource types, excluding the global IAM resource types.\nIf you set this field to `true`, when AWS Config\nadds support for a new resource type, AWS Config starts recording resources of that type automatically.\nIf you set this field to `true`,\nyou cannot enumerate specific resource types to record in the `resourceTypes` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html), or to exclude in the `resourceTypes` field of [ExclusionByResourceTypes](https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html).\n###### Note\n**Region availability**\nCheck [Resource Coverage by Region Availability](https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html)\nto see if a resource type is supported in the AWS Region where you set up AWS Config.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-allsupported", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "ExclusionByResourceTypes": { "MarkdownDocumentation": "`ExclusionByResourceTypes`\n\nAn object that specifies how AWS Config excludes resource types from being recorded by the configuration recorder.\nTo use this option, you must set the `useOnly` field of [AWS::Config::ConfigurationRecorder RecordingStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html) to `EXCLUSION_BY_RESOURCE_TYPES`.\n*Required*: No\n*Type*: [ExclusionByResourceTypes](./aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-exclusionbyresourcetypes", "Required": false, "Type": "ExclusionByResourceTypes", "UpdateType": "Mutable" }, "IncludeGlobalResourceTypes": { "MarkdownDocumentation": "`IncludeGlobalResourceTypes`\n\nThis option is a bundle which only applies to the global IAM resource types:\nIAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded\nby AWS Config in Regions where AWS Config was available before February 2022.\nYou cannot be record the global IAM resouce types in Regions supported by AWS Config after February 2022.\nThis list where you cannot record the global IAM resource types includes the following Regions:\n* Asia Pacific (Hyderabad)\n* Asia Pacific (Melbourne)\n* Canada West (Calgary)\n* Europe (Spain)\n* Europe (Zurich)\n* Israel (Tel Aviv)\n* Middle East (UAE)\n###### Important\n**Aurora global clusters are recorded in all enabled Regions**\nThe `AWS::RDS::GlobalCluster` resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled, even if `IncludeGlobalResourceTypes` is set to `false`.\nThe `IncludeGlobalResourceTypes` option is a bundle which only applies to IAM users, groups, roles, and customer managed policies.\nIf you do not want to record `AWS::RDS::GlobalCluster` in all enabled Regions, use one of the following recording strategies:\n1. **Record all current and future resource types with exclusions** (`EXCLUSION_BY_RESOURCE_TYPES`), or\n2. **Record specific resource types** (`INCLUSION_BY_RESOURCE_TYPES`).\nFor more information, see [Selecting Which Resources are Recorded](https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all) in the *AWS Config developer guide*.\n\n###### Important\n**IncludeGlobalResourceTypes and the exclusion recording strategy**\nThe `IncludeGlobalResourceTypes` field has no impact on the `EXCLUSION_BY_RESOURCE_TYPES` recording strategy.\nThis means that the global IAM resource types (IAM users, groups, roles, and customer managed policies) will\nnot be automatically added as exclusions for `ExclusionByResourceTypes` when `IncludeGlobalResourceTypes` is set to `false`.\nThe `IncludeGlobalResourceTypes` field should only be used to modify the `AllSupported` field, as the default for\nthe `AllSupported` field is to record configuration changes for all supported resource types excluding the global\nIAM resource types. To include the global IAM resource types when `AllSupported` is set to `true`, make sure to set `IncludeGlobalResourceTypes` to `true`.\nTo exclude the global IAM resource types for the `EXCLUSION_BY_RESOURCE_TYPES` recording strategy, you need to manually add them to the `ResourceTypes` field of `ExclusionByResourceTypes`.\n\n###### Note\n**Required and optional fields**\nBefore you set this field to `true`,\nset the `AllSupported` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) to\n`true`. Optionally, you can set the `useOnly` field of [RecordingStrategy](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) to `ALL_SUPPORTED_RESOURCE_TYPES`.\n\n###### Note\n**Overriding fields**\nIf you set this field to `false` but list global IAM resource types in the `ResourceTypes` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html),\nAWS Config will still record configuration changes for those specified resource types *regardless* of if you set the `IncludeGlobalResourceTypes` field to false.\nIf you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the `ResourceTypes` field\nin addition to setting the `IncludeGlobalResourceTypes` field 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-includeglobalresourcetypes", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "RecordingStrategy": { "MarkdownDocumentation": "`RecordingStrategy`\n\nAn object that specifies the recording strategy for the configuration recorder.\n* If you set the `useOnly` field of [RecordingStrategy](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) to `ALL_SUPPORTED_RESOURCE_TYPES`, AWS Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the `AllSupported` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) to `true`. When AWS Config adds support for a new resource type, AWS Config automatically starts recording resources of that type.\n* If you set the `useOnly` field of [RecordingStrategy](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) to `INCLUSION_BY_RESOURCE_TYPES`, AWS Config records configuration changes for only the resource types you specify in the `ResourceTypes` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html).\n* If you set the `useOnly` field of [RecordingStrategy](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) to `EXCLUSION_BY_RESOURCE_TYPES`, AWS Config records configuration changes for all supported resource types\n except the resource types that you specify to exclude from being recorded in the `ResourceTypes` field of [ExclusionByResourceTypes](https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html).\n###### Note\n**Required and optional fields**\nThe `recordingStrategy` field is optional when you set the\n`AllSupported` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) to `true`.\nThe `recordingStrategy` field is optional when you list resource types in the\n`ResourceTypes` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html).\nThe `recordingStrategy` field is required if you list resource types to exclude from recording in the `ResourceTypes` field of [ExclusionByResourceTypes](https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html).\n\n###### Note\n**Overriding fields**\nIf you choose `EXCLUSION_BY_RESOURCE_TYPES` for the recording strategy, the `ExclusionByResourceTypes` field will override other properties in the request.\nFor example, even if you set `IncludeGlobalResourceTypes` to false, global IAM resource types will still be automatically\nrecorded in this option unless those resource types are specifically listed as exclusions in the `ResourceTypes` field of `ExclusionByResourceTypes`.\n\n###### Note\n**Global resources types and the resource exclusion recording strategy**\nBy default, if you choose the `EXCLUSION_BY_RESOURCE_TYPES` recording strategy,\nwhen AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\nAWS Config starts recording resources of that type automatically.\nUnless specifically listed as exclusions,\n`AWS::RDS::GlobalCluster` will be recorded automatically in all supported AWS Config Regions were the configuration recorder is enabled.\nIAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where AWS Config was available before February 2022.\nYou cannot be record the global IAM resouce types in Regions supported by AWS Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\n* Asia Pacific (Hyderabad)\n* Asia Pacific (Melbourne)\n* Canada West (Calgary)\n* Europe (Spain)\n* Europe (Zurich)\n* Israel (Tel Aviv)\n* Middle East (UAE)\n*Required*: No\n*Type*: [RecordingStrategy](./aws-properties-config-configurationrecorder-recordingstrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-recordingstrategy", "Required": false, "Type": "RecordingStrategy", "UpdateType": "Mutable" }, "ResourceTypes": { "MarkdownDocumentation": "`ResourceTypes`\n\nA comma-separated list that specifies which resource types AWS Config\nrecords.\nFor a list of valid `ResourceTypes` values, see the\n**Resource Type Value** column in\n[Supported AWS resource Types](https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) in the *AWS Config developer guide*.\n###### Note\n**Required and optional fields**\nOptionally, you can set the `useOnly` field of [RecordingStrategy](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) to `INCLUSION_BY_RESOURCE_TYPES`.\nTo record all configuration changes,\nset the `AllSupported` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) to\n`true`, and either omit this field or don't specify any resource types in this field. If you set the `AllSupported` field to `false` and specify values for `ResourceTypes`,\nwhen AWS Config adds support for a new type of resource,\nit will not record resources of that type unless you manually add that type to your recording group.\n\n###### Note\n**Region availability**\nBefore specifying a resource type for AWS Config to track,\ncheck [Resource Coverage by Region Availability](https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html)\nto see if the resource type is supported in the AWS Region where you set up AWS Config.\nIf a resource type is supported by AWS Config in at least one Region,\nyou can enable the recording of that resource type in all Regions supported by AWS Config,\neven if the specified resource type is not supported in the AWS Region where you set up AWS Config.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-resourcetypes", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::Config::ConfigurationRecorder.RecordingMode": { "MarkdownDocumentation": "`AWS::Config::ConfigurationRecorder.RecordingMode`\n\nSpecifies the default recording frequency that AWS Config uses to record configuration changes.\nAWS Config supports *Continuous recording* and *Daily recording*.\n* Continuous recording allows you to record configuration changes continuously whenever a change occurs.\n* Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it\u2019s different from the previous CI recorded.\n###### Note\nAWS Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager,\nit is recommended that you set the recording frequency to Continuous.\nYou can also override the recording frequency for specific resource types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmode.html", "Properties": { "RecordingFrequency": { "MarkdownDocumentation": "`RecordingFrequency`\n\nThe default recording frequency that AWS Config uses to record configuration changes.\n###### Important\nDaily recording cannot be specified for the following resource types:\n* `AWS::Config::ResourceCompliance`\n* `AWS::Config::ConformancePackCompliance`\n* `AWS::Config::ConfigurationRecorder`\nFor the **allSupported** (`ALL_SUPPORTED_RESOURCE_TYPES`) recording strategy, these resource types will be set to Continuous recording.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CONTINUOUS | DAILY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONTINUOUS", "DAILY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmode.html#cfn-config-configurationrecorder-recordingmode-recordingfrequency", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "RecordingModeOverrides": { "MarkdownDocumentation": "`RecordingModeOverrides`\n\nAn array of `recordingModeOverride` objects for you to specify your overrides for the recording mode.\nThe `recordingModeOverride` object in the `recordingModeOverrides` array consists of three fields: a `description`, the new `recordingFrequency`, and an array of `resourceTypes` to override.\n*Required*: No\n*Type*: Array of [RecordingModeOverride](./aws-properties-config-configurationrecorder-recordingmodeoverride.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmode.html#cfn-config-configurationrecorder-recordingmode-recordingmodeoverrides", "DuplicatesAllowed": false, "ItemType": "RecordingModeOverride", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::Config::ConfigurationRecorder.RecordingModeOverride": { "MarkdownDocumentation": "`AWS::Config::ConfigurationRecorder.RecordingModeOverride`\n\nAn object for you to specify your overrides for the recording mode.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmodeoverride.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description that you provide for the override.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmodeoverride.html#cfn-config-configurationrecorder-recordingmodeoverride-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "RecordingFrequency": { "MarkdownDocumentation": "`RecordingFrequency`\n\nThe recording frequency that will be applied to all the resource types specified in the override.\n* Continuous recording allows you to record configuration changes continuously whenever a change occurs.\n* Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it\u2019s different from the previous CI recorded.\n###### Note\nAWS Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager,\nit is recommended that you set the recording frequency to Continuous.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CONTINUOUS | DAILY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONTINUOUS", "DAILY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmodeoverride.html#cfn-config-configurationrecorder-recordingmodeoverride-recordingfrequency", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "ResourceTypes": { "MarkdownDocumentation": "`ResourceTypes`\n\nA comma-separated list that specifies which resource types AWS Config\nincludes in the override.\n###### Important\nDaily recording cannot be specified for the following resource types:\n* `AWS::Config::ResourceCompliance`\n* `AWS::Config::ConformancePackCompliance`\n* `AWS::Config::ConfigurationRecorder`\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmodeoverride.html#cfn-config-configurationrecorder-recordingmodeoverride-resourcetypes", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": true, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::Config::ConfigurationRecorder.RecordingStrategy": { "MarkdownDocumentation": "`AWS::Config::ConfigurationRecorder.RecordingStrategy`\n\nSpecifies the recording strategy of the configuration recorder.\nValid values include: `ALL_SUPPORTED_RESOURCE_TYPES`, `INCLUSION_BY_RESOURCE_TYPES`, and `EXCLUSION_BY_RESOURCE_TYPES`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html", "Properties": { "UseOnly": { "MarkdownDocumentation": "`UseOnly`\n\nThe recording strategy for the configuration recorder.\n* If you set this option to `ALL_SUPPORTED_RESOURCE_TYPES`, AWS Config records configuration changes for all supported resource types, excluding the global IAM resource types.\n You also must set the `AllSupported` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) to `true`.\n When AWS Config adds support for a new resource type, AWS Config automatically starts recording resources of that type. For a list of supported resource types,\n see [Supported Resource Types](https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) in the *AWS Config developer guide*.\n* If you set this option to `INCLUSION_BY_RESOURCE_TYPES`, AWS Config records\n configuration changes for only the resource types that you specify in the\n `ResourceTypes` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html).\n* If you set this option to `EXCLUSION_BY_RESOURCE_TYPES`, AWS Config records\n configuration changes for all supported resource types, except the resource\n types that you specify to exclude from being recorded in the\n `ResourceTypes` field of [ExclusionByResourceTypes](https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html).\n###### Note\n**Required and optional fields**\nThe `recordingStrategy` field is optional when you set the\n`AllSupported` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) to `true`.\nThe `recordingStrategy` field is optional when you list resource types in the\n`ResourceTypes` field of [RecordingGroup](https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html).\nThe `recordingStrategy` field is required if you list resource types to exclude from recording in the `ResourceTypes` field of [ExclusionByResourceTypes](https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html).\n\n###### Note\n**Overriding fields**\nIf you choose `EXCLUSION_BY_RESOURCE_TYPES` for the recording strategy, the `ExclusionByResourceTypes` field will override other properties in the request.\nFor example, even if you set `IncludeGlobalResourceTypes` to false, global IAM resource types will still be automatically\nrecorded in this option unless those resource types are specifically listed as exclusions in the `ResourceTypes` field of `ExclusionByResourceTypes`.\n\n###### Note\n**Global resource types and the exclusion recording strategy**\nBy default, if you choose the `EXCLUSION_BY_RESOURCE_TYPES` recording strategy,\nwhen AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\nAWS Config starts recording resources of that type automatically.\nUnless specifically listed as exclusions,\n`AWS::RDS::GlobalCluster` will be recorded automatically in all supported AWS Config Regions were the configuration recorder is enabled.\nIAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where AWS Config was available before February 2022.\nYou cannot be record the global IAM resouce types in Regions supported by AWS Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\n* Asia Pacific (Hyderabad)\n* Asia Pacific (Melbourne)\n* Canada West (Calgary)\n* Europe (Spain)\n* Europe (Zurich)\n* Israel (Tel Aviv)\n* Middle East (UAE)\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html#cfn-config-configurationrecorder-recordingstrategy-useonly", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::Config::ConformancePack.ConformancePackInputParameter": { "MarkdownDocumentation": "`AWS::Config::ConformancePack.ConformancePackInputParameter`\n\nInput parameters in the form of key-value pairs for the conformance pack, both of which you define.\nKeys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nAnother 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html#cfn-config-conformancepack-conformancepackinputparameter-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nOne 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html#cfn-config-conformancepack-conformancepackinputparameter-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Config::ConformancePack.TemplateSSMDocumentDetails": { "MarkdownDocumentation": "`AWS::Config::ConformancePack.TemplateSSMDocumentDetails`\n\nThis API allows you to create a conformance pack template with an AWS Systems Manager document (SSM document).\nTo deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the `DocumentName` in the [PutConformancePack API](https://docs.aws.amazon.com/config/latest/APIReference/API_PutConformancePack.html). You can also provide the `DocumentVersion`.\nThe `TemplateSSMDocumentDetails` object contains the name of the SSM document and the version of the SSM document.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html", "Properties": { "DocumentVersion": { "MarkdownDocumentation": "`DocumentVersion`\n\nThe version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version.\n###### Note\nThis field is optional.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html#cfn-config-conformancepack-templatessmdocumentdetails-documentversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DocumentName": { "MarkdownDocumentation": "`DocumentName`\n\nThe name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.\nIf you use the document name, AWS Config checks only your account and AWS Region for the SSM document.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html#cfn-config-conformancepack-templatessmdocumentdetails-documentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Config::DeliveryChannel.ConfigSnapshotDeliveryProperties": { "MarkdownDocumentation": "`AWS::Config::DeliveryChannel.ConfigSnapshotDeliveryProperties`\n\nProvides options for how often AWS Config delivers\nconfiguration snapshots to the Amazon S3 bucket in your delivery\nchannel.\n###### Note\nIf you want to create a rule that triggers evaluations for\nyour resources when AWS Config delivers the configuration\nsnapshot, see the following:\nThe frequency for a rule that triggers evaluations for your\nresources when AWS Config delivers the configuration snapshot is set\nby one of two values, depending on which is less frequent:\n* The value for the `deliveryFrequency`\n parameter within the delivery channel configuration, which\n sets how often AWS Config delivers configuration snapshots.\n This value also sets how often AWS Config invokes\n evaluations for AWS Config rules.\n* The value for the\n `MaximumExecutionFrequency` parameter, which\n sets the maximum frequency with which AWS Config invokes\n evaluations for the rule. For more information, see [ConfigRule](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigRule.html).\nIf the `deliveryFrequency` value is less frequent\nthan the `MaximumExecutionFrequency` value for a rule,\nAWS Config invokes the rule only as often as the\n`deliveryFrequency` value.\n1. For example, you want your rule to run evaluations when\n AWS Config delivers the configuration snapshot.\n2. You specify the `MaximumExecutionFrequency`\n value for `Six_Hours`.\n3. You then specify the delivery channel\n `deliveryFrequency` value for\n `TwentyFour_Hours`.\n4. Because the value for `deliveryFrequency` is\n less frequent than `MaximumExecutionFrequency`,\n AWS Config invokes evaluations for the rule every 24 hours.\nYou should set the `MaximumExecutionFrequency` value\nto be at least as frequent as the `deliveryFrequency`\nvalue. You can view the `deliveryFrequency` value by\nusing the `DescribeDeliveryChannnels` action.\nTo update the `deliveryFrequency` with which AWS Config delivers your configuration snapshots, use the `PutDeliveryChannel` action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html", "Properties": { "DeliveryFrequency": { "MarkdownDocumentation": "`DeliveryFrequency`\n\nThe frequency with which AWS Config delivers configuration\nsnapshots.\n*Required*: No\n*Type*: String\n*Allowed values*: `One_Hour | Three_Hours | Si...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties-deliveryfrequency", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata": { "MarkdownDocumentation": "`AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata`\n\nAn\nobject that specifies metadata for your organization's AWS Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have\ndebug logging enabled, and other custom rule metadata, such as resource type, resource\nID of AWS resource, and organization trigger types that initiate AWS Config to evaluate AWS resources against a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html", "Properties": { "TagKeyScope": { "Required": false, "MarkdownDocumentation": "`TagKeyScope`\n\nOne 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-tagkeyscope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TagValueScope": { "Required": false, "MarkdownDocumentation": "`TagValueScope`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-tagvaluescope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Runtime": { "Required": true, "MarkdownDocumentation": "`Runtime`\n\nThe runtime system for your organization AWS Config Custom Policy rules. 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\nRepository](https://github.com/aws-cloudformation/cloudformation-guard).\n*Required*: Yes\n*Type*: String\n*Pattern*: `guard\\-2\\.x\\.x`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-runtime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PolicyText": { "Required": true, "MarkdownDocumentation": "`PolicyText`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-policytext", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResourceIdScope": { "Required": false, "MarkdownDocumentation": "`ResourceIdScope`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-resourceidscope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OrganizationConfigRuleTriggerTypes": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`OrganizationConfigRuleTriggerTypes`\n\nThe type of notification that initiates AWS Config to run an evaluation for a rule.\nFor 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\n change.\n* `OversizedConfigurationItemChangeNotification` - Initiates an evaluation when\n AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the\n notification exceeds the maximum size allowed by Amazon SNS.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-organizationconfigruletriggertypes", "UpdateType": "Mutable" }, "DebugLogDeliveryAccounts": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`DebugLogDeliveryAccounts`\n\nA 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*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-debuglogdeliveryaccounts", "UpdateType": "Mutable" }, "ResourceTypesScope": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ResourceTypesScope`\n\nThe type of the AWS resource that was evaluated.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-resourcetypesscope", "UpdateType": "Mutable" }, "MaximumExecutionFrequency": { "Required": false, "MarkdownDocumentation": "`MaximumExecutionFrequency`\n\nThe maximum frequency with which AWS Config runs evaluations for a rule. Your\nAWS Config Custom Policy rule is triggered when AWS Config delivers\nthe 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 | Three_Hours | Si...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-maximumexecutionfrequency", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InputParameters": { "Required": false, "MarkdownDocumentation": "`InputParameters`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata-inputparameters", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata": { "MarkdownDocumentation": "`AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata`\n\nAn object that specifies organization custom rule metadata such as resource type, resource ID of AWS resource, Lambda function ARN,\nand organization trigger types that trigger AWS Config to evaluate your AWS resources against a rule.\nIt also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html", "Properties": { "TagKeyScope": { "Required": false, "MarkdownDocumentation": "`TagKeyScope`\n\nOne part of a key-value pair that make up a tag.\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-tagkeyscope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TagValueScope": { "Required": false, "MarkdownDocumentation": "`TagValueScope`\n\nThe optional part of a key-value pair that make up a tag.\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-tagvaluescope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResourceIdScope": { "Required": false, "MarkdownDocumentation": "`ResourceIdScope`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-resourceidscope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "LambdaFunctionArn": { "Required": true, "MarkdownDocumentation": "`LambdaFunctionArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-lambdafunctionarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OrganizationConfigRuleTriggerTypes": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`OrganizationConfigRuleTriggerTypes`\n\nThe 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.\n 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-organizationconfigruletriggertypes", "UpdateType": "Mutable" }, "ResourceTypesScope": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ResourceTypesScope`\n\nThe type of the AWS resource that was evaluated.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-resourcetypesscope", "UpdateType": "Mutable" }, "MaximumExecutionFrequency": { "Required": false, "MarkdownDocumentation": "`MaximumExecutionFrequency`\n\nThe maximum frequency with which AWS Config runs evaluations for a rule.\nYour 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).\n###### Note\nBy default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid\nvalue for the `MaximumExecutionFrequency` parameter.\n*Required*: No\n*Type*: String\n*Allowed values*: `One_Hour | Three_Hours | Si...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-maximumexecutionfrequency", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InputParameters": { "Required": false, "MarkdownDocumentation": "`InputParameters`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-inputparameters", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata": { "MarkdownDocumentation": "`AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata`\n\nAn object that specifies organization managed rule metadata such as resource type and ID of AWS resource along with the rule identifier.\nIt also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html", "Properties": { "TagKeyScope": { "Required": false, "MarkdownDocumentation": "`TagKeyScope`\n\nOne part of a key-value pair that make up a tag.\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-tagkeyscope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TagValueScope": { "Required": false, "MarkdownDocumentation": "`TagValueScope`\n\nThe optional part of a key-value pair that make up a tag.\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-tagvaluescope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResourceIdScope": { "Required": false, "MarkdownDocumentation": "`ResourceIdScope`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-resourceidscope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RuleIdentifier": { "Required": true, "MarkdownDocumentation": "`RuleIdentifier`\n\nFor organization config managed rules, a predefined identifier from a\nlist. For example, `IAM_PASSWORD_POLICY` is a managed\nrule. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-ruleidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResourceTypesScope": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ResourceTypesScope`\n\nThe type of the AWS resource that was evaluated.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-resourcetypesscope", "UpdateType": "Mutable" }, "MaximumExecutionFrequency": { "Required": false, "MarkdownDocumentation": "`MaximumExecutionFrequency`\n\nThe 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.\n###### Note\nBy default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid\nvalue for the `MaximumExecutionFrequency` parameter.\n*Required*: No\n*Type*: String\n*Allowed values*: `One_Hour | Three_Hours | Si...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-maximumexecutionfrequency", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InputParameters": { "Required": false, "MarkdownDocumentation": "`InputParameters`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-inputparameters", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Config::OrganizationConformancePack.ConformancePackInputParameter": { "MarkdownDocumentation": "`AWS::Config::OrganizationConformancePack.ConformancePackInputParameter`\n\nInput parameters in the form of key-value pairs for the conformance pack, both of which you define.\nKeys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconformancepack-conformancepackinputparameter.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nOne part of a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconformancepack-conformancepackinputparameter.html#cfn-config-organizationconformancepack-conformancepackinputparameter-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nOne 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconformancepack-conformancepackinputparameter.html#cfn-config-organizationconformancepack-conformancepackinputparameter-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Config::RemediationConfiguration.ExecutionControls": { "MarkdownDocumentation": "`AWS::Config::RemediationConfiguration.ExecutionControls`\n\nAn ExecutionControls object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-executioncontrols.html", "Properties": { "SsmControls": { "Type": "SsmControls", "Required": false, "MarkdownDocumentation": "`SsmControls`\n\nA SsmControls object.\n*Required*: No\n*Type*: [SsmControls](./aws-properties-config-remediationconfiguration-ssmcontrols.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-executioncontrols.html#cfn-config-remediationconfiguration-executioncontrols-ssmcontrols", "UpdateType": "Mutable" } } }, "AWS::Config::RemediationConfiguration.RemediationParameterValue": { "MarkdownDocumentation": "`AWS::Config::RemediationConfiguration.RemediationParameterValue`\n\nThe value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-remediationparametervalue.html", "Properties": { "ResourceValue": { "Type": "ResourceValue", "Required": false, "MarkdownDocumentation": "`ResourceValue`\n\nThe value is dynamic and changes at run-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-remediationparametervalue.html#cfn-config-remediationconfiguration-remediationparametervalue-resourcevalue", "UpdateType": "Mutable" }, "StaticValue": { "Type": "StaticValue", "Required": false, "MarkdownDocumentation": "`StaticValue`\n\nThe value is static and does not change at run-time.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-remediationparametervalue.html#cfn-config-remediationconfiguration-remediationparametervalue-staticvalue", "UpdateType": "Mutable" } } }, "AWS::Config::RemediationConfiguration.ResourceValue": { "MarkdownDocumentation": "`AWS::Config::RemediationConfiguration.ResourceValue`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-resourcevalue.html", "Properties": { "Value": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-resourcevalue.html#cfn-config-remediationconfiguration-resourcevalue-value", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Config::RemediationConfiguration.SsmControls": { "MarkdownDocumentation": "`AWS::Config::RemediationConfiguration.SsmControls`\n\nAWS Systems Manager (SSM) specific remediation controls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-ssmcontrols.html", "Properties": { "ErrorPercentage": { "Required": false, "MarkdownDocumentation": "`ErrorPercentage`\n\nThe percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule.\nYou can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%.\nFor example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-ssmcontrols.html#cfn-config-remediationconfiguration-ssmcontrols-errorpercentage", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ConcurrentExecutionRatePercentage": { "Required": false, "MarkdownDocumentation": "`ConcurrentExecutionRatePercentage`\n\nThe maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-ssmcontrols.html#cfn-config-remediationconfiguration-ssmcontrols-concurrentexecutionratepercentage", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::Config::RemediationConfiguration.StaticValue": { "MarkdownDocumentation": "`AWS::Config::RemediationConfiguration.StaticValue`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-staticvalue.html", "Properties": { "Values": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-staticvalue.html#cfn-config-remediationconfiguration-staticvalue-values", "UpdateType": "Mutable" } } }, "AWS::ControlTower::EnabledBaseline.Parameter": { "MarkdownDocumentation": "`AWS::ControlTower::EnabledBaseline.Parameter`\n\nThe `Parameter` property type specifies Property description not available. for an [AWS::ControlTower::EnabledBaseline](./aws-resource-controltower-enabledbaseline.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-controltower-enabledbaseline-parameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-controltower-enabledbaseline-parameter.html#cfn-controltower-enabledbaseline-parameter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-controltower-enabledbaseline-parameter.html#cfn-controltower-enabledbaseline-parameter-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ControlTower::EnabledControl.EnabledControlParameter": { "MarkdownDocumentation": "`AWS::ControlTower::EnabledControl.EnabledControlParameter`\n\nA set of parameters that configure the behavior of the enabled control. Expressed as a key/value pair, where `Key` is of type `String` and `Value` is of type `Document`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-controltower-enabledcontrol-enabledcontrolparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a key/value pair. It can be of type `array`, `string`, `number`, `object`, or `boolean`. [Note: The *Type* field that follows may show a single type such as Number, which is only one possible type.]\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-controltower-enabledcontrol-enabledcontrolparameter.html#cfn-controltower-enabledcontrol-enabledcontrolparameter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of a key/value pair. It is of type `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-controltower-enabledcontrol-enabledcontrolparameter.html#cfn-controltower-enabledcontrol-enabledcontrolparameter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DAX::Cluster.SSESpecification": { "MarkdownDocumentation": "`AWS::DAX::Cluster.SSESpecification`\n\nRepresents the settings used to enable server-side encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dax-cluster-ssespecification.html", "Properties": { "SSEEnabled": { "Required": false, "MarkdownDocumentation": "`SSEEnabled`\n\nIndicates whether server-side encryption is enabled (true) or disabled (false) on\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dax-cluster-ssespecification.html#cfn-dax-cluster-ssespecification-sseenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.Action": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.Action`\n\n**[Event-based policies only]** Specifies an action for an event-based policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html", "Properties": { "CrossRegionCopy": { "Type": "List", "Required": true, "MarkdownDocumentation": "`CrossRegionCopy`\n\nThe rule for copying shared snapshots across Regions.\n*Required*: Yes\n*Type*: Array of [CrossRegionCopyAction](./aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html#cfn-dlm-lifecyclepolicy-action-crossregioncopy", "ItemType": "CrossRegionCopyAction", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA descriptive name for the action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9A-Za-z _-]+`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html#cfn-dlm-lifecyclepolicy-action-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.ArchiveRetainRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.ArchiveRetainRule`\n\n**[Custom snapshot policies only]** Specifies information about the archive storage tier retention period.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiveretainrule.html", "Properties": { "RetentionArchiveTier": { "Type": "RetentionArchiveTier", "Required": true, "MarkdownDocumentation": "`RetentionArchiveTier`\n\nInformation about retention period in the Amazon EBS Snapshots Archive. For more information, see\n[Archive Amazon\nEBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/snapshot-archive.html).\n*Required*: Yes\n*Type*: [RetentionArchiveTier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiveretainrule.html#cfn-dlm-lifecyclepolicy-archiveretainrule-retentionarchivetier", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.ArchiveRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.ArchiveRule`\n\n**[Custom snapshot policies only]** Specifies a snapshot archiving rule for a schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiverule.html", "Properties": { "RetainRule": { "Type": "ArchiveRetainRule", "Required": true, "MarkdownDocumentation": "`RetainRule`\n\nInformation about the retention period for the snapshot archiving rule.\n*Required*: Yes\n*Type*: [ArchiveRetainRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiverule.html#cfn-dlm-lifecyclepolicy-archiverule-retainrule", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.CreateRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.CreateRule`\n\n**[Custom snapshot and AMI policies only]** Specifies when the policy should create snapshots or AMIs.\n###### Note\n* You must specify either **CronExpression**, or\n **Interval**, **IntervalUnit**,\n and **Times**.\n* If you need to specify an [ArchiveRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html)\n for the schedule, then you must specify a creation frequency of at least\n 28 days.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html", "Properties": { "IntervalUnit": { "Required": false, "MarkdownDocumentation": "`IntervalUnit`\n\nThe 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)\n", "RefReturnValue": "", "AllowedValues": [ "HOURS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-intervalunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Scripts": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Scripts`\n\n**[Custom snapshot policies that target instances only]** Specifies pre and/or post scripts for a snapshot lifecycle policy\nthat targets instances. This is useful for creating application-consistent snapshots, or for\nperforming specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.\nFor more information, see [Automating\napplication-consistent snapshots with pre and post scripts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html).\n*Required*: No\n*Type*: Array of [Script](./aws-properties-dlm-lifecyclepolicy-script.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-scripts", "ItemType": "Script", "UpdateType": "Mutable" }, "Times": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Times`\n\nThe 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\nnot specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-times", "UpdateType": "Mutable" }, "CronExpression": { "Required": false, "MarkdownDocumentation": "`CronExpression`\n\nThe schedule, as a Cron expression. The schedule interval must be between 1 hour and 1\nyear. For more information, see the [Cron and rate expressions](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html)\nin the *Amazon EventBridge User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `cron\\([^\\n]{11,100}\\)`\n*Minimum*: `17`\n*Maximum*: `106`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-cronexpression", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Interval": { "Required": false, "MarkdownDocumentation": "`Interval`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-interval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Location": { "Required": false, "MarkdownDocumentation": "`Location`\n\n**[Custom snapshot policies only]** Specifies the destination for snapshots created by the policy. The\nallowed destinations depend on the location of the targeted resources.\n* If the policy targets resources in a Region, then you must create snapshots\n in the same Region as the source resource.\n* If the policy targets resources in a Local Zone, you can create snapshots in\n the same Local Zone or in its parent Region.\n* If the policy targets resources on an Outpost, then you can create snapshots\n on the same Outpost or in its parent Region.\nSpecify one of the following values:\n* To create snapshots in the same Region as the source resource, specify\n `CLOUD`.\n* To create snapshots in the same Local Zone as the source resource, specify\n `LOCAL_ZONE`.\n* To create snapshots on the same Outpost as the source resource, specify\n `OUTPOST_LOCAL`.\nDefault: `CLOUD`\n*Required*: No\n*Type*: String\n*Allowed values*: `CLOUD | OUTPOST_LOCAL | LOC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLOUD", "OUTPOST_LOCAL", "LOCAL_ZONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-location", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.CrossRegionCopyAction": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.CrossRegionCopyAction`\n\n**[Event-based policies only]** Specifies a cross-Region copy action for event-based policies.\n###### Note\nTo specify a cross-Region copy rule for snapshot and AMI policies, use\n[CrossRegionCopyRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html", "Properties": { "Target": { "Required": true, "MarkdownDocumentation": "`Target`\n\nThe target Region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w:\\-\\/\\*]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html#cfn-dlm-lifecyclepolicy-crossregioncopyaction-target", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncryptionConfiguration": { "Type": "EncryptionConfiguration", "Required": true, "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption settings for the copied snapshot.\n*Required*: Yes\n*Type*: [EncryptionConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html#cfn-dlm-lifecyclepolicy-crossregioncopyaction-encryptionconfiguration", "UpdateType": "Mutable" }, "RetainRule": { "Type": "CrossRegionCopyRetainRule", "Required": false, "MarkdownDocumentation": "`RetainRule`\n\nSpecifies a retention rule for cross-Region snapshot copies created by snapshot or\nevent-based policies, or cross-Region AMI copies created by AMI policies. After the\nretention period expires, the cross-Region copy is deleted.\n*Required*: No\n*Type*: [CrossRegionCopyRetainRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html#cfn-dlm-lifecyclepolicy-crossregioncopyaction-retainrule", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.CrossRegionCopyDeprecateRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.CrossRegionCopyDeprecateRule`\n\n**[Custom AMI policies only]** Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html", "Properties": { "IntervalUnit": { "Required": true, "MarkdownDocumentation": "`IntervalUnit`\n\nThe unit of time in which to measure the **Interval**. For example,\nto deprecate a cross-Region AMI copy after 3 months, specify `Interval=3` and\n`IntervalUnit=MONTHS`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html#cfn-dlm-lifecyclepolicy-crossregioncopydeprecaterule-intervalunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Interval": { "Required": true, "MarkdownDocumentation": "`Interval`\n\nThe period after which to deprecate the cross-Region AMI copies. The period must be less than or\nequal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is\nequivalent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html#cfn-dlm-lifecyclepolicy-crossregioncopydeprecaterule-interval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule`\n\nSpecifies a retention rule for cross-Region snapshot copies created by snapshot or\nevent-based policies, or cross-Region AMI copies created by AMI policies. After the\nretention period expires, the cross-Region copy is deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html", "Properties": { "IntervalUnit": { "Required": true, "MarkdownDocumentation": "`IntervalUnit`\n\nThe unit of time for time-based retention. For example, to retain a cross-Region copy for\n3 months, specify `Interval=3` and `IntervalUnit=MONTHS`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyretainrule-intervalunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Interval": { "Required": true, "MarkdownDocumentation": "`Interval`\n\nThe amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years.\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyretainrule-interval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.CrossRegionCopyRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.CrossRegionCopyRule`\n\n**[Custom snapshot and AMI policies only]** Specifies a cross-Region copy rule for a snapshot and AMI policies.\n###### Note\nTo specify a cross-Region copy action for event-based polices, use\n[CrossRegionCopyAction](https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html", "Properties": { "TargetRegion": { "Required": false, "MarkdownDocumentation": "`TargetRegion`\n\n###### Note\nUse this parameter for AMI policies only. For snapshot policies, use\n**Target** instead. For snapshot policies\ncreated before the **Target** parameter\nwas introduced, this parameter indicates the target Region for snapshot\ncopies.\n**[Custom AMI policies only]** The target Region or the Amazon Resource Name (ARN) of the target Outpost for the\nsnapshot copies.\n*Required*: No\n*Type*: String\n*Pattern*: `([a-z]+-){2,3}\\d`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-targetregion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Target": { "Required": false, "MarkdownDocumentation": "`Target`\n\n###### Note\nUse this parameter for snapshot policies only. For AMI policies, use\n**TargetRegion** instead.\n**[Custom snapshot policies only]** The target Region or the Amazon Resource Name (ARN) of the target Outpost for the\nsnapshot copies.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w:\\-\\/\\*]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-target", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DeprecateRule": { "Type": "CrossRegionCopyDeprecateRule", "Required": false, "MarkdownDocumentation": "`DeprecateRule`\n\n**[Custom AMI policies only]** The AMI deprecation rule for cross-Region AMI copies created by the rule.\n*Required*: No\n*Type*: [CrossRegionCopyDeprecateRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-deprecaterule", "UpdateType": "Mutable" }, "Encrypted": { "Required": true, "MarkdownDocumentation": "`Encrypted`\n\nTo encrypt a copy of an unencrypted snapshot if encryption by default is not enabled,\nenable encryption using this parameter. Copies of encrypted snapshots are encrypted,\neven 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-encrypted", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "CmkArn": { "Required": false, "MarkdownDocumentation": "`CmkArn`\n\nThe Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this\nparameter is not specified, the default KMS key for the account is used.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\\d:\\d+:key/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-cmkarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RetainRule": { "Type": "CrossRegionCopyRetainRule", "Required": false, "MarkdownDocumentation": "`RetainRule`\n\nThe retention rule that indicates how long the cross-Region snapshot or AMI copies are\nto be retained in the destination Region.\n*Required*: No\n*Type*: [CrossRegionCopyRetainRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-retainrule", "UpdateType": "Mutable" }, "CopyTags": { "Required": false, "MarkdownDocumentation": "`CopyTags`\n\nIndicates whether to copy all user-defined tags from the source snapshot or AMI to the\ncross-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-copytags", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.CrossRegionCopyTarget": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.CrossRegionCopyTarget`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopytarget.html", "Properties": { "TargetRegion": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopytarget.html#cfn-dlm-lifecyclepolicy-crossregioncopytarget-targetregion", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.CrossRegionCopyTargets": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.CrossRegionCopyTargets`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopytargets.html", "ItemType": "CrossRegionCopyTarget", "UpdateType": "Mutable" }, "AWS::DLM::LifecyclePolicy.DeprecateRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.DeprecateRule`\n\n**[Custom AMI policies only]** Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.\nFor age-based schedules, you must specify **Interval** and\n**IntervalUnit**. For count-based schedules, you must specify\n**Count**.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html", "Properties": { "IntervalUnit": { "Required": false, "MarkdownDocumentation": "`IntervalUnit`\n\nThe unit of time in which to measure the **Interval**.\n*Required*: No\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html#cfn-dlm-lifecyclepolicy-deprecaterule-intervalunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Count": { "Required": false, "MarkdownDocumentation": "`Count`\n\nIf the schedule has a count-based retention rule, this parameter specifies the number of oldest\nAMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it\ncan'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html#cfn-dlm-lifecyclepolicy-deprecaterule-count", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Interval": { "Required": false, "MarkdownDocumentation": "`Interval`\n\nIf the schedule has an age-based retention rule, this parameter specifies the period after which\nto deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's\nretention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520\nweeks, or 3650 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html#cfn-dlm-lifecyclepolicy-deprecaterule-interval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.EncryptionConfiguration`\n\n**[Event-based policies only]** Specifies the encryption settings for cross-Region snapshot copies created by\nevent-based policies.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-encryptionconfiguration.html", "Properties": { "Encrypted": { "Required": true, "MarkdownDocumentation": "`Encrypted`\n\nTo encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable\nencryption using this parameter. Copies of encrypted snapshots are encrypted, even if this\nparameter is false or when 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-encryptionconfiguration.html#cfn-dlm-lifecyclepolicy-encryptionconfiguration-encrypted", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "CmkArn": { "Required": false, "MarkdownDocumentation": "`CmkArn`\n\nThe Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If\nthis parameter is not specified, the default KMS key for the account is used.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\\d:\\d+:key/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-encryptionconfiguration.html#cfn-dlm-lifecyclepolicy-encryptionconfiguration-cmkarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.EventParameters": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.EventParameters`\n\n**[Event-based policies only]** Specifies an event that activates an event-based policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html", "Properties": { "EventType": { "Required": true, "MarkdownDocumentation": "`EventType`\n\nThe type of event. Currently, only snapshot sharing events are supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `shareSnapshot...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "shareSnapshot" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-eventtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SnapshotOwner": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`SnapshotOwner`\n\nThe IDs of the AWS accounts that can trigger policy by sharing snapshots with your account.\nThe policy only runs if one of the specified AWS accounts shares a snapshot with your account.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-snapshotowner", "UpdateType": "Mutable" }, "DescriptionRegex": { "Required": false, "MarkdownDocumentation": "`DescriptionRegex`\n\nThe snapshot description that can trigger the policy. The description pattern is specified using\na regular expression. The policy runs only if a snapshot with a description that matches the\nspecified pattern is shared with your account.\nFor example, specifying `^.*Created for policy: policy-1234567890abcdef0.*$`\nconfigures the policy to run only if snapshots created by policy `policy-1234567890abcdef0`\nare shared with your account.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{all}]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-descriptionregex", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.EventSource": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.EventSource`\n\n**[Event-based policies only]** Specifies an event that activates an event-based policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe source of the event. Currently only managed Amazon EventBridge (formerly known as Amazon CloudWatch) events are supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MANAGED_CWE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MANAGED_CWE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html#cfn-dlm-lifecyclepolicy-eventsource-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Parameters": { "Type": "EventParameters", "Required": false, "MarkdownDocumentation": "`Parameters`\n\nInformation about the event.\n*Required*: No\n*Type*: [EventParameters](./aws-properties-dlm-lifecyclepolicy-eventparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html#cfn-dlm-lifecyclepolicy-eventsource-parameters", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.ExcludeTags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.ExcludeTags`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-excludetags.html", "ItemType": "Tag", "UpdateType": "Mutable" }, "AWS::DLM::LifecyclePolicy.ExcludeVolumeTypesList": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.ExcludeVolumeTypesList`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-excludevolumetypeslist.html", "ItemType": "VolumeTypeValues", "UpdateType": "Mutable" }, "AWS::DLM::LifecyclePolicy.Exclusions": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.Exclusions`\n\n**[Default policies only]** Specifies exclusion parameters for volumes or instances for which you\ndo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs\nfor target resources that match any of the specified exclusion parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-exclusions.html", "Properties": { "ExcludeBootVolumes": { "Required": false, "MarkdownDocumentation": "`ExcludeBootVolumes`\n\n**[Default policies for EBS snapshots only]** Indicates whether to exclude volumes that are attached to\ninstances as the boot volume. If you exclude boot volumes, only volumes attached as data\n(non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-exclusions.html#cfn-dlm-lifecyclepolicy-exclusions-excludebootvolumes", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ExcludeTags": { "Type": "ExcludeTags", "Required": false, "MarkdownDocumentation": "`ExcludeTags`\n\n**[Default policies for EBS-backed AMIs only]** Specifies whether to exclude volumes that have specific tags.\n*Required*: No\n*Type*: Json\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-exclusions.html#cfn-dlm-lifecyclepolicy-exclusions-excludetags", "UpdateType": "Mutable" }, "ExcludeVolumeTypes": { "Type": "ExcludeVolumeTypesList", "Required": false, "MarkdownDocumentation": "`ExcludeVolumeTypes`\n\n**[Default policies for EBS snapshots only]** Specifies the volume types to exclude. Volumes of the specified\ntypes will not be targeted by the policy.\n*Required*: No\n*Type*: Json\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-exclusions.html#cfn-dlm-lifecyclepolicy-exclusions-excludevolumetypes", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.FastRestoreRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.FastRestoreRule`\n\n**[Custom snapshot policies only]** Specifies a rule for enabling fast snapshot restore for snapshots created by\nsnapshot policies. You can enable fast snapshot restore based on either a count or a\ntime interval.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html", "Properties": { "IntervalUnit": { "Required": false, "MarkdownDocumentation": "`IntervalUnit`\n\nThe unit of time for enabling fast snapshot restore.\n*Required*: No\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-intervalunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AvailabilityZones": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AvailabilityZones`\n\nThe Availability Zones in which to enable fast snapshot restore.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-availabilityzones", "UpdateType": "Mutable" }, "Count": { "Required": false, "MarkdownDocumentation": "`Count`\n\nThe number of snapshots to be enabled with fast snapshot restore.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-count", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Interval": { "Required": false, "MarkdownDocumentation": "`Interval`\n\nThe amount of time to enable fast snapshot restore. The maximum is 100 years. This is\nequivalent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-interval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.Parameters": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.Parameters`\n\n**[Custom snapshot and AMI policies only]** Specifies optional parameters for snapshot and AMI policies. The\nset of valid parameters depends on the combination of policy type and target resource\ntype.\nIf you choose to exclude boot volumes and you specify tags that consequently exclude\nall of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create\nany snapshots for the affected instance, and it will emit a `SnapshotsCreateFailed`\nAmazon CloudWatch metric. For more information, see [Monitor your policies\nusing Amazon CloudWatch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-dlm-cw-metrics.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html", "Properties": { "ExcludeBootVolume": { "Required": false, "MarkdownDocumentation": "`ExcludeBootVolume`\n\n**[Custom snapshot policies that target instances only]** Indicates whether to exclude the root volume from multi-volume\nsnapshot sets. The default is `false`. If you specify `true`,\nthen the root volumes attached to targeted instances will be excluded from the multi-volume\nsnapshot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-excludebootvolume", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ExcludeDataVolumeTags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ExcludeDataVolumeTags`\n\n**[Custom snapshot policies that target instances only]** The tags used to identify data (non-root) volumes to exclude from\nmulti-volume snapshot sets.\nIf you create a snapshot lifecycle policy that targets instances and you specify tags for\nthis parameter, then data volumes with the specified tags that are attached to targeted\ninstances will be excluded from the multi-volume snapshot sets created by the policy.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dlm-lifecyclepolicy-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-excludedatavolumetags", "ItemType": "Tag", "UpdateType": "Mutable" }, "NoReboot": { "Required": false, "MarkdownDocumentation": "`NoReboot`\n\n**[Custom AMI policies only]** Indicates whether targeted instances are rebooted when the lifecycle policy\nruns. `true` indicates that targeted instances are not rebooted when the policy\nruns. `false` indicates that target instances are rebooted when the policy runs.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-noreboot", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.PolicyDetails": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.PolicyDetails`\n\nSpecifies the configuration of a lifecycle policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html", "Properties": { "PolicyLanguage": { "Required": false, "MarkdownDocumentation": "`PolicyLanguage`\n\nThe type of policy to create. Specify one of the following:\n* `SIMPLIFIED` To create a default policy.\n* `STANDARD` To create a custom policy.\n*Required*: No\n*Type*: String\n*Allowed values*: `SIMPLIFIED | STANDARD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SIMPLIFIED", "STANDARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-policylanguage", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResourceTypes": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ResourceTypes`\n\n**[Custom snapshot policies only]** The target resource type for snapshot and AMI lifecycle policies. Use `VOLUME` to\ncreate snapshots of individual volumes or use `INSTANCE` to create multi-volume\nsnapshots from the volumes for an instance.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcetypes", "UpdateType": "Mutable" }, "Schedules": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Schedules`\n\n**[Custom snapshot and AMI policies only]** The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy\ncan have up to four schedules\u2014one mandatory schedule and up to three optional schedules.\n*Required*: No\n*Type*: Array of [Schedule](./aws-properties-dlm-lifecyclepolicy-schedule.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-schedules", "ItemType": "Schedule", "UpdateType": "Mutable" }, "PolicyType": { "Required": false, "MarkdownDocumentation": "`PolicyType`\n\nThe type of policy. Specify `EBS_SNAPSHOT_MANAGEMENT`\nto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify `IMAGE_MANAGEMENT`\nto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify `EVENT_BASED_POLICY` \nto 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 | I...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EBS_SNAPSHOT_MANAGEMENT", "IMAGE_MANAGEMENT", "EVENT_BASED_POLICY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-policytype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CreateInterval": { "Required": false, "MarkdownDocumentation": "`CreateInterval`\n\n**[Default policies only]** Specifies how often the policy should run and create snapshots or AMIs.\nThe creation frequency can range from 1 to 7 days. If you do not specify a value, the\ndefault is 1.\nDefault: 1\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-createinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Parameters": { "Type": "Parameters", "Required": false, "MarkdownDocumentation": "`Parameters`\n\n**[Custom snapshot and AMI policies only]** A set of optional parameters for snapshot and AMI lifecycle policies.\n###### Note\nIf you are modifying a policy that was created or previously modified using the Amazon\nData Lifecycle Manager console, then you must include this parameter and specify either\nthe default values or the new values that you require. You can't omit this parameter or\nset its values to null.\n*Required*: No\n*Type*: [Parameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-parameters", "UpdateType": "Mutable" }, "ExtendDeletion": { "Required": false, "MarkdownDocumentation": "`ExtendDeletion`\n\n**[Default policies only]** Defines the snapshot or AMI retention behavior for the policy if the\nsource volume or instance is deleted, or if the policy enters the error, disabled, or\ndeleted state.\nBy default (**ExtendDeletion=false**):\n* If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously\n created snapshots or AMIs, up to but not including the last one, based on the\n specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs,\n including the last one, specify `true`.\n* If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting\n snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs,\n including the last one, if the policy enters one of these states, specify\n `true`.\nIf you enable extended deletion (**ExtendDeletion=true**),\nyou override both default behaviors simultaneously.\nIf you do not specify a value, the default is `false`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-extenddeletion", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Exclusions": { "Type": "Exclusions", "Required": false, "MarkdownDocumentation": "`Exclusions`\n\n**[Default policies only]** Specifies exclusion parameters for volumes or instances for which you\ndo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs\nfor target resources that match any of the specified exclusion parameters.\n*Required*: No\n*Type*: [Exclusions](./aws-properties-dlm-lifecyclepolicy-exclusions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-exclusions", "UpdateType": "Mutable" }, "Actions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Actions`\n\n**[Event-based policies only]** The actions to be performed when the event-based policy is activated. You can specify\nonly one action per policy.\n*Required*: No\n*Type*: Array of [Action](./aws-properties-dlm-lifecyclepolicy-action.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-actions", "ItemType": "Action", "UpdateType": "Mutable" }, "ResourceType": { "Required": false, "MarkdownDocumentation": "`ResourceType`\n\n**[Default policies only]** Specify the type of default policy to create.\n* To create a default policy for EBS snapshots, that creates snapshots of all volumes in the\n Region that do not have recent backups, specify `VOLUME`.\n* To create a default policy for EBS-backed AMIs, that creates EBS-backed\n AMIs from all instances in the Region that do not have recent backups, specify\n `INSTANCE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `VOLUME | INSTANCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VOLUME", "INSTANCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RetainInterval": { "Required": false, "MarkdownDocumentation": "`RetainInterval`\n\n**[Default policies only]** Specifies how long the policy should retain snapshots or AMIs before\ndeleting them. The retention period can range from 2 to 14 days, but it must be greater\nthan the creation frequency to ensure that the policy retains at least 1 snapshot or\nAMI at any given time. If you do not specify a value, the default is 7.\nDefault: 7\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-retaininterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "EventSource": { "Type": "EventSource", "Required": false, "MarkdownDocumentation": "`EventSource`\n\n**[Event-based policies only]** The event that activates the event-based policy.\n*Required*: No\n*Type*: [EventSource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-eventsource", "UpdateType": "Mutable" }, "CrossRegionCopyTargets": { "Type": "CrossRegionCopyTargets", "Required": false, "MarkdownDocumentation": "`CrossRegionCopyTargets`\n\n**[Default policies only]** Specifies destination Regions for snapshot or AMI copies. You can specify\nup to 3 destination Regions. If you do not want to create cross-Region copies, omit this\nparameter.\n*Required*: No\n*Type*: Json\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-crossregioncopytargets", "UpdateType": "Mutable" }, "TargetTags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`TargetTags`\n\n**[Custom snapshot and AMI policies only]** The single tag that identifies targeted resources for this policy.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dlm-lifecyclepolicy-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-targettags", "ItemType": "Tag", "UpdateType": "Mutable" }, "ResourceLocations": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ResourceLocations`\n\n**[Custom snapshot and AMI policies only]** The location of the resources to backup.\n* If the source resources are located in a Region, specify `CLOUD`. In this case,\n the policy targets all resources of the specified type with matching target tags across all\n Availability Zones in the Region.\n* **[Custom snapshot policies only]** If the source resources are located in a Local Zone, specify `LOCAL_ZONE`.\n In this case, the policy targets all resources of the specified type with matching target\n tags across all Local Zones in the Region.\n* If the source resources are located on an Outpost in your account, specify `OUTPOST`.\n In this case, the policy targets all resources of the specified type with matching target\n tags across all of the Outposts in your account.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcelocations", "UpdateType": "Mutable" }, "CopyTags": { "Required": false, "MarkdownDocumentation": "`CopyTags`\n\n**[Default policies only]** Indicates whether the policy should copy tags from the source resource\nto the snapshot or AMI. If you do not specify a value, the default is `false`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-copytags", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.RetainRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.RetainRule`\n\n**[Custom snapshot and AMI policies only]** Specifies a retention rule for snapshots created by snapshot policies, or for AMIs\ncreated by AMI policies.\n###### Note\nFor snapshot policies that have an [ArchiveRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html), this retention rule\napplies to standard tier retention. When the retention threshold is met, snapshots\nare moved from the standard to the archive tier.\nFor snapshot policies that do not have an **ArchiveRule**, snapshots\nare permanently deleted when this retention threshold is met.\nYou can retain snapshots based on either a count or a time interval.\n* **Count-based retention**\n \n You must specify **Count**.\n If you specify an [ArchiveRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html) for the schedule, then you can specify a retention count of\n `0` to archive snapshots immediately after creation. If you specify a [FastRestoreRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_FastRestoreRule.html),\n [ShareRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_ShareRule.html), or a\n [CrossRegionCopyRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html), then you must specify a retention count\n of `1` or more.\n* **Age-based retention**\n \n You must specify **Interval**\n and **IntervalUnit**. If you specify an [ArchiveRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html) for the\n schedule, then you can specify a retention interval of `0` days to archive snapshots immediately\n after creation. If you specify a [FastRestoreRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_FastRestoreRule.html), [ShareRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_ShareRule.html), or a\n [CrossRegionCopyRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html),\n then you must specify a retention interval of `1` day or\n more.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html", "Properties": { "IntervalUnit": { "Required": false, "MarkdownDocumentation": "`IntervalUnit`\n\nThe unit of time for time-based retention. For example, to retain snapshots for 3 months, specify\n`Interval=3` and `IntervalUnit=MONTHS`. Once the snapshot has been retained for\n3 months, it is deleted, or it is moved to the archive tier if you have specified an\n[ArchiveRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-intervalunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Count": { "Required": false, "MarkdownDocumentation": "`Count`\n\nThe number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to\nretain a maximum of three snapshots, specify `3`. When the fourth snapshot is created, the\noldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an\n[ArchiveRule](https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-count", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Interval": { "Required": false, "MarkdownDocumentation": "`Interval`\n\nThe amount of time to retain each snapshot. The maximum is 100 years. This is\nequivalent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-interval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.RetentionArchiveTier": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.RetentionArchiveTier`\n\n**[Custom snapshot policies only]** Describes the retention rule for archived snapshots. Once the archive\nretention threshold is met, the snapshots are permanently deleted from the archive tier.\n###### Note\nThe archive retention rule must retain snapshots in the archive tier for a minimum\nof 90 days.\nFor **count-based schedules**, you must specify **Count**. For **age-based\nschedules**, you must specify **Interval** and\n **IntervalUnit**.\nFor more information about using snapshot archiving, see [Considerations for\nsnapshot lifecycle policies](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html", "Properties": { "IntervalUnit": { "Required": false, "MarkdownDocumentation": "`IntervalUnit`\n\nThe unit of time in which to measure the **Interval**. For\nexample, to retain a snapshots in the archive tier for 6 months, specify `Interval=6`\nand `IntervalUnit=MONTHS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html#cfn-dlm-lifecyclepolicy-retentionarchivetier-intervalunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Count": { "Required": false, "MarkdownDocumentation": "`Count`\n\nThe maximum number of snapshots to retain in the archive storage tier for each volume.\nThe count must ensure that each snapshot remains in the archive tier for at least\n90 days. For example, if the schedule creates snapshots every 30 days, you must specify a\ncount 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html#cfn-dlm-lifecyclepolicy-retentionarchivetier-count", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Interval": { "Required": false, "MarkdownDocumentation": "`Interval`\n\nSpecifies the period of time to retain snapshots in the archive tier. After this period\nexpires, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html#cfn-dlm-lifecyclepolicy-retentionarchivetier-interval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.Schedule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.Schedule`\n\n**[Custom snapshot and AMI policies only]** Specifies a schedule for a snapshot or AMI lifecycle policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html", "Properties": { "ShareRules": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ShareRules`\n\n**[Custom snapshot policies only]** The rule for sharing snapshots with other AWS accounts.\n*Required*: No\n*Type*: Array of [ShareRule](./aws-properties-dlm-lifecyclepolicy-sharerule.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-sharerules", "ItemType": "ShareRule", "UpdateType": "Mutable" }, "DeprecateRule": { "Type": "DeprecateRule", "Required": false, "MarkdownDocumentation": "`DeprecateRule`\n\n**[Custom AMI policies only]** The AMI deprecation rule for the schedule.\n*Required*: No\n*Type*: [DeprecateRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-deprecaterule", "UpdateType": "Mutable" }, "TagsToAdd": { "Type": "List", "Required": false, "MarkdownDocumentation": "`TagsToAdd`\n\nThe tags to apply to policy-created resources. These user-defined tags are in addition\nto the AWS-added lifecycle tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dlm-lifecyclepolicy-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-tagstoadd", "ItemType": "Tag", "UpdateType": "Mutable" }, "CreateRule": { "Type": "CreateRule", "Required": false, "MarkdownDocumentation": "`CreateRule`\n\nThe creation rule.\n*Required*: No\n*Type*: [CreateRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-createrule", "UpdateType": "Mutable" }, "VariableTags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`VariableTags`\n\n**[AMI policies and snapshot policies that target instances only]**\nA collection of key/value pairs with values determined dynamically when the policy is\nexecuted. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two\nfollowing formats: `$(instance-id)` or `$(timestamp)`. Variable\ntags are only valid for EBS Snapshot Management \u2013 Instance policies.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dlm-lifecyclepolicy-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-variabletags", "ItemType": "Tag", "UpdateType": "Mutable" }, "FastRestoreRule": { "Type": "FastRestoreRule", "Required": false, "MarkdownDocumentation": "`FastRestoreRule`\n\n**[Custom snapshot policies only]** The rule for enabling fast snapshot restore.\n*Required*: No\n*Type*: [FastRestoreRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-fastrestorerule", "UpdateType": "Mutable" }, "ArchiveRule": { "Type": "ArchiveRule", "Required": false, "MarkdownDocumentation": "`ArchiveRule`\n\n**[Custom snapshot policies that target volumes only]** The snapshot archiving rule for the schedule. When you specify an archiving\nrule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's\nretention threshold is met. Snapshots are then retained in the archive tier for the archive retention\nperiod that you specify.\nFor more information about using snapshot archiving, see [Considerations for\nsnapshot lifecycle policies](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive).\n*Required*: No\n*Type*: [ArchiveRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-archiverule", "UpdateType": "Mutable" }, "RetainRule": { "Type": "RetainRule", "Required": false, "MarkdownDocumentation": "`RetainRule`\n\nThe retention rule for snapshots or AMIs created by the policy.\n*Required*: No\n*Type*: [RetainRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-retainrule", "UpdateType": "Mutable" }, "CrossRegionCopyRules": { "Type": "List", "Required": false, "MarkdownDocumentation": "`CrossRegionCopyRules`\n\nSpecifies a rule for copying snapshots or AMIs across Regions.\n###### Note\nYou can't specify cross-Region copy rules for policies that create snapshots on an\nOutpost or in a Local Zone. If the policy creates snapshots in a Region, then snapshots\ncan be copied to up to three Regions or Outposts.\n*Required*: No\n*Type*: Array of [CrossRegionCopyRule](./aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-crossregioncopyrules", "ItemType": "CrossRegionCopyRule", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the schedule.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9A-Za-z _-]+`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CopyTags": { "Required": false, "MarkdownDocumentation": "`CopyTags`\n\nCopy all user-defined tags on a source volume to snapshots of the volume created by\nthis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-copytags", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.Script": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.Script`\n\n**[Custom snapshot policies that target instances only]** Information about pre and/or post scripts for a\nsnapshot lifecycle policy that targets instances. For more information, see\n[Automating application-consistent snapshots with pre and post scripts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html", "Properties": { "ExecutionHandlerService": { "Required": false, "MarkdownDocumentation": "`ExecutionHandlerService`\n\nIndicates the service used to execute the pre and/or post scripts.\n* If you are using custom SSM documents or automating\n application-consistent snapshots of SAP HANA workloads, specify\n `AWS_SYSTEMS_MANAGER`.\n* If you are automating VSS Backups, omit this parameter.\nDefault: AWS\\_SYSTEMS\\_MANAGER\n*Required*: No\n*Type*: String\n*Allowed values*: `AWS_SYSTEMS_MANAGER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS_SYSTEMS_MANAGER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-executionhandlerservice", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExecutionTimeout": { "Required": false, "MarkdownDocumentation": "`ExecutionTimeout`\n\nSpecifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script\nrun attempt if it has not completed. If a script does not complete within its\ntimeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre\nand post scripts individually.\nIf you are automating VSS Backups, omit this parameter.\nDefault: 10\n*Required*: No\n*Type*: Integer\n*Minimum*: `10`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-executiontimeout", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Stages": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Stages`\n\nIndicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts\nrun before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager\ninitiates snapshot creation.\n* To run a pre script only, specify `PRE`. In this case,\n Amazon Data Lifecycle Manager calls the SSM document with the `pre-script` parameter\n before initiating snapshot creation.\n* To run a post script only, specify `POST`. In this case,\n Amazon Data Lifecycle Manager calls the SSM document with the `post-script` parameter\n after initiating snapshot creation.\n* To run both pre and post scripts, specify both `PRE` and `POST`. In\n this case, Amazon Data Lifecycle Manager calls the SSM document with the `pre-script`\n parameter before initiating snapshot creation, and then it calls the SSM\n document again with the `post-script` parameter after initiating\n snapshot creation.\nIf you are automating VSS Backups, omit this parameter.\nDefault: PRE and POST\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-stages", "UpdateType": "Mutable" }, "ExecutionHandler": { "Required": false, "MarkdownDocumentation": "`ExecutionHandler`\n\nThe SSM document that includes the pre and/or post scripts to run.\n* If you are automating VSS backups, specify `AWS_VSS_BACKUP`.\n In this case, Amazon Data Lifecycle Manager automatically uses the `AWSEC2-CreateVssSnapshot`\n SSM document.\n* If you are automating application-consistent snapshots for SAP HANA\n workloads, specify `AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA`.\n* If you are using a custom SSM document that you own, specify either\n the name or ARN of the SSM document. If you are using a custom SSM\n document that is shared with you, specify the ARN of the SSM document.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_\\-.]{3,128}|[a-zA-Z0-9_\\-.:/]{3,200}|[A-Z0-9_]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-executionhandler", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaximumRetryCount": { "Required": false, "MarkdownDocumentation": "`MaximumRetryCount`\n\nSpecifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.\n* If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation\n process, including running the pre and post scripts.\n* If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this\n case, the pre script will have completed and the snapshot might have\n been created.\nIf you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify `0`.\nDefault: 0\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-maximumretrycount", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ExecuteOperationOnScriptFailure": { "Required": false, "MarkdownDocumentation": "`ExecuteOperationOnScriptFailure`\n\nIndicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the\npre script fails.\n* To default to crash consistent snapshot if the pre script fails,\n specify `true`.\n* To skip the instance for snapshot creation if the pre script fails,\n specify `false`.\nThis parameter is supported only if you run a pre script. If you run a post\nscript only, omit this parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-script.html#cfn-dlm-lifecyclepolicy-script-executeoperationonscriptfailure", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.ShareRule": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.ShareRule`\n\n**[Custom snapshot policies only]** Specifies a rule for sharing snapshots across AWS accounts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html", "Properties": { "TargetAccounts": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`TargetAccounts`\n\nThe IDs of the AWS accounts with which to share the snapshots.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html#cfn-dlm-lifecyclepolicy-sharerule-targetaccounts", "UpdateType": "Mutable" }, "UnshareIntervalUnit": { "Required": false, "MarkdownDocumentation": "`UnshareIntervalUnit`\n\nThe unit of time for the automatic unsharing interval.\n*Required*: No\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html#cfn-dlm-lifecyclepolicy-sharerule-unshareintervalunit", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UnshareInterval": { "Required": false, "MarkdownDocumentation": "`UnshareInterval`\n\nThe period after which snapshots that are shared with other AWS accounts are automatically unshared.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html#cfn-dlm-lifecyclepolicy-sharerule-unshareinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy.VolumeTypeValues": { "Required": false, "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy.VolumeTypeValues`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-volumetypevalues.html", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AWS::DMS::DataMigration.DataMigrationSettings": { "MarkdownDocumentation": "`AWS::DMS::DataMigration.DataMigrationSettings`\n\nOptions for configuring a data migration, including whether to enable CloudWatch logs,\nand the selection rules to use to include or exclude database objects from the\nmigration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-datamigrationsettings.html", "Properties": { "SelectionRules": { "MarkdownDocumentation": "`SelectionRules`\n\nA JSON-formatted string that defines what objects to include and exclude from the\nmigration.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-datamigrationsettings.html#cfn-dms-datamigration-datamigrationsettings-selectionrules", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudwatchLogsEnabled": { "MarkdownDocumentation": "`CloudwatchLogsEnabled`\n\nWhether to enable CloudWatch logging for the data migration.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-datamigrationsettings.html#cfn-dms-datamigration-datamigrationsettings-cloudwatchlogsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NumberOfJobs": { "MarkdownDocumentation": "`NumberOfJobs`\n\nThe number of parallel jobs that trigger parallel threads to unload the tables from the\nsource, and then load them to the target.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-datamigrationsettings.html#cfn-dms-datamigration-datamigrationsettings-numberofjobs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DMS::DataMigration.SourceDataSettings": { "MarkdownDocumentation": "`AWS::DMS::DataMigration.SourceDataSettings`\n\nThe `SourceDataSettings` property type specifies Property description not available. for an [AWS::DMS::DataMigration](./aws-resource-dms-datamigration.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html", "Properties": { "CDCStartTime": { "MarkdownDocumentation": "`CDCStartTime`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html#cfn-dms-datamigration-sourcedatasettings-cdcstarttime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CDCStopTime": { "MarkdownDocumentation": "`CDCStopTime`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html#cfn-dms-datamigration-sourcedatasettings-cdcstoptime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SlotName": { "MarkdownDocumentation": "`SlotName`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html#cfn-dms-datamigration-sourcedatasettings-slotname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CDCStartPosition": { "MarkdownDocumentation": "`CDCStartPosition`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html#cfn-dms-datamigration-sourcedatasettings-cdcstartposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.DocDbSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.DocDbSettings`\n\nProvides information that defines a DocumentDB endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html", "Properties": { "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `none | require | verify-ful...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-full" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-sslmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nThe name of the server on the DocumentDB source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port value for the DocumentDB source endpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe database name on the DocumentDB source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.IbmDb2LuwSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.IbmDb2LuwSettings`\n\nThe `IbmDb2LuwSettings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](./aws-resource-dms-dataprovider.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.html", "Properties": { "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | verify-ca...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "verify-ca" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.html#cfn-dms-dataprovider-ibmdb2luwsettings-sslmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.html#cfn-dms-dataprovider-ibmdb2luwsettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.html#cfn-dms-dataprovider-ibmdb2luwsettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.html#cfn-dms-dataprovider-ibmdb2luwsettings-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.html#cfn-dms-dataprovider-ibmdb2luwsettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.IbmDb2zOsSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.IbmDb2zOsSettings`\n\nThe `IbmDb2zOsSettings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](./aws-resource-dms-dataprovider.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.html", "Properties": { "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | verify-ca...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "verify-ca" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.html#cfn-dms-dataprovider-ibmdb2zossettings-sslmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.html#cfn-dms-dataprovider-ibmdb2zossettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.html#cfn-dms-dataprovider-ibmdb2zossettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.html#cfn-dms-dataprovider-ibmdb2zossettings-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.html#cfn-dms-dataprovider-ibmdb2zossettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.MariaDbSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.MariaDbSettings`\n\nThe `MariaDbSettings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](./aws-resource-dms-dataprovider.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mariadbsettings.html", "Properties": { "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | require | verify-ca ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-ca", "verify-full" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mariadbsettings.html#cfn-dms-dataprovider-mariadbsettings-sslmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mariadbsettings.html#cfn-dms-dataprovider-mariadbsettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mariadbsettings.html#cfn-dms-dataprovider-mariadbsettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mariadbsettings.html#cfn-dms-dataprovider-mariadbsettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.MicrosoftSqlServerSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.MicrosoftSqlServerSettings`\n\nProvides information that defines a Microsoft SQL Server endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html", "Properties": { "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | require | verify-ca ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-ca", "verify-full" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html#cfn-dms-dataprovider-microsoftsqlserversettings-sslmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nFully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is\nthe output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html#cfn-dms-dataprovider-microsoftsqlserversettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nEndpoint TCP port.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html#cfn-dms-dataprovider-microsoftsqlserversettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nDatabase name for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html#cfn-dms-dataprovider-microsoftsqlserversettings-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html#cfn-dms-dataprovider-microsoftsqlserversettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.MongoDbSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.MongoDbSettings`\n\nProvides information that defines a MongoDB endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html", "Properties": { "AuthSource": { "MarkdownDocumentation": "`AuthSource`\n\nThe MongoDB database name. This setting isn't used when `AuthType` is\nset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-authsource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthMechanism": { "MarkdownDocumentation": "`AuthMechanism`\n\nThe authentication mechanism you use to access the MongoDB source endpoint.\nFor the default value, in MongoDB version 2.x, `\"default\"` is\n`\"mongodb_cr\"`. For MongoDB version 3.x or later, `\"default\"` is\n`\"scram_sha_1\"`. This setting isn't used when `AuthType` is\nset to `\"no\"`.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | mongodb_cr | scra...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "mongodb_cr", "scram_sha_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-authmechanism", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `none | require | verify-ful...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-full" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-sslmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nThe name of the server on the MongoDB source endpoint. For MongoDB Atlas, provide the\nserver name for any of the servers in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port value for the MongoDB source endpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nThe authentication type you use to access the MongoDB source endpoint.\nWhen when set to `\"no\"`, user name and password parameters are not used and\ncan 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)", "RefReturnValue": "", "AllowedValues": [ "no", "password" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-authtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.MySqlSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.MySqlSettings`\n\nProvides information that defines a MySQL endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mysqlsettings.html", "Properties": { "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | require | verify-ca ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-ca", "verify-full" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mysqlsettings.html#cfn-dms-dataprovider-mysqlsettings-sslmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nThe host name of the endpoint database.\nFor an Amazon RDS MySQL instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` field.\nFor an Aurora MySQL instance, this is the output of [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html), in the `Endpoint` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mysqlsettings.html#cfn-dms-dataprovider-mysqlsettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nEndpoint TCP port.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mysqlsettings.html#cfn-dms-dataprovider-mysqlsettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mysqlsettings.html#cfn-dms-dataprovider-mysqlsettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.OracleSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.OracleSettings`\n\nProvides information that defines an Oracle endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html", "Properties": { "SecretsManagerOracleAsmAccessRoleArn": { "MarkdownDocumentation": "`SecretsManagerOracleAsmAccessRoleArn`\n\nRequired only if your Oracle endpoint uses Automatic Storage Management (ASM). The full\nARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required\npermissions to access the `SecretsManagerOracleAsmSecret`. This\n`SecretsManagerOracleAsmSecret` has the secret value that allows access to\nthe Oracle ASM of the endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerOracleAsmSecretId`. Or you can\nspecify clear-text values for `AsmUser`, `AsmPassword`, and\n`AsmServerName`. You can't specify both. For more information on\ncreating this `SecretsManagerOracleAsmSecret` and the\n`SecretsManagerOracleAsmAccessRoleArn` and\n`SecretsManagerOracleAsmSecretId` 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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmaccessrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecretsManagerOracleAsmSecretId": { "MarkdownDocumentation": "`SecretsManagerOracleAsmSecretId`\n\nRequired only if your Oracle endpoint uses Automatic Storage Management (ASM). The full\nARN, partial ARN, or friendly name of the `SecretsManagerOracleAsmSecret` that\ncontains 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmsecretid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | require | verify-ca ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-ca", "verify-full" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-sslmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretsManagerSecurityDbEncryptionSecretId": { "MarkdownDocumentation": "`SecretsManagerSecurityDbEncryptionSecretId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionsecretid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nFully qualified domain name of the endpoint.\nFor an Amazon RDS Oracle instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nEndpoint TCP port.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nDatabase name for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AsmServer": { "MarkdownDocumentation": "`AsmServer`\n\nFor an Oracle source endpoint, your ASM server address. You can set this value from the\n`asm_server` value. You set `asm_server` as part of the extra\nconnection attribute string to access an Oracle server with Binary Reader that uses ASM.\nFor more information, see [Configuration for change data capture (CDC) on an Oracle source\ndatabase](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-asmserver", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecretsManagerSecurityDbEncryptionAccessRoleArn": { "MarkdownDocumentation": "`SecretsManagerSecurityDbEncryptionAccessRoleArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionaccessrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.PostgreSqlSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.PostgreSqlSettings`\n\nProvides information that defines a PostgreSQL endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html", "Properties": { "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | require | verify-ca ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-ca", "verify-full" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html#cfn-dms-dataprovider-postgresqlsettings-sslmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nThe host name of the endpoint database.\nFor an Amazon RDS PostgreSQL instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` field.\nFor an Aurora PostgreSQL instance, this is the output of [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html), in the `Endpoint` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html#cfn-dms-dataprovider-postgresqlsettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nEndpoint TCP port. The default is 5432.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html#cfn-dms-dataprovider-postgresqlsettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nDatabase name for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html#cfn-dms-dataprovider-postgresqlsettings-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html#cfn-dms-dataprovider-postgresqlsettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.RedshiftSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.RedshiftSettings`\n\nProvides information that defines an Amazon Redshift endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-redshiftsettings.html", "Properties": { "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nThe name of the Amazon Redshift cluster you are using.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-redshiftsettings.html#cfn-dms-dataprovider-redshiftsettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port number for Amazon Redshift. The default value is 5439.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-redshiftsettings.html#cfn-dms-dataprovider-redshiftsettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the Amazon Redshift data warehouse (service) that you are working\nwith.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-redshiftsettings.html#cfn-dms-dataprovider-redshiftsettings-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DMS::DataProvider.Settings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.Settings`\n\nThe `Settings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](./aws-resource-dms-dataprovider.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html", "Properties": { "MariaDbSettings": { "MarkdownDocumentation": "`MariaDbSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MariaDbSettings](./aws-properties-dms-dataprovider-mariadbsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-mariadbsettings", "UpdateType": "Mutable", "Required": false, "Type": "MariaDbSettings" }, "OracleSettings": { "MarkdownDocumentation": "`OracleSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [OracleSettings](./aws-properties-dms-dataprovider-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-oraclesettings", "UpdateType": "Mutable", "Required": false, "Type": "OracleSettings" }, "SybaseAseSettings": { "MarkdownDocumentation": "`SybaseAseSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [SybaseAseSettings](./aws-properties-dms-dataprovider-sybaseasesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-sybaseasesettings", "UpdateType": "Mutable", "Required": false, "Type": "SybaseAseSettings" }, "MicrosoftSqlServerSettings": { "MarkdownDocumentation": "`MicrosoftSqlServerSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MicrosoftSqlServerSettings](./aws-properties-dms-dataprovider-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-microsoftsqlserversettings", "UpdateType": "Mutable", "Required": false, "Type": "MicrosoftSqlServerSettings" }, "RedshiftSettings": { "MarkdownDocumentation": "`RedshiftSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [RedshiftSettings](./aws-properties-dms-dataprovider-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-redshiftsettings", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftSettings" }, "IbmDb2zOsSettings": { "MarkdownDocumentation": "`IbmDb2zOsSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [IbmDb2zOsSettings](./aws-properties-dms-dataprovider-ibmdb2zossettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-ibmdb2zossettings", "UpdateType": "Mutable", "Required": false, "Type": "IbmDb2zOsSettings" }, "MySqlSettings": { "MarkdownDocumentation": "`MySqlSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MySqlSettings](./aws-properties-dms-dataprovider-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-mysqlsettings", "UpdateType": "Mutable", "Required": false, "Type": "MySqlSettings" }, "IbmDb2LuwSettings": { "MarkdownDocumentation": "`IbmDb2LuwSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [IbmDb2LuwSettings](./aws-properties-dms-dataprovider-ibmdb2luwsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-ibmdb2luwsettings", "UpdateType": "Mutable", "Required": false, "Type": "IbmDb2LuwSettings" }, "DocDbSettings": { "MarkdownDocumentation": "`DocDbSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [DocDbSettings](./aws-properties-dms-dataprovider-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-docdbsettings", "UpdateType": "Mutable", "Required": false, "Type": "DocDbSettings" }, "PostgreSqlSettings": { "MarkdownDocumentation": "`PostgreSqlSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [PostgreSqlSettings](./aws-properties-dms-dataprovider-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-postgresqlsettings", "UpdateType": "Mutable", "Required": false, "Type": "PostgreSqlSettings" }, "MongoDbSettings": { "MarkdownDocumentation": "`MongoDbSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MongoDbSettings](./aws-properties-dms-dataprovider-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.html#cfn-dms-dataprovider-settings-mongodbsettings", "UpdateType": "Mutable", "Required": false, "Type": "MongoDbSettings" } } }, "AWS::DMS::DataProvider.SybaseAseSettings": { "MarkdownDocumentation": "`AWS::DMS::DataProvider.SybaseAseSettings`\n\nThe `SybaseAseSettings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](./aws-resource-dms-dataprovider.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-sybaseasesettings.html", "Properties": { "SslMode": { "MarkdownDocumentation": "`SslMode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | require | verify-ca...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-ca" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-sybaseasesettings.html#cfn-dms-dataprovider-sybaseasesettings-sslmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-sybaseasesettings.html#cfn-dms-dataprovider-sybaseasesettings-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-sybaseasesettings.html#cfn-dms-dataprovider-sybaseasesettings-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "EncryptPassword": { "MarkdownDocumentation": "`EncryptPassword`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-sybaseasesettings.html#cfn-dms-dataprovider-sybaseasesettings-encryptpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-sybaseasesettings.html#cfn-dms-dataprovider-sybaseasesettings-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-sybaseasesettings.html#cfn-dms-dataprovider-sybaseasesettings-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::Endpoint.DocDbSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.DocDbSettings`\n\nProvides information that defines a DocumentDB endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about other available settings, see\n[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\n[Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html", "Properties": { "DocsToInvestigate": { "Required": false, "MarkdownDocumentation": "`DocsToInvestigate`\n\nIndicates the number of documents to preview to determine the document organization.\nUse this setting when `NestingLevel` is set to `\"one\"`.\nMust be a positive value greater than `0`. Default value is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-docstoinvestigate", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ExtractDocId": { "Required": false, "MarkdownDocumentation": "`ExtractDocId`\n\nSpecifies the document ID. Use this setting when `NestingLevel` is set to\n`\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-extractdocid", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager secret\nthat allows access to the DocumentDB endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NestingLevel": { "Required": false, "MarkdownDocumentation": "`NestingLevel`\n\nSpecifies either document or table mode.\nDefault value is `\"none\"`. Specify `\"none\"` to use document mode.\nSpecify `\"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)\n", "RefReturnValue": "", "AllowedValues": [ "none", "one" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-nestinglevel", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.DynamoDbSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.DynamoDbSettings`\n\nProvides information, including the Amazon Resource Name (ARN) of the IAM\nrole used to define an Amazon DynamoDB target endpoint. This\ninformation also includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For information about other available settings, see\n[Using object mapping to migrate data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html", "Properties": { "ServiceAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`ServiceAccessRoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html#cfn-dms-endpoint-dynamodbsettings-serviceaccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.ElasticsearchSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.ElasticsearchSettings`\n\nProvides information that defines an OpenSearch endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about the available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html", "Properties": { "EndpointUri": { "Required": false, "MarkdownDocumentation": "`EndpointUri`\n\nThe endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport\nprotocol (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-endpointuri", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FullLoadErrorPercentage": { "Required": false, "MarkdownDocumentation": "`FullLoadErrorPercentage`\n\nThe maximum percentage of records that can fail to be written before a full load\noperation stops.\nTo avoid early failure, this counter is only effective after 1,000 records\nare transferred. OpenSearch also has the concept of error monitoring during the\nlast 10 minutes of an Observation Window. If transfer of all records fail in the\nlast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-fullloaderrorpercentage", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ErrorRetryDuration": { "Required": false, "MarkdownDocumentation": "`ErrorRetryDuration`\n\nThe maximum number of seconds for which DMS retries failed API requests to the\nOpenSearch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-errorretryduration", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ServiceAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`ServiceAccessRoleArn`\n\nThe Amazon Resource Name (ARN) used by the service to access the IAM role.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-serviceaccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.GcpMySQLSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.GcpMySQLSettings`\n\nProvides information that defines a GCP MySQL endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. These settings are much the same as\nthe settings for any MySQL-compatible endpoint. For more information, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html", "Properties": { "AfterConnectScript": { "Required": false, "MarkdownDocumentation": "`AfterConnectScript`\n\nSpecifies a script to run immediately after AWS DMS connects to the endpoint.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-afterconnectscript", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DatabaseName": { "Required": false, "MarkdownDocumentation": "`DatabaseName`\n\nDatabase name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify\nthe database using the `DatabaseName` request parameter on either the `CreateEndpoint`\nor `ModifyEndpoint` API call. Specifying `DatabaseName` when you create or modify a\nMySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify\nthe database only when you specify the schema in the table-mapping rules of the AWS DMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CleanSourceMetadataOnMismatch": { "Required": false, "MarkdownDocumentation": "`CleanSourceMetadataOnMismatch`\n\nAdjusts the behavior of AWS DMS when migrating from an SQL Server source database\nthat is hosted as part of an Always On availability group cluster. If you need AWS DMS\nto poll all the nodes in the Always On cluster for transaction backups, set this attribute 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-cleansourcemetadataonmismatch", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ServerTimezone": { "Required": false, "MarkdownDocumentation": "`ServerTimezone`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-servertimezone", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EventsPollInterval": { "Required": false, "MarkdownDocumentation": "`EventsPollInterval`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-eventspollinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ParallelLoadThreads": { "Required": false, "MarkdownDocumentation": "`ParallelLoadThreads`\n\nImproves performance when loading data into the MySQL-compatible target database. Specifies how many\nthreads to use to load the data into the MySQL-compatible target database. Setting a large number of\nthreads can have an adverse effect on database performance, because a separate connection is required\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-parallelloadthreads", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Username": { "Required": false, "MarkdownDocumentation": "`Username`\n\nEndpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaxFileSize": { "Required": false, "MarkdownDocumentation": "`MaxFileSize`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-maxfilesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ServerName": { "Required": false, "MarkdownDocumentation": "`ServerName`\n\nThe MySQL host 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-servername", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe full ARN, partial ARN, or display name of the `SecretsManagerSecret`\nthat 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS\nas the trusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret.` The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager secret\nthat allows access to the MySQL endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify\nthe values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text\nvalues for `UserName`, `Password`, `ServerName`, and `Port`.\nYou can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` required to\naccess it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Password": { "Required": false, "MarkdownDocumentation": "`Password`\n\nEndpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-password", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.IbmDb2Settings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.IbmDb2Settings`\n\nProvides information that defines an IBMDB2 endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about other available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html", "Properties": { "LoadTimeout": { "Required": false, "MarkdownDocumentation": "`LoadTimeout`\n\nThe amount of time (in milliseconds) before AWS DMS times out operations performed by DMS\non the Db2 target. The default value is 1200 (20 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-loadtimeout", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SetDataCaptureChanges": { "Required": false, "MarkdownDocumentation": "`SetDataCaptureChanges`\n\nEnables 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-setdatacapturechanges", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "MaxFileSize": { "Required": false, "MarkdownDocumentation": "`MaxFileSize`\n\nSpecifies the maximum size (in KB) of .csv files used to transfer data to Db2\nLUW.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-maxfilesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "KeepCsvFiles": { "Required": false, "MarkdownDocumentation": "`KeepCsvFiles`\n\nIf true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate\ndata. DMS uses these files for analysis and troubleshooting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-keepcsvfiles", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "CurrentLsn": { "Required": false, "MarkdownDocumentation": "`CurrentLsn`\n\nFor ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN)\nwhere 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-currentlsn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaxKBytesPerRead": { "Required": false, "MarkdownDocumentation": "`MaxKBytesPerRead`\n\nMaximum 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-maxkbytesperread", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "WriteBufferSize": { "Required": false, "MarkdownDocumentation": "`WriteBufferSize`\n\nThe size (in KB) of the in-memory file write buffer used when generating .csv files on\nthe local disk on the DMS replication instance. The default value is 1024 (1 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-writebuffersize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value ofthe AWS Secrets Manager secret\nthat allows access to the Db2 LUW endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.KafkaSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.KafkaSettings`\n\nProvides information that describes an Apache Kafka endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about other available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html", "Properties": { "Broker": { "Required": false, "MarkdownDocumentation": "`Broker`\n\nA comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location\nin the form `broker-hostname-or-ip:port`.\nFor example, `\"ec2-12-345-678-901.compute-1.amazonaws.com:2345\"`.\nFor more information and examples of specifying a list of broker locations, see\n[Using Apache Kafka as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-broker", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SaslPassword": { "Required": false, "MarkdownDocumentation": "`SaslPassword`\n\nThe secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and\nmake 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-saslpassword", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MessageFormat": { "Required": false, "MarkdownDocumentation": "`MessageFormat`\n\nThe output format for the records created on the endpoint. The message format is\n`JSON` (default) or `JSON_UNFORMATTED` (a single line with no\ntab).\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)", "RefReturnValue": "", "AllowedValues": [ "json", "json-unformatted" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-messageformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SslClientCertificateArn": { "Required": false, "MarkdownDocumentation": "`SslClientCertificateArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientcertificatearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IncludeTransactionDetails": { "Required": false, "MarkdownDocumentation": "`IncludeTransactionDetails`\n\nProvides detailed transaction information from the source database. This information\nincludes a commit timestamp, a log position, and values for `transaction_id`,\nprevious `transaction_id`, and `transaction_record_id` (the record\noffset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includetransactiondetails", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SecurityProtocol": { "Required": false, "MarkdownDocumentation": "`SecurityProtocol`\n\nSet secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include\n`ssl-encryption`, `ssl-authentication`, and `sasl-ssl`.\n`sasl-ssl` requires `SaslUsername` and `SaslPassword`.\n*Required*: No\n*Type*: String\n*Allowed values*: `plaintext | ssl-authenticat...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "plaintext", "ssl-authentication", "ssl-encryption", "sasl-ssl" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-securityprotocol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IncludeTableAlterOperations": { "Required": false, "MarkdownDocumentation": "`IncludeTableAlterOperations`\n\nIncludes any data definition language (DDL) operations that change the table in the\ncontrol data, such as `rename-table`, `drop-table`,\n`add-column`, `drop-column`, and `rename-column`. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includetablealteroperations", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SslCaCertificateArn": { "Required": false, "MarkdownDocumentation": "`SslCaCertificateArn`\n\nThe Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslcacertificatearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IncludeControlDetails": { "Required": false, "MarkdownDocumentation": "`IncludeControlDetails`\n\nShows detailed control information for table definition, column definition, and table\nand 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includecontroldetails", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludePartitionValue": { "Required": false, "MarkdownDocumentation": "`IncludePartitionValue`\n\nShows the partition value within the Kafka message output unless the partition type is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includepartitionvalue", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "NoHexPrefix": { "Required": false, "MarkdownDocumentation": "`NoHexPrefix`\n\nSet this optional parameter to `true` to avoid adding a '0x' prefix\nto raw data in hexadecimal format. For example, by default, AWS DMS adds a '0x'\nprefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka\ntarget. Use the `NoHexPrefix` endpoint setting to enable migration of RAW data\ntype 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-nohexprefix", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SslClientKeyArn": { "Required": false, "MarkdownDocumentation": "`SslClientKeyArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientkeyarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SslClientKeyPassword": { "Required": false, "MarkdownDocumentation": "`SslClientKeyPassword`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientkeypassword", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SaslUserName": { "Required": false, "MarkdownDocumentation": "`SaslUserName`\n\nThe secure user name you created when you first set up your Amazon MSK cluster to validate a\nclient identity and make an encrypted connection between server and client using SASL-SSL\nauthentication.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-saslusername", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MessageMaxBytes": { "Required": false, "MarkdownDocumentation": "`MessageMaxBytes`\n\nThe maximum size in bytes for records created on the endpoint The default is\n1,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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-messagemaxbytes", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Topic": { "Required": false, "MarkdownDocumentation": "`Topic`\n\nThe topic to which you migrate the data. If you don't specify a topic, AWS DMS\nspecifies `\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-topic", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PartitionIncludeSchemaTable": { "Required": false, "MarkdownDocumentation": "`PartitionIncludeSchemaTable`\n\nPrefixes schema and table names to partition values, when the partition type is\n`primary-key-type`. Doing this increases data distribution among Kafka\npartitions. For example, suppose that a SysBench schema has thousands of tables and each\ntable has only limited range for a primary key. In this case, the same primary key is sent\nfrom thousands of tables to the same partition, which causes throttling. The default is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-partitionincludeschematable", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeNullAndEmpty": { "Required": false, "MarkdownDocumentation": "`IncludeNullAndEmpty`\n\nInclude 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includenullandempty", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.KinesisSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.KinesisSettings`\n\nProvides information that describes an Amazon Kinesis Data Stream endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about other available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html", "Properties": { "MessageFormat": { "Required": false, "MarkdownDocumentation": "`MessageFormat`\n\nThe output format for the records created on the endpoint. The message format is\n`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)", "RefReturnValue": "", "AllowedValues": [ "json", "json-unformatted" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-messageformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IncludeTransactionDetails": { "Required": false, "MarkdownDocumentation": "`IncludeTransactionDetails`\n\nProvides detailed transaction information from the source database. This information\nincludes a commit timestamp, a log position, and values for `transaction_id`,\nprevious `transaction_id`, and `transaction_record_id` (the record\noffset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includetransactiondetails", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeTableAlterOperations": { "Required": false, "MarkdownDocumentation": "`IncludeTableAlterOperations`\n\nIncludes any data definition language (DDL) operations that change the table in the\ncontrol data, such as `rename-table`, `drop-table`,\n`add-column`, `drop-column`, and `rename-column`. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includetablealteroperations", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeControlDetails": { "Required": false, "MarkdownDocumentation": "`IncludeControlDetails`\n\nShows detailed control information for table definition, column definition, and table\nand 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includecontroldetails", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludePartitionValue": { "Required": false, "MarkdownDocumentation": "`IncludePartitionValue`\n\nShows the partition value within the Kinesis message output, unless the partition type\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includepartitionvalue", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "StreamArn": { "Required": false, "MarkdownDocumentation": "`StreamArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-streamarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ServiceAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`ServiceAccessRoleArn`\n\nThe Amazon Resource Name (ARN) for the IAM role\nthat AWS DMS uses to write to the Kinesis data stream.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-serviceaccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NoHexPrefix": { "Required": false, "MarkdownDocumentation": "`NoHexPrefix`\n\nSet this optional parameter to `true` to avoid adding a '0x' prefix\nto raw data in hexadecimal format. For example, by default, AWS DMS adds a '0x'\nprefix to the LOB column type in hexadecimal format moving from an Oracle source to an\nAmazon Kinesis target. Use the `NoHexPrefix` endpoint setting to enable\nmigration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-nohexprefix", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "PartitionIncludeSchemaTable": { "Required": false, "MarkdownDocumentation": "`PartitionIncludeSchemaTable`\n\nPrefixes schema and table names to partition values, when the partition type is\n`primary-key-type`. Doing this increases data distribution among Kinesis\nshards. For example, suppose that a SysBench schema has thousands of tables and each table\nhas only limited range for a primary key. In this case, the same primary key is sent from\nthousands 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-partitionincludeschematable", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IncludeNullAndEmpty": { "Required": false, "MarkdownDocumentation": "`IncludeNullAndEmpty`\n\nInclude 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includenullandempty", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.MicrosoftSqlServerSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.MicrosoftSqlServerSettings`\n\nProvides information that defines a Microsoft SQL Server endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html", "Properties": { "ReadBackupOnly": { "Required": false, "MarkdownDocumentation": "`ReadBackupOnly`\n\nWhen this attribute is set to `Y`, AWS DMS only reads changes from transaction\nlog backups and doesn't read from the active transaction log file during ongoing\nreplication. Setting this parameter to `Y` enables you to control active\ntransaction log file growth during full load and ongoing replication tasks. However, it can\nadd 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-readbackuponly", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "TlogAccessMode": { "Required": false, "MarkdownDocumentation": "`TlogAccessMode`\n\nIndicates the mode used to fetch CDC data.\n*Required*: No\n*Type*: String\n*Allowed values*: `BackupOnly | PreferBackup |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BackupOnly", "PreferBackup", "PreferTlog", "TlogOnly" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-tlogaccessmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BcpPacketSize": { "Required": false, "MarkdownDocumentation": "`BcpPacketSize`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-bcppacketsize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nEndpoint TCP port.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SafeguardPolicy": { "Required": false, "MarkdownDocumentation": "`SafeguardPolicy`\n\nUse this attribute to minimize the need to access the backup log and enable AWS DMS to\nprevent truncation using one of the following two methods.\n*Start transactions in the database:* This is the default method.\nWhen this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the\ndatabase. As long as such a transaction is open, changes that appear after the transaction\nstarted aren't truncated. If you need Microsoft Replication to be enabled in your database,\nthen you must choose this method.\n*Exclusively use sp\\_repldone within a single task*: When this method\nis used, AWS DMS reads the changes and then uses sp\\_repldone to mark the TLOG transactions as\nready for truncation. Although this method doesn't involve any transactional activities, it\ncan only be used when Microsoft Replication isn't running. Also, when using this method,\nonly one AWS DMS task can access the database at any given time. Therefore, if you need to\nrun 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-safeguardpolicy", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UseThirdPartyBackupDevice": { "Required": false, "MarkdownDocumentation": "`UseThirdPartyBackupDevice`\n\nWhen this attribute is set to `Y`, DMS processes third-party transaction log\nbackups 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-usethirdpartybackupdevice", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DatabaseName": { "Required": false, "MarkdownDocumentation": "`DatabaseName`\n\nDatabase name for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UseBcpFullLoad": { "Required": false, "MarkdownDocumentation": "`UseBcpFullLoad`\n\nUse this to attribute to transfer data for full-load operations using BCP. When the\ntarget table contains an identity column that does not exist in the source table, you must\ndisable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-usebcpfullload", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Username": { "Required": false, "MarkdownDocumentation": "`Username`\n\nEndpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "QuerySingleAlwaysOnNode": { "Required": false, "MarkdownDocumentation": "`QuerySingleAlwaysOnNode`\n\nCleans and recreates table metadata information on the replication instance when a\nmismatch occurs. An example is a situation where running an alter DDL statement on a table\nmight result in different information about the table cached in the replication\ninstance.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-querysinglealwaysonnode", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ServerName": { "Required": false, "MarkdownDocumentation": "`ServerName`\n\nFully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is\nthe output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-servername", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ControlTablesFileGroup": { "Required": false, "MarkdownDocumentation": "`ControlTablesFileGroup`\n\nSpecifies a file group for the AWS DMS internal tables. When the replication task starts,\nall the internal AWS DMS control tables (awsdms\\_ apply\\_exception, awsdms\\_apply,\nawsdms\\_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-controltablesfilegroup", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ForceLobLookup": { "Required": false, "MarkdownDocumentation": "`ForceLobLookup`\n\nForces LOB lookup on inline LOB.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-forceloblookup", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager\nsecret that allows access to the SQL Server endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TrimSpaceInChar": { "Required": false, "MarkdownDocumentation": "`TrimSpaceInChar`\n\nUse the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR\nand NCHAR data types during migration. Setting `TrimSpaceInChar` does not\nleft-trim data. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-trimspaceinchar", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Password": { "Required": false, "MarkdownDocumentation": "`Password`\n\nEndpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-password", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.MongoDbSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.MongoDbSettings`\n\nProvides information that defines a MongoDB endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about other available settings, see\n[Endpoint configuration settings when using MongoDB as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html", "Properties": { "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ExtractDocId": { "Required": false, "MarkdownDocumentation": "`ExtractDocId`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-extractdocid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DatabaseName": { "Required": false, "MarkdownDocumentation": "`DatabaseName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthSource": { "Required": false, "MarkdownDocumentation": "`AuthSource`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authsource", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthMechanism": { "Required": false, "MarkdownDocumentation": "`AuthMechanism`\n\nThe authentication mechanism you use to access the MongoDB source endpoint.\nFor the default value, in MongoDB version 2.x, `\"default\"` is\n`\"mongodb_cr\"`. For MongoDB version 3.x or later, `\"default\"` is\n`\"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 | scra...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "mongodb_cr", "scram_sha_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authmechanism", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Username": { "Required": false, "MarkdownDocumentation": "`Username`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DocsToInvestigate": { "Required": false, "MarkdownDocumentation": "`DocsToInvestigate`\n\nIndicates the number of documents to preview to determine the document organization.\nUse 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-docstoinvestigate", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ServerName": { "Required": false, "MarkdownDocumentation": "`ServerName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-servername", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthType": { "Required": false, "MarkdownDocumentation": "`AuthType`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "no", "password" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager secret\nthat allows access to the MongoDB endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Password": { "Required": false, "MarkdownDocumentation": "`Password`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-password", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NestingLevel": { "Required": false, "MarkdownDocumentation": "`NestingLevel`\n\nSpecifies either document or table mode.\nDefault value is `\"none\"`. Specify `\"none\"` to use document mode.\nSpecify `\"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)\n", "RefReturnValue": "", "AllowedValues": [ "none", "one" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-nestinglevel", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.MySqlSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.MySqlSettings`\n\nProvides information that defines a MySQL endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html", "Properties": { "ServerTimezone": { "Required": false, "MarkdownDocumentation": "`ServerTimezone`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-servertimezone", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EventsPollInterval": { "Required": false, "MarkdownDocumentation": "`EventsPollInterval`\n\nSpecifies how often to check the binary log for new changes/events when the database is\nidle. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-eventspollinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ParallelLoadThreads": { "Required": false, "MarkdownDocumentation": "`ParallelLoadThreads`\n\nImproves performance when loading data into the MySQL-compatible target database.\nSpecifies how many threads to use to load the data into the MySQL-compatible target\ndatabase. Setting a large number of threads can have an adverse effect on database\nperformance, because a separate connection is required for each thread. The default is\none.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-parallelloadthreads", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AfterConnectScript": { "Required": false, "MarkdownDocumentation": "`AfterConnectScript`\n\nSpecifies a script to run immediately after AWS DMS connects to the endpoint. The\nmigration 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\ncontaining 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-afterconnectscript", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaxFileSize": { "Required": false, "MarkdownDocumentation": "`MaxFileSize`\n\nSpecifies the maximum size (in KB) of any .csv file used to transfer data to a\nMySQL-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-maxfilesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TargetDbType": { "Required": false, "MarkdownDocumentation": "`TargetDbType`\n\nSpecifies where to migrate source tables on the target, either to a single database or\nmultiple databases. If you specify `SPECIFIC_DATABASE`, specify the database\nname using the `DatabaseName` parameter of the `Endpoint`\nobject.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-targetdbtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe full ARN, partial ARN, or display name of the `SecretsManagerSecret`\nthat 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager secret\nthat allows access to the MySQL endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CleanSourceMetadataOnMismatch": { "Required": false, "MarkdownDocumentation": "`CleanSourceMetadataOnMismatch`\n\nCleans and recreates table metadata information on the replication instance when a\nmismatch occurs. For example, in a situation where running an alter DDL on the table could\nresult 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-cleansourcemetadataonmismatch", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.NeptuneSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.NeptuneSettings`\n\nProvides information that defines an Amazon Neptune endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about the available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html", "Properties": { "MaxRetryCount": { "Required": false, "MarkdownDocumentation": "`MaxRetryCount`\n\nThe number of times for AWS DMS to retry a bulk load of migrated graph data to the\nNeptune 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxretrycount", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MaxFileSize": { "Required": false, "MarkdownDocumentation": "`MaxFileSize`\n\nThe maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS\nbulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the\nbulk load is successful, AWS DMS clears the bucket, ready to store the next batch of\nmigrated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxfilesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "S3BucketFolder": { "Required": false, "MarkdownDocumentation": "`S3BucketFolder`\n\nA folder path where you want AWS DMS to store migrated graph data in the S3 bucket\nspecified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketfolder", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ErrorRetryDuration": { "Required": false, "MarkdownDocumentation": "`ErrorRetryDuration`\n\nThe number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph\ndata 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-errorretryduration", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "IamAuthEnabled": { "Required": false, "MarkdownDocumentation": "`IamAuthEnabled`\n\nIf you want IAM authorization enabled for this\nendpoint, set this parameter to `true`. Then attach the appropriate IAM policy\ndocument to your service role specified by `ServiceAccessRoleArn`. The default\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-iamauthenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "S3BucketName": { "Required": false, "MarkdownDocumentation": "`S3BucketName`\n\nThe name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data\nin .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL\nsource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ServiceAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`ServiceAccessRoleArn`\n\nThe Amazon Resource Name (ARN) of the service role that you created for the Neptune\ntarget endpoint. The role must allow the `iam:PassRole` action.\nFor more information, see\n[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)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-serviceaccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.OracleSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.OracleSettings`\n\nProvides information that defines an Oracle endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html", "Properties": { "AsmPassword": { "Required": false, "MarkdownDocumentation": "`AsmPassword`\n\nFor an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.\nYou can set this value from the `asm_user_password` value.\nYou set this value as part of the comma-separated value that you set to the\n`Password` request parameter when you create the endpoint to access\ntransaction logs using Binary Reader. For more information, see [Configuration for change data capture (CDC) on an Oracle source\ndatabase](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-asmpassword", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DirectPathParallelLoad": { "Required": false, "MarkdownDocumentation": "`DirectPathParallelLoad`\n\nWhen set to `true`, this attribute specifies a parallel load when\n`useDirectPathFullLoad` is set to `Y`. This attribute also only\napplies when you use the AWS DMS parallel load feature. Note that the target table cannot\nhave 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-directpathparallelload", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AdditionalArchivedLogDestId": { "Required": false, "MarkdownDocumentation": "`AdditionalArchivedLogDestId`\n\nSet this attribute with `ArchivedLogDestId` in a primary/ standby setup. This\nattribute is useful in the case of a switchover. In this case, AWS DMS needs to know which\ndestination to get archive redo logs from to read changes. This need arises because the\nprevious primary instance is now a standby instance after switchover.\nAlthough AWS DMS supports the use of the Oracle `RESETLOGS` option to open the\ndatabase, never use `RESETLOGS` unless necessary. For additional information\nabout `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\nUser'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-additionalarchivedlogdestid", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SpatialDataOptionToGeoJsonFunctionName": { "Required": false, "MarkdownDocumentation": "`SpatialDataOptionToGeoJsonFunctionName`\n\nUse this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format.\nBy default, DMS calls the `SDO2GEOJSON` custom function if present and\naccessible. Or you can create your own custom function that mimics the operation of\n`SDOGEOJSON` and set `SpatialDataOptionToGeoJsonFunctionName` to\ncall 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-spatialdataoptiontogeojsonfunctionname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReplacePathPrefix": { "Required": false, "MarkdownDocumentation": "`ReplacePathPrefix`\n\nSet this attribute to true in order to use the Binary Reader to capture change data for\nan Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default\nOracle root with the specified `usePathPrefix` setting to access the redo\nlogs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-replacepathprefix", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "FailTasksOnLobTruncation": { "Required": false, "MarkdownDocumentation": "`FailTasksOnLobTruncation`\n\nWhen set to `true`, this attribute causes a task to fail if the actual size\nof 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\ntask 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-failtasksonlobtruncation", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AsmServer": { "Required": false, "MarkdownDocumentation": "`AsmServer`\n\nFor an Oracle source endpoint, your ASM server address. You can set this value from the\n`asm_server` value. You set `asm_server` as part of the extra\nconnection attribute string to access an Oracle server with Binary Reader that uses ASM.\nFor more information, see [Configuration for change data capture (CDC) on an Oracle source\ndatabase](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-asmserver", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerOracleAsmAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerOracleAsmAccessRoleArn`\n\nRequired only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN\nof the IAM role that specifies AWS DMS as the trusted entity and grants the required\npermissions to access the `SecretsManagerOracleAsmSecret`. This\n`SecretsManagerOracleAsmSecret` has the secret value that allows access to\nthe Oracle ASM of the endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerOracleAsmSecretId`. Or you can\nspecify clear-text values for `AsmUser`, `AsmPassword`, and\n`AsmServerName`. You can't specify both.\nFor more information on creating this `SecretsManagerOracleAsmSecret`, the corresponding\n`SecretsManagerOracleAsmAccessRoleArn`, and the `SecretsManagerOracleAsmSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-secretsmanageroracleasmaccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OraclePathPrefix": { "Required": false, "MarkdownDocumentation": "`OraclePathPrefix`\n\nSet this string attribute to the required value in order to use the Binary Reader to\ncapture change data for an Amazon RDS for Oracle as the source. This value specifies the\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-oraclepathprefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReadAheadBlocks": { "Required": false, "MarkdownDocumentation": "`ReadAheadBlocks`\n\nSet this attribute to change the number of read-ahead blocks that DMS configures to\nperform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM).\nYou can specify an integer value between 1000 (the default) and 200,000 (the\nmaximum).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-readaheadblocks", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "StandbyDelayTime": { "Required": false, "MarkdownDocumentation": "`StandbyDelayTime`\n\nUse this attribute to specify a time in minutes for the delay in standby sync. If the\nsource is an Oracle Active Data Guard standby database, use this attribute to specify the\ntime lag between primary and standby databases.\nIn AWS DMS, you can create an Oracle CDC task that uses an Active Data Guard standby\ninstance as a source for replicating ongoing changes. Doing this eliminates the need to\nconnect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-standbydelaytime", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AllowSelectNestedTables": { "Required": false, "MarkdownDocumentation": "`AllowSelectNestedTables`\n\nSet this attribute to `true` to enable replication of Oracle tables\ncontaining 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-allowselectnestedtables", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AddSupplementalLogging": { "Required": false, "MarkdownDocumentation": "`AddSupplementalLogging`\n\nSet this attribute to set up table-level supplemental logging for the Oracle database.\nThis attribute enables PRIMARY KEY supplemental logging on all tables selected for a\nmigration task.\nIf you use this option, you still need to enable database-level supplemental\nlogging.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-addsupplementallogging", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UseBFile": { "Required": false, "MarkdownDocumentation": "`UseBFile`\n\nSet this attribute to True to capture change data using the Binary Reader utility. Set\n`UseLogminerReader` to False to set this attribute to True. To use Binary\nReader with Amazon RDS for Oracle as the source, you set additional attributes. For more\ninformation about using this setting with Oracle Automatic Storage Management (ASM), see\n [Using Oracle LogMiner or AWS DMS Binary Reader for\nCDC](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-usebfile", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "EnableHomogenousTablespace": { "Required": false, "MarkdownDocumentation": "`EnableHomogenousTablespace`\n\nSet this attribute to enable homogenous tablespace replication and create existing\ntables 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-enablehomogenoustablespace", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AsmUser": { "Required": false, "MarkdownDocumentation": "`AsmUser`\n\nFor an Oracle source endpoint, your ASM user name. You can set this value from the\n`asm_user` value. You set `asm_user` as part of the extra\nconnection attribute string to access an Oracle server with Binary Reader that uses ASM.\nFor more information, see [Configuration for change data capture (CDC) on an Oracle source\ndatabase](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-asmuser", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UseDirectPathFullLoad": { "Required": false, "MarkdownDocumentation": "`UseDirectPathFullLoad`\n\nSet this attribute to True to have AWS DMS use a direct path full load. Specify this value\nto use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI\nprotocol, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-usedirectpathfullload", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SecurityDbEncryption": { "Required": false, "MarkdownDocumentation": "`SecurityDbEncryption`\n\nFor an Oracle source endpoint, the transparent data encryption (TDE) password required\nby AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the\n`TDE_Password` part of the comma-separated value you\nset to the `Password` request parameter when you create the endpoint. The\n`SecurityDbEncryptian` setting is related to this\n`SecurityDbEncryptionName` setting. For more information, see [Supported encryption methods for using Oracle as a source for\nAWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-securitydbencryption", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ParallelAsmReadThreads": { "Required": false, "MarkdownDocumentation": "`ParallelAsmReadThreads`\n\nSet this attribute to change the number of threads that DMS configures to perform a\nchange data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can\nspecify an integer value between 2 (the default) and 8 (the maximum). Use this attribute\ntogether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-parallelasmreadthreads", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ArchivedLogDestId": { "Required": false, "MarkdownDocumentation": "`ArchivedLogDestId`\n\nSpecifies the ID of the destination for the archived redo logs. This value should be the\nsame as a number in the dest\\_id column of the v$archived\\_log view. If you work with an\nadditional redo log destination, use the `AdditionalArchivedLogDestId` option to\nspecify the additional destination ID. Doing this improves performance by ensuring that the\ncorrect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-archivedlogdestid", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "UsePathPrefix": { "Required": false, "MarkdownDocumentation": "`UsePathPrefix`\n\nSet this string attribute to the required value in order to use the Binary Reader to\ncapture change data for an Amazon RDS for Oracle as the source. This value specifies the\npath 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-usepathprefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UseLogminerReader": { "Required": false, "MarkdownDocumentation": "`UseLogminerReader`\n\nSet this attribute to True to capture change data using the Oracle LogMiner utility (the\ndefault). Set this attribute to False if you want to access the redo logs as a binary file.\nWhen you set `UseLogminerReader` to False, also set `UseBfile` to\nTrue. 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\nthe *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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-uselogminerreader", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SecurityDbEncryptionName": { "Required": false, "MarkdownDocumentation": "`SecurityDbEncryptionName`\n\nFor an Oracle source endpoint, the name of a key used for the transparent data\nencryption (TDE) of the columns and tablespaces in an Oracle source database that is\nencrypted using TDE. The key value is the value of the `SecurityDbEncryption`\nsetting. For more information on setting the key name value of\n`SecurityDbEncryptionName`, see the information and example for setting the\n`securityDbEncryptionName` extra connection attribute in [Supported encryption methods for using Oracle as a source for\nAWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-securitydbencryptionname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DirectPathNoLog": { "Required": false, "MarkdownDocumentation": "`DirectPathNoLog`\n\nWhen set to `true`, this attribute helps to increase the commit rate on the\nOracle target database by writing directly to tables and not writing a trail to database\nlogs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-directpathnolog", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SecretsManagerOracleAsmSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerOracleAsmSecretId`\n\nRequired only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or display name of the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-secretsmanageroracleasmsecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CharLengthSemantics": { "Required": false, "MarkdownDocumentation": "`CharLengthSemantics`\n\nSpecifies whether the length of a character column is in bytes or in characters. To\nindicate that the character column length is in characters, set this attribute to\n`CHAR`. Otherwise, the character column length is in bytes.\nExample: `charLengthSemantics=CHAR;`\n*Required*: No\n*Type*: String\n*Allowed values*: `default | char | byte...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "char", "byte" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-charlengthsemantics", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NumberDatatypeScale": { "Required": false, "MarkdownDocumentation": "`NumberDatatypeScale`\n\nSpecifies the number scale. You can select a scale up to 38, or you can select FLOAT. By\ndefault, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-numberdatatypescale", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ReadTableSpaceName": { "Required": false, "MarkdownDocumentation": "`ReadTableSpaceName`\n\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-readtablespacename", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AccessAlternateDirectly": { "Required": false, "MarkdownDocumentation": "`AccessAlternateDirectly`\n\nSet this attribute to `false` in order to use the Binary Reader to capture\nchange data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not\naccess redo logs through any specified path prefix replacement using direct file\naccess.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-accessalternatedirectly", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "UseAlternateFolderForOnline": { "Required": false, "MarkdownDocumentation": "`UseAlternateFolderForOnline`\n\nSet this attribute to `true` in order to use the Binary Reader to capture\nchange data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any\nspecified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-usealternatefolderforonline", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ArchivedLogsOnly": { "Required": false, "MarkdownDocumentation": "`ArchivedLogsOnly`\n\nWhen this field is set to `True`, AWS DMS only accesses the archived redo logs.\nIf the archived redo logs are stored on Automatic Storage Management (ASM) only, the AWS DMS\nuser 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-archivedlogsonly", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ExtraArchivedLogDestIds": { "PrimitiveItemType": "Integer", "Type": "List", "Required": false, "MarkdownDocumentation": "`ExtraArchivedLogDestIds`\n\nSpecifies the IDs of one more destinations for one or more archived redo logs. These IDs\nare the values of the `dest_id` column in the `v$archived_log` view.\nUse this setting with the `archivedLogDestId` extra connection attribute in a\nprimary-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\nsource. In this case, AWS DMS needs information about what destination to get archive redo\nlogs from to read changes. AWS DMS needs this because after the switchover the previous\nprimary is a standby instance. For example, in a primary-to-single standby setup you might\napply 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\ndatabase, never use `RESETLOGS` unless it's necessary. For more information\nabout `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\nUser's Guide*.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-extraarchivedlogdestids", "UpdateType": "Mutable" }, "RetryInterval": { "Required": false, "MarkdownDocumentation": "`RetryInterval`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-retryinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager secret\nthat allows access to the Oracle endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.PostgreSqlSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.PostgreSqlSettings`\n\nProvides information that defines a PostgreSQL endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html", "Properties": { "PluginName": { "Required": false, "MarkdownDocumentation": "`PluginName`\n\nSpecifies the plugin to use to create a replication slot.\nThe default value is `pglogical`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-pluginname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MapBooleanAsBoolean": { "Required": false, "MarkdownDocumentation": "`MapBooleanAsBoolean`\n\nWhen true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL\nmigrates booleans as `varchar(5)`. You must set this setting on both the source\nand target endpoints for it to take effect.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-mapbooleanasboolean", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AfterConnectScript": { "Required": false, "MarkdownDocumentation": "`AfterConnectScript`\n\nFor use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign\nkeys 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-afterconnectscript", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExecuteTimeout": { "Required": false, "MarkdownDocumentation": "`ExecuteTimeout`\n\nSets the client statement timeout for the PostgreSQL instance, in seconds. The default\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-executetimeout", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DdlArtifactsSchema": { "Required": false, "MarkdownDocumentation": "`DdlArtifactsSchema`\n\nThe schema in which the operational DDL database artifacts are created.\nThe default value is `public`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-ddlartifactsschema", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FailTasksOnLobTruncation": { "Required": false, "MarkdownDocumentation": "`FailTasksOnLobTruncation`\n\nWhen set to `true`, this value causes a task to fail if the actual size of a\nLOB column is greater than the specified `LobMaxSize`.\nThe default value is `false`.\nIf task is set to Limited LOB mode and this option is set to true, the task fails\ninstead 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-failtasksonlobtruncation", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "HeartbeatEnable": { "Required": false, "MarkdownDocumentation": "`HeartbeatEnable`\n\nThe write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this,\nit prevents idle logical replication slots from holding onto old WAL logs, which can result\nin storage full situations on the source. This heartbeat keeps `restart_lsn`\nmoving and prevents storage full scenarios.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatenable", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "BabelfishDatabaseName": { "Required": false, "MarkdownDocumentation": "`BabelfishDatabaseName`\n\nThe Babelfish for Aurora PostgreSQL database name for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-babelfishdatabasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DatabaseMode": { "Required": false, "MarkdownDocumentation": "`DatabaseMode`\n\nSpecifies the default behavior of the replication's handling of PostgreSQL- compatible\nendpoints that require some additional configuration, such as Babelfish endpoints.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | babelfish...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "babelfish" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-databasemode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CaptureDdls": { "Required": false, "MarkdownDocumentation": "`CaptureDdls`\n\nTo capture DDL events, AWS DMS creates various artifacts in\nthe PostgreSQL database when the task starts. You can later\nremove these artifacts.\nIf this value is set to `True`, you don't have to create tables or\ntriggers 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-captureddls", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "MaxFileSize": { "Required": false, "MarkdownDocumentation": "`MaxFileSize`\n\nSpecifies the maximum size (in KB) of any .csv file used to transfer data to\nPostgreSQL.\nThe default value is 32,768 KB (32 MB).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-maxfilesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "HeartbeatFrequency": { "Required": false, "MarkdownDocumentation": "`HeartbeatFrequency`\n\nSets the WAL heartbeat frequency (in minutes).\nThe default value is 5 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatfrequency", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager secret\nthat allows access to the PostgreSQL endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HeartbeatSchema": { "Required": false, "MarkdownDocumentation": "`HeartbeatSchema`\n\nSets the schema in which the heartbeat artifacts are created.\nThe default value is `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatschema", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SlotName": { "Required": false, "MarkdownDocumentation": "`SlotName`\n\nSets the name of a previously created logical replication slot for a change data capture\n(CDC) load of the PostgreSQL source instance.\nWhen used with the `CdcStartPosition` request parameter for the AWS DMS API ,\nthis attribute also makes it possible to use native CDC start points. DMS verifies that the\nspecified logical replication slot exists before starting the CDC load task. It also\nverifies that the task was created with a valid setting of `CdcStartPosition`.\nIf the specified slot doesn't exist or the task doesn't have a valid\n`CdcStartPosition` setting, DMS raises an error.\nFor more information about setting the `CdcStartPosition` request parameter,\nsee [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the *AWS Database Migration Service User\nGuide*. For more information about using `CdcStartPosition`, see\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-slotname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.RedisSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.RedisSettings`\n\nProvides information that defines a Redis target endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For information about other available settings, see\n[Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html", "Properties": { "SslSecurityProtocol": { "Required": false, "MarkdownDocumentation": "`SslSecurityProtocol`\n\nThe connection to a Redis target endpoint using Transport Layer Security (TLS). Valid\nvalues include `plaintext` and `ssl-encryption`. The default is\n`ssl-encryption`. The `ssl-encryption` option makes an encrypted\nconnection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA)\nusing the `SslCaCertificateArn` setting. If an ARN isn't given for a CA, DMS\nuses the Amazon root CA.\nThe `plaintext` option doesn't provide Transport Layer Security (TLS)\nencryption 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)", "RefReturnValue": "", "AllowedValues": [ "plaintext", "ssl-encryption" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-sslsecurityprotocol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthUserName": { "Required": false, "MarkdownDocumentation": "`AuthUserName`\n\nThe user name provided with the `auth-role` option of the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authusername", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ServerName": { "Required": false, "MarkdownDocumentation": "`ServerName`\n\nFully qualified domain name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-servername", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nTransmission Control Protocol (TCP) port for the endpoint.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-port", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "SslCaCertificateArn": { "Required": false, "MarkdownDocumentation": "`SslCaCertificateArn`\n\nThe Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to\nconnect to your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-sslcacertificatearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthPassword": { "Required": false, "MarkdownDocumentation": "`AuthPassword`\n\nThe password provided with the `auth-role` and\n`auth-token` options of the `AuthType` setting for a Redis\ntarget 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authpassword", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthType": { "Required": false, "MarkdownDocumentation": "`AuthType`\n\nThe type of authentication to perform when connecting to a Redis target. Options include\n`none`, `auth-token`, and `auth-role`. The\n`auth-token` option requires an `AuthPassword` value to be provided. The\n`auth-role` option requires `AuthUserName` and `AuthPassword` values\nto be provided.\n*Required*: No\n*Type*: String\n*Allowed values*: `none | auth-role | auth-tok...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "auth-role", "auth-token" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authtype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.RedshiftSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.RedshiftSettings`\n\nProvides information that defines an Amazon Redshift endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about other available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html", "Properties": { "ConnectionTimeout": { "Required": false, "MarkdownDocumentation": "`ConnectionTimeout`\n\nA value that sets the amount of time to wait (in milliseconds) before timing out,\nbeginning 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-connectiontimeout", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MapBooleanAsBoolean": { "Required": false, "MarkdownDocumentation": "`MapBooleanAsBoolean`\n\nWhen true, lets Redshift migrate the boolean type as boolean. By default, Redshift\nmigrates booleans as `varchar(1)`. You must set this setting on both the source\nand target endpoints for it to take effect.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-mapbooleanasboolean", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AfterConnectScript": { "Required": false, "MarkdownDocumentation": "`AfterConnectScript`\n\nCode to run after connecting. This parameter should contain the code itself, not the\nname 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-afterconnectscript", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FileTransferUploadStreams": { "Required": false, "MarkdownDocumentation": "`FileTransferUploadStreams`\n\nThe number of threads used to upload a single file. This parameter accepts a value from\n1 through 64. It defaults to 10.\nThe number of parallel streams used to upload a single .csv file to an S3 bucket using\nS3 Multipart Upload. For more information, see [Multipart upload\noverview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html).\n`FileTransferUploadStreams` accepts a value from 1 through 64. It defaults to\n10.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-filetransferuploadstreams", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "BucketName": { "Required": false, "MarkdownDocumentation": "`BucketName`\n\nThe name of the intermediate S3 bucket used to store .csv files before uploading data to\nRedshift.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-bucketname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ServerSideEncryptionKmsKeyId": { "Required": false, "MarkdownDocumentation": "`ServerSideEncryptionKmsKeyId`\n\nThe AWS KMS key ID. If you are using `SSE_KMS` for the\n`EncryptionMode`, provide this key ID. The key that you use needs an attached\npolicy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-serversideencryptionkmskeyid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExplicitIds": { "Required": false, "MarkdownDocumentation": "`ExplicitIds`\n\nThis setting is only valid for a full-load migration task. Set `ExplicitIds`\nto `true` to have tables with `IDENTITY` columns override their\nauto-generated values with explicit values loaded from the source data files used to\npopulate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-explicitids", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TruncateColumns": { "Required": false, "MarkdownDocumentation": "`TruncateColumns`\n\nA value that specifies to truncate data in columns to the appropriate number of\ncharacters, so that the data fits in the column. This parameter applies only to columns\nwith a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-truncatecolumns", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ServiceAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`ServiceAccessRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift\nservice. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-serviceaccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReplaceChars": { "Required": false, "MarkdownDocumentation": "`ReplaceChars`\n\nA value that specifies to replaces the invalid characters specified in\n`ReplaceInvalidChars`, substituting the specified characters instead. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-replacechars", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimeFormat": { "Required": false, "MarkdownDocumentation": "`TimeFormat`\n\nThe time format that you want to use. Valid values are `auto`\n(case-sensitive), `'timeformat_string'`, `'epochsecs'`, or\n`'epochmillisecs'`. It defaults to 10. Using `auto` recognizes\nmost 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\nto `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-timeformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BucketFolder": { "Required": false, "MarkdownDocumentation": "`BucketFolder`\n\nAn S3 folder where the comma-separated-value (.csv) files are stored before being\nuploaded to the target Redshift cluster.\nFor full load mode, AWS DMS converts source records into .csv files and loads them to the\n*BucketFolder/TableID* path. AWS DMS uses the Redshift\n`COPY` command to upload the .csv files to the target table. The files are\ndeleted once the `COPY` operation has finished. For more information, see [COPY](https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the\n*Amazon Redshift Database Developer Guide*.\nFor change-data-capture (CDC) mode, AWS DMS creates a *NetChanges*\ntable, and loads the .csv files to this *BucketFolder/NetChangesTableID*\npath.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-bucketfolder", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReplaceInvalidChars": { "Required": false, "MarkdownDocumentation": "`ReplaceInvalidChars`\n\nA list of characters that you want to replace. Use with\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-replaceinvalidchars", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RemoveQuotes": { "Required": false, "MarkdownDocumentation": "`RemoveQuotes`\n\nA value that specifies to remove surrounding quotation marks from strings in the\nincoming data. All characters within the quotation marks, including delimiters, are\nretained. Choose `true` to remove quotation marks. The default is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-removequotes", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "LoadTimeout": { "Required": false, "MarkdownDocumentation": "`LoadTimeout`\n\nThe amount of time to wait (in milliseconds) before timing out of operations performed\nby 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-loadtimeout", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MaxFileSize": { "Required": false, "MarkdownDocumentation": "`MaxFileSize`\n\nThe maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer\ndata 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-maxfilesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TrimBlanks": { "Required": false, "MarkdownDocumentation": "`TrimBlanks`\n\nA value that specifies to remove the trailing white space characters from a VARCHAR\nstring. This parameter applies only to columns with a VARCHAR data type. Choose\n`true` to remove unneeded white space. The default is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-trimblanks", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DateFormat": { "Required": false, "MarkdownDocumentation": "`DateFormat`\n\nThe date format that you are using. Valid values are `auto` (case-sensitive),\nyour date format string enclosed in quotes, or NULL. If this parameter is left unset\n(NULL), it defaults to a format of 'YYYY-MM-DD'. Using `auto` recognizes most\nstrings, 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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-dateformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CompUpdate": { "Required": false, "MarkdownDocumentation": "`CompUpdate`\n\nIf you set `CompUpdate` to `true` Amazon Redshift applies\nautomatic compression if the table is empty. This applies even if the table columns already\nhave encodings other than `RAW`. If you set `CompUpdate` to\n`false`, automatic compression is disabled and existing column encodings\naren'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-compupdate", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AcceptAnyDate": { "Required": false, "MarkdownDocumentation": "`AcceptAnyDate`\n\nA value that indicates to allow any date format, including invalid formats such as\n00/00/00 00:00:00, to be loaded without generating an error. You can choose\n`true` or `false` (the default).\nThis parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with\nthe DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT\nspecification, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-acceptanydate", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "WriteBufferSize": { "Required": false, "MarkdownDocumentation": "`WriteBufferSize`\n\nThe size (in KB) of the in-memory file write buffer used when generating .csv files on\nthe local disk at the DMS replication instance. The default value is 1000 (buffer size is\n1000KB).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-writebuffersize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager secret\nthat allows access to the Amazon Redshift endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CaseSensitiveNames": { "Required": false, "MarkdownDocumentation": "`CaseSensitiveNames`\n\nIf Amazon Redshift is configured to support case sensitive schema names, set\n`CaseSensitiveNames` to `true`. The default is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-casesensitivenames", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "EmptyAsNull": { "Required": false, "MarkdownDocumentation": "`EmptyAsNull`\n\nA value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as\nNULL. A value of `true` sets empty CHAR and VARCHAR fields to null. The default\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-emptyasnull", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "EncryptionMode": { "Required": false, "MarkdownDocumentation": "`EncryptionMode`\n\nThe type of server-side encryption that you want to use for your data. This encryption\ntype is part of the endpoint settings or the extra connections attributes for Amazon S3.\nYou can choose either `SSE_S3` (the default) or `SSE_KMS`.\n###### Note\nFor the `ModifyEndpoint` operation, you can change the existing value of\nthe `EncryptionMode` parameter from `SSE_KMS` to\n`SSE_S3`. But you can\u2019t change the existing value from `SSE_S3`\nto `SSE_KMS`.\nTo use `SSE_S3`, create an AWS Identity and Access Management (IAM) role with a policy that allows\n`\"arn:aws:s3:::*\"` to use the following actions: `\"s3:PutObject\",\n\"s3:ListBucket\"`\n*Required*: No\n*Type*: String\n*Allowed values*: `sse-s3 | 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)", "RefReturnValue": "", "AllowedValues": [ "sse-s3", "sse-kms" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-encryptionmode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.S3Settings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.S3Settings`\n\nProvides information that defines an Amazon S3 endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For more information about the available settings, see\n[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\n[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)\nin the*AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html", "Properties": { "TimestampColumnName": { "Required": false, "MarkdownDocumentation": "`TimestampColumnName`\n\nA value that when nonblank causes AWS DMS to add a column with timestamp information to\nthe endpoint data for an Amazon S3 target.\n###### Note\nAWS DMS supports the `TimestampColumnName` parameter in versions 3.1.4 and later.\nAWS DMS includes an additional `STRING` column in the\n.csv or .parquet object files of your migrated data when you set\n`TimestampColumnName` to a nonblank value.\nFor a full load, each row of this timestamp column contains a\ntimestamp for when the data was transferred from the source to\nthe target by DMS.\nFor a change data capture (CDC) load, each row of the timestamp column contains the\ntimestamp for the commit of that row in the source\ndatabase.\nThe string format for this timestamp column value is\n`yyyy-MM-dd HH:mm:ss.SSSSSS`. By default, the\nprecision of this value is in microseconds. For a CDC load, the\nrounding of the precision depends on the commit timestamp\nsupported by DMS for the source database.\nWhen the `AddColumnName` parameter is set to `true`, DMS also\nincludes a name for the timestamp column that you set with\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-timestampcolumnname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EnableStatistics": { "Required": false, "MarkdownDocumentation": "`EnableStatistics`\n\nA value that enables statistics for Parquet pages and row groups. Choose\n`true` to enable statistics, `false` to disable. Statistics\ninclude `NULL`, `DISTINCT`, `MAX`, and `MIN`\nvalues. This parameter defaults to `true`. This value is used for\n.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-enablestatistics", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DatePartitionSequence": { "Required": false, "MarkdownDocumentation": "`DatePartitionSequence`\n\nIdentifies the sequence of the date format to use during folder partitioning. The default value is\n`YYYYMMDD`. Use this parameter when `DatePartitionedEnabled` is set to `true`.\n*Required*: No\n*Type*: String\n*Allowed values*: `YYYYMMDD | YYYYMMDDHH | YYY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YYYYMMDD", "YYYYMMDDHH", "YYYYMM", "MMYYYYDD", "DDMMYYYY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datepartitionsequence", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CsvNullValue": { "Required": false, "MarkdownDocumentation": "`CsvNullValue`\n\nAn optional parameter that specifies how AWS DMS treats null\nvalues. While handling the null value, you can use this\nparameter to pass a user-defined string as null when writing to\nthe target. For example, when target columns are not nullable,\nyou can use this option to differentiate between the empty\nstring value and the null value. So, if you set this parameter\nvalue to the empty string (\"\" or ''), AWS DMS treats the empty\nstring 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvnullvalue", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IncludeOpForFullLoad": { "Required": false, "MarkdownDocumentation": "`IncludeOpForFullLoad`\n\nA value that enables a full load to write INSERT operations to the comma-separated value\n(.csv) output files only to indicate how the rows were added to the source database.\n###### Note\nAWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3.1.4 and\nlater.\nFor full load, records can only be inserted. By default (the `false`\nsetting), no information is recorded in these output files for a full load to indicate that\nthe rows were inserted at the source database. If `IncludeOpForFullLoad` is set\nto `true` or `y`, the INSERT is recorded as an I annotation in the\nfirst field of the .csv file. This allows the format of your target records from a full\nload to be consistent with the target records from a CDC load.\n###### Note\nThis setting works together with the `CdcInsertsOnly` and the\n`CdcInsertsAndUpdates` parameters for output to .csv files only. For more\ninformation about how these settings work together, see\n[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)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-includeopforfullload", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "CdcInsertsAndUpdates": { "Required": false, "MarkdownDocumentation": "`CdcInsertsAndUpdates`\n\nA value that enables a change data capture (CDC) load to write INSERT and UPDATE\noperations to .csv or .parquet (columnar storage) output files. The default setting is\n`false`, but when `CdcInsertsAndUpdates` is set to\n`true` or `y`, only INSERTs and UPDATEs from the source database\nare migrated to the .csv or .parquet file.\nFor .csv file format only, how these INSERTs and UPDATEs are recorded depends on the\nvalue of the `IncludeOpForFullLoad` parameter. If\n`IncludeOpForFullLoad` is set to `true`, the first field of every\nCDC record is set to either `I` or `U` to indicate INSERT and UPDATE\noperations at the source. But if `IncludeOpForFullLoad` is set to\n`false`, CDC records are written without an indication of INSERT or UPDATE\noperations at the source. For more information about how these settings work together, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n###### Note\nAWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in\nversions 3.3.1 and later.\n`CdcInsertsOnly` and `CdcInsertsAndUpdates` can't\nboth be set to `true` for the same endpoint. Set either\n`CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true`\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcinsertsandupdates", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "BucketName": { "Required": false, "MarkdownDocumentation": "`BucketName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ServerSideEncryptionKmsKeyId": { "Required": false, "MarkdownDocumentation": "`ServerSideEncryptionKmsKeyId`\n\nIf you are using `SSE_KMS` for the `EncryptionMode`, provide the\nAWS KMS key ID. The key that you use needs an attached policy that enables\nIAM user permissions and allows use of the key.\nHere is a CLI example: `aws dms create-endpoint --endpoint-identifier\nvalue --endpoint-type target --engine-name s3 --s3-settings\nServiceAccessRoleArn=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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-serversideencryptionkmskeyid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UseTaskStartTimeForFullLoadTimestamp": { "Required": false, "MarkdownDocumentation": "`UseTaskStartTimeForFullLoadTimestamp`\n\nWhen set to true, this parameter uses the task start time as the timestamp column value instead of\nthe time data is written to target. For full load, when `useTaskStartTimeForFullLoadTimestamp`\nis set to `true`, each row of the timestamp column contains the task start time. For CDC loads,\neach row of the timestamp column contains the transaction commit time.\nWhen `useTaskStartTimeForFullLoadTimestamp` is set to `false`, the full load timestamp\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-usetaskstarttimeforfullloadtimestamp", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "GlueCatalogGeneration": { "Required": false, "MarkdownDocumentation": "`GlueCatalogGeneration`\n\nWhen true, allows AWS Glue to catalog your S3 bucket. Creating an AWS Glue catalog lets you\nuse Athena to query your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-gluecataloggeneration", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DataFormat": { "Required": false, "MarkdownDocumentation": "`DataFormat`\n\nThe format of the data that you want to use for output. You can choose one of the\nfollowing:\n* `csv` : This is a row-based file format with comma-separated values\n (.csv).\n* `parquet` : Apache Parquet (.parquet) is a columnar storage file format\n 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)", "RefReturnValue": "", "AllowedValues": [ "csv", "parquet" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-dataformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CsvDelimiter": { "Required": false, "MarkdownDocumentation": "`CsvDelimiter`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvdelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AddTrailingPaddingCharacter": { "Required": false, "MarkdownDocumentation": "`AddTrailingPaddingCharacter`\n\nUse the S3 target endpoint setting `AddTrailingPaddingCharacter` to add\npadding on string data. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-addtrailingpaddingcharacter", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "IgnoreHeaderRows": { "Required": false, "MarkdownDocumentation": "`IgnoreHeaderRows`\n\nWhen this value is set to 1, AWS DMS ignores the first row header in a .csv file. A value\nof 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-ignoreheaderrows", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CannedAclForObjects": { "Required": false, "MarkdownDocumentation": "`CannedAclForObjects`\n\nA value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for\nobjects created in an Amazon S3 bucket as .csv or .parquet files. For more information\nabout Amazon S3 canned ACLs, see\n[Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)\nin the *Amazon S3 Developer Guide*.\nThe default value is NONE. Valid values include NONE, PRIVATE,\nPUBLIC\\_READ, PUBLIC\\_READ\\_WRITE, AUTHENTICATED\\_READ,\nAWS\\_EXEC\\_READ, BUCKET\\_OWNER\\_READ, and\nBUCKET\\_OWNER\\_FULL\\_CONTROL.\n*Required*: No\n*Type*: String\n*Allowed values*: `none | private | public-rea...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "private", "public-read", "public-read-write", "authenticated-read", "aws-exec-read", "bucket-owner-read", "bucket-owner-full-control" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cannedaclforobjects", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Rfc4180": { "Required": false, "MarkdownDocumentation": "`Rfc4180`\n\nFor an S3 source, when this value is set to `true` or `y`,\neach leading double quotation mark has to be followed by an\nending double quotation mark. This formatting complies with RFC\n4180. When this value is set to `false` or\n`n`, string literals are copied to the target as\nis. In this case, a delimiter (row or column) signals the end of\nthe field. Thus, you can't use a delimiter as part of the\nstring, because it signals the end of the value.\nFor an S3 target, an optional parameter used to set behavior to comply with RFC\n4180 for data migrated to Amazon S3 using .csv file format only. When this\nvalue is set to `true` or `y` using Amazon\nS3 as a target, if the data has quotation marks or newline\ncharacters in it, AWS DMS encloses the entire column with an\nadditional pair of double quotation marks (\"). Every quotation\nmark within the data is repeated twice.\nThe default value is `true`. Valid values include `true`, `false`,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-rfc4180", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ServiceAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`ServiceAccessRoleArn`\n\nA required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-serviceaccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ParquetTimestampInMillisecond": { "Required": false, "MarkdownDocumentation": "`ParquetTimestampInMillisecond`\n\nA value that specifies the precision of any `TIMESTAMP` column values that\nare written to an Amazon S3 object file in .parquet format.\n###### Note\nAWS DMS supports the `ParquetTimestampInMillisecond` parameter in versions\n3.1.4 and later.\nWhen `ParquetTimestampInMillisecond` is set to `true` or\n`y`, AWS DMS writes all `TIMESTAMP` columns in a .parquet\nformatted file with millisecond precision. Otherwise, DMS writes them with microsecond\nprecision.\nCurrently, Amazon Athena and AWS Glue can handle only\nmillisecond precision for `TIMESTAMP` values. Set\nthis parameter to `true` for S3 endpoint object\nfiles that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.\n###### Note\nAWS DMS writes any `TIMESTAMP` column\nvalues written to an S3 file in .csv format with\nmicrosecond precision.\nSetting `ParquetTimestampInMillisecond` has no effect on the string\nformat of the timestamp column value that is inserted by setting the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-parquettimestampinmillisecond", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "PreserveTransactions": { "Required": false, "MarkdownDocumentation": "`PreserveTransactions`\n\nIf this setting is set to `true`, AWS DMS saves the transaction order for a change data\ncapture (CDC) load on the Amazon S3 target specified by\n[`CdcPath`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath).\nFor more information, see\n[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).\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-preservetransactions", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "BucketFolder": { "Required": false, "MarkdownDocumentation": "`BucketFolder`\n\nAn optional parameter to set a folder name in the S3 bucket. If provided, tables are\ncreated in the path `bucketFolder/schema_name/table_name/`.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketfolder", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DatePartitionDelimiter": { "Required": false, "MarkdownDocumentation": "`DatePartitionDelimiter`\n\nSpecifies a date separating delimiter to use during folder partitioning. The default value is\n`SLASH`. Use this parameter when `DatePartitionedEnabled` is set to `true`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SLASH | UNDERSCORE | DASH |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SLASH", "UNDERSCORE", "DASH", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datepartitiondelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncodingType": { "Required": false, "MarkdownDocumentation": "`EncodingType`\n\nThe type of encoding that you're using:\n* `RLE_DICTIONARY` uses a combination of bit-packing and run-length\n encoding to store repeated values more efficiently. This is the default.\n* `PLAIN` doesn't use encoding at all. Values are stored as they\n are.\n* `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a\n given column. The dictionary is stored in a dictionary page for each column\n chunk.\n*Required*: No\n*Type*: String\n*Allowed values*: `plain | plain-dictionary | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "plain", "plain-dictionary", "rle-dictionary" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-encodingtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AddColumnName": { "Required": false, "MarkdownDocumentation": "`AddColumnName`\n\nAn optional parameter that, when set to `true` or `y`, you can use\nto add column name information to the .csv output file.\nThe default value is `false`. Valid values are `true`, `false`,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-addcolumnname", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "CdcMinFileSize": { "Required": false, "MarkdownDocumentation": "`CdcMinFileSize`\n\nMinimum file size, defined in kilobytes, to reach for a file output to Amazon S3.\nWhen `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file\nwrite is triggered by whichever parameter condition is met first within an AWS DMS\nCloudFormation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcminfilesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ParquetVersion": { "Required": false, "MarkdownDocumentation": "`ParquetVersion`\n\nThe version of the Apache Parquet format that you want to use: `parquet_1_0`\n(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)", "RefReturnValue": "", "AllowedValues": [ "parquet-1-0", "parquet-2-0" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-parquetversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExternalTableDefinition": { "Required": false, "MarkdownDocumentation": "`ExternalTableDefinition`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-externaltabledefinition", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UseCsvNoSupValue": { "Required": false, "MarkdownDocumentation": "`UseCsvNoSupValue`\n\nThis setting applies if the S3 output files during a change data capture (CDC) load are\nwritten in .csv format. If this setting is set to `true` for columns not included in the\nsupplemental log, AWS DMS uses the value specified by\n[`CsvNoSupValue`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue).\nIf this setting isn't set or is set to `false`, AWS DMS uses the null value for these columns.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-usecsvnosupvalue", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "MaxFileSize": { "Required": false, "MarkdownDocumentation": "`MaxFileSize`\n\nA value that specifies the maximum size (in KB) of any .csv\nfile to be created while migrating to an S3 target during full\nload.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-maxfilesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CdcPath": { "Required": false, "MarkdownDocumentation": "`CdcPath`\n\nSpecifies the folder path of CDC files. For an S3 source, this setting is required if a\ntask captures change data; otherwise, it's optional. If `CdcPath` is set, AWS DMS\nreads CDC files from this path and replicates the data changes to the target endpoint.\nFor an S3 target if you set\n[`PreserveTransactions`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions)\nto `true`, AWS DMS\nverifies that you have set this parameter to a folder path on your S3 target where AWS DMS\ncan save the transaction order for the CDC load. AWS DMS creates this CDC folder path\nin either your S3 target working directory or the S3 target location specified by\n[`BucketFolder`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and\n[`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\nspecify `BucketName` as `MyTargetBucket` but do not specify\n`BucketFolder`, AWS DMS creates the CDC folder path following:\n`MyTargetBucket/MyChangedData`.\nIf you specify the same `CdcPath`, and you specify `BucketName` as\n`MyTargetBucket` and `BucketFolder` as `MyTargetData`,\nAWS DMS creates the CDC folder path following:\n`MyTargetBucket/MyTargetData/MyChangedData`.\nFor more information on CDC including transaction order on an S3 target, see\n[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).\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcpath", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CsvNoSupValue": { "Required": false, "MarkdownDocumentation": "`CsvNoSupValue`\n\nThis setting only applies if your Amazon S3 output files during a change data capture\n(CDC) load are written in .csv format. If\n[`UseCsvNoSupValue`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue)\nis set to true, specify a string value that you want AWS DMS to use for all columns not included\nin the supplemental log. If you do not specify a string value, AWS DMS uses the null value for\nthese columns regardless of the `UseCsvNoSupValue` setting.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvnosupvalue", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CdcMaxBatchInterval": { "Required": false, "MarkdownDocumentation": "`CdcMaxBatchInterval`\n\nMaximum length of the interval, defined in seconds, after which to output a file to Amazon S3.\nWhen `CdcMaxBatchInterval` and `CdcMinFileSize` are both specified, the\nfile write is triggered by whichever parameter condition is met first within an AWS DMS\nCloudFormation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcmaxbatchinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CsvRowDelimiter": { "Required": false, "MarkdownDocumentation": "`CsvRowDelimiter`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvrowdelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RowGroupLength": { "Required": false, "MarkdownDocumentation": "`RowGroupLength`\n\nThe number of rows in a row group. A smaller row group size provides faster reads. But\nas the number of row groups grows, the slower writes become. This parameter defaults to\n10,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\nmax 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-rowgrouplength", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DataPageSize": { "Required": false, "MarkdownDocumentation": "`DataPageSize`\n\nThe size of one data page in bytes. This parameter defaults to 1024 \\* 1024 bytes (1 MiB).\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datapagesize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DatePartitionEnabled": { "Required": false, "MarkdownDocumentation": "`DatePartitionEnabled`\n\nWhen set to `true`, this parameter partitions S3 bucket folders based on\ntransaction commit dates. The default value is `false`. For more information\nabout date-based folder partitioning, see\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datepartitionenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DictPageSizeLimit": { "Required": false, "MarkdownDocumentation": "`DictPageSizeLimit`\n\nThe maximum size of an encoded dictionary page of a column. If the dictionary page\nexceeds this, this column is stored using an encoding type of `PLAIN`. This\nparameter defaults to 1024 \\* 1024 bytes (1 MiB), the maximum size of a dictionary page\nbefore it reverts to `PLAIN` encoding. This size is used for\n.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-dictpagesizelimit", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CompressionType": { "Required": false, "MarkdownDocumentation": "`CompressionType`\n\nAn optional parameter. When set to GZIP it enables the service to compress the target files.\nTo allow the service to write the target files uncompressed, either set this parameter to NONE (the default) or don't specify\nthe parameter at all. This parameter applies to both .csv and .parquet file formats.\n*Required*: No\n*Type*: String\n*Allowed values*: `none | gzip...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "gzip" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-compressiontype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DatePartitionTimezone": { "Required": false, "MarkdownDocumentation": "`DatePartitionTimezone`\n\nWhen creating an S3 target endpoint, set `DatePartitionTimezone` to\nconvert the current UTC time into a specified time zone. The conversion occurs when a\ndate partition folder is created and a change data capture (CDC) file name is generated. The time zone format\nis Area/Location. Use this parameter when `DatePartitionedEnabled` is set to\n`true`, as shown in the following example.\n`s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n\"DatePartitionDelimiter\": \"SLASH\",\n\"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datepartitiontimezone", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CdcInsertsOnly": { "Required": false, "MarkdownDocumentation": "`CdcInsertsOnly`\n\nA value that enables a change data capture (CDC) load to write only INSERT operations to\n.csv or columnar storage (.parquet) output files. By default\n(the `false` setting), the first field in a .csv or .parquet record contains the\nletter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was\ninserted, updated, or deleted at the source database for a CDC load to the target.\nIf `CdcInsertsOnly` is set to `true` or `y`, only\nINSERTs from the source database are migrated to the .csv or .parquet file. For .csv format\nonly, how these INSERTs are recorded depends on the value of\n`IncludeOpForFullLoad`. If `IncludeOpForFullLoad` is set to\n`true`, the first field of every CDC record is set to I to indicate the\nINSERT operation at the source. If `IncludeOpForFullLoad` is set to\n`false`, every CDC record is written without a first field to indicate the\nINSERT operation at the source. For more information about how these settings work\ntogether, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n###### Note\nAWS DMS supports the interaction described preceding between the\n`CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in\nversions 3.1.4 and later.\n`CdcInsertsOnly` and `CdcInsertsAndUpdates` can't\nboth be set to `true` for the same endpoint. Set either\n`CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true`\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcinsertsonly", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ExpectedBucketOwner": { "Required": false, "MarkdownDocumentation": "`ExpectedBucketOwner`\n\nTo specify a bucket owner and prevent sniping, you can use the\n`ExpectedBucketOwner` endpoint setting.\nExample: `--s3-settings='{\"ExpectedBucketOwner\":\n\"AWS_Account_ID\"}'`\nWhen you make a request to test a connection or perform a migration, S3 checks the\naccount ID of the bucket owner against the specified parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-expectedbucketowner", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncryptionMode": { "Required": false, "MarkdownDocumentation": "`EncryptionMode`\n\nThe type of server-side encryption that you want to use for your data. This encryption\ntype is part of the endpoint settings or the extra connections attributes for Amazon S3.\nYou can choose either `SSE_S3` (the default) or `SSE_KMS`.\n###### Note\nFor the `ModifyEndpoint` operation, you can change the existing value of\nthe `EncryptionMode` parameter from `SSE_KMS` to\n`SSE_S3`. But you can\u2019t change the existing value from `SSE_S3`\nto `SSE_KMS`.\nTo use `SSE_S3`, you need an IAM role\nwith permission to allow `\"arn:aws:s3:::dms-*\"` to use the following\nactions:\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-s3 | 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)", "RefReturnValue": "", "AllowedValues": [ "sse-s3", "sse-kms" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-encryptionmode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::Endpoint.SybaseSettings": { "MarkdownDocumentation": "`AWS::DMS::Endpoint.SybaseSettings`\n\nProvides information that defines a SAP ASE endpoint. This\ninformation includes the output format of records applied to the endpoint and details of\ntransaction and control table data information. For information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html", "Properties": { "SecretsManagerSecretId": { "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html#cfn-dms-endpoint-sybasesettings-secretsmanagersecretid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecretsManagerAccessRoleArn": { "Required": false, "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\ntrusted entity and grants the required permissions to access the value in\n`SecretsManagerSecret`. The role must allow the `iam:PassRole` action.\n`SecretsManagerSecret` has the value of the AWS Secrets Manager\nsecret that allows access to the SAP ASE endpoint.\n###### Note\nYou can specify one of two sets of values for these permissions. You can specify the\nvalues for this setting and `SecretsManagerSecretId`. Or you can specify\nclear-text values for `UserName`, `Password`,\n`ServerName`, and `Port`. You can't specify both.\nFor more information on creating this `SecretsManagerSecret`, the corresponding\n`SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId`\nthat is required to access it, see\n[Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html#cfn-dms-endpoint-sybasesettings-secretsmanageraccessrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::DMS::MigrationProject.DataProviderDescriptor": { "MarkdownDocumentation": "`AWS::DMS::MigrationProject.DataProviderDescriptor`\n\nInformation about a data provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html", "Properties": { "DataProviderName": { "MarkdownDocumentation": "`DataProviderName`\n\nThe user-friendly name of the data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-dataprovidername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataProviderArn": { "MarkdownDocumentation": "`DataProviderArn`\n\nThe Amazon Resource Name (ARN) of the data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-dataproviderarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecretsManagerSecretId": { "MarkdownDocumentation": "`SecretsManagerSecretId`\n\nThe identifier of the AWS Secrets Manager Secret used to store access credentials for the data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-secretsmanagersecretid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecretsManagerAccessRoleArn": { "MarkdownDocumentation": "`SecretsManagerAccessRoleArn`\n\nThe ARN of the role used to access AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-secretsmanageraccessrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataProviderIdentifier": { "MarkdownDocumentation": "`DataProviderIdentifier`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-dataprovideridentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::MigrationProject.SchemaConversionApplicationAttributes": { "MarkdownDocumentation": "`AWS::DMS::MigrationProject.SchemaConversionApplicationAttributes`\n\nThe `SchemaConversionApplicationAttributes` property type specifies Property description not available. for an [AWS::DMS::MigrationProject](./aws-resource-dms-migrationproject.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-schemaconversionapplicationattributes.html", "Properties": { "S3BucketPath": { "MarkdownDocumentation": "`S3BucketPath`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-schemaconversionapplicationattributes.html#cfn-dms-migrationproject-schemaconversionapplicationattributes-s3bucketpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3BucketRoleArn": { "MarkdownDocumentation": "`S3BucketRoleArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-schemaconversionapplicationattributes.html#cfn-dms-migrationproject-schemaconversionapplicationattributes-s3bucketrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DMS::ReplicationConfig.ComputeConfig": { "MarkdownDocumentation": "`AWS::DMS::ReplicationConfig.ComputeConfig`\n\nConfiguration parameters for provisioning an AWS DMS Serverless replication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html", "Properties": { "DnsNameServers": { "MarkdownDocumentation": "`DnsNameServers`\n\nA list of custom DNS name servers supported for the AWS DMS Serverless replication to\naccess your source or target database. This list overrides the default name servers\nsupported by the AWS DMS Serverless replication. You can specify a comma-separated list of\ninternet addresses for up to four DNS name servers. For example:\n`\"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-dnsnameservers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nAn AWS Key Management Service (AWS KMS) key Amazon Resource Name (ARN) that is used to encrypt the data\nduring AWS DMS Serverless replication.\nIf you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your\ndefault encryption key.\nAWS KMS creates the default encryption key for your Amazon Web Services account. Your AWS account\nhas a different default encryption key for each AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nSpecifies the virtual private cloud (VPC) security group to use with the AWS DMS\nServerless replication. The VPC security group must work with the VPC containing the\nreplication.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxCapacityUnits": { "MarkdownDocumentation": "`MaxCapacityUnits`\n\nSpecifies the maximum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS\nServerless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the\nminimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128,\n192, 256, and 384. So, the maximum value that you can specify for AWS DMS Serverless is 384.\nThe `MaxCapacityUnits` parameter is the only DCU parameter you are required to\nspecify.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-maxcapacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ReplicationSubnetGroupId": { "MarkdownDocumentation": "`ReplicationSubnetGroupId`\n\nSpecifies a subnet group identifier to associate with the AWS DMS Serverless\nreplication.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-replicationsubnetgroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone where the AWS DMS Serverless replication using this configuration\nwill run. The default value is a random, system-chosen Availability Zone in the\nconfiguration's AWS Region, for example, `\"us-west-2\"`. You can't set this\nparameter if the `MultiAZ` parameter is set 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe weekly time range during which system maintenance can occur for the AWS DMS Serverless\nreplication, in Universal Coordinated Time (UTC). The format is\n`ddd:hh24:mi-ddd:hh24:mi`.\nThe default is a 30-minute window selected at random from an 8-hour block of time per\nAWS Region. This maintenance occurs on a random day of the week. Valid values for days of\nthe week include `Mon`, `Tue`, `Wed`, `Thu`,\n`Fri`, `Sat`, and `Sun`.\nConstraints include a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-preferredmaintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinCapacityUnits": { "MarkdownDocumentation": "`MinCapacityUnits`\n\nSpecifies the minimum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS\nServerless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the\nminimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128,\n192, 256, and 384. So, the minimum DCU value that you can specify for AWS DMS Serverless is\n1. If you don't set this value, AWS DMS sets this parameter to the minimum DCU value allowed,\n1. If there is no current source activity, AWS DMS scales down your replication until it\nreaches the value specified in `MinCapacityUnits`.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-mincapacityunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MultiAZ": { "MarkdownDocumentation": "`MultiAZ`\n\nSpecifies whether the AWS DMS Serverless replication is a Multi-AZ deployment. You can't\nset the `AvailabilityZone` parameter if the `MultiAZ` parameter is\nset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-multiaz", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DSQL::Cluster.EncryptionDetails": { "MarkdownDocumentation": "`AWS::DSQL::Cluster.EncryptionDetails`\n\nConfiguration details about encryption for the cluster including the AWS KMS key ARN, encryption type, and encryption status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-encryptiondetails.html", "Properties": { "EncryptionType": { "MarkdownDocumentation": "`EncryptionType`\n\nThe type of encryption that protects the data on your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-encryptiondetails.html#cfn-dsql-cluster-encryptiondetails-encryptiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionStatus": { "MarkdownDocumentation": "`EncryptionStatus`\n\nThe status of encryption for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-encryptiondetails.html#cfn-dsql-cluster-encryptiondetails-encryptionstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the AWS KMS key that encrypts data in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-encryptiondetails.html#cfn-dsql-cluster-encryptiondetails-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DSQL::Cluster.MultiRegionProperties": { "MarkdownDocumentation": "`AWS::DSQL::Cluster.MultiRegionProperties`\n\nDefines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-multiregionproperties.html", "Properties": { "Clusters": { "MarkdownDocumentation": "`Clusters`\n\nThe set of peered clusters that form the multi-Region cluster configuration. Each\npeered cluster represents a database instance in a different Region.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-multiregionproperties.html#cfn-dsql-cluster-multiregionproperties-clusters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "WitnessRegion": { "MarkdownDocumentation": "`WitnessRegion`\n\nThe Region that serves as the witness Region for a multi-Region cluster. The witness\nRegion helps maintain cluster consistency and quorum.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-multiregionproperties.html#cfn-dsql-cluster-multiregionproperties-witnessregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Dataset.CsvOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.CsvOptions`\n\nRepresents a set of options that define how DataBrew will read a\ncomma-separated value (CSV) file when creating a dataset from that file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-csvoptions.html", "Properties": { "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nA single character that specifies the delimiter being used in the CSV file.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-csvoptions.html#cfn-databrew-dataset-csvoptions-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HeaderRow": { "MarkdownDocumentation": "`HeaderRow`\n\nA variable that specifies whether the first row in the file is parsed as the\nheader. If this value is false, column names are auto-generated.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-csvoptions.html#cfn-databrew-dataset-csvoptions-headerrow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataBrew::Dataset.DataCatalogInputDefinition": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.DataCatalogInputDefinition`\n\nRepresents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew\ndataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of a database table in the Data Catalog. This table corresponds to a DataBrew\ndataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-tablename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TempDirectory": { "MarkdownDocumentation": "`TempDirectory`\n\nAn Amazon location that AWS Glue Data Catalog can use as a temporary\ndirectory.\n*Required*: No\n*Type*: [S3Location](./aws-properties-databrew-dataset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-tempdirectory", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of a database in the Data Catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe unique identifier of the AWS account that holds the Data Catalog that stores the\ndata.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-catalogid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Dataset.DatabaseInputDefinition": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.DatabaseInputDefinition`\n\nConnection information for dataset input files stored in a database.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html", "Properties": { "TempDirectory": { "MarkdownDocumentation": "`TempDirectory`\n\nAn Amazon location that AWS Glue Data Catalog can use as a temporary\ndirectory.\n*Required*: No\n*Type*: [S3Location](./aws-properties-databrew-dataset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-tempdirectory", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nCustom SQL to run against the provided AWS Glue connection. This SQL will be used as\nthe input for DataBrew projects and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-querystring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GlueConnectionName": { "MarkdownDocumentation": "`GlueConnectionName`\n\nThe AWS Glue Connection that stores the connection information for\nthe target database.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-glueconnectionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseTableName": { "MarkdownDocumentation": "`DatabaseTableName`\n\nThe table within the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-databasetablename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Dataset.DatasetParameter": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.DatasetParameter`\n\nRepresents a dataset paramater that defines type and conditions for a parameter in the\nAmazon S3 path of the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the dataset parameter, can be one of a 'String', 'Number' or\n'Datetime'.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `String | Number | Datetime...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "String", "Number", "Datetime" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatetimeOptions": { "MarkdownDocumentation": "`DatetimeOptions`\n\nAdditional parameter options such as a format and a timezone. Required for datetime\nparameters.\n*Required*: No\n*Type*: [DatetimeOptions](./aws-properties-databrew-dataset-datetimeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-datetimeoptions", "UpdateType": "Mutable", "Required": false, "Type": "DatetimeOptions" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe optional filter expression structure to apply additional matching criteria to the\nparameter.\n*Required*: No\n*Type*: [FilterExpression](./aws-properties-databrew-dataset-filterexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-filter", "UpdateType": "Mutable", "Required": false, "Type": "FilterExpression" }, "CreateColumn": { "MarkdownDocumentation": "`CreateColumn`\n\nOptional boolean value that defines whether the captured value of this parameter\nshould be loaded as an additional column in the dataset.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-createcolumn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is used in the dataset's Amazon S3\npath.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Dataset.DatetimeOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.DatetimeOptions`\n\nRepresents additional options for correct interpretation of datetime parameters used\nin the Amazon S3 path of a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html", "Properties": { "LocaleCode": { "MarkdownDocumentation": "`LocaleCode`\n\nOptional value for a non-US locale code, needed for correct interpretation of some\ndate formats.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_\\.#@\\-]+$`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-localecode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Format": { "MarkdownDocumentation": "`Format`\n\nRequired option, that defines the datetime format used for a date parameter in the\nAmazon S3 path. Should use only supported datetime specifiers and\nseparation characters, all litera a-z or A-Z character should be escaped with single\nquotes. E.g. \"MM.dd.yyyy-'at'-HH:mm\".\n*Required*: Yes\n*Type*: String\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-format", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimezoneOffset": { "MarkdownDocumentation": "`TimezoneOffset`\n\nOptional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn't be used if Format for this parameter includes timezone\nfields. If no offset specified, UTC is assumed.\n*Required*: No\n*Type*: String\n*Pattern*: `^(Z|[-+](\\d|\\d{2}|\\d{2}:?\\d{2}))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-timezoneoffset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Dataset.ExcelOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.ExcelOptions`\n\nRepresents a set of options that define how DataBrew will interpret a Microsoft Excel file when\ncreating a dataset from that file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html", "Properties": { "HeaderRow": { "MarkdownDocumentation": "`HeaderRow`\n\nA variable that specifies whether the first row in the file is parsed as the\nheader. If this value is false, column names are auto-generated.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-headerrow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SheetNames": { "MarkdownDocumentation": "`SheetNames`\n\nOne or more named sheets in the Excel file that will be included in the dataset.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SheetIndexes": { "MarkdownDocumentation": "`SheetIndexes`\n\nOne or more sheet numbers in the Excel file that will be included in the\ndataset.\n*Required*: No\n*Type*: Array of Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetindexes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true } } }, "AWS::DataBrew::Dataset.FilesLimit": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.FilesLimit`\n\nRepresents a limit imposed on number of Amazon S3 files that should be\nselected for a dataset from a connected Amazon S3 path.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html", "Properties": { "Order": { "MarkdownDocumentation": "`Order`\n\nA criteria to use for Amazon S3 files sorting before their selection. By\ndefault uses DESCENDING order, i.e. most recent files are selected first.\nAnotherpossible value is ASCENDING.\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)", "RefReturnValue": "", "AllowedValues": [ "ASCENDING", "DESCENDING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-order", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OrderedBy": { "MarkdownDocumentation": "`OrderedBy`\n\nA criteria to use for Amazon S3 files sorting before their selection. By\ndefault uses LAST\\_MODIFIED\\_DATE as a sorting criteria. Currently it's the only allowed\nvalue.\n*Required*: No\n*Type*: String\n*Allowed values*: `LAST_MODIFIED_DATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LAST_MODIFIED_DATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-orderedby", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxFiles": { "MarkdownDocumentation": "`MaxFiles`\n\nThe number of Amazon S3 files to select.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-maxfiles", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::DataBrew::Dataset.FilterExpression": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.FilterExpression`\n\nRepresents a structure for defining parameter conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filterexpression.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression which includes condition names followed by substitution variables,\npossibly grouped and combined with other conditions. For example, \"(starts\\_with :prefix1\nor starts\\_with :prefix2) and (ends\\_with :suffix1 or ends\\_with :suffix2)\". Substitution\nvariables should start with ':' symbol.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[><0-9A-Za-z_.,:)(!= ]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filterexpression.html#cfn-databrew-dataset-filterexpression-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValuesMap": { "MarkdownDocumentation": "`ValuesMap`\n\nThe map of substitution variable names to their values used in this filter\nexpression.\n*Required*: Yes\n*Type*: Array of [FilterValue](./aws-properties-databrew-dataset-filtervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filterexpression.html#cfn-databrew-dataset-filterexpression-valuesmap", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FilterValue", "DuplicatesAllowed": true } } }, "AWS::DataBrew::Dataset.FilterValue": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.FilterValue`\n\nRepresents a single entry in the `ValuesMap` of a\n`FilterExpression`. A `FilterValue` associates the name of a\nsubstitution variable in an expression to its value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to be associated with the substitution variable.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html#cfn-databrew-dataset-filtervalue-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueReference": { "MarkdownDocumentation": "`ValueReference`\n\nThe substitution variable reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^:[A-Za-z0-9_]+$`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html#cfn-databrew-dataset-filtervalue-valuereference", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Dataset.FormatOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.FormatOptions`\n\nRepresents a set of options that define the structure of either comma-separated value (CSV),\nExcel, or JSON input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html", "Properties": { "Excel": { "MarkdownDocumentation": "`Excel`\n\nOptions that define how Excel input is to be interpreted by DataBrew.\n*Required*: No\n*Type*: [ExcelOptions](./aws-properties-databrew-dataset-exceloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-excel", "UpdateType": "Mutable", "Required": false, "Type": "ExcelOptions" }, "Csv": { "MarkdownDocumentation": "`Csv`\n\nOptions that define how CSV input is to be interpreted by DataBrew.\n*Required*: No\n*Type*: [CsvOptions](./aws-properties-databrew-dataset-csvoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-csv", "UpdateType": "Mutable", "Required": false, "Type": "CsvOptions" }, "Json": { "MarkdownDocumentation": "`Json`\n\nOptions that define how JSON input is to be interpreted by DataBrew.\n*Required*: No\n*Type*: [JsonOptions](./aws-properties-databrew-dataset-jsonoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-json", "UpdateType": "Mutable", "Required": false, "Type": "JsonOptions" } } }, "AWS::DataBrew::Dataset.Input": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.Input`\n\nRepresents information on how DataBrew can find data, in either the AWS Glue Data Catalog or\nAmazon S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html", "Properties": { "DatabaseInputDefinition": { "MarkdownDocumentation": "`DatabaseInputDefinition`\n\nConnection information for dataset input files stored in a database.\n*Required*: No\n*Type*: [DatabaseInputDefinition](./aws-properties-databrew-dataset-databaseinputdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-databaseinputdefinition", "UpdateType": "Mutable", "Required": false, "Type": "DatabaseInputDefinition" }, "S3InputDefinition": { "MarkdownDocumentation": "`S3InputDefinition`\n\nThe Amazon S3 location where the data is stored.\n*Required*: No\n*Type*: [S3Location](./aws-properties-databrew-dataset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-s3inputdefinition", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "Metadata": { "MarkdownDocumentation": "`Metadata`\n\nContains additional resource information needed for specific datasets.\n*Required*: No\n*Type*: [Metadata](./aws-properties-databrew-dataset-metadata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-metadata", "UpdateType": "Mutable", "Required": false, "Type": "Metadata" }, "DataCatalogInputDefinition": { "MarkdownDocumentation": "`DataCatalogInputDefinition`\n\nThe AWS Glue Data Catalog parameters for the data.\n*Required*: No\n*Type*: [DataCatalogInputDefinition](./aws-properties-databrew-dataset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-datacataloginputdefinition", "UpdateType": "Mutable", "Required": false, "Type": "DataCatalogInputDefinition" } } }, "AWS::DataBrew::Dataset.JsonOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.JsonOptions`\n\nRepresents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-jsonoptions.html", "Properties": { "MultiLine": { "MarkdownDocumentation": "`MultiLine`\n\nA value that specifies whether JSON input contains embedded new line\ncharacters.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-jsonoptions.html#cfn-databrew-dataset-jsonoptions-multiline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataBrew::Dataset.Metadata": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.Metadata`\n\nContains additional resource information needed for specific datasets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-metadata.html", "Properties": { "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew\nonly supports ARNs from Amazon AppFlow.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-metadata.html#cfn-databrew-dataset-metadata-sourcearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Dataset.PathOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.PathOptions`\n\nRepresents a set of options that define how DataBrew selects files for a\ngiven Amazon S3 path in a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nA structure that maps names of parameters used in the Amazon S3 path of a\ndataset to their definitions.\n*Required*: No\n*Type*: Array of [PathParameter](./aws-properties-databrew-dataset-pathparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PathParameter", "DuplicatesAllowed": true }, "LastModifiedDateCondition": { "MarkdownDocumentation": "`LastModifiedDateCondition`\n\nIf provided, this structure defines a date range for matching Amazon S3\nobjects based on their LastModifiedDate attribute in Amazon S3.\n*Required*: No\n*Type*: [FilterExpression](./aws-properties-databrew-dataset-filterexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-lastmodifieddatecondition", "UpdateType": "Mutable", "Required": false, "Type": "FilterExpression" }, "FilesLimit": { "MarkdownDocumentation": "`FilesLimit`\n\nIf provided, this structure imposes a limit on a number of files that should be\nselected.\n*Required*: No\n*Type*: [FilesLimit](./aws-properties-databrew-dataset-fileslimit.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-fileslimit", "UpdateType": "Mutable", "Required": false, "Type": "FilesLimit" } } }, "AWS::DataBrew::Dataset.PathParameter": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.PathParameter`\n\nRepresents a single entry in the path parameters of a dataset. Each\n`PathParameter` consists of a name and a parameter definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html", "Properties": { "PathParameterName": { "MarkdownDocumentation": "`PathParameterName`\n\nThe name of the path parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html#cfn-databrew-dataset-pathparameter-pathparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatasetParameter": { "MarkdownDocumentation": "`DatasetParameter`\n\nThe path parameter definition.\n*Required*: Yes\n*Type*: [DatasetParameter](./aws-properties-databrew-dataset-datasetparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html#cfn-databrew-dataset-pathparameter-datasetparameter", "UpdateType": "Mutable", "Required": true, "Type": "DatasetParameter" } } }, "AWS::DataBrew::Dataset.S3Location": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset.S3Location`\n\nRepresents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read\ninput data, or write output from a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe Amazon S3 bucket name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketOwner": { "MarkdownDocumentation": "`BucketOwner`\n\nThe AWS account ID of the bucket owner.\n*Required*: No\n*Type*: String\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-bucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe unique name of the object in the bucket.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1280`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.AllowedStatistics": { "MarkdownDocumentation": "`AWS::DataBrew::Job.AllowedStatistics`\n\nConfiguration of statistics that are allowed to be run on columns that\ncontain detected entities. When undefined, no statistics will be computed\non columns that contain detected entities.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-allowedstatistics.html", "Properties": { "Statistics": { "MarkdownDocumentation": "`Statistics`\n\nOne or more column statistics to allow for columns that contain detected entities.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-allowedstatistics.html#cfn-databrew-job-allowedstatistics-statistics", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::DataBrew::Job.ColumnSelector": { "MarkdownDocumentation": "`AWS::DataBrew::Job.ColumnSelector`\n\nSelector of a column from a dataset for profile job configuration.\nOne selector includes either a column name or a regular expression.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html", "Properties": { "Regex": { "MarkdownDocumentation": "`Regex`\n\nA regular expression for selecting a column from a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html#cfn-databrew-job-columnselector-regex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a column from a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html#cfn-databrew-job-columnselector-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.ColumnStatisticsConfiguration": { "MarkdownDocumentation": "`AWS::DataBrew::Job.ColumnStatisticsConfiguration`\n\nConfiguration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select\nevaluations and override parameters of evaluations for particular columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html", "Properties": { "Statistics": { "MarkdownDocumentation": "`Statistics`\n\nConfiguration for evaluations. Statistics can be used to select evaluations and override\nparameters of evaluations.\n*Required*: Yes\n*Type*: [StatisticsConfiguration](./aws-properties-databrew-job-statisticsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html#cfn-databrew-job-columnstatisticsconfiguration-statistics", "UpdateType": "Mutable", "Required": true, "Type": "StatisticsConfiguration" }, "Selectors": { "MarkdownDocumentation": "`Selectors`\n\nList of column selectors. Selectors can be used to select columns from the dataset.\nWhen selectors are undefined, configuration will be applied to all supported columns.\n*Required*: No\n*Type*: Array of [ColumnSelector](./aws-properties-databrew-job-columnselector.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html#cfn-databrew-job-columnstatisticsconfiguration-selectors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSelector", "DuplicatesAllowed": true } } }, "AWS::DataBrew::Job.CsvOutputOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Job.CsvOutputOptions`\n\nRepresents a set of options that define how DataBrew will write a\ncomma-separated value (CSV) file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-csvoutputoptions.html", "Properties": { "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nA single character that specifies the delimiter used to create CSV job output.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-csvoutputoptions.html#cfn-databrew-job-csvoutputoptions-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.DataCatalogOutput": { "MarkdownDocumentation": "`AWS::DataBrew::Job.DataCatalogOutput`\n\nRepresents options that specify how and where in the AWS Glue Data Catalog DataBrew\nwrites the output generated by recipe jobs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of a table in the Data Catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Overwrite": { "MarkdownDocumentation": "`Overwrite`\n\nA value that, if true, means that any data in the location specified for output\nis overwritten with new output. Not supported with DatabaseOptions.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-overwrite", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "S3Options": { "MarkdownDocumentation": "`S3Options`\n\nRepresents options that specify how and where DataBrew writes the Amazon S3\noutput generated by recipe jobs.\n*Required*: No\n*Type*: [S3TableOutputOptions](./aws-properties-databrew-job-s3tableoutputoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-s3options", "UpdateType": "Mutable", "Required": false, "Type": "S3TableOutputOptions" }, "DatabaseOptions": { "MarkdownDocumentation": "`DatabaseOptions`\n\nRepresents options that specify how and where DataBrew writes the database output\ngenerated by recipe jobs.\n*Required*: No\n*Type*: [DatabaseTableOutputOptions](./aws-properties-databrew-job-databasetableoutputoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-databaseoptions", "UpdateType": "Mutable", "Required": false, "Type": "DatabaseTableOutputOptions" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of a database in the Data Catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe unique identifier of the AWS account that holds the Data Catalog that\nstores the data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-catalogid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.DatabaseOutput": { "MarkdownDocumentation": "`AWS::DataBrew::Job.DatabaseOutput`\n\nRepresents a JDBC database output object which defines the output destination for\na DataBrew recipe job to write into.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databaseoutput.html", "Properties": { "DatabaseOutputMode": { "MarkdownDocumentation": "`DatabaseOutputMode`\n\nThe output mode to write into the database. Currently supported option: NEW\\_TABLE.\n*Required*: No\n*Type*: String\n*Allowed values*: `NEW_TABLE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "NEW_TABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databaseoutput.html#cfn-databrew-job-databaseoutput-databaseoutputmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatabaseOptions": { "MarkdownDocumentation": "`DatabaseOptions`\n\nRepresents options that specify how and where DataBrew writes the database output\ngenerated by recipe jobs.\n*Required*: Yes\n*Type*: [DatabaseTableOutputOptions](./aws-properties-databrew-job-databasetableoutputoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databaseoutput.html#cfn-databrew-job-databaseoutput-databaseoptions", "UpdateType": "Mutable", "Required": true, "Type": "DatabaseTableOutputOptions" }, "GlueConnectionName": { "MarkdownDocumentation": "`GlueConnectionName`\n\nThe AWS Glue connection that stores the connection information for the\ntarget database.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databaseoutput.html#cfn-databrew-job-databaseoutput-glueconnectionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.DatabaseTableOutputOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Job.DatabaseTableOutputOptions`\n\nRepresents options that specify how and where DataBrew writes the database\noutput generated by recipe jobs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databasetableoutputoptions.html", "Properties": { "TempDirectory": { "MarkdownDocumentation": "`TempDirectory`\n\nRepresents an Amazon S3 location (bucket name and object key) where DataBrew can store\nintermediate results.\n*Required*: No\n*Type*: [S3Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databasetableoutputoptions.html#cfn-databrew-job-databasetableoutputoptions-tempdirectory", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nA prefix for the name of a table DataBrew will create in the database.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databasetableoutputoptions.html#cfn-databrew-job-databasetableoutputoptions-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.EntityDetectorConfiguration": { "MarkdownDocumentation": "`AWS::DataBrew::Job.EntityDetectorConfiguration`\n\nConfiguration of entity detection for a profile job. When undefined, entity\ndetection is disabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html", "Properties": { "EntityTypes": { "MarkdownDocumentation": "`EntityTypes`\n\nEntity types to detect. Can be any of the following:\n* USA\\_SSN\n* EMAIL\n* USA\\_ITIN\n* USA\\_PASSPORT\\_NUMBER\n* PHONE\\_NUMBER\n* USA\\_DRIVING\\_LICENSE\n* BANK\\_ACCOUNT\n* CREDIT\\_CARD\n* IP\\_ADDRESS\n* MAC\\_ADDRESS\n* USA\\_DEA\\_NUMBER\n* USA\\_HCPCS\\_CODE\n* USA\\_NATIONAL\\_PROVIDER\\_IDENTIFIER\n* USA\\_NATIONAL\\_DRUG\\_CODE\n* USA\\_HEALTH\\_INSURANCE\\_CLAIM\\_NUMBER\n* USA\\_MEDICARE\\_BENEFICIARY\\_IDENTIFIER\n* USA\\_CPT\\_CODE\n* PERSON\\_NAME\n* DATE\nThe Entity type group USA\\_ALL is also supported, and includes all of the\nabove entity types except PERSON\\_NAME and DATE.\n*Required*: Yes\n*Type*: Array of String\n*Maximum*: `128`\n*Minimum*: `1 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html#cfn-databrew-job-entitydetectorconfiguration-entitytypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedStatistics": { "MarkdownDocumentation": "`AllowedStatistics`\n\nConfiguration of statistics that are allowed to be run on columns that\ncontain detected entities. When undefined, no statistics will be computed\non columns that contain detected entities.\n*Required*: No\n*Type*: [AllowedStatistics](./aws-properties-databrew-job-allowedstatistics.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html#cfn-databrew-job-entitydetectorconfiguration-allowedstatistics", "UpdateType": "Mutable", "Required": false, "Type": "AllowedStatistics" } } }, "AWS::DataBrew::Job.JobSample": { "MarkdownDocumentation": "`AWS::DataBrew::Job.JobSample`\n\nA sample configuration for profile jobs only, which determines the number of rows on which the\nprofile job is run. If a `JobSample` value isn't provided, the\ndefault is used. The default value is CUSTOM\\_ROWS for the mode parameter and\n20,000 for the size parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-jobsample.html", "Properties": { "Size": { "MarkdownDocumentation": "`Size`\n\nThe `Size` parameter is only required when the mode is CUSTOM\\_ROWS. The\nprofile job is run on the specified number of rows. The maximum value for size is\nLong.MAX\\_VALUE.\nLong.MAX\\_VALUE = 9223372036854775807\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-jobsample.html#cfn-databrew-job-jobsample-size", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nA value that determines whether the profile job is run on the entire dataset or a\nspecified number of rows. This value must be one of the following:\n* FULL\\_DATASET - The profile job is run on the entire dataset.\n* CUSTOM\\_ROWS - The profile job is run on the number of rows specified in the\n `Size` parameter.\n*Required*: No\n*Type*: String\n*Allowed values*: `FULL_DATASET | CUSTOM_ROWS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FULL_DATASET", "CUSTOM_ROWS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-jobsample.html#cfn-databrew-job-jobsample-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.Output": { "MarkdownDocumentation": "`AWS::DataBrew::Job.Output`\n\nRepresents options that specify how and where in Amazon S3 DataBrew writes the output generated by\nrecipe jobs or profile jobs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html", "Properties": { "Overwrite": { "MarkdownDocumentation": "`Overwrite`\n\nA value that, if true, means that any data in the location specified for output is\noverwritten with new 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-overwrite", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Format": { "MarkdownDocumentation": "`Format`\n\nThe data format of the output of the job.\n*Required*: No\n*Type*: String\n*Allowed values*: `CSV | JSON | PARQUET | GLUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CSV", "JSON", "PARQUET", "GLUEPARQUET", "AVRO", "ORC", "XML", "TABLEAUHYPER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-format", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxOutputFiles": { "MarkdownDocumentation": "`MaxOutputFiles`\n\nThe maximum number of files to be generated by the job and written to the output folder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-maxoutputfiles", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CompressionFormat": { "MarkdownDocumentation": "`CompressionFormat`\n\nThe compression algorithm used to compress the output text of the job.\n*Required*: No\n*Type*: String\n*Allowed values*: `GZIP | LZ4 | SNAPPY | BZIP2...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GZIP", "LZ4", "SNAPPY", "BZIP2", "DEFLATE", "LZO", "BROTLI", "ZSTD", "ZLIB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-compressionformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PartitionColumns": { "MarkdownDocumentation": "`PartitionColumns`\n\nThe names of one or more partition columns for the output of the job.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-partitioncolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "FormatOptions": { "MarkdownDocumentation": "`FormatOptions`\n\nRepresents options that define how DataBrew formats job output files.\n*Required*: No\n*Type*: [OutputFormatOptions](./aws-properties-databrew-job-outputformatoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-formatoptions", "UpdateType": "Mutable", "Required": false, "Type": "OutputFormatOptions" }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe location in Amazon S3 where the job writes its output.\n*Required*: Yes\n*Type*: [S3Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-location", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" } } }, "AWS::DataBrew::Job.OutputFormatOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Job.OutputFormatOptions`\n\nRepresents a set of options that define the structure of comma-separated (CSV) job output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputformatoptions.html", "Properties": { "Csv": { "MarkdownDocumentation": "`Csv`\n\nRepresents a set of options that define the structure of comma-separated value (CSV)\njob output.\n*Required*: No\n*Type*: [CsvOutputOptions](./aws-properties-databrew-job-csvoutputoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputformatoptions.html#cfn-databrew-job-outputformatoptions-csv", "UpdateType": "Mutable", "Required": false, "Type": "CsvOutputOptions" } } }, "AWS::DataBrew::Job.OutputLocation": { "MarkdownDocumentation": "`AWS::DataBrew::Job.OutputLocation`\n\nThe location in Amazon S3 or AWS Glue Data Catalog where the job\nwrites its output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html#cfn-databrew-job-outputlocation-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketOwner": { "MarkdownDocumentation": "`BucketOwner`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html#cfn-databrew-job-outputlocation-bucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html#cfn-databrew-job-outputlocation-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.ProfileConfiguration": { "MarkdownDocumentation": "`AWS::DataBrew::Job.ProfileConfiguration`\n\nConfiguration for profile jobs. Configuration can be used to select columns, do evaluations, and override default\nparameters of evaluations. When configuration is undefined, the profile job will apply default settings to all\nsupported columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html", "Properties": { "ProfileColumns": { "MarkdownDocumentation": "`ProfileColumns`\n\nList of column selectors. ProfileColumns can be used to select columns from the dataset. When\nProfileColumns is undefined, the profile job will profile all supported columns.\n*Required*: No\n*Type*: Array of [ColumnSelector](./aws-properties-databrew-job-columnselector.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-profilecolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSelector", "DuplicatesAllowed": true }, "DatasetStatisticsConfiguration": { "MarkdownDocumentation": "`DatasetStatisticsConfiguration`\n\nConfiguration for inter-column evaluations. Configuration can be used to select evaluations and override\nparameters of evaluations. When configuration is undefined, the profile job will run all supported\ninter-column evaluations.\n*Required*: No\n*Type*: [StatisticsConfiguration](./aws-properties-databrew-job-statisticsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-datasetstatisticsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StatisticsConfiguration" }, "ColumnStatisticsConfigurations": { "MarkdownDocumentation": "`ColumnStatisticsConfigurations`\n\nList of configurations for column evaluations. ColumnStatisticsConfigurations are used to\nselect evaluations and override parameters of evaluations for particular columns. When\nColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns\nand run all supported evaluations.\n*Required*: No\n*Type*: Array of [ColumnStatisticsConfiguration](./aws-properties-databrew-job-columnstatisticsconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-columnstatisticsconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnStatisticsConfiguration", "DuplicatesAllowed": true }, "EntityDetectorConfiguration": { "MarkdownDocumentation": "`EntityDetectorConfiguration`\n\nConfiguration of entity detection for a profile job. When undefined, entity detection is disabled.\n*Required*: No\n*Type*: [EntityDetectorConfiguration](./aws-properties-databrew-job-entitydetectorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-entitydetectorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EntityDetectorConfiguration" } } }, "AWS::DataBrew::Job.Recipe": { "MarkdownDocumentation": "`AWS::DataBrew::Job.Recipe`\n\nRepresents one or more actions to be performed on a DataBrew dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-recipe.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nThe identifier for the version for the recipe.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-recipe.html#cfn-databrew-job-recipe-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe unique name for the recipe.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-recipe.html#cfn-databrew-job-recipe-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.S3Location": { "MarkdownDocumentation": "`AWS::DataBrew::Job.S3Location`\n\nRepresents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read\ninput data, or write output from a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe Amazon S3 bucket name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3location.html#cfn-databrew-job-s3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketOwner": { "MarkdownDocumentation": "`BucketOwner`\n\nThe AWS account ID of the bucket owner.\n*Required*: No\n*Type*: String\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3location.html#cfn-databrew-job-s3location-bucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe unique name of the object in the bucket.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1280`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3location.html#cfn-databrew-job-s3location-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.S3TableOutputOptions": { "MarkdownDocumentation": "`AWS::DataBrew::Job.S3TableOutputOptions`\n\nRepresents options that specify how and where DataBrew writes the Amazon S3 output\ngenerated by recipe jobs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3tableoutputoptions.html", "Properties": { "Location": { "MarkdownDocumentation": "`Location`\n\nRepresents an Amazon S3 location (bucket name and object key) where DataBrew can write output\nfrom a job.\n*Required*: Yes\n*Type*: [S3Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3tableoutputoptions.html#cfn-databrew-job-s3tableoutputoptions-location", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" } } }, "AWS::DataBrew::Job.StatisticOverride": { "MarkdownDocumentation": "`AWS::DataBrew::Job.StatisticOverride`\n\nOverride of a particular evaluation for a profile job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticoverride.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nA map that includes overrides of an evaluation\u2019s parameters.\n*Required*: Yes\n*Type*: Object of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticoverride.html#cfn-databrew-job-statisticoverride-parameters", "UpdateType": "Mutable", "Required": true, "Type": "Map", "PrimitiveItemType": "String" }, "Statistic": { "MarkdownDocumentation": "`Statistic`\n\nThe name of an evaluation\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z\\_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticoverride.html#cfn-databrew-job-statisticoverride-statistic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job.StatisticsConfiguration": { "MarkdownDocumentation": "`AWS::DataBrew::Job.StatisticsConfiguration`\n\nConfiguration of evaluations for a profile job. This configuration can be used to select\nevaluations and override the parameters of selected evaluations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticsconfiguration.html", "Properties": { "IncludedStatistics": { "MarkdownDocumentation": "`IncludedStatistics`\n\nList of included evaluations. When the list is undefined, all supported\nevaluations will be included.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticsconfiguration.html#cfn-databrew-job-statisticsconfiguration-includedstatistics", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nList of overrides for evaluations.\n*Required*: No\n*Type*: Array of [StatisticOverride](./aws-properties-databrew-job-statisticoverride.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticsconfiguration.html#cfn-databrew-job-statisticsconfiguration-overrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StatisticOverride", "DuplicatesAllowed": true } } }, "AWS::DataBrew::Job.ValidationConfiguration": { "MarkdownDocumentation": "`AWS::DataBrew::Job.ValidationConfiguration`\n\nConfiguration for data quality validation. Used to select the Rulesets and Validation Mode\nto be used in the profile job. When ValidationConfiguration is null, the profile\njob will run without data quality validation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-validationconfiguration.html", "Properties": { "RulesetArn": { "MarkdownDocumentation": "`RulesetArn`\n\nThe Amazon Resource Name (ARN) for the ruleset to be validated in the profile job.\nThe TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of\nthe dataset that is associated with the profile job.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-validationconfiguration.html#cfn-databrew-job-validationconfiguration-rulesetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValidationMode": { "MarkdownDocumentation": "`ValidationMode`\n\nMode of data quality validation. Default mode is \u201cCHECK\\_ALL\u201d which verifies all rules\ndefined in the selected ruleset.\n*Required*: No\n*Type*: String\n*Allowed values*: `CHECK_ALL`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "CHECK_ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-validationconfiguration.html#cfn-databrew-job-validationconfiguration-validationmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Project.Sample": { "MarkdownDocumentation": "`AWS::DataBrew::Project.Sample`\n\nRepresents the sample size and sampling type for DataBrew to use for interactive data\nanalysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-project-sample.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe way in which DataBrew obtains rows from a dataset.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIRST_N | LAST_N | RANDOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIRST_N", "LAST_N", "RANDOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-project-sample.html#cfn-databrew-project-sample-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe number of rows in the sample.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-project-sample.html#cfn-databrew-project-sample-size", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DataBrew::Recipe.Action": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe.Action`\n\nRepresents a transformation and associated parameters that are used to apply a change\nto an AWS Glue DataBrew dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-action.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nContextual parameters for the transformation.\n*Required*: No\n*Type*: [RecipeParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-action.html#cfn-databrew-recipe-action-parameters", "UpdateType": "Mutable", "Required": false, "Type": "RecipeParameters" }, "Operation": { "MarkdownDocumentation": "`Operation`\n\nThe name of a valid DataBrew transformation to be performed on the\ndata.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-action.html#cfn-databrew-recipe-action-operation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Recipe.ConditionExpression": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe.ConditionExpression`\n\nRepresents an individual condition that evaluates to true or false.\nConditions are used with recipe actions. The action is only performed for column values where the\ncondition evaluates to true.\nIf a recipe requires more than one condition, then the recipe must specify multiple\n`ConditionExpression` elements. Each condition is applied to the rows in a dataset first, before\nthe recipe action is performed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-conditionexpression.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nA specific condition to apply to a recipe action. For more information, see [Recipe\nstructure](https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html) in the *AWS Glue DataBrew Developer\nGuide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z\\_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-conditionexpression.html#cfn-databrew-recipe-conditionexpression-condition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA value that the condition must evaluate to for the condition to succeed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-conditionexpression.html#cfn-databrew-recipe-conditionexpression-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetColumn": { "MarkdownDocumentation": "`TargetColumn`\n\nA column to apply this condition to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-conditionexpression.html#cfn-databrew-recipe-conditionexpression-targetcolumn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Recipe.DataCatalogInputDefinition": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe.DataCatalogInputDefinition`\n\nRepresents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew\ndataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-datacataloginputdefinition.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of a database table in the Data Catalog. This table corresponds to a DataBrew\ndataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-datacataloginputdefinition.html#cfn-databrew-recipe-datacataloginputdefinition-tablename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TempDirectory": { "MarkdownDocumentation": "`TempDirectory`\n\nRepresents an Amazon location where DataBrew can store intermediate results.\n*Required*: No\n*Type*: [S3Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-datacataloginputdefinition.html#cfn-databrew-recipe-datacataloginputdefinition-tempdirectory", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of a database in the Data Catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-datacataloginputdefinition.html#cfn-databrew-recipe-datacataloginputdefinition-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe unique identifier of the AWS account that holds the Data Catalog that stores the\ndata.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-datacataloginputdefinition.html#cfn-databrew-recipe-datacataloginputdefinition-catalogid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Recipe.Input": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe.Input`\n\nRepresents information on how DataBrew can find data, in either the AWS Glue Data Catalog or\nAmazon S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-input.html", "Properties": { "S3InputDefinition": { "MarkdownDocumentation": "`S3InputDefinition`\n\nThe Amazon S3 location where the data is stored.\n*Required*: No\n*Type*: [S3Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-input.html#cfn-databrew-recipe-input-s3inputdefinition", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "DataCatalogInputDefinition": { "MarkdownDocumentation": "`DataCatalogInputDefinition`\n\nThe AWS Glue Data Catalog parameters for the data.\n*Required*: No\n*Type*: [DataCatalogInputDefinition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-input.html#cfn-databrew-recipe-input-datacataloginputdefinition", "UpdateType": "Mutable", "Required": false, "Type": "DataCatalogInputDefinition" } } }, "AWS::DataBrew::Recipe.RecipeParameters": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe.RecipeParameters`\n\nParameters that are used as inputs for various recipe actions. The parameters are\nspecific to the context in which they're used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html", "Properties": { "IgnoreCase": { "MarkdownDocumentation": "`IgnoreCase`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-ignorecase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PatternOptions": { "MarkdownDocumentation": "`PatternOptions`\n\nFor splitting by multiple delimiters: A JSON-encoded string that lists the patterns in\nthe format. For example:\n`[{\\\"pattern\\\":\\\"1\\\",\\\"includeInSplit\\\":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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-patternoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Count": { "MarkdownDocumentation": "`Count`\n\nThe number of times a string needs to be repeated.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-count", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OrderByColumn": { "MarkdownDocumentation": "`OrderByColumn`\n\nA column to sort the results 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-orderbycolumn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpperBound": { "MarkdownDocumentation": "`UpperBound`\n\nThe upper boundary for a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-upperbound", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JoinKeys": { "MarkdownDocumentation": "`JoinKeys`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-joinkeys", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveLeadingAndTrailingPunctuation": { "MarkdownDocumentation": "`RemoveLeadingAndTrailingPunctuation`\n\nIf `true`, removes the following characters if they occur at the start or\nend of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingpunctuation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StepIndex": { "MarkdownDocumentation": "`StepIndex`\n\nThe index ID of a step.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-stepindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupByAggFunctionOptions": { "MarkdownDocumentation": "`GroupByAggFunctionOptions`\n\nSpecifies options to apply to the `GROUP BY` used in an aggregation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-groupbyaggfunctionoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nThe character index within 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StopWordsMode": { "MarkdownDocumentation": "`StopWordsMode`\n\nIndicates this operation uses stop words as part of word tokenization.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-stopwordsmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceColumn": { "MarkdownDocumentation": "`SourceColumn`\n\nA source column needed for an operation, step, or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sourcecolumn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomCharacters": { "MarkdownDocumentation": "`CustomCharacters`\n\nOne or more characters that can be substituted or removed, depending on the\ncontext.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-customcharacters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimeZone": { "MarkdownDocumentation": "`TimeZone`\n\nThe current timezone that you want to use for dates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-timezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveLeadingAndTrailingQuotes": { "MarkdownDocumentation": "`RemoveLeadingAndTrailingQuotes`\n\nIf `true`, removes single quotes and double quotes from the beginning and\nend of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingquotes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceColumn2": { "MarkdownDocumentation": "`SourceColumn2`\n\nA source column needed for an operation, step, or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sourcecolumn2", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CollapseConsecutiveWhitespace": { "MarkdownDocumentation": "`CollapseConsecutiveWhitespace`\n\nRemove any non-word non-punctuation character.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-collapseconsecutivewhitespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumRowsAfter": { "MarkdownDocumentation": "`NumRowsAfter`\n\nThe number of rows to consider after the current row in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-numrowsafter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveLetters": { "MarkdownDocumentation": "`RemoveLetters`\n\nIf `true`, removes all uppercase and lowercase alphabetic characters (A\nthrough Z; a through z).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeletters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceColumn1": { "MarkdownDocumentation": "`SourceColumn1`\n\nA source column needed for an operation, step, or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sourcecolumn1", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UseNewDataFrame": { "MarkdownDocumentation": "`UseNewDataFrame`\n\nCreate a new container to hold a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-usenewdataframe", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interval": { "MarkdownDocumentation": "`Interval`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-interval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LowerBound": { "MarkdownDocumentation": "`LowerBound`\n\nThe lower boundary for a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-lowerbound", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TokenizerPattern": { "MarkdownDocumentation": "`TokenizerPattern`\n\nA regex expression to use when splitting text into terms, also called words or\ntokens.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-tokenizerpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LeftColumns": { "MarkdownDocumentation": "`LeftColumns`\n\nThe columns on the left side of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-leftcolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CharsToRemove": { "MarkdownDocumentation": "`CharsToRemove`\n\nCharacters to remove from a step that applies one-hot encoding or tokenization.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-charstoremove", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value1": { "MarkdownDocumentation": "`Value1`\n\nA value that's used by this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-value1", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeleteOtherRows": { "MarkdownDocumentation": "`DeleteOtherRows`\n\nDetermines whether unmapped rows in a categorical mapping should be deleted\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-deleteotherrows", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value2": { "MarkdownDocumentation": "`Value2`\n\nA value that's used by this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-value2", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryMap": { "MarkdownDocumentation": "`CategoryMap`\n\nA category map used for one-hot encoding.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-categorymap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartPattern": { "MarkdownDocumentation": "`StartPattern`\n\nThe starting pattern to locate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-startpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartPosition": { "MarkdownDocumentation": "`StartPosition`\n\nThe starting position to locate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-startposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SheetIndexes": { "MarkdownDocumentation": "`SheetIndexes`\n\nOne or more sheet numbers in the Excel file, which will be included in a\ndataset.\n*Required*: No\n*Type*: Array of Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sheetindexes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "TargetIndex": { "MarkdownDocumentation": "`TargetIndex`\n\nThe index number of an object that is targeted by this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-targetindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveSourceColumn": { "MarkdownDocumentation": "`RemoveSourceColumn`\n\nIf `true`, the source column will be removed after un-nesting that column.\n(Used with nested column types, such as Map, Struct, or Array.)\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removesourcecolumn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DateTimeParameters": { "MarkdownDocumentation": "`DateTimeParameters`\n\nA set of parameters associated with a datetime.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-datetimeparameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndValue": { "MarkdownDocumentation": "`EndValue`\n\nThe end value to locate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-endvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveCustomCharacters": { "MarkdownDocumentation": "`RemoveCustomCharacters`\n\nIf `true`, removes all chraracters specified by\n`CustomCharacters`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removecustomcharacters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndPosition": { "MarkdownDocumentation": "`EndPosition`\n\nThe end position to locate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-endposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nThe pattern to locate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-pattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter to use when parsing separated values in a text 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveSpecialCharacters": { "MarkdownDocumentation": "`RemoveSpecialCharacters`\n\nIf `true`, removes all of the following characters: `! \" # $ % & '\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removespecialcharacters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveAllQuotes": { "MarkdownDocumentation": "`RemoveAllQuotes`\n\nIf `true`, removes all single quotes and double 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeallquotes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndPattern": { "MarkdownDocumentation": "`EndPattern`\n\nThe end pattern to locate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-endpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartColumnIndex": { "MarkdownDocumentation": "`StartColumnIndex`\n\nThe index number of the first column used by an operation, step, or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-startcolumnindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ModeType": { "MarkdownDocumentation": "`ModeType`\n\nDetermines the manner in which mode value is calculated, in case there is more than\none mode value. Valid values: `NONE` | `AVERAGE` |\n`MINIMUM` | `MAXIMUM`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-modetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecondaryInputs": { "MarkdownDocumentation": "`SecondaryInputs`\n\nA list of secondary inputs in a UNION transform\n*Required*: No\n*Type*: Array of [SecondaryInput](./aws-properties-databrew-recipe-secondaryinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-secondaryinputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SecondaryInput", "DuplicatesAllowed": true }, "SampleType": { "MarkdownDocumentation": "`SampleType`\n\nThe sampling type to apply to the dataset. Valid values: `FIRST_N` |\n`LAST_N` | `RANDOM`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sampletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nA date format to apply to a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Other": { "MarkdownDocumentation": "`Other`\n\nThe value to assign to unmapped cells, in categorical mapping\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-other", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CaseStatement": { "MarkdownDocumentation": "`CaseStatement`\n\nA case statement associated with a recipe.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-casestatement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FalseString": { "MarkdownDocumentation": "`FalseString`\n\nA value that represents `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-falsestring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveAllPunctuation": { "MarkdownDocumentation": "`RemoveAllPunctuation`\n\nIf `true`, removes all of the following 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeallpunctuation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomStopWords": { "MarkdownDocumentation": "`CustomStopWords`\n\nA list of words to ignore in a step that applies word tokenization.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-customstopwords", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MapType": { "MarkdownDocumentation": "`MapType`\n\nThe type of mappings to apply to construct a new dynamic frame.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-maptype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnRange": { "MarkdownDocumentation": "`ColumnRange`\n\nA range of columns to which a step is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-columnrange", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA list of custom values to use in a step that requires that you provide a value to\nfinish the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Input": { "MarkdownDocumentation": "`Input`\n\nThe input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog.\n*Required*: No\n*Type*: [Input](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-input", "UpdateType": "Mutable", "Required": false, "Type": "Input" }, "StepCount": { "MarkdownDocumentation": "`StepCount`\n\nThe total number of transforms in this recipe.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-stepcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetDateFormat": { "MarkdownDocumentation": "`TargetDateFormat`\n\nThe date format to convert 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-targetdateformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecondInput": { "MarkdownDocumentation": "`SecondInput`\n\nA object value to indicate the second dataset used 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-secondinput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupByColumns": { "MarkdownDocumentation": "`GroupByColumns`\n\nThe columns to use in the `GROUP BY` clause.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-groupbycolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumRowsBefore": { "MarkdownDocumentation": "`NumRowsBefore`\n\nThe number of rows to consider before the current row in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-numrowsbefore", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IsText": { "MarkdownDocumentation": "`IsText`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-istext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetColumn": { "MarkdownDocumentation": "`TargetColumn`\n\nThe column targeted by this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-targetcolumn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveNumbers": { "MarkdownDocumentation": "`RemoveNumbers`\n\nIf `true`, removes all numeric characters (0 through 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removenumbers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe size of the rolling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-period", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumRows": { "MarkdownDocumentation": "`NumRows`\n\nThe number of rows to consider in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-numrows", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RightColumns": { "MarkdownDocumentation": "`RightColumns`\n\nThe columns on the right side of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-rightcolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StemmingMode": { "MarkdownDocumentation": "`StemmingMode`\n\nIndicates this operation uses stems and lemmas (base words) for word tokenization.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-stemmingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Units": { "MarkdownDocumentation": "`Units`\n\nSpecifies a unit of time. For example: `MINUTES`; `SECONDS`;\n`HOURS`; 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-units", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SampleSize": { "MarkdownDocumentation": "`SampleSize`\n\nThe number of rows in the sample.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-samplesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IncludeInSplit": { "MarkdownDocumentation": "`IncludeInSplit`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-includeinsplit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AggregateFunction": { "MarkdownDocumentation": "`AggregateFunction`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-aggregatefunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA static value that can be used in a comparison, a substitution, or in another\ncontext-specific way. A `Value` can be a number, string, or other datatype,\ndepending on the recipe action in which it's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Exponent": { "MarkdownDocumentation": "`Exponent`\n\nThe exponent to apply in an exponential 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-exponent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartValue": { "MarkdownDocumentation": "`StartValue`\n\nThe starting value to locate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-startvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PatternOption2": { "MarkdownDocumentation": "`PatternOption2`\n\nThe ending pattern to split between.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-patternoption2", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveCustomValue": { "MarkdownDocumentation": "`RemoveCustomValue`\n\nIf `true`, removes all chraracters specified by `CustomValue`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removecustomvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PatternOption1": { "MarkdownDocumentation": "`PatternOption1`\n\nThe starting pattern to split between.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-patternoption1", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MultiLine": { "MarkdownDocumentation": "`MultiLine`\n\nSpecifies whether JSON input contains embedded new line 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-multiline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TrueString": { "MarkdownDocumentation": "`TrueString`\n\nA value to use to represent `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-truestring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveLeadingAndTrailingWhitespace": { "MarkdownDocumentation": "`RemoveLeadingAndTrailingWhitespace`\n\nIf `true`, removes all whitespaces from the beginning and end of the\nvalue.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingwhitespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HiddenColumns": { "MarkdownDocumentation": "`HiddenColumns`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-hiddencolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoveAllWhitespace": { "MarkdownDocumentation": "`RemoveAllWhitespace`\n\nIf `true`, removes all whitespaces from 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeallwhitespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ViewFrame": { "MarkdownDocumentation": "`ViewFrame`\n\nThe subset of rows currently available for viewing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-viewframe", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnDataType": { "MarkdownDocumentation": "`ColumnDataType`\n\nThe data type of the column.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-columndatatype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JoinType": { "MarkdownDocumentation": "`JoinType`\n\nThe type of join to use, for example, `INNER JOIN`, `OUTER\nJOIN`, and so 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-jointype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Base": { "MarkdownDocumentation": "`Base`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueColumn": { "MarkdownDocumentation": "`ValueColumn`\n\nThe column that is provided as a value that's used by this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-valuecolumn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatasetsColumns": { "MarkdownDocumentation": "`DatasetsColumns`\n\nA list of the dataset columns included in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-datasetscolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UdfLang": { "MarkdownDocumentation": "`UdfLang`\n\nThe language that's used in the user-defined 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-udflang", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetColumnNames": { "MarkdownDocumentation": "`TargetColumnNames`\n\nThe names to give columns altered by this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-targetcolumnnames", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DateAddValue": { "MarkdownDocumentation": "`DateAddValue`\n\nA value that specifies how many units of time to add or subtract for a date math\noperation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-dateaddvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExpandContractions": { "MarkdownDocumentation": "`ExpandContractions`\n\nA list of word contractions and what they expand to. For eample:\n*can't*; *cannot*; *can\nnot*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-expandcontractions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UnpivotColumn": { "MarkdownDocumentation": "`UnpivotColumn`\n\nCast columns as rows, so that each value is a different row in a single column.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-unpivotcolumn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Strategy": { "MarkdownDocumentation": "`Strategy`\n\nThe resolution strategy to apply in resolving ambiguities.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-strategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SheetNames": { "MarkdownDocumentation": "`SheetNames`\n\nOone or more named sheets in the Excel file, which will be included in a dataset.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sheetnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nThe number of times to perform `split` or `replaceBy` in a\nstring\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OrderByColumns": { "MarkdownDocumentation": "`OrderByColumns`\n\nThe columns to sort the results 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-orderbycolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceColumns": { "MarkdownDocumentation": "`SourceColumns`\n\nA list of source columns needed for an operation, step, or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sourcecolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Recipe.RecipeStep": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe.RecipeStep`\n\nRepresents a single step from a DataBrew recipe to be performed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipestep.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe particular action to be performed in the recipe step.\n*Required*: Yes\n*Type*: [Action](./aws-properties-databrew-recipe-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipestep.html#cfn-databrew-recipe-recipestep-action", "UpdateType": "Mutable", "Required": true, "Type": "Action" }, "ConditionExpressions": { "MarkdownDocumentation": "`ConditionExpressions`\n\nOne or more conditions that must be met for the recipe step to succeed.\n###### Note\nAll of the conditions in the array must be met. In other words, all of the\nconditions must be combined using a logical AND operation.\n*Required*: No\n*Type*: Array of [ConditionExpression](./aws-properties-databrew-recipe-conditionexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipestep.html#cfn-databrew-recipe-recipestep-conditionexpressions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConditionExpression", "DuplicatesAllowed": true } } }, "AWS::DataBrew::Recipe.S3Location": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe.S3Location`\n\nRepresents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read\ninput data, or write output from a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe Amazon S3 bucket name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-s3location.html#cfn-databrew-recipe-s3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe unique name of the object in the bucket.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1280`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-s3location.html#cfn-databrew-recipe-s3location-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Recipe.SecondaryInput": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe.SecondaryInput`\n\nRepresents secondary inputs in a UNION transform.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-secondaryinput.html", "Properties": { "S3InputDefinition": { "MarkdownDocumentation": "`S3InputDefinition`\n\nThe Amazon S3 location where the data is stored.\n*Required*: No\n*Type*: [S3Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-secondaryinput.html#cfn-databrew-recipe-secondaryinput-s3inputdefinition", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "DataCatalogInputDefinition": { "MarkdownDocumentation": "`DataCatalogInputDefinition`\n\nThe AWS Glue Data Catalog parameters for the data.\n*Required*: No\n*Type*: [DataCatalogInputDefinition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-secondaryinput.html#cfn-databrew-recipe-secondaryinput-datacataloginputdefinition", "UpdateType": "Mutable", "Required": false, "Type": "DataCatalogInputDefinition" } } }, "AWS::DataBrew::Ruleset.ColumnSelector": { "MarkdownDocumentation": "`AWS::DataBrew::Ruleset.ColumnSelector`\n\nSelector of a column from a dataset for profile job configuration.\nOne selector includes either a column name or a regular expression.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-columnselector.html", "Properties": { "Regex": { "MarkdownDocumentation": "`Regex`\n\nA regular expression for selecting a column from a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-columnselector.html#cfn-databrew-ruleset-columnselector-regex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a column from a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-columnselector.html#cfn-databrew-ruleset-columnselector-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataBrew::Ruleset.Rule": { "MarkdownDocumentation": "`AWS::DataBrew::Ruleset.Rule`\n\nRepresents a single data quality requirement that should be validated in the\nscope of this dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-rule.html", "Properties": { "ColumnSelectors": { "MarkdownDocumentation": "`ColumnSelectors`\n\nList of column selectors. Selectors can be used to select columns using a name or\nregular expression from the dataset. Rule will be applied to selected columns.\n*Required*: No\n*Type*: Array of [ColumnSelector](./aws-properties-databrew-ruleset-columnselector.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-rule.html#cfn-databrew-ruleset-rule-columnselectors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSelector", "DuplicatesAllowed": true }, "Disabled": { "MarkdownDocumentation": "`Disabled`\n\nA value that specifies whether the rule is disabled. Once a rule is disabled, a\nprofile job will not validate it during a job run. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-rule.html#cfn-databrew-ruleset-rule-disabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SubstitutionMap": { "MarkdownDocumentation": "`SubstitutionMap`\n\nThe map of substitution variable names to their values used in a check expression.\nVariable names should start with a ':' (colon). Variable values can either be actual\nvalues or column names. To differentiate between the two, column names should be\nenclosed in backticks, for example, `\":col1\": \"`Column A`\".`\n*Required*: No\n*Type*: Array of [SubstitutionValue](./aws-properties-databrew-ruleset-substitutionvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-rule.html#cfn-databrew-ruleset-rule-substitutionmap", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SubstitutionValue", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-rule.html#cfn-databrew-ruleset-rule-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CheckExpression": { "MarkdownDocumentation": "`CheckExpression`\n\nThe expression which includes column references, condition names followed by variable\nreferences, possibly grouped and combined with other conditions. For example,\n`(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1\nends_with :suffix1 or :col1 ends_with :suffix2)`. Column and value references\nare substitution variables that should start with the ':' symbol. Depending on the\ncontext, substitution variables' values can be either an actual value or a column name.\nThese values are defined in the SubstitutionMap. If a CheckExpression starts with a\ncolumn reference, then ColumnSelectors in the rule should be null. If ColumnSelectors\nhas been defined, then there should be no columnn reference in the left side of a\ncondition, for example, `is_between :val1 and :val2`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[><0-9A-Za-z_.,:)(!= ]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-rule.html#cfn-databrew-ruleset-rule-checkexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\nThe threshold used with a non-aggregate check expression. Non-aggregate check\nexpressions will be applied to each row in a specific column, and the threshold will be\nused to determine whether the validation succeeds.\n*Required*: No\n*Type*: [Threshold](./aws-properties-databrew-ruleset-threshold.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-rule.html#cfn-databrew-ruleset-rule-threshold", "UpdateType": "Mutable", "Required": false, "Type": "Threshold" } } }, "AWS::DataBrew::Ruleset.SubstitutionValue": { "MarkdownDocumentation": "`AWS::DataBrew::Ruleset.SubstitutionValue`\n\nA key-value pair to associate an expression's substitution variable names with their\nvalues.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-substitutionvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nValue or column name.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-substitutionvalue.html#cfn-databrew-ruleset-substitutionvalue-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueReference": { "MarkdownDocumentation": "`ValueReference`\n\nVariable name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^:[A-Za-z0-9_]+$`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-substitutionvalue.html#cfn-databrew-ruleset-substitutionvalue-valuereference", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Ruleset.Threshold": { "MarkdownDocumentation": "`AWS::DataBrew::Ruleset.Threshold`\n\nThe threshold used with a non-aggregate check expression. The non-aggregate check\nexpression will be applied to each row in a specific column. Then the threshold will be\nused to determine whether the validation succeeds.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-threshold.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of a threshold. Used for comparison of an actual count of rows that satisfy\nthe rule to the threshold value.\n*Required*: No\n*Type*: String\n*Allowed values*: `GREATER_THAN_OR_EQUAL | LES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "GREATER_THAN", "LESS_THAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-threshold.html#cfn-databrew-ruleset-threshold-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a threshold.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-threshold.html#cfn-databrew-ruleset-threshold-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nUnit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size\nused for validation.\n*Required*: No\n*Type*: String\n*Allowed values*: `COUNT | PERCENTAGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "PERCENTAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-ruleset-threshold.html#cfn-databrew-ruleset-threshold-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataPipeline::Pipeline.Field": { "MarkdownDocumentation": "`AWS::DataPipeline::Pipeline.Field`\n\nA key-value pair that describes a property of a `PipelineObject`. The value is specified as either a string value (`StringValue`) or a reference to another object (`RefValue`) but not as both.\nTo view fields for a\ndata pipeline object, see [Pipeline Object Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the\n*AWS Data Pipeline Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html", "Properties": { "Key": { "MarkdownDocumentation": "`Key`\n\nSpecifies the name of a field for a particular object. To view valid values for a\nparticular field, see [Pipeline\nObject 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*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-key", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "RefValue": { "MarkdownDocumentation": "`RefValue`\n\nA field value that you specify as an identifier of another object in the same\npipeline definition.\n###### Note\nYou can specify the field value as either a string value\n(`StringValue`) or a reference to another object\n(`RefValue`), but not both.\nRequired if the key that you are using requires it.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-refvalue", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "StringValue": { "MarkdownDocumentation": "`StringValue`\n\nA field value that you specify as a string. To view valid values for a\nparticular field, see [Pipeline\nObject Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the *AWS Data Pipeline Developer Guide*.\n###### Note\nYou can specify the field value as either a string value\n(`StringValue`) or a reference to another object\n(`RefValue`), but not both.\nRequired if the key that you are using requires it.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-stringvalue", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::DataPipeline::Pipeline.ParameterAttribute": { "MarkdownDocumentation": "`AWS::DataPipeline::Pipeline.ParameterAttribute`\n\n`Attribute` is a property of `ParameterObject` that defines the\nattributes of a parameter object as key-value pairs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html", "Properties": { "Key": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html#cfn-datapipeline-pipeline-parameterobjects-attribtues-key", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "StringValue": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html#cfn-datapipeline-pipeline-parameterobjects-attribtues-stringvalue", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::DataPipeline::Pipeline.ParameterObject": { "MarkdownDocumentation": "`AWS::DataPipeline::Pipeline.ParameterObject`\n\nContains information about a parameter object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html", "Properties": { "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nThe attributes of the parameter object.\n*Required*: Yes\n*Type*: Array of [ParameterAttribute](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html#cfn-datapipeline-pipeline-parameterobjects-attributes", "DuplicatesAllowed": true, "ItemType": "ParameterAttribute", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the parameter object.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html#cfn-datapipeline-pipeline-parameterobjects-id", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::DataPipeline::Pipeline.ParameterValue": { "MarkdownDocumentation": "`AWS::DataPipeline::Pipeline.ParameterValue`\n\nA value or list of parameter values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html", "Properties": { "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the parameter value.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html#cfn-datapipeline-pipeline-parametervalues-id", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "StringValue": { "MarkdownDocumentation": "`StringValue`\n\nThe field value, expressed as a String.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html#cfn-datapipeline-pipeline-parametervalues-stringvalue", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::DataPipeline::Pipeline.PipelineObject": { "MarkdownDocumentation": "`AWS::DataPipeline::Pipeline.PipelineObject`\n\nPipelineObject is property of the AWS::DataPipeline::Pipeline resource that contains\ninformation about a pipeline object. This can be a logical, physical, or physical attempt\npipeline object. The complete set of components of a pipeline defines the pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html", "Properties": { "Fields": { "MarkdownDocumentation": "`Fields`\n\nKey-value pairs that define the properties of the object.\n*Required*: Yes\n*Type*: Array of [Field](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-fields", "DuplicatesAllowed": true, "ItemType": "Field", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the object.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-id", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the object.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::DataPipeline::Pipeline.PipelineTag": { "MarkdownDocumentation": "`AWS::DataPipeline::Pipeline.PipelineTag`\n\nA list of arbitrary tags (key-value pairs) to associate with the pipeline, which you\ncan use to control permissions. For more information, see [Controlling Access to\nPipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the\n*AWS Data Pipeline Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html", "Properties": { "Key": { "MarkdownDocumentation": "`Key`\n\nThe key name of a tag.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html#cfn-datapipeline-pipeline-pipelinetags-key", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html#cfn-datapipeline-pipeline-pipelinetags-value", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::DataSync::LocationAzureBlob.AzureBlobSasConfiguration": { "MarkdownDocumentation": "`AWS::DataSync::LocationAzureBlob.AzureBlobSasConfiguration`\n\nThe shared access signature (SAS) configuration that allows AWS DataSync to\naccess your Microsoft Azure Blob Storage.\nFor more information, see [SAS\ntokens](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens) for accessing your Azure Blob Storage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-azureblobsasconfiguration.html", "Properties": { "AzureBlobSasToken": { "MarkdownDocumentation": "`AzureBlobSasToken`\n\nSpecifies a SAS token that provides permissions to access your Azure Blob\nStorage.\nThe token is part of the SAS URI string that comes after the storage resource URI and\na question mark. A token looks something like this:\n`sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D`\n*Required*: Yes\n*Type*: String\n*Pattern*: `(^.+$)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-azureblobsasconfiguration.html#cfn-datasync-locationazureblob-azureblobsasconfiguration-azureblobsastoken", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationAzureBlob.CmkSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationAzureBlob.CmkSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, such as an\nauthentication token, secret key, password, or Kerberos keytab that DataSync uses\nto access a specific storage location, with a customer-managed AWS KMS key.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-cmksecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for the DataSync-managed AWS Secrets Manager secret that\nthat is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for `KmsKeyArn`.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-cmksecretconfig.html#cfn-datasync-locationazureblob-cmksecretconfig-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nSpecifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for\n`SecretArn`. DataSync provides this key to AWS Secrets Manager.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-cmksecretconfig.html#cfn-datasync-locationazureblob-cmksecretconfig-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationAzureBlob.CustomSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationAzureBlob.CustomSecretConfig`\n\nSpecifies configuration information for a customer-managed Secrets Manager secret where\na storage location credentials is stored in Secrets Manager as plain text (for authentication\ntoken, secret key, or password) or as binary (for Kerberos keytab). This configuration includes\nthe secret ARN, and the ARN for an IAM role that provides access to the secret.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-customsecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for an AWS Secrets Manager secret.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-customsecretconfig.html#cfn-datasync-locationazureblob-customsecretconfig-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretAccessRoleArn": { "MarkdownDocumentation": "`SecretAccessRoleArn`\n\nSpecifies the ARN for the AWS Identity and Access Management role that DataSync uses to\naccess the secret specified for `SecretArn`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-customsecretconfig.html#cfn-datasync-locationazureblob-customsecretconfig-secretaccessrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationAzureBlob.ManagedSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationAzureBlob.ManagedSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, such as an\nauthentication token or set of credentials that DataSync uses to access a specific\ntransfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-managedsecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for an AWS Secrets Manager secret.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-managedsecretconfig.html#cfn-datasync-locationazureblob-managedsecretconfig-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationEFS.Ec2Config": { "MarkdownDocumentation": "`AWS::DataSync::LocationEFS.Ec2Config`\n\nThe subnet and security groups that AWS DataSync uses to connect to one of your\nAmazon EFS file system's [mount targets](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html", "Properties": { "SubnetArn": { "MarkdownDocumentation": "`SubnetArn`\n\nSpecifies the ARN of a subnet where DataSync creates the [network interfaces](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces.html) 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\n file system.\n###### Note\nYou don't need to specify a subnet that includes a file system mount\ntarget.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html#cfn-datasync-locationefs-ec2config-subnetarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupArns": { "MarkdownDocumentation": "`SecurityGroupArns`\n\nSpecifies the Amazon Resource Names (ARNs) of the security groups associated with an\nAmazon EFS file system's mount target.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html#cfn-datasync-locationefs-ec2config-securitygrouparns", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::DataSync::LocationFSxONTAP.NFS": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxONTAP.NFS`\n\nSpecifies the Network File System (NFS) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for\nNetApp ONTAP file system. For more information, see [Accessing FSx for ONTAP file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfs.html", "Properties": { "MountOptions": { "MarkdownDocumentation": "`MountOptions`\n\nSpecifies how DataSync can access a location using the NFS protocol.\n*Required*: Yes\n*Type*: [NfsMountOptions](./aws-properties-datasync-locationfsxontap-nfsmountoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfs.html#cfn-datasync-locationfsxontap-nfs-mountoptions", "UpdateType": "Mutable", "Required": true, "Type": "NfsMountOptions" } } }, "AWS::DataSync::LocationFSxONTAP.NfsMountOptions": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxONTAP.NfsMountOptions`\n\nSpecifies how DataSync can access a location using the NFS protocol.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfsmountoptions.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nSpecifies the NFS version that you want DataSync to use when mounting your NFS\nshare. 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\n the server.\n* `NFSv4_0`: Stateful, firewall-friendly protocol version that supports\n delegations and pseudo file systems.\n* `NFSv4_1`: Stateful protocol version that supports sessions, directory\n delegations, and parallel data processing. NFS version 4.1 also includes all features\n available in version 4.0.\n###### Note\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 |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "NFS3", "NFS4_0", "NFS4_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfsmountoptions.html#cfn-datasync-locationfsxontap-nfsmountoptions-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationFSxONTAP.Protocol": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxONTAP.Protocol`\n\nSpecifies the data transfer protocol that AWS DataSync uses to access your\nAmazon FSx file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html", "Properties": { "SMB": { "MarkdownDocumentation": "`SMB`\n\nSpecifies the Server Message Block (SMB) protocol configuration that DataSync uses to\naccess your FSx for ONTAP file system's SVM.\n*Required*: No\n*Type*: [SMB](./aws-properties-datasync-locationfsxontap-smb.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html#cfn-datasync-locationfsxontap-protocol-smb", "UpdateType": "Mutable", "Required": false, "Type": "SMB" }, "NFS": { "MarkdownDocumentation": "`NFS`\n\nSpecifies the Network File System (NFS) protocol configuration that DataSync uses to\naccess your FSx for ONTAP file system's storage virtual machine (SVM).\n*Required*: No\n*Type*: [NFS](./aws-properties-datasync-locationfsxontap-nfs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html#cfn-datasync-locationfsxontap-protocol-nfs", "UpdateType": "Mutable", "Required": false, "Type": "NFS" } } }, "AWS::DataSync::LocationFSxONTAP.SMB": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxONTAP.SMB`\n\nSpecifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for\nNetApp ONTAP file system. For more information, see [Accessing FSx for ONTAP file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html", "Properties": { "User": { "MarkdownDocumentation": "`User`\n\nSpecifies a user name that can mount the location and access the files, folders, and\nmetadata 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\n the AWS Delegated FSx Administrators group.\n* If you're using a self-managed Active Directory, the user must be a member of\n either the Domain Admins group or a custom group that you specified for file\n 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.\n With this privilege, you also can copy NTFS discretionary access lists\n (DACLs).\n* `SE_SECURITY_NAME`: May be needed to copy NTFS system access\n control lists (SACLs). This operation specifically requires the Windows\n privilege, which is granted to members of the Domain Admins group. If you\n configure your task to copy SACLs, make sure that the user has the required\n 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*Pattern*: `^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$`\n*Maximum*: `104`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-user", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nSpecifies the name of the Windows domain that your storage virtual machine (SVM) belongs\nto.\nIf you have multiple domains in your environment, configuring this setting makes sure that\nDataSync connects to the right SVM.\nIf you have multiple Active Directory domains in your environment, configuring this\nparameter makes sure that DataSync connects to the right SVM.\n*Required*: No\n*Type*: String\n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-domain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MountOptions": { "MarkdownDocumentation": "`MountOptions`\n\nSpecifies how DataSync can access a location using the SMB protocol.\n*Required*: Yes\n*Type*: [SmbMountOptions](./aws-properties-datasync-locationfsxontap-smbmountoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-mountoptions", "UpdateType": "Mutable", "Required": true, "Type": "SmbMountOptions" }, "Password": { "MarkdownDocumentation": "`Password`\n\nSpecifies the password of a user who has permission to access your SVM.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.{0,104}$`\n*Maximum*: `104`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationFSxONTAP.SmbMountOptions": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxONTAP.SmbMountOptions`\n\nSpecifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smbmountoptions.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nBy default, DataSync automatically chooses an SMB protocol version based on\nnegotiation with your SMB file server. You also can configure DataSync to use a\nspecific SMB version, but we recommend doing this only if DataSync has trouble\nnegotiating 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\n the highest version of SMB that they mutually support between 2.1 and 3.1.1.\n \n This is the recommended option. If you instead choose a specific version that your\n file server doesn't support, you may get an `Operation Not Supported`\n error.\n* `SMB3`: Restricts the protocol negotiation to only SMB version\n 3.0.2.\n* `SMB2`: Restricts the protocol negotiation to only SMB version 2.1.\n* `SMB2_0`: Restricts the protocol negotiation to only SMB version\n 2.0.\n* `SMB1`: Restricts the protocol negotiation to only SMB version 1.0.\n \n ###### Note\n \n The `SMB1` option isn't available when [creating an Amazon FSx for NetApp ONTAP location](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html).\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)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "SMB2", "SMB3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smbmountoptions.html#cfn-datasync-locationfsxontap-smbmountoptions-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationFSxOpenZFS.MountOptions": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxOpenZFS.MountOptions`\n\nRepresents the mount options that are available for DataSync to access a\nNetwork File System (NFS) location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-mountoptions.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nThe specific NFS version that you want DataSync to use to mount your NFS\nshare. If the server refuses to use the version specified, the sync will fail. If you\ndon't specify a version, DataSync defaults to `AUTOMATIC`. That is,\nDataSync automatically selects a version based on negotiation with the NFS\nserver.\nYou can specify the following NFS versions:\n* **[NFSv3](https://tools.ietf.org/html/rfc1813)**: Stateless protocol version that allows for asynchronous writes on\n the server.\n* **[NFSv4.0](https://tools.ietf.org/html/rfc3530)**: Stateful, firewall-friendly protocol version that supports\n delegations and pseudo file systems.\n* **[NFSv4.1](https://tools.ietf.org/html/rfc5661)**: Stateful protocol version that supports sessions, directory\n delegations, and parallel data processing. Version 4.1 also includes all\n features available in version 4.0.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "NFS3", "NFS4_0", "NFS4_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-mountoptions.html#cfn-datasync-locationfsxopenzfs-mountoptions-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationFSxOpenZFS.NFS": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxOpenZFS.NFS`\n\nRepresents the Network File System (NFS) protocol that AWS DataSync uses to\naccess your Amazon FSx for OpenZFS file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-nfs.html", "Properties": { "MountOptions": { "MarkdownDocumentation": "`MountOptions`\n\nRepresents the mount options that are available for DataSync to access an\nNFS location.\n*Required*: Yes\n*Type*: [MountOptions](./aws-properties-datasync-locationfsxopenzfs-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-nfs.html#cfn-datasync-locationfsxopenzfs-nfs-mountoptions", "UpdateType": "Mutable", "Required": true, "Type": "MountOptions" } } }, "AWS::DataSync::LocationFSxOpenZFS.Protocol": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxOpenZFS.Protocol`\n\nRepresents the protocol that AWS DataSync uses to access your Amazon FSx for\nOpenZFS file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-protocol.html", "Properties": { "NFS": { "MarkdownDocumentation": "`NFS`\n\nRepresents the Network File System (NFS) protocol that DataSync uses to\naccess your FSx for OpenZFS file system.\n*Required*: No\n*Type*: [NFS](./aws-properties-datasync-locationfsxopenzfs-nfs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-protocol.html#cfn-datasync-locationfsxopenzfs-protocol-nfs", "UpdateType": "Mutable", "Required": false, "Type": "NFS" } } }, "AWS::DataSync::LocationHDFS.NameNode": { "MarkdownDocumentation": "`AWS::DataSync::LocationHDFS.NameNode`\n\nThe NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the\nfile system's namespace and performs operations such as opening, closing, and renaming\nfiles and directories. The NameNode also contains the information to map blocks of data\nto the DataNodes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationhdfs-namenode.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nThe port that the NameNode uses to listen to client requests.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationhdfs-namenode.html#cfn-datasync-locationhdfs-namenode-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Hostname": { "MarkdownDocumentation": "`Hostname`\n\nThe hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain\nName Service (DNS) name of the NameNode. An agent that's installed on-premises uses this\nhostname to communicate with the NameNode in the network.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationhdfs-namenode.html#cfn-datasync-locationhdfs-namenode-hostname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationHDFS.QopConfiguration": { "MarkdownDocumentation": "`AWS::DataSync::LocationHDFS.QopConfiguration`\n\nThe Quality of Protection (QOP) configuration specifies the Remote Procedure Call\n(RPC) and data transfer privacy settings configured on the Hadoop Distributed File\nSystem (HDFS) cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationhdfs-qopconfiguration.html", "Properties": { "RpcProtection": { "MarkdownDocumentation": "`RpcProtection`\n\nThe Remote Procedure Call (RPC) protection setting configured on the HDFS cluster.\nThis setting corresponds to your `hadoop.rpc.protection` setting in your\n`core-site.xml` file on your Hadoop cluster.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTHENTICATION | INTEGRITY ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTHENTICATION", "INTEGRITY", "PRIVACY", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationhdfs-qopconfiguration.html#cfn-datasync-locationhdfs-qopconfiguration-rpcprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataTransferProtection": { "MarkdownDocumentation": "`DataTransferProtection`\n\nThe data transfer protection setting configured on the HDFS cluster. This setting\ncorresponds to your `dfs.data.transfer.protection` setting in the\n`hdfs-site.xml` file on your Hadoop cluster.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTHENTICATION | INTEGRITY ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTHENTICATION", "INTEGRITY", "PRIVACY", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationhdfs-qopconfiguration.html#cfn-datasync-locationhdfs-qopconfiguration-datatransferprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationNFS.MountOptions": { "MarkdownDocumentation": "`AWS::DataSync::LocationNFS.MountOptions`\n\nSpecifies the options that DataSync can use to mount your NFS file\nserver.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationnfs-mountoptions.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nSpecifies the NFS version that you want DataSync to use when mounting your NFS\nshare. 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\n the server.\n* `NFSv4_0`: Stateful, firewall-friendly protocol version that supports\n delegations and pseudo file systems.\n* `NFSv4_1`: Stateful protocol version that supports sessions, directory\n delegations, and parallel data processing. NFS version 4.1 also includes all features\n available in version 4.0.\n###### Note\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 |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "NFS3", "NFS4_0", "NFS4_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationnfs-mountoptions.html#cfn-datasync-locationnfs-mountoptions-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationNFS.OnPremConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationNFS.OnPremConfig`\n\nThe AWS DataSync agents that can connect to your Network File System (NFS)\nfile server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationnfs-onpremconfig.html", "Properties": { "AgentArns": { "MarkdownDocumentation": "`AgentArns`\n\nThe Amazon Resource Names (ARNs) of the DataSync agents that can connect to\nyour NFS file server.\nYou can specify more than one agent. For more information, see [Using multiple DataSync agents](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents).\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 8`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationnfs-onpremconfig.html#cfn-datasync-locationnfs-onpremconfig-agentarns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::DataSync::LocationObjectStorage.CmkSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationObjectStorage.CmkSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, such as an\nauthentication token, secret key, password, or Kerberos keytab that DataSync uses\nto access a specific storage location, with a customer-managed AWS KMS key.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for the DataSync-managed AWS Secrets Manager secret that\nthat is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for `KmsKeyArn`.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.html#cfn-datasync-locationobjectstorage-cmksecretconfig-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nSpecifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for\n`SecretArn`. DataSync provides this key to AWS Secrets Manager.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.html#cfn-datasync-locationobjectstorage-cmksecretconfig-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationObjectStorage.CustomSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationObjectStorage.CustomSecretConfig`\n\nSpecifies configuration information for a customer-managed Secrets Manager secret where\na storage location credentials is stored in Secrets Manager as plain text (for authentication\ntoken, secret key, or password) or as binary (for Kerberos keytab). This configuration includes\nthe secret ARN, and the ARN for an IAM role that provides access to the secret.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for an AWS Secrets Manager secret.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.html#cfn-datasync-locationobjectstorage-customsecretconfig-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretAccessRoleArn": { "MarkdownDocumentation": "`SecretAccessRoleArn`\n\nSpecifies the ARN for the AWS Identity and Access Management role that DataSync uses to\naccess the secret specified for `SecretArn`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.html#cfn-datasync-locationobjectstorage-customsecretconfig-secretaccessrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationObjectStorage.ManagedSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationObjectStorage.ManagedSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, such as an\nauthentication token or set of credentials that DataSync uses to access a specific\ntransfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-managedsecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for an AWS Secrets Manager secret.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-managedsecretconfig.html#cfn-datasync-locationobjectstorage-managedsecretconfig-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationS3.S3Config": { "MarkdownDocumentation": "`AWS::DataSync::LocationS3.S3Config`\n\nSpecifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.\nFor more information, see [Providing\nDataSync access to S3 buckets](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locations3-s3config.html", "Properties": { "BucketAccessRoleArn": { "MarkdownDocumentation": "`BucketAccessRoleArn`\n\nSpecifies the ARN of the IAM role that DataSync uses to access\nyour S3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locations3-s3config.html#cfn-datasync-locations3-s3config-bucketaccessrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationSMB.CmkSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationSMB.CmkSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, such as an\nauthentication token, secret key, password, or Kerberos keytab that DataSync uses\nto access a specific storage location, with a customer-managed AWS KMS key.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-cmksecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for the DataSync-managed AWS Secrets Manager secret that\nthat is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for `KmsKeyArn`.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-cmksecretconfig.html#cfn-datasync-locationsmb-cmksecretconfig-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nSpecifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for\n`SecretArn`. DataSync provides this key to AWS Secrets Manager.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-cmksecretconfig.html#cfn-datasync-locationsmb-cmksecretconfig-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationSMB.CustomSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationSMB.CustomSecretConfig`\n\nSpecifies configuration information for a customer-managed Secrets Manager secret where\na storage location credentials is stored in Secrets Manager as plain text (for authentication\ntoken, secret key, or password) or as binary (for Kerberos keytab). This configuration includes\nthe secret ARN, and the ARN for an IAM role that provides access to the secret.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-customsecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for an AWS Secrets Manager secret.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-customsecretconfig.html#cfn-datasync-locationsmb-customsecretconfig-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretAccessRoleArn": { "MarkdownDocumentation": "`SecretAccessRoleArn`\n\nSpecifies the ARN for the AWS Identity and Access Management role that DataSync uses to\naccess the secret specified for `SecretArn`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-customsecretconfig.html#cfn-datasync-locationsmb-customsecretconfig-secretaccessrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationSMB.ManagedSecretConfig": { "MarkdownDocumentation": "`AWS::DataSync::LocationSMB.ManagedSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, such as an\nauthentication token or set of credentials that DataSync uses to access a specific\ntransfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-managedsecretconfig.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nSpecifies the ARN for an AWS Secrets Manager secret.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-managedsecretconfig.html#cfn-datasync-locationsmb-managedsecretconfig-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::LocationSMB.MountOptions": { "MarkdownDocumentation": "`AWS::DataSync::LocationSMB.MountOptions`\n\nSpecifies the version of the SMB protocol that DataSync uses to access your SMB\nfile server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nBy default, DataSync automatically chooses an SMB protocol version based on\nnegotiation with your SMB file server. You also can configure DataSync to use a\nspecific SMB version, but we recommend doing this only if DataSync has trouble\nnegotiating 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\n the highest version of SMB that they mutually support between 2.1 and 3.1.1.\n \n This is the recommended option. If you instead choose a specific version that your\n file server doesn't support, you may get an `Operation Not Supported`\n error.\n* `SMB3`: Restricts the protocol negotiation to only SMB version\n 3.0.2.\n* `SMB2`: Restricts the protocol negotiation to only SMB version 2.1.\n* `SMB2_0`: Restricts the protocol negotiation to only SMB version\n 2.0.\n* `SMB1`: Restricts the protocol negotiation to only SMB version 1.0.\n \n ###### Note\n \n The `SMB1` option isn't available when [creating an Amazon FSx for NetApp ONTAP location](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTOMATIC | SMB1 | SMB2_0 |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "SMB1", "SMB2_0", "SMB2", "SMB3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html#cfn-datasync-locationsmb-mountoptions-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.Deleted": { "MarkdownDocumentation": "`AWS::DataSync::Task.Deleted`\n\nThe `Deleted` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-deleted.html", "Properties": { "ReportLevel": { "MarkdownDocumentation": "`ReportLevel`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ERRORS_ONLY | SUCCESSES_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ERRORS_ONLY", "SUCCESSES_AND_ERRORS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-deleted.html#cfn-datasync-task-deleted-reportlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.Destination": { "MarkdownDocumentation": "`AWS::DataSync::Task.Destination`\n\nThe `Destination` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-destination.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nProperty description not available.\n*Required*: No\n*Type*: [TaskReportConfigDestinationS3](./aws-properties-datasync-task-taskreportconfigdestinations3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-destination.html#cfn-datasync-task-destination-s3", "UpdateType": "Mutable", "Required": false, "Type": "TaskReportConfigDestinationS3" } } }, "AWS::DataSync::Task.FilterRule": { "MarkdownDocumentation": "`AWS::DataSync::Task.FilterRule`\n\nSpecifies which files, folders, and objects to include or exclude when transferring files\nfrom source to destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html", "Properties": { "FilterType": { "MarkdownDocumentation": "`FilterType`\n\nThe type of filter rule to apply. AWS DataSync only supports the SIMPLE\\_PATTERN\nrule type.\n*Required*: No\n*Type*: String\n*Allowed values*: `SIMPLE_PATTERN...`\n*Pattern*: `^[A-Z0-9_]+$`\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)", "RefReturnValue": "", "AllowedValues": [ "SIMPLE_PATTERN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html#cfn-datasync-task-filterrule-filtertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA single filter string that consists of the patterns to include or exclude. The patterns\nare delimited by \"|\" (that is, a pipe), for example: `/folder1|/folder2`\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\x00]+$`\n*Maximum*: `409600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html#cfn-datasync-task-filterrule-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.ManifestConfig": { "MarkdownDocumentation": "`AWS::DataSync::Task.ManifestConfig`\n\nConfigures a manifest, which is a list of files or objects that you want AWS DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfig.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nSpecifies what DataSync uses the manifest for.\n*Required*: No\n*Type*: String\n*Allowed values*: `TRANSFER`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "TRANSFER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfig.html#cfn-datasync-task-manifestconfig-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Format": { "MarkdownDocumentation": "`Format`\n\nSpecifies the file format of your manifest. For more information, see [Creating a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create).\n*Required*: No\n*Type*: String\n*Allowed values*: `CSV`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "CSV" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfig.html#cfn-datasync-task-manifestconfig-format", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nSpecifies the manifest that you want DataSync to use and where it's\nhosted.\n###### Note\nYou must specify this parameter if you're configuring a new manifest on or after\nFebruary 7, 2024.\nIf you don't, you'll get a 400 status code and `ValidationException` error\nstating that you're missing the IAM role for DataSync to access the\nS3 bucket where you're hosting your manifest. For more information, see [Providing DataSync access to your manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access).\n*Required*: Yes\n*Type*: [Source](./aws-properties-datasync-task-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfig.html#cfn-datasync-task-manifestconfig-source", "UpdateType": "Mutable", "Required": true, "Type": "Source" } } }, "AWS::DataSync::Task.ManifestConfigSourceS3": { "MarkdownDocumentation": "`AWS::DataSync::Task.ManifestConfigSourceS3`\n\nThe `ManifestConfigSourceS3` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html", "Properties": { "S3BucketArn": { "MarkdownDocumentation": "`S3BucketArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$`\n*Maximum*: `156`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-s3bucketarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketAccessRoleArn": { "MarkdownDocumentation": "`BucketAccessRoleArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-bucketaccessrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestObjectVersionId": { "MarkdownDocumentation": "`ManifestObjectVersionId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-manifestobjectversionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestObjectPath": { "MarkdownDocumentation": "`ManifestObjectPath`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-manifestobjectpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.Options": { "MarkdownDocumentation": "`AWS::DataSync::Task.Options`\n\nRepresents the options that are available to control the behavior of a [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) operation. This behavior includes preserving metadata,\nsuch as user ID (UID), group ID (GID), and file permissions; overwriting files in the\ndestination; data integrity verification; and so on.\nA task has a set of default options associated with it. If you don't specify an\noption in [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html), the default value is used. You can override the default\noptions on each task execution by specifying an overriding `Options` value to\n[StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html", "Properties": { "VerifyMode": { "MarkdownDocumentation": "`VerifyMode`\n\nA value that determines whether a data integrity verification is performed at the\nend of a task execution after all data and metadata have been transferred. For more\ninformation, 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\nfiles that were transferred.\n`POINT_IN_TIME_CONSISTENT`: Scan the entire source and entire\ndestination at the end of the transfer to verify that the source and destination are\nfully synchronized. This option isn't supported when transferring to S3 Glacier or S3\nGlacier Deep Archive storage classes.\n`NONE`: No additional verification is done at the end of the transfer,\nbut all data transmissions are integrity-checked with checksum verification during the\ntransfer.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "POINT_IN_TIME_CONSISTENT", "ONLY_FILES_TRANSFERRED", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-verifymode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Gid": { "MarkdownDocumentation": "`Gid`\n\nThe group ID (GID) of the file's owners.\nDefault value:\n`INT_VALUE`\n`INT_VALUE`: Preserve the integer value of the user ID (UID) and group ID\n(GID) (recommended).\n`NAME`: Currently not supported.\n`NONE`: Ignore the UID and GID.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | INT_VALUE | NAME | B...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "INT_VALUE", "NAME", "BOTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-gid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Atime": { "MarkdownDocumentation": "`Atime`\n\nA file metadata value that shows the last time that a file was accessed (that is,\nwhen the file was read or written to). If you set `Atime` to\n`BEST_EFFORT`, AWS DataSync attempts to preserve the original\n`Atime` attribute on all source files (that is, the version before the\nPREPARING phase). However, `Atime`'s behavior is not fully standard across\nplatforms, 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\n(recommended).\n`NONE`: Ignore `Atime`.\n###### Note\nIf `Atime` is set to `BEST_EFFORT`, `Mtime` must\nbe set to `PRESERVE`.\nIf `Atime` is set to `NONE`, `Mtime` must also be\n`NONE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | BEST_EFFORT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "BEST_EFFORT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-atime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OverwriteMode": { "MarkdownDocumentation": "`OverwriteMode`\n\nSpecifies whether DataSync should modify or preserve data at the destination\nlocation.\n* `ALWAYS` (default) - DataSync modifies data in the destination\n location when source data (including metadata) has changed.\n \n If DataSync overwrites objects, you might incur additional charges for\n certain Amazon S3 storage classes (for example, for retrieval or early deletion).\n For more information, see [Storage\n class considerations with Amazon S3 transfers](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).\n* `NEVER` - DataSync doesn't overwrite data in the destination\n location even if the source data has changed. You can use this option to protect against\n overwriting changes made to files or objects in the destination.\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)", "RefReturnValue": "", "AllowedValues": [ "ALWAYS", "NEVER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-overwritemode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreserveDevices": { "MarkdownDocumentation": "`PreserveDevices`\n\nA value that determines whether AWS DataSync should preserve the metadata\nof block and character devices in the source file system, and re-create the files with\nthat device name and metadata on the destination. DataSync does not copy the contents of\nsuch devices, only the name and metadata.\n###### Note\nAWS DataSync can't sync the actual contents of such devices, because\nthey 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\nisn'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)", "RefReturnValue": "", "AllowedValues": [ "NONE", "PRESERVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-preservedevices", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Mtime": { "MarkdownDocumentation": "`Mtime`\n\nA value that indicates the last time that a file was modified (that is, a file was\nwritten to) before the PREPARING phase. This option is required for cases when you need\nto run the same task more than one time.\nDefault value: `PRESERVE`\n`PRESERVE`: Preserve original `Mtime` (recommended)\n`NONE`: Ignore `Mtime`.\n###### Note\nIf `Mtime` is set to `PRESERVE`, `Atime` must be\nset to `BEST_EFFORT`.\nIf `Mtime` is set to `NONE`, `Atime` must also be\nset 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)", "RefReturnValue": "", "AllowedValues": [ "NONE", "PRESERVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-mtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TaskQueueing": { "MarkdownDocumentation": "`TaskQueueing`\n\nSpecifies whether your transfer tasks should be put into a queue during certain scenarios\nwhen [running multiple\ntasks](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks). This is `ENABLED` by default.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-taskqueueing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransferMode": { "MarkdownDocumentation": "`TransferMode`\n\nA value that determines whether DataSync transfers only the data and metadata that\ndiffer between the source and the destination location, or whether DataSync transfers\nall 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\nfrom the source location to the destination location.\n`ALL`: DataSync copies all source location content to the destination,\nwithout comparing it to existing content on the destination.\n*Required*: No\n*Type*: String\n*Allowed values*: `CHANGED | ALL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CHANGED", "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-transfermode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogLevel": { "MarkdownDocumentation": "`LogLevel`\n\nSpecifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs\nlog group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn).\n* `BASIC` - Publishes logs with only basic information (such as transfer\n errors).\n* `TRANSFER` - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.\n* `OFF` - No logs are published.\n*Required*: No\n*Type*: String\n*Allowed values*: `OFF | BASIC | TRANSFER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OFF", "BASIC", "TRANSFER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-loglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ObjectTags": { "MarkdownDocumentation": "`ObjectTags`\n\nSpecifies whether you want DataSync to `PRESERVE` object tags\n(default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `PRESERVE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRESERVE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-objecttags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Uid": { "MarkdownDocumentation": "`Uid`\n\nThe user ID (UID) of the file's owner.\nDefault value:\n`INT_VALUE`\n`INT_VALUE`: Preserve the integer value of the UID and group ID (GID)\n(recommended).\n`NAME`: Currently not supported\n`NONE`: Ignore the UID and GID.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | INT_VALUE | NAME | B...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "INT_VALUE", "NAME", "BOTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-uid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BytesPerSecond": { "MarkdownDocumentation": "`BytesPerSecond`\n\nA value that limits the bandwidth used by AWS DataSync. For example, if\nyou want AWS DataSync to use a maximum of 1 MB, set this value to\n`1048576` (=1024\\*1024).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-bytespersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "PosixPermissions": { "MarkdownDocumentation": "`PosixPermissions`\n\nA value that determines which users or groups can access a file for a specific\npurpose, such as reading, writing, or execution of the file. This option should be set\nonly for Network File System (NFS), Amazon EFS, and Amazon S3 locations. For more\ninformation about what metadata is copied by DataSync, see [Metadata Copied\nby 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###### Note\nAWS DataSync can preserve extant permissions of a source\nlocation.\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)", "RefReturnValue": "", "AllowedValues": [ "NONE", "PRESERVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-posixpermissions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreserveDeletedFiles": { "MarkdownDocumentation": "`PreserveDeletedFiles`\n\nA value that specifies whether files in the destination that don't exist in the\nsource file system are preserved. This option can affect your storage costs. If your\ntask deletes objects, you might incur minimum storage duration charges for certain\nstorage 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\nthe *AWS DataSync User Guide*.\nDefault value: `PRESERVE`\n`PRESERVE`: Ignore destination files that aren't present in the source\n(recommended).\n`REMOVE`: Delete destination files that aren't present in the\nsource.\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)", "RefReturnValue": "", "AllowedValues": [ "PRESERVE", "REMOVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-preservedeletedfiles", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityDescriptorCopyFlags": { "MarkdownDocumentation": "`SecurityDescriptorCopyFlags`\n\nA value that determines which components of the SMB security descriptor are copied\nfrom source to destination objects.\nThis value is only used for transfers between SMB and Amazon FSx for Windows File\nServer locations, or between two Amazon FSx for Windows File Server locations. For more\ninformation about how DataSync handles metadata, see [How DataSync Handles Metadata and\nSpecial 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\nmetadata:\n* Object owner.\n* NTFS discretionary access control lists (DACLs), which determine whether to\n grant access to an object.\nWhen you use option, DataSync does NOT copy the NTFS system access control lists\n(SACLs), which are used by administrators to log attempts to access a secured\nobject.\n`OWNER_DACL_SACL`: For each copied object, DataSync copies the following\nmetadata:\n* Object owner.\n* NTFS discretionary access control lists (DACLs), which determine whether to\n grant access to an object.\n* NTFS system access control lists (SACLs), which are used by administrators to\n log attempts to access a secured object.\nCopying SACLs requires granting additional permissions to the Windows user that\nDataSync uses to access your SMB location. For information about choosing a user that\nensures 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.\nDestination objects are owned by the user that was provided for accessing the\ndestination location. DACLs and SACLs are set based on the destination server\u2019s\nconfiguration.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | OWNER_DACL | OWNER_D...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "OWNER_DACL", "OWNER_DACL_SACL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-securitydescriptorcopyflags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.Overrides": { "MarkdownDocumentation": "`AWS::DataSync::Task.Overrides`\n\nThe `Overrides` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html", "Properties": { "Verified": { "MarkdownDocumentation": "`Verified`\n\nProperty description not available.\n*Required*: No\n*Type*: [Verified](./aws-properties-datasync-task-verified.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-verified", "UpdateType": "Mutable", "Required": false, "Type": "Verified" }, "Skipped": { "MarkdownDocumentation": "`Skipped`\n\nProperty description not available.\n*Required*: No\n*Type*: [Skipped](./aws-properties-datasync-task-skipped.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-skipped", "UpdateType": "Mutable", "Required": false, "Type": "Skipped" }, "Transferred": { "MarkdownDocumentation": "`Transferred`\n\nProperty description not available.\n*Required*: No\n*Type*: [Transferred](./aws-properties-datasync-task-transferred.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-transferred", "UpdateType": "Mutable", "Required": false, "Type": "Transferred" }, "Deleted": { "MarkdownDocumentation": "`Deleted`\n\nProperty description not available.\n*Required*: No\n*Type*: [Deleted](./aws-properties-datasync-task-deleted.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-deleted", "UpdateType": "Mutable", "Required": false, "Type": "Deleted" } } }, "AWS::DataSync::Task.Skipped": { "MarkdownDocumentation": "`AWS::DataSync::Task.Skipped`\n\nThe `Skipped` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-skipped.html", "Properties": { "ReportLevel": { "MarkdownDocumentation": "`ReportLevel`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ERRORS_ONLY | SUCCESSES_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ERRORS_ONLY", "SUCCESSES_AND_ERRORS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-skipped.html#cfn-datasync-task-skipped-reportlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.Source": { "MarkdownDocumentation": "`AWS::DataSync::Task.Source`\n\nThe `Source` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-source.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nProperty description not available.\n*Required*: No\n*Type*: [ManifestConfigSourceS3](./aws-properties-datasync-task-manifestconfigsources3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-source.html#cfn-datasync-task-source-s3", "UpdateType": "Mutable", "Required": false, "Type": "ManifestConfigSourceS3" } } }, "AWS::DataSync::Task.TaskReportConfig": { "MarkdownDocumentation": "`AWS::DataSync::Task.TaskReportConfig`\n\nSpecifies how you want to configure a task report, which provides detailed information\nabout for your AWS DataSync transfer.\nFor more information, see [Task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nSpecifies the Amazon S3 bucket where DataSync uploads your task report.\nFor more information, see [Task\nreports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access).\n*Required*: Yes\n*Type*: [Destination](./aws-properties-datasync-task-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-destination", "UpdateType": "Mutable", "Required": true, "Type": "Destination" }, "ReportLevel": { "MarkdownDocumentation": "`ReportLevel`\n\nSpecifies whether you want your task report to include only what went wrong with your\ntransfer or a list of what succeeded and didn't.\n* `ERRORS_ONLY`: A report shows what DataSync was unable to\n transfer, skip, verify, and delete.\n* `SUCCESSES_AND_ERRORS`: A report shows what DataSync was able and\n unable to transfer, skip, verify, and delete.\n*Required*: No\n*Type*: String\n*Allowed values*: `ERRORS_ONLY | SUCCESSES_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ERRORS_ONLY", "SUCCESSES_AND_ERRORS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-reportlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ObjectVersionIds": { "MarkdownDocumentation": "`ObjectVersionIds`\n\nSpecifies whether your task report includes the new version of each object transferred\ninto an S3 bucket. This only applies if you [enable versioning on your\nbucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html). Keep in mind that setting this to `INCLUDE` can increase the\nduration of your task execution.\n*Required*: No\n*Type*: String\n*Allowed values*: `INCLUDE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCLUDE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-objectversionids", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nCustomizes the reporting level for aspects of your task report. For example, your report\nmight generally only include errors, but you could specify that you want a list of successes\nand errors just for the files that DataSync attempted to delete in your destination\nlocation.\n*Required*: No\n*Type*: [Overrides](./aws-properties-datasync-task-overrides.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-overrides", "UpdateType": "Mutable", "Required": false, "Type": "Overrides" }, "OutputType": { "MarkdownDocumentation": "`OutputType`\n\nSpecifies the type of task report that you want:\n* `SUMMARY_ONLY`: Provides necessary details about your task, including the\n number of files, objects, and directories transferred and transfer duration.\n* `STANDARD`: Provides complete details about your task, including a full\n list of files, objects, and directories that were transferred, skipped, verified, and\n more.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SUMMARY_ONLY | STANDARD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUMMARY_ONLY", "STANDARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-outputtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.TaskReportConfigDestinationS3": { "MarkdownDocumentation": "`AWS::DataSync::Task.TaskReportConfigDestinationS3`\n\nThe `TaskReportConfigDestinationS3` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfigdestinations3.html", "Properties": { "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfigdestinations3.html#cfn-datasync-task-taskreportconfigdestinations3-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3BucketArn": { "MarkdownDocumentation": "`S3BucketArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$`\n*Maximum*: `156`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfigdestinations3.html#cfn-datasync-task-taskreportconfigdestinations3-s3bucketarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketAccessRoleArn": { "MarkdownDocumentation": "`BucketAccessRoleArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfigdestinations3.html#cfn-datasync-task-taskreportconfigdestinations3-bucketaccessrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.TaskSchedule": { "MarkdownDocumentation": "`AWS::DataSync::Task.TaskSchedule`\n\nConfigures your AWS DataSync task to run on a [schedule](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)\n(at a minimum interval of 1 hour).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies whether to enable or disable your task schedule. Your schedule is enabled by\ndefault, but there can be situations where you need to disable it. For example, you might need\nto pause a recurring transfer to fix an issue with your task or perform maintenance on your\nstorage system.\nDataSync might disable your schedule automatically if your task fails repeatedly\nwith the same error. For more information, see [TaskScheduleDetails](https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nSpecifies your task schedule by using a cron or rate expression.\nUse cron expressions for task schedules that run on a specific time and day. For example,\nthe following cron expression creates a task schedule that runs at 8 AM on the first Wednesday\nof every month:\n`cron(0 8 * * 3#1)`\nUse rate expressions for task schedules that run on a regular interval. For example, the\nfollowing rate expression creates a task schedule that runs every 12 hours:\n`rate(12 hours)`\nFor information about cron and rate expression syntax, see the [*Amazon EventBridge User Guide*](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\ \\_\\*\\?\\,\\|\\^\\-\\/\\#\\s\\(\\)\\+]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-scheduleexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.Transferred": { "MarkdownDocumentation": "`AWS::DataSync::Task.Transferred`\n\nThe `Transferred` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-transferred.html", "Properties": { "ReportLevel": { "MarkdownDocumentation": "`ReportLevel`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ERRORS_ONLY | SUCCESSES_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ERRORS_ONLY", "SUCCESSES_AND_ERRORS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-transferred.html#cfn-datasync-task-transferred-reportlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataSync::Task.Verified": { "MarkdownDocumentation": "`AWS::DataSync::Task.Verified`\n\nThe `Verified` property type specifies Property description not available. for an [AWS::DataSync::Task](./aws-resource-datasync-task.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-verified.html", "Properties": { "ReportLevel": { "MarkdownDocumentation": "`ReportLevel`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ERRORS_ONLY | SUCCESSES_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ERRORS_ONLY", "SUCCESSES_AND_ERRORS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-verified.html#cfn-datasync-task-verified-reportlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.AmazonQPropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.AmazonQPropertiesInput`\n\nThe `AmazonQPropertiesInput` property type specifies Property description not available. for an [AWS::DataZone::Connection](./aws-resource-datazone-connection.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-isenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ProfileArn": { "MarkdownDocumentation": "`ProfileArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws[a-z\\-]*:[a-z0-9\\-]+:[a-z0-9\\-]*:[0-9]*:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-profilearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthMode": { "MarkdownDocumentation": "`AuthMode`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-authmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.AthenaPropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.AthenaPropertiesInput`\n\nThe Amazon Athena properties of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-athenapropertiesinput.html", "Properties": { "WorkgroupName": { "MarkdownDocumentation": "`WorkgroupName`\n\nThe Amazon Athena workgroup name of a connection.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-athenapropertiesinput.html#cfn-datazone-connection-athenapropertiesinput-workgroupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.AuthenticationConfigurationInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.AuthenticationConfigurationInput`\n\nThe authentication configuration of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe secret ARN of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe KMS key ARN of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|arn:aws[a-z0-9-]*:kms:.*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OAuth2Properties": { "MarkdownDocumentation": "`OAuth2Properties`\n\nThe oAuth2 properties of a connection.\n*Required*: No\n*Type*: [OAuth2Properties](./aws-properties-datazone-connection-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-oauth2properties", "UpdateType": "Mutable", "Required": false, "Type": "OAuth2Properties" }, "CustomAuthenticationCredentials": { "MarkdownDocumentation": "`CustomAuthenticationCredentials`\n\nThe custom authentication credentials of a connection.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-customauthenticationcredentials", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "BasicAuthenticationCredentials": { "MarkdownDocumentation": "`BasicAuthenticationCredentials`\n\nThe basic authentication credentials of a connection.\n*Required*: No\n*Type*: [BasicAuthenticationCredentials](./aws-properties-datazone-connection-basicauthenticationcredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-basicauthenticationcredentials", "UpdateType": "Mutable", "Required": false, "Type": "BasicAuthenticationCredentials" }, "AuthenticationType": { "MarkdownDocumentation": "`AuthenticationType`\n\nThe authentication type of a connection.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC | OAUTH2 | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "OAUTH2", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-authenticationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.AuthorizationCodeProperties": { "MarkdownDocumentation": "`AWS::DataZone::Connection.AuthorizationCodeProperties`\n\nThe authorization code properties of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authorizationcodeproperties.html", "Properties": { "AuthorizationCode": { "MarkdownDocumentation": "`AuthorizationCode`\n\nThe authorization code of a connection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authorizationcodeproperties.html#cfn-datazone-connection-authorizationcodeproperties-authorizationcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RedirectUri": { "MarkdownDocumentation": "`RedirectUri`\n\nThe redirect URI of a connection.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authorizationcodeproperties.html#cfn-datazone-connection-authorizationcodeproperties-redirecturi", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.AwsLocation": { "MarkdownDocumentation": "`AWS::DataZone::Connection.AwsLocation`\n\nThe location of a project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html", "Properties": { "AwsRegion": { "MarkdownDocumentation": "`AwsRegion`\n\nThe Region of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z]{2}-[a-z]{4,10}-\\d$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-awsregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessRole": { "MarkdownDocumentation": "`AccessRole`\n\nThe access role of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-accessrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe account ID of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-awsaccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamConnectionId": { "MarkdownDocumentation": "`IamConnectionId`\n\nThe IAM connection ID of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-iamconnectionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.BasicAuthenticationCredentials": { "MarkdownDocumentation": "`AWS::DataZone::Connection.BasicAuthenticationCredentials`\n\nThe basic authentication credentials of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-basicauthenticationcredentials.html", "Properties": { "UserName": { "MarkdownDocumentation": "`UserName`\n\nThe user name for the connecion.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-basicauthenticationcredentials.html#cfn-datazone-connection-basicauthenticationcredentials-username", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password for a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-basicauthenticationcredentials.html#cfn-datazone-connection-basicauthenticationcredentials-password", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.ConnectionPropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.ConnectionPropertiesInput`\n\nThe properties of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html", "Properties": { "AmazonQProperties": { "MarkdownDocumentation": "`AmazonQProperties`\n\nProperty description not available.\n*Required*: No\n*Type*: [AmazonQPropertiesInput](./aws-properties-datazone-connection-amazonqpropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-amazonqproperties", "UpdateType": "Mutable", "Required": false, "Type": "AmazonQPropertiesInput" }, "IamProperties": { "MarkdownDocumentation": "`IamProperties`\n\nThe IAM properties of a connection.\n*Required*: No\n*Type*: [IamPropertiesInput](./aws-properties-datazone-connection-iampropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-iamproperties", "UpdateType": "Mutable", "Required": false, "Type": "IamPropertiesInput" }, "S3Properties": { "MarkdownDocumentation": "`S3Properties`\n\nProperty description not available.\n*Required*: No\n*Type*: [S3PropertiesInput](./aws-properties-datazone-connection-s3propertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-s3properties", "UpdateType": "Mutable", "Required": false, "Type": "S3PropertiesInput" }, "SparkEmrProperties": { "MarkdownDocumentation": "`SparkEmrProperties`\n\nThe Spark EMR properties of a connection.\n*Required*: No\n*Type*: [SparkEmrPropertiesInput](./aws-properties-datazone-connection-sparkemrpropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-sparkemrproperties", "UpdateType": "Mutable", "Required": false, "Type": "SparkEmrPropertiesInput" }, "HyperPodProperties": { "MarkdownDocumentation": "`HyperPodProperties`\n\nThe hyper pod properties of a connection.\n*Required*: No\n*Type*: [HyperPodPropertiesInput](./aws-properties-datazone-connection-hyperpodpropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-hyperpodproperties", "UpdateType": "Mutable", "Required": false, "Type": "HyperPodPropertiesInput" }, "SparkGlueProperties": { "MarkdownDocumentation": "`SparkGlueProperties`\n\nThe Spark AWS Glue properties of a connection.\n*Required*: No\n*Type*: [SparkGluePropertiesInput](./aws-properties-datazone-connection-sparkgluepropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-sparkglueproperties", "UpdateType": "Mutable", "Required": false, "Type": "SparkGluePropertiesInput" }, "MlflowProperties": { "MarkdownDocumentation": "`MlflowProperties`\n\nProperty description not available.\n*Required*: No\n*Type*: [MlflowPropertiesInput](./aws-properties-datazone-connection-mlflowpropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-mlflowproperties", "UpdateType": "Mutable", "Required": false, "Type": "MlflowPropertiesInput" }, "AthenaProperties": { "MarkdownDocumentation": "`AthenaProperties`\n\nThe Amazon Athena properties of a connection.\n*Required*: No\n*Type*: [AthenaPropertiesInput](./aws-properties-datazone-connection-athenapropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-athenaproperties", "UpdateType": "Mutable", "Required": false, "Type": "AthenaPropertiesInput" }, "GlueProperties": { "MarkdownDocumentation": "`GlueProperties`\n\nThe AWS Glue properties of a connection.\n*Required*: No\n*Type*: [GluePropertiesInput](./aws-properties-datazone-connection-gluepropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-glueproperties", "UpdateType": "Mutable", "Required": false, "Type": "GluePropertiesInput" }, "RedshiftProperties": { "MarkdownDocumentation": "`RedshiftProperties`\n\nThe Amazon Redshift properties of a connection.\n*Required*: No\n*Type*: [RedshiftPropertiesInput](./aws-properties-datazone-connection-redshiftpropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-redshiftproperties", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftPropertiesInput" } } }, "AWS::DataZone::Connection.GlueConnectionInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.GlueConnectionInput`\n\nThe AWS Glue connecton input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html", "Properties": { "PythonProperties": { "MarkdownDocumentation": "`PythonProperties`\n\nThe Python properties of the AWS Glue connection.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-pythonproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "AuthenticationConfiguration": { "MarkdownDocumentation": "`AuthenticationConfiguration`\n\nThe authentication configuration of the AWS Glue connection.\n*Required*: No\n*Type*: [AuthenticationConfigurationInput](./aws-properties-datazone-connection-authenticationconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-authenticationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AuthenticationConfigurationInput" }, "SparkProperties": { "MarkdownDocumentation": "`SparkProperties`\n\nThe Spark properties of the AWS Glue connection.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-sparkproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the AWS Glue connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFF\\r\\n\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionType": { "MarkdownDocumentation": "`ConnectionType`\n\nThe connection type of the AWS Glue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-connectiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MatchCriteria": { "MarkdownDocumentation": "`MatchCriteria`\n\nThe match criteria of the AWS Glue connection.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-matchcriteria", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PhysicalConnectionRequirements": { "MarkdownDocumentation": "`PhysicalConnectionRequirements`\n\nThe physical connection requirements for the AWS Glue connection.\n*Required*: No\n*Type*: [PhysicalConnectionRequirements](./aws-properties-datazone-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-physicalconnectionrequirements", "UpdateType": "Mutable", "Required": false, "Type": "PhysicalConnectionRequirements" }, "ConnectionProperties": { "MarkdownDocumentation": "`ConnectionProperties`\n\nThe connection properties of the AWS Glue connection.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-connectionproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "AthenaProperties": { "MarkdownDocumentation": "`AthenaProperties`\n\nThe Amazon Athena properties of the AWS Glue connection.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-athenaproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ValidateForComputeEnvironments": { "MarkdownDocumentation": "`ValidateForComputeEnvironments`\n\nSpeciefies whether to validate for compute environments of the AWS Glue\nconnection.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-validateforcomputeenvironments", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ValidateCredentials": { "MarkdownDocumentation": "`ValidateCredentials`\n\nSpeciefies whether to validate credentials of the AWS Glue\nconnection.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-validatecredentials", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the AWS Glue connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.GlueOAuth2Credentials": { "MarkdownDocumentation": "`AWS::DataZone::Connection.GlueOAuth2Credentials`\n\nThe GlueOAuth2 credentials of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html", "Properties": { "UserManagedClientApplicationClientSecret": { "MarkdownDocumentation": "`UserManagedClientApplicationClientSecret`\n\nThe user managed client application client secret of the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\x20-\\x7E]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-usermanagedclientapplicationclientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JwtToken": { "MarkdownDocumentation": "`JwtToken`\n\nThe jwt token of the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_\\-\\+\\/=]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-jwttoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RefreshToken": { "MarkdownDocumentation": "`RefreshToken`\n\nThe refresh token of the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\x20-\\x7E]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-refreshtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe access token of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\x20-\\x7E]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.GluePropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.GluePropertiesInput`\n\nThe AWS Glue properties of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-gluepropertiesinput.html", "Properties": { "GlueConnectionInput": { "MarkdownDocumentation": "`GlueConnectionInput`\n\nThe AWS Glue connection.\n*Required*: No\n*Type*: [GlueConnectionInput](./aws-properties-datazone-connection-glueconnectioninput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-gluepropertiesinput.html#cfn-datazone-connection-gluepropertiesinput-glueconnectioninput", "UpdateType": "Mutable", "Required": false, "Type": "GlueConnectionInput" } } }, "AWS::DataZone::Connection.HyperPodPropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.HyperPodPropertiesInput`\n\nThe hyper pod properties of a AWS Glue properties patch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-hyperpodpropertiesinput.html", "Properties": { "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe cluster name the hyper pod properties.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-hyperpodpropertiesinput.html#cfn-datazone-connection-hyperpodpropertiesinput-clustername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.IamPropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.IamPropertiesInput`\n\nThe IAM properties of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-iampropertiesinput.html", "Properties": { "GlueLineageSyncEnabled": { "MarkdownDocumentation": "`GlueLineageSyncEnabled`\n\nSpecifies whether AWS Glue lineage sync is enabled for a\nconnection.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-iampropertiesinput.html#cfn-datazone-connection-iampropertiesinput-gluelineagesyncenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::Connection.LineageSyncSchedule": { "MarkdownDocumentation": "`AWS::DataZone::Connection.LineageSyncSchedule`\n\nThe lineage sync schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-lineagesyncschedule.html", "Properties": { "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe lineage sync schedule.\n*Required*: No\n*Type*: String\n*Pattern*: `^cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) ([-?*,/\\dLW]){1,83} ([-*,/\\d]|[a-zA-Z]{3}){1,23} ([-?#*,/\\dL]|[a-zA-Z]{3}){1,13} ([^\\)]+)\\)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-lineagesyncschedule.html#cfn-datazone-connection-lineagesyncschedule-schedule", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.MlflowPropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.MlflowPropertiesInput`\n\nThe `MlflowPropertiesInput` property type specifies Property description not available. for an [AWS::DataZone::Connection](./aws-resource-datazone-connection.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-mlflowpropertiesinput.html", "Properties": { "TrackingServerArn": { "MarkdownDocumentation": "`TrackingServerArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-mlflowpropertiesinput.html#cfn-datazone-connection-mlflowpropertiesinput-trackingserverarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.OAuth2ClientApplication": { "MarkdownDocumentation": "`AWS::DataZone::Connection.OAuth2ClientApplication`\n\nThe OAuth2Client application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2clientapplication.html", "Properties": { "AWSManagedClientApplicationReference": { "MarkdownDocumentation": "`AWSManagedClientApplicationReference`\n\nThe AWS managed client application reference in the OAuth2Client\napplication.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2clientapplication.html#cfn-datazone-connection-oauth2clientapplication-awsmanagedclientapplicationreference", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserManagedClientApplicationClientId": { "MarkdownDocumentation": "`UserManagedClientApplicationClientId`\n\nThe user managed client application client ID in the OAuth2Client application.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2clientapplication.html#cfn-datazone-connection-oauth2clientapplication-usermanagedclientapplicationclientid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.OAuth2Properties": { "MarkdownDocumentation": "`AWS::DataZone::Connection.OAuth2Properties`\n\nThe OAuth2 properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html", "Properties": { "AuthorizationCodeProperties": { "MarkdownDocumentation": "`AuthorizationCodeProperties`\n\nThe authorization code properties of the OAuth2 properties.\n*Required*: No\n*Type*: [AuthorizationCodeProperties](./aws-properties-datazone-connection-authorizationcodeproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-authorizationcodeproperties", "UpdateType": "Mutable", "Required": false, "Type": "AuthorizationCodeProperties" }, "OAuth2ClientApplication": { "MarkdownDocumentation": "`OAuth2ClientApplication`\n\nThe OAuth2 client application of the OAuth2 properties.\n*Required*: No\n*Type*: [OAuth2ClientApplication](./aws-properties-datazone-connection-oauth2clientapplication.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2clientapplication", "UpdateType": "Mutable", "Required": false, "Type": "OAuth2ClientApplication" }, "TokenUrl": { "MarkdownDocumentation": "`TokenUrl`\n\nThe OAuth2 token URL of the OAuth2 properties.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-tokenurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OAuth2Credentials": { "MarkdownDocumentation": "`OAuth2Credentials`\n\nThe OAuth2 credentials of the OAuth2 properties.\n*Required*: No\n*Type*: [GlueOAuth2Credentials](./aws-properties-datazone-connection-glueoauth2credentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2credentials", "UpdateType": "Mutable", "Required": false, "Type": "GlueOAuth2Credentials" }, "OAuth2GrantType": { "MarkdownDocumentation": "`OAuth2GrantType`\n\nThe OAuth2 grant type of the OAuth2 properties.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTHORIZATION_CODE | CLIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "JWT_BEARER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2granttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TokenUrlParametersMap": { "MarkdownDocumentation": "`TokenUrlParametersMap`\n\nThe OAuth2 token URL parameter map of the OAuth2 properties.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-tokenurlparametersmap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::DataZone::Connection.PhysicalConnectionRequirements": { "MarkdownDocumentation": "`AWS::DataZone::Connection.PhysicalConnectionRequirements`\n\nPhysical connection requirements of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html", "Properties": { "SubnetIdList": { "MarkdownDocumentation": "`SubnetIdList`\n\nThe subnet ID list of the physical connection requirements of a connection.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `32 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-subnetidlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe availability zone of the physical connection requirements of a connection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIdList": { "MarkdownDocumentation": "`SecurityGroupIdList`\n\nThe group ID list of the physical connection requirements of a connection.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `255 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-securitygroupidlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe subnet ID of the physical connection requirements of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^subnet-[a-z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-subnetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.RedshiftCredentials": { "MarkdownDocumentation": "`AWS::DataZone::Connection.RedshiftCredentials`\n\nAmazon Redshift credentials of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftcredentials.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe secret ARN of the Amazon Redshift credentials of a connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\\d{12}:secret:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftcredentials.html#cfn-datazone-connection-redshiftcredentials-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UsernamePassword": { "MarkdownDocumentation": "`UsernamePassword`\n\nThe username and password of the Amazon Redshift credentials of a connection.\n*Required*: No\n*Type*: [UsernamePassword](./aws-properties-datazone-connection-usernamepassword.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftcredentials.html#cfn-datazone-connection-redshiftcredentials-usernamepassword", "UpdateType": "Mutable", "Required": false, "Type": "UsernamePassword" } } }, "AWS::DataZone::Connection.RedshiftLineageSyncConfigurationInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.RedshiftLineageSyncConfigurationInput`\n\nThe Amaon Redshift lineage sync configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html", "Properties": { "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe schedule of the Amaon Redshift lineage sync configuration.\n*Required*: No\n*Type*: [LineageSyncSchedule](./aws-properties-datazone-connection-lineagesyncschedule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-schedule", "UpdateType": "Mutable", "Required": false, "Type": "LineageSyncSchedule" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether the Amaon Redshift lineage sync 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::Connection.RedshiftPropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.RedshiftPropertiesInput`\n\nThe Amazon Redshift properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html", "Properties": { "Storage": { "MarkdownDocumentation": "`Storage`\n\nThe Amazon Redshift storage.\n*Required*: No\n*Type*: [RedshiftStorageProperties](./aws-properties-datazone-connection-redshiftstorageproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-storage", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftStorageProperties" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe Amaon Redshift port.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe Amazon Redshift database name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThe Amazon Redshift host.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-host", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Credentials": { "MarkdownDocumentation": "`Credentials`\n\nThe Amaon Redshift credentials.\n*Required*: No\n*Type*: [RedshiftCredentials](./aws-properties-datazone-connection-redshiftcredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-credentials", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftCredentials" }, "LineageSync": { "MarkdownDocumentation": "`LineageSync`\n\nThe lineage sync of the Amazon Redshift.\n*Required*: No\n*Type*: [RedshiftLineageSyncConfigurationInput](./aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-lineagesync", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftLineageSyncConfigurationInput" } } }, "AWS::DataZone::Connection.RedshiftStorageProperties": { "MarkdownDocumentation": "`AWS::DataZone::Connection.RedshiftStorageProperties`\n\nThe Amazon Redshift storage properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftstorageproperties.html", "Properties": { "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe cluster name in the Amazon Redshift storage properties.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftstorageproperties.html#cfn-datazone-connection-redshiftstorageproperties-clustername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WorkgroupName": { "MarkdownDocumentation": "`WorkgroupName`\n\nThe workgroup name in the Amazon Redshift storage properties.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftstorageproperties.html#cfn-datazone-connection-redshiftstorageproperties-workgroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.S3PropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.S3PropertiesInput`\n\nThe `S3PropertiesInput` property type specifies Property description not available. for an [AWS::DataZone::Connection](./aws-resource-datazone-connection.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-s3propertiesinput.html", "Properties": { "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `s3://.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-s3propertiesinput.html#cfn-datazone-connection-s3propertiesinput-s3uri", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3AccessGrantLocationId": { "MarkdownDocumentation": "`S3AccessGrantLocationId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\-]+`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-s3propertiesinput.html#cfn-datazone-connection-s3propertiesinput-s3accessgrantlocationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.SparkEmrPropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.SparkEmrPropertiesInput`\n\nThe Spark EMR properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html", "Properties": { "ComputeArn": { "MarkdownDocumentation": "`ComputeArn`\n\nThe compute ARN of Spark EMR.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov|iso(-[bef])?))?:(elasticmapreduce|emr-serverless|emr-containers):.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-computearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustedCertificatesS3Uri": { "MarkdownDocumentation": "`TrustedCertificatesS3Uri`\n\nThe certificates S3 URI of the Spark EMR.\n*Required*: No\n*Type*: String\n*Pattern*: `^s3://.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-trustedcertificatess3uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogUri": { "MarkdownDocumentation": "`LogUri`\n\nThe log URI of the Spark EMR.\n*Required*: No\n*Type*: String\n*Pattern*: `^s3://.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-loguri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JavaVirtualEnv": { "MarkdownDocumentation": "`JavaVirtualEnv`\n\nThe java virtual env of the Spark EMR.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-javavirtualenv", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PythonVirtualEnv": { "MarkdownDocumentation": "`PythonVirtualEnv`\n\nThe Python virtual env of the Spark EMR.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-pythonvirtualenv", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuntimeRole": { "MarkdownDocumentation": "`RuntimeRole`\n\nThe runtime role of the Spark EMR.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-runtimerole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceProfileArn": { "MarkdownDocumentation": "`InstanceProfileArn`\n\nThe instance profile ARN of Spark EMR.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-instanceprofilearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManagedEndpointArn": { "MarkdownDocumentation": "`ManagedEndpointArn`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-managedendpointarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.SparkGlueArgs": { "MarkdownDocumentation": "`AWS::DataZone::Connection.SparkGlueArgs`\n\nThe Spark AWS Glue args.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkglueargs.html", "Properties": { "Connection": { "MarkdownDocumentation": "`Connection`\n\nThe connection in the Spark AWS Glue args.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkglueargs.html#cfn-datazone-connection-sparkglueargs-connection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Connection.SparkGluePropertiesInput": { "MarkdownDocumentation": "`AWS::DataZone::Connection.SparkGluePropertiesInput`\n\nThe Spark AWS Glue properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html", "Properties": { "WorkerType": { "MarkdownDocumentation": "`WorkerType`\n\nThe worker type in the Spark AWS Glue properties.\n*Required*: No\n*Type*: String\n*Pattern*: `^[G|Z].*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-workertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdditionalArgs": { "MarkdownDocumentation": "`AdditionalArgs`\n\nThe additional args in the Spark AWS Glue properties.\n*Required*: No\n*Type*: [SparkGlueArgs](./aws-properties-datazone-connection-sparkglueargs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-additionalargs", "UpdateType": "Mutable", "Required": false, "Type": "SparkGlueArgs" }, "JavaVirtualEnv": { "MarkdownDocumentation": "`JavaVirtualEnv`\n\nThe Java virtual env in the Spark AWS Glue properties.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-javavirtualenv", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GlueVersion": { "MarkdownDocumentation": "`GlueVersion`\n\nThe AWS Glue version in the Spark AWS Glue\nproperties.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\w+\\.\\w+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-glueversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PythonVirtualEnv": { "MarkdownDocumentation": "`PythonVirtualEnv`\n\nThe Python virtual env in the Spark AWS Glue properties.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-pythonvirtualenv", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdleTimeout": { "MarkdownDocumentation": "`IdleTimeout`\n\nThe idle timeout in the Spark AWS Glue properties.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `3000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-idletimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "GlueConnectionName": { "MarkdownDocumentation": "`GlueConnectionName`\n\nThe AWS Glue connection name in the Spark AWS Glue\nproperties.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-glueconnectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumberOfWorkers": { "MarkdownDocumentation": "`NumberOfWorkers`\n\nThe number of workers in the Spark AWS Glue properties.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-numberofworkers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::DataZone::Connection.UsernamePassword": { "MarkdownDocumentation": "`AWS::DataZone::Connection.UsernamePassword`\n\nThe username and password of a connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-usernamepassword.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe username of a connection.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-usernamepassword.html#cfn-datazone-connection-usernamepassword-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password of a connection.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-usernamepassword.html#cfn-datazone-connection-usernamepassword-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::DataSource.DataSourceConfigurationInput": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.DataSourceConfigurationInput`\n\nThe configuration of the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html", "Properties": { "RedshiftRunConfiguration": { "MarkdownDocumentation": "`RedshiftRunConfiguration`\n\nThe configuration of the Amazon Redshift data source.\n*Required*: No\n*Type*: [RedshiftRunConfigurationInput](./aws-properties-datazone-datasource-redshiftrunconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-redshiftrunconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftRunConfigurationInput" }, "GlueRunConfiguration": { "MarkdownDocumentation": "`GlueRunConfiguration`\n\nThe configuration of the AWS Glue data source.\n*Required*: No\n*Type*: [GlueRunConfigurationInput](./aws-properties-datazone-datasource-gluerunconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-gluerunconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GlueRunConfigurationInput" }, "SageMakerRunConfiguration": { "MarkdownDocumentation": "`SageMakerRunConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [SageMakerRunConfigurationInput](./aws-properties-datazone-datasource-sagemakerrunconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-sagemakerrunconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SageMakerRunConfigurationInput" } } }, "AWS::DataZone::DataSource.FilterExpression": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.FilterExpression`\n\nA filter expression in Amazon DataZone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe search filter explresison type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INCLUDE | EXCLUDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCLUDE", "EXCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html#cfn-datazone-datasource-filterexpression-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe search filter expression.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html#cfn-datazone-datasource-filterexpression-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::DataSource.FormInput": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.FormInput`\n\nThe `FormInput` property type specifies Property description not available. for an [AWS::DataZone::DataSource](./aws-resource-datazone-datasource.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html", "Properties": { "TypeIdentifier": { "MarkdownDocumentation": "`TypeIdentifier`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?!\\.)[\\w\\.]*\\w$`\n*Minimum*: `1`\n*Maximum*: `385`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-typeidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeRevision": { "MarkdownDocumentation": "`TypeRevision`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-typerevision", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Maximum*: `75000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-content", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormName": { "MarkdownDocumentation": "`FormName`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-formname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::DataSource.GlueRunConfigurationInput": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.GlueRunConfigurationInput`\n\nThe configuration details of the AWS Glue data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html", "Properties": { "DataAccessRole": { "MarkdownDocumentation": "`DataAccessRole`\n\nThe data access role included in the configuration details of the AWS Glue data\nsource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-dataaccessrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoImportDataQualityResult": { "MarkdownDocumentation": "`AutoImportDataQualityResult`\n\nSpecifies whether to automatically import data quality metrics as part of the data\nsource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-autoimportdataqualityresult", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RelationalFilterConfigurations": { "MarkdownDocumentation": "`RelationalFilterConfigurations`\n\nThe relational filter configurations included in the configuration details of the AWS\nGlue data source.\n*Required*: Yes\n*Type*: Array of [RelationalFilterConfiguration](./aws-properties-datazone-datasource-relationalfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-relationalfilterconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RelationalFilterConfiguration", "DuplicatesAllowed": true }, "CatalogName": { "MarkdownDocumentation": "`CatalogName`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-catalogname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::DataSource.RecommendationConfiguration": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.RecommendationConfiguration`\n\nThe recommendation configuration for the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-recommendationconfiguration.html", "Properties": { "EnableBusinessNameGeneration": { "MarkdownDocumentation": "`EnableBusinessNameGeneration`\n\nSpecifies whether automatic business name generation is to be enabled or not as part of\nthe recommendation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-recommendationconfiguration.html#cfn-datazone-datasource-recommendationconfiguration-enablebusinessnamegeneration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::DataSource.RedshiftClusterStorage": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.RedshiftClusterStorage`\n\nThe details of the Amazon Redshift cluster storage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftclusterstorage.html", "Properties": { "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of an Amazon Redshift cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z].[a-z0-9\\-]*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftclusterstorage.html#cfn-datazone-datasource-redshiftclusterstorage-clustername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::DataSource.RedshiftCredentialConfiguration": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.RedshiftCredentialConfiguration`\n\nThe details of the credentials required to access an Amazon Redshift cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftcredentialconfiguration.html", "Properties": { "SecretManagerArn": { "MarkdownDocumentation": "`SecretManagerArn`\n\nThe ARN of a secret manager for an Amazon Redshift cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\\d{12}:secret:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftcredentialconfiguration.html#cfn-datazone-datasource-redshiftcredentialconfiguration-secretmanagerarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::DataSource.RedshiftRunConfigurationInput": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.RedshiftRunConfigurationInput`\n\nThe relational filter configurations included in the configuration details of the\nAmazon Redshift data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html", "Properties": { "DataAccessRole": { "MarkdownDocumentation": "`DataAccessRole`\n\nThe data access role included in the configuration details of the Amazon Redshift data\nsource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-dataaccessrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RelationalFilterConfigurations": { "MarkdownDocumentation": "`RelationalFilterConfigurations`\n\nThe relational filter configurations included in the configuration details of the AWS\nGlue data source.\n*Required*: Yes\n*Type*: Array of [RelationalFilterConfiguration](./aws-properties-datazone-datasource-relationalfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-relationalfilterconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RelationalFilterConfiguration", "DuplicatesAllowed": true }, "RedshiftCredentialConfiguration": { "MarkdownDocumentation": "`RedshiftCredentialConfiguration`\n\nThe details of the credentials required to access an Amazon Redshift cluster.\n*Required*: No\n*Type*: [RedshiftCredentialConfiguration](./aws-properties-datazone-datasource-redshiftcredentialconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftcredentialconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftCredentialConfiguration" }, "RedshiftStorage": { "MarkdownDocumentation": "`RedshiftStorage`\n\nThe details of the Amazon Redshift storage as part of the configuration of an Amazon\nRedshift data source run.\n*Required*: No\n*Type*: [RedshiftStorage](./aws-properties-datazone-datasource-redshiftstorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftstorage", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftStorage" } } }, "AWS::DataZone::DataSource.RedshiftServerlessStorage": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.RedshiftServerlessStorage`\n\nThe details of the Amazon Redshift Serverless workgroup storage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftserverlessstorage.html", "Properties": { "WorkgroupName": { "MarkdownDocumentation": "`WorkgroupName`\n\nThe name of the Amazon Redshift Serverless workgroup.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftserverlessstorage.html#cfn-datazone-datasource-redshiftserverlessstorage-workgroupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::DataSource.RedshiftStorage": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.RedshiftStorage`\n\nThe details of the Amazon Redshift storage as part of the configuration of an Amazon\nRedshift data source run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html", "Properties": { "RedshiftClusterSource": { "MarkdownDocumentation": "`RedshiftClusterSource`\n\nThe details of the Amazon Redshift cluster source.\n*Required*: No\n*Type*: [RedshiftClusterStorage](./aws-properties-datazone-datasource-redshiftclusterstorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html#cfn-datazone-datasource-redshiftstorage-redshiftclustersource", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftClusterStorage" }, "RedshiftServerlessSource": { "MarkdownDocumentation": "`RedshiftServerlessSource`\n\nThe details of the Amazon Redshift Serverless workgroup source.\n*Required*: No\n*Type*: [RedshiftServerlessStorage](./aws-properties-datazone-datasource-redshiftserverlessstorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html#cfn-datazone-datasource-redshiftstorage-redshiftserverlesssource", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftServerlessStorage" } } }, "AWS::DataZone::DataSource.RelationalFilterConfiguration": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.RelationalFilterConfiguration`\n\nThe relational filter configuration for the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html", "Properties": { "FilterExpressions": { "MarkdownDocumentation": "`FilterExpressions`\n\nThe filter expressions specified in the relational filter configuration for the data\nsource.\n*Required*: No\n*Type*: Array of [FilterExpression](./aws-properties-datazone-datasource-filterexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-filterexpressions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterExpression", "DuplicatesAllowed": true }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe database name specified in the relational filter configuration for the data\nsource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SchemaName": { "MarkdownDocumentation": "`SchemaName`\n\nThe schema name specified in the relational filter configuration for the data\nsource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-schemaname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::DataSource.SageMakerRunConfigurationInput": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.SageMakerRunConfigurationInput`\n\nThe `SageMakerRunConfigurationInput` property type specifies Property description not available. for an [AWS::DataZone::DataSource](./aws-resource-datazone-datasource.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-sagemakerrunconfigurationinput.html", "Properties": { "TrackingAssets": { "MarkdownDocumentation": "`TrackingAssets`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Object of Array\n*Pattern*: `^.{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-sagemakerrunconfigurationinput.html#cfn-datazone-datasource-sagemakerrunconfigurationinput-trackingassets", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::DataZone::DataSource.ScheduleConfiguration": { "MarkdownDocumentation": "`AWS::DataZone::DataSource.ScheduleConfiguration`\n\nThe details of the schedule of the data source runs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html", "Properties": { "Timezone": { "MarkdownDocumentation": "`Timezone`\n\nThe timezone of the data source run.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html#cfn-datazone-datasource-scheduleconfiguration-timezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe schedule of the data source runs.\n*Required*: No\n*Type*: String\n*Pattern*: `cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) (.*){1,5} (.*){1,5} (.*){1,5} (.*){1,5}\\)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html#cfn-datazone-datasource-scheduleconfiguration-schedule", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Domain.SingleSignOn": { "MarkdownDocumentation": "`AWS::DataZone::Domain.SingleSignOn`\n\nThe single sign-on details in Amazon DataZone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of single sign-on in Amazon DataZone.\n*Required*: No\n*Type*: String\n*Allowed values*: `IAM_IDC | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IAM_IDC", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html#cfn-datazone-domain-singlesignon-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserAssignment": { "MarkdownDocumentation": "`UserAssignment`\n\nThe single sign-on user assignment in Amazon DataZone.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html#cfn-datazone-domain-singlesignon-userassignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdcInstanceArn": { "MarkdownDocumentation": "`IdcInstanceArn`\n\nThe ARN of the IDC instance.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html#cfn-datazone-domain-singlesignon-idcinstancearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Environment.EnvironmentParameter": { "MarkdownDocumentation": "`AWS::DataZone::Environment.EnvironmentParameter`\n\nThe parameter details of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environment-environmentparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the environment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environment-environmentparameter.html#cfn-datazone-environment-environmentparameter-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the environment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environment-environmentparameter.html#cfn-datazone-environment-environmentparameter-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::EnvironmentActions.AwsConsoleLinkParameters": { "MarkdownDocumentation": "`AWS::DataZone::EnvironmentActions.AwsConsoleLinkParameters`\n\nThe parameters of the console link specified as part of the environment action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentactions-awsconsolelinkparameters.html", "Properties": { "Uri": { "MarkdownDocumentation": "`Uri`\n\nThe URI of the console link specified as part of the environment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentactions-awsconsolelinkparameters.html#cfn-datazone-environmentactions-awsconsolelinkparameters-uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::EnvironmentBlueprintConfiguration.LakeFormationConfiguration": { "MarkdownDocumentation": "`AWS::DataZone::EnvironmentBlueprintConfiguration.LakeFormationConfiguration`\n\nThe Lake Formation configuration of the Data Lake blueprint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-lakeformationconfiguration.html", "Properties": { "LocationRegistrationExcludeS3Locations": { "MarkdownDocumentation": "`LocationRegistrationExcludeS3Locations`\n\nSpecifies certain Amazon S3 locations if you do not want Amazon DataZone to\nautomatically register them in hybrid mode.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `1024 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-lakeformationconfiguration.html#cfn-datazone-environmentblueprintconfiguration-lakeformationconfiguration-locationregistrationexcludes3locations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LocationRegistrationRole": { "MarkdownDocumentation": "`LocationRegistrationRole`\n\nThe role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for\nData Lake using AWS Lake Formation hybrid access mode.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-lakeformationconfiguration.html#cfn-datazone-environmentblueprintconfiguration-lakeformationconfiguration-locationregistrationrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::EnvironmentBlueprintConfiguration.ProvisioningConfiguration": { "MarkdownDocumentation": "`AWS::DataZone::EnvironmentBlueprintConfiguration.ProvisioningConfiguration`\n\nThe provisioning configuration of the blueprint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-provisioningconfiguration.html", "Properties": { "LakeFormationConfiguration": { "MarkdownDocumentation": "`LakeFormationConfiguration`\n\nThe Lake Formation configuration of the Data Lake blueprint.\n*Required*: Yes\n*Type*: [LakeFormationConfiguration](./aws-properties-datazone-environmentblueprintconfiguration-lakeformationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-provisioningconfiguration.html#cfn-datazone-environmentblueprintconfiguration-provisioningconfiguration-lakeformationconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "LakeFormationConfiguration" } } }, "AWS::DataZone::EnvironmentBlueprintConfiguration.RegionalParameter": { "MarkdownDocumentation": "`AWS::DataZone::EnvironmentBlueprintConfiguration.RegionalParameter`\n\nThe regional parameters in the environment blueprint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nA string to string map containing parameters for the region.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.html#cfn-datazone-environmentblueprintconfiguration-regionalparameter-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe region specified in the environment parameter.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.html#cfn-datazone-environmentblueprintconfiguration-regionalparameter-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::EnvironmentProfile.EnvironmentParameter": { "MarkdownDocumentation": "`AWS::DataZone::EnvironmentProfile.EnvironmentParameter`\n\nThe parameter details of an environment profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentprofile-environmentparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the environment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentprofile-environmentparameter.html#cfn-datazone-environmentprofile-environmentparameter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name specified in the environment parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentprofile-environmentparameter.html#cfn-datazone-environmentprofile-environmentparameter-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::FormType.Model": { "MarkdownDocumentation": "`AWS::DataZone::FormType.Model`\n\nThe `Model` property type specifies Property description not available. for an [AWS::DataZone::FormType](./aws-resource-datazone-formtype.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-formtype-model.html", "Properties": { "Smithy": { "MarkdownDocumentation": "`Smithy`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `100000`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-formtype-model.html#cfn-datazone-formtype-model-smithy", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Owner.OwnerGroupProperties": { "MarkdownDocumentation": "`AWS::DataZone::Owner.OwnerGroupProperties`\n\nThe properties of the domain unit owners group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-ownergroupproperties.html", "Properties": { "GroupIdentifier": { "MarkdownDocumentation": "`GroupIdentifier`\n\nThe ID of the domain unit owners group.\n*Required*: No\n*Type*: String\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}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-ownergroupproperties.html#cfn-datazone-owner-ownergroupproperties-groupidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Owner.OwnerProperties": { "MarkdownDocumentation": "`AWS::DataZone::Owner.OwnerProperties`\n\nThe properties of a domain unit's owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-ownerproperties.html", "Properties": { "Group": { "MarkdownDocumentation": "`Group`\n\nSpecifies that the domain unit owner is a group.\n*Required*: No\n*Type*: [OwnerGroupProperties](./aws-properties-datazone-owner-ownergroupproperties.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-ownerproperties.html#cfn-datazone-owner-ownerproperties-group", "UpdateType": "Immutable", "Required": false, "Type": "OwnerGroupProperties" }, "User": { "MarkdownDocumentation": "`User`\n\nSpecifies that the domain unit owner is a user.\n*Required*: No\n*Type*: [OwnerUserProperties](./aws-properties-datazone-owner-owneruserproperties.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-ownerproperties.html#cfn-datazone-owner-ownerproperties-user", "UpdateType": "Immutable", "Required": false, "Type": "OwnerUserProperties" } } }, "AWS::DataZone::Owner.OwnerUserProperties": { "MarkdownDocumentation": "`AWS::DataZone::Owner.OwnerUserProperties`\n\nThe properties of the owner user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-owneruserproperties.html", "Properties": { "UserIdentifier": { "MarkdownDocumentation": "`UserIdentifier`\n\nThe ID of the owner user.\n*Required*: No\n*Type*: String\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}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-owneruserproperties.html#cfn-datazone-owner-owneruserproperties-useridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::PolicyGrant.AddToProjectMemberPoolPolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.AddToProjectMemberPoolPolicyGrantDetail`\n\nThe details of the policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail.html", "Properties": { "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether the policy grant is applied to child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail.html#cfn-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.CreateAssetTypePolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.CreateAssetTypePolicyGrantDetail`\n\nThe details of the policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createassettypepolicygrantdetail.html", "Properties": { "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether the policy grant is applied to child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createassettypepolicygrantdetail.html#cfn-datazone-policygrant-createassettypepolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.CreateDomainUnitPolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.CreateDomainUnitPolicyGrantDetail`\n\nThe details of the policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createdomainunitpolicygrantdetail.html", "Properties": { "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether the policy grant is applied to child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createdomainunitpolicygrantdetail.html#cfn-datazone-policygrant-createdomainunitpolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.CreateEnvironmentProfilePolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.CreateEnvironmentProfilePolicyGrantDetail`\n\nThe details of the policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createenvironmentprofilepolicygrantdetail.html", "Properties": { "DomainUnitId": { "MarkdownDocumentation": "`DomainUnitId`\n\nThe ID of the domain unit.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9_\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createenvironmentprofilepolicygrantdetail.html#cfn-datazone-policygrant-createenvironmentprofilepolicygrantdetail-domainunitid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::PolicyGrant.CreateFormTypePolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.CreateFormTypePolicyGrantDetail`\n\nThe details of the policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createformtypepolicygrantdetail.html", "Properties": { "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether the policy grant is applied to child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createformtypepolicygrantdetail.html#cfn-datazone-policygrant-createformtypepolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.CreateGlossaryPolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.CreateGlossaryPolicyGrantDetail`\n\nThe details of the policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createglossarypolicygrantdetail.html", "Properties": { "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether the policy grant is applied to child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createglossarypolicygrantdetail.html#cfn-datazone-policygrant-createglossarypolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.CreateProjectFromProjectProfilePolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.CreateProjectFromProjectProfilePolicyGrantDetail`\n\nSpecifies whether to create a project from project profile policy grant details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html", "Properties": { "ProjectProfiles": { "MarkdownDocumentation": "`ProjectProfiles`\n\nSpecifies project profiles when creating a project from project profile policy grant\ndetails\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-projectprofiles", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether to include child domain units when creating a project from project\nprofile policy grant details\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.CreateProjectPolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.CreateProjectPolicyGrantDetail`\n\nThe details of the policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectpolicygrantdetail.html", "Properties": { "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether the policy grant is applied to child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectpolicygrantdetail.html#cfn-datazone-policygrant-createprojectpolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.DomainUnitFilterForProject": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.DomainUnitFilterForProject`\n\nThe domain unit filter of the project grant filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitfilterforproject.html", "Properties": { "DomainUnit": { "MarkdownDocumentation": "`DomainUnit`\n\nThe domain unit ID to use in the filter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9_\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitfilterforproject.html#cfn-datazone-policygrant-domainunitfilterforproject-domainunit", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether to include child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitfilterforproject.html#cfn-datazone-policygrant-domainunitfilterforproject-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.DomainUnitGrantFilter": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.DomainUnitGrantFilter`\n\nThe grant filter for the domain unit. In the current release of Amazon DataZone, the\nonly supported filter is the `allDomainUnitsGrantFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitgrantfilter.html", "Properties": { "AllDomainUnitsGrantFilter": { "MarkdownDocumentation": "`AllDomainUnitsGrantFilter`\n\nSpecifies a grant filter containing all domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitgrantfilter.html#cfn-datazone-policygrant-domainunitgrantfilter-alldomainunitsgrantfilter", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::DataZone::PolicyGrant.DomainUnitPolicyGrantPrincipal": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.DomainUnitPolicyGrantPrincipal`\n\nThe domain unit principal to whom the policy is granted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html", "Properties": { "DomainUnitGrantFilter": { "MarkdownDocumentation": "`DomainUnitGrantFilter`\n\nThe grant filter for the domain unit.\n*Required*: No\n*Type*: [DomainUnitGrantFilter](./aws-properties-datazone-policygrant-domainunitgrantfilter.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitgrantfilter", "UpdateType": "Immutable", "Required": false, "Type": "DomainUnitGrantFilter" }, "DomainUnitDesignation": { "MarkdownDocumentation": "`DomainUnitDesignation`\n\nSpecifes the designation of the domain unit users.\n*Required*: No\n*Type*: String\n*Allowed values*: `OWNER`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "OWNER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitdesignation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DomainUnitIdentifier": { "MarkdownDocumentation": "`DomainUnitIdentifier`\n\nThe ID of the domain unit.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9_\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::PolicyGrant.GroupPolicyGrantPrincipal": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.GroupPolicyGrantPrincipal`\n\nThe group principal to whom the policy is granted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-grouppolicygrantprincipal.html", "Properties": { "GroupIdentifier": { "MarkdownDocumentation": "`GroupIdentifier`\n\nThe ID Of the group of the group principal.\n*Required*: Yes\n*Type*: String\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}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-grouppolicygrantprincipal.html#cfn-datazone-policygrant-grouppolicygrantprincipal-groupidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::PolicyGrant.OverrideDomainUnitOwnersPolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.OverrideDomainUnitOwnersPolicyGrantDetail`\n\nThe grant details of the override domain unit owners policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overridedomainunitownerspolicygrantdetail.html", "Properties": { "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether the policy is inherited by child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overridedomainunitownerspolicygrantdetail.html#cfn-datazone-policygrant-overridedomainunitownerspolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.OverrideProjectOwnersPolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.OverrideProjectOwnersPolicyGrantDetail`\n\nThe details of the override project owners policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overrideprojectownerspolicygrantdetail.html", "Properties": { "IncludeChildDomainUnits": { "MarkdownDocumentation": "`IncludeChildDomainUnits`\n\nSpecifies whether the policy is inherited by child domain units.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overrideprojectownerspolicygrantdetail.html#cfn-datazone-policygrant-overrideprojectownerspolicygrantdetail-includechilddomainunits", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::DataZone::PolicyGrant.PolicyGrantDetail": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.PolicyGrantDetail`\n\nThe details of the policy grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html", "Properties": { "CreateEnvironmentFromBlueprint": { "MarkdownDocumentation": "`CreateEnvironmentFromBlueprint`\n\nThe details of the policy of creating an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironmentfromblueprint", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "CreateGlossary": { "MarkdownDocumentation": "`CreateGlossary`\n\nSpecifies that this is a create glossary policy.\n*Required*: No\n*Type*: [CreateGlossaryPolicyGrantDetail](./aws-properties-datazone-policygrant-createglossarypolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createglossary", "UpdateType": "Immutable", "Required": false, "Type": "CreateGlossaryPolicyGrantDetail" }, "CreateAssetType": { "MarkdownDocumentation": "`CreateAssetType`\n\nSpecifies that this is a create asset type policy.\n*Required*: No\n*Type*: [CreateAssetTypePolicyGrantDetail](./aws-properties-datazone-policygrant-createassettypepolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createassettype", "UpdateType": "Immutable", "Required": false, "Type": "CreateAssetTypePolicyGrantDetail" }, "CreateDomainUnit": { "MarkdownDocumentation": "`CreateDomainUnit`\n\nSpecifies that this is a create domain unit policy.\n*Required*: No\n*Type*: [CreateDomainUnitPolicyGrantDetail](./aws-properties-datazone-policygrant-createdomainunitpolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createdomainunit", "UpdateType": "Immutable", "Required": false, "Type": "CreateDomainUnitPolicyGrantDetail" }, "CreateProject": { "MarkdownDocumentation": "`CreateProject`\n\nSpecifies that this is a create project policy.\n*Required*: No\n*Type*: [CreateProjectPolicyGrantDetail](./aws-properties-datazone-policygrant-createprojectpolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createproject", "UpdateType": "Immutable", "Required": false, "Type": "CreateProjectPolicyGrantDetail" }, "OverrideProjectOwners": { "MarkdownDocumentation": "`OverrideProjectOwners`\n\nSpecifies whether to override project owners.\n*Required*: No\n*Type*: [OverrideProjectOwnersPolicyGrantDetail](./aws-properties-datazone-policygrant-overrideprojectownerspolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-overrideprojectowners", "UpdateType": "Immutable", "Required": false, "Type": "OverrideProjectOwnersPolicyGrantDetail" }, "AddToProjectMemberPool": { "MarkdownDocumentation": "`AddToProjectMemberPool`\n\nSpecifies that the policy grant is to be added to the members of the project.\n*Required*: No\n*Type*: [AddToProjectMemberPoolPolicyGrantDetail](./aws-properties-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-addtoprojectmemberpool", "UpdateType": "Immutable", "Required": false, "Type": "AddToProjectMemberPoolPolicyGrantDetail" }, "DelegateCreateEnvironmentProfile": { "MarkdownDocumentation": "`DelegateCreateEnvironmentProfile`\n\nSpecifies that this is the delegation of the create environment profile policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-delegatecreateenvironmentprofile", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "CreateProjectFromProjectProfile": { "MarkdownDocumentation": "`CreateProjectFromProjectProfile`\n\nSpecifies whether to create a project from project profile.\n*Required*: No\n*Type*: [CreateProjectFromProjectProfilePolicyGrantDetail](./aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createprojectfromprojectprofile", "UpdateType": "Immutable", "Required": false, "Type": "CreateProjectFromProjectProfilePolicyGrantDetail" }, "CreateEnvironment": { "MarkdownDocumentation": "`CreateEnvironment`\n\nSpecifies that this is a create environment policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironment", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "CreateEnvironmentProfile": { "MarkdownDocumentation": "`CreateEnvironmentProfile`\n\nSpecifies that this is a create environment profile policy.\n*Required*: No\n*Type*: [CreateEnvironmentProfilePolicyGrantDetail](./aws-properties-datazone-policygrant-createenvironmentprofilepolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironmentprofile", "UpdateType": "Immutable", "Required": false, "Type": "CreateEnvironmentProfilePolicyGrantDetail" }, "CreateFormType": { "MarkdownDocumentation": "`CreateFormType`\n\nSpecifies that this is a create form type policy.\n*Required*: No\n*Type*: [CreateFormTypePolicyGrantDetail](./aws-properties-datazone-policygrant-createformtypepolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createformtype", "UpdateType": "Immutable", "Required": false, "Type": "CreateFormTypePolicyGrantDetail" }, "OverrideDomainUnitOwners": { "MarkdownDocumentation": "`OverrideDomainUnitOwners`\n\nSpecifies whether to override domain unit owners.\n*Required*: No\n*Type*: [OverrideDomainUnitOwnersPolicyGrantDetail](./aws-properties-datazone-policygrant-overridedomainunitownerspolicygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-overridedomainunitowners", "UpdateType": "Immutable", "Required": false, "Type": "OverrideDomainUnitOwnersPolicyGrantDetail" } } }, "AWS::DataZone::PolicyGrant.PolicyGrantPrincipal": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.PolicyGrantPrincipal`\n\nThe policy grant principal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html", "Properties": { "Group": { "MarkdownDocumentation": "`Group`\n\nThe group of the policy grant principal.\n*Required*: No\n*Type*: [GroupPolicyGrantPrincipal](./aws-properties-datazone-policygrant-grouppolicygrantprincipal.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-group", "UpdateType": "Immutable", "Required": false, "Type": "GroupPolicyGrantPrincipal" }, "Project": { "MarkdownDocumentation": "`Project`\n\nThe project of the policy grant principal.\n*Required*: No\n*Type*: [ProjectPolicyGrantPrincipal](./aws-properties-datazone-policygrant-projectpolicygrantprincipal.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-project", "UpdateType": "Immutable", "Required": false, "Type": "ProjectPolicyGrantPrincipal" }, "User": { "MarkdownDocumentation": "`User`\n\nThe user of the policy grant principal.\n*Required*: No\n*Type*: [UserPolicyGrantPrincipal](./aws-properties-datazone-policygrant-userpolicygrantprincipal.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-user", "UpdateType": "Immutable", "Required": false, "Type": "UserPolicyGrantPrincipal" }, "DomainUnit": { "MarkdownDocumentation": "`DomainUnit`\n\nThe domain unit of the policy grant principal.\n*Required*: No\n*Type*: [DomainUnitPolicyGrantPrincipal](./aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-domainunit", "UpdateType": "Immutable", "Required": false, "Type": "DomainUnitPolicyGrantPrincipal" } } }, "AWS::DataZone::PolicyGrant.ProjectGrantFilter": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.ProjectGrantFilter`\n\nThe project grant filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectgrantfilter.html", "Properties": { "DomainUnitFilter": { "MarkdownDocumentation": "`DomainUnitFilter`\n\nThe domain unit filter of the project grant filter.\n*Required*: Yes\n*Type*: [DomainUnitFilterForProject](./aws-properties-datazone-policygrant-domainunitfilterforproject.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectgrantfilter.html#cfn-datazone-policygrant-projectgrantfilter-domainunitfilter", "UpdateType": "Immutable", "Required": true, "Type": "DomainUnitFilterForProject" } } }, "AWS::DataZone::PolicyGrant.ProjectPolicyGrantPrincipal": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.ProjectPolicyGrantPrincipal`\n\nThe project policy grant principal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html", "Properties": { "ProjectIdentifier": { "MarkdownDocumentation": "`ProjectIdentifier`\n\nThe project ID of the project policy grant principal.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ProjectDesignation": { "MarkdownDocumentation": "`ProjectDesignation`\n\nThe project designation of the project policy grant principal.\n*Required*: No\n*Type*: String\n*Allowed values*: `OWNER | CONTRIBUTOR | PROJE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "OWNER", "CONTRIBUTOR", "PROJECT_CATALOG_STEWARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectdesignation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ProjectGrantFilter": { "MarkdownDocumentation": "`ProjectGrantFilter`\n\nThe project grant filter of the project policy grant principal.\n*Required*: No\n*Type*: [ProjectGrantFilter](./aws-properties-datazone-policygrant-projectgrantfilter.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectgrantfilter", "UpdateType": "Immutable", "Required": false, "Type": "ProjectGrantFilter" } } }, "AWS::DataZone::PolicyGrant.UserPolicyGrantPrincipal": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant.UserPolicyGrantPrincipal`\n\nThe user policy grant principal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-userpolicygrantprincipal.html", "Properties": { "AllUsersGrantFilter": { "MarkdownDocumentation": "`AllUsersGrantFilter`\n\nThe all users grant filter of the user policy grant principal.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-userpolicygrantprincipal.html#cfn-datazone-policygrant-userpolicygrantprincipal-allusersgrantfilter", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "UserIdentifier": { "MarkdownDocumentation": "`UserIdentifier`\n\nThe user ID of the user policy grant principal.\n*Required*: No\n*Type*: String\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}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws[^:]*:iam::\\d{12}:.+$)`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-userpolicygrantprincipal.html#cfn-datazone-policygrant-userpolicygrantprincipal-useridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Project.EnvironmentConfigurationUserParameter": { "MarkdownDocumentation": "`AWS::DataZone::Project.EnvironmentConfigurationUserParameter`\n\nThe environment configuration user parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentconfigurationuserparameter.html", "Properties": { "EnvironmentId": { "MarkdownDocumentation": "`EnvironmentId`\n\nThe ID of the environment.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentconfigurationuserparameter.html#cfn-datazone-project-environmentconfigurationuserparameter-environmentid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentParameters": { "MarkdownDocumentation": "`EnvironmentParameters`\n\nThe environment parameters.\n*Required*: No\n*Type*: Array of [EnvironmentParameter](./aws-properties-datazone-project-environmentparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentconfigurationuserparameter.html#cfn-datazone-project-environmentconfigurationuserparameter-environmentparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentParameter", "DuplicatesAllowed": true }, "EnvironmentConfigurationName": { "MarkdownDocumentation": "`EnvironmentConfigurationName`\n\nThe environment configuration name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w -]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentconfigurationuserparameter.html#cfn-datazone-project-environmentconfigurationuserparameter-environmentconfigurationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::Project.EnvironmentParameter": { "MarkdownDocumentation": "`AWS::DataZone::Project.EnvironmentParameter`\n\nThe parameter details of an evironment profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of an environment profile parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentparameter.html#cfn-datazone-project-environmentparameter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of an environment profile parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentparameter.html#cfn-datazone-project-environmentparameter-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::ProjectMembership.Member": { "MarkdownDocumentation": "`AWS::DataZone::ProjectMembership.Member`\n\nThe details about a project member.\nImportant - this data type is a UNION, so only one of the following members can be\nspecified when used or returned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectmembership-member.html", "Properties": { "UserIdentifier": { "MarkdownDocumentation": "`UserIdentifier`\n\nThe user ID of a project member.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectmembership-member.html#cfn-datazone-projectmembership-member-useridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GroupIdentifier": { "MarkdownDocumentation": "`GroupIdentifier`\n\nThe ID of the group of a project member.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectmembership-member.html#cfn-datazone-projectmembership-member-groupidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::ProjectProfile.AwsAccount": { "MarkdownDocumentation": "`AWS::DataZone::ProjectProfile.AwsAccount`\n\nThe AWS account of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-awsaccount.html", "Properties": { "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe account ID of a project.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-awsaccount.html#cfn-datazone-projectprofile-awsaccount-awsaccountid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::ProjectProfile.EnvironmentConfiguration": { "MarkdownDocumentation": "`AWS::DataZone::ProjectProfile.EnvironmentConfiguration`\n\nThe configuration of an environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe environment description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentConfigurationId": { "MarkdownDocumentation": "`EnvironmentConfigurationId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-environmentconfigurationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AwsRegion": { "MarkdownDocumentation": "`AwsRegion`\n\nThe AWS Region of the environment.\n*Required*: Yes\n*Type*: [Region](./aws-properties-datazone-projectprofile-region.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-awsregion", "UpdateType": "Mutable", "Required": true, "Type": "Region" }, "AwsAccount": { "MarkdownDocumentation": "`AwsAccount`\n\nThe AWS account of the environment.\n*Required*: No\n*Type*: [AwsAccount](./aws-properties-datazone-projectprofile-awsaccount.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-awsaccount", "UpdateType": "Mutable", "Required": false, "Type": "AwsAccount" }, "DeploymentMode": { "MarkdownDocumentation": "`DeploymentMode`\n\nThe deployment mode of the environment.\n*Required*: No\n*Type*: String\n*Allowed values*: `ON_CREATE | ON_DEMAND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ON_CREATE", "ON_DEMAND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-deploymentmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentBlueprintId": { "MarkdownDocumentation": "`EnvironmentBlueprintId`\n\nThe environment blueprint ID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-environmentblueprintid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConfigurationParameters": { "MarkdownDocumentation": "`ConfigurationParameters`\n\nThe configuration parameters of the environment.\n*Required*: No\n*Type*: [EnvironmentConfigurationParametersDetails](./aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-configurationparameters", "UpdateType": "Mutable", "Required": false, "Type": "EnvironmentConfigurationParametersDetails" }, "DeploymentOrder": { "MarkdownDocumentation": "`DeploymentOrder`\n\nThe deployment order of the environment.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-deploymentorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe environment name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w -]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::ProjectProfile.EnvironmentConfigurationParameter": { "MarkdownDocumentation": "`AWS::DataZone::ProjectProfile.EnvironmentConfigurationParameter`\n\nThe environment configuration parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html", "Properties": { "IsEditable": { "MarkdownDocumentation": "`IsEditable`\n\nSpecifies whether the environment parameter is editable.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-iseditable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the environment configuration parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the environment configuration parameter.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::ProjectProfile.EnvironmentConfigurationParametersDetails": { "MarkdownDocumentation": "`AWS::DataZone::ProjectProfile.EnvironmentConfigurationParametersDetails`\n\nThe details of the environment configuration parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html", "Properties": { "ParameterOverrides": { "MarkdownDocumentation": "`ParameterOverrides`\n\nThe parameter overrides.\n*Required*: No\n*Type*: Array of [EnvironmentConfigurationParameter](./aws-properties-datazone-projectprofile-environmentconfigurationparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-parameteroverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentConfigurationParameter", "DuplicatesAllowed": true }, "ResolvedParameters": { "MarkdownDocumentation": "`ResolvedParameters`\n\nThe resolved environment configuration parameters.\n*Required*: No\n*Type*: Array of [EnvironmentConfigurationParameter](./aws-properties-datazone-projectprofile-environmentconfigurationparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-resolvedparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentConfigurationParameter", "DuplicatesAllowed": true }, "SsmPath": { "MarkdownDocumentation": "`SsmPath`\n\nSsm path environment configuration parameters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-ssmpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::ProjectProfile.Region": { "MarkdownDocumentation": "`AWS::DataZone::ProjectProfile.Region`\n\nThe AWS Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-region.html", "Properties": { "RegionName": { "MarkdownDocumentation": "`RegionName`\n\nThe AWS Region name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$`\n*Minimum*: `4`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-region.html#cfn-datazone-projectprofile-region-regionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::SubscriptionTarget.SubscriptionTargetForm": { "MarkdownDocumentation": "`AWS::DataZone::SubscriptionTarget.SubscriptionTargetForm`\n\nThe details of the subscription target configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-subscriptiontarget-subscriptiontargetform.html", "Properties": { "Content": { "MarkdownDocumentation": "`Content`\n\nThe content of the subscription target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-subscriptiontarget-subscriptiontargetform.html#cfn-datazone-subscriptiontarget-subscriptiontargetform-content", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FormName": { "MarkdownDocumentation": "`FormName`\n\nThe form name included in the subscription target configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-subscriptiontarget-subscriptiontargetform.html#cfn-datazone-subscriptiontarget-subscriptiontargetform-formname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataZone::UserProfile.IamUserProfileDetails": { "MarkdownDocumentation": "`AWS::DataZone::UserProfile.IamUserProfileDetails`\n\nThe `IamUserProfileDetails` property type specifies Property description not available. for an [AWS::DataZone::UserProfile](./aws-resource-datazone-userprofile.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-iamuserprofiledetails.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-iamuserprofiledetails.html#cfn-datazone-userprofile-iamuserprofiledetails-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::UserProfile.SsoUserProfileDetails": { "MarkdownDocumentation": "`AWS::DataZone::UserProfile.SsoUserProfileDetails`\n\nThe `SsoUserProfileDetails` property type specifies Property description not available. for an [AWS::DataZone::UserProfile](./aws-resource-datazone-userprofile.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-ssouserprofiledetails.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9+=,.@-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-ssouserprofiledetails.html#cfn-datazone-userprofile-ssouserprofiledetails-username", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FirstName": { "MarkdownDocumentation": "`FirstName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-ssouserprofiledetails.html#cfn-datazone-userprofile-ssouserprofiledetails-firstname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastName": { "MarkdownDocumentation": "`LastName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-ssouserprofiledetails.html#cfn-datazone-userprofile-ssouserprofiledetails-lastname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DataZone::UserProfile.UserProfileDetails": { "MarkdownDocumentation": "`AWS::DataZone::UserProfile.UserProfileDetails`\n\nThe `UserProfileDetails` property type specifies Property description not available. for an [AWS::DataZone::UserProfile](./aws-resource-datazone-userprofile.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-userprofiledetails.html", "Properties": { "Iam": { "MarkdownDocumentation": "`Iam`\n\nProperty description not available.\n*Required*: No\n*Type*: [IamUserProfileDetails](./aws-properties-datazone-userprofile-iamuserprofiledetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-userprofiledetails.html#cfn-datazone-userprofile-userprofiledetails-iam", "UpdateType": "Mutable", "Required": false, "Type": "IamUserProfileDetails" }, "Sso": { "MarkdownDocumentation": "`Sso`\n\nProperty description not available.\n*Required*: No\n*Type*: [SsoUserProfileDetails](./aws-properties-datazone-userprofile-ssouserprofiledetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-userprofiledetails.html#cfn-datazone-userprofile-userprofiledetails-sso", "UpdateType": "Mutable", "Required": false, "Type": "SsoUserProfileDetails" } } }, "AWS::Deadline::Fleet.AcceleratorCapabilities": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.AcceleratorCapabilities`\n\nProvides information about the GPU accelerators used for jobs processed by a\nfleet.\n###### Important\nAccelerator capabilities cannot be used with wait-and-save fleets. If you specify accelerator capabilities, you must use either spot or on-demand instance market options.\n###### Note\nEach accelerator type maps to specific EC2 instance families:\n* `t4`: Uses G4dn instance family\n* `a10g`: Uses G5 instance family\n* `l4`: Uses G6 and Gr6 instance families\n* `l40s`: Uses G6e instance family\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcapabilities.html", "Properties": { "Selections": { "MarkdownDocumentation": "`Selections`\n\nA list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances\nthat provide these capabilities will be used. For example, if you specify both L4 and T4\nchips, AWS Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip\ninstalled.\n###### Important\n* You must specify at least one accelerator selection.\n* You cannot specify the same accelerator name multiple times in the selections list.\n* All accelerators in the selections must use the same runtime version.\n*Required*: Yes\n*Type*: Array of [AcceleratorSelection](./aws-properties-deadline-fleet-acceleratorselection.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcapabilities.html#cfn-deadline-fleet-acceleratorcapabilities-selections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AcceleratorSelection", "DuplicatesAllowed": true }, "Count": { "MarkdownDocumentation": "`Count`\n\nThe number of GPU accelerators specified for worker hosts in this fleet.\n###### Important\nYou must specify either `acceleratorCapabilities.count.max` or `allowedInstanceTypes` when using accelerator capabilities. If you don't specify a maximum count, AWS Deadline Cloud uses the instance types you specify in `allowedInstanceTypes` to determine the maximum number of accelerators.\n*Required*: No\n*Type*: [AcceleratorCountRange](./aws-properties-deadline-fleet-acceleratorcountrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcapabilities.html#cfn-deadline-fleet-acceleratorcapabilities-count", "UpdateType": "Mutable", "Required": false, "Type": "AcceleratorCountRange" } } }, "AWS::Deadline::Fleet.AcceleratorCountRange": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.AcceleratorCountRange`\n\nDefines the maximum and minimum number of GPU accelerators required for a worker\ninstance..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcountrange.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of GPU accelerators in the worker host.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcountrange.html#cfn-deadline-fleet-acceleratorcountrange-min", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of GPU accelerators in the worker host.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcountrange.html#cfn-deadline-fleet-acceleratorcountrange-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Deadline::Fleet.AcceleratorSelection": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.AcceleratorSelection`\n\nDescribes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorselection.html", "Properties": { "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nSpecifies the runtime driver to use for the GPU accelerator. You must use the same\nruntime for all GPUs in a fleet.\nYou can choose from the following runtimes:\n* `latest` - Use the latest runtime available for the chip. If you\n specify `latest` and a new version of the runtime is released, the new\n version of the runtime is used.\n* `grid:r570` - [NVIDIA vGPU software 18](https://docs.nvidia.com/vgpu/18.0/index.html)\n* `grid:r535` - [NVIDIA vGPU software 16](https://docs.nvidia.com/vgpu/16.0/index.html)\nIf you don't specify a runtime, AWS Deadline Cloud uses `latest` as the default. However,\nif you have multiple accelerators and specify `latest` for some and leave others\nblank, AWS Deadline Cloud raises an exception.\n###### Important\nNot all runtimes are compatible with all accelerator types:\n* `t4` and `a10g`: Support all runtimes (`grid:r570`, `grid:r535`)\n* `l4` and `l40s`: Only support `grid:r570` and newer\nAll accelerators in a fleet must use the same runtime version. You cannot mix different runtime versions within a single fleet.\n\n###### Note\nWhen you specify `latest`, it resolves to `grid:r570` for all currently supported accelerators.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorselection.html#cfn-deadline-fleet-acceleratorselection-runtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the chip used by the GPU accelerator.\nThe available GPU accelerators are:\n* `t4` - NVIDIA T4 Tensor Core GPU (16 GiB memory)\n* `a10g` - NVIDIA A10G Tensor Core GPU (24 GiB memory)\n* `l4` - NVIDIA L4 Tensor Core GPU (24 GiB memory)\n* `l40s` - NVIDIA L40S Tensor Core GPU (48 GiB memory)\n*Required*: Yes\n*Type*: String\n*Allowed values*: `t4 | a10g | l4 | l40s...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "t4", "a10g", "l4", "l40s" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorselection.html#cfn-deadline-fleet-acceleratorselection-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::Fleet.AcceleratorTotalMemoryMiBRange": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.AcceleratorTotalMemoryMiBRange`\n\nDefines the maximum and minimum amount of memory, in MiB, to use for the\naccelerator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory to use for the accelerator, measured in MiB.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html#cfn-deadline-fleet-acceleratortotalmemorymibrange-min", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory to use for the accelerator, measured in MiB.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html#cfn-deadline-fleet-acceleratortotalmemorymibrange-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Deadline::Fleet.CustomerManagedFleetConfiguration": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.CustomerManagedFleetConfiguration`\n\nThe configuration details for a customer managed fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html", "Properties": { "StorageProfileId": { "MarkdownDocumentation": "`StorageProfileId`\n\nThe storage profile ID for the customer managed fleet.\n*Required*: No\n*Type*: String\n*Pattern*: `^sp-[0-9a-f]{32}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-storageprofileid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe Auto Scaling mode for the customer managed fleet.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NO_SCALING | EVENT_BASED_AU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NO_SCALING", "EVENT_BASED_AUTO_SCALING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "WorkerCapabilities": { "MarkdownDocumentation": "`WorkerCapabilities`\n\nThe worker capabilities for the customer managed fleet.\n*Required*: Yes\n*Type*: [CustomerManagedWorkerCapabilities](./aws-properties-deadline-fleet-customermanagedworkercapabilities.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-workercapabilities", "UpdateType": "Mutable", "Required": true, "Type": "CustomerManagedWorkerCapabilities" }, "TagPropagationMode": { "MarkdownDocumentation": "`TagPropagationMode`\n\nThe tag propagation mode for the customer managed fleet.\n*Required*: No\n*Type*: String\n*Allowed values*: `NO_PROPAGATION | PROPAGATE_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NO_PROPAGATION", "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-tagpropagationmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Deadline::Fleet.CustomerManagedWorkerCapabilities": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.CustomerManagedWorkerCapabilities`\n\nThe worker capabilities for a customer managed workflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html", "Properties": { "CustomAttributes": { "MarkdownDocumentation": "`CustomAttributes`\n\nCustom attributes for the customer manged worker capabilities.\n*Required*: No\n*Type*: Array of [FleetAttributeCapability](./aws-properties-deadline-fleet-fleetattributecapability.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-customattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FleetAttributeCapability", "DuplicatesAllowed": true }, "AcceleratorCount": { "MarkdownDocumentation": "`AcceleratorCount`\n\nThe range of the accelerator.\n*Required*: No\n*Type*: [AcceleratorCountRange](./aws-properties-deadline-fleet-acceleratorcountrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratorcount", "UpdateType": "Mutable", "Required": false, "Type": "AcceleratorCountRange" }, "CustomAmounts": { "MarkdownDocumentation": "`CustomAmounts`\n\nCustom requirement ranges for customer managed worker capabilities.\n*Required*: No\n*Type*: Array of [FleetAmountCapability](./aws-properties-deadline-fleet-fleetamountcapability.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-customamounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FleetAmountCapability", "DuplicatesAllowed": true }, "AcceleratorTypes": { "MarkdownDocumentation": "`AcceleratorTypes`\n\nThe accelerator types for the customer managed worker capabilities.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratortypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AcceleratorTotalMemoryMiB": { "MarkdownDocumentation": "`AcceleratorTotalMemoryMiB`\n\nThe total memory (MiB) for the customer managed worker capabilities.\n*Required*: No\n*Type*: [AcceleratorTotalMemoryMiBRange](./aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratortotalmemorymib", "UpdateType": "Mutable", "Required": false, "Type": "AcceleratorTotalMemoryMiBRange" }, "VCpuCount": { "MarkdownDocumentation": "`VCpuCount`\n\nThe vCPU count for the customer manged worker capabilities.\n*Required*: Yes\n*Type*: [VCpuCountRange](./aws-properties-deadline-fleet-vcpucountrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-vcpucount", "UpdateType": "Mutable", "Required": true, "Type": "VCpuCountRange" }, "MemoryMiB": { "MarkdownDocumentation": "`MemoryMiB`\n\nThe memory (MiB).\n*Required*: Yes\n*Type*: [MemoryMiBRange](./aws-properties-deadline-fleet-memorymibrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-memorymib", "UpdateType": "Mutable", "Required": true, "Type": "MemoryMiBRange" }, "OsFamily": { "MarkdownDocumentation": "`OsFamily`\n\nThe operating system (OS) family.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WINDOWS | LINUX | MACOS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS", "LINUX", "MACOS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-osfamily", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CpuArchitectureType": { "MarkdownDocumentation": "`CpuArchitectureType`\n\nThe CPU architecture type for the customer managed worker capabilities.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `x86_64 | arm64...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "x86_64", "arm64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-cpuarchitecturetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::Fleet.Ec2EbsVolume": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.Ec2EbsVolume`\n\nSpecifies the EBS volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html", "Properties": { "SizeGiB": { "MarkdownDocumentation": "`SizeGiB`\n\nThe EBS volume size in GiB.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-sizegib", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ThroughputMiB": { "MarkdownDocumentation": "`ThroughputMiB`\n\nThe throughput per volume in MiB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `125`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-throughputmib", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe IOPS per volume.\n*Required*: No\n*Type*: Integer\n*Minimum*: `3000`\n*Maximum*: `16000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-iops", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Deadline::Fleet.FleetAmountCapability": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.FleetAmountCapability`\n\nThe fleet amount and attribute capabilities.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of fleet worker capability.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-min", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of the fleet worker capability.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the fleet capability.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z][a-zA-Z0-9]{0,63}:)?amount(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::Fleet.FleetAttributeCapability": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.FleetAttributeCapability`\n\nDefines the fleet's capability name, minimum, and maximum.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetattributecapability.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe number of fleet attribute capabilities.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetattributecapability.html#cfn-deadline-fleet-fleetattributecapability-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the fleet attribute capability for the worker.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z][a-zA-Z0-9]{0,63}:)?attr(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetattributecapability.html#cfn-deadline-fleet-fleetattributecapability-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::Fleet.FleetCapabilities": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.FleetCapabilities`\n\nThe amounts and attributes of fleets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetcapabilities.html", "Properties": { "Amounts": { "MarkdownDocumentation": "`Amounts`\n\nAmount capabilities of the fleet.\n*Required*: No\n*Type*: Array of [FleetAmountCapability](./aws-properties-deadline-fleet-fleetamountcapability.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetcapabilities.html#cfn-deadline-fleet-fleetcapabilities-amounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FleetAmountCapability", "DuplicatesAllowed": true }, "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nAttribute capabilities of the fleet.\n*Required*: No\n*Type*: Array of [FleetAttributeCapability](./aws-properties-deadline-fleet-fleetattributecapability.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetcapabilities.html#cfn-deadline-fleet-fleetcapabilities-attributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FleetAttributeCapability", "DuplicatesAllowed": true } } }, "AWS::Deadline::Fleet.FleetConfiguration": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.FleetConfiguration`\n\nFleet configuration details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetconfiguration.html", "Properties": { "ServiceManagedEc2": { "MarkdownDocumentation": "`ServiceManagedEc2`\n\nThe service managed Amazon EC2 instances for a fleet configuration.\n*Required*: No\n*Type*: [ServiceManagedEc2FleetConfiguration](./aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetconfiguration.html#cfn-deadline-fleet-fleetconfiguration-servicemanagedec2", "UpdateType": "Mutable", "Required": false, "Type": "ServiceManagedEc2FleetConfiguration" }, "CustomerManaged": { "MarkdownDocumentation": "`CustomerManaged`\n\nThe customer managed fleets within a fleet configuration.\n*Required*: No\n*Type*: [CustomerManagedFleetConfiguration](./aws-properties-deadline-fleet-customermanagedfleetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetconfiguration.html#cfn-deadline-fleet-fleetconfiguration-customermanaged", "UpdateType": "Mutable", "Required": false, "Type": "CustomerManagedFleetConfiguration" } } }, "AWS::Deadline::Fleet.HostConfiguration": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.HostConfiguration`\n\nProvides a script that runs as a worker is starting up that you can use to provide\nadditional configuration for workers in your fleet.\nTo remove a script from a fleet, use the [UpdateFleet](https://docs.aws.amazon.com/deadline-cloud/latest/APIReference/API_UpdateFleet.html)\noperation with the `hostConfiguration``scriptBody` parameter set to an empty string (\"\").\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-hostconfiguration.html", "Properties": { "ScriptTimeoutSeconds": { "MarkdownDocumentation": "`ScriptTimeoutSeconds`\n\nThe maximum time that the host configuration can run. If the timeout expires, the worker\nenters the `NOT RESPONDING` state and shuts down. You are charged for the time\nthat the worker is running the host configuration script.\n###### Note\nYou should configure your fleet for a maximum of one worker while testing your host\nconfiguration script to avoid starting additional workers.\nThe default is 300 seconds (5 minutes).\n*Required*: No\n*Type*: Integer\n*Minimum*: `300`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-hostconfiguration.html#cfn-deadline-fleet-hostconfiguration-scripttimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ScriptBody": { "MarkdownDocumentation": "`ScriptBody`\n\nThe text of the script that runs as a worker is starting up that you can use to provide\nadditional configuration for workers in your fleet. The script runs after a worker enters\nthe `STARTING` state and before the worker processes tasks.\nFor more information about using the script, see [Run scripts as an\nadministrator to configure workers](https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/smf-admin.html) in the *Deadline Cloud Developer\nGuide*.\n###### Important\nThe script runs as an administrative user (`sudo root` on Linux, as an\nAdministrator on Windows).\n*Required*: Yes\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `15000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-hostconfiguration.html#cfn-deadline-fleet-hostconfiguration-scriptbody", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::Fleet.MemoryMiBRange": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.MemoryMiBRange`\n\nThe range of memory in MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-memorymibrange.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory (in MiB).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `512`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-memorymibrange.html#cfn-deadline-fleet-memorymibrange-min", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory (in MiB).\n*Required*: No\n*Type*: Integer\n*Minimum*: `512`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-memorymibrange.html#cfn-deadline-fleet-memorymibrange-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Deadline::Fleet.ServiceManagedEc2FleetConfiguration": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.ServiceManagedEc2FleetConfiguration`\n\nThe configuration details for a service managed EC2 fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html", "Properties": { "StorageProfileId": { "MarkdownDocumentation": "`StorageProfileId`\n\nThe storage profile ID for the service managed EC2 fleet.\n*Required*: No\n*Type*: String\n*Pattern*: `^sp-[0-9a-f]{32}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html#cfn-deadline-fleet-servicemanagedec2fleetconfiguration-storageprofileid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceMarketOptions": { "MarkdownDocumentation": "`InstanceMarketOptions`\n\nThe instance market options for the service managed EC2 fleet.\n*Required*: Yes\n*Type*: [ServiceManagedEc2InstanceMarketOptions](./aws-properties-deadline-fleet-servicemanagedec2instancemarketoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html#cfn-deadline-fleet-servicemanagedec2fleetconfiguration-instancemarketoptions", "UpdateType": "Mutable", "Required": true, "Type": "ServiceManagedEc2InstanceMarketOptions" }, "InstanceCapabilities": { "MarkdownDocumentation": "`InstanceCapabilities`\n\nThe instance capabilities for the service managed EC2 fleet.\n*Required*: Yes\n*Type*: [ServiceManagedEc2InstanceCapabilities](./aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html#cfn-deadline-fleet-servicemanagedec2fleetconfiguration-instancecapabilities", "UpdateType": "Mutable", "Required": true, "Type": "ServiceManagedEc2InstanceCapabilities" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nThe VPC configuration for the service managed EC2 fleet.\n*Required*: No\n*Type*: [VpcConfiguration](./aws-properties-deadline-fleet-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html#cfn-deadline-fleet-servicemanagedec2fleetconfiguration-vpcconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfiguration" } } }, "AWS::Deadline::Fleet.ServiceManagedEc2InstanceCapabilities": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.ServiceManagedEc2InstanceCapabilities`\n\nThe Amazon EC2 instance capabilities.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html", "Properties": { "AllowedInstanceTypes": { "MarkdownDocumentation": "`AllowedInstanceTypes`\n\nThe allowable Amazon EC2 instance types.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-allowedinstancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CustomAttributes": { "MarkdownDocumentation": "`CustomAttributes`\n\nThe custom capability attributes to require for instances in this fleet.\n*Required*: No\n*Type*: Array of [FleetAttributeCapability](./aws-properties-deadline-fleet-fleetattributecapability.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-customattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FleetAttributeCapability", "DuplicatesAllowed": true }, "AcceleratorCapabilities": { "MarkdownDocumentation": "`AcceleratorCapabilities`\n\nDescribes the GPU accelerator capabilities required for worker host instances in this\nfleet.\n*Required*: No\n*Type*: [AcceleratorCapabilities](./aws-properties-deadline-fleet-acceleratorcapabilities.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-acceleratorcapabilities", "UpdateType": "Mutable", "Required": false, "Type": "AcceleratorCapabilities" }, "CustomAmounts": { "MarkdownDocumentation": "`CustomAmounts`\n\nThe custom capability amounts to require for instances in this fleet.\n*Required*: No\n*Type*: Array of [FleetAmountCapability](./aws-properties-deadline-fleet-fleetamountcapability.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-customamounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FleetAmountCapability", "DuplicatesAllowed": true }, "VCpuCount": { "MarkdownDocumentation": "`VCpuCount`\n\nThe amount of vCPU to require for instances in this fleet.\n*Required*: Yes\n*Type*: [VCpuCountRange](./aws-properties-deadline-fleet-vcpucountrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-vcpucount", "UpdateType": "Mutable", "Required": true, "Type": "VCpuCountRange" }, "ExcludedInstanceTypes": { "MarkdownDocumentation": "`ExcludedInstanceTypes`\n\nThe instance types to exclude from the fleet.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-excludedinstancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MemoryMiB": { "MarkdownDocumentation": "`MemoryMiB`\n\nThe memory, as MiB, for the Amazon EC2 instance type.\n*Required*: Yes\n*Type*: [MemoryMiBRange](./aws-properties-deadline-fleet-memorymibrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-memorymib", "UpdateType": "Mutable", "Required": true, "Type": "MemoryMiBRange" }, "OsFamily": { "MarkdownDocumentation": "`OsFamily`\n\nThe operating system (OS) family.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LINUX | WINDOWS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINUX", "WINDOWS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-osfamily", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CpuArchitectureType": { "MarkdownDocumentation": "`CpuArchitectureType`\n\nThe CPU architecture type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `x86_64 | arm64...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "x86_64", "arm64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-cpuarchitecturetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RootEbsVolume": { "MarkdownDocumentation": "`RootEbsVolume`\n\nThe root EBS volume.\n*Required*: No\n*Type*: [Ec2EbsVolume](./aws-properties-deadline-fleet-ec2ebsvolume.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-rootebsvolume", "UpdateType": "Mutable", "Required": false, "Type": "Ec2EbsVolume" } } }, "AWS::Deadline::Fleet.ServiceManagedEc2InstanceMarketOptions": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.ServiceManagedEc2InstanceMarketOptions`\n\nThe details of the Amazon EC2 instance market options for a service managed fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancemarketoptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe Amazon EC2 instance type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `on-demand | spot | wait-and...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "on-demand", "spot", "wait-and-save" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancemarketoptions.html#cfn-deadline-fleet-servicemanagedec2instancemarketoptions-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::Fleet.VCpuCountRange": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.VCpuCountRange`\n\nThe allowable range of vCPU processing power for the fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vcpucountrange.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of vCPU.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vcpucountrange.html#cfn-deadline-fleet-vcpucountrange-min", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of vCPU.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vcpucountrange.html#cfn-deadline-fleet-vcpucountrange-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Deadline::Fleet.VpcConfiguration": { "MarkdownDocumentation": "`AWS::Deadline::Fleet.VpcConfiguration`\n\nThe configuration options for a service managed fleet's VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vpcconfiguration.html", "Properties": { "ResourceConfigurationArns": { "MarkdownDocumentation": "`ResourceConfigurationArns`\n\nThe ARNs of the VPC Lattice resource configurations attached to the fleet.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vpcconfiguration.html#cfn-deadline-fleet-vpcconfiguration-resourceconfigurationarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Deadline::Queue.JobAttachmentSettings": { "MarkdownDocumentation": "`AWS::Deadline::Queue.JobAttachmentSettings`\n\nThe job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobattachmentsettings.html", "Properties": { "RootPrefix": { "MarkdownDocumentation": "`RootPrefix`\n\nThe root prefix.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobattachmentsettings.html#cfn-deadline-queue-jobattachmentsettings-rootprefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nThe Amazon S3 bucket name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobattachmentsettings.html#cfn-deadline-queue-jobattachmentsettings-s3bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::Queue.JobRunAsUser": { "MarkdownDocumentation": "`AWS::Deadline::Queue.JobRunAsUser`\n\nIdentifies the user for a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobrunasuser.html", "Properties": { "RunAs": { "MarkdownDocumentation": "`RunAs`\n\nSpecifies whether the job should run using the queue's system user or if the job should\nrun using the worker agent system user.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `QUEUE_CONFIGURED_USER | WOR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "QUEUE_CONFIGURED_USER", "WORKER_AGENT_USER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobrunasuser.html#cfn-deadline-queue-jobrunasuser-runas", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Posix": { "MarkdownDocumentation": "`Posix`\n\nThe user and group that the jobs in the queue run as.\n*Required*: No\n*Type*: [PosixUser](./aws-properties-deadline-queue-posixuser.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobrunasuser.html#cfn-deadline-queue-jobrunasuser-posix", "UpdateType": "Mutable", "Required": false, "Type": "PosixUser" }, "Windows": { "MarkdownDocumentation": "`Windows`\n\nIdentifies a Microsoft Windows user.\n*Required*: No\n*Type*: [WindowsUser](./aws-properties-deadline-queue-windowsuser.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobrunasuser.html#cfn-deadline-queue-jobrunasuser-windows", "UpdateType": "Mutable", "Required": false, "Type": "WindowsUser" } } }, "AWS::Deadline::Queue.PosixUser": { "MarkdownDocumentation": "`AWS::Deadline::Queue.PosixUser`\n\nThe POSIX user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-posixuser.html", "Properties": { "Group": { "MarkdownDocumentation": "`Group`\n\nThe name of the POSIX user's group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?:[a-z][a-z0-9-]{0,30})?$`\n*Minimum*: `0`\n*Maximum*: `31`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-posixuser.html#cfn-deadline-queue-posixuser-group", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "User": { "MarkdownDocumentation": "`User`\n\nThe name of the POSIX user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?:[a-z][a-z0-9-]{0,30})?$`\n*Minimum*: `0`\n*Maximum*: `31`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-posixuser.html#cfn-deadline-queue-posixuser-user", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::Queue.WindowsUser": { "MarkdownDocumentation": "`AWS::Deadline::Queue.WindowsUser`\n\nThe Windows user details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-windowsuser.html", "Properties": { "User": { "MarkdownDocumentation": "`User`\n\nThe user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\"'/\\[\\]:;|=,+*?<>\\s]*$`\n*Minimum*: `0`\n*Maximum*: `111`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-windowsuser.html#cfn-deadline-queue-windowsuser-user", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PasswordArn": { "MarkdownDocumentation": "`PasswordArn`\n\nThe password ARN for the Windows user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*):secretsmanager:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:secret:[a-zA-Z0-9-/_+=.@]{1,2028}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-windowsuser.html#cfn-deadline-queue-windowsuser-passwordarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::StorageProfile.FileSystemLocation": { "MarkdownDocumentation": "`AWS::Deadline::StorageProfile.FileSystemLocation`\n\nThe details of the file system location for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-storageprofile-filesystemlocation.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe file path.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-storageprofile-filesystemlocation.html#cfn-deadline-storageprofile-filesystemlocation-path", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of file.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SHARED | LOCAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SHARED", "LOCAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-storageprofile-filesystemlocation.html#cfn-deadline-storageprofile-filesystemlocation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe location name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z ]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-storageprofile-filesystemlocation.html#cfn-deadline-storageprofile-filesystemlocation-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DevOpsGuru::NotificationChannel.NotificationChannelConfig": { "MarkdownDocumentation": "`AWS::DevOpsGuru::NotificationChannel.NotificationChannelConfig`\n\nInformation about notification channels you have configured with DevOps Guru.\nThe one\nsupported notification channel is Amazon Simple Notification Service (Amazon SNS).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationchannelconfig.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe filter configurations for the Amazon SNS notification topic you use with DevOps Guru.\nIf 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationchannelconfig.html#cfn-devopsguru-notificationchannel-notificationchannelconfig-filters", "UpdateType": "Immutable", "Required": false, "Type": "NotificationFilterConfig" }, "Sns": { "MarkdownDocumentation": "`Sns`\n\nInformation about a notification channel configured in DevOps Guru to send notifications\nwhen 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\nto send 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.\nFor more information, see [Permissions\nfor Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html).\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\nto the CMK. For more information, see [Permissions for\nAWS KMS\u2013encrypted Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).\n*Required*: No\n*Type*: [SnsChannelConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationchannelconfig.html#cfn-devopsguru-notificationchannel-notificationchannelconfig-sns", "UpdateType": "Immutable", "Required": false, "Type": "SnsChannelConfig" } } }, "AWS::DevOpsGuru::NotificationChannel.NotificationFilterConfig": { "MarkdownDocumentation": "`AWS::DevOpsGuru::NotificationChannel.NotificationFilterConfig`\n\nThe filter configurations for the Amazon SNS notification topic you use with DevOps Guru. You can choose to specify which events or message types to receive notifications for.\nYou can also choose to specify which severity levels to receive notifications for.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.html", "Properties": { "MessageTypes": { "MarkdownDocumentation": "`MessageTypes`\n\nThe 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*: Array of String\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.html#cfn-devopsguru-notificationchannel-notificationfilterconfig-messagetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Severities": { "MarkdownDocumentation": "`Severities`\n\nThe 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.\nFor 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*: Array of String\n*Minimum*: `1`\n*Maximum*: `3`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.html#cfn-devopsguru-notificationchannel-notificationfilterconfig-severities", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::DevOpsGuru::NotificationChannel.SnsChannelConfig": { "MarkdownDocumentation": "`AWS::DevOpsGuru::NotificationChannel.SnsChannelConfig`\n\nContains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.\nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission\nto send 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.\nFor more information, see [Permissions\nfor Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html).\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\nto the CMK. For more information, see [Permissions for\nAWS KMS\u2013encrypted Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-snschannelconfig.html", "Properties": { "TopicArn": { "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$`\n*Minimum*: `36`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-snschannelconfig.html#cfn-devopsguru-notificationchannel-snschannelconfig-topicarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DevOpsGuru::ResourceCollection.CloudFormationCollectionFilter": { "MarkdownDocumentation": "`AWS::DevOpsGuru::ResourceCollection.CloudFormationCollectionFilter`\n\nInformation about AWS CloudFormation stacks. You can use up to 1000\nstacks to specify which AWS resources in your account to analyze. For more\ninformation, see [Stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the\n*AWS CloudFormation User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-cloudformationcollectionfilter.html", "Properties": { "StackNames": { "MarkdownDocumentation": "`StackNames`\n\nAn array of CloudFormation stack names.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `128 | 1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-cloudformationcollectionfilter.html#cfn-devopsguru-resourcecollection-cloudformationcollectionfilter-stacknames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::DevOpsGuru::ResourceCollection.ResourceCollectionFilter": { "MarkdownDocumentation": "`AWS::DevOpsGuru::ResourceCollection.ResourceCollectionFilter`\n\nInformation about a filter used to specify which AWS resources are analyzed for\nanomalous behavior by DevOps Guru.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-resourcecollectionfilter.html", "Properties": { "CloudFormation": { "MarkdownDocumentation": "`CloudFormation`\n\nInformation about AWS CloudFormation stacks. You can use up to 1000\nstacks to specify which AWS resources in your account to analyze. For more\ninformation, see [Stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the\n*AWS CloudFormation User Guide*.\n*Required*: No\n*Type*: [CloudFormationCollectionFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-resourcecollectionfilter.html#cfn-devopsguru-resourcecollection-resourcecollectionfilter-cloudformation", "UpdateType": "Mutable", "Required": false, "Type": "CloudFormationCollectionFilter" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe AWS tags used to filter the resources in the resource collection.\nTags help you identify and organize your AWS resources. Many AWS services support\ntagging, so you can assign the same tag to resources from different services to indicate\nthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\ntable resource that you assign to an AWS Lambda function. For more information about\nusing tags, see the [Tagging\nbest 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`,\n `Environment`, `Project`, or `Secret`). Tag\n *keys* are case-sensitive.\n* A field known as a tag *value* (for example,\n `111122223333`, `Production`, or a team\n name). Omitting the tag *value* is the same as using an empty\n string. Like tag *keys*, tag *values* are\n case-sensitive. The tag value is a required property when AppBoundaryKey is specified.\nTogether these are known as *key*-*value* pairs.\n###### Important\nThe string used for a *key* in a tag that you use to define your resource coverage must begin with the\nprefix `Devops-guru-`. The tag *key* might be\n`DevOps-Guru-deployment-application` or\n`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.\nFor example, DevOps Guru works with a\n*key* named `devops-guru-rds` and a *key* named\n`DevOps-Guru-RDS`, and these act as two different *keys*. Possible *key*/*value* pairs in your\napplication might be `Devops-Guru-production-application/RDS` or\n`Devops-Guru-production-application/containers`.\n*Required*: No\n*Type*: Array of [TagCollection](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-resourcecollectionfilter.html#cfn-devopsguru-resourcecollection-resourcecollectionfilter-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagCollection", "DuplicatesAllowed": true } } }, "AWS::DevOpsGuru::ResourceCollection.TagCollection": { "MarkdownDocumentation": "`AWS::DevOpsGuru::ResourceCollection.TagCollection`\n\nA collection of AWS tags.\nTags help you identify and organize your AWS resources. Many AWS services support\ntagging, so you can assign the same tag to resources from different services to indicate\nthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\ntable resource that you assign to an AWS Lambda function. For more information about\nusing tags, see the [Tagging\nbest 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`,\n `Environment`, `Project`, or `Secret`). Tag\n *keys* are case-sensitive.\n* A field known as a tag *value* (for example,\n `111122223333`, `Production`, or a team\n name). Omitting the tag *value* is the same as using an empty\n string. Like tag *keys*, tag *values* are\n case-sensitive. The tag value is a required property when *AppBoundaryKey* is specified.\nTogether these are known as *key*-*value* pairs.\n###### Important\nThe string used for a *key* in a tag that you use to define your resource coverage must begin with the\nprefix `Devops-guru-`. The tag *key* might be\n`DevOps-Guru-deployment-application` or\n`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.\nFor example, DevOps Guru works with a\n*key* named `devops-guru-rds` and a *key* named\n`DevOps-Guru-RDS`, and these act as two different *keys*. Possible *key*/*value* pairs in your\napplication might be `Devops-Guru-production-application/RDS` or\n`Devops-Guru-production-application/containers`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html", "Properties": { "AppBoundaryKey": { "MarkdownDocumentation": "`AppBoundaryKey`\n\nAn AWS tag *key* that is used to identify the AWS resources that\nDevOps Guru analyzes. All AWS resources in your account and Region tagged with this *key* make\nup your DevOps Guru application and analysis boundary.\n###### Important\nWhen 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.\nFor example, DevOps Guru works with a\n*key* named `devops-guru-rds` and a *key* named\n`DevOps-Guru-RDS`, and these act as two different *keys*. Possible *key*/*value* pairs in your\napplication might be `Devops-Guru-production-application/RDS` or\n`Devops-Guru-production-application/containers`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html#cfn-devopsguru-resourcecollection-tagcollection-appboundarykey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagValues": { "MarkdownDocumentation": "`TagValues`\n\nThe values in an AWS tag collection.\nThe tag's *value* is a field used to associate a string with\nthe tag *key* (for example, `111122223333`, `Production`, or a team\nname). The *key* and *value* are the tag's *key* pair.\nOmitting the tag *value* is the same as using an empty\nstring. Like tag *keys*, tag *values* are\ncase-sensitive. You can specify a maximum of 256 characters for a tag value. The tag value is a required property when *AppBoundaryKey* is specified.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `256 | 1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html#cfn-devopsguru-resourcecollection-tagcollection-tagvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::DirectoryService::MicrosoftAD.VpcSettings": { "MarkdownDocumentation": "`AWS::DirectoryService::MicrosoftAD.VpcSettings`\n\nContains VPC information for the [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) or\n[CreateMicrosoftAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html)\noperation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html", "Properties": { "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe identifiers of the subnets for the directory servers. The two subnets must be in\ndifferent Availability Zones. Directory Service specifies a directory server and a DNS\nserver in each of these subnets.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html#cfn-directoryservice-microsoftad-vpcsettings-subnetids", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html#cfn-directoryservice-microsoftad-vpcsettings-vpcid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::DirectoryService::SimpleAD.VpcSettings": { "MarkdownDocumentation": "`AWS::DirectoryService::SimpleAD.VpcSettings`\n\nContains VPC information for the [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) or\n[CreateMicrosoftAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html)\noperation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html", "Properties": { "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe identifiers of the subnets for the directory servers. The two subnets must be in\ndifferent Availability Zones. Directory Service specifies a directory server and a DNS\nserver in each of these subnets.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html#cfn-directoryservice-simplead-vpcsettings-subnetids", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html#cfn-directoryservice-simplead-vpcsettings-vpcid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::DocDB::DBCluster.ServerlessV2ScalingConfiguration": { "MarkdownDocumentation": "`AWS::DocDB::DBCluster.ServerlessV2ScalingConfiguration`\n\nSets the scaling configuration of an Amazon DocumentDB Serverless cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration.html", "Properties": { "MinCapacity": { "Required": true, "MarkdownDocumentation": "`MinCapacity`\n\nThe minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.\nYou can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration-mincapacity", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "MaxCapacity": { "Required": true, "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.\nYou can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration-maxcapacity", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::DynamoDB::GlobalTable.AttributeDefinition": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.AttributeDefinition`\n\nRepresents an attribute for describing the schema for the table and indexes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html", "Properties": { "AttributeType": { "MarkdownDocumentation": "`AttributeType`\n\nThe 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*: `S | N | B`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "S", "N", "B" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html#cfn-dynamodb-globaltable-attributedefinition-attributetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html#cfn-dynamodb-globaltable-attributedefinition-attributename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DynamoDB::GlobalTable.CapacityAutoScalingSettings": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.CapacityAutoScalingSettings`\n\nConfigures a scalable target and an autoscaling policy for a table or global secondary\nindex's read or write capacity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html", "Properties": { "MinCapacity": { "MarkdownDocumentation": "`MinCapacity`\n\nThe minimum provisioned capacity units for the global table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-mincapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "SeedCapacity": { "MarkdownDocumentation": "`SeedCapacity`\n\nWhen switching billing mode from `PAY_PER_REQUEST` to\n`PROVISIONED`, DynamoDB requires you to specify read and write capacity unit\nvalues for the table and for each global secondary index. These values will be applied to\nall replicas. The table will use these provisioned values until CloudFormation creates the\nautoscaling policies you configured in your template. CloudFormation cannot determine what\ncapacity the table and its global secondary indexes will require in this time period, since\nthey are application-dependent.\nIf you want to switch a table's billing mode from `PAY_PER_REQUEST` to\n`PROVISIONED`, you must specify a value for this property for each autoscaled\nresource. If you specify different values for the same resource in different regions,\nCloudFormation will use the highest value found in either the `SeedCapacity` or\n`ReadCapacityUnits` properties. For example, if your global secondary index\n`myGSI` has a `SeedCapacity` of 10 in us-east-1 and a fixed\n`ReadCapacityUnits` of 20 in eu-west-1, CloudFormation will initially set the\nread capacity for `myGSI` to 20. Note that if you disable `ScaleIn`\nfor `myGSI` in us-east-1, its read capacity units might not be set back to\n10.\nYou must also specify a value for `SeedCapacity` when you plan to switch a\ntable's billing mode from `PROVISIONED` to `PAY_PER_REQUEST`, because\nCloudFormation might need to roll back the operation (reverting the billing mode to\n`PROVISIONED`) and this cannot succeed without specifying a value for\n`SeedCapacity`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-seedcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetTrackingScalingPolicyConfiguration": { "MarkdownDocumentation": "`TargetTrackingScalingPolicyConfiguration`\n\nDefines a target tracking scaling policy.\n*Required*: Yes\n*Type*: [TargetTrackingScalingPolicyConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-targettrackingscalingpolicyconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "TargetTrackingScalingPolicyConfiguration" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum provisioned capacity units for the global table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-maxcapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::GlobalTable.ContributorInsightsSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.ContributorInsightsSpecification`\n\nConfigures contributor insights settings for a replica or one of its indexes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nSpecifies the CloudWatch Contributor Insights mode for a global table. Valid values are\n`ACCESSED_AND_THROTTLED_KEYS` (tracks all access and throttled events) or\n`THROTTLED_KEYS` (tracks only throttled events). This setting determines what\ntype of contributor insights data is collected for the global table.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCESSED_AND_THROTTLED_KEYS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACCESSED_AND_THROTTLED_KEYS", "THROTTLED_KEYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html#cfn-dynamodb-globaltable-contributorinsightsspecification-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled\n(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html#cfn-dynamodb-globaltable-contributorinsightsspecification-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::DynamoDB::GlobalTable.GlobalSecondaryIndex": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.GlobalSecondaryIndex`\n\nAllows you to specify a global secondary index for the global table. The index will be\ndefined on all replicas.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the global secondary index. The name must be unique among all other indexes\non this table.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-indexname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Projection": { "MarkdownDocumentation": "`Projection`\n\nRepresents attributes that are copied (projected) from the table into the global\nsecondary index. These are in addition to the primary key attributes and index key\nattributes, which are automatically projected.\n*Required*: Yes\n*Type*: [Projection](./aws-properties-dynamodb-globaltable-projection.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-projection", "UpdateType": "Mutable", "Required": true, "Type": "Projection" }, "KeySchema": { "MarkdownDocumentation": "`KeySchema`\n\nThe complete key schema for a global secondary index, which consists of one or more\npairs of attribute names and key types:\n* `HASH` - partition key\n* `RANGE` - sort key\n###### Note\nThe partition key of an item is also known as its *hash\nattribute*. The term \"hash attribute\" derives from DynamoDB's usage of an\ninternal hash function to evenly distribute data items across partitions, based on their\npartition key values.\nThe sort key of an item is also known as its *range attribute*.\nThe term \"range attribute\" derives from the way DynamoDB stores items with the same\npartition key physically close together, in sorted order by the sort key value.\n*Required*: Yes\n*Type*: [Array](./aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](./aws-properties-dynamodb-globaltable-keyschema.html)\n*Minimum*: `1`\n*Maximum*: `8`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-keyschema", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "KeySchema", "DuplicatesAllowed": false }, "WarmThroughput": { "MarkdownDocumentation": "`WarmThroughput`\n\nRepresents the warm throughput value (in read units per second and write units per\nsecond) for the specified secondary index. If you use this parameter, you must specify\n`ReadUnitsPerSecond`, `WriteUnitsPerSecond`, or both.\n*Required*: No\n*Type*: [WarmThroughput](./aws-properties-dynamodb-globaltable-warmthroughput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-warmthroughput", "UpdateType": "Mutable", "Required": false, "Type": "WarmThroughput" }, "WriteProvisionedThroughputSettings": { "MarkdownDocumentation": "`WriteProvisionedThroughputSettings`\n\nDefines write capacity settings for the global secondary index. You must specify a value\nfor this property if the table's `BillingMode` is `PROVISIONED`. All\nreplicas will have the same write capacity settings for this global secondary index.\n*Required*: No\n*Type*: [WriteProvisionedThroughputSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-writeprovisionedthroughputsettings", "UpdateType": "Mutable", "Required": false, "Type": "WriteProvisionedThroughputSettings" }, "WriteOnDemandThroughputSettings": { "MarkdownDocumentation": "`WriteOnDemandThroughputSettings`\n\nSets the write request settings for a global table or a global secondary index. You can\nonly specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.\n*Required*: No\n*Type*: [WriteOnDemandThroughputSettings](./aws-properties-dynamodb-globaltable-writeondemandthroughputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-globalsecondaryindex-writeondemandthroughputsettings", "UpdateType": "Mutable", "Required": false, "Type": "WriteOnDemandThroughputSettings" } } }, "AWS::DynamoDB::GlobalTable.GlobalTableWitness": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.GlobalTableWitness`\n\nThe witness Region for the MRSC global table. A MRSC global table can be configured with\neither three replicas, or with two replicas and one witness.\nThe witness must be in a different Region than the replicas and within the same Region\nset:\n* US Region set: US East (N. Virginia), US East (Ohio), US West (Oregon)\n* EU Region set: Europe (Ireland), Europe (London), Europe (Paris), Europe\n (Frankfurt)\n* AP Region set: Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific\n (Osaka)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globaltablewitness.html", "Properties": { "Region": { "MarkdownDocumentation": "`Region`\n\nThe name of the AWSRegion that serves as a witness for the MRSC global\ntable.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globaltablewitness.html#cfn-dynamodb-globaltable-globaltablewitness-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DynamoDB::GlobalTable.KeySchema": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.KeySchema`\n\nRepresents *a single element* of a key schema. A key schema\nspecifies the attributes that make up the primary key of a table, or the key attributes\nof an index.\nA `KeySchemaElement` represents exactly one attribute of the primary key.\nFor example, a simple primary key would be represented by one\n`KeySchemaElement` (for the partition key). A composite primary key would\nrequire one `KeySchemaElement` for the partition key, and another\n`KeySchemaElement` for the sort key.\nA `KeySchemaElement` must be a scalar, top-level attribute (not a nested\nattribute). The data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html", "Properties": { "KeyType": { "MarkdownDocumentation": "`KeyType`\n\nThe role that this key attribute will assume:\n* `HASH` - partition key\n* `RANGE` - sort key\n###### Note\nThe partition key of an item is also known as its *hash\nattribute*. The term \"hash attribute\" derives from DynamoDB's usage of an\ninternal hash function to evenly distribute data items across partitions, based on their\npartition key values.\nThe sort key of an item is also known as its *range attribute*.\nThe term \"range attribute\" derives from the way DynamoDB stores items with the same\npartition 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)", "RefReturnValue": "", "AllowedValues": [ "HASH", "RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html#cfn-dynamodb-globaltable-keyschema-keytype", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html#cfn-dynamodb-globaltable-keyschema-attributename", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" } } }, "AWS::DynamoDB::GlobalTable.KinesisStreamSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.KinesisStreamSpecification`\n\nThe Kinesis Data Streams configuration for the specified global table replica.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html", "Properties": { "ApproximateCreationDateTimePrecision": { "MarkdownDocumentation": "`ApproximateCreationDateTimePrecision`\n\nThe precision for the time and date that the stream was created.\n*Required*: No\n*Type*: String\n*Allowed values*: `MICROSECOND | MILLISECOND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MICROSECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html#cfn-dynamodb-globaltable-kinesisstreamspecification-approximatecreationdatetimeprecision", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StreamArn": { "MarkdownDocumentation": "`StreamArn`\n\nThe ARN for a specific Kinesis data stream.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html#cfn-dynamodb-globaltable-kinesisstreamspecification-streamarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DynamoDB::GlobalTable.LocalSecondaryIndex": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.LocalSecondaryIndex`\n\nRepresents the properties of a local secondary index. A local secondary index can only\nbe created when its parent table is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the local secondary index. The name must be unique among all other indexes\non this table.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-indexname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Projection": { "MarkdownDocumentation": "`Projection`\n\nRepresents attributes that are copied (projected) from the table into the local\nsecondary index. These are in addition to the primary key attributes and index key\nattributes, which are automatically projected.\n*Required*: Yes\n*Type*: [Projection](./aws-properties-dynamodb-globaltable-projection.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-projection", "UpdateType": "Immutable", "Required": true, "Type": "Projection" }, "KeySchema": { "MarkdownDocumentation": "`KeySchema`\n\nThe complete key schema for the local secondary index, consisting of one or more pairs\nof attribute names and key types:\n* `HASH` - partition key\n* `RANGE` - sort key\n###### Note\nThe partition key of an item is also known as its *hash\nattribute*. The term \"hash attribute\" derives from DynamoDB's usage of\nan internal hash function to evenly distribute data items across partitions, based\non their partition key values.\nThe sort key of an item is also known as its *range attribute*.\nThe term \"range attribute\" derives from the way DynamoDB stores items with the same\npartition key physically close together, in sorted order by the sort key\nvalue.\n*Required*: Yes\n*Type*: [Array](./aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](./aws-properties-dynamodb-globaltable-keyschema.html)\n*Maximum*: `2`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-keyschema", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "KeySchema", "DuplicatesAllowed": false } } }, "AWS::DynamoDB::GlobalTable.PointInTimeRecoverySpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.PointInTimeRecoverySpecification`\n\nRepresents the settings used to enable point in time recovery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html", "Properties": { "PointInTimeRecoveryEnabled": { "MarkdownDocumentation": "`PointInTimeRecoveryEnabled`\n\nIndicates whether point in time recovery is enabled (true) or disabled (false) on the\ntable.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html#cfn-dynamodb-globaltable-pointintimerecoveryspecification-pointintimerecoveryenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RecoveryPeriodInDays": { "MarkdownDocumentation": "`RecoveryPeriodInDays`\n\nThe number of preceding days for which continuous backups are taken and maintained.\nYour table data is only recoverable to any point-in-time from within the configured\nrecovery period. This parameter is optional. If no value is provided, the value will\ndefault to 35.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `35`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html#cfn-dynamodb-globaltable-pointintimerecoveryspecification-recoveryperiodindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::GlobalTable.Projection": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.Projection`\n\nRepresents attributes that are copied (projected) from the table into an index. These\nare in addition to the primary key attributes and index key attributes, which are\nautomatically projected.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html", "Properties": { "ProjectionType": { "MarkdownDocumentation": "`ProjectionType`\n\nThe set of attributes that are projected into the index:\n* `KEYS_ONLY` - Only the index and primary keys are projected into the\n index.\n* `INCLUDE` - In addition to the attributes described in\n `KEYS_ONLY`, the secondary index will include other non-key\n attributes that you specify.\n* `ALL` - All of the table attributes are projected into the\n index.\nWhen using the DynamoDB console, `ALL` is selected by default.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL | KEYS_ONLY | INCLUDE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html#cfn-dynamodb-globaltable-projection-projectiontype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "NonKeyAttributes": { "MarkdownDocumentation": "`NonKeyAttributes`\n\nRepresents the non-key attribute names which will be projected into the index.\nFor global and local secondary indexes, the total count of\n`NonKeyAttributes` summed across all of the secondary indexes, must not\nexceed 100. If you project the same attribute into two different indexes, this counts as\ntwo distinct attributes when determining the total. This limit only applies when you\nspecify the ProjectionType of `INCLUDE`. You still can specify the\nProjectionType of `ALL` to project all attributes from the source table, even\nif the table has more than 100 attributes.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `20`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html#cfn-dynamodb-globaltable-projection-nonkeyattributes", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::DynamoDB::GlobalTable.ReadOnDemandThroughputSettings": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.ReadOnDemandThroughputSettings`\n\nSets the read request settings for a replica table or a replica global secondary index.\nYou can only specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readondemandthroughputsettings.html", "Properties": { "MaxReadRequestUnits": { "MarkdownDocumentation": "`MaxReadRequestUnits`\n\nMaximum number of read request units for the specified replica of a global table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readondemandthroughputsettings.html#cfn-dynamodb-globaltable-readondemandthroughputsettings-maxreadrequestunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::GlobalTable.ReadProvisionedThroughputSettings": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.ReadProvisionedThroughputSettings`\n\nAllows you to specify the read capacity settings for a replica table or a replica global\nsecondary index when the `BillingMode` is set to `PROVISIONED`. You\nmust specify a value for either `ReadCapacityUnits` or\n`ReadCapacityAutoScalingSettings`, but not both. You can switch between fixed\ncapacity and auto scaling.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html", "Properties": { "ReadCapacityUnits": { "MarkdownDocumentation": "`ReadCapacityUnits`\n\nSpecifies a fixed read capacity for the replica table or global secondary index.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ReadCapacityAutoScalingSettings": { "MarkdownDocumentation": "`ReadCapacityAutoScalingSettings`\n\nSpecifies auto scaling settings for the replica table or global secondary index.\n*Required*: No\n*Type*: [CapacityAutoScalingSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityautoscalingsettings", "UpdateType": "Mutable", "Required": false, "Type": "CapacityAutoScalingSettings" } } }, "AWS::DynamoDB::GlobalTable.ReplicaGlobalSecondaryIndexSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.ReplicaGlobalSecondaryIndexSpecification`\n\nRepresents the properties of a global secondary index that can be set on a per-replica\nbasis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the global secondary index. The name must be unique among all other indexes\non this table.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-indexname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContributorInsightsSpecification": { "MarkdownDocumentation": "`ContributorInsightsSpecification`\n\nUpdates the status for contributor insights for a specific table or index. CloudWatch\nContributor Insights for DynamoDB graphs display the partition key and (if applicable)\nsort key of frequently accessed items and frequently throttled items in plaintext. If\nyou require the use of AWS Key Management Service (KMS) to encrypt this\ntable\u2019s partition key and sort key data with an AWS managed key or\ncustomer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB\nfor this table.\n*Required*: No\n*Type*: [ContributorInsightsSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-contributorinsightsspecification", "UpdateType": "Mutable", "Required": false, "Type": "ContributorInsightsSpecification" }, "ReadProvisionedThroughputSettings": { "MarkdownDocumentation": "`ReadProvisionedThroughputSettings`\n\nAllows you to specify the read capacity settings for a replica global secondary index\nwhen the `BillingMode` is set to `PROVISIONED`.\n*Required*: No\n*Type*: [ReadProvisionedThroughputSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readprovisionedthroughputsettings", "UpdateType": "Mutable", "Required": false, "Type": "ReadProvisionedThroughputSettings" }, "ReadOnDemandThroughputSettings": { "MarkdownDocumentation": "`ReadOnDemandThroughputSettings`\n\nSets the read request settings for a replica global secondary index. You can only\nspecify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.\n*Required*: No\n*Type*: [ReadOnDemandThroughputSettings](./aws-properties-dynamodb-globaltable-readondemandthroughputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readondemandthroughputsettings", "UpdateType": "Mutable", "Required": false, "Type": "ReadOnDemandThroughputSettings" } } }, "AWS::DynamoDB::GlobalTable.ReplicaSSESpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.ReplicaSSESpecification`\n\nAllows you to specify a KMS key identifier to be used for server-side encryption. The\nkey can be specified via ARN, key ID, or alias. The key must be created in the same region\nas the replica.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicassespecification.html", "Properties": { "KMSMasterKeyId": { "MarkdownDocumentation": "`KMSMasterKeyId`\n\nThe AWS KMS key that should be used for the AWS KMS encryption.\nTo specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.\nNote that you should only provide this parameter if the key is different from the\ndefault DynamoDB key `alias/aws/dynamodb`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicassespecification.html#cfn-dynamodb-globaltable-replicassespecification-kmsmasterkeyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DynamoDB::GlobalTable.ReplicaSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.ReplicaSpecification`\n\nDefines settings specific to a single replica of a global table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html", "Properties": { "SSESpecification": { "MarkdownDocumentation": "`SSESpecification`\n\nAllows you to specify a customer-managed key for the replica. When using\ncustomer-managed keys for server-side encryption, this property must have a value in all\nreplicas.\n*Required*: No\n*Type*: [ReplicaSSESpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-ssespecification", "UpdateType": "Mutable", "Required": false, "Type": "ReplicaSSESpecification" }, "KinesisStreamSpecification": { "MarkdownDocumentation": "`KinesisStreamSpecification`\n\nDefines the Kinesis Data Streams configuration for the specified replica.\n*Required*: No\n*Type*: [KinesisStreamSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-kinesisstreamspecification", "UpdateType": "Mutable", "Required": false, "Type": "KinesisStreamSpecification" }, "ContributorInsightsSpecification": { "MarkdownDocumentation": "`ContributorInsightsSpecification`\n\nThe settings used to enable or disable CloudWatch Contributor Insights for the specified\nreplica. When not specified, defaults to contributor insights disabled for the\nreplica.\n*Required*: No\n*Type*: [ContributorInsightsSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-contributorinsightsspecification", "UpdateType": "Mutable", "Required": false, "Type": "ContributorInsightsSpecification" }, "PointInTimeRecoverySpecification": { "MarkdownDocumentation": "`PointInTimeRecoverySpecification`\n\nThe settings used to enable point in time recovery. When not specified, defaults to\npoint in time recovery disabled for the replica.\n*Required*: No\n*Type*: [PointInTimeRecoverySpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-pointintimerecoveryspecification", "UpdateType": "Mutable", "Required": false, "Type": "PointInTimeRecoverySpecification" }, "ReplicaStreamSpecification": { "MarkdownDocumentation": "`ReplicaStreamSpecification`\n\nRepresents the DynamoDB Streams configuration for a global table replica.\n*Required*: No\n*Type*: [ReplicaStreamSpecification](./aws-properties-dynamodb-globaltable-replicastreamspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-replicastreamspecification", "UpdateType": "Mutable", "Required": false, "Type": "ReplicaStreamSpecification" }, "GlobalSecondaryIndexes": { "MarkdownDocumentation": "`GlobalSecondaryIndexes`\n\nDefines additional settings for the global secondary indexes of this replica.\n*Required*: No\n*Type*: Array of [ReplicaGlobalSecondaryIndexSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-globalsecondaryindexes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReplicaGlobalSecondaryIndexSpecification", "DuplicatesAllowed": false }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nA resource-based policy document that contains permissions to add to the specified\nreplica of a DynamoDB global table. Resource-based policies let you define access\npermissions by specifying who has access to each resource, and the actions they are allowed\nto perform on each resource.\nIn a CloudFormation template, you can provide the policy in JSON or YAML format\nbecause CloudFormation converts YAML to JSON before submitting it to DynamoDB. For more information about resource-based policies, see [Using\nresource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy\nexamples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n*Required*: No\n*Type*: [ResourcePolicy](./aws-properties-dynamodb-globaltable-resourcepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-resourcepolicy", "UpdateType": "Mutable", "Required": false, "Type": "ResourcePolicy" }, "ReadProvisionedThroughputSettings": { "MarkdownDocumentation": "`ReadProvisionedThroughputSettings`\n\nDefines read capacity settings for the replica table.\n*Required*: No\n*Type*: [ReadProvisionedThroughputSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-readprovisionedthroughputsettings", "UpdateType": "Mutable", "Required": false, "Type": "ReadProvisionedThroughputSettings" }, "TableClass": { "MarkdownDocumentation": "`TableClass`\n\nThe table class of the specified table. Valid values are `STANDARD` and\n`STANDARD_INFREQUENT_ACCESS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | STANDARD_INFREQU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "STANDARD_INFREQUENT_ACCESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-tableclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeletionProtectionEnabled": { "MarkdownDocumentation": "`DeletionProtectionEnabled`\n\nDetermines if a replica is protected from deletion. When enabled, the table cannot be\ndeleted by any user or process. This setting is disabled by default. For more information,\nsee [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Amazon DynamoDBDeveloper 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-deletionprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-dynamodb-globaltable-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "ReadOnDemandThroughputSettings": { "MarkdownDocumentation": "`ReadOnDemandThroughputSettings`\n\nSets read request settings for the replica table.\n*Required*: No\n*Type*: [ReadOnDemandThroughputSettings](./aws-properties-dynamodb-globaltable-readondemandthroughputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-readondemandthroughputsettings", "UpdateType": "Mutable", "Required": false, "Type": "ReadOnDemandThroughputSettings" } } }, "AWS::DynamoDB::GlobalTable.ReplicaStreamSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.ReplicaStreamSpecification`\n\nRepresents the DynamoDB Streams configuration for a global table\nreplica.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicastreamspecification.html", "Properties": { "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nA resource-based policy document that contains the permissions for the specified stream\nof a DynamoDB global table replica. Resource-based policies let you define access\npermissions by specifying who has access to each resource, and the actions they are allowed\nto perform on each resource.\nIn a CloudFormation template, you can provide the policy in JSON or YAML format\nbecause CloudFormation converts YAML to JSON before submitting it to DynamoDB. For more information about resource-based policies, see [Using\nresource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy\nexamples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\nYou can update the `ResourcePolicy` property if you've specified more than\none table using the [AWS::DynamoDB::GlobalTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html) resource.\n*Required*: Yes\n*Type*: [ResourcePolicy](./aws-properties-dynamodb-globaltable-resourcepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicastreamspecification.html#cfn-dynamodb-globaltable-replicastreamspecification-resourcepolicy", "UpdateType": "Mutable", "Required": true, "Type": "ResourcePolicy" } } }, "AWS::DynamoDB::GlobalTable.ResourcePolicy": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.ResourcePolicy`\n\nCreates or updates a resource-based policy document that contains the permissions for\nDynamoDB resources, such as a table, its indexes, and stream. Resource-based\npolicies let you define access permissions by specifying who has access to each resource,\nand the actions they are allowed to perform on each resource.\nIn a CloudFormation template, you can provide the policy in JSON or YAML format\nbecause CloudFormation converts YAML to JSON before submitting it to DynamoDB. For more information about resource-based policies, see [Using\nresource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy\nexamples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\nWhile defining resource-based policies in your CloudFormation templates, the\nfollowing considerations apply:\n* The maximum size supported for a resource-based policy document in JSON format is\n 20 KB. DynamoDB counts whitespaces when calculating the size of a policy\n against this limit.\n* Resource-based policies don't support [drift\n detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CloudFormation\n stack template, you'll need to update the CloudFormation stack with the\n changes.\n* Resource-based policies don't support out-of-band changes. If you add, update, or\n delete a policy outside of the CloudFormation template, the change won't be\n overwritten if there are no changes to the policy within the template.\n \n For example, say that your template contains a resource-based policy, which you\n later update outside of the template. If you don't make any changes to the policy in\n the template, the updated policy in DynamoDB won\u2019t be synced with the\n policy in the template.\n \n Conversely, say that your template doesn\u2019t contain a resource-based policy, but\n you add a policy outside of the template. This policy won\u2019t be removed from DynamoDB as long as you don\u2019t add it to the template. When you add a policy to\n the template and update the stack, the existing policy in DynamoDB will be\n updated to match the one defined in the template.\n* Within a resource-based policy, if the action for a DynamoDB\n service-linked role (SLR) to replicate data for a global table is denied, adding or\n deleting a replica will fail with an error.\n* The [AWS::DynamoDB::GlobalTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html) resource doesn't support\n creating a replica in the same stack update in Regions other than the Region where\n you deploy the stack update.\nFor a full list of all considerations, see [Resource-based\npolicy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-resourcepolicy.html", "Properties": { "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA resource-based policy document that contains permissions to add to the specified\nDynamoDB table, its indexes, and stream. In a CloudFormation\ntemplate, you can provide the policy in JSON or YAML format because CloudFormation\nconverts YAML to JSON before submitting it to DynamoDB. For more information\nabout resource-based policies, see [Using\nresource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy\nexamples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-resourcepolicy.html#cfn-dynamodb-globaltable-resourcepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::DynamoDB::GlobalTable.SSESpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.SSESpecification`\n\nRepresents the settings used to enable server-side encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html", "Properties": { "SSEEnabled": { "MarkdownDocumentation": "`SSEEnabled`\n\nIndicates whether server-side encryption is performed using an AWS\nmanaged key or an AWS owned key. If enabled (true), server-side encryption\ntype is set to KMS and an AWS managed key is used (AWS KMS\ncharges apply). If disabled (false) or not specified,server-side encryption is set to an\nAWS owned key. If you choose to use KMS encryption, you can also use\ncustomer managed KMS keys by specifying them in the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html#cfn-dynamodb-globaltable-ssespecification-sseenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "SSEType": { "MarkdownDocumentation": "`SSEType`\n\nServer-side encryption type. The only supported value is:\n* `KMS` - Server-side encryption that uses AWS Key Management Service. The\n 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)", "RefReturnValue": "", "AllowedValues": [ "AES256", "KMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html#cfn-dynamodb-globaltable-ssespecification-ssetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DynamoDB::GlobalTable.StreamSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.StreamSpecification`\n\nRepresents the DynamoDB Streams configuration for a table in DynamoDB.\nYou can only modify this value for a `AWS::DynamoDB::GlobalTable` resource\nconfigured for multi-Region eventual consistency (MREC, the default) if that resource\ncontains only one entry in `Replicas`. You must specify a value for this\nproperty for a `AWS::DynamoDB::GlobalTable` resource configured for MREC with\nmore than one entry in `Replicas`. For Multi-Region Strong Consistency (MRSC),\nStreams are not required and can be changed for existing tables.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-streamspecification.html", "Properties": { "StreamViewType": { "MarkdownDocumentation": "`StreamViewType`\n\nWhen an item in the table is modified, `StreamViewType` determines what\ninformation is written to the stream for this table. Valid values for\n`StreamViewType` are:\n* `KEYS_ONLY` - Only the key attributes of the modified item are\n written to the stream.\n* `NEW_IMAGE` - The entire item, as it appears after it was modified,\n is written to the stream.\n* `OLD_IMAGE` - The entire item, as it appeared before it was modified,\n is written to the stream.\n* `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the\n item are written to the stream.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW_IMAGE | OLD_IMAGE | NEW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-streamspecification.html#cfn-dynamodb-globaltable-streamspecification-streamviewtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DynamoDB::GlobalTable.TargetTrackingScalingPolicyConfiguration": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.TargetTrackingScalingPolicyConfiguration`\n\nDefines a target tracking scaling policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html", "Properties": { "ScaleOutCooldown": { "MarkdownDocumentation": "`ScaleOutCooldown`\n\nThe amount of time, in seconds, after a scale-out activity completes before another\nscale-out activity can start.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleoutcooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nDefines a target value for the scaling policy.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisableScaleIn": { "MarkdownDocumentation": "`DisableScaleIn`\n\nIndicates whether scale in by the target tracking scaling policy is disabled. The\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-disablescalein", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ScaleInCooldown": { "MarkdownDocumentation": "`ScaleInCooldown`\n\nThe amount of time, in seconds, after a scale-in activity completes before another\nscale-in activity can start.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleincooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::GlobalTable.TimeToLiveSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.TimeToLiveSpecification`\n\nRepresents the settings used to enable or disable Time to Live (TTL) for the specified\ntable. All replicas will have the same time to live configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-timetolivespecification.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-timetolivespecification.html#cfn-dynamodb-globaltable-timetolivespecification-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nThe name of the attribute used to store the expiration time for items in the\ntable.\nCurrently, you cannot directly change the attribute name used to evaluate time to live.\nIn order to do so, you must first disable time to live, and then re-enable it with the new\nattribute name. It can take up to one hour for changes to time to live to take effect. If\nyou attempt to modify time to live within that time window, your stack operation might be\ndelayed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-timetolivespecification.html#cfn-dynamodb-globaltable-timetolivespecification-attributename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DynamoDB::GlobalTable.WarmThroughput": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.WarmThroughput`\n\nProvides visibility into the number of read and write operations your table or\nsecondary index can instantaneously support. The settings can be modified using the\n`UpdateTable` operation to meet the throughput requirements of an\nupcoming peak event.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-warmthroughput.html", "Properties": { "ReadUnitsPerSecond": { "MarkdownDocumentation": "`ReadUnitsPerSecond`\n\nRepresents the number of read operations your base table can instantaneously\nsupport.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-warmthroughput.html#cfn-dynamodb-globaltable-warmthroughput-readunitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "WriteUnitsPerSecond": { "MarkdownDocumentation": "`WriteUnitsPerSecond`\n\nRepresents the number of write operations your base table can instantaneously\nsupport.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-warmthroughput.html#cfn-dynamodb-globaltable-warmthroughput-writeunitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::GlobalTable.WriteOnDemandThroughputSettings": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.WriteOnDemandThroughputSettings`\n\nSets the write request settings for a global table or a global secondary index. You can\nonly specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeondemandthroughputsettings.html", "Properties": { "MaxWriteRequestUnits": { "MarkdownDocumentation": "`MaxWriteRequestUnits`\n\nMaximum number of write request settings for the specified replica of a global\ntable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeondemandthroughputsettings.html#cfn-dynamodb-globaltable-writeondemandthroughputsettings-maxwriterequestunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::GlobalTable.WriteProvisionedThroughputSettings": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable.WriteProvisionedThroughputSettings`\n\nSpecifies an auto scaling policy for write capacity. This policy will be applied to all\nreplicas. This setting must be specified if `BillingMode` is set to\n`PROVISIONED`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.html", "Properties": { "WriteCapacityAutoScalingSettings": { "MarkdownDocumentation": "`WriteCapacityAutoScalingSettings`\n\nSpecifies auto scaling settings for the replica table or global secondary index.\n*Required*: No\n*Type*: [CapacityAutoScalingSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings-writecapacityautoscalingsettings", "UpdateType": "Mutable", "Required": false, "Type": "CapacityAutoScalingSettings" } } }, "AWS::DynamoDB::Table.AttributeDefinition": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.AttributeDefinition`\n\nRepresents an attribute for describing the schema for the table and indexes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-attributedefinition.html", "Properties": { "AttributeType": { "MarkdownDocumentation": "`AttributeType`\n\nThe 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*: `S | N | B`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "S", "N", "B" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-attributedefinition.html#cfn-dynamodb-table-attributedefinition-attributetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-attributedefinition.html#cfn-dynamodb-table-attributedefinition-attributename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DynamoDB::Table.ContributorInsightsSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.ContributorInsightsSpecification`\n\nConfigures contributor insights settings for a table or one of its indexes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nSpecifies the CloudWatch Contributor Insights mode for a table. Valid values are\n`ACCESSED_AND_THROTTLED_KEYS` (tracks all access and throttled events) or\n`THROTTLED_KEYS` (tracks only throttled events). This setting determines what\ntype of contributor insights data is collected for the table.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCESSED_AND_THROTTLED_KEYS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACCESSED_AND_THROTTLED_KEYS", "THROTTLED_KEYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html#cfn-dynamodb-table-contributorinsightsspecification-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled\n(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html#cfn-dynamodb-table-contributorinsightsspecification-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::DynamoDB::Table.Csv": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.Csv`\n\nThe options for imported source files in CSV format. The values are Delimiter and\nHeaderList.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-csv.html", "Properties": { "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter used for separating items in the CSV file being imported.\n*Required*: No\n*Type*: String\n*Pattern*: `[,;:|\\t ]`\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-csv.html#cfn-dynamodb-table-csv-delimiter", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HeaderList": { "MarkdownDocumentation": "`HeaderList`\n\nList of the headers used to specify a common header for all source CSV files being\nimported. If this field is specified then the first line of each CSV file is treated as\ndata instead of the header. If this field is not specified the the first line of each\nCSV file is treated as the header.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-csv.html#cfn-dynamodb-table-csv-headerlist", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::DynamoDB::Table.GlobalSecondaryIndex": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.GlobalSecondaryIndex`\n\nRepresents the properties of a global secondary index.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the global secondary index. The name must be unique among all other\nindexes on this table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-indexname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OnDemandThroughput": { "MarkdownDocumentation": "`OnDemandThroughput`\n\nThe maximum number of read and write units for the specified global secondary index.\nIf you use this parameter, you must specify `MaxReadRequestUnits`,\n`MaxWriteRequestUnits`, or both. You must use either\n`OnDemandThroughput` or `ProvisionedThroughput` based on your\ntable's capacity mode.\n*Required*: No\n*Type*: [OnDemandThroughput](./aws-properties-dynamodb-table-ondemandthroughput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-ondemandthroughput", "UpdateType": "Mutable", "Required": false, "Type": "OnDemandThroughput" }, "ContributorInsightsSpecification": { "MarkdownDocumentation": "`ContributorInsightsSpecification`\n\nThe settings used to specify whether to enable CloudWatch Contributor Insights for the\nglobal table and define which events to monitor.\n*Required*: No\n*Type*: [ContributorInsightsSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-contributorinsightsspecification", "UpdateType": "Mutable", "Required": false, "Type": "ContributorInsightsSpecification" }, "Projection": { "MarkdownDocumentation": "`Projection`\n\nRepresents attributes that are copied (projected) from the table into the global\nsecondary index. These are in addition to the primary key attributes and index key\nattributes, which are automatically projected.\n*Required*: Yes\n*Type*: [Projection](./aws-properties-dynamodb-table-projection.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-projection", "UpdateType": "Mutable", "Required": true, "Type": "Projection" }, "ProvisionedThroughput": { "MarkdownDocumentation": "`ProvisionedThroughput`\n\nRepresents the provisioned throughput settings for the specified global secondary\nindex. You must use either `OnDemandThroughput` or\n`ProvisionedThroughput` based on your table's capacity mode.\nFor current minimum and maximum provisioned throughput values, see [Service,\nAccount, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer\nGuide*.\n*Required*: No\n*Type*: [ProvisionedThroughput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-provisionedthroughput", "UpdateType": "Mutable", "Required": false, "Type": "ProvisionedThroughput" }, "KeySchema": { "MarkdownDocumentation": "`KeySchema`\n\nThe complete key schema for a global secondary index, which consists of one or more\npairs of attribute names and key types:\n* `HASH` - partition key\n* `RANGE` - sort key\n###### Note\nThe partition key of an item is also known as its *hash\nattribute*. The term \"hash attribute\" derives from DynamoDB's usage of\nan internal hash function to evenly distribute data items across partitions, based\non their partition key values.\nThe sort key of an item is also known as its *range attribute*.\nThe term \"range attribute\" derives from the way DynamoDB stores items with the same\npartition key physically close together, in sorted order by the sort key\nvalue.\n*Required*: Yes\n*Type*: [Array](./aws-properties-dynamodb-table-keyschema.html) of [KeySchema](./aws-properties-dynamodb-table-keyschema.html)\n*Minimum*: `1`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-keyschema", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "KeySchema", "DuplicatesAllowed": false }, "WarmThroughput": { "MarkdownDocumentation": "`WarmThroughput`\n\nRepresents the warm throughput value (in read units per second and write units per\nsecond) for the specified secondary index. If you use this parameter, you must specify\n`ReadUnitsPerSecond`, `WriteUnitsPerSecond`, or both.\n*Required*: No\n*Type*: [WarmThroughput](./aws-properties-dynamodb-table-warmthroughput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-warmthroughput", "UpdateType": "Mutable", "Required": false, "Type": "WarmThroughput" } } }, "AWS::DynamoDB::Table.ImportSourceSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.ImportSourceSpecification`\n\nSpecifies the properties of data being imported from the S3 bucket source to the\ntable.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-importsourcespecification.html", "Properties": { "S3BucketSource": { "MarkdownDocumentation": "`S3BucketSource`\n\nThe S3 bucket that provides the source for the import.\n*Required*: Yes\n*Type*: [S3BucketSource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-importsourcespecification.html#cfn-dynamodb-table-importsourcespecification-s3bucketsource", "UpdateType": "Immutable", "Required": true, "Type": "S3BucketSource" }, "InputFormat": { "MarkdownDocumentation": "`InputFormat`\n\nThe format of the source data. Valid values for `ImportFormat` are\n`CSV`, `DYNAMODB_JSON` or `ION`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DYNAMODB_JSON | ION | CSV...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DYNAMODB_JSON", "ION", "CSV" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-importsourcespecification.html#cfn-dynamodb-table-importsourcespecification-inputformat", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InputFormatOptions": { "MarkdownDocumentation": "`InputFormatOptions`\n\nAdditional properties that specify how the input is formatted,\n*Required*: No\n*Type*: [InputFormatOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-importsourcespecification.html#cfn-dynamodb-table-importsourcespecification-inputformatoptions", "UpdateType": "Immutable", "Required": false, "Type": "InputFormatOptions" }, "InputCompressionType": { "MarkdownDocumentation": "`InputCompressionType`\n\nType of compression to be used on the input coming from the imported table.\n*Required*: No\n*Type*: String\n*Allowed values*: `GZIP | ZSTD | NONE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "GZIP", "ZSTD", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-importsourcespecification.html#cfn-dynamodb-table-importsourcespecification-inputcompressiontype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DynamoDB::Table.InputFormatOptions": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.InputFormatOptions`\n\nThe format options for the data that was imported into the target table. There is one\nvalue, CsvOption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-inputformatoptions.html", "Properties": { "Csv": { "MarkdownDocumentation": "`Csv`\n\nThe options for imported source files in CSV format. The values are Delimiter and\nHeaderList.\n*Required*: No\n*Type*: [Csv](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-inputformatoptions.html#cfn-dynamodb-table-inputformatoptions-csv", "UpdateType": "Immutable", "Required": false, "Type": "Csv" } } }, "AWS::DynamoDB::Table.KeySchema": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.KeySchema`\n\nRepresents *a single element* of a key schema. A key schema\nspecifies the attributes that make up the primary key of a table, or the key attributes\nof an index.\nA `KeySchemaElement` represents exactly one attribute of the primary key.\nFor example, a simple primary key would be represented by one\n`KeySchemaElement` (for the partition key). A composite primary key would\nrequire one `KeySchemaElement` for the partition key, and another\n`KeySchemaElement` for the sort key.\nA `KeySchemaElement` must be a scalar, top-level attribute (not a nested\nattribute). The data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html", "Properties": { "KeyType": { "MarkdownDocumentation": "`KeyType`\n\nThe role that this key attribute will assume:\n* `HASH` - partition key\n* `RANGE` - sort key\n###### Note\nThe partition key of an item is also known as its *hash\nattribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\npartitions, based on their partition key values.\nThe sort key of an item is also known as its *range attribute*.\nThe term \"range attribute\" derives from the way DynamoDB stores items with\nthe same partition key physically close together, in sorted order by the sort key\nvalue.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HASH | RANGE...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HASH", "RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html#cfn-dynamodb-table-keyschema-keytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nThe name of a key attribute.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html#cfn-dynamodb-table-keyschema-attributename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DynamoDB::Table.KinesisStreamSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.KinesisStreamSpecification`\n\nThe Kinesis Data Streams configuration for the specified table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-kinesisstreamspecification.html", "Properties": { "ApproximateCreationDateTimePrecision": { "MarkdownDocumentation": "`ApproximateCreationDateTimePrecision`\n\nThe precision for the time and date that the stream was created.\n*Required*: No\n*Type*: String\n*Allowed values*: `MICROSECOND | MILLISECOND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MICROSECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-kinesisstreamspecification.html#cfn-dynamodb-table-kinesisstreamspecification-approximatecreationdatetimeprecision", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StreamArn": { "MarkdownDocumentation": "`StreamArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-kinesisstreamspecification.html#cfn-dynamodb-table-kinesisstreamspecification-streamarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DynamoDB::Table.LocalSecondaryIndex": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.LocalSecondaryIndex`\n\nRepresents the properties of a local secondary index. A local secondary index can only\nbe created when its parent table is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-localsecondaryindex.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the local secondary index. The name must be unique among all other indexes\non this table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-localsecondaryindex.html#cfn-dynamodb-table-localsecondaryindex-indexname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Projection": { "MarkdownDocumentation": "`Projection`\n\nRepresents attributes that are copied (projected) from the table into the local\nsecondary index. These are in addition to the primary key attributes and index key\nattributes, which are automatically projected.\n*Required*: Yes\n*Type*: [Projection](./aws-properties-dynamodb-table-projection.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-localsecondaryindex.html#cfn-dynamodb-table-localsecondaryindex-projection", "UpdateType": "Mutable", "Required": true, "Type": "Projection" }, "KeySchema": { "MarkdownDocumentation": "`KeySchema`\n\nThe complete key schema for the local secondary index, consisting of one or more pairs\nof attribute names and key types:\n* `HASH` - partition key\n* `RANGE` - sort key\n###### Note\nThe partition key of an item is also known as its *hash\nattribute*. The term \"hash attribute\" derives from DynamoDB's usage of\nan internal hash function to evenly distribute data items across partitions, based\non their partition key values.\nThe sort key of an item is also known as its *range attribute*.\nThe term \"range attribute\" derives from the way DynamoDB stores items with the same\npartition key physically close together, in sorted order by the sort key\nvalue.\n*Required*: Yes\n*Type*: [Array](./aws-properties-dynamodb-table-keyschema.html) of [KeySchema](./aws-properties-dynamodb-table-keyschema.html)\n*Minimum*: `1`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-localsecondaryindex.html#cfn-dynamodb-table-localsecondaryindex-keyschema", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "KeySchema", "DuplicatesAllowed": false } } }, "AWS::DynamoDB::Table.OnDemandThroughput": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.OnDemandThroughput`\n\nSets the maximum number of read and write units for the specified on-demand table. If\nyou use this property, you must specify `MaxReadRequestUnits`,\n`MaxWriteRequestUnits`, or both.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ondemandthroughput.html", "Properties": { "MaxReadRequestUnits": { "MarkdownDocumentation": "`MaxReadRequestUnits`\n\nMaximum number of read request units for the specified table.\nTo specify a maximum `OnDemandThroughput` on your table, set the value of\n`MaxReadRequestUnits` as greater than or equal to 1. To remove the\nmaximum `OnDemandThroughput` that is currently set on your table, set the\nvalue of `MaxReadRequestUnits` to -1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ondemandthroughput.html#cfn-dynamodb-table-ondemandthroughput-maxreadrequestunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxWriteRequestUnits": { "MarkdownDocumentation": "`MaxWriteRequestUnits`\n\nMaximum number of write request units for the specified table.\nTo specify a maximum `OnDemandThroughput` on your table, set the value of\n`MaxWriteRequestUnits` as greater than or equal to 1. To remove the\nmaximum `OnDemandThroughput` that is currently set on your table, set the\nvalue of `MaxWriteRequestUnits` to -1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ondemandthroughput.html#cfn-dynamodb-table-ondemandthroughput-maxwriterequestunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::Table.PointInTimeRecoverySpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.PointInTimeRecoverySpecification`\n\nThe settings used to enable point in time recovery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html", "Properties": { "PointInTimeRecoveryEnabled": { "MarkdownDocumentation": "`PointInTimeRecoveryEnabled`\n\nIndicates whether point in time recovery is enabled (true) or disabled (false) on the\ntable.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html#cfn-dynamodb-table-pointintimerecoveryspecification-pointintimerecoveryenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RecoveryPeriodInDays": { "MarkdownDocumentation": "`RecoveryPeriodInDays`\n\nThe number of preceding days for which continuous backups are taken and maintained.\nYour table data is only recoverable to any point-in-time from within the configured\nrecovery period. This parameter is optional. If no value is provided, the value will\ndefault to 35.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `35`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html#cfn-dynamodb-table-pointintimerecoveryspecification-recoveryperiodindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::Table.Projection": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.Projection`\n\nRepresents attributes that are copied (projected) from the table into an index. These\nare in addition to the primary key attributes and index key attributes, which are\nautomatically projected.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html", "Properties": { "NonKeyAttributes": { "MarkdownDocumentation": "`NonKeyAttributes`\n\nRepresents the non-key attribute names which will be projected into the index.\nFor global and local secondary indexes, the total count of\n`NonKeyAttributes` summed across all of the secondary indexes, must not\nexceed 100. If you project the same attribute into two different indexes, this counts as\ntwo distinct attributes when determining the total. This limit only applies when you\nspecify the ProjectionType of `INCLUDE`. You still can specify the\nProjectionType of `ALL` to project all attributes from the source table, even\nif the table has more than 100 attributes.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `20`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html#cfn-dynamodb-table-projection-nonkeyattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ProjectionType": { "MarkdownDocumentation": "`ProjectionType`\n\nThe set of attributes that are projected into the index:\n* `KEYS_ONLY` - Only the index and primary keys are projected into the\n index.\n* `INCLUDE` - In addition to the attributes described in\n `KEYS_ONLY`, the secondary index will include other non-key\n attributes that you specify.\n* `ALL` - All of the table attributes are projected into the\n index.\nWhen using the DynamoDB console, `ALL` is selected by default.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL | KEYS_ONLY | INCLUDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html#cfn-dynamodb-table-projection-projectiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DynamoDB::Table.ProvisionedThroughput": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.ProvisionedThroughput`\n\nThroughput for the specified table, which consists of values for\n`ReadCapacityUnits` and `WriteCapacityUnits`. For more information\nabout the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html", "Properties": { "WriteCapacityUnits": { "MarkdownDocumentation": "`WriteCapacityUnits`\n\nThe maximum number of writes consumed per second before DynamoDB returns a\n`ThrottlingException`. For more information, see [Specifying\nRead and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer\nGuide*.\nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to\n0.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html#cfn-dynamodb-table-provisionedthroughput-writecapacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ReadCapacityUnits": { "MarkdownDocumentation": "`ReadCapacityUnits`\n\nThe maximum number of strongly consistent reads consumed per second before DynamoDB\nreturns a `ThrottlingException`. For more information, see [Specifying\nRead and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer\nGuide*.\nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to\n0.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html#cfn-dynamodb-table-provisionedthroughput-readcapacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::DynamoDB::Table.ResourcePolicy": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.ResourcePolicy`\n\nCreates or updates a resource-based policy document that contains the permissions for\nDynamoDB resources, such as a table, its indexes, and stream. Resource-based\npolicies let you define access permissions by specifying who has access to each resource,\nand the actions they are allowed to perform on each resource.\nIn a CloudFormation template, you can provide the policy in JSON or YAML format\nbecause CloudFormation converts YAML to JSON before submitting it to DynamoDB. For more information about resource-based policies, see [Using\nresource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy\nexamples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\nWhile defining resource-based policies in your CloudFormation templates, the\nfollowing considerations apply:\n* The maximum size supported for a resource-based policy document in JSON format is\n 20 KB. DynamoDB counts whitespaces when calculating the size of a policy\n against this limit.\n* Resource-based policies don't support [drift\n detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CloudFormation\n stack template, you'll need to update the CloudFormation stack with the\n changes.\n* Resource-based policies don't support out-of-band changes. If you add, update, or\n delete a policy outside of the CloudFormation template, the change won't be\n overwritten if there are no changes to the policy within the template.\n \n For example, say that your template contains a resource-based policy, which you\n later update outside of the template. If you don't make any changes to the policy in\n the template, the updated policy in DynamoDB won\u2019t be synced with the\n policy in the template.\n \n Conversely, say that your template doesn\u2019t contain a resource-based policy, but\n you add a policy outside of the template. This policy won\u2019t be removed from DynamoDB as long as you don\u2019t add it to the template. When you add a policy to\n the template and update the stack, the existing policy in DynamoDB will be\n updated to match the one defined in the template.\nFor a full list of all considerations, see [Resource-based\npolicy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html", "Properties": { "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA resource-based policy document that contains permissions to add to the specified\nDynamoDB table, index, or both. In a CloudFormation template, you can\nprovide the policy in JSON or YAML format because CloudFormation converts YAML to\nJSON before submitting it to DynamoDB. For more information about resource-based\npolicies, see [Using\nresource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy\nexamples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html#cfn-dynamodb-table-resourcepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::DynamoDB::Table.S3BucketSource": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.S3BucketSource`\n\nThe S3 bucket that is being imported from.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-s3bucketsource.html", "Properties": { "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nThe S3 bucket that is being imported from.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9A-Z]+[\\.\\-\\w]*[a-z0-9A-Z]+$`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-s3bucketsource.html#cfn-dynamodb-table-s3bucketsource-s3bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3KeyPrefix": { "MarkdownDocumentation": "`S3KeyPrefix`\n\nThe key prefix shared by all S3 Objects that are being imported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-s3bucketsource.html#cfn-dynamodb-table-s3bucketsource-s3keyprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "S3BucketOwner": { "MarkdownDocumentation": "`S3BucketOwner`\n\nThe account number of the S3 bucket that is being imported from. If the bucket is\nowned by the requester this is optional.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-s3bucketsource.html#cfn-dynamodb-table-s3bucketsource-s3bucketowner", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DynamoDB::Table.SSESpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.SSESpecification`\n\nRepresents the settings used to enable server-side encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html", "Properties": { "SSEEnabled": { "MarkdownDocumentation": "`SSEEnabled`\n\nIndicates whether server-side encryption is done using an AWS managed\nkey or an AWS owned key. If enabled (true), server-side encryption type\nis set to `KMS` and an AWS managed key is used (AWS KMS charges apply). If disabled (false) or not specified, server-side\nencryption is set to AWS owned 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-sseenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "SSEType": { "MarkdownDocumentation": "`SSEType`\n\nServer-side encryption type. The only supported value is:\n* `KMS` - Server-side encryption that uses AWS Key Management Service. The\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-ssetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KMSMasterKeyId": { "MarkdownDocumentation": "`KMSMasterKeyId`\n\nThe AWS KMS key that should be used for the AWS KMS encryption.\nTo specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.\nNote that you should only provide this parameter if the key is different from the\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-kmsmasterkeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DynamoDB::Table.StreamSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.StreamSpecification`\n\nRepresents the DynamoDB Streams configuration for a table in DynamoDB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html", "Properties": { "StreamViewType": { "MarkdownDocumentation": "`StreamViewType`\n\nWhen an item in the table is modified, `StreamViewType` determines what\ninformation is written to the stream for this table. Valid values for\n`StreamViewType` are:\n* `KEYS_ONLY` - Only the key attributes of the modified item are\n written to the stream.\n* `NEW_IMAGE` - The entire item, as it appears after it was modified,\n is written to the stream.\n* `OLD_IMAGE` - The entire item, as it appeared before it was modified,\n is written to the stream.\n* `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the\n item are written to the stream.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW_IMAGE | OLD_IMAGE | NEW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html#cfn-dynamodb-table-streamspecification-streamviewtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nCreates or updates a resource-based policy document that contains the permissions for\nDynamoDB resources, such as a table's streams. Resource-based policies let you\ndefine access permissions by specifying who has access to each resource, and the actions\nthey are allowed to perform on each resource.\n###### Note\nWhen you remove the `StreamSpecification` property from the template, DynamoDB disables the stream but retains any attached resource policy until the stream is deleted after 24 hours. When you modify the `StreamViewType` property, DynamoDB creates a new stream and retains the old stream's resource policy. The old stream and its resource policy are deleted after the 24-hour retention period.\nIn a CloudFormation template, you can provide the policy in JSON or YAML format\nbecause CloudFormation converts YAML to JSON before submitting it to DynamoDB. For more information about resource-based policies, see [Using\nresource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy\nexamples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n*Required*: No\n*Type*: [ResourcePolicy](./aws-properties-dynamodb-table-resourcepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html#cfn-dynamodb-table-streamspecification-resourcepolicy", "UpdateType": "Mutable", "Required": false, "Type": "ResourcePolicy" } } }, "AWS::DynamoDB::Table.TimeToLiveSpecification": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.TimeToLiveSpecification`\n\nRepresents the settings used to enable or disable Time to Live (TTL) for the specified\ntable.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html#cfn-dynamodb-table-timetolivespecification-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nThe name of the TTL attribute used to store the expiration time for items in the\ntable.\n###### Note\n* The `AttributeName` property is required when enabling the TTL, or\n when TTL is already enabled.\n* To update this property, you must first disable TTL and then enable TTL with\n the new attribute name.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html#cfn-dynamodb-table-timetolivespecification-attributename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::DynamoDB::Table.WarmThroughput": { "MarkdownDocumentation": "`AWS::DynamoDB::Table.WarmThroughput`\n\nProvides visibility into the number of read and write operations your table or\nsecondary index can instantaneously support. The settings can be modified using the\n`UpdateTable` operation to meet the throughput requirements of an\nupcoming peak event.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-warmthroughput.html", "Properties": { "ReadUnitsPerSecond": { "MarkdownDocumentation": "`ReadUnitsPerSecond`\n\nRepresents the number of read operations your base table can instantaneously\nsupport.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-warmthroughput.html#cfn-dynamodb-table-warmthroughput-readunitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "WriteUnitsPerSecond": { "MarkdownDocumentation": "`WriteUnitsPerSecond`\n\nRepresents the number of write operations your base table can instantaneously\nsupport.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-warmthroughput.html#cfn-dynamodb-table-warmthroughput-writeunitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::CapacityReservation.CapacityAllocation": { "MarkdownDocumentation": "`AWS::EC2::CapacityReservation.CapacityAllocation`\n\nInformation about instance capacity usage for a Capacity Reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-capacityallocation.html", "Properties": { "AllocationType": { "MarkdownDocumentation": "`AllocationType`\n\nThe usage type. `used` indicates that the instance capacity is in use by\ninstances that are running in the Capacity Reservation.\n*Required*: No\n*Type*: String\n*Allowed values*: `used`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "used" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-capacityallocation.html#cfn-ec2-capacityreservation-capacityallocation-allocationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Count": { "MarkdownDocumentation": "`Count`\n\nThe amount of instance capacity associated with the usage. For example a value of\n`4` indicates that instance capacity for 4 instances is currently in\nuse.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-capacityallocation.html#cfn-ec2-capacityreservation-capacityallocation-count", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::CapacityReservation.CommitmentInfo": { "MarkdownDocumentation": "`AWS::EC2::CapacityReservation.CommitmentInfo`\n\nInformation about your commitment for a future-dated Capacity Reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-commitmentinfo.html", "Properties": { "CommittedInstanceCount": { "MarkdownDocumentation": "`CommittedInstanceCount`\n\nThe instance capacity that you committed to when you requested the future-dated\nCapacity Reservation.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-commitmentinfo.html#cfn-ec2-capacityreservation-commitmentinfo-committedinstancecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CommitmentEndDate": { "MarkdownDocumentation": "`CommitmentEndDate`\n\nThe date and time at which the commitment duration expires, in the ISO8601 format in\nthe UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). You can't decrease the\ninstance count or cancel the Capacity Reservation before this date and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-commitmentinfo.html#cfn-ec2-capacityreservation-commitmentinfo-commitmentenddate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::CapacityReservation.TagSpecification": { "MarkdownDocumentation": "`AWS::EC2::CapacityReservation.TagSpecification`\n\nAn 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html", "Properties": { "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource to tag. Specify `capacity-reservation`.\n*Required*: No\n*Type*: String\n*Allowed values*: `capacity-reservation | clie...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "capacity-reservation", "client-vpn-endpoint", "customer-gateway", "carrier-gateway", "coip-pool", "declarative-policies-report", "dedicated-host", "dhcp-options", "egress-only-internet-gateway", "elastic-ip", "elastic-gpu", "export-image-task", "export-instance-task", "fleet", "fpga-image", "host-reservation", "image", "image-usage-report", "import-image-task", "import-snapshot-task", "instance", "instance-event-window", "internet-gateway", "ipam", "ipam-pool", "ipam-scope", "ipv4pool-ec2", "ipv6pool-ec2", "key-pair", "launch-template", "local-gateway", "local-gateway-route-table", "local-gateway-virtual-interface", "local-gateway-virtual-interface-group", "local-gateway-route-table-vpc-association", "local-gateway-route-table-virtual-interface-group-association", "natgateway", "network-acl", "network-interface", "network-insights-analysis", "network-insights-path", "network-insights-access-scope", "network-insights-access-scope-analysis", "outpost-lag", "placement-group", "prefix-list", "replace-root-volume-task", "reserved-instances", "route-table", "security-group", "security-group-rule", "service-link-virtual-interface", "snapshot", "spot-fleet-request", "spot-instances-request", "subnet", "subnet-cidr-reservation", "traffic-mirror-filter", "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-metering-policy", "transit-gateway-route-table", "transit-gateway-route-table-announcement", "volume", "vpc", "vpc-endpoint", "vpc-endpoint-connection", "vpc-endpoint-service", "vpc-endpoint-service-permission", "vpc-peering-connection", "vpn-connection", "vpn-gateway", "vpc-flow-log", "capacity-reservation-fleet", "traffic-mirror-filter-rule", "vpc-endpoint-connection-device-type", "verified-access-instance", "verified-access-group", "verified-access-endpoint", "verified-access-policy", "verified-access-trust-provider", "vpn-connection-device-type", "vpc-block-public-access-exclusion", "vpc-encryption-control", "route-server", "route-server-endpoint", "route-server-peer", "ipam-resource-discovery", "ipam-resource-discovery-association", "instance-connect-endpoint", "verified-access-endpoint-target", "ipam-external-resource-verification-token", "capacity-block", "mac-modification-task", "ipam-prefix-list-resolver", "ipam-policy", "ipam-prefix-list-resolver-target", "capacity-manager-data-export", "vpn-concentrator" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html#cfn-ec2-capacityreservation-tagspecification-resourcetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-capacityreservation-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html#cfn-ec2-capacityreservation-tagspecification-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::EC2::CapacityReservationFleet.InstanceTypeSpecification": { "MarkdownDocumentation": "`AWS::EC2::CapacityReservationFleet.InstanceTypeSpecification`\n\nSpecifies information about an instance type to use in a Capacity Reservation\nFleet.\n`InstanceTypeSpecification` is a property of the [AWS::EC2::CapacityReservationFleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html", "Properties": { "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority to assign to the instance type. This value is used to determine which of\nthe instance types specified for the Fleet should be prioritized for use. A lower value\nindicates a high priority. For more information, see [Instance type\npriority](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*Maximum*: `999`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-priority", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "AvailabilityZoneId": { "MarkdownDocumentation": "`AvailabilityZoneId`\n\nThe ID of the Availability Zone in which the Capacity Reservation Fleet reserves the\ncapacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type\nspecifications that you specify for the Fleet must use the same Availability\nZone.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-availabilityzoneid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A\nCapacity Reservation Fleet can't span Availability Zones. All instance type\nspecifications that you specify for the Fleet must use the same Availability\nZone.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstancePlatform": { "MarkdownDocumentation": "`InstancePlatform`\n\nThe type of operating system for which the Capacity Reservation Fleet reserves\ncapacity.\n*Required*: No\n*Type*: String\n*Allowed values*: `Linux/UNIX | Red Hat Enterp...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Linux/UNIX", "Red Hat Enterprise Linux", "SUSE Linux", "Windows", "Windows with SQL Server", "Windows with SQL Server Enterprise", "Windows with SQL Server Standard", "Windows with SQL Server Web", "Linux with SQL Server Standard", "Linux with SQL Server Web", "Linux with SQL Server Enterprise", "RHEL with SQL Server Standard", "RHEL with SQL Server Enterprise", "RHEL with SQL Server Web", "RHEL with HA", "RHEL with HA and SQL Server Standard", "RHEL with HA and SQL Server Enterprise", "Ubuntu Pro" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-instanceplatform", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type for which the Capacity Reservation Fleet reserves capacity.\n*Required*: No\n*Type*: String\n*Allowed values*: `a1.medium | a1.large | a1.x...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge", "c8g.medium", "c8g.large", "c8g.xlarge", "c8g.2xlarge", "c8g.4xlarge", "c8g.8xlarge", "c8g.12xlarge", "c8g.16xlarge", "c8g.24xlarge", "c8g.48xlarge", "c8g.metal-24xl", "c8g.metal-48xl", "m8g.medium", "m8g.large", "m8g.xlarge", "m8g.2xlarge", "m8g.4xlarge", "m8g.8xlarge", "m8g.12xlarge", "m8g.16xlarge", "m8g.24xlarge", "m8g.48xlarge", "m8g.metal-24xl", "m8g.metal-48xl", "x8g.medium", "x8g.large", "x8g.xlarge", "x8g.2xlarge", "x8g.4xlarge", "x8g.8xlarge", "x8g.12xlarge", "x8g.16xlarge", "x8g.24xlarge", "x8g.48xlarge", "x8g.metal-24xl", "x8g.metal-48xl", "i7ie.large", "i7ie.xlarge", "i7ie.2xlarge", "i7ie.3xlarge", "i7ie.6xlarge", "i7ie.12xlarge", "i7ie.18xlarge", "i7ie.24xlarge", "i7ie.48xlarge", "i8g.large", "i8g.xlarge", "i8g.2xlarge", "i8g.4xlarge", "i8g.8xlarge", "i8g.12xlarge", "i8g.16xlarge", "i8g.24xlarge", "i8g.metal-24xl", "u7i-6tb.112xlarge", "u7i-8tb.112xlarge", "u7inh-32tb.480xlarge", "p5e.48xlarge", "p5en.48xlarge", "f2.12xlarge", "f2.48xlarge", "trn2.48xlarge", "c7i-flex.12xlarge", "c7i-flex.16xlarge", "m7i-flex.12xlarge", "m7i-flex.16xlarge", "i7ie.metal-24xl", "i7ie.metal-48xl", "i8g.48xlarge", "c8gd.medium", "c8gd.large", "c8gd.xlarge", "c8gd.2xlarge", "c8gd.4xlarge", "c8gd.8xlarge", "c8gd.12xlarge", "c8gd.16xlarge", "c8gd.24xlarge", "c8gd.48xlarge", "c8gd.metal-24xl", "c8gd.metal-48xl", "i7i.large", "i7i.xlarge", "i7i.2xlarge", "i7i.4xlarge", "i7i.8xlarge", "i7i.12xlarge", "i7i.16xlarge", "i7i.24xlarge", "i7i.48xlarge", "i7i.metal-24xl", "i7i.metal-48xl", "p6-b200.48xlarge", "m8gd.medium", "m8gd.large", "m8gd.xlarge", "m8gd.2xlarge", "m8gd.4xlarge", "m8gd.8xlarge", "m8gd.12xlarge", "m8gd.16xlarge", "m8gd.24xlarge", "m8gd.48xlarge", "m8gd.metal-24xl", "m8gd.metal-48xl", "r8gd.medium", "r8gd.large", "r8gd.xlarge", "r8gd.2xlarge", "r8gd.4xlarge", "r8gd.8xlarge", "r8gd.12xlarge", "r8gd.16xlarge", "r8gd.24xlarge", "r8gd.48xlarge", "r8gd.metal-24xl", "r8gd.metal-48xl", "c8gn.medium", "c8gn.large", "c8gn.xlarge", "c8gn.2xlarge", "c8gn.4xlarge", "c8gn.8xlarge", "c8gn.12xlarge", "c8gn.16xlarge", "c8gn.24xlarge", "c8gn.48xlarge", "c8gn.metal-24xl", "c8gn.metal-48xl", "f2.6xlarge", "p6e-gb200.36xlarge", "g6f.large", "g6f.xlarge", "g6f.2xlarge", "g6f.4xlarge", "gr6f.4xlarge", "p5.4xlarge", "r8i.large", "r8i.xlarge", "r8i.2xlarge", "r8i.4xlarge", "r8i.8xlarge", "r8i.12xlarge", "r8i.16xlarge", "r8i.24xlarge", "r8i.32xlarge", "r8i.48xlarge", "r8i.96xlarge", "r8i.metal-48xl", "r8i.metal-96xl", "r8i-flex.large", "r8i-flex.xlarge", "r8i-flex.2xlarge", "r8i-flex.4xlarge", "r8i-flex.8xlarge", "r8i-flex.12xlarge", "r8i-flex.16xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-instancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe number of capacity units provided by the specified instance type. This value,\ntogether with the total target capacity that you specify for the Fleet determine the number\nof instances for which the Fleet reserves capacity. Both values are based on units that\nmake sense for your workload. For more information, see [Total target\ncapacity](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\n`99.999`.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-weight", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "EbsOptimized": { "MarkdownDocumentation": "`EbsOptimized`\n\nIndicates whether the Capacity Reservation Fleet supports EBS-optimized instances\ntypes. This optimization provides dedicated throughput to Amazon EBS and an\noptimized configuration stack to provide optimal I/O performance. This optimization\nisn't available with all instance types. Additional usage charges apply when using\nEBS-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-ebsoptimized", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::CapacityReservationFleet.TagSpecification": { "MarkdownDocumentation": "`AWS::EC2::CapacityReservationFleet.TagSpecification`\n\nThe tags to apply to a resource when the resource is being created. When you specify a tag, you must\nspecify the resource type to tag, otherwise the request will fail.\n###### Note\nThe `Valid Values` lists all the resource types that can be tagged.\nHowever, the action you're using might not support tagging all of these resource types.\nIf you try to tag a resource type that is unsupported for the action you're using,\nyou'll get an error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-tagspecification.html", "Properties": { "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource to tag on creation. Specify\n`capacity-reservation-fleet`.\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*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-tagspecification.html#cfn-ec2-capacityreservationfleet-tagspecification-resourcetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-capacityreservationfleet-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-tagspecification.html#cfn-ec2-capacityreservationfleet-tagspecification-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::EC2::ClientVpnEndpoint.CertificateAuthenticationRequest": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.CertificateAuthenticationRequest`\n\nInformation about the client certificate to be used for authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html", "Properties": { "ClientRootCertificateChainArn": { "Required": true, "MarkdownDocumentation": "`ClientRootCertificateChainArn`\n\nThe ARN of the client certificate. The certificate must be signed by a certificate\nauthority (CA) and it must be provisioned in AWS Certificate Manager (ACM).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html#cfn-ec2-clientvpnendpoint-certificateauthenticationrequest-clientrootcertificatechainarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnEndpoint.ClientAuthenticationRequest": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.ClientAuthenticationRequest`\n\nDescribes the authentication method to be used by a Client VPN endpoint. For more information, see [Authentication](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication)\nin the *AWS Client VPN Administrator Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html", "Properties": { "MutualAuthentication": { "Type": "CertificateAuthenticationRequest", "Required": false, "MarkdownDocumentation": "`MutualAuthentication`\n\nInformation about the authentication certificates to be used, if applicable. You must provide this information if **Type** is `certificate-authentication`.\n*Required*: No\n*Type*: [CertificateAuthenticationRequest](./aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication", "UpdateType": "Mutable" }, "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of client authentication to be used.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `certificate-authentication ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "certificate-authentication", "directory-service-authentication", "federated-authentication" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FederatedAuthentication": { "Type": "FederatedAuthenticationRequest", "Required": false, "MarkdownDocumentation": "`FederatedAuthentication`\n\nInformation about the IAM SAML identity provider, if applicable.\n*Required*: No\n*Type*: [FederatedAuthenticationRequest](./aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-federatedauthentication", "UpdateType": "Mutable" }, "ActiveDirectory": { "Type": "DirectoryServiceAuthenticationRequest", "Required": false, "MarkdownDocumentation": "`ActiveDirectory`\n\nInformation about the Active Directory to be used, if applicable. You must provide this information if **Type** is `directory-service-authentication`.\n*Required*: No\n*Type*: [DirectoryServiceAuthenticationRequest](./aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnEndpoint.ClientConnectOptions": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.ClientConnectOptions`\n\nIndicates whether client connect options are enabled. The default is `false`\n(not enabled).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html", "Properties": { "LambdaFunctionArn": { "Required": false, "MarkdownDocumentation": "`LambdaFunctionArn`\n\nThe Amazon Resource Name (ARN) of the AWS Lambda function used for\nconnection authorization.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html#cfn-ec2-clientvpnendpoint-clientconnectoptions-lambdafunctionarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Enabled": { "Required": true, "MarkdownDocumentation": "`Enabled`\n\nIndicates whether client connect options are enabled. The default is `false`\n(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html#cfn-ec2-clientvpnendpoint-clientconnectoptions-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnEndpoint.ClientLoginBannerOptions": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.ClientLoginBannerOptions`\n\nOptions for enabling a customizable text banner that will be displayed on\nAWS provided clients when a VPN session is established.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html", "Properties": { "Enabled": { "Required": true, "MarkdownDocumentation": "`Enabled`\n\nEnable or disable a customizable text banner that will be displayed on\nAWS provided clients when a VPN session is established.\nValid values: `true | false`\nDefault value: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "BannerText": { "Required": false, "MarkdownDocumentation": "`BannerText`\n\nCustomizable text that will be displayed in a banner on AWS provided\nclients when a VPN session is established. UTF-8 encoded characters only. Maximum of\n1400 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions-bannertext", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnEndpoint.ClientRouteEnforcementOptions": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.ClientRouteEnforcementOptions`\n\nClient Route Enforcement is a feature of Client VPN that helps enforce administrator defined\nroutes on devices connected through the VPN. This feature helps improve your security\nposture by ensuring that network traffic originating from a connected client is not\ninadvertently sent outside the VPN tunnel.\nClient Route Enforcement works by monitoring the route table of a connected device for\nrouting policy changes to the VPN connection. If the feature detects any VPN routing\npolicy modifications, it will automatically force an update to the route table,\nreverting it back to the expected route configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientrouteenforcementoptions.html", "Properties": { "Enforced": { "Required": false, "MarkdownDocumentation": "`Enforced`\n\nEnable or disable Client Route Enforcement. The state can either be `true`\n(enabled) or `false` (disabled). The default is `false`.\nValid values: `true | false`\nDefault value: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientrouteenforcementoptions.html#cfn-ec2-clientvpnendpoint-clientrouteenforcementoptions-enforced", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions`\n\nDescribes the client connection logging options for the Client VPN endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html", "Properties": { "CloudwatchLogStream": { "Required": false, "MarkdownDocumentation": "`CloudwatchLogStream`\n\nThe name of the CloudWatch Logs log stream to which the connection data is published.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchlogstream", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Enabled": { "Required": true, "MarkdownDocumentation": "`Enabled`\n\nIndicates whether connection logging 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "CloudwatchLogGroup": { "Required": false, "MarkdownDocumentation": "`CloudwatchLogGroup`\n\nThe name of the CloudWatch Logs log group. Required if connection logging is enabled.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchloggroup", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnEndpoint.DirectoryServiceAuthenticationRequest": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.DirectoryServiceAuthenticationRequest`\n\nDescribes the Active Directory to be used for client authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html", "Properties": { "DirectoryId": { "Required": true, "MarkdownDocumentation": "`DirectoryId`\n\nThe ID of the Active Directory to be used for authentication.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html#cfn-ec2-clientvpnendpoint-directoryserviceauthenticationrequest-directoryid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnEndpoint.FederatedAuthenticationRequest": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.FederatedAuthenticationRequest`\n\nThe IAM SAML identity provider used for federated authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html", "Properties": { "SelfServiceSAMLProviderArn": { "Required": false, "MarkdownDocumentation": "`SelfServiceSAMLProviderArn`\n\nThe Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-selfservicesamlproviderarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SAMLProviderArn": { "Required": true, "MarkdownDocumentation": "`SAMLProviderArn`\n\nThe Amazon Resource Name (ARN) of the IAM SAML identity provider.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-samlproviderarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnEndpoint.TagSpecification": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint.TagSpecification`\n\nSpecifies the tags to apply to the Client VPN endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html", "Properties": { "ResourceType": { "Required": true, "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource to tag. To tag a Client VPN endpoint, `ResourceType`\nmust be `client-vpn-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-resourcetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the resource.\n*Required*: Yes\n*Type*: Array of [Tag](./aws-properties-ec2-clientvpnendpoint-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::EC2::EC2Fleet.AcceleratorCountRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.AcceleratorCountRequest`\n\nThe minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips)\non an instance. To exclude accelerator-enabled instance types, set `Max` to\n`0`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratorcountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of accelerators. To specify no minimum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratorcountrequest.html#cfn-ec2-ec2fleet-acceleratorcountrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of accelerators. To specify no maximum limit, omit this\nparameter. To exclude accelerator-enabled instance types, set `Max` to\n`0`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratorcountrequest.html#cfn-ec2-ec2fleet-acceleratorcountrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::EC2Fleet.AcceleratorTotalMemoryMiBRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.AcceleratorTotalMemoryMiBRequest`\n\nThe minimum and maximum amount of total accelerator memory, in MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html#cfn-ec2-ec2fleet-acceleratortotalmemorymibrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html#cfn-ec2-ec2fleet-acceleratortotalmemorymibrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::EC2Fleet.BaselineEbsBandwidthMbpsRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.BaselineEbsBandwidthMbpsRequest`\n\nThe minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n[Amazon\nEBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit\nthis parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-ec2fleet-baselineebsbandwidthmbpsrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit\nthis parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-ec2fleet-baselineebsbandwidthmbpsrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::EC2Fleet.BaselinePerformanceFactorsRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.BaselinePerformanceFactorsRequest`\n\nThe baseline performance to consider, using an instance family as a baseline reference.\nThe instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\nbaseline to guide instance type selection, but there is no guarantee that the selected\ninstance types will always exceed the baseline for every application.\nCurrently, this parameter only supports CPU performance as a baseline performance\nfactor. For example, specifying `c6i` would use the CPU performance of the\n`c6i` family as the baseline reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineperformancefactorsrequest.html", "Properties": { "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe CPU performance to consider, using an instance family as the baseline reference.\n*Required*: No\n*Type*: [CpuPerformanceFactorRequest](./aws-properties-ec2-ec2fleet-cpuperformancefactorrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineperformancefactorsrequest.html#cfn-ec2-ec2fleet-baselineperformancefactorsrequest-cpu", "UpdateType": "Immutable", "Required": false, "Type": "CpuPerformanceFactorRequest" } } }, "AWS::EC2::EC2Fleet.BlockDeviceMapping": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.BlockDeviceMapping`\n\nDescribes a block device mapping, which defines the EBS volumes and instance store\nvolumes to attach to an instance at launch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-blockdevicemapping.html", "Properties": { "Ebs": { "MarkdownDocumentation": "`Ebs`\n\nParameters used to automatically set up EBS volumes when the instance is\nlaunched.\n*Required*: No\n*Type*: [EbsBlockDevice](./aws-properties-ec2-ec2fleet-ebsblockdevice.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-blockdevicemapping.html#cfn-ec2-ec2fleet-blockdevicemapping-ebs", "UpdateType": "Immutable", "Required": false, "Type": "EbsBlockDevice" }, "NoDevice": { "MarkdownDocumentation": "`NoDevice`\n\nTo omit the device from the block device mapping, specify an empty string. When this\nproperty is specified, the device is removed from the block device mapping regardless of\nthe assigned 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-blockdevicemapping.html#cfn-ec2-ec2fleet-blockdevicemapping-nodevice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VirtualName": { "MarkdownDocumentation": "`VirtualName`\n\nThe virtual device name (`ephemeral`N). Instance store volumes are numbered\nstarting from 0. An instance type with 2 available instance store volumes can specify\nmappings for `ephemeral0` and `ephemeral1`. The number of\navailable instance store volumes depends on the instance type. After you connect to the\ninstance, you must mount the volume.\nNVMe instance store volumes are automatically enumerated and assigned a device name.\nIncluding them in your block device mapping has no effect.\nConstraints: For M3 instances, you must specify instance store volumes in the block\ndevice mapping for the instance. When you launch an M3 instance, we ignore any instance\nstore volumes specified in the block device mapping for the AMI.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-blockdevicemapping.html#cfn-ec2-ec2fleet-blockdevicemapping-virtualname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe device name. For available device names, see [Device names for volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-blockdevicemapping.html#cfn-ec2-ec2fleet-blockdevicemapping-devicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::EC2Fleet.CapacityRebalance": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.CapacityRebalance`\n\nThe Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance\nnotification signal that your Spot Instance is at an elevated risk of being interrupted.\nFor more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityrebalance.html", "Properties": { "TerminationDelay": { "MarkdownDocumentation": "`TerminationDelay`\n\nThe amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\nInstance after launching a new replacement Spot Instance.\nRequired when `ReplacementStrategy` is set to `launch-before-terminate`.\nNot valid when `ReplacementStrategy` is set to `launch`.\nValid values: Minimum value of `120` seconds. Maximum value of `7200` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityrebalance.html#cfn-ec2-ec2fleet-capacityrebalance-terminationdelay", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ReplacementStrategy": { "MarkdownDocumentation": "`ReplacementStrategy`\n\nThe replacement strategy to use. Only available for fleets of type\n`maintain`.\n`launch` - EC2 Fleet launches a replacement Spot Instance when a rebalance\nnotification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not\nterminate the instances that receive a rebalance notification. You can terminate the old\ninstances, or you can leave them running. You are charged for all instances while they are\nrunning.\n`launch-before-terminate` - EC2 Fleet launches a replacement Spot Instance\nwhen a rebalance notification is emitted for an existing Spot Instance in the fleet, and\nthen, after a delay that you specify (in `TerminationDelay`), terminates the\ninstances that received a rebalance notification.\n*Required*: No\n*Type*: String\n*Allowed values*: `launch | launch-before-term...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "launch", "launch-before-terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityrebalance.html#cfn-ec2-ec2fleet-capacityrebalance-replacementstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::EC2Fleet.CapacityReservationOptionsRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.CapacityReservationOptionsRequest`\n\nDescribes the strategy for using unused Capacity Reservations for fulfilling On-Demand\ncapacity.\n###### Note\nThis strategy can only be used if the EC2 Fleet is of type `instant`.\nFor more information about Capacity Reservations, see [On-Demand Capacity\nReservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide*. For examples of using\nCapacity Reservations in an EC2 Fleet, see [EC2 Fleet example\nconfigurations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityreservationoptionsrequest.html", "Properties": { "UsageStrategy": { "MarkdownDocumentation": "`UsageStrategy`\n\nIndicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.\nIf you specify `use-capacity-reservations-first`, the fleet uses unused\nCapacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If\nmultiple instance pools have unused Capacity Reservations, the On-Demand allocation\nstrategy (`lowest-price` or `prioritized`) is applied. If the number\nof unused Capacity Reservations is less than the On-Demand target capacity, the remaining\nOn-Demand target capacity is launched according to the On-Demand allocation strategy\n(`lowest-price` or `prioritized`).\nIf you do not specify a value, the fleet fulfils the On-Demand capacity according to the\nchosen On-Demand allocation strategy.\n*Required*: No\n*Type*: String\n*Allowed values*: `use-capacity-reservations-f...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "use-capacity-reservations-first" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityreservationoptionsrequest.html#cfn-ec2-ec2fleet-capacityreservationoptionsrequest-usagestrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::EC2Fleet.CpuPerformanceFactorRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.CpuPerformanceFactorRequest`\n\nThe CPU performance to consider, using an instance family as the baseline reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-cpuperformancefactorrequest.html", "Properties": { "References": { "MarkdownDocumentation": "`References`\n\nSpecify an instance family to use as the baseline reference for CPU performance. All\ninstance types that match your specified attributes will be compared against the CPU\nperformance of the referenced instance family, regardless of CPU manufacturer or\narchitecture differences.\n###### Note\nCurrently, only one instance family can be specified in the list.\n*Required*: No\n*Type*: Array of [PerformanceFactorReferenceRequest](./aws-properties-ec2-ec2fleet-performancefactorreferencerequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-cpuperformancefactorrequest.html#cfn-ec2-ec2fleet-cpuperformancefactorrequest-references", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "PerformanceFactorReferenceRequest", "DuplicatesAllowed": true } } }, "AWS::EC2::EC2Fleet.EbsBlockDevice": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.EbsBlockDevice`\n\nDescribes a block device for an EBS volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html", "Properties": { "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-snapshotid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the\n*Amazon EBS User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `gp2 | gp3 | io1 | io2 | sc1...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "gp2", "gp3", "io1", "io2", "sc1", "st1", "standard" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-volumetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nIdentifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key\nto use for EBS encryption.\nThis parameter is only supported on `BlockDeviceMapping` objects called by\n[RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html), [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html),\nand [RequestSpotInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nIndicates whether the encryption state of an EBS volume is changed while being\nrestored from a backing snapshot. The effect of setting the encryption state to `true` depends on\nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by\ndefault is enabled. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters)\nin the *Amazon EBS User Guide*.\nIn no case can you remove encryption from an encrypted volume.\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For\nmore information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances).\n* If you are creating a block device mapping for a **new (empty)\n volume**, you can include this parameter, and specify either `true`\n for an encrypted volume, or `false` for an unencrypted volume. If you omit\n this parameter, it defaults to `false` (unencrypted).\n* If you are creating a block device mapping from an **existing\n encrypted or unencrypted snapshot**, you must omit this parameter. If you\n include this parameter, the request will fail, regardless of the value that you\n specify.\n* If you are creating a block device mapping from an **existing\n unencrypted volume**, you can include this parameter, but you must specify\n `false`. If you specify `true`, the request will fail. In this\n case, we recommend that you omit the parameter.\n* If you are creating a block device mapping from an **existing\n encrypted volume**, you can include this parameter, and specify either\n `true` or `false`. However, if you specify `false`,\n the parameter is ignored and the block device mapping is always encrypted. In this\n case, we recommend that you omit the parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-encrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS). For `gp3`, `io1`, and `io2` volumes,\nthis represents the number of IOPS that are provisioned for the volume. For `gp2`\nvolumes, this represents the baseline performance of the volume and the rate at which\nthe volume accumulates I/O credits for bursting.\nThe following are the supported values for each volume type:\n* `gp3`: 3,000 - 80,000 IOPS\n* `io1`: 100 - 64,000 IOPS\n* `io2`: 100 - 256,000 IOPS\nFor `io2` volumes, you can achieve up to 256,000 IOPS on\n[instances\nbuilt on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.\nThis parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes\nis 3,000 IOPS.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-iops", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume\nsize. If you specify a snapshot, the default is the snapshot size. You can specify a\nvolume size that is equal to or larger than the snapshot size.\nThe following are the supported sizes for each volume type:\n* `gp2`: 1 - 16,384 GiB\n* `gp3`: 1 - 65,536 GiB\n* `io1`: 4 - 16,384 GiB\n* `io2`: 4 - 65,536 GiB\n* `st1` and `sc1`: 125 - 16,384 GiB\n* `standard`: 1 - 1024 GiB\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-volumesize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nIndicates whether the EBS volume is deleted on instance termination. For more\ninformation, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ebsblockdevice.html#cfn-ec2-ec2fleet-ebsblockdevice-deleteontermination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::EC2Fleet.FleetLaunchTemplateConfigRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.FleetLaunchTemplateConfigRequest`\n\nSpecifies a launch template and overrides for an EC2 Fleet.\n`FleetLaunchTemplateConfigRequest` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html", "Properties": { "LaunchTemplateSpecification": { "MarkdownDocumentation": "`LaunchTemplateSpecification`\n\nThe launch template to use. You must specify either the launch template ID or launch\ntemplate name in the request.\n*Required*: No\n*Type*: [FleetLaunchTemplateSpecificationRequest](./aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateconfigrequest-launchtemplatespecification", "UpdateType": "Immutable", "Required": false, "Type": "FleetLaunchTemplateSpecificationRequest" }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nAny parameters that you specify override the same parameters in the launch\ntemplate.\nFor fleets of type `request` and `maintain`, a maximum of 300\nitems is allowed across all launch templates.\n*Required*: No\n*Type*: Array of [FleetLaunchTemplateOverridesRequest](./aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateconfigrequest-overrides", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "FleetLaunchTemplateOverridesRequest", "DuplicatesAllowed": true } } }, "AWS::EC2::EC2Fleet.FleetLaunchTemplateOverridesRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.FleetLaunchTemplateOverridesRequest`\n\nSpecifies overrides for a launch template for an EC2 Fleet.\n`FleetLaunchTemplateOverridesRequest` is a property of the [FleetLaunchTemplateConfigRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html", "Properties": { "WeightedCapacity": { "MarkdownDocumentation": "`WeightedCapacity`\n\nThe number of units provided by the specified instance type. These are the same units\nthat you chose to set the target capacity in terms of instances, or a performance\ncharacteristic such as vCPUs, memory, or I/O.\nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the\nnumber of instances to the next whole number. If this value is not specified, the default\nis 1.\n###### Note\nWhen specifying weights, the price used in the `lowest-price` and\n`price-capacity-optimized` allocation strategies is per\n*unit* hour (where the instance price is divided by the specified\nweight). However, if all the specified weights are above the requested\n`TargetCapacity`, resulting in only 1 instance being launched, the price\nused is per *instance* hour.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-weightedcapacity", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe location where the instance launched, if applicable.\n*Required*: No\n*Type*: [Placement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-placement", "UpdateType": "Immutable", "Required": false, "Type": "Placement" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority for the launch template override. The highest priority is launched\nfirst.\nIf the On-Demand `AllocationStrategy` is set to `prioritized`,\nEC2 Fleet uses priority to determine which launch template override to use first in fulfilling\nOn-Demand capacity.\nIf the Spot `AllocationStrategy` is set to\n`capacity-optimized-prioritized`, EC2 Fleet uses priority on a best-effort basis\nto determine which launch template override to use in fulfilling Spot capacity, but\noptimizes for capacity first.\nValid values are whole numbers starting at `0`. The lower the number, the\nhigher the priority. If no number is set, the launch template override has the lowest\npriority. You can set the same priority for different launch template overrides.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-priority", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "BlockDeviceMappings": { "MarkdownDocumentation": "`BlockDeviceMappings`\n\nThe block device mappings, which define the EBS volumes and instance store volumes to\nattach to the instance at launch.\nSupported only for fleets of type `instant`.\nFor more information, see [Block device mappings\nfor volumes on Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: Array of [BlockDeviceMapping](./aws-properties-ec2-ec2fleet-blockdevicemapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-blockdevicemappings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "BlockDeviceMapping", "DuplicatesAllowed": false }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone in which to launch the instances. For example,\n`us-east-2a`.\nEither `AvailabilityZone` or `AvailabilityZoneId` must be\nspecified in the request, but not both.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, `subnet-1234abcdeexample1, subnet-0987cdef6example2`). A request of type `instant` can have only one subnet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-subnetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceRequirements": { "MarkdownDocumentation": "`InstanceRequirements`\n\nThe attributes for the instance types. When you specify instance attributes, Amazon EC2 will\nidentify instance types with those attributes.\n###### Note\nIf you specify `InstanceRequirements`, you can't specify\n`InstanceType`.\n*Required*: No\n*Type*: [InstanceRequirementsRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-instancerequirements", "UpdateType": "Immutable", "Required": false, "Type": "InstanceRequirementsRequest" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type.\n`mac1.metal` is not supported as a launch template override.\n###### Note\nIf you specify `InstanceType`, you can't specify\n`InstanceRequirements`.\n*Required*: No\n*Type*: String\n*Allowed values*: `a1.medium | a1.large | a1.x...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge", "c8g.medium", "c8g.large", "c8g.xlarge", "c8g.2xlarge", "c8g.4xlarge", "c8g.8xlarge", "c8g.12xlarge", "c8g.16xlarge", "c8g.24xlarge", "c8g.48xlarge", "c8g.metal-24xl", "c8g.metal-48xl", "m8g.medium", "m8g.large", "m8g.xlarge", "m8g.2xlarge", "m8g.4xlarge", "m8g.8xlarge", "m8g.12xlarge", "m8g.16xlarge", "m8g.24xlarge", "m8g.48xlarge", "m8g.metal-24xl", "m8g.metal-48xl", "x8g.medium", "x8g.large", "x8g.xlarge", "x8g.2xlarge", "x8g.4xlarge", "x8g.8xlarge", "x8g.12xlarge", "x8g.16xlarge", "x8g.24xlarge", "x8g.48xlarge", "x8g.metal-24xl", "x8g.metal-48xl", "i7ie.large", "i7ie.xlarge", "i7ie.2xlarge", "i7ie.3xlarge", "i7ie.6xlarge", "i7ie.12xlarge", "i7ie.18xlarge", "i7ie.24xlarge", "i7ie.48xlarge", "i8g.large", "i8g.xlarge", "i8g.2xlarge", "i8g.4xlarge", "i8g.8xlarge", "i8g.12xlarge", "i8g.16xlarge", "i8g.24xlarge", "i8g.metal-24xl", "u7i-6tb.112xlarge", "u7i-8tb.112xlarge", "u7inh-32tb.480xlarge", "p5e.48xlarge", "p5en.48xlarge", "f2.12xlarge", "f2.48xlarge", "trn2.48xlarge", "c7i-flex.12xlarge", "c7i-flex.16xlarge", "m7i-flex.12xlarge", "m7i-flex.16xlarge", "i7ie.metal-24xl", "i7ie.metal-48xl", "i8g.48xlarge", "c8gd.medium", "c8gd.large", "c8gd.xlarge", "c8gd.2xlarge", "c8gd.4xlarge", "c8gd.8xlarge", "c8gd.12xlarge", "c8gd.16xlarge", "c8gd.24xlarge", "c8gd.48xlarge", "c8gd.metal-24xl", "c8gd.metal-48xl", "i7i.large", "i7i.xlarge", "i7i.2xlarge", "i7i.4xlarge", "i7i.8xlarge", "i7i.12xlarge", "i7i.16xlarge", "i7i.24xlarge", "i7i.48xlarge", "i7i.metal-24xl", "i7i.metal-48xl", "p6-b200.48xlarge", "m8gd.medium", "m8gd.large", "m8gd.xlarge", "m8gd.2xlarge", "m8gd.4xlarge", "m8gd.8xlarge", "m8gd.12xlarge", "m8gd.16xlarge", "m8gd.24xlarge", "m8gd.48xlarge", "m8gd.metal-24xl", "m8gd.metal-48xl", "r8gd.medium", "r8gd.large", "r8gd.xlarge", "r8gd.2xlarge", "r8gd.4xlarge", "r8gd.8xlarge", "r8gd.12xlarge", "r8gd.16xlarge", "r8gd.24xlarge", "r8gd.48xlarge", "r8gd.metal-24xl", "r8gd.metal-48xl", "c8gn.medium", "c8gn.large", "c8gn.xlarge", "c8gn.2xlarge", "c8gn.4xlarge", "c8gn.8xlarge", "c8gn.12xlarge", "c8gn.16xlarge", "c8gn.24xlarge", "c8gn.48xlarge", "c8gn.metal-24xl", "c8gn.metal-48xl", "f2.6xlarge", "p6e-gb200.36xlarge", "g6f.large", "g6f.xlarge", "g6f.2xlarge", "g6f.4xlarge", "gr6f.4xlarge", "p5.4xlarge", "r8i.large", "r8i.xlarge", "r8i.2xlarge", "r8i.4xlarge", "r8i.8xlarge", "r8i.12xlarge", "r8i.16xlarge", "r8i.24xlarge", "r8i.32xlarge", "r8i.48xlarge", "r8i.96xlarge", "r8i.metal-48xl", "r8i.metal-96xl", "r8i-flex.large", "r8i-flex.xlarge", "r8i-flex.2xlarge", "r8i-flex.4xlarge", "r8i-flex.8xlarge", "r8i-flex.12xlarge", "r8i-flex.16xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-instancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaxPrice": { "MarkdownDocumentation": "`MaxPrice`\n\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not\nrecommend using this parameter because it can lead to increased interruptions. If you\ndo not specify this parameter, you will pay the current Spot price.\n###### Important\nIf you specify a maximum price, your instances will be interrupted more\nfrequently than if you do not specify this parameter.\nIf you specify a maximum price, it must be more than USD $0.001. Specifying a value\nbelow USD $0.001 will result in an `InvalidParameterValue` error\nmessage.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-maxprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::EC2Fleet.FleetLaunchTemplateSpecificationRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.FleetLaunchTemplateSpecificationRequest`\n\nSpecifies the launch template to be used by the EC2 Fleet for configuring Amazon EC2 instances.\nYou must specify the following:\n* The ID or the name of the launch template, but not both.\n* The version of the launch template.\n`FleetLaunchTemplateSpecificationRequest` is a property of the [FleetLaunchTemplateConfigRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html) property type.\nFor information about creating a launch template, see\n[AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and\n[Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template)\nin the *Amazon EC2 User Guide*.\nFor examples of launch templates, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html", "Properties": { "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nThe name of the launch template.\nYou must specify the `LaunchTemplateName` or the `LaunchTemplateId`, but not both.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\(\\)\\.\\-/_]+`\n*Minimum*: `3`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-launchtemplatename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe launch template version number, `$Latest`, or `$Default`. You must specify a value, otherwise the request fails.\nIf the value is `$Latest`, Amazon EC2 uses the latest version of the launch template.\nIf the value is `$Default`, Amazon EC2 uses the default version of the launch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nThe ID of the launch template.\nYou must specify the `LaunchTemplateId` or the `LaunchTemplateName`, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-launchtemplateid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::EC2Fleet.InstanceRequirementsRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.InstanceRequirementsRequest`\n\nThe attributes for the instance types. When you specify instance attributes, Amazon EC2 will\nidentify instance types with these attributes.\nYou must specify `VCpuCount` and `MemoryMiB`. All other attributes\nare optional. Any unspecified optional attribute is set to its default.\nWhen you specify multiple attributes, you get instance types that satisfy all of the\nspecified attributes. If you specify multiple values for an attribute, you get instance\ntypes that satisfy any of the specified values.\nTo limit the list of instance types from which Amazon EC2 can identify matching instance types,\nyou can use one of the following parameters, but not both in the same request:\n* `AllowedInstanceTypes` - The instance types to include in the list. All\n other instance types are ignored, even if they match your specified attributes.\n* `ExcludedInstanceTypes` - The instance types to exclude from the list,\n even if they match your specified attributes.\n###### Note\nIf you specify `InstanceRequirements`, you can't specify\n`InstanceType`.\nAttribute-based instance type selection is only supported when using Auto Scaling\ngroups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\nthe [launch instance\nwizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or\n[AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)AWS CloudFormation resource, you can't specify\n`InstanceRequirements`.\nFor more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot\nplacement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html", "Properties": { "InstanceGenerations": { "MarkdownDocumentation": "`InstanceGenerations`\n\nIndicates whether current or previous generation instance types are included. The\ncurrent generation instance types are recommended for use. Current generation instance types are\ntypically the latest two to three generations in each instance family. For more\ninformation, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the\n*Amazon EC2 User Guide*.\nFor current generation instance types, specify `current`.\nFor previous generation instance types, specify `previous`.\nDefault: Current and previous generation instance types\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `current | previous...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "current", "previous" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-instancegenerations", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RequireEncryptionInTransit": { "MarkdownDocumentation": "`RequireEncryptionInTransit`\n\nSpecifies whether instance types must support encrypting in-transit traffic between\ninstances. For more information, including the supported instance types, see [Encryption in\ntransit](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data-protection.html#encryption-transit) in the *Amazon EC2 User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-requireencryptionintransit", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MemoryGiBPerVCpu": { "MarkdownDocumentation": "`MemoryGiBPerVCpu`\n\nThe minimum and maximum amount of memory per vCPU, in GiB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [MemoryGiBPerVCpuRequest](./aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-memorygibpervcpu", "UpdateType": "Immutable", "Required": false, "Type": "MemoryGiBPerVCpuRequest" }, "AcceleratorTypes": { "MarkdownDocumentation": "`AcceleratorTypes`\n\nThe accelerator types that must be on the instance type.\n* For instance types with FPGA accelerators, specify `fpga`.\n* For instance types with GPU accelerators, specify `gpu`.\n* For instance types with Inference accelerators, specify `inference`.\n* For instance types with Media accelerators, specify `media`.\nDefault: Any accelerator type\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `gpu | fpga | inference | me...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "gpu", "fpga", "inference", "media" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratortypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VCpuCount": { "MarkdownDocumentation": "`VCpuCount`\n\nThe minimum and maximum number of vCPUs.\n*Required*: No\n*Type*: [VCpuCountRangeRequest](./aws-properties-ec2-ec2fleet-vcpucountrangerequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-vcpucount", "UpdateType": "Immutable", "Required": false, "Type": "VCpuCountRangeRequest" }, "AcceleratorManufacturers": { "MarkdownDocumentation": "`AcceleratorManufacturers`\n\nIndicates whether instance types must have accelerators by specific manufacturers.\n* For instance types with AWS devices, specify `amazon-web-services`.\n* For instance types with AMD devices, specify `amd`.\n* For instance types with Habana devices, specify `habana`.\n* For instance types with NVIDIA devices, specify `nvidia`.\n* For instance types with Xilinx devices, specify `xilinx`.\nDefault: Any manufacturer\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `amazon-web-services | amd |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "amazon-web-services", "amd", "habana", "nvidia", "xilinx" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratormanufacturers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LocalStorage": { "MarkdownDocumentation": "`LocalStorage`\n\nIndicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n[Amazon\nEC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.\n* To include instance types with instance store volumes, specify\n `included`.\n* To require only instance types with instance store volumes, specify\n `required`.\n* To exclude instance types with instance store volumes, specify\n `excluded`.\nDefault: `included`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-localstorage", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CpuManufacturers": { "MarkdownDocumentation": "`CpuManufacturers`\n\nThe CPU manufacturers to include.\n* For instance types with Intel CPUs, specify `intel`.\n* For instance types with AMD CPUs, specify `amd`.\n* For instance types with AWS CPUs, specify `amazon-web-services`.\n* For instance types with Apple CPUs, specify `apple`.\n###### Note\nDon't confuse the CPU manufacturer with the CPU architecture. Instances will\nbe launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you\nspecify in your launch template.\nDefault: Any manufacturer\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `intel | amd | amazon-web-se...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "intel", "amd", "amazon-web-services", "apple" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-cpumanufacturers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BareMetal": { "MarkdownDocumentation": "`BareMetal`\n\nIndicates whether bare metal instance types must be included, excluded, or required.\n* To include bare metal instance types, specify `included`.\n* To require only bare metal instance types, specify `required`.\n* To exclude bare metal instance types, specify `excluded`.\nDefault: `excluded`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-baremetal", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RequireHibernateSupport": { "MarkdownDocumentation": "`RequireHibernateSupport`\n\nIndicates whether instance types must support hibernation for On-Demand Instances.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-requirehibernatesupport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "MarkdownDocumentation": "`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`\n\n[Price protection] The price protection threshold for Spot Instances, as a percentage of an\nidentified On-Demand price. The identified On-Demand price is the price of the lowest\npriced current generation C, M, or R instance type with your specified attributes. If no\ncurrent generation C, M, or R instance type matches your attributes, then the identified\nprice is from the lowest priced current generation instance types, and failing that, from\nthe lowest priced previous generation instance types that match your attributes. When Amazon EC2\nselects instance types with your attributes, it will exclude instance types whose price\nexceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is based on the per vCPU or per\nmemory price instead of the per instance price.\n###### Note\nOnly one of `SpotMaxPricePercentageOverLowestPrice` or\n`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you\ndon't specify either, Amazon EC2 will automatically apply optimal price protection to\nconsistently select from a wide range of instance types. To indicate no price protection\nthreshold for Spot Instances, meaning you want to consider all instance types that match your\nattributes, include one of these parameters and specify a high value, such as\n`999999`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-maxspotpriceaspercentageofoptimalondemandprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "OnDemandMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`OnDemandMaxPricePercentageOverLowestPrice`\n\n[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than\nan identified On-Demand price. The identified On-Demand price is the price of the lowest\npriced current generation C, M, or R instance type with your specified attributes. When\nAmazon EC2 selects instance types with your attributes, it will exclude instance types whose\nprice exceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nTo indicate no price protection threshold, specify a high value, such as\n`999999`.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n###### Note\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is applied based on the\nper-vCPU or per-memory price instead of the per-instance price.\nDefault: `20`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-ondemandmaxpricepercentageoverlowestprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MemoryMiB": { "MarkdownDocumentation": "`MemoryMiB`\n\nThe minimum and maximum amount of memory, in MiB.\n*Required*: No\n*Type*: [MemoryMiBRequest](./aws-properties-ec2-ec2fleet-memorymibrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-memorymib", "UpdateType": "Immutable", "Required": false, "Type": "MemoryMiBRequest" }, "LocalStorageTypes": { "MarkdownDocumentation": "`LocalStorageTypes`\n\nThe type of local storage that is required.\n* For instance types with hard disk drive (HDD) storage, specify `hdd`.\n* For instance types with solid state drive (SSD) storage, specify\n `ssd`.\nDefault: `hdd` and `ssd`\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "AllowedValues": [ "hdd", "ssd" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-localstoragetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkInterfaceCount": { "MarkdownDocumentation": "`NetworkInterfaceCount`\n\nThe minimum and maximum number of network interfaces.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [NetworkInterfaceCountRequest](./aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-networkinterfacecount", "UpdateType": "Immutable", "Required": false, "Type": "NetworkInterfaceCountRequest" }, "ExcludedInstanceTypes": { "MarkdownDocumentation": "`ExcludedInstanceTypes`\n\nThe instance types to exclude.\nYou can use strings with one or more wild cards, represented by\nan asterisk (`*`), to exclude an instance family, type, size, or generation. The\nfollowing are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`,\n`r*`, `*3*`.\nFor example, if you specify `c5*`,Amazon EC2 will exclude the entire C5 instance\nfamily, which includes all C5a and C5n instance types. If you specify\n`m5a.*`, Amazon EC2 will exclude all the M5a instance types, but not the M5n\ninstance types.\n###### Note\nIf you specify `ExcludedInstanceTypes`, you can't specify `AllowedInstanceTypes`.\nDefault: No excluded instance types\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-excludedinstancetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedInstanceTypes": { "MarkdownDocumentation": "`AllowedInstanceTypes`\n\nThe instance types to apply your specified attributes against. All other instance types\nare ignored, even if they match your specified attributes.\nYou can use strings with one or more wild cards, represented by\nan asterisk (`*`), to allow an instance type, size, or generation. The\nfollowing are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`,\n`r*`, `*3*`.\nFor example, if you specify `c5*`,Amazon EC2 will allow the entire C5 instance\nfamily, which includes all C5a and C5n instance types. If you specify\n`m5a.*`, Amazon EC2 will allow all the M5a instance types, but not the M5n\ninstance types.\n###### Note\nIf you specify `AllowedInstanceTypes`, you can't specify `ExcludedInstanceTypes`.\nDefault: All instance types\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-allowedinstancetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkBandwidthGbps": { "MarkdownDocumentation": "`NetworkBandwidthGbps`\n\nThe minimum and maximum amount of baseline network bandwidth, in gigabits per second\n(Gbps). For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide*.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [NetworkBandwidthGbpsRequest](./aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-networkbandwidthgbps", "UpdateType": "Immutable", "Required": false, "Type": "NetworkBandwidthGbpsRequest" }, "AcceleratorCount": { "MarkdownDocumentation": "`AcceleratorCount`\n\nThe minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on\nan instance.\nTo exclude accelerator-enabled instance types, set `Max` to `0`.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [AcceleratorCountRequest](./aws-properties-ec2-ec2fleet-acceleratorcountrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratorcount", "UpdateType": "Immutable", "Required": false, "Type": "AcceleratorCountRequest" }, "BaselinePerformanceFactors": { "MarkdownDocumentation": "`BaselinePerformanceFactors`\n\nThe baseline performance to consider, using an instance family as a baseline reference.\nThe instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\nbaseline to guide instance type selection, but there is no guarantee that the selected\ninstance types will always exceed the baseline for every application. Currently, this\nparameter only supports CPU performance as a baseline performance factor. For more\ninformation, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: [BaselinePerformanceFactorsRequest](./aws-properties-ec2-ec2fleet-baselineperformancefactorsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-baselineperformancefactors", "UpdateType": "Immutable", "Required": false, "Type": "BaselinePerformanceFactorsRequest" }, "SpotMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`SpotMaxPricePercentageOverLowestPrice`\n\n[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\nan identified Spot price. The identified Spot price is the Spot price of the lowest priced\ncurrent generation C, M, or R instance type with your specified attributes. If no current\ngeneration C, M, or R instance type matches your attributes, then the identified Spot price\nis from the lowest priced current generation instance types, and failing that, from the\nlowest priced previous generation instance types that match your attributes. When Amazon EC2\nselects instance types with your attributes, it will exclude instance types whose Spot\nprice exceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is applied based on the\nper-vCPU or per-memory price instead of the per-instance price.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n###### Note\nOnly one of `SpotMaxPricePercentageOverLowestPrice` or\n`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you\ndon't specify either, Amazon EC2 will automatically apply optimal price protection to\nconsistently select from a wide range of instance types. To indicate no price protection\nthreshold for Spot Instances, meaning you want to consider all instance types that match your\nattributes, include one of these parameters and specify a high value, such as\n`999999`.\nDefault: `100`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-spotmaxpricepercentageoverlowestprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "BaselineEbsBandwidthMbps": { "MarkdownDocumentation": "`BaselineEbsBandwidthMbps`\n\nThe minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n[Amazon\nEBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [BaselineEbsBandwidthMbpsRequest](./aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-baselineebsbandwidthmbps", "UpdateType": "Immutable", "Required": false, "Type": "BaselineEbsBandwidthMbpsRequest" }, "AcceleratorNames": { "MarkdownDocumentation": "`AcceleratorNames`\n\nThe accelerators that must be on the instance type.\n* For instance types with NVIDIA A10G GPUs, specify `a10g`.\n* For instance types with NVIDIA A100 GPUs, specify `a100`.\n* For instance types with NVIDIA H100 GPUs, specify `h100`.\n* For instance types with AWS Inferentia chips, specify `inferentia`.\n* For instance types with AWS Inferentia2 chips, specify `inferentia2`.\n* For instance types with Habana Gaudi HL-205 GPUs, specify `gaudi-hl-205`.\n* For instance types with NVIDIA GRID K520 GPUs, specify `k520`.\n* For instance types with NVIDIA K80 GPUs, specify `k80`.\n* For instance types with NVIDIA L4 GPUs, specify `l4`.\n* For instance types with NVIDIA L40S GPUs, specify `l40s`.\n* For instance types with NVIDIA M60 GPUs, specify `m60`.\n* For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520`.\n* For instance types with AWS Trainium chips, specify `trainium`.\n* For instance types with AWS Trainium2 chips, specify `trainium2`.\n* For instance types with NVIDIA T4 GPUs, specify `t4`.\n* For instance types with NVIDIA T4G GPUs, specify `t4g`.\n* For instance types with Xilinx U30 cards, specify `u30`.\n* For instance types with Xilinx VU9P FPGAs, specify `vu9p`.\n* For instance types with NVIDIA V100 GPUs, specify `v100`.\nDefault: Any accelerator\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `a10g | a100 | h100 | infere...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "a10g", "a100", "h100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "t4g", "vu9p", "v100", "l40s", "l4", "gaudi-hl-205", "inferentia2", "trainium", "trainium2", "u30" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratornames", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AcceleratorTotalMemoryMiB": { "MarkdownDocumentation": "`AcceleratorTotalMemoryMiB`\n\nThe minimum and maximum amount of total accelerator memory, in MiB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [AcceleratorTotalMemoryMiBRequest](./aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratortotalmemorymib", "UpdateType": "Immutable", "Required": false, "Type": "AcceleratorTotalMemoryMiBRequest" }, "BurstablePerformance": { "MarkdownDocumentation": "`BurstablePerformance`\n\nIndicates whether burstable performance T instance types are included, excluded, or required. For more information, see\n[Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).\n* To include burstable performance instance types, specify `included`.\n* To require only burstable performance instance types, specify `required`.\n* To exclude burstable performance instance types, specify `excluded`.\nDefault: `excluded`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-burstableperformance", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TotalLocalStorageGB": { "MarkdownDocumentation": "`TotalLocalStorageGB`\n\nThe minimum and maximum amount of total local storage, in GB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [TotalLocalStorageGBRequest](./aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-totallocalstoragegb", "UpdateType": "Immutable", "Required": false, "Type": "TotalLocalStorageGBRequest" } } }, "AWS::EC2::EC2Fleet.MaintenanceStrategies": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.MaintenanceStrategies`\n\nThe strategies for managing your Spot Instances that are at an elevated risk of being\ninterrupted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-maintenancestrategies.html", "Properties": { "CapacityRebalance": { "MarkdownDocumentation": "`CapacityRebalance`\n\nThe strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\nelevated risk of being interrupted.\n*Required*: No\n*Type*: [CapacityRebalance](./aws-properties-ec2-ec2fleet-capacityrebalance.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-maintenancestrategies.html#cfn-ec2-ec2fleet-maintenancestrategies-capacityrebalance", "UpdateType": "Immutable", "Required": false, "Type": "CapacityRebalance" } } }, "AWS::EC2::EC2Fleet.MemoryGiBPerVCpuRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.MemoryGiBPerVCpuRequest`\n\nThe minimum and maximum amount of memory per vCPU, in GiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html#cfn-ec2-ec2fleet-memorygibpervcpurequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html#cfn-ec2-ec2fleet-memorygibpervcpurequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::EC2Fleet.MemoryMiBRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.MemoryMiBRequest`\n\nThe minimum and maximum amount of memory, in MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorymibrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory, in MiB. To specify no minimum limit, specify\n`0`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorymibrequest.html#cfn-ec2-ec2fleet-memorymibrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory, in MiB. To specify no maximum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorymibrequest.html#cfn-ec2-ec2fleet-memorymibrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::EC2Fleet.NetworkBandwidthGbpsRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.NetworkBandwidthGbpsRequest`\n\nThe minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n###### Note\nSetting the minimum bandwidth does not guarantee that your instance will achieve the\nminimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum\nbandwidth, but the actual bandwidth of your instance might go below the specified minimum\nat times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the\n*Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html#cfn-ec2-ec2fleet-networkbandwidthgbpsrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html#cfn-ec2-ec2fleet-networkbandwidthgbpsrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::EC2Fleet.NetworkInterfaceCountRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.NetworkInterfaceCountRequest`\n\nThe minimum and maximum number of network interfaces.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of network interfaces. To specify no minimum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html#cfn-ec2-ec2fleet-networkinterfacecountrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of network interfaces. To specify no maximum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html#cfn-ec2-ec2fleet-networkinterfacecountrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::EC2Fleet.OnDemandOptionsRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.OnDemandOptionsRequest`\n\nSpecifies the allocation strategy of On-Demand Instances in an EC2 Fleet.\n`OnDemandOptionsRequest` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html", "Properties": { "SingleAvailabilityZone": { "MarkdownDocumentation": "`SingleAvailabilityZone`\n\nIndicates that the fleet launches all On-Demand Instances into a single Availability Zone.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-singleavailabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "AllocationStrategy": { "MarkdownDocumentation": "`AllocationStrategy`\n\nThe strategy that determines the order of the launch template overrides to use in\nfulfilling On-Demand capacity.\n`lowest-price` - EC2 Fleet uses price to determine the order, launching the lowest\nprice first.\n`prioritized` - EC2 Fleet uses the priority that you assigned to each launch\ntemplate override, launching the highest priority first.\nDefault: `lowest-price`\n*Required*: No\n*Type*: String\n*Allowed values*: `lowest-price | prioritized...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "lowest-price", "prioritized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-allocationstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SingleInstanceType": { "MarkdownDocumentation": "`SingleInstanceType`\n\nIndicates that the fleet uses a single instance type to launch all On-Demand Instances in the\nfleet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-singleinstancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MinTargetCapacity": { "MarkdownDocumentation": "`MinTargetCapacity`\n\nThe minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't\nreached, no instances are launched.\nConstraints: Maximum value of `1000`. Supported only for fleets of type\n`instant`.\nAt least one of the following must be specified: `SingleAvailabilityZone` |\n`SingleInstanceType`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-mintargetcapacity", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MaxTotalPrice": { "MarkdownDocumentation": "`MaxTotalPrice`\n\nThe maximum amount per hour for On-Demand Instances that you're willing to pay.\n###### Note\nIf your fleet includes T instances that are configured as `unlimited`,\nand if their average CPU usage exceeds the baseline utilization, you will incur a charge\nfor surplus credits. The `MaxTotalPrice` does not account for surplus\ncredits, and, if you use surplus credits, your final cost might be higher than what you\nspecified for `MaxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-maxtotalprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CapacityReservationOptions": { "MarkdownDocumentation": "`CapacityReservationOptions`\n\nThe strategy for using unused Capacity Reservations for fulfilling On-Demand\ncapacity.\nSupported only for fleets of type `instant`.\n*Required*: No\n*Type*: [CapacityReservationOptionsRequest](./aws-properties-ec2-ec2fleet-capacityreservationoptionsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-capacityreservationoptions", "UpdateType": "Immutable", "Required": false, "Type": "CapacityReservationOptionsRequest" } } }, "AWS::EC2::EC2Fleet.PerformanceFactorReferenceRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.PerformanceFactorReferenceRequest`\n\nSpecify an instance family to use as the baseline reference for CPU performance. All\ninstance types that match your specified attributes will be compared against the CPU\nperformance of the referenced instance family, regardless of CPU manufacturer or\narchitecture.\n###### Note\nCurrently, only one instance family can be specified in the list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-performancefactorreferencerequest.html", "Properties": { "InstanceFamily": { "MarkdownDocumentation": "`InstanceFamily`\n\nThe instance family to use as a baseline reference.\n###### Note\nEnsure that you specify the correct value for the instance family. The instance\nfamily is everything before the period (`.`) in the instance type name. For\nexample, in the instance type `c6i.large`, the instance family is\n`c6i`, not `c6`. For more information, see [Amazon EC2\ninstance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance\nTypes*.\nThe following instance families are *not supported* for performance\nprotection:\n* `c1`\n* `g3` | `g3s`\n* `hpc7g`\n* `m1` | `m2`\n* `mac1` | `mac2` | `mac2-m1ultra` |\n `mac2-m2` | `mac2-m2pro`\n* `p3dn` | `p4d` | `p5`\n* `t1`\n* `u-12tb1` | `u-18tb1` | `u-24tb1` |\n `u-3tb1` | `u-6tb1` | `u-9tb1` |\n `u7i-12tb` | `u7in-16tb` | `u7in-24tb` |\n `u7in-32tb`\nIf you enable performance protection by specifying a supported instance family, the\nreturned instance types will exclude the above unsupported instance families.\nIf you specify an unsupported instance family as a value for baseline performance, the\nAPI returns an empty response response for [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) and an exception for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html), [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html), [ModifyFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyFleet.html), and [ModifySpotFleetRequest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySpotFleetRequest.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-performancefactorreferencerequest.html#cfn-ec2-ec2fleet-performancefactorreferencerequest-instancefamily", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::EC2Fleet.Placement": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.Placement`\n\nDescribes the placement of an instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the placement group that the instance is in.\nOn input, you can specify `GroupId` or `GroupName`,\nbut not both.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-groupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tenancy": { "MarkdownDocumentation": "`Tenancy`\n\nThe tenancy of the instance. An instance with a\ntenancy of `dedicated` runs on single-tenant hardware.\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). The\n`host` tenancy is not supported for [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) or\nfor T3 instances that are configured for the `unlimited` CPU credit\noption.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | dedicated | host...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "default", "dedicated", "host" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-tenancy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SpreadDomain": { "MarkdownDocumentation": "`SpreadDomain`\n\nReserved 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-spreaddomain", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PartitionNumber": { "MarkdownDocumentation": "`PartitionNumber`\n\nThe number of the partition that the instance is in. Valid only if the placement group\nstrategy is set to `partition`.\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-partitionnumber", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone of the instance.\nOn input, you can specify `AvailabilityZone` or `AvailabilityZoneId`,\nbut not both. If you specify neither one, Amazon EC2 automatically selects an Availability Zone\nfor you.\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Affinity": { "MarkdownDocumentation": "`Affinity`\n\nThe affinity setting for the instance on the Dedicated Host.\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-affinity", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HostId": { "MarkdownDocumentation": "`HostId`\n\nThe ID of the Dedicated Host on which the instance resides.\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-hostid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HostResourceGroupArn": { "MarkdownDocumentation": "`HostResourceGroupArn`\n\nThe ARN of the host resource group in which to launch the instances.\nOn input, if you specify this parameter, either omit the **Tenancy** parameter or set it to `host`.\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-hostresourcegrouparn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::EC2Fleet.SpotOptionsRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.SpotOptionsRequest`\n\nSpecifies the configuration of Spot Instances for an EC2 Fleet.\n`SpotOptionsRequest` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html", "Properties": { "SingleAvailabilityZone": { "MarkdownDocumentation": "`SingleAvailabilityZone`\n\nIndicates that the fleet launches all Spot Instances into a single Availability Zone.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-singleavailabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "AllocationStrategy": { "MarkdownDocumentation": "`AllocationStrategy`\n\nIndicates how to allocate the target Spot Instance capacity across the Spot Instance\npools specified by the EC2 Fleet.\nIf the allocation strategy is `lowestPrice`, EC2 Fleet launches instances\nfrom the Spot Instance pools with the lowest price. This is the default allocation\nstrategy.\nIf the allocation strategy is `diversified`, EC2 Fleet launches instances\nfrom all the Spot Instance pools that you specify.\nIf the allocation strategy is `capacityOptimized`, EC2 Fleet launches\ninstances from Spot Instance pools that are optimally chosen based on the available Spot\nInstance capacity.\n*Allowed Values*: `lowestPrice` | `diversified`\n| `capacityOptimized` | `capacityOptimizedPrioritized`\n*Required*: No\n*Type*: String\n*Allowed values*: `lowest-price | lowestPrice ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "lowest-price", "lowestPrice", "diversified", "capacityOptimized", "capacity-optimized", "capacityOptimizedPrioritized", "capacity-optimized-prioritized", "priceCapacityOptimized", "price-capacity-optimized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-allocationstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SingleInstanceType": { "MarkdownDocumentation": "`SingleInstanceType`\n\nIndicates that the fleet uses a single instance type to launch all Spot Instances in the\nfleet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-singleinstancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MinTargetCapacity": { "MarkdownDocumentation": "`MinTargetCapacity`\n\nThe minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't\nreached, no instances are launched.\nConstraints: Maximum value of `1000`. Supported only for fleets of type\n`instant`.\nAt least one of the following must be specified: `SingleAvailabilityZone` |\n`SingleInstanceType`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-mintargetcapacity", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MaxTotalPrice": { "MarkdownDocumentation": "`MaxTotalPrice`\n\nThe maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\nusing this parameter because it can lead to increased interruptions. If you do not specify\nthis parameter, you will pay the current Spot price.\n###### Important\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.\n\n###### Note\nIf your fleet includes T instances that are configured as `unlimited`, and\nif their average CPU usage exceeds the baseline utilization, you will incur a charge for\nsurplus credits. The `MaxTotalPrice` does not account for surplus credits,\nand, if you use surplus credits, your final cost might be higher than what you specified\nfor `MaxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-maxtotalprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaintenanceStrategies": { "MarkdownDocumentation": "`MaintenanceStrategies`\n\nThe strategies for managing your Spot Instances that are at an elevated risk of being\ninterrupted.\n*Required*: No\n*Type*: [MaintenanceStrategies](./aws-properties-ec2-ec2fleet-maintenancestrategies.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-maintenancestrategies", "UpdateType": "Immutable", "Required": false, "Type": "MaintenanceStrategies" }, "InstanceInterruptionBehavior": { "MarkdownDocumentation": "`InstanceInterruptionBehavior`\n\nThe behavior when a Spot Instance is interrupted.\nDefault: `terminate`\n*Required*: No\n*Type*: String\n*Allowed values*: `hibernate | stop | terminat...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "hibernate", "stop", "terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-instanceinterruptionbehavior", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstancePoolsToUseCount": { "MarkdownDocumentation": "`InstancePoolsToUseCount`\n\nThe number of Spot pools across which to allocate your target Spot capacity. Supported\nonly when Spot `AllocationStrategy` is set to `lowest-price`. EC2 Fleet\nselects the cheapest Spot pools and evenly allocates your target Spot capacity across the\nnumber of Spot pools that you specify.\nNote that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\nbest effort basis. If a pool runs out of Spot capacity before fulfilling your target\ncapacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\npool. To ensure that your target capacity is met, you might receive Spot Instances from more than\nthe number of pools that you specified. Similarly, if most of the pools have no Spot\ncapacity, you might receive your full target capacity from fewer than the number of pools\nthat you specified.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-instancepoolstousecount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::EC2Fleet.TagSpecification": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.TagSpecification`\n\nSpecifies the tags to apply to a resource when the resource is being created for an EC2\nFleet.\n`TagSpecification` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html", "Properties": { "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource to tag.\n*Required*: No\n*Type*: String\n*Allowed values*: `client-vpn-endpoint | custo...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "client-vpn-endpoint", "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", "internet-gateway", "key-pair", "launch-template", "local-gateway-route-table-vpc-association", "natgateway", "network-acl", "network-insights-analysis", "network-insights-path", "network-interface", "placement-group", "reserved-instances", "route-table", "security-group", "snapshot", "spot-fleet-request", "spot-instances-request", "subnet", "traffic-mirror-filter", "traffic-mirror-session", "traffic-mirror-target", "transit-gateway", "transit-gateway-attachment", "transit-gateway-connect-peer", "transit-gateway-multicast-domain", "transit-gateway-route-table", "volume", "vpc", "vpc-flow-log", "vpc-peering-connection", "vpn-connection", "vpn-gateway" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html#cfn-ec2-ec2fleet-tagspecification-resourcetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-ec2fleet-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html#cfn-ec2-ec2fleet-tagspecification-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::EC2::EC2Fleet.TargetCapacitySpecificationRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.TargetCapacitySpecificationRequest`\n\nSpecifies the number of units to request for an EC2 Fleet. You can choose to set the\ntarget capacity in terms of instances or a performance characteristic that is important to\nyour application workload, such as vCPUs, memory, or I/O. If the request type is\n`maintain`, you can specify a target capacity of `0` and add\ncapacity later.\n`TargetCapacitySpecificationRequest` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html", "Properties": { "DefaultTargetCapacityType": { "MarkdownDocumentation": "`DefaultTargetCapacityType`\n\nThe default target capacity type.\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)", "RefReturnValue": "", "AllowedValues": [ "on-demand", "spot" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-defaulttargetcapacitytype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TotalTargetCapacity": { "MarkdownDocumentation": "`TotalTargetCapacity`\n\nThe number of units to request, filled using the default target capacity type.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-totaltargetcapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "OnDemandTargetCapacity": { "MarkdownDocumentation": "`OnDemandTargetCapacity`\n\nThe number of On-Demand units to request.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-ondemandtargetcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SpotTargetCapacity": { "MarkdownDocumentation": "`SpotTargetCapacity`\n\nThe number of Spot units to request.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-spottargetcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetCapacityUnitType": { "MarkdownDocumentation": "`TargetCapacityUnitType`\n\nThe unit for the target capacity. You can specify this parameter only when using\nattributed-based instance type selection.\nDefault: `units` (the number of instances)\n*Required*: No\n*Type*: String\n*Allowed values*: `vcpu | memory-mib | units...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "vcpu", "memory-mib", "units" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-targetcapacityunittype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::EC2Fleet.TotalLocalStorageGBRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.TotalLocalStorageGBRequest`\n\nThe minimum and maximum amount of total local storage, in GB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of total local storage, in GB. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html#cfn-ec2-ec2fleet-totallocalstoragegbrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of total local storage, in GB. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html#cfn-ec2-ec2fleet-totallocalstoragegbrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::EC2Fleet.VCpuCountRangeRequest": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet.VCpuCountRangeRequest`\n\nThe minimum and maximum number of vCPUs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-vcpucountrangerequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of vCPUs. To specify no minimum limit, specify `0`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-vcpucountrangerequest.html#cfn-ec2-ec2fleet-vcpucountrangerequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of vCPUs. To specify no maximum limit, omit this parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-vcpucountrangerequest.html#cfn-ec2-ec2fleet-vcpucountrangerequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::FlowLog.DestinationOptions": { "MarkdownDocumentation": "`AWS::EC2::FlowLog.DestinationOptions`\n\nDescribes the destination options for a flow log.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html", "Properties": { "PerHourPartition": { "MarkdownDocumentation": "`PerHourPartition`\n\nIndicates whether to partition the flow log per hour. This reduces the cost and response\ntime for queries. The default is `false`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-perhourpartition", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "HiveCompatiblePartitions": { "MarkdownDocumentation": "`HiveCompatiblePartitions`\n\nIndicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.\nThe default is `false`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-hivecompatiblepartitions", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "FileFormat": { "MarkdownDocumentation": "`FileFormat`\n\nThe format for the flow log. The default is `plain-text`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `plain-text | parquet...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "plain-text", "parquet" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-fileformat", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::IPAM.IpamOperatingRegion": { "MarkdownDocumentation": "`AWS::EC2::IPAM.IpamOperatingRegion`\n\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipam-ipamoperatingregion.html", "Properties": { "RegionName": { "MarkdownDocumentation": "`RegionName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipam-ipamoperatingregion.html#cfn-ec2-ipam-ipamoperatingregion-regionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::IPAM.IpamOrganizationalUnitExclusion": { "MarkdownDocumentation": "`AWS::EC2::IPAM.IpamOrganizationalUnitExclusion`\n\nIf your IPAM is integrated with AWS Organizations,\nyou can exclude an [organizational unit (OU)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#organizationalunit) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see [Exclude organizational units from IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html) in the *Amazon Virtual Private Cloud IP Address Manager User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipam-ipamorganizationalunitexclusion.html", "Properties": { "OrganizationsEntityPath": { "MarkdownDocumentation": "`OrganizationsEntityPath`\n\nAn AWS Organizations entity path. For more information on the entity path, see [Understand the AWS Organizations entity path](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_last-accessed-view-data-orgs.html#access_policies_access-advisor-viewing-orgs-entity-path) in the *AWS Identity and Access Management User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipam-ipamorganizationalunitexclusion.html#cfn-ec2-ipam-ipamorganizationalunitexclusion-organizationsentitypath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::IPAMPool.ProvisionedCidr": { "MarkdownDocumentation": "`AWS::EC2::IPAMPool.ProvisionedCidr`\n\nThe CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask)\nand 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###### Note\nThis resource type does not allow you to provision a CIDR using the netmask length. To provision a CIDR using netmask length, use [AWS::EC2::IPAMPoolCidr](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-provisionedcidr.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask)\nand 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-provisionedcidr.html#cfn-ec2-ipampool-provisionedcidr-cidr", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::IPAMPool.SourceResource": { "MarkdownDocumentation": "`AWS::EC2::IPAMPool.SourceResource`\n\nThe resource used to provision CIDRs to a resource planning pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html", "Properties": { "ResourceRegion": { "MarkdownDocumentation": "`ResourceRegion`\n\nThe source resource Region.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html#cfn-ec2-ipampool-sourceresource-resourceregion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe source resource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html#cfn-ec2-ipampool-sourceresource-resourceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceOwner": { "MarkdownDocumentation": "`ResourceOwner`\n\nThe source resource owner.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html#cfn-ec2-ipampool-sourceresource-resourceowner", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe source resource type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `vpc`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "vpc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html#cfn-ec2-ipampool-sourceresource-resourcetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::IPAMResourceDiscovery.IpamOperatingRegion": { "MarkdownDocumentation": "`AWS::EC2::IPAMResourceDiscovery.IpamOperatingRegion`\n\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html", "Properties": { "RegionName": { "MarkdownDocumentation": "`RegionName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html#cfn-ec2-ipamresourcediscovery-ipamoperatingregion-regionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::IPAMResourceDiscovery.IpamResourceDiscoveryOrganizationalUnitExclusion": { "MarkdownDocumentation": "`AWS::EC2::IPAMResourceDiscovery.IpamResourceDiscoveryOrganizationalUnitExclusion`\n\nIf your IPAM is integrated with AWS Organizations,\nyou can exclude an [organizational unit (OU)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#organizationalunit) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see [Exclude organizational units from IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html) in the *Amazon Virtual Private Cloud IP Address Manager User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamresourcediscoveryorganizationalunitexclusion.html", "Properties": { "OrganizationsEntityPath": { "MarkdownDocumentation": "`OrganizationsEntityPath`\n\nAn AWS Organizations entity path. For more information on the entity path, see [Understand the AWS Organizations entity path](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_last-accessed-view-data-orgs.html#access_policies_access-advisor-viewing-orgs-entity-path) in the *AWS Identity and Access Management User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamresourcediscoveryorganizationalunitexclusion.html#cfn-ec2-ipamresourcediscovery-ipamresourcediscoveryorganizationalunitexclusion-organizationsentitypath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::IPAMScope.IpamScopeExternalAuthorityConfiguration": { "MarkdownDocumentation": "`AWS::EC2::IPAMScope.IpamScopeExternalAuthorityConfiguration`\n\nThe configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.\nIn IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to AWS while using Amazon VPC IPAM to manage subnets within those ranges.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration.html", "Properties": { "ExternalResourceIdentifier": { "MarkdownDocumentation": "`ExternalResourceIdentifier`\n\nThe identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format `.identity.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration.html#cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-externalresourceidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IpamScopeExternalAuthorityType": { "MarkdownDocumentation": "`IpamScopeExternalAuthorityType`\n\nThe type of external authority managing this scope. Currently supports `Infoblox` for integration with Infoblox Universal DDI.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `infoblox`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "infoblox" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration.html#cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-ipamscopeexternalauthoritytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.AssociationParameter": { "MarkdownDocumentation": "`AWS::EC2::Instance.AssociationParameter`\n\nSpecifies input parameter values for an SSM document in AWS Systems Manager.\n`AssociationParameter` is a property of the [SsmAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociation.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-associationparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of an input parameter.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-associationparameter.html#cfn-ec2-instance-associationparameter-value", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name of an input parameter that is in the associated SSM document.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-associationparameter.html#cfn-ec2-instance-associationparameter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.BlockDeviceMapping": { "MarkdownDocumentation": "`AWS::EC2::Instance.BlockDeviceMapping`\n\nSpecifies a block device mapping for an instance. You must specify exactly one of the\nfollowing properties: `VirtualName`, `Ebs`, or\n`NoDevice`.\n`BlockDeviceMapping` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\n###### Important\nAfter the instance is running, you can modify only the\n`DeleteOnTermination` parameter for the attached volumes without\ninterrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html", "Properties": { "Ebs": { "MarkdownDocumentation": "`Ebs`\n\nParameters used to automatically set up EBS volumes when the instance is\nlaunched.\n###### Important\nAfter the instance is running, you can modify only the\n`DeleteOnTermination` parameter for the attached volumes without\ninterrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt).\n*Required*: Conditional\n*Type*: [Ebs](./aws-properties-ec2-instance-ebs.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-ebs", "UpdateType": "Conditional", "Required": false, "Type": "Ebs" }, "NoDevice": { "MarkdownDocumentation": "`NoDevice`\n\nTo omit the device from the block device mapping, specify an empty string.\n###### Important\nAfter the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\n*Required*: Conditional\n*Type*: Json\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-nodevice", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Json" }, "VirtualName": { "MarkdownDocumentation": "`VirtualName`\n\nThe virtual device name (`ephemeral`N). The name must be in the form\n`ephemeral`*X* where *X* is a number\nstarting from zero (0). For example, an instance type with 2 available instance store\nvolumes can specify mappings for `ephemeral0` and `ephemeral1`. The\nnumber of available instance store volumes depends on the instance type. After you connect\nto the instance, you must mount the volume.\nNVMe instance store volumes are automatically enumerated and assigned a device name.\nIncluding them in your block device mapping has no effect.\n*Constraints*: For M3 instances, you must specify instance store volumes\nin the block device mapping for the instance. When you launch an M3 instance, we ignore any\ninstance store volumes specified in the block device mapping for the AMI.\n###### Important\nAfter the instance is running, modifying this parameter results in instance [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*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-virtualname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe device name. For available device names, see [Device names for volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html).\n###### Important\nAfter the instance is running, this parameter is used to specify the device name of\nthe block device mapping to update.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-devicename", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.CpuOptions": { "MarkdownDocumentation": "`AWS::EC2::Instance.CpuOptions`\n\nSpecifies the CPU options for the instance. When you specify CPU options, you must\nspecify both the number of CPU cores and threads per core.\nModifying the CPU options for an instance results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\nFor more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in\nthe *Amazon Elastic Compute Cloud User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html", "Properties": { "ThreadsPerCore": { "MarkdownDocumentation": "`ThreadsPerCore`\n\nThe number of threads per CPU core.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html#cfn-ec2-instance-cpuoptions-threadspercore", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "CoreCount": { "MarkdownDocumentation": "`CoreCount`\n\nThe number of CPU cores for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html#cfn-ec2-instance-cpuoptions-corecount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::Instance.CreditSpecification": { "MarkdownDocumentation": "`AWS::EC2::Instance.CreditSpecification`\n\nSpecifies the credit option for CPU usage of a T instance.\n`CreditSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\nFor more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html", "Properties": { "CPUCredits": { "MarkdownDocumentation": "`CPUCredits`\n\nThe credit option for CPU usage of the instance.\nValid values: `standard` | `unlimited`\nT3 instances with `host` tenancy do not support the `unlimited`\nCPU credit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html#cfn-ec2-instance-creditspecification-cpucredits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.Ebs": { "MarkdownDocumentation": "`AWS::EC2::Instance.Ebs`\n\nSpecifies a block device for an EBS volume.\n`Ebs` is a property of the [BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html) property type.\n###### Important\nAfter the instance is running, you can modify only the\n`DeleteOnTermination` parameters for the attached volumes without\ninterrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html", "Properties": { "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe ID of the snapshot.\nIf you specify both `SnapshotId` and `VolumeSize`,\n`VolumeSize` must be equal or greater than the size of the snapshot.\n###### Important\nAfter the instance is running, modifying this parameter results in instance [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*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-snapshotid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the\n*Amazon EC2 User Guide*. If the volume type is `io1` or\n`io2`, you must specify the IOPS that the volume supports.\n###### Important\nAfter the instance is running, modifying this parameter results in instance [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*Allowed values*: `standard | io1 | io2 | gp2 ...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-volumetype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe identifier of the AWS KMS key to use for Amazon EBS encryption. If\n`KmsKeyId` is specified, the encrypted state must be `true`. If\nthe encrypted state is `true` but you do not specify `KmsKeyId`, your\nKMS key for EBS is used.\nYou can specify the KMS key using any of the following:\n* Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.\n* Key alias. For example, alias/ExampleAlias.\n* Key ARN. For example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.\n* Alias ARN. For example,\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias.\n###### Important\nAfter the instance is running, modifying this parameter results in instance [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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-kmskeyid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nIndicates whether the volume should be encrypted. The effect of setting the encryption\nstate to `true` depends on the volume origin (new or from a snapshot), starting\nencryption state, ownership, and whether encryption by default is enabled. For more\ninformation, see [Encryption by\ndefault](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User\nGuide*.\nEncrypted Amazon EBS volumes must be attached to instances that support Amazon EBS\nencryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).\n###### Important\nAfter the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-encrypted", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS). For `gp3`, `io1`,\nand `io2` volumes, this represents the number of IOPS that are provisioned for\nthe volume. For `gp2` volumes, this represents the baseline performance of the\nvolume and the rate at which the volume accumulates I/O credits for bursting.\nThe following are the supported values for each volume type:\n* `gp3`: 3,000-16,000 IOPS\n* `io1`: 100-64,000 IOPS\n* `io2`: 100-64,000 IOPS\nFor `io1` and `io2` volumes, we guarantee 64,000 IOPS only for\n[Instances built on\nthe Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). Other instance families guarantee performance up to 32,000\nIOPS.\nThis parameter is required for `io1` and `io2` volumes. The\ndefault for `gp3` volumes is 3,000 IOPS. This parameter is not supported for\n`gp2`, `st1`, `sc1`, or `standard`\nvolumes.\n###### Important\nAfter the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-iops", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.\nIf you specify a snapshot, the default is the snapshot size. You can specify a volume size\nthat is equal to or larger than the snapshot size.\nThe following are the supported volumes sizes for each volume type:\n* `gp2` and `gp3`:1-16,384\n* `io1` and `io2`: 4-16,384\n* `st1` and `sc1`: 125-16,384\n* `standard`: 1-1,024\n###### Important\nAfter the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-volumesize", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nIndicates whether the EBS volume is deleted on instance termination. For more\ninformation, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon\nEC2 User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-deleteontermination", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::Instance.ElasticGpuSpecification": { "MarkdownDocumentation": "`AWS::EC2::Instance.ElasticGpuSpecification`\n\n###### Note\nAmazon Elastic Graphics reached end of life on January 8, 2024.\nSpecifies the type of Elastic GPU. An Elastic GPU is a GPU resource that you can attach\nto your Amazon EC2 instance to accelerate the graphics performance of your applications.\n`ElasticGpuSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of Elastic Graphics accelerator.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html#cfn-ec2-instance-elasticgpuspecification-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.ElasticInferenceAccelerator": { "MarkdownDocumentation": "`AWS::EC2::Instance.ElasticInferenceAccelerator`\n\n###### Note\nAmazon Elastic Inference is no longer available.\nSpecifies the Elastic Inference Accelerator for the instance.\n`ElasticInferenceAccelerator` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of elastic inference accelerator. The possible values are `eia1.medium`, `eia1.large`, `eia1.xlarge`, `eia2.medium`, `eia2.large`, and `eia2.xlarge`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Count": { "MarkdownDocumentation": "`Count`\n\nThe number of elastic inference accelerators to attach to the instance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-count", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::Instance.EnaSrdSpecification": { "MarkdownDocumentation": "`AWS::EC2::Instance.EnaSrdSpecification`\n\nENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the\nmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.\nWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same\naccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\nTo improve the reliability of network packet delivery, ENA Express reorders network packets on the\nreceiving end by default. However, some UDP-based applications are designed to handle network packets\nthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express\nis enabled, you can specify whether UDP network traffic uses it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enasrdspecification.html", "Properties": { "EnaSrdEnabled": { "MarkdownDocumentation": "`EnaSrdEnabled`\n\nIndicates whether ENA Express is enabled for the network interface.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enasrdspecification.html#cfn-ec2-instance-enasrdspecification-enasrdenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EnaSrdUdpSpecification": { "MarkdownDocumentation": "`EnaSrdUdpSpecification`\n\nConfigures ENA Express for UDP network traffic.\n*Required*: No\n*Type*: [EnaSrdUdpSpecification](./aws-properties-ec2-instance-enasrdudpspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enasrdspecification.html#cfn-ec2-instance-enasrdspecification-enasrdudpspecification", "UpdateType": "Immutable", "Required": false, "Type": "EnaSrdUdpSpecification" } } }, "AWS::EC2::Instance.EnaSrdUdpSpecification": { "MarkdownDocumentation": "`AWS::EC2::Instance.EnaSrdUdpSpecification`\n\nENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic\nautomatically uses it. However, some UDP-based applications are designed to handle network packets that are\nout of order, without a need for retransmission, such as live video broadcasting or other near-real-time\napplications. For UDP traffic, you can specify whether to use ENA Express, based on your application\nenvironment needs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enasrdudpspecification.html", "Properties": { "EnaSrdUdpEnabled": { "MarkdownDocumentation": "`EnaSrdUdpEnabled`\n\nIndicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting,\nyou must first enable ENA Express.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enasrdudpspecification.html#cfn-ec2-instance-enasrdudpspecification-enasrdudpenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::Instance.EnclaveOptions": { "MarkdownDocumentation": "`AWS::EC2::Instance.EnclaveOptions`\n\nIndicates whether the instance is enabled for AWS Nitro\nEnclaves.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enclaveoptions.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIf this parameter is set to `true`, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro\nEnclaves.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enclaveoptions.html#cfn-ec2-instance-enclaveoptions-enabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::Instance.HibernationOptions": { "MarkdownDocumentation": "`AWS::EC2::Instance.HibernationOptions`\n\nSpecifies the hibernation options for the instance.\n`HibernationOptions` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-hibernationoptions.html", "Properties": { "Configured": { "MarkdownDocumentation": "`Configured`\n\nSet to `true` to enable your instance for hibernation.\nFor Spot Instances, if you set `Configured` to `true`, either\nomit the `InstanceInterruptionBehavior` parameter (for [`SpotMarketOptions`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html)), or set it to\n`hibernate`. When `Configured` is true:\n* If you omit `InstanceInterruptionBehavior`, it defaults to\n `hibernate`.\n* If you set `InstanceInterruptionBehavior` to a value other than\n `hibernate`, you'll get an error.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-hibernationoptions.html#cfn-ec2-instance-hibernationoptions-configured", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::Instance.InstanceIpv6Address": { "MarkdownDocumentation": "`AWS::EC2::Instance.InstanceIpv6Address`\n\nSpecifies the IPv6 address for the instance.\n`InstanceIpv6Address` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html", "Properties": { "Ipv6Address": { "MarkdownDocumentation": "`Ipv6Address`\n\nThe IPv6 address.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html#cfn-ec2-instance-instanceipv6address-ipv6address", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.LaunchTemplateSpecification": { "MarkdownDocumentation": "`AWS::EC2::Instance.LaunchTemplateSpecification`\n\nSpecifies a launch template to use when launching an Amazon EC2 instance.\nYou must specify the following:\n* The ID or the name of the launch template, but not both.\n* The version of the launch template.\nFor information about creating a launch template, see\n[AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and\n[Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template)\nin the *Amazon EC2 User Guide*. For example launch templates, see the\n[Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) for `AWS::EC2::LaunchTemplate`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html", "Properties": { "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nThe name of the launch template.\nYou must specify either the launch template ID or the\nlaunch template name, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplatename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version number of the launch template. You must specify this property.\nTo specify the default version of the template, use the `Fn::GetAtt`\nintrinsic function to retrieve the `DefaultVersionNumber` attribute\nof the launch template. To specify the latest version of the template, use\n`Fn::GetAtt` to retrieve the `LatestVersionNumber` attribute.\nFor more information, see [AWS::EC2:LaunchTemplate return values for Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate-return-values-fn--getatt).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nThe ID of the launch template.\nYou must specify either the launch template ID or the\nlaunch template name, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplateid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.LicenseSpecification": { "MarkdownDocumentation": "`AWS::EC2::Instance.LicenseSpecification`\n\nSpecifies the license configuration to use.\n`LicenseSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-licensespecification.html", "Properties": { "LicenseConfigurationArn": { "MarkdownDocumentation": "`LicenseConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the license 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-licensespecification.html#cfn-ec2-instance-licensespecification-licenseconfigurationarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.MetadataOptions": { "MarkdownDocumentation": "`AWS::EC2::Instance.MetadataOptions`\n\nSpecifies the metadata options for the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-metadataoptions.html", "Properties": { "HttpPutResponseHopLimit": { "MarkdownDocumentation": "`HttpPutResponseHopLimit`\n\nThe maximum number of hops that the metadata token can travel.\nPossible values: Integers from 1 to 64\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-metadataoptions.html#cfn-ec2-instance-metadataoptions-httpputresponsehoplimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HttpProtocolIpv6": { "MarkdownDocumentation": "`HttpProtocolIpv6`\n\nEnables or disables the IPv6 endpoint for the instance metadata service.\nDefault: `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)", "RefReturnValue": "", "AllowedValues": [ "disabled", "enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-metadataoptions.html#cfn-ec2-instance-metadataoptions-httpprotocolipv6", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpTokens": { "MarkdownDocumentation": "`HttpTokens`\n\nIndicates whether IMDSv2 is required.\n* `optional` - IMDSv2 is optional, which means that you can use\n either IMDSv2 or IMDSv1.\n* `required` - IMDSv2 is required, which means that IMDSv1 is\n disabled, and you must use IMDSv2.\nDefault:\n* If the value of `ImdsSupport` for the Amazon Machine Image (AMI)\n for your instance is `v2.0` and the account level default is set to\n `no-preference`, the default is `required`.\n* If the value of `ImdsSupport` for the Amazon Machine Image (AMI)\n for your instance is `v2.0`, but the account level default is set to\n `V1 or V2`, the default is `optional`.\nThe default value can also be affected by other combinations of parameters. For more\ninformation, see [Order of precedence for instance metadata options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) in the\n*Amazon EC2 User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "optional", "required" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-metadataoptions.html#cfn-ec2-instance-metadataoptions-httptokens", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceMetadataTags": { "MarkdownDocumentation": "`InstanceMetadataTags`\n\nSet to `enabled` to allow access to instance tags from the instance\nmetadata. Set to `disabled` to turn off access to instance tags from the\ninstance metadata. For more information, see [Work with\ninstance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS).\nDefault: `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)", "RefReturnValue": "", "AllowedValues": [ "disabled", "enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-metadataoptions.html#cfn-ec2-instance-metadataoptions-instancemetadatatags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpEndpoint": { "MarkdownDocumentation": "`HttpEndpoint`\n\nEnables or disables the HTTP metadata endpoint on your instances.\nIf you specify a value of `disabled`, you cannot access your instance\nmetadata.\nDefault: `enabled`\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)", "RefReturnValue": "", "AllowedValues": [ "disabled", "enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-metadataoptions.html#cfn-ec2-instance-metadataoptions-httpendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.NetworkInterface": { "MarkdownDocumentation": "`AWS::EC2::Instance.NetworkInterface`\n\nSpecifies a network interface that is to be attached to an instance.\nYou can create a network interface when launching an instance. For an example, see the\n[AWS::EC2::Instance examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#aws-properties-ec2-instance--examples--Automatically_assign_a_public_IP_address).\nAlternatively, you can attach an existing network interface when launching an instance.\nFor an example, see the [AWS::EC2:NetworkInterface examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#aws-resource-ec2-networkinterface--examples).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the network interface. Applies only if creating a network interface\nwhen launching an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe private IPv4 address of the network interface. Applies only if creating a network\ninterface when launching an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-privateipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PrivateIpAddresses": { "MarkdownDocumentation": "`PrivateIpAddresses`\n\nOne or more private IPv4 addresses to assign to the network interface. Only one private\nIPv4 address can be designated as primary.\n*Required*: No\n*Type*: Array of [PrivateIpAddressSpecification](./aws-properties-ec2-instance-privateipaddressspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-privateipaddresses", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "PrivateIpAddressSpecification", "DuplicatesAllowed": true }, "SecondaryPrivateIpAddressCount": { "MarkdownDocumentation": "`SecondaryPrivateIpAddressCount`\n\nThe number of secondary private IPv4 addresses. You can't specify this option and\nspecify more than one private IP address using the private IP addresses option.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-secondaryprivateipaddresscount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DeviceIndex": { "MarkdownDocumentation": "`DeviceIndex`\n\nThe position of the network interface in the attachment order. A primary network\ninterface has a device index of 0.\nIf you create a network interface when launching an instance, you must specify the\ndevice index.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-deviceindex", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GroupSet": { "MarkdownDocumentation": "`GroupSet`\n\nThe IDs of the security groups for the network interface. Applies only if creating a\nnetwork interface when launching an instance.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-groupset", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Ipv6Addresses": { "MarkdownDocumentation": "`Ipv6Addresses`\n\nThe IPv6 addresses to assign to the network interface. You cannot specify this option\nand the option to assign a number of IPv6 addresses in the same request. You cannot\nspecify this option if you've specified a minimum number of instances to launch.\n*Required*: No\n*Type*: Array of [InstanceIpv6Address](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-ipv6addresses", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "InstanceIpv6Address", "DuplicatesAllowed": true }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet associated with the network 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-subnetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AssociatePublicIpAddress": { "MarkdownDocumentation": "`AssociatePublicIpAddress`\n\nIndicates whether to assign a public IPv4 address to an instance. Applies only if\ncreating a network interface when launching an instance. The network interface must be the\nprimary network interface. If launching into a default subnet, the default value is\n`true`.\nAWS charges for all public IPv4 addresses, including public IPv4 addresses\nassociated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab\non the [VPC pricing page](https://aws.amazon.com/vpc/pricing/).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-associatepublicipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of the network interface, when attaching an existing network 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-networkinterfaceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AssociateCarrierIpAddress": { "MarkdownDocumentation": "`AssociateCarrierIpAddress`\n\nIndicates whether to assign a carrier IP address to the network interface.\nYou can only assign a carrier IP address to a network interface that is in a subnet in\na Wavelength Zone. For more information about carrier IP addresses, see [Carrier IP address](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *AWS Wavelength Developer\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-associatecarrieripaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EnaSrdSpecification": { "MarkdownDocumentation": "`EnaSrdSpecification`\n\nConfigures ENA Express for UDP network traffic.\n*Required*: No\n*Type*: [EnaSrdSpecification](./aws-properties-ec2-instance-enasrdspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-enasrdspecification", "UpdateType": "Immutable", "Required": false, "Type": "EnaSrdSpecification" }, "Ipv6AddressCount": { "MarkdownDocumentation": "`Ipv6AddressCount`\n\nA number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the\nIPv6 addresses from the range of the subnet. You cannot specify this option and the\noption to assign specific IPv6 addresses in the same request. You can specify this\noption if you've specified a minimum number of instances to launch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-ipv6addresscount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nIndicates whether the network interface is deleted when the instance is terminated.\nApplies only if creating a network interface when launching an instance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-deleteontermination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::Instance.PrivateDnsNameOptions": { "MarkdownDocumentation": "`AWS::EC2::Instance.PrivateDnsNameOptions`\n\nThe type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an\ninstance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance\nDNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\nnames use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html", "Properties": { "EnableResourceNameDnsARecord": { "MarkdownDocumentation": "`EnableResourceNameDnsARecord`\n\nIndicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsarecord", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "HostnameType": { "MarkdownDocumentation": "`HostnameType`\n\nThe type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an\ninstance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance\nDNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\nnames use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `ip-name | resource-name...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ip-name", "resource-name" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-hostnametype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "EnableResourceNameDnsAAAARecord": { "MarkdownDocumentation": "`EnableResourceNameDnsAAAARecord`\n\nIndicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsaaaarecord", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::Instance.PrivateIpAddressSpecification": { "MarkdownDocumentation": "`AWS::EC2::Instance.PrivateIpAddressSpecification`\n\nSpecifies a secondary private IPv4 address for a network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privateipaddressspecification.html", "Properties": { "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe private IPv4 address.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privateipaddressspecification.html#cfn-ec2-instance-privateipaddressspecification-privateipaddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Primary": { "MarkdownDocumentation": "`Primary`\n\nIndicates whether the private IPv4 address is the primary private IPv4 address. Only\none IPv4 address can be designated as primary.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privateipaddressspecification.html#cfn-ec2-instance-privateipaddressspecification-primary", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::EC2::Instance.SsmAssociation": { "MarkdownDocumentation": "`AWS::EC2::Instance.SsmAssociation`\n\nSpecifies the SSM document and parameter values in AWS Systems Manager to associate\nwith an instance.\n`SsmAssociations` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociation.html", "Properties": { "AssociationParameters": { "MarkdownDocumentation": "`AssociationParameters`\n\nThe input parameter values to use with the associated SSM document.\n*Required*: No\n*Type*: Array of [AssociationParameter](./aws-properties-ec2-instance-associationparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociation.html#cfn-ec2-instance-ssmassociation-associationparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AssociationParameter", "DuplicatesAllowed": true }, "DocumentName": { "MarkdownDocumentation": "`DocumentName`\n\nThe name of an SSM document to associate with 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociation.html#cfn-ec2-instance-ssmassociation-documentname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.State": { "MarkdownDocumentation": "`AWS::EC2::Instance.State`\n\nDescribes the current state of an instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html", "Properties": { "Code": { "MarkdownDocumentation": "`Code`\n\nThe state of the instance as a 16-bit unsigned integer.\nThe high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\nbetween 256 and 65,535. These numerical values are used for internal purposes and should\nbe ignored.\nThe low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\nbetween 0 and 255.\nThe valid values for instance-state-code will all be in the range of the low byte and\nthey are:\n* `0` : `pending`\n* `16` : `running`\n* `32` : `shutting-down`\n* `48` : `terminated`\n* `64` : `stopping`\n* `80` : `stopped`\nYou can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\ndecimal.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html#cfn-ec2-instance-state-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe current state of the instance.\n*Required*: No\n*Type*: String\n*Allowed values*: `pending | running | shuttin...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html#cfn-ec2-instance-state-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::Instance.Volume": { "MarkdownDocumentation": "`AWS::EC2::Instance.Volume`\n\nSpecifies a volume to attach to an instance.\n`Volume` is an embedded property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-volume.html", "Properties": { "VolumeId": { "MarkdownDocumentation": "`VolumeId`\n\nThe ID of the EBS volume. The volume and instance must be within the same Availability\nZone.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-volume.html#cfn-ec2-instance-volume-volumeid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Device": { "MarkdownDocumentation": "`Device`\n\nThe device name (for example, `/dev/sdh` or `xvdh`).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-volume.html#cfn-ec2-instance-volume-device", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.AcceleratorCount": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.AcceleratorCount`\n\nThe minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips)\non an instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratorcount.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of accelerators. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratorcount.html#cfn-ec2-launchtemplate-acceleratorcount-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of accelerators. To specify no maximum limit, omit this\nparameter. To exclude accelerator-enabled instance types, set `Max` to\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratorcount.html#cfn-ec2-launchtemplate-acceleratorcount-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::LaunchTemplate.AcceleratorTotalMemoryMiB": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.AcceleratorTotalMemoryMiB`\n\nThe minimum and maximum amount of total accelerator memory, in MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html#cfn-ec2-launchtemplate-acceleratortotalmemorymib-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html#cfn-ec2-launchtemplate-acceleratortotalmemorymib-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::LaunchTemplate.BaselineEbsBandwidthMbps": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.BaselineEbsBandwidthMbps`\n\nThe minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n[Amazon\nEBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit\nthis parameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html#cfn-ec2-launchtemplate-baselineebsbandwidthmbps-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit\nthis parameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html#cfn-ec2-launchtemplate-baselineebsbandwidthmbps-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::LaunchTemplate.BaselinePerformanceFactors": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.BaselinePerformanceFactors`\n\nThe baseline performance to consider, using an instance family as a baseline reference.\nThe instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\nbaseline to guide instance type selection, but there is no guarantee that the selected\ninstance types will always exceed the baseline for every application.\nCurrently, this parameter only supports CPU performance as a baseline performance\nfactor. For example, specifying `c6i` would use the CPU performance of the\n`c6i` family as the baseline reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineperformancefactors.html", "Properties": { "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe CPU performance to consider, using an instance family as the baseline reference.\n*Required*: No\n*Type*: [Cpu](./aws-properties-ec2-launchtemplate-cpu.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineperformancefactors.html#cfn-ec2-launchtemplate-baselineperformancefactors-cpu", "UpdateType": "Mutable", "Required": false, "Type": "Cpu" } } }, "AWS::EC2::LaunchTemplate.BlockDeviceMapping": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.BlockDeviceMapping`\n\nSpecifies a block device mapping for a launch template. You must specify `DeviceName`\nplus exactly one of the following properties: `Ebs`, `NoDevice`, or `VirtualName`.\n`BlockDeviceMapping` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html", "Properties": { "Ebs": { "MarkdownDocumentation": "`Ebs`\n\nParameters used to automatically set up EBS volumes when the instance is\nlaunched.\n*Required*: No\n*Type*: [Ebs](./aws-properties-ec2-launchtemplate-ebs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs", "UpdateType": "Mutable", "Required": false, "Type": "Ebs" }, "NoDevice": { "MarkdownDocumentation": "`NoDevice`\n\nTo omit the device from the block device mapping, specify 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-nodevice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VirtualName": { "MarkdownDocumentation": "`VirtualName`\n\nThe virtual device name (ephemeralN). Instance store volumes are numbered starting\nfrom 0. An instance type with 2 available instance store volumes can specify mappings\nfor ephemeral0 and ephemeral1. The number of available instance store volumes depends on\nthe instance type. After you connect to the instance, you must mount 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-virtualname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe device name (for example, /dev/sdh or xvdh).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-devicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.CapacityReservationSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.CapacityReservationSpecification`\n\nSpecifies an instance's Capacity Reservation targeting option. You can specify only one\noption at a time.\n`CapacityReservationSpecification` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationspecification.html", "Properties": { "CapacityReservationPreference": { "MarkdownDocumentation": "`CapacityReservationPreference`\n\nIndicates the instance's Capacity Reservation preferences. Possible preferences\ninclude:\n* `capacity-reservations-only` - The instance will only run in a\n Capacity Reservation or Capacity Reservation group. If capacity isn't available,\n the instance will fail to launch.\n* `open` - The instance can run in any `open` Capacity\n Reservation that has matching attributes (instance type, platform, Availability\n Zone, tenancy).\n* `none` - The instance avoids running in a Capacity Reservation even\n if one is available. The instance runs in On-Demand capacity.\n*Required*: No\n*Type*: String\n*Allowed values*: `capacity-reservations-only ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "capacity-reservations-only", "open", "none" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationspecification.html#cfn-ec2-launchtemplate-capacityreservationspecification-capacityreservationpreference", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityReservationTarget": { "MarkdownDocumentation": "`CapacityReservationTarget`\n\nInformation about the target Capacity Reservation or Capacity Reservation\ngroup.\n*Required*: No\n*Type*: [CapacityReservationTarget](./aws-properties-ec2-launchtemplate-capacityreservationtarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationspecification.html#cfn-ec2-launchtemplate-capacityreservationspecification-capacityreservationtarget", "UpdateType": "Mutable", "Required": false, "Type": "CapacityReservationTarget" } } }, "AWS::EC2::LaunchTemplate.CapacityReservationTarget": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.CapacityReservationTarget`\n\nSpecifies a target Capacity Reservation.\n`CapacityReservationTarget` is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html", "Properties": { "CapacityReservationResourceGroupArn": { "MarkdownDocumentation": "`CapacityReservationResourceGroupArn`\n\nThe ARN of the Capacity Reservation resource group in which to run the\ninstance.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html#cfn-ec2-launchtemplate-capacityreservationtarget-capacityreservationresourcegrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityReservationId": { "MarkdownDocumentation": "`CapacityReservationId`\n\nThe ID of the Capacity Reservation in which to run the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html#cfn-ec2-launchtemplate-capacityreservationtarget-capacityreservationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.ConnectionTrackingSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.ConnectionTrackingSpecification`\n\nA security group connection tracking specification that enables you to set the idle\ntimeout for connection tracking on an Elastic network interface. For more information,\nsee [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the\n*Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-connectiontrackingspecification.html", "Properties": { "UdpTimeout": { "MarkdownDocumentation": "`UdpTimeout`\n\nTimeout (in seconds) for idle UDP flows that\nhave seen traffic only in a single direction or a single request-response\ntransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-connectiontrackingspecification.html#cfn-ec2-launchtemplate-connectiontrackingspecification-udptimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TcpEstablishedTimeout": { "MarkdownDocumentation": "`TcpEstablishedTimeout`\n\nTimeout (in seconds) for idle TCP\nconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\ndays). Default: 432000 seconds. Recommended: Less than 432000 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-connectiontrackingspecification.html#cfn-ec2-launchtemplate-connectiontrackingspecification-tcpestablishedtimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UdpStreamTimeout": { "MarkdownDocumentation": "`UdpStreamTimeout`\n\nTimeout (in seconds) for idle UDP\nflows classified as streams which have seen more than one request-response\ntransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\nseconds.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-connectiontrackingspecification.html#cfn-ec2-launchtemplate-connectiontrackingspecification-udpstreamtimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::LaunchTemplate.Cpu": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.Cpu`\n\nSpecifies the CPU performance to consider when using an instance family as the baseline reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpu.html", "Properties": { "References": { "MarkdownDocumentation": "`References`\n\nThe instance family to use as the baseline reference for CPU performance. All\ninstance types that match your specified attributes are compared against the CPU\nperformance of the referenced instance family, regardless of CPU manufacturer or\narchitecture differences.\n*Required*: No\n*Type*: Array of [Reference](./aws-properties-ec2-launchtemplate-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpu.html#cfn-ec2-launchtemplate-cpu-references", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Reference", "DuplicatesAllowed": false } } }, "AWS::EC2::LaunchTemplate.CpuOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.CpuOptions`\n\nSpecifies the CPU options for an instance. For more information, see [Optimize\nCPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User\nGuide*.\n`CpuOptions` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpuoptions.html", "Properties": { "ThreadsPerCore": { "MarkdownDocumentation": "`ThreadsPerCore`\n\nThe number of threads per CPU core. To disable multithreading for the instance,\nspecify a value of `1`. Otherwise, specify the default value of\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpuoptions.html#cfn-ec2-launchtemplate-cpuoptions-threadspercore", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AmdSevSnp": { "MarkdownDocumentation": "`AmdSevSnp`\n\nIndicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported\nwith M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP for\nAmazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `enabled | disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enabled", "disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpuoptions.html#cfn-ec2-launchtemplate-cpuoptions-amdsevsnp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CoreCount": { "MarkdownDocumentation": "`CoreCount`\n\nThe number of CPU cores for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpuoptions.html#cfn-ec2-launchtemplate-cpuoptions-corecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::LaunchTemplate.CreditSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.CreditSpecification`\n\nSpecifies the credit option for CPU usage of a T2, T3, or T3a instance.\n`CreditSpecification` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-creditspecification.html", "Properties": { "CpuCredits": { "MarkdownDocumentation": "`CpuCredits`\n\nThe credit option for CPU usage of a T instance.\nValid values: `standard` | `unlimited`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-creditspecification.html#cfn-ec2-launchtemplate-creditspecification-cpucredits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.Ebs": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.Ebs`\n\nParameters for a block device for an EBS volume in an Amazon EC2 launch template.\n`Ebs` is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html", "Properties": { "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-snapshotid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the\n*Amazon EBS User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | io1 | io2 | gp2 ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-volumetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nIdentifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nIndicates whether the EBS volume is encrypted. Encrypted volumes can only be attached\nto instances that support Amazon EBS encryption. If you are creating a volume from a\nsnapshot, you can't specify an encryption 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-encrypted", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Throughput": { "MarkdownDocumentation": "`Throughput`\n\nThe throughput to provision for a `gp3` volume, with a maximum of 2,000\nMiB/s.\nValid Range: Minimum value of 125. Maximum value of 2,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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-throughput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS). For `gp3`,\n`io1`, and `io2` volumes, this represents the number of IOPS that\nare provisioned for the volume. For `gp2` volumes, this represents the\nbaseline performance of the volume and the rate at which the volume accumulates I/O\ncredits for bursting.\nThe following are the supported values for each volume type:\n* `gp3`: 3,000 - 80,000 IOPS\n* `io1`: 100 - 64,000 IOPS\n* `io2`: 100 - 256,000 IOPS\nFor `io2` volumes, you can achieve up to 256,000 IOPS on\n[instances\nbuilt on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS.\nThis parameter is supported for `io1`, `io2`, and `gp3` volumes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-iops", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeInitializationRate": { "MarkdownDocumentation": "`VolumeInitializationRate`\n\nSpecifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download\nthe snapshot blocks from Amazon S3 to the volume. This is also known as *volume\ninitialization*. Specifying a volume initialization rate ensures that the volume is\ninitialized at a predictable and consistent rate after creation.\nThis parameter is supported only for volumes created from snapshots. Omit this parameter\nif:\n* You want to create the volume using fast snapshot restore. You must specify a snapshot\n that is enabled for fast snapshot restore. In this case, the volume is fully initialized\n at creation.\n \n ###### Note\n \n If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate,\n the volume will be initialized at the specified rate instead of fast snapshot restore.\n* You want to create a volume that is initialized at the default rate.\nFor more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*.\nValid range: 100 - 300 MiB/s\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-volumeinitializationrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume\nsize. The following are the supported volumes sizes for each volume type:\n* `gp2`: 1 - 16,384 GiB\n* `gp3`: 1 - 65,536 GiB\n* `io1`: 4 - 16,384 GiB\n* `io2`: 4 - 65,536 GiB\n* `st1` and `sc1`: 125 - 16,384 GiB\n* `standard`: 1 - 1024 GiB\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-volumesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nIndicates whether the EBS volume is deleted on instance termination.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-deleteontermination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::LaunchTemplate.EnaSrdSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.EnaSrdSpecification`\n\nENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the\nmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.\nWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same\naccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\nTo improve the reliability of network packet delivery, ENA Express reorders network packets on the\nreceiving end by default. However, some UDP-based applications are designed to handle network packets\nthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express\nis enabled, you can specify whether UDP network traffic uses it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enasrdspecification.html", "Properties": { "EnaSrdEnabled": { "MarkdownDocumentation": "`EnaSrdEnabled`\n\nIndicates whether ENA Express is enabled for the network interface.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enasrdspecification.html#cfn-ec2-launchtemplate-enasrdspecification-enasrdenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnaSrdUdpSpecification": { "MarkdownDocumentation": "`EnaSrdUdpSpecification`\n\nConfigures ENA Express for UDP network traffic.\n*Required*: No\n*Type*: [EnaSrdUdpSpecification](./aws-properties-ec2-launchtemplate-enasrdudpspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enasrdspecification.html#cfn-ec2-launchtemplate-enasrdspecification-enasrdudpspecification", "UpdateType": "Mutable", "Required": false, "Type": "EnaSrdUdpSpecification" } } }, "AWS::EC2::LaunchTemplate.EnaSrdUdpSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.EnaSrdUdpSpecification`\n\nENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic\nautomatically uses it. However, some UDP-based applications are designed to handle network packets that are\nout of order, without a need for retransmission, such as live video broadcasting or other near-real-time\napplications. For UDP traffic, you can specify whether to use ENA Express, based on your application\nenvironment needs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enasrdudpspecification.html", "Properties": { "EnaSrdUdpEnabled": { "MarkdownDocumentation": "`EnaSrdUdpEnabled`\n\nIndicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting,\nyou must first enable ENA Express.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enasrdudpspecification.html#cfn-ec2-launchtemplate-enasrdudpspecification-enasrdudpenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::LaunchTemplate.EnclaveOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.EnclaveOptions`\n\nIndicates whether the instance is enabled for AWS Nitro\nEnclaves.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enclaveoptions.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIf this parameter is set to `true`, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro\nEnclaves.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enclaveoptions.html#cfn-ec2-launchtemplate-enclaveoptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::LaunchTemplate.HibernationOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.HibernationOptions`\n\nSpecifies whether your instance is configured for hibernation. This parameter is valid\nonly if the instance meets the [hibernation\nprerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the\n*Amazon EC2 User Guide*.\n`HibernationOptions` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-hibernationoptions.html", "Properties": { "Configured": { "MarkdownDocumentation": "`Configured`\n\nIf you set this parameter to `true`, the instance is enabled for\nhibernation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-hibernationoptions.html#cfn-ec2-launchtemplate-hibernationoptions-configured", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::LaunchTemplate.IamInstanceProfile": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.IamInstanceProfile`\n\nSpecifies an IAM instance profile, which is a container for an IAM role for your\ninstance. You can use an IAM role to distribute your AWS credentials to\nyour instances.\nIf you are creating the launch template for use with an Amazon EC2 Auto Scaling group,\nyou can specify either the name or the ARN of the instance profile, but not both.\n`IamInstanceProfile` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-iaminstanceprofile.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the instance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-iaminstanceprofile.html#cfn-ec2-launchtemplate-iaminstanceprofile-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the instance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-iaminstanceprofile.html#cfn-ec2-launchtemplate-iaminstanceprofile-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.InstanceMarketOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.InstanceMarketOptions`\n\nSpecifies the market (purchasing) option for an instance.\n`InstanceMarketOptions` is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancemarketoptions.html", "Properties": { "SpotOptions": { "MarkdownDocumentation": "`SpotOptions`\n\nThe options for Spot Instances.\n*Required*: No\n*Type*: [SpotOptions](./aws-properties-ec2-launchtemplate-spotoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancemarketoptions.html#cfn-ec2-launchtemplate-instancemarketoptions-spotoptions", "UpdateType": "Mutable", "Required": false, "Type": "SpotOptions" }, "MarketType": { "MarkdownDocumentation": "`MarketType`\n\nThe market type.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `spot | capacity-block | int...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "spot", "capacity-block", "interruptible-capacity-reservation" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancemarketoptions.html#cfn-ec2-launchtemplate-instancemarketoptions-markettype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.InstanceRequirements": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.InstanceRequirements`\n\nThe attributes for the instance types. When you specify instance attributes, Amazon EC2 will\nidentify instance types with these attributes.\nYou must specify `VCpuCount` and `MemoryMiB`. All other attributes\nare optional. Any unspecified optional attribute is set to its default.\nWhen you specify multiple attributes, you get instance types that satisfy all of the\nspecified attributes. If you specify multiple values for an attribute, you get instance\ntypes that satisfy any of the specified values.\nTo limit the list of instance types from which Amazon EC2 can identify matching instance types,\nyou can use one of the following parameters, but not both in the same request:\n* `AllowedInstanceTypes` - The instance types to include in the list. All\n other instance types are ignored, even if they match your specified attributes.\n* `ExcludedInstanceTypes` - The instance types to exclude from the list,\n even if they match your specified attributes.\n###### Note\nIf you specify `InstanceRequirements`, you can't specify\n`InstanceType`.\nAttribute-based instance type selection is only supported when using Auto Scaling\ngroups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\nthe [launch instance\nwizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or\n[AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)AWS CloudFormation resource, you can't specify\n`InstanceRequirements`.\nFor more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot\nplacement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html", "Properties": { "InstanceGenerations": { "MarkdownDocumentation": "`InstanceGenerations`\n\nIndicates whether current or previous generation instance types are included. The\ncurrent generation instance types are recommended for use. Current generation instance types are\ntypically the latest two to three generations in each instance family. For more\ninformation, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the\n*Amazon EC2 User Guide*.\nFor current generation instance types, specify `current`.\nFor previous generation instance types, specify `previous`.\nDefault: Current and previous generation instance types\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-instancegenerations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MemoryGiBPerVCpu": { "MarkdownDocumentation": "`MemoryGiBPerVCpu`\n\nThe minimum and maximum amount of memory per vCPU, in GiB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [MemoryGiBPerVCpu](./aws-properties-ec2-launchtemplate-memorygibpervcpu.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-memorygibpervcpu", "UpdateType": "Mutable", "Required": false, "Type": "MemoryGiBPerVCpu" }, "AcceleratorTypes": { "MarkdownDocumentation": "`AcceleratorTypes`\n\nThe accelerator types that must be on the instance type.\n* For instance types with FPGA accelerators, specify `fpga`.\n* For instance types with GPU accelerators, specify `gpu`.\n* For instance types with Inference accelerators, specify `inference`.\n* For instance types with Media accelerators, specify `media`.\nDefault: Any accelerator type\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratortypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VCpuCount": { "MarkdownDocumentation": "`VCpuCount`\n\nThe minimum and maximum number of vCPUs.\n*Required*: No\n*Type*: [VCpuCount](./aws-properties-ec2-launchtemplate-vcpucount.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-vcpucount", "UpdateType": "Mutable", "Required": false, "Type": "VCpuCount" }, "AcceleratorManufacturers": { "MarkdownDocumentation": "`AcceleratorManufacturers`\n\nIndicates whether instance types must have accelerators by specific manufacturers.\n* For instance types with AWS devices, specify `amazon-web-services`.\n* For instance types with AMD devices, specify `amd`.\n* For instance types with Habana devices, specify `habana`.\n* For instance types with NVIDIA devices, specify `nvidia`.\n* For instance types with Xilinx devices, specify `xilinx`.\nDefault: Any manufacturer\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratormanufacturers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LocalStorage": { "MarkdownDocumentation": "`LocalStorage`\n\nIndicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n[Amazon\nEC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.\n* To include instance types with instance store volumes, specify\n `included`.\n* To require only instance types with instance store volumes, specify\n `required`.\n* To exclude instance types with instance store volumes, specify\n `excluded`.\nDefault: `included`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-localstorage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CpuManufacturers": { "MarkdownDocumentation": "`CpuManufacturers`\n\nThe CPU manufacturers to include.\n* For instance types with Intel CPUs, specify `intel`.\n* For instance types with AMD CPUs, specify `amd`.\n* For instance types with AWS CPUs, specify `amazon-web-services`.\n* For instance types with Apple CPUs, specify `apple`.\n###### Note\nDon't confuse the CPU manufacturer with the CPU architecture. Instances will\nbe launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you\nspecify in your launch template.\nDefault: Any manufacturer\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-cpumanufacturers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BareMetal": { "MarkdownDocumentation": "`BareMetal`\n\nIndicates whether bare metal instance types must be included, excluded, or required.\n* To include bare metal instance types, specify `included`.\n* To require only bare metal instance types, specify `required`.\n* To exclude bare metal instance types, specify `excluded`.\nDefault: `excluded`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-baremetal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequireHibernateSupport": { "MarkdownDocumentation": "`RequireHibernateSupport`\n\nIndicates whether instance types must support hibernation for On-Demand\nInstances.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-requirehibernatesupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "MarkdownDocumentation": "`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`\n\n[Price protection] The price protection threshold for Spot Instances, as a percentage of an\nidentified On-Demand price. The identified On-Demand price is the price of the lowest\npriced current generation C, M, or R instance type with your specified attributes. If no\ncurrent generation C, M, or R instance type matches your attributes, then the identified\nprice is from the lowest priced current generation instance types, and failing that, from\nthe lowest priced previous generation instance types that match your attributes. When Amazon EC2\nselects instance types with your attributes, it will exclude instance types whose price\nexceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is based on the per vCPU or per\nmemory price instead of the per instance price.\n###### Note\nOnly one of `SpotMaxPricePercentageOverLowestPrice` or\n`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you\ndon't specify either, Amazon EC2 will automatically apply optimal price protection to\nconsistently select from a wide range of instance types. To indicate no price protection\nthreshold for Spot Instances, meaning you want to consider all instance types that match your\nattributes, include one of these parameters and specify a high value, such as\n`999999`.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-maxspotpriceaspercentageofoptimalondemandprice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OnDemandMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`OnDemandMaxPricePercentageOverLowestPrice`\n\n[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher\nthan an identified On-Demand price. The identified On-Demand price is the price of the\nlowest priced current generation C, M, or R instance type with your specified attributes.\nWhen Amazon EC2 selects instance types with your attributes, it will exclude instance types\nwhose price exceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nTo turn off price protection, specify a high value, such as `999999`.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n###### Note\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is applied based on the\nper-vCPU or per-memory price instead of the per-instance price.\nDefault: `20`\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-ondemandmaxpricepercentageoverlowestprice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MemoryMiB": { "MarkdownDocumentation": "`MemoryMiB`\n\nThe minimum and maximum amount of memory, in MiB.\n*Required*: No\n*Type*: [MemoryMiB](./aws-properties-ec2-launchtemplate-memorymib.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-memorymib", "UpdateType": "Mutable", "Required": false, "Type": "MemoryMiB" }, "LocalStorageTypes": { "MarkdownDocumentation": "`LocalStorageTypes`\n\nThe type of local storage that is required.\n* For instance types with hard disk drive (HDD) storage, specify `hdd`.\n* For instance types with solid state drive (SSD) storage, specify\n `ssd`.\nDefault: `hdd` and `ssd`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-localstoragetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkInterfaceCount": { "MarkdownDocumentation": "`NetworkInterfaceCount`\n\nThe minimum and maximum number of network interfaces.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [NetworkInterfaceCount](./aws-properties-ec2-launchtemplate-networkinterfacecount.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-networkinterfacecount", "UpdateType": "Mutable", "Required": false, "Type": "NetworkInterfaceCount" }, "ExcludedInstanceTypes": { "MarkdownDocumentation": "`ExcludedInstanceTypes`\n\nThe instance types to exclude.\nYou can use strings with one or more wild cards, represented by\nan asterisk (`*`), to exclude an instance type, size, or generation. The\nfollowing are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`,\n`r*`, `*3*`.\nFor example, if you specify `c5*`,Amazon EC2 will exclude the entire C5 instance\nfamily, which includes all C5a and C5n instance types. If you specify\n`m5a.*`, Amazon EC2 will exclude all the M5a instance types, but not the M5n\ninstance types.\n###### Note\nIf you specify `ExcludedInstanceTypes`, you can't specify `AllowedInstanceTypes`.\nDefault: No excluded instance types\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-excludedinstancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedInstanceTypes": { "MarkdownDocumentation": "`AllowedInstanceTypes`\n\nThe instance types to apply your specified attributes against. All other instance types\nare ignored, even if they match your specified attributes.\nYou can use strings with one or more wild cards, represented by\nan asterisk (`*`), to allow an instance type, size, or generation. The\nfollowing are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`,\n`r*`, `*3*`.\nFor example, if you specify `c5*`,Amazon EC2 will allow the entire C5 instance\nfamily, which includes all C5a and C5n instance types. If you specify\n`m5a.*`, Amazon EC2 will allow all the M5a instance types, but not the M5n\ninstance types.\n###### Note\nIf you specify `AllowedInstanceTypes`, you can't specify `ExcludedInstanceTypes`.\nDefault: All instance types\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-allowedinstancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AcceleratorCount": { "MarkdownDocumentation": "`AcceleratorCount`\n\nThe minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on\nan instance.\nTo exclude accelerator-enabled instance types, set `Max` to `0`.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [AcceleratorCount](./aws-properties-ec2-launchtemplate-acceleratorcount.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratorcount", "UpdateType": "Mutable", "Required": false, "Type": "AcceleratorCount" }, "NetworkBandwidthGbps": { "MarkdownDocumentation": "`NetworkBandwidthGbps`\n\nThe minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [NetworkBandwidthGbps](./aws-properties-ec2-launchtemplate-networkbandwidthgbps.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-networkbandwidthgbps", "UpdateType": "Mutable", "Required": false, "Type": "NetworkBandwidthGbps" }, "BaselinePerformanceFactors": { "MarkdownDocumentation": "`BaselinePerformanceFactors`\n\nThe baseline performance to consider, using an instance family as a baseline reference.\nThe instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\nbaseline to guide instance type selection, but there is no guarantee that the selected\ninstance types will always exceed the baseline for every application. Currently, this\nparameter only supports CPU performance as a baseline performance factor. For more\ninformation, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: [BaselinePerformanceFactors](./aws-properties-ec2-launchtemplate-baselineperformancefactors.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-baselineperformancefactors", "UpdateType": "Mutable", "Required": false, "Type": "BaselinePerformanceFactors" }, "SpotMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`SpotMaxPricePercentageOverLowestPrice`\n\n[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\nan identified Spot price. The identified Spot price is the Spot price of the lowest priced\ncurrent generation C, M, or R instance type with your specified attributes. If no current\ngeneration C, M, or R instance type matches your attributes, then the identified Spot price\nis from the lowest priced current generation instance types, and failing that, from the\nlowest priced previous generation instance types that match your attributes. When Amazon EC2\nselects instance types with your attributes, it will exclude instance types whose Spot\nprice exceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is applied based on the per-vCPU\nor per-memory price instead of the per-instance price.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n###### Note\nOnly one of `SpotMaxPricePercentageOverLowestPrice` or\n`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you\ndon't specify either, Amazon EC2 will automatically apply optimal price protection to\nconsistently select from a wide range of instance types. To indicate no price protection\nthreshold for Spot Instances, meaning you want to consider all instance types that match your\nattributes, include one of these parameters and specify a high value, such as\n`999999`.\nDefault: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-spotmaxpricepercentageoverlowestprice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "BaselineEbsBandwidthMbps": { "MarkdownDocumentation": "`BaselineEbsBandwidthMbps`\n\nThe minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n[Amazon\nEBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [BaselineEbsBandwidthMbps](./aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-baselineebsbandwidthmbps", "UpdateType": "Mutable", "Required": false, "Type": "BaselineEbsBandwidthMbps" }, "AcceleratorNames": { "MarkdownDocumentation": "`AcceleratorNames`\n\nThe accelerators that must be on the instance type.\n* For instance types with NVIDIA A10G GPUs, specify `a10g`.\n* For instance types with NVIDIA A100 GPUs, specify `a100`.\n* For instance types with NVIDIA H100 GPUs, specify `h100`.\n* For instance types with AWS Inferentia chips, specify `inferentia`.\n* For instance types with AWS Inferentia2 chips, specify `inferentia2`.\n* For instance types with Habana Gaudi HL-205 GPUs, specify `gaudi-hl-205`.\n* For instance types with NVIDIA GRID K520 GPUs, specify `k520`.\n* For instance types with NVIDIA K80 GPUs, specify `k80`.\n* For instance types with NVIDIA L4 GPUs, specify `l4`.\n* For instance types with NVIDIA L40S GPUs, specify `l40s`.\n* For instance types with NVIDIA M60 GPUs, specify `m60`.\n* For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520`.\n* For instance types with AWS Trainium chips, specify `trainium`.\n* For instance types with AWS Trainium2 chips, specify `trainium2`.\n* For instance types with NVIDIA T4 GPUs, specify `t4`.\n* For instance types with NVIDIA T4G GPUs, specify `t4g`.\n* For instance types with Xilinx U30 cards, specify `u30`.\n* For instance types with Xilinx VU9P FPGAs, specify `vu9p`.\n* For instance types with NVIDIA V100 GPUs, specify `v100`.\nDefault: Any accelerator\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratornames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AcceleratorTotalMemoryMiB": { "MarkdownDocumentation": "`AcceleratorTotalMemoryMiB`\n\nThe minimum and maximum amount of total accelerator memory, in MiB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [AcceleratorTotalMemoryMiB](./aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratortotalmemorymib", "UpdateType": "Mutable", "Required": false, "Type": "AcceleratorTotalMemoryMiB" }, "BurstablePerformance": { "MarkdownDocumentation": "`BurstablePerformance`\n\nIndicates whether burstable performance T instance types are included, excluded, or required. For more information, see\n[Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).\n* To include burstable performance instance types, specify `included`.\n* To require only burstable performance instance types, specify `required`.\n* To exclude burstable performance instance types, specify `excluded`.\nDefault: `excluded`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-burstableperformance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalLocalStorageGB": { "MarkdownDocumentation": "`TotalLocalStorageGB`\n\nThe minimum and maximum amount of total local storage, in GB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [TotalLocalStorageGB](./aws-properties-ec2-launchtemplate-totallocalstoragegb.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-totallocalstoragegb", "UpdateType": "Mutable", "Required": false, "Type": "TotalLocalStorageGB" } } }, "AWS::EC2::LaunchTemplate.Ipv4PrefixSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.Ipv4PrefixSpecification`\n\nSpecifies an IPv4 prefix for a network interface.\n`Ipv4PrefixSpecification` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv4prefixspecification.html", "Properties": { "Ipv4Prefix": { "MarkdownDocumentation": "`Ipv4Prefix`\n\nThe IPv4 prefix. For information, see [Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv4prefixspecification.html#cfn-ec2-launchtemplate-ipv4prefixspecification-ipv4prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.Ipv6Add": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.Ipv6Add`\n\nSpecifies an IPv6 address in an Amazon EC2 launch template.\n`Ipv6Add` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html", "Properties": { "Ipv6Address": { "MarkdownDocumentation": "`Ipv6Address`\n\nOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You\ncan't use this option if you're specifying a number of IPv6 addresses.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html#cfn-ec2-launchtemplate-ipv6add-ipv6address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.Ipv6PrefixSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.Ipv6PrefixSpecification`\n\nSpecifies an IPv6 prefix for a network interface.\n`Ipv6PrefixSpecification` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6prefixspecification.html", "Properties": { "Ipv6Prefix": { "MarkdownDocumentation": "`Ipv6Prefix`\n\nThe IPv6 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6prefixspecification.html#cfn-ec2-launchtemplate-ipv6prefixspecification-ipv6prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.LaunchTemplateData": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.LaunchTemplateData`\n\nThe information to include in the launch template.\n###### Note\nYou must specify at least one parameter for the launch template data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe names of the security groups. For a nondefault VPC, you must use security group\nIDs instead.\nIf you specify a network interface, you must specify any security groups as part of\nthe network interface instead of using this parameter.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TagSpecifications": { "MarkdownDocumentation": "`TagSpecifications`\n\nThe tags to apply to resources that are created during instance launch.\nTo tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).\n*Required*: No\n*Type*: Array of [TagSpecification](./aws-properties-ec2-launchtemplate-tagspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagSpecification", "DuplicatesAllowed": true }, "NetworkPerformanceOptions": { "MarkdownDocumentation": "`NetworkPerformanceOptions`\n\nThe settings for the network performance options for the instance. For more information, see\n[EC2 instance bandwidth weighting configuration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-bandwidth-weighting.html).\n*Required*: No\n*Type*: [NetworkPerformanceOptions](./aws-properties-ec2-launchtemplate-networkperformanceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-networkperformanceoptions", "UpdateType": "Mutable", "Required": false, "Type": "NetworkPerformanceOptions" }, "UserData": { "MarkdownDocumentation": "`UserData`\n\nThe user data to make available to the instance. You must provide base64-encoded text.\nUser data is limited to 16 KB. For more information, see [Run commands when you launch an EC2\ninstance with user data input](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the\n*Amazon EC2 User Guide*.\nIf you are creating the launch template for use with AWS Batch, the user\ndata must be provided in the [MIME multi-part archive format](https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html#lt-user-data) in the\n*AWS Batch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-userdata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlockDeviceMappings": { "MarkdownDocumentation": "`BlockDeviceMappings`\n\nThe block device mapping.\n*Required*: No\n*Type*: Array of [BlockDeviceMapping](./aws-properties-ec2-launchtemplate-blockdevicemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-blockdevicemappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BlockDeviceMapping", "DuplicatesAllowed": true }, "MaintenanceOptions": { "MarkdownDocumentation": "`MaintenanceOptions`\n\nThe maintenance options of your instance.\n*Required*: No\n*Type*: [MaintenanceOptions](./aws-properties-ec2-launchtemplate-maintenanceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-maintenanceoptions", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceOptions" }, "IamInstanceProfile": { "MarkdownDocumentation": "`IamInstanceProfile`\n\nThe name or Amazon Resource Name (ARN) of an IAM instance profile.\n*Required*: No\n*Type*: [IamInstanceProfile](./aws-properties-ec2-launchtemplate-iaminstanceprofile.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile", "UpdateType": "Mutable", "Required": false, "Type": "IamInstanceProfile" }, "KernelId": { "MarkdownDocumentation": "`KernelId`\n\nThe ID of the kernel.\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\ninformation, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in\nthe *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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-kernelid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EbsOptimized": { "MarkdownDocumentation": "`EbsOptimized`\n\nIndicates whether the instance is optimized for Amazon EBS I/O. This optimization\nprovides dedicated throughput to Amazon EBS and an optimized configuration stack to\nprovide optimal Amazon EBS I/O performance. This optimization isn't available with all\ninstance types. Additional usage charges apply when using an EBS-optimized\ninstance.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ebsoptimized", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe placement for the instance.\n*Required*: No\n*Type*: [Placement](./aws-properties-ec2-launchtemplate-placement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-placement", "UpdateType": "Mutable", "Required": false, "Type": "Placement" }, "NetworkInterfaces": { "MarkdownDocumentation": "`NetworkInterfaces`\n\nThe network interfaces for the instance.\n*Required*: No\n*Type*: Array of [NetworkInterface](./aws-properties-ec2-launchtemplate-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-networkinterfaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NetworkInterface", "DuplicatesAllowed": true }, "EnclaveOptions": { "MarkdownDocumentation": "`EnclaveOptions`\n\nIndicates whether the instance is enabled for AWS Nitro Enclaves. For more\ninformation, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the\n*AWS Nitro Enclaves User Guide*.\nYou can't enable AWS Nitro Enclaves and hibernation on the same instance.\n*Required*: No\n*Type*: [EnclaveOptions](./aws-properties-ec2-launchtemplate-enclaveoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-enclaveoptions", "UpdateType": "Mutable", "Required": false, "Type": "EnclaveOptions" }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nThe ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which\nwill resolve to an AMI ID on launch.\nValid formats:\n* `ami-0ac394d6a3example`\n* `resolve:ssm:parameter-name`\n* `resolve:ssm:parameter-name:version-number`\n* `resolve:ssm:parameter-name:label`\nFor more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-imageid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in\nthe *Amazon EC2 User Guide*.\nIf you specify `InstanceType`, you can't specify\n`InstanceRequirements`.\n*Required*: No\n*Type*: String\n*Allowed values*: `a1.medium | a1.large | a1.x...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge", "c8g.medium", "c8g.large", "c8g.xlarge", "c8g.2xlarge", "c8g.4xlarge", "c8g.8xlarge", "c8g.12xlarge", "c8g.16xlarge", "c8g.24xlarge", "c8g.48xlarge", "c8g.metal-24xl", "c8g.metal-48xl", "m8g.medium", "m8g.large", "m8g.xlarge", "m8g.2xlarge", "m8g.4xlarge", "m8g.8xlarge", "m8g.12xlarge", "m8g.16xlarge", "m8g.24xlarge", "m8g.48xlarge", "m8g.metal-24xl", "m8g.metal-48xl", "x8g.medium", "x8g.large", "x8g.xlarge", "x8g.2xlarge", "x8g.4xlarge", "x8g.8xlarge", "x8g.12xlarge", "x8g.16xlarge", "x8g.24xlarge", "x8g.48xlarge", "x8g.metal-24xl", "x8g.metal-48xl", "i7ie.large", "i7ie.xlarge", "i7ie.2xlarge", "i7ie.3xlarge", "i7ie.6xlarge", "i7ie.12xlarge", "i7ie.18xlarge", "i7ie.24xlarge", "i7ie.48xlarge", "i8g.large", "i8g.xlarge", "i8g.2xlarge", "i8g.4xlarge", "i8g.8xlarge", "i8g.12xlarge", "i8g.16xlarge", "i8g.24xlarge", "i8g.metal-24xl", "u7i-6tb.112xlarge", "u7i-8tb.112xlarge", "u7inh-32tb.480xlarge", "p5e.48xlarge", "p5en.48xlarge", "f2.12xlarge", "f2.48xlarge", "trn2.48xlarge", "c7i-flex.12xlarge", "c7i-flex.16xlarge", "m7i-flex.12xlarge", "m7i-flex.16xlarge", "i7ie.metal-24xl", "i7ie.metal-48xl", "i8g.48xlarge", "c8gd.medium", "c8gd.large", "c8gd.xlarge", "c8gd.2xlarge", "c8gd.4xlarge", "c8gd.8xlarge", "c8gd.12xlarge", "c8gd.16xlarge", "c8gd.24xlarge", "c8gd.48xlarge", "c8gd.metal-24xl", "c8gd.metal-48xl", "i7i.large", "i7i.xlarge", "i7i.2xlarge", "i7i.4xlarge", "i7i.8xlarge", "i7i.12xlarge", "i7i.16xlarge", "i7i.24xlarge", "i7i.48xlarge", "i7i.metal-24xl", "i7i.metal-48xl", "p6-b200.48xlarge", "m8gd.medium", "m8gd.large", "m8gd.xlarge", "m8gd.2xlarge", "m8gd.4xlarge", "m8gd.8xlarge", "m8gd.12xlarge", "m8gd.16xlarge", "m8gd.24xlarge", "m8gd.48xlarge", "m8gd.metal-24xl", "m8gd.metal-48xl", "r8gd.medium", "r8gd.large", "r8gd.xlarge", "r8gd.2xlarge", "r8gd.4xlarge", "r8gd.8xlarge", "r8gd.12xlarge", "r8gd.16xlarge", "r8gd.24xlarge", "r8gd.48xlarge", "r8gd.metal-24xl", "r8gd.metal-48xl", "c8gn.medium", "c8gn.large", "c8gn.xlarge", "c8gn.2xlarge", "c8gn.4xlarge", "c8gn.8xlarge", "c8gn.12xlarge", "c8gn.16xlarge", "c8gn.24xlarge", "c8gn.48xlarge", "c8gn.metal-24xl", "c8gn.metal-48xl", "f2.6xlarge", "p6e-gb200.36xlarge", "g6f.large", "g6f.xlarge", "g6f.2xlarge", "g6f.4xlarge", "gr6f.4xlarge", "p5.4xlarge", "r8i.large", "r8i.xlarge", "r8i.2xlarge", "r8i.4xlarge", "r8i.8xlarge", "r8i.12xlarge", "r8i.16xlarge", "r8i.24xlarge", "r8i.32xlarge", "r8i.48xlarge", "r8i.96xlarge", "r8i.metal-48xl", "r8i.metal-96xl", "r8i-flex.large", "r8i-flex.xlarge", "r8i-flex.2xlarge", "r8i-flex.4xlarge", "r8i-flex.8xlarge", "r8i-flex.12xlarge", "r8i-flex.16xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Monitoring": { "MarkdownDocumentation": "`Monitoring`\n\nThe monitoring for the instance.\n*Required*: No\n*Type*: [Monitoring](./aws-properties-ec2-launchtemplate-monitoring.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring", "UpdateType": "Mutable", "Required": false, "Type": "Monitoring" }, "HibernationOptions": { "MarkdownDocumentation": "`HibernationOptions`\n\nIndicates whether an instance is enabled for hibernation. This parameter is valid only\nif the instance meets the [hibernation\nprerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html)\nin the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: [HibernationOptions](./aws-properties-ec2-launchtemplate-hibernationoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-hibernationoptions", "UpdateType": "Mutable", "Required": false, "Type": "HibernationOptions" }, "MetadataOptions": { "MarkdownDocumentation": "`MetadataOptions`\n\nThe metadata options for the instance. For more information, see [Configure\nthe Instance Metadata Service options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) in the\n*Amazon EC2 User Guide*.\n*Required*: No\n*Type*: [MetadataOptions](./aws-properties-ec2-launchtemplate-metadataoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions", "UpdateType": "Mutable", "Required": false, "Type": "MetadataOptions" }, "LicenseSpecifications": { "MarkdownDocumentation": "`LicenseSpecifications`\n\nThe license configurations.\n*Required*: No\n*Type*: Array of [LicenseSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-licensespecifications", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LicenseSpecification", "DuplicatesAllowed": true }, "InstanceInitiatedShutdownBehavior": { "MarkdownDocumentation": "`InstanceInitiatedShutdownBehavior`\n\nIndicates whether an instance stops or terminates when you initiate shutdown from the\ninstance (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)", "RefReturnValue": "", "AllowedValues": [ "stop", "terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instanceinitiatedshutdownbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisableApiStop": { "MarkdownDocumentation": "`DisableApiStop`\n\nIndicates whether to enable the instance for stop protection. For more information,\nsee [Enable stop protection for your EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html) in the\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapistop", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CpuOptions": { "MarkdownDocumentation": "`CpuOptions`\n\nThe CPU options for the instance. For more information, see [CPU\noptions for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the\n*Amazon EC2 User Guide*.\n*Required*: No\n*Type*: [CpuOptions](./aws-properties-ec2-launchtemplate-cpuoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions", "UpdateType": "Mutable", "Required": false, "Type": "CpuOptions" }, "PrivateDnsNameOptions": { "MarkdownDocumentation": "`PrivateDnsNameOptions`\n\nThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*.\n*Required*: No\n*Type*: [PrivateDnsNameOptions](./aws-properties-ec2-launchtemplate-privatednsnameoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions", "UpdateType": "Mutable", "Required": false, "Type": "PrivateDnsNameOptions" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the security groups. You can specify the IDs of existing security groups and\nreferences to resources created by the stack template.\nIf you specify a network interface, you must specify any security groups as part of the\nnetwork interface instead.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "KeyName": { "MarkdownDocumentation": "`KeyName`\n\nThe 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\n[ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).\n###### Important\nIf you do not specify a key pair, you can't connect to the instance unless you\nchoose 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-keyname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisableApiTermination": { "MarkdownDocumentation": "`DisableApiTermination`\n\nIndicates whether termination protection is enabled for the instance. The default is\n`false`, which means that you can terminate the instance using the Amazon EC2\nconsole, command line tools, or API. You can enable termination protection when you\nlaunch an instance, while the instance is running, or while the instance is\nstopped.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapitermination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InstanceMarketOptions": { "MarkdownDocumentation": "`InstanceMarketOptions`\n\nThe market (purchasing) option for the instances.\n*Required*: No\n*Type*: [InstanceMarketOptions](./aws-properties-ec2-launchtemplate-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions", "UpdateType": "Mutable", "Required": false, "Type": "InstanceMarketOptions" }, "InstanceRequirements": { "MarkdownDocumentation": "`InstanceRequirements`\n\nThe attributes for the instance types. When you specify instance attributes, Amazon EC2 will\nidentify instance types with these attributes.\nYou must specify `VCpuCount` and `MemoryMiB`. All other attributes\nare optional. Any unspecified optional attribute is set to its default.\nWhen you specify multiple attributes, you get instance types that satisfy all of the\nspecified attributes. If you specify multiple values for an attribute, you get instance\ntypes that satisfy any of the specified values.\nTo limit the list of instance types from which Amazon EC2 can identify matching instance types,\nyou can use one of the following parameters, but not both in the same request:\n* `AllowedInstanceTypes` - The instance types to include in the list. All\n other instance types are ignored, even if they match your specified attributes.\n* `ExcludedInstanceTypes` - The instance types to exclude from the list,\n even if they match your specified attributes.\n###### Note\nIf you specify `InstanceRequirements`, you can't specify\n`InstanceType`.\nAttribute-based instance type selection is only supported when using Auto Scaling\ngroups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\nthe [launch instance\nwizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or\n[AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)AWS CloudFormation resource, you can't specify `InstanceRequirements`.\nFor more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot\nplacement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: [InstanceRequirements](./aws-properties-ec2-launchtemplate-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements", "UpdateType": "Mutable", "Required": false, "Type": "InstanceRequirements" }, "RamDiskId": { "MarkdownDocumentation": "`RamDiskId`\n\nThe ID of the RAM disk.\n###### Important\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\ninformation, see [User provided\nkernels](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ramdiskid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityReservationSpecification": { "MarkdownDocumentation": "`CapacityReservationSpecification`\n\nThe Capacity Reservation targeting option. If you do not specify this parameter, the\ninstance's Capacity Reservation preference defaults to `open`, which enables\nit to run in any open Capacity Reservation that has matching attributes (instance type,\nplatform, Availability Zone).\n*Required*: No\n*Type*: [CapacityReservationSpecification](./aws-properties-ec2-launchtemplate-capacityreservationspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification", "UpdateType": "Mutable", "Required": false, "Type": "CapacityReservationSpecification" }, "CreditSpecification": { "MarkdownDocumentation": "`CreditSpecification`\n\nThe credit option for CPU usage of the instance. Valid only for T instances.\n*Required*: No\n*Type*: [CreditSpecification](./aws-properties-ec2-launchtemplate-creditspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification", "UpdateType": "Mutable", "Required": false, "Type": "CreditSpecification" } } }, "AWS::EC2::LaunchTemplate.LaunchTemplateTagSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.LaunchTemplateTagSpecification`\n\nSpecifies the tags to apply to the launch template during creation.\nTo specify the tags for the resources that are created during instance launch, use\n[AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html).\n`LaunchTemplateTagSpecification` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html", "Properties": { "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource. To tag a launch template, `ResourceType` must be\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html#cfn-ec2-launchtemplate-launchtemplatetagspecification-resourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-launchtemplate-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html#cfn-ec2-launchtemplate-launchtemplatetagspecification-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::EC2::LaunchTemplate.LicenseSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.LicenseSpecification`\n\nSpecifies a license configuration for an instance.\n`LicenseSpecification` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-licensespecification.html", "Properties": { "LicenseConfigurationArn": { "MarkdownDocumentation": "`LicenseConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the license 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-licensespecification.html#cfn-ec2-launchtemplate-licensespecification-licenseconfigurationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.MaintenanceOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.MaintenanceOptions`\n\nThe maintenance options of your instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-maintenanceoptions.html", "Properties": { "AutoRecovery": { "MarkdownDocumentation": "`AutoRecovery`\n\nDisables the automatic recovery behavior of your instance or sets it to\ndefault.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-maintenanceoptions.html#cfn-ec2-launchtemplate-maintenanceoptions-autorecovery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.MemoryGiBPerVCpu": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.MemoryGiBPerVCpu`\n\nThe minimum and maximum amount of memory per vCPU, in GiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorygibpervcpu.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorygibpervcpu.html#cfn-ec2-launchtemplate-memorygibpervcpu-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorygibpervcpu.html#cfn-ec2-launchtemplate-memorygibpervcpu-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::LaunchTemplate.MemoryMiB": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.MemoryMiB`\n\nThe minimum and maximum amount of memory, in MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorymib.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory, in MiB. To specify no minimum limit, specify\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorymib.html#cfn-ec2-launchtemplate-memorymib-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory, in MiB. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorymib.html#cfn-ec2-launchtemplate-memorymib-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::LaunchTemplate.MetadataOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.MetadataOptions`\n\nThe metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the\n*Amazon EC2 User Guide*.\n`MetadataOptions` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html", "Properties": { "HttpPutResponseHopLimit": { "MarkdownDocumentation": "`HttpPutResponseHopLimit`\n\nThe desired HTTP PUT response hop limit for instance metadata requests. The larger the\nnumber, the further instance metadata requests can travel.\nDefault: `1`\nPossible values: Integers from 1 to 64\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpputresponsehoplimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HttpTokens": { "MarkdownDocumentation": "`HttpTokens`\n\nIndicates whether IMDSv2 is required.\n* `optional` - IMDSv2 is optional. You can choose whether to send a\n session token in your instance metadata retrieval requests. If you retrieve IAM\n role credentials without a session token, you receive the IMDSv1 role\n credentials. If you retrieve IAM role credentials using a valid session token,\n you receive the IMDSv2 role credentials.\n* `required` - IMDSv2 is required. You must send a session token in\n your instance metadata retrieval requests. With this option, retrieving the IAM\n role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not\n available.\nDefault: If the value of `ImdsSupport` for the Amazon Machine Image (AMI)\nfor your instance is `v2.0`, the default is `required`.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "optional", "required" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httptokens", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpProtocolIpv6": { "MarkdownDocumentation": "`HttpProtocolIpv6`\n\nEnables or disables the IPv6 endpoint for the instance metadata service.\nDefault: `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)", "RefReturnValue": "", "AllowedValues": [ "disabled", "enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpprotocolipv6", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceMetadataTags": { "MarkdownDocumentation": "`InstanceMetadataTags`\n\nSet to `enabled` to allow access to instance tags from the instance\nmetadata. Set to `disabled` to turn off access to instance tags from the\ninstance metadata. For more information, see [View tags for your EC2\ninstances using instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-tags-in-IMDS.html).\nDefault: `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)", "RefReturnValue": "", "AllowedValues": [ "disabled", "enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-instancemetadatatags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpEndpoint": { "MarkdownDocumentation": "`HttpEndpoint`\n\nEnables or disables the HTTP metadata endpoint on your instances. If the parameter is\nnot specified, the default state is `enabled`.\n###### Note\nIf you specify a value of `disabled`, you will not be able to access\nyour instance metadata.\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)", "RefReturnValue": "", "AllowedValues": [ "disabled", "enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.Monitoring": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.Monitoring`\n\nSpecifies whether detailed monitoring is enabled for an instance. For more information\nabout detailed monitoring, see [Enable or turn off detailed\nmonitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *Amazon EC2 User\nGuide*.\n`Monitoring` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-monitoring.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecify `true` to enable detailed monitoring. Otherwise, basic monitoring\nis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-monitoring.html#cfn-ec2-launchtemplate-monitoring-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::LaunchTemplate.NetworkBandwidthGbps": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.NetworkBandwidthGbps`\n\nThe minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n###### Note\nSetting the minimum bandwidth does not guarantee that your instance will achieve the\nminimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum\nbandwidth, but the actual bandwidth of your instance might go below the specified minimum\nat times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the\n*Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkbandwidthgbps.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum\nlimit.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkbandwidthgbps.html#cfn-ec2-launchtemplate-networkbandwidthgbps-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkbandwidthgbps.html#cfn-ec2-launchtemplate-networkbandwidthgbps-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::LaunchTemplate.NetworkInterface": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.NetworkInterface`\n\nSpecifies the parameters for a network interface.\n`NetworkInterface` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe primary private IPv4 address 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateIpAddresses": { "MarkdownDocumentation": "`PrivateIpAddresses`\n\nOne or more private IPv4 addresses.\n*Required*: No\n*Type*: Array of [PrivateIpAdd](./aws-properties-ec2-launchtemplate-privateipadd.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PrivateIpAdd", "DuplicatesAllowed": true }, "SecondaryPrivateIpAddressCount": { "MarkdownDocumentation": "`SecondaryPrivateIpAddressCount`\n\nThe number of secondary private IPv4 addresses to assign to a network\ninterface.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-secondaryprivateipaddresscount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv6PrefixCount": { "MarkdownDocumentation": "`Ipv6PrefixCount`\n\nThe number of IPv6 prefixes to be automatically assigned to the network interface. You\ncannot use this option if you use the `Ipv6Prefix` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6prefixcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv4Prefixes": { "MarkdownDocumentation": "`Ipv4Prefixes`\n\nOne or more IPv4 prefixes to be assigned to the network interface. You cannot use this\noption if you use the `Ipv4PrefixCount` option.\n*Required*: No\n*Type*: Array of [Ipv4PrefixSpecification](./aws-properties-ec2-launchtemplate-ipv4prefixspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv4prefixes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ipv4PrefixSpecification", "DuplicatesAllowed": true }, "DeviceIndex": { "MarkdownDocumentation": "`DeviceIndex`\n\nThe device index for the network interface attachment. The primary network interface\nhas a device index of 0. If the network interface is of type `interface`, you\nmust specify a device index.\nIf you create a launch template that includes secondary network interfaces but no\nprimary network interface, and you specify it using the `LaunchTemplate` property\nof `AWS::EC2::Instance`, then you must include a primary network interface using\nthe `NetworkInterfaces` property of `AWS::EC2::Instance`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deviceindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PrimaryIpv6": { "MarkdownDocumentation": "`PrimaryIpv6`\n\nThe primary IPv6 address of the network interface. When you enable an IPv6 GUA address\nto be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the\ninstance is terminated or the network interface is detached. For more information about\nprimary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-primaryipv6", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Ipv4PrefixCount": { "MarkdownDocumentation": "`Ipv4PrefixCount`\n\nThe number of IPv4 prefixes to be automatically assigned to the network interface. You\ncannot use this option if you use the `Ipv4Prefix` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv4prefixcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnaQueueCount": { "MarkdownDocumentation": "`EnaQueueCount`\n\nThe number of ENA queues to be created with the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-enaqueuecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv6Prefixes": { "MarkdownDocumentation": "`Ipv6Prefixes`\n\nOne or more IPv6 prefixes to be assigned to the network interface. You cannot use this\noption if you use the `Ipv6PrefixCount` option.\n*Required*: No\n*Type*: Array of [Ipv6PrefixSpecification](./aws-properties-ec2-launchtemplate-ipv6prefixspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6prefixes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ipv6PrefixSpecification", "DuplicatesAllowed": true }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-subnetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ipv6Addresses": { "MarkdownDocumentation": "`Ipv6Addresses`\n\nOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You\ncan't use this option if you're specifying a number of IPv6 addresses.\n*Required*: No\n*Type*: Array of [Ipv6Add](./aws-properties-ec2-launchtemplate-ipv6add.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ipv6Add", "DuplicatesAllowed": true }, "AssociatePublicIpAddress": { "MarkdownDocumentation": "`AssociatePublicIpAddress`\n\nAssociates a public IPv4 address with eth0 for a new network interface.\nAWS charges for all public IPv4 addresses, including public IPv4 addresses\nassociated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://aws.amazon.com/vpc/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatepublicipaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkinterfaceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkCardIndex": { "MarkdownDocumentation": "`NetworkCardIndex`\n\nThe index of the network card. Some instance types support multiple network cards. The\nprimary network interface must be assigned to network card index 0. The default is\nnetwork card index 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkcardindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "InterfaceType": { "MarkdownDocumentation": "`InterfaceType`\n\nThe type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n`efa` or `efa`. For more information, see [Elastic Fabric Adapter for AI/ML\nand HPC workloads on Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the\n*Amazon EC2 User Guide*.\nIf you are not creating an EFA, specify `interface` or omit this\nparameter.\nIf you specify `efa-only`, do not assign any IP addresses to the network\ninterface. EFA-only network interfaces do not support IP addresses.\nValid values: `interface` | `efa` | `efa-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-interfacetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssociateCarrierIpAddress": { "MarkdownDocumentation": "`AssociateCarrierIpAddress`\n\nAssociates a Carrier IP address with eth0 for a new network interface.\nUse this option when you launch an instance in a Wavelength Zone and want to associate\na Carrier IP address with the network interface. For more information about Carrier IP\naddresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *AWS Wavelength Developer\nGuide*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatecarrieripaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnaSrdSpecification": { "MarkdownDocumentation": "`EnaSrdSpecification`\n\nThe ENA Express configuration for the network interface.\n*Required*: No\n*Type*: [EnaSrdSpecification](./aws-properties-ec2-launchtemplate-enasrdspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-enasrdspecification", "UpdateType": "Mutable", "Required": false, "Type": "EnaSrdSpecification" }, "Ipv6AddressCount": { "MarkdownDocumentation": "`Ipv6AddressCount`\n\nThe number of IPv6 addresses to assign to a network interface. Amazon EC2\nautomatically selects the IPv6 addresses from the subnet range. You can't use this\noption if specifying specific IPv6 addresses.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresscount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe IDs of one or more security groups.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nIndicates whether the network interface is deleted when the instance is\nterminated.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deleteontermination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ConnectionTrackingSpecification": { "MarkdownDocumentation": "`ConnectionTrackingSpecification`\n\nA connection tracking specification for the network interface.\n*Required*: No\n*Type*: [ConnectionTrackingSpecification](./aws-properties-ec2-launchtemplate-connectiontrackingspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-connectiontrackingspecification", "UpdateType": "Mutable", "Required": false, "Type": "ConnectionTrackingSpecification" } } }, "AWS::EC2::LaunchTemplate.NetworkInterfaceCount": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.NetworkInterfaceCount`\n\nThe minimum and maximum number of network interfaces.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterfacecount.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of network interfaces. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterfacecount.html#cfn-ec2-launchtemplate-networkinterfacecount-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of network interfaces. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterfacecount.html#cfn-ec2-launchtemplate-networkinterfacecount-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::LaunchTemplate.NetworkPerformanceOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.NetworkPerformanceOptions`\n\nContains settings for the network performance options for the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkperformanceoptions.html", "Properties": { "BandwidthWeighting": { "MarkdownDocumentation": "`BandwidthWeighting`\n\nSpecify the bandwidth weighting option to boost the associated type of baseline bandwidth,\nas follows:\ndefault\nThis option uses the standard bandwidth configuration for your instance type.\n\nvpc-1\nThis option boosts your networking baseline bandwidth and reduces your EBS baseline\nbandwidth.\n\nebs-1\nThis option boosts your EBS baseline bandwidth and reduces your networking baseline\nbandwidth.\n\n*Required*: No\n*Type*: String\n*Allowed values*: `default | vpc-1 | ebs-1...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "vpc-1", "ebs-1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkperformanceoptions.html#cfn-ec2-launchtemplate-networkperformanceoptions-bandwidthweighting", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.Placement": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.Placement`\n\nSpecifies the placement of an instance.\n`Placement` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the placement group for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-groupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tenancy": { "MarkdownDocumentation": "`Tenancy`\n\nThe tenancy of the instance. An instance with a tenancy of dedicated runs on\nsingle-tenant hardware.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | dedicated | host...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "dedicated", "host" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-tenancy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpreadDomain": { "MarkdownDocumentation": "`SpreadDomain`\n\nReserved 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-spreaddomain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PartitionNumber": { "MarkdownDocumentation": "`PartitionNumber`\n\nThe number of the partition the instance should launch in. Valid only if the placement\ngroup strategy is set to `partition`.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-partitionnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone for the instance.\nEither `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Affinity": { "MarkdownDocumentation": "`Affinity`\n\nThe affinity setting for an instance on a Dedicated Host.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-affinity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostId": { "MarkdownDocumentation": "`HostId`\n\nThe ID of the Dedicated Host for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-hostid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostResourceGroupArn": { "MarkdownDocumentation": "`HostResourceGroupArn`\n\nThe ARN of the host resource group in which to launch the instances. If you specify a\nhost resource group ARN, omit the **Tenancy** parameter or\nset it to `host`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-hostresourcegrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupId": { "MarkdownDocumentation": "`GroupId`\n\nThe Group Id of a placement group. You must specify the Placement Group **Group Id** to launch an instance in a shared placement\ngroup.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-groupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.PrivateDnsNameOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.PrivateDnsNameOptions`\n\nThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privatednsnameoptions.html", "Properties": { "EnableResourceNameDnsARecord": { "MarkdownDocumentation": "`EnableResourceNameDnsARecord`\n\nIndicates whether to respond to DNS queries for instance hostnames with DNS A\nrecords.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privatednsnameoptions.html#cfn-ec2-launchtemplate-privatednsnameoptions-enableresourcenamednsarecord", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "HostnameType": { "MarkdownDocumentation": "`HostnameType`\n\nThe type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be\nbased on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based\non the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance\nIPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `ip-name | resource-name...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ip-name", "resource-name" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privatednsnameoptions.html#cfn-ec2-launchtemplate-privatednsnameoptions-hostnametype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableResourceNameDnsAAAARecord": { "MarkdownDocumentation": "`EnableResourceNameDnsAAAARecord`\n\nIndicates whether to respond to DNS queries for instance hostnames with DNS AAAA\nrecords.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privatednsnameoptions.html#cfn-ec2-launchtemplate-privatednsnameoptions-enableresourcenamednsaaaarecord", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::LaunchTemplate.PrivateIpAdd": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.PrivateIpAdd`\n\nSpecifies a secondary private IPv4 address for a network interface.\n`PrivateIpAdd` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html", "Properties": { "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe private IPv4 address.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-privateipaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Primary": { "MarkdownDocumentation": "`Primary`\n\nIndicates whether the private IPv4 address is the primary private IPv4 address. Only\none IPv4 address can be designated as primary.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-primary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::LaunchTemplate.Reference": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.Reference`\n\nSpecifies an instance family to use as the baseline reference for CPU performance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-reference.html", "Properties": { "InstanceFamily": { "MarkdownDocumentation": "`InstanceFamily`\n\nThe instance family to use as a baseline reference.\n###### Note\nEnsure that you specify the correct value for the instance family. The instance\nfamily is everything before the period (`.`) in the instance type name. For\nexample, in the instance type `c6i.large`, the instance family is\n`c6i`, not `c6`. For more information, see [Amazon EC2\ninstance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance\nTypes*.\nThe following instance families are *not supported* for performance\nprotection:\n* `c1`\n* `g3` | `g3s`\n* `hpc7g`\n* `m1` | `m2`\n* `mac1` | `mac2` | `mac2-m1ultra` |\n `mac2-m2` | `mac2-m2pro`\n* `p3dn` | `p4d` | `p5`\n* `t1`\n* `u-12tb1` | `u-18tb1` | `u-24tb1` |\n `u-3tb1` | `u-6tb1` | `u-9tb1` |\n `u7i-12tb` | `u7in-16tb` | `u7in-24tb` |\n `u7in-32tb`\nIf you enable performance protection by specifying a supported instance family, the\nreturned instance types will exclude the above unsupported instance families.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-reference.html#cfn-ec2-launchtemplate-reference-instancefamily", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.SpotOptions": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.SpotOptions`\n\nSpecifies options for Spot Instances.\n`SpotOptions` is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html", "Properties": { "SpotInstanceType": { "MarkdownDocumentation": "`SpotInstanceType`\n\nThe Spot Instance request type.\nIf you are using Spot Instances with an Auto Scaling group, use `one-time`\nrequests, as the Amazon EC2 Auto Scaling service handles requesting new Spot Instances\nwhenever the group is below its desired capacity.\n*Required*: No\n*Type*: String\n*Allowed values*: `one-time | persistent...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "one-time", "persistent" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-spotinstancetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceInterruptionBehavior": { "MarkdownDocumentation": "`InstanceInterruptionBehavior`\n\nThe behavior when a Spot Instance is interrupted. The default is\n`terminate`.\n*Required*: No\n*Type*: String\n*Allowed values*: `hibernate | stop | terminat...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "hibernate", "stop", "terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-instanceinterruptionbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxPrice": { "MarkdownDocumentation": "`MaxPrice`\n\nThe maximum hourly price you're willing to pay for a Spot Instance. We do not\nrecommend using this parameter because it can lead to increased interruptions. If you do\nnot specify this parameter, you will pay the current Spot price. If you do specify this\nparameter, it must be more than USD $0.001. Specifying a value below USD $0.001 will\nresult in an `InvalidParameterValue` error message when the launch template\nis used to launch an instance.\n###### Important\nIf you specify a maximum price, your Spot Instances will be interrupted more\nfrequently than if you do not specify this parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-maxprice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlockDurationMinutes": { "MarkdownDocumentation": "`BlockDurationMinutes`\n\nDeprecated.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-blockdurationminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ValidUntil": { "MarkdownDocumentation": "`ValidUntil`\n\nThe end date of the request, in UTC format\n(*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for\npersistent requests.\n* For a persistent request, the request remains active until the\n `ValidUntil` date and time is reached. Otherwise, the request\n remains active until you cancel it.\n* For a one-time request, `ValidUntil` is not supported. The request\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-validuntil", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::LaunchTemplate.TagSpecification": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.TagSpecification`\n\nSpecifies the tags to apply to resources that are created during instance launch.\n`TagSpecification` is a property type of [`TagSpecifications`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications).\n[`TagSpecifications`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html", "Properties": { "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource to tag. You can specify tags for the following resource types\nonly: `instance` | `volume` | `network-interface` | `spot-instances-request`.\nIf the instance does not include the resource type that you specify, the instance\nlaunch fails. For example, not all instance types include a volume.\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*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-resourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-launchtemplate-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::EC2::LaunchTemplate.TotalLocalStorageGB": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.TotalLocalStorageGB`\n\nThe minimum and maximum amount of total local storage, in GB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-totallocalstoragegb.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of total local storage, in GB. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-totallocalstoragegb.html#cfn-ec2-launchtemplate-totallocalstoragegb-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of total local storage, in GB. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-totallocalstoragegb.html#cfn-ec2-launchtemplate-totallocalstoragegb-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::LaunchTemplate.VCpuCount": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate.VCpuCount`\n\nThe minimum and maximum number of vCPUs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-vcpucount.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of vCPUs. To specify no minimum limit, specify `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-vcpucount.html#cfn-ec2-launchtemplate-vcpucount-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of vCPUs. To specify no maximum limit, omit this parameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-vcpucount.html#cfn-ec2-launchtemplate-vcpucount-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::NatGateway.AvailabilityZoneAddress": { "MarkdownDocumentation": "`AWS::EC2::NatGateway.AvailabilityZoneAddress`\n\nFor regional NAT gateways only: The configuration specifying which Elastic IP address (EIP) to use for handling outbound NAT traffic from a specific Availability Zone.\nA regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.\nFor more information, see [Regional NAT gateways for automatic multi-AZ expansion](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-natgateway-availabilityzoneaddress.html", "Properties": { "AvailabilityZoneId": { "MarkdownDocumentation": "`AvailabilityZoneId`\n\nFor regional NAT gateways only: The ID of the Availability Zone where this specific NAT gateway configuration will be active. Each AZ in a regional NAT gateway has its own configuration to handle outbound NAT traffic from that AZ. Use this instead of AvailabilityZone for consistent identification of AZs across AWS Regions.\nA regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-natgateway-availabilityzoneaddress.html#cfn-ec2-natgateway-availabilityzoneaddress-availabilityzoneid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nFor regional NAT gateways only: The Availability Zone where this specific NAT gateway configuration will be active. Each AZ in a regional NAT gateway has its own configuration to handle outbound NAT traffic from that AZ.\nA regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-natgateway-availabilityzoneaddress.html#cfn-ec2-natgateway-availabilityzoneaddress-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllocationIds": { "MarkdownDocumentation": "`AllocationIds`\n\nThe allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-natgateway-availabilityzoneaddress.html#cfn-ec2-natgateway-availabilityzoneaddress-allocationids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::EC2::NetworkAclEntry.Icmp": { "MarkdownDocumentation": "`AWS::EC2::NetworkAclEntry.Icmp`\n\nDescribes the ICMP type and code.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe Internet Control Message Protocol (ICMP) type. You can use -1 to specify all ICMP\ntypes. Conditional requirement: Required if you specify 1 (ICMP) for the\n`CreateNetworkAclEntry` protocol parameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe Internet Control Message Protocol (ICMP) code. You can use -1 to specify all ICMP\ncodes for the given ICMP type. Required if you specify 1 (ICMP)\nfor the protocol parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::NetworkAclEntry.PortRange": { "MarkdownDocumentation": "`AWS::EC2::NetworkAclEntry.PortRange`\n\nDescribes a range of ports.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html", "Properties": { "From": { "MarkdownDocumentation": "`From`\n\nThe first port in the range. Required if you specify 6 (TCP) or 17 (UDP) for the\nprotocol parameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-from", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "To": { "MarkdownDocumentation": "`To`\n\nThe last port in the range. Required if you specify 6 (TCP) or 17 (UDP) for the protocol\nparameter.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-to", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::NetworkInsightsAccessScope.AccessScopePathRequest": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAccessScope.AccessScopePathRequest`\n\nDescribes a path.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination.\n*Required*: No\n*Type*: [PathStatementRequest](./aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-destination", "UpdateType": "Immutable", "Required": false, "Type": "PathStatementRequest" }, "ThroughResources": { "MarkdownDocumentation": "`ThroughResources`\n\nThe through resources.\n*Required*: No\n*Type*: Array of [ThroughResourcesStatementRequest](./aws-properties-ec2-networkinsightsaccessscope-throughresourcesstatementrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-throughresources", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ThroughResourcesStatementRequest", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source.\n*Required*: No\n*Type*: [PathStatementRequest](./aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-source", "UpdateType": "Immutable", "Required": false, "Type": "PathStatementRequest" } } }, "AWS::EC2::NetworkInsightsAccessScope.PacketHeaderStatementRequest": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAccessScope.PacketHeaderStatementRequest`\n\nDescribes a packet header statement.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html", "Properties": { "Protocols": { "MarkdownDocumentation": "`Protocols`\n\nThe protocols.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-protocols", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DestinationPorts": { "MarkdownDocumentation": "`DestinationPorts`\n\nThe destination ports.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationports", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DestinationAddresses": { "MarkdownDocumentation": "`DestinationAddresses`\n\nThe destination addresses.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationaddresses", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DestinationPrefixLists": { "MarkdownDocumentation": "`DestinationPrefixLists`\n\nThe destination prefix lists.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationprefixlists", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SourceAddresses": { "MarkdownDocumentation": "`SourceAddresses`\n\nThe source addresses.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceaddresses", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SourcePorts": { "MarkdownDocumentation": "`SourcePorts`\n\nThe source ports.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceports", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SourcePrefixLists": { "MarkdownDocumentation": "`SourcePrefixLists`\n\nThe source prefix lists.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceprefixlists", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EC2::NetworkInsightsAccessScope.PathStatementRequest": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAccessScope.PathStatementRequest`\n\nDescribes a path statement.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html", "Properties": { "ResourceStatement": { "MarkdownDocumentation": "`ResourceStatement`\n\nThe resource statement.\n*Required*: No\n*Type*: [ResourceStatementRequest](./aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html#cfn-ec2-networkinsightsaccessscope-pathstatementrequest-resourcestatement", "UpdateType": "Immutable", "Required": false, "Type": "ResourceStatementRequest" }, "PacketHeaderStatement": { "MarkdownDocumentation": "`PacketHeaderStatement`\n\nThe packet header statement.\n*Required*: No\n*Type*: [PacketHeaderStatementRequest](./aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html#cfn-ec2-networkinsightsaccessscope-pathstatementrequest-packetheaderstatement", "UpdateType": "Immutable", "Required": false, "Type": "PacketHeaderStatementRequest" } } }, "AWS::EC2::NetworkInsightsAccessScope.ResourceStatementRequest": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAccessScope.ResourceStatementRequest`\n\nDescribes a resource statement.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html", "Properties": { "ResourceTypes": { "MarkdownDocumentation": "`ResourceTypes`\n\nThe resource types.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html#cfn-ec2-networkinsightsaccessscope-resourcestatementrequest-resourcetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Resources": { "MarkdownDocumentation": "`Resources`\n\nThe resources.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html#cfn-ec2-networkinsightsaccessscope-resourcestatementrequest-resources", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EC2::NetworkInsightsAccessScope.ThroughResourcesStatementRequest": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAccessScope.ThroughResourcesStatementRequest`\n\nDescribes a through resource statement.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-throughresourcesstatementrequest.html", "Properties": { "ResourceStatement": { "MarkdownDocumentation": "`ResourceStatement`\n\nThe resource statement.\n*Required*: No\n*Type*: [ResourceStatementRequest](./aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-throughresourcesstatementrequest.html#cfn-ec2-networkinsightsaccessscope-throughresourcesstatementrequest-resourcestatement", "UpdateType": "Immutable", "Required": false, "Type": "ResourceStatementRequest" } } }, "AWS::EC2::NetworkInsightsAnalysis.AdditionalDetail": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AdditionalDetail`\n\nDescribes an additional detail for a path analysis. For more information, see [Reachability Analyzer additional detail codes](https://docs.aws.amazon.com/vpc/latest/reachability/additional-detail-codes.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html", "Properties": { "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe name of the VPC endpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-servicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdditionalDetailType": { "MarkdownDocumentation": "`AdditionalDetailType`\n\nThe additional detail 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-additionaldetailtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancers": { "MarkdownDocumentation": "`LoadBalancers`\n\nThe load balancers.\n*Required*: No\n*Type*: Array of [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-loadbalancers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AnalysisComponent", "DuplicatesAllowed": true }, "Component": { "MarkdownDocumentation": "`Component`\n\nThe path component.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-component", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" } } }, "AWS::EC2::NetworkInsightsAnalysis.AlternatePathHint": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AlternatePathHint`\n\nDescribes an potential intermediate component of a feasible path.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-alternatepathhint.html", "Properties": { "ComponentArn": { "MarkdownDocumentation": "`ComponentArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-alternatepathhint.html#cfn-ec2-networkinsightsanalysis-alternatepathhint-componentarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComponentId": { "MarkdownDocumentation": "`ComponentId`\n\nThe ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-alternatepathhint.html#cfn-ec2-networkinsightsanalysis-alternatepathhint-componentid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInsightsAnalysis.AnalysisAclRule": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AnalysisAclRule`\n\nDescribes a network access control (ACL) rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html", "Properties": { "PortRange": { "MarkdownDocumentation": "`PortRange`\n\nThe range of ports.\n*Required*: No\n*Type*: [PortRange](./aws-properties-ec2-networkinsightsanalysis-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-portrange", "UpdateType": "Mutable", "Required": false, "Type": "PortRange" }, "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe IPv4 address range, in CIDR notation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-cidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleAction": { "MarkdownDocumentation": "`RuleAction`\n\nIndicates whether to allow or deny traffic that matches the rule.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-ruleaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Egress": { "MarkdownDocumentation": "`Egress`\n\nIndicates whether the rule is an outbound rule.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-egress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RuleNumber": { "MarkdownDocumentation": "`RuleNumber`\n\nThe rule 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-rulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent`\n\nDescribes a path component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html", "Properties": { "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html#cfn-ec2-networkinsightsanalysis-analysiscomponent-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html#cfn-ec2-networkinsightsanalysis-analysiscomponent-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInsightsAnalysis.AnalysisLoadBalancerListener": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AnalysisLoadBalancerListener`\n\nDescribes a load balancer listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html", "Properties": { "InstancePort": { "MarkdownDocumentation": "`InstancePort`\n\n[Classic Load Balancers] The back-end port for the listener.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancerlistener-instanceport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LoadBalancerPort": { "MarkdownDocumentation": "`LoadBalancerPort`\n\nThe port on which the load balancer is listening.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancerlistener-loadbalancerport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::NetworkInsightsAnalysis.AnalysisLoadBalancerTarget": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AnalysisLoadBalancerTarget`\n\nDescribes a load balancer target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe IP address.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Instance": { "MarkdownDocumentation": "`Instance`\n\nInformation about the instance.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-instance", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port on which the target is listening.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInsightsAnalysis.AnalysisPacketHeader": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AnalysisPacketHeader`\n\nDescribes a header. Reflects any changes made by a component as traffic passes through.\nThe fields of an inbound header are null except for the first component of a path.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html", "Properties": { "DestinationPortRanges": { "MarkdownDocumentation": "`DestinationPortRanges`\n\nThe destination port ranges.\n*Required*: No\n*Type*: Array of [PortRange](./aws-properties-ec2-networkinsightsanalysis-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-destinationportranges", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": true }, "SourcePortRanges": { "MarkdownDocumentation": "`SourcePortRanges`\n\nThe source port ranges.\n*Required*: No\n*Type*: Array of [PortRange](./aws-properties-ec2-networkinsightsanalysis-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-sourceportranges", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": true }, "DestinationAddresses": { "MarkdownDocumentation": "`DestinationAddresses`\n\nThe destination addresses.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-destinationaddresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceAddresses": { "MarkdownDocumentation": "`SourceAddresses`\n\nThe source addresses.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-sourceaddresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EC2::NetworkInsightsAnalysis.AnalysisRouteTableRoute": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AnalysisRouteTableRoute`\n\nDescribes a route table route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html", "Properties": { "Origin": { "MarkdownDocumentation": "`Origin`\n\nDescribes how the route was created. The following are the possible values:\n* CreateRouteTable - The route was automatically created when the route table was created.\n* CreateRoute - The route was manually added to the route table.\n* EnableVgwRoutePropagation - The route was propagated by route propagation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-origin", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "destinationPrefixListId": { "MarkdownDocumentation": "`destinationPrefixListId`\n\nThe prefix of the AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-destinationprefixlistid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of a transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-transitgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcPeeringConnectionId": { "MarkdownDocumentation": "`VpcPeeringConnectionId`\n\nThe ID of a VPC peering 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-vpcpeeringconnectionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "instanceId": { "MarkdownDocumentation": "`instanceId`\n\nThe ID of the instance, such as a NAT 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-instanceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state. The following are the possible values:\n* active\n* blackhole\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "egressOnlyInternetGatewayId": { "MarkdownDocumentation": "`egressOnlyInternetGatewayId`\n\nThe ID of an egress-only internet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-egressonlyinternetgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "destinationCidr": { "MarkdownDocumentation": "`destinationCidr`\n\nThe destination IPv4 address, in CIDR notation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-destinationcidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-networkinterfaceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NatGatewayId": { "MarkdownDocumentation": "`NatGatewayId`\n\nThe ID of a NAT 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-natgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "gatewayId": { "MarkdownDocumentation": "`gatewayId`\n\nThe ID of the gateway, such as an internet gateway or virtual private 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-gatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInsightsAnalysis.AnalysisSecurityGroupRule": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.AnalysisSecurityGroupRule`\n\nDescribes a security group rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html", "Properties": { "PortRange": { "MarkdownDocumentation": "`PortRange`\n\nThe port range.\n*Required*: No\n*Type*: [PortRange](./aws-properties-ec2-networkinsightsanalysis-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-portrange", "UpdateType": "Mutable", "Required": false, "Type": "PortRange" }, "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe IPv4 address range, in CIDR notation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-cidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrefixListId": { "MarkdownDocumentation": "`PrefixListId`\n\nThe prefix list 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-prefixlistid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupId": { "MarkdownDocumentation": "`SecurityGroupId`\n\nThe security group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-securitygroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe direction. The following are the possible values:\n* egress\n* ingress\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-direction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInsightsAnalysis.Explanation": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.Explanation`\n\nDescribes an explanation code for an unreachable path. For more information, see [Reachability Analyzer explanation codes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html", "Properties": { "VpnGateway": { "MarkdownDocumentation": "`VpnGateway`\n\nThe VPN gateway.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpngateway", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "PacketField": { "MarkdownDocumentation": "`PacketField`\n\nThe packet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-packetfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransitGatewayAttachment": { "MarkdownDocumentation": "`TransitGatewayAttachment`\n\nThe transit gateway attachment.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayattachment", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Protocols": { "MarkdownDocumentation": "`Protocols`\n\nThe protocols.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-protocols", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IngressRouteTable": { "MarkdownDocumentation": "`IngressRouteTable`\n\nThe route table.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-ingressroutetable", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "ClassicLoadBalancerListener": { "MarkdownDocumentation": "`ClassicLoadBalancerListener`\n\nThe listener for a Classic Load Balancer.\n*Required*: No\n*Type*: [AnalysisLoadBalancerListener](./aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-classicloadbalancerlistener", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisLoadBalancerListener" }, "VpcPeeringConnection": { "MarkdownDocumentation": "`VpcPeeringConnection`\n\nThe VPC peering connection.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpcpeeringconnection", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Address": { "MarkdownDocumentation": "`Address`\n\nThe IPv4 address, in CIDR notation.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Addresses": { "MarkdownDocumentation": "`Addresses`\n\nThe IPv4 addresses, in CIDR notation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-addresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ElasticLoadBalancerListener": { "MarkdownDocumentation": "`ElasticLoadBalancerListener`\n\nThe load balancer listener.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-elasticloadbalancerlistener", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "TransitGatewayRouteTable": { "MarkdownDocumentation": "`TransitGatewayRouteTable`\n\nThe transit gateway route table.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayroutetable", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "ExplanationCode": { "MarkdownDocumentation": "`ExplanationCode`\n\nThe explanation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-explanationcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InternetGateway": { "MarkdownDocumentation": "`InternetGateway`\n\nThe internet gateway.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-internetgateway", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "SourceVpc": { "MarkdownDocumentation": "`SourceVpc`\n\nThe source VPC.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-sourcevpc", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "AttachedTo": { "MarkdownDocumentation": "`AttachedTo`\n\nThe resource to which the component is attached.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-attachedto", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "PrefixList": { "MarkdownDocumentation": "`PrefixList`\n\nThe prefix list.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-prefixlist", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "TransitGatewayRouteTableRoute": { "MarkdownDocumentation": "`TransitGatewayRouteTableRoute`\n\nThe transit gateway route table route.\n*Required*: No\n*Type*: [TransitGatewayRouteTableRoute](./aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayroutetableroute", "UpdateType": "Mutable", "Required": false, "Type": "TransitGatewayRouteTableRoute" }, "ComponentRegion": { "MarkdownDocumentation": "`ComponentRegion`\n\nThe Region for the component.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-z]{2}-[a-z]+-[1-9]+`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-componentregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancerTargetGroup": { "MarkdownDocumentation": "`LoadBalancerTargetGroup`\n\nThe target group.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetgroup", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "NetworkInterface": { "MarkdownDocumentation": "`NetworkInterface`\n\nThe network interface.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-networkinterface", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "CustomerGateway": { "MarkdownDocumentation": "`CustomerGateway`\n\nThe customer gateway.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-customergateway", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "DestinationVpc": { "MarkdownDocumentation": "`DestinationVpc`\n\nThe destination VPC.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-destinationvpc", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "SecurityGroup": { "MarkdownDocumentation": "`SecurityGroup`\n\nThe security group.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygroup", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "TransitGateway": { "MarkdownDocumentation": "`TransitGateway`\n\nThe transit gateway.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgateway", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "RouteTable": { "MarkdownDocumentation": "`RouteTable`\n\nThe route table.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-routetable", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancerListenerPort": { "MarkdownDocumentation": "`LoadBalancerListenerPort`\n\nThe listener port of the load balancer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancerlistenerport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "vpcEndpoint": { "MarkdownDocumentation": "`vpcEndpoint`\n\nThe VPC endpoint.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpcendpoint", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Subnet": { "MarkdownDocumentation": "`Subnet`\n\nThe subnet.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-subnet", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Cidrs": { "MarkdownDocumentation": "`Cidrs`\n\nThe CIDR ranges.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-cidrs", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-destination", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security groups.\n*Required*: No\n*Type*: Array of [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AnalysisComponent", "DuplicatesAllowed": true }, "ComponentAccount": { "MarkdownDocumentation": "`ComponentAccount`\n\nThe AWS account for the component.\n*Required*: No\n*Type*: String\n*Pattern*: `\\d{12}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-componentaccount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpnConnection": { "MarkdownDocumentation": "`VpnConnection`\n\nThe VPN connection.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpnconnection", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Vpc": { "MarkdownDocumentation": "`Vpc`\n\nThe component VPC.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpc", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "NatGateway": { "MarkdownDocumentation": "`NatGateway`\n\nThe NAT gateway.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-natgateway", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe direction. The following are the possible values:\n* egress\n* ingress\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-direction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancerTargetPort": { "MarkdownDocumentation": "`LoadBalancerTargetPort`\n\nThe target port.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LoadBalancerTarget": { "MarkdownDocumentation": "`LoadBalancerTarget`\n\nThe target.\n*Required*: No\n*Type*: [AnalysisLoadBalancerTarget](./aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertarget", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisLoadBalancerTarget" }, "LoadBalancerTargetGroups": { "MarkdownDocumentation": "`LoadBalancerTargetGroups`\n\nThe target groups.\n*Required*: No\n*Type*: Array of [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AnalysisComponent", "DuplicatesAllowed": true }, "Component": { "MarkdownDocumentation": "`Component`\n\nThe component.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-component", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "MissingComponent": { "MarkdownDocumentation": "`MissingComponent`\n\nThe missing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-missingcomponent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RouteTableRoute": { "MarkdownDocumentation": "`RouteTableRoute`\n\nThe route table route.\n*Required*: No\n*Type*: [AnalysisRouteTableRoute](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-routetableroute", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisRouteTableRoute" }, "AvailabilityZones": { "MarkdownDocumentation": "`AvailabilityZones`\n\nThe Availability Zones.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-availabilityzones", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PortRanges": { "MarkdownDocumentation": "`PortRanges`\n\nThe port ranges.\n*Required*: No\n*Type*: Array of [PortRange](./aws-properties-ec2-networkinsightsanalysis-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-portranges", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": true }, "Acl": { "MarkdownDocumentation": "`Acl`\n\nThe network ACL.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-acl", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "SecurityGroupRule": { "MarkdownDocumentation": "`SecurityGroupRule`\n\nThe security group rule.\n*Required*: No\n*Type*: [AnalysisSecurityGroupRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygrouprule", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisSecurityGroupRule" }, "SubnetRouteTable": { "MarkdownDocumentation": "`SubnetRouteTable`\n\nThe route table for the subnet.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-subnetroutetable", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "LoadBalancerArn": { "MarkdownDocumentation": "`LoadBalancerArn`\n\nThe Amazon Resource Name (ARN) of the load balancer.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1283`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancerarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AclRule": { "MarkdownDocumentation": "`AclRule`\n\nThe network ACL rule.\n*Required*: No\n*Type*: [AnalysisAclRule](./aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-aclrule", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisAclRule" } } }, "AWS::EC2::NetworkInsightsAnalysis.PathComponent": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.PathComponent`\n\nDescribes a path component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html", "Properties": { "AdditionalDetails": { "MarkdownDocumentation": "`AdditionalDetails`\n\nThe additional details.\n*Required*: No\n*Type*: Array of [AdditionalDetail](./aws-properties-ec2-networkinsightsanalysis-additionaldetail.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-additionaldetails", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AdditionalDetail", "DuplicatesAllowed": true }, "InboundHeader": { "MarkdownDocumentation": "`InboundHeader`\n\nThe inbound header.\n*Required*: No\n*Type*: [AnalysisPacketHeader](./aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-inboundheader", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisPacketHeader" }, "Vpc": { "MarkdownDocumentation": "`Vpc`\n\nThe component VPC.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-vpc", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "DestinationVpc": { "MarkdownDocumentation": "`DestinationVpc`\n\nThe destination VPC.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-destinationvpc", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "SecurityGroupRule": { "MarkdownDocumentation": "`SecurityGroupRule`\n\nThe security group rule.\n*Required*: No\n*Type*: [AnalysisSecurityGroupRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-securitygrouprule", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisSecurityGroupRule" }, "TransitGateway": { "MarkdownDocumentation": "`TransitGateway`\n\nThe transit gateway.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-transitgateway", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "ElasticLoadBalancerListener": { "MarkdownDocumentation": "`ElasticLoadBalancerListener`\n\nThe load balancer listener.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-elasticloadbalancerlistener", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Explanations": { "MarkdownDocumentation": "`Explanations`\n\nThe explanation codes.\n*Required*: No\n*Type*: Array of [Explanation](./aws-properties-ec2-networkinsightsanalysis-explanation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-explanations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Explanation", "DuplicatesAllowed": true }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe name of the VPC endpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-servicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SequenceNumber": { "MarkdownDocumentation": "`SequenceNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-sequencenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SourceVpc": { "MarkdownDocumentation": "`SourceVpc`\n\nThe source VPC.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-sourcevpc", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "OutboundHeader": { "MarkdownDocumentation": "`OutboundHeader`\n\nThe outbound header.\n*Required*: No\n*Type*: [AnalysisPacketHeader](./aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-outboundheader", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisPacketHeader" }, "AclRule": { "MarkdownDocumentation": "`AclRule`\n\nThe network ACL rule.\n*Required*: No\n*Type*: [AnalysisAclRule](./aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-aclrule", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisAclRule" }, "TransitGatewayRouteTableRoute": { "MarkdownDocumentation": "`TransitGatewayRouteTableRoute`\n\nThe route in a transit gateway route table.\n*Required*: No\n*Type*: [TransitGatewayRouteTableRoute](./aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-transitgatewayroutetableroute", "UpdateType": "Mutable", "Required": false, "Type": "TransitGatewayRouteTableRoute" }, "Component": { "MarkdownDocumentation": "`Component`\n\nThe component.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-component", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "Subnet": { "MarkdownDocumentation": "`Subnet`\n\nThe subnet.\n*Required*: No\n*Type*: [AnalysisComponent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-subnet", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisComponent" }, "RouteTableRoute": { "MarkdownDocumentation": "`RouteTableRoute`\n\nThe route table route.\n*Required*: No\n*Type*: [AnalysisRouteTableRoute](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-routetableroute", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisRouteTableRoute" } } }, "AWS::EC2::NetworkInsightsAnalysis.PortRange": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.PortRange`\n\nDescribes a range of ports.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-portrange.html", "Properties": { "From": { "MarkdownDocumentation": "`From`\n\nThe first port in the range.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-portrange.html#cfn-ec2-networkinsightsanalysis-portrange-from", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "To": { "MarkdownDocumentation": "`To`\n\nThe last port in the range.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-portrange.html#cfn-ec2-networkinsightsanalysis-portrange-to", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::NetworkInsightsAnalysis.TransitGatewayRouteTableRoute": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis.TransitGatewayRouteTableRoute`\n\nDescribes a route in a transit gateway route table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html", "Properties": { "PrefixListId": { "MarkdownDocumentation": "`PrefixListId`\n\nThe ID of the prefix 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-prefixlistid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the resource for the route attachment.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-resourceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe resource type for the route attachment.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-resourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RouteOrigin": { "MarkdownDocumentation": "`RouteOrigin`\n\nThe route origin. The following are the possible values:\n* static\n* propagated\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-routeorigin", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationCidr": { "MarkdownDocumentation": "`DestinationCidr`\n\nThe CIDR block used for destination matches.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-destinationcidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttachmentId": { "MarkdownDocumentation": "`AttachmentId`\n\nThe ID of the route attachment.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-attachmentid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInsightsPath.FilterPortRange": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsPath.FilterPortRange`\n\nDescribes a port range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-filterportrange.html", "Properties": { "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nThe first port in the range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-filterportrange.html#cfn-ec2-networkinsightspath-filterportrange-fromport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nThe last port in the range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-filterportrange.html#cfn-ec2-networkinsightspath-filterportrange-toport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::NetworkInsightsPath.PathFilter": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsPath.PathFilter`\n\nDescribes a set of filters for a path analysis. Use path filters to scope the analysis when\nthere can be multiple resulting paths.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html", "Properties": { "SourceAddress": { "MarkdownDocumentation": "`SourceAddress`\n\nThe source IPv4 address.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`\n*Minimum*: `0`\n*Maximum*: `15`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-sourceaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DestinationPortRange": { "MarkdownDocumentation": "`DestinationPortRange`\n\nThe destination port range.\n*Required*: No\n*Type*: [FilterPortRange](./aws-properties-ec2-networkinsightspath-filterportrange.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-destinationportrange", "UpdateType": "Immutable", "Required": false, "Type": "FilterPortRange" }, "SourcePortRange": { "MarkdownDocumentation": "`SourcePortRange`\n\nThe source port range.\n*Required*: No\n*Type*: [FilterPortRange](./aws-properties-ec2-networkinsightspath-filterportrange.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-sourceportrange", "UpdateType": "Immutable", "Required": false, "Type": "FilterPortRange" }, "DestinationAddress": { "MarkdownDocumentation": "`DestinationAddress`\n\nThe destination IPv4 address.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`\n*Minimum*: `0`\n*Maximum*: `15`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-destinationaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInterface.ConnectionTrackingSpecification": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterface.ConnectionTrackingSpecification`\n\nConfigurable options for connection tracking on a network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon Elastic Compute Cloud User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-connectiontrackingspecification.html", "Properties": { "UdpTimeout": { "MarkdownDocumentation": "`UdpTimeout`\n\nTimeout (in seconds) for idle UDP flows that\nhave seen traffic only in a single direction or a single request-response\ntransaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-connectiontrackingspecification.html#cfn-ec2-networkinterface-connectiontrackingspecification-udptimeout", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "TcpEstablishedTimeout": { "MarkdownDocumentation": "`TcpEstablishedTimeout`\n\nTimeout (in seconds) for idle TCP\nconnections in an established state. Min: 60 seconds. Max: 432000 seconds (5\ndays). Default: 432000 seconds. Recommended: Less than 432000 seconds.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-connectiontrackingspecification.html#cfn-ec2-networkinterface-connectiontrackingspecification-tcpestablishedtimeout", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "UdpStreamTimeout": { "MarkdownDocumentation": "`UdpStreamTimeout`\n\nTimeout (in seconds) for idle UDP\nflows classified as streams which have seen more than one request-response\ntransaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180\nseconds.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-connectiontrackingspecification.html#cfn-ec2-networkinterface-connectiontrackingspecification-udpstreamtimeout", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::NetworkInterface.InstanceIpv6Address": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterface.InstanceIpv6Address`\n\nDescribes the IPv6 addresses to associate with the network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html", "Properties": { "Ipv6Address": { "MarkdownDocumentation": "`Ipv6Address`\n\nAn IPv6 address to associate with the network interface.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html#cfn-ec2-networkinterface-instanceipv6address-ipv6address", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInterface.Ipv4PrefixSpecification": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterface.Ipv4PrefixSpecification`\n\nDescribes an IPv4 prefix.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-ipv4prefixspecification.html", "Properties": { "Ipv4Prefix": { "MarkdownDocumentation": "`Ipv4Prefix`\n\nThe IPv4 prefix. For information, see [Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-ipv4prefixspecification.html#cfn-ec2-networkinterface-ipv4prefixspecification-ipv4prefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInterface.Ipv6PrefixSpecification": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterface.Ipv6PrefixSpecification`\n\nDescribes the IPv6 prefix.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-ipv6prefixspecification.html", "Properties": { "Ipv6Prefix": { "MarkdownDocumentation": "`Ipv6Prefix`\n\nThe IPv6 prefix. For information, see [Assigning prefixes to Amazon EC2 network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the\n*Amazon Elastic Compute Cloud 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-ipv6prefixspecification.html#cfn-ec2-networkinterface-ipv6prefixspecification-ipv6prefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInterface.PrivateIpAddressSpecification": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterface.PrivateIpAddressSpecification`\n\nDescribes a secondary private IPv4 address for a network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-privateipaddressspecification.html", "Properties": { "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe private IP address of the network interface.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-privateipaddressspecification.html#cfn-ec2-networkinterface-privateipaddressspecification-privateipaddress", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "Primary": { "MarkdownDocumentation": "`Primary`\n\nSets the private IP address as the primary private address. You can set only one primary\nprivate IP address. If you don't specify a primary private IP address, Amazon EC2\nautomatically assigns a primary private IP address.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-privateipaddressspecification.html#cfn-ec2-networkinterface-privateipaddressspecification-primary", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::EC2::NetworkInterface.PublicIpDnsNameOptions": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterface.PublicIpDnsNameOptions`\n\nPublic hostname type options. For more information, see [EC2 instance hostnames, DNS names, and domains](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-publicipdnsnameoptions.html", "Properties": { "DnsHostnameType": { "MarkdownDocumentation": "`DnsHostnameType`\n\nThe public hostname type. For more information, see [EC2 instance hostnames, DNS names, and domains](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-publicipdnsnameoptions.html#cfn-ec2-networkinterface-publicipdnsnameoptions-dnshostnametype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PublicIpv4DnsName": { "MarkdownDocumentation": "`PublicIpv4DnsName`\n\nAn IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-publicipdnsnameoptions.html#cfn-ec2-networkinterface-publicipdnsnameoptions-publicipv4dnsname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PublicDualStackDnsName": { "MarkdownDocumentation": "`PublicDualStackDnsName`\n\nA dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-publicipdnsnameoptions.html#cfn-ec2-networkinterface-publicipdnsnameoptions-publicdualstackdnsname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PublicIpv6DnsName": { "MarkdownDocumentation": "`PublicIpv6DnsName`\n\nAn IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-publicipdnsnameoptions.html#cfn-ec2-networkinterface-publicipdnsnameoptions-publicipv6dnsname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::NetworkInterfaceAttachment.EnaSrdSpecification": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterfaceAttachment.EnaSrdSpecification`\n\nENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the\nmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.\nWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same\naccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\nTo improve the reliability of network packet delivery, ENA Express reorders network packets on the\nreceiving end by default. However, some UDP-based applications are designed to handle network packets\nthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express\nis enabled, you can specify whether UDP network traffic uses it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterfaceattachment-enasrdspecification.html", "Properties": { "EnaSrdEnabled": { "MarkdownDocumentation": "`EnaSrdEnabled`\n\nIndicates whether ENA Express is enabled for the network interface.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterfaceattachment-enasrdspecification.html#cfn-ec2-networkinterfaceattachment-enasrdspecification-enasrdenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnaSrdUdpSpecification": { "MarkdownDocumentation": "`EnaSrdUdpSpecification`\n\nConfigures ENA Express for UDP network traffic.\n*Required*: No\n*Type*: [EnaSrdUdpSpecification](./aws-properties-ec2-networkinterfaceattachment-enasrdudpspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterfaceattachment-enasrdspecification.html#cfn-ec2-networkinterfaceattachment-enasrdspecification-enasrdudpspecification", "UpdateType": "Mutable", "Required": false, "Type": "EnaSrdUdpSpecification" } } }, "AWS::EC2::NetworkInterfaceAttachment.EnaSrdUdpSpecification": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterfaceAttachment.EnaSrdUdpSpecification`\n\nENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic\nautomatically uses it. However, some UDP-based applications are designed to handle network packets that are\nout of order, without a need for retransmission, such as live video broadcasting or other near-real-time\napplications. For UDP traffic, you can specify whether to use ENA Express, based on your application\nenvironment needs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterfaceattachment-enasrdudpspecification.html", "Properties": { "EnaSrdUdpEnabled": { "MarkdownDocumentation": "`EnaSrdUdpEnabled`\n\nIndicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting,\nyou must first enable ENA Express.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterfaceattachment-enasrdudpspecification.html#cfn-ec2-networkinterfaceattachment-enasrdudpspecification-enasrdudpenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::PrefixList.Entry": { "MarkdownDocumentation": "`AWS::EC2::PrefixList.Entry`\n\nAn entry for a prefix list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-prefixlist-entry.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the entry.\nConstraints: Up to 255 characters in length.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-prefixlist-entry.html#cfn-ec2-prefixlist-entry-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR block.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `46`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-prefixlist-entry.html#cfn-ec2-prefixlist-entry-cidr", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::RouteServerPeer.BgpOptions": { "MarkdownDocumentation": "`AWS::EC2::RouteServerPeer.BgpOptions`\n\nThe BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-routeserverpeer-bgpoptions.html", "Properties": { "PeerLivenessDetection": { "MarkdownDocumentation": "`PeerLivenessDetection`\n\nThe liveness detection protocol used for the BGP peer.\nThe requested liveness detection protocol for the BGP peer.\n* `bgp-keepalive`: The standard BGP keep alive mechanism ([RFC4271](https://www.rfc-editor.org/rfc/rfc4271#page-21)) that is stable but may take longer to fail-over in cases of network impact or router failure.\n* `bfd`: An additional Bidirectional Forwarding Detection (BFD) protocol ([RFC5880](https://www.rfc-editor.org/rfc/rfc5880)) that enables fast failover by using more sensitive liveness detection.\nDefaults to `bgp-keepalive`.\n*Required*: No\n*Type*: String\n*Allowed values*: `bfd | bgp-keepalive...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "bfd", "bgp-keepalive" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-routeserverpeer-bgpoptions.html#cfn-ec2-routeserverpeer-bgpoptions-peerlivenessdetection", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PeerAsn": { "MarkdownDocumentation": "`PeerAsn`\n\nThe Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512\u201365534 (16-bit ASN) or 4200000000\u20134294967294 (32-bit ASN) range.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `4294967294`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-routeserverpeer-bgpoptions.html#cfn-ec2-routeserverpeer-bgpoptions-peerasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Long" } } }, "AWS::EC2::SecurityGroup.Egress": { "MarkdownDocumentation": "`AWS::EC2::SecurityGroup.Egress`\n\nAdds the specified outbound (egress) rule to a security group.\nAn outbound rule permits instances to send traffic to the specified IPv4 or IPv6\naddress range, the IP address ranges that are specified by a prefix list, or the instances\nthat are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).\nYou must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range,\na prefix list, or a security group.\nYou must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP,\nyou must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also\nspecify the ICMP/ICMPv6 type and code.\nRule changes are propagated to instances associated with the security group as quickly\nas possible. However, a small delay might occur.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html", "Properties": { "CidrIp": { "MarkdownDocumentation": "`CidrIp`\n\nThe IPv4 address range, in CIDR format.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `DestinationPrefixListId`, or `DestinationSecurityGroupId`.\nFor examples of rules that you can add to security groups for specific access scenarios,\nsee [Security group rules\nfor different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-cidrip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CidrIpv6": { "MarkdownDocumentation": "`CidrIpv6`\n\nThe IPv6 address range, in CIDR format.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `DestinationPrefixListId`, or `DestinationSecurityGroupId`.\nFor examples of rules that you can add to security groups for specific access scenarios,\nsee [Security group rules\nfor different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-cidripv6", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the security group rule.\nConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\nspaces, and .\\_-:/()#,@[]+=;{}!$\\*\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nIf the protocol is TCP or UDP, this is the start of the port range.\nIf the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-fromport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nIf the protocol is TCP or UDP, this is the end of the port range.\nIf the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes).\nIf the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-toport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IpProtocol": { "MarkdownDocumentation": "`IpProtocol`\n\nThe IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`)\nor number (see [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).\nUse `-1` to specify all protocols. When authorizing\nsecurity group rules, specifying `-1` or a protocol number other than\n`tcp`, `udp`, `icmp`, or `icmpv6` allows\ntraffic on all ports, regardless of any port range you specify. For `tcp`,\n`udp`, and `icmp`, you must specify a port range. For `icmpv6`,\nthe port range is optional; if you omit the port range, traffic for all types and codes is allowed.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-ipprotocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DestinationSecurityGroupId": { "MarkdownDocumentation": "`DestinationSecurityGroupId`\n\nThe ID of the destination VPC security group.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `DestinationPrefixListId`, or `DestinationSecurityGroupId`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-destinationsecuritygroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationPrefixListId": { "MarkdownDocumentation": "`DestinationPrefixListId`\n\nThe prefix list IDs for the destination AWS service.\nThis is the AWS service that you want to access through a VPC endpoint\nfrom instances associated with the security group.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `DestinationPrefixListId`, or `DestinationSecurityGroupId`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-destinationprefixlistid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::SecurityGroup.Ingress": { "MarkdownDocumentation": "`AWS::EC2::SecurityGroup.Ingress`\n\nAdds an inbound (ingress) rule to a security group.\nAn inbound rule permits instances to receive traffic from the specified IPv4 or IPv6\naddress range, the IP address ranges that are specified by a prefix list, or the instances\nthat are associated with a source security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).\nYou must specify exactly one of the following sources: an IPv4 address range, an IPv6 address range,\na prefix list, or a security group.\nYou must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP,\nyou must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also\nspecify the ICMP/ICMPv6 type and code.\nRule changes are propagated to instances associated with the security group as quickly\nas possible. However, a small delay might occur.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html", "Properties": { "CidrIp": { "MarkdownDocumentation": "`CidrIp`\n\nThe IPv4 address range, in CIDR format.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `SourcePrefixListId`, or `SourceSecurityGroupId`.\nFor examples of rules that you can add to\nsecurity groups for specific access scenarios, see [Security group rules\nfor different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-cidrip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CidrIpv6": { "MarkdownDocumentation": "`CidrIpv6`\n\nThe IPv6 address range, in CIDR format.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `SourcePrefixListId`, or `SourceSecurityGroupId`.\nFor examples of rules that you can add to\nsecurity groups for specific access scenarios, see [Security group rules\nfor different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-cidripv6", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nUpdates the description of an ingress (inbound) security group rule. You can replace an\nexisting description, or add a description to a rule that did not have one\npreviously.\nConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\nspaces, and .\\_-:/()#,@[]+=;{}!$\\*\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nIf the protocol is TCP or UDP, this is the start of the port range.\nIf the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-fromport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SourceSecurityGroupName": { "MarkdownDocumentation": "`SourceSecurityGroupName`\n\n[Default VPC] The name of the source security group. You must specify either the security group ID\nor the security group name. You can't specify the group name in combination with an IP address range.\nCreates rules that grant full ICMP, UDP, and TCP access.\nFor security groups in a nondefault VPC, you must specify the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-sourcesecuritygroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nIf the protocol is TCP or UDP, this is the end of the port range.\nIf the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes).\nIf the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-toport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SourceSecurityGroupOwnerId": { "MarkdownDocumentation": "`SourceSecurityGroupOwnerId`\n\n[nondefault VPC] The AWS account ID for the source security group, if\nthe source security group is in a different account. You can't specify this property with\nan IP address range. Creates rules that grant full ICMP, UDP, and TCP access.\nIf you specify `SourceSecurityGroupName` or\n`SourceSecurityGroupId` and that security group is owned by a different\naccount than the account creating the stack, you must specify the\n`SourceSecurityGroupOwnerId`; otherwise, this property is optional.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-sourcesecuritygroupownerid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpProtocol": { "MarkdownDocumentation": "`IpProtocol`\n\nThe IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`)\nor number (see [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).\nUse `-1` to specify all protocols. When authorizing\nsecurity group rules, specifying `-1` or a protocol number other than\n`tcp`, `udp`, `icmp`, or `icmpv6` allows\ntraffic on all ports, regardless of any port range you specify. For `tcp`,\n`udp`, and `icmp`, you must specify a port range. For `icmpv6`,\nthe port range is optional; if you omit the port range, traffic for all types and codes is allowed.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-ipprotocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceSecurityGroupId": { "MarkdownDocumentation": "`SourceSecurityGroupId`\n\nThe ID of the security 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-sourcesecuritygroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourcePrefixListId": { "MarkdownDocumentation": "`SourcePrefixListId`\n\nThe ID of a prefix 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-sourceprefixlistid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.AcceleratorCountRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.AcceleratorCountRequest`\n\nThe minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips)\non an instance. To exclude accelerator-enabled instance types, set `Max` to\n`0`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratorcountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of accelerators. To specify no minimum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratorcountrequest.html#cfn-ec2-spotfleet-acceleratorcountrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of accelerators. To specify no maximum limit, omit this\nparameter. To exclude accelerator-enabled instance types, set `Max` to\n`0`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratorcountrequest.html#cfn-ec2-spotfleet-acceleratorcountrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::SpotFleet.AcceleratorTotalMemoryMiBRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.AcceleratorTotalMemoryMiBRequest`\n\nThe minimum and maximum amount of total accelerator memory, in MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html#cfn-ec2-spotfleet-acceleratortotalmemorymibrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html#cfn-ec2-spotfleet-acceleratortotalmemorymibrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::SpotFleet.BaselineEbsBandwidthMbpsRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.BaselineEbsBandwidthMbpsRequest`\n\nThe minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n[Amazon\nEBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit\nthis parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-spotfleet-baselineebsbandwidthmbpsrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit\nthis parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-spotfleet-baselineebsbandwidthmbpsrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::SpotFleet.BaselinePerformanceFactorsRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.BaselinePerformanceFactorsRequest`\n\nThe baseline performance to consider, using an instance family as a baseline reference.\nThe instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\nbaseline to guide instance type selection, but there is no guarantee that the selected\ninstance types will always exceed the baseline for every application.\nCurrently, this parameter only supports CPU performance as a baseline performance\nfactor. For example, specifying `c6i` would use the CPU performance of the\n`c6i` family as the baseline reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineperformancefactorsrequest.html", "Properties": { "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe CPU performance to consider, using an instance family as the baseline reference.\n*Required*: No\n*Type*: [CpuPerformanceFactorRequest](./aws-properties-ec2-spotfleet-cpuperformancefactorrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineperformancefactorsrequest.html#cfn-ec2-spotfleet-baselineperformancefactorsrequest-cpu", "UpdateType": "Immutable", "Required": false, "Type": "CpuPerformanceFactorRequest" } } }, "AWS::EC2::SpotFleet.BlockDeviceMapping": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.BlockDeviceMapping`\n\nSpecifies a block device mapping.\nYou can specify `Ebs` or `VirtualName`, but not both.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html", "Properties": { "Ebs": { "MarkdownDocumentation": "`Ebs`\n\nParameters used to automatically set up EBS volumes when the instance is\nlaunched.\n*Required*: Conditional\n*Type*: [EbsBlockDevice](./aws-properties-ec2-spotfleet-ebsblockdevice.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-ebs", "UpdateType": "Immutable", "Required": false, "Type": "EbsBlockDevice" }, "NoDevice": { "MarkdownDocumentation": "`NoDevice`\n\nTo omit the device from the block device mapping, specify an empty string. When this\nproperty is specified, the device is removed from the block device mapping regardless of\nthe assigned 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-nodevice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VirtualName": { "MarkdownDocumentation": "`VirtualName`\n\nThe virtual device name (`ephemeral`N). Instance store volumes are numbered\nstarting from 0. An instance type with 2 available instance store volumes can specify\nmappings for `ephemeral0` and `ephemeral1`. The number of\navailable instance store volumes depends on the instance type. After you connect to the\ninstance, you must mount the volume.\nNVMe instance store volumes are automatically enumerated and assigned a device name.\nIncluding them in your block device mapping has no effect.\nConstraints: For M3 instances, you must specify instance store volumes in the block\ndevice mapping for the instance. When you launch an M3 instance, we ignore any instance\nstore volumes specified in the block device mapping for the AMI.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-virtualname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe device name. For available device names, see [Device names for volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-devicename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.ClassicLoadBalancer": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.ClassicLoadBalancer`\n\nSpecifies a Classic Load Balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancer.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the load balancer.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancer.html#cfn-ec2-spotfleet-classicloadbalancer-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.ClassicLoadBalancersConfig": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.ClassicLoadBalancersConfig`\n\nSpecifies the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the\nrunning Spot Instances with these Classic Load Balancers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancersconfig.html", "Properties": { "ClassicLoadBalancers": { "MarkdownDocumentation": "`ClassicLoadBalancers`\n\nOne or more Classic Load Balancers.\n*Required*: Yes\n*Type*: Array of [ClassicLoadBalancer](./aws-properties-ec2-spotfleet-classicloadbalancer.html)\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancersconfig.html#cfn-ec2-spotfleet-classicloadbalancersconfig-classicloadbalancers", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "ClassicLoadBalancer", "DuplicatesAllowed": false } } }, "AWS::EC2::SpotFleet.CpuPerformanceFactorRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.CpuPerformanceFactorRequest`\n\nThe CPU performance to consider, using an instance family as the baseline reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-cpuperformancefactorrequest.html", "Properties": { "References": { "MarkdownDocumentation": "`References`\n\nSpecify an instance family to use as the baseline reference for CPU performance. All\ninstance types that match your specified attributes will be compared against the CPU\nperformance of the referenced instance family, regardless of CPU manufacturer or\narchitecture differences.\n###### Note\nCurrently, only one instance family can be specified in the list.\n*Required*: No\n*Type*: Array of [PerformanceFactorReferenceRequest](./aws-properties-ec2-spotfleet-performancefactorreferencerequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-cpuperformancefactorrequest.html#cfn-ec2-spotfleet-cpuperformancefactorrequest-references", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "PerformanceFactorReferenceRequest", "DuplicatesAllowed": true } } }, "AWS::EC2::SpotFleet.EbsBlockDevice": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.EbsBlockDevice`\n\nDescribes a block device for an EBS volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html", "Properties": { "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-snapshotid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the\n*Amazon EBS User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `gp2 | gp3 | io1 | io2 | sc1...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "gp2", "gp3", "io1", "io2", "sc1", "st1", "standard" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-volumetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nIndicates whether the encryption state of an EBS volume is changed while being restored\nfrom a backing snapshot. The effect of setting the encryption state to `true`\ndepends on the volume origin (new or from a snapshot), starting encryption state,\nownership, and whether encryption by default is enabled. For more information, see [Amazon EBS\nEncryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) in the *Amazon EC2 User Guide*.\nIn no case can you remove encryption from an encrypted volume.\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption.\nFor more information, see [Supported Instance Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).\nThis parameter is not returned by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-encrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS). For `gp3`, `io1`, and `io2` volumes,\nthis represents the number of IOPS that are provisioned for the volume. For `gp2`\nvolumes, this represents the baseline performance of the volume and the rate at which\nthe volume accumulates I/O credits for bursting.\nThe following are the supported values for each volume type:\n* `gp3`: 3,000 - 80,000 IOPS\n* `io1`: 100 - 64,000 IOPS\n* `io2`: 100 - 256,000 IOPS\nFor `io2` volumes, you can achieve up to 256,000 IOPS on\n[instances\nbuilt on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.\nThis parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes\nis 3,000 IOPS.\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-iops", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume\nsize. If you specify a snapshot, the default is the snapshot size. You can specify a\nvolume size that is equal to or larger than the snapshot size.\nThe following are the supported sizes for each volume type:\n* `gp2`: 1 - 16,384 GiB\n* `gp3`: 1 - 65,536 GiB\n* `io1`: 4 - 16,384 GiB\n* `io2`: 4 - 65,536 GiB\n* `st1` and `sc1`: 125 - 16,384 GiB\n* `standard`: 1 - 1024 GiB\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-volumesize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nIndicates whether the EBS volume is deleted on instance termination. For more\ninformation, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-deleteontermination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::SpotFleet.FleetLaunchTemplateSpecification": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.FleetLaunchTemplateSpecification`\n\nSpecifies the launch template to be used by the Spot Fleet request for configuring Amazon EC2 instances.\nYou must specify the following:\n* The ID or the name of the launch template, but not both.\n* The version of the launch template.\n`FleetLaunchTemplateSpecification` is a property of the [AWS::EC2::SpotFleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html) resource.\nFor information about creating a launch template, see\n[AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and\n[Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template)\nin the *Amazon EC2 User Guide*.\nFor examples of launch templates, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html", "Properties": { "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nThe name of the launch template.\nYou must specify the `LaunchTemplateName` or the `LaunchTemplateId`, but not both.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\(\\)\\.\\-/_]+`\n*Minimum*: `3`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplatename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version number of the launch template.\nSpecifying `$Latest` or `$Default` for the template version number\nis not supported. However, you can specify\n`LatestVersionNumber` or `DefaultVersionNumber` using the\n`Fn::GetAtt` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate-return-values-fn--getatt).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nThe ID of the launch template.\nYou must specify the `LaunchTemplateId` or the `LaunchTemplateName`, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplateid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.GroupIdentifier": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.GroupIdentifier`\n\nDescribes a security group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-groupidentifier.html", "Properties": { "GroupId": { "MarkdownDocumentation": "`GroupId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-groupidentifier.html#cfn-ec2-spotfleet-groupidentifier-groupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.IamInstanceProfileSpecification": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.IamInstanceProfileSpecification`\n\nDescribes an IAM instance profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-iaminstanceprofilespecification.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the instance profile.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-iaminstanceprofilespecification.html#cfn-ec2-spotfleet-iaminstanceprofilespecification-arn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.InstanceIpv6Address": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.InstanceIpv6Address`\n\nDescribes an IPv6 address.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html", "Properties": { "Ipv6Address": { "MarkdownDocumentation": "`Ipv6Address`\n\nThe IPv6 address.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html#cfn-ec2-spotfleet-instanceipv6address-ipv6address", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.InstanceNetworkInterfaceSpecification": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.InstanceNetworkInterfaceSpecification`\n\nDescribes a network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the network interface. Applies only if creating a network interface\nwhen launching an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PrivateIpAddresses": { "MarkdownDocumentation": "`PrivateIpAddresses`\n\nThe private IPv4 addresses to assign to the network interface. Only one private IPv4\naddress can be designated as primary. You cannot specify this option if you're launching\nmore than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html)\nrequest.\n*Required*: No\n*Type*: Array of [PrivateIpAddressSpecification](./aws-properties-ec2-spotfleet-privateipaddressspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-privateipaddresses", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "PrivateIpAddressSpecification", "DuplicatesAllowed": false }, "SecondaryPrivateIpAddressCount": { "MarkdownDocumentation": "`SecondaryPrivateIpAddressCount`\n\nThe number of secondary private IPv4 addresses. You can\u2019t specify this parameter and\nalso specify a secondary private IP address using the `PrivateIpAddress`\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-secondaryprivateipaddresscount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DeviceIndex": { "MarkdownDocumentation": "`DeviceIndex`\n\nThe position of the network interface in the attachment order. A primary network\ninterface has a device index of 0.\nIf you specify a network interface when launching an instance, you must specify the\ndevice index.\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deviceindex", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe IDs of the security groups for the network interface. Applies only if creating a\nnetwork interface when launching an instance.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-groups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Ipv6AddressCount": { "MarkdownDocumentation": "`Ipv6AddressCount`\n\nA number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the\nIPv6 addresses from the range of the subnet. You cannot specify this option and the\noption to assign specific IPv6 addresses in the same request. You can specify this\noption if you've specified a minimum number of instances to launch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresscount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv6Addresses": { "MarkdownDocumentation": "`Ipv6Addresses`\n\nThe IPv6 addresses to assign to the network interface. You cannot specify this option\nand the option to assign a number of IPv6 addresses in the same request. You cannot\nspecify this option if you've specified a minimum number of instances to launch.\n*Required*: No\n*Type*: Array of [InstanceIpv6Address](./aws-properties-ec2-spotfleet-instanceipv6address.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresses", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "InstanceIpv6Address", "DuplicatesAllowed": false }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet associated with the network 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-subnetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AssociatePublicIpAddress": { "MarkdownDocumentation": "`AssociatePublicIpAddress`\n\nIndicates whether to assign a public IPv4 address to an instance you launch in a VPC.\nThe public IP address can only be assigned to a network interface for eth0, and can only\nbe assigned to a new network interface, not an existing one. You cannot specify more\nthan one network interface in the request. If launching into a default subnet, the\ndefault value is `true`.\nAWS charges for all public IPv4 addresses, including public IPv4 addresses\nassociated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://aws.amazon.com/vpc/pricing/).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-associatepublicipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of the network interface.\nIf you are creating a Spot Fleet, omit this parameter because you can\u2019t specify a\nnetwork interface ID in a launch specification.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-networkinterfaceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nIndicates whether the network interface is deleted when the instance is\nterminated.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deleteontermination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::SpotFleet.InstanceRequirementsRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.InstanceRequirementsRequest`\n\nThe attributes for the instance types. When you specify instance attributes, Amazon EC2 will\nidentify instance types with these attributes.\nYou must specify `VCpuCount` and `MemoryMiB`. All other attributes\nare optional. Any unspecified optional attribute is set to its default.\nWhen you specify multiple attributes, you get instance types that satisfy all of the\nspecified attributes. If you specify multiple values for an attribute, you get instance\ntypes that satisfy any of the specified values.\nTo limit the list of instance types from which Amazon EC2 can identify matching instance types,\nyou can use one of the following parameters, but not both in the same request:\n* `AllowedInstanceTypes` - The instance types to include in the list. All\n other instance types are ignored, even if they match your specified attributes.\n* `ExcludedInstanceTypes` - The instance types to exclude from the list,\n even if they match your specified attributes.\n###### Note\nIf you specify `InstanceRequirements`, you can't specify\n`InstanceType`.\nAttribute-based instance type selection is only supported when using Auto Scaling\ngroups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\nthe [launch instance\nwizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or\n[AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)AWS CloudFormation resource, you can't specify\n`InstanceRequirements`.\nFor more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot\nplacement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html", "Properties": { "InstanceGenerations": { "MarkdownDocumentation": "`InstanceGenerations`\n\nIndicates whether current or previous generation instance types are included. The\ncurrent generation instance types are recommended for use. Current generation instance types are\ntypically the latest two to three generations in each instance family. For more\ninformation, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the\n*Amazon EC2 User Guide*.\nFor current generation instance types, specify `current`.\nFor previous generation instance types, specify `previous`.\nDefault: Current and previous generation instance types\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `current | previous...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "current", "previous" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-instancegenerations", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RequireEncryptionInTransit": { "MarkdownDocumentation": "`RequireEncryptionInTransit`\n\nSpecifies whether instance types must support encrypting in-transit traffic between\ninstances. For more information, including the supported instance types, see [Encryption in\ntransit](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data-protection.html#encryption-transit) in the *Amazon EC2 User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-requireencryptionintransit", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MemoryGiBPerVCpu": { "MarkdownDocumentation": "`MemoryGiBPerVCpu`\n\nThe minimum and maximum amount of memory per vCPU, in GiB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [MemoryGiBPerVCpuRequest](./aws-properties-ec2-spotfleet-memorygibpervcpurequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-memorygibpervcpu", "UpdateType": "Immutable", "Required": false, "Type": "MemoryGiBPerVCpuRequest" }, "AcceleratorTypes": { "MarkdownDocumentation": "`AcceleratorTypes`\n\nThe accelerator types that must be on the instance type.\n* For instance types with FPGA accelerators, specify `fpga`.\n* For instance types with GPU accelerators, specify `gpu`.\n* For instance types with Inference accelerators, specify `inference`.\n* For instance types with Media accelerators, specify `media`.\nDefault: Any accelerator type\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `gpu | fpga | inference | me...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "gpu", "fpga", "inference", "media" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratortypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VCpuCount": { "MarkdownDocumentation": "`VCpuCount`\n\nThe minimum and maximum number of vCPUs.\n*Required*: No\n*Type*: [VCpuCountRangeRequest](./aws-properties-ec2-spotfleet-vcpucountrangerequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-vcpucount", "UpdateType": "Immutable", "Required": false, "Type": "VCpuCountRangeRequest" }, "AcceleratorManufacturers": { "MarkdownDocumentation": "`AcceleratorManufacturers`\n\nIndicates whether instance types must have accelerators by specific manufacturers.\n* For instance types with AWS devices, specify `amazon-web-services`.\n* For instance types with AMD devices, specify `amd`.\n* For instance types with Habana devices, specify `habana`.\n* For instance types with NVIDIA devices, specify `nvidia`.\n* For instance types with Xilinx devices, specify `xilinx`.\nDefault: Any manufacturer\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `amazon-web-services | amd |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "amazon-web-services", "amd", "habana", "nvidia", "xilinx" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratormanufacturers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LocalStorage": { "MarkdownDocumentation": "`LocalStorage`\n\nIndicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n[Amazon\nEC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.\n* To include instance types with instance store volumes, specify\n `included`.\n* To require only instance types with instance store volumes, specify\n `required`.\n* To exclude instance types with instance store volumes, specify\n `excluded`.\nDefault: `included`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-localstorage", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CpuManufacturers": { "MarkdownDocumentation": "`CpuManufacturers`\n\nThe CPU manufacturers to include.\n* For instance types with Intel CPUs, specify `intel`.\n* For instance types with AMD CPUs, specify `amd`.\n* For instance types with AWS CPUs, specify `amazon-web-services`.\n* For instance types with Apple CPUs, specify `apple`.\n###### Note\nDon't confuse the CPU manufacturer with the CPU architecture. Instances will\nbe launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you\nspecify in your launch template.\nDefault: Any manufacturer\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `intel | amd | amazon-web-se...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "intel", "amd", "amazon-web-services", "apple" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-cpumanufacturers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BareMetal": { "MarkdownDocumentation": "`BareMetal`\n\nIndicates whether bare metal instance types must be included, excluded, or required.\n* To include bare metal instance types, specify `included`.\n* To require only bare metal instance types, specify `required`.\n* To exclude bare metal instance types, specify `excluded`.\nDefault: `excluded`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-baremetal", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RequireHibernateSupport": { "MarkdownDocumentation": "`RequireHibernateSupport`\n\nIndicates whether instance types must support hibernation for On-Demand Instances.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-requirehibernatesupport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "MarkdownDocumentation": "`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`\n\n[Price protection] The price protection threshold for Spot Instances, as a percentage of an\nidentified On-Demand price. The identified On-Demand price is the price of the lowest\npriced current generation C, M, or R instance type with your specified attributes. If no\ncurrent generation C, M, or R instance type matches your attributes, then the identified\nprice is from the lowest priced current generation instance types, and failing that, from\nthe lowest priced previous generation instance types that match your attributes. When Amazon EC2\nselects instance types with your attributes, it will exclude instance types whose price\nexceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is based on the per vCPU or per\nmemory price instead of the per instance price.\n###### Note\nOnly one of `SpotMaxPricePercentageOverLowestPrice` or\n`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you\ndon't specify either, Amazon EC2 will automatically apply optimal price protection to\nconsistently select from a wide range of instance types. To indicate no price protection\nthreshold for Spot Instances, meaning you want to consider all instance types that match your\nattributes, include one of these parameters and specify a high value, such as\n`999999`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-maxspotpriceaspercentageofoptimalondemandprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "OnDemandMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`OnDemandMaxPricePercentageOverLowestPrice`\n\n[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than\nan identified On-Demand price. The identified On-Demand price is the price of the lowest\npriced current generation C, M, or R instance type with your specified attributes. When\nAmazon EC2 selects instance types with your attributes, it will exclude instance types whose\nprice exceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nTo indicate no price protection threshold, specify a high value, such as\n`999999`.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n###### Note\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is applied based on the\nper-vCPU or per-memory price instead of the per-instance price.\nDefault: `20`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-ondemandmaxpricepercentageoverlowestprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MemoryMiB": { "MarkdownDocumentation": "`MemoryMiB`\n\nThe minimum and maximum amount of memory, in MiB.\n*Required*: No\n*Type*: [MemoryMiBRequest](./aws-properties-ec2-spotfleet-memorymibrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-memorymib", "UpdateType": "Immutable", "Required": false, "Type": "MemoryMiBRequest" }, "LocalStorageTypes": { "MarkdownDocumentation": "`LocalStorageTypes`\n\nThe type of local storage that is required.\n* For instance types with hard disk drive (HDD) storage, specify `hdd`.\n* For instance types with solid state drive (SSD) storage, specify\n `ssd`.\nDefault: `hdd` and `ssd`\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "AllowedValues": [ "hdd", "ssd" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-localstoragetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkInterfaceCount": { "MarkdownDocumentation": "`NetworkInterfaceCount`\n\nThe minimum and maximum number of network interfaces.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [NetworkInterfaceCountRequest](./aws-properties-ec2-spotfleet-networkinterfacecountrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-networkinterfacecount", "UpdateType": "Immutable", "Required": false, "Type": "NetworkInterfaceCountRequest" }, "ExcludedInstanceTypes": { "MarkdownDocumentation": "`ExcludedInstanceTypes`\n\nThe instance types to exclude.\nYou can use strings with one or more wild cards, represented by\nan asterisk (`*`), to exclude an instance family, type, size, or generation. The\nfollowing are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`,\n`r*`, `*3*`.\nFor example, if you specify `c5*`,Amazon EC2 will exclude the entire C5 instance\nfamily, which includes all C5a and C5n instance types. If you specify\n`m5a.*`, Amazon EC2 will exclude all the M5a instance types, but not the M5n\ninstance types.\n###### Note\nIf you specify `ExcludedInstanceTypes`, you can't specify `AllowedInstanceTypes`.\nDefault: No excluded instance types\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-excludedinstancetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedInstanceTypes": { "MarkdownDocumentation": "`AllowedInstanceTypes`\n\nThe instance types to apply your specified attributes against. All other instance types\nare ignored, even if they match your specified attributes.\nYou can use strings with one or more wild cards, represented by\nan asterisk (`*`), to allow an instance type, size, or generation. The\nfollowing are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`,\n`r*`, `*3*`.\nFor example, if you specify `c5*`,Amazon EC2 will allow the entire C5 instance\nfamily, which includes all C5a and C5n instance types. If you specify\n`m5a.*`, Amazon EC2 will allow all the M5a instance types, but not the M5n\ninstance types.\n###### Note\nIf you specify `AllowedInstanceTypes`, you can't specify `ExcludedInstanceTypes`.\nDefault: All instance types\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-allowedinstancetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkBandwidthGbps": { "MarkdownDocumentation": "`NetworkBandwidthGbps`\n\nThe minimum and maximum amount of baseline network bandwidth, in gigabits per second\n(Gbps). For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide*.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [NetworkBandwidthGbpsRequest](./aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-networkbandwidthgbps", "UpdateType": "Immutable", "Required": false, "Type": "NetworkBandwidthGbpsRequest" }, "AcceleratorCount": { "MarkdownDocumentation": "`AcceleratorCount`\n\nThe minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on\nan instance.\nTo exclude accelerator-enabled instance types, set `Max` to `0`.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [AcceleratorCountRequest](./aws-properties-ec2-spotfleet-acceleratorcountrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratorcount", "UpdateType": "Immutable", "Required": false, "Type": "AcceleratorCountRequest" }, "BaselinePerformanceFactors": { "MarkdownDocumentation": "`BaselinePerformanceFactors`\n\nThe baseline performance to consider, using an instance family as a baseline reference.\nThe instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this\nbaseline to guide instance type selection, but there is no guarantee that the selected\ninstance types will always exceed the baseline for every application. Currently, this\nparameter only supports CPU performance as a baseline performance factor. For more\ninformation, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: [BaselinePerformanceFactorsRequest](./aws-properties-ec2-spotfleet-baselineperformancefactorsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-baselineperformancefactors", "UpdateType": "Immutable", "Required": false, "Type": "BaselinePerformanceFactorsRequest" }, "SpotMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`SpotMaxPricePercentageOverLowestPrice`\n\n[Price protection] The price protection threshold for Spot Instances, as a percentage higher than\nan identified Spot price. The identified Spot price is the Spot price of the lowest priced\ncurrent generation C, M, or R instance type with your specified attributes. If no current\ngeneration C, M, or R instance type matches your attributes, then the identified Spot price\nis from the lowest priced current generation instance types, and failing that, from the\nlowest priced previous generation instance types that match your attributes. When Amazon EC2\nselects instance types with your attributes, it will exclude instance types whose Spot\nprice exceeds your specified threshold.\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\nIf you set `TargetCapacityUnitType` to `vcpu` or\n`memory-mib`, the price protection threshold is applied based on the\nper-vCPU or per-memory price instead of the per-instance price.\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n###### Note\nOnly one of `SpotMaxPricePercentageOverLowestPrice` or\n`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you\ndon't specify either, Amazon EC2 will automatically apply optimal price protection to\nconsistently select from a wide range of instance types. To indicate no price protection\nthreshold for Spot Instances, meaning you want to consider all instance types that match your\nattributes, include one of these parameters and specify a high value, such as\n`999999`.\nDefault: `100`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-spotmaxpricepercentageoverlowestprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "BaselineEbsBandwidthMbps": { "MarkdownDocumentation": "`BaselineEbsBandwidthMbps`\n\nThe minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n[Amazon\nEBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [BaselineEbsBandwidthMbpsRequest](./aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-baselineebsbandwidthmbps", "UpdateType": "Immutable", "Required": false, "Type": "BaselineEbsBandwidthMbpsRequest" }, "AcceleratorNames": { "MarkdownDocumentation": "`AcceleratorNames`\n\nThe accelerators that must be on the instance type.\n* For instance types with NVIDIA A10G GPUs, specify `a10g`.\n* For instance types with NVIDIA A100 GPUs, specify `a100`.\n* For instance types with NVIDIA H100 GPUs, specify `h100`.\n* For instance types with AWS Inferentia chips, specify `inferentia`.\n* For instance types with AWS Inferentia2 chips, specify `inferentia2`.\n* For instance types with Habana Gaudi HL-205 GPUs, specify `gaudi-hl-205`.\n* For instance types with NVIDIA GRID K520 GPUs, specify `k520`.\n* For instance types with NVIDIA K80 GPUs, specify `k80`.\n* For instance types with NVIDIA L4 GPUs, specify `l4`.\n* For instance types with NVIDIA L40S GPUs, specify `l40s`.\n* For instance types with NVIDIA M60 GPUs, specify `m60`.\n* For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520`.\n* For instance types with AWS Trainium chips, specify `trainium`.\n* For instance types with AWS Trainium2 chips, specify `trainium2`.\n* For instance types with NVIDIA T4 GPUs, specify `t4`.\n* For instance types with NVIDIA T4G GPUs, specify `t4g`.\n* For instance types with Xilinx U30 cards, specify `u30`.\n* For instance types with Xilinx VU9P FPGAs, specify `vu9p`.\n* For instance types with NVIDIA V100 GPUs, specify `v100`.\nDefault: Any accelerator\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `a10g | a100 | h100 | infere...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "a10g", "a100", "h100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "t4g", "vu9p", "v100", "l40s", "l4", "gaudi-hl-205", "inferentia2", "trainium", "trainium2", "u30" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratornames", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AcceleratorTotalMemoryMiB": { "MarkdownDocumentation": "`AcceleratorTotalMemoryMiB`\n\nThe minimum and maximum amount of total accelerator memory, in MiB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [AcceleratorTotalMemoryMiBRequest](./aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratortotalmemorymib", "UpdateType": "Immutable", "Required": false, "Type": "AcceleratorTotalMemoryMiBRequest" }, "BurstablePerformance": { "MarkdownDocumentation": "`BurstablePerformance`\n\nIndicates whether burstable performance T instance types are included, excluded, or required. For more information, see\n[Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).\n* To include burstable performance instance types, specify `included`.\n* To require only burstable performance instance types, specify `required`.\n* To exclude burstable performance instance types, specify `excluded`.\nDefault: `excluded`\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-burstableperformance", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TotalLocalStorageGB": { "MarkdownDocumentation": "`TotalLocalStorageGB`\n\nThe minimum and maximum amount of total local storage, in GB.\nDefault: No minimum or maximum limits\n*Required*: No\n*Type*: [TotalLocalStorageGBRequest](./aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-totallocalstoragegb", "UpdateType": "Immutable", "Required": false, "Type": "TotalLocalStorageGBRequest" } } }, "AWS::EC2::SpotFleet.LaunchTemplateConfig": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.LaunchTemplateConfig`\n\nSpecifies a launch template and overrides.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html", "Properties": { "LaunchTemplateSpecification": { "MarkdownDocumentation": "`LaunchTemplateSpecification`\n\nThe launch template to use. Make sure that the launch template does not contain the\n`NetworkInterfaceId` parameter because you can't specify a network interface\nID in a Spot Fleet.\n*Required*: No\n*Type*: [FleetLaunchTemplateSpecification](./aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-launchtemplatespecification", "UpdateType": "Immutable", "Required": false, "Type": "FleetLaunchTemplateSpecification" }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nAny parameters that you specify override the same parameters in the launch\ntemplate.\n*Required*: No\n*Type*: Array of [LaunchTemplateOverrides](./aws-properties-ec2-spotfleet-launchtemplateoverrides.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-overrides", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "LaunchTemplateOverrides", "DuplicatesAllowed": false } } }, "AWS::EC2::SpotFleet.LaunchTemplateOverrides": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.LaunchTemplateOverrides`\n\nSpecifies overrides for a launch template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html", "Properties": { "SpotPrice": { "MarkdownDocumentation": "`SpotPrice`\n\nThe 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\nincreased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n###### Important\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-spotprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "WeightedCapacity": { "MarkdownDocumentation": "`WeightedCapacity`\n\nThe number of units provided by the specified instance type. These are the same units\nthat you chose to set the target capacity in terms of instances, or a performance\ncharacteristic such as vCPUs, memory, or I/O.\nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the\nnumber of instances to the next whole number. If this value is not specified, the default\nis 1.\n###### Note\nWhen specifying weights, the price used in the `lowestPrice` and\n`priceCapacityOptimized` allocation strategies is per\n*unit* hour (where the instance price is divided by the specified\nweight). However, if all the specified weights are above the requested\n`TargetCapacity`, resulting in only 1 instance being launched, the price\nused is per *instance* hour.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-weightedcapacity", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority for the launch template override. The highest priority is launched\nfirst.\nIf `OnDemandAllocationStrategy` is set to `prioritized`, Spot Fleet\nuses priority to determine which launch template override to use first in fulfilling\nOn-Demand capacity.\nIf the Spot `AllocationStrategy` is set to\n`capacityOptimizedPrioritized`, Spot Fleet uses priority on a best-effort basis\nto determine which launch template override to use in fulfilling Spot capacity, but\noptimizes for capacity first.\nValid values are whole numbers starting at `0`. The lower the number, the\nhigher the priority. If no number is set, the launch template override has the lowest\npriority. You can set the same priority for different launch template overrides.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-priority", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone in which to launch the instances. For example,\n`us-east-2a`.\nEither `AvailabilityZone` or `AvailabilityZoneId` must be\nspecified in the request, but not both.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-subnetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceRequirements": { "MarkdownDocumentation": "`InstanceRequirements`\n\nThe instance requirements. When you specify instance requirements, Amazon EC2 will identify\ninstance types with the provided requirements, and then use your On-Demand and Spot\nallocation strategies to launch instances from these instance types, in the same way as\nwhen you specify a list of instance types.\n###### Note\nIf you specify `InstanceRequirements`, you can't specify\n`InstanceType`.\n*Required*: No\n*Type*: [InstanceRequirementsRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-instancerequirements", "UpdateType": "Immutable", "Required": false, "Type": "InstanceRequirementsRequest" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type.\n*Required*: No\n*Type*: String\n*Allowed values*: `a1.medium | a1.large | a1.x...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge", "c8g.medium", "c8g.large", "c8g.xlarge", "c8g.2xlarge", "c8g.4xlarge", "c8g.8xlarge", "c8g.12xlarge", "c8g.16xlarge", "c8g.24xlarge", "c8g.48xlarge", "c8g.metal-24xl", "c8g.metal-48xl", "m8g.medium", "m8g.large", "m8g.xlarge", "m8g.2xlarge", "m8g.4xlarge", "m8g.8xlarge", "m8g.12xlarge", "m8g.16xlarge", "m8g.24xlarge", "m8g.48xlarge", "m8g.metal-24xl", "m8g.metal-48xl", "x8g.medium", "x8g.large", "x8g.xlarge", "x8g.2xlarge", "x8g.4xlarge", "x8g.8xlarge", "x8g.12xlarge", "x8g.16xlarge", "x8g.24xlarge", "x8g.48xlarge", "x8g.metal-24xl", "x8g.metal-48xl", "i7ie.large", "i7ie.xlarge", "i7ie.2xlarge", "i7ie.3xlarge", "i7ie.6xlarge", "i7ie.12xlarge", "i7ie.18xlarge", "i7ie.24xlarge", "i7ie.48xlarge", "i8g.large", "i8g.xlarge", "i8g.2xlarge", "i8g.4xlarge", "i8g.8xlarge", "i8g.12xlarge", "i8g.16xlarge", "i8g.24xlarge", "i8g.metal-24xl", "u7i-6tb.112xlarge", "u7i-8tb.112xlarge", "u7inh-32tb.480xlarge", "p5e.48xlarge", "p5en.48xlarge", "f2.12xlarge", "f2.48xlarge", "trn2.48xlarge", "c7i-flex.12xlarge", "c7i-flex.16xlarge", "m7i-flex.12xlarge", "m7i-flex.16xlarge", "i7ie.metal-24xl", "i7ie.metal-48xl", "i8g.48xlarge", "c8gd.medium", "c8gd.large", "c8gd.xlarge", "c8gd.2xlarge", "c8gd.4xlarge", "c8gd.8xlarge", "c8gd.12xlarge", "c8gd.16xlarge", "c8gd.24xlarge", "c8gd.48xlarge", "c8gd.metal-24xl", "c8gd.metal-48xl", "i7i.large", "i7i.xlarge", "i7i.2xlarge", "i7i.4xlarge", "i7i.8xlarge", "i7i.12xlarge", "i7i.16xlarge", "i7i.24xlarge", "i7i.48xlarge", "i7i.metal-24xl", "i7i.metal-48xl", "p6-b200.48xlarge", "m8gd.medium", "m8gd.large", "m8gd.xlarge", "m8gd.2xlarge", "m8gd.4xlarge", "m8gd.8xlarge", "m8gd.12xlarge", "m8gd.16xlarge", "m8gd.24xlarge", "m8gd.48xlarge", "m8gd.metal-24xl", "m8gd.metal-48xl", "r8gd.medium", "r8gd.large", "r8gd.xlarge", "r8gd.2xlarge", "r8gd.4xlarge", "r8gd.8xlarge", "r8gd.12xlarge", "r8gd.16xlarge", "r8gd.24xlarge", "r8gd.48xlarge", "r8gd.metal-24xl", "r8gd.metal-48xl", "c8gn.medium", "c8gn.large", "c8gn.xlarge", "c8gn.2xlarge", "c8gn.4xlarge", "c8gn.8xlarge", "c8gn.12xlarge", "c8gn.16xlarge", "c8gn.24xlarge", "c8gn.48xlarge", "c8gn.metal-24xl", "c8gn.metal-48xl", "f2.6xlarge", "p6e-gb200.36xlarge", "g6f.large", "g6f.xlarge", "g6f.2xlarge", "g6f.4xlarge", "gr6f.4xlarge", "p5.4xlarge", "r8i.large", "r8i.xlarge", "r8i.2xlarge", "r8i.4xlarge", "r8i.8xlarge", "r8i.12xlarge", "r8i.16xlarge", "r8i.24xlarge", "r8i.32xlarge", "r8i.48xlarge", "r8i.96xlarge", "r8i.metal-48xl", "r8i.metal-96xl", "r8i-flex.large", "r8i-flex.xlarge", "r8i-flex.2xlarge", "r8i-flex.4xlarge", "r8i-flex.8xlarge", "r8i-flex.12xlarge", "r8i-flex.16xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-instancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.LoadBalancersConfig": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.LoadBalancersConfig`\n\nSpecifies the Classic Load Balancers and target groups to attach to a Spot Fleet\nrequest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html", "Properties": { "ClassicLoadBalancersConfig": { "MarkdownDocumentation": "`ClassicLoadBalancersConfig`\n\nThe Classic Load Balancers.\n*Required*: No\n*Type*: [ClassicLoadBalancersConfig](./aws-properties-ec2-spotfleet-classicloadbalancersconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-classicloadbalancersconfig", "UpdateType": "Immutable", "Required": false, "Type": "ClassicLoadBalancersConfig" }, "TargetGroupsConfig": { "MarkdownDocumentation": "`TargetGroupsConfig`\n\nThe target groups.\n*Required*: No\n*Type*: [TargetGroupsConfig](./aws-properties-ec2-spotfleet-targetgroupsconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-targetgroupsconfig", "UpdateType": "Immutable", "Required": false, "Type": "TargetGroupsConfig" } } }, "AWS::EC2::SpotFleet.MemoryGiBPerVCpuRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.MemoryGiBPerVCpuRequest`\n\nThe minimum and maximum amount of memory per vCPU, in GiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorygibpervcpurequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorygibpervcpurequest.html#cfn-ec2-spotfleet-memorygibpervcpurequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorygibpervcpurequest.html#cfn-ec2-spotfleet-memorygibpervcpurequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::SpotFleet.MemoryMiBRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.MemoryMiBRequest`\n\nThe minimum and maximum amount of memory, in MiB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorymibrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory, in MiB. To specify no minimum limit, specify\n`0`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorymibrequest.html#cfn-ec2-spotfleet-memorymibrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory, in MiB. To specify no maximum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorymibrequest.html#cfn-ec2-spotfleet-memorymibrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::SpotFleet.NetworkBandwidthGbpsRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.NetworkBandwidthGbpsRequest`\n\nThe minimum and maximum amount of baseline network bandwidth, in gigabits per second\n(Gbps). For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide*.\nDefault: No minimum or maximum limits\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html#cfn-ec2-spotfleet-networkbandwidthgbpsrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html#cfn-ec2-spotfleet-networkbandwidthgbpsrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::SpotFleet.NetworkInterfaceCountRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.NetworkInterfaceCountRequest`\n\nThe minimum and maximum number of network interfaces.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkinterfacecountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of network interfaces. To specify no minimum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkinterfacecountrequest.html#cfn-ec2-spotfleet-networkinterfacecountrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of network interfaces. To specify no maximum limit, omit this\nparameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkinterfacecountrequest.html#cfn-ec2-spotfleet-networkinterfacecountrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::SpotFleet.PerformanceFactorReferenceRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.PerformanceFactorReferenceRequest`\n\nSpecify an instance family to use as the baseline reference for CPU performance. All\ninstance types that match your specified attributes will be compared against the CPU\nperformance of the referenced instance family, regardless of CPU manufacturer or\narchitecture.\n###### Note\nCurrently, only one instance family can be specified in the list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-performancefactorreferencerequest.html", "Properties": { "InstanceFamily": { "MarkdownDocumentation": "`InstanceFamily`\n\nThe instance family to use as a baseline reference.\n###### Note\nEnsure that you specify the correct value for the instance family. The instance\nfamily is everything before the period (`.`) in the instance type name. For\nexample, in the instance type `c6i.large`, the instance family is\n`c6i`, not `c6`. For more information, see [Amazon EC2\ninstance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance\nTypes*.\nThe following instance families are *not supported* for performance\nprotection:\n* `c1`\n* `g3` | `g3s`\n* `hpc7g`\n* `m1` | `m2`\n* `mac1` | `mac2` | `mac2-m1ultra` |\n `mac2-m2` | `mac2-m2pro`\n* `p3dn` | `p4d` | `p5`\n* `t1`\n* `u-12tb1` | `u-18tb1` | `u-24tb1` |\n `u-3tb1` | `u-6tb1` | `u-9tb1` |\n `u7i-12tb` | `u7in-16tb` | `u7in-24tb` |\n `u7in-32tb`\nIf you enable performance protection by specifying a supported instance family, the\nreturned instance types will exclude the above unsupported instance families.\nIf you specify an unsupported instance family as a value for baseline performance, the\nAPI returns an empty response for [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) and an exception for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html), [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html), [ModifyFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyFleet.html), and [ModifySpotFleetRequest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySpotFleetRequest.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-performancefactorreferencerequest.html#cfn-ec2-spotfleet-performancefactorreferencerequest-instancefamily", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.PrivateIpAddressSpecification": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.PrivateIpAddressSpecification`\n\nDescribes a secondary private IPv4 address for a network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-privateipaddressspecification.html", "Properties": { "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe private IPv4 address.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-privateipaddressspecification.html#cfn-ec2-spotfleet-privateipaddressspecification-privateipaddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Primary": { "MarkdownDocumentation": "`Primary`\n\nIndicates whether the private IPv4 address is the primary private IPv4 address. Only\none IPv4 address can be designated as primary.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-privateipaddressspecification.html#cfn-ec2-spotfleet-privateipaddressspecification-primary", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::SpotFleet.SpotCapacityRebalance": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.SpotCapacityRebalance`\n\nThe Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\nSpot Instance is at an elevated risk of being interrupted. For more information, see\n[Capacity\nrebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotcapacityrebalance.html", "Properties": { "TerminationDelay": { "MarkdownDocumentation": "`TerminationDelay`\n\nThe amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\nInstance after launching a new replacement Spot Instance.\nRequired when `ReplacementStrategy` is set to `launch-before-terminate`.\nNot valid when `ReplacementStrategy` is set to `launch`.\nValid values: Minimum value of `120` seconds. Maximum value of `7200` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotcapacityrebalance.html#cfn-ec2-spotfleet-spotcapacityrebalance-terminationdelay", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ReplacementStrategy": { "MarkdownDocumentation": "`ReplacementStrategy`\n\nThe replacement strategy to use. Only available for fleets of type\n`maintain`.\n`launch` - Spot Fleet launches a new replacement Spot Instance when a\nrebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\ndoes not terminate the instances that receive a rebalance notification. You can\nterminate the old instances, or you can leave them running. You are charged for all\ninstances while they are running.\n`launch-before-terminate` - Spot Fleet launches a new replacement Spot\nInstance when a rebalance notification is emitted for an existing Spot Instance in the\nfleet, and then, after a delay that you specify (in `TerminationDelay`),\nterminates the instances that received a rebalance notification.\n*Required*: No\n*Type*: String\n*Allowed values*: `launch | launch-before-term...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "launch", "launch-before-terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotcapacityrebalance.html#cfn-ec2-spotfleet-spotcapacityrebalance-replacementstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.SpotFleetLaunchSpecification": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.SpotFleetLaunchSpecification`\n\nSpecifies the launch specification for one or more Spot Instances. If you include\nOn-Demand capacity in your fleet request, you can't use\n`SpotFleetLaunchSpecification`; you must use [LaunchTemplateConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security groups.\nIf you specify a network interface, you must specify any security groups as part of\nthe network interface instead of using this parameter.\n*Required*: No\n*Type*: Array of [GroupIdentifier](./aws-properties-ec2-spotfleet-groupidentifier.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-securitygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "GroupIdentifier", "DuplicatesAllowed": false }, "TagSpecifications": { "MarkdownDocumentation": "`TagSpecifications`\n\nThe tags to apply during creation.\n*Required*: No\n*Type*: Array of [SpotFleetTagSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-tagspecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "SpotFleetTagSpecification", "DuplicatesAllowed": false }, "UserData": { "MarkdownDocumentation": "`UserData`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-userdata", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BlockDeviceMappings": { "MarkdownDocumentation": "`BlockDeviceMappings`\n\nOne or more block devices that are mapped to the Spot Instances. You can't specify both\na snapshot ID and an encryption value. This is because only blank volumes can be\nencrypted on creation. If a snapshot is the basis for a volume, it is not blank and its\nencryption status is used for the volume encryption status.\n*Required*: No\n*Type*: Array of [BlockDeviceMapping](./aws-properties-ec2-spotfleet-blockdevicemapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-blockdevicemappings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "BlockDeviceMapping", "DuplicatesAllowed": false }, "IamInstanceProfile": { "MarkdownDocumentation": "`IamInstanceProfile`\n\nThe IAM instance profile.\n*Required*: No\n*Type*: [IamInstanceProfileSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-iaminstanceprofile", "UpdateType": "Immutable", "Required": false, "Type": "IamInstanceProfileSpecification" }, "KernelId": { "MarkdownDocumentation": "`KernelId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-kernelid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe IDs of the subnets in which to launch the instances. To specify multiple subnets, separate\nthem using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".\nIf you specify a network interface, you must specify any subnets as part of the\nnetwork interface instead of using 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-subnetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EbsOptimized": { "MarkdownDocumentation": "`EbsOptimized`\n\nIndicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ebsoptimized", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyName": { "MarkdownDocumentation": "`KeyName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-keyname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RamdiskId": { "MarkdownDocumentation": "`RamdiskId`\n\nThe ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel\nrequirements for information about whether you need to specify a RAM disk. To find kernel\nrequirements, refer to the AWS Resource Center and search for the kernel 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ramdiskid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SpotPrice": { "MarkdownDocumentation": "`SpotPrice`\n\nThe 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\nincreased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n###### Important\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-spotprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "WeightedCapacity": { "MarkdownDocumentation": "`WeightedCapacity`\n\nThe number of units provided by the specified instance type. These are the same units\nthat you chose to set the target capacity in terms of instances, or a performance\ncharacteristic such as vCPUs, memory, or I/O.\nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the\nnumber of instances to the next whole number. If this value is not specified, the default\nis 1.\n###### Note\nWhen specifying weights, the price used in the `lowestPrice` and\n`priceCapacityOptimized` allocation strategies is per\n*unit* hour (where the instance price is divided by the specified\nweight). However, if all the specified weights are above the requested\n`TargetCapacity`, resulting in only 1 instance being launched, the price\nused is per *instance* hour.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-weightedcapacity", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe placement information.\n*Required*: No\n*Type*: [SpotPlacement](./aws-properties-ec2-spotfleet-spotplacement.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-placement", "UpdateType": "Immutable", "Required": false, "Type": "SpotPlacement" }, "NetworkInterfaces": { "MarkdownDocumentation": "`NetworkInterfaces`\n\nThe network interfaces.\n*Required*: No\n*Type*: Array of [InstanceNetworkInterfaceSpecification](./aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-networkinterfaces", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "InstanceNetworkInterfaceSpecification", "DuplicatesAllowed": false }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-imageid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceRequirements": { "MarkdownDocumentation": "`InstanceRequirements`\n\nThe attributes for the instance types. When you specify instance attributes, Amazon EC2 will\nidentify instance types with those attributes.\n###### Note\nIf you specify `InstanceRequirements`, you can't specify\n`InstanceType`.\n*Required*: No\n*Type*: [InstanceRequirementsRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancerequirements", "UpdateType": "Immutable", "Required": false, "Type": "InstanceRequirementsRequest" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type.\n*Required*: No\n*Type*: String\n*Allowed values*: `a1.medium | a1.large | a1.x...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge", "c8g.medium", "c8g.large", "c8g.xlarge", "c8g.2xlarge", "c8g.4xlarge", "c8g.8xlarge", "c8g.12xlarge", "c8g.16xlarge", "c8g.24xlarge", "c8g.48xlarge", "c8g.metal-24xl", "c8g.metal-48xl", "m8g.medium", "m8g.large", "m8g.xlarge", "m8g.2xlarge", "m8g.4xlarge", "m8g.8xlarge", "m8g.12xlarge", "m8g.16xlarge", "m8g.24xlarge", "m8g.48xlarge", "m8g.metal-24xl", "m8g.metal-48xl", "x8g.medium", "x8g.large", "x8g.xlarge", "x8g.2xlarge", "x8g.4xlarge", "x8g.8xlarge", "x8g.12xlarge", "x8g.16xlarge", "x8g.24xlarge", "x8g.48xlarge", "x8g.metal-24xl", "x8g.metal-48xl", "i7ie.large", "i7ie.xlarge", "i7ie.2xlarge", "i7ie.3xlarge", "i7ie.6xlarge", "i7ie.12xlarge", "i7ie.18xlarge", "i7ie.24xlarge", "i7ie.48xlarge", "i8g.large", "i8g.xlarge", "i8g.2xlarge", "i8g.4xlarge", "i8g.8xlarge", "i8g.12xlarge", "i8g.16xlarge", "i8g.24xlarge", "i8g.metal-24xl", "u7i-6tb.112xlarge", "u7i-8tb.112xlarge", "u7inh-32tb.480xlarge", "p5e.48xlarge", "p5en.48xlarge", "f2.12xlarge", "f2.48xlarge", "trn2.48xlarge", "c7i-flex.12xlarge", "c7i-flex.16xlarge", "m7i-flex.12xlarge", "m7i-flex.16xlarge", "i7ie.metal-24xl", "i7ie.metal-48xl", "i8g.48xlarge", "c8gd.medium", "c8gd.large", "c8gd.xlarge", "c8gd.2xlarge", "c8gd.4xlarge", "c8gd.8xlarge", "c8gd.12xlarge", "c8gd.16xlarge", "c8gd.24xlarge", "c8gd.48xlarge", "c8gd.metal-24xl", "c8gd.metal-48xl", "i7i.large", "i7i.xlarge", "i7i.2xlarge", "i7i.4xlarge", "i7i.8xlarge", "i7i.12xlarge", "i7i.16xlarge", "i7i.24xlarge", "i7i.48xlarge", "i7i.metal-24xl", "i7i.metal-48xl", "p6-b200.48xlarge", "m8gd.medium", "m8gd.large", "m8gd.xlarge", "m8gd.2xlarge", "m8gd.4xlarge", "m8gd.8xlarge", "m8gd.12xlarge", "m8gd.16xlarge", "m8gd.24xlarge", "m8gd.48xlarge", "m8gd.metal-24xl", "m8gd.metal-48xl", "r8gd.medium", "r8gd.large", "r8gd.xlarge", "r8gd.2xlarge", "r8gd.4xlarge", "r8gd.8xlarge", "r8gd.12xlarge", "r8gd.16xlarge", "r8gd.24xlarge", "r8gd.48xlarge", "r8gd.metal-24xl", "r8gd.metal-48xl", "c8gn.medium", "c8gn.large", "c8gn.xlarge", "c8gn.2xlarge", "c8gn.4xlarge", "c8gn.8xlarge", "c8gn.12xlarge", "c8gn.16xlarge", "c8gn.24xlarge", "c8gn.48xlarge", "c8gn.metal-24xl", "c8gn.metal-48xl", "f2.6xlarge", "p6e-gb200.36xlarge", "g6f.large", "g6f.xlarge", "g6f.2xlarge", "g6f.4xlarge", "gr6f.4xlarge", "p5.4xlarge", "r8i.large", "r8i.xlarge", "r8i.2xlarge", "r8i.4xlarge", "r8i.8xlarge", "r8i.12xlarge", "r8i.16xlarge", "r8i.24xlarge", "r8i.32xlarge", "r8i.48xlarge", "r8i.96xlarge", "r8i.metal-48xl", "r8i.metal-96xl", "r8i-flex.large", "r8i-flex.xlarge", "r8i-flex.2xlarge", "r8i-flex.4xlarge", "r8i-flex.8xlarge", "r8i-flex.12xlarge", "r8i-flex.16xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Monitoring": { "MarkdownDocumentation": "`Monitoring`\n\nEnable or disable monitoring for the instances.\n*Required*: No\n*Type*: [SpotFleetMonitoring](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-monitoring", "UpdateType": "Immutable", "Required": false, "Type": "SpotFleetMonitoring" } } }, "AWS::EC2::SpotFleet.SpotFleetMonitoring": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.SpotFleetMonitoring`\n\nDescribes whether monitoring is enabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetmonitoring.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables monitoring for the instance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetmonitoring.html#cfn-ec2-spotfleet-spotfleetmonitoring-enabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::SpotFleet.SpotFleetRequestConfigData": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.SpotFleetRequestConfigData`\n\nSpecifies the configuration of a Spot Fleet request. For more information, see [Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html) in the *Amazon EC2 User Guide*.\nYou must specify either `LaunchSpecifications` or\n`LaunchTemplateConfigs`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html", "Properties": { "Context": { "MarkdownDocumentation": "`Context`\n\nReserved.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-context", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpotMaxTotalPrice": { "MarkdownDocumentation": "`SpotMaxTotalPrice`\n\nThe maximum amount per hour for Spot Instances that you're willing to pay. You can use\nthe `spotMaxTotalPrice` parameter, the `onDemandMaxTotalPrice`\nparameter, or both parameters to ensure that your fleet cost does not exceed your budget.\nIf you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will\nlaunch instances until it reaches the maximum amount you're willing to pay. When the\nmaximum amount you're willing to pay is reached, the fleet stops launching instances even\nif it hasn\u2019t met the target capacity.\n###### Note\nIf your fleet includes T instances that are configured as `unlimited`,\nand if their average CPU usage exceeds the baseline utilization, you will incur a charge\nfor surplus credits. The `spotMaxTotalPrice` does not account for surplus\ncredits, and, if you use surplus credits, your final cost might be higher than what you\nspecified for `spotMaxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotmaxtotalprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExcessCapacityTerminationPolicy": { "MarkdownDocumentation": "`ExcessCapacityTerminationPolicy`\n\nIndicates whether running Spot Instances should be terminated if you decrease the\ntarget capacity of the Spot Fleet request below the current size of the Spot\nFleet.\nSupported only for fleets of type `maintain`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Default | NoTermination | d...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Default", "NoTermination", "default", "noTermination" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-excesscapacityterminationpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagSpecifications": { "MarkdownDocumentation": "`TagSpecifications`\n\nThe key-value pair for tagging the Spot Fleet request on creation. The value for\n`ResourceType` must be `spot-fleet-request`, otherwise the\nSpot Fleet request fails. To tag instances at launch, specify the tags in the [launch\ntemplate](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) (valid only if you use `LaunchTemplateConfigs`) or in\nthe `[SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html)` (valid only if you use\n`LaunchSpecifications`). For information about tagging after launch, see\n[Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources).\n*Required*: No\n*Type*: Array of [SpotFleetTagSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-tagspecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "SpotFleetTagSpecification", "DuplicatesAllowed": false }, "InstancePoolsToUseCount": { "MarkdownDocumentation": "`InstancePoolsToUseCount`\n\nThe number of Spot pools across which to allocate your target Spot capacity. Valid\nonly when Spot **AllocationStrategy** is set to\n`lowest-price`. Spot Fleet selects the cheapest Spot pools and evenly\nallocates your target Spot capacity across the number of Spot pools that you\nspecify.\nNote that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\nbest effort basis. If a pool runs out of Spot capacity before fulfilling your target\ncapacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\npool. To ensure that your target capacity is met, you might receive Spot Instances from more than\nthe number of pools that you specified. Similarly, if most of the pools have no Spot\ncapacity, you might receive your full target capacity from fewer than the number of\npools that you specified.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-instancepoolstousecount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "LaunchTemplateConfigs": { "MarkdownDocumentation": "`LaunchTemplateConfigs`\n\nThe launch template and overrides. If you specify `LaunchTemplateConfigs`,\nyou can't specify `LaunchSpecifications`.\n*Required*: Conditional\n*Type*: Array of [LaunchTemplateConfig](./aws-properties-ec2-spotfleet-launchtemplateconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchtemplateconfigs", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "LaunchTemplateConfig", "DuplicatesAllowed": false }, "TargetCapacityUnitType": { "MarkdownDocumentation": "`TargetCapacityUnitType`\n\nThe unit for the target capacity. You can specify this parameter only when\nusing attribute-based instance type selection.\nDefault: `units` (the number of instances)\n*Required*: No\n*Type*: String\n*Allowed values*: `vcpu | memory-mib | units...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "vcpu", "memory-mib", "units" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacityunittype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamFleetRole": { "MarkdownDocumentation": "`IamFleetRole`\n\nThe Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the\nSpot Fleet the permission to request, launch, terminate, and tag instances on your behalf.\nFor more information, see [Spot\nFleet Prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) in the *Amazon EC2 User Guide*.\nSpot Fleet can terminate Spot Instances on your behalf when you\ncancel its Spot Fleet request or when the Spot Fleet request expires, if you set\n`TerminateInstancesWithExpiration`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-iamfleetrole", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SpotMaintenanceStrategies": { "MarkdownDocumentation": "`SpotMaintenanceStrategies`\n\nThe strategies for managing your Spot Instances that are at an elevated risk of being\ninterrupted.\n*Required*: No\n*Type*: [SpotMaintenanceStrategies](./aws-properties-ec2-spotfleet-spotmaintenancestrategies.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotmaintenancestrategies", "UpdateType": "Immutable", "Required": false, "Type": "SpotMaintenanceStrategies" }, "TerminateInstancesWithExpiration": { "MarkdownDocumentation": "`TerminateInstancesWithExpiration`\n\nIndicates whether running Spot Instances are terminated when the Spot Fleet request\nexpires.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-terminateinstanceswithexpiration", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ValidUntil": { "MarkdownDocumentation": "`ValidUntil`\n\nThe end date and time of the request, in UTC format\n(*YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).\nAfter the end date and time, no new Spot Instance requests are placed or able to fulfill\nthe request. If no value is specified, the Spot Fleet request remains until you cancel\nit.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validuntil", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OnDemandMaxTotalPrice": { "MarkdownDocumentation": "`OnDemandMaxTotalPrice`\n\nThe maximum amount per hour for On-Demand Instances that you're willing to pay. You\ncan use the `onDemandMaxTotalPrice` parameter, the\n`spotMaxTotalPrice` parameter, or both parameters to ensure that your\nfleet cost does not exceed your budget. If you set a maximum price per hour for the\nOn-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\nmaximum amount you're willing to pay. When the maximum amount you're willing to pay is\nreached, the fleet stops launching instances even if it hasn\u2019t met the target\ncapacity.\n###### Note\nIf your fleet includes T instances that are configured as `unlimited`,\nand if their average CPU usage exceeds the baseline utilization, you will incur a charge\nfor surplus credits. The `onDemandMaxTotalPrice` does not account for surplus\ncredits, and, if you use surplus credits, your final cost might be higher than what you\nspecified for `onDemandMaxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandmaxtotalprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OnDemandAllocationStrategy": { "MarkdownDocumentation": "`OnDemandAllocationStrategy`\n\nThe order of the launch template overrides to use in fulfilling On-Demand capacity. If\nyou specify `lowestPrice`, Spot Fleet uses price to determine the order, launching\nthe lowest price first. If you specify `prioritized`, Spot Fleet uses the priority\nthat you assign to each Spot Fleet launch template override, launching the highest priority\nfirst. If you do not specify a value, Spot Fleet defaults to `lowestPrice`.\n*Required*: No\n*Type*: String\n*Allowed values*: `lowestPrice | prioritized...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "lowestPrice", "prioritized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandallocationstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SpotPrice": { "MarkdownDocumentation": "`SpotPrice`\n\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend\nusing this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n###### Important\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AllocationStrategy": { "MarkdownDocumentation": "`AllocationStrategy`\n\nThe strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\npools specified by the Spot Fleet launch configuration. For more information, see [Allocation\nstrategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide*.\npriceCapacityOptimized (recommended)\nSpot Fleet identifies the pools with\nthe highest capacity availability for the number of instances that are launching. This means\nthat we will request Spot Instances from the pools that we believe have the lowest chance of interruption\nin the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.\n\ncapacityOptimized\nSpot Fleet identifies the pools with\nthe highest capacity availability for the number of instances that are launching. This means\nthat we will request Spot Instances from the pools that we believe have the lowest chance of interruption\nin the near term. To give certain\ninstance types a higher chance of launching first, use\n`capacityOptimizedPrioritized`. Set a priority for each instance type by\nusing the `Priority` parameter for `LaunchTemplateOverrides`. You can\nassign the same priority to different `LaunchTemplateOverrides`. EC2 implements\nthe priorities on a best-effort basis, but optimizes for capacity first.\n`capacityOptimizedPrioritized` is supported only if your Spot Fleet uses a\nlaunch template. Note that if the `OnDemandAllocationStrategy` is set to\n`prioritized`, the same priority is applied when fulfilling On-Demand\ncapacity.\n\ndiversified\nSpot Fleet requests instances from all of the Spot Instance pools that you\nspecify.\n\nlowestPrice (not recommended)\n###### Important\nWe don't recommend the `lowestPrice` allocation strategy because\nit has the highest risk of interruption for your Spot Instances.\nSpot Fleet requests instances from the lowest priced Spot Instance pool that has available\ncapacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\ncome from the next lowest priced pool that has available capacity. If a pool runs\nout of capacity before fulfilling your desired capacity, Spot Fleet will continue to\nfulfill your request by drawing from the next lowest priced pool. To ensure that\nyour desired capacity is met, you might receive Spot Instances from several pools. Because\nthis strategy only considers instance price and not capacity availability, it\nmight lead to high interruption rates.\n\nDefault: `lowestPrice`\n*Required*: No\n*Type*: String\n*Allowed values*: `capacityOptimized | capacit...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "capacityOptimized", "capacityOptimizedPrioritized", "diversified", "lowestPrice", "priceCapacityOptimized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-allocationstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OnDemandTargetCapacity": { "MarkdownDocumentation": "`OnDemandTargetCapacity`\n\nThe number of On-Demand units to request. You can choose to set the target capacity in\nterms of instances or a performance characteristic that is important to your application\nworkload, such as vCPUs, memory, or I/O. If the request type is `maintain`,\nyou can specify a target capacity of 0 and add capacity later.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandtargetcapacity", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of request. Indicates whether the Spot Fleet only requests the target\ncapacity or also attempts to maintain it. When this value is `request`, the\nSpot Fleet only places the required requests. It does not attempt to replenish Spot\nInstances if capacity is diminished, nor does it submit requests in alternative Spot\npools if capacity is not available. When this value is `maintain`, the Spot\nFleet maintains the target capacity. The Spot Fleet places the required requests to meet\ncapacity and automatically replenishes any interrupted instances. Default:\n`maintain`. `instant` is listed but is not used by Spot\nFleet.\n*Required*: No\n*Type*: String\n*Allowed values*: `maintain | request...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "maintain", "request" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LaunchSpecifications": { "MarkdownDocumentation": "`LaunchSpecifications`\n\nThe launch specifications for the Spot Fleet request. If you specify\n`LaunchSpecifications`, you can't specify\n`LaunchTemplateConfigs`.\n*Required*: Conditional\n*Type*: Array of [SpotFleetLaunchSpecification](./aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "SpotFleetLaunchSpecification", "DuplicatesAllowed": false }, "InstanceInterruptionBehavior": { "MarkdownDocumentation": "`InstanceInterruptionBehavior`\n\nThe behavior when a Spot Instance is interrupted. The default is\n`terminate`.\n*Required*: No\n*Type*: String\n*Allowed values*: `hibernate | stop | terminat...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "hibernate", "stop", "terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-instanceinterruptionbehavior", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancersConfig": { "MarkdownDocumentation": "`LoadBalancersConfig`\n\nOne or more Classic Load Balancers and target groups to attach to the Spot Fleet\nrequest. Spot Fleet registers the running Spot Instances with the specified Classic Load\nBalancers and target groups.\nWith Network Load Balancers, Spot Fleet cannot register instances that have the\nfollowing instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\nM3, and T1.\n*Required*: No\n*Type*: [LoadBalancersConfig](./aws-properties-ec2-spotfleet-loadbalancersconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-loadbalancersconfig", "UpdateType": "Immutable", "Required": false, "Type": "LoadBalancersConfig" }, "ValidFrom": { "MarkdownDocumentation": "`ValidFrom`\n\nThe start date and time of the request, in UTC format\n(*YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).\nBy default, Amazon EC2 starts fulfilling the request immediately.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validfrom", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ReplaceUnhealthyInstances": { "MarkdownDocumentation": "`ReplaceUnhealthyInstances`\n\nIndicates whether Spot Fleet should replace unhealthy instances.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-replaceunhealthyinstances", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "TargetCapacity": { "MarkdownDocumentation": "`TargetCapacity`\n\nThe number of units to request for the Spot Fleet. You can choose to set the target\ncapacity in terms of instances or a performance characteristic that is important to your\napplication workload, such as vCPUs, memory, or I/O. If the request type is\n`maintain`, you can specify a target capacity of 0 and add capacity\nlater.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::EC2::SpotFleet.SpotFleetTagSpecification": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.SpotFleetTagSpecification`\n\nThe tags for a Spot Fleet resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html", "Properties": { "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource. Currently, the only resource type that is supported is\n`instance`. To tag the Spot Fleet request on creation, use the\n`TagSpecifications` parameter in `[SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html)`.\n*Required*: No\n*Type*: String\n*Allowed values*: `client-vpn-endpoint | custo...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "client-vpn-endpoint", "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", "internet-gateway", "key-pair", "launch-template", "local-gateway-route-table-vpc-association", "natgateway", "network-acl", "network-insights-analysis", "network-insights-path", "network-interface", "placement-group", "reserved-instances", "route-table", "security-group", "snapshot", "spot-fleet-request", "spot-instances-request", "subnet", "traffic-mirror-filter", "traffic-mirror-session", "traffic-mirror-target", "transit-gateway", "transit-gateway-attachment", "transit-gateway-connect-peer", "transit-gateway-multicast-domain", "transit-gateway-route-table", "volume", "vpc", "vpc-flow-log", "vpc-peering-connection", "vpn-connection", "vpn-gateway" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html#cfn-ec2-spotfleet-spotfleettagspecification-resourcetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-spotfleet-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html#cfn-ec2-spotfleet-spotfleettagspecification-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::EC2::SpotFleet.SpotMaintenanceStrategies": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.SpotMaintenanceStrategies`\n\nThe strategies for managing your Spot Instances that are at an elevated risk of being\ninterrupted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotmaintenancestrategies.html", "Properties": { "CapacityRebalance": { "MarkdownDocumentation": "`CapacityRebalance`\n\nThe Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\nSpot Instance is at an elevated risk of being interrupted. For more information, see\n[Capacity\nrebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: [SpotCapacityRebalance](./aws-properties-ec2-spotfleet-spotcapacityrebalance.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotmaintenancestrategies.html#cfn-ec2-spotfleet-spotmaintenancestrategies-capacityrebalance", "UpdateType": "Immutable", "Required": false, "Type": "SpotCapacityRebalance" } } }, "AWS::EC2::SpotFleet.SpotPlacement": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.SpotPlacement`\n\nDescribes Spot Instance placement.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the placement 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-groupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tenancy": { "MarkdownDocumentation": "`Tenancy`\n\nThe tenancy of the instance (if the instance is running in a VPC). An instance with a\ntenancy of `dedicated` runs on single-tenant hardware. The `host`\ntenancy is not supported for Spot Instances.\n*Required*: No\n*Type*: String\n*Allowed values*: `dedicated | default | host...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "dedicated", "default", "host" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-tenancy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone.\nTo specify multiple Availability Zones, separate them using commas; for example,\n\"us-west-2a, us-west-2b\".\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.TargetGroup": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.TargetGroup`\n\nDescribes a load balancer target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroup.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroup.html#cfn-ec2-spotfleet-targetgroup-arn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::SpotFleet.TargetGroupsConfig": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.TargetGroupsConfig`\n\nDescribes the target groups to attach to a Spot Fleet. Spot Fleet registers the\nrunning Spot Instances with these target groups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroupsconfig.html", "Properties": { "TargetGroups": { "MarkdownDocumentation": "`TargetGroups`\n\nOne or more target groups.\n*Required*: Yes\n*Type*: Array of [TargetGroup](./aws-properties-ec2-spotfleet-targetgroup.html)\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroupsconfig.html#cfn-ec2-spotfleet-targetgroupsconfig-targetgroups", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "TargetGroup", "DuplicatesAllowed": false } } }, "AWS::EC2::SpotFleet.TotalLocalStorageGBRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.TotalLocalStorageGBRequest`\n\nThe minimum and maximum amount of total local storage, in GB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of total local storage, in GB. To specify no minimum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html#cfn-ec2-spotfleet-totallocalstoragegbrequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of total local storage, in GB. To specify no maximum limit, omit this\nparameter.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html#cfn-ec2-spotfleet-totallocalstoragegbrequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::SpotFleet.VCpuCountRangeRequest": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet.VCpuCountRangeRequest`\n\nThe minimum and maximum number of vCPUs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-vcpucountrangerequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of vCPUs. To specify no minimum limit, specify `0`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-vcpucountrangerequest.html#cfn-ec2-spotfleet-vcpucountrangerequest-min", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of vCPUs. To specify no maximum limit, omit this parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-vcpucountrangerequest.html#cfn-ec2-spotfleet-vcpucountrangerequest-max", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::Subnet.BlockPublicAccessStates": { "MarkdownDocumentation": "`AWS::EC2::Subnet.BlockPublicAccessStates`\n\nSpecifies the state of VPC Block Public Access (BPA).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-blockpublicaccessstates.html", "Properties": { "InternetGatewayBlockMode": { "MarkdownDocumentation": "`InternetGatewayBlockMode`\n\nThe mode of VPC BPA.\n* `off`: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.\n* `block-bidirectional`: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).\n* `block-ingress`: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.\n*Required*: No\n*Type*: String\n*Allowed values*: `off | block-bidirectional |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "off", "block-bidirectional", "block-ingress" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-blockpublicaccessstates.html#cfn-ec2-subnet-blockpublicaccessstates-internetgatewayblockmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::Subnet.PrivateDnsNameOptionsOnLaunch": { "MarkdownDocumentation": "`AWS::EC2::Subnet.PrivateDnsNameOptionsOnLaunch`\n\nSpecifies the options for instance hostnames.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html", "Properties": { "EnableResourceNameDnsARecord": { "MarkdownDocumentation": "`EnableResourceNameDnsARecord`\n\nIndicates whether to respond to DNS queries for instance hostnames with DNS A\nrecords.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-enableresourcenamednsarecord", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "HostnameType": { "MarkdownDocumentation": "`HostnameType`\n\nThe type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\nmust be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\nmust be based on the instance ID. For dual-stack subnets, you can specify whether DNS\nnames use the instance IPv4 address or the instance ID.\n*Required*: No\n*Type*: String\n*Allowed values*: `ip-name | resource-name...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ip-name", "resource-name" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-hostnametype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableResourceNameDnsAAAARecord": { "MarkdownDocumentation": "`EnableResourceNameDnsAAAARecord`\n\nIndicates whether to respond to DNS queries for instance hostname with DNS AAAA\nrecords.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-enableresourcenamednsaaaarecord", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::TrafficMirrorFilterRule.TrafficMirrorPortRange": { "MarkdownDocumentation": "`AWS::EC2::TrafficMirrorFilterRule.TrafficMirrorPortRange`\n\nDescribes the Traffic Mirror port range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html", "Properties": { "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nThe start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-fromport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nThe end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-toport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::EC2::TransitGatewayAttachment.Options": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayAttachment.Options`\n\nDescribes the VPC attachment options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html", "Properties": { "Ipv6Support": { "MarkdownDocumentation": "`Ipv6Support`\n\nEnable or disable IPv6 support. The default is `disable`.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-ipv6support", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplianceModeSupport": { "MarkdownDocumentation": "`ApplianceModeSupport`\n\nEnable or disable appliance mode support. The default is `disable`.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-appliancemodesupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupReferencingSupport": { "MarkdownDocumentation": "`SecurityGroupReferencingSupport`\n\nEnables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.\nFor important information about this feature, see [Create a transit gateway](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html#create-tgw) in the *AWS Transit Gateway Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-securitygroupreferencingsupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DnsSupport": { "MarkdownDocumentation": "`DnsSupport`\n\nEnable or disable DNS support. The default is `disable`.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-dnssupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::TransitGatewayConnect.TransitGatewayConnectOptions": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayConnect.TransitGatewayConnectOptions`\n\nDescribes the Connect attachment options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnect-transitgatewayconnectoptions.html", "Properties": { "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe tunnel protocol.\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)\n", "RefReturnValue": "", "AllowedValues": [ "gre" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnect-transitgatewayconnectoptions.html#cfn-ec2-transitgatewayconnect-transitgatewayconnectoptions-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::TransitGatewayConnectPeer.TransitGatewayAttachmentBgpConfiguration": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayConnectPeer.TransitGatewayAttachmentBgpConfiguration`\n\nThe BGP configuration information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration.html", "Properties": { "TransitGatewayAddress": { "MarkdownDocumentation": "`TransitGatewayAddress`\n\nThe interior BGP peer IP address for the transit gateway.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration-transitgatewayaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PeerAddress": { "MarkdownDocumentation": "`PeerAddress`\n\nThe interior BGP peer IP address for the appliance.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration-peeraddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BgpStatus": { "MarkdownDocumentation": "`BgpStatus`\n\nThe BGP status.\n*Required*: No\n*Type*: String\n*Allowed values*: `up | down`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "up", "down" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration-bgpstatus", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PeerAsn": { "MarkdownDocumentation": "`PeerAsn`\n\nThe peer Autonomous System Number (ASN).\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration-peerasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "TransitGatewayAsn": { "MarkdownDocumentation": "`TransitGatewayAsn`\n\nThe transit gateway Autonomous System Number (ASN).\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration-transitgatewayasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EC2::TransitGatewayConnectPeer.TransitGatewayConnectPeerConfiguration": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayConnectPeer.TransitGatewayConnectPeerConfiguration`\n\nDescribes the Connect peer details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration.html", "Properties": { "TransitGatewayAddress": { "MarkdownDocumentation": "`TransitGatewayAddress`\n\nThe Connect peer IP address on the transit gateway side of the tunnel.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration-transitgatewayaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BgpConfigurations": { "MarkdownDocumentation": "`BgpConfigurations`\n\nThe BGP configuration details.\n*Required*: No\n*Type*: Array of [TransitGatewayAttachmentBgpConfiguration](./aws-properties-ec2-transitgatewayconnectpeer-transitgatewayattachmentbgpconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration-bgpconfigurations", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "TransitGatewayAttachmentBgpConfiguration", "DuplicatesAllowed": true }, "PeerAddress": { "MarkdownDocumentation": "`PeerAddress`\n\nThe Connect peer IP address on the appliance side of the tunnel.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration-peeraddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InsideCidrBlocks": { "MarkdownDocumentation": "`InsideCidrBlocks`\n\nThe range of interior BGP peer IP addresses.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration-insidecidrblocks", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe tunnel protocol.\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)\n", "RefReturnValue": "", "AllowedValues": [ "gre" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::TransitGatewayMulticastDomain.Options": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayMulticastDomain.Options`\n\nThe options for the transit gateway multicast domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html", "Properties": { "StaticSourcesSupport": { "MarkdownDocumentation": "`StaticSourcesSupport`\n\nSpecify whether to enable support for statically configuring multicast group sources for a domain.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-staticsourcessupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoAcceptSharedAssociations": { "MarkdownDocumentation": "`AutoAcceptSharedAssociations`\n\nIndicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-autoacceptsharedassociations", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Igmpv2Support": { "MarkdownDocumentation": "`Igmpv2Support`\n\nSpecify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-igmpv2support", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::TransitGatewayPeeringAttachment.PeeringAttachmentStatus": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayPeeringAttachment.PeeringAttachmentStatus`\n\nThe status of the transit gateway peering attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaypeeringattachment-peeringattachmentstatus.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nThe status message, if applicable.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaypeeringattachment-peeringattachmentstatus.html#cfn-ec2-transitgatewaypeeringattachment-peeringattachmentstatus-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe status 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaypeeringattachment-peeringattachmentstatus.html#cfn-ec2-transitgatewaypeeringattachment-peeringattachmentstatus-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::TransitGatewayVpcAttachment.Options": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayVpcAttachment.Options`\n\nDescribes the VPC attachment options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html", "Properties": { "Ipv6Support": { "MarkdownDocumentation": "`Ipv6Support`\n\nEnable or disable IPv6 support. The default is `disable`.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-ipv6support", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplianceModeSupport": { "MarkdownDocumentation": "`ApplianceModeSupport`\n\nEnable or disable appliance mode support. The default is `disable`.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-appliancemodesupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupReferencingSupport": { "MarkdownDocumentation": "`SecurityGroupReferencingSupport`\n\nEnables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.\nFor important information about this feature, see [Create a transit gateway](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html#create-tgw) in the *AWS Transit Gateway Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-securitygroupreferencingsupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DnsSupport": { "MarkdownDocumentation": "`DnsSupport`\n\nEnable or disable DNS support. The default is `disable`.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-dnssupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPCEncryptionControl.ResourceExclusions": { "MarkdownDocumentation": "`AWS::EC2::VPCEncryptionControl.ResourceExclusions`\n\nInformation about resource exclusions for the VPC Encryption Control configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html", "Properties": { "ElasticFileSystem": { "MarkdownDocumentation": "`ElasticFileSystem`\n\nSpecifies whether to exclude Elastic File System traffic from encryption enforcement.\n*Required*: No\n*Type*: [VpcEncryptionControlExclusion](./aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html)\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-elasticfilesystem", "UpdateType": "Mutable", "Required": false, "Type": "VpcEncryptionControlExclusion" }, "VpcLattice": { "MarkdownDocumentation": "`VpcLattice`\n\nSpecifies whether to exclude VPC Lattice traffic from encryption enforcement.\n*Required*: No\n*Type*: [VpcEncryptionControlExclusion](./aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html)\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-vpclattice", "UpdateType": "Mutable", "Required": false, "Type": "VpcEncryptionControlExclusion" }, "VpcPeering": { "MarkdownDocumentation": "`VpcPeering`\n\nSpecifies whether to exclude VPC peering connection traffic from encryption enforcement.\n*Required*: No\n*Type*: [VpcEncryptionControlExclusion](./aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html)\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-vpcpeering", "UpdateType": "Mutable", "Required": false, "Type": "VpcEncryptionControlExclusion" }, "InternetGateway": { "MarkdownDocumentation": "`InternetGateway`\n\nSpecifies whether to exclude internet gateway traffic from encryption enforcement.\n*Required*: No\n*Type*: [VpcEncryptionControlExclusion](./aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html)\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-internetgateway", "UpdateType": "Mutable", "Required": false, "Type": "VpcEncryptionControlExclusion" }, "EgressOnlyInternetGateway": { "MarkdownDocumentation": "`EgressOnlyInternetGateway`\n\nSpecifies whether to exclude egress-only internet gateway traffic from encryption enforcement.\n*Required*: No\n*Type*: [VpcEncryptionControlExclusion](./aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html)\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-egressonlyinternetgateway", "UpdateType": "Mutable", "Required": false, "Type": "VpcEncryptionControlExclusion" }, "VirtualPrivateGateway": { "MarkdownDocumentation": "`VirtualPrivateGateway`\n\nSpecifies whether to exclude virtual private gateway traffic from encryption enforcement.\n*Required*: No\n*Type*: [VpcEncryptionControlExclusion](./aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html)\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-virtualprivategateway", "UpdateType": "Mutable", "Required": false, "Type": "VpcEncryptionControlExclusion" }, "NatGateway": { "MarkdownDocumentation": "`NatGateway`\n\nSpecifies whether to exclude NAT gateway traffic from encryption enforcement.\n*Required*: No\n*Type*: [VpcEncryptionControlExclusion](./aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html)\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-natgateway", "UpdateType": "Mutable", "Required": false, "Type": "VpcEncryptionControlExclusion" }, "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nSpecifies whether to exclude Lambda function traffic from encryption enforcement.\n*Required*: No\n*Type*: [VpcEncryptionControlExclusion](./aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html)\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-lambda", "UpdateType": "Mutable", "Required": false, "Type": "VpcEncryptionControlExclusion" } } }, "AWS::EC2::VPCEncryptionControl.VpcEncryptionControlExclusion": { "MarkdownDocumentation": "`AWS::EC2::VPCEncryptionControl.VpcEncryptionControlExclusion`\n\nDescribes an exclusion configuration for VPC Encryption Control.\nFor more information, see [Enforce VPC encryption in transit](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-encryption-controls.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html", "Properties": { "State": { "MarkdownDocumentation": "`State`\n\nThe current state of the exclusion configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `enabling | enabled | disabl...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enabling", "enabled", "disabling", "disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html#cfn-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StateMessage": { "MarkdownDocumentation": "`StateMessage`\n\nA message providing additional information about the exclusion state.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html#cfn-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion-statemessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPCEndpoint.DnsOptionsSpecification": { "MarkdownDocumentation": "`AWS::EC2::VPCEndpoint.DnsOptionsSpecification`\n\nDescribes the DNS options for an endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcendpoint-dnsoptionsspecification.html", "Properties": { "PrivateDnsOnlyForInboundResolverEndpoint": { "MarkdownDocumentation": "`PrivateDnsOnlyForInboundResolverEndpoint`\n\nIndicates whether to enable private DNS only for inbound endpoints. This option is\navailable only for services that support both gateway and interface endpoints. It routes\ntraffic that originates from the VPC to the gateway endpoint and traffic that originates\nfrom on-premises to the interface endpoint.\n*Required*: No\n*Type*: String\n*Allowed values*: `OnlyInboundResolver | AllRe...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OnlyInboundResolver", "AllResolvers", "NotSpecified" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcendpoint-dnsoptionsspecification.html#cfn-ec2-vpcendpoint-dnsoptionsspecification-privatednsonlyforinboundresolverendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateDnsSpecifiedDomains": { "MarkdownDocumentation": "`PrivateDnsSpecifiedDomains`\n\nIndicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is `VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS` or `SPECIFIED_DOMAINS_ONLY`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `255 | 10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcendpoint-dnsoptionsspecification.html#cfn-ec2-vpcendpoint-dnsoptionsspecification-privatednsspecifieddomains", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DnsRecordIpType": { "MarkdownDocumentation": "`DnsRecordIpType`\n\nThe DNS records created for the endpoint.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dualstack | s...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dualstack", "service-defined", "not-specified" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcendpoint-dnsoptionsspecification.html#cfn-ec2-vpcendpoint-dnsoptionsspecification-dnsrecordiptype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateDnsPreference": { "MarkdownDocumentation": "`PrivateDnsPreference`\n\nThe preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.\n*Required*: No\n*Type*: String\n*Allowed values*: `VERIFIED_DOMAINS_ONLY | ALL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "VERIFIED_DOMAINS_ONLY", "ALL_DOMAINS", "VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS", "SPECIFIED_DOMAINS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcendpoint-dnsoptionsspecification.html#cfn-ec2-vpcendpoint-dnsoptionsspecification-privatednspreference", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPNConnection.CloudwatchLogOptionsSpecification": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.CloudwatchLogOptionsSpecification`\n\nOptions for sending VPN tunnel logs to CloudWatch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-cloudwatchlogoptionsspecification.html", "Properties": { "BgpLogEnabled": { "MarkdownDocumentation": "`BgpLogEnabled`\n\nSpecifies whether to enable BGP logging for the VPN connection. Default value is `False`.\nValid values: `True` | `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-cloudwatchlogoptionsspecification.html#cfn-ec2-vpnconnection-cloudwatchlogoptionsspecification-bgplogenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "LogEnabled": { "MarkdownDocumentation": "`LogEnabled`\n\nEnable or disable VPN tunnel logging feature. Default value is `False`.\nValid values: `True` | `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-cloudwatchlogoptionsspecification.html#cfn-ec2-vpnconnection-cloudwatchlogoptionsspecification-logenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "LogOutputFormat": { "MarkdownDocumentation": "`LogOutputFormat`\n\nSet log format. Default format is `json`.\nValid values: `json` | `text`\n*Required*: No\n*Type*: String\n*Allowed values*: `json | text...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "json", "text" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-cloudwatchlogoptionsspecification.html#cfn-ec2-vpnconnection-cloudwatchlogoptionsspecification-logoutputformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BgpLogGroupArn": { "MarkdownDocumentation": "`BgpLogGroupArn`\n\nThe Amazon Resource Name (ARN) of the CloudWatch log group where BGP logs will be sent.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-cloudwatchlogoptionsspecification.html#cfn-ec2-vpnconnection-cloudwatchlogoptionsspecification-bgploggrouparn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe Amazon Resource Name (ARN) of the CloudWatch log group to send logs 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-cloudwatchlogoptionsspecification.html#cfn-ec2-vpnconnection-cloudwatchlogoptionsspecification-loggrouparn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BgpLogOutputFormat": { "MarkdownDocumentation": "`BgpLogOutputFormat`\n\nThe desired output format for BGP logs to be sent to CloudWatch. Default format is `json`.\nValid values: `json` | `text`\n*Required*: No\n*Type*: String\n*Allowed values*: `json | text...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "json", "text" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-cloudwatchlogoptionsspecification.html#cfn-ec2-vpnconnection-cloudwatchlogoptionsspecification-bgplogoutputformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPNConnection.IKEVersionsRequestListValue": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.IKEVersionsRequestListValue`\n\nThe IKE version that is permitted for the VPN tunnel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-ikeversionsrequestlistvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe IKE version.\n*Required*: No\n*Type*: String\n*Allowed values*: `ikev1 | ikev2...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ikev1", "ikev2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-ikeversionsrequestlistvalue.html#cfn-ec2-vpnconnection-ikeversionsrequestlistvalue-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPNConnection.Phase1DHGroupNumbersRequestListValue": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.Phase1DHGroupNumbersRequestListValue`\n\nSpecifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE\nnegotiations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase1dhgroupnumbersrequestlistvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe Diffie-Hellmann group number.\n*Required*: No\n*Type*: Integer\n*Allowed values*: `2 | 14 | 15 | 16 | 17 | 18 ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "2", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase1dhgroupnumbersrequestlistvalue.html#cfn-ec2-vpnconnection-phase1dhgroupnumbersrequestlistvalue-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::VPNConnection.Phase1EncryptionAlgorithmsRequestListValue": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.Phase1EncryptionAlgorithmsRequestListValue`\n\nSpecifies the encryption algorithm for the VPN tunnel for phase 1 IKE\nnegotiations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase1encryptionalgorithmsrequestlistvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the encryption algorithm.\n*Required*: No\n*Type*: String\n*Allowed values*: `AES128 | AES256 | AES128-GC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AES128", "AES256", "AES128-GCM-16", "AES256-GCM-16" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase1encryptionalgorithmsrequestlistvalue.html#cfn-ec2-vpnconnection-phase1encryptionalgorithmsrequestlistvalue-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPNConnection.Phase1IntegrityAlgorithmsRequestListValue": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.Phase1IntegrityAlgorithmsRequestListValue`\n\nSpecifies the integrity algorithm for the VPN tunnel for phase 1 IKE\nnegotiations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase1integrityalgorithmsrequestlistvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the integrity algorithm.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHA1 | SHA2-256 | SHA2-384 ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SHA1", "SHA2-256", "SHA2-384", "SHA2-512" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase1integrityalgorithmsrequestlistvalue.html#cfn-ec2-vpnconnection-phase1integrityalgorithmsrequestlistvalue-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPNConnection.Phase2DHGroupNumbersRequestListValue": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.Phase2DHGroupNumbersRequestListValue`\n\nSpecifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE\nnegotiations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase2dhgroupnumbersrequestlistvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe Diffie-Hellmann group number.\n*Required*: No\n*Type*: Integer\n*Allowed values*: `2 | 5 | 14 | 15 | 16 | 17 |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "2", "5", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase2dhgroupnumbersrequestlistvalue.html#cfn-ec2-vpnconnection-phase2dhgroupnumbersrequestlistvalue-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::VPNConnection.Phase2EncryptionAlgorithmsRequestListValue": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.Phase2EncryptionAlgorithmsRequestListValue`\n\nSpecifies the encryption algorithm for the VPN tunnel for phase 2 IKE\nnegotiations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase2encryptionalgorithmsrequestlistvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe encryption algorithm.\n*Required*: No\n*Type*: String\n*Allowed values*: `AES128 | AES256 | AES128-GC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AES128", "AES256", "AES128-GCM-16", "AES256-GCM-16" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase2encryptionalgorithmsrequestlistvalue.html#cfn-ec2-vpnconnection-phase2encryptionalgorithmsrequestlistvalue-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPNConnection.Phase2IntegrityAlgorithmsRequestListValue": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.Phase2IntegrityAlgorithmsRequestListValue`\n\nSpecifies the integrity algorithm for the VPN tunnel for phase 2 IKE\nnegotiations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase2integrityalgorithmsrequestlistvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe integrity algorithm.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHA1 | SHA2-256 | SHA2-384 ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SHA1", "SHA2-256", "SHA2-384", "SHA2-512" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-phase2integrityalgorithmsrequestlistvalue.html#cfn-ec2-vpnconnection-phase2integrityalgorithmsrequestlistvalue-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VPNConnection.VpnTunnelLogOptionsSpecification": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.VpnTunnelLogOptionsSpecification`\n\nOptions for logging VPN tunnel activity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunnellogoptionsspecification.html", "Properties": { "CloudwatchLogOptions": { "MarkdownDocumentation": "`CloudwatchLogOptions`\n\nOptions for sending VPN tunnel logs to CloudWatch.\n*Required*: No\n*Type*: [CloudwatchLogOptionsSpecification](./aws-properties-ec2-vpnconnection-cloudwatchlogoptionsspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunnellogoptionsspecification.html#cfn-ec2-vpnconnection-vpntunnellogoptionsspecification-cloudwatchlogoptions", "UpdateType": "Immutable", "Required": false, "Type": "CloudwatchLogOptionsSpecification" } } }, "AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification`\n\nThe tunnel options for a single VPN tunnel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html", "Properties": { "Phase2EncryptionAlgorithms": { "MarkdownDocumentation": "`Phase2EncryptionAlgorithms`\n\nOne or more encryption algorithms that are permitted for the VPN tunnel for phase 2\nIKE negotiations.\nValid values: `AES128` | `AES256` | `AES128-GCM-16` |\n`AES256-GCM-16`\n*Required*: No\n*Type*: Array of [Phase2EncryptionAlgorithmsRequestListValue](./aws-properties-ec2-vpnconnection-phase2encryptionalgorithmsrequestlistvalue.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-phase2encryptionalgorithms", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Phase2EncryptionAlgorithmsRequestListValue", "DuplicatesAllowed": true }, "Phase2DHGroupNumbers": { "MarkdownDocumentation": "`Phase2DHGroupNumbers`\n\nOne or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\nphase 2 IKE negotiations.\nValid values: `2` | `5` | `14` | `15` |\n`16` | `17` | `18` | `19` |\n`20` | `21` | `22` | `23` |\n`24`\n*Required*: No\n*Type*: Array of [Phase2DHGroupNumbersRequestListValue](./aws-properties-ec2-vpnconnection-phase2dhgroupnumbersrequestlistvalue.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-phase2dhgroupnumbers", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Phase2DHGroupNumbersRequestListValue", "DuplicatesAllowed": true }, "TunnelInsideIpv6Cidr": { "MarkdownDocumentation": "`TunnelInsideIpv6Cidr`\n\nThe range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\nunique across all VPN connections that use the same transit gateway.\nConstraints: A size /126 CIDR block from the local `fd00::/8` range.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-tunnelinsideipv6cidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StartupAction": { "MarkdownDocumentation": "`StartupAction`\n\nThe action to take when the establishing the tunnel for the VPN connection. By\ndefault, your customer gateway device must initiate the IKE negotiation and bring up the\ntunnel. Specify `start` for AWS to initiate the IKE\nnegotiation.\nValid Values: `add` | `start`\nDefault: `add`\n*Required*: No\n*Type*: String\n*Allowed values*: `add | start...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "add", "start" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-startupaction", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TunnelInsideCidr": { "MarkdownDocumentation": "`TunnelInsideCidr`\n\nThe range of inside IP addresses for the tunnel. Any specified CIDR blocks must be\nunique across all VPN connections that use the same virtual private gateway.\nConstraints: A size /30 CIDR block from the `169.254.0.0/16` range. The\nfollowing CIDR blocks are reserved and cannot be used:\n* `169.254.0.0/30`\n* `169.254.1.0/30`\n* `169.254.2.0/30`\n* `169.254.3.0/30`\n* `169.254.4.0/30`\n* `169.254.5.0/30`\n* `169.254.169.252/30`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-tunnelinsidecidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IKEVersions": { "MarkdownDocumentation": "`IKEVersions`\n\nThe IKE versions that are permitted for the VPN tunnel.\nValid values: `ikev1` | `ikev2`\n*Required*: No\n*Type*: Array of [IKEVersionsRequestListValue](./aws-properties-ec2-vpnconnection-ikeversionsrequestlistvalue.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-ikeversions", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "IKEVersionsRequestListValue", "DuplicatesAllowed": true }, "LogOptions": { "MarkdownDocumentation": "`LogOptions`\n\nOptions for logging VPN tunnel activity.\n*Required*: No\n*Type*: [VpnTunnelLogOptionsSpecification](./aws-properties-ec2-vpnconnection-vpntunnellogoptionsspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-logoptions", "UpdateType": "Immutable", "Required": false, "Type": "VpnTunnelLogOptionsSpecification" }, "Phase1DHGroupNumbers": { "MarkdownDocumentation": "`Phase1DHGroupNumbers`\n\nOne or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\nphase 1 IKE negotiations.\nValid values: `2` | `14` | `15` | `16` |\n`17` | `18` | `19` | `20` |\n`21` | `22` | `23` | `24`\n*Required*: No\n*Type*: Array of [Phase1DHGroupNumbersRequestListValue](./aws-properties-ec2-vpnconnection-phase1dhgroupnumbersrequestlistvalue.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-phase1dhgroupnumbers", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Phase1DHGroupNumbersRequestListValue", "DuplicatesAllowed": true }, "ReplayWindowSize": { "MarkdownDocumentation": "`ReplayWindowSize`\n\nThe number of packets in an IKE replay window.\nConstraints: A value between 64 and 2048.\nDefault: `1024`\n*Required*: No\n*Type*: Integer\n*Minimum*: `64`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-replaywindowsize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "EnableTunnelLifecycleControl": { "MarkdownDocumentation": "`EnableTunnelLifecycleControl`\n\nTurn on or off tunnel endpoint lifecycle control feature.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-enabletunnellifecyclecontrol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "RekeyMarginTimeSeconds": { "MarkdownDocumentation": "`RekeyMarginTimeSeconds`\n\nThe margin time, in seconds, before the phase 2 lifetime expires, during which the\nAWS side of the VPN connection performs an IKE rekey. The exact time\nof the rekey is randomly selected based on the value for\n`RekeyFuzzPercentage`.\nConstraints: A value between 60 and half of `Phase2LifetimeSeconds`.\nDefault: `270`\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-rekeymargintimeseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DPDTimeoutAction": { "MarkdownDocumentation": "`DPDTimeoutAction`\n\nThe action to take after DPD timeout occurs. Specify `restart` to restart\nthe IKE initiation. Specify `clear` to end the IKE session.\nValid Values: `clear` | `none` | `restart`\nDefault: `clear`\n*Required*: No\n*Type*: String\n*Allowed values*: `clear | none | restart...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "clear", "none", "restart" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-dpdtimeoutaction", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Phase2LifetimeSeconds": { "MarkdownDocumentation": "`Phase2LifetimeSeconds`\n\nThe lifetime for phase 2 of the IKE negotiation, in seconds.\nConstraints: A value between 900 and 3,600. The value must be less than the value for\n`Phase1LifetimeSeconds`.\nDefault: `3600`\n*Required*: No\n*Type*: Integer\n*Minimum*: `900`\n*Maximum*: `3600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-phase2lifetimeseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Phase2IntegrityAlgorithms": { "MarkdownDocumentation": "`Phase2IntegrityAlgorithms`\n\nOne or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\nnegotiations.\nValid values: `SHA1` | `SHA2-256` | `SHA2-384` |\n`SHA2-512`\n*Required*: No\n*Type*: Array of [Phase2IntegrityAlgorithmsRequestListValue](./aws-properties-ec2-vpnconnection-phase2integrityalgorithmsrequestlistvalue.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-phase2integrityalgorithms", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Phase2IntegrityAlgorithmsRequestListValue", "DuplicatesAllowed": true }, "Phase1IntegrityAlgorithms": { "MarkdownDocumentation": "`Phase1IntegrityAlgorithms`\n\nOne or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\nnegotiations.\nValid values: `SHA1` | `SHA2-256` | `SHA2-384` |\n`SHA2-512`\n*Required*: No\n*Type*: Array of [Phase1IntegrityAlgorithmsRequestListValue](./aws-properties-ec2-vpnconnection-phase1integrityalgorithmsrequestlistvalue.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-phase1integrityalgorithms", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Phase1IntegrityAlgorithmsRequestListValue", "DuplicatesAllowed": true }, "PreSharedKey": { "MarkdownDocumentation": "`PreSharedKey`\n\nThe pre-shared key (PSK) to establish initial authentication between the virtual\nprivate gateway and customer gateway.\nConstraints: Allowed characters are alphanumeric characters, periods (.), and\nunderscores (\\_). Must be between 8 and 64 characters in length and cannot start with\nzero (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-presharedkey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Phase1LifetimeSeconds": { "MarkdownDocumentation": "`Phase1LifetimeSeconds`\n\nThe lifetime for phase 1 of the IKE negotiation, in seconds.\nConstraints: A value between 900 and 28,800.\nDefault: `28800`\n*Required*: No\n*Type*: Integer\n*Minimum*: `900`\n*Maximum*: `28800`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-phase1lifetimeseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "RekeyFuzzPercentage": { "MarkdownDocumentation": "`RekeyFuzzPercentage`\n\nThe percentage of the rekey window (determined by `RekeyMarginTimeSeconds`)\nduring which the rekey time is randomly selected.\nConstraints: A value between 0 and 100.\nDefault: `100`\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-rekeyfuzzpercentage", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Phase1EncryptionAlgorithms": { "MarkdownDocumentation": "`Phase1EncryptionAlgorithms`\n\nOne or more encryption algorithms that are permitted for the VPN tunnel for phase 1\nIKE negotiations.\nValid values: `AES128` | `AES256` | `AES128-GCM-16` |\n`AES256-GCM-16`\n*Required*: No\n*Type*: Array of [Phase1EncryptionAlgorithmsRequestListValue](./aws-properties-ec2-vpnconnection-phase1encryptionalgorithmsrequestlistvalue.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-phase1encryptionalgorithms", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Phase1EncryptionAlgorithmsRequestListValue", "DuplicatesAllowed": true }, "DPDTimeoutSeconds": { "MarkdownDocumentation": "`DPDTimeoutSeconds`\n\nThe number of seconds after which a DPD timeout occurs.\nConstraints: A value greater than or equal to 30.\nDefault: `30`\n*Required*: No\n*Type*: Integer\n*Minimum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-dpdtimeoutseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::VerifiedAccessEndpoint.CidrOptions": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessEndpoint.CidrOptions`\n\nDescribes the CIDR options for a Verified Access endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html#cfn-ec2-verifiedaccessendpoint-cidroptions-cidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PortRanges": { "MarkdownDocumentation": "`PortRanges`\n\nThe port ranges.\n*Required*: No\n*Type*: Array of [PortRange](./aws-properties-ec2-verifiedaccessendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html#cfn-ec2-verifiedaccessendpoint-cidroptions-portranges", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": false }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol.\n*Required*: No\n*Type*: String\n*Allowed values*: `http | https | tcp...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "http", "https", "tcp" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html#cfn-ec2-verifiedaccessendpoint-cidroptions-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of the subnets.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html#cfn-ec2-verifiedaccessendpoint-cidroptions-subnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::EC2::VerifiedAccessEndpoint.LoadBalancerOptions": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessEndpoint.LoadBalancerOptions`\n\nDescribes the load balancer options when creating an AWS Verified Access endpoint using the\n`load-balancer` type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html", "Properties": { "LoadBalancerArn": { "MarkdownDocumentation": "`LoadBalancerArn`\n\nThe ARN of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-loadbalancerarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe IP port number.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PortRanges": { "MarkdownDocumentation": "`PortRanges`\n\nThe port ranges.\n*Required*: No\n*Type*: Array of [PortRange](./aws-properties-ec2-verifiedaccessendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-portranges", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": false }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe IP protocol.\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)", "RefReturnValue": "", "AllowedValues": [ "http", "https", "tcp" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of the subnets. You can specify only one subnet per Availability Zone.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::EC2::VerifiedAccessEndpoint.NetworkInterfaceOptions": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessEndpoint.NetworkInterfaceOptions`\n\nDescribes the network interface options when creating an AWS Verified Access endpoint using the\n`network-interface` type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nThe IP port number.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PortRanges": { "MarkdownDocumentation": "`PortRanges`\n\nThe port ranges.\n*Required*: No\n*Type*: Array of [PortRange](./aws-properties-ec2-verifiedaccessendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-portranges", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": false }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of the network 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-networkinterfaceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe IP protocol.\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)", "RefReturnValue": "", "AllowedValues": [ "http", "https", "tcp" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VerifiedAccessEndpoint.PortRange": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessEndpoint.PortRange`\n\nDescribes the port range for a Verified Access endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-portrange.html", "Properties": { "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nThe start of the port range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-portrange.html#cfn-ec2-verifiedaccessendpoint-portrange-fromport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nThe end of the port range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-portrange.html#cfn-ec2-verifiedaccessendpoint-portrange-toport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EC2::VerifiedAccessEndpoint.RdsOptions": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessEndpoint.RdsOptions`\n\nDescribes the RDS options for a Verified Access endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html", "Properties": { "RdsDbProxyArn": { "MarkdownDocumentation": "`RdsDbProxyArn`\n\nThe ARN of the RDS proxy.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-rdsdbproxyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RdsDbClusterArn": { "MarkdownDocumentation": "`RdsDbClusterArn`\n\nThe ARN of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-rdsdbclusterarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RdsEndpoint": { "MarkdownDocumentation": "`RdsEndpoint`\n\nThe RDS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-rdsendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RdsDbInstanceArn": { "MarkdownDocumentation": "`RdsDbInstanceArn`\n\nThe ARN of the RDS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-rdsdbinstancearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol.\n*Required*: No\n*Type*: String\n*Allowed values*: `http | https | tcp...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "http", "https", "tcp" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of the subnets. You can specify only one subnet per Availability Zone.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::EC2::VerifiedAccessEndpoint.SseSpecification": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessEndpoint.SseSpecification`\n\nAWS Verified Access provides server side encryption by default to data at rest using AWS-owned KMS keys. You also have the option of using customer managed KMS keys, which can be specified using the options below.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-ssespecification.html", "Properties": { "CustomerManagedKeyEnabled": { "MarkdownDocumentation": "`CustomerManagedKeyEnabled`\n\nEnable or disable the use of customer managed KMS keys for server side encryption.\nValid values: `True` | `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-ssespecification.html#cfn-ec2-verifiedaccessendpoint-ssespecification-customermanagedkeyenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the KMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-ssespecification.html#cfn-ec2-verifiedaccessendpoint-ssespecification-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VerifiedAccessGroup.SseSpecification": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessGroup.SseSpecification`\n\nAWS Verified Access provides server side encryption by default to data at rest using AWS-owned KMS keys. You also have the option of using customer managed KMS keys, which can be specified using the options below.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessgroup-ssespecification.html", "Properties": { "CustomerManagedKeyEnabled": { "MarkdownDocumentation": "`CustomerManagedKeyEnabled`\n\nEnable or disable the use of customer managed KMS keys for server side encryption.\nValid values: `True` | `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessgroup-ssespecification.html#cfn-ec2-verifiedaccessgroup-ssespecification-customermanagedkeyenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the KMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessgroup-ssespecification.html#cfn-ec2-verifiedaccessgroup-ssespecification-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VerifiedAccessInstance.CloudWatchLogs": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessInstance.CloudWatchLogs`\n\nOptions for CloudWatch Logs as a logging destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html", "Properties": { "LogGroup": { "MarkdownDocumentation": "`LogGroup`\n\nThe ID of the CloudWatch Logs log 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html#cfn-ec2-verifiedaccessinstance-cloudwatchlogs-loggroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether logging 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html#cfn-ec2-verifiedaccessinstance-cloudwatchlogs-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::VerifiedAccessInstance.KinesisDataFirehose": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessInstance.KinesisDataFirehose`\n\nOptions for Kinesis as a logging destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html", "Properties": { "DeliveryStream": { "MarkdownDocumentation": "`DeliveryStream`\n\nThe ID of the delivery 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html#cfn-ec2-verifiedaccessinstance-kinesisdatafirehose-deliverystream", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether logging 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html#cfn-ec2-verifiedaccessinstance-kinesisdatafirehose-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::VerifiedAccessInstance.S3": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessInstance.S3`\n\nOptions for Amazon S3 as a logging destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe bucket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether logging 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe bucket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketOwner": { "MarkdownDocumentation": "`BucketOwner`\n\nThe AWS account number that owns 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-bucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VerifiedAccessInstance.VerifiedAccessLogs": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessInstance.VerifiedAccessLogs`\n\nDescribes the options for Verified Access logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nAmazon S3 logging options.\n*Required*: No\n*Type*: [S3](./aws-properties-ec2-verifiedaccessinstance-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3" }, "LogVersion": { "MarkdownDocumentation": "`LogVersion`\n\nThe logging version.\nValid values: `ocsf-0.1` | `ocsf-1.0.0-rc.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-logversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KinesisDataFirehose": { "MarkdownDocumentation": "`KinesisDataFirehose`\n\nKinesis logging destination.\n*Required*: No\n*Type*: [KinesisDataFirehose](./aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-kinesisdatafirehose", "UpdateType": "Mutable", "Required": false, "Type": "KinesisDataFirehose" }, "CloudWatchLogs": { "MarkdownDocumentation": "`CloudWatchLogs`\n\nCloudWatch Logs logging destination.\n*Required*: No\n*Type*: [CloudWatchLogs](./aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-cloudwatchlogs", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLogs" }, "IncludeTrustContext": { "MarkdownDocumentation": "`IncludeTrustContext`\n\nIndicates whether to include trust data sent by trust providers 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-includetrustcontext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EC2::VerifiedAccessInstance.VerifiedAccessTrustProvider": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessInstance.VerifiedAccessTrustProvider`\n\nA trust provider is a third-party entity that creates, maintains, and manages identity\ninformation for users and devices. When an application request is made, the identity\ninformation sent by the trust provider is evaluated by Verified Access before allowing or\ndenying the application request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the AWS Verified Access trust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeviceTrustProviderType": { "MarkdownDocumentation": "`DeviceTrustProviderType`\n\nThe type of device-based trust provider.\n*Required*: No\n*Type*: String\n*Allowed values*: `jamf | crowdstrike | jumpcl...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "jamf", "crowdstrike", "jumpcloud" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-devicetrustprovidertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VerifiedAccessTrustProviderId": { "MarkdownDocumentation": "`VerifiedAccessTrustProviderId`\n\nThe ID of the AWS Verified Access trust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-verifiedaccesstrustproviderid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustProviderType": { "MarkdownDocumentation": "`TrustProviderType`\n\nThe type of Verified Access trust provider.\n*Required*: No\n*Type*: String\n*Allowed values*: `user | device...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "user", "device" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-trustprovidertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserTrustProviderType": { "MarkdownDocumentation": "`UserTrustProviderType`\n\nThe type of user-based trust provider.\n*Required*: No\n*Type*: String\n*Allowed values*: `iam-identity-center | oidc...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "iam-identity-center", "oidc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-usertrustprovidertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VerifiedAccessTrustProvider.DeviceOptions": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessTrustProvider.DeviceOptions`\n\nDescribes the options for an AWS Verified Access device-identity based trust provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-deviceoptions.html", "Properties": { "TenantId": { "MarkdownDocumentation": "`TenantId`\n\nThe ID of the tenant application with the device-identity provider.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-deviceoptions.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions-tenantid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PublicSigningKeyUrl": { "MarkdownDocumentation": "`PublicSigningKeyUrl`\n\nThe URL AWS Verified Access will use to verify the authenticity of the device tokens.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-deviceoptions.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions-publicsigningkeyurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VerifiedAccessTrustProvider.NativeApplicationOidcOptions": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessTrustProvider.NativeApplicationOidcOptions`\n\nDescribes the OpenID Connect (OIDC) options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html", "Properties": { "TokenEndpoint": { "MarkdownDocumentation": "`TokenEndpoint`\n\nThe token endpoint of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions-tokenendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe set of user claims to be requested from the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nThe OIDC issuer identifier of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions-issuer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe OAuth 2.0 client 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions-clientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserInfoEndpoint": { "MarkdownDocumentation": "`UserInfoEndpoint`\n\nThe user info endpoint of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions-userinfoendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe OAuth 2.0 client 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions-clientid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizationEndpoint": { "MarkdownDocumentation": "`AuthorizationEndpoint`\n\nThe authorization endpoint of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions-authorizationendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PublicSigningKeyEndpoint": { "MarkdownDocumentation": "`PublicSigningKeyEndpoint`\n\nThe public signing key 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions-publicsigningkeyendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VerifiedAccessTrustProvider.OidcOptions": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessTrustProvider.OidcOptions`\n\nDescribes the options for an OpenID Connect-compatible user-identity trust\nprovider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html", "Properties": { "TokenEndpoint": { "MarkdownDocumentation": "`TokenEndpoint`\n\nThe OIDC token 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-tokenendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe OpenID Connect (OIDC) scope 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nThe OIDC issuer.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-issuer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe client 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-clientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserInfoEndpoint": { "MarkdownDocumentation": "`UserInfoEndpoint`\n\nThe OIDC user info 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-userinfoendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe client 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-clientid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizationEndpoint": { "MarkdownDocumentation": "`AuthorizationEndpoint`\n\nThe OIDC authorization 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-authorizationendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::VerifiedAccessTrustProvider.SseSpecification": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessTrustProvider.SseSpecification`\n\nAWS Verified Access provides server side encryption by default to data at rest using AWS-owned KMS keys. You also have the option of using customer managed KMS keys, which can be specified using the options below.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-ssespecification.html", "Properties": { "CustomerManagedKeyEnabled": { "MarkdownDocumentation": "`CustomerManagedKeyEnabled`\n\nEnable or disable the use of customer managed KMS keys for server side encryption.\nValid values: `True` | `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-ssespecification.html#cfn-ec2-verifiedaccesstrustprovider-ssespecification-customermanagedkeyenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the KMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-ssespecification.html#cfn-ec2-verifiedaccesstrustprovider-ssespecification-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECR::RegistryScanningConfiguration.RepositoryFilter": { "MarkdownDocumentation": "`AWS::ECR::RegistryScanningConfiguration.RepositoryFilter`\n\nThe filter settings used with image replication. Specifying a repository filter to a\nreplication rule provides a method for controlling which repositories in a private\nregistry are replicated. If no filters are added, the contents of all repositories are\nreplicated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-registryscanningconfiguration-repositoryfilter.html", "Properties": { "FilterType": { "MarkdownDocumentation": "`FilterType`\n\nThe type associated with the filter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WILDCARD`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "WILDCARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-registryscanningconfiguration-repositoryfilter.html#cfn-ecr-registryscanningconfiguration-repositoryfilter-filtertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe filter to use when scanning.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9*](?:[._\\-/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-registryscanningconfiguration-repositoryfilter.html#cfn-ecr-registryscanningconfiguration-repositoryfilter-filter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECR::RegistryScanningConfiguration.ScanningRule": { "MarkdownDocumentation": "`AWS::ECR::RegistryScanningConfiguration.ScanningRule`\n\nThe scanning rules associated with the registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-registryscanningconfiguration-scanningrule.html", "Properties": { "RepositoryFilters": { "MarkdownDocumentation": "`RepositoryFilters`\n\nThe details of a scanning repository filter. For more information on how to use\nfilters, see [Using\nfilters](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters) in the *Amazon Elastic Container Registry User Guide*.\n*Required*: Yes\n*Type*: Array of [RepositoryFilter](./aws-properties-ecr-registryscanningconfiguration-repositoryfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-registryscanningconfiguration-scanningrule.html#cfn-ecr-registryscanningconfiguration-scanningrule-repositoryfilters", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RepositoryFilter", "DuplicatesAllowed": true }, "ScanFrequency": { "MarkdownDocumentation": "`ScanFrequency`\n\nThe frequency that scans are performed at for a private registry. When the\n`ENHANCED` scan type is specified, the supported scan frequencies are\n`CONTINUOUS_SCAN` and `SCAN_ON_PUSH`. When the\n`BASIC` scan type is specified, the `SCAN_ON_PUSH` scan\nfrequency is supported. If scan on push is not specified, then the `MANUAL`\nscan frequency is set by default.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SCAN_ON_PUSH | CONTINUOUS_S...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SCAN_ON_PUSH", "CONTINUOUS_SCAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-registryscanningconfiguration-scanningrule.html#cfn-ecr-registryscanningconfiguration-scanningrule-scanfrequency", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECR::ReplicationConfiguration.ReplicationConfiguration": { "MarkdownDocumentation": "`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration`\n\nThe replication configuration for a registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nAn array of objects representing the replication destinations and repository filters\nfor a replication configuration.\n*Required*: Yes\n*Type*: Array of [ReplicationRule](./aws-properties-ecr-replicationconfiguration-replicationrule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ReplicationRule", "DuplicatesAllowed": true } } }, "AWS::ECR::ReplicationConfiguration.ReplicationDestination": { "MarkdownDocumentation": "`AWS::ECR::ReplicationConfiguration.ReplicationDestination`\n\nAn array of objects representing the destination for a replication rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html", "Properties": { "Region": { "MarkdownDocumentation": "`Region`\n\nThe Region to replicate to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-z-]{2,25}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RegistryId": { "MarkdownDocumentation": "`RegistryId`\n\nThe AWS account ID of the Amazon ECR private registry to replicate to. When configuring\ncross-Region replication within your own registry, specify your own account ID.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECR::ReplicationConfiguration.ReplicationRule": { "MarkdownDocumentation": "`AWS::ECR::ReplicationConfiguration.ReplicationRule`\n\nAn array of objects representing the replication destinations and repository filters\nfor a replication configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html", "Properties": { "RepositoryFilters": { "MarkdownDocumentation": "`RepositoryFilters`\n\nAn array of objects representing the filters for a replication rule. Specifying a\nrepository filter for a replication rule provides a method for controlling which\nrepositories in a private registry are replicated.\n*Required*: No\n*Type*: Array of [RepositoryFilter](./aws-properties-ecr-replicationconfiguration-repositoryfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-repositoryfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RepositoryFilter", "DuplicatesAllowed": true }, "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nAn array of objects representing the destination for a replication rule.\n*Required*: Yes\n*Type*: Array of [ReplicationDestination](./aws-properties-ecr-replicationconfiguration-replicationdestination.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ReplicationDestination", "DuplicatesAllowed": true } } }, "AWS::ECR::ReplicationConfiguration.RepositoryFilter": { "MarkdownDocumentation": "`AWS::ECR::ReplicationConfiguration.RepositoryFilter`\n\nThe filter settings used with image replication. Specifying a repository filter to a\nreplication rule provides a method for controlling which repositories in a private\nregistry are replicated. If no filters are added, the contents of all repositories are\nreplicated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-repositoryfilter.html", "Properties": { "FilterType": { "MarkdownDocumentation": "`FilterType`\n\nThe repository filter type. The only supported value is `PREFIX_MATCH`,\nwhich is a repository name prefix specified with the `filter`\nparameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PREFIX_MATCH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PREFIX_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-repositoryfilter.html#cfn-ecr-replicationconfiguration-repositoryfilter-filtertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe repository filter details. When the `PREFIX_MATCH` filter type is\nspecified, this value is required and should be the repository name prefix to configure\nreplication for.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-repositoryfilter.html#cfn-ecr-replicationconfiguration-repositoryfilter-filter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECR::Repository.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::ECR::Repository.EncryptionConfiguration`\n\nThe encryption configuration for the repository. This determines how the contents of\nyour repository are encrypted at rest.\nBy default, when no encryption configuration is set or the `AES256`\nencryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption\nkeys which encrypts your data at rest using an AES256 encryption algorithm. This does\nnot require any action on your part.\nFor more control over the encryption of the contents of your repository, you can use\nserver-side encryption with AWS Key Management Service key stored in AWS Key Management Service (AWS KMS) to encrypt your\nimages. For more information, see [Amazon ECR encryption at\nrest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-encryptionconfiguration.html", "Properties": { "EncryptionType": { "MarkdownDocumentation": "`EncryptionType`\n\nThe encryption type to use.\nIf you use the `KMS` encryption type, the contents of the repository will\nbe encrypted using server-side encryption with AWS Key Management Service key stored in AWS KMS. When you\nuse AWS KMS to encrypt your data, you can either use the default AWS managed AWS KMS key\nfor Amazon ECR, or specify your own AWS KMS key, which you already created.\nIf you use the `KMS_DSSE` encryption type, the contents of the repository\nwill be encrypted with two layers of encryption using server-side encryption with the\nAWS KMS Management Service key stored in AWS KMS. Similar to the `KMS` encryption\ntype, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your\nown AWS KMS key, which you've already created.\nIf you use the `AES256` encryption type, Amazon ECR uses server-side encryption\nwith Amazon S3-managed encryption keys which encrypts the images in the repository using an\nAES256 encryption algorithm.\nFor more information, see [Amazon ECR encryption at\nrest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AES256 | KMS | KMS_DSSE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AES256", "KMS", "KMS_DSSE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-encryptionconfiguration.html#cfn-ecr-repository-encryptionconfiguration-encryptiontype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nIf you use the `KMS` encryption type, specify the AWS KMS key to use for\nencryption. The alias, key ID, or full ARN of the AWS KMS key can be specified. The key\nmust exist in the same Region as the repository. If no key is specified, the default\nAWS managed AWS KMS key for Amazon ECR will be used.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-encryptionconfiguration.html#cfn-ecr-repository-encryptionconfiguration-kmskey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECR::Repository.ImageScanningConfiguration": { "MarkdownDocumentation": "`AWS::ECR::Repository.ImageScanningConfiguration`\n\nThe image scanning configuration for a repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-imagescanningconfiguration.html", "Properties": { "ScanOnPush": { "MarkdownDocumentation": "`ScanOnPush`\n\nThe setting that determines whether images are scanned after being pushed to a\nrepository. If set to `true`, images will be scanned after being pushed. If\nthis parameter is not specified, it will default to `false` and images will\nnot be scanned unless a scan is manually started.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-imagescanningconfiguration.html#cfn-ecr-repository-imagescanningconfiguration-scanonpush", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ECR::Repository.ImageTagMutabilityExclusionFilter": { "MarkdownDocumentation": "`AWS::ECR::Repository.ImageTagMutabilityExclusionFilter`\n\nA filter that specifies which image tags should be excluded from the repository's\nimage tag mutability setting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-imagetagmutabilityexclusionfilter.html", "Properties": { "ImageTagMutabilityExclusionFilterType": { "MarkdownDocumentation": "`ImageTagMutabilityExclusionFilterType`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WILDCARD`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "WILDCARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-imagetagmutabilityexclusionfilter.html#cfn-ecr-repository-imagetagmutabilityexclusionfilter-imagetagmutabilityexclusionfiltertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImageTagMutabilityExclusionFilterValue": { "MarkdownDocumentation": "`ImageTagMutabilityExclusionFilterValue`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z._*-]{1,128}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-imagetagmutabilityexclusionfilter.html#cfn-ecr-repository-imagetagmutabilityexclusionfilter-imagetagmutabilityexclusionfiltervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECR::Repository.LifecyclePolicy": { "MarkdownDocumentation": "`AWS::ECR::Repository.LifecyclePolicy`\n\nThe `LifecyclePolicy` property type specifies a lifecycle policy. For\ninformation about lifecycle policy syntax, see [Lifecycle policy\ntemplate](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html", "Properties": { "LifecyclePolicyText": { "MarkdownDocumentation": "`LifecyclePolicyText`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RegistryId": { "MarkdownDocumentation": "`RegistryId`\n\nThe AWS account ID associated with the registry that contains the repository. If you\ndo\u2028 not specify a registry, the default registry is assumed.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECR::RepositoryCreationTemplate.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::ECR::RepositoryCreationTemplate.EncryptionConfiguration`\n\nThe encryption configuration for the repository. This determines how the contents of\nyour repository are encrypted at rest.\nBy default, when no encryption configuration is set or the `AES256`\nencryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption\nkeys which encrypts your data at rest using an AES256 encryption algorithm. This does\nnot require any action on your part.\nFor more control over the encryption of the contents of your repository, you can use\nserver-side encryption with AWS Key Management Service key stored in AWS Key Management Service (AWS KMS) to encrypt your\nimages. For more information, see [Amazon ECR encryption at\nrest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repositorycreationtemplate-encryptionconfiguration.html", "Properties": { "EncryptionType": { "MarkdownDocumentation": "`EncryptionType`\n\nThe encryption type to use.\nIf you use the `KMS` encryption type, the contents of the repository will\nbe encrypted using server-side encryption with AWS Key Management Service key stored in AWS KMS. When you\nuse AWS KMS to encrypt your data, you can either use the default AWS managed AWS KMS key\nfor Amazon ECR, or specify your own AWS KMS key, which you already created.\nIf you use the `KMS_DSSE` encryption type, the contents of the repository\nwill be encrypted with two layers of encryption using server-side encryption with the\nAWS KMS Management Service key stored in AWS KMS. Similar to the `KMS` encryption\ntype, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your\nown AWS KMS key, which you've already created.\nIf you use the `AES256` encryption type, Amazon ECR uses server-side encryption\nwith Amazon S3-managed encryption keys which encrypts the images in the repository using an\nAES256 encryption algorithm.\nFor more information, see [Amazon ECR encryption at\nrest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AES256 | KMS | KMS_DSSE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AES256", "KMS", "KMS_DSSE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repositorycreationtemplate-encryptionconfiguration.html#cfn-ecr-repositorycreationtemplate-encryptionconfiguration-encryptiontype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nIf you use the `KMS` encryption type, specify the AWS KMS key to use for\nencryption. The alias, key ID, or full ARN of the AWS KMS key can be specified. The key\nmust exist in the same Region as the repository. If no key is specified, the default\nAWS managed AWS KMS key for Amazon ECR will be used.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repositorycreationtemplate-encryptionconfiguration.html#cfn-ecr-repositorycreationtemplate-encryptionconfiguration-kmskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECR::RepositoryCreationTemplate.ImageTagMutabilityExclusionFilter": { "MarkdownDocumentation": "`AWS::ECR::RepositoryCreationTemplate.ImageTagMutabilityExclusionFilter`\n\nA filter that specifies which image tags should be excluded from the repository's\nimage tag mutability setting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repositorycreationtemplate-imagetagmutabilityexclusionfilter.html", "Properties": { "ImageTagMutabilityExclusionFilterType": { "MarkdownDocumentation": "`ImageTagMutabilityExclusionFilterType`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WILDCARD`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "WILDCARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repositorycreationtemplate-imagetagmutabilityexclusionfilter.html#cfn-ecr-repositorycreationtemplate-imagetagmutabilityexclusionfilter-imagetagmutabilityexclusionfiltertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImageTagMutabilityExclusionFilterValue": { "MarkdownDocumentation": "`ImageTagMutabilityExclusionFilterValue`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z._*-]{1,128}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repositorycreationtemplate-imagetagmutabilityexclusionfilter.html#cfn-ecr-repositorycreationtemplate-imagetagmutabilityexclusionfilter-imagetagmutabilityexclusionfiltervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECR::SigningConfiguration.RepositoryFilter": { "MarkdownDocumentation": "`AWS::ECR::SigningConfiguration.RepositoryFilter`\n\nA repository filter used to determine which repositories have their\nimages automatically signed on push. Each filter consists of a filter type and filter value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-signingconfiguration-repositoryfilter.html", "Properties": { "FilterType": { "MarkdownDocumentation": "`FilterType`\n\nThe type of filter to apply. Currently, only `WILDCARD_MATCH` is supported,\nwhich uses wildcard patterns to match repository names.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WILDCARD_MATCH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WILDCARD_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-signingconfiguration-repositoryfilter.html#cfn-ecr-signingconfiguration-repositoryfilter-filtertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe filter value used to match repository names. When using\n`WILDCARD_MATCH`, the `*` character matches any sequence of characters.\nExamples:\n* `myapp/*` - Matches all repositories starting with\n `myapp/`\n* `*/production` - Matches all repositories ending with\n `/production`\n* `*prod*` - Matches all repositories containing\n `prod`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?:[a-z0-9*]+(?:[._-][a-z0-9*]+)*/)*[a-z0-9*]+(?:[._-][a-z0-9*]+)*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-signingconfiguration-repositoryfilter.html#cfn-ecr-signingconfiguration-repositoryfilter-filter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECR::SigningConfiguration.Rule": { "MarkdownDocumentation": "`AWS::ECR::SigningConfiguration.Rule`\n\nA signing rule that specifies a signing profile and optional\nrepository filters. When an image is pushed to a matching repository, a\nsigning job is created using the specified profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-signingconfiguration-rule.html", "Properties": { "RepositoryFilters": { "MarkdownDocumentation": "`RepositoryFilters`\n\nA list of repository filters that determine which repositories\nhave their images signed on push. If no filters are specified, all\nimages pushed to the registry are signed using the rule's signing\nprofile. Maximum of 100 filters per rule.\n*Required*: No\n*Type*: Array of [RepositoryFilter](./aws-properties-ecr-signingconfiguration-repositoryfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-signingconfiguration-rule.html#cfn-ecr-signingconfiguration-rule-repositoryfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RepositoryFilter", "DuplicatesAllowed": true }, "SigningProfileArn": { "MarkdownDocumentation": "`SigningProfileArn`\n\nThe ARN of the AWS Signer signing profile to use for signing images that match this\nrule. For more information about signing profiles, see [Signing profiles](https://docs.aws.amazon.com/signer/latest/developerguide/signing-profiles.html) in\nthe *AWS Signer Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[a-z]+)*:signer:[a-z0-9-]+:[0-9]{12}:\\/signing-profiles\\/[a-zA-Z0-9_]{2,}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-signingconfiguration-rule.html#cfn-ecr-signingconfiguration-rule-signingprofilearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::CapacityProvider.AcceleratorCountRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.AcceleratorCountRequest`\n\nThe minimum and maximum number of accelerators (such as GPUs) for instance type\nselection. This is used for workloads that require specific numbers of\naccelerators.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-acceleratorcountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of accelerators. Instance types with fewer accelerators are\nexcluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-acceleratorcountrequest.html#cfn-ecs-capacityprovider-acceleratorcountrequest-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of accelerators. Instance types with more accelerators are excluded\nfrom selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-acceleratorcountrequest.html#cfn-ecs-capacityprovider-acceleratorcountrequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::CapacityProvider.AcceleratorTotalMemoryMiBRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.AcceleratorTotalMemoryMiBRequest`\n\nThe minimum and maximum total accelerator memory in mebibytes (MiB) for instance type\nselection. This is important for GPU workloads that require specific amounts of video\nmemory.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-acceleratortotalmemorymibrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum total accelerator memory in MiB. Instance types with less accelerator\nmemory are excluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-acceleratortotalmemorymibrequest.html#cfn-ecs-capacityprovider-acceleratortotalmemorymibrequest-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum total accelerator memory in MiB. Instance types with more accelerator\nmemory are excluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-acceleratortotalmemorymibrequest.html#cfn-ecs-capacityprovider-acceleratortotalmemorymibrequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::CapacityProvider.AutoScalingGroupProvider": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.AutoScalingGroupProvider`\n\nThe details of the Auto Scaling group for the capacity provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html", "Properties": { "ManagedScaling": { "MarkdownDocumentation": "`ManagedScaling`\n\nThe managed scaling settings for the Auto Scaling group capacity provider.\n*Required*: No\n*Type*: [ManagedScaling](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-managedscaling", "UpdateType": "Mutable", "Required": false, "Type": "ManagedScaling" }, "AutoScalingGroupArn": { "MarkdownDocumentation": "`AutoScalingGroupArn`\n\nThe Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto\nScaling group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-autoscalinggrouparn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ManagedTerminationProtection": { "MarkdownDocumentation": "`ManagedTerminationProtection`\n\nThe managed termination protection setting to use for the Auto Scaling group capacity\nprovider. This determines whether the Auto Scaling group has managed termination\nprotection. The default is off.\n###### Important\nWhen using managed termination protection, managed scaling must also be used\notherwise managed termination protection doesn't work.\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2\ninstances in an Auto Scaling group that contain tasks from being terminated during a\nscale-in action. The Auto Scaling group and each instance in the Auto Scaling group must\nhave instance protection from scale-in actions on as well. For more information, see\n[Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the *AWS Auto Scaling User\nGuide*.\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected\nfrom 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-managedterminationprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManagedDraining": { "MarkdownDocumentation": "`ManagedDraining`\n\nThe managed draining option for the Auto Scaling group capacity provider. When you\nenable this, Amazon ECS manages and gracefully drains the EC2 container instances that\nare in the Auto Scaling group 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider-manageddraining", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::CapacityProvider.BaselineEbsBandwidthMbpsRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.BaselineEbsBandwidthMbpsRequest`\n\nThe minimum and maximum baseline Amazon EBS bandwidth in megabits per second (Mbps)\nfor instance type selection. This is important for workloads with high storage I/O\nrequirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-baselineebsbandwidthmbpsrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum baseline Amazon EBS bandwidth in Mbps. Instance types with lower Amazon\nEBS bandwidth are excluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-baselineebsbandwidthmbpsrequest.html#cfn-ecs-capacityprovider-baselineebsbandwidthmbpsrequest-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum baseline Amazon EBS bandwidth in Mbps. Instance types with higher Amazon\nEBS bandwidth are excluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-baselineebsbandwidthmbpsrequest.html#cfn-ecs-capacityprovider-baselineebsbandwidthmbpsrequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::CapacityProvider.InfrastructureOptimization": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.InfrastructureOptimization`\n\nThe configuration that controls how Amazon ECS optimizes your infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-infrastructureoptimization.html", "Properties": { "ScaleInAfter": { "MarkdownDocumentation": "`ScaleInAfter`\n\nThis parameter defines the number of seconds Amazon ECS Managed Instances waits before optimizing EC2 instances that have become idle or underutilized.\nA longer delay increases the likelihood of placing new tasks on idle or underutilized instances instances, reducing startup time.\nA shorter delay helps reduce infrastructure costs by optimizing idle or underutilized instances,instances more quickly.\nValid values are:\n* `null` - Uses the default optimization behavior.\n* `-1` - Disables automatic infrastructure optimization.\n* A value between `0` and `3600` (inclusive) - Specifies the number of seconds to wait before optimizing instances.\n*Required*: No\n*Type*: Integer\n*Minimum*: `-1`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-infrastructureoptimization.html#cfn-ecs-capacityprovider-infrastructureoptimization-scaleinafter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::CapacityProvider.InstanceLaunchTemplate": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.InstanceLaunchTemplate`\n\nThe launch template configuration for Amazon ECS Managed Instances. This defines how\nAmazon ECS launches Amazon EC2 instances, including the instance profile for your tasks,\nnetwork and storage configuration, capacity options, and instance requirements for\nflexible instance type selection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancelaunchtemplate.html", "Properties": { "Ec2InstanceProfileArn": { "MarkdownDocumentation": "`Ec2InstanceProfileArn`\n\nThe Amazon Resource Name (ARN) of the instance profile that Amazon ECS applies to\nAmazon ECS Managed Instances. This instance profile must include the necessary\npermissions for your tasks to access AWS services and\nresources.\nFor more information, see [Amazon\nECS instance profile for Managed Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/managed-instances-instance-profile.html) in the *Amazon ECS\nDeveloper 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancelaunchtemplate.html#cfn-ecs-capacityprovider-instancelaunchtemplate-ec2instanceprofilearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CapacityOptionType": { "MarkdownDocumentation": "`CapacityOptionType`\n\nThe capacity option type. This determines whether\nAmazon ECS launches On-Demand or Spot Instances for your managed instance\ncapacity provider.\nValid values are:\n* `ON_DEMAND` - Launches standard On-Demand Instances.\n On-Demand Instances provide predictable pricing and availability.\n* `SPOT` - Launches Spot Instances that use spare Amazon EC2 capacity\n at reduced cost. Spot Instances can be interrupted by Amazon EC2 with a two-minute\n notification when the capacity is needed back.\nThe default is On-Demand\nFor more information about Amazon EC2 capacity options, see [Instance purchasing\noptions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `ON_DEMAND | SPOT...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ON_DEMAND", "SPOT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancelaunchtemplate.html#cfn-ecs-capacityprovider-instancelaunchtemplate-capacityoptiontype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "StorageConfiguration": { "MarkdownDocumentation": "`StorageConfiguration`\n\nThe storage configuration for Amazon ECS Managed Instances. This defines the root\nvolume size and type for the instances.\n*Required*: No\n*Type*: [ManagedInstancesStorageConfiguration](./aws-properties-ecs-capacityprovider-managedinstancesstorageconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancelaunchtemplate.html#cfn-ecs-capacityprovider-instancelaunchtemplate-storageconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ManagedInstancesStorageConfiguration" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for Amazon ECS Managed Instances. This specifies the subnets\nand security groups that instances use for network connectivity.\n*Required*: Yes\n*Type*: [ManagedInstancesNetworkConfiguration](./aws-properties-ecs-capacityprovider-managedinstancesnetworkconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancelaunchtemplate.html#cfn-ecs-capacityprovider-instancelaunchtemplate-networkconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ManagedInstancesNetworkConfiguration" }, "InstanceRequirements": { "MarkdownDocumentation": "`InstanceRequirements`\n\nThe instance requirements. You can specify:\n* The instance types\n* Instance requirements such as vCPU count, memory, network performance, and\n accelerator specifications\nAmazon ECS automatically selects the instances that match the specified\ncriteria.\n*Required*: No\n*Type*: [InstanceRequirementsRequest](./aws-properties-ecs-capacityprovider-instancerequirementsrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancelaunchtemplate.html#cfn-ecs-capacityprovider-instancelaunchtemplate-instancerequirements", "UpdateType": "Mutable", "Required": false, "Type": "InstanceRequirementsRequest" }, "Monitoring": { "MarkdownDocumentation": "`Monitoring`\n\nCloudWatch provides two categories of monitoring: basic monitoring and detailed\nmonitoring. By default, your managed instance is configured for basic monitoring. You\ncan optionally enable detailed monitoring to help you more quickly identify and act on\noperational issues. You can enable or turn off detailed monitoring at launch or when the\nmanaged instance is running or stopped. For more information, see [Detailed monitoring for Amazon ECS Managed Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/detailed-monitoring-managed-instances.html) in the Amazon ECS\nDeveloper Guide.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC | DETAILED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "DETAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancelaunchtemplate.html#cfn-ecs-capacityprovider-instancelaunchtemplate-monitoring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::CapacityProvider.InstanceRequirementsRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.InstanceRequirementsRequest`\n\nThe instance requirements for attribute-based instance type selection. Instead of\nspecifying exact instance types, you define requirements such as vCPU count, memory\nsize, network performance, and accelerator specifications. Amazon ECS automatically\nselects Amazon EC2 instance types that match these requirements, providing flexibility\nand helping to mitigate capacity constraints.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html", "Properties": { "LocalStorageTypes": { "MarkdownDocumentation": "`LocalStorageTypes`\n\nThe local storage types to include. You can specify `hdd` for hard disk\ndrives, `ssd` for solid state drives, or both.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `hdd | ssd`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "hdd", "ssd" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-localstoragetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "InstanceGenerations": { "MarkdownDocumentation": "`InstanceGenerations`\n\nThe instance generations to include. You can specify `current` to use the\nlatest generation instances, or `previous` to include previous generation\ninstances for cost optimization.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `current | previous...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "current", "previous" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-instancegenerations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkInterfaceCount": { "MarkdownDocumentation": "`NetworkInterfaceCount`\n\nThe minimum and maximum number of network interfaces for the instance types. This is\nuseful for workloads that require multiple network interfaces.\n*Required*: No\n*Type*: [NetworkInterfaceCountRequest](./aws-properties-ecs-capacityprovider-networkinterfacecountrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-networkinterfacecount", "UpdateType": "Mutable", "Required": false, "Type": "NetworkInterfaceCountRequest" }, "MemoryGiBPerVCpu": { "MarkdownDocumentation": "`MemoryGiBPerVCpu`\n\nThe minimum and maximum amount of memory per vCPU in gibibytes (GiB). This helps\nensure that instance types have the appropriate memory-to-CPU ratio for your\nworkloads.\n*Required*: No\n*Type*: [MemoryGiBPerVCpuRequest](./aws-properties-ecs-capacityprovider-memorygibpervcpurequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-memorygibpervcpu", "UpdateType": "Mutable", "Required": false, "Type": "MemoryGiBPerVCpuRequest" }, "AcceleratorTypes": { "MarkdownDocumentation": "`AcceleratorTypes`\n\nThe accelerator types to include. You can specify `gpu` for graphics\nprocessing units, `fpga` for field programmable gate arrays, or\n`inference` for machine learning inference accelerators.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `gpu | fpga | inference...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "gpu", "fpga", "inference" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-acceleratortypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VCpuCount": { "MarkdownDocumentation": "`VCpuCount`\n\nThe minimum and maximum number of vCPUs for the instance types. Amazon ECS selects\ninstance types that have vCPU counts within this range.\n*Required*: Yes\n*Type*: [VCpuCountRangeRequest](./aws-properties-ecs-capacityprovider-vcpucountrangerequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-vcpucount", "UpdateType": "Mutable", "Required": true, "Type": "VCpuCountRangeRequest" }, "ExcludedInstanceTypes": { "MarkdownDocumentation": "`ExcludedInstanceTypes`\n\nThe instance types to exclude from selection. Use this to prevent Amazon ECS from\nselecting specific instance types that may not be suitable for your workloads.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-excludedinstancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AcceleratorManufacturers": { "MarkdownDocumentation": "`AcceleratorManufacturers`\n\nThe accelerator manufacturers to include. You can specify `nvidia`,\n`amd`, `amazon-web-services`, or `xilinx` depending\non your accelerator requirements.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `amazon-web-services | amd |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "amazon-web-services", "amd", "habana", "nvidia", "xilinx" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-acceleratormanufacturers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedInstanceTypes": { "MarkdownDocumentation": "`AllowedInstanceTypes`\n\nThe instance types to include in the selection. When specified, Amazon ECS only\nconsiders these instance types, subject to the other requirements specified.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-allowedinstancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LocalStorage": { "MarkdownDocumentation": "`LocalStorage`\n\nIndicates whether to include instance types with local storage. Set to\n`included` to allow local storage, `excluded` to exclude it,\nor `required` to use only instances with local storage.\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-localstorage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CpuManufacturers": { "MarkdownDocumentation": "`CpuManufacturers`\n\nThe CPU manufacturers to include or exclude. You can specify `intel`,\n`amd`, or `amazon-web-services` to control which CPU types are\nused for your workloads.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `intel | amd | amazon-web-se...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "intel", "amd", "amazon-web-services" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-cpumanufacturers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkBandwidthGbps": { "MarkdownDocumentation": "`NetworkBandwidthGbps`\n\nThe minimum and maximum network bandwidth in gigabits per second (Gbps). This is\ncrucial for network-intensive workloads that require high throughput.\n*Required*: No\n*Type*: [NetworkBandwidthGbpsRequest](./aws-properties-ecs-capacityprovider-networkbandwidthgbpsrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-networkbandwidthgbps", "UpdateType": "Mutable", "Required": false, "Type": "NetworkBandwidthGbpsRequest" }, "AcceleratorCount": { "MarkdownDocumentation": "`AcceleratorCount`\n\nThe minimum and maximum number of accelerators for the instance types. This is used\nwhen you need instances with specific numbers of GPUs or other accelerators.\n*Required*: No\n*Type*: [AcceleratorCountRequest](./aws-properties-ecs-capacityprovider-acceleratorcountrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-acceleratorcount", "UpdateType": "Mutable", "Required": false, "Type": "AcceleratorCountRequest" }, "BareMetal": { "MarkdownDocumentation": "`BareMetal`\n\nIndicates whether to include bare metal instance types. Set to `included`\nto allow bare metal instances, `excluded` to exclude them, or\n`required` to use only bare metal instances.\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-baremetal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequireHibernateSupport": { "MarkdownDocumentation": "`RequireHibernateSupport`\n\nIndicates whether the instance types must support hibernation. When set to\n`true`, only instance types that support hibernation are selected.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-requirehibernatesupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "MarkdownDocumentation": "`MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`\n\nThe maximum price for Spot instances as a percentage of the optimal On-Demand price.\nThis provides more precise cost control for Spot instance selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-maxspotpriceaspercentageofoptimalondemandprice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SpotMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`SpotMaxPricePercentageOverLowestPrice`\n\nThe maximum price for Spot instances as a percentage over the lowest priced On-Demand\ninstance. This helps control Spot instance costs while maintaining access to\ncapacity.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-spotmaxpricepercentageoverlowestprice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "BaselineEbsBandwidthMbps": { "MarkdownDocumentation": "`BaselineEbsBandwidthMbps`\n\nThe minimum and maximum baseline Amazon EBS bandwidth in megabits per second (Mbps).\nThis is important for workloads with high storage I/O requirements.\n*Required*: No\n*Type*: [BaselineEbsBandwidthMbpsRequest](./aws-properties-ecs-capacityprovider-baselineebsbandwidthmbpsrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-baselineebsbandwidthmbps", "UpdateType": "Mutable", "Required": false, "Type": "BaselineEbsBandwidthMbpsRequest" }, "OnDemandMaxPricePercentageOverLowestPrice": { "MarkdownDocumentation": "`OnDemandMaxPricePercentageOverLowestPrice`\n\nThe price protection threshold for On-Demand Instances, as a percentage higher than an\nidentified On-Demand price. The identified On-Demand price is the price of the lowest\npriced current generation C, M, or R instance type with your specified attributes. If no\ncurrent generation C, M, or R instance type matches your attributes, then the identified\nprice is from either the lowest priced current generation instance types or, failing\nthat, the lowest priced previous generation instance types that match your attributes.\nWhen Amazon ECS selects instance types with your attributes, we will exclude instance\ntypes whose price exceeds your specified threshold.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-ondemandmaxpricepercentageoverlowestprice", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AcceleratorNames": { "MarkdownDocumentation": "`AcceleratorNames`\n\nThe specific accelerator names to include. For example, you can specify\n`a100`, `v100`, `k80`, or other specific\naccelerator models.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `a10g | a100 | h100 | infere...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "a10g", "a100", "h100", "inferentia", "k520", "k80", "m60", "radeon-pro-v520", "t4", "t4g", "vu9p", "v100", "l40s" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-acceleratornames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AcceleratorTotalMemoryMiB": { "MarkdownDocumentation": "`AcceleratorTotalMemoryMiB`\n\nThe minimum and maximum total accelerator memory in mebibytes (MiB). This is important\nfor GPU workloads that require specific amounts of video memory.\n*Required*: No\n*Type*: [AcceleratorTotalMemoryMiBRequest](./aws-properties-ecs-capacityprovider-acceleratortotalmemorymibrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-acceleratortotalmemorymib", "UpdateType": "Mutable", "Required": false, "Type": "AcceleratorTotalMemoryMiBRequest" }, "BurstablePerformance": { "MarkdownDocumentation": "`BurstablePerformance`\n\nIndicates whether to include burstable performance instance types (T2, T3, T3a, T4g).\nSet to `included` to allow burstable instances, `excluded` to\nexclude them, or `required` to use only burstable instances.\n*Required*: No\n*Type*: String\n*Allowed values*: `included | required | exclu...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "included", "required", "excluded" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-burstableperformance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MemoryMiB": { "MarkdownDocumentation": "`MemoryMiB`\n\nThe minimum and maximum amount of memory in mebibytes (MiB) for the instance types.\nAmazon ECS selects instance types that have memory within this range.\n*Required*: Yes\n*Type*: [MemoryMiBRequest](./aws-properties-ecs-capacityprovider-memorymibrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-memorymib", "UpdateType": "Mutable", "Required": true, "Type": "MemoryMiBRequest" }, "TotalLocalStorageGB": { "MarkdownDocumentation": "`TotalLocalStorageGB`\n\nThe minimum and maximum total local storage in gigabytes (GB) for instance types with\nlocal storage.\n*Required*: No\n*Type*: [TotalLocalStorageGBRequest](./aws-properties-ecs-capacityprovider-totallocalstoragegbrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-totallocalstoragegb", "UpdateType": "Mutable", "Required": false, "Type": "TotalLocalStorageGBRequest" } } }, "AWS::ECS::CapacityProvider.ManagedInstancesNetworkConfiguration": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.ManagedInstancesNetworkConfiguration`\n\nThe network configuration for Amazon ECS Managed Instances. This specifies the VPC\nsubnets and security groups that instances use for network connectivity. Amazon ECS\nManaged Instances support multiple network modes including `awsvpc`\n(instances receive ENIs for task isolation), `host` (instances share network\nnamespace with tasks), and `none` (no external network connectivity),\nensuring backward compatibility for migrating workloads from Fargate or Amazon\nEC2.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesnetworkconfiguration.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe list of security group IDs to apply to Amazon ECS Managed Instances. These\nsecurity groups control the network traffic allowed to and from the instances.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesnetworkconfiguration.html#cfn-ecs-capacityprovider-managedinstancesnetworkconfiguration-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe list of subnet IDs where Amazon ECS can launch Amazon ECS Managed Instances.\nInstances are distributed across the specified subnets for high availability. All\nsubnets must be in the same VPC.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesnetworkconfiguration.html#cfn-ecs-capacityprovider-managedinstancesnetworkconfiguration-subnets", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ECS::CapacityProvider.ManagedInstancesProvider": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.ManagedInstancesProvider`\n\nThe configuration for a Amazon ECS Managed Instances provider. Amazon ECS uses this\nconfiguration to automatically launch, manage, and terminate Amazon EC2 instances on\nyour behalf. Managed instances provide access to the full range of Amazon EC2 instance\ntypes and features while offloading infrastructure management to AWS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesprovider.html", "Properties": { "InfrastructureRoleArn": { "MarkdownDocumentation": "`InfrastructureRoleArn`\n\nThe Amazon Resource Name (ARN) of the infrastructure role that Amazon ECS assumes to\nmanage instances. This role must include permissions for Amazon EC2 instance lifecycle\nmanagement, networking, and any additional AWS services required for your\nworkloads.\nFor more information, see [Amazon ECS\ninfrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer\nGuide*.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesprovider.html#cfn-ecs-capacityprovider-managedinstancesprovider-infrastructurerolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PropagateTags": { "MarkdownDocumentation": "`PropagateTags`\n\nDetermines whether tags from the capacity provider are automatically applied to Amazon\nECS Managed Instances. This helps with cost allocation and resource management by\nensuring consistent tagging across your infrastructure.\n*Required*: No\n*Type*: String\n*Allowed values*: `CAPACITY_PROVIDER | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CAPACITY_PROVIDER", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesprovider.html#cfn-ecs-capacityprovider-managedinstancesprovider-propagatetags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InfrastructureOptimization": { "MarkdownDocumentation": "`InfrastructureOptimization`\n\nDefines how Amazon ECS Managed Instances optimizes the infrastastructure in your capacity provider.\nConfigure it to turn on or off the infrastructure optimization in your capacity provider, and to control the idle or underutilized EC2 instances optimization delay.\n*Required*: No\n*Type*: [InfrastructureOptimization](./aws-properties-ecs-capacityprovider-infrastructureoptimization.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesprovider.html#cfn-ecs-capacityprovider-managedinstancesprovider-infrastructureoptimization", "UpdateType": "Mutable", "Required": false, "Type": "InfrastructureOptimization" }, "InstanceLaunchTemplate": { "MarkdownDocumentation": "`InstanceLaunchTemplate`\n\nThe launch template that defines how Amazon ECS launches Amazon ECS Managed Instances.\nThis includes the instance profile for your tasks, network and storage configuration,\nand instance requirements that determine which Amazon EC2 instance types can be\nused.\nFor more information, see [Store instance launch\nparameters in Amazon EC2 launch templates](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User\nGuide*.\n*Required*: Yes\n*Type*: [InstanceLaunchTemplate](./aws-properties-ecs-capacityprovider-instancelaunchtemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesprovider.html#cfn-ecs-capacityprovider-managedinstancesprovider-instancelaunchtemplate", "UpdateType": "Mutable", "Required": true, "Type": "InstanceLaunchTemplate" } } }, "AWS::ECS::CapacityProvider.ManagedInstancesStorageConfiguration": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.ManagedInstancesStorageConfiguration`\n\nThe storage configuration for Amazon ECS Managed Instances. This defines the root\nvolume configuration for the instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesstorageconfiguration.html", "Properties": { "StorageSizeGiB": { "MarkdownDocumentation": "`StorageSizeGiB`\n\nThe size of the tasks volume.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedinstancesstorageconfiguration.html#cfn-ecs-capacityprovider-managedinstancesstorageconfiguration-storagesizegib", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ECS::CapacityProvider.ManagedScaling": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.ManagedScaling`\n\nThe managed scaling settings for the Auto Scaling group capacity provider.\nWhen managed scaling is turned on, Amazon ECS manages the scale-in and scale-out\nactions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy\nusing an Amazon ECS managed CloudWatch metric with the specified\n`targetCapacity` value as the target value for the metric. For more\ninformation, see [Using managed scaling](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling) in the *Amazon Elastic Container Service\nDeveloper Guide*.\nIf managed scaling is off, the user must manage the scaling of the Auto Scaling\ngroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nDetermines 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinimumScalingStepSize": { "MarkdownDocumentation": "`MinimumScalingStepSize`\n\nThe minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time.\nThe scale in process is not affected by this parameter If this parameter is omitted, the\ndefault value of `1` is used.\nWhen additional capacity is required, Amazon ECS will scale up the minimum scaling\nstep size even if the actual demand is less than the minimum scaling step size.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-minimumscalingstepsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "InstanceWarmupPeriod": { "MarkdownDocumentation": "`InstanceWarmupPeriod`\n\nThe period of time, in seconds, after a newly launched Amazon EC2 instance can\ncontribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted,\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-instancewarmupperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetCapacity": { "MarkdownDocumentation": "`TargetCapacity`\n\nThe target capacity utilization as a percentage for the capacity provider. The\nspecified value must be greater than `0` and less than or equal to\n`100`. For example, if you want the capacity provider to maintain 10%\nspare capacity, then that means the utilization is 90%, so use a\n`targetCapacity` of `90`. The default value of\n`100` percent results in the Amazon EC2 instances in your Auto Scaling\ngroup 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-targetcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumScalingStepSize": { "MarkdownDocumentation": "`MaximumScalingStepSize`\n\nThe maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html#cfn-ecs-capacityprovider-managedscaling-maximumscalingstepsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::CapacityProvider.MemoryGiBPerVCpuRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.MemoryGiBPerVCpuRequest`\n\nThe minimum and maximum amount of memory per vCPU in gibibytes (GiB). This helps\nensure that instance types have the appropriate memory-to-CPU ratio for your\nworkloads.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-memorygibpervcpurequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory per vCPU in GiB. Instance types with a lower\nmemory-to-vCPU ratio are excluded from selection.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-memorygibpervcpurequest.html#cfn-ecs-capacityprovider-memorygibpervcpurequest-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory per vCPU in GiB. Instance types with a higher\nmemory-to-vCPU ratio are excluded from selection.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-memorygibpervcpurequest.html#cfn-ecs-capacityprovider-memorygibpervcpurequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ECS::CapacityProvider.MemoryMiBRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.MemoryMiBRequest`\n\nThe minimum and maximum amount of memory in mebibytes (MiB) for instance type\nselection. This ensures that selected instance types have adequate memory for your\nworkloads.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-memorymibrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum amount of memory in MiB. Instance types with less memory than this value\nare excluded from selection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-memorymibrequest.html#cfn-ecs-capacityprovider-memorymibrequest-min", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum amount of memory in MiB. Instance types with more memory than this value\nare excluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-memorymibrequest.html#cfn-ecs-capacityprovider-memorymibrequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::CapacityProvider.NetworkBandwidthGbpsRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.NetworkBandwidthGbpsRequest`\n\nThe minimum and maximum network bandwidth in gigabits per second (Gbps) for instance\ntype selection. This is important for network-intensive workloads.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-networkbandwidthgbpsrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum network bandwidth in Gbps. Instance types with lower network bandwidth are\nexcluded from selection.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-networkbandwidthgbpsrequest.html#cfn-ecs-capacityprovider-networkbandwidthgbpsrequest-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum network bandwidth in Gbps. Instance types with higher network bandwidth\nare excluded from selection.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-networkbandwidthgbpsrequest.html#cfn-ecs-capacityprovider-networkbandwidthgbpsrequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ECS::CapacityProvider.NetworkInterfaceCountRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.NetworkInterfaceCountRequest`\n\nThe minimum and maximum number of network interfaces for instance type selection. This\nis useful for workloads that require multiple network interfaces.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-networkinterfacecountrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of network interfaces. Instance types that support fewer network\ninterfaces are excluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-networkinterfacecountrequest.html#cfn-ecs-capacityprovider-networkinterfacecountrequest-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of network interfaces. Instance types that support more network\ninterfaces are excluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-networkinterfacecountrequest.html#cfn-ecs-capacityprovider-networkinterfacecountrequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::CapacityProvider.TotalLocalStorageGBRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.TotalLocalStorageGBRequest`\n\nThe minimum and maximum total local storage in gigabytes (GB) for instance types with\nlocal storage. This is useful for workloads that require local storage for temporary\ndata or caching.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-totallocalstoragegbrequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum total local storage in GB. Instance types with less local storage are\nexcluded from selection.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-totallocalstoragegbrequest.html#cfn-ecs-capacityprovider-totallocalstoragegbrequest-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum total local storage in GB. Instance types with more local storage are\nexcluded from selection.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-totallocalstoragegbrequest.html#cfn-ecs-capacityprovider-totallocalstoragegbrequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ECS::CapacityProvider.VCpuCountRangeRequest": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider.VCpuCountRangeRequest`\n\nThe minimum and maximum number of vCPUs for instance type selection. This allows you\nto specify a range of vCPU counts that meet your workload requirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-vcpucountrangerequest.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum number of vCPUs. Instance types with fewer vCPUs than this value are\nexcluded from selection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-vcpucountrangerequest.html#cfn-ecs-capacityprovider-vcpucountrangerequest-min", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum number of vCPUs. Instance types with more vCPUs than this value are\nexcluded from selection.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-vcpucountrangerequest.html#cfn-ecs-capacityprovider-vcpucountrangerequest-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::Cluster.CapacityProviderStrategyItem": { "MarkdownDocumentation": "`AWS::ECS::Cluster.CapacityProviderStrategyItem`\n\nThe `CapacityProviderStrategyItem` property specifies the details of the\ndefault capacity provider strategy for the cluster. When services or tasks are run in the\ncluster with no launch type or capacity provider strategy specified, the default capacity\nprovider strategy is used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html", "Properties": { "CapacityProvider": { "MarkdownDocumentation": "`CapacityProvider`\n\nThe short name of the capacity provider. This can be either an AWS managed capacity provider (`FARGATE` or `FARGATE_SPOT`) or the name of a custom capacity provider that you 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-capacityprovider", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe *weight* value designates the relative percentage of the total\nnumber of tasks launched that should use the specified capacity provider. The\n`weight` value is taken into consideration after the `base`\nvalue, if defined, is satisfied.\nIf no `weight` value is specified, the default value of `0` is\nused. When multiple capacity providers are specified within a capacity provider\nstrategy, at least one of the capacity providers must have a weight value greater than\nzero and any capacity providers with a weight of `0` can't be used to place\ntasks. If you specify multiple capacity providers in a strategy that all have a weight\nof `0`, any `RunTask` or `CreateService` actions using\nthe capacity provider strategy will fail.\nWeight value characteristics:\n* Weight is considered after the base value is satisfied\n* The default value is `0` if not specified\n* The valid range is 0 to 1,000\n* At least one capacity provider must have a weight greater than zero\n* Capacity providers with weight of `0` cannot place tasks\nTask distribution logic:\n1. Base satisfaction: The minimum number of tasks specified by the base value are\n placed on that capacity provider\n2. Weight distribution: After base requirements are met, additional tasks are\n distributed according to weight ratios\nExamples:\nEqual Distribution: Two capacity providers both with weight `1` will split\ntasks evenly after base requirements are met.\nWeighted Distribution: If capacityProviderA has weight `1` and\ncapacityProviderB has weight `4`, then for every 1 task on A, 4 tasks will\nrun on B.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Base": { "MarkdownDocumentation": "`Base`\n\nThe *base* value designates how many tasks, at a minimum, to run on\nthe specified capacity provider for each service. Only one capacity provider in a\ncapacity provider strategy can have a *base* defined. If no value is\nspecified, the default value of `0` is used.\nBase value characteristics:\n* Only one capacity provider in a strategy can have a base defined\n* The default value is `0` if not specified\n* The valid range is 0 to 100,000\n* Base requirements are satisfied first before weight distribution\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::Cluster.ClusterConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Cluster.ClusterConfiguration`\n\nThe execute command and managed storage configuration for the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html", "Properties": { "ManagedStorageConfiguration": { "MarkdownDocumentation": "`ManagedStorageConfiguration`\n\nThe details of the managed storage configuration.\n*Required*: No\n*Type*: [ManagedStorageConfiguration](./aws-properties-ecs-cluster-managedstorageconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html#cfn-ecs-cluster-clusterconfiguration-managedstorageconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ManagedStorageConfiguration" }, "ExecuteCommandConfiguration": { "MarkdownDocumentation": "`ExecuteCommandConfiguration`\n\nThe details of the execute command configuration.\n*Required*: No\n*Type*: [ExecuteCommandConfiguration](./aws-properties-ecs-cluster-executecommandconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html#cfn-ecs-cluster-clusterconfiguration-executecommandconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExecuteCommandConfiguration" } } }, "AWS::ECS::Cluster.ClusterSettings": { "MarkdownDocumentation": "`AWS::ECS::Cluster.ClusterSettings`\n\nThe settings to use when creating a cluster. This parameter is used to turn on\nCloudWatch Container Insights with enhanced observability or CloudWatch Container\nInsights for a cluster.\nContainer Insights with enhanced observability provides all the Container Insights\nmetrics, plus additional task and container metrics. This version supports enhanced\nobservability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types.\nAfter you configure Container Insights with enhanced observability on Amazon ECS,\nContainer Insights auto-collects detailed infrastructure telemetry from the cluster\nlevel down to the container level in your environment and displays these critical\nperformance data in curated dashboards removing the heavy lifting in observability\nset-up.\nFor more information, see [Monitor\nAmazon ECS containers using Container Insights with enhanced observability](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to set for the cluster setting. The supported values are\n`enhanced`, `enabled`, and `disabled`.\nTo use Container Insights with enhanced observability, set the\n`containerInsights` account setting to `enhanced`.\nTo use Container Insights, set the `containerInsights` account setting to\n`enabled`.\nIf a cluster value is specified, it will override the `containerInsights`\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the cluster setting. The 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)", "RefReturnValue": "", "AllowedValues": [ "containerInsights" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Cluster.ExecuteCommandConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Cluster.ExecuteCommandConfiguration`\n\nThe details of the execute command configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html", "Properties": { "Logging": { "MarkdownDocumentation": "`Logging`\n\nThe log setting to use for redirecting logs for your execute command results. The\nfollowing log settings are available.\n* `NONE`: The execute command session is not logged.\n* `DEFAULT`: The `awslogs` configuration in the task\n definition is used. If no logging parameter is specified, it defaults to this\n value. If no `awslogs` log driver is configured in the task\n definition, the output won't be logged.\n* `OVERRIDE`: Specify the logging details as a part of\n `logConfiguration`. If the `OVERRIDE` logging option\n is specified, the `logConfiguration` is required.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | DEFAULT | OVERRIDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "DEFAULT", "OVERRIDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logging", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nSpecify an AWS Key Management Service key ID to encrypt the data between the local client and\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe log configuration for the results of the execute command actions. The logs can be\nsent to CloudWatch Logs or an Amazon S3 bucket. When `logging=OVERRIDE` is\nspecified, a `logConfiguration` must be provided.\n*Required*: No\n*Type*: [ExecuteCommandLogConfiguration](./aws-properties-ecs-cluster-executecommandlogconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExecuteCommandLogConfiguration" } } }, "AWS::ECS::Cluster.ExecuteCommandLogConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Cluster.ExecuteCommandLogConfiguration`\n\nThe log configuration for the results of the execute command actions. The logs can be\nsent to CloudWatch Logs or an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html", "Properties": { "S3EncryptionEnabled": { "MarkdownDocumentation": "`S3EncryptionEnabled`\n\nDetermines whether to use encryption on the S3 logs. If not specified, encryption is\nnot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3encryptionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CloudWatchEncryptionEnabled": { "MarkdownDocumentation": "`CloudWatchEncryptionEnabled`\n\nDetermines whether to use encryption on the CloudWatch logs. If not specified,\nencryption 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-cloudwatchencryptionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CloudWatchLogGroupName": { "MarkdownDocumentation": "`CloudWatchLogGroupName`\n\nThe name of the CloudWatch log group to send logs to.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-cloudwatchloggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3KeyPrefix": { "MarkdownDocumentation": "`S3KeyPrefix`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nThe name of the S3 bucket to send logs to.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Cluster.ManagedStorageConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Cluster.ManagedStorageConfiguration`\n\nThe managed storage configuration for the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-managedstorageconfiguration.html", "Properties": { "FargateEphemeralStorageKmsKeyId": { "MarkdownDocumentation": "`FargateEphemeralStorageKmsKeyId`\n\nSpecify the AWS Key Management Service key ID for Fargate ephemeral storage.\nWhen you specify a `fargateEphemeralStorageKmsKeyId`, AWS\nFargate uses the key to encrypt data at rest in ephemeral storage. For more information\nabout Fargate ephemeral storage encryption, see [Customer managed keys for AWS Fargate ephemeral\nstorage for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-storage-encryption.html) in the *Amazon Elastic Container Service\nDeveloper Guide*.\nThe key must be a single Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-managedstorageconfiguration.html#cfn-ecs-cluster-managedstorageconfiguration-fargateephemeralstoragekmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nSpecify a AWS Key Management Service key ID to encrypt Amazon ECS managed storage.\nWhen you specify a `kmsKeyId`, Amazon ECS uses the key to encrypt data\nvolumes managed by Amazon ECS that are attached to tasks in the cluster. The following\ndata volumes are managed by Amazon ECS: Amazon EBS. For more information about\nencryption of Amazon EBS volumes attached to Amazon ECS tasks, see [Encrypt data stored in Amazon EBS volumes for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html) in the\n*Amazon Elastic Container Service Developer Guide*.\nThe key must be a single Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-managedstorageconfiguration.html#cfn-ecs-cluster-managedstorageconfiguration-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Cluster.ServiceConnectDefaults": { "MarkdownDocumentation": "`AWS::ECS::Cluster.ServiceConnectDefaults`\n\nUse this parameter to set a default Service Connect namespace. After you set a default\nService Connect namespace, any new services with Service Connect turned on that are\ncreated in the cluster are added as client services in the namespace. This setting only\napplies to new services that set the `enabled` parameter to `true`\nin the `ServiceConnectConfiguration`. You can set the namespace of each\nservice individually in the `ServiceConnectConfiguration` to override this\ndefault parameter.\nTasks that run in a namespace can use short names to connect to services in the\nnamespace. Tasks can connect to services across all of the clusters in the namespace.\nTasks connect through a managed proxy container that collects logs and metrics for\nincreased visibility. Only the tasks that Amazon ECS services create are supported with\nService Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-serviceconnectdefaults.html", "Properties": { "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace that's\nused when you create a service and don't specify a Service Connect configuration. The\nnamespace name can include up to 1024 characters. The name is case-sensitive. The name\ncan't include greater than (>), less than (<), double quotation marks (\"), or\nslash (/).\nIf you enter an existing namespace name or ARN, then that namespace will be used. Any\nnamespace type is supported. The namespace must be in this account and this AWS\nRegion.\nIf you enter a new name, a AWS Cloud Map namespace will be created. Amazon ECS creates a AWS Cloud Map namespace\nwith the \"API calls\" method of instance discovery only. This instance discovery method\nis the \"HTTP\" namespace type in the AWS Command Line Interface. Other types of\ninstance discovery aren't used by Service Connect.\nIf you update the cluster with an empty string `\"\"` for the namespace name,\nthe cluster configuration for Service Connect is removed. Note that the namespace will\nremain 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/cloud-map/latest/dg/working-with-services.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-serviceconnectdefaults.html#cfn-ecs-cluster-serviceconnectdefaults-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::ClusterCapacityProviderAssociations.CapacityProviderStrategy": { "MarkdownDocumentation": "`AWS::ECS::ClusterCapacityProviderAssociations.CapacityProviderStrategy`\n\nThe `CapacityProviderStrategy` property specifies the details of the default\ncapacity provider strategy for the cluster. When services or tasks are run in the cluster\nwith no launch type or capacity provider strategy specified, the default capacity provider\nstrategy is used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html", "Properties": { "CapacityProvider": { "MarkdownDocumentation": "`CapacityProvider`\n\nThe short name of the capacity provider. This can be either an AWS managed capacity provider (`FARGATE` or `FARGATE_SPOT`) or the name of a custom capacity provider that you created.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FARGATE | FARGATE_SPOT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FARGATE", "FARGATE_SPOT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-capacityprovider", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Base": { "MarkdownDocumentation": "`Base`\n\nThe *base* value designates how many tasks, at a minimum, to run on\nthe specified capacity provider for each service. Only one capacity provider in a\ncapacity provider strategy can have a *base* defined. If no value is\nspecified, the default value of `0` is used.\nBase value characteristics:\n* Only one capacity provider in a strategy can have a base defined\n* The default value is `0` if not specified\n* The valid range is 0 to 100,000\n* Base requirements are satisfied first before weight distribution\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe *weight* value designates the relative percentage of the total\nnumber of tasks launched that should use the specified capacity provider. The\n`weight` value is taken into consideration after the `base`\nvalue, if defined, is satisfied.\nIf no `weight` value is specified, the default value of `0` is\nused. When multiple capacity providers are specified within a capacity provider\nstrategy, at least one of the capacity providers must have a weight value greater than\nzero and any capacity providers with a weight of `0` can't be used to place\ntasks. If you specify multiple capacity providers in a strategy that all have a weight\nof `0`, any `RunTask` or `CreateService` actions using\nthe capacity provider strategy will fail.\nWeight value characteristics:\n* Weight is considered after the base value is satisfied\n* The default value is `0` if not specified\n* The valid range is 0 to 1,000\n* At least one capacity provider must have a weight greater than zero\n* Capacity providers with weight of `0` cannot place tasks\nTask distribution logic:\n1. Base satisfaction: The minimum number of tasks specified by the base value are\n placed on that capacity provider\n2. Weight distribution: After base requirements are met, additional tasks are\n distributed according to weight ratios\nExamples:\nEqual Distribution: Two capacity providers both with weight `1` will split\ntasks evenly after base requirements are met.\nWeighted Distribution: If capacityProviderA has weight `1` and\ncapacityProviderB has weight `4`, then for every 1 task on A, 4 tasks will\nrun on B.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::ExpressGatewayService.AutoScalingArns": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.AutoScalingArns`\n\nThe `AutoScalingArns` property type specifies Property description not available. for an [AWS::ECS::ExpressGatewayService](./aws-resource-ecs-expressgatewayservice.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-autoscalingarns.html", "Properties": { "ScalableTarget": { "MarkdownDocumentation": "`ScalableTarget`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-autoscalingarns.html#cfn-ecs-expressgatewayservice-autoscalingarns-scalabletarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationAutoScalingPolicies": { "MarkdownDocumentation": "`ApplicationAutoScalingPolicies`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-autoscalingarns.html#cfn-ecs-expressgatewayservice-autoscalingarns-applicationautoscalingpolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ECS::ExpressGatewayService.ECSManagedResourceArns": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.ECSManagedResourceArns`\n\nThe `ECSManagedResourceArns` property type specifies Property description not available. for an [AWS::ECS::ExpressGatewayService](./aws-resource-ecs-expressgatewayservice.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ecsmanagedresourcearns.html", "Properties": { "LogGroups": { "MarkdownDocumentation": "`LogGroups`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ecsmanagedresourcearns.html#cfn-ecs-expressgatewayservice-ecsmanagedresourcearns-loggroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ServiceSecurityGroups": { "MarkdownDocumentation": "`ServiceSecurityGroups`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ecsmanagedresourcearns.html#cfn-ecs-expressgatewayservice-ecsmanagedresourcearns-servicesecuritygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MetricAlarms": { "MarkdownDocumentation": "`MetricAlarms`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ecsmanagedresourcearns.html#cfn-ecs-expressgatewayservice-ecsmanagedresourcearns-metricalarms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IngressPath": { "MarkdownDocumentation": "`IngressPath`\n\nProperty description not available.\n*Required*: No\n*Type*: [IngressPathArns](./aws-properties-ecs-expressgatewayservice-ingresspatharns.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ecsmanagedresourcearns.html#cfn-ecs-expressgatewayservice-ecsmanagedresourcearns-ingresspath", "UpdateType": "Mutable", "Required": false, "Type": "IngressPathArns" }, "AutoScaling": { "MarkdownDocumentation": "`AutoScaling`\n\nProperty description not available.\n*Required*: No\n*Type*: [AutoScalingArns](./aws-properties-ecs-expressgatewayservice-autoscalingarns.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ecsmanagedresourcearns.html#cfn-ecs-expressgatewayservice-ecsmanagedresourcearns-autoscaling", "UpdateType": "Mutable", "Required": false, "Type": "AutoScalingArns" } } }, "AWS::ECS::ExpressGatewayService.ExpressGatewayContainer": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.ExpressGatewayContainer`\n\nDefines the configuration for the primary container in an Express service. This container\nreceives traffic from the Application Load Balancer and runs your application code.\nThe container configuration includes the container image, port mapping, logging\nsettings, environment variables, and secrets. The container image is the only required\nparameter, with sensible defaults provided for other settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html", "Properties": { "RepositoryCredentials": { "MarkdownDocumentation": "`RepositoryCredentials`\n\nThe configuration for repository credentials for private registry authentication.\n*Required*: No\n*Type*: [ExpressGatewayRepositoryCredentials](./aws-properties-ecs-expressgatewayservice-expressgatewayrepositorycredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-repositorycredentials", "UpdateType": "Mutable", "Required": false, "Type": "ExpressGatewayRepositoryCredentials" }, "Secrets": { "MarkdownDocumentation": "`Secrets`\n\nThe secrets to pass to the container.\n*Required*: No\n*Type*: Array of [Secret](./aws-properties-ecs-expressgatewayservice-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-secrets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Secret", "DuplicatesAllowed": true }, "Command": { "MarkdownDocumentation": "`Command`\n\nThe command that is passed to the container.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-command", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AwsLogsConfiguration": { "MarkdownDocumentation": "`AwsLogsConfiguration`\n\nThe log configuration for the container.\n*Required*: No\n*Type*: [ExpressGatewayServiceAwsLogsConfiguration](./aws-properties-ecs-expressgatewayservice-expressgatewayserviceawslogsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-awslogsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExpressGatewayServiceAwsLogsConfiguration" }, "ContainerPort": { "MarkdownDocumentation": "`ContainerPort`\n\nThe port number on the container that receives traffic from the load balancer. Default\nis 80.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-containerport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nThe environment variables to pass to the container.\n*Required*: No\n*Type*: Array of [KeyValuePair](./aws-properties-ecs-expressgatewayservice-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-environment", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KeyValuePair", "DuplicatesAllowed": true }, "Image": { "MarkdownDocumentation": "`Image`\n\nThe image used to start a container. This string is passed directly to the Docker\ndaemon. Images in the Docker Hub registry are available by default. Other repositories are\nspecified with either `repository-url/image:tag` or\n`repository-url/image@digest`.\nFor Express services, the image typically contains a web application that listens on the\nspecified container port. The image can be stored in Amazon ECR, Docker Hub, or any other\ncontainer registry accessible to your execution role.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-image", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::ExpressGatewayService.ExpressGatewayRepositoryCredentials": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.ExpressGatewayRepositoryCredentials`\n\nThe repository credentials for private registry authentication to pass to the container.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayrepositorycredentials.html", "Properties": { "CredentialsParameter": { "MarkdownDocumentation": "`CredentialsParameter`\n\nThe Amazon Resource Name (ARN) of the secret containing the private repository 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayrepositorycredentials.html#cfn-ecs-expressgatewayservice-expressgatewayrepositorycredentials-credentialsparameter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::ExpressGatewayService.ExpressGatewayScalingTarget": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.ExpressGatewayScalingTarget`\n\nDefines the auto-scaling configuration for an Express service. This determines how the\nservice automatically adjusts the number of running tasks based on demand metrics such as\nCPU utilization, memory utilization, or request count per target.\nAuto-scaling helps ensure your application can handle varying levels of traffic while\noptimizing costs by scaling down during low-demand periods. You can specify the minimum and\nmaximum number of tasks, the scaling metric, and the target value for that metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayscalingtarget.html", "Properties": { "MinTaskCount": { "MarkdownDocumentation": "`MinTaskCount`\n\nThe minimum number of tasks to run in the Express 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayscalingtarget.html#cfn-ecs-expressgatewayservice-expressgatewayscalingtarget-mintaskcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxTaskCount": { "MarkdownDocumentation": "`MaxTaskCount`\n\nThe maximum number of tasks to run in the Express 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayscalingtarget.html#cfn-ecs-expressgatewayservice-expressgatewayscalingtarget-maxtaskcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AutoScalingMetric": { "MarkdownDocumentation": "`AutoScalingMetric`\n\nThe metric used for auto-scaling decisions. The default metric used for an Express service is `CPUUtilization`.\n*Required*: No\n*Type*: String\n*Allowed values*: `AVERAGE_CPU | AVERAGE_MEMOR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AVERAGE_CPU", "AVERAGE_MEMORY", "REQUEST_COUNT_PER_TARGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayscalingtarget.html#cfn-ecs-expressgatewayservice-expressgatewayscalingtarget-autoscalingmetric", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoScalingTargetValue": { "MarkdownDocumentation": "`AutoScalingTargetValue`\n\nThe target value for the auto-scaling metric. The default value for an Express service 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayscalingtarget.html#cfn-ecs-expressgatewayservice-expressgatewayscalingtarget-autoscalingtargetvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::ExpressGatewayService.ExpressGatewayServiceAwsLogsConfiguration": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.ExpressGatewayServiceAwsLogsConfiguration`\n\nSpecifies the Amazon CloudWatch Logs configuration for the Express service\ncontainer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceawslogsconfiguration.html", "Properties": { "LogStreamPrefix": { "MarkdownDocumentation": "`LogStreamPrefix`\n\nThe prefix for the CloudWatch Logs log stream names. The default for an Express service is `ecs`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceawslogsconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceawslogsconfiguration-logstreamprefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogGroup": { "MarkdownDocumentation": "`LogGroup`\n\nThe name of the CloudWatch Logs log group to send container logs 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceawslogsconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceawslogsconfiguration-loggroup", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::ExpressGatewayService.ExpressGatewayServiceConfiguration": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.ExpressGatewayServiceConfiguration`\n\nRepresents a specific configuration revision of an Express service, containing all the\nsettings and parameters for that revision.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html", "Properties": { "ServiceRevisionArn": { "MarkdownDocumentation": "`ServiceRevisionArn`\n\nThe ARN of the service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-servicerevisionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe ARN of the task execution role for the service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-executionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TaskRoleArn": { "MarkdownDocumentation": "`TaskRoleArn`\n\nThe ARN of the task role for the service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-taskrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScalingTarget": { "MarkdownDocumentation": "`ScalingTarget`\n\nThe auto-scaling configuration for this service revision.\n*Required*: No\n*Type*: [ExpressGatewayScalingTarget](./aws-properties-ecs-expressgatewayservice-expressgatewayscalingtarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-scalingtarget", "UpdateType": "Mutable", "Required": false, "Type": "ExpressGatewayScalingTarget" }, "IngressPaths": { "MarkdownDocumentation": "`IngressPaths`\n\nThe entry point into this service revision.\n*Required*: No\n*Type*: Array of [IngressPathSummary](./aws-properties-ecs-expressgatewayservice-ingresspathsummary.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-ingresspaths", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IngressPathSummary", "DuplicatesAllowed": true }, "PrimaryContainer": { "MarkdownDocumentation": "`PrimaryContainer`\n\nThe primary container configuration for this service revision.\n*Required*: No\n*Type*: [ExpressGatewayContainer](./aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-primarycontainer", "UpdateType": "Mutable", "Required": false, "Type": "ExpressGatewayContainer" }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe memory allocation for tasks in this service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-memory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HealthCheckPath": { "MarkdownDocumentation": "`HealthCheckPath`\n\nThe health check path for this service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-healthcheckpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nThe Unix timestamp for when this service revision 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-createdat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe CPU allocation for tasks in this service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-cpu", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for tasks in this service revision.\n*Required*: No\n*Type*: [ExpressGatewayServiceNetworkConfiguration](./aws-properties-ecs-expressgatewayservice-expressgatewayservicenetworkconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayserviceconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayserviceconfiguration-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExpressGatewayServiceNetworkConfiguration" } } }, "AWS::ECS::ExpressGatewayService.ExpressGatewayServiceNetworkConfiguration": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.ExpressGatewayServiceNetworkConfiguration`\n\nThe network configuration for an Express service. By default, an Express service utilizes subnets and security groups associated with the default VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayservicenetworkconfiguration.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe IDs of the security groups associated with the Express service.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayservicenetworkconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayservicenetworkconfiguration-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe IDs of the subnets associated with the Express service.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayservicenetworkconfiguration.html#cfn-ecs-expressgatewayservice-expressgatewayservicenetworkconfiguration-subnets", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ECS::ExpressGatewayService.ExpressGatewayServiceStatus": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.ExpressGatewayServiceStatus`\n\nAn object that defines the status of Express service creation and information about the\nstatus of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayservicestatus.html", "Properties": { "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe status of the Express service.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACTIVE | DRAINING | INACTIV...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACTIVE", "DRAINING", "INACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewayservicestatus.html#cfn-ecs-expressgatewayservice-expressgatewayservicestatus-statuscode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::ExpressGatewayService.IngressPathArns": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.IngressPathArns`\n\nThe `IngressPathArns` property type specifies Property description not available. for an [AWS::ECS::ExpressGatewayService](./aws-resource-ecs-expressgatewayservice.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspatharns.html", "Properties": { "ListenerArn": { "MarkdownDocumentation": "`ListenerArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspatharns.html#cfn-ecs-expressgatewayservice-ingresspatharns-listenerarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancerArn": { "MarkdownDocumentation": "`LoadBalancerArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspatharns.html#cfn-ecs-expressgatewayservice-ingresspatharns-loadbalancerarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetGroupArns": { "MarkdownDocumentation": "`TargetGroupArns`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspatharns.html#cfn-ecs-expressgatewayservice-ingresspatharns-targetgrouparns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ListenerRuleArn": { "MarkdownDocumentation": "`ListenerRuleArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspatharns.html#cfn-ecs-expressgatewayservice-ingresspatharns-listenerrulearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancerSecurityGroups": { "MarkdownDocumentation": "`LoadBalancerSecurityGroups`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspatharns.html#cfn-ecs-expressgatewayservice-ingresspatharns-loadbalancersecuritygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspatharns.html#cfn-ecs-expressgatewayservice-ingresspatharns-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::ExpressGatewayService.IngressPathSummary": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.IngressPathSummary`\n\nThe entry point into an Express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspathsummary.html", "Properties": { "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint for access to the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspathsummary.html#cfn-ecs-expressgatewayservice-ingresspathsummary-endpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessType": { "MarkdownDocumentation": "`AccessType`\n\nThe type of access to the endpoint for the Express service.\n*Required*: No\n*Type*: String\n*Allowed values*: `PUBLIC | PRIVATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PUBLIC", "PRIVATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-ingresspathsummary.html#cfn-ecs-expressgatewayservice-ingresspathsummary-accesstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::ExpressGatewayService.KeyValuePair": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.KeyValuePair`\n\nA key-value pair object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-keyvaluepair.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the key-value pair. For environment variables, this is the value of the\nenvironment variable.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-keyvaluepair.html#cfn-ecs-expressgatewayservice-keyvaluepair-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the key-value pair. For environment variables, this is the name of the\nenvironment variable.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-keyvaluepair.html#cfn-ecs-expressgatewayservice-keyvaluepair-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::ExpressGatewayService.Secret": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService.Secret`\n\nAn object representing the secret to expose to your container. Secrets can be exposed\nto a container in the following ways:\n* To inject sensitive data into your containers as environment variables, use\n the `secrets` container definition parameter.\n* To reference sensitive information in the log configuration of a container,\n use the `secretOptions` container definition parameter.\nFor more information, see [Specifying\nsensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-secret.html", "Properties": { "ValueFrom": { "MarkdownDocumentation": "`ValueFrom`\n\nThe secret to expose to the container. The supported values are either the full ARN of\nthe AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter\nStore.\nFor information about the require AWS Identity and Access Management permissions,\nsee [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\n[Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager\nParameter store) in the *Amazon Elastic Container Service Developer\nGuide*.\n###### Note\nIf the SSM Parameter Store parameter exists in the same Region as the task you're\nlaunching, then you can use either the full ARN or name of the parameter. If the\nparameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-secret.html#cfn-ecs-expressgatewayservice-secret-valuefrom", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-secret.html#cfn-ecs-expressgatewayservice-secret-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.AdvancedConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.AdvancedConfiguration`\n\nThe advanced settings for a load balancer used in blue/green deployments. Specify the\nalternate target group, listener rules, and IAM role required for traffic shifting during\nblue/green deployments. For more information, see [Required resources for Amazon ECS\nblue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-deployment-implementation.html) in the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-advancedconfiguration.html", "Properties": { "TestListenerRule": { "MarkdownDocumentation": "`TestListenerRule`\n\nThe Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or\nlistener (in the case for an Network Load Balancer) for routing test traffic.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-advancedconfiguration.html#cfn-ecs-service-advancedconfiguration-testlistenerrule", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AlternateTargetGroupArn": { "MarkdownDocumentation": "`AlternateTargetGroupArn`\n\nThe Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-advancedconfiguration.html#cfn-ecs-service-advancedconfiguration-alternatetargetgrouparn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProductionListenerRule": { "MarkdownDocumentation": "`ProductionListenerRule`\n\nThe Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or\nlistener (in the case for an Network Load Balancer) for routing production traffic.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-advancedconfiguration.html#cfn-ecs-service-advancedconfiguration-productionlistenerrule", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-advancedconfiguration.html#cfn-ecs-service-advancedconfiguration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.AwsVpcConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.AwsVpcConfiguration`\n\nAn object representing the networking details for a task or service. For example\n`awsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe IDs of the security groups associated with the task or service. If you don't\nspecify a security group, the default security group for the VPC is used. There's a\nlimit of 5 security groups that can be specified.\n###### Note\nAll specified security groups must be from the same VPC.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe IDs of the subnets associated with the task or service. There's a limit of 16\nsubnets that can be specified.\n###### Note\nAll specified subnets must be from the same VPC.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-subnets", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AssignPublicIp": { "MarkdownDocumentation": "`AssignPublicIp`\n\nWhether the task's elastic network interface receives a public IP address.\nConsider the following when you set this value:\n* When you use `create-service` or `update-service`, the\n default is `DISABLED`.\n* When the service `deploymentController` is `ECS`, the\n value must be `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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-assignpublicip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.CanaryConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.CanaryConfiguration`\n\nConfiguration for a canary deployment strategy that shifts a fixed percentage of traffic to\nthe new service revision, waits for a specified bake time, then shifts the remaining\ntraffic.\nThe following validation applies only to Canary deployments created through CloudFormation. CloudFormation operations time out after 36 hours. Canary deployments can approach this limit because of their extended duration. This can cause CloudFormation to roll back the deployment. To prevent timeout-related rollbacks, CloudFormation rejects deployments when the calculated deployment time exceeds 33 hours based on your template configuration:\n`BakeTimeInMinutes + CanaryBakeTimeInMinutes`\nAdditional backend processes (such as task scaling and running lifecycle hooks) can extend deployment time beyond these calculations. Even deployments under the 33-hour threshold might still time out if these processes\ncause the total duration to exceed 36 hours.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-canaryconfiguration.html", "Properties": { "CanaryPercent": { "MarkdownDocumentation": "`CanaryPercent`\n\nThe percentage of production traffic to shift to the new service revision during the canary phase. Valid values are multiples of 0.1 from 0.1 to 100.0. The default value is 5.0.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-canaryconfiguration.html#cfn-ecs-service-canaryconfiguration-canarypercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "CanaryBakeTimeInMinutes": { "MarkdownDocumentation": "`CanaryBakeTimeInMinutes`\n\nThe amount of time in minutes to wait during the canary phase before shifting the\nremaining production traffic to the new service revision. Valid values are 0 to 1440\nminutes (24 hours). The default value is 10.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-canaryconfiguration.html#cfn-ecs-service-canaryconfiguration-canarybaketimeinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::Service.CapacityProviderStrategyItem": { "MarkdownDocumentation": "`AWS::ECS::Service.CapacityProviderStrategyItem`\n\nThe details of a capacity provider strategy. A capacity provider strategy can be set\nwhen using the `RunTask` or `CreateService` APIs or as the default\ncapacity provider strategy for a cluster with the `CreateCluster` API.\nOnly capacity providers that are already associated with a cluster and have an\n`ACTIVE` or `UPDATING` status can be used in a capacity provider\nstrategy. The `PutClusterCapacityProviders` API is used to associate a capacity\nprovider with a cluster.\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider\nmust already be created. New Auto Scaling group capacity providers can be created with the\n`CreateCapacityProvider` API operation.\nTo use an AWS Fargate capacity provider, specify either the\n`FARGATE` or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to\nbe associated with a cluster to be used in a capacity provider strategy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html", "Properties": { "CapacityProvider": { "MarkdownDocumentation": "`CapacityProvider`\n\nThe short name of the capacity provider. This can be either an AWS managed capacity provider (`FARGATE` or `FARGATE_SPOT`) or the name of a custom capacity provider that you 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-capacityprovider", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Base": { "MarkdownDocumentation": "`Base`\n\nThe *base* value designates how many tasks, at a minimum, to run on\nthe specified capacity provider for each service. Only one capacity provider in a\ncapacity provider strategy can have a *base* defined. If no value is\nspecified, the default value of `0` is used.\nBase value characteristics:\n* Only one capacity provider in a strategy can have a base defined\n* The default value is `0` if not specified\n* The valid range is 0 to 100,000\n* Base requirements are satisfied first before weight distribution\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe *weight* value designates the relative percentage of the total\nnumber of tasks launched that should use the specified capacity provider. The\n`weight` value is taken into consideration after the `base`\nvalue, if defined, is satisfied.\nIf no `weight` value is specified, the default value of `0` is\nused. When multiple capacity providers are specified within a capacity provider\nstrategy, at least one of the capacity providers must have a weight value greater than\nzero and any capacity providers with a weight of `0` can't be used to place\ntasks. If you specify multiple capacity providers in a strategy that all have a weight\nof `0`, any `RunTask` or `CreateService` actions using\nthe capacity provider strategy will fail.\nWeight value characteristics:\n* Weight is considered after the base value is satisfied\n* The default value is `0` if not specified\n* The valid range is 0 to 1,000\n* At least one capacity provider must have a weight greater than zero\n* Capacity providers with weight of `0` cannot place tasks\nTask distribution logic:\n1. Base satisfaction: The minimum number of tasks specified by the base value are\n placed on that capacity provider\n2. Weight distribution: After base requirements are met, additional tasks are\n distributed according to weight ratios\nExamples:\nEqual Distribution: Two capacity providers both with weight `1` will split\ntasks evenly after base requirements are met.\nWeighted Distribution: If capacityProviderA has weight `1` and\ncapacityProviderB has weight `4`, then for every 1 task on A, 4 tasks will\nrun on B.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-capacityproviderstrategyitem.html#cfn-ecs-service-capacityproviderstrategyitem-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::Service.DeploymentAlarms": { "MarkdownDocumentation": "`AWS::ECS::Service.DeploymentAlarms`\n\nOne of the methods which provide a way for you to quickly identify when a deployment\nhas failed, and then to optionally roll back the failure to the last working\ndeployment.\nWhen the alarms are generated, Amazon ECS sets the service deployment to failed. Set\nthe rollback parameter to have Amazon ECS to roll back your service to the last\ncompleted deployment after a failure.\nYou can only use the `DeploymentAlarms` method to detect failures when the\n`DeploymentController` is set to `ECS`.\nFor more information, see [Rolling\nupdate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the **Amazon Elastic Container Service Developer\nGuide**.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html", "Properties": { "AlarmNames": { "MarkdownDocumentation": "`AlarmNames`\n\nOne or more CloudWatch alarm names. Use a \",\" to separate the alarms.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html#cfn-ecs-service-deploymentalarms-alarmnames", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Enable": { "MarkdownDocumentation": "`Enable`\n\nDetermines whether to use the CloudWatch alarm option in the service deployment\nprocess.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html#cfn-ecs-service-deploymentalarms-enable", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Rollback": { "MarkdownDocumentation": "`Rollback`\n\nDetermines whether to configure Amazon ECS to roll back the service if a service\ndeployment fails. If rollback is used, when a service deployment fails, the service is\nrolled 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html#cfn-ecs-service-deploymentalarms-rollback", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::ECS::Service.DeploymentCircuitBreaker": { "MarkdownDocumentation": "`AWS::ECS::Service.DeploymentCircuitBreaker`\n\n###### Note\nThe deployment circuit breaker can only be used for services using the rolling\nupdate (`ECS`) deployment type.\nThe **deployment circuit breaker** determines whether a\nservice deployment will fail if the service can't reach a steady state. If it is turned\non, a service deployment will transition to a failed state and stop launching new tasks.\nYou can also configure Amazon ECS to roll back your service to the last completed\ndeployment after a failure. For more information, see [Rolling\nupdate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer\nGuide*.\nFor more information about API failure reasons, see [API failure\nreasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html", "Properties": { "Enable": { "MarkdownDocumentation": "`Enable`\n\nDetermines 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-enable", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Rollback": { "MarkdownDocumentation": "`Rollback`\n\nDetermines whether to configure Amazon ECS to roll back the service if a service\ndeployment fails. If rollback is on, when a service deployment fails, the service is\nrolled 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-rollback", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::ECS::Service.DeploymentConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.DeploymentConfiguration`\n\nOptional deployment parameters that control how many tasks run during a deployment and\nthe ordering of stopping and starting tasks.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html", "Properties": { "CanaryConfiguration": { "MarkdownDocumentation": "`CanaryConfiguration`\n\nConfiguration for canary deployment strategy. Only valid when the deployment strategy\nis `CANARY`. This configuration enables shifting a fixed percentage of\ntraffic for testing, followed by shifting the remaining traffic after a bake\nperiod.\n*Required*: No\n*Type*: [CanaryConfiguration](./aws-properties-ecs-service-canaryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-canaryconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CanaryConfiguration" }, "BakeTimeInMinutes": { "MarkdownDocumentation": "`BakeTimeInMinutes`\n\nThe duration when both blue and green service revisions are running simultaneously after the production traffic has shifted.\nThe following rules apply when you don't specify a value:\n* For rolling deployments, the value is set to 3 hours (180 minutes).\n* When you use an external deployment controller (`EXTERNAL`), or the CodeDeploy blue/green deployment controller (`CODE_DEPLOY`), the value is set to 3 hours (180 minutes).\n* For all other cases, the value is set to 36 hours (2160 minutes).\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-baketimeinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LifecycleHooks": { "MarkdownDocumentation": "`LifecycleHooks`\n\nAn array of deployment lifecycle hook objects to run custom logic at specific stages of the deployment lifecycle.\n*Required*: No\n*Type*: Array of [DeploymentLifecycleHook](./aws-properties-ecs-service-deploymentlifecyclehook.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-lifecyclehooks", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DeploymentLifecycleHook", "DuplicatesAllowed": true }, "Alarms": { "MarkdownDocumentation": "`Alarms`\n\nInformation about the CloudWatch alarms.\n*Required*: No\n*Type*: [DeploymentAlarms](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-alarms", "UpdateType": "Mutable", "Required": false, "Type": "DeploymentAlarms" }, "Strategy": { "MarkdownDocumentation": "`Strategy`\n\nThe deployment strategy for the service. Choose from these valid values:\n* `ROLLING` - When you create a service which uses the rolling update\n (`ROLLING`) deployment strategy, the Amazon ECS service scheduler replaces\n the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or\n removes from the service during a rolling update is controlled by the service\n deployment configuration.\n* `BLUE_GREEN` - A blue/green deployment strategy\n (`BLUE_GREEN`) is a release methodology that reduces downtime and risk\n by running two identical production environments called blue and green. With Amazon ECS\n blue/green deployments, you can validate new service revisions before directing\n production traffic to them. This approach provides a safer way to deploy changes with\n the ability to quickly roll back if needed.\n* `LINEAR` - A *linear* deployment strategy\n (`LINEAR`) gradually shifts traffic from the current production\n environment to a new environment in equal percentages over time. With Amazon ECS linear\n deployments, you can control the pace of traffic shifting and validate new service\n revisions with increasing amounts of production traffic.\n* `CANARY` - A *canary* deployment strategy\n (`CANARY`) shifts a small percentage of traffic to the new service\n revision first, then shifts the remaining traffic all at once after a specified\n time period. This allows you to test the new version with a subset of users before\n full deployment.\n*Required*: No\n*Type*: String\n*Allowed values*: `ROLLING | BLUE_GREEN | LINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROLLING", "BLUE_GREEN", "LINEAR", "CANARY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-strategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeploymentCircuitBreaker": { "MarkdownDocumentation": "`DeploymentCircuitBreaker`\n\n###### Note\nThe deployment circuit breaker can only be used for services using the rolling\nupdate (`ECS`) deployment type.\nThe **deployment circuit breaker** determines whether a\nservice deployment will fail if the service can't reach a steady state. If you use the\ndeployment circuit breaker, a service deployment will transition to a failed state and\nstop launching new tasks. If you use the rollback option, when a service deployment\nfails, the service is rolled back to the last deployment that completed successfully.\nFor more information, see [Rolling\nupdate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer\nGuide*\n*Required*: No\n*Type*: [DeploymentCircuitBreaker](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-deploymentcircuitbreaker", "UpdateType": "Mutable", "Required": false, "Type": "DeploymentCircuitBreaker" }, "MaximumPercent": { "MarkdownDocumentation": "`MaximumPercent`\n\nIf a service is using the rolling update (`ECS`) deployment type, the\n`maximumPercent` parameter represents an upper limit on the number of\nyour service's tasks that are allowed in the `RUNNING` or\n`PENDING` state during a deployment, as a percentage of the\n`desiredCount` (rounded down to the nearest integer). This parameter\nenables you to define the deployment batch size. For example, if your service is using\nthe `REPLICA` service scheduler and has a `desiredCount` of four\ntasks and a `maximumPercent` value of 200%, the scheduler may start four new\ntasks before stopping the four older tasks (provided that the cluster resources required\nto do this are available). The default `maximumPercent` value for a service\nusing the `REPLICA` service scheduler is 200%.\nThe Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting\nreplacement tasks first and then stopping the unhealthy tasks, as long as cluster\nresources for starting replacement tasks are available. For more information about how\nthe scheduler replaces unhealthy tasks, see [Amazon ECS\nservices](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\nIf a service is using either the blue/green (`CODE_DEPLOY`) or\n`EXTERNAL` deployment types, and tasks in the service use the EC2 launch\ntype, the **maximum percent** value is set to the default\nvalue. The **maximum percent** value is used to define the\nupper limit on the number of the tasks in the service that remain in the\n`RUNNING` state while the container instances are in the\n`DRAINING` state.\n###### Note\nYou can't specify a custom `maximumPercent` value for a service that\nuses either the blue/green (`CODE_DEPLOY`) or `EXTERNAL`\ndeployment types and has tasks that use the EC2 launch type.\nIf the service uses either the blue/green (`CODE_DEPLOY`) or\n`EXTERNAL` deployment types, and the tasks in the service use the Fargate\nlaunch type, the maximum percent value is not used. The value is still returned when\ndescribing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-maximumpercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinimumHealthyPercent": { "MarkdownDocumentation": "`MinimumHealthyPercent`\n\nIf a service is using the rolling update (`ECS`) deployment type, the\n`minimumHealthyPercent` represents a lower limit on the number of your\nservice's tasks that must remain in the `RUNNING` state during a deployment,\nas a percentage of the `desiredCount` (rounded up to the nearest integer).\nThis parameter enables you to deploy without using additional cluster capacity. For\nexample, if your service has a `desiredCount` of four tasks and a\n`minimumHealthyPercent` of 50%, the service scheduler may stop two\nexisting tasks to free up cluster capacity before starting two new tasks.\nIf any tasks are unhealthy and if `maximumPercent` doesn't allow the\nAmazon ECS scheduler to start replacement tasks, the scheduler stops the unhealthy tasks\none-by-one \u2014 using the `minimumHealthyPercent` as a constraint \u2014 to clear up\ncapacity to launch replacement tasks. For more information about how the scheduler\nreplaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\nFor services that *do not* use a load balancer, the following\nshould be noted:\n* A service is considered healthy if all essential containers within the tasks\n in the service pass their health checks.\n* If a task has no essential containers with a health check defined, the service\n scheduler will wait for 40 seconds after a task reaches a `RUNNING`\n state before the task is counted towards the minimum healthy percent\n total.\n* If a task has one or more essential containers with a health check defined,\n the service scheduler will wait for the task to reach a healthy status before\n counting it towards the minimum healthy percent total. A task is considered\n healthy when all essential containers within the task have passed their health\n checks. The amount of time the service scheduler can wait for is determined by\n the container health check settings.\nFor services that *do* use a load balancer, the following should be\nnoted:\n* If a task has no essential containers with a health check defined, the service\n scheduler will wait for the load balancer target group health check to return a\n healthy status before counting the task towards the minimum healthy percent\n total.\n* If a task has an essential container with a health check defined, the service\n scheduler will wait for both the task to reach a healthy status and the load\n balancer target group health check to return a healthy status before counting\n the task towards the minimum healthy percent total.\nThe default value for a replica service for `minimumHealthyPercent` is\n100%. The default `minimumHealthyPercent` value for a service using the\n`DAEMON` service schedule is 0% for the AWS CLI, the AWS SDKs, and the\nAPIs and 50% for the AWS Management Console.\nThe minimum number of healthy tasks during a deployment is the\n`desiredCount` multiplied by the `minimumHealthyPercent`/100,\nrounded up to the nearest integer value.\nIf a service is using either the blue/green (`CODE_DEPLOY`) or\n`EXTERNAL` deployment types and is running tasks that use the EC2 launch\ntype, the **minimum healthy percent** value is set to the\ndefault value. The **minimum healthy percent** value is\nused to define the lower limit on the number of the tasks in the service that remain in\nthe `RUNNING` state while the container instances are in the\n`DRAINING` state.\n###### Note\nYou can't specify a custom `minimumHealthyPercent` value for a service\nthat uses either the blue/green (`CODE_DEPLOY`) or `EXTERNAL`\ndeployment types and has tasks that use the EC2 launch type.\nIf a service is using either the blue/green (`CODE_DEPLOY`) or\n`EXTERNAL` deployment types and is running tasks that use the Fargate\nlaunch type, the minimum healthy percent value is not used, although it is returned when\ndescribing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-minimumhealthypercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LinearConfiguration": { "MarkdownDocumentation": "`LinearConfiguration`\n\nConfiguration for linear deployment strategy. Only valid when the deployment strategy\nis `LINEAR`. This configuration enables progressive traffic shifting in equal\npercentage increments with configurable bake times between each step.\n*Required*: No\n*Type*: [LinearConfiguration](./aws-properties-ecs-service-linearconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-linearconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LinearConfiguration" } } }, "AWS::ECS::Service.DeploymentController": { "MarkdownDocumentation": "`AWS::ECS::Service.DeploymentController`\n\nThe deployment controller to use for the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe deployment controller type to use.\nThe deployment controller is the mechanism that determines how tasks are deployed for\nyour service. The valid options are:\n* ECS\n \n When you create a service which uses the `ECS` deployment controller, you can choose between the following deployment strategies:\n \n + `ROLLING`: When you create a service which uses the *rolling update*\n (`ROLLING`) deployment strategy, the Amazon ECS service scheduler replaces the\n currently running tasks with new tasks. The number of tasks that Amazon ECS adds or\n removes from the service during a rolling update is controlled by the service\n deployment configuration.\n \n Rolling update deployments are best suited for the following scenarios:\n \n - Gradual service updates: You need to\n update your service incrementally without taking the entire service\n offline at once.\n - Limited resource requirements: You\n want to avoid the additional resource costs of running two complete\n environments simultaneously (as required by blue/green\n deployments).\n - Acceptable deployment time: Your\n application can tolerate a longer deployment process, as rolling updates\n replace tasks one by one.\n - No need for instant roll back: Your\n service can tolerate a rollback process that takes minutes rather than\n seconds.\n - Simple deployment process: You prefer\n a straightforward deployment approach without the complexity of managing\n multiple environments, target groups, and listeners.\n - No load balancer requirement: Your\n service doesn't use or require a load balancer, Application Load Balancer, Network Load Balancer, or Service Connect (which are required\n for blue/green deployments).\n - Stateful applications: Your\n application maintains state that makes it difficult to run two parallel\n environments.\n - Cost sensitivity: You want to\n minimize deployment costs by not running duplicate environments during\n deployment.\n \n Rolling updates are the default deployment strategy for services and provide a\n balance between deployment safety and resource efficiency for many common\n application scenarios.\n + `BLUE_GREEN`: A *blue/green* deployment strategy (`BLUE_GREEN`) is a release methodology that reduces downtime and\n risk by running two identical production environments called blue and green.\n With Amazon ECS blue/green deployments, you can validate new service revisions before\n directing production traffic to them. This approach provides a safer way to\n deploy changes with the ability to quickly roll back if needed.\n \n Amazon ECS blue/green deployments are best suited for the following scenarios:\n \n - Service validation: When you need to\n validate new service revisions before directing production traffic to\n them\n - Zero downtime: When your service\n requires zero-downtime deployments\n - Instant roll back: When you\n need the ability to quickly roll back if issues are detected\n - Load balancer requirement: When your\n service uses Application Load Balancer, Network Load Balancer, or Service Connect\n* External\n \n Use a third-party deployment controller.\n* Blue/green deployment (powered by CodeDeploy)\n \n CodeDeploy installs an updated version of the application as a new replacement task\n set and reroutes production traffic from the original application task set to\n the replacement task set. The original task set is terminated after a successful\n deployment. Use this deployment controller to verify a new deployment of a service\n before sending production traffic to it.\nWhen updating the deployment controller for a service,\nconsider the following depending on the type of migration you're\nperforming.\n* If you have a\n template that contains the `EXTERNAL` deployment controller\n information as well as `TaskSet` and\n `PrimaryTaskSet` resources, and you remove the task set\n resources from the template when updating from `EXTERNAL` to\n `ECS`, the `DescribeTaskSet` and\n `DeleteTaskSet` API calls will return a 400 error after\n the deployment controller is updated to `ECS`. This results\n in a delete failure on the task set resources, even though\n the stack transitions to `UPDATE_COMPLETE` status.\n For more information, see [Resource removed from stack but not deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-resource-removed-not-deleted) in the\n AWS CloudFormation User Guide. To fix this issue, delete the task sets directly\n using the Amazon ECS`DeleteTaskSet` API. For more information\n about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the Amazon Elastic Container Service API Reference.\n* If you're migrating from `CODE_DEPLOY` to `ECS` with a\n new task definition and CloudFormation performs a rollback operation, the\n Amazon ECS`UpdateService` request fails with the following error:\n \n Resource handler returned message: \"Invalid request provided: Unable to update\n task definition on services with a CODE\\_DEPLOY deployment controller.\n* After a successful migration from `ECS` to `EXTERNAL`\n deployment controller, you need to manually remove the `ACTIVE` task\n set, because Amazon ECS no longer manages the deployment. For\n information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the Amazon Elastic Container Service API Reference.\n*Required*: No\n*Type*: String\n*Allowed values*: `CODE_DEPLOY | ECS | EXTERNA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CODE_DEPLOY", "ECS", "EXTERNAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html#cfn-ecs-service-deploymentcontroller-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.DeploymentLifecycleHook": { "MarkdownDocumentation": "`AWS::ECS::Service.DeploymentLifecycleHook`\n\nA deployment lifecycle hook runs custom logic at specific stages of the deployment process. Currently, you can use Lambda functions as hook targets.\nFor more information, see [Lifecycle hooks for Amazon ECS service deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-lifecycle-hooks.html) in the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html", "Properties": { "LifecycleStages": { "MarkdownDocumentation": "`LifecycleStages`\n\nThe lifecycle stages at which to run the hook. Choose from these valid values:\n* RECONCILE\\_SERVICE\n \n The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.\n \n You can use a lifecycle hook for this stage.\n* PRE\\_SCALE\\_UP\n \n The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.\n \n You can use a lifecycle hook for this stage.\n* POST\\_SCALE\\_UP\n \n The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.\n \n You can use a lifecycle hook for this stage.\n* TEST\\_TRAFFIC\\_SHIFT\n \n The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.\n \n You can use a lifecycle hook for this stage.\n* POST\\_TEST\\_TRAFFIC\\_SHIFT\n \n The test traffic shift is complete. The green service revision handles 100% of the test traffic.\n \n You can use a lifecycle hook for this stage.\n* PRODUCTION\\_TRAFFIC\\_SHIFT\n \n Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.\n \n You can use a lifecycle hook for this stage.\n* POST\\_PRODUCTION\\_TRAFFIC\\_SHIFT\n \n The production traffic shift is complete.\n \n You can use a lifecycle hook for this stage.\nYou must provide this parameter when configuring a deployment lifecycle hook.\n*Required*: Yes\n*Type*: Array of String\n*Allowed values*: `RECONCILE_SERVICE | PRE_SCA...`\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)", "RefReturnValue": "", "AllowedValues": [ "RECONCILE_SERVICE", "PRE_SCALE_UP", "POST_SCALE_UP", "TEST_TRAFFIC_SHIFT", "POST_TEST_TRAFFIC_SHIFT", "PRODUCTION_TRAFFIC_SHIFT", "POST_PRODUCTION_TRAFFIC_SHIFT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html#cfn-ecs-service-deploymentlifecyclehook-lifecyclestages", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "HookTargetArn": { "MarkdownDocumentation": "`HookTargetArn`\n\nThe Amazon Resource Name (ARN) of the hook target. Currently, only Lambda function ARNs are supported.\nYou must provide this parameter when configuring a deployment lifecycle hook.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html#cfn-ecs-service-deploymentlifecyclehook-hooktargetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HookDetails": { "MarkdownDocumentation": "`HookDetails`\n\nUse this field to specify custom parameters that Amazon ECS passes to your hook target invocations (such as a Lambda function).\nThis field must be a JSON object as a string.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html#cfn-ecs-service-deploymentlifecyclehook-hookdetails", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.\nFor more information, see [Permissions required\nfor Lambda functions in Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-permissions.html) in the *Amazon Elastic Container 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html#cfn-ecs-service-deploymentlifecyclehook-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.EBSTagSpecification": { "MarkdownDocumentation": "`AWS::ECS::Service.EBSTagSpecification`\n\nThe tag specifications of an Amazon EBS volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-ebstagspecification.html", "Properties": { "PropagateTags": { "MarkdownDocumentation": "`PropagateTags`\n\nDetermines whether to propagate the tags from the task definition to \nthe\nAmazon EBS volume. Tags can only propagate to a `SERVICE` specified in\n\n`ServiceVolumeConfiguration`. If no value is specified, the tags\naren't \npropagated.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "SERVICE", "TASK_DEFINITION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-ebstagspecification.html#cfn-ecs-service-ebstagspecification-propagatetags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of volume resource.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `volume`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "volume" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-ebstagspecification.html#cfn-ecs-service-ebstagspecification-resourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags applied to this Amazon EBS volume. `AmazonECSCreated` and\n`AmazonECSManaged` are reserved tags that can't be used.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecs-service-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-ebstagspecification.html#cfn-ecs-service-ebstagspecification-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::ECS::Service.ForceNewDeployment": { "MarkdownDocumentation": "`AWS::ECS::Service.ForceNewDeployment`\n\nDetermines whether to force a new deployment of the service. By default, deployments\naren't forced. You can use this option to start a new deployment with no service\ndefinition changes. For example, you can update a service's tasks to use a newer Docker\nimage with the same image/tag combination (`my_image:latest`) or to roll\nFargate tasks onto a newer platform version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-forcenewdeployment.html", "Properties": { "EnableForceNewDeployment": { "MarkdownDocumentation": "`EnableForceNewDeployment`\n\nDetermines whether to force a new deployment of the service. By default, deployments\naren't forced. You can use this option to start a new deployment with no service\ndefinition changes. For example, you can update a service's tasks to use a newer Docker\nimage with the same image/tag combination (`my_image:latest`) or to roll\nFargate tasks onto a newer platform version.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-forcenewdeployment.html#cfn-ecs-service-forcenewdeployment-enableforcenewdeployment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "ForceNewDeploymentNonce": { "MarkdownDocumentation": "`ForceNewDeploymentNonce`\n\nWhen you change the `ForceNewDeploymentNonce` value in your\ntemplate, it signals Amazon ECS to start a new deployment even though no\nother service parameters have changed. The value must be a unique, time-\nvarying value like a timestamp, random string, or sequence number.\nUse this property when you want to ensure your tasks pick up the\nlatest version of a Docker image that uses the same tag but has been updated in\nthe registry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-forcenewdeployment.html#cfn-ecs-service-forcenewdeployment-forcenewdeploymentnonce", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.LinearConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.LinearConfiguration`\n\nConfiguration for a linear deployment strategy that shifts production traffic in equal\npercentage increments with configurable wait times between each step until 100 percent of\ntraffic is shifted to the new service revision.\nThe following validation applies only to Linear deployments created through CloudFormation. CloudFormation operations time out after 36 hours. Linear deployments can approach this limit because of their extended duration. This can cause CloudFormation to roll back the deployment. To prevent timeout-related rollbacks, CloudFormation rejects deployments when the calculated deployment time exceeds 33 hours based on your template configuration:\n`BakeTimeInMinutes + (StepBakeTimeInMinutes \u00d7 Number of deployment steps)`\nWhere the number of deployment steps is calculated as follows:\n* **If `StepPercent` evenly divides by 100**: The number of deployment steps equals `(100 \u00f7 StepPercent) - 1`\n* **Otherwise**: The number of deployment steps equals the floor of `100 \u00f7 StepPercent`. For example, if `StepPercent` is 11, the number of deployment steps is 9 (not 9.1).\nThis calculation reflects that CloudFormation doesn't apply the step bake time after the final traffic shift reaches 100%. For example, with a `StepPercent` of 50%, there are actually two traffic shifts, but only one deployment step is counted for validation purposes because the bake time is applied only after the first 50% shift, not after reaching 100%.\nAdditional backend processes (such as task scaling and running lifecycle hooks) can extend deployment time beyond these calculations. Even deployments under the 33-hour threshold might still time out if these processes\ncause the total duration to exceed 36 hours.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-linearconfiguration.html", "Properties": { "StepBakeTimeInMinutes": { "MarkdownDocumentation": "`StepBakeTimeInMinutes`\n\nThe amount of time in minutes to wait between each traffic shifting step during a linear deployment. Valid values are 0 to 1440 minutes (24 hours). The default value is 6. This bake time is not applied after reaching 100 percent traffic.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-linearconfiguration.html#cfn-ecs-service-linearconfiguration-stepbaketimeinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StepPercent": { "MarkdownDocumentation": "`StepPercent`\n\nThe percentage of production traffic to shift in each step during a linear deployment. Valid\nvalues are multiples of 0.1 from 3.0 to 100.0. The default value is 10.0.\n*Required*: No\n*Type*: Number\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-linearconfiguration.html#cfn-ecs-service-linearconfiguration-steppercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::ECS::Service.LoadBalancer": { "MarkdownDocumentation": "`AWS::ECS::Service.LoadBalancer`\n\nThe `LoadBalancer` property specifies details on a load balancer that is used\nwith a service.\nIf the service is using the `CODE_DEPLOY` deployment controller, the service\nis required to use either an Application Load Balancer or Network Load Balancer. When you\nare creating an AWS CodeDeploy deployment group, you specify two target groups\n(referred to as a `targetGroupPair`). Each target group binds to a separate task\nset in the deployment. The load balancer can also have up to two listeners, a required\nlistener for production traffic and an optional listener that allows you to test new\nrevisions of the service before routing production traffic to it.\nServices with tasks that use the `awsvpc` network mode (for example, those\nwith the Fargate launch type) only support Application Load Balancers and Network Load\nBalancers. Classic Load Balancers are not supported. Also, when you create any target\ngroups for these services, you must choose `ip` as the target type, not\n`instance`. Tasks that use the `awsvpc` network mode are\nassociated with an elastic network interface, not an Amazon EC2 instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html", "Properties": { "TargetGroupArn": { "MarkdownDocumentation": "`TargetGroupArn`\n\nThe full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or\ngroups associated with a service or task set.\nA target group ARN is only specified when using an Application Load Balancer or\nNetwork Load Balancer.\nFor services using the `ECS` deployment controller, you can specify one or\nmultiple 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\nthe *Amazon Elastic Container Service Developer Guide*.\nFor services using the `CODE_DEPLOY` deployment controller, you're required\nto 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\n*Amazon Elastic Container Service Developer Guide*.\n###### Important\nIf your service's task definition uses the `awsvpc` network mode, you\nmust choose `ip` as the target type, not `instance`. Do this\nwhen creating your target groups because tasks that use the `awsvpc`\nnetwork mode are associated with an elastic network interface, not an Amazon EC2\ninstance. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-targetgrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancerName": { "MarkdownDocumentation": "`LoadBalancerName`\n\nThe name of the load balancer to associate with the Amazon ECS service or task\nset.\nIf you are using an Application Load Balancer or a Network Load Balancer the load\nbalancer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-loadbalancername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContainerName": { "MarkdownDocumentation": "`ContainerName`\n\nThe name of the container (as it appears in a container definition) to associate with\nthe load balancer.\nYou need to specify the container name when configuring the target group for an Amazon\nECS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-containername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContainerPort": { "MarkdownDocumentation": "`ContainerPort`\n\nThe port on the container to associate with the load balancer. This port must\ncorrespond to a `containerPort` in the task definition the tasks in the\nservice are using. For tasks that use the EC2 launch type, the container instance\nthey're launched on must allow ingress traffic on the `hostPort` of the port\nmapping.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-containerport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AdvancedConfiguration": { "MarkdownDocumentation": "`AdvancedConfiguration`\n\nThe advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments.\n*Required*: No\n*Type*: [AdvancedConfiguration](./aws-properties-ecs-service-advancedconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html#cfn-ecs-service-loadbalancer-advancedconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedConfiguration" } } }, "AWS::ECS::Service.LogConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.LogConfiguration`\n\nThe log configuration for the container. This parameter maps to `LogConfig`\nin the docker container create command and the `--log-driver` option to\ndocker run.\nBy default, containers use the same logging driver that the Docker daemon uses.\nHowever, the container might use a different logging driver than the Docker daemon by\nspecifying a log driver configuration in the container definition.\nUnderstand the following when specifying a log configuration for your\ncontainers.\n* Amazon ECS currently supports a subset of the logging drivers available to the\n Docker daemon. Additional log drivers may be available in future releases of the\n Amazon ECS container agent.\n \n For tasks on AWS Fargate, the supported log drivers are\n `awslogs`, `splunk`, and\n `awsfirelens`.\n \n For tasks hosted on Amazon EC2 instances, the supported log drivers are\n `awslogs`, `fluentd`, `gelf`,\n `json-file`, `journald`,`syslog`,\n `splunk`, and `awsfirelens`.\n* This parameter requires version 1.18 of the Docker Remote API or greater on\n your container instance.\n* For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container\n agent must register the available logging drivers with the\n `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before\n containers placed on that instance can use these log configuration options. For\n more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the\n *Amazon Elastic Container Service Developer\n Guide*.\n* For tasks that are on AWS Fargate, because you don't have access\n to the underlying infrastructure your tasks are hosted on, any additional\n software needed must be installed outside of the task. For example, the Fluentd\n output aggregators or a remote host running Logstash to send Gelf logs\n to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html", "Properties": { "SecretOptions": { "MarkdownDocumentation": "`SecretOptions`\n\nThe secrets to pass to the log configuration. For more information, see [Specifying\nsensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: Array of [Secret](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html#cfn-ecs-service-logconfiguration-secretoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Secret", "DuplicatesAllowed": true }, "Options": { "MarkdownDocumentation": "`Options`\n\nThe configuration options to send to the log driver.\nThe options you can specify depend on the log driver. Some of the options you can\nspecify when you use the `awslogs` log driver to route logs to Amazon\nCloudWatch include the following:\nawslogs-create-group\nRequired: No\nSpecify whether you want the log group to be created automatically. If\nthis option isn't specified, it defaults to `false`.\n###### Note\nYour IAM policy must include the `logs:CreateLogGroup`\npermission before you attempt to use\n`awslogs-create-group`.\n\nawslogs-region\nRequired: Yes\nSpecify the AWS Region that the `awslogs` log\ndriver is to send your Docker logs to. You can choose to send all of your\nlogs from clusters in different Regions to a single region in CloudWatch\nLogs. This is so that they're all visible in one location. Otherwise, you\ncan separate them by Region for more granularity. Make sure that the\nspecified log group exists in the Region that you specify with this\noption.\n\nawslogs-group\nRequired: Yes\nMake sure to specify a log group that the `awslogs` log driver\nsends its log streams to.\n\nawslogs-stream-prefix\nRequired: Yes, when using Fargate.Optional when\nusing EC2.\nUse the `awslogs-stream-prefix` option to associate a log\nstream with the specified prefix, the container name, and the ID of the\nAmazon ECS task that the container belongs to. If you specify a prefix with\nthis option, then the log stream takes the format\n`prefix-name/container-name/ecs-task-id`.\nIf you don't specify a prefix with this option, then the log stream is\nnamed after the container ID that's assigned by the Docker daemon on the\ncontainer instance. Because it's difficult to trace logs back to the\ncontainer that sent them with just the Docker container ID (which is only\navailable on the container instance), we recommend that you specify a prefix\nwith this option.\nFor Amazon ECS services, you can use the service name as the prefix. Doing\nso, you can trace log streams to the service that the container belongs to,\nthe name of the container that sent them, and the ID of the task that the\ncontainer belongs to.\nYou must specify a stream-prefix for your logs to have your logs appear in\nthe Log pane when using the Amazon ECS console.\n\nawslogs-datetime-format\nRequired: No\nThis option defines a multiline start pattern in Python\n`strftime` format. A log message consists of a line that\nmatches the pattern and any following lines that don\u2019t match the pattern.\nThe matched line is the delimiter between log messages.\nOne example of a use case for using this format is for parsing output such\nas a stack dump, which might otherwise be logged in multiple entries. The\ncorrect pattern allows it to be captured in a single entry.\nFor more information, see [awslogs-datetime-format](https://docs.docker.com/config/containers/logging/awslogs/#awslogs-datetime-format).\nYou cannot configure both the `awslogs-datetime-format` and\n`awslogs-multiline-pattern` options.\n###### Note\nMultiline logging performs regular expression parsing and matching of\nall log messages. This might have a negative impact on logging\nperformance.\n\nawslogs-multiline-pattern\nRequired: No\nThis option defines a multiline start pattern that uses a regular\nexpression. A log message consists of a line that matches the pattern and\nany following lines that don\u2019t match the pattern. The matched line is the\ndelimiter between log messages.\nFor more information, see [awslogs-multiline-pattern](https://docs.docker.com/config/containers/logging/awslogs/#awslogs-multiline-pattern).\nThis option is ignored if `awslogs-datetime-format` is also\nconfigured.\nYou cannot configure both the `awslogs-datetime-format` and\n`awslogs-multiline-pattern` options.\n###### Note\nMultiline logging performs regular expression parsing and matching of\nall log messages. This might have a negative impact on logging\nperformance.\n\nThe following options apply to all supported log drivers.\nmode\nRequired: No\nValid values: `non-blocking` | `blocking`\nThis option defines the delivery mode of log messages from the container\nto the log driver specified using `logDriver`. The delivery mode\nyou choose affects application availability when the flow of logs from\ncontainer is interrupted.\nIf you use the `blocking` mode and the flow of logs is\ninterrupted, calls from container code to write to the `stdout`\nand `stderr` streams will block. The logging thread of the\napplication will block as a result. This may cause the application to become\nunresponsive and lead to container healthcheck failure.\nIf you use the `non-blocking` mode, the container's logs are\ninstead stored in an in-memory intermediate buffer configured with the\n`max-buffer-size` option. This prevents the application from\nbecoming unresponsive when logs cannot be sent. We recommend using this mode\nif you want to ensure service availability and are okay with some log loss.\nFor more information, see [Preventing log loss with non-blocking mode in the `awslogs`\ncontainer log driver](https://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/).\nYou can set a default `mode` for all containers in a specific\nAWS Region by using the\n`defaultLogDriverMode` account setting. If you don't specify\nthe `mode` option or configure the account setting, Amazon ECS\nwill default to the `non-blocking` mode. For more information\nabout the account setting, see [Default log driver mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#default-log-driver-mode) in the *Amazon Elastic\nContainer Service Developer Guide*.\n###### Note\nOn June 25, 2025, Amazon ECS changed the default log driver mode from\n`blocking` to `non-blocking` to prioritize\ntask availability over logging. To continue using the\n`blocking` mode after this change, do one of the\nfollowing:\n* Set the `mode` option in your container\n definition's `logConfiguration` as\n `blocking`.\n* Set the `defaultLogDriverMode` account setting to\n `blocking`.\n\nmax-buffer-size\nRequired: No\nDefault value: `10m`\nWhen `non-blocking` mode is used, the\n`max-buffer-size` log option controls the size of the buffer\nthat's used for intermediate message storage. Make sure to specify an\nadequate buffer size based on your application. When the buffer fills up,\nfurther logs cannot be stored. Logs that cannot be stored are lost.\n\nTo route logs using the `splunk` log router, you need to specify a\n`splunk-token` and a `splunk-url`.\nWhen you use the `awsfirelens` log router to route logs to an AWS\nService or AWS Partner Network destination for log storage and analytics, you can\nset the `log-driver-buffer-limit` option to limit the number of events that\nare buffered in memory, before being sent to the log router container. It can help to\nresolve potential log loss issue because high throughput might result in memory running\nout for the buffer inside of Docker.\nOther options you can specify when using `awsfirelens` to route logs depend\non the destination. When you export logs to Amazon Data Firehose, you can specify the\nAWS Region with `region` and a name for the log stream with\n`delivery_stream`.\nWhen you export logs to Amazon Kinesis Data Streams, you can specify an AWS\nRegion with `region` and a data stream name with `stream`.\nWhen you export logs to Amazon OpenSearch Service, you can specify options like\n`Name`, `Host` (OpenSearch Service endpoint without protocol),\n`Port`, `Index`, `Type`, `Aws_auth`,\n`Aws_region`, `Suppress_Type_Name`, and `tls`. For\nmore information, see [Under the hood:\nFireLens for Amazon ECS Tasks](https://aws.amazon.com/blogs/containers/under-the-hood-firelens-for-amazon-ecs-tasks/).\nWhen you export logs to Amazon S3, you can specify the bucket using the\n`bucket` option. You can also specify `region`,\n`total_file_size`, `upload_timeout`, and\n`use_put_object` as options.\nThis parameter requires version 1.19 of the Docker Remote API or greater on your\ncontainer instance. To check the Docker Remote API version on your container instance,\nlog in to your container instance and run the following command: `sudo docker\nversion --format '{{.Server.APIVersion}}'`\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html#cfn-ecs-service-logconfiguration-options", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "LogDriver": { "MarkdownDocumentation": "`LogDriver`\n\nThe log driver to use for the container.\nFor tasks on AWS Fargate, the supported log drivers are `awslogs`,\n`splunk`, and `awsfirelens`.\nFor tasks hosted on Amazon EC2 instances, the supported log drivers are\n`awslogs`, `fluentd`, `gelf`,\n`json-file`, `journald`, `syslog`,\n`splunk`, and `awsfirelens`.\nFor more information about using the `awslogs` log driver, see [Send\nAmazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container\nService Developer Guide*.\nFor more information about using the `awsfirelens` log driver, see [Send\nAmazon ECS logs to an AWS service or AWS\nPartner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html).\n###### Note\nIf you have a custom driver that isn't listed, you can fork the Amazon ECS\ncontainer agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We\nencourage you to submit pull requests for changes that you would like to have\nincluded. However, we don't currently provide support for running modified copies of\nthis software.\n*Required*: No\n*Type*: String\n*Allowed values*: `json-file | syslog | journa...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html#cfn-ecs-service-logconfiguration-logdriver", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.NetworkConfiguration`\n\nThe network configuration for a task or service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html", "Properties": { "AwsvpcConfiguration": { "MarkdownDocumentation": "`AwsvpcConfiguration`\n\nThe VPC subnets and security groups that are associated with a task.\n###### Note\nAll specified subnets and security groups must be from the same VPC.\n*Required*: No\n*Type*: [AwsVpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html#cfn-ecs-service-networkconfiguration-awsvpcconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AwsVpcConfiguration" } } }, "AWS::ECS::Service.PlacementConstraint": { "MarkdownDocumentation": "`AWS::ECS::Service.PlacementConstraint`\n\nAn object representing a constraint on task placement. For more information, see\n[Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon\nElastic Container Service Developer Guide*.\n###### Note\nIf you're using the Fargate launch type, task placement constraints aren't\nsupported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of constraint. Use `distinctInstance` to ensure that each task in\na particular group is running on a different container instance. Use\n`memberOf` to restrict the selection to a group of valid\ncandidates.\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)", "RefReturnValue": "", "AllowedValues": [ "distinctInstance", "memberOf" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nA cluster query language expression to apply to the constraint. The expression can\nhave a maximum length of 2000 characters. You can't specify an expression if the\nconstraint 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\nContainer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.PlacementStrategy": { "MarkdownDocumentation": "`AWS::ECS::Service.PlacementStrategy`\n\nThe task placement strategy for a task or service. For more information, see [Task placement strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon\nElastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field to apply the placement strategy against. For the `spread`\nplacement strategy, valid values are `instanceId` (or `host`,\nwhich has the same effect), or any platform or custom attribute that's applied to a\ncontainer instance, such as `attribute:ecs.availability-zone`. For the\n`binpack` placement strategy, valid values are `cpu` and\n`memory`. For the `random` placement strategy, this field is\nnot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of placement strategy. The `random` placement strategy randomly\nplaces tasks on available candidates. The `spread` placement strategy spreads\nplacement across available candidates evenly based on the `field` parameter.\nThe `binpack` strategy places tasks on available candidates that have the\nleast available amount of the resource that's specified with the `field`\nparameter. For example, if you binpack on memory, a task is placed on the instance with\nthe 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)", "RefReturnValue": "", "AllowedValues": [ "binpack", "random", "spread" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.Secret": { "MarkdownDocumentation": "`AWS::ECS::Service.Secret`\n\nAn object representing the secret to expose to your container. Secrets can be exposed\nto a container in the following ways:\n* To inject sensitive data into your containers as environment variables, use\n the `secrets` container definition parameter.\n* To reference sensitive information in the log configuration of a container,\n use the `secretOptions` container definition parameter.\nFor more information, see [Specifying\nsensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html", "Properties": { "ValueFrom": { "MarkdownDocumentation": "`ValueFrom`\n\nThe secret to expose to the container. The supported values are either the full ARN of\nthe AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter\nStore.\nFor information about the require AWS Identity and Access Management permissions,\nsee [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\n[Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager\nParameter store) in the *Amazon Elastic Container Service Developer\nGuide*.\n###### Note\nIf the SSM Parameter Store parameter exists in the same Region as the task you're\nlaunching, then you can use either the full ARN or name of the parameter. If the\nparameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html#cfn-ecs-service-secret-valuefrom", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html#cfn-ecs-service-secret-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceConnectAccessLogConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectAccessLogConfiguration`\n\nConfiguration for Service Connect access logging. Access logs provide detailed\ninformation about requests made to your service, including request patterns, response\ncodes, and timing data for debugging and monitoring purposes.\n###### Note\nTo enable access logs, you must also specify a `logConfiguration` in the `serviceConnectConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectaccesslogconfiguration.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe format for Service Connect access log output. Choose TEXT for human-readable logs\nor JSON for structured data that integrates well with log analysis tools.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEXT | JSON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TEXT", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectaccesslogconfiguration.html#cfn-ecs-service-serviceconnectaccesslogconfiguration-format", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IncludeQueryParameters": { "MarkdownDocumentation": "`IncludeQueryParameters`\n\nSpecifies whether to include query parameters in Service Connect access logs.\nWhen enabled, query parameters from HTTP requests are included in the access logs.\nConsider security and privacy implications when enabling this feature, as query\nparameters may contain sensitive information such as request IDs and tokens. By default,\nthis parameter 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectaccesslogconfiguration.html#cfn-ecs-service-serviceconnectaccesslogconfiguration-includequeryparameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceConnectClientAlias": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectClientAlias`\n\nEach alias (\"endpoint\") is a fully-qualified name and port number that other tasks\n(\"clients\") can use to connect to this service.\nEach name and port mapping must be unique within the namespace.\nTasks that run in a namespace can use short names to connect to services in the\nnamespace. Tasks can connect to services across all of the clusters in the namespace.\nTasks connect through a managed proxy container that collects logs and metrics for\nincreased visibility. Only the tasks that Amazon ECS services create are supported with\nService Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html", "Properties": { "DnsName": { "MarkdownDocumentation": "`DnsName`\n\nThe `dnsName` is the name that you use in the applications of client tasks\nto connect to this service. The name must be a valid DNS name but doesn't need to be\nfully-qualified. The name can include up to 127 characters. The name can include\nlowercase letters, numbers, underscores (\\_), hyphens (-), and periods (.). The name\ncan't start with a hyphen.\nIf this parameter isn't specified, the default value of\n`discoveryName.namespace` is used. If the `discoveryName`\nisn't specified, the port mapping name from the task definition is used in\n`portName.namespace`.\nTo avoid changing your applications in client Amazon ECS services, set this to the\nsame name that the client application uses by default. For example, a few common names\nare `database`, `db`, or the lowercase name of a database, such as\n`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\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html#cfn-ecs-service-serviceconnectclientalias-dnsname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TestTrafficRules": { "MarkdownDocumentation": "`TestTrafficRules`\n\nThe configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic.\n*Required*: No\n*Type*: [ServiceConnectTestTrafficRules](./aws-properties-ecs-service-serviceconnecttesttrafficrules.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html#cfn-ecs-service-serviceconnectclientalias-testtrafficrules", "UpdateType": "Mutable", "Required": false, "Type": "ServiceConnectTestTrafficRules" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe listening port number for the Service Connect proxy. This port is available inside\nof all of the tasks within the same namespace.\nTo avoid changing your applications in client Amazon ECS services, set this to the\nsame 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\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html#cfn-ecs-service-serviceconnectclientalias-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ECS::Service.ServiceConnectConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectConfiguration`\n\nThe Service Connect configuration of your Amazon ECS service. The configuration for\nthis service to discover and connect to services, and be discovered by, and connected\nfrom, other services within a namespace.\nTasks that run in a namespace can use short names to connect to services in the\nnamespace. Tasks can connect to services across all of the clusters in the namespace.\nTasks connect through a managed proxy container that collects logs and metrics for\nincreased visibility. Only the tasks that Amazon ECS services create are supported with\nService Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html", "Properties": { "Services": { "MarkdownDocumentation": "`Services`\n\nThe list of Service Connect service objects. These are names and aliases (also known\nas 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\nnamespace only to connect to other services within the namespace. An example of this\nwould be a frontend application that accepts incoming requests from either a load\nbalancer 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\nservice, and a list of aliases (endpoints) and ports for client applications to refer to\nthis service.\n*Required*: No\n*Type*: Array of [ServiceConnectService](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html#cfn-ecs-service-serviceconnectconfiguration-services", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServiceConnectService", "DuplicatesAllowed": true }, "AccessLogConfiguration": { "MarkdownDocumentation": "`AccessLogConfiguration`\n\nThe configuration for Service Connect access logging. Access logs capture detailed\ninformation about requests made to your service, including request patterns, response\ncodes, and timing data. They can be useful for debugging connectivity issues, monitoring\nservice performance, and auditing service-to-service communication for security and\ncompliance purposes.\n###### Note\nTo enable access logs, you must also specify a `logConfiguration` in the `serviceConnectConfiguration`.\n*Required*: No\n*Type*: [ServiceConnectAccessLogConfiguration](./aws-properties-ecs-service-serviceconnectaccesslogconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html#cfn-ecs-service-serviceconnectconfiguration-accesslogconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ServiceConnectAccessLogConfiguration" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html#cfn-ecs-service-serviceconnectconfiguration-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe log configuration for the container. This parameter maps to `LogConfig`\nin the docker container create command and the `--log-driver` option to\ndocker run.\nBy default, containers use the same logging driver that the Docker daemon uses.\nHowever, the container might use a different logging driver than the Docker daemon by\nspecifying a log driver configuration in the container definition.\nUnderstand the following when specifying a log configuration for your\ncontainers.\n* Amazon ECS currently supports a subset of the logging drivers available to the\n Docker daemon. Additional log drivers may be available in future releases of the\n Amazon ECS container agent.\n \n For tasks on AWS Fargate, the supported log drivers are\n `awslogs`, `splunk`, and\n `awsfirelens`.\n \n For tasks hosted on Amazon EC2 instances, the supported log drivers are\n `awslogs`, `fluentd`, `gelf`,\n `json-file`, `journald`,`syslog`,\n `splunk`, and `awsfirelens`.\n* This parameter requires version 1.18 of the Docker Remote API or greater on\n your container instance.\n* For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container\n agent must register the available logging drivers with the\n `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before\n containers placed on that instance can use these log configuration options. For\n more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the\n *Amazon Elastic Container Service Developer\n Guide*.\n* For tasks that are on AWS Fargate, because you don't have access\n to the underlying infrastructure your tasks are hosted on, any additional\n software needed must be installed outside of the task. For example, the Fluentd\n output aggregators or a remote host running Logstash to send Gelf logs\n to.\n*Required*: No\n*Type*: [LogConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html#cfn-ecs-service-serviceconnectconfiguration-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogConfiguration" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace for use\nwith Service Connect. The namespace must be in the same AWS Region as the\nAmazon ECS service and cluster. The type of namespace doesn't affect Service Connect.\nFor more information about AWS Cloud Map, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html#cfn-ecs-service-serviceconnectconfiguration-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceConnectService": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectService`\n\nThe Service Connect service object configuration. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html", "Properties": { "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nA reference to an object that represents the configured timeouts for Service\nConnect.\n*Required*: No\n*Type*: [TimeoutConfiguration](./aws-properties-ecs-service-timeoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-timeout", "UpdateType": "Mutable", "Required": false, "Type": "TimeoutConfiguration" }, "IngressPortOverride": { "MarkdownDocumentation": "`IngressPortOverride`\n\nThe 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\nspecified in the named `portMapping` in the task definition of this\napplication, and then use it in your VPC security groups to allow traffic into the proxy\nfor this Amazon ECS service.\nIn `awsvpc` mode and Fargate, the default value is the container port\nnumber. The container port number is in the `portMapping` in the task\ndefinition. In bridge mode, the default value is the ephemeral port of the Service\nConnect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-ingressportoverride", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ClientAliases": { "MarkdownDocumentation": "`ClientAliases`\n\nThe list of client aliases for this Service Connect service. You use these to assign\nnames that can be used by client applications. The maximum number of client aliases that\nyou can have in this list is 1.\nEach alias (\"endpoint\") is a fully-qualified name and port number that other Amazon\nECS 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\n`clientAlias` with one `port`.\n*Required*: No\n*Type*: Array of [ServiceConnectClientAlias](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-clientaliases", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServiceConnectClientAlias", "DuplicatesAllowed": true }, "Tls": { "MarkdownDocumentation": "`Tls`\n\nA reference to an object that represents a Transport Layer Security (TLS)\nconfiguration.\n*Required*: No\n*Type*: [ServiceConnectTlsConfiguration](./aws-properties-ecs-service-serviceconnecttlsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-tls", "UpdateType": "Mutable", "Required": false, "Type": "ServiceConnectTlsConfiguration" }, "DiscoveryName": { "MarkdownDocumentation": "`DiscoveryName`\n\nThe `discoveryName` is the name of the new AWS Cloud Map service that Amazon ECS\ncreates for this Amazon ECS service. This must be unique within the AWS Cloud Map namespace. The\nname can contain up to 64 characters. The name can include lowercase letters, numbers,\nunderscores (\\_), and hyphens (-). The name can't start with a hyphen.\nIf the `discoveryName` isn't specified, the port mapping name from the task\ndefinition 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-discoveryname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PortName": { "MarkdownDocumentation": "`PortName`\n\nThe `portName` must match the name of one of the `portMappings`\nfrom 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-portname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceConnectTestTrafficRules": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectTestTrafficRules`\n\nThe test traffic routing configuration for Amazon ECS blue/green deployments. This\nconfiguration allows you to define rules for routing specific traffic to the new service\nrevision during the deployment process, allowing for safe testing before full production\ntraffic shift.\nFor more information, see [Service Connect for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-blue-green.html) in the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttesttrafficrules.html", "Properties": { "Header": { "MarkdownDocumentation": "`Header`\n\nThe HTTP header-based routing rules that determine which requests should be routed to the new service version during blue/green deployment testing. These rules provide fine-grained control over test traffic routing based on request headers.\n*Required*: Yes\n*Type*: [ServiceConnectTestTrafficRulesHeader](./aws-properties-ecs-service-serviceconnecttesttrafficrulesheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttesttrafficrules.html#cfn-ecs-service-serviceconnecttesttrafficrules-header", "UpdateType": "Mutable", "Required": true, "Type": "ServiceConnectTestTrafficRulesHeader" } } }, "AWS::ECS::Service.ServiceConnectTestTrafficRulesHeader": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectTestTrafficRulesHeader`\n\nThe `ServiceConnectTestTrafficRulesHeader` property type specifies Property description not available. for an [AWS::ECS::Service](./aws-resource-ecs-service.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttesttrafficrulesheader.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: No\n*Type*: [ServiceConnectTestTrafficRulesHeaderValue](./aws-properties-ecs-service-serviceconnecttesttrafficrulesheadervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttesttrafficrulesheader.html#cfn-ecs-service-serviceconnecttesttrafficrulesheader-value", "UpdateType": "Mutable", "Required": false, "Type": "ServiceConnectTestTrafficRulesHeaderValue" }, "Name": { "MarkdownDocumentation": "`Name`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttesttrafficrulesheader.html#cfn-ecs-service-serviceconnecttesttrafficrulesheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceConnectTestTrafficRulesHeaderValue": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectTestTrafficRulesHeaderValue`\n\nThe `ServiceConnectTestTrafficRulesHeaderValue` property type specifies Property description not available. for an [AWS::ECS::Service](./aws-resource-ecs-service.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttesttrafficrulesheadervalue.html", "Properties": { "Exact": { "MarkdownDocumentation": "`Exact`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttesttrafficrulesheadervalue.html#cfn-ecs-service-serviceconnecttesttrafficrulesheadervalue-exact", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceConnectTlsCertificateAuthority": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectTlsCertificateAuthority`\n\nThe certificate root authority that secures your service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttlscertificateauthority.html", "Properties": { "AwsPcaAuthorityArn": { "MarkdownDocumentation": "`AwsPcaAuthorityArn`\n\nThe ARN of the AWS Private Certificate Authority 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttlscertificateauthority.html#cfn-ecs-service-serviceconnecttlscertificateauthority-awspcaauthorityarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceConnectTlsConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceConnectTlsConfiguration`\n\nThe key that encrypts and decrypts your resources for Service Connect TLS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttlsconfiguration.html", "Properties": { "IssuerCertificateAuthority": { "MarkdownDocumentation": "`IssuerCertificateAuthority`\n\nThe signer certificate authority.\n*Required*: Yes\n*Type*: [ServiceConnectTlsCertificateAuthority](./aws-properties-ecs-service-serviceconnecttlscertificateauthority.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttlsconfiguration.html#cfn-ecs-service-serviceconnecttlsconfiguration-issuercertificateauthority", "UpdateType": "Mutable", "Required": true, "Type": "ServiceConnectTlsCertificateAuthority" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nThe AWS Key Management Service 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttlsconfiguration.html#cfn-ecs-service-serviceconnecttlsconfiguration-kmskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that's associated with the Service\nConnect TLS.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttlsconfiguration.html#cfn-ecs-service-serviceconnecttlsconfiguration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceManagedEBSVolumeConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceManagedEBSVolumeConfiguration`\n\nThe configuration for the Amazon EBS volume that Amazon ECS creates and manages on\nyour behalf. These settings are used to create each Amazon EBS volume, with one volume\ncreated for each task in the service. For information about the supported launch types\nand operating systems, see [Supported operating systems and launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volumes-configuration) in the *Amazon\nElastic Container Service Developer Guide*.\nMany of these parameters map 1:1 with the Amazon EBS `CreateVolume` API\nrequest parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html", "Properties": { "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained\nby the service. You must specify either `snapshotId` or\n`sizeInGiB` in your volume configuration. This parameter maps 1:1 with\nthe `SnapshotId` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in\nthe *Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-snapshotid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe volume type. This parameter maps 1:1 with the `VolumeType` parameter of\nthe [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For\nmore information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html)\nin the *Amazon EC2 User Guide*.\nThe following are the supported volume types.\n* General Purpose SSD: `gp2`|`gp3`\n* Provisioned IOPS SSD: `io1`|`io2`\n* Throughput Optimized HDD: `st1`\n* Cold HDD: `sc1`\n* Magnetic: `standard`\n \n ###### Note\n \n The magnetic volume type is not supported on 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-volumetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) identifier of the AWS Key Management Service key\nto use for Amazon EBS encryption. When a key is specified using this parameter, it\noverrides Amazon EBS default encryption or any KMS key that you specified for\ncluster-level managed storage encryption. This parameter maps 1:1 with the\n`KmsKeyId` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in\nthe *Amazon EC2 API Reference*. For more information about encrypting\nAmazon EBS volumes attached to tasks, see [Encrypt data stored in Amazon EBS volumes attached to Amazon ECS\ntasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html).\n###### Important\nAWS authenticates the AWS Key Management Service\nkey asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid,\nthe action can appear to complete, but eventually fails.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagSpecifications": { "MarkdownDocumentation": "`TagSpecifications`\n\nThe tags to apply to the volume. Amazon ECS applies service-managed tags by default.\nThis parameter maps 1:1 with the `TagSpecifications.N` parameter of the\n[CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API\nReference*.\n*Required*: No\n*Type*: Array of [EBSTagSpecification](./aws-properties-ecs-service-ebstagspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-tagspecifications", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EBSTagSpecification", "DuplicatesAllowed": true }, "FilesystemType": { "MarkdownDocumentation": "`FilesystemType`\n\nThe filesystem type for the volume. For volumes created from a snapshot, you must\nspecify the same filesystem type that the volume was using when the snapshot was\ncreated. If there is a filesystem type mismatch, the tasks will fail to start.\nThe available Linux filesystem types are\n `ext3`, `ext4`,\nand `xfs`. If no value is specified, the `xfs` filesystem type is\nused by default.\nThe available Windows filesystem types are `NTFS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ext3 | ext4 | xfs | ntfs...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ext3", "ext4", "xfs", "ntfs" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-filesystemtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nIndicates whether the volume should be encrypted. If you turn on Region-level Amazon\nEBS encryption by default but set this value as `false`, the setting is\noverridden and the volume is encrypted with the KMS key specified for Amazon EBS\nencryption by default. This parameter maps 1:1 with the `Encrypted` parameter\nof the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in\nthe *Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-encrypted", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Throughput": { "MarkdownDocumentation": "`Throughput`\n\nThe throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.\nThis parameter maps 1:1 with the `Throughput` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API\nReference*.\n###### Important\nThis parameter is only supported for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-throughput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeInitializationRate": { "MarkdownDocumentation": "`VolumeInitializationRate`\n\nThe rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume\nto create new volumes for attachment to the tasks maintained by the service. This\nproperty can be specified only if you specify a `snapshotId`. For more\ninformation, see [Initialize Amazon EBS\nvolumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EBS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-volumeinitializationrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS). For `gp3`,\n`io1`, and `io2` volumes, this represents the number of IOPS that\nare provisioned for the volume. For `gp2` volumes, this represents the\nbaseline performance of the volume and the rate at which the volume accumulates I/O\ncredits for bursting.\nThe following are the supported values for each volume type.\n* `gp3`: 3,000 - 16,000 IOPS\n* `io1`: 100 - 64,000 IOPS\n* `io2`: 100 - 256,000 IOPS\nThis parameter is required for `io1` and `io2` volume types. The\ndefault for `gp3` volumes is `3,000 IOPS`. This parameter is not\nsupported for `st1`, `sc1`, or `standard` volume\ntypes.\nThis parameter maps 1:1 with the `Iops` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API\nReference*.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-iops", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SizeInGiB": { "MarkdownDocumentation": "`SizeInGiB`\n\nThe size of the volume in GiB. You must specify either a volume size or a snapshot ID.\nIf you specify a snapshot ID, the snapshot size is used for the volume size by default.\nYou can optionally specify a volume size greater than or equal to the snapshot size.\nThis parameter maps 1:1 with the `Size` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API\nReference*.\nThe following are the supported volume size values for each volume type.\n* `gp2` and `gp3`: 1-16,384\n* `io1` and `io2`: 4-16,384\n* `st1` and `sc1`: 125-16,384\n* `standard`: 1-1,024\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-sizeingib", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role to associate with this volume. This is the Amazon ECS\ninfrastructure IAM role that is used to manage your AWS infrastructure. We\nrecommend using the Amazon ECS-managed\n`AmazonECSInfrastructureRolePolicyForVolumes` IAM policy with this role.\nFor more information, see [Amazon ECS\ninfrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer\nGuide*.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceRegistry": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceRegistry`\n\nThe details for the service registry.\nEach service may be associated with one service registry. Multiple service registries\nfor each service are not supported.\nWhen you add, update, or remove the service registries configuration, Amazon ECS\nstarts a new deployment. New tasks are registered and deregistered to the updated\nservice registry configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html", "Properties": { "ContainerName": { "MarkdownDocumentation": "`ContainerName`\n\nThe container name value to be used for your service discovery service. It's already\nspecified in the task definition. If the task definition that your service task\nspecifies uses the `bridge` or `host` network mode, you must\nspecify a `containerName` and `containerPort` combination from the\ntask definition. If the task definition that your service task specifies uses the\n`awsvpc` network mode and a type SRV DNS record is used, you must specify\neither a `containerName` and `containerPort` combination or a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port value used if your service discovery service specified an SRV record. This\nfield might be used if both the `awsvpc` network mode and SRV records are\nused.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ContainerPort": { "MarkdownDocumentation": "`ContainerPort`\n\nThe port value to be used for your service discovery service. It's already specified\nin the task definition. If the task definition your service task specifies uses the\n`bridge` or `host` network mode, you must specify a\n`containerName` and `containerPort` combination from the task\ndefinition. If the task definition your service task specifies uses the\n`awsvpc` network mode and a type SRV DNS record is used, you must specify\neither a `containerName` and `containerPort` combination or a\n`port` value. However, you can't specify both.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containerport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RegistryArn": { "MarkdownDocumentation": "`RegistryArn`\n\nThe Amazon Resource Name (ARN) of the service registry. The currently supported\nservice 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-registryarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::Service.ServiceVolumeConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.ServiceVolumeConfiguration`\n\nThe configuration for a volume specified in the task definition as a volume that is\nconfigured at launch time. Currently, the only supported volume type is an Amazon EBS\nvolume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicevolumeconfiguration.html", "Properties": { "ManagedEBSVolume": { "MarkdownDocumentation": "`ManagedEBSVolume`\n\nThe configuration for the Amazon EBS volume that Amazon ECS creates and manages on\nyour behalf. These settings are used to create each Amazon EBS volume, with one volume\ncreated for each task in the service. The Amazon EBS volumes are visible in your account\nin the Amazon EC2 console once they are created.\n*Required*: No\n*Type*: [ServiceManagedEBSVolumeConfiguration](./aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicevolumeconfiguration.html#cfn-ecs-service-servicevolumeconfiguration-managedebsvolume", "UpdateType": "Mutable", "Required": false, "Type": "ServiceManagedEBSVolumeConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the volume. This value must match the volume name from the\n`Volume` object in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicevolumeconfiguration.html#cfn-ecs-service-servicevolumeconfiguration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service.TimeoutConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.TimeoutConfiguration`\n\nAn object that represents the timeout configurations for Service Connect.\n###### Note\nIf `idleTimeout` is set to a time that is less than\n`perRequestTimeout`, the connection will close when the\n`idleTimeout` is reached and not the\n`perRequestTimeout`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-timeoutconfiguration.html", "Properties": { "PerRequestTimeoutSeconds": { "MarkdownDocumentation": "`PerRequestTimeoutSeconds`\n\nThe amount of time waiting for the upstream to respond with a complete response per\nrequest. A value of `0` can be set to disable `perRequestTimeout`.\n`perRequestTimeout` can only be set if Service Connect\n`appProtocol` isn't `TCP`. Only `idleTimeout` is\nallowed for `TCP``appProtocol`.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-timeoutconfiguration.html#cfn-ecs-service-timeoutconfiguration-perrequesttimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IdleTimeoutSeconds": { "MarkdownDocumentation": "`IdleTimeoutSeconds`\n\nThe amount of time in seconds a connection will stay active while idle. A value of\n`0` can be set to disable `idleTimeout`.\nThe `idleTimeout` default for\n`HTTP`/`HTTP2`/`GRPC` is 5 minutes.\nThe `idleTimeout` default for `TCP` is 1 hour.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-timeoutconfiguration.html#cfn-ecs-service-timeoutconfiguration-idletimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::Service.VpcLatticeConfiguration": { "MarkdownDocumentation": "`AWS::ECS::Service.VpcLatticeConfiguration`\n\nThe VPC Lattice configuration for your service that holds the information for the\ntarget group(s) Amazon ECS tasks will be registered to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-vpclatticeconfiguration.html", "Properties": { "TargetGroupArn": { "MarkdownDocumentation": "`TargetGroupArn`\n\nThe full Amazon Resource Name (ARN) of the target group or groups associated with the\nVPC Lattice configuration that the Amazon ECS tasks will be registered 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-vpclatticeconfiguration.html#cfn-ecs-service-vpclatticeconfiguration-targetgrouparn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PortName": { "MarkdownDocumentation": "`PortName`\n\nThe name of the port mapping to register in the VPC Lattice target group. This is the\nname of the `portMapping` you defined in your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-vpclatticeconfiguration.html#cfn-ecs-service-vpclatticeconfiguration-portname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role to associate with this VPC Lattice configuration. This is the\nAmazon ECS\u2028 infrastructure IAM role that is used to manage your VPC Lattice\ninfrastructure.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-vpclatticeconfiguration.html#cfn-ecs-service-vpclatticeconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.AuthorizationConfig": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.AuthorizationConfig`\n\nThe authorization configuration details for the Amazon EFS file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html", "Properties": { "IAM": { "MarkdownDocumentation": "`IAM`\n\nDetermines whether to use the Amazon ECS task role defined in a task definition when\nmounting the Amazon EFS file system. If it is turned on, transit encryption must be\nturned on in the `EFSVolumeConfiguration`. If this parameter is omitted, the\ndefault value of `DISABLED` is used. For more information, see [Using\nAmazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service\nDeveloper Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html#cfn-ecs-taskdefinition-authorizationconfig-iam", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AccessPointId": { "MarkdownDocumentation": "`AccessPointId`\n\nThe Amazon EFS access point ID to use. If an access point is specified, the root\ndirectory value specified in the `EFSVolumeConfiguration` must either be\nomitted or set to `/` which will enforce the path set on the EFS access\npoint. If an access point is used, transit encryption must be on in the\n`EFSVolumeConfiguration`. For more information, see [Working with Amazon\nEFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html#cfn-ecs-taskdefinition-authorizationconfig-accesspointid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.ContainerDefinition": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.ContainerDefinition`\n\nThe `ContainerDefinition` property specifies a container definition.\nContainer definitions are used in task definitions to describe the different containers\nthat are launched as part of a task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html", "Properties": { "User": { "MarkdownDocumentation": "`User`\n\nThe user to use inside the container. This parameter maps to `User` in the\ndocker container create command and the `--user` option to docker run.\n###### Important\nWhen running tasks using the `host` network mode, don't run containers\nusing the root user (UID 0). We recommend using a non-root user for better\nsecurity.\nYou can specify the `user` using the following formats. If specifying a UID\nor 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`\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-user", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Secrets": { "MarkdownDocumentation": "`Secrets`\n\nThe secrets to pass to the container. For more information, see [Specifying\nSensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: Array of [Secret](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-secrets", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Secret", "DuplicatesAllowed": true }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe amount (in MiB) of memory to present to the container. If your container attempts to\nexceed the memory specified here, the container is killed. The total amount of memory\nreserved for all containers within a task must be lower than the task `memory`\nvalue, if one is specified. This parameter maps to `Memory` in the [Create a\ncontainer](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\nrun](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\ncontainer-level memory value. If you specify both a container-level `memory` and\n`memoryReservation` value, `memory` must be greater than\n`memoryReservation`. If you specify `memoryReservation`, then that\nvalue is subtracted from the available memory resources for the container instance where\nthe 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\ncontainer, 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\ncontainer, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-memory", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Privileged": { "MarkdownDocumentation": "`Privileged`\n\nWhen this parameter is true, the container is given elevated privileges on the host\ncontainer instance (similar to the `root` user). This parameter maps to\n`Privileged` in the docker container create command and the\n`--privileged` option to docker run\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-privileged", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "HealthCheck": { "MarkdownDocumentation": "`HealthCheck`\n\nThe container health check command and associated configuration parameters for the\ncontainer. This parameter maps to `HealthCheck` in the docker container\ncreate command and the `HEALTHCHECK` parameter of docker run.\n*Required*: No\n*Type*: [HealthCheck](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-healthcheck", "UpdateType": "Immutable", "Required": false, "Type": "HealthCheck" }, "StartTimeout": { "MarkdownDocumentation": "`StartTimeout`\n\nTime duration (in seconds) to wait before giving up on resolving dependencies for a\ncontainer. For example, you specify two containers in a task definition with containerA\nhaving a dependency on containerB reaching a `COMPLETE`,\n`SUCCESS`, or `HEALTHY` status. If a `startTimeout`\nvalue is specified for containerB and it doesn't reach the desired status within that\ntime then containerA gives up and not start. This results in the task transitioning to a\n`STOPPED` state.\n###### Note\nWhen the `ECS_CONTAINER_START_TIMEOUT` container agent configuration\nvariable 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\nplatforms:\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\n`1.26.0` of the container agent to use a container start timeout value.\nHowever, we recommend using the latest container agent version. For information about\nchecking 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\nContainer Service Developer Guide*. If you're using an Amazon\nECS-optimized Linux AMI, your instance needs at least version `1.26.0-1` of\nthe `ecs-init` package. If your container instances are launched from version\n`20190301` or later, then they contain the required versions of the\ncontainer 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\nService Developer Guide*.\nThe valid values for Fargate are 2-120 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-starttimeout", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "VolumesFrom": { "MarkdownDocumentation": "`VolumesFrom`\n\nData volumes to mount from another container. This parameter maps to\n`VolumesFrom` in the docker container create command and the\n`--volumes-from` option to docker run.\n*Required*: No\n*Type*: Array of [VolumeFrom](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "VolumeFrom", "DuplicatesAllowed": false }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe number of `cpu` units reserved for the container. This parameter maps\nto `CpuShares` in the docker container create command and the\n`--cpu-shares` option to docker run.\nThis field is optional for tasks using the Fargate launch type, and the only\nrequirement is that the total amount of CPU reserved for all containers within a task be\nlower than the task-level `cpu` value.\n###### Note\nYou can determine the number of CPU units that are available per EC2 instance type\nby multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://aws.amazon.com/ec2/instance-types/) detail\npage by 1,024.\nLinux containers share unallocated CPU units with other containers on the container\ninstance with the same ratio as their allocated amount. For example, if you run a\nsingle-container task on a single-core instance type with 512 CPU units specified for\nthat container, and that's the only task running on the container instance, that\ncontainer could use the full 1,024 CPU unit share at any given time. However, if you\nlaunched another copy of the same task on that container instance, each task is\nguaranteed a minimum of 512 CPU units when needed. Moreover, each container could float\nto higher CPU usage if the other container was not using it. If both tasks were 100%\nactive 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\nvalue to calculate the relative CPU share ratios for running containers. The minimum\nvalid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share\nvalue that the Linux kernel allows is 262144. However, the CPU parameter isn't required,\nand you can use CPU values below 2 or above 262144 in your container definitions. For\nCPU values below 2 (including null) or above 262144, the behavior varies based on your\nAmazon ECS container agent version:\n* **Agent versions less than or equal to 1.1.0:**\n Null and zero CPU values are passed to Docker as 0, which Docker then converts\n to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux\n kernel converts to two CPU shares.\n* **Agent versions greater than or equal to 1.2.0:**\n Null, zero, and CPU values of 1 are passed to Docker as 2.\n* **Agent versions greater than or equal to\n 1.84.0:** CPU values greater than 256 vCPU are passed to Docker as\n 256, which is equivalent to 262144 CPU shares.\nOn Windows container instances, the CPU limit is enforced as an absolute limit, or a\nquota. Windows containers only have access to the specified amount of CPU that's\ndescribed in the task definition. A null or zero CPU value is passed to Docker as\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-cpu", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "EntryPoint": { "MarkdownDocumentation": "`EntryPoint`\n\n###### Important\nEarly versions of the Amazon ECS container agent don't properly handle\n`entryPoint` parameters. If you have problems using\n`entryPoint`, update your container agent or enter your commands and\narguments as `command` array items instead.\nThe entry point that's passed to the container. This parameter maps to\n`Entrypoint` in the docker container create command and the\n`--entrypoint` option to docker run.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-entrypoint", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DnsServers": { "MarkdownDocumentation": "`DnsServers`\n\nA list of DNS servers that are presented to the container. This parameter maps to\n`Dns` in the docker container create command and the `--dns`\noption to docker run.\n###### Note\nThis parameter is not supported for Windows containers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-dnsservers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ReadonlyRootFilesystem": { "MarkdownDocumentation": "`ReadonlyRootFilesystem`\n\nWhen this parameter is true, the container is given read-only access to its root file\nsystem. This parameter maps to `ReadonlyRootfs` in the docker container\ncreate command and the `--read-only` option to docker run.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-readonlyrootfilesystem", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Image": { "MarkdownDocumentation": "`Image`\n\nThe image used to start a container. This string is passed directly to the Docker\ndaemon. By default, images in the Docker Hub registry are available. Other repositories\nare specified with either `repository-url/image:tag` or `repository-url/image@digest`. For images using tags (repository-url/image:tag), up to 255 characters total\nare allowed, including letters (uppercase and lowercase), numbers, hyphens, underscores,\ncolons, periods, forward slashes, and number signs (#). For images using digests\n(repository-url/image@digest), the 255 character limit applies only to the repository\nURL and image name (everything before the @ sign). The only supported hash function is\nsha256, and the hash value after sha256: must be exactly 64 characters (only letters\nA-F, a-f, and numbers 0-9 are allowed). This parameter maps to `Image` in the\ndocker container create command and the `IMAGE` parameter of docker\nrun.\n* When a new task starts, the Amazon ECS container agent pulls the latest\n version of the specified image and tag for the container to use. However,\n subsequent updates to a repository image aren't propagated to already running\n tasks.\n* Images in Amazon ECR repositories can be specified by either using the full\n `registry/repository:tag` or\n `registry/repository@digest`. For example,\n `012345678910.dkr.ecr..amazonaws.com/:latest`\n or\n `012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`.\n* Images in official repositories on Docker Hub use a single name (for example,\n `ubuntu` or `mongo`).\n* Images in other repositories on Docker Hub are qualified with an organization\n name (for example, `amazon/amazon-ecs-agent`).\n* Images in other online repositories are qualified further by a domain name\n (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-image", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Essential": { "MarkdownDocumentation": "`Essential`\n\nIf the `essential` parameter of a container is marked as `true`,\nand that container fails or stops for any reason, all other containers that are part of\nthe task are stopped. If the `essential` parameter of a container is marked\nas `false`, its failure doesn't affect the rest of the containers in a task.\nIf 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\nthat's composed of multiple containers, group containers that are used for a common\npurpose into components, and separate the different components into multiple task\ndefinitions. For more information, see [Application\nArchitecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-essential", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe log configuration specification for the container.\nThis parameter maps to `LogConfig` in the docker Create a\ncontainer command and the `--log-driver` option to docker run. By default,\ncontainers use the same logging driver that the Docker daemon uses. However, the container\nmay use a different logging driver than the Docker daemon by specifying a log driver with\nthis parameter in the container definition. To use a different logging driver for a\ncontainer, the log system must be configured properly on the container instance (or on a\ndifferent log server for remote logging options). For more information on the options for\ndifferent supported log drivers, see [Configure logging\ndrivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n###### Note\nAmazon ECS currently supports a subset of the logging drivers available to the Docker\ndaemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in\nfuture releases of the Amazon ECS container agent.\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\ncontainer instance. To check the Docker Remote API version on your container instance, log\nin to your container instance and run the following command: `sudo docker version\n--format '{{.Server.APIVersion}}'`\n###### Note\nThe Amazon ECS container agent running on a container instance must register the\nlogging drivers available on that instance with the\n`ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers\nplaced on that instance can use these log configuration options. For more information,\nsee [Amazon ECS Container\nAgent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service\nDeveloper Guide*.\n*Required*: No\n*Type*: [LogConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "LogConfiguration" }, "ResourceRequirements": { "MarkdownDocumentation": "`ResourceRequirements`\n\nThe type and amount of a resource to assign to a container. The only supported\nresource is a GPU.\n*Required*: No\n*Type*: Array of [ResourceRequirement](./aws-properties-ecs-taskdefinition-resourcerequirement.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-resourcerequirements", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ResourceRequirement", "DuplicatesAllowed": true }, "EnvironmentFiles": { "MarkdownDocumentation": "`EnvironmentFiles`\n\nA list of files containing the environment variables to pass to a container. This\nparameter maps to the `--env-file` option to docker run.\nYou can specify up to ten environment files. The file must have a `.env`\nfile extension. Each line in an environment file contains an environment variable in\n`VARIABLE=VALUE` format. Lines beginning with `#` are treated\nas comments and are ignored.\nIf there are environment variables specified using the `environment`\nparameter in a container definition, they take precedence over the variables contained\nwithin an environment file. If multiple environment files are specified that contain the\nsame variable, they're processed from the top down. We recommend that you use unique\nvariable names. For more information, see [Specifying Environment\nVariables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: Array of [EnvironmentFile](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-environmentfiles", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "EnvironmentFile", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a container. If you're linking multiple containers together in a task\ndefinition, the `name` of one container can be entered in the\n`links` of another container to connect the containers. Up to 255 letters\n(uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter\nmaps to `name` in the docker container create command and the\n`--name` option to docker run.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FirelensConfiguration": { "MarkdownDocumentation": "`FirelensConfiguration`\n\nThe FireLens configuration for the container. This is used to specify and configure a\nlog router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\n*Type*: [FirelensConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-firelensconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "FirelensConfiguration" }, "DockerSecurityOptions": { "MarkdownDocumentation": "`DockerSecurityOptions`\n\nA list of strings to provide custom configuration for multiple security systems. This\nfield isn't valid for containers in tasks using the Fargate launch type.\nFor Linux tasks on EC2, this parameter can be used to reference custom labels for\nSELinux and AppArmor multi-level security systems.\nFor any tasks on EC2, this parameter can be used to reference a credential spec file\nthat configures a container for Active Directory authentication. For more information,\nsee [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux\nContainers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer\nGuide*.\nThis parameter maps to `SecurityOpt` in the docker container create command\nand the `--security-opt` option to docker run.\n###### Note\nThe Amazon ECS container agent running on a container instance must register with\nthe `ECS_SELINUX_CAPABLE=true` or `ECS_APPARMOR_CAPABLE=true`\nenvironment variables before containers placed on that instance can use these\nsecurity options. For more information, see [Amazon ECS Container\nAgent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service\nDeveloper Guide*.\nValid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\"credentialspec:CredentialSpecFilePath\"\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-dockersecurityoptions", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SystemControls": { "MarkdownDocumentation": "`SystemControls`\n\nA list of namespaced kernel parameters to set in the container. This parameter maps to\n`Sysctls` in the docker container create command and the\n`--sysctl` option to docker run. For example, you can configure\n`net.ipv4.tcp_keepalive_time` setting to maintain longer lived\nconnections.\n*Required*: No\n*Type*: Array of [SystemControl](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-systemcontrols", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "SystemControl", "DuplicatesAllowed": true }, "Interactive": { "MarkdownDocumentation": "`Interactive`\n\nWhen this parameter is `true`, you can deploy containerized applications\nthat require `stdin` or a `tty` to be allocated. This parameter\nmaps to `OpenStdin` in the docker container create command and the\n`--interactive` option to docker run.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-interactive", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DnsSearchDomains": { "MarkdownDocumentation": "`DnsSearchDomains`\n\nA list of DNS search domains that are presented to the container. This parameter maps\nto `DnsSearch` in the docker container create command and the\n`--dns-search` option to docker run.\n###### Note\nThis parameter is not supported for Windows containers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-dnssearchdomains", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CredentialSpecs": { "MarkdownDocumentation": "`CredentialSpecs`\n\nA list of ARNs in SSM or Amazon S3 to a credential spec (`CredSpec`) file\nthat configures the container for Active Directory authentication. We recommend that you\nuse this parameter instead of the `dockerSecurityOptions`. The maximum number\nof ARNs is 1.\nThere are two formats for each ARN.\ncredentialspecdomainless:MyARN\nYou use `credentialspecdomainless:MyARN` to provide a\n`CredSpec` with an additional section for a secret in AWS Secrets Manager. You provide the login credentials to the domain in the\nsecret.\nEach task that runs on any container instance can join different\ndomains.\nYou can use this format without joining the container instance to a\ndomain.\n\ncredentialspec:MyARN\nYou use `credentialspec:MyARN` to provide a\n`CredSpec` for a single domain.\nYou must join the container instance to the domain before you start any\ntasks that use this task definition.\n\nIn both formats, replace `MyARN` with the ARN in SSM or Amazon S3.\nIf you provide a `credentialspecdomainless:MyARN`, the\n`credspec` must provide a ARN in AWS Secrets Manager for a secret containing the\nusername, password, and the domain to connect to. For better security, the instance\nisn't joined to the domain for domainless authentication. Other applications on the\ninstance can't use the domainless credentials. You can use this parameter to run tasks\non the same instance, even it the tasks need to join different domains. For more\ninformation, see [Using gMSAs for Windows\nContainers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux\nContainers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-credentialspecs", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Ulimits": { "MarkdownDocumentation": "`Ulimits`\n\nA list of `ulimits` to set in the container. This parameter maps to\n`Ulimits` in the [Create a\ncontainer](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\nvalues are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This\nparameter requires version 1.18 of the Docker Remote API or greater on your container\ninstance. To check the Docker Remote API version on your container instance, log in to your\ncontainer instance and run the following command: `sudo docker version --format\n'{{.Server.APIVersion}}'`\n###### Note\nThis parameter is not supported for Windows containers.\n*Required*: No\n*Type*: Array of [Ulimit](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-ulimits", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Ulimit", "DuplicatesAllowed": true }, "StopTimeout": { "MarkdownDocumentation": "`StopTimeout`\n\nTime duration (in seconds) to wait before the container is forcefully killed if it\ndoesn't exit normally on its own.\nFor tasks using the Fargate launch type, the task or service requires the following\nplatforms:\n* Linux platform version `1.3.0` or later.\n* Windows platform version `1.0.0` or later.\nFor tasks that use the Fargate launch type, the max stop timeout value is 120 seconds\nand 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\nisn't specified, the value set for the Amazon ECS container agent configuration variable\n`ECS_CONTAINER_STOP_TIMEOUT` is used. If neither the\n`stopTimeout` parameter or the `ECS_CONTAINER_STOP_TIMEOUT`\nagent configuration variable are set, then the default values of 30 seconds for Linux\ncontainers and 30 seconds on Windows containers are used. Your container instances\nrequire at least version 1.26.0 of the container agent to use a container stop timeout\nvalue. However, we recommend using the latest container agent version. For information\nabout 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\nContainer Service Developer Guide*. If you're using an Amazon\nECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n`ecs-init` package. If your container instances are launched from version\n`20190301` or later, then they contain the required versions of the\ncontainer 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\nService Developer Guide*.\nThe valid values for Fargate are 2-120 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-stoptimeout", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "WorkingDirectory": { "MarkdownDocumentation": "`WorkingDirectory`\n\nThe working directory to run commands inside the container in. This parameter maps to\n`WorkingDir` in the docker container create command and the\n`--workdir` option to docker run.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-workingdirectory", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MemoryReservation": { "MarkdownDocumentation": "`MemoryReservation`\n\nThe soft limit (in MiB) of memory to reserve for the container. When system memory is\nunder heavy contention, Docker attempts to keep the container memory to this soft limit.\nHowever, your container can consume more memory when it needs to, up to either the hard\nlimit specified with the `memory` parameter (if applicable), or all of the\navailable memory on the container instance, whichever comes first. This parameter maps\nto `MemoryReservation` in the docker container create command and the\n`--memory-reservation` option to docker run.\nIf a task-level memory value is not specified, you must specify a non-zero integer for\none or both of `memory` or `memoryReservation` in a container\ndefinition. If you specify both, `memory` must be greater than\n`memoryReservation`. If you specify `memoryReservation`, then\nthat value is subtracted from the available memory resources for the container instance\nwhere the container is placed. Otherwise, the value of `memory` is\nused.\nFor example, if your container normally uses 128 MiB of memory, but occasionally\nbursts to 256 MiB of memory for short periods of time, you can set a\n`memoryReservation` of 128 MiB, and a `memory` hard limit of\n300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\nfrom the remaining resources on the container instance, but also allow the container to\nconsume more memory resources when needed.\nThe Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\ncontainer. 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\ncontainer. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-memoryreservation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "RepositoryCredentials": { "MarkdownDocumentation": "`RepositoryCredentials`\n\nThe private repository authentication credentials to use.\n*Required*: No\n*Type*: [RepositoryCredentials](./aws-properties-ecs-taskdefinition-repositorycredentials.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-repositorycredentials", "UpdateType": "Immutable", "Required": false, "Type": "RepositoryCredentials" }, "ExtraHosts": { "MarkdownDocumentation": "`ExtraHosts`\n\nA list of hostnames and IP address mappings to append to the `/etc/hosts`\nfile on the container. This parameter maps to `ExtraHosts` in the docker\ncontainer create command and the `--add-host` option to docker run.\n###### Note\nThis parameter isn't supported for Windows containers or tasks that use the\n`awsvpc` network mode.\n*Required*: No\n*Type*: Array of [HostEntry](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-extrahosts", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "HostEntry", "DuplicatesAllowed": true }, "Hostname": { "MarkdownDocumentation": "`Hostname`\n\nThe hostname to use for your container. This parameter maps to `Hostname`\nin the docker container create command and the `--hostname` option to docker\nrun.\n###### Note\nThe `hostname` parameter is not supported if you're using the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-hostname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LinuxParameters": { "MarkdownDocumentation": "`LinuxParameters`\n\nLinux-specific modifications that are applied to the container, such as Linux kernel\ncapabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).\n###### Note\nThis parameter is not supported for Windows containers.\n*Required*: No\n*Type*: [LinuxParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-linuxparameters", "UpdateType": "Immutable", "Required": false, "Type": "LinuxParameters" }, "VersionConsistency": { "MarkdownDocumentation": "`VersionConsistency`\n\nSpecifies whether Amazon ECS will resolve the container image tag provided in the\ncontainer definition to an image digest. By default, the value is `enabled`.\nIf you set the value for a container as `disabled`, Amazon ECS will not\nresolve the provided container image tag to a digest and will use the original image URI\nspecified in the container definition for deployment. For more information about\ncontainer image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer\nGuide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `enabled | disabled...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "enabled", "disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-versionconsistency", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RestartPolicy": { "MarkdownDocumentation": "`RestartPolicy`\n\nThe restart policy for a container. When you set up a restart policy, Amazon ECS can\nrestart the container without needing to replace the task. For more information, see\n[Restart\nindividual containers in Amazon ECS tasks with container restart policies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html) in\nthe *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\n*Type*: [RestartPolicy](./aws-properties-ecs-taskdefinition-restartpolicy.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-restartpolicy", "UpdateType": "Immutable", "Required": false, "Type": "RestartPolicy" }, "DisableNetworking": { "MarkdownDocumentation": "`DisableNetworking`\n\nWhen this parameter is true, networking is off within the container. This parameter\nmaps to `NetworkDisabled` in the docker container create command.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-disablenetworking", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "PseudoTerminal": { "MarkdownDocumentation": "`PseudoTerminal`\n\nWhen this parameter is `true`, a TTY is allocated. This parameter maps to\n`Tty` in the docker container create command and the `--tty`\noption to docker run.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-pseudoterminal", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MountPoints": { "MarkdownDocumentation": "`MountPoints`\n\nThe mount points for data volumes in your container.\nThis parameter maps to `Volumes` in the docker container create command and\nthe `--volume` option to docker run.\nWindows containers can mount whole directories on the same drive as\n`$env:ProgramData`. Windows containers can't mount directories on a\ndifferent drive, and mount point can't be across drives.\n*Required*: No\n*Type*: Array of [MountPoint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "MountPoint", "DuplicatesAllowed": false }, "DependsOn": { "MarkdownDocumentation": "`DependsOn`\n\nThe dependencies defined for container startup and shutdown. A container can contain\nmultiple dependencies. When a dependency is defined for container startup, for container\nshutdown it is reversed.\nFor tasks using the EC2 launch type, the container instances require at least version\n1.26.0 of the container agent to turn on container dependencies. However, we recommend\nusing the latest container agent version. For information about checking your agent version\nand updating to the latest version, see [Updating the Amazon ECS\nContainer Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer\nGuide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs\nat least version 1.26.0-1 of the `ecs-init` package. If your container instances\nare launched from version `20190301` or later, then they contain the required\nversions of the container agent and `ecs-init`. For more information, see [Amazon\nECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service\nDeveloper Guide*.\nFor tasks using the Fargate launch type, the task or service requires the following\nplatforms:\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\n`dependsOn` parameter is not supported.\n*Required*: No\n*Type*: Array of [ContainerDependency](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-dependson", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ContainerDependency", "DuplicatesAllowed": true }, "DockerLabels": { "MarkdownDocumentation": "`DockerLabels`\n\nA key/value map of labels to add to the container. This parameter maps to\n`Labels` in the docker container create command and the\n`--label` option to docker run. This parameter requires version 1.18 of\nthe Docker Remote API or greater on your container instance. To check the Docker Remote\nAPI version on your container instance, log in to your container instance and run the\nfollowing command: `sudo docker version --format '{{.Server.APIVersion}}'`\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-dockerlabels", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "PortMappings": { "MarkdownDocumentation": "`PortMappings`\n\nThe list of port mappings for the container. Port mappings allow containers to access\nports on the host container instance to send or receive traffic.\nFor task definitions that use the `awsvpc` network mode, you should only\nspecify the `containerPort`. The `hostPort` can be left blank or it\nmust be the same value as the `containerPort`.\nPort mappings on Windows use the `NetNAT` gateway address rather than\n`localhost`. There is no loopback for port mappings on Windows, so you cannot\naccess a container's mapped port from the host itself.\nThis parameter maps to `PortBindings` in the [Create a\ncontainer](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\nmode of a task definition is set to `none`, then you can't specify port\nmappings. If the network mode of a task definition is set to `host`, then host\nports must either be undefined or they must match the container port in the port\nmapping.\n###### Note\nAfter a task reaches the `RUNNING` status, manual and automatic host and\ncontainer port assignments are visible in the **Network\nBindings** section of a container description for a selected task in the\nAmazon ECS console. The assignments are also visible in the `networkBindings`\nsection [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html)\nresponses.\n*Required*: No\n*Type*: Array of [PortMapping](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-portmappings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "PortMapping", "DuplicatesAllowed": false }, "Command": { "MarkdownDocumentation": "`Command`\n\nThe command that's passed to the container. This parameter maps to `Cmd` in\nthe docker container create command and the `COMMAND` parameter to docker\nrun. If there are multiple arguments, each argument is a separated string in the\narray.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-command", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nThe environment variables to pass to a container. This parameter maps to\n`Env` in the docker container create command and the `--env`\noption to docker run.\n###### Important\nWe don't recommend that you use plaintext environment variables for sensitive\ninformation, such as credential data.\n*Required*: No\n*Type*: Array of [KeyValuePair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-environment", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "KeyValuePair", "DuplicatesAllowed": false }, "Links": { "MarkdownDocumentation": "`Links`\n\nThe `links` parameter allows containers to communicate with each other\nwithout the need for port mappings. This parameter is only supported if the network mode\nof a task definition is `bridge`. The `name:internalName`\nconstruct is analogous to `name:alias` in Docker links. Up to 255 letters\n(uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This\nparameter maps to `Links` in the docker container create command and the\n`--link` option to docker run.\n###### Note\nThis parameter is not supported for Windows containers.\n\n###### Important\nContainers that are collocated on a single container instance may be able to\ncommunicate with each other without requiring links or host port mappings. Network\nisolation is achieved on the container instance using security groups and VPC\nsettings.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-links", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ECS::TaskDefinition.ContainerDependency": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.ContainerDependency`\n\nThe `ContainerDependency` property specifies the dependencies defined for\ncontainer startup and shutdown. A container can contain multiple dependencies. When a\ndependency is defined for container startup, for container shutdown it is reversed.\nYour Amazon ECS container instances require at least version 1.26.0 of the container\nagent to enable container dependencies. However, we recommend using the latest container\nagent version. For information about checking your agent version and updating to the latest\nversion, see [Updating the Amazon ECS\nContainer Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer\nGuide*. If you are using an Amazon ECS-optimized Linux AMI, your instance\nneeds at least version 1.26.0-1 of the `ecs-init` package. If your container\ninstances are launched from version `20190301` or later, then they contain the\nrequired versions of the container agent and `ecs-init`. For more information,\nsee [Amazon ECS-optimized Linux\nAMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n###### Note\nFor tasks using the Fargate launch type, this parameter requires that the task or\nservice uses platform version 1.3.0 or later.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nThe dependency condition of the container. The following are the available conditions\nand their behavior:\n* `START` - This condition emulates the behavior of links and volumes\n today. It validates that a dependent container is started before permitting\n other containers to start.\n* `COMPLETE` - This condition validates that a dependent container\n runs to completion (exits) before permitting other containers to start. This can\n be useful for nonessential containers that run a script and then exit. This\n condition can't be set on an essential container.\n* `SUCCESS` - This condition is the same as `COMPLETE`,\n but it also requires that the container exits with a `zero` status.\n This condition can't be set on an essential container.\n* `HEALTHY` - This condition validates that the dependent container\n passes its Docker health check before permitting other containers to start. This\n requires that the dependent container has health checks configured. This\n condition is confirmed only at task startup.\n*Required*: No\n*Type*: String\n*Allowed values*: `START | COMPLETE | SUCCESS ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "START", "COMPLETE", "SUCCESS", "HEALTHY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-condition", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ContainerName": { "MarkdownDocumentation": "`ContainerName`\n\nThe name of a container.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-containername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.Device": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.Device`\n\nThe `Device` property specifies an object representing a container instance\nhost device.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html", "Properties": { "HostPath": { "MarkdownDocumentation": "`HostPath`\n\nThe path for the device on the host container 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-hostpath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nThe explicit permissions to provide to the container for the device. By default, the\ncontainer has permissions for `read`, `write`, and\n`mknod` for the device.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-permissions", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ContainerPath": { "MarkdownDocumentation": "`ContainerPath`\n\nThe path inside the container at which to expose the host device.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-containerpath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.DockerVolumeConfiguration": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.DockerVolumeConfiguration`\n\nThe `DockerVolumeConfiguration` property specifies a Docker volume\nconfiguration and is used when you use Docker volumes. Docker volumes are only supported\nwhen you are using the EC2 launch type. Windows containers only support the use of the\n`local` driver. To use bind mounts, specify a `host`\ninstead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html", "Properties": { "DriverOpts": { "MarkdownDocumentation": "`DriverOpts`\n\nA map of Docker driver-specific options passed through. This parameter maps to\n`DriverOpts` in the docker create-volume command and the\n`xxopt` option to docker volume create.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driveropts", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope for the Docker volume that determines its lifecycle. Docker volumes that are\nscoped to a `task` are automatically provisioned when the task starts and\ndestroyed when the task stops. Docker volumes that are scoped as `shared`\npersist after the task stops.\n*Required*: No\n*Type*: String\n*Allowed values*: `task | shared...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "task", "shared" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-scope", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Autoprovision": { "MarkdownDocumentation": "`Autoprovision`\n\nIf this value is `true`, the Docker volume is created if it doesn't already\nexist.\n###### Note\nThis field is only used if the `scope` is `shared`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-autoprovision", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Driver": { "MarkdownDocumentation": "`Driver`\n\nThe Docker volume driver to use. The driver value must match the driver name provided\nby Docker because it is used for task placement. If the driver was installed using the\nDocker plugin CLI, use `docker plugin ls` to retrieve the driver name from\nyour container instance. If the driver was installed using another method, use Docker\nplugin discovery to retrieve the driver name. This parameter maps to `Driver`\nin the docker container create command and the `xxdriver` option to docker\nvolume 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driver", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Labels": { "MarkdownDocumentation": "`Labels`\n\nCustom metadata to add to your Docker volume. This parameter maps to\n`Labels` in the docker container create command and the\n`xxlabel` option to docker volume create.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-labels", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ECS::TaskDefinition.EFSVolumeConfiguration": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.EFSVolumeConfiguration`\n\nThis parameter is specified when you're using an Amazon Elastic File System file\nsystem for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in\nthe *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html", "Properties": { "FilesystemId": { "MarkdownDocumentation": "`FilesystemId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-filesystemid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TransitEncryption": { "MarkdownDocumentation": "`TransitEncryption`\n\nDetermines whether to use encryption for Amazon EFS data in transit between the Amazon\nECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS\nIAM authorization is used. If this parameter is omitted, the default value of\n`DISABLED` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in\nthe *Amazon Elastic File System User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-transitencryption", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AuthorizationConfig": { "MarkdownDocumentation": "`AuthorizationConfig`\n\nThe authorization configuration details for the Amazon EFS file system.\n*Required*: No\n*Type*: [AuthorizationConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-authorizationconfig", "UpdateType": "Immutable", "Required": false, "Type": "AuthorizationConfig" }, "RootDirectory": { "MarkdownDocumentation": "`RootDirectory`\n\nThe directory within the Amazon EFS file system to mount as the root directory inside\nthe host. If this parameter is omitted, the root of the Amazon EFS volume will be used.\nSpecifying `/` will have the same effect as omitting this parameter.\n###### Important\nIf an EFS access point is specified in the `authorizationConfig`, the\nroot directory parameter must either be omitted or set to `/` which will\nenforce 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-rootdirectory", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TransitEncryptionPort": { "MarkdownDocumentation": "`TransitEncryptionPort`\n\nThe port to use when sending encrypted data between the Amazon ECS host and the Amazon\nEFS server. If you do not specify a transit encryption port, it will use the port\nselection strategy that the Amazon EFS mount helper uses. For more information, see\n[EFS mount\nhelper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-transitencryptionport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::TaskDefinition.EnvironmentFile": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.EnvironmentFile`\n\nA list of files containing the environment variables to pass to a container. You can\nspecify up to ten environment files. The file must have a `.env` file\nextension. Each line in an environment file should contain an environment variable in\n`VARIABLE=VALUE` format. Lines beginning with `#` are treated\nas comments and are ignored.\nIf there are environment variables specified using the `environment`\nparameter in a container definition, they take precedence over the variables contained\nwithin an environment file. If multiple environment files are specified that contain the\nsame variable, they're processed from the top down. We recommend that you use unique\nvariable names. For more information, see [Use a file to pass\nenvironment variables to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) in the *Amazon Elastic\nContainer Service Developer Guide*.\nEnvironment variable files are objects in Amazon S3 and all Amazon S3 security\nconsiderations apply.\nYou must use the following platforms for the Fargate launch type:\n* Linux platform version `1.4.0` or later.\n* Windows platform version `1.0.0` or later.\nConsider the following when using the Fargate launch type:\n* The file is handled like a native Docker env-file.\n* There is no support for shell escape handling.\n* The container entry point interperts the `VARIABLE` values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe file type to use. Environment files are objects in Amazon S3. The only supported\nvalue 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)\n", "RefReturnValue": "", "AllowedValues": [ "s3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html#cfn-ecs-taskdefinition-environmentfile-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe Amazon Resource Name (ARN) of the Amazon S3 object containing the environment\nvariable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html#cfn-ecs-taskdefinition-environmentfile-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.EphemeralStorage": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.EphemeralStorage`\n\nThe amount of ephemeral storage to allocate for the task. This parameter is used to\nexpand the total amount of ephemeral storage available, beyond the default amount, for\ntasks hosted on AWS Fargate. For more information, see [Using data volumes in\ntasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*.\n###### Note\nFor tasks using the Fargate launch type, the task requires the following\nplatforms:\n* Linux platform version `1.4.0` or later.\n* Windows platform version `1.0.0` or later.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ephemeralstorage.html", "Properties": { "SizeInGiB": { "MarkdownDocumentation": "`SizeInGiB`\n\nThe total amount, in GiB, of ephemeral storage to set for the task. The minimum\nsupported value is `21` GiB and the maximum supported value is\n`200` GiB.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ephemeralstorage.html#cfn-ecs-taskdefinition-ephemeralstorage-sizeingib", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::TaskDefinition.FSxAuthorizationConfig": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.FSxAuthorizationConfig`\n\nThe authorization configuration details for Amazon FSx for Windows File Server file\nsystem. See [FSxWindowsFileServerVolumeConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html) in the *Amazon ECS API\nReference*.\nFor more information and the input format, see [Amazon FSx for Windows File\nServer Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxauthorizationconfig.html", "Properties": { "CredentialsParameter": { "MarkdownDocumentation": "`CredentialsParameter`\n\nThe authorization credential option to use. The authorization credential options can\nbe provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or SSM\nParameter Store parameter. The ARN refers to the stored credentials.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxauthorizationconfig.html#cfn-ecs-taskdefinition-fsxauthorizationconfig-credentialsparameter", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nA fully qualified domain name hosted by an [AWS Directory Service](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) Managed Microsoft AD (Active Directory) or self-hosted\nAD on Amazon EC2.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxauthorizationconfig.html#cfn-ecs-taskdefinition-fsxauthorizationconfig-domain", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.FSxWindowsFileServerVolumeConfiguration": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.FSxWindowsFileServerVolumeConfiguration`\n\nThis parameter is specified when you're using [Amazon FSx for Windows File\nServer](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage.\nFor more information and the input format, see [Amazon FSx for Windows File\nServer volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration.html", "Properties": { "AuthorizationConfig": { "MarkdownDocumentation": "`AuthorizationConfig`\n\nThe authorization configuration details for the Amazon FSx for Windows File Server\nfile system.\n*Required*: No\n*Type*: [FSxAuthorizationConfig](./aws-properties-ecs-taskdefinition-fsxauthorizationconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration.html#cfn-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration-authorizationconfig", "UpdateType": "Immutable", "Required": false, "Type": "FSxAuthorizationConfig" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe Amazon FSx for Windows File Server 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration.html#cfn-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration-filesystemid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RootDirectory": { "MarkdownDocumentation": "`RootDirectory`\n\nThe directory within the Amazon FSx for Windows File Server file system to mount as\nthe root directory inside the host.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration.html#cfn-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration-rootdirectory", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.FirelensConfiguration": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.FirelensConfiguration`\n\nThe FireLens configuration for the container. This is used to specify and configure a\nlog router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nThe options to use when configuring the log router. This field is optional and can be\nused to add additional metadata, such as the task, task definition, cluster, and container\ninstance details to the log event.\nIf specified, valid option keys are:\n* `enable-ecs-log-metadata`, which can be `true` or\n `false`\n* `config-file-type`, which can be `s3` or `file`\n* `config-file-value`, which is either an S3 ARN or a file path\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html#cfn-ecs-taskdefinition-firelensconfiguration-options", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe log router to use. The valid values are `fluentd` or\n`fluentbit`.\n*Required*: No\n*Type*: String\n*Allowed values*: `fluentd | fluentbit...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "fluentd", "fluentbit" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html#cfn-ecs-taskdefinition-firelensconfiguration-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.HealthCheck": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.HealthCheck`\n\nThe `HealthCheck` property specifies an object representing a container\nhealth check. Health check parameters that are specified in a container definition override\nany Docker health checks that exist in the container image (such as those specified in a\nparent image or from the image's Dockerfile). This configuration maps to the\n`HEALTHCHECK` parameter of docker run.\n###### Note\nThe Amazon ECS container agent only monitors and reports on the health checks\nspecified in the task definition. Amazon ECS does not monitor Docker health checks that\nare embedded in a container image and not specified in the container definition. Health\ncheck parameters that are specified in a container definition override any Docker health\nchecks that exist in the container image.\nIf a task is run manually, and not as part of a service, the task will continue its\nlifecycle regardless of its health status. For tasks that are part of a service, if the\ntask reports as unhealthy then the task will be stopped and the service scheduler will\nreplace it.\nThe following are notes about container health check support:\n* Container health checks require version 1.17.0 or greater of the Amazon ECS\n container agent. For more information, see [Updating the Amazon\n ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html).\n* Container health checks are supported for Fargate tasks if you are using platform\n version 1.1.0 or greater. For more information, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).\n* Container health checks are not supported for tasks that are part of a service\n that is configured to use a Classic Load Balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html", "Properties": { "Command": { "MarkdownDocumentation": "`Command`\n\nA string array representing the command that the container runs to determine if it is\nhealthy. The string array must start with `CMD` to run the command arguments\ndirectly, or `CMD-SHELL` to run the command with the container's default\nshell.\nWhen 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\nbrackets.\n`[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]`\nYou don't include the double quotes and brackets when you use the AWS\nManagement 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\nmore information, see `HealthCheck` in the docker container create\ncommand.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-command", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nThe time period in seconds to wait for a health check to succeed before it is\nconsidered a failure. You may specify between 2 and 60 seconds. The default value is 5.\nThis value applies only when you specify a `command`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-timeout", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Retries": { "MarkdownDocumentation": "`Retries`\n\nThe number of times to retry a failed health check before the container is considered\nunhealthy. You may specify between 1 and 10 retries. The default value is 3. This value\napplies only when you specify a `command`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-retries", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Interval": { "MarkdownDocumentation": "`Interval`\n\nThe time period in seconds between each health check execution. You may specify\nbetween 5 and 300 seconds. The default value is 30 seconds. This value applies only when\nyou specify a `command`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-interval", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "StartPeriod": { "MarkdownDocumentation": "`StartPeriod`\n\nThe optional grace period to provide containers time to bootstrap before failed health\nchecks count towards the maximum number of retries. You can specify between 0 and 300\nseconds. By default, the `startPeriod` is off. This value applies only when\nyou specify a `command`.\n###### Note\nIf a health check succeeds within the `startPeriod`, then the container\nis considered healthy and any subsequent failures count toward the maximum number of\nretries.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-startperiod", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::TaskDefinition.HostEntry": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.HostEntry`\n\nThe `HostEntry` property specifies a hostname and an IP address that are\nadded to the `/etc/hosts` file of a container through the\n`extraHosts` parameter of its `ContainerDefinition`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostentry.html", "Properties": { "Hostname": { "MarkdownDocumentation": "`Hostname`\n\nThe hostname to use in the `/etc/hosts` entry.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostentry.html#cfn-ecs-taskdefinition-hostentry-hostname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IpAddress": { "MarkdownDocumentation": "`IpAddress`\n\nThe IP address to use in the `/etc/hosts` entry.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostentry.html#cfn-ecs-taskdefinition-hostentry-ipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.HostVolumeProperties": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.HostVolumeProperties`\n\nThe `HostVolumeProperties` property specifies details on a container instance\nbind mount host volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostvolumeproperties.html", "Properties": { "SourcePath": { "MarkdownDocumentation": "`SourcePath`\n\nWhen the `host` parameter is used, specify a `sourcePath` to\ndeclare the path on the host container instance that's presented to the container. If\nthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n`host` parameter contains a `sourcePath` file location, then\nthe data volume persists at the specified location on the host container instance until\nyou delete it manually. If the `sourcePath` value doesn't exist on the host\ncontainer instance, the Docker daemon creates it. If the location does exist, the\ncontents of the source path folder are exported.\nIf you're using the Fargate launch type, the `sourcePath` parameter is not\nsupported.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostvolumeproperties.html#cfn-ecs-taskdefinition-hostvolumeproperties-sourcepath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.KernelCapabilities": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.KernelCapabilities`\n\nThe Linux capabilities to add or remove from the default Docker configuration for a\ncontainer defined in the task definition. For more detailed information about these\nLinux capabilities, see the [capabilities(7)](http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.\nThe following describes how Docker processes the Linux capabilities specified in the\n`add` and `drop` request parameters. For information about the\nlatest behavior, see [Docker Compose: order of cap\\_drop and cap\\_add](https://forums.docker.com/t/docker-compose-order-of-cap-drop-and-cap-add/97136/1) in the Docker Community\nForum.\n* When the container is a privleged container, the container capabilities are\n all of the default Docker capabilities. The capabilities specified in the\n `add` request parameter, and the `drop` request\n parameter are ignored.\n* When the `add` request parameter is set to ALL, the container\n capabilities are all of the default Docker capabilities, excluding those\n specified in the `drop` request parameter.\n* When the `drop` request parameter is set to ALL, the container\n capabilities are the capabilities specified in the `add` request\n parameter.\n* When the `add` request parameter and the `drop` request\n parameter are both empty, the capabilities the container capabilities are all of\n the default Docker capabilities.\n* The default is to first drop the capabilities specified in the\n `drop` request parameter, and then add the capabilities specified\n in the `add` request parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html", "Properties": { "Add": { "MarkdownDocumentation": "`Add`\n\nThe Linux capabilities for the container that have been added to the default\nconfiguration provided by Docker. This parameter maps to `CapAdd` in the\ndocker container create command and the `--cap-add` option to docker\nrun.\n###### Note\nTasks launched on AWS Fargate only support adding the `SYS_PTRACE`\nkernel capability.\nValid values: `\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\"WAKE_ALARM\"`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-add", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Drop": { "MarkdownDocumentation": "`Drop`\n\nThe Linux capabilities for the container that have been removed from the default\nconfiguration provided by Docker. This parameter maps to `CapDrop` in the\ndocker container create command and the `--cap-drop` option to docker\nrun.\nValid values: `\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\"WAKE_ALARM\"`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-drop", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ECS::TaskDefinition.KeyValuePair": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.KeyValuePair`\n\nA key-value pair object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the key-value pair. For environment variables, this is the value of the\nenvironment variable.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html#cfn-ecs-taskdefinition-keyvaluepair-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the key-value pair. For environment variables, this is the name of the\nenvironment variable.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html#cfn-ecs-taskdefinition-keyvaluepair-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.LinuxParameters": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.LinuxParameters`\n\nThe Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html", "Properties": { "Capabilities": { "MarkdownDocumentation": "`Capabilities`\n\nThe Linux capabilities for the container that are added to or dropped from the default\nconfiguration provided by Docker.\n###### Note\nFor tasks that use the Fargate launch type, `capabilities` is supported\nfor all platform versions but the `add` parameter is only supported if\nusing platform version 1.4.0 or later.\n*Required*: No\n*Type*: [KernelCapabilities](./aws-properties-ecs-taskdefinition-kernelcapabilities.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-capabilities", "UpdateType": "Immutable", "Required": false, "Type": "KernelCapabilities" }, "Swappiness": { "MarkdownDocumentation": "`Swappiness`\n\nThis allows you to tune a container's memory swappiness behavior. A\n`swappiness` value of `0` will cause swapping to not happen\nunless absolutely necessary. A `swappiness` value of `100` will\ncause pages to be swapped very aggressively. Accepted values are whole numbers between\n`0` and `100`. If the `swappiness` parameter is not\nspecified, a default value of `60` is used. If a value is not specified for\n`maxSwap` then this parameter is ignored. This parameter maps to the\n`--memory-swappiness` option to docker run.\n###### Note\nIf you're using tasks that use the Fargate launch type, the\n`swappiness` parameter isn't supported.\nIf you're using tasks on Amazon Linux 2023 the `swappiness` parameter\nisn't supported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-swappiness", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Tmpfs": { "MarkdownDocumentation": "`Tmpfs`\n\nThe container path, mount options, and size (in MiB) of the tmpfs mount. This\nparameter maps to the `--tmpfs` option to docker run.\n###### Note\nIf you're using tasks that use the Fargate launch type, the `tmpfs`\nparameter isn't supported.\n*Required*: No\n*Type*: [Array](./aws-properties-ecs-taskdefinition-tmpfs.html) of [Tmpfs](./aws-properties-ecs-taskdefinition-tmpfs.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-tmpfs", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tmpfs", "DuplicatesAllowed": true }, "SharedMemorySize": { "MarkdownDocumentation": "`SharedMemorySize`\n\nThe value for the size (in MiB) of the `/dev/shm` volume. This parameter\nmaps to the `--shm-size` option to docker run.\n###### Note\nIf you are using tasks that use the Fargate launch type, the\n`sharedMemorySize` parameter is not supported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-sharedmemorysize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Devices": { "MarkdownDocumentation": "`Devices`\n\nAny host devices to expose to the container. This parameter maps to\n`Devices` in the docker container create command and the\n`--device` option to docker run.\n###### Note\nIf you're using tasks that use the Fargate launch type, the `devices`\nparameter isn't supported.\n*Required*: No\n*Type*: Array of [Device](./aws-properties-ecs-taskdefinition-device.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-devices", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Device", "DuplicatesAllowed": true }, "InitProcessEnabled": { "MarkdownDocumentation": "`InitProcessEnabled`\n\nRun an `init` process inside the container that forwards signals and reaps\nprocesses. This parameter maps to the `--init` option to docker run. This\nparameter requires version 1.25 of the Docker Remote API or greater on your container\ninstance. To check the Docker Remote API version on your container instance, log in to\nyour container instance and run the following command: `sudo docker version\n--format '{{.Server.APIVersion}}'`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-initprocessenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxSwap": { "MarkdownDocumentation": "`MaxSwap`\n\nThe total amount of swap memory (in MiB) a container can use. This parameter will be\ntranslated to the `--memory-swap` option to docker run where the value would\nbe the sum of the container memory plus the `maxSwap` value.\nIf a `maxSwap` value of `0` is specified, the container will not\nuse swap. Accepted values are `0` or any positive integer. If the\n`maxSwap` parameter is omitted, the container will use the swap\nconfiguration for the container instance it is running on. A `maxSwap` value\nmust be set for the `swappiness` parameter to be used.\n###### Note\nIf you're using tasks that use the Fargate launch type, the `maxSwap`\nparameter isn't supported.\nIf you're using tasks on Amazon Linux 2023 the `swappiness` parameter\nisn't supported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-maxswap", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::TaskDefinition.LogConfiguration": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.LogConfiguration`\n\nThe `LogConfiguration` property specifies log configuration options to send\nto a custom log driver for the container.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-logconfiguration.html", "Properties": { "SecretOptions": { "MarkdownDocumentation": "`SecretOptions`\n\nThe secrets to pass to the log configuration. For more information, see [Specifying\nsensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: Array of [Secret](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-logconfiguration.html#cfn-ecs-taskdefinition-logconfiguration-secretoptions", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Secret", "DuplicatesAllowed": true }, "Options": { "MarkdownDocumentation": "`Options`\n\nThe configuration options to send to the log driver.\nThe options you can specify depend on the log driver. Some of the options you can\nspecify when you use the `awslogs` log driver to route logs to Amazon\nCloudWatch include the following:\nawslogs-create-group\nRequired: No\nSpecify whether you want the log group to be created automatically. If\nthis option isn't specified, it defaults to `false`.\n###### Note\nYour IAM policy must include the `logs:CreateLogGroup`\npermission before you attempt to use\n`awslogs-create-group`.\n\nawslogs-region\nRequired: Yes\nSpecify the AWS Region that the `awslogs` log\ndriver is to send your Docker logs to. You can choose to send all of your\nlogs from clusters in different Regions to a single region in CloudWatch\nLogs. This is so that they're all visible in one location. Otherwise, you\ncan separate them by Region for more granularity. Make sure that the\nspecified log group exists in the Region that you specify with this\noption.\n\nawslogs-group\nRequired: Yes\nMake sure to specify a log group that the `awslogs` log driver\nsends its log streams to.\n\nawslogs-stream-prefix\nRequired: Yes, when using Fargate.Optional when\nusing EC2.\nUse the `awslogs-stream-prefix` option to associate a log\nstream with the specified prefix, the container name, and the ID of the\nAmazon ECS task that the container belongs to. If you specify a prefix with\nthis option, then the log stream takes the format\n`prefix-name/container-name/ecs-task-id`.\nIf you don't specify a prefix with this option, then the log stream is\nnamed after the container ID that's assigned by the Docker daemon on the\ncontainer instance. Because it's difficult to trace logs back to the\ncontainer that sent them with just the Docker container ID (which is only\navailable on the container instance), we recommend that you specify a prefix\nwith this option.\nFor Amazon ECS services, you can use the service name as the prefix. Doing\nso, you can trace log streams to the service that the container belongs to,\nthe name of the container that sent them, and the ID of the task that the\ncontainer belongs to.\nYou must specify a stream-prefix for your logs to have your logs appear in\nthe Log pane when using the Amazon ECS console.\n\nawslogs-datetime-format\nRequired: No\nThis option defines a multiline start pattern in Python\n`strftime` format. A log message consists of a line that\nmatches the pattern and any following lines that don\u2019t match the pattern.\nThe matched line is the delimiter between log messages.\nOne example of a use case for using this format is for parsing output such\nas a stack dump, which might otherwise be logged in multiple entries. The\ncorrect pattern allows it to be captured in a single entry.\nFor more information, see [awslogs-datetime-format](https://docs.docker.com/config/containers/logging/awslogs/#awslogs-datetime-format).\nYou cannot configure both the `awslogs-datetime-format` and\n`awslogs-multiline-pattern` options.\n###### Note\nMultiline logging performs regular expression parsing and matching of\nall log messages. This might have a negative impact on logging\nperformance.\n\nawslogs-multiline-pattern\nRequired: No\nThis option defines a multiline start pattern that uses a regular\nexpression. A log message consists of a line that matches the pattern and\nany following lines that don\u2019t match the pattern. The matched line is the\ndelimiter between log messages.\nFor more information, see [awslogs-multiline-pattern](https://docs.docker.com/config/containers/logging/awslogs/#awslogs-multiline-pattern).\nThis option is ignored if `awslogs-datetime-format` is also\nconfigured.\nYou cannot configure both the `awslogs-datetime-format` and\n`awslogs-multiline-pattern` options.\n###### Note\nMultiline logging performs regular expression parsing and matching of\nall log messages. This might have a negative impact on logging\nperformance.\n\nThe following options apply to all supported log drivers.\nmode\nRequired: No\nValid values: `non-blocking` | `blocking`\nThis option defines the delivery mode of log messages from the container\nto the log driver specified using `logDriver`. The delivery mode\nyou choose affects application availability when the flow of logs from\ncontainer is interrupted.\nIf you use the `blocking` mode and the flow of logs is\ninterrupted, calls from container code to write to the `stdout`\nand `stderr` streams will block. The logging thread of the\napplication will block as a result. This may cause the application to become\nunresponsive and lead to container healthcheck failure.\nIf you use the `non-blocking` mode, the container's logs are\ninstead stored in an in-memory intermediate buffer configured with the\n`max-buffer-size` option. This prevents the application from\nbecoming unresponsive when logs cannot be sent. We recommend using this mode\nif you want to ensure service availability and are okay with some log loss.\nFor more information, see [Preventing log loss with non-blocking mode in the `awslogs`\ncontainer log driver](https://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/).\nYou can set a default `mode` for all containers in a specific\nAWS Region by using the\n`defaultLogDriverMode` account setting. If you don't specify\nthe `mode` option or configure the account setting, Amazon ECS\nwill default to the `non-blocking` mode. For more information\nabout the account setting, see [Default log driver mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#default-log-driver-mode) in the *Amazon Elastic\nContainer Service Developer Guide*.\n###### Note\nOn June 25, 2025, Amazon ECS changed the default log driver mode from\n`blocking` to `non-blocking` to prioritize\ntask availability over logging. To continue using the\n`blocking` mode after this change, do one of the\nfollowing:\n* Set the `mode` option in your container\n definition's `logConfiguration` as\n `blocking`.\n* Set the `defaultLogDriverMode` account setting to\n `blocking`.\n\nmax-buffer-size\nRequired: No\nDefault value: `10m`\nWhen `non-blocking` mode is used, the\n`max-buffer-size` log option controls the size of the buffer\nthat's used for intermediate message storage. Make sure to specify an\nadequate buffer size based on your application. When the buffer fills up,\nfurther logs cannot be stored. Logs that cannot be stored are lost.\n\nTo route logs using the `splunk` log router, you need to specify a\n`splunk-token` and a `splunk-url`.\nWhen you use the `awsfirelens` log router to route logs to an AWS\nService or AWS Partner Network destination for log storage and analytics, you can\nset the `log-driver-buffer-limit` option to limit the number of events that\nare buffered in memory, before being sent to the log router container. It can help to\nresolve potential log loss issue because high throughput might result in memory running\nout for the buffer inside of Docker.\nOther options you can specify when using `awsfirelens` to route logs depend\non the destination. When you export logs to Amazon Data Firehose, you can specify the\nAWS Region with `region` and a name for the log stream with\n`delivery_stream`.\nWhen you export logs to Amazon Kinesis Data Streams, you can specify an AWS\nRegion with `region` and a data stream name with `stream`.\nWhen you export logs to Amazon OpenSearch Service, you can specify options like\n`Name`, `Host` (OpenSearch Service endpoint without protocol),\n`Port`, `Index`, `Type`, `Aws_auth`,\n`Aws_region`, `Suppress_Type_Name`, and `tls`. For\nmore information, see [Under the hood:\nFireLens for Amazon ECS Tasks](https://aws.amazon.com/blogs/containers/under-the-hood-firelens-for-amazon-ecs-tasks/).\nWhen you export logs to Amazon S3, you can specify the bucket using the\n`bucket` option. You can also specify `region`,\n`total_file_size`, `upload_timeout`, and\n`use_put_object` as options.\nThis parameter requires version 1.19 of the Docker Remote API or greater on your\ncontainer instance. To check the Docker Remote API version on your container instance,\nlog in to your container instance and run the following command: `sudo docker\nversion --format '{{.Server.APIVersion}}'`\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-logconfiguration.html#cfn-ecs-taskdefinition-logconfiguration-options", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "LogDriver": { "MarkdownDocumentation": "`LogDriver`\n\nThe log driver to use for the container.\nFor tasks on AWS Fargate, the supported log drivers are `awslogs`,\n`splunk`, and `awsfirelens`.\nFor tasks hosted on Amazon EC2 instances, the supported log drivers are\n`awslogs`, `fluentd`, `gelf`,\n`json-file`, `journald`, `syslog`,\n`splunk`, and `awsfirelens`.\nFor more information about using the `awslogs` log driver, see [Send\nAmazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container\nService Developer Guide*.\nFor more information about using the `awsfirelens` log driver, see [Send\nAmazon ECS logs to an AWS service or AWS\nPartner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html).\n###### Note\nIf you have a custom driver that isn't listed, you can fork the Amazon ECS\ncontainer agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We\nencourage you to submit pull requests for changes that you would like to have\nincluded. However, we don't currently provide support for running modified copies of\nthis software.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `json-file | syslog | journa...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-logconfiguration.html#cfn-ecs-taskdefinition-logconfiguration-logdriver", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.MountPoint": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.MountPoint`\n\nThe details for a volume mount point that's used in a container definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-mountpoint.html", "Properties": { "ReadOnly": { "MarkdownDocumentation": "`ReadOnly`\n\nIf this value is `true`, the container has read-only access to the volume.\nIf this value is `false`, then the container can write to the volume. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-mountpoint.html#cfn-ecs-taskdefinition-mountpoint-readonly", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "SourceVolume": { "MarkdownDocumentation": "`SourceVolume`\n\nThe name of the volume to mount. Must be a volume name referenced in the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-mountpoint.html#cfn-ecs-taskdefinition-mountpoint-sourcevolume", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ContainerPath": { "MarkdownDocumentation": "`ContainerPath`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-mountpoint.html#cfn-ecs-taskdefinition-mountpoint-containerpath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.PortMapping": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.PortMapping`\n\nThe `PortMapping` property specifies a port mapping. Port mappings allow\ncontainers to access ports on the host container instance to send or receive traffic. Port\nmappings are specified as part of the container definition.\nIf you are using containers in a task with the `awsvpc` or `host`\nnetwork mode, exposed ports should be specified using `containerPort`. The\n`hostPort` can be left blank or it must be the same value as the\n`containerPort`.\nAfter a task reaches the `RUNNING` status, manual and automatic host and\ncontainer port assignments are visible in the `networkBindings` section of\n[DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) API responses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html", "Properties": { "AppProtocol": { "MarkdownDocumentation": "`AppProtocol`\n\nThe application protocol that's used for the port mapping. This parameter only applies\nto Service Connect. We recommend that you set this parameter to be consistent with the\nprotocol that your application uses. If you set this parameter, Amazon ECS adds\nprotocol-specific connection handling to the Service Connect proxy. If you set this\nparameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and\nCloudWatch.\nIf you don't set a value for this parameter, then TCP is used. However, Amazon ECS\ndoesn't add protocol-specific telemetry for TCP.\n`appProtocol` is immutable in a Service Connect service. Updating this\nfield requires a service deletion and redeployment.\nTasks that run in a namespace can use short names to connect to services in the\nnamespace. Tasks can connect to services across all of the clusters in the namespace.\nTasks connect through a managed proxy container that collects logs and metrics for\nincreased visibility. Only the tasks that Amazon ECS services create are supported with\nService Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `http | http2 | grpc...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "http", "http2", "grpc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html#cfn-ecs-taskdefinition-portmapping-appprotocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ContainerPortRange": { "MarkdownDocumentation": "`ContainerPortRange`\n\nThe port number range on the container that's bound to the dynamically mapped host\nport range.\nThe following rules apply when you specify a `containerPortRange`:\n* You must use either the `bridge` network mode or the\n `awsvpc` network mode.\n* This parameter is available for both the EC2 and AWS Fargate launch\n types.\n* This parameter is available for both the Linux and Windows operating\n systems.\n* The container instance must have at least version 1.67.0 of the container\n 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\n `hostPortRange` is set as follows:\n \n + For containers in a task with the `awsvpc` network mode,\n the `hostPortRange` is set to the same value as the\n `containerPortRange`. This is a static mapping\n strategy.\n + For containers in a task with the `bridge` network mode,\n the Amazon ECS agent finds open host ports from the default ephemeral\n range and passes it to docker to bind them to the container\n ports.\n* The `containerPortRange` valid values are between 1 and\n 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\n config file when you have a large number of ports.\n \n For more information, see [Issue #11185](https://github.com/moby/moby/issues/11185) on the\n Github website.\n \n For information about how to turn off the docker-proxy in the Docker daemon\n config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer\n Guide*.\nYou can call [`DescribeTasks`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the `hostPortRange` which\nare the host ports that are bound to the container ports.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html#cfn-ecs-taskdefinition-portmapping-containerportrange", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HostPort": { "MarkdownDocumentation": "`HostPort`\n\nThe port number on the container instance to reserve for your container.\nIf you specify a `containerPortRange`, leave this field empty and the value\nof the `hostPort` is set as follows:\n* For containers in a task with the `awsvpc` network mode, the\n `hostPort` is set to the same value as the\n `containerPort`. This is a static mapping strategy.\n* For containers in a task with the `bridge` network mode, the Amazon\n ECS agent finds open ports on the host and automatically binds them to the\n container ports. This is a dynamic mapping strategy.\nIf you use containers in a task with the `awsvpc` or `host`\nnetwork mode, the `hostPort` can either be left blank or set to the same\nvalue as the `containerPort`.\nIf you use containers in a task with the `bridge` network mode, you can\nspecify a non-reserved host port for your container port mapping, or you can omit the\n`hostPort` (or set it to `0`) while specifying a\n`containerPort` and your container automatically receives a port in the\nephemeral port range for your container instance operating system and Docker\nversion.\nThe default ephemeral port range for Docker version 1.6.0 and later is listed on the\ninstance under `/proc/sys/net/ipv4/ip_local_port_range`. If this kernel\nparameter is unavailable, the default ephemeral port range from 49153 through 65535\n(Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port\nin the ephemeral port range as these are reserved for automatic assignment. In general,\nports below 32768 are outside of the ephemeral port range.\nThe default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\nAmazon ECS container agent ports 51678-51680. Any host port that was previously\nspecified in a running task is also reserved while the task is running. That is, after a\ntask stops, the host port is released. The current reserved ports are displayed in the\n`remainingResources` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100\nreserved ports at a time. This number includes the default reserved ports. Automatically\nassigned ports aren't included in the 100 reserved ports quota.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html#cfn-ecs-taskdefinition-portmapping-hostport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ContainerPort": { "MarkdownDocumentation": "`ContainerPort`\n\nThe port number on the container that's bound to the user-specified or automatically\nassigned host port.\nIf you use containers in a task with the `awsvpc` or `host`\nnetwork mode, specify the exposed ports using `containerPort`.\nIf you use containers in a task with the `bridge` network mode and you\nspecify a container port and not a host port, your container automatically receives a\nhost port in the ephemeral port range. For more information, see `hostPort`.\nPort mappings that are automatically assigned in this way do not count toward the 100\nreserved 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html#cfn-ecs-taskdefinition-portmapping-containerport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol used for the port mapping. Valid values are `tcp` and\n`udp`. The default is `tcp`. `protocol` is\nimmutable in a Service Connect service. Updating this field requires a service deletion\nand redeployment.\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)\n", "RefReturnValue": "", "AllowedValues": [ "tcp", "udp" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html#cfn-ecs-taskdefinition-portmapping-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name that's used for the port mapping. This parameter is the name that you use in\nthe `serviceConnectConfiguration` and the\n`vpcLatticeConfigurations` of a service. The name can include up to 64\ncharacters. The characters can include lowercase letters, numbers, underscores (\\_), and\nhyphens (-). The name can't start 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html#cfn-ecs-taskdefinition-portmapping-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.ProxyConfiguration": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.ProxyConfiguration`\n\nThe configuration details for the App Mesh proxy.\nFor tasks that use the EC2 launch type, the container instances require at least\nversion 1.26.0 of the container agent and at least version 1.26.0-1 of the\n`ecs-init` package to use a proxy configuration. If your container\ninstances are launched from the Amazon ECS optimized AMI version `20190301`\nor later, then they contain the required versions of the container agent and\n`ecs-init`. For more information, see [Amazon ECS-optimized\nLinux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html", "Properties": { "ProxyConfigurationProperties": { "MarkdownDocumentation": "`ProxyConfigurationProperties`\n\nThe set of network configuration parameters to provide the Container Network Interface\n(CNI) plugin, specified as key-value pairs.\n* `IgnoredUID` - (Required) The user ID (UID) of the proxy container\n as defined by the `user` parameter in a container definition. This is\n used to ensure the proxy ignores its own traffic. If `IgnoredGID` is\n specified, this field can be empty.\n* `IgnoredGID` - (Required) The group ID (GID) of the proxy container\n as defined by the `user` parameter in a container definition. This is\n used to ensure the proxy ignores its own traffic. If `IgnoredUID` is\n specified, this field can be empty.\n* `AppPorts` - (Required) The list of ports that the application\n uses. Network traffic to these ports is forwarded to the\n `ProxyIngressPort` and `ProxyEgressPort`.\n* `ProxyIngressPort` - (Required) Specifies the port that incoming\n traffic to the `AppPorts` is directed to.\n* `ProxyEgressPort` - (Required) Specifies the port that outgoing\n traffic from the `AppPorts` is directed to.\n* `EgressIgnoredPorts` - (Required) The egress traffic going to the\n specified ports is ignored and not redirected to the\n `ProxyEgressPort`. It can be an empty list.\n* `EgressIgnoredIPs` - (Required) The egress traffic going to the\n specified IP addresses is ignored and not redirected to the\n `ProxyEgressPort`. It can be an empty list.\n*Required*: No\n*Type*: Array of [KeyValuePair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-proxyconfigurationproperties", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "KeyValuePair", "DuplicatesAllowed": false }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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)\n", "RefReturnValue": "", "AllowedValues": [ "APPMESH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ContainerName": { "MarkdownDocumentation": "`ContainerName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html#cfn-ecs-taskdefinition-proxyconfiguration-containername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.RepositoryCredentials": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.RepositoryCredentials`\n\nThe repository credentials for private registry authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-repositorycredentials.html", "Properties": { "CredentialsParameter": { "MarkdownDocumentation": "`CredentialsParameter`\n\nThe Amazon Resource Name (ARN) of the secret containing the private repository\ncredentials.\n###### Note\nWhen you use the Amazon ECS API, AWS CLI, or AWS SDK, if the secret\nexists in the same Region as the task that you're launching then you can use either\nthe full ARN or the name of the secret. When you use the AWS Management\nConsole, you must specify the full ARN of the secret.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-repositorycredentials.html#cfn-ecs-taskdefinition-repositorycredentials-credentialsparameter", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.ResourceRequirement": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.ResourceRequirement`\n\nThe type and amount of a resource to assign to a container. The supported resource\ntypes are GPUs and Elastic Inference accelerators. For more information, see [Working with\nGPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic\nInference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service\nDeveloper Guide*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of resource to assign to a container.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GPU | InferenceAccelerator...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "GPU", "InferenceAccelerator" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the specified resource type.\nWhen the type is `GPU`, the value is the number of physical\n`GPUs` the Amazon ECS container agent reserves for the container. The\nnumber of GPUs that's reserved for all containers in a task can't exceed the number of\navailable GPUs on the container instance that the task is launched on.\nWhen the type is `InferenceAccelerator`, the `value` matches the\n`deviceName` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-resourcerequirement.html#cfn-ecs-taskdefinition-resourcerequirement-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.RestartPolicy": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.RestartPolicy`\n\nYou can enable a restart policy for each container defined in your task definition, to\novercome transient failures faster and maintain task availability. When you enable a\nrestart policy for a container, Amazon ECS can restart the container if it exits,\nwithout needing to replace the task. For more information, see [Restart\nindividual containers in Amazon ECS tasks with container restart policies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html) in\nthe *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-restartpolicy.html", "Properties": { "IgnoredExitCodes": { "MarkdownDocumentation": "`IgnoredExitCodes`\n\nA list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can\nspecify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any\nexit codes.\n*Required*: No\n*Type*: Array of Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-restartpolicy.html#cfn-ecs-taskdefinition-restartpolicy-ignoredexitcodes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "RestartAttemptPeriod": { "MarkdownDocumentation": "`RestartAttemptPeriod`\n\nA period of time (in seconds) that the container must run for before a restart can be\nattempted. A container can be restarted only once every\n`restartAttemptPeriod` seconds. If a container isn't able to run for this\ntime period and exits early, it will not be restarted. You can set a minimum\n`restartAttemptPeriod` of 60 seconds and a maximum\n`restartAttemptPeriod` of 1800 seconds. By default, a container must run\nfor 300 seconds before it can be restarted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-restartpolicy.html#cfn-ecs-taskdefinition-restartpolicy-restartattemptperiod", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether a restart policy is enabled for the container.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-restartpolicy.html#cfn-ecs-taskdefinition-restartpolicy-enabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ECS::TaskDefinition.RuntimePlatform": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.RuntimePlatform`\n\nInformation about the platform for the Amazon ECS service or task.\nFor more information about `RuntimePlatform`, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html", "Properties": { "OperatingSystemFamily": { "MarkdownDocumentation": "`OperatingSystemFamily`\n\nThe operating system.\n*Required*: No\n*Type*: String\n*Allowed values*: `WINDOWS_SERVER_2019_FULL | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_2025_CORE", "WINDOWS_SERVER_2025_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html#cfn-ecs-taskdefinition-runtimeplatform-operatingsystemfamily", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CpuArchitecture": { "MarkdownDocumentation": "`CpuArchitecture`\n\nThe CPU architecture.\nYou can run your Linux tasks on an ARM-based platform by setting the value to\n`ARM64`. This option is available for tasks that run on Linux Amazon EC2\ninstance, Amazon ECS Managed Instances, or Linux containers on Fargate.\n*Required*: No\n*Type*: String\n*Allowed values*: `X86_64 | ARM64...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "X86_64", "ARM64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html#cfn-ecs-taskdefinition-runtimeplatform-cpuarchitecture", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.Secret": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.Secret`\n\nAn object representing the secret to expose to your container. Secrets can be exposed\nto a container in the following ways:\n* To inject sensitive data into your containers as environment variables, use\n the `secrets` container definition parameter.\n* To reference sensitive information in the log configuration of a container,\n use the `secretOptions` container definition parameter.\nFor more information, see [Specifying\nsensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html", "Properties": { "ValueFrom": { "MarkdownDocumentation": "`ValueFrom`\n\nThe secret to expose to the container. The supported values are either the full ARN of\nthe AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter\nStore.\nFor information about the require AWS Identity and Access Management permissions,\nsee [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\n[Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager\nParameter store) in the *Amazon Elastic Container Service Developer\nGuide*.\n###### Note\nIf the SSM Parameter Store parameter exists in the same Region as the task you're\nlaunching, then you can use either the full ARN or name of the parameter. If the\nparameter exists in a different Region, then the full ARN must be specified.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html#cfn-ecs-taskdefinition-secret-valuefrom", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the secret.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html#cfn-ecs-taskdefinition-secret-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.SystemControl": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.SystemControl`\n\nA list of namespaced kernel parameters to set in the container. This parameter maps to\n`Sysctls` in the docker container create command and the\n`--sysctl` option to docker run. For example, you can configure\n`net.ipv4.tcp_keepalive_time` setting to maintain longer lived\nconnections.\nWe don't recommend that you specify network-related `systemControls`\nparameters for multiple containers in a single task that also uses either the\n`awsvpc` or `host` network mode. Doing this has the following\ndisadvantages:\n* For tasks that use the `awsvpc` network mode including Fargate, if\n you set `systemControls` for any container, it applies to all\n containers in the task. If you set different `systemControls` for\n multiple containers in a single task, the container that's started last\n determines which `systemControls` take effect.\n* For tasks that use the `host` network mode, the network namespace\n `systemControls` aren't supported.\nIf you're setting an IPC resource namespace to use for the containers in the task, the\nfollowing conditions apply to your system controls. For more information, see [IPC mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode).\n* For tasks that use the `host` IPC mode, IPC namespace\n `systemControls` aren't supported.\n* For tasks that use the `task` IPC mode, IPC namespace\n `systemControls` values apply to all containers within a\n task.\n###### Note\nThis parameter is not supported for Windows containers.\n###### Note\nThis parameter is only supported for tasks that are hosted on AWS Fargate if\nthe tasks are using platform version `1.4.0` or later (Linux). This isn't\nsupported for Windows containers on Fargate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe namespaced kernel parameter to set a `value` for.\nValid IPC namespace values: `\"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\"\n| \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" |\n\"kernel.shm_rmid_forced\"`, and `Sysctls` that start with\n`\"fs.mqueue.*\"`\nValid network namespace values: `Sysctls` that start with\n`\"net.*\"`. Only namespaced `Sysctls` that exist within the\ncontainer starting with \"net.\\* are accepted.\nAll of these values are supported by Fargate.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html#cfn-ecs-taskdefinition-systemcontrol-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespaced kernel parameter to set a `value` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html#cfn-ecs-taskdefinition-systemcontrol-namespace", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint`\n\nThe constraint on task placement in the task definition. For more information, see\n[Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon\nElastic Container Service Developer Guide*.\n###### Note\nTask placement constraints aren't supported for tasks run on AWS Fargate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of constraint. The `MemberOf` constraint restricts selection to be\nfrom a group of valid candidates.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `memberOf`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "memberOf" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nA cluster query language expression to apply to the constraint. For more information,\nsee [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic\nContainer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-expression", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.Tmpfs": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.Tmpfs`\n\nThe container path, mount options, and size of the tmpfs mount.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html", "Properties": { "Size": { "MarkdownDocumentation": "`Size`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-size", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "ContainerPath": { "MarkdownDocumentation": "`ContainerPath`\n\nThe absolute file path where the tmpfs volume is to be mounted.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-containerpath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MountOptions": { "MarkdownDocumentation": "`MountOptions`\n\nThe list of tmpfs volume mount options.\nValid values: `\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n\"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n\"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n\"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n\"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n| \"nr_inodes\" | \"nr_blocks\" | \"mpol\"`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tmpfs.html#cfn-ecs-taskdefinition-tmpfs-mountoptions", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ECS::TaskDefinition.Ulimit": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.Ulimit`\n\nThe `ulimit` settings to pass to the container.\nAmazon ECS tasks hosted on AWS Fargate use the default resource limit values\nset by the operating system with the exception of the `nofile` resource limit\nparameter which AWS Fargate overrides. The `nofile` resource limit sets a\nrestriction on the number of open files that a container can use. The default\n`nofile` soft limit is `65535` and the default hard limit is\n`65535`.\nYou can specify the `ulimit` settings for a container in a task\ndefinition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ulimit.html", "Properties": { "SoftLimit": { "MarkdownDocumentation": "`SoftLimit`\n\nThe soft limit for the `ulimit` type. The value can be specified in bytes,\nseconds, or as a count, depending on the `type` of the\n`ulimit`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ulimit.html#cfn-ecs-taskdefinition-ulimit-softlimit", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "HardLimit": { "MarkdownDocumentation": "`HardLimit`\n\nThe hard limit for the `ulimit` type. The value can be specified in bytes,\nseconds, or as a count, depending on the `type` of the\n`ulimit`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ulimit.html#cfn-ecs-taskdefinition-ulimit-hardlimit", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe `type` of the `ulimit`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `core | cpu | data | fsize |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ulimit.html#cfn-ecs-taskdefinition-ulimit-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.Volume": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.Volume`\n\nThe data volume configuration for tasks launched using this task definition.\nSpecifying a volume configuration in a task definition is optional. The volume\nconfiguration may contain multiple volumes but only one volume configured at launch is\nsupported. Each volume defined in the volume configuration may only specify a\n`name` and one of either `configuredAtLaunch`,\n`dockerVolumeConfiguration`, `efsVolumeConfiguration`,\n`fsxWindowsFileServerVolumeConfiguration`, or `host`. If an\nempty volume configuration is specified, by default Amazon ECS uses a host volume. For\nmore information, see [Using data volumes in\ntasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html", "Properties": { "EFSVolumeConfiguration": { "MarkdownDocumentation": "`EFSVolumeConfiguration`\n\nThis parameter is specified when you use an Amazon Elastic File System file system for\ntask storage.\n*Required*: No\n*Type*: [EFSVolumeConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-efsvolumeconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EFSVolumeConfiguration" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThis parameter is specified when you use bind mount host volumes. The contents of the\n`host` parameter determine whether your bind mount host volume persists\non the host container instance and where it's stored. If the `host` parameter\nis empty, then the Docker daemon assigns a host path for your data volume. However, the\ndata isn't guaranteed to persist after the containers that are associated with it stop\nrunning.\nWindows containers can mount whole directories on the same drive as\n`$env:ProgramData`. Windows containers can't mount directories on a\ndifferent drive, and mount point can't be across drives. For example, you can mount\n`C:\\my\\path:C:\\my\\path` and `D:\\:D:\\`, but not\n`D:\\my\\path:C:\\my\\path` or `D:\\:C:\\my\\path`.\n*Required*: No\n*Type*: [HostVolumeProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-host", "UpdateType": "Immutable", "Required": false, "Type": "HostVolumeProperties" }, "ConfiguredAtLaunch": { "MarkdownDocumentation": "`ConfiguredAtLaunch`\n\nIndicates whether the volume should be configured at launch time. This is used to\ncreate Amazon EBS volumes for standalone tasks or tasks created as part of a service.\nEach task definition revision may only have one volume configured at launch in the\nvolume configuration.\nTo configure a volume at launch time, use this task definition revision and specify a\n`volumeConfigurations` object when calling the\n`CreateService`, `UpdateService`, `RunTask` or\n`StartTask` APIs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-configuredatlaunch", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DockerVolumeConfiguration": { "MarkdownDocumentation": "`DockerVolumeConfiguration`\n\nThis parameter is specified when you use Docker volumes.\nWindows containers only support the use of the `local` driver. To use bind\nmounts, specify the `host` parameter instead.\n###### Note\nDocker volumes aren't supported by tasks run on AWS Fargate.\n*Required*: No\n*Type*: [DockerVolumeConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-dockervolumeconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "DockerVolumeConfiguration" }, "FSxWindowsFileServerVolumeConfiguration": { "MarkdownDocumentation": "`FSxWindowsFileServerVolumeConfiguration`\n\nThis parameter is specified when you use Amazon FSx for Windows File Server file\nsystem for task storage.\n*Required*: No\n*Type*: [FSxWindowsFileServerVolumeConfiguration](./aws-properties-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-fsxwindowsfileservervolumeconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "FSxWindowsFileServerVolumeConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the volume. Up to 255 letters (uppercase and lowercase), numbers,\nunderscores, and hyphens are allowed.\nWhen using a volume configured at launch, the `name` is required and must\nalso be specified as the volume name in the `ServiceVolumeConfiguration` or\n`TaskVolumeConfiguration` parameter when creating your service or\nstandalone task.\nFor all other types of volumes, this name is referenced in the\n`sourceVolume` parameter of the `mountPoints` object in the\ncontainer definition.\nWhen a volume is using the `efsVolumeConfiguration`, the name is\nrequired.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskDefinition.VolumeFrom": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition.VolumeFrom`\n\nDetails on a data volume from another container in the same task definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumefrom.html", "Properties": { "ReadOnly": { "MarkdownDocumentation": "`ReadOnly`\n\nIf this value is `true`, the container has read-only access to the volume.\nIf this value is `false`, then the container can write to the volume. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumefrom.html#cfn-ecs-taskdefinition-volumefrom-readonly", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "SourceContainer": { "MarkdownDocumentation": "`SourceContainer`\n\nThe name of another container within the same task definition to mount volumes\nfrom.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumefrom.html#cfn-ecs-taskdefinition-volumefrom-sourcecontainer", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskSet.AwsVpcConfiguration": { "MarkdownDocumentation": "`AWS::ECS::TaskSet.AwsVpcConfiguration`\n\nAn object representing the networking details for a task or service. For example\n`awsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe IDs of the security groups associated with the task or service. If you don't\nspecify a security group, the default security group for the VPC is used. There's a\nlimit of 5 security groups that can be specified.\n###### Note\nAll specified security groups must be from the same VPC.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-securitygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe IDs of the subnets associated with the task or service. There's a limit of 16\nsubnets that can be specified.\n###### Note\nAll specified subnets must be from the same VPC.\n*Required*: Yes\n*Type*: Array of String\n*Maximum*: `16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-subnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AssignPublicIp": { "MarkdownDocumentation": "`AssignPublicIp`\n\nWhether the task's elastic network interface receives a public IP address.\nConsider the following when you set this value:\n* When you use `create-service` or `update-service`, the\n default is `DISABLED`.\n* When the service `deploymentController` is `ECS`, the\n value must be `DISABLED`.\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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html#cfn-ecs-taskset-awsvpcconfiguration-assignpublicip", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskSet.CapacityProviderStrategyItem": { "MarkdownDocumentation": "`AWS::ECS::TaskSet.CapacityProviderStrategyItem`\n\nThe details of a capacity provider strategy. A capacity provider strategy can be set\nwhen using the [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)or [CreateCluster](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html) APIs or as the default capacity provider strategy for a\ncluster with the `CreateCluster` API.\nOnly capacity providers that are already associated with a cluster and have an\n`ACTIVE` or `UPDATING` status can be used in a capacity\nprovider strategy. The [PutClusterCapacityProviders](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html) API is used to associate a capacity provider\nwith a cluster.\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers can be\ncreated with the [CreateClusterCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html) API operation.\nTo use a AWS Fargate capacity provider, specify either the `FARGATE` or\n`FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers\nare available to all accounts and only need to be associated with a cluster to be used\nin a capacity provider strategy.\nWith `FARGATE_SPOT`, you can run interruption tolerant tasks at a rate\nthat's discounted compared to the `FARGATE` price. `FARGATE_SPOT`\nruns tasks on spare compute capacity. When AWS needs the capacity back,\nyour tasks are interrupted with a two-minute warning. `FARGATE_SPOT` supports\nLinux tasks with the X86\\_64 architecture on platform version 1.3.0 or later.\n`FARGATE_SPOT` supports Linux tasks with the ARM64 architecture on\nplatform version 1.4.0 or later.\nA capacity provider strategy can contain a maximum of 20 capacity providers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-capacityproviderstrategyitem.html", "Properties": { "CapacityProvider": { "MarkdownDocumentation": "`CapacityProvider`\n\nThe short name of the capacity provider. This can be either an AWS managed capacity provider (`FARGATE` or `FARGATE_SPOT`) or the name of a custom capacity provider that you 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-capacityproviderstrategyitem.html#cfn-ecs-taskset-capacityproviderstrategyitem-capacityprovider", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Base": { "MarkdownDocumentation": "`Base`\n\nThe *base* value designates how many tasks, at a minimum, to run on\nthe specified capacity provider for each service. Only one capacity provider in a\ncapacity provider strategy can have a *base* defined. If no value is\nspecified, the default value of `0` is used.\nBase value characteristics:\n* Only one capacity provider in a strategy can have a base defined\n* The default value is `0` if not specified\n* The valid range is 0 to 100,000\n* Base requirements are satisfied first before weight distribution\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-capacityproviderstrategyitem.html#cfn-ecs-taskset-capacityproviderstrategyitem-base", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe *weight* value designates the relative percentage of the total\nnumber of tasks launched that should use the specified capacity provider. The\n`weight` value is taken into consideration after the `base`\nvalue, if defined, is satisfied.\nIf no `weight` value is specified, the default value of `0` is\nused. When multiple capacity providers are specified within a capacity provider\nstrategy, at least one of the capacity providers must have a weight value greater than\nzero and any capacity providers with a weight of `0` can't be used to place\ntasks. If you specify multiple capacity providers in a strategy that all have a weight\nof `0`, any `RunTask` or `CreateService` actions using\nthe capacity provider strategy will fail.\nWeight value characteristics:\n* Weight is considered after the base value is satisfied\n* The default value is `0` if not specified\n* The valid range is 0 to 1,000\n* At least one capacity provider must have a weight greater than zero\n* Capacity providers with weight of `0` cannot place tasks\nTask distribution logic:\n1. Base satisfaction: The minimum number of tasks specified by the base value are\n placed on that capacity provider\n2. Weight distribution: After base requirements are met, additional tasks are\n distributed according to weight ratios\nExamples:\nEqual Distribution: Two capacity providers both with weight `1` will split\ntasks evenly after base requirements are met.\nWeighted Distribution: If capacityProviderA has weight `1` and\ncapacityProviderB has weight `4`, then for every 1 task on A, 4 tasks will\nrun on B.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-capacityproviderstrategyitem.html#cfn-ecs-taskset-capacityproviderstrategyitem-weight", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::TaskSet.LoadBalancer": { "MarkdownDocumentation": "`AWS::ECS::TaskSet.LoadBalancer`\n\nThe load balancer configuration to use with a service or task set.\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts a new\ndeployment with the updated Elastic Load Balancing configuration. This causes tasks to\nregister to and deregister from load balancers.\nWe recommend that you verify this on a test environment before you update the Elastic\nLoad Balancing configuration.\nA service-linked role is required for services that use multiple target groups. For\nmore information, see [Using\nservice-linked roles](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service\nDeveloper Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html", "Properties": { "TargetGroupArn": { "MarkdownDocumentation": "`TargetGroupArn`\n\nThe full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or\ngroups associated with a service or task set.\nA target group ARN is only specified when using an Application Load Balancer or\nNetwork Load Balancer.\nFor services using the `ECS` deployment controller, you can specify one or\nmultiple 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\nthe *Amazon Elastic Container Service Developer Guide*.\nFor services using the `CODE_DEPLOY` deployment controller, you're required\nto 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\n*Amazon Elastic Container Service Developer Guide*.\n###### Important\nIf your service's task definition uses the `awsvpc` network mode, you\nmust choose `ip` as the target type, not `instance`. Do this\nwhen creating your target groups because tasks that use the `awsvpc`\nnetwork mode are associated with an elastic network interface, not an Amazon EC2\ninstance. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-targetgrouparn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ContainerName": { "MarkdownDocumentation": "`ContainerName`\n\nThe name of the container (as it appears in a container definition) to associate with\nthe load balancer.\nYou need to specify the container name when configuring the target group for an Amazon\nECS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-containername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ContainerPort": { "MarkdownDocumentation": "`ContainerPort`\n\nThe port on the container to associate with the load balancer. This port must\ncorrespond to a `containerPort` in the task definition the tasks in the\nservice are using. For tasks that use the EC2 launch type, the container instance\nthey're launched on must allow ingress traffic on the `hostPort` of the port\nmapping.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html#cfn-ecs-taskset-loadbalancer-containerport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ECS::TaskSet.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::ECS::TaskSet.NetworkConfiguration`\n\nThe network configuration for a task or service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html", "Properties": { "AwsVpcConfiguration": { "MarkdownDocumentation": "`AwsVpcConfiguration`\n\nThe VPC subnets and security groups that are associated with a task.\n###### Note\nAll specified subnets and security groups must be from the same VPC.\n*Required*: No\n*Type*: [AwsVpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html#cfn-ecs-taskset-networkconfiguration-awsvpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "AwsVpcConfiguration" } } }, "AWS::ECS::TaskSet.Scale": { "MarkdownDocumentation": "`AWS::ECS::TaskSet.Scale`\n\nA floating-point percentage of the desired number of tasks to place and keep running\nin the task set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value, specified as a percent total of a service's `desiredCount`, to\nscale the task set. Accepted values are numbers between 0 and 100.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html#cfn-ecs-taskset-scale-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit of measure for the scale value.\n*Required*: No\n*Type*: String\n*Allowed values*: `PERCENT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html#cfn-ecs-taskset-scale-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECS::TaskSet.ServiceRegistry": { "MarkdownDocumentation": "`AWS::ECS::TaskSet.ServiceRegistry`\n\nThe details for the service registry.\nEach service may be associated with one service registry. Multiple service registries\nfor each service are not supported.\nWhen you add, update, or remove the service registries configuration, Amazon ECS\nstarts a new deployment. New tasks are registered and deregistered to the updated\nservice registry configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html", "Properties": { "ContainerName": { "MarkdownDocumentation": "`ContainerName`\n\nThe container name value to be used for your service discovery service. It's already\nspecified in the task definition. If the task definition that your service task\nspecifies uses the `bridge` or `host` network mode, you must\nspecify a `containerName` and `containerPort` combination from the\ntask definition. If the task definition that your service task specifies uses the\n`awsvpc` network mode and a type SRV DNS record is used, you must specify\neither a `containerName` and `containerPort` combination or a\n`port` value. However, you can't specify both.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-containername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port value used if your service discovery service specified an SRV record. This\nfield might be used if both the `awsvpc` network mode and SRV records are\nused.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-port", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ContainerPort": { "MarkdownDocumentation": "`ContainerPort`\n\nThe port value to be used for your service discovery service. It's already specified\nin the task definition. If the task definition your service task specifies uses the\n`bridge` or `host` network mode, you must specify a\n`containerName` and `containerPort` combination from the task\ndefinition. If the task definition your service task specifies uses the\n`awsvpc` network mode and a type SRV DNS record is used, you must specify\neither a `containerName` and `containerPort` combination or a\n`port` value. However, you can't specify both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-containerport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "RegistryArn": { "MarkdownDocumentation": "`RegistryArn`\n\nThe Amazon Resource Name (ARN) of the service registry. The currently supported\nservice 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*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html#cfn-ecs-taskset-serviceregistry-registryarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EFS::AccessPoint.AccessPointTag": { "MarkdownDocumentation": "`AWS::EFS::AccessPoint.AccessPointTag`\n\nA tag is a key-value pair attached to a file system. Allowed characters in the `Key` and `Value` properties\nare letters, white space, and numbers that\ncan be represented in UTF-8, and the following characters: `+ - = . _ : /`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-accesspointtag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the tag 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-accesspointtag.html#cfn-efs-accesspoint-accesspointtag-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key (String). The key can't start with `aws:`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-accesspointtag.html#cfn-efs-accesspoint-accesspointtag-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EFS::AccessPoint.CreationInfo": { "MarkdownDocumentation": "`AWS::EFS::AccessPoint.CreationInfo`\n\nRequired if the `RootDirectory` > `Path` specified does not exist.\nSpecifies the POSIX IDs and permissions to apply to the access point's `RootDirectory` > `Path`.\nIf the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point.\nWhen specifying `CreationInfo`, you must include values for all properties.\nAmazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory.\nIf you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount\nusing the access point will fail.\n###### Important\nIf you do not provide `CreationInfo` and the specified `RootDirectory` does not exist,\nattempts to mount the file system using the access point will fail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html", "Properties": { "OwnerGid": { "MarkdownDocumentation": "`OwnerGid`\n\nSpecifies the POSIX group ID to apply to the `RootDirectory`. Accepts values from 0 to 2^32 (4294967295).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-ownergid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OwnerUid": { "MarkdownDocumentation": "`OwnerUid`\n\nSpecifies the POSIX user ID to apply to the `RootDirectory`. Accepts values from 0 to 2^32 (4294967295).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-owneruid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nSpecifies the POSIX permissions to apply to the `RootDirectory`, in the format of an octal number representing the file's mode bits.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-7]{3,4}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-permissions", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EFS::AccessPoint.PosixUser": { "MarkdownDocumentation": "`AWS::EFS::AccessPoint.PosixUser`\n\nThe full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by\nNFS clients using the access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-posixuser.html", "Properties": { "Uid": { "MarkdownDocumentation": "`Uid`\n\nThe POSIX user ID used for all file system operations using 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-posixuser.html#cfn-efs-accesspoint-posixuser-uid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecondaryGids": { "MarkdownDocumentation": "`SecondaryGids`\n\nSecondary POSIX group IDs used for all file system operations using this access point.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-posixuser.html#cfn-efs-accesspoint-posixuser-secondarygids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Gid": { "MarkdownDocumentation": "`Gid`\n\nThe POSIX group ID used for all file system operations using 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-posixuser.html#cfn-efs-accesspoint-posixuser-gid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EFS::AccessPoint.RootDirectory": { "MarkdownDocumentation": "`AWS::EFS::AccessPoint.RootDirectory`\n\nSpecifies the directory on the Amazon EFS file system that the access point\nprovides access to. The access point exposes the specified file system path as the root\ndirectory of your file system to applications using the access point. NFS clients using the\naccess point can only access data in the access point's `RootDirectory` and its\nsubdirectories.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-rootdirectory.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nSpecifies the path on the EFS file system to expose as the root directory to\nNFS clients using the access point to access the EFS file system. A path can have\nup to four subdirectories. If the specified path does not exist, you are required to provide\nthe `CreationInfo`.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-rootdirectory.html#cfn-efs-accesspoint-rootdirectory-path", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CreationInfo": { "MarkdownDocumentation": "`CreationInfo`\n\n(Optional) Specifies the POSIX IDs and permissions to apply to the access point's\n`RootDirectory`. If the `RootDirectory` > `Path`\nspecified does not exist, EFS creates the root directory using the\n`CreationInfo` settings when a client connects to an access point. When\nspecifying the `CreationInfo`, you must provide values for all properties.\n###### Important\nIf you do not provide `CreationInfo` and the specified `RootDirectory` > `Path` does not exist,\nattempts to mount the file system using the access point will fail.\n*Required*: No\n*Type*: [CreationInfo](./aws-properties-efs-accesspoint-creationinfo.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-rootdirectory.html#cfn-efs-accesspoint-rootdirectory-creationinfo", "UpdateType": "Immutable", "Required": false, "Type": "CreationInfo" } } }, "AWS::EFS::FileSystem.BackupPolicy": { "MarkdownDocumentation": "`AWS::EFS::FileSystem.BackupPolicy`\n\nThe backup policy turns automatic backups for the file system on or off.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-backuppolicy.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSet 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 | ENABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-backuppolicy.html#cfn-efs-filesystem-backuppolicy-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EFS::FileSystem.ElasticFileSystemTag": { "MarkdownDocumentation": "`AWS::EFS::FileSystem.ElasticFileSystemTag`\n\nA tag is a key-value pair attached to a file system. Allowed characters in the `Key` and `Value` properties\nare letters, white space, and numbers that\ncan be represented in UTF-8, and the following characters: `+ - = . _ : /`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-elasticfilesystemtag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the tag key.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-elasticfilesystemtag.html#cfn-efs-filesystem-elasticfilesystemtag-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key (String). The key can't start with `aws:`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?![aA]{1}[wW]{1}[sS]{1}:)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-elasticfilesystemtag.html#cfn-efs-filesystem-elasticfilesystemtag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EFS::FileSystem.FileSystemProtection": { "MarkdownDocumentation": "`AWS::EFS::FileSystem.FileSystemProtection`\n\nDescribes the protection on the file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemprotection.html", "Properties": { "ReplicationOverwriteProtection": { "MarkdownDocumentation": "`ReplicationOverwriteProtection`\n\nThe status of the file system's replication overwrite protection.\n* `ENABLED` \u2013 The file system cannot be used as the destination file\n system in a replication configuration. The file system is writeable. Replication overwrite\n protection is `ENABLED` by default.\n* `DISABLED` \u2013 The file system can be used as the destination file\n system in a replication configuration. The file system is read-only and can only be\n modified by EFS replication.\n* `REPLICATING` \u2013 The file system is being used as the destination\n file system in a replication configuration. The file system is read-only and is modified\n only by EFS replication.\nIf the replication configuration is deleted, the file system's replication overwrite\nprotection is re-enabled, the file system becomes writeable.\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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemprotection.html#cfn-efs-filesystem-filesystemprotection-replicationoverwriteprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EFS::FileSystem.LifecyclePolicy": { "MarkdownDocumentation": "`AWS::EFS::FileSystem.LifecyclePolicy`\n\nDescribes a policy used by Lifecycle management that\nspecifies when to transition files into and out of the EFS storage classes. For more information,\nsee [Managing file system storage](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).\n###### Note\n* Each `LifecyclePolicy` object can have only a single transition. This means that in a\n request body, `LifecyclePolicies` must be structured as an array of\n `LifecyclePolicy` objects, one object for each transition,\n `TransitionToIA`, `TransitionToArchive`, `TransitionToPrimaryStorageClass`.\n* See the AWS::EFS::FileSystem examples for the correct `LifecyclePolicy` structure. Do not\n use the syntax shown on this page.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html", "Properties": { "TransitionToIA": { "MarkdownDocumentation": "`TransitionToIA`\n\nThe number of days after files were last accessed in primary storage (the\nStandard storage class) at which to move them to Infrequent Access\n(IA) storage. Metadata operations such as listing the contents of a directory\ndon't count as file access events.\n*Required*: No\n*Type*: String\n*Allowed values*: `AFTER_7_DAYS | AFTER_14_DAY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AFTER_7_DAYS", "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS", "AFTER_1_DAY", "AFTER_180_DAYS", "AFTER_270_DAYS", "AFTER_365_DAYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html#cfn-efs-filesystem-lifecyclepolicy-transitiontoia", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransitionToPrimaryStorageClass": { "MarkdownDocumentation": "`TransitionToPrimaryStorageClass`\n\nWhether to move files back to primary (Standard) storage after they are\naccessed in IA or Archive storage. Metadata operations such as\nlisting 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)", "RefReturnValue": "", "AllowedValues": [ "AFTER_1_ACCESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html#cfn-efs-filesystem-lifecyclepolicy-transitiontoprimarystorageclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransitionToArchive": { "MarkdownDocumentation": "`TransitionToArchive`\n\nThe number of days after files were last accessed in primary storage (the\nStandard storage class) at which to move them to Archive\nstorage. Metadata operations such as listing the contents of a directory don't count as\nfile access events.\n*Required*: No\n*Type*: String\n*Allowed values*: `AFTER_1_DAY | AFTER_7_DAYS ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AFTER_1_DAY", "AFTER_7_DAYS", "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS", "AFTER_180_DAYS", "AFTER_270_DAYS", "AFTER_365_DAYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html#cfn-efs-filesystem-lifecyclepolicy-transitiontoarchive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EFS::FileSystem.ReplicationConfiguration": { "MarkdownDocumentation": "`AWS::EFS::FileSystem.ReplicationConfiguration`\n\nDescribes the replication configuration for a specific file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationconfiguration.html", "Properties": { "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nAn array of destination objects. Only one destination object is supported.\n*Required*: No\n*Type*: Array of [ReplicationDestination](./aws-properties-efs-filesystem-replicationdestination.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationconfiguration.html#cfn-efs-filesystem-replicationconfiguration-destinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReplicationDestination", "DuplicatesAllowed": false } } }, "AWS::EFS::FileSystem.ReplicationDestination": { "MarkdownDocumentation": "`AWS::EFS::FileSystem.ReplicationDestination`\n\nDescribes the destination file system in the replication configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nDescribes the status of the replication configuration. For more information\nabout replication status, see [Viewing\nreplication details](https://docs.aws.amazon.com//efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) in the *Amazon EFS User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | ENABLING | DELETI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "ENABLING", "DELETING", "ERROR", "PAUSED", "PAUSING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe ID of an AWS KMS key used to protect the encrypted file system.\n*Required*: No\n*Type*: String\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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneName": { "MarkdownDocumentation": "`AvailabilityZoneName`\n\nFor One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located.\nUse the format `us-east-1a`\nto specify the Availability Zone. For\nmore information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*.\n###### Note\nOne Zone file system type is not available in all Availability Zones in AWS Regions where\nAmazon EFS is available.\n*Required*: No\n*Type*: String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-availabilityzonename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe ID of the destination Amazon EFS file system.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-filesystemid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe AWS Region in which the destination file system is located.\n###### Note\nFor One Zone file systems, the replication configuration must specify the AWS Region in which the destination\nfile system is located.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the current source file system in the\nreplication 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusMessage": { "MarkdownDocumentation": "`StatusMessage`\n\nMessage that provides details about the `PAUSED` or `ERRROR` state\nof the replication destination configuration. For more information\nabout replication status messages, see [Viewing\nreplication details](https://docs.aws.amazon.com//efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) in the *Amazon EFS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-statusmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::AccessEntry.AccessPolicy": { "MarkdownDocumentation": "`AWS::EKS::AccessEntry.AccessPolicy`\n\nAn access policy includes permissions that allow Amazon EKS to authorize an\nIAM principal to work with Kubernetes objects on your cluster. The policies are\nmanaged by Amazon EKS, but they're not IAM policies. You can't view the permissions in the\npolicies using the API. The permissions for many of the policies are similar to the\nKubernetes `cluster-admin`, `admin`, `edit`, and\n`view` cluster roles. For more information about these cluster roles, see\n[User-facing roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) in the Kubernetes documentation. To view the contents of the\npolicies, see [Access\npolicy permissions](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html#access-policy-permissions) in the *Amazon EKS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-accessentry-accesspolicy.html", "Properties": { "PolicyArn": { "MarkdownDocumentation": "`PolicyArn`\n\nThe ARN of the access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-accessentry-accesspolicy.html#cfn-eks-accessentry-accesspolicy-policyarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AccessScope": { "MarkdownDocumentation": "`AccessScope`\n\nThe scope of an `AccessPolicy` that's associated to an\n`AccessEntry`.\n*Required*: Yes\n*Type*: [AccessScope](./aws-properties-eks-accessentry-accessscope.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-accessentry-accesspolicy.html#cfn-eks-accessentry-accesspolicy-accessscope", "UpdateType": "Mutable", "Required": true, "Type": "AccessScope" } } }, "AWS::EKS::AccessEntry.AccessScope": { "MarkdownDocumentation": "`AWS::EKS::AccessEntry.AccessScope`\n\nThe scope of an `AccessPolicy` that's associated to an\n`AccessEntry`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-accessentry-accessscope.html", "Properties": { "Namespaces": { "MarkdownDocumentation": "`Namespaces`\n\nA Kubernetes `namespace` that an access policy is scoped to. A value is required\nif you specified `namespace` for `Type`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-accessentry-accessscope.html#cfn-eks-accessentry-accessscope-namespaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe scope type of an access policy.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `namespace | cluster...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "namespace", "cluster" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-accessentry-accessscope.html#cfn-eks-accessentry-accessscope-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::Addon.NamespaceConfig": { "MarkdownDocumentation": "`AWS::EKS::Addon.NamespaceConfig`\n\nThe `NamespaceConfig` property type specifies Property description not available. for an [AWS::EKS::Addon](./aws-resource-eks-addon.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-namespaceconfig.html", "Properties": { "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-namespaceconfig.html#cfn-eks-addon-namespaceconfig-namespace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::Addon.PodIdentityAssociation": { "MarkdownDocumentation": "`AWS::EKS::Addon.PodIdentityAssociation`\n\nAmazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-podidentityassociation.html", "Properties": { "ServiceAccount": { "MarkdownDocumentation": "`ServiceAccount`\n\nThe name of the Kubernetes service account inside the cluster to associate the IAM\ncredentials with.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-podidentityassociation.html#cfn-eks-addon-podidentityassociation-serviceaccount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity\nagent manages credentials to assume this role for applications in the containers in the\nPods that use this service account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-cn|-us-gov|-iso(-[a-z])?)?:iam::\\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-podidentityassociation.html#cfn-eks-addon-podidentityassociation-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::Capability.ArgoCd": { "MarkdownDocumentation": "`AWS::EKS::Capability.ArgoCd`\n\nThe `ArgoCd` property type specifies Property description not available. for an [AWS::EKS::Capability](./aws-resource-eks-capability.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html", "Properties": { "ServerUrl": { "MarkdownDocumentation": "`ServerUrl`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-serverurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkAccess": { "MarkdownDocumentation": "`NetworkAccess`\n\nProperty description not available.\n*Required*: No\n*Type*: [NetworkAccess](./aws-properties-eks-capability-networkaccess.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-networkaccess", "UpdateType": "Mutable", "Required": false, "Type": "NetworkAccess" }, "AwsIdc": { "MarkdownDocumentation": "`AwsIdc`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [AwsIdc](./aws-properties-eks-capability-awsidc.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-awsidc", "UpdateType": "Immutable", "Required": true, "Type": "AwsIdc" }, "RbacRoleMappings": { "MarkdownDocumentation": "`RbacRoleMappings`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [ArgoCdRoleMapping](./aws-properties-eks-capability-argocdrolemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-rbacrolemappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ArgoCdRoleMapping", "DuplicatesAllowed": true }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-namespace", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Capability.ArgoCdRoleMapping": { "MarkdownDocumentation": "`AWS::EKS::Capability.ArgoCdRoleMapping`\n\nA mapping between an Argo CD role and IAM Identity CenterIAM; Identity Center identities. This defines which users or groups have specific permissions in Argo CD.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocdrolemapping.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe Argo CD role to assign. Valid values are:\n* `ADMIN` \u2013 Full administrative access to Argo CD.\n* `EDITOR` \u2013 Edit access to Argo CD resources.\n* `VIEWER` \u2013 Read-only access to Argo CD resources.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ADMIN | EDITOR | VIEWER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ADMIN", "EDITOR", "VIEWER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocdrolemapping.html#cfn-eks-capability-argocdrolemapping-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Identities": { "MarkdownDocumentation": "`Identities`\n\nA list of IAM Identity CenterIAM; Identity Center identities (users or groups) that should be assigned this Argo CD role.\n*Required*: Yes\n*Type*: Array of [SsoIdentity](./aws-properties-eks-capability-ssoidentity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocdrolemapping.html#cfn-eks-capability-argocdrolemapping-identities", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SsoIdentity", "DuplicatesAllowed": true } } }, "AWS::EKS::Capability.AwsIdc": { "MarkdownDocumentation": "`AWS::EKS::Capability.AwsIdc`\n\nThe `AwsIdc` property type specifies Property description not available. for an [AWS::EKS::Capability](./aws-resource-eks-capability.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-awsidc.html", "Properties": { "IdcRegion": { "MarkdownDocumentation": "`IdcRegion`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-awsidc.html#cfn-eks-capability-awsidc-idcregion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IdcManagedApplicationArn": { "MarkdownDocumentation": "`IdcManagedApplicationArn`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-awsidc.html#cfn-eks-capability-awsidc-idcmanagedapplicationarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IdcInstanceArn": { "MarkdownDocumentation": "`IdcInstanceArn`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-awsidc.html#cfn-eks-capability-awsidc-idcinstancearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::Capability.CapabilityConfiguration": { "MarkdownDocumentation": "`AWS::EKS::Capability.CapabilityConfiguration`\n\nThe `CapabilityConfiguration` property type specifies Property description not available. for an [AWS::EKS::Capability](./aws-resource-eks-capability.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-capabilityconfiguration.html", "Properties": { "ArgoCd": { "MarkdownDocumentation": "`ArgoCd`\n\nProperty description not available.\n*Required*: No\n*Type*: [ArgoCd](./aws-properties-eks-capability-argocd.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-capabilityconfiguration.html#cfn-eks-capability-capabilityconfiguration-argocd", "UpdateType": "Mutable", "Required": false, "Type": "ArgoCd" } } }, "AWS::EKS::Capability.NetworkAccess": { "MarkdownDocumentation": "`AWS::EKS::Capability.NetworkAccess`\n\nThe `NetworkAccess` property type specifies Property description not available. for an [AWS::EKS::Capability](./aws-resource-eks-capability.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-networkaccess.html", "Properties": { "VpceIds": { "MarkdownDocumentation": "`VpceIds`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-networkaccess.html#cfn-eks-capability-networkaccess-vpceids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EKS::Capability.SsoIdentity": { "MarkdownDocumentation": "`AWS::EKS::Capability.SsoIdentity`\n\nAn IAM Identity CenterIAM; Identity Center identity (user or group) that can be assigned permissions in a capability.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-ssoidentity.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of identity. Valid values are `SSO_USER` or `SSO_GROUP`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SSO_USER | SSO_GROUP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SSO_USER", "SSO_GROUP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-ssoidentity.html#cfn-eks-capability-ssoidentity-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the IAM Identity CenterIAM; Identity Center user or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-ssoidentity.html#cfn-eks-capability-ssoidentity-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::Cluster.AccessConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.AccessConfig`\n\nThe access configuration for the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-accessconfig.html", "Properties": { "AuthenticationMode": { "MarkdownDocumentation": "`AuthenticationMode`\n\nThe desired authentication mode for the cluster. If you create a cluster by using the\nEKS API, AWS SDKs, or AWS CloudFormation, the default is `CONFIG_MAP`. If you create\nthe cluster by using the AWS Management Console, the default value is\n`API_AND_CONFIG_MAP`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CONFIG_MAP | API_AND_CONFIG...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONFIG_MAP", "API_AND_CONFIG_MAP", "API" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-accessconfig.html#cfn-eks-cluster-accessconfig-authenticationmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BootstrapClusterCreatorAdminPermissions": { "MarkdownDocumentation": "`BootstrapClusterCreatorAdminPermissions`\n\nSpecifies whether or not the cluster creator IAM principal was set as a cluster\nadmin access entry during cluster creation time. The default value is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-accessconfig.html#cfn-eks-cluster-accessconfig-bootstrapclustercreatoradminpermissions", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EKS::Cluster.BlockStorage": { "MarkdownDocumentation": "`AWS::EKS::Cluster.BlockStorage`\n\nIndicates the current configuration of the block storage capability on your EKS Auto\nMode cluster. For example, if the capability is enabled or disabled. If the block\nstorage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your\nAWS account. For more information, see EKS Auto Mode block storage capability in the\n*Amazon EKS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-blockstorage.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates if the block storage capability is enabled on your EKS Auto Mode cluster. If\nthe block storage capability is enabled, EKS Auto Mode will create and delete EBS\nvolumes in your AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-blockstorage.html#cfn-eks-cluster-blockstorage-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EKS::Cluster.ClusterLogging": { "MarkdownDocumentation": "`AWS::EKS::Cluster.ClusterLogging`\n\nThe cluster control plane logging configuration for your cluster.\n###### Important\nWhen updating a resource, you must include this `ClusterLogging`\nproperty if the previous CloudFormation template of the resource had it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-clusterlogging.html", "Properties": { "EnabledTypes": { "MarkdownDocumentation": "`EnabledTypes`\n\nThe enabled control plane logs for your cluster. All log types are disabled if the\narray is empty.\n###### Important\nWhen updating a resource, you must include this `EnabledTypes` property\nif the previous CloudFormation template of the resource had it.\n*Required*: No\n*Type*: Array of [LoggingTypeConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-clusterlogging.html#cfn-eks-cluster-clusterlogging-enabledtypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LoggingTypeConfig", "DuplicatesAllowed": true } } }, "AWS::EKS::Cluster.ComputeConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.ComputeConfig`\n\nIndicates the current configuration of the compute capability on your EKS Auto Mode\ncluster. For example, if the capability is enabled or disabled. If the compute\ncapability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in\nyour AWS account. For more information, see EKS Auto Mode compute capability in the\n*Amazon EKS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-computeconfig.html", "Properties": { "NodePools": { "MarkdownDocumentation": "`NodePools`\n\nConfiguration for node pools that defines the compute resources for your EKS Auto Mode\ncluster. For more information, see EKS Auto Mode Node Pools in the\n*Amazon EKS User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-computeconfig.html#cfn-eks-cluster-computeconfig-nodepools", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NodeRoleArn": { "MarkdownDocumentation": "`NodeRoleArn`\n\nThe ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto\nMode cluster. This value cannot be changed after the compute capability of EKS Auto Mode\nis enabled. For more information, see the IAM Reference in the\n*Amazon EKS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-computeconfig.html#cfn-eks-cluster-computeconfig-noderolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nRequest to enable or disable the compute capability on your EKS Auto Mode cluster. If\nthe compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed\nInstances in your AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-computeconfig.html#cfn-eks-cluster-computeconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EKS::Cluster.ControlPlanePlacement": { "MarkdownDocumentation": "`AWS::EKS::Cluster.ControlPlanePlacement`\n\nThe placement configuration for all the control plane instances of your local Amazon EKS\ncluster on an AWS Outpost. For more information, see [Capacity\nconsiderations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-controlplaneplacement.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the placement group for the Kubernetes control plane instances. This\nproperty is only used for a local cluster on an AWS Outpost.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-controlplaneplacement.html#cfn-eks-cluster-controlplaneplacement-groupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Cluster.ControlPlaneScalingConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.ControlPlaneScalingConfig`\n\nThe control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-controlplanescalingconfig.html", "Properties": { "Tier": { "MarkdownDocumentation": "`Tier`\n\nThe control plane scaling tier configuration. Available options are `standard`, `tier-xl`, `tier-2xl`, or `tier-4xl`. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | tier-xl | tier-2...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "tier-xl", "tier-2xl", "tier-4xl" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-controlplanescalingconfig.html#cfn-eks-cluster-controlplanescalingconfig-tier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Cluster.ElasticLoadBalancing": { "MarkdownDocumentation": "`AWS::EKS::Cluster.ElasticLoadBalancing`\n\nIndicates the current configuration of the load balancing capability on your EKS Auto\nMode cluster. For example, if the capability is enabled or disabled. For more\ninformation, see EKS Auto Mode load balancing capability in the *Amazon EKS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-elasticloadbalancing.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates if the load balancing capability is enabled on your EKS Auto Mode cluster.\nIf the load balancing capability is enabled, EKS Auto Mode will create and delete load\nbalancers in your AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-elasticloadbalancing.html#cfn-eks-cluster-elasticloadbalancing-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EKS::Cluster.EncryptionConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.EncryptionConfig`\n\nThe encryption configuration for the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html", "Properties": { "Resources": { "MarkdownDocumentation": "`Resources`\n\nSpecifies the resources to be encrypted. The only supported value is\n`secrets`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html#cfn-eks-cluster-encryptionconfig-resources", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Provider": { "MarkdownDocumentation": "`Provider`\n\nThe encryption provider for the cluster.\n*Required*: No\n*Type*: [Provider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html#cfn-eks-cluster-encryptionconfig-provider", "UpdateType": "Immutable", "Required": false, "Type": "Provider" } } }, "AWS::EKS::Cluster.KubernetesNetworkConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.KubernetesNetworkConfig`\n\nThe Kubernetes network configuration for the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html", "Properties": { "ServiceIpv4Cidr": { "MarkdownDocumentation": "`ServiceIpv4Cidr`\n\nDon't specify a value if you select `ipv6` for **ipFamily**. The CIDR block to assign Kubernetes service IP addresses from. If\nyou don't specify a block, Kubernetes assigns addresses from either the\n`10.100.0.0/16` or `172.20.0.0/16` CIDR blocks. We recommend\nthat you specify a block that does not overlap with resources in other networks that are\npeered or connected to your VPC. The block must meet the following requirements:\n* Within one of the following private IP address blocks:\n `10.0.0.0/8`, `172.16.0.0/12`, or\n `192.168.0.0/16`.\n* Doesn't overlap with any CIDR block assigned to the VPC that you selected for\n VPC.\n* Between `/24` and `/12`.\n###### Important\nYou can only specify a custom CIDR block when you create a cluster. You can't\nchange this value after 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html#cfn-eks-cluster-kubernetesnetworkconfig-serviceipv4cidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServiceIpv6Cidr": { "MarkdownDocumentation": "`ServiceIpv6Cidr`\n\nThe CIDR block that Kubernetes pod and service IP addresses are assigned from if you\ncreated a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and\nspecified `ipv6` for **ipFamily** when you\ncreated the cluster. Kubernetes assigns service addresses from the unique local address range\n(`fc00::/7`) because you can't specify a custom IPv6 CIDR block when you\ncreate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html#cfn-eks-cluster-kubernetesnetworkconfig-serviceipv6cidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpFamily": { "MarkdownDocumentation": "`IpFamily`\n\nSpecify which IP family is used to assign Kubernetes pod and service IP addresses. If you\ndon't specify a value, `ipv4` is used by default. You can only specify an IP\nfamily when you create a cluster and can't change this value once the cluster is\ncreated. If you specify `ipv6`, the VPC and subnets that you specify for\ncluster creation must have both `IPv4` and `IPv6` CIDR blocks\nassigned to them. You can't specify `ipv6` for clusters in China\nRegions.\nYou can only specify `ipv6` for `1.21` and later clusters that\nuse version `1.10.1` or later of the Amazon VPC CNI add-on. If you specify\n`ipv6`, then ensure that your VPC meets the requirements listed in the\nconsiderations listed in [Assigning IPv6 addresses to pods and\nservices](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the *Amazon EKS User Guide*. Kubernetes assigns services `IPv6`\naddresses from the unique local address range `(fc00::/7)`. You can't specify\na custom `IPv6` CIDR block. Pod addresses are assigned from the subnet's\n`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)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html#cfn-eks-cluster-kubernetesnetworkconfig-ipfamily", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ElasticLoadBalancing": { "MarkdownDocumentation": "`ElasticLoadBalancing`\n\nRequest to enable or disable the load balancing capability on your EKS Auto Mode\ncluster. For more information, see EKS Auto Mode load balancing capability in the\n*Amazon EKS User Guide*.\n*Required*: No\n*Type*: [ElasticLoadBalancing](./aws-properties-eks-cluster-elasticloadbalancing.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html#cfn-eks-cluster-kubernetesnetworkconfig-elasticloadbalancing", "UpdateType": "Mutable", "Required": false, "Type": "ElasticLoadBalancing" } } }, "AWS::EKS::Cluster.Logging": { "MarkdownDocumentation": "`AWS::EKS::Cluster.Logging`\n\nEnable or disable exporting the Kubernetes control plane logs for your cluster to\nCloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch\nLogs. For more information, see [Amazon EKS Cluster control plane\nlogs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the **Amazon EKS User Guide**.\n###### Important\nWhen updating a resource, you must include this `Logging` property if\nthe previous CloudFormation template of the resource had it.\n###### Note\nCloudWatch Logs ingestion, archive storage, and data scanning rates apply to\nexported control plane logs. For more information, see [CloudWatch Pricing](https://aws.amazon.com/cloudwatch/pricing/).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-logging.html", "Properties": { "ClusterLogging": { "MarkdownDocumentation": "`ClusterLogging`\n\nThe cluster control plane logging configuration for your cluster.\n*Required*: No\n*Type*: [ClusterLogging](./aws-properties-eks-cluster-clusterlogging.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-logging.html#cfn-eks-cluster-logging-clusterlogging", "UpdateType": "Mutable", "Required": false, "Type": "ClusterLogging" } } }, "AWS::EKS::Cluster.LoggingTypeConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.LoggingTypeConfig`\n\nThe enabled logging type. For a list of the valid logging types, see the [`types` property of `LogSetup`](https://docs.aws.amazon.com/eks/latest/APIReference/API_LogSetup.html#AmazonEKS-Type-LogSetup-types) in the\n*Amazon EKS API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-loggingtypeconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe name of the log type.\n*Required*: No\n*Type*: String\n*Allowed values*: `api | audit | authenticator...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-loggingtypeconfig.html#cfn-eks-cluster-loggingtypeconfig-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Cluster.OutpostConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.OutpostConfig`\n\nThe configuration of your local Amazon EKS cluster on an AWS Outpost. Before creating a\ncluster on an Outpost, review [Creating a local\ncluster on an Outpost](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-create.html) in the *Amazon EKS User Guide*. This API isn't available for\nAmazon EKS clusters on the AWS cloud.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-outpostconfig.html", "Properties": { "OutpostArns": { "MarkdownDocumentation": "`OutpostArns`\n\nThe ARN of the Outpost that you want to use for your local Amazon EKS cluster on\nOutposts. Only a single Outpost ARN is supported.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-outpostconfig.html#cfn-eks-cluster-outpostconfig-outpostarns", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ControlPlanePlacement": { "MarkdownDocumentation": "`ControlPlanePlacement`\n\nAn object representing the placement configuration for all the control plane instances\nof 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-outpostconfig.html#cfn-eks-cluster-outpostconfig-controlplaneplacement", "UpdateType": "Immutable", "Required": false, "Type": "ControlPlanePlacement" }, "ControlPlaneInstanceType": { "MarkdownDocumentation": "`ControlPlaneInstanceType`\n\nThe Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts.\nChoose an instance type based on the number of nodes that your cluster will have. For\nmore information, see [Capacity\nconsiderations](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\ninstance type can't be changed after cluster creation. The control plane is not\nautomatically scaled by Amazon EKS.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-outpostconfig.html#cfn-eks-cluster-outpostconfig-controlplaneinstancetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::Cluster.Provider": { "MarkdownDocumentation": "`AWS::EKS::Cluster.Provider`\n\nIdentifies the AWS Key Management Service (AWS KMS) key used to encrypt the secrets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html", "Properties": { "KeyArn": { "MarkdownDocumentation": "`KeyArn`\n\nAmazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in\nthe same AWS Region as the cluster. If the KMS key was created in a different\naccount, the [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) must have access to the KMS key. For more information,\nsee [Allowing\nusers 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\nDeveloper 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html#cfn-eks-cluster-provider-keyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Cluster.RemoteNetworkConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.RemoteNetworkConfig`\n\nThe configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this\nconfiguration after the cluster is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-remotenetworkconfig.html", "Properties": { "RemoteNodeNetworks": { "MarkdownDocumentation": "`RemoteNodeNetworks`\n\nThe list of network CIDRs that can contain hybrid nodes.\nThese CIDR blocks define the expected IP address range of the hybrid nodes that join\nthe cluster. These blocks are typically determined by your network administrator.\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,\n `10.2.0.0/16`).\nIt must satisfy the following requirements:\n* Each block must be within an `IPv4` RFC-1918 network range. Minimum\n allowed size is /32, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.\n* Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.\n* Each block must have a route to the VPC that uses the VPC CIDR blocks, not\n public IPs or Elastic IPs. There are many options including AWS Transit Gateway,\n AWS Site-to-Site VPN, or AWS Direct Connect.\n* Each host must allow outbound connection to the EKS cluster control plane on\n TCP ports `443` and `10250`.\n* Each host must allow inbound connection from the EKS cluster control plane on\n TCP port 10250 for logs, exec and port-forward operations.\n* Each host must allow TCP and UDP network connectivity to and from other hosts\n that are running `CoreDNS` on UDP port `53` for service and pod DNS\n names.\n*Required*: Yes\n*Type*: Array of [RemoteNodeNetwork](./aws-properties-eks-cluster-remotenodenetwork.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-remotenetworkconfig.html#cfn-eks-cluster-remotenetworkconfig-remotenodenetworks", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RemoteNodeNetwork", "DuplicatesAllowed": true }, "RemotePodNetworks": { "MarkdownDocumentation": "`RemotePodNetworks`\n\nThe list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid\nnodes.\nThese CIDR blocks are determined by configuring your Container Network Interface (CNI)\nplugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\navailable for on-premises and edge locations.\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,\n `10.2.0.0/16`).\nIt must satisfy the following requirements:\n* Each block must be within an `IPv4` RFC-1918 network range. Minimum\n allowed size is /32, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.\n* Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.\n*Required*: No\n*Type*: Array of [RemotePodNetwork](./aws-properties-eks-cluster-remotepodnetwork.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-remotenetworkconfig.html#cfn-eks-cluster-remotenetworkconfig-remotepodnetworks", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RemotePodNetwork", "DuplicatesAllowed": true } } }, "AWS::EKS::Cluster.RemoteNodeNetwork": { "MarkdownDocumentation": "`AWS::EKS::Cluster.RemoteNodeNetwork`\n\nA network CIDR that can contain hybrid nodes.\nThese CIDR blocks define the expected IP address range of the hybrid nodes that join\nthe cluster. These blocks are typically determined by your network administrator.\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,\n `10.2.0.0/16`).\nIt must satisfy the following requirements:\n* Each block must be within an `IPv4` RFC-1918 network range. Minimum\n allowed size is /32, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.\n* Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.\n* Each block must have a route to the VPC that uses the VPC CIDR blocks, not\n public IPs or Elastic IPs. There are many options including AWS Transit Gateway,\n AWS Site-to-Site VPN, or AWS Direct Connect.\n* Each host must allow outbound connection to the EKS cluster control plane on\n TCP ports `443` and `10250`.\n* Each host must allow inbound connection from the EKS cluster control plane on\n TCP port 10250 for logs, exec and port-forward operations.\n* Each host must allow TCP and UDP network connectivity to and from other hosts\n that are running `CoreDNS` on UDP port `53` for service and pod DNS\n names.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-remotenodenetwork.html", "Properties": { "Cidrs": { "MarkdownDocumentation": "`Cidrs`\n\nA network CIDR that can contain hybrid nodes.\nThese CIDR blocks define the expected IP address range of the hybrid nodes that join\nthe cluster. These blocks are typically determined by your network administrator.\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,\n `10.2.0.0/16`).\nIt must satisfy the following requirements:\n* Each block must be within an `IPv4` RFC-1918 network range. Minimum\n allowed size is /32, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.\n* Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.\n* Each block must have a route to the VPC that uses the VPC CIDR blocks, not\n public IPs or Elastic IPs. There are many options including AWS Transit Gateway,\n AWS Site-to-Site VPN, or AWS Direct Connect.\n* Each host must allow outbound connection to the EKS cluster control plane on\n TCP ports `443` and `10250`.\n* Each host must allow inbound connection from the EKS cluster control plane on\n TCP port 10250 for logs, exec and port-forward operations.\n* Each host must allow TCP and UDP network connectivity to and from other hosts\n that are running `CoreDNS` on UDP port `53` for service and pod DNS\n names.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-remotenodenetwork.html#cfn-eks-cluster-remotenodenetwork-cidrs", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EKS::Cluster.RemotePodNetwork": { "MarkdownDocumentation": "`AWS::EKS::Cluster.RemotePodNetwork`\n\nA network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.\nThese CIDR blocks are determined by configuring your Container Network Interface (CNI)\nplugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\navailable for on-premises and edge locations.\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,\n `10.2.0.0/16`).\nIt must satisfy the following requirements:\n* Each block must be within an `IPv4` RFC-1918 network range. Minimum\n allowed size is /32, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.\n* Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-remotepodnetwork.html", "Properties": { "Cidrs": { "MarkdownDocumentation": "`Cidrs`\n\nA network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.\nThese CIDR blocks are determined by configuring your Container Network Interface (CNI)\nplugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\navailable for on-premises and edge locations.\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,\n `10.2.0.0/16`).\nIt must satisfy the following requirements:\n* Each block must be within an `IPv4` RFC-1918 network range. Minimum\n allowed size is /32, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.\n* Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-remotepodnetwork.html#cfn-eks-cluster-remotepodnetwork-cidrs", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EKS::Cluster.ResourcesVpcConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.ResourcesVpcConfig`\n\nAn object representing the VPC configuration to use for an Amazon EKS cluster.\n###### Important\nWhen updating a resource, you must include these properties if the previous\nCloudFormation template of the resource had them:\n* `EndpointPublicAccess`\n* `EndpointPrivateAccess`\n* `PublicAccessCidrs`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html", "Properties": { "EndpointPublicAccess": { "MarkdownDocumentation": "`EndpointPublicAccess`\n\nSet this value to `false` to disable public access to your cluster's Kubernetes\nAPI server endpoint. If you disable public access, your cluster's Kubernetes API server can\nonly receive requests from within the cluster VPC. The default value for this parameter\nis `true`, which enables public access for your Kubernetes API server. The\nendpoint domain name and IP address family depends on the value of the\n`ipFamily` for the cluster. For more information, see [Cluster API\nserver endpoint](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-endpointpublicaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PublicAccessCidrs": { "MarkdownDocumentation": "`PublicAccessCidrs`\n\nThe CIDR blocks that are allowed access to your cluster's public Kubernetes API server\nendpoint. Communication to the endpoint from addresses outside of the CIDR blocks that\nyou specify is denied. The default value is `0.0.0.0/0` and additionally\n`::/0` for dual-stack `IPv6` clusters. If you've disabled private\nendpoint access, make sure that you specify the necessary CIDR blocks for every node and\nAWS Fargate`Pod` in the cluster. For more information, see [Cluster\nAPI server endpoint](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the **Amazon EKS User Guide**.\nNote that the public endpoints are dual-stack for only `IPv6` clusters that\nare made after October 2024. You can't add `IPv6` CIDR blocks to\n`IPv4` clusters or `IPv6` clusters that were made before\nOctober 2024.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-publicaccesscidrs", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EndpointPrivateAccess": { "MarkdownDocumentation": "`EndpointPrivateAccess`\n\nSet this value to `true` to enable private access for your cluster's Kubernetes\nAPI server endpoint. If you enable private access, Kubernetes API requests from within your\ncluster's VPC use the private VPC endpoint. The default value for this parameter is\n`false`, which disables private access for your Kubernetes API server. If you\ndisable private access and you have nodes or AWS Fargate pods in the cluster, then\nensure that `publicAccessCidrs` includes the necessary CIDR blocks for\ncommunication with the nodes or Fargate pods. For more information, see [Cluster\nAPI server endpoint](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-endpointprivateaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nSpecify one or more security groups for the cross-account elastic network interfaces\nthat Amazon EKS creates to use that allow communication between your nodes and the Kubernetes\ncontrol plane. If you don't specify any security groups, then familiarize yourself with\nthe difference between Amazon EKS defaults for clusters deployed with Kubernetes. For more\ninformation, see [Amazon EKS security group\nconsiderations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the **Amazon EKS User Guide**.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nSpecify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network\ninterfaces in these subnets to allow communication between your nodes and the Kubernetes\ncontrol plane.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EKS::Cluster.StorageConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.StorageConfig`\n\nRequest to update the configuration of the storage capability of your EKS Auto Mode\ncluster. For example, enable the capability. For more information, see EKS Auto Mode\nblock storage capability in the *Amazon EKS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-storageconfig.html", "Properties": { "BlockStorage": { "MarkdownDocumentation": "`BlockStorage`\n\nRequest to configure EBS Block Storage settings for your EKS Auto Mode cluster.\n*Required*: No\n*Type*: [BlockStorage](./aws-properties-eks-cluster-blockstorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-storageconfig.html#cfn-eks-cluster-storageconfig-blockstorage", "UpdateType": "Mutable", "Required": false, "Type": "BlockStorage" } } }, "AWS::EKS::Cluster.UpgradePolicy": { "MarkdownDocumentation": "`AWS::EKS::Cluster.UpgradePolicy`\n\nThe support policy to use for the cluster. Extended support allows you to remain on\nspecific Kubernetes versions for longer. Clusters in extended support have higher costs. The\ndefault value is `EXTENDED`. Use `STANDARD` to disable extended\nsupport.\n[Learn more about EKS Extended Support in the *Amazon EKS User Guide*.](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-upgradepolicy.html", "Properties": { "SupportType": { "MarkdownDocumentation": "`SupportType`\n\nIf the cluster is set to `EXTENDED`, it will enter extended support at the\nend of standard support. If the cluster is set to `STANDARD`, it will be\nautomatically upgraded at the end of standard support.\n[Learn more about EKS Extended Support in the *Amazon EKS User Guide*.](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html)\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | EXTENDED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "EXTENDED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-upgradepolicy.html#cfn-eks-cluster-upgradepolicy-supporttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Cluster.ZonalShiftConfig": { "MarkdownDocumentation": "`AWS::EKS::Cluster.ZonalShiftConfig`\n\nThe configuration for zonal shift for the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-zonalshiftconfig.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIf zonal shift is enabled, AWS configures zonal autoshift 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-zonalshiftconfig.html#cfn-eks-cluster-zonalshiftconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EKS::FargateProfile.Label": { "MarkdownDocumentation": "`AWS::EKS::FargateProfile.Label`\n\nA key-value pair.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nEnter a value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html#cfn-eks-fargateprofile-label-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nEnter a key.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `127`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html#cfn-eks-fargateprofile-label-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::FargateProfile.Selector": { "MarkdownDocumentation": "`AWS::EKS::FargateProfile.Selector`\n\nAn object representing an AWS Fargate profile selector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html", "Properties": { "Labels": { "MarkdownDocumentation": "`Labels`\n\nThe Kubernetes labels that the selector should match. A pod must contain all of the labels\nthat are specified in the selector for it to be considered a match.\n*Required*: No\n*Type*: Array of [Label](./aws-properties-eks-fargateprofile-label.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html#cfn-eks-fargateprofile-selector-labels", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Label", "DuplicatesAllowed": true }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe Kubernetes `namespace` that the selector should match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html#cfn-eks-fargateprofile-selector-namespace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::IdentityProviderConfig.OidcIdentityProviderConfig": { "MarkdownDocumentation": "`AWS::EKS::IdentityProviderConfig.OidcIdentityProviderConfig`\n\nAn object representing the configuration for an OpenID Connect (OIDC) identity provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html", "Properties": { "UsernamePrefix": { "MarkdownDocumentation": "`UsernamePrefix`\n\nThe prefix that is prepended to username claims to prevent clashes with existing\nnames. The prefix can't contain `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-usernameprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GroupsPrefix": { "MarkdownDocumentation": "`GroupsPrefix`\n\nThe prefix that is prepended to group claims to prevent clashes with existing names\n(such as `system:` groups). For example, the value `oidc:` creates\ngroup names like `oidc:engineering` and `oidc:infra`. The prefix\ncan't contain `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-groupsprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IssuerUrl": { "MarkdownDocumentation": "`IssuerUrl`\n\nThe URL of the OIDC identity provider that allows the API server to discover public\nsigning keys for verifying tokens.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-issuerurl", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RequiredClaims": { "MarkdownDocumentation": "`RequiredClaims`\n\nThe key-value pairs that describe required claims in the identity token. If set, each\nclaim is verified to be present in the token with a matching value.\n*Required*: No\n*Type*: Array of [RequiredClaim](./aws-properties-eks-identityproviderconfig-requiredclaim.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-requiredclaims", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "RequiredClaim", "DuplicatesAllowed": false }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThis is also known as *audience*. The ID of the client application\nthat makes authentication requests to the OIDC identity provider.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-clientid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GroupsClaim": { "MarkdownDocumentation": "`GroupsClaim`\n\nThe JSON web token (JWT) claim that the provider uses to return your groups.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-groupsclaim", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UsernameClaim": { "MarkdownDocumentation": "`UsernameClaim`\n\nThe JSON Web token (JWT) claim that is used as the username.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html#cfn-eks-identityproviderconfig-oidcidentityproviderconfig-usernameclaim", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::IdentityProviderConfig.RequiredClaim": { "MarkdownDocumentation": "`AWS::EKS::IdentityProviderConfig.RequiredClaim`\n\nA key-value pair that describes a required claim in the identity token. If set, each\nclaim is verified to be present in the token with a matching value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-requiredclaim.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the key from the token.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `253`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-requiredclaim.html#cfn-eks-identityproviderconfig-requiredclaim-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key to match from the token.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-requiredclaim.html#cfn-eks-identityproviderconfig-requiredclaim-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::Nodegroup.LaunchTemplateSpecification": { "MarkdownDocumentation": "`AWS::EKS::Nodegroup.LaunchTemplateSpecification`\n\nAn object representing a node group launch template specification. The launch template\ncan't include [`SubnetId`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html), [`IamInstanceProfile`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html), [`RequestSpotInstances`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html), [`HibernationOptions`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html), or [`TerminateInstances`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TerminateInstances.html), or the node group deployment or\nupdate will fail. For more information about launch templates, see [`CreateLaunchTemplate`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) in the Amazon EC2 API Reference.\nFor more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*.\nYou must specify either the launch template ID or the launch template name in the\nrequest, but not both.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nThe version number of the launch template to use. If no version is specified, then the\ntemplate's default version is used. You can use a different version for node group\nupdates.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html#cfn-eks-nodegroup-launchtemplatespecification-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the launch template.\nYou must specify either the launch template ID or the launch template name in the\nrequest, but not both. After node group creation, you cannot use a different ID.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html#cfn-eks-nodegroup-launchtemplatespecification-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the launch template.\nYou must specify either the launch template name or the launch template ID in the\nrequest, but not both. After node group creation, you cannot use a different\nname.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html#cfn-eks-nodegroup-launchtemplatespecification-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Nodegroup.NodeRepairConfig": { "MarkdownDocumentation": "`AWS::EKS::Nodegroup.NodeRepairConfig`\n\nThe node auto repair configuration for the node group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfig.html", "Properties": { "NodeRepairConfigOverrides": { "MarkdownDocumentation": "`NodeRepairConfigOverrides`\n\nSpecify granular overrides for specific repair actions. These overrides control the\nrepair action and the repair delay time before a node is considered eligible for repair.\nIf you use this, you must specify all the values.\n*Required*: No\n*Type*: [Array](./aws-properties-eks-nodegroup-noderepairconfigoverrides.html) of [NodeRepairConfigOverrides](./aws-properties-eks-nodegroup-noderepairconfigoverrides.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfig.html#cfn-eks-nodegroup-noderepairconfig-noderepairconfigoverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NodeRepairConfigOverrides", "DuplicatesAllowed": true }, "MaxParallelNodesRepairedCount": { "MarkdownDocumentation": "`MaxParallelNodesRepairedCount`\n\nSpecify the maximum number of nodes that can be repaired concurrently or in parallel,\nexpressed as a count of unhealthy nodes. This gives you finer-grained control over the\npace of node replacements. When using this, you cannot also set\n`maxParallelNodesRepairedPercentage` at the same time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfig.html#cfn-eks-nodegroup-noderepairconfig-maxparallelnodesrepairedcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether to enable node auto repair for the node group. Node auto repair is\ndisabled 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfig.html#cfn-eks-nodegroup-noderepairconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxUnhealthyNodeThresholdPercentage": { "MarkdownDocumentation": "`MaxUnhealthyNodeThresholdPercentage`\n\nSpecify a percentage threshold of unhealthy nodes, above which node auto\nrepair actions will stop. When using this, you cannot also set\n`maxUnhealthyNodeThresholdCount` at the same time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfig.html#cfn-eks-nodegroup-noderepairconfig-maxunhealthynodethresholdpercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxParallelNodesRepairedPercentage": { "MarkdownDocumentation": "`MaxParallelNodesRepairedPercentage`\n\nSpecify the maximum number of nodes that can be repaired concurrently or in parallel,\nexpressed as a percentage of unhealthy nodes. This gives you finer-grained control over the\npace of node replacements. When using this, you cannot also set\n`maxParallelNodesRepairedCount` at the same time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfig.html#cfn-eks-nodegroup-noderepairconfig-maxparallelnodesrepairedpercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxUnhealthyNodeThresholdCount": { "MarkdownDocumentation": "`MaxUnhealthyNodeThresholdCount`\n\nSpecify a count threshold of unhealthy nodes, above which node auto\nrepair actions will stop. When using this, you cannot also set\n`maxUnhealthyNodeThresholdPercentage` at the same time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfig.html#cfn-eks-nodegroup-noderepairconfig-maxunhealthynodethresholdcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EKS::Nodegroup.NodeRepairConfigOverrides": { "MarkdownDocumentation": "`AWS::EKS::Nodegroup.NodeRepairConfigOverrides`\n\nSpecify granular overrides for specific repair actions. These overrides control the\nrepair action and the repair delay time before a node is considered eligible for repair.\nIf you use this, you must specify all the values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfigoverrides.html", "Properties": { "NodeUnhealthyReason": { "MarkdownDocumentation": "`NodeUnhealthyReason`\n\nSpecify a reason reported by the node monitoring agent that this\noverride would apply 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfigoverrides.html#cfn-eks-nodegroup-noderepairconfigoverrides-nodeunhealthyreason", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RepairAction": { "MarkdownDocumentation": "`RepairAction`\n\nSpecify the repair action to take for nodes when all of the specified conditions are\nmet.\n*Required*: No\n*Type*: String\n*Allowed values*: `Replace | Reboot | NoAction...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Replace", "Reboot", "NoAction" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfigoverrides.html#cfn-eks-nodegroup-noderepairconfigoverrides-repairaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinRepairWaitTimeMins": { "MarkdownDocumentation": "`MinRepairWaitTimeMins`\n\nSpecify the minimum time in minutes to wait before attempting to repair a node\nwith this specific `nodeMonitoringCondition` and\n`nodeUnhealthyReason`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfigoverrides.html#cfn-eks-nodegroup-noderepairconfigoverrides-minrepairwaittimemins", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NodeMonitoringCondition": { "MarkdownDocumentation": "`NodeMonitoringCondition`\n\nSpecify an unhealthy condition reported by the node monitoring agent that this\noverride would apply 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-noderepairconfigoverrides.html#cfn-eks-nodegroup-noderepairconfigoverrides-nodemonitoringcondition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Nodegroup.RemoteAccess": { "MarkdownDocumentation": "`AWS::EKS::Nodegroup.RemoteAccess`\n\nAn object representing the remote access configuration for the managed node\ngroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html", "Properties": { "SourceSecurityGroups": { "MarkdownDocumentation": "`SourceSecurityGroups`\n\nThe security group IDs that are allowed SSH access (port 22) to the nodes. For\nWindows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source\nsecurity group when you create a managed node group, then the port on the nodes is\nopened to the internet (`0.0.0.0/0`). For more information, see [Security\nGroups 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*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html#cfn-eks-nodegroup-remoteaccess-sourcesecuritygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Ec2SshKey": { "MarkdownDocumentation": "`Ec2SshKey`\n\nThe Amazon EC2 SSH key name that provides access for SSH communication with the nodes in\nthe managed node group. For more information, see [Amazon EC2 key\npairs 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\nkey is used to obtain the RDP password. For more information, see [Amazon EC2 key\npairs 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html#cfn-eks-nodegroup-remoteaccess-ec2sshkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EKS::Nodegroup.ScalingConfig": { "MarkdownDocumentation": "`AWS::EKS::Nodegroup.ScalingConfig`\n\nAn object representing the scaling configuration details for the Auto Scaling group that is\nassociated with your node group. When creating a node group, you must specify all or\nnone of the properties. When updating a node group, you can specify any or none of the\nproperties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html", "Properties": { "MinSize": { "MarkdownDocumentation": "`MinSize`\n\nThe minimum number of nodes that the managed node group can scale in to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html#cfn-eks-nodegroup-scalingconfig-minsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DesiredSize": { "MarkdownDocumentation": "`DesiredSize`\n\nThe current number of nodes that the managed node group should maintain.\n###### Important\nIf you use the Kubernetes [Cluster\nAutoscaler](https://github.com/kubernetes/autoscaler#kubernetes-autoscaler), you shouldn't change the `desiredSize` value\ndirectly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\ndown.\nWhenever this parameter changes, the number of worker nodes in the node group is\nupdated to the specified size. If this parameter is given a value that is smaller than\nthe current number of running worker nodes, the necessary number of worker nodes are\nterminated to match the given value.\nWhen using CloudFormation, no action occurs if you remove this parameter from your CFN\ntemplate.\nThis parameter can be different from `minSize` in some cases, such as when\nstarting with extra hosts for testing. This parameter can also be different when you\nwant to start with an estimated number of needed hosts, but let the Cluster Autoscaler\nreduce the number if there are too many. When the Cluster Autoscaler is used, the\n`desiredSize` parameter is altered by the Cluster Autoscaler (but can be\nout-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed\nnode 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html#cfn-eks-nodegroup-scalingconfig-desiredsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxSize": { "MarkdownDocumentation": "`MaxSize`\n\nThe maximum number of nodes that the managed node group can scale out to. For\ninformation about the maximum number that you can specify, see [Amazon EKS service\nquotas](https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) in the *Amazon EKS User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html#cfn-eks-nodegroup-scalingconfig-maxsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EKS::Nodegroup.Taint": { "MarkdownDocumentation": "`AWS::EKS::Nodegroup.Taint`\n\nA property that allows a node to repel a `Pod`. For more information, see\n[Node taints on\nmanaged node groups](https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html) in the *Amazon EKS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the taint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html#cfn-eks-nodegroup-taint-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Effect": { "MarkdownDocumentation": "`Effect`\n\nThe effect of the taint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html#cfn-eks-nodegroup-taint-effect", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the taint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html#cfn-eks-nodegroup-taint-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EKS::Nodegroup.UpdateConfig": { "MarkdownDocumentation": "`AWS::EKS::Nodegroup.UpdateConfig`\n\nThe update configuration for the node group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html", "Properties": { "MaxUnavailablePercentage": { "MarkdownDocumentation": "`MaxUnavailablePercentage`\n\nThe maximum percentage of nodes unavailable during a version update. This percentage\nof nodes are updated in parallel, up to 100 nodes at once. This value or\n`maxUnavailable` is required to have a value.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-maxunavailablepercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "UpdateStrategy": { "MarkdownDocumentation": "`UpdateStrategy`\n\nThe configuration for the behavior to follow during a node group version update of\nthis managed node group. You choose between two possible strategies for replacing nodes\nduring an [`UpdateNodegroupVersion`](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateNodegroupVersion.html) action.\nAn Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI\nversions in parallel. The *update strategy* changes the managed node\nupdate behavior of the managed node group for each quantity. The\n*default* strategy has guardrails to protect you from\nmisconfiguration and launches the new instances first, before terminating the old\ninstances. The *minimal* strategy removes the guardrails and\nterminates the old instances before launching the new instances. This minimal strategy\nis useful in scenarios where you are constrained to resources or costs (for example,\nwith hardware accelerators such as GPUs).\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | MINIMAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "MINIMAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-updatestrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxUnavailable": { "MarkdownDocumentation": "`MaxUnavailable`\n\nThe maximum number of nodes unavailable at once during a version update. Nodes are\nupdated in parallel. This value or `maxUnavailablePercentage` is required to\nhave a value.The maximum number is 100.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-maxunavailable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::EMR::Cluster.Application": { "MarkdownDocumentation": "`AWS::EMR::Cluster.Application`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html", "Properties": { "AdditionalInfo": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-additionalinfo", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Args": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-args", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Version": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-version", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.AutoScalingPolicy": { "MarkdownDocumentation": "`AWS::EMR::Cluster.AutoScalingPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html", "Properties": { "Constraints": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html#cfn-elasticmapreduce-cluster-autoscalingpolicy-constraints", "Required": true, "Type": "ScalingConstraints", "UpdateType": "Mutable" }, "Rules": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html#cfn-elasticmapreduce-cluster-autoscalingpolicy-rules", "DuplicatesAllowed": false, "ItemType": "ScalingRule", "Required": true, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.AutoTerminationPolicy": { "MarkdownDocumentation": "`AWS::EMR::Cluster.AutoTerminationPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoterminationpolicy.html", "Properties": { "IdleTimeout": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoterminationpolicy.html#cfn-elasticmapreduce-cluster-autoterminationpolicy-idletimeout", "PrimitiveType": "Long", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.BootstrapActionConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.BootstrapActionConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html", "Properties": { "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html#cfn-elasticmapreduce-cluster-bootstrapactionconfig-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "ScriptBootstrapAction": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html#cfn-elasticmapreduce-cluster-bootstrapactionconfig-scriptbootstrapaction", "Required": true, "Type": "ScriptBootstrapActionConfig", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.CloudWatchAlarmDefinition": { "MarkdownDocumentation": "`AWS::EMR::Cluster.CloudWatchAlarmDefinition`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-comparisonoperator", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Dimensions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-dimensions", "DuplicatesAllowed": false, "ItemType": "MetricDimension", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "EvaluationPeriods": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-evaluationperiods", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "MetricName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-metricname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Namespace": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-namespace", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Period": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-period", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "Statistic": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-statistic", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Threshold": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-threshold", "PrimitiveType": "Double", "Required": true, "UpdateType": "Mutable" }, "Unit": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-unit", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.ComputeLimits": { "MarkdownDocumentation": "`AWS::EMR::Cluster.ComputeLimits`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-computelimits.html", "Properties": { "MaximumCapacityUnits": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-computelimits.html#cfn-elasticmapreduce-cluster-computelimits-maximumcapacityunits", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "MaximumCoreCapacityUnits": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-computelimits.html#cfn-elasticmapreduce-cluster-computelimits-maximumcorecapacityunits", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "MaximumOnDemandCapacityUnits": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-computelimits.html#cfn-elasticmapreduce-cluster-computelimits-maximumondemandcapacityunits", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "MinimumCapacityUnits": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-computelimits.html#cfn-elasticmapreduce-cluster-computelimits-minimumcapacityunits", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "UnitType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-computelimits.html#cfn-elasticmapreduce-cluster-computelimits-unittype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.Configuration": { "MarkdownDocumentation": "`AWS::EMR::Cluster.Configuration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html", "Properties": { "Classification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-classification", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ConfigurationProperties": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-configurationproperties", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Configurations": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-configurations", "DuplicatesAllowed": false, "ItemType": "Configuration", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.EbsBlockDeviceConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.EbsBlockDeviceConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html", "Properties": { "VolumeSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html#cfn-elasticmapreduce-cluster-ebsblockdeviceconfig-volumespecification", "Required": true, "Type": "VolumeSpecification", "UpdateType": "Mutable" }, "VolumesPerInstance": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html#cfn-elasticmapreduce-cluster-ebsblockdeviceconfig-volumesperinstance", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.EbsConfiguration": { "MarkdownDocumentation": "`AWS::EMR::Cluster.EbsConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsconfiguration.html", "Properties": { "EbsBlockDeviceConfigs": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsconfiguration.html#cfn-elasticmapreduce-cluster-ebsconfiguration-ebsblockdeviceconfigs", "DuplicatesAllowed": false, "ItemType": "EbsBlockDeviceConfig", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "EbsOptimized": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsconfiguration.html#cfn-elasticmapreduce-cluster-ebsconfiguration-ebsoptimized", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.HadoopJarStepConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.HadoopJarStepConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html", "Properties": { "Args": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html#cfn-elasticmapreduce-cluster-hadoopjarstepconfig-args", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Jar": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html#cfn-elasticmapreduce-cluster-hadoopjarstepconfig-jar", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "MainClass": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html#cfn-elasticmapreduce-cluster-hadoopjarstepconfig-mainclass", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "StepProperties": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-hadoopjarstepconfig.html#cfn-elasticmapreduce-cluster-hadoopjarstepconfig-stepproperties", "DuplicatesAllowed": false, "ItemType": "KeyValue", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.InstanceFleetConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.InstanceFleetConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html", "Properties": { "InstanceTypeConfigs": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-instancetypeconfigs", "DuplicatesAllowed": false, "ItemType": "InstanceTypeConfig", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "LaunchSpecifications": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-launchspecifications", "Required": false, "Type": "InstanceFleetProvisioningSpecifications", "UpdateType": "Immutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ResizeSpecifications": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-resizespecifications", "Required": false, "Type": "InstanceFleetResizingSpecifications", "UpdateType": "Mutable" }, "TargetOnDemandCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-targetondemandcapacity", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "TargetSpotCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-targetspotcapacity", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.InstanceFleetProvisioningSpecifications": { "MarkdownDocumentation": "`AWS::EMR::Cluster.InstanceFleetProvisioningSpecifications`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetprovisioningspecifications.html", "Properties": { "OnDemandSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetprovisioningspecifications.html#cfn-elasticmapreduce-cluster-instancefleetprovisioningspecifications-ondemandspecification", "Required": false, "Type": "OnDemandProvisioningSpecification", "UpdateType": "Mutable" }, "SpotSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetprovisioningspecifications.html#cfn-elasticmapreduce-cluster-instancefleetprovisioningspecifications-spotspecification", "Required": false, "Type": "SpotProvisioningSpecification", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.InstanceFleetResizingSpecifications": { "MarkdownDocumentation": "`AWS::EMR::Cluster.InstanceFleetResizingSpecifications`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetresizingspecifications.html", "Properties": { "OnDemandResizeSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetresizingspecifications.html#cfn-elasticmapreduce-cluster-instancefleetresizingspecifications-ondemandresizespecification", "Required": false, "Type": "OnDemandResizingSpecification", "UpdateType": "Mutable" }, "SpotResizeSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetresizingspecifications.html#cfn-elasticmapreduce-cluster-instancefleetresizingspecifications-spotresizespecification", "Required": false, "Type": "SpotResizingSpecification", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.InstanceGroupConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.InstanceGroupConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html", "Properties": { "AutoScalingPolicy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-autoscalingpolicy", "Required": false, "Type": "AutoScalingPolicy", "UpdateType": "Mutable" }, "BidPrice": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-bidprice", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Configurations": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-configurations", "DuplicatesAllowed": false, "ItemType": "Configuration", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "CustomAmiId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-customamiid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EbsConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-ebsconfiguration", "Required": false, "Type": "EbsConfiguration", "UpdateType": "Immutable" }, "InstanceCount": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-instancecount", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "InstanceType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-instancetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Market": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-market", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" } } }, "AWS::EMR::Cluster.InstanceTypeConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.InstanceTypeConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html", "Properties": { "BidPrice": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-bidprice", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "BidPriceAsPercentageOfOnDemandPrice": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-bidpriceaspercentageofondemandprice", "PrimitiveType": "Double", "Required": false, "UpdateType": "Mutable" }, "Configurations": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-configurations", "DuplicatesAllowed": false, "ItemType": "Configuration", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "CustomAmiId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-customamiid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EbsConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-ebsconfiguration", "Required": false, "Type": "EbsConfiguration", "UpdateType": "Mutable" }, "InstanceType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-instancetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Priority": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-priority", "PrimitiveType": "Double", "Required": false, "UpdateType": "Mutable" }, "WeightedCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-weightedcapacity", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.JobFlowInstancesConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.JobFlowInstancesConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html", "Properties": { "AdditionalMasterSecurityGroups": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-additionalmastersecuritygroups", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "AdditionalSlaveSecurityGroups": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-additionalslavesecuritygroups", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "CoreInstanceFleet": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-coreinstancefleet", "Required": false, "Type": "InstanceFleetConfig", "UpdateType": "Immutable" }, "CoreInstanceGroup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-coreinstancegroup", "Required": false, "Type": "InstanceGroupConfig", "UpdateType": "Immutable" }, "Ec2KeyName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2keyname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Ec2SubnetId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2subnetid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Ec2SubnetIds": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2subnetids", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "EmrManagedMasterSecurityGroup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-emrmanagedmastersecuritygroup", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EmrManagedSlaveSecurityGroup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-emrmanagedslavesecuritygroup", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "HadoopVersion": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-hadoopversion", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "KeepJobFlowAliveWhenNoSteps": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-keepjobflowalivewhennosteps", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" }, "MasterInstanceFleet": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-masterinstancefleet", "Required": false, "Type": "InstanceFleetConfig", "UpdateType": "Immutable" }, "MasterInstanceGroup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-masterinstancegroup", "Required": false, "Type": "InstanceGroupConfig", "UpdateType": "Immutable" }, "Placement": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-placement", "Required": false, "Type": "PlacementType", "UpdateType": "Immutable" }, "ServiceAccessSecurityGroup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-serviceaccesssecuritygroup", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "TaskInstanceFleets": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-taskinstancefleets", "DuplicatesAllowed": false, "ItemType": "InstanceFleetConfig", "Required": false, "Type": "List", "UpdateType": "Conditional" }, "TaskInstanceGroups": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-taskinstancegroups", "DuplicatesAllowed": false, "ItemType": "InstanceGroupConfig", "Required": false, "Type": "List", "UpdateType": "Conditional" }, "TerminationProtected": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-terminationprotected", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "UnhealthyNodeReplacement": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-unhealthynodereplacement", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.KerberosAttributes": { "MarkdownDocumentation": "`AWS::EMR::Cluster.KerberosAttributes`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html", "Properties": { "ADDomainJoinPassword": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-addomainjoinpassword", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ADDomainJoinUser": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-addomainjoinuser", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CrossRealmTrustPrincipalPassword": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-crossrealmtrustprincipalpassword", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "KdcAdminPassword": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-kdcadminpassword", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Realm": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-kerberosattributes.html#cfn-elasticmapreduce-cluster-kerberosattributes-realm", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.KeyValue": { "MarkdownDocumentation": "`AWS::EMR::Cluster.KeyValue`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-keyvalue.html", "Properties": { "Key": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-keyvalue.html#cfn-elasticmapreduce-cluster-keyvalue-key", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Value": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-keyvalue.html#cfn-elasticmapreduce-cluster-keyvalue-value", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.ManagedScalingPolicy": { "MarkdownDocumentation": "`AWS::EMR::Cluster.ManagedScalingPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-managedscalingpolicy.html", "Properties": { "ComputeLimits": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-managedscalingpolicy.html#cfn-elasticmapreduce-cluster-managedscalingpolicy-computelimits", "Required": false, "Type": "ComputeLimits", "UpdateType": "Mutable" }, "ScalingStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-managedscalingpolicy.html#cfn-elasticmapreduce-cluster-managedscalingpolicy-scalingstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "UtilizationPerformanceIndex": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-managedscalingpolicy.html#cfn-elasticmapreduce-cluster-managedscalingpolicy-utilizationperformanceindex", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.MetricDimension": { "MarkdownDocumentation": "`AWS::EMR::Cluster.MetricDimension`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-metricdimension.html", "Properties": { "Key": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-metricdimension.html#cfn-elasticmapreduce-cluster-metricdimension-key", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Value": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-metricdimension.html#cfn-elasticmapreduce-cluster-metricdimension-value", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.OnDemandCapacityReservationOptions": { "MarkdownDocumentation": "`AWS::EMR::Cluster.OnDemandCapacityReservationOptions`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandcapacityreservationoptions.html", "Properties": { "CapacityReservationPreference": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandcapacityreservationoptions.html#cfn-elasticmapreduce-cluster-ondemandcapacityreservationoptions-capacityreservationpreference", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CapacityReservationResourceGroupArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandcapacityreservationoptions.html#cfn-elasticmapreduce-cluster-ondemandcapacityreservationoptions-capacityreservationresourcegrouparn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "UsageStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandcapacityreservationoptions.html#cfn-elasticmapreduce-cluster-ondemandcapacityreservationoptions-usagestrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.OnDemandProvisioningSpecification": { "MarkdownDocumentation": "`AWS::EMR::Cluster.OnDemandProvisioningSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandprovisioningspecification.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandprovisioningspecification.html#cfn-elasticmapreduce-cluster-ondemandprovisioningspecification-allocationstrategy", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "CapacityReservationOptions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandprovisioningspecification.html#cfn-elasticmapreduce-cluster-ondemandprovisioningspecification-capacityreservationoptions", "Required": false, "Type": "OnDemandCapacityReservationOptions", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.OnDemandResizingSpecification": { "MarkdownDocumentation": "`AWS::EMR::Cluster.OnDemandResizingSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandresizingspecification.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandresizingspecification.html#cfn-elasticmapreduce-cluster-ondemandresizingspecification-allocationstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CapacityReservationOptions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandresizingspecification.html#cfn-elasticmapreduce-cluster-ondemandresizingspecification-capacityreservationoptions", "Required": false, "Type": "OnDemandCapacityReservationOptions", "UpdateType": "Mutable" }, "TimeoutDurationMinutes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandresizingspecification.html#cfn-elasticmapreduce-cluster-ondemandresizingspecification-timeoutdurationminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.PlacementGroupConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.PlacementGroupConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementgroupconfig.html", "Properties": { "InstanceRole": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementgroupconfig.html#cfn-elasticmapreduce-cluster-placementgroupconfig-instancerole", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "PlacementStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementgroupconfig.html#cfn-elasticmapreduce-cluster-placementgroupconfig-placementstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.PlacementType": { "MarkdownDocumentation": "`AWS::EMR::Cluster.PlacementType`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementtype.html", "Properties": { "AvailabilityZone": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementtype.html#cfn-elasticmapreduce-cluster-placementtype-availabilityzone", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::EMR::Cluster.ScalingAction": { "MarkdownDocumentation": "`AWS::EMR::Cluster.ScalingAction`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingaction.html", "Properties": { "Market": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingaction.html#cfn-elasticmapreduce-cluster-scalingaction-market", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SimpleScalingPolicyConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingaction.html#cfn-elasticmapreduce-cluster-scalingaction-simplescalingpolicyconfiguration", "Required": true, "Type": "SimpleScalingPolicyConfiguration", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.ScalingConstraints": { "MarkdownDocumentation": "`AWS::EMR::Cluster.ScalingConstraints`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html", "Properties": { "MaxCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html#cfn-elasticmapreduce-cluster-scalingconstraints-maxcapacity", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "MinCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html#cfn-elasticmapreduce-cluster-scalingconstraints-mincapacity", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.ScalingRule": { "MarkdownDocumentation": "`AWS::EMR::Cluster.ScalingRule`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html", "Properties": { "Action": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-action", "Required": true, "Type": "ScalingAction", "UpdateType": "Mutable" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Trigger": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-trigger", "Required": true, "Type": "ScalingTrigger", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.ScalingTrigger": { "MarkdownDocumentation": "`AWS::EMR::Cluster.ScalingTrigger`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingtrigger.html", "Properties": { "CloudWatchAlarmDefinition": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingtrigger.html#cfn-elasticmapreduce-cluster-scalingtrigger-cloudwatchalarmdefinition", "Required": true, "Type": "CloudWatchAlarmDefinition", "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.ScriptBootstrapActionConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.ScriptBootstrapActionConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html", "Properties": { "Args": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html#cfn-elasticmapreduce-cluster-scriptbootstrapactionconfig-args", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Path": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html#cfn-elasticmapreduce-cluster-scriptbootstrapactionconfig-path", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.SimpleScalingPolicyConfiguration": { "MarkdownDocumentation": "`AWS::EMR::Cluster.SimpleScalingPolicyConfiguration`\n\n`SimpleScalingPolicyConfiguration` is a subproperty of the `ScalingAction` property type. `SimpleScalingPolicyConfiguration` determines how an automatic scaling action adds or removes instances, the cooldown period, and the number of EC2 instances that are added each time the CloudWatch metric alarm condition is satisfied.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html", "Properties": { "AdjustmentType": { "MarkdownDocumentation": "`AdjustmentType`\n\nThe way in which Amazon EC2 instances are added (if\n`ScalingAdjustment` is a positive number) or terminated (if\n`ScalingAdjustment` is a negative number) each time the scaling activity is\ntriggered. `CHANGE_IN_CAPACITY` is the default. `CHANGE_IN_CAPACITY`\nindicates that the Amazon EC2 instance count increments or decrements by\n`ScalingAdjustment`, which should be expressed as an integer.\n`PERCENT_CHANGE_IN_CAPACITY` indicates the instance count increments or\ndecrements by the percentage specified by `ScalingAdjustment`, which should be\nexpressed as an integer. For example, 20 indicates an increase in 20% increments of cluster\ncapacity. `EXACT_CAPACITY` indicates the scaling activity results in an instance\ngroup with the number of Amazon EC2 instances specified by\n`ScalingAdjustment`, which should be expressed as a positive integer.\n*Required*: No\n*Type*: String\n*Allowed values*: `CHANGE_IN_CAPACITY | PERCEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CHANGE_IN_CAPACITY", "PERCENT_CHANGE_IN_CAPACITY", "EXACT_CAPACITY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-adjustmenttype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CoolDown": { "MarkdownDocumentation": "`CoolDown`\n\nThe amount of time, in seconds, after a scaling activity completes before any further\ntrigger-related scaling activities can start. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-cooldown", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "ScalingAdjustment": { "MarkdownDocumentation": "`ScalingAdjustment`\n\nThe amount by which to scale in or scale out, based on the specified\n`AdjustmentType`. A positive value adds to the instance group's Amazon EC2 instance count while a negative number removes instances. If\n`AdjustmentType` is set to `EXACT_CAPACITY`, the number should\nonly be a positive integer. If `AdjustmentType` is set to\n`PERCENT_CHANGE_IN_CAPACITY`, the value should express the percentage as an\ninteger. For example, -20 indicates a decrease in 20% increments of cluster\ncapacity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-scalingadjustment", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.SpotProvisioningSpecification": { "MarkdownDocumentation": "`AWS::EMR::Cluster.SpotProvisioningSpecification`\n\n`SpotProvisioningSpecification` is a subproperty of the `InstanceFleetProvisioningSpecifications` property type. `SpotProvisioningSpecification` determines the launch specification for Spot instances in the instance fleet, which includes the defined duration and provisioning timeout behavior.\n###### Note\nThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "`AllocationStrategy`\n\nSpecifies one of the following strategies to launch Spot Instance fleets:\n`capacity-optimized`, `price-capacity-optimized`, `lowest-price`, or\n`diversified`, and `capacity-optimized-prioritized`. For more information on the provisioning strategies, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide for Linux Instances*.\n###### Note\nWhen you launch a Spot Instance fleet with the old console, it automatically launches with the `capacity-optimized` strategy. You can't change the allocation strategy from the old console.\n*Required*: No\n*Type*: String\n*Allowed values*: `capacity-optimized | price-...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "capacity-optimized", "price-capacity-optimized", "lowest-price", "diversified", "capacity-optimized-prioritized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-allocationstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "BlockDurationMinutes": { "MarkdownDocumentation": "`BlockDurationMinutes`\n\nThe defined duration for Spot Instances (also known as Spot blocks) in minutes. When\nspecified, the Spot Instance does not terminate before the defined duration expires, and\ndefined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240,\n300, or 360. The duration period starts as soon as a Spot Instance receives its instance\nID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination\nand provides a Spot Instance termination notice, which gives the instance a two-minute\nwarning before it terminates.\n###### Note\nSpot Instances with a defined duration (also known as Spot blocks) are no longer\navailable to new customers from July 1, 2021. For customers who have previously used the\nfeature, we will continue to support Spot Instances with a defined duration until\nDecember 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-blockdurationminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "TimeoutAction": { "MarkdownDocumentation": "`TimeoutAction`\n\nThe action to take when `TargetSpotCapacity` has not been fulfilled when the\n`TimeoutDurationMinutes` has expired; that is, when all Spot Instances could\nnot be provisioned within the Spot provisioning timeout. Valid values are\n`TERMINATE_CLUSTER` and `SWITCH_TO_ON_DEMAND`. SWITCH\\_TO\\_ON\\_DEMAND\nspecifies that if no Spot Instances are available, On-Demand Instances should be\nprovisioned to fulfill any remaining Spot capacity.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SWITCH_TO_ON_DEMAND | TERMI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SWITCH_TO_ON_DEMAND", "TERMINATE_CLUSTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-timeoutaction", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "TimeoutDurationMinutes": { "MarkdownDocumentation": "`TimeoutDurationMinutes`\n\nThe Spot provisioning timeout period in minutes. If Spot Instances are not provisioned\nwithin this time period, the `TimeOutAction` is taken. Minimum value is 5 and\nmaximum value is 1440. The timeout applies only during initial provisioning, when the\ncluster 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-timeoutdurationminutes", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.SpotResizingSpecification": { "MarkdownDocumentation": "`AWS::EMR::Cluster.SpotResizingSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotresizingspecification.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotresizingspecification.html#cfn-elasticmapreduce-cluster-spotresizingspecification-allocationstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "TimeoutDurationMinutes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotresizingspecification.html#cfn-elasticmapreduce-cluster-spotresizingspecification-timeoutdurationminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.StepConfig": { "MarkdownDocumentation": "`AWS::EMR::Cluster.StepConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html", "Properties": { "ActionOnFailure": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html#cfn-elasticmapreduce-cluster-stepconfig-actiononfailure", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "HadoopJarStep": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html#cfn-elasticmapreduce-cluster-stepconfig-hadoopjarstep", "Required": true, "Type": "HadoopJarStepConfig", "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-stepconfig.html#cfn-elasticmapreduce-cluster-stepconfig-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Cluster.VolumeSpecification": { "MarkdownDocumentation": "`AWS::EMR::Cluster.VolumeSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html", "Properties": { "Iops": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-iops", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "SizeInGB": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-sizeingb", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "Throughput": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-throughput", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "VolumeType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-volumetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.Configuration": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.Configuration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html", "Properties": { "Classification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-classification", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ConfigurationProperties": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-configurationproperties", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Immutable" }, "Configurations": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-configurations", "DuplicatesAllowed": false, "ItemType": "Configuration", "Required": false, "Type": "List", "UpdateType": "Immutable" } } }, "AWS::EMR::InstanceFleetConfig.EbsBlockDeviceConfig": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.EbsBlockDeviceConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html", "Properties": { "VolumeSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html#cfn-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig-volumespecification", "Required": true, "Type": "VolumeSpecification", "UpdateType": "Immutable" }, "VolumesPerInstance": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html#cfn-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig-volumesperinstance", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" } } }, "AWS::EMR::InstanceFleetConfig.EbsConfiguration": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.EbsConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsconfiguration.html", "Properties": { "EbsBlockDeviceConfigs": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsconfiguration.html#cfn-elasticmapreduce-instancefleetconfig-ebsconfiguration-ebsblockdeviceconfigs", "DuplicatesAllowed": false, "ItemType": "EbsBlockDeviceConfig", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "EbsOptimized": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsconfiguration.html#cfn-elasticmapreduce-instancefleetconfig-ebsconfiguration-ebsoptimized", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" } } }, "AWS::EMR::InstanceFleetConfig.InstanceFleetProvisioningSpecifications": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.InstanceFleetProvisioningSpecifications`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications.html", "Properties": { "OnDemandSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications.html#cfn-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications-ondemandspecification", "Required": false, "Type": "OnDemandProvisioningSpecification", "UpdateType": "Mutable" }, "SpotSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications.html#cfn-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications-spotspecification", "Required": false, "Type": "SpotProvisioningSpecification", "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.InstanceFleetResizingSpecifications": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.InstanceFleetResizingSpecifications`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetresizingspecifications.html", "Properties": { "OnDemandResizeSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetresizingspecifications.html#cfn-elasticmapreduce-instancefleetconfig-instancefleetresizingspecifications-ondemandresizespecification", "Required": false, "Type": "OnDemandResizingSpecification", "UpdateType": "Mutable" }, "SpotResizeSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetresizingspecifications.html#cfn-elasticmapreduce-instancefleetconfig-instancefleetresizingspecifications-spotresizespecification", "Required": false, "Type": "SpotResizingSpecification", "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.InstanceTypeConfig": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.InstanceTypeConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html", "Properties": { "BidPrice": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-bidprice", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "BidPriceAsPercentageOfOnDemandPrice": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-bidpriceaspercentageofondemandprice", "PrimitiveType": "Double", "Required": false, "UpdateType": "Mutable" }, "Configurations": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-configurations", "DuplicatesAllowed": false, "ItemType": "Configuration", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "CustomAmiId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-customamiid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EbsConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-ebsconfiguration", "Required": false, "Type": "EbsConfiguration", "UpdateType": "Mutable" }, "InstanceType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-instancetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Priority": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-priority", "PrimitiveType": "Double", "Required": false, "UpdateType": "Mutable" }, "WeightedCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-weightedcapacity", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.OnDemandCapacityReservationOptions": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.OnDemandCapacityReservationOptions`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandcapacityreservationoptions.html", "Properties": { "CapacityReservationPreference": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandcapacityreservationoptions.html#cfn-elasticmapreduce-instancefleetconfig-ondemandcapacityreservationoptions-capacityreservationpreference", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CapacityReservationResourceGroupArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandcapacityreservationoptions.html#cfn-elasticmapreduce-instancefleetconfig-ondemandcapacityreservationoptions-capacityreservationresourcegrouparn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "UsageStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandcapacityreservationoptions.html#cfn-elasticmapreduce-instancefleetconfig-ondemandcapacityreservationoptions-usagestrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.OnDemandProvisioningSpecification": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.OnDemandProvisioningSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandprovisioningspecification.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-ondemandprovisioningspecification-allocationstrategy", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "CapacityReservationOptions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-ondemandprovisioningspecification-capacityreservationoptions", "Required": false, "Type": "OnDemandCapacityReservationOptions", "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.OnDemandResizingSpecification": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.OnDemandResizingSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandresizingspecification.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandresizingspecification.html#cfn-elasticmapreduce-instancefleetconfig-ondemandresizingspecification-allocationstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CapacityReservationOptions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandresizingspecification.html#cfn-elasticmapreduce-instancefleetconfig-ondemandresizingspecification-capacityreservationoptions", "Required": false, "Type": "OnDemandCapacityReservationOptions", "UpdateType": "Mutable" }, "TimeoutDurationMinutes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandresizingspecification.html#cfn-elasticmapreduce-instancefleetconfig-ondemandresizingspecification-timeoutdurationminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification`\n\n`SpotProvisioningSpecification` is a subproperty of the `InstanceFleetProvisioningSpecifications` property type. `SpotProvisioningSpecification` determines the launch specification for Spot instances in the instance fleet, which includes the defined duration and provisioning timeout behavior.\n###### Note\nThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "`AllocationStrategy`\n\nSpecifies one of the following strategies to launch Spot Instance fleets:\n`capacity-optimized`, `price-capacity-optimized`, `lowest-price`, or\n`diversified`, and `capacity-optimized-prioritized`. For more information on the provisioning strategies, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide for Linux Instances*.\n###### Note\nWhen you launch a Spot Instance fleet with the old console, it automatically launches with the `capacity-optimized` strategy. You can't change the allocation strategy from the old console.\n*Required*: No\n*Type*: String\n*Allowed values*: `capacity-optimized | price-...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "capacity-optimized", "price-capacity-optimized", "lowest-price", "diversified", "capacity-optimized-prioritized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-allocationstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "BlockDurationMinutes": { "MarkdownDocumentation": "`BlockDurationMinutes`\n\nThe defined duration for Spot Instances (also known as Spot blocks) in minutes. When\nspecified, the Spot Instance does not terminate before the defined duration expires, and\ndefined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240,\n300, or 360. The duration period starts as soon as a Spot Instance receives its instance\nID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination\nand provides a Spot Instance termination notice, which gives the instance a two-minute\nwarning before it terminates.\n###### Note\nSpot Instances with a defined duration (also known as Spot blocks) are no longer\navailable to new customers from July 1, 2021. For customers who have previously used the\nfeature, we will continue to support Spot Instances with a defined duration until\nDecember 31, 2022.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-blockdurationminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "TimeoutAction": { "MarkdownDocumentation": "`TimeoutAction`\n\nThe action to take when `TargetSpotCapacity` has not been fulfilled when the\n`TimeoutDurationMinutes` has expired; that is, when all Spot Instances could\nnot be provisioned within the Spot provisioning timeout. Valid values are\n`TERMINATE_CLUSTER` and `SWITCH_TO_ON_DEMAND`. SWITCH\\_TO\\_ON\\_DEMAND\nspecifies that if no Spot Instances are available, On-Demand Instances should be\nprovisioned to fulfill any remaining Spot capacity.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SWITCH_TO_ON_DEMAND | TERMI...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SWITCH_TO_ON_DEMAND", "TERMINATE_CLUSTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-timeoutaction", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "TimeoutDurationMinutes": { "MarkdownDocumentation": "`TimeoutDurationMinutes`\n\nThe Spot provisioning timeout period in minutes. If Spot Instances are not provisioned\nwithin this time period, the `TimeOutAction` is taken. Minimum value is 5 and\nmaximum value is 1440. The timeout applies only during initial provisioning, when the\ncluster is first created.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-timeoutdurationminutes", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.SpotResizingSpecification": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.SpotResizingSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotresizingspecification.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotresizingspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotresizingspecification-allocationstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "TimeoutDurationMinutes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotresizingspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotresizingspecification-timeoutdurationminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig.VolumeSpecification": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig.VolumeSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html", "Properties": { "Iops": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-iops", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "SizeInGB": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-sizeingb", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Immutable" }, "Throughput": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-throughput", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "VolumeType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-volumetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::EMR::InstanceGroupConfig.AutoScalingPolicy": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.AutoScalingPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html", "Properties": { "Constraints": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy-constraints", "Required": true, "Type": "ScalingConstraints", "UpdateType": "Mutable" }, "Rules": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy-rules", "DuplicatesAllowed": false, "ItemType": "ScalingRule", "Required": true, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.CloudWatchAlarmDefinition": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.CloudWatchAlarmDefinition`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-comparisonoperator", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Dimensions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-dimensions", "DuplicatesAllowed": false, "ItemType": "MetricDimension", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "EvaluationPeriods": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-evaluationperiods", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "MetricName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-metricname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Namespace": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-namespace", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Period": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-period", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "Statistic": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-statistic", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Threshold": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-threshold", "PrimitiveType": "Double", "Required": true, "UpdateType": "Mutable" }, "Unit": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-unit", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.Configuration": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.Configuration`\n\n###### Note\nUsed only with Amazon EMR release 4.0 and later.\n`Configuration` is a subproperty of `InstanceFleetConfig` or `InstanceGroupConfig`. `Configuration` specifies optional configurations for customizing open-source big data applications and environment parameters. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see [Configuring Applications](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html) in the *Amazon EMR Release Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html", "Properties": { "Classification": { "MarkdownDocumentation": "`Classification`\n\nThe classification within a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-classification", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ConfigurationProperties": { "MarkdownDocumentation": "`ConfigurationProperties`\n\nA list of additional configurations to apply within a configuration object.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-configurationproperties", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Immutable" }, "Configurations": { "MarkdownDocumentation": "`Configurations`\n\nA list of additional configurations to apply within a configuration object.\n*Required*: No\n*Type*: Array of [Configuration](./aws-properties-emr-cluster-configuration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-configurations", "DuplicatesAllowed": false, "ItemType": "Configuration", "Required": false, "Type": "List", "UpdateType": "Immutable" } } }, "AWS::EMR::InstanceGroupConfig.EbsBlockDeviceConfig": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.EbsBlockDeviceConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html", "Properties": { "VolumeSpecification": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification", "Required": true, "Type": "VolumeSpecification", "UpdateType": "Mutable" }, "VolumesPerInstance": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumesperinstance", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.EbsConfiguration": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.EbsConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration.html", "Properties": { "EbsBlockDeviceConfigs": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfigs", "DuplicatesAllowed": false, "ItemType": "EbsBlockDeviceConfig", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "EbsOptimized": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration.html#cfn-emr-ebsconfiguration-ebsoptimized", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.MetricDimension": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.MetricDimension`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-metricdimension.html", "Properties": { "Key": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-metricdimension.html#cfn-elasticmapreduce-instancegroupconfig-metricdimension-key", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Value": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-metricdimension.html#cfn-elasticmapreduce-instancegroupconfig-metricdimension-value", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.ScalingAction": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.ScalingAction`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingaction.html", "Properties": { "Market": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingaction.html#cfn-elasticmapreduce-instancegroupconfig-scalingaction-market", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SimpleScalingPolicyConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingaction.html#cfn-elasticmapreduce-instancegroupconfig-scalingaction-simplescalingpolicyconfiguration", "Required": true, "Type": "SimpleScalingPolicyConfiguration", "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.ScalingConstraints": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.ScalingConstraints`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingconstraints.html", "Properties": { "MaxCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingconstraints.html#cfn-elasticmapreduce-instancegroupconfig-scalingconstraints-maxcapacity", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "MinCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingconstraints.html#cfn-elasticmapreduce-instancegroupconfig-scalingconstraints-mincapacity", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.ScalingRule": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.ScalingRule`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html", "Properties": { "Action": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-action", "Required": true, "Type": "ScalingAction", "UpdateType": "Mutable" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Trigger": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-trigger", "Required": true, "Type": "ScalingTrigger", "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.ScalingTrigger": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.ScalingTrigger`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingtrigger.html", "Properties": { "CloudWatchAlarmDefinition": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingtrigger.html#cfn-elasticmapreduce-instancegroupconfig-scalingtrigger-cloudwatchalarmdefinition", "Required": true, "Type": "CloudWatchAlarmDefinition", "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.SimpleScalingPolicyConfiguration": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.SimpleScalingPolicyConfiguration`\n\n`SimpleScalingPolicyConfiguration` is a subproperty of the `ScalingAction` property type. `SimpleScalingPolicyConfiguration` determines how an automatic scaling action adds or removes instances, the cooldown period, and the number of EC2 instances that are added each time the CloudWatch metric alarm condition is satisfied.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html", "Properties": { "AdjustmentType": { "MarkdownDocumentation": "`AdjustmentType`\n\nThe way in which Amazon EC2 instances are added (if\n`ScalingAdjustment` is a positive number) or terminated (if\n`ScalingAdjustment` is a negative number) each time the scaling activity is\ntriggered. `CHANGE_IN_CAPACITY` is the default. `CHANGE_IN_CAPACITY`\nindicates that the Amazon EC2 instance count increments or decrements by\n`ScalingAdjustment`, which should be expressed as an integer.\n`PERCENT_CHANGE_IN_CAPACITY` indicates the instance count increments or\ndecrements by the percentage specified by `ScalingAdjustment`, which should be\nexpressed as an integer. For example, 20 indicates an increase in 20% increments of cluster\ncapacity. `EXACT_CAPACITY` indicates the scaling activity results in an instance\ngroup with the number of Amazon EC2 instances specified by\n`ScalingAdjustment`, which should be expressed as a positive integer.\n*Required*: No\n*Type*: String\n*Allowed values*: `CHANGE_IN_CAPACITY | PERCEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CHANGE_IN_CAPACITY", "PERCENT_CHANGE_IN_CAPACITY", "EXACT_CAPACITY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-adjustmenttype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CoolDown": { "MarkdownDocumentation": "`CoolDown`\n\nThe amount of time, in seconds, after a scaling activity completes before any further\ntrigger-related scaling activities can start. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-cooldown", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "ScalingAdjustment": { "MarkdownDocumentation": "`ScalingAdjustment`\n\nThe amount by which to scale in or scale out, based on the specified\n`AdjustmentType`. A positive value adds to the instance group's Amazon EC2 instance count while a negative number removes instances. If\n`AdjustmentType` is set to `EXACT_CAPACITY`, the number should\nonly be a positive integer. If `AdjustmentType` is set to\n`PERCENT_CHANGE_IN_CAPACITY`, the value should express the percentage as an\ninteger. For example, -20 indicates a decrease in 20% increments of cluster\ncapacity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-scalingadjustment", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig.VolumeSpecification": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig.VolumeSpecification`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html", "Properties": { "Iops": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-iops", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "SizeInGB": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-sizeingb", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "Throughput": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-throughput", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "VolumeType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-volumetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::EMR::Step.HadoopJarStepConfig": { "MarkdownDocumentation": "`AWS::EMR::Step.HadoopJarStepConfig`\n\nA job flow step consisting of a JAR file whose main function will be executed. The main\nfunction submits a job for Hadoop to execute and waits for the job to finish or\nfail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-step-hadoopjarstepconfig.html", "Properties": { "Args": { "MarkdownDocumentation": "`Args`\n\nA list of command line arguments passed to the JAR file's main function when\nexecuted.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-step-hadoopjarstepconfig.html#cfn-emr-step-hadoopjarstepconfig-args", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MainClass": { "MarkdownDocumentation": "`MainClass`\n\nThe name of the main class in the specified Java file. If not specified, the JAR file\nshould specify a Main-Class in its manifest file.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-step-hadoopjarstepconfig.html#cfn-emr-step-hadoopjarstepconfig-mainclass", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StepProperties": { "MarkdownDocumentation": "`StepProperties`\n\nA list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.\n*Required*: No\n*Type*: Array of [KeyValue](./aws-properties-emr-step-keyvalue.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-step-hadoopjarstepconfig.html#cfn-emr-step-hadoopjarstepconfig-stepproperties", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "KeyValue", "DuplicatesAllowed": false }, "Jar": { "MarkdownDocumentation": "`Jar`\n\nA path to a JAR file run during the step.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-step-hadoopjarstepconfig.html#cfn-emr-step-hadoopjarstepconfig-jar", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EMR::Step.KeyValue": { "MarkdownDocumentation": "`AWS::EMR::Step.KeyValue`\n\n`KeyValue` is a subproperty of the `HadoopJarStepConfig` property type. `KeyValue` is used to pass parameters to a step.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-step-keyvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value part of the identified key.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-step-keyvalue.html#cfn-emr-step-keyvalue-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe unique identifier of a key-value pair.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-step-keyvalue.html#cfn-emr-step-keyvalue-key", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EMRContainers::VirtualCluster.ContainerInfo": { "MarkdownDocumentation": "`AWS::EMRContainers::VirtualCluster.ContainerInfo`\n\nThe information about the container used for a job run or a managed endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerinfo.html", "Properties": { "EksInfo": { "MarkdownDocumentation": "`EksInfo`\n\nThe information about the Amazon EKS cluster.\n*Required*: Yes\n*Type*: [EksInfo](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerinfo.html#cfn-emrcontainers-virtualcluster-containerinfo-eksinfo", "UpdateType": "Immutable", "Required": true, "Type": "EksInfo" } } }, "AWS::EMRContainers::VirtualCluster.ContainerProvider": { "MarkdownDocumentation": "`AWS::EMRContainers::VirtualCluster.ContainerProvider`\n\nThe information about the container provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerprovider.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the container provider. Amazon EKS is the only supported type as of\nnow.\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)\n", "RefReturnValue": "", "AllowedValues": [ "EKS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerprovider.html#cfn-emrcontainers-virtualcluster-containerprovider-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe 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*Pattern*: `^[0-9A-Za-z][A-Za-z0-9\\-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerprovider.html#cfn-emrcontainers-virtualcluster-containerprovider-id", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Info": { "MarkdownDocumentation": "`Info`\n\nThe information about the container cluster.\n*Required*: Yes\n*Type*: [ContainerInfo](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerprovider.html#cfn-emrcontainers-virtualcluster-containerprovider-info", "UpdateType": "Immutable", "Required": true, "Type": "ContainerInfo" } } }, "AWS::EMRContainers::VirtualCluster.EksInfo": { "MarkdownDocumentation": "`AWS::EMRContainers::VirtualCluster.EksInfo`\n\nThe information about the Amazon EKS cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html", "Properties": { "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe 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*Pattern*: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html#cfn-emrcontainers-virtualcluster-eksinfo-namespace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.AutoStartConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.AutoStartConfiguration`\n\nThe configuration for an application to automatically start on job submission.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostartconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables the application to automatically start on job submission.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostartconfiguration.html#cfn-emrserverless-application-autostartconfiguration-enabled", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EMRServerless::Application.AutoStopConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.AutoStopConfiguration`\n\nThe configuration for an application to automatically stop after a certain amount of\ntime being idle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables the application to automatically stop after a certain amount of time being idle.\nDefaults to true.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html#cfn-emrserverless-application-autostopconfiguration-enabled", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "IdleTimeoutMinutes": { "MarkdownDocumentation": "`IdleTimeoutMinutes`\n\nThe amount of idle time in minutes after which your application will automatically stop.\nDefaults to 15 minutes.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `10080`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html#cfn-emrserverless-application-autostopconfiguration-idletimeoutminutes", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EMRServerless::Application.CloudWatchLoggingConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.CloudWatchLoggingConfiguration`\n\nThe Amazon CloudWatch configuration for monitoring logs. You can configure your jobs\nto send log information to CloudWatch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html", "Properties": { "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nThe AWS Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$`\n*Minimum*: `20`\n*Maximum*: `2048`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-encryptionkeyarn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables CloudWatch logging.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-enabled", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "LogStreamNamePrefix": { "MarkdownDocumentation": "`LogStreamNamePrefix`\n\nPrefix for the CloudWatch log stream name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^:*]*$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-logstreamnameprefix", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe name of the log group in Amazon CloudWatch Logs where you want to publish your\nlogs.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\.\\-_/#A-Za-z0-9]+$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-loggroupname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "LogTypeMap": { "MarkdownDocumentation": "`LogTypeMap`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [LogTypeMapKeyValuePair](./aws-properties-emrserverless-application-logtypemapkeyvaluepair.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html#cfn-emrserverless-application-cloudwatchloggingconfiguration-logtypemap", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "LogTypeMapKeyValuePair", "DuplicatesAllowed": false } } }, "AWS::EMRServerless::Application.ConfigurationObject": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.ConfigurationObject`\n\nA configuration specification to be used when provisioning an application. A\nconfiguration consists of a classification, properties, and optional nested configurations.\nA classification refers to an application-specific configuration file. Properties are the\nsettings you want to change in that file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-configurationobject.html", "Properties": { "Classification": { "MarkdownDocumentation": "`Classification`\n\nThe classification within a configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-configurationobject.html#cfn-emrserverless-application-configurationobject-classification", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "Properties": { "MarkdownDocumentation": "`Properties`\n\nA set of properties specified within a configuration classification.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z]+[-a-zA-Z0-9_.]*$`\n*Minimum*: `1`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-configurationobject.html#cfn-emrserverless-application-configurationobject-properties", "UpdateType": "Conditional", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Configurations": { "MarkdownDocumentation": "`Configurations`\n\nA list of additional configurations to apply within a configuration object.\n*Required*: No\n*Type*: Array of [ConfigurationObject](./aws-properties-emrserverless-application-configurationobject.html)\n*Minimum*: `0`\n*Maximum*: `100`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-configurationobject.html#cfn-emrserverless-application-configurationobject-configurations", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "ConfigurationObject", "DuplicatesAllowed": false } } }, "AWS::EMRServerless::Application.IdentityCenterConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.IdentityCenterConfiguration`\n\nThe IAM Identity Center Configuration accepts the Identity Center instance parameter required to enable trusted identity\npropagation. This configuration allows identity propagation between integrated services and the Identity Center instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-identitycenterconfiguration.html", "Properties": { "IdentityCenterInstanceArn": { "MarkdownDocumentation": "`IdentityCenterInstanceArn`\n\nThe ARN of the IAM Identity Center instance.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-identitycenterconfiguration.html#cfn-emrserverless-application-identitycenterconfiguration-identitycenterinstancearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.ImageConfigurationInput": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.ImageConfigurationInput`\n\nThe image configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html", "Properties": { "ImageUri": { "MarkdownDocumentation": "`ImageUri`\n\nThe URI of an image in the Amazon ECR registry. This field is required when you create a\nnew application. If you leave this field blank in an update, Amazon EMR will remove the\nimage configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-z0-9]+[a-z0-9-.]*)\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))$`\n*Minimum*: `1`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html#cfn-emrserverless-application-imageconfigurationinput-imageuri", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.InitialCapacityConfig": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.InitialCapacityConfig`\n\nThe initial capacity configuration per worker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html", "Properties": { "WorkerConfiguration": { "MarkdownDocumentation": "`WorkerConfiguration`\n\nThe resource configuration of the initial capacity configuration.\n*Required*: Yes\n*Type*: [WorkerConfiguration](./aws-properties-emrserverless-application-workerconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html#cfn-emrserverless-application-initialcapacityconfig-workerconfiguration", "UpdateType": "Conditional", "Required": true, "Type": "WorkerConfiguration" }, "WorkerCount": { "MarkdownDocumentation": "`WorkerCount`\n\nThe number of workers in the initial capacity configuration.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `1000000`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html#cfn-emrserverless-application-initialcapacityconfig-workercount", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "Long" } } }, "AWS::EMRServerless::Application.InitialCapacityConfigKeyValuePair": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.InitialCapacityConfigKeyValuePair`\n\nThe `InitialCapacityConfigKeyValuePair` property type specifies Property description not available. for an [AWS::EMRServerless::Application](./aws-resource-emrserverless-application.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [InitialCapacityConfig](./aws-properties-emrserverless-application-initialcapacityconfig.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html#cfn-emrserverless-application-initialcapacityconfigkeyvaluepair-value", "UpdateType": "Conditional", "Required": true, "Type": "InitialCapacityConfig" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]+[-_]*[a-zA-Z]+$`\n*Minimum*: `1`\n*Maximum*: `50`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html#cfn-emrserverless-application-initialcapacityconfigkeyvaluepair-key", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.InteractiveConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.InteractiveConfiguration`\n\nThe configuration to use to enable the different types of interactive use cases in an application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-interactiveconfiguration.html", "Properties": { "StudioEnabled": { "MarkdownDocumentation": "`StudioEnabled`\n\nEnables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-interactiveconfiguration.html#cfn-emrserverless-application-interactiveconfiguration-studioenabled", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "LivyEndpointEnabled": { "MarkdownDocumentation": "`LivyEndpointEnabled`\n\nEnables an Apache Livy endpoint that you can connect to and run interactive jobs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-interactiveconfiguration.html#cfn-emrserverless-application-interactiveconfiguration-livyendpointenabled", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EMRServerless::Application.LogTypeMapKeyValuePair": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.LogTypeMapKeyValuePair`\n\nThe `LogTypeMapKeyValuePair` property type specifies Property description not available. for an [AWS::EMRServerless::Application](./aws-resource-emrserverless-application.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-logtypemapkeyvaluepair.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-logtypemapkeyvaluepair.html#cfn-emrserverless-application-logtypemapkeyvaluepair-value", "UpdateType": "Conditional", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z]+[-_]*[a-zA-Z]+$`\n*Minimum*: `1`\n*Maximum*: `50`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-logtypemapkeyvaluepair.html#cfn-emrserverless-application-logtypemapkeyvaluepair-key", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.ManagedPersistenceMonitoringConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.ManagedPersistenceMonitoringConfiguration`\n\nThe managed log persistence configuration for a job run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-managedpersistencemonitoringconfiguration.html", "Properties": { "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nThe KMS key ARN to encrypt the logs stored in managed log persistence.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$`\n*Minimum*: `20`\n*Maximum*: `2048`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-managedpersistencemonitoringconfiguration.html#cfn-emrserverless-application-managedpersistencemonitoringconfiguration-encryptionkeyarn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables managed logging and defaults to true. If set to false, managed logging will be\nturned off.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-managedpersistencemonitoringconfiguration.html#cfn-emrserverless-application-managedpersistencemonitoringconfiguration-enabled", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::EMRServerless::Application.MaximumAllowedResources": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.MaximumAllowedResources`\n\nThe maximum allowed cumulative resources for an application. No new resources will be\ncreated once the limit is hit.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html", "Properties": { "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe maximum allowed resources for an application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$`\n*Minimum*: `1`\n*Maximum*: `15`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html#cfn-emrserverless-application-maximumallowedresources-memory", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe maximum allowed CPU for an application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$`\n*Minimum*: `1`\n*Maximum*: `15`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html#cfn-emrserverless-application-maximumallowedresources-cpu", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "Disk": { "MarkdownDocumentation": "`Disk`\n\nThe maximum allowed disk for an application.\n*Required*: No\n*Type*: String\n*Pattern*: `^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$`\n*Minimum*: `1`\n*Maximum*: `15`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html#cfn-emrserverless-application-maximumallowedresources-disk", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.MonitoringConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.MonitoringConfiguration`\n\nThe configuration setting for monitoring logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html", "Properties": { "S3MonitoringConfiguration": { "MarkdownDocumentation": "`S3MonitoringConfiguration`\n\nThe Amazon S3 configuration for monitoring log publishing.\n*Required*: No\n*Type*: [S3MonitoringConfiguration](./aws-properties-emrserverless-application-s3monitoringconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html#cfn-emrserverless-application-monitoringconfiguration-s3monitoringconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "S3MonitoringConfiguration" }, "PrometheusMonitoringConfiguration": { "MarkdownDocumentation": "`PrometheusMonitoringConfiguration`\n\nThe monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.\n*Required*: No\n*Type*: [PrometheusMonitoringConfiguration](./aws-properties-emrserverless-application-prometheusmonitoringconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html#cfn-emrserverless-application-monitoringconfiguration-prometheusmonitoringconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "PrometheusMonitoringConfiguration" }, "ManagedPersistenceMonitoringConfiguration": { "MarkdownDocumentation": "`ManagedPersistenceMonitoringConfiguration`\n\nThe managed log persistence configuration for a job run.\n*Required*: No\n*Type*: [ManagedPersistenceMonitoringConfiguration](./aws-properties-emrserverless-application-managedpersistencemonitoringconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html#cfn-emrserverless-application-monitoringconfiguration-managedpersistencemonitoringconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "ManagedPersistenceMonitoringConfiguration" }, "CloudWatchLoggingConfiguration": { "MarkdownDocumentation": "`CloudWatchLoggingConfiguration`\n\nThe Amazon CloudWatch configuration for monitoring logs. You can configure your jobs\nto send log information to CloudWatch.\n*Required*: No\n*Type*: [CloudWatchLoggingConfiguration](./aws-properties-emrserverless-application-cloudwatchloggingconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-monitoringconfiguration.html#cfn-emrserverless-application-monitoringconfiguration-cloudwatchloggingconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "CloudWatchLoggingConfiguration" } } }, "AWS::EMRServerless::Application.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.NetworkConfiguration`\n\nThe network configuration for customer VPC connectivity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html", "Properties": { "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe array of subnet Ids for customer VPC connectivity.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `16`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html#cfn-emrserverless-application-networkconfiguration-subnetids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe array of security group Ids for customer VPC connectivity.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html#cfn-emrserverless-application-networkconfiguration-securitygroupids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::EMRServerless::Application.PrometheusMonitoringConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.PrometheusMonitoringConfiguration`\n\nThe monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-prometheusmonitoringconfiguration.html", "Properties": { "RemoteWriteUrl": { "MarkdownDocumentation": "`RemoteWriteUrl`\n\nThe remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.\n*Required*: No\n*Type*: String\n*Pattern*: `^https://aps-workspaces.([a-z]{2}-[a-z-]{1,20}-[1-9]).amazonaws(.[0-9A-Za-z]{2,4})+/workspaces/[-_.0-9A-Za-z]{1,100}/api/v1/remote_write$`\n*Minimum*: `1`\n*Maximum*: `10280`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-prometheusmonitoringconfiguration.html#cfn-emrserverless-application-prometheusmonitoringconfiguration-remotewriteurl", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.S3MonitoringConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.S3MonitoringConfiguration`\n\nThe Amazon S3 configuration for monitoring log publishing. You can configure your jobs\nto send log information to Amazon S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-s3monitoringconfiguration.html", "Properties": { "LogUri": { "MarkdownDocumentation": "`LogUri`\n\nThe Amazon S3 destination URI for log publishing.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `10280`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-s3monitoringconfiguration.html#cfn-emrserverless-application-s3monitoringconfiguration-loguri", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nThe KMS key ARN to encrypt the logs published to the given Amazon S3 destination.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$`\n*Minimum*: `20`\n*Maximum*: `2048`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-s3monitoringconfiguration.html#cfn-emrserverless-application-s3monitoringconfiguration-encryptionkeyarn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.SchedulerConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.SchedulerConfiguration`\n\nThe scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-schedulerconfiguration.html", "Properties": { "QueueTimeoutMinutes": { "MarkdownDocumentation": "`QueueTimeoutMinutes`\n\nThe maximum duration in minutes for the job in QUEUED state. If scheduler configuration is enabled on your application, the default value is 360 minutes (6 hours). The valid range is from 15 to 720.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-schedulerconfiguration.html#cfn-emrserverless-application-schedulerconfiguration-queuetimeoutminutes", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "MaxConcurrentRuns": { "MarkdownDocumentation": "`MaxConcurrentRuns`\n\nThe maximum concurrent job runs on this application. If scheduler configuration is enabled on your application, the default value is 15. The valid range is 1 to 1000.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-schedulerconfiguration.html#cfn-emrserverless-application-schedulerconfiguration-maxconcurrentruns", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::EMRServerless::Application.WorkerConfiguration": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.WorkerConfiguration`\n\nThe configuration of a worker. For more information,\nsee [Supported worker configurations](https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/app-behavior.html#worker-configs).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html", "Properties": { "DiskType": { "MarkdownDocumentation": "`DiskType`\n\nThe disk type for every worker instance of the work type. Shuffle optimized disks have higher\nperformance characteristics and are better for shuffle heavy workloads. Default is `STANDARD`.\n*Required*: No\n*Type*: String\n*Pattern*: `^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html#cfn-emrserverless-application-workerconfiguration-disktype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe memory requirements of the worker configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$`\n*Minimum*: `1`\n*Maximum*: `15`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html#cfn-emrserverless-application-workerconfiguration-memory", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe CPU requirements of the worker configuration. Each worker can have 1, 2, 4, 8, or 16 vCPUs.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$`\n*Minimum*: `1`\n*Maximum*: `15`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html#cfn-emrserverless-application-workerconfiguration-cpu", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "Disk": { "MarkdownDocumentation": "`Disk`\n\nThe disk requirements of the worker configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$`\n*Minimum*: `1`\n*Maximum*: `15`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html#cfn-emrserverless-application-workerconfiguration-disk", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::EMRServerless::Application.WorkerTypeSpecificationInput": { "MarkdownDocumentation": "`AWS::EMRServerless::Application.WorkerTypeSpecificationInput`\n\nThe specifications for a worker type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workertypespecificationinput.html", "Properties": { "ImageConfiguration": { "MarkdownDocumentation": "`ImageConfiguration`\n\nThe image configuration for a worker type.\n*Required*: No\n*Type*: [ImageConfigurationInput](./aws-properties-emrserverless-application-imageconfigurationinput.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workertypespecificationinput.html#cfn-emrserverless-application-workertypespecificationinput-imageconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "ImageConfigurationInput" } } }, "AWS::EVS::Environment.Check": { "MarkdownDocumentation": "`AWS::EVS::Environment.Check`\n\nA check on the environment to identify environment health and validate VMware VCF licensing compliance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-check.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe check type.\nAmazon EVS performs the following checks.\n* `KEY_REUSE`: checks that the VCF license key is not used by another Amazon EVS environment.\n This check fails if a used license is added to the environment.\n* `KEY_COVERAGE`: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts.\n The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.\n* `REACHABILITY`: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager.\n If Amazon EVS cannot reach the environment, this check fails.\n* `HOST_COUNT`:\n Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.\n \n If this check fails, you will need to add hosts so that your environment meets this minimum requirement.\n Amazon EVS only supports environments with 4-16 hosts.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `KEY_REUSE | KEY_COVERAGE | ...`\n*Update requires*: Updates are not supported.", "RefReturnValue": "", "AllowedValues": [ "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "VCF_VERSION", "HOST_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-check.html#cfn-evs-environment-check-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImpairedSince": { "MarkdownDocumentation": "`ImpairedSince`\n\nThe time when environment health began to be impaired.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-check.html#cfn-evs-environment-check-impairedsince", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Result": { "MarkdownDocumentation": "`Result`\n\nThe check result.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PASSED | FAILED | UNKNOWN...`\n*Update requires*: Updates are not supported.", "RefReturnValue": "", "AllowedValues": [ "PASSED", "FAILED", "UNKNOWN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-check.html#cfn-evs-environment-check-result", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EVS::Environment.ConnectivityInfo": { "MarkdownDocumentation": "`AWS::EVS::Environment.ConnectivityInfo`\n\nThe connectivity configuration for the environment.\nAmazon EVS requires that you specify two route server peer IDs.\nDuring environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-connectivityinfo.html", "Properties": { "PrivateRouteServerPeerings": { "MarkdownDocumentation": "`PrivateRouteServerPeerings`\n\nThe unique IDs for private route server peers.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `2`\n*Maximum*: `2`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-connectivityinfo.html#cfn-evs-environment-connectivityinfo-privaterouteserverpeerings", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EVS::Environment.HostInfoForCreate": { "MarkdownDocumentation": "`AWS::EVS::Environment.HostInfoForCreate`\n\nAn object that represents a host.\n###### Note\nYou cannot use `dedicatedHostId` and `placementGroupId` together in the same `HostInfoForCreate`object.\nThis results in a `ValidationException` response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html", "Properties": { "KeyName": { "MarkdownDocumentation": "`KeyName`\n\nThe name of the SSH key that is used to access the host.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-keyname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DedicatedHostId": { "MarkdownDocumentation": "`DedicatedHostId`\n\nThe unique ID of the Amazon EC2 Dedicated Host.\n*Required*: No\n*Type*: String\n*Pattern*: `^h-[a-f0-9]{8}([a-f0-9]{9})?$`\n*Minimum*: `1`\n*Maximum*: `25`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-dedicatedhostid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlacementGroupId": { "MarkdownDocumentation": "`PlacementGroupId`\n\nThe unique ID of the placement group where the host is placed.\n*Required*: No\n*Type*: String\n*Pattern*: `^pg-[a-f0-9]{8}([a-f0-9]{9})?$`\n*Minimum*: `1`\n*Maximum*: `25`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-placementgroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe EC2 instance type that represents the host.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `i4i.metal`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "AllowedValues": [ "i4i.metal" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-instancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HostName": { "MarkdownDocumentation": "`HostName`\n\nThe DNS hostname of the host.\nDNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-hostname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EVS::Environment.InitialVlanInfo": { "MarkdownDocumentation": "`AWS::EVS::Environment.InitialVlanInfo`\n\nAn object that represents an initial VLAN subnet for the Amazon EVS environment.\nAmazon EVS creates initial VLAN subnets when you first create the environment.\nAmazon EVS creates the following 10 VLAN subnets: host management VLAN, vMotion VLAN, vSAN VLAN, VTEP VLAN, Edge VTEP VLAN,\nManagement VM VLAN, HCX uplink VLAN, NSX uplink VLAN, expansion VLAN 1, expansion VLAN 2.\n###### Note\nFor each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block.\nAmazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlaninfo.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR block that you provide to create an Amazon EVS VLAN subnet.\nAmazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.\nAmazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[1-2][0-9]|[0-9])$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlaninfo.html#cfn-evs-environment-initialvlaninfo-cidr", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EVS::Environment.InitialVlans": { "MarkdownDocumentation": "`AWS::EVS::Environment.InitialVlans`\n\nThe initial VLAN subnets for the environment.\nAmazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.\nAmazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html", "Properties": { "VmkManagement": { "MarkdownDocumentation": "`VmkManagement`\n\nThe host VMkernel management VLAN subnet.\nThis VLAN subnet carries traffic for managing ESXi hosts and communicating with VMware vCenter Server.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vmkmanagement", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "VTep": { "MarkdownDocumentation": "`VTep`\n\nThe VTEP VLAN subnet.\nThis VLAN subnet handles internal network traffic between virtual machines within a VCF instance.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vtep", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "ExpansionVlan2": { "MarkdownDocumentation": "`ExpansionVlan2`\n\nAn additional VLAN subnet that can be used to extend VCF capabilities once configured.\nFor example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization\nof multiple NSX deployments across different locations.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-expansionvlan2", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "VSan": { "MarkdownDocumentation": "`VSan`\n\nThe vSAN VLAN subnet.\nThis VLAN subnet carries the communication between ESXi hosts to implement a vSAN shared storage pool.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vsan", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "VMotion": { "MarkdownDocumentation": "`VMotion`\n\nThe vMotion VLAN subnet.\nThis VLAN subnet carries traffic for vSphere vMotion.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vmotion", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "IsHcxPublic": { "MarkdownDocumentation": "`IsHcxPublic`\n\nDetermines if the HCX VLAN that Amazon EVS provisions is public or private.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-ishcxpublic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Hcx": { "MarkdownDocumentation": "`Hcx`\n\nThe HCX VLAN subnet.\nThis VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.\nIf you plan to use a public HCX VLAN subnet, the following requirements must be met:\n* Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration.\n* The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block.\n* Must have at least two Elastic IP addresses to be allocated from the public IPAM pool for HCX components.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-hcx", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "EdgeVTep": { "MarkdownDocumentation": "`EdgeVTep`\n\nThe edge VTEP VLAN subnet.\nThis VLAN subnet manages traffic flowing between the internal network and external networks, including internet access and other site connections.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-edgevtep", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "HcxNetworkAclId": { "MarkdownDocumentation": "`HcxNetworkAclId`\n\nA unique ID for a network access control list that the HCX VLAN uses.\nRequired when `isHcxPublic` is set to `true`.\n*Required*: No\n*Type*: String\n*Pattern*: `^acl-[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-hcxnetworkaclid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExpansionVlan1": { "MarkdownDocumentation": "`ExpansionVlan1`\n\nAn additional VLAN subnet that can be used to extend VCF capabilities once configured.\nFor example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization\nof multiple NSX deployments across different locations.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-expansionvlan1", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "VmManagement": { "MarkdownDocumentation": "`VmManagement`\n\nThe VM management VLAN subnet.\nThis VLAN subnet carries traffic for vSphere virtual machines.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vmmanagement", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" }, "NsxUpLink": { "MarkdownDocumentation": "`NsxUpLink`\n\nThe NSX uplink VLAN subnet.\nThis VLAN subnet allows connectivity to the NSX overlay network.\n*Required*: Yes\n*Type*: [InitialVlanInfo](./aws-properties-evs-environment-initialvlaninfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-nsxuplink", "UpdateType": "Mutable", "Required": true, "Type": "InitialVlanInfo" } } }, "AWS::EVS::Environment.LicenseInfo": { "MarkdownDocumentation": "`AWS::EVS::Environment.LicenseInfo`\n\nThe license information that Amazon EVS requires to create an environment.\nAmazon EVS requires two license keys: a VCF solution key and a vSAN license key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-licenseinfo.html", "Properties": { "SolutionKey": { "MarkdownDocumentation": "`SolutionKey`\n\nThe VCF solution key.\nThis license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server.\nThe VCF solution key must cover a minimum of 256 cores.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-licenseinfo.html#cfn-evs-environment-licenseinfo-solutionkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VsanKey": { "MarkdownDocumentation": "`VsanKey`\n\nThe VSAN license key.\nThis license unlocks vSAN features.\nThe vSAN license key must provide at least 110 TiB of vSAN capacity.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-licenseinfo.html#cfn-evs-environment-licenseinfo-vsankey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EVS::Environment.Secret": { "MarkdownDocumentation": "`AWS::EVS::Environment.Secret`\n\nA managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager.\nDuring environment creation, the Amazon EVS control plane uses AWS Secrets Manager to create, encrypt, validate, and store secrets.\nIf you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment.\nAmazon EVS does not provide managed rotation of secrets.\nWe recommend that you rotate secrets regularly to ensure that secrets are not long-lived.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-secret.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the secret.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-secret.html#cfn-evs-environment-secret-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EVS::Environment.ServiceAccessSecurityGroups": { "MarkdownDocumentation": "`AWS::EVS::Environment.ServiceAccessSecurityGroups`\n\nThe security groups that allow traffic between the Amazon EVS control plane and your VPC for Amazon EVS service access.\nIf a security group is not specified, Amazon EVS uses the default security group in your account for service access.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-serviceaccesssecuritygroups.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security groups that allow service access.\n*Required*: No\n*Type*: Array of String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-serviceaccesssecuritygroups.html#cfn-evs-environment-serviceaccesssecuritygroups-securitygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EVS::Environment.VcfHostnames": { "MarkdownDocumentation": "`AWS::EVS::Environment.VcfHostnames`\n\nThe DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder.\nEach hostname must be unique, and resolve to a domain name that you've registered in your DNS service of choice.\nHostnames cannot be changed.\nVMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html", "Properties": { "Nsx": { "MarkdownDocumentation": "`Nsx`\n\nThe VMware NSX hostname.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-nsx", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VCenter": { "MarkdownDocumentation": "`VCenter`\n\nThe VMware vCenter hostname.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-vcenter", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NsxManager1": { "MarkdownDocumentation": "`NsxManager1`\n\nThe hostname for the first VMware NSX Manager virtual machine (VM).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-nsxmanager1", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NsxEdge1": { "MarkdownDocumentation": "`NsxEdge1`\n\nThe hostname for the first NSX Edge node.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-nsxedge1", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NsxManager3": { "MarkdownDocumentation": "`NsxManager3`\n\nThe hostname for the third VMware NSX Manager virtual machine (VM).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-nsxmanager3", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SddcManager": { "MarkdownDocumentation": "`SddcManager`\n\nThe hostname for SDDC Manager.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-sddcmanager", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NsxManager2": { "MarkdownDocumentation": "`NsxManager2`\n\nThe hostname for the second VMware NSX Manager virtual machine (VM).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-nsxmanager2", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NsxEdge2": { "MarkdownDocumentation": "`NsxEdge2`\n\nThe hostname for the second NSX Edge node.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-nsxedge2", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CloudBuilder": { "MarkdownDocumentation": "`CloudBuilder`\n\nThe hostname for VMware Cloud Builder.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9\\-]*)$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html#cfn-evs-environment-vcfhostnames-cloudbuilder", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElastiCache::CacheCluster.CloudWatchLogsDestinationDetails": { "MarkdownDocumentation": "`AWS::ElastiCache::CacheCluster.CloudWatchLogsDestinationDetails`\n\nConfiguration details of a CloudWatch Logs destination. Note that this field is marked as required but only if\nCloudWatch Logs was chosen as the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-cloudwatchlogsdestinationdetails.html", "Properties": { "LogGroup": { "MarkdownDocumentation": "`LogGroup`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-cloudwatchlogsdestinationdetails.html#cfn-elasticache-cachecluster-cloudwatchlogsdestinationdetails-loggroup", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElastiCache::CacheCluster.DestinationDetails": { "MarkdownDocumentation": "`AWS::ElastiCache::CacheCluster.DestinationDetails`\n\nConfiguration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html", "Properties": { "CloudWatchLogsDetails": { "MarkdownDocumentation": "`CloudWatchLogsDetails`\n\nThe configuration details of the CloudWatch Logs destination. Note that this field is marked as required but\nonly if CloudWatch Logs was chosen as the destination.\n*Required*: No\n*Type*: [CloudWatchLogsDestinationDetails](./aws-properties-elasticache-cachecluster-cloudwatchlogsdestinationdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html#cfn-elasticache-cachecluster-destinationdetails-cloudwatchlogsdetails", "Required": false, "Type": "CloudWatchLogsDestinationDetails", "UpdateType": "Mutable" }, "KinesisFirehoseDetails": { "MarkdownDocumentation": "`KinesisFirehoseDetails`\n\nThe configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required\nbut only if Kinesis Data Firehose was chosen as the destination.\n*Required*: No\n*Type*: [KinesisFirehoseDestinationDetails](./aws-properties-elasticache-cachecluster-kinesisfirehosedestinationdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html#cfn-elasticache-cachecluster-destinationdetails-kinesisfirehosedetails", "Required": false, "Type": "KinesisFirehoseDestinationDetails", "UpdateType": "Mutable" } } }, "AWS::ElastiCache::CacheCluster.KinesisFirehoseDestinationDetails": { "MarkdownDocumentation": "`AWS::ElastiCache::CacheCluster.KinesisFirehoseDestinationDetails`\n\nThe configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required\nbut only if Kinesis Data Firehose was chosen as the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-kinesisfirehosedestinationdetails.html", "Properties": { "DeliveryStream": { "MarkdownDocumentation": "`DeliveryStream`\n\nThe name of the Kinesis Data Firehose 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-kinesisfirehosedestinationdetails.html#cfn-elasticache-cachecluster-kinesisfirehosedestinationdetails-deliverystream", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElastiCache::CacheCluster.LogDeliveryConfigurationRequest": { "MarkdownDocumentation": "`AWS::ElastiCache::CacheCluster.LogDeliveryConfigurationRequest`\n\nSpecifies the destination, format and type of the logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html", "Properties": { "DestinationDetails": { "MarkdownDocumentation": "`DestinationDetails`\n\nConfiguration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.\n*Required*: Yes\n*Type*: [DestinationDetails](./aws-properties-elasticache-cachecluster-destinationdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-destinationdetails", "Required": true, "Type": "DestinationDetails", "UpdateType": "Mutable" }, "DestinationType": { "MarkdownDocumentation": "`DestinationType`\n\nSpecify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either\n`cloudwatch-logs` or `kinesis-firehose`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-destinationtype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LogFormat": { "MarkdownDocumentation": "`LogFormat`\n\nValid values are either `json` or `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-logformat", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LogType": { "MarkdownDocumentation": "`LogType`\n\nValid value is either `slow-log`, which refers to [slow-log](https://redis.io/commands/slowlog) or `engine-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-logtype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElastiCache::GlobalReplicationGroup.GlobalReplicationGroupMember": { "MarkdownDocumentation": "`AWS::ElastiCache::GlobalReplicationGroup.GlobalReplicationGroupMember`\n\nA member of a Global datastore. It contains the Replication Group Id, the Amazon\nregion and the role of the replication group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nIndicates the role of the replication group, `PRIMARY` or `SECONDARY`.\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)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY", "SECONDARY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReplicationGroupRegion": { "MarkdownDocumentation": "`ReplicationGroupRegion`\n\nThe Amazon region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReplicationGroupId": { "MarkdownDocumentation": "`ReplicationGroupId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElastiCache::GlobalReplicationGroup.RegionalConfiguration": { "MarkdownDocumentation": "`AWS::ElastiCache::GlobalReplicationGroup.RegionalConfiguration`\n\nA list of the replication groups\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html", "Properties": { "ReplicationGroupRegion": { "MarkdownDocumentation": "`ReplicationGroupRegion`\n\nThe Amazon region where the cluster 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReplicationGroupId": { "MarkdownDocumentation": "`ReplicationGroupId`\n\nThe name of the secondary 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReshardingConfigurations": { "MarkdownDocumentation": "`ReshardingConfigurations`\n\nA list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded\ncluster.\n*Required*: No\n*Type*: Array of [ReshardingConfiguration](./aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-reshardingconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReshardingConfiguration", "DuplicatesAllowed": false } } }, "AWS::ElastiCache::GlobalReplicationGroup.ReshardingConfiguration": { "MarkdownDocumentation": "`AWS::ElastiCache::GlobalReplicationGroup.ReshardingConfiguration`\n\nA list of `PreferredAvailabilityZones` objects that specifies the\nconfiguration of a node group in the resharded cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html", "Properties": { "NodeGroupId": { "MarkdownDocumentation": "`NodeGroupId`\n\nEither the ElastiCache supplied 4-digit id or a user supplied id for the\nnode group these configuration values apply to.\n*Required*: No\n*Type*: String\n*Pattern*: `\\d+`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-nodegroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreferredAvailabilityZones": { "MarkdownDocumentation": "`PreferredAvailabilityZones`\n\nA list of preferred availability zones for the nodes in this cluster.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-preferredavailabilityzones", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ElastiCache::ReplicationGroup.CloudWatchLogsDestinationDetails": { "MarkdownDocumentation": "`AWS::ElastiCache::ReplicationGroup.CloudWatchLogsDestinationDetails`\n\nThe configuration details of the CloudWatch Logs destination. Note that this field is marked as required but\nonly if CloudWatch Logs was chosen as the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-cloudwatchlogsdestinationdetails.html", "Properties": { "LogGroup": { "MarkdownDocumentation": "`LogGroup`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-cloudwatchlogsdestinationdetails.html#cfn-elasticache-replicationgroup-cloudwatchlogsdestinationdetails-loggroup", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElastiCache::ReplicationGroup.DestinationDetails": { "MarkdownDocumentation": "`AWS::ElastiCache::ReplicationGroup.DestinationDetails`\n\nConfiguration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-destinationdetails.html", "Properties": { "CloudWatchLogsDetails": { "MarkdownDocumentation": "`CloudWatchLogsDetails`\n\nThe configuration details of the CloudWatch Logs destination. Note that this field is marked as required but\nonly if CloudWatch Logs was chosen as the destination.\n*Required*: No\n*Type*: [CloudWatchLogsDestinationDetails](./aws-properties-elasticache-replicationgroup-cloudwatchlogsdestinationdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-destinationdetails.html#cfn-elasticache-replicationgroup-destinationdetails-cloudwatchlogsdetails", "Required": false, "Type": "CloudWatchLogsDestinationDetails", "UpdateType": "Mutable" }, "KinesisFirehoseDetails": { "MarkdownDocumentation": "`KinesisFirehoseDetails`\n\nThe configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required\nbut only if Kinesis Data Firehose was chosen as the destination.\n*Required*: No\n*Type*: [KinesisFirehoseDestinationDetails](./aws-properties-elasticache-replicationgroup-kinesisfirehosedestinationdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-destinationdetails.html#cfn-elasticache-replicationgroup-destinationdetails-kinesisfirehosedetails", "Required": false, "Type": "KinesisFirehoseDestinationDetails", "UpdateType": "Mutable" } } }, "AWS::ElastiCache::ReplicationGroup.KinesisFirehoseDestinationDetails": { "MarkdownDocumentation": "`AWS::ElastiCache::ReplicationGroup.KinesisFirehoseDestinationDetails`\n\nThe configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required\nbut only if Kinesis Data Firehose was chosen as the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-kinesisfirehosedestinationdetails.html", "Properties": { "DeliveryStream": { "MarkdownDocumentation": "`DeliveryStream`\n\nThe name of the Kinesis Data Firehose 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-kinesisfirehosedestinationdetails.html#cfn-elasticache-replicationgroup-kinesisfirehosedestinationdetails-deliverystream", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElastiCache::ReplicationGroup.LogDeliveryConfigurationRequest": { "MarkdownDocumentation": "`AWS::ElastiCache::ReplicationGroup.LogDeliveryConfigurationRequest`\n\nSpecifies the destination, format and type of the logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html", "Properties": { "DestinationDetails": { "MarkdownDocumentation": "`DestinationDetails`\n\nConfiguration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.\n*Required*: Yes\n*Type*: [DestinationDetails](./aws-properties-elasticache-replicationgroup-destinationdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html#cfn-elasticache-replicationgroup-logdeliveryconfigurationrequest-destinationdetails", "Required": true, "Type": "DestinationDetails", "UpdateType": "Mutable" }, "DestinationType": { "MarkdownDocumentation": "`DestinationType`\n\nSpecify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either\n`cloudwatch-logs` or `kinesis-firehose`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html#cfn-elasticache-replicationgroup-logdeliveryconfigurationrequest-destinationtype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LogFormat": { "MarkdownDocumentation": "`LogFormat`\n\nValid values are either `json` or `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html#cfn-elasticache-replicationgroup-logdeliveryconfigurationrequest-logformat", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LogType": { "MarkdownDocumentation": "`LogType`\n\nValid value is either `slow-log`, which refers to [slow-log](https://redis.io/commands/slowlog) or `engine-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html#cfn-elasticache-replicationgroup-logdeliveryconfigurationrequest-logtype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration": { "MarkdownDocumentation": "`AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration`\n\n`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup`\nresource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html", "Properties": { "NodeGroupId": { "MarkdownDocumentation": "`NodeGroupId`\n\nEither the ElastiCache supplied 4-digit id or a user supplied id for the\nnode group these configuration values apply to.\n*Required*: No\n*Type*: String\n*Pattern*: `\\d+`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-nodegroupid", "PrimitiveType": "String", "Required": false, "UpdateType": "Conditional" }, "PrimaryAvailabilityZone": { "MarkdownDocumentation": "`PrimaryAvailabilityZone`\n\nThe Availability Zone where the primary node of this node group (shard) is\nlaunched.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-primaryavailabilityzone", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ReplicaAvailabilityZones": { "MarkdownDocumentation": "`ReplicaAvailabilityZones`\n\nA list of Availability Zones to be used for the read replicas. The number of\nAvailability Zones in this list must match the value of `ReplicaCount` or\n`ReplicasPerNodeGroup` if not specified.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicaavailabilityzones", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "ReplicaCount": { "MarkdownDocumentation": "`ReplicaCount`\n\nThe number of read replica nodes in this node group (shard).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicacount", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "Slots": { "MarkdownDocumentation": "`Slots`\n\nA string of comma-separated values where the first set of values are the slot numbers (zero based), and the\nsecond set of values are the keyspaces for each slot. The following example specifies three slots (numbered 0, 1, and\n2): `0,1,2,0-4999,5000-9999,10000-16,383`.\nIf you don't specify a value, ElastiCache allocates keys equally among each slot.\nWhen you use an `UseOnlineResharding` update policy to update the number of node groups without\ninterruption, ElastiCache evenly distributes the keyspaces between the specified number of slots. This cannot be\nupdated later. Therefore, after updating the number of node groups in this way, you should remove the value specified\nfor the `Slots` property of each `NodeGroupConfiguration` from the stack template, as it no\nlonger reflects the actual values in each node group. For more information, see [UseOnlineResharding Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-slots", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" } } }, "AWS::ElastiCache::ServerlessCache.CacheUsageLimits": { "MarkdownDocumentation": "`AWS::ElastiCache::ServerlessCache.CacheUsageLimits`\n\nThe usage limits for storage and ElastiCache Processing Units for the cache.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-cacheusagelimits.html", "Properties": { "DataStorage": { "MarkdownDocumentation": "`DataStorage`\n\nThe maximum data storage limit in the cache, expressed in Gigabytes.\n*Required*: No\n*Type*: [DataStorage](./aws-properties-elasticache-serverlesscache-datastorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-cacheusagelimits.html#cfn-elasticache-serverlesscache-cacheusagelimits-datastorage", "UpdateType": "Mutable", "Required": false, "Type": "DataStorage" }, "ECPUPerSecond": { "MarkdownDocumentation": "`ECPUPerSecond`\n\nThe number of ElastiCache Processing Units (ECPU) the cache can consume per second.\n*Required*: No\n*Type*: [ECPUPerSecond](./aws-properties-elasticache-serverlesscache-ecpupersecond.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-cacheusagelimits.html#cfn-elasticache-serverlesscache-cacheusagelimits-ecpupersecond", "UpdateType": "Mutable", "Required": false, "Type": "ECPUPerSecond" } } }, "AWS::ElastiCache::ServerlessCache.DataStorage": { "MarkdownDocumentation": "`AWS::ElastiCache::ServerlessCache.DataStorage`\n\nThe data storage limit.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html", "Properties": { "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nThe lower limit for data storage the cache is set to use.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-minimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Maximum": { "MarkdownDocumentation": "`Maximum`\n\nThe upper limit for data storage the cache is set to use.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-maximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit that the storage is measured in, in GB.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GB`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "GB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-unit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElastiCache::ServerlessCache.ECPUPerSecond": { "MarkdownDocumentation": "`AWS::ElastiCache::ServerlessCache.ECPUPerSecond`\n\nThe configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-ecpupersecond.html", "Properties": { "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nThe configuration for the minimum number of ECPUs the cache should be able consume 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-ecpupersecond.html#cfn-elasticache-serverlesscache-ecpupersecond-minimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Maximum": { "MarkdownDocumentation": "`Maximum`\n\nThe configuration for the maximum number of ECPUs the cache can consume 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-ecpupersecond.html#cfn-elasticache-serverlesscache-ecpupersecond-maximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ElastiCache::ServerlessCache.Endpoint": { "MarkdownDocumentation": "`AWS::ElastiCache::ServerlessCache.Endpoint`\n\nRepresents the information required for client programs to connect to a cache\nnode. This value is read-only.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-endpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe DNS hostname of the cache node.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-endpoint.html#cfn-elasticache-serverlesscache-endpoint-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port number that the cache 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-endpoint.html#cfn-elasticache-serverlesscache-endpoint-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElastiCache::User.AuthenticationMode": { "MarkdownDocumentation": "`AWS::ElastiCache::User.AuthenticationMode`\n\nSpecifies the authentication mode to use.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-user-authenticationmode.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the authentication type. Possible options are IAM authentication, password\nand no password.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `password | no-password-requ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "password", "no-password-required", "iam" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-user-authenticationmode.html#cfn-elasticache-user-authenticationmode-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Passwords": { "MarkdownDocumentation": "`Passwords`\n\nSpecifies the passwords to use for authentication if `Type` is set to\n`password`.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-user-authenticationmode.html#cfn-elasticache-user-authenticationmode-passwords", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ElasticBeanstalk::Application.ApplicationResourceLifecycleConfig": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::Application.ApplicationResourceLifecycleConfig`\n\nThe resource lifecycle configuration for an application. Defines lifecycle settings for\nresources that belong to the application, and the service role that Elastic Beanstalk assumes\nin order to apply lifecycle settings. The version lifecycle configuration defines lifecycle\nsettings for application versions.\n`ApplicationResourceLifecycleConfig` is a property of the [AWS::ElasticBeanstalk::Application](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html", "Properties": { "ServiceRole": { "MarkdownDocumentation": "`ServiceRole`\n\nThe ARN of an IAM service role that Elastic Beanstalk has permission to\nassume.\nThe `ServiceRole` property is required the first time that you provide a `ResourceLifecycleConfig` for the application.\nAfter you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again.\nYou can, however, specify it in subsequent updates to change the Service Role to another 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-servicerole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VersionLifecycleConfig": { "MarkdownDocumentation": "`VersionLifecycleConfig`\n\nDefines lifecycle settings for application versions.\n*Required*: No\n*Type*: [ApplicationVersionLifecycleConfig](./aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-versionlifecycleconfig", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationVersionLifecycleConfig" } } }, "AWS::ElasticBeanstalk::Application.ApplicationVersionLifecycleConfig": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::Application.ApplicationVersionLifecycleConfig`\n\nThe application version lifecycle settings for an application. Defines the rules that\nElastic Beanstalk applies to an application's versions in order to avoid hitting the\nper-region limit for application versions.\nWhen Elastic Beanstalk deletes an application version from its database, you can no\nlonger deploy that version to an environment. The source bundle remains in S3 unless you\nconfigure the rule to delete it.\n`ApplicationVersionLifecycleConfig` is a property of the [ApplicationResourceLifecycleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html)\nproperty type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html", "Properties": { "MaxCountRule": { "MarkdownDocumentation": "`MaxCountRule`\n\nSpecify a max count rule to restrict the number of application versions that are\nretained for an application.\n*Required*: No\n*Type*: [MaxCountRule](./aws-properties-elasticbeanstalk-application-maxcountrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxcountrule", "UpdateType": "Mutable", "Required": false, "Type": "MaxCountRule" }, "MaxAgeRule": { "MarkdownDocumentation": "`MaxAgeRule`\n\nSpecify a max age rule to restrict the length of time that application versions are\nretained for an application.\n*Required*: No\n*Type*: [MaxAgeRule](./aws-properties-elasticbeanstalk-application-maxagerule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxagerule", "UpdateType": "Mutable", "Required": false, "Type": "MaxAgeRule" } } }, "AWS::ElasticBeanstalk::Application.MaxAgeRule": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::Application.MaxAgeRule`\n\nA lifecycle rule that deletes application versions after the specified number of\ndays.\n`MaxAgeRule` is a property of the [ApplicationVersionLifecycleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html)\nproperty type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html", "Properties": { "DeleteSourceFromS3": { "MarkdownDocumentation": "`DeleteSourceFromS3`\n\nSet to `true` to delete a version's source bundle from Amazon S3 when\nElastic Beanstalk deletes the application 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-deletesourcefroms3", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxAgeInDays": { "MarkdownDocumentation": "`MaxAgeInDays`\n\nSpecify the number of days to retain an application versions.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-maxageindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecify `true` to apply the rule, or `false` to disable\nit.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ElasticBeanstalk::Application.MaxCountRule": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::Application.MaxCountRule`\n\nA lifecycle rule that deletes the oldest application version when the maximum count is\nexceeded.\n`MaxCountRule` is a property of the [ApplicationVersionLifecycleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html)\nproperty type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html", "Properties": { "DeleteSourceFromS3": { "MarkdownDocumentation": "`DeleteSourceFromS3`\n\nSet to `true` to delete a version's source bundle from Amazon S3 when\nElastic Beanstalk deletes the application 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-deletesourcefroms3", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecify `true` to apply the rule, or `false` to disable\nit.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxCount": { "MarkdownDocumentation": "`MaxCount`\n\nSpecify the maximum number of application versions to retain.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-maxcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle`\n\nThe `SourceBundle` property is an embedded property of the [AWS::ElasticBeanstalk::ApplicationVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html) resource. It specifies the Amazon S3\nlocation of the source bundle for an AWS Elastic Beanstalk application version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html", "Properties": { "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html#cfn-elasticbeanstalk-applicationversion-sourcebundle-s3bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3Key": { "MarkdownDocumentation": "`S3Key`\n\nThe Amazon S3 key where the data is located.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html#cfn-elasticbeanstalk-applicationversion-sourcebundle-s3key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticBeanstalk::ConfigurationTemplate.ConfigurationOptionSetting": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::ConfigurationTemplate.ConfigurationOptionSetting`\n\nThe `ConfigurationOptionSetting` property type specifies an option for an AWS Elastic Beanstalk configuration template.\nThe `OptionSettings` property of the [AWS::ElasticBeanstalk::ConfigurationTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html)\nresource contains a list of `ConfigurationOptionSetting` property types.\nFor a list of possible namespaces and option values, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the\n*AWS Elastic Beanstalk Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html", "Properties": { "ResourceName": { "MarkdownDocumentation": "`ResourceName`\n\nA unique resource name for the option setting. Use it for a time\u2013based scaling configuration option.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-resourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe current value for the configuration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nA unique namespace that identifies the option's associated AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-namespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OptionName": { "MarkdownDocumentation": "`OptionName`\n\nThe name of the configuration option.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-optionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticBeanstalk::ConfigurationTemplate.SourceConfiguration": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::ConfigurationTemplate.SourceConfiguration`\n\nAn AWS Elastic Beanstalk configuration template to base a new one on. You can use it to\ndefine a [AWS::ElasticBeanstalk::ConfigurationTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html", "Properties": { "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nThe name of the application associated with the configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-applicationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TemplateName": { "MarkdownDocumentation": "`TemplateName`\n\nThe name of the configuration template.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-templatename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticBeanstalk::Environment.OptionSetting": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::Environment.OptionSetting`\n\nThe `OptionSetting` property type specifies an option for an AWS Elastic Beanstalk environment.\nThe `OptionSettings` property of the [AWS::ElasticBeanstalk::Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html) resource contains a list of\n`OptionSetting` property types.\nFor a list of possible namespaces and option values, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the\n*AWS Elastic Beanstalk Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html", "Properties": { "ResourceName": { "MarkdownDocumentation": "`ResourceName`\n\nA unique resource name for the option setting. Use it for a time\u2013based scaling configuration option.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-resourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe current value for the configuration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nA unique namespace that identifies the option's associated AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-namespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OptionName": { "MarkdownDocumentation": "`OptionName`\n\nThe name of the configuration option.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-optionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticBeanstalk::Environment.Tier": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::Environment.Tier`\n\nDescribes the environment tier for an [AWS::ElasticBeanstalk::Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html) resource. For more information, see [Environment Tiers](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html) in the *AWS Elastic Beanstalk Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of this environment tier.\nValid values:\n* For *Web server tier* \u2013 `Standard`\n* For *Worker tier* \u2013 `SQS/HTTP`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the\nlatest compatible worker tier version.\n###### Note\nThis member is deprecated. Any specific version that you set may become out of date.\nWe recommend leaving it unspecified.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of this environment tier.\nValid values:\n* For *Web server tier* \u2013 `WebServer`\n* For *Worker tier* \u2013 `Worker`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html", "Properties": { "EmitInterval": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-emitinterval", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "Enabled": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-enabled", "PrimitiveType": "Boolean", "Required": true, "UpdateType": "Mutable" }, "S3BucketName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-s3bucketname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "S3BucketPrefix": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-s3bucketprefix", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-AppCookieStickinessPolicy.html", "Properties": { "CookieName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-AppCookieStickinessPolicy.html#cfn-elb-appcookiestickinesspolicy-cookiename", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "PolicyName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-AppCookieStickinessPolicy.html#cfn-elb-appcookiestickinesspolicy-policyname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectiondrainingpolicy.html", "Properties": { "Enabled": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectiondrainingpolicy.html#cfn-elb-connectiondrainingpolicy-enabled", "PrimitiveType": "Boolean", "Required": true, "UpdateType": "Mutable" }, "Timeout": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectiondrainingpolicy.html#cfn-elb-connectiondrainingpolicy-timeout", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectionsettings.html", "Properties": { "IdleTimeout": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectionsettings.html#cfn-elb-connectionsettings-idletimeout", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck`\n\nSpecifies health check settings for your Classic Load Balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html", "Properties": { "HealthyThreshold": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-healthythreshold", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Interval": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-interval", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Target": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-target", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Timeout": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-timeout", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "UnhealthyThreshold": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-unhealthythreshold", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-LBCookieStickinessPolicy.html", "Properties": { "CookieExpirationPeriod": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-LBCookieStickinessPolicy.html#cfn-elb-lbcookiestickinesspolicy-cookieexpirationperiod", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "PolicyName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-LBCookieStickinessPolicy.html#cfn-elb-lbcookiestickinesspolicy-policyname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancing::LoadBalancer.Listeners": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer.Listeners`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html", "Properties": { "InstancePort": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-instanceport", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "InstanceProtocol": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-instanceprotocol", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "LoadBalancerPort": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-loadbalancerport", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "PolicyNames": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-policynames", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Protocol": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-protocol", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "SSLCertificateId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-sslcertificateid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancing::LoadBalancer.Policies": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer.Policies`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html", "Properties": { "Attributes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-attributes", "DuplicatesAllowed": false, "PrimitiveItemType": "Json", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "InstancePorts": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-instanceports", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "LoadBalancerPorts": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-loadbalancerports", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "PolicyName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-policyname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "PolicyType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-policytype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancingV2::Listener.Action": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.Action`\n\nSpecifies an action for a listener rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html", "Properties": { "Order": { "MarkdownDocumentation": "`Order`\n\nThe order for the action. This value is required for rules with multiple actions. The\naction with the lowest value for order is performed first.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-order", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetGroupArn": { "MarkdownDocumentation": "`TargetGroupArn`\n\nThe Amazon Resource Name (ARN) of the target group. Specify only when `Type` is\n`forward` and you want to route to a single target group. To route to multiple\ntarget groups, you must use `ForwardConfig` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-targetgrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FixedResponseConfig": { "MarkdownDocumentation": "`FixedResponseConfig`\n\n[Application Load Balancer] Information for creating an action that returns a custom HTTP\nresponse. Specify only when `Type` is `fixed-response`.\n*Required*: No\n*Type*: [FixedResponseConfig](./aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-fixedresponseconfig", "UpdateType": "Mutable", "Required": false, "Type": "FixedResponseConfig" }, "AuthenticateCognitoConfig": { "MarkdownDocumentation": "`AuthenticateCognitoConfig`\n\n[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only\nwhen `Type` is `authenticate-cognito`.\n*Required*: No\n*Type*: [AuthenticateCognitoConfig](./aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticatecognitoconfig", "UpdateType": "Mutable", "Required": false, "Type": "AuthenticateCognitoConfig" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of action.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `forward | authenticate-oidc...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RedirectConfig": { "MarkdownDocumentation": "`RedirectConfig`\n\n[Application Load Balancer] Information for creating a redirect action. Specify only when\n`Type` is `redirect`.\n*Required*: No\n*Type*: [RedirectConfig](./aws-properties-elasticloadbalancingv2-listener-redirectconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-redirectconfig", "UpdateType": "Mutable", "Required": false, "Type": "RedirectConfig" }, "JwtValidationConfig": { "MarkdownDocumentation": "`JwtValidationConfig`\n\n[HTTPS listeners] Information for validating JWT access tokens in client requests.\nSpecify only when `Type` is `jwt-validation`.\n*Required*: No\n*Type*: [JwtValidationConfig](./aws-properties-elasticloadbalancingv2-listener-jwtvalidationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-jwtvalidationconfig", "UpdateType": "Mutable", "Required": false, "Type": "JwtValidationConfig" }, "ForwardConfig": { "MarkdownDocumentation": "`ForwardConfig`\n\nInformation for creating an action that distributes requests among multiple target\ngroups. Specify only when `Type` is `forward`.\nIf you specify both `ForwardConfig` and `TargetGroupArn`, you can\nspecify only one target group using `ForwardConfig` and it must be the same\ntarget group specified in `TargetGroupArn`.\n*Required*: No\n*Type*: [ForwardConfig](./aws-properties-elasticloadbalancingv2-listener-forwardconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-forwardconfig", "UpdateType": "Mutable", "Required": false, "Type": "ForwardConfig" }, "AuthenticateOidcConfig": { "MarkdownDocumentation": "`AuthenticateOidcConfig`\n\n[HTTPS listeners] Information about an identity provider that is compliant with OpenID\nConnect (OIDC). Specify only when `Type` is `authenticate-oidc`.\n*Required*: No\n*Type*: [AuthenticateOidcConfig](./aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticateoidcconfig", "UpdateType": "Mutable", "Required": false, "Type": "AuthenticateOidcConfig" } } }, "AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig`\n\nSpecifies information required when integrating with Amazon Cognito to authenticate\nusers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html", "Properties": { "OnUnauthenticatedRequest": { "MarkdownDocumentation": "`OnUnauthenticatedRequest`\n\nThe 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\n the default value.\n*Required*: No\n*Type*: String\n*Allowed values*: `deny | allow | authenticate...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "deny", "allow", "authenticate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-onunauthenticatedrequest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserPoolClientId": { "MarkdownDocumentation": "`UserPoolClientId`\n\nThe ID of the Amazon Cognito user pool 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolclientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UserPoolDomain": { "MarkdownDocumentation": "`UserPoolDomain`\n\nThe domain prefix or fully-qualified domain name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpooldomain", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SessionTimeout": { "MarkdownDocumentation": "`SessionTimeout`\n\nThe maximum duration of the authentication session, in seconds. The default is 604800\nseconds (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe set of user claims to be requested from the IdP. The default is\n`openid`.\nTo verify which scope values your IdP supports and how to separate multiple values, see\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SessionCookieName": { "MarkdownDocumentation": "`SessionCookieName`\n\nThe name of the cookie used to maintain session information. The default is\nAWSELBAuthSessionCookie.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessioncookiename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserPoolArn": { "MarkdownDocumentation": "`UserPoolArn`\n\nThe Amazon Resource Name (ARN) of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthenticationRequestExtraParams": { "MarkdownDocumentation": "`AuthenticationRequestExtraParams`\n\nThe query parameters (up to 10) to include in the redirect request to the authorization\nendpoint.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-authenticationrequestextraparams", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig`\n\nSpecifies information required using an identity provide (IdP) that is compliant with\nOpenID Connect (OIDC) to authenticate users.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html", "Properties": { "OnUnauthenticatedRequest": { "MarkdownDocumentation": "`OnUnauthenticatedRequest`\n\nThe 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\n the default value.\n*Required*: No\n*Type*: String\n*Allowed values*: `deny | allow | authenticate...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "deny", "allow", "authenticate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-onunauthenticatedrequest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TokenEndpoint": { "MarkdownDocumentation": "`TokenEndpoint`\n\nThe token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the\ndomain, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-tokenendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UseExistingClientSecret": { "MarkdownDocumentation": "`UseExistingClientSecret`\n\nIndicates whether to use the existing client secret when modifying a rule. If you are\ncreating 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-useexistingclientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SessionTimeout": { "MarkdownDocumentation": "`SessionTimeout`\n\nThe maximum duration of the authentication session, in seconds. The default is 604800\nseconds (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe set of user claims to be requested from the IdP. The default is\n`openid`.\nTo verify which scope values your IdP supports and how to separate multiple values, see\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nThe OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS\nprotocol, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-issuer", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you\nare modifying a rule, you can omit this parameter if you set\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserInfoEndpoint": { "MarkdownDocumentation": "`UserInfoEndpoint`\n\nThe user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol,\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-userinfoendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthorizationEndpoint": { "MarkdownDocumentation": "`AuthorizationEndpoint`\n\nThe authorization endpoint of the IdP. This must be a full URL, including the HTTPS\nprotocol, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authorizationendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SessionCookieName": { "MarkdownDocumentation": "`SessionCookieName`\n\nThe name of the cookie used to maintain session information. The default is\nAWSELBAuthSessionCookie.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessioncookiename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthenticationRequestExtraParams": { "MarkdownDocumentation": "`AuthenticationRequestExtraParams`\n\nThe query parameters (up to 10) to include in the redirect request to the authorization\nendpoint.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authenticationrequestextraparams", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ElasticLoadBalancingV2::Listener.Certificate": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.Certificate`\n\nSpecifies an SSL server certificate to use as the default certificate for a secure\nlistener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificate.html", "Properties": { "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificate.html#cfn-elasticloadbalancingv2-listener-certificate-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig`\n\nSpecifies information required when returning a custom HTTP response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html", "Properties": { "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe content type.\nValid Values: text/plain | text/css | text/html | application/javascript |\napplication/json\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe HTTP response code (2XX, 4XX, or 5XX).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(2|4|5)\\d\\d$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-statuscode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MessageBody": { "MarkdownDocumentation": "`MessageBody`\n\nThe message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-messagebody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::Listener.ForwardConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.ForwardConfig`\n\nInformation for creating an action that distributes requests among multiple target\ngroups. Specify only when `Type` is `forward`.\nIf you specify both `ForwardConfig` and `TargetGroupArn`, you can\nspecify only one target group using `ForwardConfig` and it must be the same\ntarget group specified in `TargetGroupArn`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html", "Properties": { "TargetGroupStickinessConfig": { "MarkdownDocumentation": "`TargetGroupStickinessConfig`\n\nInformation about the target group stickiness for a rule.\n*Required*: No\n*Type*: [TargetGroupStickinessConfig](./aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html#cfn-elasticloadbalancingv2-listener-forwardconfig-targetgroupstickinessconfig", "UpdateType": "Mutable", "Required": false, "Type": "TargetGroupStickinessConfig" }, "TargetGroups": { "MarkdownDocumentation": "`TargetGroups`\n\nInformation about how traffic will be distributed between multiple target groups in a\nforward rule.\n*Required*: No\n*Type*: Array of [TargetGroupTuple](./aws-properties-elasticloadbalancingv2-listener-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html#cfn-elasticloadbalancingv2-listener-forwardconfig-targetgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetGroupTuple", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::Listener.JwtValidationActionAdditionalClaim": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.JwtValidationActionAdditionalClaim`\n\nInformation about an additional claim to validate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-jwtvalidationactionadditionalclaim.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe format of the claim value.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `single-string | string-arra...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "single-string", "string-array", "space-separated-values" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-jwtvalidationactionadditionalclaim.html#cfn-elasticloadbalancingv2-listener-jwtvalidationactionadditionalclaim-format", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe claim value. The maximum size of the list is 10.\nEach value can be up to 256 characters in length.\nIf the format is `space-separated-values`, the values\ncan't include spaces.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-jwtvalidationactionadditionalclaim.html#cfn-elasticloadbalancingv2-listener-jwtvalidationactionadditionalclaim-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the claim. You can't specify `exp`, `iss`,\n`nbf`, or `iat` because we validate them by default.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-jwtvalidationactionadditionalclaim.html#cfn-elasticloadbalancingv2-listener-jwtvalidationactionadditionalclaim-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::Listener.JwtValidationConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.JwtValidationConfig`\n\nThe `JwtValidationConfig` property type specifies Property description not available. for an [AWS::ElasticLoadBalancingV2::Listener](./aws-resource-elasticloadbalancingv2-listener.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-jwtvalidationconfig.html", "Properties": { "JwksEndpoint": { "MarkdownDocumentation": "`JwksEndpoint`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-jwtvalidationconfig.html#cfn-elasticloadbalancingv2-listener-jwtvalidationconfig-jwksendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-jwtvalidationconfig.html#cfn-elasticloadbalancingv2-listener-jwtvalidationconfig-issuer", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AdditionalClaims": { "MarkdownDocumentation": "`AdditionalClaims`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [JwtValidationActionAdditionalClaim](./aws-properties-elasticloadbalancingv2-listener-jwtvalidationactionadditionalclaim.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-jwtvalidationconfig.html#cfn-elasticloadbalancingv2-listener-jwtvalidationconfig-additionalclaims", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "JwtValidationActionAdditionalClaim", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::Listener.ListenerAttribute": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.ListenerAttribute`\n\nInformation about a listener attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-listenerattribute.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-listenerattribute.html#cfn-elasticloadbalancingv2-listener-listenerattribute-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name of the attribute.\nThe following attribute is supported by Network Load Balancers, and Gateway Load Balancers.\n* `tcp.idle_timeout.seconds` - The tcp idle timeout value, in seconds. The\n valid range is 60-6000 seconds. The default is 350 seconds.\nThe following attributes are only supported by Application Load Balancers.\n* `routing.http.request.x_amzn_mtls_clientcert_serial_number.header_name` -\n Enables you to modify the header name of the\n **X-Amzn-Mtls-Clientcert-Serial-Number** HTTP request header.\n* `routing.http.request.x_amzn_mtls_clientcert_issuer.header_name` -\n Enables you to modify the header name of the\n **X-Amzn-Mtls-Clientcert-Issuer** HTTP request header.\n* `routing.http.request.x_amzn_mtls_clientcert_subject.header_name` -\n Enables you to modify the header name of the\n **X-Amzn-Mtls-Clientcert-Subject** HTTP request header.\n* `routing.http.request.x_amzn_mtls_clientcert_validity.header_name` -\n Enables you to modify the header name of the\n **X-Amzn-Mtls-Clientcert-Validity** HTTP request header.\n* `routing.http.request.x_amzn_mtls_clientcert_leaf.header_name` -\n Enables you to modify the header name of the\n **X-Amzn-Mtls-Clientcert-Leaf** HTTP request header.\n* `routing.http.request.x_amzn_mtls_clientcert.header_name` -\n Enables you to modify the header name of the\n **X-Amzn-Mtls-Clientcert** HTTP request header.\n* `routing.http.request.x_amzn_tls_version.header_name` -\n Enables you to modify the header name of the\n **X-Amzn-Tls-Version** HTTP request header.\n* `routing.http.request.x_amzn_tls_cipher_suite.header_name` -\n Enables you to modify the header name of the\n **X-Amzn-Tls-Cipher-Suite** HTTP request header.\n* `routing.http.response.server.enabled` -\n Enables you to allow or remove the HTTP response server header.\n* `routing.http.response.strict_transport_security.header_value` -\n Informs browsers that the site should only be accessed using HTTPS, and that\n any future attempts to access it using HTTP should automatically be converted\n to HTTPS.\n* `routing.http.response.access_control_allow_origin.header_value` -\n Specifies which origins are allowed to access the server.\n* `routing.http.response.access_control_allow_methods.header_value` -\n Returns which HTTP methods are allowed when accessing the server from a different\n origin.\n* `routing.http.response.access_control_allow_headers.header_value` -\n Specifies which headers can be used during the request.\n* `routing.http.response.access_control_allow_credentials.header_value` -\n Indicates whether the browser should include credentials such as cookies or\n authentication when making requests.\n* `routing.http.response.access_control_expose_headers.header_value` -\n Returns which headers the browser can expose to the requesting client.\n* `routing.http.response.access_control_max_age.header_value` -\n Specifies how long the results of a preflight request can be cached, in seconds.\n* `routing.http.response.content_security_policy.header_value` -\n Specifies restrictions enforced by the browser to help minimize the risk of certain\n types of security threats.\n* `routing.http.response.x_content_type_options.header_value` -\n Indicates whether the MIME types advertised in the **Content-Type**\n headers should be followed and not be changed.\n* `routing.http.response.x_frame_options.header_value` - Indicates\n whether the browser is allowed to render a page in a **frame**,\n **iframe**, **embed** or\n **object**.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-listenerattribute.html#cfn-elasticloadbalancingv2-listener-listenerattribute-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::Listener.MutualAuthentication": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.MutualAuthentication`\n\nThe mutual authentication configuration information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-mutualauthentication.html", "Properties": { "IgnoreClientCertificateExpiry": { "MarkdownDocumentation": "`IgnoreClientCertificateExpiry`\n\nIndicates whether expired client certificates are ignored.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-mutualauthentication.html#cfn-elasticloadbalancingv2-listener-mutualauthentication-ignoreclientcertificateexpiry", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe client certificate handling method. Options are `off`,\n`passthrough` or `verify`. The default value is\n`off`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-mutualauthentication.html#cfn-elasticloadbalancingv2-listener-mutualauthentication-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustStoreArn": { "MarkdownDocumentation": "`TrustStoreArn`\n\nThe Amazon Resource Name (ARN) of the trust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-mutualauthentication.html#cfn-elasticloadbalancingv2-listener-mutualauthentication-truststorearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdvertiseTrustStoreCaNames": { "MarkdownDocumentation": "`AdvertiseTrustStoreCaNames`\n\nIndicates whether trust store CA certificate names are advertised.\n*Required*: No\n*Type*: String\n*Allowed values*: `on | off`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "on", "off" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-mutualauthentication.html#cfn-elasticloadbalancingv2-listener-mutualauthentication-advertisetruststorecanames", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::Listener.RedirectConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.RedirectConfig`\n\nInformation about a redirect action.\nA URI consists of the following components: protocol://hostname:port/path?query. You must\nmodify at least one of the following components to avoid a redirect loop: protocol, hostname,\nport, or path. Any components that you do not modify retain their original values.\nYou can reuse URI components using the following reserved keywords:\n* #{protocol}\n* #{host}\n* #{port}\n* #{path} (the leading \"/\" is removed)\n* #{query}\nFor example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\",\nor the query to \"#{query}&value=xyz\".\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe absolute path, starting with the leading \"/\". This component is not percent-encoded.\nThe path can contain #{host}, #{path}, and #{port}.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Query": { "MarkdownDocumentation": "`Query`\n\nThe query parameters, URL-encoded when necessary, but not percent-encoded. Do not include\nthe leading \"?\", as it is automatically added. You can specify any of the reserved\nkeywords.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-query", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port. You can specify a value from 1 to 65535 or #{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThe hostname. This component is not percent-encoded. The hostname can contain\n#{host}.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-host", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP,\nHTTP to HTTPS, and HTTPS to HTTPS. You can't redirect HTTPS to HTTP.\n*Required*: No\n*Type*: String\n*Pattern*: `^(HTTPS?|#\\{protocol\\})$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP\n302).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HTTP_301 | HTTP_302...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HTTP_301", "HTTP_302" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-statuscode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig`\n\nInformation about the target group stickiness for a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether target group stickiness 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listener-targetgroupstickinessconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DurationSeconds": { "MarkdownDocumentation": "`DurationSeconds`\n\n[Application Load Balancers] The time period, in seconds, during which requests from a\nclient should be routed to the same target group. The range is 1-604800 seconds (7 days). You\nmust specify this value when enabling target group stickiness.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listener-targetgroupstickinessconfig-durationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple`\n\nInformation about how traffic will be distributed between multiple target groups in a\nforward rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html", "Properties": { "TargetGroupArn": { "MarkdownDocumentation": "`TargetGroupArn`\n\nThe Amazon Resource Name (ARN) of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html#cfn-elasticloadbalancingv2-listener-targetgrouptuple-targetgrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html#cfn-elasticloadbalancingv2-listener-targetgrouptuple-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html", "Properties": { "CertificateArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html#cfn-elasticloadbalancingv2-listener-certificates-certificatearn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.Action": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.Action`\n\nSpecifies an action for a listener rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html", "Properties": { "Order": { "MarkdownDocumentation": "`Order`\n\nThe order for the action. This value is required for rules with multiple actions. The\naction with the lowest value for order is performed first.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-order", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetGroupArn": { "MarkdownDocumentation": "`TargetGroupArn`\n\nThe Amazon Resource Name (ARN) of the target group. Specify only when `Type` is\n`forward` and you want to route to a single target group. To route to multiple\ntarget groups, you must use `ForwardConfig` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-targetgrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FixedResponseConfig": { "MarkdownDocumentation": "`FixedResponseConfig`\n\n[Application Load Balancer] Information for creating an action that returns a custom HTTP\nresponse. Specify only when `Type` is `fixed-response`.\n*Required*: No\n*Type*: [FixedResponseConfig](./aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-fixedresponseconfig", "UpdateType": "Mutable", "Required": false, "Type": "FixedResponseConfig" }, "AuthenticateCognitoConfig": { "MarkdownDocumentation": "`AuthenticateCognitoConfig`\n\n[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only\nwhen `Type` is `authenticate-cognito`.\n*Required*: No\n*Type*: [AuthenticateCognitoConfig](./aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-authenticatecognitoconfig", "UpdateType": "Mutable", "Required": false, "Type": "AuthenticateCognitoConfig" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of action.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `forward | authenticate-oidc...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "forward", "authenticate-oidc", "authenticate-cognito", "redirect", "fixed-response", "jwt-validation" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RedirectConfig": { "MarkdownDocumentation": "`RedirectConfig`\n\n[Application Load Balancer] Information for creating a redirect action. Specify only when\n`Type` is `redirect`.\n*Required*: No\n*Type*: [RedirectConfig](./aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-redirectconfig", "UpdateType": "Mutable", "Required": false, "Type": "RedirectConfig" }, "JwtValidationConfig": { "MarkdownDocumentation": "`JwtValidationConfig`\n\n[HTTPS listeners] Information for validating JWT access tokens in client requests.\nSpecify only when `Type` is `jwt-validation`.\n*Required*: No\n*Type*: [JwtValidationConfig](./aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-jwtvalidationconfig", "UpdateType": "Mutable", "Required": false, "Type": "JwtValidationConfig" }, "ForwardConfig": { "MarkdownDocumentation": "`ForwardConfig`\n\nInformation for creating an action that distributes requests among multiple target\ngroups. Specify only when `Type` is `forward`.\nIf you specify both `ForwardConfig` and `TargetGroupArn`, you can\nspecify only one target group using `ForwardConfig` and it must be the same\ntarget group specified in `TargetGroupArn`.\n*Required*: No\n*Type*: [ForwardConfig](./aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-forwardconfig", "UpdateType": "Mutable", "Required": false, "Type": "ForwardConfig" }, "AuthenticateOidcConfig": { "MarkdownDocumentation": "`AuthenticateOidcConfig`\n\n[HTTPS listeners] Information about an identity provider that is compliant with OpenID\nConnect (OIDC). Specify only when `Type` is `authenticate-oidc`.\n*Required*: No\n*Type*: [AuthenticateOidcConfig](./aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-action.html#cfn-elasticloadbalancingv2-listenerrule-action-authenticateoidcconfig", "UpdateType": "Mutable", "Required": false, "Type": "AuthenticateOidcConfig" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig`\n\nSpecifies information required when integrating with Amazon Cognito to authenticate\nusers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html", "Properties": { "OnUnauthenticatedRequest": { "MarkdownDocumentation": "`OnUnauthenticatedRequest`\n\nThe 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\n the default value.\n*Required*: No\n*Type*: String\n*Allowed values*: `deny | allow | authenticate...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "deny", "allow", "authenticate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-onunauthenticatedrequest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserPoolClientId": { "MarkdownDocumentation": "`UserPoolClientId`\n\nThe ID of the Amazon Cognito user pool 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpoolclientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UserPoolDomain": { "MarkdownDocumentation": "`UserPoolDomain`\n\nThe domain prefix or fully-qualified domain name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpooldomain", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SessionTimeout": { "MarkdownDocumentation": "`SessionTimeout`\n\nThe maximum duration of the authentication session, in seconds. The default is 604800\nseconds (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-sessiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe set of user claims to be requested from the IdP. The default is\n`openid`.\nTo verify which scope values your IdP supports and how to separate multiple values, see\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SessionCookieName": { "MarkdownDocumentation": "`SessionCookieName`\n\nThe name of the cookie used to maintain session information. The default is\nAWSELBAuthSessionCookie.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-sessioncookiename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserPoolArn": { "MarkdownDocumentation": "`UserPoolArn`\n\nThe Amazon Resource Name (ARN) of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpoolarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthenticationRequestExtraParams": { "MarkdownDocumentation": "`AuthenticationRequestExtraParams`\n\nThe query parameters (up to 10) to include in the redirect request to the authorization\nendpoint.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-authenticationrequestextraparams", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig`\n\nSpecifies information required using an identity provide (IdP) that is compliant with\nOpenID Connect (OIDC) to authenticate users.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html", "Properties": { "OnUnauthenticatedRequest": { "MarkdownDocumentation": "`OnUnauthenticatedRequest`\n\nThe 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\n the default value.\n*Required*: No\n*Type*: String\n*Allowed values*: `deny | allow | authenticate...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "deny", "allow", "authenticate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-onunauthenticatedrequest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TokenEndpoint": { "MarkdownDocumentation": "`TokenEndpoint`\n\nThe token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the\ndomain, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-tokenendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UseExistingClientSecret": { "MarkdownDocumentation": "`UseExistingClientSecret`\n\nIndicates whether to use the existing client secret when modifying a rule. If you are\ncreating 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-useexistingclientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SessionTimeout": { "MarkdownDocumentation": "`SessionTimeout`\n\nThe maximum duration of the authentication session, in seconds. The default is 604800\nseconds (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe set of user claims to be requested from the IdP. The default is\n`openid`.\nTo verify which scope values your IdP supports and how to separate multiple values, see\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nThe OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS\nprotocol, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-issuer", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you\nare modifying a rule, you can omit this parameter if you set\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientsecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserInfoEndpoint": { "MarkdownDocumentation": "`UserInfoEndpoint`\n\nThe user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol,\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-userinfoendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthorizationEndpoint": { "MarkdownDocumentation": "`AuthorizationEndpoint`\n\nThe authorization endpoint of the IdP. This must be a full URL, including the HTTPS\nprotocol, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authorizationendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SessionCookieName": { "MarkdownDocumentation": "`SessionCookieName`\n\nThe name of the cookie used to maintain session information. The default is\nAWSELBAuthSessionCookie.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessioncookiename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthenticationRequestExtraParams": { "MarkdownDocumentation": "`AuthenticationRequestExtraParams`\n\nThe query parameters (up to 10) to include in the redirect request to the authorization\nendpoint.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authenticationrequestextraparams", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig`\n\nSpecifies information required when returning a custom HTTP response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html", "Properties": { "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe content type.\nValid Values: text/plain | text/css | text/html | application/javascript |\napplication/json\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe HTTP response code (2XX, 4XX, or 5XX).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(2|4|5)\\d\\d$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-statuscode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MessageBody": { "MarkdownDocumentation": "`MessageBody`\n\nThe message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-messagebody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig`\n\nInformation for creating an action that distributes requests among multiple target\ngroups. Specify only when `Type` is `forward`.\nIf you specify both `ForwardConfig` and `TargetGroupArn`, you can\nspecify only one target group using `ForwardConfig` and it must be the same\ntarget group specified in `TargetGroupArn`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html", "Properties": { "TargetGroupStickinessConfig": { "MarkdownDocumentation": "`TargetGroupStickinessConfig`\n\nInformation about the target group stickiness for a rule.\n*Required*: No\n*Type*: [TargetGroupStickinessConfig](./aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html#cfn-elasticloadbalancingv2-listenerrule-forwardconfig-targetgroupstickinessconfig", "UpdateType": "Mutable", "Required": false, "Type": "TargetGroupStickinessConfig" }, "TargetGroups": { "MarkdownDocumentation": "`TargetGroups`\n\nInformation about how traffic will be distributed between multiple target groups in a\nforward rule.\n*Required*: No\n*Type*: Array of [TargetGroupTuple](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-forwardconfig.html#cfn-elasticloadbalancingv2-listenerrule-forwardconfig-targetgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetGroupTuple", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig`\n\nInformation about a host header condition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-hostheaderconfig.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe host names. The maximum length of each string is 128 characters. The comparison is\ncase insensitive. The following wildcard characters are supported: \\* (matches 0 or more\ncharacters) and ? (matches exactly 1 character). You must include at least one \".\"\ncharacter. You can include only alphabetical characters after the final \".\" character.\nIf you specify multiple strings, the condition is satisfied if one of the strings matches\nthe host name.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-hostheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-hostheaderconfig-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "RegexValues": { "MarkdownDocumentation": "`RegexValues`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-hostheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-hostheaderconfig-regexvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig`\n\nInformation about an HTTP header condition.\nThere is a set of standard HTTP header fields. You can also define custom HTTP header\nfields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe strings to compare against the value of the HTTP header. The maximum length of\neach string is 128 characters. The comparison strings are case insensitive. The following\nwildcard characters are supported: \\* (matches 0 or more characters) and ? (matches exactly 1\ncharacter).\nIf the same header appears multiple times in the request, we search them in order until a\nmatch is found.\nIf you specify multiple strings, the condition is satisfied if one of the strings matches\nthe value of the HTTP header. To require that all of the strings are a match, create one\ncondition per string.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-httpheaderconfig-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "RegexValues": { "MarkdownDocumentation": "`RegexValues`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-httpheaderconfig-regexvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HttpHeaderName": { "MarkdownDocumentation": "`HttpHeaderName`\n\nThe name of the HTTP header field. The maximum size is 40 characters. The header name is\ncase insensitive. The allowed characters are specified by RFC 7230. Wildcards are not\nsupported.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html#cfn-elasticloadbalancingv2-listenerrule-httpheaderconfig-httpheadername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig`\n\nInformation about an HTTP method condition.\nHTTP defines a set of request methods, also referred to as HTTP verbs. For more\ninformation, see the [HTTP Method\nRegistry](https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also define custom HTTP methods.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httprequestmethodconfig.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe name of the request method. The maximum length is 40 characters. The allowed characters\nare A-Z, hyphen (-), and underscore (\\_). The comparison is case sensitive. Wildcards are not\nsupported; therefore, the method name must be an exact match.\nIf you specify multiple strings, the condition is satisfied if one of the strings matches\nthe HTTP request method. We recommend that you route GET and HEAD requests in the same way,\nbecause the response to a HEAD request may be cached.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-httprequestmethodconfig.html#cfn-elasticloadbalancingv2-listenerrule-httprequestmethodconfig-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.JwtValidationActionAdditionalClaim": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.JwtValidationActionAdditionalClaim`\n\nInformation about an additional claim to validate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationactionadditionalclaim.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe format of the claim value.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `single-string | string-arra...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "single-string", "string-array", "space-separated-values" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationactionadditionalclaim.html#cfn-elasticloadbalancingv2-listenerrule-jwtvalidationactionadditionalclaim-format", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe claim value. The maximum size of the list is 10.\nEach value can be up to 256 characters in length.\nIf the format is `space-separated-values`, the values\ncan't include spaces.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationactionadditionalclaim.html#cfn-elasticloadbalancingv2-listenerrule-jwtvalidationactionadditionalclaim-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the claim. You can't specify `exp`, `iss`,\n`nbf`, or `iat` because we validate them by default.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationactionadditionalclaim.html#cfn-elasticloadbalancingv2-listenerrule-jwtvalidationactionadditionalclaim-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.JwtValidationConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.JwtValidationConfig`\n\nThe `JwtValidationConfig` property type specifies Property description not available. for an [AWS::ElasticLoadBalancingV2::ListenerRule](./aws-resource-elasticloadbalancingv2-listenerrule.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationconfig.html", "Properties": { "JwksEndpoint": { "MarkdownDocumentation": "`JwksEndpoint`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationconfig.html#cfn-elasticloadbalancingv2-listenerrule-jwtvalidationconfig-jwksendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationconfig.html#cfn-elasticloadbalancingv2-listenerrule-jwtvalidationconfig-issuer", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AdditionalClaims": { "MarkdownDocumentation": "`AdditionalClaims`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [JwtValidationActionAdditionalClaim](./aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationactionadditionalclaim.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-jwtvalidationconfig.html#cfn-elasticloadbalancingv2-listenerrule-jwtvalidationconfig-additionalclaims", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "JwtValidationActionAdditionalClaim", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig`\n\nInformation about a path pattern condition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-pathpatternconfig.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe path patterns to compare against the request URL. The maximum size of each\nstring is 128 characters. The comparison is case sensitive. The following wildcard\ncharacters are supported: \\* (matches 0 or more characters) and ? (matches exactly 1\ncharacter).\nIf you specify multiple strings, the condition is satisfied if one of them matches the\nrequest URL. The path pattern is compared only to the path of the URL, not to its query\nstring.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-pathpatternconfig.html#cfn-elasticloadbalancingv2-listenerrule-pathpatternconfig-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "RegexValues": { "MarkdownDocumentation": "`RegexValues`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-pathpatternconfig.html#cfn-elasticloadbalancingv2-listenerrule-pathpatternconfig-regexvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig`\n\nInformation about a query string condition.\nThe query string component of a URI starts after the first '?' character and is terminated\nby either a '#' character or the end of the URI. A typical query string contains key/value\npairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any\ncharacter can be percentage encoded.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringconfig.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe key/value pairs or values to find in the query string. The maximum length of\neach string is 128 characters. The comparison is case insensitive. The following wildcard\ncharacters are supported: \\* (matches 0 or more characters) and ? (matches exactly 1\ncharacter). To search for a literal '\\*' or '?' character in a query string, you must escape\nthese characters in `Values` using a '\\' character.\nIf you specify multiple key/value pairs or values, the condition is satisfied if one of\nthem is found in the query string.\n*Required*: No\n*Type*: Array of [QueryStringKeyValue](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringconfig.html#cfn-elasticloadbalancingv2-listenerrule-querystringconfig-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "QueryStringKeyValue", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue`\n\nInformation about a key/value pair.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html#cfn-elasticloadbalancingv2-listenerrule-querystringkeyvalue-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html#cfn-elasticloadbalancingv2-listenerrule-querystringkeyvalue-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig`\n\nInformation about a redirect action.\nA URI consists of the following components: protocol://hostname:port/path?query. You must\nmodify at least one of the following components to avoid a redirect loop: protocol, hostname,\nport, or path. Any components that you do not modify retain their original values.\nYou can reuse URI components using the following reserved keywords:\n* #{protocol}\n* #{host}\n* #{port}\n* #{path} (the leading \"/\" is removed)\n* #{query}\nFor example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\",\nor the query to \"#{query}&value=xyz\".\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe absolute path, starting with the leading \"/\". This component is not percent-encoded.\nThe path can contain #{host}, #{path}, and #{port}.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Query": { "MarkdownDocumentation": "`Query`\n\nThe query parameters, URL-encoded when necessary, but not percent-encoded. Do not include\nthe leading \"?\", as it is automatically added. You can specify any of the reserved\nkeywords.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-query", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port. You can specify a value from 1 to 65535 or #{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThe hostname. This component is not percent-encoded. The hostname can contain\n#{host}.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-host", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP,\nHTTP to HTTPS, and HTTPS to HTTPS. You can't redirect HTTPS to HTTP.\n*Required*: No\n*Type*: String\n*Pattern*: `^(HTTPS?|#\\{protocol\\})$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP\n302).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HTTP_301 | HTTP_302...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HTTP_301", "HTTP_302" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-statuscode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.RewriteConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.RewriteConfig`\n\nInformation about a rewrite transform. This transform matches a pattern and replaces it with the specified string.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rewriteconfig.html", "Properties": { "Replace": { "MarkdownDocumentation": "`Replace`\n\nThe replacement string to use when rewriting the matched input. The maximum length of the string is 1,024 characters.\nYou can specify capture groups in the regular expression (for example, $1 and $2).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rewriteconfig.html#cfn-elasticloadbalancingv2-listenerrule-rewriteconfig-replace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Regex": { "MarkdownDocumentation": "`Regex`\n\nThe regular expression to match in the input string. The maximum length of the string is 1,024 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rewriteconfig.html#cfn-elasticloadbalancingv2-listenerrule-rewriteconfig-regex", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.RewriteConfigObject": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.RewriteConfigObject`\n\nThe `RewriteConfigObject` property type specifies Property description not available. for an [AWS::ElasticLoadBalancingV2::ListenerRule](./aws-resource-elasticloadbalancingv2-listenerrule.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rewriteconfigobject.html", "Properties": { "Rewrites": { "MarkdownDocumentation": "`Rewrites`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [RewriteConfig](./aws-properties-elasticloadbalancingv2-listenerrule-rewriteconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rewriteconfigobject.html#cfn-elasticloadbalancingv2-listenerrule-rewriteconfigobject-rewrites", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RewriteConfig", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition`\n\nSpecifies a condition for a listener rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field in the HTTP request. The following are the possible values:\n* `http-header`\n* `http-request-method`\n* `host-header`\n* `path-pattern`\n* `query-string`\n* `source-ip`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpHeaderConfig": { "MarkdownDocumentation": "`HttpHeaderConfig`\n\nInformation for an HTTP header condition. Specify only when `Field` is\n`http-header`.\n*Required*: Conditional\n*Type*: [HttpHeaderConfig](./aws-properties-elasticloadbalancingv2-listenerrule-httpheaderconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-httpheaderconfig", "UpdateType": "Mutable", "Required": false, "Type": "HttpHeaderConfig" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe condition value. Specify only when `Field` is `host-header` or\n`path-pattern`. Alternatively, to specify multiple host names or multiple\npath patterns, use `HostHeaderConfig` or `PathPatternConfig`.\nIf `Field` is `host-header` and you're not using\n`HostHeaderConfig`, you can specify a single host name (for example,\nmy.example.com). A host name is case insensitive, can be up to 128 characters in length,\nand 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\n`PathPatternConfig`, you can specify a single path pattern (for example,\n/img/\\*). A path pattern is case-sensitive, can be up to 128 characters in length, and can\ncontain 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "QueryStringConfig": { "MarkdownDocumentation": "`QueryStringConfig`\n\nInformation for a query string condition. Specify only when `Field` is\n`query-string`.\n*Required*: Conditional\n*Type*: [QueryStringConfig](./aws-properties-elasticloadbalancingv2-listenerrule-querystringconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-querystringconfig", "UpdateType": "Mutable", "Required": false, "Type": "QueryStringConfig" }, "RegexValues": { "MarkdownDocumentation": "`RegexValues`\n\nThe regular expressions to match against the condition field. The maximum length of each string is 128 characters.\nSpecify only when `Field` is `http-header`, `host-header`, or `path-pattern`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-regexvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HostHeaderConfig": { "MarkdownDocumentation": "`HostHeaderConfig`\n\nInformation for a host header condition. Specify only when `Field` is\n`host-header`.\n*Required*: No\n*Type*: [HostHeaderConfig](./aws-properties-elasticloadbalancingv2-listenerrule-hostheaderconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-hostheaderconfig", "UpdateType": "Mutable", "Required": false, "Type": "HostHeaderConfig" }, "HttpRequestMethodConfig": { "MarkdownDocumentation": "`HttpRequestMethodConfig`\n\nInformation for an HTTP method condition. Specify only when `Field` is\n`http-request-method`.\n*Required*: Conditional\n*Type*: [HttpRequestMethodConfig](./aws-properties-elasticloadbalancingv2-listenerrule-httprequestmethodconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-httprequestmethodconfig", "UpdateType": "Mutable", "Required": false, "Type": "HttpRequestMethodConfig" }, "PathPatternConfig": { "MarkdownDocumentation": "`PathPatternConfig`\n\nInformation for a path pattern condition. Specify only when `Field` is\n`path-pattern`.\n*Required*: No\n*Type*: [PathPatternConfig](./aws-properties-elasticloadbalancingv2-listenerrule-pathpatternconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-pathpatternconfig", "UpdateType": "Mutable", "Required": false, "Type": "PathPatternConfig" }, "SourceIpConfig": { "MarkdownDocumentation": "`SourceIpConfig`\n\nInformation for a source IP condition. Specify only when `Field` is\n`source-ip`.\n*Required*: Conditional\n*Type*: [SourceIpConfig](./aws-properties-elasticloadbalancingv2-listenerrule-sourceipconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html#cfn-elasticloadbalancingv2-listenerrule-rulecondition-sourceipconfig", "UpdateType": "Mutable", "Required": false, "Type": "SourceIpConfig" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig`\n\nInformation about a source IP condition.\nYou can use this condition to route based on the IP address of the source that connects to\nthe load balancer. If a client is behind a proxy, this is the IP address of the proxy not the\nIP address of the client.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-sourceipconfig.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe source IP addresses, in CIDR format. You can use both IPv4 and IPv6\naddresses. Wildcards are not supported.\nIf you specify multiple addresses, the condition is satisfied if the source IP address\nof the request matches one of the CIDR blocks. This condition is not satisfied by the\naddresses in the X-Forwarded-For header.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-sourceipconfig.html#cfn-elasticloadbalancingv2-listenerrule-sourceipconfig-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig`\n\nInformation about the target group stickiness for a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether target group stickiness 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DurationSeconds": { "MarkdownDocumentation": "`DurationSeconds`\n\n[Application Load Balancers] The time period, in seconds, during which requests from a\nclient should be routed to the same target group. The range is 1-604800 seconds (7 days). You\nmust specify this value when enabling target group stickiness.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listenerrule-targetgroupstickinessconfig-durationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple`\n\nInformation about how traffic will be distributed between multiple target groups in a\nforward rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html", "Properties": { "TargetGroupArn": { "MarkdownDocumentation": "`TargetGroupArn`\n\nThe Amazon Resource Name (ARN) of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html#cfn-elasticloadbalancingv2-listenerrule-targetgrouptuple-targetgrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html#cfn-elasticloadbalancingv2-listenerrule-targetgrouptuple-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule.Transform": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule.Transform`\n\nThe `Transform` property type specifies Property description not available. for an [AWS::ElasticLoadBalancingV2::ListenerRule](./aws-resource-elasticloadbalancingv2-listenerrule.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-transform.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-transform.html#cfn-elasticloadbalancingv2-listenerrule-transform-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UrlRewriteConfig": { "MarkdownDocumentation": "`UrlRewriteConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [RewriteConfigObject](./aws-properties-elasticloadbalancingv2-listenerrule-rewriteconfigobject.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-transform.html#cfn-elasticloadbalancingv2-listenerrule-transform-urlrewriteconfig", "UpdateType": "Mutable", "Required": false, "Type": "RewriteConfigObject" }, "HostHeaderRewriteConfig": { "MarkdownDocumentation": "`HostHeaderRewriteConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [RewriteConfigObject](./aws-properties-elasticloadbalancingv2-listenerrule-rewriteconfigobject.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-transform.html#cfn-elasticloadbalancingv2-listenerrule-transform-hostheaderrewriteconfig", "UpdateType": "Mutable", "Required": false, "Type": "RewriteConfigObject" } } }, "AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute`\n\nSpecifies an attribute for an Application Load Balancer, a Network Load Balancer, or a\nGateway Load Balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattribute.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattribute.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattribute-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name of the attribute.\nThe following attributes are supported by all load balancers:\n* `deletion_protection.enabled` - Indicates whether deletion protection is\n enabled. The value is `true` or `false`. The default is\n `false`.\n* `load_balancing.cross_zone.enabled` - Indicates whether cross-zone load\n balancing is enabled. The possible values are `true` and `false`.\n The default for Network Load Balancers and Gateway Load Balancers is `false`.\n The default for Application Load Balancers is `true`, and can't be changed.\nThe following attributes are supported by both Application Load Balancers and Network Load\nBalancers:\n* `access_logs.s3.enabled` - Indicates whether access logs are enabled. The\n value is `true` or `false`. The default is\n `false`.\n* `access_logs.s3.bucket` - The name of the S3 bucket for the access logs.\n This attribute is required if access logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.\n* `access_logs.s3.prefix` - The prefix for the location in the S3 bucket for the\n access logs.\n* `ipv6.deny_all_igw_traffic` - Blocks internet gateway (IGW) access to the\n load balancer. It is set to `false` for internet-facing load balancers and\n `true` for internal load balancers, preventing unintended access to your\n internal load balancer through an internet gateway.\n* `zonal_shift.config.enabled` - Indicates whether zonal shift is\n enabled. The possible values are `true` and `false`. The\n default is `false`.\nThe following attributes are supported by only Application Load Balancers:\n* `idle_timeout.timeout_seconds` - The idle timeout value, in seconds. The\n valid range is 1-4000 seconds. The default is 60 seconds.\n* `client_keep_alive.seconds` - The client keep alive value, in seconds. The\n valid range is 60-604800 seconds. The default is 3600 seconds.\n* `connection_logs.s3.enabled` - Indicates whether connection logs are enabled. The\n value is `true` or `false`. The default is `false`.\n* `connection_logs.s3.bucket` - The name of the S3 bucket for the connection logs.\n This attribute is required if connection logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.\n* `connection_logs.s3.prefix` - The prefix for the location in the S3 bucket for the\n connection logs.\n* `health_check_logs.s3.enabled` - Indicates whether health check logs are enabled. The\n value is `true` or `false`. The default is `false`.\n* `health_check_logs.s3.bucket` - The name of the S3 bucket for the health check logs.\n This attribute is required if health check logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.\n* `health_check_logs.s3.prefix` - The prefix for the location in the S3 bucket for the\n health check logs.\n* `routing.http.desync_mitigation_mode` - Determines how the load balancer\n handles requests that might pose a security risk to your application. The possible values\n are `monitor`, `defensive`, and `strictest`. The default\n is `defensive`.\n* `routing.http.drop_invalid_header_fields.enabled` - Indicates whether HTTP\n headers with invalid header fields are removed by the load balancer (`true`) or\n routed to targets (`false`). The default is `false`.\n* `routing.http.preserve_host_header.enabled` - Indicates whether the\n Application Load Balancer should preserve the `Host` header in the HTTP request\n and send it to the target without any change. The possible values are `true`\n and `false`. The default is `false`.\n* `routing.http.x_amzn_tls_version_and_cipher_suite.enabled` - Indicates\n whether the two headers (`x-amzn-tls-version` and\n `x-amzn-tls-cipher-suite`), which contain information about the negotiated\n TLS version and cipher suite, are added to the client request before sending it to the\n target. The `x-amzn-tls-version` header has information about the TLS protocol\n version negotiated with the client, and the `x-amzn-tls-cipher-suite` header\n has information about the cipher suite negotiated with the client. Both headers are in\n OpenSSL format. The possible values for the attribute are `true` and\n `false`. The default is `false`.\n* `routing.http.xff_client_port.enabled` - Indicates whether the\n `X-Forwarded-For` header should preserve the source port that the client used\n to connect to the load balancer. The possible values are `true` and\n `false`. The default is `false`.\n* `routing.http.xff_header_processing.mode` - Enables you to modify,\n preserve, or remove the `X-Forwarded-For` header in the HTTP request before the\n Application Load Balancer sends the request to the target. The possible values are\n `append`, `preserve`, and `remove`. The default is\n `append`.\n \n + If the value is `append`, the Application Load Balancer adds the client\n IP address (of the last hop) to the `X-Forwarded-For` header in the HTTP\n request before it sends it to targets.\n + If the value is `preserve` the Application Load Balancer preserves the\n `X-Forwarded-For` header in the HTTP request, and sends it to targets\n without any change.\n + If the value is `remove`, the Application Load Balancer removes the\n `X-Forwarded-For` header in the HTTP request before it sends it to\n targets.\n* `routing.http2.enabled` - Indicates whether clients can connect to the load\n balancer using HTTP/2. If `true`, clients can connect using HTTP/2 or HTTP/1.1.\n However, all client requests are subject to the stricter HTTP/2 header validation rules.\n For example, message header names must contain only alphanumeric characters and hyphens.\n If `false`, clients must connect using HTTP/1.1. The default is\n `true`.\n* `waf.fail_open.enabled` - Indicates whether to allow a WAF-enabled load\n 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\n default is `false`.\nThe following attributes are supported by only Network Load Balancers:\n* `dns_record.client_routing_policy` - Indicates how traffic is\n distributed among the load balancer Availability Zones. The possible values are\n `availability_zone_affinity` with 100 percent zonal affinity,\n `partial_availability_zone_affinity` with 85 percent zonal affinity,\n and `any_availability_zone` with 0 percent zonal affinity.\n* `secondary_ips.auto_assigned.per_subnet` - The number of secondary\n IP addresses to configure for your load balancer nodes. Use to address port\n allocation errors if you can't add targets. The valid range is 0 to 7. The\n default is 0. After you set this value, you can't decrease it.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattribute.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattribute-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::LoadBalancer.MinimumLoadBalancerCapacity": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::LoadBalancer.MinimumLoadBalancerCapacity`\n\nThe minimum capacity for a load balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-minimumloadbalancercapacity.html", "Properties": { "CapacityUnits": { "MarkdownDocumentation": "`CapacityUnits`\n\nThe number of capacity 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-minimumloadbalancercapacity.html#cfn-elasticloadbalancingv2-loadbalancer-minimumloadbalancercapacity-capacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping`\n\nSpecifies a subnet for a load balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html", "Properties": { "AllocationId": { "MarkdownDocumentation": "`AllocationId`\n\n[Network Load Balancers] The allocation ID of the Elastic IP address for an\ninternet-facing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-allocationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IPv6Address": { "MarkdownDocumentation": "`IPv6Address`\n\n[Network Load Balancers] The IPv6 address.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-ipv6address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-subnetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceNatIpv6Prefix": { "MarkdownDocumentation": "`SourceNatIpv6Prefix`\n\n[Network Load Balancers with UDP listeners] The IPv6 prefix to use for source NAT.\nSpecify an IPv6 prefix (/80 netmask) from the subnet CIDR block or `auto_assigned`\nto use an IPv6 prefix selected at random from the subnet CIDR block.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-sourcenatipv6prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateIPv4Address": { "MarkdownDocumentation": "`PrivateIPv4Address`\n\n[Network Load Balancers] The private IPv4 address for an internal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-privateipv4address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::TargetGroup.Matcher": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::TargetGroup.Matcher`\n\nSpecifies the HTTP codes that healthy targets must use when responding to an HTTP health\ncheck.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html", "Properties": { "GrpcCode": { "MarkdownDocumentation": "`GrpcCode`\n\nYou can specify values between 0 and 99. You can specify multiple values (for example,\n\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html#cfn-elasticloadbalancingv2-targetgroup-matcher-grpccode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpCode": { "MarkdownDocumentation": "`HttpCode`\n\nFor Application Load Balancers, you can specify values between 200 and 499, with the\ndefault 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\ndefault 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\nescaped.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html#cfn-elasticloadbalancingv2-targetgroup-matcher-httpcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription`\n\nSpecifies a target to add to a target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html", "Properties": { "QuicServerId": { "MarkdownDocumentation": "`QuicServerId`\n\nThe server ID for the targets. This value is required if the protocol is\n`QUIC` or `TCP_QUIC` and can't be used with other protocols.\nThe ID consists of the `0x` prefix followed by 16 hexadecimal characters.\nAny letters must be lowercase. The value must be unique at the listener level. You can't\nmodify the server ID for a registered target. You must deregister the target and then\nprovide a new server ID when you register the target again.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-quicserverid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port on which the target is listening. If the target group protocol is GENEVE, the\nsupported port is 6081. If the target type is `alb`, the targeted Application Load\nBalancer must have at least one listener whose port matches the target group port. This\nparameter is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nAn Availability Zone or `all`. This determines whether the target receives\ntraffic from the load balancer nodes in the specified Availability Zone or from all enabled\nAvailability Zones for the load balancer.\nFor Application Load Balancer target groups, the specified Availability Zone value is only applicable\nwhen cross-zone load balancing is off. Otherwise the parameter is ignored and treated\nas `all`.\nThis parameter is not supported if the target type of the target group is\n`instance` or `alb`.\nIf the target type is `ip` and the IP address is in a subnet of the VPC for the target group,\nthe Availability Zone is automatically detected and this parameter is optional. If the IP address is outside\nthe VPC, this parameter is required.\nFor Application Load Balancer target groups with cross-zone load balancing off, if the target type\nis `ip` and the IP address is outside of the VPC for the target group, this should be an\nAvailability Zone inside the VPC for the target group.\nIf the target type is `lambda`, this parameter is optional and the only\nsupported 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the target. If the target type of the target group is `instance`,\nspecify an instance ID. If the target type is `ip`, specify an IP address. If the\ntarget type is `lambda`, specify the ARN of the Lambda function. If the target type\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute`\n\nSpecifies a target group attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name of the attribute.\nThe following attributes are supported by all load balancers:\n* `deregistration_delay.timeout_seconds` - The amount of time, in seconds,\n for Elastic Load Balancing to wait before changing the state of a deregistering target\n from `draining` to `unused`. The range is 0-3600 seconds. The\n default value is 300 seconds. If the target is a Lambda function, this attribute is not\n supported.\n* `stickiness.enabled` - Indicates whether target stickiness is enabled. The\n value is `true` or `false`. The default is\n `false`.\n* `stickiness.type` - Indicates the type of stickiness. The possible values are:\n \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\nNetwork Load Balancers:\n* `load_balancing.cross_zone.enabled` - Indicates whether cross zone load\n balancing is enabled. The value is `true`, `false` or\n `use_load_balancer_configuration`. The default is\n `use_load_balancer_configuration`.\n* `target_group_health.dns_failover.minimum_healthy_targets.count` -\n The minimum number of targets that must be healthy.\n If the number of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n `off` or an integer from 1 to the maximum number of targets.\n The default is 1.\n* `target_group_health.dns_failover.minimum_healthy_targets.percentage` -\n The minimum percentage of targets that must be healthy.\n If the percentage of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n `off` or an integer from 1 to 100. The default is `off`.\n* `target_group_health.unhealthy_state_routing.minimum_healthy_targets.count` -\n The minimum number of targets that must be healthy.\n If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n 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` -\n The minimum percentage of targets that must be healthy.\n If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are `off` or an integer from 1 to 100.\n The default is `off`.\nThe following attributes are supported only if the load balancer is an Application Load\nBalancer and the target is an instance or an IP address:\n* `load_balancing.algorithm.type` - The load balancing algorithm determines\n how the load balancer selects targets when routing requests. The value is\n `round_robin`, `least_outstanding_requests`, or `weighted_random`. The default is\n `round_robin`.\n* `load_balancing.algorithm.anomaly_mitigation` - Only available when `load_balancing.algorithm.type`\n is `weighted_random`. Indicates whether anomaly mitigation is enabled. The value is `on`\n or `off`. The default is `off`.\n* `slow_start.duration_seconds` - The time period, in seconds, during which a\n newly registered target receives an increasing share of the traffic to the target group.\n After this time period ends, the target receives its full share of traffic. The range is\n 30-900 seconds (15 minutes). The default is 0 seconds (disabled).\n* `stickiness.app_cookie.cookie_name` - Indicates the name of the\n application-based cookie. Names that start with the following prefixes are not allowed:\n `AWSALB`, `AWSALBAPP`, and `AWSALBTG`; they're reserved\n for use by the load balancer.\n* `stickiness.app_cookie.duration_seconds` - The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the application-based cookie is considered stale. The range is 1 second to\n 1 week (604800 seconds). The default value is 1 day (86400 seconds).\n* `stickiness.lb_cookie.duration_seconds` - The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the load balancer-generated cookie is considered stale. The range is 1\n 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\nBalancer and the target is a Lambda function:\n* `lambda.multi_value_headers.enabled` - Indicates whether the request and\n response headers that are exchanged between the load balancer and the Lambda function\n include arrays of values or strings. The value is `true` or `false`.\n The default is `false`. If the value is `false` and the request\n contains a duplicate header field name or query parameter key, the load balancer uses the\n last value sent by the client.\nThe following attributes are supported only by Network Load Balancers:\n* `deregistration_delay.connection_termination.enabled` - Indicates whether\n the load balancer terminates connections at the end of the deregistration timeout. The\n value is `true` or `false`. For new UDP/TCP\\_UDP target groups the\n default is `true`. Otherwise, the default is `false`.\n* `preserve_client_ip.enabled` - Indicates whether client IP preservation is\n enabled. The value is `true` or `false`. The default is disabled if\n the target group type is IP address and the target group protocol is TCP or TLS.\n Otherwise, the default is enabled. Client IP preservation can't be disabled for UDP and\n TCP\\_UDP target groups.\n* `proxy_protocol_v2.enabled` - Indicates whether Proxy Protocol version 2 is\n enabled. The value is `true` or `false`. The default is\n `false`.\n* `target_health_state.unhealthy.connection_termination.enabled` - Indicates whether\n the load balancer terminates connections to unhealthy targets. The value is `true`\n or `false`. The default is `true`. This attribute can't be enabled for UDP and\n TCP\\_UDP target groups.\n* `target_health_state.unhealthy.draining_interval_seconds` - The amount of time\n for Elastic Load Balancing to wait before changing the state of an unhealthy target from\n `unhealthy.draining` to `unhealthy`. The range is 0-360000 seconds.\n The default value is 0 seconds.\n \n Note: This attribute can only be configured when\n `target_health_state.unhealthy.connection_termination.enabled` is `false`.\nThe following attributes are supported only by Gateway Load Balancers:\n* `target_failover.on_deregistration` - Indicates how the Gateway Load\n Balancer handles existing flows when a target is deregistered. The possible values are\n `rebalance` and `no_rebalance`. The default is\n `no_rebalance`. The two attributes\n (`target_failover.on_deregistration` and\n `target_failover.on_unhealthy`) can't be set independently. The value you set\n for both attributes must be the same.\n* `target_failover.on_unhealthy` - Indicates how the Gateway Load Balancer\n handles existing flows when a target is unhealthy. The possible values are\n `rebalance` and `no_rebalance`. The default is\n `no_rebalance`. The two attributes\n (`target_failover.on_deregistration` and\n `target_failover.on_unhealthy`) can't be set independently. The value you\n set for both attributes must be the same.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::TrustStoreRevocation.RevocationContent": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::TrustStoreRevocation.RevocationContent`\n\nInformation about a revocation file. You must specify `S3Bucket` and `S3Key`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-revocationcontent.html", "Properties": { "S3ObjectVersion": { "MarkdownDocumentation": "`S3ObjectVersion`\n\nThe Amazon S3 object version of the revocation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-revocationcontent.html#cfn-elasticloadbalancingv2-truststorerevocation-revocationcontent-s3objectversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nThe Amazon S3 bucket for the revocation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-revocationcontent.html#cfn-elasticloadbalancingv2-truststorerevocation-revocationcontent-s3bucket", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "S3Key": { "MarkdownDocumentation": "`S3Key`\n\nThe Amazon S3 path for the revocation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-revocationcontent.html#cfn-elasticloadbalancingv2-truststorerevocation-revocationcontent-s3key", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RevocationType": { "MarkdownDocumentation": "`RevocationType`\n\nThe type of revocation file.\n*Required*: No\n*Type*: String\n*Allowed values*: `CRL`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "CRL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-revocationcontent.html#cfn-elasticloadbalancingv2-truststorerevocation-revocationcontent-revocationtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ElasticLoadBalancingV2::TrustStoreRevocation.TrustStoreRevocation": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::TrustStoreRevocation.TrustStoreRevocation`\n\nInformation about a revocation file in use by a trust store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-truststorerevocation.html", "Properties": { "NumberOfRevokedEntries": { "MarkdownDocumentation": "`NumberOfRevokedEntries`\n\nThe number of revoked certificates.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-truststorerevocation.html#cfn-elasticloadbalancingv2-truststorerevocation-truststorerevocation-numberofrevokedentries", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "TrustStoreArn": { "MarkdownDocumentation": "`TrustStoreArn`\n\nThe Amazon Resource Name (ARN) of the trust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-truststorerevocation.html#cfn-elasticloadbalancingv2-truststorerevocation-truststorerevocation-truststorearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RevocationType": { "MarkdownDocumentation": "`RevocationType`\n\nThe type of revocation file.\n*Required*: No\n*Type*: String\n*Allowed values*: `CRL`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "CRL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-truststorerevocation.html#cfn-elasticloadbalancingv2-truststorerevocation-truststorerevocation-revocationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RevocationId": { "MarkdownDocumentation": "`RevocationId`\n\nThe revocation ID of the revocation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-truststorerevocation-truststorerevocation.html#cfn-elasticloadbalancingv2-truststorerevocation-truststorerevocation-revocationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Elasticsearch::Domain.AdvancedSecurityOptionsInput": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.AdvancedSecurityOptionsInput`\n\nSpecifies options for fine-grained access control.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html", "Properties": { "AnonymousAuthEnabled": { "MarkdownDocumentation": "`AnonymousAuthEnabled`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-anonymousauthenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nTrue to enable fine-grained access control. You must also enable encryption of data at rest\nand node-to-node encryption.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-enabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" }, "InternalUserDatabaseEnabled": { "MarkdownDocumentation": "`InternalUserDatabaseEnabled`\n\nTrue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-internaluserdatabaseenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "MasterUserOptions": { "MarkdownDocumentation": "`MasterUserOptions`\n\nSpecifies information about the master user.\n*Required*: No\n*Type*: [MasterUserOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html#cfn-elasticsearch-domain-advancedsecurityoptionsinput-masteruseroptions", "Required": false, "Type": "MasterUserOptions", "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.CognitoOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.CognitoOptions`\n\nConfigures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. See [Amazon\nCognito 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-enabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "IdentityPoolId": { "MarkdownDocumentation": "`IdentityPoolId`\n\nThe Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch\nDashboards 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-identitypoolid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe `AmazonESCognitoAccess` role that allows OpenSearch Service to configure\nyour user pool and identity pool. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-rolearn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch\nDashboards 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-userpoolid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.ColdStorageOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.ColdStorageOptions`\n\nSpecifies options for cold storage. For more information, see [Cold storage for Amazon\nElasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/cold-storage.html).\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-coldstorageoptions.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-coldstorageoptions.html#cfn-elasticsearch-domain-coldstorageoptions-enabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.DomainEndpointOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.DomainEndpointOptions`\n\nSpecifies 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###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html", "Properties": { "CustomEndpoint": { "MarkdownDocumentation": "`CustomEndpoint`\n\nThe fully qualified URL for your custom endpoint. Required if you enabled a custom endpoint\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpoint", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CustomEndpointCertificateArn": { "MarkdownDocumentation": "`CustomEndpointCertificateArn`\n\nThe AWS Certificate Manager ARN for your domain's SSL/TLS certificate. Required if you\nenabled 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointcertificatearn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CustomEndpointEnabled": { "MarkdownDocumentation": "`CustomEndpointEnabled`\n\nTrue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "EnforceHTTPS": { "MarkdownDocumentation": "`EnforceHTTPS`\n\nTrue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-enforcehttps", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "TLSSecurityPolicy": { "MarkdownDocumentation": "`TLSSecurityPolicy`\n\nThe minimum TLS version required for traffic to the domain. Valid values are TLS 1.3 (recommended) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-tlssecuritypolicy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.EBSOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.EBSOptions`\n\nThe configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to\ndata 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\nGuide*.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html", "Properties": { "EBSEnabled": { "MarkdownDocumentation": "`EBSEnabled`\n\nSpecifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service\ndomain.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-ebsenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS) that the volume supports. This property\napplies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-iops", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nThe size (in GiB) of the EBS volume for each data node. The minimum and maximum size of an\nEBS volume depends on the EBS volume type and the instance type to which it is attached. For\nmore information, see [EBS volume size\nlimits](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or\nio1. For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.ElasticsearchClusterConfig": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.ElasticsearchClusterConfig`\n\nThe cluster configuration for the OpenSearch Service domain. You can specify options such\nas the instance type and the number of instances. For more information, see [Creating and managing Amazon OpenSearch Service domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) in the *Amazon\nOpenSearch Service Developer Guide*.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html", "Properties": { "ColdStorageOptions": { "MarkdownDocumentation": "`ColdStorageOptions`\n\nSpecifies cold storage options for the domain.\n*Required*: No\n*Type*: [ColdStorageOptions](./aws-properties-elasticsearch-domain-coldstorageoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-coldstorageoptions", "Required": false, "Type": "ColdStorageOptions", "UpdateType": "Mutable" }, "DedicatedMasterCount": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastercount", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "DedicatedMasterEnabled": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmasterenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "DedicatedMasterType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastertype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "InstanceCount": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instancecount", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "InstanceType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instnacetype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "WarmCount": { "MarkdownDocumentation": "`WarmCount`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmcount", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "WarmEnabled": { "MarkdownDocumentation": "`WarmEnabled`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "WarmType": { "MarkdownDocumentation": "`WarmType`\n\nThe instance type for the cluster's warm nodes. Required if you enable warm\nstorage.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-warmtype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ZoneAwarenessConfig": { "MarkdownDocumentation": "`ZoneAwarenessConfig`\n\nSpecifies zone awareness configuration options. Only use if\n`ZoneAwarenessEnabled` is `true`.\n*Required*: Conditional\n*Type*: [ZoneAwarenessConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-zoneawarenessconfig", "Required": false, "Type": "ZoneAwarenessConfig", "UpdateType": "Mutable" }, "ZoneAwarenessEnabled": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-zoneawarenessenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.EncryptionAtRestOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.EncryptionAtRestOptions`\n\nWhether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecify `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-enabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Conditional" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe KMS key ID. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`. Required\nif 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-kmskeyid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" } } }, "AWS::Elasticsearch::Domain.LogPublishingOption": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.LogPublishingOption`\n\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\nSpecifies whether the OpenSearch Service domain publishes the Elasticsearch application,\nsearch slow logs, or index slow logs to Amazon CloudWatch. Each option must be an object of\nname `SEARCH_SLOW_LOGS`, `ES_APPLICATION_LOGS`,\n`INDEX_SLOW_LOGS`, or `AUDIT_LOGS` depending on the type of logs you\nwant to publish.\nIf you enable a slow log, you still have to enable the *collection* of\nslow logs using the Configuration API. To learn more, see [Enabling log publishing (AWS CLI)](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html#createdomain-configure-slow-logs-cli).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html", "Properties": { "CloudWatchLogsLogGroupArn": { "MarkdownDocumentation": "`CloudWatchLogsLogGroupArn`\n\nSpecifies the CloudWatch log group to publish to. Required if you enable log publishing\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-cloudwatchlogsloggrouparn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIf `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-domain-logpublishingoption-enabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.MasterUserOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.MasterUserOptions`\n\nSpecifies information about the master user. Required if you enabled the internal user\ndatabase.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html", "Properties": { "MasterUserARN": { "MarkdownDocumentation": "`MasterUserARN`\n\nARN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masteruserarn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "MasterUserName": { "MarkdownDocumentation": "`MasterUserName`\n\nUsername 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masterusername", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "MasterUserPassword": { "MarkdownDocumentation": "`MasterUserPassword`\n\nPassword 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html#cfn-elasticsearch-domain-masteruseroptions-masteruserpassword", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions`\n\nSpecifies whether node-to-node encryption is enabled.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether node-to-node encryption is enabled, as a Boolean.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions-enabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Conditional" } } }, "AWS::Elasticsearch::Domain.SnapshotOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.SnapshotOptions`\n\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n**DEPRECATED**. For domains running Elasticsearch 5.3 and\nlater, OpenSearch Service takes hourly automated snapshots, making this setting irrelevant. For domains\nrunning earlier versions of Elasticsearch, OpenSearch Service takes daily automated snapshots.\nThe automated snapshot configuration for the OpenSearch Service domain indices.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html", "Properties": { "AutomatedSnapshotStartHour": { "MarkdownDocumentation": "`AutomatedSnapshotStartHour`\n\nThe hour in UTC during which the service takes an automated daily snapshot of the indices\nin the OpenSearch Service domain. For example, if you specify 0, OpenSearch Service takes an automated snapshot\neveryday 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.VPCOptions": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.VPCOptions`\n\nThe virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more\ninformation, see [Launching your Amazon OpenSearch\nService domains using a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer\nGuide*.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html", "Properties": { "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe list of security group IDs that are associated with the VPC endpoints for the domain.\nIf you don't provide a security group ID, OpenSearch Service uses the default security group\nfor the VPC. To learn more, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in\nthe *Amazon VPC User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-securitygroupids", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nProvide one subnet ID for each Availability Zone that your domain uses. For example, you\nmust 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\nthe *Amazon VPC User Guide*.\nRequired if you're creating your domain inside a VPC.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::Elasticsearch::Domain.ZoneAwarenessConfig": { "MarkdownDocumentation": "`AWS::Elasticsearch::Domain.ZoneAwarenessConfig`\n\nSpecifies zone awareness configuration options. Only use if\n`ZoneAwarenessEnabled` is `true`.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nElasticsearch. For more information about the service rename, see [New resource\ntypes](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html", "Properties": { "AvailabilityZoneCount": { "MarkdownDocumentation": "`AvailabilityZoneCount`\n\nIf you enabled multiple Availability Zones (AZs), the number of AZs that you want the\ndomain 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html#cfn-elasticsearch-domain-zoneawarenessconfig-availabilityzonecount", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EntityResolution::IdMappingWorkflow.IdMappingIncrementalRunConfig": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow.IdMappingIncrementalRunConfig`\n\nThe `IdMappingIncrementalRunConfig` property type specifies Property description not available. for an [AWS::EntityResolution::IdMappingWorkflow](./aws-resource-entityresolution-idmappingworkflow.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig.html", "Properties": { "IncrementalRunType": { "MarkdownDocumentation": "`IncrementalRunType`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ON_DEMAND`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ON_DEMAND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig.html#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-incrementalruntype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdMappingWorkflow.IdMappingRuleBasedProperties": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow.IdMappingRuleBasedProperties`\n\nAn object that defines the list of matching rules to run in an ID mapping\nworkflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html", "Properties": { "AttributeMatchingModel": { "MarkdownDocumentation": "`AttributeMatchingModel`\n\nThe comparison type. You can either choose `ONE_TO_ONE` or\n`MANY_TO_MANY` as the `attributeMatchingModel`.\nIf you choose `ONE_TO_ONE`, the system can only match attributes if the\nsub-types are an exact match. For example, for the `Email` attribute type, the\nsystem will only consider it a match if the value of the `Email` field of\nProfile A matches the value of the `Email` field of Profile B.\nIf you choose `MANY_TO_MANY`, the system can match attributes across the\nsub-types of an attribute type. For example, if the value of the `Email` field\nof Profile A matches the value of the `BusinessEmail` field of Profile B, the\ntwo profiles are matched on the `Email` attribute type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ONE_TO_ONE | MANY_TO_MANY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ONE_TO_ONE", "MANY_TO_MANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-attributematchingmodel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RuleDefinitionType": { "MarkdownDocumentation": "`RuleDefinitionType`\n\nThe set of rules you can use in an ID mapping workflow. The limitations specified for\nthe source or target to define the match rules must be compatible.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "SOURCE", "TARGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-ruledefinitiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe rules that can be used for ID mapping.\n*Required*: No\n*Type*: Array of [Rule](./aws-properties-entityresolution-idmappingworkflow-rule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-rules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true }, "RecordMatchingModel": { "MarkdownDocumentation": "`RecordMatchingModel`\n\nThe type of matching record that is allowed to be used in an ID mapping workflow.\nIf the value is set to `ONE_SOURCE_TO_ONE_TARGET`, only one record in the\nsource can be matched to the same record in the target.\nIf the value is set to `MANY_SOURCE_TO_ONE_TARGET`, multiple records in the\nsource can be matched to one record in the target.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ONE_SOURCE_TO_ONE_TARGET | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ONE_SOURCE_TO_ONE_TARGET", "MANY_SOURCE_TO_ONE_TARGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-recordmatchingmodel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdMappingWorkflow.IdMappingTechniques": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow.IdMappingTechniques`\n\nAn object which defines the ID mapping technique and any additional\nconfigurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html", "Properties": { "RuleBasedProperties": { "MarkdownDocumentation": "`RuleBasedProperties`\n\nAn object which defines any additional configurations required by rule-based\nmatching.\n*Required*: No\n*Type*: [IdMappingRuleBasedProperties](./aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-rulebasedproperties", "UpdateType": "Mutable", "Required": false, "Type": "IdMappingRuleBasedProperties" }, "ProviderProperties": { "MarkdownDocumentation": "`ProviderProperties`\n\nAn object which defines any additional configurations required by the provider\nservice.\n*Required*: No\n*Type*: [ProviderProperties](./aws-properties-entityresolution-idmappingworkflow-providerproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-providerproperties", "UpdateType": "Mutable", "Required": false, "Type": "ProviderProperties" }, "IdMappingType": { "MarkdownDocumentation": "`IdMappingType`\n\nThe type of ID mapping.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROVIDER | RULE_BASED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROVIDER", "RULE_BASED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-idmappingtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NormalizationVersion": { "MarkdownDocumentation": "`NormalizationVersion`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-normalizationversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdMappingWorkflow.IdMappingWorkflowInputSource": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow.IdMappingWorkflowInputSource`\n\nAn object containing `inputSourceARN`, `schemaName`, and\n`type`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of ID namespace. There are two types: `SOURCE` and\n`TARGET`.\nThe `SOURCE` contains configurations for `sourceId` data that will\nbe processed in an ID mapping workflow.\nThe `TARGET` contains a configuration of `targetId` which all\n`sourceIds` will resolve to.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "SOURCE", "TARGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputSourceARN": { "MarkdownDocumentation": "`InputSourceARN`\n\nAn AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for\nthe input source table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-inputsourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SchemaArn": { "MarkdownDocumentation": "`SchemaArn`\n\nThe ARN (Amazon Resource Name) that AWS Entity Resolution generated for the\n`SchemaMapping`.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-schemaarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdMappingWorkflow.IdMappingWorkflowOutputSource": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow.IdMappingWorkflowOutputSource`\n\nA list of `IdMappingWorkflowOutputSource` objects, each of which contains\nfields `outputS3Path` and `KMSArn`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.html", "Properties": { "KMSArn": { "MarkdownDocumentation": "`KMSArn`\n\nCustomer AWS KMS ARN for encryption at rest. If not provided, system will use\nan AWS Entity Resolution managed KMS key.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-kmsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputS3Path": { "MarkdownDocumentation": "`OutputS3Path`\n\nThe S3 path to which AWS Entity Resolution will write the output table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^s3://([^/]+)/?(.*?([^/]+)/?)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-outputs3path", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdMappingWorkflow.IntermediateSourceConfiguration": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow.IntermediateSourceConfiguration`\n\nThe Amazon S3 location that temporarily stores your data while it processes.\nYour information won't be saved permanently.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration.html", "Properties": { "IntermediateS3Path": { "MarkdownDocumentation": "`IntermediateS3Path`\n\nThe Amazon S3 location (bucket and prefix). For example:\n`s3://provider_bucket/DOC-EXAMPLE-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration.html#cfn-entityresolution-idmappingworkflow-intermediatesourceconfiguration-intermediates3path", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdMappingWorkflow.ProviderProperties": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow.ProviderProperties`\n\nAn object containing the `providerServiceARN`,\n`intermediateSourceConfiguration`, and\n`providerConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html", "Properties": { "IntermediateSourceConfiguration": { "MarkdownDocumentation": "`IntermediateSourceConfiguration`\n\nThe Amazon S3 location that temporarily stores your data while it processes.\nYour information won't be saved permanently.\n*Required*: No\n*Type*: [IntermediateSourceConfiguration](./aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-intermediatesourceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IntermediateSourceConfiguration" }, "ProviderServiceArn": { "MarkdownDocumentation": "`ProviderServiceArn`\n\nThe ARN of the provider service.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-providerservicearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProviderConfiguration": { "MarkdownDocumentation": "`ProviderConfiguration`\n\nThe required configuration fields to use with the provider service.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-providerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::EntityResolution::IdMappingWorkflow.Rule": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow.Rule`\n\nAn object containing the `ruleName` and `matchingKeys`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-rule.html", "Properties": { "MatchingKeys": { "MarkdownDocumentation": "`MatchingKeys`\n\nA list of `MatchingKeys`. The `MatchingKeys` must have been\ndefined in the `SchemaMapping`. Two records are considered to match according to\nthis rule if all of the `MatchingKeys` match.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-rule.html#cfn-entityresolution-idmappingworkflow-rule-matchingkeys", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nA name for the matching rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9- \\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-rule.html#cfn-entityresolution-idmappingworkflow-rule-rulename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdNamespace.IdNamespaceIdMappingWorkflowProperties": { "MarkdownDocumentation": "`AWS::EntityResolution::IdNamespace.IdNamespaceIdMappingWorkflowProperties`\n\nAn object containing `idMappingType`, `providerProperties`, and\n`ruleBasedProperties`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html", "Properties": { "RuleBasedProperties": { "MarkdownDocumentation": "`RuleBasedProperties`\n\nAn object which defines any additional configurations required by rule-based\nmatching.\n*Required*: No\n*Type*: [NamespaceRuleBasedProperties](./aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-rulebasedproperties", "UpdateType": "Mutable", "Required": false, "Type": "NamespaceRuleBasedProperties" }, "ProviderProperties": { "MarkdownDocumentation": "`ProviderProperties`\n\nAn object which defines any additional configurations required by the provider\nservice.\n*Required*: No\n*Type*: [NamespaceProviderProperties](./aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-providerproperties", "UpdateType": "Mutable", "Required": false, "Type": "NamespaceProviderProperties" }, "IdMappingType": { "MarkdownDocumentation": "`IdMappingType`\n\nThe type of ID mapping.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PROVIDER | RULE_BASED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROVIDER", "RULE_BASED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-idmappingtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdNamespace.IdNamespaceInputSource": { "MarkdownDocumentation": "`AWS::EntityResolution::IdNamespace.IdNamespaceInputSource`\n\nAn object containing `inputSourceARN` and `schemaName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html", "Properties": { "InputSourceARN": { "MarkdownDocumentation": "`InputSourceARN`\n\nAn AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for\nthe input source table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html#cfn-entityresolution-idnamespace-idnamespaceinputsource-inputsourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SchemaName": { "MarkdownDocumentation": "`SchemaName`\n\nThe name of the schema.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html#cfn-entityresolution-idnamespace-idnamespaceinputsource-schemaname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EntityResolution::IdNamespace.NamespaceProviderProperties": { "MarkdownDocumentation": "`AWS::EntityResolution::IdNamespace.NamespaceProviderProperties`\n\nAn object containing `providerConfiguration` and\n`providerServiceArn`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html", "Properties": { "ProviderServiceArn": { "MarkdownDocumentation": "`ProviderServiceArn`\n\nThe Amazon Resource Name (ARN) of the provider service.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$`\n*Minimum*: `20`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html#cfn-entityresolution-idnamespace-namespaceproviderproperties-providerservicearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProviderConfiguration": { "MarkdownDocumentation": "`ProviderConfiguration`\n\nAn object which defines any additional configurations required by the provider\nservice.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html#cfn-entityresolution-idnamespace-namespaceproviderproperties-providerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::EntityResolution::IdNamespace.NamespaceRuleBasedProperties": { "MarkdownDocumentation": "`AWS::EntityResolution::IdNamespace.NamespaceRuleBasedProperties`\n\nThe rule-based properties of an ID namespace. These properties define how the ID\nnamespace can be used in an ID mapping workflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html", "Properties": { "AttributeMatchingModel": { "MarkdownDocumentation": "`AttributeMatchingModel`\n\nThe comparison type. You can either choose `ONE_TO_ONE` or\n`MANY_TO_MANY` as the `attributeMatchingModel`.\nIf you choose `ONE_TO_ONE`, the system can only match attributes if the\nsub-types are an exact match. For example, for the `Email` attribute type, the\nsystem will only consider it a match if the value of the `Email` field of\nProfile A matches the value of the `Email` field of Profile B.\nIf you choose `MANY_TO_MANY`, the system can match attributes across the\nsub-types of an attribute type. For example, if the value of the `Email` field\nof Profile A matches the value of `BusinessEmail` field of Profile B, the two\nprofiles are matched on the `Email` attribute type.\n*Required*: No\n*Type*: String\n*Allowed values*: `ONE_TO_ONE | MANY_TO_MANY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ONE_TO_ONE", "MANY_TO_MANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-attributematchingmodel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleDefinitionTypes": { "MarkdownDocumentation": "`RuleDefinitionTypes`\n\nThe sets of rules you can use in an ID mapping workflow. The limitations specified for\nthe source and target must be compatible.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-ruledefinitiontypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RecordMatchingModels": { "MarkdownDocumentation": "`RecordMatchingModels`\n\nThe type of matching record that is allowed to be used in an ID mapping workflow.\nIf the value is set to `ONE_SOURCE_TO_ONE_TARGET`, only one record in the\nsource is matched to one record in the target.\nIf the value is set to `MANY_SOURCE_TO_ONE_TARGET`, all matching records in\nthe source are matched to one record in the target.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-recordmatchingmodels", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe rules for the ID namespace.\n*Required*: No\n*Type*: Array of [Rule](./aws-properties-entityresolution-idnamespace-rule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-rules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true } } }, "AWS::EntityResolution::IdNamespace.Rule": { "MarkdownDocumentation": "`AWS::EntityResolution::IdNamespace.Rule`\n\nAn object containing the `ruleName` and `matchingKeys`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-rule.html", "Properties": { "MatchingKeys": { "MarkdownDocumentation": "`MatchingKeys`\n\nA list of `MatchingKeys`. The `MatchingKeys` must have been\ndefined in the `SchemaMapping`. Two records are considered to match according to\nthis rule if all of the `MatchingKeys` match.\n*Required*: Yes\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-rule.html#cfn-entityresolution-idnamespace-rule-matchingkeys", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nA name for the matching rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9- \\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-rule.html#cfn-entityresolution-idnamespace-rule-rulename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.CustomerProfilesIntegrationConfig": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.CustomerProfilesIntegrationConfig`\n\nThe `CustomerProfilesIntegrationConfig` property type specifies Property description not available. for an [AWS::EntityResolution::MatchingWorkflow](./aws-resource-entityresolution-matchingworkflow.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-customerprofilesintegrationconfig.html", "Properties": { "DomainArn": { "MarkdownDocumentation": "`DomainArn`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):profile:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(domains/[a-zA-Z_0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-customerprofilesintegrationconfig.html#cfn-entityresolution-matchingworkflow-customerprofilesintegrationconfig-domainarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ObjectTypeArn": { "MarkdownDocumentation": "`ObjectTypeArn`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):profile:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(domains/[a-zA-Z_0-9-]{1,255}/object-types/[a-zA-Z_0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-customerprofilesintegrationconfig.html#cfn-entityresolution-matchingworkflow-customerprofilesintegrationconfig-objecttypearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.IncrementalRunConfig": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.IncrementalRunConfig`\n\nOptional. An object that defines the incremental run type. This object contains only the\n`incrementalRunType` field, which appears as \"Automatic\" in the console.\n###### Important\nFor workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER`,\nincremental processing is not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-incrementalrunconfig.html", "Properties": { "IncrementalRunType": { "MarkdownDocumentation": "`IncrementalRunType`\n\nThe type of incremental run. The only valid value is `IMMEDIATE`. This\nappears as \"Automatic\" in the console.\n###### Important\nFor workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER`,\nincremental processing is not supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IMMEDIATE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "IMMEDIATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-incrementalrunconfig.html#cfn-entityresolution-matchingworkflow-incrementalrunconfig-incrementalruntype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.InputSource": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.InputSource`\n\nAn object containing `inputSourceARN`, `schemaName`, and\n`applyNormalization`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html", "Properties": { "ApplyNormalization": { "MarkdownDocumentation": "`ApplyNormalization`\n\nNormalizes the attributes defined in the schema in the input data. For example, if an\nattribute has an `AttributeType` of `PHONE_NUMBER`, and the data in\nthe input table is in a format of 1234567890, AWS Entity Resolution will normalize this field\nin the output to (123)-456-7890.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-applynormalization", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InputSourceARN": { "MarkdownDocumentation": "`InputSourceARN`\n\nAn object containing `inputSourceARN`, `schemaName`, and\n`applyNormalization`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn):.*:.*:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-inputsourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SchemaArn": { "MarkdownDocumentation": "`SchemaArn`\n\nThe name of the schema.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-schemaarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.IntermediateSourceConfiguration": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.IntermediateSourceConfiguration`\n\nThe Amazon S3 location that temporarily stores your data while it processes.\nYour information won't be saved permanently.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-intermediatesourceconfiguration.html", "Properties": { "IntermediateS3Path": { "MarkdownDocumentation": "`IntermediateS3Path`\n\nThe Amazon S3 location (bucket and prefix). For example:\n`s3://provider_bucket/DOC-EXAMPLE-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-intermediatesourceconfiguration.html#cfn-entityresolution-matchingworkflow-intermediatesourceconfiguration-intermediates3path", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.OutputAttribute": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.OutputAttribute`\n\nA list of `OutputAttribute` objects, each of which have the fields\n`Name` and `Hashed`. Each of these objects selects a column to be\nincluded in the output table, and whether the values of the column should be hashed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputattribute.html", "Properties": { "Hashed": { "MarkdownDocumentation": "`Hashed`\n\nEnables the ability to hash the column values in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputattribute.html#cfn-entityresolution-matchingworkflow-outputattribute-hashed", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name of a column to be written to the output. This must be an `InputField`\nname in the schema mapping.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9- \\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputattribute.html#cfn-entityresolution-matchingworkflow-outputattribute-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.OutputSource": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.OutputSource`\n\nA list of `OutputAttribute` objects, each of which have the fields\n`Name` and `Hashed`. Each of these objects selects a column to be\nincluded in the output table, and whether the values of the column should be hashed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html", "Properties": { "KMSArn": { "MarkdownDocumentation": "`KMSArn`\n\nCustomer KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-kmsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputS3Path": { "MarkdownDocumentation": "`OutputS3Path`\n\nThe S3 path to which AWS Entity Resolution will write the output table.\n*Required*: No\n*Type*: String\n*Pattern*: `^s3://([^/]+)/?(.*?([^/]+)/?)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-outputs3path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Output": { "MarkdownDocumentation": "`Output`\n\nA list of `OutputAttribute` objects, each of which have the fields\n`Name` and `Hashed`. Each of these objects selects a column to be\nincluded in the output table, and whether the values of the column should be hashed.\n*Required*: Yes\n*Type*: Array of [OutputAttribute](./aws-properties-entityresolution-matchingworkflow-outputattribute.html)\n*Minimum*: `0`\n*Maximum*: `750`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-output", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "OutputAttribute", "DuplicatesAllowed": true }, "ApplyNormalization": { "MarkdownDocumentation": "`ApplyNormalization`\n\nNormalizes the attributes defined in the schema in the input data. For example, if an\nattribute has an `AttributeType` of `PHONE_NUMBER`, and the data in\nthe input table is in a format of 1234567890, AWS Entity Resolution will normalize this field\nin the output to (123)-456-7890.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-applynormalization", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CustomerProfilesIntegrationConfig": { "MarkdownDocumentation": "`CustomerProfilesIntegrationConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomerProfilesIntegrationConfig](./aws-properties-entityresolution-matchingworkflow-customerprofilesintegrationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-customerprofilesintegrationconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomerProfilesIntegrationConfig" } } }, "AWS::EntityResolution::MatchingWorkflow.ProviderProperties": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.ProviderProperties`\n\nAn object containing the `providerServiceARN`,\n`intermediateSourceConfiguration`, and\n`providerConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-providerproperties.html", "Properties": { "IntermediateSourceConfiguration": { "MarkdownDocumentation": "`IntermediateSourceConfiguration`\n\nThe Amazon S3 location that temporarily stores your data while it processes.\nYour information won't be saved permanently.\n*Required*: No\n*Type*: [IntermediateSourceConfiguration](./aws-properties-entityresolution-matchingworkflow-intermediatesourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-providerproperties.html#cfn-entityresolution-matchingworkflow-providerproperties-intermediatesourceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IntermediateSourceConfiguration" }, "ProviderServiceArn": { "MarkdownDocumentation": "`ProviderServiceArn`\n\nThe ARN of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-providerproperties.html#cfn-entityresolution-matchingworkflow-providerproperties-providerservicearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProviderConfiguration": { "MarkdownDocumentation": "`ProviderConfiguration`\n\nThe required configuration fields to use with the provider service.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-providerproperties.html#cfn-entityresolution-matchingworkflow-providerproperties-providerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.ResolutionTechniques": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.ResolutionTechniques`\n\nAn object which defines the `resolutionType` and the\n`ruleBasedProperties`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html", "Properties": { "RuleBasedProperties": { "MarkdownDocumentation": "`RuleBasedProperties`\n\nAn object which defines the list of matching rules to run and has a field\n`rules`, which is a list of rule objects.\n*Required*: No\n*Type*: [RuleBasedProperties](./aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-rulebasedproperties", "UpdateType": "Mutable", "Required": false, "Type": "RuleBasedProperties" }, "ProviderProperties": { "MarkdownDocumentation": "`ProviderProperties`\n\nThe properties of the provider service.\n*Required*: No\n*Type*: [ProviderProperties](./aws-properties-entityresolution-matchingworkflow-providerproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-providerproperties", "UpdateType": "Mutable", "Required": false, "Type": "ProviderProperties" }, "ResolutionType": { "MarkdownDocumentation": "`ResolutionType`\n\nThe type of matching workflow to create. Specify one of the following types:\n* `RULE_MATCHING`: Match records using configurable rule-based criteria\n* `ML_MATCHING`: Match records using machine learning models\n* `PROVIDER`: Match records using a third-party matching provider\n*Required*: No\n*Type*: String\n*Allowed values*: `RULE_MATCHING | ML_MATCHING...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RULE_MATCHING", "ML_MATCHING", "PROVIDER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-resolutiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleConditionProperties": { "MarkdownDocumentation": "`RuleConditionProperties`\n\nAn object containing the `rules` for a matching workflow.\n*Required*: No\n*Type*: [RuleConditionProperties](./aws-properties-entityresolution-matchingworkflow-ruleconditionproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-ruleconditionproperties", "UpdateType": "Mutable", "Required": false, "Type": "RuleConditionProperties" } } }, "AWS::EntityResolution::MatchingWorkflow.Rule": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.Rule`\n\nAn object containing the `ruleName` and `matchingKeys`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rule.html", "Properties": { "MatchingKeys": { "MarkdownDocumentation": "`MatchingKeys`\n\nA list of `MatchingKeys`. The `MatchingKeys` must have been\ndefined in the `SchemaMapping`. Two records are considered to match according to\nthis rule if all of the `MatchingKeys` match.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rule.html#cfn-entityresolution-matchingworkflow-rule-matchingkeys", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nA name for the matching rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9- \\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rule.html#cfn-entityresolution-matchingworkflow-rule-rulename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.RuleBasedProperties": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.RuleBasedProperties`\n\nAn object which defines the list of matching rules to run in a matching workflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html", "Properties": { "AttributeMatchingModel": { "MarkdownDocumentation": "`AttributeMatchingModel`\n\nThe comparison type. You can choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel`.\nIf you choose `ONE_TO_ONE`, the system can only match attributes if the\nsub-types are an exact match. For example, for the `Email` attribute type, the\nsystem will only consider it a match if the value of the `Email` field of\nProfile A matches the value of the `Email` field of Profile B.\nIf you choose `MANY_TO_MANY`, the system can match attributes across the\nsub-types of an attribute type. For example, if the value of the `Email` field\nof Profile A and the value of `BusinessEmail` field of Profile B matches, the\ntwo profiles are matched on the `Email` attribute type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ONE_TO_ONE | MANY_TO_MANY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ONE_TO_ONE", "MANY_TO_MANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-attributematchingmodel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchPurpose": { "MarkdownDocumentation": "`MatchPurpose`\n\nAn indicator of whether to generate IDs and index the data or not.\nIf you choose `IDENTIFIER_GENERATION`, the process generates IDs and indexes\nthe data.\nIf you choose `INDEXING`, the process indexes the data without generating\nIDs.\n*Required*: No\n*Type*: String\n*Allowed values*: `IDENTIFIER_GENERATION | IND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IDENTIFIER_GENERATION", "INDEXING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-matchpurpose", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nA list of `Rule` objects, each of which have fields `RuleName` and\n`MatchingKeys`.\n*Required*: Yes\n*Type*: Array of [Rule](./aws-properties-entityresolution-matchingworkflow-rule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true } } }, "AWS::EntityResolution::MatchingWorkflow.RuleCondition": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.RuleCondition`\n\nAn object that defines the `ruleCondition` and the `ruleName` to\nuse in a matching workflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulecondition.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nA statement that specifies the conditions for a matching rule.\nIf your data is accurate, use an Exact matching function: `Exact` or `ExactManyToMany`.\nIf your data has variations in spelling or pronunciation, use a Fuzzy matching function: `Cosine`, `Levenshtein`, or `Soundex`.\nUse operators if you want to combine (`AND`), separate (`OR`), or group matching functions `(...)`.\nFor example: `(Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulecondition.html#cfn-entityresolution-matchingworkflow-rulecondition-condition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nA name for the matching rule.\nFor example: `Rule1`\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9- \\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulecondition.html#cfn-entityresolution-matchingworkflow-rulecondition-rulename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EntityResolution::MatchingWorkflow.RuleConditionProperties": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow.RuleConditionProperties`\n\nThe properties of a rule condition that provides the ability to use more complex\nsyntax.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-ruleconditionproperties.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nA list of rule objects, each of which have fields `ruleName` and `condition`.\n*Required*: Yes\n*Type*: Array of [RuleCondition](./aws-properties-entityresolution-matchingworkflow-rulecondition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-ruleconditionproperties.html#cfn-entityresolution-matchingworkflow-ruleconditionproperties-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RuleCondition", "DuplicatesAllowed": true } } }, "AWS::EntityResolution::SchemaMapping.SchemaInputAttribute": { "MarkdownDocumentation": "`AWS::EntityResolution::SchemaMapping.SchemaInputAttribute`\n\nA configuration object for defining input data fields in AWS Entity Resolution. The `SchemaInputAttribute` specifies how individual fields in your input data\nshould be processed and matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nA string that instructs AWS Entity Resolution to combine several columns into a unified\ncolumn with the identical attribute type.\nFor example, when working with columns such as `NAME_FIRST`,\n`NAME_MIDDLE`, and `NAME_LAST`, assigning them a common\n`groupName` will prompt AWS Entity Resolution to concatenate them into a single\nvalue.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9- \\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-groupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the attribute, selected from a list of values.\nLiveRamp supports: `NAME` | `NAME_FIRST` |\n`NAME_MIDDLE` | `NAME_LAST` | `ADDRESS` |\n`ADDRESS_STREET1` | `ADDRESS_STREET2` |\n`ADDRESS_STREET3` | `ADDRESS_CITY` | `ADDRESS_STATE` |\n`ADDRESS_COUNTRY` | `ADDRESS_POSTALCODE` | `PHONE` |\n`PHONE_NUMBER` | `EMAIL_ADDRESS` | `UNIQUE_ID` |\n`PROVIDER_ID`\nTransUnion supports: `NAME` | `NAME_FIRST` |\n`NAME_LAST` | `ADDRESS` | `ADDRESS_CITY` |\n`ADDRESS_STATE` | `ADDRESS_COUNTRY` |\n`ADDRESS_POSTALCODE` | `PHONE_NUMBER` | `EMAIL_ADDRESS`\n| `UNIQUE_ID` | `IPV4` | `IPV6` | `MAID`\nUnified ID 2.0 supports: `PHONE_NUMBER` | `EMAIL_ADDRESS` |\n`UNIQUE_ID`\n###### Note\nNormalization is only supported for `NAME`, `ADDRESS`,\n`PHONE`, and `EMAIL_ADDRESS`.\nIf you want to normalize `NAME_FIRST`, `NAME_MIDDLE`, and\n`NAME_LAST`, you must group them by assigning them to the\n`NAME``groupName`.\nIf you want to normalize `ADDRESS_STREET1`, `ADDRESS_STREET2`,\n`ADDRESS_STREET3`, `ADDRESS_CITY`, `ADDRESS_STATE`,\n`ADDRESS_COUNTRY`, and `ADDRESS_POSTALCODE`, you must group\nthem by assigning them to the `ADDRESS``groupName`.\nIf you want to normalize `PHONE_NUMBER` and\n`PHONE_COUNTRYCODE`, you must group them by assigning them to the\n`PHONE``groupName`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NAME | NAME_FIRST | NAME_MI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NAME", "NAME_FIRST", "NAME_MIDDLE", "NAME_LAST", "ADDRESS", "ADDRESS_STREET1", "ADDRESS_STREET2", "ADDRESS_STREET3", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_COUNTRY", "ADDRESS_POSTALCODE", "PHONE", "PHONE_NUMBER", "PHONE_COUNTRYCODE", "EMAIL_ADDRESS", "UNIQUE_ID", "DATE", "STRING", "PROVIDER_ID" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubType": { "MarkdownDocumentation": "`SubType`\n\nThe subtype of the attribute, selected from a list of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-subtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Hashed": { "MarkdownDocumentation": "`Hashed`\n\nIndicates if the column values are hashed in the schema input.\nIf the value is set to `TRUE`, the column values are hashed.\nIf the value is set to `FALSE`, the column values are cleartext.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-hashed", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MatchKey": { "MarkdownDocumentation": "`MatchKey`\n\nA key that allows grouping of multiple input attributes into a unified matching group.\nFor example, consider a scenario where the source table contains various addresses, such\nas `business_address` and `shipping_address`. By assigning a\n`matchKey` called `address` to both attributes, AWS Entity Resolution\nwill match records across these fields to create a consolidated matching group.\nIf no `matchKey` is specified for a column, it won't be utilized for matching\npurposes but will still be included in the output table.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9- \\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-matchkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nA string containing the field name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9- \\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-fieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EventSchemas::Discoverer.TagsEntry": { "MarkdownDocumentation": "`AWS::EventSchemas::Discoverer.TagsEntry`\n\nTags to associate with the discoverer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-discoverer-tagsentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a key-value pair.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-discoverer-tagsentry.html#cfn-eventschemas-discoverer-tagsentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of a key-value pair.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-discoverer-tagsentry.html#cfn-eventschemas-discoverer-tagsentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EventSchemas::Registry.TagsEntry": { "MarkdownDocumentation": "`AWS::EventSchemas::Registry.TagsEntry`\n\nTags to associate with the schema registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-registry-tagsentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a key-value pair.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-registry-tagsentry.html#cfn-eventschemas-registry-tagsentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of a key-value pair.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-registry-tagsentry.html#cfn-eventschemas-registry-tagsentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EventSchemas::Schema.TagsEntry": { "MarkdownDocumentation": "`AWS::EventSchemas::Schema.TagsEntry`\n\nTags to associate with the schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-schema-tagsentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a key-value pair.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-schema-tagsentry.html#cfn-eventschemas-schema-tagsentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of a key-value pair.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-schema-tagsentry.html#cfn-eventschemas-schema-tagsentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Connection.ApiKeyAuthParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.ApiKeyAuthParameters`\n\nThe API key authorization parameters for the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html", "Properties": { "ApiKeyValue": { "MarkdownDocumentation": "`ApiKeyValue`\n\nThe value for the API key to use for authorization.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ \\t]*[^\\x00-\\x1F\\x7F]+([ \\t]+[^\\x00-\\x1F\\x7F]+)*[ \\t]*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApiKeyName": { "MarkdownDocumentation": "`ApiKeyName`\n\nThe name of the API key to use for authorization.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ \\t]*[^\\x00-\\x1F\\x7F]+([ \\t]+[^\\x00-\\x1F\\x7F]+)*[ \\t]*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Connection.AuthParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.AuthParameters`\n\nTthe authorization parameters to use for the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html", "Properties": { "InvocationHttpParameters": { "MarkdownDocumentation": "`InvocationHttpParameters`\n\nAdditional parameters for the connection that are passed through with every invocation to\nthe HTTP endpoint.\n*Required*: No\n*Type*: [ConnectionHttpParameters](./aws-properties-events-connection-connectionhttpparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-invocationhttpparameters", "UpdateType": "Mutable", "Required": false, "Type": "ConnectionHttpParameters" }, "ConnectivityParameters": { "MarkdownDocumentation": "`ConnectivityParameters`\n\nFor private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.\nFor more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide**.\n*Required*: No\n*Type*: [ConnectivityParameters](./aws-properties-events-connection-connectivityparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-connectivityparameters", "UpdateType": "Mutable", "Required": false, "Type": "ConnectivityParameters" }, "BasicAuthParameters": { "MarkdownDocumentation": "`BasicAuthParameters`\n\nThe authorization parameters for Basic authorization.\n*Required*: No\n*Type*: [BasicAuthParameters](./aws-properties-events-connection-basicauthparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-basicauthparameters", "UpdateType": "Mutable", "Required": false, "Type": "BasicAuthParameters" }, "ApiKeyAuthParameters": { "MarkdownDocumentation": "`ApiKeyAuthParameters`\n\nThe API Key parameters to use for authorization.\n*Required*: No\n*Type*: [ApiKeyAuthParameters](./aws-properties-events-connection-apikeyauthparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-apikeyauthparameters", "UpdateType": "Mutable", "Required": false, "Type": "ApiKeyAuthParameters" }, "OAuthParameters": { "MarkdownDocumentation": "`OAuthParameters`\n\nThe OAuth parameters to use for authorization.\n*Required*: No\n*Type*: [OAuthParameters](./aws-properties-events-connection-oauthparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-oauthparameters", "UpdateType": "Mutable", "Required": false, "Type": "OAuthParameters" } } }, "AWS::Events::Connection.BasicAuthParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.BasicAuthParameters`\n\nThe Basic authorization parameters for the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe user name to use for Basic authorization.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ \\t]*[^\\x00-\\x1F\\x7F]+([ \\t]+[^\\x00-\\x1F\\x7F]+)*[ \\t]*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password associated with the user name to use for Basic authorization.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ \\t]*[^\\x00-\\x1F\\x7F]+([ \\t]+[^\\x00-\\x1F\\x7F]+)*[ \\t]*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Connection.ClientParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.ClientParameters`\n\nThe OAuth authorization parameters to use for the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html", "Properties": { "ClientSecret": { "MarkdownDocumentation": "`ClientSecret`\n\nThe client secret assciated with the client ID to use for OAuth authorization.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ \\t]*[^\\x00-\\x1F\\x7F]+([ \\t]+[^\\x00-\\x1F\\x7F]+)*[ \\t]*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientsecret", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ClientID": { "MarkdownDocumentation": "`ClientID`\n\nThe client ID to use for OAuth authorization.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ \\t]*[^\\x00-\\x1F\\x7F]+([ \\t]+[^\\x00-\\x1F\\x7F]+)*[ \\t]*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Connection.ConnectionHttpParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.ConnectionHttpParameters`\n\nAny additional parameters for the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html", "Properties": { "HeaderParameters": { "MarkdownDocumentation": "`HeaderParameters`\n\nAny additional header parameters for the connection.\n*Required*: No\n*Type*: Array of [Parameter](./aws-properties-events-connection-parameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-headerparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Parameter", "DuplicatesAllowed": true }, "QueryStringParameters": { "MarkdownDocumentation": "`QueryStringParameters`\n\nAny additional query string parameters for the connection.\n*Required*: No\n*Type*: Array of [Parameter](./aws-properties-events-connection-parameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-querystringparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Parameter", "DuplicatesAllowed": true }, "BodyParameters": { "MarkdownDocumentation": "`BodyParameters`\n\nAny additional body string parameters for the connection.\n*Required*: No\n*Type*: Array of [Parameter](./aws-properties-events-connection-parameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-bodyparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Parameter", "DuplicatesAllowed": true } } }, "AWS::Events::Connection.ConnectivityParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.ConnectivityParameters`\n\nIf you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.\nFor more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide**.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectivityparameters.html", "Properties": { "ResourceParameters": { "MarkdownDocumentation": "`ResourceParameters`\n\nThe parameters for EventBridge to use when invoking the resource endpoint.\n*Required*: Yes\n*Type*: [ResourceParameters](./aws-properties-events-connection-resourceparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectivityparameters.html#cfn-events-connection-connectivityparameters-resourceparameters", "UpdateType": "Mutable", "Required": true, "Type": "ResourceParameters" } } }, "AWS::Events::Connection.InvocationConnectivityParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.InvocationConnectivityParameters`\n\nFor connections to private APIs, the parameters to use for invoking the API.\nFor more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the **Amazon EventBridge User Guide**.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-invocationconnectivityparameters.html", "Properties": { "ResourceParameters": { "MarkdownDocumentation": "`ResourceParameters`\n\nThe parameters for EventBridge to use when invoking the resource endpoint.\n*Required*: Yes\n*Type*: [ResourceParameters](./aws-properties-events-connection-resourceparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-invocationconnectivityparameters.html#cfn-events-connection-invocationconnectivityparameters-resourceparameters", "UpdateType": "Mutable", "Required": true, "Type": "ResourceParameters" } } }, "AWS::Events::Connection.OAuthParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.OAuthParameters`\n\nContains the OAuth authorization parameters to use for the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html", "Properties": { "ClientParameters": { "MarkdownDocumentation": "`ClientParameters`\n\nThe client parameters for OAuth authorization.\n*Required*: Yes\n*Type*: [ClientParameters](./aws-properties-events-connection-clientparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-clientparameters", "UpdateType": "Mutable", "Required": true, "Type": "ClientParameters" }, "OAuthHttpParameters": { "MarkdownDocumentation": "`OAuthHttpParameters`\n\nDetails about the additional\nparameters to use for the connection.\n*Required*: No\n*Type*: [ConnectionHttpParameters](./aws-properties-events-connection-connectionhttpparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-oauthhttpparameters", "UpdateType": "Mutable", "Required": false, "Type": "ConnectionHttpParameters" }, "AuthorizationEndpoint": { "MarkdownDocumentation": "`AuthorizationEndpoint`\n\nThe URL to the authorization endpoint when OAuth is specified as the authorization\ntype.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-authorizationendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HttpMethod": { "MarkdownDocumentation": "`HttpMethod`\n\nThe method to use for the authorization request.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GET | POST | PUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GET", "POST", "PUT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-httpmethod", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Connection.Parameter": { "MarkdownDocumentation": "`AWS::Events::Connection.Parameter`\n\nAny additional query string parameter for the connection. You can include up to 100 additional\nquery string parameters per request. Each additional parameter counts towards the event\npayload size, which cannot exceed 64 KB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value associated with the key for the query string parameter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IsValueSecret": { "MarkdownDocumentation": "`IsValueSecret`\n\nSpecifies whether the value is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-isvaluesecret", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key for a query string parameter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^\\x00-\\x1F\\x7F]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Connection.ResourceParameters": { "MarkdownDocumentation": "`AWS::Events::Connection.ResourceParameters`\n\nThe parameters for EventBridge to use when invoking the resource endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-resourceparameters.html", "Properties": { "ResourceAssociationArn": { "MarkdownDocumentation": "`ResourceAssociationArn`\n\nFor connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.\n###### Note\nThe value of this property is set by EventBridge. Any value you specify in your template is ignored.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetworkresourceassociation/snra-[0-9a-z]{17}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-resourceparameters.html#cfn-events-connection-resourceparameters-resourceassociationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceConfigurationArn": { "MarkdownDocumentation": "`ResourceConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[a-z0-9f\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-resourceparameters.html#cfn-events-connection-resourceparameters-resourceconfigurationarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Endpoint.EndpointEventBus": { "MarkdownDocumentation": "`AWS::Events::Endpoint.EndpointEventBus`\n\nThe event buses the endpoint is associated with.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html", "Properties": { "EventBusArn": { "MarkdownDocumentation": "`EventBusArn`\n\nThe ARN of the event bus the endpoint is associated with.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z-]*:events:[a-z]+-[a-z-]+-\\d+:\\d{12}:event-bus/[\\w.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html#cfn-events-endpoint-endpointeventbus-eventbusarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Endpoint.FailoverConfig": { "MarkdownDocumentation": "`AWS::Events::Endpoint.FailoverConfig`\n\nThe failover configuration for an endpoint. This includes what triggers failover and what\nhappens when it's triggered.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html", "Properties": { "Secondary": { "MarkdownDocumentation": "`Secondary`\n\nThe Region that events are routed to when failover is triggered or event replication is\nenabled.\n*Required*: Yes\n*Type*: [Secondary](./aws-properties-events-endpoint-secondary.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-secondary", "UpdateType": "Mutable", "Required": true, "Type": "Secondary" }, "Primary": { "MarkdownDocumentation": "`Primary`\n\nThe main Region of the endpoint.\n*Required*: Yes\n*Type*: [Primary](./aws-properties-events-endpoint-primary.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-primary", "UpdateType": "Mutable", "Required": true, "Type": "Primary" } } }, "AWS::Events::Endpoint.Primary": { "MarkdownDocumentation": "`AWS::Events::Endpoint.Primary`\n\nThe primary Region of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html", "Properties": { "HealthCheck": { "MarkdownDocumentation": "`HealthCheck`\n\nThe ARN of the health check used by the endpoint to determine whether failover is\ntriggered.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws([a-z]|\\-)*:route53:::healthcheck/[\\-a-z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html#cfn-events-endpoint-primary-healthcheck", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Endpoint.ReplicationConfig": { "MarkdownDocumentation": "`AWS::Events::Endpoint.ReplicationConfig`\n\nEndpoints can replicate all events to the secondary Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html", "Properties": { "State": { "MarkdownDocumentation": "`State`\n\nThe state of event replication.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html#cfn-events-endpoint-replicationconfig-state", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Endpoint.RoutingConfig": { "MarkdownDocumentation": "`AWS::Events::Endpoint.RoutingConfig`\n\nThe routing configuration of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html", "Properties": { "FailoverConfig": { "MarkdownDocumentation": "`FailoverConfig`\n\nThe failover configuration for an endpoint. This includes what triggers failover and what\nhappens when it's triggered.\n*Required*: Yes\n*Type*: [FailoverConfig](./aws-properties-events-endpoint-failoverconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html#cfn-events-endpoint-routingconfig-failoverconfig", "UpdateType": "Mutable", "Required": true, "Type": "FailoverConfig" } } }, "AWS::Events::Endpoint.Secondary": { "MarkdownDocumentation": "`AWS::Events::Endpoint.Secondary`\n\nThe secondary Region that processes events when failover is triggered or replication is\nenabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html", "Properties": { "Route": { "MarkdownDocumentation": "`Route`\n\nDefines the secondary Region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\-a-z0-9]+$`\n*Minimum*: `9`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html#cfn-events-endpoint-secondary-route", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::EventBus.DeadLetterConfig": { "MarkdownDocumentation": "`AWS::Events::EventBus.DeadLetterConfig`\n\nConfiguration details of the Amazon SQS queue for EventBridge to use as a\ndead-letter queue (DLQ).\nFor more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-deadletterconfig.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe ARN of the SQS queue specified as the target for the dead-letter queue.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-deadletterconfig.html#cfn-events-eventbus-deadletterconfig-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Events::EventBus.LogConfig": { "MarkdownDocumentation": "`AWS::Events::EventBus.LogConfig`\n\nThe logging configuration settings for the event bus.\nFor more information, see [Configuring logs for event buses](https://docs.aws.amazon.com/eb-event-bus-logs.html) in the *EventBridge User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-logconfig.html", "Properties": { "IncludeDetail": { "MarkdownDocumentation": "`IncludeDetail`\n\nWhether EventBridge include detailed event information in the records it generates.\nDetailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details.\nFor more information, see [Including detail data in event bus logs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html#eb-event-logs-data) in the *EventBridge User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `FULL | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FULL", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-logconfig.html#cfn-events-eventbus-logconfig-includedetail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Level": { "MarkdownDocumentation": "`Level`\n\nThe level of logging detail to include. This applies to all log destinations for the event bus.\nFor more information, see [Specifying event bus log level](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html#eb-event-bus-logs-level) in the *EventBridge User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `INFO | ERROR | TRACE | OFF...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INFO", "ERROR", "TRACE", "OFF" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-logconfig.html#cfn-events-eventbus-logconfig-level", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Events::Rule.AppSyncParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.AppSyncParameters`\n\nContains the GraphQL operation to be parsed and executed, if the event target is an\nAWS AppSync API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-appsyncparameters.html", "Properties": { "GraphQLOperation": { "MarkdownDocumentation": "`GraphQLOperation`\n\nThe GraphQL operation; that is, the query, mutation, or subscription to be parsed and\nexecuted by the GraphQL service.\nFor more information, see [Operations](https://docs.aws.amazon.com/appsync/latest/devguide/graphql-architecture.html#graphql-operations) in the *AWS AppSync User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-appsyncparameters.html#cfn-events-rule-appsyncparameters-graphqloperation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Rule.AwsVpcConfiguration": { "MarkdownDocumentation": "`AWS::Events::Rule.AwsVpcConfiguration`\n\nThis structure specifies the VPC subnets and security groups for the task, and whether a\npublic IP address is to be used. This structure is relevant only for ECS tasks that use the\n`awsvpc` network mode.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nSpecifies the security groups associated with the task. These security groups must all be\nin the same VPC. You can specify as many as five security groups. If you do not specify a\nsecurity group, the default security group for the VPC is used.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nSpecifies the subnets associated with the task. These subnets must all be in the same VPC.\nYou can specify as many as 16 subnets.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-subnets", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AssignPublicIp": { "MarkdownDocumentation": "`AssignPublicIp`\n\nSpecifies whether the task's elastic network interface receives a public IP address. You\ncan specify `ENABLED` only when `LaunchType` in\n`EcsParameters` is set to `FARGATE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-assignpublicip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Events::Rule.BatchArrayProperties": { "MarkdownDocumentation": "`AWS::Events::Rule.BatchArrayProperties`\n\nThe array properties for the submitted job, such as the size of the array. The array size\ncan be between 2 and 10,000. If you specify array properties for a job, it becomes an array\njob. This parameter is used only if the target is an AWS Batch job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html", "Properties": { "Size": { "MarkdownDocumentation": "`Size`\n\nThe size of the array, if this is an array batch job. Valid values are integers between 2\nand 10,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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html#cfn-events-rule-batcharrayproperties-size", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Events::Rule.BatchParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.BatchParameters`\n\nThe custom parameters to be used when the target is an AWS Batch job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html", "Properties": { "ArrayProperties": { "MarkdownDocumentation": "`ArrayProperties`\n\nThe array properties for the submitted job, such as the size of the array. The array size\ncan be between 2 and 10,000. If you specify array properties for a job, it becomes an array\njob. This parameter is used only if the target is an AWS Batch job.\n*Required*: No\n*Type*: [BatchArrayProperties](./aws-properties-events-rule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties", "UpdateType": "Mutable", "Required": false, "Type": "BatchArrayProperties" }, "JobName": { "MarkdownDocumentation": "`JobName`\n\nThe name to use for this execution of the job, if the target is an AWS Batch\njob.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RetryStrategy": { "MarkdownDocumentation": "`RetryStrategy`\n\nThe retry strategy to use for failed jobs, if the target is an AWS Batch job.\nThe retry strategy is the number of times to retry the failed job execution. Valid values are\n1\u201310. When you specify a retry strategy here, it overrides the retry strategy defined in the\njob definition.\n*Required*: No\n*Type*: [BatchRetryStrategy](./aws-properties-events-rule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy", "UpdateType": "Mutable", "Required": false, "Type": "BatchRetryStrategy" }, "JobDefinition": { "MarkdownDocumentation": "`JobDefinition`\n\nThe ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Rule.BatchRetryStrategy": { "MarkdownDocumentation": "`AWS::Events::Rule.BatchRetryStrategy`\n\nThe retry strategy to use for failed jobs, if the target is an AWS Batch job.\nIf you specify a retry strategy here, it overrides the retry strategy defined in the job\ndefinition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html", "Properties": { "Attempts": { "MarkdownDocumentation": "`Attempts`\n\nThe number of times to attempt to retry, if the job fails. Valid values are 1\u201310.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html#cfn-events-rule-batchretrystrategy-attempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Events::Rule.CapacityProviderStrategyItem": { "MarkdownDocumentation": "`AWS::Events::Rule.CapacityProviderStrategyItem`\n\nThe details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html", "Properties": { "CapacityProvider": { "MarkdownDocumentation": "`CapacityProvider`\n\nThe short name of the capacity provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-capacityprovider", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Base": { "MarkdownDocumentation": "`Base`\n\nThe base value designates how many tasks, at a minimum, to run on the specified capacity\nprovider. Only one capacity provider in a capacity provider strategy can have a base defined.\nIf no value is specified, the default value of 0 is used.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe weight value designates the relative percentage of the total number of tasks launched\nthat should use the specified capacity provider. The weight value is taken into consideration\nafter the base value, if defined, is satisfied.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Events::Rule.DeadLetterConfig": { "MarkdownDocumentation": "`AWS::Events::Rule.DeadLetterConfig`\n\nConfiguration details of the Amazon SQS queue for EventBridge to use as a\ndead-letter queue (DLQ).\nFor more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe ARN of the SQS queue specified as the target for the dead-letter queue.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Events::Rule.EcsParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.EcsParameters`\n\nThe custom parameters to be used when the target is an Amazon ECS task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html", "Properties": { "PlatformVersion": { "MarkdownDocumentation": "`PlatformVersion`\n\nSpecifies the platform version for the task. Specify only the numeric portion of the\nplatform version, such as `1.1.0`.\nThis structure is used only if `LaunchType` is `FARGATE`. For more\ninformation about valid platform versions, see [AWS Fargate\nPlatform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Group": { "MarkdownDocumentation": "`Group`\n\nSpecifies an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableECSManagedTags": { "MarkdownDocumentation": "`EnableECSManagedTags`\n\nSpecifies whether to enable Amazon ECS managed tags for the task. For more\ninformation, see [Tagging Your Amazon ECS\nResources](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableecsmanagedtags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableExecuteCommand": { "MarkdownDocumentation": "`EnableExecuteCommand`\n\nWhether or not to enable the execute command functionality for the containers in this\ntask. If true, this enables execute command functionality on all containers in the\ntask.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableexecutecommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PlacementConstraints": { "MarkdownDocumentation": "`PlacementConstraints`\n\nAn array of placement constraint objects to use for the task. You can specify up to 10\nconstraints per task (including constraints in the task definition and those specified at\nruntime).\n*Required*: No\n*Type*: Array of [PlacementConstraint](./aws-properties-events-rule-placementconstraint.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementconstraints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlacementConstraint", "DuplicatesAllowed": false }, "PropagateTags": { "MarkdownDocumentation": "`PropagateTags`\n\nSpecifies whether to propagate the tags from the task definition to the task. If no value\nis specified, the tags are not propagated. Tags can only be propagated to the task during task\ncreation. To add tags to a task after task creation, use the TagResource API action.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "TASK_DEFINITION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-propagatetags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TaskCount": { "MarkdownDocumentation": "`TaskCount`\n\nThe number of tasks to create based on `TaskDefinition`. The default is\n1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PlacementStrategies": { "MarkdownDocumentation": "`PlacementStrategies`\n\nThe placement strategy objects to use for the task. You can specify a maximum of five\nstrategy rules per task.\n*Required*: No\n*Type*: Array of [PlacementStrategy](./aws-properties-events-rule-placementstrategy.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementstrategies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlacementStrategy", "DuplicatesAllowed": false }, "CapacityProviderStrategy": { "MarkdownDocumentation": "`CapacityProviderStrategy`\n\nThe capacity provider strategy to use for the task.\nIf a `capacityProviderStrategy` is specified, the `launchType`\nparameter must be omitted. If no `capacityProviderStrategy` or launchType is\nspecified, the `defaultCapacityProviderStrategy` for the cluster is used.\n*Required*: No\n*Type*: Array of [CapacityProviderStrategyItem](./aws-properties-events-rule-capacityproviderstrategyitem.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-capacityproviderstrategy", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CapacityProviderStrategyItem", "DuplicatesAllowed": false }, "LaunchType": { "MarkdownDocumentation": "`LaunchType`\n\nSpecifies the launch type on which your task is running. The launch type that you specify\nhere must match one of the launch type (compatibilities) of the target task. The\n`FARGATE` value is supported only in the Regions where AWS Fargate\nwith 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\nGuide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `EC2 | FARGATE | EXTERNAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EC2", "FARGATE", "EXTERNAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReferenceId": { "MarkdownDocumentation": "`ReferenceId`\n\nThe reference ID to use for the task.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-referenceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagList": { "MarkdownDocumentation": "`TagList`\n\nThe metadata that you apply to the task to help you categorize and organize them. Each tag\nconsists 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*: Array of [Tag](./aws-properties-events-rule-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taglist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nUse this structure if the Amazon ECS task uses the `awsvpc` network\nmode. This structure specifies the VPC subnets and security groups associated with the task,\nand whether a public IP address is to be used. This structure is required if\n`LaunchType` is `FARGATE` because the `awsvpc` mode is\nrequired for Fargate tasks.\nIf you specify `NetworkConfiguration` when the target ECS task does not use the\n`awsvpc` network mode, the task fails.\n*Required*: No\n*Type*: [NetworkConfiguration](./aws-properties-events-rule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NetworkConfiguration" }, "TaskDefinitionArn": { "MarkdownDocumentation": "`TaskDefinitionArn`\n\nThe ARN of the task definition to use if the event target is an Amazon ECS task.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Rule.HttpParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.HttpParameters`\n\nThese are custom parameter to be used when the target is an API Gateway APIs or\nEventBridge ApiDestinations. In the latter case, these are merged with any\nInvocationParameters specified on the Connection, with any values from the Connection taking\nprecedence.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html", "Properties": { "PathParameterValues": { "MarkdownDocumentation": "`PathParameterValues`\n\nThe path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards (\"\\*\").\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-pathparametervalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HeaderParameters": { "MarkdownDocumentation": "`HeaderParameters`\n\nThe headers that need to be sent as part of request invoking the API Gateway API or\nEventBridge ApiDestination.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-headerparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "QueryStringParameters": { "MarkdownDocumentation": "`QueryStringParameters`\n\nThe query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-querystringparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::Events::Rule.InputTransformer": { "MarkdownDocumentation": "`AWS::Events::Rule.InputTransformer`\n\nContains the parameters needed for you to provide custom input to a target based on one or\nmore pieces of data extracted from the event.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html", "Properties": { "InputPathsMap": { "MarkdownDocumentation": "`InputPathsMap`\n\nMap of JSON paths to be extracted from the event. You can then insert these in the\ntemplate in `InputTemplate` to produce the output you want to be sent to the\ntarget.\n`InputPathsMap` is an array key-value pairs, where each value is a valid JSON\npath. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket\nnotation.\nThe keys cannot start with \"AWS.\"\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "InputTemplate": { "MarkdownDocumentation": "`InputTemplate`\n\nInput template where you specify placeholders that will be filled with the values of the\nkeys from `InputPathsMap` to customize the data sent to the target. Enclose each\n`InputPathsMaps` value in brackets: <*value*>\nIf `InputTemplate` is a JSON object (surrounded by curly braces), the following\nrestrictions apply:\n* The placeholder cannot be used as an object key.\nThe following example shows the syntax for using `InputPathsMap` and\n`InputTemplate`.\n `\"InputTransformer\":`\n`{`\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n\"$.detail.status\"},`\n`\"InputTemplate\": \" is in state \"`\n`}`\nTo have the `InputTemplate` include quote marks within a JSON string, escape\neach quote marks with a slash, as in the following example:\n `\"InputTransformer\":`\n`{`\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n\"$.detail.status\"},`\n`\"InputTemplate\": \" is in state \\\"\\\"\"`\n`}`\nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as\nin the following example:\n `\"InputTransformer\":`\n`{`\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n\"$.detail.status\"},`\n`\"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is\nin state \\\"\\\"\"}'`\n`}`\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Rule.KinesisParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.KinesisParameters`\n\nThis object enables you to specify a JSON path to extract from the event and use as the\npartition key for the Amazon Kinesis data stream, so that you can control the shard to which\nthe event goes. If you do not include this parameter, the default is to use the\n`eventId` as the partition key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html", "Properties": { "PartitionKeyPath": { "MarkdownDocumentation": "`PartitionKeyPath`\n\nThe JSON path to be extracted from the event and used as the partition key. For more\ninformation, see [Amazon Kinesis Streams Key\nConcepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) in the *Amazon Kinesis Streams Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Rule.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::Events::Rule.NetworkConfiguration`\n\nThis structure specifies the network configuration for an ECS task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html", "Properties": { "AwsVpcConfiguration": { "MarkdownDocumentation": "`AwsVpcConfiguration`\n\nUse this structure to specify the VPC subnets and security groups for the task, and\nwhether a public IP address is to be used. This structure is relevant only for ECS tasks that\nuse the `awsvpc` network mode.\n*Required*: No\n*Type*: [AwsVpcConfiguration](./aws-properties-events-rule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AwsVpcConfiguration" } } }, "AWS::Events::Rule.PlacementConstraint": { "MarkdownDocumentation": "`AWS::Events::Rule.PlacementConstraint`\n\nAn object representing a constraint on task placement. To learn more, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of constraint. Use distinctInstance to ensure that each task in a particular\ngroup is running on a different container instance. Use memberOf to restrict the selection to\na group of valid candidates.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "distinctInstance", "memberOf" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nA cluster query language expression to apply to the constraint. You cannot specify an\nexpression 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Events::Rule.PlacementStrategy": { "MarkdownDocumentation": "`AWS::Events::Rule.PlacementStrategy`\n\nThe task placement strategy for a task or service. To learn more, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer\nGuide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field to apply the placement strategy against. For the spread placement strategy,\nvalid values are instanceId (or host, which has the same effect), or any platform or custom\nattribute that is applied to a container instance, such as attribute:ecs.availability-zone.\nFor the binpack placement strategy, valid values are cpu and memory. For the random placement\nstrategy, this field is not used.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of placement strategy. The random placement strategy randomly places tasks on\navailable candidates. The spread placement strategy spreads placement across available\ncandidates evenly based on the field parameter. The binpack strategy places tasks on available\ncandidates that have the least available amount of the resource that is specified with the\nfield parameter. For example, if you binpack on memory, a task is placed on the instance with\nthe least amount of remaining memory (but still enough to run the task).\n*Required*: No\n*Type*: String\n*Allowed values*: `random | spread | binpack...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "random", "spread", "binpack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Events::Rule.RedshiftDataParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.RedshiftDataParameters`\n\nThese are custom parameters to be used when the target is a Amazon Redshift cluster\nto invoke the Amazon Redshift Data API\nExecuteStatement based on EventBridge events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html", "Properties": { "StatementName": { "MarkdownDocumentation": "`StatementName`\n\nThe name of the SQL statement. You can name the SQL statement when you create it to\nidentify the query.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-statementname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Sqls": { "MarkdownDocumentation": "`Sqls`\n\nOne or more SQL statements to run. The SQL statements are run as a single transaction.\nThey run serially in the order of the array. Subsequent SQL statements don't start until the\nprevious statement in the array completes. If any SQL statement fails, then because they are\nrun as one transaction, all work is rolled back.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sqls", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Database": { "MarkdownDocumentation": "`Database`\n\nThe name of the database. Required when authenticating using temporary credentials.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretManagerArn": { "MarkdownDocumentation": "`SecretManagerArn`\n\nThe name or ARN of the secret that enables access to the database. Required when\nauthenticating using AWS Secrets Manager.\n*Required*: No\n*Type*: String\n*Pattern*: `(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-secretmanagerarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DbUser": { "MarkdownDocumentation": "`DbUser`\n\nThe database user name. Required when authenticating using temporary credentials.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-dbuser", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Sql": { "MarkdownDocumentation": "`Sql`\n\nThe SQL statement text to run.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sql", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WithEvent": { "MarkdownDocumentation": "`WithEvent`\n\nIndicates whether to send an event back to EventBridge after the SQL statement\nruns.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-withevent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Events::Rule.RetryPolicy": { "MarkdownDocumentation": "`AWS::Events::Rule.RetryPolicy`\n\nA `RetryPolicy` object that includes information about the retry policy\nsettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html", "Properties": { "MaximumRetryAttempts": { "MarkdownDocumentation": "`MaximumRetryAttempts`\n\nThe maximum number of retry attempts to make before the request fails. Retry attempts\ncontinue until either the maximum number of attempts is made or until the duration of the\n`MaximumEventAgeInSeconds` is met.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `185`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumretryattempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumEventAgeInSeconds": { "MarkdownDocumentation": "`MaximumEventAgeInSeconds`\n\nThe maximum amount of time, in seconds, to continue to make retry attempts.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `86400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumeventageinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Events::Rule.RunCommandParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.RunCommandParameters`\n\nThis parameter contains the criteria (either InstanceIds or a tag) used to specify which\nEC2 instances are to be sent the command.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html", "Properties": { "RunCommandTargets": { "MarkdownDocumentation": "`RunCommandTargets`\n\nCurrently, we support including only one RunCommandTarget block, which specifies either an\narray of InstanceIds or a tag.\n*Required*: Yes\n*Type*: Array of [RunCommandTarget](./aws-properties-events-rule-runcommandtarget.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RunCommandTarget", "DuplicatesAllowed": false } } }, "AWS::Events::Rule.RunCommandTarget": { "MarkdownDocumentation": "`AWS::Events::Rule.RunCommandTarget`\n\nInformation about the EC2 instances that are to be sent the command, specified as\nkey-value pairs. Each `RunCommandTarget` block can include only one key, but this\nkey may specify multiple values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nIf `Key` is `tag:`*tag-key*, `Values`\nis a list of tag values. If `Key` is `InstanceIds`, `Values`\nis a list of Amazon EC2 instance IDs.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Key": { "MarkdownDocumentation": "`Key`\n\nCan be either `tag:`*tag-key* or\n`InstanceIds`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Rule.SageMakerPipelineParameter": { "MarkdownDocumentation": "`AWS::Events::Rule.SageMakerPipelineParameter`\n\nName/Value pair of a parameter to start execution of a SageMaker AI Model Building\nPipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nValue of parameter to start execution of a SageMaker AI Model Building\nPipeline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of parameter to start execution of a SageMaker AI Model Building\nPipeline.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Rule.SageMakerPipelineParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.SageMakerPipelineParameters`\n\nThese are custom parameters to use when the target is a SageMaker AI Model Building\nPipeline that starts based on EventBridge events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html", "Properties": { "PipelineParameterList": { "MarkdownDocumentation": "`PipelineParameterList`\n\nList of Parameter names and values for SageMaker AI Model Building Pipeline\nexecution.\n*Required*: No\n*Type*: Array of [SageMakerPipelineParameter](./aws-properties-events-rule-sagemakerpipelineparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html#cfn-events-rule-sagemakerpipelineparameters-pipelineparameterlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SageMakerPipelineParameter", "DuplicatesAllowed": false } } }, "AWS::Events::Rule.SqsParameters": { "MarkdownDocumentation": "`AWS::Events::Rule.SqsParameters`\n\nThe custom parameters for EventBridge to use for a target that is an Amazon SQS fair or FIFO queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html", "Properties": { "MessageGroupId": { "MarkdownDocumentation": "`MessageGroupId`\n\nThe ID of the message group to use as the target.\n*Required*: Yes\n*Type*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html#cfn-events-rule-sqsparameters-messagegroupid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Events::Rule.Target": { "MarkdownDocumentation": "`AWS::Events::Rule.Target`\n\nTargets are the resources to be invoked when a rule is triggered. For a complete list of\nservices and resources that can be set as a target, see [PutTargets](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html).\nIf you are setting the event bus of another account as the target, and that account\ngranted permission to your account through an organization instead of directly by the account\nID, then you must specify a `RoleArn` with proper permissions in the\n`Target` structure. For more information, see [Sending and\nReceiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html", "Properties": { "InputPath": { "MarkdownDocumentation": "`InputPath`\n\nThe value of the JSONPath that is used for extracting part of the matched event when\npassing it to the target. You may use JSON dot notation or bracket notation. For more\ninformation about JSON paths, see [JSONPath](http://goessner.net/articles/JsonPath/).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpParameters": { "MarkdownDocumentation": "`HttpParameters`\n\nContains the HTTP parameters to use when the target is a API Gateway endpoint or\nEventBridge ApiDestination.\nIf you specify an API Gateway API or EventBridge ApiDestination as a target,\nyou can use this parameter to specify headers, path parameters, and query string keys/values\nas part of your target invoking request. If you're using ApiDestinations, the corresponding\nConnection can also have these values configured. In case of any conflicting keys, values from\nthe Connection take precedence.\n*Required*: No\n*Type*: [HttpParameters](./aws-properties-events-rule-httpparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-httpparameters", "UpdateType": "Mutable", "Required": false, "Type": "HttpParameters" }, "DeadLetterConfig": { "MarkdownDocumentation": "`DeadLetterConfig`\n\nThe `DeadLetterConfig` that defines the target queue to send dead-letter queue\nevents to.\n*Required*: No\n*Type*: [DeadLetterConfig](./aws-properties-events-rule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig", "UpdateType": "Mutable", "Required": false, "Type": "DeadLetterConfig" }, "RunCommandParameters": { "MarkdownDocumentation": "`RunCommandParameters`\n\nParameters used when you are using the rule to invoke Amazon EC2 Run Command.\n*Required*: No\n*Type*: [RunCommandParameters](./aws-properties-events-rule-runcommandparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters", "UpdateType": "Mutable", "Required": false, "Type": "RunCommandParameters" }, "InputTransformer": { "MarkdownDocumentation": "`InputTransformer`\n\nSettings to enable you to provide custom input to a target based on certain event data.\nYou can extract one or more key-value pairs from the event and then use that data to send\ncustomized input to the target.\n*Required*: No\n*Type*: [InputTransformer](./aws-properties-events-rule-inputtransformer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer", "UpdateType": "Mutable", "Required": false, "Type": "InputTransformer" }, "KinesisParameters": { "MarkdownDocumentation": "`KinesisParameters`\n\nThe custom parameter you can use to control the shard assignment, when the target is a\nKinesis data stream. If you do not include this parameter, the default is to use the\n`eventId` as the partition key.\n*Required*: No\n*Type*: [KinesisParameters](./aws-properties-events-rule-kinesisparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters", "UpdateType": "Mutable", "Required": false, "Type": "KinesisParameters" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is\ntriggered. If one rule triggers multiple targets, you can use a different IAM role for each\ntarget.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RedshiftDataParameters": { "MarkdownDocumentation": "`RedshiftDataParameters`\n\nContains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.\nIf you specify a Amazon Redshift Cluster as a Target, you can use this to specify\nparameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.\n*Required*: No\n*Type*: [RedshiftDataParameters](./aws-properties-events-rule-redshiftdataparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-redshiftdataparameters", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftDataParameters" }, "AppSyncParameters": { "MarkdownDocumentation": "`AppSyncParameters`\n\nContains the GraphQL operation to be parsed and executed, if the event target is an\nAWS AppSync API.\n*Required*: No\n*Type*: [AppSyncParameters](./aws-properties-events-rule-appsyncparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-appsyncparameters", "UpdateType": "Mutable", "Required": false, "Type": "AppSyncParameters" }, "Input": { "MarkdownDocumentation": "`Input`\n\nValid JSON text passed to the target. In this case, nothing from the event itself is\npassed to the target. For more information, see [The JavaScript Object Notation (JSON) Data\nInterchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SqsParameters": { "MarkdownDocumentation": "`SqsParameters`\n\nContains the message group ID to use when the target is an Amazon SQS fair or FIFO queue.\nIf you specify a fair or FIFO queue as a target, the queue must have content-based\ndeduplication enabled.\n*Required*: No\n*Type*: [SqsParameters](./aws-properties-events-rule-sqsparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sqsparameters", "UpdateType": "Mutable", "Required": false, "Type": "SqsParameters" }, "EcsParameters": { "MarkdownDocumentation": "`EcsParameters`\n\nContains the Amazon ECS task definition and task count to be used, if the event target is\nan Amazon ECS task. For more information about Amazon ECS tasks, see [Task\nDefinitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon EC2 Container Service Developer\nGuide*.\n*Required*: No\n*Type*: [EcsParameters](./aws-properties-events-rule-ecsparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters", "UpdateType": "Mutable", "Required": false, "Type": "EcsParameters" }, "BatchParameters": { "MarkdownDocumentation": "`BatchParameters`\n\nIf the event target is an AWS Batch job, this contains the job definition, job\nname, and other parameters. For more information, see [Jobs](https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the *AWS Batch\nUser Guide*.\n*Required*: No\n*Type*: [BatchParameters](./aws-properties-events-rule-batchparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-batchparameters", "UpdateType": "Mutable", "Required": false, "Type": "BatchParameters" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the target within the specified rule. Use this ID to reference the target when\nupdating the rule. We recommend using a memorable and unique string.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\.\\-_A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the target.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SageMakerPipelineParameters": { "MarkdownDocumentation": "`SageMakerPipelineParameters`\n\nContains the SageMaker AI Model Building Pipeline parameters to start execution of a\nSageMaker AI Model Building Pipeline.\nIf you specify a SageMaker AI Model Building Pipeline as a target, you can use this\nto specify parameters to start a pipeline execution based on EventBridge events.\n*Required*: No\n*Type*: [SageMakerPipelineParameters](./aws-properties-events-rule-sagemakerpipelineparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sagemakerpipelineparameters", "UpdateType": "Mutable", "Required": false, "Type": "SageMakerPipelineParameters" }, "RetryPolicy": { "MarkdownDocumentation": "`RetryPolicy`\n\nThe retry policy configuration to use\nfor the dead-letter queue.\n*Required*: No\n*Type*: [RetryPolicy](./aws-properties-events-rule-retrypolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy", "UpdateType": "Mutable", "Required": false, "Type": "RetryPolicy" } } }, "AWS::Evidently::Experiment.MetricGoalObject": { "MarkdownDocumentation": "`AWS::Evidently::Experiment.MetricGoalObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html", "Properties": { "EntityIdKey": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-entityidkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DesiredChange": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-desiredchange", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EventPattern": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-eventpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueKey": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-valuekey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UnitLabel": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-unitlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Evidently::Experiment.OnlineAbConfigObject": { "MarkdownDocumentation": "`AWS::Evidently::Experiment.OnlineAbConfigObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-onlineabconfigobject.html", "Properties": { "TreatmentWeights": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-onlineabconfigobject.html#cfn-evidently-experiment-onlineabconfigobject-treatmentweights", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TreatmentToWeight", "DuplicatesAllowed": false }, "ControlTreatmentName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-onlineabconfigobject.html#cfn-evidently-experiment-onlineabconfigobject-controltreatmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Evidently::Experiment.RunningStatusObject": { "MarkdownDocumentation": "`AWS::Evidently::Experiment.RunningStatusObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html", "Properties": { "Status": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DesiredState": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-desiredstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AnalysisCompleteTime": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-analysiscompletetime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Reason": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-reason", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Evidently::Experiment.TreatmentObject": { "MarkdownDocumentation": "`AWS::Evidently::Experiment.TreatmentObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html", "Properties": { "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Variation": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-variation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Feature": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-feature", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TreatmentName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-treatmentname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Evidently::Experiment.TreatmentToWeight": { "MarkdownDocumentation": "`AWS::Evidently::Experiment.TreatmentToWeight`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmenttoweight.html", "Properties": { "Treatment": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmenttoweight.html#cfn-evidently-experiment-treatmenttoweight-treatment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SplitWeight": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmenttoweight.html#cfn-evidently-experiment-treatmenttoweight-splitweight", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Evidently::Feature.EntityOverride": { "MarkdownDocumentation": "`AWS::Evidently::Feature.EntityOverride`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-entityoverride.html", "Properties": { "EntityId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-entityoverride.html#cfn-evidently-feature-entityoverride-entityid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Variation": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-entityoverride.html#cfn-evidently-feature-entityoverride-variation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Evidently::Feature.VariationObject": { "MarkdownDocumentation": "`AWS::Evidently::Feature.VariationObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html", "Properties": { "VariationName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-variationname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DoubleValue": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-doublevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "BooleanValue": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-booleanvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LongValue": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-longvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StringValue": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-stringvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Evidently::Launch.ExecutionStatusObject": { "MarkdownDocumentation": "`AWS::Evidently::Launch.ExecutionStatusObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html", "Properties": { "Status": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DesiredState": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-desiredstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Reason": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-reason", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Evidently::Launch.GroupToWeight": { "MarkdownDocumentation": "`AWS::Evidently::Launch.GroupToWeight`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html", "Properties": { "GroupName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html#cfn-evidently-launch-grouptoweight-groupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SplitWeight": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html#cfn-evidently-launch-grouptoweight-splitweight", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Evidently::Launch.LaunchGroupObject": { "MarkdownDocumentation": "`AWS::Evidently::Launch.LaunchGroupObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html", "Properties": { "GroupName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-groupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Variation": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-variation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Feature": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-feature", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Evidently::Launch.MetricDefinitionObject": { "MarkdownDocumentation": "`AWS::Evidently::Launch.MetricDefinitionObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html", "Properties": { "EntityIdKey": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-entityidkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EventPattern": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-eventpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueKey": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-valuekey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UnitLabel": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-unitlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Evidently::Launch.SegmentOverride": { "MarkdownDocumentation": "`AWS::Evidently::Launch.SegmentOverride`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html", "Properties": { "Weights": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-weights", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GroupToWeight", "DuplicatesAllowed": false }, "EvaluationOrder": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-evaluationorder", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Segment": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-segment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Evidently::Launch.StepConfig": { "MarkdownDocumentation": "`AWS::Evidently::Launch.StepConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html", "Properties": { "GroupWeights": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-groupweights", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GroupToWeight", "DuplicatesAllowed": false }, "SegmentOverrides": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-segmentoverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SegmentOverride", "DuplicatesAllowed": false }, "StartTime": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-starttime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Evidently::Project.AppConfigResourceObject": { "MarkdownDocumentation": "`AWS::Evidently::Project.AppConfigResourceObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html", "Properties": { "EnvironmentId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html#cfn-evidently-project-appconfigresourceobject-environmentid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApplicationId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html#cfn-evidently-project-appconfigresourceobject-applicationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Evidently::Project.DataDeliveryObject": { "MarkdownDocumentation": "`AWS::Evidently::Project.DataDeliveryObject`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.html", "Properties": { "S3": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.html#cfn-evidently-project-datadeliveryobject-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3Destination" }, "LogGroup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.html#cfn-evidently-project-datadeliveryobject-loggroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Evidently::Project.S3Destination": { "MarkdownDocumentation": "`AWS::Evidently::Project.S3Destination`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.html", "Properties": { "BucketName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.html#cfn-evidently-project-s3destination-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.html#cfn-evidently-project-s3destination-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FIS::ExperimentTemplate.CloudWatchDashboard": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.CloudWatchDashboard`\n\nThe CloudWatch dashboards to include as data sources in the experiment report.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-cloudwatchdashboard.html", "Properties": { "DashboardIdentifier": { "MarkdownDocumentation": "`DashboardIdentifier`\n\nThe Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-cloudwatchdashboard.html#cfn-fis-experimenttemplate-cloudwatchdashboard-dashboardidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FIS::ExperimentTemplate.CloudWatchLogsConfiguration": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.CloudWatchLogsConfiguration`\n\nSpecifies the configuration for experiment logging to CloudWatch Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-cloudwatchlogsconfiguration.html", "Properties": { "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-cloudwatchlogsconfiguration.html#cfn-fis-experimenttemplate-cloudwatchlogsconfiguration-loggrouparn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FIS::ExperimentTemplate.DataSources": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.DataSources`\n\nDescribes the data sources for the experiment report.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-datasources.html", "Properties": { "CloudWatchDashboards": { "MarkdownDocumentation": "`CloudWatchDashboards`\n\nThe CloudWatch dashboards to include as data sources in the experiment report.\n*Required*: No\n*Type*: Array of [CloudWatchDashboard](./aws-properties-fis-experimenttemplate-cloudwatchdashboard.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-datasources.html#cfn-fis-experimenttemplate-datasources-cloudwatchdashboards", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CloudWatchDashboard", "DuplicatesAllowed": true } } }, "AWS::FIS::ExperimentTemplate.ExperimentReportS3Configuration": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.ExperimentReportS3Configuration`\n\nThe S3 destination for the experiment report.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimentreports3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the S3 bucket where the experiment report will be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimentreports3configuration.html#cfn-fis-experimenttemplate-experimentreports3configuration-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe prefix of the S3 bucket where the experiment report will be stored.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimentreports3configuration.html#cfn-fis-experimenttemplate-experimentreports3configuration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FIS::ExperimentTemplate.ExperimentTemplateAction": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.ExperimentTemplateAction`\n\nSpecifies an action for an experiment template.\nFor more information, see [Actions](https://docs.aws.amazon.com/fis/latest/userguide/actions.html)\nin the *AWS Fault Injection Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateaction.html", "Properties": { "ActionId": { "MarkdownDocumentation": "`ActionId`\n\nThe ID of the action.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateaction.html#cfn-fis-experimenttemplate-experimenttemplateaction-actionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the action.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateaction.html#cfn-fis-experimenttemplate-experimenttemplateaction-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters for the action.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,64}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateaction.html#cfn-fis-experimenttemplate-experimenttemplateaction-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe targets for the action.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,64}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateaction.html#cfn-fis-experimenttemplate-experimenttemplateaction-targets", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "StartAfter": { "MarkdownDocumentation": "`StartAfter`\n\nThe name of the action that must be completed before the current action starts.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateaction.html#cfn-fis-experimenttemplate-experimenttemplateaction-startafter", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::FIS::ExperimentTemplate.ExperimentTemplateExperimentOptions": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.ExperimentTemplateExperimentOptions`\n\nDescribes the experiment options for an experiment template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateexperimentoptions.html", "Properties": { "EmptyTargetResolutionMode": { "MarkdownDocumentation": "`EmptyTargetResolutionMode`\n\nThe empty target resolution mode for an experiment template.\n*Required*: No\n*Type*: String\n*Allowed values*: `fail | skip...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "fail", "skip" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateexperimentoptions.html#cfn-fis-experimenttemplate-experimenttemplateexperimentoptions-emptytargetresolutionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccountTargeting": { "MarkdownDocumentation": "`AccountTargeting`\n\nThe account targeting setting for an experiment template.\n*Required*: No\n*Type*: String\n*Allowed values*: `multi-account | single-acco...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "multi-account", "single-account" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateexperimentoptions.html#cfn-fis-experimenttemplate-experimenttemplateexperimentoptions-accounttargeting", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FIS::ExperimentTemplate.ExperimentTemplateExperimentReportConfiguration": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.ExperimentTemplateExperimentReportConfiguration`\n\nDescribes the report configuration for the experiment template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration.html", "Properties": { "DataSources": { "MarkdownDocumentation": "`DataSources`\n\nThe data sources for the experiment report.\n*Required*: No\n*Type*: [DataSources](./aws-properties-fis-experimenttemplate-datasources.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration.html#cfn-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration-datasources", "UpdateType": "Mutable", "Required": false, "Type": "DataSources" }, "PostExperimentDuration": { "MarkdownDocumentation": "`PostExperimentDuration`\n\nThe duration after the experiment end time for the data sources to include in the report.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\S]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration.html#cfn-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration-postexperimentduration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Outputs": { "MarkdownDocumentation": "`Outputs`\n\nThe output destinations of the experiment report.\n*Required*: Yes\n*Type*: [Outputs](./aws-properties-fis-experimenttemplate-outputs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration.html#cfn-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration-outputs", "UpdateType": "Mutable", "Required": true, "Type": "Outputs" }, "PreExperimentDuration": { "MarkdownDocumentation": "`PreExperimentDuration`\n\nThe duration before the experiment start time for the data sources to include in the report.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\S]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration.html#cfn-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration-preexperimentduration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FIS::ExperimentTemplate.ExperimentTemplateLogConfiguration": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.ExperimentTemplateLogConfiguration`\n\nSpecifies the configuration for experiment logging.\nFor more information, see [Experiment logging](https://docs.aws.amazon.com/fis/latest/userguide/monitoring-logging.html)\nin the *AWS Fault Injection Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatelogconfiguration.html", "Properties": { "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nThe configuration for experiment logging to Amazon S3.\n*Required*: No\n*Type*: [S3Configuration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatelogconfiguration.html#cfn-fis-experimenttemplate-experimenttemplatelogconfiguration-s3configuration", "UpdateType": "Mutable", "Required": false, "Type": "S3Configuration" }, "LogSchemaVersion": { "MarkdownDocumentation": "`LogSchemaVersion`\n\nThe schema version.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatelogconfiguration.html#cfn-fis-experimenttemplate-experimenttemplatelogconfiguration-logschemaversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "CloudWatchLogsConfiguration": { "MarkdownDocumentation": "`CloudWatchLogsConfiguration`\n\nThe configuration for experiment logging to CloudWatch Logs.\n*Required*: No\n*Type*: [CloudWatchLogsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatelogconfiguration.html#cfn-fis-experimenttemplate-experimenttemplatelogconfiguration-cloudwatchlogsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLogsConfiguration" } } }, "AWS::FIS::ExperimentTemplate.ExperimentTemplateStopCondition": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.ExperimentTemplateStopCondition`\n\nSpecifies a stop condition for an experiment template.\nFor more information, see [Stop conditions](https://docs.aws.amazon.com/fis/latest/userguide/stop-conditions.html)\nin the *AWS Fault Injection Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatestopcondition.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatestopcondition.html#cfn-fis-experimenttemplate-experimenttemplatestopcondition-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source for the stop condition.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatestopcondition.html#cfn-fis-experimenttemplate-experimenttemplatestopcondition-source", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FIS::ExperimentTemplate.ExperimentTemplateTarget": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.ExperimentTemplateTarget`\n\nSpecifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or\nat least one resource tag. You cannot specify both ARNs and tags.\nFor more information, see [Targets](https://docs.aws.amazon.com/fis/latest/userguide/targets.html)\nin the *AWS Fault Injection Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetarget.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe filters to apply to identify target resources using specific attributes.\n*Required*: No\n*Type*: Array of [ExperimentTemplateTargetFilter](./aws-properties-fis-experimenttemplate-experimenttemplatetargetfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetarget.html#cfn-fis-experimenttemplate-experimenttemplatetarget-filters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ExperimentTemplateTargetFilter", "DuplicatesAllowed": true }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters for the resource type.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,64}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetarget.html#cfn-fis-experimenttemplate-experimenttemplatetarget-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nThe tags for the target resources.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,128}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetarget.html#cfn-fis-experimenttemplate-experimenttemplatetarget-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe resource type.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetarget.html#cfn-fis-experimenttemplate-experimenttemplatetarget-resourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceArns": { "MarkdownDocumentation": "`ResourceArns`\n\nThe Amazon Resource Names (ARNs) of the targets.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetarget.html#cfn-fis-experimenttemplate-experimenttemplatetarget-resourcearns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SelectionMode": { "MarkdownDocumentation": "`SelectionMode`\n\nScopes the identified resources to a specific count or percentage.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetarget.html#cfn-fis-experimenttemplate-experimenttemplatetarget-selectionmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FIS::ExperimentTemplate.ExperimentTemplateTargetFilter": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.ExperimentTemplateTargetFilter`\n\nSpecifies a filter used for the target resource input in an experiment template.\nFor more information, see [Resource filters](https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters)\nin the *AWS Fault Injection Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetargetfilter.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe attribute path for the filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetargetfilter.html#cfn-fis-experimenttemplate-experimenttemplatetargetfilter-path", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe attribute values for the filter.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetargetfilter.html#cfn-fis-experimenttemplate-experimenttemplatetargetfilter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::FIS::ExperimentTemplate.Outputs": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.Outputs`\n\nDescribes the output destinations of the experiment report.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-outputs.html", "Properties": { "ExperimentReportS3Configuration": { "MarkdownDocumentation": "`ExperimentReportS3Configuration`\n\nThe S3 destination for the experiment report.\n*Required*: Yes\n*Type*: [ExperimentReportS3Configuration](./aws-properties-fis-experimenttemplate-experimentreports3configuration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-outputs.html#cfn-fis-experimenttemplate-outputs-experimentreports3configuration", "UpdateType": "Mutable", "Required": true, "Type": "ExperimentReportS3Configuration" } } }, "AWS::FIS::ExperimentTemplate.S3Configuration": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate.S3Configuration`\n\nSpecifies the configuration for experiment logging to Amazon S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-s3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the destination bucket.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-s3configuration.html#cfn-fis-experimenttemplate-s3configuration-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe bucket prefix.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `700`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-s3configuration.html#cfn-fis-experimenttemplate-s3configuration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FMS::Policy.IEMap": { "MarkdownDocumentation": "`AWS::FMS::Policy.IEMap`\n\nSpecifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in or exclude from the policy.\nSpecifying 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.\nThis is used for the policy's `IncludeMap` and `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:\n `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d]}`.\n* Specify OUs by setting the key to `ORGUNIT`. For example, the following is a valid map:\n `{\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:\n `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d], \u201cORGUNIT\u201d : [\u201couid111\u201d, \u201couid112\u201d]}`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-iemap.html", "Properties": { "ACCOUNT": { "MarkdownDocumentation": "`ACCOUNT`\n\nThe account list for the map.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-iemap.html#cfn-fms-policy-iemap-account", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ORGUNIT": { "MarkdownDocumentation": "`ORGUNIT`\n\nThe organizational unit list for the map.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-iemap.html#cfn-fms-policy-iemap-orgunit", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::FMS::Policy.IcmpTypeCode": { "MarkdownDocumentation": "`AWS::FMS::Policy.IcmpTypeCode`\n\nICMP protocol: The ICMP type and code.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-icmptypecode.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nICMP type.\n*Required*: Yes\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-icmptypecode.html#cfn-fms-policy-icmptypecode-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Code": { "MarkdownDocumentation": "`Code`\n\nICMP code.\n*Required*: Yes\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-icmptypecode.html#cfn-fms-policy-icmptypecode-code", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::FMS::Policy.NetworkAclCommonPolicy": { "MarkdownDocumentation": "`AWS::FMS::Policy.NetworkAclCommonPolicy`\n\nDefines a Firewall Manager network ACL policy. This is used in the `PolicyOption` of a `SecurityServicePolicyData` for a `Policy`, when\nthe `SecurityServicePolicyData` type is set to `NETWORK_ACL_COMMON`.\nFor information about network ACLs, see\n[Control traffic to subnets using network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html)\nin the *Amazon Virtual Private Cloud User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclcommonpolicy.html", "Properties": { "NetworkAclEntrySet": { "MarkdownDocumentation": "`NetworkAclEntrySet`\n\nThe definition of the first and last rules for the network ACL policy.\n*Required*: Yes\n*Type*: [NetworkAclEntrySet](./aws-properties-fms-policy-networkaclentryset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclcommonpolicy.html#cfn-fms-policy-networkaclcommonpolicy-networkaclentryset", "UpdateType": "Mutable", "Required": true, "Type": "NetworkAclEntrySet" } } }, "AWS::FMS::Policy.NetworkAclEntry": { "MarkdownDocumentation": "`AWS::FMS::Policy.NetworkAclEntry`\n\nDescribes a rule in a network ACL.\nEach network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining\nwhether a packet should be allowed in or out of a subnet associated with the network ACL, AWS processes the\nentries in the network ACL according to the rule numbers, in ascending order.\nWhen you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy,\nyou provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order\nthat you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentry.html", "Properties": { "PortRange": { "MarkdownDocumentation": "`PortRange`\n\nTCP or UDP protocols: The range of ports the rule applies to.\n*Required*: No\n*Type*: [PortRange](./aws-properties-fms-policy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentry.html#cfn-fms-policy-networkaclentry-portrange", "UpdateType": "Mutable", "Required": false, "Type": "PortRange" }, "IcmpTypeCode": { "MarkdownDocumentation": "`IcmpTypeCode`\n\nICMP protocol: The ICMP type and code.\n*Required*: No\n*Type*: [IcmpTypeCode](./aws-properties-fms-policy-icmptypecode.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentry.html#cfn-fms-policy-networkaclentry-icmptypecode", "UpdateType": "Mutable", "Required": false, "Type": "IcmpTypeCode" }, "RuleAction": { "MarkdownDocumentation": "`RuleAction`\n\nIndicates whether to allow or deny the traffic that matches the rule.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `allow | deny...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "allow", "deny" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentry.html#cfn-fms-policy-networkaclentry-ruleaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CidrBlock": { "MarkdownDocumentation": "`CidrBlock`\n\nThe IPv4 network range to allow or deny, in CIDR notation.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2]))$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentry.html#cfn-fms-policy-networkaclentry-cidrblock", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Egress": { "MarkdownDocumentation": "`Egress`\n\nIndicates whether the rule is an egress, or outbound, rule (applied to traffic leaving the subnet). If it's not\nan egress rule, then it's an ingress, or inbound, rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentry.html#cfn-fms-policy-networkaclentry-egress", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Ipv6CidrBlock": { "MarkdownDocumentation": "`Ipv6CidrBlock`\n\nThe IPv6 network range to allow or deny, in CIDR notation.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([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]))(/(1[0-2]|[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentry.html#cfn-fms-policy-networkaclentry-ipv6cidrblock", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol number. A value of \"-1\" means all protocols.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(tcp|udp|icmp|-1|([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentry.html#cfn-fms-policy-networkaclentry-protocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FMS::Policy.NetworkAclEntrySet": { "MarkdownDocumentation": "`AWS::FMS::Policy.NetworkAclEntrySet`\n\nThe configuration of the first and last rules for the network ACL policy, and the remediation settings for each.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentryset.html", "Properties": { "LastEntries": { "MarkdownDocumentation": "`LastEntries`\n\nThe rules that you want to run last in the Firewall Manager managed network ACLs.\n###### Note\nProvide these in the order in which you want them to run. Firewall Manager will assign\nthe specific rule numbers for you, in the network ACLs that it creates.\nYou must specify at least one first entry or one last entry in any network ACL policy.\n*Required*: No\n*Type*: Array of [NetworkAclEntry](./aws-properties-fms-policy-networkaclentry.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentryset.html#cfn-fms-policy-networkaclentryset-lastentries", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NetworkAclEntry", "DuplicatesAllowed": true }, "ForceRemediateForFirstEntries": { "MarkdownDocumentation": "`ForceRemediateForFirstEntries`\n\nApplies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy\nviolations that involve conflicts between the custom entries and the policy entries.\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to\nremediate. For more information about the remediation behavior, see\n[Remediation for managed network ACLs](https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation)\nin the *AWS Firewall Manager Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentryset.html#cfn-fms-policy-networkaclentryset-forceremediateforfirstentries", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "FirstEntries": { "MarkdownDocumentation": "`FirstEntries`\n\nThe rules that you want to run first in the Firewall Manager managed network ACLs.\n###### Note\nProvide these in the order in which you want them to run. Firewall Manager will assign\nthe specific rule numbers for you, in the network ACLs that it creates.\nYou must specify at least one first entry or one last entry in any network ACL policy.\n*Required*: No\n*Type*: Array of [NetworkAclEntry](./aws-properties-fms-policy-networkaclentry.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentryset.html#cfn-fms-policy-networkaclentryset-firstentries", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NetworkAclEntry", "DuplicatesAllowed": true }, "ForceRemediateForLastEntries": { "MarkdownDocumentation": "`ForceRemediateForLastEntries`\n\nApplies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy\nviolations that involve conflicts between the custom entries and the policy entries.\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to\nremediate. For more information about the remediation behavior, see\n[Remediation for managed network ACLs](https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation)\nin the *AWS Firewall Manager Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkaclentryset.html#cfn-fms-policy-networkaclentryset-forceremediateforlastentries", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::FMS::Policy.NetworkFirewallPolicy": { "MarkdownDocumentation": "`AWS::FMS::Policy.NetworkFirewallPolicy`\n\nConfigures the firewall policy deployment model of AWS Network Firewall. For information about\nNetwork Firewall deployment models, see [AWS Network Firewall example\narchitectures with routing](https://docs.aws.amazon.com/network-firewall/latest/developerguide/architectures.html) in the *Network Firewall Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html", "Properties": { "FirewallDeploymentModel": { "MarkdownDocumentation": "`FirewallDeploymentModel`\n\nDefines the deployment model to use for the firewall policy. To use a distributed model,\nset [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) to\n`DISTRIBUTED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DISTRIBUTED | CENTRALIZED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISTRIBUTED", "CENTRALIZED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html#cfn-fms-policy-networkfirewallpolicy-firewalldeploymentmodel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FMS::Policy.PolicyOption": { "MarkdownDocumentation": "`AWS::FMS::Policy.PolicyOption`\n\nContains the settings to configure a network ACL policy, a AWS Network Firewall firewall policy deployment model, or a third-party firewall policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policyoption.html", "Properties": { "NetworkFirewallPolicy": { "MarkdownDocumentation": "`NetworkFirewallPolicy`\n\nDefines the deployment model to use for the firewall policy.\n*Required*: No\n*Type*: [NetworkFirewallPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policyoption.html#cfn-fms-policy-policyoption-networkfirewallpolicy", "UpdateType": "Mutable", "Required": false, "Type": "NetworkFirewallPolicy" }, "NetworkAclCommonPolicy": { "MarkdownDocumentation": "`NetworkAclCommonPolicy`\n\nDefines a Firewall Manager network ACL policy.\n*Required*: No\n*Type*: [NetworkAclCommonPolicy](./aws-properties-fms-policy-networkaclcommonpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policyoption.html#cfn-fms-policy-policyoption-networkaclcommonpolicy", "UpdateType": "Mutable", "Required": false, "Type": "NetworkAclCommonPolicy" }, "ThirdPartyFirewallPolicy": { "MarkdownDocumentation": "`ThirdPartyFirewallPolicy`\n\nDefines the policy options for a third-party firewall policy.\n*Required*: No\n*Type*: [ThirdPartyFirewallPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policyoption.html#cfn-fms-policy-policyoption-thirdpartyfirewallpolicy", "UpdateType": "Mutable", "Required": false, "Type": "ThirdPartyFirewallPolicy" } } }, "AWS::FMS::Policy.PolicyTag": { "MarkdownDocumentation": "`AWS::FMS::Policy.PolicyTag`\n\nA collection of 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.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policytag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nPart 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*Pattern*: `^([^\\s]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policytag.html#cfn-fms-policy-policytag-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nPart 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*Pattern*: `^([^\\s]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policytag.html#cfn-fms-policy-policytag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FMS::Policy.PortRange": { "MarkdownDocumentation": "`AWS::FMS::Policy.PortRange`\n\nTCP or UDP protocols: The range of ports the rule applies to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-portrange.html", "Properties": { "From": { "MarkdownDocumentation": "`From`\n\nThe beginning port number of the range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-portrange.html#cfn-fms-policy-portrange-from", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "To": { "MarkdownDocumentation": "`To`\n\nThe ending port number of the range.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-portrange.html#cfn-fms-policy-portrange-to", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::FMS::Policy.ResourceTag": { "MarkdownDocumentation": "`AWS::FMS::Policy.ResourceTag`\n\nThe resource tags that AWS Firewall Manager uses to determine if a particular resource\nshould be included or excluded from the AWS Firewall Manager policy. Tags enable you to\ncategorize your AWS resources in different ways, for example, by purpose, owner, or\nenvironment. Each tag consists of a key and an optional value. Firewall Manager combines the\ntags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have\nall the specified tags to be included or excluded. For more information, see\n[Working with Tag Editor](https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-resourcetag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe resource tag value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-resourcetag.html#cfn-fms-policy-resourcetag-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe resource tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-resourcetag.html#cfn-fms-policy-resourcetag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FMS::Policy.SecurityServicePolicyData": { "MarkdownDocumentation": "`AWS::FMS::Policy.SecurityServicePolicyData`\n\nDetails about the security service that is being used to protect the resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-securityservicepolicydata.html", "Properties": { "ManagedServiceData": { "MarkdownDocumentation": "`ManagedServiceData`\n\nDetails about the service that are specific to the service type, in JSON format.\n* Example: `DNS_FIREWALL`\n \n `\"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"`\n \n ###### Note\n \n Valid values for `preProcessRuleGroups` are between 1 and 99. Valid\n values for `postProcessRuleGroups` are between 9901 and 10000.\n* Example: `NETWORK_FIREWALL` - Centralized deployment\n model\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}},\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n* Example: `NETWORK_FIREWALL` - Distributed deployment model with\n automatic Availability Zone configuration\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"OFF\\\"},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"`\n \n With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n* Example: `NETWORK_FIREWALL` - Distributed deployment model with\n automatic Availability Zone configuration and route management\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"]},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\": \\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n* Example: `NETWORK_FIREWALL` - Distributed deployment model with\n custom Availability Zone configuration\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\", \\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{ \\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"]}]} },\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"OFF\\\",\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"`\n \n With custom Availability Zone configuration,\n you define which specific Availability Zones to create endpoints in by configuring\n `firewallCreationConfig`. To configure the Availability Zones in `firewallCreationConfig`, specify either the `availabilityZoneName` or `availabilityZoneId` parameter, not both parameters.\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n* Example: `NETWORK_FIREWALL` - Distributed deployment model with\n custom Availability Zone configuration and route management\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"],\\\"routeManagementConfig\\\":{\\\"allowCrossAZTrafficIfNoEndpoint\\\":true}},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n* Example: `THIRD_PARTY_FIREWALL` - Palo Alto Networks Cloud Next-Generation Firewall centralized deployment model\n \n `\"{ \\\"type\\\":\\\"THIRD_PARTY_FIREWALL\\\", \\\"thirdPartyFirewall\\\":\\\"PALO_ALTO_NETWORKS_CLOUD_NGFW\\\", \\\"thirdPartyFirewallConfig\\\":{ \\\"thirdPartyFirewallPolicyList\\\":[\\\"global-1\\\"] },\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) to\n `CENTRALIZED`.\n* Example: `THIRD_PARTY_FIREWALL` - Palo Alto Networks Cloud Next-Generation Firewall distributed deployment model\n \n `\"{\\\"type\\\":\\\"THIRD_PARTY_FIREWALL\\\",\\\"thirdPartyFirewall\\\":\\\"PALO_ALTO_NETWORKS_CLOUD_NGFW\\\",\\\"thirdPartyFirewallConfig\\\":{\\\"thirdPartyFirewallPolicyList\\\":[\\\"global-1\\\"] },\\\"firewallDeploymentModel\\\":{ \\\"distributedFirewallDeploymentModel\\\":{ \\\"distributedFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ {\\\"availabilityZoneName\\\":\\\"${AvailabilityZone}\\\" } ] } }, \\\"allowedIPV4CidrList\\\":[ ] } } } }\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) to\n `DISTRIBUTED`.\n* Specification for `SHIELD_ADVANCED` for Amazon CloudFront distributions\n \n `\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\",\n \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"},\n \\\"overrideCustomerWebaclClassic\\\":true|false}\"`\n \n For example:\n `\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"`\n \n The default value for `automaticResponseStatus` is\n `IGNORED`. The value for `automaticResponseAction` is only\n required when `automaticResponseStatus` is set to `ENABLED`.\n The default value for `overrideCustomerWebaclClassic` is\n `false`.\n \n For other resource types that you can protect with a Shield Advanced policy, this\n `ManagedServiceData` configuration is an empty string.\n* Example: `WAFV2`\n \n `\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"`\n \n In the `loggingConfiguration`, you can specify one\n `logDestinationConfigs`, you can optionally provide up to 20\n `redactedFields`, and the `RedactedFieldType` must be one of\n `URI`, `QUERY_STRING`, `HEADER`, or\n `METHOD`.\n* Example: `AWS WAF Classic`\n \n `\"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\":\n [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\":\n \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"`\n* Example: `WAFV2` - AWS Firewall Manager support for AWS WAF managed rule group versioning\n \n `\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":true,\\\"version\\\":\\\"Version_2.0\\\",\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesCommonRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"`\n \n To use a specific version of a AWS WAF managed rule group in your Firewall Manager policy, you must set `versionEnabled` to `true`, and set `version` to the version you'd like to use. If you don't set `versionEnabled` to `true`, or if you omit `versionEnabled`, then Firewall Manager uses the default version of the AWS WAF managed rule group.\n* Example: `SECURITY_GROUPS_COMMON`\n \n `\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"`\n* Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as\n well as to those in VPCs that the account owns\n \n `\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"`\n* Example: `SECURITY_GROUPS_CONTENT_AUDIT`\n \n `\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"`\n \n The security group action for content audit can be `ALLOW` or\n `DENY`. For `ALLOW`, all in-scope security group rules must\n be within the allowed range of the policy's security group rules. For\n `DENY`, all in-scope security group rules must not contain a value or a\n range that matches a rule value or range in the policy security group.\n* Example: `SECURITY_GROUPS_USAGE_AUDIT`\n \n `\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"`\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `30000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-securityservicepolicydata.html#cfn-fms-policy-securityservicepolicydata-managedservicedata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe service that the policy is using to protect the resources. This specifies the type of\npolicy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security\ngroup policy. For security group policies, Firewall Manager supports one security group for\neach common policy and for each content audit policy. This is an adjustable limit that you can\nincrease by contacting AWS Support.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WAF | WAFV2 | SHIELD_ADVANC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WAF", "WAFV2", "SHIELD_ADVANCED", "SECURITY_GROUPS_COMMON", "SECURITY_GROUPS_CONTENT_AUDIT", "SECURITY_GROUPS_USAGE_AUDIT", "NETWORK_FIREWALL", "THIRD_PARTY_FIREWALL", "DNS_FIREWALL", "IMPORT_NETWORK_FIREWALL", "NETWORK_ACL_COMMON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-securityservicepolicydata.html#cfn-fms-policy-securityservicepolicydata-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyOption": { "MarkdownDocumentation": "`PolicyOption`\n\nContains the settings to configure a network ACL policy, a AWS Network Firewall firewall policy deployment model, or a third-party firewall policy.\n*Required*: No\n*Type*: [PolicyOption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-securityservicepolicydata.html#cfn-fms-policy-securityservicepolicydata-policyoption", "UpdateType": "Mutable", "Required": false, "Type": "PolicyOption" } } }, "AWS::FMS::Policy.ThirdPartyFirewallPolicy": { "MarkdownDocumentation": "`AWS::FMS::Policy.ThirdPartyFirewallPolicy`\n\nConfigures the deployment model for the third-party firewall.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html", "Properties": { "FirewallDeploymentModel": { "MarkdownDocumentation": "`FirewallDeploymentModel`\n\nDefines the deployment model to use for the third-party firewall policy.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DISTRIBUTED | CENTRALIZED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISTRIBUTED", "CENTRALIZED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html#cfn-fms-policy-thirdpartyfirewallpolicy-firewalldeploymentmodel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FSx::DataRepositoryAssociation.AutoExportPolicy": { "MarkdownDocumentation": "`AWS::FSx::DataRepositoryAssociation.AutoExportPolicy`\n\nDescribes a data repository association's automatic export policy. The\n`AutoExportPolicy` defines the types of updated objects on the\nfile system that will be automatically exported to the data repository.\nAs you create, modify, or delete files, Amazon FSx for Lustre\nautomatically exports the defined changes asynchronously once your application finishes\nmodifying the file.\nThe `AutoExportPolicy` is only supported on Amazon FSx for Lustre file systems\nwith a data repository association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoexportpolicy.html", "Properties": { "Events": { "MarkdownDocumentation": "`Events`\n\nThe `AutoExportPolicy` can have the following event values:\n* `NEW` - New files and directories are automatically exported\n to the data repository as they are added to the file system.\n* `CHANGED` - Changes to files and directories on the\n file system are automatically exported to the data repository.\n* `DELETED` - Files and directories are automatically deleted\n 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*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoexportpolicy.html#cfn-fsx-datarepositoryassociation-autoexportpolicy-events", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::FSx::DataRepositoryAssociation.AutoImportPolicy": { "MarkdownDocumentation": "`AWS::FSx::DataRepositoryAssociation.AutoImportPolicy`\n\nDescribes the data repository association's automatic import policy.\nThe AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory\nlistings up to date by importing changes to your Amazon FSx for Lustre file system\nas you modify objects in a linked S3 bucket.\nThe `AutoImportPolicy` is only supported on Amazon FSx for Lustre file systems\nwith a data repository association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoimportpolicy.html", "Properties": { "Events": { "MarkdownDocumentation": "`Events`\n\nThe `AutoImportPolicy` can have the following event values:\n* `NEW` - Amazon FSx automatically imports metadata of\n files added to the linked S3 bucket that do not currently exist in the FSx\n file system.\n* `CHANGED` - Amazon FSx automatically updates file\n metadata and invalidates existing file content on the file system as files\n change in the data repository.\n* `DELETED` - Amazon FSx automatically deletes files\n 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*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoimportpolicy.html#cfn-fsx-datarepositoryassociation-autoimportpolicy-events", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::FSx::DataRepositoryAssociation.S3": { "MarkdownDocumentation": "`AWS::FSx::DataRepositoryAssociation.S3`\n\nThe configuration for an Amazon S3 data repository linked to an\nAmazon FSx Lustre file system with a data repository association.\nThe configuration defines which file events (new, changed, or\ndeleted files or directories) are automatically imported from\nthe linked data repository to the file system or automatically\nexported from the file system to the data repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html", "Properties": { "AutoImportPolicy": { "MarkdownDocumentation": "`AutoImportPolicy`\n\nDescribes the data repository association's automatic import policy.\nThe AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory\nlistings up to date by importing changes to your Amazon FSx for Lustre file system\nas you modify objects in a linked S3 bucket.\nThe `AutoImportPolicy` is only supported on Amazon FSx for Lustre file systems\nwith a data repository association.\n*Required*: No\n*Type*: [AutoImportPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html#cfn-fsx-datarepositoryassociation-s3-autoimportpolicy", "UpdateType": "Mutable", "Required": false, "Type": "AutoImportPolicy" }, "AutoExportPolicy": { "MarkdownDocumentation": "`AutoExportPolicy`\n\nDescribes a data repository association's automatic export policy. The\n`AutoExportPolicy` defines the types of updated objects on the\nfile system that will be automatically exported to the data repository.\nAs you create, modify, or delete files, Amazon FSx for Lustre\nautomatically exports the defined changes asynchronously once your application finishes\nmodifying the file.\nThe `AutoExportPolicy` is only supported on Amazon FSx for Lustre file systems\nwith a data repository association.\n*Required*: No\n*Type*: [AutoExportPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html#cfn-fsx-datarepositoryassociation-s3-autoexportpolicy", "UpdateType": "Mutable", "Required": false, "Type": "AutoExportPolicy" } } }, "AWS::FSx::FileSystem.AuditLogConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.AuditLogConfiguration`\n\nThe configuration that Amazon FSx for Windows File Server uses to audit and log\nuser accesses of files, folders, and file shares on the Amazon FSx for Windows File Server\nfile system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-auditlogconfiguration.html", "Properties": { "FileAccessAuditLogLevel": { "Required": true, "MarkdownDocumentation": "`FileAccessAuditLogLevel`\n\nSets which attempt type is logged by Amazon FSx for file and folder accesses.\n* `SUCCESS_ONLY` - only successful attempts to access files\n or folders are logged.\n* `FAILURE_ONLY` - only failed attempts to access files\n or folders are logged.\n* `SUCCESS_AND_FAILURE` - both successful attempts and\n failed attempts to access files or folders are logged.\n* `DISABLED` - access auditing of files and folders is turned off.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DISABLED | SUCCESS_ONLY | F...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-auditlogconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-auditlogconfiguration-fileaccessauditloglevel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FileShareAccessAuditLogLevel": { "Required": true, "MarkdownDocumentation": "`FileShareAccessAuditLogLevel`\n\nSets which attempt type is logged by Amazon FSx for file share accesses.\n* `SUCCESS_ONLY` - only successful attempts to access file\n shares are logged.\n* `FAILURE_ONLY` - only failed attempts to access file\n shares are logged.\n* `SUCCESS_AND_FAILURE` - both successful attempts and\n failed attempts to access file shares are logged.\n* `DISABLED` - access auditing of file shares is turned off.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DISABLED | SUCCESS_ONLY | F...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-auditlogconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-auditlogconfiguration-fileshareaccessauditloglevel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuditLogDestination": { "Required": false, "MarkdownDocumentation": "`AuditLogDestination`\n\nThe Amazon Resource Name (ARN) for the destination of the audit logs.\nThe destination can be any Amazon CloudWatch Logs log group ARN or\nAmazon Kinesis Data Firehose delivery stream ARN.\nThe name of the Amazon CloudWatch Logs log group must begin with\nthe `/aws/fsx` prefix. The name of the Amazon Kinesis Data\nFirehose delivery stream must begin with the `aws-fsx` prefix.\nThe destination ARN (either CloudWatch Logs log group or Kinesis\nData Firehose delivery stream) must be in the same AWS partition,\nAWS Region, and AWS account as your Amazon FSx file system.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[^:]{1,63}:[^:]{0,63}:[^:]{0,63}:(?:|\\d{12}):[^/].{0,1023}$`\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-auditlogconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-auditlogconfiguration-auditlogdestination", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::FSx::FileSystem.ClientConfigurations": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.ClientConfigurations`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports-clientconfigurations.html", "Properties": { "Options": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports-clientconfigurations.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports-clientconfigurations-options", "UpdateType": "Immutable" }, "Clients": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports-clientconfigurations.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports-clientconfigurations-clients", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::FSx::FileSystem.DataReadCacheConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.DataReadCacheConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration-datareadcacheconfiguration.html", "Properties": { "SizingMode": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration-datareadcacheconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-datareadcacheconfiguration-sizingmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SizeGiB": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration-datareadcacheconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-datareadcacheconfiguration-sizegib", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::FSx::FileSystem.DiskIopsConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.DiskIopsConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration.html", "Properties": { "Mode": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration-mode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Iops": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration-iops", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::FSx::FileSystem.LustreConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.LustreConfiguration`\n\nThe configuration for the Amazon FSx for Lustre file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html", "Properties": { "DriveCacheType": { "Required": false, "MarkdownDocumentation": "`DriveCacheType`\n\nThe type of drive cache used by `PERSISTENT_1` file systems that are provisioned with\nHDD storage devices. This parameter is required when storage type is HDD. Set this property to\n`READ` to improve the performance for frequently accessed files by caching up to 20%\nof the total storage capacity of the file system.\nThis parameter is required when `StorageType` is set to `HDD` and `DeploymentType` is\n`PERSISTENT_1`.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `NONE | READ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "READ" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-drivecachetype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AutoImportPolicy": { "Required": false, "MarkdownDocumentation": "`AutoImportPolicy`\n\n(Optional) When you create your file system, your existing S3 objects appear as file and directory listings.\nUse this property to choose how Amazon FSx keeps your file and directory listings up to date\nas you add or modify objects in your linked S3 bucket. `AutoImportPolicy` can\nhave the following values:\n* `NONE` - (Default) AutoImport is off. Amazon FSx only updates\n file and directory listings from the linked S3 bucket\n when the file system is created. FSx does not update file and directory\n listings for any new or changed objects after choosing this option.\n* `NEW` - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that\n do not currently exist in the FSx file system.\n* `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports\n file and directory listings of any new objects added to the S3 bucket and any\n existing objects that are changed in the S3 bucket after you choose this option.\n* `NEW_CHANGED_DELETED` - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any\n existing objects that are changed in the S3 bucket, and any objects that were deleted\n 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).\n###### Important\nThis parameter is not supported for Lustre file systems with a data repository association.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | NEW | NEW_CHANGED | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-autoimportpolicy", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EfaEnabled": { "Required": false, "MarkdownDocumentation": "`EfaEnabled`\n\n(Optional) Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS)\nsupport is enabled for the Amazon FSx for Lustre file system.\n(Default = `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-efaenabled", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "ImportedFileChunkSize": { "Required": false, "MarkdownDocumentation": "`ImportedFileChunkSize`\n\n(Optional) For files imported from a data repository, this value determines the stripe\ncount and maximum amount of data per file (in MiB) stored on a single physical disk. The\nmaximum number of disks that a single file can be striped across is limited by the total\nnumber 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\nGiB). Amazon S3 objects have a maximum size of 5 TB.\n###### Important\nThis parameter is not supported for Lustre file systems with a data repository association.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-importedfilechunksize", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "DeploymentType": { "Required": false, "MarkdownDocumentation": "`DeploymentType`\n\n(Optional) Choose `SCRATCH_1` and `SCRATCH_2` deployment\ntypes when you need temporary storage and shorter-term processing of data.\nThe `SCRATCH_2` deployment type provides in-transit encryption of data and higher burst\nthroughput capacity than `SCRATCH_1`.\nChoose `PERSISTENT_1` for longer-term storage and for throughput-focused\nworkloads that aren\u2019t latency-sensitive.\n`PERSISTENT_1` supports encryption of data in transit, and is available in all\nAWS Regions in which FSx for Lustre is available.\nChoose `PERSISTENT_2` for longer-term storage and for latency-sensitive workloads\nthat require the highest levels of IOPS/throughput. `PERSISTENT_2` supports\nthe SSD and Intelligent-Tiering storage classes.\nYou can optionally specify a metadata configuration mode for `PERSISTENT_2`\nwhich supports increasing metadata performance. `PERSISTENT_2` is available\nin a limited number of AWS Regions. For more information, and an up-to-date\nlist of AWS Regions in which `PERSISTENT_2` is available, see\n[Deployment and\nstorage class options for FSx for Lustre file systems](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html) in\nthe *Amazon FSx for Lustre User Guide*.\n###### Note\nIf you choose `PERSISTENT_2`, and you set `FileSystemTypeVersion` to\n`2.10`, the `CreateFileSystem` operation fails.\nEncryption of data in transit is automatically turned on when you access\n`SCRATCH_2`, `PERSISTENT_1`, and `PERSISTENT_2` file\nsystems from Amazon EC2 instances that support automatic encryption in\nthe AWS Regions where they are available. For more information about\nencryption in transit for FSx for Lustre file systems, see [Encrypting data in\ntransit](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*: `SCRATCH_1 | SCRATCH_2 | PER...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-deploymenttype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ThroughputCapacity": { "Required": false, "MarkdownDocumentation": "`ThroughputCapacity`\n\nSpecifies the throughput of an FSx for Lustre file system using the Intelligent-Tiering storage class,\nmeasured in megabytes per second (MBps). Valid values are 4000 MBps or\nmultiples of 4000 MBps. You pay for the amount of throughput that you provision.\n*Required*: No\n*Type*: Integer\n*Minimum*: `4000`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-throughputcapacity", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DataCompressionType": { "Required": false, "MarkdownDocumentation": "`DataCompressionType`\n\nSets the data compression configuration for the file system. `DataCompressionType`\ncan have the following values:\n* `NONE` - (Default) Data compression is turned off when\n the file system is created.\n* `LZ4` - Data compression is turned on with the LZ4\n algorithm.\nFor more information, see [Lustre data compression](https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html)\nin the *Amazon FSx for Lustre User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | LZ4`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "NONE", "LZ4" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-datacompressiontype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DataReadCacheConfiguration": { "Type": "DataReadCacheConfiguration", "Required": false, "MarkdownDocumentation": "`DataReadCacheConfiguration`\n\nSpecifies the optional provisioned SSD read cache on FSx for Lustre file systems that\nuse the Intelligent-Tiering storage class. Required when `StorageType` is set\nto `INTELLIGENT_TIERING`.\n*Required*: No\n*Type*: [DataReadCacheConfiguration](./aws-properties-fsx-filesystem-datareadcacheconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-datareadcacheconfiguration", "UpdateType": "Mutable" }, "ImportPath": { "Required": false, "MarkdownDocumentation": "`ImportPath`\n\n(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\nyou're using as the data repository for your Amazon FSx for Lustre file system. The root\nof your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket\nyou select. An example is `s3://import-bucket/optional-prefix`. If you\nspecify a prefix after the Amazon S3 bucket name, only object keys with that prefix are\nloaded into the file system.\n###### Important\nThis parameter is not supported for Lustre file systems with a data repository association.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$`\n*Minimum*: `3`\n*Maximum*: `4357`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-importpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "WeeklyMaintenanceStartTime": { "Required": false, "MarkdownDocumentation": "`WeeklyMaintenanceStartTime`\n\nThe preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\ntime zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-weeklymaintenancestarttime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MetadataConfiguration": { "Type": "MetadataConfiguration", "Required": false, "MarkdownDocumentation": "`MetadataConfiguration`\n\nThe Lustre metadata performance configuration for the creation of an\nFSx for Lustre file system using a `PERSISTENT_2`\ndeployment type.\n*Required*: No\n*Type*: [MetadataConfiguration](./aws-properties-fsx-filesystem-metadataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-metadataconfiguration", "UpdateType": "Mutable" }, "DailyAutomaticBackupStartTime": { "Required": false, "MarkdownDocumentation": "`DailyAutomaticBackupStartTime`\n\nA recurring daily time, in the format `HH:MM`. `HH` is the\nzero-padded hour of the day (0-23), and `MM` is the zero-padded minute of the\nhour. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-dailyautomaticbackupstarttime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CopyTagsToBackups": { "Required": false, "MarkdownDocumentation": "`CopyTagsToBackups`\n\n(Optional) Not available for use with file systems that are linked to a data\nrepository. A boolean flag indicating whether tags for the file system should be copied\nto backups. The default value is false. If `CopyTagsToBackups` is set to\ntrue, all file system tags are copied to all automatic and user-initiated backups when\nthe user doesn't specify any backup-specific tags. If\n`CopyTagsToBackups` is set to true and you specify one or more backup\ntags, only the specified tags are copied to backups. If you specify one or more tags\nwhen creating a user-initiated backup, no tags are copied from the file system,\nregardless of this value.\n(Default = `false`)\nFor 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*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-copytagstobackups", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "ExportPath": { "Required": false, "MarkdownDocumentation": "`ExportPath`\n\n(Optional) Specifies the path in the Amazon S3 bucket where the root of your\nAmazon FSx file system is exported. The path must use the same Amazon S3 bucket as\nspecified in ImportPath. You can provide an optional prefix to which new and changed\ndata is to be exported from your Amazon FSx for Lustre file system. If an\n`ExportPath` value is not provided, Amazon FSx sets a default export\npath, `s3://import-bucket/FSxLustre[creation-timestamp]`. The timestamp is in\nUTC format, for example\n`s3://import-bucket/FSxLustre20181105T222312Z`.\nThe Amazon S3 export bucket must be the same as the import bucket specified by\n`ImportPath`. If you specify only a bucket name, such as\n`s3://import-bucket`, you get a 1:1 mapping of file system objects to S3\nbucket objects. This mapping means that the input data in S3 is overwritten on export.\nIf you provide a custom prefix in the export path, such as\n`s3://import-bucket/[custom-optional-prefix]`, Amazon FSx exports the\ncontents of your file system to that export prefix in the Amazon S3 bucket.\n###### Important\nThis parameter is not supported for file systems with a data repository association.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$`\n*Minimum*: `3`\n*Maximum*: `4357`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-exportpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "PerUnitStorageThroughput": { "Required": false, "MarkdownDocumentation": "`PerUnitStorageThroughput`\n\nRequired with `PERSISTENT_1` and `PERSISTENT_2` deployment\ntypes, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of\nfile system storage capacity, in MB/s/TiB. File system throughput capacity is calculated\nby multiplying \ufb01le system storage capacity (TiB) by the\n`PerUnitStorageThroughput` (MB/s/TiB). For a 2.4-TiB \ufb01le system,\nprovisioning 50 MB/s/TiB of `PerUnitStorageThroughput` yields 120 MB/s of \ufb01le\nsystem 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\n MB/s/TiB.\n*Required*: Conditional\n*Type*: Integer\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-perunitstoragethroughput", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AutomaticBackupRetentionDays": { "Required": false, "MarkdownDocumentation": "`AutomaticBackupRetentionDays`\n\nThe number of days to retain automatic backups. Setting this property to\n`0` disables automatic backups. You can retain automatic backups for a\nmaximum of 90 days. The default is `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-automaticbackupretentiondays", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::FSx::FileSystem.MetadataConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.MetadataConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration-metadataconfiguration.html", "Properties": { "Mode": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration-metadataconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-metadataconfiguration-mode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Iops": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration-metadataconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-metadataconfiguration-iops", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::FSx::FileSystem.NfsExports": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.NfsExports`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports.html", "Properties": { "ClientConfigurations": { "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports-clientconfigurations", "ItemType": "ClientConfigurations", "UpdateType": "Immutable" } } }, "AWS::FSx::FileSystem.OntapConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.OntapConfiguration`\n\nThe configuration for this Amazon FSx for NetApp ONTAP file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html", "Properties": { "HAPairs": { "Required": false, "MarkdownDocumentation": "`HAPairs`\n\nSpecifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair.\nSecond-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1.\nThe value of this property affects the values of `StorageCapacity`,\n`Iops`, and `ThroughputCapacity`. For more information, see\n[High-availability (HA) pairs](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs) in the FSx for ONTAP user guide. Block storage protocol support\n(iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see\n[Using block storage protocols](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage).\nAmazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:\n* The value of `HAPairs` is less than 1 or greater than 12.\n* The value of `HAPairs` is greater than 1 and the value of `DeploymentType` is `SINGLE_AZ_1`, `MULTI_AZ_1`, or `MULTI_AZ_2`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-hapairs", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "FsxAdminPassword": { "Required": false, "MarkdownDocumentation": "`FsxAdminPassword`\n\nThe ONTAP administrative password for the `fsxadmin` user with which you\nadminister your file system using the NetApp ONTAP CLI and REST API.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{8,50}$`\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-fsxadminpassword", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ThroughputCapacityPerHAPair": { "Required": false, "MarkdownDocumentation": "`ThroughputCapacityPerHAPair`\n\nUse to choose the throughput capacity per HA pair, rather than the total throughput for the file system.\nYou can define either the `ThroughputCapacityPerHAPair` or the `ThroughputCapacity` when creating a file system, but not both.\nThis field and `ThroughputCapacity` are the same for file systems powered by one HA pair.\n* For `SINGLE_AZ_1` and `MULTI_AZ_1` file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.\n* For `SINGLE_AZ_2`, valid values are 1536, 3072, or 6144 MBps.\n* For `MULTI_AZ_2`, valid values are 384, 768, 1536, 3072, or 6144 MBps.\nAmazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:\n* The value of `ThroughputCapacity` and `ThroughputCapacityPerHAPair` are not the same value for file systems with one HA pair.\n* The value of deployment type is `SINGLE_AZ_2` and `ThroughputCapacity` / `ThroughputCapacityPerHAPair` is not a valid HA pair (a value between 1 and 12).\n* The value of `ThroughputCapacityPerHAPair` is not a valid value.\n*Required*: No\n*Type*: Integer\n*Minimum*: `128`\n*Maximum*: `6144`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-throughputcapacityperhapair", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DeploymentType": { "Required": true, "MarkdownDocumentation": "`DeploymentType`\n\nSpecifies the FSx for ONTAP file system deployment type to use in creating\nthe file system.\n* `MULTI_AZ_1` - A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability. This is a first-generation FSx for ONTAP file system.\n* `MULTI_AZ_2` - A high availability file system configured for Multi-AZ redundancy to tolerate\n temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.\n* `SINGLE_AZ_1` - A file system configured for Single-AZ\n redundancy. This is a first-generation FSx for ONTAP file system.\n* `SINGLE_AZ_2` - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.\n This is a second-generation FSx for ONTAP file system.\nFor information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n[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)", "RefReturnValue": "", "AllowedValues": [ "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2", "MULTI_AZ_2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-deploymenttype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ThroughputCapacity": { "Required": false, "MarkdownDocumentation": "`ThroughputCapacity`\n\nSets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see\n[Managing throughput capacity](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html)\nin the FSx for ONTAP User Guide.\nAmazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:\n* The value of `ThroughputCapacity` and `ThroughputCapacityPerHAPair` are not the same value.\n* The value of `ThroughputCapacity` when divided by the value of `HAPairs` is outside of the valid range for `ThroughputCapacity`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-throughputcapacity", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "EndpointIpAddressRange": { "Required": false, "MarkdownDocumentation": "`EndpointIpAddressRange`\n\n(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your\nfile system will be created. By default in the Amazon FSx API, Amazon FSx\nselects an unused IP address range for you from the 198.19.\\* range. By default in the\nAmazon FSx console, Amazon FSx chooses the last 64 IP addresses from\nthe VPC\u2019s primary CIDR range to use as the endpoint IP address range for the file system.\nYou can have overlapping endpoint IP addresses for file systems deployed in the\nsame VPC/route tables, as long as they don't overlap with any subnet.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$`\n*Minimum*: `9`\n*Maximum*: `17`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-endpointipaddressrange", "PrimitiveType": "String", "UpdateType": "Immutable" }, "RouteTableIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`RouteTableIds`\n\n(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules\nfor routing traffic to the correct file server. You should specify all virtual private cloud\n(VPC) route tables associated with the subnets in which your clients are located. By default,\nAmazon FSx selects your VPC's default route table.\n###### Note\nAmazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication.\nThese route tables are tagged with `Key: AmazonFSx; Value: ManagedByAmazonFSx`.\nWhen creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the\n`Key: AmazonFSx; Value: ManagedByAmazonFSx` tag manually.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-routetableids", "UpdateType": "Mutable" }, "WeeklyMaintenanceStartTime": { "Required": false, "MarkdownDocumentation": "`WeeklyMaintenanceStartTime`\n\nThe preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\ntime zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-weeklymaintenancestarttime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DiskIopsConfiguration": { "Type": "DiskIopsConfiguration", "Required": false, "MarkdownDocumentation": "`DiskIopsConfiguration`\n\nThe SSD IOPS configuration for the FSx for ONTAP file system.\n*Required*: No\n*Type*: [DiskIopsConfiguration](./aws-properties-fsx-filesystem-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-diskiopsconfiguration", "UpdateType": "Mutable" }, "DailyAutomaticBackupStartTime": { "Required": false, "MarkdownDocumentation": "`DailyAutomaticBackupStartTime`\n\nA recurring daily time, in the format `HH:MM`. `HH` is the\nzero-padded hour of the day (0-23), and `MM` is the zero-padded minute of the\nhour. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-dailyautomaticbackupstarttime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AutomaticBackupRetentionDays": { "Required": false, "MarkdownDocumentation": "`AutomaticBackupRetentionDays`\n\nThe number of days to retain automatic backups. Setting this property to\n`0` disables automatic backups. You can retain automatic backups for a\nmaximum of 90 days. The default is `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-automaticbackupretentiondays", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "EndpointIpv6AddressRange": { "Required": false, "MarkdownDocumentation": "`EndpointIpv6AddressRange`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-endpointipv6addressrange", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PreferredSubnetId": { "Required": false, "MarkdownDocumentation": "`PreferredSubnetId`\n\nRequired when `DeploymentType` is set to `MULTI_AZ_1` or `MULTI_AZ_2`. This\nspecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-preferredsubnetid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::FSx::FileSystem.OpenZFSConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.OpenZFSConfiguration`\n\nThe OpenZFS configuration for the file system that's being created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html", "Properties": { "Options": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Options`\n\nTo delete a file system if there are child volumes present below the root volume,\nuse the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`. If your file system\nhas child volumes and you don't use this option, the delete request will fail.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-options", "UpdateType": "Mutable" }, "CopyTagsToVolumes": { "Required": false, "MarkdownDocumentation": "`CopyTagsToVolumes`\n\nA Boolean value indicating whether tags for the file system should be copied to volumes.\nThis value defaults to `false`. If it's set to `true`, all tags\nfor the file system are copied to volumes where the user doesn't specify tags. If this\nvalue is `true`, and you specify one or more tags, only the specified tags\nare copied to volumes. If you specify one or more tags when creating the volume, no\ntags 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-copytagstovolumes", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DeploymentType": { "Required": true, "MarkdownDocumentation": "`DeploymentType`\n\nSpecifies the file system deployment type. Valid values are the following:\n* `MULTI_AZ_1`- Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same AWS Region.\n* `SINGLE_AZ_HA_2`- Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.\n* `SINGLE_AZ_HA_1`- Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.\n* `SINGLE_AZ_2`- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache that automatically recover within a single Availability Zone.\n* `SINGLE_AZ_1`- Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.\nFor a list of which AWS Regions each deployment type is available in, see [Deployment type availability](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions).\nFor more information on the differences in performance between deployment types, see [File system performance](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance)\nin 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)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_AZ_1", "SINGLE_AZ_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_HA_2", "MULTI_AZ_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-deploymenttype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ThroughputCapacity": { "Required": false, "MarkdownDocumentation": "`ThroughputCapacity`\n\nSpecifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Required if\nyou are creating a new file system.\nValid values depend on the `DeploymentType` that you choose, as follows:\n* For `MULTI_AZ_1` and `SINGLE_AZ_2`, valid values are 160, 320, 640,\n 1280, 2560, 3840, 5120, 7680, or 10240 MBps.\n* For `SINGLE_AZ_1`, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-throughputcapacity", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RootVolumeConfiguration": { "Type": "RootVolumeConfiguration", "Required": false, "MarkdownDocumentation": "`RootVolumeConfiguration`\n\nThe configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS\nfile system. All volumes are children of the root volume.\n*Required*: No\n*Type*: [RootVolumeConfiguration](./aws-properties-fsx-filesystem-rootvolumeconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration", "UpdateType": "Mutable" }, "EndpointIpAddressRange": { "Required": false, "MarkdownDocumentation": "`EndpointIpAddressRange`\n\n(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your\nfile system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\nselects an available /28 IP address range for you from one of the VPC's CIDR ranges.\nYou can have overlapping endpoint IP addresses for file systems deployed in the\nsame VPC/route tables, as long as they don't overlap with any subnet.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$`\n*Minimum*: `9`\n*Maximum*: `17`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-endpointipaddressrange", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ReadCacheConfiguration": { "Type": "ReadCacheConfiguration", "Required": false, "MarkdownDocumentation": "`ReadCacheConfiguration`\n\nSpecifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.\n*Required*: No\n*Type*: [ReadCacheConfiguration](./aws-properties-fsx-filesystem-readcacheconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-readcacheconfiguration", "UpdateType": "Mutable" }, "RouteTableIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`RouteTableIds`\n\n(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules\nfor routing traffic to the correct file server. You should specify all virtual private cloud\n(VPC) route tables associated with the subnets in which your clients are located. By default,\nAmazon FSx selects your VPC's default route table.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-routetableids", "UpdateType": "Mutable" }, "WeeklyMaintenanceStartTime": { "Required": false, "MarkdownDocumentation": "`WeeklyMaintenanceStartTime`\n\nThe preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\ntime zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-weeklymaintenancestarttime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DiskIopsConfiguration": { "Type": "DiskIopsConfiguration", "Required": false, "MarkdownDocumentation": "`DiskIopsConfiguration`\n\nThe SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx\nautomatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per\nGB of storage. The configuration consists of the total number of provisioned SSD IOPS\nand how it is was provisioned, or the mode (by the customer or by Amazon FSx).\n*Required*: No\n*Type*: [DiskIopsConfiguration](./aws-properties-fsx-filesystem-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration", "UpdateType": "Mutable" }, "DailyAutomaticBackupStartTime": { "Required": false, "MarkdownDocumentation": "`DailyAutomaticBackupStartTime`\n\nA recurring daily time, in the format `HH:MM`. `HH` is the\nzero-padded hour of the day (0-23), and `MM` is the zero-padded minute of the\nhour. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-dailyautomaticbackupstarttime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CopyTagsToBackups": { "Required": false, "MarkdownDocumentation": "`CopyTagsToBackups`\n\nA Boolean value indicating whether tags for the file system should be copied to\nbackups. This value defaults to `false`. If it's set to `true`,\nall tags for the file system are copied to all automatic and user-initiated backups\nwhere the user doesn't specify tags. If this value is `true`, and you specify\none or more tags, only the specified tags are copied to backups. If you specify one or\nmore tags when creating a user-initiated backup, no tags are copied from the file\nsystem, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-copytagstobackups", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AutomaticBackupRetentionDays": { "Required": false, "MarkdownDocumentation": "`AutomaticBackupRetentionDays`\n\nThe number of days to retain automatic backups. Setting this property to\n`0` disables automatic backups. You can retain automatic backups for a\nmaximum of 90 days. The default is `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-automaticbackupretentiondays", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "EndpointIpv6AddressRange": { "Required": false, "MarkdownDocumentation": "`EndpointIpv6AddressRange`\n\n(Multi-AZ only) Specifies the IP address range in which the endpoints to access\nyour file system will be created. By default in the Amazon FSx API and Amazon FSx console,\nAmazon FSx selects an available /118 IP address\nrange for you from one of the VPC's CIDR ranges. You can have overlapping endpoint\nIP addresses for file systems deployed in the same VPC/route tables, as long as they\ndon't overlap with any subnet.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{4,43}$`\n*Minimum*: `4`\n*Maximum*: `43`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-endpointipv6addressrange", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PreferredSubnetId": { "Required": false, "MarkdownDocumentation": "`PreferredSubnetId`\n\nRequired 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-preferredsubnetid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::FSx::FileSystem.ReadCacheConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.ReadCacheConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-readcacheconfiguration.html", "Properties": { "SizingMode": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-readcacheconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-readcacheconfiguration-sizingmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SizeGiB": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-readcacheconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-readcacheconfiguration-sizegib", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::FSx::FileSystem.RootVolumeConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.RootVolumeConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html", "Properties": { "ReadOnly": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-readonly", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "DataCompressionType": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-datacompressiontype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "NfsExports": { "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports", "ItemType": "NfsExports", "UpdateType": "Immutable" }, "CopyTagsToSnapshots": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-copytagstosnapshots", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "RecordSizeKiB": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-recordsizekib", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "UserAndGroupQuotas": { "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas", "ItemType": "UserAndGroupQuotas", "UpdateType": "Immutable" } } }, "AWS::FSx::FileSystem.SelfManagedActiveDirectoryConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.SelfManagedActiveDirectoryConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html", "Properties": { "FileSystemAdministratorsGroup": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-filesystemadministratorsgroup", "PrimitiveType": "String", "UpdateType": "Immutable" }, "UserName": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DomainName": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-domainname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "OrganizationalUnitDistinguishedName": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-organizationalunitdistinguishedname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DomainJoinServiceAccountSecret": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-domainjoinserviceaccountsecret", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DnsIps": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-dnsips", "UpdateType": "Mutable" }, "Password": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration-password", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::FSx::FileSystem.UserAndGroupQuotas": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.UserAndGroupQuotas`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html", "Properties": { "Type": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas-type", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas-id", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "StorageCapacityQuotaGiB": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas-storagecapacityquotagib", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::FSx::FileSystem.WindowsConfiguration": { "MarkdownDocumentation": "`AWS::FSx::FileSystem.WindowsConfiguration`\n\nThe Microsoft Windows configuration for the file system that's being created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html", "Properties": { "SelfManagedActiveDirectoryConfiguration": { "Type": "SelfManagedActiveDirectoryConfiguration", "Required": false, "MarkdownDocumentation": "`SelfManagedActiveDirectoryConfiguration`\n\nThe configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to\na self-managed (including on-premises) Microsoft Active Directory (AD)\ndirectory. For more information, see\n[Using Amazon FSx for Windows with your self-managed Microsoft Active Directory](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) or\n[Managing FSx for ONTAP SVMs](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html).\n*Required*: No\n*Type*: [SelfManagedActiveDirectoryConfiguration](./aws-properties-fsx-filesystem-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration", "UpdateType": "Mutable" }, "AuditLogConfiguration": { "Type": "AuditLogConfiguration", "Required": false, "MarkdownDocumentation": "`AuditLogConfiguration`\n\nThe configuration that Amazon FSx for Windows File Server uses to audit and log\nuser accesses of files, folders, and file shares on the Amazon FSx for Windows File Server\nfile system.\n*Required*: No\n*Type*: [AuditLogConfiguration](./aws-properties-fsx-filesystem-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-auditlogconfiguration", "UpdateType": "Mutable" }, "WeeklyMaintenanceStartTime": { "Required": false, "MarkdownDocumentation": "`WeeklyMaintenanceStartTime`\n\nThe preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\ntime 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-weeklymaintenancestarttime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ActiveDirectoryId": { "Required": false, "MarkdownDocumentation": "`ActiveDirectoryId`\n\nThe ID for an existing AWS Managed Microsoft Active Directory (AD)\ninstance that the file system should join when it's created. Required if you are joining the file system to an existing\nAWS Managed Microsoft AD.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^d-[0-9a-f]{10}$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-activedirectoryid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DiskIopsConfiguration": { "Type": "DiskIopsConfiguration", "Required": false, "MarkdownDocumentation": "`DiskIopsConfiguration`\n\nThe SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.\nBy default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional\nIOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.\n*Required*: No\n*Type*: [DiskIopsConfiguration](./aws-properties-fsx-filesystem-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-diskiopsconfiguration", "UpdateType": "Mutable" }, "DeploymentType": { "Required": false, "MarkdownDocumentation": "`DeploymentType`\n\nSpecifies the file system deployment type, valid values are the following:\n* `MULTI_AZ_1` - Deploys a high availability file system that is configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You\n can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also\n 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.\n Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.\nFor more information, see\n[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 | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-deploymenttype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Aliases": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Aliases`\n\nAn array of one or more DNS alias names that you want to associate with the Amazon FSx\nfile system. Aliases allow you to use existing DNS names to access the data in your\nAmazon FSx file system. You can associate up to 50 aliases with a file system at any\ntime.\nFor more information, see [Working with DNS\nAliases](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\nadditional steps you must take to be able to access your file system using a DNS\nalias.\nAn alias name has to meet the following requirements:\n* Formatted as a fully-qualified domain name (FQDN),\n `hostname.domain`, for example,\n `accounting.example.com`.\n* Can contain alphanumeric characters, the underscore (\\_), and the hyphen\n (-).\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\n(a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or\nthe corresponding letters in escape codes.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-aliases", "UpdateType": "Mutable" }, "ThroughputCapacity": { "Required": true, "MarkdownDocumentation": "`ThroughputCapacity`\n\nSets the throughput capacity of an Amazon FSx file system, measured in megabytes per\nsecond (MB/s), in 2 to the *n*th increments, between 2^3 (8) and 2^11\n(2048).\n###### Note\nTo increase storage capacity, a file system must have a minimum throughput capacity\nof 16 MB/s.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-throughputcapacity", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CopyTagsToBackups": { "Required": false, "MarkdownDocumentation": "`CopyTagsToBackups`\n\nA boolean flag indicating whether tags for the file system should be copied to\nbackups. This value defaults to false. If it's set to true, all tags for the file\nsystem are copied to all automatic and user-initiated backups where the user\ndoesn't specify tags. If this value is true, and you specify one or more tags, only\nthe specified tags are copied to backups. If you specify one or more tags when creating a\nuser-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-copytagstobackups", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "DailyAutomaticBackupStartTime": { "Required": false, "MarkdownDocumentation": "`DailyAutomaticBackupStartTime`\n\nA recurring daily time, in the format `HH:MM`. `HH` is the\nzero-padded hour of the day (0-23), and `MM` is the zero-padded minute of the\nhour. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-dailyautomaticbackupstarttime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AutomaticBackupRetentionDays": { "Required": false, "MarkdownDocumentation": "`AutomaticBackupRetentionDays`\n\nThe number of days to retain automatic backups. Setting this property to\n`0` disables automatic backups. You can retain automatic backups for a\nmaximum of 90 days. The default is `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-automaticbackupretentiondays", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "PreferredSubnetId": { "Required": false, "MarkdownDocumentation": "`PreferredSubnetId`\n\nRequired when `DeploymentType` is set to `MULTI_AZ_1`. This\nspecifies the subnet in which you want the preferred file server to be located. For\nin-AWS applications, we recommend that you launch your clients in the\nsame availability zone as your preferred file server to reduce cross-availability zone data\ntransfer costs and minimize latency.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-preferredsubnetid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::FSx::S3AccessPointAttachment.FileSystemGID": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.FileSystemGID`\n\nThe GID of the file system user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-filesystemgid.html", "Properties": { "Gid": { "MarkdownDocumentation": "`Gid`\n\nThe GID of the file system user.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `4294967295`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-filesystemgid.html#cfn-fsx-s3accesspointattachment-filesystemgid-gid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::FSx::S3AccessPointAttachment.OntapFileSystemIdentity": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.OntapFileSystemIdentity`\n\nSpecifies the file system user identity that will be used for authorizing all file access requests that are made using the S3 access point. The identity can be either a UNIX user or a Windows user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-ontapfilesystemidentity.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the FSx for ONTAP user identity type. Valid values are `UNIX` and `WINDOWS`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `UNIX | WINDOWS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "UNIX", "WINDOWS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-ontapfilesystemidentity.html#cfn-fsx-s3accesspointattachment-ontapfilesystemidentity-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UnixUser": { "MarkdownDocumentation": "`UnixUser`\n\nSpecifies the UNIX user identity for file system operations.\n*Required*: No\n*Type*: [OntapUnixFileSystemUser](./aws-properties-fsx-s3accesspointattachment-ontapunixfilesystemuser.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-ontapfilesystemidentity.html#cfn-fsx-s3accesspointattachment-ontapfilesystemidentity-unixuser", "UpdateType": "Immutable", "Required": false, "Type": "OntapUnixFileSystemUser" }, "WindowsUser": { "MarkdownDocumentation": "`WindowsUser`\n\nSpecifies the Windows user identity for file system operations.\n*Required*: No\n*Type*: [OntapWindowsFileSystemUser](./aws-properties-fsx-s3accesspointattachment-ontapwindowsfilesystemuser.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-ontapfilesystemidentity.html#cfn-fsx-s3accesspointattachment-ontapfilesystemidentity-windowsuser", "UpdateType": "Immutable", "Required": false, "Type": "OntapWindowsFileSystemUser" } } }, "AWS::FSx::S3AccessPointAttachment.OntapUnixFileSystemUser": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.OntapUnixFileSystemUser`\n\nThe FSx for ONTAP UNIX file system user that is used for authorizing all file access requests that are made using the S3 access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-ontapunixfilesystemuser.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the UNIX user. The name can be up to 256 characters long.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-ontapunixfilesystemuser.html#cfn-fsx-s3accesspointattachment-ontapunixfilesystemuser-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FSx::S3AccessPointAttachment.OntapWindowsFileSystemUser": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.OntapWindowsFileSystemUser`\n\nThe FSx for ONTAP Windows file system user that is used for authorizing all file access requests that are made using the S3 access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-ontapwindowsfilesystemuser.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Windows user. The name can be up to 256 characters long and supports Active Directory users.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-ontapwindowsfilesystemuser.html#cfn-fsx-s3accesspointattachment-ontapwindowsfilesystemuser-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FSx::S3AccessPointAttachment.OpenZFSFileSystemIdentity": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.OpenZFSFileSystemIdentity`\n\nSpecifies the file system user identity that will be used for authorizing all file access requests that are made using the S3 access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsfilesystemidentity.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the FSx for OpenZFS user identity type, accepts only `POSIX`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `POSIX`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "POSIX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsfilesystemidentity.html#cfn-fsx-s3accesspointattachment-openzfsfilesystemidentity-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PosixUser": { "MarkdownDocumentation": "`PosixUser`\n\nSpecifies the UID and GIDs of the file system POSIX user.\n*Required*: Yes\n*Type*: [OpenZFSPosixFileSystemUser](./aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsfilesystemidentity.html#cfn-fsx-s3accesspointattachment-openzfsfilesystemidentity-posixuser", "UpdateType": "Immutable", "Required": true, "Type": "OpenZFSPosixFileSystemUser" } } }, "AWS::FSx::S3AccessPointAttachment.OpenZFSPosixFileSystemUser": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.OpenZFSPosixFileSystemUser`\n\nThe FSx for OpenZFS file system user that is used for authorizing all file access requests that are made using the S3 access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.html", "Properties": { "Uid": { "MarkdownDocumentation": "`Uid`\n\nThe UID of the file system user.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `4294967295`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.html#cfn-fsx-s3accesspointattachment-openzfsposixfilesystemuser-uid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" }, "SecondaryGids": { "MarkdownDocumentation": "`SecondaryGids`\n\nThe list of secondary GIDs for the file system user.\n*Required*: No\n*Type*: Array of [FileSystemGID](./aws-properties-fsx-s3accesspointattachment-filesystemgid.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.html#cfn-fsx-s3accesspointattachment-openzfsposixfilesystemuser-secondarygids", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "FileSystemGID", "DuplicatesAllowed": true }, "Gid": { "MarkdownDocumentation": "`Gid`\n\nThe GID of the file system user.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `4294967295`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-openzfsposixfilesystemuser.html#cfn-fsx-s3accesspointattachment-openzfsposixfilesystemuser-gid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::FSx::S3AccessPointAttachment.S3AccessPoint": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.S3AccessPoint`\n\nDescribes the S3 access point configuration of the S3 access point attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe S3 access point's policy.\n*Required*: No\n*Type*: Json\n*Minimum*: `1`\n*Maximum*: `200000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html#cfn-fsx-s3accesspointattachment-s3accesspoint-policy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "ResourceARN": { "MarkdownDocumentation": "`ResourceARN`\n\nThe S3 access point's ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[^:]{1,63}:[^:]{0,63}:[^:]{0,63}:(?:|\\d{12}):[^/].{0,1023}$`\n*Minimum*: `8`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html#cfn-fsx-s3accesspointattachment-s3accesspoint-resourcearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nThe S3 access point's alias.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-z\\\\-]{1,63}`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html#cfn-fsx-s3accesspointattachment-s3accesspoint-alias", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nThe S3 access point's virtual private cloud (VPC) configuration.\n*Required*: No\n*Type*: [S3AccessPointVpcConfiguration](./aws-properties-fsx-s3accesspointattachment-s3accesspointvpcconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspoint.html#cfn-fsx-s3accesspointattachment-s3accesspoint-vpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "S3AccessPointVpcConfiguration" } } }, "AWS::FSx::S3AccessPointAttachment.S3AccessPointOntapConfiguration": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.S3AccessPointOntapConfiguration`\n\nDescribes the FSx for ONTAP attachment configuration of an S3 access point attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointontapconfiguration.html", "Properties": { "VolumeId": { "MarkdownDocumentation": "`VolumeId`\n\nThe ID of the FSx for ONTAP volume that the S3 access point is attached to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(fsvol-[0-9a-f]{17,})$`\n*Minimum*: `23`\n*Maximum*: `23`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointontapconfiguration.html#cfn-fsx-s3accesspointattachment-s3accesspointontapconfiguration-volumeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FileSystemIdentity": { "MarkdownDocumentation": "`FileSystemIdentity`\n\nThe file system identity used to authorize file access requests made using the S3 access point.\n*Required*: Yes\n*Type*: [OntapFileSystemIdentity](./aws-properties-fsx-s3accesspointattachment-ontapfilesystemidentity.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointontapconfiguration.html#cfn-fsx-s3accesspointattachment-s3accesspointontapconfiguration-filesystemidentity", "UpdateType": "Immutable", "Required": true, "Type": "OntapFileSystemIdentity" } } }, "AWS::FSx::S3AccessPointAttachment.S3AccessPointOpenZFSConfiguration": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.S3AccessPointOpenZFSConfiguration`\n\nDescribes the FSx for OpenZFS attachment configuration of an S3 access point attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration.html", "Properties": { "VolumeId": { "MarkdownDocumentation": "`VolumeId`\n\nThe ID of the FSx for OpenZFS volume that the S3 access point is attached to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(fsvol-[0-9a-f]{17,})$`\n*Minimum*: `23`\n*Maximum*: `23`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration.html#cfn-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration-volumeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FileSystemIdentity": { "MarkdownDocumentation": "`FileSystemIdentity`\n\nThe file system identity used to authorize file access requests made using the S3 access point.\n*Required*: Yes\n*Type*: [OpenZFSFileSystemIdentity](./aws-properties-fsx-s3accesspointattachment-openzfsfilesystemidentity.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration.html#cfn-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration-filesystemidentity", "UpdateType": "Immutable", "Required": true, "Type": "OpenZFSFileSystemIdentity" } } }, "AWS::FSx::S3AccessPointAttachment.S3AccessPointVpcConfiguration": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment.S3AccessPointVpcConfiguration`\n\nIf included, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointvpcconfiguration.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nSpecifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(vpc-[0-9a-f]{8,})$`\n*Minimum*: `12`\n*Maximum*: `21`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-s3accesspointattachment-s3accesspointvpcconfiguration.html#cfn-fsx-s3accesspointattachment-s3accesspointvpcconfiguration-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FSx::StorageVirtualMachine.ActiveDirectoryConfiguration": { "MarkdownDocumentation": "`AWS::FSx::StorageVirtualMachine.ActiveDirectoryConfiguration`\n\nDescribes the self-managed Microsoft Active Directory to which you want to join the SVM.\nJoining an Active Directory provides user authentication and access control for SMB clients,\nincluding Microsoft Windows and macOS clients accessing the file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html", "Properties": { "SelfManagedActiveDirectoryConfiguration": { "Type": "SelfManagedActiveDirectoryConfiguration", "Required": false, "MarkdownDocumentation": "`SelfManagedActiveDirectoryConfiguration`\n\nThe configuration that Amazon FSx uses to join the ONTAP storage virtual machine\n(SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.\n*Required*: No\n*Type*: [SelfManagedActiveDirectoryConfiguration](./aws-properties-fsx-storagevirtualmachine-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration", "UpdateType": "Mutable" }, "NetBiosName": { "Required": false, "MarkdownDocumentation": "`NetBiosName`\n\nThe NetBIOS name of the Active Directory computer object that will be created for your SVM.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-netbiosname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::FSx::StorageVirtualMachine.SelfManagedActiveDirectoryConfiguration": { "MarkdownDocumentation": "`AWS::FSx::StorageVirtualMachine.SelfManagedActiveDirectoryConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html", "Properties": { "FileSystemAdministratorsGroup": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration-filesystemadministratorsgroup", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UserName": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DomainName": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration-domainname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OrganizationalUnitDistinguishedName": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration-organizationalunitdistinguishedname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DomainJoinServiceAccountSecret": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration-domainjoinserviceaccountsecret", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DnsIps": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration-dnsips", "UpdateType": "Mutable" }, "Password": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration-password", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::FSx::Volume.AggregateConfiguration": { "MarkdownDocumentation": "`AWS::FSx::Volume.AggregateConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-aggregateconfiguration.html", "Properties": { "Aggregates": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-aggregateconfiguration.html#cfn-fsx-volume-ontapconfiguration-aggregateconfiguration-aggregates", "UpdateType": "Immutable" }, "ConstituentsPerAggregate": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-aggregateconfiguration.html#cfn-fsx-volume-ontapconfiguration-aggregateconfiguration-constituentsperaggregate", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::FSx::Volume.AutocommitPeriod": { "MarkdownDocumentation": "`AWS::FSx::Volume.AutocommitPeriod`\n\nSets the autocommit period of files in an FSx for ONTAP SnapLock volume, which determines\nhow long the files must\nremain unmodified before they're automatically transitioned to the write once, read many (WORM) state.\nFor more information, see\n[Autocommit](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-autocommit).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration-autocommitperiod.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nDefines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.\nSetting this value to `NONE` disables autocommit. The default value is `NONE`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MINUTES | HOURS | DAYS | MO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MINUTES", "HOURS", "DAYS", "MONTHS", "YEARS", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration-autocommitperiod.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration-autocommitperiod-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Value": { "Required": false, "MarkdownDocumentation": "`Value`\n\nDefines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.\nThe following ranges are valid:\n* `Minutes`: 5 - 65,535\n* `Hours`: 1 - 65,535\n* `Days`: 1 - 3,650\n* `Months`: 1 - 120\n* `Years`: 1 - 10\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration-autocommitperiod.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration-autocommitperiod-value", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::FSx::Volume.ClientConfigurations": { "MarkdownDocumentation": "`AWS::FSx::Volume.ClientConfigurations`\n\nSpecifies who can mount an OpenZFS file system and the options available while\nmounting the file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html", "Properties": { "Options": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`Options`\n\nThe options to use when mounting the file system. For a list of options that you can\nuse with Network File System (NFS), see the [exports(5) - Linux man page](https://linux.die.net/man/5/exports). When\nchoosing your options, consider the following:\n* `crossmnt` is used by default. If you don't specify\n `crossmnt` when changing the client configuration, you won't be\n able to see or access snapshots in your file system's snapshot directory.\n* `sync` is used by default. If you instead specify\n `async`, the system acknowledges writes before writing to disk.\n If the system crashes before the writes are finished, you lose the unwritten\n data.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html#cfn-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations-options", "UpdateType": "Mutable" }, "Clients": { "Required": true, "MarkdownDocumentation": "`Clients`\n\nA value that specifies who can mount the file system. You can provide a wildcard\ncharacter (`*`), an IP address (`0.0.0.0`), or a CIDR address\n(`192.0.2.0/24`). By default, Amazon FSx uses the wildcard\ncharacter when specifying the client.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ -~]{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html#cfn-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations-clients", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::FSx::Volume.NfsExports": { "MarkdownDocumentation": "`AWS::FSx::Volume.NfsExports`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports.html", "Properties": { "ClientConfigurations": { "Type": "List", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports.html#cfn-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations", "ItemType": "ClientConfigurations", "UpdateType": "Mutable" } } }, "AWS::FSx::Volume.OntapConfiguration": { "MarkdownDocumentation": "`AWS::FSx::Volume.OntapConfiguration`\n\nSpecifies the configuration of the ONTAP volume that you are creating.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html", "Properties": { "JunctionPath": { "Required": false, "MarkdownDocumentation": "`JunctionPath`\n\nSpecifies the location in the SVM's namespace where the volume is mounted.\nThis parameter is required. The `JunctionPath` must have a leading\nforward slash, such as `/vol3`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-junctionpath", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StorageVirtualMachineId": { "Required": true, "MarkdownDocumentation": "`StorageVirtualMachineId`\n\nSpecifies the ONTAP SVM in which to create the volume.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(svm-[0-9a-f]{17,})$`\n*Minimum*: `21`\n*Maximum*: `21`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-storagevirtualmachineid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "TieringPolicy": { "Type": "TieringPolicy", "Required": false, "MarkdownDocumentation": "`TieringPolicy`\n\nDescribes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent\ntiering automatically transitions a volume's data between the file system's primary storage and capacity\npool 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](./aws-properties-fsx-volume-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-tieringpolicy", "UpdateType": "Mutable" }, "SizeInMegabytes": { "Required": false, "MarkdownDocumentation": "`SizeInMegabytes`\n\nUse `SizeInBytes` instead. Specifies the size of the volume, in megabytes (MB), that you are creating.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-sizeinmegabytes", "PrimitiveType": "String", "UpdateType": "Mutable" }, "VolumeStyle": { "Required": false, "MarkdownDocumentation": "`VolumeStyle`\n\nUse to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes,\nFlexVol and FlexGroup volumes. For more information, see\n[Volume styles](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles) in the Amazon FSx for NetApp ONTAP User Guide.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLEXVOL | FLEXGROUP...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FLEXVOL", "FLEXGROUP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-volumestyle", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SizeInBytes": { "Required": false, "MarkdownDocumentation": "`SizeInBytes`\n\nSpecifies the configured size of the volume, in bytes.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-sizeinbytes", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecurityStyle": { "Required": false, "MarkdownDocumentation": "`SecurityStyle`\n\nSpecifies the security style for the volume. If a volume's security style is not specified,\nit is automatically set to the root volume's security style. The security style determines the type of permissions\nthat FSx for ONTAP uses to control data access. Specify one of the following values:\n* `UNIX` if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n* `NTFS` if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.\n* `MIXED` This is an advanced setting. For more information, see the topic\n [What the security styles and their effects are](https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html)\n in the NetApp Documentation Center.\nFor more information, see [Volume security style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) in the\nFSx for ONTAP User Guide.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNIX | NTFS | MIXED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNIX", "NTFS", "MIXED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-securitystyle", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SnaplockConfiguration": { "Type": "SnaplockConfiguration", "Required": false, "MarkdownDocumentation": "`SnaplockConfiguration`\n\nThe SnapLock configuration object for an FSx for ONTAP SnapLock volume.\n*Required*: No\n*Type*: [SnaplockConfiguration](./aws-properties-fsx-volume-snaplockconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration", "UpdateType": "Mutable" }, "AggregateConfiguration": { "Type": "AggregateConfiguration", "Required": false, "MarkdownDocumentation": "`AggregateConfiguration`\n\nUsed to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.\n*Required*: No\n*Type*: [AggregateConfiguration](./aws-properties-fsx-volume-aggregateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-aggregateconfiguration", "UpdateType": "Mutable" }, "SnapshotPolicy": { "Required": false, "MarkdownDocumentation": "`SnapshotPolicy`\n\nSpecifies 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\n the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after\n 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\n 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\n 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)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-snapshotpolicy", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StorageEfficiencyEnabled": { "Required": false, "MarkdownDocumentation": "`StorageEfficiencyEnabled`\n\nSet to true to enable deduplication, compression, and compaction storage\nefficiency features on the volume, or set to false to disable them.\n`StorageEfficiencyEnabled` is required when creating a `RW` volume (`OntapVolumeType` set to `RW`).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-storageefficiencyenabled", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CopyTagsToBackups": { "Required": false, "MarkdownDocumentation": "`CopyTagsToBackups`\n\nA boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to\nfalse. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups\nwhere the user doesn't specify tags. If this value is true, and you specify one or more tags, only the\nspecified tags are copied to backups. If you specify one or more tags when creating a user-initiated\nbackup, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-copytagstobackups", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OntapVolumeType": { "Required": false, "MarkdownDocumentation": "`OntapVolumeType`\n\nSpecifies 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\n 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/managing-volumes.html#volume-types)\nin the Amazon FSx for NetApp ONTAP User Guide.\n*Required*: No\n*Type*: String\n*Allowed values*: `RW | DP`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "RW", "DP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-ontapvolumetype", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::FSx::Volume.OpenZFSConfiguration": { "MarkdownDocumentation": "`AWS::FSx::Volume.OpenZFSConfiguration`\n\nSpecifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html", "Properties": { "ReadOnly": { "Required": false, "MarkdownDocumentation": "`ReadOnly`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-readonly", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Options": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Options`\n\nTo delete the volume's child volumes, snapshots, and clones, use the string\n`DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-options", "UpdateType": "Mutable" }, "DataCompressionType": { "Required": false, "MarkdownDocumentation": "`DataCompressionType`\n\nSpecifies the method used to compress the data on the volume. The compression\ntype is `NONE` by default.\n* `NONE` - Doesn't compress the data on the volume.\n `NONE` is the default.\n* `ZSTD` - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better\n compression ratio to minimize on-disk storage utilization.\n* `LZ4` - Compresses the data in the volume using the LZ4\n compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive\n and delivers higher write throughput speeds.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | ZSTD | LZ4...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "ZSTD", "LZ4" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-datacompressiontype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NfsExports": { "Type": "List", "Required": false, "MarkdownDocumentation": "`NfsExports`\n\nThe configuration object for mounting a Network File System (NFS) file system.\n*Required*: No\n*Type*: [Array](./aws-properties-fsx-volume-nfsexports.html) of [NfsExports](./aws-properties-fsx-volume-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-nfsexports", "ItemType": "NfsExports", "UpdateType": "Mutable" }, "StorageCapacityQuotaGiB": { "Required": false, "MarkdownDocumentation": "`StorageCapacityQuotaGiB`\n\nSets the maximum storage size in gibibytes (GiB) for the volume. You can specify\na quota that is larger than the storage on the parent volume. A volume quota limits\nthe amount of storage that the volume can consume to the configured amount, but does not\nguarantee the space will be available on the parent volume. To guarantee quota space, you must also set\n`StorageCapacityReservationGiB`. To *not* specify a storage capacity quota, set this to `-1`.\nFor more information, see\n[Volume properties](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-storagecapacityquotagib", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CopyTagsToSnapshots": { "Required": false, "MarkdownDocumentation": "`CopyTagsToSnapshots`\n\nA Boolean value indicating whether tags for the volume should be copied to snapshots.\nThis value defaults to `false`. If this value is set to\u00a0`true`, and you do not specify any tags, all tags for the original volume are copied over to snapshots.\nIf this value is\u00a0set to `true`, and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-copytagstosnapshots", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ParentVolumeId": { "Required": true, "MarkdownDocumentation": "`ParentVolumeId`\n\nThe ID of the volume to use as the parent volume of the volume that you are creating.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(fsvol-[0-9a-f]{17,})$`\n*Minimum*: `23`\n*Maximum*: `23`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-parentvolumeid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "StorageCapacityReservationGiB": { "Required": false, "MarkdownDocumentation": "`StorageCapacityReservationGiB`\n\nSpecifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting\n`StorageCapacityReservationGiB` guarantees that the specified amount of storage space\non the parent volume will always be available for the volume.\nYou can't reserve more storage than the parent volume has. To *not* specify a storage capacity\nreservation, set this to `0` or `-1`. For more information, see\n[Volume properties](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-storagecapacityreservationgib", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RecordSizeKiB": { "Required": false, "MarkdownDocumentation": "`RecordSizeKiB`\n\nSpecifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).\nFor file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB.\nFor all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB.\nWe 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).\nFor additional guidance on when to set a custom record size, see\n[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*: `4096`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-recordsizekib", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "OriginSnapshot": { "Type": "OriginSnapshot", "Required": false, "MarkdownDocumentation": "`OriginSnapshot`\n\nThe configuration object that specifies the snapshot to use as the origin of the data\nfor the volume.\n*Required*: No\n*Type*: [OriginSnapshot](./aws-properties-fsx-volume-originsnapshot.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-originsnapshot", "UpdateType": "Immutable" }, "UserAndGroupQuotas": { "Type": "List", "Required": false, "MarkdownDocumentation": "`UserAndGroupQuotas`\n\nConfigures how much storage users and groups can use on the volume.\n*Required*: No\n*Type*: [Array](./aws-properties-fsx-volume-userandgroupquotas.html) of [UserAndGroupQuotas](./aws-properties-fsx-volume-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-userandgroupquotas", "ItemType": "UserAndGroupQuotas", "UpdateType": "Mutable" } } }, "AWS::FSx::Volume.OriginSnapshot": { "MarkdownDocumentation": "`AWS::FSx::Volume.OriginSnapshot`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-originsnapshot.html", "Properties": { "CopyStrategy": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-originsnapshot.html#cfn-fsx-volume-openzfsconfiguration-originsnapshot-copystrategy", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SnapshotARN": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-originsnapshot.html#cfn-fsx-volume-openzfsconfiguration-originsnapshot-snapshotarn", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::FSx::Volume.RetentionPeriod": { "MarkdownDocumentation": "`AWS::FSx::Volume.RetentionPeriod`\n\nSpecifies the retention period of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed.\nFiles can't be\ndeleted or modified during the retention period.\nFor more information, see\n[Working with the retention\nperiod in SnapLock](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-retentionperiod.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nDefines the type of time for the retention period of an FSx for ONTAP SnapLock volume.\nSet it to\none of the valid types. If you set it to `INFINITE`, the files are retained forever. If you set it to\n`UNSPECIFIED`, the files are retained until you set an explicit retention period.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SECONDS | MINUTES | HOURS |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SECONDS", "MINUTES", "HOURS", "DAYS", "MONTHS", "YEARS", "INFINITE", "UNSPECIFIED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-retentionperiod.html#cfn-fsx-volume-retentionperiod-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Value": { "Required": false, "MarkdownDocumentation": "`Value`\n\nDefines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.\nYou can't set a value for `INFINITE` or `UNSPECIFIED`. For all other options, the\nfollowing ranges are valid:\n* `Seconds`: 0 - 65,535\n* `Minutes`: 0 - 65,535\n* `Hours`: 0 - 24\n* `Days`: 0 - 365\n* `Months`: 0 - 12\n* `Years`: 0 - 100\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-retentionperiod.html#cfn-fsx-volume-retentionperiod-value", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::FSx::Volume.SnaplockConfiguration": { "MarkdownDocumentation": "`AWS::FSx::Volume.SnaplockConfiguration`\n\nSpecifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration.html", "Properties": { "AuditLogVolume": { "Required": false, "MarkdownDocumentation": "`AuditLogVolume`\n\nEnables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default\nvalue is `false`. If you set `AuditLogVolume` to `true`, the SnapLock volume is\ncreated as an audit log volume. The minimum retention period for an audit log volume is six months.\nFor more information, see\n[SnapLock audit log volumes](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration-auditlogvolume", "PrimitiveType": "String", "UpdateType": "Mutable" }, "VolumeAppendModeEnabled": { "Required": false, "MarkdownDocumentation": "`VolumeAppendModeEnabled`\n\nEnables or disables volume-append mode\non an FSx for ONTAP SnapLock volume. Volume-append mode allows you to\ncreate WORM-appendable files and write data to them incrementally.\nThe default value is `false`.\nFor more information, see [Volume-append mode](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration-volumeappendmodeenabled", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AutocommitPeriod": { "Type": "AutocommitPeriod", "Required": false, "MarkdownDocumentation": "`AutocommitPeriod`\n\nThe configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.\n*Required*: No\n*Type*: [AutocommitPeriod](./aws-properties-fsx-volume-autocommitperiod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration-autocommitperiod", "UpdateType": "Mutable" }, "RetentionPeriod": { "Type": "SnaplockRetentionPeriod", "Required": false, "MarkdownDocumentation": "`RetentionPeriod`\n\nSpecifies the retention period of an FSx for ONTAP SnapLock volume.\n*Required*: No\n*Type*: [SnaplockRetentionPeriod](./aws-properties-fsx-volume-snaplockretentionperiod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration-retentionperiod", "UpdateType": "Mutable" }, "PrivilegedDelete": { "Required": false, "MarkdownDocumentation": "`PrivilegedDelete`\n\nEnables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock\nEnterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read\nmany (WORM) files even\nif they have active retention periods. `PERMANENTLY_DISABLED` is a terminal state.\nIf privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default\nvalue is `DISABLED`.\nFor more information, see [Privileged delete](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete).\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLED | ENABLED | PERMAN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED", "PERMANENTLY_DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration-privilegeddelete", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SnaplockType": { "Required": true, "MarkdownDocumentation": "`SnaplockType`\n\nSpecifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed.\nYou can choose one of the following retention modes:\n* `COMPLIANCE`: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted\n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect\n against ransomware attacks. For more information,\n see [SnapLock Compliance](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html).\n* `ENTERPRISE`: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users\n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity\n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see\n [SnapLock Enterprise](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `COMPLIANCE | ENTERPRISE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "COMPLIANCE", "ENTERPRISE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-snaplockconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration-snaplocktype", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::FSx::Volume.SnaplockRetentionPeriod": { "MarkdownDocumentation": "`AWS::FSx::Volume.SnaplockRetentionPeriod`\n\nThe configuration to set the retention period of an FSx for ONTAP SnapLock volume. The retention\nperiod includes default, maximum, and minimum settings. For more information, see\n[Working with the retention period\nin SnapLock](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockretentionperiod.html", "Properties": { "DefaultRetention": { "Type": "RetentionPeriod", "Required": true, "MarkdownDocumentation": "`DefaultRetention`\n\nThe retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an\nFSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to\nthe minimum retention period and less than or equal to the maximum retention period.\n*Required*: Yes\n*Type*: [RetentionPeriod](./aws-properties-fsx-volume-retentionperiod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockretentionperiod.html#cfn-fsx-volume-snaplockretentionperiod-defaultretention", "UpdateType": "Mutable" }, "MaximumRetention": { "Type": "RetentionPeriod", "Required": true, "MarkdownDocumentation": "`MaximumRetention`\n\nThe longest retention period that can be assigned to a WORM file on\nan FSx for ONTAP SnapLock volume.\n*Required*: Yes\n*Type*: [RetentionPeriod](./aws-properties-fsx-volume-retentionperiod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockretentionperiod.html#cfn-fsx-volume-snaplockretentionperiod-maximumretention", "UpdateType": "Mutable" }, "MinimumRetention": { "Type": "RetentionPeriod", "Required": true, "MarkdownDocumentation": "`MinimumRetention`\n\nThe shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.\n*Required*: Yes\n*Type*: [RetentionPeriod](./aws-properties-fsx-volume-retentionperiod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockretentionperiod.html#cfn-fsx-volume-snaplockretentionperiod-minimumretention", "UpdateType": "Mutable" } } }, "AWS::FSx::Volume.TieringPolicy": { "MarkdownDocumentation": "`AWS::FSx::Volume.TieringPolicy`\n\nDescribes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent\ntiering automatically transitions a volume's data between the file system's primary storage and capacity\npool 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-tieringpolicy.html", "Properties": { "CoolingPeriod": { "Required": false, "MarkdownDocumentation": "`CoolingPeriod`\n\nSpecifies the number of days that user data in a volume must remain inactive before it is considered \"cold\"\nand moved to the capacity pool. Used with the `AUTO` and `SNAPSHOT_ONLY` tiering policies.\nEnter a whole number between 2 and 183. Default values are 31 days for `AUTO` and 2 days for\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-tieringpolicy.html#cfn-fsx-volume-ontapconfiguration-tieringpolicy-coolingperiod", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nSpecifies 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\n based on your access patterns.\n* `ALL` - moves all user data blocks in both the active file system and Snapshot copies to the\n storage pool tier.\n* `NONE` - keeps a volume's data in the primary storage tier, preventing it from being moved to\n the capacity pool tier.\n*Required*: No\n*Type*: String\n*Allowed values*: `SNAPSHOT_ONLY | AUTO | ALL ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-tieringpolicy.html#cfn-fsx-volume-ontapconfiguration-tieringpolicy-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::FSx::Volume.UserAndGroupQuotas": { "MarkdownDocumentation": "`AWS::FSx::Volume.UserAndGroupQuotas`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html#cfn-fsx-volume-openzfsconfiguration-userandgroupquotas-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Id": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html#cfn-fsx-volume-openzfsconfiguration-userandgroupquotas-id", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "StorageCapacityQuotaGiB": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html#cfn-fsx-volume-openzfsconfiguration-userandgroupquotas-storagecapacityquotagib", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::FinSpace::Environment.AttributeMapItems": { "MarkdownDocumentation": "`AWS::FinSpace::Environment.AttributeMapItems`\n\nThe `AttributeMapItems` property type specifies Property description not available. for an [AWS::FinSpace::Environment](./aws-resource-finspace-environment.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-attributemapitems.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-attributemapitems.html#cfn-finspace-environment-attributemapitems-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-attributemapitems.html#cfn-finspace-environment-attributemapitems-key", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FinSpace::Environment.FederationParameters": { "MarkdownDocumentation": "`AWS::FinSpace::Environment.FederationParameters`\n\nConfiguration information when authentication mode is FEDERATED.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html", "Properties": { "AttributeMap": { "MarkdownDocumentation": "`AttributeMap`\n\nSAML attribute name and value. The name must always be `Email` and the value should be set to\nthe attribute definition in which user email is set. For example, name would be `Email` and\nvalue `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`.\nPlease check your SAML 2.0 compliant identity provider (IdP) documentation for details.\n*Required*: No\n*Type*: Array of [AttributeMapItems](./aws-properties-finspace-environment-attributemapitems.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-attributemap", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AttributeMapItems", "DuplicatesAllowed": true }, "FederationProviderName": { "MarkdownDocumentation": "`FederationProviderName`\n\nName of the identity provider (IdP).\n*Required*: No\n*Type*: String\n*Pattern*: `[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-federationprovidername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SamlMetadataURL": { "MarkdownDocumentation": "`SamlMetadataURL`\n\nProvide the metadata URL from your SAML 2.0 compliant identity provider (IdP).\n*Required*: No\n*Type*: String\n*Pattern*: `^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-samlmetadataurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FederationURN": { "MarkdownDocumentation": "`FederationURN`\n\nThe Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9._\\-:\\/#\\+]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-federationurn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SamlMetadataDocument": { "MarkdownDocumentation": "`SamlMetadataDocument`\n\nSAML 2.0 Metadata document from identity provider (IdP).\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `1000`\n*Maximum*: `10000000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-samlmetadatadocument", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ApplicationCallBackURL": { "MarkdownDocumentation": "`ApplicationCallBackURL`\n\nThe redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration\n(IdP).\n*Required*: No\n*Type*: String\n*Pattern*: `^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-applicationcallbackurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FinSpace::Environment.SuperuserParameters": { "MarkdownDocumentation": "`AWS::FinSpace::Environment.SuperuserParameters`\n\nConfiguration information for the superuser.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-superuserparameters.html", "Properties": { "FirstName": { "MarkdownDocumentation": "`FirstName`\n\nThe first name of the superuser.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]{1,50}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-superuserparameters.html#cfn-finspace-environment-superuserparameters-firstname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LastName": { "MarkdownDocumentation": "`LastName`\n\nThe last name of the superuser.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]{1,50}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-superuserparameters.html#cfn-finspace-environment-superuserparameters-lastname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EmailAddress": { "MarkdownDocumentation": "`EmailAddress`\n\nThe email address of the superuser.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-superuserparameters.html#cfn-finspace-environment-superuserparameters-emailaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Forecast::Dataset.AttributesItems": { "MarkdownDocumentation": "`AWS::Forecast::Dataset.AttributesItems`\n\nThe `AttributesItems` property type specifies Property description not available. for an [AWS::Forecast::Dataset](./aws-resource-forecast-dataset.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html", "Properties": { "AttributeType": { "MarkdownDocumentation": "`AttributeType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `string | integer | float | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "string", "integer", "float", "timestamp", "geolocation" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html#cfn-forecast-dataset-attributesitems-attributetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html#cfn-forecast-dataset-attributesitems-attributename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Forecast::Dataset.EncryptionConfig": { "MarkdownDocumentation": "`AWS::Forecast::Dataset.EncryptionConfig`\n\nAn AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to\naccess the key. You can specify this optional object in the\n[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) and [CreatePredictor](https://docs.aws.amazon.com/forecast/latest/dg/API_CreatePredictor.html) requests.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws[-a-z]*:kms:.*:key/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html#cfn-forecast-dataset-encryptionconfig-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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\naccount, you get an `InvalidInputException` error.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html#cfn-forecast-dataset-encryptionconfig-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Forecast::Dataset.Schema": { "MarkdownDocumentation": "`AWS::Forecast::Dataset.Schema`\n\nDefines the fields of a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-schema.html", "Properties": { "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nAn array of attributes specifying the name and type of each field in a dataset.\n*Required*: No\n*Type*: Array of [AttributesItems](./aws-properties-forecast-dataset-attributesitems.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-schema.html#cfn-forecast-dataset-schema-attributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AttributesItems", "DuplicatesAllowed": true } } }, "AWS::Forecast::Dataset.TagsItems": { "MarkdownDocumentation": "`AWS::Forecast::Dataset.TagsItems`\n\nThe `TagsItems` property type specifies Property description not available. for an [AWS::Forecast::Dataset](./aws-resource-forecast-dataset.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html#cfn-forecast-dataset-tagsitems-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html#cfn-forecast-dataset-tagsitems-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FraudDetector::Detector.EntityType": { "MarkdownDocumentation": "`AWS::FraudDetector::Detector.EntityType`\n\nThe entity type details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe entity type description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when the entity type was created.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when the entity type was last updated.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true`,\nCloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false`, CloudFormation will validate that the object exists and\nthen use it within the resource without making changes to the object.\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these Variables and CloudFormation will\ncreate/update/delete the variables as part of stack operations. However, if you set `Inline=false`, CloudFormation will associate the variables to your detector but not execute any\nchanges to the variables.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-inline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe entity type ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn\\:aws[a-z-]{0,15}\\:frauddetector\\:[a-z0-9-]{3,20}\\:[0-9]{12}\\:[^\\s]{2,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-detector-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe entity type 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FraudDetector::Detector.EventType": { "MarkdownDocumentation": "`AWS::FraudDetector::Detector.EventType`\n\nThe event type details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html", "Properties": { "EntityTypes": { "MarkdownDocumentation": "`EntityTypes`\n\nThe event type entity types.\n*Required*: No\n*Type*: Array of [EntityType](./aws-properties-frauddetector-detector-entitytype.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-entitytypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EntityType", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe event type description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when the event type was created.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when the event type was last updated.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Labels": { "MarkdownDocumentation": "`Labels`\n\nThe event type labels.\n*Required*: No\n*Type*: Array of [Label](./aws-properties-frauddetector-detector-label.html)\n*Minimum*: `2`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-labels", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Label", "DuplicatesAllowed": true }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true`,\nCloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false`, CloudFormation will validate that the object exists and\nthen use it within the resource without making changes to the object.\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will\ncreate/update/delete the Variables as part of stack operations. However, if you set `Inline=false`, CloudFormation will associate the variables to your detector but not execute any\nchanges to the variables.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-inline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EventVariables": { "MarkdownDocumentation": "`EventVariables`\n\nThe event type event variables.\n*Required*: No\n*Type*: Array of [EventVariable](./aws-properties-frauddetector-detector-eventvariable.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-eventvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EventVariable", "DuplicatesAllowed": true }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe entity type ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn\\:aws[a-z-]{0,15}\\:frauddetector\\:[a-z0-9-]{3,20}\\:[0-9]{12}\\:[^\\s]{2,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-detector-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe event type name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FraudDetector::Detector.EventVariable": { "MarkdownDocumentation": "`AWS::FraudDetector::Detector.EventVariable`\n\nThe event type variable for the detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe default value of the event variable. This is required if you are providing the details of your variables instead of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the event variable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp for when the event variable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VariableType": { "MarkdownDocumentation": "`VariableType`\n\nThe type of event variable. For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types).\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTH_CODE | AVS | BILLING_A...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTH_CODE", "AVS", "BILLING_ADDRESS_L1", "BILLING_ADDRESS_L2", "BILLING_CITY", "BILLING_COUNTRY", "BILLING_NAME", "BILLING_PHONE", "BILLING_STATE", "BILLING_ZIP", "CARD_BIN", "CATEGORICAL", "CURRENCY_CODE", "EMAIL_ADDRESS", "FINGERPRINT", "FRAUD_LABEL", "FREE_FORM_TEXT", "IP_ADDRESS", "NUMERIC", "ORDER_ID", "PAYMENT_TYPE", "PHONE_NUMBER", "PRICE", "PRODUCT_CATEGORY", "SHIPPING_ADDRESS_L1", "SHIPPING_ADDRESS_L2", "SHIPPING_CITY", "SHIPPING_COUNTRY", "SHIPPING_NAME", "SHIPPING_PHONE", "SHIPPING_STATE", "SHIPPING_ZIP", "USERAGENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-variabletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe data type of the event variable.\nValid values: `STRING | INTEGER | BOOLEAN | FLOAT`\n*Required*: No\n*Type*: String\n*Allowed values*: `STRING | INTEGER | FLOAT | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "INTEGER", "FLOAT", "BOOLEAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-datatype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp for when the event variable was last updated.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true`,\nCloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false`, CloudFormation will validate that the object exists and\nthen use it within the resource without making changes to the object.\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will\ncreate/update/delete the variables as part of stack operations. However, if you set `Inline=false`, CloudFormation will associate the variables to your detector but not execute any\nchanges to the variables.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-inline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe event variable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-detector-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the event 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nThe data source of the event variable.\nValid values: `EVENT | EXTERNAL_MODEL_SCORE`\nWhen defining a variable within a detector, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true.\nIf the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource.\n*Required*: No\n*Type*: String\n*Allowed values*: `EVENT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "EVENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-datasource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FraudDetector::Detector.Label": { "MarkdownDocumentation": "`AWS::FraudDetector::Detector.Label`\n\nThe label details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe label description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when the event type was created.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when the label was last updated.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true`,\nCloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false`, CloudFormation will validate that the object exists and\nthen use it within the resource without making changes to the object.\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will\ncreate/update/delete the variables as part of stack operations. However, if you set `Inline=false`, CloudFormation will associate the variables to your detector but not execute any\nchanges to the variables.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-inline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe label ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn\\:aws[a-z-]{0,15}\\:frauddetector\\:[a-z0-9-]{3,20}\\:[0-9]{12}\\:[^\\s]{2,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-detector-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe label 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FraudDetector::Detector.Model": { "MarkdownDocumentation": "`AWS::FraudDetector::Detector.Model`\n\nThe model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-model.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe ARN of the model.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn\\:aws[a-z-]{0,15}\\:frauddetector\\:[a-z0-9-]{3,20}\\:[0-9]{12}\\:[^\\s]{2,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-model.html#cfn-frauddetector-detector-model-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FraudDetector::Detector.Outcome": { "MarkdownDocumentation": "`AWS::FraudDetector::Detector.Outcome`\n\nThe outcome.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe outcome description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nThe timestamp when the outcome was created.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe timestamp when the outcome was last updated.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true`,\nCloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false`, CloudFormation will validate that the object exists and\nthen use it within the resource without making changes to the object.\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will\ncreate/update/delete the variables as part of stack operations. However, if you set `Inline=false`, CloudFormation will associate the variables to your detector but not execute any\nchanges to the variables.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-inline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe outcome ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn\\:aws[a-z-]{0,15}\\:frauddetector\\:[a-z0-9-]{3,20}\\:[0-9]{12}\\:[^\\s]{2,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-detector-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe outcome name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FraudDetector::Detector.Rule": { "MarkdownDocumentation": "`AWS::FraudDetector::Detector.Rule`\n\nA rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe rule description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp for when the rule 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Language": { "MarkdownDocumentation": "`Language`\n\nThe rule language.\nValid Value: DETECTORPL\n*Required*: No\n*Type*: String\n*Allowed values*: `DETECTORPL`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DETECTORPL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-language", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe rule expression. A rule expression captures the business logic. For more information, see [Rule language reference](https://docs.aws.amazon.com/frauddetector/latest/ug/rule-language-reference.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleId": { "MarkdownDocumentation": "`RuleId`\n\nThe rule ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-ruleid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe detector for which the rule is associated.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-detectorid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleVersion": { "MarkdownDocumentation": "`RuleVersion`\n\nThe rule version.\n*Required*: No\n*Type*: String\n*Pattern*: `^([1-9][0-9]*)$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-ruleversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp for when the rule was last updated.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe rule 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Outcomes": { "MarkdownDocumentation": "`Outcomes`\n\nThe rule outcome.\n*Required*: No\n*Type*: Array of [Outcome](./aws-properties-frauddetector-detector-outcome.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-outcomes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Outcome", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-detector-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html#cfn-frauddetector-detector-rule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::FraudDetector::EventType.EntityType": { "MarkdownDocumentation": "`AWS::FraudDetector::EventType.EntityType`\n\nThe entity type details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-entitytype.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe entity type description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-entitytype.html#cfn-frauddetector-eventtype-entitytype-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when the entity type was created.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-entitytype.html#cfn-frauddetector-eventtype-entitytype-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when the entity type was last updated.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-entitytype.html#cfn-frauddetector-eventtype-entitytype-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true`,\nCloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false`, CloudFormation will validate that the object exists and\nthen use it within the resource without making changes to the object.\nFor example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will\ncreate/update/delete the variables as part of stack operations. However, if you set `Inline=false`, CloudFormation will associate the variables to your event type but not execute any\nchanges to the variables.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-entitytype.html#cfn-frauddetector-eventtype-entitytype-inline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe entity type ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn\\:aws[a-z-]{0,15}\\:frauddetector\\:[a-z0-9-]{3,20}\\:[0-9]{12}\\:[^\\s]{2,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-entitytype.html#cfn-frauddetector-eventtype-entitytype-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-eventtype-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-entitytype.html#cfn-frauddetector-eventtype-entitytype-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe entity type name.\n`^[0-9a-z_-]+$`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-entitytype.html#cfn-frauddetector-eventtype-entitytype-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FraudDetector::EventType.EventVariable": { "MarkdownDocumentation": "`AWS::FraudDetector::EventType.EventVariable`\n\nThe variables associated with this event type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe default value of the event 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe event variable description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp for when event variable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VariableType": { "MarkdownDocumentation": "`VariableType`\n\nThe type of event variable. For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/variables.html#variable-types).\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTH_CODE | AVS | BILLING_A...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTH_CODE", "AVS", "BILLING_ADDRESS_L1", "BILLING_ADDRESS_L2", "BILLING_CITY", "BILLING_COUNTRY", "BILLING_NAME", "BILLING_PHONE", "BILLING_STATE", "BILLING_ZIP", "CARD_BIN", "CATEGORICAL", "CURRENCY_CODE", "EMAIL_ADDRESS", "FINGERPRINT", "FRAUD_LABEL", "FREE_FORM_TEXT", "IP_ADDRESS", "NUMERIC", "ORDER_ID", "PAYMENT_TYPE", "PHONE_NUMBER", "PRICE", "PRODUCT_CATEGORY", "SHIPPING_ADDRESS_L1", "SHIPPING_ADDRESS_L2", "SHIPPING_CITY", "SHIPPING_COUNTRY", "SHIPPING_NAME", "SHIPPING_PHONE", "SHIPPING_STATE", "SHIPPING_ZIP", "USERAGENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-variabletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe data type of the event variable. For more information, see [Data types](https://docs.aws.amazon.com/frauddetector/latest/ug/variables.html#data-types).\n*Required*: No\n*Type*: String\n*Allowed values*: `STRING | INTEGER | FLOAT | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "INTEGER", "FLOAT", "BOOLEAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-datatype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp for when the event variable was last updated.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true`,\nCloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false`, CloudFormation will validate that the object exists and\nthen use it within the resource without making changes to the object.\nFor example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will\ncreate/update/delete the Variables as part of stack operations. However, if you set `Inline=false`, CloudFormation will associate the variables to your event type but not execute any\nchanges to the variables.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-inline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe event variable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-eventtype-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the event 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nThe source of the event variable.\nValid values: `EVENT | EXTERNAL_MODEL_SCORE`\nWhen defining a variable within a event type, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true.\nIf the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource.\n*Required*: No\n*Type*: String\n*Allowed values*: `EVENT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "EVENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-eventvariable.html#cfn-frauddetector-eventtype-eventvariable-datasource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::FraudDetector::EventType.Label": { "MarkdownDocumentation": "`AWS::FraudDetector::EventType.Label`\n\nThe label associated with the event type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-label.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe label description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-label.html#cfn-frauddetector-eventtype-label-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when the event type was created.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-label.html#cfn-frauddetector-eventtype-label-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedTime": { "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when the label was last updated.\n*Required*: No\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-label.html#cfn-frauddetector-eventtype-label-lastupdatedtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inline": { "MarkdownDocumentation": "`Inline`\n\nIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true`,\nCloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false`, CloudFormation will validate that the object exists and\nthen use it within the resource without making changes to the object.\nFor example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will\ncreate/update/delete the variables as part of stack operations. However, if you set `Inline=false`, CloudFormation will associate the variables to your EventType but not execute any\nchanges to the variables.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-label.html#cfn-frauddetector-eventtype-label-inline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe label ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn\\:aws[a-z-]{0,15}\\:frauddetector\\:[a-z0-9-]{3,20}\\:[0-9]{12}\\:[^\\s]{2,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-label.html#cfn-frauddetector-eventtype-label-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-eventtype-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-label.html#cfn-frauddetector-eventtype-label-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe label 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-eventtype-label.html#cfn-frauddetector-eventtype-label-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GameLift::Alias.RoutingStrategy": { "MarkdownDocumentation": "`AWS::GameLift::Alias.RoutingStrategy`\n\nThe routing configuration for a fleet alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nA type of routing strategy.\nPossible routing types include the following:\n* **SIMPLE** - The alias resolves to one specific fleet. Use\n this type when routing to active fleets.\n* **TERMINAL** - The alias does not resolve to a fleet but\n instead can be used to display a message to the user. A terminal alias throws a\n `TerminalRoutingStrategyException` with the message that you specified in the\n `Message` property.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SIMPLE | TERMINAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SIMPLE", "TERMINAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nThe message text to be used with a terminal routing strategy. If you specify\n`TERMINAL` for the `Type` property, you must specify this\nproperty.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FleetId": { "MarkdownDocumentation": "`FleetId`\n\nA unique identifier for a fleet that the alias points to. If you specify\n`SIMPLE` for the `Type` property, you must specify this\nproperty.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-z]*fleet-[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-fleetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GameLift::Build.StorageLocation": { "MarkdownDocumentation": "`AWS::GameLift::Build.StorageLocation`\n\nThe location in Amazon S3 where build or script files are stored for access by\nAmazon GameLift.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html", "Properties": { "ObjectVersion": { "MarkdownDocumentation": "`ObjectVersion`\n\nA version of a stored file to retrieve, if the object versioning feature is turned on for the S3 bucket.\nUse this parameter to specify a specific version. If this parameter isn't set, Amazon GameLift Servers retrieves\nthe latest version of the file.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-objectversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nAn Amazon S3 bucket identifier. The name of the S3 bucket.\n###### Note\nAmazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot\n(.).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARNfor an IAM role that allows Amazon GameLift 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLift::Fleet.AnywhereConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.AnywhereConfiguration`\n\nAmazon GameLift Servers configuration options for your Anywhere fleets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html", "Properties": { "Cost": { "MarkdownDocumentation": "`Cost`\n\nThe cost to run your fleet per hour. Amazon GameLift Servers uses the provided cost of your fleet to\nbalance usage in queues. For more information about queues, see [Setting\nup queues](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) in the *Amazon GameLift Servers Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\d{1,5}(?:\\.\\d{1,5})?$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html#cfn-gamelift-fleet-anywhereconfiguration-cost", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLift::Fleet.CertificateConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.CertificateConfiguration`\n\nDetermines whether a TLS/SSL certificate is generated for a fleet. This feature must be\nenabled when creating the fleet. All instances in a fleet share the same\ncertificate. The certificate can be retrieved by calling the\n[GameLift Server\nSDK](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) operation `GetInstanceCertificate`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html", "Properties": { "CertificateType": { "MarkdownDocumentation": "`CertificateType`\n\nIndicates whether a TLS/SSL certificate is generated for a fleet.\nValid values include:\n* **GENERATED** - Generate a TLS/SSL certificate\n for this fleet.\n* **DISABLED** - (default) Do not generate a\n 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "GENERATED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html#cfn-gamelift-fleet-certificateconfiguration-certificatetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLift::Fleet.IpPermission": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.IpPermission`\n\nA range of IP addresses and port settings that allow inbound traffic to connect to\nserver processes on an instance in a fleet. New game sessions are assigned an IP\naddress/port number combination, which must fall into the fleet's allowed ranges. Fleets\nwith custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift\nautomatically opens two port ranges, one for TCP messaging and one for UDP.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html", "Properties": { "IpRange": { "MarkdownDocumentation": "`IpRange`\n\nA range of allowed IP addresses. This value must be expressed in CIDR notation.\nExample: \"`000.000.000.000/[subnet mask]`\" or optionally the shortened\nversion \"`0.0.0.0/[subnet mask]`\".\n*Required*: Yes\n*Type*: String\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-9]|[1-2][0-9]|3[0-2]))$)`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-iprange", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nA starting value for a range of allowed port numbers.\nFor fleets using Linux builds, only ports `22` and `1026-60000` are valid.\nFor fleets using Windows builds, only ports `1026-60000` are valid.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `60000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-fromport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nAn ending value for a range of allowed port numbers. Port numbers are end-inclusive.\nThis value must be equal to or greater than `FromPort`.\nFor fleets using Linux builds, only ports `22` and `1026-60000` are valid.\nFor fleets using Windows builds, only ports `1026-60000` are valid.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `60000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-toport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe network communication protocol used by the fleet.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TCP | UDP`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "TCP", "UDP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-protocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLift::Fleet.LocationCapacity": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.LocationCapacity`\n\nCurrent resource capacity settings for managed EC2 fleets and managed container fleets. For\nmulti-location fleets, location values might refer to a fleet's remote location or its\nhome Region.\n**Returned by:**[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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html", "Properties": { "MinSize": { "MarkdownDocumentation": "`MinSize`\n\nThe minimum number of instances that are allowed in the specified fleet location. If\nthis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-minsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DesiredEC2Instances": { "MarkdownDocumentation": "`DesiredEC2Instances`\n\nThe number of Amazon EC2 instances you want to maintain in the specified fleet location.\nThis value must fall between the minimum and maximum size limits. Changes in desired\ninstance value can take up to 1 minute to be reflected when viewing the fleet's capacity\nsettings.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-desiredec2instances", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxSize": { "MarkdownDocumentation": "`MaxSize`\n\nThe maximum number of instances that are allowed in the specified fleet location. If\nthis parameter is not set, the default is 1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-maxsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::GameLift::Fleet.LocationConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.LocationConfiguration`\n\nA remote location where a multi-location fleet can deploy game servers for game\nhosting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html", "Properties": { "LocationCapacity": { "MarkdownDocumentation": "`LocationCapacity`\n\nCurrent resource capacity settings for managed EC2 fleets and managed container fleets. For\nmulti-location fleets, location values might refer to a fleet's remote location or its\nhome Region.\n**Returned by:**[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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-locationcapacity", "UpdateType": "Mutable", "Required": false, "Type": "LocationCapacity" }, "Location": { "MarkdownDocumentation": "`Location`\n\nAn AWS Region code, such as `us-west-2`. For a list of supported Regions\nand Local Zones, see [Amazon GameLift Servers service\nlocations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLift::Fleet.ResourceCreationLimitPolicy": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.ResourceCreationLimitPolicy`\n\nA policy that limits the number of game sessions a player can create on the same fleet.\nThis optional policy gives game owners control over how players can consume available game\nserver resources. A resource creation policy makes the following statement: \"An individual\nplayer can create a maximum number of new game sessions within a specified time\nperiod\".\nThe policy is evaluated when a player tries to create a new game session. For example,\nassume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving\na `CreateGameSession` request, Amazon GameLift checks that the player (identified\nby `CreatorId`) has created fewer than 10 game sessions in the past 60\nminutes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html", "Properties": { "PolicyPeriodInMinutes": { "MarkdownDocumentation": "`PolicyPeriodInMinutes`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-policyperiodinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NewGameSessionsPerCreator": { "MarkdownDocumentation": "`NewGameSessionsPerCreator`\n\nA policy that puts limits on the number of game sessions that a player can create\nwithin a specified span of time. With this policy, you can control players' ability to\nconsume available resources.\nThe policy is evaluated when a player tries to create a new game session. On receiving\na `CreateGameSession` request, Amazon GameLift Servers checks that the player (identified by\n`CreatorId`) has created fewer than game session limit in the specified\ntime 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-newgamesessionspercreator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GameLift::Fleet.RuntimeConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.RuntimeConfiguration`\n\nA collection of server process configurations that describe the set of processes to\nrun on each instance in a fleet. Server processes run either an executable in a custom\ngame build or a Realtime Servers script. GameLift launches the configured processes, manages their\nlife cycle, and replaces them as needed. Each instance checks regularly for an updated\nruntime configuration.\nA GameLift instance is limited to 50 processes running concurrently. To calculate the\ntotal number of processes in a runtime configuration, add the values of the\n`ConcurrentExecutions` parameter for each ServerProcess. Learn more about\n [Running Multiple\nProcesses on a Fleet](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html", "Properties": { "ServerProcesses": { "MarkdownDocumentation": "`ServerProcesses`\n\nA collection of server process configurations that identify what server processes to\nrun on fleet computes.\n*Required*: No\n*Type*: Array of [ServerProcess](./aws-properties-gamelift-fleet-serverprocess.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-serverprocesses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServerProcess", "DuplicatesAllowed": true }, "MaxConcurrentGameSessionActivations": { "MarkdownDocumentation": "`MaxConcurrentGameSessionActivations`\n\nThe number of game sessions in status `ACTIVATING` to allow on an\ninstance or compute. This setting limits the instance resources that can be\nused for new game activations at any one time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-maxconcurrentgamesessionactivations", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "GameSessionActivationTimeoutSeconds": { "MarkdownDocumentation": "`GameSessionActivationTimeoutSeconds`\n\nThe maximum amount of time (in seconds) allowed to launch a new game session and have\nit report ready to host players. During this time, the game session is in status\n`ACTIVATING`. If the game session does not become active before the\ntimeout, it is ended and the game session status is changed to\n`TERMINATED`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-gamesessionactivationtimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GameLift::Fleet.ScalingPolicy": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.ScalingPolicy`\n\nRule that controls how a fleet is scaled. Scaling policies are uniquely identified by\nthe combination of name and fleet ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nCurrent status of the scaling policy. The scaling policy can be in force only when in\nan `ACTIVE` status. Scaling policies can be suspended for individual fleets.\nIf the policy is suspended for a fleet, the policy status does not change.\n* **ACTIVE** -- The scaling policy can be used for\n auto-scaling a fleet.\n* **UPDATE\\_REQUESTED** -- A request to update the\n scaling policy has been received.\n* **UPDATING** -- A change is being made to the\n scaling policy.\n* **DELETE\\_REQUESTED** -- A request to delete the\n scaling policy has been received.\n* **DELETING** -- The scaling policy is being\n deleted.\n* **DELETED** -- The scaling policy has been\n deleted.\n* **ERROR** -- An error occurred in creating the\n policy. It should be removed and recreated.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACTIVE | UPDATE_REQUESTED |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACTIVE", "UPDATE_REQUESTED", "UPDATING", "DELETE_REQUESTED", "DELETING", "DELETED", "ERROR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nName of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment. For\ndetailed descriptions of fleet metrics, see [Monitor Amazon GameLift Servers\nwith Amazon CloudWatch](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html).\n* **ActivatingGameSessions** -- Game sessions in\n the process of being created.\n* **ActiveGameSessions** -- Game sessions that\n are currently running.\n* **ActiveInstances** -- Fleet instances that\n are currently running at least one game session.\n* **AvailableGameSessions** -- Additional game\n sessions that fleet could host simultaneously, given current capacity.\n* **AvailablePlayerSessions** -- Empty player\n slots in currently active game sessions. This includes game sessions that are\n not currently accepting players. Reserved player slots are not\n included.\n* **CurrentPlayerSessions** -- Player slots in\n active game sessions that are being used by a player or are reserved for a\n player.\n* **IdleInstances** -- Active instances that are\n currently hosting zero game sessions.\n* **PercentAvailableGameSessions** -- Unused\n percentage of the total number of game sessions that a fleet could host\n simultaneously, given current capacity. Use this metric for a target-based\n scaling policy.\n* **PercentIdleInstances** -- Percentage of the\n total number of active instances that are hosting zero game sessions.\n* **QueueDepth** -- Pending game session\n placement requests, in any queue, where the current fleet is the top-priority\n destination.\n* **WaitTime** -- Current wait time for pending\n game session placement requests, in any queue, where the current fleet is the\n top-priority destination.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ActivatingGameSessions | Ac...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ActivatingGameSessions", "ActiveGameSessions", "ActiveInstances", "AvailableGameSessions", "AvailablePlayerSessions", "CurrentPlayerSessions", "IdleInstances", "PercentAvailableGameSessions", "PercentIdleInstances", "QueueDepth", "WaitTime", "ConcurrentActivatableGameSessions" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyType": { "MarkdownDocumentation": "`PolicyType`\n\nThe type of scaling policy to create. For a target-based policy, set the parameter\n*MetricName* to 'PercentAvailableGameSessions' and specify a\n*TargetConfiguration*. For a rule-based policy set the following\nparameters: *MetricName*, *ComparisonOperator*,\n*Threshold*, *EvaluationPeriods*,\n*ScalingAdjustmentType*, and\n*ScalingAdjustment*.\n*Required*: No\n*Type*: String\n*Allowed values*: `RuleBased | TargetBased...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RuleBased", "TargetBased" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-policytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nComparison operator to use when measuring a metric against the threshold value.\n*Required*: No\n*Type*: String\n*Allowed values*: `GreaterThanOrEqualToThresho...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-comparisonoperator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetConfiguration": { "MarkdownDocumentation": "`TargetConfiguration`\n\nAn object that contains settings for a target-based scaling policy.\n*Required*: No\n*Type*: [TargetConfiguration](./aws-properties-gamelift-fleet-targetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-targetconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TargetConfiguration" }, "UpdateStatus": { "MarkdownDocumentation": "`UpdateStatus`\n\nThe current status of the fleet's scaling policies in a requested fleet location. The\nstatus `PENDING_UPDATE` indicates that an update was requested for the fleet\nbut has not yet been completed for the location.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "PENDING_UPDATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-updatestatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScalingAdjustment": { "MarkdownDocumentation": "`ScalingAdjustment`\n\nAmount of adjustment to make, based on the scaling adjustment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-scalingadjustment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EvaluationPeriods": { "MarkdownDocumentation": "`EvaluationPeriods`\n\nLength of time (in minutes) the metric must be at or beyond the threshold before a\nscaling event is triggered.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-evaluationperiods", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe fleet location.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-location", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA descriptive label that is associated with a fleet's scaling policy. Policy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ScalingAdjustmentType": { "MarkdownDocumentation": "`ScalingAdjustmentType`\n\nThe type of adjustment to make to a fleet's instance count.\n* **ChangeInCapacity** -- add (or subtract) the\n scaling adjustment value from the current instance count. Positive values scale\n up while negative values scale down.\n* **ExactCapacity** -- set the instance count to the\n scaling adjustment value.\n* **PercentChangeInCapacity** -- increase or reduce\n the current instance count by the scaling adjustment, read as a percentage.\n Positive values scale up while negative values scale down.\n*Required*: No\n*Type*: String\n*Allowed values*: `ChangeInCapacity | ExactCap...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ChangeInCapacity", "ExactCapacity", "PercentChangeInCapacity" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-scalingadjustmenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\nMetric value used to trigger a scaling event.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-threshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::GameLift::Fleet.ServerProcess": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.ServerProcess`\n\nA set of instructions for launching server processes on each instance in a fleet.\nServer processes run either an executable in a custom game build or a Realtime Servers script.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html", "Properties": { "ConcurrentExecutions": { "MarkdownDocumentation": "`ConcurrentExecutions`\n\nThe number of server processes using this configuration that run concurrently on each\ninstance or compute.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-concurrentexecutions", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nAn optional list of parameters to pass to the server executable or Realtime script on launch.\nLength Constraints: Minimum length of 1. Maximum length of 1024.\nPattern: [A-Za-z0-9\\_:.+\\/\\\\\\- =@{},?'\\[\\]\"]+\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-parameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchPath": { "MarkdownDocumentation": "`LaunchPath`\n\nThe location of a game build executable or Realtime script. Game builds and Realtime\nscripts are installed on instances at the root:\n* Windows (custom game builds only): `C:\\game`. Example:\n \"`C:\\game\\MyGame\\server.exe`\"\n* Linux: `/local/game`. Examples:\n \"`/local/game/MyGame/server.exe`\" or\n \"`/local/game/MyRealtimeScript.js`\"\n###### Note\nAmazon GameLift Servers doesn't support the use of setup scripts that launch the game executable.\nFor custom game builds, this parameter must indicate the executable that calls the\nserver SDK operations `initSDK()` and `ProcessReady()`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([Cc]:\\\\game\\S+|/local/game/\\S+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-launchpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLift::Fleet.TargetConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::Fleet.TargetConfiguration`\n\nSettings for a target-based scaling policy. A target-based policy tracks a particular\nfleet metric specifies a target value for the metric. As player usage changes, the\npolicy triggers Amazon GameLift Servers to adjust capacity so that the metric returns to the target\nvalue. The target configuration specifies settings as needed for the target based\npolicy, including the target value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html", "Properties": { "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nDesired value to use with a target-based scaling policy. The value must be relevant\nfor whatever metric the scaling policy is using. For example, in a policy using the\nmetric PercentAvailableGameSessions, the target value should be the preferred size of\nthe fleet's buffer (the percent of capacity that should be idle and ready for new game\nsessions).\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html#cfn-gamelift-fleet-targetconfiguration-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::GameLift::GameServerGroup.AutoScalingPolicy": { "MarkdownDocumentation": "`AWS::GameLift::GameServerGroup.AutoScalingPolicy`\n\n**This data type is used with the GameLift FleetIQ and game server groups.**\nConfiguration settings for intelligent automatic scaling that uses target tracking.\nAfter the Auto Scaling group is created, all updates to Auto Scaling policies, including\nchanging this policy and adding or removing other policies, is done directly on the Auto\nScaling group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html", "Properties": { "TargetTrackingConfiguration": { "MarkdownDocumentation": "`TargetTrackingConfiguration`\n\nSettings for a target-based scaling policy applied to Auto Scaling group.\nThese settings are used to create a target-based policy that tracks the GameLift\nFleetIQ metric `PercentUtilizedGameServers` and specifies a target value\nfor the metric. As player usage changes, the policy triggers to adjust the game server group\ncapacity so that the metric returns to the target value.\n*Required*: Yes\n*Type*: [TargetTrackingConfiguration](./aws-properties-gamelift-gameservergroup-targettrackingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html#cfn-gamelift-gameservergroup-autoscalingpolicy-targettrackingconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "TargetTrackingConfiguration" }, "EstimatedInstanceWarmup": { "MarkdownDocumentation": "`EstimatedInstanceWarmup`\n\nLength of time, in seconds, it takes for a new instance to start new game server\nprocesses and register with Amazon GameLift Servers FleetIQ. Specifying a warm-up time can be useful, particularly\nwith game servers that take a long time to start up, because it avoids prematurely\nstarting new instances.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html#cfn-gamelift-gameservergroup-autoscalingpolicy-estimatedinstancewarmup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::GameLift::GameServerGroup.InstanceDefinition": { "MarkdownDocumentation": "`AWS::GameLift::GameServerGroup.InstanceDefinition`\n\n**This data type is used with the Amazon GameLift FleetIQ and game server groups.**\nAn allowed instance type for a `GameServerGroup`. All game server groups must have at least two\ninstance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type\nfor viability. It then updates the Auto Scaling group with the list of viable instance\ntypes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html", "Properties": { "WeightedCapacity": { "MarkdownDocumentation": "`WeightedCapacity`\n\nInstance weighting that indicates how much this instance type contributes to the total\ncapacity of a game server group. Instance weights are used by Amazon GameLift Servers FleetIQ to calculate the\ninstance type's cost per unit hour and better identify the most cost-effective options.\nFor detailed information on weighting instance capacity, see [Instance\nWeighting](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) in the *Amazon Elastic Compute Cloud Auto Scaling User Guide*.\nDefault value is \"1\".\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0031-\\u0039][\\u0030-\\u0039]{0,2}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html#cfn-gamelift-gameservergroup-instancedefinition-weightedcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nAn Amazon EC2 instance type designation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `c4.large | c4.xlarge | c4.2...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html#cfn-gamelift-gameservergroup-instancedefinition-instancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLift::GameServerGroup.LaunchTemplate": { "MarkdownDocumentation": "`AWS::GameLift::GameServerGroup.LaunchTemplate`\n\n**This data type is used with the GameLift FleetIQ and game server groups.**\nAn Amazon EC2 launch template that contains configuration settings and game server code to\nbe deployed to all instances in a game server group. The launch template is specified\nwhen creating a new game server group with `GameServerGroup`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html", "Properties": { "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nA readable identifier for an existing Amazon EC2 launch template.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\(\\)\\.\\-/_]+`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-launchtemplatename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of the Amazon EC2 launch template to use. If no version is specified, the\ndefault version will be used. With Amazon EC2, you can specify a default version for a launch\ntemplate. If none is set, the default is the first version created.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nA unique identifier for an existing Amazon EC2 launch template.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-launchtemplateid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GameLift::GameServerGroup.TargetTrackingConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::GameServerGroup.TargetTrackingConfiguration`\n\n**This data type is used with the Amazon GameLift FleetIQ and game server groups.**\nSettings for a target-based scaling policy as part of a `GameServerGroupAutoScalingPolicy`.\nThese settings are used to\ncreate a target-based policy that tracks the GameLift FleetIQ metric\n`\"PercentUtilizedGameServers\"` and specifies a target value for the\nmetric. As player usage changes, the policy triggers to adjust the game server group\ncapacity so that the metric returns to the target value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-targettrackingconfiguration.html", "Properties": { "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nDesired value to use with a game server group target-based scaling policy.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-targettrackingconfiguration.html#cfn-gamelift-gameservergroup-targettrackingconfiguration-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::GameLift::GameSessionQueue.FilterConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::GameSessionQueue.FilterConfiguration`\n\nA list of fleet locations where a game session queue can place new game sessions. You\ncan use a filter to temporarily turn off placements for specific locations. For queues\nthat have multi-location fleets, you can use a filter configuration allow placement with\nsome, but not all of these locations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-filterconfiguration.html", "Properties": { "AllowedLocations": { "MarkdownDocumentation": "`AllowedLocations`\n\nA list of locations to allow game session placement in, in the form of AWS Region\ncodes such as `us-west-2`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-filterconfiguration.html#cfn-gamelift-gamesessionqueue-filterconfiguration-allowedlocations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::GameLift::GameSessionQueue.GameSessionQueueDestination": { "MarkdownDocumentation": "`AWS::GameLift::GameSessionQueue.GameSessionQueueDestination`\n\nA fleet or alias designated in a game session queue. Queues fulfill requests for new\ngame sessions by placing a new game session on any of the queue's destinations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-gamesessionqueuedestination.html", "Properties": { "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nThe Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which\ninclude a fleet ID or alias ID and a Region name, provide a unique identifier across all\nRegions.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:/-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-gamesessionqueuedestination.html#cfn-gamelift-gamesessionqueue-gamesessionqueuedestination-destinationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GameLift::GameSessionQueue.PlayerLatencyPolicy": { "MarkdownDocumentation": "`AWS::GameLift::GameSessionQueue.PlayerLatencyPolicy`\n\nThe queue setting that determines the highest latency allowed for individual\nplayers when placing a game session. When a latency policy is in force, a game session cannot\nbe placed with any fleet in a Region where a player reports latency higher than the cap.\nLatency policies are only enforced when the placement request contains player latency\ninformation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html", "Properties": { "PolicyDurationSeconds": { "MarkdownDocumentation": "`PolicyDurationSeconds`\n\nThe length of time, in seconds, that the policy is enforced while placing a new game\nsession. A null value for this property means that the policy is enforced until the\nqueue times out.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-policydurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumIndividualPlayerLatencyMilliseconds": { "MarkdownDocumentation": "`MaximumIndividualPlayerLatencyMilliseconds`\n\nThe maximum latency value that is allowed for any player, in milliseconds. All\npolicies must have a value set for this property.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-maximumindividualplayerlatencymilliseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GameLift::GameSessionQueue.PriorityConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::GameSessionQueue.PriorityConfiguration`\n\nCustom prioritization settings for use by a game session queue when placing new game\nsessions with available game servers. When defined, this configuration replaces the\ndefault FleetIQ prioritization process, which is as follows:\n* If player latency data is included in a game session request, destinations and\n locations are prioritized first based on lowest average latency (1), then on\n lowest hosting cost (2), then on destination list order (3), and finally on\n location (alphabetical) (4). This approach ensures that the queue's top priority\n is to place game sessions where average player latency is lowest, and--if\n latency is the same--where the hosting cost is less, etc.\n* If player latency data is not included, destinations and locations are\n prioritized first on destination list order (1), and then on location\n (alphabetical) (2). This approach ensures that the queue's top priority is to\n place game sessions on the first destination fleet listed. If that fleet has\n multiple locations, the game session is placed on the first location (when\n listed alphabetically).\nChanging the priority order will affect how game sessions are placed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html", "Properties": { "PriorityOrder": { "MarkdownDocumentation": "`PriorityOrder`\n\nA custom sequence to use when prioritizing where to place new game sessions. Each\npriority type is listed once.\n* `LATENCY` -- Amazon GameLift Servers prioritizes locations where the average player\n latency is lowest. Player latency data is provided in each game session\n placement request.\n* `COST` -- Amazon GameLift Servers prioritizes queue destinations with the lowest\n current hosting costs. Cost is evaluated based on the destination's location,\n instance type, and fleet type (Spot or On-Demand).\n* `DESTINATION` -- Amazon GameLift Servers prioritizes based on the list order of\n destinations in the queue configuration.\n* `LOCATION` -- Amazon GameLift Servers prioritizes based on the provided order of\n locations, as defined in `LocationOrder`.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `LATENCY | COST | DESTINATIO...`\n*Minimum*: `1`\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)", "RefReturnValue": "", "AllowedValues": [ "LATENCY", "COST", "DESTINATION", "LOCATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-priorityorder", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LocationOrder": { "MarkdownDocumentation": "`LocationOrder`\n\nThe prioritization order to use for fleet locations, when the\n`PriorityOrder` property includes `LOCATION`. Locations can\ninclude AWS Region codes (such as `us-west-2`), local zones, and custom\nlocations (for Anywhere fleets). Each location must be listed only once. For details, see\n[Amazon GameLift Servers service locations.](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html)\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-locationorder", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::GameLift::MatchmakingConfiguration.GameProperty": { "MarkdownDocumentation": "`AWS::GameLift::MatchmakingConfiguration.GameProperty`\n\nThis key-value pair can store custom data about a game session. For example, you might\nuse a `GameProperty` to track a game session's map, level of difficulty, or\nremaining time. The difficulty level could be specified like this: `{\"Key\":\n\"difficulty\", \"Value\":\"Novice\"}`.\nYou can set game properties when creating a game session. You can also modify game\nproperties of an active game session. When searching for game sessions, you can filter\non game property keys and values. You can't delete game properties from a game session.\nFor examples of working with game properties, see [Create a game session with properties](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe game property value.\n*Required*: Yes\n*Type*: String\n*Maximum*: `96`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe game property identifier.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLift::Script.S3Location": { "MarkdownDocumentation": "`AWS::GameLift::Script.S3Location`\n\nThe location in Amazon S3 where build or script files can be stored for access by\nAmazon GameLift.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html", "Properties": { "ObjectVersion": { "MarkdownDocumentation": "`ObjectVersion`\n\nThe version of the file, if object versioning is turned on for the bucket. Amazon GameLift Servers uses\nthis information when retrieving files from an S3 bucket that you own. Use this\nparameter to specify a specific version of the file. If not set, the latest version of\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-objectversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nAn Amazon S3 bucket identifier. Thename of the S3 bucket.\n###### Note\nAmazon GameLift Servers doesn't support uploading from Amazon S3 buckets with names that contain a dot\n(.).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM role that\nallows Amazon GameLift Servers 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLiftStreams::Application.RuntimeEnvironment": { "MarkdownDocumentation": "`AWS::GameLiftStreams::Application.RuntimeEnvironment`\n\nConfiguration settings that identify the operating system for an application resource. This can also include a compatibility layer and\nother drivers.\nA runtime environment can be one of the following:\n* For Linux applications\n \n + Ubuntu 22.04 LTS (`Type=UBUNTU, Version=22_04_LTS`)\n* For Windows applications\n \n + Microsoft Windows Server 2022 Base (`Type=WINDOWS, Version=2022`)\n + Proton 9.0-2 (`Type=PROTON, Version=20250516`)\n + Proton 8.0-5 (`Type=PROTON, Version=20241007`)\n + Proton 8.0-2c (`Type=PROTON, Version=20230704`)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-application-runtimeenvironment.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe operating system and other drivers. For Proton, this also includes the Proton compatibility layer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-application-runtimeenvironment.html#cfn-gameliftstreams-application-runtimeenvironment-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nVersioned container environment for the application operating system.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-application-runtimeenvironment.html#cfn-gameliftstreams-application-runtimeenvironment-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GameLiftStreams::StreamGroup.DefaultApplication": { "MarkdownDocumentation": "`AWS::GameLiftStreams::StreamGroup.DefaultApplication`\n\nRepresents the default Amazon GameLift Streams application that a stream group hosts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.html", "Properties": { "Id": { "MarkdownDocumentation": "`Id`\n\nAn\nID that uniquely identifies the application resource. Example ID: `a-9ZY8X7Wv6`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.html#cfn-gameliftstreams-streamgroup-defaultapplication-id", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nAn\n[Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely identifies the application resource. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws:gameliftstreams:([^:\n]*):([0-9]{12}):([^:\n]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.html#cfn-gameliftstreams-streamgroup-defaultapplication-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GameLiftStreams::StreamGroup.LocationConfiguration": { "MarkdownDocumentation": "`AWS::GameLiftStreams::StreamGroup.LocationConfiguration`\n\nConfiguration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you\nmust specify a numeric value for at least one of the two capacity types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html", "Properties": { "AlwaysOnCapacity": { "MarkdownDocumentation": "`AlwaysOnCapacity`\n\nThis setting, if non-zero, indicates minimum streaming capacity\nwhich is allocated to you and is never released back to the service. You pay for this\nbase level of capacity at all times, whether used or idle.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-alwaysoncapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-maximumcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OnDemandCapacity": { "MarkdownDocumentation": "`OnDemandCapacity`\n\nThis field is deprecated. Use MaximumCapacity instead. This parameter is ignored when MaximumCapacity is specified.\nThe streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated.\nThis offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when you create a stream group or add a location.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-ondemandcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LocationName": { "MarkdownDocumentation": "`LocationName`\n\nA location's name. For example, `us-east-1`. For a complete list of locations that Amazon GameLift Streams supports, refer to [Regions, quotas, and limitations](https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html) in the *Amazon GameLift Streams Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-locationname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetIdleCapacity": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-targetidlecapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GlobalAccelerator::CrossAccountAttachment.Resource": { "MarkdownDocumentation": "`AWS::GlobalAccelerator::CrossAccountAttachment.Resource`\n\nA resource is one of the following: the ARN for an AWS resource that is supported by\nAWS Global Accelerator to be added as an endpoint, or a CIDR range that specifies a bring your own IP (BYOIP) address pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nAn IP address range, in CIDR format, that is specified as resource. The address must\nbe provisioned and advertised in AWS Global Accelerator by following the bring your own IP address (BYOIP) process\nfor Global Accelerator\nFor more information, see\n[Bring your own IP addresses (BYOIP)](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in\nthe AWS Global Accelerator Developer Guide.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.html#cfn-globalaccelerator-crossaccountattachment-resource-cidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointId": { "MarkdownDocumentation": "`EndpointId`\n\nThe endpoint ID for the endpoint that is specified as a AWS resource.\nAn endpoint ID for the cross-account feature is the ARN of an AWS resource, such as a\nNetwork Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.html#cfn-globalaccelerator-crossaccountattachment-resource-endpointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe AWS Region where a shared endpoint resource is located.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-crossaccountattachment-resource.html#cfn-globalaccelerator-crossaccountattachment-resource-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GlobalAccelerator::EndpointGroup.EndpointConfiguration": { "MarkdownDocumentation": "`AWS::GlobalAccelerator::EndpointGroup.EndpointConfiguration`\n\nA complex type for endpoints. A resource must be valid and active when you add it as an endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html", "Properties": { "AttachmentArn": { "MarkdownDocumentation": "`AttachmentArn`\n\nThe Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources)\nthat can be added to accelerators and principals that have permission to add the endpoints.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html#cfn-globalaccelerator-endpointgroup-endpointconfiguration-attachmentarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointId": { "MarkdownDocumentation": "`EndpointId`\n\nAn ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\nResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\nallocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active\nwhen you add it as an endpoint.\nFor cross-account endpoints, this must be the ARN of the resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html#cfn-globalaccelerator-endpointgroup-endpointconfiguration-endpointid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic\nbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\nresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\nand third endpoints, and 6/20 is routed to the last endpoint. For more information, see [Endpoint Weights](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) in the\n*AWS Global Accelerator Developer Guide*.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html#cfn-globalaccelerator-endpointgroup-endpointconfiguration-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ClientIPPreservationEnabled": { "MarkdownDocumentation": "`ClientIPPreservationEnabled`\n\nIndicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.\nThe value is true or false. The default value is true for new accelerators.\nIf the value is set to true, the client's IP address is preserved in the `X-Forwarded-For` request header as\ntraffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.\nFor more information, see [Preserve Client IP Addresses](https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html) in the *AWS Global Accelerator 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html#cfn-globalaccelerator-endpointgroup-endpointconfiguration-clientippreservationenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::GlobalAccelerator::EndpointGroup.PortOverride": { "MarkdownDocumentation": "`AWS::GlobalAccelerator::EndpointGroup.PortOverride`\n\nOverride specific listener ports used to route traffic to endpoints that are part of an endpoint group.\nFor example, you can create a port override in which the listener\nreceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080\nand 1443, respectively, on the endpoints.\nFor more information, see [Port overrides](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) in the *AWS Global Accelerator Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html", "Properties": { "ListenerPort": { "MarkdownDocumentation": "`ListenerPort`\n\nThe listener port that you want to map to a specific endpoint port. This is the port that user traffic\narrives to the Global Accelerator on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html#cfn-globalaccelerator-endpointgroup-portoverride-listenerport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "EndpointPort": { "MarkdownDocumentation": "`EndpointPort`\n\nThe endpoint port that you want a listener port to be mapped to. This is the port on the endpoint,\nsuch as the Application Load Balancer or Amazon EC2 instance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html#cfn-globalaccelerator-endpointgroup-portoverride-endpointport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::GlobalAccelerator::Listener.PortRange": { "MarkdownDocumentation": "`AWS::GlobalAccelerator::Listener.PortRange`\n\nA complex type for a range of ports for a listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-listener-portrange.html", "Properties": { "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nThe first port in the range of ports, inclusive.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-listener-portrange.html#cfn-globalaccelerator-listener-portrange-fromport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nThe last port in the range of ports, inclusive.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-listener-portrange.html#cfn-globalaccelerator-listener-portrange-toport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Glue::Classifier.CsvClassifier": { "MarkdownDocumentation": "`AWS::Glue::Classifier.CsvClassifier`\n\nA classifier for custom `CSV` content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html", "Properties": { "ContainsCustomDatatype": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ContainsCustomDatatype`\n\nIndicates whether the CSV file contains custom data types.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-containscustomdatatype", "UpdateType": "Mutable" }, "QuoteSymbol": { "Required": false, "MarkdownDocumentation": "`QuoteSymbol`\n\nA custom symbol to denote what combines content into a single column value. It must be\ndifferent from the column delimiter.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\r\\n]`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-quotesymbol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ContainsHeader": { "Required": false, "MarkdownDocumentation": "`ContainsHeader`\n\nIndicates 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*Allowed values*: `UNKNOWN | PRESENT | ABSENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNKNOWN", "PRESENT", "ABSENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-containsheader", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Delimiter": { "Required": false, "MarkdownDocumentation": "`Delimiter`\n\nA custom symbol to denote what separates each column entry in the row.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\r\\n]`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-delimiter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Header": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Header`\n\nA list of strings representing column names.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-header", "UpdateType": "Mutable" }, "AllowSingleColumn": { "Required": false, "MarkdownDocumentation": "`AllowSingleColumn`\n\nEnables 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-allowsinglecolumn", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "CustomDatatypeConfigured": { "Required": false, "MarkdownDocumentation": "`CustomDatatypeConfigured`\n\nEnables the configuration of custom data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-customdatatypeconfigured", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DisableValueTrimming": { "Required": false, "MarkdownDocumentation": "`DisableValueTrimming`\n\nSpecifies not to trim values before identifying the type of column values. The default\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-disablevaluetrimming", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the classifier.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::Classifier.GrokClassifier": { "MarkdownDocumentation": "`AWS::Glue::Classifier.GrokClassifier`\n\nA classifier that uses `grok` patterns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html", "Properties": { "CustomPatterns": { "Required": false, "MarkdownDocumentation": "`CustomPatterns`\n\nOptional custom grok patterns defined by this classifier. For more information, see\ncustom patterns in [Writing Custom\nClassifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `16000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-custompatterns", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GrokPattern": { "Required": true, "MarkdownDocumentation": "`GrokPattern`\n\nThe grok pattern applied to a data store by this classifier. For more information, see\nbuilt-in patterns in [Writing Custom\nClassifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-grokpattern", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Classification": { "Required": true, "MarkdownDocumentation": "`Classification`\n\nAn identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and\nso 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-classification", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the classifier.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::Classifier.JsonClassifier": { "MarkdownDocumentation": "`AWS::Glue::Classifier.JsonClassifier`\n\nA classifier for `JSON` content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html", "Properties": { "JsonPath": { "Required": true, "MarkdownDocumentation": "`JsonPath`\n\nA `JsonPath` string defining the JSON data for the classifier to classify.\nAWS Glue supports a subset of `JsonPath`, as described in [Writing JsonPath\nCustom Classifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html#cfn-glue-classifier-jsonclassifier-jsonpath", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the classifier.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html#cfn-glue-classifier-jsonclassifier-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::Classifier.XMLClassifier": { "MarkdownDocumentation": "`AWS::Glue::Classifier.XMLClassifier`\n\nA classifier for `XML` content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html", "Properties": { "RowTag": { "Required": true, "MarkdownDocumentation": "`RowTag`\n\nThe XML tag designating the element that contains each record in an XML document being\nparsed. This can't identify a self-closing element (closed by `/>`). An empty\nrow element that contains only attributes can be parsed as long as it ends with a closing tag\n(for example, `` is okay, but\n`` is not).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-rowtag", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Classification": { "Required": true, "MarkdownDocumentation": "`Classification`\n\nAn identifier of the data format that the classifier matches.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-classification", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the classifier.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::Connection.AuthenticationConfigurationInput": { "MarkdownDocumentation": "`AWS::Glue::Connection.AuthenticationConfigurationInput`\n\nA structure containing the authentication configuration in the CreateConnection request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html", "Properties": { "SecretArn": { "Required": false, "MarkdownDocumentation": "`SecretArn`\n\nThe secret manager ARN to store credentials in the CreateConnection request.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-secretarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KmsKeyArn": { "Required": false, "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|arn:aws[a-z0-9-]*:kms:.*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-kmskeyarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OAuth2Properties": { "Type": "OAuth2PropertiesInput", "Required": false, "MarkdownDocumentation": "`OAuth2Properties`\n\nThe properties for OAuth2 authentication in the CreateConnection request.\n*Required*: No\n*Type*: [OAuth2PropertiesInput](./aws-properties-glue-connection-oauth2propertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-oauth2properties", "UpdateType": "Mutable" }, "CustomAuthenticationCredentials": { "Required": false, "MarkdownDocumentation": "`CustomAuthenticationCredentials`\n\nThe credentials used when the authentication type is custom authentication.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-customauthenticationcredentials", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "BasicAuthenticationCredentials": { "Type": "BasicAuthenticationCredentials", "Required": false, "MarkdownDocumentation": "`BasicAuthenticationCredentials`\n\nThe credentials used when the authentication type is basic authentication.\n*Required*: No\n*Type*: [BasicAuthenticationCredentials](./aws-properties-glue-connection-basicauthenticationcredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-basicauthenticationcredentials", "UpdateType": "Mutable" }, "AuthenticationType": { "Required": true, "MarkdownDocumentation": "`AuthenticationType`\n\nA structure containing the authentication configuration in the CreateConnection request.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BASIC | OAUTH2 | CUSTOM | I...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "OAUTH2", "CUSTOM", "IAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-authenticationtype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Connection.AuthorizationCodeProperties": { "MarkdownDocumentation": "`AWS::Glue::Connection.AuthorizationCodeProperties`\n\nThe set of properties required for the the OAuth2 `AUTHORIZATION_CODE` grant type workflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authorizationcodeproperties.html", "Properties": { "AuthorizationCode": { "Required": false, "MarkdownDocumentation": "`AuthorizationCode`\n\nAn authorization code to be used in the third leg of the `AUTHORIZATION_CODE` grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authorizationcodeproperties.html#cfn-glue-connection-authorizationcodeproperties-authorizationcode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RedirectUri": { "Required": false, "MarkdownDocumentation": "`RedirectUri`\n\nThe redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https?):\\/\\/[^\\s/$.?#].[^\\s]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authorizationcodeproperties.html#cfn-glue-connection-authorizationcodeproperties-redirecturi", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Connection.BasicAuthenticationCredentials": { "MarkdownDocumentation": "`AWS::Glue::Connection.BasicAuthenticationCredentials`\n\nFor supplying basic auth credentials when not providing a `SecretArn` value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-basicauthenticationcredentials.html", "Properties": { "Username": { "Required": false, "MarkdownDocumentation": "`Username`\n\nThe username to connect to the data source.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-basicauthenticationcredentials.html#cfn-glue-connection-basicauthenticationcredentials-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Password": { "Required": false, "MarkdownDocumentation": "`Password`\n\nThe password to connect to the data source.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-basicauthenticationcredentials.html#cfn-glue-connection-basicauthenticationcredentials-password", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Connection.ConnectionInput": { "MarkdownDocumentation": "`AWS::Glue::Connection.ConnectionInput`\n\nA structure that is used to specify a connection to create or update.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html", "Properties": { "AuthenticationConfiguration": { "Type": "AuthenticationConfigurationInput", "Required": false, "MarkdownDocumentation": "`AuthenticationConfiguration`\n\nThe authentication properties of the connection.\n*Required*: No\n*Type*: [AuthenticationConfigurationInput](./aws-properties-glue-connection-authenticationconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-authenticationconfiguration", "UpdateType": "Mutable" }, "PythonProperties": { "Required": false, "MarkdownDocumentation": "`PythonProperties`\n\nConnection properties specific to the Python compute environment.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-pythonproperties", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "SparkProperties": { "Required": false, "MarkdownDocumentation": "`SparkProperties`\n\nConnection properties specific to the Spark compute environment.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-sparkproperties", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe description of the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ConnectionType": { "Required": true, "MarkdownDocumentation": "`ConnectionType`\n\nThe type of the connection. Currently, these types are supported:\n* `JDBC` - Designates a connection to a database through Java Database Connectivity (JDBC).\n \n `JDBC` Connections use the following ConnectionParameters.\n \n + Required: All of (`HOST`, `PORT`, `JDBC_ENGINE`) or `JDBC_CONNECTION_URL`.\n + Required: All of (`USERNAME`, `PASSWORD`) or `SECRET_ID`.\n + Optional: `JDBC_ENFORCE_SSL`, `CUSTOM_JDBC_CERT`, `CUSTOM_JDBC_CERT_STRING`, `SKIP_CUSTOM_JDBC_CERT_VALIDATION`. These parameters are used to configure SSL with JDBC.\n* `KAFKA` - Designates a connection to an Apache Kafka streaming platform.\n \n `KAFKA` Connections use the following ConnectionParameters.\n \n + Required: `KAFKA_BOOTSTRAP_SERVERS`.\n + Optional: `KAFKA_SSL_ENABLED`, `KAFKA_CUSTOM_CERT`, `KAFKA_SKIP_CUSTOM_CERT_VALIDATION`. These parameters are used to configure SSL with `KAFKA`.\n + Optional: `KAFKA_CLIENT_KEYSTORE`, `KAFKA_CLIENT_KEYSTORE_PASSWORD`, `KAFKA_CLIENT_KEY_PASSWORD`, `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`, `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`. These parameters are used to configure TLS client configuration with SSL in `KAFKA`.\n + Optional: `KAFKA_SASL_MECHANISM`. Can be specified as `SCRAM-SHA-512`, `GSSAPI`, or `AWS_MSK_IAM`.\n + Optional: `KAFKA_SASL_SCRAM_USERNAME`, `KAFKA_SASL_SCRAM_PASSWORD`, `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with `KAFKA`.\n + Optional: `KAFKA_SASL_GSSAPI_KEYTAB`, `KAFKA_SASL_GSSAPI_KRB5_CONF`, `KAFKA_SASL_GSSAPI_SERVICE`, `KAFKA_SASL_GSSAPI_PRINCIPAL`. These parameters are used to configure SASL/GSSAPI authentication with `KAFKA`.\n* `MONGODB` - Designates a connection to a MongoDB document database.\n \n `MONGODB` Connections use the following ConnectionParameters.\n \n + Required: `CONNECTION_URL`.\n + Required: All of (`USERNAME`, `PASSWORD`) or `SECRET_ID`.\n* `VIEW_VALIDATION_REDSHIFT` - Designates a connection used for view validation by Amazon Redshift.\n* `VIEW_VALIDATION_ATHENA` - Designates a connection used for view validation by Amazon Athena.\n* `NETWORK` - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).\n \n `NETWORK` Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.\n* `MARKETPLACE` - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue.\n \n `MARKETPLACE` Connections use the following ConnectionParameters.\n \n + Required: `CONNECTOR_TYPE`, `CONNECTOR_URL`, `CONNECTOR_CLASS_NAME`, `CONNECTION_URL`.\n + Required for `JDBC``CONNECTOR_TYPE` connections: All of (`USERNAME`, `PASSWORD`) or `SECRET_ID`.\n* `CUSTOM` - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue.\nFor more information on the connection parameters needed for a particular connector, see the documentation for the connector in [Adding an AWS Glue connection](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html)in the AWS Glue User Guide.\n`SFTP` is not supported.\nFor more information about how optional ConnectionProperties are used to configure features in AWS Glue, consult [AWS Glue connection properties](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html).\nFor more information about how optional ConnectionProperties are used to configure features in AWS Glue Studio, consult [Using connectors and connections](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `JDBC | SFTP | MONGODB | KAF...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JDBC", "SFTP", "MONGODB", "KAFKA", "NETWORK", "MARKETPLACE", "CUSTOM", "SALESFORCE", "VIEW_VALIDATION_REDSHIFT", "VIEW_VALIDATION_ATHENA", "GOOGLEADS", "GOOGLESHEETS", "GOOGLEANALYTICS4", "SERVICENOW", "MARKETO", "SAPODATA", "ZENDESK", "JIRACLOUD", "NETSUITEERP", "HUBSPOT", "FACEBOOKADS", "INSTAGRAMADS", "ZOHOCRM", "SALESFORCEPARDOT", "SALESFORCEMARKETINGCLOUD", "ADOBEANALYTICS", "SLACK", "LINKEDIN", "MIXPANEL", "ASANA", "STRIPE", "SMARTSHEET", "DATADOG", "WOOCOMMERCE", "INTERCOM", "SNAPCHATADS", "PAYPAL", "QUICKBOOKS", "FACEBOOKPAGEINSIGHTS", "FRESHDESK", "TWILIO", "DOCUSIGNMONITOR", "FRESHSALES", "ZOOM", "GOOGLESEARCHCONSOLE", "SALESFORCECOMMERCECLOUD", "SAPCONCUR", "DYNATRACE", "MICROSOFTDYNAMIC365FINANCEANDOPS", "MICROSOFTTEAMS", "BLACKBAUDRAISEREDGENXT", "MAILCHIMP", "GITLAB", "PENDO", "PRODUCTBOARD", "CIRCLECI", "PIPEDIVE", "SENDGRID", "AZURECOSMOS", "AZURESQL", "BIGQUERY", "BLACKBAUD", "CLOUDERAHIVE", "CLOUDERAIMPALA", "CLOUDWATCH", "CLOUDWATCHMETRICS", "CMDB", "DATALAKEGEN2", "DB2", "DB2AS400", "DOCUMENTDB", "DOMO", "DYNAMODB", "GOOGLECLOUDSTORAGE", "HBASE", "KUSTOMER", "MICROSOFTDYNAMICS365CRM", "MONDAY", "MYSQL", "OKTA", "OPENSEARCH", "ORACLE", "PIPEDRIVE", "POSTGRESQL", "SAPHANA", "SQLSERVER", "SYNAPSE", "TERADATA", "TERADATANOS", "TIMESTREAM", "TPCDS", "VERTICA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectiontype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MatchCriteria": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`MatchCriteria`\n\nA list of criteria that can be used in selecting this connection.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-matchcriteria", "UpdateType": "Mutable" }, "PhysicalConnectionRequirements": { "Type": "PhysicalConnectionRequirements", "Required": false, "MarkdownDocumentation": "`PhysicalConnectionRequirements`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-physicalconnectionrequirements", "UpdateType": "Mutable" }, "ConnectionProperties": { "Required": false, "MarkdownDocumentation": "`ConnectionProperties`\n\nThese 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectionproperties", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "AthenaProperties": { "Required": false, "MarkdownDocumentation": "`AthenaProperties`\n\nConnection properties specific to the Athena compute environment.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-athenaproperties", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "ValidateForComputeEnvironments": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ValidateForComputeEnvironments`\n\nThe compute environments that the specified connection properties are validated against.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-validateforcomputeenvironments", "UpdateType": "Mutable" }, "ValidateCredentials": { "Required": false, "MarkdownDocumentation": "`ValidateCredentials`\n\nA flag to validate the credentials during create connection. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-validatecredentials", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::Connection.OAuth2ClientApplication": { "MarkdownDocumentation": "`AWS::Glue::Connection.OAuth2ClientApplication`\n\nThe OAuth2 client app used for the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2clientapplication.html", "Properties": { "AWSManagedClientApplicationReference": { "Required": false, "MarkdownDocumentation": "`AWSManagedClientApplicationReference`\n\nThe reference to the SaaS-side client app that is AWS managed.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2clientapplication.html#cfn-glue-connection-oauth2clientapplication-awsmanagedclientapplicationreference", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UserManagedClientApplicationClientId": { "Required": false, "MarkdownDocumentation": "`UserManagedClientApplicationClientId`\n\nThe client application clientID if the ClientAppType is `USER_MANAGED`.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2clientapplication.html#cfn-glue-connection-oauth2clientapplication-usermanagedclientapplicationclientid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Connection.OAuth2Credentials": { "MarkdownDocumentation": "`AWS::Glue::Connection.OAuth2Credentials`\n\nThe credentials used when the authentication type is OAuth2 authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html", "Properties": { "UserManagedClientApplicationClientSecret": { "Required": false, "MarkdownDocumentation": "`UserManagedClientApplicationClientSecret`\n\nThe client application client secret if the client application is user managed.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\x20-\\x7E]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html#cfn-glue-connection-oauth2credentials-usermanagedclientapplicationclientsecret", "PrimitiveType": "String", "UpdateType": "Mutable" }, "JwtToken": { "Required": false, "MarkdownDocumentation": "`JwtToken`\n\nThe JSON Web Token (JWT) used when the authentication type is OAuth2.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_=]+)\\.([a-zA-Z0-9_\\-\\+\\/=]*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html#cfn-glue-connection-oauth2credentials-jwttoken", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RefreshToken": { "Required": false, "MarkdownDocumentation": "`RefreshToken`\n\nThe refresh token used when the authentication type is OAuth2.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\x20-\\x7E]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html#cfn-glue-connection-oauth2credentials-refreshtoken", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AccessToken": { "Required": false, "MarkdownDocumentation": "`AccessToken`\n\nThe access token used when the authentication type is OAuth2.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\x20-\\x7E]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html#cfn-glue-connection-oauth2credentials-accesstoken", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Connection.OAuth2PropertiesInput": { "MarkdownDocumentation": "`AWS::Glue::Connection.OAuth2PropertiesInput`\n\nA structure containing properties for OAuth2 in the CreateConnection request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html", "Properties": { "AuthorizationCodeProperties": { "Type": "AuthorizationCodeProperties", "Required": false, "MarkdownDocumentation": "`AuthorizationCodeProperties`\n\nThe set of properties required for the the OAuth2 `AUTHORIZATION_CODE` grant type.\n*Required*: No\n*Type*: [AuthorizationCodeProperties](./aws-properties-glue-connection-authorizationcodeproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-authorizationcodeproperties", "UpdateType": "Mutable" }, "OAuth2ClientApplication": { "Type": "OAuth2ClientApplication", "Required": false, "MarkdownDocumentation": "`OAuth2ClientApplication`\n\nThe client application type in the CreateConnection request. For example, `AWS_MANAGED` or `USER_MANAGED`.\n*Required*: No\n*Type*: [OAuth2ClientApplication](./aws-properties-glue-connection-oauth2clientapplication.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-oauth2clientapplication", "UpdateType": "Mutable" }, "TokenUrl": { "Required": false, "MarkdownDocumentation": "`TokenUrl`\n\nThe URL of the provider's authentication server, to exchange an authorization code for an access token.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-tokenurl", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OAuth2Credentials": { "Type": "OAuth2Credentials", "Required": false, "MarkdownDocumentation": "`OAuth2Credentials`\n\nThe credentials used when the authentication type is OAuth2 authentication.\n*Required*: No\n*Type*: [OAuth2Credentials](./aws-properties-glue-connection-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-oauth2credentials", "UpdateType": "Mutable" }, "OAuth2GrantType": { "Required": false, "MarkdownDocumentation": "`OAuth2GrantType`\n\nThe OAuth2 grant type in the CreateConnection request. For example, `AUTHORIZATION_CODE`, `JWT_BEARER`, or `CLIENT_CREDENTIALS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTHORIZATION_CODE | CLIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "JWT_BEARER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-oauth2granttype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TokenUrlParametersMap": { "Required": false, "MarkdownDocumentation": "`TokenUrlParametersMap`\n\nA map of parameters that are added to the token `GET` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-tokenurlparametersmap", "PrimitiveType": "Json", "UpdateType": "Mutable" } } }, "AWS::Glue::Connection.PhysicalConnectionRequirements": { "MarkdownDocumentation": "`AWS::Glue::Connection.PhysicalConnectionRequirements`\n\nThe OAuth client app in GetConnection response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html", "Properties": { "AvailabilityZone": { "Required": false, "MarkdownDocumentation": "`AvailabilityZone`\n\nThe connection's Availability Zone.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-availabilityzone", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecurityGroupIdList": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SecurityGroupIdList`\n\nThe security group ID list used by the connection.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-securitygroupidlist", "UpdateType": "Mutable" }, "SubnetId": { "Required": false, "MarkdownDocumentation": "`SubnetId`\n\nThe subnet ID used by the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-subnetid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Crawler.CatalogTarget": { "MarkdownDocumentation": "`AWS::Glue::Crawler.CatalogTarget`\n\nSpecifies an AWS Glue Data Catalog target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a `Catalog` connection type paired with a `NETWORK` Connection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the database to be synchronized.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DlqEventQueueArn": { "MarkdownDocumentation": "`DlqEventQueueArn`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-dlqeventqueuearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tables": { "MarkdownDocumentation": "`Tables`\n\nA list of the tables to be synchronized.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-tables", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EventQueueArn": { "MarkdownDocumentation": "`EventQueueArn`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-eventqueuearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Crawler.DeltaTarget": { "MarkdownDocumentation": "`AWS::Glue::Crawler.DeltaTarget`\n\nSpecifies a Delta data store to crawl one or more Delta tables.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection to use to connect to the Delta table 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateNativeDeltaTable": { "MarkdownDocumentation": "`CreateNativeDeltaTable`\n\nSpecifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-createnativedeltatable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "WriteManifest": { "MarkdownDocumentation": "`WriteManifest`\n\nSpecifies whether to write the manifest files to the Delta table path.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-writemanifest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DeltaTables": { "MarkdownDocumentation": "`DeltaTables`\n\nA list of the Amazon S3 paths to the Delta tables.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-deltatables", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Glue::Crawler.DynamoDBTarget": { "MarkdownDocumentation": "`AWS::Glue::Crawler.DynamoDBTarget`\n\nSpecifies an Amazon DynamoDB table to crawl.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe name of the DynamoDB table to crawl.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html#cfn-glue-crawler-dynamodbtarget-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScanRate": { "MarkdownDocumentation": "`ScanRate`\n\nThe percentage of the configured read capacity units to use by the AWS Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.\nThe valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html#cfn-glue-crawler-dynamodbtarget-scanrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ScanAll": { "MarkdownDocumentation": "`ScanAll`\n\nIndicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.\nA value of `true` means to scan all records, while a value of `false` means to sample the records. If no value is specified, the value 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html#cfn-glue-crawler-dynamodbtarget-scanall", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Glue::Crawler.HudiTarget": { "MarkdownDocumentation": "`AWS::Glue::Crawler.HudiTarget`\n\nSpecifies an Apache Hudi data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html#cfn-glue-crawler-huditarget-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Exclusions": { "MarkdownDocumentation": "`Exclusions`\n\nA list of glob patterns used to exclude from the crawl.\nFor more information, see [Catalog Tables with a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html#cfn-glue-crawler-huditarget-exclusions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Paths": { "MarkdownDocumentation": "`Paths`\n\nAn array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.\nThe crawler will scan all folders underneath a path for a Hudi folder.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html#cfn-glue-crawler-huditarget-paths", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaximumTraversalDepth": { "MarkdownDocumentation": "`MaximumTraversalDepth`\n\nThe maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html#cfn-glue-crawler-huditarget-maximumtraversaldepth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Glue::Crawler.IcebergTarget": { "MarkdownDocumentation": "`AWS::Glue::Crawler.IcebergTarget`\n\nSpecifies Apache Iceberg data store targets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection to use to connect to the Iceberg 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Exclusions": { "MarkdownDocumentation": "`Exclusions`\n\nA list of global patterns used to exclude from the crawl.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-exclusions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Paths": { "MarkdownDocumentation": "`Paths`\n\nOne or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix .\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-paths", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaximumTraversalDepth": { "MarkdownDocumentation": "`MaximumTraversalDepth`\n\nThe maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-maximumtraversaldepth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Glue::Crawler.JdbcTarget": { "MarkdownDocumentation": "`AWS::Glue::Crawler.JdbcTarget`\n\nSpecifies a JDBC data store to crawl.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection to use to connect to the JDBC 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Path": { "MarkdownDocumentation": "`Path`\n\nThe path of the JDBC 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Exclusions": { "MarkdownDocumentation": "`Exclusions`\n\nA list of glob patterns used to exclude from the crawl. For more information, see\n[Catalog Tables\nwith a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-exclusions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnableAdditionalMetadata": { "MarkdownDocumentation": "`EnableAdditionalMetadata`\n\nSpecify a value of `RAWTYPES` or `COMMENTS` to enable additional metadata in table responses. `RAWTYPES` provides the native-level datatype. `COMMENTS` provides comments associated with a column or table in the database.\nIf you do not need additional metadata, keep the field empty.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-enableadditionalmetadata", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Glue::Crawler.LakeFormationConfiguration": { "MarkdownDocumentation": "`AWS::Glue::Crawler.LakeFormationConfiguration`\n\nSpecifies AWS Lake Formation configuration settings for the crawler.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-lakeformationconfiguration.html", "Properties": { "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nRequired for cross account crawls. For same account crawls as the target data, this can be left as null.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-lakeformationconfiguration.html#cfn-glue-crawler-lakeformationconfiguration-accountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UseLakeFormationCredentials": { "MarkdownDocumentation": "`UseLakeFormationCredentials`\n\nSpecifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-lakeformationconfiguration.html#cfn-glue-crawler-lakeformationconfiguration-uselakeformationcredentials", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Glue::Crawler.MongoDBTarget": { "MarkdownDocumentation": "`AWS::Glue::Crawler.MongoDBTarget`\n\nSpecifies an Amazon DocumentDB or MongoDB data store to crawl.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-mongodbtarget.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection to use to connect to the Amazon DocumentDB or MongoDB 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-mongodbtarget.html#cfn-glue-crawler-mongodbtarget-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Path": { "MarkdownDocumentation": "`Path`\n\nThe path of the Amazon DocumentDB or MongoDB target (database/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-mongodbtarget.html#cfn-glue-crawler-mongodbtarget-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Crawler.RecrawlPolicy": { "MarkdownDocumentation": "`AWS::Glue::Crawler.RecrawlPolicy`\n\nWhen crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see [Incremental Crawls in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html) in the developer guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-recrawlpolicy.html", "Properties": { "RecrawlBehavior": { "MarkdownDocumentation": "`RecrawlBehavior`\n\nSpecifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.\nA value of `CRAWL_EVERYTHING` specifies crawling the entire dataset again.\nA value of `CRAWL_NEW_FOLDERS_ONLY` specifies crawling only folders that were added since the last crawler run.\nA value of `CRAWL_EVENT_MODE` specifies crawling only the changes identified by Amazon S3 events.\n*Required*: No\n*Type*: String\n*Allowed values*: `CRAWL_EVERYTHING | CRAWL_NE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CRAWL_EVERYTHING", "CRAWL_NEW_FOLDERS_ONLY", "CRAWL_EVENT_MODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-recrawlpolicy.html#cfn-glue-crawler-recrawlpolicy-recrawlbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Crawler.S3Target": { "MarkdownDocumentation": "`AWS::Glue::Crawler.S3Target`\n\nSpecifies a data store in Amazon Simple Storage Service (Amazon S3).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Path": { "MarkdownDocumentation": "`Path`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SampleSize": { "MarkdownDocumentation": "`SampleSize`\n\nSets 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-samplesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Exclusions": { "MarkdownDocumentation": "`Exclusions`\n\nA list of glob patterns used to exclude from the crawl. For more information, see\n[Catalog Tables\nwith a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-exclusions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DlqEventQueueArn": { "MarkdownDocumentation": "`DlqEventQueueArn`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-dlqeventqueuearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventQueueArn": { "MarkdownDocumentation": "`EventQueueArn`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-eventqueuearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Crawler.Schedule": { "MarkdownDocumentation": "`AWS::Glue::Crawler.Schedule`\n\nA scheduling object using a `cron` statement to schedule an event.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html", "Properties": { "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nA `cron` expression used to specify the schedule. For more information, see\n[Time-Based Schedules for\nJobs 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,\nspecify `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html#cfn-glue-crawler-schedule-scheduleexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Crawler.SchemaChangePolicy": { "MarkdownDocumentation": "`AWS::Glue::Crawler.SchemaChangePolicy`\n\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html", "Properties": { "UpdateBehavior": { "MarkdownDocumentation": "`UpdateBehavior`\n\nThe 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*Allowed values*: `LOG | UPDATE_IN_DATABASE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOG", "UPDATE_IN_DATABASE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-updatebehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeleteBehavior": { "MarkdownDocumentation": "`DeleteBehavior`\n\nThe 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*Allowed values*: `LOG | DELETE_FROM_DATABASE ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOG", "DELETE_FROM_DATABASE", "DEPRECATE_IN_DATABASE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-deletebehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Crawler.Targets": { "MarkdownDocumentation": "`AWS::Glue::Crawler.Targets`\n\nSpecifies data stores to crawl.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html", "Properties": { "HudiTargets": { "MarkdownDocumentation": "`HudiTargets`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [HudiTarget](./aws-properties-glue-crawler-huditarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-huditargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HudiTarget", "DuplicatesAllowed": true }, "S3Targets": { "MarkdownDocumentation": "`S3Targets`\n\nSpecifies Amazon Simple Storage Service (Amazon S3) targets.\n*Required*: No\n*Type*: Array of [S3Target](./aws-properties-glue-crawler-s3target.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-s3targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "S3Target", "DuplicatesAllowed": true }, "CatalogTargets": { "MarkdownDocumentation": "`CatalogTargets`\n\nSpecifies AWS Glue Data Catalog targets.\n*Required*: No\n*Type*: Array of [CatalogTarget](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-catalogtargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CatalogTarget", "DuplicatesAllowed": true }, "DeltaTargets": { "MarkdownDocumentation": "`DeltaTargets`\n\nSpecifies an array of Delta data store targets.\n*Required*: No\n*Type*: Array of [DeltaTarget](./aws-properties-glue-crawler-deltatarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-deltatargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DeltaTarget", "DuplicatesAllowed": true }, "MongoDBTargets": { "MarkdownDocumentation": "`MongoDBTargets`\n\nA list of Mongo DB targets.\n*Required*: No\n*Type*: Array of [MongoDBTarget](./aws-properties-glue-crawler-mongodbtarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-mongodbtargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MongoDBTarget", "DuplicatesAllowed": true }, "JdbcTargets": { "MarkdownDocumentation": "`JdbcTargets`\n\nSpecifies JDBC targets.\n*Required*: No\n*Type*: Array of [JdbcTarget](./aws-properties-glue-crawler-jdbctarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-jdbctargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "JdbcTarget", "DuplicatesAllowed": true }, "DynamoDBTargets": { "MarkdownDocumentation": "`DynamoDBTargets`\n\nSpecifies Amazon DynamoDB targets.\n*Required*: No\n*Type*: Array of [DynamoDBTarget](./aws-properties-glue-crawler-dynamodbtarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-dynamodbtargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DynamoDBTarget", "DuplicatesAllowed": true }, "IcebergTargets": { "MarkdownDocumentation": "`IcebergTargets`\n\nSpecifies Apache Iceberg data store targets.\n*Required*: No\n*Type*: Array of [IcebergTarget](./aws-properties-glue-crawler-icebergtarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-icebergtargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IcebergTarget", "DuplicatesAllowed": true } } }, "AWS::Glue::DataCatalogEncryptionSettings.ConnectionPasswordEncryption": { "MarkdownDocumentation": "`AWS::Glue::DataCatalogEncryptionSettings.ConnectionPasswordEncryption`\n\nThe data structure used by the Data Catalog to encrypt the password as part of\n`CreateConnection` or `UpdateConnection` and store it in the\n`ENCRYPTED_PASSWORD` field in the connection properties. You can enable catalog\nencryption or only password encryption.\nWhen a `CreationConnection` request arrives containing a password, the Data\nCatalog first encrypts the password using your AWS KMS key. It then encrypts the whole\nconnection object again if catalog encryption is also enabled.\nThis encryption requires that you set AWS KMS key permissions to enable or restrict access\non the password key according to your security requirements. For example, you might want only\nadministrators to have decrypt permission on the password key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html", "Properties": { "ReturnConnectionPasswordEncrypted": { "Required": false, "MarkdownDocumentation": "`ReturnConnectionPasswordEncrypted`\n\nWhen the `ReturnConnectionPasswordEncrypted` flag is set to \"true\", passwords remain encrypted in the responses of `GetConnection` and `GetConnections`. This encryption takes effect independently from catalog encryption.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html#cfn-glue-datacatalogencryptionsettings-connectionpasswordencryption-returnconnectionpasswordencrypted", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nAn AWS KMS key that is used to encrypt the connection password.\nIf connection password protection is enabled, the caller of\n`CreateConnection` and `UpdateConnection` needs at least\n`kms:Encrypt` permission on the specified AWS KMS key, to encrypt\npasswords before storing them in the Data Catalog. You can set the decrypt permission to\nenable or restrict access on the password key according to your security\nrequirements.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html#cfn-glue-datacatalogencryptionsettings-connectionpasswordencryption-kmskeyid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::DataCatalogEncryptionSettings.DataCatalogEncryptionSettings": { "MarkdownDocumentation": "`AWS::Glue::DataCatalogEncryptionSettings.DataCatalogEncryptionSettings`\n\nContains configuration information for maintaining Data Catalog security.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html", "Properties": { "ConnectionPasswordEncryption": { "Type": "ConnectionPasswordEncryption", "Required": false, "MarkdownDocumentation": "`ConnectionPasswordEncryption`\n\nWhen connection password protection is enabled, the Data Catalog uses a customer-provided\nkey to encrypt the password as part of `CreateConnection` or\n`UpdateConnection` and store it in the `ENCRYPTED_PASSWORD` field in\nthe connection properties. You can enable catalog encryption or only password\nencryption.\n*Required*: No\n*Type*: [ConnectionPasswordEncryption](./aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings-connectionpasswordencryption", "UpdateType": "Mutable" }, "EncryptionAtRest": { "Type": "EncryptionAtRest", "Required": false, "MarkdownDocumentation": "`EncryptionAtRest`\n\nSpecifies the encryption-at-rest configuration for the Data Catalog.\n*Required*: No\n*Type*: [EncryptionAtRest](./aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings-encryptionatrest", "UpdateType": "Mutable" } } }, "AWS::Glue::DataCatalogEncryptionSettings.EncryptionAtRest": { "MarkdownDocumentation": "`AWS::Glue::DataCatalogEncryptionSettings.EncryptionAtRest`\n\nSpecifies the encryption-at-rest configuration for the Data Catalog.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html", "Properties": { "CatalogEncryptionMode": { "Required": false, "MarkdownDocumentation": "`CatalogEncryptionMode`\n\nThe encryption-at-rest mode for encrypting Data Catalog data.\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLED | SSE-KMS | SSE-KM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "SSE-KMS", "SSE-KMS-WITH-SERVICE-ROLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html#cfn-glue-datacatalogencryptionsettings-encryptionatrest-catalogencryptionmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CatalogEncryptionServiceRole": { "Required": false, "MarkdownDocumentation": "`CatalogEncryptionServiceRole`\n\nThe role that AWS Glue assumes to encrypt and decrypt the Data Catalog objects on the caller's behalf.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov|iso(-[bef])?))?: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html#cfn-glue-datacatalogencryptionsettings-encryptionatrest-catalogencryptionservicerole", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SseAwsKmsKeyId": { "Required": false, "MarkdownDocumentation": "`SseAwsKmsKeyId`\n\nThe ID of the AWS KMS key to use for encryption at rest.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html#cfn-glue-datacatalogencryptionsettings-encryptionatrest-sseawskmskeyid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::DataQualityRuleset.DataQualityTargetTable": { "MarkdownDocumentation": "`AWS::Glue::DataQualityRuleset.DataQualityTargetTable`\n\nAn object representing an AWS Glue table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-dataqualityruleset-dataqualitytargettable.html", "Properties": { "TableName": { "Required": false, "MarkdownDocumentation": "`TableName`\n\nThe name of the AWS Glue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-dataqualityruleset-dataqualitytargettable.html#cfn-glue-dataqualityruleset-dataqualitytargettable-tablename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DatabaseName": { "Required": false, "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the database where the AWS Glue table exists.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-dataqualityruleset-dataqualitytargettable.html#cfn-glue-dataqualityruleset-dataqualitytargettable-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Database.DataLakePrincipal": { "MarkdownDocumentation": "`AWS::Glue::Database.DataLakePrincipal`\n\nThe AWS Lake Formation principal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-datalakeprincipal.html", "Properties": { "DataLakePrincipalIdentifier": { "MarkdownDocumentation": "`DataLakePrincipalIdentifier`\n\nAn identifier for the AWS Lake Formation principal.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-datalakeprincipal.html#cfn-glue-database-datalakeprincipal-datalakeprincipalidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Database.DatabaseIdentifier": { "MarkdownDocumentation": "`AWS::Glue::Database.DatabaseIdentifier`\n\nA structure that describes a target database for resource linking.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseidentifier.html", "Properties": { "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseidentifier.html#cfn-glue-database-databaseidentifier-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseidentifier.html#cfn-glue-database-databaseidentifier-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe ID of the Data Catalog in which the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseidentifier.html#cfn-glue-database-databaseidentifier-catalogid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Database.DatabaseInput": { "MarkdownDocumentation": "`AWS::Glue::Database.DatabaseInput`\n\nThe structure used to create or update a database.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html", "Properties": { "LocationUri": { "MarkdownDocumentation": "`LocationUri`\n\nThe location of the database (for example, an HDFS path).\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-locationuri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateTableDefaultPermissions": { "MarkdownDocumentation": "`CreateTableDefaultPermissions`\n\nCreates 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*: Array of [PrincipalPrivileges](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-createtabledefaultpermissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PrincipalPrivileges", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the database.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThese key-value pairs define parameters and properties\nof the database.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-parameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TargetDatabase": { "MarkdownDocumentation": "`TargetDatabase`\n\nA `DatabaseIdentifier` structure that describes a target database for resource linking.\n*Required*: No\n*Type*: [DatabaseIdentifier](./aws-properties-glue-database-databaseidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-targetdatabase", "UpdateType": "Mutable", "Required": false, "Type": "DatabaseIdentifier" }, "FederatedDatabase": { "MarkdownDocumentation": "`FederatedDatabase`\n\nA `FederatedDatabase` structure that references an entity outside the AWS Glue Data Catalog.\n*Required*: No\n*Type*: [FederatedDatabase](./aws-properties-glue-database-federateddatabase.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-federateddatabase", "UpdateType": "Mutable", "Required": false, "Type": "FederatedDatabase" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the database. For Hive compatibility, this is folded to lowercase when it is\nstored.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Database.FederatedDatabase": { "MarkdownDocumentation": "`AWS::Glue::Database.FederatedDatabase`\n\nA `FederatedDatabase` structure that references an entity outside the AWS Glue Data Catalog.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-federateddatabase.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection to the external metastore.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-federateddatabase.html#cfn-glue-database-federateddatabase-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nA unique identifier for the federated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-federateddatabase.html#cfn-glue-database-federateddatabase-identifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Database.PrincipalPrivileges": { "MarkdownDocumentation": "`AWS::Glue::Database.PrincipalPrivileges`\n\nthe permissions granted to a principal\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html", "Properties": { "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nThe permissions that are granted to the principal.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html#cfn-glue-database-principalprivileges-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe principal who is granted permissions.\n*Required*: No\n*Type*: [DataLakePrincipal](./aws-properties-glue-database-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html#cfn-glue-database-principalprivileges-principal", "UpdateType": "Mutable", "Required": false, "Type": "DataLakePrincipal" } } }, "AWS::Glue::Integration.IntegrationConfig": { "MarkdownDocumentation": "`AWS::Glue::Integration.IntegrationConfig`\n\nProperties associated with the integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integration-integrationconfig.html", "Properties": { "ContinuousSync": { "MarkdownDocumentation": "`ContinuousSync`\n\nEnables continuous synchronization for on-demand data extractions from SaaS applications to AWS data services like Amazon Redshift\nand Amazon S3.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integration-integrationconfig.html#cfn-glue-integration-integrationconfig-continuoussync", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "RefreshInterval": { "MarkdownDocumentation": "`RefreshInterval`\n\nSpecifies the frequency at which CDC (Change Data Capture) pulls or incremental loads should occur. This parameter provides flexibility to align\nthe refresh rate with your specific data update patterns, system load considerations, and performance optimization goals. Time increment can be set from\n15 minutes to 8640 minutes (six days).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integration-integrationconfig.html#cfn-glue-integration-integrationconfig-refreshinterval", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceProperties": { "MarkdownDocumentation": "`SourceProperties`\n\nA collection of key-value pairs that specify additional properties for the integration source. These properties provide configuration options that\ncan be used to customize the behavior of the ODB source during data integration operations.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integration-integrationconfig.html#cfn-glue-integration-integrationconfig-sourceproperties", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::Glue::IntegrationResourceProperty.SourceProcessingProperties": { "MarkdownDocumentation": "`AWS::Glue::IntegrationResourceProperty.SourceProcessingProperties`\n\nThe structure used to define the resource properties associated with the integration source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-sourceprocessingproperties.html", "Properties": { "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role to access the AWS Glue connection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-sourceprocessingproperties.html#cfn-glue-integrationresourceproperty-sourceprocessingproperties-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Glue::IntegrationResourceProperty.TargetProcessingProperties": { "MarkdownDocumentation": "`AWS::Glue::IntegrationResourceProperty.TargetProcessingProperties`\n\nThe structure used to define the resource properties associated with the integration target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe AWS Glue network connection to configure the AWS Glue job running in the customer VPC.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html#cfn-glue-integrationresourceproperty-targetprocessingproperties-connectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsArn": { "MarkdownDocumentation": "`KmsArn`\n\nThe ARN of the KMS key used for encryption.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws:kms:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html#cfn-glue-integrationresourceproperty-targetprocessingproperties-kmsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role to access the AWS Glue database.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html#cfn-glue-integrationresourceproperty-targetprocessingproperties-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EventBusArn": { "MarkdownDocumentation": "`EventBusArn`\n\nThe ARN of an Eventbridge event bus to receive the integration status notification.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html#cfn-glue-integrationresourceproperty-targetprocessingproperties-eventbusarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Job.ConnectionsList": { "MarkdownDocumentation": "`AWS::Glue::Job.ConnectionsList`\n\nSpecifies the connections used by a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html", "Properties": { "Connections": { "MarkdownDocumentation": "`Connections`\n\nA list of connections used by the job.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html#cfn-glue-job-connectionslist-connections", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Glue::Job.ExecutionProperty": { "MarkdownDocumentation": "`AWS::Glue::Job.ExecutionProperty`\n\nAn execution property of a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html", "Properties": { "MaxConcurrentRuns": { "MarkdownDocumentation": "`MaxConcurrentRuns`\n\nThe maximum number of concurrent runs allowed for the job. The default is 1. An error\nis returned when this threshold is reached. The maximum value you can specify is\ncontrolled by a service limit.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html#cfn-glue-job-executionproperty-maxconcurrentruns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Glue::Job.JobCommand": { "MarkdownDocumentation": "`AWS::Glue::Job.JobCommand`\n\nSpecifies code executed when a job is run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html", "Properties": { "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nIn Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see [Working with Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/ray-jobs-section.html) in the AWS Glue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-runtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PythonVersion": { "MarkdownDocumentation": "`PythonVersion`\n\nThe 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*Pattern*: `^([2-3]|3[.]9)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-pythonversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScriptLocation": { "MarkdownDocumentation": "`ScriptLocation`\n\nSpecifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes\na job (required).\n*Required*: No\n*Type*: String\n*Maximum*: `400000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-scriptlocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the job command. For an Apache Spark ETL job, this must be\n`glueetl`. For a Python shell job, it must be `pythonshell`.\nFor an Apache Spark streaming ETL job, this must be `gluestreaming`. For a Ray job,\nthis must be `glueray`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Job.NotificationProperty": { "MarkdownDocumentation": "`AWS::Glue::Job.NotificationProperty`\n\nSpecifies configuration properties of a notification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-notificationproperty.html", "Properties": { "NotifyDelayAfter": { "MarkdownDocumentation": "`NotifyDelayAfter`\n\nAfter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-notificationproperty.html#cfn-glue-job-notificationproperty-notifydelayafter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Glue::MLTransform.FindMatchesParameters": { "MarkdownDocumentation": "`AWS::Glue::MLTransform.FindMatchesParameters`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html", "Properties": { "PrecisionRecallTradeoff": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters-precisionrecalltradeoff", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "EnforceProvidedLabels": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters-enforceprovidedlabels", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "PrimaryKeyColumnName": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters-primarykeycolumnname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AccuracyCostTradeoff": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters-findmatchesparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters-accuracycosttradeoff", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::Glue::MLTransform.GlueTables": { "MarkdownDocumentation": "`AWS::Glue::MLTransform.GlueTables`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html", "Properties": { "ConnectionName": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html#cfn-glue-mltransform-inputrecordtables-gluetables-connectionname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TableName": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html#cfn-glue-mltransform-inputrecordtables-gluetables-tablename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DatabaseName": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html#cfn-glue-mltransform-inputrecordtables-gluetables-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CatalogId": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables-gluetables.html#cfn-glue-mltransform-inputrecordtables-gluetables-catalogid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::MLTransform.InputRecordTables": { "MarkdownDocumentation": "`AWS::Glue::MLTransform.InputRecordTables`\n\nA list of AWS Glue table definitions used by the transform.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables.html", "Properties": { "GlueTables": { "Type": "List", "Required": false, "MarkdownDocumentation": "`GlueTables`\n\nThe database and table in the AWS Glue Data Catalog that is used for input or output data.\n*Required*: No\n*Type*: [Array](./aws-properties-glue-mltransform-gluetables.html) of [GlueTables](./aws-properties-glue-mltransform-gluetables.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables.html#cfn-glue-mltransform-inputrecordtables-gluetables", "ItemType": "GlueTables", "UpdateType": "Mutable" } } }, "AWS::Glue::MLTransform.MLUserDataEncryption": { "MarkdownDocumentation": "`AWS::Glue::MLTransform.MLUserDataEncryption`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformencryption-mluserdataencryption.html", "Properties": { "MLUserDataEncryptionMode": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformencryption-mluserdataencryption.html#cfn-glue-mltransform-transformencryption-mluserdataencryption-mluserdataencryptionmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KmsKeyId": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformencryption-mluserdataencryption.html#cfn-glue-mltransform-transformencryption-mluserdataencryption-kmskeyid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::MLTransform.TransformEncryption": { "MarkdownDocumentation": "`AWS::Glue::MLTransform.TransformEncryption`\n\nThe encryption-at-rest settings of the transform that apply to accessing user data. Machine learning\ntransforms can access user data encrypted in Amazon S3 using KMS.\nAdditionally, imported labels and trained transforms can now be encrypted using a customer provided\nKMS key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformencryption.html", "Properties": { "MLUserDataEncryption": { "Type": "MLUserDataEncryption", "Required": false, "MarkdownDocumentation": "`MLUserDataEncryption`\n\nThe encryption-at-rest settings of the transform that apply to accessing user data.\n*Required*: No\n*Type*: [MLUserDataEncryption](./aws-properties-glue-mltransform-mluserdataencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformencryption.html#cfn-glue-mltransform-transformencryption-mluserdataencryption", "UpdateType": "Mutable" }, "TaskRunSecurityConfigurationName": { "Required": false, "MarkdownDocumentation": "`TaskRunSecurityConfigurationName`\n\nThe name 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformencryption.html#cfn-glue-mltransform-transformencryption-taskrunsecurityconfigurationname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::MLTransform.TransformParameters": { "MarkdownDocumentation": "`AWS::Glue::MLTransform.TransformParameters`\n\nThe algorithm-specific parameters that are associated with the machine learning\ntransform.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters.html", "Properties": { "TransformType": { "Required": true, "MarkdownDocumentation": "`TransformType`\n\nThe type of machine learning transform. `FIND_MATCHES` is the only option.\nFor information about the types of machine learning transforms, see [Working with machine learning transforms](https://docs.aws.amazon.com/glue/latest/dg/console-machine-learning-transforms.html).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIND_MATCHES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIND_MATCHES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters.html#cfn-glue-mltransform-transformparameters-transformtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FindMatchesParameters": { "Type": "FindMatchesParameters", "Required": false, "MarkdownDocumentation": "`FindMatchesParameters`\n\nThe parameters for the find matches algorithm.\n*Required*: No\n*Type*: [FindMatchesParameters](./aws-properties-glue-mltransform-findmatchesparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters", "UpdateType": "Mutable" } } }, "AWS::Glue::Partition.Column": { "MarkdownDocumentation": "`AWS::Glue::Partition.Column`\n\nA column in a `Table`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html", "Properties": { "Comment": { "Required": false, "MarkdownDocumentation": "`Comment`\n\nA free-form text comment.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-comment", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Type": { "Required": false, "MarkdownDocumentation": "`Type`\n\nThe data type of the `Column`.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the `Column`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Partition.Order": { "MarkdownDocumentation": "`AWS::Glue::Partition.Order`\n\nSpecifies the sort order of a sorted column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html", "Properties": { "Column": { "Required": true, "MarkdownDocumentation": "`Column`\n\nThe name of the column.\n*Required*: Yes\n*Type*: [String](./aws-properties-glue-partition-column.html)\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-column", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SortOrder": { "Required": false, "MarkdownDocumentation": "`SortOrder`\n\nIndicates that the column is sorted in ascending order\n(`== 1`), or in descending order (`==0`).\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-sortorder", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::Glue::Partition.PartitionInput": { "MarkdownDocumentation": "`AWS::Glue::Partition.PartitionInput`\n\nThe structure used to create and update a partition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html", "Properties": { "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nThese key-value pairs define partition parameters.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "StorageDescriptor": { "Type": "StorageDescriptor", "Required": false, "MarkdownDocumentation": "`StorageDescriptor`\n\nProvides information about the physical\nlocation where the partition is stored.\n*Required*: No\n*Type*: [StorageDescriptor](./aws-properties-glue-partition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-storagedescriptor", "UpdateType": "Mutable" }, "Values": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`Values`\n\nThe values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.\nThe values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise AWS Glue will add the values to the wrong keys.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-values", "UpdateType": "Immutable" } } }, "AWS::Glue::Partition.SchemaId": { "MarkdownDocumentation": "`AWS::Glue::Partition.SchemaId`\n\nA structure that contains schema identity fields. Either this or the `SchemaVersionId` has to be\nprovided.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html", "Properties": { "RegistryName": { "Required": false, "MarkdownDocumentation": "`RegistryName`\n\nThe name of the schema registry that contains the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-registryname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SchemaName": { "Required": false, "MarkdownDocumentation": "`SchemaName`\n\nThe name of the schema. One of `SchemaArn` or `SchemaName` has to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-schemaname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SchemaArn": { "Required": false, "MarkdownDocumentation": "`SchemaArn`\n\nThe Amazon Resource Name (ARN) of the schema. One of `SchemaArn` or `SchemaName` has to be\nprovided.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-schemaarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Partition.SchemaReference": { "MarkdownDocumentation": "`AWS::Glue::Partition.SchemaReference`\n\nAn object that references a schema stored in the AWS Glue Schema Registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html", "Properties": { "SchemaVersionId": { "Required": false, "MarkdownDocumentation": "`SchemaVersionId`\n\nThe unique ID assigned to a version of the schema. Either this or the `SchemaId` has to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaversionid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SchemaId": { "Type": "SchemaId", "Required": false, "MarkdownDocumentation": "`SchemaId`\n\nA structure that contains schema identity fields. Either this or the `SchemaVersionId` has to be\nprovided.\n*Required*: No\n*Type*: [SchemaId](./aws-properties-glue-partition-schemaid.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaid", "UpdateType": "Mutable" }, "SchemaVersionNumber": { "Required": false, "MarkdownDocumentation": "`SchemaVersionNumber`\n\nThe version number of the schema.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaversionnumber", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::Glue::Partition.SerdeInfo": { "MarkdownDocumentation": "`AWS::Glue::Partition.SerdeInfo`\n\nInformation about a serialization/deserialization program (SerDe) that serves as an\nextractor and loader.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html", "Properties": { "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nThese key-value pairs define initialization parameters for the SerDe.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "SerializationLibrary": { "Required": false, "MarkdownDocumentation": "`SerializationLibrary`\n\nUsually the class that implements the SerDe. An example is\n`org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-serializationlibrary", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nName of the SerDe.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Partition.SkewedInfo": { "MarkdownDocumentation": "`AWS::Glue::Partition.SkewedInfo`\n\nSpecifies skewed values in a table. Skewed values are those that occur with very high\nfrequency.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html", "Properties": { "SkewedColumnNames": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SkewedColumnNames`\n\nA list of names of columns that contain skewed values.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnnames", "UpdateType": "Mutable" }, "SkewedColumnValues": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SkewedColumnValues`\n\nA list of values that appear so frequently as to be considered\nskewed.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvalues", "UpdateType": "Mutable" }, "SkewedColumnValueLocationMaps": { "Required": false, "MarkdownDocumentation": "`SkewedColumnValueLocationMaps`\n\nA mapping of skewed values to the columns that contain them.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvaluelocationmaps", "PrimitiveType": "Json", "UpdateType": "Mutable" } } }, "AWS::Glue::Partition.StorageDescriptor": { "MarkdownDocumentation": "`AWS::Glue::Partition.StorageDescriptor`\n\nDescribes the physical storage of table data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html", "Properties": { "StoredAsSubDirectories": { "Required": false, "MarkdownDocumentation": "`StoredAsSubDirectories`\n\n`True` if the table data is stored in subdirectories, or `False` if\nnot.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-storedassubdirectories", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nThe user-supplied properties in key-value form.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "BucketColumns": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`BucketColumns`\n\nA list of reducer grouping columns, clustering columns, and\nbucketing columns in the table.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-bucketcolumns", "UpdateType": "Mutable" }, "NumberOfBuckets": { "Required": false, "MarkdownDocumentation": "`NumberOfBuckets`\n\nThe number of buckets.\nYou must specify this property if the partition contains any dimension columns.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-numberofbuckets", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "OutputFormat": { "Required": false, "MarkdownDocumentation": "`OutputFormat`\n\nThe output format: `SequenceFileOutputFormat` (binary),\nor `IgnoreKeyTextOutputFormat`, or a custom format.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-outputformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Columns": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Columns`\n\nA list of the `Columns` in the table.\n*Required*: No\n*Type*: Array of [Column](./aws-properties-glue-partition-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-columns", "ItemType": "Column", "UpdateType": "Mutable" }, "SerdeInfo": { "Type": "SerdeInfo", "Required": false, "MarkdownDocumentation": "`SerdeInfo`\n\nThe serialization/deserialization (SerDe) information.\n*Required*: No\n*Type*: [SerdeInfo](./aws-properties-glue-partition-serdeinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-serdeinfo", "UpdateType": "Mutable" }, "SortColumns": { "Type": "List", "Required": false, "MarkdownDocumentation": "`SortColumns`\n\nA list specifying the sort order of each bucket in the table.\n*Required*: No\n*Type*: Array of [Order](./aws-properties-glue-partition-order.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-sortcolumns", "ItemType": "Order", "UpdateType": "Mutable" }, "Compressed": { "Required": false, "MarkdownDocumentation": "`Compressed`\n\n`True` if the data in the table is compressed, or `False` if\nnot.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-compressed", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SchemaReference": { "Type": "SchemaReference", "Required": false, "MarkdownDocumentation": "`SchemaReference`\n\nAn object that references a schema stored in the AWS Glue Schema Registry.\n*Required*: No\n*Type*: [SchemaReference](./aws-properties-glue-partition-schemareference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-schemareference", "UpdateType": "Mutable" }, "SkewedInfo": { "Type": "SkewedInfo", "Required": false, "MarkdownDocumentation": "`SkewedInfo`\n\nThe information about values that appear frequently in a column (skewed values).\n*Required*: No\n*Type*: [SkewedInfo](./aws-properties-glue-partition-skewedinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-skewedinfo", "UpdateType": "Mutable" }, "InputFormat": { "Required": false, "MarkdownDocumentation": "`InputFormat`\n\nThe input format: `SequenceFileInputFormat` (binary),\nor `TextInputFormat`, or a custom format.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-inputformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Location": { "Required": false, "MarkdownDocumentation": "`Location`\n\nThe physical location of the table. By default, this takes the form of the warehouse\nlocation, followed by the database location in the warehouse, followed by the table\nname.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Maximum*: `2056`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-location", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Schema.Registry": { "MarkdownDocumentation": "`AWS::Glue::Schema.Registry`\n\nSpecifies a registry in the AWS Glue Schema Registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-registry.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the registry.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-registry.html#cfn-glue-schema-registry-arn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the registry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-registry.html#cfn-glue-schema-registry-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Schema.SchemaVersion": { "MarkdownDocumentation": "`AWS::Glue::Schema.SchemaVersion`\n\nSpecifies the version of a schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-schemaversion.html", "Properties": { "IsLatest": { "MarkdownDocumentation": "`IsLatest`\n\nIndicates if this version is the latest version of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-schemaversion.html#cfn-glue-schema-schemaversion-islatest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VersionNumber": { "MarkdownDocumentation": "`VersionNumber`\n\nThe version number of the schema.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-schemaversion.html#cfn-glue-schema-schemaversion-versionnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Glue::SchemaVersion.Schema": { "MarkdownDocumentation": "`AWS::Glue::SchemaVersion.Schema`\n\nA wrapper structure to contain schema identity fields. Either `SchemaArn`, or `SchemaName` and `RegistryName` has to be provided.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schemaversion-schema.html", "Properties": { "RegistryName": { "MarkdownDocumentation": "`RegistryName`\n\nThe name of the registry where the schema is stored. Either `SchemaArn`, or `SchemaName` and `RegistryName` has to be provided.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schemaversion-schema.html#cfn-glue-schemaversion-schema-registryname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SchemaArn": { "MarkdownDocumentation": "`SchemaArn`\n\nThe Amazon Resource Name (ARN) of the schema. Either `SchemaArn`, or `SchemaName` and `RegistryName` has to be provided.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn):glue:.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schemaversion-schema.html#cfn-glue-schemaversion-schema-schemaarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SchemaName": { "MarkdownDocumentation": "`SchemaName`\n\nThe name of the schema. Either `SchemaArn`, or `SchemaName` and `RegistryName` has to be provided.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schemaversion-schema.html#cfn-glue-schemaversion-schema-schemaname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::SecurityConfiguration.CloudWatchEncryption": { "MarkdownDocumentation": "`AWS::Glue::SecurityConfiguration.CloudWatchEncryption`\n\nSpecifies how Amazon CloudWatch data should be encrypted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html", "Properties": { "KmsKeyArn": { "Required": false, "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|arn:aws[a-z0-9-]*:kms:.*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html#cfn-glue-securityconfiguration-cloudwatchencryption-kmskeyarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CloudWatchEncryptionMode": { "Required": false, "MarkdownDocumentation": "`CloudWatchEncryptionMode`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "SSE-KMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html#cfn-glue-securityconfiguration-cloudwatchencryption-cloudwatchencryptionmode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::SecurityConfiguration.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::Glue::SecurityConfiguration.EncryptionConfiguration`\n\nSpecifies an encryption configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html", "Properties": { "S3Encryptions": { "Type": "S3Encryptions", "Required": false, "MarkdownDocumentation": "`S3Encryptions`\n\nThe encyption configuration for Amazon Simple Storage Service (Amazon S3) data.\n*Required*: No\n*Type*: Array of [S3Encryption](./aws-properties-glue-securityconfiguration-s3encryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-s3encryptions", "UpdateType": "Mutable" }, "CloudWatchEncryption": { "Type": "CloudWatchEncryption", "Required": false, "MarkdownDocumentation": "`CloudWatchEncryption`\n\nThe encryption configuration for Amazon CloudWatch.\n*Required*: No\n*Type*: [CloudWatchEncryption](./aws-properties-glue-securityconfiguration-cloudwatchencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-cloudwatchencryption", "UpdateType": "Mutable" }, "JobBookmarksEncryption": { "Type": "JobBookmarksEncryption", "Required": false, "MarkdownDocumentation": "`JobBookmarksEncryption`\n\nThe encryption configuration for job bookmarks.\n*Required*: No\n*Type*: [JobBookmarksEncryption](./aws-properties-glue-securityconfiguration-jobbookmarksencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-jobbookmarksencryption", "UpdateType": "Mutable" } } }, "AWS::Glue::SecurityConfiguration.JobBookmarksEncryption": { "MarkdownDocumentation": "`AWS::Glue::SecurityConfiguration.JobBookmarksEncryption`\n\nSpecifies how job bookmark data should be encrypted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html", "Properties": { "KmsKeyArn": { "Required": false, "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|arn:aws[a-z0-9-]*:kms:.*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html#cfn-glue-securityconfiguration-jobbookmarksencryption-kmskeyarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "JobBookmarksEncryptionMode": { "Required": false, "MarkdownDocumentation": "`JobBookmarksEncryptionMode`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "CSE-KMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html#cfn-glue-securityconfiguration-jobbookmarksencryption-jobbookmarksencryptionmode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::SecurityConfiguration.S3Encryption": { "MarkdownDocumentation": "`AWS::Glue::SecurityConfiguration.S3Encryption`\n\nSpecifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html", "Properties": { "KmsKeyArn": { "Required": false, "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|arn:aws[a-z0-9-]*:kms:.*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html#cfn-glue-securityconfiguration-s3encryption-kmskeyarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "S3EncryptionMode": { "Required": false, "MarkdownDocumentation": "`S3EncryptionMode`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "SSE-KMS", "SSE-S3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html#cfn-glue-securityconfiguration-s3encryption-s3encryptionmode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::SecurityConfiguration.S3Encryptions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::Glue::SecurityConfiguration.S3Encryptions`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryptions.html", "ItemType": "S3Encryption", "UpdateType": "Mutable" }, "AWS::Glue::Table.Column": { "MarkdownDocumentation": "`AWS::Glue::Table.Column`\n\nA column in a `Table`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html", "Properties": { "Comment": { "Required": false, "MarkdownDocumentation": "`Comment`\n\nA free-form text comment.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-comment", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Type": { "Required": false, "MarkdownDocumentation": "`Type`\n\nThe data type of the `Column`.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the `Column`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.IcebergInput": { "MarkdownDocumentation": "`AWS::Glue::Table.IcebergInput`\n\nSpecifies an input structure that defines an Apache Iceberg metadata table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-iceberginput.html", "Properties": { "MetadataOperation": { "Type": "MetadataOperation", "Required": false, "MarkdownDocumentation": "`MetadataOperation`\n\nA required metadata operation. Can only be set 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-iceberginput.html#cfn-glue-table-iceberginput-metadataoperation", "UpdateType": "Mutable" }, "Version": { "Required": false, "MarkdownDocumentation": "`Version`\n\nThe table version for the Iceberg table. Defaults to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-iceberginput.html#cfn-glue-table-iceberginput-version", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.MetadataOperation": { "Required": false, "MarkdownDocumentation": "`AWS::Glue::Table.MetadataOperation`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-metadataoperation.html", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AWS::Glue::Table.OpenTableFormatInput": { "MarkdownDocumentation": "`AWS::Glue::Table.OpenTableFormatInput`\n\nSpecifies an `OpenTableFormatInput` structure when creating an open format table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-opentableformatinput.html", "Properties": { "IcebergInput": { "Type": "IcebergInput", "Required": false, "MarkdownDocumentation": "`IcebergInput`\n\nSpecifies an `IcebergInput` structure that defines an Apache Iceberg metadata table.\n*Required*: No\n*Type*: [IcebergInput](./aws-properties-glue-table-iceberginput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-opentableformatinput.html#cfn-glue-table-opentableformatinput-iceberginput", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.Order": { "MarkdownDocumentation": "`AWS::Glue::Table.Order`\n\nSpecifies the sort order of a sorted column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html", "Properties": { "Column": { "Required": true, "MarkdownDocumentation": "`Column`\n\nThe name of the column.\n*Required*: Yes\n*Type*: [String](./aws-properties-glue-table-column.html)\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-column", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SortOrder": { "Required": true, "MarkdownDocumentation": "`SortOrder`\n\nIndicates that the column is sorted in ascending order\n(`== 1`), or in descending order (`==0`).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-sortorder", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.SchemaId": { "MarkdownDocumentation": "`AWS::Glue::Table.SchemaId`\n\nA structure that contains schema identity fields. Either this or the `SchemaVersionId` has to be\nprovided.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemaid.html", "Properties": { "RegistryName": { "Required": false, "MarkdownDocumentation": "`RegistryName`\n\nThe name of the schema registry that contains the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemaid.html#cfn-glue-table-schemaid-registryname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SchemaName": { "Required": false, "MarkdownDocumentation": "`SchemaName`\n\nThe name of the schema. One of `SchemaArn` or `SchemaName` has to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemaid.html#cfn-glue-table-schemaid-schemaname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SchemaArn": { "Required": false, "MarkdownDocumentation": "`SchemaArn`\n\nThe Amazon Resource Name (ARN) of the schema. One of `SchemaArn` or `SchemaName` has to be\nprovided.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemaid.html#cfn-glue-table-schemaid-schemaarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.SchemaReference": { "MarkdownDocumentation": "`AWS::Glue::Table.SchemaReference`\n\nAn object that references a schema stored in the AWS Glue Schema Registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemareference.html", "Properties": { "SchemaVersionId": { "Required": false, "MarkdownDocumentation": "`SchemaVersionId`\n\nThe unique ID assigned to a version of the schema. Either this or the `SchemaId` has to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemareference.html#cfn-glue-table-schemareference-schemaversionid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SchemaId": { "Type": "SchemaId", "Required": false, "MarkdownDocumentation": "`SchemaId`\n\nA structure that contains schema identity fields. Either this or the `SchemaVersionId` has to be\nprovided.\n*Required*: No\n*Type*: [SchemaId](./aws-properties-glue-table-schemaid.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemareference.html#cfn-glue-table-schemareference-schemaid", "UpdateType": "Mutable" }, "SchemaVersionNumber": { "Required": false, "MarkdownDocumentation": "`SchemaVersionNumber`\n\nThe version number of the schema.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemareference.html#cfn-glue-table-schemareference-schemaversionnumber", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.SerdeInfo": { "MarkdownDocumentation": "`AWS::Glue::Table.SerdeInfo`\n\nInformation about a serialization/deserialization program (SerDe) that serves as an\nextractor and loader.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html", "Properties": { "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nThese key-value pairs define initialization parameters for the SerDe.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "SerializationLibrary": { "Required": false, "MarkdownDocumentation": "`SerializationLibrary`\n\nUsually the class that implements the SerDe. An example is\n`org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-serializationlibrary", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nName of the SerDe.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.SkewedInfo": { "MarkdownDocumentation": "`AWS::Glue::Table.SkewedInfo`\n\nSpecifies skewed values in a table. Skewed values are those that occur with very high\nfrequency.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html", "Properties": { "SkewedColumnNames": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SkewedColumnNames`\n\nA list of names of columns that contain skewed values.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnnames", "UpdateType": "Mutable" }, "SkewedColumnValues": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SkewedColumnValues`\n\nA list of values that appear so frequently as to be considered\nskewed.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvalues", "UpdateType": "Mutable" }, "SkewedColumnValueLocationMaps": { "Required": false, "MarkdownDocumentation": "`SkewedColumnValueLocationMaps`\n\nA mapping of skewed values to the columns that contain them.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvaluelocationmaps", "PrimitiveType": "Json", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.StorageDescriptor": { "MarkdownDocumentation": "`AWS::Glue::Table.StorageDescriptor`\n\nDescribes the physical storage of table data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html", "Properties": { "StoredAsSubDirectories": { "Required": false, "MarkdownDocumentation": "`StoredAsSubDirectories`\n\n`True` if the table data is stored in subdirectories, or `False` if\nnot.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-storedassubdirectories", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nThe user-supplied properties in key-value form.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "BucketColumns": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`BucketColumns`\n\nA list of reducer grouping columns, clustering columns, and\nbucketing columns in the table.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-bucketcolumns", "UpdateType": "Mutable" }, "NumberOfBuckets": { "Required": false, "MarkdownDocumentation": "`NumberOfBuckets`\n\nMust be specified if the table contains any dimension columns.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-numberofbuckets", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "OutputFormat": { "Required": false, "MarkdownDocumentation": "`OutputFormat`\n\nThe output format: `SequenceFileOutputFormat` (binary),\nor `IgnoreKeyTextOutputFormat`, or a custom format.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-outputformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Columns": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Columns`\n\nA list of the `Columns` in the table.\n*Required*: No\n*Type*: Array of [Column](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-columns", "ItemType": "Column", "UpdateType": "Mutable" }, "SerdeInfo": { "Type": "SerdeInfo", "Required": false, "MarkdownDocumentation": "`SerdeInfo`\n\nThe serialization/deserialization (SerDe) information.\n*Required*: No\n*Type*: [SerdeInfo](./aws-properties-glue-table-serdeinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-serdeinfo", "UpdateType": "Mutable" }, "SortColumns": { "Type": "List", "Required": false, "MarkdownDocumentation": "`SortColumns`\n\nA list specifying the sort order of each bucket in the table.\n*Required*: No\n*Type*: Array of [Order](./aws-properties-glue-table-order.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-sortcolumns", "ItemType": "Order", "UpdateType": "Mutable" }, "Compressed": { "Required": false, "MarkdownDocumentation": "`Compressed`\n\n`True` if the data in the table is compressed, or `False` if\nnot.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-compressed", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SchemaReference": { "Type": "SchemaReference", "Required": false, "MarkdownDocumentation": "`SchemaReference`\n\nAn object that references a schema stored in the AWS Glue Schema Registry.\n*Required*: No\n*Type*: [SchemaReference](./aws-properties-glue-table-schemareference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-schemareference", "UpdateType": "Mutable" }, "SkewedInfo": { "Type": "SkewedInfo", "Required": false, "MarkdownDocumentation": "`SkewedInfo`\n\nThe information about values that appear frequently in a column (skewed values).\n*Required*: No\n*Type*: [SkewedInfo](./aws-properties-glue-table-skewedinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-skewedinfo", "UpdateType": "Mutable" }, "InputFormat": { "Required": false, "MarkdownDocumentation": "`InputFormat`\n\nThe input format: `SequenceFileInputFormat` (binary),\nor `TextInputFormat`, or a custom format.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-inputformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Location": { "Required": false, "MarkdownDocumentation": "`Location`\n\nThe physical location of the table. By default, this takes the form of the warehouse\nlocation, followed by the database location in the warehouse, followed by the table\nname.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Maximum*: `2056`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-location", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.TableIdentifier": { "MarkdownDocumentation": "`AWS::Glue::Table.TableIdentifier`\n\nA structure that describes a target table for resource linking.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html", "Properties": { "DatabaseName": { "Required": false, "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the catalog database that contains the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html#cfn-glue-table-tableidentifier-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Region": { "Required": false, "MarkdownDocumentation": "`Region`\n\nThe Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html#cfn-glue-table-tableidentifier-region", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CatalogId": { "Required": false, "MarkdownDocumentation": "`CatalogId`\n\nThe ID of the Data Catalog in which the table 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html#cfn-glue-table-tableidentifier-catalogid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html#cfn-glue-table-tableidentifier-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Table.TableInput": { "MarkdownDocumentation": "`AWS::Glue::Table.TableInput`\n\nA structure used to define a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html", "Properties": { "Owner": { "Required": false, "MarkdownDocumentation": "`Owner`\n\nThe table owner. Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-owner", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ViewOriginalText": { "Required": false, "MarkdownDocumentation": "`ViewOriginalText`\n\nIncluded for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.\nIf the table is a `VIRTUAL_VIEW`, certain Athena configuration encoded in base64.\n*Required*: No\n*Type*: String\n*Maximum*: `409600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-vieworiginaltext", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA description of the table.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TableType": { "Required": false, "MarkdownDocumentation": "`TableType`\n\nThe type of this table.\nAWS Glue will create tables with the `EXTERNAL_TABLE` type.\nOther services, such as Athena, may create tables with additional table types.\nAWS Glue related table types:\nEXTERNAL\\_TABLE\nHive compatible attribute - indicates a non-Hive managed table.\n\nGOVERNED\nUsed by AWS Lake Formation.\nThe AWS Glue Data Catalog understands `GOVERNED`.\n\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-tabletype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nThese 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "ViewExpandedText": { "Required": false, "MarkdownDocumentation": "`ViewExpandedText`\n\nIncluded for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.\n*Required*: No\n*Type*: String\n*Maximum*: `409600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-viewexpandedtext", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StorageDescriptor": { "Type": "StorageDescriptor", "Required": false, "MarkdownDocumentation": "`StorageDescriptor`\n\nA storage descriptor containing information about the physical storage\nof this table.\n*Required*: No\n*Type*: [StorageDescriptor](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-storagedescriptor", "UpdateType": "Mutable" }, "TargetTable": { "Type": "TableIdentifier", "Required": false, "MarkdownDocumentation": "`TargetTable`\n\nA `TableIdentifier` structure that describes a target table for resource linking.\n*Required*: No\n*Type*: [TableIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-targettable", "UpdateType": "Mutable" }, "PartitionKeys": { "Type": "List", "Required": false, "MarkdownDocumentation": "`PartitionKeys`\n\nA list of columns by which the table is partitioned. Only primitive\ntypes are supported as partition keys.\nWhen you create a table used by Amazon Athena, and you do not specify any\n`partitionKeys`, you must at least set the value of `partitionKeys` to\nan empty list. For example:\n`\"PartitionKeys\": []`\n*Required*: No\n*Type*: Array of [Column](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-partitionkeys", "ItemType": "Column", "UpdateType": "Mutable" }, "Retention": { "Required": false, "MarkdownDocumentation": "`Retention`\n\nThe retention time for this table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-retention", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe table name. For Hive compatibility, this is folded to\nlowercase when it is stored.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::TableOptimizer.IcebergConfiguration": { "MarkdownDocumentation": "`AWS::Glue::TableOptimizer.IcebergConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration-icebergconfiguration.html", "Properties": { "OrphanFileRetentionPeriodInDays": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration-icebergconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration-icebergconfiguration-orphanfileretentionperiodindays", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Location": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration-icebergconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration-icebergconfiguration-location", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::TableOptimizer.IcebergRetentionConfiguration": { "MarkdownDocumentation": "`AWS::Glue::TableOptimizer.IcebergRetentionConfiguration`\n\nThe `IcebergRetentionConfiguration` property type specifies Property description not available. for an [AWS::Glue::TableOptimizer](./aws-resource-glue-tableoptimizer.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-icebergretentionconfiguration.html", "Properties": { "CleanExpiredFiles": { "Required": false, "MarkdownDocumentation": "`CleanExpiredFiles`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-icebergretentionconfiguration.html#cfn-glue-tableoptimizer-icebergretentionconfiguration-cleanexpiredfiles", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SnapshotRetentionPeriodInDays": { "Required": false, "MarkdownDocumentation": "`SnapshotRetentionPeriodInDays`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-icebergretentionconfiguration.html#cfn-glue-tableoptimizer-icebergretentionconfiguration-snapshotretentionperiodindays", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "NumberOfSnapshotsToRetain": { "Required": false, "MarkdownDocumentation": "`NumberOfSnapshotsToRetain`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-icebergretentionconfiguration.html#cfn-glue-tableoptimizer-icebergretentionconfiguration-numberofsnapshotstoretain", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::Glue::TableOptimizer.OrphanFileDeletionConfiguration": { "MarkdownDocumentation": "`AWS::Glue::TableOptimizer.OrphanFileDeletionConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration.html", "Properties": { "IcebergConfiguration": { "Type": "IcebergConfiguration", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration-icebergconfiguration", "UpdateType": "Mutable" } } }, "AWS::Glue::TableOptimizer.RetentionConfiguration": { "MarkdownDocumentation": "`AWS::Glue::TableOptimizer.RetentionConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-retentionconfiguration.html", "Properties": { "IcebergConfiguration": { "Type": "IcebergRetentionConfiguration", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-retentionconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-retentionconfiguration-icebergconfiguration", "UpdateType": "Mutable" } } }, "AWS::Glue::TableOptimizer.TableOptimizerConfiguration": { "MarkdownDocumentation": "`AWS::Glue::TableOptimizer.TableOptimizerConfiguration`\n\nSpecifies configuration details of a table optimizer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html", "Properties": { "RetentionConfiguration": { "Type": "RetentionConfiguration", "Required": false, "MarkdownDocumentation": "`RetentionConfiguration`\n\nThe configuration for a snapshot retention optimizer for Apache Iceberg tables.\n*Required*: No\n*Type*: [RetentionConfiguration](./aws-properties-glue-tableoptimizer-retentionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-retentionconfiguration", "UpdateType": "Mutable" }, "OrphanFileDeletionConfiguration": { "Type": "OrphanFileDeletionConfiguration", "Required": false, "MarkdownDocumentation": "`OrphanFileDeletionConfiguration`\n\n`OrphanFileDeletionConfiguration` is a property that can be included within the\nTableOptimizer resource. It controls the automatic deletion of orphaned\nfiles - files that are not tracked by the table metadata, and older than the configured age limit.\n*Required*: No\n*Type*: [OrphanFileDeletionConfiguration](./aws-properties-glue-tableoptimizer-orphanfiledeletionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-orphanfiledeletionconfiguration", "UpdateType": "Mutable" }, "Enabled": { "Required": true, "MarkdownDocumentation": "`Enabled`\n\nWhether the table optimization 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "VpcConfiguration": { "Type": "VpcConfiguration", "Required": false, "MarkdownDocumentation": "`VpcConfiguration`\n\nAn object that describes the VPC configuration for a table optimizer. This configuration is necessary to perform optimization on tables that are in a customer VPC.\n*Required*: No\n*Type*: [VpcConfiguration](./aws-properties-glue-tableoptimizer-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-vpcconfiguration", "UpdateType": "Mutable" }, "RoleArn": { "Required": true, "MarkdownDocumentation": "`RoleArn`\n\nA role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::TableOptimizer.VpcConfiguration": { "MarkdownDocumentation": "`AWS::Glue::TableOptimizer.VpcConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-vpcconfiguration.html", "Properties": { "GlueConnectionName": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration-vpcconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-vpcconfiguration-glueconnectionname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Trigger.Action": { "MarkdownDocumentation": "`AWS::Glue::Trigger.Action`\n\nDefines an action to be initiated by a trigger.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html", "Properties": { "NotificationProperty": { "MarkdownDocumentation": "`NotificationProperty`\n\nSpecifies configuration properties of a job run notification.\n*Required*: No\n*Type*: [NotificationProperty](./aws-properties-glue-trigger-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-notificationproperty", "UpdateType": "Mutable", "Required": false, "Type": "NotificationProperty" }, "CrawlerName": { "MarkdownDocumentation": "`CrawlerName`\n\nThe name of the crawler to be used with this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-crawlername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nThe `JobRun` timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-timeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "JobName": { "MarkdownDocumentation": "`JobName`\n\nThe name of a job to be executed.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-jobname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arguments": { "MarkdownDocumentation": "`Arguments`\n\nThe job arguments used when this trigger fires. For this job run, they replace the\ndefault arguments set in the job definition itself.\nYou can specify arguments here that your own job-execution script consumes, in\naddition 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\nGuide*.\nFor information about the key-value pairs that AWS Glue consumes to set up your job,\nsee the [Special Parameters\nUsed by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) topic in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-arguments", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "SecurityConfiguration": { "MarkdownDocumentation": "`SecurityConfiguration`\n\nThe name of the `SecurityConfiguration` structure to be used with this\naction.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-securityconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Trigger.Condition": { "MarkdownDocumentation": "`AWS::Glue::Trigger.Condition`\n\nDefines a condition under which a trigger fires.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html", "Properties": { "CrawlerName": { "MarkdownDocumentation": "`CrawlerName`\n\nThe name of the crawler to which this condition applies.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-crawlername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nThe condition state. Currently, the values supported are `SUCCEEDED`,\n`STOPPED`, `TIMEOUT`, and `FAILED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `STARTING | RUNNING | STOPPI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED", "TIMEOUT", "ERROR", "WAITING", "EXPIRED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrawlState": { "MarkdownDocumentation": "`CrawlState`\n\nThe state of the crawler to which this condition applies.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-crawlstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogicalOperator": { "MarkdownDocumentation": "`LogicalOperator`\n\nA logical operator.\n*Required*: No\n*Type*: String\n*Allowed values*: `EQUALS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-logicaloperator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JobName": { "MarkdownDocumentation": "`JobName`\n\nThe name of the job whose `JobRuns` this condition applies to, and on which\nthis trigger waits.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-jobname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::Trigger.EventBatchingCondition": { "MarkdownDocumentation": "`AWS::Glue::Trigger.EventBatchingCondition`\n\nBatch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-eventbatchingcondition.html", "Properties": { "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nNumber 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-eventbatchingcondition.html#cfn-glue-trigger-eventbatchingcondition-batchsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "BatchWindow": { "MarkdownDocumentation": "`BatchWindow`\n\nWindow 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-eventbatchingcondition.html#cfn-glue-trigger-eventbatchingcondition-batchwindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Glue::Trigger.NotificationProperty": { "MarkdownDocumentation": "`AWS::Glue::Trigger.NotificationProperty`\n\nSpecifies configuration properties of a job run notification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-notificationproperty.html", "Properties": { "NotifyDelayAfter": { "MarkdownDocumentation": "`NotifyDelayAfter`\n\nAfter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-notificationproperty.html#cfn-glue-trigger-notificationproperty-notifydelayafter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Glue::Trigger.Predicate": { "MarkdownDocumentation": "`AWS::Glue::Trigger.Predicate`\n\nDefines the predicate of the trigger, which determines when it fires.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html", "Properties": { "Logical": { "MarkdownDocumentation": "`Logical`\n\nAn optional field if only one condition is listed. If multiple conditions are listed,\nthen this field is required.\n*Required*: No\n*Type*: String\n*Allowed values*: `AND | ANY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "AND", "ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-logical", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nA list of the conditions that determine when the trigger will fire.\n*Required*: No\n*Type*: Array of [Condition](./aws-properties-glue-trigger-condition.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-conditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Condition", "DuplicatesAllowed": true } } }, "AWS::Glue::UsageProfile.ConfigurationObject": { "MarkdownDocumentation": "`AWS::Glue::UsageProfile.ConfigurationObject`\n\nSpecifies the values that an admin sets for each job or session parameter configured in a AWS Glue usage profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nA default value for the parameter.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllowedValues": { "MarkdownDocumentation": "`AllowedValues`\n\nA list of allowed values for the parameter.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-allowedvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MinValue": { "MarkdownDocumentation": "`MinValue`\n\nA minimum allowed value for the parameter.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-minvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxValue": { "MarkdownDocumentation": "`MaxValue`\n\nA maximum allowed value for the parameter.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-maxvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Glue::UsageProfile.ProfileConfiguration": { "MarkdownDocumentation": "`AWS::Glue::UsageProfile.ProfileConfiguration`\n\nSpecifies the job and session values that an admin configures in an AWS Glue usage profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-profileconfiguration.html", "Properties": { "JobConfiguration": { "MarkdownDocumentation": "`JobConfiguration`\n\nA key-value map of configuration parameters for AWS Glue jobs.\n*Required*: No\n*Type*: [ConfigurationObject](./aws-properties-glue-usageprofile-configurationobject.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-profileconfiguration.html#cfn-glue-usageprofile-profileconfiguration-jobconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ConfigurationObject" }, "SessionConfiguration": { "MarkdownDocumentation": "`SessionConfiguration`\n\nA key-value map of configuration parameters for AWS Glue sessions.\n*Required*: No\n*Type*: [ConfigurationObject](./aws-properties-glue-usageprofile-configurationobject.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-profileconfiguration.html#cfn-glue-usageprofile-profileconfiguration-sessionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ConfigurationObject" } } }, "AWS::Grafana::Workspace.AssertionAttributes": { "MarkdownDocumentation": "`AWS::Grafana::Workspace.AssertionAttributes`\n\nA structure that defines which attributes in the IdP assertion are to be used to\ndefine information about the users authenticated by the IdP to use the workspace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Email": { "MarkdownDocumentation": "`Email`\n\nThe name of the attribute within the SAML assertion to use as the email names for SAML\nusers.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-email", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Org": { "MarkdownDocumentation": "`Org`\n\nThe name of the attribute within the SAML assertion to use as the user full \"friendly\"\nnames 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-org", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe name of the attribute within the SAML assertion to use as the user full \"friendly\"\nnames 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-groups", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Login": { "MarkdownDocumentation": "`Login`\n\nThe name of the attribute within the SAML assertion to use as the login names for SAML\nusers.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-login", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the attribute within the SAML assertion to use as the user full \"friendly\"\nnames 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Grafana::Workspace.IdpMetadata": { "MarkdownDocumentation": "`AWS::Grafana::Workspace.IdpMetadata`\n\nA structure containing the identity provider (IdP) metadata used to integrate the\nidentity provider with this workspace. You can specify the metadata either by providing\na URL to its location in the `url` parameter, or by specifying the full\nmetadata in XML format in the `xml` parameter. Specifying both will cause an\nerror.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html", "Properties": { "Xml": { "MarkdownDocumentation": "`Xml`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html#cfn-grafana-workspace-idpmetadata-xml", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html#cfn-grafana-workspace-idpmetadata-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Grafana::Workspace.NetworkAccessControl": { "MarkdownDocumentation": "`AWS::Grafana::Workspace.NetworkAccessControl`\n\nThe configuration settings for in-bound network access to your workspace.\nWhen this is configured, only listed IP addresses and VPC endpoints will be able to\naccess your workspace. Standard Grafana authentication and authorization are still\nrequired.\nAccess is granted to a caller that is in either the IP address list or the VPC\nendpoint list - they do not need to be in both.\nIf this is not configured, or is removed, then all IP addresses and VPC endpoints are\nallowed. Standard Grafana authentication and authorization are still\nrequired.\n###### Note\nWhile both `prefixListIds` and `vpceIds` are required, you\ncan pass in an empty array of strings for either parameter if you do not want to allow any\nof that type.\nIf both are passed as empty arrays, no traffic is allowed to the workspace,\nbecause only *explicitly* allowed connections are accepted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-networkaccesscontrol.html", "Properties": { "PrefixListIds": { "MarkdownDocumentation": "`PrefixListIds`\n\nAn array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses.\nThe IP addresses specified are allowed to access your workspace. If the list is not\nincluded in the configuration (passed an empty array) then no IP addresses are\nallowed to access the workspace. You create a prefix list using the Amazon VPC\nconsole.\nPrefix list IDs have the format `pl-1a2b3c4d`.\nFor more information about prefix lists, see [Group CIDR blocks using managed\nprefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)in the *Amazon Virtual Private Cloud User\nGuide*.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-networkaccesscontrol.html#cfn-grafana-workspace-networkaccesscontrol-prefixlistids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "VpceIds": { "MarkdownDocumentation": "`VpceIds`\n\nAn array of Amazon VPC endpoint IDs for the workspace. You can create VPC\nendpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a\n`NetworkAccessConfiguration` is specified then only VPC endpoints\nspecified here are allowed to access the workspace. If you pass in an empty array\nof strings, then no VPCs are allowed to access the workspace.\nVPC endpoint IDs have the format\n`vpce-1a2b3c4d`.\nFor more information about creating an interface VPC endpoint, see [Interface VPC\nendpoints](https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints) in the *Amazon Managed Grafana User\nGuide*.\n###### Note\nThe only VPC endpoints that can be specified here are interface VPC endpoints for\nGrafana workspaces (using the `com.amazonaws.[region].grafana-workspace`\nservice endpoint). Other VPC endpoints are ignored.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-networkaccesscontrol.html#cfn-grafana-workspace-networkaccesscontrol-vpceids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Grafana::Workspace.RoleValues": { "MarkdownDocumentation": "`AWS::Grafana::Workspace.RoleValues`\n\nThis structure defines which groups defined in the SAML assertion attribute are to be\nmapped to the Grafana `Admin` and `Editor` roles in the workspace.\nSAML authenticated users not part of `Admin` or `Editor` role\ngroups have `Viewer` permission over the workspace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html", "Properties": { "Editor": { "MarkdownDocumentation": "`Editor`\n\nA list of groups from the SAML assertion attribute to grant the Grafana\n`Editor` role to.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html#cfn-grafana-workspace-rolevalues-editor", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Admin": { "MarkdownDocumentation": "`Admin`\n\nA list of groups from the SAML assertion attribute to grant the Grafana\n`Admin` role to.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html#cfn-grafana-workspace-rolevalues-admin", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Grafana::Workspace.SamlConfiguration": { "MarkdownDocumentation": "`AWS::Grafana::Workspace.SamlConfiguration`\n\nA structure containing information about how this workspace works with SAML.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html", "Properties": { "LoginValidityDuration": { "MarkdownDocumentation": "`LoginValidityDuration`\n\nHow long a sign-on session by a SAML user is valid, before the user has to sign on\nagain.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-loginvalidityduration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "RoleValues": { "MarkdownDocumentation": "`RoleValues`\n\nA structure containing arrays that map group names in the SAML assertion to the\nGrafana `Admin` and `Editor` roles in the workspace.\n*Required*: No\n*Type*: [RoleValues](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-rolevalues", "UpdateType": "Mutable", "Required": false, "Type": "RoleValues" }, "IdpMetadata": { "MarkdownDocumentation": "`IdpMetadata`\n\nA structure containing the identity provider (IdP) metadata used to integrate the\nidentity provider with this workspace.\n*Required*: Yes\n*Type*: [IdpMetadata](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-idpmetadata", "UpdateType": "Mutable", "Required": true, "Type": "IdpMetadata" }, "AssertionAttributes": { "MarkdownDocumentation": "`AssertionAttributes`\n\nA structure that defines which attributes in the SAML assertion are to be used to\ndefine information about the users authenticated by that IdP to use the\nworkspace.\n*Required*: No\n*Type*: [AssertionAttributes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-assertionattributes", "UpdateType": "Mutable", "Required": false, "Type": "AssertionAttributes" }, "AllowedOrganizations": { "MarkdownDocumentation": "`AllowedOrganizations`\n\nLists 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\nhave access.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-allowedorganizations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Grafana::Workspace.VpcConfiguration": { "MarkdownDocumentation": "`AWS::Grafana::Workspace.VpcConfiguration`\n\nThe configuration settings for an Amazon VPC that contains data sources for\nyour Grafana workspace to connect to.\n###### Note\nProvided `securityGroupIds` and `subnetIds` must be part of\nthe same VPC.\nConnecting to a private VPC is not yet available in the Asia Pacific (Seoul)\nRegion (ap-northeast-2).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html", "Properties": { "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe list of Amazon EC2 security group IDs attached to the Amazon VPC\nfor 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*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `255 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html#cfn-grafana-workspace-vpcconfiguration-securitygroupids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe list of Amazon EC2 subnet IDs created in the Amazon VPC for\nyour 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*: Array of String\n*Minimum*: `1 | 2`\n*Maximum*: `255 | 6`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html#cfn-grafana-workspace-vpcconfiguration-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Greengrass::ConnectorDefinition.Connector": { "MarkdownDocumentation": "`AWS::Greengrass::ConnectorDefinition.Connector`\n\nConnectors are\nmodules that provide built-in integration with local infrastructure, device protocols,\nAWS, and other cloud services. For more information, see [Integrate\nwith Services and Protocols Using Greengrass Connectors](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an\nCloudFormation template, the `Connectors` property of the [`ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html) property type contains a list of `Connector` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html", "Properties": { "ConnectorArn": { "Required": true, "MarkdownDocumentation": "`ConnectorArn`\n\nThe Amazon Resource Name (ARN) of the connector.\nFor more information about connectors provided by AWS, see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-connectorarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nThe parameters or configuration used by the connector.\nFor more information about connectors provided by AWS, see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-parameters", "PrimitiveType": "Json", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the connector. This value must be unique within the\nconnector definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-id", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ConnectorDefinition.ConnectorDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::ConnectorDefinition.ConnectorDefinitionVersion`\n\nA\nconnector definition version contains a list of connectors.\n###### Note\nAfter you create a connector definition version that contains the connectors you want\nto deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\nIn an CloudFormation template, `ConnectorDefinitionVersion` is the\nproperty type of the `InitialVersion` property in the [`AWS::Greengrass::ConnectorDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html", "Properties": { "Connectors": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Connectors`\n\nThe connectors in this version. Only one instance of a given connector can be added to a\nconnector definition version at a time.\n*Required*: Yes\n*Type*: Array of [Connector](./aws-properties-greengrass-connectordefinition-connector.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html#cfn-greengrass-connectordefinition-connectordefinitionversion-connectors", "ItemType": "Connector", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ConnectorDefinitionVersion.Connector": { "MarkdownDocumentation": "`AWS::Greengrass::ConnectorDefinitionVersion.Connector`\n\nConnectors are modules that provide built-in integration with local infrastructure, device\nprotocols, AWS, and other cloud services. For more information, see [Integrate\nwith Services and Protocols Using Greengrass Connectors](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an\nCloudFormation template, the `Connectors` property of the [`AWS::Greengrass::ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource contains a list of `Connector` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html", "Properties": { "ConnectorArn": { "Required": true, "MarkdownDocumentation": "`ConnectorArn`\n\nThe Amazon Resource Name (ARN) of the connector.\nFor more information about connectors provided by AWS, see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-connectorarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nThe parameters or configuration that the connector uses.\nFor more information about connectors provided by AWS, see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-parameters", "PrimitiveType": "Json", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the connector. This value must be unique within the\nconnector definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-id", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::CoreDefinition.Core": { "MarkdownDocumentation": "`AWS::Greengrass::CoreDefinition.Core`\n\nA core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local\nprocesses for a Greengrass group. For more information, see [What Is AWS IoT Greengrass?](https://docs.aws.amazon.com/greengrass/v1/developerguide/what-is-gg.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, the `Cores` property of the [`CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html) property type contains a list of `Core` property types. Currently, the\nlist can contain only one core.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html", "Properties": { "SyncShadow": { "Required": false, "MarkdownDocumentation": "`SyncShadow`\n\nIndicates whether the core's local shadow is synced with the cloud automatically. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-syncshadow", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "ThingArn": { "Required": true, "MarkdownDocumentation": "`ThingArn`\n\nThe ARN of the core, which is an AWS IoT device (thing).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-thingarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the core. This value must be unique within the core\ndefinition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CertificateArn": { "Required": true, "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) of the device certificate for the core. This X.509\ncertificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html#cfn-greengrass-coredefinition-core-certificatearn", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::CoreDefinition.CoreDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::CoreDefinition.CoreDefinitionVersion`\n\nA core\ndefinition version contains a Greengrass [core](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html).\n###### Note\nAfter you create a core definition version that contains the core you want to deploy,\nyou must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\nIn an\nCloudFormation template, `CoreDefinitionVersion` is the property type\nof the `InitialVersion` property in the [`AWS::Greengrass::CoreDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html", "Properties": { "Cores": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Cores`\n\nThe Greengrass core in this version. Currently, the `Cores` property for a\ncore definition version can contain only one core.\n*Required*: Yes\n*Type*: Array of [Core](./aws-properties-greengrass-coredefinition-core.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html#cfn-greengrass-coredefinition-coredefinitionversion-cores", "ItemType": "Core", "UpdateType": "Immutable" } } }, "AWS::Greengrass::CoreDefinitionVersion.Core": { "MarkdownDocumentation": "`AWS::Greengrass::CoreDefinitionVersion.Core`\n\nA core is an\nAWS IoT device that runs the AWS IoT Greengrass core software and manages\nlocal processes for a Greengrass group. For more information, see [What Is\nAWS IoT Greengrass?](https://docs.aws.amazon.com/greengrass/v1/developerguide/what-is-gg.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, the `Cores` property of the [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html) resource contains a list of `Core` property types. Currently, the list\ncan contain only one core.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html", "Properties": { "SyncShadow": { "Required": false, "MarkdownDocumentation": "`SyncShadow`\n\nIndicates whether the core's local shadow is synced with the cloud automatically. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-syncshadow", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "ThingArn": { "Required": true, "MarkdownDocumentation": "`ThingArn`\n\nThe Amazon Resource Name (ARN) of the core, which is an AWS IoT device\n(thing).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-thingarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the core. This value must be unique within the core\ndefinition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CertificateArn": { "Required": true, "MarkdownDocumentation": "`CertificateArn`\n\nThe ARN of the device certificate for the core. This X.509 certificate is used to\nauthenticate the core with AWS IoT and AWS IoT Greengrass services.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.html#cfn-greengrass-coredefinitionversion-core-certificatearn", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::DeviceDefinition.Device": { "MarkdownDocumentation": "`AWS::Greengrass::DeviceDefinition.Device`\n\nA device is an\nAWS IoT device (thing) that's added to a Greengrass group. Greengrass\ndevices can communicate with the Greengrass core in the same group. For more information,\nsee [What\nIs AWS IoT Greengrass?](https://docs.aws.amazon.com/greengrass/v1/developerguide/what-is-gg.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, the `Devices` property of the [`DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html) property type contains a list of `Device` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html", "Properties": { "SyncShadow": { "Required": false, "MarkdownDocumentation": "`SyncShadow`\n\nIndicates whether the device's local shadow is synced with the cloud\nautomatically.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-syncshadow", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "ThingArn": { "Required": true, "MarkdownDocumentation": "`ThingArn`\n\nThe ARN of the device, which is an AWS IoT device (thing).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-thingarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the device. This value must be unique within the\ndevice definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CertificateArn": { "Required": true, "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) of the device certificate for the device. This X.509\ncertificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-certificatearn", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::DeviceDefinition.DeviceDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::DeviceDefinition.DeviceDefinitionVersion`\n\nA\ndevice definition version contains a list of [devices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html).\n###### Note\nAfter you create a device definition version that contains the devices you want to\ndeploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\nIn\nan CloudFormation template, `DeviceDefinitionVersion` is the property type\nof the `InitialVersion` property in the [`AWS::Greengrass::DeviceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html", "Properties": { "Devices": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Devices`\n\nThe devices in this version.\n*Required*: Yes\n*Type*: Array of [Device](./aws-properties-greengrass-devicedefinition-device.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html#cfn-greengrass-devicedefinition-devicedefinitionversion-devices", "ItemType": "Device", "UpdateType": "Immutable" } } }, "AWS::Greengrass::DeviceDefinitionVersion.Device": { "MarkdownDocumentation": "`AWS::Greengrass::DeviceDefinitionVersion.Device`\n\nA device is\nan AWS IoT device (thing) that's added to a Greengrass group. Greengrass\ndevices can communicate with the Greengrass core in the same group. For more information,\nsee [What\nIs AWS IoT Greengrass?](https://docs.aws.amazon.com/greengrass/v1/developerguide/what-is-gg.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, the `Devices` property of the [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html) resource contains a list of `Device` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html", "Properties": { "SyncShadow": { "Required": false, "MarkdownDocumentation": "`SyncShadow`\n\nIndicates whether the device's local shadow is synced with the cloud\nautomatically.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-syncshadow", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "ThingArn": { "Required": true, "MarkdownDocumentation": "`ThingArn`\n\nThe Amazon Resource Name (ARN) of the device, which is an AWS IoT device\n(thing).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-thingarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the device. This value must be unique within the\ndevice definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CertificateArn": { "Required": true, "MarkdownDocumentation": "`CertificateArn`\n\nThe ARN of the device certificate for the device. This X.509 certificate is used to\nauthenticate the device with AWS IoT and AWS IoT Greengrass services.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-certificatearn", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinition.DefaultConfig": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition.DefaultConfig`\n\nThe default\nconfiguration that applies to all Lambda functions in the function definition\nversion. Individual Lambda functions can override these settings.\nIn an\nCloudFormation template, `DefaultConfig` is a property of the [`FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html", "Properties": { "Execution": { "Type": "Execution", "Required": true, "MarkdownDocumentation": "`Execution`\n\nConfiguration settings for the Lambda execution environment on the AWS IoT Greengrass core.\n*Required*: Yes\n*Type*: [Execution](./aws-properties-greengrass-functiondefinition-execution.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html#cfn-greengrass-functiondefinition-defaultconfig-execution", "UpdateType": "Mutable" } } }, "AWS::Greengrass::FunctionDefinition.Environment": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition.Environment`\n\nThe\nenvironment configuration for a Lambda function on the AWS IoT Greengrass\ncore.\nIn an CloudFormation template, `Environment` is a property of the [`FunctionConfiguration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html", "Properties": { "Variables": { "Required": false, "MarkdownDocumentation": "`Variables`\n\nEnvironment variables for the Lambda function.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-variables", "PrimitiveType": "Json", "UpdateType": "Immutable" }, "Execution": { "Type": "Execution", "Required": false, "MarkdownDocumentation": "`Execution`\n\nSettings for the Lambda execution environment in AWS IoT Greengrass.\n*Required*: No\n*Type*: [Execution](./aws-properties-greengrass-functiondefinition-execution.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-execution", "UpdateType": "Immutable" }, "ResourceAccessPolicies": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ResourceAccessPolicies`\n\nA list of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding\nread-only or read-write permissions. The maximum is 10 resources.\n###### Note\nThis property applies only for Lambda functions that run in a\nGreengrass container.\n*Required*: No\n*Type*: Array of [ResourceAccessPolicy](./aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-resourceaccesspolicies", "ItemType": "ResourceAccessPolicy", "UpdateType": "Immutable" }, "AccessSysfs": { "Required": false, "MarkdownDocumentation": "`AccessSysfs`\n\nIndicates whether the function is allowed to access the `/sys` directory on\nthe core device, which allows the read device information from `/sys`.\n###### Note\nThis property applies only to Lambda functions that run in a Greengrass\ncontainer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-accesssysfs", "PrimitiveType": "Boolean", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinition.Execution": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition.Execution`\n\nConfiguration\nsettings for the Lambda execution environment on the AWS IoT Greengrass\ncore.\nIn an CloudFormation template, `Execution` is a property of the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html) property type for a function definition version and the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html) property type for a function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html", "Properties": { "IsolationMode": { "Required": false, "MarkdownDocumentation": "`IsolationMode`\n\nThe containerization that the Lambda function runs in. Valid values are\n`GreengrassContainer` or `NoContainer`. Typically, this is\n`GreengrassContainer`. For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-function-containerization) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n* When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the\n default containerization for all Lambda functions in the function\n definition version.\n* When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and\n overrides the default. Omit this value to run the function with the default\n containerization.\n###### Note\nWe recommend that you run in a Greengrass container unless your business case\nrequires that you run without containerization.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html#cfn-greengrass-functiondefinition-execution-isolationmode", "PrimitiveType": "String", "UpdateType": "Immutable" }, "RunAs": { "Type": "RunAs", "Required": false, "MarkdownDocumentation": "`RunAs`\n\nThe user and group permissions used to run the Lambda function. Typically,\nthis is the ggc\\_user and ggc\\_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n* When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the\n default access identity for all Lambda functions in the function\n definition version.\n* When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and\n overrides the default. You can override the user, group, or both. Omit this value to\n run the function with the default permissions.\n###### Important\nRunning as the root user increases risks to your data and device. Do not run as root\n(UID/GID=0) unless your business case requires it. For more information and\nrequirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root).\n*Required*: No\n*Type*: [RunAs](./aws-properties-greengrass-functiondefinition-runas.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html#cfn-greengrass-functiondefinition-execution-runas", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinition.Function": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition.Function`\n\nA function is a\nLambda function that's referenced from an AWS IoT Greengrass group. The\nfunction is deployed to a Greengrass core where it runs locally. For more information, see\n[Run Lambda Functions on the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-functions.html) in the\n*AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, the `Functions` property of the [`FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html) property type contains a list of `Function` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html", "Properties": { "FunctionArn": { "Required": true, "MarkdownDocumentation": "`FunctionArn`\n\nThe Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced\nLambda 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FunctionConfiguration": { "Type": "FunctionConfiguration", "Required": true, "MarkdownDocumentation": "`FunctionConfiguration`\n\nThe group-specific settings of the Lambda function. These settings\nconfigure the function's behavior in the Greengrass group.\n*Required*: Yes\n*Type*: [FunctionConfiguration](./aws-properties-greengrass-functiondefinition-functionconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionconfiguration", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the function. This value must be unique within the\nfunction definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-id", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinition.FunctionConfiguration": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition.FunctionConfiguration`\n\nThe\ngroup-specific configuration settings for a Lambda function. These settings\nconfigure the function's behavior in the Greengrass group. For more information, see [Controlling Execution of Greengrass Lambda Functions by Using\nGroup-Specific Configuration](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn\nan CloudFormation template, `FunctionConfiguration` is a property of the\n[`Function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html", "Properties": { "MemorySize": { "Required": false, "MarkdownDocumentation": "`MemorySize`\n\nThe memory size (in KB) required by the function.\n###### Note\nThis property applies only to Lambda functions that run in a Greengrass\ncontainer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-memorysize", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "Pinned": { "Required": false, "MarkdownDocumentation": "`Pinned`\n\nIndicates whether the function is pinned (or *long-lived*). Pinned\nfunctions start when the core starts and process all requests in the same container. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-pinned", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ExecArgs": { "Required": false, "MarkdownDocumentation": "`ExecArgs`\n\nThe execution arguments.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-execargs", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Timeout": { "Required": false, "MarkdownDocumentation": "`Timeout`\n\nThe allowed execution time (in seconds) after which the function should terminate. For\npinned functions, this timeout applies for each 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-timeout", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "EncodingType": { "Required": false, "MarkdownDocumentation": "`EncodingType`\n\nThe expected encoding type of the input payload for the function. Valid values are\n`json` (default) and `binary`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-encodingtype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Environment": { "Type": "Environment", "Required": false, "MarkdownDocumentation": "`Environment`\n\nThe environment configuration of the function.\n*Required*: No\n*Type*: [Environment](./aws-properties-greengrass-functiondefinition-environment.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-environment", "UpdateType": "Immutable" }, "Executable": { "Required": false, "MarkdownDocumentation": "`Executable`\n\nThe name of the function executable.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-executable", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinition.FunctionDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition.FunctionDefinitionVersion`\n\nA function definition version contains a list of functions.\n###### Note\nAfter you create a function definition version that contains the functions you want\nto deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\nIn an CloudFormation template, `FunctionDefinitionVersion` is the property\ntype of the `InitialVersion` property in the [`AWS::Greengrass::FunctionDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html", "Properties": { "DefaultConfig": { "Type": "DefaultConfig", "Required": false, "MarkdownDocumentation": "`DefaultConfig`\n\nThe default configuration that applies to all Lambda functions in the\ngroup. Individual Lambda functions can override these settings.\n*Required*: No\n*Type*: [DefaultConfig](./aws-properties-greengrass-functiondefinition-defaultconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html#cfn-greengrass-functiondefinition-functiondefinitionversion-defaultconfig", "UpdateType": "Immutable" }, "Functions": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Functions`\n\nThe functions in this version.\n*Required*: Yes\n*Type*: Array of [Function](./aws-properties-greengrass-functiondefinition-function.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html#cfn-greengrass-functiondefinition-functiondefinitionversion-functions", "ItemType": "Function", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinition.ResourceAccessPolicy": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition.ResourceAccessPolicy`\n\nA\nlist of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding\nread-only or read-write permissions. The maximum is 10 resources.\n###### Note\nThis property applies only to Lambda functions that run in a Greengrass\ncontainer.\nIn\nan CloudFormation template, `ResourceAccessPolicy` is a property of the\n[`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html", "Properties": { "ResourceId": { "Required": true, "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the resource. This ID is assigned to the resource when you create the resource\ndefinition.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html#cfn-greengrass-functiondefinition-resourceaccesspolicy-resourceid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Permission": { "Required": false, "MarkdownDocumentation": "`Permission`\n\nThe read-only or read-write access that the Lambda function has to the\nresource. Valid values are `ro` or `rw`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html#cfn-greengrass-functiondefinition-resourceaccesspolicy-permission", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinition.RunAs": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition.RunAs`\n\nThe access identity\nwhose permissions are used to run the Lambda function. This setting overrides\nthe default access identity that's specified for the group (by default, ggc\\_user and\nggc\\_group). You can override the user, group, or both. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n###### Important\nRunning as the root user increases risks to your data and device. Do not run as root\n(UID/GID=0) unless your business case requires it. For more information and\nrequirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root).\nIn an CloudFormation template, `RunAs` is a property of the [`Execution`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html", "Properties": { "Uid": { "Required": false, "MarkdownDocumentation": "`Uid`\n\nThe user ID whose permissions are used to run the Lambda function. You can\nuse the **getent passwd** command on your core device to look up the user\nID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html#cfn-greengrass-functiondefinition-runas-uid", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "Gid": { "Required": false, "MarkdownDocumentation": "`Gid`\n\nThe group ID whose permissions are used to run the Lambda function. You\ncan use the **getent group** command on your core device to look up the\ngroup ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html#cfn-greengrass-functiondefinition-runas-gid", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinitionVersion.DefaultConfig": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinitionVersion.DefaultConfig`\n\nThe\ndefault configuration that applies to all Lambda functions in the function\ndefinition version. Individual Lambda functions can override these\nsettings.\nIn\nan CloudFormation template, `DefaultConfig` is a property of the [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html", "Properties": { "Execution": { "Type": "Execution", "Required": true, "MarkdownDocumentation": "`Execution`\n\nConfiguration settings for the Lambda execution environment on the AWS IoT Greengrass core.\n*Required*: Yes\n*Type*: [Execution](./aws-properties-greengrass-functiondefinitionversion-execution.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html#cfn-greengrass-functiondefinitionversion-defaultconfig-execution", "UpdateType": "Mutable" } } }, "AWS::Greengrass::FunctionDefinitionVersion.Environment": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinitionVersion.Environment`\n\nThe\nenvironment configuration for a Lambda function on the AWS IoT Greengrass\ncore.\nIn an\nCloudFormation template, `Environment` is a property of the [`FunctionConfiguration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html", "Properties": { "Variables": { "Required": false, "MarkdownDocumentation": "`Variables`\n\nEnvironment variables for the Lambda function.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-variables", "PrimitiveType": "Json", "UpdateType": "Immutable" }, "Execution": { "Type": "Execution", "Required": false, "MarkdownDocumentation": "`Execution`\n\nSettings for the Lambda execution environment in AWS IoT Greengrass.\n*Required*: No\n*Type*: [Execution](./aws-properties-greengrass-functiondefinitionversion-execution.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-execution", "UpdateType": "Immutable" }, "ResourceAccessPolicies": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ResourceAccessPolicies`\n\nA list of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding\nread-only or read-write permissions. The maximum is 10 resources.\n###### Note\nThis property applies only to Lambda functions that run in a Greengrass\ncontainer.\n*Required*: No\n*Type*: Array of [ResourceAccessPolicy](./aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-resourceaccesspolicies", "ItemType": "ResourceAccessPolicy", "UpdateType": "Immutable" }, "AccessSysfs": { "Required": false, "MarkdownDocumentation": "`AccessSysfs`\n\nIndicates whether the function is allowed to access the `/sys` directory on\nthe core device, which allows the read device information from `/sys`.\n###### Note\nThis property applies only to Lambda functions that run in a Greengrass\ncontainer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-accesssysfs", "PrimitiveType": "Boolean", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinitionVersion.Execution": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinitionVersion.Execution`\n\nConfiguration settings for the Lambda execution environment on the AWS IoT Greengrass core.\nIn an\nCloudFormation template, `Execution` is a property of the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property type for a function definition version and the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property type for a function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html", "Properties": { "IsolationMode": { "Required": false, "MarkdownDocumentation": "`IsolationMode`\n\nThe containerization that the Lambda function runs in. Valid values are\n`GreengrassContainer` or `NoContainer`. Typically, this is\n`GreengrassContainer`. For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-function-containerization) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n* When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the\n default containerization for all Lambda functions in the function\n definition version.\n* When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and\n overrides the default. Omit this value to run the function with the default\n containerization.\n###### Note\nWe recommend that you run in a Greengrass container unless your business case\nrequires that you run without containerization.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html#cfn-greengrass-functiondefinitionversion-execution-isolationmode", "PrimitiveType": "String", "UpdateType": "Immutable" }, "RunAs": { "Type": "RunAs", "Required": false, "MarkdownDocumentation": "`RunAs`\n\nThe user and group permissions used to run the Lambda function. Typically,\nthis is the ggc\\_user and ggc\\_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n* When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the\n default access identity for all Lambda functions in the function\n definition version.\n* When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and\n overrides the default. You can override the user, group, or both. Omit this value to\n run the function with the default permissions.\n###### Important\nRunning as the root user increases risks to your data and device. Do not run as root\n(UID/GID=0) unless your business case requires it. For more information and\nrequirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root).\n*Required*: No\n*Type*: [RunAs](./aws-properties-greengrass-functiondefinitionversion-runas.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html#cfn-greengrass-functiondefinitionversion-execution-runas", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinitionVersion.Function": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinitionVersion.Function`\n\nA function\nis a Lambda function that's referenced from an AWS IoT Greengrass group. The\nfunction is deployed to a Greengrass core where it runs locally. For more information, see\n[Run Lambda Functions on the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-functions.html) in the\n*AWS IoT Greengrass Version 1 Developer Guide*.\nIn an\nCloudFormation template, the `Functions` property of the [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource contains a list of `Function` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html", "Properties": { "FunctionArn": { "Required": true, "MarkdownDocumentation": "`FunctionArn`\n\nThe Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced\nLambda 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-functionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FunctionConfiguration": { "Type": "FunctionConfiguration", "Required": true, "MarkdownDocumentation": "`FunctionConfiguration`\n\nThe group-specific settings of the Lambda function. These settings\nconfigure the function's behavior in the Greengrass group.\n*Required*: Yes\n*Type*: [FunctionConfiguration](./aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-functionconfiguration", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the function. This value must be unique within the\nfunction definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-id", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinitionVersion.FunctionConfiguration": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinitionVersion.FunctionConfiguration`\n\nThe group-specific configuration settings for a Lambda function. These\nsettings configure the function's behavior in the Greengrass group. For more information,\nsee [Controlling Execution of\nGreengrass Lambda Functions by Using Group-Specific Configuration](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html)\nin the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `FunctionConfiguration` is a property of\nthe [`Function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-function.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html", "Properties": { "MemorySize": { "Required": false, "MarkdownDocumentation": "`MemorySize`\n\nThe memory size (in KB) required by the function.\n###### Note\nThis property applies only to Lambda functions that run in a Greengrass\ncontainer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-memorysize", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "Pinned": { "Required": false, "MarkdownDocumentation": "`Pinned`\n\nIndicates whether the function is pinned (or *long-lived*). Pinned\nfunctions start when the core starts and process all requests in the same container. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-pinned", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ExecArgs": { "Required": false, "MarkdownDocumentation": "`ExecArgs`\n\nThe execution arguments.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-execargs", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Timeout": { "Required": false, "MarkdownDocumentation": "`Timeout`\n\nThe allowed execution time (in seconds) after which the function should terminate. For\npinned functions, this timeout applies for each 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-timeout", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "EncodingType": { "Required": false, "MarkdownDocumentation": "`EncodingType`\n\nThe expected encoding type of the input payload for the function. Valid values are\n`json` (default) and `binary`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-encodingtype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Environment": { "Type": "Environment", "Required": false, "MarkdownDocumentation": "`Environment`\n\nThe environment configuration of the function.\n*Required*: No\n*Type*: [Environment](./aws-properties-greengrass-functiondefinitionversion-environment.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-environment", "UpdateType": "Immutable" }, "Executable": { "Required": false, "MarkdownDocumentation": "`Executable`\n\nThe name of the function executable.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-executable", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinitionVersion.ResourceAccessPolicy": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinitionVersion.ResourceAccessPolicy`\n\nA\nlist of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding\nread-only or read-write permissions. The maximum is 10 resources.\n###### Note\nThis property applies only to Lambda functions that run in a Greengrass\ncontainer.\nIn an CloudFormation template, `ResourceAccessPolicy` is a property of the\n[`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html", "Properties": { "ResourceId": { "Required": true, "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the resource. This ID is assigned to the resource when you create the resource\ndefinition.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html#cfn-greengrass-functiondefinitionversion-resourceaccesspolicy-resourceid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Permission": { "Required": false, "MarkdownDocumentation": "`Permission`\n\nThe read-only or read-write access that the Lambda function has to the\nresource. Valid values are `ro` or `rw`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-resourceaccesspolicy.html#cfn-greengrass-functiondefinitionversion-resourceaccesspolicy-permission", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinitionVersion.RunAs": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinitionVersion.RunAs`\n\nThe user and\ngroup permissions used to run the Lambda function. This setting overrides the\ndefault access identity that's specified for the group (by default, ggc\\_user and\nggc\\_group). You can override the user, group, or both. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n###### Important\nRunning as the root user increases risks to your data and device. Do not run as root\n(UID/GID=0) unless your business case requires it. For more information and\nrequirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root).\nIn an\nCloudFormation template, `RunAs` is a property of the [`Execution`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-execution.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html", "Properties": { "Uid": { "Required": false, "MarkdownDocumentation": "`Uid`\n\nThe user ID whose permissions are used to run the Lambda function. You can\nuse the **getent passwd** command on your core device to look up the user\nID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html#cfn-greengrass-functiondefinitionversion-runas-uid", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "Gid": { "Required": false, "MarkdownDocumentation": "`Gid`\n\nThe group ID whose permissions are used to run the Lambda function. You\ncan use the **getent group** command on your core device to look up the\ngroup ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-runas.html#cfn-greengrass-functiondefinitionversion-runas-gid", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::Greengrass::Group.GroupVersion": { "MarkdownDocumentation": "`AWS::Greengrass::Group.GroupVersion`\n\nA group version in AWS IoT Greengrass, which references of a core definition version, device definition version,\nsubscription definition version, and other version types that contain the components you\nwant to deploy to a Greengrass core device. The group version must reference a core\ndefinition version that contains one core. Other version types are optionally included,\ndepending on your business need.\nIn an CloudFormation template, `GroupVersion` is the property type of the\n`InitialVersion` property in the [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html", "Properties": { "LoggerDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`LoggerDefinitionVersionArn`\n\nThe ARN of the logger definition version that contains the loggers you want to deploy\nwith the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-loggerdefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DeviceDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`DeviceDefinitionVersionArn`\n\nThe ARN of the device definition version that contains the devices you want to deploy\nwith the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-devicedefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FunctionDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`FunctionDefinitionVersionArn`\n\nThe ARN of the function definition version that contains the functions you want to\ndeploy with the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-functiondefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CoreDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`CoreDefinitionVersionArn`\n\nThe ARN of the core definition version that contains the core you want to deploy with\nthe group version. Currently, the core definition version can contain only one 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-coredefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ResourceDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`ResourceDefinitionVersionArn`\n\nThe ARN of the resource definition version that contains the resources you want to\ndeploy with the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-resourcedefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ConnectorDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`ConnectorDefinitionVersionArn`\n\nThe Amazon Resource Name (ARN) of the connector definition version that contains the\nconnectors you want to deploy with the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-connectordefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SubscriptionDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`SubscriptionDefinitionVersionArn`\n\nThe ARN of the subscription definition version that contains the subscriptions you want\nto deploy with the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-subscriptiondefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::LoggerDefinition.Logger": { "MarkdownDocumentation": "`AWS::Greengrass::LoggerDefinition.Logger`\n\nA logger represents\nlogging settings for the AWS IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device. All log entries include a\ntimestamp, log level, and information about the event. For more information, see [Monitoring with\nAWS IoT Greengrass Logs](https://docs.aws.amazon.com/greengrass/v1/developerguide/greengrass-logs-overview.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, the `Loggers` property of the [`LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html) property type contains a list of `Logger` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html", "Properties": { "Space": { "Required": false, "MarkdownDocumentation": "`Space`\n\nThe amount of file space (in KB) to use when writing logs to the local file system. This\nproperty does not apply for CloudWatch Logs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-space", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe storage mechanism for log events. Valid values are `FileSystem` or\n`AWSCloudWatch`. When `AWSCloudWatch` is used, log events are sent\nto CloudWatch Logs. When `FileSystem` is used, log events are stored on the\nlocal file system.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-type", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Level": { "Required": true, "MarkdownDocumentation": "`Level`\n\nThe log-level threshold. Log events below this threshold are filtered out and aren't\nstored. Valid values are `DEBUG`, `INFO` (recommended),\n`WARN`, `ERROR`, or `FATAL`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-level", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the logger. This value must be unique within the\nlogger definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Component": { "Required": true, "MarkdownDocumentation": "`Component`\n\nThe source of the log event. Valid values are `GreengrassSystem` or\n`Lambda`. When `GreengrassSystem` is used, events from Greengrass\nsystem components are logged. When `Lambda` is used, events from user-defined\nLambda functions are logged.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-component", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::LoggerDefinition.LoggerDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::LoggerDefinition.LoggerDefinitionVersion`\n\nA\nlogger definition version contains a list of [loggers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html).\n###### Note\nAfter you create a logger definition version that contains the loggers you want to\ndeploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\nIn\nan CloudFormation template, `LoggerDefinitionVersion` is the property type\nof the `InitialVersion` property in the [`AWS::Greengrass::LoggerDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html", "Properties": { "Loggers": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Loggers`\n\nThe loggers in this version.\n*Required*: Yes\n*Type*: Array of [Logger](./aws-properties-greengrass-loggerdefinition-logger.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html#cfn-greengrass-loggerdefinition-loggerdefinitionversion-loggers", "ItemType": "Logger", "UpdateType": "Immutable" } } }, "AWS::Greengrass::LoggerDefinitionVersion.Logger": { "MarkdownDocumentation": "`AWS::Greengrass::LoggerDefinitionVersion.Logger`\n\nA logger\nrepresents logging settings for the AWS IoT Greengrass group, which can be stored in\nCloudWatch and the local file system of your core device. All log entries\ninclude a timestamp, log level, and information about the event. For more information, see\n[Monitoring with\nAWS IoT Greengrass Logs](https://docs.aws.amazon.com/greengrass/v1/developerguide/greengrass-logs-overview.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, the `Loggers` property of the [`AWS::Greengrass::LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html) resource contains a list of `Logger` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html", "Properties": { "Space": { "Required": false, "MarkdownDocumentation": "`Space`\n\nThe amount of file space (in KB) to use when writing logs to the local file system. This\nproperty does not apply for CloudWatch Logs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-space", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe storage mechanism for log events. Valid values are `FileSystem` or\n`AWSCloudWatch`. When `AWSCloudWatch` is used, log events are sent\nto CloudWatch Logs. When `FileSystem` is used, log events are stored on the\nlocal file system.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-type", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Level": { "Required": true, "MarkdownDocumentation": "`Level`\n\nThe log-level threshold. Log events below this threshold are filtered out and aren't\nstored. Valid values are `DEBUG`, `INFO` (recommended),\n`WARN`, `ERROR`, or `FATAL`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-level", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the logger. This value must be unique within the\nlogger definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Component": { "Required": true, "MarkdownDocumentation": "`Component`\n\nThe source of the log event. Valid values are `GreengrassSystem` or\n`Lambda`. When `GreengrassSystem` is used, events from Greengrass\nsystem components are logged. When `Lambda` is used, events from user-defined\nLambda functions are logged.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinitionversion-logger.html#cfn-greengrass-loggerdefinitionversion-logger-component", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.GroupOwnerSetting": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.GroupOwnerSetting`\n\nSettings\nthat define additional Linux OS group permissions to give to the Lambda\nfunction process. You can give the permissions of the Linux group that owns the resource or\nchoose another Linux group. These permissions are in addition to the function's\n`RunAs` permissions.\nIn an\nCloudFormation template, `GroupOwnerSetting` is a property of the\n[`LocalDeviceResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html) and [`LocalVolumeResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html) property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html", "Properties": { "AutoAddGroupOwner": { "Required": true, "MarkdownDocumentation": "`AutoAddGroupOwner`\n\nIndicates whether to give the privileges of the Linux group that owns the resource to\nthe Lambda process. This gives the Lambda process the file\naccess permissions of the Linux group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html#cfn-greengrass-resourcedefinition-groupownersetting-autoaddgroupowner", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "GroupOwner": { "Required": false, "MarkdownDocumentation": "`GroupOwner`\n\nThe name of the Linux group whose privileges you want to add to the Lambda\nprocess. This value is ignored if `AutoAddGroupOwner` is true.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-groupownersetting.html#cfn-greengrass-resourcedefinition-groupownersetting-groupowner", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.LocalDeviceResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.LocalDeviceResourceData`\n\nSettings for a local device resource, which represents a file under `/dev`. For\nmore information, see [Access Local\nResources with Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-local-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `LocalDeviceResourceData` can be used in\nthe [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html", "Properties": { "SourcePath": { "Required": true, "MarkdownDocumentation": "`SourcePath`\n\nThe local absolute path of the device resource. The source path for a device resource\ncan refer only to a character device or block device under `/dev`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html#cfn-greengrass-resourcedefinition-localdeviceresourcedata-sourcepath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GroupOwnerSetting": { "Type": "GroupOwnerSetting", "Required": false, "MarkdownDocumentation": "`GroupOwnerSetting`\n\nSettings that define additional Linux OS group permissions to give to the Lambda function process.\n*Required*: No\n*Type*: [GroupOwnerSetting](./aws-properties-greengrass-resourcedefinition-groupownersetting.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html#cfn-greengrass-resourcedefinition-localdeviceresourcedata-groupownersetting", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.LocalVolumeResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.LocalVolumeResourceData`\n\nSettings for a local volume resource, which represents a file or directory on the root\nfile system. For more information, see [Access Local\nResources with Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-local-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `LocalVolumeResourceData` can be used in\nthe [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html", "Properties": { "SourcePath": { "Required": true, "MarkdownDocumentation": "`SourcePath`\n\nThe local absolute path of the volume resource on the host. The source path for a volume\nresource type cannot start with `/sys`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-sourcepath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DestinationPath": { "Required": true, "MarkdownDocumentation": "`DestinationPath`\n\nThe absolute local path of the resource in the Lambda 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-destinationpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GroupOwnerSetting": { "Type": "GroupOwnerSetting", "Required": false, "MarkdownDocumentation": "`GroupOwnerSetting`\n\nSettings that define additional Linux OS group permissions to give to the Lambda function process.\n*Required*: No\n*Type*: [GroupOwnerSetting](./aws-properties-greengrass-resourcedefinition-groupownersetting.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html#cfn-greengrass-resourcedefinition-localvolumeresourcedata-groupownersetting", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.ResourceDataContainer": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.ResourceDataContainer`\n\nA\ncontainer for resource data, which defines the resource type. The container takes only one\nof the following supported resource data types: `LocalDeviceResourceData`,\n`LocalVolumeResourceData`,\n`SageMakerMachineLearningModelResourceData`,\n`S3MachineLearningModelResourceData`, or\n`SecretsManagerSecretResourceData`.\n###### Note\nOnly one resource type can be defined for a `ResourceDataContainer`\ninstance.\nIn\nan CloudFormation template, `ResourceDataContainer` is a property of the\n[`ResourceInstance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html", "Properties": { "SecretsManagerSecretResourceData": { "Type": "SecretsManagerSecretResourceData", "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretResourceData`\n\nSettings for a secret resource.\n*Required*: No\n*Type*: [SecretsManagerSecretResourceData](./aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-secretsmanagersecretresourcedata", "UpdateType": "Immutable" }, "SageMakerMachineLearningModelResourceData": { "Type": "SageMakerMachineLearningModelResourceData", "Required": false, "MarkdownDocumentation": "`SageMakerMachineLearningModelResourceData`\n\nSettings for a machine learning resource saved as an SageMaker AI training\njob.\n*Required*: No\n*Type*: [SageMakerMachineLearningModelResourceData](./aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-sagemakermachinelearningmodelresourcedata", "UpdateType": "Immutable" }, "LocalVolumeResourceData": { "Type": "LocalVolumeResourceData", "Required": false, "MarkdownDocumentation": "`LocalVolumeResourceData`\n\nSettings for a local volume resource.\n*Required*: No\n*Type*: [LocalVolumeResourceData](./aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-localvolumeresourcedata", "UpdateType": "Immutable" }, "LocalDeviceResourceData": { "Type": "LocalDeviceResourceData", "Required": false, "MarkdownDocumentation": "`LocalDeviceResourceData`\n\nSettings for a local device resource.\n*Required*: No\n*Type*: [LocalDeviceResourceData](./aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-localdeviceresourcedata", "UpdateType": "Immutable" }, "S3MachineLearningModelResourceData": { "Type": "S3MachineLearningModelResourceData", "Required": false, "MarkdownDocumentation": "`S3MachineLearningModelResourceData`\n\nSettings for a machine learning resource stored in Amazon S3.\n*Required*: No\n*Type*: [S3MachineLearningModelResourceData](./aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html#cfn-greengrass-resourcedefinition-resourcedatacontainer-s3machinelearningmodelresourcedata", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.ResourceDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.ResourceDefinitionVersion`\n\nA resource definition version contains a list of resources. (In CloudFormation,\nresources are named *resource instances*.)\n###### Note\nAfter you create a resource definition version that contains the resources you want\nto deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\nIn an CloudFormation template, `ResourceDefinitionVersion` is the property\ntype of the `InitialVersion` property in the [`AWS::Greengrass::ResourceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedefinitionversion.html", "Properties": { "Resources": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Resources`\n\nThe resources in this version.\n*Required*: Yes\n*Type*: Array of [ResourceInstance](./aws-properties-greengrass-resourcedefinition-resourceinstance.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedefinitionversion.html#cfn-greengrass-resourcedefinition-resourcedefinitionversion-resources", "ItemType": "ResourceInstance", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting`\n\nThe owner setting for a downloaded machine learning resource. For more information, see\n[Access Machine Learning\nResources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `ResourceDownloadOwnerSetting` is the\nproperty type of the `OwnerSetting` property for the [`S3MachineLearningModelResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html) and [`SageMakerMachineLearningModelResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html) property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html", "Properties": { "GroupOwner": { "Required": true, "MarkdownDocumentation": "`GroupOwner`\n\nThe group owner of the machine learning resource. This is the group ID (GID) of an\nexisting Linux OS group on the system. The group's permissions are added to the Lambda process.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinition-resourcedownloadownersetting-groupowner", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GroupPermission": { "Required": true, "MarkdownDocumentation": "`GroupPermission`\n\nThe permissions that the group owner has to the machine learning resource. Valid values\nare `rw` (read-write) or `ro` (read-only).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinition-resourcedownloadownersetting-grouppermission", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.ResourceInstance": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.ResourceInstance`\n\nA local\nresource, machine learning resource, or secret resource. For more information, see [Access Local Resources with Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-local-resources.html), [Perform Machine Learning\nInference](https://docs.aws.amazon.com/greengrass/v1/developerguide/ml-inference.html), and [Deploy Secrets to the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/v1/developerguide/secrets.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an\nCloudFormation template, the `Resources` property of the [`AWS::Greengrass::ResourceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html) resource contains a list of `ResourceInstance` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html", "Properties": { "ResourceDataContainer": { "Type": "ResourceDataContainer", "Required": true, "MarkdownDocumentation": "`ResourceDataContainer`\n\nA container for resource data. The container takes only one of the following supported\nresource data types: `LocalDeviceResourceData`,\n`LocalVolumeResourceData`,\n`SageMakerMachineLearningModelResourceData`,\n`S3MachineLearningModelResourceData`, or\n`SecretsManagerSecretResourceData`.\n###### Note\nOnly one resource type can be defined for a `ResourceDataContainer`\ninstance.\n*Required*: Yes\n*Type*: [ResourceDataContainer](./aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-resourcedatacontainer", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the resource. This value must be unique within the\nresource definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe descriptive resource name, which is displayed on the AWS IoT Greengrass console.\nMaximum length 128 characters with pattern [a-zA-Z0-9:\\_-]+. This must be unique within a\nGreengrass 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.S3MachineLearningModelResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.S3MachineLearningModelResourceData`\n\nSettings for an Amazon S3 machine learning resource. For more information, see\n[Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/v1/developerguide/ml-inference.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `S3MachineLearningModelResourceData` can\nbe used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html", "Properties": { "OwnerSetting": { "Type": "ResourceDownloadOwnerSetting", "Required": false, "MarkdownDocumentation": "`OwnerSetting`\n\nThe owner setting for the downloaded machine learning resource. For more information,\nsee [Access Machine Learning\nResources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n*Required*: No\n*Type*: [ResourceDownloadOwnerSetting](./aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-ownersetting", "UpdateType": "Immutable" }, "DestinationPath": { "Required": true, "MarkdownDocumentation": "`DestinationPath`\n\nThe absolute local path of the resource inside the Lambda\nenvironment.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-destinationpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "S3Uri": { "Required": true, "MarkdownDocumentation": "`S3Uri`\n\nThe URI of the source model in an Amazon S3 bucket. The model package must be\nin `tar.gz` or `.zip` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-s3machinelearningmodelresourcedata-s3uri", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.SageMakerMachineLearningModelResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.SageMakerMachineLearningModelResourceData`\n\nSettings for an Secrets Manager machine learning resource. For more information, see\n[Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/v1/developerguide/ml-inference.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template,\n`SageMakerMachineLearningModelResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html", "Properties": { "OwnerSetting": { "Type": "ResourceDownloadOwnerSetting", "Required": false, "MarkdownDocumentation": "`OwnerSetting`\n\nThe owner setting for the downloaded machine learning resource. For more information,\nsee [Access Machine Learning\nResources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n*Required*: No\n*Type*: [ResourceDownloadOwnerSetting](./aws-properties-greengrass-resourcedefinition-resourcedownloadownersetting.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-ownersetting", "UpdateType": "Immutable" }, "DestinationPath": { "Required": true, "MarkdownDocumentation": "`DestinationPath`\n\nThe absolute local path of the resource inside the Lambda\nenvironment.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-destinationpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SageMakerJobArn": { "Required": true, "MarkdownDocumentation": "`SageMakerJobArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SageMaker AI training job that\nrepresents the source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata-sagemakerjobarn", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition.SecretsManagerSecretResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition.SecretsManagerSecretResourceData`\n\nSettings for a secret resource, which references a secret from AWS Secrets Manager.\nAWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core,\nwhere it can be securely accessed by connectors and Lambda functions. For\nmore information, see [Deploy Secrets to the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/v1/developerguide/secrets.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `SecretsManagerSecretResourceData` can be\nused in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html", "Properties": { "ARN": { "Required": true, "MarkdownDocumentation": "`ARN`\n\nThe Amazon Resource Name (ARN) of the Secrets Manager secret to make available\non the core. The value of the secret's latest version (represented by the\n`AWSCURRENT` staging label) is included 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinition-secretsmanagersecretresourcedata-arn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AdditionalStagingLabelsToDownload": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AdditionalStagingLabelsToDownload`\n\nThe staging labels whose values you want to make available on the core, in addition to\n`AWSCURRENT`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinition-secretsmanagersecretresourcedata-additionalstaginglabelstodownload", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.GroupOwnerSetting": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.GroupOwnerSetting`\n\nSettings that define additional Linux OS group permissions to give to the Lambda function process. You can give the permissions of the Linux group that owns\nthe resource or choose another Linux group. These permissions are in addition to the\nfunction's `RunAs` permissions.\nIn an CloudFormation template, `GroupOwnerSetting` is a property of the\n[`LocalDeviceResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html) and [`LocalVolumeResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html) property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html", "Properties": { "AutoAddGroupOwner": { "Required": true, "MarkdownDocumentation": "`AutoAddGroupOwner`\n\nIndicates whether to give the privileges of the Linux group that owns the resource to\nthe Lambda process. This gives the Lambda process the file\naccess permissions of the Linux group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html#cfn-greengrass-resourcedefinitionversion-groupownersetting-autoaddgroupowner", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "GroupOwner": { "Required": false, "MarkdownDocumentation": "`GroupOwner`\n\nThe name of the Linux group whose privileges you want to add to the Lambda\nprocess. This value is ignored if `AutoAddGroupOwner` is true.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html#cfn-greengrass-resourcedefinitionversion-groupownersetting-groupowner", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.LocalDeviceResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.LocalDeviceResourceData`\n\nSettings for a local device resource, which represents a file under `/dev`. For\nmore information, see [Access Local\nResources with Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-local-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `LocalDeviceResourceData` can be used in\nthe [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html", "Properties": { "SourcePath": { "Required": true, "MarkdownDocumentation": "`SourcePath`\n\nThe local absolute path of the device resource. The source path for a device resource\ncan refer only to a character device or block device under `/dev`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html#cfn-greengrass-resourcedefinitionversion-localdeviceresourcedata-sourcepath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GroupOwnerSetting": { "Type": "GroupOwnerSetting", "Required": false, "MarkdownDocumentation": "`GroupOwnerSetting`\n\nSettings that define additional Linux OS group permissions to give to the Lambda function process.\n*Required*: No\n*Type*: [GroupOwnerSetting](./aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html#cfn-greengrass-resourcedefinitionversion-localdeviceresourcedata-groupownersetting", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.LocalVolumeResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.LocalVolumeResourceData`\n\nSettings for a local volume resource, which represents a file or directory on the root\nfile system. For more information, see [Access Local\nResources with Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-local-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `LocalVolumeResourceData` can be used in\nthe [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html", "Properties": { "SourcePath": { "Required": true, "MarkdownDocumentation": "`SourcePath`\n\nThe local absolute path of the volume resource on the host. The source path for a volume\nresource type cannot start with `/sys`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-sourcepath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DestinationPath": { "Required": true, "MarkdownDocumentation": "`DestinationPath`\n\nThe absolute local path of the resource in the Lambda 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-destinationpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GroupOwnerSetting": { "Type": "GroupOwnerSetting", "Required": false, "MarkdownDocumentation": "`GroupOwnerSetting`\n\nSettings that define additional Linux OS group permissions to give to the Lambda function process.\n*Required*: No\n*Type*: [GroupOwnerSetting](./aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-groupownersetting", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.ResourceDataContainer": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.ResourceDataContainer`\n\nA container for resource data, which defines the resource type. The container takes only\none of the following supported resource data types: `LocalDeviceResourceData`,\n`LocalVolumeResourceData`,\n`SageMakerMachineLearningModelResourceData`,\n`S3MachineLearningModelResourceData`, or\n`SecretsManagerSecretResourceData`.\n###### Note\nOnly one resource type can be defined for a `ResourceDataContainer`\ninstance.\nIn an CloudFormation template, `ResourceDataContainer` is a property of\nthe [`ResourceInstance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html", "Properties": { "SecretsManagerSecretResourceData": { "Type": "SecretsManagerSecretResourceData", "Required": false, "MarkdownDocumentation": "`SecretsManagerSecretResourceData`\n\nSettings for a secret resource.\n*Required*: No\n*Type*: [SecretsManagerSecretResourceData](./aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-secretsmanagersecretresourcedata", "UpdateType": "Immutable" }, "SageMakerMachineLearningModelResourceData": { "Type": "SageMakerMachineLearningModelResourceData", "Required": false, "MarkdownDocumentation": "`SageMakerMachineLearningModelResourceData`\n\nSettings for a machine learning resource saved as an SageMaker AI training\njob.\n*Required*: No\n*Type*: [SageMakerMachineLearningModelResourceData](./aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-sagemakermachinelearningmodelresourcedata", "UpdateType": "Immutable" }, "LocalVolumeResourceData": { "Type": "LocalVolumeResourceData", "Required": false, "MarkdownDocumentation": "`LocalVolumeResourceData`\n\nSettings for a local volume resource.\n*Required*: No\n*Type*: [LocalVolumeResourceData](./aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-localvolumeresourcedata", "UpdateType": "Immutable" }, "LocalDeviceResourceData": { "Type": "LocalDeviceResourceData", "Required": false, "MarkdownDocumentation": "`LocalDeviceResourceData`\n\nSettings for a local device resource.\n*Required*: No\n*Type*: [LocalDeviceResourceData](./aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-localdeviceresourcedata", "UpdateType": "Immutable" }, "S3MachineLearningModelResourceData": { "Type": "S3MachineLearningModelResourceData", "Required": false, "MarkdownDocumentation": "`S3MachineLearningModelResourceData`\n\nSettings for a machine learning resource stored in Amazon S3.\n*Required*: No\n*Type*: [S3MachineLearningModelResourceData](./aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-s3machinelearningmodelresourcedata", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting`\n\nThe owner setting for a downloaded machine learning resource. For more information, see\n[Access Machine Learning\nResources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `ResourceDownloadOwnerSetting` is the\nproperty type of the `OwnerSetting` property for the [`S3MachineLearningModelResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html) and [`SageMakerMachineLearningModelResourceData`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html) property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html", "Properties": { "GroupOwner": { "Required": true, "MarkdownDocumentation": "`GroupOwner`\n\nThe group owner of the machine learning resource. This is the group ID (GID) of an\nexisting Linux OS group on the system. The group's permissions are added to the Lambda process.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinitionversion-resourcedownloadownersetting-groupowner", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GroupPermission": { "Required": true, "MarkdownDocumentation": "`GroupPermission`\n\nThe permissions that the group owner has to the machine learning resource. Valid values\nare `rw` (read-write) or `ro` (read-only).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinitionversion-resourcedownloadownersetting-grouppermission", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.ResourceInstance": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.ResourceInstance`\n\nA\nlocal resource, machine learning resource, or secret resource. For more information, see\n[Access Local\nResources with Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-local-resources.html), [Perform Machine Learning\nInference](https://docs.aws.amazon.com/greengrass/v1/developerguide/ml-inference.html), and [Deploy Secrets to the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/v1/developerguide/secrets.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, the `Resources` property of the [`AWS::Greengrass::ResourceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html) resource contains a list of `ResourceInstance` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html", "Properties": { "ResourceDataContainer": { "Type": "ResourceDataContainer", "Required": true, "MarkdownDocumentation": "`ResourceDataContainer`\n\nA container for resource data. The container takes only one of the following supported\nresource data types: `LocalDeviceResourceData`,\n`LocalVolumeResourceData`,\n`SageMakerMachineLearningModelResourceData`,\n`S3MachineLearningModelResourceData`, or\n`SecretsManagerSecretResourceData`.\n###### Note\nOnly one resource type can be defined for a `ResourceDataContainer`\ninstance.\n*Required*: Yes\n*Type*: [ResourceDataContainer](./aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-resourcedatacontainer", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the resource. This value must be unique within the\nresource definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe descriptive resource name, which is displayed on the AWS IoT Greengrass console.\nMaximum length 128 characters with pattern [a-zA-Z0-9:\\_-]+. This must be unique within a\nGreengrass 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html#cfn-greengrass-resourcedefinitionversion-resourceinstance-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.S3MachineLearningModelResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.S3MachineLearningModelResourceData`\n\nSettings for an Amazon S3 machine learning resource. For more information, see\n[Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/v1/developerguide/ml-inference.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `S3MachineLearningModelResourceData` can\nbe used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html", "Properties": { "OwnerSetting": { "Type": "ResourceDownloadOwnerSetting", "Required": false, "MarkdownDocumentation": "`OwnerSetting`\n\nThe owner setting for the downloaded machine learning resource. For more information,\nsee [Access Machine Learning\nResources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n*Required*: No\n*Type*: [ResourceDownloadOwnerSetting](./aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-ownersetting", "UpdateType": "Immutable" }, "DestinationPath": { "Required": true, "MarkdownDocumentation": "`DestinationPath`\n\nThe absolute local path of the resource inside the Lambda\nenvironment.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-destinationpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "S3Uri": { "Required": true, "MarkdownDocumentation": "`S3Uri`\n\nThe URI of the source model in an Amazon S3 bucket. The model package must be\nin `tar.gz` or `.zip` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-s3uri", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.SageMakerMachineLearningModelResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.SageMakerMachineLearningModelResourceData`\n\nSettings for an Secrets Manager machine learning resource. For more information, see\n[Perform Machine Learning Inference](https://docs.aws.amazon.com/greengrass/v1/developerguide/ml-inference.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template,\n`SageMakerMachineLearningModelResourceData` can be used in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html", "Properties": { "OwnerSetting": { "Type": "ResourceDownloadOwnerSetting", "Required": false, "MarkdownDocumentation": "`OwnerSetting`\n\nThe owner setting for the downloaded machine learning resource. For more information,\nsee [Access Machine Learning\nResources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n*Required*: No\n*Type*: [ResourceDownloadOwnerSetting](./aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-ownersetting", "UpdateType": "Immutable" }, "DestinationPath": { "Required": true, "MarkdownDocumentation": "`DestinationPath`\n\nThe absolute local path of the resource inside the Lambda\nenvironment.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-destinationpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SageMakerJobArn": { "Required": true, "MarkdownDocumentation": "`SageMakerJobArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SageMaker AI training job that\nrepresents the source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-sagemakerjobarn", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion.SecretsManagerSecretResourceData": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion.SecretsManagerSecretResourceData`\n\nSettings for a secret resource, which references a secret from AWS Secrets Manager.\nAWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core,\nwhere it can be securely accessed by connectors and Lambda functions. For\nmore information, see [Deploy Secrets to the AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/v1/developerguide/secrets.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nIn an CloudFormation template, `SecretsManagerSecretResourceData` can be\nused in the [`ResourceDataContainer`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html", "Properties": { "ARN": { "Required": true, "MarkdownDocumentation": "`ARN`\n\nThe Amazon Resource Name (ARN) of the Secrets Manager secret to make available\non the core. The value of the secret's latest version (represented by the\n`AWSCURRENT` staging label) is included 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata-arn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AdditionalStagingLabelsToDownload": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AdditionalStagingLabelsToDownload`\n\nThe staging labels whose values you want to make available on the core, in addition to\n`AWSCURRENT`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata-additionalstaginglabelstodownload", "UpdateType": "Immutable" } } }, "AWS::Greengrass::SubscriptionDefinition.Subscription": { "MarkdownDocumentation": "`AWS::Greengrass::SubscriptionDefinition.Subscription`\n\nSubscriptions define how MQTT messages can be exchanged between devices, functions, and\nconnectors in the group, and with AWS IoT or the local shadow service. A\nsubscription defines a message source, message target, and a topic (or subject) that's used\nto route messages from the source to the target. A subscription defines the message flow in\none direction, from the source to the target. For two-way communication, you must set up\ntwo subscriptions, one for each direction.\nIn an\nCloudFormation template, the `Subscriptions` property of the [`SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html) property type contains a list of `Subscription` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html", "Properties": { "Target": { "Required": true, "MarkdownDocumentation": "`Target`\n\nThe destination of the message. The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN,\n`cloud` (which represents the AWS IoT cloud), or\n`GGShadowService`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-target", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the subscription. This value must be unique within the\nsubscription definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Source": { "Required": true, "MarkdownDocumentation": "`Source`\n\nThe originator of the message. The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN,\n`cloud` (which represents the AWS IoT cloud), or\n`GGShadowService`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-source", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Subject": { "Required": true, "MarkdownDocumentation": "`Subject`\n\nThe MQTT topic used to route the message.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html#cfn-greengrass-subscriptiondefinition-subscription-subject", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::SubscriptionDefinition.SubscriptionDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::SubscriptionDefinition.SubscriptionDefinitionVersion`\n\nA subscription definition version contains a list of [subscriptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html).\n###### Note\nAfter you create a subscription definition version that contains the subscriptions\nyou want to deploy, you must add it to your group version. For more information, see\n[`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\nIn an CloudFormation template, `SubscriptionDefinitionVersion` is the\nproperty type of the `InitialVersion` property in the [`AWS::Greengrass::SubscriptionDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html", "Properties": { "Subscriptions": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Subscriptions`\n\nThe subscriptions in this version.\n*Required*: Yes\n*Type*: Array of [Subscription](./aws-properties-greengrass-subscriptiondefinition-subscription.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinition-subscriptiondefinitionversion-subscriptions", "ItemType": "Subscription", "UpdateType": "Immutable" } } }, "AWS::Greengrass::SubscriptionDefinitionVersion.Subscription": { "MarkdownDocumentation": "`AWS::Greengrass::SubscriptionDefinitionVersion.Subscription`\n\nSubscriptions define how MQTT messages can be exchanged between devices, functions, and\nconnectors in the group, and with AWS IoT or the local shadow service. A\nsubscription defines a message source, message target, and a topic (or subject) that's used\nto route messages from the source to the target. A subscription defines the message flow in\none direction, from the source to the target. For two-way communication, you must set up\ntwo subscriptions, one for each direction.\nIn an CloudFormation template, the `Subscriptions` property of the [`AWS::Greengrass::SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html) resource contains a list of `Subscription` property types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html", "Properties": { "Target": { "Required": true, "MarkdownDocumentation": "`Target`\n\nThe destination of the message. The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN,\n`cloud` (which represents the AWS IoT cloud), or\n`GGShadowService`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-target", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Id": { "Required": true, "MarkdownDocumentation": "`Id`\n\nA descriptive or arbitrary ID for the subscription. This value must be unique within the\nsubscription definition version. Maximum length is 128 characters with pattern\n`[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-id", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Source": { "Required": true, "MarkdownDocumentation": "`Source`\n\nThe originator of the message. The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN,\n`cloud` (which represents the AWS IoT cloud), or\n`GGShadowService`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-source", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Subject": { "Required": true, "MarkdownDocumentation": "`Subject`\n\nThe MQTT topic used to route the message.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinitionversion-subscription.html#cfn-greengrass-subscriptiondefinitionversion-subscription-subject", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::GreengrassV2::ComponentVersion.ComponentDependencyRequirement": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.ComponentDependencyRequirement`\n\nContains information about a component dependency for a Lambda function\ncomponent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentdependencyrequirement.html", "Properties": { "VersionRequirement": { "MarkdownDocumentation": "`VersionRequirement`\n\nThe component version requirement for the component dependency.\nAWS IoT Greengrass uses semantic version constraints. For more information, see\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentdependencyrequirement.html#cfn-greengrassv2-componentversion-componentdependencyrequirement-versionrequirement", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DependencyType": { "MarkdownDocumentation": "`DependencyType`\n\nThe type of this dependency. Choose from the following options:\n* `SOFT` \u2013 The component doesn't restart if the dependency changes\n state.\n* `HARD` \u2013 The component restarts if the dependency changes state.\nDefault: `HARD`\n*Required*: No\n*Type*: String\n*Allowed values*: `SOFT | HARD...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SOFT", "HARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentdependencyrequirement.html#cfn-greengrassv2-componentversion-componentdependencyrequirement-dependencytype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::ComponentVersion.ComponentPlatform": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.ComponentPlatform`\n\nContains information about a platform that a component supports.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentplatform.html", "Properties": { "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nA dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines\nthe `os` and `platform` by default. You can specify additional platform\nattributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For\nmore information, see the [AWS IoT Greengrass\nnucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer\nGuide*.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentplatform.html#cfn-greengrassv2-componentversion-componentplatform-attributes", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentplatform.html#cfn-greengrassv2-componentversion-componentplatform-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::ComponentVersion.LambdaContainerParams": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.LambdaContainerParams`\n\nContains information about a container in which AWS Lambda functions run on\nAWS IoT Greengrass core devices.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html", "Properties": { "Volumes": { "MarkdownDocumentation": "`Volumes`\n\nThe list of volumes that the container can access.\n*Required*: No\n*Type*: Array of [LambdaVolumeMount](./aws-properties-greengrassv2-componentversion-lambdavolumemount.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html#cfn-greengrassv2-componentversion-lambdacontainerparams-volumes", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "LambdaVolumeMount", "DuplicatesAllowed": true }, "MountROSysfs": { "MarkdownDocumentation": "`MountROSysfs`\n\nWhether or not the container can read information from the device's `/sys`\nfolder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html#cfn-greengrassv2-componentversion-lambdacontainerparams-mountrosysfs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MemorySizeInKB": { "MarkdownDocumentation": "`MemorySizeInKB`\n\nThe memory size of the container, expressed in kilobytes.\nDefault: `16384` (16 MB)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html#cfn-greengrassv2-componentversion-lambdacontainerparams-memorysizeinkb", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Devices": { "MarkdownDocumentation": "`Devices`\n\nThe list of system devices that the container can access.\n*Required*: No\n*Type*: Array of [LambdaDeviceMount](./aws-properties-greengrassv2-componentversion-lambdadevicemount.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdacontainerparams.html#cfn-greengrassv2-componentversion-lambdacontainerparams-devices", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "LambdaDeviceMount", "DuplicatesAllowed": true } } }, "AWS::GreengrassV2::ComponentVersion.LambdaDeviceMount": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.LambdaDeviceMount`\n\nContains information about a device that Linux processes in a container can access.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdadevicemount.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe mount path for the device 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdadevicemount.html#cfn-greengrassv2-componentversion-lambdadevicemount-path", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AddGroupOwner": { "MarkdownDocumentation": "`AddGroupOwner`\n\nWhether or not to add the component's system user as an owner of the device.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdadevicemount.html#cfn-greengrassv2-componentversion-lambdadevicemount-addgroupowner", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Permission": { "MarkdownDocumentation": "`Permission`\n\nThe permission to access the device: read/only (`ro`) or read/write\n(`rw`).\nDefault: `ro`\n*Required*: No\n*Type*: String\n*Allowed values*: `ro | rw`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ro", "rw" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdadevicemount.html#cfn-greengrassv2-componentversion-lambdadevicemount-permission", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::ComponentVersion.LambdaEventSource": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.LambdaEventSource`\n\nContains information about an event source for an AWS Lambda function. The\nevent source defines the topics on which this Lambda function subscribes to\nreceive messages that run the function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaeventsource.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of event source. Choose from the following options:\n* `PUB_SUB` \u2013 Subscribe to local publish/subscribe messages. This event\n source type doesn't support MQTT wildcards (`+` and `#`) in the\n event source topic.\n* `IOT_CORE` \u2013 Subscribe to AWS IoT Core MQTT messages. This\n event source type supports MQTT wildcards (`+` and `#`) in the event\n source topic.\n*Required*: No\n*Type*: String\n*Allowed values*: `PUB_SUB | IOT_CORE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PUB_SUB", "IOT_CORE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaeventsource.html#cfn-greengrassv2-componentversion-lambdaeventsource-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Topic": { "MarkdownDocumentation": "`Topic`\n\nThe topic to which to subscribe to receive event messages.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaeventsource.html#cfn-greengrassv2-componentversion-lambdaeventsource-topic", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::ComponentVersion.LambdaExecutionParameters": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.LambdaExecutionParameters`\n\nContains parameters for a Lambda function that runs on AWS IoT Greengrass.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html", "Properties": { "MaxInstancesCount": { "MarkdownDocumentation": "`MaxInstancesCount`\n\nThe maximum number of instances that a non-pinned Lambda function can run at\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxinstancescount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "TimeoutInSeconds": { "MarkdownDocumentation": "`TimeoutInSeconds`\n\nThe maximum amount of time in seconds that the Lambda function can process a\nwork 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-timeoutinseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "EnvironmentVariables": { "MarkdownDocumentation": "`EnvironmentVariables`\n\nThe map of environment variables that are available to the Lambda function\nwhen it runs.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-environmentvariables", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "EventSources": { "MarkdownDocumentation": "`EventSources`\n\nThe list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can\nsubscribe this function to local publish/subscribe messages and AWS IoT Core MQTT\nmessages.\n*Required*: No\n*Type*: Array of [LambdaEventSource](./aws-properties-greengrassv2-componentversion-lambdaeventsource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-eventsources", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "LambdaEventSource", "DuplicatesAllowed": true }, "Pinned": { "MarkdownDocumentation": "`Pinned`\n\nWhether or not the Lambda function is pinned, or long-lived.\n* A pinned Lambda function starts when the AWS IoT Greengrass Core starts\n and keeps running in its own container.\n* A non-pinned Lambda function starts only when it receives a work item\n and exists after it idles for `maxIdleTimeInSeconds`. If the function has\n multiple work items, the AWS IoT Greengrass Core software creates multiple instances of\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-pinned", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ExecArgs": { "MarkdownDocumentation": "`ExecArgs`\n\nThe list of arguments to pass to the Lambda function when it runs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-execargs", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LinuxProcessParams": { "MarkdownDocumentation": "`LinuxProcessParams`\n\nThe parameters for the Linux process that contains the Lambda\nfunction.\n*Required*: No\n*Type*: [LambdaLinuxProcessParams](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-linuxprocessparams", "UpdateType": "Immutable", "Required": false, "Type": "LambdaLinuxProcessParams" }, "InputPayloadEncodingType": { "MarkdownDocumentation": "`InputPayloadEncodingType`\n\nThe encoding type that the Lambda function supports.\nDefault: `json`\n*Required*: No\n*Type*: String\n*Allowed values*: `json | binary...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "json", "binary" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-inputpayloadencodingtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaxQueueSize": { "MarkdownDocumentation": "`MaxQueueSize`\n\nThe maximum size of the message queue for the Lambda function component. The\nAWS IoT Greengrass core device stores messages in a FIFO (first-in-first-out) queue until\nit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxqueuesize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "StatusTimeoutInSeconds": { "MarkdownDocumentation": "`StatusTimeoutInSeconds`\n\nThe interval in seconds at which a pinned (also known as long-lived) Lambda\nfunction 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-statustimeoutinseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MaxIdleTimeInSeconds": { "MarkdownDocumentation": "`MaxIdleTimeInSeconds`\n\nThe maximum amount of time in seconds that a non-pinned Lambda function can\nidle 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html#cfn-greengrassv2-componentversion-lambdaexecutionparameters-maxidletimeinseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GreengrassV2::ComponentVersion.LambdaFunctionRecipeSource": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.LambdaFunctionRecipeSource`\n\nContains information about an AWS Lambda function to import to create a\ncomponent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html", "Properties": { "ComponentDependencies": { "MarkdownDocumentation": "`ComponentDependencies`\n\nThe component versions on which this Lambda function component\ndepends.\n*Required*: No\n*Type*: Object of [ComponentDependencyRequirement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentdependencies", "UpdateType": "Immutable", "Required": false, "Type": "Map", "ItemType": "ComponentDependencyRequirement" }, "ComponentLambdaParameters": { "MarkdownDocumentation": "`ComponentLambdaParameters`\n\nThe system and runtime parameters for the Lambda function as it runs on the\nAWS IoT Greengrass core device.\n*Required*: No\n*Type*: [LambdaExecutionParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentlambdaparameters", "UpdateType": "Immutable", "Required": false, "Type": "LambdaExecutionParameters" }, "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe ARN of the Lambda function. The ARN must include the version of the\nfunction to import. You can't use version aliases like `$LATEST`.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[^:]*:lambda:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-lambdaarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ComponentPlatforms": { "MarkdownDocumentation": "`ComponentPlatforms`\n\nThe platforms that the component version supports.\n*Required*: No\n*Type*: Array of [ComponentPlatform](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentplatforms", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ComponentPlatform", "DuplicatesAllowed": true }, "ComponentName": { "MarkdownDocumentation": "`ComponentName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ComponentVersion": { "MarkdownDocumentation": "`ComponentVersion`\n\nThe version of the component.\nDefaults to the version of the Lambda function as a semantic version. For\nexample, if your function version is `3`, the component version becomes\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html#cfn-greengrassv2-componentversion-lambdafunctionrecipesource-componentversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::ComponentVersion.LambdaLinuxProcessParams": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.LambdaLinuxProcessParams`\n\nContains parameters for a Linux process that contains an AWS Lambda\nfunction.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams.html", "Properties": { "IsolationMode": { "MarkdownDocumentation": "`IsolationMode`\n\nThe isolation mode for the process that contains the Lambda function. The\nprocess can run in an isolated runtime environment inside the AWS IoT Greengrass\ncontainer, or as a regular process outside any container.\nDefault: `GreengrassContainer`\n*Required*: No\n*Type*: String\n*Allowed values*: `GreengrassContainer | NoCon...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "GreengrassContainer", "NoContainer" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams.html#cfn-greengrassv2-componentversion-lambdalinuxprocessparams-isolationmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ContainerParams": { "MarkdownDocumentation": "`ContainerParams`\n\nThe parameters for the container in which the Lambda function runs.\n*Required*: No\n*Type*: [LambdaContainerParams](./aws-properties-greengrassv2-componentversion-lambdacontainerparams.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams.html#cfn-greengrassv2-componentversion-lambdalinuxprocessparams-containerparams", "UpdateType": "Immutable", "Required": false, "Type": "LambdaContainerParams" } } }, "AWS::GreengrassV2::ComponentVersion.LambdaVolumeMount": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion.LambdaVolumeMount`\n\nContains information about a volume that Linux processes in a container can access. When\nyou define a volume, the AWS IoT Greengrass Core software mounts the source files to the\ndestination inside the container.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html", "Properties": { "SourcePath": { "MarkdownDocumentation": "`SourcePath`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html#cfn-greengrassv2-componentversion-lambdavolumemount-sourcepath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DestinationPath": { "MarkdownDocumentation": "`DestinationPath`\n\nThe path to the logical 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html#cfn-greengrassv2-componentversion-lambdavolumemount-destinationpath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AddGroupOwner": { "MarkdownDocumentation": "`AddGroupOwner`\n\nWhether or not to add the AWS IoT Greengrass user group as an owner of the\nvolume.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html#cfn-greengrassv2-componentversion-lambdavolumemount-addgroupowner", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Permission": { "MarkdownDocumentation": "`Permission`\n\nThe permission to access the volume: read/only (`ro`) or read/write\n(`rw`).\nDefault: `ro`\n*Required*: No\n*Type*: String\n*Allowed values*: `ro | rw`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ro", "rw" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdavolumemount.html#cfn-greengrassv2-componentversion-lambdavolumemount-permission", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::Deployment.ComponentConfigurationUpdate": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.ComponentConfigurationUpdate`\n\nContains information about a deployment's update to a component's configuration on AWS IoT Greengrass core devices. For more information, see [Update component\nconfigurations](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) in the *AWS IoT Greengrass V2 Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html", "Properties": { "Merge": { "MarkdownDocumentation": "`Merge`\n\nA serialized JSON string that contains the configuration object to merge to target\ndevices. The core device merges this configuration with the component's existing\nconfiguration. If this is the first time a component deploys on a device, the core device\nmerges this configuration with the component's default configuration. This means that the core\ndevice keeps it's existing configuration for keys and values that you don't specify in this\nobject. 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\nGuide*.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `10485760`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html#cfn-greengrassv2-deployment-componentconfigurationupdate-merge", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Reset": { "MarkdownDocumentation": "`Reset`\n\nThe list of configuration nodes to reset to default values on target devices. Use JSON\npointers to specify each node to reset. JSON pointers start with a forward slash\n(`/`) and use forward slashes to separate the key for each level in the object.\nFor more information, see the [JSON pointer\nspecification](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\nGuide*.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html#cfn-greengrassv2-deployment-componentconfigurationupdate-reset", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::GreengrassV2::Deployment.ComponentDeploymentSpecification": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.ComponentDeploymentSpecification`\n\nContains information about a component to deploy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html", "Properties": { "RunWith": { "MarkdownDocumentation": "`RunWith`\n\nThe system user and group that the software uses to run component\nprocesses on the core device. If you omit this parameter, the software\nuses the system user and group that you configure for the core device. For more information,\nsee [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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-runwith", "UpdateType": "Immutable", "Required": false, "Type": "ComponentRunWith" }, "ConfigurationUpdate": { "MarkdownDocumentation": "`ConfigurationUpdate`\n\nThe configuration updates to deploy for the component. You can define reset updates and\nmerge updates. A reset updates the keys that you specify to the default configuration for the\ncomponent. A merge updates the core device's component configuration with the keys and values\nthat you specify. The AWS IoT Greengrass Core software applies reset updates before it\napplies merge updates. For more information, see [Update component\nconfiguration](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html).\n*Required*: No\n*Type*: [ComponentConfigurationUpdate](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-configurationupdate", "UpdateType": "Immutable", "Required": false, "Type": "ComponentConfigurationUpdate" }, "ComponentVersion": { "MarkdownDocumentation": "`ComponentVersion`\n\nThe version of the component.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html#cfn-greengrassv2-deployment-componentdeploymentspecification-componentversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::Deployment.ComponentRunWith": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.ComponentRunWith`\n\nContains information system user and group that the AWS IoT Greengrass Core software uses\nto run component processes on 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html", "Properties": { "WindowsUser": { "MarkdownDocumentation": "`WindowsUser`\n\nThe Windows user to use to run this component on Windows core devices. The user must exist\non each Windows core device, and its name and password must be in the LocalSystem account's\nCredentials Manager instance.\nIf you omit this parameter, the AWS IoT Greengrass Core software uses the default Windows\nuser that you configure on the AWS IoT Greengrass nucleus component. For more information,\nsee [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*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html#cfn-greengrassv2-deployment-componentrunwith-windowsuser", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SystemResourceLimits": { "MarkdownDocumentation": "`SystemResourceLimits`\n\nThe system resource limits to apply to this component's process on the core device.\nAWS 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\nresource limits that you configure on the AWS IoT Greengrass nucleus component. For more\ninformation, 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html#cfn-greengrassv2-deployment-componentrunwith-systemresourcelimits", "UpdateType": "Immutable", "Required": false, "Type": "SystemResourceLimits" }, "PosixUser": { "MarkdownDocumentation": "`PosixUser`\n\nThe POSIX system user and (optional) group to use to run this component. Specify the user\nand group separated by a colon (`:`) in the following format:\n`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*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html#cfn-greengrassv2-deployment-componentrunwith-posixuser", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::Deployment.DeploymentComponentUpdatePolicy": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.DeploymentComponentUpdatePolicy`\n\nContains information about a deployment's policy that defines when components are safe to\nupdate.\nEach component on a device can report whether or not it's ready to update. After a\ncomponent and its dependencies are ready, they can apply the update in the deployment. You can\nconfigure whether or not the deployment notifies components of an update and waits for a\nresponse. You specify the amount of time each component has to respond to the update\nnotification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nWhether or not to notify components and wait for components to become safe to update.\nChoose from the following options:\n* `NOTIFY_COMPONENTS` \u2013 The deployment notifies each component before it\n 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,\n 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\n deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer\n Guide*.\n* `SKIP_NOTIFY_COMPONENTS` \u2013 The deployment doesn't notify components or wait\n for them to be safe to update.\nDefault: `NOTIFY_COMPONENTS`\n*Required*: No\n*Type*: String\n*Allowed values*: `NOTIFY_COMPONENTS | SKIP_NO...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "NOTIFY_COMPONENTS", "SKIP_NOTIFY_COMPONENTS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.html#cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-action", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TimeoutInSeconds": { "MarkdownDocumentation": "`TimeoutInSeconds`\n\nThe amount of time in seconds that each component on a device has to report that it's safe\nto update. If the component waits for longer than this timeout, then the deployment proceeds\non the device.\nDefault: `60`\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `2147483647`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.html#cfn-greengrassv2-deployment-deploymentcomponentupdatepolicy-timeoutinseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GreengrassV2::Deployment.DeploymentConfigurationValidationPolicy": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.DeploymentConfigurationValidationPolicy`\n\nContains information about how long a component on a core device can validate its\nconfiguration updates before it times out. Components can use the [SubscribeToValidateConfigurationUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates) IPC operation to receive notifications when\na deployment specifies a configuration update. Then, components can respond with the [SendConfigurationValidityReport](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport) IPC operation. For more information, see the [Create\ndeployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy.html", "Properties": { "TimeoutInSeconds": { "MarkdownDocumentation": "`TimeoutInSeconds`\n\nThe amount of time in seconds that a component can validate its configuration updates. If\nthe validation time exceeds this timeout, then the deployment proceeds for the device.\nDefault: `30`\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `2147483647`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy.html#cfn-greengrassv2-deployment-deploymentconfigurationvalidationpolicy-timeoutinseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GreengrassV2::Deployment.DeploymentIoTJobConfiguration": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.DeploymentIoTJobConfiguration`\n\nContains information about an AWS IoT job configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html", "Properties": { "JobExecutionsRolloutConfig": { "MarkdownDocumentation": "`JobExecutionsRolloutConfig`\n\nThe rollout configuration for the job. This configuration defines the rate at which the\njob rolls out to the fleet of target devices.\n*Required*: No\n*Type*: [IoTJobExecutionsRolloutConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-jobexecutionsrolloutconfig", "UpdateType": "Immutable", "Required": false, "Type": "IoTJobExecutionsRolloutConfig" }, "TimeoutConfig": { "MarkdownDocumentation": "`TimeoutConfig`\n\nThe timeout configuration for the job. This configuration defines the amount of time each\ndevice has to complete the job.\n*Required*: No\n*Type*: [IoTJobTimeoutConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-timeoutconfig", "UpdateType": "Immutable", "Required": false, "Type": "IoTJobTimeoutConfig" }, "AbortConfig": { "MarkdownDocumentation": "`AbortConfig`\n\nThe stop configuration for the job. This configuration defines when and how to stop a job\nrollout.\n*Required*: No\n*Type*: [IoTJobAbortConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-abortconfig", "UpdateType": "Immutable", "Required": false, "Type": "IoTJobAbortConfig" } } }, "AWS::GreengrassV2::Deployment.DeploymentPolicies": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.DeploymentPolicies`\n\nContains information about policies that define how a deployment updates components and\nhandles failure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html", "Properties": { "ComponentUpdatePolicy": { "MarkdownDocumentation": "`ComponentUpdatePolicy`\n\nThe component update policy for the configuration deployment. This policy defines when\nit's safe to deploy the configuration to devices.\n*Required*: No\n*Type*: [DeploymentComponentUpdatePolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-componentupdatepolicy", "UpdateType": "Immutable", "Required": false, "Type": "DeploymentComponentUpdatePolicy" }, "ConfigurationValidationPolicy": { "MarkdownDocumentation": "`ConfigurationValidationPolicy`\n\nThe configuration validation policy for the configuration deployment. This policy defines\nhow long each component has to validate its configure updates.\n*Required*: No\n*Type*: [DeploymentConfigurationValidationPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-configurationvalidationpolicy", "UpdateType": "Immutable", "Required": false, "Type": "DeploymentConfigurationValidationPolicy" }, "FailureHandlingPolicy": { "MarkdownDocumentation": "`FailureHandlingPolicy`\n\nThe failure handling policy for the configuration deployment. This policy defines what to\ndo if the deployment fails.\nDefault: `ROLLBACK`\n*Required*: No\n*Type*: String\n*Allowed values*: `ROLLBACK | DO_NOTHING...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ROLLBACK", "DO_NOTHING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-failurehandlingpolicy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GreengrassV2::Deployment.IoTJobAbortConfig": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.IoTJobAbortConfig`\n\nContains a list of criteria that define when and how to cancel a configuration\ndeployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortconfig.html", "Properties": { "CriteriaList": { "MarkdownDocumentation": "`CriteriaList`\n\nThe list of criteria that define when and how to cancel the configuration\ndeployment.\n*Required*: Yes\n*Type*: Array of [IoTJobAbortCriteria](./aws-properties-greengrassv2-deployment-iotjobabortcriteria.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortconfig.html#cfn-greengrassv2-deployment-iotjobabortconfig-criterialist", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "IoTJobAbortCriteria", "DuplicatesAllowed": true } } }, "AWS::GreengrassV2::Deployment.IoTJobAbortCriteria": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.IoTJobAbortCriteria`\n\nContains criteria that define when and how to cancel a job.\nThe deployment stops if the following conditions are true:\n1. The number of things that receive the deployment exceeds the\n `minNumberOfExecutedThings`.\n2. The percentage of failures with type `failureType` exceeds the\n `thresholdPercentage`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html", "Properties": { "FailureType": { "MarkdownDocumentation": "`FailureType`\n\nThe type of job deployment failure that can cancel a job.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FAILED | REJECTED | TIMED_O...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FAILED", "REJECTED", "TIMED_OUT", "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html#cfn-greengrassv2-deployment-iotjobabortcriteria-failuretype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nThe action to perform when the criteria are met.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CANCEL`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "CANCEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html#cfn-greengrassv2-deployment-iotjobabortcriteria-action", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ThresholdPercentage": { "MarkdownDocumentation": "`ThresholdPercentage`\n\nThe minimum percentage of `failureType` failures that occur before the job can\ncancel.\nThis parameter supports up to two digits after the decimal (for example, you can specify\n`10.9` or `10.99`, but not `10.999`).\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html#cfn-greengrassv2-deployment-iotjobabortcriteria-thresholdpercentage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" }, "MinNumberOfExecutedThings": { "MarkdownDocumentation": "`MinNumberOfExecutedThings`\n\nThe minimum number of things that receive the configuration before the job can\ncancel.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `2147483647`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html#cfn-greengrassv2-deployment-iotjobabortcriteria-minnumberofexecutedthings", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::GreengrassV2::Deployment.IoTJobExecutionsRolloutConfig": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.IoTJobExecutionsRolloutConfig`\n\nContains information about the rollout configuration for a job. This configuration defines\nthe rate at which the job deploys a configuration to a fleet of target devices.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.html", "Properties": { "MaximumPerMinute": { "MarkdownDocumentation": "`MaximumPerMinute`\n\nThe maximum number of devices that receive a pending job notification, per minute.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.html#cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-maximumperminute", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ExponentialRate": { "MarkdownDocumentation": "`ExponentialRate`\n\nThe exponential rate to increase the job rollout rate.\n*Required*: No\n*Type*: [IoTJobExponentialRolloutRate](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.html#cfn-greengrassv2-deployment-iotjobexecutionsrolloutconfig-exponentialrate", "UpdateType": "Immutable", "Required": false, "Type": "IoTJobExponentialRolloutRate" } } }, "AWS::GreengrassV2::Deployment.IoTJobExponentialRolloutRate": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.IoTJobExponentialRolloutRate`\n\nContains information about an exponential rollout rate for a configuration deployment\njob.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html", "Properties": { "RateIncreaseCriteria": { "MarkdownDocumentation": "`RateIncreaseCriteria`\n\nThe criteria to increase the rollout rate for the job.\n*Required*: Yes\n*Type*: [IoTJobRateIncreaseCriteria](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-rateincreasecriteria", "UpdateType": "Immutable", "Required": true, "Type": "IoTJobRateIncreaseCriteria" }, "BaseRatePerMinute": { "MarkdownDocumentation": "`BaseRatePerMinute`\n\nThe minimum number of devices that receive a pending job notification, per minute, when\nthe job starts. This parameter defines the initial rollout rate of the job.\n*Required*: Yes\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-baserateperminute", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "IncrementFactor": { "MarkdownDocumentation": "`IncrementFactor`\n\nThe 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\n`1.5`, but not `1.55`).\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html#cfn-greengrassv2-deployment-iotjobexponentialrolloutrate-incrementfactor", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::GreengrassV2::Deployment.IoTJobRateIncreaseCriteria": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.IoTJobRateIncreaseCriteria`\n\nContains information about criteria to meet before a job increases its rollout rate.\nSpecify either `numberOfNotifiedThings` or\n`numberOfSucceededThings`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria.html", "Properties": { "NumberOfSucceededThings": { "MarkdownDocumentation": "`NumberOfSucceededThings`\n\nThe number of devices to successfully run the configuration job before the rollout rate\nincreases.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `2147483647`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria.html#cfn-greengrassv2-deployment-iotjobrateincreasecriteria-numberofsucceededthings", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "NumberOfNotifiedThings": { "MarkdownDocumentation": "`NumberOfNotifiedThings`\n\nThe number of devices to receive the job notification before the rollout rate\nincreases.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `2147483647`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria.html#cfn-greengrassv2-deployment-iotjobrateincreasecriteria-numberofnotifiedthings", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GreengrassV2::Deployment.IoTJobTimeoutConfig": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.IoTJobTimeoutConfig`\n\nContains information about the timeout configuration for a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobtimeoutconfig.html", "Properties": { "InProgressTimeoutInMinutes": { "MarkdownDocumentation": "`InProgressTimeoutInMinutes`\n\nThe amount of time, in minutes, that devices have to complete the job. The timer starts\nwhen the job status is set to `IN_PROGRESS`. If the job status doesn't change to a\nterminal state before the time expires, then the job status is set to\n`TIMED_OUT`.\nThe timeout interval must be between 1 minute and 7 days (10080 minutes).\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `2147483647`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobtimeoutconfig.html#cfn-greengrassv2-deployment-iotjobtimeoutconfig-inprogresstimeoutinminutes", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GreengrassV2::Deployment.SystemResourceLimits": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment.SystemResourceLimits`\n\nContains information about system resource limits that the software\napplies to a component's processes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-systemresourcelimits.html", "Properties": { "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe maximum amount of RAM, expressed in kilobytes, that a component's processes can use on\nthe 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*Minimum*: `0`\n*Maximum*: `9223372036854771712`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-systemresourcelimits.html#cfn-greengrassv2-deployment-systemresourcelimits-memory", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Long" }, "Cpus": { "MarkdownDocumentation": "`Cpus`\n\nThe maximum amount of CPU time that a component's processes can use on the core device. A\ncore device's total CPU time is equivalent to the device's number of CPU cores. For example,\non a core device with 4 CPU cores, you can set this value to 2 to limit the component's\nprocesses to 50 percent usage of each CPU core. On a device with 1 CPU core, you can set this\nvalue to 0.25 to limit the component's processes to 25 percent usage of the CPU. If you set\nthis value to a number greater than the number of CPU cores, the AWS IoT Greengrass Core\nsoftware doesn't limit the component's CPU usage.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-systemresourcelimits.html#cfn-greengrassv2-deployment-systemresourcelimits-cpus", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::GroundStation::Config.AntennaDownlinkConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.AntennaDownlinkConfig`\n\nProvides information about how AWS Ground Station should configure an antenna for downlink during a contact.\nUse an antenna downlink config in a mission profile to receive the downlink data in raw DigIF format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkconfig.html", "Properties": { "SpectrumConfig": { "MarkdownDocumentation": "`SpectrumConfig`\n\nDefines the spectrum configuration.\n*Required*: No\n*Type*: [SpectrumConfig](./aws-properties-groundstation-config-spectrumconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkconfig.html#cfn-groundstation-config-antennadownlinkconfig-spectrumconfig", "UpdateType": "Mutable", "Required": false, "Type": "SpectrumConfig" } } }, "AWS::GroundStation::Config.AntennaDownlinkDemodDecodeConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.AntennaDownlinkDemodDecodeConfig`\n\nProvides information about how AWS Ground Station should configure an antenna for downlink during a contact.\nUse an antenna downlink demod decode config in a mission profile to receive the downlink data that has been demodulated and decoded.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html", "Properties": { "DemodulationConfig": { "MarkdownDocumentation": "`DemodulationConfig`\n\nDefines how the RF signal will be demodulated.\n*Required*: No\n*Type*: [DemodulationConfig](./aws-properties-groundstation-config-demodulationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html#cfn-groundstation-config-antennadownlinkdemoddecodeconfig-demodulationconfig", "UpdateType": "Mutable", "Required": false, "Type": "DemodulationConfig" }, "SpectrumConfig": { "MarkdownDocumentation": "`SpectrumConfig`\n\nDefines the spectrum configuration.\n*Required*: No\n*Type*: [SpectrumConfig](./aws-properties-groundstation-config-spectrumconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html#cfn-groundstation-config-antennadownlinkdemoddecodeconfig-spectrumconfig", "UpdateType": "Mutable", "Required": false, "Type": "SpectrumConfig" }, "DecodeConfig": { "MarkdownDocumentation": "`DecodeConfig`\n\nDefines how the RF signal will be decoded.\n*Required*: No\n*Type*: [DecodeConfig](./aws-properties-groundstation-config-decodeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html#cfn-groundstation-config-antennadownlinkdemoddecodeconfig-decodeconfig", "UpdateType": "Mutable", "Required": false, "Type": "DecodeConfig" } } }, "AWS::GroundStation::Config.AntennaUplinkConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.AntennaUplinkConfig`\n\nProvides information about how AWS Ground Station should configure an antenna for uplink during a contact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html", "Properties": { "TransmitDisabled": { "MarkdownDocumentation": "`TransmitDisabled`\n\nWhether or not uplink transmit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html#cfn-groundstation-config-antennauplinkconfig-transmitdisabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SpectrumConfig": { "MarkdownDocumentation": "`SpectrumConfig`\n\nDefines the spectrum configuration.\n*Required*: No\n*Type*: [UplinkSpectrumConfig](./aws-properties-groundstation-config-uplinkspectrumconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html#cfn-groundstation-config-antennauplinkconfig-spectrumconfig", "UpdateType": "Mutable", "Required": false, "Type": "UplinkSpectrumConfig" }, "TargetEirp": { "MarkdownDocumentation": "`TargetEirp`\n\nThe equivalent isotropically radiated power (EIRP) to use for uplink transmissions. Valid values are between 20.0 to 50.0 dBW.\n*Required*: No\n*Type*: [Eirp](./aws-properties-groundstation-config-eirp.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html#cfn-groundstation-config-antennauplinkconfig-targeteirp", "UpdateType": "Mutable", "Required": false, "Type": "Eirp" } } }, "AWS::GroundStation::Config.ConfigData": { "MarkdownDocumentation": "`AWS::GroundStation::Config.ConfigData`\n\nConfig objects provide information to Ground Station about how to configure the antenna and how data flows during a contact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html", "Properties": { "DataflowEndpointConfig": { "MarkdownDocumentation": "`DataflowEndpointConfig`\n\nProvides information for a dataflow endpoint config object.\nDataflow endpoint config objects are used to provide parameters about which IP endpoint(s) to use during a contact.\nDataflow endpoints are where Ground Station sends data during a downlink contact and where Ground Station receives data to send to the satellite during an uplink contact.\n*Required*: No\n*Type*: [DataflowEndpointConfig](./aws-properties-groundstation-config-dataflowendpointconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-dataflowendpointconfig", "UpdateType": "Mutable", "Required": false, "Type": "DataflowEndpointConfig" }, "UplinkEchoConfig": { "MarkdownDocumentation": "`UplinkEchoConfig`\n\nProvides information for an uplink echo config object.\nUplink echo config objects are used to provide parameters for uplink echo during uplink contacts.\n*Required*: No\n*Type*: [UplinkEchoConfig](./aws-properties-groundstation-config-uplinkechoconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-uplinkechoconfig", "UpdateType": "Mutable", "Required": false, "Type": "UplinkEchoConfig" }, "AntennaDownlinkConfig": { "MarkdownDocumentation": "`AntennaDownlinkConfig`\n\nProvides information for an antenna downlink config object.\nAntenna downlink config objects are used to provide parameters for downlinks where no demodulation or decoding is performed by Ground Station (RF over IP downlinks).\n*Required*: No\n*Type*: [AntennaDownlinkConfig](./aws-properties-groundstation-config-antennadownlinkconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-antennadownlinkconfig", "UpdateType": "Mutable", "Required": false, "Type": "AntennaDownlinkConfig" }, "AntennaDownlinkDemodDecodeConfig": { "MarkdownDocumentation": "`AntennaDownlinkDemodDecodeConfig`\n\nProvides information for a downlink demod decode config object.\nDownlink demod decode config objects are used to provide parameters for downlinks where the Ground Station service will demodulate and decode the downlinked data.\n*Required*: No\n*Type*: [AntennaDownlinkDemodDecodeConfig](./aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-antennadownlinkdemoddecodeconfig", "UpdateType": "Mutable", "Required": false, "Type": "AntennaDownlinkDemodDecodeConfig" }, "TrackingConfig": { "MarkdownDocumentation": "`TrackingConfig`\n\nProvides information for a tracking config object.\nTracking config objects are used to provide parameters about how to track the satellite through the sky during a contact.\n*Required*: No\n*Type*: [TrackingConfig](./aws-properties-groundstation-config-trackingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-trackingconfig", "UpdateType": "Mutable", "Required": false, "Type": "TrackingConfig" }, "AntennaUplinkConfig": { "MarkdownDocumentation": "`AntennaUplinkConfig`\n\nProvides information for an uplink config object.\nUplink config objects are used to provide parameters for uplink contacts.\n*Required*: No\n*Type*: [AntennaUplinkConfig](./aws-properties-groundstation-config-antennauplinkconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-antennauplinkconfig", "UpdateType": "Mutable", "Required": false, "Type": "AntennaUplinkConfig" }, "S3RecordingConfig": { "MarkdownDocumentation": "`S3RecordingConfig`\n\nProvides information for an S3 recording config object.\nS3 recording config objects are used to provide parameters for S3 recording during downlink contacts.\n*Required*: No\n*Type*: [S3RecordingConfig](./aws-properties-groundstation-config-s3recordingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-s3recordingconfig", "UpdateType": "Mutable", "Required": false, "Type": "S3RecordingConfig" } } }, "AWS::GroundStation::Config.DataflowEndpointConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.DataflowEndpointConfig`\n\nProvides information to AWS Ground Station about which IP endpoints to use during a contact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-dataflowendpointconfig.html", "Properties": { "DataflowEndpointName": { "MarkdownDocumentation": "`DataflowEndpointName`\n\nThe name of the dataflow endpoint to use during contacts.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-dataflowendpointconfig.html#cfn-groundstation-config-dataflowendpointconfig-dataflowendpointname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataflowEndpointRegion": { "MarkdownDocumentation": "`DataflowEndpointRegion`\n\nThe region of the dataflow endpoint to use during contacts. When omitted, Ground Station will use the region of the contact.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-dataflowendpointconfig.html#cfn-groundstation-config-dataflowendpointconfig-dataflowendpointregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.DecodeConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.DecodeConfig`\n\nDefines decoding settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-decodeconfig.html", "Properties": { "UnvalidatedJSON": { "MarkdownDocumentation": "`UnvalidatedJSON`\n\nThe decoding settings are in JSON format and define a set of steps to perform to decode the data.\n*Required*: No\n*Type*: String\n*Pattern*: `^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{1,8192}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-decodeconfig.html#cfn-groundstation-config-decodeconfig-unvalidatedjson", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.DemodulationConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.DemodulationConfig`\n\nDefines demodulation settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-demodulationconfig.html", "Properties": { "UnvalidatedJSON": { "MarkdownDocumentation": "`UnvalidatedJSON`\n\nThe demodulation settings are in JSON format and define parameters for demodulation, for example which modulation scheme (e.g. PSK, QPSK, etc.) and matched filter to use.\n*Required*: No\n*Type*: String\n*Pattern*: `^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{1,8192}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-demodulationconfig.html#cfn-groundstation-config-demodulationconfig-unvalidatedjson", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.Eirp": { "MarkdownDocumentation": "`AWS::GroundStation::Config.Eirp`\n\nDefines an equivalent isotropically radiated power (EIRP).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-eirp.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the EIRP. Valid values are between 20.0 to 50.0 dBW.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-eirp.html#cfn-groundstation-config-eirp-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Units": { "MarkdownDocumentation": "`Units`\n\nThe units of the EIRP.\n*Required*: No\n*Type*: String\n*Allowed values*: `dBW`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "dBW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-eirp.html#cfn-groundstation-config-eirp-units", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.Frequency": { "MarkdownDocumentation": "`AWS::GroundStation::Config.Frequency`\n\nDefines a frequency.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequency.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the frequency. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequency.html#cfn-groundstation-config-frequency-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Units": { "MarkdownDocumentation": "`Units`\n\nThe units of the frequency.\n*Required*: No\n*Type*: String\n*Allowed values*: `GHz | MHz | kHz...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GHz", "MHz", "kHz" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequency.html#cfn-groundstation-config-frequency-units", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.FrequencyBandwidth": { "MarkdownDocumentation": "`AWS::GroundStation::Config.FrequencyBandwidth`\n\nDefines a bandwidth.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequencybandwidth.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the bandwidth. AWS Ground Station currently has the following bandwidth limitations:\n* For `AntennaDownlinkDemodDecodeconfig`, valid values are between 125 kHz to 650 MHz.\n* For `AntennaDownlinkconfig`, valid values are between 10 kHz to 54 MHz.\n* For `AntennaUplinkConfig`, valid values are between 10 kHz to 54 MHz.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequencybandwidth.html#cfn-groundstation-config-frequencybandwidth-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Units": { "MarkdownDocumentation": "`Units`\n\nThe units of the bandwidth.\n*Required*: No\n*Type*: String\n*Allowed values*: `GHz | MHz | kHz...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GHz", "MHz", "kHz" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequencybandwidth.html#cfn-groundstation-config-frequencybandwidth-units", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.S3RecordingConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.S3RecordingConfig`\n\nProvides information about how AWS Ground Station should save downlink data to S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-s3recordingconfig.html", "Properties": { "BucketArn": { "MarkdownDocumentation": "`BucketArn`\n\nS3 Bucket where the data is written. The name of the S3 Bucket provided must begin with `aws-groundstation`.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[A-Za-z0-9-]{0,64}:s3:::[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-s3recordingconfig.html#cfn-groundstation-config-s3recordingconfig-bucketarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe prefix of the S3 data object.\nIf you choose to use any optional keys for substitution, these values will be replaced with the corresponding information from your contact details.\nFor example, a prefix of `{satellite_id}/{year}/{month}/{day}/` will replaced with `fake_satellite_id/2021/01/10/`\n*Optional keys for substitution*: `{satellite_id}` | `{config-name}` | `{config-id}` | `{year}` | `{month}` | `{day}`\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_\\-=/]|\\{satellite_id\\}|\\{config\\-name}|\\{s3\\-config-id}|\\{year\\}|\\{month\\}|\\{day\\}){1,900}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-s3recordingconfig.html#cfn-groundstation-config-s3recordingconfig-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nDefines the ARN of the role assumed for putting archives to S3.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[^:\\n]+:iam::[^:\\n]+:role\\/.+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-s3recordingconfig.html#cfn-groundstation-config-s3recordingconfig-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.SpectrumConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.SpectrumConfig`\n\nDefines a spectrum.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html", "Properties": { "Polarization": { "MarkdownDocumentation": "`Polarization`\n\nThe polarization of the spectrum. Valid values are `\"RIGHT_HAND\"` and `\"LEFT_HAND\"`. Capturing both `\"RIGHT_HAND\"` and `\"LEFT_HAND\"` polarization requires two separate configs.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT_HAND | RIGHT_HAND | NO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT_HAND", "RIGHT_HAND", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html#cfn-groundstation-config-spectrumconfig-polarization", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bandwidth": { "MarkdownDocumentation": "`Bandwidth`\n\nThe bandwidth of the spectrum. AWS Ground Station currently has the following bandwidth limitations:\n* For `AntennaDownlinkDemodDecodeconfig`, valid values are between 125 kHz to 650 MHz.\n* For `AntennaDownlinkconfig`, valid values are between 10 kHz to 54 MHz.\n* For `AntennaUplinkConfig`, valid values are between 10 kHz to 54 MHz.\n*Required*: No\n*Type*: [FrequencyBandwidth](./aws-properties-groundstation-config-frequencybandwidth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html#cfn-groundstation-config-spectrumconfig-bandwidth", "UpdateType": "Mutable", "Required": false, "Type": "FrequencyBandwidth" }, "CenterFrequency": { "MarkdownDocumentation": "`CenterFrequency`\n\nThe center frequency of the spectrum. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.\n*Required*: No\n*Type*: [Frequency](./aws-properties-groundstation-config-frequency.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html#cfn-groundstation-config-spectrumconfig-centerfrequency", "UpdateType": "Mutable", "Required": false, "Type": "Frequency" } } }, "AWS::GroundStation::Config.TrackingConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.TrackingConfig`\n\nProvides information about how AWS Ground Station should track the satellite through the sky during a contact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-trackingconfig.html", "Properties": { "Autotrack": { "MarkdownDocumentation": "`Autotrack`\n\nSpecifies whether or not to use autotrack.\n`REMOVED` specifies that program track should only be used during the contact.\n`PREFERRED` specifies that autotracking is preferred during the contact but fallback to program track if the signal is lost.\n`REQUIRED` specifies that autotracking is required during the contact and not to use program track if the signal is lost.\n*Required*: No\n*Type*: String\n*Allowed values*: `REQUIRED | PREFERRED | REMO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REQUIRED", "PREFERRED", "REMOVED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-trackingconfig.html#cfn-groundstation-config-trackingconfig-autotrack", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.UplinkEchoConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.UplinkEchoConfig`\n\nProvides information about how AWS Ground Station should echo back uplink transmissions to a dataflow endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkechoconfig.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhether or not uplink echo 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkechoconfig.html#cfn-groundstation-config-uplinkechoconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AntennaUplinkConfigArn": { "MarkdownDocumentation": "`AntennaUplinkConfigArn`\n\nDefines the ARN of the uplink config to echo back to a dataflow endpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkechoconfig.html#cfn-groundstation-config-uplinkechoconfig-antennauplinkconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::Config.UplinkSpectrumConfig": { "MarkdownDocumentation": "`AWS::GroundStation::Config.UplinkSpectrumConfig`\n\nDefines a uplink spectrum.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkspectrumconfig.html", "Properties": { "Polarization": { "MarkdownDocumentation": "`Polarization`\n\nThe polarization of the spectrum. Valid values are `\"RIGHT_HAND\"` and `\"LEFT_HAND\"`.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT_HAND | RIGHT_HAND | NO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT_HAND", "RIGHT_HAND", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkspectrumconfig.html#cfn-groundstation-config-uplinkspectrumconfig-polarization", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CenterFrequency": { "MarkdownDocumentation": "`CenterFrequency`\n\nThe center frequency of the spectrum. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.\n*Required*: No\n*Type*: [Frequency](./aws-properties-groundstation-config-frequency.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkspectrumconfig.html#cfn-groundstation-config-uplinkspectrumconfig-centerfrequency", "UpdateType": "Mutable", "Required": false, "Type": "Frequency" } } }, "AWS::GroundStation::DataflowEndpointGroup.AwsGroundStationAgentEndpoint": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.AwsGroundStationAgentEndpoint`\n\nInformation about AwsGroundStationAgentEndpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html", "Properties": { "AgentStatus": { "MarkdownDocumentation": "`AgentStatus`\n\nThe status of AgentEndpoint.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUCCESS | FAILED | ACTIVE |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SUCCESS", "FAILED", "ACTIVE", "INACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-agentstatus", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IngressAddress": { "MarkdownDocumentation": "`IngressAddress`\n\nThe ingress address of AgentEndpoint.\n*Required*: No\n*Type*: [RangedConnectionDetails](./aws-properties-groundstation-dataflowendpointgroup-rangedconnectiondetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-ingressaddress", "UpdateType": "Immutable", "Required": false, "Type": "RangedConnectionDetails" }, "AuditResults": { "MarkdownDocumentation": "`AuditResults`\n\nThe results of the audit.\n*Required*: No\n*Type*: String\n*Allowed values*: `HEALTHY | UNHEALTHY...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "HEALTHY", "UNHEALTHY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-auditresults", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `^[ a-zA-Z0-9_:-]{1,256}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EgressAddress": { "MarkdownDocumentation": "`EgressAddress`\n\nThe egress address of AgentEndpoint.\n*Required*: No\n*Type*: [ConnectionDetails](./aws-properties-groundstation-dataflowendpointgroup-connectiondetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-egressaddress", "UpdateType": "Immutable", "Required": false, "Type": "ConnectionDetails" } } }, "AWS::GroundStation::DataflowEndpointGroup.ConnectionDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.ConnectionDetails`\n\nEgress address of AgentEndpoint with an optional mtu.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-connectiondetails.html", "Properties": { "SocketAddress": { "MarkdownDocumentation": "`SocketAddress`\n\nA socket address.\n*Required*: No\n*Type*: [SocketAddress](./aws-properties-groundstation-dataflowendpointgroup-socketaddress.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-connectiondetails.html#cfn-groundstation-dataflowendpointgroup-connectiondetails-socketaddress", "UpdateType": "Immutable", "Required": false, "Type": "SocketAddress" }, "Mtu": { "MarkdownDocumentation": "`Mtu`\n\nMaximum transmission unit (MTU) size in bytes of a dataflow endpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-connectiondetails.html#cfn-groundstation-dataflowendpointgroup-connectiondetails-mtu", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GroundStation::DataflowEndpointGroup.DataflowEndpoint": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.DataflowEndpoint`\n\nContains information such as socket address and name that defines an endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe address and port of an endpoint.\n*Required*: No\n*Type*: [SocketAddress](./aws-properties-groundstation-dataflowendpointgroup-socketaddress.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html#cfn-groundstation-dataflowendpointgroup-dataflowendpoint-address", "UpdateType": "Immutable", "Required": false, "Type": "SocketAddress" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe endpoint name.\nWhen listing available contacts for a satellite, Ground Station searches for a dataflow endpoint whose name matches the value specified by the dataflow endpoint config of the selected mission profile. If no matching dataflow endpoints are found then Ground Station will not display any available contacts for the satellite.\n*Required*: No\n*Type*: String\n*Pattern*: `^[ a-zA-Z0-9_:-]{1,256}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html#cfn-groundstation-dataflowendpointgroup-dataflowendpoint-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Mtu": { "MarkdownDocumentation": "`Mtu`\n\nMaximum transmission unit (MTU) size in bytes of a dataflow endpoint.\nValid values are between 1400 and 1500. A default value of 1500 is used if not set.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1400`\n*Maximum*: `1500`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html#cfn-groundstation-dataflowendpointgroup-dataflowendpoint-mtu", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GroundStation::DataflowEndpointGroup.EndpointDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.EndpointDetails`\n\nThe security details and endpoint information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html", "Properties": { "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nInformation about the endpoint such as name and the endpoint address.\n*Required*: No\n*Type*: [DataflowEndpoint](./aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-endpoint", "UpdateType": "Immutable", "Required": false, "Type": "DataflowEndpoint" }, "AwsGroundStationAgentEndpoint": { "MarkdownDocumentation": "`AwsGroundStationAgentEndpoint`\n\nAn agent endpoint.\n*Required*: No\n*Type*: [AwsGroundStationAgentEndpoint](./aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-awsgroundstationagentendpoint", "UpdateType": "Immutable", "Required": false, "Type": "AwsGroundStationAgentEndpoint" }, "SecurityDetails": { "MarkdownDocumentation": "`SecurityDetails`\n\nThe role ARN, and IDs for security groups and subnets.\n*Required*: No\n*Type*: [SecurityDetails](./aws-properties-groundstation-dataflowendpointgroup-securitydetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-securitydetails", "UpdateType": "Immutable", "Required": false, "Type": "SecurityDetails" } } }, "AWS::GroundStation::DataflowEndpointGroup.IntegerRange": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.IntegerRange`\n\nAn integer range that has a minimum and maximum value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-integerrange.html", "Properties": { "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nA minimum value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-integerrange.html#cfn-groundstation-dataflowendpointgroup-integerrange-minimum", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Maximum": { "MarkdownDocumentation": "`Maximum`\n\nA maximum value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-integerrange.html#cfn-groundstation-dataflowendpointgroup-integerrange-maximum", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GroundStation::DataflowEndpointGroup.RangedConnectionDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.RangedConnectionDetails`\n\nIngress address of AgentEndpoint with a port range and an optional mtu.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedconnectiondetails.html", "Properties": { "SocketAddress": { "MarkdownDocumentation": "`SocketAddress`\n\nA ranged socket address.\n*Required*: No\n*Type*: [RangedSocketAddress](./aws-properties-groundstation-dataflowendpointgroup-rangedsocketaddress.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedconnectiondetails.html#cfn-groundstation-dataflowendpointgroup-rangedconnectiondetails-socketaddress", "UpdateType": "Immutable", "Required": false, "Type": "RangedSocketAddress" }, "Mtu": { "MarkdownDocumentation": "`Mtu`\n\nMaximum transmission unit (MTU) size in bytes of a dataflow endpoint.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1400`\n*Maximum*: `1500`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedconnectiondetails.html#cfn-groundstation-dataflowendpointgroup-rangedconnectiondetails-mtu", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GroundStation::DataflowEndpointGroup.RangedSocketAddress": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.RangedSocketAddress`\n\nA socket address with a port range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedsocketaddress.html", "Properties": { "PortRange": { "MarkdownDocumentation": "`PortRange`\n\nPort range of a socket address.\n*Required*: No\n*Type*: [IntegerRange](./aws-properties-groundstation-dataflowendpointgroup-integerrange.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedsocketaddress.html#cfn-groundstation-dataflowendpointgroup-rangedsocketaddress-portrange", "UpdateType": "Immutable", "Required": false, "Type": "IntegerRange" }, "Name": { "MarkdownDocumentation": "`Name`\n\nIPv4 socket address.\n*Required*: No\n*Type*: String\n*Pattern*: `\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}`\n*Minimum*: `7`\n*Maximum*: `16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedsocketaddress.html#cfn-groundstation-dataflowendpointgroup-rangedsocketaddress-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroup.SecurityDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.SecurityDetails`\n\nInformation about IAM roles, subnets, and security groups needed for this DataflowEndpointGroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html", "Properties": { "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe subnet Ids of the security details, such as\n`subnet-12345678`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-subnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe security group Ids of the security role, such as\n`sg-1234567890abcdef0`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-securitygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of a role which Ground Station has permission to assume, such as\n`arn:aws:iam::1234567890:role/DataDeliveryServiceRole`.\nGround Station will assume this role and create an ENI in your VPC on the specified subnet upon creation of a dataflow endpoint group. This ENI is used as the ingress/egress point for data streamed during a satellite contact.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-rolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroup.SocketAddress": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup.SocketAddress`\n\nThe address of the endpoint, such as\n`192.168.1.1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nThe port of the endpoint, such as\n`55888`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html#cfn-groundstation-dataflowendpointgroup-socketaddress-port", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the endpoint, such as\n`Endpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html#cfn-groundstation-dataflowendpointgroup-socketaddress-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.ConnectionDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.ConnectionDetails`\n\nEgress address of AgentEndpoint with an optional mtu.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-connectiondetails.html", "Properties": { "SocketAddress": { "MarkdownDocumentation": "`SocketAddress`\n\nA socket address.\n*Required*: Yes\n*Type*: [SocketAddress](./aws-properties-groundstation-dataflowendpointgroupv2-socketaddress.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-connectiondetails.html#cfn-groundstation-dataflowendpointgroupv2-connectiondetails-socketaddress", "UpdateType": "Conditional", "Required": true, "Type": "SocketAddress" }, "Mtu": { "MarkdownDocumentation": "`Mtu`\n\nMaximum transmission unit (MTU) size in bytes of a dataflow endpoint.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1400`\n*Maximum*: `1500`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-connectiondetails.html#cfn-groundstation-dataflowendpointgroupv2-connectiondetails-mtu", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.CreateEndpointDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.CreateEndpointDetails`\n\nEndpoint definition used for creating a dataflow endpoint\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-createendpointdetails.html", "Properties": { "UplinkAwsGroundStationAgentEndpoint": { "MarkdownDocumentation": "`UplinkAwsGroundStationAgentEndpoint`\n\nDefinition for an uplink agent endpoint\n*Required*: No\n*Type*: [UplinkAwsGroundStationAgentEndpoint](./aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpoint.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-createendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-createendpointdetails-uplinkawsgroundstationagentendpoint", "UpdateType": "Immutable", "Required": false, "Type": "UplinkAwsGroundStationAgentEndpoint" }, "DownlinkAwsGroundStationAgentEndpoint": { "MarkdownDocumentation": "`DownlinkAwsGroundStationAgentEndpoint`\n\nDefinition for a downlink agent endpoint\n*Required*: No\n*Type*: [DownlinkAwsGroundStationAgentEndpoint](./aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpoint.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-createendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-createendpointdetails-downlinkawsgroundstationagentendpoint", "UpdateType": "Immutable", "Required": false, "Type": "DownlinkAwsGroundStationAgentEndpoint" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.DownlinkAwsGroundStationAgentEndpoint": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.DownlinkAwsGroundStationAgentEndpoint`\n\nDefinition for a downlink agent endpoint\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpoint.html", "Properties": { "DataflowDetails": { "MarkdownDocumentation": "`DataflowDetails`\n\nDataflow details for the downlink endpoint\n*Required*: Yes\n*Type*: [DownlinkDataflowDetails](./aws-properties-groundstation-dataflowendpointgroupv2-downlinkdataflowdetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpoint-dataflowdetails", "UpdateType": "Immutable", "Required": true, "Type": "DownlinkDataflowDetails" }, "Name": { "MarkdownDocumentation": "`Name`\n\nDownlink dataflow endpoint name\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ a-zA-Z0-9_:-]{1,256}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpoint-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.DownlinkAwsGroundStationAgentEndpointDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.DownlinkAwsGroundStationAgentEndpointDetails`\n\nDetails for a downlink agent endpoint\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails.html", "Properties": { "AgentStatus": { "MarkdownDocumentation": "`AgentStatus`\n\nStatus of the agent associated with the downlink dataflow endpoint\n*Required*: No\n*Type*: String\n*Allowed values*: `SUCCESS | FAILED | ACTIVE |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUCCESS", "FAILED", "ACTIVE", "INACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails-agentstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuditResults": { "MarkdownDocumentation": "`AuditResults`\n\nHealth audit results for the downlink dataflow endpoint\n*Required*: No\n*Type*: String\n*Allowed values*: `HEALTHY | UNHEALTHY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HEALTHY", "UNHEALTHY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails-auditresults", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataflowDetails": { "MarkdownDocumentation": "`DataflowDetails`\n\nDataflow details for the downlink endpoint\n*Required*: Yes\n*Type*: [DownlinkDataflowDetails](./aws-properties-groundstation-dataflowendpointgroupv2-downlinkdataflowdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails-dataflowdetails", "UpdateType": "Mutable", "Required": true, "Type": "DownlinkDataflowDetails" }, "Name": { "MarkdownDocumentation": "`Name`\n\nDownlink dataflow endpoint name\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ a-zA-Z0-9_:-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.DownlinkConnectionDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.DownlinkConnectionDetails`\n\nConnection details for Ground Station to Agent and Agent to customer\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkconnectiondetails.html", "Properties": { "EgressAddressAndPort": { "MarkdownDocumentation": "`EgressAddressAndPort`\n\nEgress address and port for the downlink connection.\n*Required*: Yes\n*Type*: [ConnectionDetails](./aws-properties-groundstation-dataflowendpointgroupv2-connectiondetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkconnectiondetails.html#cfn-groundstation-dataflowendpointgroupv2-downlinkconnectiondetails-egressaddressandport", "UpdateType": "Conditional", "Required": true, "Type": "ConnectionDetails" }, "AgentIpAndPortAddress": { "MarkdownDocumentation": "`AgentIpAndPortAddress`\n\nAgent IP and port address for the downlink connection.\n*Required*: Yes\n*Type*: [RangedConnectionDetails](./aws-properties-groundstation-dataflowendpointgroupv2-rangedconnectiondetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkconnectiondetails.html#cfn-groundstation-dataflowendpointgroupv2-downlinkconnectiondetails-agentipandportaddress", "UpdateType": "Conditional", "Required": true, "Type": "RangedConnectionDetails" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.DownlinkDataflowDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.DownlinkDataflowDetails`\n\nDataflow details for a downlink endpoint\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkdataflowdetails.html", "Properties": { "AgentConnectionDetails": { "MarkdownDocumentation": "`AgentConnectionDetails`\n\nDownlink connection details for customer to Agent and Agent to Ground Station\n*Required*: No\n*Type*: [DownlinkConnectionDetails](./aws-properties-groundstation-dataflowendpointgroupv2-downlinkconnectiondetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-downlinkdataflowdetails.html#cfn-groundstation-dataflowendpointgroupv2-downlinkdataflowdetails-agentconnectiondetails", "UpdateType": "Conditional", "Required": true, "Type": "DownlinkConnectionDetails" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.EndpointDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.EndpointDetails`\n\nInformation about the endpoint details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-endpointdetails.html", "Properties": { "UplinkAwsGroundStationAgentEndpoint": { "MarkdownDocumentation": "`UplinkAwsGroundStationAgentEndpoint`\n\nDefinition for an uplink agent endpoint\n*Required*: No\n*Type*: [UplinkAwsGroundStationAgentEndpointDetails](./aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-endpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-endpointdetails-uplinkawsgroundstationagentendpoint", "UpdateType": "Mutable", "Required": false, "Type": "UplinkAwsGroundStationAgentEndpointDetails" }, "DownlinkAwsGroundStationAgentEndpoint": { "MarkdownDocumentation": "`DownlinkAwsGroundStationAgentEndpoint`\n\nDefinition for a downlink agent endpoint\n*Required*: No\n*Type*: [DownlinkAwsGroundStationAgentEndpointDetails](./aws-properties-groundstation-dataflowendpointgroupv2-downlinkawsgroundstationagentendpointdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-endpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-endpointdetails-downlinkawsgroundstationagentendpoint", "UpdateType": "Mutable", "Required": false, "Type": "DownlinkAwsGroundStationAgentEndpointDetails" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.IntegerRange": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.IntegerRange`\n\nAn integer range that has a minimum and maximum value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-integerrange.html", "Properties": { "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nA minimum 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-integerrange.html#cfn-groundstation-dataflowendpointgroupv2-integerrange-minimum", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "Integer" }, "Maximum": { "MarkdownDocumentation": "`Maximum`\n\nA maximum 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-integerrange.html#cfn-groundstation-dataflowendpointgroupv2-integerrange-maximum", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.RangedConnectionDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.RangedConnectionDetails`\n\nIngress address of AgentEndpoint with a port range and an optional mtu.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-rangedconnectiondetails.html", "Properties": { "SocketAddress": { "MarkdownDocumentation": "`SocketAddress`\n\nA ranged socket address.\n*Required*: Yes\n*Type*: [RangedSocketAddress](./aws-properties-groundstation-dataflowendpointgroupv2-rangedsocketaddress.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-rangedconnectiondetails.html#cfn-groundstation-dataflowendpointgroupv2-rangedconnectiondetails-socketaddress", "UpdateType": "Conditional", "Required": true, "Type": "RangedSocketAddress" }, "Mtu": { "MarkdownDocumentation": "`Mtu`\n\nMaximum transmission unit (MTU) size in bytes of a dataflow endpoint.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1400`\n*Maximum*: `1500`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-rangedconnectiondetails.html#cfn-groundstation-dataflowendpointgroupv2-rangedconnectiondetails-mtu", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.RangedSocketAddress": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.RangedSocketAddress`\n\nA socket address with a port range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-rangedsocketaddress.html", "Properties": { "PortRange": { "MarkdownDocumentation": "`PortRange`\n\nPort range of a socket address.\n*Required*: Yes\n*Type*: [IntegerRange](./aws-properties-groundstation-dataflowendpointgroupv2-integerrange.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-rangedsocketaddress.html#cfn-groundstation-dataflowendpointgroupv2-rangedsocketaddress-portrange", "UpdateType": "Conditional", "Required": true, "Type": "IntegerRange" }, "Name": { "MarkdownDocumentation": "`Name`\n\nIPv4 socket address.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-rangedsocketaddress.html#cfn-groundstation-dataflowendpointgroupv2-rangedsocketaddress-name", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.SocketAddress": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.SocketAddress`\n\nInformation about the socket address.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-socketaddress.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort of a socket address.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-socketaddress.html#cfn-groundstation-dataflowendpointgroupv2-socketaddress-port", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of a socket address.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-socketaddress.html#cfn-groundstation-dataflowendpointgroupv2-socketaddress-name", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.UplinkAwsGroundStationAgentEndpoint": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.UplinkAwsGroundStationAgentEndpoint`\n\nDefinition for an uplink agent endpoint\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpoint.html", "Properties": { "DataflowDetails": { "MarkdownDocumentation": "`DataflowDetails`\n\nDataflow details for the uplink endpoint\n*Required*: Yes\n*Type*: [UplinkDataflowDetails](./aws-properties-groundstation-dataflowendpointgroupv2-uplinkdataflowdetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpoint-dataflowdetails", "UpdateType": "Immutable", "Required": true, "Type": "UplinkDataflowDetails" }, "Name": { "MarkdownDocumentation": "`Name`\n\nUplink dataflow endpoint name\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ a-zA-Z0-9_:-]{1,256}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpoint-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.UplinkAwsGroundStationAgentEndpointDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.UplinkAwsGroundStationAgentEndpointDetails`\n\nDetails for an uplink agent endpoint\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails.html", "Properties": { "AgentStatus": { "MarkdownDocumentation": "`AgentStatus`\n\nStatus of the agent associated with the uplink dataflow endpoint\n*Required*: No\n*Type*: String\n*Allowed values*: `SUCCESS | FAILED | ACTIVE |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUCCESS", "FAILED", "ACTIVE", "INACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails-agentstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuditResults": { "MarkdownDocumentation": "`AuditResults`\n\nHealth audit results for the uplink dataflow endpoint\n*Required*: No\n*Type*: String\n*Allowed values*: `HEALTHY | UNHEALTHY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HEALTHY", "UNHEALTHY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails-auditresults", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataflowDetails": { "MarkdownDocumentation": "`DataflowDetails`\n\nDataflow details for the uplink endpoint\n*Required*: Yes\n*Type*: [UplinkDataflowDetails](./aws-properties-groundstation-dataflowendpointgroupv2-uplinkdataflowdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails-dataflowdetails", "UpdateType": "Mutable", "Required": true, "Type": "UplinkDataflowDetails" }, "Name": { "MarkdownDocumentation": "`Name`\n\nUplink dataflow endpoint name\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ a-zA-Z0-9_:-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails.html#cfn-groundstation-dataflowendpointgroupv2-uplinkawsgroundstationagentendpointdetails-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.UplinkConnectionDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.UplinkConnectionDetails`\n\nConnection details for customer to Agent and Agent to Ground Station\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkconnectiondetails.html", "Properties": { "AgentIpAndPortAddress": { "MarkdownDocumentation": "`AgentIpAndPortAddress`\n\nAgent IP and port address for the uplink connection.\n*Required*: Yes\n*Type*: [RangedConnectionDetails](./aws-properties-groundstation-dataflowendpointgroupv2-rangedconnectiondetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkconnectiondetails.html#cfn-groundstation-dataflowendpointgroupv2-uplinkconnectiondetails-agentipandportaddress", "UpdateType": "Conditional", "Required": true, "Type": "RangedConnectionDetails" }, "IngressAddressAndPort": { "MarkdownDocumentation": "`IngressAddressAndPort`\n\nIngress address and port for the uplink connection.\n*Required*: Yes\n*Type*: [ConnectionDetails](./aws-properties-groundstation-dataflowendpointgroupv2-connectiondetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkconnectiondetails.html#cfn-groundstation-dataflowendpointgroupv2-uplinkconnectiondetails-ingressaddressandport", "UpdateType": "Conditional", "Required": true, "Type": "ConnectionDetails" } } }, "AWS::GroundStation::DataflowEndpointGroupV2.UplinkDataflowDetails": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2.UplinkDataflowDetails`\n\nDataflow details for an uplink endpoint\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkdataflowdetails.html", "Properties": { "AgentConnectionDetails": { "MarkdownDocumentation": "`AgentConnectionDetails`\n\nUplink connection details for customer to Agent and Agent to Ground Station\n*Required*: No\n*Type*: [UplinkConnectionDetails](./aws-properties-groundstation-dataflowendpointgroupv2-uplinkconnectiondetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroupv2-uplinkdataflowdetails.html#cfn-groundstation-dataflowendpointgroupv2-uplinkdataflowdetails-agentconnectiondetails", "UpdateType": "Conditional", "Required": true, "Type": "UplinkConnectionDetails" } } }, "AWS::GroundStation::MissionProfile.DataflowEdge": { "MarkdownDocumentation": "`AWS::GroundStation::MissionProfile.DataflowEdge`\n\nA dataflow edge defines from where and to where data will flow during a contact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-dataflowedge.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe ARN of the destination for this dataflow edge.\nFor example, specify the ARN of a dataflow endpoint config for a downlink edge or an antenna uplink config for an uplink edge.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-dataflowedge.html#cfn-groundstation-missionprofile-dataflowedge-destination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe ARN of the source for this dataflow edge.\nFor example, specify the ARN of an antenna downlink config for a downlink edge or a dataflow endpoint config for an uplink edge.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-dataflowedge.html#cfn-groundstation-missionprofile-dataflowedge-source", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GroundStation::MissionProfile.StreamsKmsKey": { "MarkdownDocumentation": "`AWS::GroundStation::MissionProfile.StreamsKmsKey`\n\nKMS key info.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-streamskmskey.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nKMS Key Arn.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-streamskmskey.html#cfn-groundstation-missionprofile-streamskmskey-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsAliasArn": { "MarkdownDocumentation": "`KmsAliasArn`\n\nKMS Alias Arn.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-streamskmskey.html#cfn-groundstation-missionprofile-streamskmskey-kmsaliasarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsAliasName": { "MarkdownDocumentation": "`KmsAliasName`\n\nKMS Alias Name.\n*Required*: No\n*Type*: String\n*Pattern*: `^alias/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-streamskmskey.html#cfn-groundstation-missionprofile-streamskmskey-kmsaliasname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GuardDuty::Detector.CFNDataSourceConfigurations": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.CFNDataSourceConfigurations`\n\nDescribes whether S3 data event logs, Kubernetes audit logs, or Malware Protection will\nbe enabled as a data source when the detector is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfndatasourceconfigurations.html", "Properties": { "MalwareProtection": { "MarkdownDocumentation": "`MalwareProtection`\n\nDescribes whether Malware Protection will be enabled as a data source.\n*Required*: No\n*Type*: [CFNMalwareProtectionConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfndatasourceconfigurations.html#cfn-guardduty-detector-cfndatasourceconfigurations-malwareprotection", "UpdateType": "Mutable", "Required": false, "Type": "CFNMalwareProtectionConfiguration" }, "S3Logs": { "MarkdownDocumentation": "`S3Logs`\n\nDescribes whether S3 data event logs are enabled as a data source.\n*Required*: No\n*Type*: [CFNS3LogsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfndatasourceconfigurations.html#cfn-guardduty-detector-cfndatasourceconfigurations-s3logs", "UpdateType": "Mutable", "Required": false, "Type": "CFNS3LogsConfiguration" }, "Kubernetes": { "MarkdownDocumentation": "`Kubernetes`\n\nDescribes which Kubernetes data sources are enabled for a detector.\n*Required*: No\n*Type*: [CFNKubernetesConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfndatasourceconfigurations.html#cfn-guardduty-detector-cfndatasourceconfigurations-kubernetes", "UpdateType": "Mutable", "Required": false, "Type": "CFNKubernetesConfiguration" } } }, "AWS::GuardDuty::Detector.CFNFeatureAdditionalConfiguration": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.CFNFeatureAdditionalConfiguration`\n\nInformation about the additional configuration of a feature in your account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureadditionalconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nStatus of the additional configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureadditionalconfiguration.html#cfn-guardduty-detector-cfnfeatureadditionalconfiguration-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the additional configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureadditionalconfiguration.html#cfn-guardduty-detector-cfnfeatureadditionalconfiguration-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GuardDuty::Detector.CFNFeatureConfiguration": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.CFNFeatureConfiguration`\n\nInformation about the configuration of a feature in your account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nStatus of the feature configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureconfiguration.html#cfn-guardduty-detector-cfnfeatureconfiguration-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AdditionalConfiguration": { "MarkdownDocumentation": "`AdditionalConfiguration`\n\nInformation about the additional configuration of a feature in your account.\n*Required*: No\n*Type*: Array of [CFNFeatureAdditionalConfiguration](./aws-properties-guardduty-detector-cfnfeatureadditionalconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureconfiguration.html#cfn-guardduty-detector-cfnfeatureconfiguration-additionalconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CFNFeatureAdditionalConfiguration", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the feature. For a list of allowed values, see [DetectorFeatureConfiguration](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DetectorFeatureConfiguration.html#guardduty-Type-DetectorFeatureConfiguration-name) in the *GuardDuty API Reference*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureconfiguration.html#cfn-guardduty-detector-cfnfeatureconfiguration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::Detector.CFNKubernetesAuditLogsConfiguration": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.CFNKubernetesAuditLogsConfiguration`\n\nDescribes which optional data sources are enabled for a detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesauditlogsconfiguration.html", "Properties": { "Enable": { "MarkdownDocumentation": "`Enable`\n\nDescribes whether Kubernetes audit logs are enabled as a data source for the\ndetector.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesauditlogsconfiguration.html#cfn-guardduty-detector-cfnkubernetesauditlogsconfiguration-enable", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::GuardDuty::Detector.CFNKubernetesConfiguration": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.CFNKubernetesConfiguration`\n\nDescribes which Kubernetes protection data sources are enabled for the detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesconfiguration.html", "Properties": { "AuditLogs": { "MarkdownDocumentation": "`AuditLogs`\n\nDescribes whether Kubernetes audit logs are enabled as a data source for the\ndetector.\n*Required*: Yes\n*Type*: [CFNKubernetesAuditLogsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesconfiguration.html#cfn-guardduty-detector-cfnkubernetesconfiguration-auditlogs", "UpdateType": "Mutable", "Required": true, "Type": "CFNKubernetesAuditLogsConfiguration" } } }, "AWS::GuardDuty::Detector.CFNMalwareProtectionConfiguration": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.CFNMalwareProtectionConfiguration`\n\nDescribes whether Malware Protection will be enabled as a data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnmalwareprotectionconfiguration.html", "Properties": { "ScanEc2InstanceWithFindings": { "MarkdownDocumentation": "`ScanEc2InstanceWithFindings`\n\nDescribes the configuration of Malware Protection for EC2 instances with\nfindings.\n*Required*: No\n*Type*: [CFNScanEc2InstanceWithFindingsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnmalwareprotectionconfiguration.html#cfn-guardduty-detector-cfnmalwareprotectionconfiguration-scanec2instancewithfindings", "UpdateType": "Mutable", "Required": false, "Type": "CFNScanEc2InstanceWithFindingsConfiguration" } } }, "AWS::GuardDuty::Detector.CFNS3LogsConfiguration": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.CFNS3LogsConfiguration`\n\nDescribes whether S3 data event logs will be enabled as a data source when the detector\nis created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfns3logsconfiguration.html", "Properties": { "Enable": { "MarkdownDocumentation": "`Enable`\n\nThe status of S3 data event logs as a data source.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfns3logsconfiguration.html#cfn-guardduty-detector-cfns3logsconfiguration-enable", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::GuardDuty::Detector.CFNScanEc2InstanceWithFindingsConfiguration": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.CFNScanEc2InstanceWithFindingsConfiguration`\n\nDescribes whether Malware Protection for EC2 instances with findings will be enabled as\na data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnscanec2instancewithfindingsconfiguration.html", "Properties": { "EbsVolumes": { "MarkdownDocumentation": "`EbsVolumes`\n\nDescribes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnscanec2instancewithfindingsconfiguration.html#cfn-guardduty-detector-cfnscanec2instancewithfindingsconfiguration-ebsvolumes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::GuardDuty::Detector.TagItem": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector.TagItem`\n\nDescribes a tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-tagitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-tagitem.html#cfn-guardduty-detector-tagitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-tagitem.html#cfn-guardduty-detector-tagitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::Filter.Condition": { "MarkdownDocumentation": "`AWS::GuardDuty::Filter.Condition`\n\nSpecifies the condition to apply to a single field when filtering through GuardDuty findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html", "Properties": { "Equals": { "MarkdownDocumentation": "`Equals`\n\nRepresents an *equal* condition to be applied to\na single field when querying for findings.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-equals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LessThan": { "MarkdownDocumentation": "`LessThan`\n\nRepresents a *less than* condition to be applied to a single field when\nquerying 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-lessthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "LessThanOrEqual": { "MarkdownDocumentation": "`LessThanOrEqual`\n\nRepresents a *less than or equal* condition to be applied to a single\nfield 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-lessthanorequal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "GreaterThan": { "MarkdownDocumentation": "`GreaterThan`\n\nRepresents a *greater than* condition to be applied to a single field\nwhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-greaterthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "Lt": { "MarkdownDocumentation": "`Lt`\n\nRepresents the less than condition to apply to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-lt", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Gte": { "MarkdownDocumentation": "`Gte`\n\nRepresents the greater than or equal condition to apply to a single field when querying\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-gte", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Neq": { "MarkdownDocumentation": "`Neq`\n\nRepresents the not equal condition to apply to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-neq", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "GreaterThanOrEqual": { "MarkdownDocumentation": "`GreaterThanOrEqual`\n\nRepresents a *greater than or equal* condition to be applied to a\nsingle 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-greaterthanorequal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "Eq": { "MarkdownDocumentation": "`Eq`\n\nRepresents the equal condition to apply to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-eq", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Lte": { "MarkdownDocumentation": "`Lte`\n\nRepresents the less than or equal condition to apply to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-lte", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Gt": { "MarkdownDocumentation": "`Gt`\n\nRepresents a *greater than* condition to be applied to a single field\nwhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-gt", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NotEquals": { "MarkdownDocumentation": "`NotEquals`\n\nRepresents a *not equal* condition to be applied\nto a single field when querying for findings.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-notequals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::GuardDuty::Filter.FindingCriteria": { "MarkdownDocumentation": "`AWS::GuardDuty::Filter.FindingCriteria`\n\nRepresents a map of finding properties that match specified conditions and values when\nquerying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-findingcriteria.html", "Properties": { "Criterion": { "MarkdownDocumentation": "`Criterion`\n\nRepresents a map of finding properties that match specified conditions and values when\nquerying findings.\nFor information about JSON criterion mapping to their console equivalent, see [Finding\ncriteria](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html#filter_criteria). The following are the available criterion:\n* accountId\n* id\n* region\n* severity\n \n To filter on the basis of severity, the API and AWS CLI use the\n following input list for the `FindingCriteria` condition:\n \n + **Low**: `[\"1\", \"2\", \"3\"]`\n + **Medium**: `[\"4\", \"5\", \"6\"]`\n + **High**: `[\"7\", \"8\", \"9\"]`\n \n For more information, see [Severity levels for GuardDuty findings](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html#guardduty_findings-severity) in the *Amazon GuardDuty User Guide*.\n* type\n* updatedAt\n \n Type: ISO 8601 string format: `YYYY-MM-DDTHH:MM:SS.SSSZ` or\n `YYYY-MM-DDTHH:MM:SSZ` depending on whether the value contains\n milliseconds.\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.tags.key\n* resource.instanceDetails.tags.value\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.outpostArn\n* resource.resourceType\n* resource.s3BucketDetails.publicAccess.effectivePermissions\n* resource.s3BucketDetails.name\n* resource.s3BucketDetails.tags.key\n* resource.s3BucketDetails.tags.value\n* resource.s3BucketDetails.type\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.ipAddressV6\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.dnsRequestAction.domainWithSuffix\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.remoteIpDetails.city.cityName\n* service.action.networkConnectionAction.remoteIpDetails.country.countryName\n* service.action.networkConnectionAction.remoteIpDetails.ipAddressV4\n* service.action.networkConnectionAction.remoteIpDetails.ipAddressV6\n* service.action.networkConnectionAction.remoteIpDetails.organization.asn\n* service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg\n* service.action.networkConnectionAction.remotePortDetails.port\n* service.action.awsApiCallAction.remoteAccountDetails.affiliated\n* service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4\n* service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6\n* service.action.kubernetesApiCallAction.namespace\n* service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn\n* service.action.kubernetesApiCallAction.requestUri\n* service.action.kubernetesApiCallAction.statusCode\n* service.action.networkConnectionAction.localIpDetails.ipAddressV4\n* service.action.networkConnectionAction.localIpDetails.ipAddressV6\n* service.action.networkConnectionAction.protocol\n* service.action.awsApiCallAction.serviceName\n* service.action.awsApiCallAction.remoteAccountDetails.accountId\n* service.additionalInfo.threatListName\n* service.resourceRole\n* resource.eksClusterDetails.name\n* resource.kubernetesDetails.kubernetesWorkloadDetails.name\n* resource.kubernetesDetails.kubernetesWorkloadDetails.namespace\n* resource.kubernetesDetails.kubernetesUserDetails.username\n* resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image\n* resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix\n* service.ebsVolumeScanDetails.scanId\n* service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name\n* service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity\n* service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash\n* service.malwareScanDetails.threats.name\n* resource.ecsClusterDetails.name\n* resource.ecsClusterDetails.taskDetails.containers.image\n* resource.ecsClusterDetails.taskDetails.definitionArn\n* resource.containerDetails.image\n* resource.rdsDbInstanceDetails.dbInstanceIdentifier\n* resource.rdsDbInstanceDetails.dbClusterIdentifier\n* resource.rdsDbInstanceDetails.engine\n* resource.rdsDbUserDetails.user\n* resource.rdsDbInstanceDetails.tags.key\n* resource.rdsDbInstanceDetails.tags.value\n* service.runtimeDetails.process.executableSha256\n* service.runtimeDetails.process.name\n* service.runtimeDetails.process.name\n* resource.lambdaDetails.functionName\n* resource.lambdaDetails.functionArn\n* resource.lambdaDetails.tags.key\n* resource.lambdaDetails.tags.value\n*Required*: No\n*Type*: Object of [Condition](./aws-properties-guardduty-filter-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-findingcriteria.html#cfn-guardduty-filter-findingcriteria-criterion", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "Condition" } } }, "AWS::GuardDuty::Filter.TagItem": { "MarkdownDocumentation": "`AWS::GuardDuty::Filter.TagItem`\n\nDescribes a tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-tagitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-tagitem.html#cfn-guardduty-filter-tagitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-tagitem.html#cfn-guardduty-filter-tagitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::IPSet.TagItem": { "MarkdownDocumentation": "`AWS::GuardDuty::IPSet.TagItem`\n\nDescribes a tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-ipset-tagitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-ipset-tagitem.html#cfn-guardduty-ipset-tagitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-ipset-tagitem.html#cfn-guardduty-ipset-tagitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::MalwareProtectionPlan.CFNActions": { "MarkdownDocumentation": "`AWS::GuardDuty::MalwareProtectionPlan.CFNActions`\n\nSpecifies the action that is to be applied to the Malware Protection plan\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnactions.html", "Properties": { "Tagging": { "MarkdownDocumentation": "`Tagging`\n\nContains information about tagging status of the Malware Protection plan\nresource.\n*Required*: No\n*Type*: [CFNTagging](./aws-properties-guardduty-malwareprotectionplan-cfntagging.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnactions.html#cfn-guardduty-malwareprotectionplan-cfnactions-tagging", "UpdateType": "Mutable", "Required": false, "Type": "CFNTagging" } } }, "AWS::GuardDuty::MalwareProtectionPlan.CFNProtectedResource": { "MarkdownDocumentation": "`AWS::GuardDuty::MalwareProtectionPlan.CFNProtectedResource`\n\nInformation about the protected resource. Presently, `S3Bucket` is the only\nsupported protected resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnprotectedresource.html", "Properties": { "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nInformation about the protected S3 bucket resource.\n*Required*: Yes\n*Type*: [S3Bucket](./aws-properties-guardduty-malwareprotectionplan-s3bucket.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnprotectedresource.html#cfn-guardduty-malwareprotectionplan-cfnprotectedresource-s3bucket", "UpdateType": "Mutable", "Required": true, "Type": "S3Bucket" } } }, "AWS::GuardDuty::MalwareProtectionPlan.CFNStatusReasons": { "MarkdownDocumentation": "`AWS::GuardDuty::MalwareProtectionPlan.CFNStatusReasons`\n\nInformation about the status code and status details associated with the status of the\nMalware Protection plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnstatusreasons.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nIssue message that specifies the reason. For information\nabout potential troubleshooting steps, see\n[Troubleshooting Malware Protection for S3 status issues](https://docs.aws.amazon.com/guardduty/latest/ug/troubleshoot-s3-malware-protection-status-errors.html) in the\n*Amazon GuardDuty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnstatusreasons.html#cfn-guardduty-malwareprotectionplan-cfnstatusreasons-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe status code of the Malware Protection plan. For more information, see [Malware\nProtection plan resource status](https://docs.aws.amazon.com/guardduty/latest/ug/malware-protection-s3-bucket-status-gdu.html) in the *GuardDuty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnstatusreasons.html#cfn-guardduty-malwareprotectionplan-cfnstatusreasons-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GuardDuty::MalwareProtectionPlan.CFNTagging": { "MarkdownDocumentation": "`AWS::GuardDuty::MalwareProtectionPlan.CFNTagging`\n\nContains information about tagging status of the Malware Protection plan\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfntagging.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nIndicates whether or not you chose GuardDuty to add a predefined tag to the\nscanned S3 object.\nPotential values include `ENABLED` and `DISABLED`. These values\nare case-sensitive.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfntagging.html#cfn-guardduty-malwareprotectionplan-cfntagging-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GuardDuty::MalwareProtectionPlan.S3Bucket": { "MarkdownDocumentation": "`AWS::GuardDuty::MalwareProtectionPlan.S3Bucket`\n\nInformation about the protected S3 bucket resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-s3bucket.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nName 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-s3bucket.html#cfn-guardduty-malwareprotectionplan-s3bucket-bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ObjectPrefixes": { "MarkdownDocumentation": "`ObjectPrefixes`\n\nInformation about the specified object prefixes. An S3 object will be scanned only if it\nbelongs to any of the specified object prefixes.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-s3bucket.html#cfn-guardduty-malwareprotectionplan-s3bucket-objectprefixes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::GuardDuty::MalwareProtectionPlan.TagItem": { "MarkdownDocumentation": "`AWS::GuardDuty::MalwareProtectionPlan.TagItem`\n\nDescribes a tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-tagitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-tagitem.html#cfn-guardduty-malwareprotectionplan-tagitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-tagitem.html#cfn-guardduty-malwareprotectionplan-tagitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::PublishingDestination.CFNDestinationProperties": { "MarkdownDocumentation": "`AWS::GuardDuty::PublishingDestination.CFNDestinationProperties`\n\nContains the Amazon Resource Name (ARN) of the resource that receives the published\nfindings, such as an S3 bucket, and the ARN of the KMS key that is used to encrypt these\npublished findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-cfndestinationproperties.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the KMS key to use for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-cfndestinationproperties.html#cfn-guardduty-publishingdestination-cfndestinationproperties-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nThe ARN of the resource where the findings are published.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-cfndestinationproperties.html#cfn-guardduty-publishingdestination-cfndestinationproperties-destinationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GuardDuty::PublishingDestination.TagItem": { "MarkdownDocumentation": "`AWS::GuardDuty::PublishingDestination.TagItem`\n\nDescribes a tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-tagitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-tagitem.html#cfn-guardduty-publishingdestination-tagitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-publishingdestination-tagitem.html#cfn-guardduty-publishingdestination-tagitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::ThreatEntitySet.TagItem": { "MarkdownDocumentation": "`AWS::GuardDuty::ThreatEntitySet.TagItem`\n\nDescribes a tag. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-threatentityset-tagitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value. This is optional.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-threatentityset-tagitem.html#cfn-guardduty-threatentityset-tagitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-threatentityset-tagitem.html#cfn-guardduty-threatentityset-tagitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::ThreatIntelSet.TagItem": { "MarkdownDocumentation": "`AWS::GuardDuty::ThreatIntelSet.TagItem`\n\nDescribes a tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-threatintelset-tagitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-threatintelset-tagitem.html#cfn-guardduty-threatintelset-tagitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-threatintelset-tagitem.html#cfn-guardduty-threatintelset-tagitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::TrustedEntitySet.TagItem": { "MarkdownDocumentation": "`AWS::GuardDuty::TrustedEntitySet.TagItem`\n\nDescribes a tag. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-trustedentityset-tagitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value. This is optional.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-trustedentityset-tagitem.html#cfn-guardduty-trustedentityset-tagitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-trustedentityset-tagitem.html#cfn-guardduty-trustedentityset-tagitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::HealthLake::FHIRDatastore.CreatedAt": { "MarkdownDocumentation": "`AWS::HealthLake::FHIRDatastore.CreatedAt`\n\nThe `CreatedAt` property type specifies Property description not available. for an [AWS::HealthLake::FHIRDatastore](./aws-resource-healthlake-fhirdatastore.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-createdat.html", "Properties": { "Nanos": { "MarkdownDocumentation": "`Nanos`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-createdat.html#cfn-healthlake-fhirdatastore-createdat-nanos", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Seconds": { "MarkdownDocumentation": "`Seconds`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-createdat.html#cfn-healthlake-fhirdatastore-createdat-seconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::HealthLake::FHIRDatastore.IdentityProviderConfiguration": { "MarkdownDocumentation": "`AWS::HealthLake::FHIRDatastore.IdentityProviderConfiguration`\n\nThe identity provider configuration selected when the data store was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html", "Properties": { "AuthorizationStrategy": { "MarkdownDocumentation": "`AuthorizationStrategy`\n\nThe authorization strategy selected when the HealthLake data store is created.\n###### Note\nHealthLake provides support for both SMART on FHIR V1 and V2 as described below.\n* `SMART_ON_FHIR_V1` \u2013 Support for only SMART on FHIR V1, which\n includes `read` (read/search) and `write`\n (create/update/delete) permissions.\n* `SMART_ON_FHIR` \u2013 Support for both SMART on FHIR V1 and V2,\n which includes `create`, `read`, `update`,\n `delete`, and `search` permissions.\n* `AWS_AUTH` \u2013 The default HealthLake authorization\n strategy; not affiliated with SMART on FHIR.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SMART_ON_FHIR_V1 | AWS_AUTH...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SMART_ON_FHIR_V1", "AWS_AUTH", "SMART_ON_FHIR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration-authorizationstrategy", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IdpLambdaArn": { "MarkdownDocumentation": "`IdpLambdaArn`\n\nThe Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the\nauthorization server.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws[-a-z]*:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?`\n*Minimum*: `49`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration-idplambdaarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FineGrainedAuthorizationEnabled": { "MarkdownDocumentation": "`FineGrainedAuthorizationEnabled`\n\nThe parameter to enable SMART on FHIR fine-grained authorization for the data\nstore.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration-finegrainedauthorizationenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Metadata": { "MarkdownDocumentation": "`Metadata`\n\nThe JSON metadata elements to use in your identity provider configuration. Required\nelements are listed based on the launch specification of the SMART application. For more\ninformation on all possible elements, see [Metadata](https://build.fhir.org/ig/HL7/smart-app-launch/conformance.html#metadata) in SMART's App Launch specification.\n`authorization_endpoint`: The URL to the OAuth2 authorization\nendpoint.\n`grant_types_supported`: An array of grant types that are supported at the\ntoken endpoint. You must provide at least one grant type option. Valid options are\n`authorization_code` and `client_credentials`.\n`token_endpoint`: The URL to the OAuth2 token endpoint.\n`capabilities`: An array of strings of the SMART capabilities that the\nauthorization server supports.\n`code_challenge_methods_supported`: An array of strings of supported PKCE\ncode challenge methods. You must include the `S256` method in the array of PKCE\ncode challenge methods.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration-metadata", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::HealthLake::FHIRDatastore.KmsEncryptionConfig": { "MarkdownDocumentation": "`AWS::HealthLake::FHIRDatastore.KmsEncryptionConfig`\n\nThe customer-managed-key(CMK) used when creating a Data Store. If a customer owned key is not specified, an\nAmazon owned key will be used for encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at\nrest.\n*Required*: No\n*Type*: String\n*Pattern*: `(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))`\n*Minimum*: `1`\n*Maximum*: `400`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html#cfn-healthlake-fhirdatastore-kmsencryptionconfig-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CmkType": { "MarkdownDocumentation": "`CmkType`\n\nThe type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned\nCMKs 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*Allowed values*: `CUSTOMER_MANAGED_KMS_KEY | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KMS_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html#cfn-healthlake-fhirdatastore-kmsencryptionconfig-cmktype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::HealthLake::FHIRDatastore.PreloadDataConfig": { "MarkdownDocumentation": "`AWS::HealthLake::FHIRDatastore.PreloadDataConfig`\n\nAn optional parameter to preload (import) open source Synthea FHIR data upon creation of\nthe data store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-preloaddataconfig.html", "Properties": { "PreloadDataType": { "MarkdownDocumentation": "`PreloadDataType`\n\nThe type of preloaded data. Only Synthea preloaded data is supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SYNTHEA`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "SYNTHEA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-preloaddataconfig.html#cfn-healthlake-fhirdatastore-preloaddataconfig-preloaddatatype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::HealthLake::FHIRDatastore.SseConfiguration": { "MarkdownDocumentation": "`AWS::HealthLake::FHIRDatastore.SseConfiguration`\n\nThe server-side encryption key configuration for a customer-provided encryption\nkey.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-sseconfiguration.html", "Properties": { "KmsEncryptionConfig": { "MarkdownDocumentation": "`KmsEncryptionConfig`\n\nThe server-side encryption key configuration for a customer provided encryption\nkey.\n*Required*: Yes\n*Type*: [KmsEncryptionConfig](./aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-sseconfiguration.html#cfn-healthlake-fhirdatastore-sseconfiguration-kmsencryptionconfig", "UpdateType": "Immutable", "Required": true, "Type": "KmsEncryptionConfig" } } }, "AWS::IAM::Group.Policy": { "MarkdownDocumentation": "`AWS::IAM::Group.Policy`\n\nContains information about an attached policy.\nAn attached policy is a managed policy that has been attached to a user, group, or\nrole.\nFor more information about managed policies, see [Managed Policies and Inline\nPolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group-policy.html", "Properties": { "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe friendly name (not ARN) identifying the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group-policy.html#cfn-iam-group-policy-policyname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe policy document.\n*Required*: Yes\n*Type*: Json\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group-policy.html#cfn-iam-group-policy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::IAM::Role.Policy": { "MarkdownDocumentation": "`AWS::IAM::Role.Policy`\n\nContains information about an attached policy.\nAn attached policy is a managed policy that has been attached to a user, group, or\nrole.\nFor more information about managed policies, refer to [Managed Policies and Inline\nPolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-role-policy.html", "Properties": { "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe friendly name (not ARN) identifying the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-role-policy.html#cfn-iam-role-policy-policyname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe entire contents of the policy that defines permissions. For more information, see\n[Overview of JSON\npolicies](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-role-policy.html#cfn-iam-role-policy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::IAM::SAMLProvider.SAMLPrivateKey": { "MarkdownDocumentation": "`AWS::IAM::SAMLProvider.SAMLPrivateKey`\n\nContains the private keys for the SAML provider.\nThis data type is used as a response element in the [GetSAMLProvider](https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetSAMLProvider.html)\noperation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-samlprovider-samlprivatekey.html", "Properties": { "KeyId": { "MarkdownDocumentation": "`KeyId`\n\nThe unique identifier for the SAML private key.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Z0-9]+`\n*Minimum*: `22`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-samlprovider-samlprivatekey.html#cfn-iam-samlprovider-samlprivatekey-keyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Timestamp": { "MarkdownDocumentation": "`Timestamp`\n\nThe date and time, in [ISO 8601 date-time](http://www.iso.org/iso/iso8601) format, when the private key was uploaded.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-samlprovider-samlprivatekey.html#cfn-iam-samlprovider-samlprivatekey-timestamp", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IAM::User.LoginProfile": { "MarkdownDocumentation": "`AWS::IAM::User.LoginProfile`\n\nCreates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about\nmanaging passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html", "Properties": { "PasswordResetRequired": { "MarkdownDocumentation": "`PasswordResetRequired`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html#cfn-iam-user-loginprofile-passwordresetrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe user's password.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html#cfn-iam-user-loginprofile-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IAM::User.Policy": { "MarkdownDocumentation": "`AWS::IAM::User.Policy`\n\nContains information about an attached policy.\nAn attached policy is a managed policy that has been attached to a user, group, or\nrole.\nFor more information about managed policies, refer to [Managed Policies and Inline\nPolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-policy.html", "Properties": { "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe friendly name (not ARN) identifying the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-policy.html#cfn-iam-user-policy-policyname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe entire contents of the policy that defines permissions. For more information, see\n[Overview of JSON\npolicies](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-policy.html#cfn-iam-user-policy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::IdentityStore::GroupMembership.MemberId": { "MarkdownDocumentation": "`AWS::IdentityStore::GroupMembership.MemberId`\n\nAn object that contains the identifier of a group member. Setting the\n`UserID` field to the specific identifier for a user indicates that the user\nis a member of the group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-groupmembership-memberid.html", "Properties": { "UserId": { "MarkdownDocumentation": "`UserId`\n\nAn object containing the identifiers of resources that can be members.\n*Required*: Yes\n*Type*: String\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*Minimum*: `1`\n*Maximum*: `47`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-groupmembership-memberid.html#cfn-identitystore-groupmembership-memberid-userid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::Component.LatestVersion": { "MarkdownDocumentation": "`AWS::ImageBuilder::Component.LatestVersion`\n\nThe resource ARNs with different wildcard variations of semantic versioning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-component-latestversion.html", "Properties": { "Major": { "MarkdownDocumentation": "`Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-component-latestversion.html#cfn-imagebuilder-component-latestversion-major", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Minor": { "MarkdownDocumentation": "`Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-component-latestversion.html#cfn-imagebuilder-component-latestversion-minor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-component-latestversion.html#cfn-imagebuilder-component-latestversion-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Patch": { "MarkdownDocumentation": "`Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-component-latestversion.html#cfn-imagebuilder-component-latestversion-patch", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ContainerRecipe.ComponentConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ContainerRecipe.ComponentConfiguration`\n\nConfiguration details of the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nA group of parameter settings that Image Builder uses to configure the component for a specific\nrecipe.\n*Required*: No\n*Type*: Array of [ComponentParameter](./aws-properties-imagebuilder-containerrecipe-componentparameter.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html#cfn-imagebuilder-containerrecipe-componentconfiguration-parameters", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ComponentParameter", "DuplicatesAllowed": true }, "ComponentArn": { "MarkdownDocumentation": "`ComponentArn`\n\nThe Amazon Resource Name (ARN) of the component.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html#cfn-imagebuilder-containerrecipe-componentconfiguration-componentarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ContainerRecipe.ComponentParameter": { "MarkdownDocumentation": "`AWS::ImageBuilder::ContainerRecipe.ComponentParameter`\n\nContains a key/value pair that sets the named component parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nSets the value for the named component parameter.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentparameter.html#cfn-imagebuilder-containerrecipe-componentparameter-value", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the component parameter to set.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^\\x00]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentparameter.html#cfn-imagebuilder-containerrecipe-componentparameter-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ContainerRecipe.EbsInstanceBlockDeviceSpecification": { "MarkdownDocumentation": "`AWS::ImageBuilder::ContainerRecipe.EbsInstanceBlockDeviceSpecification`\n\nAmazon EBS-specific block device mapping specifications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html", "Properties": { "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe snapshot that defines the device contents.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-snapshotid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nUse to override the device's volume type.\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | io1 | io2 | gp2 ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "standard", "io1", "io2", "gp2", "gp3", "sc1", "st1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-volumetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device.\nThis can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)\nin the *AWS Key Management Service Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nUse to configure device 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-encrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Throughput": { "MarkdownDocumentation": "`Throughput`\n\n**For GP3 volumes only** \u2013 The throughput in MiB/s\nthat the volume supports.\n*Required*: No\n*Type*: Integer\n*Minimum*: `125`\n*Maximum*: `1000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-throughput", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nUse to configure device IOPS.\n*Required*: No\n*Type*: Integer\n*Minimum*: `100`\n*Maximum*: `64000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-iops", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nUse to override the device's volume size.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `16000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-volumesize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nUse 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification-deleteontermination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::ContainerRecipe.InstanceBlockDeviceMapping": { "MarkdownDocumentation": "`AWS::ImageBuilder::ContainerRecipe.InstanceBlockDeviceMapping`\n\nDefines block device mappings for the instance used to configure your image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html", "Properties": { "Ebs": { "MarkdownDocumentation": "`Ebs`\n\nUse to manage Amazon EBS-specific configuration for this mapping.\n*Required*: No\n*Type*: [EbsInstanceBlockDeviceSpecification](./aws-properties-imagebuilder-containerrecipe-ebsinstanceblockdevicespecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html#cfn-imagebuilder-containerrecipe-instanceblockdevicemapping-ebs", "UpdateType": "Immutable", "Required": false, "Type": "EbsInstanceBlockDeviceSpecification" }, "NoDevice": { "MarkdownDocumentation": "`NoDevice`\n\nUse to remove a mapping from the base image.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `0`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html#cfn-imagebuilder-containerrecipe-instanceblockdevicemapping-nodevice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VirtualName": { "MarkdownDocumentation": "`VirtualName`\n\nUse to manage instance ephemeral devices.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html#cfn-imagebuilder-containerrecipe-instanceblockdevicemapping-virtualname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe device to which these mappings apply.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html#cfn-imagebuilder-containerrecipe-instanceblockdevicemapping-devicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ContainerRecipe.InstanceConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ContainerRecipe.InstanceConfiguration`\n\nDefines a custom base AMI and block device mapping configurations of an instance\nused for building and testing container images.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceconfiguration.html", "Properties": { "BlockDeviceMappings": { "MarkdownDocumentation": "`BlockDeviceMappings`\n\nDefines the block devices to attach for building an instance from this Image Builder\nAMI.\n*Required*: No\n*Type*: Array of [InstanceBlockDeviceMapping](./aws-properties-imagebuilder-containerrecipe-instanceblockdevicemapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceconfiguration.html#cfn-imagebuilder-containerrecipe-instanceconfiguration-blockdevicemappings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "InstanceBlockDeviceMapping", "DuplicatesAllowed": true }, "Image": { "MarkdownDocumentation": "`Image`\n\nThe base image for a container build and test instance. This can contain an AMI ID\nor it can specify an AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by `ssm:`,\nfollowed by the parameter name or ARN.\nIf not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceconfiguration.html#cfn-imagebuilder-containerrecipe-instanceconfiguration-image", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ContainerRecipe.LatestVersion": { "MarkdownDocumentation": "`AWS::ImageBuilder::ContainerRecipe.LatestVersion`\n\nThe resource ARNs with different wildcard variations of semantic versioning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-latestversion.html", "Properties": { "Major": { "MarkdownDocumentation": "`Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-latestversion.html#cfn-imagebuilder-containerrecipe-latestversion-major", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Minor": { "MarkdownDocumentation": "`Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-latestversion.html#cfn-imagebuilder-containerrecipe-latestversion-minor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-latestversion.html#cfn-imagebuilder-containerrecipe-latestversion-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Patch": { "MarkdownDocumentation": "`Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-latestversion.html#cfn-imagebuilder-containerrecipe-latestversion-patch", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ContainerRecipe.TargetContainerRepository": { "MarkdownDocumentation": "`AWS::ImageBuilder::ContainerRecipe.TargetContainerRepository`\n\nThe container repository where the output container image is stored.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-targetcontainerrepository.html", "Properties": { "Service": { "MarkdownDocumentation": "`Service`\n\nSpecifies the service in which this image was registered.\n*Required*: No\n*Type*: String\n*Allowed values*: `ECR`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ECR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-targetcontainerrepository.html#cfn-imagebuilder-containerrecipe-targetcontainerrepository-service", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RepositoryName": { "MarkdownDocumentation": "`RepositoryName`\n\nThe name of the container repository where the output container image is stored.\nThis name is prefixed by the repository location. For example,\n`/repository_name`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-targetcontainerrepository.html#cfn-imagebuilder-containerrecipe-targetcontainerrepository-repositoryname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::DistributionConfiguration.AmiDistributionConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.AmiDistributionConfiguration`\n\nDefine and configure the output AMIs of the pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html", "Properties": { "AmiTags": { "MarkdownDocumentation": "`AmiTags`\n\nThe tags to apply to AMIs distributed to this Region.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-amidistributionconfiguration-amitags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the AMI distribution configuration. Minimum and maximum length are\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-amidistributionconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image.\nThis can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)\nin the *AWS Key Management Service Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-amidistributionconfiguration-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchPermissionConfiguration": { "MarkdownDocumentation": "`LaunchPermissionConfiguration`\n\nLaunch permissions can be used to configure which AWS accounts can use the AMI to\nlaunch instances.\n*Required*: No\n*Type*: [LaunchPermissionConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-amidistributionconfiguration-launchpermissionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LaunchPermissionConfiguration" }, "TargetAccountIds": { "MarkdownDocumentation": "`TargetAccountIds`\n\nThe ID of an account to which you want to distribute an image.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-amidistributionconfiguration-targetaccountids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the output AMI.\n*Required*: No\n*Type*: String\n*Pattern*: `^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}\\.]+[-_A-Za-z0-9}]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-amidistributionconfiguration-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::DistributionConfiguration.ContainerDistributionConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.ContainerDistributionConfiguration`\n\nContainer distribution settings for encryption, licensing, and sharing in a specific\nRegion.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-containerdistributionconfiguration.html", "Properties": { "TargetRepository": { "MarkdownDocumentation": "`TargetRepository`\n\nThe destination repository for the container distribution configuration.\n*Required*: No\n*Type*: [TargetContainerRepository](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-containerdistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-containerdistributionconfiguration-targetrepository", "UpdateType": "Mutable", "Required": false, "Type": "TargetContainerRepository" }, "ContainerTags": { "MarkdownDocumentation": "`ContainerTags`\n\nTags that are attached to the container distribution configuration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-containerdistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-containerdistributionconfiguration-containertags", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-containerdistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-containerdistributionconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::DistributionConfiguration.Distribution": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.Distribution`\n\nThe distribution configuration distribution defines the settings for a specific Region\nin the Distribution Configuration. You must specify whether the distribution is for an AMI\nor a container image. To do so, include exactly one of the following data types for your\ndistribution:\n* amiDistributionConfiguration\n* containerDistributionConfiguration\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html", "Properties": { "AmiDistributionConfiguration": { "MarkdownDocumentation": "`AmiDistributionConfiguration`\n\nThe specific AMI settings, such as launch permissions and AMI tags. For details,\nsee example schema below.\n*Required*: No\n*Type*: [AmiDistributionConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-amidistributionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AmiDistributionConfiguration" }, "ContainerDistributionConfiguration": { "MarkdownDocumentation": "`ContainerDistributionConfiguration`\n\nContainer distribution settings for encryption, licensing, and sharing\nin a specific Region. For details, see example schema below.\n*Required*: No\n*Type*: [ContainerDistributionConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-containerdistributionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ContainerDistributionConfiguration" }, "FastLaunchConfigurations": { "MarkdownDocumentation": "`FastLaunchConfigurations`\n\nThe Windows faster-launching configurations to use for AMI distribution.\n*Required*: No\n*Type*: Array of [FastLaunchConfiguration](./aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-fastlaunchconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FastLaunchConfiguration", "DuplicatesAllowed": true }, "LaunchTemplateConfigurations": { "MarkdownDocumentation": "`LaunchTemplateConfigurations`\n\nA group of launchTemplateConfiguration settings that apply to image distribution for\nspecified accounts.\n*Required*: No\n*Type*: Array of [LaunchTemplateConfiguration](./aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-launchtemplateconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LaunchTemplateConfiguration", "DuplicatesAllowed": true }, "LicenseConfigurationArns": { "MarkdownDocumentation": "`LicenseConfigurationArns`\n\nThe License Manager Configuration to associate with the AMI in the specified Region.\nFor more information, see the [LicenseConfiguration API](https://docs.aws.amazon.com/license-manager/latest/APIReference/API_LicenseConfiguration.html).\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-licenseconfigurationarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe target Region for the Distribution Configuration. For example,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SsmParameterConfigurations": { "MarkdownDocumentation": "`SsmParameterConfigurations`\n\nContains settings to update AWS Systems Manager (SSM) Parameter Store Parameters with\noutput AMI IDs from the build by target Region.\n*Required*: No\n*Type*: Array of [SsmParameterConfiguration](./aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-ssmparameterconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SsmParameterConfiguration", "DuplicatesAllowed": true } } }, "AWS::ImageBuilder::DistributionConfiguration.FastLaunchConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.FastLaunchConfiguration`\n\nDefine and configure faster launching for output Windows AMIs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html", "Properties": { "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-accountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchTemplate": { "MarkdownDocumentation": "`LaunchTemplate`\n\nThe launch template that the fast-launch enabled Windows AMI uses when it launches\nWindows instances to create pre-provisioned snapshots.\n*Required*: No\n*Type*: [FastLaunchLaunchTemplateSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-launchtemplate", "UpdateType": "Mutable", "Required": false, "Type": "FastLaunchLaunchTemplateSpecification" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nA Boolean that represents the current state of faster launching for the Windows AMI.\nSet to `true` to start using Windows faster launching, or `false`\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxParallelLaunches": { "MarkdownDocumentation": "`MaxParallelLaunches`\n\nThe maximum number of parallel instances that are launched for creating\nresources.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-maxparallellaunches", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SnapshotConfiguration": { "MarkdownDocumentation": "`SnapshotConfiguration`\n\nConfiguration settings for managing the number of snapshots that are created from\npre-provisioned instances for the Windows AMI when faster launching is enabled.\n*Required*: No\n*Type*: [FastLaunchSnapshotConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-snapshotconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FastLaunchSnapshotConfiguration" } } }, "AWS::ImageBuilder::DistributionConfiguration.FastLaunchLaunchTemplateSpecification": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.FastLaunchLaunchTemplateSpecification`\n\nIdentifies the launch template that the associated Windows AMI uses for launching an\ninstance when faster launching is enabled.\n###### Note\nYou can specify either the `launchTemplateName` or the\n`launchTemplateId`, but not both.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html", "Properties": { "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html#cfn-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification-launchtemplatename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchTemplateVersion": { "MarkdownDocumentation": "`LaunchTemplateVersion`\n\nThe version of the launch template to use for faster launching for a Windows\nAMI.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html#cfn-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification-launchtemplateversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html#cfn-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification-launchtemplateid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::DistributionConfiguration.FastLaunchSnapshotConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.FastLaunchSnapshotConfiguration`\n\nConfiguration settings for creating and managing pre-provisioned snapshots for a\nfast-launch enabled Windows AMI.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration.html", "Properties": { "TargetResourceCount": { "MarkdownDocumentation": "`TargetResourceCount`\n\nThe number of pre-provisioned snapshots to keep on hand for a fast-launch enabled\nWindows 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration-targetresourcecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ImageBuilder::DistributionConfiguration.LaunchPermissionConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.LaunchPermissionConfiguration`\n\nDescribes the configuration for a launch permission. The launch permission\nmodification request is sent to the [Amazon EC2\nModifyImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html) API on behalf of the user for each Region they have\nselected to distribute the AMI. To make an AMI public, set the launch permission\nauthorized accounts to `all`. See the examples for making an AMI public at\n[Amazon EC2\nModifyImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html", "Properties": { "OrganizationArns": { "MarkdownDocumentation": "`OrganizationArns`\n\nThe ARN for an AWS Organization that you want to share your AMI with. For more\ninformation, see [What is\nAWS Organizations?](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html).\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-organizationarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "OrganizationalUnitArns": { "MarkdownDocumentation": "`OrganizationalUnitArns`\n\nThe ARN for an AWS Organizations organizational unit (OU) that you want to share your AMI with.\nFor more information about key concepts for AWS Organizations, see [AWS Organizations\nterminology and concepts](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html).\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-organizationalunitarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UserIds": { "MarkdownDocumentation": "`UserIds`\n\nThe AWS account ID.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-userids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UserGroups": { "MarkdownDocumentation": "`UserGroups`\n\nThe name of the group.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-usergroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ImageBuilder::DistributionConfiguration.LaunchTemplateConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.LaunchTemplateConfiguration`\n\nIdentifies an Amazon EC2 launch template to use for a specific account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html", "Properties": { "SetDefaultVersion": { "MarkdownDocumentation": "`SetDefaultVersion`\n\nSet the specified Amazon EC2 launch template as the default launch template for the\nspecified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchtemplateconfiguration-setdefaultversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchtemplateconfiguration-accountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchTemplateId": { "MarkdownDocumentation": "`LaunchTemplateId`\n\nIdentifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchtemplateconfiguration-launchtemplateid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::DistributionConfiguration.SsmParameterConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.SsmParameterConfiguration`\n\nConfiguration for a single Parameter in the AWS Systems Manager (SSM) Parameter Store in\na given Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html", "Properties": { "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe data type specifies what type of value the Parameter contains. We recommend that\nyou use data type `aws:ec2:image`.\n*Required*: No\n*Type*: String\n*Allowed values*: `text | aws:ec2:image...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "text", "aws:ec2:image" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-datatype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThis is the name of the Parameter in the target Region or account. The image\ndistribution creates the Parameter if it doesn't already exist. Otherwise, it updates\nthe parameter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.\\-\\/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AmiAccountId": { "MarkdownDocumentation": "`AmiAccountId`\n\nSpecify the account that will own the Parameter in a given Region. During distribution,\nthis account must be specified in distribution settings as a target account for the\nRegion.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-amiaccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::DistributionConfiguration.TargetContainerRepository": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration.TargetContainerRepository`\n\nThe container repository where the output container image is stored.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-targetcontainerrepository.html", "Properties": { "Service": { "MarkdownDocumentation": "`Service`\n\nSpecifies 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)\n", "RefReturnValue": "", "AllowedValues": [ "ECR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-targetcontainerrepository.html#cfn-imagebuilder-distributionconfiguration-targetcontainerrepository-service", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RepositoryName": { "MarkdownDocumentation": "`RepositoryName`\n\nThe name of the container repository where the output container image is stored.\nThis name is prefixed by the repository location. For example,\n`/repository_name`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-targetcontainerrepository.html#cfn-imagebuilder-distributionconfiguration-targetcontainerrepository-repositoryname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::Image.DeletionSettings": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.DeletionSettings`\n\nContains deletion settings of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.\n###### Note\nIf you specify the `Retain` option in the [DeletionPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-attribute-updatereplacepolicy.html) or [UpdateReplacePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-attribute-deletionpolicy.html), the deletion of underlying resources will not be executed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-deletionsettings.html", "Properties": { "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to delete the image and its underlying resources.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-deletionsettings.html#cfn-imagebuilder-image-deletionsettings-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::Image.EcrConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.EcrConfiguration`\n\nSettings that Image Builder uses to configure the ECR repository and the output container\nimages that Amazon Inspector scans.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-ecrconfiguration.html", "Properties": { "ContainerTags": { "MarkdownDocumentation": "`ContainerTags`\n\nTags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can\nhelp you identify and manage your scanned images.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-ecrconfiguration.html#cfn-imagebuilder-image-ecrconfiguration-containertags", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RepositoryName": { "MarkdownDocumentation": "`RepositoryName`\n\nThe name of the container repository that Amazon Inspector scans to identify findings for your\ncontainer images. The name includes the path for the repository location. If you don\u2019t\nprovide this information, Image Builder creates a repository in your account named\n`image-builder-image-scanning-repository` for vulnerability scans of your\noutput container images.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-ecrconfiguration.html#cfn-imagebuilder-image-ecrconfiguration-repositoryname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::Image.ImageLoggingConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.ImageLoggingConfiguration`\n\nThe logging configuration that's defined for the image. Image Builder uses the defined settings\nto direct execution log output during image creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imageloggingconfiguration.html", "Properties": { "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe log group name that Image Builder uses for image creation. If not specified, the log group\nname defaults to `/aws/imagebuilder/image-name`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\-_/\\.]{1,512}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imageloggingconfiguration.html#cfn-imagebuilder-image-imageloggingconfiguration-loggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::Image.ImagePipelineExecutionSettings": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.ImagePipelineExecutionSettings`\n\nContains settings for starting an image pipeline execution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html", "Properties": { "DeploymentId": { "MarkdownDocumentation": "`DeploymentId`\n\nThe deployment identifier of the pipeline, utilized to initiate new image pipeline executions.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html#cfn-imagebuilder-image-imagepipelineexecutionsettings-deploymentid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "OnUpdate": { "MarkdownDocumentation": "`OnUpdate`\n\nDefines whether the pipeline should be executed upon pipeline updates. False by default.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html#cfn-imagebuilder-image-imagepipelineexecutionsettings-onupdate", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::Image.ImageScanningConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.ImageScanningConfiguration`\n\nContains settings for Image Builder image resource and container image scans.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagescanningconfiguration.html", "Properties": { "EcrConfiguration": { "MarkdownDocumentation": "`EcrConfiguration`\n\nContains Amazon ECR settings for vulnerability scans.\n*Required*: No\n*Type*: [EcrConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagescanningconfiguration.html#cfn-imagebuilder-image-imagescanningconfiguration-ecrconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EcrConfiguration" }, "ImageScanningEnabled": { "MarkdownDocumentation": "`ImageScanningEnabled`\n\nA setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that\nAmazon Inspector runs against the build instance when you create a new image.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagescanningconfiguration.html#cfn-imagebuilder-image-imagescanningconfiguration-imagescanningenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::Image.ImageTestsConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.ImageTestsConfiguration`\n\nWhen you create an image or container recipe with Image Builder, you can add the build or\ntest components that are used to create the final image. You must have at least one build\ncomponent to create a recipe, but test components are not required. If you have added tests,\nthey run after the image is created, to ensure that the target image is functional and can\nbe used reliably for launching Amazon EC2 instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagetestsconfiguration.html", "Properties": { "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe maximum time in minutes that tests are permitted to run.\n###### Note\nThe timeout property is not currently active. This value is\nignored.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagetestsconfiguration.html#cfn-imagebuilder-image-imagetestsconfiguration-timeoutminutes", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ImageTestsEnabled": { "MarkdownDocumentation": "`ImageTestsEnabled`\n\nDetermines if tests should run after building the image. Image Builder defaults to enable tests\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagetestsconfiguration.html#cfn-imagebuilder-image-imagetestsconfiguration-imagetestsenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::Image.LatestVersion": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.LatestVersion`\n\nThe resource ARNs with different wildcard variations of semantic versioning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html", "Properties": { "Major": { "MarkdownDocumentation": "`Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html#cfn-imagebuilder-image-latestversion-major", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Minor": { "MarkdownDocumentation": "`Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html#cfn-imagebuilder-image-latestversion-minor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html#cfn-imagebuilder-image-latestversion-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Patch": { "MarkdownDocumentation": "`Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-latestversion.html#cfn-imagebuilder-image-latestversion-patch", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::Image.WorkflowConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.WorkflowConfiguration`\n\nContains control settings and configurable inputs for a workflow\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html", "Properties": { "ParallelGroup": { "MarkdownDocumentation": "`ParallelGroup`\n\nTest workflows are defined within named runtime groups called parallel groups.\nThe parallel group is the named group that contains this test workflow. Test\nworkflows within a parallel group can run at the same time. Image Builder starts up to five\ntest workflows in the group at the same time, and starts additional workflows as\nothers complete, until all workflows in the group have completed. This field only\napplies for test workflows.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9][A-Za-z0-9-_+#]{0,99}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-parallelgroup", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nContains parameter values for each of the parameters that the workflow\ndocument defined for the workflow resource.\n*Required*: No\n*Type*: Array of [WorkflowParameter](./aws-properties-imagebuilder-image-workflowparameter.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-parameters", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "WorkflowParameter", "DuplicatesAllowed": true }, "WorkflowArn": { "MarkdownDocumentation": "`WorkflowArn`\n\nThe Amazon Resource Name (ARN) of the workflow resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-workflowarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OnFailure": { "MarkdownDocumentation": "`OnFailure`\n\nThe action to take if the workflow fails.\n*Required*: No\n*Type*: String\n*Allowed values*: `CONTINUE | ABORT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "ABORT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-onfailure", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::Image.WorkflowParameter": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image.WorkflowParameter`\n\nContains a key/value pair that sets the named workflow parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nSets the value for the named workflow parameter.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowparameter.html#cfn-imagebuilder-image-workflowparameter-value", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the workflow parameter to set.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\x00]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowparameter.html#cfn-imagebuilder-image-workflowparameter-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImagePipeline.AutoDisablePolicy": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline.AutoDisablePolicy`\n\nDefines the rules by which an image pipeline is automatically disabled when it fails.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-autodisablepolicy.html", "Properties": { "FailureCount": { "MarkdownDocumentation": "`FailureCount`\n\nThe number of consecutive scheduled image pipeline executions that must fail before Image Builder\nautomatically disables the pipeline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-autodisablepolicy.html#cfn-imagebuilder-imagepipeline-autodisablepolicy-failurecount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ImageBuilder::ImagePipeline.EcrConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline.EcrConfiguration`\n\nSettings that Image Builder uses to configure the ECR repository and the output container\nimages that Amazon Inspector scans.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.html", "Properties": { "ContainerTags": { "MarkdownDocumentation": "`ContainerTags`\n\nTags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can\nhelp you identify and manage your scanned images.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.html#cfn-imagebuilder-imagepipeline-ecrconfiguration-containertags", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RepositoryName": { "MarkdownDocumentation": "`RepositoryName`\n\nThe name of the container repository that Amazon Inspector scans to identify findings for your\ncontainer images. The name includes the path for the repository location. If you don\u2019t\nprovide this information, Image Builder creates a repository in your account named\n`image-builder-image-scanning-repository` for vulnerability scans of your\noutput container images.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.html#cfn-imagebuilder-imagepipeline-ecrconfiguration-repositoryname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration`\n\nContains settings for Image Builder image resource and container image scans.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagescanningconfiguration.html", "Properties": { "EcrConfiguration": { "MarkdownDocumentation": "`EcrConfiguration`\n\nContains Amazon ECR settings for vulnerability scans.\n*Required*: No\n*Type*: [EcrConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagescanningconfiguration.html#cfn-imagebuilder-imagepipeline-imagescanningconfiguration-ecrconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EcrConfiguration" }, "ImageScanningEnabled": { "MarkdownDocumentation": "`ImageScanningEnabled`\n\nA setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that\nAmazon Inspector runs against the build instance when you create a new image.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagescanningconfiguration.html#cfn-imagebuilder-imagepipeline-imagescanningconfiguration-imagescanningenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::ImagePipeline.ImageTestsConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline.ImageTestsConfiguration`\n\nWhen you create an image or container recipe with Image Builder, you can add the build or\ntest components that your image pipeline uses to create the final image. You must\nhave at least one build component to create a recipe, but test components are not required.\nYour pipeline runs tests after it builds the image, to ensure that the target image is\nfunctional and can be used reliably for launching Amazon EC2 instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagetestsconfiguration.html", "Properties": { "TimeoutMinutes": { "MarkdownDocumentation": "`TimeoutMinutes`\n\nThe maximum time in minutes that tests are permitted to run.\n###### Note\nThe timeout property is not currently active. This value is\nignored.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagetestsconfiguration.html#cfn-imagebuilder-imagepipeline-imagetestsconfiguration-timeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ImageTestsEnabled": { "MarkdownDocumentation": "`ImageTestsEnabled`\n\nDefines if tests should be executed when building this image. For example,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagetestsconfiguration.html#cfn-imagebuilder-imagepipeline-imagetestsconfiguration-imagetestsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::ImagePipeline.PipelineLoggingConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline.PipelineLoggingConfiguration`\n\nThe logging configuration that's defined for pipeline execution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-pipelineloggingconfiguration.html", "Properties": { "PipelineLogGroupName": { "MarkdownDocumentation": "`PipelineLogGroupName`\n\nThe log group name that Image Builder uses for the log output during creation of a new pipeline.\nIf not specified, the pipeline log group name defaults to\n`/aws/imagebuilder/pipeline/pipeline-name`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\-_/\\.]{1,512}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-pipelineloggingconfiguration.html#cfn-imagebuilder-imagepipeline-pipelineloggingconfiguration-pipelineloggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImageLogGroupName": { "MarkdownDocumentation": "`ImageLogGroupName`\n\nThe log group name that Image Builder uses for image creation. If not specified, the log group\nname defaults to `/aws/imagebuilder/image-name`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\-_/\\.]{1,512}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-pipelineloggingconfiguration.html#cfn-imagebuilder-imagepipeline-pipelineloggingconfiguration-imageloggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImagePipeline.Schedule": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline.Schedule`\n\nA schedule configures when and how often a pipeline will automatically create a new\nimage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html", "Properties": { "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nThe cron expression determines how often EC2 Image Builder evaluates your\n`pipelineExecutionStartCondition`.\nFor information on how to format a cron expression in Image Builder, see [Use\ncron 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html#cfn-imagebuilder-imagepipeline-schedule-scheduleexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PipelineExecutionStartCondition": { "MarkdownDocumentation": "`PipelineExecutionStartCondition`\n\nThe condition configures when the pipeline should trigger a new image build. When the\n`pipelineExecutionStartCondition` is set to\n`EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`, and you use semantic version\nfilters on the base image or components in your image recipe, Image Builder will build a\nnew image only when there are new versions of the image or components in your recipe that\nmatch the semantic version filter. When it is set to `EXPRESSION_MATCH_ONLY`, it\nwill build a new image every time the CRON expression matches the current time. For semantic\nversion syntax, see [CreateComponent](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html)\nin the *Image Builder API Reference*.\n*Required*: No\n*Type*: String\n*Allowed values*: `EXPRESSION_MATCH_ONLY | EXP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXPRESSION_MATCH_ONLY", "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html#cfn-imagebuilder-imagepipeline-schedule-pipelineexecutionstartcondition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoDisablePolicy": { "MarkdownDocumentation": "`AutoDisablePolicy`\n\nThe policy that configures when Image Builder should automatically disable a pipeline that\nis failing.\n*Required*: No\n*Type*: [AutoDisablePolicy](./aws-properties-imagebuilder-imagepipeline-autodisablepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html#cfn-imagebuilder-imagepipeline-schedule-autodisablepolicy", "UpdateType": "Mutable", "Required": false, "Type": "AutoDisablePolicy" } } }, "AWS::ImageBuilder::ImagePipeline.WorkflowConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline.WorkflowConfiguration`\n\nContains control settings and configurable inputs for a workflow\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html", "Properties": { "ParallelGroup": { "MarkdownDocumentation": "`ParallelGroup`\n\nTest workflows are defined within named runtime groups called parallel groups.\nThe parallel group is the named group that contains this test workflow. Test\nworkflows within a parallel group can run at the same time. Image Builder starts up to five\ntest workflows in the group at the same time, and starts additional workflows as\nothers complete, until all workflows in the group have completed. This field only\napplies for test workflows.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9][A-Za-z0-9-_+#]{0,99}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html#cfn-imagebuilder-imagepipeline-workflowconfiguration-parallelgroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nContains parameter values for each of the parameters that the workflow\ndocument defined for the workflow resource.\n*Required*: No\n*Type*: Array of [WorkflowParameter](./aws-properties-imagebuilder-imagepipeline-workflowparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html#cfn-imagebuilder-imagepipeline-workflowconfiguration-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "WorkflowParameter", "DuplicatesAllowed": true }, "WorkflowArn": { "MarkdownDocumentation": "`WorkflowArn`\n\nThe Amazon Resource Name (ARN) of the workflow resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html#cfn-imagebuilder-imagepipeline-workflowconfiguration-workflowarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OnFailure": { "MarkdownDocumentation": "`OnFailure`\n\nThe action to take if the workflow fails.\n*Required*: No\n*Type*: String\n*Allowed values*: `CONTINUE | ABORT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "ABORT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html#cfn-imagebuilder-imagepipeline-workflowconfiguration-onfailure", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImagePipeline.WorkflowParameter": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline.WorkflowParameter`\n\nContains a key/value pair that sets the named workflow parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nSets the value for the named workflow parameter.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowparameter.html#cfn-imagebuilder-imagepipeline-workflowparameter-value", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the workflow parameter to set.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\x00]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-workflowparameter.html#cfn-imagebuilder-imagepipeline-workflowparameter-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImageRecipe.AdditionalInstanceConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImageRecipe.AdditionalInstanceConfiguration`\n\nIn addition to your infrastructure configuration, these settings provide an extra\nlayer of control over your build instances. You can also specify commands to run on\nlaunch for all of your build instances.\nImage Builder does not automatically install the Systems Manager agent on Windows instances. If your base\nimage includes the Systems Manager agent, then the AMI that you create will also include the\nagent. For Linux instances, if the base image does not already include the Systems Manager agent,\nImage Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can\nchoose whether to keep it for the AMI that you create.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-additionalinstanceconfiguration.html", "Properties": { "UserDataOverride": { "MarkdownDocumentation": "`UserDataOverride`\n\nUse this property to provide commands or a command script to run when you launch your\nbuild instance.\nThe userDataOverride property replaces any commands that Image Builder might have added to\nensure that Systems Manager is installed on your Linux build instance. If you override the user\ndata, make sure that you add commands to install Systems Manager, if it is not pre-installed on\nyour base image.\n###### Note\nThe user data is always base 64 encoded. For example, the following commands are\nencoded as\n`IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$`:\n*#!/bin/bash*\nmkdir -p /var/bb/\ntouch /var\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$`\n*Minimum*: `1`\n*Maximum*: `21847`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-additionalinstanceconfiguration.html#cfn-imagebuilder-imagerecipe-additionalinstanceconfiguration-userdataoverride", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SystemsManagerAgent": { "MarkdownDocumentation": "`SystemsManagerAgent`\n\nContains settings for the Systems Manager agent on your build instance.\n*Required*: No\n*Type*: [SystemsManagerAgent](./aws-properties-imagebuilder-imagerecipe-systemsmanageragent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-additionalinstanceconfiguration.html#cfn-imagebuilder-imagerecipe-additionalinstanceconfiguration-systemsmanageragent", "UpdateType": "Mutable", "Required": false, "Type": "SystemsManagerAgent" } } }, "AWS::ImageBuilder::ImageRecipe.ComponentConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImageRecipe.ComponentConfiguration`\n\nConfiguration details of the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentconfiguration.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nA group of parameter settings that Image Builder uses to configure the component for a specific\nrecipe.\n*Required*: No\n*Type*: Array of [ComponentParameter](./aws-properties-imagebuilder-imagerecipe-componentparameter.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentconfiguration.html#cfn-imagebuilder-imagerecipe-componentconfiguration-parameters", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ComponentParameter", "DuplicatesAllowed": true }, "ComponentArn": { "MarkdownDocumentation": "`ComponentArn`\n\nThe Amazon Resource Name (ARN) of the component.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentconfiguration.html#cfn-imagebuilder-imagerecipe-componentconfiguration-componentarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImageRecipe.ComponentParameter": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImageRecipe.ComponentParameter`\n\nContains a key/value pair that sets the named component parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nSets the value for the named component parameter.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html#cfn-imagebuilder-imagerecipe-componentparameter-value", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the component parameter to set.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^\\x00]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html#cfn-imagebuilder-imagerecipe-componentparameter-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImageRecipe.EbsInstanceBlockDeviceSpecification": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImageRecipe.EbsInstanceBlockDeviceSpecification`\n\nThe image recipe EBS instance block device specification includes the Amazon\nEBS-specific block device mapping specifications for the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html", "Properties": { "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe snapshot that defines the device contents.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-snapshotid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nOverrides the volume type of the device.\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | io1 | io2 | gp2 ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "standard", "io1", "io2", "gp2", "gp3", "sc1", "st1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-volumetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device.\nThis can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)\nin the *AWS Key Management Service Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nUse to configure device 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-encrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Throughput": { "MarkdownDocumentation": "`Throughput`\n\n**For GP3 volumes only** \u2013 The throughput in MiB/s\nthat the volume supports.\n*Required*: No\n*Type*: Integer\n*Minimum*: `125`\n*Maximum*: `1000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-throughput", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nUse to configure device IOPS.\n*Required*: No\n*Type*: Integer\n*Minimum*: `100`\n*Maximum*: `64000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-iops", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nOverrides the volume size of the device.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `16000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-volumesize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nConfigures 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html#cfn-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification-deleteontermination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::ImageRecipe.InstanceBlockDeviceMapping": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImageRecipe.InstanceBlockDeviceMapping`\n\nDefines block device mappings for the instance used to configure your image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-instanceblockdevicemapping.html", "Properties": { "Ebs": { "MarkdownDocumentation": "`Ebs`\n\nUse to manage Amazon EBS-specific configuration for this mapping.\n*Required*: No\n*Type*: [EbsInstanceBlockDeviceSpecification](./aws-properties-imagebuilder-imagerecipe-ebsinstanceblockdevicespecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-instanceblockdevicemapping.html#cfn-imagebuilder-imagerecipe-instanceblockdevicemapping-ebs", "UpdateType": "Immutable", "Required": false, "Type": "EbsInstanceBlockDeviceSpecification" }, "NoDevice": { "MarkdownDocumentation": "`NoDevice`\n\nEnter an empty string to remove a mapping from the parent image.\nThe following is an example of an empty string value in the `NoDevice` field.\n`NoDevice:\"\"`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-instanceblockdevicemapping.html#cfn-imagebuilder-imagerecipe-instanceblockdevicemapping-nodevice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VirtualName": { "MarkdownDocumentation": "`VirtualName`\n\nManages the instance ephemeral devices.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-instanceblockdevicemapping.html#cfn-imagebuilder-imagerecipe-instanceblockdevicemapping-virtualname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe device to which these mappings apply.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-instanceblockdevicemapping.html#cfn-imagebuilder-imagerecipe-instanceblockdevicemapping-devicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImageRecipe.LatestVersion": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImageRecipe.LatestVersion`\n\nThe resource ARNs with different wildcard variations of semantic versioning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-latestversion.html", "Properties": { "Major": { "MarkdownDocumentation": "`Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-latestversion.html#cfn-imagebuilder-imagerecipe-latestversion-major", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Minor": { "MarkdownDocumentation": "`Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-latestversion.html#cfn-imagebuilder-imagerecipe-latestversion-minor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-latestversion.html#cfn-imagebuilder-imagerecipe-latestversion-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Patch": { "MarkdownDocumentation": "`Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-latestversion.html#cfn-imagebuilder-imagerecipe-latestversion-patch", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::ImageRecipe.SystemsManagerAgent": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImageRecipe.SystemsManagerAgent`\n\nContains settings for the Systems Manager agent on your build instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-systemsmanageragent.html", "Properties": { "UninstallAfterBuild": { "MarkdownDocumentation": "`UninstallAfterBuild`\n\nControls whether the Systems Manager agent is removed from your final build image, prior to\ncreating the new AMI. If this is set to true, then the agent is removed from the final\nimage. If it's set to false, then the agent is left in, so that it is included in the\nnew AMI. default value is false.\nThe default behavior of uninstallAfterBuild is to remove the SSM Agent if it was installed by EC2 Image Builder\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-systemsmanageragent.html#cfn-imagebuilder-imagerecipe-systemsmanageragent-uninstallafterbuild", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::InfrastructureConfiguration.InstanceMetadataOptions": { "MarkdownDocumentation": "`AWS::ImageBuilder::InfrastructureConfiguration.InstanceMetadataOptions`\n\nThe instance metadata options that apply to the HTTP requests that pipeline builds use\nto launch EC2 build and test instances. For more information about instance metadata\noptions, see [Configure the instance metadata options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) in the\n**Amazon EC2 User Guide** for Linux instances, or [Configure the instance metadata options](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html) in the\n**Amazon EC2 Windows Guide** for Windows instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-instancemetadataoptions.html", "Properties": { "HttpPutResponseHopLimit": { "MarkdownDocumentation": "`HttpPutResponseHopLimit`\n\nLimit the number of hops that an instance metadata request can traverse to reach its\ndestination. The default is one hop. However, if HTTP tokens are required, container\nimage 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-instancemetadataoptions.html#cfn-imagebuilder-infrastructureconfiguration-instancemetadataoptions-httpputresponsehoplimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HttpTokens": { "MarkdownDocumentation": "`HttpTokens`\n\nIndicates whether a signed token header is required for instance metadata retrieval\nrequests. The values affect the response as follows:\n* **required** \u2013 When you retrieve the IAM\n role credentials, version 2.0 credentials are returned in all cases.\n* **optional** \u2013 You can include a signed\n token header in your request to retrieve instance metadata, or you can leave it\n out. If you include it, version 2.0 credentials are returned for the IAM role.\n Otherwise, version 1.0 credentials are returned.\nThe default setting is **optional**.\n*Required*: No\n*Type*: String\n*Allowed values*: `required | optional...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "required", "optional" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-instancemetadataoptions.html#cfn-imagebuilder-infrastructureconfiguration-instancemetadataoptions-httptokens", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::InfrastructureConfiguration.Logging": { "MarkdownDocumentation": "`AWS::ImageBuilder::InfrastructureConfiguration.Logging`\n\nLogging configuration defines where Image Builder uploads your logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-logging.html", "Properties": { "S3Logs": { "MarkdownDocumentation": "`S3Logs`\n\nThe Amazon S3 logging configuration.\n*Required*: No\n*Type*: [S3Logs](./aws-properties-imagebuilder-infrastructureconfiguration-s3logs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-logging.html#cfn-imagebuilder-infrastructureconfiguration-logging-s3logs", "UpdateType": "Mutable", "Required": false, "Type": "S3Logs" } } }, "AWS::ImageBuilder::InfrastructureConfiguration.Placement": { "MarkdownDocumentation": "`AWS::ImageBuilder::InfrastructureConfiguration.Placement`\n\nBy default, EC2 instances run on shared tenancy hardware. This means that multiple\nAWS accounts might share the same physical hardware. When you use dedicated hardware,\nthe physical server that hosts your instances is dedicated to your AWS account.\nInstance placement settings contain the details for the physical hardware where\ninstances that Image Builder launches during image creation will run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html", "Properties": { "Tenancy": { "MarkdownDocumentation": "`Tenancy`\n\nThe tenancy of the instance. An instance with a tenancy of `dedicated`\nruns on single-tenant hardware. An instance with a tenancy of `host` runs\non a Dedicated Host.\nIf tenancy is set to `host`, then you can optionally specify one target\nfor placement \u2013 either host ID or host resource group ARN. If automatic placement\nis enabled for your host, and you don't specify any placement target, Amazon EC2 will try to\nfind an available host for your build and test instances.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | dedicated | host...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "dedicated", "host" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html#cfn-imagebuilder-infrastructureconfiguration-placement-tenancy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone where your build and test instances will launch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html#cfn-imagebuilder-infrastructureconfiguration-placement-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostId": { "MarkdownDocumentation": "`HostId`\n\nThe ID of the Dedicated Host on which build and test instances run. This only\napplies if `tenancy` is `host`. If you specify the host ID, you\nmust not specify the resource group ARN. If you specify both, Image Builder returns an error.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html#cfn-imagebuilder-infrastructureconfiguration-placement-hostid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostResourceGroupArn": { "MarkdownDocumentation": "`HostResourceGroupArn`\n\nThe Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances.\nThis only applies if `tenancy` is `host`. If you specify the resource\ngroup ARN, you must not specify the host ID. If you specify both, Image Builder returns an error.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-placement.html#cfn-imagebuilder-infrastructureconfiguration-placement-hostresourcegrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::InfrastructureConfiguration.S3Logs": { "MarkdownDocumentation": "`AWS::ImageBuilder::InfrastructureConfiguration.S3Logs`\n\nAmazon S3 logging configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-s3logs.html", "Properties": { "S3KeyPrefix": { "MarkdownDocumentation": "`S3KeyPrefix`\n\nThe Amazon S3 path to the bucket where the logs are stored.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-s3logs.html#cfn-imagebuilder-infrastructureconfiguration-s3logs-s3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nThe S3 bucket in which to store the logs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-infrastructureconfiguration-s3logs.html#cfn-imagebuilder-infrastructureconfiguration-s3logs-s3bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::LifecyclePolicy.Action": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.Action`\n\nContains selection criteria for the lifecycle policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-action.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the lifecycle action to take.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DELETE | DEPRECATE | DISABL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DELETE", "DEPRECATE", "DISABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-action.html#cfn-imagebuilder-lifecyclepolicy-action-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IncludeResources": { "MarkdownDocumentation": "`IncludeResources`\n\nSpecifies the resources that the lifecycle policy applies to.\n*Required*: No\n*Type*: [IncludeResources](./aws-properties-imagebuilder-lifecyclepolicy-includeresources.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-action.html#cfn-imagebuilder-lifecyclepolicy-action-includeresources", "UpdateType": "Mutable", "Required": false, "Type": "IncludeResources" } } }, "AWS::ImageBuilder::LifecyclePolicy.AmiExclusionRules": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.AmiExclusionRules`\n\nDefines criteria for AMIs that are excluded from lifecycle actions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html", "Properties": { "IsPublic": { "MarkdownDocumentation": "`IsPublic`\n\nConfigures whether public AMIs are excluded from the lifecycle action.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-ispublic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LastLaunched": { "MarkdownDocumentation": "`LastLaunched`\n\nSpecifies configuration details for Image Builder to exclude the most recent resources\nfrom lifecycle actions.\n*Required*: No\n*Type*: [LastLaunched](./aws-properties-imagebuilder-lifecyclepolicy-lastlaunched.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-lastlaunched", "UpdateType": "Mutable", "Required": false, "Type": "LastLaunched" }, "Regions": { "MarkdownDocumentation": "`Regions`\n\nConfigures AWS Regions that are excluded from the lifecycle action.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-regions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SharedAccounts": { "MarkdownDocumentation": "`SharedAccounts`\n\nSpecifies AWS accounts whose resources are excluded from the lifecycle action.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-sharedaccounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TagMap": { "MarkdownDocumentation": "`TagMap`\n\nLists tags that should be excluded from lifecycle actions for the AMIs that have them.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html#cfn-imagebuilder-lifecyclepolicy-amiexclusionrules-tagmap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ImageBuilder::LifecyclePolicy.ExclusionRules": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.ExclusionRules`\n\nSpecifies resources that lifecycle policy actions should not apply to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-exclusionrules.html", "Properties": { "Amis": { "MarkdownDocumentation": "`Amis`\n\nLists configuration values that apply to AMIs that Image Builder should exclude\nfrom the lifecycle action.\n*Required*: No\n*Type*: [AmiExclusionRules](./aws-properties-imagebuilder-lifecyclepolicy-amiexclusionrules.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-exclusionrules.html#cfn-imagebuilder-lifecyclepolicy-exclusionrules-amis", "UpdateType": "Mutable", "Required": false, "Type": "AmiExclusionRules" }, "TagMap": { "MarkdownDocumentation": "`TagMap`\n\nContains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image\nresources that have them.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-exclusionrules.html#cfn-imagebuilder-lifecyclepolicy-exclusionrules-tagmap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ImageBuilder::LifecyclePolicy.Filter": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.Filter`\n\nDefines filters that the lifecycle policy uses to determine impacted resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nFilter resources based on either `age` or `count`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AGE | COUNT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AGE", "COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe number of units for the time period or for the count. For example, a value of\n`6` might refer to six months or six AMIs.\n###### Note\nFor count-based filters, this value represents the minimum number of resources\nto keep on hand. If you have fewer resources than this number, the resource is\nexcluded from lifecycle actions.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "RetainAtLeast": { "MarkdownDocumentation": "`RetainAtLeast`\n\nFor age-based filters, this is the number of resources to keep on hand after the lifecycle\n`DELETE` action is applied. Impacted resources are only deleted if you have more than\nthis number of resources. If you have fewer resources than this number, the impacted resource\nis not deleted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-retainatleast", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nDefines the unit of time that the lifecycle policy uses to determine impacted\nresources. This is required for age-based rules.\n*Required*: No\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::LifecyclePolicy.IncludeResources": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.IncludeResources`\n\nSpecifies how the lifecycle policy should apply actions to selected resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-includeresources.html", "Properties": { "Containers": { "MarkdownDocumentation": "`Containers`\n\nSpecifies whether the lifecycle action should apply to distributed containers.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-includeresources.html#cfn-imagebuilder-lifecyclepolicy-includeresources-containers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Amis": { "MarkdownDocumentation": "`Amis`\n\nSpecifies whether the lifecycle action should apply to distributed AMIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-includeresources.html#cfn-imagebuilder-lifecyclepolicy-includeresources-amis", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Snapshots": { "MarkdownDocumentation": "`Snapshots`\n\nSpecifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-includeresources.html#cfn-imagebuilder-lifecyclepolicy-includeresources-snapshots", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ImageBuilder::LifecyclePolicy.LastLaunched": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.LastLaunched`\n\nDefines criteria to exclude AMIs from lifecycle actions based on the last\ntime they were used to launch an instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-lastlaunched.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe integer number of units for the time period. For example `6` (months).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-lastlaunched.html#cfn-imagebuilder-lifecyclepolicy-lastlaunched-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nDefines the unit of time that the lifecycle policy uses to calculate elapsed time\nsince the last instance launched from the AMI. For example: days, weeks, months, or years.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DAYS | WEEKS | MONTHS | YEA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-lastlaunched.html#cfn-imagebuilder-lifecyclepolicy-lastlaunched-unit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::LifecyclePolicy.PolicyDetail": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.PolicyDetail`\n\nThe configuration details for a lifecycle policy resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-policydetail.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nConfiguration details for the policy action.\n*Required*: Yes\n*Type*: [Action](./aws-properties-imagebuilder-lifecyclepolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-policydetail.html#cfn-imagebuilder-lifecyclepolicy-policydetail-action", "UpdateType": "Mutable", "Required": true, "Type": "Action" }, "ExclusionRules": { "MarkdownDocumentation": "`ExclusionRules`\n\nAdditional rules to specify resources that should be exempt from policy actions.\n*Required*: No\n*Type*: [ExclusionRules](./aws-properties-imagebuilder-lifecyclepolicy-exclusionrules.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-policydetail.html#cfn-imagebuilder-lifecyclepolicy-policydetail-exclusionrules", "UpdateType": "Mutable", "Required": false, "Type": "ExclusionRules" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nSpecifies the resources that the lifecycle policy applies to.\n*Required*: Yes\n*Type*: [Filter](./aws-properties-imagebuilder-lifecyclepolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-policydetail.html#cfn-imagebuilder-lifecyclepolicy-policydetail-filter", "UpdateType": "Mutable", "Required": true, "Type": "Filter" } } }, "AWS::ImageBuilder::LifecyclePolicy.RecipeSelection": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.RecipeSelection`\n\nSpecifies an Image Builder recipe that the lifecycle policy uses for resource selection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-recipeselection.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of an Image Builder recipe that the lifecycle policy uses for resource selection.\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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-recipeselection.html#cfn-imagebuilder-lifecyclepolicy-recipeselection-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SemanticVersion": { "MarkdownDocumentation": "`SemanticVersion`\n\nThe version of the Image Builder recipe specified by the `name` field.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]+\\.[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-recipeselection.html#cfn-imagebuilder-lifecyclepolicy-recipeselection-semanticversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ImageBuilder::LifecyclePolicy.ResourceSelection": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy.ResourceSelection`\n\nResource selection criteria for the lifecycle policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-resourceselection.html", "Properties": { "Recipes": { "MarkdownDocumentation": "`Recipes`\n\nA list of recipes that are used as selection criteria for the output\nimages that the lifecycle policy applies to.\n*Required*: No\n*Type*: Array of [RecipeSelection](./aws-properties-imagebuilder-lifecyclepolicy-recipeselection.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-resourceselection.html#cfn-imagebuilder-lifecyclepolicy-resourceselection-recipes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RecipeSelection", "DuplicatesAllowed": true }, "TagMap": { "MarkdownDocumentation": "`TagMap`\n\nA list of tags that are used as selection criteria for the Image Builder image\nresources that the lifecycle policy applies to.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-resourceselection.html#cfn-imagebuilder-lifecyclepolicy-resourceselection-tagmap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::ImageBuilder::Workflow.LatestVersion": { "MarkdownDocumentation": "`AWS::ImageBuilder::Workflow.LatestVersion`\n\nThe resource ARNs with different wildcard variations of semantic versioning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-workflow-latestversion.html", "Properties": { "Major": { "MarkdownDocumentation": "`Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-workflow-latestversion.html#cfn-imagebuilder-workflow-latestversion-major", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Minor": { "MarkdownDocumentation": "`Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-workflow-latestversion.html#cfn-imagebuilder-workflow-latestversion-minor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-workflow-latestversion.html#cfn-imagebuilder-workflow-latestversion-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Patch": { "MarkdownDocumentation": "`Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-workflow-latestversion.html#cfn-imagebuilder-workflow-latestversion-patch", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::InspectorV2::CisScanConfiguration.CisTargets": { "MarkdownDocumentation": "`AWS::InspectorV2::CisScanConfiguration.CisTargets`\n\nThe CIS targets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-cistargets.html", "Properties": { "TargetResourceTags": { "MarkdownDocumentation": "`TargetResourceTags`\n\nThe CIS target resource tags.\n*Required*: Yes\n*Type*: Array of String\n*Pattern*: `^.+$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-cistargets.html#cfn-inspectorv2-cisscanconfiguration-cistargets-targetresourcetags", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "AccountIds": { "MarkdownDocumentation": "`AccountIds`\n\nThe CIS target account ids.\n*Required*: Yes\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-cistargets.html#cfn-inspectorv2-cisscanconfiguration-cistargets-accountids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::InspectorV2::CisScanConfiguration.DailySchedule": { "MarkdownDocumentation": "`AWS::InspectorV2::CisScanConfiguration.DailySchedule`\n\nA daily schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-dailyschedule.html", "Properties": { "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe schedule start time.\n*Required*: Yes\n*Type*: [Time](./aws-properties-inspectorv2-cisscanconfiguration-time.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-dailyschedule.html#cfn-inspectorv2-cisscanconfiguration-dailyschedule-starttime", "UpdateType": "Mutable", "Required": true, "Type": "Time" } } }, "AWS::InspectorV2::CisScanConfiguration.MonthlySchedule": { "MarkdownDocumentation": "`AWS::InspectorV2::CisScanConfiguration.MonthlySchedule`\n\nA monthly schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-monthlyschedule.html", "Properties": { "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe monthly schedule's start time.\n*Required*: Yes\n*Type*: [Time](./aws-properties-inspectorv2-cisscanconfiguration-time.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-monthlyschedule.html#cfn-inspectorv2-cisscanconfiguration-monthlyschedule-starttime", "UpdateType": "Mutable", "Required": true, "Type": "Time" }, "Day": { "MarkdownDocumentation": "`Day`\n\nThe monthly schedule's day.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MON | TUE | WED | THU | FRI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-monthlyschedule.html#cfn-inspectorv2-cisscanconfiguration-monthlyschedule-day", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::InspectorV2::CisScanConfiguration.Schedule": { "MarkdownDocumentation": "`AWS::InspectorV2::CisScanConfiguration.Schedule`\n\nThe schedule the CIS scan configuration runs on. Each CIS scan configuration has\nexactly one type of schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-schedule.html", "Properties": { "Daily": { "MarkdownDocumentation": "`Daily`\n\nA daily schedule.\n*Required*: No\n*Type*: [DailySchedule](./aws-properties-inspectorv2-cisscanconfiguration-dailyschedule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-schedule.html#cfn-inspectorv2-cisscanconfiguration-schedule-daily", "UpdateType": "Mutable", "Required": false, "Type": "DailySchedule" }, "Monthly": { "MarkdownDocumentation": "`Monthly`\n\nA monthly schedule.\n*Required*: No\n*Type*: [MonthlySchedule](./aws-properties-inspectorv2-cisscanconfiguration-monthlyschedule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-schedule.html#cfn-inspectorv2-cisscanconfiguration-schedule-monthly", "UpdateType": "Mutable", "Required": false, "Type": "MonthlySchedule" }, "Weekly": { "MarkdownDocumentation": "`Weekly`\n\nA weekly schedule.\n*Required*: No\n*Type*: [WeeklySchedule](./aws-properties-inspectorv2-cisscanconfiguration-weeklyschedule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-schedule.html#cfn-inspectorv2-cisscanconfiguration-schedule-weekly", "UpdateType": "Mutable", "Required": false, "Type": "WeeklySchedule" }, "OneTime": { "MarkdownDocumentation": "`OneTime`\n\nA one time schedule.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-schedule.html#cfn-inspectorv2-cisscanconfiguration-schedule-onetime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::InspectorV2::CisScanConfiguration.Time": { "MarkdownDocumentation": "`AWS::InspectorV2::CisScanConfiguration.Time`\n\nThe time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-time.html", "Properties": { "TimeOfDay": { "MarkdownDocumentation": "`TimeOfDay`\n\nThe time of day in 24-hour format (00:00).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-time.html#cfn-inspectorv2-cisscanconfiguration-time-timeofday", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeZone": { "MarkdownDocumentation": "`TimeZone`\n\nThe timezone.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-time.html#cfn-inspectorv2-cisscanconfiguration-time-timezone", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::InspectorV2::CisScanConfiguration.WeeklySchedule": { "MarkdownDocumentation": "`AWS::InspectorV2::CisScanConfiguration.WeeklySchedule`\n\nA weekly schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-weeklyschedule.html", "Properties": { "Days": { "MarkdownDocumentation": "`Days`\n\nThe weekly schedule's days.\n*Required*: Yes\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-weeklyschedule.html#cfn-inspectorv2-cisscanconfiguration-weeklyschedule-days", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe weekly schedule's start time.\n*Required*: Yes\n*Type*: [Time](./aws-properties-inspectorv2-cisscanconfiguration-time.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-cisscanconfiguration-weeklyschedule.html#cfn-inspectorv2-cisscanconfiguration-weeklyschedule-starttime", "UpdateType": "Mutable", "Required": true, "Type": "Time" } } }, "AWS::InspectorV2::CodeSecurityIntegration.CreateDetails": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityIntegration.CreateDetails`\n\nContains details required to create a code security integration with a specific\nrepository provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-createdetails.html", "Properties": { "gitlabSelfManaged": { "MarkdownDocumentation": "`gitlabSelfManaged`\n\nDetails specific to creating an integration with a self-managed GitLab\ninstance.\n*Required*: Yes\n*Type*: [CreateGitLabSelfManagedIntegrationDetail](./aws-properties-inspectorv2-codesecurityintegration-creategitlabselfmanagedintegrationdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-createdetails.html#cfn-inspectorv2-codesecurityintegration-createdetails-gitlabselfmanaged", "UpdateType": "Immutable", "Required": true, "Type": "CreateGitLabSelfManagedIntegrationDetail" } } }, "AWS::InspectorV2::CodeSecurityIntegration.CreateGitLabSelfManagedIntegrationDetail": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityIntegration.CreateGitLabSelfManagedIntegrationDetail`\n\nContains details required to create an integration with a self-managed GitLab\ninstance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-creategitlabselfmanagedintegrationdetail.html", "Properties": { "accessToken": { "MarkdownDocumentation": "`accessToken`\n\nThe personal access token used to authenticate with the self-managed GitLab 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-creategitlabselfmanagedintegrationdetail.html#cfn-inspectorv2-codesecurityintegration-creategitlabselfmanagedintegrationdetail-accesstoken", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "instanceUrl": { "MarkdownDocumentation": "`instanceUrl`\n\nThe URL of the self-managed GitLab instance.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https://[-a-zA-Z0-9()@:%_+.~#?&//=]{1,1024}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-creategitlabselfmanagedintegrationdetail.html#cfn-inspectorv2-codesecurityintegration-creategitlabselfmanagedintegrationdetail-instanceurl", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::InspectorV2::CodeSecurityIntegration.UpdateDetails": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityIntegration.UpdateDetails`\n\nContains details required to update a code security integration with a specific\nrepository provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-updatedetails.html", "Properties": { "gitlabSelfManaged": { "MarkdownDocumentation": "`gitlabSelfManaged`\n\nDetails specific to updating an integration with a self-managed GitLab\ninstance.\n*Required*: No\n*Type*: [UpdateGitLabSelfManagedIntegrationDetail](./aws-properties-inspectorv2-codesecurityintegration-updategitlabselfmanagedintegrationdetail.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-updatedetails.html#cfn-inspectorv2-codesecurityintegration-updatedetails-gitlabselfmanaged", "UpdateType": "Mutable", "Required": false, "Type": "UpdateGitLabSelfManagedIntegrationDetail" }, "github": { "MarkdownDocumentation": "`github`\n\nDetails specific to updating an integration with GitHub.\n*Required*: No\n*Type*: [UpdateGitHubIntegrationDetail](./aws-properties-inspectorv2-codesecurityintegration-updategithubintegrationdetail.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-updatedetails.html#cfn-inspectorv2-codesecurityintegration-updatedetails-github", "UpdateType": "Mutable", "Required": false, "Type": "UpdateGitHubIntegrationDetail" } } }, "AWS::InspectorV2::CodeSecurityIntegration.UpdateGitHubIntegrationDetail": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityIntegration.UpdateGitHubIntegrationDetail`\n\nContains details required to update an integration with GitHub.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-updategithubintegrationdetail.html", "Properties": { "code": { "MarkdownDocumentation": "`code`\n\nThe authorization code received from GitHub to update the integration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-updategithubintegrationdetail.html#cfn-inspectorv2-codesecurityintegration-updategithubintegrationdetail-code", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "installationId": { "MarkdownDocumentation": "`installationId`\n\nThe installation ID of the GitHub App associated with the integration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-updategithubintegrationdetail.html#cfn-inspectorv2-codesecurityintegration-updategithubintegrationdetail-installationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::InspectorV2::CodeSecurityIntegration.UpdateGitLabSelfManagedIntegrationDetail": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityIntegration.UpdateGitLabSelfManagedIntegrationDetail`\n\nContains details required to update an integration with a self-managed GitLab\ninstance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-updategitlabselfmanagedintegrationdetail.html", "Properties": { "authCode": { "MarkdownDocumentation": "`authCode`\n\nThe authorization code received from the self-managed GitLab instance to update the\nintegration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityintegration-updategitlabselfmanagedintegrationdetail.html#cfn-inspectorv2-codesecurityintegration-updategitlabselfmanagedintegrationdetail-authcode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::InspectorV2::CodeSecurityScanConfiguration.CodeSecurityScanConfiguration": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityScanConfiguration.CodeSecurityScanConfiguration`\n\nContains the configuration settings for code security scans.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.html", "Properties": { "continuousIntegrationScanConfiguration": { "MarkdownDocumentation": "`continuousIntegrationScanConfiguration`\n\nConfiguration settings for continuous integration scans that run automatically when\ncode changes are made.\n*Required*: No\n*Type*: [ContinuousIntegrationScanConfiguration](./aws-properties-inspectorv2-codesecurityscanconfiguration-continuousintegrationscanconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration-continuousintegrationscanconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ContinuousIntegrationScanConfiguration" }, "periodicScanConfiguration": { "MarkdownDocumentation": "`periodicScanConfiguration`\n\nConfiguration settings for periodic scans that run on a scheduled basis.\n*Required*: No\n*Type*: [PeriodicScanConfiguration](./aws-properties-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration-periodicscanconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PeriodicScanConfiguration" }, "ruleSetCategories": { "MarkdownDocumentation": "`ruleSetCategories`\n\nThe categories of security rules to be applied during the scan.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration-rulesetcategories", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::InspectorV2::CodeSecurityScanConfiguration.ContinuousIntegrationScanConfiguration": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityScanConfiguration.ContinuousIntegrationScanConfiguration`\n\nConfiguration settings for continuous integration scans that run automatically when\ncode changes are made.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-continuousintegrationscanconfiguration.html", "Properties": { "supportedEvents": { "MarkdownDocumentation": "`supportedEvents`\n\nThe repository events that trigger continuous integration scans, such as pull requests\nor commits.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-continuousintegrationscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-continuousintegrationscanconfiguration-supportedevents", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::InspectorV2::CodeSecurityScanConfiguration.PeriodicScanConfiguration": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityScanConfiguration.PeriodicScanConfiguration`\n\nConfiguration settings for periodic scans that run on a scheduled basis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration.html", "Properties": { "frequencyExpression": { "MarkdownDocumentation": "`frequencyExpression`\n\nThe schedule expression for periodic scans, in cron format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration-frequencyexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "frequency": { "MarkdownDocumentation": "`frequency`\n\nThe frequency at which periodic scans are performed (such as weekly or monthly).\nIf you don't provide the `frequencyExpression`Amazon Inspector chooses day for the scan\nto run. If you provide the `frequencyExpression`, the schedule must match the\nspecified `frequency`.\n*Required*: No\n*Type*: String\n*Allowed values*: `WEEKLY | MONTHLY | NEVER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WEEKLY", "MONTHLY", "NEVER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration-frequency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::InspectorV2::CodeSecurityScanConfiguration.ScopeSettings": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityScanConfiguration.ScopeSettings`\n\nThe scope settings that define which repositories will be scanned. If the\n`ScopeSetting` parameter is `ALL` the scan configuration applies\nto all existing and future projects imported into Amazon Inspector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-scopesettings.html", "Properties": { "projectSelectionScope": { "MarkdownDocumentation": "`projectSelectionScope`\n\nThe scope of projects to be selected for scanning within the integrated\nrepositories.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-scopesettings.html#cfn-inspectorv2-codesecurityscanconfiguration-scopesettings-projectselectionscope", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::InspectorV2::Filter.DateFilter": { "MarkdownDocumentation": "`AWS::InspectorV2::Filter.DateFilter`\n\nContains details on the time range used to filter findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-datefilter.html", "Properties": { "EndInclusive": { "MarkdownDocumentation": "`EndInclusive`\n\nA timestamp representing the end of the time period filtered 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-datefilter.html#cfn-inspectorv2-filter-datefilter-endinclusive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "StartInclusive": { "MarkdownDocumentation": "`StartInclusive`\n\nA timestamp representing the start of the time period filtered 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-datefilter.html#cfn-inspectorv2-filter-datefilter-startinclusive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" } } }, "AWS::InspectorV2::Filter.FilterCriteria": { "MarkdownDocumentation": "`AWS::InspectorV2::Filter.FilterCriteria`\n\nDetails on the criteria used to define the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html", "Properties": { "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nDetails on the resource tags used to filter findings.\n*Required*: No\n*Type*: Array of [MapFilter](./aws-properties-inspectorv2-filter-mapfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MapFilter", "DuplicatesAllowed": true }, "Ec2InstanceImageId": { "MarkdownDocumentation": "`Ec2InstanceImageId`\n\nDetails of the Amazon EC2 instance image IDs used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ec2instanceimageid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "FirstObservedAt": { "MarkdownDocumentation": "`FirstObservedAt`\n\nDetails on the date and time a finding was first seen used to filter findings.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-inspectorv2-filter-datefilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-firstobservedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "InspectorScore": { "MarkdownDocumentation": "`InspectorScore`\n\nThe Amazon Inspector score to filter on.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-inspectorv2-filter-numberfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-inspectorscore", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": true }, "Ec2InstanceVpcId": { "MarkdownDocumentation": "`Ec2InstanceVpcId`\n\nDetails of the Amazon EC2 instance VPC IDs used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ec2instancevpcid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "LambdaFunctionName": { "MarkdownDocumentation": "`LambdaFunctionName`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-lambdafunctionname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "LambdaFunctionRuntime": { "MarkdownDocumentation": "`LambdaFunctionRuntime`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-lambdafunctionruntime", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "LastObservedAt": { "MarkdownDocumentation": "`LastObservedAt`\n\nDetails on the date and time a finding was last seen used to filter findings.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-inspectorv2-filter-datefilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-lastobservedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "EcrImagePushedAt": { "MarkdownDocumentation": "`EcrImagePushedAt`\n\nDetails on the Amazon ECR image push date and time used to filter findings.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-inspectorv2-filter-datefilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ecrimagepushedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "LambdaFunctionLayers": { "MarkdownDocumentation": "`LambdaFunctionLayers`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-lambdafunctionlayers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "FixAvailable": { "MarkdownDocumentation": "`FixAvailable`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-fixavailable", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ExploitAvailable": { "MarkdownDocumentation": "`ExploitAvailable`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-exploitavailable", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "EcrImageArchitecture": { "MarkdownDocumentation": "`EcrImageArchitecture`\n\nDetails of the Amazon ECR image architecture types used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ecrimagearchitecture", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "RelatedVulnerabilities": { "MarkdownDocumentation": "`RelatedVulnerabilities`\n\nDetails on the related vulnerabilities used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-relatedvulnerabilities", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "EcrImageTags": { "MarkdownDocumentation": "`EcrImageTags`\n\nThe tags attached to the Amazon ECR container image.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ecrimagetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "VulnerabilityId": { "MarkdownDocumentation": "`VulnerabilityId`\n\nDetails on the vulnerability ID used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-vulnerabilityid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ComponentType": { "MarkdownDocumentation": "`ComponentType`\n\nDetails of the component types used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-componenttype", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "LambdaFunctionExecutionRoleArn": { "MarkdownDocumentation": "`LambdaFunctionExecutionRoleArn`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-lambdafunctionexecutionrolearn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "VendorSeverity": { "MarkdownDocumentation": "`VendorSeverity`\n\nDetails on the vendor severity used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-vendorseverity", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "CodeVulnerabilityDetectorTags": { "MarkdownDocumentation": "`CodeVulnerabilityDetectorTags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-codevulnerabilitydetectortags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "CodeVulnerabilityDetectorName": { "MarkdownDocumentation": "`CodeVulnerabilityDetectorName`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-codevulnerabilitydetectorname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "EcrImageRepositoryName": { "MarkdownDocumentation": "`EcrImageRepositoryName`\n\nDetails on the name of the Amazon ECR repository used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ecrimagerepositoryname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nDetails on the finding title used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-title", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nDetails on the resource types used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-resourcetype", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "Severity": { "MarkdownDocumentation": "`Severity`\n\nDetails on the severity used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-severity", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "NetworkProtocol": { "MarkdownDocumentation": "`NetworkProtocol`\n\nDetails on network protocol used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-networkprotocol", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "UpdatedAt": { "MarkdownDocumentation": "`UpdatedAt`\n\nDetails on the date and time a finding was last updated at used to filter\nfindings.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-inspectorv2-filter-datefilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-updatedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "CodeVulnerabilityFilePath": { "MarkdownDocumentation": "`CodeVulnerabilityFilePath`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-codevulnerabilityfilepath", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "EcrImageHash": { "MarkdownDocumentation": "`EcrImageHash`\n\nDetails of the Amazon ECR image hashes used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ecrimagehash", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "LambdaFunctionLastModifiedAt": { "MarkdownDocumentation": "`LambdaFunctionLastModifiedAt`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-inspectorv2-filter-datefilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-lambdafunctionlastmodifiedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "PortRange": { "MarkdownDocumentation": "`PortRange`\n\nDetails on the port ranges used to filter findings.\n*Required*: No\n*Type*: Array of [PortRangeFilter](./aws-properties-inspectorv2-filter-portrangefilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-portrange", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRangeFilter", "DuplicatesAllowed": true }, "VulnerabilitySource": { "MarkdownDocumentation": "`VulnerabilitySource`\n\nDetails on the vulnerability score to filter findings by.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-vulnerabilitysource", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "Ec2InstanceSubnetId": { "MarkdownDocumentation": "`Ec2InstanceSubnetId`\n\nDetails of the Amazon EC2 instance subnet IDs used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ec2instancesubnetid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "FindingArn": { "MarkdownDocumentation": "`FindingArn`\n\nDetails on the finding ARNs used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-findingarn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nDetails on the resource IDs used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-resourceid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "FindingStatus": { "MarkdownDocumentation": "`FindingStatus`\n\nDetails on the finding status types used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-findingstatus", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "VulnerablePackages": { "MarkdownDocumentation": "`VulnerablePackages`\n\nDetails on the vulnerable packages used to filter findings.\n*Required*: No\n*Type*: Array of [PackageFilter](./aws-properties-inspectorv2-filter-packagefilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-vulnerablepackages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PackageFilter", "DuplicatesAllowed": true }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nDetails of the AWS account IDs used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-awsaccountid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "EpssScore": { "MarkdownDocumentation": "`EpssScore`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-inspectorv2-filter-numberfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-epssscore", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": true }, "ComponentId": { "MarkdownDocumentation": "`ComponentId`\n\nDetails of the component IDs used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-componentid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "EcrImageRegistry": { "MarkdownDocumentation": "`EcrImageRegistry`\n\nDetails on the Amazon ECR registry used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-ecrimageregistry", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "FindingType": { "MarkdownDocumentation": "`FindingType`\n\nDetails on the finding types used to filter findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-filtercriteria.html#cfn-inspectorv2-filter-filtercriteria-findingtype", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true } } }, "AWS::InspectorV2::Filter.MapFilter": { "MarkdownDocumentation": "`AWS::InspectorV2::Filter.MapFilter`\n\nAn object that describes details of a map filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-mapfilter.html", "Properties": { "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe operator to use when comparing values in the filter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-mapfilter.html#cfn-inspectorv2-filter-mapfilter-comparison", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag value used in the filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-mapfilter.html#cfn-inspectorv2-filter-mapfilter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag key used in the filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-mapfilter.html#cfn-inspectorv2-filter-mapfilter-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::InspectorV2::Filter.NumberFilter": { "MarkdownDocumentation": "`AWS::InspectorV2::Filter.NumberFilter`\n\nAn object that describes the details of a number filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-numberfilter.html", "Properties": { "LowerInclusive": { "MarkdownDocumentation": "`LowerInclusive`\n\nThe lowest number to be included in the filter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-numberfilter.html#cfn-inspectorv2-filter-numberfilter-lowerinclusive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "UpperInclusive": { "MarkdownDocumentation": "`UpperInclusive`\n\nThe highest number to be included in the filter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-numberfilter.html#cfn-inspectorv2-filter-numberfilter-upperinclusive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::InspectorV2::Filter.PackageFilter": { "MarkdownDocumentation": "`AWS::InspectorV2::Filter.PackageFilter`\n\nContains information on the details of a package filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html", "Properties": { "FilePath": { "MarkdownDocumentation": "`FilePath`\n\nProperty description not available.\n*Required*: No\n*Type*: [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html#cfn-inspectorv2-filter-packagefilter-filepath", "UpdateType": "Mutable", "Required": false, "Type": "StringFilter" }, "Architecture": { "MarkdownDocumentation": "`Architecture`\n\nAn object that contains details on the package architecture type to filter on.\n*Required*: No\n*Type*: [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html#cfn-inspectorv2-filter-packagefilter-architecture", "UpdateType": "Mutable", "Required": false, "Type": "StringFilter" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe package version to filter on.\n*Required*: No\n*Type*: [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html#cfn-inspectorv2-filter-packagefilter-version", "UpdateType": "Mutable", "Required": false, "Type": "StringFilter" }, "Epoch": { "MarkdownDocumentation": "`Epoch`\n\nAn object that contains details on the package epoch to filter on.\n*Required*: No\n*Type*: [NumberFilter](./aws-properties-inspectorv2-filter-numberfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html#cfn-inspectorv2-filter-packagefilter-epoch", "UpdateType": "Mutable", "Required": false, "Type": "NumberFilter" }, "SourceLayerHash": { "MarkdownDocumentation": "`SourceLayerHash`\n\nAn object that contains details on the source layer hash to filter on.\n*Required*: No\n*Type*: [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html#cfn-inspectorv2-filter-packagefilter-sourcelayerhash", "UpdateType": "Mutable", "Required": false, "Type": "StringFilter" }, "SourceLambdaLayerArn": { "MarkdownDocumentation": "`SourceLambdaLayerArn`\n\nProperty description not available.\n*Required*: No\n*Type*: [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html#cfn-inspectorv2-filter-packagefilter-sourcelambdalayerarn", "UpdateType": "Mutable", "Required": false, "Type": "StringFilter" }, "Release": { "MarkdownDocumentation": "`Release`\n\nAn object that contains details on the package release to filter on.\n*Required*: No\n*Type*: [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html#cfn-inspectorv2-filter-packagefilter-release", "UpdateType": "Mutable", "Required": false, "Type": "StringFilter" }, "Name": { "MarkdownDocumentation": "`Name`\n\nAn object that contains details on the name of the package to filter on.\n*Required*: No\n*Type*: [StringFilter](./aws-properties-inspectorv2-filter-stringfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-packagefilter.html#cfn-inspectorv2-filter-packagefilter-name", "UpdateType": "Mutable", "Required": false, "Type": "StringFilter" } } }, "AWS::InspectorV2::Filter.PortRangeFilter": { "MarkdownDocumentation": "`AWS::InspectorV2::Filter.PortRangeFilter`\n\nAn object that describes the details of a port range filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-portrangefilter.html", "Properties": { "BeginInclusive": { "MarkdownDocumentation": "`BeginInclusive`\n\nThe port number the port range begins at.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-portrangefilter.html#cfn-inspectorv2-filter-portrangefilter-begininclusive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EndInclusive": { "MarkdownDocumentation": "`EndInclusive`\n\nThe port number the port range ends at.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-portrangefilter.html#cfn-inspectorv2-filter-portrangefilter-endinclusive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::InspectorV2::Filter.StringFilter": { "MarkdownDocumentation": "`AWS::InspectorV2::Filter.StringFilter`\n\nAn object that describes the details of a string filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-stringfilter.html", "Properties": { "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe operator to use when comparing values in the filter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | PREFIX | 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)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "PREFIX", "NOT_EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-stringfilter.html#cfn-inspectorv2-filter-stringfilter-comparison", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to filter on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-filter-stringfilter.html#cfn-inspectorv2-filter-stringfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::InternetMonitor::Monitor.HealthEventsConfig": { "MarkdownDocumentation": "`AWS::InternetMonitor::Monitor.HealthEventsConfig`\n\nDefine the health event threshold percentages for the performance score and availability score for your application's\nmonitor. Amazon CloudWatch Internet Monitor creates a health event when there's an internet issue that\naffects your application end users where a health score percentage is at or below a set threshold.\nIf you don't set a health event threshold, the default value is 95%.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html", "Properties": { "AvailabilityLocalHealthEventsConfig": { "MarkdownDocumentation": "`AvailabilityLocalHealthEventsConfig`\n\nThe configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.\n*Required*: No\n*Type*: [LocalHealthEventsConfig](./aws-properties-internetmonitor-monitor-localhealtheventsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-availabilitylocalhealtheventsconfig", "UpdateType": "Mutable", "Required": false, "Type": "LocalHealthEventsConfig" }, "PerformanceScoreThreshold": { "MarkdownDocumentation": "`PerformanceScoreThreshold`\n\nThe health event threshold percentage set for performance scores. When the overall performance\nscore is at or below this percentage, Internet Monitor creates a health event.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-performancescorethreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PerformanceLocalHealthEventsConfig": { "MarkdownDocumentation": "`PerformanceLocalHealthEventsConfig`\n\nThe configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.\n*Required*: No\n*Type*: [LocalHealthEventsConfig](./aws-properties-internetmonitor-monitor-localhealtheventsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-performancelocalhealtheventsconfig", "UpdateType": "Mutable", "Required": false, "Type": "LocalHealthEventsConfig" }, "AvailabilityScoreThreshold": { "MarkdownDocumentation": "`AvailabilityScoreThreshold`\n\nThe health event threshold percentage set for availability scores. When the overall availability\nscore is at or below this percentage, Internet Monitor creates a health event.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-availabilityscorethreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::InternetMonitor::Monitor.InternetMeasurementsLogDelivery": { "MarkdownDocumentation": "`AWS::InternetMonitor::Monitor.InternetMeasurementsLogDelivery`\n\nPublish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-internetmeasurementslogdelivery.html", "Properties": { "S3Config": { "MarkdownDocumentation": "`S3Config`\n\nThe configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.\n*Required*: No\n*Type*: [S3Config](./aws-properties-internetmonitor-monitor-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-internetmeasurementslogdelivery.html#cfn-internetmonitor-monitor-internetmeasurementslogdelivery-s3config", "UpdateType": "Mutable", "Required": false, "Type": "S3Config" } } }, "AWS::InternetMonitor::Monitor.LocalHealthEventsConfig": { "MarkdownDocumentation": "`AWS::InternetMonitor::Monitor.LocalHealthEventsConfig`\n\nConfiguration information that determines the threshold and other conditions for when Internet Monitor creates a health event\nfor a local performance or availability issue, when scores cross a threshold for one or more city-networks.\nDefines the percentages, for performance scores or availability scores, that are the local thresholds\nfor when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage\nof overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.\nIf you don't set a local health event threshold, the default value is 60%.\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *Amazon CloudWatch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be `ENABLED`\nor `DISABLED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html#cfn-internetmonitor-monitor-localhealtheventsconfig-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HealthScoreThreshold": { "MarkdownDocumentation": "`HealthScoreThreshold`\n\nThe health event threshold percentage set for a local health score.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html#cfn-internetmonitor-monitor-localhealtheventsconfig-healthscorethreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MinTrafficImpact": { "MarkdownDocumentation": "`MinTrafficImpact`\n\nThe minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a\nthreshold is crossed for a local health score.\nIf you don't set a minimum traffic impact threshold, the default value is 0.01%.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html#cfn-internetmonitor-monitor-localhealtheventsconfig-mintrafficimpact", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::InternetMonitor::Monitor.S3Config": { "MarkdownDocumentation": "`AWS::InternetMonitor::Monitor.S3Config`\n\nThe configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration\nincludes the bucket name and (optionally) bucket prefix for the S3 bucket to store the measurements, and the delivery status.\nThe delivery status is `ENABLED` if you choose to deliver internet measurements to S3 logs, and `DISABLED` otherwise.\nThe measurements are also published to Amazon CloudWatch Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe Amazon S3 bucket name for internet measurements publishing.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogDeliveryStatus": { "MarkdownDocumentation": "`LogDeliveryStatus`\n\nThe status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is `ENABLED`\nif you choose to deliver internet measurements to an S3 bucket, and `DISABLED` otherwise.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-logdeliverystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nAn optional Amazon S3 bucket prefix for internet measurements publishing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-bucketprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Invoicing::InvoiceUnit.ResourceTag": { "MarkdownDocumentation": "`AWS::Invoicing::InvoiceUnit.ResourceTag`\n\nThe tag structure that contains a tag key and value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-invoiceunit-resourcetag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe specific value of the resource tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-invoiceunit-resourcetag.html#cfn-invoicing-invoiceunit-resourcetag-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe object key of your of your resource tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-invoiceunit-resourcetag.html#cfn-invoicing-invoiceunit-resourcetag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Invoicing::InvoiceUnit.Rule": { "MarkdownDocumentation": "`AWS::Invoicing::InvoiceUnit.Rule`\n\nThe `InvoiceUnitRule` object used to update invoice units.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-invoiceunit-rule.html", "Properties": { "LinkedAccounts": { "MarkdownDocumentation": "`LinkedAccounts`\n\nThe list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-invoiceunit-rule.html#cfn-invoicing-invoiceunit-rule-linkedaccounts", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration": { "MarkdownDocumentation": "`AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration`\n\nWhich audit checks are enabled and disabled for this account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nTrue if this audit check is enabled for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html#cfn-iot-accountauditconfiguration-auditcheckconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoT::AccountAuditConfiguration.AuditCheckConfigurations": { "MarkdownDocumentation": "`AWS::IoT::AccountAuditConfiguration.AuditCheckConfigurations`\n\nThe types of audit checks that can be performed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html", "Properties": { "IotRoleAliasOverlyPermissiveCheck": { "MarkdownDocumentation": "`IotRoleAliasOverlyPermissiveCheck`\n\nChecks if the temporary credentials provided by AWS IoT role aliases are\noverly permissive.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-iotrolealiasoverlypermissivecheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "DeviceCertificateSharedCheck": { "MarkdownDocumentation": "`DeviceCertificateSharedCheck`\n\nChecks if multiple concurrent connections use the same X.509 certificate to authenticate\nwith AWS IoT.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-devicecertificatesharedcheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "ConflictingClientIdsCheck": { "MarkdownDocumentation": "`ConflictingClientIdsCheck`\n\nChecks if multiple devices connect using the same client ID.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-conflictingclientidscheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "IntermediateCaRevokedForActiveDeviceCertificatesCheck": { "MarkdownDocumentation": "`IntermediateCaRevokedForActiveDeviceCertificatesCheck`\n\nChecks if device certificates are still active despite being revoked by an intermediate\nCA.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-intermediatecarevokedforactivedevicecertificatescheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "IotRoleAliasAllowsAccessToUnusedServicesCheck": { "MarkdownDocumentation": "`IotRoleAliasAllowsAccessToUnusedServicesCheck`\n\nChecks 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-iotrolealiasallowsaccesstounusedservicescheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "RevokedCaCertificateStillActiveCheck": { "MarkdownDocumentation": "`RevokedCaCertificateStillActiveCheck`\n\nChecks if a revoked CA certificate is still active.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-revokedcacertificatestillactivecheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "LoggingDisabledCheck": { "MarkdownDocumentation": "`LoggingDisabledCheck`\n\nChecks if AWS IoT logs are disabled.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-loggingdisabledcheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "UnauthenticatedCognitoRoleOverlyPermissiveCheck": { "MarkdownDocumentation": "`UnauthenticatedCognitoRoleOverlyPermissiveCheck`\n\nChecks if policy attached to an unauthenticated Amazon Cognito identity pool role is too\npermissive.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-unauthenticatedcognitoroleoverlypermissivecheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "AuthenticatedCognitoRoleOverlyPermissiveCheck": { "MarkdownDocumentation": "`AuthenticatedCognitoRoleOverlyPermissiveCheck`\n\nChecks the permissiveness of an authenticated Amazon Cognito identity pool role. For\nthis check, AWS IoT Device Defender audits all Amazon Cognito identity pools that have been\nused to connect to the AWS IoT message broker during the 31 days before the\naudit is performed.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-authenticatedcognitoroleoverlypermissivecheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "CaCertificateExpiringCheck": { "MarkdownDocumentation": "`CaCertificateExpiringCheck`\n\nChecks if a CA certificate is expiring. This check applies to CA certificates expiring\nwithin 30 days or that have expired.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-cacertificateexpiringcheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "DeviceCertificateExpiringCheck": { "MarkdownDocumentation": "`DeviceCertificateExpiringCheck`\n\nChecks if a device certificate is expiring. By default, this check applies to device certificates expiring within 30 days or that have expired. You can modify this threshold by configuring the DeviceCertExpirationAuditCheckConfiguration.\n*Required*: No\n*Type*: [DeviceCertExpirationAuditCheckConfiguration](./aws-properties-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-devicecertificateexpiringcheck", "UpdateType": "Mutable", "Required": false, "Type": "DeviceCertExpirationAuditCheckConfiguration" }, "IoTPolicyPotentialMisConfigurationCheck": { "MarkdownDocumentation": "`IoTPolicyPotentialMisConfigurationCheck`\n\nChecks if an AWS IoT policy is potentially misconfigured. Misconfigured\npolicies, including overly permissive policies, can cause security incidents like allowing\ndevices access to unintended resources. This check is a warning for you to make sure that\nonly intended actions are allowed before updating the policy.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-iotpolicypotentialmisconfigurationcheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "DeviceCertificateAgeCheck": { "MarkdownDocumentation": "`DeviceCertificateAgeCheck`\n\nChecks when a device certificate has been active for a number of days greater than or equal to the number you specify.\n*Required*: No\n*Type*: [DeviceCertAgeAuditCheckConfiguration](./aws-properties-iot-accountauditconfiguration-devicecertageauditcheckconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-devicecertificateagecheck", "UpdateType": "Mutable", "Required": false, "Type": "DeviceCertAgeAuditCheckConfiguration" }, "IotPolicyOverlyPermissiveCheck": { "MarkdownDocumentation": "`IotPolicyOverlyPermissiveCheck`\n\nChecks the permissiveness of a policy attached to an authenticated Amazon Cognito\nidentity pool role.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-iotpolicyoverlypermissivecheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "RevokedDeviceCertificateStillActiveCheck": { "MarkdownDocumentation": "`RevokedDeviceCertificateStillActiveCheck`\n\nChecks if a revoked device certificate is still active.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-revokeddevicecertificatestillactivecheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "DeviceCertificateKeyQualityCheck": { "MarkdownDocumentation": "`DeviceCertificateKeyQualityCheck`\n\nChecks the quality of the device certificate key. The quality checks if the key is in a\nvalid format, not expired, signed by a registered certificate authority, and if the key\nmeets a minimum required size.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-devicecertificatekeyqualitycheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" }, "CaCertificateKeyQualityCheck": { "MarkdownDocumentation": "`CaCertificateKeyQualityCheck`\n\nChecks the quality of the CA certificate key. The quality checks if the key is in a\nvalid format, not expired, and if the key meets a minimum required size. This check applies\nto CA certificates that are `ACTIVE` or `PENDING_TRANSFER`.\n*Required*: No\n*Type*: [AuditCheckConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-cacertificatekeyqualitycheck", "UpdateType": "Mutable", "Required": false, "Type": "AuditCheckConfiguration" } } }, "AWS::IoT::AccountAuditConfiguration.AuditNotificationTarget": { "MarkdownDocumentation": "`AWS::IoT::AccountAuditConfiguration.AuditNotificationTarget`\n\nInformation about the targets to which audit notifications are sent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html", "Properties": { "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe ARN of the target (SNS topic) to which audit notifications are sent.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html#cfn-iot-accountauditconfiguration-auditnotificationtarget-targetarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nTrue if notifications to the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html#cfn-iot-accountauditconfiguration-auditnotificationtarget-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants permission to send notifications to the target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html#cfn-iot-accountauditconfiguration-auditnotificationtarget-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::AccountAuditConfiguration.AuditNotificationTargetConfigurations": { "MarkdownDocumentation": "`AWS::IoT::AccountAuditConfiguration.AuditNotificationTargetConfigurations`\n\nThe configuration of the audit notification target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtargetconfigurations.html", "Properties": { "Sns": { "MarkdownDocumentation": "`Sns`\n\nThe `Sns` notification target.\n*Required*: No\n*Type*: [AuditNotificationTarget](./aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtargetconfigurations.html#cfn-iot-accountauditconfiguration-auditnotificationtargetconfigurations-sns", "UpdateType": "Mutable", "Required": false, "Type": "AuditNotificationTarget" } } }, "AWS::IoT::AccountAuditConfiguration.CertAgeCheckCustomConfiguration": { "MarkdownDocumentation": "`AWS::IoT::AccountAuditConfiguration.CertAgeCheckCustomConfiguration`\n\nConfiguration structure containing settings for the device certificate age check.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-certagecheckcustomconfiguration.html", "Properties": { "CertAgeThresholdInDays": { "MarkdownDocumentation": "`CertAgeThresholdInDays`\n\nThe number of days that defines when a device certificate is considered to have aged. The check will report a finding if a certificate has been active for a number of days greater than or equal to this threshold value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-certagecheckcustomconfiguration.html#cfn-iot-accountauditconfiguration-certagecheckcustomconfiguration-certagethresholdindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::AccountAuditConfiguration.CertExpirationCheckCustomConfiguration": { "MarkdownDocumentation": "`AWS::IoT::AccountAuditConfiguration.CertExpirationCheckCustomConfiguration`\n\nConfiguration structure containing settings for the device certificate expiration check.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-certexpirationcheckcustomconfiguration.html", "Properties": { "CertExpirationThresholdInDays": { "MarkdownDocumentation": "`CertExpirationThresholdInDays`\n\nThe number of days before expiration that defines when a device certificate is considered to be approaching expiration. The check will report a finding if a certificate will expire within this number of days.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-certexpirationcheckcustomconfiguration.html#cfn-iot-accountauditconfiguration-certexpirationcheckcustomconfiguration-certexpirationthresholdindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::AccountAuditConfiguration.DeviceCertAgeAuditCheckConfiguration": { "MarkdownDocumentation": "`AWS::IoT::AccountAuditConfiguration.DeviceCertAgeAuditCheckConfiguration`\n\nConfiguration for the device certificate age audit check.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertageauditcheckconfiguration.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nConfiguration settings for the device certificate age check, including the threshold in days for certificate age. This configuration is of type `CertAgeCheckCustomConfiguration`.\n*Required*: No\n*Type*: [CertAgeCheckCustomConfiguration](./aws-properties-iot-accountauditconfiguration-certagecheckcustomconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertageauditcheckconfiguration.html#cfn-iot-accountauditconfiguration-devicecertageauditcheckconfiguration-configuration", "UpdateType": "Mutable", "Required": false, "Type": "CertAgeCheckCustomConfiguration" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nTrue if this audit check is enabled for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertageauditcheckconfiguration.html#cfn-iot-accountauditconfiguration-devicecertageauditcheckconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoT::AccountAuditConfiguration.DeviceCertExpirationAuditCheckConfiguration": { "MarkdownDocumentation": "`AWS::IoT::AccountAuditConfiguration.DeviceCertExpirationAuditCheckConfiguration`\n\nConfiguration for the device certificate expiration audit check.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nConfiguration settings for the device certificate expiration check, including the threshold in days before expiration. This configuration is of type `CertExpirationCheckCustomConfiguration`\n*Required*: No\n*Type*: [CertExpirationCheckCustomConfiguration](./aws-properties-iot-accountauditconfiguration-certexpirationcheckcustomconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration.html#cfn-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration-configuration", "UpdateType": "Mutable", "Required": false, "Type": "CertExpirationCheckCustomConfiguration" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nTrue if this audit check is enabled for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration.html#cfn-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoT::BillingGroup.BillingGroupProperties": { "MarkdownDocumentation": "`AWS::IoT::BillingGroup.BillingGroupProperties`\n\nThe properties of a billing group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-billinggroup-billinggroupproperties.html", "Properties": { "BillingGroupDescription": { "MarkdownDocumentation": "`BillingGroupDescription`\n\nThe description of the billing group.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{Graph}\\x20]*`\n*Maximum*: `2028`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-billinggroup-billinggroupproperties.html#cfn-iot-billinggroup-billinggroupproperties-billinggroupdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::CACertificate.RegistrationConfig": { "MarkdownDocumentation": "`AWS::IoT::CACertificate.RegistrationConfig`\n\nThe registration configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-cacertificate-registrationconfig.html", "Properties": { "TemplateName": { "MarkdownDocumentation": "`TemplateName`\n\nThe name of the provisioning template.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_-]+$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-cacertificate-registrationconfig.html#cfn-iot-cacertificate-registrationconfig-templatename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TemplateBody": { "MarkdownDocumentation": "`TemplateBody`\n\nThe template body.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-cacertificate-registrationconfig.html#cfn-iot-cacertificate-registrationconfig-templatebody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-cacertificate-registrationconfig.html#cfn-iot-cacertificate-registrationconfig-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::Command.CommandParameter": { "MarkdownDocumentation": "`AWS::IoT::Command.CommandParameter`\n\nThe `CommandParameter` property type specifies Property description not available. for an [AWS::IoT::Command](./aws-resource-iot-command.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nProperty description not available.\n*Required*: No\n*Type*: [CommandParameterValue](./aws-properties-iot-command-commandparametervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html#cfn-iot-command-commandparameter-defaultvalue", "UpdateType": "Mutable", "Required": false, "Type": "CommandParameterValue" }, "Description": { "MarkdownDocumentation": "`Description`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Maximum*: `2028`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html#cfn-iot-command-commandparameter-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: No\n*Type*: [CommandParameterValue](./aws-properties-iot-command-commandparametervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html#cfn-iot-command-commandparameter-value", "UpdateType": "Mutable", "Required": false, "Type": "CommandParameterValue" }, "Name": { "MarkdownDocumentation": "`Name`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[.$a-zA-Z0-9_-]+$`\n*Minimum*: `1`\n*Maximum*: `192`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparameter.html#cfn-iot-command-commandparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::Command.CommandParameterValue": { "MarkdownDocumentation": "`AWS::IoT::Command.CommandParameterValue`\n\nThe `CommandParameterValue` property type specifies Property description not available. for an [AWS::IoT::Command](./aws-resource-iot-command.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html", "Properties": { "B": { "MarkdownDocumentation": "`B`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-b", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "S": { "MarkdownDocumentation": "`S`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-s", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "D": { "MarkdownDocumentation": "`D`\n\nProperty description not available.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-d", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "BIN": { "MarkdownDocumentation": "`BIN`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-bin", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UL": { "MarkdownDocumentation": "`UL`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-ul", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "I": { "MarkdownDocumentation": "`I`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-i", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "L": { "MarkdownDocumentation": "`L`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^-?\\d+$`\n*Maximum*: `19`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandparametervalue.html#cfn-iot-command-commandparametervalue-l", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::Command.CommandPayload": { "MarkdownDocumentation": "`AWS::IoT::Command.CommandPayload`\n\nThe `CommandPayload` property type specifies Property description not available. for an [AWS::IoT::Command](./aws-resource-iot-command.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandpayload.html", "Properties": { "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandpayload.html#cfn-iot-command-commandpayload-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-command-commandpayload.html#cfn-iot-command-commandpayload-content", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::DomainConfiguration.AuthorizerConfig": { "MarkdownDocumentation": "`AWS::IoT::DomainConfiguration.AuthorizerConfig`\n\nAn object that specifies the authorization service for a domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-authorizerconfig.html", "Properties": { "DefaultAuthorizerName": { "MarkdownDocumentation": "`DefaultAuthorizerName`\n\nThe name of the authorization service for a domain configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w=,@-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-authorizerconfig.html#cfn-iot-domainconfiguration-authorizerconfig-defaultauthorizername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllowAuthorizerOverride": { "MarkdownDocumentation": "`AllowAuthorizerOverride`\n\nA Boolean that specifies whether the domain configuration's authorization service can be overridden.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-authorizerconfig.html#cfn-iot-domainconfiguration-authorizerconfig-allowauthorizeroverride", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoT::DomainConfiguration.ClientCertificateConfig": { "MarkdownDocumentation": "`AWS::IoT::DomainConfiguration.ClientCertificateConfig`\n\nAn object that speci\ufb01es the client certificate con\ufb01guration for a domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-clientcertificateconfig.html", "Properties": { "ClientCertificateCallbackArn": { "MarkdownDocumentation": "`ClientCertificateCallbackArn`\n\nThe ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `170`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-clientcertificateconfig.html#cfn-iot-domainconfiguration-clientcertificateconfig-clientcertificatecallbackarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::DomainConfiguration.ServerCertificateConfig": { "MarkdownDocumentation": "`AWS::IoT::DomainConfiguration.ServerCertificateConfig`\n\nThe server certificate configuration.\nFor more information, see [Configurable\nendpoints](https://docs.aws.amazon.com//iot/latest/developerguide/iot-custom-endpoints-configurable.html) from the AWS IoT Core Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificateconfig.html", "Properties": { "EnableOCSPCheck": { "MarkdownDocumentation": "`EnableOCSPCheck`\n\nA Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server\ncertificate check is enabled or not. For more information, see [Configurable\nendpoints](https://docs.aws.amazon.com//iot/latest/developerguide/iot-custom-endpoints-configurable.html) from the AWS IoT Core 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificateconfig.html#cfn-iot-domainconfiguration-servercertificateconfig-enableocspcheck", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "OcspLambdaArn": { "MarkdownDocumentation": "`OcspLambdaArn`\n\nThe Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments\n(RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic\nOCSP responses. The Lambda function accepts a base64-encoding of the OCSP request in the\nDistinguished Encoding Rules (DER) format. The Lambda function's response is also a\nbase64-encoded OCSP response in the DER format. The response size must not exceed 4\nkilobytes (KiB). The Lambda function must be in the same account and region as\nthe domain configuration.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `170`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificateconfig.html#cfn-iot-domainconfiguration-servercertificateconfig-ocsplambdaarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OcspAuthorizedResponderArn": { "MarkdownDocumentation": "`OcspAuthorizedResponderArn`\n\nThe Amazon Resource Name (ARN) for an X.509 certificate stored in ACM.\nIf provided, AWS IoT Core will use this certificate to validate the signature\nof the received OCSP response. The OCSP responder must sign responses using either this\nauthorized responder certificate or the issuing certificate, depending on whether the ARN\nis provided or not. The certificate must be in the same account and region as the\ndomain configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificateconfig.html#cfn-iot-domainconfiguration-servercertificateconfig-ocspauthorizedresponderarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::DomainConfiguration.ServerCertificateSummary": { "MarkdownDocumentation": "`AWS::IoT::DomainConfiguration.ServerCertificateSummary`\n\nAn object that contains information about a server certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificatesummary.html", "Properties": { "ServerCertificateStatusDetail": { "MarkdownDocumentation": "`ServerCertificateStatusDetail`\n\nDetails that explain the status of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificatesummary.html#cfn-iot-domainconfiguration-servercertificatesummary-servercertificatestatusdetail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerCertificateArn": { "MarkdownDocumentation": "`ServerCertificateArn`\n\nThe ARN of the server certificate.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificatesummary.html#cfn-iot-domainconfiguration-servercertificatesummary-servercertificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerCertificateStatus": { "MarkdownDocumentation": "`ServerCertificateStatus`\n\nThe status of the server certificate.\n*Required*: No\n*Type*: String\n*Allowed values*: `INVALID | VALID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INVALID", "VALID" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificatesummary.html#cfn-iot-domainconfiguration-servercertificatesummary-servercertificatestatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::DomainConfiguration.TlsConfig": { "MarkdownDocumentation": "`AWS::IoT::DomainConfiguration.TlsConfig`\n\nAn object that specifies the TLS configuration for a domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-tlsconfig.html", "Properties": { "SecurityPolicy": { "MarkdownDocumentation": "`SecurityPolicy`\n\nThe security policy for a domain configuration. For more information, see [Security\npolicies](https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html#tls-policy-table) in the *AWS IoT Core developer guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-tlsconfig.html#cfn-iot-domainconfiguration-tlsconfig-securitypolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::EncryptionConfiguration.ConfigurationDetails": { "MarkdownDocumentation": "`AWS::IoT::EncryptionConfiguration.ConfigurationDetails`\n\nThe encryption configuration details that include the status information of the AWS Key Management Service (AWS KMS) key and the AWS KMS access role.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html", "Properties": { "ConfigurationStatus": { "MarkdownDocumentation": "`ConfigurationStatus`\n\nThe health status of KMS key and AWS KMS access role. If either KMS key or AWS KMS access role\nis `UNHEALTHY`, the return value will be `UNHEALTHY`. To use a\ncustomer managed KMS key, the value of `configurationStatus` must be\n`HEALTHY`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HEALTHY | UNHEALTHY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HEALTHY", "UNHEALTHY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-configurationstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ErrorCode": { "MarkdownDocumentation": "`ErrorCode`\n\nThe error code that indicates either the KMS key or the AWS KMS access role is `UNHEALTHY`.\nValid values: `KMS_KEY_VALIDATION_ERROR` and `ROLE_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-errorcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ErrorMessage": { "MarkdownDocumentation": "`ErrorMessage`\n\nThe detailed error message that corresponds to the `errorCode`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-errormessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::FleetMetric.AggregationType": { "MarkdownDocumentation": "`AWS::IoT::FleetMetric.AggregationType`\n\nThe type of aggregation queries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-fleetmetric-aggregationtype.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nA list of the values of aggregation types.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-fleetmetric-aggregationtype.html#cfn-iot-fleetmetric-aggregationtype-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the aggregation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-fleetmetric-aggregationtype.html#cfn-iot-fleetmetric-aggregationtype-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::JobTemplate.AbortConfig": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.AbortConfig`\n\nThe criteria that determine when and how a job abort takes place.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortconfig.html", "Properties": { "CriteriaList": { "MarkdownDocumentation": "`CriteriaList`\n\nThe list of criteria that determine when and how to abort the job.\n*Required*: Yes\n*Type*: Array of [AbortCriteria](./aws-properties-iot-jobtemplate-abortcriteria.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortconfig.html#cfn-iot-jobtemplate-abortconfig-criterialist", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "AbortCriteria", "DuplicatesAllowed": true } } }, "AWS::IoT::JobTemplate.AbortCriteria": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.AbortCriteria`\n\nThe criteria that determine when and how a job abort takes place.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe type of job action to take to initiate the job abort.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CANCEL`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "CANCEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-action", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FailureType": { "MarkdownDocumentation": "`FailureType`\n\nThe type of job execution failures that can initiate a job abort.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FAILED | REJECTED | TIMED_O...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FAILED", "REJECTED", "TIMED_OUT", "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-failuretype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ThresholdPercentage": { "MarkdownDocumentation": "`ThresholdPercentage`\n\nThe minimum percentage of job execution failures that must occur to initiate the\njob abort.\nAWS IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99,\nbut not 10.999).\n*Required*: Yes\n*Type*: Number\n*Maximum*: `100`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-thresholdpercentage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" }, "MinNumberOfExecutedThings": { "MarkdownDocumentation": "`MinNumberOfExecutedThings`\n\nThe minimum number of things which must receive job execution notifications before\nthe job can be aborted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-minnumberofexecutedthings", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::IoT::JobTemplate.ExponentialRolloutRate": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.ExponentialRolloutRate`\n\nAllows you to create an exponential rate of rollout for a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html", "Properties": { "RateIncreaseCriteria": { "MarkdownDocumentation": "`RateIncreaseCriteria`\n\nThe criteria to initiate the increase in rate of rollout for a job.\n*Required*: Yes\n*Type*: [RateIncreaseCriteria](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html#cfn-iot-jobtemplate-exponentialrolloutrate-rateincreasecriteria", "UpdateType": "Immutable", "Required": true, "Type": "RateIncreaseCriteria" }, "BaseRatePerMinute": { "MarkdownDocumentation": "`BaseRatePerMinute`\n\nThe minimum number of things that will be notified of a pending job, per minute at\nthe start of job rollout. This parameter allows you to define the initial rate of rollout.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html#cfn-iot-jobtemplate-exponentialrolloutrate-baserateperminute", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "IncrementFactor": { "MarkdownDocumentation": "`IncrementFactor`\n\nThe exponential factor to increase the rate of rollout for a job.\nAWS IoT Core supports up to one digit after the decimal (for example, 1.5, but\nnot 1.55).\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html#cfn-iot-jobtemplate-exponentialrolloutrate-incrementfactor", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::IoT::JobTemplate.JobExecutionsRetryConfig": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.JobExecutionsRetryConfig`\n\nThe configuration that determines how many retries are allowed for each failure type\nfor a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsretryconfig.html", "Properties": { "RetryCriteriaList": { "MarkdownDocumentation": "`RetryCriteriaList`\n\nThe list of criteria that determines how many retries are allowed for each failure\ntype for a job.\n*Required*: No\n*Type*: Array of [RetryCriteria](./aws-properties-iot-jobtemplate-retrycriteria.html)\n*Minimum*: `1`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsretryconfig.html#cfn-iot-jobtemplate-jobexecutionsretryconfig-retrycriterialist", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "RetryCriteria", "DuplicatesAllowed": true } } }, "AWS::IoT::JobTemplate.JobExecutionsRolloutConfig": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.JobExecutionsRolloutConfig`\n\nAllows you to create a staged rollout of a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html", "Properties": { "MaximumPerMinute": { "MarkdownDocumentation": "`MaximumPerMinute`\n\nThe maximum number of things that will be notified of a pending job, per minute.\nThis parameter allows you to create a staged rollout.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html#cfn-iot-jobtemplate-jobexecutionsrolloutconfig-maximumperminute", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ExponentialRolloutRate": { "MarkdownDocumentation": "`ExponentialRolloutRate`\n\nThe rate of increase for a job rollout. This parameter allows you to define an\nexponential rate for a job rollout.\n*Required*: No\n*Type*: [ExponentialRolloutRate](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html#cfn-iot-jobtemplate-jobexecutionsrolloutconfig-exponentialrolloutrate", "UpdateType": "Immutable", "Required": false, "Type": "ExponentialRolloutRate" } } }, "AWS::IoT::JobTemplate.MaintenanceWindow": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.MaintenanceWindow`\n\nAn optional configuration within the `SchedulingConfig` to setup a recurring\nmaintenance window with a predetermined start time and duration for the rollout of a job\ndocument to all devices in a target group for a job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-maintenancewindow.html", "Properties": { "DurationInMinutes": { "MarkdownDocumentation": "`DurationInMinutes`\n\nDisplays the duration of the next maintenance window.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `1430`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-maintenancewindow.html#cfn-iot-jobtemplate-maintenancewindow-durationinminutes", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nDisplays the start time of the next maintenance window.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-maintenancewindow.html#cfn-iot-jobtemplate-maintenancewindow-starttime", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::JobTemplate.PresignedUrlConfig": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.PresignedUrlConfig`\n\nConfiguration for pre-signed S3 URLs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html", "Properties": { "ExpiresInSec": { "MarkdownDocumentation": "`ExpiresInSec`\n\nHow long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the\ndefault value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT\nrequest for the job document.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `3600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html#cfn-iot-jobtemplate-presignedurlconfig-expiresinsec", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of an IAM role that grants grants permission to download files from the S3\nbucket where the job data/updates are stored. The role must also grant permission for IoT\nto download the files.\n###### Important\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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html#cfn-iot-jobtemplate-presignedurlconfig-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::JobTemplate.RateIncreaseCriteria": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.RateIncreaseCriteria`\n\nAllows you to define a criteria to initiate the increase in rate of rollout for a\njob.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html", "Properties": { "NumberOfSucceededThings": { "MarkdownDocumentation": "`NumberOfSucceededThings`\n\nThe threshold for number of succeeded things that will initiate the increase in\nrate of rollout.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html#cfn-iot-jobtemplate-rateincreasecriteria-numberofsucceededthings", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "NumberOfNotifiedThings": { "MarkdownDocumentation": "`NumberOfNotifiedThings`\n\nThe threshold for number of notified things that will initiate the increase in rate\nof rollout.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html#cfn-iot-jobtemplate-rateincreasecriteria-numberofnotifiedthings", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::IoT::JobTemplate.RetryCriteria": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.RetryCriteria`\n\nThe criteria that determines how many retries are allowed for each failure type for a\njob.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html", "Properties": { "FailureType": { "MarkdownDocumentation": "`FailureType`\n\nThe type of job execution failures that can initiate a job retry.\n*Required*: No\n*Type*: String\n*Allowed values*: `FAILED | TIMED_OUT | ALL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FAILED", "TIMED_OUT", "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html#cfn-iot-jobtemplate-retrycriteria-failuretype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NumberOfRetries": { "MarkdownDocumentation": "`NumberOfRetries`\n\nThe number of retries allowed for a failure type for the job.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html#cfn-iot-jobtemplate-retrycriteria-numberofretries", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::IoT::JobTemplate.TimeoutConfig": { "MarkdownDocumentation": "`AWS::IoT::JobTemplate.TimeoutConfig`\n\nSpecifies the amount of time each device has to finish its execution of the job. A\ntimer is started when the job execution status is set to `IN_PROGRESS`. If\nthe job execution status is not set to another terminal state before the timer expires,\nit will be automatically set to `TIMED_OUT`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-timeoutconfig.html", "Properties": { "InProgressTimeoutInMinutes": { "MarkdownDocumentation": "`InProgressTimeoutInMinutes`\n\nSpecifies the amount of time, in minutes, this device has to finish execution of this\njob. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes).\nThe in progress timer can't be updated and will apply to all job executions for the job.\nWhenever a job execution remains in the IN\\_PROGRESS status for longer than this interval,\nthe job execution will fail and switch to the terminal `TIMED_OUT`\nstatus.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `10080`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-timeoutconfig.html#cfn-iot-jobtemplate-timeoutconfig-inprogresstimeoutinminutes", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::IoT::MitigationAction.ActionParams": { "MarkdownDocumentation": "`AWS::IoT::MitigationAction.ActionParams`\n\nDefines the type of action and the parameters for that action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html", "Properties": { "UpdateDeviceCertificateParams": { "MarkdownDocumentation": "`UpdateDeviceCertificateParams`\n\nSpecifies the new state for a device certificate. Only a value of\n`DEACTIVATE` is currently supported.\n*Required*: No\n*Type*: [UpdateDeviceCertificateParams](./aws-properties-iot-mitigationaction-updatedevicecertificateparams.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-updatedevicecertificateparams", "UpdateType": "Mutable", "Required": false, "Type": "UpdateDeviceCertificateParams" }, "AddThingsToThingGroupParams": { "MarkdownDocumentation": "`AddThingsToThingGroupParams`\n\nSpecifies the group to which you want to add the devices.\n*Required*: No\n*Type*: [AddThingsToThingGroupParams](./aws-properties-iot-mitigationaction-addthingstothinggroupparams.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-addthingstothinggroupparams", "UpdateType": "Mutable", "Required": false, "Type": "AddThingsToThingGroupParams" }, "PublishFindingToSnsParams": { "MarkdownDocumentation": "`PublishFindingToSnsParams`\n\nSpecifies the topic to which the finding should be published.\n*Required*: No\n*Type*: [PublishFindingToSnsParams](./aws-properties-iot-mitigationaction-publishfindingtosnsparams.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-publishfindingtosnsparams", "UpdateType": "Mutable", "Required": false, "Type": "PublishFindingToSnsParams" }, "EnableIoTLoggingParams": { "MarkdownDocumentation": "`EnableIoTLoggingParams`\n\nSpecifies the logging level and the role with permissions for logging. You cannot\nspecify a logging level of `DISABLED`.\n*Required*: No\n*Type*: [EnableIoTLoggingParams](./aws-properties-iot-mitigationaction-enableiotloggingparams.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-enableiotloggingparams", "UpdateType": "Mutable", "Required": false, "Type": "EnableIoTLoggingParams" }, "ReplaceDefaultPolicyVersionParams": { "MarkdownDocumentation": "`ReplaceDefaultPolicyVersionParams`\n\nReplaces the policy version with a default or blank policy. You specify the template\nname. Only a value of `BLANK_POLICY` is currently supported.\n*Required*: No\n*Type*: [ReplaceDefaultPolicyVersionParams](./aws-properties-iot-mitigationaction-replacedefaultpolicyversionparams.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-replacedefaultpolicyversionparams", "UpdateType": "Mutable", "Required": false, "Type": "ReplaceDefaultPolicyVersionParams" }, "UpdateCACertificateParams": { "MarkdownDocumentation": "`UpdateCACertificateParams`\n\nSpecifies the new state for the CA certificate. Only a value of `DEACTIVATE`\nis currently supported.\n*Required*: No\n*Type*: [UpdateCACertificateParams](./aws-properties-iot-mitigationaction-updatecacertificateparams.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-actionparams.html#cfn-iot-mitigationaction-actionparams-updatecacertificateparams", "UpdateType": "Mutable", "Required": false, "Type": "UpdateCACertificateParams" } } }, "AWS::IoT::MitigationAction.AddThingsToThingGroupParams": { "MarkdownDocumentation": "`AWS::IoT::MitigationAction.AddThingsToThingGroupParams`\n\nParameters used when defining a mitigation action that move a set of things to a thing group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-addthingstothinggroupparams.html", "Properties": { "OverrideDynamicGroups": { "MarkdownDocumentation": "`OverrideDynamicGroups`\n\nSpecifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-addthingstothinggroupparams.html#cfn-iot-mitigationaction-addthingstothinggroupparams-overridedynamicgroups", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ThingGroupNames": { "MarkdownDocumentation": "`ThingGroupNames`\n\nThe list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can't add a thing to more than one group in the same hierarchy.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `128 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-addthingstothinggroupparams.html#cfn-iot-mitigationaction-addthingstothinggroupparams-thinggroupnames", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::IoT::MitigationAction.EnableIoTLoggingParams": { "MarkdownDocumentation": "`AWS::IoT::MitigationAction.EnableIoTLoggingParams`\n\nParameters used when defining a mitigation action that enable AWS IoT Core logging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-enableiotloggingparams.html", "Properties": { "RoleArnForLogging": { "MarkdownDocumentation": "`RoleArnForLogging`\n\nThe Amazon Resource Name (ARN) of the IAM role used for logging.\n*Required*: Yes\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-enableiotloggingparams.html#cfn-iot-mitigationaction-enableiotloggingparams-rolearnforlogging", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogLevel": { "MarkdownDocumentation": "`LogLevel`\n\nSpecifies the type of information to be logged.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEBUG | INFO | ERROR | WARN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEBUG", "INFO", "ERROR", "WARN", "UNSET_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-enableiotloggingparams.html#cfn-iot-mitigationaction-enableiotloggingparams-loglevel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::MitigationAction.PublishFindingToSnsParams": { "MarkdownDocumentation": "`AWS::IoT::MitigationAction.PublishFindingToSnsParams`\n\nParameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-publishfindingtosnsparams.html", "Properties": { "TopicArn": { "MarkdownDocumentation": "`TopicArn`\n\nThe ARN of the topic to which you want to publish the findings.\n*Required*: Yes\n*Type*: String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-publishfindingtosnsparams.html#cfn-iot-mitigationaction-publishfindingtosnsparams-topicarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::MitigationAction.ReplaceDefaultPolicyVersionParams": { "MarkdownDocumentation": "`AWS::IoT::MitigationAction.ReplaceDefaultPolicyVersionParams`\n\nParameters to define a mitigation action that adds a blank policy to restrict permissions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-replacedefaultpolicyversionparams.html", "Properties": { "TemplateName": { "MarkdownDocumentation": "`TemplateName`\n\nThe name of the template to be applied. The only supported value is `BLANK_POLICY`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BLANK_POLICY | UNSET_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLANK_POLICY", "UNSET_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-replacedefaultpolicyversionparams.html#cfn-iot-mitigationaction-replacedefaultpolicyversionparams-templatename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::MitigationAction.UpdateCACertificateParams": { "MarkdownDocumentation": "`AWS::IoT::MitigationAction.UpdateCACertificateParams`\n\nParameters to define a mitigation action that changes the state of the CA certificate to inactive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-updatecacertificateparams.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that you want to apply to the CA certificate. The only supported value is `DEACTIVATE`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEACTIVATE | UNSET_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEACTIVATE", "UNSET_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-updatecacertificateparams.html#cfn-iot-mitigationaction-updatecacertificateparams-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::MitigationAction.UpdateDeviceCertificateParams": { "MarkdownDocumentation": "`AWS::IoT::MitigationAction.UpdateDeviceCertificateParams`\n\nParameters to define a mitigation action that changes the state of the device certificate to inactive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-updatedevicecertificateparams.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that you want to apply to the device certificate. The only supported value is `DEACTIVATE`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEACTIVATE | UNSET_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEACTIVATE", "UNSET_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-mitigationaction-updatedevicecertificateparams.html#cfn-iot-mitigationaction-updatedevicecertificateparams-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::ProvisioningTemplate.ProvisioningHook": { "MarkdownDocumentation": "`AWS::IoT::ProvisioningTemplate.ProvisioningHook`\n\nStructure that contains payloadVersion and targetArn. Provisioning hooks can be used\nwhen fleet provisioning to validate device parameters before allowing the device to be\nprovisioned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-provisioningtemplate-provisioninghook.html", "Properties": { "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe ARN of the target 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-provisioningtemplate-provisioninghook.html#cfn-iot-provisioningtemplate-provisioninghook-targetarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PayloadVersion": { "MarkdownDocumentation": "`PayloadVersion`\n\nThe payload that was sent to the target function. The valid payload is\n`\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-provisioningtemplate-provisioninghook.html#cfn-iot-provisioningtemplate-provisioninghook-payloadversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::SecurityProfile.AlertTarget": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.AlertTarget`\n\nA structure containing the alert target ARN and the role ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-alerttarget.html", "Properties": { "AlertTargetArn": { "MarkdownDocumentation": "`AlertTargetArn`\n\nThe Amazon Resource Name (ARN) of the notification target to which alerts are sent.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-alerttarget.html#cfn-iot-securityprofile-alerttarget-alerttargetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants permission to send alerts to the\nnotification target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-alerttarget.html#cfn-iot-securityprofile-alerttarget-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::SecurityProfile.Behavior": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.Behavior`\n\nA Device Defender security profile behavior.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html", "Properties": { "ExportMetric": { "MarkdownDocumentation": "`ExportMetric`\n\nValue indicates exporting metrics related to the behavior when it 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-exportmetric", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SuppressAlerts": { "MarkdownDocumentation": "`SuppressAlerts`\n\nThe alert status. If you set the value to `true`, alerts will be\nsuppressed.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-suppressalerts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nWhat is measured by the behavior.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-metric", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Criteria": { "MarkdownDocumentation": "`Criteria`\n\nThe criteria that determine if a device is behaving normally in regard to the `metric`.\n###### Note\nIn the AWS IoT console, you can choose to be sent an alert through Amazon SNS when AWS IoT Device Defender detects that a device is behaving anomalously.\n*Required*: No\n*Type*: [BehaviorCriteria](./aws-properties-iot-securityprofile-behaviorcriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-criteria", "UpdateType": "Mutable", "Required": false, "Type": "BehaviorCriteria" }, "MetricDimension": { "MarkdownDocumentation": "`MetricDimension`\n\nThe dimension of the metric.\n*Required*: No\n*Type*: [MetricDimension](./aws-properties-iot-securityprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-metricdimension", "UpdateType": "Mutable", "Required": false, "Type": "MetricDimension" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name\nyou've given to the behavior.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::SecurityProfile.BehaviorCriteria": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.BehaviorCriteria`\n\nThe criteria by which the behavior is determined to be normal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe operator that relates the thing measured (`metric`) to the criteria\n(containing a `value` or `statisticalThreshold`). Valid operators include:\n* `string-list`: `in-set` and `not-in-set`\n* `number-list`: `in-set` and `not-in-set`\n* `ip-address-list`: `in-cidr-set` and `not-in-cidr-set`\n* `number`: `less-than`, `less-than-equals`, `greater-than`, and `greater-than-equals`\n*Required*: No\n*Type*: String\n*Allowed values*: `less-than | less-than-equal...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "less-than", "less-than-equals", "greater-than", "greater-than-equals", "in-cidr-set", "not-in-cidr-set", "in-port-set", "not-in-port-set", "in-set", "not-in-set" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-comparisonoperator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MlDetectionConfig": { "MarkdownDocumentation": "`MlDetectionConfig`\n\nThe confidence level of the detection model.\n*Required*: No\n*Type*: [MachineLearningDetectionConfig](./aws-properties-iot-securityprofile-machinelearningdetectionconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-mldetectionconfig", "UpdateType": "Mutable", "Required": false, "Type": "MachineLearningDetectionConfig" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to be compared with the `metric`.\n*Required*: No\n*Type*: [MetricValue](./aws-properties-iot-securityprofile-metricvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-value", "UpdateType": "Mutable", "Required": false, "Type": "MetricValue" }, "StatisticalThreshold": { "MarkdownDocumentation": "`StatisticalThreshold`\n\nA statistical ranking (percentile)that\nindicates a threshold value by which a behavior is determined to be in compliance or in\nviolation of the behavior.\n*Required*: No\n*Type*: [StatisticalThreshold](./aws-properties-iot-securityprofile-statisticalthreshold.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-statisticalthreshold", "UpdateType": "Mutable", "Required": false, "Type": "StatisticalThreshold" }, "DurationSeconds": { "MarkdownDocumentation": "`DurationSeconds`\n\nUse this to specify the time duration over which the behavior is evaluated, for those criteria that\nhave a time dimension (for example, `NUM_MESSAGES_SENT`). For a\n`statisticalThreshhold` metric comparison, measurements from all devices are\naccumulated over this time duration before being used to calculate percentiles, and later,\nmeasurements from an individual device are also accumulated over this time duration before\nbeing given a percentile rank. Cannot be used with list-based metric datatypes.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-durationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ConsecutiveDatapointsToAlarm": { "MarkdownDocumentation": "`ConsecutiveDatapointsToAlarm`\n\nIf a device is in violation of the behavior for the specified number of consecutive\ndatapoints, an alarm occurs. If not specified, the default is 1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-consecutivedatapointstoalarm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ConsecutiveDatapointsToClear": { "MarkdownDocumentation": "`ConsecutiveDatapointsToClear`\n\nIf an alarm has occurred and the offending device is no longer in violation of the behavior\nfor the specified number of consecutive datapoints, the alarm is cleared. If not specified,\nthe default is 1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-consecutivedatapointstoclear", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::IoT::SecurityProfile.MachineLearningDetectionConfig": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.MachineLearningDetectionConfig`\n\nThe `MachineLearningDetectionConfig` property type controls confidence of the\nmachine learning model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-machinelearningdetectionconfig.html", "Properties": { "ConfidenceLevel": { "MarkdownDocumentation": "`ConfidenceLevel`\n\nThe model confidence level.\nThere are three levels of confidence, `\"high\"`, `\"medium\"`, and\n`\"low\"`.\nThe higher the confidence level, the lower the sensitivity, and the lower the alarm\nfrequency will be.\n*Required*: No\n*Type*: String\n*Allowed values*: `LOW | MEDIUM | HIGH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOW", "MEDIUM", "HIGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-machinelearningdetectionconfig.html#cfn-iot-securityprofile-machinelearningdetectionconfig-confidencelevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::SecurityProfile.MetricDimension": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.MetricDimension`\n\nThe dimension of the metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricdimension.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nOperators are constructs that perform logical operations. Valid values are\n`IN` and `NOT_IN`.\n*Required*: No\n*Type*: String\n*Allowed values*: `IN | NOT_IN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IN", "NOT_IN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricdimension.html#cfn-iot-securityprofile-metricdimension-operator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DimensionName": { "MarkdownDocumentation": "`DimensionName`\n\nThe name of the dimension.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricdimension.html#cfn-iot-securityprofile-metricdimension-dimensionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::SecurityProfile.MetricToRetain": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.MetricToRetain`\n\nThe metric you want to retain. Dimensions are optional.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html", "Properties": { "ExportMetric": { "MarkdownDocumentation": "`ExportMetric`\n\nThe value indicates exporting metrics related to the `MetricToRetain` when\nit's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-exportmetric", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nA standard of measurement.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-metric", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricDimension": { "MarkdownDocumentation": "`MetricDimension`\n\nThe dimension of the metric.\n*Required*: No\n*Type*: [MetricDimension](./aws-properties-iot-securityprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-metricdimension", "UpdateType": "Mutable", "Required": false, "Type": "MetricDimension" } } }, "AWS::IoT::SecurityProfile.MetricValue": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.MetricValue`\n\nThe value to be compared with the `metric`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html", "Properties": { "Numbers": { "MarkdownDocumentation": "`Numbers`\n\nThe numeric value of a metric.\n*Required*: No\n*Type*: Array of Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-numbers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": false }, "Number": { "MarkdownDocumentation": "`Number`\n\nThe numeric values of a metric.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-number", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Ports": { "MarkdownDocumentation": "`Ports`\n\nIf the `comparisonOperator` calls for a set of ports, use this\nto specify that set to be compared with the `metric`.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-ports", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": false }, "Count": { "MarkdownDocumentation": "`Count`\n\nIf the `comparisonOperator` calls for a numeric value, use this\nto specify that numeric value to be compared with the `metric`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-count", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Strings": { "MarkdownDocumentation": "`Strings`\n\nThe string values of a metric.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-strings", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Cidrs": { "MarkdownDocumentation": "`Cidrs`\n\nIf the `comparisonOperator` calls for a set of CIDRs, use this\nto specify that set to be compared with the `metric`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-cidrs", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::IoT::SecurityProfile.MetricsExportConfig": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.MetricsExportConfig`\n\nSpecifies the MQTT topic and role ARN required for metric export.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricsexportconfig.html", "Properties": { "MqttTopic": { "MarkdownDocumentation": "`MqttTopic`\n\nThe MQTT topic that Device Defender Detect should publish messages to for metrics\nexport.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricsexportconfig.html#cfn-iot-securityprofile-metricsexportconfig-mqtttopic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThis role ARN has permission to publish MQTT messages, after which Device Defender Detect\ncan assume the role and publish messages on your behalf.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricsexportconfig.html#cfn-iot-securityprofile-metricsexportconfig-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::SecurityProfile.StatisticalThreshold": { "MarkdownDocumentation": "`AWS::IoT::SecurityProfile.StatisticalThreshold`\n\nA statistical ranking (percentile) that\nindicates a threshold value by which a behavior is determined to be in compliance or in\nviolation of the behavior.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-statisticalthreshold.html", "Properties": { "Statistic": { "MarkdownDocumentation": "`Statistic`\n\nThe percentile that\nresolves to a threshold value by which compliance with a behavior is determined. Metrics are\ncollected over the specified period (`durationSeconds`) from all reporting devices\nin your account and statistical ranks are calculated. Then, the measurements from a device are\ncollected over the same period. If the accumulated measurements from the device fall above or\nbelow (`comparisonOperator`) the value associated with the percentile specified,\nthen the device is considered to be in compliance with the behavior, otherwise a violation\noccurs.\n*Required*: No\n*Type*: String\n*Allowed values*: `Average | p0 | p0.1 | p0.01...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Average", "p0", "p0.1", "p0.01", "p1", "p10", "p50", "p90", "p99", "p99.9", "p99.99", "p100" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-statisticalthreshold.html#cfn-iot-securityprofile-statisticalthreshold-statistic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::SoftwarePackageVersion.PackageVersionArtifact": { "MarkdownDocumentation": "`AWS::IoT::SoftwarePackageVersion.PackageVersionArtifact`\n\nThe `PackageVersionArtifact` property type specifies Property description not available. for an [AWS::IoT::SoftwarePackageVersion](./aws-resource-iot-softwarepackageversion.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-packageversionartifact.html", "Properties": { "S3Location": { "MarkdownDocumentation": "`S3Location`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-iot-softwarepackageversion-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-packageversionartifact.html#cfn-iot-softwarepackageversion-packageversionartifact-s3location", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" } } }, "AWS::IoT::SoftwarePackageVersion.S3Location": { "MarkdownDocumentation": "`AWS::IoT::SoftwarePackageVersion.S3Location`\n\nThe `S3Location` property type specifies Property description not available. for an [AWS::IoT::SoftwarePackageVersion](./aws-resource-iot-softwarepackageversion.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-version", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::SoftwarePackageVersion.Sbom": { "MarkdownDocumentation": "`AWS::IoT::SoftwarePackageVersion.Sbom`\n\nThe `Sbom` property type specifies Property description not available. for an [AWS::IoT::SoftwarePackageVersion](./aws-resource-iot-softwarepackageversion.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-sbom.html", "Properties": { "S3Location": { "MarkdownDocumentation": "`S3Location`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-iot-softwarepackageversion-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-sbom.html#cfn-iot-softwarepackageversion-sbom-s3location", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" } } }, "AWS::IoT::Thing.AttributePayload": { "MarkdownDocumentation": "`AWS::IoT::Thing.AttributePayload`\n\nThe AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs. AttributePayload is a property of the [AWS::IoT::Thing](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thing-attributepayload.html", "Properties": { "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nA JSON string containing up to three key-value pair in JSON format. For example:\n`{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}`\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thing-attributepayload.html#cfn-iot-thing-attributepayload-attributes", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::IoT::ThingGroup.AttributePayload": { "MarkdownDocumentation": "`AWS::IoT::ThingGroup.AttributePayload`\n\nThe attribute payload.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-attributepayload.html", "Properties": { "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nA JSON string containing up to three key-value pair in JSON format. For example:\n`{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}`\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-attributepayload.html#cfn-iot-thinggroup-attributepayload-attributes", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::IoT::ThingGroup.ThingGroupProperties": { "MarkdownDocumentation": "`AWS::IoT::ThingGroup.ThingGroupProperties`\n\nThing group properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-thinggroupproperties.html", "Properties": { "AttributePayload": { "MarkdownDocumentation": "`AttributePayload`\n\nThe thing group attributes in JSON format.\n*Required*: No\n*Type*: [AttributePayload](./aws-properties-iot-thinggroup-attributepayload.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-thinggroupproperties.html#cfn-iot-thinggroup-thinggroupproperties-attributepayload", "UpdateType": "Mutable", "Required": false, "Type": "AttributePayload" }, "ThingGroupDescription": { "MarkdownDocumentation": "`ThingGroupDescription`\n\nThe thing group description.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{Graph}\\x20]*`\n*Maximum*: `2028`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-thinggroupproperties.html#cfn-iot-thinggroup-thinggroupproperties-thinggroupdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::ThingType.Mqtt5Configuration": { "MarkdownDocumentation": "`AWS::IoT::ThingType.Mqtt5Configuration`\n\nThe configuration to add user-defined properties to enrich MQTT 5 messages.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-mqtt5configuration.html", "Properties": { "PropagatingAttributes": { "MarkdownDocumentation": "`PropagatingAttributes`\n\nAn object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.\n*Required*: No\n*Type*: Array of [PropagatingAttribute](./aws-properties-iot-thingtype-propagatingattribute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-mqtt5configuration.html#cfn-iot-thingtype-mqtt5configuration-propagatingattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PropagatingAttribute", "DuplicatesAllowed": false } } }, "AWS::IoT::ThingType.PropagatingAttribute": { "MarkdownDocumentation": "`AWS::IoT::ThingType.PropagatingAttribute`\n\nAn object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-propagatingattribute.html", "Properties": { "UserPropertyKey": { "MarkdownDocumentation": "`UserPropertyKey`\n\nThe key of the MQTT 5 user property, which is a key-value pair.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:$.]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-propagatingattribute.html#cfn-iot-thingtype-propagatingattribute-userpropertykey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ThingAttribute": { "MarkdownDocumentation": "`ThingAttribute`\n\nThe thing attribute that is propagating for MQTT 5 message enrichment.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.,@/:#-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-propagatingattribute.html#cfn-iot-thingtype-propagatingattribute-thingattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionAttribute": { "MarkdownDocumentation": "`ConnectionAttribute`\n\nThe attribute associated with the connection details.\n*Required*: No\n*Type*: String\n*Allowed values*: `iot:ClientId | iot:Thing.Th...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "iot:ClientId", "iot:Thing.ThingName" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-propagatingattribute.html#cfn-iot-thingtype-propagatingattribute-connectionattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::ThingType.ThingTypeProperties": { "MarkdownDocumentation": "`AWS::IoT::ThingType.ThingTypeProperties`\n\nThe ThingTypeProperties contains information about the thing type including: a thing type description,\nand a list of searchable thing attribute names.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-thingtypeproperties.html", "Properties": { "ThingTypeDescription": { "MarkdownDocumentation": "`ThingTypeDescription`\n\nThe description of the thing type.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{Graph}\\x20]*`\n*Maximum*: `2028`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-thingtypeproperties.html#cfn-iot-thingtype-thingtypeproperties-thingtypedescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Mqtt5Configuration": { "MarkdownDocumentation": "`Mqtt5Configuration`\n\nThe configuration to add user-defined properties to enrich MQTT 5 messages.\n*Required*: No\n*Type*: [Mqtt5Configuration](./aws-properties-iot-thingtype-mqtt5configuration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-thingtypeproperties.html#cfn-iot-thingtype-thingtypeproperties-mqtt5configuration", "UpdateType": "Mutable", "Required": false, "Type": "Mqtt5Configuration" }, "SearchableAttributes": { "MarkdownDocumentation": "`SearchableAttributes`\n\nA list of searchable thing attribute names.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `128 | 3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-thingtypeproperties.html#cfn-iot-thingtype-thingtypeproperties-searchableattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::IoT::TopicRule.Action": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.Action`\n\nDescribes the actions associated with a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nWrite to an Amazon S3 bucket.\n*Required*: No\n*Type*: [S3Action](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3Action" }, "CloudwatchAlarm": { "MarkdownDocumentation": "`CloudwatchAlarm`\n\nChange the state of a CloudWatch alarm.\n*Required*: No\n*Type*: [CloudwatchAlarmAction](./aws-properties-iot-topicrule-cloudwatchalarmaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchalarm", "UpdateType": "Mutable", "Required": false, "Type": "CloudwatchAlarmAction" }, "IotEvents": { "MarkdownDocumentation": "`IotEvents`\n\nSends an input to an AWS IoT Events detector.\n*Required*: No\n*Type*: [IotEventsAction](./aws-properties-iot-topicrule-ioteventsaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-iotevents", "UpdateType": "Mutable", "Required": false, "Type": "IotEventsAction" }, "Firehose": { "MarkdownDocumentation": "`Firehose`\n\nWrite to an Amazon Kinesis Firehose stream.\n*Required*: No\n*Type*: [FirehoseAction](./aws-properties-iot-topicrule-firehoseaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-firehose", "UpdateType": "Mutable", "Required": false, "Type": "FirehoseAction" }, "Republish": { "MarkdownDocumentation": "`Republish`\n\nPublish to another MQTT topic.\n*Required*: No\n*Type*: [RepublishAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-republish", "UpdateType": "Mutable", "Required": false, "Type": "RepublishAction" }, "Kafka": { "MarkdownDocumentation": "`Kafka`\n\nSend messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.\n*Required*: No\n*Type*: [KafkaAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-kafka", "UpdateType": "Mutable", "Required": false, "Type": "KafkaAction" }, "StepFunctions": { "MarkdownDocumentation": "`StepFunctions`\n\nStarts execution of a Step Functions state machine.\n*Required*: No\n*Type*: [StepFunctionsAction](./aws-properties-iot-topicrule-stepfunctionsaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-stepfunctions", "UpdateType": "Mutable", "Required": false, "Type": "StepFunctionsAction" }, "DynamoDB": { "MarkdownDocumentation": "`DynamoDB`\n\nWrite to a DynamoDB table.\n*Required*: No\n*Type*: [DynamoDBAction](./aws-properties-iot-topicrule-dynamodbaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodb", "UpdateType": "Mutable", "Required": false, "Type": "DynamoDBAction" }, "Http": { "MarkdownDocumentation": "`Http`\n\nSend data to an HTTPS endpoint.\n*Required*: No\n*Type*: [HttpAction](./aws-properties-iot-topicrule-httpaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-http", "UpdateType": "Mutable", "Required": false, "Type": "HttpAction" }, "OpenSearch": { "MarkdownDocumentation": "`OpenSearch`\n\nWrite data to an Amazon OpenSearch Service domain.\n*Required*: No\n*Type*: [OpenSearchAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-opensearch", "UpdateType": "Mutable", "Required": false, "Type": "OpenSearchAction" }, "DynamoDBv2": { "MarkdownDocumentation": "`DynamoDBv2`\n\nWrite to a DynamoDB table. This is a new version of the DynamoDB action. It allows\nyou to write each attribute in an MQTT message payload into a separate DynamoDB\ncolumn.\n*Required*: No\n*Type*: [DynamoDBv2Action](./aws-properties-iot-topicrule-dynamodbv2action.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodbv2", "UpdateType": "Mutable", "Required": false, "Type": "DynamoDBv2Action" }, "CloudwatchMetric": { "MarkdownDocumentation": "`CloudwatchMetric`\n\nCapture a CloudWatch metric.\n*Required*: No\n*Type*: [CloudwatchMetricAction](./aws-properties-iot-topicrule-cloudwatchmetricaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchmetric", "UpdateType": "Mutable", "Required": false, "Type": "CloudwatchMetricAction" }, "IotSiteWise": { "MarkdownDocumentation": "`IotSiteWise`\n\nSends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset\nproperties.\n*Required*: No\n*Type*: [IotSiteWiseAction](./aws-properties-iot-topicrule-iotsitewiseaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-iotsitewise", "UpdateType": "Mutable", "Required": false, "Type": "IotSiteWiseAction" }, "Elasticsearch": { "MarkdownDocumentation": "`Elasticsearch`\n\nWrite data to an Amazon OpenSearch Service domain.\n###### Note\nThe `Elasticsearch` action can only be used by existing rule actions.\nTo create a new rule action or to update an existing rule action, use the\n`OpenSearch` rule action instead. For more information, see\n[OpenSearchAction](https://docs.aws.amazon.com//iot/latest/apireference/API_OpenSearchAction.html).\n*Required*: No\n*Type*: [ElasticsearchAction](./aws-properties-iot-topicrule-elasticsearchaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-elasticsearch", "UpdateType": "Mutable", "Required": false, "Type": "ElasticsearchAction" }, "Sqs": { "MarkdownDocumentation": "`Sqs`\n\nPublish to an Amazon SQS queue.\n*Required*: No\n*Type*: [SqsAction](./aws-properties-iot-topicrule-sqsaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sqs", "UpdateType": "Mutable", "Required": false, "Type": "SqsAction" }, "Kinesis": { "MarkdownDocumentation": "`Kinesis`\n\nWrite data to an Amazon Kinesis stream.\n*Required*: No\n*Type*: [KinesisAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-kinesis", "UpdateType": "Mutable", "Required": false, "Type": "KinesisAction" }, "CloudwatchLogs": { "MarkdownDocumentation": "`CloudwatchLogs`\n\nSends data to CloudWatch.\n*Required*: No\n*Type*: [CloudwatchLogsAction](./aws-properties-iot-topicrule-cloudwatchlogsaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchlogs", "UpdateType": "Mutable", "Required": false, "Type": "CloudwatchLogsAction" }, "Timestream": { "MarkdownDocumentation": "`Timestream`\n\nWrites attributes from an MQTT message.\n*Required*: No\n*Type*: [TimestreamAction](./aws-properties-iot-topicrule-timestreamaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-timestream", "UpdateType": "Mutable", "Required": false, "Type": "TimestreamAction" }, "IotAnalytics": { "MarkdownDocumentation": "`IotAnalytics`\n\nSends message data to an AWS IoT Analytics channel.\n*Required*: No\n*Type*: [IotAnalyticsAction](./aws-properties-iot-topicrule-iotanalyticsaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-iotanalytics", "UpdateType": "Mutable", "Required": false, "Type": "IotAnalyticsAction" }, "Sns": { "MarkdownDocumentation": "`Sns`\n\nPublish to an Amazon SNS topic.\n*Required*: No\n*Type*: [SnsAction](./aws-properties-iot-topicrule-snsaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sns", "UpdateType": "Mutable", "Required": false, "Type": "SnsAction" }, "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nInvoke a Lambda function.\n*Required*: No\n*Type*: [LambdaAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-lambda", "UpdateType": "Mutable", "Required": false, "Type": "LambdaAction" }, "Location": { "MarkdownDocumentation": "`Location`\n\nSends device location data to [Amazon Location\nService](https://docs.aws.amazon.com//location/latest/developerguide/welcome.html).\n*Required*: No\n*Type*: [LocationAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-location", "UpdateType": "Mutable", "Required": false, "Type": "LocationAction" } } }, "AWS::IoT::TopicRule.AssetPropertyTimestamp": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.AssetPropertyTimestamp`\n\nAn asset property timestamp entry containing the following information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertytimestamp.html", "Properties": { "TimeInSeconds": { "MarkdownDocumentation": "`TimeInSeconds`\n\nA string that contains the time in seconds since epoch. Accepts substitution\ntemplates.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertytimestamp.html#cfn-iot-topicrule-assetpropertytimestamp-timeinseconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OffsetInNanos": { "MarkdownDocumentation": "`OffsetInNanos`\n\nOptional. A string that contains the nanosecond time offset. Accepts substitution\ntemplates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertytimestamp.html#cfn-iot-topicrule-assetpropertytimestamp-offsetinnanos", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.AssetPropertyValue": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.AssetPropertyValue`\n\nAn asset property value entry containing the following information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvalue.html", "Properties": { "Quality": { "MarkdownDocumentation": "`Quality`\n\nOptional. A string that describes the quality of the value. Accepts substitution\ntemplates. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvalue.html#cfn-iot-topicrule-assetpropertyvalue-quality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the asset property.\n*Required*: Yes\n*Type*: [AssetPropertyVariant](./aws-properties-iot-topicrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvalue.html#cfn-iot-topicrule-assetpropertyvalue-value", "UpdateType": "Mutable", "Required": true, "Type": "AssetPropertyVariant" }, "Timestamp": { "MarkdownDocumentation": "`Timestamp`\n\nThe asset property value timestamp.\n*Required*: Yes\n*Type*: [AssetPropertyTimestamp](./aws-properties-iot-topicrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvalue.html#cfn-iot-topicrule-assetpropertyvalue-timestamp", "UpdateType": "Mutable", "Required": true, "Type": "AssetPropertyTimestamp" } } }, "AWS::IoT::TopicRule.AssetPropertyVariant": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.AssetPropertyVariant`\n\nContains an asset property value (of a single type).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvariant.html", "Properties": { "DoubleValue": { "MarkdownDocumentation": "`DoubleValue`\n\nOptional. A string that contains the double value of the value entry. Accepts substitution\ntemplates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvariant.html#cfn-iot-topicrule-assetpropertyvariant-doublevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BooleanValue": { "MarkdownDocumentation": "`BooleanValue`\n\nOptional. A string that contains the boolean value (`true` or\n`false`) of the value entry. Accepts substitution 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvariant.html#cfn-iot-topicrule-assetpropertyvariant-booleanvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegerValue": { "MarkdownDocumentation": "`IntegerValue`\n\nOptional. A string that contains the integer value of the value entry. Accepts\nsubstitution 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvariant.html#cfn-iot-topicrule-assetpropertyvariant-integervalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StringValue": { "MarkdownDocumentation": "`StringValue`\n\nOptional. The string value of the value entry. Accepts substitution templates.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvariant.html#cfn-iot-topicrule-assetpropertyvariant-stringvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.BatchConfig": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.BatchConfig`\n\nThe `BatchConfig` property type specifies Property description not available. for an [AWS::IoT::TopicRule](./aws-resource-iot-topicrule.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-batchconfig.html", "Properties": { "MaxBatchOpenMs": { "MarkdownDocumentation": "`MaxBatchOpenMs`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-batchconfig.html#cfn-iot-topicrule-batchconfig-maxbatchopenms", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxBatchSize": { "MarkdownDocumentation": "`MaxBatchSize`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-batchconfig.html#cfn-iot-topicrule-batchconfig-maxbatchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxBatchSizeBytes": { "MarkdownDocumentation": "`MaxBatchSizeBytes`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-batchconfig.html#cfn-iot-topicrule-batchconfig-maxbatchsizebytes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::IoT::TopicRule.CloudwatchAlarmAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.CloudwatchAlarmAction`\n\nDescribes an action that updates a CloudWatch alarm.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html", "Properties": { "AlarmName": { "MarkdownDocumentation": "`AlarmName`\n\nThe CloudWatch alarm 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-alarmname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StateReason": { "MarkdownDocumentation": "`StateReason`\n\nThe reason for the alarm change.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statereason", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StateValue": { "MarkdownDocumentation": "`StateValue`\n\nThe value of the alarm state. Acceptable values are: OK, ALARM,\nINSUFFICIENT\\_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statevalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role that allows access to the CloudWatch alarm.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.CloudwatchLogsAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.CloudwatchLogsAction`\n\nDescribes an action that updates a CloudWatch log.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchlogsaction.html", "Properties": { "BatchMode": { "MarkdownDocumentation": "`BatchMode`\n\nIndicates whether batches of log records will be extracted and uploaded into\nCloudWatch.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchlogsaction.html#cfn-iot-topicrule-cloudwatchlogsaction-batchmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchlogsaction.html#cfn-iot-topicrule-cloudwatchlogsaction-loggroupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchlogsaction.html#cfn-iot-topicrule-cloudwatchlogsaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.CloudwatchMetricAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.CloudwatchMetricAction`\n\nDescribes an action that captures a CloudWatch metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe CloudWatch metric 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricValue": { "MarkdownDocumentation": "`MetricValue`\n\nThe CloudWatch metric 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricNamespace": { "MarkdownDocumentation": "`MetricNamespace`\n\nThe CloudWatch metric namespace 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricnamespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricUnit": { "MarkdownDocumentation": "`MetricUnit`\n\nThe [metric\nunit](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) supported by CloudWatch.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricunit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role that allows access to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricTimestamp": { "MarkdownDocumentation": "`MetricTimestamp`\n\nAn optional [Unix timestamp](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metrictimestamp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.DynamoDBAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.DynamoDBAction`\n\nDescribes an action to write to a DynamoDB table.\nThe `tableName`, `hashKeyField`, and `rangeKeyField`\nvalues must match the values used when you created the table.\nThe `hashKeyValue` and `rangeKeyvalue` fields use a\nsubstitution template syntax. These templates provide data at runtime. The syntax is as\nfollows: ${*sql-expression*}.\nYou can specify any valid expression in a WHERE or SELECT clause, including JSON\nproperties, comparisons, calculations, and functions. For example, the following field uses\nthe third level of the topic:\n`\"hashKeyValue\": \"${topic(3)}\"`\nThe following field uses the timestamp:\n`\"rangeKeyValue\": \"${timestamp()}\"`\nFor more information, see [DynamoDBv2 Action](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rule-actions.html) in the *AWS IoT Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PayloadField": { "MarkdownDocumentation": "`PayloadField`\n\nThe action payload. This name can be customized.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-payloadfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeKeyField": { "MarkdownDocumentation": "`RangeKeyField`\n\nThe range key 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyField": { "MarkdownDocumentation": "`HashKeyField`\n\nThe hash 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyfield", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeKeyValue": { "MarkdownDocumentation": "`RangeKeyValue`\n\nThe range key 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeKeyType": { "MarkdownDocumentation": "`RangeKeyType`\n\nThe range key type. Valid values are \"STRING\" or \"NUMBER\"\n*Required*: No\n*Type*: String\n*Allowed values*: `STRING | NUMBER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "NUMBER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyType": { "MarkdownDocumentation": "`HashKeyType`\n\nThe hash key type. Valid values are \"STRING\" or \"NUMBER\"\n*Required*: No\n*Type*: String\n*Allowed values*: `STRING | NUMBER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "NUMBER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyValue": { "MarkdownDocumentation": "`HashKeyValue`\n\nThe hash 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that grants access to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.DynamoDBv2Action": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.DynamoDBv2Action`\n\nDescribes an action to write to a DynamoDB table.\nThis DynamoDB action writes each attribute in the message payload into it's own\ncolumn in the DynamoDB table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html", "Properties": { "PutItem": { "MarkdownDocumentation": "`PutItem`\n\nSpecifies the DynamoDB table to which the message data will be written. For\nexample:\n`{ \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\":\n\"my-table\" } } }`\nEach attribute in the message payload will be written to a separate column in the\nDynamoDB database.\n*Required*: No\n*Type*: [PutItemInput](./aws-properties-iot-topicrule-putiteminput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-putitem", "UpdateType": "Mutable", "Required": false, "Type": "PutItemInput" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that grants access to the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.ElasticsearchAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.ElasticsearchAction`\n\nDescribes an action that writes data to an Amazon OpenSearch Service\ndomain.\n###### Note\nThe `Elasticsearch` action can only be used by existing rule actions. To create a\nnew rule action or to update an existing rule action, use the\n`OpenSearch` rule action instead. For more information, see [OpenSearchAction](https://docs.aws.amazon.com//iot/latest/apireference/API_OpenSearchAction.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint of your OpenSearch domain.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-endpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Index": { "MarkdownDocumentation": "`Index`\n\nThe index where you want to store your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-index", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role ARN that has access to OpenSearch.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.FirehoseAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.FirehoseAction`\n\nDescribes an action that writes data to an Amazon Kinesis Firehose stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html", "Properties": { "DeliveryStreamName": { "MarkdownDocumentation": "`DeliveryStreamName`\n\nThe delivery stream 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-deliverystreamname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BatchMode": { "MarkdownDocumentation": "`BatchMode`\n\nWhether to deliver the Kinesis Data Firehose stream as a batch by using [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html). The default value is `false`.\nWhen `batchMode` is `true` and the rule's SQL statement\nevaluates to an Array, each Array element forms one record in the [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) request. The resulting array can't have more than 500 records.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-batchmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role that grants access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Separator": { "MarkdownDocumentation": "`Separator`\n\nA character separator that will be used to separate records written to the Firehose\nstream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ','\n(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-separator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.HttpAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.HttpAction`\n\nSend data to an HTTPS endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html", "Properties": { "EnableBatching": { "MarkdownDocumentation": "`EnableBatching`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-enablebatching", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BatchConfig": { "MarkdownDocumentation": "`BatchConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [BatchConfig](./aws-properties-iot-topicrule-batchconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-batchconfig", "UpdateType": "Mutable", "Required": false, "Type": "BatchConfig" }, "Headers": { "MarkdownDocumentation": "`Headers`\n\nThe HTTP headers to send with the message data.\n*Required*: No\n*Type*: Array of [HttpActionHeader](./aws-properties-iot-topicrule-httpactionheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-headers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HttpActionHeader", "DuplicatesAllowed": false }, "Auth": { "MarkdownDocumentation": "`Auth`\n\nThe authentication method to use when sending data to an HTTPS endpoint.\n*Required*: No\n*Type*: [HttpAuthorization](./aws-properties-iot-topicrule-httpauthorization.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-auth", "UpdateType": "Mutable", "Required": false, "Type": "HttpAuthorization" }, "ConfirmationUrl": { "MarkdownDocumentation": "`ConfirmationUrl`\n\nThe URL to which AWS IoT sends a confirmation message. The value of the confirmation URL\nmust be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses\nthe endpoint URL as the confirmation URL. If you use substitution templates in the\nconfirmationUrl, you must create and enable topic rule destinations that match each\npossible value of the substitution template before traffic is allowed to your endpoint\nURL.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-confirmationurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe endpoint URL. If substitution templates are used in the URL, you must also specify a\n`confirmationUrl`. If this is a new destination, a new\n`TopicRuleDestination` is created if possible.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.HttpActionHeader": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.HttpActionHeader`\n\nThe HTTP action header.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpactionheader.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe HTTP header value. Substitution templates are 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpactionheader.html#cfn-iot-topicrule-httpactionheader-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe HTTP header 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpactionheader.html#cfn-iot-topicrule-httpactionheader-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.HttpAuthorization": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.HttpAuthorization`\n\nThe authorization method used to send messages.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpauthorization.html", "Properties": { "Sigv4": { "MarkdownDocumentation": "`Sigv4`\n\nUse Sig V4 authorization. For more information, see [Signature Version 4 Signing\nProcess](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\n*Required*: No\n*Type*: [SigV4Authorization](./aws-properties-iot-topicrule-sigv4authorization.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpauthorization.html#cfn-iot-topicrule-httpauthorization-sigv4", "UpdateType": "Mutable", "Required": false, "Type": "SigV4Authorization" } } }, "AWS::IoT::TopicRule.IotAnalyticsAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.IotAnalyticsAction`\n\nSends message data to an AWS IoT Analytics channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html", "Properties": { "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe name of the IoT Analytics channel to which message data will be sent.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-channelname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BatchMode": { "MarkdownDocumentation": "`BatchMode`\n\nWhether to process the action as a batch. The default value is\n`false`.\nWhen `batchMode` is `true` and the rule SQL statement evaluates\nto an Array, each Array element is delivered as a separate message when passed by [`BatchPutMessage`](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html) The resulting array can't have more than 100 messages.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-batchmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role which has a policy that grants IoT Analytics permission to send\nmessage data via IoT Analytics (iotanalytics:BatchPutMessage).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.IotEventsAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.IotEventsAction`\n\nSends an input to an AWS IoT Events detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html", "Properties": { "InputName": { "MarkdownDocumentation": "`InputName`\n\nThe name of the AWS IoT Events input.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html#cfn-iot-topicrule-ioteventsaction-inputname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BatchMode": { "MarkdownDocumentation": "`BatchMode`\n\nWhether to process the event actions as a batch. The default value is\n`false`.\nWhen `batchMode` is `true`, you can't specify a\n`messageId`.\nWhen `batchMode` is `true` and the rule SQL statement evaluates\nto an Array, each Array element is treated as a separate message when Events by calling\n[`BatchPutMessage`](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html). The resulting array can't have more than 10 messages.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html#cfn-iot-topicrule-ioteventsaction-batchmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants AWS IoT permission to send an input to an AWS IoT\nEvents detector. (\"Action\":\"iotevents:BatchPutMessage\").\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html#cfn-iot-topicrule-ioteventsaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MessageId": { "MarkdownDocumentation": "`MessageId`\n\nThe ID of the message. The default `messageId` is a new UUID value.\nWhen `batchMode` is `true`, you can't specify a\n`messageId`--a new UUID value will be assigned.\nAssign a value to this property to ensure that only one input (message) with a given\n`messageId` will be processed by an AWS IoT Events detector.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html#cfn-iot-topicrule-ioteventsaction-messageid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.IotSiteWiseAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.IotSiteWiseAction`\n\nDescribes an action to send data from an MQTT message that triggered the rule to AWS IoT\nSiteWise asset properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html", "Properties": { "PutAssetPropertyValueEntries": { "MarkdownDocumentation": "`PutAssetPropertyValueEntries`\n\nA list of asset property value entries.\n*Required*: Yes\n*Type*: Array of [PutAssetPropertyValueEntry](./aws-properties-iot-topicrule-putassetpropertyvalueentry.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html#cfn-iot-topicrule-iotsitewiseaction-putassetpropertyvalueentries", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PutAssetPropertyValueEntry", "DuplicatesAllowed": false }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. (`\"Action\": \"iotsitewise:BatchPutAssetPropertyValue\"`). The trust\npolicy can restrict access to specific asset hierarchy paths.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html#cfn-iot-topicrule-iotsitewiseaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.KafkaAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.KafkaAction`\n\nSend messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html", "Properties": { "Partition": { "MarkdownDocumentation": "`Partition`\n\nThe Kafka message partition.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-partition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientProperties": { "MarkdownDocumentation": "`ClientProperties`\n\nProperties of the Apache Kafka producer client.\n*Required*: Yes\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-clientproperties", "UpdateType": "Mutable", "Required": true, "Type": "Map", "PrimitiveItemType": "String" }, "Headers": { "MarkdownDocumentation": "`Headers`\n\nThe list of Kafka headers that you specify.\n*Required*: No\n*Type*: Array of [KafkaActionHeader](./aws-properties-iot-topicrule-kafkaactionheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-headers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KafkaActionHeader", "DuplicatesAllowed": false }, "Topic": { "MarkdownDocumentation": "`Topic`\n\nThe Kafka topic for messages to be sent to the Kafka broker.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-topic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nThe ARN of Kafka action's VPC `TopicRuleDestination`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-destinationarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe Kafka message 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.KafkaActionHeader": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.KafkaActionHeader`\n\nSpecifies a Kafka header using key-value pairs when you create a Rule\u2019s Kafka Action.\nYou can use these headers to route data from IoT clients to downstream Kafka clusters\nwithout modifying your message payload.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaactionheader.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the Kafka header.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaactionheader.html#cfn-iot-topicrule-kafkaactionheader-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the Kafka header.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaactionheader.html#cfn-iot-topicrule-kafkaactionheader-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.KinesisAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.KinesisAction`\n\nDescribes an action to write data to an Amazon Kinesis stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html", "Properties": { "StreamName": { "MarkdownDocumentation": "`StreamName`\n\nThe name of the Amazon Kinesis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-streamname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PartitionKey": { "MarkdownDocumentation": "`PartitionKey`\n\nThe partition 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-partitionkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that grants access to the Amazon Kinesis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.LambdaAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.LambdaAction`\n\nDescribes an action to invoke a Lambda function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html", "Properties": { "FunctionArn": { "MarkdownDocumentation": "`FunctionArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html#cfn-iot-topicrule-lambdaaction-functionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.LocationAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.LocationAction`\n\nDescribes an action to send device location updates from an MQTT message to an Amazon\nLocation tracker resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html", "Properties": { "TrackerName": { "MarkdownDocumentation": "`TrackerName`\n\nThe name of the tracker resource in Amazon Location in which the location is\nupdated.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-trackername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DeviceId": { "MarkdownDocumentation": "`DeviceId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-deviceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Latitude": { "MarkdownDocumentation": "`Latitude`\n\nA string that evaluates to a double value that represents the latitude of the device's\nlocation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-latitude", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Longitude": { "MarkdownDocumentation": "`Longitude`\n\nA string that evaluates to a double value that represents the longitude of the device's\nlocation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-longitude", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Timestamp": { "MarkdownDocumentation": "`Timestamp`\n\nThe time that the location data was sampled. The default value is the time the MQTT\nmessage was processed.\n*Required*: No\n*Type*: [Timestamp](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-timestamp", "UpdateType": "Mutable", "Required": false, "Type": "Timestamp" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.OpenSearchAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.OpenSearchAction`\n\nDescribes an action that writes data to an Amazon OpenSearch Service domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint of your OpenSearch domain.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-endpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Index": { "MarkdownDocumentation": "`Index`\n\nThe OpenSearch index where you want to store your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-index", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role ARN that has access to OpenSearch.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.PutAssetPropertyValueEntry": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.PutAssetPropertyValueEntry`\n\nAn asset property value entry containing the following information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html", "Properties": { "PropertyValues": { "MarkdownDocumentation": "`PropertyValues`\n\nA list of property values to insert that each contain timestamp, quality, and value (TQV)\ninformation.\n*Required*: Yes\n*Type*: Array of [AssetPropertyValue](./aws-properties-iot-topicrule-assetpropertyvalue.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-propertyvalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AssetPropertyValue", "DuplicatesAllowed": false }, "EntryId": { "MarkdownDocumentation": "`EntryId`\n\nOptional. A unique identifier for this entry that you can define to better track which\nmessage caused an error in case of failure. Accepts substitution templates. Defaults to a new\nUUID.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-entryid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyAlias": { "MarkdownDocumentation": "`PropertyAlias`\n\nThe name of the property alias associated with your asset property. You must specify\neither a `propertyAlias` or both an `aliasId` and a\n`propertyId`. Accepts substitution templates.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-propertyalias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssetId": { "MarkdownDocumentation": "`AssetId`\n\nThe ID of the AWS IoT SiteWise asset. You must specify either a `propertyAlias`\nor both an `aliasId` and a `propertyId`. Accepts substitution\ntemplates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-assetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyId": { "MarkdownDocumentation": "`PropertyId`\n\nThe ID of the asset's property. You must specify either a `propertyAlias` or\nboth an `aliasId` and a `propertyId`. Accepts substitution\ntemplates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-propertyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.PutItemInput": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.PutItemInput`\n\nThe input for the DynamoActionVS action that specifies the DynamoDB table to which\nthe message data will be written.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putiteminput.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putiteminput.html#cfn-iot-topicrule-putiteminput-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.RepublishAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.RepublishAction`\n\nDescribes an action to republish to another topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html", "Properties": { "Qos": { "MarkdownDocumentation": "`Qos`\n\nThe Quality of Service (QoS) level to use when republishing messages. The default value\nis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-qos", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Headers": { "MarkdownDocumentation": "`Headers`\n\nMQTT Version 5.0 headers information. For more information, see [MQTT](https://docs.aws.amazon.com//iot/latest/developerguide/mqtt.html) in the IoT\nCore Developer Guide.\n*Required*: No\n*Type*: [RepublishActionHeaders](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-headers", "UpdateType": "Mutable", "Required": false, "Type": "RepublishActionHeaders" }, "Topic": { "MarkdownDocumentation": "`Topic`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-topic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.RepublishActionHeaders": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.RepublishActionHeaders`\n\nSpecifies MQTT Version 5.0 headers information. For more information, see [MQTT](https://docs.aws.amazon.com//iot/latest/developerguide/mqtt.html) in the IoT\nCore Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html", "Properties": { "CorrelationData": { "MarkdownDocumentation": "`CorrelationData`\n\nThe base64-encoded binary data used by the sender of the request message to identify\nwhich 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\ntemplates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html).\n###### Note\nThis binary data must be base64-encoded.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-correlationdata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserProperties": { "MarkdownDocumentation": "`UserProperties`\n\nAn array of key-value pairs that you define in the MQTT5 header.\n*Required*: No\n*Type*: Array of [UserProperty](./aws-properties-iot-topicrule-userproperty.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-userproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UserProperty", "DuplicatesAllowed": true }, "PayloadFormatIndicator": { "MarkdownDocumentation": "`PayloadFormatIndicator`\n\nAn `Enum` string value that indicates whether the payload is formatted as\nUTF-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\ntemplates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-payloadformatindicator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nA 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\ntemplates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MessageExpiry": { "MarkdownDocumentation": "`MessageExpiry`\n\nA user-defined integer value that represents the message expiry interval at the broker.\nIf the messages haven't been sent to the subscribers within that interval, the message\nexpires and is removed. The value of `messageExpiry` represents the number of\nseconds before it expires. For more information about the limits of\n`messageExpiry`, see [Message broker and protocol limits and\nquotas](https://docs.aws.amazon.com//general/latest/gr/iot-core.html#limits_iot) in the IoT Core Reference Guide.\nSupports [substitution\ntemplates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-messageexpiry", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseTopic": { "MarkdownDocumentation": "`ResponseTopic`\n\nA UTF-8 encoded string that's used as the topic name for a response message. The\nresponse topic is used to describe the topic to which the receiver should publish as part\nof 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\ntemplates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-responsetopic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.S3Action": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.S3Action`\n\nDescribes an action to write data to an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CannedAcl": { "MarkdownDocumentation": "`CannedAcl`\n\nThe Amazon S3 canned ACL that controls access to the object identified by the object\nkey. 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*Allowed values*: `private | public-read | pub...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control", "log-delivery-write" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-cannedacl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe object key. For more information, see [Actions, resources, and condition keys for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.SigV4Authorization": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.SigV4Authorization`\n\nFor more information, see [Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sigv4authorization.html", "Properties": { "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe service name to use while signing with Sig V4.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sigv4authorization.html#cfn-iot-topicrule-sigv4authorization-servicename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SigningRegion": { "MarkdownDocumentation": "`SigningRegion`\n\nThe signing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sigv4authorization.html#cfn-iot-topicrule-sigv4authorization-signingregion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the signing role.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sigv4authorization.html#cfn-iot-topicrule-sigv4authorization-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.SnsAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.SnsAction`\n\nDescribes an action to publish to an Amazon SNS topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html", "Properties": { "MessageFormat": { "MarkdownDocumentation": "`MessageFormat`\n\n(Optional) The message format of the message to publish. Accepted values are \"JSON\"\nand \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine\nif the payload should be parsed and relevant platform-specific bits of the payload should\nbe extracted. For more information, see [Amazon SNS Message and JSON Formats](https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) in the\n*Amazon Simple Notification Service Developer Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `RAW | JSON`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "RAW", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-messageformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe ARN of the SNS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-targetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.SqsAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.SqsAction`\n\nDescribes an action to publish data to an Amazon SQS queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html", "Properties": { "UseBase64": { "MarkdownDocumentation": "`UseBase64`\n\nSpecifies whether to use Base64 encoding.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-usebase64", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "QueueUrl": { "MarkdownDocumentation": "`QueueUrl`\n\nThe URL of the Amazon SQS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-queueurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.StepFunctionsAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.StepFunctionsAction`\n\nStarts execution of a Step Functions state machine.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html", "Properties": { "ExecutionNamePrefix": { "MarkdownDocumentation": "`ExecutionNamePrefix`\n\n(Optional) A name will be given to the state machine execution consisting of this\nprefix followed by a UUID. Step Functions automatically creates a unique name for each state\nmachine execution if one is not 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-executionnameprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StateMachineName": { "MarkdownDocumentation": "`StateMachineName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-statemachinename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants IoT permission to start execution of a state machine\n(\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.Timestamp": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.Timestamp`\n\nDescribes how to interpret an application-defined timestamp value from an MQTT message\npayload and the precision of that value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestamp.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestamp.html#cfn-iot-topicrule-timestamp-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe precision of the timestamp value that results from the expression described in\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestamp.html#cfn-iot-topicrule-timestamp-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.TimestreamAction": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.TimestreamAction`\n\nDescribes an action that writes records into an Amazon Timestream table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of an Amazon Timestream database that has the table to write records\ninto.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nMetadata attributes of the time series that are written in each measure record.\n*Required*: Yes\n*Type*: Array of [TimestreamDimension](./aws-properties-iot-topicrule-timestreamdimension.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-dimensions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TimestreamDimension", "DuplicatesAllowed": true }, "Timestamp": { "MarkdownDocumentation": "`Timestamp`\n\nThe value to use for the entry's timestamp. If blank, the time that the entry was\nprocessed is used.\n*Required*: No\n*Type*: [TimestreamTimestamp](./aws-properties-iot-topicrule-timestreamtimestamp.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-timestamp", "UpdateType": "Mutable", "Required": false, "Type": "TimestreamTimestamp" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the role that grants AWS IoT permission\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.TimestreamDimension": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.TimestreamDimension`\n\nMetadata attributes of the time series that are written in each measure record.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamdimension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to write in this column of the database record.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamdimension.html#cfn-iot-topicrule-timestreamdimension-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe metadata dimension name. This is the name of the column in the Amazon Timestream\ndatabase table record.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamdimension.html#cfn-iot-topicrule-timestreamdimension-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.TimestreamTimestamp": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.TimestreamTimestamp`\n\nThe value to use for the entry's timestamp. If blank, the time that the entry was\nprocessed is used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamtimestamp.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamtimestamp.html#cfn-iot-topicrule-timestreamtimestamp-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe precision of the timestamp value that results from the expression described in\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamtimestamp.html#cfn-iot-topicrule-timestreamtimestamp-unit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.TopicRulePayload": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.TopicRulePayload`\n\nDescribes a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html", "Properties": { "RuleDisabled": { "MarkdownDocumentation": "`RuleDisabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-ruledisabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ErrorAction": { "MarkdownDocumentation": "`ErrorAction`\n\nThe action to take when an error occurs.\n*Required*: No\n*Type*: [Action](./aws-properties-iot-topicrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-erroraction", "UpdateType": "Mutable", "Required": false, "Type": "Action" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the rule.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AwsIotSqlVersion": { "MarkdownDocumentation": "`AwsIotSqlVersion`\n\nThe version of the SQL rules engine to use when evaluating the rule.\nThe default value is 2015-10-08.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions associated with the rule.\n*Required*: Yes\n*Type*: Array of [Action](./aws-properties-iot-topicrule-action.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Action", "DuplicatesAllowed": true }, "Sql": { "MarkdownDocumentation": "`Sql`\n\nThe SQL statement used to query the topic. For more information, see [AWS IoT SQL\nReference](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRule.UserProperty": { "MarkdownDocumentation": "`AWS::IoT::TopicRule.UserProperty`\n\nA key-value pair that you define in the header.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-userproperty.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nA value to be specified in `UserProperty`.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-userproperty.html#cfn-iot-topicrule-userproperty-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nA key to be specified in `UserProperty`.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-userproperty.html#cfn-iot-topicrule-userproperty-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRuleDestination.HttpUrlDestinationSummary": { "MarkdownDocumentation": "`AWS::IoT::TopicRuleDestination.HttpUrlDestinationSummary`\n\nHTTP URL destination properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-httpurldestinationsummary.html", "Properties": { "ConfirmationUrl": { "MarkdownDocumentation": "`ConfirmationUrl`\n\nThe URL used to confirm the HTTP topic rule destination 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-httpurldestinationsummary.html#cfn-iot-topicruledestination-httpurldestinationsummary-confirmationurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoT::TopicRuleDestination.VpcDestinationProperties": { "MarkdownDocumentation": "`AWS::IoT::TopicRuleDestination.VpcDestinationProperties`\n\nThe properties of a virtual private cloud (VPC) destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security groups of the VPC destination.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html#cfn-iot-topicruledestination-vpcdestinationproperties-securitygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html#cfn-iot-topicruledestination-vpcdestinationproperties-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe subnet IDs of the VPC destination.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html#cfn-iot-topicruledestination-vpcdestinationproperties-subnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-vpcdestinationproperties.html#cfn-iot-topicruledestination-vpcdestinationproperties-rolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Channel.ChannelStorage": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Channel.ChannelStorage`\n\nWhere channel data is stored. You may choose one of `serviceManagedS3`,\n`customerManagedS3` storage. If not specified, the default is\n`serviceManagedS3`. This can't be changed after creation of the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html", "Properties": { "CustomerManagedS3": { "MarkdownDocumentation": "`CustomerManagedS3`\n\nUsed to store channel data in an S3 bucket that you manage. If customer managed storage is\nselected, the `retentionPeriod` parameter is ignored. You can't change the choice\nof S3 storage after the data store is created.\n*Required*: No\n*Type*: [CustomerManagedS3](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html#cfn-iotanalytics-channel-channelstorage-customermanageds3", "UpdateType": "Mutable", "Required": false, "Type": "CustomerManagedS3" }, "ServiceManagedS3": { "MarkdownDocumentation": "`ServiceManagedS3`\n\nUsed to store channel data in an S3 bucket managed by AWS IoT Analytics. You can't change the choice\nof 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html#cfn-iotanalytics-channel-channelstorage-servicemanageds3", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::IoTAnalytics::Channel.CustomerManagedS3": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Channel.CustomerManagedS3`\n\nUsed to store channel data in an S3 bucket that you manage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the S3 bucket in which channel data is stored.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9.\\-_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3\nresources.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyPrefix": { "MarkdownDocumentation": "`KeyPrefix`\n\n(Optional) The prefix used to create the keys of the channel data objects. Each object in\nan S3 bucket has a key that is its unique identifier within the bucket (each object in a\nbucket has exactly one key). The prefix must end with a forward slash (/).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9!_.*'()/{}:-]*/$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Channel.RetentionPeriod": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Channel.RetentionPeriod`\n\nHow long, in days, message data is kept.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html", "Properties": { "NumberOfDays": { "MarkdownDocumentation": "`NumberOfDays`\n\nThe number of days that message data is kept. The `unlimited` parameter must be\nfalse.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-numberofdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Unlimited": { "MarkdownDocumentation": "`Unlimited`\n\nIf true, message data is kept indefinitely.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-unlimited", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoTAnalytics::Dataset.Action": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.Action`\n\nInformation needed to run the \"containerAction\" to produce data set contents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html", "Properties": { "ActionName": { "MarkdownDocumentation": "`ActionName`\n\nThe name of the data set action by which data set contents are automatically created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-actionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContainerAction": { "MarkdownDocumentation": "`ContainerAction`\n\nInformation which allows the system to run a containerized application in order to create\nthe data set contents. The application must be in a Docker container along with any needed\nsupport libraries.\n*Required*: No\n*Type*: [ContainerAction](./aws-properties-iotanalytics-dataset-containeraction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-containeraction", "UpdateType": "Mutable", "Required": false, "Type": "ContainerAction" }, "QueryAction": { "MarkdownDocumentation": "`QueryAction`\n\nAn \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents.\n*Required*: No\n*Type*: [QueryAction](./aws-properties-iotanalytics-dataset-queryaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-queryaction", "UpdateType": "Mutable", "Required": false, "Type": "QueryAction" } } }, "AWS::IoTAnalytics::Dataset.ContainerAction": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.ContainerAction`\n\nInformation needed to run the \"containerAction\" to produce data set contents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html", "Properties": { "Variables": { "MarkdownDocumentation": "`Variables`\n\nThe values of variables used within the context of the execution of the containerized\napplication (basically, parameters passed to the application). Each variable must have a\nname and a value given by one of \"stringValue\", \"datasetContentVersionValue\",\nor \"outputFileUriValue\".\n*Required*: No\n*Type*: Array of [Variable](./aws-properties-iotanalytics-dataset-variable.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-variables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Variable", "DuplicatesAllowed": true }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe ARN of the role which gives permission to the system to access needed resources in order\nto run the \"containerAction\". This includes, at minimum, permission to retrieve the data set\ncontents which are the input to the containerized application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-executionrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Image": { "MarkdownDocumentation": "`Image`\n\nThe ARN of the Docker container stored in your account. The Docker container contains an\napplication and needed support libraries and is used to generate data set contents.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-image", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceConfiguration": { "MarkdownDocumentation": "`ResourceConfiguration`\n\nConfiguration of the resource which executes the \"containerAction\".\n*Required*: Yes\n*Type*: [ResourceConfiguration](./aws-properties-iotanalytics-dataset-resourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-resourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ResourceConfiguration" } } }, "AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule`\n\nWhen dataset contents are created, they are delivered to destination specified\nhere.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination to which dataset contents are delivered.\n*Required*: Yes\n*Type*: [DatasetContentDeliveryRuleDestination](./aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-destination", "UpdateType": "Mutable", "Required": true, "Type": "DatasetContentDeliveryRuleDestination" }, "EntryName": { "MarkdownDocumentation": "`EntryName`\n\nThe name of the dataset content delivery rules entry.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-entryname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination`\n\nThe destination to which dataset contents are delivered.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html", "Properties": { "IotEventsDestinationConfiguration": { "MarkdownDocumentation": "`IotEventsDestinationConfiguration`\n\nConfiguration information for delivery of dataset contents to AWS IoT Events.\n*Required*: No\n*Type*: [IotEventsDestinationConfiguration](./aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-ioteventsdestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IotEventsDestinationConfiguration" }, "S3DestinationConfiguration": { "MarkdownDocumentation": "`S3DestinationConfiguration`\n\nConfiguration information for delivery of dataset contents to Amazon S3.\n*Required*: No\n*Type*: [S3DestinationConfiguration](./aws-properties-iotanalytics-dataset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-s3destinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "S3DestinationConfiguration" } } }, "AWS::IoTAnalytics::Dataset.DatasetContentVersionValue": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.DatasetContentVersionValue`\n\nThe dataset whose latest contents are used as input to the notebook or application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentversionvalue.html", "Properties": { "DatasetName": { "MarkdownDocumentation": "`DatasetName`\n\nThe name of the dataset whose latest contents are used as input to the notebook or\napplication.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(^(?!_{2}))(^[a-zA-Z0-9_]+$)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentversionvalue.html#cfn-iotanalytics-dataset-datasetcontentversionvalue-datasetname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.DeltaTime": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.DeltaTime`\n\nUsed to limit data to that which has arrived since the last execution of the\naction.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html", "Properties": { "TimeExpression": { "MarkdownDocumentation": "`TimeExpression`\n\nAn expression by which the time of the message data might be determined. This can be the\nname of a timestamp field or a SQL expression that is used to derive the time the message data\nwas generated.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-timeexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OffsetSeconds": { "MarkdownDocumentation": "`OffsetSeconds`\n\nThe number of seconds of estimated in-flight lag time of message data. When you create\ndataset contents using message data from a specified timeframe, some message data might still\nbe in flight when processing begins, and so do not arrive in time to be processed. Use this\nfield to make allowances for the in flight time of your message data, so that data not\nprocessed from a previous timeframe is included with the next timeframe. Otherwise, missed\nmessage data would be excluded from processing during the next timeframe too, because its\ntimestamp places it within the previous timeframe.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-offsetseconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::IoTAnalytics::Dataset.DeltaTimeSessionWindowConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.DeltaTimeSessionWindowConfiguration`\n\nA structure that contains the configuration information of a delta time session\nwindow.\n[`DeltaTime`](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) specifies a time interval. You can use\n`DeltaTime` to create dataset contents with data that has arrived in the data\nstore since the last execution. For an example of `DeltaTime`, see [Creating\na SQL dataset with a delta window (CLI)](https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6) in the\n*AWS IoT Analytics User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.html", "Properties": { "TimeoutInMinutes": { "MarkdownDocumentation": "`TimeoutInMinutes`\n\nA time interval. You can use `timeoutInMinutes` so that AWS IoT Analytics can batch up late\ndata notifications that have been generated since the last execution. AWS IoT Analytics sends one batch of\nnotifications to Amazon CloudWatch Events at one time.\nFor more information about how to write a timestamp expression, see [Date and Time Functions and\nOperators](https://prestodb.io/docs/current/functions/datetime.html), in the *Presto 0.172 Documentation*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.html#cfn-iotanalytics-dataset-deltatimesessionwindowconfiguration-timeoutinminutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::IoTAnalytics::Dataset.Filter": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.Filter`\n\nInformation which is used to filter message data, to segregate it according to the time\nframe in which it arrives.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html", "Properties": { "DeltaTime": { "MarkdownDocumentation": "`DeltaTime`\n\nUsed to limit data to that which has arrived since the last execution of the action.\n*Required*: No\n*Type*: [DeltaTime](./aws-properties-iotanalytics-dataset-deltatime.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html#cfn-iotanalytics-dataset-filter-deltatime", "UpdateType": "Mutable", "Required": false, "Type": "DeltaTime" } } }, "AWS::IoTAnalytics::Dataset.GlueConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.GlueConfiguration`\n\nConfiguration information for coordination with AWS Glue, a fully managed extract, transform\nand load (ETL) service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the table in your AWS Glue Data Catalog that is used to perform the ETL\noperations. An AWS Glue Data Catalog table contains partitioned data and descriptions of data\nsources and targets.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the database in your AWS Glue Data Catalog in which the table is located. An\nAWS Glue Data Catalog database contains metadata tables.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-databasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration`\n\nConfiguration information for delivery of dataset contents to AWS IoT Events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html", "Properties": { "InputName": { "MarkdownDocumentation": "`InputName`\n\nThe name of the AWS IoT Events input to which dataset contents are delivered.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-inputname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events\ninput.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.LateDataRule": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.LateDataRule`\n\nA structure that contains the name and configuration information of a late data\nrule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html", "Properties": { "RuleConfiguration": { "MarkdownDocumentation": "`RuleConfiguration`\n\nThe information needed to configure the late data rule.\n*Required*: Yes\n*Type*: [LateDataRuleConfiguration](./aws-properties-iotanalytics-dataset-latedataruleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html#cfn-iotanalytics-dataset-latedatarule-ruleconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "LateDataRuleConfiguration" }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nThe name of the late data rule.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html#cfn-iotanalytics-dataset-latedatarule-rulename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.LateDataRuleConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.LateDataRuleConfiguration`\n\nThe information needed to configure a delta time session window.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedataruleconfiguration.html", "Properties": { "DeltaTimeSessionWindowConfiguration": { "MarkdownDocumentation": "`DeltaTimeSessionWindowConfiguration`\n\nThe information needed to configure a delta time session window.\n*Required*: No\n*Type*: [DeltaTimeSessionWindowConfiguration](./aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedataruleconfiguration.html#cfn-iotanalytics-dataset-latedataruleconfiguration-deltatimesessionwindowconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DeltaTimeSessionWindowConfiguration" } } }, "AWS::IoTAnalytics::Dataset.OutputFileUriValue": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.OutputFileUriValue`\n\nThe value of the variable as a structure that specifies an output file URI.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-outputfileurivalue.html", "Properties": { "FileName": { "MarkdownDocumentation": "`FileName`\n\nThe URI of the location where dataset contents are stored, usually the URI of a file in an\nS3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\.-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-outputfileurivalue.html#cfn-iotanalytics-dataset-outputfileurivalue-filename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.QueryAction": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.QueryAction`\n\nAn \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nPre-filters applied to message data.\n*Required*: No\n*Type*: Array of [Filter](./aws-properties-iotanalytics-dataset-filter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-filters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": true }, "SqlQuery": { "MarkdownDocumentation": "`SqlQuery`\n\nAn \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-sqlquery", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.ResourceConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.ResourceConfiguration`\n\nThe configuration of the resource used to execute the `containerAction`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html", "Properties": { "VolumeSizeInGB": { "MarkdownDocumentation": "`VolumeSizeInGB`\n\nThe size, in GB, of the persistent storage available to the resource instance used to\nexecute the `containerAction` (min: 1, max: 50).\n*Required*: Yes\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-volumesizeingb", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ComputeType": { "MarkdownDocumentation": "`ComputeType`\n\nThe type of the compute resource used to execute the `containerAction`.\nPossible values are: `ACU_1` (vCPU=4, memory=16 GiB) or `ACU_2` (vCPU=8,\nmemory=32 GiB).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ACU_1 | ACU_2...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACU_1", "ACU_2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-computetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.RetentionPeriod": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.RetentionPeriod`\n\nHow long, in days, message data is kept.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html", "Properties": { "NumberOfDays": { "MarkdownDocumentation": "`NumberOfDays`\n\nThe number of days that message data is kept. The `unlimited` parameter must be\nfalse.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-numberofdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Unlimited": { "MarkdownDocumentation": "`Unlimited`\n\nIf true, message data is kept indefinitely.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-unlimited", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoTAnalytics::Dataset.S3DestinationConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.S3DestinationConfiguration`\n\nConfiguration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html", "Properties": { "GlueConfiguration": { "MarkdownDocumentation": "`GlueConfiguration`\n\nConfiguration information for coordination with AWS Glue, a fully managed extract, transform\nand load (ETL) service.\n*Required*: No\n*Type*: [GlueConfiguration](./aws-properties-iotanalytics-dataset-glueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-glueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GlueConfiguration" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the S3 bucket to which dataset contents are delivered.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9.\\-_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the dataset contents object in an S3 bucket. Each object has a key that is a\nunique identifier. Each object has exactly one key.\nYou can create a unique key with the following options:\n* Use `!{iotanalytics:scheduleTime}` to insert the time of a scheduled SQL\n query run.\n* Use `!{iotanalytics:versionId}` to insert a unique hash that identifies a\n dataset content.\n* Use `!{iotanalytics:creationTime}` to insert the creation time of a dataset\n content.\nThe following example creates a unique key for a CSV file:\n`dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv`\n###### Note\nIf you don't use `!{iotanalytics:versionId}` to specify the key, you might\nget duplicate keys. For example, you might have two dataset contents with the same\n`scheduleTime` but different `versionId`s. This means that one\ndataset content overwrites the other.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9!_.*'()/{}:-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue\nresources.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.Schedule": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.Schedule`\n\nThe schedule for when to trigger an update.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-schedule.html", "Properties": { "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nThe expression that defines when to trigger an update. For more information, see\n[Schedule Expressions for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) in the Amazon CloudWatch documentation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-schedule.html#cfn-iotanalytics-dataset-schedule-scheduleexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.Trigger": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.Trigger`\n\nThe \"DatasetTrigger\"\nthat specifies when the data set is automatically updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html", "Properties": { "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe \"Schedule\" when the trigger is initiated.\n*Required*: No\n*Type*: [Schedule](./aws-properties-iotanalytics-dataset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-schedule", "UpdateType": "Mutable", "Required": false, "Type": "Schedule" }, "TriggeringDataset": { "MarkdownDocumentation": "`TriggeringDataset`\n\nInformation about the data set whose content generation triggers the new data set content\ngeneration.\n*Required*: No\n*Type*: [TriggeringDataset](./aws-properties-iotanalytics-dataset-triggeringdataset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-triggeringdataset", "UpdateType": "Mutable", "Required": false, "Type": "TriggeringDataset" } } }, "AWS::IoTAnalytics::Dataset.TriggeringDataset": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.TriggeringDataset`\n\nInformation about the dataset whose content generation triggers the new dataset content\ngeneration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html", "Properties": { "DatasetName": { "MarkdownDocumentation": "`DatasetName`\n\nThe name of the data set whose content generation triggers the new data set content\ngeneration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(^(?!_{2}))(^[a-zA-Z0-9_]+$)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html#cfn-iotanalytics-dataset-triggeringdataset-datasetname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.Variable": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.Variable`\n\nAn instance of a variable to be passed to the `containerAction` execution. Each\nvariable must have a name and a value given by one of `stringValue`,\n`datasetContentVersionValue`, or `outputFileUriValue`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html", "Properties": { "DatasetContentVersionValue": { "MarkdownDocumentation": "`DatasetContentVersionValue`\n\nThe value of the variable as a structure that specifies a dataset content version.\n*Required*: No\n*Type*: [DatasetContentVersionValue](./aws-properties-iotanalytics-dataset-datasetcontentversionvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue", "UpdateType": "Mutable", "Required": false, "Type": "DatasetContentVersionValue" }, "DoubleValue": { "MarkdownDocumentation": "`DoubleValue`\n\nThe value of the variable as a double (numeric).\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-doublevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "OutputFileUriValue": { "MarkdownDocumentation": "`OutputFileUriValue`\n\nThe value of the variable as a structure that specifies an output file URI.\n*Required*: No\n*Type*: [OutputFileUriValue](./aws-properties-iotanalytics-dataset-outputfileurivalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-outputfileurivalue", "UpdateType": "Mutable", "Required": false, "Type": "OutputFileUriValue" }, "VariableName": { "MarkdownDocumentation": "`VariableName`\n\nThe name of the variable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-variablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StringValue": { "MarkdownDocumentation": "`StringValue`\n\nThe value of the variable as a string.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-stringvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Dataset.VersioningConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Dataset.VersioningConfiguration`\n\nInformation about the versioning of dataset contents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html", "Properties": { "MaxVersions": { "MarkdownDocumentation": "`MaxVersions`\n\nHow many versions of dataset contents are kept. The `unlimited` parameter must\nbe `false`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-maxversions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Unlimited": { "MarkdownDocumentation": "`Unlimited`\n\nIf true, unlimited versions of dataset contents are kept.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-unlimited", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoTAnalytics::Datastore.Column": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.Column`\n\nContains information about a column that stores your data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of data. For more information about the supported data types, see [Common data types](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html)\nin the *AWS Glue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.html#cfn-iotanalytics-datastore-column-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the column.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.html#cfn-iotanalytics-datastore-column-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Datastore.CustomerManagedS3": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.CustomerManagedS3`\n\nS3-customer-managed; When you choose customer-managed storage, the `retentionPeriod` parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the Amazon S3 bucket where your data is stored.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9.\\-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyPrefix": { "MarkdownDocumentation": "`KeyPrefix`\n\n(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9!_.*'()/{}:-]*/`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Datastore.CustomerManagedS3Storage": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.CustomerManagedS3Storage`\n\nAmazon S3-customer-managed; When you choose customer-managed storage, the `retentionPeriod` parameter is ignored.\nYou can't change the choice of Amazon S3 storage after your data store is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the Amazon S3 bucket where your data is stored.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9.\\-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.html#cfn-iotanalytics-datastore-customermanageds3storage-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyPrefix": { "MarkdownDocumentation": "`KeyPrefix`\n\n(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket.\nEach object in a bucket has exactly one key. The prefix must end with a forward slash (/).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9!_.*'()/{}:-]*/`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.html#cfn-iotanalytics-datastore-customermanageds3storage-keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Datastore.DatastorePartition": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.DatastorePartition`\n\nA single dimension to partition a data store. The dimension must be an `AttributePartition` or a `TimestampPartition`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.html", "Properties": { "Partition": { "MarkdownDocumentation": "`Partition`\n\nA partition dimension defined by an attribute.\n*Required*: No\n*Type*: [Partition](./aws-properties-iotanalytics-datastore-partition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.html#cfn-iotanalytics-datastore-datastorepartition-partition", "UpdateType": "Mutable", "Required": false, "Type": "Partition" }, "TimestampPartition": { "MarkdownDocumentation": "`TimestampPartition`\n\nA partition dimension defined by a timestamp attribute.\n*Required*: No\n*Type*: [TimestampPartition](./aws-properties-iotanalytics-datastore-timestamppartition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.html#cfn-iotanalytics-datastore-datastorepartition-timestamppartition", "UpdateType": "Mutable", "Required": false, "Type": "TimestampPartition" } } }, "AWS::IoTAnalytics::Datastore.DatastorePartitions": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.DatastorePartitions`\n\nInformation about the partition dimensions in a data store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartitions.html", "Properties": { "Partitions": { "MarkdownDocumentation": "`Partitions`\n\nA list of partition dimensions in a data store.\n*Required*: No\n*Type*: Array of [DatastorePartition](./aws-properties-iotanalytics-datastore-datastorepartition.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartitions.html#cfn-iotanalytics-datastore-datastorepartitions-partitions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DatastorePartition", "DuplicatesAllowed": true } } }, "AWS::IoTAnalytics::Datastore.DatastoreStorage": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.DatastoreStorage`\n\nWhere data store data is stored.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html", "Properties": { "CustomerManagedS3": { "MarkdownDocumentation": "`CustomerManagedS3`\n\nUse this to store data store data in an S3 bucket that you manage. The choice of\nservice-managed or customer-managed S3 storage cannot be changed after creation\nof the data store.\n*Required*: No\n*Type*: [CustomerManagedS3](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-customermanageds3", "UpdateType": "Mutable", "Required": false, "Type": "CustomerManagedS3" }, "ServiceManagedS3": { "MarkdownDocumentation": "`ServiceManagedS3`\n\nUse this to store data store data in an S3 bucket managed by the AWS IoT Analytics service.\nThe choice of service-managed or customer-managed S3 storage cannot be changed after creation\nof 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-servicemanageds3", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "IotSiteWiseMultiLayerStorage": { "MarkdownDocumentation": "`IotSiteWiseMultiLayerStorage`\n\nUse this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.\nYou can't change the choice of Amazon S3 storage after your data store is created.\n*Required*: No\n*Type*: [IotSiteWiseMultiLayerStorage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-iotsitewisemultilayerstorage", "UpdateType": "Mutable", "Required": false, "Type": "IotSiteWiseMultiLayerStorage" } } }, "AWS::IoTAnalytics::Datastore.FileFormatConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.FileFormatConfiguration`\n\nContains the configuration information of file formats. AWS IoT Analytics data stores support JSON and [Parquet](https://parquet.apache.org/).\nThe default file format is JSON. You can specify only one format.\nYou can't change the file format after you create the data store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.html", "Properties": { "ParquetConfiguration": { "MarkdownDocumentation": "`ParquetConfiguration`\n\nContains the configuration information of the Parquet format.\n*Required*: No\n*Type*: [ParquetConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.html#cfn-iotanalytics-datastore-fileformatconfiguration-parquetconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ParquetConfiguration" }, "JsonConfiguration": { "MarkdownDocumentation": "`JsonConfiguration`\n\nContains 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.html#cfn-iotanalytics-datastore-fileformatconfiguration-jsonconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::IoTAnalytics::Datastore.IotSiteWiseMultiLayerStorage": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.IotSiteWiseMultiLayerStorage`\n\nStores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.\nYou can't change the choice of Amazon S3 storage after your data store is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-iotsitewisemultilayerstorage.html", "Properties": { "CustomerManagedS3Storage": { "MarkdownDocumentation": "`CustomerManagedS3Storage`\n\nStores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.\n*Required*: No\n*Type*: [CustomerManagedS3Storage](./aws-properties-iotanalytics-datastore-customermanageds3storage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-iotsitewisemultilayerstorage.html#cfn-iotanalytics-datastore-iotsitewisemultilayerstorage-customermanageds3storage", "UpdateType": "Mutable", "Required": false, "Type": "CustomerManagedS3Storage" } } }, "AWS::IoTAnalytics::Datastore.ParquetConfiguration": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.ParquetConfiguration`\n\nContains the configuration information of the Parquet format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-parquetconfiguration.html", "Properties": { "SchemaDefinition": { "MarkdownDocumentation": "`SchemaDefinition`\n\nInformation needed to define a schema.\n*Required*: No\n*Type*: [SchemaDefinition](./aws-properties-iotanalytics-datastore-schemadefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-parquetconfiguration.html#cfn-iotanalytics-datastore-parquetconfiguration-schemadefinition", "UpdateType": "Mutable", "Required": false, "Type": "SchemaDefinition" } } }, "AWS::IoTAnalytics::Datastore.Partition": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.Partition`\n\nA single dimension to partition a data store. The dimension must be an `AttributePartition` or a `TimestampPartition`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-partition.html", "Properties": { "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nThe name of the attribute that defines a partition dimension.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-partition.html#cfn-iotanalytics-datastore-partition-attributename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Datastore.RetentionPeriod": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.RetentionPeriod`\n\nHow long, in days, message data is kept.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html", "Properties": { "NumberOfDays": { "MarkdownDocumentation": "`NumberOfDays`\n\nThe number of days that message data is kept. The `unlimited` parameter must be\nfalse.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-numberofdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Unlimited": { "MarkdownDocumentation": "`Unlimited`\n\nIf true, message data is kept indefinitely.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-unlimited", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoTAnalytics::Datastore.SchemaDefinition": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.SchemaDefinition`\n\nInformation needed to define a schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-schemadefinition.html", "Properties": { "Columns": { "MarkdownDocumentation": "`Columns`\n\nSpecifies one or more columns that store your data.\nEach schema can have up to 100 columns. Each column can have up to 100 nested\ntypes.\n*Required*: No\n*Type*: Array of [Column](./aws-properties-iotanalytics-datastore-column.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-schemadefinition.html#cfn-iotanalytics-datastore-schemadefinition-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Column", "DuplicatesAllowed": true } } }, "AWS::IoTAnalytics::Datastore.TimestampPartition": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Datastore.TimestampPartition`\n\nA partition dimension defined by a timestamp attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.html", "Properties": { "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nThe attribute name of the partition defined by a timestamp.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.html#cfn-iotanalytics-datastore-timestamppartition-attributename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimestampFormat": { "MarkdownDocumentation": "`TimestampFormat`\n\nThe timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.html#cfn-iotanalytics-datastore-timestamppartition-timestampformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.Activity": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.Activity`\n\nAn activity that performs a transformation on a message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html", "Properties": { "SelectAttributes": { "MarkdownDocumentation": "`SelectAttributes`\n\nCreates a new message using only the specified attributes from the original message.\n*Required*: No\n*Type*: [SelectAttributes](./aws-properties-iotanalytics-pipeline-selectattributes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-selectattributes", "UpdateType": "Mutable", "Required": false, "Type": "SelectAttributes" }, "Datastore": { "MarkdownDocumentation": "`Datastore`\n\nSpecifies where to store the processed message data.\n*Required*: No\n*Type*: [Datastore](./aws-properties-iotanalytics-pipeline-datastore.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-datastore", "UpdateType": "Mutable", "Required": false, "Type": "Datastore" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nFilters a message based on its attributes.\n*Required*: No\n*Type*: [Filter](./aws-properties-iotanalytics-pipeline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-filter", "UpdateType": "Mutable", "Required": false, "Type": "Filter" }, "AddAttributes": { "MarkdownDocumentation": "`AddAttributes`\n\nAdds other attributes based on existing attributes in the message.\n*Required*: No\n*Type*: [AddAttributes](./aws-properties-iotanalytics-pipeline-addattributes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-addattributes", "UpdateType": "Mutable", "Required": false, "Type": "AddAttributes" }, "Channel": { "MarkdownDocumentation": "`Channel`\n\nDetermines the source of the messages to be processed.\n*Required*: No\n*Type*: [Channel](./aws-properties-iotanalytics-pipeline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-channel", "UpdateType": "Mutable", "Required": false, "Type": "Channel" }, "DeviceShadowEnrich": { "MarkdownDocumentation": "`DeviceShadowEnrich`\n\nAdds information from the AWS IoT Device Shadows service to a message.\n*Required*: No\n*Type*: [DeviceShadowEnrich](./aws-properties-iotanalytics-pipeline-deviceshadowenrich.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceshadowenrich", "UpdateType": "Mutable", "Required": false, "Type": "DeviceShadowEnrich" }, "Math": { "MarkdownDocumentation": "`Math`\n\nComputes an arithmetic expression using the message's attributes and adds\nit to the message.\n*Required*: No\n*Type*: [Math](./aws-properties-iotanalytics-pipeline-math.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-math", "UpdateType": "Mutable", "Required": false, "Type": "Math" }, "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nRuns a Lambda function to modify the message.\n*Required*: No\n*Type*: [Lambda](./aws-properties-iotanalytics-pipeline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-lambda", "UpdateType": "Mutable", "Required": false, "Type": "Lambda" }, "DeviceRegistryEnrich": { "MarkdownDocumentation": "`DeviceRegistryEnrich`\n\nAdds data from the AWS IoT device registry to your message.\n*Required*: No\n*Type*: [DeviceRegistryEnrich](./aws-properties-iotanalytics-pipeline-deviceregistryenrich.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceregistryenrich", "UpdateType": "Mutable", "Required": false, "Type": "DeviceRegistryEnrich" }, "RemoveAttributes": { "MarkdownDocumentation": "`RemoveAttributes`\n\nRemoves attributes from a message.\n*Required*: No\n*Type*: [RemoveAttributes](./aws-properties-iotanalytics-pipeline-removeattributes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-removeattributes", "UpdateType": "Mutable", "Required": false, "Type": "RemoveAttributes" } } }, "AWS::IoTAnalytics::Pipeline.AddAttributes": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.AddAttributes`\n\nAn activity that adds other attributes based on existing attributes in the message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html", "Properties": { "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nA list of 1-50 \"AttributeNameMapping\"\nobjects that map an existing attribute to a new attribute.\n###### Note\nThe existing attributes remain in the message,\nso if you want to remove the originals,\nuse \"RemoveAttributeActivity\".\n*Required*: Yes\n*Type*: Object of String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-attributes", "UpdateType": "Mutable", "Required": true, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'addAttributes' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.Channel": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.Channel`\n\nDetermines the source of the messages to be processed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html", "Properties": { "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe name of the channel from which the messages are processed.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-channelname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'channel' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.Datastore": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.Datastore`\n\nThe datastore activity that specifies where to store the processed data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html", "Properties": { "DatastoreName": { "MarkdownDocumentation": "`DatastoreName`\n\nThe name of the data store where processed messages are stored.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-datastorename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the datastore activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.DeviceRegistryEnrich": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.DeviceRegistryEnrich`\n\nAn activity that adds data from the AWS IoT device registry to your message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe name of the attribute that is added to the message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThingName": { "MarkdownDocumentation": "`ThingName`\n\nThe name of the IoT device whose registry information is added to the message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-thingname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that allows access to the device's registry information.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'deviceRegistryEnrich' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.DeviceShadowEnrich": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.DeviceShadowEnrich`\n\nAn activity that adds information from the AWS IoT Device Shadows service to a message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe name of the attribute that is added to the message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThingName": { "MarkdownDocumentation": "`ThingName`\n\nThe name of the IoT device whose shadow information is added to\nthe message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-thingname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that allows access to the device's shadow.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'deviceShadowEnrich' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.Filter": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.Filter`\n\nAn activity that filters a message based on its attributes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nAn expression that looks like an SQL WHERE clause that must return a Boolean value.\n*Required*: Yes\n*Type*: [String](./aws-properties-iotanalytics-pipeline-filter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-filter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'filter' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.Lambda": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.Lambda`\n\nAn activity that runs a Lambda function to modify the message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html", "Properties": { "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe number of messages passed to the Lambda function for processing.\nThe AWS Lambda function must be able to process all of these messages within\nfive minutes, which is the maximum timeout duration for Lambda functions.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-batchsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LambdaName": { "MarkdownDocumentation": "`LambdaName`\n\nThe name of the Lambda function that is run on the message.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-lambdaname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'lambda' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.Math": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.Math`\n\nAn activity that computes an arithmetic expression using the message's attributes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe name of the attribute that contains the result of the math operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Math": { "MarkdownDocumentation": "`Math`\n\nAn expression that uses one or more existing attributes and must return an integer value.\n*Required*: Yes\n*Type*: [String](./aws-properties-iotanalytics-pipeline-math.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-math", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'math' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.RemoveAttributes": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.RemoveAttributes`\n\nAn activity that removes attributes from a message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html", "Properties": { "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nA list of 1-50 attributes to remove from the message.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `256 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-attributes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'removeAttributes' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTAnalytics::Pipeline.SelectAttributes": { "MarkdownDocumentation": "`AWS::IoTAnalytics::Pipeline.SelectAttributes`\n\nCreates a new message using only the specified attributes\nfrom the original message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html", "Properties": { "Next": { "MarkdownDocumentation": "`Next`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-next", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nA list of the attributes to select from the message.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `256 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-attributes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 'selectAttributes' activity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::AlarmModel.AcknowledgeFlow": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.AcknowledgeFlow`\n\nSpecifies whether to get notified for alarm state changes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nThe value must be `TRUE` or `FALSE`. If `TRUE`, you\nreceive a notification when the alarm state changes. You must choose to acknowledge the\nnotification before the alarm state can return to `NORMAL`. If `FALSE`,\nyou won't receive notifications. The alarm automatically changes to the `NORMAL`\nstate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html#cfn-iotevents-alarmmodel-acknowledgeflow-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::IoTEvents::AlarmModel.AlarmAction": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.AlarmAction`\n\nSpecifies one of the following actions to receive notifications when the alarm state\nchanges.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html", "Properties": { "DynamoDBv2": { "MarkdownDocumentation": "`DynamoDBv2`\n\nDefines an action to write to the Amazon DynamoDB table that you created. The default action\npayload contains all the information about the detector model instance and the event that\ntriggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of\nthe DynamoDB table receives one attribute-value pair in the payload that you specify.\nYou must use expressions for all parameters in `DynamoDBv2Action`. The expressions\naccept literals, operators, functions, references, and substitution templates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `tableName` parameter can be\n `'GreenhouseTemperatureTable'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `tableName` parameter can be\n `$variable.ddbtableName`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `contentExpression` parameter\n in `Payload` uses a substitution template.\n \n `'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\":\n \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'`\n* For a string concatenation, you must use `+`. A string concatenation can\n also contain a combination of literals, operators, functions, references, and substitution\n templates.\n \n In the following example, the value for the `tableName` parameter uses a\n string concatenation.\n \n `'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\nThe value for the `type` parameter in `Payload` must be\n`JSON`.\n*Required*: No\n*Type*: [DynamoDBv2](./aws-properties-iotevents-alarmmodel-dynamodbv2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-dynamodbv2", "UpdateType": "Mutable", "Required": false, "Type": "DynamoDBv2" }, "IotEvents": { "MarkdownDocumentation": "`IotEvents`\n\nSends an AWS IoT Events input, passing in information about the detector model instance and the\nevent that triggered the action.\n*Required*: No\n*Type*: [IotEvents](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iotevents", "UpdateType": "Mutable", "Required": false, "Type": "IotEvents" }, "IotSiteWise": { "MarkdownDocumentation": "`IotSiteWise`\n\nSends information about the detector model instance and the event that triggered the\naction to a specified asset property in AWS IoT SiteWise.\nYou must use expressions for all parameters in `IotSiteWiseAction`. The\nexpressions accept literals, operators, functions, references, and substitutions\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `propertyAlias` parameter can be\n `'/company/windfarm/3/turbine/7/temperature'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `assetId` parameter can be\n `$input.TurbineInput.assetId1`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `propertyAlias` parameter uses\n a substitution template.\n \n `'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/\n ${$input.TemperatureInput.sensorData.turbineID}/temperature'`\nYou must specify either `propertyAlias` or both `assetId` and\n`propertyId` to identify the target asset property in AWS IoT SiteWise.\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\n*Required*: No\n*Type*: [IotSiteWise](./aws-properties-iotevents-alarmmodel-iotsitewise.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iotsitewise", "UpdateType": "Mutable", "Required": false, "Type": "IotSiteWise" }, "Sqs": { "MarkdownDocumentation": "`Sqs`\n\nSends information about the detector model instance and the event that triggered the\naction to an Amazon SQS queue.\n*Required*: No\n*Type*: [Sqs](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sqs", "UpdateType": "Mutable", "Required": false, "Type": "Sqs" }, "Firehose": { "MarkdownDocumentation": "`Firehose`\n\nSends information about the detector model instance and the event that triggered the\naction to an Amazon Kinesis Data Firehose delivery stream.\n*Required*: No\n*Type*: [Firehose](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-firehose", "UpdateType": "Mutable", "Required": false, "Type": "Firehose" }, "DynamoDB": { "MarkdownDocumentation": "`DynamoDB`\n\nDefines an action to write to the Amazon DynamoDB table that you created. The standard action\npayload contains all the information about the detector model instance and the event that\ntriggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the\nDynamoDB table receives all attribute-value pairs in the payload that you specify.\nYou must use expressions for all parameters in `DynamoDBAction`. The expressions\naccept literals, operators, functions, references, and substitution templates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `hashKeyType` parameter can be `'STRING'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `hashKeyField` parameter can be\n `$input.GreenhouseInput.name`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `hashKeyValue` parameter uses a\n substitution template.\n \n `'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'`\n* For a string concatenation, you must use `+`. A string concatenation can\n also contain a combination of literals, operators, functions, references, and substitution\n templates.\n \n In the following example, the value for the `tableName` parameter uses a\n string concatenation.\n \n `'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\nIf the defined payload type is a string, `DynamoDBAction` writes non-JSON data to\nthe DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text.\nThe value for the `payloadField` parameter is\n`_raw`.\n*Required*: No\n*Type*: [DynamoDB](./aws-properties-iotevents-alarmmodel-dynamodb.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-dynamodb", "UpdateType": "Mutable", "Required": false, "Type": "DynamoDB" }, "IotTopicPublish": { "MarkdownDocumentation": "`IotTopicPublish`\n\nInformation required to publish the MQTT message through the AWS IoT message broker.\n*Required*: No\n*Type*: [IotTopicPublish](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iottopicpublish", "UpdateType": "Mutable", "Required": false, "Type": "IotTopicPublish" }, "Sns": { "MarkdownDocumentation": "`Sns`\n\nInformation required to publish the Amazon SNS message.\n*Required*: No\n*Type*: [Sns](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sns", "UpdateType": "Mutable", "Required": false, "Type": "Sns" }, "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nCalls a Lambda function, passing in information about the detector model instance and the\nevent that triggered the action.\n*Required*: No\n*Type*: [Lambda](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-lambda", "UpdateType": "Mutable", "Required": false, "Type": "Lambda" } } }, "AWS::IoTEvents::AlarmModel.AlarmCapabilities": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.AlarmCapabilities`\n\nContains the configuration information of alarm state changes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html", "Properties": { "AcknowledgeFlow": { "MarkdownDocumentation": "`AcknowledgeFlow`\n\nSpecifies whether to get notified for alarm state changes.\n*Required*: No\n*Type*: [AcknowledgeFlow](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html#cfn-iotevents-alarmmodel-alarmcapabilities-acknowledgeflow", "UpdateType": "Mutable", "Required": false, "Type": "AcknowledgeFlow" }, "InitializationConfiguration": { "MarkdownDocumentation": "`InitializationConfiguration`\n\nSpecifies the default alarm state.\nThe configuration applies to all alarms that were created based on this alarm model.\n*Required*: No\n*Type*: [InitializationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html#cfn-iotevents-alarmmodel-alarmcapabilities-initializationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InitializationConfiguration" } } }, "AWS::IoTEvents::AlarmModel.AlarmEventActions": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.AlarmEventActions`\n\nContains information about one or more alarm actions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.html", "Properties": { "AlarmActions": { "MarkdownDocumentation": "`AlarmActions`\n\nSpecifies one or more supported actions to receive notifications when the alarm state\nchanges.\n*Required*: No\n*Type*: Array of [AlarmAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.html#cfn-iotevents-alarmmodel-alarmeventactions-alarmactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AlarmAction", "DuplicatesAllowed": true } } }, "AWS::IoTEvents::AlarmModel.AlarmRule": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.AlarmRule`\n\nDefines when your alarm is invoked.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.html", "Properties": { "SimpleRule": { "MarkdownDocumentation": "`SimpleRule`\n\nA rule that compares an input property value to a threshold value with a comparison operator.\n*Required*: No\n*Type*: [SimpleRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.html#cfn-iotevents-alarmmodel-alarmrule-simplerule", "UpdateType": "Mutable", "Required": false, "Type": "SimpleRule" } } }, "AWS::IoTEvents::AlarmModel.AssetPropertyTimestamp": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.AssetPropertyTimestamp`\n\nA structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference*.\nYou must use expressions for all parameters in `AssetPropertyTimestamp`. The\nexpressions accept literals, operators, functions, references, and substitution\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `timeInSeconds` parameter can be `'1586400675'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `offsetInNanos` parameter can be\n `$variable.time`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `timeInSeconds` parameter uses\n a substitution template.\n \n `'${$input.TemperatureInput.sensorData.timestamp / 1000}'`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html", "Properties": { "TimeInSeconds": { "MarkdownDocumentation": "`TimeInSeconds`\n\nThe timestamp, in seconds, in the Unix epoch format. The valid range is between\n1-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html#cfn-iotevents-alarmmodel-assetpropertytimestamp-timeinseconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OffsetInNanos": { "MarkdownDocumentation": "`OffsetInNanos`\n\nThe nanosecond offset converted from `timeInSeconds`. The valid range is\nbetween 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html#cfn-iotevents-alarmmodel-assetpropertytimestamp-offsetinnanos", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::AlarmModel.AssetPropertyValue": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.AssetPropertyValue`\n\nA structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference*.\nYou must use expressions for all parameters in `AssetPropertyValue`. The\nexpressions accept literals, operators, functions, references, and substitution\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `quality` parameter can be `'GOOD'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `quality` parameter can be\n `$input.TemperatureInput.sensorData.quality`.\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html", "Properties": { "Quality": { "MarkdownDocumentation": "`Quality`\n\nThe quality of the asset property value. The value must be `'GOOD'`,\n`'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-quality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to send to an asset property.\n*Required*: Yes\n*Type*: [AssetPropertyVariant](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-value", "UpdateType": "Mutable", "Required": true, "Type": "AssetPropertyVariant" }, "Timestamp": { "MarkdownDocumentation": "`Timestamp`\n\nThe timestamp associated with the asset property value. The default is the current event\ntime.\n*Required*: No\n*Type*: [AssetPropertyTimestamp](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-timestamp", "UpdateType": "Mutable", "Required": false, "Type": "AssetPropertyTimestamp" } } }, "AWS::IoTEvents::AlarmModel.AssetPropertyVariant": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.AssetPropertyVariant`\n\nA structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html)\nin the *AWS IoT SiteWise API Reference*.\nYou must use expressions for all parameters in `AssetPropertyVariant`. The\nexpressions accept literals, operators, functions, references, and substitution\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `integerValue` parameter can be `'100'`.\n* For references, you must specify either variables or parameters. For example, the\n value for the `booleanValue` parameter can be\n `$variable.offline`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `doubleValue` parameter uses a\n substitution template.\n \n `'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\nYou must specify one of the following value types, depending on the `dataType`\nof the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the\n*AWS IoT SiteWise API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html", "Properties": { "DoubleValue": { "MarkdownDocumentation": "`DoubleValue`\n\nThe asset property value is a double. You must use an expression, and the evaluated result\nshould 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-doublevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BooleanValue": { "MarkdownDocumentation": "`BooleanValue`\n\nThe asset property value is a Boolean value that must be `'TRUE'` or\n`'FALSE'`. You must use an expression, and the evaluated result should be a\nBoolean 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-booleanvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegerValue": { "MarkdownDocumentation": "`IntegerValue`\n\nThe asset property value is an integer. You must use an expression, and the evaluated\nresult 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-integervalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StringValue": { "MarkdownDocumentation": "`StringValue`\n\nThe asset property value is a string. You must use an expression, and the evaluated result\nshould 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-stringvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::AlarmModel.DynamoDB": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.DynamoDB`\n\nDefines an action to write to the Amazon DynamoDB table that you created. The standard action\npayload contains all the information about the detector model instance and the event that\ntriggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the\nDynamoDB table receives all attribute-value pairs in the payload that you specify.\nYou must use expressions for all parameters in `DynamoDBAction`. The expressions\naccept literals, operators, functions, references, and substitution templates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `hashKeyType` parameter can be `'STRING'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `hashKeyField` parameter can be\n `$input.GreenhouseInput.name`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `hashKeyValue` parameter uses a\n substitution template.\n \n `'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'`\n* For a string concatenation, you must use `+`. A string concatenation can\n also contain a combination of literals, operators, functions, references, and substitution\n templates.\n \n In the following example, the value for the `tableName` parameter uses a\n string concatenation.\n \n `'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\nIf the defined payload type is a string, `DynamoDBAction` writes non-JSON data to\nthe DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text.\nThe value for the `payloadField` parameter is\n`_raw`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the DynamoDB table. The `tableName` value must match the table name of\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PayloadField": { "MarkdownDocumentation": "`PayloadField`\n\nThe name of the DynamoDB column that receives the action payload.\nIf you don't specify this parameter, the name of the DynamoDB column is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-payloadfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeKeyField": { "MarkdownDocumentation": "`RangeKeyField`\n\nThe name of the range key (also called the sort key). The `rangeKeyField` value\nmust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeyfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyField": { "MarkdownDocumentation": "`HashKeyField`\n\nThe name of the hash key (also called the partition key). The `hashKeyField`\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeyfield", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeKeyValue": { "MarkdownDocumentation": "`RangeKeyValue`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeyvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeKeyType": { "MarkdownDocumentation": "`RangeKeyType`\n\nThe data type for the range key (also called the sort key), You can specify the following\nvalues:\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\n`'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyType": { "MarkdownDocumentation": "`HashKeyType`\n\nThe data type for the hash key (also called the partition key). You can specify the\nfollowing 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\n`'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyValue": { "MarkdownDocumentation": "`HashKeyValue`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeyvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nInformation needed to configure the payload.\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload\ncontains all attribute-value pairs that have the information about the detector model instance\nand the event triggered the action. To configure the action payload, you can use\n`contentExpression`.\n*Required*: No\n*Type*: [Payload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" }, "Operation": { "MarkdownDocumentation": "`Operation`\n\nThe 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\n the specified hash key as a partition key. If you specified a range key, the item uses the\n range key as a sort key.\n* `'UPDATE'` - Update an existing item of the DynamoDB table with new data. This\n item's partition key must match the specified hash key. If you specified a range key, the\n range key must match the item's sort key.\n* `'DELETE'` - Delete an existing item of the DynamoDB table. This item's\n partition key must match the specified hash key. If you specified a range key, the range\n key must match the item's sort key.\nIf you don't specify this parameter, AWS IoT Events triggers the `'INSERT'`\noperation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-operation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::AlarmModel.DynamoDBv2": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.DynamoDBv2`\n\nDefines an action to write to the Amazon DynamoDB table that you created. The default action\npayload contains all the information about the detector model instance and the event that\ntriggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of\nthe DynamoDB table receives one attribute-value pair in the payload that you specify.\nYou must use expressions for all parameters in `DynamoDBv2Action`. The expressions\naccept literals, operators, functions, references, and substitution templates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `tableName` parameter can be\n `'GreenhouseTemperatureTable'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `tableName` parameter can be\n `$variable.ddbtableName`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `contentExpression` parameter\n in `Payload` uses a substitution template.\n \n `'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\":\n \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'`\n* For a string concatenation, you must use `+`. A string concatenation can\n also contain a combination of literals, operators, functions, references, and substitution\n templates.\n \n In the following example, the value for the `tableName` parameter uses a\n string concatenation.\n \n `'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\nThe value for the `type` parameter in `Payload` must be\n`JSON`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nInformation needed to configure the payload.\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload\ncontains all attribute-value pairs that have the information about the detector model instance\nand the event triggered the action. To configure the action payload, you can use\n`contentExpression`.\n*Required*: No\n*Type*: [Payload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::AlarmModel.Firehose": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.Firehose`\n\nSends information about the detector model instance and the event that triggered the\naction to an Amazon Kinesis Data Firehose delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html", "Properties": { "DeliveryStreamName": { "MarkdownDocumentation": "`DeliveryStreamName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-deliverystreamname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message to an Amazon Data Firehose delivery\nstream.\n*Required*: No\n*Type*: [Payload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" }, "Separator": { "MarkdownDocumentation": "`Separator`\n\nA character separator that is used to separate records written to the Kinesis Data\nFirehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows\nnewline), ',' (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-separator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::AlarmModel.InitializationConfiguration": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.InitializationConfiguration`\n\nSpecifies the default alarm state.\nThe configuration applies to all alarms that were created based on this alarm model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html", "Properties": { "DisabledOnInitialization": { "MarkdownDocumentation": "`DisabledOnInitialization`\n\nThe value must be `TRUE` or `FALSE`. If `FALSE`, all\nalarm instances created based on the alarm model are activated. The default value is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html#cfn-iotevents-alarmmodel-initializationconfiguration-disabledoninitialization", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::IoTEvents::AlarmModel.IotEvents": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.IotEvents`\n\nSends an AWS IoT Events input, passing in information about the detector model instance and the\nevent that triggered the action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html", "Properties": { "InputName": { "MarkdownDocumentation": "`InputName`\n\nThe name of the AWS IoT Events input where the data is sent.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html#cfn-iotevents-alarmmodel-iotevents-inputname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message to an AWS IoT Events input.\n*Required*: No\n*Type*: [Payload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html#cfn-iotevents-alarmmodel-iotevents-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::AlarmModel.IotSiteWise": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.IotSiteWise`\n\nSends information about the detector model instance and the event that triggered the\naction to a specified asset property in AWS IoT SiteWise.\nYou must use expressions for all parameters in `IotSiteWiseAction`. The\nexpressions accept literals, operators, functions, references, and substitutions\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `propertyAlias` parameter can be\n `'/company/windfarm/3/turbine/7/temperature'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `assetId` parameter can be\n `$input.TurbineInput.assetId1`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `propertyAlias` parameter uses\n a substitution template.\n \n `'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/\n ${$input.TemperatureInput.sensorData.turbineID}/temperature'`\nYou must specify either `propertyAlias` or both `assetId` and\n`propertyId` to identify the target asset property in AWS IoT SiteWise.\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html", "Properties": { "EntryId": { "MarkdownDocumentation": "`EntryId`\n\nA unique identifier for this entry. You can use the entry ID to track which data entry\ncauses 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-entryid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyAlias": { "MarkdownDocumentation": "`PropertyAlias`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyalias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyValue": { "MarkdownDocumentation": "`PropertyValue`\n\nThe value to send to the asset property. This value contains timestamp, quality, and value\n(TQV) information.\n*Required*: No\n*Type*: [AssetPropertyValue](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyvalue", "UpdateType": "Mutable", "Required": false, "Type": "AssetPropertyValue" }, "AssetId": { "MarkdownDocumentation": "`AssetId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-assetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyId": { "MarkdownDocumentation": "`PropertyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::AlarmModel.IotTopicPublish": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.IotTopicPublish`\n\nInformation required to publish the MQTT message through the AWS IoT message broker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html", "Properties": { "MqttTopic": { "MarkdownDocumentation": "`MqttTopic`\n\nThe MQTT topic of the message. You can use a string expression that includes variables\n(`$variable.`) and input values\n(`$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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html#cfn-iotevents-alarmmodel-iottopicpublish-mqtttopic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you publish a message to an AWS IoT Core\ntopic.\n*Required*: No\n*Type*: [Payload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html#cfn-iotevents-alarmmodel-iottopicpublish-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::AlarmModel.Lambda": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.Lambda`\n\nCalls a Lambda function, passing in information about the detector model instance and the\nevent that triggered the action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html", "Properties": { "FunctionArn": { "MarkdownDocumentation": "`FunctionArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html#cfn-iotevents-alarmmodel-lambda-functionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message to a Lambda function.\n*Required*: No\n*Type*: [Payload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html#cfn-iotevents-alarmmodel-lambda-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::AlarmModel.Payload": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.Payload`\n\nInformation needed to configure the payload.\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload\ncontains all attribute-value pairs that have the information about the detector model instance\nand the event triggered the action. To configure the action payload, you can use\n`contentExpression`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html", "Properties": { "ContentExpression": { "MarkdownDocumentation": "`ContentExpression`\n\nThe content of the payload. You can use a string expression that includes quoted strings\n(`''`), variables (`$variable.`),\ninput values (`$input..`), string\nconcatenations, and quoted strings that contain `${}` as the content. The\nrecommended 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html#cfn-iotevents-alarmmodel-payload-contentexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe value of the payload type can be either `STRING` or\n`JSON`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRING | JSON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html#cfn-iotevents-alarmmodel-payload-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::AlarmModel.SimpleRule": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.SimpleRule`\n\nA rule that compares an input property value to a threshold value with a comparison operator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe comparison operator.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GREATER | GREATER_OR_EQUAL ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GREATER", "GREATER_OR_EQUAL", "LESS", "LESS_OR_EQUAL", "EQUAL", "NOT_EQUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-comparisonoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputProperty": { "MarkdownDocumentation": "`InputProperty`\n\nThe value on the left side of the comparison operator. You can specify an AWS IoT Events input\nattribute 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-inputproperty", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\nThe value on the right side of the comparison operator. You can enter a number or specify\nan 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-threshold", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::AlarmModel.Sns": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.Sns`\n\nInformation required to publish the Amazon SNS message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html", "Properties": { "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html#cfn-iotevents-alarmmodel-sns-targetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message as an Amazon SNS push\nnotification.\n*Required*: No\n*Type*: [Payload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html#cfn-iotevents-alarmmodel-sns-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::AlarmModel.Sqs": { "MarkdownDocumentation": "`AWS::IoTEvents::AlarmModel.Sqs`\n\nSends information about the detector model instance and the event that triggered the\naction to an Amazon SQS queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html", "Properties": { "UseBase64": { "MarkdownDocumentation": "`UseBase64`\n\nSet this to TRUE if you want the data to be base-64 encoded before it is written to the\nqueue. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-usebase64", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message to an Amazon SQS\nqueue.\n*Required*: No\n*Type*: [Payload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" }, "QueueUrl": { "MarkdownDocumentation": "`QueueUrl`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-queueurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.Action": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.Action`\n\nAn action to be performed when the `condition` is TRUE.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html", "Properties": { "IotEvents": { "MarkdownDocumentation": "`IotEvents`\n\nSends AWS IoT Events input, which passes information about the detector model instance and the\nevent that triggered the action.\n*Required*: No\n*Type*: [IotEvents](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iotevents", "UpdateType": "Mutable", "Required": false, "Type": "IotEvents" }, "Firehose": { "MarkdownDocumentation": "`Firehose`\n\nSends information about the detector model instance and the event that triggered the\naction to an Amazon Kinesis Data Firehose delivery stream.\n*Required*: No\n*Type*: [Firehose](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-firehose", "UpdateType": "Mutable", "Required": false, "Type": "Firehose" }, "DynamoDB": { "MarkdownDocumentation": "`DynamoDB`\n\nWrites to the DynamoDB table that you created. The default action payload contains all\nattribute-value pairs that have the information about the detector model instance and the\nevent that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the\nDynamoDB table receives all attribute-value pairs in the payload that you specify. For more\ninformation, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in\n*AWS IoT Events Developer Guide*.\n*Required*: No\n*Type*: [DynamoDB](./aws-properties-iotevents-detectormodel-dynamodb.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-dynamodb", "UpdateType": "Mutable", "Required": false, "Type": "DynamoDB" }, "IotTopicPublish": { "MarkdownDocumentation": "`IotTopicPublish`\n\nPublishes an MQTT message with the given topic to the AWS IoT message broker.\n*Required*: No\n*Type*: [IotTopicPublish](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iottopicpublish", "UpdateType": "Mutable", "Required": false, "Type": "IotTopicPublish" }, "DynamoDBv2": { "MarkdownDocumentation": "`DynamoDBv2`\n\nWrites to the DynamoDB table that you created. The default action payload contains all\nattribute-value pairs that have the information about the detector model instance and the\nevent that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of\nthe DynamoDB table receives one attribute-value pair in the payload that you specify. For more\ninformation, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in\n*AWS IoT Events Developer Guide*.\n*Required*: No\n*Type*: [DynamoDBv2](./aws-properties-iotevents-detectormodel-dynamodbv2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-dynamodbv2", "UpdateType": "Mutable", "Required": false, "Type": "DynamoDBv2" }, "IotSiteWise": { "MarkdownDocumentation": "`IotSiteWise`\n\nSends information about the detector model instance and the event that triggered the\naction to an asset property in AWS IoT SiteWise .\n*Required*: No\n*Type*: [IotSiteWise](./aws-properties-iotevents-detectormodel-iotsitewise.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iotsitewise", "UpdateType": "Mutable", "Required": false, "Type": "IotSiteWise" }, "ResetTimer": { "MarkdownDocumentation": "`ResetTimer`\n\nInformation needed to reset the timer.\n*Required*: No\n*Type*: [ResetTimer](./aws-properties-iotevents-detectormodel-resettimer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-resettimer", "UpdateType": "Mutable", "Required": false, "Type": "ResetTimer" }, "Sqs": { "MarkdownDocumentation": "`Sqs`\n\nSends an Amazon SNS message.\n*Required*: No\n*Type*: [Sqs](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-sqs", "UpdateType": "Mutable", "Required": false, "Type": "Sqs" }, "SetTimer": { "MarkdownDocumentation": "`SetTimer`\n\nInformation needed to set the timer.\n*Required*: No\n*Type*: [SetTimer](./aws-properties-iotevents-detectormodel-settimer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-settimer", "UpdateType": "Mutable", "Required": false, "Type": "SetTimer" }, "Sns": { "MarkdownDocumentation": "`Sns`\n\nSends an Amazon SNS message.\n*Required*: No\n*Type*: [Sns](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-sns", "UpdateType": "Mutable", "Required": false, "Type": "Sns" }, "ClearTimer": { "MarkdownDocumentation": "`ClearTimer`\n\nInformation needed to clear the timer.\n*Required*: No\n*Type*: [ClearTimer](./aws-properties-iotevents-detectormodel-cleartimer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-cleartimer", "UpdateType": "Mutable", "Required": false, "Type": "ClearTimer" }, "Lambda": { "MarkdownDocumentation": "`Lambda`\n\nCalls a Lambda function, passing in information about the detector model instance and the\nevent that triggered the action.\n*Required*: No\n*Type*: [Lambda](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-lambda", "UpdateType": "Mutable", "Required": false, "Type": "Lambda" }, "SetVariable": { "MarkdownDocumentation": "`SetVariable`\n\nSets a variable to a specified value.\n*Required*: No\n*Type*: [SetVariable](./aws-properties-iotevents-detectormodel-setvariable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-setvariable", "UpdateType": "Mutable", "Required": false, "Type": "SetVariable" } } }, "AWS::IoTEvents::DetectorModel.AssetPropertyTimestamp": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.AssetPropertyTimestamp`\n\nA structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference*.\nYou must use expressions for all parameters in `AssetPropertyTimestamp`. The\nexpressions accept literals, operators, functions, references, and substitution\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `timeInSeconds` parameter can be `'1586400675'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `offsetInNanos` parameter can be\n `$variable.time`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `timeInSeconds` parameter uses\n a substitution template.\n \n `'${$input.TemperatureInput.sensorData.timestamp / 1000}'`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html", "Properties": { "TimeInSeconds": { "MarkdownDocumentation": "`TimeInSeconds`\n\nThe timestamp, in seconds, in the Unix epoch format. The valid range is between\n1-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html#cfn-iotevents-detectormodel-assetpropertytimestamp-timeinseconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OffsetInNanos": { "MarkdownDocumentation": "`OffsetInNanos`\n\nThe nanosecond offset converted from `timeInSeconds`. The valid range is\nbetween 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html#cfn-iotevents-detectormodel-assetpropertytimestamp-offsetinnanos", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.AssetPropertyValue": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.AssetPropertyValue`\n\nA structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference*.\nYou must use expressions for all parameters in `AssetPropertyValue`. The\nexpressions accept literals, operators, functions, references, and substitution\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `quality` parameter can be `'GOOD'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `quality` parameter can be\n `$input.TemperatureInput.sensorData.quality`.\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html", "Properties": { "Quality": { "MarkdownDocumentation": "`Quality`\n\nThe quality of the asset property value. The value must be `'GOOD'`,\n`'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-quality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to send to an asset property.\n*Required*: Yes\n*Type*: [AssetPropertyVariant](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-value", "UpdateType": "Mutable", "Required": true, "Type": "AssetPropertyVariant" }, "Timestamp": { "MarkdownDocumentation": "`Timestamp`\n\nThe timestamp associated with the asset property value. The default is the current event\ntime.\n*Required*: No\n*Type*: [AssetPropertyTimestamp](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-timestamp", "UpdateType": "Mutable", "Required": false, "Type": "AssetPropertyTimestamp" } } }, "AWS::IoTEvents::DetectorModel.AssetPropertyVariant": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.AssetPropertyVariant`\n\nA structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html)\nin the *AWS IoT SiteWise API Reference*.\nYou must use expressions for all parameters in `AssetPropertyVariant`. The\nexpressions accept literals, operators, functions, references, and substitution\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `integerValue` parameter can be `'100'`.\n* For references, you must specify either variables or parameters. For example, the\n value for the `booleanValue` parameter can be\n `$variable.offline`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `doubleValue` parameter uses a\n substitution template.\n \n `'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\nYou must specify one of the following value types, depending on the `dataType`\nof the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the\n*AWS IoT SiteWise API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html", "Properties": { "DoubleValue": { "MarkdownDocumentation": "`DoubleValue`\n\nThe asset property value is a double. You must use an expression, and the evaluated result\nshould 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-doublevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BooleanValue": { "MarkdownDocumentation": "`BooleanValue`\n\nThe asset property value is a Boolean value that must be `'TRUE'` or\n`'FALSE'`. You must use an expression, and the evaluated result should be a\nBoolean 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-booleanvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegerValue": { "MarkdownDocumentation": "`IntegerValue`\n\nThe asset property value is an integer. You must use an expression, and the evaluated\nresult 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-integervalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StringValue": { "MarkdownDocumentation": "`StringValue`\n\nThe asset property value is a string. You must use an expression, and the evaluated result\nshould 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-stringvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.ClearTimer": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.ClearTimer`\n\nInformation needed to clear the timer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-cleartimer.html", "Properties": { "TimerName": { "MarkdownDocumentation": "`TimerName`\n\nThe name of the timer to clear.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-cleartimer.html#cfn-iotevents-detectormodel-cleartimer-timername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.DetectorModelDefinition": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.DetectorModelDefinition`\n\nInformation that defines how a detector operates.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html", "Properties": { "States": { "MarkdownDocumentation": "`States`\n\nInformation about the states of the detector.\n*Required*: Yes\n*Type*: Array of [State](./aws-properties-iotevents-detectormodel-state.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html#cfn-iotevents-detectormodel-detectormodeldefinition-states", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "State", "DuplicatesAllowed": true }, "InitialStateName": { "MarkdownDocumentation": "`InitialStateName`\n\nThe state that is entered at the creation of each detector (instance).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html#cfn-iotevents-detectormodel-detectormodeldefinition-initialstatename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.DynamoDB": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.DynamoDB`\n\nDefines an action to write to the Amazon DynamoDB table that you created. The standard action\npayload contains all the information about the detector model instance and the event that\ntriggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the\nDynamoDB table receives all attribute-value pairs in the payload that you specify.\nYou must use expressions for all parameters in `DynamoDBAction`. The expressions\naccept literals, operators, functions, references, and substitution templates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `hashKeyType` parameter can be `'STRING'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `hashKeyField` parameter can be\n `$input.GreenhouseInput.name`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `hashKeyValue` parameter uses a\n substitution template.\n \n `'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'`\n* For a string concatenation, you must use `+`. A string concatenation can\n also contain a combination of literals, operators, functions, references, and substitution\n templates.\n \n In the following example, the value for the `tableName` parameter uses a\n string concatenation.\n \n `'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\nIf the defined payload type is a string, `DynamoDBAction` writes non-JSON data to\nthe DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text.\nThe value for the `payloadField` parameter is\n`_raw`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the DynamoDB table. The `tableName` value must match the table name of\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PayloadField": { "MarkdownDocumentation": "`PayloadField`\n\nThe name of the DynamoDB column that receives the action payload.\nIf you don't specify this parameter, the name of the DynamoDB column is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-payloadfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeKeyField": { "MarkdownDocumentation": "`RangeKeyField`\n\nThe name of the range key (also called the sort key). The `rangeKeyField` value\nmust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeyfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyField": { "MarkdownDocumentation": "`HashKeyField`\n\nThe name of the hash key (also called the partition key). The `hashKeyField`\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeyfield", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeKeyValue": { "MarkdownDocumentation": "`RangeKeyValue`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeyvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeKeyType": { "MarkdownDocumentation": "`RangeKeyType`\n\nThe data type for the range key (also called the sort key), You can specify the following\nvalues:\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\n`'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyType": { "MarkdownDocumentation": "`HashKeyType`\n\nThe data type for the hash key (also called the partition key). You can specify the\nfollowing 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\n`'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HashKeyValue": { "MarkdownDocumentation": "`HashKeyValue`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeyvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nInformation needed to configure the payload.\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload\ncontains all attribute-value pairs that have the information about the detector model instance\nand the event triggered the action. To configure the action payload, you can use\n`contentExpression`.\n*Required*: No\n*Type*: [Payload](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" }, "Operation": { "MarkdownDocumentation": "`Operation`\n\nThe 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\n the specified hash key as a partition key. If you specified a range key, the item uses the\n range key as a sort key.\n* `'UPDATE'` - Update an existing item of the DynamoDB table with new data. This\n item's partition key must match the specified hash key. If you specified a range key, the\n range key must match the item's sort key.\n* `'DELETE'` - Delete an existing item of the DynamoDB table. This item's\n partition key must match the specified hash key. If you specified a range key, the range\n key must match the item's sort key.\nIf you don't specify this parameter, AWS IoT Events triggers the `'INSERT'`\noperation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-operation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.DynamoDBv2": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.DynamoDBv2`\n\nDefines an action to write to the Amazon DynamoDB table that you created. The default action\npayload contains all the information about the detector model instance and the event that\ntriggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of\nthe DynamoDB table receives one attribute-value pair in the payload that you specify.\nYou must use expressions for all parameters in `DynamoDBv2Action`. The expressions\naccept literals, operators, functions, references, and substitution templates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `tableName` parameter can be\n `'GreenhouseTemperatureTable'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `tableName` parameter can be\n `$variable.ddbtableName`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `contentExpression` parameter\n in `Payload` uses a substitution template.\n \n `'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\":\n \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'`\n* For a string concatenation, you must use `+`. A string concatenation can\n also contain a combination of literals, operators, functions, references, and substitution\n templates.\n \n In the following example, the value for the `tableName` parameter uses a\n string concatenation.\n \n `'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\nThe value for the `type` parameter in `Payload` must be\n`JSON`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html#cfn-iotevents-detectormodel-dynamodbv2-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nInformation needed to configure the payload.\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload\ncontains all attribute-value pairs that have the information about the detector model instance\nand the event triggered the action. To configure the action payload, you can use\n`contentExpression`.\n*Required*: No\n*Type*: [Payload](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html#cfn-iotevents-detectormodel-dynamodbv2-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::DetectorModel.Event": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.Event`\n\nSpecifies the `actions` to be performed when the `condition`\nevaluates to TRUE.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nOptional. The Boolean expression that, when TRUE, causes the `actions` to be\nperformed. If not present, the actions are performed (=TRUE). If the expression result is not\na Boolean value, the actions are not performed (=FALSE).\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-condition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions to be performed.\n*Required*: No\n*Type*: Array of [Action](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Action", "DuplicatesAllowed": true }, "EventName": { "MarkdownDocumentation": "`EventName`\n\nThe name of the event.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-eventname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.Firehose": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.Firehose`\n\nSends information about the detector model instance and the event that triggered the\naction to an Amazon Kinesis Data Firehose delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html", "Properties": { "DeliveryStreamName": { "MarkdownDocumentation": "`DeliveryStreamName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-deliverystreamname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message to an Amazon Data Firehose delivery\nstream.\n*Required*: No\n*Type*: [Payload](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" }, "Separator": { "MarkdownDocumentation": "`Separator`\n\nA character separator that is used to separate records written to the Kinesis Data\nFirehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows\nnewline), ',' (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-separator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.IotEvents": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.IotEvents`\n\nSends an AWS IoT Events input, passing in information about the detector model instance and the\nevent that triggered the action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html", "Properties": { "InputName": { "MarkdownDocumentation": "`InputName`\n\nThe name of the AWS IoT Events input where the data is sent.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html#cfn-iotevents-detectormodel-iotevents-inputname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message to an AWS IoT Events input.\n*Required*: No\n*Type*: [Payload](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html#cfn-iotevents-detectormodel-iotevents-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::DetectorModel.IotSiteWise": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.IotSiteWise`\n\nSends information about the detector model instance and the event that triggered the\naction to a specified asset property in AWS IoT SiteWise.\nYou must use expressions for all parameters in `IotSiteWiseAction`. The\nexpressions accept literals, operators, functions, references, and substitutions\ntemplates.\n###### Examples\n* For literal values, the expressions must contain single quotes. For example, the value\n for the `propertyAlias` parameter can be\n `'/company/windfarm/3/turbine/7/temperature'`.\n* For references, you must specify either variables or input values. For example, the\n value for the `assetId` parameter can be\n `$input.TurbineInput.assetId1`.\n* For a substitution template, you must use `${}`, and the template must be\n in single quotes. A substitution template can also contain a combination of literals,\n operators, functions, references, and substitution templates.\n \n In the following example, the value for the `propertyAlias` parameter uses\n a substitution template.\n \n `'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/\n ${$input.TemperatureInput.sensorData.turbineID}/temperature'`\nYou must specify either `propertyAlias` or both `assetId` and\n`propertyId` to identify the target asset property in AWS IoT SiteWise.\nFor more information,\nsee [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)\nin the *AWS IoT Events Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html", "Properties": { "EntryId": { "MarkdownDocumentation": "`EntryId`\n\nA unique identifier for this entry. You can use the entry ID to track which data entry\ncauses 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-entryid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyAlias": { "MarkdownDocumentation": "`PropertyAlias`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyalias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyValue": { "MarkdownDocumentation": "`PropertyValue`\n\nThe value to send to the asset property. This value contains timestamp, quality, and value\n(TQV) information.\n*Required*: Yes\n*Type*: [AssetPropertyValue](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyvalue", "UpdateType": "Mutable", "Required": true, "Type": "AssetPropertyValue" }, "AssetId": { "MarkdownDocumentation": "`AssetId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-assetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyId": { "MarkdownDocumentation": "`PropertyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.IotTopicPublish": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.IotTopicPublish`\n\nInformation required to publish the MQTT message through the AWS IoT message broker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html", "Properties": { "MqttTopic": { "MarkdownDocumentation": "`MqttTopic`\n\nThe MQTT topic of the message. You can use a string expression that includes variables\n(`$variable.`) and input values\n(`$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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html#cfn-iotevents-detectormodel-iottopicpublish-mqtttopic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you publish a message to an AWS IoT Core\ntopic.\n*Required*: No\n*Type*: [Payload](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html#cfn-iotevents-detectormodel-iottopicpublish-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::DetectorModel.Lambda": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.Lambda`\n\nCalls a Lambda function, passing in information about the detector model instance and the\nevent that triggered the action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html", "Properties": { "FunctionArn": { "MarkdownDocumentation": "`FunctionArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html#cfn-iotevents-detectormodel-lambda-functionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message to a Lambda function.\n*Required*: No\n*Type*: [Payload](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html#cfn-iotevents-detectormodel-lambda-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::DetectorModel.OnEnter": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.OnEnter`\n\nWhen entering this state, perform these `actions` if the `condition`\nis TRUE.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html", "Properties": { "Events": { "MarkdownDocumentation": "`Events`\n\nSpecifies the actions that are performed when the state is entered and the\n`condition` is `TRUE`.\n*Required*: No\n*Type*: Array of [Event](./aws-properties-iotevents-detectormodel-event.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html#cfn-iotevents-detectormodel-onenter-events", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Event", "DuplicatesAllowed": true } } }, "AWS::IoTEvents::DetectorModel.OnExit": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.OnExit`\n\nWhen exiting this state, perform these `actions` if the specified\n`condition` is `TRUE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html", "Properties": { "Events": { "MarkdownDocumentation": "`Events`\n\nSpecifies the `actions` that are performed when the state is exited and the\n`condition` is `TRUE`.\n*Required*: No\n*Type*: Array of [Event](./aws-properties-iotevents-detectormodel-event.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html#cfn-iotevents-detectormodel-onexit-events", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Event", "DuplicatesAllowed": true } } }, "AWS::IoTEvents::DetectorModel.OnInput": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.OnInput`\n\nSpecifies the actions performed when the `condition` evaluates to TRUE.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html", "Properties": { "Events": { "MarkdownDocumentation": "`Events`\n\nSpecifies the actions performed when the `condition` evaluates to TRUE.\n*Required*: No\n*Type*: Array of [Event](./aws-properties-iotevents-detectormodel-event.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html#cfn-iotevents-detectormodel-oninput-events", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Event", "DuplicatesAllowed": true }, "TransitionEvents": { "MarkdownDocumentation": "`TransitionEvents`\n\nSpecifies the actions performed, and the next state entered, when a `condition`\nevaluates to TRUE.\n*Required*: No\n*Type*: Array of [TransitionEvent](./aws-properties-iotevents-detectormodel-transitionevent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html#cfn-iotevents-detectormodel-oninput-transitionevents", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TransitionEvent", "DuplicatesAllowed": true } } }, "AWS::IoTEvents::DetectorModel.Payload": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.Payload`\n\nInformation needed to configure the payload.\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload\ncontains all attribute-value pairs that have the information about the detector model instance\nand the event triggered the action. To configure the action payload, you can use\n`contentExpression`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html", "Properties": { "ContentExpression": { "MarkdownDocumentation": "`ContentExpression`\n\nThe content of the payload. You can use a string expression that includes quoted strings\n(`''`), variables (`$variable.`),\ninput values (`$input..`), string\nconcatenations, and quoted strings that contain `${}` as the content. The\nrecommended 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html#cfn-iotevents-detectormodel-payload-contentexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe value of the payload type can be either `STRING` or\n`JSON`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRING | JSON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html#cfn-iotevents-detectormodel-payload-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.ResetTimer": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.ResetTimer`\n\nInformation required to reset the timer. The timer is reset to the previously evaluated\nresult of the duration. The duration expression isn't reevaluated when you reset the\ntimer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-resettimer.html", "Properties": { "TimerName": { "MarkdownDocumentation": "`TimerName`\n\nThe name of the timer to reset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-resettimer.html#cfn-iotevents-detectormodel-resettimer-timername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.SetTimer": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.SetTimer`\n\nInformation needed to set the timer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html", "Properties": { "Seconds": { "MarkdownDocumentation": "`Seconds`\n\nThe number of seconds until the timer expires. The minimum value is 60 seconds to ensure\naccuracy. The maximum value is 31622400 seconds.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `31622400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-seconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TimerName": { "MarkdownDocumentation": "`TimerName`\n\nThe name of the timer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-timername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DurationExpression": { "MarkdownDocumentation": "`DurationExpression`\n\nThe duration of the timer, in seconds. You can use a string expression that includes\nnumbers, variables (`$variable.`), and input values\n(`$input..`) as the duration. The range of\nthe duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds.\nThe evaluated result of the duration is rounded down to the nearest whole number.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-durationexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.SetVariable": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.SetVariable`\n\nInformation about the variable and its new value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe new value of the variable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html#cfn-iotevents-detectormodel-setvariable-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VariableName": { "MarkdownDocumentation": "`VariableName`\n\nThe name of the variable.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html#cfn-iotevents-detectormodel-setvariable-variablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.Sns": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.Sns`\n\nInformation required to publish the Amazon SNS message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html", "Properties": { "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html#cfn-iotevents-detectormodel-sns-targetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message as an Amazon SNS push\nnotification.\n*Required*: No\n*Type*: [Payload](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html#cfn-iotevents-detectormodel-sns-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" } } }, "AWS::IoTEvents::DetectorModel.Sqs": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.Sqs`\n\nSends information about the detector model instance and the event that triggered the\naction to an Amazon SQS queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html", "Properties": { "UseBase64": { "MarkdownDocumentation": "`UseBase64`\n\nSet this to TRUE if you want the data to be base-64 encoded before it is written to the\nqueue. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-usebase64", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nYou can configure the action payload when you send a message to an Amazon SQS\nqueue.\n*Required*: No\n*Type*: [Payload](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-payload", "UpdateType": "Mutable", "Required": false, "Type": "Payload" }, "QueueUrl": { "MarkdownDocumentation": "`QueueUrl`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-queueurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::DetectorModel.State": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.State`\n\nInformation that defines a state of a detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html", "Properties": { "OnInput": { "MarkdownDocumentation": "`OnInput`\n\nWhen an input is received and the `condition` is TRUE, perform the specified\n`actions`.\n*Required*: No\n*Type*: [OnInput](./aws-properties-iotevents-detectormodel-oninput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-oninput", "UpdateType": "Mutable", "Required": false, "Type": "OnInput" }, "OnExit": { "MarkdownDocumentation": "`OnExit`\n\nWhen exiting this state, perform these `actions` if the specified\n`condition` is `TRUE`.\n*Required*: No\n*Type*: [OnExit](./aws-properties-iotevents-detectormodel-onexit.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onexit", "UpdateType": "Mutable", "Required": false, "Type": "OnExit" }, "StateName": { "MarkdownDocumentation": "`StateName`\n\nThe name of the state.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-statename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OnEnter": { "MarkdownDocumentation": "`OnEnter`\n\nWhen entering this state, perform these `actions` if the `condition`\nis TRUE.\n*Required*: No\n*Type*: [OnEnter](./aws-properties-iotevents-detectormodel-onenter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onenter", "UpdateType": "Mutable", "Required": false, "Type": "OnEnter" } } }, "AWS::IoTEvents::DetectorModel.TransitionEvent": { "MarkdownDocumentation": "`AWS::IoTEvents::DetectorModel.TransitionEvent`\n\nSpecifies the actions performed and the next state entered when a `condition`\nevaluates to TRUE.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nRequired. A Boolean expression that when TRUE causes the actions to be performed and the\n`nextState` to be entered.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-condition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions to be performed.\n*Required*: No\n*Type*: Array of [Action](./aws-properties-iotevents-detectormodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Action", "DuplicatesAllowed": true }, "NextState": { "MarkdownDocumentation": "`NextState`\n\nThe next state to enter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-nextstate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EventName": { "MarkdownDocumentation": "`EventName`\n\nThe name of the transition event.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-eventname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::Input.Attribute": { "MarkdownDocumentation": "`AWS::IoTEvents::Input.Attribute`\n\nThe attributes from the JSON payload that are made available by the input. Inputs are\nderived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such\nmessage contains a JSON payload. Those attributes (and their paired values) specified here are\navailable for use in the `condition` expressions used by detectors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html", "Properties": { "JsonPath": { "MarkdownDocumentation": "`JsonPath`\n\nAn expression that specifies an attribute-value pair in a JSON structure. Use this to\nspecify an attribute from the JSON payload that is made available by the input. Inputs are\nderived from messages sent to AWS IoT Events (`BatchPutMessage`). Each such message contains\na JSON payload. The attribute (and its paired value) specified here are available for use in\nthe `condition` expressions used by detectors.\nSyntax: `....`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((`[a-zA-Z0-9_\\- ]+`)|([a-zA-Z0-9_\\-]+))(\\.((`[a-zA-Z0-9_\\- ]+`)|([a-zA-Z0-9_\\-]+)))*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html#cfn-iotevents-input-attribute-jsonpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTEvents::Input.InputDefinition": { "MarkdownDocumentation": "`AWS::IoTEvents::Input.InputDefinition`\n\nThe definition of the input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.html", "Properties": { "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nThe attributes from the JSON payload that are made available by the input. Inputs are\nderived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such\nmessage contains a JSON payload, and those attributes (and their paired values) specified here\nare available for use in the `condition` expressions used by detectors that monitor\nthis input.\n*Required*: Yes\n*Type*: Array of [Attribute](./aws-properties-iotevents-input-attribute.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.html#cfn-iotevents-input-inputdefinition-attributes", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Attribute", "DuplicatesAllowed": false } } }, "AWS::IoTSiteWise::AccessPolicy.AccessPolicyIdentity": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AccessPolicy.AccessPolicyIdentity`\n\nThe identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy\napplies.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html", "Properties": { "User": { "MarkdownDocumentation": "`User`\n\nAn IAM Identity Center user identity.\n*Required*: No\n*Type*: [User](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-user", "UpdateType": "Mutable", "Required": false, "Type": "User" }, "IamUser": { "MarkdownDocumentation": "`IamUser`\n\nAn IAM user identity.\n*Required*: No\n*Type*: [IamUser](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-iamuser", "UpdateType": "Mutable", "Required": false, "Type": "IamUser" }, "IamRole": { "MarkdownDocumentation": "`IamRole`\n\nAn IAM role identity.\n*Required*: No\n*Type*: [IamRole](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-iamrole", "UpdateType": "Mutable", "Required": false, "Type": "IamRole" } } }, "AWS::IoTSiteWise::AccessPolicy.AccessPolicyResource": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AccessPolicy.AccessPolicyResource`\n\nThe AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html", "Properties": { "Project": { "MarkdownDocumentation": "`Project`\n\nIdentifies a specific AWS IoT SiteWise Monitor project.\n*Required*: No\n*Type*: [Project](./aws-properties-iotsitewise-accesspolicy-project.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-project", "UpdateType": "Mutable", "Required": false, "Type": "Project" }, "Portal": { "MarkdownDocumentation": "`Portal`\n\nIdentifies an AWS IoT SiteWise Monitor portal.\n*Required*: No\n*Type*: [Portal](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-portal", "UpdateType": "Mutable", "Required": false, "Type": "Portal" } } }, "AWS::IoTSiteWise::AccessPolicy.IamRole": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AccessPolicy.IamRole`\n\nContains information about an AWS Identity and Access Management role. For more information, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the\n*IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html", "Properties": { "arn": { "MarkdownDocumentation": "`arn`\n\nThe ARN of the IAM role. For more information, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html#cfn-iotsitewise-accesspolicy-iamrole-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AccessPolicy.IamUser": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AccessPolicy.IamUser`\n\nContains information about an AWS Identity and Access Management user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html", "Properties": { "arn": { "MarkdownDocumentation": "`arn`\n\nThe ARN of the IAM user. For more information, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the\n*IAM User Guide*.\n###### Note\nIf you delete the IAM user, access policies that contain this identity include an\nempty `arn`. You can delete the access policy for the IAM user that no longer\nexists.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html#cfn-iotsitewise-accesspolicy-iamuser-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AccessPolicy.Portal": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AccessPolicy.Portal`\n\nIdentifies an AWS IoT SiteWise Monitor portal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html", "Properties": { "id": { "MarkdownDocumentation": "`id`\n\nThe ID of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html#cfn-iotsitewise-accesspolicy-portal-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AccessPolicy.Project": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AccessPolicy.Project`\n\nIdentifies a specific AWS IoT SiteWise Monitor project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-project.html", "Properties": { "id": { "MarkdownDocumentation": "`id`\n\nThe ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-project.html#cfn-iotsitewise-accesspolicy-project-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AccessPolicy.User": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AccessPolicy.User`\n\nContains information for a user identity in an access policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html", "Properties": { "id": { "MarkdownDocumentation": "`id`\n\nThe IAM Identity Center 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html#cfn-iotsitewise-accesspolicy-user-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::Asset.AssetHierarchy": { "MarkdownDocumentation": "`AWS::IoTSiteWise::Asset.AssetHierarchy`\n\nDescribes an asset hierarchy that contains a hierarchy's name and ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html", "Properties": { "LogicalId": { "MarkdownDocumentation": "`LogicalId`\n\nThe ID of the hierarchy. This ID is a `hierarchyId`.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\u0000-\\u001F\\u007F]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-logicalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID of the hierarchy, if it has one. When you update an asset hierarchy, you\nmay assign an external ID if it doesn't already have one. You can't change the external ID of\nan asset hierarchy that already has one. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the hierarchy. This ID is a `hierarchyId`.\n###### Note\nThis is a return value and can't be set.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ChildAssetId": { "MarkdownDocumentation": "`ChildAssetId`\n\nThe Id of the child 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-childassetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::Asset.AssetProperty": { "MarkdownDocumentation": "`AWS::IoTSiteWise::Asset.AssetProperty`\n\nContains asset property information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html", "Properties": { "LogicalId": { "MarkdownDocumentation": "`LogicalId`\n\nThe `LogicalID` of the asset property.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\u0000-\\u001F\\u007F]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-logicalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nThe alias that identifies the property, such as an OPC-UA server data stream path (for\nexample, `/company/windfarm/3/turbine/7/temperature`). For more information,\nsee [Mapping industrial\ndata streams to asset properties](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the *AWS IoT SiteWise User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-alias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID of the property. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the asset property.\n###### Note\nThis is a return value and can't be set.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NotificationState": { "MarkdownDocumentation": "`NotificationState`\n\nThe MQTT notification state (enabled or disabled) for this asset property.\nWhen the notification state is enabled, AWS IoT SiteWise publishes property value\nupdates 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*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-notificationstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.AssetModelCompositeModel": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.AssetModelCompositeModel`\n\nContains information about a composite model in an asset model. This object contains the\nasset property definitions that you define in the composite model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe structured path to the property from the root of the asset using property names.\nPath is used as the ID if the asset model is a derived composite model.\n###### Note\nOne of `ExternalId` or `Path` must be specified.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-path", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ParentAssetModelCompositeModelExternalId": { "MarkdownDocumentation": "`ParentAssetModelCompositeModelExternalId`\n\nThe external ID of the parent composite model. For more information, see [Using external\nIDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-parentassetmodelcompositemodelexternalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the composite model. For alarm composite models, this type is\n`AWS/ALARM`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the composite model.\n###### Note\nIf the composite model is a `component-model-based` composite model,\nthe description is inherited from the `COMPONENT_MODEL` asset model and\ncannot be changed.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComposedAssetModelId": { "MarkdownDocumentation": "`ComposedAssetModelId`\n\nThe ID of a component model which is reused to create this composite 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-composedassetmodelid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID of a composite model on this asset model. For more information, see\n[Using external\nIDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n###### Note\nOne of `ExternalId` or `Path` must be specified.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CompositeModelProperties": { "MarkdownDocumentation": "`CompositeModelProperties`\n\nThe asset property definitions for this composite model.\n*Required*: No\n*Type*: Array of [AssetModelProperty](./aws-properties-iotsitewise-assetmodel-assetmodelproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-compositemodelproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AssetModelProperty", "DuplicatesAllowed": true }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the asset model composite model.\n###### Note\nThis is a return value and can't be set.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the composite 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.AssetModelHierarchy": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.AssetModelHierarchy`\n\nDescribes an asset hierarchy that contains a hierarchy's name, ID, and child asset model\nID that specifies the type of asset that can be in this hierarchy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html", "Properties": { "LogicalId": { "MarkdownDocumentation": "`LogicalId`\n\nThe `LogicalID` of the asset model hierarchy. This ID is a\n`hierarchyLogicalId`.\n###### Note\nOne of `ExternalId` or `LogicalId` must be specified.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\u0000-\\u001F\\u007F]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-logicalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID (if any) provided in the [CreateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or [UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) operation. You can assign an external ID by specifying\nthis value as part of a call to [UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html). However, you can't change the external ID if one is\nalready assigned. For more information, see [Using external\nIDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n###### Note\nOne of `ExternalId` or `LogicalId` must be specified.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the asset model hierarchy. This ID is a `hierarchyId`.\n###### Note\nThis is a return value and can't be set.\n\n* If you are callling [UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) to create a *new* hierarchy:\n You can specify its ID here, if desired. AWS IoT SiteWise automatically\n generates a unique ID for you, so this parameter is never required. However, if\n you prefer to supply your own ID instead, you can specify it here in UUID\n format. If you specify your own ID, it must be globally unique.\n* If you are calling UpdateAssetModel to modify an *existing*\n hierarchy: This can be either the actual ID in UUID format, or else\n `externalId:` followed by the external ID, if it has one. For\n more information, see [Referencing objects with external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the *AWS IoT SiteWise User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ChildAssetModelId": { "MarkdownDocumentation": "`ChildAssetModelId`\n\nThe ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the\n`childAssetModelId` asset model. AWS IoT SiteWise will always return the actual\nasset model ID for this value. However, when you are specifying this value as part of a call to\n[UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html), you may provide either the asset model ID or else `externalId:`\nfollowed by the asset model's external ID. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-childassetmodelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the asset model hierarchy that you specify by using the [CreateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or\n[UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.AssetModelProperty": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.AssetModelProperty`\n\nContains information about an asset model property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nContains a property type, which can be one of `attribute`,\n`measurement`, `metric`, or `transform`.\n*Required*: Yes\n*Type*: [PropertyType](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-type", "UpdateType": "Mutable", "Required": true, "Type": "PropertyType" }, "LogicalId": { "MarkdownDocumentation": "`LogicalId`\n\nThe `LogicalID` of the asset model property.\n###### Note\nOne of `ExternalId` or `LogicalId` must be specified.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\u0000-\\u001F\\u007F]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-logicalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID of the asset property. For more information, see [Using external\nIDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n###### Note\nOne of `ExternalId` or `LogicalId` must be specified.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-externalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataTypeSpec": { "MarkdownDocumentation": "`DataTypeSpec`\n\nThe data type of the structure for this property. This parameter exists on properties that\nhave the `STRUCT` data type.\n*Required*: No\n*Type*: String\n*Allowed values*: `AWS/ALARM_STATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS/ALARM_STATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatypespec", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe data type of the asset model property.\nIf you specify `STRUCT`, you must also specify `dataTypeSpec` to\nidentify the type of the structure for this property.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRING | INTEGER | DOUBLE |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the property.\n###### Note\nThis is a return value and can't be set.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit of the asset model property, such as `Newtons` or\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the asset model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.Attribute": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.Attribute`\n\nContains an asset attribute property. For more information, see\n[Attributes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes) in the *AWS IoT SiteWise User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-attribute.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe default value of the asset model property attribute. All assets that you create from\nthe asset model contain this attribute value. You can update an attribute's value after you\ncreate an asset. For more information, see [Updating attribute values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html) in the\n*AWS IoT SiteWise 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-attribute.html#cfn-iotsitewise-assetmodel-attribute-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.EnforcedAssetModelInterfacePropertyMapping": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.EnforcedAssetModelInterfacePropertyMapping`\n\nContains information about applied interface property and asset model property\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html", "Properties": { "InterfaceAssetModelPropertyExternalId": { "MarkdownDocumentation": "`InterfaceAssetModelPropertyExternalId`\n\nThe external ID of the applied interface 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping-interfaceassetmodelpropertyexternalid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AssetModelPropertyLogicalId": { "MarkdownDocumentation": "`AssetModelPropertyLogicalId`\n\nThe logical ID of the linked asset model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping-assetmodelpropertylogicalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssetModelPropertyExternalId": { "MarkdownDocumentation": "`AssetModelPropertyExternalId`\n\nThe external ID of the linked asset model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping-assetmodelpropertyexternalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.EnforcedAssetModelInterfaceRelationship": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.EnforcedAssetModelInterfaceRelationship`\n\nContains information about applied interface hierarchy and asset model\nhierarchy\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship.html", "Properties": { "InterfaceAssetModelId": { "MarkdownDocumentation": "`InterfaceAssetModelId`\n\nThe ID of the asset model that has the interface applied 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship-interfaceassetmodelid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyMappings": { "MarkdownDocumentation": "`PropertyMappings`\n\nA list of property mappings between the interface asset model and the asset model\nwhere the interface is applied.\n*Required*: No\n*Type*: Array of [EnforcedAssetModelInterfacePropertyMapping](./aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship-propertymappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnforcedAssetModelInterfacePropertyMapping", "DuplicatesAllowed": true } } }, "AWS::IoTSiteWise::AssetModel.ExpressionVariable": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.ExpressionVariable`\n\nContains expression variable information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-expressionvariable.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe variable that identifies an asset property from which to use values.\n*Required*: Yes\n*Type*: [VariableValue](./aws-properties-iotsitewise-assetmodel-variablevalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-expressionvariable.html#cfn-iotsitewise-assetmodel-expressionvariable-value", "UpdateType": "Mutable", "Required": true, "Type": "VariableValue" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe friendly name of the variable to be used in the expression.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-expressionvariable.html#cfn-iotsitewise-assetmodel-expressionvariable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.Metric": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.Metric`\n\nContains an asset metric property. With metrics, you can calculate aggregate functions,\nsuch as an average, maximum, or minimum, as specified through an expression. A metric maps\nseveral values to a single value (such as a sum).\nThe maximum number of dependent/cascading variables used in any one metric calculation is\n10. Therefore, a *root* metric can have\nup to 10 cascading metrics in its computational dependency\ntree. Additionally, a metric can only have a data type of `DOUBLE` and consume\nproperties with data types of `INTEGER` or `DOUBLE`.\nFor more information, see [Metrics](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) in the *AWS IoT SiteWise User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html", "Properties": { "Variables": { "MarkdownDocumentation": "`Variables`\n\nThe list of variables used in the expression.\n*Required*: Yes\n*Type*: Array of [ExpressionVariable](./aws-properties-iotsitewise-assetmodel-expressionvariable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-variables", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ExpressionVariable", "DuplicatesAllowed": true }, "Window": { "MarkdownDocumentation": "`Window`\n\nThe window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression.\nAWS IoT SiteWise computes one data point per `window`.\n*Required*: Yes\n*Type*: [MetricWindow](./aws-properties-iotsitewise-assetmodel-metricwindow.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-window", "UpdateType": "Mutable", "Required": true, "Type": "MetricWindow" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe mathematical expression that defines the metric aggregation function. You can specify\nup to 10 variables per expression. You can specify up to 10 functions\nper expression.\nFor more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.MetricWindow": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.MetricWindow`\n\nContains a time interval window used for data aggregate computations (for example,\naverage, sum, count, and so on).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metricwindow.html", "Properties": { "Tumbling": { "MarkdownDocumentation": "`Tumbling`\n\nThe tumbling time interval window.\n*Required*: No\n*Type*: [TumblingWindow](./aws-properties-iotsitewise-assetmodel-tumblingwindow.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metricwindow.html#cfn-iotsitewise-assetmodel-metricwindow-tumbling", "UpdateType": "Mutable", "Required": false, "Type": "TumblingWindow" } } }, "AWS::IoTSiteWise::AssetModel.PropertyPathDefinition": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.PropertyPathDefinition`\n\nRepresents one level between a composite model and the root of the asset model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertypathdefinition.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the path 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertypathdefinition.html#cfn-iotsitewise-assetmodel-propertypathdefinition-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.PropertyType": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.PropertyType`\n\nContains a property type, which can be one of `attribute`,\n`measurement`, `metric`, or `transform`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html", "Properties": { "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe type of property type, which can be one of `Attribute`,\n`Measurement`, `Metric`, or `Transform`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Measurement | Attribute | T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Measurement", "Attribute", "Transform", "Metric" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-typename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nSpecifies an asset attribute property. An attribute generally contains static information,\nsuch as the serial number of an [IIoT](https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind turbine.\n*Required*: No\n*Type*: [Attribute](./aws-properties-iotsitewise-assetmodel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-attribute", "UpdateType": "Mutable", "Required": false, "Type": "Attribute" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nSpecifies an asset metric property. A metric contains a mathematical expression that uses\naggregate functions to process all input data points over a time interval and output a single\ndata point, such as to calculate the average hourly temperature.\n*Required*: No\n*Type*: [Metric](./aws-properties-iotsitewise-assetmodel-metric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-metric", "UpdateType": "Mutable", "Required": false, "Type": "Metric" }, "Transform": { "MarkdownDocumentation": "`Transform`\n\nSpecifies an asset transform property. A transform contains a mathematical expression that\nmaps a property's data points from one form to another, such as a unit conversion from Celsius\nto Fahrenheit.\n*Required*: No\n*Type*: [Transform](./aws-properties-iotsitewise-assetmodel-transform.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-transform", "UpdateType": "Mutable", "Required": false, "Type": "Transform" } } }, "AWS::IoTSiteWise::AssetModel.Transform": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.Transform`\n\nContains an asset transform property. A transform is a one-to-one mapping of a property's\ndata points from one form to another. For example, you can use a transform to convert a\nCelsius data stream to Fahrenheit by applying the transformation expression to each data point\nof the Celsius stream. A transform can only have a data type of `DOUBLE` and\nconsume properties with data types of `INTEGER` or `DOUBLE`.\nFor more information, see [Transforms](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms) in the *AWS IoT SiteWise User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-transform.html", "Properties": { "Variables": { "MarkdownDocumentation": "`Variables`\n\nThe list of variables used in the expression.\n*Required*: Yes\n*Type*: Array of [ExpressionVariable](./aws-properties-iotsitewise-assetmodel-expressionvariable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-transform.html#cfn-iotsitewise-assetmodel-transform-variables", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ExpressionVariable", "DuplicatesAllowed": true }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe mathematical expression that defines the transformation function. You can specify up\nto 10 variables per expression. You can specify up to 10 functions per\nexpression.\nFor more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-transform.html#cfn-iotsitewise-assetmodel-transform-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.TumblingWindow": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.TumblingWindow`\n\nContains a tumbling window, which is a repeating fixed-sized, non-overlapping, and\ncontiguous time window. You can use this window in metrics to aggregate data from properties\nand other assets.\nYou can use `m`, `h`, `d`, and `w` when you\nspecify an interval or offset. Note that `m` represents minutes, `h`\nrepresents hours, `d` represents days, and `w` represents weeks. You can\nalso use `s` to represent seconds in `offset`.\nThe `interval` and `offset` parameters support the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example,\n`PT5S` represents 5 seconds, `PT5M` represents 5 minutes, and\n`PT5H` represents 5 hours.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-tumblingwindow.html", "Properties": { "Interval": { "MarkdownDocumentation": "`Interval`\n\nThe time interval for the tumbling window. The interval time must be between 1 minute and\n1 week.\nAWS IoT SiteWise computes the `1w` interval the end of Sunday at midnight each week (UTC),\nthe `1d` interval at the end of each day at midnight (UTC), the `1h`\ninterval at the end of each hour, and so on.\nWhen AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is\nexclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at\nthe end of the interval.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-tumblingwindow.html#cfn-iotsitewise-assetmodel-tumblingwindow-interval", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Offset": { "MarkdownDocumentation": "`Offset`\n\nThe offset for the tumbling window. The `offset` parameter accepts the\nfollowing:\n* The offset time.\n \n For example, if you specify `18h` for `offset` and\n `1d` for `interval`, AWS IoT SiteWise aggregates data in one of the following\n ways:\n \n + If you create the metric before or at 6 PM (UTC), you get the first aggregation\n result at 6 PM (UTC) on the day when you create the metric.\n + If you create the metric after 6 PM (UTC), you get the first aggregation result at\n 6 PM (UTC) the next day.\n* The ISO 8601 format.\n \n For example, if you specify `PT18H` for `offset` and\n `1d` for `interval`, AWS IoT SiteWise aggregates data in one of the following\n ways:\n \n + If you create the metric before or at 6 PM (UTC), you get the first aggregation\n result at 6 PM (UTC) on the day when you create the metric.\n + If you create the metric after 6 PM (UTC), you get the first aggregation result at\n 6 PM (UTC) the next day.\n* The 24-hour clock.\n \n For example, if you specify `00:03:00` for `offset`,\n `5m` for `interval`, and you create the metric at 2 PM (UTC), you\n get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result\n at 2:08 PM (UTC).\n* The offset time zone.\n \n For example, if you specify `2021-07-23T18:00-08` for `offset`\n and `1d` for `interval`, AWS IoT SiteWise aggregates data in one of the\n following ways:\n \n + If you create the metric before or at 6 PM (PST), you get the first aggregation\n result at 6 PM (PST) on the day when you create the metric.\n + If you create the metric after 6 PM (PST), you get the first aggregation result at\n 6 PM (PST) the next day.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-tumblingwindow.html#cfn-iotsitewise-assetmodel-tumblingwindow-offset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::AssetModel.VariableValue": { "MarkdownDocumentation": "`AWS::IoTSiteWise::AssetModel.VariableValue`\n\nIdentifies a property value used in an expression.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html", "Properties": { "PropertyExternalId": { "MarkdownDocumentation": "`PropertyExternalId`\n\nThe external ID of the property being referenced. For more information, see [Using external\nIDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyexternalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe ID of the hierarchy to query for the property ID. You can use the hierarchy's name\ninstead of the hierarchy's ID. If the hierarchy has an external ID, you can specify\n`externalId:` followed by the external ID. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\nYou use a hierarchy ID instead of a model ID because you can have several hierarchies\nusing the same model and therefore the same `propertyId`. For example, you might\nhave separately grouped assets that come from the same asset model. For more information, see\n[Asset hierarchies](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the *AWS IoT SiteWise User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyLogicalId": { "MarkdownDocumentation": "`PropertyLogicalId`\n\nThe `LogicalID` of the property that is being referenced.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\u0000-\\u001F\\u007F]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertylogicalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HierarchyLogicalId": { "MarkdownDocumentation": "`HierarchyLogicalId`\n\nThe `LogicalID` of the hierarchy to query for the\n`PropertyLogicalID`.\nYou use a `hierarchyLogicalID` instead of a model ID because you can have\nseveral hierarchies using the same model and therefore the same property. For example,\nyou might have separately grouped assets that come from the same asset model. For more\ninformation, see [Defining relationships\nbetween asset models (hierarchies)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the *AWS IoT SiteWise User\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[^\\u0000-\\u001F\\u007F]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchylogicalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyPath": { "MarkdownDocumentation": "`PropertyPath`\n\nThe path of the property. Each step of the path is the name of the step. See the\nfollowing example:\n```\nPropertyPath:\n Name: AssetModelName\n Name: Composite1\n Name: NestedComposite\n```\n*Required*: No\n*Type*: Array of [PropertyPathDefinition](./aws-properties-iotsitewise-assetmodel-propertypathdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertypath", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PropertyPathDefinition", "DuplicatesAllowed": true }, "HierarchyExternalId": { "MarkdownDocumentation": "`HierarchyExternalId`\n\nThe external ID of the hierarchy being referenced. For more information, see [Using external\nIDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyexternalid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyId": { "MarkdownDocumentation": "`PropertyId`\n\nThe ID of the property to use as the variable. You can use the property\n`name` if it's from the same asset model. If the property has an external\nID, you can specify `externalId:` followed by the external ID. For more\ninformation, see [Using external\nIDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide*.\n###### Note\nThis is a return value and can't be set.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::Gateway.GatewayCapabilitySummary": { "MarkdownDocumentation": "`AWS::IoTSiteWise::Gateway.GatewayCapabilitySummary`\n\nContains a summary of a gateway capability configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html", "Properties": { "CapabilityNamespace": { "MarkdownDocumentation": "`CapabilityNamespace`\n\nThe namespace of the capability configuration.\nFor example, if you configure OPC UA\nsources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace\n`iotsitewise:opcuacollector:3`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html#cfn-iotsitewise-gateway-gatewaycapabilitysummary-capabilitynamespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CapabilityConfiguration": { "MarkdownDocumentation": "`CapabilityConfiguration`\n\nThe JSON document that defines the configuration for the gateway capability. For more\ninformation, see [Configuring data sources (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) in the *AWS IoT SiteWise 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html#cfn-iotsitewise-gateway-gatewaycapabilitysummary-capabilityconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::Gateway.GatewayPlatform": { "MarkdownDocumentation": "`AWS::IoTSiteWise::Gateway.GatewayPlatform`\n\nThe gateway's platform configuration. You can only specify one platform type in a\ngateway.\n(Legacy only) For Greengrass V1 gateways, specify the `greengrass` parameter\nwith a valid Greengrass group ARN.\nFor Greengrass V2 gateways, specify the `greengrassV2` parameter with a valid\ncore device thing name. If creating a V3 gateway (`gatewayVersion=3`), you must\nalso specify the `coreDeviceOperatingSystem`.\nFor Siemens Industrial Edge gateways, specify the `siemensIE` parameter with a\nvalid IoT Core thing name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html", "Properties": { "GreengrassV2": { "MarkdownDocumentation": "`GreengrassV2`\n\nA gateway that runs on AWS IoT Greengrass V2.\n*Required*: No\n*Type*: [GreengrassV2](./aws-properties-iotsitewise-gateway-greengrassv2.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-greengrassv2", "UpdateType": "Immutable", "Required": false, "Type": "GreengrassV2" }, "SiemensIE": { "MarkdownDocumentation": "`SiemensIE`\n\nAn AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge\nDevice.\n*Required*: No\n*Type*: [SiemensIE](./aws-properties-iotsitewise-gateway-siemensie.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-siemensie", "UpdateType": "Immutable", "Required": false, "Type": "SiemensIE" } } }, "AWS::IoTSiteWise::Gateway.GreengrassV2": { "MarkdownDocumentation": "`AWS::IoTSiteWise::Gateway.GreengrassV2`\n\nContains details for a gateway that runs on AWS IoT Greengrass V2. To create a gateway that runs on AWS IoT Greengrass V2,\nyou must deploy the IoT SiteWise Edge component to your gateway device. Your [Greengrass\ndevice role](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html) must use the `AWSIoTSiteWiseEdgeAccess` policy. For more\ninformation, see [Using AWS IoT SiteWise at the edge](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html) in the\n*AWS IoT SiteWise User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.html", "Properties": { "CoreDeviceThingName": { "MarkdownDocumentation": "`CoreDeviceThingName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.html#cfn-iotsitewise-gateway-greengrassv2-coredevicethingname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CoreDeviceOperatingSystem": { "MarkdownDocumentation": "`CoreDeviceOperatingSystem`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINUX_AARCH64 | LINUX_AMD64...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "LINUX_AARCH64", "LINUX_AMD64", "WINDOWS_AMD64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.html#cfn-iotsitewise-gateway-greengrassv2-coredeviceoperatingsystem", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::Gateway.SiemensIE": { "MarkdownDocumentation": "`AWS::IoTSiteWise::Gateway.SiemensIE`\n\nContains details for a AWS IoT SiteWise Edge gateway that runs on a Siemens\nIndustrial Edge Device.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-siemensie.html", "Properties": { "IotCoreThingName": { "MarkdownDocumentation": "`IotCoreThingName`\n\nThe name of the AWS IoT Thing for your AWS IoT SiteWise Edge\ngateway.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-siemensie.html#cfn-iotsitewise-gateway-siemensie-iotcorethingname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::Portal.Alarms": { "MarkdownDocumentation": "`AWS::IoTSiteWise::Portal.Alarms`\n\nContains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.\nYou can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.\nFor 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html", "Properties": { "NotificationLambdaArn": { "MarkdownDocumentation": "`NotificationLambdaArn`\n\nThe [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Lambda function that manages alarm notifications. For more\ninformation, see [Managing alarm\nnotifications](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) in the *AWS IoT Events 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html#cfn-iotsitewise-portal-alarms-notificationlambdaarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AlarmRoleArn": { "MarkdownDocumentation": "`AlarmRoleArn`\n\nThe [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the IAM role that allows the alarm to perform actions and access AWS\nresources and services, such as AWS IoT 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html#cfn-iotsitewise-portal-alarms-alarmrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::IoTSiteWise::Portal.PortalTypeEntry": { "MarkdownDocumentation": "`AWS::IoTSiteWise::Portal.PortalTypeEntry`\n\nThe `PortalTypeEntry` property type specifies Property description not available. for an [AWS::IoTSiteWise::Portal](./aws-resource-iotsitewise-portal.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-portaltypeentry.html", "Properties": { "PortalTools": { "MarkdownDocumentation": "`PortalTools`\n\nThe array of tools associated with the specified portal type. The possible values are\n`ASSISTANT` and `DASHBOARD`.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-portaltypeentry.html#cfn-iotsitewise-portal-portaltypeentry-portaltools", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::KafkaConnect::Connector.ApacheKafkaCluster": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.ApacheKafkaCluster`\n\nThe details of the Apache Kafka cluster to which the connector is connected.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-apachekafkacluster.html", "Properties": { "Vpc": { "MarkdownDocumentation": "`Vpc`\n\nDetails of an Amazon VPC which has network connectivity to the Apache Kafka\ncluster.\n*Required*: Yes\n*Type*: [Vpc](./aws-properties-kafkaconnect-connector-vpc.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-apachekafkacluster.html#cfn-kafkaconnect-connector-apachekafkacluster-vpc", "UpdateType": "Immutable", "Required": true, "Type": "Vpc" }, "BootstrapServers": { "MarkdownDocumentation": "`BootstrapServers`\n\nThe bootstrap servers 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-apachekafkacluster.html#cfn-kafkaconnect-connector-apachekafkacluster-bootstrapservers", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KafkaConnect::Connector.AutoScaling": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.AutoScaling`\n\nSpecifies how the connector scales.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html", "Properties": { "ScaleOutPolicy": { "MarkdownDocumentation": "`ScaleOutPolicy`\n\nThe sacle-out policy for the connector.\n*Required*: Yes\n*Type*: [ScaleOutPolicy](./aws-properties-kafkaconnect-connector-scaleoutpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-scaleoutpolicy", "UpdateType": "Mutable", "Required": true, "Type": "ScaleOutPolicy" }, "ScaleInPolicy": { "MarkdownDocumentation": "`ScaleInPolicy`\n\nThe sacle-in policy for the connector.\n*Required*: Yes\n*Type*: [ScaleInPolicy](./aws-properties-kafkaconnect-connector-scaleinpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-scaleinpolicy", "UpdateType": "Mutable", "Required": true, "Type": "ScaleInPolicy" }, "MaxWorkerCount": { "MarkdownDocumentation": "`MaxWorkerCount`\n\nThe maximum number of workers allocated to the connector.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-maxworkercount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "MinWorkerCount": { "MarkdownDocumentation": "`MinWorkerCount`\n\nThe minimum number of workers allocated to the connector.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-minworkercount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "McuCount": { "MarkdownDocumentation": "`McuCount`\n\nThe number of microcontroller units (MCUs) allocated to each connector worker. The valid\nvalues are 1,2,4,8.\n*Required*: Yes\n*Type*: Integer\n*Allowed values*: `1 | 2 | 4 | 8...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "1", "2", "4", "8" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-mcucount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::KafkaConnect::Connector.Capacity": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.Capacity`\n\nInformation about the capacity of the connector, whether it is auto scaled or\nprovisioned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-capacity.html", "Properties": { "ProvisionedCapacity": { "MarkdownDocumentation": "`ProvisionedCapacity`\n\nDetails about a fixed capacity allocated to a connector.\n*Required*: No\n*Type*: [ProvisionedCapacity](./aws-properties-kafkaconnect-connector-provisionedcapacity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-capacity.html#cfn-kafkaconnect-connector-capacity-provisionedcapacity", "UpdateType": "Mutable", "Required": false, "Type": "ProvisionedCapacity" }, "AutoScaling": { "MarkdownDocumentation": "`AutoScaling`\n\nInformation about the auto scaling parameters for the connector.\n*Required*: No\n*Type*: [AutoScaling](./aws-properties-kafkaconnect-connector-autoscaling.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-capacity.html#cfn-kafkaconnect-connector-capacity-autoscaling", "UpdateType": "Mutable", "Required": false, "Type": "AutoScaling" } } }, "AWS::KafkaConnect::Connector.CloudWatchLogsLogDelivery": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.CloudWatchLogsLogDelivery`\n\nThe settings for delivering connector logs to Amazon CloudWatch Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-cloudwatchlogslogdelivery.html", "Properties": { "LogGroup": { "MarkdownDocumentation": "`LogGroup`\n\nThe name of the CloudWatch log group that is the destination for log delivery.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-cloudwatchlogslogdelivery.html#cfn-kafkaconnect-connector-cloudwatchlogslogdelivery-loggroup", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhether log delivery to Amazon CloudWatch Logs is enabled.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-cloudwatchlogslogdelivery.html#cfn-kafkaconnect-connector-cloudwatchlogslogdelivery-enabled", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::KafkaConnect::Connector.CustomPlugin": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.CustomPlugin`\n\nA plugin is an AWS resource that contains the code that defines a connector's logic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-customplugin.html", "Properties": { "CustomPluginArn": { "MarkdownDocumentation": "`CustomPluginArn`\n\nThe Amazon Resource Name (ARN) of the custom plugin.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-customplugin.html#cfn-kafkaconnect-connector-customplugin-custompluginarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Revision": { "MarkdownDocumentation": "`Revision`\n\nThe revision of the custom plugin.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-customplugin.html#cfn-kafkaconnect-connector-customplugin-revision", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Long" } } }, "AWS::KafkaConnect::Connector.FirehoseLogDelivery": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.FirehoseLogDelivery`\n\nThe settings for delivering logs to Amazon Kinesis Data Firehose.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-firehoselogdelivery.html", "Properties": { "DeliveryStream": { "MarkdownDocumentation": "`DeliveryStream`\n\nThe name of the Kinesis Data Firehose delivery stream that is the destination for log\ndelivery.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-firehoselogdelivery.html#cfn-kafkaconnect-connector-firehoselogdelivery-deliverystream", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether connector logs get delivered to Amazon Kinesis Data Firehose.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-firehoselogdelivery.html#cfn-kafkaconnect-connector-firehoselogdelivery-enabled", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::KafkaConnect::Connector.KafkaCluster": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.KafkaCluster`\n\nThe details of the Apache Kafka cluster to which the connector is connected.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkacluster.html", "Properties": { "ApacheKafkaCluster": { "MarkdownDocumentation": "`ApacheKafkaCluster`\n\nThe Apache Kafka cluster to which the connector is connected.\n*Required*: Yes\n*Type*: [ApacheKafkaCluster](./aws-properties-kafkaconnect-connector-apachekafkacluster.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkacluster.html#cfn-kafkaconnect-connector-kafkacluster-apachekafkacluster", "UpdateType": "Immutable", "Required": true, "Type": "ApacheKafkaCluster" } } }, "AWS::KafkaConnect::Connector.KafkaClusterClientAuthentication": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.KafkaClusterClientAuthentication`\n\nThe client authentication information used in order to authenticate with the Apache\nKafka cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterclientauthentication.html", "Properties": { "AuthenticationType": { "MarkdownDocumentation": "`AuthenticationType`\n\nThe type of client authentication used to connect to the Apache Kafka cluster. Value\nNONE means that no client authentication is used.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | IAM`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "NONE", "IAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterclientauthentication.html#cfn-kafkaconnect-connector-kafkaclusterclientauthentication-authenticationtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KafkaConnect::Connector.KafkaClusterEncryptionInTransit": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.KafkaClusterEncryptionInTransit`\n\nDetails of encryption in transit to the Apache Kafka cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterencryptionintransit.html", "Properties": { "EncryptionType": { "MarkdownDocumentation": "`EncryptionType`\n\nThe type of encryption in transit to the Apache Kafka cluster.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PLAINTEXT | TLS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PLAINTEXT", "TLS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterencryptionintransit.html#cfn-kafkaconnect-connector-kafkaclusterencryptionintransit-encryptiontype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KafkaConnect::Connector.LogDelivery": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.LogDelivery`\n\nDetails about log delivery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-logdelivery.html", "Properties": { "WorkerLogDelivery": { "MarkdownDocumentation": "`WorkerLogDelivery`\n\nThe workers can send worker logs to different destination types. This configuration\nspecifies the details of these destinations.\n*Required*: Yes\n*Type*: [WorkerLogDelivery](./aws-properties-kafkaconnect-connector-workerlogdelivery.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-logdelivery.html#cfn-kafkaconnect-connector-logdelivery-workerlogdelivery", "UpdateType": "Immutable", "Required": true, "Type": "WorkerLogDelivery" } } }, "AWS::KafkaConnect::Connector.Plugin": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.Plugin`\n\nA plugin is an AWS resource that contains the code that defines your connector logic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html", "Properties": { "CustomPlugin": { "MarkdownDocumentation": "`CustomPlugin`\n\nDetails about a custom plugin.\n*Required*: Yes\n*Type*: [CustomPlugin](./aws-properties-kafkaconnect-connector-customplugin.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html#cfn-kafkaconnect-connector-plugin-customplugin", "UpdateType": "Immutable", "Required": true, "Type": "CustomPlugin" } } }, "AWS::KafkaConnect::Connector.ProvisionedCapacity": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.ProvisionedCapacity`\n\nDetails about a connector's provisioned capacity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-provisionedcapacity.html", "Properties": { "WorkerCount": { "MarkdownDocumentation": "`WorkerCount`\n\nThe number of workers that are allocated to the connector.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-provisionedcapacity.html#cfn-kafkaconnect-connector-provisionedcapacity-workercount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "McuCount": { "MarkdownDocumentation": "`McuCount`\n\nThe number of microcontroller units (MCUs) allocated to each connector worker. The valid\nvalues are 1,2,4,8.\n*Required*: No\n*Type*: Integer\n*Allowed values*: `1 | 2 | 4 | 8...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "1", "2", "4", "8" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-provisionedcapacity.html#cfn-kafkaconnect-connector-provisionedcapacity-mcucount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KafkaConnect::Connector.S3LogDelivery": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.S3LogDelivery`\n\nDetails about delivering logs to Amazon S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the S3 bucket that is the destination for log delivery.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.html#cfn-kafkaconnect-connector-s3logdelivery-bucket", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether connector logs get sent to the specified Amazon S3 destination.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.html#cfn-kafkaconnect-connector-s3logdelivery-enabled", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe S3 prefix that is the destination for log delivery.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.html#cfn-kafkaconnect-connector-s3logdelivery-prefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KafkaConnect::Connector.ScaleInPolicy": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.ScaleInPolicy`\n\nThe scale-in policy for the connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-scaleinpolicy.html", "Properties": { "CpuUtilizationPercentage": { "MarkdownDocumentation": "`CpuUtilizationPercentage`\n\nSpecifies the CPU utilization percentage threshold at which you want connector scale in\nto be triggered.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-scaleinpolicy.html#cfn-kafkaconnect-connector-scaleinpolicy-cpuutilizationpercentage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::KafkaConnect::Connector.ScaleOutPolicy": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.ScaleOutPolicy`\n\nThe scale-out policy for the connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-scaleoutpolicy.html", "Properties": { "CpuUtilizationPercentage": { "MarkdownDocumentation": "`CpuUtilizationPercentage`\n\nThe CPU utilization percentage threshold at which you want connector scale out to be\ntriggered.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-scaleoutpolicy.html#cfn-kafkaconnect-connector-scaleoutpolicy-cpuutilizationpercentage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::KafkaConnect::Connector.Vpc": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.Vpc`\n\nInformation about the VPC in which the connector resides.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-vpc.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security group IDs for the connector.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-vpc.html#cfn-kafkaconnect-connector-vpc-securitygroups", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe subnets for the connector.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-vpc.html#cfn-kafkaconnect-connector-vpc-subnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::KafkaConnect::Connector.WorkerConfiguration": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.WorkerConfiguration`\n\nThe configuration of the workers, which are the processes that run the connector\nlogic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerconfiguration.html", "Properties": { "Revision": { "MarkdownDocumentation": "`Revision`\n\nThe revision of the worker configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerconfiguration.html#cfn-kafkaconnect-connector-workerconfiguration-revision", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Long" }, "WorkerConfigurationArn": { "MarkdownDocumentation": "`WorkerConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the worker configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerconfiguration.html#cfn-kafkaconnect-connector-workerconfiguration-workerconfigurationarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KafkaConnect::Connector.WorkerLogDelivery": { "MarkdownDocumentation": "`AWS::KafkaConnect::Connector.WorkerLogDelivery`\n\nWorkers can send worker logs to different destination types. This configuration\nspecifies the details of these destinations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerlogdelivery.html", "Properties": { "S3": { "MarkdownDocumentation": "`S3`\n\nDetails about delivering logs to Amazon S3.\n*Required*: No\n*Type*: [S3LogDelivery](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerlogdelivery.html#cfn-kafkaconnect-connector-workerlogdelivery-s3", "UpdateType": "Immutable", "Required": false, "Type": "S3LogDelivery" }, "Firehose": { "MarkdownDocumentation": "`Firehose`\n\nDetails about delivering logs to Amazon Kinesis Data Firehose.\n*Required*: No\n*Type*: [FirehoseLogDelivery](./aws-properties-kafkaconnect-connector-firehoselogdelivery.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerlogdelivery.html#cfn-kafkaconnect-connector-workerlogdelivery-firehose", "UpdateType": "Immutable", "Required": false, "Type": "FirehoseLogDelivery" }, "CloudWatchLogs": { "MarkdownDocumentation": "`CloudWatchLogs`\n\nDetails about delivering logs to Amazon CloudWatch Logs.\n*Required*: No\n*Type*: [CloudWatchLogsLogDelivery](./aws-properties-kafkaconnect-connector-cloudwatchlogslogdelivery.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerlogdelivery.html#cfn-kafkaconnect-connector-workerlogdelivery-cloudwatchlogs", "UpdateType": "Immutable", "Required": false, "Type": "CloudWatchLogsLogDelivery" } } }, "AWS::KafkaConnect::CustomPlugin.CustomPluginFileDescription": { "MarkdownDocumentation": "`AWS::KafkaConnect::CustomPlugin.CustomPluginFileDescription`\n\nDetails about a custom plugin file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginfiledescription.html", "Properties": { "FileMd5": { "MarkdownDocumentation": "`FileMd5`\n\nThe hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the\nfile.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginfiledescription.html#cfn-kafkaconnect-customplugin-custompluginfiledescription-filemd5", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileSize": { "MarkdownDocumentation": "`FileSize`\n\nThe size in bytes of the custom plugin file. You can use it to validate the file.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginfiledescription.html#cfn-kafkaconnect-customplugin-custompluginfiledescription-filesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" } } }, "AWS::KafkaConnect::CustomPlugin.CustomPluginLocation": { "MarkdownDocumentation": "`AWS::KafkaConnect::CustomPlugin.CustomPluginLocation`\n\nInformation about the location of a custom plugin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginlocation.html", "Properties": { "S3Location": { "MarkdownDocumentation": "`S3Location`\n\nThe S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin\nfile stored in Amazon S3.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-kafkaconnect-customplugin-s3location.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginlocation.html#cfn-kafkaconnect-customplugin-custompluginlocation-s3location", "UpdateType": "Immutable", "Required": true, "Type": "S3Location" } } }, "AWS::KafkaConnect::CustomPlugin.S3Location": { "MarkdownDocumentation": "`AWS::KafkaConnect::CustomPlugin.S3Location`\n\nThe location of an object in Amazon S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.html", "Properties": { "BucketArn": { "MarkdownDocumentation": "`BucketArn`\n\nThe Amazon Resource Name (ARN) of an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.html#cfn-kafkaconnect-customplugin-s3location-bucketarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FileKey": { "MarkdownDocumentation": "`FileKey`\n\nThe file key for an object in an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.html#cfn-kafkaconnect-customplugin-s3location-filekey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ObjectVersion": { "MarkdownDocumentation": "`ObjectVersion`\n\nThe version of an object in an S3 bucket.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.html#cfn-kafkaconnect-customplugin-s3location-objectversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Kendra::DataSource.CustomDocumentEnrichmentConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::DataSource.CustomDocumentEnrichmentConfiguration`\n\nProvides the configuration information for altering document metadata and content\nduring the document ingestion process.\nFor more information, see [Customizing document metadata\nduring the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html", "Properties": { "InlineConfigurations": { "MarkdownDocumentation": "`InlineConfigurations`\n\nConfiguration information to alter document attributes or metadata fields and content\nwhen ingesting documents into Amazon Kendra.\n*Required*: No\n*Type*: Array of [InlineCustomDocumentEnrichmentConfiguration](./aws-properties-kendra-datasource-inlinecustomdocumentenrichmentconfiguration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-inlineconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InlineCustomDocumentEnrichmentConfiguration", "DuplicatesAllowed": true }, "PreExtractionHookConfiguration": { "MarkdownDocumentation": "`PreExtractionHookConfiguration`\n\nConfiguration information for invoking a Lambda function in AWS Lambda on\nthe original or raw documents before extracting their metadata and text. You can use a\nLambda function to apply advanced logic for creating, modifying, or deleting document\nmetadata and content. For more information, see [Advanced data manipulation](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation).\n*Required*: No\n*Type*: [HookConfiguration](./aws-properties-kendra-datasource-hookconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-preextractionhookconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HookConfiguration" }, "PostExtractionHookConfiguration": { "MarkdownDocumentation": "`PostExtractionHookConfiguration`\n\nConfiguration information for invoking a Lambda function in AWS Lambda on\nthe structured documents with their metadata and text extracted. You can use a Lambda\nfunction to apply advanced logic for creating, modifying, or deleting document metadata\nand content. For more information, see [Advanced data manipulation](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation).\n*Required*: No\n*Type*: [HookConfiguration](./aws-properties-kendra-datasource-hookconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-postextractionhookconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HookConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role with permission to run\n`PreExtractionHookConfiguration` and\n`PostExtractionHookConfiguration` for altering document metadata and\ncontent during the document ingestion process. For more information, see [an IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).\n*Required*: No\n*Type*: String\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*Minimum*: `1`\n*Maximum*: `1284`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Kendra::DataSource.DataSourceConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::DataSource.DataSourceConfiguration`\n\nProvides the configuration information for an Amazon Kendra data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html", "Properties": { "TemplateConfiguration": { "MarkdownDocumentation": "`TemplateConfiguration`\n\nProvides a template for the configuration information to connect to your data\nsource.\n*Required*: No\n*Type*: [TemplateConfiguration](./aws-properties-kendra-datasource-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-templateconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TemplateConfiguration" } } }, "AWS::Kendra::DataSource.DocumentAttributeCondition": { "MarkdownDocumentation": "`AWS::Kendra::DataSource.DocumentAttributeCondition`\n\nThe condition used for the target document attribute or metadata field when ingesting\ndocuments into Amazon Kendra. You use this with [DocumentAttributeTarget to\napply the condition](https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html).\nFor example, you can create the 'Department' target field and have it prefill\ndepartment names associated with the documents based on information in the 'Source\\_URI'\nfield. Set the condition that if the 'Source\\_URI' field contains 'financial' in its URI\nvalue, then prefill the target field 'Department' with the target value 'Finance' for\nthe document.\nAmazon Kendra cannot create a target field if it has not already been created as\nan index field. After you create your index field, you can create a document metadata\nfield using `DocumentAttributeTarget`. Amazon Kendra then will map your\nnewly created metadata field to your index field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe condition operator.\nFor example, you can use 'Contains' to partially match a string.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GreaterThan | GreaterThanOr...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GreaterThan", "GreaterThanOrEquals", "LessThan", "LessThanOrEquals", "Equals", "NotEquals", "Contains", "NotContains", "Exists", "NotExists", "BeginsWith" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.html#cfn-kendra-datasource-documentattributecondition-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConditionDocumentAttributeKey": { "MarkdownDocumentation": "`ConditionDocumentAttributeKey`\n\nThe identifier of the document attribute used for the condition.\nFor example, 'Source\\_URI' could be an identifier for the attribute or metadata field\nthat contains source URIs associated with the documents.\nAmazon Kendra currently does not support `_document_body` as an\nattribute key used for the condition.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.html#cfn-kendra-datasource-documentattributecondition-conditiondocumentattributekey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConditionOnValue": { "MarkdownDocumentation": "`ConditionOnValue`\n\nThe value used by the operator.\nFor example, you can specify the value 'financial' for strings in the 'Source\\_URI'\nfield that partially match or contain this value.\n*Required*: No\n*Type*: [DocumentAttributeValue](./aws-properties-kendra-datasource-documentattributevalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.html#cfn-kendra-datasource-documentattributecondition-conditiononvalue", "UpdateType": "Mutable", "Required": false, "Type": "DocumentAttributeValue" } } }, "AWS::Kendra::DataSource.DocumentAttributeTarget": { "MarkdownDocumentation": "`AWS::Kendra::DataSource.DocumentAttributeTarget`\n\nThe target document attribute or metadata field you want to alter when ingesting\ndocuments into Amazon Kendra.\nFor example, you can delete customer identification numbers associated with the\ndocuments, stored in the document metadata field called 'Customer\\_ID'. You set the\ntarget key as 'Customer\\_ID' and the deletion flag to `TRUE`. This removes all\ncustomer ID values in the field 'Customer\\_ID'. This would scrub personally identifiable\ninformation from each document's metadata.\nAmazon Kendra cannot create a target field if it has not already been created as\nan index field. After you create your index field, you can create a document metadata\nfield using `DocumentAttributeTarget`. Amazon Kendra then will map your\nnewly created metadata field to your index field.\nYou can also use this with [DocumentAttributeCondition](https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html", "Properties": { "TargetDocumentAttributeKey": { "MarkdownDocumentation": "`TargetDocumentAttributeKey`\n\nThe identifier of the target document attribute or metadata field.\nFor example, 'Department' could be an identifier for the target attribute or metadata\nfield that includes the department names associated with the documents.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html#cfn-kendra-datasource-documentattributetarget-targetdocumentattributekey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetDocumentAttributeValueDeletion": { "MarkdownDocumentation": "`TargetDocumentAttributeValueDeletion`\n\n`TRUE` to delete the existing target value for your specified target\nattribute key. You cannot create a target value and set this to `TRUE`. To\ncreate a target value (`TargetDocumentAttributeValue`), set this to\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html#cfn-kendra-datasource-documentattributetarget-targetdocumentattributevaluedeletion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TargetDocumentAttributeValue": { "MarkdownDocumentation": "`TargetDocumentAttributeValue`\n\nThe target value you want to create for the target attribute.\nFor example, 'Finance' could be the target value for the target attribute key\n'Department'.\n*Required*: No\n*Type*: [DocumentAttributeValue](./aws-properties-kendra-datasource-documentattributevalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html#cfn-kendra-datasource-documentattributetarget-targetdocumentattributevalue", "UpdateType": "Mutable", "Required": false, "Type": "DocumentAttributeValue" } } }, "AWS::Kendra::DataSource.DocumentAttributeValue": { "MarkdownDocumentation": "`AWS::Kendra::DataSource.DocumentAttributeValue`\n\nThe value of a document attribute. You can only provide one value for a document\nattribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributevalue.html", "Properties": { "DateValue": { "MarkdownDocumentation": "`DateValue`\n\nA 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\nexample, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012\nat 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributevalue.html#cfn-kendra-datasource-documentattributevalue-datevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LongValue": { "MarkdownDocumentation": "`LongValue`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributevalue.html#cfn-kendra-datasource-documentattributevalue-longvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "StringValue": { "MarkdownDocumentation": "`StringValue`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributevalue.html#cfn-kendra-datasource-documentattributevalue-stringvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StringListValue": { "MarkdownDocumentation": "`StringListValue`\n\nA list of strings. The default maximum length or number of strings is 10.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributevalue.html#cfn-kendra-datasource-documentattributevalue-stringlistvalue", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Kendra::DataSource.HookConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::DataSource.HookConfiguration`\n\nProvides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into\nAmazon Kendra. You can configure your Lambda function using [PreExtractionHookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) if you want to apply advanced alterations on\nthe original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using\n[PostExtractionHookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html). You can only invoke one Lambda function.\nHowever, this function can invoke other functions it requires.\nFor more information, see [Customizing document metadata\nduring the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-hookconfiguration.html", "Properties": { "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nStores the original, raw documents or the structured, parsed documents before and\nafter altering them. For more information, see [Data contracts for Lambda functions](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-hookconfiguration.html#cfn-kendra-datasource-hookconfiguration-s3bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LambdaArn": { "MarkdownDocumentation": "`LambdaArn`\n\nThe Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function\nduring ingestion. For more information, see [an IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-hookconfiguration.html#cfn-kendra-datasource-hookconfiguration-lambdaarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InvocationCondition": { "MarkdownDocumentation": "`InvocationCondition`\n\nThe condition used for when a Lambda function should be invoked.\nFor example, you can specify a condition that if there are empty date-time values,\nthen Amazon Kendra should invoke a function that inserts the current\ndate-time.\n*Required*: No\n*Type*: [DocumentAttributeCondition](./aws-properties-kendra-datasource-documentattributecondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-hookconfiguration.html#cfn-kendra-datasource-hookconfiguration-invocationcondition", "UpdateType": "Mutable", "Required": false, "Type": "DocumentAttributeCondition" } } }, "AWS::Kendra::DataSource.InlineCustomDocumentEnrichmentConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::DataSource.InlineCustomDocumentEnrichmentConfiguration`\n\nProvides the configuration information for applying basic logic to alter document\nmetadata and content when ingesting documents into Amazon Kendra. To apply advanced\nlogic, to go beyond what you can do with basic logic, see [HookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html).\nFor more information, see [Customizing document metadata\nduring the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-inlinecustomdocumentenrichmentconfiguration.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nConfiguration of the condition used for the target document attribute or metadata\nfield when ingesting documents into Amazon Kendra.\n*Required*: No\n*Type*: [DocumentAttributeCondition](./aws-properties-kendra-datasource-documentattributecondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-inlinecustomdocumentenrichmentconfiguration.html#cfn-kendra-datasource-inlinecustomdocumentenrichmentconfiguration-condition", "UpdateType": "Mutable", "Required": false, "Type": "DocumentAttributeCondition" }, "Target": { "MarkdownDocumentation": "`Target`\n\nConfiguration of the target document attribute or metadata field when ingesting\ndocuments into Amazon Kendra. You can also include a value.\n*Required*: No\n*Type*: [DocumentAttributeTarget](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-inlinecustomdocumentenrichmentconfiguration.html#cfn-kendra-datasource-inlinecustomdocumentenrichmentconfiguration-target", "UpdateType": "Mutable", "Required": false, "Type": "DocumentAttributeTarget" }, "DocumentContentDeletion": { "MarkdownDocumentation": "`DocumentContentDeletion`\n\n`TRUE` to delete content if the condition used for the target attribute is\nmet.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-inlinecustomdocumentenrichmentconfiguration.html#cfn-kendra-datasource-inlinecustomdocumentenrichmentconfiguration-documentcontentdeletion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Kendra::DataSource.TemplateConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::DataSource.TemplateConfiguration`\n\nProvides a template for the configuration information to connect to your data\nsource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-templateconfiguration.html", "Properties": { "Template": { "MarkdownDocumentation": "`Template`\n\nThe template schema used for the data source, where templates schemas are\nsupported.\nSee [Data source\ntemplate schemas](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-templateconfiguration.html#cfn-kendra-datasource-templateconfiguration-template", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::Kendra::Faq.S3Path": { "MarkdownDocumentation": "`AWS::Kendra::Faq.S3Path`\n\nInformation required to find a specific file in an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-faq-s3path.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the S3 bucket that contains the file.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-faq-s3path.html#cfn-kendra-faq-s3path-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-faq-s3path.html#cfn-kendra-faq-s3path-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Kendra::Index.CapacityUnitsConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::Index.CapacityUnitsConfiguration`\n\nSpecifies additional capacity units configured for your Enterprise Edition index. You can\nadd and remove capacity units to fit your usage requirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html", "Properties": { "QueryCapacityUnits": { "MarkdownDocumentation": "`QueryCapacityUnits`\n\nThe amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html)\ncapacity.\nA single extra capacity unit for an index provides 0.1 queries per second or approximately\n8,000 queries per day. You can add up to 100 extra capacity units.\n`GetQuerySuggestions` capacity is five times the provisioned query capacity for\nan index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the\nbase capacity for an index is 0.1 queries per second, and `GetQuerySuggestions`\ncapacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to\ntotal 0.2 queries per second for an index, the `GetQuerySuggestions` capacity is\n2.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html#cfn-kendra-index-capacityunitsconfiguration-querycapacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "StorageCapacityUnits": { "MarkdownDocumentation": "`StorageCapacityUnits`\n\nThe amount of extra storage capacity for an index. A single capacity unit provides 30 GB\nof storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra\ncapacity 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html#cfn-kendra-index-capacityunitsconfiguration-storagecapacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Kendra::Index.DocumentMetadataConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::Index.DocumentMetadataConfiguration`\n\nSpecifies the properties, such as relevance tuning and searchability, of an index\nfield.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html", "Properties": { "Relevance": { "MarkdownDocumentation": "`Relevance`\n\nProvides tuning parameters to determine how the field affects the search\nresults.\n*Required*: No\n*Type*: [Relevance](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-relevance", "UpdateType": "Mutable", "Required": false, "Type": "Relevance" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe data type of the index field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRING_VALUE | STRING_LIST_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Search": { "MarkdownDocumentation": "`Search`\n\nProvides information about how the field is used during a search.\n*Required*: No\n*Type*: [Search](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-search", "UpdateType": "Mutable", "Required": false, "Type": "Search" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Kendra::Index.JsonTokenTypeConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::Index.JsonTokenTypeConfiguration`\n\nProvides the configuration information for the JSON token type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jsontokentypeconfiguration.html", "Properties": { "GroupAttributeField": { "MarkdownDocumentation": "`GroupAttributeField`\n\nThe group attribute field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jsontokentypeconfiguration.html#cfn-kendra-index-jsontokentypeconfiguration-groupattributefield", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UserNameAttributeField": { "MarkdownDocumentation": "`UserNameAttributeField`\n\nThe user name attribute field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jsontokentypeconfiguration.html#cfn-kendra-index-jsontokentypeconfiguration-usernameattributefield", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Kendra::Index.JwtTokenTypeConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::Index.JwtTokenTypeConfiguration`\n\nProvides the configuration information for the JWT token type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html", "Properties": { "ClaimRegex": { "MarkdownDocumentation": "`ClaimRegex`\n\nThe regular expression that identifies the claim.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-claimregex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nThe issuer of the token.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `65`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-issuer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KeyLocation": { "MarkdownDocumentation": "`KeyLocation`\n\nThe location of the key.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `URL | SECRET_MANAGER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "URL", "SECRET_MANAGER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-keylocation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretManagerArn": { "MarkdownDocumentation": "`SecretManagerArn`\n\nThe Amazon Resource Name (arn) of the secret.\n*Required*: No\n*Type*: String\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*Minimum*: `1`\n*Maximum*: `1284`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-secretmanagerarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupAttributeField": { "MarkdownDocumentation": "`GroupAttributeField`\n\nThe group attribute field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-groupattributefield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "URL": { "MarkdownDocumentation": "`URL`\n\nThe signing key URL.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https?|ftp|file):\\/\\/([^\\s]*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserNameAttributeField": { "MarkdownDocumentation": "`UserNameAttributeField`\n\nThe user name attribute field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-usernameattributefield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Kendra::Index.Relevance": { "MarkdownDocumentation": "`AWS::Kendra::Index.Relevance`\n\nProvides information for tuning the relevance of a field in a search. When a query\nincludes terms that match the field, the results are given a boost in the response based\non these tuning parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html", "Properties": { "Importance": { "MarkdownDocumentation": "`Importance`\n\nThe relative importance of the field in the search. Larger numbers provide more of a\nboost 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-importance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RankOrder": { "MarkdownDocumentation": "`RankOrder`\n\nDetermines how values should be interpreted.\nWhen the `RankOrder` field is `ASCENDING`, higher numbers are\nbetter. For example, a document with a rating score of 10 is higher ranking than a\ndocument with a rating score of 1.\nWhen the `RankOrder` field is `DESCENDING`, lower numbers are\nbetter. For example, in a task tracking application, a priority 1 task is more important\nthan a priority 5 task.\nOnly applies to `LONG` 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)", "RefReturnValue": "", "AllowedValues": [ "ASCENDING", "DESCENDING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-rankorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueImportanceItems": { "MarkdownDocumentation": "`ValueImportanceItems`\n\nAn array of key-value pairs for different boosts when they appear in the search result\nlist. For example, if you want to boost query terms that match the \"department\" field in\nthe result, query terms that match this field are boosted in the result. You can add\nentries 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\n\"HR\", 5 and \"Legal\",3 those departments are given special attention when they appear in\nthe metadata of a document.\n*Required*: No\n*Type*: Array of [ValueImportanceItem](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-valueimportanceitems", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ValueImportanceItem", "DuplicatesAllowed": true }, "Freshness": { "MarkdownDocumentation": "`Freshness`\n\nIndicates that this field determines how \"fresh\" a document is. For example, if\ndocument 1 was created on November 5, and document 2 was created on October 31, document\n1 is \"fresher\" than document 2. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-freshness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Duration": { "MarkdownDocumentation": "`Duration`\n\nSpecifies the time period that the boost applies to. For example, to make the boost\napply to documents with the field value within the last month, you would use \"2628000s\".\nOnce the field value is beyond the specified range, the effect of the boost drops off.\nThe higher the importance, the faster the effect drops off. If you don't specify a\nvalue, the default is 3 months. The value of the field is a numeric string followed by\nthe character \"s\", for example \"86400s\" for one day, or \"604800s\" for one week.\nOnly applies to `DATE` fields.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9]+[s]`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-duration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Kendra::Index.Search": { "MarkdownDocumentation": "`AWS::Kendra::Index.Search`\n\nProvides information about how a custom index field is used during a search.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html", "Properties": { "Displayable": { "MarkdownDocumentation": "`Displayable`\n\nDetermines whether the field is returned in the query response. The default is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-displayable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Sortable": { "MarkdownDocumentation": "`Sortable`\n\nDetermines whether the field can be used to sort the results of a query. The default\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-sortable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Facetable": { "MarkdownDocumentation": "`Facetable`\n\nIndicates that the field can be used to create search facets, a count of results for\neach 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-facetable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Searchable": { "MarkdownDocumentation": "`Searchable`\n\nDetermines whether the field is used in the search. If the `Searchable`\nfield is `true`, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is `true` for\nstring 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-searchable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Kendra::Index.ServerSideEncryptionConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::Index.ServerSideEncryptionConfiguration`\n\nProvides the identifier of the AWS KMS customer master key (CMK) used\nto encrypt data indexed by Amazon Kendra. We suggest that you use a CMK from your\naccount to help secure your index. Amazon Kendra doesn't support asymmetric CMKs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-serversideencryptionconfiguration.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe identifier of the AWS KMS key. Amazon Kendra doesn't support\nasymmetric 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-serversideencryptionconfiguration.html#cfn-kendra-index-serversideencryptionconfiguration-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Kendra::Index.UserTokenConfiguration": { "MarkdownDocumentation": "`AWS::Kendra::Index.UserTokenConfiguration`\n\nProvides the configuration information for a token.\n###### Important\nIf you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use\n`UserTokenConfigurations` to configure user context policy, Amazon Kendra returns\na `ValidationException` error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html", "Properties": { "JwtTokenTypeConfiguration": { "MarkdownDocumentation": "`JwtTokenTypeConfiguration`\n\nInformation about the JWT token type configuration.\n*Required*: No\n*Type*: [JwtTokenTypeConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html#cfn-kendra-index-usertokenconfiguration-jwttokentypeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "JwtTokenTypeConfiguration" }, "JsonTokenTypeConfiguration": { "MarkdownDocumentation": "`JsonTokenTypeConfiguration`\n\nInformation about the JSON token type configuration.\n*Required*: No\n*Type*: [JsonTokenTypeConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html#cfn-kendra-index-usertokenconfiguration-jsontokentypeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "JsonTokenTypeConfiguration" } } }, "AWS::Kendra::Index.ValueImportanceItem": { "MarkdownDocumentation": "`AWS::Kendra::Index.ValueImportanceItem`\n\nSpecifies a key-value pair of the search boost value for a document when the key is\npart of the metadata of a document.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe boost value for a document when the key is part of the metadata of a\ndocument.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html#cfn-kendra-index-valueimportanceitem-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe document metadata value used for the search boost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html#cfn-kendra-index-valueimportanceitem-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KendraRanking::ExecutionPlan.CapacityUnitsConfiguration": { "MarkdownDocumentation": "`AWS::KendraRanking::ExecutionPlan.CapacityUnitsConfiguration`\n\nSets additional capacity units configured for your\nrescore execution plan. A rescore execution plan is an\nAmazon Kendra Intelligent Ranking resource used for\nprovisioning the `Rescore` API. You can add and\nremove capacity units to fit your usage requirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendraranking-executionplan-capacityunitsconfiguration.html", "Properties": { "RescoreCapacityUnits": { "MarkdownDocumentation": "`RescoreCapacityUnits`\n\nThe amount of extra capacity for your rescore execution\nplan.\nA single extra capacity unit for a rescore execution\nplan provides 0.01 rescore requests per second. You can add\nup 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendraranking-executionplan-capacityunitsconfiguration.html#cfn-kendraranking-executionplan-capacityunitsconfiguration-rescorecapacityunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Kinesis::Stream.StreamEncryption": { "MarkdownDocumentation": "`AWS::Kinesis::Stream.StreamEncryption`\n\nEnables or updates server-side encryption using an AWS KMS key for a\nspecified stream.\n###### Note\nWhen invoking this API, you must use either the `StreamARN` or the\n`StreamName` parameter, or both. It is recommended that you use the\n`StreamARN` input parameter when you invoke this API.\nStarting encryption is an asynchronous operation. Upon receiving the request, Kinesis\nData Streams returns immediately and sets the status of the stream to\n`UPDATING`. After the update is complete, Kinesis Data Streams sets the\nstatus of the stream back to `ACTIVE`. Updating or applying encryption\nnormally takes a few seconds to complete, but it can take minutes. You can continue to\nread and write data to your stream while its status is `UPDATING`. Once the\nstatus of the stream is `ACTIVE`, encryption begins for records written to\nthe stream.\nAPI Limits: You can successfully apply a new AWS KMS key for\nserver-side encryption 25 times in a rolling 24-hour period.\nNote: It can take up to 5 seconds after the stream is in an `ACTIVE` status\nbefore all records written to the stream are encrypted. After you enable encryption, you\ncan verify that encryption is applied by inspecting the API response from\n`PutRecord` or `PutRecords`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html", "Properties": { "EncryptionType": { "MarkdownDocumentation": "`EncryptionType`\n\nThe encryption type to use. The only valid value is `KMS`.\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)\n", "RefReturnValue": "", "AllowedValues": [ "KMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html#cfn-kinesis-stream-streamencryption-encryptiontype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyId": { "MarkdownDocumentation": "`KeyId`\n\nThe GUID for the customer-managed AWS KMS key to use for encryption.\nThis value can be a globally unique identifier, a fully specified Amazon Resource Name\n(ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\nuse a master key owned by Kinesis Data Streams by specifying the alias\n`aws/kinesis`.\n* Key ARN example:\n `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`\n* Alias ARN example:\n `arn:aws:kms:us-east-1:123456789012:alias/MyAliasName`\n* Globally unique key ID example:\n `12345678-1234-1234-1234-123456789012`\n* Alias name example: `alias/MyAliasName`\n* Master key owned by Kinesis Data Streams:\n `alias/aws/kinesis`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html#cfn-kinesis-stream-streamencryption-keyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Kinesis::Stream.StreamModeDetails": { "MarkdownDocumentation": "`AWS::Kinesis::Stream.StreamModeDetails`\n\nSpecifies the capacity mode to which you want to set your data stream. Currently, in\nKinesis Data Streams, you can choose between an **on-demand** capacity mode and a **provisioned** capacity mode for your data streams.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streammodedetails.html", "Properties": { "StreamMode": { "MarkdownDocumentation": "`StreamMode`\n\nSpecifies the capacity mode to which you want to set your data stream. Currently, in\nKinesis Data Streams, you can choose between an **on-demand** capacity mode and a **provisioned** capacity mode for your data streams.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ON_DEMAND | PROVISIONED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ON_DEMAND", "PROVISIONED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streammodedetails.html#cfn-kinesis-stream-streammodedetails-streammode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Kinesis::Stream.WarmThroughputObject": { "MarkdownDocumentation": "`AWS::Kinesis::Stream.WarmThroughputObject`\n\nRepresents the warm throughput configuration on the stream. This is only present for On-Demand Kinesis Data Streams in accounts that have `MinimumThroughputBillingCommitment` enabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-warmthroughputobject.html", "Properties": { "CurrentMiBps": { "MarkdownDocumentation": "`CurrentMiBps`\n\nThe current warm throughput value on the stream. This is the write throughput in MiBps that the stream is currently scaled to handle.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-warmthroughputobject.html#cfn-kinesis-stream-warmthroughputobject-currentmibps", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetMiBps": { "MarkdownDocumentation": "`TargetMiBps`\n\nThe target warm throughput value on the stream. This indicates that the stream is currently scaling towards this target value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-warmthroughputobject.html#cfn-kinesis-stream-warmthroughputobject-targetmibps", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisAnalytics::Application.CSVMappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.CSVMappingParameters`\n\nProvides additional mapping information when the record format uses delimiters, such\nas CSV. For example, the following sample records use CSV format, where the records use\nthe *'\\n'* as the row delimiter and a comma (\",\") as the column\ndelimiter:\n`\"name1\", \"address1\"`\n`\"name2\", \"address2\"`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html", "Properties": { "RecordRowDelimiter": { "Required": true, "MarkdownDocumentation": "`RecordRowDelimiter`\n\nRow delimiter. For example, in a CSV format, *'\\n'* is the typical\nrow delimiter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordrowdelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RecordColumnDelimiter": { "Required": true, "MarkdownDocumentation": "`RecordColumnDelimiter`\n\nColumn delimiter. For example, in a CSV format, a comma (\",\") is the typical column\ndelimiter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordcolumndelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.Input": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.Input`\n\nWhen you configure the application input, you specify the streaming source, the\nin-application stream name that is created, and the mapping between the two. For more\ninformation, see [Configuring Application\nInput](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html", "Properties": { "NamePrefix": { "Required": true, "MarkdownDocumentation": "`NamePrefix`\n\nName prefix to use when creating an in-application stream. Suppose that you specify a\nprefix \"MyInApplicationStream.\" Amazon Kinesis Analytics then creates one or more (as\nper the `InputParallelism` count you specified) in-application streams with\nnames \"MyInApplicationStream\\_001,\" \"MyInApplicationStream\\_002,\" and so on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-nameprefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InputSchema": { "Type": "InputSchema", "Required": true, "MarkdownDocumentation": "`InputSchema`\n\nDescribes the format of the data in the streaming source, and how each data element\nmaps to corresponding columns in the in-application stream that is being created.\nAlso used to describe the format of the reference data source.\n*Required*: Yes\n*Type*: [InputSchema](./aws-properties-kinesisanalytics-application-inputschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputschema", "UpdateType": "Mutable" }, "KinesisStreamsInput": { "Type": "KinesisStreamsInput", "Required": false, "MarkdownDocumentation": "`KinesisStreamsInput`\n\nIf the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon\nResource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the\nstream on your behalf.\nNote: Either `KinesisStreamsInput` or `KinesisFirehoseInput` is\nrequired.\n*Required*: Conditional\n*Type*: [KinesisStreamsInput](./aws-properties-kinesisanalytics-application-kinesisstreamsinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisstreamsinput", "UpdateType": "Mutable" }, "KinesisFirehoseInput": { "Type": "KinesisFirehoseInput", "Required": false, "MarkdownDocumentation": "`KinesisFirehoseInput`\n\nIf the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the\ndelivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access\nthe stream on your behalf.\nNote: Either `KinesisStreamsInput` or `KinesisFirehoseInput` is\nrequired.\n*Required*: Conditional\n*Type*: [KinesisFirehoseInput](./aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisfirehoseinput", "UpdateType": "Mutable" }, "InputProcessingConfiguration": { "Type": "InputProcessingConfiguration", "Required": false, "MarkdownDocumentation": "`InputProcessingConfiguration`\n\nThe [InputProcessingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html) for the input. An input\nprocessor transforms records as they are received from the stream, before the\napplication's SQL code executes. Currently, the only input processing configuration\navailable is [InputLambdaProcessor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html).\n*Required*: No\n*Type*: [InputProcessingConfiguration](./aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputprocessingconfiguration", "UpdateType": "Mutable" }, "InputParallelism": { "Type": "InputParallelism", "Required": false, "MarkdownDocumentation": "`InputParallelism`\n\nDescribes the number of in-application streams to create.\nData from your source is routed to these in-application input streams.\nSee [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).\n*Required*: No\n*Type*: [InputParallelism](./aws-properties-kinesisanalytics-application-inputparallelism.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputparallelism", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.InputLambdaProcessor": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.InputLambdaProcessor`\n\nAn object that contains the Amazon Resource Name (ARN) of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that is used to preprocess records in the\nstream, and the ARN of the IAM role that is used to access the AWS Lambda\nfunction.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nThe ARN of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that operates on records in the\nstream.\n###### Note\nTo specify an earlier version of the Lambda function than the latest, include the\nLambda function version in the Lambda function ARN. For more information about\nLambda ARNs, see [Example\nARNs: AWS Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda)\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RoleARN": { "Required": true, "MarkdownDocumentation": "`RoleARN`\n\nThe ARN of the IAM role that is used to access the AWS Lambda\nfunction.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.InputParallelism": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.InputParallelism`\n\nDescribes the number of in-application streams to create for a given streaming source.\nFor information about parallelism, see [Configuring Application\nInput](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html", "Properties": { "Count": { "Required": false, "MarkdownDocumentation": "`Count`\n\nNumber of in-application streams to create. For more information, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html#cfn-kinesisanalytics-application-inputparallelism-count", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.InputProcessingConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.InputProcessingConfiguration`\n\nProvides a description of a processor that is used to preprocess the records in the\nstream before being processed by your application code. Currently, the only input\nprocessor available is [AWS Lambda](https://docs.aws.amazon.com/lambda/).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html", "Properties": { "InputLambdaProcessor": { "Type": "InputLambdaProcessor", "Required": false, "MarkdownDocumentation": "`InputLambdaProcessor`\n\nThe [InputLambdaProcessor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html) that is used to preprocess the records\nin the stream before being processed by your application code.\n*Required*: No\n*Type*: [InputLambdaProcessor](./aws-properties-kinesisanalytics-application-inputlambdaprocessor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html#cfn-kinesisanalytics-application-inputprocessingconfiguration-inputlambdaprocessor", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.InputSchema": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.InputSchema`\n\nDescribes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.\nAlso used to describe the format of the reference data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html", "Properties": { "RecordEncoding": { "Required": false, "MarkdownDocumentation": "`RecordEncoding`\n\nSpecifies the encoding of the records in the streaming source. For example, UTF-8.\n*Required*: No\n*Type*: String\n*Pattern*: `UTF-8`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordencoding", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RecordColumns": { "Type": "List", "Required": true, "MarkdownDocumentation": "`RecordColumns`\n\nA list of `RecordColumn` objects.\n*Required*: Yes\n*Type*: Array of [RecordColumn](./aws-properties-kinesisanalytics-application-recordcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordcolumns", "ItemType": "RecordColumn", "UpdateType": "Mutable" }, "RecordFormat": { "Type": "RecordFormat", "Required": true, "MarkdownDocumentation": "`RecordFormat`\n\nSpecifies the format of the records on the streaming source.\n*Required*: Yes\n*Type*: [RecordFormat](./aws-properties-kinesisanalytics-application-recordformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordformat", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.JSONMappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.JSONMappingParameters`\n\nProvides additional mapping information when JSON is the record format on the\nstreaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html", "Properties": { "RecordRowPath": { "Required": true, "MarkdownDocumentation": "`RecordRowPath`\n\nPath to the top-level parent that contains the records.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html#cfn-kinesisanalytics-application-jsonmappingparameters-recordrowpath", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.KinesisFirehoseInput": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.KinesisFirehoseInput`\n\nIdentifies an Amazon Kinesis Firehose delivery stream as the streaming source. You\nprovide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that\nenables Amazon Kinesis Analytics to access the stream on your behalf.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nARN of the input delivery stream.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RoleARN": { "Required": true, "MarkdownDocumentation": "`RoleARN`\n\nARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on\nyour behalf. You need to make sure that the role has the necessary permissions to access\nthe stream.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.KinesisStreamsInput": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.KinesisStreamsInput`\n\nIdentifies an Amazon Kinesis stream as the streaming source. You provide the stream's\nAmazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to\naccess the stream on your behalf.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nARN of the input Amazon Kinesis stream to read.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RoleARN": { "Required": true, "MarkdownDocumentation": "`RoleARN`\n\nARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on\nyour behalf. You need to grant the necessary permissions to this role.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.MappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.MappingParameters`\n\nWhen configuring application input at the time of creating or updating an application,\nprovides additional mapping information specific to the record format (such as JSON,\nCSV, or record fields delimited by some delimiter) on the streaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html", "Properties": { "JSONMappingParameters": { "Type": "JSONMappingParameters", "Required": false, "MarkdownDocumentation": "`JSONMappingParameters`\n\nProvides additional mapping information when JSON is the record format on the\nstreaming source.\n*Required*: No\n*Type*: [JSONMappingParameters](./aws-properties-kinesisanalytics-application-jsonmappingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-jsonmappingparameters", "UpdateType": "Mutable" }, "CSVMappingParameters": { "Type": "CSVMappingParameters", "Required": false, "MarkdownDocumentation": "`CSVMappingParameters`\n\nProvides additional mapping information when the record format uses delimiters (for\nexample, CSV).\n*Required*: No\n*Type*: [CSVMappingParameters](./aws-properties-kinesisanalytics-application-csvmappingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-csvmappingparameters", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.RecordColumn": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.RecordColumn`\n\nDescribes the mapping of each data element in the streaming source to the\ncorresponding column in the in-application stream.\nAlso used to describe the format of the reference data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html", "Properties": { "Mapping": { "Required": false, "MarkdownDocumentation": "`Mapping`\n\nReference to the data element in the streaming input or the reference data source.\nThis element is required if the [RecordFormatType](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) is `JSON`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-mapping", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SqlType": { "Required": true, "MarkdownDocumentation": "`SqlType`\n\nType of column created in the in-application input stream or reference table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-sqltype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nName of the column created in the in-application input stream or reference\ntable.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::Application.RecordFormat": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application.RecordFormat`\n\nDescribes the record format and relevant mapping information that should be applied\nto schematize the records on the stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html", "Properties": { "MappingParameters": { "Type": "MappingParameters", "Required": false, "MarkdownDocumentation": "`MappingParameters`\n\nWhen configuring application input at the time of creating or updating an application,\nprovides additional mapping information specific to the record format (such as JSON,\nCSV, or record fields delimited by some delimiter) on the streaming source.\n*Required*: No\n*Type*: [MappingParameters](./aws-properties-kinesisanalytics-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-mappingparameters", "UpdateType": "Mutable" }, "RecordFormatType": { "Required": true, "MarkdownDocumentation": "`RecordFormatType`\n\nThe type of record format.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `JSON | CSV`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "JSON", "CSV" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-recordformattype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema`\n\nDescribes the data format when records are written to the destination. For more\ninformation, see [Configuring Application\nOutput](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-destinationschema.html", "Properties": { "RecordFormatType": { "Required": false, "MarkdownDocumentation": "`RecordFormatType`\n\nSpecifies the format of the records on the output stream.\n*Required*: No\n*Type*: String\n*Allowed values*: `JSON | CSV`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "JSON", "CSV" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-destinationschema.html#cfn-kinesisanalytics-applicationoutput-destinationschema-recordformattype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput`\n\nWhen configuring application output, identifies an Amazon Kinesis Firehose delivery\nstream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM\nrole that enables Amazon Kinesis Analytics to write to the stream on your behalf.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nARN of the destination Amazon Kinesis Firehose delivery stream to write to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisfirehoseoutput-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RoleARN": { "Required": true, "MarkdownDocumentation": "`RoleARN`\n\nARN of the IAM role that Amazon Kinesis Analytics can assume to write to the\ndestination stream on your behalf. You need to grant the necessary permissions to this\nrole.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisfirehoseoutput-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput`\n\nWhen configuring application output, identifies an Amazon Kinesis stream as the\ndestination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN\nthat Amazon Kinesis Analytics can use to write to the stream on your behalf.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nARN of the destination Amazon Kinesis stream to write to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisstreamsoutput-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RoleARN": { "Required": true, "MarkdownDocumentation": "`RoleARN`\n\nARN of the IAM role that Amazon Kinesis Analytics can assume to write to the\ndestination stream on your behalf. You need to grant the necessary permissions to this\nrole.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisstreamsoutput-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput`\n\nWhen configuring application output, identifies an AWS Lambda function\nas the destination. You provide the function Amazon Resource Name (ARN) and also an IAM\nrole ARN that Amazon Kinesis Analytics can use to write to the function on your behalf.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nAmazon Resource Name (ARN) of the destination Lambda function to write to.\n###### Note\nTo specify an earlier version of the Lambda function than the latest, include the\nLambda function version in the Lambda function ARN. For more information about\nLambda ARNs, see [Example\nARNs: AWS Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda)\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html#cfn-kinesisanalytics-applicationoutput-lambdaoutput-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RoleARN": { "Required": true, "MarkdownDocumentation": "`RoleARN`\n\nARN of the IAM role that Amazon Kinesis Analytics can assume to write to the\ndestination function on your behalf. You need to grant the necessary permissions to this\nrole.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html#cfn-kinesisanalytics-applicationoutput-lambdaoutput-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationOutput.Output": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationOutput.Output`\n\nDescribes application output configuration in which you identify an in-application\nstream and a destination where you want the in-application stream data to be written.\nThe destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery\nstream.\nFor limits on how many destinations an application can write and other limitations,\nsee [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html", "Properties": { "DestinationSchema": { "Type": "DestinationSchema", "Required": true, "MarkdownDocumentation": "`DestinationSchema`\n\nDescribes the data format when records are written to the destination. For more\ninformation, see [Configuring Application\nOutput](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).\n*Required*: Yes\n*Type*: [DestinationSchema](./aws-properties-kinesisanalytics-applicationoutput-destinationschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-destinationschema", "UpdateType": "Mutable" }, "LambdaOutput": { "Type": "LambdaOutput", "Required": false, "MarkdownDocumentation": "`LambdaOutput`\n\nIdentifies an AWS Lambda function as the destination.\n*Required*: No\n*Type*: [LambdaOutput](./aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-lambdaoutput", "UpdateType": "Mutable" }, "KinesisFirehoseOutput": { "Type": "KinesisFirehoseOutput", "Required": false, "MarkdownDocumentation": "`KinesisFirehoseOutput`\n\nIdentifies an Amazon Kinesis Firehose delivery stream as the destination.\n*Required*: No\n*Type*: [KinesisFirehoseOutput](./aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-kinesisfirehoseoutput", "UpdateType": "Mutable" }, "KinesisStreamsOutput": { "Type": "KinesisStreamsOutput", "Required": false, "MarkdownDocumentation": "`KinesisStreamsOutput`\n\nIdentifies an Amazon Kinesis stream as the destination.\n*Required*: No\n*Type*: [KinesisStreamsOutput](./aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-kinesisstreamsoutput", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nName of the in-application stream.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters`\n\nProvides additional mapping information when the record format uses delimiters, such\nas CSV. For example, the following sample records use CSV format, where the records use\nthe *'\\n'* as the row delimiter and a comma (\",\") as the column\ndelimiter:\n`\"name1\", \"address1\"`\n`\"name2\", \"address2\"`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html", "Properties": { "RecordRowDelimiter": { "Required": true, "MarkdownDocumentation": "`RecordRowDelimiter`\n\nRow delimiter. For example, in a CSV format, *'\\n'* is the typical\nrow delimiter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordrowdelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RecordColumnDelimiter": { "Required": true, "MarkdownDocumentation": "`RecordColumnDelimiter`\n\nColumn delimiter. For example, in a CSV format, a comma (\",\") is the typical column\ndelimiter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordcolumndelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters`\n\nProvides additional mapping information when JSON is the record format on the\nstreaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters.html", "Properties": { "RecordRowPath": { "Required": true, "MarkdownDocumentation": "`RecordRowPath`\n\nPath to the top-level parent that contains the records.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters-recordrowpath", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters`\n\nWhen configuring application input at the time of creating or updating an application,\nprovides additional mapping information specific to the record format (such as JSON,\nCSV, or record fields delimited by some delimiter) on the streaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html", "Properties": { "JSONMappingParameters": { "Type": "JSONMappingParameters", "Required": false, "MarkdownDocumentation": "`JSONMappingParameters`\n\nProvides additional mapping information when JSON is the record format on the\nstreaming source.\n*Required*: No\n*Type*: [JSONMappingParameters](./aws-properties-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-jsonmappingparameters", "UpdateType": "Mutable" }, "CSVMappingParameters": { "Type": "CSVMappingParameters", "Required": false, "MarkdownDocumentation": "`CSVMappingParameters`\n\nProvides additional mapping information when the record format uses delimiters (for\nexample, CSV).\n*Required*: No\n*Type*: [CSVMappingParameters](./aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-csvmappingparameters", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn`\n\nDescribes the mapping of each data element in the streaming source to the\ncorresponding column in the in-application stream.\nAlso used to describe the format of the reference data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html", "Properties": { "Mapping": { "Required": false, "MarkdownDocumentation": "`Mapping`\n\nReference to the data element in the streaming input or the reference data source.\nThis element is required if the [RecordFormatType](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) is `JSON`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-mapping", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SqlType": { "Required": true, "MarkdownDocumentation": "`SqlType`\n\nType of column created in the in-application input stream or reference table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-sqltype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nName of the column created in the in-application input stream or reference\ntable.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat`\n\nDescribes the record format and relevant mapping information that should be applied\nto schematize the records on the stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html", "Properties": { "MappingParameters": { "Type": "MappingParameters", "Required": false, "MarkdownDocumentation": "`MappingParameters`\n\nWhen configuring application input at the time of creating or updating an application,\nprovides additional mapping information specific to the record format (such as JSON,\nCSV, or record fields delimited by some delimiter) on the streaming source.\n*Required*: No\n*Type*: [MappingParameters](./aws-properties-kinesisanalytics-applicationreferencedatasource-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-mappingparameters", "UpdateType": "Mutable" }, "RecordFormatType": { "Required": true, "MarkdownDocumentation": "`RecordFormatType`\n\nThe type of record format.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `JSON | CSV`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "JSON", "CSV" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-recordformattype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource`\n\nDescribes the reference data source by providing the source information (S3 bucket\nname and object key name), the resulting in-application table name that is created, and\nthe necessary schema to map the data elements in the Amazon S3 object to the\nin-application table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html", "Properties": { "ReferenceSchema": { "Type": "ReferenceSchema", "Required": true, "MarkdownDocumentation": "`ReferenceSchema`\n\nDescribes the format of the data in the streaming source, and how each data element\nmaps to corresponding columns created in the in-application stream.\n*Required*: Yes\n*Type*: [ReferenceSchema](./aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-referenceschema", "UpdateType": "Mutable" }, "TableName": { "Required": false, "MarkdownDocumentation": "`TableName`\n\nName of the in-application table to create.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-tablename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "S3ReferenceDataSource": { "Type": "S3ReferenceDataSource", "Required": false, "MarkdownDocumentation": "`S3ReferenceDataSource`\n\nIdentifies the S3 bucket and object that contains the reference data. Also identifies\nthe IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An\nAmazon Kinesis Analytics application loads reference data only once. If the data\nchanges, you call the `UpdateApplication` operation to trigger reloading of\ndata into your application.\n*Required*: No\n*Type*: [S3ReferenceDataSource](./aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-s3referencedatasource", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema`\n\nThe ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html", "Properties": { "RecordEncoding": { "Required": false, "MarkdownDocumentation": "`RecordEncoding`\n\nSpecifies the encoding of the records in the reference source. For example, UTF-8.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordencoding", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RecordColumns": { "Type": "List", "Required": true, "MarkdownDocumentation": "`RecordColumns`\n\nA list of RecordColumn objects.\n*Required*: Yes\n*Type*: Array of [RecordColumn](./aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordcolumns", "ItemType": "RecordColumn", "UpdateType": "Mutable" }, "RecordFormat": { "Type": "RecordFormat", "Required": true, "MarkdownDocumentation": "`RecordFormat`\n\nSpecifies the format of the records on the reference source.\n*Required*: Yes\n*Type*: [RecordFormat](./aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordformat", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource`\n\nIdentifies the S3 bucket and object that contains the reference data. Also identifies\nthe IAM role Amazon Kinesis Analytics can assume to read this object on your\nbehalf.\nAn Amazon Kinesis Analytics application loads reference data only once. If the data\nchanges, you call the [UpdateApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation to trigger reloading of data into your\napplication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html", "Properties": { "BucketARN": { "Required": true, "MarkdownDocumentation": "`BucketARN`\n\nAmazon Resource Name (ARN) of the S3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-bucketarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FileKey": { "Required": true, "MarkdownDocumentation": "`FileKey`\n\nObject key name containing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-filekey", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReferenceRoleARN": { "Required": true, "MarkdownDocumentation": "`ReferenceRoleARN`\n\nARN of the IAM role that the service can assume to read data on your behalf. This role\nmust have permission for the `s3:GetObject` action on the object and trust\npolicy that allows Amazon Kinesis Analytics service principal to assume this\nrole.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-referencerolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::Application.ApplicationCodeConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ApplicationCodeConfiguration`\n\nDescribes code configuration for an application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationcodeconfiguration.html", "Properties": { "CodeContentType": { "MarkdownDocumentation": "`CodeContentType`\n\nSpecifies whether the code content is in text or zip format.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PLAINTEXT | ZIPFILE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PLAINTEXT", "ZIPFILE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationcodeconfiguration.html#cfn-kinesisanalyticsv2-application-applicationcodeconfiguration-codecontenttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CodeContent": { "MarkdownDocumentation": "`CodeContent`\n\nThe location and type of the application code.\n*Required*: Yes\n*Type*: [CodeContent](./aws-properties-kinesisanalyticsv2-application-codecontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationcodeconfiguration.html#cfn-kinesisanalyticsv2-application-applicationcodeconfiguration-codecontent", "UpdateType": "Mutable", "Required": true, "Type": "CodeContent" } } }, "AWS::KinesisAnalyticsV2::Application.ApplicationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ApplicationConfiguration`\n\nSpecifies the creation parameters for a Managed Service for Apache Flink application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html", "Properties": { "ApplicationCodeConfiguration": { "MarkdownDocumentation": "`ApplicationCodeConfiguration`\n\nThe code location and type parameters for a Managed Service for Apache Flink application.\n*Required*: Conditional\n*Type*: [ApplicationCodeConfiguration](./aws-properties-kinesisanalyticsv2-application-applicationcodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-applicationcodeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationCodeConfiguration" }, "ApplicationEncryptionConfiguration": { "MarkdownDocumentation": "`ApplicationEncryptionConfiguration`\n\nThe configuration to manage encryption at rest.\n*Required*: No\n*Type*: [ApplicationEncryptionConfiguration](./aws-properties-kinesisanalyticsv2-application-applicationencryptionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-applicationencryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationEncryptionConfiguration" }, "EnvironmentProperties": { "MarkdownDocumentation": "`EnvironmentProperties`\n\nDescribes execution properties for a Managed Service for Apache Flink application.\n*Required*: No\n*Type*: [EnvironmentProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-environmentproperties", "UpdateType": "Mutable", "Required": false, "Type": "EnvironmentProperties" }, "FlinkApplicationConfiguration": { "MarkdownDocumentation": "`FlinkApplicationConfiguration`\n\nThe creation and update parameters for a Managed Service for Apache Flink application.\n*Required*: No\n*Type*: [FlinkApplicationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-flinkapplicationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FlinkApplicationConfiguration" }, "SqlApplicationConfiguration": { "MarkdownDocumentation": "`SqlApplicationConfiguration`\n\nThe creation and update parameters for a SQL-based Kinesis Data Analytics application.\n*Required*: No\n*Type*: [SqlApplicationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-sqlapplicationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SqlApplicationConfiguration" }, "ZeppelinApplicationConfiguration": { "MarkdownDocumentation": "`ZeppelinApplicationConfiguration`\n\nThe configuration parameters for a Kinesis Data Analytics Studio notebook.\n*Required*: No\n*Type*: [ZeppelinApplicationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-zeppelinapplicationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ZeppelinApplicationConfiguration" }, "VpcConfigurations": { "MarkdownDocumentation": "`VpcConfigurations`\n\nThe array of descriptions of VPC configurations available to the application.\n*Required*: No\n*Type*: Array of [VpcConfiguration](./aws-properties-kinesisanalyticsv2-application-vpcconfiguration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-vpcconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VpcConfiguration", "DuplicatesAllowed": true }, "ApplicationSnapshotConfiguration": { "MarkdownDocumentation": "`ApplicationSnapshotConfiguration`\n\nDescribes whether snapshots are enabled for a Managed Service for Apache Flink application.\n*Required*: No\n*Type*: [ApplicationSnapshotConfiguration](./aws-properties-kinesisanalyticsv2-application-applicationsnapshotconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-applicationsnapshotconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationSnapshotConfiguration" }, "ApplicationSystemRollbackConfiguration": { "MarkdownDocumentation": "`ApplicationSystemRollbackConfiguration`\n\nDescribes whether system rollbacks are enabled for a Managed Service for Apache Flink application.\n*Required*: No\n*Type*: [ApplicationSystemRollbackConfiguration](./aws-properties-kinesisanalyticsv2-application-applicationsystemrollbackconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html#cfn-kinesisanalyticsv2-application-applicationconfiguration-applicationsystemrollbackconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationSystemRollbackConfiguration" } } }, "AWS::KinesisAnalyticsV2::Application.ApplicationEncryptionConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ApplicationEncryptionConfiguration`\n\nSpecifies the configuration to manage encryption at rest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationencryptionconfiguration.html", "Properties": { "KeyType": { "MarkdownDocumentation": "`KeyType`\n\nSpecifies the type of key used for encryption at rest.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS_OWNED_KEY | CUSTOMER_MA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationencryptionconfiguration.html#cfn-kinesisanalyticsv2-application-applicationencryptionconfiguration-keytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyId": { "MarkdownDocumentation": "`KeyId`\n\nThe key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:arn:.*:kms:.*:.*:(?:key\\/.*|alias\\/.*)|alias\\/.*|(?i)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationencryptionconfiguration.html#cfn-kinesisanalyticsv2-application-applicationencryptionconfiguration-keyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration`\n\nSpecifies the maintenance configuration for a Amazon Managed Service for Apache Flink.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationmaintenanceconfiguration.html", "Properties": { "ApplicationMaintenanceWindowStartTime": { "MarkdownDocumentation": "`ApplicationMaintenanceWindowStartTime`\n\nThe UTC timestamp of a day from which the eight-hour maintenance window will begin every day of the week. Maintenance of the application happens only during this eight-hour window.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([01][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationmaintenanceconfiguration.html#cfn-kinesisanalyticsv2-application-applicationmaintenanceconfiguration-applicationmaintenancewindowstarttime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.ApplicationRestoreConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ApplicationRestoreConfiguration`\n\nSpecifies the method and snapshot to use when restarting an application using previously saved application state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationrestoreconfiguration.html", "Properties": { "SnapshotName": { "MarkdownDocumentation": "`SnapshotName`\n\nThe identifier of an existing snapshot of application state to use to restart an application.\nThe application uses this value if `RESTORE_FROM_CUSTOM_SNAPSHOT` is specified for the\n`ApplicationRestoreType`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationrestoreconfiguration.html#cfn-kinesisanalyticsv2-application-applicationrestoreconfiguration-snapshotname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationRestoreType": { "MarkdownDocumentation": "`ApplicationRestoreType`\n\nSpecifies how the application should be restored.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "SKIP_RESTORE_FROM_SNAPSHOT", "RESTORE_FROM_LATEST_SNAPSHOT", "RESTORE_FROM_CUSTOM_SNAPSHOT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationrestoreconfiguration.html#cfn-kinesisanalyticsv2-application-applicationrestoreconfiguration-applicationrestoretype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.ApplicationSnapshotConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ApplicationSnapshotConfiguration`\n\nDescribes whether snapshots are enabled for a Managed Service for Apache Flink application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationsnapshotconfiguration.html", "Properties": { "SnapshotsEnabled": { "MarkdownDocumentation": "`SnapshotsEnabled`\n\nDescribes whether snapshots are enabled for a Managed Service for Apache Flink 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationsnapshotconfiguration.html#cfn-kinesisanalyticsv2-application-applicationsnapshotconfiguration-snapshotsenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::KinesisAnalyticsV2::Application.ApplicationSystemRollbackConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ApplicationSystemRollbackConfiguration`\n\nDescribes the system rollback configuration for a Managed Service for Apache Flink application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationsystemrollbackconfiguration.html", "Properties": { "RollbackEnabled": { "MarkdownDocumentation": "`RollbackEnabled`\n\nDescribes whether system rollbacks are enabled for a Managed Service for Apache Flink 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationsystemrollbackconfiguration.html#cfn-kinesisanalyticsv2-application-applicationsystemrollbackconfiguration-rollbackenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::KinesisAnalyticsV2::Application.CSVMappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.CSVMappingParameters`\n\nFor a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record\nformat uses delimiters, such as CSV. For example, the following sample records use CSV format,\nwhere the records use the *'\\n'* as the row delimiter and a comma (\",\") as\nthe column delimiter:\n`\"name1\", \"address1\"`\n`\"name2\", \"address2\"`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-csvmappingparameters.html", "Properties": { "RecordRowDelimiter": { "MarkdownDocumentation": "`RecordRowDelimiter`\n\nThe row delimiter. For example, in a CSV format, *'\\n'* is the typical\nrow delimiter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-csvmappingparameters.html#cfn-kinesisanalyticsv2-application-csvmappingparameters-recordrowdelimiter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RecordColumnDelimiter": { "MarkdownDocumentation": "`RecordColumnDelimiter`\n\nThe column delimiter. For example, in a CSV format, a comma (\",\") is the typical column\ndelimiter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-csvmappingparameters.html#cfn-kinesisanalyticsv2-application-csvmappingparameters-recordcolumndelimiter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.CatalogConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.CatalogConfiguration`\n\nThe configuration parameters for the default Amazon Glue database. You use this\ndatabase for SQL queries that you write in a Kinesis Data Analytics Studio\nnotebook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-catalogconfiguration.html", "Properties": { "GlueDataCatalogConfiguration": { "MarkdownDocumentation": "`GlueDataCatalogConfiguration`\n\nThe configuration parameters for the default Amazon Glue database. You use this\ndatabase for Apache Flink SQL queries and table API transforms that you write in a\nKinesis Data Analytics Studio notebook.\n*Required*: No\n*Type*: [GlueDataCatalogConfiguration](./aws-properties-kinesisanalyticsv2-application-gluedatacatalogconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-catalogconfiguration.html#cfn-kinesisanalyticsv2-application-catalogconfiguration-gluedatacatalogconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GlueDataCatalogConfiguration" } } }, "AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration`\n\nDescribes an application's checkpointing configuration. Checkpointing is the process\nof persisting application state for fault tolerance. For more information, see [Checkpoints for Fault Tolerance](https://nightlies.apache.org/flink/flink-docs-master/docs/dev/datastream/fault-tolerance/checkpointing/) in the [Apache Flink\nDocumentation](https://nightlies.apache.org/flink/flink-docs-master).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html", "Properties": { "ConfigurationType": { "MarkdownDocumentation": "`ConfigurationType`\n\nDescribes whether the application uses Managed Service for Apache Flink' default checkpointing behavior.\nYou must set this property to `CUSTOM` in order to set the\n`CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters.\n###### Note\nIf this value is set to `DEFAULT`, the application will use the following values, even if they are set to other values using APIs or\napplication code:\n* **CheckpointingEnabled:** true\n* **CheckpointInterval:** 60000\n* **MinPauseBetweenCheckpoints:** 5000\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEFAULT | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-configurationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CheckpointInterval": { "MarkdownDocumentation": "`CheckpointInterval`\n\nDescribes the interval in milliseconds between checkpoint operations.\n###### Note\nIf `CheckpointConfiguration.ConfigurationType` is `DEFAULT`,\nthe application will use a `CheckpointInterval` value of 60000, even if this value is set\nto another value using this API or in application code.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `9223372036854775807`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-checkpointinterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "MinPauseBetweenCheckpoints": { "MarkdownDocumentation": "`MinPauseBetweenCheckpoints`\n\nDescribes the minimum time in milliseconds after a checkpoint operation completes that\na new checkpoint operation can start. If a checkpoint operation takes longer than the\n`CheckpointInterval`, the application otherwise performs continual\ncheckpoint operations. For more information, see [Tuning Checkpointing](https://nightlies.apache.org/flink/flink-docs-master/docs/ops/state/large_state_tuning/#tuning-checkpointing) in the [Apache Flink\nDocumentation](https://nightlies.apache.org/flink/flink-docs-master).\n###### Note\nIf `CheckpointConfiguration.ConfigurationType` is `DEFAULT`,\nthe application will use a `MinPauseBetweenCheckpoints` value of 5000,\neven if this value is set using this API or in application code.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `9223372036854775807`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-minpausebetweencheckpoints", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "CheckpointingEnabled": { "MarkdownDocumentation": "`CheckpointingEnabled`\n\nDescribes whether checkpointing is enabled for a Managed Service for Apache Flink application.\n###### Note\nIf `CheckpointConfiguration.ConfigurationType` is `DEFAULT`,\nthe application will use a `CheckpointingEnabled` value of `true`, even if this value\nis set to another value using this API or in application code.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html#cfn-kinesisanalyticsv2-application-checkpointconfiguration-checkpointingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::KinesisAnalyticsV2::Application.CodeContent": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.CodeContent`\n\nSpecifies either the application code, or the location of the application code, for a\nManaged Service for Apache Flink application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-codecontent.html", "Properties": { "ZipFileContent": { "MarkdownDocumentation": "`ZipFileContent`\n\nThe zip-format code for a Managed Service for Apache Flink 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-codecontent.html#cfn-kinesisanalyticsv2-application-codecontent-zipfilecontent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3ContentLocation": { "MarkdownDocumentation": "`S3ContentLocation`\n\nInformation about the Amazon S3 bucket that contains the application code.\n*Required*: No\n*Type*: [S3ContentLocation](./aws-properties-kinesisanalyticsv2-application-s3contentlocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-codecontent.html#cfn-kinesisanalyticsv2-application-codecontent-s3contentlocation", "UpdateType": "Mutable", "Required": false, "Type": "S3ContentLocation" }, "TextContent": { "MarkdownDocumentation": "`TextContent`\n\nThe text-format code for a Managed Service for Apache Flink application.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-codecontent.html#cfn-kinesisanalyticsv2-application-codecontent-textcontent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.CustomArtifactConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.CustomArtifactConfiguration`\n\nThe configuration of connectors and user-defined functions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-customartifactconfiguration.html", "Properties": { "MavenReference": { "MarkdownDocumentation": "`MavenReference`\n\nThe parameters required to fully specify a Maven reference.\n*Required*: No\n*Type*: [MavenReference](./aws-properties-kinesisanalyticsv2-application-mavenreference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-customartifactconfiguration.html#cfn-kinesisanalyticsv2-application-customartifactconfiguration-mavenreference", "UpdateType": "Mutable", "Required": false, "Type": "MavenReference" }, "S3ContentLocation": { "MarkdownDocumentation": "`S3ContentLocation`\n\nThe location of the custom artifacts.\n*Required*: No\n*Type*: [S3ContentLocation](./aws-properties-kinesisanalyticsv2-application-s3contentlocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-customartifactconfiguration.html#cfn-kinesisanalyticsv2-application-customartifactconfiguration-s3contentlocation", "UpdateType": "Mutable", "Required": false, "Type": "S3ContentLocation" }, "ArtifactType": { "MarkdownDocumentation": "`ArtifactType`\n\nSet this to either `UDF` or `DEPENDENCY_JAR`. `UDF`\nstands for user-defined functions. This type of artifact must be in an S3 bucket. A\n`DEPENDENCY_JAR` can be in either Maven or an S3 bucket.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEPENDENCY_JAR | UDF...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEPENDENCY_JAR", "UDF" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-customartifactconfiguration.html#cfn-kinesisanalyticsv2-application-customartifactconfiguration-artifacttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.DeployAsApplicationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.DeployAsApplicationConfiguration`\n\nThe information required to deploy a Kinesis Data Analytics Studio notebook as an\napplication with durable state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-deployasapplicationconfiguration.html", "Properties": { "S3ContentLocation": { "MarkdownDocumentation": "`S3ContentLocation`\n\nThe description of an Amazon S3 object that contains the Amazon Data Analytics\napplication, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the\nAmazon S3 object that contains the data, and the version number of the Amazon S3 object\nthat contains the data.\n*Required*: Yes\n*Type*: [S3ContentBaseLocation](./aws-properties-kinesisanalyticsv2-application-s3contentbaselocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-deployasapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-deployasapplicationconfiguration-s3contentlocation", "UpdateType": "Mutable", "Required": true, "Type": "S3ContentBaseLocation" } } }, "AWS::KinesisAnalyticsV2::Application.EnvironmentProperties": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.EnvironmentProperties`\n\nDescribes execution properties for a Managed Service for Apache Flink application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-environmentproperties.html", "Properties": { "PropertyGroups": { "MarkdownDocumentation": "`PropertyGroups`\n\nDescribes the execution property groups.\n*Required*: No\n*Type*: Array of [PropertyGroup](./aws-properties-kinesisanalyticsv2-application-propertygroup.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-environmentproperties.html#cfn-kinesisanalyticsv2-application-environmentproperties-propertygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PropertyGroup", "DuplicatesAllowed": true } } }, "AWS::KinesisAnalyticsV2::Application.FlinkApplicationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.FlinkApplicationConfiguration`\n\nDescribes configuration parameters for a Managed Service for Apache Flink application or a Studio notebook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html", "Properties": { "CheckpointConfiguration": { "MarkdownDocumentation": "`CheckpointConfiguration`\n\nDescribes an application's checkpointing configuration. Checkpointing is the process\nof persisting application state for fault tolerance. For more information, see [Checkpoints for Fault Tolerance](https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance) in the [Apache Flink\nDocumentation](https://ci.apache.org/projects/flink/flink-docs-release-1.8/).\n*Required*: No\n*Type*: [CheckpointConfiguration](./aws-properties-kinesisanalyticsv2-application-checkpointconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-flinkapplicationconfiguration-checkpointconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CheckpointConfiguration" }, "ParallelismConfiguration": { "MarkdownDocumentation": "`ParallelismConfiguration`\n\nDescribes parameters for how an application executes multiple tasks simultaneously.\n*Required*: No\n*Type*: [ParallelismConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-flinkapplicationconfiguration-parallelismconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ParallelismConfiguration" }, "MonitoringConfiguration": { "MarkdownDocumentation": "`MonitoringConfiguration`\n\nDescribes configuration parameters for Amazon CloudWatch logging for an\napplication.\n*Required*: No\n*Type*: [MonitoringConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-flinkapplicationconfiguration-monitoringconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MonitoringConfiguration" } } }, "AWS::KinesisAnalyticsV2::Application.FlinkRunConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.FlinkRunConfiguration`\n\nDescribes the starting parameters for a Managed Service for Apache Flink application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkrunconfiguration.html", "Properties": { "AllowNonRestoredState": { "MarkdownDocumentation": "`AllowNonRestoredState`\n\nWhen restoring from a snapshot, specifies whether the runtime is allowed to skip a\nstate that cannot be mapped to the new program. This will happen if the program is\nupdated between snapshots to remove stateful parameters, and state data in the snapshot\nno longer corresponds to valid application data. For more information, see [Allowing Non-Restored State](https://nightlies.apache.org/flink/flink-docs-master/docs/ops/state/savepoints/#allowing-non-restored-state) in the [Apache Flink\ndocumentation](https://nightlies.apache.org/flink/flink-docs-master).\n###### Note\nThis value defaults to `false`. If you update your application without\nspecifying this parameter, `AllowNonRestoredState` will be set to\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkrunconfiguration.html#cfn-kinesisanalyticsv2-application-flinkrunconfiguration-allownonrestoredstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::KinesisAnalyticsV2::Application.GlueDataCatalogConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.GlueDataCatalogConfiguration`\n\nThe configuration of the Glue Data Catalog that you use for Apache Flink SQL queries\nand table API transforms that you write in an application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-gluedatacatalogconfiguration.html", "Properties": { "DatabaseARN": { "MarkdownDocumentation": "`DatabaseARN`\n\nThe Amazon Resource Name (ARN) of the database.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-gluedatacatalogconfiguration.html#cfn-kinesisanalyticsv2-application-gluedatacatalogconfiguration-databasearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.Input": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.Input`\n\nWhen you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream\nname that is created,\nand the mapping between the two.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html", "Properties": { "NamePrefix": { "MarkdownDocumentation": "`NamePrefix`\n\nThe name prefix to use when creating an in-application stream. Suppose that you specify a\nprefix \"`MyInApplicationStream`.\" Kinesis Data Analytics then creates one or more\n(as per the `InputParallelism` count you specified) in-application streams with the\nnames \"`MyInApplicationStream_001`,\" \"`MyInApplicationStream_002`,\" and\nso on.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^-\\s<>&]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-nameprefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputSchema": { "MarkdownDocumentation": "`InputSchema`\n\nDescribes the format of the data in the streaming source, and how each data element maps\nto corresponding columns in the in-application stream that is being created.\nAlso used to describe the format of the reference data source.\n*Required*: Yes\n*Type*: [InputSchema](./aws-properties-kinesisanalyticsv2-application-inputschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-inputschema", "UpdateType": "Mutable", "Required": true, "Type": "InputSchema" }, "KinesisStreamsInput": { "MarkdownDocumentation": "`KinesisStreamsInput`\n\nIf the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).\n*Required*: No\n*Type*: [KinesisStreamsInput](./aws-properties-kinesisanalyticsv2-application-kinesisstreamsinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-kinesisstreamsinput", "UpdateType": "Mutable", "Required": false, "Type": "KinesisStreamsInput" }, "KinesisFirehoseInput": { "MarkdownDocumentation": "`KinesisFirehoseInput`\n\nIf the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.\n*Required*: No\n*Type*: [KinesisFirehoseInput](./aws-properties-kinesisanalyticsv2-application-kinesisfirehoseinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-kinesisfirehoseinput", "UpdateType": "Mutable", "Required": false, "Type": "KinesisFirehoseInput" }, "InputProcessingConfiguration": { "MarkdownDocumentation": "`InputProcessingConfiguration`\n\nThe [InputProcessingConfiguration](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_InputProcessingConfiguration.html) for the input. An input processor transforms\nrecords as they are received from the stream, before the application's SQL code\nexecutes. Currently, the only input processing configuration available is [InputLambdaProcessor](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_InputLambdaProcessor.html).\n*Required*: No\n*Type*: [InputProcessingConfiguration](./aws-properties-kinesisanalyticsv2-application-inputprocessingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-inputprocessingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InputProcessingConfiguration" }, "InputParallelism": { "MarkdownDocumentation": "`InputParallelism`\n\nDescribes the number of in-application streams to create.\n*Required*: No\n*Type*: [InputParallelism](./aws-properties-kinesisanalyticsv2-application-inputparallelism.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html#cfn-kinesisanalyticsv2-application-input-inputparallelism", "UpdateType": "Mutable", "Required": false, "Type": "InputParallelism" } } }, "AWS::KinesisAnalyticsV2::Application.InputLambdaProcessor": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.InputLambdaProcessor`\n\nAn object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is\nused to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputlambdaprocessor.html", "Properties": { "ResourceARN": { "MarkdownDocumentation": "`ResourceARN`\n\nThe ARN of the Amazon Lambda function that operates on records in the stream.\n###### Note\nTo specify an earlier version of the Lambda function than the latest, include the\nLambda function version in the Lambda function ARN. For more information about\nLambda ARNs, see [Example\nARNs: Amazon Lambda](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda)\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputlambdaprocessor.html#cfn-kinesisanalyticsv2-application-inputlambdaprocessor-resourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.InputParallelism": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.InputParallelism`\n\nFor a SQL-based Kinesis Data Analytics application, describes the number of\nin-application streams to create for a given streaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputparallelism.html", "Properties": { "Count": { "MarkdownDocumentation": "`Count`\n\nThe number of in-application streams to create.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputparallelism.html#cfn-kinesisanalyticsv2-application-inputparallelism-count", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisAnalyticsV2::Application.InputProcessingConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.InputProcessingConfiguration`\n\nFor an SQL-based Amazon Kinesis Data Analytics application, describes a processor that\nis used to preprocess the records in the stream before being processed by your\napplication code. Currently, the only input processor available is [Amazon Lambda](https://docs.aws.amazon.com/lambda/).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputprocessingconfiguration.html", "Properties": { "InputLambdaProcessor": { "MarkdownDocumentation": "`InputLambdaProcessor`\n\nThe [InputLambdaProcessor](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_InputLambdaProcessor.html) that is used to preprocess the records in the stream\nbefore being processed by your application code.\n*Required*: No\n*Type*: [InputLambdaProcessor](./aws-properties-kinesisanalyticsv2-application-inputlambdaprocessor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputprocessingconfiguration.html#cfn-kinesisanalyticsv2-application-inputprocessingconfiguration-inputlambdaprocessor", "UpdateType": "Mutable", "Required": false, "Type": "InputLambdaProcessor" } } }, "AWS::KinesisAnalyticsV2::Application.InputSchema": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.InputSchema`\n\nFor a SQL-based Kinesis Data Analytics application, describes the format of the\ndata in the streaming source, and how each data element maps to corresponding columns created\nin the in-application stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html", "Properties": { "RecordEncoding": { "MarkdownDocumentation": "`RecordEncoding`\n\nSpecifies the encoding of the records in the streaming source. For example, UTF-8.\n*Required*: No\n*Type*: String\n*Allowed values*: `UTF-8`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "UTF-8" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordencoding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RecordColumns": { "MarkdownDocumentation": "`RecordColumns`\n\nA list of `RecordColumn` objects.\n*Required*: Yes\n*Type*: Array of [RecordColumn](./aws-properties-kinesisanalyticsv2-application-recordcolumn.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordcolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RecordColumn", "DuplicatesAllowed": true }, "RecordFormat": { "MarkdownDocumentation": "`RecordFormat`\n\nSpecifies the format of the records on the streaming source.\n*Required*: Yes\n*Type*: [RecordFormat](./aws-properties-kinesisanalyticsv2-application-recordformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordformat", "UpdateType": "Mutable", "Required": true, "Type": "RecordFormat" } } }, "AWS::KinesisAnalyticsV2::Application.JSONMappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.JSONMappingParameters`\n\nFor a SQL-based Kinesis Data Analytics application, provides additional mapping\ninformation when JSON is the record format on the streaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-jsonmappingparameters.html", "Properties": { "RecordRowPath": { "MarkdownDocumentation": "`RecordRowPath`\n\nThe path to the top-level parent that contains the records.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=^\\$)(?=^\\S+$).*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-jsonmappingparameters.html#cfn-kinesisanalyticsv2-application-jsonmappingparameters-recordrowpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.KinesisFirehoseInput": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.KinesisFirehoseInput`\n\nFor a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data\nFirehose delivery stream as the streaming source. You provide the delivery stream's Amazon\nResource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-kinesisfirehoseinput.html", "Properties": { "ResourceARN": { "MarkdownDocumentation": "`ResourceARN`\n\nThe Amazon Resource Name (ARN) of the delivery stream.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-kinesisfirehoseinput.html#cfn-kinesisanalyticsv2-application-kinesisfirehoseinput-resourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.KinesisStreamsInput": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.KinesisStreamsInput`\n\nIdentifies a Kinesis data stream as the streaming source. You provide the\nstream's Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-kinesisstreamsinput.html", "Properties": { "ResourceARN": { "MarkdownDocumentation": "`ResourceARN`\n\nThe ARN of the input Kinesis data stream to read.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-kinesisstreamsinput.html#cfn-kinesisanalyticsv2-application-kinesisstreamsinput-resourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.MappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.MappingParameters`\n\nWhen you configure a SQL-based Kinesis Data Analytics application's input at the\ntime of creating or updating an application, provides additional mapping information specific\nto the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the\nstreaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mappingparameters.html", "Properties": { "JSONMappingParameters": { "MarkdownDocumentation": "`JSONMappingParameters`\n\nProvides additional mapping information when JSON is the record format on the streaming source.\n*Required*: No\n*Type*: [JSONMappingParameters](./aws-properties-kinesisanalyticsv2-application-jsonmappingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mappingparameters.html#cfn-kinesisanalyticsv2-application-mappingparameters-jsonmappingparameters", "UpdateType": "Mutable", "Required": false, "Type": "JSONMappingParameters" }, "CSVMappingParameters": { "MarkdownDocumentation": "`CSVMappingParameters`\n\nProvides additional mapping information when the record format uses delimiters\n(for example, CSV).\n*Required*: No\n*Type*: [CSVMappingParameters](./aws-properties-kinesisanalyticsv2-application-csvmappingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mappingparameters.html#cfn-kinesisanalyticsv2-application-mappingparameters-csvmappingparameters", "UpdateType": "Mutable", "Required": false, "Type": "CSVMappingParameters" } } }, "AWS::KinesisAnalyticsV2::Application.MavenReference": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.MavenReference`\n\nThe information required to specify a Maven reference. You can use Maven references to\nspecify dependency JAR files.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mavenreference.html", "Properties": { "ArtifactId": { "MarkdownDocumentation": "`ArtifactId`\n\nThe artifact ID of the Maven reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mavenreference.html#cfn-kinesisanalyticsv2-application-mavenreference-artifactid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of the Maven reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mavenreference.html#cfn-kinesisanalyticsv2-application-mavenreference-version", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GroupId": { "MarkdownDocumentation": "`GroupId`\n\nThe group ID of the Maven reference.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mavenreference.html#cfn-kinesisanalyticsv2-application-mavenreference-groupid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.MonitoringConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.MonitoringConfiguration`\n\nDescribes configuration parameters for Amazon CloudWatch logging for a Java-based\nKinesis Data Analytics application. For more information about CloudWatch logging, see\n[Monitoring](https://docs.aws.amazon.com/managed-flink/latest/java/monitoring-overview).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html", "Properties": { "ConfigurationType": { "MarkdownDocumentation": "`ConfigurationType`\n\nDescribes whether to use the default CloudWatch logging configuration for an application.\nYou must set this property to `CUSTOM` in order to set the `LogLevel` or\n`MetricsLevel` parameters.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEFAULT | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html#cfn-kinesisanalyticsv2-application-monitoringconfiguration-configurationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricsLevel": { "MarkdownDocumentation": "`MetricsLevel`\n\nDescribes the granularity of the CloudWatch Logs for an application. The `Parallelism`\nlevel is not recommended for applications with a Parallelism over 64 due to excessive costs.\n*Required*: No\n*Type*: String\n*Allowed values*: `APPLICATION | OPERATOR | PA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "APPLICATION", "OPERATOR", "PARALLELISM", "TASK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html#cfn-kinesisanalyticsv2-application-monitoringconfiguration-metricslevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogLevel": { "MarkdownDocumentation": "`LogLevel`\n\nDescribes the verbosity of the CloudWatch Logs for an application.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEBUG | INFO | WARN | ERROR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEBUG", "INFO", "WARN", "ERROR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html#cfn-kinesisanalyticsv2-application-monitoringconfiguration-loglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration`\n\nDescribes parameters for how a Flink-based Kinesis Data Analytics application executes\nmultiple tasks simultaneously. For more information about parallelism, see [Parallel Execution](https://nightlies.apache.org/flink/flink-docs-master/docs/dev/datastream/execution/parallel/) in the [Apache Flink\nDocumentation](https://nightlies.apache.org/flink/flink-docs-master).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html", "Properties": { "ConfigurationType": { "MarkdownDocumentation": "`ConfigurationType`\n\nDescribes whether the application uses the default parallelism for the Managed Service for Apache Flink service. You must set this property to `CUSTOM`\nin order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CUSTOM | DEFAULT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CUSTOM", "DEFAULT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-configurationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParallelismPerKPU": { "MarkdownDocumentation": "`ParallelismPerKPU`\n\nDescribes the number of parallel tasks that a Java-based Kinesis Data Analytics\napplication can perform per Kinesis Processing Unit (KPU) used by the application. For\nmore information about KPUs, see [Amazon Kinesis Data Analytics\nPricing](https://aws.amazon.com/kinesis/data-analytics/pricing/).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-parallelismperkpu", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AutoScalingEnabled": { "MarkdownDocumentation": "`AutoScalingEnabled`\n\nDescribes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-autoscalingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Parallelism": { "MarkdownDocumentation": "`Parallelism`\n\nDescribes the initial number of parallel tasks that a Java-based Kinesis Data\nAnalytics application can perform. The Kinesis Data Analytics service can increase this\nnumber automatically if [ParallelismConfiguration:AutoScalingEnabled](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_ParallelismConfiguration.html#kinesisanalytics-Type-ParallelismConfiguration-AutoScalingEnabled.html) is set to\n`true`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html#cfn-kinesisanalyticsv2-application-parallelismconfiguration-parallelism", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisAnalyticsV2::Application.PropertyGroup": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.PropertyGroup`\n\nProperty key-value pairs passed into an application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-propertygroup.html", "Properties": { "PropertyMap": { "MarkdownDocumentation": "`PropertyMap`\n\nDescribes the value of an application execution property key-value pair.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^.{1,2048}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-propertygroup.html#cfn-kinesisanalyticsv2-application-propertygroup-propertymap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "PropertyGroupId": { "MarkdownDocumentation": "`PropertyGroupId`\n\nDescribes the key of an application execution property key-value pair.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-propertygroup.html#cfn-kinesisanalyticsv2-application-propertygroup-propertygroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.RecordColumn": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.RecordColumn`\n\nFor a SQL-based Kinesis Data Analytics application, describes the mapping of each\ndata element in the streaming source to the corresponding column in the in-application\nstream.\nAlso used to describe the format of the reference data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordcolumn.html", "Properties": { "Mapping": { "MarkdownDocumentation": "`Mapping`\n\nA reference to the data element in the streaming input or the reference data\nsource.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordcolumn.html#cfn-kinesisanalyticsv2-application-recordcolumn-mapping", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SqlType": { "MarkdownDocumentation": "`SqlType`\n\nThe type of column created in the in-application input stream or reference table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordcolumn.html#cfn-kinesisanalyticsv2-application-recordcolumn-sqltype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the column that is created in the in-application input stream or reference\ntable.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^-\\s<>&]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordcolumn.html#cfn-kinesisanalyticsv2-application-recordcolumn-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.RecordFormat": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.RecordFormat`\n\nFor a SQL-based Kinesis Data Analytics application, describes the record format\nand relevant mapping information that should be applied to schematize the records on the\nstream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordformat.html", "Properties": { "MappingParameters": { "MarkdownDocumentation": "`MappingParameters`\n\nWhen you configure application input at the time of creating or updating an application,\nprovides additional mapping information specific to the record format (such as JSON, CSV, or\nrecord fields delimited by some delimiter) on the streaming source.\n*Required*: No\n*Type*: [MappingParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordformat.html#cfn-kinesisanalyticsv2-application-recordformat-mappingparameters", "UpdateType": "Mutable", "Required": false, "Type": "MappingParameters" }, "RecordFormatType": { "MarkdownDocumentation": "`RecordFormatType`\n\nThe 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)\n", "RefReturnValue": "", "AllowedValues": [ "CSV", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-recordformat.html#cfn-kinesisanalyticsv2-application-recordformat-recordformattype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.RunConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.RunConfiguration`\n\nDescribes the starting parameters for an Managed Service for Apache Flink application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-runconfiguration.html", "Properties": { "FlinkRunConfiguration": { "MarkdownDocumentation": "`FlinkRunConfiguration`\n\nDescribes the starting parameters for a Managed Service for Apache Flink application.\n*Required*: No\n*Type*: [FlinkRunConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-runconfiguration.html#cfn-kinesisanalyticsv2-application-runconfiguration-flinkrunconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FlinkRunConfiguration" }, "ApplicationRestoreConfiguration": { "MarkdownDocumentation": "`ApplicationRestoreConfiguration`\n\nDescribes the restore behavior of a restarting application.\n*Required*: No\n*Type*: [ApplicationRestoreConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-runconfiguration.html#cfn-kinesisanalyticsv2-application-runconfiguration-applicationrestoreconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationRestoreConfiguration" } } }, "AWS::KinesisAnalyticsV2::Application.S3ContentBaseLocation": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.S3ContentBaseLocation`\n\nThe base location of the Amazon Data Analytics application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentbaselocation.html", "Properties": { "BucketARN": { "MarkdownDocumentation": "`BucketARN`\n\nThe Amazon Resource Name (ARN) of the S3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentbaselocation.html#cfn-kinesisanalyticsv2-application-s3contentbaselocation-bucketarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BasePath": { "MarkdownDocumentation": "`BasePath`\n\nThe base path for the S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9/!-_.*'()]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentbaselocation.html#cfn-kinesisanalyticsv2-application-s3contentbaselocation-basepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.S3ContentLocation": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.S3ContentLocation`\n\nThe location of an application or a custom artifact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentlocation.html", "Properties": { "BucketARN": { "MarkdownDocumentation": "`BucketARN`\n\nThe Amazon Resource Name (ARN) for the S3 bucket containing the application code.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentlocation.html#cfn-kinesisanalyticsv2-application-s3contentlocation-bucketarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FileKey": { "MarkdownDocumentation": "`FileKey`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentlocation.html#cfn-kinesisanalyticsv2-application-s3contentlocation-filekey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ObjectVersion": { "MarkdownDocumentation": "`ObjectVersion`\n\nThe version of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-s3contentlocation.html#cfn-kinesisanalyticsv2-application-s3contentlocation-objectversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::Application.SqlApplicationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.SqlApplicationConfiguration`\n\nDescribes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-sqlapplicationconfiguration.html", "Properties": { "Inputs": { "MarkdownDocumentation": "`Inputs`\n\nThe array of [Input](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_Input.html) objects describing the\ninput streams used by the application.\n*Required*: No\n*Type*: Array of [Input](./aws-properties-kinesisanalyticsv2-application-input.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-sqlapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-sqlapplicationconfiguration-inputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Input", "DuplicatesAllowed": true } } }, "AWS::KinesisAnalyticsV2::Application.VpcConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.VpcConfiguration`\n\nDescribes the parameters of a VPC used by the application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-vpcconfiguration.html", "Properties": { "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe array of [SecurityGroup](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html)\nIDs used by the VPC configuration.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-vpcconfiguration.html#cfn-kinesisanalyticsv2-application-vpcconfiguration-securitygroupids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe array of [Subnet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs\nused by the VPC configuration.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-vpcconfiguration.html#cfn-kinesisanalyticsv2-application-vpcconfiguration-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::KinesisAnalyticsV2::Application.ZeppelinApplicationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ZeppelinApplicationConfiguration`\n\nThe configuration of a Kinesis Data Analytics Studio notebook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-zeppelinapplicationconfiguration.html", "Properties": { "CatalogConfiguration": { "MarkdownDocumentation": "`CatalogConfiguration`\n\nThe Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics\nStudio notebook.\n*Required*: No\n*Type*: [CatalogConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-zeppelinapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-zeppelinapplicationconfiguration-catalogconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CatalogConfiguration" }, "MonitoringConfiguration": { "MarkdownDocumentation": "`MonitoringConfiguration`\n\nThe monitoring configuration of a Kinesis Data Analytics Studio notebook.\n*Required*: No\n*Type*: [ZeppelinMonitoringConfiguration](./aws-properties-kinesisanalyticsv2-application-zeppelinmonitoringconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-zeppelinapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-zeppelinapplicationconfiguration-monitoringconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ZeppelinMonitoringConfiguration" }, "DeployAsApplicationConfiguration": { "MarkdownDocumentation": "`DeployAsApplicationConfiguration`\n\nThe information required to deploy a Kinesis Data Analytics Studio notebook as an\napplication with durable state.\n*Required*: No\n*Type*: [DeployAsApplicationConfiguration](./aws-properties-kinesisanalyticsv2-application-deployasapplicationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-zeppelinapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-zeppelinapplicationconfiguration-deployasapplicationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DeployAsApplicationConfiguration" }, "CustomArtifactsConfiguration": { "MarkdownDocumentation": "`CustomArtifactsConfiguration`\n\nA list of `CustomArtifactConfiguration` objects.\n*Required*: No\n*Type*: Array of [CustomArtifactConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-zeppelinapplicationconfiguration.html#cfn-kinesisanalyticsv2-application-zeppelinapplicationconfiguration-customartifactsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomArtifactConfiguration", "DuplicatesAllowed": true } } }, "AWS::KinesisAnalyticsV2::Application.ZeppelinMonitoringConfiguration": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application.ZeppelinMonitoringConfiguration`\n\nDescribes configuration parameters for Amazon CloudWatch logging for a Kinesis Data\nAnalytics Studio notebook. For more information about CloudWatch logging, see [Monitoring](https://docs.aws.amazon.com/managed-flink/latest/java/monitoring-overview.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-zeppelinmonitoringconfiguration.html", "Properties": { "LogLevel": { "MarkdownDocumentation": "`LogLevel`\n\nThe verbosity of the CloudWatch Logs for an application. You can set it to\n`INFO`, `WARN`, `ERROR`, or\n`DEBUG`.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEBUG | INFO | WARN | ERROR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEBUG", "INFO", "WARN", "ERROR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-zeppelinmonitoringconfiguration.html#cfn-kinesisanalyticsv2-application-zeppelinmonitoringconfiguration-loglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption.CloudWatchLoggingOption": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption.CloudWatchLoggingOption`\n\nProvides a description of Amazon CloudWatch logging options, including the log stream\nAmazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption.html", "Properties": { "LogStreamARN": { "Required": true, "MarkdownDocumentation": "`LogStreamARN`\n\nThe ARN of the CloudWatch log to receive application messages.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption.html#cfn-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption-logstreamarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationOutput.DestinationSchema": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationOutput.DestinationSchema`\n\nDescribes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-destinationschema.html", "Properties": { "RecordFormatType": { "Required": false, "MarkdownDocumentation": "`RecordFormatType`\n\nSpecifies the format of the records on the output stream.\n*Required*: No\n*Type*: String\n*Allowed values*: `JSON | CSV`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "JSON", "CSV" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-destinationschema.html#cfn-kinesisanalyticsv2-applicationoutput-destinationschema-recordformattype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisFirehoseOutput": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisFirehoseOutput`\n\nFor a SQL-based Kinesis Data Analytics application, when configuring application\noutput, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the\nstream Amazon Resource Name (ARN) of the delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nThe ARN of the destination delivery stream to write to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisStreamsOutput": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisStreamsOutput`\n\nWhen you configure a SQL-based Kinesis Data Analytics application's output,\nidentifies a Kinesis data stream as the destination. You provide the stream Amazon Resource\nName (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nThe ARN of the destination Kinesis data stream to write to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationOutput.LambdaOutput": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationOutput.LambdaOutput`\n\nWhen you configure a SQL-based Kinesis Data Analytics application's output,\nidentifies an Amazon Lambda function as the destination. You provide the function Amazon Resource\nName (ARN) of the Lambda function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-lambdaoutput.html", "Properties": { "ResourceARN": { "Required": true, "MarkdownDocumentation": "`ResourceARN`\n\nThe Amazon Resource Name (ARN) of the destination Lambda function to write to.\n###### Note\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see [Example ARNs: Amazon Lambda](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda)\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-lambdaoutput.html#cfn-kinesisanalyticsv2-applicationoutput-lambdaoutput-resourcearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationOutput.Output": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationOutput.Output`\n\nDescribes a SQL-based Kinesis Data Analytics application's output configuration,\nin which you identify an in-application stream and a destination where you want the\nin-application stream data to be written. The destination can be a Kinesis data stream or a\nKinesis Data Firehose delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html", "Properties": { "DestinationSchema": { "Type": "DestinationSchema", "Required": true, "MarkdownDocumentation": "`DestinationSchema`\n\nDescribes the data format when records are written to the destination.\n*Required*: Yes\n*Type*: [DestinationSchema](./aws-properties-kinesisanalyticsv2-applicationoutput-destinationschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-destinationschema", "UpdateType": "Mutable" }, "LambdaOutput": { "Type": "LambdaOutput", "Required": false, "MarkdownDocumentation": "`LambdaOutput`\n\nIdentifies an Amazon Lambda function as the destination.\n*Required*: No\n*Type*: [LambdaOutput](./aws-properties-kinesisanalyticsv2-applicationoutput-lambdaoutput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-lambdaoutput", "UpdateType": "Mutable" }, "KinesisFirehoseOutput": { "Type": "KinesisFirehoseOutput", "Required": false, "MarkdownDocumentation": "`KinesisFirehoseOutput`\n\nIdentifies a Kinesis Data Firehose delivery stream as the destination.\n*Required*: No\n*Type*: [KinesisFirehoseOutput](./aws-properties-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-kinesisfirehoseoutput", "UpdateType": "Mutable" }, "KinesisStreamsOutput": { "Type": "KinesisStreamsOutput", "Required": false, "MarkdownDocumentation": "`KinesisStreamsOutput`\n\nIdentifies a Kinesis data stream\nas the destination.\n*Required*: No\n*Type*: [KinesisStreamsOutput](./aws-properties-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-kinesisstreamsoutput", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the in-application stream.\n*Required*: No\n*Type*: String\n*Pattern*: `[^-\\s<>&]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html#cfn-kinesisanalyticsv2-applicationoutput-output-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.CSVMappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.CSVMappingParameters`\n\nFor a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record\nformat uses delimiters, such as CSV. For example, the following sample records use CSV format,\nwhere the records use the *'\\n'* as the row delimiter and a comma (\",\") as\nthe column delimiter:\n`\"name1\", \"address1\"`\n`\"name2\", \"address2\"`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters.html", "Properties": { "RecordRowDelimiter": { "Required": true, "MarkdownDocumentation": "`RecordRowDelimiter`\n\nThe row delimiter. For example, in a CSV format, *'\\n'* is the typical\nrow delimiter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters-recordrowdelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RecordColumnDelimiter": { "Required": true, "MarkdownDocumentation": "`RecordColumnDelimiter`\n\nThe column delimiter. For example, in a CSV format, a comma (\",\") is the typical column\ndelimiter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters-recordcolumndelimiter", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.JSONMappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.JSONMappingParameters`\n\nFor a SQL-based Kinesis Data Analytics application, provides additional mapping\ninformation when JSON is the record format on the streaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-jsonmappingparameters.html", "Properties": { "RecordRowPath": { "Required": true, "MarkdownDocumentation": "`RecordRowPath`\n\nThe path to the top-level parent that contains the records.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=^\\$)(?=^\\S+$).*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-jsonmappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-jsonmappingparameters-recordrowpath", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.MappingParameters": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.MappingParameters`\n\nWhen you configure a SQL-based Kinesis Data Analytics application's input at the\ntime of creating or updating an application, provides additional mapping information specific\nto the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the\nstreaming source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters.html", "Properties": { "JSONMappingParameters": { "Type": "JSONMappingParameters", "Required": false, "MarkdownDocumentation": "`JSONMappingParameters`\n\nProvides additional mapping information when JSON is the record format on the streaming source.\n*Required*: No\n*Type*: [JSONMappingParameters](./aws-properties-kinesisanalyticsv2-applicationreferencedatasource-jsonmappingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters-jsonmappingparameters", "UpdateType": "Mutable" }, "CSVMappingParameters": { "Type": "CSVMappingParameters", "Required": false, "MarkdownDocumentation": "`CSVMappingParameters`\n\nProvides additional mapping information when the record format uses delimiters\n(for example, CSV).\n*Required*: No\n*Type*: [CSVMappingParameters](./aws-properties-kinesisanalyticsv2-applicationreferencedatasource-csvmappingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-mappingparameters-csvmappingparameters", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordColumn": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordColumn`\n\nFor a SQL-based Kinesis Data Analytics application, describes the mapping of each\ndata element in the streaming source to the corresponding column in the in-application\nstream.\nAlso used to describe the format of the reference data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html", "Properties": { "Mapping": { "Required": false, "MarkdownDocumentation": "`Mapping`\n\nA reference to the data element in the streaming input or the reference data\nsource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn-mapping", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SqlType": { "Required": true, "MarkdownDocumentation": "`SqlType`\n\nThe type of column created in the in-application input stream or reference table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn-sqltype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the column that is created in the in-application input stream or reference\ntable.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^-\\s<>&]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordFormat": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordFormat`\n\nFor a SQL-based Kinesis Data Analytics application, describes the record format\nand relevant mapping information that should be applied to schematize the records on the\nstream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordformat.html", "Properties": { "MappingParameters": { "Type": "MappingParameters", "Required": false, "MarkdownDocumentation": "`MappingParameters`\n\nWhen you configure application input at the time of creating or updating an application,\nprovides additional mapping information specific to the record format (such as JSON, CSV, or\nrecord fields delimited by some delimiter) on the streaming source.\n*Required*: No\n*Type*: [MappingParameters](./aws-properties-kinesisanalyticsv2-applicationreferencedatasource-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordformat.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordformat-mappingparameters", "UpdateType": "Mutable" }, "RecordFormatType": { "Required": true, "MarkdownDocumentation": "`RecordFormatType`\n\nThe type of record format.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `JSON | CSV`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "JSON", "CSV" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordformat.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-recordformat-recordformattype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceDataSource": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceDataSource`\n\nFor a SQL-based Kinesis Data Analytics application, describes the reference data\nsource by providing the source information (Amazon S3 bucket name and object key name), the\nresulting in-application table name that is created, and the necessary schema to map the data\nelements in the Amazon S3 object to the in-application table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html", "Properties": { "ReferenceSchema": { "Type": "ReferenceSchema", "Required": true, "MarkdownDocumentation": "`ReferenceSchema`\n\nDescribes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.\n*Required*: Yes\n*Type*: [ReferenceSchema](./aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-referenceschema", "UpdateType": "Mutable" }, "TableName": { "Required": false, "MarkdownDocumentation": "`TableName`\n\nThe name of the in-application table to create.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-tablename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "S3ReferenceDataSource": { "Type": "S3ReferenceDataSource", "Required": false, "MarkdownDocumentation": "`S3ReferenceDataSource`\n\nIdentifies the S3 bucket and object that contains the reference data. A Kinesis Data\nAnalytics application loads reference data only once. If the data changes, you call the\n[UpdateApplication](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_UpdateApplication.html) operation to trigger reloading of data into your\napplication.\n*Required*: No\n*Type*: [S3ReferenceDataSource](./aws-properties-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-s3referencedatasource", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceSchema": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceSchema`\n\nFor a SQL-based Kinesis Data Analytics application, describes the format of the\ndata in the streaming source, and how each data element maps to corresponding columns created\nin the in-application stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html", "Properties": { "RecordEncoding": { "Required": false, "MarkdownDocumentation": "`RecordEncoding`\n\nSpecifies the encoding of the records in the streaming source. For example, UTF-8.\n*Required*: No\n*Type*: String\n*Pattern*: `UTF-8`\n*Minimum*: `5`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referenceschema-recordencoding", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RecordColumns": { "Type": "List", "Required": true, "MarkdownDocumentation": "`RecordColumns`\n\nA list of `RecordColumn` objects.\n*Required*: Yes\n*Type*: Array of [RecordColumn](./aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referenceschema-recordcolumns", "ItemType": "RecordColumn", "UpdateType": "Mutable" }, "RecordFormat": { "Type": "RecordFormat", "Required": true, "MarkdownDocumentation": "`RecordFormat`\n\nSpecifies the format of the records on the streaming source.\n*Required*: Yes\n*Type*: [RecordFormat](./aws-properties-kinesisanalyticsv2-applicationreferencedatasource-recordformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referenceschema-recordformat", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.S3ReferenceDataSource": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.S3ReferenceDataSource`\n\nFor an SQL-based Amazon Kinesis Data Analytics application, identifies the Amazon S3\nbucket and object that contains the reference data.\nA Kinesis Data Analytics application loads reference data only once. If the data\nchanges, you call the [UpdateApplication](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_UpdateApplication.html) operation to trigger reloading of data into your\napplication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource.html", "Properties": { "BucketARN": { "Required": true, "MarkdownDocumentation": "`BucketARN`\n\nThe Amazon Resource Name (ARN) of the S3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource-bucketarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FileKey": { "Required": true, "MarkdownDocumentation": "`FileKey`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-s3referencedatasource-filekey", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessBufferingHints": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessBufferingHints`\n\nDescribes the buffering to perform before delivering data to the Serverless offering for\nAmazon OpenSearch Service destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html", "Properties": { "IntervalInSeconds": { "MarkdownDocumentation": "`IntervalInSeconds`\n\nBuffer incoming data for the specified period of time, in seconds, before delivering it\nto the destination. The default value is 300 (5 minutes).\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-intervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SizeInMBs": { "MarkdownDocumentation": "`SizeInMBs`\n\nBuffer incoming data to the specified size, in MBs, before delivering it to the\ndestination. The default value is 5.\nWe recommend setting this parameter to a value greater than the amount of data you\ntypically ingest into the Firehose stream in 10 seconds. For example, if you typically\ningest 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-sizeinmbs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration`\n\nDescribes the configuration of a destination in the Serverless offering for Amazon\nOpenSearch Service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe Serverless offering for Amazon OpenSearch Service index name.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-indexname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3DestinationConfiguration" }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nThe buffering options. If no value is specified, the default values for\nAmazonopensearchserviceBufferingHints are used.\n*Required*: No\n*Type*: [AmazonOpenSearchServerlessBufferingHints](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "AmazonOpenSearchServerlessBufferingHints" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nThe retry behavior in case Firehose is unable to deliver documents to the\nServerless offering for Amazon OpenSearch Service. The default value is 300 (5\nminutes).\n*Required*: No\n*Type*: [AmazonOpenSearchServerlessRetryOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "AmazonOpenSearchServerlessRetryOptions" }, "CollectionEndpoint": { "MarkdownDocumentation": "`CollectionEndpoint`\n\nThe endpoint to use when communicating with the collection in the Serverless offering\nfor Amazon OpenSearch Service.\n*Required*: No\n*Type*: String\n*Pattern*: `https:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-collectionendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [VpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-vpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfiguration" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose\nfor calling the Serverless offering for Amazon OpenSearch Service Configuration API and for\nindexing documents.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3BackupMode": { "MarkdownDocumentation": "`S3BackupMode`\n\nDefines how documents should be delivered to Amazon S3. When it is set to\nFailedDocumentsOnly, Firehose writes any documents that could not be indexed\nto the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to\nthe key prefix. When set to AllDocuments, Firehose delivers all incoming\nrecords to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/\nappended to the prefix.\n*Required*: No\n*Type*: String\n*Allowed values*: `FailedDocumentsOnly | AllDo...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FailedDocumentsOnly", "AllDocuments" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessRetryOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessRetryOptions`\n\nConfigures retry behavior in case Firehose is unable to deliver documents\nto the Serverless offering for Amazon OpenSearch Service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.html", "Properties": { "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nAfter an initial failure to deliver to the Serverless offering for Amazon OpenSearch\nService, the total amount of time during which Firehose retries delivery\n(including the first attempt). After this time has elapsed, the failed documents are\nwritten to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-durationinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.AmazonopensearchserviceBufferingHints": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.AmazonopensearchserviceBufferingHints`\n\nDescribes the buffering to perform before delivering data to the Amazon OpenSearch\nService destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints.html", "Properties": { "IntervalInSeconds": { "MarkdownDocumentation": "`IntervalInSeconds`\n\nBuffer incoming data for the specified period of time, in seconds, before delivering it\nto the destination. The default value is 300 (5 minutes).\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-intervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SizeInMBs": { "MarkdownDocumentation": "`SizeInMBs`\n\nBuffer incoming data to the specified size, in MBs, before delivering it to the\ndestination. The default value is 5. We recommend setting this parameter to a value greater\nthan the amount of data you typically ingest into the delivery stream in 10 seconds. For\nexample, if you typically ingest data at 1 MB/sec, the value should be 10 MB or\nhigher.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-sizeinmbs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.AmazonopensearchserviceDestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.AmazonopensearchserviceDestinationConfiguration`\n\nDescribes the configuration of a destination in Amazon OpenSearch Service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html", "Properties": { "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe Amazon OpenSearch Service type name.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-typename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IndexRotationPeriod": { "MarkdownDocumentation": "`IndexRotationPeriod`\n\nThe Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp\nto the IndexName to facilitate the expiration of old data.\n*Required*: No\n*Type*: String\n*Allowed values*: `NoRotation | OneHour | OneD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NoRotation", "OneHour", "OneDay", "OneWeek", "OneMonth" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexrotationperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nDescribes a data processing configuration.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "ClusterEndpoint": { "MarkdownDocumentation": "`ClusterEndpoint`\n\nThe endpoint to use when communicating with the cluster. Specify either this\nClusterEndpoint or the DomainARN field.\n*Required*: No\n*Type*: String\n*Pattern*: `https:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-clusterendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainARN": { "MarkdownDocumentation": "`DomainARN`\n\nThe ARN of the Amazon OpenSearch Service domain.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-domainarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose\nfor calling the Amazon OpenSearch Service Configuration API and for indexing\ndocuments.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3BackupMode": { "MarkdownDocumentation": "`S3BackupMode`\n\nDefines how documents should be delivered to Amazon S3.\n*Required*: No\n*Type*: String\n*Allowed values*: `FailedDocumentsOnly | AllDo...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FailedDocumentsOnly", "AllDocuments" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe Amazon OpenSearch Service index name.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DocumentIdOptions": { "MarkdownDocumentation": "`DocumentIdOptions`\n\nIndicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.\n*Required*: No\n*Type*: [DocumentIdOptions](./aws-properties-kinesisfirehose-deliverystream-documentidoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-documentidoptions", "UpdateType": "Mutable", "Required": false, "Type": "DocumentIdOptions" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nDescribes the configuration of a destination in Amazon S3.\n*Required*: Yes\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3DestinationConfiguration" }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nThe buffering options. If no value is specified, the default values for\nAmazonopensearchserviceBufferingHints are used.\n*Required*: No\n*Type*: [AmazonopensearchserviceBufferingHints](./aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "AmazonopensearchserviceBufferingHints" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nThe retry behavior in case Kinesis Data Firehose is unable to deliver documents to\nAmazon OpenSearch Service. The default value is 300 (5 minutes).\n*Required*: No\n*Type*: [AmazonopensearchserviceRetryOptions](./aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "AmazonopensearchserviceRetryOptions" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nThe details of the VPC of the Amazon OpenSearch Service destination.\n*Required*: No\n*Type*: [VpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-vpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfiguration" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nDescribes the Amazon CloudWatch logging options for your delivery stream.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" } } }, "AWS::KinesisFirehose::DeliveryStream.AmazonopensearchserviceRetryOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.AmazonopensearchserviceRetryOptions`\n\nConfigures retry behavior in case Kinesis Data Firehose is unable to deliver documents\nto Amazon OpenSearch Service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions.html", "Properties": { "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nAfter an initial failure to deliver to Amazon OpenSearch Service, the total amount of\ntime during which Kinesis Data Firehose retries delivery (including the first attempt).\nAfter this time has elapsed, the failed documents are written to Amazon S3. Default value\nis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-durationinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.AuthenticationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.AuthenticationConfiguration`\n\nThe authentication configuration of the Amazon MSK cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration.html", "Properties": { "Connectivity": { "MarkdownDocumentation": "`Connectivity`\n\nThe type of connectivity used to access the Amazon MSK cluster.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PUBLIC | PRIVATE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PUBLIC", "PRIVATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration.html#cfn-kinesisfirehose-deliverystream-authenticationconfiguration-connectivity", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe ARN of the role used to access the Amazon MSK cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration.html#cfn-kinesisfirehose-deliverystream-authenticationconfiguration-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.BufferingHints": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.BufferingHints`\n\nThe `BufferingHints` property type specifies how Amazon Kinesis Data\nFirehose (Kinesis Data Firehose) buffers incoming data before delivering it to the\ndestination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to\ndeliver the data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html", "Properties": { "IntervalInSeconds": { "MarkdownDocumentation": "`IntervalInSeconds`\n\nThe length of time, in seconds, that Kinesis Data Firehose buffers incoming data\nbefore delivering it to the destination. For valid values, see the\n`IntervalInSeconds` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data\ntype in the *Amazon Kinesis Data Firehose API Reference*.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-intervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SizeInMBs": { "MarkdownDocumentation": "`SizeInMBs`\n\nThe size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data\nbefore delivering it to the destination. For valid values, see the `SizeInMBs`\ncontent for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data\ntype in the *Amazon Kinesis Data Firehose API Reference*.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-sizeinmbs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.CatalogConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.CatalogConfiguration`\n\nDescribes the containers where the destination Apache Iceberg Tables are persisted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-catalogconfiguration.html", "Properties": { "CatalogArn": { "MarkdownDocumentation": "`CatalogArn`\n\nSpecifies the Glue catalog ARN identifier of the destination Apache Iceberg Tables. You must specify the ARN in the format `arn:aws:glue:region:account-id:catalog`.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-catalogconfiguration.html#cfn-kinesisfirehose-deliverystream-catalogconfiguration-catalogarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "WarehouseLocation": { "MarkdownDocumentation": "`WarehouseLocation`\n\nThe warehouse location for Apache Iceberg tables. You must configure this when schema\nevolution and table creation is enabled.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: String\n*Pattern*: `s3:\\/\\/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-catalogconfiguration.html#cfn-kinesisfirehose-deliverystream-catalogconfiguration-warehouselocation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions`\n\nThe `CloudWatchLoggingOptions` property type specifies Amazon CloudWatch\nLogs (CloudWatch Logs) logging options that Amazon Kinesis Data Firehose (Kinesis Data\nFirehose) uses for the delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html", "Properties": { "LogStreamName": { "MarkdownDocumentation": "`LogStreamName`\n\nThe name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send\nlogs about data delivery.\nConditional. If you enable logging, you must specify this property.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[^:*]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-logstreamname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether CloudWatch Logs logging 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe name of the CloudWatch Logs log group that contains the log stream that Kinesis\nData Firehose will use.\nConditional. If you enable logging, you must specify this property.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[\\.\\-_/#A-Za-z0-9]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-loggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.CopyCommand": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.CopyCommand`\n\nThe `CopyCommand` property type configures the Amazon Redshift\n`COPY` command that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses\nto load data into an Amazon Redshift cluster from an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html", "Properties": { "DataTableName": { "MarkdownDocumentation": "`DataTableName`\n\nThe name of the target table. The table must already exist in the database.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CopyOptions": { "MarkdownDocumentation": "`CopyOptions`\n\nParameters to use with the Amazon Redshift `COPY` command. For examples, see\nthe `CopyOptions` content for the [CopyCommand](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CopyCommand.html) data type in\nthe *Amazon Kinesis Data Firehose API Reference*.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `204800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-copyoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataTableColumns": { "MarkdownDocumentation": "`DataTableColumns`\n\nA comma-separated list of column names.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `204800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration`\n\nSpecifies that you want Kinesis Data Firehose to convert data from the JSON format to\nthe Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the\nserializer and deserializer that you specify, in addition to the column information from\nthe AWS Glue table, to deserialize your input data from JSON and then\nserialize it to the Parquet or ORC format. For more information, see [Kinesis\nData Firehose Record Format Conversion](https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html", "Properties": { "InputFormatConfiguration": { "MarkdownDocumentation": "`InputFormatConfiguration`\n\nSpecifies the deserializer that you want Firehose to use to convert the\nformat of your data from JSON. This parameter is required if `Enabled` is set to\ntrue.\n*Required*: No\n*Type*: [InputFormatConfiguration](./aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-inputformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InputFormatConfiguration" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nDefaults to `true`. Set it to `false` if you want to disable\nformat conversion while preserving the configuration details.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SchemaConfiguration": { "MarkdownDocumentation": "`SchemaConfiguration`\n\nSpecifies the AWS Glue Data Catalog table that contains the column\ninformation. This parameter is required if `Enabled` is set to true.\n*Required*: No\n*Type*: [SchemaConfiguration](./aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-schemaconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SchemaConfiguration" }, "OutputFormatConfiguration": { "MarkdownDocumentation": "`OutputFormatConfiguration`\n\nSpecifies the serializer that you want Firehose to use to convert the\nformat of your data to the Parquet or ORC format. This parameter is required if\n`Enabled` is set to true.\n*Required*: No\n*Type*: [OutputFormatConfiguration](./aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-outputformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "OutputFormatConfiguration" } } }, "AWS::KinesisFirehose::DeliveryStream.DatabaseColumns": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DatabaseColumns`\n\nThe `DatabaseColumns` property type specifies Property description not available. for an [AWS::KinesisFirehose::DeliveryStream](./aws-resource-kinesisfirehose-deliverystream.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasecolumns.html", "Properties": { "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasecolumns.html#cfn-kinesisfirehose-deliverystream-databasecolumns-exclude", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Include": { "MarkdownDocumentation": "`Include`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasecolumns.html#cfn-kinesisfirehose-deliverystream-databasecolumns-include", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::KinesisFirehose::DeliveryStream.DatabaseSourceAuthenticationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DatabaseSourceAuthenticationConfiguration`\n\nThe structure to configure the authentication methods for Firehose to connect to source database endpoint.\nAmazon Data Firehose is in preview release and is subject to change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration.html", "Properties": { "SecretsManagerConfiguration": { "MarkdownDocumentation": "`SecretsManagerConfiguration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [SecretsManagerConfiguration](./aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration-secretsmanagerconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "SecretsManagerConfiguration" } } }, "AWS::KinesisFirehose::DeliveryStream.DatabaseSourceConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DatabaseSourceConfiguration`\n\nThe top level object for configuring streams with database as a source.\nAmazon Data Firehose is in preview release and is subject to change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html", "Properties": { "Digest": { "MarkdownDocumentation": "`Digest`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-digest", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port of the database. This can be one of the following values.\n* 3306 for MySQL database type\n* 5432 for PostgreSQL database type\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-port", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "PublicCertificate": { "MarkdownDocumentation": "`PublicCertificate`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-publiccertificate", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe list of column patterns in source database endpoint for Firehose to read from.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: [DatabaseColumns](./aws-properties-kinesisfirehose-deliverystream-databasecolumns.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-columns", "UpdateType": "Immutable", "Required": false, "Type": "DatabaseColumns" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of database engine. This can be one of the following values.\n* MySQL\n* PostgreSQL\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MySQL | PostgreSQL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "MySQL", "PostgreSQL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SurrogateKeys": { "MarkdownDocumentation": "`SurrogateKeys`\n\nThe optional list of table and column names used as unique key columns when taking snapshot if the tables don\u2019t have primary keys configured.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-surrogatekeys", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Databases": { "MarkdownDocumentation": "`Databases`\n\nThe list of database patterns in source database endpoint for Firehose to read from.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\n*Type*: [Databases](./aws-properties-kinesisfirehose-deliverystream-databases.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databases", "UpdateType": "Immutable", "Required": true, "Type": "Databases" }, "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint of the database server.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-endpoint", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SSLMode": { "MarkdownDocumentation": "`SSLMode`\n\nThe mode to enable or disable SSL when Firehose connects to the database endpoint.\nAmazon Data Firehose is in preview release and is subject to change.\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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-sslmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SnapshotWatermarkTable": { "MarkdownDocumentation": "`SnapshotWatermarkTable`\n\nThe fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0001-\\uFFFF]*`\n*Minimum*: `1`\n*Maximum*: `129`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-snapshotwatermarktable", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DatabaseSourceAuthenticationConfiguration": { "MarkdownDocumentation": "`DatabaseSourceAuthenticationConfiguration`\n\nThe structure to configure the authentication methods for Firehose to connect to source database endpoint.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\n*Type*: [DatabaseSourceAuthenticationConfiguration](./aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourceauthenticationconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "DatabaseSourceAuthenticationConfiguration" }, "Tables": { "MarkdownDocumentation": "`Tables`\n\nThe list of table patterns in source database endpoint for Firehose to read from.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\n*Type*: [DatabaseTables](./aws-properties-kinesisfirehose-deliverystream-databasetables.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-tables", "UpdateType": "Immutable", "Required": true, "Type": "DatabaseTables" }, "DatabaseSourceVPCConfiguration": { "MarkdownDocumentation": "`DatabaseSourceVPCConfiguration`\n\nThe details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\n*Type*: [DatabaseSourceVPCConfiguration](./aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourcevpcconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "DatabaseSourceVPCConfiguration" } } }, "AWS::KinesisFirehose::DeliveryStream.DatabaseSourceVPCConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DatabaseSourceVPCConfiguration`\n\nThe structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.\nAmazon Data Firehose is in preview release and is subject to change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration.html", "Properties": { "VpcEndpointServiceName": { "MarkdownDocumentation": "`VpcEndpointServiceName`\n\nThe VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle `firehose.amazonaws.com` as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like `com.amazonaws.vpce..`.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([a-zA-Z0-9\\-\\_]+\\.){2,3}vpce\\.[a-zA-Z0-9\\-]*\\.vpce-svc\\-[a-zA-Z0-9\\-]{17}$`\n*Minimum*: `47`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-vpcendpointservicename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.DatabaseTables": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DatabaseTables`\n\nThe `DatabaseTables` property type specifies Property description not available. for an [AWS::KinesisFirehose::DeliveryStream](./aws-resource-kinesisfirehose-deliverystream.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasetables.html", "Properties": { "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasetables.html#cfn-kinesisfirehose-deliverystream-databasetables-exclude", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Include": { "MarkdownDocumentation": "`Include`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasetables.html#cfn-kinesisfirehose-deliverystream-databasetables-include", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::KinesisFirehose::DeliveryStream.Databases": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.Databases`\n\nThe `Databases` property type specifies Property description not available. for an [AWS::KinesisFirehose::DeliveryStream](./aws-resource-kinesisfirehose-deliverystream.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databases.html", "Properties": { "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databases.html#cfn-kinesisfirehose-deliverystream-databases-exclude", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Include": { "MarkdownDocumentation": "`Include`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databases.html#cfn-kinesisfirehose-deliverystream-databases-include", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::KinesisFirehose::DeliveryStream.DeliveryStreamEncryptionConfigurationInput": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DeliveryStreamEncryptionConfigurationInput`\n\nSpecifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side\nEncryption (SSE).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html", "Properties": { "KeyType": { "MarkdownDocumentation": "`KeyType`\n\nIndicates the type of customer master key (CMK) to use for encryption. The default\nsetting is `AWS_OWNED_CMK`. For more information about CMKs, see [Customer\nMaster Keys (CMKs)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys).\nYou can use a CMK of type CUSTOMER\\_MANAGED\\_CMK to encrypt up to 500 delivery\nstreams.\n###### Important\nTo encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't\nsupport asymmetric CMKs. For information about symmetric and asymmetric CMKs, see [About\nSymmetric and Asymmetric CMKs](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html) in the AWS Key Management\nService developer guide.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS_OWNED_CMK | CUSTOMER_MA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS_OWNED_CMK", "CUSTOMER_MANAGED_CMK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyARN": { "MarkdownDocumentation": "`KeyARN`\n\nIf you set `KeyType` to `CUSTOMER_MANAGED_CMK`, you must specify\nthe Amazon Resource Name (ARN) of the CMK. If you set `KeyType` to `AWS_OWNED_CMK`, Firehose uses a service-account CMK.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.Deserializer": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.Deserializer`\n\nThe deserializer you want Kinesis Data Firehose to use for converting the input data\nfrom JSON. Kinesis Data Firehose then serializes the data to its final format using the\n`Serializer`. Kinesis Data Firehose supports two types of deserializers: the\n[Apache Hive JSON SerDe](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON) and the [OpenX JSON SerDe](https://github.com/rcongiu/Hive-JSON-Serde).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html", "Properties": { "HiveJsonSerDe": { "MarkdownDocumentation": "`HiveJsonSerDe`\n\nThe native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing\ndata, which means converting it from the JSON format in preparation for serializing it to\nthe Parquet or ORC format. This is one of two deserializers you can choose, depending on\nwhich one offers the functionality you need. The other option is the OpenX SerDe.\n*Required*: No\n*Type*: [HiveJsonSerDe](./aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-hivejsonserde", "UpdateType": "Mutable", "Required": false, "Type": "HiveJsonSerDe" }, "OpenXJsonSerDe": { "MarkdownDocumentation": "`OpenXJsonSerDe`\n\nThe OpenX SerDe. Used by Firehose for deserializing data, which means\nconverting it from the JSON format in preparation for serializing it to the Parquet or ORC\nformat. This is one of two deserializers you can choose, depending on which one offers the\nfunctionality you need. The other option is the native Hive / HCatalog JsonSerDe.\n*Required*: No\n*Type*: [OpenXJsonSerDe](./aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-openxjsonserde", "UpdateType": "Mutable", "Required": false, "Type": "OpenXJsonSerDe" } } }, "AWS::KinesisFirehose::DeliveryStream.DestinationTableConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DestinationTableConfiguration`\n\nDescribes the configuration of a destination in Apache Iceberg Tables. This section is only needed for tables where you want to update or delete data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration.html", "Properties": { "DestinationDatabaseName": { "MarkdownDocumentation": "`DestinationDatabaseName`\n\nThe name of the Apache Iceberg database.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration.html#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-destinationdatabasename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3ErrorOutputPrefix": { "MarkdownDocumentation": "`S3ErrorOutputPrefix`\n\nThe table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration.html#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-s3erroroutputprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationTableName": { "MarkdownDocumentation": "`DestinationTableName`\n\nSpecifies the name of the Apache Iceberg Table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration.html#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-destinationtablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UniqueKeys": { "MarkdownDocumentation": "`UniqueKeys`\n\nA list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create, Update, or Delete operations on the given Iceberg table.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration.html#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-uniquekeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PartitionSpec": { "MarkdownDocumentation": "`PartitionSpec`\n\nThe partition spec configuration for a table that is used by automatic table\ncreation.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: [PartitionSpec](./aws-properties-kinesisfirehose-deliverystream-partitionspec.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration.html#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-partitionspec", "UpdateType": "Mutable", "Required": false, "Type": "PartitionSpec" } } }, "AWS::KinesisFirehose::DeliveryStream.DirectPutSourceConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DirectPutSourceConfiguration`\n\nThe structure that configures parameters such as `ThroughputHintInMBs` for a stream configured with\nDirect PUT as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration.html", "Properties": { "ThroughputHintInMBs": { "MarkdownDocumentation": "`ThroughputHintInMBs`\n\nThe value that you configure for this parameter is for information purpose only and\ndoes not affect Firehose delivery throughput limit. You can use the [Firehose Limits form](https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits) to request a throughput limit increase.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-directputsourceconfiguration-throughputhintinmbs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.DocumentIdOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DocumentIdOptions`\n\nIndicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-documentidoptions.html", "Properties": { "DefaultDocumentIdFormat": { "MarkdownDocumentation": "`DefaultDocumentIdFormat`\n\nWhen the `FIREHOSE_DEFAULT` option is chosen, Firehose generates\na unique document ID for each record based on a unique internal identifier. The generated\ndocument ID is stable across multiple delivery attempts, which helps prevent the same\nrecord from being indexed multiple times with different document IDs.\nWhen the `NO_DOCUMENT_ID` option is chosen, Firehose does not\ninclude any document IDs in the requests it sends to the Amazon OpenSearch Service. This\ncauses the Amazon OpenSearch Service domain to generate document IDs. In case of multiple\ndelivery attempts, this may cause the same record to be indexed more than once with\ndifferent document IDs. This option enables write-heavy operations, such as the ingestion\nof logs and observability data, to consume less resources in the Amazon OpenSearch Service\ndomain, resulting in improved performance.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIREHOSE_DEFAULT | NO_DOCUM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIREHOSE_DEFAULT", "NO_DOCUMENT_ID" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-documentidoptions.html#cfn-kinesisfirehose-deliverystream-documentidoptions-defaultdocumentidformat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.DynamicPartitioningConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.DynamicPartitioningConfiguration`\n\nThe `DynamicPartitioningConfiguration` property type specifies the\nconfiguration of the dynamic partitioning mechanism that creates targeted data sets from\nthe streaming data by partitioning it based on partition keys.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether dynamic partitioning is enabled for this Kinesis Data Firehose\ndelivery stream.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration.html#cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nSpecifies the retry behavior in case Kinesis Data Firehose is unable to deliver data\nto an Amazon S3 prefix.\n*Required*: No\n*Type*: [RetryOptions](./aws-properties-kinesisfirehose-deliverystream-retryoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration.html#cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "RetryOptions" } } }, "AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints`\n\nThe `ElasticsearchBufferingHints` property type specifies how Amazon\nKinesis Data Firehose (Kinesis Data Firehose) buffers incoming data while delivering it to\nthe destination. The first buffer condition that is satisfied triggers Kinesis Data\nFirehose to deliver the data.\nElasticsearchBufferingHints is the property type for the `BufferingHints`\nproperty of the [Amazon Kinesis Data Firehose DeliveryStream\nElasticsearchDestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html", "Properties": { "IntervalInSeconds": { "MarkdownDocumentation": "`IntervalInSeconds`\n\nThe length of time, in seconds, that Kinesis Data Firehose buffers incoming data\nbefore delivering it to the destination. For valid values, see the\n`IntervalInSeconds` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data\ntype in the *Amazon Kinesis Data Firehose API Reference*.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SizeInMBs": { "MarkdownDocumentation": "`SizeInMBs`\n\nThe size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data\nbefore delivering it to the destination. For valid values, see the `SizeInMBs`\ncontent for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data\ntype in the *Amazon Kinesis Data Firehose API Reference*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration`\n\nThe `ElasticsearchDestinationConfiguration` property type specifies an Amazon\nElasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data\nFirehose) delivers data to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html", "Properties": { "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe Elasticsearch type name that Amazon ES adds to documents when indexing\ndata.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IndexRotationPeriod": { "MarkdownDocumentation": "`IndexRotationPeriod`\n\nThe frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis\nData Firehose appends a portion of the UTC arrival timestamp to the specified index name,\nand rotates the appended timestamp accordingly. For more information, see [Index Rotation for the Amazon ES Destination](https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation) in the *Amazon Kinesis\nData Firehose Developer Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `NoRotation | OneHour | OneD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NoRotation", "OneHour", "OneDay", "OneWeek", "OneMonth" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nThe data processing configuration for the Kinesis Data Firehose delivery\nstream.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "ClusterEndpoint": { "MarkdownDocumentation": "`ClusterEndpoint`\n\nThe endpoint to use when communicating with the cluster. Specify either this\n`ClusterEndpoint` or the `DomainARN` field.\n*Required*: No\n*Type*: String\n*Pattern*: `https:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-clusterendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainARN": { "MarkdownDocumentation": "`DomainARN`\n\nThe ARN of the Amazon ES domain. The IAM role must have permissions for\n`DescribeElasticsearchDomain`, `DescribeElasticsearchDomains`, and\n`DescribeElasticsearchDomainConfig` after assuming the role specified in\n**RoleARN**.\nSpecify either `ClusterEndpoint` or `DomainARN`.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose\nfor calling the Amazon ES Configuration API and for indexing documents. For more\ninformation, see [Controlling Access with Amazon Kinesis\nData Firehose](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3BackupMode": { "MarkdownDocumentation": "`S3BackupMode`\n\nThe condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage\nService (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents\nthat Kinesis Data Firehose could not deliver to the Amazon ES destination. For more\ninformation and valid values, see the `S3BackupMode` content for the [ElasticsearchDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationConfiguration.html) data type in the *Amazon Kinesis\nData Firehose API Reference*.\n*Required*: No\n*Type*: String\n*Allowed values*: `FailedDocumentsOnly | AllDo...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FailedDocumentsOnly", "AllDocuments" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the Elasticsearch index to which Kinesis Data Firehose adds data for\nindexing.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DocumentIdOptions": { "MarkdownDocumentation": "`DocumentIdOptions`\n\nIndicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.\n*Required*: No\n*Type*: [DocumentIdOptions](./aws-properties-kinesisfirehose-deliverystream-documentidoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-documentidoptions", "UpdateType": "Mutable", "Required": false, "Type": "DocumentIdOptions" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nThe S3 bucket where Kinesis Data Firehose backs up incoming data.\n*Required*: Yes\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3DestinationConfiguration" }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nConfigures how Kinesis Data Firehose buffers incoming data while delivering it to the\nAmazon ES domain.\n*Required*: No\n*Type*: [ElasticsearchBufferingHints](./aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "ElasticsearchBufferingHints" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nThe retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon\nES.\n*Required*: No\n*Type*: [ElasticsearchRetryOptions](./aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "ElasticsearchRetryOptions" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nThe details of the VPC of the Amazon ES destination.\n*Required*: No\n*Type*: [VpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-vpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfiguration" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nThe Amazon CloudWatch Logs logging options for the delivery stream.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" } } }, "AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions`\n\nThe `ElasticsearchRetryOptions` property type configures the retry behavior\nfor when Amazon Kinesis Data Firehose (Kinesis Data Firehose) can't deliver data to Amazon\nElasticsearch Service (Amazon ES).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html", "Properties": { "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nAfter an initial failure to deliver to Amazon ES, the total amount of time during which\nKinesis Data Firehose re-attempts delivery (including the first attempt). If Kinesis Data\nFirehose can't deliver the data within the specified time, it writes the data to the backup\nS3 bucket. For valid values, see the `DurationInSeconds` content for the [ElasticsearchRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchRetryOptions.html) data type in the *Amazon Kinesis Data\nFirehose API Reference*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html#cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration`\n\nThe `EncryptionConfiguration` property type specifies the encryption\nsettings that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses when delivering\ndata to Amazon Simple Storage Service (Amazon S3).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html", "Properties": { "KMSEncryptionConfig": { "MarkdownDocumentation": "`KMSEncryptionConfig`\n\nThe AWS Key Management Service (AWS KMS) encryption\nkey that Amazon S3 uses to encrypt your data.\n*Required*: No\n*Type*: [KMSEncryptionConfig](./aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-kmsencryptionconfig", "UpdateType": "Mutable", "Required": false, "Type": "KMSEncryptionConfig" }, "NoEncryptionConfig": { "MarkdownDocumentation": "`NoEncryptionConfig`\n\nDisables encryption. For valid values, see the `NoEncryptionConfig`\ncontent for the [EncryptionConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_EncryptionConfiguration.html) data type in the *Amazon Kinesis Data Firehose\nAPI Reference*.\n*Required*: No\n*Type*: String\n*Allowed values*: `NoEncryption...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NoEncryption" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-noencryptionconfig", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration`\n\nThe `ExtendedS3DestinationConfiguration` property type configures an\nAmazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html", "Properties": { "ErrorOutputPrefix": { "MarkdownDocumentation": "`ErrorOutputPrefix`\n\nA prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\nthem to S3. This prefix appears immediately following the bucket name. For information\nabout how to specify this prefix, see [Custom Prefixes for Amazon S3\nObjects](https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-erroroutputprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3BackupConfiguration": { "MarkdownDocumentation": "`S3BackupConfiguration`\n\nThe configuration for backup in Amazon S3.\n*Required*: No\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "S3DestinationConfiguration" }, "BucketARN": { "MarkdownDocumentation": "`BucketARN`\n\nThe Amazon Resource Name (ARN) of the Amazon S3 bucket. For constraints, see [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data\nFirehose API Reference*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CompressionFormat": { "MarkdownDocumentation": "`CompressionFormat`\n\nThe compression format. If no value is specified, the default is\n`UNCOMPRESSED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNCOMPRESSED | GZIP | ZIP |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-compressionformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataFormatConversionConfiguration": { "MarkdownDocumentation": "`DataFormatConversionConfiguration`\n\nThe serializer, deserializer, and schema for converting data from the JSON format to\nthe Parquet or ORC format before writing it to Amazon S3.\n*Required*: No\n*Type*: [DataFormatConversionConfiguration](./aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dataformatconversionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DataFormatConversionConfiguration" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption configuration for the Kinesis Data Firehose delivery stream. The default\nvalue is `NoEncryption`.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-kinesisfirehose-deliverystream-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfiguration" }, "CustomTimeZone": { "MarkdownDocumentation": "`CustomTimeZone`\n\nThe time zone you prefer. UTC is the default.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-customtimezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DynamicPartitioningConfiguration": { "MarkdownDocumentation": "`DynamicPartitioningConfiguration`\n\nThe configuration of the dynamic partitioning mechanism that creates targeted data\nsets from the streaming data by partitioning it based on partition keys.\n*Required*: No\n*Type*: [DynamicPartitioningConfiguration](./aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dynamicpartitioningconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DynamicPartitioningConfiguration" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe `YYYY/MM/DD/HH` time format prefix is automatically used for delivered\nAmazon S3 files. For more information, see [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data\nFirehose API Reference*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nThe data processing configuration for the Kinesis Data Firehose delivery\nstream.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe Amazon Resource Name (ARN) of the AWS credentials. For constraints,\nsee [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data\nFirehose API Reference*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3BackupMode": { "MarkdownDocumentation": "`S3BackupMode`\n\nThe Amazon S3 backup mode. After you create a Firehose stream, you can update it to\nenable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the\nFirehose stream to disable it.\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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nThe buffering option.\n*Required*: No\n*Type*: [BufferingHints](./aws-properties-kinesisfirehose-deliverystream-bufferinghints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "BufferingHints" }, "FileExtension": { "MarkdownDocumentation": "`FileExtension`\n\nSpecify a file extension. It will override the default file extension\n*Required*: No\n*Type*: String\n*Pattern*: `^$|\\.[0-9a-z!\\-_.*'()]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-fileextension", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nThe Amazon CloudWatch logging options for your Firehose stream.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" } } }, "AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe`\n\nThe native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing\ndata, which means converting it from the JSON format in preparation for serializing it to\nthe Parquet or ORC format. This is one of two deserializers you can choose, depending on\nwhich one offers the functionality you need. The other option is the OpenX SerDe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html", "Properties": { "TimestampFormats": { "MarkdownDocumentation": "`TimestampFormats`\n\nIndicates how you want Firehose to parse the date and timestamps that\nmay be present in your input data JSON. To specify these format strings, follow the pattern\nsyntax of JodaTime's DateTimeFormat format strings. For more information, see [Class DateTimeFormat](https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html). You can also use the special value `millis` to\nparse timestamps in epoch milliseconds. If you don't specify a format, Firehose uses `java.sql.Timestamp::valueOf` by default.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html#cfn-kinesisfirehose-deliverystream-hivejsonserde-timestampformats", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::KinesisFirehose::DeliveryStream.HttpEndpointCommonAttribute": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.HttpEndpointCommonAttribute`\n\nDescribes the metadata that's delivered to the specified HTTP endpoint destination.\nKinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported\nthird-party service providers, including Datadog, MongoDB, and New Relic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html", "Properties": { "AttributeValue": { "MarkdownDocumentation": "`AttributeValue`\n\nThe value of the HTTP endpoint common attribute.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributevalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AttributeName": { "MarkdownDocumentation": "`AttributeName`\n\nThe name of the HTTP endpoint common attribute.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.HttpEndpointConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.HttpEndpointConfiguration`\n\nDescribes the configuration of the HTTP endpoint to which Kinesis Firehose delivers\ndata. Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by\nsupported third-party service providers, including Datadog, MongoDB, and New Relic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html", "Properties": { "AccessKey": { "MarkdownDocumentation": "`AccessKey`\n\nThe access key required for Kinesis Firehose to authenticate with the HTTP endpoint\nselected as the destination.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-accesskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL of the HTTP endpoint selected as the destination.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the HTTP endpoint selected as the destination.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.HttpEndpointDestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.HttpEndpointDestinationConfiguration`\n\nDescribes the configuration of the HTTP endpoint destination. Kinesis Firehose\nsupports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service\nproviders, including Datadog, MongoDB, and New Relic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html", "Properties": { "RequestConfiguration": { "MarkdownDocumentation": "`RequestConfiguration`\n\nThe configuration of the request sent to the HTTP endpoint specified as the\ndestination.\n*Required*: No\n*Type*: [HttpEndpointRequestConfiguration](./aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-requestconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HttpEndpointRequestConfiguration" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nDescribes the configuration of a destination in Amazon S3.\n*Required*: Yes\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3DestinationConfiguration" }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nThe buffering options that can be used before data is delivered to the specified\ndestination. Kinesis Data Firehose treats these options as hints, and it might choose to\nuse more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional.\nHowever, if you specify a value for one of them, you must also provide a value for the\nother.\n*Required*: No\n*Type*: [BufferingHints](./aws-properties-kinesisfirehose-deliverystream-bufferinghints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "BufferingHints" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nDescribes the retry behavior in case Kinesis Data Firehose is unable to deliver data\nto the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment\nof receipt from the specified HTTP endpoint destination.\n*Required*: No\n*Type*: [RetryOptions](./aws-properties-kinesisfirehose-deliverystream-retryoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "RetryOptions" }, "SecretsManagerConfiguration": { "MarkdownDocumentation": "`SecretsManagerConfiguration`\n\nThe configuration that defines how you access secrets for HTTP Endpoint destination.\n*Required*: No\n*Type*: [SecretsManagerConfiguration](./aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-secretsmanagerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SecretsManagerConfiguration" }, "EndpointConfiguration": { "MarkdownDocumentation": "`EndpointConfiguration`\n\nThe configuration of the HTTP endpoint selected as the destination.\n*Required*: Yes\n*Type*: [HttpEndpointConfiguration](./aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-endpointconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "HttpEndpointConfiguration" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nDescribes the data processing configuration.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nKinesis Data Firehose uses this IAM role for all the permissions that the delivery\nstream needs.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nDescribes the Amazon CloudWatch logging options for your delivery stream.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" }, "S3BackupMode": { "MarkdownDocumentation": "`S3BackupMode`\n\nDescribes the S3 bucket backup options for the data that Kinesis Data Firehose\ndelivers to the HTTP endpoint destination. You can back up all documents (AllData) or only\nthe documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint\ndestination (FailedDataOnly).\n*Required*: No\n*Type*: String\n*Allowed values*: `FailedDataOnly | AllData...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FailedDataOnly", "AllData" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.HttpEndpointRequestConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.HttpEndpointRequestConfiguration`\n\nThe configuration of the HTTP endpoint request. Kinesis Firehose supports any custom\nHTTP endpoint or HTTP endpoints owned by supported third-party service providers, including\nDatadog, MongoDB, and New Relic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html", "Properties": { "CommonAttributes": { "MarkdownDocumentation": "`CommonAttributes`\n\nDescribes the metadata sent to the HTTP endpoint destination.\n*Required*: No\n*Type*: Array of [HttpEndpointCommonAttribute](./aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-commonattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HttpEndpointCommonAttribute", "DuplicatesAllowed": false }, "ContentEncoding": { "MarkdownDocumentation": "`ContentEncoding`\n\nKinesis Data Firehose uses the content encoding to compress the body of a request\nbefore sending the request to the destination. For more information, see Content-Encoding\nin MDN Web Docs, the official Mozilla documentation.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | GZIP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "GZIP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-contentencoding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.IcebergDestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.IcebergDestinationConfiguration`\n\nSpecifies the destination configure settings for Apache Iceberg Table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html", "Properties": { "CatalogConfiguration": { "MarkdownDocumentation": "`CatalogConfiguration`\n\nConfiguration describing where the destination Apache Iceberg Tables are persisted.\n*Required*: Yes\n*Type*: [CatalogConfiguration](./aws-properties-kinesisfirehose-deliverystream-catalogconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-catalogconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "CatalogConfiguration" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3DestinationConfiguration" }, "DestinationTableConfigurationList": { "MarkdownDocumentation": "`DestinationTableConfigurationList`\n\nProvides a list of `DestinationTableConfigurations` which Firehose uses\nto deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.\n*Required*: No\n*Type*: Array of [DestinationTableConfiguration](./aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-destinationtableconfigurationlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DestinationTableConfiguration", "DuplicatesAllowed": true }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nProperty description not available.\n*Required*: No\n*Type*: [BufferingHints](./aws-properties-kinesisfirehose-deliverystream-bufferinghints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "BufferingHints" }, "TableCreationConfiguration": { "MarkdownDocumentation": "`TableCreationConfiguration`\n\nThe configuration to enable automatic table creation.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: [TableCreationConfiguration](./aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-tablecreationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableCreationConfiguration" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [RetryOptions](./aws-properties-kinesisfirehose-deliverystream-retryoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "RetryOptions" }, "s3BackupMode": { "MarkdownDocumentation": "`s3BackupMode`\n\nDescribes how Firehose will backup records. Currently,S3 backup only supports\n`FailedDataOnly`.\n*Required*: No\n*Type*: String\n*Allowed values*: `AllData | FailedDataOnly...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AllData", "FailedDataOnly" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "SchemaEvolutionConfiguration": { "MarkdownDocumentation": "`SchemaEvolutionConfiguration`\n\nThe configuration to enable automatic schema evolution.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: [SchemaEvolutionConfiguration](./aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-schemaevolutionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SchemaEvolutionConfiguration" }, "AppendOnly": { "MarkdownDocumentation": "`AppendOnly`\n\nDescribes whether all incoming data for this delivery stream will be append only\n(inserts only and not for updates and deletes) for Iceberg delivery. This feature is only\napplicable for Apache Iceberg Tables.\nThe default value is false. If you set this value to true, Firehose automatically\nincreases the throughput limit of a stream based on the throttling levels of the stream. If\nyou set this parameter to true for a stream with updates and deletes, you will see out of\norder delivery.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-appendonly", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration`\n\nSpecifies the deserializer you want to use to convert the format of the input data.\nThis parameter is required if `Enabled` is set to true.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.html", "Properties": { "Deserializer": { "MarkdownDocumentation": "`Deserializer`\n\nSpecifies which deserializer to use. You can choose either the Apache Hive JSON SerDe\nor the OpenX JSON SerDe. If both are non-null, the server rejects the request.\n*Required*: No\n*Type*: [Deserializer](./aws-properties-kinesisfirehose-deliverystream-deserializer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.html#cfn-kinesisfirehose-deliverystream-inputformatconfiguration-deserializer", "UpdateType": "Mutable", "Required": false, "Type": "Deserializer" } } }, "AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig`\n\nThe `KMSEncryptionConfig` property type specifies the AWS\nKey Management Service (AWS KMS) encryption key that Amazon Simple Storage\nService (Amazon S3) uses to encrypt data delivered by the Amazon Kinesis Data Firehose\n(Kinesis Data Firehose) stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html", "Properties": { "AWSKMSKeyARN": { "MarkdownDocumentation": "`AWSKMSKeyARN`\n\nThe Amazon Resource Name (ARN) of the AWS KMS encryption key that\nAmazon S3 uses to encrypt data delivered by the Kinesis Data Firehose stream. The key must\nbelong to the same region as the destination S3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*:kms:[a-zA-Z0-9\\-]+:\\d{12}:(key|alias)/[a-zA-Z_0-9+=,.@\\-_/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html#cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration`\n\nThe `KinesisStreamSourceConfiguration` property type specifies the stream and\nrole Amazon Resource Names (ARNs) for a Kinesis stream used as the source for a delivery\nstream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html", "Properties": { "KinesisStreamARN": { "MarkdownDocumentation": "`KinesisStreamARN`\n\nThe ARN of the source Kinesis data stream.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe ARN of the role that provides access to the source Kinesis data stream.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.MSKSourceConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.MSKSourceConfiguration`\n\nThe configuration for the Amazon MSK cluster to be used as the source for a delivery\nstream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html", "Properties": { "AuthenticationConfiguration": { "MarkdownDocumentation": "`AuthenticationConfiguration`\n\nThe authentication configuration of the Amazon MSK cluster.\n*Required*: Yes\n*Type*: [AuthenticationConfiguration](./aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-authenticationconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "AuthenticationConfiguration" }, "ReadFromTimestamp": { "MarkdownDocumentation": "`ReadFromTimestamp`\n\nThe start date and time in UTC for the offset position within your MSK topic from where\nFirehose begins to read. By default, this is set to timestamp when Firehose becomes Active.\nIf you want to create a Firehose stream with Earliest start position from SDK or CLI,\nyou need to set the `ReadFromTimestamp` parameter to Epoch\n(1970-01-01T00:00:00Z).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-readfromtimestamp", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MSKClusterARN": { "MarkdownDocumentation": "`MSKClusterARN`\n\nThe ARN of the Amazon MSK cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-mskclusterarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TopicName": { "MarkdownDocumentation": "`TopicName`\n\nThe topic name within the Amazon MSK cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\._\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-topicname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe`\n\nThe OpenX SerDe. Used by Firehose for deserializing data, which means\nconverting it from the JSON format in preparation for serializing it to the Parquet or ORC\nformat. This is one of two deserializers you can choose, depending on which one offers the\nfunctionality you need. The other option is the native Hive / HCatalog JsonSerDe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html", "Properties": { "ConvertDotsInJsonKeysToUnderscores": { "MarkdownDocumentation": "`ConvertDotsInJsonKeysToUnderscores`\n\nWhen set to `true`, specifies that the names of the keys include dots and\nthat you want Firehose to replace them with underscores. This is useful\nbecause Apache Hive does not allow dots in column names. For example, if the JSON contains\na key whose name is \"a.b\", you can define the column name to be \"a\\_b\" when using this\noption.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-convertdotsinjsonkeystounderscores", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ColumnToJsonKeyMappings": { "MarkdownDocumentation": "`ColumnToJsonKeyMappings`\n\nMaps column names to JSON keys that aren't identical to the column names. This is\nuseful when the JSON contains keys that are Hive keywords. For example,\n`timestamp` is a Hive keyword. If you have a JSON key named\n`timestamp`, set this parameter to `{\"ts\": \"timestamp\"}` to map\nthis key to a column named `ts`.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-columntojsonkeymappings", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "CaseInsensitive": { "MarkdownDocumentation": "`CaseInsensitive`\n\nWhen set to `true`, which is the default, Firehose converts\nJSON keys to lowercase before deserializing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-caseinsensitive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::KinesisFirehose::DeliveryStream.OrcSerDe": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.OrcSerDe`\n\nA serializer to use for converting data to the ORC format before storing it in Amazon\nS3. For more information, see [Apache\nORC](https://orc.apache.org/docs/).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html", "Properties": { "PaddingTolerance": { "MarkdownDocumentation": "`PaddingTolerance`\n\nA number between 0 and 1 that defines the tolerance for block padding as a decimal\nfraction of stripe size. The default value is 0.05, which means 5 percent of stripe\nsize.\nFor the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block\npadding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB\nblock. In such a case, if the available size within the block is more than 3.2 MiB, a new,\nsmaller stripe is inserted to fit within that space. This ensures that no stripe crosses\nblock boundaries and causes remote reads within a node-local task.\nKinesis Data Firehose ignores this parameter when `EnablePadding` is\n`false`.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-paddingtolerance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Compression": { "MarkdownDocumentation": "`Compression`\n\nThe compression code to use over data blocks. The default is `SNAPPY`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | ZLIB | SNAPPY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "ZLIB", "SNAPPY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-compression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StripeSizeBytes": { "MarkdownDocumentation": "`StripeSizeBytes`\n\nThe number of bytes in each stripe. The default is 64 MiB and the minimum is 8\nMiB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `8388608`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-stripesizebytes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "BloomFilterColumns": { "MarkdownDocumentation": "`BloomFilterColumns`\n\nThe column names for which you want Firehose to create bloom filters. The\ndefault is `null`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfiltercolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "BloomFilterFalsePositiveProbability": { "MarkdownDocumentation": "`BloomFilterFalsePositiveProbability`\n\nThe Bloom filter false positive probability (FPP). The lower the FPP, the bigger the\nBloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-bloomfilterfalsepositiveprobability", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "EnablePadding": { "MarkdownDocumentation": "`EnablePadding`\n\nSet this to `true` to indicate that you want stripes to be padded to the HDFS\nblock boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS\nbefore querying. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-enablepadding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FormatVersion": { "MarkdownDocumentation": "`FormatVersion`\n\nThe version of the file to write. The possible values are `V0_11` and\n`V0_12`. The default is `V0_12`.\n*Required*: No\n*Type*: String\n*Allowed values*: `V0_11 | V0_12...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "V0_11", "V0_12" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-formatversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowIndexStride": { "MarkdownDocumentation": "`RowIndexStride`\n\nThe number of rows between index entries. The default is 10,000 and the minimum is\n1,000.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-rowindexstride", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "BlockSizeBytes": { "MarkdownDocumentation": "`BlockSizeBytes`\n\nThe Hadoop Distributed File System (HDFS) block size. This is useful if you intend to\ncopy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the\nminimum is 64 MiB. Firehose uses this value for padding calculations.\n*Required*: No\n*Type*: Integer\n*Minimum*: `67108864`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-blocksizebytes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DictionaryKeyThreshold": { "MarkdownDocumentation": "`DictionaryKeyThreshold`\n\nRepresents the fraction of the total number of non-null rows. To turn off dictionary\nencoding, set this fraction to a number that is less than the number of distinct keys in a\ndictionary. To always use dictionary encoding, set this threshold to 1.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-dictionarykeythreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration`\n\nSpecifies the serializer that you want Firehose to use to convert the\nformat of your data before it writes it to Amazon S3. This parameter is required if\n`Enabled` is set to true.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.html", "Properties": { "Serializer": { "MarkdownDocumentation": "`Serializer`\n\nSpecifies which serializer to use. You can choose either the ORC SerDe or the Parquet\nSerDe. If both are non-null, the server rejects the request.\n*Required*: No\n*Type*: [Serializer](./aws-properties-kinesisfirehose-deliverystream-serializer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.html#cfn-kinesisfirehose-deliverystream-outputformatconfiguration-serializer", "UpdateType": "Mutable", "Required": false, "Type": "Serializer" } } }, "AWS::KinesisFirehose::DeliveryStream.ParquetSerDe": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.ParquetSerDe`\n\nA serializer to use for converting data to the Parquet format before storing it in\nAmazon S3. For more information, see [Apache Parquet](https://parquet.apache.org/docs/).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html", "Properties": { "Compression": { "MarkdownDocumentation": "`Compression`\n\nThe compression code to use over data blocks. The possible values are\n`UNCOMPRESSED`, `SNAPPY`, and `GZIP`, with the default\nbeing `SNAPPY`. Use `SNAPPY` for higher decompression speed. Use\n`GZIP` if the compression ratio is more important than speed.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNCOMPRESSED | GZIP | SNAPP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNCOMPRESSED", "GZIP", "SNAPPY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-compression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlockSizeBytes": { "MarkdownDocumentation": "`BlockSizeBytes`\n\nThe Hadoop Distributed File System (HDFS) block size. This is useful if you intend to\ncopy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the\nminimum is 64 MiB. Firehose uses this value for padding calculations.\n*Required*: No\n*Type*: Integer\n*Minimum*: `67108864`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-blocksizebytes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnableDictionaryCompression": { "MarkdownDocumentation": "`EnableDictionaryCompression`\n\nIndicates whether to enable dictionary compression.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-enabledictionarycompression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PageSizeBytes": { "MarkdownDocumentation": "`PageSizeBytes`\n\nThe Parquet page size. Column chunks are divided into pages. A page is conceptually an\nindivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and\nthe default is 1 MiB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `65536`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-pagesizebytes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxPaddingBytes": { "MarkdownDocumentation": "`MaxPaddingBytes`\n\nThe maximum amount of padding to apply. This is useful if you intend to copy the data\nfrom Amazon S3 to HDFS before querying. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-maxpaddingbytes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "WriterVersion": { "MarkdownDocumentation": "`WriterVersion`\n\nIndicates the version of row format to output. The possible values are `V1`\nand `V2`. The default is `V1`.\n*Required*: No\n*Type*: String\n*Allowed values*: `V1 | V2`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "V1", "V2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-writerversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.PartitionField": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.PartitionField`\n\nRepresents a single field in a `PartitionSpec`.\nAmazon Data Firehose is in preview release and is subject to change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-partitionfield.html", "Properties": { "SourceName": { "MarkdownDocumentation": "`SourceName`\n\nThe column name to be configured in partition spec.\nAmazon Data Firehose is in preview release and is subject to change.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-partitionfield.html#cfn-kinesisfirehose-deliverystream-partitionfield-sourcename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.PartitionSpec": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.PartitionSpec`\n\nRepresents how to produce partition data for a table. Partition data is produced by\ntransforming columns in a table. Each column transform is represented by a named\n`PartitionField`.\nHere is an example of the schema in JSON.\n`\"partitionSpec\": { \"identity\": [ {\"sourceName\": \"column1\"}, {\"sourceName\":\n\"column2\"}, {\"sourceName\": \"column3\"} ] }`\nAmazon Data Firehose is in preview release and is subject to change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-partitionspec.html", "Properties": { "Identity": { "MarkdownDocumentation": "`Identity`\n\nList of identity [transforms](https://iceberg.apache.org/spec/#partition-transforms) that performs an identity transformation. The transform takes the\nsource value, and does not modify it. Result type is the source type.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: Array of [PartitionField](./aws-properties-kinesisfirehose-deliverystream-partitionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-partitionspec.html#cfn-kinesisfirehose-deliverystream-partitionspec-identity", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PartitionField", "DuplicatesAllowed": false } } }, "AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration`\n\nThe `ProcessingConfiguration` property configures data processing for an\nAmazon Kinesis Data Firehose delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether data processing is enabled (true) or disabled (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Processors": { "MarkdownDocumentation": "`Processors`\n\nThe data processors.\n*Required*: No\n*Type*: Array of [Processor](./aws-properties-kinesisfirehose-deliverystream-processor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-processors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Processor", "DuplicatesAllowed": false } } }, "AWS::KinesisFirehose::DeliveryStream.Processor": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.Processor`\n\nThe `Processor` property specifies a data processor for an Amazon Kinesis\nData Firehose delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of processor. Valid values: `Lambda`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RecordDeAggregation | Decom...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RecordDeAggregation", "Decompression", "CloudWatchLogProcessing", "Lambda", "MetadataExtraction", "AppendDelimiterToRecord" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe processor parameters.\n*Required*: No\n*Type*: Array of [ProcessorParameter](./aws-properties-kinesisfirehose-deliverystream-processorparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ProcessorParameter", "DuplicatesAllowed": false } } }, "AWS::KinesisFirehose::DeliveryStream.ProcessorParameter": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.ProcessorParameter`\n\nThe `ProcessorParameter` property specifies a processor parameter in a data\nprocessor for an Amazon Kinesis Data Firehose delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nThe parameter value.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$).+`\n*Minimum*: `1`\n*Maximum*: `5120`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe name of the parameter. Currently the following default values are supported: 3\nfor `NumberOfRetries` and 60 for the `BufferIntervalInSeconds`. The\n`BufferSizeInMBs` ranges between 0.2 MB and up to 3MB. The default buffering\nhint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is\n256 KB.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LambdaArn | NumberOfRetries...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LambdaArn", "NumberOfRetries", "MetadataExtractionQuery", "JsonParsingEngine", "RoleArn", "BufferSizeInMBs", "BufferIntervalInSeconds", "SubRecordType", "Delimiter", "CompressionFormat", "DataMessageExtraction" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration`\n\nThe `RedshiftDestinationConfiguration` property type specifies an Amazon\nRedshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers\ndata.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html", "Properties": { "S3BackupConfiguration": { "MarkdownDocumentation": "`S3BackupConfiguration`\n\nThe configuration for backup in Amazon S3.\n*Required*: No\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "S3DestinationConfiguration" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nThe S3 bucket where Kinesis Data Firehose first delivers data. After the data is in the\nbucket, Kinesis Data Firehose uses the `COPY` command to load the data into the\nAmazon Redshift cluster. For the Amazon S3 bucket's compression format, don't specify\n`SNAPPY` or `ZIP` because the Amazon Redshift `COPY`\ncommand doesn't support them.\n*Required*: Yes\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3DestinationConfiguration" }, "Username": { "MarkdownDocumentation": "`Username`\n\nThe Amazon Redshift user that has permission to access the Amazon Redshift cluster.\nThis user must have `INSERT` privileges for copying data from the Amazon S3\nbucket to the cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CopyCommand": { "MarkdownDocumentation": "`CopyCommand`\n\nConfigures the Amazon Redshift `COPY` command that Kinesis Data Firehose uses\nto load data into the cluster from the Amazon S3 bucket.\n*Required*: Yes\n*Type*: [CopyCommand](./aws-properties-kinesisfirehose-deliverystream-copycommand.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand", "UpdateType": "Mutable", "Required": true, "Type": "CopyCommand" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nThe retry behavior in case Firehose is unable to deliver documents to\nAmazon Redshift. Default value is 3600 (60 minutes).\n*Required*: No\n*Type*: [RedshiftRetryOptions](./aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftRetryOptions" }, "SecretsManagerConfiguration": { "MarkdownDocumentation": "`SecretsManagerConfiguration`\n\nThe configuration that defines how you access secrets for Amazon Redshift.\n*Required*: No\n*Type*: [SecretsManagerConfiguration](./aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-secretsmanagerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SecretsManagerConfiguration" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nThe data processing configuration for the Kinesis Data Firehose delivery\nstream.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nThe CloudWatch logging options for your Firehose stream.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" }, "ClusterJDBCURL": { "MarkdownDocumentation": "`ClusterJDBCURL`\n\nThe connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift\ncluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe ARN of the AWS Identity and Access Management (IAM) role that\ngrants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS\n(if you enable data encryption). For more information, see [Grant Kinesis Data\nFirehose Access to an Amazon Redshift Destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-rs) in the *Amazon\nKinesis Data Firehose Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password for the Amazon Redshift user that you specified in the\n`Username` property.\n*Required*: No\n*Type*: String\n*Minimum*: `6`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3BackupMode": { "MarkdownDocumentation": "`S3BackupMode`\n\nThe Amazon S3 backup mode. After you create a Firehose stream, you can update it to\nenable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the\nFirehose stream to disable it.\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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.RedshiftRetryOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.RedshiftRetryOptions`\n\nConfigures retry behavior in case Firehose is unable to deliver\ndocuments to Amazon Redshift.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.html", "Properties": { "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nThe length of time during which Firehose retries delivery after a\nfailure, starting from the initial request and including the first attempt. The default\nvalue is 3600 seconds (60 minutes). Firehose does not retry if the value of\n`DurationInSeconds` is 0 (zero) or if the first delivery attempt takes longer\nthan the current value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.html#cfn-kinesisfirehose-deliverystream-redshiftretryoptions-durationinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.RetryOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.RetryOptions`\n\nDescribes the retry behavior in case Kinesis Data Firehose is unable to deliver data\nto the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment\nof receipt from the specified HTTP endpoint destination. Kinesis Firehose supports any\ncustom HTTP endpoint or HTTP endpoints owned by supported third-party service providers,\nincluding Datadog, MongoDB, and New Relic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-retryoptions.html", "Properties": { "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nThe total amount of time that Kinesis Data Firehose spends on retries. This duration\nstarts after the initial attempt to send data to the custom destination via HTTPS endpoint\nfails. It doesn't include the periods during which Kinesis Data Firehose waits for\nacknowledgment from the specified destination after each attempt.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-retryoptions.html#cfn-kinesisfirehose-deliverystream-retryoptions-durationinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration`\n\nThe `S3DestinationConfiguration` property type specifies an Amazon Simple\nStorage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data\nFirehose) delivers data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html", "Properties": { "ErrorOutputPrefix": { "MarkdownDocumentation": "`ErrorOutputPrefix`\n\nA prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\nthem to S3. This prefix appears immediately following the bucket name. For information\nabout how to specify this prefix, see [Custom Prefixes for Amazon S3\nObjects](https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-erroroutputprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketARN": { "MarkdownDocumentation": "`BucketARN`\n\nThe Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nConfigures how Kinesis Data Firehose buffers incoming data while delivering it to the\nAmazon S3 bucket.\n*Required*: No\n*Type*: [BufferingHints](./aws-properties-kinesisfirehose-deliverystream-bufferinghints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "BufferingHints" }, "CompressionFormat": { "MarkdownDocumentation": "`CompressionFormat`\n\nThe type of compression that Kinesis Data Firehose uses to compress the data that it\ndelivers to the Amazon S3 bucket. For valid values, see the `CompressionFormat`\ncontent for the [S3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html) data type in the *Amazon Kinesis Data\nFirehose API Reference*.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNCOMPRESSED | GZIP | ZIP |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nConfigures Amazon Simple Storage Service (Amazon S3) server-side encryption. Kinesis\nData Firehose uses AWS Key Management Service (AWS KMS)\nto encrypt the data that it delivers to your Amazon S3 bucket.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-kinesisfirehose-deliverystream-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfiguration" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nA prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3\nbucket. The prefix helps you identify the files that Kinesis Data Firehose\ndelivered.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nThe CloudWatch logging options for your Firehose stream.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe ARN of an AWS Identity and Access Management (IAM) role that grants\nKinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you\nenable data encryption). For more information, see [Grant Kinesis Data\nFirehose Access to an Amazon S3 Destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) in the *Amazon Kinesis Data\nFirehose Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration`\n\nSpecifies the schema to which you want Firehose to configure your data\nbefore it writes it to Amazon S3. This parameter is required if `Enabled` is set\nto true.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html", "Properties": { "VersionId": { "MarkdownDocumentation": "`VersionId`\n\nSpecifies the table version for the output data schema. If you don't specify this\nversion ID, or if you set it to `LATEST`, Firehose uses the most\nrecent version. This means that any updates to the table are automatically picked\nup.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nSpecifies the AWS Glue table that contains the column information that\nconstitutes your data schema.\n###### Important\nIf the `SchemaConfiguration` request parameter is used as part of invoking\nthe `CreateDeliveryStream` API, then the `TableName` property is\nrequired and its value must be specified.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-tablename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nSpecifies the name of the AWS Glue database that contains the schema for\nthe output data.\n###### Important\nIf the `SchemaConfiguration` request parameter is used as part of invoking\nthe `CreateDeliveryStream` API, then the `DatabaseName` property\nis required and its value must be specified.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nIf you don't specify an AWS Region, the default is the current\nRegion.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe ID of the AWS Glue Data Catalog. If you don't supply this, the\nAWS account ID is used by default.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe role that Firehose can use to access AWS Glue. This\nrole must be in the same account you use for Firehose. Cross-account roles\naren't allowed.\n###### Important\nIf the `SchemaConfiguration` request parameter is used as part of invoking\nthe `CreateDeliveryStream` API, then the `RoleARN` property is\nrequired and its value must be specified.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.SchemaEvolutionConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SchemaEvolutionConfiguration`\n\nThe configuration to enable schema evolution.\nAmazon Data Firehose is in preview release and is subject to change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecify whether you want to enable schema evolution.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaevolutionconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::KinesisFirehose::DeliveryStream.SecretsManagerConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SecretsManagerConfiguration`\n\nThe structure that defines how Firehose accesses the secret.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html", "Properties": { "SecretARN": { "MarkdownDocumentation": "`SecretARN`\n\nThe ARN of the secret that stores your credentials. It must be in the same region as the\nFirehose stream and the role. The secret ARN can reside in a different account than the Firehose stream and role as Firehose supports cross-account secret access. This parameter is required when **Enabled** is set to `True`.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*:secretsmanager:[a-zA-Z0-9\\-]+:\\d{12}:secret:[a-zA-Z0-9\\-/_+=.@]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-secretarn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether you want to use the secrets manager feature. When set as\n`True` the secrets manager configuration overwrites the existing secrets in\nthe destination configuration. When it's set to `False` Firehose falls back to\nthe credentials in the destination configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-enabled", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "Boolean" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nSpecifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*:iam::\\d{12}:role/[a-zA-Z_0-9+=,.@\\-_/]+`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-rolearn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.Serializer": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.Serializer`\n\nThe serializer that you want Firehose to use to convert data to the target\nformat before writing it to Amazon S3. Firehose supports two types of\nserializers: the ORC SerDe and the Parquet SerDe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html", "Properties": { "OrcSerDe": { "MarkdownDocumentation": "`OrcSerDe`\n\nA serializer to use for converting data to the ORC format before storing it in Amazon\nS3. For more information, see [Apache\nORC](https://orc.apache.org/docs/).\n*Required*: No\n*Type*: [OrcSerDe](./aws-properties-kinesisfirehose-deliverystream-orcserde.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html#cfn-kinesisfirehose-deliverystream-serializer-orcserde", "UpdateType": "Mutable", "Required": false, "Type": "OrcSerDe" }, "ParquetSerDe": { "MarkdownDocumentation": "`ParquetSerDe`\n\nA serializer to use for converting data to the Parquet format before storing it in\nAmazon S3. For more information, see [Apache Parquet](https://parquet.apache.org/docs/contribution-guidelines/).\n*Required*: No\n*Type*: [ParquetSerDe](./aws-properties-kinesisfirehose-deliverystream-parquetserde.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-serializer.html#cfn-kinesisfirehose-deliverystream-serializer-parquetserde", "UpdateType": "Mutable", "Required": false, "Type": "ParquetSerDe" } } }, "AWS::KinesisFirehose::DeliveryStream.SnowflakeBufferingHints": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SnowflakeBufferingHints`\n\nDescribes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints.html", "Properties": { "IntervalInSeconds": { "MarkdownDocumentation": "`IntervalInSeconds`\n\nBuffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 0.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints.html#cfn-kinesisfirehose-deliverystream-snowflakebufferinghints-intervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SizeInMBs": { "MarkdownDocumentation": "`SizeInMBs`\n\nBuffer incoming data to the specified size, in MBs, before delivering it to the\ndestination. The default value is 128.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints.html#cfn-kinesisfirehose-deliverystream-snowflakebufferinghints-sizeinmbs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.SnowflakeDestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SnowflakeDestinationConfiguration`\n\nConfigure Snowflake destination\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html", "Properties": { "PrivateKey": { "MarkdownDocumentation": "`PrivateKey`\n\nThe private key used to encrypt your Snowflake client. For information, see [Using Key Pair Authentication & Key Rotation](https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation).\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$`\n*Minimum*: `256`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-privatekey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "User": { "MarkdownDocumentation": "`User`\n\nUser login name for the Snowflake account.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-user", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Table": { "MarkdownDocumentation": "`Table`\n\nAll data in Snowflake is stored in database tables, logically structured as collections of columns and rows.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-table", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SnowflakeVpcConfiguration": { "MarkdownDocumentation": "`SnowflakeVpcConfiguration`\n\nThe VPCE ID for Firehose to privately connect with Snowflake. The ID format is\ncom.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see [Amazon PrivateLink & Snowflake](https://docs.snowflake.com/en/user-guide/admin-security-privatelink)\n*Required*: No\n*Type*: [SnowflakeVpcConfiguration](./aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakevpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "SnowflakeVpcConfiguration" }, "DataLoadingOption": { "MarkdownDocumentation": "`DataLoadingOption`\n\nChoose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.\n*Required*: No\n*Type*: String\n*Allowed values*: `JSON_MAPPING | VARIANT_CONT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JSON_MAPPING", "VARIANT_CONTENT_MAPPING", "VARIANT_CONTENT_AND_METADATA_MAPPING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-dataloadingoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nEach database consists of one or more schemas, which are logical groupings of database objects, such as tables and views\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-schema", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContentColumnName": { "MarkdownDocumentation": "`ContentColumnName`\n\nThe name of the record content column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-contentcolumnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecretsManagerConfiguration": { "MarkdownDocumentation": "`SecretsManagerConfiguration`\n\nThe configuration that defines how you access secrets for Snowflake.\n*Required*: No\n*Type*: [SecretsManagerConfiguration](./aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-secretsmanagerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SecretsManagerConfiguration" }, "SnowflakeRoleConfiguration": { "MarkdownDocumentation": "`SnowflakeRoleConfiguration`\n\nOptionally configure a Snowflake role. Otherwise the default user role will be used.\n*Required*: No\n*Type*: [SnowflakeRoleConfiguration](./aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakeroleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeRoleConfiguration" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "AccountUrl": { "MarkdownDocumentation": "`AccountUrl`\n\nURL for accessing your Snowflake account. This URL must include your [account identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier).\nNote that the protocol (https://) and port number are optional.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.+?\\.snowflakecomputing\\.com`\n*Minimum*: `24`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-accounturl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe Amazon Resource Name (ARN) of the Snowflake role\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3BackupMode": { "MarkdownDocumentation": "`S3BackupMode`\n\nChoose an S3 backup mode\n*Required*: No\n*Type*: String\n*Allowed values*: `FailedDataOnly | AllData...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FailedDataOnly", "AllData" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3DestinationConfiguration" }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nDescribes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.\n*Required*: No\n*Type*: [SnowflakeBufferingHints](./aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeBufferingHints" }, "MetaDataColumnName": { "MarkdownDocumentation": "`MetaDataColumnName`\n\nSpecify a column name in the table, where the metadata information has to be loaded.\nWhen you enable this field, you will see the following column in the snowflake table, which\ndiffers based on the source type.\nFor Direct PUT as source\n`{ \"firehoseDeliveryStreamName\" : \"streamname\", \"IngestionTime\" : \"timestamp\"\n}`\nFor Kinesis Data Stream as source\n `\"kinesisStreamName\" : \"streamname\", \"kinesisShardId\" : \"Id\",\n\"kinesisPartitionKey\" : \"key\", \"kinesisSequenceNumber\" : \"1234\", \"subsequenceNumber\" :\n\"2334\", \"IngestionTime\" : \"timestamp\" }`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-metadatacolumnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Database": { "MarkdownDocumentation": "`Database`\n\nAll data in Snowflake is maintained in databases.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nThe time period where Firehose will retry sending data to the chosen HTTP endpoint.\n*Required*: No\n*Type*: [SnowflakeRetryOptions](./aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeRetryOptions" }, "KeyPassphrase": { "MarkdownDocumentation": "`KeyPassphrase`\n\nPassphrase to decrypt the private key when the key is encrypted. For information, see [Using Key Pair Authentication & Key Rotation](https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation).\n*Required*: No\n*Type*: String\n*Minimum*: `7`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-keypassphrase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" } } }, "AWS::KinesisFirehose::DeliveryStream.SnowflakeRetryOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SnowflakeRetryOptions`\n\nSpecify how long Firehose retries sending data to the New Relic HTTP endpoint.\nAfter sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn\u2019t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket.\nEvery time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint.\nEven if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired.\nIf you don't want Firehose to retry sending data, set this value to 0.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions.html", "Properties": { "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nthe time period where Firehose will retry sending data to the chosen HTTP endpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions.html#cfn-kinesisfirehose-deliverystream-snowflakeretryoptions-durationinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.SnowflakeRoleConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SnowflakeRoleConfiguration`\n\nOptionally configure a Snowflake role. Otherwise the default user role will be used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration.html", "Properties": { "SnowflakeRole": { "MarkdownDocumentation": "`SnowflakeRole`\n\nThe Snowflake role you wish to configure\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-snowflakerole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnable Snowflake role\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::KinesisFirehose::DeliveryStream.SnowflakeVpcConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SnowflakeVpcConfiguration`\n\nConfigure a Snowflake VPC\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration.html", "Properties": { "PrivateLinkVpceId": { "MarkdownDocumentation": "`PrivateLinkVpceId`\n\nThe VPCE ID for Firehose to privately connect with Snowflake. The ID format is\ncom.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see [Amazon PrivateLink & Snowflake](https://docs.snowflake.com/en/user-guide/admin-security-privatelink)\n*Required*: Yes\n*Type*: String\n*Pattern*: `([a-zA-Z0-9\\-\\_]+\\.){2,3}vpce\\.[a-zA-Z0-9\\-]*\\.vpce-svc\\-[a-zA-Z0-9\\-]{17}$`\n*Minimum*: `47`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakevpcconfiguration-privatelinkvpceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.SplunkBufferingHints": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SplunkBufferingHints`\n\nThe buffering options. If no value is specified, the default values for Splunk are used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints.html", "Properties": { "IntervalInSeconds": { "MarkdownDocumentation": "`IntervalInSeconds`\n\nBuffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute).\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints.html#cfn-kinesisfirehose-deliverystream-splunkbufferinghints-intervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SizeInMBs": { "MarkdownDocumentation": "`SizeInMBs`\n\nBuffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints.html#cfn-kinesisfirehose-deliverystream-splunkbufferinghints-sizeinmbs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration`\n\nThe `SplunkDestinationConfiguration` property type specifies the\nconfiguration of a destination in Splunk for a Kinesis Data Firehose delivery stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html", "Properties": { "HECEndpoint": { "MarkdownDocumentation": "`HECEndpoint`\n\nThe HTTP Event Collector (HEC) endpoint to which Firehose sends your\ndata.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nThe configuration for the backup Amazon S3 location.\n*Required*: Yes\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3DestinationConfiguration" }, "BufferingHints": { "MarkdownDocumentation": "`BufferingHints`\n\nThe buffering options. If no value is specified, the default values for Splunk are used.\n*Required*: No\n*Type*: [SplunkBufferingHints](./aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-bufferinghints", "UpdateType": "Mutable", "Required": false, "Type": "SplunkBufferingHints" }, "HECToken": { "MarkdownDocumentation": "`HECToken`\n\nThis is a GUID that you obtain from your Splunk cluster when you create a new HEC\nendpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RetryOptions": { "MarkdownDocumentation": "`RetryOptions`\n\nThe retry behavior in case Firehose is unable to deliver data to Splunk,\nor if it doesn't receive an acknowledgment of receipt from Splunk.\n*Required*: No\n*Type*: [SplunkRetryOptions](./aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions", "UpdateType": "Mutable", "Required": false, "Type": "SplunkRetryOptions" }, "HECEndpointType": { "MarkdownDocumentation": "`HECEndpointType`\n\nThis type can be either `Raw` or `Event`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Raw | Event...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Raw", "Event" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretsManagerConfiguration": { "MarkdownDocumentation": "`SecretsManagerConfiguration`\n\nThe configuration that defines how you access secrets for Splunk.\n*Required*: No\n*Type*: [SecretsManagerConfiguration](./aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-secretsmanagerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SecretsManagerConfiguration" }, "HECAcknowledgmentTimeoutInSeconds": { "MarkdownDocumentation": "`HECAcknowledgmentTimeoutInSeconds`\n\nThe amount of time that Firehose waits to receive an acknowledgment from\nSplunk after it sends it data. At the end of the timeout period, Firehose\neither tries to send the data again or considers it an error, based on your retry\nsettings.\n*Required*: No\n*Type*: Integer\n*Minimum*: `180`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ProcessingConfiguration": { "MarkdownDocumentation": "`ProcessingConfiguration`\n\nThe data processing configuration.\n*Required*: No\n*Type*: [ProcessingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProcessingConfiguration" }, "CloudWatchLoggingOptions": { "MarkdownDocumentation": "`CloudWatchLoggingOptions`\n\nThe Amazon CloudWatch logging options for your Firehose stream.\n*Required*: No\n*Type*: [CloudWatchLoggingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLoggingOptions" }, "S3BackupMode": { "MarkdownDocumentation": "`S3BackupMode`\n\nDefines how documents should be delivered to Amazon S3. When set to\n`FailedEventsOnly`, Firehose writes any data that could not be\nindexed to the configured Amazon S3 destination. When set to `AllEvents`,\nFirehose delivers all incoming records to Amazon S3, and also writes failed\ndocuments to Amazon S3. The default value is `FailedEventsOnly`.\nYou can update this backup mode from `FailedEventsOnly` to\n`AllEvents`. You can't update it from `AllEvents` to\n`FailedEventsOnly`.\n*Required*: No\n*Type*: String\n*Allowed values*: `FailedEventsOnly | AllEvent...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FailedEventsOnly", "AllEvents" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions`\n\nThe `SplunkRetryOptions` property type specifies retry behavior in case\nKinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an\nacknowledgment from Splunk.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html", "Properties": { "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nThe total amount of time that Firehose spends on retries. This duration\nstarts after the initial attempt to send data to Splunk fails. It doesn't include the\nperiods during which Firehose waits for acknowledgment from Splunk after each\nattempt.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::KinesisFirehose::DeliveryStream.TableCreationConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.TableCreationConfiguration`\n\nThe configuration to enable automatic table creation.\nAmazon Data Firehose is in preview release and is subject to change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecify whether you want to enable automatic table creation.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration.html#cfn-kinesisfirehose-deliverystream-tablecreationconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::KinesisFirehose::DeliveryStream.VpcConfiguration": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream.VpcConfiguration`\n\nThe details of the VPC of the Amazon ES destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html", "Properties": { "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of\nthe Amazon ES destination. Make sure that the routing tables and inbound and outbound rules\nallow traffic to flow from the subnets whose IDs are specified here to the subnets that\nhave the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in\neach of the subnets that are specified here. Do not delete or modify these ENIs.\nThe number of ENIs that Kinesis Data Firehose creates in the subnets specified here\nscales up and down automatically based on throughput. To enable Kinesis Data Firehose to\nscale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\nhelp you calculate the quota you need, assume that Kinesis Data Firehose can create up to\nthree ENIs for this delivery stream for each of the subnets specified here.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `1024 | 16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html#cfn-kinesisfirehose-deliverystream-vpcconfiguration-subnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the security groups that you want Kinesis Data Firehose to use when it\ncreates ENIs in the VPC of the Amazon ES destination. You can use the same security group\nthat the Amazon ES domain uses or different ones. If you specify different security groups\nhere, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security\ngroup. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the\nsecurity groups specified here. If you use the same security group for both your delivery\nstream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS\ntraffic.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `1024 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html#cfn-kinesisfirehose-deliverystream-vpcconfiguration-securitygroupids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe ARN of the IAM role that you want the delivery stream to use to create endpoints\nin the destination VPC. You can use your existing Kinesis Data Firehose delivery role or\nyou can specify a new role. In either case, make sure that the role trusts the Kinesis Data\nFirehose service principal and that it grants the following permissions:\n* `ec2:DescribeVpcs`\n* `ec2:DescribeVpcAttribute`\n* `ec2:DescribeSubnets`\n* `ec2:DescribeSecurityGroups`\n* `ec2:DescribeNetworkInterfaces`\n* `ec2:CreateNetworkInterface`\n* `ec2:CreateNetworkInterfacePermission`\n* `ec2:DeleteNetworkInterface`\nIf you revoke these permissions after you create the delivery stream, Kinesis Data\nFirehose can't scale out by creating more ENIs when necessary. You might therefore see a\ndegradation in performance.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html#cfn-kinesisfirehose-deliverystream-vpcconfiguration-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisVideo::Stream.StreamStorageConfiguration": { "MarkdownDocumentation": "`AWS::KinesisVideo::Stream.StreamStorageConfiguration`\n\nThe configuration for stream storage, including the default storage tier for stream data. This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisvideo-stream-streamstorageconfiguration.html", "Properties": { "DefaultStorageTier": { "MarkdownDocumentation": "`DefaultStorageTier`\n\nThe default storage tier for the stream data. This setting determines the storage class used for stream data, affecting both performance characteristics and storage costs.\nAvailable storage tiers:\n* `HOT` - Optimized for frequent access with the lowest latency and highest performance. Ideal for real-time applications and frequently accessed data.\n* `WARM` - Balanced performance and cost for moderately accessed data. Suitable for data that is accessed regularly but not continuously.\n*Required*: No\n*Type*: String\n*Allowed values*: `HOT | WARM`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "HOT", "WARM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisvideo-stream-streamstorageconfiguration.html#cfn-kinesisvideo-stream-streamstorageconfiguration-defaultstoragetier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::LakeFormation::DataCellsFilter.ColumnWildcard": { "MarkdownDocumentation": "`AWS::LakeFormation::DataCellsFilter.ColumnWildcard`\n\nA wildcard object, consisting of an optional list of excluded column names or indexes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-columnwildcard.html", "Properties": { "ExcludedColumnNames": { "MarkdownDocumentation": "`ExcludedColumnNames`\n\nExcludes column names. Any column with this name will be excluded.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-columnwildcard.html#cfn-lakeformation-datacellsfilter-columnwildcard-excludedcolumnnames", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::LakeFormation::DataCellsFilter.RowFilter": { "MarkdownDocumentation": "`AWS::LakeFormation::DataCellsFilter.RowFilter`\n\nA PartiQL predicate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-rowfilter.html", "Properties": { "AllRowsWildcard": { "MarkdownDocumentation": "`AllRowsWildcard`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-rowfilter.html#cfn-lakeformation-datacellsfilter-rowfilter-allrowswildcard", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "FilterExpression": { "MarkdownDocumentation": "`FilterExpression`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-rowfilter.html#cfn-lakeformation-datacellsfilter-rowfilter-filterexpression", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::LakeFormation::DataLakeSettings.Admins": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::LakeFormation::DataLakeSettings.Admins`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-admins.html", "ItemType": "DataLakePrincipal", "UpdateType": "Mutable" }, "AWS::LakeFormation::DataLakeSettings.CreateDatabaseDefaultPermissions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::LakeFormation::DataLakeSettings.CreateDatabaseDefaultPermissions`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-createdatabasedefaultpermissions.html", "ItemType": "PrincipalPermissions", "UpdateType": "Mutable" }, "AWS::LakeFormation::DataLakeSettings.CreateTableDefaultPermissions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::LakeFormation::DataLakeSettings.CreateTableDefaultPermissions`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-createtabledefaultpermissions.html", "ItemType": "PrincipalPermissions", "UpdateType": "Mutable" }, "AWS::LakeFormation::DataLakeSettings.DataLakePrincipal": { "MarkdownDocumentation": "`AWS::LakeFormation::DataLakeSettings.DataLakePrincipal`\n\nThe Lake Formation principal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-datalakeprincipal.html", "Properties": { "DataLakePrincipalIdentifier": { "Required": true, "MarkdownDocumentation": "`DataLakePrincipalIdentifier`\n\nAn identifier for the Lake Formation principal.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-datalakeprincipal.html#cfn-lakeformation-datalakesettings-datalakeprincipal-datalakeprincipalidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::DataLakeSettings.ExternalDataFilteringAllowList": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::LakeFormation::DataLakeSettings.ExternalDataFilteringAllowList`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-externaldatafilteringallowlist.html", "ItemType": "DataLakePrincipal", "UpdateType": "Mutable" }, "AWS::LakeFormation::DataLakeSettings.PrincipalPermissions": { "MarkdownDocumentation": "`AWS::LakeFormation::DataLakeSettings.PrincipalPermissions`\n\nPermissions granted to a principal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-principalpermissions.html", "Properties": { "Permissions": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`Permissions`\n\nThe permissions that are granted to the principal.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-principalpermissions.html#cfn-lakeformation-datalakesettings-principalpermissions-permissions", "UpdateType": "Mutable" }, "Principal": { "Type": "DataLakePrincipal", "Required": true, "MarkdownDocumentation": "`Principal`\n\nThe principal who is granted permissions.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-principalpermissions.html#cfn-lakeformation-datalakesettings-principalpermissions-principal", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::DataLakeSettings.ReadOnlyAdmins": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AWS::LakeFormation::DataLakeSettings.ReadOnlyAdmins`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-readonlyadmins.html", "ItemType": "DataLakePrincipal", "UpdateType": "Mutable" }, "AWS::LakeFormation::Permissions.ColumnWildcard": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions.ColumnWildcard`\n\nA wildcard object, consisting of an optional list of excluded column names or indexes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-columnwildcard.html", "Properties": { "ExcludedColumnNames": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ExcludedColumnNames`\n\nExcludes column names. Any column with this name will be excluded.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-columnwildcard.html#cfn-lakeformation-permissions-columnwildcard-excludedcolumnnames", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::Permissions.DataLakePrincipal": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions.DataLakePrincipal`\n\nThe Lake Formation principal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalakeprincipal.html", "Properties": { "DataLakePrincipalIdentifier": { "Required": false, "MarkdownDocumentation": "`DataLakePrincipalIdentifier`\n\nAn identifier for the Lake Formation principal.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalakeprincipal.html#cfn-lakeformation-permissions-datalakeprincipal-datalakeprincipalidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::Permissions.DataLocationResource": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions.DataLocationResource`\n\nA structure for a data location object where permissions are granted or revoked.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalocationresource.html", "Properties": { "S3Resource": { "Required": false, "MarkdownDocumentation": "`S3Resource`\n\nThe Amazon Resource Name (ARN) that uniquely identifies the data location 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalocationresource.html#cfn-lakeformation-permissions-datalocationresource-s3resource", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CatalogId": { "Required": false, "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it is the account ID of the caller.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalocationresource.html#cfn-lakeformation-permissions-datalocationresource-catalogid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::Permissions.DatabaseResource": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions.DatabaseResource`\n\nA structure for the database object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-databaseresource.html", "Properties": { "CatalogId": { "Required": false, "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it is the account ID of the caller.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-databaseresource.html#cfn-lakeformation-permissions-databaseresource-catalogid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the database resource. Unique to the Data Catalog.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-databaseresource.html#cfn-lakeformation-permissions-databaseresource-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::Permissions.Resource": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions.Resource`\n\nA structure for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html", "Properties": { "TableResource": { "Type": "TableResource", "Required": false, "MarkdownDocumentation": "`TableResource`\n\nA 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](./aws-properties-lakeformation-permissions-tableresource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-tableresource", "UpdateType": "Mutable" }, "DatabaseResource": { "Type": "DatabaseResource", "Required": false, "MarkdownDocumentation": "`DatabaseResource`\n\nA structure for the database object.\n*Required*: No\n*Type*: [DatabaseResource](./aws-properties-lakeformation-permissions-databaseresource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-databaseresource", "UpdateType": "Mutable" }, "DataLocationResource": { "Type": "DataLocationResource", "Required": false, "MarkdownDocumentation": "`DataLocationResource`\n\nA structure for a data location object where permissions are granted or revoked.\n*Required*: No\n*Type*: [DataLocationResource](./aws-properties-lakeformation-permissions-datalocationresource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-datalocationresource", "UpdateType": "Mutable" }, "TableWithColumnsResource": { "Type": "TableWithColumnsResource", "Required": false, "MarkdownDocumentation": "`TableWithColumnsResource`\n\nA structure for a table with columns object. This object is only used when granting a SELECT permission.\n*Required*: No\n*Type*: [TableWithColumnsResource](./aws-properties-lakeformation-permissions-tablewithcolumnsresource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-tablewithcolumnsresource", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::Permissions.TableResource": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions.TableResource`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html", "Properties": { "DatabaseName": { "Required": false, "MarkdownDocumentation": "`DatabaseName`\n\nThe 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*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CatalogId": { "Required": false, "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it is the account ID of the caller.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-catalogid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TableWildcard": { "Type": "TableWildcard", "Required": false, "MarkdownDocumentation": "`TableWildcard`\n\nAn 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*: Json\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-tablewildcard", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the table.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::Permissions.TableWildcard": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions.TableWildcard`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewildcard.html", "Properties": {} }, "AWS::LakeFormation::Permissions.TableWithColumnsResource": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions.TableWithColumnsResource`\n\nA structure for a table with columns object. This object is only used when granting a SELECT permission.\nThis object must take a value for at least one of `ColumnsNames`, `ColumnsIndexes`, or `ColumnsWildcard`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html", "Properties": { "ColumnNames": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ColumnNames`\n\nThe list of column names for the table. At least one of `ColumnNames` or `ColumnWildcard` is required.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-columnnames", "UpdateType": "Mutable" }, "DatabaseName": { "Required": false, "MarkdownDocumentation": "`DatabaseName`\n\nThe 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*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CatalogId": { "Required": false, "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it is the account ID of the caller.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-catalogid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe 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*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ColumnWildcard": { "Type": "ColumnWildcard", "Required": false, "MarkdownDocumentation": "`ColumnWildcard`\n\nA wildcard specified by a `ColumnWildcard` object. At least one of `ColumnNames` or `ColumnWildcard` is required.\n*Required*: No\n*Type*: [ColumnWildcard](./aws-properties-lakeformation-permissions-columnwildcard.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-columnwildcard", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::PrincipalPermissions.ColumnWildcard": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.ColumnWildcard`\n\nA wildcard object, consisting of an optional list of excluded column names or indexes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-columnwildcard.html", "Properties": { "ExcludedColumnNames": { "MarkdownDocumentation": "`ExcludedColumnNames`\n\nExcludes column names. Any column with this name will be excluded.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-columnwildcard.html#cfn-lakeformation-principalpermissions-columnwildcard-excludedcolumnnames", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::LakeFormation::PrincipalPermissions.DataCellsFilterResource": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.DataCellsFilterResource`\n\nA structure that describes certain columns on certain rows.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-tablename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nA database in the Data Catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TableCatalogId": { "MarkdownDocumentation": "`TableCatalogId`\n\nThe ID of the catalog to which the table belongs.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-tablecatalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name given by the user to the data filter cell.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::LakeFormation::PrincipalPermissions.DataLakePrincipal": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.DataLakePrincipal`\n\nThe AWS Lake Formation principal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalakeprincipal.html", "Properties": { "DataLakePrincipalIdentifier": { "MarkdownDocumentation": "`DataLakePrincipalIdentifier`\n\nAn identifier for the AWS Lake Formation principal.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalakeprincipal.html#cfn-lakeformation-principalpermissions-datalakeprincipal-datalakeprincipalidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::LakeFormation::PrincipalPermissions.DataLocationResource": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.DataLocationResource`\n\nA structure for a data location object where permissions are granted or revoked.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html#cfn-lakeformation-principalpermissions-datalocationresource-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog where the location is registered with AWS Lake Formation.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html#cfn-lakeformation-principalpermissions-datalocationresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::LakeFormation::PrincipalPermissions.DatabaseResource": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.DatabaseResource`\n\nA structure for the database object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html", "Properties": { "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it is the account ID of the caller.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html#cfn-lakeformation-principalpermissions-databaseresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the database resource. Unique to the Data Catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html#cfn-lakeformation-principalpermissions-databaseresource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::LakeFormation::PrincipalPermissions.LFTag": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.LFTag`\n\nThe LF-tag key and values attached to a resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html", "Properties": { "TagKey": { "MarkdownDocumentation": "`TagKey`\n\nThe key-name for the LF-tag.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html#cfn-lakeformation-principalpermissions-lftag-tagkey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TagValues": { "MarkdownDocumentation": "`TagValues`\n\nA list of possible values of the corresponding `TagKey` of an LF-tag key-value pair.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html#cfn-lakeformation-principalpermissions-lftag-tagvalues", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::LakeFormation::PrincipalPermissions.LFTagKeyResource": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.LFTagKeyResource`\n\nA structure containing an LF-tag key and values for a resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html", "Properties": { "TagKey": { "MarkdownDocumentation": "`TagKey`\n\nThe key-name for the LF-tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-tagkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog where the location is registered with Data Catalog.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TagValues": { "MarkdownDocumentation": "`TagValues`\n\nA list of possible values for the corresponding `TagKey` of an LF-tag key-value pair.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-tagvalues", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::LakeFormation::PrincipalPermissions.LFTagPolicyResource": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.LFTagPolicyResource`\n\nA list of LF-tag conditions that define a resource's LF-tag policy.\nA structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nA list of LF-tag conditions that apply to the resource's LF-tag policy.\n*Required*: Yes\n*Type*: Array of [LFTag](./aws-properties-lakeformation-principalpermissions-lftag.html)\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-expression", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "LFTag", "DuplicatesAllowed": true }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe resource type for which the LF-tag policy applies.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DATABASE | TABLE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DATABASE", "TABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-resourcetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe 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*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::LakeFormation::PrincipalPermissions.Resource": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.Resource`\n\nA structure for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html", "Properties": { "LFTag": { "MarkdownDocumentation": "`LFTag`\n\nThe LF-tag key and values attached to a resource.\n*Required*: No\n*Type*: [LFTagKeyResource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-lftag", "UpdateType": "Immutable", "Required": false, "Type": "LFTagKeyResource" }, "Table": { "MarkdownDocumentation": "`Table`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-table", "UpdateType": "Immutable", "Required": false, "Type": "TableResource" }, "DataCellsFilter": { "MarkdownDocumentation": "`DataCellsFilter`\n\nA data cell filter.\n*Required*: No\n*Type*: [DataCellsFilterResource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-datacellsfilter", "UpdateType": "Immutable", "Required": false, "Type": "DataCellsFilterResource" }, "TableWithColumns": { "MarkdownDocumentation": "`TableWithColumns`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-tablewithcolumns", "UpdateType": "Immutable", "Required": false, "Type": "TableWithColumnsResource" }, "LFTagPolicy": { "MarkdownDocumentation": "`LFTagPolicy`\n\nA list of LF-tag conditions that define a resource's LF-tag policy.\n*Required*: No\n*Type*: [LFTagPolicyResource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-lftagpolicy", "UpdateType": "Immutable", "Required": false, "Type": "LFTagPolicyResource" }, "Database": { "MarkdownDocumentation": "`Database`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-database", "UpdateType": "Immutable", "Required": false, "Type": "DatabaseResource" }, "DataLocation": { "MarkdownDocumentation": "`DataLocation`\n\nThe location of an Amazon S3 path where permissions are granted or revoked.\n*Required*: No\n*Type*: [DataLocationResource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-datalocation", "UpdateType": "Immutable", "Required": false, "Type": "DataLocationResource" }, "Catalog": { "MarkdownDocumentation": "`Catalog`\n\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*: Json\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-catalog", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::LakeFormation::PrincipalPermissions.TableResource": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.TableResource`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html", "Properties": { "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it is the account ID of the caller.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TableWildcard": { "MarkdownDocumentation": "`TableWildcard`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-tablewildcard", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::LakeFormation::PrincipalPermissions.TableWithColumnsResource": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions.TableWithColumnsResource`\n\nA structure for a table with columns object. This object is only used when granting a SELECT permission.\nThis object must take a value for at least one of `ColumnsNames`, `ColumnsIndexes`, or `ColumnsWildcard`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html", "Properties": { "ColumnNames": { "MarkdownDocumentation": "`ColumnNames`\n\nThe list of column names for the table. At least one of `ColumnNames` or `ColumnWildcard` is required.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-columnnames", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog where the location is registered with AWS Lake Formation.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ColumnWildcard": { "MarkdownDocumentation": "`ColumnWildcard`\n\nA wildcard specified by a `ColumnWildcard` object. At least one of `ColumnNames` or `ColumnWildcard` is required.\n*Required*: No\n*Type*: [ColumnWildcard](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-columnwildcard", "UpdateType": "Immutable", "Required": false, "Type": "ColumnWildcard" } } }, "AWS::LakeFormation::TagAssociation.DatabaseResource": { "MarkdownDocumentation": "`AWS::LakeFormation::TagAssociation.DatabaseResource`\n\nA structure for the database object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html", "Properties": { "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it should be the account ID of the caller.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html#cfn-lakeformation-tagassociation-databaseresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the database resource. Unique to the Data Catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html#cfn-lakeformation-tagassociation-databaseresource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::LakeFormation::TagAssociation.LFTagPair": { "MarkdownDocumentation": "`AWS::LakeFormation::TagAssociation.LFTagPair`\n\nA structure containing the catalog ID, tag key, and tag values of an LF-tag key-value pair.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html", "Properties": { "TagKey": { "MarkdownDocumentation": "`TagKey`\n\nThe key-name for the LF-tag.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-tagkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it is the account ID of the caller.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TagValues": { "MarkdownDocumentation": "`TagValues`\n\nA list of possible values of the corresponding `TagKey` of an LF-tag key-value pair.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-tagvalues", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::LakeFormation::TagAssociation.Resource": { "MarkdownDocumentation": "`AWS::LakeFormation::TagAssociation.Resource`\n\nA structure for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html", "Properties": { "Table": { "MarkdownDocumentation": "`Table`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-table", "UpdateType": "Immutable", "Required": false, "Type": "TableResource" }, "TableWithColumns": { "MarkdownDocumentation": "`TableWithColumns`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-tablewithcolumns", "UpdateType": "Immutable", "Required": false, "Type": "TableWithColumnsResource" }, "Database": { "MarkdownDocumentation": "`Database`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-database", "UpdateType": "Immutable", "Required": false, "Type": "DatabaseResource" }, "Catalog": { "MarkdownDocumentation": "`Catalog`\n\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*: Json\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-catalog", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::LakeFormation::TagAssociation.TableResource": { "MarkdownDocumentation": "`AWS::LakeFormation::TagAssociation.TableResource`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html", "Properties": { "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe identifier for the Data Catalog. By default, it is the account ID of the caller.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TableWildcard": { "MarkdownDocumentation": "`TableWildcard`\n\nA 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.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-tablewildcard", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::LakeFormation::TagAssociation.TableWithColumnsResource": { "MarkdownDocumentation": "`AWS::LakeFormation::TagAssociation.TableWithColumnsResource`\n\nA structure for a table with columns object. This object is only used when granting a SELECT permission.\nThis object must take a value for at least one of `ColumnsNames`, `ColumnsIndexes`, or `ColumnsWildcard`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html", "Properties": { "ColumnNames": { "MarkdownDocumentation": "`ColumnNames`\n\nThe list of column names for the table. At least one of `ColumnNames` or `ColumnWildcard` is required.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-columnnames", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nA 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*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-catalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Lambda::Alias.AliasRoutingConfiguration": { "MarkdownDocumentation": "`AWS::Lambda::Alias.AliasRoutingConfiguration`\n\nThe [traffic-shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) configuration of a Lambda function alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html", "Properties": { "AdditionalVersionWeights": { "MarkdownDocumentation": "`AdditionalVersionWeights`\n\nThe second version, and the percentage of traffic that's routed to it.\n*Required*: No\n*Type*: Array of [VersionWeight](./aws-properties-lambda-alias-versionweight.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html#cfn-lambda-alias-aliasroutingconfiguration-additionalversionweights", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VersionWeight", "DuplicatesAllowed": false } } }, "AWS::Lambda::Alias.ProvisionedConcurrencyConfiguration": { "MarkdownDocumentation": "`AWS::Lambda::Alias.ProvisionedConcurrencyConfiguration`\n\nA provisioned concurrency configuration for a function's alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html", "Properties": { "ProvisionedConcurrentExecutions": { "MarkdownDocumentation": "`ProvisionedConcurrentExecutions`\n\nThe amount of provisioned concurrency to allocate for the alias.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html#cfn-lambda-alias-provisionedconcurrencyconfiguration-provisionedconcurrentexecutions", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Lambda::Alias.VersionWeight": { "MarkdownDocumentation": "`AWS::Lambda::Alias.VersionWeight`\n\nThe [traffic-shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) configuration of a Lambda function alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html", "Properties": { "FunctionVersion": { "MarkdownDocumentation": "`FunctionVersion`\n\nThe qualifier of the second 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FunctionWeight": { "MarkdownDocumentation": "`FunctionWeight`\n\nThe percentage of traffic that the alias routes to the second version.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionweight", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::Lambda::CapacityProvider.CapacityProviderPermissionsConfig": { "MarkdownDocumentation": "`AWS::Lambda::CapacityProvider.CapacityProviderPermissionsConfig`\n\nConfiguration that specifies the permissions required for the capacity provider to manage compute resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderpermissionsconfig.html", "Properties": { "CapacityProviderOperatorRoleArn": { "MarkdownDocumentation": "`CapacityProviderOperatorRoleArn`\n\nThe ARN of the IAM role that the capacity provider uses to manage compute instances and other AWS resources.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\n*Minimum*: `0`\n*Maximum*: `10000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderpermissionsconfig.html#cfn-lambda-capacityprovider-capacityproviderpermissionsconfig-capacityprovideroperatorrolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Lambda::CapacityProvider.CapacityProviderScalingConfig": { "MarkdownDocumentation": "`AWS::Lambda::CapacityProvider.CapacityProviderScalingConfig`\n\nConfiguration that defines how the capacity provider scales compute instances based on demand and policies.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html", "Properties": { "ScalingPolicies": { "MarkdownDocumentation": "`ScalingPolicies`\n\nA list of target tracking scaling policies for the capacity provider.\n*Required*: No\n*Type*: Array of [TargetTrackingScalingPolicy](./aws-properties-lambda-capacityprovider-targettrackingscalingpolicy.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-scalingpolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetTrackingScalingPolicy", "DuplicatesAllowed": true }, "ScalingMode": { "MarkdownDocumentation": "`ScalingMode`\n\nThe scaling mode that determines how the capacity provider responds to changes in demand.\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)", "RefReturnValue": "", "AllowedValues": [ "Auto", "Manual" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-scalingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxVCpuCount": { "MarkdownDocumentation": "`MaxVCpuCount`\n\nThe maximum number of vCPUs that the capacity provider can provision across all compute instances.\n*Required*: No\n*Type*: Integer\n*Minimum*: `2`\n*Maximum*: `15000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-maxvcpucount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Lambda::CapacityProvider.CapacityProviderVpcConfig": { "MarkdownDocumentation": "`AWS::Lambda::CapacityProvider.CapacityProviderVpcConfig`\n\nVPC configuration that specifies the network settings for compute instances managed by the capacity provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html", "Properties": { "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of subnet IDs where the capacity provider launches compute instances.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0 | 1`\n*Maximum*: `1024 | 16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html#cfn-lambda-capacityprovider-capacityprovidervpcconfig-subnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of security group IDs that control network access for compute instances managed by the capacity provider.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `1024 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html#cfn-lambda-capacityprovider-capacityprovidervpcconfig-securitygroupids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Lambda::CapacityProvider.InstanceRequirements": { "MarkdownDocumentation": "`AWS::Lambda::CapacityProvider.InstanceRequirements`\n\nSpecifications that define the characteristics and constraints for compute instances used by the capacity provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html", "Properties": { "AllowedInstanceTypes": { "MarkdownDocumentation": "`AllowedInstanceTypes`\n\nA list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `30 | 400`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-allowedinstancetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExcludedInstanceTypes": { "MarkdownDocumentation": "`ExcludedInstanceTypes`\n\nA list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `30 | 400`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-excludedinstancetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Architectures": { "MarkdownDocumentation": "`Architectures`\n\nA list of supported CPU architectures for compute instances. Valid values include `x86_64` and `arm64`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-architectures", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Lambda::CapacityProvider.TargetTrackingScalingPolicy": { "MarkdownDocumentation": "`AWS::Lambda::CapacityProvider.TargetTrackingScalingPolicy`\n\nA scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-targettrackingscalingpolicy.html", "Properties": { "PredefinedMetricType": { "MarkdownDocumentation": "`PredefinedMetricType`\n\nThe predefined metric type to track for scaling decisions.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LambdaCapacityProviderAvera...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LambdaCapacityProviderAverageCPUUtilization" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-targettrackingscalingpolicy.html#cfn-lambda-capacityprovider-targettrackingscalingpolicy-predefinedmetrictype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nThe target value for the metric that the scaling policy attempts to maintain through scaling actions.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-targettrackingscalingpolicy.html#cfn-lambda-capacityprovider-targettrackingscalingpolicy-targetvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::Lambda::CodeSigningConfig.AllowedPublishers": { "MarkdownDocumentation": "`AWS::Lambda::CodeSigningConfig.AllowedPublishers`\n\nList of signing profiles that can sign a code package.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-codesigningconfig-allowedpublishers.html", "Properties": { "SigningProfileVersionArns": { "MarkdownDocumentation": "`SigningProfileVersionArns`\n\nThe Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user\nwho can sign a code package.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `12 | 1`\n*Maximum*: `1024 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-codesigningconfig-allowedpublishers.html#cfn-lambda-codesigningconfig-allowedpublishers-signingprofileversionarns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Lambda::CodeSigningConfig.CodeSigningPolicies": { "MarkdownDocumentation": "`AWS::Lambda::CodeSigningConfig.CodeSigningPolicies`\n\nCode signing configuration [policies](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies) specify the validation failure action for signature mismatch or\nexpiry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-codesigningconfig-codesigningpolicies.html", "Properties": { "UntrustedArtifactOnDeployment": { "MarkdownDocumentation": "`UntrustedArtifactOnDeployment`\n\nCode signing configuration policy for deployment validation failure. If you set the policy to\n`Enforce`, Lambda blocks the deployment request if signature validation checks\nfail. If you set the policy to `Warn`, Lambda allows the deployment and issues a\nnew Amazon CloudWatch metric (`SignatureValidationErrors`) and also stores the\nwarning in the CloudTrail log.\nDefault value: `Warn`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Warn | Enforce...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Warn", "Enforce" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-codesigningconfig-codesigningpolicies.html#cfn-lambda-codesigningconfig-codesigningpolicies-untrustedartifactondeployment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Lambda::EventInvokeConfig.DestinationConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventInvokeConfig.DestinationConfig`\n\nA configuration object that specifies the destination of an event after Lambda processes it. For more information, see [Adding a destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html", "Properties": { "OnSuccess": { "MarkdownDocumentation": "`OnSuccess`\n\nThe destination configuration for successful invocations.\n###### Note\nWhen using an Amazon SQS queue as a destination, FIFO queues cannot be used.\n*Required*: No\n*Type*: [OnSuccess](./aws-properties-lambda-eventinvokeconfig-onsuccess.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onsuccess", "UpdateType": "Mutable", "Required": false, "Type": "OnSuccess" }, "OnFailure": { "MarkdownDocumentation": "`OnFailure`\n\nThe destination configuration for failed invocations.\n###### Note\nWhen using an Amazon SQS queue as a destination, FIFO queues cannot be used.\n*Required*: No\n*Type*: [OnFailure](./aws-properties-lambda-eventinvokeconfig-onfailure.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onfailure", "UpdateType": "Mutable", "Required": false, "Type": "OnFailure" } } }, "AWS::Lambda::EventInvokeConfig.OnFailure": { "MarkdownDocumentation": "`AWS::Lambda::EventInvokeConfig.OnFailure`\n\nA destination for events that failed processing. For more information, see [Adding a destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe Amazon Resource Name (ARN) of the destination resource.\nTo retain records of failed invocations from [Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html), [DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html), [self-managed Apache Kafka](https://docs.aws.amazon.com/lambda/latest/dg/kafka-on-failure.html), or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/kafka-on-failure.html), you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, or Kafka topic as the destination.\n###### Note\nAmazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending `OnFailure` event to the destination. For details on this behavior, refer to [Retaining records of asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html).\nTo retain records of failed invocations from [Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html),\n[DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html), [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or\n[Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination),\nyou can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]+(-[a-z]+)+-\\d{1})?:(\\d{12})?:(.*)`\n*Minimum*: `0`\n*Maximum*: `350`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html#cfn-lambda-eventinvokeconfig-onfailure-destination", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Lambda::EventInvokeConfig.OnSuccess": { "MarkdownDocumentation": "`AWS::Lambda::EventInvokeConfig.OnSuccess`\n\nA destination for events that were processed successfully.\nTo retain records of successful [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations),\nyou can configure an Amazon SNS topic, Amazon SQS queue, Lambda function,\nor Amazon EventBridge event bus as the destination.\n###### Note\n`OnSuccess` is not supported in `CreateEventSourceMapping` or `UpdateEventSourceMapping` requests.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe Amazon Resource Name (ARN) of the destination resource.\n###### Note\nAmazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending `OnFailure` event to the destination. For details on this behavior, refer to [Retaining records of asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]+(-[a-z]+)+-\\d{1})?:(\\d{12})?:(.*)`\n*Minimum*: `0`\n*Maximum*: `350`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess.html#cfn-lambda-eventinvokeconfig-onsuccess-destination", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Lambda::EventSourceMapping.AmazonManagedKafkaEventSourceConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.AmazonManagedKafkaEventSourceConfig`\n\nSpecific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig.html", "Properties": { "ConsumerGroupId": { "MarkdownDocumentation": "`ConsumerGroupId`\n\nThe identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources.\nAfter creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see\n[Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-\\/*:_+=.@-]*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig-consumergroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SchemaRegistryConfig": { "MarkdownDocumentation": "`SchemaRegistryConfig`\n\nSpecific configuration settings for a Kafka schema registry.\n*Required*: No\n*Type*: [SchemaRegistryConfig](./aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig-schemaregistryconfig", "UpdateType": "Mutable", "Required": false, "Type": "SchemaRegistryConfig" } } }, "AWS::Lambda::EventSourceMapping.DestinationConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.DestinationConfig`\n\nA configuration object that specifies the destination of an event after Lambda processes it. For more information, see [Adding a destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html", "Properties": { "OnFailure": { "MarkdownDocumentation": "`OnFailure`\n\nThe destination configuration for failed invocations.\n*Required*: No\n*Type*: [OnFailure](./aws-properties-lambda-eventsourcemapping-onfailure.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html#cfn-lambda-eventsourcemapping-destinationconfig-onfailure", "UpdateType": "Mutable", "Required": false, "Type": "OnFailure" } } }, "AWS::Lambda::EventSourceMapping.DocumentDBEventSourceConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.DocumentDBEventSourceConfig`\n\nSpecific configuration settings for a DocumentDB event source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html", "Properties": { "FullDocument": { "MarkdownDocumentation": "`FullDocument`\n\nDetermines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.\n*Required*: No\n*Type*: String\n*Allowed values*: `UpdateLookup | Default...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UpdateLookup", "Default" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CollectionName": { "MarkdownDocumentation": "`CollectionName`\n\nThe name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `57`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the database to consume within the DocumentDB cluster.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::EventSourceMapping.Endpoints": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.Endpoints`\n\nThe list of bootstrap servers for your Kafka brokers in the following format: `\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-endpoints.html", "Properties": { "KafkaBootstrapServers": { "MarkdownDocumentation": "`KafkaBootstrapServers`\n\nThe list of bootstrap servers for your Kafka brokers in the following format: `\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `300 | 10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-endpoints.html#cfn-lambda-eventsourcemapping-endpoints-kafkabootstrapservers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Lambda::EventSourceMapping.Filter": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.Filter`\n\nA structure within a `FilterCriteria` object that defines an event filtering pattern.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filter.html", "Properties": { "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nA filter pattern. For more information on the syntax of a filter pattern, see\n[Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax).\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filter.html#cfn-lambda-eventsourcemapping-filter-pattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::EventSourceMapping.FilterCriteria": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.FilterCriteria`\n\nAn object that contains the filters for an event source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nA list of filters.\n*Required*: No\n*Type*: Array of [Filter](./aws-properties-lambda-eventsourcemapping-filter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html#cfn-lambda-eventsourcemapping-filtercriteria-filters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": false } } }, "AWS::Lambda::EventSourceMapping.LoggingConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.LoggingConfig`\n\nThe function's Amazon CloudWatch Logs configuration settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html", "Properties": { "SystemLogLevel": { "MarkdownDocumentation": "`SystemLogLevel`\n\nSet this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the\nselected level of detail and lower, where `DEBUG` is the highest level and `WARN` is the lowest.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEBUG | INFO | WARN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEBUG", "INFO", "WARN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html#cfn-lambda-eventsourcemapping-loggingconfig-systemloglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::EventSourceMapping.MetricsConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.MetricsConfig`\n\nThe metrics configuration for your event source. Use this configuration object to define which metrics you want your\nevent source mapping to produce.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html", "Properties": { "Metrics": { "MarkdownDocumentation": "`Metrics`\n\nThe metrics you want your event source mapping to produce. Include `EventCount` to receive event source mapping\nmetrics related to the number of events processed by your event source mapping. For more information about these metrics,\nsee [Event source mapping metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics).\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `EventCount | ErrorCount | K...`\n*Minimum*: `0`\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)", "RefReturnValue": "", "AllowedValues": [ "EventCount", "ErrorCount", "KafkaMetrics" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html#cfn-lambda-eventsourcemapping-metricsconfig-metrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Lambda::EventSourceMapping.OnFailure": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.OnFailure`\n\nA destination for events that failed processing. For more information, see [Adding a destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe Amazon Resource Name (ARN) of the destination resource.\nTo retain records of failed invocations from [Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html), [DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html), [self-managed Apache Kafka](https://docs.aws.amazon.com/lambda/latest/dg/kafka-on-failure.html), or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/kafka-on-failure.html), you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, or Kafka topic as the destination.\n###### Note\nAmazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending `OnFailure` event to the destination. For details on this behavior, refer to [Retaining records of asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html).\nTo retain records of failed invocations from [Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html),\n[DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html), [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or\n[Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination),\nyou can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|kafka://([^.]([a-zA-Z0-9\\-_.]{0,248}))|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html#cfn-lambda-eventsourcemapping-onfailure-destination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::EventSourceMapping.ProvisionedPollerConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.ProvisionedPollerConfig`\n\nThe [provisioned mode](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode) configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers\nfor your event source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig.html", "Properties": { "PollerGroupName": { "MarkdownDocumentation": "`PollerGroupName`\n\n(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group. Use this option to group multiple ESMs within the event source's VPC to share Event Poller Unit (EPU) capacity. You can use this option to optimize Provisioned mode costs for your ESMs. You can group up to 100 ESMs per poller group and aggregate maximum pollers across all ESMs in a group cannot exceed 2000.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig-pollergroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinimumPollers": { "MarkdownDocumentation": "`MinimumPollers`\n\nThe minimum number of event pollers this event source can scale down to. For Amazon SQS events source mappings, default is 2, and minimum 2 required. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 1.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig-minimumpollers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumPollers": { "MarkdownDocumentation": "`MaximumPollers`\n\nThe maximum number of event pollers this event source can scale up to. For Amazon SQS events source mappings, default is 200, and minimum value allowed is 2. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 200, and minimum value allowed is 1.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig-maximumpollers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Lambda::EventSourceMapping.ScalingConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.ScalingConfig`\n\n(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html", "Properties": { "MaximumConcurrency": { "MarkdownDocumentation": "`MaximumConcurrency`\n\nLimits the number of concurrent instances that the Amazon SQS event source can invoke.\n*Required*: No\n*Type*: Integer\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html#cfn-lambda-eventsourcemapping-scalingconfig-maximumconcurrency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Lambda::EventSourceMapping.SchemaRegistryAccessConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.SchemaRegistryAccessConfig`\n\nSpecific access configuration settings that tell Lambda how to authenticate with your schema registry.\nIf you're working with an AWS Glue schema registry, don't provide authentication details in this object.\nInstead, ensure that your execution role has the required permissions for Lambda to access your cluster.\nIf you're working with a Confluent schema registry, choose the authentication method in the `Type` field,\nand provide the AWS Secrets Manager secret ARN in the `URI` field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryaccessconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of authentication Lambda uses to access your schema registry.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC_AUTH | CLIENT_CERTIFI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryaccessconfig.html#cfn-lambda-eventsourcemapping-schemaregistryaccessconfig-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "URI": { "MarkdownDocumentation": "`URI`\n\nThe URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryaccessconfig.html#cfn-lambda-eventsourcemapping-schemaregistryaccessconfig-uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::EventSourceMapping.SchemaRegistryConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.SchemaRegistryConfig`\n\nSpecific configuration settings for a Kafka schema registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html", "Properties": { "SchemaValidationConfigs": { "MarkdownDocumentation": "`SchemaValidationConfigs`\n\nAn array of schema validation configuration objects, which tell Lambda the message\nattributes you want to validate and filter using your schema registry.\n*Required*: No\n*Type*: Array of [SchemaValidationConfig](./aws-properties-lambda-eventsourcemapping-schemavalidationconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html#cfn-lambda-eventsourcemapping-schemaregistryconfig-schemavalidationconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SchemaValidationConfig", "DuplicatesAllowed": false }, "SchemaRegistryURI": { "MarkdownDocumentation": "`SchemaRegistryURI`\n\nThe URI for your schema registry. The correct URI format depends on the type of schema registry you're using.\n* For AWS Glue schema registries, use the ARN of the registry.\n* For Confluent schema registries, use the URL of the registry.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-/*:_+=.@-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html#cfn-lambda-eventsourcemapping-schemaregistryconfig-schemaregistryuri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventRecordFormat": { "MarkdownDocumentation": "`EventRecordFormat`\n\nThe record format that Lambda delivers to your function after schema validation.\n* Choose `JSON` to have Lambda deliver the record to your function as a standard JSON object.\n* Choose `SOURCE` to have Lambda deliver the record to your function in its original source format.\n Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.\n*Required*: No\n*Type*: String\n*Allowed values*: `JSON | SOURCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JSON", "SOURCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html#cfn-lambda-eventsourcemapping-schemaregistryconfig-eventrecordformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessConfigs": { "MarkdownDocumentation": "`AccessConfigs`\n\nAn array of access configuration objects that tell Lambda how to authenticate with your schema registry.\n*Required*: No\n*Type*: Array of [SchemaRegistryAccessConfig](./aws-properties-lambda-eventsourcemapping-schemaregistryaccessconfig.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html#cfn-lambda-eventsourcemapping-schemaregistryconfig-accessconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SchemaRegistryAccessConfig", "DuplicatesAllowed": false } } }, "AWS::Lambda::EventSourceMapping.SchemaValidationConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.SchemaValidationConfig`\n\nSpecific schema validation configuration settings that tell Lambda the message\nattributes you want to validate and filter using your schema registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemavalidationconfig.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe attributes you want your schema registry to validate and filter for. If you selected `JSON` as the\n`EventRecordFormat`, Lambda also deserializes the selected message attributes.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "KEY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemavalidationconfig.html#cfn-lambda-eventsourcemapping-schemavalidationconfig-attribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::EventSourceMapping.SelfManagedEventSource": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.SelfManagedEventSource`\n\nThe self-managed Apache Kafka cluster for your event source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedeventsource.html", "Properties": { "Endpoints": { "MarkdownDocumentation": "`Endpoints`\n\nThe list of bootstrap servers for your Kafka brokers in the following format: `\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]`.\n*Required*: No\n*Type*: [Endpoints](./aws-properties-lambda-eventsourcemapping-endpoints.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedeventsource.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource-endpoints", "UpdateType": "Immutable", "Required": false, "Type": "Endpoints" } } }, "AWS::Lambda::EventSourceMapping.SelfManagedKafkaEventSourceConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.SelfManagedKafkaEventSourceConfig`\n\nSpecific configuration settings for a self-managed Apache Kafka event source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html", "Properties": { "ConsumerGroupId": { "MarkdownDocumentation": "`ConsumerGroupId`\n\nThe identifier for the Kafka consumer group to join. The consumer group ID must be unique\namong all your Kafka event sources. After creating a Kafka event source mapping with the\nconsumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka-process.html#services-smaa-topic-add).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-\\/*:_+=.@-]*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig-consumergroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SchemaRegistryConfig": { "MarkdownDocumentation": "`SchemaRegistryConfig`\n\nSpecific configuration settings for a Kafka schema registry.\n*Required*: No\n*Type*: [SchemaRegistryConfig](./aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig-schemaregistryconfig", "UpdateType": "Mutable", "Required": false, "Type": "SchemaRegistryConfig" } } }, "AWS::Lambda::EventSourceMapping.SourceAccessConfiguration": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping.SourceAccessConfiguration`\n\nAn array of the authentication protocol, VPC components, or virtual host to secure and define your event source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of authentication protocol, VPC components, or virtual host for your event source. For example: `\"Type\":\"SASL_SCRAM_512_AUTH\"`.\n* `BASIC_AUTH` \u2013 (Amazon MQ) The AWS Secrets Manager secret that stores your broker credentials.\n* `BASIC_AUTH` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.\n* `VPC_SUBNET` \u2013 (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.\n* `VPC_SECURITY_GROUP` \u2013 (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.\n* `SASL_SCRAM_256_AUTH` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.\n* `SASL_SCRAM_512_AUTH` \u2013 (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.\n* `VIRTUAL_HOST` \u2013- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source.\n This property cannot be specified in an UpdateEventSourceMapping API call.\n* `CLIENT_CERTIFICATE_TLS_AUTH` \u2013 (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM),\n private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.\n* `SERVER_ROOT_CA_CERTIFICATE` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC_AUTH | VPC_SUBNET | V...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC_AUTH", "VPC_SUBNET", "VPC_SECURITY_GROUP", "SASL_SCRAM_512_AUTH", "SASL_SCRAM_256_AUTH", "VIRTUAL_HOST", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html#cfn-lambda-eventsourcemapping-sourceaccessconfiguration-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "URI": { "MarkdownDocumentation": "`URI`\n\nThe value for your chosen configuration in `Type`. For example: `\"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\"`.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-\\/*:_+=.@-]*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html#cfn-lambda-eventsourcemapping-sourceaccessconfiguration-uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::Function.CapacityProviderConfig": { "MarkdownDocumentation": "`AWS::Lambda::Function.CapacityProviderConfig`\n\nConfiguration for the capacity provider that manages compute resources for Lambda functions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-capacityproviderconfig.html", "Properties": { "LambdaManagedInstancesCapacityProviderConfig": { "MarkdownDocumentation": "`LambdaManagedInstancesCapacityProviderConfig`\n\nConfiguration for Lambda-managed instances used by the capacity provider.\n*Required*: Yes\n*Type*: [LambdaManagedInstancesCapacityProviderConfig](./aws-properties-lambda-function-lambdamanagedinstancescapacityproviderconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-capacityproviderconfig.html#cfn-lambda-function-capacityproviderconfig-lambdamanagedinstancescapacityproviderconfig", "UpdateType": "Mutable", "Required": true, "Type": "LambdaManagedInstancesCapacityProviderConfig" } } }, "AWS::Lambda::Function.Code": { "MarkdownDocumentation": "`AWS::Lambda::Function.Code`\n\nThe [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html)\nfor a Lambda function. To deploy a function defined as a container image,\nyou specify the location of a container image in the Amazon ECR registry.\nFor a .zip file deployment package, you can specify the location of an object in\nAmazon S3. For Node.js and Python functions, you can specify the function code inline\nin the template.\n###### Note\nWhen you specify source code inline for a Node.js function, the `index` file that CloudFormation creates uses the extension\n`.js`. This means that Node.js treats the file as a CommonJS module.\nChanges to a deployment package in Amazon S3 or a container image in ECR are not\ndetected automatically during stack updates. To update the function code, change the\nobject key or version in the template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html", "Properties": { "SourceKMSKeyArn": { "MarkdownDocumentation": "`SourceKMSKeyArn`\n\nThe ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt your function's\n.zip deployment package. If you don't provide a customer managed key, Lambda uses an [AWS owned key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk).\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-sourcekmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3ObjectVersion": { "MarkdownDocumentation": "`S3ObjectVersion`\n\nFor versioned objects, the version of the deployment package object to use.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nAn Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[0-9A-Za-z\\.\\-_]*(?`. To use a different log group, enter an existing log group or enter a new log group name.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html#cfn-lambda-function-loggingconfig-loggroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SystemLogLevel": { "MarkdownDocumentation": "`SystemLogLevel`\n\nSet this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the\nselected level of detail and lower, where `DEBUG` is the highest level and `WARN` is the lowest.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEBUG | INFO | WARN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEBUG", "INFO", "WARN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html#cfn-lambda-function-loggingconfig-systemloglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::Function.RuntimeManagementConfig": { "MarkdownDocumentation": "`AWS::Lambda::Function.RuntimeManagementConfig`\n\nSets the runtime management configuration for a function's version. For more information,\nsee [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html", "Properties": { "UpdateRuntimeOn": { "MarkdownDocumentation": "`UpdateRuntimeOn`\n\nSpecify the runtime update mode.\n* **Auto (default)** - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best\n choice for most customers to ensure they always benefit from runtime updates.\n* **FunctionUpdate** - Lambda updates the runtime of you function to the most recent and secure runtime version when you update your\n function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and\n mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.\n* **Manual** - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely.\n In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information,\n see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback).\n*Valid Values*: `Auto` | `FunctionUpdate` | `Manual`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Auto | FunctionUpdate | Man...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Auto", "FunctionUpdate", "Manual" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html#cfn-lambda-function-runtimemanagementconfig-updateruntimeon", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RuntimeVersionArn": { "MarkdownDocumentation": "`RuntimeVersionArn`\n\nThe ARN of the runtime version you want the function to use.\n###### Note\nThis is only required if you're using the **Manual** runtime update mode.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}::runtime:.+`\n*Minimum*: `26`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html#cfn-lambda-function-runtimemanagementconfig-runtimeversionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::Function.SnapStart": { "MarkdownDocumentation": "`AWS::Lambda::Function.SnapStart`\n\nThe function's [AWS Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html", "Properties": { "ApplyOn": { "MarkdownDocumentation": "`ApplyOn`\n\nSet `ApplyOn` to `PublishedVersions` to create a snapshot of the initialized execution environment when you publish a function version.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PublishedVersions | None...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PublishedVersions", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html#cfn-lambda-function-snapstart-applyon", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Lambda::Function.SnapStartResponse": { "MarkdownDocumentation": "`AWS::Lambda::Function.SnapStartResponse`\n\nThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html", "Properties": { "OptimizationStatus": { "MarkdownDocumentation": "`OptimizationStatus`\n\nWhen you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version.\n*Required*: No\n*Type*: String\n*Allowed values*: `On | Off`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "On", "Off" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html#cfn-lambda-function-snapstartresponse-optimizationstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplyOn": { "MarkdownDocumentation": "`ApplyOn`\n\nWhen set to `PublishedVersions`, Lambda creates a snapshot of the execution environment when you publish a function version.\n*Required*: No\n*Type*: String\n*Allowed values*: `PublishedVersions | None...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PublishedVersions", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html#cfn-lambda-function-snapstartresponse-applyon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::Function.TenancyConfig": { "MarkdownDocumentation": "`AWS::Lambda::Function.TenancyConfig`\n\nSpecifies the tenant isolation mode configuration for a Lambda function.\nThis allows you to configure specific tenant isolation strategies for your function invocations.\nTenant isolation configuration cannot be modified after function creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tenancyconfig.html", "Properties": { "TenantIsolationMode": { "MarkdownDocumentation": "`TenantIsolationMode`\n\nTenant isolation mode allows for invocation to be sent to a\ncorresponding execution environment dedicated to a specific tenant ID.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PER_TENANT`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "PER_TENANT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tenancyconfig.html#cfn-lambda-function-tenancyconfig-tenantisolationmode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Lambda::Function.TracingConfig": { "MarkdownDocumentation": "`AWS::Lambda::Function.TracingConfig`\n\nThe function's [AWS X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration.\nTo sample and record incoming requests, set `Mode` to `Active`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe tracing mode.\n*Required*: No\n*Type*: String\n*Allowed values*: `Active | PassThrough...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Active", "PassThrough" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html#cfn-lambda-function-tracingconfig-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Lambda::Function.VpcConfig": { "MarkdownDocumentation": "`AWS::Lambda::Function.VpcConfig`\n\nThe VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a\nVPC, Lambda creates an elastic network interface for each combination of security group and subnet in the\nfunction's VPC configuration. The function can only access resources and the internet through that VPC. For more\ninformation, see [VPC\nSettings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).\n###### Note\nWhen you delete a function, CloudFormation monitors the state of its network interfaces and waits for\nLambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to\nbe deleted by Lambda before CloudFormation can delete the VPC's resources.\nTo monitor network interfaces, CloudFormation needs the `ec2:DescribeNetworkInterfaces`\npermission. It obtains this from the user or role that modifies the stack. If you don't provide this permission,\nCloudFormation does not wait for network interfaces to be deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html", "Properties": { "Ipv6AllowedForDualStack": { "MarkdownDocumentation": "`Ipv6AllowedForDualStack`\n\nAllows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-ipv6allowedfordualstack", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of VPC security group IDs.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of VPC subnet IDs.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Lambda::LayerVersion.Content": { "MarkdownDocumentation": "`AWS::Lambda::LayerVersion.Content`\n\nA ZIP archive that contains the contents of an [Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html", "Properties": { "S3ObjectVersion": { "MarkdownDocumentation": "`S3ObjectVersion`\n\nFor versioned objects, the version of the layer archive object to use.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3objectversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nThe Amazon S3 bucket of the layer archive.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9A-Za-z\\.\\-_]*(?\n1.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-gopbreference", "PrimitiveType": "String", "UpdateType": "Mutable" }, "LookAheadRateControl": { "Required": false, "MarkdownDocumentation": "`LookAheadRateControl`\n\nThe amount of lookahead. A value of low can decrease latency and memory usage, while\nhigh can produce better quality for certain 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-lookaheadratecontrol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Level": { "Required": false, "MarkdownDocumentation": "`Level`\n\nThe H.264 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-level", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaxBitrate": { "Required": false, "MarkdownDocumentation": "`MaxBitrate`\n\nFor QVBR: See the tooltip for Quality level. For VBR: Set the maximum bitrate in order\nto accommodate expected spikes in the complexity of the video.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-maxbitrate", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Syntax": { "Required": false, "MarkdownDocumentation": "`Syntax`\n\nProduces a bitstream that is compliant with SMPTE RP-2027.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-syntax", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SubgopLength": { "Required": false, "MarkdownDocumentation": "`SubgopLength`\n\nIf set to fixed, uses gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimizes\nthe number of B-frames used for each sub-GOP to improve visual quality.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-subgoplength", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GopNumBFrames": { "Required": false, "MarkdownDocumentation": "`GopNumBFrames`\n\nThe number of B-frames between reference frames.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h264settings.html#cfn-medialive-channel-h264settings-gopnumbframes", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.H265ColorSpaceSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.H265ColorSpaceSettings`\n\nH265 Color Space Settings\nThe parent of this entity is H265Settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html", "Properties": { "Rec601Settings": { "Type": "Rec601Settings", "Required": false, "MarkdownDocumentation": "`Rec601Settings`\n\nSettings to configure the handling of Rec601 color space.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-rec601settings", "UpdateType": "Mutable" }, "Rec709Settings": { "Type": "Rec709Settings", "Required": false, "MarkdownDocumentation": "`Rec709Settings`\n\nSettings to configure the handling of Rec709 color space.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-rec709settings", "UpdateType": "Mutable" }, "ColorSpacePassthroughSettings": { "Type": "ColorSpacePassthroughSettings", "Required": false, "MarkdownDocumentation": "`ColorSpacePassthroughSettings`\n\nPassthrough applies no color space conversion to the output.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-colorspacepassthroughsettings", "UpdateType": "Mutable" }, "DolbyVision81Settings": { "Type": "DolbyVision81Settings", "Required": false, "MarkdownDocumentation": "`DolbyVision81Settings`\n\nProperty description not available.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-dolbyvision81settings", "UpdateType": "Mutable" }, "Hdr10Settings": { "Type": "Hdr10Settings", "Required": false, "MarkdownDocumentation": "`Hdr10Settings`\n\nSettings to configure the handling of HDR10 color space.\n*Required*: No\n*Type*: [Hdr10Settings](./aws-properties-medialive-channel-hdr10settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-hdr10settings", "UpdateType": "Mutable" }, "Hlg2020Settings": { "Type": "Hlg2020Settings", "Required": false, "MarkdownDocumentation": "`Hlg2020Settings`\n\nProperty description not available.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265colorspacesettings.html#cfn-medialive-channel-h265colorspacesettings-hlg2020settings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.H265FilterSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.H265FilterSettings`\n\nSettings to configure video filters that apply to the H265 codec.\nThe parent of this entity is H265Settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265filtersettings.html", "Properties": { "TemporalFilterSettings": { "Type": "TemporalFilterSettings", "Required": false, "MarkdownDocumentation": "`TemporalFilterSettings`\n\nSettings for applying the temporal filter to the video.\n*Required*: No\n*Type*: [TemporalFilterSettings](./aws-properties-medialive-channel-temporalfiltersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265filtersettings.html#cfn-medialive-channel-h265filtersettings-temporalfiltersettings", "UpdateType": "Mutable" }, "BandwidthReductionFilterSettings": { "Type": "BandwidthReductionFilterSettings", "Required": false, "MarkdownDocumentation": "`BandwidthReductionFilterSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [BandwidthReductionFilterSettings](./aws-properties-medialive-channel-bandwidthreductionfiltersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265filtersettings.html#cfn-medialive-channel-h265filtersettings-bandwidthreductionfiltersettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.H265Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.H265Settings`\n\nH265 Settings\nThe parent of this entity is VideoCodecSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html", "Properties": { "MvOverPictureBoundaries": { "Required": false, "MarkdownDocumentation": "`MvOverPictureBoundaries`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-mvoverpictureboundaries", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimecodeBurninSettings": { "Type": "TimecodeBurninSettings", "Required": false, "MarkdownDocumentation": "`TimecodeBurninSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [TimecodeBurninSettings](./aws-properties-medialive-channel-timecodeburninsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-timecodeburninsettings", "UpdateType": "Mutable" }, "Slices": { "Required": false, "MarkdownDocumentation": "`Slices`\n\nNumber of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-slices", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "QvbrQualityLevel": { "Required": false, "MarkdownDocumentation": "`QvbrQualityLevel`\n\nControls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-qvbrqualitylevel", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TileHeight": { "Required": false, "MarkdownDocumentation": "`TileHeight`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-tileheight", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "FramerateNumerator": { "Required": false, "MarkdownDocumentation": "`FramerateNumerator`\n\nFramerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-frameratenumerator", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "GopClosedCadence": { "Required": false, "MarkdownDocumentation": "`GopClosedCadence`\n\nFrequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-gopclosedcadence", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "FlickerAq": { "Required": false, "MarkdownDocumentation": "`FlickerAq`\n\nIf set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-flickeraq", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Profile": { "Required": false, "MarkdownDocumentation": "`Profile`\n\nH.265 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-profile", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MvTemporalPredictor": { "Required": false, "MarkdownDocumentation": "`MvTemporalPredictor`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-mvtemporalpredictor", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MinBitrate": { "Required": false, "MarkdownDocumentation": "`MinBitrate`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-minbitrate", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MinIInterval": { "Required": false, "MarkdownDocumentation": "`MinIInterval`\n\nOnly meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-miniinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SceneChangeDetect": { "Required": false, "MarkdownDocumentation": "`SceneChangeDetect`\n\nScene change detection.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-scenechangedetect", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FramerateDenominator": { "Required": false, "MarkdownDocumentation": "`FramerateDenominator`\n\nFramerate denominator.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-frameratedenominator", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "GopSize": { "Required": false, "MarkdownDocumentation": "`GopSize`\n\nGOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-gopsize", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "AdaptiveQuantization": { "Required": false, "MarkdownDocumentation": "`AdaptiveQuantization`\n\nAdaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-adaptivequantization", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TileWidth": { "Required": false, "MarkdownDocumentation": "`TileWidth`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-tilewidth", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "FilterSettings": { "Type": "H265FilterSettings", "Required": false, "MarkdownDocumentation": "`FilterSettings`\n\nOptional filters that you can apply to an encode.\n*Required*: No\n*Type*: [H265FilterSettings](./aws-properties-medialive-channel-h265filtersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-filtersettings", "UpdateType": "Mutable" }, "MinQp": { "Required": false, "MarkdownDocumentation": "`MinQp`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-minqp", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AlternativeTransferFunction": { "Required": false, "MarkdownDocumentation": "`AlternativeTransferFunction`\n\nWhether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-alternativetransferfunction", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ColorSpaceSettings": { "Type": "H265ColorSpaceSettings", "Required": false, "MarkdownDocumentation": "`ColorSpaceSettings`\n\nColor Space settings\n*Required*: No\n*Type*: [H265ColorSpaceSettings](./aws-properties-medialive-channel-h265colorspacesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-colorspacesettings", "UpdateType": "Mutable" }, "Tier": { "Required": false, "MarkdownDocumentation": "`Tier`\n\nH.265 Tier.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-tier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ParDenominator": { "Required": false, "MarkdownDocumentation": "`ParDenominator`\n\nPixel Aspect Ratio denominator.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-pardenominator", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "FixedAfd": { "Required": false, "MarkdownDocumentation": "`FixedAfd`\n\nFour bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-fixedafd", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GopSizeUnits": { "Required": false, "MarkdownDocumentation": "`GopSizeUnits`\n\nIndicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-gopsizeunits", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TilePadding": { "Required": false, "MarkdownDocumentation": "`TilePadding`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-tilepadding", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AfdSignaling": { "Required": false, "MarkdownDocumentation": "`AfdSignaling`\n\nIndicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-afdsignaling", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Bitrate": { "Required": false, "MarkdownDocumentation": "`Bitrate`\n\nAverage bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-bitrate", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ParNumerator": { "Required": false, "MarkdownDocumentation": "`ParNumerator`\n\nPixel Aspect Ratio numerator.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-parnumerator", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RateControlMode": { "Required": false, "MarkdownDocumentation": "`RateControlMode`\n\nRate control mode.\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.\nMultiplex: This rate control mode is only supported (and is required) when the video is being\ndelivered to a MediaLive Multiplex in which case the rate control configuration is controlled\nby the properties within the Multiplex Program.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-ratecontrolmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ScanType": { "Required": false, "MarkdownDocumentation": "`ScanType`\n\nSets the scan type of the output to progressive or top-field-first interlaced.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-scantype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BufSize": { "Required": false, "MarkdownDocumentation": "`BufSize`\n\nSize of buffer (HRD buffer model) in bits.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-bufsize", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TimecodeInsertion": { "Required": false, "MarkdownDocumentation": "`TimecodeInsertion`\n\nDetermines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-timecodeinsertion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Deblocking": { "Required": false, "MarkdownDocumentation": "`Deblocking`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-deblocking", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ColorMetadata": { "Required": false, "MarkdownDocumentation": "`ColorMetadata`\n\nIncludes colorspace metadata in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-colormetadata", "PrimitiveType": "String", "UpdateType": "Mutable" }, "LookAheadRateControl": { "Required": false, "MarkdownDocumentation": "`LookAheadRateControl`\n\nAmount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-lookaheadratecontrol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GopBReference": { "Required": false, "MarkdownDocumentation": "`GopBReference`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-gopbreference", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Level": { "Required": false, "MarkdownDocumentation": "`Level`\n\nH.265 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-level", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaxBitrate": { "Required": false, "MarkdownDocumentation": "`MaxBitrate`\n\nFor QVBR: See the tooltip for Quality level\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-maxbitrate", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TreeblockSize": { "Required": false, "MarkdownDocumentation": "`TreeblockSize`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-treeblocksize", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SubgopLength": { "Required": false, "MarkdownDocumentation": "`SubgopLength`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-subgoplength", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GopNumBFrames": { "Required": false, "MarkdownDocumentation": "`GopNumBFrames`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-h265settings.html#cfn-medialive-channel-h265settings-gopnumbframes", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Hdr10Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Hdr10Settings`\n\nHdr10 Settings\nThe parents of this entity are H265ColorSpaceSettings (for color space settings in the\noutput) and VideoSelectorColorSpaceSettings (for color space settings in the\ninput).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hdr10settings.html", "Properties": { "MaxCll": { "Required": false, "MarkdownDocumentation": "`MaxCll`\n\nMaximum Content Light Level\nAn integer metadata value defining the maximum light level, in nits,\nof any single pixel within an encoded HDR video stream or file.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hdr10settings.html#cfn-medialive-channel-hdr10settings-maxcll", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MaxFall": { "Required": false, "MarkdownDocumentation": "`MaxFall`\n\nMaximum Frame Average Light Level\nAn integer metadata value defining the maximum average light level, in nits,\nfor any single frame within an encoded HDR video stream or file.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hdr10settings.html#cfn-medialive-channel-hdr10settings-maxfall", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Hlg2020Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Hlg2020Settings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlg2020settings.html", "Properties": {} }, "AWS::MediaLive::Channel.HlsAkamaiSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsAkamaiSettings`\n\nThe Akamai settings in an HLS output.\nThe parent of this entity is HlsCdnSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.html", "Properties": { "Salt": { "Required": false, "MarkdownDocumentation": "`Salt`\n\nThe salt for authenticated Akamai.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.html#cfn-medialive-channel-hlsakamaisettings-salt", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FilecacheDuration": { "Required": false, "MarkdownDocumentation": "`FilecacheDuration`\n\nThe size, in seconds, of the file cache for streaming outputs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.html#cfn-medialive-channel-hlsakamaisettings-filecacheduration", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "NumRetries": { "Required": false, "MarkdownDocumentation": "`NumRetries`\n\nThe number of retry attempts that will be made before the channel is put into an error\nstate.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.html#cfn-medialive-channel-hlsakamaisettings-numretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Token": { "Required": false, "MarkdownDocumentation": "`Token`\n\nThe token parameter for authenticated Akamai. If this is not specified, \\_gda\\_ is\nused.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.html#cfn-medialive-channel-hlsakamaisettings-token", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RestartDelay": { "Required": false, "MarkdownDocumentation": "`RestartDelay`\n\nIf a streaming output fails, the number of seconds to wait until a restart is\ninitiated. A value of 0 means never restart.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.html#cfn-medialive-channel-hlsakamaisettings-restartdelay", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ConnectionRetryInterval": { "Required": false, "MarkdownDocumentation": "`ConnectionRetryInterval`\n\nThe number of seconds to wait before retrying a connection to the CDN if the\nconnection is lost.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.html#cfn-medialive-channel-hlsakamaisettings-connectionretryinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "HttpTransferMode": { "Required": false, "MarkdownDocumentation": "`HttpTransferMode`\n\nSpecifies whether to use chunked transfer encoding to Akamai. To enable this feature,\ncontact Akamai.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsakamaisettings.html#cfn-medialive-channel-hlsakamaisettings-httptransfermode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsBasicPutSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsBasicPutSettings`\n\nThe configuration of HLS Basic Put Settings.\nThe parent of this entity is HlsCdnSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsbasicputsettings.html", "Properties": { "FilecacheDuration": { "Required": false, "MarkdownDocumentation": "`FilecacheDuration`\n\nThe size, in seconds, of the file cache for streaming outputs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsbasicputsettings.html#cfn-medialive-channel-hlsbasicputsettings-filecacheduration", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "NumRetries": { "Required": false, "MarkdownDocumentation": "`NumRetries`\n\nThe number of retry attempts that MediaLive makes before the channel is put into an\nerror state.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsbasicputsettings.html#cfn-medialive-channel-hlsbasicputsettings-numretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RestartDelay": { "Required": false, "MarkdownDocumentation": "`RestartDelay`\n\nIf a streaming output fails, the number of seconds to wait until a restart is\ninitiated. A value of 0 means never restart.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsbasicputsettings.html#cfn-medialive-channel-hlsbasicputsettings-restartdelay", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ConnectionRetryInterval": { "Required": false, "MarkdownDocumentation": "`ConnectionRetryInterval`\n\nThe number of seconds to wait before retrying a connection to the CDN if the\nconnection is lost.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsbasicputsettings.html#cfn-medialive-channel-hlsbasicputsettings-connectionretryinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsCdnSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsCdnSettings`\n\nThe settings for the CDN of an HLS output.\nThe parent of this entity is HlsGroupSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlscdnsettings.html", "Properties": { "HlsWebdavSettings": { "Type": "HlsWebdavSettings", "Required": false, "MarkdownDocumentation": "`HlsWebdavSettings`\n\nThe settings for Web VTT captions in the HLS output group.\nThe parent of this entity is HlsGroupSettings.\n*Required*: No\n*Type*: [HlsWebdavSettings](./aws-properties-medialive-channel-hlswebdavsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlscdnsettings.html#cfn-medialive-channel-hlscdnsettings-hlswebdavsettings", "UpdateType": "Mutable" }, "HlsS3Settings": { "Type": "HlsS3Settings", "Required": false, "MarkdownDocumentation": "`HlsS3Settings`\n\nSets up Amazon S3 as the destination for this HLS output.\n*Required*: No\n*Type*: [HlsS3Settings](./aws-properties-medialive-channel-hlss3settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlscdnsettings.html#cfn-medialive-channel-hlscdnsettings-hlss3settings", "UpdateType": "Mutable" }, "HlsAkamaiSettings": { "Type": "HlsAkamaiSettings", "Required": false, "MarkdownDocumentation": "`HlsAkamaiSettings`\n\nSets up Akamai as the downstream system for the HLS output group.\n*Required*: No\n*Type*: [HlsAkamaiSettings](./aws-properties-medialive-channel-hlsakamaisettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlscdnsettings.html#cfn-medialive-channel-hlscdnsettings-hlsakamaisettings", "UpdateType": "Mutable" }, "HlsBasicPutSettings": { "Type": "HlsBasicPutSettings", "Required": false, "MarkdownDocumentation": "`HlsBasicPutSettings`\n\nThe settings for Basic Put for the HLS output.\n*Required*: No\n*Type*: [HlsBasicPutSettings](./aws-properties-medialive-channel-hlsbasicputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlscdnsettings.html#cfn-medialive-channel-hlscdnsettings-hlsbasicputsettings", "UpdateType": "Mutable" }, "HlsMediaStoreSettings": { "Type": "HlsMediaStoreSettings", "Required": false, "MarkdownDocumentation": "`HlsMediaStoreSettings`\n\nSets up MediaStore as the destination for the HLS output.\n*Required*: No\n*Type*: [HlsMediaStoreSettings](./aws-properties-medialive-channel-hlsmediastoresettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlscdnsettings.html#cfn-medialive-channel-hlscdnsettings-hlsmediastoresettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsGroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsGroupSettings`\n\nThe settings for an HLS output group.\nThe parent of this entity is OutputGroupSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html", "Properties": { "SegmentationMode": { "Required": false, "MarkdownDocumentation": "`SegmentationMode`\n\nuseInputSegmentation has been deprecated. The configured segment size is always\nused.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-segmentationmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Destination": { "Type": "OutputLocationRef", "Required": false, "MarkdownDocumentation": "`Destination`\n\nA directory or HTTP destination for the HLS segments, manifest files, and encryption\nkeys (if enabled).\n*Required*: No\n*Type*: [OutputLocationRef](./aws-properties-medialive-channel-outputlocationref.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-destination", "UpdateType": "Mutable" }, "CodecSpecification": { "Required": false, "MarkdownDocumentation": "`CodecSpecification`\n\nThe specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist\ngeneration.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-codecspecification", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IvSource": { "Required": false, "MarkdownDocumentation": "`IvSource`\n\nUsed with encryptionType. The IV (initialization vector) is a 128-bit number used in\nconjunction with the key for encrypting blocks. If this setting is\n\"followsSegmentNumber,\" it causes the IV to change every segment (to match the segment\nnumber). If this is set to \"explicit,\" you must enter a constantIv 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-ivsource", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimedMetadataId3Frame": { "Required": false, "MarkdownDocumentation": "`TimedMetadataId3Frame`\n\nIndicates the ID3 frame that has the timecode.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-timedmetadataid3frame", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KeyFormatVersions": { "Required": false, "MarkdownDocumentation": "`KeyFormatVersions`\n\nEither a single positive integer version value or a slash-delimited list of version\nvalues (1/2/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-keyformatversions", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RedundantManifest": { "Required": false, "MarkdownDocumentation": "`RedundantManifest`\n\nENABLED: The master manifest (.m3u8 file) for each pipeline includes information about\nboth pipelines: first its own media files, then the media files of the other pipeline.\nThis feature allows a playout device that supports stale manifest detection to switch\nfrom one manifest to the other, when the current manifest seems to be stale. There are\nstill two destinations and two master manifests, but both master manifests reference the\nmedia files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each\npipeline includes information about its own pipeline only. For an HLS output group with\nMediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage\nregenerates the manifests it serves to players, so a redundant manifest from MediaLive\nis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-redundantmanifest", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OutputSelection": { "Required": false, "MarkdownDocumentation": "`OutputSelection`\n\nMANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and\nmedia manifests) for this output group. SEGMENTSONLY: Doesn't generate any manifests for\nthis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-outputselection", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KeyProviderSettings": { "Type": "KeyProviderSettings", "Required": false, "MarkdownDocumentation": "`KeyProviderSettings`\n\nThe key provider settings.\n*Required*: No\n*Type*: [KeyProviderSettings](./aws-properties-medialive-channel-keyprovidersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-keyprovidersettings", "UpdateType": "Mutable" }, "StreamInfResolution": { "Required": false, "MarkdownDocumentation": "`StreamInfResolution`\n\nThe include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of\na variant 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-streaminfresolution", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CaptionLanguageMappings": { "Type": "List", "Required": false, "MarkdownDocumentation": "`CaptionLanguageMappings`\n\nA mapping of up to 4 captions channels to captions languages. This is meaningful only\nif captionLanguageSetting is set to \"insert.\"\n*Required*: No\n*Type*: Array of [CaptionLanguageMapping](./aws-properties-medialive-channel-captionlanguagemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-captionlanguagemappings", "ItemType": "CaptionLanguageMapping", "UpdateType": "Mutable" }, "HlsId3SegmentTagging": { "Required": false, "MarkdownDocumentation": "`HlsId3SegmentTagging`\n\nState of HLS ID3 Segment Tagging\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-hlsid3segmenttagging", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IFrameOnlyPlaylists": { "Required": false, "MarkdownDocumentation": "`IFrameOnlyPlaylists`\n\nDISABLED: Don't create an I-frame-only manifest, but do create the master and media\nmanifests (according to the Output Selection field). STANDARD: Create an I-frame-only\nmanifest for each output that contains video, as well as the other manifests (according\nto the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag\nto indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the\nI-frame position. For example, #EXT-X-BYTERANGE:160364@1461888\".\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-iframeonlyplaylists", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CaptionLanguageSetting": { "Required": false, "MarkdownDocumentation": "`CaptionLanguageSetting`\n\nApplies only to 608 embedded output captions. Insert: Include CLOSED-CAPTIONS lines in\nthe manifest. Specify at least one language in the CC1 Language Code field. One\nCLOSED-CAPTION line is added for each Language Code that you specify. Make sure to\nspecify the languages in the order in which they appear in the original source (if the\nsource is embedded format) or the order of the captions selectors (if the source is\nother than embedded). Otherwise, languages in the manifest will not match properly with\nthe output captions. None: Include the CLOSED-CAPTIONS=NONE line in the manifest. Omit:\nOmit any CLOSED-CAPTIONS line from the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-captionlanguagesetting", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KeepSegments": { "Required": false, "MarkdownDocumentation": "`KeepSegments`\n\nApplies only if the Mode field is LIVE. Specifies the number of media segments (.ts\nfiles) to retain in the destination directory.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-keepsegments", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ConstantIv": { "Required": false, "MarkdownDocumentation": "`ConstantIv`\n\nUsed with encryptionType. This is a 128-bit, 16-byte hex value that is represented by\na 32-character text string. If ivSource is set to \"explicit,\" this parameter is required\nand is used as the IV for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-constantiv", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DirectoryStructure": { "Required": false, "MarkdownDocumentation": "`DirectoryStructure`\n\nPlaces segments in subdirectories.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-directorystructure", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncryptionType": { "Required": false, "MarkdownDocumentation": "`EncryptionType`\n\nEncrypts the segments with the specified encryption scheme. Exclude this parameter if\nyou don't want 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-encryptiontype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AdMarkers": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AdMarkers`\n\nChooses one or more ad marker types to pass SCTE35 signals through to this group of\nApple HLS outputs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-admarkers", "UpdateType": "Mutable" }, "HlsCdnSettings": { "Type": "HlsCdnSettings", "Required": false, "MarkdownDocumentation": "`HlsCdnSettings`\n\nThe parameters that control interactions with the CDN.\n*Required*: No\n*Type*: [HlsCdnSettings](./aws-properties-medialive-channel-hlscdnsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-hlscdnsettings", "UpdateType": "Mutable" }, "IndexNSegments": { "Required": false, "MarkdownDocumentation": "`IndexNSegments`\n\nApplies only if the Mode field is LIVE. Specifies the maximum number of segments in\nthe media manifest file. After this maximum, older segments are removed from the media\nmanifest. This number must be less than or equal to the Keep Segments field.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-indexnsegments", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DiscontinuityTags": { "Required": false, "MarkdownDocumentation": "`DiscontinuityTags`\n\nSpecifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.\nTypically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose.\nChoose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-discontinuitytags", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InputLossAction": { "Required": false, "MarkdownDocumentation": "`InputLossAction`\n\nA parameter that controls output group behavior on an input loss.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-inputlossaction", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Mode": { "Required": false, "MarkdownDocumentation": "`Mode`\n\nIf \"vod,\" all segments are indexed and kept permanently in the destination and\nmanifest. If \"live,\" only the number segments specified in keepSegments and\nindexNSegments are kept. Newer segments replace older segments, which might prevent\nplayers from rewinding all the way to the beginning of the channel. VOD mode uses HLS\nEXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a \"VOD\" type\nmanifest 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-mode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TsFileMode": { "Required": false, "MarkdownDocumentation": "`TsFileMode`\n\nSEGMENTEDFILES: Emits the program as segments -multiple .ts media files. SINGLEFILE:\nApplies only if the Mode field is VOD. Emits the program as a single .ts media file. The\nmedia manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical\nuse for this value is when sending the output to AWS Elemental MediaConvert, which can\naccept only a single media file. Playback while the channel is running is not guaranteed\ndue to HTTP server caching.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-tsfilemode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BaseUrlManifest1": { "Required": false, "MarkdownDocumentation": "`BaseUrlManifest1`\n\nOptional. One value per output group.\nComplete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-baseurlmanifest1", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ClientCache": { "Required": false, "MarkdownDocumentation": "`ClientCache`\n\nWhen set to \"disabled,\" sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which\nprevents clients from saving media segments for later replay.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-clientcache", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MinSegmentLength": { "Required": false, "MarkdownDocumentation": "`MinSegmentLength`\n\nWhen set, minimumSegmentLength is enforced by looking ahead and back within the\nspecified range for a nearby avail and extending the segment size if needed.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-minsegmentlength", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "KeyFormat": { "Required": false, "MarkdownDocumentation": "`KeyFormat`\n\nSpecifies how the key is represented in the resource identified by the URI. If the\nparameter is absent, an implicit value of \"identity\" is used. A reverse DNS string can\nalso be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-keyformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IvInManifest": { "Required": false, "MarkdownDocumentation": "`IvInManifest`\n\nUsed with encryptionType. The IV (initialization vector) is a 128-bit number used in\nconjunction with the key for encrypting blocks. If set to \"include,\" the IV is listed in\nthe manifest. Otherwise, the IV is not in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-ivinmanifest", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BaseUrlContent1": { "Required": false, "MarkdownDocumentation": "`BaseUrlContent1`\n\nOptional. One value per output group.\nThis field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-baseurlcontent1", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ProgramDateTimeClock": { "Required": false, "MarkdownDocumentation": "`ProgramDateTimeClock`\n\nSpecifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include:\nINITIALIZE\\_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.\nSYSTEM\\_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-programdatetimeclock", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ManifestCompression": { "Required": false, "MarkdownDocumentation": "`ManifestCompression`\n\nWhen set to gzip, compresses HLS playlist.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-manifestcompression", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ManifestDurationFormat": { "Required": false, "MarkdownDocumentation": "`ManifestDurationFormat`\n\nIndicates whether the output manifest should use a floating point or integer values\nfor segment duration.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-manifestdurationformat", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimedMetadataId3Period": { "Required": false, "MarkdownDocumentation": "`TimedMetadataId3Period`\n\nThe timed metadata interval, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-timedmetadataid3period", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "IncompleteSegmentBehavior": { "Required": false, "MarkdownDocumentation": "`IncompleteSegmentBehavior`\n\nSpecifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.\nAuto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups.\nSuppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-incompletesegmentbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ProgramDateTimePeriod": { "Required": false, "MarkdownDocumentation": "`ProgramDateTimePeriod`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-programdatetimeperiod", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SegmentLength": { "Required": false, "MarkdownDocumentation": "`SegmentLength`\n\nThe length of the MPEG-2 Transport Stream segments to create, in seconds. Note that\nsegments will end on the next keyframe after this number of seconds, so the actual\nsegment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-segmentlength", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TimestampDeltaMilliseconds": { "Required": false, "MarkdownDocumentation": "`TimestampDeltaMilliseconds`\n\nProvides an extra millisecond delta offset to fine tune the timestamps.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-timestampdeltamilliseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ProgramDateTime": { "Required": false, "MarkdownDocumentation": "`ProgramDateTime`\n\nIncludes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The\nvalue is calculated as follows: Either the program date and time are initialized using\nthe input timecode source, or the time is initialized using the input timecode source\nand 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-programdatetime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SegmentsPerSubdirectory": { "Required": false, "MarkdownDocumentation": "`SegmentsPerSubdirectory`\n\nThe number of segments to write to a subdirectory before starting a new one. For this\nsetting to have an effect, directoryStructure must be subdirectoryPerStream.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-segmentspersubdirectory", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "BaseUrlContent": { "Required": false, "MarkdownDocumentation": "`BaseUrlContent`\n\nA partial URI prefix that will be prepended to each output in the media .m3u8 file.\nThe partial URI prefix can be used if the base manifest is delivered from a different\nURL than the main .m3u8 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-baseurlcontent", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BaseUrlManifest": { "Required": false, "MarkdownDocumentation": "`BaseUrlManifest`\n\nA partial URI prefix that will be prepended to each output in the media .m3u8 file.\nThe partial URI prefix can be used if the base manifest is delivered from a different\nURL than the main .m3u8 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsgroupsettings.html#cfn-medialive-channel-hlsgroupsettings-baseurlmanifest", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsInputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsInputSettings`\n\nInformation about how to connect to the upstream system.\nThe parent of this entity is NetworkInputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html", "Properties": { "Scte35Source": { "Required": false, "MarkdownDocumentation": "`Scte35Source`\n\nIdentifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-scte35source", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BufferSegments": { "Required": false, "MarkdownDocumentation": "`BufferSegments`\n\nWhen specified, reading of the HLS input begins this many buffer segments from the end\n(most recently written segment). When not specified, the HLS input begins with the first\nsegment specified in the m3u8.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-buffersegments", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Retries": { "Required": false, "MarkdownDocumentation": "`Retries`\n\nThe number of consecutive times that attempts to read a manifest or segment must fail\nbefore the input is considered unavailable.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-retries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Bandwidth": { "Required": false, "MarkdownDocumentation": "`Bandwidth`\n\nWhen specified, the HLS stream with the m3u8 bandwidth that most closely matches this\nvalue is chosen. Otherwise, the highest bandwidth stream in the m3u8 is chosen. The\nbitrate is specified in bits per second, as in an HLS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-bandwidth", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RetryInterval": { "Required": false, "MarkdownDocumentation": "`RetryInterval`\n\nThe number of seconds between retries when an attempt to read a manifest or segment\nfails.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsinputsettings.html#cfn-medialive-channel-hlsinputsettings-retryinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsMediaStoreSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsMediaStoreSettings`\n\nThe configuration of a MediaStore container as the destination for an HLS\noutput.\nThe parent of this entity is HlsCdnSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsmediastoresettings.html", "Properties": { "FilecacheDuration": { "Required": false, "MarkdownDocumentation": "`FilecacheDuration`\n\nThe size, in seconds, of the file cache for streaming outputs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsmediastoresettings.html#cfn-medialive-channel-hlsmediastoresettings-filecacheduration", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "NumRetries": { "Required": false, "MarkdownDocumentation": "`NumRetries`\n\nThe number of retry attempts that are made before the channel is put into an error\nstate.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsmediastoresettings.html#cfn-medialive-channel-hlsmediastoresettings-numretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MediaStoreStorageClass": { "Required": false, "MarkdownDocumentation": "`MediaStoreStorageClass`\n\nWhen set to temporal, output files are stored in non-persistent memory for faster\nreading and writing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsmediastoresettings.html#cfn-medialive-channel-hlsmediastoresettings-mediastorestorageclass", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RestartDelay": { "Required": false, "MarkdownDocumentation": "`RestartDelay`\n\nIf a streaming output fails, the number of seconds to wait until a restart is\ninitiated. A value of 0 means never restart.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsmediastoresettings.html#cfn-medialive-channel-hlsmediastoresettings-restartdelay", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ConnectionRetryInterval": { "Required": false, "MarkdownDocumentation": "`ConnectionRetryInterval`\n\nThe number of seconds to wait before retrying a connection to the CDN if the\nconnection is lost.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsmediastoresettings.html#cfn-medialive-channel-hlsmediastoresettings-connectionretryinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsOutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsOutputSettings`\n\nThe settings for an HLS output.\nThe parent of this entity is OutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsoutputsettings.html", "Properties": { "NameModifier": { "Required": false, "MarkdownDocumentation": "`NameModifier`\n\nA string that is concatenated to the end of the destination file name. Accepts\n\\\"Format Identifiers\\\":#formatIdentifierParameters.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsoutputsettings.html#cfn-medialive-channel-hlsoutputsettings-namemodifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HlsSettings": { "Type": "HlsSettings", "Required": false, "MarkdownDocumentation": "`HlsSettings`\n\nThe settings regarding the underlying stream. These settings are different for\naudio-only outputs.\n*Required*: No\n*Type*: [HlsSettings](./aws-properties-medialive-channel-hlssettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsoutputsettings.html#cfn-medialive-channel-hlsoutputsettings-hlssettings", "UpdateType": "Mutable" }, "H265PackagingType": { "Required": false, "MarkdownDocumentation": "`H265PackagingType`\n\nOnly applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsoutputsettings.html#cfn-medialive-channel-hlsoutputsettings-h265packagingtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SegmentModifier": { "Required": false, "MarkdownDocumentation": "`SegmentModifier`\n\nA string that is concatenated to the end of segment file names.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlsoutputsettings.html#cfn-medialive-channel-hlsoutputsettings-segmentmodifier", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsS3Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsS3Settings`\n\nSets up Amazon S3 as the destination for this HLS output.\nThe parent of this entity is HlsCdnSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlss3settings.html", "Properties": { "CannedAcl": { "Required": false, "MarkdownDocumentation": "`CannedAcl`\n\nSpecify the canned ACL to apply to each S3 request. Defaults to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlss3settings.html#cfn-medialive-channel-hlss3settings-cannedacl", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsSettings`\n\nThe settings for an HLS output.\nThe parent of this entity is HlsOutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlssettings.html", "Properties": { "StandardHlsSettings": { "Type": "StandardHlsSettings", "Required": false, "MarkdownDocumentation": "`StandardHlsSettings`\n\nThe settings for a standard output (an output that is not audio-only).\n*Required*: No\n*Type*: [StandardHlsSettings](./aws-properties-medialive-channel-standardhlssettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlssettings.html#cfn-medialive-channel-hlssettings-standardhlssettings", "UpdateType": "Mutable" }, "AudioOnlyHlsSettings": { "Type": "AudioOnlyHlsSettings", "Required": false, "MarkdownDocumentation": "`AudioOnlyHlsSettings`\n\nThe settings for an audio-only output.\n*Required*: No\n*Type*: [AudioOnlyHlsSettings](./aws-properties-medialive-channel-audioonlyhlssettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlssettings.html#cfn-medialive-channel-hlssettings-audioonlyhlssettings", "UpdateType": "Mutable" }, "Fmp4HlsSettings": { "Type": "Fmp4HlsSettings", "Required": false, "MarkdownDocumentation": "`Fmp4HlsSettings`\n\nThe settings for an fMP4 container.\n*Required*: No\n*Type*: [Fmp4HlsSettings](./aws-properties-medialive-channel-fmp4hlssettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlssettings.html#cfn-medialive-channel-hlssettings-fmp4hlssettings", "UpdateType": "Mutable" }, "FrameCaptureHlsSettings": { "Type": "FrameCaptureHlsSettings", "Required": false, "MarkdownDocumentation": "`FrameCaptureHlsSettings`\n\nSettings for a frame capture output in an HLS output group.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlssettings.html#cfn-medialive-channel-hlssettings-framecapturehlssettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HlsWebdavSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HlsWebdavSettings`\n\nThe configuration of a WebDav server as the downstream system for an HLS\noutput.\nThe parent of this entity is HlsCdnSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlswebdavsettings.html", "Properties": { "FilecacheDuration": { "Required": false, "MarkdownDocumentation": "`FilecacheDuration`\n\nThe size, in seconds, of the file cache for streaming outputs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlswebdavsettings.html#cfn-medialive-channel-hlswebdavsettings-filecacheduration", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "NumRetries": { "Required": false, "MarkdownDocumentation": "`NumRetries`\n\nThe number of retry attempts that are made before the channel is put into an error\nstate.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlswebdavsettings.html#cfn-medialive-channel-hlswebdavsettings-numretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RestartDelay": { "Required": false, "MarkdownDocumentation": "`RestartDelay`\n\nIf a streaming output fails, the number of seconds to wait until a restart is\ninitiated. A value of 0 means never restart.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlswebdavsettings.html#cfn-medialive-channel-hlswebdavsettings-restartdelay", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ConnectionRetryInterval": { "Required": false, "MarkdownDocumentation": "`ConnectionRetryInterval`\n\nThe number of seconds to wait before retrying a connection to the CDN if the\nconnection is lost.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlswebdavsettings.html#cfn-medialive-channel-hlswebdavsettings-connectionretryinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "HttpTransferMode": { "Required": false, "MarkdownDocumentation": "`HttpTransferMode`\n\nSpecifies whether to use chunked transfer encoding to WebDAV.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-hlswebdavsettings.html#cfn-medialive-channel-hlswebdavsettings-httptransfermode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.HtmlMotionGraphicsSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.HtmlMotionGraphicsSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-htmlmotiongraphicssettings.html", "Properties": {} }, "AWS::MediaLive::Channel.InputAttachment": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.InputAttachment`\n\nAn input to attach to this channel.\nThis entity is at the top level in the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html", "Properties": { "InputAttachmentName": { "Required": false, "MarkdownDocumentation": "`InputAttachmentName`\n\nA name for the attachment. This is required if you want to use this input in an input\nswitch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputattachmentname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "LogicalInterfaceNames": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`LogicalInterfaceNames`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-logicalinterfacenames", "UpdateType": "Mutable" }, "InputId": { "Required": false, "MarkdownDocumentation": "`InputId`\n\nThe ID of the input to attach.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AutomaticInputFailoverSettings": { "Type": "AutomaticInputFailoverSettings", "Required": false, "MarkdownDocumentation": "`AutomaticInputFailoverSettings`\n\nSettings to implement automatic input failover in this input.\n*Required*: No\n*Type*: [AutomaticInputFailoverSettings](./aws-properties-medialive-channel-automaticinputfailoversettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-automaticinputfailoversettings", "UpdateType": "Mutable" }, "InputSettings": { "Type": "InputSettings", "Required": false, "MarkdownDocumentation": "`InputSettings`\n\nInformation about the content to extract from the input and about the general handling\nof the content.\n*Required*: No\n*Type*: [InputSettings](./aws-properties-medialive-channel-inputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputattachment.html#cfn-medialive-channel-inputattachment-inputsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.InputChannelLevel": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.InputChannelLevel`\n\nThe setting to remix the audio.\nThe parent of this entity is AudioChannelMappings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputchannellevel.html", "Properties": { "InputChannel": { "Required": false, "MarkdownDocumentation": "`InputChannel`\n\nThe index of the input channel that is used as a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputchannellevel.html#cfn-medialive-channel-inputchannellevel-inputchannel", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Gain": { "Required": false, "MarkdownDocumentation": "`Gain`\n\nThe remixing value. Units are in dB, and acceptable values are within the range from\n-60 (mute) to 6 dB.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputchannellevel.html#cfn-medialive-channel-inputchannellevel-gain", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.InputLocation": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.InputLocation`\n\nThe input location.\nThe parent of this entity is InputLossBehavior.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlocation.html", "Properties": { "Username": { "Required": false, "MarkdownDocumentation": "`Username`\n\nThe user name to connect to the downstream system. This applies only if the downstream\nsystem requires 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlocation.html#cfn-medialive-channel-inputlocation-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PasswordParam": { "Required": false, "MarkdownDocumentation": "`PasswordParam`\n\nThe password parameter that holds the password for accessing the downstream system.\nThis applies only if the downstream system requires 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlocation.html#cfn-medialive-channel-inputlocation-passwordparam", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Uri": { "Required": false, "MarkdownDocumentation": "`Uri`\n\nThe URI should be a path to a file that is accessible to the Live system (for example,\nan http:// URI) depending on the output type. For example, an RTMP destination should\nhave a URI similar to rtmp://fmsserver/live.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlocation.html#cfn-medialive-channel-inputlocation-uri", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.InputLossBehavior": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.InputLossBehavior`\n\nThe configuration of channel behavior when the input is lost.\nThe parent of this entity is GlobalConfiguration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossbehavior.html", "Properties": { "InputLossImageColor": { "Required": false, "MarkdownDocumentation": "`InputLossImageColor`\n\nWhen the input loss image type is \"color,\" this field specifies the color to use.\nValue: 6 hex characters that represent the values of RGB.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossbehavior.html#cfn-medialive-channel-inputlossbehavior-inputlossimagecolor", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BlackFrameMsec": { "Required": false, "MarkdownDocumentation": "`BlackFrameMsec`\n\nOn input loss, the number of milliseconds to substitute black into the output before\nswitching to the frame specified by inputLossImageType. A value x, where 0 <= x <=\n1,000,000 and a value of 1,000,000, is interpreted as infinite.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossbehavior.html#cfn-medialive-channel-inputlossbehavior-blackframemsec", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "InputLossImageType": { "Required": false, "MarkdownDocumentation": "`InputLossImageType`\n\nIndicates whether to substitute a solid color or a slate into the output after the\ninput loss exceeds blackFrameMsec.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossbehavior.html#cfn-medialive-channel-inputlossbehavior-inputlossimagetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InputLossImageSlate": { "Type": "InputLocation", "Required": false, "MarkdownDocumentation": "`InputLossImageSlate`\n\nWhen the input loss image type is \"slate,\" these fields specify the parameters for\naccessing the slate.\n*Required*: No\n*Type*: [InputLocation](./aws-properties-medialive-channel-inputlocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossbehavior.html#cfn-medialive-channel-inputlossbehavior-inputlossimageslate", "UpdateType": "Mutable" }, "RepeatFrameMsec": { "Required": false, "MarkdownDocumentation": "`RepeatFrameMsec`\n\nOn input loss, the number of milliseconds to repeat the previous picture before\nsubstituting black into the output. A value x, where 0 <= x <= 1,000,000 and a\nvalue of 1,000,000, is interpreted as infinite.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossbehavior.html#cfn-medialive-channel-inputlossbehavior-repeatframemsec", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.InputLossFailoverSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.InputLossFailoverSettings`\n\nMediaLive will perform a failover if content is not detected in this input for the\nspecified period.\nThe parent of this entity is FailoverConditionSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossfailoversettings.html", "Properties": { "InputLossThresholdMsec": { "Required": false, "MarkdownDocumentation": "`InputLossThresholdMsec`\n\nThe amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputlossfailoversettings.html#cfn-medialive-channel-inputlossfailoversettings-inputlossthresholdmsec", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.InputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.InputSettings`\n\nInformation about extracting content from the input and about handling the\ncontent.\nThe parent of this entity is InputAttachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html", "Properties": { "Scte35Pid": { "Required": false, "MarkdownDocumentation": "`Scte35Pid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-scte35pid", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DeblockFilter": { "Required": false, "MarkdownDocumentation": "`DeblockFilter`\n\nEnables or disables the deblock filter when filtering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-deblockfilter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FilterStrength": { "Required": false, "MarkdownDocumentation": "`FilterStrength`\n\nAdjusts 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-filterstrength", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "InputFilter": { "Required": false, "MarkdownDocumentation": "`InputFilter`\n\nTurns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled\nby default. 1) auto - filtering is applied depending on input type/quality 2) disabled -\nno filtering is applied to the input 3) forced - filtering is applied regardless of the\ninput 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-inputfilter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SourceEndBehavior": { "Required": false, "MarkdownDocumentation": "`SourceEndBehavior`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-sourceendbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "VideoSelector": { "Type": "VideoSelector", "Required": false, "MarkdownDocumentation": "`VideoSelector`\n\nInformation about one video to extract from the input.\n*Required*: No\n*Type*: [VideoSelector](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-videoselector", "UpdateType": "Mutable" }, "Smpte2038DataPreference": { "Required": false, "MarkdownDocumentation": "`Smpte2038DataPreference`\n\nSpecifies 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.\n- PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).\n- 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-smpte2038datapreference", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioSelectors": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AudioSelectors`\n\nInformation about the specific audio to extract from the input.\nThe parent of this entity is InputSettings.\n*Required*: No\n*Type*: Array of [AudioSelector](./aws-properties-medialive-channel-audioselector.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-audioselectors", "ItemType": "AudioSelector", "UpdateType": "Mutable" }, "CaptionSelectors": { "Type": "List", "Required": false, "MarkdownDocumentation": "`CaptionSelectors`\n\nInformation about the specific captions to extract from the input.\n*Required*: No\n*Type*: Array of [CaptionSelector](./aws-properties-medialive-channel-captionselector.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-captionselectors", "ItemType": "CaptionSelector", "UpdateType": "Mutable" }, "DenoiseFilter": { "Required": false, "MarkdownDocumentation": "`DenoiseFilter`\n\nEnables or disables the denoise filter when filtering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-denoisefilter", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NetworkInputSettings": { "Type": "NetworkInputSettings", "Required": false, "MarkdownDocumentation": "`NetworkInputSettings`\n\nInformation about how to connect to the upstream system.\n*Required*: No\n*Type*: [NetworkInputSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputsettings.html#cfn-medialive-channel-inputsettings-networkinputsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.InputSpecification": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.InputSpecification`\n\nThe input specification for this channel. It specifies the key characteristics of the\ninputs for this channel: the maximum bitrate, the resolution, and the codec.\nThis entity is at the top level in the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.html", "Properties": { "Codec": { "Required": false, "MarkdownDocumentation": "`Codec`\n\nThe codec to include in the input specification for this channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.html#cfn-medialive-channel-inputspecification-codec", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaximumBitrate": { "Required": false, "MarkdownDocumentation": "`MaximumBitrate`\n\nThe maximum input bitrate for any input attached to this channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.html#cfn-medialive-channel-inputspecification-maximumbitrate", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Resolution": { "Required": false, "MarkdownDocumentation": "`Resolution`\n\nThe resolution for any input attached to this channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-inputspecification.html#cfn-medialive-channel-inputspecification-resolution", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.KeyProviderSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.KeyProviderSettings`\n\nThe configuration of key provider settings.\nThe parent of this entity is HlsGroupSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-keyprovidersettings.html", "Properties": { "StaticKeySettings": { "Type": "StaticKeySettings", "Required": false, "MarkdownDocumentation": "`StaticKeySettings`\n\nThe configuration of static key settings.\n*Required*: No\n*Type*: [StaticKeySettings](./aws-properties-medialive-channel-statickeysettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-keyprovidersettings.html#cfn-medialive-channel-keyprovidersettings-statickeysettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.M2tsSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.M2tsSettings`\n\nThe configuration of the M2TS in the output.\nThe parents of this entity are ArchiveContainerSettings and\nUdpContainerSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html", "Properties": { "EtvPlatformPid": { "Required": false, "MarkdownDocumentation": "`EtvPlatformPid`\n\nThe PID for the input source ETV Platform data to this output. You can enter it as a\ndecimal or hexadecimal value. Valid values are 32 (or 0x20) to 8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-etvplatformpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PatInterval": { "Required": false, "MarkdownDocumentation": "`PatInterval`\n\nThe number of milliseconds between instances of this table in the output transport\nstream. Valid values are 0, 10..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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-patinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ProgramNum": { "Required": false, "MarkdownDocumentation": "`ProgramNum`\n\nThe value of the program number field in the Program Map Table (PMT).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-programnum", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RateMode": { "Required": false, "MarkdownDocumentation": "`RateMode`\n\nWhen VBR, does not insert null packets into the transport stream to fill the specified\nbitrate. The bitrate setting acts as the maximum bitrate when VBR is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-ratemode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KlvDataPids": { "Required": false, "MarkdownDocumentation": "`KlvDataPids`\n\nThe PID for the input source KLV data to this output. Multiple values are accepted,\nand can be entered in ranges or by comma separation. You can enter the value as a\ndecimal or hexadecimal value. Each PID specified must be in the range of 32 (or\n0x20)..8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-klvdatapids", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NullPacketBitrate": { "Required": false, "MarkdownDocumentation": "`NullPacketBitrate`\n\nThe value, in bits per second, of extra null packets to insert into the transport\nstream. This can be used if a downstream encryption system requires periodic null\npackets.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-nullpacketbitrate", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "PmtInterval": { "Required": false, "MarkdownDocumentation": "`PmtInterval`\n\nThe number of milliseconds between instances of this table in the output transport\nstream. Valid values are 0, 10..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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-pmtinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AribCaptionsPid": { "Required": false, "MarkdownDocumentation": "`AribCaptionsPid`\n\nThe PID for ARIB Captions in the transport stream. You can enter the value as a\ndecimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-aribcaptionspid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EsRateInPes": { "Required": false, "MarkdownDocumentation": "`EsRateInPes`\n\nIncludes or excludes the ES Rate field in the PES 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-esrateinpes", "PrimitiveType": "String", "UpdateType": "Mutable" }, "VideoPid": { "Required": false, "MarkdownDocumentation": "`VideoPid`\n\nThe PID of the elementary video stream in the transport stream. You can enter the\nvalue as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or\n0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-videopid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TransportStreamId": { "Required": false, "MarkdownDocumentation": "`TransportStreamId`\n\nThe value of the transport stream ID field in the Program Map Table (PMT).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-transportstreamid", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "EbpPlacement": { "Required": false, "MarkdownDocumentation": "`EbpPlacement`\n\nControls placement of EBP on audio PIDs. If set to videoAndAudioPids, EBP markers are\nplaced on the video PID and all audio PIDs. If set to videoPid, EBP markers are placed\non only the video PID.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-ebpplacement", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DvbSubPids": { "Required": false, "MarkdownDocumentation": "`DvbSubPids`\n\nThe PID for the input source DVB Subtitle data to this output. Multiple values are\naccepted, and can be entered in ranges and/or by comma separation. You can enter the\nvalue as a decimal or hexadecimal value. Each PID specified must be in the range of 32\n(or 0x20)..8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-dvbsubpids", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SegmentationStyle": { "Required": false, "MarkdownDocumentation": "`SegmentationStyle`\n\nThe segmentation style parameter controls how segmentation markers are inserted into\nthe transport stream. With avails, it is possible that segments might be truncated,\nwhich can influence where future segmentation markers are inserted. When a segmentation\nstyle of resetCadence is selected and a segment is truncated due to an avail, we will\nreset the segmentation cadence. This means the subsequent segment will have a duration\nof $segmentationTime seconds. When a segmentation style of maintainCadence is selected\nand a segment is truncated due to an avail, we will not reset the segmentation cadence.\nThis means the subsequent segment will likely be truncated as well. However, all\nsegments after that will have a duration of $segmentationTime seconds. Note that EBP\nlookahead is a slight exception to this rule.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-segmentationstyle", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Scte35Pid": { "Required": false, "MarkdownDocumentation": "`Scte35Pid`\n\nThe PID of the SCTE-35 stream in the transport stream. You can enter the value as a\ndecimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-scte35pid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioStreamType": { "Required": false, "MarkdownDocumentation": "`AudioStreamType`\n\nWhen set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3.\nWhen set to dvb, uses stream type = 0x06.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-audiostreamtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Klv": { "Required": false, "MarkdownDocumentation": "`Klv`\n\nIf set to passthrough, passes any KLV data from the input source to this\noutput.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-klv", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EbpLookaheadMs": { "Required": false, "MarkdownDocumentation": "`EbpLookaheadMs`\n\nWhen set, enforces that Encoder Boundary Points do not come within the specified time\ninterval of each other by looking ahead at input video. If another EBP is going to come\nin within the specified time interval, the current EBP is not emitted, and the segment\nis \"stretched\" to the next marker. The lookahead value does not add latency to the\nsystem. The channel must be configured elsewhere to create sufficient latency to make\nthe lookahead accurate.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-ebplookaheadms", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Scte35PrerollPullupMilliseconds": { "Required": false, "MarkdownDocumentation": "`Scte35PrerollPullupMilliseconds`\n\nProperty description not available.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-scte35prerollpullupmilliseconds", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "DvbTdtSettings": { "Type": "DvbTdtSettings", "Required": false, "MarkdownDocumentation": "`DvbTdtSettings`\n\nInserts DVB Time and Date Table (TDT) at the specified table repetition\ninterval.\n*Required*: No\n*Type*: [DvbTdtSettings](./aws-properties-medialive-channel-dvbtdtsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-dvbtdtsettings", "UpdateType": "Mutable" }, "TimedMetadataBehavior": { "Required": false, "MarkdownDocumentation": "`TimedMetadataBehavior`\n\nWhen set to passthrough, timed metadata is passed through from input to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-timedmetadatabehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EbpAudioInterval": { "Required": false, "MarkdownDocumentation": "`EbpAudioInterval`\n\nWhen videoAndFixedIntervals is selected, audio EBP markers are added to partitions 3\nand 4. The interval between these additional markers is fixed, and is slightly shorter\nthan the video EBP marker interval. This is only available when EBP Cablelabs\nsegmentation markers are selected. Partitions 1 and 2 always follow the video\ninterval.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-ebpaudiointerval", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FragmentTime": { "Required": false, "MarkdownDocumentation": "`FragmentTime`\n\nThe length in seconds of each fragment. This is used only with EBP markers.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-fragmenttime", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "DvbTeletextPid": { "Required": false, "MarkdownDocumentation": "`DvbTeletextPid`\n\nThe PID for the input source DVB Teletext data to this output. You can enter the value\nas a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or\n0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-dvbteletextpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Scte35Control": { "Required": false, "MarkdownDocumentation": "`Scte35Control`\n\nOptionally passes SCTE-35 signals from the input source to this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-scte35control", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PcrPeriod": { "Required": false, "MarkdownDocumentation": "`PcrPeriod`\n\nThe maximum time, in milliseconds, between Program Clock References (PCRs) inserted\ninto the transport stream.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-pcrperiod", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "NielsenId3Behavior": { "Required": false, "MarkdownDocumentation": "`NielsenId3Behavior`\n\nIf set to passthrough, Nielsen inaudible tones for media tracking will be detected in\nthe input audio and an equivalent ID3 tag will be inserted in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-nielsenid3behavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PcrPid": { "Required": false, "MarkdownDocumentation": "`PcrPid`\n\nThe PID of the Program Clock Reference (PCR) in the transport stream. When no value is\ngiven, MediaLive assigns the same value as the video PID. You can enter the value as a\ndecimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-pcrpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SegmentationTime": { "Required": false, "MarkdownDocumentation": "`SegmentationTime`\n\nThe length, in seconds, of each segment. This is required unless markers is set to\nNone\\_.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-segmentationtime", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "CcDescriptor": { "Required": false, "MarkdownDocumentation": "`CcDescriptor`\n\nWhen set to enabled, generates captionServiceDescriptor in PMT.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-ccdescriptor", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioFramesPerPes": { "Required": false, "MarkdownDocumentation": "`AudioFramesPerPes`\n\nThe number of audio frames to insert for each PES packet.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-audioframesperpes", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AbsentInputAudioBehavior": { "Required": false, "MarkdownDocumentation": "`AbsentInputAudioBehavior`\n\nWhen set to drop, the output audio streams are removed from the program if the\nselected input audio stream is removed from the input. This allows the output audio\nconfiguration to dynamically change based on the input configuration. If this is set to\nencodeSilence, all output audio streams will output encoded silence when not connected\nto an active input 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-absentinputaudiobehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Bitrate": { "Required": false, "MarkdownDocumentation": "`Bitrate`\n\nThe output bitrate of the transport stream in bits per second. Setting to 0 lets the\nmuxer automatically determine the appropriate bitrate.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-bitrate", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "PmtPid": { "Required": false, "MarkdownDocumentation": "`PmtPid`\n\nThe PID for the Program Map Table (PMT) in the transport stream. You can enter the\nvalue as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or\n0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-pmtpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Scte27Pids": { "Required": false, "MarkdownDocumentation": "`Scte27Pids`\n\nThe PID for the input source SCTE-27 data to this output. Multiple values are\naccepted, and can be entered in ranges or by comma separation. You can enter the value\nas a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or\n0x20)..8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-scte27pids", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SegmentationMarkers": { "Required": false, "MarkdownDocumentation": "`SegmentationMarkers`\n\nInserts segmentation markers at each segmentationTime period. raiSegstart sets the\nRandom Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds\nthe current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables\nat the start of segments. ebp adds Encoder Boundary Point information to the adaptation\nfield as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder\nBoundary Point information to the adaptation field using a legacy proprietary\nformat.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-segmentationmarkers", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DvbNitSettings": { "Type": "DvbNitSettings", "Required": false, "MarkdownDocumentation": "`DvbNitSettings`\n\nInserts a DVB Network Information Table (NIT) at the specified table repetition\ninterval.\n*Required*: No\n*Type*: [DvbNitSettings](./aws-properties-medialive-channel-dvbnitsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-dvbnitsettings", "UpdateType": "Mutable" }, "DvbSdtSettings": { "Type": "DvbSdtSettings", "Required": false, "MarkdownDocumentation": "`DvbSdtSettings`\n\nInserts a DVB Service Description Table (SDT) at the specified table repetition\ninterval.\n*Required*: No\n*Type*: [DvbSdtSettings](./aws-properties-medialive-channel-dvbsdtsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-dvbsdtsettings", "UpdateType": "Mutable" }, "EtvSignalPid": { "Required": false, "MarkdownDocumentation": "`EtvSignalPid`\n\nThe PID for input source ETV Signal data to this output. You can enter the value as a\ndecimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-etvsignalpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Arib": { "Required": false, "MarkdownDocumentation": "`Arib`\n\nWhen set to enabled, uses ARIB-compliant field muxing and removes video\ndescriptor.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-arib", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BufferModel": { "Required": false, "MarkdownDocumentation": "`BufferModel`\n\nIf set to multiplex, uses the multiplex buffer model for accurate interleaving.\nSetting to bufferModel to none can lead to lower latency, but low-memory devices might\nnot be able to play back the stream without interruptions.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-buffermodel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EcmPid": { "Required": false, "MarkdownDocumentation": "`EcmPid`\n\nThis field is unused and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-ecmpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimedMetadataPid": { "Required": false, "MarkdownDocumentation": "`TimedMetadataPid`\n\nThe PID of the timed metadata stream in the transport stream. You can enter the value\nas a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or\n0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-timedmetadatapid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioPids": { "Required": false, "MarkdownDocumentation": "`AudioPids`\n\nThe PID of the elementary audio streams in the transport stream. Multiple values are\naccepted, and can be entered in ranges or by comma separation. You can enter the value\nas a decimal or hexadecimal value. Each PID specified must be in the range of 32 (or\n0x20)..8182 (or 0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-audiopids", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioBufferModel": { "Required": false, "MarkdownDocumentation": "`AudioBufferModel`\n\nWhen set to dvb, uses the DVB buffer model for Dolby Digital audio. When set to atsc,\nthe ATSC model 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-audiobuffermodel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Ebif": { "Required": false, "MarkdownDocumentation": "`Ebif`\n\nIf set to passthrough, passes any EBIF data from the input source to this\noutput.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-ebif", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AribCaptionsPidControl": { "Required": false, "MarkdownDocumentation": "`AribCaptionsPidControl`\n\nIf set to auto, The PID number used for ARIB Captions will be auto-selected from\nunused PIDs. If set to useConfigured, ARIB captions will be on the configured PID\nnumber.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-aribcaptionspidcontrol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PcrControl": { "Required": false, "MarkdownDocumentation": "`PcrControl`\n\nWhen set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every\nPacketized Elementary Stream (PES) header. This parameter is effective only when the PCR\nPID is the same as the video or audio elementary 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m2tssettings.html#cfn-medialive-channel-m2tssettings-pcrcontrol", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.M3u8Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.M3u8Settings`\n\nSettings for the M3U8 container.\nThe parent of this entity is StandardHlsSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html", "Properties": { "PatInterval": { "Required": false, "MarkdownDocumentation": "`PatInterval`\n\nThe number of milliseconds between instances of this table in the output transport\nstream. A value of \\\"0\\\" writes out the PMT once per segment file.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-patinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ProgramNum": { "Required": false, "MarkdownDocumentation": "`ProgramNum`\n\nThe value of the program number field in the Program Map Table (PMT).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-programnum", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "PcrPeriod": { "Required": false, "MarkdownDocumentation": "`PcrPeriod`\n\nThe maximum time, in milliseconds, between Program Clock References (PCRs) inserted\ninto the transport stream.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-pcrperiod", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "PmtInterval": { "Required": false, "MarkdownDocumentation": "`PmtInterval`\n\nThe number of milliseconds between instances of this table in the output transport\nstream. A value of \\\"0\\\" writes out the PMT once per segment file.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-pmtinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "KlvDataPids": { "Required": false, "MarkdownDocumentation": "`KlvDataPids`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-klvdatapids", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NielsenId3Behavior": { "Required": false, "MarkdownDocumentation": "`NielsenId3Behavior`\n\nIf set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-nielsenid3behavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PcrPid": { "Required": false, "MarkdownDocumentation": "`PcrPid`\n\nThe PID of the Program Clock Reference (PCR) in the transport stream. When no value is\ngiven, MediaLive assigns the same value as the video PID. You can enter the value as a\ndecimal or hexadecimal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-pcrpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "VideoPid": { "Required": false, "MarkdownDocumentation": "`VideoPid`\n\nThe PID of the elementary video stream in the transport stream. You can enter the\nvalue as a decimal or hexadecimal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-videopid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioFramesPerPes": { "Required": false, "MarkdownDocumentation": "`AudioFramesPerPes`\n\nThe number of audio frames to insert for each PES packet.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-audioframesperpes", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TransportStreamId": { "Required": false, "MarkdownDocumentation": "`TransportStreamId`\n\nThe value of the transport stream ID field in the Program Map Table (PMT).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-transportstreamid", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "PmtPid": { "Required": false, "MarkdownDocumentation": "`PmtPid`\n\nThe PID for the Program Map Table (PMT) in the transport stream. You can enter the\nvalue as a decimal or hexadecimal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-pmtpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Scte35Pid": { "Required": false, "MarkdownDocumentation": "`Scte35Pid`\n\nThe PID of the SCTE-35 stream in the transport stream. You can enter the value as a\ndecimal or hexadecimal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-scte35pid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Scte35Behavior": { "Required": false, "MarkdownDocumentation": "`Scte35Behavior`\n\nIf set to passthrough, passes any SCTE-35 signals from the input source to this\noutput.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-scte35behavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KlvBehavior": { "Required": false, "MarkdownDocumentation": "`KlvBehavior`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-klvbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EcmPid": { "Required": false, "MarkdownDocumentation": "`EcmPid`\n\nThis parameter is unused and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-ecmpid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimedMetadataPid": { "Required": false, "MarkdownDocumentation": "`TimedMetadataPid`\n\nThe PID of the timed metadata stream in the transport stream. You can enter the value\nas a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or\n0x1ff6).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-timedmetadatapid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioPids": { "Required": false, "MarkdownDocumentation": "`AudioPids`\n\nThe PID of the elementary audio streams in the transport stream. Multiple values are\naccepted, and can be entered in ranges or by comma separation. You can enter the value\nas a decimal or hexadecimal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-audiopids", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PcrControl": { "Required": false, "MarkdownDocumentation": "`PcrControl`\n\nWhen set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every\nPacketized Elementary Stream (PES) header. This parameter is effective only when the PCR\nPID is the same as the video or audio elementary 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-pcrcontrol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimedMetadataBehavior": { "Required": false, "MarkdownDocumentation": "`TimedMetadataBehavior`\n\nWhen set to passthrough, timed metadata is passed through from input to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-m3u8settings.html#cfn-medialive-channel-m3u8settings-timedmetadatabehavior", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MaintenanceCreateSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MaintenanceCreateSettings`\n\nThe `MaintenanceCreateSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenancecreatesettings.html", "Properties": { "MaintenanceDay": { "Required": false, "MarkdownDocumentation": "`MaintenanceDay`\n\nChoose one day of the week for maintenance. The chosen day is used for all future maintenance windows.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenancecreatesettings.html#cfn-medialive-channel-maintenancecreatesettings-maintenanceday", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaintenanceStartTime": { "Required": false, "MarkdownDocumentation": "`MaintenanceStartTime`\n\nChoose the hour that maintenance will start. The chosen time is used for all future maintenance windows.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenancecreatesettings.html#cfn-medialive-channel-maintenancecreatesettings-maintenancestarttime", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MaintenanceUpdateSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MaintenanceUpdateSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenanceupdatesettings.html", "Properties": { "MaintenanceDay": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenanceupdatesettings.html#cfn-medialive-channel-maintenanceupdatesettings-maintenanceday", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaintenanceScheduledDate": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenanceupdatesettings.html#cfn-medialive-channel-maintenanceupdatesettings-maintenancescheduleddate", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaintenanceStartTime": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-maintenanceupdatesettings.html#cfn-medialive-channel-maintenanceupdatesettings-maintenancestarttime", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MediaPackageGroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MediaPackageGroupSettings`\n\nThe settings for the MediaPackage group.\nThe parent of this entity is OutputGroupSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagegroupsettings.html", "Properties": { "Destination": { "Type": "OutputLocationRef", "Required": false, "MarkdownDocumentation": "`Destination`\n\nThe MediaPackage channel destination.\n*Required*: No\n*Type*: [OutputLocationRef](./aws-properties-medialive-channel-outputlocationref.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagegroupsettings.html#cfn-medialive-channel-mediapackagegroupsettings-destination", "UpdateType": "Mutable" }, "MediapackageV2GroupSettings": { "Type": "MediaPackageV2GroupSettings", "Required": false, "MarkdownDocumentation": "`MediapackageV2GroupSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MediaPackageV2GroupSettings](./aws-properties-medialive-channel-mediapackagev2groupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagegroupsettings.html#cfn-medialive-channel-mediapackagegroupsettings-mediapackagev2groupsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MediaPackageOutputDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MediaPackageOutputDestinationSettings`\n\nDestination settings for a MediaPackage output.\nThe parent of this entity is OutputDestination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputdestinationsettings.html", "Properties": { "ChannelName": { "Required": false, "MarkdownDocumentation": "`ChannelName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputdestinationsettings.html#cfn-medialive-channel-mediapackageoutputdestinationsettings-channelname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ChannelId": { "Required": false, "MarkdownDocumentation": "`ChannelId`\n\nThe ID of the channel in MediaPackage that is the destination for this output group.\nYou don't need to specify the individual inputs in MediaPackage; MediaLive handles the\nconnection of the two MediaLive pipelines to the two MediaPackage inputs. The\nMediaPackage channel and MediaLive channel must be in the same 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputdestinationsettings.html#cfn-medialive-channel-mediapackageoutputdestinationsettings-channelid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ChannelGroup": { "Required": false, "MarkdownDocumentation": "`ChannelGroup`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputdestinationsettings.html#cfn-medialive-channel-mediapackageoutputdestinationsettings-channelgroup", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MediaPackageOutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MediaPackageOutputSettings`\n\nThe settings for a MediaPackage output.\nThe parent of this entity is OutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputsettings.html", "Properties": { "MediaPackageV2DestinationSettings": { "Type": "MediaPackageV2DestinationSettings", "Required": false, "MarkdownDocumentation": "`MediaPackageV2DestinationSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MediaPackageV2DestinationSettings](./aws-properties-medialive-channel-mediapackagev2destinationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackageoutputsettings.html#cfn-medialive-channel-mediapackageoutputsettings-mediapackagev2destinationsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MediaPackageV2DestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MediaPackageV2DestinationSettings`\n\nThe `MediaPackageV2DestinationSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2destinationsettings.html", "Properties": { "AudioRenditionSets": { "Required": false, "MarkdownDocumentation": "`AudioRenditionSets`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2destinationsettings.html#cfn-medialive-channel-mediapackagev2destinationsettings-audiorenditionsets", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HlsDefault": { "Required": false, "MarkdownDocumentation": "`HlsDefault`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2destinationsettings.html#cfn-medialive-channel-mediapackagev2destinationsettings-hlsdefault", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioGroupId": { "Required": false, "MarkdownDocumentation": "`AudioGroupId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2destinationsettings.html#cfn-medialive-channel-mediapackagev2destinationsettings-audiogroupid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HlsAutoSelect": { "Required": false, "MarkdownDocumentation": "`HlsAutoSelect`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2destinationsettings.html#cfn-medialive-channel-mediapackagev2destinationsettings-hlsautoselect", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MediaPackageV2GroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MediaPackageV2GroupSettings`\n\nThe `MediaPackageV2GroupSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html", "Properties": { "CaptionLanguageMappings": { "Type": "List", "Required": false, "MarkdownDocumentation": "`CaptionLanguageMappings`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [CaptionLanguageMapping](./aws-properties-medialive-channel-captionlanguagemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-captionlanguagemappings", "ItemType": "CaptionLanguageMapping", "UpdateType": "Mutable" }, "Scte35Type": { "Required": false, "MarkdownDocumentation": "`Scte35Type`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-scte35type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SegmentLengthUnits": { "Required": false, "MarkdownDocumentation": "`SegmentLengthUnits`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-segmentlengthunits", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimedMetadataId3Frame": { "Required": false, "MarkdownDocumentation": "`TimedMetadataId3Frame`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-timedmetadataid3frame", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimedMetadataId3Period": { "Required": false, "MarkdownDocumentation": "`TimedMetadataId3Period`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-timedmetadataid3period", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TimedMetadataPassthrough": { "Required": false, "MarkdownDocumentation": "`TimedMetadataPassthrough`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-timedmetadatapassthrough", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NielsenId3Behavior": { "Required": false, "MarkdownDocumentation": "`NielsenId3Behavior`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-nielsenid3behavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KlvBehavior": { "Required": false, "MarkdownDocumentation": "`KlvBehavior`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-klvbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Id3Behavior": { "Required": false, "MarkdownDocumentation": "`Id3Behavior`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-id3behavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SegmentLength": { "Required": false, "MarkdownDocumentation": "`SegmentLength`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mediapackagev2groupsettings.html#cfn-medialive-channel-mediapackagev2groupsettings-segmentlength", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MotionGraphicsConfiguration": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MotionGraphicsConfiguration`\n\nSettings to enable and configure the motion graphics overlay feature in the\nchannel.\nThe parent of this entity is EncoderSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-motiongraphicsconfiguration.html", "Properties": { "MotionGraphicsSettings": { "Type": "MotionGraphicsSettings", "Required": false, "MarkdownDocumentation": "`MotionGraphicsSettings`\n\nSettings to enable and configure the motion graphics overlay feature in the\nchannel.\n*Required*: No\n*Type*: [MotionGraphicsSettings](./aws-properties-medialive-channel-motiongraphicssettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-motiongraphicsconfiguration.html#cfn-medialive-channel-motiongraphicsconfiguration-motiongraphicssettings", "UpdateType": "Mutable" }, "MotionGraphicsInsertion": { "Required": false, "MarkdownDocumentation": "`MotionGraphicsInsertion`\n\nEnables or disables the motion graphics overlay feature in the channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-motiongraphicsconfiguration.html#cfn-medialive-channel-motiongraphicsconfiguration-motiongraphicsinsertion", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MotionGraphicsSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MotionGraphicsSettings`\n\nSettings to enable and configure the motion graphics overlay feature in the\nchannel.\nThe parent of this entity is MotionGraphicsConfiguration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-motiongraphicssettings.html", "Properties": { "HtmlMotionGraphicsSettings": { "Type": "HtmlMotionGraphicsSettings", "Required": false, "MarkdownDocumentation": "`HtmlMotionGraphicsSettings`\n\nSettings to configure the motion graphics overlay to use an HTML asset.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-motiongraphicssettings.html#cfn-medialive-channel-motiongraphicssettings-htmlmotiongraphicssettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Mp2Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Mp2Settings`\n\nThe configuration for this MP2 audio.\nThe parent of this entity is AudioCodecSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mp2settings.html", "Properties": { "CodingMode": { "Required": false, "MarkdownDocumentation": "`CodingMode`\n\nThe MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20\n(for stereo).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mp2settings.html#cfn-medialive-channel-mp2settings-codingmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SampleRate": { "Required": false, "MarkdownDocumentation": "`SampleRate`\n\nThe sample rate in Hz.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mp2settings.html#cfn-medialive-channel-mp2settings-samplerate", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "Bitrate": { "Required": false, "MarkdownDocumentation": "`Bitrate`\n\nThe average bitrate in bits/second.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mp2settings.html#cfn-medialive-channel-mp2settings-bitrate", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Mpeg2FilterSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Mpeg2FilterSettings`\n\nSettings to configure video filters that apply to the MPEG-2 codec.\nThe parent of this entity is Mpeg2FilterSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2filtersettings.html", "Properties": { "TemporalFilterSettings": { "Type": "TemporalFilterSettings", "Required": false, "MarkdownDocumentation": "`TemporalFilterSettings`\n\nSettings for applying the temporal filter to the video.\n*Required*: No\n*Type*: [TemporalFilterSettings](./aws-properties-medialive-channel-temporalfiltersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2filtersettings.html#cfn-medialive-channel-mpeg2filtersettings-temporalfiltersettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Mpeg2Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Mpeg2Settings`\n\nThe settings for the MPEG-2 codec in the output.\nThe parent of this entity is VideoCodecSetting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html", "Properties": { "TimecodeBurninSettings": { "Type": "TimecodeBurninSettings", "Required": false, "MarkdownDocumentation": "`TimecodeBurninSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [TimecodeBurninSettings](./aws-properties-medialive-channel-timecodeburninsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-timecodeburninsettings", "UpdateType": "Mutable" }, "ColorSpace": { "Required": false, "MarkdownDocumentation": "`ColorSpace`\n\nChoose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \\\"MediaLive Features - Video - color space\\\" in the MediaLive User Guide.\nPASSTHROUGH: Keep the color space of the input content - do not convert it.\nAUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-colorspace", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FixedAfd": { "Required": false, "MarkdownDocumentation": "`FixedAfd`\n\nComplete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-fixedafd", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GopSizeUnits": { "Required": false, "MarkdownDocumentation": "`GopSizeUnits`\n\nRelates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-gopsizeunits", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FramerateNumerator": { "Required": false, "MarkdownDocumentation": "`FramerateNumerator`\n\nThe framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-frameratenumerator", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "GopClosedCadence": { "Required": false, "MarkdownDocumentation": "`GopClosedCadence`\n\nMPEG2: default is open GOP.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-gopclosedcadence", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AfdSignaling": { "Required": false, "MarkdownDocumentation": "`AfdSignaling`\n\nIndicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO.\nAUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid).\nFIXED: MediaLive will use the value you specify in fixedAFD.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-afdsignaling", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DisplayAspectRatio": { "Required": false, "MarkdownDocumentation": "`DisplayAspectRatio`\n\nSets the pixel aspect ratio for the encode.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-displayaspectratio", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ScanType": { "Required": false, "MarkdownDocumentation": "`ScanType`\n\nSet the scan type of the output to PROGRESSIVE or INTERLACED (top field first).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-scantype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimecodeInsertion": { "Required": false, "MarkdownDocumentation": "`TimecodeInsertion`\n\nDetermines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \\\"MediaLive Features - Timecode configuration\\\" in the MediaLive User Guide.\nDISABLED: do not include timecodes.\nGOP\\_TIMECODE: Include timecode metadata in the GOP 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-timecodeinsertion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ColorMetadata": { "Required": false, "MarkdownDocumentation": "`ColorMetadata`\n\nSpecifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-colormetadata", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FramerateDenominator": { "Required": false, "MarkdownDocumentation": "`FramerateDenominator`\n\ndescription\": \"The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-frameratedenominator", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "GopSize": { "Required": false, "MarkdownDocumentation": "`GopSize`\n\nRelates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default.\nIf gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-gopsize", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "AdaptiveQuantization": { "Required": false, "MarkdownDocumentation": "`AdaptiveQuantization`\n\nChoose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-adaptivequantization", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SubgopLength": { "Required": false, "MarkdownDocumentation": "`SubgopLength`\n\nRelates to the GOP structure. If you do not know what GOP is, use the default.\nFIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames.\nDYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-subgoplength", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FilterSettings": { "Type": "Mpeg2FilterSettings", "Required": false, "MarkdownDocumentation": "`FilterSettings`\n\nOptionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied.\nTEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean.\nWhen the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise.\nWhen the content is reasonably clean, the filter tends to decrease the bitrate.\n*Required*: No\n*Type*: [Mpeg2FilterSettings](./aws-properties-medialive-channel-mpeg2filtersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-filtersettings", "UpdateType": "Mutable" }, "GopNumBFrames": { "Required": false, "MarkdownDocumentation": "`GopNumBFrames`\n\nRelates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mpeg2settings.html#cfn-medialive-channel-mpeg2settings-gopnumbframes", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MsSmoothGroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MsSmoothGroupSettings`\n\nThe settings for a Microsoft Smooth output group.\nThe parent of this entity is OutputGroupSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html", "Properties": { "SegmentationMode": { "Required": false, "MarkdownDocumentation": "`SegmentationMode`\n\nuseInputSegmentation has been deprecated. The configured segment size is always\nused.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-segmentationmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Destination": { "Type": "OutputLocationRef", "Required": false, "MarkdownDocumentation": "`Destination`\n\nThe Smooth Streaming publish point on an IIS server. MediaLive acts as a \"Push\"\nencoder to IIS.\n*Required*: No\n*Type*: [OutputLocationRef](./aws-properties-medialive-channel-outputlocationref.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-destination", "UpdateType": "Mutable" }, "EventStopBehavior": { "Required": false, "MarkdownDocumentation": "`EventStopBehavior`\n\nWhen set to sendEos, sends an EOS signal to an IIS server when stopping the\nchannel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-eventstopbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FilecacheDuration": { "Required": false, "MarkdownDocumentation": "`FilecacheDuration`\n\nThe size, in seconds, of the file cache for streaming outputs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-filecacheduration", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CertificateMode": { "Required": false, "MarkdownDocumentation": "`CertificateMode`\n\nIf set to verifyAuthenticity, verifies the HTTPS certificate chain to a trusted\ncertificate authority (CA). This causes HTTPS outputs to self-signed certificates to\nfail.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-certificatemode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AcquisitionPointId": { "Required": false, "MarkdownDocumentation": "`AcquisitionPointId`\n\nThe value of the Acquisition Point Identity element that is used in each message\nplaced in the sparse track. Enabled only if sparseTrackType is not \"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-acquisitionpointid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StreamManifestBehavior": { "Required": false, "MarkdownDocumentation": "`StreamManifestBehavior`\n\nWhen set to send, sends a stream manifest so that the publishing point doesn't start\nuntil all streams 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-streammanifestbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InputLossAction": { "Required": false, "MarkdownDocumentation": "`InputLossAction`\n\nA parameter that controls output group behavior on an input loss.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-inputlossaction", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FragmentLength": { "Required": false, "MarkdownDocumentation": "`FragmentLength`\n\nThe length, in seconds, of mp4 fragments to generate. The fragment length must be\ncompatible with GOP size and frame rate.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-fragmentlength", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RestartDelay": { "Required": false, "MarkdownDocumentation": "`RestartDelay`\n\nThe number of seconds before initiating a restart due to output failure, due to\nexhausting the numRetries on one segment, or exceeding filecacheDuration.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-restartdelay", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SparseTrackType": { "Required": false, "MarkdownDocumentation": "`SparseTrackType`\n\nIf set to scte35, uses incoming SCTE-35 messages to generate a sparse track in this\ngroup of Microsoft Smooth outputs.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-sparsetracktype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EventIdMode": { "Required": false, "MarkdownDocumentation": "`EventIdMode`\n\nSpecifies whether to send a channel ID to the IIS server. If no channel ID is sent and\nthe same channel is used without changing the publishing point, clients might see cached\nvideo from the previous run. Options: - \"useConfigured\" - use the value provided in\neventId - \"useTimestamp\" - generate and send a channel ID based on the current timestamp\n- \"noEventId\" - do not send a channel ID to the IIS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-eventidmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimestampOffsetMode": { "Required": false, "MarkdownDocumentation": "`TimestampOffsetMode`\n\nThe type of timestamp date offset to use. - useEventStartDate: Use the date the\nchannel was started as the offset - useConfiguredOffset: Use an explicitly configured\ndate as the offset.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-timestampoffsetmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioOnlyTimecodeControl": { "Required": false, "MarkdownDocumentation": "`AudioOnlyTimecodeControl`\n\nIf set to passthrough for an audio-only Microsoft Smooth output, the fragment absolute\ntime is set to the current timecode. This option does not write timecodes to the audio\nelementary 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-audioonlytimecodecontrol", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NumRetries": { "Required": false, "MarkdownDocumentation": "`NumRetries`\n\nThe number of retry attempts.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-numretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TimestampOffset": { "Required": false, "MarkdownDocumentation": "`TimestampOffset`\n\nThe timestamp offset for the channel. Used only if timestampOffsetMode is set to\nuseConfiguredOffset.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-timestampoffset", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EventId": { "Required": false, "MarkdownDocumentation": "`EventId`\n\nThe Microsoft Smooth channel ID that is sent to the IIS server. Specify the ID only if\neventIdMode is set to useConfigured.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-eventid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SendDelayMs": { "Required": false, "MarkdownDocumentation": "`SendDelayMs`\n\nThe number of milliseconds to delay the output from the second pipeline.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-senddelayms", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ConnectionRetryInterval": { "Required": false, "MarkdownDocumentation": "`ConnectionRetryInterval`\n\nThe number of seconds to wait before retrying the connection to the IIS server if the\nconnection is lost. Content is cached during this time, and the cache is delivered to\nthe IIS server after the connection is re-established.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-connectionretryinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MsSmoothOutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MsSmoothOutputSettings`\n\nConfiguration of a Microsoft Smooth output.\nThe parent of this entity is OutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothoutputsettings.html", "Properties": { "NameModifier": { "Required": false, "MarkdownDocumentation": "`NameModifier`\n\nA string that is concatenated to the end of the destination file name. This is\nrequired for multiple outputs of the same 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothoutputsettings.html#cfn-medialive-channel-mssmoothoutputsettings-namemodifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "H265PackagingType": { "Required": false, "MarkdownDocumentation": "`H265PackagingType`\n\nOnly applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothoutputsettings.html#cfn-medialive-channel-mssmoothoutputsettings-h265packagingtype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MulticastInputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MulticastInputSettings`\n\nThe `MulticastInputSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multicastinputsettings.html", "Properties": { "SourceIpAddress": { "Required": false, "MarkdownDocumentation": "`SourceIpAddress`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multicastinputsettings.html#cfn-medialive-channel-multicastinputsettings-sourceipaddress", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MultiplexContainerSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MultiplexContainerSettings`\n\nThe `MultiplexContainerSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexcontainersettings.html", "Properties": { "MultiplexM2tsSettings": { "Type": "MultiplexM2tsSettings", "Required": false, "MarkdownDocumentation": "`MultiplexM2tsSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MultiplexM2tsSettings](./aws-properties-medialive-channel-multiplexm2tssettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexcontainersettings.html#cfn-medialive-channel-multiplexcontainersettings-multiplexm2tssettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MultiplexGroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MultiplexGroupSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexgroupsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.MultiplexM2tsSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MultiplexM2tsSettings`\n\nThe `MultiplexM2tsSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html", "Properties": { "Scte35Control": { "Required": false, "MarkdownDocumentation": "`Scte35Control`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-scte35control", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PcrPeriod": { "Required": false, "MarkdownDocumentation": "`PcrPeriod`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-pcrperiod", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "NielsenId3Behavior": { "Required": false, "MarkdownDocumentation": "`NielsenId3Behavior`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-nielsenid3behavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EsRateInPes": { "Required": false, "MarkdownDocumentation": "`EsRateInPes`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-esrateinpes", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CcDescriptor": { "Required": false, "MarkdownDocumentation": "`CcDescriptor`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-ccdescriptor", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioFramesPerPes": { "Required": false, "MarkdownDocumentation": "`AudioFramesPerPes`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-audioframesperpes", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AbsentInputAudioBehavior": { "Required": false, "MarkdownDocumentation": "`AbsentInputAudioBehavior`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-absentinputaudiobehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioStreamType": { "Required": false, "MarkdownDocumentation": "`AudioStreamType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-audiostreamtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Klv": { "Required": false, "MarkdownDocumentation": "`Klv`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-klv", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Arib": { "Required": false, "MarkdownDocumentation": "`Arib`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-arib", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AudioBufferModel": { "Required": false, "MarkdownDocumentation": "`AudioBufferModel`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-audiobuffermodel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Ebif": { "Required": false, "MarkdownDocumentation": "`Ebif`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-ebif", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Scte35PrerollPullupMilliseconds": { "Required": false, "MarkdownDocumentation": "`Scte35PrerollPullupMilliseconds`\n\nProperty description not available.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-scte35prerollpullupmilliseconds", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "PcrControl": { "Required": false, "MarkdownDocumentation": "`PcrControl`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexm2tssettings.html#cfn-medialive-channel-multiplexm2tssettings-pcrcontrol", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MultiplexOutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MultiplexOutputSettings`\n\nConfiguration of a Multiplex output.\nThe parent of this entity is OutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexoutputsettings.html", "Properties": { "Destination": { "Type": "OutputLocationRef", "Required": false, "MarkdownDocumentation": "`Destination`\n\nDestination is a Multiplex.\n*Required*: No\n*Type*: [OutputLocationRef](./aws-properties-medialive-channel-outputlocationref.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexoutputsettings.html#cfn-medialive-channel-multiplexoutputsettings-destination", "UpdateType": "Mutable" }, "ContainerSettings": { "Type": "MultiplexContainerSettings", "Required": false, "MarkdownDocumentation": "`ContainerSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MultiplexContainerSettings](./aws-properties-medialive-channel-multiplexcontainersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexoutputsettings.html#cfn-medialive-channel-multiplexoutputsettings-containersettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.MultiplexProgramChannelDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.MultiplexProgramChannelDestinationSettings`\n\nDestination settings for a Multiplex output.\nThe parent of this entity is OutputDestination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexprogramchanneldestinationsettings.html", "Properties": { "MultiplexId": { "Required": false, "MarkdownDocumentation": "`MultiplexId`\n\nThe ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances.\nThe Multiplex must be in the same region as the Channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexprogramchanneldestinationsettings.html#cfn-medialive-channel-multiplexprogramchanneldestinationsettings-multiplexid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ProgramName": { "Required": false, "MarkdownDocumentation": "`ProgramName`\n\nThe program name of the Multiplex program that the encoder is providing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-multiplexprogramchanneldestinationsettings.html#cfn-medialive-channel-multiplexprogramchanneldestinationsettings-programname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.NetworkInputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.NetworkInputSettings`\n\nInformation about how to connect to the upstream system.\nThe parent of this entity is InputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.html", "Properties": { "ServerValidation": { "Required": false, "MarkdownDocumentation": "`ServerValidation`\n\nChecks HTTPS server certificates. When set to checkCryptographyOnly, cryptography in\nthe certificate is checked, but not the server's name. Certain subdomains (notably S3\nbuckets that use dots in the bucket name) don't strictly match the corresponding\ncertificate's wildcard pattern and would otherwise cause the channel to error. This\nsetting is ignored for protocols that do not use 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.html#cfn-medialive-channel-networkinputsettings-servervalidation", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HlsInputSettings": { "Type": "HlsInputSettings", "Required": false, "MarkdownDocumentation": "`HlsInputSettings`\n\nInformation about how to connect to the upstream system.\n*Required*: No\n*Type*: [HlsInputSettings](./aws-properties-medialive-channel-hlsinputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.html#cfn-medialive-channel-networkinputsettings-hlsinputsettings", "UpdateType": "Mutable" }, "MulticastInputSettings": { "Type": "MulticastInputSettings", "Required": false, "MarkdownDocumentation": "`MulticastInputSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MulticastInputSettings](./aws-properties-medialive-channel-multicastinputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.html#cfn-medialive-channel-networkinputsettings-multicastinputsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.NielsenCBET": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.NielsenCBET`\n\nComplete these fields only if you want to insert watermarks of type Nielsen\nCBET\nThe parent of this entity is NielsenWatermarksSettings\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsencbet.html", "Properties": { "CbetCheckDigitString": { "Required": false, "MarkdownDocumentation": "`CbetCheckDigitString`\n\nEnter the CBET check digits to use in the watermark.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsencbet.html#cfn-medialive-channel-nielsencbet-cbetcheckdigitstring", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CbetStepaside": { "Required": false, "MarkdownDocumentation": "`CbetStepaside`\n\nDetermines the method of CBET insertion mode when prior encoding is detected on the same layer.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsencbet.html#cfn-medialive-channel-nielsencbet-cbetstepaside", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Csid": { "Required": false, "MarkdownDocumentation": "`Csid`\n\nEnter the CBET Source ID (CSID) to use in the watermark\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsencbet.html#cfn-medialive-channel-nielsencbet-csid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.NielsenConfiguration": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.NielsenConfiguration`\n\nThe settings to configure Nielsen watermarks.\nThe parent of this entity is EncoderSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenconfiguration.html", "Properties": { "DistributorId": { "Required": false, "MarkdownDocumentation": "`DistributorId`\n\nEnter the Distributor ID assigned to your organization by Nielsen.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenconfiguration.html#cfn-medialive-channel-nielsenconfiguration-distributorid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NielsenPcmToId3Tagging": { "Required": false, "MarkdownDocumentation": "`NielsenPcmToId3Tagging`\n\nEnables Nielsen PCM to ID3 tagging\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenconfiguration.html#cfn-medialive-channel-nielsenconfiguration-nielsenpcmtoid3tagging", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.NielsenNaesIiNw": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.NielsenNaesIiNw`\n\nComplete these fields only if you want to insert watermarks of type Nielsen NAES II\n(N2) and Nielsen NAES VI (NW).\nThe parent of this entity is NielsenWatermarksSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsennaesiinw.html", "Properties": { "Timezone": { "Required": false, "MarkdownDocumentation": "`Timezone`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsennaesiinw.html#cfn-medialive-channel-nielsennaesiinw-timezone", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CheckDigitString": { "Required": false, "MarkdownDocumentation": "`CheckDigitString`\n\nEnter the check digit string for the watermark\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsennaesiinw.html#cfn-medialive-channel-nielsennaesiinw-checkdigitstring", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Sid": { "Required": false, "MarkdownDocumentation": "`Sid`\n\nEnter the Nielsen Source ID (SID) to include in the watermark\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsennaesiinw.html#cfn-medialive-channel-nielsennaesiinw-sid", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.NielsenWatermarksSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.NielsenWatermarksSettings`\n\nSettings to configure Nielsen Watermarks in the audio encode.\nThe parent of this entity is AudioWatermarkSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenwatermarkssettings.html", "Properties": { "NielsenDistributionType": { "Required": false, "MarkdownDocumentation": "`NielsenDistributionType`\n\nChoose the distribution types that you want to assign to the watermarks:\n- PROGRAM\\_CONTENT\n- FINAL\\_DISTRIBUTOR\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenwatermarkssettings.html#cfn-medialive-channel-nielsenwatermarkssettings-nielsendistributiontype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NielsenCbetSettings": { "Type": "NielsenCBET", "Required": false, "MarkdownDocumentation": "`NielsenCbetSettings`\n\nComplete these fields only if you want to insert watermarks of type Nielsen CBET\n*Required*: No\n*Type*: [NielsenCBET](./aws-properties-medialive-channel-nielsencbet.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenwatermarkssettings.html#cfn-medialive-channel-nielsenwatermarkssettings-nielsencbetsettings", "UpdateType": "Mutable" }, "NielsenNaesIiNwSettings": { "Type": "NielsenNaesIiNw", "Required": false, "MarkdownDocumentation": "`NielsenNaesIiNwSettings`\n\nComplete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).\n*Required*: No\n*Type*: [NielsenNaesIiNw](./aws-properties-medialive-channel-nielsennaesiinw.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-nielsenwatermarkssettings.html#cfn-medialive-channel-nielsenwatermarkssettings-nielsennaesiinwsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Output": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Output`\n\nThe output settings.\nThe parent of this entity is OutputGroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-output.html", "Properties": { "OutputSettings": { "Type": "OutputSettings", "Required": false, "MarkdownDocumentation": "`OutputSettings`\n\nThe output type-specific settings.\n*Required*: No\n*Type*: [OutputSettings](./aws-properties-medialive-channel-outputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-output.html#cfn-medialive-channel-output-outputsettings", "UpdateType": "Mutable" }, "CaptionDescriptionNames": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`CaptionDescriptionNames`\n\nThe names of the caption descriptions that are used as captions sources for this\noutput.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-output.html#cfn-medialive-channel-output-captiondescriptionnames", "UpdateType": "Mutable" }, "AudioDescriptionNames": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AudioDescriptionNames`\n\nThe names of the audio descriptions that are used as audio sources for this\noutput.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-output.html#cfn-medialive-channel-output-audiodescriptionnames", "UpdateType": "Mutable" }, "OutputName": { "Required": false, "MarkdownDocumentation": "`OutputName`\n\nThe name that is used to identify an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-output.html#cfn-medialive-channel-output-outputname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "VideoDescriptionName": { "Required": false, "MarkdownDocumentation": "`VideoDescriptionName`\n\nThe name of the VideoDescription that is used as the source for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-output.html#cfn-medialive-channel-output-videodescriptionname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.OutputDestination": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.OutputDestination`\n\nConfiguration information for an output.\nThis entity is at the top level in the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html", "Properties": { "SrtSettings": { "Type": "List", "Required": false, "MarkdownDocumentation": "`SrtSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [SrtOutputDestinationSettings](./aws-properties-medialive-channel-srtoutputdestinationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-srtsettings", "ItemType": "SrtOutputDestinationSettings", "UpdateType": "Mutable" }, "LogicalInterfaceNames": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`LogicalInterfaceNames`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-logicalinterfacenames", "UpdateType": "Mutable" }, "MultiplexSettings": { "Type": "MultiplexProgramChannelDestinationSettings", "Required": false, "MarkdownDocumentation": "`MultiplexSettings`\n\nDestination settings for a Multiplex output; one destination for both encoders.\n*Required*: No\n*Type*: [MultiplexProgramChannelDestinationSettings](./aws-properties-medialive-channel-multiplexprogramchanneldestinationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-multiplexsettings", "UpdateType": "Mutable" }, "Id": { "Required": false, "MarkdownDocumentation": "`Id`\n\nThe ID for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-id", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Settings": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Settings`\n\nThe destination settings for an output.\n*Required*: No\n*Type*: Array of [OutputDestinationSettings](./aws-properties-medialive-channel-outputdestinationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-settings", "ItemType": "OutputDestinationSettings", "UpdateType": "Mutable" }, "MediaPackageSettings": { "Type": "List", "Required": false, "MarkdownDocumentation": "`MediaPackageSettings`\n\nThe destination settings for a MediaPackage output.\n*Required*: No\n*Type*: Array of [MediaPackageOutputDestinationSettings](./aws-properties-medialive-channel-mediapackageoutputdestinationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestination.html#cfn-medialive-channel-outputdestination-mediapackagesettings", "ItemType": "MediaPackageOutputDestinationSettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.OutputDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.OutputDestinationSettings`\n\nThe configuration information for this output.\nThe parent of this entity is OutputDestination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html", "Properties": { "StreamName": { "Required": false, "MarkdownDocumentation": "`StreamName`\n\nThe stream name for the content. This applies only to RTMP outputs.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html#cfn-medialive-channel-outputdestinationsettings-streamname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Username": { "Required": false, "MarkdownDocumentation": "`Username`\n\nThe user name to connect to the downstream system. This applies only if the downstream\nsystem requires 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html#cfn-medialive-channel-outputdestinationsettings-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PasswordParam": { "Required": false, "MarkdownDocumentation": "`PasswordParam`\n\nThe password parameter that holds the password for accessing the downstream system.\nThis password parameter applies only if the downstream system requires\ncredentials.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html#cfn-medialive-channel-outputdestinationsettings-passwordparam", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Url": { "Required": false, "MarkdownDocumentation": "`Url`\n\nThe URL for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputdestinationsettings.html#cfn-medialive-channel-outputdestinationsettings-url", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.OutputGroup": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.OutputGroup`\n\nThe settings for one output group.\nThe parent of this entity is EncoderSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroup.html", "Properties": { "Outputs": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Outputs`\n\nThe settings for the outputs in the output group.\n*Required*: No\n*Type*: Array of [Output](./aws-properties-medialive-channel-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroup.html#cfn-medialive-channel-outputgroup-outputs", "ItemType": "Output", "UpdateType": "Mutable" }, "OutputGroupSettings": { "Type": "OutputGroupSettings", "Required": false, "MarkdownDocumentation": "`OutputGroupSettings`\n\nThe settings associated with the output group.\n*Required*: No\n*Type*: [OutputGroupSettings](./aws-properties-medialive-channel-outputgroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroup.html#cfn-medialive-channel-outputgroup-outputgroupsettings", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nA custom output group name that you can optionally define. Only letters, numbers, and\nthe underscore character are allowed. The maximum length is 32 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroup.html#cfn-medialive-channel-outputgroup-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.OutputGroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.OutputGroupSettings`\n\nThe configuration of the output group.\nThe parent of this entity is OutputGroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html", "Properties": { "HlsGroupSettings": { "Type": "HlsGroupSettings", "Required": false, "MarkdownDocumentation": "`HlsGroupSettings`\n\nThe configuration of an HLS output group.\n*Required*: No\n*Type*: [HlsGroupSettings](./aws-properties-medialive-channel-hlsgroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-hlsgroupsettings", "UpdateType": "Mutable" }, "FrameCaptureGroupSettings": { "Type": "FrameCaptureGroupSettings", "Required": false, "MarkdownDocumentation": "`FrameCaptureGroupSettings`\n\nThe configuration of a frame capture output group.\n*Required*: No\n*Type*: [FrameCaptureGroupSettings](./aws-properties-medialive-channel-framecapturegroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-framecapturegroupsettings", "UpdateType": "Mutable" }, "MultiplexGroupSettings": { "Type": "MultiplexGroupSettings", "Required": false, "MarkdownDocumentation": "`MultiplexGroupSettings`\n\nThe settings for a Multiplex output group.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-multiplexgroupsettings", "UpdateType": "Mutable" }, "SrtGroupSettings": { "Type": "SrtGroupSettings", "Required": false, "MarkdownDocumentation": "`SrtGroupSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [SrtGroupSettings](./aws-properties-medialive-channel-srtgroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-srtgroupsettings", "UpdateType": "Mutable" }, "ArchiveGroupSettings": { "Type": "ArchiveGroupSettings", "Required": false, "MarkdownDocumentation": "`ArchiveGroupSettings`\n\nThe configuration of an archive output group.\nThe parent of this entity is OutputGroupSettings.\n*Required*: No\n*Type*: [ArchiveGroupSettings](./aws-properties-medialive-channel-archivegroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-archivegroupsettings", "UpdateType": "Mutable" }, "MediaPackageGroupSettings": { "Type": "MediaPackageGroupSettings", "Required": false, "MarkdownDocumentation": "`MediaPackageGroupSettings`\n\nThe configuration of a MediaPackage output group.\n*Required*: No\n*Type*: [MediaPackageGroupSettings](./aws-properties-medialive-channel-mediapackagegroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-mediapackagegroupsettings", "UpdateType": "Mutable" }, "UdpGroupSettings": { "Type": "UdpGroupSettings", "Required": false, "MarkdownDocumentation": "`UdpGroupSettings`\n\nThe configuration of a UDP output group.\n*Required*: No\n*Type*: [UdpGroupSettings](./aws-properties-medialive-channel-udpgroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-udpgroupsettings", "UpdateType": "Mutable" }, "MsSmoothGroupSettings": { "Type": "MsSmoothGroupSettings", "Required": false, "MarkdownDocumentation": "`MsSmoothGroupSettings`\n\nThe configuration of a Microsoft Smooth output group.\n*Required*: No\n*Type*: [MsSmoothGroupSettings](./aws-properties-medialive-channel-mssmoothgroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-mssmoothgroupsettings", "UpdateType": "Mutable" }, "RtmpGroupSettings": { "Type": "RtmpGroupSettings", "Required": false, "MarkdownDocumentation": "`RtmpGroupSettings`\n\nThe configuration of an RTMP output group.\n*Required*: No\n*Type*: [RtmpGroupSettings](./aws-properties-medialive-channel-rtmpgroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-rtmpgroupsettings", "UpdateType": "Mutable" }, "CmafIngestGroupSettings": { "Type": "CmafIngestGroupSettings", "Required": false, "MarkdownDocumentation": "`CmafIngestGroupSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [CmafIngestGroupSettings](./aws-properties-medialive-channel-cmafingestgroupsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputgroupsettings.html#cfn-medialive-channel-outputgroupsettings-cmafingestgroupsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.OutputLocationRef": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.OutputLocationRef`\n\nA reference to an OutputDestination ID that is defined in the channel.\nThis entity is used by ArchiveGroupSettings, FrameCaptureGroupSettings,\nHlsGroupSettings, MediaPackageGroupSettings, MSSmoothGroupSettings, RtmpOutputSettings,\nand UdpOutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputlocationref.html", "Properties": { "DestinationRefId": { "Required": false, "MarkdownDocumentation": "`DestinationRefId`\n\nA reference ID for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputlocationref.html#cfn-medialive-channel-outputlocationref-destinationrefid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.OutputLockingSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.OutputLockingSettings`\n\nThe `OutputLockingSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputlockingsettings.html", "Properties": { "PipelineLockingSettings": { "Type": "PipelineLockingSettings", "Required": false, "MarkdownDocumentation": "`PipelineLockingSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputlockingsettings.html#cfn-medialive-channel-outputlockingsettings-pipelinelockingsettings", "UpdateType": "Mutable" }, "EpochLockingSettings": { "Type": "EpochLockingSettings", "Required": false, "MarkdownDocumentation": "`EpochLockingSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [EpochLockingSettings](./aws-properties-medialive-channel-epochlockingsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputlockingsettings.html#cfn-medialive-channel-outputlockingsettings-epochlockingsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.OutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.OutputSettings`\n\nThe output settings.\nThe parent of this entity is Output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html", "Properties": { "MediaPackageOutputSettings": { "Type": "MediaPackageOutputSettings", "Required": false, "MarkdownDocumentation": "`MediaPackageOutputSettings`\n\nThe settings for a MediaPackage output.\nThe parent of this entity is OutputGroupSettings.\n*Required*: No\n*Type*: [MediaPackageOutputSettings](./aws-properties-medialive-channel-mediapackageoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-mediapackageoutputsettings", "UpdateType": "Mutable" }, "MsSmoothOutputSettings": { "Type": "MsSmoothOutputSettings", "Required": false, "MarkdownDocumentation": "`MsSmoothOutputSettings`\n\nThe settings for a Microsoft Smooth output.\n*Required*: No\n*Type*: [MsSmoothOutputSettings](./aws-properties-medialive-channel-mssmoothoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-mssmoothoutputsettings", "UpdateType": "Mutable" }, "FrameCaptureOutputSettings": { "Type": "FrameCaptureOutputSettings", "Required": false, "MarkdownDocumentation": "`FrameCaptureOutputSettings`\n\nThe settings for a frame capture output.\nThe parent of this entity is OutputGroupSettings.\n*Required*: No\n*Type*: [FrameCaptureOutputSettings](./aws-properties-medialive-channel-framecaptureoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-framecaptureoutputsettings", "UpdateType": "Mutable" }, "HlsOutputSettings": { "Type": "HlsOutputSettings", "Required": false, "MarkdownDocumentation": "`HlsOutputSettings`\n\nThe settings for an HLS output.\nThe parent of this entity is OutputGroupSettings.\n*Required*: No\n*Type*: [HlsOutputSettings](./aws-properties-medialive-channel-hlsoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-hlsoutputsettings", "UpdateType": "Mutable" }, "RtmpOutputSettings": { "Type": "RtmpOutputSettings", "Required": false, "MarkdownDocumentation": "`RtmpOutputSettings`\n\nThe settings for an RTMP output.\nThe parent of this entity is OutputGroupSettings.\n*Required*: No\n*Type*: [RtmpOutputSettings](./aws-properties-medialive-channel-rtmpoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-rtmpoutputsettings", "UpdateType": "Mutable" }, "UdpOutputSettings": { "Type": "UdpOutputSettings", "Required": false, "MarkdownDocumentation": "`UdpOutputSettings`\n\nThe settings for a UDP output.\nThe parent of this entity is OutputGroupSettings.\n*Required*: No\n*Type*: [UdpOutputSettings](./aws-properties-medialive-channel-udpoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-udpoutputsettings", "UpdateType": "Mutable" }, "MultiplexOutputSettings": { "Type": "MultiplexOutputSettings", "Required": false, "MarkdownDocumentation": "`MultiplexOutputSettings`\n\nConfiguration of a Multiplex output.\n*Required*: No\n*Type*: [MultiplexOutputSettings](./aws-properties-medialive-channel-multiplexoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-multiplexoutputsettings", "UpdateType": "Mutable" }, "CmafIngestOutputSettings": { "Type": "CmafIngestOutputSettings", "Required": false, "MarkdownDocumentation": "`CmafIngestOutputSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [CmafIngestOutputSettings](./aws-properties-medialive-channel-cmafingestoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-cmafingestoutputsettings", "UpdateType": "Mutable" }, "SrtOutputSettings": { "Type": "SrtOutputSettings", "Required": false, "MarkdownDocumentation": "`SrtOutputSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [SrtOutputSettings](./aws-properties-medialive-channel-srtoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-srtoutputsettings", "UpdateType": "Mutable" }, "ArchiveOutputSettings": { "Type": "ArchiveOutputSettings", "Required": false, "MarkdownDocumentation": "`ArchiveOutputSettings`\n\nThe settings for an archive output.\n*Required*: No\n*Type*: [ArchiveOutputSettings](./aws-properties-medialive-channel-archiveoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-outputsettings.html#cfn-medialive-channel-outputsettings-archiveoutputsettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.PassThroughSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.PassThroughSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-passthroughsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.PipelineLockingSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.PipelineLockingSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-pipelinelockingsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.RawSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.RawSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rawsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.Rec601Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Rec601Settings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rec601settings.html", "Properties": {} }, "AWS::MediaLive::Channel.Rec709Settings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Rec709Settings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rec709settings.html", "Properties": {} }, "AWS::MediaLive::Channel.RemixSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.RemixSettings`\n\nThe settings for remixing audio in the output.\nThe parent of this entity is AudioDescription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-remixsettings.html", "Properties": { "ChannelsOut": { "Required": false, "MarkdownDocumentation": "`ChannelsOut`\n\nThe number of output channels to be produced. Valid values: 1, 2, 4, 6, 8.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-remixsettings.html#cfn-medialive-channel-remixsettings-channelsout", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ChannelMappings": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ChannelMappings`\n\nA mapping of input channels to output channels, with appropriate gain\nadjustments.\n*Required*: No\n*Type*: Array of [AudioChannelMapping](./aws-properties-medialive-channel-audiochannelmapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-remixsettings.html#cfn-medialive-channel-remixsettings-channelmappings", "ItemType": "AudioChannelMapping", "UpdateType": "Mutable" }, "ChannelsIn": { "Required": false, "MarkdownDocumentation": "`ChannelsIn`\n\nThe number of input channels to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-remixsettings.html#cfn-medialive-channel-remixsettings-channelsin", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.RtmpCaptionInfoDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.RtmpCaptionInfoDestinationSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpcaptioninfodestinationsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.RtmpGroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.RtmpGroupSettings`\n\nThe configuration of an RTMP output group.\nThe parent of this entity is OutputGroupSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html", "Properties": { "AuthenticationScheme": { "Required": false, "MarkdownDocumentation": "`AuthenticationScheme`\n\nAn authentication scheme to use when connecting with a CDN.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-authenticationscheme", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CacheLength": { "Required": false, "MarkdownDocumentation": "`CacheLength`\n\nThe cache length, in seconds, that is used to calculate buffer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-cachelength", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "AdMarkers": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AdMarkers`\n\nChoose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-admarkers", "UpdateType": "Mutable" }, "IncludeFillerNalUnits": { "Required": false, "MarkdownDocumentation": "`IncludeFillerNalUnits`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-includefillernalunits", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InputLossAction": { "Required": false, "MarkdownDocumentation": "`InputLossAction`\n\nControls the behavior of this RTMP group if the input becomes unavailable. emitOutput:\nEmit a slate until the input returns. pauseOutput: Stop transmitting data until the\ninput returns. This does not close the underlying RTMP 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-inputlossaction", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RestartDelay": { "Required": false, "MarkdownDocumentation": "`RestartDelay`\n\nIf a streaming output fails, the number of seconds to wait until a restart is\ninitiated. A value of 0 means never restart.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-restartdelay", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CaptionData": { "Required": false, "MarkdownDocumentation": "`CaptionData`\n\nControls the types of data that pass to onCaptionInfo outputs. If set to all, 608 and\n708 carried DTVCC data is passed. If set to field1AndField2608, DTVCC data is stripped\nout, but 608 data from both fields is passed. If set to field1608, only the data carried\nin 608 from field 1 video is passed.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-captiondata", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CacheFullBehavior": { "Required": false, "MarkdownDocumentation": "`CacheFullBehavior`\n\nControls behavior when the content cache fills up. If a remote origin server stalls\nthe RTMP connection and doesn't accept content fast enough, the media cache fills up.\nWhen the cache reaches the duration specified by cacheLength, the cache stops accepting\nnew content. If set to disconnectImmediately, the RTMP output forces a disconnect. Clear\nthe media cache, and reconnect after restartDelay seconds. If set to waitForServer, the\nRTMP output waits up to 5 minutes to allow the origin server to begin accepting data\nagain.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-cachefullbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.RtmpOutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.RtmpOutputSettings`\n\nThe settings for one RTMP output.\nThe parent of this entity is OutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpoutputsettings.html", "Properties": { "Destination": { "Type": "OutputLocationRef", "Required": false, "MarkdownDocumentation": "`Destination`\n\nThe RTMP endpoint excluding the stream name (for example, rtmp://host/appname).\n*Required*: No\n*Type*: [OutputLocationRef](./aws-properties-medialive-channel-outputlocationref.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpoutputsettings.html#cfn-medialive-channel-rtmpoutputsettings-destination", "UpdateType": "Mutable" }, "CertificateMode": { "Required": false, "MarkdownDocumentation": "`CertificateMode`\n\nIf set to verifyAuthenticity, verifies the TLS certificate chain to a trusted\ncertificate authority (CA). This causes RTMPS outputs with self-signed certificates to\nfail.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpoutputsettings.html#cfn-medialive-channel-rtmpoutputsettings-certificatemode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NumRetries": { "Required": false, "MarkdownDocumentation": "`NumRetries`\n\nThe number of retry attempts.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpoutputsettings.html#cfn-medialive-channel-rtmpoutputsettings-numretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ConnectionRetryInterval": { "Required": false, "MarkdownDocumentation": "`ConnectionRetryInterval`\n\nThe number of seconds to wait before retrying a connection to the Flash Media server\nif the connection is lost.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpoutputsettings.html#cfn-medialive-channel-rtmpoutputsettings-connectionretryinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Scte20PlusEmbeddedDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Scte20PlusEmbeddedDestinationSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20plusembeddeddestinationsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.Scte20SourceSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Scte20SourceSettings`\n\nInformation about the SCTE-20 captions to extract from the input.\nThe parent of this entity is CaptionSelectorSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html", "Properties": { "Source608ChannelNumber": { "Required": false, "MarkdownDocumentation": "`Source608ChannelNumber`\n\nSpecifies the 608/708 channel number within the video track from which to extract\ncaptions.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html#cfn-medialive-channel-scte20sourcesettings-source608channelnumber", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Convert608To708": { "Required": false, "MarkdownDocumentation": "`Convert608To708`\n\nIf upconvert, 608 data is both passed through the \"608 compatibility bytes\" fields of\nthe 708 wrapper as well as translated into 708. Any 708 data present in the source\ncontent is discarded.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte20sourcesettings.html#cfn-medialive-channel-scte20sourcesettings-convert608to708", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Scte27DestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Scte27DestinationSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27destinationsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.Scte27SourceSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Scte27SourceSettings`\n\nInformation about the SCTE-27 captions to extract from the input.\nThe parent of this entity is CaptionSelectorSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html", "Properties": { "OcrLanguage": { "Required": false, "MarkdownDocumentation": "`OcrLanguage`\n\nIf you will configure a WebVTT caption description that references this caption selector, use this field to\nprovide the language to consider when translating the image-based source to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html#cfn-medialive-channel-scte27sourcesettings-ocrlanguage", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Pid": { "Required": false, "MarkdownDocumentation": "`Pid`\n\nThe PID field is used in conjunction with the captions selector languageCode field as\nfollows: Specify PID and Language: Extracts captions from that PID; the language is\n\"informational.\" Specify PID and omit Language: Extracts the specified PID. Omit PID and\nspecify Language: Extracts the specified language, whichever PID that happens to be.\nOmit PID and omit Language: Valid only if source is DVB-Sub that is being passed\nthrough; all languages are passed through.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte27sourcesettings.html#cfn-medialive-channel-scte27sourcesettings-pid", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Scte35SpliceInsert": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Scte35SpliceInsert`\n\nThe setup of SCTE-35 splice insert handling.\nThe parent of this entity is AvailSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35spliceinsert.html", "Properties": { "AdAvailOffset": { "Required": false, "MarkdownDocumentation": "`AdAvailOffset`\n\nWhen specified, this offset (in milliseconds) is added to the input ad avail PTS time.\nThis applies only to embedded SCTE 104/35 messages. It doesn't apply to OOB\nmessages.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35spliceinsert.html#cfn-medialive-channel-scte35spliceinsert-adavailoffset", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "WebDeliveryAllowedFlag": { "Required": false, "MarkdownDocumentation": "`WebDeliveryAllowedFlag`\n\nWhen set to ignore, segment descriptors with webDeliveryAllowedFlag set to 0 no longer\ntrigger blackouts or ad avail slates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35spliceinsert.html#cfn-medialive-channel-scte35spliceinsert-webdeliveryallowedflag", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NoRegionalBlackoutFlag": { "Required": false, "MarkdownDocumentation": "`NoRegionalBlackoutFlag`\n\nWhen set to ignore, segment descriptors with noRegionalBlackoutFlag set to 0 no longer\ntrigger blackouts or ad avail slates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35spliceinsert.html#cfn-medialive-channel-scte35spliceinsert-noregionalblackoutflag", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.Scte35TimeSignalApos": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.Scte35TimeSignalApos`\n\nThe settings for the SCTE-35 time signal APOS mode.\nThe parent of this entity is AvailSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35timesignalapos.html", "Properties": { "AdAvailOffset": { "Required": false, "MarkdownDocumentation": "`AdAvailOffset`\n\nWhen specified, this offset (in milliseconds) is added to the input ad avail PTS time.\nThis applies only to embedded SCTE 104/35 messages. It doesn't apply to OOB\nmessages.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35timesignalapos.html#cfn-medialive-channel-scte35timesignalapos-adavailoffset", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "WebDeliveryAllowedFlag": { "Required": false, "MarkdownDocumentation": "`WebDeliveryAllowedFlag`\n\nWhen set to ignore, segment descriptors with webDeliveryAllowedFlag set to 0 no longer\ntrigger blackouts or ad avail slates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35timesignalapos.html#cfn-medialive-channel-scte35timesignalapos-webdeliveryallowedflag", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NoRegionalBlackoutFlag": { "Required": false, "MarkdownDocumentation": "`NoRegionalBlackoutFlag`\n\nWhen set to ignore, segment descriptors with noRegionalBlackoutFlag set to 0 no longer\ntrigger blackouts or ad avail slates.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-scte35timesignalapos.html#cfn-medialive-channel-scte35timesignalapos-noregionalblackoutflag", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.SmpteTtDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.SmpteTtDestinationSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-smptettdestinationsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.SrtGroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.SrtGroupSettings`\n\nThe `SrtGroupSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtgroupsettings.html", "Properties": { "InputLossAction": { "Required": false, "MarkdownDocumentation": "`InputLossAction`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtgroupsettings.html#cfn-medialive-channel-srtgroupsettings-inputlossaction", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.SrtOutputDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.SrtOutputDestinationSettings`\n\nThe `SrtOutputDestinationSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputdestinationsettings.html", "Properties": { "StreamId": { "Required": false, "MarkdownDocumentation": "`StreamId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputdestinationsettings.html#cfn-medialive-channel-srtoutputdestinationsettings-streamid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncryptionPassphraseSecretArn": { "Required": false, "MarkdownDocumentation": "`EncryptionPassphraseSecretArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputdestinationsettings.html#cfn-medialive-channel-srtoutputdestinationsettings-encryptionpassphrasesecretarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Url": { "Required": false, "MarkdownDocumentation": "`Url`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputdestinationsettings.html#cfn-medialive-channel-srtoutputdestinationsettings-url", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.SrtOutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.SrtOutputSettings`\n\nThe `SrtOutputSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputsettings.html", "Properties": { "EncryptionType": { "Required": false, "MarkdownDocumentation": "`EncryptionType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputsettings.html#cfn-medialive-channel-srtoutputsettings-encryptiontype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Destination": { "Type": "OutputLocationRef", "Required": false, "MarkdownDocumentation": "`Destination`\n\nProperty description not available.\n*Required*: No\n*Type*: [OutputLocationRef](./aws-properties-medialive-channel-outputlocationref.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputsettings.html#cfn-medialive-channel-srtoutputsettings-destination", "UpdateType": "Mutable" }, "ContainerSettings": { "Type": "UdpContainerSettings", "Required": false, "MarkdownDocumentation": "`ContainerSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [UdpContainerSettings](./aws-properties-medialive-channel-udpcontainersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputsettings.html#cfn-medialive-channel-srtoutputsettings-containersettings", "UpdateType": "Mutable" }, "BufferMsec": { "Required": false, "MarkdownDocumentation": "`BufferMsec`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputsettings.html#cfn-medialive-channel-srtoutputsettings-buffermsec", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Latency": { "Required": false, "MarkdownDocumentation": "`Latency`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-srtoutputsettings.html#cfn-medialive-channel-srtoutputsettings-latency", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.StandardHlsSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.StandardHlsSettings`\n\nThe configuration of an HLS output that is a standard output (not an audio-only\noutput).\nThe parent of this entity is HlsSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-standardhlssettings.html", "Properties": { "AudioRenditionSets": { "Required": false, "MarkdownDocumentation": "`AudioRenditionSets`\n\nLists all the audio groups that are used with the video output stream. This inputs all\nthe audio GROUP-IDs that are associated with the video, separated by 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-standardhlssettings.html#cfn-medialive-channel-standardhlssettings-audiorenditionsets", "PrimitiveType": "String", "UpdateType": "Mutable" }, "M3u8Settings": { "Type": "M3u8Settings", "Required": false, "MarkdownDocumentation": "`M3u8Settings`\n\nSettings for the M3U8 container.\n*Required*: No\n*Type*: [M3u8Settings](./aws-properties-medialive-channel-m3u8settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-standardhlssettings.html#cfn-medialive-channel-standardhlssettings-m3u8settings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.StaticKeySettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.StaticKeySettings`\n\nThe static key settings.\nThe parent of this entity is KeyProviderSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-statickeysettings.html", "Properties": { "KeyProviderServer": { "Type": "InputLocation", "Required": false, "MarkdownDocumentation": "`KeyProviderServer`\n\nThe URL of the license server that is used for protecting content.\n*Required*: No\n*Type*: [InputLocation](./aws-properties-medialive-channel-inputlocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-statickeysettings.html#cfn-medialive-channel-statickeysettings-keyproviderserver", "UpdateType": "Mutable" }, "StaticKeyValue": { "Required": false, "MarkdownDocumentation": "`StaticKeyValue`\n\nThe static key value as a 32 character hexadecimal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-statickeysettings.html#cfn-medialive-channel-statickeysettings-statickeyvalue", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.TeletextDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.TeletextDestinationSettings`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextdestinationsettings.html", "Properties": {} }, "AWS::MediaLive::Channel.TeletextSourceSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.TeletextSourceSettings`\n\nInformation about the Teletext captions to extract from the input.\nThe parent of this entity is CaptionSelectorSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextsourcesettings.html", "Properties": { "OutputRectangle": { "Type": "CaptionRectangle", "Required": false, "MarkdownDocumentation": "`OutputRectangle`\n\nSettings to configure the caption rectangle for an output captions that will be\ncreated using this Teletext source captions.\n*Required*: No\n*Type*: [CaptionRectangle](./aws-properties-medialive-channel-captionrectangle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextsourcesettings.html#cfn-medialive-channel-teletextsourcesettings-outputrectangle", "UpdateType": "Mutable" }, "PageNumber": { "Required": false, "MarkdownDocumentation": "`PageNumber`\n\nSpecifies the Teletext page number within the data stream from which to extract\ncaptions. The range is 0x100 (256) to 0x8FF (2303). This is unused for passthrough. It\nshould be specified as a hexadecimal string with no \"0x\" 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-teletextsourcesettings.html#cfn-medialive-channel-teletextsourcesettings-pagenumber", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.TemporalFilterSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.TemporalFilterSettings`\n\nSettings for the temporal filter to apply to the video.\nThe parents of this entity are H264FilterSettings, H265FilterSettings, and\nMpeg2FilterSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-temporalfiltersettings.html", "Properties": { "PostFilterSharpening": { "Required": false, "MarkdownDocumentation": "`PostFilterSharpening`\n\nIf you enable this filter, the results are the following:\n- If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source.\n- If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-temporalfiltersettings.html#cfn-medialive-channel-temporalfiltersettings-postfiltersharpening", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Strength": { "Required": false, "MarkdownDocumentation": "`Strength`\n\nChoose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-temporalfiltersettings.html#cfn-medialive-channel-temporalfiltersettings-strength", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.ThumbnailConfiguration": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.ThumbnailConfiguration`\n\nThe `ThumbnailConfiguration` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-thumbnailconfiguration.html", "Properties": { "State": { "Required": false, "MarkdownDocumentation": "`State`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-thumbnailconfiguration.html#cfn-medialive-channel-thumbnailconfiguration-state", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.TimecodeBurninSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.TimecodeBurninSettings`\n\nThe `TimecodeBurninSettings` property type specifies Property description not available. for an [AWS::MediaLive::Channel](./aws-resource-medialive-channel.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeburninsettings.html", "Properties": { "FontSize": { "Required": false, "MarkdownDocumentation": "`FontSize`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeburninsettings.html#cfn-medialive-channel-timecodeburninsettings-fontsize", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Position": { "Required": false, "MarkdownDocumentation": "`Position`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeburninsettings.html#cfn-medialive-channel-timecodeburninsettings-position", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Prefix": { "Required": false, "MarkdownDocumentation": "`Prefix`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeburninsettings.html#cfn-medialive-channel-timecodeburninsettings-prefix", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.TimecodeConfig": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.TimecodeConfig`\n\nThe configuration of the timecode in the output.\nThe parent of this entity is EncoderSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeconfig.html", "Properties": { "SyncThreshold": { "Required": false, "MarkdownDocumentation": "`SyncThreshold`\n\nThe threshold in frames beyond which output timecode is resynchronized to the input\ntimecode. Discrepancies below this threshold are permitted to avoid unnecessary\ndiscontinuities in the output timecode. There is no timecode sync when this is not\nspecified.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeconfig.html#cfn-medialive-channel-timecodeconfig-syncthreshold", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Source": { "Required": false, "MarkdownDocumentation": "`Source`\n\nIdentifies the source for the timecode that will be associated with the channel\noutputs. Embedded (embedded): Initialize the output timecode with timecode from the\nsource. If no embedded timecode is detected in the source, the system falls back to\nusing \"Start at 0\" (zerobased). System Clock (systemclock): Use the UTC time. Start at 0\n(zerobased): The time of the first frame of the channel will be 00:00:00:00.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-timecodeconfig.html#cfn-medialive-channel-timecodeconfig-source", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.TtmlDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.TtmlDestinationSettings`\n\nThe setup of TTML captions in the output.\nThe parent of this entity is CaptionDestinationSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ttmldestinationsettings.html", "Properties": { "StyleControl": { "Required": false, "MarkdownDocumentation": "`StyleControl`\n\nWhen set to passthrough, passes through style and position information from a\nTTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML\noutput.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-ttmldestinationsettings.html#cfn-medialive-channel-ttmldestinationsettings-stylecontrol", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.UdpContainerSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.UdpContainerSettings`\n\nThe configuration of a UDP output.\nThe parent of this entity is UdpOutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpcontainersettings.html", "Properties": { "M2tsSettings": { "Type": "M2tsSettings", "Required": false, "MarkdownDocumentation": "`M2tsSettings`\n\nThe M2TS configuration for this UDP output.\n*Required*: No\n*Type*: [M2tsSettings](./aws-properties-medialive-channel-m2tssettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpcontainersettings.html#cfn-medialive-channel-udpcontainersettings-m2tssettings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.UdpGroupSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.UdpGroupSettings`\n\nThe configuration of a UDP output group.\nThe parent of this entity is OutputGroupSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpgroupsettings.html", "Properties": { "TimedMetadataId3Frame": { "Required": false, "MarkdownDocumentation": "`TimedMetadataId3Frame`\n\nIndicates the ID3 frame that has the timecode.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpgroupsettings.html#cfn-medialive-channel-udpgroupsettings-timedmetadataid3frame", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TimedMetadataId3Period": { "Required": false, "MarkdownDocumentation": "`TimedMetadataId3Period`\n\nThe timed metadata interval 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpgroupsettings.html#cfn-medialive-channel-udpgroupsettings-timedmetadataid3period", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "InputLossAction": { "Required": false, "MarkdownDocumentation": "`InputLossAction`\n\nSpecifies the behavior of the last resort when the input video is lost, and no more\nbackup inputs are available. When dropTs is selected, the entire transport stream stops\nemitting. When dropProgram is selected, the program can be dropped from the transport\nstream (and replaced with null packets to meet the TS bitrate requirement). Or when\nemitProgram is selected, the transport stream continues to be produced normally with\nrepeat frames, black frames, or slate frames substituted for the absent input\nvideo.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpgroupsettings.html#cfn-medialive-channel-udpgroupsettings-inputlossaction", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.UdpOutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.UdpOutputSettings`\n\nThe settings for one UDP output.\nThe parent of this entity is OutputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpoutputsettings.html", "Properties": { "Destination": { "Type": "OutputLocationRef", "Required": false, "MarkdownDocumentation": "`Destination`\n\nThe destination address and port number for RTP or UDP packets. These can be unicast\nor multicast RTP or UDP (for example, rtp://239.10.10.10:5001 or\nudp://10.100.100.100:5002).\n*Required*: No\n*Type*: [OutputLocationRef](./aws-properties-medialive-channel-outputlocationref.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpoutputsettings.html#cfn-medialive-channel-udpoutputsettings-destination", "UpdateType": "Mutable" }, "FecOutputSettings": { "Type": "FecOutputSettings", "Required": false, "MarkdownDocumentation": "`FecOutputSettings`\n\nThe settings for enabling and adjusting Forward Error Correction on UDP\noutputs.\n*Required*: No\n*Type*: [FecOutputSettings](./aws-properties-medialive-channel-fecoutputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpoutputsettings.html#cfn-medialive-channel-udpoutputsettings-fecoutputsettings", "UpdateType": "Mutable" }, "ContainerSettings": { "Type": "UdpContainerSettings", "Required": false, "MarkdownDocumentation": "`ContainerSettings`\n\nThe settings for the UDP output.\n*Required*: No\n*Type*: [UdpContainerSettings](./aws-properties-medialive-channel-udpcontainersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpoutputsettings.html#cfn-medialive-channel-udpoutputsettings-containersettings", "UpdateType": "Mutable" }, "BufferMsec": { "Required": false, "MarkdownDocumentation": "`BufferMsec`\n\nThe UDP output buffering in milliseconds. Larger values increase latency through the\ntranscoder but simultaneously assist the transcoder in maintaining a constant,\nlow-jitter UDP/RTP output while accommodating clock recovery, input switching, input\ndisruptions, picture reordering, and so 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-udpoutputsettings.html#cfn-medialive-channel-udpoutputsettings-buffermsec", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VideoBlackFailoverSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VideoBlackFailoverSettings`\n\nMediaLive will perform a failover if content is considered black for the specified\nperiod.\nThe parent of this entity is FailoverConditionSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html", "Properties": { "VideoBlackThresholdMsec": { "Required": false, "MarkdownDocumentation": "`VideoBlackThresholdMsec`\n\nThe amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html#cfn-medialive-channel-videoblackfailoversettings-videoblackthresholdmsec", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "BlackDetectThreshold": { "Required": false, "MarkdownDocumentation": "`BlackDetectThreshold`\n\nA value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023\\*0.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255\\*0.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html#cfn-medialive-channel-videoblackfailoversettings-blackdetectthreshold", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VideoCodecSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VideoCodecSettings`\n\nThe settings for the video codec in the output.\nThe parent of this entity is VideoDescription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videocodecsettings.html", "Properties": { "Mpeg2Settings": { "Type": "Mpeg2Settings", "Required": false, "MarkdownDocumentation": "`Mpeg2Settings`\n\nSettings for video encoded with the MPEG-2 codec.\n*Required*: No\n*Type*: [Mpeg2Settings](./aws-properties-medialive-channel-mpeg2settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videocodecsettings.html#cfn-medialive-channel-videocodecsettings-mpeg2settings", "UpdateType": "Mutable" }, "FrameCaptureSettings": { "Type": "FrameCaptureSettings", "Required": false, "MarkdownDocumentation": "`FrameCaptureSettings`\n\nThe settings for the video codec in a frame capture output.\n*Required*: No\n*Type*: [FrameCaptureSettings](./aws-properties-medialive-channel-framecapturesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videocodecsettings.html#cfn-medialive-channel-videocodecsettings-framecapturesettings", "UpdateType": "Mutable" }, "H264Settings": { "Type": "H264Settings", "Required": false, "MarkdownDocumentation": "`H264Settings`\n\nThe settings for the H.264 codec in the output.\n*Required*: No\n*Type*: [H264Settings](./aws-properties-medialive-channel-h264settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videocodecsettings.html#cfn-medialive-channel-videocodecsettings-h264settings", "UpdateType": "Mutable" }, "H265Settings": { "Type": "H265Settings", "Required": false, "MarkdownDocumentation": "`H265Settings`\n\nSettings for video encoded with the H265 codec.\n*Required*: No\n*Type*: [H265Settings](./aws-properties-medialive-channel-h265settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videocodecsettings.html#cfn-medialive-channel-videocodecsettings-h265settings", "UpdateType": "Mutable" }, "Av1Settings": { "Type": "Av1Settings", "Required": false, "MarkdownDocumentation": "`Av1Settings`\n\nProperty description not available.\n*Required*: No\n*Type*: [Av1Settings](./aws-properties-medialive-channel-av1settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videocodecsettings.html#cfn-medialive-channel-videocodecsettings-av1settings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VideoDescription": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VideoDescription`\n\nEncoding information for one output video.\nThe parent of this entity is EncoderSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.html", "Properties": { "ScalingBehavior": { "Required": false, "MarkdownDocumentation": "`ScalingBehavior`\n\nSTRETCHTOOUTPUT configures the output position to stretch the video to the specified\noutput resolution (height and width). This option overrides any position value. DEFAULT\nmight insert black boxes (pillar boxes or letter boxes) around the video to provide the\nspecified output resolution.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.html#cfn-medialive-channel-videodescription-scalingbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RespondToAfd": { "Required": false, "MarkdownDocumentation": "`RespondToAfd`\n\nIndicates how to respond to the AFD values in the input stream. RESPOND causes input\nvideo to be clipped, depending on the AFD value, input display aspect ratio, and output\ndisplay aspect ratio, and (except for the FRAMECAPTURE codec) includes the values in the\noutput. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and\nincludes the values in the output, so input video is not clipped. NONE ignores the AFD\nvalues and does not include the values through to the output, so input video is not\nclipped.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.html#cfn-medialive-channel-videodescription-respondtoafd", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Height": { "Required": false, "MarkdownDocumentation": "`Height`\n\nThe output video height, in pixels. This must be an even number. For most codecs, you\ncan keep this field and width blank in order to use the height and width (resolution)\nfrom the source. Note that we don't recommend keeping the field blank. For the Frame\nCapture codec, height and width are required.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.html#cfn-medialive-channel-videodescription-height", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Sharpness": { "Required": false, "MarkdownDocumentation": "`Sharpness`\n\nChanges the strength of the anti-alias filter used for scaling. 0 is the softest\nsetting, and 100 is the sharpest. We recommend a setting of 50 for most content.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.html#cfn-medialive-channel-videodescription-sharpness", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Width": { "Required": false, "MarkdownDocumentation": "`Width`\n\nThe output video width, in pixels. It must be an even number. For most codecs, you can\nkeep this field and height blank in order to use the height and width (resolution) from\nthe source. Note that we don't recommend keeping the field blank. For the Frame Capture\ncodec, height and width are required.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.html#cfn-medialive-channel-videodescription-width", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CodecSettings": { "Type": "VideoCodecSettings", "Required": false, "MarkdownDocumentation": "`CodecSettings`\n\nThe video codec settings.\n*Required*: No\n*Type*: [VideoCodecSettings](./aws-properties-medialive-channel-videocodecsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.html#cfn-medialive-channel-videodescription-codecsettings", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of this VideoDescription. Outputs use this name to uniquely identify this\ndescription. Description names should be unique within this channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videodescription.html#cfn-medialive-channel-videodescription-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VideoSelector": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VideoSelector`\n\nInformation about the video to extract from the input. An input can contain only one\nvideo selector.\nThe parent of this entity is InputSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html", "Properties": { "ColorSpaceSettings": { "Type": "VideoSelectorColorSpaceSettings", "Required": false, "MarkdownDocumentation": "`ColorSpaceSettings`\n\nSettings to configure color space settings in the incoming video.\n*Required*: No\n*Type*: [VideoSelectorColorSpaceSettings](./aws-properties-medialive-channel-videoselectorcolorspacesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-colorspacesettings", "UpdateType": "Mutable" }, "SelectorSettings": { "Type": "VideoSelectorSettings", "Required": false, "MarkdownDocumentation": "`SelectorSettings`\n\nInformation about the video to select from the content.\n*Required*: No\n*Type*: [VideoSelectorSettings](./aws-properties-medialive-channel-videoselectorsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-selectorsettings", "UpdateType": "Mutable" }, "ColorSpace": { "Required": false, "MarkdownDocumentation": "`ColorSpace`\n\nSpecifies the color space of an input. This setting works in tandem with\ncolorSpaceConversion to determine if MediaLive will perform any conversion.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-colorspace", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ColorSpaceUsage": { "Required": false, "MarkdownDocumentation": "`ColorSpaceUsage`\n\nApplies only if colorSpace is a value other than Follow. This field controls how the\nvalue in the colorSpace field is used. Fallback means that when the input does include\ncolor space data, that data is used, but when the input has no color space data, the\nvalue in colorSpace is used. Choose fallback if your input is sometimes missing color\nspace data, but when it does have color space data, that data is correct. Force means to\nalways use the value in colorSpace. Choose force if your input usually has no color\nspace data or might have unreliable color space 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html#cfn-medialive-channel-videoselector-colorspaceusage", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VideoSelectorColorSpaceSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VideoSelectorColorSpaceSettings`\n\nSettings to configure color space settings in the incoming video.\nThe parent of this entity is VideoSelector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorcolorspacesettings.html", "Properties": { "Hdr10Settings": { "Type": "Hdr10Settings", "Required": false, "MarkdownDocumentation": "`Hdr10Settings`\n\nSettings to configure color space settings in the incoming video.\n*Required*: No\n*Type*: [Hdr10Settings](./aws-properties-medialive-channel-hdr10settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorcolorspacesettings.html#cfn-medialive-channel-videoselectorcolorspacesettings-hdr10settings", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VideoSelectorPid": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VideoSelectorPid`\n\nSelects a specific PID from within a video source.\nThe parent of this entity is VideoSelectorSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorpid.html", "Properties": { "Pid": { "Required": false, "MarkdownDocumentation": "`Pid`\n\nSelects a specific PID from within a video 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorpid.html#cfn-medialive-channel-videoselectorpid-pid", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VideoSelectorProgramId": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VideoSelectorProgramId`\n\nUsed to extract video by the program ID.\nThe parent of this entity is VideoSelectorSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorprogramid.html", "Properties": { "ProgramId": { "Required": false, "MarkdownDocumentation": "`ProgramId`\n\nSelects a specific program from within a multi-program transport stream. If the\nprogram doesn't exist, MediaLive selects the first program within the transport stream\nby default.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorprogramid.html#cfn-medialive-channel-videoselectorprogramid-programid", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VideoSelectorSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VideoSelectorSettings`\n\nInformation about the video to extract from the input.\nThe parent of this entity is VideoSelector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html", "Properties": { "VideoSelectorProgramId": { "Type": "VideoSelectorProgramId", "Required": false, "MarkdownDocumentation": "`VideoSelectorProgramId`\n\nUsed to extract video by program ID.\n*Required*: No\n*Type*: [VideoSelectorProgramId](./aws-properties-medialive-channel-videoselectorprogramid.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html#cfn-medialive-channel-videoselectorsettings-videoselectorprogramid", "UpdateType": "Mutable" }, "VideoSelectorPid": { "Type": "VideoSelectorPid", "Required": false, "MarkdownDocumentation": "`VideoSelectorPid`\n\nUsed to extract video by PID.\n*Required*: No\n*Type*: [VideoSelectorPid](./aws-properties-medialive-channel-videoselectorpid.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselectorsettings.html#cfn-medialive-channel-videoselectorsettings-videoselectorpid", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.VpcOutputSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.VpcOutputSettings`\n\nSettings to enable VPC mode in the channel, so that the endpoints for all outputs are\nin your VPC.\nThis entity is at the top level in the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-vpcoutputsettings.html", "Properties": { "PublicAddressAllocationIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`PublicAddressAllocationIds`\n\nList of public address allocation IDs to associate with ENIs that will be created in\nOutput VPC. Must specify one for SINGLE\\_PIPELINE, two for STANDARD channels\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-vpcoutputsettings.html#cfn-medialive-channel-vpcoutputsettings-publicaddressallocationids", "UpdateType": "Mutable" }, "SecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces.\nIf none are specified then the VPC default security group will be used\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-vpcoutputsettings.html#cfn-medialive-channel-vpcoutputsettings-securitygroupids", "UpdateType": "Mutable" }, "SubnetIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SubnetIds`\n\nA list of VPC subnet IDs from the same VPC.\nIf STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-vpcoutputsettings.html#cfn-medialive-channel-vpcoutputsettings-subnetids", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.WavSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.WavSettings`\n\nThe setup of WAV audio in the output.\nThe parent of this entity is AudioCodecSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-wavsettings.html", "Properties": { "CodingMode": { "Required": false, "MarkdownDocumentation": "`CodingMode`\n\nThe audio coding mode for the WAV audio. The mode determines the number of channels in the audio.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-wavsettings.html#cfn-medialive-channel-wavsettings-codingmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SampleRate": { "Required": false, "MarkdownDocumentation": "`SampleRate`\n\nSample rate in Hz.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-wavsettings.html#cfn-medialive-channel-wavsettings-samplerate", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "BitDepth": { "Required": false, "MarkdownDocumentation": "`BitDepth`\n\nBits per sample.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-wavsettings.html#cfn-medialive-channel-wavsettings-bitdepth", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Channel.WebvttDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Channel.WebvttDestinationSettings`\n\nThe configuration of Web VTT captions in the output.\nThe parent of this entity is CaptionDestinationSettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-webvttdestinationsettings.html", "Properties": { "StyleControl": { "Required": false, "MarkdownDocumentation": "`StyleControl`\n\nControls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO\\_STYLE\\_DATA - Don't pass through the style. The output captions will not contain any font styling information.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-webvttdestinationsettings.html#cfn-medialive-channel-webvttdestinationsettings-stylecontrol", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::ChannelPlacementGroup.Tags": { "MarkdownDocumentation": "`AWS::MediaLive::ChannelPlacementGroup.Tags`\n\nThe `Tags` property type specifies Property description not available. for an [AWS::MediaLive::ChannelPlacementGroup](./aws-resource-medialive-channelplacementgroup.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channelplacementgroup-tags.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channelplacementgroup-tags.html#cfn-medialive-channelplacementgroup-tags-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channelplacementgroup-tags.html#cfn-medialive-channelplacementgroup-tags-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::Cluster.ClusterNetworkSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Cluster.ClusterNetworkSettings`\n\nThe `ClusterNetworkSettings` property type specifies Property description not available. for an [AWS::MediaLive::Cluster](./aws-resource-medialive-cluster.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-clusternetworksettings.html", "Properties": { "InterfaceMappings": { "MarkdownDocumentation": "`InterfaceMappings`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [InterfaceMapping](./aws-properties-medialive-cluster-interfacemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-clusternetworksettings.html#cfn-medialive-cluster-clusternetworksettings-interfacemappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InterfaceMapping", "DuplicatesAllowed": true }, "DefaultRoute": { "MarkdownDocumentation": "`DefaultRoute`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-clusternetworksettings.html#cfn-medialive-cluster-clusternetworksettings-defaultroute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::Cluster.InterfaceMapping": { "MarkdownDocumentation": "`AWS::MediaLive::Cluster.InterfaceMapping`\n\nThe `InterfaceMapping` property type specifies Property description not available. for an [AWS::MediaLive::Cluster](./aws-resource-medialive-cluster.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-interfacemapping.html", "Properties": { "NetworkId": { "MarkdownDocumentation": "`NetworkId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-interfacemapping.html#cfn-medialive-cluster-interfacemapping-networkid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogicalInterfaceName": { "MarkdownDocumentation": "`LogicalInterfaceName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-interfacemapping.html#cfn-medialive-cluster-interfacemapping-logicalinterfacename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::Cluster.Tags": { "MarkdownDocumentation": "`AWS::MediaLive::Cluster.Tags`\n\nThe `Tags` property type specifies Property description not available. for an [AWS::MediaLive::Cluster](./aws-resource-medialive-cluster.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-tags.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-tags.html#cfn-medialive-cluster-tags-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-cluster-tags.html#cfn-medialive-cluster-tags-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::EventBridgeRuleTemplate.EventBridgeRuleTemplateTarget": { "MarkdownDocumentation": "`AWS::MediaLive::EventBridgeRuleTemplate.EventBridgeRuleTemplateTarget`\n\nThe target to which to send matching events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-eventbridgeruletemplate-eventbridgeruletemplatetarget.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nTarget ARNs must be either an SNS topic or CloudWatch log group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-eventbridgeruletemplate-eventbridgeruletemplatetarget.html#cfn-medialive-eventbridgeruletemplate-eventbridgeruletemplatetarget-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaLive::InputSecurityGroup.InputWhitelistRuleCidr": { "MarkdownDocumentation": "`AWS::MediaLive::InputSecurityGroup.InputWhitelistRuleCidr`\n\nAn IPv4 CIDR range to include in this input security group.\nThe parent of this entity is InputSecurityGroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-inputsecuritygroup-inputwhitelistrulecidr.html", "Properties": { "Cidr": { "Required": false, "MarkdownDocumentation": "`Cidr`\n\nAn IPv4 CIDR range to include in this input security 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-inputsecuritygroup-inputwhitelistrulecidr.html#cfn-medialive-inputsecuritygroup-inputwhitelistrulecidr-cidr", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaLive::Multiplex.MultiplexMediaConnectOutputDestinationSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplex.MultiplexMediaConnectOutputDestinationSettings`\n\nMultiplex MediaConnect output destination settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexmediaconnectoutputdestinationsettings.html", "Properties": { "EntitlementArn": { "MarkdownDocumentation": "`EntitlementArn`\n\nThe MediaConnect entitlement ARN available as a Flow source.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexmediaconnectoutputdestinationsettings.html#cfn-medialive-multiplex-multiplexmediaconnectoutputdestinationsettings-entitlementarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::Multiplex.MultiplexOutputDestination": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplex.MultiplexOutputDestination`\n\nMultiplex output destination settings\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexoutputdestination.html", "Properties": { "MultiplexMediaConnectOutputDestinationSettings": { "MarkdownDocumentation": "`MultiplexMediaConnectOutputDestinationSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [MultiplexMediaConnectOutputDestinationSettings](./aws-properties-medialive-multiplex-multiplexmediaconnectoutputdestinationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexoutputdestination.html#cfn-medialive-multiplex-multiplexoutputdestination-multiplexmediaconnectoutputdestinationsettings", "UpdateType": "Mutable", "Required": false, "Type": "MultiplexMediaConnectOutputDestinationSettings" } } }, "AWS::MediaLive::Multiplex.MultiplexSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplex.MultiplexSettings`\n\nContains configuration for a Multiplex event\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexsettings.html", "Properties": { "TransportStreamBitrate": { "MarkdownDocumentation": "`TransportStreamBitrate`\n\nTransport stream bit rate.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1000000`\n*Maximum*: `100000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexsettings.html#cfn-medialive-multiplex-multiplexsettings-transportstreambitrate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "MaximumVideoBufferDelayMilliseconds": { "MarkdownDocumentation": "`MaximumVideoBufferDelayMilliseconds`\n\nMaximum video buffer delay in milliseconds.\n*Required*: No\n*Type*: Integer\n*Minimum*: `800`\n*Maximum*: `3000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexsettings.html#cfn-medialive-multiplex-multiplexsettings-maximumvideobufferdelaymilliseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TransportStreamId": { "MarkdownDocumentation": "`TransportStreamId`\n\nTransport stream ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexsettings.html#cfn-medialive-multiplex-multiplexsettings-transportstreamid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "TransportStreamReservedBitrate": { "MarkdownDocumentation": "`TransportStreamReservedBitrate`\n\nTransport stream reserved bit rate.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `100000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-multiplexsettings.html#cfn-medialive-multiplex-multiplexsettings-transportstreamreservedbitrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::MediaLive::Multiplex.Tags": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplex.Tags`\n\nThe `Tags` property type specifies Property description not available. for an [AWS::MediaLive::Multiplex](./aws-resource-medialive-multiplex.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-tags.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-tags.html#cfn-medialive-multiplex-tags-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplex-tags.html#cfn-medialive-multiplex-tags-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::Multiplexprogram.MultiplexProgramPacketIdentifiersMap": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplexprogram.MultiplexProgramPacketIdentifiersMap`\n\nPacket identifiers map for a given Multiplex program.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html", "Properties": { "EtvPlatformPid": { "MarkdownDocumentation": "`EtvPlatformPid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-etvplatformpid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DvbTeletextPid": { "MarkdownDocumentation": "`DvbTeletextPid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-dvbteletextpid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "KlvDataPids": { "MarkdownDocumentation": "`KlvDataPids`\n\nProperty description not available.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-klvdatapids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "PcrPid": { "MarkdownDocumentation": "`PcrPid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-pcrpid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VideoPid": { "MarkdownDocumentation": "`VideoPid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-videopid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PmtPid": { "MarkdownDocumentation": "`PmtPid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-pmtpid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Scte27Pids": { "MarkdownDocumentation": "`Scte27Pids`\n\nProperty description not available.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-scte27pids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "DvbSubPids": { "MarkdownDocumentation": "`DvbSubPids`\n\nProperty description not available.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-dvbsubpids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "Scte35Pid": { "MarkdownDocumentation": "`Scte35Pid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-scte35pid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EtvSignalPid": { "MarkdownDocumentation": "`EtvSignalPid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-etvsignalpid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PrivateMetadataPid": { "MarkdownDocumentation": "`PrivateMetadataPid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-privatemetadatapid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TimedMetadataPid": { "MarkdownDocumentation": "`TimedMetadataPid`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-timedmetadatapid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AudioPids": { "MarkdownDocumentation": "`AudioPids`\n\nProperty description not available.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html#cfn-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap-audiopids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true } } }, "AWS::MediaLive::Multiplexprogram.MultiplexProgramPipelineDetail": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplexprogram.MultiplexProgramPipelineDetail`\n\nThe current source for one of the pipelines in the multiplex.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampipelinedetail.html", "Properties": { "ActiveChannelPipeline": { "MarkdownDocumentation": "`ActiveChannelPipeline`\n\nIdentifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampipelinedetail.html#cfn-medialive-multiplexprogram-multiplexprogrampipelinedetail-activechannelpipeline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PipelineId": { "MarkdownDocumentation": "`PipelineId`\n\nIdentifies a specific pipeline in the multiplex.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogrampipelinedetail.html#cfn-medialive-multiplexprogram-multiplexprogrampipelinedetail-pipelineid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::Multiplexprogram.MultiplexProgramServiceDescriptor": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplexprogram.MultiplexProgramServiceDescriptor`\n\nTransport stream service descriptor configuration for the Multiplex program.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogramservicedescriptor.html", "Properties": { "ProviderName": { "MarkdownDocumentation": "`ProviderName`\n\nName of the provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogramservicedescriptor.html#cfn-medialive-multiplexprogram-multiplexprogramservicedescriptor-providername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nName of the service.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogramservicedescriptor.html#cfn-medialive-multiplexprogram-multiplexprogramservicedescriptor-servicename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaLive::Multiplexprogram.MultiplexProgramSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplexprogram.MultiplexProgramSettings`\n\nMultiplex Program settings configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogramsettings.html", "Properties": { "PreferredChannelPipeline": { "MarkdownDocumentation": "`PreferredChannelPipeline`\n\nIndicates which pipeline is preferred by the multiplex for program ingest.\n*Required*: No\n*Type*: String\n*Allowed values*: `CURRENTLY_ACTIVE | PIPELINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CURRENTLY_ACTIVE", "PIPELINE_0", "PIPELINE_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogramsettings.html#cfn-medialive-multiplexprogram-multiplexprogramsettings-preferredchannelpipeline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceDescriptor": { "MarkdownDocumentation": "`ServiceDescriptor`\n\nTransport stream service descriptor configuration for the Multiplex program.\n*Required*: No\n*Type*: [MultiplexProgramServiceDescriptor](./aws-properties-medialive-multiplexprogram-multiplexprogramservicedescriptor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogramsettings.html#cfn-medialive-multiplexprogram-multiplexprogramsettings-servicedescriptor", "UpdateType": "Mutable", "Required": false, "Type": "MultiplexProgramServiceDescriptor" }, "VideoSettings": { "MarkdownDocumentation": "`VideoSettings`\n\nProgram video settings configuration.\n*Required*: No\n*Type*: [MultiplexVideoSettings](./aws-properties-medialive-multiplexprogram-multiplexvideosettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogramsettings.html#cfn-medialive-multiplexprogram-multiplexprogramsettings-videosettings", "UpdateType": "Mutable", "Required": false, "Type": "MultiplexVideoSettings" }, "ProgramNumber": { "MarkdownDocumentation": "`ProgramNumber`\n\nUnique program number.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexprogramsettings.html#cfn-medialive-multiplexprogram-multiplexprogramsettings-programnumber", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::MediaLive::Multiplexprogram.MultiplexStatmuxVideoSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplexprogram.MultiplexStatmuxVideoSettings`\n\nStatmux rate control settings\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexstatmuxvideosettings.html", "Properties": { "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe purpose of the priority is to use a combination of the\\nmultiplex rate control algorithm and the QVBR capability of the\\nencoder to prioritize the video quality of some channels in a\\nmultiplex over others. Channels that have a higher priority will\\nget higher video quality at the expense of the video quality of\\nother channels in the multiplex with lower priority.\n*Required*: No\n*Type*: Integer\n*Minimum*: `-5`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexstatmuxvideosettings.html#cfn-medialive-multiplexprogram-multiplexstatmuxvideosettings-priority", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumBitrate": { "MarkdownDocumentation": "`MaximumBitrate`\n\nMaximum statmux bitrate.\n*Required*: No\n*Type*: Integer\n*Minimum*: `100000`\n*Maximum*: `100000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexstatmuxvideosettings.html#cfn-medialive-multiplexprogram-multiplexstatmuxvideosettings-maximumbitrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinimumBitrate": { "MarkdownDocumentation": "`MinimumBitrate`\n\nMinimum statmux bitrate.\n*Required*: No\n*Type*: Integer\n*Minimum*: `100000`\n*Maximum*: `100000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexstatmuxvideosettings.html#cfn-medialive-multiplexprogram-multiplexstatmuxvideosettings-minimumbitrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::MediaLive::Multiplexprogram.MultiplexVideoSettings": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplexprogram.MultiplexVideoSettings`\n\nThe video configuration for each program in a multiplex.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexvideosettings.html", "Properties": { "StatmuxSettings": { "MarkdownDocumentation": "`StatmuxSettings`\n\nStatmux rate control settings.\nWhen this field is defined, ConstantBitrate must be undefined.\n*Required*: No\n*Type*: [MultiplexStatmuxVideoSettings](./aws-properties-medialive-multiplexprogram-multiplexstatmuxvideosettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexvideosettings.html#cfn-medialive-multiplexprogram-multiplexvideosettings-statmuxsettings", "UpdateType": "Mutable", "Required": false, "Type": "MultiplexStatmuxVideoSettings" }, "ConstantBitrate": { "MarkdownDocumentation": "`ConstantBitrate`\n\nThe constant bitrate configuration for the video encode.\nWhen this field is defined, StatmuxSettings must be undefined.\n*Required*: No\n*Type*: Integer\n*Minimum*: `100000`\n*Maximum*: `100000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-multiplexprogram-multiplexvideosettings.html#cfn-medialive-multiplexprogram-multiplexvideosettings-constantbitrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::MediaLive::Network.IpPool": { "MarkdownDocumentation": "`AWS::MediaLive::Network.IpPool`\n\nThe `IpPool` property type specifies Property description not available. for an [AWS::MediaLive::Network](./aws-resource-medialive-network.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-network-ippool.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-network-ippool.html#cfn-medialive-network-ippool-cidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::Network.Route": { "MarkdownDocumentation": "`AWS::MediaLive::Network.Route`\n\nThe `Route` property type specifies Property description not available. for an [AWS::MediaLive::Network](./aws-resource-medialive-network.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-network-route.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-network-route.html#cfn-medialive-network-route-cidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Gateway": { "MarkdownDocumentation": "`Gateway`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-network-route.html#cfn-medialive-network-route-gateway", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::Network.Tags": { "MarkdownDocumentation": "`AWS::MediaLive::Network.Tags`\n\nThe `Tags` property type specifies Property description not available. for an [AWS::MediaLive::Network](./aws-resource-medialive-network.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-network-tags.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-network-tags.html#cfn-medialive-network-tags-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-network-tags.html#cfn-medialive-network-tags-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::SdiSource.Tags": { "MarkdownDocumentation": "`AWS::MediaLive::SdiSource.Tags`\n\nThe `Tags` property type specifies Property description not available. for an [AWS::MediaLive::SdiSource](./aws-resource-medialive-sdisource.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-sdisource-tags.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-sdisource-tags.html#cfn-medialive-sdisource-tags-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-sdisource-tags.html#cfn-medialive-sdisource-tags-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::SignalMap.MediaResource": { "MarkdownDocumentation": "`AWS::MediaLive::SignalMap.MediaResource`\n\nAn Amazon Web Services resource used in media workflows.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresource.html", "Properties": { "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nA direct destination neighbor to an Amazon Web Services media resource.\n*Required*: No\n*Type*: Array of [MediaResourceNeighbor](./aws-properties-medialive-signalmap-mediaresourceneighbor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresource.html#cfn-medialive-signalmap-mediaresource-destinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MediaResourceNeighbor", "DuplicatesAllowed": true }, "Sources": { "MarkdownDocumentation": "`Sources`\n\nA direct source neighbor to an Amazon Web Services media resource.\n*Required*: No\n*Type*: Array of [MediaResourceNeighbor](./aws-properties-medialive-signalmap-mediaresourceneighbor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresource.html#cfn-medialive-signalmap-mediaresource-sources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MediaResourceNeighbor", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe logical name of an Amazon Web Services media resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresource.html#cfn-medialive-signalmap-mediaresource-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::SignalMap.MediaResourceNeighbor": { "MarkdownDocumentation": "`AWS::MediaLive::SignalMap.MediaResourceNeighbor`\n\nA direct source or destination neighbor to an Amazon Web Services media resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresourceneighbor.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe ARN of a resource used in Amazon Web Services media workflows.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresourceneighbor.html#cfn-medialive-signalmap-mediaresourceneighbor-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe logical name of an Amazon Web Services media resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-mediaresourceneighbor.html#cfn-medialive-signalmap-mediaresourceneighbor-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::SignalMap.MonitorDeployment": { "MarkdownDocumentation": "`AWS::MediaLive::SignalMap.MonitorDeployment`\n\nRepresents the latest monitor deployment of a signal map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-monitordeployment.html", "Properties": { "DetailsUri": { "MarkdownDocumentation": "`DetailsUri`\n\nURI associated with a signal map's monitor deployment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-monitordeployment.html#cfn-medialive-signalmap-monitordeployment-detailsuri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Status": { "MarkdownDocumentation": "`Status`\n\nThe signal map monitor deployment status.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NOT_DEPLOYED | DRY_RUN_DEPL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-monitordeployment.html#cfn-medialive-signalmap-monitordeployment-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ErrorMessage": { "MarkdownDocumentation": "`ErrorMessage`\n\nError message associated with a failed monitor deployment of a signal map.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-monitordeployment.html#cfn-medialive-signalmap-monitordeployment-errormessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaLive::SignalMap.SuccessfulMonitorDeployment": { "MarkdownDocumentation": "`AWS::MediaLive::SignalMap.SuccessfulMonitorDeployment`\n\nRepresents the latest successful monitor deployment of a signal map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-successfulmonitordeployment.html", "Properties": { "DetailsUri": { "MarkdownDocumentation": "`DetailsUri`\n\nURI associated with a signal map's monitor deployment.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-successfulmonitordeployment.html#cfn-medialive-signalmap-successfulmonitordeployment-detailsuri", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Status": { "MarkdownDocumentation": "`Status`\n\nA signal map's monitor deployment status.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NOT_DEPLOYED | DRY_RUN_DEPL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NOT_DEPLOYED", "DRY_RUN_DEPLOYMENT_COMPLETE", "DRY_RUN_DEPLOYMENT_FAILED", "DRY_RUN_DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_COMPLETE", "DEPLOYMENT_FAILED", "DEPLOYMENT_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "DELETE_IN_PROGRESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-signalmap-successfulmonitordeployment.html#cfn-medialive-signalmap-successfulmonitordeployment-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackage::Asset.EgressEndpoint": { "MarkdownDocumentation": "`AWS::MediaPackage::Asset.EgressEndpoint`\n\nThe playback endpoint for a packaging configuration on an asset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-asset-egressendpoint.html", "Properties": { "PackagingConfigurationId": { "MarkdownDocumentation": "`PackagingConfigurationId`\n\nThe ID of a packaging configuration that's applied to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-asset-egressendpoint.html#cfn-mediapackage-asset-egressendpoint-packagingconfigurationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL that's used to request content from 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-asset-egressendpoint.html#cfn-mediapackage-asset-egressendpoint-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackage::Channel.HlsIngest": { "MarkdownDocumentation": "`AWS::MediaPackage::Channel.HlsIngest`\n\nHLS ingest configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-hlsingest.html", "Properties": { "ingestEndpoints": { "MarkdownDocumentation": "`ingestEndpoints`\n\nThe input URL where the source stream should be sent.\n*Required*: No\n*Type*: Array of [IngestEndpoint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-hlsingest.html#cfn-mediapackage-channel-hlsingest-ingestendpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IngestEndpoint", "DuplicatesAllowed": true } } }, "AWS::MediaPackage::Channel.IngestEndpoint": { "MarkdownDocumentation": "`AWS::MediaPackage::Channel.IngestEndpoint`\n\nAn endpoint for ingesting source content for a channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html", "Properties": { "Username": { "MarkdownDocumentation": "`Username`\n\nThe system-generated username for WebDAV input authentication.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html#cfn-mediapackage-channel-ingestendpoint-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe endpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html#cfn-mediapackage-channel-ingestendpoint-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe input URL where the source stream should be sent.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html#cfn-mediapackage-channel-ingestendpoint-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe system-generated password for WebDAV input authentication.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html#cfn-mediapackage-channel-ingestendpoint-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackage::Channel.LogConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackage::Channel.LogConfiguration`\n\nThe access log configuration parameters for your channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html", "Properties": { "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nSets a custom Amazon CloudWatch log group name.\n*Required*: No\n*Type*: String\n*Pattern*: `\\A^(\\/aws\\/MediaPackage\\/)[a-zA-Z0-9_-]+\\Z`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html#cfn-mediapackage-channel-logconfiguration-loggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackage::OriginEndpoint.Authorization": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.Authorization`\n\nParameters for enabling CDN authorization on the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-authorization.html", "Properties": { "SecretsRoleArn": { "MarkdownDocumentation": "`SecretsRoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-authorization.html#cfn-mediapackage-originendpoint-authorization-secretsrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CdnIdentifierSecret": { "MarkdownDocumentation": "`CdnIdentifierSecret`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-authorization.html#cfn-mediapackage-originendpoint-authorization-cdnidentifiersecret", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackage::OriginEndpoint.CmafEncryption": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.CmafEncryption`\n\nHolds encryption information so that access to the content can be controlled by a DRM solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafencryption.html", "Properties": { "KeyRotationIntervalSeconds": { "MarkdownDocumentation": "`KeyRotationIntervalSeconds`\n\nNumber 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafencryption.html#cfn-mediapackage-originendpoint-cmafencryption-keyrotationintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nParameters for the SPEKE key provider.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafencryption.html#cfn-mediapackage-originendpoint-cmafencryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" }, "ConstantInitializationVector": { "MarkdownDocumentation": "`ConstantInitializationVector`\n\nAn 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*Pattern*: `\\A[0-9a-fA-F]+\\Z`\n*Minimum*: `32`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafencryption.html#cfn-mediapackage-originendpoint-cmafencryption-constantinitializationvector", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionMethod": { "MarkdownDocumentation": "`EncryptionMethod`\n\nThe encryption method to use.\n*Required*: No\n*Type*: String\n*Allowed values*: `SAMPLE_AES | AES_CTR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SAMPLE_AES", "AES_CTR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafencryption.html#cfn-mediapackage-originendpoint-cmafencryption-encryptionmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackage::OriginEndpoint.CmafPackage": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.CmafPackage`\n\nParameters for Common Media Application Format (CMAF) packaging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafpackage.html", "Properties": { "SegmentPrefix": { "MarkdownDocumentation": "`SegmentPrefix`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafpackage.html#cfn-mediapackage-originendpoint-cmafpackage-segmentprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StreamSelection": { "MarkdownDocumentation": "`StreamSelection`\n\nLimitations for outputs from the endpoint, based on the video bitrate.\n*Required*: No\n*Type*: [StreamSelection](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafpackage.html#cfn-mediapackage-originendpoint-cmafpackage-streamselection", "UpdateType": "Mutable", "Required": false, "Type": "StreamSelection" }, "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nDuration (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafpackage.html#cfn-mediapackage-originendpoint-cmafpackage-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nParameters for encrypting content.\n*Required*: No\n*Type*: [CmafEncryption](./aws-properties-mediapackage-originendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafpackage.html#cfn-mediapackage-originendpoint-cmafpackage-encryption", "UpdateType": "Mutable", "Required": false, "Type": "CmafEncryption" }, "HlsManifests": { "MarkdownDocumentation": "`HlsManifests`\n\nA list of HLS manifest configurations that are available from this endpoint.\n*Required*: No\n*Type*: Array of [HlsManifest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafpackage.html#cfn-mediapackage-originendpoint-cmafpackage-hlsmanifests", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HlsManifest", "DuplicatesAllowed": true } } }, "AWS::MediaPackage::OriginEndpoint.DashEncryption": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.DashEncryption`\n\nHolds encryption information so that access to the content can be controlled by a DRM solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashencryption.html", "Properties": { "KeyRotationIntervalSeconds": { "MarkdownDocumentation": "`KeyRotationIntervalSeconds`\n\nNumber 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashencryption.html#cfn-mediapackage-originendpoint-dashencryption-keyrotationintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nParameters for the SPEKE key provider.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashencryption.html#cfn-mediapackage-originendpoint-dashencryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" } } }, "AWS::MediaPackage::OriginEndpoint.DashPackage": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.DashPackage`\n\nParameters for DASH packaging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html", "Properties": { "ManifestWindowSeconds": { "MarkdownDocumentation": "`ManifestWindowSeconds`\n\nTime 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-manifestwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AdsOnDeliveryRestrictions": { "MarkdownDocumentation": "`AdsOnDeliveryRestrictions`\n\nThe 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*Allowed values*: `NONE | RESTRICTED | UNRESTR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-adsondeliveryrestrictions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestLayout": { "MarkdownDocumentation": "`ManifestLayout`\n\nDetermines 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*Allowed values*: `FULL | COMPACT | DRM_TOP_LE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FULL", "COMPACT", "DRM_TOP_LEVEL_COMPACT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-manifestlayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StreamSelection": { "MarkdownDocumentation": "`StreamSelection`\n\nLimitations for outputs from the endpoint, based on the video bitrate.\n*Required*: No\n*Type*: [StreamSelection](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-streamselection", "UpdateType": "Mutable", "Required": false, "Type": "StreamSelection" }, "IncludeIframeOnlyStream": { "MarkdownDocumentation": "`IncludeIframeOnlyStream`\n\nThis applies only to stream sets with a single video track. When true, the stream set includes an\nadditional 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-includeiframeonlystream", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SegmentTemplateFormat": { "MarkdownDocumentation": "`SegmentTemplateFormat`\n\nDetermines 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\n 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*Allowed values*: `NUMBER_WITH_TIMELINE | TIME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NUMBER_WITH_TIMELINE", "TIME_WITH_TIMELINE", "NUMBER_WITH_DURATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-segmenttemplateformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nParameters for encrypting content.\n*Required*: No\n*Type*: [DashEncryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-encryption", "UpdateType": "Mutable", "Required": false, "Type": "DashEncryption" }, "AdTriggers": { "MarkdownDocumentation": "`AdTriggers`\n\nSpecifies 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*: Array of String\n*Allowed values*: `SPLICE_INSERT | BREAK | PRO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-adtriggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Profile": { "MarkdownDocumentation": "`Profile`\n\nThe 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*Allowed values*: `NONE | HBBTV_1_5 | HYBRIDCA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "HBBTV_1_5", "HYBRIDCAST", "DVB_DASH_2014" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-profile", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PeriodTriggers": { "MarkdownDocumentation": "`PeriodTriggers`\n\nControls 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*: Array of String\n*Allowed values*: `ADS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ADS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-periodtriggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SuggestedPresentationDelaySeconds": { "MarkdownDocumentation": "`SuggestedPresentationDelaySeconds`\n\nAmount 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-suggestedpresentationdelayseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UtcTiming": { "MarkdownDocumentation": "`UtcTiming`\n\nDetermines the type of UTC timing included in the DASH Media Presentation Description (MPD).\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTP-XSDATE | HTTP-ISO | HT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HTTP-XSDATE", "HTTP-ISO", "HTTP-HEAD", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-utctiming", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinBufferTimeSeconds": { "MarkdownDocumentation": "`MinBufferTimeSeconds`\n\nMinimum 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-minbuffertimeseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nDuration (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinUpdatePeriodSeconds": { "MarkdownDocumentation": "`MinUpdatePeriodSeconds`\n\nMinimum 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-minupdateperiodseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UtcTimingUri": { "MarkdownDocumentation": "`UtcTimingUri`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html#cfn-mediapackage-originendpoint-dashpackage-utctiminguri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackage::OriginEndpoint.EncryptionContractConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.EncryptionContractConfiguration`\n\nUse `encryptionContractConfiguration` to configure one or more content\nencryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract\ndefines the content keys used to encrypt the audio and video tracks in your stream.\nTo configure the encryption contract, specify which audio and video encryption\npresets to use. For more information about these presets, see [SPEKE Version 2.0 Presets](https://docs.aws.amazon.com/mediapackage/latest/ug/drm-content-speke-v2-presets.html).\nNote the following considerations when using\n`encryptionContractConfiguration`:\n* You can use `encryptionContractConfiguration` for DASH endpoints\n that use SPEKE Version 2.0. SPEKE Version 2.0 relies on the CPIX Version 2.3 specification.\n* You cannot combine an `UNENCRYPTED` preset with\n `UNENCRYPTED` or `SHARED` presets across\n `presetSpeke20Audio` and `presetSpeke20Video`.\n* When you use a `SHARED` preset, you must use it for both\n `presetSpeke20Audio` and `presetSpeke20Video`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-encryptioncontractconfiguration.html", "Properties": {} }, "AWS::MediaPackage::OriginEndpoint.HlsEncryption": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.HlsEncryption`\n\nHolds encryption information so that access to the content can be controlled by a DRM solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsencryption.html", "Properties": { "KeyRotationIntervalSeconds": { "MarkdownDocumentation": "`KeyRotationIntervalSeconds`\n\nNumber 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsencryption.html#cfn-mediapackage-originendpoint-hlsencryption-keyrotationintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RepeatExtXKey": { "MarkdownDocumentation": "`RepeatExtXKey`\n\nRepeat the `EXT-X-KEY` directive for every media segment. This\nmight 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsencryption.html#cfn-mediapackage-originendpoint-hlsencryption-repeatextxkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ConstantInitializationVector": { "MarkdownDocumentation": "`ConstantInitializationVector`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsencryption.html#cfn-mediapackage-originendpoint-hlsencryption-constantinitializationvector", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nParameters for the SPEKE key provider.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsencryption.html#cfn-mediapackage-originendpoint-hlsencryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" }, "EncryptionMethod": { "MarkdownDocumentation": "`EncryptionMethod`\n\nHLS encryption type.\n*Required*: No\n*Type*: String\n*Allowed values*: `AES_128 | SAMPLE_AES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AES_128", "SAMPLE_AES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsencryption.html#cfn-mediapackage-originendpoint-hlsencryption-encryptionmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackage::OriginEndpoint.HlsManifest": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.HlsManifest`\n\nAn HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html", "Properties": { "AdsOnDeliveryRestrictions": { "MarkdownDocumentation": "`AdsOnDeliveryRestrictions`\n\nThe 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*Allowed values*: `NONE | RESTRICTED | UNRESTR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-adsondeliveryrestrictions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nA 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\nmanifestName 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-manifestname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdMarkers": { "MarkdownDocumentation": "`AdMarkers`\n\nControls 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*Allowed values*: `NONE | SCTE35_ENHANCED | PA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SCTE35_ENHANCED", "PASSTHROUGH", "DATERANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-admarkers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProgramDateTimeIntervalSeconds": { "MarkdownDocumentation": "`ProgramDateTimeIntervalSeconds`\n\nInserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify.\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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-programdatetimeintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PlaylistWindowSeconds": { "MarkdownDocumentation": "`PlaylistWindowSeconds`\n\nTime 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-playlistwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IncludeIframeOnlyStream": { "MarkdownDocumentation": "`IncludeIframeOnlyStream`\n\nApplies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-includeiframeonlystream", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PlaylistType": { "MarkdownDocumentation": "`PlaylistType`\n\nWhen specified as either `event` or `vod`, a\ncorresponding `EXT-X-PLAYLIST-TYPE` entry is included in the media playlist.\nIndicates if the playlist is live-to-VOD content.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | EVENT | VOD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "EVENT", "VOD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-playlisttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdTriggers": { "MarkdownDocumentation": "`AdTriggers`\n\nSpecifies 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*: Array of String\n*Allowed values*: `SPLICE_INSERT | BREAK | PRO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-adtriggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html#cfn-mediapackage-originendpoint-hlsmanifest-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackage::OriginEndpoint.HlsPackage": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.HlsPackage`\n\nParameters for Apple HLS packaging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html", "Properties": { "AdsOnDeliveryRestrictions": { "MarkdownDocumentation": "`AdsOnDeliveryRestrictions`\n\nThe 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*Allowed values*: `NONE | RESTRICTED | UNRESTR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "RESTRICTED", "UNRESTRICTED", "BOTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-adsondeliveryrestrictions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdMarkers": { "MarkdownDocumentation": "`AdMarkers`\n\nControls 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*Allowed values*: `NONE | SCTE35_ENHANCED | PA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SCTE35_ENHANCED", "PASSTHROUGH", "DATERANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-admarkers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProgramDateTimeIntervalSeconds": { "MarkdownDocumentation": "`ProgramDateTimeIntervalSeconds`\n\nInserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify.\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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-programdatetimeintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StreamSelection": { "MarkdownDocumentation": "`StreamSelection`\n\nLimitations for outputs from the endpoint, based on the video bitrate.\n*Required*: No\n*Type*: [StreamSelection](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-streamselection", "UpdateType": "Mutable", "Required": false, "Type": "StreamSelection" }, "PlaylistWindowSeconds": { "MarkdownDocumentation": "`PlaylistWindowSeconds`\n\nTime 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-playlistwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IncludeIframeOnlyStream": { "MarkdownDocumentation": "`IncludeIframeOnlyStream`\n\nOnly 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-includeiframeonlystream", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "UseAudioRenditionGroup": { "MarkdownDocumentation": "`UseAudioRenditionGroup`\n\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-useaudiorenditiongroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nDuration (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nParameters for encrypting content.\n*Required*: No\n*Type*: [HlsEncryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-encryption", "UpdateType": "Mutable", "Required": false, "Type": "HlsEncryption" }, "PlaylistType": { "MarkdownDocumentation": "`PlaylistType`\n\nWhen specified as either `event` or `vod`, a corresponding `EXT-X-PLAYLIST-TYPE` entry is included in the media playlist.\nIndicates if the playlist is live-to-VOD content.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | EVENT | VOD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "EVENT", "VOD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-playlisttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdTriggers": { "MarkdownDocumentation": "`AdTriggers`\n\nSpecifies 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*: Array of String\n*Allowed values*: `SPLICE_INSERT | BREAK | PRO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SPLICE_INSERT", "BREAK", "PROVIDER_ADVERTISEMENT", "DISTRIBUTOR_ADVERTISEMENT", "PROVIDER_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-adtriggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IncludeDvbSubtitles": { "MarkdownDocumentation": "`IncludeDvbSubtitles`\n\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlspackage.html#cfn-mediapackage-originendpoint-hlspackage-includedvbsubtitles", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::MediaPackage::OriginEndpoint.MssEncryption": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.MssEncryption`\n\nHolds encryption information so that access to the content can be controlled by a DRM solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-mssencryption.html", "Properties": { "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nParameters for the SPEKE key provider.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-mssencryption.html#cfn-mediapackage-originendpoint-mssencryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" } } }, "AWS::MediaPackage::OriginEndpoint.MssPackage": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.MssPackage`\n\nParameters for Microsoft Smooth Streaming packaging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-msspackage.html", "Properties": { "ManifestWindowSeconds": { "MarkdownDocumentation": "`ManifestWindowSeconds`\n\nTime 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-msspackage.html#cfn-mediapackage-originendpoint-msspackage-manifestwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StreamSelection": { "MarkdownDocumentation": "`StreamSelection`\n\nLimitations for outputs from the endpoint, based on the video bitrate.\n*Required*: No\n*Type*: [StreamSelection](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-msspackage.html#cfn-mediapackage-originendpoint-msspackage-streamselection", "UpdateType": "Mutable", "Required": false, "Type": "StreamSelection" }, "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nDuration (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-msspackage.html#cfn-mediapackage-originendpoint-msspackage-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nParameters for encrypting content.\n*Required*: No\n*Type*: [MssEncryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-msspackage.html#cfn-mediapackage-originendpoint-msspackage-encryption", "UpdateType": "Mutable", "Required": false, "Type": "MssEncryption" } } }, "AWS::MediaPackage::OriginEndpoint.SpekeKeyProvider": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.SpekeKeyProvider`\n\nKey provider settings for DRM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html", "Properties": { "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nUnique 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html#cfn-mediapackage-originendpoint-spekekeyprovider-resourceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SystemIds": { "MarkdownDocumentation": "`SystemIds`\n\nList of unique identifiers for the DRM systems to use, as defined in the CPIX specification.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html#cfn-mediapackage-originendpoint-spekekeyprovider-systemids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EncryptionContractConfiguration": { "MarkdownDocumentation": "`EncryptionContractConfiguration`\n\nUse `encryptionContractConfiguration` to configure one or more content encryption keys for your\nendpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the\naudio 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html#cfn-mediapackage-originendpoint-spekekeyprovider-encryptioncontractconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionContractConfiguration" }, "Url": { "MarkdownDocumentation": "`Url`\n\nURL 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html#cfn-mediapackage-originendpoint-spekekeyprovider-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN for the IAM role that's granted by the key provider to provide\naccess 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\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html#cfn-mediapackage-originendpoint-spekekeyprovider-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html#cfn-mediapackage-originendpoint-spekekeyprovider-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackage::OriginEndpoint.StreamSelection": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint.StreamSelection`\n\nLimitations for outputs from the endpoint, based on the video bitrate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html", "Properties": { "MinVideoBitsPerSecond": { "MarkdownDocumentation": "`MinVideoBitsPerSecond`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html#cfn-mediapackage-originendpoint-streamselection-minvideobitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StreamOrder": { "MarkdownDocumentation": "`StreamOrder`\n\nOrder 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*Allowed values*: `ORIGINAL | VIDEO_BITRATE_AS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html#cfn-mediapackage-originendpoint-streamselection-streamorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxVideoBitsPerSecond": { "MarkdownDocumentation": "`MaxVideoBitsPerSecond`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html#cfn-mediapackage-originendpoint-streamselection-maxvideobitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::MediaPackage::PackagingConfiguration.CmafEncryption": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.CmafEncryption`\n\nHolds encryption information so that access to the content can be controlled by a DRM solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafencryption.html", "Properties": { "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nParameters for the SPEKE key provider.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafencryption.html#cfn-mediapackage-packagingconfiguration-cmafencryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" } } }, "AWS::MediaPackage::PackagingConfiguration.CmafPackage": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.CmafPackage`\n\nParameters for a packaging configuration that uses Common Media Application Format (CMAF) packaging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html", "Properties": { "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nDuration (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html#cfn-mediapackage-packagingconfiguration-cmafpackage-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nParameters for encrypting content.\n*Required*: No\n*Type*: [CmafEncryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html#cfn-mediapackage-packagingconfiguration-cmafpackage-encryption", "UpdateType": "Mutable", "Required": false, "Type": "CmafEncryption" }, "HlsManifests": { "MarkdownDocumentation": "`HlsManifests`\n\nA list of HLS manifest configurations that are available from this endpoint.\n*Required*: Yes\n*Type*: Array of [HlsManifest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html#cfn-mediapackage-packagingconfiguration-cmafpackage-hlsmanifests", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HlsManifest", "DuplicatesAllowed": true }, "IncludeEncoderConfigurationInSegments": { "MarkdownDocumentation": "`IncludeEncoderConfigurationInSegments`\n\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafpackage.html#cfn-mediapackage-packagingconfiguration-cmafpackage-includeencoderconfigurationinsegments", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::MediaPackage::PackagingConfiguration.DashEncryption": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.DashEncryption`\n\nHolds encryption information so that access to the content can be controlled by a DRM solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashencryption.html", "Properties": { "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nParameters for the SPEKE key provider.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashencryption.html#cfn-mediapackage-packagingconfiguration-dashencryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" } } }, "AWS::MediaPackage::PackagingConfiguration.DashManifest": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.DashManifest`\n\nParameters for a DASH manifest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html", "Properties": { "ScteMarkersSource": { "MarkdownDocumentation": "`ScteMarkersSource`\n\nThe 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.\n The MANIFEST value is compatible with source HLS playlists using the SCTE-35 Enhanced syntax (`EXT-OATCLS-SCTE35` tags).\n SCTE-35 Elemental and SCTE-35 Daterange syntaxes are not supported with this option.\n*Required*: No\n*Type*: String\n*Allowed values*: `SEGMENTS | MANIFEST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SEGMENTS", "MANIFEST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-sctemarkerssource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-manifestname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestLayout": { "MarkdownDocumentation": "`ManifestLayout`\n\nDetermines the position of some tags in the Media Presentation Description (MPD). When set to `FULL`, elements like `SegmentTemplate` and\n`ContentProtection` are included in each `Representation`. When set to `COMPACT`, duplicate elements are combined and presented at the\nAdaptationSet level.\n*Required*: No\n*Type*: String\n*Allowed values*: `FULL | COMPACT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FULL", "COMPACT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-manifestlayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StreamSelection": { "MarkdownDocumentation": "`StreamSelection`\n\nLimitations for outputs from the endpoint, based on the video bitrate.\n*Required*: No\n*Type*: [StreamSelection](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-streamselection", "UpdateType": "Mutable", "Required": false, "Type": "StreamSelection" }, "MinBufferTimeSeconds": { "MarkdownDocumentation": "`MinBufferTimeSeconds`\n\nMinimum 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-minbuffertimeseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Profile": { "MarkdownDocumentation": "`Profile`\n\nThe DASH profile type. When set to `HBBTV_1_5`, the content is compliant with HbbTV 1.5.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | HBBTV_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)", "RefReturnValue": "", "AllowedValues": [ "NONE", "HBBTV_1_5" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html#cfn-mediapackage-packagingconfiguration-dashmanifest-profile", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackage::PackagingConfiguration.DashPackage": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.DashPackage`\n\nParameters for a packaging configuration that uses Dynamic Adaptive Streaming over HTTP (DASH) packaging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html", "Properties": { "PeriodTriggers": { "MarkdownDocumentation": "`PeriodTriggers`\n\nControls 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*: Array of String\n*Allowed values*: `ADS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ADS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-periodtriggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IncludeIframeOnlyStream": { "MarkdownDocumentation": "`IncludeIframeOnlyStream`\n\nThis applies only to stream sets with a single video track. When true, the stream set includes an\nadditional 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-includeiframeonlystream", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nDuration (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nParameters for encrypting content.\n*Required*: No\n*Type*: [DashEncryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-encryption", "UpdateType": "Mutable", "Required": false, "Type": "DashEncryption" }, "SegmentTemplateFormat": { "MarkdownDocumentation": "`SegmentTemplateFormat`\n\nDetermines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to `NUMBER_WITH_TIMELINE`, a full timeline is\npresented in each SegmentTemplate, with $Number$ media URLs. When set to `TIME_WITH_TIMELINE`, a full timeline is presented in each\nSegmentTemplate, with $Time$ media URLs. When set to `NUMBER_WITH_DURATION`, only a duration is included in each\nSegmentTemplate, with $Number$ media URLs.\n*Required*: No\n*Type*: String\n*Allowed values*: `NUMBER_WITH_TIMELINE | TIME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NUMBER_WITH_TIMELINE", "TIME_WITH_TIMELINE", "NUMBER_WITH_DURATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-segmenttemplateformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IncludeEncoderConfigurationInSegments": { "MarkdownDocumentation": "`IncludeEncoderConfigurationInSegments`\n\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-includeencoderconfigurationinsegments", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DashManifests": { "MarkdownDocumentation": "`DashManifests`\n\nA list of DASH manifest configurations that are available from this endpoint.\n*Required*: Yes\n*Type*: Array of [DashManifest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html#cfn-mediapackage-packagingconfiguration-dashpackage-dashmanifests", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DashManifest", "DuplicatesAllowed": true } } }, "AWS::MediaPackage::PackagingConfiguration.EncryptionContractConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.EncryptionContractConfiguration`\n\nUse `encryptionContractConfiguration` to configure one or more content\nencryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract\ndefines the content keys used to encrypt the audio and video tracks in your stream.\nTo configure the encryption contract, specify which audio and video encryption\npresets to use. For more information about these presets, see [SPEKE Version 2.0 Presets](https://docs.aws.amazon.com/mediapackage/latest/ug/drm-content-speke-v2-presets.html).\nNote the following considerations when using\n`encryptionContractConfiguration`:\n* You can use `encryptionContractConfiguration` for DASH endpoints\n that use SPEKE Version 2.0. SPEKE Version 2.0 relies on the CPIX Version 2.3 specification.\n* You cannot combine an `UNENCRYPTED` preset with\n `UNENCRYPTED` or `SHARED` presets across\n `presetSpeke20Audio` and `presetSpeke20Video`.\n* When you use a `SHARED` preset, you must use it for both\n `presetSpeke20Audio` and `presetSpeke20Video`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-encryptioncontractconfiguration.html", "Properties": { "PresetSpeke20Audio": { "MarkdownDocumentation": "`PresetSpeke20Audio`\n\nA collection of audio encryption presets.\nValue description:\n* `PRESET-AUDIO-1` - Use one content key to encrypt all of the\n audio tracks in your stream.\n* `PRESET-AUDIO-2` - Use one content key to encrypt all of the\n stereo audio tracks and one content key to encrypt all of the multichannel\n audio tracks.\n* `PRESET-AUDIO-3` - Use one content key to encrypt all of the\n stereo audio tracks, one content key to encrypt all of the multichannel audio\n tracks with 3 to 6 channels, and one content key to encrypt all of the\n multichannel audio tracks with more than 6 channels.\n* `SHARED` - Use the same content key for all of the audio and\n video tracks in your stream.\n* `UNENCRYPTED` - Don't encrypt any of the audio tracks in your\n stream.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRESET-AUDIO-1 | PRESET-AUD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRESET-AUDIO-1", "PRESET-AUDIO-2", "PRESET-AUDIO-3", "SHARED", "UNENCRYPTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-encryptioncontractconfiguration.html#cfn-mediapackage-packagingconfiguration-encryptioncontractconfiguration-presetspeke20audio", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PresetSpeke20Video": { "MarkdownDocumentation": "`PresetSpeke20Video`\n\nA collection of video encryption presets.\nValue description:\n* `PRESET-VIDEO-1` - Use one content key to encrypt all of the video\n tracks in your stream.\n* `PRESET-VIDEO-2` - Use one content key to encrypt all of the SD\n video tracks and one content key for all HD and higher resolutions video\n tracks.\n* `PRESET-VIDEO-3` - Use one content key to encrypt all of the SD\n video tracks, one content key for HD video tracks and one content key for all\n UHD video tracks.\n* `PRESET-VIDEO-4` - Use one content key to encrypt all of the SD\n video tracks, one content key for HD video tracks, one content key for all UHD1\n 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\n video tracks, one content key for HD1 video tracks, one content key for HD2\n video tracks, one content key for all UHD1 video tracks and one content key for\n all UHD2 video tracks.\n* `PRESET-VIDEO-6` - Use one content key to encrypt all of the SD\n video tracks, one content key for HD1 video tracks, one content key for HD2\n 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\n video tracks, one content key for HD2 video tracks and one content key for all\n UHD video tracks.\n* `PRESET-VIDEO-8` - Use one content key to encrypt all of the SD+HD1\n video tracks, one content key for HD2 video tracks, one content key for all\n 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\n tracks in your stream.\n* `UNENCRYPTED` - Don't encrypt any of the video tracks in your\n stream.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRESET-VIDEO-1 | PRESET-VID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRESET-VIDEO-1", "PRESET-VIDEO-2", "PRESET-VIDEO-3", "PRESET-VIDEO-4", "PRESET-VIDEO-5", "PRESET-VIDEO-6", "PRESET-VIDEO-7", "PRESET-VIDEO-8", "SHARED", "UNENCRYPTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-encryptioncontractconfiguration.html#cfn-mediapackage-packagingconfiguration-encryptioncontractconfiguration-presetspeke20video", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackage::PackagingConfiguration.HlsEncryption": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.HlsEncryption`\n\nHolds encryption information so that access to the content can be controlled by a DRM solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsencryption.html", "Properties": { "ConstantInitializationVector": { "MarkdownDocumentation": "`ConstantInitializationVector`\n\nA 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),\nAWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsencryption.html#cfn-mediapackage-packagingconfiguration-hlsencryption-constantinitializationvector", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nParameters for the SPEKE key provider.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsencryption.html#cfn-mediapackage-packagingconfiguration-hlsencryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" }, "EncryptionMethod": { "MarkdownDocumentation": "`EncryptionMethod`\n\nHLS encryption type.\n*Required*: No\n*Type*: String\n*Allowed values*: `AES_128 | SAMPLE_AES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AES_128", "SAMPLE_AES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsencryption.html#cfn-mediapackage-packagingconfiguration-hlsencryption-encryptionmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackage::PackagingConfiguration.HlsManifest": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.HlsManifest`\n\nParameters for an HLS manifest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html", "Properties": { "AdMarkers": { "MarkdownDocumentation": "`AdMarkers`\n\nThis 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*Allowed values*: `NONE | SCTE35_ENHANCED | PA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SCTE35_ENHANCED", "PASSTHROUGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-admarkers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-manifestname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProgramDateTimeIntervalSeconds": { "MarkdownDocumentation": "`ProgramDateTimeIntervalSeconds`\n\nInserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify.\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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-programdatetimeintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StreamSelection": { "MarkdownDocumentation": "`StreamSelection`\n\nVideo bitrate limitations for outputs from this packaging configuration.\n*Required*: No\n*Type*: [StreamSelection](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-streamselection", "UpdateType": "Mutable", "Required": false, "Type": "StreamSelection" }, "RepeatExtXKey": { "MarkdownDocumentation": "`RepeatExtXKey`\n\nRepeat 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-repeatextxkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IncludeIframeOnlyStream": { "MarkdownDocumentation": "`IncludeIframeOnlyStream`\n\nApplies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html#cfn-mediapackage-packagingconfiguration-hlsmanifest-includeiframeonlystream", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::MediaPackage::PackagingConfiguration.HlsPackage": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.HlsPackage`\n\nParameters for a packaging configuration that uses HTTP Live Streaming (HLS) packaging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html", "Properties": { "UseAudioRenditionGroup": { "MarkdownDocumentation": "`UseAudioRenditionGroup`\n\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-useaudiorenditiongroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nDuration (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nParameters for encrypting content.\n*Required*: No\n*Type*: [HlsEncryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-encryption", "UpdateType": "Mutable", "Required": false, "Type": "HlsEncryption" }, "HlsManifests": { "MarkdownDocumentation": "`HlsManifests`\n\nA list of HLS manifest configurations that are available from this endpoint.\n*Required*: Yes\n*Type*: Array of [HlsManifest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-hlsmanifests", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HlsManifest", "DuplicatesAllowed": true }, "IncludeDvbSubtitles": { "MarkdownDocumentation": "`IncludeDvbSubtitles`\n\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html#cfn-mediapackage-packagingconfiguration-hlspackage-includedvbsubtitles", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::MediaPackage::PackagingConfiguration.MssEncryption": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.MssEncryption`\n\nHolds encryption information so that access to the content can be controlled by a DRM solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssencryption.html", "Properties": { "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nParameters for the SPEKE key provider.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssencryption.html#cfn-mediapackage-packagingconfiguration-mssencryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" } } }, "AWS::MediaPackage::PackagingConfiguration.MssManifest": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.MssManifest`\n\nParameters for a Microsoft Smooth manifest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssmanifest.html", "Properties": { "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssmanifest.html#cfn-mediapackage-packagingconfiguration-mssmanifest-manifestname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StreamSelection": { "MarkdownDocumentation": "`StreamSelection`\n\nVideo bitrate limitations for outputs from this packaging configuration.\n*Required*: No\n*Type*: [StreamSelection](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssmanifest.html#cfn-mediapackage-packagingconfiguration-mssmanifest-streamselection", "UpdateType": "Mutable", "Required": false, "Type": "StreamSelection" } } }, "AWS::MediaPackage::PackagingConfiguration.MssPackage": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.MssPackage`\n\nParameters for a packaging configuration that uses Microsoft Smooth Streaming (MSS) packaging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html", "Properties": { "MssManifests": { "MarkdownDocumentation": "`MssManifests`\n\nA list of Microsoft Smooth manifest configurations that are available from this endpoint.\n*Required*: Yes\n*Type*: Array of [MssManifest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html#cfn-mediapackage-packagingconfiguration-msspackage-mssmanifests", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MssManifest", "DuplicatesAllowed": true }, "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nDuration (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html#cfn-mediapackage-packagingconfiguration-msspackage-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nParameters for encrypting content.\n*Required*: No\n*Type*: [MssEncryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html#cfn-mediapackage-packagingconfiguration-msspackage-encryption", "UpdateType": "Mutable", "Required": false, "Type": "MssEncryption" } } }, "AWS::MediaPackage::PackagingConfiguration.SpekeKeyProvider": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.SpekeKeyProvider`\n\nA configuration for accessing an external Secure Packager and Encoder Key Exchange\n(SPEKE) service that provides encryption keys.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html", "Properties": { "SystemIds": { "MarkdownDocumentation": "`SystemIds`\n\nList of unique identifiers for the DRM systems to use, as defined in the CPIX specification.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html#cfn-mediapackage-packagingconfiguration-spekekeyprovider-systemids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EncryptionContractConfiguration": { "MarkdownDocumentation": "`EncryptionContractConfiguration`\n\nUse `encryptionContractConfiguration` to configure one or more content encryption keys for your\nendpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the\naudio 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html#cfn-mediapackage-packagingconfiguration-spekekeyprovider-encryptioncontractconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionContractConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN for the IAM role that's granted by the key provider to provide access\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html#cfn-mediapackage-packagingconfiguration-spekekeyprovider-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nURL 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html#cfn-mediapackage-packagingconfiguration-spekekeyprovider-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackage::PackagingConfiguration.StreamSelection": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration.StreamSelection`\n\nLimitations for outputs from the endpoint, based on the video bitrate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html", "Properties": { "MinVideoBitsPerSecond": { "MarkdownDocumentation": "`MinVideoBitsPerSecond`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html#cfn-mediapackage-packagingconfiguration-streamselection-minvideobitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StreamOrder": { "MarkdownDocumentation": "`StreamOrder`\n\nOrder 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*Allowed values*: `ORIGINAL | VIDEO_BITRATE_AS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html#cfn-mediapackage-packagingconfiguration-streamselection-streamorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxVideoBitsPerSecond": { "MarkdownDocumentation": "`MaxVideoBitsPerSecond`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html#cfn-mediapackage-packagingconfiguration-streamselection-maxvideobitspersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::MediaPackage::PackagingGroup.Authorization": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingGroup.Authorization`\n\nParameters for enabling CDN authorization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packaginggroup-authorization.html", "Properties": { "SecretsRoleArn": { "MarkdownDocumentation": "`SecretsRoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packaginggroup-authorization.html#cfn-mediapackage-packaginggroup-authorization-secretsrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CdnIdentifierSecret": { "MarkdownDocumentation": "`CdnIdentifierSecret`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packaginggroup-authorization.html#cfn-mediapackage-packaginggroup-authorization-cdnidentifiersecret", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackage::PackagingGroup.LogConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingGroup.LogConfiguration`\n\nSets 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packaginggroup-logconfiguration.html", "Properties": { "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nSets 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*Pattern*: `\\A\\/aws\\/MediaPackage\\/[0-9a-zA-Z-_\\/\\.#]+\\Z`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packaginggroup-logconfiguration.html#cfn-mediapackage-packaginggroup-logconfiguration-loggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::Channel.IngestEndpoint": { "MarkdownDocumentation": "`AWS::MediaPackageV2::Channel.IngestEndpoint`\n\nThe input URL where the source stream should be sent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-ingestendpoint.html", "Properties": { "Id": { "MarkdownDocumentation": "`Id`\n\nThe identifier associated with the ingest endpoint of the channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-ingestendpoint.html#cfn-mediapackagev2-channel-ingestendpoint-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL associated with the ingest endpoint of the channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-ingestendpoint.html#cfn-mediapackagev2-channel-ingestendpoint-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::Channel.InputSwitchConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::Channel.InputSwitchConfiguration`\n\nThe configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-inputswitchconfiguration.html", "Properties": { "PreferredInput": { "MarkdownDocumentation": "`PreferredInput`\n\nFor CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select `1` to prefer the first ingest endpoint, or `2` to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-inputswitchconfiguration.html#cfn-mediapackagev2-channel-inputswitchconfiguration-preferredinput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MQCSInputSwitching": { "MarkdownDocumentation": "`MQCSInputSwitching`\n\nWhen true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is false. This setting is valid only when `InputType` is `CMAF`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-inputswitchconfiguration.html#cfn-mediapackagev2-channel-inputswitchconfiguration-mqcsinputswitching", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::MediaPackageV2::Channel.OutputHeaderConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::Channel.OutputHeaderConfiguration`\n\nThe settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-outputheaderconfiguration.html", "Properties": { "PublishMQCS": { "MarkdownDocumentation": "`PublishMQCS`\n\nWhen true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when `InputType` is `CMAF`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-channel-outputheaderconfiguration.html#cfn-mediapackagev2-channel-outputheaderconfiguration-publishmqcs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::MediaPackageV2::OriginEndpoint.DashBaseUrl": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashBaseUrl`\n\nThe base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashbaseurl.html", "Properties": { "ServiceLocation": { "MarkdownDocumentation": "`ServiceLocation`\n\nThe name of the source location.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashbaseurl.html#cfn-mediapackagev2-originendpoint-dashbaseurl-servicelocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DvbWeight": { "MarkdownDocumentation": "`DvbWeight`\n\nFor use with DVB-DASH profiles only. The weighting for source locations that have the same priority.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `15000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashbaseurl.html#cfn-mediapackagev2-originendpoint-dashbaseurl-dvbweight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DvbPriority": { "MarkdownDocumentation": "`DvbPriority`\n\nFor use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `15000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashbaseurl.html#cfn-mediapackagev2-originendpoint-dashbaseurl-dvbpriority", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Url": { "MarkdownDocumentation": "`Url`\n\nA source location for segments.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashbaseurl.html#cfn-mediapackagev2-originendpoint-dashbaseurl-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.DashDvbFontDownload": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashDvbFontDownload`\n\nFor use with DVB-DASH profiles only. The settings for font downloads that you want AWS Elemental MediaPackage to pass through to the manifest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbfontdownload.html", "Properties": { "FontFamily": { "MarkdownDocumentation": "`FontFamily`\n\nThe `fontFamily` name for subtitles, as described in [EBU-TT-D Subtitling Distribution Format](https://tech.ebu.ch/publications/tech3380).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbfontdownload.html#cfn-mediapackagev2-originendpoint-dashdvbfontdownload-fontfamily", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL for downloading fonts for subtitles.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbfontdownload.html#cfn-mediapackagev2-originendpoint-dashdvbfontdownload-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MimeType": { "MarkdownDocumentation": "`MimeType`\n\nThe `mimeType` of the resource that's at the font download URL.\nFor information about font MIME types, see the [MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks](https://dvb.org/wp-content/uploads/2021/06/A168r4_MPEG-DASH-Profile-for-Transport-of-ISO-BMFF-Based-DVB-Services_Draft-ts_103-285-v140_November_2021.pdf) document.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_/-]*[a-zA-Z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbfontdownload.html#cfn-mediapackagev2-originendpoint-dashdvbfontdownload-mimetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.DashDvbMetricsReporting": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashDvbMetricsReporting`\n\nFor use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want AWS Elemental MediaPackage to pass through to the manifest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbmetricsreporting.html", "Properties": { "ReportingUrl": { "MarkdownDocumentation": "`ReportingUrl`\n\nThe URL where playback devices send error reports.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbmetricsreporting.html#cfn-mediapackagev2-originendpoint-dashdvbmetricsreporting-reportingurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Probability": { "MarkdownDocumentation": "`Probability`\n\nThe number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbmetricsreporting.html#cfn-mediapackagev2-originendpoint-dashdvbmetricsreporting-probability", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::MediaPackageV2::OriginEndpoint.DashDvbSettings": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashDvbSettings`\n\nFor endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbsettings.html", "Properties": { "FontDownload": { "MarkdownDocumentation": "`FontDownload`\n\nSubtitle font settings.\n*Required*: No\n*Type*: [DashDvbFontDownload](./aws-properties-mediapackagev2-originendpoint-dashdvbfontdownload.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbsettings.html#cfn-mediapackagev2-originendpoint-dashdvbsettings-fontdownload", "UpdateType": "Mutable", "Required": false, "Type": "DashDvbFontDownload" }, "ErrorMetrics": { "MarkdownDocumentation": "`ErrorMetrics`\n\nPlayback device error reporting settings.\n*Required*: No\n*Type*: Array of [DashDvbMetricsReporting](./aws-properties-mediapackagev2-originendpoint-dashdvbmetricsreporting.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashdvbsettings.html#cfn-mediapackagev2-originendpoint-dashdvbsettings-errormetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DashDvbMetricsReporting", "DuplicatesAllowed": true } } }, "AWS::MediaPackageV2::OriginEndpoint.DashManifestConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashManifestConfiguration`\n\nThe DASH manifest configuration associated with the origin endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html", "Properties": { "ManifestWindowSeconds": { "MarkdownDocumentation": "`ManifestWindowSeconds`\n\nThe total duration (in seconds) of the manifest's content.\n*Required*: No\n*Type*: Integer\n*Minimum*: `30`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-manifestwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DrmSignaling": { "MarkdownDocumentation": "`DrmSignaling`\n\nDetermines how the DASH manifest signals the DRM content.\n*Required*: No\n*Type*: String\n*Allowed values*: `INDIVIDUAL | REFERENCED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INDIVIDUAL", "REFERENCED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-drmsignaling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Compactness": { "MarkdownDocumentation": "`Compactness`\n\nThe layout of the DASH manifest that MediaPackage produces. `STANDARD` indicates a default manifest, which is compacted. `NONE` indicates a full manifest.\nFor information about compactness, see [DASH manifest compactness](https://docs.aws.amazon.com/mediapackage/latest/userguide/compacted.html) in the *AWS Elemental MediaPackage v2 User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-compactness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProgramInformation": { "MarkdownDocumentation": "`ProgramInformation`\n\nDetails about the content that you want MediaPackage to pass through in the manifest to the playback device.\n*Required*: No\n*Type*: [DashProgramInformation](./aws-properties-mediapackagev2-originendpoint-dashprograminformation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-programinformation", "UpdateType": "Mutable", "Required": false, "Type": "DashProgramInformation" }, "FilterConfiguration": { "MarkdownDocumentation": "`FilterConfiguration`\n\nFilter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.\n*Required*: No\n*Type*: [FilterConfiguration](./aws-properties-mediapackagev2-originendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-filterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilterConfiguration" }, "SegmentTemplateFormat": { "MarkdownDocumentation": "`SegmentTemplateFormat`\n\nDetermines 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`.\nValue description:\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*Required*: No\n*Type*: String\n*Allowed values*: `NUMBER_WITH_TIMELINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NUMBER_WITH_TIMELINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-segmenttemplateformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseUrls": { "MarkdownDocumentation": "`BaseUrls`\n\nThe base URLs to use for retrieving segments.\n*Required*: No\n*Type*: Array of [DashBaseUrl](./aws-properties-mediapackagev2-originendpoint-dashbaseurl.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-baseurls", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DashBaseUrl", "DuplicatesAllowed": true }, "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nA short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-manifestname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PeriodTriggers": { "MarkdownDocumentation": "`PeriodTriggers`\n\nA list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type `ADS` to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period.\nFor more information about periods in the DASH manifest, see [Multi-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html).\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-periodtriggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SuggestedPresentationDelaySeconds": { "MarkdownDocumentation": "`SuggestedPresentationDelaySeconds`\n\nThe amount of time (in seconds) that the player should be from the end of the manifest.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-suggestedpresentationdelayseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UtcTiming": { "MarkdownDocumentation": "`UtcTiming`\n\nDetermines the type of UTC timing included in the DASH Media Presentation Description (MPD).\n*Required*: No\n*Type*: [DashUtcTiming](./aws-properties-mediapackagev2-originendpoint-dashutctiming.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-utctiming", "UpdateType": "Mutable", "Required": false, "Type": "DashUtcTiming" }, "SubtitleConfiguration": { "MarkdownDocumentation": "`SubtitleConfiguration`\n\nThe configuration for DASH subtitles.\n*Required*: No\n*Type*: [DashSubtitleConfiguration](./aws-properties-mediapackagev2-originendpoint-dashsubtitleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-subtitleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DashSubtitleConfiguration" }, "MinBufferTimeSeconds": { "MarkdownDocumentation": "`MinBufferTimeSeconds`\n\nMinimum amount of content (in seconds) that a player must keep available in the buffer.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-minbuffertimeseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Profiles": { "MarkdownDocumentation": "`Profiles`\n\nThe profile that the output is compliant with.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-profiles", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DvbSettings": { "MarkdownDocumentation": "`DvbSettings`\n\nFor endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.\n*Required*: No\n*Type*: [DashDvbSettings](./aws-properties-mediapackagev2-originendpoint-dashdvbsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-dvbsettings", "UpdateType": "Mutable", "Required": false, "Type": "DashDvbSettings" }, "MinUpdatePeriodSeconds": { "MarkdownDocumentation": "`MinUpdatePeriodSeconds`\n\nMinimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-minupdateperiodseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ScteDash": { "MarkdownDocumentation": "`ScteDash`\n\nThe SCTE configuration.\n*Required*: No\n*Type*: [ScteDash](./aws-properties-mediapackagev2-originendpoint-sctedash.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-dashmanifestconfiguration-sctedash", "UpdateType": "Mutable", "Required": false, "Type": "ScteDash" } } }, "AWS::MediaPackageV2::OriginEndpoint.DashProgramInformation": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashProgramInformation`\n\nDetails about the content that you want MediaPackage to pass through in the manifest to the playback device.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashprograminformation.html", "Properties": { "Copyright": { "MarkdownDocumentation": "`Copyright`\n\nA copyright statement about the content.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashprograminformation.html#cfn-mediapackagev2-originendpoint-dashprograminformation-copyright", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LanguageCode": { "MarkdownDocumentation": "`LanguageCode`\n\nThe language code for this manifest.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$`\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashprograminformation.html#cfn-mediapackagev2-originendpoint-dashprograminformation-languagecode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title for the manifest.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashprograminformation.html#cfn-mediapackagev2-originendpoint-dashprograminformation-title", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MoreInformationUrl": { "MarkdownDocumentation": "`MoreInformationUrl`\n\nAn absolute URL that contains more information about this content.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashprograminformation.html#cfn-mediapackagev2-originendpoint-dashprograminformation-moreinformationurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nInformation about the content provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashprograminformation.html#cfn-mediapackagev2-originendpoint-dashprograminformation-source", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.DashSubtitleConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashSubtitleConfiguration`\n\nThe configuration for DASH subtitles.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashsubtitleconfiguration.html", "Properties": { "TtmlConfiguration": { "MarkdownDocumentation": "`TtmlConfiguration`\n\nSettings for TTML subtitles.\n*Required*: No\n*Type*: [DashTtmlConfiguration](./aws-properties-mediapackagev2-originendpoint-dashttmlconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashsubtitleconfiguration.html#cfn-mediapackagev2-originendpoint-dashsubtitleconfiguration-ttmlconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DashTtmlConfiguration" } } }, "AWS::MediaPackageV2::OriginEndpoint.DashTtmlConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashTtmlConfiguration`\n\nThe settings for TTML subtitles.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashttmlconfiguration.html", "Properties": { "TtmlProfile": { "MarkdownDocumentation": "`TtmlProfile`\n\nThe profile that MediaPackage uses when signaling subtitles in the manifest. `IMSC` is the default profile.\n`EBU-TT-D` produces subtitles that are compliant with the EBU-TT-D TTML profile.\nMediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see [EBU-TT-D Subtitling Distribution Format](https://tech.ebu.ch/publications/tech3380).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IMSC_1 | EBU_TT_D_101...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IMSC_1", "EBU_TT_D_101" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashttmlconfiguration.html#cfn-mediapackagev2-originendpoint-dashttmlconfiguration-ttmlprofile", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.DashUtcTiming": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.DashUtcTiming`\n\nDetermines the type of UTC timing included in the DASH Media Presentation Description (MPD).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashutctiming.html", "Properties": { "TimingMode": { "MarkdownDocumentation": "`TimingMode`\n\nThe UTC timing mode.\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTP_HEAD | HTTP_ISO | HTTP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HTTP_HEAD", "HTTP_ISO", "HTTP_XSDATE", "UTC_DIRECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashutctiming.html#cfn-mediapackagev2-originendpoint-dashutctiming-timingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimingSource": { "MarkdownDocumentation": "`TimingSource`\n\nThe the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-dashutctiming.html#cfn-mediapackagev2-originendpoint-dashutctiming-timingsource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.Encryption": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.Encryption`\n\nThe parameters for encrypting content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html", "Properties": { "KeyRotationIntervalSeconds": { "MarkdownDocumentation": "`KeyRotationIntervalSeconds`\n\nThe interval, in seconds, to rotate encryption keys for the origin endpoint.\n*Required*: No\n*Type*: Integer\n*Minimum*: `300`\n*Maximum*: `31536000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-keyrotationintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CmafExcludeSegmentDrmMetadata": { "MarkdownDocumentation": "`CmafExcludeSegmentDrmMetadata`\n\nExcludes SEIG and SGPD boxes from segment metadata in CMAF containers.\nWhen set to `true`, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.\nImportant considerations:\n* This setting only affects CMAF container formats\n* Key rotation can still be handled through media playlist signaling\n* PSSH and TENC boxes remain unaffected\n* Default behavior is preserved when this setting is disabled\nValid values: `true` | `false`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-cmafexcludesegmentdrmmetadata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ConstantInitializationVector": { "MarkdownDocumentation": "`ConstantInitializationVector`\n\nA 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-fA-F]+$`\n*Minimum*: `32`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-constantinitializationvector", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpekeKeyProvider": { "MarkdownDocumentation": "`SpekeKeyProvider`\n\nThe SPEKE key provider to use for encryption.\n*Required*: Yes\n*Type*: [SpekeKeyProvider](./aws-properties-mediapackagev2-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-spekekeyprovider", "UpdateType": "Mutable", "Required": true, "Type": "SpekeKeyProvider" }, "EncryptionMethod": { "MarkdownDocumentation": "`EncryptionMethod`\n\nThe encryption method to use.\n*Required*: Yes\n*Type*: [EncryptionMethod](./aws-properties-mediapackagev2-originendpoint-encryptionmethod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html#cfn-mediapackagev2-originendpoint-encryption-encryptionmethod", "UpdateType": "Mutable", "Required": true, "Type": "EncryptionMethod" } } }, "AWS::MediaPackageV2::OriginEndpoint.EncryptionContractConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.EncryptionContractConfiguration`\n\nUse `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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptioncontractconfiguration.html", "Properties": { "PresetSpeke20Audio": { "MarkdownDocumentation": "`PresetSpeke20Audio`\n\nA 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*Allowed values*: `PRESET_AUDIO_1 | PRESET_AUD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRESET_AUDIO_1", "PRESET_AUDIO_2", "PRESET_AUDIO_3", "SHARED", "UNENCRYPTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptioncontractconfiguration.html#cfn-mediapackagev2-originendpoint-encryptioncontractconfiguration-presetspeke20audio", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PresetSpeke20Video": { "MarkdownDocumentation": "`PresetSpeke20Video`\n\nThe SPEKE Version 2.0 preset video associated with the encryption contract configuration of the origin endpoint.\nA 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*Allowed values*: `PRESET_VIDEO_1 | PRESET_VID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRESET_VIDEO_1", "PRESET_VIDEO_2", "PRESET_VIDEO_3", "PRESET_VIDEO_4", "PRESET_VIDEO_5", "PRESET_VIDEO_6", "PRESET_VIDEO_7", "PRESET_VIDEO_8", "SHARED", "UNENCRYPTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptioncontractconfiguration.html#cfn-mediapackagev2-originendpoint-encryptioncontractconfiguration-presetspeke20video", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.EncryptionMethod": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.EncryptionMethod`\n\nThe encryption method associated with the origin endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html", "Properties": { "IsmEncryptionMethod": { "MarkdownDocumentation": "`IsmEncryptionMethod`\n\nThe encryption method used for Microsoft Smooth Streaming (MSS) content. This specifies how the MSS segments are encrypted to protect the content during delivery to client players.\n*Required*: No\n*Type*: String\n*Allowed values*: `CENC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "CENC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html#cfn-mediapackagev2-originendpoint-encryptionmethod-ismencryptionmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CmafEncryptionMethod": { "MarkdownDocumentation": "`CmafEncryptionMethod`\n\nThe encryption method to use.\n*Required*: No\n*Type*: String\n*Allowed values*: `CENC | CBCS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CENC", "CBCS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html#cfn-mediapackagev2-originendpoint-encryptionmethod-cmafencryptionmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TsEncryptionMethod": { "MarkdownDocumentation": "`TsEncryptionMethod`\n\nThe encryption method to use.\n*Required*: No\n*Type*: String\n*Allowed values*: `AES_128 | SAMPLE_AES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AES_128", "SAMPLE_AES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryptionmethod.html#cfn-mediapackagev2-originendpoint-encryptionmethod-tsencryptionmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.FilterConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.FilterConfiguration`\n\nFilter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html", "Properties": { "Start": { "MarkdownDocumentation": "`Start`\n\nOptionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-start", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "End": { "MarkdownDocumentation": "`End`\n\nOptionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-end", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimeDelaySeconds": { "MarkdownDocumentation": "`TimeDelaySeconds`\n\nOptionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `1209600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-timedelayseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ClipStartTime": { "MarkdownDocumentation": "`ClipStartTime`\n\nOptionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-clipstarttime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestFilter": { "MarkdownDocumentation": "`ManifestFilter`\n\nOptionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-filterconfiguration.html#cfn-mediapackagev2-originendpoint-filterconfiguration-manifestfilter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.ForceEndpointErrorConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.ForceEndpointErrorConfiguration`\n\nThe failover settings for the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-forceendpointerrorconfiguration.html", "Properties": { "EndpointErrorConditions": { "MarkdownDocumentation": "`EndpointErrorConditions`\n\nThe failover conditions for the endpoint. The options are:\n* `STALE_MANIFEST` - The manifest stalled and there are no new segments or parts.\n* `INCOMPLETE_MANIFEST` - There is a gap in the manifest.\n* `MISSING_DRM_KEY` - Key rotation is enabled but we're unable to fetch the key for the current key period.\n* `SLATE_INPUT` - The segments which contain slate content are considered to be missing content.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-forceendpointerrorconfiguration.html#cfn-mediapackagev2-originendpoint-forceendpointerrorconfiguration-endpointerrorconditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::MediaPackageV2::OriginEndpoint.HlsManifestConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.HlsManifestConfiguration`\n\nThe HLS manifest configuration associated with the origin endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html", "Properties": { "ManifestWindowSeconds": { "MarkdownDocumentation": "`ManifestWindowSeconds`\n\nThe duration of the manifest window, in seconds, for the HLS manifest configuration.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-manifestwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nThe name of the manifest associated with the HLS manifest configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-manifestname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProgramDateTimeIntervalSeconds": { "MarkdownDocumentation": "`ProgramDateTimeIntervalSeconds`\n\nThe `EXT-X-PROGRAM-DATE-TIME` interval, in seconds, associated with the HLS manifest configuration.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-programdatetimeintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ChildManifestName": { "MarkdownDocumentation": "`ChildManifestName`\n\nThe name of the child manifest associated with the HLS manifest configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-childmanifestname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScteHls": { "MarkdownDocumentation": "`ScteHls`\n\nTHE SCTE-35 HLS configuration associated with the HLS manifest configuration.\n*Required*: No\n*Type*: [ScteHls](./aws-properties-mediapackagev2-originendpoint-sctehls.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-sctehls", "UpdateType": "Mutable", "Required": false, "Type": "ScteHls" }, "FilterConfiguration": { "MarkdownDocumentation": "`FilterConfiguration`\n\nFilter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.\n*Required*: No\n*Type*: [FilterConfiguration](./aws-properties-mediapackagev2-originendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-filterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilterConfiguration" }, "UrlEncodeChildManifest": { "MarkdownDocumentation": "`UrlEncodeChildManifest`\n\nWhen enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol.\nFor more information, see [AWS Signature Version 4 for API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) in *AWS Identity and Access Management 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-urlencodechildmanifest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL of the HLS manifest 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartTag": { "MarkdownDocumentation": "`StartTag`\n\nTo insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.\n*Required*: No\n*Type*: [StartTag](./aws-properties-mediapackagev2-originendpoint-starttag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-hlsmanifestconfiguration-starttag", "UpdateType": "Mutable", "Required": false, "Type": "StartTag" } } }, "AWS::MediaPackageV2::OriginEndpoint.LowLatencyHlsManifestConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.LowLatencyHlsManifestConfiguration`\n\nSpecify a low-latency HTTP live streaming (LL-HLS) manifest configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html", "Properties": { "ManifestWindowSeconds": { "MarkdownDocumentation": "`ManifestWindowSeconds`\n\nThe total duration (in seconds) of the manifest's content.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-manifestwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nA short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, `index`. MediaPackage automatically inserts the format extension, such as `.m3u8`. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The `manifestName` on the `HLSManifest` object overrides the `manifestName` you provided on the `originEndpoint` object.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-manifestname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProgramDateTimeIntervalSeconds": { "MarkdownDocumentation": "`ProgramDateTimeIntervalSeconds`\n\nInserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify. If you don't enter an interval, `EXT-X-PROGRAM-DATE-TIME` tags aren't included in the manifest.\nThe tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\nIrrespective of this parameter, if any `ID3Timed` metadata is in the HLS input, MediaPackage passes through that metadata to the HLS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-programdatetimeintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ChildManifestName": { "MarkdownDocumentation": "`ChildManifestName`\n\nThe name of the child manifest associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-childmanifestname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScteHls": { "MarkdownDocumentation": "`ScteHls`\n\nThe SCTE-35 HLS configuration associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.\n*Required*: No\n*Type*: [ScteHls](./aws-properties-mediapackagev2-originendpoint-sctehls.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-sctehls", "UpdateType": "Mutable", "Required": false, "Type": "ScteHls" }, "FilterConfiguration": { "MarkdownDocumentation": "`FilterConfiguration`\n\nFilter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.\n*Required*: No\n*Type*: [FilterConfiguration](./aws-properties-mediapackagev2-originendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-filterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilterConfiguration" }, "UrlEncodeChildManifest": { "MarkdownDocumentation": "`UrlEncodeChildManifest`\n\nWhen enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol.\nFor more information, see [AWS Signature Version 4 for API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) in *AWS Identity and Access Management 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-urlencodechildmanifest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL of the low-latency HLS (LL-HLS) manifest configuration of the origin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartTag": { "MarkdownDocumentation": "`StartTag`\n\nTo insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.\n*Required*: No\n*Type*: [StartTag](./aws-properties-mediapackagev2-originendpoint-starttag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration-starttag", "UpdateType": "Mutable", "Required": false, "Type": "StartTag" } } }, "AWS::MediaPackageV2::OriginEndpoint.MssManifestConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.MssManifestConfiguration`\n\nThe `MssManifestConfiguration` property type specifies Property description not available. for an [AWS::MediaPackageV2::OriginEndpoint](./aws-resource-mediapackagev2-originendpoint.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html", "Properties": { "ManifestWindowSeconds": { "MarkdownDocumentation": "`ManifestWindowSeconds`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-mssmanifestconfiguration-manifestwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-mssmanifestconfiguration-manifestname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ManifestLayout": { "MarkdownDocumentation": "`ManifestLayout`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `FULL | COMPACT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FULL", "COMPACT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-mssmanifestconfiguration-manifestlayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FilterConfiguration": { "MarkdownDocumentation": "`FilterConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [FilterConfiguration](./aws-properties-mediapackagev2-originendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html#cfn-mediapackagev2-originendpoint-mssmanifestconfiguration-filterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilterConfiguration" } } }, "AWS::MediaPackageV2::OriginEndpoint.Scte": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.Scte`\n\nThe SCTE-35 configuration associated with the origin endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-scte.html", "Properties": { "ScteFilter": { "MarkdownDocumentation": "`ScteFilter`\n\nThe filter associated with the SCTE-35 configuration.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-scte.html#cfn-mediapackagev2-originendpoint-scte-sctefilter", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::MediaPackageV2::OriginEndpoint.ScteDash": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.ScteDash`\n\nThe SCTE configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-sctedash.html", "Properties": { "AdMarkerDash": { "MarkdownDocumentation": "`AdMarkerDash`\n\nChoose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.\nValue description:\n* `Binary` - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.\n* `XML` - The SCTE marker is expressed fully in XML.\n*Required*: No\n*Type*: String\n*Allowed values*: `BINARY | XML...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BINARY", "XML" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-sctedash.html#cfn-mediapackagev2-originendpoint-sctedash-admarkerdash", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.ScteHls": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.ScteHls`\n\nThe SCTE-35 HLS configuration associated with the origin endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-sctehls.html", "Properties": { "AdMarkerHls": { "MarkdownDocumentation": "`AdMarkerHls`\n\nThe SCTE-35 HLS ad-marker configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `DATERANGE | SCTE35_ENHANCED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DATERANGE", "SCTE35_ENHANCED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-sctehls.html#cfn-mediapackagev2-originendpoint-sctehls-admarkerhls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.Segment": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.Segment`\n\nThe segment configuration, including the segment name, duration, and other configuration values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html", "Properties": { "SegmentName": { "MarkdownDocumentation": "`SegmentName`\n\nThe name of the segment associated with the origin endpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-segmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TsUseAudioRenditionGroup": { "MarkdownDocumentation": "`TsUseAudioRenditionGroup`\n\nWhether the segment is an audio rendition 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-tsuseaudiorenditiongroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IncludeIframeOnlyStreams": { "MarkdownDocumentation": "`IncludeIframeOnlyStreams`\n\nWhether the segment includes I-frame-only streams.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-includeiframeonlystreams", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Scte": { "MarkdownDocumentation": "`Scte`\n\nThe SCTE-35 configuration associated with the segment.\n*Required*: No\n*Type*: [Scte](./aws-properties-mediapackagev2-originendpoint-scte.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-scte", "UpdateType": "Mutable", "Required": false, "Type": "Scte" }, "TsIncludeDvbSubtitles": { "MarkdownDocumentation": "`TsIncludeDvbSubtitles`\n\nWhether the segment includes DVB subtitles.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-tsincludedvbsubtitles", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SegmentDurationSeconds": { "MarkdownDocumentation": "`SegmentDurationSeconds`\n\nThe duration of the segment, in seconds.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-segmentdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nWhether to use encryption for the segment.\n*Required*: No\n*Type*: [Encryption](./aws-properties-mediapackagev2-originendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-segment.html#cfn-mediapackagev2-originendpoint-segment-encryption", "UpdateType": "Mutable", "Required": false, "Type": "Encryption" } } }, "AWS::MediaPackageV2::OriginEndpoint.SpekeKeyProvider": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.SpekeKeyProvider`\n\nThe parameters for the SPEKE key provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html", "Properties": { "DrmSystems": { "MarkdownDocumentation": "`DrmSystems`\n\nThe DRM solution provider you're using to protect your content during distribution.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-drmsystems", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe unique identifier for the content. The service sends this identifier to the key server to identify the current endpoint. How unique you make this identifier depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.\nThe following example shows a resource ID: `MovieNight20171126093045`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-resourceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EncryptionContractConfiguration": { "MarkdownDocumentation": "`EncryptionContractConfiguration`\n\nThe encryption contract configuration associated with the SPEKE key provider.\n*Required*: Yes\n*Type*: [EncryptionContractConfiguration](./aws-properties-mediapackagev2-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-encryptioncontractconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "EncryptionContractConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.\nValid format: `arn:aws:iam::{accountID}:role/{name}`. The following example shows a role ARN: `arn:aws:iam::444455556666:role/SpekeAccess`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL of the SPEKE key provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-spekekeyprovider.html#cfn-mediapackagev2-originendpoint-spekekeyprovider-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint.StartTag": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint.StartTag`\n\nTo insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-starttag.html", "Properties": { "Precise": { "MarkdownDocumentation": "`Precise`\n\nSpecify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-starttag.html#cfn-mediapackagev2-originendpoint-starttag-precise", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TimeOffset": { "MarkdownDocumentation": "`TimeOffset`\n\nSpecify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-starttag.html#cfn-mediapackagev2-originendpoint-starttag-timeoffset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::MediaPackageV2::OriginEndpointPolicy.CdnAuthConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpointPolicy.CdnAuthConfiguration`\n\nThe settings to enable CDN authorization headers in MediaPackage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration.html", "Properties": { "SecretsRoleArn": { "MarkdownDocumentation": "`SecretsRoleArn`\n\nThe ARN for the IAM role that gives MediaPackage read access to Secrets Manager and AWS KMS for CDN authorization.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration.html#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration-secretsrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CdnIdentifierSecretArns": { "MarkdownDocumentation": "`CdnIdentifierSecretArns`\n\nThe ARN for the secret in Secrets Manager that your CDN uses for authorization to access the endpoint.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `20 | 1`\n*Maximum*: `2048 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration.html#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration-cdnidentifiersecretarns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::MediaTailor::Channel.DashPlaylistSettings": { "MarkdownDocumentation": "`AWS::MediaTailor::Channel.DashPlaylistSettings`\n\nDash manifest configuration parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html", "Properties": { "ManifestWindowSeconds": { "MarkdownDocumentation": "`ManifestWindowSeconds`\n\nThe total duration (in seconds) of each manifest. Minimum value: `30` seconds. Maximum value: `3600` seconds.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-manifestwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "SuggestedPresentationDelaySeconds": { "MarkdownDocumentation": "`SuggestedPresentationDelaySeconds`\n\nAmount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: `2` seconds. Maximum value: `60` seconds.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-suggestedpresentationdelayseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MinBufferTimeSeconds": { "MarkdownDocumentation": "`MinBufferTimeSeconds`\n\nMinimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: `2` seconds. Maximum value: `60` seconds.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minbuffertimeseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MinUpdatePeriodSeconds": { "MarkdownDocumentation": "`MinUpdatePeriodSeconds`\n\nMinimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: `2` seconds. Maximum value: `60` seconds.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minupdateperiodseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::MediaTailor::Channel.HlsPlaylistSettings": { "MarkdownDocumentation": "`AWS::MediaTailor::Channel.HlsPlaylistSettings`\n\nHLS playlist configuration parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html", "Properties": { "ManifestWindowSeconds": { "MarkdownDocumentation": "`ManifestWindowSeconds`\n\nThe total duration (in seconds) of each manifest. Minimum value: `30` seconds. Maximum value: `3600` seconds.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-manifestwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "AdMarkupType": { "MarkdownDocumentation": "`AdMarkupType`\n\nDetermines the type of SCTE 35 tags to use in ad markup. Specify `DATERANGE` to use `DATERANGE` tags (for live or VOD content). Specify `SCTE35_ENHANCED` to use `EXT-X-CUE-OUT` and `EXT-X-CUE-IN` tags (for VOD content only).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-admarkuptype", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::MediaTailor::Channel.LogConfigurationForChannel": { "MarkdownDocumentation": "`AWS::MediaTailor::Channel.LogConfigurationForChannel`\n\nThe log configuration for the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.html", "Properties": { "LogTypes": { "MarkdownDocumentation": "`LogTypes`\n\nThe log types.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.html#cfn-mediatailor-channel-logconfigurationforchannel-logtypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::MediaTailor::Channel.RequestOutputItem": { "MarkdownDocumentation": "`AWS::MediaTailor::Channel.RequestOutputItem`\n\nThe output configuration for this channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html", "Properties": { "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nThe name of the manifest for the channel. The name appears in the `PlaybackUrl`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-manifestname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DashPlaylistSettings": { "MarkdownDocumentation": "`DashPlaylistSettings`\n\nDASH manifest configuration parameters.\n*Required*: No\n*Type*: [DashPlaylistSettings](./aws-properties-mediatailor-channel-dashplaylistsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-dashplaylistsettings", "UpdateType": "Mutable", "Required": false, "Type": "DashPlaylistSettings" }, "HlsPlaylistSettings": { "MarkdownDocumentation": "`HlsPlaylistSettings`\n\nHLS playlist configuration parameters.\n*Required*: No\n*Type*: [HlsPlaylistSettings](./aws-properties-mediatailor-channel-hlsplaylistsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-hlsplaylistsettings", "UpdateType": "Mutable", "Required": false, "Type": "HlsPlaylistSettings" }, "SourceGroup": { "MarkdownDocumentation": "`SourceGroup`\n\nA string used to match which `HttpPackageConfiguration` is used for each `VodSource`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-sourcegroup", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaTailor::Channel.SlateSource": { "MarkdownDocumentation": "`AWS::MediaTailor::Channel.SlateSource`\n\nSlate VOD source configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html", "Properties": { "VodSourceName": { "MarkdownDocumentation": "`VodSourceName`\n\nThe slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html#cfn-mediatailor-channel-slatesource-vodsourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceLocationName": { "MarkdownDocumentation": "`SourceLocationName`\n\nThe name of the source location where the slate VOD source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html#cfn-mediatailor-channel-slatesource-sourcelocationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::Channel.TimeShiftConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::Channel.TimeShiftConfiguration`\n\nThe configuration for time-shifted viewing.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-timeshiftconfiguration.html", "Properties": { "MaxTimeDelaySeconds": { "MarkdownDocumentation": "`MaxTimeDelaySeconds`\n\nThe maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds,\nand the maximum allowed maximum time delay is 21600 seconds (6 hours).\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-timeshiftconfiguration.html#cfn-mediatailor-channel-timeshiftconfiguration-maxtimedelayseconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::MediaTailor::LiveSource.HttpPackageConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::LiveSource.HttpPackageConfiguration`\n\nThe HTTP package configuration properties for the requested VOD source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe relative path to the URL for this VOD source. This is combined with `SourceLocation::HttpConfiguration::BaseUrl` to form a valid URL.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-path", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe streaming protocol for this package configuration. Supported values are `HLS` and `DASH`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DASH | HLS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DASH", "HLS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceGroup": { "MarkdownDocumentation": "`SourceGroup`\n\nThe name of the source group. This has to match one of the `Channel::Outputs::SourceGroup`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-sourcegroup", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaTailor::PlaybackConfiguration.AdConditioningConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.AdConditioningConfiguration`\n\nThe setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adconditioningconfiguration.html", "Properties": { "StreamingMediaFileConditioning": { "MarkdownDocumentation": "`StreamingMediaFileConditioning`\n\nFor ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS.\n`TRANSCODE` indicates that MediaTailor must transcode the ads.\n`NONE` indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow.\nFor more information about ad conditioning see [Using preconditioned ads](https://docs.aws.amazon.com/mediatailor/latest/ug/precondition-ads.html) in the AWS Elemental MediaTailor user guide.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TRANSCODE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TRANSCODE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adconditioningconfiguration.html#cfn-mediatailor-playbackconfiguration-adconditioningconfiguration-streamingmediafileconditioning", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaTailor::PlaybackConfiguration.AdDecisionServerConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.AdDecisionServerConfiguration`\n\nThe `AdDecisionServerConfiguration` property type specifies Property description not available. for an [AWS::MediaTailor::PlaybackConfiguration](./aws-resource-mediatailor-playbackconfiguration.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-addecisionserverconfiguration.html", "Properties": { "HttpRequest": { "MarkdownDocumentation": "`HttpRequest`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [HttpRequest](./aws-properties-mediatailor-playbackconfiguration-httprequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-addecisionserverconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverconfiguration-httprequest", "UpdateType": "Mutable", "Required": true, "Type": "HttpRequest" } } }, "AWS::MediaTailor::PlaybackConfiguration.AdMarkerPassthrough": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.AdMarkerPassthrough`\n\nFor HLS, when set to `true`, MediaTailor passes through `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest.\nNo logic is applied to these ad markers. For example, if `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that ad break, MediaTailor will not set the value to `0`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables ad marker passthrough for your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html#cfn-mediatailor-playbackconfiguration-admarkerpassthrough-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::MediaTailor::PlaybackConfiguration.AdsInteractionLog": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.AdsInteractionLog`\n\nSettings for customizing what events are included in logs for interactions with the ad decision server (ADS).\nFor more information about ADS logs, inlcuding descriptions of the event types, see [MediaTailor ADS logs description and event types](https://docs.aws.amazon.com/mediatailor/latest/ug/ads-log-format.html)\nin AWS Elemental MediaTailor User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html", "Properties": { "ExcludeEventTypes": { "MarkdownDocumentation": "`ExcludeEventTypes`\n\nIndicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html#cfn-mediatailor-playbackconfiguration-adsinteractionlog-excludeeventtypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PublishOptInEventTypes": { "MarkdownDocumentation": "`PublishOptInEventTypes`\n\nIndicates that MediaTailor emits `RAW_ADS_RESPONSE` logs for playback sessions that are initialized with this configuration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html#cfn-mediatailor-playbackconfiguration-adsinteractionlog-publishoptineventtypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::MediaTailor::PlaybackConfiguration.AvailSuppression": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.AvailSuppression`\n\nThe configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nSets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to `BEHIND_LIVE_EDGE`, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to `AFTER_LIVE_EDGE`, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.\n*Required*: No\n*Type*: String\n*Allowed values*: `OFF | BEHIND_LIVE_EDGE | AF...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OFF", "BEHIND_LIVE_EDGE", "AFTER_LIVE_EDGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FillPolicy": { "MarkdownDocumentation": "`FillPolicy`\n\nDefines the policy to apply to the avail suppression mode. `BEHIND_LIVE_EDGE` will always use the full avail suppression policy. `AFTER_LIVE_EDGE` mode can be used to invoke partial ad break fills when a session starts mid-break.\n*Required*: No\n*Type*: String\n*Allowed values*: `PARTIAL_AVAIL | FULL_AVAIL_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PARTIAL_AVAIL", "FULL_AVAIL_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-fillpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::PlaybackConfiguration.Bumper": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.Bumper`\n\nThe configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html", "Properties": { "StartUrl": { "MarkdownDocumentation": "`StartUrl`\n\nThe URL for the start bumper 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html#cfn-mediatailor-playbackconfiguration-bumper-starturl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndUrl": { "MarkdownDocumentation": "`EndUrl`\n\nThe URL for the end bumper 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html#cfn-mediatailor-playbackconfiguration-bumper-endurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration`\n\nThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html", "Properties": { "AdSegmentUrlPrefix": { "MarkdownDocumentation": "`AdSegmentUrlPrefix`\n\nA non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.**.amazonaws.com. Then specify the rule's name in this `AdSegmentUrlPrefix`. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration-adsegmenturlprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentSegmentUrlPrefix": { "MarkdownDocumentation": "`ContentSegmentUrlPrefix`\n\nA content delivery network (CDN) to cache content segments, so that content requests don\u2019t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this `ContentSegmentUrlPrefix`. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration-contentsegmenturlprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::PlaybackConfiguration.DashConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.DashConfiguration`\n\nThe configuration for DASH content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html", "Properties": { "MpdLocation": { "MarkdownDocumentation": "`MpdLocation`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-mpdlocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestEndpointPrefix": { "MarkdownDocumentation": "`ManifestEndpointPrefix`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-manifestendpointprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OriginManifestType": { "MarkdownDocumentation": "`OriginManifestType`\n\nThe 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*Allowed values*: `SINGLE_PERIOD | MULTI_PERIO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_PERIOD", "MULTI_PERIOD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-originmanifesttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration`\n\nThe configuration for HLS content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.html", "Properties": { "ManifestEndpointPrefix": { "MarkdownDocumentation": "`ManifestEndpointPrefix`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.html#cfn-mediatailor-playbackconfiguration-hlsconfiguration-manifestendpointprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::PlaybackConfiguration.HttpRequest": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.HttpRequest`\n\nThe `HttpRequest` property type specifies Property description not available. for an [AWS::MediaTailor::PlaybackConfiguration](./aws-resource-mediatailor-playbackconfiguration.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html", "Properties": { "Headers": { "MarkdownDocumentation": "`Headers`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-headers", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "CompressRequest": { "MarkdownDocumentation": "`CompressRequest`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | GZIP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "GZIP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-compressrequest", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Body": { "MarkdownDocumentation": "`Body`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-body", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpMethod": { "MarkdownDocumentation": "`HttpMethod`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `GET | POST`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "GET", "POST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-httpmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration`\n\nThe configuration for pre-roll ad insertion.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html", "Properties": { "AdDecisionServerUrl": { "MarkdownDocumentation": "`AdDecisionServerUrl`\n\nThe URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-addecisionserverurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxDurationSeconds": { "MarkdownDocumentation": "`MaxDurationSeconds`\n\nThe maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-maxdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::MediaTailor::PlaybackConfiguration.LogConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.LogConfiguration`\n\nDefines where AWS Elemental MediaTailor sends logs for the playback configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html", "Properties": { "EnabledLoggingStrategies": { "MarkdownDocumentation": "`EnabledLoggingStrategies`\n\nThe method used for collecting logs from AWS Elemental MediaTailor. `LEGACY_CLOUDWATCH` indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. `VENDED_LOGS` indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-enabledloggingstrategies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PercentEnabled": { "MarkdownDocumentation": "`PercentEnabled`\n\nThe percentage of session logs that MediaTailor sends to your configured log destination. For example, if your playback configuration has 1000 sessions and `percentEnabled` is set to `60`, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the [debug log mode](https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html).\nValid values: `0` - `100`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-percentenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "AdsInteractionLog": { "MarkdownDocumentation": "`AdsInteractionLog`\n\nSettings for customizing what events are included in logs for interactions with the ad decision server (ADS).\n*Required*: No\n*Type*: [AdsInteractionLog](./aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-adsinteractionlog", "UpdateType": "Mutable", "Required": false, "Type": "AdsInteractionLog" }, "ManifestServiceInteractionLog": { "MarkdownDocumentation": "`ManifestServiceInteractionLog`\n\nSettings for customizing what events are included in logs for interactions with the origin server.\n*Required*: No\n*Type*: [ManifestServiceInteractionLog](./aws-properties-mediatailor-playbackconfiguration-manifestserviceinteractionlog.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-manifestserviceinteractionlog", "UpdateType": "Mutable", "Required": false, "Type": "ManifestServiceInteractionLog" } } }, "AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules`\n\nThe configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.html", "Properties": { "AdMarkerPassthrough": { "MarkdownDocumentation": "`AdMarkerPassthrough`\n\nFor HLS, when set to `true`, MediaTailor passes through `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest.\nNo logic is applied to these ad markers. For example, if `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that ad break, MediaTailor will not set the value to `0`.\n*Required*: No\n*Type*: [AdMarkerPassthrough](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.html#cfn-mediatailor-playbackconfiguration-manifestprocessingrules-admarkerpassthrough", "UpdateType": "Mutable", "Required": false, "Type": "AdMarkerPassthrough" } } }, "AWS::MediaTailor::PlaybackConfiguration.ManifestServiceInteractionLog": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration.ManifestServiceInteractionLog`\n\nSettings for customizing what events are included in logs for interactions with the origin server.\nFor more information about manifest service logs, including descriptions of the event types, see [MediaTailor manifest logs description and event types](https://docs.aws.amazon.com/mediatailor/latest/ug/log-types.html)\nin AWS Elemental MediaTailor User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestserviceinteractionlog.html", "Properties": { "ExcludeEventTypes": { "MarkdownDocumentation": "`ExcludeEventTypes`\n\nIndicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestserviceinteractionlog.html#cfn-mediatailor-playbackconfiguration-manifestserviceinteractionlog-excludeeventtypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::MediaTailor::SourceLocation.AccessConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::SourceLocation.AccessConfiguration`\n\nAccess configuration parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html", "Properties": { "SecretsManagerAccessTokenConfiguration": { "MarkdownDocumentation": "`SecretsManagerAccessTokenConfiguration`\n\nAWS Secrets Manager access token configuration parameters.\n*Required*: No\n*Type*: [SecretsManagerAccessTokenConfiguration](./aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html#cfn-mediatailor-sourcelocation-accessconfiguration-secretsmanageraccesstokenconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SecretsManagerAccessTokenConfiguration" }, "AccessType": { "MarkdownDocumentation": "`AccessType`\n\nThe type of authentication used to access content from `HttpConfiguration::BaseUrl` on your source location. Accepted value: `S3_SIGV4`.\n`S3_SIGV4` - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.\nBefore you can use `S3_SIGV4`, you must meet these requirements:\n\u2022 You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.\n\u2022 The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.\n\u2022 The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.\n*Required*: No\n*Type*: String\n*Allowed values*: `S3_SIGV4 | SECRETS_MANAGER_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html#cfn-mediatailor-sourcelocation-accessconfiguration-accesstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::SourceLocation.DefaultSegmentDeliveryConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::SourceLocation.DefaultSegmentDeliveryConfiguration`\n\nThe optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration.html", "Properties": { "BaseUrl": { "MarkdownDocumentation": "`BaseUrl`\n\nThe hostname of the server that will be used to serve segments. This string must include the protocol, such as **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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration-baseurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::SourceLocation.HttpConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::SourceLocation.HttpConfiguration`\n\nThe HTTP configuration for the source location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-httpconfiguration.html", "Properties": { "BaseUrl": { "MarkdownDocumentation": "`BaseUrl`\n\nThe base URL for the source location host server. This string must include the protocol, such as **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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-httpconfiguration.html#cfn-mediatailor-sourcelocation-httpconfiguration-baseurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaTailor::SourceLocation.SecretsManagerAccessTokenConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::SourceLocation.SecretsManagerAccessTokenConfiguration`\n\nAWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see [Working with AWS Secrets Manager access token authentication](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HeaderName": { "MarkdownDocumentation": "`HeaderName`\n\nThe name of the HTTP header used to supply the access token in requests to the source location.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-headername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecretStringKey": { "MarkdownDocumentation": "`SecretStringKey`\n\nThe AWS Secrets Manager[SecretString](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html) key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-secretstringkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::SourceLocation.SegmentDeliveryConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::SourceLocation.SegmentDeliveryConfiguration`\n\nThe segment delivery configuration settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html", "Properties": { "BaseUrl": { "MarkdownDocumentation": "`BaseUrl`\n\nThe base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as `https://example.com/some/path`. To use a relative URL specify the relative path, such as `/some/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfiguration-baseurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA unique identifier used to distinguish between multiple segment delivery configurations in a source location.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfiguration-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::MediaTailor::VodSource.HttpPackageConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::VodSource.HttpPackageConfiguration`\n\nThe HTTP package configuration properties for the requested VOD source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe relative path to the URL for this VOD source. This is combined with `SourceLocation::HttpConfiguration::BaseUrl` to form a valid URL.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-path", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe streaming protocol for this package configuration. Supported values are `HLS` and `DASH`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DASH | HLS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DASH", "HLS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceGroup": { "MarkdownDocumentation": "`SourceGroup`\n\nThe name of the source group. This has to match one of the `Channel::Outputs::SourceGroup`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-sourcegroup", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MemoryDB::Cluster.Endpoint": { "MarkdownDocumentation": "`AWS::MemoryDB::Cluster.Endpoint`\n\nRepresents the information required for client programs to connect to the cluster and\nits nodes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe DNS hostname of the node.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html#cfn-memorydb-cluster-endpoint-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port number that the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html#cfn-memorydb-cluster-endpoint-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::MemoryDB::User.AuthenticationMode": { "MarkdownDocumentation": "`AWS::MemoryDB::User.AuthenticationMode`\n\nDenotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-user-authenticationmode.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nIndicates 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 | iam...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "password", "iam" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-user-authenticationmode.html#cfn-memorydb-user-authenticationmode-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Passwords": { "MarkdownDocumentation": "`Passwords`\n\nThe password(s) used for authentication\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-user-authenticationmode.html#cfn-memorydb-user-authenticationmode-passwords", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Neptune::DBCluster.DBClusterRole": { "MarkdownDocumentation": "`AWS::Neptune::DBCluster.DBClusterRole`\n\nDescribes an Amazon Identity and Access Management (IAM) role that is associated with a DB\ncluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-dbclusterrole.html", "Properties": { "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that is associated with the DB\ncluster.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-dbclusterrole.html#cfn-neptune-dbcluster-dbclusterrole-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FeatureName": { "MarkdownDocumentation": "`FeatureName`\n\nThe name of the feature associated with the Amazon Identity and Access Management (IAM) role.\nFor the list of supported feature names, see [DescribeDBEngineVersions](https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-dbclusterrole.html#cfn-neptune-dbcluster-dbclusterrole-featurename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Neptune::DBCluster.ServerlessScalingConfiguration": { "MarkdownDocumentation": "`AWS::Neptune::DBCluster.ServerlessScalingConfiguration`\n\nContains the scaling configuration of a Neptune Serverless DB cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-serverlessscalingconfiguration.html", "Properties": { "MinCapacity": { "MarkdownDocumentation": "`MinCapacity`\n\nThe minimum number of Neptune capacity units (NCUs) for a DB instance\nin a Neptune Serverless cluster. You can specify NCU values in half-step\nincrements, such as 8, 8.5, 9, and so on.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-serverlessscalingconfiguration.html#cfn-neptune-dbcluster-serverlessscalingconfiguration-mincapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster.\nYou can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-serverlessscalingconfiguration.html#cfn-neptune-dbcluster-serverlessscalingconfiguration-maxcapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::NeptuneGraph::Graph.VectorSearchConfiguration": { "MarkdownDocumentation": "`AWS::NeptuneGraph::Graph.VectorSearchConfiguration`\n\nThe vector-search configuration for the graph, which specifies the vector dimension\nto use in the vector index, if any.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-vectorsearchconfiguration.html", "Properties": { "VectorSearchDimension": { "MarkdownDocumentation": "`VectorSearchDimension`\n\nThe number of dimensions.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-vectorsearchconfiguration.html#cfn-neptunegraph-graph-vectorsearchconfiguration-vectorsearchdimension", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::NetworkFirewall::Firewall.AvailabilityZoneMapping": { "MarkdownDocumentation": "`AWS::NetworkFirewall::Firewall.AvailabilityZoneMapping`\n\nDefines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling `CreateFirewall`, `AssociateAvailabilityZones`, and `DisassociateAvailabilityZones`.\nTo retrieve the current Availability Zone mappings for a firewall, use `DescribeFirewall`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-availabilityzonemapping.html", "Properties": { "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe ID of the Availability Zone where the firewall endpoint is located. For example, `us-east-2a`. The Availability Zone must be in the same Region as the transit gateway.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-availabilityzonemapping.html#cfn-networkfirewall-firewall-availabilityzonemapping-availabilityzone", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::Firewall.SubnetMapping": { "MarkdownDocumentation": "`AWS::NetworkFirewall::Firewall.SubnetMapping`\n\nThe ID for a subnet that you want to associate with the firewall. AWS Network Firewall\ncreates an instance of the associated firewall in each subnet that you specify, to filter\ntraffic in the subnet's Availability Zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-subnetmapping.html", "Properties": { "IPAddressType": { "MarkdownDocumentation": "`IPAddressType`\n\nThe 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 | IPV6...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DUALSTACK", "IPV4", "IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-subnetmapping.html#cfn-networkfirewall-firewall-subnetmapping-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-subnetmapping.html#cfn-networkfirewall-firewall-subnetmapping-subnetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::FirewallPolicy.ActionDefinition": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.ActionDefinition`\n\nA custom action to use in stateless rule actions settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-actiondefinition.html", "Properties": { "PublishMetricAction": { "MarkdownDocumentation": "`PublishMetricAction`\n\nStateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the\nmatching 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\nexample, you could pair this in a rule action with the standard action that forwards the\npacket for stateful inspection. Then, when a packet matches the rule, Network Firewall\npublishes metrics for the packet and forwards it.\n*Required*: No\n*Type*: [PublishMetricAction](./aws-properties-networkfirewall-firewallpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-actiondefinition.html#cfn-networkfirewall-firewallpolicy-actiondefinition-publishmetricaction", "UpdateType": "Mutable", "Required": false, "Type": "PublishMetricAction" } } }, "AWS::NetworkFirewall::FirewallPolicy.CustomAction": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.CustomAction`\n\nAn optional, non-standard action to use for stateless packet handling. You can define\nthis in addition to the standard action that you must specify.\nYou define and name the custom actions that you want to be able to use, and then you\nreference them by name in your actions settings.\nYou can use custom actions in the following places:\n* In an `StatelessRulesAndCustomActions`.\n The custom actions are available for use by name inside the\n `StatelessRulesAndCustomActions` where you define them. You can use\n them for your stateless rule actions to specify what to do with a packet that matches\n the rule's match attributes.\n* In an firewall policy specification, in\n `StatelessCustomActions`. The custom actions are available for use\n inside the policy where you define them. You can use them for the policy's default\n stateless actions settings to specify what to do with packets that don't match any of\n the policy's stateless rules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html", "Properties": { "ActionName": { "MarkdownDocumentation": "`ActionName`\n\nThe descriptive name of the custom action. You can't change the name of a custom action after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html#cfn-networkfirewall-firewallpolicy-customaction-actionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionDefinition": { "MarkdownDocumentation": "`ActionDefinition`\n\nThe custom action associated with the action name.\n*Required*: Yes\n*Type*: [ActionDefinition](./aws-properties-networkfirewall-firewallpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html#cfn-networkfirewall-firewallpolicy-customaction-actiondefinition", "UpdateType": "Mutable", "Required": true, "Type": "ActionDefinition" } } }, "AWS::NetworkFirewall::FirewallPolicy.Dimension": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.Dimension`\n\nThe value to use in an Amazon CloudWatch custom metric dimension. This is used in the\n`PublishMetrics` custom action. A CloudWatch custom metric dimension is a name/value pair that's\npart of the identity of a metric.\nAWS Network Firewall sets the dimension name to `CustomAction` and you provide the\ndimension value.\nFor more information about CloudWatch custom metric dimensions, see\n[Publishing Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the [Amazon CloudWatch User\nGuide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-dimension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to use in the custom metric dimension.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_ ]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-dimension.html#cfn-networkfirewall-firewallpolicy-dimension-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy`\n\nThe traffic filtering behavior of a firewall policy, defined in a collection of stateless\nand stateful rule groups and other settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html", "Properties": { "StatelessRuleGroupReferences": { "MarkdownDocumentation": "`StatelessRuleGroupReferences`\n\nReferences to the stateless rule groups that are used in the policy. These define the\nmatching criteria in stateless rules.\n*Required*: No\n*Type*: Array of [StatelessRuleGroupReference](./aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessrulegroupreferences", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StatelessRuleGroupReference", "DuplicatesAllowed": true }, "StatefulRuleGroupReferences": { "MarkdownDocumentation": "`StatefulRuleGroupReferences`\n\nReferences to the stateful rule groups that are used in the policy. These define the\ninspection criteria in stateful rules.\n*Required*: No\n*Type*: Array of [StatefulRuleGroupReference](./aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulrulegroupreferences", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StatefulRuleGroupReference", "DuplicatesAllowed": true }, "EnableTLSSessionHolding": { "MarkdownDocumentation": "`EnableTLSSessionHolding`\n\nWhen true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules. Requires an associated TLS Inspection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-enabletlssessionholding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "StatelessDefaultActions": { "MarkdownDocumentation": "`StatelessDefaultActions`\n\nThe actions to take on a packet if it doesn't match any of the stateless rules in the\npolicy. If you want non-matching packets to be forwarded for stateful inspection, specify\n`aws:forward_to_sfe`.\nYou must specify one of the standard actions: `aws:pass`,\n`aws:drop`, or `aws:forward_to_sfe`. In addition, you can specify\ncustom actions that are compatible with your standard section choice.\nFor example, you could specify `[\"aws:pass\"]` or you could specify\n`[\"aws:pass\", \u201ccustomActionName\u201d]`. For information about compatibility, see\nthe custom action descriptions.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessdefaultactions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "StatefulEngineOptions": { "MarkdownDocumentation": "`StatefulEngineOptions`\n\nAdditional options governing how Network Firewall handles stateful rules. The stateful\nrule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.\n*Required*: No\n*Type*: [StatefulEngineOptions](./aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulengineoptions", "UpdateType": "Mutable", "Required": false, "Type": "StatefulEngineOptions" }, "StatelessCustomActions": { "MarkdownDocumentation": "`StatelessCustomActions`\n\nThe custom action definitions that are available for use in the firewall policy's\n`StatelessDefaultActions` setting. You name each custom action that you\ndefine, and then you can use it by name in your default actions specifications.\n*Required*: No\n*Type*: Array of [CustomAction](./aws-properties-networkfirewall-firewallpolicy-customaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelesscustomactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomAction", "DuplicatesAllowed": true }, "StatelessFragmentDefaultActions": { "MarkdownDocumentation": "`StatelessFragmentDefaultActions`\n\nThe actions to take on a fragmented packet if it doesn't match any of the stateless\nrules in the policy. If you want non-matching fragmented packets to be forwarded for\nstateful inspection, specify `aws:forward_to_sfe`.\nYou must specify one of the standard actions: `aws:pass`,\n`aws:drop`, or `aws:forward_to_sfe`. In addition, you can specify\ncustom actions that are compatible with your standard section choice.\nFor example, you could specify `[\"aws:pass\"]` or you could specify\n`[\"aws:pass\", \u201ccustomActionName\u201d]`. For information about compatibility, see\nthe custom action descriptions.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessfragmentdefaultactions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PolicyVariables": { "MarkdownDocumentation": "`PolicyVariables`\n\nContains variables that you can use to override default Suricata settings in your firewall policy.\n*Required*: No\n*Type*: [PolicyVariables](./aws-properties-networkfirewall-firewallpolicy-policyvariables.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-policyvariables", "UpdateType": "Mutable", "Required": false, "Type": "PolicyVariables" }, "StatefulDefaultActions": { "MarkdownDocumentation": "`StatefulDefaultActions`\n\nThe default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional,\nand is only valid when using the strict rule order.\nValid values of the stateful default action:\n* aws:drop\\_strict\n* aws:drop\\_established\n* aws:alert\\_strict\n* aws:alert\\_established\nFor more information, see\n[Strict evaluation order](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefuldefaultactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TLSInspectionConfigurationArn": { "MarkdownDocumentation": "`TLSInspectionConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the TLS inspection configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-tlsinspectionconfigurationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::FirewallPolicy.FlowTimeouts": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.FlowTimeouts`\n\nDescribes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table.\nExisting connections and flows are not impacted when you update this value. Only new connections after you update this value are impacted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-flowtimeouts.html", "Properties": { "TcpIdleTimeoutSeconds": { "MarkdownDocumentation": "`TcpIdleTimeoutSeconds`\n\nThe number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle.\nAfter the idle timeout passes, data packets are dropped, however, the next TCP SYN packet is considered a new flow and is processed by the firewall.\nClients or targets can use TCP keepalive packets to reset the idle timeout.\nYou can define the `TcpIdleTimeoutSeconds` value to be between 60 and 6000 seconds. If no value is provided, it defaults to 350 seconds.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `6000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-flowtimeouts.html#cfn-networkfirewall-firewallpolicy-flowtimeouts-tcpidletimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkFirewall::FirewallPolicy.IPSet": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.IPSet`\n\nA list of IP addresses and address ranges, in CIDR notation. This is part of a rule variable.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-ipset.html", "Properties": { "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe list of IP addresses and address ranges, in CIDR notation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-ipset.html#cfn-networkfirewall-firewallpolicy-ipset-definition", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::FirewallPolicy.PolicyVariables": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.PolicyVariables`\n\nContains variables that you can use to override default Suricata settings in your firewall policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-policyvariables.html", "Properties": { "RuleVariables": { "MarkdownDocumentation": "`RuleVariables`\n\nThe IPv4 or IPv6 addresses in CIDR notation to use for the Suricata `HOME_NET` variable. If your firewall uses an inspection VPC, you might want to override the `HOME_NET` variable with the CIDRs of your home networks. If you don't override `HOME_NET` with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.\n*Required*: No\n*Type*: Object of [IPSet](./aws-properties-networkfirewall-firewallpolicy-ipset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-policyvariables.html#cfn-networkfirewall-firewallpolicy-policyvariables-rulevariables", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "IPSet" } } }, "AWS::NetworkFirewall::FirewallPolicy.PublishMetricAction": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.PublishMetricAction`\n\nStateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the\nmatching packet. This setting defines a CloudWatch dimension value to be published.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-publishmetricaction.html", "Properties": { "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\n*Required*: Yes\n*Type*: Array of [Dimension](./aws-properties-networkfirewall-firewallpolicy-dimension.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-publishmetricaction.html#cfn-networkfirewall-firewallpolicy-publishmetricaction-dimensions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Dimension", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::FirewallPolicy.StatefulEngineOptions": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.StatefulEngineOptions`\n\nConfiguration settings for the handling of the stateful rule groups in a firewall policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html", "Properties": { "StreamExceptionPolicy": { "MarkdownDocumentation": "`StreamExceptionPolicy`\n\nConfigures 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* `REJECT` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.\n*Required*: No\n*Type*: String\n*Allowed values*: `DROP | CONTINUE | REJECT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DROP", "CONTINUE", "REJECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-streamexceptionpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FlowTimeouts": { "MarkdownDocumentation": "`FlowTimeouts`\n\nConfigures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.\n*Required*: No\n*Type*: [FlowTimeouts](./aws-properties-networkfirewall-firewallpolicy-flowtimeouts.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-flowtimeouts", "UpdateType": "Mutable", "Required": false, "Type": "FlowTimeouts" }, "RuleOrder": { "MarkdownDocumentation": "`RuleOrder`\n\nIndicates how to manage the order of stateful rule evaluation for the policy. `DEFAULT_ACTION_ORDER` is\nthe default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\nbased on certain settings. For more information, see\n[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 | STRI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT_ACTION_ORDER", "STRICT_ORDER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-ruleorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupOverride": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupOverride`\n\nThe setting that allows the policy owner to change the behavior of the rule group within a policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that changes the rule group from `DROP` to `ALERT`. This only applies to\nmanaged 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)", "RefReturnValue": "", "AllowedValues": [ "DROP_TO_ALERT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupoverride-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupReference": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupReference`\n\nIdentifier for a single stateful rule group, used in a firewall policy to refer to a\nrule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the stateful rule group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-resourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nAn integer setting that indicates the order in which to run the stateful rule groups in\na single firewall policy. This setting only applies to firewall policies\nthat specify the `STRICT_ORDER` rule order in the stateful engine options settings.\nNetwork Firewall evalutes each stateful rule group\nagainst a packet starting with the group that has the lowest priority setting. You must ensure\nthat 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\ninsert rule groups later, number them so there's a wide range in between, for example use 100,\n200, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-priority", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Override": { "MarkdownDocumentation": "`Override`\n\nThe action that allows the policy owner to override the behavior of the rule group within a policy.\n*Required*: No\n*Type*: [StatefulRuleGroupOverride](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-override", "UpdateType": "Mutable", "Required": false, "Type": "StatefulRuleGroupOverride" }, "DeepThreatInspection": { "MarkdownDocumentation": "`DeepThreatInspection`\n\nAWS Network Firewall plans to augment the active threat defense managed rule group with an additional deep threat inspection capability. When this capability is released, AWS will analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers.\nAWS will use these threat indicators to improve the active threat defense managed rule groups and protect the security of AWS customers and services.\n###### Note\nCustomers can opt-out of deep threat inspection at any time through the AWS Network Firewall console or API. When customers opt out, AWS Network Firewall will not use the network traffic processed by those customers' active threat defense rule groups for rule group improvement.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-deepthreatinspection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::NetworkFirewall::FirewallPolicy.StatelessRuleGroupReference": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy.StatelessRuleGroupReference`\n\nIdentifier for a single stateless rule group, used in a firewall policy to refer to the\nrule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the stateless rule group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-resourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nAn integer setting that indicates the order in which to run the stateless rule groups in\na single firewall policy. Network Firewall applies each stateless rule group\nto a packet starting with the group that has the lowest priority setting. You must ensure\nthat the priority settings are unique within each policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::NetworkFirewall::LoggingConfiguration.LogDestinationConfig": { "MarkdownDocumentation": "`AWS::NetworkFirewall::LoggingConfiguration.LogDestinationConfig`\n\nDefines where AWS Network Firewall sends logs for the firewall for one log type. This is used\nin logging configuration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.\nNetwork Firewall generates logs for stateful rule groups. You can save alert and flow log\ntypes. The stateful rules engine records flow logs for all network traffic that it receives.\nIt records alert logs for traffic that matches stateful rules that have the rule\naction set to `DROP` or `ALERT`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html", "Properties": { "LogType": { "MarkdownDocumentation": "`LogType`\n\nThe type of log to record. You can record the following types of logs from your Network Firewall stateful engine.\n* `ALERT` - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see the `StatefulRule` property.\n* `FLOW` - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.\n* `TLS` - Logs for events that are related to TLS inspection. For more information, see\n [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-configurations.html)\n in the *Network Firewall Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALERT | FLOW | TLS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALERT", "FLOW", "TLS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogDestination": { "MarkdownDocumentation": "`LogDestination`\n\nThe named location for the logs, provided in a key:value mapping that is specific to the\nchosen destination type.\n* For an Amazon S3 bucket, provide the name of the bucket, with key `bucketName`,\n and optionally provide a prefix, with key `prefix`.\n \n The following example specifies an Amazon S3 bucket named `DOC-EXAMPLE-BUCKET` and the prefix `alerts`:\n \n `\"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\"\n }`\n* For a CloudWatch log group, provide the name of the CloudWatch log group, with key\n `logGroup`. The following example specifies a log group named\n `alert-log-group`:\n \n `\"LogDestination\": { \"logGroup\": \"alert-log-group\" }`\n* For a Firehose delivery stream, provide the name of the delivery stream, with key\n `deliveryStream`. The following example specifies a delivery stream\n named `alert-delivery-stream`:\n \n `\"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\"\n }`\n*Required*: Yes\n*Type*: Object of String\n*Pattern*: `^[0-9A-Za-z.\\-_@\\/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logdestination", "UpdateType": "Mutable", "Required": true, "Type": "Map", "PrimitiveItemType": "String" }, "LogDestinationType": { "MarkdownDocumentation": "`LogDestinationType`\n\nThe type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket,\na CloudWatch log group, or a Firehose delivery stream.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `S3 | CloudWatchLogs | Kines...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "S3", "CloudWatchLogs", "KinesisDataFirehose" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logdestinationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::LoggingConfiguration.LoggingConfiguration": { "MarkdownDocumentation": "`AWS::NetworkFirewall::LoggingConfiguration.LoggingConfiguration`\n\nDefines how AWS Network Firewall performs logging for a firewall.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-loggingconfiguration.html", "Properties": { "LogDestinationConfigs": { "MarkdownDocumentation": "`LogDestinationConfigs`\n\nDefines the logging destinations for the logs for a firewall. Network Firewall generates\nlogs for stateful rule groups.\n*Required*: Yes\n*Type*: Array of [LogDestinationConfig](./aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration-logdestinationconfigs", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "LogDestinationConfig", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.ActionDefinition": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.ActionDefinition`\n\nA custom action to use in stateless rule actions settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-actiondefinition.html", "Properties": { "PublishMetricAction": { "MarkdownDocumentation": "`PublishMetricAction`\n\nStateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the\nmatching 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\nexample, you could pair this in a rule action with the standard action that forwards the\npacket for stateful inspection. Then, when a packet matches the rule, Network Firewall\npublishes metrics for the packet and forwards it.\n*Required*: No\n*Type*: [PublishMetricAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-actiondefinition.html#cfn-networkfirewall-rulegroup-actiondefinition-publishmetricaction", "UpdateType": "Mutable", "Required": false, "Type": "PublishMetricAction" } } }, "AWS::NetworkFirewall::RuleGroup.Address": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.Address`\n\nA single IP address specification. This is used in the match attributes\nsource and destination specifications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-address.html", "Properties": { "AddressDefinition": { "MarkdownDocumentation": "`AddressDefinition`\n\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\nInter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-fA-F\\d:\\.]+/\\d{1,3})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-address.html#cfn-networkfirewall-rulegroup-address-addressdefinition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::RuleGroup.CustomAction": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.CustomAction`\n\nAn optional, non-standard action to use for stateless packet handling. You can define\nthis in addition to the standard action that you must specify.\nYou define and name the custom actions that you want to be able to use, and then you\nreference them by name in your actions settings.\nYou can use custom actions in the following places:\n* In a `StatelessRulesAndCustomActions`.\n The custom actions are available for use by name inside the\n `StatelessRulesAndCustomActions` where you define them. You can use\n them for your stateless rule actions to specify what to do with a packet that matches\n the rule's match attributes.\n* In an firewall policy specification, in\n `StatelessCustomActions`. The custom actions are available for use\n inside the policy where you define them. You can use them for the policy's default\n stateless actions settings to specify what to do with packets that don't match any of\n the policy's stateless rules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html", "Properties": { "ActionName": { "MarkdownDocumentation": "`ActionName`\n\nThe descriptive name of the custom action. You can't change the name of a custom action after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html#cfn-networkfirewall-rulegroup-customaction-actionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionDefinition": { "MarkdownDocumentation": "`ActionDefinition`\n\nThe custom action associated with the action name.\n*Required*: Yes\n*Type*: [ActionDefinition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html#cfn-networkfirewall-rulegroup-customaction-actiondefinition", "UpdateType": "Mutable", "Required": true, "Type": "ActionDefinition" } } }, "AWS::NetworkFirewall::RuleGroup.Dimension": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.Dimension`\n\nThe value to use in an Amazon CloudWatch custom metric dimension. This is used in the\n`PublishMetrics` custom action. A CloudWatch custom metric dimension is a name/value pair that's\npart of the identity of a metric.\nAWS Network Firewall sets the dimension name to `CustomAction` and you provide the\ndimension value.\nFor more information about CloudWatch custom metric dimensions, see\n[Publishing Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the [Amazon CloudWatch User\nGuide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-dimension.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to use in the custom metric dimension.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_ ]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-dimension.html#cfn-networkfirewall-rulegroup-dimension-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::RuleGroup.Header": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.Header`\n\nThe 5-tuple criteria for AWS Network Firewall to use to inspect packet headers in stateful\ntraffic flow inspection. Traffic flows that match the criteria are a match for the\ncorresponding stateful rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination IP address or address range to inspect for, in CIDR notation.\nTo 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\nInter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-destination", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe 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*: `IP | TCP | UDP | ICMP | HTT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IP", "TCP", "UDP", "ICMP", "HTTP", "FTP", "TLS", "SMB", "DNS", "DCERPC", "SSH", "SMTP", "IMAP", "MSN", "KRB5", "IKEV2", "TFTP", "NTP", "DHCP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-protocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourcePort": { "MarkdownDocumentation": "`SourcePort`\n\nThe source port to inspect for. You can specify an individual port,\nfor example `1994` and you can specify a port range, for example `1990:1994`.\nTo match with any port, specify `ANY`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-sourceport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe direction of traffic flow to inspect. If set to `ANY`, the inspection\nmatches bidirectional traffic, both from the source to the destination and from the\ndestination to the source. If set to `FORWARD`, the inspection only matches\ntraffic going from the source to the destination.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FORWARD | ANY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FORWARD", "ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DestinationPort": { "MarkdownDocumentation": "`DestinationPort`\n\nThe destination port to inspect for. You can specify an individual port,\nfor example `1994` and you can specify a port range, for example `1990:1994`.\nTo match with any port, specify `ANY`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-destinationport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source IP address or address range to inspect for, in CIDR notation.\nTo 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\nInter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-source", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::RuleGroup.IPSet": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.IPSet`\n\nA list of IP addresses and address ranges, in CIDR notation. This is part of a `RuleVariables`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipset.html", "Properties": { "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe list of IP addresses and address ranges, in CIDR notation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipset.html#cfn-networkfirewall-rulegroup-ipset-definition", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.IPSetReference": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.IPSetReference`\n\nConfigures one or more IP set references for a Suricata-compatible rule group. An IP set reference is a rule variable that references a resource that you create and manage in another AWS service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the IP set you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall, see [Using IP set references](https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html) in the *Network Firewall Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipsetreference.html", "Properties": { "ReferenceArn": { "MarkdownDocumentation": "`ReferenceArn`\n\nThe Amazon Resource Name (ARN) of the resource to include in the IP set reference.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipsetreference.html#cfn-networkfirewall-rulegroup-ipsetreference-referencearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::RuleGroup.MatchAttributes": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.MatchAttributes`\n\nCriteria 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html", "Properties": { "Protocols": { "MarkdownDocumentation": "`Protocols`\n\nThe protocols to inspect for, specified using the assigned internet protocol number (IANA)\nfor each protocol. If not specified, this matches with any protocol.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-protocols", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "TCPFlags": { "MarkdownDocumentation": "`TCPFlags`\n\nThe TCP flags and masks to inspect for. If not specified, this matches with any\nsettings. This setting is only used for protocol 6 (TCP).\n*Required*: No\n*Type*: Array of [TCPFlagField](./aws-properties-networkfirewall-rulegroup-tcpflagfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-tcpflags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TCPFlagField", "DuplicatesAllowed": true }, "DestinationPorts": { "MarkdownDocumentation": "`DestinationPorts`\n\nThe destination port to inspect for. You can specify an individual port,\nfor example `1994` and you can specify a port range, for example `1990:1994`.\nTo match with any port, specify `ANY`.\nThis setting is only used for protocols 6 (TCP) and 17 (UDP).\n*Required*: No\n*Type*: Array of [PortRange](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-destinationports", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": true }, "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nThe destination IP addresses and address ranges to inspect for, in CIDR notation. If not\nspecified, this matches with any destination address.\n*Required*: No\n*Type*: Array of [Address](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-destinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Address", "DuplicatesAllowed": true }, "Sources": { "MarkdownDocumentation": "`Sources`\n\nThe source IP addresses and address ranges to inspect for, in CIDR notation. If not\nspecified, this matches with any source address.\n*Required*: No\n*Type*: Array of [Address](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-sources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Address", "DuplicatesAllowed": true }, "SourcePorts": { "MarkdownDocumentation": "`SourcePorts`\n\nThe source port to inspect for. You can specify an individual port,\nfor example `1994` and you can specify a port range, for example `1990:1994`.\nTo match with any port, specify `ANY`.\nIf not specified, this matches with any source port.\nThis setting is only used for protocols 6 (TCP) and 17 (UDP).\n*Required*: No\n*Type*: Array of [PortRange](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-sourceports", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.PortRange": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.PortRange`\n\nA single port range specification. This is used for source and destination port ranges\nin the stateless match attributes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html", "Properties": { "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nThe lower limit of the port range. This must be less than or equal to the\n`ToPort` specification.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html#cfn-networkfirewall-rulegroup-portrange-fromport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nThe upper limit of the port range. This must be greater than or equal to the\n`FromPort` specification.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html#cfn-networkfirewall-rulegroup-portrange-toport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::NetworkFirewall::RuleGroup.PortSet": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.PortSet`\n\nA set of port ranges for use in the rules in a rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portset.html", "Properties": { "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe set of port ranges.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portset.html#cfn-networkfirewall-rulegroup-portset-definition", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.PublishMetricAction": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.PublishMetricAction`\n\nStateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the\nmatching packet. This setting defines a CloudWatch dimension value to be published.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-publishmetricaction.html", "Properties": { "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\n*Required*: Yes\n*Type*: Array of [Dimension](./aws-properties-networkfirewall-rulegroup-dimension.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-publishmetricaction.html#cfn-networkfirewall-rulegroup-publishmetricaction-dimensions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Dimension", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.ReferenceSets": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.ReferenceSets`\n\nConfigures the reference sets for a stateful rule group. For more information, see the [Using IP set references in Suricata compatible rule groups](https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html) in the *Network Firewall User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-referencesets.html", "Properties": { "IPSetReferences": { "MarkdownDocumentation": "`IPSetReferences`\n\nThe IP set references to use in the stateful rule group.\n*Required*: No\n*Type*: Object of [IPSetReference](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-referencesets.html#cfn-networkfirewall-rulegroup-referencesets-ipsetreferences", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "IPSetReference" } } }, "AWS::NetworkFirewall::RuleGroup.RuleDefinition": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.RuleDefinition`\n\nThe inspection criteria and action for a single stateless rule. AWS Network Firewall inspects each packet for the specified matching\ncriteria. When a packet matches the criteria, Network Firewall performs the rule's actions on\nthe packet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions to take on a packet that matches one of the stateless rule definition's\nmatch attributes. You must specify a standard action and you can add custom actions.\n###### Note\nNetwork Firewall only forwards a packet for stateful rule inspection if you specify\n`aws:forward_to_sfe` for a rule that the packet matches, or if the packet\ndoesn't match any stateless rule and you specify `aws:forward_to_sfe` for the\n`StatelessDefaultActions` setting for the firewall policy.\nFor every rule, you must specify exactly one of the following standard actions.\n* **aws:pass** - Discontinues all inspection of\n the packet and permits it to go to its intended destination.\n* **aws:drop** - Discontinues all inspection of\n the packet and blocks it from going to its intended destination.\n* **aws:forward\\_to\\_sfe** - Discontinues\n stateless inspection of the packet and forwards it to the stateful rule engine for\n inspection.\nAdditionally, you can specify a custom action.\nTo do this, you define a custom action by name and type, then provide the name you've assigned\nto the action in this `Actions` setting.\nTo provide more than one action in this setting, separate the settings with a comma. For\nexample, if you have a publish metrics custom action that you've named\n`MyMetricsAction`, then you could specify the standard action\n`aws:pass` combined with the custom action using `[\u201caws:pass\u201d,\n\u201cMyMetricsAction\u201d]`.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html#cfn-networkfirewall-rulegroup-ruledefinition-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MatchAttributes": { "MarkdownDocumentation": "`MatchAttributes`\n\nCriteria 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html#cfn-networkfirewall-rulegroup-ruledefinition-matchattributes", "UpdateType": "Mutable", "Required": true, "Type": "MatchAttributes" } } }, "AWS::NetworkFirewall::RuleGroup.RuleGroup": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.RuleGroup`\n\nThe object that defines the rules in a rule group.\nAWS Network Firewall uses a rule group to inspect and control network traffic.\nYou define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their\ntraffic flow.\nTo use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from\nmore than one firewall policy, and you can use a firewall policy in more than one firewall.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html", "Properties": { "StatefulRuleOptions": { "MarkdownDocumentation": "`StatefulRuleOptions`\n\nAdditional options governing how Network Firewall handles stateful rules. The policies where you use your stateful\nrule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see [Strict evaluation order](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-limitations-caveats.html) in the *AWS Network Firewall Developer Guide*.\n*Required*: No\n*Type*: [StatefulRuleOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-statefulruleoptions", "UpdateType": "Mutable", "Required": false, "Type": "StatefulRuleOptions" }, "ReferenceSets": { "MarkdownDocumentation": "`ReferenceSets`\n\nThe reference sets for the stateful rule group.\n*Required*: No\n*Type*: [ReferenceSets](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-referencesets", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceSets" }, "RulesSource": { "MarkdownDocumentation": "`RulesSource`\n\nThe stateful rules or stateless rules for the rule group.\n*Required*: Yes\n*Type*: [RulesSource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-rulessource", "UpdateType": "Mutable", "Required": true, "Type": "RulesSource" }, "RuleVariables": { "MarkdownDocumentation": "`RuleVariables`\n\nSettings that are available for use in the rules in the rule group. You can only use\nthese for stateful rule groups.\n*Required*: No\n*Type*: [RuleVariables](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-rulevariables", "UpdateType": "Mutable", "Required": false, "Type": "RuleVariables" } } }, "AWS::NetworkFirewall::RuleGroup.RuleOption": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.RuleOption`\n\nAdditional settings for a stateful rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html", "Properties": { "Keyword": { "MarkdownDocumentation": "`Keyword`\n\nThe Suricata rule option keywords. For Network Firewall, the keyword signature ID (sid) is required in the format `sid:112233`. The sid must be unique within the rule group. For information about Suricata rule option keywords, see [Rule options](https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html#cfn-networkfirewall-rulegroup-ruleoption-keyword", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nThe Suricata rule option settings. Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is `number`. For information about Suricata rule option settings, see [Rule options](https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html#cfn-networkfirewall-rulegroup-ruleoption-settings", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.RuleVariables": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.RuleVariables`\n\nSettings that are available for use in the rules in the rule group\nwhere this is defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html", "Properties": { "PortSets": { "MarkdownDocumentation": "`PortSets`\n\nA list of port ranges.\n*Required*: No\n*Type*: Object of [PortSet](./aws-properties-networkfirewall-rulegroup-portset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html#cfn-networkfirewall-rulegroup-rulevariables-portsets", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "PortSet" }, "IPSets": { "MarkdownDocumentation": "`IPSets`\n\nA list of IP addresses and address ranges, in CIDR notation.\n*Required*: No\n*Type*: Object of [IPSet](./aws-properties-networkfirewall-rulegroup-ipset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html#cfn-networkfirewall-rulegroup-rulevariables-ipsets", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "IPSet" } } }, "AWS::NetworkFirewall::RuleGroup.RulesSource": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.RulesSource`\n\nThe stateless or stateful rules definitions for use in a single rule group. Each rule\ngroup requires a single `RulesSource`. You can use an instance of this for\neither stateless rules or stateful rules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html", "Properties": { "StatelessRulesAndCustomActions": { "MarkdownDocumentation": "`StatelessRulesAndCustomActions`\n\nStateless inspection criteria to be used in a stateless rule group.\n*Required*: No\n*Type*: [StatelessRulesAndCustomActions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-statelessrulesandcustomactions", "UpdateType": "Mutable", "Required": false, "Type": "StatelessRulesAndCustomActions" }, "StatefulRules": { "MarkdownDocumentation": "`StatefulRules`\n\nAn array of individual stateful rules inspection criteria to be used together in a stateful rule group.\nUse this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options.\nFor information about the Suricata `Rules` format, see\n[Rules Format](https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html).\n*Required*: No\n*Type*: Array of [StatefulRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-statefulrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StatefulRule", "DuplicatesAllowed": true }, "RulesString": { "MarkdownDocumentation": "`RulesString`\n\nStateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard\nrule-based language for network traffic inspection.\nThese rules contain the inspection criteria and the action to take for traffic that\nmatches the criteria, so this type of rule group doesn't have a separate action\nsetting.\n###### Note\nYou can't use the `priority` keyword if the `RuleOrder` option in StatefulRuleOptions is set to `STRICT_ORDER`.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `1000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-rulesstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RulesSourceList": { "MarkdownDocumentation": "`RulesSourceList`\n\nStateful inspection criteria for a domain list rule group.\n*Required*: No\n*Type*: [RulesSourceList](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-rulessourcelist", "UpdateType": "Mutable", "Required": false, "Type": "RulesSourceList" } } }, "AWS::NetworkFirewall::RuleGroup.RulesSourceList": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.RulesSourceList`\n\nStateful inspection criteria for a domain list rule group.\nFor HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.\nBy default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the `HOME_NET` rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see `RuleVariables` in this guide and [Stateful domain list rule groups in AWS Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) in the *Network Firewall Developer Guide*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html", "Properties": { "GeneratedRulesType": { "MarkdownDocumentation": "`GeneratedRulesType`\n\nWhether you want to apply allow, reject, alert, or drop behavior to the domains in your target list.\n###### Note\nWhen logging is enabled and you choose Alert, traffic that matches the domain specifications\ngenerates an alert in the firewall's logs. Then, traffic either passes, is rejected, or drops based on other rules in the firewall policy.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALLOWLIST | DENYLIST | ALER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOWLIST", "DENYLIST", "ALERTLIST", "REJECTLIST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-generatedrulestype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetTypes": { "MarkdownDocumentation": "`TargetTypes`\n\nThe types of targets to inspect for. Valid values are `TLS_SNI` and `HTTP_HOST`.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-targettypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-targets", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.StatefulRule": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.StatefulRule`\n\nA single Suricata rules specification, for use in a stateful rule group.\nUse this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options.\nFor information about the Suricata `Rules` format, see\n[Rules Format](https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nDefines what Network Firewall should do with the packets in a traffic flow when the flow\nmatches the stateful rule criteria. For all actions, Network Firewall performs the specified\naction 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\n intended destination.\n* **DROP** - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the firewall\n logging configuration.\n* **REJECT** - Drops traffic that matches the conditions of the stateful rule and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. `REJECT` is available only for TCP traffic.\n* **ALERT** - Permits the packets to go to the\n intended destination and sends an alert log message, if alert logging is configured in the firewall\n logging configuration.\n \n You can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with `ALERT` action, verify in the logs that the rule\n is filtering as you want, then change the action to `DROP`.\n* **REJECT** - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the firewall\n logging configuration.\n \n `REJECT` isn't currently available for use with IMAP and FTP protocols.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PASS | DROP | ALERT | REJEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PASS", "DROP", "ALERT", "REJECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Header": { "MarkdownDocumentation": "`Header`\n\nThe stateful inspection criteria for this rule, used to inspect traffic flows.\n*Required*: Yes\n*Type*: [Header](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-header", "UpdateType": "Mutable", "Required": true, "Type": "Header" }, "RuleOptions": { "MarkdownDocumentation": "`RuleOptions`\n\nAdditional settings for a stateful rule, provided as keywords and settings.\n*Required*: Yes\n*Type*: Array of [RuleOption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-ruleoptions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RuleOption", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.StatefulRuleOptions": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.StatefulRuleOptions`\n\nAdditional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulruleoptions.html", "Properties": { "RuleOrder": { "MarkdownDocumentation": "`RuleOrder`\n\nIndicates how to manage the order of the rule evaluation for the rule group. `DEFAULT_ACTION_ORDER` is\nthe default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\nbased on certain settings. For more information, see\n[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 | STRI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT_ACTION_ORDER", "STRICT_ORDER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulruleoptions.html#cfn-networkfirewall-rulegroup-statefulruleoptions-ruleorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::RuleGroup.StatelessRule": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.StatelessRule`\n\nA single stateless rule. This is used in `StatelessRulesAndCustomActions`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html", "Properties": { "Priority": { "MarkdownDocumentation": "`Priority`\n\nIndicates the order in which to run this rule relative to all of the\nrules that are defined for a stateless rule group. Network Firewall evaluates the rules in a\nrule group starting with the lowest priority setting. You must ensure that the priority\nsettings are unique for the rule group.\nEach stateless rule group uses exactly one `StatelessRulesAndCustomActions`\nobject, and each `StatelessRulesAndCustomActions` contains exactly one\n`StatelessRules` object. To ensure unique priority settings for your rule\ngroups, set unique priorities for the stateless rules that you define inside any single\n`StatelessRules` object.\nYou can change the priority settings of your rules at any time. To make it easier to\ninsert rules later, number them so there's a wide range in between, for example use 100,\n200, and so on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html#cfn-networkfirewall-rulegroup-statelessrule-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "RuleDefinition": { "MarkdownDocumentation": "`RuleDefinition`\n\nDefines the stateless 5-tuple packet inspection criteria and the action to take on a\npacket that matches the criteria.\n*Required*: Yes\n*Type*: [RuleDefinition](./aws-properties-networkfirewall-rulegroup-ruledefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html#cfn-networkfirewall-rulegroup-statelessrule-ruledefinition", "UpdateType": "Mutable", "Required": true, "Type": "RuleDefinition" } } }, "AWS::NetworkFirewall::RuleGroup.StatelessRulesAndCustomActions": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.StatelessRulesAndCustomActions`\n\nStateless inspection criteria. Each stateless rule group uses exactly one of these data\ntypes to define its stateless rules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html", "Properties": { "StatelessRules": { "MarkdownDocumentation": "`StatelessRules`\n\nDefines the set of stateless rules for use in a stateless rule group.\n*Required*: Yes\n*Type*: Array of [StatelessRule](./aws-properties-networkfirewall-rulegroup-statelessrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html#cfn-networkfirewall-rulegroup-statelessrulesandcustomactions-statelessrules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "StatelessRule", "DuplicatesAllowed": true }, "CustomActions": { "MarkdownDocumentation": "`CustomActions`\n\nDefines an array of individual custom action definitions that are available for use by\nthe stateless rules in this `StatelessRulesAndCustomActions` specification. You\nname each custom action that you define, and then you can use it by name in your stateless rule definition\n`Actions` specification.\n*Required*: No\n*Type*: Array of [CustomAction](./aws-properties-networkfirewall-rulegroup-customaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html#cfn-networkfirewall-rulegroup-statelessrulesandcustomactions-customactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomAction", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.SummaryConfiguration": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.SummaryConfiguration`\n\nA complex type that specifies which Suricata rule metadata fields to use when displaying threat information. Contains:\n* `RuleOptions` - The Suricata rule options fields to extract and display\nThese settings affect how threat information appears in both the console and API responses. Summaries are available for rule groups you manage and for active threat defense AWS managed rule groups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-summaryconfiguration.html", "Properties": { "RuleOptions": { "MarkdownDocumentation": "`RuleOptions`\n\nSpecifies the selected rule options returned by `DescribeRuleGroupSummary`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-summaryconfiguration.html#cfn-networkfirewall-rulegroup-summaryconfiguration-ruleoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::RuleGroup.TCPFlagField": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup.TCPFlagField`\n\nTCP flags and masks to inspect packets for. This is used in the match attributes\nspecification.\nFor example:\n`\"TCPFlags\": [\n{\n\"Flags\": [\n\"ECE\",\n\"SYN\"\n],\n\"Masks\": [\n\"SYN\",\n\"ECE\"\n]\n}\n]`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html", "Properties": { "Flags": { "MarkdownDocumentation": "`Flags`\n\nUsed 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-flags", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Masks": { "MarkdownDocumentation": "`Masks`\n\nThe 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-masks", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::TLSInspectionConfiguration.Address": { "MarkdownDocumentation": "`AWS::NetworkFirewall::TLSInspectionConfiguration.Address`\n\nA single IP address specification. This is used in the [MatchAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html)\nsource and destination settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-address.html", "Properties": { "AddressDefinition": { "MarkdownDocumentation": "`AddressDefinition`\n\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\nInter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-fA-F\\d:\\.]+/\\d{1,3})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-address.html#cfn-networkfirewall-tlsinspectionconfiguration-address-addressdefinition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::TLSInspectionConfiguration.CheckCertificateRevocationStatus": { "MarkdownDocumentation": "`AWS::NetworkFirewall::TLSInspectionConfiguration.CheckCertificateRevocationStatus`\n\nWhen enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a `CertificateAuthorityArn` in [ServerCertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-networkfirewall-servercertificateconfiguration.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html", "Properties": { "UnknownStatusAction": { "MarkdownDocumentation": "`UnknownStatusAction`\n\nConfigures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate.\n* **PASS** - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.\n* **DROP** - Network Firewall closes the connection and drops subsequent packets for that connection.\n* **REJECT** - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. `REJECT` is available only for TCP traffic.\n*Required*: No\n*Type*: String\n*Allowed values*: `PASS | DROP | REJECT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PASS", "DROP", "REJECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html#cfn-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus-unknownstatusaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RevokedStatusAction": { "MarkdownDocumentation": "`RevokedStatusAction`\n\nConfigures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status.\n* **PASS** - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.\n* **DROP** - Network Firewall closes the connection and drops subsequent packets for that connection.\n* **REJECT** - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. `REJECT` is available only for TCP traffic.\n*Required*: No\n*Type*: String\n*Allowed values*: `PASS | DROP | REJECT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PASS", "DROP", "REJECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html#cfn-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus-revokedstatusaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::TLSInspectionConfiguration.PortRange": { "MarkdownDocumentation": "`AWS::NetworkFirewall::TLSInspectionConfiguration.PortRange`\n\nA single port range specification. This is used for source and destination port ranges\nin the stateless rule [MatchAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html), `SourcePorts`, and\n`DestinationPorts` settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-portrange.html", "Properties": { "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nThe lower limit of the port range. This must be less than or equal to the\n`ToPort` specification.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-portrange.html#cfn-networkfirewall-tlsinspectionconfiguration-portrange-fromport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nThe upper limit of the port range. This must be greater than or equal to the\n`FromPort` specification.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-portrange.html#cfn-networkfirewall-tlsinspectionconfiguration-portrange-toport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::NetworkFirewall::TLSInspectionConfiguration.ServerCertificate": { "MarkdownDocumentation": "`AWS::NetworkFirewall::TLSInspectionConfiguration.ServerCertificate`\n\nAny AWS Certificate Manager (ACM) Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a [ServerCertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html). Used in a [TLSInspectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-networkfirewall-tlsinspectionconfiguration.html) for inspection of inbound traffic to your firewall. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. AWS Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in AWS Certificate Manager, see [Request a public certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) or [Importing certificates](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *AWS Certificate Manager User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificate.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the AWS Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificate.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificate-resourcearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkFirewall::TLSInspectionConfiguration.ServerCertificateConfiguration": { "MarkdownDocumentation": "`AWS::NetworkFirewall::TLSInspectionConfiguration.ServerCertificateConfiguration`\n\nConfigures the AWS Certificate Manager certificates and scope that Network Firewall uses to decrypt and re-encrypt traffic using a [TLSInspectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-networkfirewall-tlsinspectionconfiguration.html). You can configure `ServerCertificates` for inbound SSL/TLS inspection, a `CertificateAuthorityArn` for outbound SSL/TLS inspection, or both. For information about working with certificates for TLS inspection, see [Using SSL/TLS server certficiates with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) in the *AWS Network Firewall Developer Guide*.\n###### Note\nIf a server certificate that's associated with your [TLSInspectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-networkfirewall-tlsinspectionconfiguration.html) is revoked, deleted, or expired it can result in client-side TLS errors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html", "Properties": { "CertificateAuthorityArn": { "MarkdownDocumentation": "`CertificateAuthorityArn`\n\nThe Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within AWS Certificate Manager (ACM) to use for outbound SSL/TLS inspection.\nThe following limitations apply:\n* You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.\n* You can't use certificates issued by AWS Private Certificate Authority.\nFor more information about configuring certificates for outbound inspection, see [Using SSL/TLS certificates with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) in the *AWS Network Firewall Developer Guide*.\nFor information about working with certificates in ACM, see [Importing certificates](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *AWS Certificate Manager User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-certificateauthorityarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CheckCertificateRevocationStatus": { "MarkdownDocumentation": "`CheckCertificateRevocationStatus`\n\nWhen enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a `CertificateAuthorityArn` in [ServerCertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-networkfirewall-servercertificateconfiguration.html).\n*Required*: No\n*Type*: [CheckCertificateRevocationStatus](./aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-checkcertificaterevocationstatus", "UpdateType": "Mutable", "Required": false, "Type": "CheckCertificateRevocationStatus" }, "Scopes": { "MarkdownDocumentation": "`Scopes`\n\nA list of scopes.\n*Required*: No\n*Type*: Array of [ServerCertificateScope](./aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-scopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServerCertificateScope", "DuplicatesAllowed": true }, "ServerCertificates": { "MarkdownDocumentation": "`ServerCertificates`\n\nThe list of server certificates to use for inbound SSL/TLS inspection.\n*Required*: No\n*Type*: Array of [ServerCertificate](./aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-servercertificates", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServerCertificate", "DuplicatesAllowed": false } } }, "AWS::NetworkFirewall::TLSInspectionConfiguration.ServerCertificateScope": { "MarkdownDocumentation": "`AWS::NetworkFirewall::TLSInspectionConfiguration.ServerCertificateScope`\n\nSettings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html", "Properties": { "Protocols": { "MarkdownDocumentation": "`Protocols`\n\nThe protocols to inspect for, specified using the assigned internet protocol number (IANA)\nfor each protocol. If not specified, this matches with any protocol.\nNetwork Firewall currently supports only TCP.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-protocols", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "DestinationPorts": { "MarkdownDocumentation": "`DestinationPorts`\n\nThe destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.\nYou can specify individual ports, for example `1994`, and you can specify port ranges, such as `1990:1994`.\n*Required*: No\n*Type*: Array of [PortRange](./aws-properties-networkfirewall-tlsinspectionconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-destinationports", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": true }, "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nThe destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this\nmatches with any destination address.\n*Required*: No\n*Type*: Array of [Address](./aws-properties-networkfirewall-tlsinspectionconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-destinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Address", "DuplicatesAllowed": true }, "Sources": { "MarkdownDocumentation": "`Sources`\n\nThe source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this\nmatches with any source address.\n*Required*: No\n*Type*: Array of [Address](./aws-properties-networkfirewall-tlsinspectionconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-sources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Address", "DuplicatesAllowed": true }, "SourcePorts": { "MarkdownDocumentation": "`SourcePorts`\n\nThe source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.\nYou can specify individual ports, for example `1994`, and you can specify port ranges, such as `1990:1994`.\n*Required*: No\n*Type*: Array of [PortRange](./aws-properties-networkfirewall-tlsinspectionconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-sourceports", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::TLSInspectionConfiguration.TLSInspectionConfiguration": { "MarkdownDocumentation": "`AWS::NetworkFirewall::TLSInspectionConfiguration.TLSInspectionConfiguration`\n\nThe object that defines a TLS inspection configuration. This defines the TLS inspection configuration.\nAWS Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.\nTo use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS\ninspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the *AWS Network Firewall Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration.html", "Properties": { "ServerCertificateConfigurations": { "MarkdownDocumentation": "`ServerCertificateConfigurations`\n\nLists the server certificate configurations that are associated with the TLS configuration.\n*Required*: No\n*Type*: Array of [ServerCertificateConfiguration](./aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration-servercertificateconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServerCertificateConfiguration", "DuplicatesAllowed": true } } }, "AWS::NetworkFirewall::VpcEndpointAssociation.SubnetMapping": { "MarkdownDocumentation": "`AWS::NetworkFirewall::VpcEndpointAssociation.SubnetMapping`\n\nThe ID for a subnet that's used in an association with a firewall. This is used in\n`CreateFirewall`, `AssociateSubnets`, and `CreateVpcEndpointAssociation`. AWS Network Firewall\ncreates an instance of the associated firewall in each subnet that you specify, to filter\ntraffic in the subnet's Availability Zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-vpcendpointassociation-subnetmapping.html", "Properties": { "IPAddressType": { "MarkdownDocumentation": "`IPAddressType`\n\nThe 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 | IPV6...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DUALSTACK", "IPV4", "IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-vpcendpointassociation-subnetmapping.html#cfn-networkfirewall-vpcendpointassociation-subnetmapping-ipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe unique identifier for the subnet.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-vpcendpointassociation-subnetmapping.html#cfn-networkfirewall-vpcendpointassociation-subnetmapping-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkManager::ConnectAttachment.ConnectAttachmentOptions": { "MarkdownDocumentation": "`AWS::NetworkManager::ConnectAttachment.ConnectAttachmentOptions`\n\nDescribes a core network Connect attachment options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-connectattachmentoptions.html", "Properties": { "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol used for the attachment connection.\n*Required*: No\n*Type*: String\n*Allowed values*: `GRE | NO_ENCAP...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "GRE", "NO_ENCAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-connectattachmentoptions.html#cfn-networkmanager-connectattachment-connectattachmentoptions-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::ConnectAttachment.ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`AWS::NetworkManager::ConnectAttachment.ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-proposednetworkfunctiongroupchange.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of proposed changes to the key-value tags associated with the network function group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-connectattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-connectattachment-proposednetworkfunctiongroupchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "NetworkFunctionGroupName": { "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe proposed name change for the network function group name.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-connectattachment-proposednetworkfunctiongroupchange-networkfunctiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe proposed new attachment policy rule number for the network function 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-connectattachment-proposednetworkfunctiongroupchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::ConnectAttachment.ProposedSegmentChange": { "MarkdownDocumentation": "`AWS::NetworkManager::ConnectAttachment.ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-proposedsegmentchange.html", "Properties": { "SegmentName": { "MarkdownDocumentation": "`SegmentName`\n\nThe name of the segment to change.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-proposedsegmentchange.html#cfn-networkmanager-connectattachment-proposedsegmentchange-segmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value tags that changed for the segment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-connectattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-proposedsegmentchange.html#cfn-networkmanager-connectattachment-proposedsegmentchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-proposedsegmentchange.html#cfn-networkmanager-connectattachment-proposedsegmentchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::ConnectPeer.BgpOptions": { "MarkdownDocumentation": "`AWS::NetworkManager::ConnectPeer.BgpOptions`\n\nDescribes the BGP options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-bgpoptions.html", "Properties": { "PeerAsn": { "MarkdownDocumentation": "`PeerAsn`\n\nThe Peer ASN of the BGP.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-bgpoptions.html#cfn-networkmanager-connectpeer-bgpoptions-peerasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::NetworkManager::ConnectPeer.ConnectPeerBgpConfiguration": { "MarkdownDocumentation": "`AWS::NetworkManager::ConnectPeer.ConnectPeerBgpConfiguration`\n\nDescribes a core network BGP configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerbgpconfiguration.html", "Properties": { "PeerAddress": { "MarkdownDocumentation": "`PeerAddress`\n\nThe address of a core network Connect peer.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerbgpconfiguration.html#cfn-networkmanager-connectpeer-connectpeerbgpconfiguration-peeraddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CoreNetworkAddress": { "MarkdownDocumentation": "`CoreNetworkAddress`\n\nThe address of a core network.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerbgpconfiguration.html#cfn-networkmanager-connectpeer-connectpeerbgpconfiguration-corenetworkaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PeerAsn": { "MarkdownDocumentation": "`PeerAsn`\n\nThe ASN of the Connect peer.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerbgpconfiguration.html#cfn-networkmanager-connectpeer-connectpeerbgpconfiguration-peerasn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "CoreNetworkAsn": { "MarkdownDocumentation": "`CoreNetworkAsn`\n\nThe ASN of the Coret Network.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerbgpconfiguration.html#cfn-networkmanager-connectpeer-connectpeerbgpconfiguration-corenetworkasn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::NetworkManager::ConnectPeer.ConnectPeerConfiguration": { "MarkdownDocumentation": "`AWS::NetworkManager::ConnectPeer.ConnectPeerConfiguration`\n\nDescribes a core network Connect peer configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerconfiguration.html", "Properties": { "BgpConfigurations": { "MarkdownDocumentation": "`BgpConfigurations`\n\nThe Connect peer BGP configurations.\n*Required*: No\n*Type*: Array of [ConnectPeerBgpConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerconfiguration.html#cfn-networkmanager-connectpeer-connectpeerconfiguration-bgpconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConnectPeerBgpConfiguration", "DuplicatesAllowed": true }, "PeerAddress": { "MarkdownDocumentation": "`PeerAddress`\n\nThe IP address of the Connect peer.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerconfiguration.html#cfn-networkmanager-connectpeer-connectpeerconfiguration-peeraddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CoreNetworkAddress": { "MarkdownDocumentation": "`CoreNetworkAddress`\n\nThe IP address of a core network.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerconfiguration.html#cfn-networkmanager-connectpeer-connectpeerconfiguration-corenetworkaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InsideCidrBlocks": { "MarkdownDocumentation": "`InsideCidrBlocks`\n\nThe inside IP addresses used for a Connect peer configuration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerconfiguration.html#cfn-networkmanager-connectpeer-connectpeerconfiguration-insidecidrblocks", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol used for a Connect peer configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `GRE | NO_ENCAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GRE", "NO_ENCAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerconfiguration.html#cfn-networkmanager-connectpeer-connectpeerconfiguration-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::CoreNetwork.CoreNetworkEdge": { "MarkdownDocumentation": "`AWS::NetworkManager::CoreNetwork.CoreNetworkEdge`\n\nDescribes a core network edge.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworkedge.html", "Properties": { "InsideCidrBlocks": { "MarkdownDocumentation": "`InsideCidrBlocks`\n\nThe inside IP addresses used for core network edges.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworkedge.html#cfn-networkmanager-corenetwork-corenetworkedge-insidecidrblocks", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Asn": { "MarkdownDocumentation": "`Asn`\n\nThe ASN of a core network edge.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworkedge.html#cfn-networkmanager-corenetwork-corenetworkedge-asn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "EdgeLocation": { "MarkdownDocumentation": "`EdgeLocation`\n\nThe Region where a core network edge is located.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworkedge.html#cfn-networkmanager-corenetwork-corenetworkedge-edgelocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::CoreNetwork.CoreNetworkNetworkFunctionGroup": { "MarkdownDocumentation": "`AWS::NetworkManager::CoreNetwork.CoreNetworkNetworkFunctionGroup`\n\nDescribes a network function group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworknetworkfunctiongroup.html", "Properties": { "EdgeLocations": { "MarkdownDocumentation": "`EdgeLocations`\n\nThe core network edge locations.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworknetworkfunctiongroup.html#cfn-networkmanager-corenetwork-corenetworknetworkfunctiongroup-edgelocations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Segments": { "MarkdownDocumentation": "`Segments`\n\nThe segments associated with the network function group.\n*Required*: No\n*Type*: [Segments](./aws-properties-networkmanager-corenetwork-segments.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworknetworkfunctiongroup.html#cfn-networkmanager-corenetwork-corenetworknetworkfunctiongroup-segments", "UpdateType": "Mutable", "Required": false, "Type": "Segments" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the network function group.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworknetworkfunctiongroup.html#cfn-networkmanager-corenetwork-corenetworknetworkfunctiongroup-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::CoreNetwork.CoreNetworkSegment": { "MarkdownDocumentation": "`AWS::NetworkManager::CoreNetwork.CoreNetworkSegment`\n\nDescribes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworksegment.html", "Properties": { "EdgeLocations": { "MarkdownDocumentation": "`EdgeLocations`\n\nThe Regions where the edges are located.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworksegment.html#cfn-networkmanager-corenetwork-corenetworksegment-edgelocations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SharedSegments": { "MarkdownDocumentation": "`SharedSegments`\n\nThe shared segments of a core network.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworksegment.html#cfn-networkmanager-corenetwork-corenetworksegment-sharedsegments", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a core network segment.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-corenetworksegment.html#cfn-networkmanager-corenetwork-corenetworksegment-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::CoreNetwork.Segments": { "MarkdownDocumentation": "`AWS::NetworkManager::CoreNetwork.Segments`\n\nThe `Segments` property type specifies Property description not available. for an [AWS::NetworkManager::CoreNetwork](./aws-resource-networkmanager-corenetwork.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-segments.html", "Properties": { "SendTo": { "MarkdownDocumentation": "`SendTo`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-segments.html#cfn-networkmanager-corenetwork-segments-sendto", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SendVia": { "MarkdownDocumentation": "`SendVia`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-corenetwork-segments.html#cfn-networkmanager-corenetwork-segments-sendvia", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::NetworkManager::Device.AWSLocation": { "MarkdownDocumentation": "`AWS::NetworkManager::Device.AWSLocation`\n\nSpecifies a location in AWS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-device-awslocation.html", "Properties": { "Zone": { "MarkdownDocumentation": "`Zone`\n\nThe Zone that the device is located in. Specify the ID of an Availability Zone, Local\nZone, Wavelength Zone, or an Outpost.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-device-awslocation.html#cfn-networkmanager-device-awslocation-zone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetArn": { "MarkdownDocumentation": "`SubnetArn`\n\nThe Amazon Resource Name (ARN) of the subnet that the device is located in.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\\/subnet-[0-9a-f]{8,17}$|^$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-device-awslocation.html#cfn-networkmanager-device-awslocation-subnetarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::Device.Location": { "MarkdownDocumentation": "`AWS::NetworkManager::Device.Location`\n\nDescribes a location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-device-location.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe physical address.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-device-location.html#cfn-networkmanager-device-location-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Latitude": { "MarkdownDocumentation": "`Latitude`\n\nThe latitude.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-device-location.html#cfn-networkmanager-device-location-latitude", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Longitude": { "MarkdownDocumentation": "`Longitude`\n\nThe longitude.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-device-location.html#cfn-networkmanager-device-location-longitude", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::DirectConnectGatewayAttachment.ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`AWS::NetworkManager::DirectConnectGatewayAttachment.ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of proposed changes to the key-value tags associated with the network function group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-directconnectgatewayattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "NetworkFunctionGroupName": { "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe proposed name change for the network function group name.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange-networkfunctiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe proposed new attachment policy rule number for the network function 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::DirectConnectGatewayAttachment.ProposedSegmentChange": { "MarkdownDocumentation": "`AWS::NetworkManager::DirectConnectGatewayAttachment.ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-directconnectgatewayattachment-proposedsegmentchange.html", "Properties": { "SegmentName": { "MarkdownDocumentation": "`SegmentName`\n\nThe name of the segment to change.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-directconnectgatewayattachment-proposedsegmentchange.html#cfn-networkmanager-directconnectgatewayattachment-proposedsegmentchange-segmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value tags that changed for the segment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-directconnectgatewayattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-directconnectgatewayattachment-proposedsegmentchange.html#cfn-networkmanager-directconnectgatewayattachment-proposedsegmentchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-directconnectgatewayattachment-proposedsegmentchange.html#cfn-networkmanager-directconnectgatewayattachment-proposedsegmentchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::Link.Bandwidth": { "MarkdownDocumentation": "`AWS::NetworkManager::Link.Bandwidth`\n\nDescribes bandwidth information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-link-bandwidth.html", "Properties": { "DownloadSpeed": { "MarkdownDocumentation": "`DownloadSpeed`\n\nDownload speed in Mbps.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-link-bandwidth.html#cfn-networkmanager-link-bandwidth-downloadspeed", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UploadSpeed": { "MarkdownDocumentation": "`UploadSpeed`\n\nUpload speed in Mbps.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-link-bandwidth.html#cfn-networkmanager-link-bandwidth-uploadspeed", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::Site.Location": { "MarkdownDocumentation": "`AWS::NetworkManager::Site.Location`\n\nDescribes a location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-site-location.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe physical address.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-site-location.html#cfn-networkmanager-site-location-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Latitude": { "MarkdownDocumentation": "`Latitude`\n\nThe latitude.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-site-location.html#cfn-networkmanager-site-location-latitude", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Longitude": { "MarkdownDocumentation": "`Longitude`\n\nThe longitude.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-site-location.html#cfn-networkmanager-site-location-longitude", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::SiteToSiteVpnAttachment.ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`AWS::NetworkManager::SiteToSiteVpnAttachment.ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of proposed changes to the key-value tags associated with the network function group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-sitetositevpnattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "NetworkFunctionGroupName": { "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe proposed name change for the network function group name.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange-networkfunctiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe proposed new attachment policy rule number for the network function 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::SiteToSiteVpnAttachment.ProposedSegmentChange": { "MarkdownDocumentation": "`AWS::NetworkManager::SiteToSiteVpnAttachment.ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-sitetositevpnattachment-proposedsegmentchange.html", "Properties": { "SegmentName": { "MarkdownDocumentation": "`SegmentName`\n\nThe name of the segment to change.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-sitetositevpnattachment-proposedsegmentchange.html#cfn-networkmanager-sitetositevpnattachment-proposedsegmentchange-segmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value tags that changed for the segment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-sitetositevpnattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-sitetositevpnattachment-proposedsegmentchange.html#cfn-networkmanager-sitetositevpnattachment-proposedsegmentchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-sitetositevpnattachment-proposedsegmentchange.html#cfn-networkmanager-sitetositevpnattachment-proposedsegmentchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::TransitGatewayRouteTableAttachment.ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`AWS::NetworkManager::TransitGatewayRouteTableAttachment.ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of proposed changes to the key-value tags associated with the network function group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-transitgatewayroutetableattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "NetworkFunctionGroupName": { "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe proposed name change for the network function group name.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange-networkfunctiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe proposed new attachment policy rule number for the network function 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::TransitGatewayRouteTableAttachment.ProposedSegmentChange": { "MarkdownDocumentation": "`AWS::NetworkManager::TransitGatewayRouteTableAttachment.ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange.html", "Properties": { "SegmentName": { "MarkdownDocumentation": "`SegmentName`\n\nThe name of the segment to change.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange.html#cfn-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange-segmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value tags that changed for the segment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-transitgatewayroutetableattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange.html#cfn-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange.html#cfn-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::VpcAttachment.ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`AWS::NetworkManager::VpcAttachment.ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-proposednetworkfunctiongroupchange.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of proposed changes to the key-value tags associated with the network function group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-vpcattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-vpcattachment-proposednetworkfunctiongroupchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "NetworkFunctionGroupName": { "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe proposed name change for the network function group name.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-vpcattachment-proposednetworkfunctiongroupchange-networkfunctiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe proposed new attachment policy rule number for the network function 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-proposednetworkfunctiongroupchange.html#cfn-networkmanager-vpcattachment-proposednetworkfunctiongroupchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::VpcAttachment.ProposedSegmentChange": { "MarkdownDocumentation": "`AWS::NetworkManager::VpcAttachment.ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-proposedsegmentchange.html", "Properties": { "SegmentName": { "MarkdownDocumentation": "`SegmentName`\n\nThe name of the segment to change.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-proposedsegmentchange.html#cfn-networkmanager-vpcattachment-proposedsegmentchange-segmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value tags that changed for the segment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-vpcattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-proposedsegmentchange.html#cfn-networkmanager-vpcattachment-proposedsegmentchange-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AttachmentPolicyRuleNumber": { "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-proposedsegmentchange.html#cfn-networkmanager-vpcattachment-proposedsegmentchange-attachmentpolicyrulenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::NetworkManager::VpcAttachment.VpcOptions": { "MarkdownDocumentation": "`AWS::NetworkManager::VpcAttachment.VpcOptions`\n\nDescribes the VPC options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-vpcoptions.html", "Properties": { "Ipv6Support": { "MarkdownDocumentation": "`Ipv6Support`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-vpcoptions.html#cfn-networkmanager-vpcattachment-vpcoptions-ipv6support", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ApplianceModeSupport": { "MarkdownDocumentation": "`ApplianceModeSupport`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-vpcoptions.html#cfn-networkmanager-vpcattachment-vpcoptions-appliancemodesupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SecurityGroupReferencingSupport": { "MarkdownDocumentation": "`SecurityGroupReferencingSupport`\n\nIndicates whether security group referencing is enabled for this VPC attachment. The default is `true`. However, at the core network policy-level the default is set 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-vpcoptions.html#cfn-networkmanager-vpcattachment-vpcoptions-securitygroupreferencingsupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DnsSupport": { "MarkdownDocumentation": "`DnsSupport`\n\nIndicates whether DNS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-vpcoptions.html#cfn-networkmanager-vpcattachment-vpcoptions-dnssupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::NimbleStudio::Studio.StudioEncryptionConfiguration": { "MarkdownDocumentation": "`AWS::NimbleStudio::Studio.StudioEncryptionConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studio-studioencryptionconfiguration.html", "Properties": { "KeyType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studio-studioencryptionconfiguration.html#cfn-nimblestudio-studio-studioencryptionconfiguration-keytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studio-studioencryptionconfiguration.html#cfn-nimblestudio-studio-studioencryptionconfiguration-keyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ODB::CloudAutonomousVmCluster.MaintenanceWindow": { "MarkdownDocumentation": "`AWS::ODB::CloudAutonomousVmCluster.MaintenanceWindow`\n\nThe scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.html", "Properties": { "DaysOfWeek": { "MarkdownDocumentation": "`DaysOfWeek`\n\nThe days of the week when maintenance can be performed.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `MONDAY | TUESDAY | WEDNESDA...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.html#cfn-odb-cloudautonomousvmcluster-maintenancewindow-daysofweek", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Preference": { "MarkdownDocumentation": "`Preference`\n\nThe preference for the maintenance window scheduling.\n*Required*: No\n*Type*: String\n*Allowed values*: `NO_PREFERENCE | CUSTOM_PREF...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "NO_PREFERENCE", "CUSTOM_PREFERENCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.html#cfn-odb-cloudautonomousvmcluster-maintenancewindow-preference", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LeadTimeInWeeks": { "MarkdownDocumentation": "`LeadTimeInWeeks`\n\nThe lead time in weeks before the maintenance window.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `4`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.html#cfn-odb-cloudautonomousvmcluster-maintenancewindow-leadtimeinweeks", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Months": { "MarkdownDocumentation": "`Months`\n\nThe months when maintenance can be performed.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `JANUARY | FEBRUARY | MARCH ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.html#cfn-odb-cloudautonomousvmcluster-maintenancewindow-months", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "WeeksOfMonth": { "MarkdownDocumentation": "`WeeksOfMonth`\n\nThe weeks of the month when maintenance can be performed.\n*Required*: No\n*Type*: Array of Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.html#cfn-odb-cloudautonomousvmcluster-maintenancewindow-weeksofmonth", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "HoursOfDay": { "MarkdownDocumentation": "`HoursOfDay`\n\nThe hours of the day when maintenance can be performed.\n*Required*: No\n*Type*: Array of Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.html#cfn-odb-cloudautonomousvmcluster-maintenancewindow-hoursofday", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true } } }, "AWS::ODB::CloudExadataInfrastructure.CustomerContact": { "MarkdownDocumentation": "`AWS::ODB::CloudExadataInfrastructure.CustomerContact`\n\nA contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-customercontact.html", "Properties": { "Email": { "MarkdownDocumentation": "`Email`\n\nThe email address of the contact.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `320`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-customercontact.html#cfn-odb-cloudexadatainfrastructure-customercontact-email", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ODB::CloudExadataInfrastructure.MaintenanceWindow": { "MarkdownDocumentation": "`AWS::ODB::CloudExadataInfrastructure.MaintenanceWindow`\n\nThe scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html", "Properties": { "CustomActionTimeoutInMins": { "MarkdownDocumentation": "`CustomActionTimeoutInMins`\n\nThe custom action timeout in minutes for the maintenance window.\n*Required*: No\n*Type*: Integer\n*Minimum*: `15`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-customactiontimeoutinmins", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DaysOfWeek": { "MarkdownDocumentation": "`DaysOfWeek`\n\nThe days of the week when maintenance can be performed.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `MONDAY | TUESDAY | WEDNESDA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-daysofweek", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Preference": { "MarkdownDocumentation": "`Preference`\n\nThe preference for the maintenance window scheduling.\n*Required*: No\n*Type*: String\n*Allowed values*: `NO_PREFERENCE | CUSTOM_PREF...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NO_PREFERENCE", "CUSTOM_PREFERENCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-preference", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LeadTimeInWeeks": { "MarkdownDocumentation": "`LeadTimeInWeeks`\n\nThe lead time in weeks before the maintenance window.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-leadtimeinweeks", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Months": { "MarkdownDocumentation": "`Months`\n\nThe months when maintenance can be performed.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `JANUARY | FEBRUARY | MARCH ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-months", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PatchingMode": { "MarkdownDocumentation": "`PatchingMode`\n\nThe patching mode for the maintenance window.\n*Required*: No\n*Type*: String\n*Allowed values*: `ROLLING | NONROLLING...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROLLING", "NONROLLING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-patchingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WeeksOfMonth": { "MarkdownDocumentation": "`WeeksOfMonth`\n\nThe weeks of the month when maintenance can be performed.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-weeksofmonth", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": false }, "IsCustomActionTimeoutEnabled": { "MarkdownDocumentation": "`IsCustomActionTimeoutEnabled`\n\nIndicates whether custom action timeout is enabled for the maintenance window.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-iscustomactiontimeoutenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "HoursOfDay": { "MarkdownDocumentation": "`HoursOfDay`\n\nThe hours of the day when maintenance can be performed.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow-hoursofday", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": false } } }, "AWS::ODB::CloudVmCluster.DataCollectionOptions": { "MarkdownDocumentation": "`AWS::ODB::CloudVmCluster.DataCollectionOptions`\n\nInformation about the data collection options enabled for a VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-datacollectionoptions.html", "Properties": { "IsIncidentLogsEnabled": { "MarkdownDocumentation": "`IsIncidentLogsEnabled`\n\nSpecifies whether incident logs are enabled for the VM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-datacollectionoptions.html#cfn-odb-cloudvmcluster-datacollectionoptions-isincidentlogsenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "IsDiagnosticsEventsEnabled": { "MarkdownDocumentation": "`IsDiagnosticsEventsEnabled`\n\nSpecifies whether diagnostic collection is enabled for the VM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-datacollectionoptions.html#cfn-odb-cloudvmcluster-datacollectionoptions-isdiagnosticseventsenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "IsHealthMonitoringEnabled": { "MarkdownDocumentation": "`IsHealthMonitoringEnabled`\n\nSpecifies whether health monitoring is enabled for the VM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-datacollectionoptions.html#cfn-odb-cloudvmcluster-datacollectionoptions-ishealthmonitoringenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ODB::CloudVmCluster.DbNode": { "MarkdownDocumentation": "`AWS::ODB::CloudVmCluster.DbNode`\n\nInformation about a DB node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe current status of the DB node.\n*Required*: No\n*Type*: String\n*Allowed values*: `AVAILABLE | FAILED | PROVIS...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "STOPPING", "STOPPED", "STARTING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-status", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "HostIpId": { "MarkdownDocumentation": "`HostIpId`\n\nThe OCID of the host IP address that's associated with the DB node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-hostipid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "MemorySizeInGBs": { "MarkdownDocumentation": "`MemorySizeInGBs`\n\nThe allocated memory in GBs on the DB node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-memorysizeingbs", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "CpuCoreCount": { "MarkdownDocumentation": "`CpuCoreCount`\n\nNumber of CPU cores enabled on the DB node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-cpucorecount", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "BackupIpId": { "MarkdownDocumentation": "`BackupIpId`\n\nThe Oracle Cloud ID (OCID) of the backup IP address that's associated with the DB node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-backupipid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Hostname": { "MarkdownDocumentation": "`Hostname`\n\nThe host name for the DB node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-hostname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Ocid": { "MarkdownDocumentation": "`Ocid`\n\nThe OCID of the DB node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-ocid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DbNodeId": { "MarkdownDocumentation": "`DbNodeId`\n\nThe unique identifier of the DB node.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_~.-]+`\n*Minimum*: `6`\n*Maximum*: `64`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-dbnodeid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "VnicId": { "MarkdownDocumentation": "`VnicId`\n\nThe OCID of the VNIC.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-vnicid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DbNodeStorageSizeInGBs": { "MarkdownDocumentation": "`DbNodeStorageSizeInGBs`\n\nThe amount of local node storage, in gigabytes (GBs), that's allocated on the DB node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-dbnodestoragesizeingbs", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "Vnic2Id": { "MarkdownDocumentation": "`Vnic2Id`\n\nThe OCID of the second VNIC.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-vnic2id", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DbNodeArn": { "MarkdownDocumentation": "`DbNodeArn`\n\nThe Amazon Resource Name (ARN) of the DB node.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}`\n*Minimum*: `20`\n*Maximum*: `2048`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-dbnodearn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DbServerId": { "MarkdownDocumentation": "`DbServerId`\n\nThe unique identifier of the Db server that is associated with the DB node.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_~.-]+`\n*Minimum*: `6`\n*Maximum*: `64`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-dbserverid", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "BackupVnic2Id": { "MarkdownDocumentation": "`BackupVnic2Id`\n\nThe OCID of the second backup VNIC.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-backupvnic2id", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-odb-cloudvmcluster-tag.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-tags", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "DbSystemId": { "MarkdownDocumentation": "`DbSystemId`\n\nThe OCID of the DB system.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-cloudvmcluster-dbnode.html#cfn-odb-cloudvmcluster-dbnode-dbsystemid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::ODB::OdbNetwork.ManagedS3BackupAccess": { "MarkdownDocumentation": "`AWS::ODB::OdbNetwork.ManagedS3BackupAccess`\n\nThe configuration for managed Amazon S3 backup access from the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-manageds3backupaccess.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the managed Amazon S3 backup access.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | ENABLING | DISABL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-manageds3backupaccess.html#cfn-odb-odbnetwork-manageds3backupaccess-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ipv4Addresses": { "MarkdownDocumentation": "`Ipv4Addresses`\n\nThe IPv4 addresses for the managed Amazon S3 backup access.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-manageds3backupaccess.html#cfn-odb-odbnetwork-manageds3backupaccess-ipv4addresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::ODB::OdbNetwork.ManagedServices": { "MarkdownDocumentation": "`AWS::ODB::OdbNetwork.ManagedServices`\n\nThe managed services configuration for the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html", "Properties": { "ManagedServicesIpv4Cidrs": { "MarkdownDocumentation": "`ManagedServicesIpv4Cidrs`\n\nThe IPv4 CIDR blocks for the managed services.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-managedservicesipv4cidrs", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ResourceGatewayArn": { "MarkdownDocumentation": "`ResourceGatewayArn`\n\nThe Amazon Resource Name (ARN) of the resource gateway.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-resourcegatewayarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManagedS3BackupAccess": { "MarkdownDocumentation": "`ManagedS3BackupAccess`\n\nThe managed Amazon S3 backup access configuration.\n*Required*: No\n*Type*: [ManagedS3BackupAccess](./aws-properties-odb-odbnetwork-manageds3backupaccess.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-manageds3backupaccess", "UpdateType": "Mutable", "Required": false, "Type": "ManagedS3BackupAccess" }, "ServiceNetworkEndpoint": { "MarkdownDocumentation": "`ServiceNetworkEndpoint`\n\nThe service network endpoint configuration.\n*Required*: No\n*Type*: [ServiceNetworkEndpoint](./aws-properties-odb-odbnetwork-servicenetworkendpoint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-servicenetworkendpoint", "UpdateType": "Mutable", "Required": false, "Type": "ServiceNetworkEndpoint" }, "ZeroEtlAccess": { "MarkdownDocumentation": "`ZeroEtlAccess`\n\nThe Zero-ETL access configuration.\n*Required*: No\n*Type*: [ZeroEtlAccess](./aws-properties-odb-odbnetwork-zeroetlaccess.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-zeroetlaccess", "UpdateType": "Mutable", "Required": false, "Type": "ZeroEtlAccess" }, "ServiceNetworkArn": { "MarkdownDocumentation": "`ServiceNetworkArn`\n\nThe Amazon Resource Name (ARN) of the service network.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-servicenetworkarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Access": { "MarkdownDocumentation": "`S3Access`\n\nThe Amazon S3 access configuration.\n*Required*: No\n*Type*: [S3Access](./aws-properties-odb-odbnetwork-s3access.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-s3access", "UpdateType": "Mutable", "Required": false, "Type": "S3Access" } } }, "AWS::ODB::OdbNetwork.S3Access": { "MarkdownDocumentation": "`AWS::ODB::OdbNetwork.S3Access`\n\nThe configuration for Amazon S3 access from the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the Amazon S3 access.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | ENABLING | DISABL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html#cfn-odb-odbnetwork-s3access-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ipv4Addresses": { "MarkdownDocumentation": "`Ipv4Addresses`\n\nThe IPv4 addresses for the Amazon S3 access.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html#cfn-odb-odbnetwork-s3access-ipv4addresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name for the Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html#cfn-odb-odbnetwork-s3access-domainname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3PolicyDocument": { "MarkdownDocumentation": "`S3PolicyDocument`\n\nThe endpoint policy for the Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html#cfn-odb-odbnetwork-s3access-s3policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ODB::OdbNetwork.ServiceNetworkEndpoint": { "MarkdownDocumentation": "`AWS::ODB::OdbNetwork.ServiceNetworkEndpoint`\n\nThe configuration for a service network endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-servicenetworkendpoint.html", "Properties": { "VpcEndpointType": { "MarkdownDocumentation": "`VpcEndpointType`\n\nThe type of the VPC endpoint.\n*Required*: No\n*Type*: String\n*Allowed values*: `SERVICENETWORK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SERVICENETWORK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-servicenetworkendpoint.html#cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe identifier 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-servicenetworkendpoint.html#cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ODB::OdbNetwork.ZeroEtlAccess": { "MarkdownDocumentation": "`AWS::ODB::OdbNetwork.ZeroEtlAccess`\n\nThe configuration for Zero-ETL access from the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-zeroetlaccess.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the Zero-ETL access.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | ENABLING | DISABL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-zeroetlaccess.html#cfn-odb-odbnetwork-zeroetlaccess-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR block for the Zero-ETL 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-zeroetlaccess.html#cfn-odb-odbnetwork-zeroetlaccess-cidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OSIS::Pipeline.BufferOptions": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline.BufferOptions`\n\nOptions that specify the configuration of a persistent buffer.\nTo configure how OpenSearch Ingestion encrypts this data, set the `EncryptionAtRestOptions`. For more information, see [Persistent buffering](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/osis-features-overview.html#persistent-buffering).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-bufferoptions.html", "Properties": { "PersistentBufferEnabled": { "MarkdownDocumentation": "`PersistentBufferEnabled`\n\nWhether persistent buffering should be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-bufferoptions.html#cfn-osis-pipeline-bufferoptions-persistentbufferenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::OSIS::Pipeline.CloudWatchLogDestination": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline.CloudWatchLogDestination`\n\nThe destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-cloudwatchlogdestination.html", "Properties": { "LogGroup": { "MarkdownDocumentation": "`LogGroup`\n\nThe name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing\nlog group or create a new one. For example,\n`/aws/vendedlogs/OpenSearchService/pipelines`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\/aws\\/vendedlogs\\/[\\.\\-_/#A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-cloudwatchlogdestination.html#cfn-osis-pipeline-cloudwatchlogdestination-loggroup", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OSIS::Pipeline.EncryptionAtRestOptions": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline.EncryptionAtRestOptions`\n\nOptions to control how OpenSearch encrypts buffer data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-encryptionatrestoptions.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the KMS key used to encrypt buffer data.\nBy default, data is encrypted using an AWS owned key.\n*Required*: Yes\n*Type*: String\n*Minimum*: `7`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-encryptionatrestoptions.html#cfn-osis-pipeline-encryptionatrestoptions-kmskeyarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OSIS::Pipeline.LogPublishingOptions": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline.LogPublishingOptions`\n\nContainer for the values required to configure logging for the pipeline. If you don't\nspecify these values, OpenSearch Ingestion will not publish logs from your application to\nCloudWatch Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-logpublishingoptions.html", "Properties": { "CloudWatchLogDestination": { "MarkdownDocumentation": "`CloudWatchLogDestination`\n\nThe destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This\nparameter is required if `IsLoggingEnabled` is set to `true`.\n*Required*: No\n*Type*: [CloudWatchLogDestination](./aws-properties-osis-pipeline-cloudwatchlogdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-logpublishingoptions.html#cfn-osis-pipeline-logpublishingoptions-cloudwatchlogdestination", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLogDestination" }, "IsLoggingEnabled": { "MarkdownDocumentation": "`IsLoggingEnabled`\n\nWhether logs should be published.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-logpublishingoptions.html#cfn-osis-pipeline-logpublishingoptions-isloggingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OSIS::Pipeline.ResourcePolicy": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline.ResourcePolicy`\n\nThe `ResourcePolicy` property type specifies Property description not available. for an [AWS::OSIS::Pipeline](./aws-resource-osis-pipeline.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-resourcepolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-resourcepolicy.html#cfn-osis-pipeline-resourcepolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::OSIS::Pipeline.VpcAttachmentOptions": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline.VpcAttachmentOptions`\n\nOptions for attaching a VPC to pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcattachmentoptions.html", "Properties": { "AttachToVpc": { "MarkdownDocumentation": "`AttachToVpc`\n\nWhether a VPC is attached to the pipeline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcattachmentoptions.html#cfn-osis-pipeline-vpcattachmentoptions-attachtovpc", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "CidrBlock": { "MarkdownDocumentation": "`CidrBlock`\n\nThe CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcattachmentoptions.html#cfn-osis-pipeline-vpcattachmentoptions-cidrblock", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OSIS::Pipeline.VpcEndpoint": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline.VpcEndpoint`\n\nAn OpenSearch Ingestion-managed VPC endpoint that will access one or more\npipelines.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID for your VPC. AWS PrivateLink generates this value when you create a\nVPC.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcOptions": { "MarkdownDocumentation": "`VpcOptions`\n\nInformation about the VPC, including associated subnets and security groups.\n*Required*: No\n*Type*: [VpcOptions](./aws-properties-osis-pipeline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcoptions", "UpdateType": "Mutable", "Required": false, "Type": "VpcOptions" }, "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe unique identifier of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcendpointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OSIS::Pipeline.VpcOptions": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline.VpcOptions`\n\nOptions that specify the subnets and security groups for an OpenSearch Ingestion\nVPC endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html", "Properties": { "VpcAttachmentOptions": { "MarkdownDocumentation": "`VpcAttachmentOptions`\n\nOptions for attaching a VPC to a pipeline.\n*Required*: No\n*Type*: [VpcAttachmentOptions](./aws-properties-osis-pipeline-vpcattachmentoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html#cfn-osis-pipeline-vpcoptions-vpcattachmentoptions", "UpdateType": "Mutable", "Required": false, "Type": "VpcAttachmentOptions" }, "VpcEndpointManagement": { "MarkdownDocumentation": "`VpcEndpointManagement`\n\nDefines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.\n*Required*: No\n*Type*: String\n*Allowed values*: `CUSTOMER | SERVICE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER", "SERVICE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html#cfn-osis-pipeline-vpcoptions-vpcendpointmanagement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of security groups associated with the VPC endpoint.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `11`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html#cfn-osis-pipeline-vpcoptions-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of subnet IDs associated with the VPC endpoint.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `15`\n*Maximum*: `24`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcoptions.html#cfn-osis-pipeline-vpcoptions-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Oam::Link.LinkConfiguration": { "MarkdownDocumentation": "`AWS::Oam::Link.LinkConfiguration`\n\nUse this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from\nthe source account to the monitoring account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-oam-link-linkconfiguration.html", "Properties": { "LogGroupConfiguration": { "MarkdownDocumentation": "`LogGroupConfiguration`\n\nUse this structure to filter which log groups are to\nshare log events from this source account to the monitoring account.\n*Required*: No\n*Type*: [LinkFilter](./aws-properties-oam-link-linkfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-oam-link-linkconfiguration.html#cfn-oam-link-linkconfiguration-loggroupconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LinkFilter" }, "MetricConfiguration": { "MarkdownDocumentation": "`MetricConfiguration`\n\nUse this structure to filter which metric namespaces are to be shared from\nthe source account to the monitoring account.\n*Required*: No\n*Type*: [LinkFilter](./aws-properties-oam-link-linkfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-oam-link-linkconfiguration.html#cfn-oam-link-linkconfiguration-metricconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LinkFilter" } } }, "AWS::Oam::Link.LinkFilter": { "MarkdownDocumentation": "`AWS::Oam::Link.LinkFilter`\n\nWhen used in `MetricConfiguration` this field specifies which metric namespaces are to be shared with the monitoring account\nWhen used in `LogGroupConfiguration` this field specifies which log groups are to share their log events with the monitoring account. Use the term `LogGroupName` and one or\nmore of the following operands.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-oam-link-linkfilter.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nWhen used in `MetricConfiguration` this field specifies which metric namespaces are to be shared with the monitoring account\nWhen used in `LogGroupConfiguration` this field specifies which log groups are to share their log events with the monitoring account. Use the term `LogGroupName` and one or\nmore of the following operands.\nUse single quotation marks (') around log group names and metric namespaces.\nThe matching of log group names and metric namespaces is case sensitive.\nEach filter has a limit of five conditional operands. Conditional operands are `AND` and `OR`.\n* `=` and `!=`\n* `AND`\n* `OR`\n* `LIKE` and `NOT LIKE`. These can be used only as prefix searches. Include a `%` at the end\n of the string that you want to search for and include.\n* `IN` and `NOT IN`, using parentheses `( )`\nExamples:\n* `Namespace NOT LIKE 'AWS/%'` includes only namespaces that don't start with `AWS/`, such as custom namespaces.\n* `Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')` includes only the metrics in the EC2, ELB, and Amazon S3 namespaces.\n* `Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%'` includes only the EC2 namespace and your custom namespaces.\n* `LogGroupName IN ('This-Log-Group', 'Other-Log-Group')` includes only the log groups with names `This-Log-Group` and\n `Other-Log-Group`.\n* `LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2')` includes all log groups except the log groups with names `Private-Log-Group` and\n `Private-Log-Group-2`.\n* `LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'` includes all log groups that have names that start with `aws/lambda/` or\n `AWSLogs`.\n###### Note\nIf you are updating a link that uses filters, you can specify `*` as the only value for the\n`filter` parameter to delete the filter and share all log groups with the monitoring account.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-oam-link-linkfilter.html#cfn-oam-link-linkfilter-filter", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationCentralizationRule.CentralizationRule": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationCentralizationRule.CentralizationRule`\n\nDefines how telemetry data should be centralized across an AWS Organization, including\nsource and destination configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrule.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nConfiguration determining where the telemetry data should be centralized, backed up, as\nwell as encryption configuration for the primary and backup destinations.\n*Required*: Yes\n*Type*: [CentralizationRuleDestination](./aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrule.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrule-destination", "UpdateType": "Mutable", "Required": true, "Type": "CentralizationRuleDestination" }, "Source": { "MarkdownDocumentation": "`Source`\n\nConfiguration determining the source of the telemetry data to be centralized.\n*Required*: Yes\n*Type*: [CentralizationRuleSource](./aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrule.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrule-source", "UpdateType": "Mutable", "Required": true, "Type": "CentralizationRuleSource" } } }, "AWS::ObservabilityAdmin::OrganizationCentralizationRule.CentralizationRuleDestination": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationCentralizationRule.CentralizationRuleDestination`\n\nConfiguration specifying the primary destination for centralized telemetry data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html", "Properties": { "Account": { "MarkdownDocumentation": "`Account`\n\nThe destination account (within the organization) to which the telemetry data should be\ncentralized.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationruledestination-account", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationLogsConfiguration": { "MarkdownDocumentation": "`DestinationLogsConfiguration`\n\nLog specific configuration for centralization destination log groups.\n*Required*: No\n*Type*: [DestinationLogsConfiguration](./aws-properties-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationruledestination-destinationlogsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DestinationLogsConfiguration" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe primary destination region to which telemetry data should be centralized.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationruledestination.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationruledestination-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationCentralizationRule.CentralizationRuleSource": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationCentralizationRule.CentralizationRuleSource`\n\nConfiguration specifying the source of telemetry data to be centralized.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe organizational scope from which telemetry data should be centralized, specified using\norganization id, accounts or organizational unit ids.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrulesource-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceLogsConfiguration": { "MarkdownDocumentation": "`SourceLogsConfiguration`\n\nLog specific configuration for centralization source log groups.\n*Required*: No\n*Type*: [SourceLogsConfiguration](./aws-properties-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrulesource-sourcelogsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SourceLogsConfiguration" }, "Regions": { "MarkdownDocumentation": "`Regions`\n\nThe list of source regions from which telemetry data should be centralized.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrulesource.html#cfn-observabilityadmin-organizationcentralizationrule-centralizationrulesource-regions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ObservabilityAdmin::OrganizationCentralizationRule.DestinationLogsConfiguration": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationCentralizationRule.DestinationLogsConfiguration`\n\nConfiguration for centralization destination log groups, including encryption and backup\nsettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration.html", "Properties": { "LogsEncryptionConfiguration": { "MarkdownDocumentation": "`LogsEncryptionConfiguration`\n\nThe encryption configuration for centralization destination log groups.\n*Required*: No\n*Type*: [LogsEncryptionConfiguration](./aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration-logsencryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogsEncryptionConfiguration" }, "BackupConfiguration": { "MarkdownDocumentation": "`BackupConfiguration`\n\nConfiguration defining the backup region and an optional KMS key for the backup\ndestination.\n*Required*: No\n*Type*: [LogsBackupConfiguration](./aws-properties-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-destinationlogsconfiguration-backupconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogsBackupConfiguration" } } }, "AWS::ObservabilityAdmin::OrganizationCentralizationRule.LogsBackupConfiguration": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationCentralizationRule.LogsBackupConfiguration`\n\nConfiguration for backing up centralized log data to a secondary region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nKMS Key ARN belonging to the primary destination account and backup region, to encrypt\nnewly created central log groups in the backup destination.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nLogs specific backup destination region within the primary destination account to which\nlog data should be centralized.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsbackupconfiguration-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationCentralizationRule.LogsEncryptionConfiguration": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationCentralizationRule.LogsEncryptionConfiguration`\n\nConfiguration for encrypting centralized log groups. This configuration is only applied to\ndestination log groups for which the corresponding source log groups are encrypted using\nCustomer Managed KMS Keys.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nKMS Key ARN belonging to the primary destination account and region, to encrypt newly\ncreated central log groups in the primary destination.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionStrategy": { "MarkdownDocumentation": "`EncryptionStrategy`\n\nConfiguration that determines the encryption strategy of the destination log groups.\nCUSTOMER\\_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log\ngroups.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CUSTOMER_MANAGED | AWS_OWNE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER_MANAGED", "AWS_OWNED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration-encryptionstrategy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EncryptionConflictResolutionStrategy": { "MarkdownDocumentation": "`EncryptionConflictResolutionStrategy`\n\nConflict resolution strategy for centralization if the encryption strategy is set to\nCUSTOMER\\_MANAGED and the destination log group is encrypted with an AWS\\_OWNED KMS Key. ALLOW\nlets centralization go through while SKIP prevents centralization into the destination log\ngroup.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOW | SKIP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "SKIP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-logsencryptionconfiguration-encryptionconflictresolutionstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationCentralizationRule.SourceLogsConfiguration": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationCentralizationRule.SourceLogsConfiguration`\n\nConfiguration for selecting and handling source log groups for centralization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration.html", "Properties": { "EncryptedLogGroupStrategy": { "MarkdownDocumentation": "`EncryptedLogGroupStrategy`\n\nA strategy determining whether to centralize source log groups that are encrypted with\ncustomer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for\ncentralization while SKIP will skip CMK encrypted source log groups from\ncentralization.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALLOW | SKIP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "SKIP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration-encryptedloggroupstrategy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogGroupSelectionCriteria": { "MarkdownDocumentation": "`LogGroupSelectionCriteria`\n\nThe selection criteria that specifies which source log groups to centralize. The selection\ncriteria uses the same format as OAM link filters.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration.html#cfn-observabilityadmin-organizationcentralizationrule-sourcelogsconfiguration-loggroupselectioncriteria", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.ActionCondition": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.ActionCondition`\n\nCondition that matches based on the specific WAF action taken on the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-actioncondition.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe WAF action to match against (ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE,\nEXCLUDED\\_AS\\_COUNT).\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOW | BLOCK | COUNT | CAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "BLOCK", "COUNT", "CAPTCHA", "CHALLENGE", "EXCLUDED_AS_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-actioncondition.html#cfn-observabilityadmin-organizationtelemetryrule-actioncondition-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.AdvancedEventSelector": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.AdvancedEventSelector`\n\nAdvanced event selectors let you create fine-grained selectors for management, data, and\nnetwork activity events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedeventselector.html", "Properties": { "FieldSelectors": { "MarkdownDocumentation": "`FieldSelectors`\n\nContains all selector statements in an advanced event selector.\n*Required*: Yes\n*Type*: Array of [AdvancedFieldSelector](./aws-properties-observabilityadmin-organizationtelemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedeventselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedeventselector-fieldselectors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AdvancedFieldSelector", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nAn optional, descriptive name for an advanced event selector, such as \"Log data events for\nonly two S3 buckets\".\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedeventselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedeventselector-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.AdvancedFieldSelector": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.AdvancedFieldSelector`\n\nDefines criteria for selecting resources based on field values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe name of the field to use for selection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Equals": { "MarkdownDocumentation": "`Equals`\n\nMatches if the field value equals the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-equals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotStartsWith": { "MarkdownDocumentation": "`NotStartsWith`\n\nMatches if the field value does not start with the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-notstartswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotEndsWith": { "MarkdownDocumentation": "`NotEndsWith`\n\nMatches if the field value does not end with the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-notendswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "StartsWith": { "MarkdownDocumentation": "`StartsWith`\n\nMatches if the field value starts with the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-startswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EndsWith": { "MarkdownDocumentation": "`EndsWith`\n\nMatches if the field value ends with the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-endswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotEquals": { "MarkdownDocumentation": "`NotEquals`\n\nMatches if the field value does not equal the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-notequals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.CloudtrailParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.CloudtrailParameters`\n\nParameters specific to AWS CloudTrail telemetry configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-cloudtrailparameters.html", "Properties": { "AdvancedEventSelectors": { "MarkdownDocumentation": "`AdvancedEventSelectors`\n\nThe advanced event selectors to use for filtering AWS CloudTrail events.\n*Required*: Yes\n*Type*: Array of [AdvancedEventSelector](./aws-properties-observabilityadmin-organizationtelemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-cloudtrailparameters.html#cfn-observabilityadmin-organizationtelemetryrule-cloudtrailparameters-advancedeventselectors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AdvancedEventSelector", "DuplicatesAllowed": false } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.Condition": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.Condition`\n\nA single condition that can match based on WAF rule action or label name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-condition.html", "Properties": { "LabelNameCondition": { "MarkdownDocumentation": "`LabelNameCondition`\n\nMatches log records based on WAF rule labels applied to the request.\n*Required*: No\n*Type*: [LabelNameCondition](./aws-properties-observabilityadmin-organizationtelemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-condition.html#cfn-observabilityadmin-organizationtelemetryrule-condition-labelnamecondition", "UpdateType": "Mutable", "Required": false, "Type": "LabelNameCondition" }, "ActionCondition": { "MarkdownDocumentation": "`ActionCondition`\n\nMatches log records based on the WAF rule action taken (ALLOW, BLOCK, COUNT, etc.).\n*Required*: No\n*Type*: [ActionCondition](./aws-properties-observabilityadmin-organizationtelemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-condition.html#cfn-observabilityadmin-organizationtelemetryrule-condition-actioncondition", "UpdateType": "Mutable", "Required": false, "Type": "ActionCondition" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.ELBLoadBalancerLoggingParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.ELBLoadBalancerLoggingParameters`\n\nConfiguration parameters for ELB load balancer logging, including output format and field\ndelimiter settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters.html", "Properties": { "FieldDelimiter": { "MarkdownDocumentation": "`FieldDelimiter`\n\nThe delimiter character used to separate fields in ELB access log entries when using\nplain text 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters-fielddelimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputFormat": { "MarkdownDocumentation": "`OutputFormat`\n\nThe format for ELB access log entries (plain text or JSON format).\n*Required*: No\n*Type*: String\n*Allowed values*: `plain | json...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "plain", "json" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters-outputformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.FieldToMatch": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.FieldToMatch`\n\nSpecifies a field in the request to redact from WAF logs, such as headers, query\nparameters, or body content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html", "Properties": { "UriPath": { "MarkdownDocumentation": "`UriPath`\n\nRedacts the URI path from WAF 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html#cfn-observabilityadmin-organizationtelemetryrule-fieldtomatch-uripath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nRedacts the entire query string from WAF 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html#cfn-observabilityadmin-organizationtelemetryrule-fieldtomatch-querystring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Method": { "MarkdownDocumentation": "`Method`\n\nRedacts the HTTP method from WAF 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html#cfn-observabilityadmin-organizationtelemetryrule-fieldtomatch-method", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SingleHeader": { "MarkdownDocumentation": "`SingleHeader`\n\nRedacts a specific header field by name from WAF logs.\n*Required*: No\n*Type*: [SingleHeader](./aws-properties-observabilityadmin-organizationtelemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html#cfn-observabilityadmin-organizationtelemetryrule-fieldtomatch-singleheader", "UpdateType": "Mutable", "Required": false, "Type": "SingleHeader" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.Filter": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.Filter`\n\nA single filter condition that specifies behavior, requirement, and matching conditions\nfor WAF log records.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-filter.html", "Properties": { "Requirement": { "MarkdownDocumentation": "`Requirement`\n\nWhether the log record must meet all conditions (MEETS\\_ALL) or any condition (MEETS\\_ANY)\nto match this filter.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "MEETS_ALL", "MEETS_ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-filter.html#cfn-observabilityadmin-organizationtelemetryrule-filter-requirement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Behavior": { "MarkdownDocumentation": "`Behavior`\n\nThe action to take for log records matching this filter (KEEP or DROP).\n*Required*: No\n*Type*: String\n*Allowed values*: `KEEP | DROP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEEP", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-filter.html#cfn-observabilityadmin-organizationtelemetryrule-filter-behavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe list of conditions that determine if a log record matches this filter.\n*Required*: No\n*Type*: Array of [Condition](./aws-properties-observabilityadmin-organizationtelemetryrule-condition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-filter.html#cfn-observabilityadmin-organizationtelemetryrule-filter-conditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Condition", "DuplicatesAllowed": false } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.LabelNameCondition": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.LabelNameCondition`\n\nCondition that matches based on WAF rule labels, with label names limited to 1024\ncharacters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-labelnamecondition.html", "Properties": { "LabelName": { "MarkdownDocumentation": "`LabelName`\n\nThe label name to match, supporting alphanumeric characters, underscores, hyphens, and\ncolons.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_\\-:]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-labelnamecondition.html#cfn-observabilityadmin-organizationtelemetryrule-labelnamecondition-labelname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.LoggingFilter": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.LoggingFilter`\n\nConfiguration that determines which WAF log records to keep or drop based on specified\nconditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-loggingfilter.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nA list of filter conditions that determine log record handling behavior.\n*Required*: No\n*Type*: Array of [Filter](./aws-properties-observabilityadmin-organizationtelemetryrule-filter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-loggingfilter.html#cfn-observabilityadmin-organizationtelemetryrule-loggingfilter-filters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": false }, "DefaultBehavior": { "MarkdownDocumentation": "`DefaultBehavior`\n\nThe default action (KEEP or DROP) for log records that don't match any filter conditions.\n*Required*: No\n*Type*: String\n*Allowed values*: `KEEP | DROP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEEP", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-loggingfilter.html#cfn-observabilityadmin-organizationtelemetryrule-loggingfilter-defaultbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.SingleHeader": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.SingleHeader`\n\nStructure containing a name field limited to 64 characters for header or query parameter\nidentification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-singleheader.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name value, limited to 64 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-singleheader.html#cfn-observabilityadmin-organizationtelemetryrule-singleheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.TelemetryDestinationConfiguration": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.TelemetryDestinationConfiguration`\n\nConfiguration specifying where and how telemetry data should be delivered for AWS\nresources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html", "Properties": { "RetentionInDays": { "MarkdownDocumentation": "`RetentionInDays`\n\nThe number of days to retain the telemetry data in the destination.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-retentionindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DestinationPattern": { "MarkdownDocumentation": "`DestinationPattern`\n\nThe pattern used to generate the destination path or name, supporting macros like\n and .\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-destinationpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ELBLoadBalancerLoggingParameters": { "MarkdownDocumentation": "`ELBLoadBalancerLoggingParameters`\n\nConfiguration parameters specific to ELB load balancer logging when ELB is the resource\ntype.\n*Required*: No\n*Type*: [ELBLoadBalancerLoggingParameters](./aws-properties-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-elbloadbalancerloggingparameters", "UpdateType": "Mutable", "Required": false, "Type": "ELBLoadBalancerLoggingParameters" }, "VPCFlowLogParameters": { "MarkdownDocumentation": "`VPCFlowLogParameters`\n\nConfiguration parameters specific to VPC Flow Logs when VPC is the resource type.\n*Required*: No\n*Type*: [VPCFlowLogParameters](./aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-vpcflowlogparameters", "UpdateType": "Mutable", "Required": false, "Type": "VPCFlowLogParameters" }, "CloudtrailParameters": { "MarkdownDocumentation": "`CloudtrailParameters`\n\nConfiguration parameters specific to AWS CloudTrail when CloudTrail is the source type.\n*Required*: No\n*Type*: [CloudtrailParameters](./aws-properties-observabilityadmin-organizationtelemetryrule-cloudtrailparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-cloudtrailparameters", "UpdateType": "Mutable", "Required": false, "Type": "CloudtrailParameters" }, "WAFLoggingParameters": { "MarkdownDocumentation": "`WAFLoggingParameters`\n\nConfiguration parameters specific to WAF logging when WAF is the resource type.\n*Required*: No\n*Type*: [WAFLoggingParameters](./aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-wafloggingparameters", "UpdateType": "Mutable", "Required": false, "Type": "WAFLoggingParameters" }, "DestinationType": { "MarkdownDocumentation": "`DestinationType`\n\nThe type of destination for the telemetry data (e.g., \"Amazon CloudWatch Logs\", \"S3\").\n*Required*: No\n*Type*: String\n*Allowed values*: `cloud-watch-logs...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "cloud-watch-logs" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-destinationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.TelemetryRule": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.TelemetryRule`\n\nDefines how telemetry should be configured for specific AWS resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html", "Properties": { "TelemetrySourceTypes": { "MarkdownDocumentation": "`TelemetrySourceTypes`\n\nThe specific telemetry source types to configure for the resource, such as VPC\\_FLOW\\_LOGS\nor EKS\\_AUDIT\\_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-telemetrysourcetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "DestinationConfiguration": { "MarkdownDocumentation": "`DestinationConfiguration`\n\nConfiguration specifying where and how the telemetry data should be delivered.\n*Required*: No\n*Type*: [TelemetryDestinationConfiguration](./aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-destinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TelemetryDestinationConfiguration" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe organizational scope to which the rule applies, specified using accounts or\norganizational units.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectionCriteria": { "MarkdownDocumentation": "`SelectionCriteria`\n\nCriteria for selecting which resources the rule applies to, such as resource tags.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-selectioncriteria", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of AWS resource to configure telemetry for (e.g., \"AWS::EC2::VPC\",\n\"AWS::EKS::Cluster\", \"AWS::WAFv2::WebACL\").\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS::EC2::VPC | AWS::WAFv2:...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS::EC2::VPC", "AWS::WAFv2::WebACL", "AWS::CloudTrail", "AWS::EKS::Cluster", "AWS::ElasticLoadBalancingV2::LoadBalancer" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-resourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TelemetryType": { "MarkdownDocumentation": "`TelemetryType`\n\nThe type of telemetry to collect (Logs, Metrics, or Traces).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Logs`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "Logs" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-telemetrytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.VPCFlowLogParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.VPCFlowLogParameters`\n\nConfiguration parameters specific to VPC Flow Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html", "Properties": { "LogFormat": { "MarkdownDocumentation": "`LogFormat`\n\nThe format in which VPC Flow Log entries should be logged.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-logformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxAggregationInterval": { "MarkdownDocumentation": "`MaxAggregationInterval`\n\nThe maximum interval in seconds between the capture of flow log 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-maxaggregationinterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TrafficType": { "MarkdownDocumentation": "`TrafficType`\n\nThe type of traffic to log (ACCEPT, REJECT, or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-organizationtelemetryrule-vpcflowlogparameters-traffictype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule.WAFLoggingParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule.WAFLoggingParameters`\n\nConfiguration parameters for WAF logging, including redacted fields and logging filters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html", "Properties": { "RedactedFields": { "MarkdownDocumentation": "`RedactedFields`\n\nThe fields to redact from WAF logs to protect sensitive information.\n*Required*: No\n*Type*: Array of [FieldToMatch](./aws-properties-observabilityadmin-organizationtelemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-wafloggingparameters-redactedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldToMatch", "DuplicatesAllowed": false }, "LoggingFilter": { "MarkdownDocumentation": "`LoggingFilter`\n\nA filter configuration that determines which WAF log records to include or exclude.\n*Required*: No\n*Type*: [LoggingFilter](./aws-properties-observabilityadmin-organizationtelemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-wafloggingparameters-loggingfilter", "UpdateType": "Mutable", "Required": false, "Type": "LoggingFilter" }, "LogType": { "MarkdownDocumentation": "`LogType`\n\nThe type of WAF logs to collect (currently supports WAF\\_LOGS).\n*Required*: No\n*Type*: String\n*Allowed values*: `WAF_LOGS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "WAF_LOGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-wafloggingparameters-logtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::S3TableIntegration.EncryptionConfig": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::S3TableIntegration.EncryptionConfig`\n\nDefines the encryption configuration for S3 Table integrations, including the encryption\nalgorithm and KMS key settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-encryptionconfig.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key used for encryption when using\ncustomer-managed keys.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$`\n*Minimum*: `1`\n*Maximum*: `1011`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-encryptionconfig.html#cfn-observabilityadmin-s3tableintegration-encryptionconfig-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SseAlgorithm": { "MarkdownDocumentation": "`SseAlgorithm`\n\nThe server-side encryption algorithm used for encrypting data in the S3 Table\nintegration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AES256 | aws:kms...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AES256", "aws:kms" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-encryptionconfig.html#cfn-observabilityadmin-s3tableintegration-encryptionconfig-ssealgorithm", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::S3TableIntegration.LogSource": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::S3TableIntegration.LogSource`\n\nA data source with an S3 Table integration for query access in the `logs` namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-logsource.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-logsource.html#cfn-observabilityadmin-s3tableintegration-logsource-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nThe unique identifier for the association between the data source and S3 Table integration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-logsource.html#cfn-observabilityadmin-s3tableintegration-logsource-identifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-logsource.html#cfn-observabilityadmin-s3tableintegration-logsource-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryPipelines.TelemetryPipeline": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryPipelines.TelemetryPipeline`\n\nRepresents a complete telemetry pipeline resource with configuration, status, and metadata\nfor data processing and transformation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe current status of the telemetry pipeline.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATING | ACTIVE | UPDATIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdateTimeStamp": { "MarkdownDocumentation": "`LastUpdateTimeStamp`\n\nThe timestamp when the telemetry pipeline was last updated.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-lastupdatetimestamp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "CreatedTimeStamp": { "MarkdownDocumentation": "`CreatedTimeStamp`\n\nThe timestamp when the telemetry pipeline was created.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-createdtimestamp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration that defines how the telemetry pipeline processes data. For more information, see the\n[Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Creating-pipelines.html).\n*Required*: No\n*Type*: [TelemetryPipelineConfiguration](./aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-configuration", "UpdateType": "Mutable", "Required": false, "Type": "TelemetryPipelineConfiguration" }, "StatusReason": { "MarkdownDocumentation": "`StatusReason`\n\nAdditional information about the pipeline status, including reasons for failure\nstates.\n*Required*: No\n*Type*: [TelemetryPipelineStatusReason](./aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelinestatusreason.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-statusreason", "UpdateType": "Mutable", "Required": false, "Type": "TelemetryPipelineStatusReason" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the telemetry pipeline.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe key-value pairs associated with the telemetry pipeline resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-observabilityadmin-telemetrypipelines-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the telemetry pipeline.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\-]+`\n*Minimum*: `3`\n*Maximum*: `28`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryPipelines.TelemetryPipelineConfiguration": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryPipelines.TelemetryPipelineConfiguration`\n\nDefines the configuration for a pipeline, including how data flows from sources through\nprocessors to destinations. The configuration is specified in YAML format and must include a\nvalid pipeline definition with required source and sink components. This pipeline enables\nend-to-end telemetry data collection, transformation, and delivery while supporting optional\nprocessing steps and extensions for enhanced functionality.\nThe primary pipeline configuration section are:\n* **Source:** Defines where log data originates from (S3\n buckets, CloudWatch Logs, third-party APIs). Each pipeline must have exactly one\n source.\n* **Processors (optional):** Transform, parse, and enrich\n log data as it flows through the pipeline. Processors are applied sequentially in the\n order they are defined.\n* **Sink:** Defines the destination where processed log\n data is sent. Each pipeline must have exactly one sink.\n* **Extensions (optional):** Provide additional\n functionality such as AWS Secrets Manager integration for credential management.\nFor more details on each configuration section see [CloudWatch pipelines User\nGuide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-pipelines.html). Additional comprehensive configuration examples can be found in the [CreateTelemetryPipeline API docs](https://docs.aws.amazon.com/cloudwatch/latest/observabilityadmin/API_CreateTelemetryPipeline.html#API_CreateTelemetryPipeline_Examples).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration.html", "Properties": { "Body": { "MarkdownDocumentation": "`Body`\n\nThe pipeline configuration body that defines the data processing rules and\ntransformations.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `24000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration-body", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryPipelines.TelemetryPipelineStatusReason": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryPipelines.TelemetryPipelineStatusReason`\n\nProvides detailed information about the status of a telemetry pipeline, including reasons\nfor specific states.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelinestatusreason.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the pipeline status reason, providing additional context about the\ncurrent state.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelinestatusreason.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipelinestatusreason-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.ActionCondition": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.ActionCondition`\n\nCondition that matches based on the specific WAF action taken on the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-actioncondition.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe WAF action to match against (ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE,\nEXCLUDED\\_AS\\_COUNT).\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOW | BLOCK | COUNT | CAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "BLOCK", "COUNT", "CAPTCHA", "CHALLENGE", "EXCLUDED_AS_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-actioncondition.html#cfn-observabilityadmin-telemetryrule-actioncondition-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.AdvancedEventSelector": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.AdvancedEventSelector`\n\nAdvanced event selectors let you create fine-grained selectors for management, data, and\nnetwork activity events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedeventselector.html", "Properties": { "FieldSelectors": { "MarkdownDocumentation": "`FieldSelectors`\n\nContains all selector statements in an advanced event selector.\n*Required*: Yes\n*Type*: Array of [AdvancedFieldSelector](./aws-properties-observabilityadmin-telemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedeventselector.html#cfn-observabilityadmin-telemetryrule-advancedeventselector-fieldselectors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AdvancedFieldSelector", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nAn optional, descriptive name for an advanced event selector, such as \"Log data events for\nonly two S3 buckets\".\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedeventselector.html#cfn-observabilityadmin-telemetryrule-advancedeventselector-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.AdvancedFieldSelector": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.AdvancedFieldSelector`\n\nDefines criteria for selecting resources based on field values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe name of the field to use for selection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Equals": { "MarkdownDocumentation": "`Equals`\n\nMatches if the field value equals the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-equals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotStartsWith": { "MarkdownDocumentation": "`NotStartsWith`\n\nMatches if the field value does not start with the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-notstartswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotEndsWith": { "MarkdownDocumentation": "`NotEndsWith`\n\nMatches if the field value does not end with the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-notendswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "StartsWith": { "MarkdownDocumentation": "`StartsWith`\n\nMatches if the field value starts with the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-startswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EndsWith": { "MarkdownDocumentation": "`EndsWith`\n\nMatches if the field value ends with the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-endswith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NotEquals": { "MarkdownDocumentation": "`NotEquals`\n\nMatches if the field value does not equal the specified value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-notequals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ObservabilityAdmin::TelemetryRule.CloudtrailParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.CloudtrailParameters`\n\nParameters specific to AWS CloudTrail telemetry configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-cloudtrailparameters.html", "Properties": { "AdvancedEventSelectors": { "MarkdownDocumentation": "`AdvancedEventSelectors`\n\nThe advanced event selectors to use for filtering AWS CloudTrail events.\n*Required*: Yes\n*Type*: Array of [AdvancedEventSelector](./aws-properties-observabilityadmin-telemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-cloudtrailparameters.html#cfn-observabilityadmin-telemetryrule-cloudtrailparameters-advancedeventselectors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AdvancedEventSelector", "DuplicatesAllowed": false } } }, "AWS::ObservabilityAdmin::TelemetryRule.Condition": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.Condition`\n\nA single condition that can match based on WAF rule action or label name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-condition.html", "Properties": { "LabelNameCondition": { "MarkdownDocumentation": "`LabelNameCondition`\n\nMatches log records based on WAF rule labels applied to the request.\n*Required*: No\n*Type*: [LabelNameCondition](./aws-properties-observabilityadmin-telemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-condition.html#cfn-observabilityadmin-telemetryrule-condition-labelnamecondition", "UpdateType": "Mutable", "Required": false, "Type": "LabelNameCondition" }, "ActionCondition": { "MarkdownDocumentation": "`ActionCondition`\n\nMatches log records based on the WAF rule action taken (ALLOW, BLOCK, COUNT, etc.).\n*Required*: No\n*Type*: [ActionCondition](./aws-properties-observabilityadmin-telemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-condition.html#cfn-observabilityadmin-telemetryrule-condition-actioncondition", "UpdateType": "Mutable", "Required": false, "Type": "ActionCondition" } } }, "AWS::ObservabilityAdmin::TelemetryRule.ELBLoadBalancerLoggingParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.ELBLoadBalancerLoggingParameters`\n\nConfiguration parameters for ELB load balancer logging, including output format and field\ndelimiter settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters.html", "Properties": { "FieldDelimiter": { "MarkdownDocumentation": "`FieldDelimiter`\n\nThe delimiter character used to separate fields in ELB access log entries when using\nplain text 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters.html#cfn-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters-fielddelimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputFormat": { "MarkdownDocumentation": "`OutputFormat`\n\nThe format for ELB access log entries (plain text or JSON format).\n*Required*: No\n*Type*: String\n*Allowed values*: `plain | json...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "plain", "json" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters.html#cfn-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters-outputformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.FieldToMatch": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.FieldToMatch`\n\nSpecifies a field in the request to redact from WAF logs, such as headers, query\nparameters, or body content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html", "Properties": { "UriPath": { "MarkdownDocumentation": "`UriPath`\n\nRedacts the URI path from WAF 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html#cfn-observabilityadmin-telemetryrule-fieldtomatch-uripath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nRedacts the entire query string from WAF 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html#cfn-observabilityadmin-telemetryrule-fieldtomatch-querystring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Method": { "MarkdownDocumentation": "`Method`\n\nRedacts the HTTP method from WAF 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html#cfn-observabilityadmin-telemetryrule-fieldtomatch-method", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SingleHeader": { "MarkdownDocumentation": "`SingleHeader`\n\nRedacts a specific header field by name from WAF logs.\n*Required*: No\n*Type*: [SingleHeader](./aws-properties-observabilityadmin-telemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html#cfn-observabilityadmin-telemetryrule-fieldtomatch-singleheader", "UpdateType": "Mutable", "Required": false, "Type": "SingleHeader" } } }, "AWS::ObservabilityAdmin::TelemetryRule.Filter": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.Filter`\n\nA single filter condition that specifies behavior, requirement, and matching conditions\nfor WAF log records.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-filter.html", "Properties": { "Requirement": { "MarkdownDocumentation": "`Requirement`\n\nWhether the log record must meet all conditions (MEETS\\_ALL) or any condition (MEETS\\_ANY)\nto match this filter.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "MEETS_ALL", "MEETS_ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-filter.html#cfn-observabilityadmin-telemetryrule-filter-requirement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Behavior": { "MarkdownDocumentation": "`Behavior`\n\nThe action to take for log records matching this filter (KEEP or DROP).\n*Required*: No\n*Type*: String\n*Allowed values*: `KEEP | DROP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEEP", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-filter.html#cfn-observabilityadmin-telemetryrule-filter-behavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe list of conditions that determine if a log record matches this filter.\n*Required*: No\n*Type*: Array of [Condition](./aws-properties-observabilityadmin-telemetryrule-condition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-filter.html#cfn-observabilityadmin-telemetryrule-filter-conditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Condition", "DuplicatesAllowed": false } } }, "AWS::ObservabilityAdmin::TelemetryRule.LabelNameCondition": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.LabelNameCondition`\n\nCondition that matches based on WAF rule labels, with label names limited to 1024\ncharacters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-labelnamecondition.html", "Properties": { "LabelName": { "MarkdownDocumentation": "`LabelName`\n\nThe label name to match, supporting alphanumeric characters, underscores, hyphens, and\ncolons.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_\\-:]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-labelnamecondition.html#cfn-observabilityadmin-telemetryrule-labelnamecondition-labelname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.LogDeliveryParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.LogDeliveryParameters`\n\nConfiguration parameters for Amazon Bedrock AgentCore logging, including `logType`\nsettings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-logdeliveryparameters.html", "Properties": { "LogTypes": { "MarkdownDocumentation": "`LogTypes`\n\nThe type of log that the source is sending.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `APPLICATION_LOGS | USAGE_LO...`\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)", "RefReturnValue": "", "AllowedValues": [ "APPLICATION_LOGS", "USAGE_LOGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-logdeliveryparameters.html#cfn-observabilityadmin-telemetryrule-logdeliveryparameters-logtypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::ObservabilityAdmin::TelemetryRule.LoggingFilter": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.LoggingFilter`\n\nConfiguration that determines which WAF log records to keep or drop based on specified\nconditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-loggingfilter.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nA list of filter conditions that determine log record handling behavior.\n*Required*: No\n*Type*: Array of [Filter](./aws-properties-observabilityadmin-telemetryrule-filter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-loggingfilter.html#cfn-observabilityadmin-telemetryrule-loggingfilter-filters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": false }, "DefaultBehavior": { "MarkdownDocumentation": "`DefaultBehavior`\n\nThe default action (KEEP or DROP) for log records that don't match any filter conditions.\n*Required*: No\n*Type*: String\n*Allowed values*: `KEEP | DROP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEEP", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-loggingfilter.html#cfn-observabilityadmin-telemetryrule-loggingfilter-defaultbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.SingleHeader": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.SingleHeader`\n\nStructure containing a name field limited to 64 characters for header or query parameter\nidentification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-singleheader.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name value, limited to 64 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-singleheader.html#cfn-observabilityadmin-telemetryrule-singleheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.TelemetryDestinationConfiguration": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.TelemetryDestinationConfiguration`\n\nConfiguration specifying where and how telemetry data should be delivered for AWS\nresources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html", "Properties": { "RetentionInDays": { "MarkdownDocumentation": "`RetentionInDays`\n\nThe number of days to retain the telemetry data in the destination.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-retentionindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DestinationPattern": { "MarkdownDocumentation": "`DestinationPattern`\n\nThe pattern used to generate the destination path or name, supporting macros like\n and .\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-destinationpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ELBLoadBalancerLoggingParameters": { "MarkdownDocumentation": "`ELBLoadBalancerLoggingParameters`\n\nConfiguration parameters specific to ELB load balancer logging when ELB is the resource\ntype.\n*Required*: No\n*Type*: [ELBLoadBalancerLoggingParameters](./aws-properties-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-elbloadbalancerloggingparameters", "UpdateType": "Mutable", "Required": false, "Type": "ELBLoadBalancerLoggingParameters" }, "VPCFlowLogParameters": { "MarkdownDocumentation": "`VPCFlowLogParameters`\n\nConfiguration parameters specific to VPC Flow Logs when VPC is the resource type.\n*Required*: No\n*Type*: [VPCFlowLogParameters](./aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-vpcflowlogparameters", "UpdateType": "Mutable", "Required": false, "Type": "VPCFlowLogParameters" }, "CloudtrailParameters": { "MarkdownDocumentation": "`CloudtrailParameters`\n\nConfiguration parameters specific to AWS CloudTrail when CloudTrail is the source type.\n*Required*: No\n*Type*: [CloudtrailParameters](./aws-properties-observabilityadmin-telemetryrule-cloudtrailparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-cloudtrailparameters", "UpdateType": "Mutable", "Required": false, "Type": "CloudtrailParameters" }, "WAFLoggingParameters": { "MarkdownDocumentation": "`WAFLoggingParameters`\n\nConfiguration parameters specific to WAF logging when WAF is the resource type.\n*Required*: No\n*Type*: [WAFLoggingParameters](./aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-wafloggingparameters", "UpdateType": "Mutable", "Required": false, "Type": "WAFLoggingParameters" }, "LogDeliveryParameters": { "MarkdownDocumentation": "`LogDeliveryParameters`\n\nConfiguration parameters specific to Amazon Bedrock AgentCore logging when Amazon Bedrock AgentCore is the resource\ntype.\n*Required*: No\n*Type*: [LogDeliveryParameters](./aws-properties-observabilityadmin-telemetryrule-logdeliveryparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-logdeliveryparameters", "UpdateType": "Mutable", "Required": false, "Type": "LogDeliveryParameters" }, "DestinationType": { "MarkdownDocumentation": "`DestinationType`\n\nThe type of destination for the telemetry data (e.g., \"Amazon CloudWatch Logs\", \"S3\").\n*Required*: No\n*Type*: String\n*Allowed values*: `cloud-watch-logs...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "cloud-watch-logs" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-destinationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.TelemetryRule": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.TelemetryRule`\n\nDefines how telemetry should be configured for specific AWS resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html", "Properties": { "TelemetrySourceTypes": { "MarkdownDocumentation": "`TelemetrySourceTypes`\n\nThe specific telemetry source types to configure for the resource, such as VPC\\_FLOW\\_LOGS\nor EKS\\_AUDIT\\_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-telemetrysourcetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "DestinationConfiguration": { "MarkdownDocumentation": "`DestinationConfiguration`\n\nConfiguration specifying where and how the telemetry data should be delivered.\n*Required*: No\n*Type*: [TelemetryDestinationConfiguration](./aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-destinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TelemetryDestinationConfiguration" }, "SelectionCriteria": { "MarkdownDocumentation": "`SelectionCriteria`\n\nCriteria for selecting which resources the rule applies to, such as resource tags.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-selectioncriteria", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of AWS resource to configure telemetry for (e.g., \"AWS::EC2::VPC\",\n\"AWS::EKS::Cluster\", \"AWS::WAFv2::WebACL\").\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS::EC2::VPC | AWS::WAFv2:...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS::EC2::VPC", "AWS::WAFv2::WebACL", "AWS::CloudTrail", "AWS::EKS::Cluster", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::BedrockAgentCore::Runtime", "AWS::BedrockAgentCore::Browser", "AWS::BedrockAgentCore::CodeInterpreter" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-resourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TelemetryType": { "MarkdownDocumentation": "`TelemetryType`\n\nThe type of telemetry to collect (Logs, Metrics, or Traces).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Logs | Traces...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Logs", "Traces" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-telemetrytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.VPCFlowLogParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.VPCFlowLogParameters`\n\nConfiguration parameters specific to VPC Flow Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html", "Properties": { "LogFormat": { "MarkdownDocumentation": "`LogFormat`\n\nThe format in which VPC Flow Log entries should be logged.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-logformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxAggregationInterval": { "MarkdownDocumentation": "`MaxAggregationInterval`\n\nThe maximum interval in seconds between the capture of flow log 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-maxaggregationinterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TrafficType": { "MarkdownDocumentation": "`TrafficType`\n\nThe type of traffic to log (ACCEPT, REJECT, or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-traffictype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ObservabilityAdmin::TelemetryRule.WAFLoggingParameters": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule.WAFLoggingParameters`\n\nConfiguration parameters for WAF logging, including redacted fields and logging filters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html", "Properties": { "RedactedFields": { "MarkdownDocumentation": "`RedactedFields`\n\nThe fields to redact from WAF logs to protect sensitive information.\n*Required*: No\n*Type*: Array of [FieldToMatch](./aws-properties-observabilityadmin-telemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-redactedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldToMatch", "DuplicatesAllowed": false }, "LoggingFilter": { "MarkdownDocumentation": "`LoggingFilter`\n\nA filter configuration that determines which WAF log records to include or exclude.\n*Required*: No\n*Type*: [LoggingFilter](./aws-properties-observabilityadmin-telemetryrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-loggingfilter", "UpdateType": "Mutable", "Required": false, "Type": "LoggingFilter" }, "LogType": { "MarkdownDocumentation": "`LogType`\n\nThe type of WAF logs to collect (currently supports WAF\\_LOGS).\n*Required*: No\n*Type*: String\n*Allowed values*: `WAF_LOGS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "WAF_LOGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-logtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchServerless::Index.Index": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::Index.Index`\n\nAn OpenSearch Serverless index resource\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html", "Properties": { "KnnAlgoParamEfSearch": { "MarkdownDocumentation": "`KnnAlgoParamEfSearch`\n\nThe size of the dynamic list for the nearest neighbors.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-knnalgoparamefsearch", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RefreshInterval": { "MarkdownDocumentation": "`RefreshInterval`\n\nHow often to perform a refresh operation. For example, 1s or 5s.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-refreshinterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Knn": { "MarkdownDocumentation": "`Knn`\n\nEnable or disable k-nearest neighbor search capability.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-knn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchServerless::Index.IndexSettings": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::Index.IndexSettings`\n\nIndex settings for the OpenSearch Serverless index.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-indexsettings.html", "Properties": { "Index": { "MarkdownDocumentation": "`Index`\n\nIndex settings.\n*Required*: No\n*Type*: [Index](./aws-properties-opensearchserverless-index-index.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-indexsettings.html#cfn-opensearchserverless-index-indexsettings-index", "UpdateType": "Mutable", "Required": false, "Type": "Index" } } }, "AWS::OpenSearchServerless::Index.Mappings": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::Index.Mappings`\n\nIndex mappings for the OpenSearch Serverless index.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-mappings.html", "Properties": { "Properties": { "MarkdownDocumentation": "`Properties`\n\nNested fields within an object or nested field type.\n*Required*: No\n*Type*: Object of [PropertyMapping](./aws-properties-opensearchserverless-index-propertymapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-mappings.html#cfn-opensearchserverless-index-mappings-properties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "PropertyMapping" } } }, "AWS::OpenSearchServerless::Index.Method": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::Index.Method`\n\nConfiguration for k-NN search method.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nAdditional parameters for the k-NN algorithm.\n*Required*: No\n*Type*: [Parameters](./aws-properties-opensearchserverless-index-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Parameters" }, "SpaceType": { "MarkdownDocumentation": "`SpaceType`\n\nThe distance function used for k-NN search.\n*Required*: No\n*Type*: String\n*Allowed values*: `l2 | l1 | linf | cosinesimi...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "l2", "l1", "linf", "cosinesimil", "innerproduct", "hamming" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-spacetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe k-NN search engine to use\n*Required*: No\n*Type*: String\n*Allowed values*: `nmslib | faiss | lucene...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "nmslib", "faiss", "lucene" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-engine", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe algorithm name for k-NN search.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `hnsw | ivf`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "hnsw", "ivf" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OpenSearchServerless::Index.Parameters": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::Index.Parameters`\n\nAdditional parameters for the k-NN algorithm.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-parameters.html", "Properties": { "EfConstruction": { "MarkdownDocumentation": "`EfConstruction`\n\nThe size of the dynamic list used during k-NN graph creation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-parameters.html#cfn-opensearchserverless-index-parameters-efconstruction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "M": { "MarkdownDocumentation": "`M`\n\nNumber of neighbors to consider during k-NN search.\n*Required*: No\n*Type*: Integer\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-parameters.html#cfn-opensearchserverless-index-parameters-m", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::OpenSearchServerless::Index.PropertyMapping": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::Index.PropertyMapping`\n\nProperty mappings for the OpenSearch Serverless index.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe field data type. Must be a valid OpenSearch field type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `text | knn_vector...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "text", "knn_vector" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nDefault value for the field when not specified in a document.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Index": { "MarkdownDocumentation": "`Index`\n\nWhether a field should be indexed.\n*Required*: No\n*Type*: [Boolean](./aws-properties-opensearchserverless-index-index.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-index", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Dimension": { "MarkdownDocumentation": "`Dimension`\n\nDimension size for vector fields, defines the number of dimensions in the vector.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-dimension", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Method": { "MarkdownDocumentation": "`Method`\n\nConfiguration for k-NN search method.\n*Required*: No\n*Type*: [Method](./aws-properties-opensearchserverless-index-method.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-method", "UpdateType": "Mutable", "Required": false, "Type": "Method" }, "Properties": { "MarkdownDocumentation": "`Properties`\n\nDefines the fields within the mapping, including their types and configurations.\n*Required*: No\n*Type*: Object of [PropertyMapping](./aws-properties-opensearchserverless-index-propertymapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-properties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "PropertyMapping" } } }, "AWS::OpenSearchServerless::SecurityConfig.IamFederationConfigOptions": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::SecurityConfig.IamFederationConfigOptions`\n\nDescribes IAM federation options for an OpenSearch Serverless security configuration\nin the form of a key-value map. These options define how OpenSearch Serverless\nintegrates with external identity providers using federation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html", "Properties": { "UserAttribute": { "MarkdownDocumentation": "`UserAttribute`\n\nThe user attribute for this IAM federation integration. This attribute is used to\nidentify users in the federated authentication process.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z][A-Za-z0-9_.:/=+\\-@]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html#cfn-opensearchserverless-securityconfig-iamfederationconfigoptions-userattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupAttribute": { "MarkdownDocumentation": "`GroupAttribute`\n\nThe group attribute for this IAM federation integration. This attribute is used to map\nidentity provider groups to OpenSearch Serverless permissions.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z][A-Za-z0-9_.:/=+\\-@]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html#cfn-opensearchserverless-securityconfig-iamfederationconfigoptions-groupattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchServerless::SecurityConfig.IamIdentityCenterConfigOptions": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::SecurityConfig.IamIdentityCenterConfigOptions`\n\nDescribes IAM Identity Center options for an OpenSearch Serverless security\nconfiguration in the form of a key-value map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html", "Properties": { "ApplicationArn": { "MarkdownDocumentation": "`ApplicationArn`\n\nThe ARN of the IAM Identity Center application used to integrate with OpenSearch\nServerless.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-applicationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nThe name of the IAM Identity Center application used to integrate with OpenSearch\nServerless.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-applicationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserAttribute": { "MarkdownDocumentation": "`UserAttribute`\n\nThe user attribute for this IAM Identity Center integration. Defaults to\n`UserId`\n*Required*: No\n*Type*: String\n*Allowed values*: `UserId | UserName | Email...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UserId", "UserName", "Email" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-userattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceArn": { "MarkdownDocumentation": "`InstanceArn`\n\nThe ARN of the IAM Identity Center instance used to integrate with OpenSearch\nServerless.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-instancearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplicationDescription": { "MarkdownDocumentation": "`ApplicationDescription`\n\nThe description of the IAM Identity Center application used to integrate with\nOpenSearch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-applicationdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupAttribute": { "MarkdownDocumentation": "`GroupAttribute`\n\nThe group attribute for this IAM Identity Center integration. Defaults to\n`GroupId`.\n*Required*: No\n*Type*: String\n*Allowed values*: `GroupId | GroupName...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GroupId", "GroupName" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-groupattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchServerless::SecurityConfig.SamlConfigOptions": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::SecurityConfig.SamlConfigOptions`\n\nDescribes SAML options for an OpenSearch Serverless security configuration in the form of a key-value\nmap.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html", "Properties": { "SessionTimeout": { "MarkdownDocumentation": "`SessionTimeout`\n\nThe session timeout, in minutes. Default is 60 minutes (12 hours).\n*Required*: No\n*Type*: Integer\n*Minimum*: `5`\n*Maximum*: `720`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-sessiontimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OpenSearchServerlessEntityId": { "MarkdownDocumentation": "`OpenSearchServerlessEntityId`\n\nCustom entity ID attribute to override the default entity ID for this SAML\nintegration.\n*Required*: No\n*Type*: String\n*Pattern*: `^aws:opensearch:[0-9]{12}:*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-opensearchserverlessentityid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserAttribute": { "MarkdownDocumentation": "`UserAttribute`\n\nA user attribute for this SAML integration.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-userattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Metadata": { "MarkdownDocumentation": "`Metadata`\n\nThe XML IdP metadata file generated from your identity provider.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-metadata", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GroupAttribute": { "MarkdownDocumentation": "`GroupAttribute`\n\nThe group attribute for this SAML integration.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-groupattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Application.AppConfig": { "MarkdownDocumentation": "`AWS::OpenSearchService::Application.AppConfig`\n\nConfiguration settings for an OpenSearch application. For more information, see [Using the\nOpenSearch user interface in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-appconfig.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value assigned to the configuration key, such as an IAM user ARN.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-appconfig.html#cfn-opensearchservice-application-appconfig-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe configuration item to set, such as the admin role for the OpenSearch\napplication.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `opensearchDashboards.dashbo...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "opensearchDashboards.dashboardAdmin.users", "opensearchDashboards.dashboardAdmin.groups" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-appconfig.html#cfn-opensearchservice-application-appconfig-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Application.DataSource": { "MarkdownDocumentation": "`AWS::OpenSearchService::Application.DataSource`\n\nData sources that are associated with an OpenSearch application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-datasource.html", "Properties": { "DataSourceArn": { "MarkdownDocumentation": "`DataSourceArn`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-datasource.html#cfn-opensearchservice-application-datasource-datasourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSourceDescription": { "MarkdownDocumentation": "`DataSourceDescription`\n\nDetailed description of a data source.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-datasource.html#cfn-opensearchservice-application-datasource-datasourcedescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Application.IamIdentityCenterOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Application.IamIdentityCenterOptions`\n\nConfiguration settings for IAM Identity Center in an OpenSearch application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html", "Properties": { "IamIdentityCenterInstanceArn": { "MarkdownDocumentation": "`IamIdentityCenterInstanceArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-iamidentitycenterinstancearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamRoleForIdentityCenterApplicationArn": { "MarkdownDocumentation": "`IamRoleForIdentityCenterApplicationArn`\n\nThe Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center\napplication for the OpenSearch application.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-iamroleforidentitycenterapplicationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether IAM Identity Center is enabled for the OpenSearch application.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.AIMLOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.AIMLOptions`\n\nThe `AIMLOptions` property type specifies Property description not available. for an [AWS::OpenSearchService::Domain](./aws-resource-opensearchservice-domain.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-aimloptions.html", "Properties": { "S3VectorsEngine": { "MarkdownDocumentation": "`S3VectorsEngine`\n\nProperty description not available.\n*Required*: No\n*Type*: [S3VectorsEngine](./aws-properties-opensearchservice-domain-s3vectorsengine.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-aimloptions.html#cfn-opensearchservice-domain-aimloptions-s3vectorsengine", "UpdateType": "Mutable", "Required": false, "Type": "S3VectorsEngine" } } }, "AWS::OpenSearchService::Domain.AdvancedSecurityOptionsInput": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.AdvancedSecurityOptionsInput`\n\nSpecifies options for fine-grained access control.\nIf you specify advanced security options,\nyou 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\n[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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html", "Properties": { "IAMFederationOptions": { "MarkdownDocumentation": "`IAMFederationOptions`\n\nInput configuration for IAM identity federation within advanced security\noptions.\n*Required*: No\n*Type*: [IAMFederationOptions](./aws-properties-opensearchservice-domain-iamfederationoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-iamfederationoptions", "UpdateType": "Mutable", "Required": false, "Type": "IAMFederationOptions" }, "AnonymousAuthEnabled": { "MarkdownDocumentation": "`AnonymousAuthEnabled`\n\nTrue to enable a 30-day migration period during which administrators can create role\nmappings. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-anonymousauthenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InternalUserDatabaseEnabled": { "MarkdownDocumentation": "`InternalUserDatabaseEnabled`\n\nTrue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-internaluserdatabaseenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SAMLOptions": { "MarkdownDocumentation": "`SAMLOptions`\n\nContainer for information about the SAML configuration for OpenSearch\nDashboards.\n*Required*: No\n*Type*: [SAMLOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-samloptions", "UpdateType": "Mutable", "Required": false, "Type": "SAMLOptions" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nTrue to enable fine-grained access control. You must also enable encryption of data at rest\nand node-to-node encryption. See [Fine-grained access control in\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "JWTOptions": { "MarkdownDocumentation": "`JWTOptions`\n\nContainer for information about the JWT configuration of the Amazon OpenSearch\nService.\n*Required*: No\n*Type*: [JWTOptions](./aws-properties-opensearchservice-domain-jwtoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-jwtoptions", "UpdateType": "Mutable", "Required": false, "Type": "JWTOptions" }, "AnonymousAuthDisableDate": { "MarkdownDocumentation": "`AnonymousAuthDisableDate`\n\nDate and time when the migration period will be disabled. Only necessary when [enabling\nfine-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-anonymousauthdisabledate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterUserOptions": { "MarkdownDocumentation": "`MasterUserOptions`\n\nSpecifies information about the master user.\n*Required*: No\n*Type*: [MasterUserOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-masteruseroptions", "UpdateType": "Mutable", "Required": false, "Type": "MasterUserOptions" } } }, "AWS::OpenSearchService::Domain.ClusterConfig": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.ClusterConfig`\n\nThe cluster configuration for the OpenSearch Service domain. You can specify options such\nas the instance type and the number of instances. For more information, see [Creating and managing Amazon OpenSearch Service domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) in the *Amazon OpenSearch Service\nDeveloper Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html", "Properties": { "MultiAZWithStandbyEnabled": { "MarkdownDocumentation": "`MultiAZWithStandbyEnabled`\n\nIndicates whether Multi-AZ with Standby deployment option is enabled. For more\ninformation, see [Multi-AZ with Standby](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html#managedomains-za-standby).\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-multiazwithstandbyenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DedicatedMasterEnabled": { "MarkdownDocumentation": "`DedicatedMasterEnabled`\n\nIndicates whether to use a dedicated master node for the OpenSearch Service domain. A\ndedicated master node is a cluster node that performs cluster management tasks, but doesn't\nhold data or respond to data upload requests. Dedicated master nodes offload cluster\nmanagement 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmasterenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ZoneAwarenessConfig": { "MarkdownDocumentation": "`ZoneAwarenessConfig`\n\nSpecifies zone awareness configuration options. Only use if\n`ZoneAwarenessEnabled` is `true`.\n*Required*: No\n*Type*: [ZoneAwarenessConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-zoneawarenessconfig", "UpdateType": "Mutable", "Required": false, "Type": "ZoneAwarenessConfig" }, "ColdStorageOptions": { "MarkdownDocumentation": "`ColdStorageOptions`\n\nContainer for cold storage configuration options.\n*Required*: No\n*Type*: [ColdStorageOptions](./aws-properties-opensearchservice-domain-coldstorageoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-coldstorageoptions", "UpdateType": "Mutable", "Required": false, "Type": "ColdStorageOptions" }, "NodeOptions": { "MarkdownDocumentation": "`NodeOptions`\n\nList of node options for the domain.\n*Required*: No\n*Type*: Array of [NodeOption](./aws-properties-opensearchservice-domain-nodeoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-nodeoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NodeOption", "DuplicatesAllowed": true }, "WarmType": { "MarkdownDocumentation": "`WarmType`\n\nThe instance type for the cluster's warm nodes.\n*Required*: No\n*Type*: String\n*Allowed values*: `ultrawarm1.medium.search | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceCount": { "MarkdownDocumentation": "`InstanceCount`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-instancecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "WarmEnabled": { "MarkdownDocumentation": "`WarmEnabled`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "WarmCount": { "MarkdownDocumentation": "`WarmCount`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DedicatedMasterCount": { "MarkdownDocumentation": "`DedicatedMasterCount`\n\nThe number of instances to use for the master node. If you specify this property, you must\nspecify `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmastercount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type for your data nodes, such as `m3.medium.search`. For valid\nvalues, see [Supported\ninstance 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*: `m3.medium.search | m3.large...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "or1.medium.search", "or1.large.search", "or1.xlarge.search", "or1.2xlarge.search", "or1.4xlarge.search", "or1.8xlarge.search", "or1.12xlarge.search", "or1.16xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-instancetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ZoneAwarenessEnabled": { "MarkdownDocumentation": "`ZoneAwarenessEnabled`\n\nIndicates whether to enable zone awareness for the OpenSearch Service domain. When you\nenable zone awareness, OpenSearch Service allocates the nodes and replica index shards that\nbelong to a cluster across two Availability Zones (AZs) in the same region to prevent data\nloss and minimize downtime in the event of node or data center failure. Don't enable zone\nawareness if your cluster has no replica index shards or is a single-node cluster. For more\ninformation, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-zoneawarenessenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DedicatedMasterType": { "MarkdownDocumentation": "`DedicatedMasterType`\n\nThe hardware configuration of the computer that hosts the dedicated master node, such as\n`m3.medium.search`. If you specify this property, you must specify\n`true` for the `DedicatedMasterEnabled` property. For valid values,\nsee [Supported\ninstance 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*: `m3.medium.search | m3.large...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "or1.medium.search", "or1.large.search", "or1.xlarge.search", "or1.2xlarge.search", "or1.4xlarge.search", "or1.8xlarge.search", "or1.12xlarge.search", "or1.16xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmastertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Domain.CognitoOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.CognitoOptions`\n\nConfigures OpenSearch Service to use Amazon Cognito authentication for OpenSearch\nDashboards.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html", "Properties": { "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch\nDashboards authentication.\nRequired if you enabled Cognito Authentication for OpenSearch Dashboards.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-userpoolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. See\n[Amazon Cognito\nauthentication 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IdentityPoolId": { "MarkdownDocumentation": "`IdentityPoolId`\n\nThe Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch\nDashboards authentication.\nRequired if you enabled Cognito Authentication for OpenSearch Dashboards.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[\\w-]+:[0-9a-f-]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-identitypoolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service\nto configure your user pool and identity pool.\nRequired if you enabled Cognito Authentication for OpenSearch Dashboards.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Domain.ColdStorageOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.ColdStorageOptions`\n\nContainer for the parameters required to enable cold storage for an OpenSearch Service\ndomain. For more information, see [Cold storage for\nAmazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-coldstorageoptions.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhether to enable or disable cold storage on the domain. You must enable UltraWarm\nstorage 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-coldstorageoptions.html#cfn-opensearchservice-domain-coldstorageoptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.DomainEndpointOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.DomainEndpointOptions`\n\nSpecifies 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html", "Properties": { "CustomEndpointEnabled": { "MarkdownDocumentation": "`CustomEndpointEnabled`\n\nTrue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpointenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnforceHTTPS": { "MarkdownDocumentation": "`EnforceHTTPS`\n\nTrue to require that all traffic to the domain arrive over HTTPS. Required if you enable\nfine-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-enforcehttps", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CustomEndpointCertificateArn": { "MarkdownDocumentation": "`CustomEndpointCertificateArn`\n\nThe AWS Certificate Manager ARN for your domain's SSL/TLS certificate. Required if you\nenabled 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpointcertificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomEndpoint": { "MarkdownDocumentation": "`CustomEndpoint`\n\nThe fully qualified URL for your custom endpoint. Required if you enabled a custom endpoint\nfor the domain.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TLSSecurityPolicy": { "MarkdownDocumentation": "`TLSSecurityPolicy`\n\nThe minimum TLS version required for traffic to the domain. The policy can be one of the\nfollowing values:\n* **Policy-Min-TLS-1-0-2019-07:** TLS security policy that\n supports TLS version 1.0 to TLS version 1.2\n* **Policy-Min-TLS-1-2-2019-07:** TLS security policy that\n supports only TLS version 1.2\n* **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy\n that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher\n suites\n*Required*: No\n*Type*: String\n*Allowed values*: `Policy-Min-TLS-1-0-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)", "RefReturnValue": "", "AllowedValues": [ "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07", "Policy-Min-TLS-1-2-PFS-2023-10" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-tlssecuritypolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Domain.EBSOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.EBSOptions`\n\nThe configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to\ndata 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\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html", "Properties": { "EBSEnabled": { "MarkdownDocumentation": "`EBSEnabled`\n\nSpecifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service\ndomain.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-ebsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe EBS volume type to use with the OpenSearch Service domain. If you choose\n`gp3`, you must also specify values for `Iops` and\n`Throughput`. For more information about each type, see [Amazon EBS volume\ntypes](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*: `standard | gp2 | io1 | gp3...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "gp2", "io1", "gp3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-volumetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Throughput": { "MarkdownDocumentation": "`Throughput`\n\nThe throughput (in MiB/s) of the EBS volumes attached to data nodes. Applies only to the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-throughput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS) that the volume supports. This property\napplies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-iops", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeSize": { "MarkdownDocumentation": "`VolumeSize`\n\nThe size (in GiB) of the EBS volume for each data node. The minimum and maximum size of an\nEBS volume depends on the EBS volume type and the instance type to which it is attached. For\nmore information, see [EBS volume size\nlimits](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-volumesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::OpenSearchService::Domain.EncryptionAtRestOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.EncryptionAtRestOptions`\n\nWhether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe KMS key ID. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`. Required\nif you enable encryption at rest.\nYou can also use `keyAlias` as a value.\nIf no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template,\nthe domain is deleted and recreated in order to modify the property.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `.*`\n*Minimum*: `1`\n*Maximum*: `500`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html#cfn-opensearchservice-domain-encryptionatrestoptions-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecify `true` to enable encryption at rest. Required if you enable\nfine-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html).\nIf no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template,\nthe domain is deleted and recreated in order to modify the property.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html#cfn-opensearchservice-domain-encryptionatrestoptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.IAMFederationOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.IAMFederationOptions`\n\nThe `IAMFederationOptions` property type specifies Property description not available. for an [AWS::OpenSearchService::Domain](./aws-resource-opensearchservice-domain.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.html", "Properties": { "SubjectKey": { "MarkdownDocumentation": "`SubjectKey`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.html#cfn-opensearchservice-domain-iamfederationoptions-subjectkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RolesKey": { "MarkdownDocumentation": "`RolesKey`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.html#cfn-opensearchservice-domain-iamfederationoptions-roleskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.html#cfn-opensearchservice-domain-iamfederationoptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.IdentityCenterOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.IdentityCenterOptions`\n\nSettings container for integrating IAM Identity Center with OpenSearch UI applications,\nwhich enables enabling secure user authentication and access control across multiple data\nsources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing\ncentralized user management.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html", "Properties": { "IdentityCenterApplicationARN": { "MarkdownDocumentation": "`IdentityCenterApplicationARN`\n\nThe ARN of the IAM Identity Center application that integrates with Amazon OpenSearch\nService.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\\\-]*:[a-z]+:[a-z0-9\\\\-]*:[0-9]*:[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitycenterapplicationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdentityCenterInstanceARN": { "MarkdownDocumentation": "`IdentityCenterInstanceARN`\n\nThe Amazon Resource Name (ARN) of the IAM Identity Center instance.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\\\-]*:[a-z]+:[a-z0-9\\\\-]*:[0-9]*:[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitycenterinstancearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubjectKey": { "MarkdownDocumentation": "`SubjectKey`\n\nSpecifies the attribute that contains the subject identifier (such as username, user ID, or\nemail) in IAM Identity Center.\n*Required*: No\n*Type*: String\n*Allowed values*: `UserName | UserId | Email...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UserName", "UserId", "Email" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-subjectkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnabledAPIAccess": { "MarkdownDocumentation": "`EnabledAPIAccess`\n\nIndicates whether IAM Identity Center is enabled for the application.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-enabledapiaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RolesKey": { "MarkdownDocumentation": "`RolesKey`\n\nSpecifies the attribute that contains the backend role identifier (such as group name or\ngroup ID) in IAM Identity Center.\n*Required*: No\n*Type*: String\n*Allowed values*: `GroupName | GroupId...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GroupName", "GroupId" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-roleskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdentityStoreId": { "MarkdownDocumentation": "`IdentityStoreId`\n\nThe identifier of the IAM Identity Store.\n*Required*: No\n*Type*: String\n*Pattern*: `^d-[0-9a-f]{10}$|^[0-9a-f]{8}\\\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\\\b[0-9a-f]{12}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitystoreid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Domain.Idp": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.Idp`\n\nThe SAML Identity Provider's information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html", "Properties": { "EntityId": { "MarkdownDocumentation": "`EntityId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html#cfn-opensearchservice-domain-idp-entityid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetadataContent": { "MarkdownDocumentation": "`MetadataContent`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html#cfn-opensearchservice-domain-idp-metadatacontent", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Domain.JWTOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.JWTOptions`\n\nThe `JWTOptions` property type specifies Property description not available. for an [AWS::OpenSearchService::Domain](./aws-resource-opensearchservice-domain.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html", "Properties": { "SubjectKey": { "MarkdownDocumentation": "`SubjectKey`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html#cfn-opensearchservice-domain-jwtoptions-subjectkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PublicKey": { "MarkdownDocumentation": "`PublicKey`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html#cfn-opensearchservice-domain-jwtoptions-publickey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RolesKey": { "MarkdownDocumentation": "`RolesKey`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html#cfn-opensearchservice-domain-jwtoptions-roleskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html#cfn-opensearchservice-domain-jwtoptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.LogPublishingOption": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.LogPublishingOption`\n\nSpecifies whether the OpenSearch Service domain publishes application, search slow logs,\nor index slow logs to Amazon CloudWatch. Each option must be an object of name\n`SEARCH_SLOW_LOGS`, `ES_APPLICATION_LOGS`,\n`INDEX_SLOW_LOGS`, or `AUDIT_LOGS` depending on the type of logs you\nwant to publish. 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).\nBefore you enable log publishing, you need to create a CloudWatch log group and provide\nOpenSearch Service the correct permissions to write to it. To learn more, see [Enabling log publishing (AWS CloudFormation)](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html#createdomain-configure-slow-logs-cfn).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html", "Properties": { "CloudWatchLogsLogGroupArn": { "MarkdownDocumentation": "`CloudWatchLogsLogGroupArn`\n\nSpecifies the CloudWatch log group to publish to. Required if you enable log\npublishing.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html#cfn-opensearchservice-domain-logpublishingoption-cloudwatchlogsloggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIf `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html#cfn-opensearchservice-domain-logpublishingoption-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.MasterUserOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.MasterUserOptions`\n\nSpecifies information about the master user.\nRequired if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html", "Properties": { "MasterUserPassword": { "MarkdownDocumentation": "`MasterUserPassword`\n\nPassword for the master user. Only specify if `InternalUserDatabaseEnabled` is true\nin [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*Pattern*: `.*`\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html#cfn-opensearchservice-domain-masteruseroptions-masteruserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterUserARN": { "MarkdownDocumentation": "`MasterUserARN`\n\nAmazon Resource Name (ARN) for the master user. The ARN can point to an IAM user or role. This\nproperty is required for Amazon Cognito to work, and it must match the role configured for\nCognito. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html#cfn-opensearchservice-domain-masteruseroptions-masteruserarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterUserName": { "MarkdownDocumentation": "`MasterUserName`\n\nUsername for the master user. Only specify if `InternalUserDatabaseEnabled` is true\nin [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*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html#cfn-opensearchservice-domain-masteruseroptions-masterusername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Domain.NodeConfig": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.NodeConfig`\n\nConfiguration options for defining the setup of any node type within the\ncluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe instance type of a particular node within the cluster.\n*Required*: No\n*Type*: String\n*Allowed values*: `m3.medium.search | m3.large...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "or1.medium.search", "or1.large.search", "or1.xlarge.search", "or1.2xlarge.search", "or1.4xlarge.search", "or1.8xlarge.search", "or1.12xlarge.search", "or1.16xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeconfig.html#cfn-opensearchservice-domain-nodeconfig-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nA boolean value indicating whether a specific node type is active or inactive.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeconfig.html#cfn-opensearchservice-domain-nodeconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Count": { "MarkdownDocumentation": "`Count`\n\nThe number of nodes of a specific type within 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeconfig.html#cfn-opensearchservice-domain-nodeconfig-count", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::OpenSearchService::Domain.NodeOption": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.NodeOption`\n\nConfiguration settings for defining the node type within a cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeoption.html", "Properties": { "NodeType": { "MarkdownDocumentation": "`NodeType`\n\nDefines the type of node, such as coordinating nodes.\n*Required*: No\n*Type*: String\n*Allowed values*: `coordinator...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "coordinator" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeoption.html#cfn-opensearchservice-domain-nodeoption-nodetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NodeConfig": { "MarkdownDocumentation": "`NodeConfig`\n\nConfiguration options for defining the setup of any node type.\n*Required*: No\n*Type*: [NodeConfig](./aws-properties-opensearchservice-domain-nodeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeoption.html#cfn-opensearchservice-domain-nodeoption-nodeconfig", "UpdateType": "Mutable", "Required": false, "Type": "NodeConfig" } } }, "AWS::OpenSearchService::Domain.NodeToNodeEncryptionOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.NodeToNodeEncryptionOptions`\n\nSpecifies options for node-to-node encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies to enable or disable node-to-node encryption on the domain. Required if you\nenable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html#cfn-opensearchservice-domain-nodetonodeencryptionoptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.OffPeakWindow": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.OffPeakWindow`\n\nA custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain.\nThese actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will\nschedule these actions during the window that you specify. If you don't specify a window start time, it defaults to 10:00 P.M. local time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindow.html", "Properties": { "WindowStartTime": { "MarkdownDocumentation": "`WindowStartTime`\n\nThe desired start time for an off-peak maintenance window.\n*Required*: No\n*Type*: [WindowStartTime](./aws-properties-opensearchservice-domain-windowstarttime.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindow.html#cfn-opensearchservice-domain-offpeakwindow-windowstarttime", "UpdateType": "Mutable", "Required": false, "Type": "WindowStartTime" } } }, "AWS::OpenSearchService::Domain.OffPeakWindowOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.OffPeakWindowOptions`\n\nOff-peak window settings for the domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindowoptions.html", "Properties": { "OffPeakWindow": { "MarkdownDocumentation": "`OffPeakWindow`\n\nOff-peak window settings for the domain.\n*Required*: No\n*Type*: [OffPeakWindow](./aws-properties-opensearchservice-domain-offpeakwindow.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindowoptions.html#cfn-opensearchservice-domain-offpeakwindowoptions-offpeakwindow", "UpdateType": "Mutable", "Required": false, "Type": "OffPeakWindow" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether off-peak window settings are enabled for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindowoptions.html#cfn-opensearchservice-domain-offpeakwindowoptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.S3VectorsEngine": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.S3VectorsEngine`\n\nOptions for enabling S3 vectors engine features on the specified domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-s3vectorsengine.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nEnables S3 vectors engine features.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-s3vectorsengine.html#cfn-opensearchservice-domain-s3vectorsengine-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.SAMLOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.SAMLOptions`\n\nContainer for information about the SAML configuration for OpenSearch\nDashboards.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html", "Properties": { "MasterBackendRole": { "MarkdownDocumentation": "`MasterBackendRole`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-masterbackendrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubjectKey": { "MarkdownDocumentation": "`SubjectKey`\n\nElement of the SAML assertion to use for the user name. Default is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-subjectkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Idp": { "MarkdownDocumentation": "`Idp`\n\nThe SAML Identity Provider's information.\n*Required*: No\n*Type*: [Idp](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-idp", "UpdateType": "Mutable", "Required": false, "Type": "Idp" }, "SessionTimeoutMinutes": { "MarkdownDocumentation": "`SessionTimeoutMinutes`\n\nThe duration, in minutes, after which a user session becomes inactive. Acceptable\nvalues 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-sessiontimeoutminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RolesKey": { "MarkdownDocumentation": "`RolesKey`\n\nElement of the SAML assertion to use for backend roles. Default is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-roleskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nTrue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MasterUserName": { "MarkdownDocumentation": "`MasterUserName`\n\nThe SAML master user name, which is stored in the domain's internal user\ndatabase.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-masterusername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::OpenSearchService::Domain.ServiceSoftwareOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.ServiceSoftwareOptions`\n\nThe current status of the service software for an Amazon OpenSearch Service domain.\nFor more information, see [Service\nsoftware updates in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html", "Properties": { "NewVersion": { "MarkdownDocumentation": "`NewVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-newversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpdateStatus": { "MarkdownDocumentation": "`UpdateStatus`\n\nThe status of your service software update.\n*Required*: No\n*Type*: String\n*Allowed values*: `PENDING_UPDATE | IN_PROGRES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-updatestatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cancellable": { "MarkdownDocumentation": "`Cancellable`\n\nTrue if you're able to cancel your service software version update. False if you\ncan'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-cancellable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CurrentVersion": { "MarkdownDocumentation": "`CurrentVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-currentversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutomatedUpdateDate": { "MarkdownDocumentation": "`AutomatedUpdateDate`\n\nThe timestamp, in Epoch time, until which you can manually request a service software\nupdate. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-automatedupdatedate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpdateAvailable": { "MarkdownDocumentation": "`UpdateAvailable`\n\nTrue if you're able to update your service software version. False if you can't update\nyour 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-updateavailable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "OptionalDeployment": { "MarkdownDocumentation": "`OptionalDeployment`\n\nTrue if a service software is never automatically updated. False if a service software\nis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-optionaldeployment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.SnapshotOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.SnapshotOptions`\n\n**DEPRECATED**. This setting is only relevant to domains\nrunning legacy Elasticsearch OSS versions earlier than 5.3. It does not apply to OpenSearch\ndomains.\nThe automated snapshot configuration for the OpenSearch Service domain indexes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html", "Properties": { "AutomatedSnapshotStartHour": { "MarkdownDocumentation": "`AutomatedSnapshotStartHour`\n\nThe hour in UTC during which the service takes an automated daily snapshot of the indexes\nin the OpenSearch Service domain. For example, if you specify 0, OpenSearch Service takes an\nautomated snapshot everyday between midnight and 1 am. You can specify a value between 0 and\n23.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html#cfn-opensearchservice-domain-snapshotoptions-automatedsnapshotstarthour", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::OpenSearchService::Domain.SoftwareUpdateOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.SoftwareUpdateOptions`\n\nOptions for configuring service software updates for a domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-softwareupdateoptions.html", "Properties": { "AutoSoftwareUpdateEnabled": { "MarkdownDocumentation": "`AutoSoftwareUpdateEnabled`\n\nSpecifies whether automatic service software updates are enabled for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-softwareupdateoptions.html#cfn-opensearchservice-domain-softwareupdateoptions-autosoftwareupdateenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::OpenSearchService::Domain.VPCOptions": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.VPCOptions`\n\nThe virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more\ninformation, see [Launching your Amazon OpenSearch\nService domains using a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html", "Properties": { "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe list of security group IDs that are associated with the VPC endpoints for the domain.\nIf you don't provide a security group ID, OpenSearch Service uses the default security group\nfor the VPC. To learn more, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in\nthe *Amazon VPC User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html#cfn-opensearchservice-domain-vpcoptions-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nProvide one subnet ID for each Availability Zone that your domain uses. For example, you\nmust 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\nthe *Amazon VPC User Guide*.\nIf you specify more than one subnet, you must also configure\n`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\"\nduring template creation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html#cfn-opensearchservice-domain-vpcoptions-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::OpenSearchService::Domain.WindowStartTime": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.WindowStartTime`\n\nA custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't\nspecify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-windowstarttime.html", "Properties": { "Hours": { "MarkdownDocumentation": "`Hours`\n\nThe start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.\nThe minimum value is 0 and the maximum value is 23.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-windowstarttime.html#cfn-opensearchservice-domain-windowstarttime-hours", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Minutes": { "MarkdownDocumentation": "`Minutes`\n\nThe start minute of the window, in UTC. The minimum value is 0 and the maximum value is 59.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-windowstarttime.html#cfn-opensearchservice-domain-windowstarttime-minutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::OpenSearchService::Domain.ZoneAwarenessConfig": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain.ZoneAwarenessConfig`\n\nSpecifies zone awareness configuration options. Only use if\n`ZoneAwarenessEnabled` is `true`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-zoneawarenessconfig.html", "Properties": { "AvailabilityZoneCount": { "MarkdownDocumentation": "`AvailabilityZoneCount`\n\nIf you enabled multiple Availability Zones (AZs), the number of AZs that you want the\ndomain 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-zoneawarenessconfig.html#cfn-opensearchservice-domain-zoneawarenessconfig-availabilityzonecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::OpsWorks::App.DataSource": { "MarkdownDocumentation": "`AWS::OpsWorks::App.DataSource`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html", "Properties": { "Arn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-arn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DatabaseName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-databasename", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-type", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::App.EnvironmentVariable": { "MarkdownDocumentation": "`AWS::OpsWorks::App.EnvironmentVariable`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html", "Properties": { "Key": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#cfn-opsworks-app-environment-key", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Secure": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#cfn-opsworks-app-environment-secure", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Value": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#value", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::App.Source": { "MarkdownDocumentation": "`AWS::OpsWorks::App.Source`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html", "Properties": { "Password": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-pw", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Revision": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SshKey": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Url": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Username": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::App.SslConfiguration": { "MarkdownDocumentation": "`AWS::OpsWorks::App.SslConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html", "Properties": { "Certificate": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-certificate", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Chain": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-chain", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "PrivateKey": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-privatekey", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Instance.BlockDeviceMapping": { "MarkdownDocumentation": "`AWS::OpsWorks::Instance.BlockDeviceMapping`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html", "Properties": { "DeviceName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-devicename", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Ebs": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-ebs", "Required": false, "Type": "EbsBlockDevice", "UpdateType": "Mutable" }, "NoDevice": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-nodevice", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "VirtualName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-virtualname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Instance.EbsBlockDevice": { "MarkdownDocumentation": "`AWS::OpsWorks::Instance.EbsBlockDevice`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html", "Properties": { "DeleteOnTermination": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-deleteontermination", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Iops": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-iops", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "SnapshotId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-snapshotid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "VolumeSize": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumesize", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "VolumeType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumetype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Instance.TimeBasedAutoScaling": { "MarkdownDocumentation": "`AWS::OpsWorks::Instance.TimeBasedAutoScaling`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html", "Properties": { "Friday": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-friday", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Monday": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-monday", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Saturday": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-saturday", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Sunday": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-sunday", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Thursday": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-thursday", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Tuesday": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-tuesday", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Wednesday": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-wednesday", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Layer.AutoScalingThresholds": { "MarkdownDocumentation": "`AWS::OpsWorks::Layer.AutoScalingThresholds`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html", "Properties": { "CpuThreshold": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-cputhreshold", "PrimitiveType": "Double", "Required": false, "UpdateType": "Mutable" }, "IgnoreMetricsTime": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-ignoremetricstime", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "InstanceCount": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-instancecount", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "LoadThreshold": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-loadthreshold", "PrimitiveType": "Double", "Required": false, "UpdateType": "Mutable" }, "MemoryThreshold": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-memorythreshold", "PrimitiveType": "Double", "Required": false, "UpdateType": "Mutable" }, "ThresholdsWaitTime": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-thresholdwaittime", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Layer.LifecycleEventConfiguration": { "MarkdownDocumentation": "`AWS::OpsWorks::Layer.LifecycleEventConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html", "Properties": { "ShutdownEventConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration", "Required": false, "Type": "ShutdownEventConfiguration", "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Layer.LoadBasedAutoScaling": { "MarkdownDocumentation": "`AWS::OpsWorks::Layer.LoadBasedAutoScaling`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html", "Properties": { "DownScaling": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-downscaling", "Required": false, "Type": "AutoScalingThresholds", "UpdateType": "Mutable" }, "Enable": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-enable", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "UpScaling": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-upscaling", "Required": false, "Type": "AutoScalingThresholds", "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Layer.Recipes": { "MarkdownDocumentation": "`AWS::OpsWorks::Layer.Recipes`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html", "Properties": { "Configure": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-configure", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Deploy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-deploy", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Setup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-setup", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Shutdown": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-shutdown", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Undeploy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-undeploy", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Layer.ShutdownEventConfiguration": { "MarkdownDocumentation": "`AWS::OpsWorks::Layer.ShutdownEventConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html", "Properties": { "DelayUntilElbConnectionsDrained": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration-delayuntilelbconnectionsdrained", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "ExecutionTimeout": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration-executiontimeout", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Layer.VolumeConfiguration": { "MarkdownDocumentation": "`AWS::OpsWorks::Layer.VolumeConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html", "Properties": { "Encrypted": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-encrypted", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Iops": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-iops", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "MountPoint": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-mountpoint", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "NumberOfDisks": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-numberofdisks", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "RaidLevel": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-raidlevel", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "Size": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-size", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "VolumeType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-volumetype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Stack.ChefConfiguration": { "MarkdownDocumentation": "`AWS::OpsWorks::Stack.ChefConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html", "Properties": { "BerkshelfVersion": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-chefconfiguration-berkshelfversion", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ManageBerkshelf": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-chefconfiguration-berkshelfversion", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Stack.ElasticIp": { "MarkdownDocumentation": "`AWS::OpsWorks::Stack.ElasticIp`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html", "Properties": { "Ip": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-ip", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Stack.RdsDbInstance": { "MarkdownDocumentation": "`AWS::OpsWorks::Stack.RdsDbInstance`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html", "Properties": { "DbPassword": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbpassword", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "DbUser": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbuser", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "RdsDbInstanceArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-rdsdbinstancearn", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Stack.Source": { "MarkdownDocumentation": "`AWS::OpsWorks::Stack.Source`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html", "Properties": { "Password": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-password", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Revision": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SshKey": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Url": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Username": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Stack.StackConfigurationManager": { "MarkdownDocumentation": "`AWS::OpsWorks::Stack.StackConfigurationManager`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html", "Properties": { "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html#cfn-opsworks-configmanager-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Version": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html#cfn-opsworks-configmanager-version", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::PCAConnectorAD::Connector.VpcInformation": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Connector.VpcInformation`\n\nInformation about your VPC and security groups used with the connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-connector-vpcinformation.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe VPC IP address type.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | DUALSTACK...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "DUALSTACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-connector-vpcinformation.html#cfn-pcaconnectorad-connector-vpcinformation-ipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe security groups used with the connector. You can use a maximum of 4 security groups\nwith a connector.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `11 | 1`\n*Maximum*: `20 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-connector-vpcinformation.html#cfn-pcaconnectorad-connector-vpcinformation-securitygroupids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::PCAConnectorAD::Template.ApplicationPolicies": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.ApplicationPolicies`\n\nApplication policies describe what the certificate can be used for.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-applicationpolicies.html", "Properties": { "Policies": { "MarkdownDocumentation": "`Policies`\n\nApplication policies describe what the certificate can be used for.\n*Required*: Yes\n*Type*: Array of [ApplicationPolicy](./aws-properties-pcaconnectorad-template-applicationpolicy.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-applicationpolicies.html#cfn-pcaconnectorad-template-applicationpolicies-policies", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ApplicationPolicy", "DuplicatesAllowed": false }, "Critical": { "MarkdownDocumentation": "`Critical`\n\nMarks the application policy extension as critical.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-applicationpolicies.html#cfn-pcaconnectorad-template-applicationpolicies-critical", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.ApplicationPolicy": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.ApplicationPolicy`\n\nApplication policies describe what the certificate can be used for.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-applicationpolicy.html", "Properties": { "PolicyType": { "MarkdownDocumentation": "`PolicyType`\n\nThe type of application policy\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_APPLICATION_POLICIES | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_APPLICATION_POLICIES", "ANY_PURPOSE", "ATTESTATION_IDENTITY_KEY_CERTIFICATE", "CERTIFICATE_REQUEST_AGENT", "CLIENT_AUTHENTICATION", "CODE_SIGNING", "CTL_USAGE", "DIGITAL_RIGHTS", "DIRECTORY_SERVICE_EMAIL_REPLICATION", "DISALLOWED_LIST", "DNS_SERVER_TRUST", "DOCUMENT_ENCRYPTION", "DOCUMENT_SIGNING", "DYNAMIC_CODE_GENERATOR", "EARLY_LAUNCH_ANTIMALWARE_DRIVER", "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "ENCLAVE", "ENCRYPTING_FILE_SYSTEM", "ENDORSEMENT_KEY_CERTIFICATE", "FILE_RECOVERY", "HAL_EXTENSION", "IP_SECURITY_END_SYSTEM", "IP_SECURITY_IKE_INTERMEDIATE", "IP_SECURITY_TUNNEL_TERMINATION", "IP_SECURITY_USER", "ISOLATED_USER_MODE", "KDC_AUTHENTICATION", "KERNEL_MODE_CODE_SIGNING", "KEY_PACK_LICENSES", "KEY_RECOVERY", "KEY_RECOVERY_AGENT", "LICENSE_SERVER_VERIFICATION", "LIFETIME_SIGNING", "MICROSOFT_PUBLISHER", "MICROSOFT_TIME_STAMPING", "MICROSOFT_TRUST_LIST_SIGNING", "OCSP_SIGNING", "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "PLATFORM_CERTIFICATE", "PREVIEW_BUILD_SIGNING", "PRIVATE_KEY_ARCHIVAL", "PROTECTED_PROCESS_LIGHT_VERIFICATION", "PROTECTED_PROCESS_VERIFICATION", "QUALIFIED_SUBORDINATION", "REVOKED_LIST_SIGNER", "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", "ROOT_LIST_SIGNER", "SECURE_EMAIL", "SERVER_AUTHENTICATION", "SMART_CARD_LOGIN", "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", "SPC_RELAXED_PE_MARKER_CHECK", "TIME_STAMPING", "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_VERIFICATION", "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", "WINDOWS_KITS_COMPONENT", "WINDOWS_RT_VERIFICATION", "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", "WINDOWS_STORE", "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "WINDOWS_TCB_COMPONENT", "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", "WINDOWS_UPDATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-applicationpolicy.html#cfn-pcaconnectorad-template-applicationpolicy-policytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyObjectIdentifier": { "MarkdownDocumentation": "`PolicyObjectIdentifier`\n\nThe object identifier (OID) of an application policy.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))(\\.([0-9]+)){0,126}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-applicationpolicy.html#cfn-pcaconnectorad-template-applicationpolicy-policyobjectidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCAConnectorAD::Template.CertificateValidity": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.CertificateValidity`\n\nInformation describing the end of the validity period of the certificate. This parameter\nsets the \u201cNot After\u201d date for the certificate. Certificate validity is the period of time\nduring which a certificate is valid. Validity can be expressed as an explicit date and time\nwhen the certificate expires, or as a span of time after issuance, stated in days, months,\nor years. For more information, see Validity in RFC 5280. This value is unaffected when\nValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\nfuture, the certificate will expire 20 days from issuance time regardless of the\nValidityNotBefore value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-certificatevalidity.html", "Properties": { "ValidityPeriod": { "MarkdownDocumentation": "`ValidityPeriod`\n\nInformation describing the end of the validity period of the certificate. This parameter\nsets the \u201cNot After\u201d date for the certificate. Certificate validity is the period of time\nduring which a certificate is valid. Validity can be expressed as an explicit date and time\nwhen the certificate expires, or as a span of time after issuance, stated in days, months,\nor years. For more information, see Validity in RFC 5280. This value is unaffected when\nValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\nfuture, the certificate will expire 20 days from issuance time regardless of the\nValidityNotBefore value.\n*Required*: Yes\n*Type*: [ValidityPeriod](./aws-properties-pcaconnectorad-template-validityperiod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-certificatevalidity.html#cfn-pcaconnectorad-template-certificatevalidity-validityperiod", "UpdateType": "Mutable", "Required": true, "Type": "ValidityPeriod" }, "RenewalPeriod": { "MarkdownDocumentation": "`RenewalPeriod`\n\nRenewal period is the period of time before certificate expiration when a new\ncertificate will be requested.\n*Required*: Yes\n*Type*: [ValidityPeriod](./aws-properties-pcaconnectorad-template-validityperiod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-certificatevalidity.html#cfn-pcaconnectorad-template-certificatevalidity-renewalperiod", "UpdateType": "Mutable", "Required": true, "Type": "ValidityPeriod" } } }, "AWS::PCAConnectorAD::Template.EnrollmentFlagsV2": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.EnrollmentFlagsV2`\n\nTemplate configurations for v2 template schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv2.html", "Properties": { "NoSecurityExtension": { "MarkdownDocumentation": "`NoSecurityExtension`\n\nThis flag instructs the CA to not include the security extension\nszOID\\_NTDS\\_CA\\_SECURITY\\_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\nKerberos elevation-of-privilege vulnerability.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv2.html#cfn-pcaconnectorad-template-enrollmentflagsv2-nosecurityextension", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IncludeSymmetricAlgorithms": { "MarkdownDocumentation": "`IncludeSymmetricAlgorithms`\n\nInclude symmetric algorithms allowed by the subject.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv2.html#cfn-pcaconnectorad-template-enrollmentflagsv2-includesymmetricalgorithms", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "UserInteractionRequired": { "MarkdownDocumentation": "`UserInteractionRequired`\n\nRequire user interaction when the subject is enrolled and the private key associated\nwith the certificate is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv2.html#cfn-pcaconnectorad-template-enrollmentflagsv2-userinteractionrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableKeyReuseOnNtTokenKeysetStorageFull": { "MarkdownDocumentation": "`EnableKeyReuseOnNtTokenKeysetStorageFull`\n\nAllow renewal using the same 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv2.html#cfn-pcaconnectorad-template-enrollmentflagsv2-enablekeyreuseonnttokenkeysetstoragefull", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RemoveInvalidCertificateFromPersonalStore": { "MarkdownDocumentation": "`RemoveInvalidCertificateFromPersonalStore`\n\nDelete expired or revoked certificates instead of archiving 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv2.html#cfn-pcaconnectorad-template-enrollmentflagsv2-removeinvalidcertificatefrompersonalstore", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.EnrollmentFlagsV3": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.EnrollmentFlagsV3`\n\nTemplate configurations for v3 template schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv3.html", "Properties": { "NoSecurityExtension": { "MarkdownDocumentation": "`NoSecurityExtension`\n\nThis flag instructs the CA to not include the security extension\nszOID\\_NTDS\\_CA\\_SECURITY\\_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\nKerberos elevation-of-privilege vulnerability.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv3.html#cfn-pcaconnectorad-template-enrollmentflagsv3-nosecurityextension", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IncludeSymmetricAlgorithms": { "MarkdownDocumentation": "`IncludeSymmetricAlgorithms`\n\nInclude symmetric algorithms allowed by the subject.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv3.html#cfn-pcaconnectorad-template-enrollmentflagsv3-includesymmetricalgorithms", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "UserInteractionRequired": { "MarkdownDocumentation": "`UserInteractionRequired`\n\nRequire user interaction when the subject is enrolled and the private key associated\nwith the certificate is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv3.html#cfn-pcaconnectorad-template-enrollmentflagsv3-userinteractionrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableKeyReuseOnNtTokenKeysetStorageFull": { "MarkdownDocumentation": "`EnableKeyReuseOnNtTokenKeysetStorageFull`\n\nAllow renewal using the same 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv3.html#cfn-pcaconnectorad-template-enrollmentflagsv3-enablekeyreuseonnttokenkeysetstoragefull", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RemoveInvalidCertificateFromPersonalStore": { "MarkdownDocumentation": "`RemoveInvalidCertificateFromPersonalStore`\n\nDelete expired or revoked certificates instead of archiving 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv3.html#cfn-pcaconnectorad-template-enrollmentflagsv3-removeinvalidcertificatefrompersonalstore", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.EnrollmentFlagsV4": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.EnrollmentFlagsV4`\n\nTemplate configurations for v4 template schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv4.html", "Properties": { "NoSecurityExtension": { "MarkdownDocumentation": "`NoSecurityExtension`\n\nThis flag instructs the CA to not include the security extension\nszOID\\_NTDS\\_CA\\_SECURITY\\_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\nKerberos elevation-of-privilege vulnerability.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv4.html#cfn-pcaconnectorad-template-enrollmentflagsv4-nosecurityextension", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IncludeSymmetricAlgorithms": { "MarkdownDocumentation": "`IncludeSymmetricAlgorithms`\n\nInclude symmetric algorithms allowed by the subject.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv4.html#cfn-pcaconnectorad-template-enrollmentflagsv4-includesymmetricalgorithms", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "UserInteractionRequired": { "MarkdownDocumentation": "`UserInteractionRequired`\n\nRequire user interaction when the subject is enrolled and the private key associated\nwith the certificate is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv4.html#cfn-pcaconnectorad-template-enrollmentflagsv4-userinteractionrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableKeyReuseOnNtTokenKeysetStorageFull": { "MarkdownDocumentation": "`EnableKeyReuseOnNtTokenKeysetStorageFull`\n\nAllow renewal using the same 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv4.html#cfn-pcaconnectorad-template-enrollmentflagsv4-enablekeyreuseonnttokenkeysetstoragefull", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RemoveInvalidCertificateFromPersonalStore": { "MarkdownDocumentation": "`RemoveInvalidCertificateFromPersonalStore`\n\nDelete expired or revoked certificates instead of archiving 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-enrollmentflagsv4.html#cfn-pcaconnectorad-template-enrollmentflagsv4-removeinvalidcertificatefrompersonalstore", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.ExtensionsV2": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.ExtensionsV2`\n\nCertificate extensions for v2 template schema\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv2.html", "Properties": { "ApplicationPolicies": { "MarkdownDocumentation": "`ApplicationPolicies`\n\nApplication policies specify what the certificate is used for and its purpose.\n*Required*: No\n*Type*: [ApplicationPolicies](./aws-properties-pcaconnectorad-template-applicationpolicies.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv2.html#cfn-pcaconnectorad-template-extensionsv2-applicationpolicies", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationPolicies" }, "KeyUsage": { "MarkdownDocumentation": "`KeyUsage`\n\nThe key usage extension defines the purpose (e.g., encipherment, signature, certificate\nsigning) of the key contained in the certificate.\n*Required*: Yes\n*Type*: [KeyUsage](./aws-properties-pcaconnectorad-template-keyusage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv2.html#cfn-pcaconnectorad-template-extensionsv2-keyusage", "UpdateType": "Mutable", "Required": true, "Type": "KeyUsage" } } }, "AWS::PCAConnectorAD::Template.ExtensionsV3": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.ExtensionsV3`\n\nCertificate extensions for v3 template schema\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv3.html", "Properties": { "ApplicationPolicies": { "MarkdownDocumentation": "`ApplicationPolicies`\n\nApplication policies specify what the certificate is used for and its purpose.\n*Required*: No\n*Type*: [ApplicationPolicies](./aws-properties-pcaconnectorad-template-applicationpolicies.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv3.html#cfn-pcaconnectorad-template-extensionsv3-applicationpolicies", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationPolicies" }, "KeyUsage": { "MarkdownDocumentation": "`KeyUsage`\n\nThe key usage extension defines the purpose (e.g., encipherment, signature, certificate\nsigning) of the key contained in the certificate.\n*Required*: Yes\n*Type*: [KeyUsage](./aws-properties-pcaconnectorad-template-keyusage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv3.html#cfn-pcaconnectorad-template-extensionsv3-keyusage", "UpdateType": "Mutable", "Required": true, "Type": "KeyUsage" } } }, "AWS::PCAConnectorAD::Template.ExtensionsV4": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.ExtensionsV4`\n\nCertificate extensions for v4 template schema\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv4.html", "Properties": { "ApplicationPolicies": { "MarkdownDocumentation": "`ApplicationPolicies`\n\nApplication policies specify what the certificate is used for and its purpose.\n*Required*: No\n*Type*: [ApplicationPolicies](./aws-properties-pcaconnectorad-template-applicationpolicies.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv4.html#cfn-pcaconnectorad-template-extensionsv4-applicationpolicies", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationPolicies" }, "KeyUsage": { "MarkdownDocumentation": "`KeyUsage`\n\nThe key usage extension defines the purpose (e.g., encipherment, signature) of the key\ncontained in the certificate.\n*Required*: Yes\n*Type*: [KeyUsage](./aws-properties-pcaconnectorad-template-keyusage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-extensionsv4.html#cfn-pcaconnectorad-template-extensionsv4-keyusage", "UpdateType": "Mutable", "Required": true, "Type": "KeyUsage" } } }, "AWS::PCAConnectorAD::Template.GeneralFlagsV2": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.GeneralFlagsV2`\n\nGeneral flags for v2 template schema that defines if the template is for a machine or a\nuser and if the template can be issued using autoenrollment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv2.html", "Properties": { "AutoEnrollment": { "MarkdownDocumentation": "`AutoEnrollment`\n\nAllows certificate issuance using autoenrollment. Set to TRUE to allow\nautoenrollment.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv2.html#cfn-pcaconnectorad-template-generalflagsv2-autoenrollment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MachineType": { "MarkdownDocumentation": "`MachineType`\n\nDefines if the template is for machines or users. Set to TRUE if the template is for\nmachines. Set to FALSE if the template is for users.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv2.html#cfn-pcaconnectorad-template-generalflagsv2-machinetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.GeneralFlagsV3": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.GeneralFlagsV3`\n\nGeneral flags for v3 template schema that defines if the template is for a machine or a\nuser and if the template can be issued using autoenrollment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv3.html", "Properties": { "AutoEnrollment": { "MarkdownDocumentation": "`AutoEnrollment`\n\nAllows certificate issuance using autoenrollment. Set to TRUE to allow\nautoenrollment.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv3.html#cfn-pcaconnectorad-template-generalflagsv3-autoenrollment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MachineType": { "MarkdownDocumentation": "`MachineType`\n\nDefines if the template is for machines or users. Set to TRUE if the template is for\nmachines. Set to FALSE if the template is for users\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv3.html#cfn-pcaconnectorad-template-generalflagsv3-machinetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.GeneralFlagsV4": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.GeneralFlagsV4`\n\nGeneral flags for v4 template schema that defines if the template is for a machine or a\nuser and if the template can be issued using autoenrollment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv4.html", "Properties": { "AutoEnrollment": { "MarkdownDocumentation": "`AutoEnrollment`\n\nAllows certificate issuance using autoenrollment. Set to TRUE to allow\nautoenrollment.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv4.html#cfn-pcaconnectorad-template-generalflagsv4-autoenrollment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MachineType": { "MarkdownDocumentation": "`MachineType`\n\nDefines if the template is for machines or users. Set to TRUE if the template is for\nmachines. Set to FALSE if the template is for users\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-generalflagsv4.html#cfn-pcaconnectorad-template-generalflagsv4-machinetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.KeyUsage": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.KeyUsage`\n\nThe key usage extension defines the purpose (e.g., encipherment, signature) of the key\ncontained in the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusage.html", "Properties": { "Critical": { "MarkdownDocumentation": "`Critical`\n\nSets the key usage extension to critical.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusage.html#cfn-pcaconnectorad-template-keyusage-critical", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "UsageFlags": { "MarkdownDocumentation": "`UsageFlags`\n\nThe key usage flags represent the purpose (e.g., encipherment, signature) of the key\ncontained in the certificate.\n*Required*: Yes\n*Type*: [KeyUsageFlags](./aws-properties-pcaconnectorad-template-keyusageflags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusage.html#cfn-pcaconnectorad-template-keyusage-usageflags", "UpdateType": "Mutable", "Required": true, "Type": "KeyUsageFlags" } } }, "AWS::PCAConnectorAD::Template.KeyUsageFlags": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.KeyUsageFlags`\n\nThe key usage flags represent the purpose (e.g., encipherment, signature) of the key\ncontained in the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageflags.html", "Properties": { "KeyEncipherment": { "MarkdownDocumentation": "`KeyEncipherment`\n\nKeyEncipherment is asserted when the subject public key is used for enciphering private\nor secret keys, i.e., for key transport.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageflags.html#cfn-pcaconnectorad-template-keyusageflags-keyencipherment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DataEncipherment": { "MarkdownDocumentation": "`DataEncipherment`\n\nDataEncipherment is asserted when the subject public key is used for directly\nenciphering raw user data without the use of an intermediate symmetric cipher.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageflags.html#cfn-pcaconnectorad-template-keyusageflags-dataencipherment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DigitalSignature": { "MarkdownDocumentation": "`DigitalSignature`\n\nThe digitalSignature is asserted when the subject public key is used for verifying\ndigital signatures.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageflags.html#cfn-pcaconnectorad-template-keyusageflags-digitalsignature", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyAgreement": { "MarkdownDocumentation": "`KeyAgreement`\n\nKeyAgreement is asserted when the subject public key is used for key agreement.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageflags.html#cfn-pcaconnectorad-template-keyusageflags-keyagreement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NonRepudiation": { "MarkdownDocumentation": "`NonRepudiation`\n\nNonRepudiation is asserted when the subject public key is used to verify digital\nsignatures.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageflags.html#cfn-pcaconnectorad-template-keyusageflags-nonrepudiation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.KeyUsageProperty": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.KeyUsageProperty`\n\nThe key usage property defines the purpose of the private key contained in the\ncertificate. You can specify specific purposes using property flags or all by using\nproperty type ALL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageproperty.html", "Properties": { "PropertyFlags": { "MarkdownDocumentation": "`PropertyFlags`\n\nYou can specify key usage for encryption, key agreement, and signature. You can use\nproperty flags or property type but not both.\n*Required*: No\n*Type*: [KeyUsagePropertyFlags](./aws-properties-pcaconnectorad-template-keyusagepropertyflags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageproperty.html#cfn-pcaconnectorad-template-keyusageproperty-propertyflags", "UpdateType": "Mutable", "Required": false, "Type": "KeyUsagePropertyFlags" }, "PropertyType": { "MarkdownDocumentation": "`PropertyType`\n\nYou can specify all key usages using property type ALL. You can use property type or\nproperty flags but not both.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusageproperty.html#cfn-pcaconnectorad-template-keyusageproperty-propertytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCAConnectorAD::Template.KeyUsagePropertyFlags": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.KeyUsagePropertyFlags`\n\nSpecifies key usage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusagepropertyflags.html", "Properties": { "Decrypt": { "MarkdownDocumentation": "`Decrypt`\n\nAllows key for encryption and decryption.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusagepropertyflags.html#cfn-pcaconnectorad-template-keyusagepropertyflags-decrypt", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Sign": { "MarkdownDocumentation": "`Sign`\n\nAllow key use for digital signature.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusagepropertyflags.html#cfn-pcaconnectorad-template-keyusagepropertyflags-sign", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyAgreement": { "MarkdownDocumentation": "`KeyAgreement`\n\nAllows key exchange without encryption.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-keyusagepropertyflags.html#cfn-pcaconnectorad-template-keyusagepropertyflags-keyagreement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.PrivateKeyAttributesV2": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.PrivateKeyAttributesV2`\n\nDefines the attributes of the private key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv2.html", "Properties": { "MinimalKeyLength": { "MarkdownDocumentation": "`MinimalKeyLength`\n\nSet the minimum key length of the private key.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv2.html#cfn-pcaconnectorad-template-privatekeyattributesv2-minimalkeylength", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "KeySpec": { "MarkdownDocumentation": "`KeySpec`\n\nDefines the purpose of the private key. Set it to \"KEY\\_EXCHANGE\" or \"SIGNATURE\"\nvalue.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `KEY_EXCHANGE | SIGNATURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEY_EXCHANGE", "SIGNATURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv2.html#cfn-pcaconnectorad-template-privatekeyattributesv2-keyspec", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CryptoProviders": { "MarkdownDocumentation": "`CryptoProviders`\n\nDefines the cryptographic providers used to generate the private key.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv2.html#cfn-pcaconnectorad-template-privatekeyattributesv2-cryptoproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::PCAConnectorAD::Template.PrivateKeyAttributesV3": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.PrivateKeyAttributesV3`\n\nDefines the attributes of the private key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv3.html", "Properties": { "MinimalKeyLength": { "MarkdownDocumentation": "`MinimalKeyLength`\n\nSet the minimum key length of the private key.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv3.html#cfn-pcaconnectorad-template-privatekeyattributesv3-minimalkeylength", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "KeySpec": { "MarkdownDocumentation": "`KeySpec`\n\nDefines the purpose of the private key. Set it to \"KEY\\_EXCHANGE\" or \"SIGNATURE\"\nvalue.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `KEY_EXCHANGE | SIGNATURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEY_EXCHANGE", "SIGNATURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv3.html#cfn-pcaconnectorad-template-privatekeyattributesv3-keyspec", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyUsageProperty": { "MarkdownDocumentation": "`KeyUsageProperty`\n\nThe key usage property defines the purpose of the private key contained in the\ncertificate. You can specify specific purposes using property flags or all by using\nproperty type ALL.\n*Required*: Yes\n*Type*: [KeyUsageProperty](./aws-properties-pcaconnectorad-template-keyusageproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv3.html#cfn-pcaconnectorad-template-privatekeyattributesv3-keyusageproperty", "UpdateType": "Mutable", "Required": true, "Type": "KeyUsageProperty" }, "Algorithm": { "MarkdownDocumentation": "`Algorithm`\n\nDefines the algorithm used to generate the private key.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RSA | ECDH_P256 | ECDH_P384...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RSA", "ECDH_P256", "ECDH_P384", "ECDH_P521" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv3.html#cfn-pcaconnectorad-template-privatekeyattributesv3-algorithm", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CryptoProviders": { "MarkdownDocumentation": "`CryptoProviders`\n\nDefines the cryptographic providers used to generate the private key.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv3.html#cfn-pcaconnectorad-template-privatekeyattributesv3-cryptoproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::PCAConnectorAD::Template.PrivateKeyAttributesV4": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.PrivateKeyAttributesV4`\n\nDefines the attributes of the private key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv4.html", "Properties": { "MinimalKeyLength": { "MarkdownDocumentation": "`MinimalKeyLength`\n\nSet the minimum key length of the private key.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv4.html#cfn-pcaconnectorad-template-privatekeyattributesv4-minimalkeylength", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "KeySpec": { "MarkdownDocumentation": "`KeySpec`\n\nDefines the purpose of the private key. Set it to \"KEY\\_EXCHANGE\" or \"SIGNATURE\"\nvalue.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `KEY_EXCHANGE | SIGNATURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEY_EXCHANGE", "SIGNATURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv4.html#cfn-pcaconnectorad-template-privatekeyattributesv4-keyspec", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyUsageProperty": { "MarkdownDocumentation": "`KeyUsageProperty`\n\nThe key usage property defines the purpose of the private key contained in the\ncertificate. You can specify specific purposes using property flags or all by using\nproperty type ALL.\n*Required*: No\n*Type*: [KeyUsageProperty](./aws-properties-pcaconnectorad-template-keyusageproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv4.html#cfn-pcaconnectorad-template-privatekeyattributesv4-keyusageproperty", "UpdateType": "Mutable", "Required": false, "Type": "KeyUsageProperty" }, "Algorithm": { "MarkdownDocumentation": "`Algorithm`\n\nDefines the algorithm used to generate the private key.\n*Required*: No\n*Type*: String\n*Allowed values*: `RSA | ECDH_P256 | ECDH_P384...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RSA", "ECDH_P256", "ECDH_P384", "ECDH_P521" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv4.html#cfn-pcaconnectorad-template-privatekeyattributesv4-algorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CryptoProviders": { "MarkdownDocumentation": "`CryptoProviders`\n\nDefines the cryptographic providers used to generate the private key.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyattributesv4.html#cfn-pcaconnectorad-template-privatekeyattributesv4-cryptoproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::PCAConnectorAD::Template.PrivateKeyFlagsV2": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.PrivateKeyFlagsV2`\n\nPrivate key flags for v2 templates specify the client compatibility, if the private key\ncan be exported, and if user input is required when using a private key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv2.html", "Properties": { "ExportableKey": { "MarkdownDocumentation": "`ExportableKey`\n\nAllows the private key to be exported.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv2.html#cfn-pcaconnectorad-template-privatekeyflagsv2-exportablekey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "StrongKeyProtectionRequired": { "MarkdownDocumentation": "`StrongKeyProtectionRequired`\n\nRequire user input when using the private key for enrollment.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv2.html#cfn-pcaconnectorad-template-privatekeyflagsv2-strongkeyprotectionrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ClientVersion": { "MarkdownDocumentation": "`ClientVersion`\n\nDefines the minimum client compatibility.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WINDOWS_SERVER_2003 | WINDO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS_SERVER_2003", "WINDOWS_SERVER_2008", "WINDOWS_SERVER_2008_R2", "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv2.html#cfn-pcaconnectorad-template-privatekeyflagsv2-clientversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCAConnectorAD::Template.PrivateKeyFlagsV3": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.PrivateKeyFlagsV3`\n\nPrivate key flags for v3 templates specify the client compatibility, if the private key\ncan be exported, if user input is required when using a private key, and if an alternate\nsignature algorithm should be used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv3.html", "Properties": { "RequireAlternateSignatureAlgorithm": { "MarkdownDocumentation": "`RequireAlternateSignatureAlgorithm`\n\nReguires the PKCS #1 v2.1 signature format for certificates. You should verify that your\nCA, objects, and applications can accept this signature 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv3.html#cfn-pcaconnectorad-template-privatekeyflagsv3-requirealternatesignaturealgorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExportableKey": { "MarkdownDocumentation": "`ExportableKey`\n\nAllows the private key to be exported.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv3.html#cfn-pcaconnectorad-template-privatekeyflagsv3-exportablekey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "StrongKeyProtectionRequired": { "MarkdownDocumentation": "`StrongKeyProtectionRequired`\n\nRequirer user input when using the private key for enrollment.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv3.html#cfn-pcaconnectorad-template-privatekeyflagsv3-strongkeyprotectionrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ClientVersion": { "MarkdownDocumentation": "`ClientVersion`\n\nDefines the minimum client compatibility.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WINDOWS_SERVER_2008 | WINDO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS_SERVER_2008", "WINDOWS_SERVER_2008_R2", "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv3.html#cfn-pcaconnectorad-template-privatekeyflagsv3-clientversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCAConnectorAD::Template.PrivateKeyFlagsV4": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.PrivateKeyFlagsV4`\n\nPrivate key flags for v4 templates specify the client compatibility, if the private key\ncan be exported, if user input is required when using a private key, if an alternate\nsignature algorithm should be used, and if certificates are renewed using the same private\nkey.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv4.html", "Properties": { "RequireAlternateSignatureAlgorithm": { "MarkdownDocumentation": "`RequireAlternateSignatureAlgorithm`\n\nRequires the PKCS #1 v2.1 signature format for certificates. You should verify that your\nCA, objects, and applications can accept this signature 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv4.html#cfn-pcaconnectorad-template-privatekeyflagsv4-requirealternatesignaturealgorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExportableKey": { "MarkdownDocumentation": "`ExportableKey`\n\nAllows the private key to be exported.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv4.html#cfn-pcaconnectorad-template-privatekeyflagsv4-exportablekey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "UseLegacyProvider": { "MarkdownDocumentation": "`UseLegacyProvider`\n\nSpecifies the cryptographic service provider category used to generate private keys. Set\nto TRUE to use Legacy Cryptographic Service Providers and FALSE to use Key Storage\nProviders.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv4.html#cfn-pcaconnectorad-template-privatekeyflagsv4-uselegacyprovider", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "StrongKeyProtectionRequired": { "MarkdownDocumentation": "`StrongKeyProtectionRequired`\n\nRequire user input when using the private key for enrollment.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv4.html#cfn-pcaconnectorad-template-privatekeyflagsv4-strongkeyprotectionrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireSameKeyRenewal": { "MarkdownDocumentation": "`RequireSameKeyRenewal`\n\nRenew certificate using the same private 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv4.html#cfn-pcaconnectorad-template-privatekeyflagsv4-requiresamekeyrenewal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ClientVersion": { "MarkdownDocumentation": "`ClientVersion`\n\nDefines the minimum client compatibility.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WINDOWS_SERVER_2012 | WINDO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-privatekeyflagsv4.html#cfn-pcaconnectorad-template-privatekeyflagsv4-clientversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCAConnectorAD::Template.SubjectNameFlagsV2": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.SubjectNameFlagsV2`\n\nInformation to include in the subject name and alternate subject name of the\ncertificate. The subject name can be common name, directory path, DNS as common name, or\nleft blank. You can optionally include email to the subject name for user templates. If you\nleave the subject name blank then you must set a subject alternate name. The subject\nalternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\nservice principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\nIf you leave the SAN blank, then you must set a subject name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html", "Properties": { "SanRequireEmail": { "MarkdownDocumentation": "`SanRequireEmail`\n\nInclude the subject's email in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-sanrequireemail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDns": { "MarkdownDocumentation": "`SanRequireDns`\n\nInclude the DNS in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-sanrequiredns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireCommonName": { "MarkdownDocumentation": "`RequireCommonName`\n\nInclude the common name in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-requirecommonname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireUpn": { "MarkdownDocumentation": "`SanRequireUpn`\n\nInclude the user principal name (UPN) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-sanrequireupn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDomainDns": { "MarkdownDocumentation": "`SanRequireDomainDns`\n\nInclude the domain DNS in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-sanrequiredomaindns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireSpn": { "MarkdownDocumentation": "`SanRequireSpn`\n\nInclude the service principal name (SPN) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-sanrequirespn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireEmail": { "MarkdownDocumentation": "`RequireEmail`\n\nInclude the subject's email in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-requireemail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireDirectoryPath": { "MarkdownDocumentation": "`RequireDirectoryPath`\n\nInclude the directory path in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-requiredirectorypath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDirectoryGuid": { "MarkdownDocumentation": "`SanRequireDirectoryGuid`\n\nInclude the globally unique identifier (GUID) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-sanrequiredirectoryguid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireDnsAsCn": { "MarkdownDocumentation": "`RequireDnsAsCn`\n\nInclude the DNS as common name in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv2.html#cfn-pcaconnectorad-template-subjectnameflagsv2-requirednsascn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.SubjectNameFlagsV3": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.SubjectNameFlagsV3`\n\nInformation to include in the subject name and alternate subject name of the\ncertificate. The subject name can be common name, directory path, DNS as common name, or\nleft blank. You can optionally include email to the subject name for user templates. If you\nleave the subject name blank then you must set a subject alternate name. The subject\nalternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\nservice principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\nIf you leave the SAN blank, then you must set a subject name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html", "Properties": { "SanRequireEmail": { "MarkdownDocumentation": "`SanRequireEmail`\n\nInclude the subject's email in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-sanrequireemail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDns": { "MarkdownDocumentation": "`SanRequireDns`\n\nInclude the DNS in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-sanrequiredns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireCommonName": { "MarkdownDocumentation": "`RequireCommonName`\n\nInclude the common name in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-requirecommonname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireUpn": { "MarkdownDocumentation": "`SanRequireUpn`\n\nInclude the user principal name (UPN) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-sanrequireupn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDomainDns": { "MarkdownDocumentation": "`SanRequireDomainDns`\n\nInclude the domain DNS in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-sanrequiredomaindns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireSpn": { "MarkdownDocumentation": "`SanRequireSpn`\n\nInclude the service principal name (SPN) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-sanrequirespn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireEmail": { "MarkdownDocumentation": "`RequireEmail`\n\nInclude the subject's email in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-requireemail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireDirectoryPath": { "MarkdownDocumentation": "`RequireDirectoryPath`\n\nInclude the directory path in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-requiredirectorypath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDirectoryGuid": { "MarkdownDocumentation": "`SanRequireDirectoryGuid`\n\nInclude the globally unique identifier (GUID) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-sanrequiredirectoryguid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireDnsAsCn": { "MarkdownDocumentation": "`RequireDnsAsCn`\n\nInclude the DNS as common name in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv3.html#cfn-pcaconnectorad-template-subjectnameflagsv3-requirednsascn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.SubjectNameFlagsV4": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.SubjectNameFlagsV4`\n\nInformation to include in the subject name and alternate subject name of the\ncertificate. The subject name can be common name, directory path, DNS as common name, or\nleft blank. You can optionally include email to the subject name for user templates. If you\nleave the subject name blank then you must set a subject alternate name. The subject\nalternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\nservice principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\nIf you leave the SAN blank, then you must set a subject name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html", "Properties": { "SanRequireEmail": { "MarkdownDocumentation": "`SanRequireEmail`\n\nInclude the subject's email in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-sanrequireemail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDns": { "MarkdownDocumentation": "`SanRequireDns`\n\nInclude the DNS in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-sanrequiredns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireCommonName": { "MarkdownDocumentation": "`RequireCommonName`\n\nInclude the common name in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-requirecommonname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireUpn": { "MarkdownDocumentation": "`SanRequireUpn`\n\nInclude the user principal name (UPN) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-sanrequireupn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDomainDns": { "MarkdownDocumentation": "`SanRequireDomainDns`\n\nInclude the domain DNS in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-sanrequiredomaindns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireSpn": { "MarkdownDocumentation": "`SanRequireSpn`\n\nInclude the service principal name (SPN) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-sanrequirespn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireEmail": { "MarkdownDocumentation": "`RequireEmail`\n\nInclude the subject's email in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-requireemail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireDirectoryPath": { "MarkdownDocumentation": "`RequireDirectoryPath`\n\nInclude the directory path in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-requiredirectorypath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SanRequireDirectoryGuid": { "MarkdownDocumentation": "`SanRequireDirectoryGuid`\n\nInclude the globally unique identifier (GUID) in the subject alternate name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-sanrequiredirectoryguid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireDnsAsCn": { "MarkdownDocumentation": "`RequireDnsAsCn`\n\nInclude the DNS as common name in the subject name.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-subjectnameflagsv4.html#cfn-pcaconnectorad-template-subjectnameflagsv4-requirednsascn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PCAConnectorAD::Template.TemplateDefinition": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.TemplateDefinition`\n\nTemplate configuration to define the information included in certificates. Define\ncertificate validity and renewal periods, certificate request handling and enrollment\noptions, key usage extensions, application policies, and cryptography settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatedefinition.html", "Properties": { "TemplateV4": { "MarkdownDocumentation": "`TemplateV4`\n\nTemplate configuration to define the information included in certificates. Define\ncertificate validity and renewal periods, certificate request handling and enrollment\noptions, key usage extensions, application policies, and cryptography settings.\n*Required*: No\n*Type*: [TemplateV4](./aws-properties-pcaconnectorad-template-templatev4.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatedefinition.html#cfn-pcaconnectorad-template-templatedefinition-templatev4", "UpdateType": "Mutable", "Required": false, "Type": "TemplateV4" }, "TemplateV3": { "MarkdownDocumentation": "`TemplateV3`\n\nTemplate configuration to define the information included in certificates. Define\ncertificate validity and renewal periods, certificate request handling and enrollment\noptions, key usage extensions, application policies, and cryptography settings.\n*Required*: No\n*Type*: [TemplateV3](./aws-properties-pcaconnectorad-template-templatev3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatedefinition.html#cfn-pcaconnectorad-template-templatedefinition-templatev3", "UpdateType": "Mutable", "Required": false, "Type": "TemplateV3" }, "TemplateV2": { "MarkdownDocumentation": "`TemplateV2`\n\nTemplate configuration to define the information included in certificates. Define\ncertificate validity and renewal periods, certificate request handling and enrollment\noptions, key usage extensions, application policies, and cryptography settings.\n*Required*: No\n*Type*: [TemplateV2](./aws-properties-pcaconnectorad-template-templatev2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatedefinition.html#cfn-pcaconnectorad-template-templatedefinition-templatev2", "UpdateType": "Mutable", "Required": false, "Type": "TemplateV2" } } }, "AWS::PCAConnectorAD::Template.TemplateV2": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.TemplateV2`\n\nv2 template schema that uses Legacy Cryptographic Providers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html", "Properties": { "SubjectNameFlags": { "MarkdownDocumentation": "`SubjectNameFlags`\n\nSubject name flags describe the subject name and subject alternate name that is included\nin a certificate.\n*Required*: Yes\n*Type*: [SubjectNameFlagsV2](./aws-properties-pcaconnectorad-template-subjectnameflagsv2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html#cfn-pcaconnectorad-template-templatev2-subjectnameflags", "UpdateType": "Mutable", "Required": true, "Type": "SubjectNameFlagsV2" }, "SupersededTemplates": { "MarkdownDocumentation": "`SupersededTemplates`\n\nList of templates in Active Directory that are superseded by this template.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html#cfn-pcaconnectorad-template-templatev2-supersededtemplates", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PrivateKeyFlags": { "MarkdownDocumentation": "`PrivateKeyFlags`\n\nPrivate key flags for v2 templates specify the client compatibility, if the private key\ncan be exported, and if user input is required when using a private key.\n*Required*: Yes\n*Type*: [PrivateKeyFlagsV2](./aws-properties-pcaconnectorad-template-privatekeyflagsv2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html#cfn-pcaconnectorad-template-templatev2-privatekeyflags", "UpdateType": "Mutable", "Required": true, "Type": "PrivateKeyFlagsV2" }, "PrivateKeyAttributes": { "MarkdownDocumentation": "`PrivateKeyAttributes`\n\nPrivate key attributes allow you to specify the minimal key length, key spec, and\ncryptographic providers for the private key of a certificate for v2 templates. V2 templates\nallow you to use Legacy Cryptographic Service Providers.\n*Required*: Yes\n*Type*: [PrivateKeyAttributesV2](./aws-properties-pcaconnectorad-template-privatekeyattributesv2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html#cfn-pcaconnectorad-template-templatev2-privatekeyattributes", "UpdateType": "Mutable", "Required": true, "Type": "PrivateKeyAttributesV2" }, "GeneralFlags": { "MarkdownDocumentation": "`GeneralFlags`\n\nGeneral flags describe whether the template is used for computers or users and if the\ntemplate can be used with autoenrollment.\n*Required*: Yes\n*Type*: [GeneralFlagsV2](./aws-properties-pcaconnectorad-template-generalflagsv2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html#cfn-pcaconnectorad-template-templatev2-generalflags", "UpdateType": "Mutable", "Required": true, "Type": "GeneralFlagsV2" }, "CertificateValidity": { "MarkdownDocumentation": "`CertificateValidity`\n\nCertificate validity describes the validity and renewal periods of a certificate.\n*Required*: Yes\n*Type*: [CertificateValidity](./aws-properties-pcaconnectorad-template-certificatevalidity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html#cfn-pcaconnectorad-template-templatev2-certificatevalidity", "UpdateType": "Mutable", "Required": true, "Type": "CertificateValidity" }, "Extensions": { "MarkdownDocumentation": "`Extensions`\n\nExtensions describe the key usage extensions and application policies for a\ntemplate.\n*Required*: Yes\n*Type*: [ExtensionsV2](./aws-properties-pcaconnectorad-template-extensionsv2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html#cfn-pcaconnectorad-template-templatev2-extensions", "UpdateType": "Mutable", "Required": true, "Type": "ExtensionsV2" }, "EnrollmentFlags": { "MarkdownDocumentation": "`EnrollmentFlags`\n\nEnrollment flags describe the enrollment settings for certificates such as using the\nexisting private key and deleting expired or revoked certificates.\n*Required*: Yes\n*Type*: [EnrollmentFlagsV2](./aws-properties-pcaconnectorad-template-enrollmentflagsv2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev2.html#cfn-pcaconnectorad-template-templatev2-enrollmentflags", "UpdateType": "Mutable", "Required": true, "Type": "EnrollmentFlagsV2" } } }, "AWS::PCAConnectorAD::Template.TemplateV3": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.TemplateV3`\n\nv3 template schema that uses Key Storage Providers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html", "Properties": { "SubjectNameFlags": { "MarkdownDocumentation": "`SubjectNameFlags`\n\nSubject name flags describe the subject name and subject alternate name that is included\nin a certificate.\n*Required*: Yes\n*Type*: [SubjectNameFlagsV3](./aws-properties-pcaconnectorad-template-subjectnameflagsv3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-subjectnameflags", "UpdateType": "Mutable", "Required": true, "Type": "SubjectNameFlagsV3" }, "SupersededTemplates": { "MarkdownDocumentation": "`SupersededTemplates`\n\nList of templates in Active Directory that are superseded by this template.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-supersededtemplates", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PrivateKeyFlags": { "MarkdownDocumentation": "`PrivateKeyFlags`\n\nPrivate key flags for v3 templates specify the client compatibility, if the private key\ncan be exported, if user input is required when using a private key, and if an alternate\nsignature algorithm should be used.\n*Required*: Yes\n*Type*: [PrivateKeyFlagsV3](./aws-properties-pcaconnectorad-template-privatekeyflagsv3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-privatekeyflags", "UpdateType": "Mutable", "Required": true, "Type": "PrivateKeyFlagsV3" }, "PrivateKeyAttributes": { "MarkdownDocumentation": "`PrivateKeyAttributes`\n\nPrivate key attributes allow you to specify the algorithm, minimal key length, key spec,\nkey usage, and cryptographic providers for the private key of a certificate for v3\ntemplates. V3 templates allow you to use Key Storage Providers.\n*Required*: Yes\n*Type*: [PrivateKeyAttributesV3](./aws-properties-pcaconnectorad-template-privatekeyattributesv3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-privatekeyattributes", "UpdateType": "Mutable", "Required": true, "Type": "PrivateKeyAttributesV3" }, "GeneralFlags": { "MarkdownDocumentation": "`GeneralFlags`\n\nGeneral flags describe whether the template is used for computers or users and if the\ntemplate can be used with autoenrollment.\n*Required*: Yes\n*Type*: [GeneralFlagsV3](./aws-properties-pcaconnectorad-template-generalflagsv3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-generalflags", "UpdateType": "Mutable", "Required": true, "Type": "GeneralFlagsV3" }, "CertificateValidity": { "MarkdownDocumentation": "`CertificateValidity`\n\nCertificate validity describes the validity and renewal periods of a certificate.\n*Required*: Yes\n*Type*: [CertificateValidity](./aws-properties-pcaconnectorad-template-certificatevalidity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-certificatevalidity", "UpdateType": "Mutable", "Required": true, "Type": "CertificateValidity" }, "Extensions": { "MarkdownDocumentation": "`Extensions`\n\nExtensions describe the key usage extensions and application policies for a\ntemplate.\n*Required*: Yes\n*Type*: [ExtensionsV3](./aws-properties-pcaconnectorad-template-extensionsv3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-extensions", "UpdateType": "Mutable", "Required": true, "Type": "ExtensionsV3" }, "EnrollmentFlags": { "MarkdownDocumentation": "`EnrollmentFlags`\n\nEnrollment flags describe the enrollment settings for certificates such as using the\nexisting private key and deleting expired or revoked certificates.\n*Required*: Yes\n*Type*: [EnrollmentFlagsV3](./aws-properties-pcaconnectorad-template-enrollmentflagsv3.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-enrollmentflags", "UpdateType": "Mutable", "Required": true, "Type": "EnrollmentFlagsV3" }, "HashAlgorithm": { "MarkdownDocumentation": "`HashAlgorithm`\n\nSpecifies the hash algorithm used to hash the private key.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SHA256 | SHA384 | SHA512...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SHA256", "SHA384", "SHA512" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev3.html#cfn-pcaconnectorad-template-templatev3-hashalgorithm", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCAConnectorAD::Template.TemplateV4": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.TemplateV4`\n\nv4 template schema that can use either Legacy Cryptographic Providers or Key Storage\nProviders.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html", "Properties": { "SubjectNameFlags": { "MarkdownDocumentation": "`SubjectNameFlags`\n\nSubject name flags describe the subject name and subject alternate name that is included\nin a certificate.\n*Required*: Yes\n*Type*: [SubjectNameFlagsV4](./aws-properties-pcaconnectorad-template-subjectnameflagsv4.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-subjectnameflags", "UpdateType": "Mutable", "Required": true, "Type": "SubjectNameFlagsV4" }, "SupersededTemplates": { "MarkdownDocumentation": "`SupersededTemplates`\n\nList of templates in Active Directory that are superseded by this template.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-supersededtemplates", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PrivateKeyFlags": { "MarkdownDocumentation": "`PrivateKeyFlags`\n\nPrivate key flags for v4 templates specify the client compatibility, if the private key\ncan be exported, if user input is required when using a private key, if an alternate\nsignature algorithm should be used, and if certificates are renewed using the same private\nkey.\n*Required*: Yes\n*Type*: [PrivateKeyFlagsV4](./aws-properties-pcaconnectorad-template-privatekeyflagsv4.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-privatekeyflags", "UpdateType": "Mutable", "Required": true, "Type": "PrivateKeyFlagsV4" }, "PrivateKeyAttributes": { "MarkdownDocumentation": "`PrivateKeyAttributes`\n\nPrivate key attributes allow you to specify the minimal key length, key spec, key usage,\nand cryptographic providers for the private key of a certificate for v4 templates. V4\ntemplates allow you to use either Key Storage Providers or Legacy Cryptographic Service\nProviders. You specify the cryptography provider category in private key flags.\n*Required*: Yes\n*Type*: [PrivateKeyAttributesV4](./aws-properties-pcaconnectorad-template-privatekeyattributesv4.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-privatekeyattributes", "UpdateType": "Mutable", "Required": true, "Type": "PrivateKeyAttributesV4" }, "GeneralFlags": { "MarkdownDocumentation": "`GeneralFlags`\n\nGeneral flags describe whether the template is used for computers or users and if the\ntemplate can be used with autoenrollment.\n*Required*: Yes\n*Type*: [GeneralFlagsV4](./aws-properties-pcaconnectorad-template-generalflagsv4.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-generalflags", "UpdateType": "Mutable", "Required": true, "Type": "GeneralFlagsV4" }, "CertificateValidity": { "MarkdownDocumentation": "`CertificateValidity`\n\nCertificate validity describes the validity and renewal periods of a certificate.\n*Required*: Yes\n*Type*: [CertificateValidity](./aws-properties-pcaconnectorad-template-certificatevalidity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-certificatevalidity", "UpdateType": "Mutable", "Required": true, "Type": "CertificateValidity" }, "Extensions": { "MarkdownDocumentation": "`Extensions`\n\nExtensions describe the key usage extensions and application policies for a\ntemplate.\n*Required*: Yes\n*Type*: [ExtensionsV4](./aws-properties-pcaconnectorad-template-extensionsv4.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-extensions", "UpdateType": "Mutable", "Required": true, "Type": "ExtensionsV4" }, "EnrollmentFlags": { "MarkdownDocumentation": "`EnrollmentFlags`\n\nEnrollment flags describe the enrollment settings for certificates using the existing\nprivate key and deleting expired or revoked certificates.\n*Required*: Yes\n*Type*: [EnrollmentFlagsV4](./aws-properties-pcaconnectorad-template-enrollmentflagsv4.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-enrollmentflags", "UpdateType": "Mutable", "Required": true, "Type": "EnrollmentFlagsV4" }, "HashAlgorithm": { "MarkdownDocumentation": "`HashAlgorithm`\n\nSpecifies the hash algorithm used to hash the private key. Hash algorithm can only be\nspecified when using Key Storage Providers.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHA256 | SHA384 | SHA512...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SHA256", "SHA384", "SHA512" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-templatev4.html#cfn-pcaconnectorad-template-templatev4-hashalgorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCAConnectorAD::Template.ValidityPeriod": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template.ValidityPeriod`\n\nInformation describing the end of the validity period of the certificate. This parameter\nsets the \u201cNot After\u201d date for the certificate. Certificate validity is the period of time\nduring which a certificate is valid. Validity can be expressed as an explicit date and time\nwhen the certificate expires, or as a span of time after issuance, stated in hours, days,\nmonths, or years. For more information, see Validity in RFC 5280. This value is unaffected\nwhen ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\nfuture, the certificate will expire 20 days from issuance time regardless of the\nValidityNotBefore value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-validityperiod.html", "Properties": { "PeriodType": { "MarkdownDocumentation": "`PeriodType`\n\nThe unit of time. You can select hours, days, weeks, months, and years.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HOURS | DAYS | WEEKS | MONT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-validityperiod.html#cfn-pcaconnectorad-template-validityperiod-periodtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe numeric value for the validity period.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `8766000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-template-validityperiod.html#cfn-pcaconnectorad-template-validityperiod-period", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::PCAConnectorAD::TemplateGroupAccessControlEntry.AccessRights": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::TemplateGroupAccessControlEntry.AccessRights`\n\nAllow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a\ntemplate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-templategroupaccesscontrolentry-accessrights.html", "Properties": { "Enroll": { "MarkdownDocumentation": "`Enroll`\n\nAllow or deny an Active Directory group from enrolling certificates issued against a\ntemplate.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOW | DENY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-templategroupaccesscontrolentry-accessrights.html#cfn-pcaconnectorad-templategroupaccesscontrolentry-accessrights-enroll", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoEnroll": { "MarkdownDocumentation": "`AutoEnroll`\n\nAllow or deny an Active Directory group from autoenrolling certificates issued against a template.\nThe Active Directory group must be allowed to enroll to allow autoenrollment\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOW | DENY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorad-templategroupaccesscontrolentry-accessrights.html#cfn-pcaconnectorad-templategroupaccesscontrolentry-accessrights-autoenroll", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCAConnectorSCEP::Connector.IntuneConfiguration": { "MarkdownDocumentation": "`AWS::PCAConnectorSCEP::Connector.IntuneConfiguration`\n\nContains configuration details for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see [Using Connector for SCEP for Microsoft Intune](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html).\nWhen you use Connector for SCEP for Microsoft Intune, certain functionalities are enabled by accessing Microsoft Intune through the Microsoft API. Your use of the Connector for SCEP and accompanying AWS services doesn't remove your need to have a valid license for your use of the Microsoft Intune service. You should also review the [Microsoft Intune\u00ae App Protection Policies](https://learn.microsoft.com/en-us/mem/intune/apps/app-protection-policy).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html", "Properties": { "AzureApplicationId": { "MarkdownDocumentation": "`AzureApplicationId`\n\nThe directory (tenant) ID from your Microsoft Entra ID app registration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}$`\n*Minimum*: `15`\n*Maximum*: `100`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html#cfn-pcaconnectorscep-connector-intuneconfiguration-azureapplicationid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe primary domain from your Microsoft Entra ID app registration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html#cfn-pcaconnectorscep-connector-intuneconfiguration-domain", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCAConnectorSCEP::Connector.MobileDeviceManagement": { "MarkdownDocumentation": "`AWS::PCAConnectorSCEP::Connector.MobileDeviceManagement`\n\nIf you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. For information about considerations and limitations with using Connector for SCEP, see [Considerations and Limitations](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlc4scep-considerations-limitations.html).\nIf you provide an `IntuneConfiguration`, Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see [Using Connector for SCEP for Microsoft Intune](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-mobiledevicemanagement.html", "Properties": { "Intune": { "MarkdownDocumentation": "`Intune`\n\nConfiguration settings for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see [Using Connector for SCEP for Microsoft Intune](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html).\n*Required*: Yes\n*Type*: [IntuneConfiguration](./aws-properties-pcaconnectorscep-connector-intuneconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-mobiledevicemanagement.html#cfn-pcaconnectorscep-connector-mobiledevicemanagement-intune", "UpdateType": "Immutable", "Required": true, "Type": "IntuneConfiguration" } } }, "AWS::PCAConnectorSCEP::Connector.OpenIdConfiguration": { "MarkdownDocumentation": "`AWS::PCAConnectorSCEP::Connector.OpenIdConfiguration`\n\nContains OpenID Connect (OIDC) parameters for use with Microsoft Intune. For more information about using Connector for SCEP for Microsoft Intune, see [Using Connector for SCEP for Microsoft Intune](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html", "Properties": { "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nThe issuer value to copy into your Microsoft Entra app registration's OIDC.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-issuer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Audience": { "MarkdownDocumentation": "`Audience`\n\nThe audience value to copy into your Microsoft Entra app registration's OIDC.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-audience", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Subject": { "MarkdownDocumentation": "`Subject`\n\nThe subject value to copy into your Microsoft Entra app registration's OIDC.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-subject", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::Cluster.Accounting": { "MarkdownDocumentation": "`AWS::PCS::Cluster.Accounting`\n\nThe accounting configuration includes configurable settings for Slurm accounting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-accounting.html", "Properties": { "DefaultPurgeTimeInDays": { "MarkdownDocumentation": "`DefaultPurgeTimeInDays`\n\nThe default value for all purge settings for `slurmdbd.conf`. For more\ninformation, see the [slurmdbd.conf documentation at SchedMD](https://slurm.schedmd.com/slurmdbd.conf.html).\nThe default value for `defaultPurgeTimeInDays` is `-1`.\nA value of `-1` means there is no purge time and records persist as long as\nthe cluster exists.\n###### Important\n`0` isn't a valid value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-accounting.html#cfn-pcs-cluster-accounting-defaultpurgetimeindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe default value for `mode` is `NONE`. A value of\n`STANDARD` means Slurm accounting is enabled.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STANDARD | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-accounting.html#cfn-pcs-cluster-accounting-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCS::Cluster.AuthKey": { "MarkdownDocumentation": "`AWS::PCS::Cluster.AuthKey`\n\nThe shared Slurm key for authentication, also known as the **cluster\nsecret**.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-authkey.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the shared Slurm 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-authkey.html#cfn-pcs-cluster-authkey-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretVersion": { "MarkdownDocumentation": "`SecretVersion`\n\nThe version of the shared Slurm 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-authkey.html#cfn-pcs-cluster-authkey-secretversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCS::Cluster.Endpoint": { "MarkdownDocumentation": "`AWS::PCS::Cluster.Endpoint`\n\nAn endpoint available for interaction with the scheduler.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html", "Properties": { "PublicIpAddress": { "MarkdownDocumentation": "`PublicIpAddress`\n\nThe endpoint's public IP address.\nExample: `192.0.2.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-publicipaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nIndicates the type of endpoint running at the specific IP address.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SLURMCTLD | SLURMDBD | SLUR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SLURMCTLD", "SLURMDBD", "SLURMRESTD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nFor clusters that use IPv4, this is the endpoint's private IP address.\nExample: `10.1.2.3`\nFor clusters configured to use IPv6, this is an empty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-privateipaddress", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe endpoint's connection port number.\nExample: `1234`\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Ipv6Address": { "MarkdownDocumentation": "`Ipv6Address`\n\nThe endpoint's IPv6 address.\nExample: `2001:db8::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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-ipv6address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::Cluster.ErrorInfo": { "MarkdownDocumentation": "`AWS::PCS::Cluster.ErrorInfo`\n\nAn error that occurred during resource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-errorinfo.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nThe detailed error information.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-errorinfo.html#cfn-pcs-cluster-errorinfo-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe short-form 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-errorinfo.html#cfn-pcs-cluster-errorinfo-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::Cluster.JwtAuth": { "MarkdownDocumentation": "`AWS::PCS::Cluster.JwtAuth`\n\nThe JWT authentication configuration for Slurm REST API access.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-jwtauth.html", "Properties": { "JwtKey": { "MarkdownDocumentation": "`JwtKey`\n\nThe JWT key for Slurm REST API authentication.\n*Required*: No\n*Type*: [JwtKey](./aws-properties-pcs-cluster-jwtkey.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-jwtauth.html#cfn-pcs-cluster-jwtauth-jwtkey", "UpdateType": "Mutable", "Required": false, "Type": "JwtKey" } } }, "AWS::PCS::Cluster.JwtKey": { "MarkdownDocumentation": "`AWS::PCS::Cluster.JwtKey`\n\nThe JWT key stored in AWS Secrets Manager for Slurm REST API authentication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-jwtkey.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the JWT 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-jwtkey.html#cfn-pcs-cluster-jwtkey-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretVersion": { "MarkdownDocumentation": "`SecretVersion`\n\nThe version of the AWS Secrets Manager secret containing the JWT 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-jwtkey.html#cfn-pcs-cluster-jwtkey-secretversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCS::Cluster.Networking": { "MarkdownDocumentation": "`AWS::PCS::Cluster.Networking`\n\nThe networking configuration for the cluster's control plane.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-networking.html", "Properties": { "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nThe IP address version the cluster uses. The default is `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)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-networking.html#cfn-pcs-cluster-networking-networktype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe list of security group IDs associated with the Elastic Network Interface (ENI)\ncreated in subnets.\nThe following rules are required:\n* Inbound rule 1\n \n + Protocol: All\n + Ports: All\n + Source: Self\n* Outbound rule 1\n \n + Protocol: All\n + Ports: All\n + Destination: 0.0.0.0/0 (IPv4) or ::/0 (IPv6)\n* Outbound rule 2\n \n + Protocol: All\n + Ports: All\n + Destination: Self\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-networking.html#cfn-pcs-cluster-networking-securitygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe ID of the subnet where AWS PCS creates an Elastic Network Interface (ENI)\nto enable communication between managed controllers and AWS PCS resources. The\nsubnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or\nan AWS Local Zone.\nExample: `subnet-abcd1234`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-networking.html#cfn-pcs-cluster-networking-subnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::PCS::Cluster.Scheduler": { "MarkdownDocumentation": "`AWS::PCS::Cluster.Scheduler`\n\nThe cluster management and job scheduling software associated with the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-scheduler.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe software AWS PCS uses to manage cluster scaling and job\nscheduling.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SLURM`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "SLURM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-scheduler.html#cfn-pcs-cluster-scheduler-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of the specified scheduling software that AWS PCS uses to manage\ncluster scaling and job scheduling. For more information, see [Slurm versions in AWS PCS](https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions.html) in the *AWS PCS User Guide*.\nValid Values: `23.11 | 24.05 | 24.11`\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-scheduler.html#cfn-pcs-cluster-scheduler-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCS::Cluster.SlurmConfiguration": { "MarkdownDocumentation": "`AWS::PCS::Cluster.SlurmConfiguration`\n\nAdditional options related to the Slurm scheduler.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html", "Properties": { "JwtAuth": { "MarkdownDocumentation": "`JwtAuth`\n\nThe JWT authentication configuration for Slurm REST API access.\n*Required*: No\n*Type*: [JwtAuth](./aws-properties-pcs-cluster-jwtauth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-jwtauth", "UpdateType": "Mutable", "Required": false, "Type": "JwtAuth" }, "Accounting": { "MarkdownDocumentation": "`Accounting`\n\nThe accounting configuration includes configurable settings for Slurm accounting.\n*Required*: No\n*Type*: [Accounting](./aws-properties-pcs-cluster-accounting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-accounting", "UpdateType": "Mutable", "Required": false, "Type": "Accounting" }, "AuthKey": { "MarkdownDocumentation": "`AuthKey`\n\nThe shared Slurm key for authentication, also known as the **cluster\nsecret**.\n*Required*: No\n*Type*: [AuthKey](./aws-properties-pcs-cluster-authkey.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-authkey", "UpdateType": "Mutable", "Required": false, "Type": "AuthKey" }, "ScaleDownIdleTimeInSeconds": { "MarkdownDocumentation": "`ScaleDownIdleTimeInSeconds`\n\nThe time (in seconds) before an idle node is scaled down.\nDefault: `600`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-scaledownidletimeinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SlurmCustomSettings": { "MarkdownDocumentation": "`SlurmCustomSettings`\n\nAdditional Slurm-specific configuration that directly maps to Slurm settings.\n*Required*: No\n*Type*: Array of [SlurmCustomSetting](./aws-properties-pcs-cluster-slurmcustomsetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-slurmcustomsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SlurmCustomSetting", "DuplicatesAllowed": true }, "SlurmRest": { "MarkdownDocumentation": "`SlurmRest`\n\nThe Slurm REST API configuration for the cluster.\n*Required*: No\n*Type*: [SlurmRest](./aws-properties-pcs-cluster-slurmrest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-slurmrest", "UpdateType": "Mutable", "Required": false, "Type": "SlurmRest" } } }, "AWS::PCS::Cluster.SlurmCustomSetting": { "MarkdownDocumentation": "`AWS::PCS::Cluster.SlurmCustomSetting`\n\nAdditional settings that directly map to Slurm settings.\n###### Important\nAWS PCS supports a subset of Slurm settings. For more information, see [Configuring custom Slurm settings in AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/slurm-custom-settings.html) in the *AWS PCS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmcustomsetting.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nThe values for the configured Slurm settings.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmcustomsetting.html#cfn-pcs-cluster-slurmcustomsetting-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nAWS PCS supports custom Slurm settings for clusters,\ncompute node groups, and queues. For more information,\nsee [Configuring\ncustom Slurm settings in AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/slurm-custom-settings.html)\nin the *AWS PCS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmcustomsetting.html#cfn-pcs-cluster-slurmcustomsetting-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCS::Cluster.SlurmRest": { "MarkdownDocumentation": "`AWS::PCS::Cluster.SlurmRest`\n\nThe Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API. It's a property of the [ClusterSlurmConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html) object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmrest.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe default value for `mode` is `NONE`. A value of `STANDARD` means the Slurm REST API is enabled.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STANDARD | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmrest.html#cfn-pcs-cluster-slurmrest-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCS::ComputeNodeGroup.CustomLaunchTemplate": { "MarkdownDocumentation": "`AWS::PCS::ComputeNodeGroup.CustomLaunchTemplate`\n\nAn Amazon EC2 launch template AWS PCS uses to launch compute\nnodes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-customlaunchtemplate.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of the EC2 launch template to use to provision instances.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-customlaunchtemplate.html#cfn-pcs-computenodegroup-customlaunchtemplate-version", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TemplateId": { "MarkdownDocumentation": "`TemplateId`\n\nThe ID of the EC2 launch template to use to provision 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-customlaunchtemplate.html#cfn-pcs-computenodegroup-customlaunchtemplate-templateid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::ComputeNodeGroup.ErrorInfo": { "MarkdownDocumentation": "`AWS::PCS::ComputeNodeGroup.ErrorInfo`\n\nAn error that occurred during resource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-errorinfo.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nThe detailed error information.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-errorinfo.html#cfn-pcs-computenodegroup-errorinfo-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe short-form 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-errorinfo.html#cfn-pcs-computenodegroup-errorinfo-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::ComputeNodeGroup.InstanceConfig": { "MarkdownDocumentation": "`AWS::PCS::ComputeNodeGroup.InstanceConfig`\n\nAn EC2 instance configuration AWS PCS uses to launch compute nodes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-instanceconfig.html", "Properties": { "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe EC2 instance type that AWS PCS can provision in the compute node\ngroup.\nExample: `t2.xlarge`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-instanceconfig.html#cfn-pcs-computenodegroup-instanceconfig-instancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::ComputeNodeGroup.ScalingConfiguration": { "MarkdownDocumentation": "`AWS::PCS::ComputeNodeGroup.ScalingConfiguration`\n\nSpecifies the boundaries of the compute node group auto scaling.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-scalingconfiguration.html", "Properties": { "MaxInstanceCount": { "MarkdownDocumentation": "`MaxInstanceCount`\n\nThe upper bound of the number of instances allowed in the compute fleet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-scalingconfiguration.html#cfn-pcs-computenodegroup-scalingconfiguration-maxinstancecount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "MinInstanceCount": { "MarkdownDocumentation": "`MinInstanceCount`\n\nThe lower bound of the number of instances allowed in the compute fleet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-scalingconfiguration.html#cfn-pcs-computenodegroup-scalingconfiguration-mininstancecount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::PCS::ComputeNodeGroup.SlurmConfiguration": { "MarkdownDocumentation": "`AWS::PCS::ComputeNodeGroup.SlurmConfiguration`\n\nAdditional options related to the Slurm scheduler.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-slurmconfiguration.html", "Properties": { "SlurmCustomSettings": { "MarkdownDocumentation": "`SlurmCustomSettings`\n\nAdditional Slurm-specific configuration that directly maps to Slurm settings.\n*Required*: No\n*Type*: Array of [SlurmCustomSetting](./aws-properties-pcs-computenodegroup-slurmcustomsetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-slurmconfiguration.html#cfn-pcs-computenodegroup-slurmconfiguration-slurmcustomsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SlurmCustomSetting", "DuplicatesAllowed": true } } }, "AWS::PCS::ComputeNodeGroup.SlurmCustomSetting": { "MarkdownDocumentation": "`AWS::PCS::ComputeNodeGroup.SlurmCustomSetting`\n\nAdditional settings that directly map to Slurm settings.\n###### Important\nAWS PCS supports a subset of Slurm settings. For more information, see [Configuring custom Slurm settings in AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/slurm-custom-settings.html) in the *AWS PCS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-slurmcustomsetting.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nThe values for the configured Slurm settings.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-slurmcustomsetting.html#cfn-pcs-computenodegroup-slurmcustomsetting-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nAWS PCS supports custom Slurm settings for clusters,\ncompute node groups, and queues. For more information,\nsee [Configuring\ncustom Slurm settings in AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/slurm-custom-settings.html)\nin the *AWS PCS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-slurmcustomsetting.html#cfn-pcs-computenodegroup-slurmcustomsetting-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PCS::ComputeNodeGroup.SpotOptions": { "MarkdownDocumentation": "`AWS::PCS::ComputeNodeGroup.SpotOptions`\n\nAdditional configuration when you specify `SPOT` as the\n`purchaseOption` for the `CreateComputeNodeGroup` API\naction.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-spotoptions.html", "Properties": { "AllocationStrategy": { "MarkdownDocumentation": "`AllocationStrategy`\n\nThe Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports **lowest price**, **capacity optimized**, and **price capacity\noptimized**. For more information, see [Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and\nOn-Demand capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) in the *Amazon Elastic Compute Cloud User\nGuide*. If you don't provide this option, it defaults to **price capacity optimized**.\n*Required*: No\n*Type*: String\n*Allowed values*: `lowest-price | capacity-opt...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "lowest-price", "capacity-optimized", "price-capacity-optimized" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-spotoptions.html#cfn-pcs-computenodegroup-spotoptions-allocationstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::Queue.ComputeNodeGroupConfiguration": { "MarkdownDocumentation": "`AWS::PCS::Queue.ComputeNodeGroupConfiguration`\n\nThe compute node group configuration for a queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-computenodegroupconfiguration.html", "Properties": { "ComputeNodeGroupId": { "MarkdownDocumentation": "`ComputeNodeGroupId`\n\nThe compute node group ID for the compute node group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-computenodegroupconfiguration.html#cfn-pcs-queue-computenodegroupconfiguration-computenodegroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::Queue.ErrorInfo": { "MarkdownDocumentation": "`AWS::PCS::Queue.ErrorInfo`\n\nAn error that occurred during resource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-errorinfo.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nThe detailed error information.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-errorinfo.html#cfn-pcs-queue-errorinfo-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe short-form 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-errorinfo.html#cfn-pcs-queue-errorinfo-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCS::Queue.SlurmConfiguration": { "MarkdownDocumentation": "`AWS::PCS::Queue.SlurmConfiguration`\n\nThe `SlurmConfiguration` property type specifies Property description not available. for an [AWS::PCS::Queue](./aws-resource-pcs-queue.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-slurmconfiguration.html", "Properties": { "SlurmCustomSettings": { "MarkdownDocumentation": "`SlurmCustomSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [SlurmCustomSetting](./aws-properties-pcs-queue-slurmcustomsetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-slurmconfiguration.html#cfn-pcs-queue-slurmconfiguration-slurmcustomsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SlurmCustomSetting", "DuplicatesAllowed": true } } }, "AWS::PCS::Queue.SlurmCustomSetting": { "MarkdownDocumentation": "`AWS::PCS::Queue.SlurmCustomSetting`\n\nThe `SlurmCustomSetting` property type specifies Property description not available. for an [AWS::PCS::Queue](./aws-resource-pcs-queue.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-slurmcustomsetting.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-slurmcustomsetting.html#cfn-pcs-queue-slurmcustomsetting-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-slurmcustomsetting.html#cfn-pcs-queue-slurmcustomsetting-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PaymentCryptography::Key.KeyAttributes": { "MarkdownDocumentation": "`AWS::PaymentCryptography::Key.KeyAttributes`\n\nThe role of the key, the algorithm it supports, and the cryptographic operations allowed\nwith the key. This data is immutable after the key is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html", "Properties": { "KeyClass": { "MarkdownDocumentation": "`KeyClass`\n\nThe type of AWS Payment Cryptography key to create, which determines the classi\ufb01cation of the\ncryptographic method and whether AWS Payment Cryptography key contains a symmetric key or an asymmetric\nkey pair.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SYMMETRIC_KEY | ASYMMETRIC_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html#cfn-paymentcryptography-key-keyattributes-keyclass", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyUsage": { "MarkdownDocumentation": "`KeyUsage`\n\nThe cryptographic usage of an AWS Payment Cryptography key as de\ufb01ned in section A.5.2 of the TR-31\nspec.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TR31_B0_BASE_DERIVATION_KEY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION", "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS", "TR31_E1_EMV_MKEY_CONFIDENTIALITY", "TR31_E2_EMV_MKEY_INTEGRITY", "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS", "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION", "TR31_E6_EMV_MKEY_OTHER", "TR31_K0_KEY_ENCRYPTION_KEY", "TR31_K1_KEY_BLOCK_PROTECTION_KEY", "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT", "TR31_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY", "TR31_K2_TR34_ASYMMETRIC_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html#cfn-paymentcryptography-key-keyattributes-keyusage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyModesOfUse": { "MarkdownDocumentation": "`KeyModesOfUse`\n\nThe list of cryptographic operations that you can perform using the key.\n*Required*: Yes\n*Type*: [KeyModesOfUse](./aws-properties-paymentcryptography-key-keymodesofuse.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html#cfn-paymentcryptography-key-keyattributes-keymodesofuse", "UpdateType": "Mutable", "Required": true, "Type": "KeyModesOfUse" }, "KeyAlgorithm": { "MarkdownDocumentation": "`KeyAlgorithm`\n\nThe key algorithm to be use during creation of an AWS Payment Cryptography key.\nFor symmetric keys, AWS Payment Cryptography supports `AES` and `TDES`\nalgorithms. For asymmetric keys, AWS Payment Cryptography supports `RSA` and\n`ECC_NIST` algorithms.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TDES_2KEY | TDES_3KEY | AES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keyattributes.html#cfn-paymentcryptography-key-keyattributes-keyalgorithm", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::PaymentCryptography::Key.KeyModesOfUse": { "MarkdownDocumentation": "`AWS::PaymentCryptography::Key.KeyModesOfUse`\n\nThe list of cryptographic operations that you can perform using the key. The modes of\nuse are de\ufb01ned in section A.5.3 of the TR-31 spec.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html", "Properties": { "Unwrap": { "MarkdownDocumentation": "`Unwrap`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-unwrap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Wrap": { "MarkdownDocumentation": "`Wrap`\n\nSpeci\ufb01es whether an AWS Payment Cryptography key can be used to wrap other keys.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-wrap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Decrypt": { "MarkdownDocumentation": "`Decrypt`\n\nSpeci\ufb01es whether an AWS Payment Cryptography key can be used to decrypt 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-decrypt", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NoRestrictions": { "MarkdownDocumentation": "`NoRestrictions`\n\nSpeci\ufb01es whether an AWS Payment Cryptography key has no special restrictions other than the\nrestrictions implied by `KeyUsage`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-norestrictions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Generate": { "MarkdownDocumentation": "`Generate`\n\nSpeci\ufb01es whether an AWS Payment Cryptography key can be used to generate and verify other card and PIN\nverification keys.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-generate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Sign": { "MarkdownDocumentation": "`Sign`\n\nSpeci\ufb01es whether an AWS Payment Cryptography key can be used for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-sign", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Verify": { "MarkdownDocumentation": "`Verify`\n\nSpeci\ufb01es whether an AWS Payment Cryptography key can be used to verify signatures.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-verify", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DeriveKey": { "MarkdownDocumentation": "`DeriveKey`\n\nSpeci\ufb01es whether an AWS Payment Cryptography key can be used to derive new keys.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-derivekey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Encrypt": { "MarkdownDocumentation": "`Encrypt`\n\nSpeci\ufb01es whether an AWS Payment Cryptography key can be used to encrypt 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-keymodesofuse.html#cfn-paymentcryptography-key-keymodesofuse-encrypt", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::PaymentCryptography::Key.ReplicationStatusType": { "MarkdownDocumentation": "`AWS::PaymentCryptography::Key.ReplicationStatusType`\n\nRepresents the replication status information for a key in a replication region for\n[Multi-Region key replication](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html).\nThis structure contains details about the current state of key replication, including\nany status messages and operational information about the replication process.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-replicationstatustype.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe current status of key replication in this AWS Region.\nThis field indicates whether the key replication is in progress, completed successfully,\nor has encountered an error. Possible values include states such as\n`SYNCRHONIZED`, `IN_PROGRESS`, `DELETE_IN_PROGRESS`, or\n`FAILED`. This provides visibility into the replication process for\nmonitoring and troubleshooting purposes.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IN_PROGRESS | DELETE_IN_PRO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-replicationstatustype.html#cfn-paymentcryptography-key-replicationstatustype-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StatusMessage": { "MarkdownDocumentation": "`StatusMessage`\n\nA message that provides additional information about the current replication status of\nthe key.\nThis field contains details about any issues or progress updates related to key\nreplication operations. It may include information about replication failures,\nsynchronization status, or other operational 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-paymentcryptography-key-replicationstatustype.html#cfn-paymentcryptography-key-replicationstatustype-statusmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Personalize::Dataset.DataSource": { "MarkdownDocumentation": "`AWS::Personalize::Dataset.DataSource`\n\nDescribes the data source that contains the data to upload to a dataset, or the list of\nrecords to delete from Amazon Personalize.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html", "Properties": { "DataLocation": { "MarkdownDocumentation": "`DataLocation`\n\nFor dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to\nyour dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete.\nFor example:\n`s3://bucket-name/folder-name/fileName.csv`\nIf your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job\nto consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a `/` after the folder\nname:\n`s3://bucket-name/folder-name/`\n*Required*: No\n*Type*: String\n*Pattern*: `(s3|http|https)://.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html#cfn-personalize-dataset-datasource-datalocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Personalize::Dataset.DatasetImportJob": { "MarkdownDocumentation": "`AWS::Personalize::Dataset.DatasetImportJob`\n\nDescribes a job that imports training data from a data source (Amazon S3\nbucket) to an Amazon Personalize dataset.\nA dataset import job can be in one of the following states:\n* CREATE PENDING > CREATE IN\\_PROGRESS > ACTIVE -or- CREATE\n FAILED\nIf you specify a dataset import job as part of a dataset, all\ndataset import job fields are required.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html", "Properties": { "DatasetArn": { "MarkdownDocumentation": "`DatasetArn`\n\nThe Amazon Resource Name (ARN) of the dataset that receives the\nimported data.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-datasetarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JobName": { "MarkdownDocumentation": "`JobName`\n\nThe name of the import job.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\\-_]*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-jobname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatasetImportJobArn": { "MarkdownDocumentation": "`DatasetImportJobArn`\n\nThe ARN of the dataset import job.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-datasetimportjobarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that has permissions to read from the Amazon S3\ndata source.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nThe Amazon S3 bucket that contains the training data to import.\n*Required*: No\n*Type*: [DataSource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasetimportjob.html#cfn-personalize-dataset-datasetimportjob-datasource", "UpdateType": "Mutable", "Required": false, "Type": "DataSource" } } }, "AWS::Personalize::Solution.AlgorithmHyperParameterRanges": { "MarkdownDocumentation": "`AWS::Personalize::Solution.AlgorithmHyperParameterRanges`\n\nSpecifies the hyperparameters and their ranges.\nHyperparameters can be categorical, continuous, or integer-valued.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html", "Properties": { "IntegerHyperParameterRanges": { "MarkdownDocumentation": "`IntegerHyperParameterRanges`\n\nProvides the name and range of an integer-valued hyperparameter.\n*Required*: No\n*Type*: Array of [IntegerHyperParameterRange](./aws-properties-personalize-solution-integerhyperparameterrange.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html#cfn-personalize-solution-algorithmhyperparameterranges-integerhyperparameterranges", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "IntegerHyperParameterRange", "DuplicatesAllowed": true }, "CategoricalHyperParameterRanges": { "MarkdownDocumentation": "`CategoricalHyperParameterRanges`\n\nProvides the name and range of a categorical hyperparameter.\n*Required*: No\n*Type*: Array of [CategoricalHyperParameterRange](./aws-properties-personalize-solution-categoricalhyperparameterrange.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html#cfn-personalize-solution-algorithmhyperparameterranges-categoricalhyperparameterranges", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "CategoricalHyperParameterRange", "DuplicatesAllowed": true }, "ContinuousHyperParameterRanges": { "MarkdownDocumentation": "`ContinuousHyperParameterRanges`\n\nProvides the name and range of a continuous hyperparameter.\n*Required*: No\n*Type*: Array of [ContinuousHyperParameterRange](./aws-properties-personalize-solution-continuoushyperparameterrange.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html#cfn-personalize-solution-algorithmhyperparameterranges-continuoushyperparameterranges", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ContinuousHyperParameterRange", "DuplicatesAllowed": true } } }, "AWS::Personalize::Solution.AutoMLConfig": { "MarkdownDocumentation": "`AWS::Personalize::Solution.AutoMLConfig`\n\nWhen the solution performs AutoML (`performAutoML` is true in\n[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)), Amazon Personalize\ndetermines which recipe, from the specified list, optimizes the given metric.\nAmazon Personalize then uses that recipe for the solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html#cfn-personalize-solution-automlconfig-metricname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RecipeList": { "MarkdownDocumentation": "`RecipeList`\n\nThe list of candidate recipes.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `256 | 100`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html#cfn-personalize-solution-automlconfig-recipelist", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Personalize::Solution.CategoricalHyperParameterRange": { "MarkdownDocumentation": "`AWS::Personalize::Solution.CategoricalHyperParameterRange`\n\nProvides the name and range of a categorical hyperparameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nA list of the categories for the hyperparameter.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `1000 | 100`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html#cfn-personalize-solution-categoricalhyperparameterrange-values", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html#cfn-personalize-solution-categoricalhyperparameterrange-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Personalize::Solution.ContinuousHyperParameterRange": { "MarkdownDocumentation": "`AWS::Personalize::Solution.ContinuousHyperParameterRange`\n\nProvides the name and range of a continuous hyperparameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html", "Properties": { "MinValue": { "MarkdownDocumentation": "`MinValue`\n\nThe minimum allowable value for the hyperparameter.\n*Required*: No\n*Type*: Number\n*Minimum*: `-1000000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-minvalue", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "MaxValue": { "MarkdownDocumentation": "`MaxValue`\n\nThe maximum allowable value for the hyperparameter.\n*Required*: No\n*Type*: Number\n*Minimum*: `-1000000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-maxvalue", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Personalize::Solution.HpoConfig": { "MarkdownDocumentation": "`AWS::Personalize::Solution.HpoConfig`\n\nDescribes the properties for hyperparameter optimization (HPO).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html", "Properties": { "HpoResourceConfig": { "MarkdownDocumentation": "`HpoResourceConfig`\n\nDescribes the resource configuration for HPO.\n*Required*: No\n*Type*: [HpoResourceConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-hporesourceconfig", "UpdateType": "Immutable", "Required": false, "Type": "HpoResourceConfig" }, "AlgorithmHyperParameterRanges": { "MarkdownDocumentation": "`AlgorithmHyperParameterRanges`\n\nThe hyperparameters and their allowable ranges.\n*Required*: No\n*Type*: [AlgorithmHyperParameterRanges](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-algorithmhyperparameterranges", "UpdateType": "Immutable", "Required": false, "Type": "AlgorithmHyperParameterRanges" }, "HpoObjective": { "MarkdownDocumentation": "`HpoObjective`\n\nThe metric to optimize during HPO.\n###### Note\nAmazon Personalize doesn't support configuring the `hpoObjective`\nat this time.\n*Required*: No\n*Type*: [HpoObjective](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-hpoobjective", "UpdateType": "Immutable", "Required": false, "Type": "HpoObjective" } } }, "AWS::Personalize::Solution.HpoObjective": { "MarkdownDocumentation": "`AWS::Personalize::Solution.HpoObjective`\n\nThe metric to optimize during hyperparameter optimization (HPO).\n###### Note\nAmazon Personalize doesn't support configuring the `hpoObjective`\nat this time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-metricname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the metric. Valid values are `Maximize` and `Minimize`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Maximize | Minimize...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Maximize", "Minimize" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MetricRegex": { "MarkdownDocumentation": "`MetricRegex`\n\nA regular expression for finding the metric in the training job logs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-metricregex", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Personalize::Solution.HpoResourceConfig": { "MarkdownDocumentation": "`AWS::Personalize::Solution.HpoResourceConfig`\n\nDescribes the resource configuration for hyperparameter optimization (HPO).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html", "Properties": { "MaxParallelTrainingJobs": { "MarkdownDocumentation": "`MaxParallelTrainingJobs`\n\nThe maximum number of parallel training\njobs when you create a\nsolution\nversion.\nThe maximum value for `maxParallelTrainingJobs` is\n`10`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html#cfn-personalize-solution-hporesourceconfig-maxparalleltrainingjobs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaxNumberOfTrainingJobs": { "MarkdownDocumentation": "`MaxNumberOfTrainingJobs`\n\nThe maximum number of training\njobs when you create a\nsolution\nversion.\nThe maximum value for `maxNumberOfTrainingJobs` is\n`40`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html#cfn-personalize-solution-hporesourceconfig-maxnumberoftrainingjobs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Personalize::Solution.IntegerHyperParameterRange": { "MarkdownDocumentation": "`AWS::Personalize::Solution.IntegerHyperParameterRange`\n\nProvides the name and range of an integer-valued hyperparameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html", "Properties": { "MinValue": { "MarkdownDocumentation": "`MinValue`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-minvalue", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MaxValue": { "MarkdownDocumentation": "`MaxValue`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-maxvalue", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Personalize::Solution.SolutionConfig": { "MarkdownDocumentation": "`AWS::Personalize::Solution.SolutionConfig`\n\nDescribes the configuration properties for the solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html", "Properties": { "EventValueThreshold": { "MarkdownDocumentation": "`EventValueThreshold`\n\nOnly events with a value greater than or equal to this threshold are\nused 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-eventvaluethreshold", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HpoConfig": { "MarkdownDocumentation": "`HpoConfig`\n\nDescribes the properties for hyperparameter optimization (HPO).\n*Required*: No\n*Type*: [HpoConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-hpoconfig", "UpdateType": "Immutable", "Required": false, "Type": "HpoConfig" }, "AlgorithmHyperParameters": { "MarkdownDocumentation": "`AlgorithmHyperParameters`\n\nLists the algorithm hyperparameters and their values.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-algorithmhyperparameters", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "FeatureTransformationParameters": { "MarkdownDocumentation": "`FeatureTransformationParameters`\n\nLists the feature transformation parameters.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-featuretransformationparameters", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "AutoMLConfig": { "MarkdownDocumentation": "`AutoMLConfig`\n\nThe [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search\nwhen AutoML is performed.\n*Required*: No\n*Type*: [AutoMLConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html#cfn-personalize-solution-solutionconfig-automlconfig", "UpdateType": "Immutable", "Required": false, "Type": "AutoMLConfig" } } }, "AWS::Pinpoint::InAppTemplate.BodyConfig": { "MarkdownDocumentation": "`AWS::Pinpoint::InAppTemplate.BodyConfig`\n\nSpecifies the configuration of the main body text of the in-app message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html", "Properties": { "Alignment": { "MarkdownDocumentation": "`Alignment`\n\nThe text alignment of the main body text of the message. Acceptable values:\n`LEFT`, `CENTER`, `RIGHT`.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-alignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe color of the body text, expressed as a hex color code (such as #000000 for\nblack).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-textcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Body": { "MarkdownDocumentation": "`Body`\n\nThe main body text of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-body", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pinpoint::InAppTemplate.ButtonConfig": { "MarkdownDocumentation": "`AWS::Pinpoint::InAppTemplate.ButtonConfig`\n\nSpecifies the behavior of buttons that appear in an in-app message template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html", "Properties": { "Web": { "MarkdownDocumentation": "`Web`\n\nOptional button configuration to use for in-app messages sent to web applications.\nThis button configuration overrides the default button configuration.\n*Required*: No\n*Type*: [OverrideButtonConfiguration](./aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-web", "UpdateType": "Mutable", "Required": false, "Type": "OverrideButtonConfiguration" }, "DefaultConfig": { "MarkdownDocumentation": "`DefaultConfig`\n\nSpecifies the default behavior of a button that appears in an in-app message. You can\noptionally add button configurations that specifically apply to iOS, Android, or web\nbrowser users.\n*Required*: No\n*Type*: [DefaultButtonConfiguration](./aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-defaultconfig", "UpdateType": "Mutable", "Required": false, "Type": "DefaultButtonConfiguration" }, "IOS": { "MarkdownDocumentation": "`IOS`\n\nOptional button configuration to use for in-app messages sent to iOS devices. This\nbutton configuration overrides the default button configuration.\n*Required*: No\n*Type*: [OverrideButtonConfiguration](./aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-ios", "UpdateType": "Mutable", "Required": false, "Type": "OverrideButtonConfiguration" }, "Android": { "MarkdownDocumentation": "`Android`\n\nOptional button configuration to use for in-app messages sent to Android devices. This\nbutton configuration overrides the default button configuration.\n*Required*: No\n*Type*: [OverrideButtonConfiguration](./aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-android", "UpdateType": "Mutable", "Required": false, "Type": "OverrideButtonConfiguration" } } }, "AWS::Pinpoint::InAppTemplate.DefaultButtonConfiguration": { "MarkdownDocumentation": "`AWS::Pinpoint::InAppTemplate.DefaultButtonConfiguration`\n\nSpecifies the default behavior of a button that appears in an in-app message. You can\noptionally add button configurations that specifically apply to iOS, Android, or web\nbrowser users.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html", "Properties": { "BorderRadius": { "MarkdownDocumentation": "`BorderRadius`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-borderradius", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ButtonAction": { "MarkdownDocumentation": "`ButtonAction`\n\nThe action that occurs when a recipient chooses a button in an in-app message.\nYou 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\n application.\n* `CLOSE` \u2013 Dismisses the message.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINK | DEEP_LINK | CLOSE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINK", "DEEP_LINK", "CLOSE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-buttonaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Text": { "MarkdownDocumentation": "`Text`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-text", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe color of the body text in a button, expressed as a hex color code (such as #000000\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-textcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Link": { "MarkdownDocumentation": "`Link`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-link", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color of a button, expressed as a hex color code (such as #000000 for\nblack).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pinpoint::InAppTemplate.HeaderConfig": { "MarkdownDocumentation": "`AWS::Pinpoint::InAppTemplate.HeaderConfig`\n\nSpecifies the configuration and content of the header or title text of the in-app\nmessage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html", "Properties": { "Alignment": { "MarkdownDocumentation": "`Alignment`\n\nThe text alignment of the title of the message. Acceptable values: `LEFT`,\n`CENTER`, `RIGHT`.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-alignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Header": { "MarkdownDocumentation": "`Header`\n\nThe title text of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-header", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe color of the title text, expressed as a hex color code (such as #000000 for\nblack).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-textcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pinpoint::InAppTemplate.InAppMessageContent": { "MarkdownDocumentation": "`AWS::Pinpoint::InAppTemplate.InAppMessageContent`\n\nSpecifies the configuration of an in-app message, including its header, body, buttons,\ncolors, and images.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html", "Properties": { "BodyConfig": { "MarkdownDocumentation": "`BodyConfig`\n\nAn object that contains configuration information about the header or title\ntext of the in-app message.\n*Required*: No\n*Type*: [BodyConfig](./aws-properties-pinpoint-inapptemplate-bodyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-bodyconfig", "UpdateType": "Mutable", "Required": false, "Type": "BodyConfig" }, "SecondaryBtn": { "MarkdownDocumentation": "`SecondaryBtn`\n\nAn object that contains configuration information about the secondary button\nin an in-app message.\n*Required*: No\n*Type*: [ButtonConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-secondarybtn", "UpdateType": "Mutable", "Required": false, "Type": "ButtonConfig" }, "ImageUrl": { "MarkdownDocumentation": "`ImageUrl`\n\nThe URL of the image that appears on an in-app message banner.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-imageurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrimaryBtn": { "MarkdownDocumentation": "`PrimaryBtn`\n\nAn object that contains configuration information about the primary button in\nan in-app message.\n*Required*: No\n*Type*: [ButtonConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-primarybtn", "UpdateType": "Mutable", "Required": false, "Type": "ButtonConfig" }, "HeaderConfig": { "MarkdownDocumentation": "`HeaderConfig`\n\nAn object that contains configuration information about the header or title\ntext of the in-app message.\n*Required*: No\n*Type*: [HeaderConfig](./aws-properties-pinpoint-inapptemplate-headerconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-headerconfig", "UpdateType": "Mutable", "Required": false, "Type": "HeaderConfig" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color for an in-app message banner, expressed as a hex color code (such\nas #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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pinpoint::InAppTemplate.OverrideButtonConfiguration": { "MarkdownDocumentation": "`AWS::Pinpoint::InAppTemplate.OverrideButtonConfiguration`\n\nSpecifies the configuration of a button with settings that are specific to a certain\ndevice type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html", "Properties": { "ButtonAction": { "MarkdownDocumentation": "`ButtonAction`\n\nThe action that occurs when a recipient chooses a button in an in-app message.\nYou 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\n application.\n* `CLOSE` \u2013 Dismisses the message.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINK | DEEP_LINK | CLOSE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINK", "DEEP_LINK", "CLOSE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html#cfn-pinpoint-inapptemplate-overridebuttonconfiguration-buttonaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Link": { "MarkdownDocumentation": "`Link`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html#cfn-pinpoint-inapptemplate-overridebuttonconfiguration-link", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.AwsVpcConfiguration": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.AwsVpcConfiguration`\n\nThis structure specifies the VPC subnets and security groups for the task, and whether a\npublic IP address is to be used. This structure is relevant only for ECS tasks that use the\n`awsvpc` network mode.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nSpecifies the security groups associated with the task. These security groups must all\nbe in the same VPC. You can specify as many as five security groups. If you do not specify\na security group, the default security group for the VPC is used.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `1024 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html#cfn-pipes-pipe-awsvpcconfiguration-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nSpecifies the subnets associated with the task. These subnets must all be in the same\nVPC. You can specify as many as 16 subnets.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `1024 | 16`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html#cfn-pipes-pipe-awsvpcconfiguration-subnets", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AssignPublicIp": { "MarkdownDocumentation": "`AssignPublicIp`\n\nSpecifies whether the task's elastic network interface receives a public IP address. You\ncan specify `ENABLED` only when `LaunchType` in\n`EcsParameters` is set to `FARGATE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html#cfn-pipes-pipe-awsvpcconfiguration-assignpublicip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.BatchArrayProperties": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.BatchArrayProperties`\n\nThe array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000.\nIf 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batcharrayproperties.html", "Properties": { "Size": { "MarkdownDocumentation": "`Size`\n\nThe size of the array, if this is an array batch job.\n*Required*: No\n*Type*: Integer\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batcharrayproperties.html#cfn-pipes-pipe-batcharrayproperties-size", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.BatchContainerOverrides": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.BatchContainerOverrides`\n\nThe overrides that are sent to a container.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html", "Properties": { "Command": { "MarkdownDocumentation": "`Command`\n\nThe command to send to the container that overrides the default command from the Docker\nimage or the task definition.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html#cfn-pipes-pipe-batchcontaineroverrides-command", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nThe environment variables to send to the container. You can add new environment\nvariables, which are added to the container at launch, or you can override the existing\nenvironment variables from the Docker image or the task definition.\n###### Note\nEnvironment variables cannot start with \"`AWS Batch`\". This\nnaming convention is reserved for variables that AWS Batch sets.\n*Required*: No\n*Type*: Array of [BatchEnvironmentVariable](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html#cfn-pipes-pipe-batchcontaineroverrides-environment", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BatchEnvironmentVariable", "DuplicatesAllowed": true }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type to use for a multi-node parallel job.\n###### Note\nThis parameter isn't applicable to single-node container jobs or jobs that run on\nFargate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html#cfn-pipes-pipe-batchcontaineroverrides-instancetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceRequirements": { "MarkdownDocumentation": "`ResourceRequirements`\n\nThe type and amount of resources to assign to a container. This overrides the settings\nin the job definition. The supported resources include `GPU`,\n`MEMORY`, and `VCPU`.\n*Required*: No\n*Type*: Array of [BatchResourceRequirement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html#cfn-pipes-pipe-batchcontaineroverrides-resourcerequirements", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BatchResourceRequirement", "DuplicatesAllowed": true } } }, "AWS::Pipes::Pipe.BatchEnvironmentVariable": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.BatchEnvironmentVariable`\n\nThe environment variables to send to the container. You can add new environment\nvariables, which are added to the container at launch, or you can override the existing\nenvironment variables from the Docker image or the task definition.\n###### Note\nEnvironment variables cannot start with \"`AWS Batch`\". This\nnaming convention is reserved for variables that AWS Batch sets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the key-value pair. For environment variables, this is the value of the\nenvironment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html#cfn-pipes-pipe-batchenvironmentvariable-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the key-value pair. For environment variables, this is the name of the\nenvironment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html#cfn-pipes-pipe-batchenvironmentvariable-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.BatchJobDependency": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.BatchJobDependency`\n\nAn object that represents an AWS Batch job dependency.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchjobdependency.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the job dependency.\n*Required*: No\n*Type*: String\n*Allowed values*: `N_TO_N | SEQUENTIAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "N_TO_N", "SEQUENTIAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchjobdependency.html#cfn-pipes-pipe-batchjobdependency-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JobId": { "MarkdownDocumentation": "`JobId`\n\nThe job ID of the AWS Batch job that's associated with this\ndependency.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchjobdependency.html#cfn-pipes-pipe-batchjobdependency-jobid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.BatchResourceRequirement": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.BatchResourceRequirement`\n\nThe type and amount of a resource to assign to a container. The supported resources\ninclude `GPU`, `MEMORY`, and `VCPU`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchresourcerequirement.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of resource to assign to a container. The supported resources include\n`GPU`, `MEMORY`, and `VCPU`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GPU | MEMORY | VCPU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GPU", "MEMORY", "VCPU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchresourcerequirement.html#cfn-pipes-pipe-batchresourcerequirement-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe quantity of the specified resource to reserve for the container. The values vary based on the\n`type` specified.\ntype=\"GPU\"\nThe number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all\ncontainers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched\non.\n###### Note\nGPUs aren't available for jobs that are running on Fargate resources.\n\ntype=\"MEMORY\"\nThe memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\nrunning on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\nThis 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/)\nand the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/).\nYou must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\nmulti-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n`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\n`--memory` option to [docker run](https://docs.docker.com/engine/reference/run/).\n###### Note\nIf you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\na particular instance type, see [Memory\nmanagement](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\nmust match one of the supported values and the `VCPU` values must be one of the values supported for\nthat memory value.\nvalue = 512\n`VCPU` = 0.25\n\nvalue = 1024\n`VCPU` = 0.25 or 0.5\n\nvalue = 2048\n`VCPU` = 0.25, 0.5, or 1\n\nvalue = 3072\n`VCPU` = 0.5, or 1\n\nvalue = 4096\n`VCPU` = 0.5, 1, or 2\n\nvalue = 5120, 6144, or 7168\n`VCPU` = 1 or 2\n\nvalue = 8192\n`VCPU` = 1, 2, 4, or 8\n\nvalue = 9216, 10240, 11264, 12288, 13312, 14336, or 15360\n`VCPU` = 2 or 4\n\nvalue = 16384\n`VCPU` = 2, 4, or 8\n\nvalue = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720\n`VCPU` = 4\n\nvalue = 20480, 24576, or 28672\n`VCPU` = 4 or 8\n\nvalue = 36864, 45056, 53248, or 61440\n`VCPU` = 8\n\nvalue = 32768, 40960, 49152, or 57344\n`VCPU` = 8 or 16\n\nvalue = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n`VCPU` = 16\n\n\ntype=\"VCPU\"\nThe number of vCPUs reserved for the container. This parameter maps to `CpuShares` in the\n[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/)\nand the `--cpu-shares` option to\n[docker run](https://docs.docker.com/engine/reference/run/). Each vCPU is equivalent to 1,024 CPU shares. For EC2\nresources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\nspecified for each node at least once.\nThe default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about\nFargate 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\nvalues and the `MEMORY` values must be one of the values supported for that `VCPU` value.\nThe supported values are 0.25, 0.5, 1, 2, 4, 8, and 16\nvalue = 0.25\n`MEMORY` = 512, 1024, or 2048\n\nvalue = 0.5\n`MEMORY` = 1024, 2048, 3072, or 4096\n\nvalue = 1\n`MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192\n\nvalue = 2\n`MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384\n\nvalue = 4\n`MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720\n\nvalue = 8\n`MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n\nvalue = 16\n`MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n\n\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchresourcerequirement.html#cfn-pipes-pipe-batchresourcerequirement-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.BatchRetryStrategy": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.BatchRetryStrategy`\n\nThe retry strategy that's associated with a job. For more information, see [Automated job retries](https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) in the *AWS Batch User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchretrystrategy.html", "Properties": { "Attempts": { "MarkdownDocumentation": "`Attempts`\n\nThe number of times to move a job to the `RUNNABLE` status. If the value of\n`attempts` is greater than one, the job is retried on failure the same number\nof attempts as the value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchretrystrategy.html#cfn-pipes-pipe-batchretrystrategy-attempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.CapacityProviderStrategyItem": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.CapacityProviderStrategyItem`\n\nThe details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html", "Properties": { "CapacityProvider": { "MarkdownDocumentation": "`CapacityProvider`\n\nThe short name of the capacity provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html#cfn-pipes-pipe-capacityproviderstrategyitem-capacityprovider", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe weight value designates the relative percentage of the total number of tasks\nlaunched that should use the specified capacity provider. The weight value is taken into\nconsideration after the base value, if defined, is satisfied.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html#cfn-pipes-pipe-capacityproviderstrategyitem-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Base": { "MarkdownDocumentation": "`Base`\n\nThe base value designates how many tasks, at a minimum, to run on the specified capacity\nprovider. Only one capacity provider in a capacity provider strategy can have a base\ndefined. If no value is specified, the default value of 0 is used.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html#cfn-pipes-pipe-capacityproviderstrategyitem-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.CloudwatchLogsLogDestination": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.CloudwatchLogsLogDestination`\n\nRepresents the Amazon CloudWatch Logs logging configuration settings for the pipe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-cloudwatchlogslogdestination.html", "Properties": { "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:logs:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):log-group:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-cloudwatchlogslogdestination.html#cfn-pipes-pipe-cloudwatchlogslogdestination-loggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.DeadLetterConfig": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.DeadLetterConfig`\n\nA `DeadLetterConfig` object that contains information about a dead-letter\nqueue configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-deadletterconfig.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe ARN of the specified target for the dead-letter queue.\nFor Amazon Kinesis stream and Amazon DynamoDB stream sources, specify\neither an Amazon SNS topic or Amazon SQS queue ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-deadletterconfig.html#cfn-pipes-pipe-deadletterconfig-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.DimensionMapping": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.DimensionMapping`\n\nMaps source data to a dimension in the target Timestream for LiveAnalytics\ntable.\nFor more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-dimensionmapping.html", "Properties": { "DimensionValueType": { "MarkdownDocumentation": "`DimensionValueType`\n\nThe data type of the dimension for the time-series data.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VARCHAR`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "VARCHAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-dimensionmapping.html#cfn-pipes-pipe-dimensionmapping-dimensionvaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DimensionValue": { "MarkdownDocumentation": "`DimensionValue`\n\nDynamic path to the dimension value in the source event.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-dimensionmapping.html#cfn-pipes-pipe-dimensionmapping-dimensionvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DimensionName": { "MarkdownDocumentation": "`DimensionName`\n\nThe metadata attributes of the time series. For example, the name and Availability Zone\nof an Amazon EC2 instance or the name of the manufacturer of a wind turbine are\ndimensions.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-dimensionmapping.html#cfn-pipes-pipe-dimensionmapping-dimensionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.EcsContainerOverride": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.EcsContainerOverride`\n\nThe overrides that are sent to a container. An empty container override can be passed\nin. An example of an empty container override is `{\"containerOverrides\": [ ] }`.\nIf a non-empty container override is specified, the `name` parameter must be\nincluded.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html", "Properties": { "MemoryReservation": { "MarkdownDocumentation": "`MemoryReservation`\n\nThe soft limit (in MiB) of memory to reserve for the container, instead of the default\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-memoryreservation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Command": { "MarkdownDocumentation": "`Command`\n\nThe command to send to the container that overrides the default command from the Docker\nimage or the task definition. You must also specify a container name.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-command", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe hard limit (in MiB) of memory to present to the container, instead of the default\nvalue from the task definition. If your container attempts to exceed the memory specified\nhere, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-memory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe number of `cpu` units reserved for the container, instead of the default\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-cpu", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nThe environment variables to send to the container. You can add new environment\nvariables, which are added to the container at launch, or you can override the existing\nenvironment variables from the Docker image or the task definition. You must also specify a\ncontainer name.\n*Required*: No\n*Type*: Array of [EcsEnvironmentVariable](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-environment", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EcsEnvironmentVariable", "DuplicatesAllowed": true }, "ResourceRequirements": { "MarkdownDocumentation": "`ResourceRequirements`\n\nThe type and amount of a resource to assign to a container, instead of the default value\nfrom the task definition. The only supported resource is a GPU.\n*Required*: No\n*Type*: Array of [EcsResourceRequirement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-resourcerequirements", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EcsResourceRequirement", "DuplicatesAllowed": true }, "EnvironmentFiles": { "MarkdownDocumentation": "`EnvironmentFiles`\n\nA list of files containing the environment variables to pass to a container, instead of\nthe value from the container definition.\n*Required*: No\n*Type*: Array of [EcsEnvironmentFile](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-environmentfiles", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EcsEnvironmentFile", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the container that receives the override. This parameter is required if any\noverride 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.EcsEnvironmentFile": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.EcsEnvironmentFile`\n\nA list of files containing the environment variables to pass to a container. You can\nspecify up to ten environment files. The file must have a `.env` file extension.\nEach line in an environment file should contain an environment variable in\n`VARIABLE=VALUE` format. Lines beginning with `#` are treated as\ncomments and are ignored. For more information about the environment variable file syntax,\nsee [Declare default environment\nvariables in file](https://docs.docker.com/compose/env-file/).\nIf there are environment variables specified using the `environment`\nparameter in a container definition, they take precedence over the variables contained\nwithin an environment file. If multiple environment files are specified that contain the\nsame variable, they're processed from the top down. We recommend that you use unique\nvariable names. For more information, see [Specifying environment\nvariables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer\nGuide*.\nThis parameter is only supported for tasks hosted on Fargate using the\nfollowing platform versions:\n* Linux platform version `1.4.0` or later.\n* Windows platform version `1.0.0` or later.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe file type to use. The only supported value is `s3`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `s3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "s3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html#cfn-pipes-pipe-ecsenvironmentfile-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe Amazon Resource Name (ARN) of the Amazon S3 object containing the\nenvironment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html#cfn-pipes-pipe-ecsenvironmentfile-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.EcsEnvironmentVariable": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.EcsEnvironmentVariable`\n\nThe environment variables to send to the container. You can add new environment\nvariables, which are added to the container at launch, or you can override the existing\nenvironment variables from the Docker image or the task definition. You must also specify a\ncontainer name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentvariable.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the key-value pair. For environment variables, this is the value of the\nenvironment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentvariable.html#cfn-pipes-pipe-ecsenvironmentvariable-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the key-value pair. For environment variables, this is the name of the\nenvironment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentvariable.html#cfn-pipes-pipe-ecsenvironmentvariable-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.EcsEphemeralStorage": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.EcsEphemeralStorage`\n\nThe amount of ephemeral storage to allocate for the task. This parameter is used to\nexpand the total amount of ephemeral storage available, beyond the default amount, for\ntasks hosted on Fargate. For more information, see [Fargate task storage](https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) in the *Amazon ECS User Guide\nfor Fargate*.\n###### Note\nThis parameter is only supported for tasks hosted on Fargate using\nLinux platform version `1.4.0` or later. This parameter is not supported for\nWindows containers on Fargate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsephemeralstorage.html", "Properties": { "SizeInGiB": { "MarkdownDocumentation": "`SizeInGiB`\n\nThe total amount, in GiB, of ephemeral storage to set for the task. The minimum\nsupported value is `21` GiB and the maximum supported value is `200`\nGiB.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `21`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsephemeralstorage.html#cfn-pipes-pipe-ecsephemeralstorage-sizeingib", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.EcsInferenceAcceleratorOverride": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.EcsInferenceAcceleratorOverride`\n\nDetails on an Elastic Inference accelerator task override. This parameter is used to\noverride the Elastic Inference accelerator specified in the task definition. For more\ninformation, see [Working with Amazon Elastic\nInference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html) in the *Amazon Elastic Container Service\nDeveloper Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsinferenceacceleratoroverride.html", "Properties": { "DeviceType": { "MarkdownDocumentation": "`DeviceType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsinferenceacceleratoroverride.html#cfn-pipes-pipe-ecsinferenceacceleratoroverride-devicetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe Elastic Inference accelerator device name to override for the task. This parameter\nmust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsinferenceacceleratoroverride.html#cfn-pipes-pipe-ecsinferenceacceleratoroverride-devicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.EcsResourceRequirement": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.EcsResourceRequirement`\n\nThe type and amount of a resource to assign to a container. The supported resource types\nare GPUs and Elastic Inference accelerators. For more information, see [Working with\nGPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic\nInference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service\nDeveloper Guide*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsresourcerequirement.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of resource to assign to a container. The supported values are `GPU`\nor `InferenceAccelerator`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GPU | InferenceAccelerator...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GPU", "InferenceAccelerator" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsresourcerequirement.html#cfn-pipes-pipe-ecsresourcerequirement-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the specified resource type.\nIf the `GPU` type is used, the value is the number of physical\n`GPUs` the Amazon ECS container agent reserves for the container. The\nnumber of GPUs that's reserved for all containers in a task can't exceed the number of\navailable GPUs on the container instance that the task is launched on.\nIf the `InferenceAccelerator` type is used, the `value` matches\nthe `deviceName` for an InferenceAccelerator specified in a task\ndefinition.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsresourcerequirement.html#cfn-pipes-pipe-ecsresourcerequirement-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.EcsTaskOverride": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.EcsTaskOverride`\n\nThe overrides that are associated with a task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html", "Properties": { "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the task execution IAM role override for the task. For\nmore information, see [Amazon ECS\ntask execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html#cfn-pipes-pipe-ecstaskoverride-executionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TaskRoleArn": { "MarkdownDocumentation": "`TaskRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.\nAll containers in this task are granted the permissions that are specified in this role.\nFor more information, see [IAM Role for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in\nthe *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html#cfn-pipes-pipe-ecstaskoverride-taskrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html#cfn-pipes-pipe-ecstaskoverride-memory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html#cfn-pipes-pipe-ecstaskoverride-cpu", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InferenceAcceleratorOverrides": { "MarkdownDocumentation": "`InferenceAcceleratorOverrides`\n\nThe Elastic Inference accelerator override for the task.\n*Required*: No\n*Type*: Array of [EcsInferenceAcceleratorOverride](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html#cfn-pipes-pipe-ecstaskoverride-inferenceacceleratoroverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EcsInferenceAcceleratorOverride", "DuplicatesAllowed": true }, "EphemeralStorage": { "MarkdownDocumentation": "`EphemeralStorage`\n\nThe ephemeral storage setting override for the task.\n###### Note\nThis parameter is only supported for tasks hosted on Fargate that use\nthe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html#cfn-pipes-pipe-ecstaskoverride-ephemeralstorage", "UpdateType": "Mutable", "Required": false, "Type": "EcsEphemeralStorage" }, "ContainerOverrides": { "MarkdownDocumentation": "`ContainerOverrides`\n\nOne or more container overrides that are sent to a task.\n*Required*: No\n*Type*: Array of [EcsContainerOverride](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html#cfn-pipes-pipe-ecstaskoverride-containeroverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EcsContainerOverride", "DuplicatesAllowed": true } } }, "AWS::Pipes::Pipe.Filter": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.Filter`\n\nFilter events using an event pattern. For more information, see [Events and Event\nPatterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filter.html", "Properties": { "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nThe event pattern.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filter.html#cfn-pipes-pipe-filter-pattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.FilterCriteria": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.FilterCriteria`\n\nThe collection of event patterns used to filter events.\nTo remove a filter, specify a `FilterCriteria` object with an empty array of `Filter` objects.\nFor more information, see [Events and Event\nPatterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filtercriteria.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe event patterns.\n*Required*: No\n*Type*: Array of [Filter](./aws-properties-pipes-pipe-filter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filtercriteria.html#cfn-pipes-pipe-filtercriteria-filters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": true } } }, "AWS::Pipes::Pipe.FirehoseLogDestination": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.FirehoseLogDestination`\n\nRepresents the Amazon Data Firehose logging configuration settings for the pipe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-firehoselogdestination.html", "Properties": { "DeliveryStreamArn": { "MarkdownDocumentation": "`DeliveryStreamArn`\n\nThe Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:firehose:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):deliverystream/.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-firehoselogdestination.html#cfn-pipes-pipe-firehoselogdestination-deliverystreamarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.MQBrokerAccessCredentials": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.MQBrokerAccessCredentials`\n\nThe AWS Secrets Manager secret that stores your broker credentials.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mqbrokeraccesscredentials.html", "Properties": { "BasicAuth": { "MarkdownDocumentation": "`BasicAuth`\n\nThe ARN of the Secrets Manager secret.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mqbrokeraccesscredentials.html#cfn-pipes-pipe-mqbrokeraccesscredentials-basicauth", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.MSKAccessCredentials": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.MSKAccessCredentials`\n\nThe AWS Secrets Manager secret that stores your stream credentials.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mskaccesscredentials.html", "Properties": { "ClientCertificateTlsAuth": { "MarkdownDocumentation": "`ClientCertificateTlsAuth`\n\nThe ARN of the Secrets Manager secret.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mskaccesscredentials.html#cfn-pipes-pipe-mskaccesscredentials-clientcertificatetlsauth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SaslScram512Auth": { "MarkdownDocumentation": "`SaslScram512Auth`\n\nThe ARN of the Secrets Manager secret.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mskaccesscredentials.html#cfn-pipes-pipe-mskaccesscredentials-saslscram512auth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.MultiMeasureAttributeMapping": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.MultiMeasureAttributeMapping`\n\nA mapping of a source event data field to a measure in a Timestream for\nLiveAnalytics record.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-multimeasureattributemapping.html", "Properties": { "MultiMeasureAttributeName": { "MarkdownDocumentation": "`MultiMeasureAttributeName`\n\nTarget measure name to be used.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-multimeasureattributemapping.html#cfn-pipes-pipe-multimeasureattributemapping-multimeasureattributename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MeasureValueType": { "MarkdownDocumentation": "`MeasureValueType`\n\nData type of the measurement attribute in the source event.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DOUBLE | BIGINT | VARCHAR |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DOUBLE", "BIGINT", "VARCHAR", "BOOLEAN", "TIMESTAMP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-multimeasureattributemapping.html#cfn-pipes-pipe-multimeasureattributemapping-measurevaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MeasureValue": { "MarkdownDocumentation": "`MeasureValue`\n\nDynamic path to the measurement attribute in the source event.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-multimeasureattributemapping.html#cfn-pipes-pipe-multimeasureattributemapping-measurevalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.MultiMeasureMapping": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.MultiMeasureMapping`\n\nMaps multiple measures from the source event to the same Timestream for\nLiveAnalytics record.\nFor more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-multimeasuremapping.html", "Properties": { "MultiMeasureName": { "MarkdownDocumentation": "`MultiMeasureName`\n\nThe name of the multiple measurements per record (multi-measure).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-multimeasuremapping.html#cfn-pipes-pipe-multimeasuremapping-multimeasurename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MultiMeasureAttributeMappings": { "MarkdownDocumentation": "`MultiMeasureAttributeMappings`\n\nMappings that represent multiple source event fields mapped to measures in the same\nTimestream for LiveAnalytics record.\n*Required*: Yes\n*Type*: Array of [MultiMeasureAttributeMapping](./aws-properties-pipes-pipe-multimeasureattributemapping.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-multimeasuremapping.html#cfn-pipes-pipe-multimeasuremapping-multimeasureattributemappings", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MultiMeasureAttributeMapping", "DuplicatesAllowed": true } } }, "AWS::Pipes::Pipe.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.NetworkConfiguration`\n\nThis structure specifies the network configuration for an Amazon ECS\ntask.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-networkconfiguration.html", "Properties": { "AwsvpcConfiguration": { "MarkdownDocumentation": "`AwsvpcConfiguration`\n\nUse this structure to specify the VPC subnets and security groups for the task, and\nwhether a public IP address is to be used. This structure is relevant only for ECS tasks\nthat use the `awsvpc` network mode.\n*Required*: No\n*Type*: [AwsVpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-networkconfiguration.html#cfn-pipes-pipe-networkconfiguration-awsvpcconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AwsVpcConfiguration" } } }, "AWS::Pipes::Pipe.PipeEnrichmentHttpParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeEnrichmentHttpParameters`\n\nThese are custom parameter to be used when the target is an API Gateway REST APIs\nor EventBridge ApiDestinations. In the latter case, these are merged with any\nInvocationParameters specified on the Connection, with any values from the Connection\ntaking precedence.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmenthttpparameters.html", "Properties": { "PathParameterValues": { "MarkdownDocumentation": "`PathParameterValues`\n\nThe path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"\\*\").\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmenthttpparameters.html#cfn-pipes-pipe-pipeenrichmenthttpparameters-pathparametervalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "HeaderParameters": { "MarkdownDocumentation": "`HeaderParameters`\n\nThe headers that need to be sent as part of request invoking the API Gateway REST\nAPI or EventBridge ApiDestination.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmenthttpparameters.html#cfn-pipes-pipe-pipeenrichmenthttpparameters-headerparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "QueryStringParameters": { "MarkdownDocumentation": "`QueryStringParameters`\n\nThe query string keys/values that need to be sent as part of request invoking the\nAPI Gateway REST API or EventBridge ApiDestination.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[^\\x00-\\x1F\\x7F]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmenthttpparameters.html#cfn-pipes-pipe-pipeenrichmenthttpparameters-querystringparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::Pipes::Pipe.PipeEnrichmentParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeEnrichmentParameters`\n\nThe parameters required to set up enrichment on your pipe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html", "Properties": { "HttpParameters": { "MarkdownDocumentation": "`HttpParameters`\n\nContains the HTTP parameters to use when the target is a API Gateway REST\nendpoint or EventBridge ApiDestination.\nIf you specify an API Gateway REST API or EventBridge ApiDestination as a\ntarget, you can use this parameter to specify headers, path parameters, and query string\nkeys/values as part of your target invoking request. If you're using ApiDestinations, the\ncorresponding Connection can also have these values configured. In case of any conflicting\nkeys, values from the Connection take precedence.\n*Required*: No\n*Type*: [PipeEnrichmentHttpParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html#cfn-pipes-pipe-pipeenrichmentparameters-httpparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeEnrichmentHttpParameters" }, "InputTemplate": { "MarkdownDocumentation": "`InputTemplate`\n\nValid JSON text passed to the enrichment. In this case, nothing from the event itself is\npassed to the enrichment. For more information, see [The JavaScript Object Notation (JSON)\nData Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt).\nTo remove an input template, specify an empty string.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html#cfn-pipes-pipe-pipeenrichmentparameters-inputtemplate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeLogConfiguration": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeLogConfiguration`\n\nRepresents the configuration settings for the logs to which this pipe should report events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html", "Properties": { "FirehoseLogDestination": { "MarkdownDocumentation": "`FirehoseLogDestination`\n\nThe Amazon Data Firehose logging configuration settings for the pipe.\n*Required*: No\n*Type*: [FirehoseLogDestination](./aws-properties-pipes-pipe-firehoselogdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-firehoselogdestination", "UpdateType": "Mutable", "Required": false, "Type": "FirehoseLogDestination" }, "CloudwatchLogsLogDestination": { "MarkdownDocumentation": "`CloudwatchLogsLogDestination`\n\nThe logging configuration settings for the pipe.\n*Required*: No\n*Type*: [CloudwatchLogsLogDestination](./aws-properties-pipes-pipe-cloudwatchlogslogdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-cloudwatchlogslogdestination", "UpdateType": "Mutable", "Required": false, "Type": "CloudwatchLogsLogDestination" }, "IncludeExecutionData": { "MarkdownDocumentation": "`IncludeExecutionData`\n\nWhether the execution data (specifically, the `payload`,\n`awsRequest`, and `awsResponse` fields) is included in the log\nmessages for this pipe.\nThis applies to all log destinations for the pipe.\nFor more information, see [Including execution data in logs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data) in the *Amazon EventBridge User\nGuide*.\n*Allowed values:*\n`ALL`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "S3LogDestination": { "MarkdownDocumentation": "`S3LogDestination`\n\nThe Amazon S3 logging configuration settings for the pipe.\n*Required*: No\n*Type*: [S3LogDestination](./aws-properties-pipes-pipe-s3logdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-s3logdestination", "UpdateType": "Mutable", "Required": false, "Type": "S3LogDestination" }, "Level": { "MarkdownDocumentation": "`Level`\n\nThe level of logging detail to include. This applies to all log destinations for the pipe.\n*Required*: No\n*Type*: String\n*Allowed values*: `OFF | ERROR | INFO | TRACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OFF", "ERROR", "INFO", "TRACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-level", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeSourceActiveMQBrokerParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeSourceActiveMQBrokerParameters`\n\nThe parameters for using an Active MQ broker as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.html", "Properties": { "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe maximum number of records to include in each batch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.html#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-batchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "QueueName": { "MarkdownDocumentation": "`QueueName`\n\nThe name of the destination queue to consume.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\s\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.html#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-queuename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Credentials": { "MarkdownDocumentation": "`Credentials`\n\nThe credentials needed to access the resource.\n*Required*: Yes\n*Type*: [MQBrokerAccessCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.html#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-credentials", "UpdateType": "Mutable", "Required": true, "Type": "MQBrokerAccessCredentials" }, "MaximumBatchingWindowInSeconds": { "MarkdownDocumentation": "`MaximumBatchingWindowInSeconds`\n\nThe maximum length of a time to wait for events.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.html#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-maximumbatchingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.PipeSourceDynamoDBStreamParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeSourceDynamoDBStreamParameters`\n\nThe parameters for using a DynamoDB stream as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html", "Properties": { "StartingPosition": { "MarkdownDocumentation": "`StartingPosition`\n\n(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*Allowed values*: `TRIM_HORIZON | LATEST...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TRIM_HORIZON", "LATEST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-startingposition", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe maximum number of records to include in each batch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-batchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumRetryAttempts": { "MarkdownDocumentation": "`MaximumRetryAttempts`\n\nDiscard records after the specified number of retries. The default value is -1, which sets the maximum number of\nretries 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumretryattempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OnPartialBatchItemFailure": { "MarkdownDocumentation": "`OnPartialBatchItemFailure`\n\nDefine how to handle item process failures. `AUTOMATIC_BISECT` halves each batch and retry each half\nuntil all the records are processed or there is one failed message left in the batch.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTOMATIC_BISECT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC_BISECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-onpartialbatchitemfailure", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeadLetterConfig": { "MarkdownDocumentation": "`DeadLetterConfig`\n\nDefine the target queue to send dead-letter queue events to.\n*Required*: No\n*Type*: [DeadLetterConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-deadletterconfig", "UpdateType": "Mutable", "Required": false, "Type": "DeadLetterConfig" }, "ParallelizationFactor": { "MarkdownDocumentation": "`ParallelizationFactor`\n\nThe number of batches to process concurrently from each shard. The default value is 1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-parallelizationfactor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumRecordAgeInSeconds": { "MarkdownDocumentation": "`MaximumRecordAgeInSeconds`\n\nDiscard records older than the specified age. The default value is -1, which sets the maximum age to infinite.\nWhen the value is set to infinite, EventBridge never discards old records.\n*Required*: No\n*Type*: Integer\n*Minimum*: `-1`\n*Maximum*: `604800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumrecordageinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumBatchingWindowInSeconds": { "MarkdownDocumentation": "`MaximumBatchingWindowInSeconds`\n\nThe maximum length of a time to wait for events.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumbatchingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.PipeSourceKinesisStreamParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeSourceKinesisStreamParameters`\n\nThe parameters for using a Kinesis stream as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html", "Properties": { "StartingPosition": { "MarkdownDocumentation": "`StartingPosition`\n\nThe position in a stream from which to start reading.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TRIM_HORIZON | LATEST | AT_...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingposition", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe maximum number of records to include in each batch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-batchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumRetryAttempts": { "MarkdownDocumentation": "`MaximumRetryAttempts`\n\nDiscard records after the specified number of retries. The default value is -1, which sets the maximum number of\nretries 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumretryattempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OnPartialBatchItemFailure": { "MarkdownDocumentation": "`OnPartialBatchItemFailure`\n\nDefine how to handle item process failures. `AUTOMATIC_BISECT` halves each batch and retry each half\nuntil all the records are processed or there is one failed message left in the batch.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTOMATIC_BISECT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC_BISECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-onpartialbatchitemfailure", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeadLetterConfig": { "MarkdownDocumentation": "`DeadLetterConfig`\n\nDefine the target queue to send dead-letter queue events to.\n*Required*: No\n*Type*: [DeadLetterConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-deadletterconfig", "UpdateType": "Mutable", "Required": false, "Type": "DeadLetterConfig" }, "ParallelizationFactor": { "MarkdownDocumentation": "`ParallelizationFactor`\n\nThe number of batches to process concurrently from each shard. The default value is 1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-parallelizationfactor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumRecordAgeInSeconds": { "MarkdownDocumentation": "`MaximumRecordAgeInSeconds`\n\nDiscard records older than the specified age. The default value is -1, which sets the maximum age to infinite.\nWhen the value is set to infinite, EventBridge never discards old records.\n*Required*: No\n*Type*: Integer\n*Minimum*: `-1`\n*Maximum*: `604800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumrecordageinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StartingPositionTimestamp": { "MarkdownDocumentation": "`StartingPositionTimestamp`\n\nWith `StartingPosition` set to `AT_TIMESTAMP`, the time from which\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingpositiontimestamp", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaximumBatchingWindowInSeconds": { "MarkdownDocumentation": "`MaximumBatchingWindowInSeconds`\n\nThe maximum length of a time to wait for events.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumbatchingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.PipeSourceManagedStreamingKafkaParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeSourceManagedStreamingKafkaParameters`\n\nThe parameters for using an MSK stream as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html", "Properties": { "StartingPosition": { "MarkdownDocumentation": "`StartingPosition`\n\nThe position in a stream from which to start reading.\n*Required*: No\n*Type*: String\n*Allowed values*: `TRIM_HORIZON | LATEST...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TRIM_HORIZON", "LATEST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-startingposition", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe maximum number of records to include in each batch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-batchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ConsumerGroupID": { "MarkdownDocumentation": "`ConsumerGroupID`\n\nThe name of the destination queue to consume.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-\\/*:_+=.@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-consumergroupid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Credentials": { "MarkdownDocumentation": "`Credentials`\n\nThe credentials needed to access the resource.\n*Required*: No\n*Type*: [MSKAccessCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-credentials", "UpdateType": "Mutable", "Required": false, "Type": "MSKAccessCredentials" }, "TopicName": { "MarkdownDocumentation": "`TopicName`\n\nThe name of the topic that the pipe will read from.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^.]([a-zA-Z0-9\\-_.]+)$`\n*Minimum*: `1`\n*Maximum*: `249`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-topicname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MaximumBatchingWindowInSeconds": { "MarkdownDocumentation": "`MaximumBatchingWindowInSeconds`\n\nThe maximum length of a time to wait for events.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-maximumbatchingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.PipeSourceParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeSourceParameters`\n\nThe parameters required to set up a source for your pipe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html", "Properties": { "ManagedStreamingKafkaParameters": { "MarkdownDocumentation": "`ManagedStreamingKafkaParameters`\n\nThe parameters for using an MSK stream as a source.\n*Required*: No\n*Type*: [PipeSourceManagedStreamingKafkaParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html#cfn-pipes-pipe-pipesourceparameters-managedstreamingkafkaparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeSourceManagedStreamingKafkaParameters" }, "DynamoDBStreamParameters": { "MarkdownDocumentation": "`DynamoDBStreamParameters`\n\nThe parameters for using a DynamoDB stream as a source.\n*Required*: No\n*Type*: [PipeSourceDynamoDBStreamParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html#cfn-pipes-pipe-pipesourceparameters-dynamodbstreamparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeSourceDynamoDBStreamParameters" }, "SelfManagedKafkaParameters": { "MarkdownDocumentation": "`SelfManagedKafkaParameters`\n\nThe parameters for using a self-managed Apache Kafka stream as a source.\nA *self managed* cluster refers to any Apache Kafka cluster not hosted by AWS.\nThis includes both clusters you manage yourself, as well as those hosted by a third-party\nprovider, such as [Confluent\nCloud](https://www.confluent.io/), [CloudKarafka](https://www.cloudkarafka.com/), or [Redpanda](https://redpanda.com/). For more information, see [Apache Kafka streams as a source](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html) in the *Amazon EventBridge User Guide*.\n*Required*: No\n*Type*: [PipeSourceSelfManagedKafkaParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html#cfn-pipes-pipe-pipesourceparameters-selfmanagedkafkaparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeSourceSelfManagedKafkaParameters" }, "RabbitMQBrokerParameters": { "MarkdownDocumentation": "`RabbitMQBrokerParameters`\n\nThe parameters for using a Rabbit MQ broker as a source.\n*Required*: No\n*Type*: [PipeSourceRabbitMQBrokerParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html#cfn-pipes-pipe-pipesourceparameters-rabbitmqbrokerparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeSourceRabbitMQBrokerParameters" }, "SqsQueueParameters": { "MarkdownDocumentation": "`SqsQueueParameters`\n\nThe parameters for using a Amazon SQS stream as a source.\n*Required*: No\n*Type*: [PipeSourceSqsQueueParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html#cfn-pipes-pipe-pipesourceparameters-sqsqueueparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeSourceSqsQueueParameters" }, "KinesisStreamParameters": { "MarkdownDocumentation": "`KinesisStreamParameters`\n\nThe parameters for using a Kinesis stream as a source.\n*Required*: No\n*Type*: [PipeSourceKinesisStreamParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html#cfn-pipes-pipe-pipesourceparameters-kinesisstreamparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeSourceKinesisStreamParameters" }, "FilterCriteria": { "MarkdownDocumentation": "`FilterCriteria`\n\nThe collection of event patterns used to filter events.\nTo remove a filter, specify a `FilterCriteria` object with an empty array of `Filter` objects.\nFor more information, see [Events and Event\nPatterns](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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html#cfn-pipes-pipe-pipesourceparameters-filtercriteria", "UpdateType": "Mutable", "Required": false, "Type": "FilterCriteria" }, "ActiveMQBrokerParameters": { "MarkdownDocumentation": "`ActiveMQBrokerParameters`\n\nThe parameters for using an Active MQ broker as a source.\n*Required*: No\n*Type*: [PipeSourceActiveMQBrokerParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html#cfn-pipes-pipe-pipesourceparameters-activemqbrokerparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeSourceActiveMQBrokerParameters" } } }, "AWS::Pipes::Pipe.PipeSourceRabbitMQBrokerParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeSourceRabbitMQBrokerParameters`\n\nThe parameters for using a Rabbit MQ broker as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html", "Properties": { "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe maximum number of records to include in each batch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-batchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VirtualHost": { "MarkdownDocumentation": "`VirtualHost`\n\nThe name of the virtual host associated with the source broker.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-\\/*:_+=.@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-virtualhost", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "QueueName": { "MarkdownDocumentation": "`QueueName`\n\nThe name of the destination queue to consume.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\s\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-queuename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Credentials": { "MarkdownDocumentation": "`Credentials`\n\nThe credentials needed to access the resource.\n*Required*: Yes\n*Type*: [MQBrokerAccessCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-credentials", "UpdateType": "Mutable", "Required": true, "Type": "MQBrokerAccessCredentials" }, "MaximumBatchingWindowInSeconds": { "MarkdownDocumentation": "`MaximumBatchingWindowInSeconds`\n\nThe maximum length of a time to wait for events.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-maximumbatchingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.PipeSourceSelfManagedKafkaParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeSourceSelfManagedKafkaParameters`\n\nThe parameters for using a self-managed Apache Kafka stream as a source.\nA *self managed* cluster refers to any Apache Kafka cluster not hosted by AWS.\nThis includes both clusters you manage yourself, as well as those hosted by a third-party\nprovider, such as [Confluent\nCloud](https://www.confluent.io/), [CloudKarafka](https://www.cloudkarafka.com/), or [Redpanda](https://redpanda.com/). For more information, see [Apache Kafka streams as a source](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html) in the *Amazon EventBridge User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html", "Properties": { "StartingPosition": { "MarkdownDocumentation": "`StartingPosition`\n\nThe position in a stream from which to start reading.\n*Required*: No\n*Type*: String\n*Allowed values*: `TRIM_HORIZON | LATEST...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TRIM_HORIZON", "LATEST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-startingposition", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe maximum number of records to include in each batch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-batchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ConsumerGroupID": { "MarkdownDocumentation": "`ConsumerGroupID`\n\nThe name of the destination queue to consume.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-\\/*:_+=.@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-consumergroupid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AdditionalBootstrapServers": { "MarkdownDocumentation": "`AdditionalBootstrapServers`\n\nAn array of server URLs.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `300 | 2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-additionalbootstrapservers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Vpc": { "MarkdownDocumentation": "`Vpc`\n\nThis 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-vpc", "UpdateType": "Mutable", "Required": false, "Type": "SelfManagedKafkaAccessConfigurationVpc" }, "Credentials": { "MarkdownDocumentation": "`Credentials`\n\nThe credentials needed to access the resource.\n*Required*: No\n*Type*: [SelfManagedKafkaAccessConfigurationCredentials](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-credentials", "UpdateType": "Mutable", "Required": false, "Type": "SelfManagedKafkaAccessConfigurationCredentials" }, "ServerRootCaCertificate": { "MarkdownDocumentation": "`ServerRootCaCertificate`\n\nThe ARN of the Secrets Manager secret used for certification.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-serverrootcacertificate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TopicName": { "MarkdownDocumentation": "`TopicName`\n\nThe name of the topic that the pipe will read from.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^.]([a-zA-Z0-9\\-_.]+)$`\n*Minimum*: `1`\n*Maximum*: `249`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-topicname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MaximumBatchingWindowInSeconds": { "MarkdownDocumentation": "`MaximumBatchingWindowInSeconds`\n\nThe maximum length of a time to wait for events.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-maximumbatchingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.PipeSourceSqsQueueParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeSourceSqsQueueParameters`\n\nThe parameters for using a Amazon SQS stream as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html", "Properties": { "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe maximum number of records to include in each batch.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html#cfn-pipes-pipe-pipesourcesqsqueueparameters-batchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumBatchingWindowInSeconds": { "MarkdownDocumentation": "`MaximumBatchingWindowInSeconds`\n\nThe maximum length of a time to wait for events.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html#cfn-pipes-pipe-pipesourcesqsqueueparameters-maximumbatchingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Pipes::Pipe.PipeTargetBatchJobParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetBatchJobParameters`\n\nThe parameters for using an AWS Batch job as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html", "Properties": { "DependsOn": { "MarkdownDocumentation": "`DependsOn`\n\nA list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can\nspecify a `SEQUENTIAL` type dependency without specifying a job ID for array\njobs so that each child array job completes sequentially, starting at index 0. You can also\nspecify an `N_TO_N` type dependency with a job ID for array jobs. In that case,\neach index child of this job must wait for the corresponding index child of each dependency\nto complete before it can begin.\n*Required*: No\n*Type*: Array of [BatchJobDependency](./aws-properties-pipes-pipe-batchjobdependency.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-dependson", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BatchJobDependency", "DuplicatesAllowed": true }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nAdditional parameters passed to the job that replace parameter substitution placeholders\nthat are set in the job definition. Parameters are specified as a key and value pair\nmapping. Parameters included here override any corresponding parameter defaults from the\njob definition.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ArrayProperties": { "MarkdownDocumentation": "`ArrayProperties`\n\nThe array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000.\nIf 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-arrayproperties", "UpdateType": "Mutable", "Required": false, "Type": "BatchArrayProperties" }, "JobName": { "MarkdownDocumentation": "`JobName`\n\nThe name of the job. It can be up to 128 letters long. The first character must be\nalphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and\nunderscores (\\_).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-jobname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RetryStrategy": { "MarkdownDocumentation": "`RetryStrategy`\n\nThe retry strategy to use for failed jobs. When a retry strategy is specified here, it\noverrides the retry strategy defined in the job definition.\n*Required*: No\n*Type*: [BatchRetryStrategy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-retrystrategy", "UpdateType": "Mutable", "Required": false, "Type": "BatchRetryStrategy" }, "JobDefinition": { "MarkdownDocumentation": "`JobDefinition`\n\nThe job definition used by this job. This value can be one of `name`,\n`name:revision`, or the Amazon Resource Name (ARN) for the job definition. If\nname 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-jobdefinition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContainerOverrides": { "MarkdownDocumentation": "`ContainerOverrides`\n\nThe overrides that are sent to a container.\n*Required*: No\n*Type*: [BatchContainerOverrides](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-containeroverrides", "UpdateType": "Mutable", "Required": false, "Type": "BatchContainerOverrides" } } }, "AWS::Pipes::Pipe.PipeTargetCloudWatchLogsParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetCloudWatchLogsParameters`\n\nThe parameters for using an CloudWatch Logs log stream as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters.html", "Properties": { "LogStreamName": { "MarkdownDocumentation": "`LogStreamName`\n\nThe name of the log stream.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters.html#cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-logstreamname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Timestamp": { "MarkdownDocumentation": "`Timestamp`\n\nA [dynamic path parameter](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) to a field in the payload containing the time the event\noccurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.\nThe value cannot be a static timestamp as the provided timestamp would be applied to all\nevents delivered by the Pipe, regardless of when they are actually delivered.\nIf no dynamic path parameter is provided, the default value is the time the invocation is\nprocessed by the Pipe.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters.html#cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-timestamp", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeTargetEcsTaskParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetEcsTaskParameters`\n\nThe parameters for using an Amazon ECS task as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html", "Properties": { "PlatformVersion": { "MarkdownDocumentation": "`PlatformVersion`\n\nSpecifies the platform version for the task. Specify only the numeric portion of the\nplatform version, such as `1.1.0`.\nThis structure is used only if `LaunchType` is `FARGATE`. For more\ninformation about valid platform versions, see [AWS Fargate\nPlatform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-platformversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Group": { "MarkdownDocumentation": "`Group`\n\nSpecifies an Amazon ECS task group for the task. The maximum length is 255\ncharacters.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-group", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableECSManagedTags": { "MarkdownDocumentation": "`EnableECSManagedTags`\n\nSpecifies whether to enable Amazon ECS managed tags for the task. For more\ninformation, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-enableecsmanagedtags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TaskCount": { "MarkdownDocumentation": "`TaskCount`\n\nThe number of tasks to create based on `TaskDefinition`. The default is\n1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-taskcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnableExecuteCommand": { "MarkdownDocumentation": "`EnableExecuteCommand`\n\nWhether or not to enable the execute command functionality for the containers in this\ntask. If true, this enables execute command functionality on all containers in the\ntask.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-enableexecutecommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PlacementConstraints": { "MarkdownDocumentation": "`PlacementConstraints`\n\nAn array of placement constraint objects to use for the task. You can specify up to 10\nconstraints per task (including constraints in the task definition and those specified at\nruntime).\n*Required*: No\n*Type*: Array of [PlacementConstraint](./aws-properties-pipes-pipe-placementconstraint.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-placementconstraints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlacementConstraint", "DuplicatesAllowed": true }, "PropagateTags": { "MarkdownDocumentation": "`PropagateTags`\n\nSpecifies whether to propagate the tags from the task definition to the task. If no\nvalue is specified, the tags are not propagated. Tags can only be propagated to the task\nduring task creation. To add tags to a task after task creation, use the\n`TagResource` API action.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "TASK_DEFINITION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-propagatetags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlacementStrategy": { "MarkdownDocumentation": "`PlacementStrategy`\n\nThe placement strategy objects to use for the task. You can specify a maximum of five\nstrategy rules per task.\n*Required*: No\n*Type*: [Array](./aws-properties-pipes-pipe-placementstrategy.html) of [PlacementStrategy](./aws-properties-pipes-pipe-placementstrategy.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-placementstrategy", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlacementStrategy", "DuplicatesAllowed": true }, "LaunchType": { "MarkdownDocumentation": "`LaunchType`\n\nSpecifies the launch type on which your task is running. The launch type that you\nspecify here must match one of the launch type (compatibilities) of the target task. The\n`FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see\n[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*Allowed values*: `EC2 | FARGATE | EXTERNAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EC2", "FARGATE", "EXTERNAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-launchtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityProviderStrategy": { "MarkdownDocumentation": "`CapacityProviderStrategy`\n\nThe capacity provider strategy to use for the task.\nIf a `capacityProviderStrategy` is specified, the `launchType`\nparameter must be omitted. If no `capacityProviderStrategy` or launchType is\nspecified, the `defaultCapacityProviderStrategy` for the cluster is used.\n*Required*: No\n*Type*: Array of [CapacityProviderStrategyItem](./aws-properties-pipes-pipe-capacityproviderstrategyitem.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-capacityproviderstrategy", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CapacityProviderStrategyItem", "DuplicatesAllowed": true }, "ReferenceId": { "MarkdownDocumentation": "`ReferenceId`\n\nThe reference ID to use for the task.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-referenceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nThe overrides that are associated with a task.\n*Required*: No\n*Type*: [EcsTaskOverride](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-overrides", "UpdateType": "Mutable", "Required": false, "Type": "EcsTaskOverride" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nUse this structure if the Amazon ECS task uses the `awsvpc` network\nmode. This structure specifies the VPC subnets and security groups associated with the\ntask, and whether a public IP address is to be used. This structure is required if\n`LaunchType` is `FARGATE` because the `awsvpc` mode is\nrequired for Fargate tasks.\nIf you specify `NetworkConfiguration` when the target ECS task does not use\nthe `awsvpc` network mode, the task fails.\n*Required*: No\n*Type*: [NetworkConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NetworkConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to the task to help you categorize and organize them. Each\ntag consists of a key and an optional value, both of which you define. To learn more, see\n[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*: Array of [Tag](./aws-properties-pipes-pipe-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "TaskDefinitionArn": { "MarkdownDocumentation": "`TaskDefinitionArn`\n\nThe ARN of the task definition to use if the event target is an Amazon ECS task.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html#cfn-pipes-pipe-pipetargetecstaskparameters-taskdefinitionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeTargetEventBridgeEventBusParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetEventBridgeEventBusParameters`\n\nThe parameters for using an EventBridge event bus as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html", "Properties": { "DetailType": { "MarkdownDocumentation": "`DetailType`\n\nA free-form string, with a maximum of 128 characters, used to decide what fields to\nexpect in the event detail.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-detailtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointId": { "MarkdownDocumentation": "`EndpointId`\n\nThe URL subdomain of the endpoint. For example, if the URL for Endpoint is\nhttps://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is\n`abcde.veo`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-endpointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe 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*Pattern*: `^\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-time", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Resources": { "MarkdownDocumentation": "`Resources`\n\nAWS resources, identified by Amazon Resource Name (ARN), which the event\nprimarily concerns. Any number, including zero, may be present.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `1600 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-resources", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the event.\n*Required*: No\n*Type*: String\n*Pattern*: `(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-source", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeTargetHttpParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetHttpParameters`\n\nThese are custom parameter to be used when the target is an API Gateway REST APIs or\nEventBridge ApiDestinations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html", "Properties": { "PathParameterValues": { "MarkdownDocumentation": "`PathParameterValues`\n\nThe path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"\\*\").\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-pathparametervalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "HeaderParameters": { "MarkdownDocumentation": "`HeaderParameters`\n\nThe headers that need to be sent as part of request invoking the API Gateway REST\nAPI or EventBridge ApiDestination.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-headerparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "QueryStringParameters": { "MarkdownDocumentation": "`QueryStringParameters`\n\nThe query string keys/values that need to be sent as part of request invoking the\nAPI Gateway REST API or EventBridge ApiDestination.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[^\\x00-\\x1F\\x7F]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-querystringparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::Pipes::Pipe.PipeTargetKinesisStreamParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetKinesisStreamParameters`\n\nThe parameters for using a Kinesis stream as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetkinesisstreamparameters.html", "Properties": { "PartitionKey": { "MarkdownDocumentation": "`PartitionKey`\n\nDetermines which shard in the stream the data record is assigned to. Partition keys are\nUnicode 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\npartition key and associated data to a specific shard. Specifically, an MD5 hash function\nis used to map partition keys to 128-bit integer values and to map associated data records\nto shards. As a result of this hashing mechanism, all data records with the same partition\nkey map to the same shard within the stream.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetkinesisstreamparameters.html#cfn-pipes-pipe-pipetargetkinesisstreamparameters-partitionkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeTargetLambdaFunctionParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetLambdaFunctionParameters`\n\nThe parameters for using a Lambda function as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetlambdafunctionparameters.html", "Properties": { "InvocationType": { "MarkdownDocumentation": "`InvocationType`\n\nSpecify whether to invoke the function synchronously or asynchronously.\n* `REQUEST_RESPONSE` (default) - Invoke synchronously. This corresponds\n to the `RequestResponse` option in the `InvocationType`\n parameter for the Lambda\n [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax)\n API.\n* `FIRE_AND_FORGET` - Invoke asynchronously. This corresponds to the\n `Event` option in the `InvocationType` parameter for the\n Lambda\n [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax)\n API.\nFor more information, see [Invocation\ntypes](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*Allowed values*: `REQUEST_RESPONSE | FIRE_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REQUEST_RESPONSE", "FIRE_AND_FORGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetlambdafunctionparameters.html#cfn-pipes-pipe-pipetargetlambdafunctionparameters-invocationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeTargetParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetParameters`\n\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html", "Properties": { "StepFunctionStateMachineParameters": { "MarkdownDocumentation": "`StepFunctionStateMachineParameters`\n\nThe parameters for using a Step Functions state machine as a target.\n*Required*: No\n*Type*: [PipeTargetStateMachineParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-stepfunctionstatemachineparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetStateMachineParameters" }, "HttpParameters": { "MarkdownDocumentation": "`HttpParameters`\n\nThese are custom parameter to be used when the target is an API Gateway REST APIs or\nEventBridge ApiDestinations.\n*Required*: No\n*Type*: [PipeTargetHttpParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-httpparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetHttpParameters" }, "TimestreamParameters": { "MarkdownDocumentation": "`TimestreamParameters`\n\nThe parameters for using a Timestream for LiveAnalytics table as a\ntarget.\n*Required*: No\n*Type*: [PipeTargetTimestreamParameters](./aws-properties-pipes-pipe-pipetargettimestreamparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-timestreamparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetTimestreamParameters" }, "InputTemplate": { "MarkdownDocumentation": "`InputTemplate`\n\nValid JSON text passed to the target. In this case, nothing from the event itself is\npassed to the target. For more information, see [The JavaScript Object Notation (JSON)\nData Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt).\nTo remove an input template, specify an empty string.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-inputtemplate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventBridgeEventBusParameters": { "MarkdownDocumentation": "`EventBridgeEventBusParameters`\n\nThe parameters for using an EventBridge event bus as a target.\n*Required*: No\n*Type*: [PipeTargetEventBridgeEventBusParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-eventbridgeeventbusparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetEventBridgeEventBusParameters" }, "LambdaFunctionParameters": { "MarkdownDocumentation": "`LambdaFunctionParameters`\n\nThe parameters for using a Lambda function as a target.\n*Required*: No\n*Type*: [PipeTargetLambdaFunctionParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-lambdafunctionparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetLambdaFunctionParameters" }, "BatchJobParameters": { "MarkdownDocumentation": "`BatchJobParameters`\n\nThe parameters for using an AWS Batch job as a target.\n*Required*: No\n*Type*: [PipeTargetBatchJobParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-batchjobparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetBatchJobParameters" }, "RedshiftDataParameters": { "MarkdownDocumentation": "`RedshiftDataParameters`\n\nThese are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\nAmazon Redshift Data API BatchExecuteStatement.\n*Required*: No\n*Type*: [PipeTargetRedshiftDataParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-redshiftdataparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetRedshiftDataParameters" }, "SqsQueueParameters": { "MarkdownDocumentation": "`SqsQueueParameters`\n\nThe parameters for using a Amazon SQS stream as a target.\n*Required*: No\n*Type*: [PipeTargetSqsQueueParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-sqsqueueparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetSqsQueueParameters" }, "CloudWatchLogsParameters": { "MarkdownDocumentation": "`CloudWatchLogsParameters`\n\nThe parameters for using an CloudWatch Logs log stream as a target.\n*Required*: No\n*Type*: [PipeTargetCloudWatchLogsParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-cloudwatchlogsparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetCloudWatchLogsParameters" }, "KinesisStreamParameters": { "MarkdownDocumentation": "`KinesisStreamParameters`\n\nThe parameters for using a Kinesis stream as a target.\n*Required*: No\n*Type*: [PipeTargetKinesisStreamParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-kinesisstreamparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetKinesisStreamParameters" }, "SageMakerPipelineParameters": { "MarkdownDocumentation": "`SageMakerPipelineParameters`\n\nThe parameters for using a SageMaker AI pipeline as a target.\n*Required*: No\n*Type*: [PipeTargetSageMakerPipelineParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-sagemakerpipelineparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetSageMakerPipelineParameters" }, "EcsTaskParameters": { "MarkdownDocumentation": "`EcsTaskParameters`\n\nThe parameters for using an Amazon ECS task as a target.\n*Required*: No\n*Type*: [PipeTargetEcsTaskParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-ecstaskparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetEcsTaskParameters" } } }, "AWS::Pipes::Pipe.PipeTargetRedshiftDataParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetRedshiftDataParameters`\n\nThese are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\nAmazon Redshift Data API BatchExecuteStatement.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html", "Properties": { "StatementName": { "MarkdownDocumentation": "`StatementName`\n\nThe name of the SQL statement. You can name the SQL statement when you create it to\nidentify the query.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-statementname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Sqls": { "MarkdownDocumentation": "`Sqls`\n\nThe SQL statement text to run.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100000 | 40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-sqls", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Database": { "MarkdownDocumentation": "`Database`\n\nThe name of the database. Required when authenticating using temporary\ncredentials.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecretManagerArn": { "MarkdownDocumentation": "`SecretManagerArn`\n\nThe name or ARN of the secret that enables access to the database. Required when\nauthenticating using Secrets Manager.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-secretmanagerarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DbUser": { "MarkdownDocumentation": "`DbUser`\n\nThe database user name. Required when authenticating using temporary credentials.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-dbuser", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WithEvent": { "MarkdownDocumentation": "`WithEvent`\n\nIndicates whether to send an event back to EventBridge after the SQL statement\nruns.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-withevent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Pipes::Pipe.PipeTargetSageMakerPipelineParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetSageMakerPipelineParameters`\n\nThe parameters for using a SageMaker AI pipeline as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters.html", "Properties": { "PipelineParameterList": { "MarkdownDocumentation": "`PipelineParameterList`\n\nList of Parameter names and values for SageMaker AI Model Building Pipeline\nexecution.\n*Required*: No\n*Type*: Array of [SageMakerPipelineParameter](./aws-properties-pipes-pipe-sagemakerpipelineparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters.html#cfn-pipes-pipe-pipetargetsagemakerpipelineparameters-pipelineparameterlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SageMakerPipelineParameter", "DuplicatesAllowed": true } } }, "AWS::Pipes::Pipe.PipeTargetSqsQueueParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetSqsQueueParameters`\n\nThe parameters for using a Amazon SQS stream as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html", "Properties": { "MessageGroupId": { "MarkdownDocumentation": "`MessageGroupId`\n\nThe FIFO message group ID to use as the target.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagegroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MessageDeduplicationId": { "MarkdownDocumentation": "`MessageDeduplicationId`\n\nThis 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeTargetStateMachineParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetStateMachineParameters`\n\nThe parameters for using a Step Functions state machine as a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetstatemachineparameters.html", "Properties": { "InvocationType": { "MarkdownDocumentation": "`InvocationType`\n\nSpecify whether to invoke the Step Functions state machine synchronously or\nasynchronously.\n* `REQUEST_RESPONSE` (default) - Invoke synchronously. For more\n information, see [StartSyncExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html) in the *AWS Step Functions API\n Reference*.\n \n ###### Note\n \n `REQUEST_RESPONSE` is not supported for `STANDARD` state\n machine workflows.\n* `FIRE_AND_FORGET` - Invoke asynchronously. For more information, see\n [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) in the *AWS Step Functions API\n Reference*.\nFor more information, see [Invocation\ntypes](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*Allowed values*: `REQUEST_RESPONSE | FIRE_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REQUEST_RESPONSE", "FIRE_AND_FORGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetstatemachineparameters.html#cfn-pipes-pipe-pipetargetstatemachineparameters-invocationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PipeTargetTimestreamParameters": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PipeTargetTimestreamParameters`\n\nThe parameters for using a Timestream for LiveAnalytics table as a\ntarget.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html", "Properties": { "VersionValue": { "MarkdownDocumentation": "`VersionValue`\n\n64 bit version value or source data field that represents the version value for your data.\nWrite requests with a higher version number will update the existing measure values of the record and version.\nIn cases where the measure value is the same, the version will still be updated.\nDefault value is 1.\nTimestream for LiveAnalytics does not support updating partial measure values in a record.\nWrite requests for duplicate data with a\nhigher version number will update the existing measure value and version. In cases where\nthe measure value is the same, `Version` will still be updated. Default value is\n`1`.\n###### Note\n`Version` must be `1` or greater, or you will receive a\n`ValidationException` error.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-versionvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DimensionMappings": { "MarkdownDocumentation": "`DimensionMappings`\n\nMap source data to dimensions in the target Timestream for LiveAnalytics\ntable.\nFor more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)\n*Required*: Yes\n*Type*: Array of [DimensionMapping](./aws-properties-pipes-pipe-dimensionmapping.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-dimensionmappings", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DimensionMapping", "DuplicatesAllowed": true }, "EpochTimeUnit": { "MarkdownDocumentation": "`EpochTimeUnit`\n\nThe granularity of the time units used. Default is `MILLISECONDS`.\nRequired if `TimeFieldType` is specified as `EPOCH`.\n*Required*: No\n*Type*: String\n*Allowed values*: `MILLISECONDS | SECONDS | MI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MILLISECONDS", "SECONDS", "MICROSECONDS", "NANOSECONDS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-epochtimeunit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimeFieldType": { "MarkdownDocumentation": "`TimeFieldType`\n\nThe type of time value used.\nThe default is `EPOCH`.\n*Required*: No\n*Type*: String\n*Allowed values*: `EPOCH | TIMESTAMP_FORMAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EPOCH", "TIMESTAMP_FORMAT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-timefieldtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimestampFormat": { "MarkdownDocumentation": "`TimestampFormat`\n\nHow to format the timestamps. For example,\n`yyyy-MM-dd'T'HH:mm:ss'Z'`.\nRequired if `TimeFieldType` is specified as\n`TIMESTAMP_FORMAT`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-timestampformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MultiMeasureMappings": { "MarkdownDocumentation": "`MultiMeasureMappings`\n\nMaps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.\n*Required*: No\n*Type*: Array of [MultiMeasureMapping](./aws-properties-pipes-pipe-multimeasuremapping.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-multimeasuremappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MultiMeasureMapping", "DuplicatesAllowed": true }, "TimeValue": { "MarkdownDocumentation": "`TimeValue`\n\nDynamic path to the source data field that represents the time value for your data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-timevalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SingleMeasureMappings": { "MarkdownDocumentation": "`SingleMeasureMappings`\n\nMappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.\n*Required*: No\n*Type*: Array of [SingleMeasureMapping](./aws-properties-pipes-pipe-singlemeasuremapping.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-singlemeasuremappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SingleMeasureMapping", "DuplicatesAllowed": true } } }, "AWS::Pipes::Pipe.PlacementConstraint": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PlacementConstraint`\n\nAn object representing a constraint on task placement. To learn more, see [Task Placement\nConstraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementconstraint.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of constraint. Use distinctInstance to ensure that each task in a particular\ngroup is running on a different container instance. Use memberOf to restrict the selection\nto a group of valid candidates.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "distinctInstance", "memberOf" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementconstraint.html#cfn-pipes-pipe-placementconstraint-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nA cluster query language expression to apply to the constraint. You cannot specify an\nexpression if the constraint type is `distinctInstance`. To learn more, see\n[Cluster Query\nLanguage](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*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementconstraint.html#cfn-pipes-pipe-placementconstraint-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.PlacementStrategy": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.PlacementStrategy`\n\nThe task placement strategy for a task or service. To learn more, see [Task Placement\nStrategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field to apply the placement strategy against. For the spread placement strategy,\nvalid values are instanceId (or host, which has the same effect), or any platform or custom\nattribute that is applied to a container instance, such as attribute:ecs.availability-zone.\nFor the binpack placement strategy, valid values are cpu and memory. For the random\nplacement strategy, this field is not used.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html#cfn-pipes-pipe-placementstrategy-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of placement strategy. The random placement strategy randomly places tasks on\navailable candidates. The spread placement strategy spreads placement across available\ncandidates evenly based on the field parameter. The binpack strategy places tasks on\navailable candidates that have the least available amount of the resource that is specified\nwith the field parameter. For example, if you binpack on memory, a task is placed on the\ninstance with the least amount of remaining memory (but still enough to run the task).\n*Required*: No\n*Type*: String\n*Allowed values*: `random | spread | binpack...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "random", "spread", "binpack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html#cfn-pipes-pipe-placementstrategy-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.S3LogDestination": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.S3LogDestination`\n\nRepresents the Amazon S3 logging configuration settings for the pipe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the Amazon S3 bucket to which EventBridge delivers the log\nrecords for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputFormat": { "MarkdownDocumentation": "`OutputFormat`\n\nThe format EventBridge uses for the log records.\nEventBridge currently only supports `json` formatting.\n*Required*: No\n*Type*: String\n*Allowed values*: `json | plain | w3c...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "json", "plain", "w3c" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-outputformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe prefix text with which to begin Amazon S3 log object names.\nFor more information, see [Organizing objects using\nprefixes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) in the *Amazon Simple Storage 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketOwner": { "MarkdownDocumentation": "`BucketOwner`\n\nThe AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-bucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.SageMakerPipelineParameter": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.SageMakerPipelineParameter`\n\nName/Value pair of a parameter to start execution of a SageMaker AI Model Building\nPipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-sagemakerpipelineparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nValue of parameter to start execution of a SageMaker AI Model Building\nPipeline.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-sagemakerpipelineparameter.html#cfn-pipes-pipe-sagemakerpipelineparameter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of parameter to start execution of a SageMaker AI Model Building\nPipeline.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-sagemakerpipelineparameter.html#cfn-pipes-pipe-sagemakerpipelineparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationCredentials": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationCredentials`\n\nThe AWS Secrets Manager secret that stores your stream credentials.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.html", "Properties": { "BasicAuth": { "MarkdownDocumentation": "`BasicAuth`\n\nThe ARN of the Secrets Manager secret.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.html#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-basicauth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SaslScram256Auth": { "MarkdownDocumentation": "`SaslScram256Auth`\n\nThe ARN of the Secrets Manager secret.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.html#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-saslscram256auth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientCertificateTlsAuth": { "MarkdownDocumentation": "`ClientCertificateTlsAuth`\n\nThe ARN of the Secrets Manager secret.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.html#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-clientcertificatetlsauth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SaslScram512Auth": { "MarkdownDocumentation": "`SaslScram512Auth`\n\nThe ARN of the Secrets Manager secret.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.html#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-saslscram512auth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationVpc": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationVpc`\n\nThis structure specifies the VPC subnets and security groups for the stream, and whether\na public IP address is to be used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc.html", "Properties": { "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nSpecifies the subnets associated with the stream. These subnets must all be in the same\nVPC. You can specify as many as 16 subnets.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `1024 | 16`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc.html#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-subnets", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SecurityGroup": { "MarkdownDocumentation": "`SecurityGroup`\n\nSpecifies the security groups associated with the stream. These security groups must all\nbe in the same VPC. You can specify as many as five security groups.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `1024 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc.html#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-securitygroup", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Pipes::Pipe.SingleMeasureMapping": { "MarkdownDocumentation": "`AWS::Pipes::Pipe.SingleMeasureMapping`\n\nMaps a single source data field to a single record in the specified Timestream\nfor LiveAnalytics table.\nFor more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-singlemeasuremapping.html", "Properties": { "MeasureName": { "MarkdownDocumentation": "`MeasureName`\n\nTarget measure name for the measurement attribute in the Timestream table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-singlemeasuremapping.html#cfn-pipes-pipe-singlemeasuremapping-measurename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MeasureValueType": { "MarkdownDocumentation": "`MeasureValueType`\n\nData type of the source field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DOUBLE | BIGINT | VARCHAR |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DOUBLE", "BIGINT", "VARCHAR", "BOOLEAN", "TIMESTAMP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-singlemeasuremapping.html#cfn-pipes-pipe-singlemeasuremapping-measurevaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MeasureValue": { "MarkdownDocumentation": "`MeasureValue`\n\nDynamic path of the source field to map to the measure in the record.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-singlemeasuremapping.html#cfn-pipes-pipe-singlemeasuremapping-measurevalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QLDB::Stream.KinesisConfiguration": { "MarkdownDocumentation": "`AWS::QLDB::Stream.KinesisConfiguration`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html", "Properties": { "AggregationEnabled": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html#cfn-qldb-stream-kinesisconfiguration-aggregationenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "StreamArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html#cfn-qldb-stream-kinesisconfiguration-streamarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.AggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AggregationFunction`\n\nAn aggregation function aggregates values from a dimension or measure.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html", "Properties": { "AttributeAggregationFunction": { "MarkdownDocumentation": "`AttributeAggregationFunction`\n\nAggregation for attributes.\n*Required*: No\n*Type*: [AttributeAggregationFunction](./aws-properties-quicksight-analysis-attributeaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html#cfn-quicksight-analysis-aggregationfunction-attributeaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AttributeAggregationFunction" }, "DateAggregationFunction": { "MarkdownDocumentation": "`DateAggregationFunction`\n\nAggregation for date values.\n* `COUNT`: Aggregate by the total number of values, including duplicates.\n* `DISTINCT_COUNT`: Aggregate by the total number of distinct values.\n* `MIN`: Select the smallest date value.\n* `MAX`: Select the largest date value.\n*Required*: No\n*Type*: String\n*Allowed values*: `COUNT | DISTINCT_COUNT | MI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT", "MIN", "MAX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html#cfn-quicksight-analysis-aggregationfunction-dateaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumericalAggregationFunction": { "MarkdownDocumentation": "`NumericalAggregationFunction`\n\nAggregation for numerical values.\n*Required*: No\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-analysis-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html#cfn-quicksight-analysis-aggregationfunction-numericalaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "NumericalAggregationFunction" }, "CategoricalAggregationFunction": { "MarkdownDocumentation": "`CategoricalAggregationFunction`\n\nAggregation for categorical values.\n* `COUNT`: Aggregate by the total number of values, including duplicates.\n* `DISTINCT_COUNT`: Aggregate by the total number of distinct values.\n*Required*: No\n*Type*: String\n*Allowed values*: `COUNT | DISTINCT_COUNT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html#cfn-quicksight-analysis-aggregationfunction-categoricalaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.AggregationSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AggregationSortConfiguration`\n\nThe configuration options to sort aggregated values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationsortconfiguration.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe function that aggregates the values in `Column`.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-analysis-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationsortconfiguration.html#cfn-quicksight-analysis-aggregationsortconfiguration-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "SortDirection": { "MarkdownDocumentation": "`SortDirection`\n\nThe sort direction of values.\n* `ASC`: Sort in ascending order.\n* `DESC`: Sort in descending order.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationsortconfiguration.html#cfn-quicksight-analysis-aggregationsortconfiguration-sortdirection", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that determines the sort order of aggregated values.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationsortconfiguration.html#cfn-quicksight-analysis-aggregationsortconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Analysis.AnalysisDefaults": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AnalysisDefaults`\n\nThe configuration for default analysis settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefaults.html", "Properties": { "DefaultNewSheetConfiguration": { "MarkdownDocumentation": "`DefaultNewSheetConfiguration`\n\nThe configuration for default new sheet settings.\n*Required*: Yes\n*Type*: [DefaultNewSheetConfiguration](./aws-properties-quicksight-analysis-defaultnewsheetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefaults.html#cfn-quicksight-analysis-analysisdefaults-defaultnewsheetconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "DefaultNewSheetConfiguration" } } }, "AWS::QuickSight::Analysis.AnalysisDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AnalysisDefinition`\n\nThe definition of an analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nAn array of option definitions for an analysis.\n*Required*: No\n*Type*: [AssetOptions](./aws-properties-quicksight-analysis-assetoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-options", "UpdateType": "Mutable", "Required": false, "Type": "AssetOptions" }, "FilterGroups": { "MarkdownDocumentation": "`FilterGroups`\n\nFilter definitions for an analysis.\nFor more information, see [Filtering Data in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [FilterGroup](./aws-properties-quicksight-analysis-filtergroup.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-filtergroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterGroup", "DuplicatesAllowed": true }, "QueryExecutionOptions": { "MarkdownDocumentation": "`QueryExecutionOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [QueryExecutionOptions](./aws-properties-quicksight-analysis-queryexecutionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-queryexecutionoptions", "UpdateType": "Mutable", "Required": false, "Type": "QueryExecutionOptions" }, "StaticFiles": { "MarkdownDocumentation": "`StaticFiles`\n\nThe static files for the definition.\n*Required*: No\n*Type*: Array of [StaticFile](./aws-properties-quicksight-analysis-staticfile.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-staticfiles", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StaticFile", "DuplicatesAllowed": true }, "CalculatedFields": { "MarkdownDocumentation": "`CalculatedFields`\n\nAn array of calculated field definitions for the analysis.\n*Required*: No\n*Type*: Array of [CalculatedField](./aws-properties-quicksight-analysis-calculatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-calculatedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CalculatedField", "DuplicatesAllowed": true }, "DataSetIdentifierDeclarations": { "MarkdownDocumentation": "`DataSetIdentifierDeclarations`\n\nAn array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead\nof dataset ARNs throughout analysis sub-structures.\n*Required*: Yes\n*Type*: Array of [DataSetIdentifierDeclaration](./aws-properties-quicksight-analysis-datasetidentifierdeclaration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-datasetidentifierdeclarations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataSetIdentifierDeclaration", "DuplicatesAllowed": true }, "ColumnConfigurations": { "MarkdownDocumentation": "`ColumnConfigurations`\n\nAn array of analysis-level column configurations. Column configurations can be used to set default\nformatting for a column to be used throughout an analysis.\n*Required*: No\n*Type*: Array of [ColumnConfiguration](./aws-properties-quicksight-analysis-columnconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-columnconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnConfiguration", "DuplicatesAllowed": true }, "AnalysisDefaults": { "MarkdownDocumentation": "`AnalysisDefaults`\n\nProperty description not available.\n*Required*: No\n*Type*: [AnalysisDefaults](./aws-properties-quicksight-analysis-analysisdefaults.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-analysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisDefaults" }, "Sheets": { "MarkdownDocumentation": "`Sheets`\n\nAn array of sheet definitions for an analysis. Each `SheetDefinition` provides detailed information about\na sheet within this analysis.\n*Required*: No\n*Type*: Array of [SheetDefinition](./aws-properties-quicksight-analysis-sheetdefinition.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-sheets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetDefinition", "DuplicatesAllowed": true }, "ParameterDeclarations": { "MarkdownDocumentation": "`ParameterDeclarations`\n\nAn array of parameter declarations for an analysis.\nParameters are named variables that can transfer a value for use by an action or an object.\nFor more information, see [Parameters in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [ParameterDeclaration](./aws-properties-quicksight-analysis-parameterdeclaration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-parameterdeclarations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ParameterDeclaration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.AnalysisError": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AnalysisError`\n\nAnalysis error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the analysis error.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCESS_DENIED | SOURCE_NOT_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html#cfn-quicksight-analysis-analysiserror-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nThe message associated with the analysis error.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html#cfn-quicksight-analysis-analysiserror-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ViolatedEntities": { "MarkdownDocumentation": "`ViolatedEntities`\n\nLists the violated entities that caused the analysis error\n*Required*: No\n*Type*: Array of [Entity](./aws-properties-quicksight-analysis-entity.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html#cfn-quicksight-analysis-analysiserror-violatedentities", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Entity", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.AnalysisSourceEntity": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AnalysisSourceEntity`\n\nThe source entity of an analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html", "Properties": { "SourceTemplate": { "MarkdownDocumentation": "`SourceTemplate`\n\nThe source template for the source entity of the analysis.\n*Required*: No\n*Type*: [AnalysisSourceTemplate](./aws-properties-quicksight-analysis-analysissourcetemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html#cfn-quicksight-analysis-analysissourceentity-sourcetemplate", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisSourceTemplate" } } }, "AWS::QuickSight::Analysis.AnalysisSourceTemplate": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AnalysisSourceTemplate`\n\nThe source template of an analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.html", "Properties": { "DataSetReferences": { "MarkdownDocumentation": "`DataSetReferences`\n\nThe dataset references of the source template of an analysis.\n*Required*: Yes\n*Type*: Array of [DataSetReference](./aws-properties-quicksight-analysis-datasetreference.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.html#cfn-quicksight-analysis-analysissourcetemplate-datasetreferences", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataSetReference", "DuplicatesAllowed": true }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the source template of an analysis.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.html#cfn-quicksight-analysis-analysissourcetemplate-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.AnchorDateConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AnchorDateConfiguration`\n\nThe date configuration of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-anchordateconfiguration.html", "Properties": { "AnchorOption": { "MarkdownDocumentation": "`AnchorOption`\n\nThe options for the date configuration. Choose one of the options below:\n* `NOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `NOW`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "NOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-anchordateconfiguration.html#cfn-quicksight-analysis-anchordateconfiguration-anchoroption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe name of the parameter that is used for the anchor date configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-anchordateconfiguration.html#cfn-quicksight-analysis-anchordateconfiguration-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ArcAxisConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ArcAxisConfiguration`\n\nThe arc axis configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcaxisconfiguration.html", "Properties": { "Range": { "MarkdownDocumentation": "`Range`\n\nThe arc axis range of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcAxisDisplayRange](./aws-properties-quicksight-analysis-arcaxisdisplayrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcaxisconfiguration.html#cfn-quicksight-analysis-arcaxisconfiguration-range", "UpdateType": "Mutable", "Required": false, "Type": "ArcAxisDisplayRange" }, "ReserveRange": { "MarkdownDocumentation": "`ReserveRange`\n\nThe reserved range of the arc axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcaxisconfiguration.html#cfn-quicksight-analysis-arcaxisconfiguration-reserverange", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.ArcAxisDisplayRange": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ArcAxisDisplayRange`\n\nThe arc axis range of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcaxisdisplayrange.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum value of the arc axis range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcaxisdisplayrange.html#cfn-quicksight-analysis-arcaxisdisplayrange-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum value of the arc axis range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcaxisdisplayrange.html#cfn-quicksight-analysis-arcaxisdisplayrange-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.ArcConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ArcConfiguration`\n\nThe arc configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcconfiguration.html", "Properties": { "ArcAngle": { "MarkdownDocumentation": "`ArcAngle`\n\nThe option that determines the arc angle of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcconfiguration.html#cfn-quicksight-analysis-arcconfiguration-arcangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ArcThickness": { "MarkdownDocumentation": "`ArcThickness`\n\nThe options that determine the arc thickness of a `GaugeChartVisual`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SMALL | MEDIUM | LARGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SMALL", "MEDIUM", "LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcconfiguration.html#cfn-quicksight-analysis-arcconfiguration-arcthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ArcOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ArcOptions`\n\nThe options that determine the arc thickness of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcoptions.html", "Properties": { "ArcThickness": { "MarkdownDocumentation": "`ArcThickness`\n\nThe arc thickness of a `GaugeChartVisual`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SMALL | MEDIUM | LARGE | WH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SMALL", "MEDIUM", "LARGE", "WHOLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-arcoptions.html#cfn-quicksight-analysis-arcoptions-arcthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.AssetOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AssetOptions`\n\nAn array of analysis level configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-assetoptions.html", "Properties": { "Timezone": { "MarkdownDocumentation": "`Timezone`\n\nDetermines the timezone for the analysis.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-assetoptions.html#cfn-quicksight-analysis-assetoptions-timezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WeekStart": { "MarkdownDocumentation": "`WeekStart`\n\nDetermines the week start day for an analysis.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUNDAY | MONDAY | TUESDAY |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-assetoptions.html#cfn-quicksight-analysis-assetoptions-weekstart", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.AttributeAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AttributeAggregationFunction`\n\nAggregation for attributes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-attributeaggregationfunction.html", "Properties": { "SimpleAttributeAggregation": { "MarkdownDocumentation": "`SimpleAttributeAggregation`\n\nThe built-in aggregation functions for attributes.\n* `UNIQUE_VALUE`: Returns the unique value for a field, aggregated by the dimension fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNIQUE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNIQUE_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-attributeaggregationfunction.html#cfn-quicksight-analysis-attributeaggregationfunction-simpleattributeaggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueForMultipleValues": { "MarkdownDocumentation": "`ValueForMultipleValues`\n\nUsed by the `UNIQUE_VALUE` aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-attributeaggregationfunction.html#cfn-quicksight-analysis-attributeaggregationfunction-valueformultiplevalues", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.AxisDataOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisDataOptions`\n\nThe data options for an axis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdataoptions.html", "Properties": { "DateAxisOptions": { "MarkdownDocumentation": "`DateAxisOptions`\n\nThe options for an axis with a date field.\n*Required*: No\n*Type*: [DateAxisOptions](./aws-properties-quicksight-analysis-dateaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdataoptions.html#cfn-quicksight-analysis-axisdataoptions-dateaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateAxisOptions" }, "NumericAxisOptions": { "MarkdownDocumentation": "`NumericAxisOptions`\n\nThe options for an axis with a numeric field.\n*Required*: No\n*Type*: [NumericAxisOptions](./aws-properties-quicksight-analysis-numericaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdataoptions.html#cfn-quicksight-analysis-axisdataoptions-numericaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "NumericAxisOptions" } } }, "AWS::QuickSight::Analysis.AxisDisplayMinMaxRange": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisDisplayMinMaxRange`\n\nThe minimum and maximum setup for an axis display range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayminmaxrange.html", "Properties": { "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nThe minimum setup for an axis display range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayminmaxrange.html#cfn-quicksight-analysis-axisdisplayminmaxrange-minimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Maximum": { "MarkdownDocumentation": "`Maximum`\n\nThe maximum setup for an axis display range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayminmaxrange.html#cfn-quicksight-analysis-axisdisplayminmaxrange-maximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.AxisDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisDisplayOptions`\n\nThe display options for the axis label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayoptions.html", "Properties": { "DataOptions": { "MarkdownDocumentation": "`DataOptions`\n\nThe data options for an axis.\n*Required*: No\n*Type*: [AxisDataOptions](./aws-properties-quicksight-analysis-axisdataoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayoptions.html#cfn-quicksight-analysis-axisdisplayoptions-dataoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDataOptions" }, "TickLabelOptions": { "MarkdownDocumentation": "`TickLabelOptions`\n\nThe tick label options of an axis.\n*Required*: No\n*Type*: [AxisTickLabelOptions](./aws-properties-quicksight-analysis-axisticklabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayoptions.html#cfn-quicksight-analysis-axisdisplayoptions-ticklabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisTickLabelOptions" }, "AxisOffset": { "MarkdownDocumentation": "`AxisOffset`\n\nThe offset value that determines the starting placement of the axis within a visual's bounds.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayoptions.html#cfn-quicksight-analysis-axisdisplayoptions-axisoffset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AxisLineVisibility": { "MarkdownDocumentation": "`AxisLineVisibility`\n\nDetermines whether or not the axis line is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayoptions.html#cfn-quicksight-analysis-axisdisplayoptions-axislinevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GridLineVisibility": { "MarkdownDocumentation": "`GridLineVisibility`\n\nDetermines whether or not the grid line is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayoptions.html#cfn-quicksight-analysis-axisdisplayoptions-gridlinevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScrollbarOptions": { "MarkdownDocumentation": "`ScrollbarOptions`\n\nThe scroll bar options for an axis.\n*Required*: No\n*Type*: [ScrollBarOptions](./aws-properties-quicksight-analysis-scrollbaroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayoptions.html#cfn-quicksight-analysis-axisdisplayoptions-scrollbaroptions", "UpdateType": "Mutable", "Required": false, "Type": "ScrollBarOptions" } } }, "AWS::QuickSight::Analysis.AxisDisplayRange": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisDisplayRange`\n\nThe range setup of a numeric axis display range.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayrange.html", "Properties": { "DataDriven": { "MarkdownDocumentation": "`DataDriven`\n\nThe data-driven setup of an axis display range.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayrange.html#cfn-quicksight-analysis-axisdisplayrange-datadriven", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MinMax": { "MarkdownDocumentation": "`MinMax`\n\nThe minimum and maximum setup of an axis display range.\n*Required*: No\n*Type*: [AxisDisplayMinMaxRange](./aws-properties-quicksight-analysis-axisdisplayminmaxrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisdisplayrange.html#cfn-quicksight-analysis-axisdisplayrange-minmax", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayMinMaxRange" } } }, "AWS::QuickSight::Analysis.AxisLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisLabelOptions`\n\nThe label options for a chart axis. You must specify the field that the label is targeted to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislabeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe text for the axis label.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislabeloptions.html#cfn-quicksight-analysis-axislabeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplyTo": { "MarkdownDocumentation": "`ApplyTo`\n\nThe options that indicate which field the label belongs to.\n*Required*: No\n*Type*: [AxisLabelReferenceOptions](./aws-properties-quicksight-analysis-axislabelreferenceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislabeloptions.html#cfn-quicksight-analysis-axislabeloptions-applyto", "UpdateType": "Mutable", "Required": false, "Type": "AxisLabelReferenceOptions" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the axis label.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislabeloptions.html#cfn-quicksight-analysis-axislabeloptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Analysis.AxisLabelReferenceOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisLabelReferenceOptions`\n\nThe reference that specifies where the axis label is applied to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislabelreferenceoptions.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the axis label is targeted to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislabelreferenceoptions.html#cfn-quicksight-analysis-axislabelreferenceoptions-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field that the axis label is targeted to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislabelreferenceoptions.html#cfn-quicksight-analysis-axislabelreferenceoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.AxisLinearScale": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisLinearScale`\n\nThe liner axis scale setup.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislinearscale.html", "Properties": { "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe step size setup of a linear axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislinearscale.html#cfn-quicksight-analysis-axislinearscale-stepsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StepCount": { "MarkdownDocumentation": "`StepCount`\n\nThe step count setup of a linear axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislinearscale.html#cfn-quicksight-analysis-axislinearscale-stepcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.AxisLogarithmicScale": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisLogarithmicScale`\n\nThe logarithmic axis scale setup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislogarithmicscale.html", "Properties": { "Base": { "MarkdownDocumentation": "`Base`\n\nThe base setup of a logarithmic axis scale.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axislogarithmicscale.html#cfn-quicksight-analysis-axislogarithmicscale-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.AxisScale": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisScale`\n\nThe scale setup\noptions for a numeric axis display.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisscale.html", "Properties": { "Logarithmic": { "MarkdownDocumentation": "`Logarithmic`\n\nThe logarithmic axis scale setup.\n*Required*: No\n*Type*: [AxisLogarithmicScale](./aws-properties-quicksight-analysis-axislogarithmicscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisscale.html#cfn-quicksight-analysis-axisscale-logarithmic", "UpdateType": "Mutable", "Required": false, "Type": "AxisLogarithmicScale" }, "Linear": { "MarkdownDocumentation": "`Linear`\n\nThe linear axis scale setup.\n*Required*: No\n*Type*: [AxisLinearScale](./aws-properties-quicksight-analysis-axislinearscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisscale.html#cfn-quicksight-analysis-axisscale-linear", "UpdateType": "Mutable", "Required": false, "Type": "AxisLinearScale" } } }, "AWS::QuickSight::Analysis.AxisTickLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.AxisTickLabelOptions`\n\nThe tick label options of an axis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisticklabeloptions.html", "Properties": { "RotationAngle": { "MarkdownDocumentation": "`RotationAngle`\n\nThe rotation angle of the axis tick labels.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisticklabeloptions.html#cfn-quicksight-analysis-axisticklabeloptions-rotationangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "LabelOptions": { "MarkdownDocumentation": "`LabelOptions`\n\nDetermines whether or not the axis ticks are visible.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-axisticklabeloptions.html#cfn-quicksight-analysis-axisticklabeloptions-labeloptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" } } }, "AWS::QuickSight::Analysis.BarChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BarChartAggregatedFieldWells`\n\nThe aggregated field wells of a bar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category (y-axis) field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartaggregatedfieldwells.html#cfn-quicksight-analysis-barchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color (group/color) field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartaggregatedfieldwells.html#cfn-quicksight-analysis-barchartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a bar chart. Values are aggregated by\ncategory.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartaggregatedfieldwells.html#cfn-quicksight-analysis-barchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartaggregatedfieldwells.html#cfn-quicksight-analysis-barchartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.BarChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BarChartConfiguration`\n\nThe configuration of a `BarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `BarChartVisual`.\n*Required*: No\n*Type*: [BarChartSortConfiguration](./aws-properties-quicksight-analysis-barchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BarChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-analysis-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a bar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-analysis-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "Orientation": { "MarkdownDocumentation": "`Orientation`\n\nThe orientation of the bars in a bar chart visual. There are two valid values in this structure:\n* `HORIZONTAL`: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.\n* `VERTICAL`: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.\n*Required*: No\n*Type*: String\n*Allowed values*: `HORIZONTAL | VERTICAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HORIZONTAL", "VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-orientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a bar chart value.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "BarsArrangement": { "MarkdownDocumentation": "`BarsArrangement`\n\nDetermines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLUSTERED | STACKED | STACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLUSTERED", "STACKED", "STACKED_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-barsarrangement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe label display options (grid line, range, scale, axis step) for bar chart category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe contribution analysis (anomaly configuration) setup of the visual.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-analysis-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [BarChartFieldWells](./aws-properties-quicksight-analysis-barchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BarChartFieldWells" }, "ValueAxis": { "MarkdownDocumentation": "`ValueAxis`\n\nThe label display options (grid line, range, scale, axis step) for a bar chart value.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-valueaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartconfiguration.html#cfn-quicksight-analysis-barchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Analysis.BarChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BarChartFieldWells`\n\nThe field wells of a `BarChartVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartfieldwells.html", "Properties": { "BarChartAggregatedFieldWells": { "MarkdownDocumentation": "`BarChartAggregatedFieldWells`\n\nThe aggregated field wells of a bar chart.\n*Required*: No\n*Type*: [BarChartAggregatedFieldWells](./aws-properties-quicksight-analysis-barchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartfieldwells.html#cfn-quicksight-analysis-barchartfieldwells-barchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BarChartAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.BarChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BarChartSortConfiguration`\n\nsort-configuration-description\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartsortconfiguration.html", "Properties": { "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartsortconfiguration.html#cfn-quicksight-analysis-barchartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe sort configuration of color fields in a bar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartsortconfiguration.html#cfn-quicksight-analysis-barchartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe limit on the number of values displayed in a bar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartsortconfiguration.html#cfn-quicksight-analysis-barchartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories displayed in a bar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartsortconfiguration.html#cfn-quicksight-analysis-barchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartsortconfiguration.html#cfn-quicksight-analysis-barchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartsortconfiguration.html#cfn-quicksight-analysis-barchartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Analysis.BarChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BarChartVisual`\n\nA bar chart.\nThe `BarChartVisual` structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:\n* Horizontal bar chart\n* Vertical bar chart\n* Horizontal stacked bar chart\n* Vertical stacked bar chart\n* Horizontal stacked 100% bar chart\n* Vertical stacked 100% bar chart\nFor more information, see [Using bar charts](https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartvisual.html#cfn-quicksight-analysis-barchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartvisual.html#cfn-quicksight-analysis-barchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [BarChartConfiguration](./aws-properties-quicksight-analysis-barchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartvisual.html#cfn-quicksight-analysis-barchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BarChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartvisual.html#cfn-quicksight-analysis-barchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartvisual.html#cfn-quicksight-analysis-barchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartvisual.html#cfn-quicksight-analysis-barchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-barchartvisual.html#cfn-quicksight-analysis-barchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.BinCountOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BinCountOptions`\n\nThe options that determine the bin count of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bincountoptions.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe options that determine the bin count value.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bincountoptions.html#cfn-quicksight-analysis-bincountoptions-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.BinWidthOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BinWidthOptions`\n\nThe options that determine the bin width of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-binwidthoptions.html", "Properties": { "BinCountLimit": { "MarkdownDocumentation": "`BinCountLimit`\n\nThe options that determine the bin count limit.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-binwidthoptions.html#cfn-quicksight-analysis-binwidthoptions-bincountlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe options that determine the bin width value.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-binwidthoptions.html#cfn-quicksight-analysis-binwidthoptions-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.BodySectionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BodySectionConfiguration`\n\nThe configuration of a body section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionconfiguration.html", "Properties": { "Content": { "MarkdownDocumentation": "`Content`\n\nThe configuration of content in a body section.\n*Required*: Yes\n*Type*: [BodySectionContent](./aws-properties-quicksight-analysis-bodysectioncontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionconfiguration.html#cfn-quicksight-analysis-bodysectionconfiguration-content", "UpdateType": "Mutable", "Required": true, "Type": "BodySectionContent" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style options of a body section.\n*Required*: No\n*Type*: [SectionStyle](./aws-properties-quicksight-analysis-sectionstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionconfiguration.html#cfn-quicksight-analysis-bodysectionconfiguration-style", "UpdateType": "Mutable", "Required": false, "Type": "SectionStyle" }, "PageBreakConfiguration": { "MarkdownDocumentation": "`PageBreakConfiguration`\n\nThe configuration of a page break for a section.\n*Required*: No\n*Type*: [SectionPageBreakConfiguration](./aws-properties-quicksight-analysis-sectionpagebreakconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionconfiguration.html#cfn-quicksight-analysis-bodysectionconfiguration-pagebreakconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SectionPageBreakConfiguration" }, "SectionId": { "MarkdownDocumentation": "`SectionId`\n\nThe unique identifier of a body section.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionconfiguration.html#cfn-quicksight-analysis-bodysectionconfiguration-sectionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RepeatConfiguration": { "MarkdownDocumentation": "`RepeatConfiguration`\n\nDescribes the configurations that are required to declare a section as repeating.\n*Required*: No\n*Type*: [BodySectionRepeatConfiguration](./aws-properties-quicksight-analysis-bodysectionrepeatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionconfiguration.html#cfn-quicksight-analysis-bodysectionconfiguration-repeatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionRepeatConfiguration" } } }, "AWS::QuickSight::Analysis.BodySectionContent": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BodySectionContent`\n\nThe configuration of content in a body section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectioncontent.html", "Properties": { "Layout": { "MarkdownDocumentation": "`Layout`\n\nThe layout configuration of a body section.\n*Required*: No\n*Type*: [SectionLayoutConfiguration](./aws-properties-quicksight-analysis-sectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectioncontent.html#cfn-quicksight-analysis-bodysectioncontent-layout", "UpdateType": "Mutable", "Required": false, "Type": "SectionLayoutConfiguration" } } }, "AWS::QuickSight::Analysis.BodySectionDynamicCategoryDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BodySectionDynamicCategoryDimensionConfiguration`\n\nDescribes the **Category** dataset column and constraints for the dynamic values used to repeat the contents of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectiondynamiccategorydimensionconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-analysis-bodysectiondynamiccategorydimensionconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "SortByMetrics": { "MarkdownDocumentation": "`SortByMetrics`\n\nSort criteria on the column values that you use for repetition.\n*Required*: No\n*Type*: Array of [ColumnSort](./aws-properties-quicksight-analysis-columnsort.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-analysis-bodysectiondynamiccategorydimensionconfiguration-sortbymetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSort", "DuplicatesAllowed": true }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nNumber of values to use from the column for repetition.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-analysis-bodysectiondynamiccategorydimensionconfiguration-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.BodySectionDynamicNumericDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BodySectionDynamicNumericDimensionConfiguration`\n\nDescribes the **Numeric** dataset column and constraints for the dynamic values used to repeat the contents of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectiondynamicnumericdimensionconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-analysis-bodysectiondynamicnumericdimensionconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "SortByMetrics": { "MarkdownDocumentation": "`SortByMetrics`\n\nSort criteria on the column values that you use for repetition.\n*Required*: No\n*Type*: Array of [ColumnSort](./aws-properties-quicksight-analysis-columnsort.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-analysis-bodysectiondynamicnumericdimensionconfiguration-sortbymetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSort", "DuplicatesAllowed": true }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nNumber of values to use from the column for repetition.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-analysis-bodysectiondynamicnumericdimensionconfiguration-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.BodySectionRepeatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BodySectionRepeatConfiguration`\n\nDescribes the configurations that are required to declare a section as repeating.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatconfiguration.html", "Properties": { "DimensionConfigurations": { "MarkdownDocumentation": "`DimensionConfigurations`\n\nList of `BodySectionRepeatDimensionConfiguration` values that describe the dataset column and constraints for the column used to repeat the contents of a section.\n*Required*: No\n*Type*: Array of [BodySectionRepeatDimensionConfiguration](./aws-properties-quicksight-analysis-bodysectionrepeatdimensionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatconfiguration.html#cfn-quicksight-analysis-bodysectionrepeatconfiguration-dimensionconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BodySectionRepeatDimensionConfiguration", "DuplicatesAllowed": true }, "NonRepeatingVisuals": { "MarkdownDocumentation": "`NonRepeatingVisuals`\n\nList of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatconfiguration.html#cfn-quicksight-analysis-bodysectionrepeatconfiguration-nonrepeatingvisuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PageBreakConfiguration": { "MarkdownDocumentation": "`PageBreakConfiguration`\n\nPage break configuration to apply for each repeating instance.\n*Required*: No\n*Type*: [BodySectionRepeatPageBreakConfiguration](./aws-properties-quicksight-analysis-bodysectionrepeatpagebreakconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatconfiguration.html#cfn-quicksight-analysis-bodysectionrepeatconfiguration-pagebreakconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionRepeatPageBreakConfiguration" } } }, "AWS::QuickSight::Analysis.BodySectionRepeatDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BodySectionRepeatDimensionConfiguration`\n\nDescribes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either **Category** or **Numeric** column configuration\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatdimensionconfiguration.html", "Properties": { "DynamicNumericDimensionConfiguration": { "MarkdownDocumentation": "`DynamicNumericDimensionConfiguration`\n\nDescribes the **Numeric** dataset column and constraints around the dynamic values used to repeat the contents of a section.\n*Required*: No\n*Type*: [BodySectionDynamicNumericDimensionConfiguration](./aws-properties-quicksight-analysis-bodysectiondynamicnumericdimensionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatdimensionconfiguration.html#cfn-quicksight-analysis-bodysectionrepeatdimensionconfiguration-dynamicnumericdimensionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionDynamicNumericDimensionConfiguration" }, "DynamicCategoryDimensionConfiguration": { "MarkdownDocumentation": "`DynamicCategoryDimensionConfiguration`\n\nDescribes the **Category** dataset column and constraints around the dynamic values that will be used in repeating the section contents.\n*Required*: No\n*Type*: [BodySectionDynamicCategoryDimensionConfiguration](./aws-properties-quicksight-analysis-bodysectiondynamiccategorydimensionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatdimensionconfiguration.html#cfn-quicksight-analysis-bodysectionrepeatdimensionconfiguration-dynamiccategorydimensionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionDynamicCategoryDimensionConfiguration" } } }, "AWS::QuickSight::Analysis.BodySectionRepeatPageBreakConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BodySectionRepeatPageBreakConfiguration`\n\nThe page break configuration to apply for each repeating instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatpagebreakconfiguration.html", "Properties": { "After": { "MarkdownDocumentation": "`After`\n\nProperty description not available.\n*Required*: No\n*Type*: [SectionAfterPageBreak](./aws-properties-quicksight-analysis-sectionafterpagebreak.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-bodysectionrepeatpagebreakconfiguration.html#cfn-quicksight-analysis-bodysectionrepeatpagebreakconfiguration-after", "UpdateType": "Mutable", "Required": false, "Type": "SectionAfterPageBreak" } } }, "AWS::QuickSight::Analysis.BoxPlotAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BoxPlotAggregatedFieldWells`\n\nThe aggregated field well for a box plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well of a box plot chart. Values are grouped based on group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotaggregatedfieldwells.html#cfn-quicksight-analysis-boxplotaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field well of a box plot chart. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotaggregatedfieldwells.html#cfn-quicksight-analysis-boxplotaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.BoxPlotChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BoxPlotChartConfiguration`\n\nThe configuration of a `BoxPlotVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `BoxPlotVisual`.\n*Required*: No\n*Type*: [BoxPlotSortConfiguration](./aws-properties-quicksight-analysis-boxplotsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nProperty description not available.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-analysis-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe label display options (grid line, range, scale, axis step) of a box plot category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) of a box plot value.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility and sort Icon visibility) of a box plot category.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [BoxPlotFieldWells](./aws-properties-quicksight-analysis-boxplotfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "BoxPlotOptions": { "MarkdownDocumentation": "`BoxPlotOptions`\n\nThe box plot chart options for a box plot visual\n*Required*: No\n*Type*: [BoxPlotOptions](./aws-properties-quicksight-analysis-boxplotoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-boxplotoptions", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, axis step) of a box plot category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotchartconfiguration.html#cfn-quicksight-analysis-boxplotchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Analysis.BoxPlotFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BoxPlotFieldWells`\n\nThe field wells of a `BoxPlotVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotfieldwells.html", "Properties": { "BoxPlotAggregatedFieldWells": { "MarkdownDocumentation": "`BoxPlotAggregatedFieldWells`\n\nThe aggregated field wells of a box plot.\n*Required*: No\n*Type*: [BoxPlotAggregatedFieldWells](./aws-properties-quicksight-analysis-boxplotaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotfieldwells.html#cfn-quicksight-analysis-boxplotfieldwells-boxplotaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.BoxPlotOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BoxPlotOptions`\n\nThe options of a box plot visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotoptions.html", "Properties": { "StyleOptions": { "MarkdownDocumentation": "`StyleOptions`\n\nThe style options of the box plot.\n*Required*: No\n*Type*: [BoxPlotStyleOptions](./aws-properties-quicksight-analysis-boxplotstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotoptions.html#cfn-quicksight-analysis-boxplotoptions-styleoptions", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotStyleOptions" }, "OutlierVisibility": { "MarkdownDocumentation": "`OutlierVisibility`\n\nDetermines the visibility of the outlier in a box plot.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotoptions.html#cfn-quicksight-analysis-boxplotoptions-outliervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllDataPointsVisibility": { "MarkdownDocumentation": "`AllDataPointsVisibility`\n\nDetermines the visibility of all data points of the box plot.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotoptions.html#cfn-quicksight-analysis-boxplotoptions-alldatapointsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.BoxPlotSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BoxPlotSortConfiguration`\n\nThe sort configuration of a `BoxPlotVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotsortconfiguration.html", "Properties": { "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of a group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotsortconfiguration.html#cfn-quicksight-analysis-boxplotsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "PaginationConfiguration": { "MarkdownDocumentation": "`PaginationConfiguration`\n\nThe pagination configuration of a table visual or box plot.\n*Required*: No\n*Type*: [PaginationConfiguration](./aws-properties-quicksight-analysis-paginationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotsortconfiguration.html#cfn-quicksight-analysis-boxplotsortconfiguration-paginationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PaginationConfiguration" } } }, "AWS::QuickSight::Analysis.BoxPlotStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BoxPlotStyleOptions`\n\nThe style options of the box plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotstyleoptions.html", "Properties": { "FillStyle": { "MarkdownDocumentation": "`FillStyle`\n\nThe fill styles (solid, transparent) of the box plot.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | TRANSPARENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "TRANSPARENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotstyleoptions.html#cfn-quicksight-analysis-boxplotstyleoptions-fillstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.BoxPlotVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.BoxPlotVisual`\n\nA box plot.\nFor more information, see [Using box plots](https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotvisual.html#cfn-quicksight-analysis-boxplotvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotvisual.html#cfn-quicksight-analysis-boxplotvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [BoxPlotChartConfiguration](./aws-properties-quicksight-analysis-boxplotchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotvisual.html#cfn-quicksight-analysis-boxplotvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotvisual.html#cfn-quicksight-analysis-boxplotvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotvisual.html#cfn-quicksight-analysis-boxplotvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotvisual.html#cfn-quicksight-analysis-boxplotvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-boxplotvisual.html#cfn-quicksight-analysis-boxplotvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.CalculatedField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CalculatedField`\n\nThe calculated field of an analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-calculatedfield.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the calculated field.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-calculatedfield.html#cfn-quicksight-analysis-calculatedfield-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in this calculated field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-calculatedfield.html#cfn-quicksight-analysis-calculatedfield-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the calculated field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-calculatedfield.html#cfn-quicksight-analysis-calculatedfield-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CalculatedMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CalculatedMeasureField`\n\nThe table calculation measure field for pivot tables.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-calculatedmeasurefield.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression in the table calculation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-calculatedmeasurefield.html#cfn-quicksight-analysis-calculatedmeasurefield-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-calculatedmeasurefield.html#cfn-quicksight-analysis-calculatedmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CascadingControlConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-cascadingcontrolconfiguration.html", "Properties": { "SourceControls": { "MarkdownDocumentation": "`SourceControls`\n\nA list of source controls that determine the values that are used in the current control.\n*Required*: No\n*Type*: Array of [CascadingControlSource](./aws-properties-quicksight-analysis-cascadingcontrolsource.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-cascadingcontrolconfiguration.html#cfn-quicksight-analysis-cascadingcontrolconfiguration-sourcecontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CascadingControlSource", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.CascadingControlSource": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CascadingControlSource`\n\nThe source controls that are used in a `CascadingControlConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-cascadingcontrolsource.html", "Properties": { "SourceSheetControlId": { "MarkdownDocumentation": "`SourceSheetControlId`\n\nThe source sheet control ID of a `CascadingControlSource`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-cascadingcontrolsource.html#cfn-quicksight-analysis-cascadingcontrolsource-sourcesheetcontrolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnToMatch": { "MarkdownDocumentation": "`ColumnToMatch`\n\nThe column identifier that determines which column to look up for the source sheet control.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-cascadingcontrolsource.html#cfn-quicksight-analysis-cascadingcontrolsource-columntomatch", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Analysis.CategoricalDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CategoricalDimensionField`\n\nThe dimension type field with categorical type columns..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricaldimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricaldimensionfield.html#cfn-quicksight-analysis-categoricaldimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-analysis-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricaldimensionfield.html#cfn-quicksight-analysis-categoricaldimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `CategoricalDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricaldimensionfield.html#cfn-quicksight-analysis-categoricaldimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricaldimensionfield.html#cfn-quicksight-analysis-categoricaldimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CategoricalMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CategoricalMeasureField`\n\nThe measure type field with categorical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricalmeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [String](./aws-properties-quicksight-analysis-aggregationfunction.html)\n*Allowed values*: `COUNT | DISTINCT_COUNT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricalmeasurefield.html#cfn-quicksight-analysis-categoricalmeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-analysis-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricalmeasurefield.html#cfn-quicksight-analysis-categoricalmeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `CategoricalMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricalmeasurefield.html#cfn-quicksight-analysis-categoricalmeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoricalmeasurefield.html#cfn-quicksight-analysis-categoricalmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CategoryDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CategoryDrillDownFilter`\n\nThe category drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categorydrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categorydrilldownfilter.html#cfn-quicksight-analysis-categorydrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nA list of the string inputs that are the values of the category drill down filter.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categorydrilldownfilter.html#cfn-quicksight-analysis-categorydrilldownfilter-categoryvalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.CategoryFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CategoryFilter`\n\nA `CategoryFilter` filters text values.\nFor more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilter.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration for a `CategoryFilter`.\n*Required*: Yes\n*Type*: [CategoryFilterConfiguration](./aws-properties-quicksight-analysis-categoryfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilter.html#cfn-quicksight-analysis-categoryfilter-configuration", "UpdateType": "Mutable", "Required": true, "Type": "CategoryFilterConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilter.html#cfn-quicksight-analysis-categoryfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilter.html#cfn-quicksight-analysis-categoryfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilter.html#cfn-quicksight-analysis-categoryfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CategoryFilterConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CategoryFilterConfiguration`\n\nThe configuration for a `CategoryFilter`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilterconfiguration.html", "Properties": { "CustomFilterListConfiguration": { "MarkdownDocumentation": "`CustomFilterListConfiguration`\n\nA list of custom filter values. In the Quick Sight console, this filter type is called a custom filter list.\n*Required*: No\n*Type*: [CustomFilterListConfiguration](./aws-properties-quicksight-analysis-customfilterlistconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilterconfiguration.html#cfn-quicksight-analysis-categoryfilterconfiguration-customfilterlistconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomFilterListConfiguration" }, "CustomFilterConfiguration": { "MarkdownDocumentation": "`CustomFilterConfiguration`\n\nA custom filter that filters based on a single value. This filter can be partially matched.\n*Required*: No\n*Type*: [CustomFilterConfiguration](./aws-properties-quicksight-analysis-customfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilterconfiguration.html#cfn-quicksight-analysis-categoryfilterconfiguration-customfilterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomFilterConfiguration" }, "FilterListConfiguration": { "MarkdownDocumentation": "`FilterListConfiguration`\n\nA list of filter configurations. In the Quick Sight console, this filter type is called a filter list.\n*Required*: No\n*Type*: [FilterListConfiguration](./aws-properties-quicksight-analysis-filterlistconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilterconfiguration.html#cfn-quicksight-analysis-categoryfilterconfiguration-filterlistconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilterListConfiguration" } } }, "AWS::QuickSight::Analysis.CategoryInnerFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CategoryInnerFilter`\n\nA `CategoryInnerFilter` filters text values for the `NestedFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryinnerfilter.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [CategoryFilterConfiguration](./aws-properties-quicksight-analysis-categoryfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryinnerfilter.html#cfn-quicksight-analysis-categoryinnerfilter-configuration", "UpdateType": "Mutable", "Required": true, "Type": "CategoryFilterConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryinnerfilter.html#cfn-quicksight-analysis-categoryinnerfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryinnerfilter.html#cfn-quicksight-analysis-categoryinnerfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" } } }, "AWS::QuickSight::Analysis.ChartAxisLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ChartAxisLabelOptions`\n\nThe label options for an axis on a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-chartaxislabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of an axis label on a chart. Choose one of the following options:\n* `VISIBLE`: Shows the axis.\n* `HIDDEN`: Hides the axis.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-chartaxislabeloptions.html#cfn-quicksight-analysis-chartaxislabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SortIconVisibility": { "MarkdownDocumentation": "`SortIconVisibility`\n\nThe visibility configuration of the sort icon on a chart's axis label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-chartaxislabeloptions.html#cfn-quicksight-analysis-chartaxislabeloptions-sorticonvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AxisLabelOptions": { "MarkdownDocumentation": "`AxisLabelOptions`\n\nThe label options for a chart axis.\n*Required*: No\n*Type*: [Array](./aws-properties-quicksight-analysis-axislabeloptions.html) of [AxisLabelOptions](./aws-properties-quicksight-analysis-axislabeloptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-chartaxislabeloptions.html#cfn-quicksight-analysis-chartaxislabeloptions-axislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AxisLabelOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ClusterMarker": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ClusterMarker`\n\nThe cluster marker that is a part of the cluster marker\nconfiguration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-clustermarker.html", "Properties": { "SimpleClusterMarker": { "MarkdownDocumentation": "`SimpleClusterMarker`\n\nThe simple cluster marker of the cluster marker.\n*Required*: No\n*Type*: [SimpleClusterMarker](./aws-properties-quicksight-analysis-simpleclustermarker.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-clustermarker.html#cfn-quicksight-analysis-clustermarker-simpleclustermarker", "UpdateType": "Mutable", "Required": false, "Type": "SimpleClusterMarker" } } }, "AWS::QuickSight::Analysis.ClusterMarkerConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ClusterMarkerConfiguration`\n\nThe cluster marker configuration of the geospatial map selected point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-clustermarkerconfiguration.html", "Properties": { "ClusterMarker": { "MarkdownDocumentation": "`ClusterMarker`\n\nThe cluster marker that is a part of the cluster marker configuration.\n*Required*: No\n*Type*: [ClusterMarker](./aws-properties-quicksight-analysis-clustermarker.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-clustermarkerconfiguration.html#cfn-quicksight-analysis-clustermarkerconfiguration-clustermarker", "UpdateType": "Mutable", "Required": false, "Type": "ClusterMarker" } } }, "AWS::QuickSight::Analysis.ColorScale": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ColorScale`\n\nDetermines the color scale that is applied to the visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-colorscale.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nDetermines the list of colors that are applied to the visual.\n*Required*: Yes\n*Type*: Array of [DataColor](./aws-properties-quicksight-analysis-datacolor.html)\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-colorscale.html#cfn-quicksight-analysis-colorscale-colors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataColor", "DuplicatesAllowed": true }, "ColorFillType": { "MarkdownDocumentation": "`ColorFillType`\n\nDetermines the color fill type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DISCRETE | GRADIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISCRETE", "GRADIENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-colorscale.html#cfn-quicksight-analysis-colorscale-colorfilltype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NullValueColor": { "MarkdownDocumentation": "`NullValueColor`\n\nDetermines the color that is applied to null values.\n*Required*: No\n*Type*: [DataColor](./aws-properties-quicksight-analysis-datacolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-colorscale.html#cfn-quicksight-analysis-colorscale-nullvaluecolor", "UpdateType": "Mutable", "Required": false, "Type": "DataColor" } } }, "AWS::QuickSight::Analysis.ColorsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ColorsConfiguration`\n\nThe color configurations for a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-colorsconfiguration.html", "Properties": { "CustomColors": { "MarkdownDocumentation": "`CustomColors`\n\nA list of up to 50 custom colors.\n*Required*: No\n*Type*: Array of [CustomColor](./aws-properties-quicksight-analysis-customcolor.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-colorsconfiguration.html#cfn-quicksight-analysis-colorsconfiguration-customcolors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ColumnConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ColumnConfiguration`\n\nThe general configuration of a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnconfiguration.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe role of the column.\n*Required*: No\n*Type*: String\n*Allowed values*: `DIMENSION | MEASURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIMENSION", "MEASURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnconfiguration.html#cfn-quicksight-analysis-columnconfiguration-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of a column.\n*Required*: No\n*Type*: [FormatConfiguration](./aws-properties-quicksight-analysis-formatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnconfiguration.html#cfn-quicksight-analysis-columnconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnconfiguration.html#cfn-quicksight-analysis-columnconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "ColorsConfiguration": { "MarkdownDocumentation": "`ColorsConfiguration`\n\nThe color configurations of the column.\n*Required*: No\n*Type*: [ColorsConfiguration](./aws-properties-quicksight-analysis-colorsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnconfiguration.html#cfn-quicksight-analysis-columnconfiguration-colorsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ColorsConfiguration" } } }, "AWS::QuickSight::Analysis.ColumnHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ColumnHierarchy`\n\nThe option that determines the hierarchy of the fields for a visual element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnhierarchy.html", "Properties": { "DateTimeHierarchy": { "MarkdownDocumentation": "`DateTimeHierarchy`\n\nThe option that determines the hierarchy of any `DateTime` fields.\n*Required*: No\n*Type*: [DateTimeHierarchy](./aws-properties-quicksight-analysis-datetimehierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnhierarchy.html#cfn-quicksight-analysis-columnhierarchy-datetimehierarchy", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeHierarchy" }, "ExplicitHierarchy": { "MarkdownDocumentation": "`ExplicitHierarchy`\n\nThe option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.\n*Required*: No\n*Type*: [ExplicitHierarchy](./aws-properties-quicksight-analysis-explicithierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnhierarchy.html#cfn-quicksight-analysis-columnhierarchy-explicithierarchy", "UpdateType": "Mutable", "Required": false, "Type": "ExplicitHierarchy" }, "PredefinedHierarchy": { "MarkdownDocumentation": "`PredefinedHierarchy`\n\nThe option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.\n*Required*: No\n*Type*: [PredefinedHierarchy](./aws-properties-quicksight-analysis-predefinedhierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnhierarchy.html#cfn-quicksight-analysis-columnhierarchy-predefinedhierarchy", "UpdateType": "Mutable", "Required": false, "Type": "PredefinedHierarchy" } } }, "AWS::QuickSight::Analysis.ColumnIdentifier": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ColumnIdentifier`\n\nA column of a data set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnidentifier.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnidentifier.html#cfn-quicksight-analysis-columnidentifier-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that the column belongs to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnidentifier.html#cfn-quicksight-analysis-columnidentifier-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ColumnSort": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ColumnSort`\n\nThe sort configuration for a column that is not used in a field well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnsort.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function that is defined in the column sort.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-analysis-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnsort.html#cfn-quicksight-analysis-columnsort-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "SortBy": { "MarkdownDocumentation": "`SortBy`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnsort.html#cfn-quicksight-analysis-columnsort-sortby", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe sort direction.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnsort.html#cfn-quicksight-analysis-columnsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ColumnTooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ColumnTooltipItem`\n\nThe tooltip item for the columns that are not part of a field well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columntooltipitem.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nThe aggregation function of the column tooltip item.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-analysis-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columntooltipitem.html#cfn-quicksight-analysis-columntooltipitem-aggregation", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "TooltipTarget": { "MarkdownDocumentation": "`TooltipTarget`\n\nDetermines the target of the column tooltip item in a combo chart visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `BOTH | BAR | LINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BOTH", "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columntooltipitem.html#cfn-quicksight-analysis-columntooltipitem-tooltiptarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe target column of the tooltip item.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columntooltipitem.html#cfn-quicksight-analysis-columntooltipitem-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label of the tooltip item.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columntooltipitem.html#cfn-quicksight-analysis-columntooltipitem-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip item.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columntooltipitem.html#cfn-quicksight-analysis-columntooltipitem-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ComboChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ComboChartAggregatedFieldWells`\n\nThe aggregated field wells of a combo chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartaggregatedfieldwells.html", "Properties": { "BarValues": { "MarkdownDocumentation": "`BarValues`\n\nThe aggregated `BarValues` field well of a combo chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartaggregatedfieldwells.html#cfn-quicksight-analysis-combochartaggregatedfieldwells-barvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe aggregated category field wells of a combo chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartaggregatedfieldwells.html#cfn-quicksight-analysis-combochartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe aggregated colors field well of a combo chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartaggregatedfieldwells.html#cfn-quicksight-analysis-combochartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "LineValues": { "MarkdownDocumentation": "`LineValues`\n\nThe aggregated `LineValues` field well of a combo chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartaggregatedfieldwells.html#cfn-quicksight-analysis-combochartaggregatedfieldwells-linevalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ComboChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ComboChartConfiguration`\n\nThe configuration of a `ComboChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `ComboChartVisual`.\n*Required*: No\n*Type*: [ComboChartSortConfiguration](./aws-properties-quicksight-analysis-combochartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-analysis-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "BarDataLabels": { "MarkdownDocumentation": "`BarDataLabels`\n\nThe options that determine if visual data labels are displayed.\nThe data label options for a bar in a combo chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-bardatalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SingleAxisOptions": { "MarkdownDocumentation": "`SingleAxisOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [SingleAxisOptions](./aws-properties-quicksight-analysis-singleaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-singleaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "SingleAxisOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "BarsArrangement": { "MarkdownDocumentation": "`BarsArrangement`\n\nDetermines the bar arrangement in a combo chart. The following are valid values in this structure:\n* `CLUSTERED`: For clustered bar combo charts.\n* `STACKED`: For stacked bar combo charts.\n* `STACKED_PERCENT`: Do not use. If you use this value, the operation returns a validation error.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLUSTERED | STACKED | STACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLUSTERED", "STACKED", "STACKED_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-barsarrangement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecondaryYAxisLabelOptions": { "MarkdownDocumentation": "`SecondaryYAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-secondaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "LineDataLabels": { "MarkdownDocumentation": "`LineDataLabels`\n\nThe options that determine if visual data labels are displayed.\nThe data label options for a line in a combo chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-linedatalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe category axis of a combo chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [ComboChartFieldWells](./aws-properties-quicksight-analysis-combochartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartFieldWells" }, "SecondaryYAxisDisplayOptions": { "MarkdownDocumentation": "`SecondaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-secondaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartconfiguration.html#cfn-quicksight-analysis-combochartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Analysis.ComboChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ComboChartFieldWells`\n\nThe field wells of the visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartfieldwells.html", "Properties": { "ComboChartAggregatedFieldWells": { "MarkdownDocumentation": "`ComboChartAggregatedFieldWells`\n\nThe aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.\n*Required*: No\n*Type*: [ComboChartAggregatedFieldWells](./aws-properties-quicksight-analysis-combochartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartfieldwells.html#cfn-quicksight-analysis-combochartfieldwells-combochartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.ComboChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ComboChartSortConfiguration`\n\nThe sort configuration of a `ComboChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartsortconfiguration.html", "Properties": { "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe sort configuration of the color field well in a combo chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartsortconfiguration.html#cfn-quicksight-analysis-combochartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe item limit configuration of the color field well in a combo chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartsortconfiguration.html#cfn-quicksight-analysis-combochartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe item limit configuration for the category field well of a combo chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartsortconfiguration.html#cfn-quicksight-analysis-combochartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category field well in a combo chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartsortconfiguration.html#cfn-quicksight-analysis-combochartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ComboChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ComboChartVisual`\n\nA combo chart.\nThe `ComboChartVisual` includes stacked bar combo charts and clustered bar combo charts\nFor more information, see [Using combo charts](https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartvisual.html#cfn-quicksight-analysis-combochartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartvisual.html#cfn-quicksight-analysis-combochartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [ComboChartConfiguration](./aws-properties-quicksight-analysis-combochartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartvisual.html#cfn-quicksight-analysis-combochartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartvisual.html#cfn-quicksight-analysis-combochartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartvisual.html#cfn-quicksight-analysis-combochartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartvisual.html#cfn-quicksight-analysis-combochartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-combochartvisual.html#cfn-quicksight-analysis-combochartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ComparisonConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ComparisonConfiguration`\n\nThe comparison display configuration of a KPI or gauge chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-comparisonconfiguration.html", "Properties": { "ComparisonMethod": { "MarkdownDocumentation": "`ComparisonMethod`\n\nThe method of the comparison. Choose from the following options:\n* `DIFFERENCE`\n* `PERCENT_DIFFERENCE`\n* `PERCENT`\n*Required*: No\n*Type*: String\n*Allowed values*: `DIFFERENCE | PERCENT_DIFFER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIFFERENCE", "PERCENT_DIFFERENCE", "PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-comparisonconfiguration.html#cfn-quicksight-analysis-comparisonconfiguration-comparisonmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComparisonFormat": { "MarkdownDocumentation": "`ComparisonFormat`\n\nThe format of the comparison.\n*Required*: No\n*Type*: [ComparisonFormatConfiguration](./aws-properties-quicksight-analysis-comparisonformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-comparisonconfiguration.html#cfn-quicksight-analysis-comparisonconfiguration-comparisonformat", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonFormatConfiguration" } } }, "AWS::QuickSight::Analysis.ComparisonFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ComparisonFormatConfiguration`\n\nThe format of the comparison.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-comparisonformatconfiguration.html", "Properties": { "NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`NumberDisplayFormatConfiguration`\n\nThe number display format.\n*Required*: No\n*Type*: [NumberDisplayFormatConfiguration](./aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-comparisonformatconfiguration.html#cfn-quicksight-analysis-comparisonformatconfiguration-numberdisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberDisplayFormatConfiguration" }, "PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`PercentageDisplayFormatConfiguration`\n\nThe percentage display format.\n*Required*: No\n*Type*: [PercentageDisplayFormatConfiguration](./aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-comparisonformatconfiguration.html#cfn-quicksight-analysis-comparisonformatconfiguration-percentagedisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PercentageDisplayFormatConfiguration" } } }, "AWS::QuickSight::Analysis.Computation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.Computation`\n\nThe computation union that is used in an insight visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html", "Properties": { "PeriodToDate": { "MarkdownDocumentation": "`PeriodToDate`\n\nThe period to `DataSetIdentifier` computation configuration.\n*Required*: No\n*Type*: [PeriodToDateComputation](./aws-properties-quicksight-analysis-periodtodatecomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-periodtodate", "UpdateType": "Mutable", "Required": false, "Type": "PeriodToDateComputation" }, "GrowthRate": { "MarkdownDocumentation": "`GrowthRate`\n\nThe growth rate computation configuration.\n*Required*: No\n*Type*: [GrowthRateComputation](./aws-properties-quicksight-analysis-growthratecomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-growthrate", "UpdateType": "Mutable", "Required": false, "Type": "GrowthRateComputation" }, "TopBottomRanked": { "MarkdownDocumentation": "`TopBottomRanked`\n\nThe top ranked and bottom ranked computation configuration.\n*Required*: No\n*Type*: [TopBottomRankedComputation](./aws-properties-quicksight-analysis-topbottomrankedcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-topbottomranked", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomRankedComputation" }, "TotalAggregation": { "MarkdownDocumentation": "`TotalAggregation`\n\nThe total aggregation computation configuration.\n*Required*: No\n*Type*: [TotalAggregationComputation](./aws-properties-quicksight-analysis-totalaggregationcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-totalaggregation", "UpdateType": "Mutable", "Required": false, "Type": "TotalAggregationComputation" }, "Forecast": { "MarkdownDocumentation": "`Forecast`\n\nThe forecast computation configuration.\n*Required*: No\n*Type*: [ForecastComputation](./aws-properties-quicksight-analysis-forecastcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-forecast", "UpdateType": "Mutable", "Required": false, "Type": "ForecastComputation" }, "MaximumMinimum": { "MarkdownDocumentation": "`MaximumMinimum`\n\nThe maximum and minimum computation configuration.\n*Required*: No\n*Type*: [MaximumMinimumComputation](./aws-properties-quicksight-analysis-maximumminimumcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-maximumminimum", "UpdateType": "Mutable", "Required": false, "Type": "MaximumMinimumComputation" }, "PeriodOverPeriod": { "MarkdownDocumentation": "`PeriodOverPeriod`\n\nThe period over period computation configuration.\n*Required*: No\n*Type*: [PeriodOverPeriodComputation](./aws-properties-quicksight-analysis-periodoverperiodcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-periodoverperiod", "UpdateType": "Mutable", "Required": false, "Type": "PeriodOverPeriodComputation" }, "MetricComparison": { "MarkdownDocumentation": "`MetricComparison`\n\nThe metric comparison computation configuration.\n*Required*: No\n*Type*: [MetricComparisonComputation](./aws-properties-quicksight-analysis-metriccomparisoncomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-metriccomparison", "UpdateType": "Mutable", "Required": false, "Type": "MetricComparisonComputation" }, "TopBottomMovers": { "MarkdownDocumentation": "`TopBottomMovers`\n\nThe top movers and bottom movers computation configuration.\n*Required*: No\n*Type*: [TopBottomMoversComputation](./aws-properties-quicksight-analysis-topbottommoverscomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-topbottommovers", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomMoversComputation" }, "UniqueValues": { "MarkdownDocumentation": "`UniqueValues`\n\nThe unique values computation configuration.\n*Required*: No\n*Type*: [UniqueValuesComputation](./aws-properties-quicksight-analysis-uniquevaluescomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-computation.html#cfn-quicksight-analysis-computation-uniquevalues", "UpdateType": "Mutable", "Required": false, "Type": "UniqueValuesComputation" } } }, "AWS::QuickSight::Analysis.ConditionalFormattingColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ConditionalFormattingColor`\n\nThe formatting configuration for the color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcolor.html", "Properties": { "Gradient": { "MarkdownDocumentation": "`Gradient`\n\nFormatting configuration for gradient color.\n*Required*: No\n*Type*: [ConditionalFormattingGradientColor](./aws-properties-quicksight-analysis-conditionalformattinggradientcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcolor.html#cfn-quicksight-analysis-conditionalformattingcolor-gradient", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingGradientColor" }, "Solid": { "MarkdownDocumentation": "`Solid`\n\nFormatting configuration for solid color.\n*Required*: No\n*Type*: [ConditionalFormattingSolidColor](./aws-properties-quicksight-analysis-conditionalformattingsolidcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcolor.html#cfn-quicksight-analysis-conditionalformattingcolor-solid", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingSolidColor" } } }, "AWS::QuickSight::Analysis.ConditionalFormattingCustomIconCondition": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ConditionalFormattingCustomIconCondition`\n\nDetermines the custom condition for an icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcustomiconcondition.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the condition of the icon set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcustomiconcondition.html#cfn-quicksight-analysis-conditionalformattingcustomiconcondition-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color of the icon.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcustomiconcondition.html#cfn-quicksight-analysis-conditionalformattingcustomiconcondition-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayConfiguration": { "MarkdownDocumentation": "`DisplayConfiguration`\n\nDetermines the icon display configuration.\n*Required*: No\n*Type*: [ConditionalFormattingIconDisplayConfiguration](./aws-properties-quicksight-analysis-conditionalformattingicondisplayconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcustomiconcondition.html#cfn-quicksight-analysis-conditionalformattingcustomiconcondition-displayconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIconDisplayConfiguration" }, "IconOptions": { "MarkdownDocumentation": "`IconOptions`\n\nCustom icon options for an icon set.\n*Required*: Yes\n*Type*: [ConditionalFormattingCustomIconOptions](./aws-properties-quicksight-analysis-conditionalformattingcustomiconoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcustomiconcondition.html#cfn-quicksight-analysis-conditionalformattingcustomiconcondition-iconoptions", "UpdateType": "Mutable", "Required": true, "Type": "ConditionalFormattingCustomIconOptions" } } }, "AWS::QuickSight::Analysis.ConditionalFormattingCustomIconOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ConditionalFormattingCustomIconOptions`\n\nCustom icon options for an icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcustomiconoptions.html", "Properties": { "UnicodeIcon": { "MarkdownDocumentation": "`UnicodeIcon`\n\nDetermines the Unicode icon type.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000-\\u00FF]$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcustomiconoptions.html#cfn-quicksight-analysis-conditionalformattingcustomiconoptions-unicodeicon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nDetermines the type of icon.\n*Required*: No\n*Type*: String\n*Allowed values*: `CARET_UP | CARET_DOWN | PLU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CARET_UP", "CARET_DOWN", "PLUS", "MINUS", "ARROW_UP", "ARROW_DOWN", "ARROW_LEFT", "ARROW_UP_LEFT", "ARROW_DOWN_LEFT", "ARROW_RIGHT", "ARROW_UP_RIGHT", "ARROW_DOWN_RIGHT", "FACE_UP", "FACE_DOWN", "FACE_FLAT", "ONE_BAR", "TWO_BAR", "THREE_BAR", "CIRCLE", "TRIANGLE", "SQUARE", "FLAG", "THUMBS_UP", "THUMBS_DOWN", "CHECKMARK", "X" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingcustomiconoptions.html#cfn-quicksight-analysis-conditionalformattingcustomiconoptions-icon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ConditionalFormattingGradientColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ConditionalFormattingGradientColor`\n\nFormatting configuration for gradient color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattinggradientcolor.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for gradient color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattinggradientcolor.html#cfn-quicksight-analysis-conditionalformattinggradientcolor-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\n*Required*: Yes\n*Type*: [GradientColor](./aws-properties-quicksight-analysis-gradientcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattinggradientcolor.html#cfn-quicksight-analysis-conditionalformattinggradientcolor-color", "UpdateType": "Mutable", "Required": true, "Type": "GradientColor" } } }, "AWS::QuickSight::Analysis.ConditionalFormattingIcon": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ConditionalFormattingIcon`\n\nThe formatting configuration for the icon.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingicon.html", "Properties": { "CustomCondition": { "MarkdownDocumentation": "`CustomCondition`\n\nDetermines the custom condition for an icon set.\n*Required*: No\n*Type*: [ConditionalFormattingCustomIconCondition](./aws-properties-quicksight-analysis-conditionalformattingcustomiconcondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingicon.html#cfn-quicksight-analysis-conditionalformattingicon-customcondition", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingCustomIconCondition" }, "IconSet": { "MarkdownDocumentation": "`IconSet`\n\nFormatting configuration for icon set.\n*Required*: No\n*Type*: [ConditionalFormattingIconSet](./aws-properties-quicksight-analysis-conditionalformattingiconset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingicon.html#cfn-quicksight-analysis-conditionalformattingicon-iconset", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIconSet" } } }, "AWS::QuickSight::Analysis.ConditionalFormattingIconDisplayConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ConditionalFormattingIconDisplayConfiguration`\n\nDetermines the icon display configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingicondisplayconfiguration.html", "Properties": { "IconDisplayOption": { "MarkdownDocumentation": "`IconDisplayOption`\n\nDetermines the icon display configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `ICON_ONLY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ICON_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingicondisplayconfiguration.html#cfn-quicksight-analysis-conditionalformattingicondisplayconfiguration-icondisplayoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ConditionalFormattingIconSet": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ConditionalFormattingIconSet`\n\nFormatting configuration for icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingiconset.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for the icon set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingiconset.html#cfn-quicksight-analysis-conditionalformattingiconset-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IconSetType": { "MarkdownDocumentation": "`IconSetType`\n\nDetermines the icon set type.\n*Required*: No\n*Type*: String\n*Allowed values*: `PLUS_MINUS | CHECK_X | THRE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PLUS_MINUS", "CHECK_X", "THREE_COLOR_ARROW", "THREE_GRAY_ARROW", "CARET_UP_MINUS_DOWN", "THREE_SHAPE", "THREE_CIRCLE", "FLAGS", "BARS", "FOUR_COLOR_ARROW", "FOUR_GRAY_ARROW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingiconset.html#cfn-quicksight-analysis-conditionalformattingiconset-iconsettype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ConditionalFormattingSolidColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ConditionalFormattingSolidColor`\n\nFormatting configuration for solid color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingsolidcolor.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for solid color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingsolidcolor.html#cfn-quicksight-analysis-conditionalformattingsolidcolor-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-conditionalformattingsolidcolor.html#cfn-quicksight-analysis-conditionalformattingsolidcolor-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ContextMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ContextMenuOption`\n\nThe context menu options for a visual's interactions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-contextmenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availability status of the context menu options. If the value of this property is set to `ENABLED`, dashboard readers can interact with the context menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-contextmenuoption.html#cfn-quicksight-analysis-contextmenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ContributionAnalysisDefault": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ContributionAnalysisDefault`\n\nThe contribution analysis visual display for a line, pie, or bar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-contributionanalysisdefault.html", "Properties": { "MeasureFieldId": { "MarkdownDocumentation": "`MeasureFieldId`\n\nThe measure field that is used in the contribution analysis.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-contributionanalysisdefault.html#cfn-quicksight-analysis-contributionanalysisdefault-measurefieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContributorDimensions": { "MarkdownDocumentation": "`ContributorDimensions`\n\nThe dimensions columns that are used in the contribution analysis,\nusually a list of `ColumnIdentifiers`.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-contributionanalysisdefault.html#cfn-quicksight-analysis-contributionanalysisdefault-contributordimensions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.CurrencyDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CurrencyDisplayFormatConfiguration`\n\nThe options that determine the currency display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-analysis-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html#cfn-quicksight-analysis-currencydisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-analysis-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html#cfn-quicksight-analysis-currencydisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NumberScale": { "MarkdownDocumentation": "`NumberScale`\n\nDetermines the number scale value for the currency format.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AUTO | THOUSANDS | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html#cfn-quicksight-analysis-currencydisplayformatconfiguration-numberscale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-analysis-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html#cfn-quicksight-analysis-currencydisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the currency format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html#cfn-quicksight-analysis-currencydisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-analysis-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html#cfn-quicksight-analysis-currencydisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Symbol": { "MarkdownDocumentation": "`Symbol`\n\nDetermines the symbol for the currency format.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Z]{3}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html#cfn-quicksight-analysis-currencydisplayformatconfiguration-symbol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the currency format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html#cfn-quicksight-analysis-currencydisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CustomActionFilterOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomActionFilterOperation`\n\nThe filter operation that filters data included in a visual or in an entire sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionfilteroperation.html", "Properties": { "SelectedFieldsConfiguration": { "MarkdownDocumentation": "`SelectedFieldsConfiguration`\n\nThe configuration that chooses the fields to be filtered.\n*Required*: Yes\n*Type*: [FilterOperationSelectedFieldsConfiguration](./aws-properties-quicksight-analysis-filteroperationselectedfieldsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionfilteroperation.html#cfn-quicksight-analysis-customactionfilteroperation-selectedfieldsconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterOperationSelectedFieldsConfiguration" }, "TargetVisualsConfiguration": { "MarkdownDocumentation": "`TargetVisualsConfiguration`\n\nThe configuration that chooses the target visuals to be filtered.\n*Required*: Yes\n*Type*: [FilterOperationTargetVisualsConfiguration](./aws-properties-quicksight-analysis-filteroperationtargetvisualsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionfilteroperation.html#cfn-quicksight-analysis-customactionfilteroperation-targetvisualsconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterOperationTargetVisualsConfiguration" } } }, "AWS::QuickSight::Analysis.CustomActionNavigationOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomActionNavigationOperation`\n\nThe navigation operation that navigates between different sheets in the same analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionnavigationoperation.html", "Properties": { "LocalNavigationConfiguration": { "MarkdownDocumentation": "`LocalNavigationConfiguration`\n\nThe configuration that chooses the navigation target.\n*Required*: No\n*Type*: [LocalNavigationConfiguration](./aws-properties-quicksight-analysis-localnavigationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionnavigationoperation.html#cfn-quicksight-analysis-customactionnavigationoperation-localnavigationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LocalNavigationConfiguration" } } }, "AWS::QuickSight::Analysis.CustomActionSetParametersOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomActionSetParametersOperation`\n\nThe set parameter operation that sets parameters in custom action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionsetparametersoperation.html", "Properties": { "ParameterValueConfigurations": { "MarkdownDocumentation": "`ParameterValueConfigurations`\n\nThe parameter that determines the value configuration.\n*Required*: Yes\n*Type*: Array of [SetParameterValueConfiguration](./aws-properties-quicksight-analysis-setparametervalueconfiguration.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionsetparametersoperation.html#cfn-quicksight-analysis-customactionsetparametersoperation-parametervalueconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SetParameterValueConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.CustomActionURLOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomActionURLOperation`\n\nThe URL operation that opens a link to another webpage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionurloperation.html", "Properties": { "URLTemplate": { "MarkdownDocumentation": "`URLTemplate`\n\nTHe URL link of the `CustomActionURLOperation`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionurloperation.html#cfn-quicksight-analysis-customactionurloperation-urltemplate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "URLTarget": { "MarkdownDocumentation": "`URLTarget`\n\nThe target of the `CustomActionURLOperation`.\nValid values are defined as follows:\n* `NEW_TAB`: Opens the target URL in a new browser tab.\n* `NEW_WINDOW`: Opens the target URL in a new browser window.\n* `SAME_TAB`: Opens the target URL in the same browser tab.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW_TAB | NEW_WINDOW | SAME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_TAB", "NEW_WINDOW", "SAME_TAB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customactionurloperation.html#cfn-quicksight-analysis-customactionurloperation-urltarget", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CustomColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomColor`\n\nThe color configurations for a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcolor.html", "Properties": { "Color": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcolor.html#cfn-quicksight-analysis-customcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcolor.html#cfn-quicksight-analysis-customcolor-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpecialValue": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcolor.html#cfn-quicksight-analysis-customcolor-specialvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CustomContentConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomContentConfiguration`\n\nThe configuration of a `CustomContentVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentconfiguration.html", "Properties": { "ContentUrl": { "MarkdownDocumentation": "`ContentUrl`\n\nThe input URL that links to the custom content that you want in the custom visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentconfiguration.html#cfn-quicksight-analysis-customcontentconfiguration-contenturl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe content type of the custom content visual. You can use this to have the visual render as an image.\n*Required*: No\n*Type*: String\n*Allowed values*: `IMAGE | OTHER_EMBEDDED_CONT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IMAGE", "OTHER_EMBEDDED_CONTENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentconfiguration.html#cfn-quicksight-analysis-customcontentconfiguration-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImageScaling": { "MarkdownDocumentation": "`ImageScaling`\n\nThe sizing options for the size of the custom content visual. This structure is required when the `ContentType` of the visual is `'IMAGE'`.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIT_TO_HEIGHT | FIT_TO_WIDT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIT_TO_HEIGHT", "FIT_TO_WIDTH", "DO_NOT_SCALE", "SCALE_TO_VISUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentconfiguration.html#cfn-quicksight-analysis-customcontentconfiguration-imagescaling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentconfiguration.html#cfn-quicksight-analysis-customcontentconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Analysis.CustomContentVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomContentVisual`\n\nA visual that contains custom content.\nFor more information, see [Using custom visual content](https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentvisual.html#cfn-quicksight-analysis-customcontentvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentvisual.html#cfn-quicksight-analysis-customcontentvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `CustomContentVisual`.\n*Required*: No\n*Type*: [CustomContentConfiguration](./aws-properties-quicksight-analysis-customcontentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentvisual.html#cfn-quicksight-analysis-customcontentvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomContentConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentvisual.html#cfn-quicksight-analysis-customcontentvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe dataset that is used to create the custom content visual. You can't create a visual without a dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentvisual.html#cfn-quicksight-analysis-customcontentvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentvisual.html#cfn-quicksight-analysis-customcontentvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customcontentvisual.html#cfn-quicksight-analysis-customcontentvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CustomFilterConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomFilterConfiguration`\n\nA custom filter that filters based on a single value. This filter can be partially matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterconfiguration.html", "Properties": { "CategoryValue": { "MarkdownDocumentation": "`CategoryValue`\n\nThe category value for the filter.\nThis field is mutually exclusive to `ParameterName`.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterconfiguration.html#cfn-quicksight-analysis-customfilterconfiguration-categoryvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\nThis field is mutually exclusive to `CategoryValue`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterconfiguration.html#cfn-quicksight-analysis-customfilterconfiguration-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterconfiguration.html#cfn-quicksight-analysis-customfilterconfiguration-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterconfiguration.html#cfn-quicksight-analysis-customfilterconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterconfiguration.html#cfn-quicksight-analysis-customfilterconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CustomFilterListConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomFilterListConfiguration`\n\nA list of custom filter values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterlistconfiguration.html", "Properties": { "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nThe list of category values for the filter.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterlistconfiguration.html#cfn-quicksight-analysis-customfilterlistconfiguration-categoryvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterlistconfiguration.html#cfn-quicksight-analysis-customfilterlistconfiguration-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterlistconfiguration.html#cfn-quicksight-analysis-customfilterlistconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customfilterlistconfiguration.html#cfn-quicksight-analysis-customfilterlistconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CustomNarrativeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomNarrativeOptions`\n\nThe custom narrative options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customnarrativeoptions.html", "Properties": { "Narrative": { "MarkdownDocumentation": "`Narrative`\n\nThe string input of custom narrative.\n*Required*: Yes\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `150000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customnarrativeoptions.html#cfn-quicksight-analysis-customnarrativeoptions-narrative", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.CustomParameterValues": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomParameterValues`\n\nThe customized parameter values.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customparametervalues.html", "Properties": { "DecimalValues": { "MarkdownDocumentation": "`DecimalValues`\n\nA list of decimal-type parameter values.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customparametervalues.html#cfn-quicksight-analysis-customparametervalues-decimalvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "IntegerValues": { "MarkdownDocumentation": "`IntegerValues`\n\nA list of integer-type parameter values.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customparametervalues.html#cfn-quicksight-analysis-customparametervalues-integervalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "StringValues": { "MarkdownDocumentation": "`StringValues`\n\nA list of string-type parameter values.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customparametervalues.html#cfn-quicksight-analysis-customparametervalues-stringvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DateTimeValues": { "MarkdownDocumentation": "`DateTimeValues`\n\nA list of datetime-type parameter values.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customparametervalues.html#cfn-quicksight-analysis-customparametervalues-datetimevalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.CustomValuesConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.CustomValuesConfiguration`\n\nThe configuration of custom values for the destination parameter in `DestinationParameterValueConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customvaluesconfiguration.html", "Properties": { "IncludeNullValue": { "MarkdownDocumentation": "`IncludeNullValue`\n\nIncludes the null value in custom action parameter values.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customvaluesconfiguration.html#cfn-quicksight-analysis-customvaluesconfiguration-includenullvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CustomValues": { "MarkdownDocumentation": "`CustomValues`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [CustomParameterValues](./aws-properties-quicksight-analysis-customparametervalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-customvaluesconfiguration.html#cfn-quicksight-analysis-customvaluesconfiguration-customvalues", "UpdateType": "Mutable", "Required": true, "Type": "CustomParameterValues" } } }, "AWS::QuickSight::Analysis.DataBarsOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataBarsOptions`\n\nThe options for data bars.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-databarsoptions.html", "Properties": { "PositiveColor": { "MarkdownDocumentation": "`PositiveColor`\n\nThe color of the positive data bar.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-databarsoptions.html#cfn-quicksight-analysis-databarsoptions-positivecolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for the data bars options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-databarsoptions.html#cfn-quicksight-analysis-databarsoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NegativeColor": { "MarkdownDocumentation": "`NegativeColor`\n\nThe color of the negative data bar.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-databarsoptions.html#cfn-quicksight-analysis-databarsoptions-negativecolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DataColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataColor`\n\nDetermines the color that is applied to a particular data value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datacolor.html", "Properties": { "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nThe data value that the color is applied to.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datacolor.html#cfn-quicksight-analysis-datacolor-datavalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that is applied to the data value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datacolor.html#cfn-quicksight-analysis-datacolor-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DataFieldSeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataFieldSeriesItem`\n\nThe data field series item configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datafieldseriesitem.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that you are setting the axis binding to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datafieldseriesitem.html#cfn-quicksight-analysis-datafieldseriesitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis that you are binding the field to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datafieldseriesitem.html#cfn-quicksight-analysis-datafieldseriesitem-axisbinding", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe field value of the field that you are setting the axis binding 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datafieldseriesitem.html#cfn-quicksight-analysis-datafieldseriesitem-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nThe options that determine the presentation of line series associated to the field.\n*Required*: No\n*Type*: [LineChartSeriesSettings](./aws-properties-quicksight-analysis-linechartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datafieldseriesitem.html#cfn-quicksight-analysis-datafieldseriesitem-settings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSeriesSettings" } } }, "AWS::QuickSight::Analysis.DataLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html", "Properties": { "DataLabelTypes": { "MarkdownDocumentation": "`DataLabelTypes`\n\nThe option that determines the data label type.\n*Required*: No\n*Type*: Array of [DataLabelType](./aws-properties-quicksight-analysis-datalabeltype.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-datalabeltypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataLabelType", "DuplicatesAllowed": true }, "MeasureLabelVisibility": { "MarkdownDocumentation": "`MeasureLabelVisibility`\n\nDetermines the visibility of the measure field labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-measurelabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nDetermines the position of the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSIDE | OUTSIDE | LEFT | T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSIDE", "OUTSIDE", "LEFT", "TOP", "BOTTOM", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelContent": { "MarkdownDocumentation": "`LabelContent`\n\nDetermines the content of the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `VALUE | PERCENT | VALUE_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VALUE", "PERCENT", "VALUE_AND_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-labelcontent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nDetermines the visibility of the total.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Overlap": { "MarkdownDocumentation": "`Overlap`\n\nDetermines whether overlap is enabled or disabled for the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLE_OVERLAP | ENABLE_OV...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLE_OVERLAP", "ENABLE_OVERLAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-overlap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryLabelVisibility": { "MarkdownDocumentation": "`CategoryLabelVisibility`\n\nDetermines the visibility of the category field labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-categorylabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelColor": { "MarkdownDocumentation": "`LabelColor`\n\nDetermines the color of the data labels.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-labelcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelFontConfiguration": { "MarkdownDocumentation": "`LabelFontConfiguration`\n\nDetermines the font configuration of the data labels.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeloptions.html#cfn-quicksight-analysis-datalabeloptions-labelfontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Analysis.DataLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataLabelType`\n\nThe option that determines the data label type.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeltype.html", "Properties": { "MaximumLabelType": { "MarkdownDocumentation": "`MaximumLabelType`\n\nDetermines the label configuration for the maximum value in a visual.\n*Required*: No\n*Type*: [MaximumLabelType](./aws-properties-quicksight-analysis-maximumlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeltype.html#cfn-quicksight-analysis-datalabeltype-maximumlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "MaximumLabelType" }, "DataPathLabelType": { "MarkdownDocumentation": "`DataPathLabelType`\n\nThe option that specifies individual data values for labels.\n*Required*: No\n*Type*: [DataPathLabelType](./aws-properties-quicksight-analysis-datapathlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeltype.html#cfn-quicksight-analysis-datalabeltype-datapathlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "DataPathLabelType" }, "RangeEndsLabelType": { "MarkdownDocumentation": "`RangeEndsLabelType`\n\nDetermines the label configuration for range end value in a visual.\n*Required*: No\n*Type*: [RangeEndsLabelType](./aws-properties-quicksight-analysis-rangeendslabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeltype.html#cfn-quicksight-analysis-datalabeltype-rangeendslabeltype", "UpdateType": "Mutable", "Required": false, "Type": "RangeEndsLabelType" }, "FieldLabelType": { "MarkdownDocumentation": "`FieldLabelType`\n\nDetermines the label configuration for the entire field.\n*Required*: No\n*Type*: [FieldLabelType](./aws-properties-quicksight-analysis-fieldlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeltype.html#cfn-quicksight-analysis-datalabeltype-fieldlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "FieldLabelType" }, "MinimumLabelType": { "MarkdownDocumentation": "`MinimumLabelType`\n\nDetermines the label configuration for the minimum value in a visual.\n*Required*: No\n*Type*: [MinimumLabelType](./aws-properties-quicksight-analysis-minimumlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datalabeltype.html#cfn-quicksight-analysis-datalabeltype-minimumlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "MinimumLabelType" } } }, "AWS::QuickSight::Analysis.DataPathColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataPathColor`\n\nThe color map that determines the color options for a particular element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathcolor.html", "Properties": { "Element": { "MarkdownDocumentation": "`Element`\n\nThe element that the color needs to be applied to.\n*Required*: Yes\n*Type*: [DataPathValue](./aws-properties-quicksight-analysis-datapathvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathcolor.html#cfn-quicksight-analysis-datapathcolor-element", "UpdateType": "Mutable", "Required": true, "Type": "DataPathValue" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that needs to be applied to the element.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathcolor.html#cfn-quicksight-analysis-datapathcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe time granularity of the field that the color needs to be applied to.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathcolor.html#cfn-quicksight-analysis-datapathcolor-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DataPathLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataPathLabelType`\n\nThe option that specifies individual data values for labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathlabeltype.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that the data label needs to be applied to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathlabeltype.html#cfn-quicksight-analysis-datapathlabeltype-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the data label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathlabeltype.html#cfn-quicksight-analysis-datapathlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe actual value of the field that is labeled.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathlabeltype.html#cfn-quicksight-analysis-datapathlabeltype-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DataPathSort": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataPathSort`\n\nAllows data paths to be sorted by a specific data value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathsort.html", "Properties": { "SortPaths": { "MarkdownDocumentation": "`SortPaths`\n\nThe list of data paths that need to be sorted.\n*Required*: Yes\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-analysis-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathsort.html#cfn-quicksight-analysis-datapathsort-sortpaths", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nDetermines the sort direction.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathsort.html#cfn-quicksight-analysis-datapathsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DataPathType": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataPathType`\n\nThe type of the data path value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathtype.html", "Properties": { "PivotTableDataPathType": { "MarkdownDocumentation": "`PivotTableDataPathType`\n\nThe type of data path value utilized in a pivot table. Choose one of the following options:\n* `HIERARCHY_ROWS_LAYOUT_COLUMN` - The type of data path for the rows layout column, when `RowsLayout` is set to `HIERARCHY`.\n* `MULTIPLE_ROW_METRICS_COLUMN` - The type of data path for the metric column when the row is set to Metric Placement.\n* `EMPTY_COLUMN_HEADER` - The type of data path for the column with empty column header, when there is no field in `ColumnsFieldWell` and the row is set to Metric Placement.\n* `COUNT_METRIC_COLUMN` - The type of data path for the column with `COUNT` as the metric, when there is no field in the `ValuesFieldWell`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIERARCHY_ROWS_LAYOUT_COLUM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIERARCHY_ROWS_LAYOUT_COLUMN", "MULTIPLE_ROW_METRICS_COLUMN", "EMPTY_COLUMN_HEADER", "COUNT_METRIC_COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathtype.html#cfn-quicksight-analysis-datapathtype-pivottabledatapathtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DataPathValue": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataPathValue`\n\nThe data path that needs to be sorted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathvalue.html", "Properties": { "DataPathType": { "MarkdownDocumentation": "`DataPathType`\n\nThe type configuration of the field.\n*Required*: No\n*Type*: [DataPathType](./aws-properties-quicksight-analysis-datapathtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathvalue.html#cfn-quicksight-analysis-datapathvalue-datapathtype", "UpdateType": "Mutable", "Required": false, "Type": "DataPathType" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that needs to be sorted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathvalue.html#cfn-quicksight-analysis-datapathvalue-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe actual value of the field that needs to be sorted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathvalue.html#cfn-quicksight-analysis-datapathvalue-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DataSetIdentifierDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataSetIdentifierDeclaration`\n\nA data set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetidentifierdeclaration.html", "Properties": { "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nThe identifier of the data set, typically the data set's name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetidentifierdeclaration.html#cfn-quicksight-analysis-datasetidentifierdeclaration-identifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetArn": { "MarkdownDocumentation": "`DataSetArn`\n\nThe Amazon Resource Name (ARN) of the data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetidentifierdeclaration.html#cfn-quicksight-analysis-datasetidentifierdeclaration-datasetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DataSetReference": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DataSetReference`\n\nDataset reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.html", "Properties": { "DataSetArn": { "MarkdownDocumentation": "`DataSetArn`\n\nDataset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.html#cfn-quicksight-analysis-datasetreference-datasetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetPlaceholder": { "MarkdownDocumentation": "`DataSetPlaceholder`\n\nDataset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.html#cfn-quicksight-analysis-datasetreference-datasetplaceholder", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DateAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateAxisOptions`\n\nThe options that determine how a date axis is displayed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dateaxisoptions.html", "Properties": { "MissingDateVisibility": { "MarkdownDocumentation": "`MissingDateVisibility`\n\nDetermines whether or not missing dates are displayed.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dateaxisoptions.html#cfn-quicksight-analysis-dateaxisoptions-missingdatevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DateDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateDimensionField`\n\nThe dimension type field with date type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datedimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datedimensionfield.html#cfn-quicksight-analysis-datedimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-analysis-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datedimensionfield.html#cfn-quicksight-analysis-datedimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `DateDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datedimensionfield.html#cfn-quicksight-analysis-datedimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datedimensionfield.html#cfn-quicksight-analysis-datedimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DateGranularity": { "MarkdownDocumentation": "`DateGranularity`\n\nThe date granularity of the `DateDimensionField`. Choose one of the following options:\n* `YEAR`\n* `QUARTER`\n* `MONTH`\n* `WEEK`\n* `DAY`\n* `HOUR`\n* `MINUTE`\n* `SECOND`\n* `MILLISECOND`\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datedimensionfield.html#cfn-quicksight-analysis-datedimensionfield-dategranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DateMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateMeasureField`\n\nThe measure type field with date type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datemeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [String](./aws-properties-quicksight-analysis-aggregationfunction.html)\n*Allowed values*: `COUNT | DISTINCT_COUNT | MI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT", "MIN", "MAX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datemeasurefield.html#cfn-quicksight-analysis-datemeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-analysis-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datemeasurefield.html#cfn-quicksight-analysis-datemeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `DateMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datemeasurefield.html#cfn-quicksight-analysis-datemeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datemeasurefield.html#cfn-quicksight-analysis-datemeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DateTimeDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateTimeDefaultValues`\n\nThe default values of the `DateTimeParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimedefaultvalues.html", "Properties": { "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date of the `DataTimeDefaultValues`. The date is determined from the dataset based on input expression.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-analysis-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimedefaultvalues.html#cfn-quicksight-analysis-datetimedefaultvalues-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `DataTimeDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-analysis-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimedefaultvalues.html#cfn-quicksight-analysis-datetimedefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DataTimeDefaultValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimedefaultvalues.html#cfn-quicksight-analysis-datetimedefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.DateTimeFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateTimeFormatConfiguration`\n\nFormatting configuration for `DateTime` fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeformatconfiguration.html", "Properties": { "NumericFormatConfiguration": { "MarkdownDocumentation": "`NumericFormatConfiguration`\n\nThe formatting configuration for numeric `DateTime` fields.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-analysis-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeformatconfiguration.html#cfn-quicksight-analysis-datetimeformatconfiguration-numericformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-analysis-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeformatconfiguration.html#cfn-quicksight-analysis-datetimeformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nDetermines the `DateTime` format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeformatconfiguration.html#cfn-quicksight-analysis-datetimeformatconfiguration-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DateTimeHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateTimeHierarchy`\n\nThe option that determines the hierarchy of any `DateTime` fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimehierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the `DateTime` hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimehierarchy.html#cfn-quicksight-analysis-datetimehierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the\n`DateTime` hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-analysis-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimehierarchy.html#cfn-quicksight-analysis-datetimehierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.DateTimeParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateTimeParameter`\n\nA date-time parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values for the date-time parameter.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameter.html#cfn-quicksight-analysis-datetimeparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the date-time 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameter.html#cfn-quicksight-analysis-datetimeparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DateTimeParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateTimeParameterDeclaration`\n\nA parameter declaration for the `DateTime` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-analysis-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameterdeclaration.html#cfn-quicksight-analysis-datetimeparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [DateTimeDefaultValues](./aws-properties-quicksight-analysis-datetimedefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameterdeclaration.html#cfn-quicksight-analysis-datetimeparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeDefaultValues" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameterdeclaration.html#cfn-quicksight-analysis-datetimeparameterdeclaration-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `DateTime` parameter when a value has not been set.\n*Required*: No\n*Type*: [DateTimeValueWhenUnsetConfiguration](./aws-properties-quicksight-analysis-datetimevaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameterdeclaration.html#cfn-quicksight-analysis-datetimeparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameterdeclaration.html#cfn-quicksight-analysis-datetimeparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DateTimePickerControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateTimePickerControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html#cfn-quicksight-analysis-datetimepickercontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html#cfn-quicksight-analysis-datetimepickercontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" }, "HelperTextVisibility": { "MarkdownDocumentation": "`HelperTextVisibility`\n\nThe helper text visibility of the `DateTimePickerControlDisplayOptions`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html#cfn-quicksight-analysis-datetimepickercontroldisplayoptions-helpertextvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DateIconVisibility": { "MarkdownDocumentation": "`DateIconVisibility`\n\nThe date icon visibility of the `DateTimePickerControlDisplayOptions`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html#cfn-quicksight-analysis-datetimepickercontroldisplayoptions-dateiconvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nCustomize how dates are formatted in controls.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html#cfn-quicksight-analysis-datetimepickercontroldisplayoptions-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DateTimeValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DateTimeValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `DateTime` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimevaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-analysis-datetimevaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-analysis-datetimevaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DecimalDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DecimalDefaultValues`\n\nThe default values of the `DecimalParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimaldefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `DecimalDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-analysis-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimaldefaultvalues.html#cfn-quicksight-analysis-decimaldefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DecimalDefaultValues`.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimaldefaultvalues.html#cfn-quicksight-analysis-decimaldefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.DecimalParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DecimalParameter`\n\nA decimal parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values for the decimal parameter.\n*Required*: Yes\n*Type*: Array of Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameter.html#cfn-quicksight-analysis-decimalparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the decimal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameter.html#cfn-quicksight-analysis-decimalparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DecimalParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DecimalParameterDeclaration`\n\nA parameter declaration for the `Decimal` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-analysis-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameterdeclaration.html#cfn-quicksight-analysis-decimalparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [DecimalDefaultValues](./aws-properties-quicksight-analysis-decimaldefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameterdeclaration.html#cfn-quicksight-analysis-decimalparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "DecimalDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameterdeclaration.html#cfn-quicksight-analysis-decimalparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `Decimal` parameter when a value has not been set.\n*Required*: No\n*Type*: [DecimalValueWhenUnsetConfiguration](./aws-properties-quicksight-analysis-decimalvaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameterdeclaration.html#cfn-quicksight-analysis-decimalparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "DecimalValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameterdeclaration.html#cfn-quicksight-analysis-decimalparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DecimalPlacesConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalplacesconfiguration.html", "Properties": { "DecimalPlaces": { "MarkdownDocumentation": "`DecimalPlaces`\n\nThe values of the decimal places.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalplacesconfiguration.html#cfn-quicksight-analysis-decimalplacesconfiguration-decimalplaces", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.DecimalValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DecimalValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `Decimal` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalvaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-analysis-decimalvaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't set.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-analysis-decimalvaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.DefaultDateTimePickerControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultDateTimePickerControlOptions`\n\nThe default options that correspond to the filter control type of a `DateTimePicker`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultdatetimepickercontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe date time picker type of the `DefaultDateTimePickerControlOptions`. Choose one of the following options:\n* `SINGLE_VALUED`: The filter condition is a fixed date.\n* `DATE_RANGE`: The filter condition is a date time range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_VALUED | DATE_RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_VALUED", "DATE_RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultdatetimepickercontroloptions.html#cfn-quicksight-analysis-defaultdatetimepickercontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultdatetimepickercontroloptions.html#cfn-quicksight-analysis-defaultdatetimepickercontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `DateTimePickerControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultdatetimepickercontroloptions.html#cfn-quicksight-analysis-defaultdatetimepickercontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultFilterControlConfiguration`\n\nThe default configuration for all dependent controls of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html", "Properties": { "ControlOptions": { "MarkdownDocumentation": "`ControlOptions`\n\nThe control option for the `DefaultFilterControlConfiguration`.\n*Required*: Yes\n*Type*: [DefaultFilterControlOptions](./aws-properties-quicksight-analysis-defaultfiltercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html#cfn-quicksight-analysis-defaultfiltercontrolconfiguration-controloptions", "UpdateType": "Mutable", "Required": true, "Type": "DefaultFilterControlOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `DefaultFilterControlConfiguration`. This title is shared by all controls that are tied to this filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html#cfn-quicksight-analysis-defaultfiltercontrolconfiguration-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DefaultFilterControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultFilterControlOptions`\n\nThe option that corresponds to the control type of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontroloptions.html", "Properties": { "DefaultSliderOptions": { "MarkdownDocumentation": "`DefaultSliderOptions`\n\nThe default options that correspond to the `Slider` filter control type.\n*Required*: No\n*Type*: [DefaultSliderControlOptions](./aws-properties-quicksight-analysis-defaultslidercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontroloptions.html#cfn-quicksight-analysis-defaultfiltercontroloptions-defaultslideroptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSliderControlOptions" }, "DefaultRelativeDateTimeOptions": { "MarkdownDocumentation": "`DefaultRelativeDateTimeOptions`\n\nThe default options that correspond to the `RelativeDateTime` filter control type.\n*Required*: No\n*Type*: [DefaultRelativeDateTimeControlOptions](./aws-properties-quicksight-analysis-defaultrelativedatetimecontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontroloptions.html#cfn-quicksight-analysis-defaultfiltercontroloptions-defaultrelativedatetimeoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultRelativeDateTimeControlOptions" }, "DefaultTextFieldOptions": { "MarkdownDocumentation": "`DefaultTextFieldOptions`\n\nThe default options that correspond to the `TextField` filter control type.\n*Required*: No\n*Type*: [DefaultTextFieldControlOptions](./aws-properties-quicksight-analysis-defaulttextfieldcontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontroloptions.html#cfn-quicksight-analysis-defaultfiltercontroloptions-defaulttextfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultTextFieldControlOptions" }, "DefaultTextAreaOptions": { "MarkdownDocumentation": "`DefaultTextAreaOptions`\n\nThe default options that correspond to the `TextArea` filter control type.\n*Required*: No\n*Type*: [DefaultTextAreaControlOptions](./aws-properties-quicksight-analysis-defaulttextareacontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontroloptions.html#cfn-quicksight-analysis-defaultfiltercontroloptions-defaulttextareaoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultTextAreaControlOptions" }, "DefaultDropdownOptions": { "MarkdownDocumentation": "`DefaultDropdownOptions`\n\nThe default options that correspond to the `Dropdown` filter control type.\n*Required*: No\n*Type*: [DefaultFilterDropDownControlOptions](./aws-properties-quicksight-analysis-defaultfilterdropdowncontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontroloptions.html#cfn-quicksight-analysis-defaultfiltercontroloptions-defaultdropdownoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterDropDownControlOptions" }, "DefaultDateTimePickerOptions": { "MarkdownDocumentation": "`DefaultDateTimePickerOptions`\n\nThe default options that correspond to the filter control type of a `DateTimePicker`.\n*Required*: No\n*Type*: [DefaultDateTimePickerControlOptions](./aws-properties-quicksight-analysis-defaultdatetimepickercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontroloptions.html#cfn-quicksight-analysis-defaultfiltercontroloptions-defaultdatetimepickeroptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultDateTimePickerControlOptions" }, "DefaultListOptions": { "MarkdownDocumentation": "`DefaultListOptions`\n\nThe default options that correspond to the `List` filter control type.\n*Required*: No\n*Type*: [DefaultFilterListControlOptions](./aws-properties-quicksight-analysis-defaultfilterlistcontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfiltercontroloptions.html#cfn-quicksight-analysis-defaultfiltercontroloptions-defaultlistoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterListControlOptions" } } }, "AWS::QuickSight::Analysis.DefaultFilterDropDownControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultFilterDropDownControlOptions`\n\nThe default options that correspond to the `Dropdown` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterdropdowncontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterdropdowncontroloptions.html#cfn-quicksight-analysis-defaultfilterdropdowncontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-analysis-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterdropdowncontroloptions.html#cfn-quicksight-analysis-defaultfilterdropdowncontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterdropdowncontroloptions.html#cfn-quicksight-analysis-defaultfilterdropdowncontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-analysis-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterdropdowncontroloptions.html#cfn-quicksight-analysis-defaultfilterdropdowncontroloptions-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Analysis.DefaultFilterListControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultFilterListControlOptions`\n\nThe default options that correspond to the `List` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterlistcontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `DefaultFilterListControlOptions`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from the list.\n* `SINGLE_SELECT`: The user can select a single entry from the list.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterlistcontroloptions.html#cfn-quicksight-analysis-defaultfilterlistcontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-analysis-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterlistcontroloptions.html#cfn-quicksight-analysis-defaultfilterlistcontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-analysis-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfilterlistcontroloptions.html#cfn-quicksight-analysis-defaultfilterlistcontroloptions-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Analysis.DefaultFreeFormLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultFreeFormLayoutConfiguration`\n\nThe options that determine the default settings of a free-form layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfreeformlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a free-form layout.\n*Required*: Yes\n*Type*: [FreeFormLayoutCanvasSizeOptions](./aws-properties-quicksight-analysis-freeformlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultfreeformlayoutconfiguration.html#cfn-quicksight-analysis-defaultfreeformlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "FreeFormLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Analysis.DefaultGridLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultGridLayoutConfiguration`\n\nThe options that determine the default settings for a grid layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultgridlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a grid layout.\n*Required*: Yes\n*Type*: [GridLayoutCanvasSizeOptions](./aws-properties-quicksight-analysis-gridlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultgridlayoutconfiguration.html#cfn-quicksight-analysis-defaultgridlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "GridLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Analysis.DefaultInteractiveLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultInteractiveLayoutConfiguration`\n\nThe options that determine the default settings for interactive layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultinteractivelayoutconfiguration.html", "Properties": { "FreeForm": { "MarkdownDocumentation": "`FreeForm`\n\nThe options that determine the default settings of a free-form layout configuration.\n*Required*: No\n*Type*: [DefaultFreeFormLayoutConfiguration](./aws-properties-quicksight-analysis-defaultfreeformlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultinteractivelayoutconfiguration.html#cfn-quicksight-analysis-defaultinteractivelayoutconfiguration-freeform", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFreeFormLayoutConfiguration" }, "Grid": { "MarkdownDocumentation": "`Grid`\n\nThe options that determine the default settings for a grid layout configuration.\n*Required*: No\n*Type*: [DefaultGridLayoutConfiguration](./aws-properties-quicksight-analysis-defaultgridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultinteractivelayoutconfiguration.html#cfn-quicksight-analysis-defaultinteractivelayoutconfiguration-grid", "UpdateType": "Mutable", "Required": false, "Type": "DefaultGridLayoutConfiguration" } } }, "AWS::QuickSight::Analysis.DefaultNewSheetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultNewSheetConfiguration`\n\nThe configuration for default new sheet settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultnewsheetconfiguration.html", "Properties": { "SheetContentType": { "MarkdownDocumentation": "`SheetContentType`\n\nThe option that determines the sheet content type.\n*Required*: No\n*Type*: String\n*Allowed values*: `PAGINATED | INTERACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PAGINATED", "INTERACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultnewsheetconfiguration.html#cfn-quicksight-analysis-defaultnewsheetconfiguration-sheetcontenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InteractiveLayoutConfiguration": { "MarkdownDocumentation": "`InteractiveLayoutConfiguration`\n\nThe options that determine the default settings for interactive layout configuration.\n*Required*: No\n*Type*: [DefaultInteractiveLayoutConfiguration](./aws-properties-quicksight-analysis-defaultinteractivelayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultnewsheetconfiguration.html#cfn-quicksight-analysis-defaultnewsheetconfiguration-interactivelayoutconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultInteractiveLayoutConfiguration" }, "PaginatedLayoutConfiguration": { "MarkdownDocumentation": "`PaginatedLayoutConfiguration`\n\nThe options that determine the default settings for a paginated layout configuration.\n*Required*: No\n*Type*: [DefaultPaginatedLayoutConfiguration](./aws-properties-quicksight-analysis-defaultpaginatedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultnewsheetconfiguration.html#cfn-quicksight-analysis-defaultnewsheetconfiguration-paginatedlayoutconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultPaginatedLayoutConfiguration" } } }, "AWS::QuickSight::Analysis.DefaultPaginatedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultPaginatedLayoutConfiguration`\n\nThe options that determine the default settings for a paginated layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultpaginatedlayoutconfiguration.html", "Properties": { "SectionBased": { "MarkdownDocumentation": "`SectionBased`\n\nThe options that determine the default settings for a section-based layout configuration.\n*Required*: No\n*Type*: [DefaultSectionBasedLayoutConfiguration](./aws-properties-quicksight-analysis-defaultsectionbasedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultpaginatedlayoutconfiguration.html#cfn-quicksight-analysis-defaultpaginatedlayoutconfiguration-sectionbased", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSectionBasedLayoutConfiguration" } } }, "AWS::QuickSight::Analysis.DefaultRelativeDateTimeControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultRelativeDateTimeControlOptions`\n\nThe default options that correspond to the `RelativeDateTime` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultrelativedatetimecontroloptions.html", "Properties": { "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [RelativeDateTimeControlDisplayOptions](./aws-properties-quicksight-analysis-relativedatetimecontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultrelativedatetimecontroloptions.html#cfn-quicksight-analysis-defaultrelativedatetimecontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDateTimeControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `RelativeDateTimeControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultrelativedatetimecontroloptions.html#cfn-quicksight-analysis-defaultrelativedatetimecontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DefaultSectionBasedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultSectionBasedLayoutConfiguration`\n\nThe options that determine the default settings for a section-based layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultsectionbasedlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a section-based layout.\n*Required*: Yes\n*Type*: [SectionBasedLayoutCanvasSizeOptions](./aws-properties-quicksight-analysis-sectionbasedlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultsectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-defaultsectionbasedlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "SectionBasedLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Analysis.DefaultSliderControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultSliderControlOptions`\n\nThe default options that correspond to the `Slider` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultslidercontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `DefaultSliderControlOptions`. Choose one of the following options:\n* `SINGLE_POINT`: Filter against(equals) a single data point.\n* `RANGE`: Filter data that is in a specified range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_POINT | RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_POINT", "RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultslidercontroloptions.html#cfn-quicksight-analysis-defaultslidercontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultslidercontroloptions.html#cfn-quicksight-analysis-defaultslidercontroloptions-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-analysis-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultslidercontroloptions.html#cfn-quicksight-analysis-defaultslidercontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultslidercontroloptions.html#cfn-quicksight-analysis-defaultslidercontroloptions-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaultslidercontroloptions.html#cfn-quicksight-analysis-defaultslidercontroloptions-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.DefaultTextAreaControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultTextAreaControlOptions`\n\nThe default options that correspond to the `TextArea` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaulttextareacontroloptions.html", "Properties": { "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaulttextareacontroloptions.html#cfn-quicksight-analysis-defaulttextareacontroloptions-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-analysis-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaulttextareacontroloptions.html#cfn-quicksight-analysis-defaulttextareacontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" } } }, "AWS::QuickSight::Analysis.DefaultTextFieldControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DefaultTextFieldControlOptions`\n\nThe default options that correspond to the `TextField` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaulttextfieldcontroloptions.html", "Properties": { "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-analysis-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-defaulttextfieldcontroloptions.html#cfn-quicksight-analysis-defaulttextfieldcontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" } } }, "AWS::QuickSight::Analysis.DestinationParameterValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DestinationParameterValueConfiguration`\n\nThe configuration of destination parameter values.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-destinationparametervalueconfiguration.html", "Properties": { "CustomValuesConfiguration": { "MarkdownDocumentation": "`CustomValuesConfiguration`\n\nThe configuration of custom values for destination parameter in `DestinationParameterValueConfiguration`.\n*Required*: No\n*Type*: [CustomValuesConfiguration](./aws-properties-quicksight-analysis-customvaluesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-destinationparametervalueconfiguration.html#cfn-quicksight-analysis-destinationparametervalueconfiguration-customvaluesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomValuesConfiguration" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the destination parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-destinationparametervalueconfiguration.html#cfn-quicksight-analysis-destinationparametervalueconfiguration-sourceparametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectAllValueOptions": { "MarkdownDocumentation": "`SelectAllValueOptions`\n\nThe configuration that selects all options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VALUES`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-destinationparametervalueconfiguration.html#cfn-quicksight-analysis-destinationparametervalueconfiguration-selectallvalueoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceField": { "MarkdownDocumentation": "`SourceField`\n\nThe source field ID of the destination parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-destinationparametervalueconfiguration.html#cfn-quicksight-analysis-destinationparametervalueconfiguration-sourcefield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceColumn": { "MarkdownDocumentation": "`SourceColumn`\n\nA column of a data set.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-destinationparametervalueconfiguration.html#cfn-quicksight-analysis-destinationparametervalueconfiguration-sourcecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Analysis.DimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DimensionField`\n\nThe dimension type field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dimensionfield.html", "Properties": { "DateDimensionField": { "MarkdownDocumentation": "`DateDimensionField`\n\nThe dimension type field with date type columns.\n*Required*: No\n*Type*: [DateDimensionField](./aws-properties-quicksight-analysis-datedimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dimensionfield.html#cfn-quicksight-analysis-dimensionfield-datedimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "DateDimensionField" }, "NumericalDimensionField": { "MarkdownDocumentation": "`NumericalDimensionField`\n\nThe dimension type field with numerical type columns.\n*Required*: No\n*Type*: [NumericalDimensionField](./aws-properties-quicksight-analysis-numericaldimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dimensionfield.html#cfn-quicksight-analysis-dimensionfield-numericaldimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "NumericalDimensionField" }, "CategoricalDimensionField": { "MarkdownDocumentation": "`CategoricalDimensionField`\n\nThe dimension type field with categorical type columns.\n*Required*: No\n*Type*: [CategoricalDimensionField](./aws-properties-quicksight-analysis-categoricaldimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dimensionfield.html#cfn-quicksight-analysis-dimensionfield-categoricaldimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "CategoricalDimensionField" } } }, "AWS::QuickSight::Analysis.DonutCenterOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DonutCenterOptions`\n\nThe label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-donutcenteroptions.html", "Properties": { "LabelVisibility": { "MarkdownDocumentation": "`LabelVisibility`\n\nDetermines the visibility of the label in a donut chart. In the Quick Sight console, this option is called `'Show total'`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-donutcenteroptions.html#cfn-quicksight-analysis-donutcenteroptions-labelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.DonutOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DonutOptions`\n\nThe options for configuring a donut chart or pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-donutoptions.html", "Properties": { "DonutCenterOptions": { "MarkdownDocumentation": "`DonutCenterOptions`\n\nThe label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.\n*Required*: No\n*Type*: [DonutCenterOptions](./aws-properties-quicksight-analysis-donutcenteroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-donutoptions.html#cfn-quicksight-analysis-donutoptions-donutcenteroptions", "UpdateType": "Mutable", "Required": false, "Type": "DonutCenterOptions" }, "ArcOptions": { "MarkdownDocumentation": "`ArcOptions`\n\nThe option for define the arc of the chart shape. Valid values are as follows:\n* `WHOLE` - A pie chart\n* `SMALL`- A small-sized donut chart\n* `MEDIUM`- A medium-sized donut chart\n* `LARGE`- A large-sized donut chart\n*Required*: No\n*Type*: [ArcOptions](./aws-properties-quicksight-analysis-arcoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-donutoptions.html#cfn-quicksight-analysis-donutoptions-arcoptions", "UpdateType": "Mutable", "Required": false, "Type": "ArcOptions" } } }, "AWS::QuickSight::Analysis.DrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DrillDownFilter`\n\nThe drill down filter for the column hierarchies.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-drilldownfilter.html", "Properties": { "NumericEqualityFilter": { "MarkdownDocumentation": "`NumericEqualityFilter`\n\nThe numeric equality type drill down filter. This filter is used for number type columns.\n*Required*: No\n*Type*: [NumericEqualityDrillDownFilter](./aws-properties-quicksight-analysis-numericequalitydrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-drilldownfilter.html#cfn-quicksight-analysis-drilldownfilter-numericequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericEqualityDrillDownFilter" }, "TimeRangeFilter": { "MarkdownDocumentation": "`TimeRangeFilter`\n\nThe time range drill down filter. This filter is used for date time columns.\n*Required*: No\n*Type*: [TimeRangeDrillDownFilter](./aws-properties-quicksight-analysis-timerangedrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-drilldownfilter.html#cfn-quicksight-analysis-drilldownfilter-timerangefilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeDrillDownFilter" }, "CategoryFilter": { "MarkdownDocumentation": "`CategoryFilter`\n\nThe category type drill down filter. This filter is used for string type columns.\n*Required*: No\n*Type*: [CategoryDrillDownFilter](./aws-properties-quicksight-analysis-categorydrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-drilldownfilter.html#cfn-quicksight-analysis-drilldownfilter-categoryfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryDrillDownFilter" } } }, "AWS::QuickSight::Analysis.DropDownControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DropDownControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dropdowncontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dropdowncontroldisplayoptions.html#cfn-quicksight-analysis-dropdowncontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nThe configuration of the `Select all` options in a\ndropdown control.\n*Required*: No\n*Type*: [ListControlSelectAllOptions](./aws-properties-quicksight-analysis-listcontrolselectalloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dropdowncontroldisplayoptions.html#cfn-quicksight-analysis-dropdowncontroldisplayoptions-selectalloptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSelectAllOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dropdowncontroldisplayoptions.html#cfn-quicksight-analysis-dropdowncontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Analysis.DynamicDefaultValue": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.DynamicDefaultValue`\n\nDefines different defaults to the users or groups based on mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dynamicdefaultvalue.html", "Properties": { "GroupNameColumn": { "MarkdownDocumentation": "`GroupNameColumn`\n\nThe column that contains the group name.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dynamicdefaultvalue.html#cfn-quicksight-analysis-dynamicdefaultvalue-groupnamecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" }, "DefaultValueColumn": { "MarkdownDocumentation": "`DefaultValueColumn`\n\nThe column that contains the default value of each user or group.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dynamicdefaultvalue.html#cfn-quicksight-analysis-dynamicdefaultvalue-defaultvaluecolumn", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "UserNameColumn": { "MarkdownDocumentation": "`UserNameColumn`\n\nThe column that contains the username.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-dynamicdefaultvalue.html#cfn-quicksight-analysis-dynamicdefaultvalue-usernamecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Analysis.EmptyVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.EmptyVisual`\n\nAn empty visual.\nEmpty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an `EmptyVisual` until a visual type is selected.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.html", "Properties": { "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.html#cfn-quicksight-analysis-emptyvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.html#cfn-quicksight-analysis-emptyvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in the empty visual. Every visual requires a dataset to render.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.html#cfn-quicksight-analysis-emptyvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.Entity": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.Entity`\n\nAn object, structure, or sub-structure of an analysis, template, or dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-entity.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe hierarchical path of the entity within the analysis, template, or dashboard definition tree.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-entity.html#cfn-quicksight-analysis-entity-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ExcludePeriodConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ExcludePeriodConfiguration`\n\nThe exclude period of `TimeRangeFilter` or `RelativeDatesFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the exclude period. Choose from the following options:\n* `ENABLED`\n* `DISABLED`\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Amount": { "MarkdownDocumentation": "`Amount`\n\nThe amount or number of the exclude period.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-amount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Granularity": { "MarkdownDocumentation": "`Granularity`\n\nThe granularity or unit (day, month, year) of the exclude period.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-granularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ExplicitHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ExplicitHierarchy`\n\nThe option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-explicithierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the explicit hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-explicithierarchy.html#cfn-quicksight-analysis-explicithierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the explicit hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-analysis-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-explicithierarchy.html#cfn-quicksight-analysis-explicithierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe list of columns that define the explicit hierarchy.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-explicithierarchy.html#cfn-quicksight-analysis-explicithierarchy-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FieldBasedTooltip": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FieldBasedTooltip`\n\nThe setup for the detailed tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldbasedtooltip.html", "Properties": { "TooltipFields": { "MarkdownDocumentation": "`TooltipFields`\n\nThe fields configuration in the\ntooltip.\n*Required*: No\n*Type*: Array of [TooltipItem](./aws-properties-quicksight-analysis-tooltipitem.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldbasedtooltip.html#cfn-quicksight-analysis-fieldbasedtooltip-tooltipfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TooltipItem", "DuplicatesAllowed": true }, "AggregationVisibility": { "MarkdownDocumentation": "`AggregationVisibility`\n\nThe visibility of `Show aggregations`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldbasedtooltip.html#cfn-quicksight-analysis-fieldbasedtooltip-aggregationvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipTitleType": { "MarkdownDocumentation": "`TooltipTitleType`\n\nThe type for the >tooltip title. Choose one of the following options:\n* `NONE`: Doesn't use the primary value as the title.\n* `PRIMARY_VALUE`: Uses primary value as the title.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | PRIMARY_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "PRIMARY_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldbasedtooltip.html#cfn-quicksight-analysis-fieldbasedtooltip-tooltiptitletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FieldLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FieldLabelType`\n\nThe field label type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldlabeltype.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nIndicates the field that is targeted by the field\nlabel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldlabeltype.html#cfn-quicksight-analysis-fieldlabeltype-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the field label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldlabeltype.html#cfn-quicksight-analysis-fieldlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FieldSeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FieldSeriesItem`\n\nThe field series item configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldseriesitem.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field for which you are setting the axis binding.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldseriesitem.html#cfn-quicksight-analysis-fieldseriesitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis that you are binding the field to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldseriesitem.html#cfn-quicksight-analysis-fieldseriesitem-axisbinding", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nThe options that determine the presentation of line series associated to the field.\n*Required*: No\n*Type*: [LineChartSeriesSettings](./aws-properties-quicksight-analysis-linechartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldseriesitem.html#cfn-quicksight-analysis-fieldseriesitem-settings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSeriesSettings" } } }, "AWS::QuickSight::Analysis.FieldSort": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FieldSort`\n\nThe sort configuration for a field in a\nfield well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldsort.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe sort configuration target field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldsort.html#cfn-quicksight-analysis-fieldsort-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe sort direction. Choose one of the following\noptions:\n* `ASC`: Ascending\n* `DESC`: Descending\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldsort.html#cfn-quicksight-analysis-fieldsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FieldSortOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FieldSortOptions`\n\nThe field sort options in a chart configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldsortoptions.html", "Properties": { "FieldSort": { "MarkdownDocumentation": "`FieldSort`\n\nThe sort configuration for a field in a field well.\n*Required*: No\n*Type*: [FieldSort](./aws-properties-quicksight-analysis-fieldsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldsortoptions.html#cfn-quicksight-analysis-fieldsortoptions-fieldsort", "UpdateType": "Mutable", "Required": false, "Type": "FieldSort" }, "ColumnSort": { "MarkdownDocumentation": "`ColumnSort`\n\nThe sort configuration for a column that is not used in a field well.\n*Required*: No\n*Type*: [ColumnSort](./aws-properties-quicksight-analysis-columnsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldsortoptions.html#cfn-quicksight-analysis-fieldsortoptions-columnsort", "UpdateType": "Mutable", "Required": false, "Type": "ColumnSort" } } }, "AWS::QuickSight::Analysis.FieldTooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FieldTooltipItem`\n\nThe tooltip item for the fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldtooltipitem.html", "Properties": { "TooltipTarget": { "MarkdownDocumentation": "`TooltipTarget`\n\nDetermines the target of the field tooltip item in a combo chart visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `BOTH | BAR | LINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BOTH", "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldtooltipitem.html#cfn-quicksight-analysis-fieldtooltipitem-tooltiptarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe unique ID of the field that is targeted by the tooltip.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldtooltipitem.html#cfn-quicksight-analysis-fieldtooltipitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label of the tooltip item.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldtooltipitem.html#cfn-quicksight-analysis-fieldtooltipitem-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip item.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fieldtooltipitem.html#cfn-quicksight-analysis-fieldtooltipitem-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilledMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilledMapAggregatedFieldWells`\n\nThe aggregated field well of the filled map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe aggregated color field well of a filled map. Values are aggregated based on location fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapaggregatedfieldwells.html#cfn-quicksight-analysis-filledmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Geospatial": { "MarkdownDocumentation": "`Geospatial`\n\nThe aggregated location field well of the filled map. Values are grouped by location fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapaggregatedfieldwells.html#cfn-quicksight-analysis-filledmapaggregatedfieldwells-geospatial", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FilledMapConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilledMapConditionalFormatting`\n\nThe conditional formatting of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options of a `FilledMapVisual`.\n*Required*: Yes\n*Type*: Array of [FilledMapConditionalFormattingOption](./aws-properties-quicksight-analysis-filledmapconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconditionalformatting.html#cfn-quicksight-analysis-filledmapconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FilledMapConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FilledMapConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilledMapConditionalFormattingOption`\n\nConditional formatting options of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconditionalformattingoption.html", "Properties": { "Shape": { "MarkdownDocumentation": "`Shape`\n\nThe conditional formatting that determines the shape of the filled map.\n*Required*: Yes\n*Type*: [FilledMapShapeConditionalFormatting](./aws-properties-quicksight-analysis-filledmapshapeconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconditionalformattingoption.html#cfn-quicksight-analysis-filledmapconditionalformattingoption-shape", "UpdateType": "Mutable", "Required": true, "Type": "FilledMapShapeConditionalFormatting" } } }, "AWS::QuickSight::Analysis.FilledMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilledMapConfiguration`\n\nThe configuration for a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `FilledMapVisual`.\n*Required*: No\n*Type*: [FilledMapSortConfiguration](./aws-properties-quicksight-analysis-filledmapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconfiguration.html#cfn-quicksight-analysis-filledmapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconfiguration.html#cfn-quicksight-analysis-filledmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "MapStyleOptions": { "MarkdownDocumentation": "`MapStyleOptions`\n\nThe map style options of the filled map visual.\n*Required*: No\n*Type*: [GeospatialMapStyleOptions](./aws-properties-quicksight-analysis-geospatialmapstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconfiguration.html#cfn-quicksight-analysis-filledmapconfiguration-mapstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapStyleOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [FilledMapFieldWells](./aws-properties-quicksight-analysis-filledmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconfiguration.html#cfn-quicksight-analysis-filledmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconfiguration.html#cfn-quicksight-analysis-filledmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconfiguration.html#cfn-quicksight-analysis-filledmapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "WindowOptions": { "MarkdownDocumentation": "`WindowOptions`\n\nThe window options of the filled map visual.\n*Required*: No\n*Type*: [GeospatialWindowOptions](./aws-properties-quicksight-analysis-geospatialwindowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapconfiguration.html#cfn-quicksight-analysis-filledmapconfiguration-windowoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialWindowOptions" } } }, "AWS::QuickSight::Analysis.FilledMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilledMapFieldWells`\n\nThe field wells of a `FilledMapVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapfieldwells.html", "Properties": { "FilledMapAggregatedFieldWells": { "MarkdownDocumentation": "`FilledMapAggregatedFieldWells`\n\nThe aggregated field well of the filled map.\n*Required*: No\n*Type*: [FilledMapAggregatedFieldWells](./aws-properties-quicksight-analysis-filledmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapfieldwells.html#cfn-quicksight-analysis-filledmapfieldwells-filledmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.FilledMapShapeConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilledMapShapeConditionalFormatting`\n\nThe conditional formatting that determines the shape of the filled map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapshapeconditionalformatting.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe conditional formatting that determines the background color of a filled map's shape.\n*Required*: No\n*Type*: [ShapeConditionalFormat](./aws-properties-quicksight-analysis-shapeconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapshapeconditionalformatting.html#cfn-quicksight-analysis-filledmapshapeconditionalformatting-format", "UpdateType": "Mutable", "Required": false, "Type": "ShapeConditionalFormat" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the filled map shape.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapshapeconditionalformatting.html#cfn-quicksight-analysis-filledmapshapeconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilledMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilledMapSortConfiguration`\n\nThe sort configuration of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapsortconfiguration.html", "Properties": { "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the location fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapsortconfiguration.html#cfn-quicksight-analysis-filledmapsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FilledMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilledMapVisual`\n\nA filled map.\nFor more information, see [Creating filled maps](https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html#cfn-quicksight-analysis-filledmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a `FilledMapVisual`.\n*Required*: No\n*Type*: [FilledMapConditionalFormatting](./aws-properties-quicksight-analysis-filledmapconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html#cfn-quicksight-analysis-filledmapvisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html#cfn-quicksight-analysis-filledmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [FilledMapConfiguration](./aws-properties-quicksight-analysis-filledmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html#cfn-quicksight-analysis-filledmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html#cfn-quicksight-analysis-filledmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html#cfn-quicksight-analysis-filledmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html#cfn-quicksight-analysis-filledmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filledmapvisual.html#cfn-quicksight-analysis-filledmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.Filter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.Filter`\n\nWith a `Filter`, you can remove portions of data from a particular visual or view.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html", "Properties": { "NestedFilter": { "MarkdownDocumentation": "`NestedFilter`\n\nA `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.\n*Required*: No\n*Type*: [NestedFilter](./aws-properties-quicksight-analysis-nestedfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-nestedfilter", "UpdateType": "Mutable", "Required": false, "Type": "NestedFilter" }, "NumericEqualityFilter": { "MarkdownDocumentation": "`NumericEqualityFilter`\n\nA `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value.\n*Required*: No\n*Type*: [NumericEqualityFilter](./aws-properties-quicksight-analysis-numericequalityfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-numericequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericEqualityFilter" }, "NumericRangeFilter": { "MarkdownDocumentation": "`NumericRangeFilter`\n\nA `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range.\n*Required*: No\n*Type*: [NumericRangeFilter](./aws-properties-quicksight-analysis-numericrangefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-numericrangefilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilter" }, "TimeRangeFilter": { "MarkdownDocumentation": "`TimeRangeFilter`\n\nA `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range.\n*Required*: No\n*Type*: [TimeRangeFilter](./aws-properties-quicksight-analysis-timerangefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-timerangefilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilter" }, "RelativeDatesFilter": { "MarkdownDocumentation": "`RelativeDatesFilter`\n\nA `RelativeDatesFilter` filters date values that are relative to a given date.\n*Required*: No\n*Type*: [RelativeDatesFilter](./aws-properties-quicksight-analysis-relativedatesfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-relativedatesfilter", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDatesFilter" }, "TopBottomFilter": { "MarkdownDocumentation": "`TopBottomFilter`\n\nA `TopBottomFilter` filters data to the top or bottom values for a given column.\n*Required*: No\n*Type*: [TopBottomFilter](./aws-properties-quicksight-analysis-topbottomfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-topbottomfilter", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomFilter" }, "TimeEqualityFilter": { "MarkdownDocumentation": "`TimeEqualityFilter`\n\nA `TimeEqualityFilter` filters date-time values that equal or do not equal\na given date/time value.\n*Required*: No\n*Type*: [TimeEqualityFilter](./aws-properties-quicksight-analysis-timeequalityfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-timeequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeEqualityFilter" }, "CategoryFilter": { "MarkdownDocumentation": "`CategoryFilter`\n\nA `CategoryFilter` filters text values.\nFor more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [CategoryFilter](./aws-properties-quicksight-analysis-categoryfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-categoryfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryFilter" } } }, "AWS::QuickSight::Analysis.FilterControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterControl`\n\nThe control of a filter that is used to interact with a dashboard or an analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html", "Properties": { "Slider": { "MarkdownDocumentation": "`Slider`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n*Required*: No\n*Type*: [FilterSliderControl](./aws-properties-quicksight-analysis-filterslidercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html#cfn-quicksight-analysis-filtercontrol-slider", "UpdateType": "Mutable", "Required": false, "Type": "FilterSliderControl" }, "TextArea": { "MarkdownDocumentation": "`TextArea`\n\nA control to display a text box that is used to enter multiple entries.\n*Required*: No\n*Type*: [FilterTextAreaControl](./aws-properties-quicksight-analysis-filtertextareacontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html#cfn-quicksight-analysis-filtercontrol-textarea", "UpdateType": "Mutable", "Required": false, "Type": "FilterTextAreaControl" }, "Dropdown": { "MarkdownDocumentation": "`Dropdown`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n*Required*: No\n*Type*: [FilterDropDownControl](./aws-properties-quicksight-analysis-filterdropdowncontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html#cfn-quicksight-analysis-filtercontrol-dropdown", "UpdateType": "Mutable", "Required": false, "Type": "FilterDropDownControl" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nA control to display a text box that is used to enter a single entry.\n*Required*: No\n*Type*: [FilterTextFieldControl](./aws-properties-quicksight-analysis-filtertextfieldcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html#cfn-quicksight-analysis-filtercontrol-textfield", "UpdateType": "Mutable", "Required": false, "Type": "FilterTextFieldControl" }, "List": { "MarkdownDocumentation": "`List`\n\nA control to display a list of buttons or boxes. This is used to select either a single value or multiple values.\n*Required*: No\n*Type*: [FilterListControl](./aws-properties-quicksight-analysis-filterlistcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html#cfn-quicksight-analysis-filtercontrol-list", "UpdateType": "Mutable", "Required": false, "Type": "FilterListControl" }, "DateTimePicker": { "MarkdownDocumentation": "`DateTimePicker`\n\nA control from a date filter that is used to specify date and time.\n*Required*: No\n*Type*: [FilterDateTimePickerControl](./aws-properties-quicksight-analysis-filterdatetimepickercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html#cfn-quicksight-analysis-filtercontrol-datetimepicker", "UpdateType": "Mutable", "Required": false, "Type": "FilterDateTimePickerControl" }, "RelativeDateTime": { "MarkdownDocumentation": "`RelativeDateTime`\n\nA control from a date filter that is used to specify the relative date.\n*Required*: No\n*Type*: [FilterRelativeDateTimeControl](./aws-properties-quicksight-analysis-filterrelativedatetimecontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html#cfn-quicksight-analysis-filtercontrol-relativedatetime", "UpdateType": "Mutable", "Required": false, "Type": "FilterRelativeDateTimeControl" }, "CrossSheet": { "MarkdownDocumentation": "`CrossSheet`\n\nA control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet\n*Required*: No\n*Type*: [FilterCrossSheetControl](./aws-properties-quicksight-analysis-filtercrosssheetcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercontrol.html#cfn-quicksight-analysis-filtercontrol-crosssheet", "UpdateType": "Mutable", "Required": false, "Type": "FilterCrossSheetControl" } } }, "AWS::QuickSight::Analysis.FilterCrossSheetControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterCrossSheetControl`\n\nA control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercrosssheetcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterCrossSheetControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercrosssheetcontrol.html#cfn-quicksight-analysis-filtercrosssheetcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-analysis-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercrosssheetcontrol.html#cfn-quicksight-analysis-filtercrosssheetcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterCrossSheetControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtercrosssheetcontrol.html#cfn-quicksight-analysis-filtercrosssheetcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilterDateTimePickerControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterDateTimePickerControl`\n\nA control from a date filter that is used to specify date and time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdatetimepickercontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdatetimepickercontrol.html#cfn-quicksight-analysis-filterdatetimepickercontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_VALUED | DATE_RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_VALUED", "DATE_RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdatetimepickercontrol.html#cfn-quicksight-analysis-filterdatetimepickercontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdatetimepickercontrol.html#cfn-quicksight-analysis-filterdatetimepickercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterDateTimePickerControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdatetimepickercontrol.html#cfn-quicksight-analysis-filterdatetimepickercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configurationof the Apply button on a `DateTimePickerControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdatetimepickercontrol.html#cfn-quicksight-analysis-filterdatetimepickercontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdatetimepickercontrol.html#cfn-quicksight-analysis-filterdatetimepickercontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilterDropDownControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterDropDownControl`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html#cfn-quicksight-analysis-filterdropdowncontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html#cfn-quicksight-analysis-filterdropdowncontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of the `FilterDropDownControl`.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-analysis-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html#cfn-quicksight-analysis-filterdropdowncontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-analysis-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html#cfn-quicksight-analysis-filterdropdowncontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterDropDownControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html#cfn-quicksight-analysis-filterdropdowncontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html#cfn-quicksight-analysis-filterdropdowncontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html#cfn-quicksight-analysis-filterdropdowncontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-analysis-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterdropdowncontrol.html#cfn-quicksight-analysis-filterdropdowncontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Analysis.FilterGroup": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterGroup`\n\nA grouping of individual filters. Filter groups are applied to the same group of visuals.\nFor more information, see [Adding filter conditions (group filters) with AND and OR operators](https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the `FilterGroup`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe list of filters that are present in a `FilterGroup`.\n*Required*: Yes\n*Type*: Array of [Filter](./aws-properties-quicksight-analysis-filter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-filters", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": true }, "CrossDataset": { "MarkdownDocumentation": "`CrossDataset`\n\nThe filter new feature which can apply filter group to all data sets. Choose one of the following options:\n* `ALL_DATASETS`\n* `SINGLE_DATASET`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_DATASETS | SINGLE_DATAS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_DATASETS", "SINGLE_DATASET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-crossdataset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ScopeConfiguration": { "MarkdownDocumentation": "`ScopeConfiguration`\n\nThe configuration that specifies what scope to apply to a `FilterGroup`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: [FilterScopeConfiguration](./aws-properties-quicksight-analysis-filterscopeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-scopeconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterScopeConfiguration" }, "FilterGroupId": { "MarkdownDocumentation": "`FilterGroupId`\n\nThe value that uniquely identifies a `FilterGroup` within a dashboard, template, or analysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-filtergroupid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilterListConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterListConfiguration`\n\nA list of filter configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistconfiguration.html", "Properties": { "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nThe list of category values for the filter.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistconfiguration.html#cfn-quicksight-analysis-filterlistconfiguration-categoryvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistconfiguration.html#cfn-quicksight-analysis-filterlistconfiguration-nulloption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistconfiguration.html#cfn-quicksight-analysis-filterlistconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistconfiguration.html#cfn-quicksight-analysis-filterlistconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilterListControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterListControl`\n\nA control to display a list of buttons or boxes. This is used to select either a single value or multiple values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistcontrol.html#cfn-quicksight-analysis-filterlistcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterListControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from the list.\n* `SINGLE_SELECT`: The user can select a single entry from the list.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistcontrol.html#cfn-quicksight-analysis-filterlistcontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-analysis-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistcontrol.html#cfn-quicksight-analysis-filterlistcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-analysis-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistcontrol.html#cfn-quicksight-analysis-filterlistcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterListControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistcontrol.html#cfn-quicksight-analysis-filterlistcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistcontrol.html#cfn-quicksight-analysis-filterlistcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-analysis-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterlistcontrol.html#cfn-quicksight-analysis-filterlistcontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Analysis.FilterOperationSelectedFieldsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterOperationSelectedFieldsConfiguration`\n\nThe configuration of selected fields in the`CustomActionFilterOperation`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filteroperationselectedfieldsconfiguration.html", "Properties": { "SelectedColumns": { "MarkdownDocumentation": "`SelectedColumns`\n\nThe selected columns of a dataset.\n*Required*: No\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-analysis-filteroperationselectedfieldsconfiguration-selectedcolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true }, "SelectedFields": { "MarkdownDocumentation": "`SelectedFields`\n\nChooses the fields that are filtered in `CustomActionFilterOperation`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `512 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-analysis-filteroperationselectedfieldsconfiguration-selectedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nA structure that contains the options that choose which fields are filtered in the `CustomActionFilterOperation`.\nValid values are defined as follows:\n* `ALL_FIELDS`: Applies the filter operation to all fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_FIELDS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL_FIELDS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-analysis-filteroperationselectedfieldsconfiguration-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilterOperationTargetVisualsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterOperationTargetVisualsConfiguration`\n\nThe configuration of target visuals that you want to be filtered.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filteroperationtargetvisualsconfiguration.html", "Properties": { "SameSheetTargetVisualConfiguration": { "MarkdownDocumentation": "`SameSheetTargetVisualConfiguration`\n\nThe configuration of the same-sheet target visuals that you want to be filtered.\n*Required*: No\n*Type*: [SameSheetTargetVisualConfiguration](./aws-properties-quicksight-analysis-samesheettargetvisualconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filteroperationtargetvisualsconfiguration.html#cfn-quicksight-analysis-filteroperationtargetvisualsconfiguration-samesheettargetvisualconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SameSheetTargetVisualConfiguration" } } }, "AWS::QuickSight::Analysis.FilterRelativeDateTimeControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterRelativeDateTimeControl`\n\nA control from a date filter that is used to specify the relative date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterrelativedatetimecontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterrelativedatetimecontrol.html#cfn-quicksight-analysis-filterrelativedatetimecontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [RelativeDateTimeControlDisplayOptions](./aws-properties-quicksight-analysis-relativedatetimecontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterrelativedatetimecontrol.html#cfn-quicksight-analysis-filterrelativedatetimecontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDateTimeControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterrelativedatetimecontrol.html#cfn-quicksight-analysis-filterrelativedatetimecontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterRelativeDateTimeControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterrelativedatetimecontrol.html#cfn-quicksight-analysis-filterrelativedatetimecontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterrelativedatetimecontrol.html#cfn-quicksight-analysis-filterrelativedatetimecontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilterScopeConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterScopeConfiguration`\n\nThe scope configuration for a `FilterGroup`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterscopeconfiguration.html", "Properties": { "AllSheets": { "MarkdownDocumentation": "`AllSheets`\n\nThe configuration that applies a filter to all sheets. When you choose `AllSheets` as the value for a `FilterScopeConfiguration`, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The `AllSheetsFilterScopeConfiguration` is chosen.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterscopeconfiguration.html#cfn-quicksight-analysis-filterscopeconfiguration-allsheets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "SelectedSheets": { "MarkdownDocumentation": "`SelectedSheets`\n\nThe configuration for applying a filter to specific sheets.\n*Required*: No\n*Type*: [SelectedSheetsFilterScopeConfiguration](./aws-properties-quicksight-analysis-selectedsheetsfilterscopeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterscopeconfiguration.html#cfn-quicksight-analysis-filterscopeconfiguration-selectedsheets", "UpdateType": "Mutable", "Required": false, "Type": "SelectedSheetsFilterScopeConfiguration" } } }, "AWS::QuickSight::Analysis.FilterSelectableValues": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterSelectableValues`\n\nA list of selectable values that are used in a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterselectablevalues.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are used in the `FilterSelectableValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterselectablevalues.html#cfn-quicksight-analysis-filterselectablevalues-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FilterSliderControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterSliderControl`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html#cfn-quicksight-analysis-filterslidercontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterSliderControl`. Choose one of the following options:\n* `SINGLE_POINT`: Filter against(equals) a single data point.\n* `RANGE`: Filter data that is in a specified range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_POINT | RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_POINT", "RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html#cfn-quicksight-analysis-filterslidercontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html#cfn-quicksight-analysis-filterslidercontrol-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-analysis-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html#cfn-quicksight-analysis-filterslidercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterSliderControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html#cfn-quicksight-analysis-filterslidercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html#cfn-quicksight-analysis-filterslidercontrol-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html#cfn-quicksight-analysis-filterslidercontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filterslidercontrol.html#cfn-quicksight-analysis-filterslidercontrol-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.FilterTextAreaControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterTextAreaControl`\n\nA control to display a text box that is used to enter multiple entries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextareacontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextareacontrol.html#cfn-quicksight-analysis-filtertextareacontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextareacontrol.html#cfn-quicksight-analysis-filtertextareacontrol-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-analysis-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextareacontrol.html#cfn-quicksight-analysis-filtertextareacontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextareacontrol.html#cfn-quicksight-analysis-filtertextareacontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextareacontrol.html#cfn-quicksight-analysis-filtertextareacontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FilterTextFieldControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FilterTextFieldControl`\n\nA control to display a text box that is used to enter a single entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextfieldcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextfieldcontrol.html#cfn-quicksight-analysis-filtertextfieldcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-analysis-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextfieldcontrol.html#cfn-quicksight-analysis-filtertextfieldcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextFieldControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextfieldcontrol.html#cfn-quicksight-analysis-filtertextfieldcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtertextfieldcontrol.html#cfn-quicksight-analysis-filtertextfieldcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FontConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FontConfiguration`\n\nConfigures the display properties of the given text.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontconfiguration.html", "Properties": { "FontFamily": { "MarkdownDocumentation": "`FontFamily`\n\nThe font family that you want 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontconfiguration.html#cfn-quicksight-analysis-fontconfiguration-fontfamily", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontStyle": { "MarkdownDocumentation": "`FontStyle`\n\nDetermines the text display face that is inherited by the given font family.\n*Required*: No\n*Type*: String\n*Allowed values*: `NORMAL | ITALIC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NORMAL", "ITALIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontconfiguration.html#cfn-quicksight-analysis-fontconfiguration-fontstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontSize": { "MarkdownDocumentation": "`FontSize`\n\nThe option that determines the text display size.\n*Required*: No\n*Type*: [FontSize](./aws-properties-quicksight-analysis-fontsize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontconfiguration.html#cfn-quicksight-analysis-fontconfiguration-fontsize", "UpdateType": "Mutable", "Required": false, "Type": "FontSize" }, "FontDecoration": { "MarkdownDocumentation": "`FontDecoration`\n\nDetermines the appearance of decorative lines on the text.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNDERLINE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNDERLINE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontconfiguration.html#cfn-quicksight-analysis-fontconfiguration-fontdecoration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontColor": { "MarkdownDocumentation": "`FontColor`\n\nDetermines the color of the text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontconfiguration.html#cfn-quicksight-analysis-fontconfiguration-fontcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontWeight": { "MarkdownDocumentation": "`FontWeight`\n\nThe option that determines the text display weight, or boldness.\n*Required*: No\n*Type*: [FontWeight](./aws-properties-quicksight-analysis-fontweight.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontconfiguration.html#cfn-quicksight-analysis-fontconfiguration-fontweight", "UpdateType": "Mutable", "Required": false, "Type": "FontWeight" } } }, "AWS::QuickSight::Analysis.FontSize": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FontSize`\n\nThe option that determines the text display size.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontsize.html", "Properties": { "Relative": { "MarkdownDocumentation": "`Relative`\n\nThe lexical name for the text size, proportional to its surrounding context.\n*Required*: No\n*Type*: String\n*Allowed values*: `EXTRA_SMALL | SMALL | MEDIU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontsize.html#cfn-quicksight-analysis-fontsize-relative", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Absolute": { "MarkdownDocumentation": "`Absolute`\n\nThe font size that you want to use in px.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontsize.html#cfn-quicksight-analysis-fontsize-absolute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FontWeight": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FontWeight`\n\nThe option that determines the text display weight, or boldness.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontweight.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe lexical name for the level of boldness of the text display.\n*Required*: No\n*Type*: String\n*Allowed values*: `NORMAL | BOLD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NORMAL", "BOLD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-fontweight.html#cfn-quicksight-analysis-fontweight-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ForecastComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ForecastComputation`\n\nThe forecast computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html", "Properties": { "PeriodsBackward": { "MarkdownDocumentation": "`PeriodsBackward`\n\nThe periods backward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-periodsbackward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PeriodsForward": { "MarkdownDocumentation": "`PeriodsForward`\n\nThe periods forward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-periodsforward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PredictionInterval": { "MarkdownDocumentation": "`PredictionInterval`\n\nThe prediction interval setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `50`\n*Maximum*: `95`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-predictioninterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Seasonality": { "MarkdownDocumentation": "`Seasonality`\n\nThe seasonality setup of a forecast computation. Choose one of the following options:\n* `AUTOMATIC`\n* `CUSTOM`: Checks the custom seasonality value.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTOMATIC | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-seasonality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomSeasonalityValue": { "MarkdownDocumentation": "`CustomSeasonalityValue`\n\nThe custom seasonality value setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `180`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-customseasonalityvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "UpperBoundary": { "MarkdownDocumentation": "`UpperBoundary`\n\nThe upper boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-upperboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LowerBoundary": { "MarkdownDocumentation": "`LowerBoundary`\n\nThe lower boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastcomputation.html#cfn-quicksight-analysis-forecastcomputation-lowerboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.ForecastConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ForecastConfiguration`\n\nThe forecast configuration that is used in a line chart's display properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastconfiguration.html", "Properties": { "ForecastProperties": { "MarkdownDocumentation": "`ForecastProperties`\n\nThe forecast properties setup of a forecast in the line\nchart.\n*Required*: No\n*Type*: [TimeBasedForecastProperties](./aws-properties-quicksight-analysis-timebasedforecastproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastconfiguration.html#cfn-quicksight-analysis-forecastconfiguration-forecastproperties", "UpdateType": "Mutable", "Required": false, "Type": "TimeBasedForecastProperties" }, "Scenario": { "MarkdownDocumentation": "`Scenario`\n\nThe forecast scenario of a forecast in the line chart.\n*Required*: No\n*Type*: [ForecastScenario](./aws-properties-quicksight-analysis-forecastscenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastconfiguration.html#cfn-quicksight-analysis-forecastconfiguration-scenario", "UpdateType": "Mutable", "Required": false, "Type": "ForecastScenario" } } }, "AWS::QuickSight::Analysis.ForecastScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ForecastScenario`\n\nThe forecast scenario of a forecast in the line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastscenario.html", "Properties": { "WhatIfRangeScenario": { "MarkdownDocumentation": "`WhatIfRangeScenario`\n\nThe what-if analysis forecast setup with the date range.\n*Required*: No\n*Type*: [WhatIfRangeScenario](./aws-properties-quicksight-analysis-whatifrangescenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastscenario.html#cfn-quicksight-analysis-forecastscenario-whatifrangescenario", "UpdateType": "Mutable", "Required": false, "Type": "WhatIfRangeScenario" }, "WhatIfPointScenario": { "MarkdownDocumentation": "`WhatIfPointScenario`\n\nThe what-if analysis forecast setup with the target date.\n*Required*: No\n*Type*: [WhatIfPointScenario](./aws-properties-quicksight-analysis-whatifpointscenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-forecastscenario.html#cfn-quicksight-analysis-forecastscenario-whatifpointscenario", "UpdateType": "Mutable", "Required": false, "Type": "WhatIfPointScenario" } } }, "AWS::QuickSight::Analysis.FormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FormatConfiguration`\n\nThe formatting configuration for all types of field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-formatconfiguration.html", "Properties": { "NumberFormatConfiguration": { "MarkdownDocumentation": "`NumberFormatConfiguration`\n\nFormatting configuration for number fields.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-analysis-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-formatconfiguration.html#cfn-quicksight-analysis-formatconfiguration-numberformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "DateTimeFormatConfiguration": { "MarkdownDocumentation": "`DateTimeFormatConfiguration`\n\nFormatting configuration for `DateTime` fields.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-analysis-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-formatconfiguration.html#cfn-quicksight-analysis-formatconfiguration-datetimeformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "StringFormatConfiguration": { "MarkdownDocumentation": "`StringFormatConfiguration`\n\nFormatting configuration for string fields.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-analysis-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-formatconfiguration.html#cfn-quicksight-analysis-formatconfiguration-stringformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" } } }, "AWS::QuickSight::Analysis.FreeFormLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FreeFormLayoutCanvasSizeOptions`\n\nConfiguration options for the canvas of a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutcanvassizeoptions.html", "Properties": { "ScreenCanvasSizeOptions": { "MarkdownDocumentation": "`ScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a free-form layout.\n*Required*: No\n*Type*: [FreeFormLayoutScreenCanvasSizeOptions](./aws-properties-quicksight-analysis-freeformlayoutscreencanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutcanvassizeoptions.html#cfn-quicksight-analysis-freeformlayoutcanvassizeoptions-screencanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutScreenCanvasSizeOptions" } } }, "AWS::QuickSight::Analysis.FreeFormLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FreeFormLayoutConfiguration`\n\nThe configuration of a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [FreeFormLayoutCanvasSizeOptions](./aws-properties-quicksight-analysis-freeformlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutconfiguration.html#cfn-quicksight-analysis-freeformlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutCanvasSizeOptions" }, "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in a free-form layout.\n*Required*: Yes\n*Type*: Array of [FreeFormLayoutElement](./aws-properties-quicksight-analysis-freeformlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutconfiguration.html#cfn-quicksight-analysis-freeformlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FreeFormLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FreeFormLayoutElement": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FreeFormLayoutElement`\n\nAn element within a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html", "Properties": { "ElementType": { "MarkdownDocumentation": "`ElementType`\n\nThe type of element.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VISUAL | FILTER_CONTROL | P...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VISUAL", "FILTER_CONTROL", "PARAMETER_CONTROL", "TEXT_BOX", "IMAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-elementtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BorderStyle": { "MarkdownDocumentation": "`BorderStyle`\n\nThe border style configuration of a free-form layout element.\n*Required*: No\n*Type*: [FreeFormLayoutElementBorderStyle](./aws-properties-quicksight-analysis-freeformlayoutelementborderstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-borderstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBorderStyle" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-height", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of an element within a free-form layout.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RenderingRules": { "MarkdownDocumentation": "`RenderingRules`\n\nThe rendering rules that determine when an element should be displayed within a free-form layout.\n*Required*: No\n*Type*: Array of [SheetElementRenderingRule](./aws-properties-quicksight-analysis-sheetelementrenderingrule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-renderingrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetElementRenderingRule", "DuplicatesAllowed": true }, "YAxisLocation": { "MarkdownDocumentation": "`YAxisLocation`\n\nThe y-axis coordinate of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-yaxislocation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LoadingAnimation": { "MarkdownDocumentation": "`LoadingAnimation`\n\nThe loading animation configuration of a free-form layout element.\n*Required*: No\n*Type*: [LoadingAnimation](./aws-properties-quicksight-analysis-loadinganimation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-loadinganimation", "UpdateType": "Mutable", "Required": false, "Type": "LoadingAnimation" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-width", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BackgroundStyle": { "MarkdownDocumentation": "`BackgroundStyle`\n\nThe background style configuration of a free-form layout element.\n*Required*: No\n*Type*: [FreeFormLayoutElementBackgroundStyle](./aws-properties-quicksight-analysis-freeformlayoutelementbackgroundstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-backgroundstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBackgroundStyle" }, "ElementId": { "MarkdownDocumentation": "`ElementId`\n\nA unique identifier for an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-elementid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "XAxisLocation": { "MarkdownDocumentation": "`XAxisLocation`\n\nThe x-axis coordinate of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-xaxislocation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectedBorderStyle": { "MarkdownDocumentation": "`SelectedBorderStyle`\n\nThe border style configuration of a free-form layout element. This border style is used when the element is selected.\n*Required*: No\n*Type*: [FreeFormLayoutElementBorderStyle](./aws-properties-quicksight-analysis-freeformlayoutelementborderstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelement.html#cfn-quicksight-analysis-freeformlayoutelement-selectedborderstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBorderStyle" } } }, "AWS::QuickSight::Analysis.FreeFormLayoutElementBackgroundStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FreeFormLayoutElementBackgroundStyle`\n\nThe background style configuration of a free-form layout element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelementbackgroundstyle.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe background color of a free-form layout element.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-analysis-freeformlayoutelementbackgroundstyle-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe background visibility of a free-form layout element.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-analysis-freeformlayoutelementbackgroundstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FreeFormLayoutElementBorderStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FreeFormLayoutElementBorderStyle`\n\nThe background style configuration of a free-form layout element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelementborderstyle.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe border color of a free-form layout element.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelementborderstyle.html#cfn-quicksight-analysis-freeformlayoutelementborderstyle-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe border visibility of a free-form layout element.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutelementborderstyle.html#cfn-quicksight-analysis-freeformlayoutelementborderstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FreeFormLayoutScreenCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FreeFormLayoutScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutscreencanvassizeoptions.html", "Properties": { "OptimizedViewPortWidth": { "MarkdownDocumentation": "`OptimizedViewPortWidth`\n\nThe width that the view port will be optimized for when the layout renders.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformlayoutscreencanvassizeoptions.html#cfn-quicksight-analysis-freeformlayoutscreencanvassizeoptions-optimizedviewportwidth", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.FreeFormSectionLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FreeFormSectionLayoutConfiguration`\n\nThe free-form layout configuration of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformsectionlayoutconfiguration.html", "Properties": { "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in the free-form layout.\n*Required*: Yes\n*Type*: Array of [FreeFormLayoutElement](./aws-properties-quicksight-analysis-freeformlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-freeformsectionlayoutconfiguration.html#cfn-quicksight-analysis-freeformsectionlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FreeFormLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FunnelChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FunnelChartAggregatedFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field wells of a funnel chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartaggregatedfieldwells.html#cfn-quicksight-analysis-funnelchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a funnel chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartaggregatedfieldwells.html#cfn-quicksight-analysis-funnelchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FunnelChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FunnelChartConfiguration`\n\nThe configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartSortConfiguration](./aws-properties-quicksight-analysis-funnelchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html#cfn-quicksight-analysis-funnelchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartSortConfiguration" }, "DataLabelOptions": { "MarkdownDocumentation": "`DataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n*Required*: No\n*Type*: [FunnelChartDataLabelOptions](./aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html#cfn-quicksight-analysis-funnelchartconfiguration-datalabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartDataLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options of the categories that are displayed in a `FunnelChartVisual`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html#cfn-quicksight-analysis-funnelchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartFieldWells](./aws-properties-quicksight-analysis-funnelchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html#cfn-quicksight-analysis-funnelchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html#cfn-quicksight-analysis-funnelchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html#cfn-quicksight-analysis-funnelchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options for the values that are displayed in a `FunnelChartVisual`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html#cfn-quicksight-analysis-funnelchartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartconfiguration.html#cfn-quicksight-analysis-funnelchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Analysis.FunnelChartDataLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FunnelChartDataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html", "Properties": { "MeasureLabelVisibility": { "MarkdownDocumentation": "`MeasureLabelVisibility`\n\nThe visibility of the measure labels within the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html#cfn-quicksight-analysis-funnelchartdatalabeloptions-measurelabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nDetermines the positioning of the data label relative to a section of the funnel.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSIDE | OUTSIDE | LEFT | T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSIDE", "OUTSIDE", "LEFT", "TOP", "BOTTOM", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html#cfn-quicksight-analysis-funnelchartdatalabeloptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility option that determines if data labels are displayed.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html#cfn-quicksight-analysis-funnelchartdatalabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryLabelVisibility": { "MarkdownDocumentation": "`CategoryLabelVisibility`\n\nThe visibility of the category labels within the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html#cfn-quicksight-analysis-funnelchartdatalabeloptions-categorylabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelColor": { "MarkdownDocumentation": "`LabelColor`\n\nThe color of the data label text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html#cfn-quicksight-analysis-funnelchartdatalabeloptions-labelcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MeasureDataLabelStyle": { "MarkdownDocumentation": "`MeasureDataLabelStyle`\n\nDetermines the style of the metric labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `VALUE_ONLY | PERCENTAGE_BY_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VALUE_ONLY", "PERCENTAGE_BY_FIRST_STAGE", "PERCENTAGE_BY_PREVIOUS_STAGE", "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html#cfn-quicksight-analysis-funnelchartdatalabeloptions-measuredatalabelstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelFontConfiguration": { "MarkdownDocumentation": "`LabelFontConfiguration`\n\nThe font configuration for the data labels.\nOnly the `FontSize` attribute of the font configuration is used for data labels.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartdatalabeloptions.html#cfn-quicksight-analysis-funnelchartdatalabeloptions-labelfontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Analysis.FunnelChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FunnelChartFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartfieldwells.html", "Properties": { "FunnelChartAggregatedFieldWells": { "MarkdownDocumentation": "`FunnelChartAggregatedFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartAggregatedFieldWells](./aws-properties-quicksight-analysis-funnelchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartfieldwells.html#cfn-quicksight-analysis-funnelchartfieldwells-funnelchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.FunnelChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FunnelChartSortConfiguration`\n\nThe sort configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartsortconfiguration.html", "Properties": { "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartsortconfiguration.html#cfn-quicksight-analysis-funnelchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartsortconfiguration.html#cfn-quicksight-analysis-funnelchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.FunnelChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.FunnelChartVisual`\n\nA funnel chart.\nFor more information, see [Using funnel charts](https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartvisual.html#cfn-quicksight-analysis-funnelchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartvisual.html#cfn-quicksight-analysis-funnelchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartConfiguration](./aws-properties-quicksight-analysis-funnelchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartvisual.html#cfn-quicksight-analysis-funnelchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartvisual.html#cfn-quicksight-analysis-funnelchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartvisual.html#cfn-quicksight-analysis-funnelchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartvisual.html#cfn-quicksight-analysis-funnelchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-funnelchartvisual.html#cfn-quicksight-analysis-funnelchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GaugeChartArcConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartArcConditionalFormatting`\n\nThe options that determine the presentation of the arc of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartarcconditionalformatting.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe conditional formatting of the arc foreground color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartarcconditionalformatting.html#cfn-quicksight-analysis-gaugechartarcconditionalformatting-foregroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Analysis.GaugeChartColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartColorConfiguration`\n\nThe color configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartcolorconfiguration.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe foreground color configuration of a `GaugeChartVisual`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartcolorconfiguration.html#cfn-quicksight-analysis-gaugechartcolorconfiguration-foregroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color configuration of a `GaugeChartVisual`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartcolorconfiguration.html#cfn-quicksight-analysis-gaugechartcolorconfiguration-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GaugeChartConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartConditionalFormatting`\n\nThe conditional formatting of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [GaugeChartConditionalFormattingOption](./aws-properties-quicksight-analysis-gaugechartconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconditionalformatting.html#cfn-quicksight-analysis-gaugechartconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GaugeChartConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GaugeChartConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartConditionalFormattingOption`\n\nConditional formatting options of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconditionalformattingoption.html", "Properties": { "Arc": { "MarkdownDocumentation": "`Arc`\n\nThe options that determine the presentation of the arc of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartArcConditionalFormatting](./aws-properties-quicksight-analysis-gaugechartarcconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconditionalformattingoption.html#cfn-quicksight-analysis-gaugechartconditionalformattingoption-arc", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartArcConditionalFormatting" }, "PrimaryValue": { "MarkdownDocumentation": "`PrimaryValue`\n\nThe conditional formatting for the primary value of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartPrimaryValueConditionalFormatting](./aws-properties-quicksight-analysis-gaugechartprimaryvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconditionalformattingoption.html#cfn-quicksight-analysis-gaugechartconditionalformattingoption-primaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartPrimaryValueConditionalFormatting" } } }, "AWS::QuickSight::Analysis.GaugeChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartConfiguration`\n\nThe configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconfiguration.html", "Properties": { "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconfiguration.html#cfn-quicksight-analysis-gaugechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartFieldWells](./aws-properties-quicksight-analysis-gaugechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconfiguration.html#cfn-quicksight-analysis-gaugechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartFieldWells" }, "TooltipOptions": { "MarkdownDocumentation": "`TooltipOptions`\n\nThe tooltip configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconfiguration.html#cfn-quicksight-analysis-gaugechartconfiguration-tooltipoptions", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "GaugeChartOptions": { "MarkdownDocumentation": "`GaugeChartOptions`\n\nThe options that determine the presentation of the `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartOptions](./aws-properties-quicksight-analysis-gaugechartoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconfiguration.html#cfn-quicksight-analysis-gaugechartconfiguration-gaugechartoptions", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartOptions" }, "ColorConfiguration": { "MarkdownDocumentation": "`ColorConfiguration`\n\nThe color configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartColorConfiguration](./aws-properties-quicksight-analysis-gaugechartcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconfiguration.html#cfn-quicksight-analysis-gaugechartconfiguration-colorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartColorConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconfiguration.html#cfn-quicksight-analysis-gaugechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartconfiguration.html#cfn-quicksight-analysis-gaugechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Analysis.GaugeChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartFieldWells`\n\nThe field well configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartfieldwells.html", "Properties": { "TargetValues": { "MarkdownDocumentation": "`TargetValues`\n\nThe target value field wells of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartfieldwells.html#cfn-quicksight-analysis-gaugechartfieldwells-targetvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartfieldwells.html#cfn-quicksight-analysis-gaugechartfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GaugeChartOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartOptions`\n\nThe options that determine the presentation of the `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartoptions.html", "Properties": { "Arc": { "MarkdownDocumentation": "`Arc`\n\nThe arc configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcConfiguration](./aws-properties-quicksight-analysis-arcconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartoptions.html#cfn-quicksight-analysis-gaugechartoptions-arc", "UpdateType": "Mutable", "Required": false, "Type": "ArcConfiguration" }, "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe comparison configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ComparisonConfiguration](./aws-properties-quicksight-analysis-comparisonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartoptions.html#cfn-quicksight-analysis-gaugechartoptions-comparison", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonConfiguration" }, "PrimaryValueDisplayType": { "MarkdownDocumentation": "`PrimaryValueDisplayType`\n\nThe options that determine the primary value display type.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | COMPARISON | ACTUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "COMPARISON", "ACTUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartoptions.html#cfn-quicksight-analysis-gaugechartoptions-primaryvaluedisplaytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ArcAxis": { "MarkdownDocumentation": "`ArcAxis`\n\nThe arc axis configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcAxisConfiguration](./aws-properties-quicksight-analysis-arcaxisconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartoptions.html#cfn-quicksight-analysis-gaugechartoptions-arcaxis", "UpdateType": "Mutable", "Required": false, "Type": "ArcAxisConfiguration" }, "PrimaryValueFontConfiguration": { "MarkdownDocumentation": "`PrimaryValueFontConfiguration`\n\nThe options that determine the primary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartoptions.html#cfn-quicksight-analysis-gaugechartoptions-primaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Analysis.GaugeChartPrimaryValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartPrimaryValueConditionalFormatting`\n\nThe conditional formatting for the primary value of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartprimaryvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the primary value text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-analysis-gaugechartprimaryvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the primary value icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-analysis-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-analysis-gaugechartprimaryvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Analysis.GaugeChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GaugeChartVisual`\n\nA gauge chart.\nFor more information, see [Using gauge charts](https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartvisual.html#cfn-quicksight-analysis-gaugechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartConditionalFormatting](./aws-properties-quicksight-analysis-gaugechartconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartvisual.html#cfn-quicksight-analysis-gaugechartvisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartvisual.html#cfn-quicksight-analysis-gaugechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartConfiguration](./aws-properties-quicksight-analysis-gaugechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartvisual.html#cfn-quicksight-analysis-gaugechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartvisual.html#cfn-quicksight-analysis-gaugechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartvisual.html#cfn-quicksight-analysis-gaugechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gaugechartvisual.html#cfn-quicksight-analysis-gaugechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialCategoricalColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialCategoricalColor`\n\nThe definition for a categorical color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcategoricalcolor.html", "Properties": { "CategoryDataColors": { "MarkdownDocumentation": "`CategoryDataColors`\n\nA list of categorical data colors for each category.\n*Required*: Yes\n*Type*: Array of [GeospatialCategoricalDataColor](./aws-properties-quicksight-analysis-geospatialcategoricaldatacolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcategoricalcolor.html#cfn-quicksight-analysis-geospatialcategoricalcolor-categorydatacolors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GeospatialCategoricalDataColor", "DuplicatesAllowed": true }, "DefaultOpacity": { "MarkdownDocumentation": "`DefaultOpacity`\n\nThe default opacity of a categorical color.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcategoricalcolor.html#cfn-quicksight-analysis-geospatialcategoricalcolor-defaultopacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "NullDataVisibility": { "MarkdownDocumentation": "`NullDataVisibility`\n\nThe state of visibility for null data.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcategoricalcolor.html#cfn-quicksight-analysis-geospatialcategoricalcolor-nulldatavisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullDataSettings": { "MarkdownDocumentation": "`NullDataSettings`\n\nThe null data visualization settings.\n*Required*: No\n*Type*: [GeospatialNullDataSettings](./aws-properties-quicksight-analysis-geospatialnulldatasettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcategoricalcolor.html#cfn-quicksight-analysis-geospatialcategoricalcolor-nulldatasettings", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialNullDataSettings" } } }, "AWS::QuickSight::Analysis.GeospatialCategoricalDataColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialCategoricalDataColor`\n\nThe categorical data color for a single category.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcategoricaldatacolor.html", "Properties": { "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nThe data value for the category data color.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcategoricaldatacolor.html#cfn-quicksight-analysis-geospatialcategoricaldatacolor-datavalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color and opacity values for the category data color.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcategoricaldatacolor.html#cfn-quicksight-analysis-geospatialcategoricaldatacolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialCircleRadius": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialCircleRadius`\n\nThe geospatial radius for a circle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcircleradius.html", "Properties": { "Radius": { "MarkdownDocumentation": "`Radius`\n\nThe positive value for the radius of a circle.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcircleradius.html#cfn-quicksight-analysis-geospatialcircleradius-radius", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.GeospatialCircleSymbolStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialCircleSymbolStyle`\n\nThe properties for a circle symbol style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcirclesymbolstyle.html", "Properties": { "FillColor": { "MarkdownDocumentation": "`FillColor`\n\nThe color and opacity values for the fill color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-analysis-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcirclesymbolstyle.html#cfn-quicksight-analysis-geospatialcirclesymbolstyle-fillcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" }, "StrokeWidth": { "MarkdownDocumentation": "`StrokeWidth`\n\nThe width of the stroke (border).\n*Required*: No\n*Type*: [GeospatialLineWidth](./aws-properties-quicksight-analysis-geospatiallinewidth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcirclesymbolstyle.html#cfn-quicksight-analysis-geospatialcirclesymbolstyle-strokewidth", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineWidth" }, "StrokeColor": { "MarkdownDocumentation": "`StrokeColor`\n\nThe color and opacity values for the stroke color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-analysis-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcirclesymbolstyle.html#cfn-quicksight-analysis-geospatialcirclesymbolstyle-strokecolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" }, "CircleRadius": { "MarkdownDocumentation": "`CircleRadius`\n\nThe radius of the circle.\n*Required*: No\n*Type*: [GeospatialCircleRadius](./aws-properties-quicksight-analysis-geospatialcircleradius.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcirclesymbolstyle.html#cfn-quicksight-analysis-geospatialcirclesymbolstyle-circleradius", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCircleRadius" } } }, "AWS::QuickSight::Analysis.GeospatialColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialColor`\n\nThe visualization properties for solid, gradient, and categorical colors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcolor.html", "Properties": { "Gradient": { "MarkdownDocumentation": "`Gradient`\n\nThe visualization properties for the gradient color.\n*Required*: No\n*Type*: [GeospatialGradientColor](./aws-properties-quicksight-analysis-geospatialgradientcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcolor.html#cfn-quicksight-analysis-geospatialcolor-gradient", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialGradientColor" }, "Categorical": { "MarkdownDocumentation": "`Categorical`\n\nThe visualization properties for the categorical color.\n*Required*: No\n*Type*: [GeospatialCategoricalColor](./aws-properties-quicksight-analysis-geospatialcategoricalcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcolor.html#cfn-quicksight-analysis-geospatialcolor-categorical", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCategoricalColor" }, "Solid": { "MarkdownDocumentation": "`Solid`\n\nThe visualization properties for the solid color.\n*Required*: No\n*Type*: [GeospatialSolidColor](./aws-properties-quicksight-analysis-geospatialsolidcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcolor.html#cfn-quicksight-analysis-geospatialcolor-solid", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialSolidColor" } } }, "AWS::QuickSight::Analysis.GeospatialCoordinateBounds": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialCoordinateBounds`\n\nThe bound\noptions (north, south, west, east) of the geospatial window options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcoordinatebounds.html", "Properties": { "West": { "MarkdownDocumentation": "`West`\n\nThe longitude of the west bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-1800`\n*Maximum*: `1800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcoordinatebounds.html#cfn-quicksight-analysis-geospatialcoordinatebounds-west", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "South": { "MarkdownDocumentation": "`South`\n\nThe latitude of the south bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-90`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcoordinatebounds.html#cfn-quicksight-analysis-geospatialcoordinatebounds-south", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "North": { "MarkdownDocumentation": "`North`\n\nThe latitude of the north bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-90`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcoordinatebounds.html#cfn-quicksight-analysis-geospatialcoordinatebounds-north", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "East": { "MarkdownDocumentation": "`East`\n\nThe longitude of the east bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-1800`\n*Maximum*: `1800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialcoordinatebounds.html#cfn-quicksight-analysis-geospatialcoordinatebounds-east", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.GeospatialDataSourceItem": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialDataSourceItem`\n\nThe data source properties for the geospatial data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialdatasourceitem.html", "Properties": { "StaticFileDataSource": { "MarkdownDocumentation": "`StaticFileDataSource`\n\nThe static file data source properties for the geospatial data.\n*Required*: No\n*Type*: [GeospatialStaticFileSource](./aws-properties-quicksight-analysis-geospatialstaticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialdatasourceitem.html#cfn-quicksight-analysis-geospatialdatasourceitem-staticfiledatasource", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialStaticFileSource" } } }, "AWS::QuickSight::Analysis.GeospatialGradientColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialGradientColor`\n\nThe definition for a gradient color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialgradientcolor.html", "Properties": { "DefaultOpacity": { "MarkdownDocumentation": "`DefaultOpacity`\n\nThe default opacity for the gradient color.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialgradientcolor.html#cfn-quicksight-analysis-geospatialgradientcolor-defaultopacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StepColors": { "MarkdownDocumentation": "`StepColors`\n\nA list of gradient step colors for the gradient.\n*Required*: Yes\n*Type*: Array of [GeospatialGradientStepColor](./aws-properties-quicksight-analysis-geospatialgradientstepcolor.html)\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialgradientcolor.html#cfn-quicksight-analysis-geospatialgradientcolor-stepcolors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GeospatialGradientStepColor", "DuplicatesAllowed": true }, "NullDataVisibility": { "MarkdownDocumentation": "`NullDataVisibility`\n\nThe state of visibility for null data.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialgradientcolor.html#cfn-quicksight-analysis-geospatialgradientcolor-nulldatavisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullDataSettings": { "MarkdownDocumentation": "`NullDataSettings`\n\nThe null data visualization settings.\n*Required*: No\n*Type*: [GeospatialNullDataSettings](./aws-properties-quicksight-analysis-geospatialnulldatasettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialgradientcolor.html#cfn-quicksight-analysis-geospatialgradientcolor-nulldatasettings", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialNullDataSettings" } } }, "AWS::QuickSight::Analysis.GeospatialGradientStepColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialGradientStepColor`\n\nThe gradient step color for a single step.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialgradientstepcolor.html", "Properties": { "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nThe data value for the gradient step color.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialgradientstepcolor.html#cfn-quicksight-analysis-geospatialgradientstepcolor-datavalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color and opacity values for the gradient step color.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialgradientstepcolor.html#cfn-quicksight-analysis-geospatialgradientstepcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialHeatmapColorScale": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialHeatmapColorScale`\n\nThe color scale specification for the heatmap point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialheatmapcolorscale.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe list of colors to be used in heatmap point style.\n*Required*: No\n*Type*: Array of [GeospatialHeatmapDataColor](./aws-properties-quicksight-analysis-geospatialheatmapdatacolor.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialheatmapcolorscale.html#cfn-quicksight-analysis-geospatialheatmapcolorscale-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GeospatialHeatmapDataColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GeospatialHeatmapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialHeatmapConfiguration`\n\nThe heatmap configuration of the geospatial point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialheatmapconfiguration.html", "Properties": { "HeatmapColor": { "MarkdownDocumentation": "`HeatmapColor`\n\nThe color scale specification for the heatmap point style.\n*Required*: No\n*Type*: [GeospatialHeatmapColorScale](./aws-properties-quicksight-analysis-geospatialheatmapcolorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialheatmapconfiguration.html#cfn-quicksight-analysis-geospatialheatmapconfiguration-heatmapcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialHeatmapColorScale" } } }, "AWS::QuickSight::Analysis.GeospatialHeatmapDataColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialHeatmapDataColor`\n\nThe color to be used in the heatmap point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialheatmapdatacolor.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe hex color to be used in the heatmap point style.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialheatmapdatacolor.html#cfn-quicksight-analysis-geospatialheatmapdatacolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialLayerColorField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLayerColorField`\n\nThe color field that defines a gradient or categorical style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayercolorfield.html", "Properties": { "ColorValuesFields": { "MarkdownDocumentation": "`ColorValuesFields`\n\nA list of color measure fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayercolorfield.html#cfn-quicksight-analysis-geospatiallayercolorfield-colorvaluesfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "ColorDimensionsFields": { "MarkdownDocumentation": "`ColorDimensionsFields`\n\nA list of color dimension fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayercolorfield.html#cfn-quicksight-analysis-geospatiallayercolorfield-colordimensionsfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GeospatialLayerDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLayerDefinition`\n\nThe definition properties for a geospatial layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayerdefinition.html", "Properties": { "PointLayer": { "MarkdownDocumentation": "`PointLayer`\n\nThe definition for a point layer.\n*Required*: No\n*Type*: [GeospatialPointLayer](./aws-properties-quicksight-analysis-geospatialpointlayer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayerdefinition.html#cfn-quicksight-analysis-geospatiallayerdefinition-pointlayer", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPointLayer" }, "PolygonLayer": { "MarkdownDocumentation": "`PolygonLayer`\n\nThe definition for a polygon layer.\n*Required*: No\n*Type*: [GeospatialPolygonLayer](./aws-properties-quicksight-analysis-geospatialpolygonlayer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayerdefinition.html#cfn-quicksight-analysis-geospatiallayerdefinition-polygonlayer", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPolygonLayer" }, "LineLayer": { "MarkdownDocumentation": "`LineLayer`\n\nThe definition for a line layer.\n*Required*: No\n*Type*: [GeospatialLineLayer](./aws-properties-quicksight-analysis-geospatiallinelayer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayerdefinition.html#cfn-quicksight-analysis-geospatiallayerdefinition-linelayer", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineLayer" } } }, "AWS::QuickSight::Analysis.GeospatialLayerItem": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLayerItem`\n\nThe properties for a single geospatial layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html", "Properties": { "LayerId": { "MarkdownDocumentation": "`LayerId`\n\nThe ID of the layer.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-layerid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "JoinDefinition": { "MarkdownDocumentation": "`JoinDefinition`\n\nThe join definition properties for a layer.\n*Required*: No\n*Type*: [GeospatialLayerJoinDefinition](./aws-properties-quicksight-analysis-geospatiallayerjoindefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-joindefinition", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLayerJoinDefinition" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nA list of custom actions for a layer.\n*Required*: No\n*Type*: Array of [LayerCustomAction](./aws-properties-quicksight-analysis-layercustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LayerCustomAction", "DuplicatesAllowed": true }, "LayerType": { "MarkdownDocumentation": "`LayerType`\n\nThe layer type.\n*Required*: No\n*Type*: String\n*Allowed values*: `POINT | LINE | POLYGON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POINT", "LINE", "POLYGON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-layertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LayerDefinition": { "MarkdownDocumentation": "`LayerDefinition`\n\nThe definition properties for a layer.\n*Required*: No\n*Type*: [GeospatialLayerDefinition](./aws-properties-quicksight-analysis-geospatiallayerdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-layerdefinition", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLayerDefinition" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nProperty description not available.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label that is displayed for the layer.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe state of visibility for the layer.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nThe data source for the layer.\n*Required*: No\n*Type*: [GeospatialDataSourceItem](./aws-properties-quicksight-analysis-geospatialdatasourceitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayeritem.html#cfn-quicksight-analysis-geospatiallayeritem-datasource", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialDataSourceItem" } } }, "AWS::QuickSight::Analysis.GeospatialLayerJoinDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLayerJoinDefinition`\n\nThe custom actions for a layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayerjoindefinition.html", "Properties": { "ColorField": { "MarkdownDocumentation": "`ColorField`\n\nThe geospatial color field for the join definition.\n*Required*: No\n*Type*: [GeospatialLayerColorField](./aws-properties-quicksight-analysis-geospatiallayercolorfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayerjoindefinition.html#cfn-quicksight-analysis-geospatiallayerjoindefinition-colorfield", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLayerColorField" }, "ShapeKeyField": { "MarkdownDocumentation": "`ShapeKeyField`\n\nThe name of the field or property in the geospatial 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayerjoindefinition.html#cfn-quicksight-analysis-geospatiallayerjoindefinition-shapekeyfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatasetKeyField": { "MarkdownDocumentation": "`DatasetKeyField`\n\nProperty description not available.\n*Required*: No\n*Type*: [UnaggregatedField](./aws-properties-quicksight-analysis-unaggregatedfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayerjoindefinition.html#cfn-quicksight-analysis-geospatiallayerjoindefinition-datasetkeyfield", "UpdateType": "Mutable", "Required": false, "Type": "UnaggregatedField" } } }, "AWS::QuickSight::Analysis.GeospatialLayerMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLayerMapConfiguration`\n\nThe map definition that defines map state, map style, and geospatial layers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayermapconfiguration.html", "Properties": { "Legend": { "MarkdownDocumentation": "`Legend`\n\nProperty description not available.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayermapconfiguration.html#cfn-quicksight-analysis-geospatiallayermapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "MapState": { "MarkdownDocumentation": "`MapState`\n\nThe map state properties for the map.\n*Required*: No\n*Type*: [GeospatialMapState](./aws-properties-quicksight-analysis-geospatialmapstate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayermapconfiguration.html#cfn-quicksight-analysis-geospatiallayermapconfiguration-mapstate", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapState" }, "MapStyle": { "MarkdownDocumentation": "`MapStyle`\n\nThe map style properties for the map.\n*Required*: No\n*Type*: [GeospatialMapStyle](./aws-properties-quicksight-analysis-geospatialmapstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayermapconfiguration.html#cfn-quicksight-analysis-geospatiallayermapconfiguration-mapstyle", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapStyle" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayermapconfiguration.html#cfn-quicksight-analysis-geospatiallayermapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "MapLayers": { "MarkdownDocumentation": "`MapLayers`\n\nThe geospatial layers to visualize on the map.\n*Required*: No\n*Type*: Array of [GeospatialLayerItem](./aws-properties-quicksight-analysis-geospatiallayeritem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallayermapconfiguration.html#cfn-quicksight-analysis-geospatiallayermapconfiguration-maplayers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GeospatialLayerItem", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GeospatialLineLayer": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLineLayer`\n\nThe geospatial Line layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinelayer.html", "Properties": { "Style": { "MarkdownDocumentation": "`Style`\n\nThe visualization style for a line layer.\n*Required*: Yes\n*Type*: [GeospatialLineStyle](./aws-properties-quicksight-analysis-geospatiallinestyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinelayer.html#cfn-quicksight-analysis-geospatiallinelayer-style", "UpdateType": "Mutable", "Required": true, "Type": "GeospatialLineStyle" } } }, "AWS::QuickSight::Analysis.GeospatialLineStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLineStyle`\n\nThe visualization style for a line layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinestyle.html", "Properties": { "LineSymbolStyle": { "MarkdownDocumentation": "`LineSymbolStyle`\n\nThe symbol style for a line style.\n*Required*: No\n*Type*: [GeospatialLineSymbolStyle](./aws-properties-quicksight-analysis-geospatiallinesymbolstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinestyle.html#cfn-quicksight-analysis-geospatiallinestyle-linesymbolstyle", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineSymbolStyle" } } }, "AWS::QuickSight::Analysis.GeospatialLineSymbolStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLineSymbolStyle`\n\nThe symbol style for a line layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinesymbolstyle.html", "Properties": { "FillColor": { "MarkdownDocumentation": "`FillColor`\n\nThe color and opacity values for the fill color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-analysis-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinesymbolstyle.html#cfn-quicksight-analysis-geospatiallinesymbolstyle-fillcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" }, "LineWidth": { "MarkdownDocumentation": "`LineWidth`\n\nThe width value for a line.\n*Required*: No\n*Type*: [GeospatialLineWidth](./aws-properties-quicksight-analysis-geospatiallinewidth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinesymbolstyle.html#cfn-quicksight-analysis-geospatiallinesymbolstyle-linewidth", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineWidth" } } }, "AWS::QuickSight::Analysis.GeospatialLineWidth": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialLineWidth`\n\nThe width properties for a line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinewidth.html", "Properties": { "LineWidth": { "MarkdownDocumentation": "`LineWidth`\n\nThe positive value for the width of a line.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatiallinewidth.html#cfn-quicksight-analysis-geospatiallinewidth-linewidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.GeospatialMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialMapAggregatedFieldWells`\n\nThe aggregated field wells for a geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapaggregatedfieldwells.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field wells of a geospatial map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapaggregatedfieldwells.html#cfn-quicksight-analysis-geospatialmapaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe size field wells of a geospatial map. Values are aggregated based on geospatial fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapaggregatedfieldwells.html#cfn-quicksight-analysis-geospatialmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Geospatial": { "MarkdownDocumentation": "`Geospatial`\n\nThe geospatial field wells of a geospatial map. Values are grouped by geospatial fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapaggregatedfieldwells.html#cfn-quicksight-analysis-geospatialmapaggregatedfieldwells-geospatial", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GeospatialMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialMapConfiguration`\n\nThe configuration of a `GeospatialMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html", "Properties": { "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html#cfn-quicksight-analysis-geospatialmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "MapStyleOptions": { "MarkdownDocumentation": "`MapStyleOptions`\n\nThe map style options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialMapStyleOptions](./aws-properties-quicksight-analysis-geospatialmapstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html#cfn-quicksight-analysis-geospatialmapconfiguration-mapstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapStyleOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [GeospatialMapFieldWells](./aws-properties-quicksight-analysis-geospatialmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html#cfn-quicksight-analysis-geospatialmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html#cfn-quicksight-analysis-geospatialmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html#cfn-quicksight-analysis-geospatialmapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "WindowOptions": { "MarkdownDocumentation": "`WindowOptions`\n\nThe window options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialWindowOptions](./aws-properties-quicksight-analysis-geospatialwindowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html#cfn-quicksight-analysis-geospatialmapconfiguration-windowoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialWindowOptions" }, "PointStyleOptions": { "MarkdownDocumentation": "`PointStyleOptions`\n\nThe point style options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialPointStyleOptions](./aws-properties-quicksight-analysis-geospatialpointstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html#cfn-quicksight-analysis-geospatialmapconfiguration-pointstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPointStyleOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapconfiguration.html#cfn-quicksight-analysis-geospatialmapconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Analysis.GeospatialMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialMapFieldWells`\n\nThe field wells of a `GeospatialMapVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapfieldwells.html", "Properties": { "GeospatialMapAggregatedFieldWells": { "MarkdownDocumentation": "`GeospatialMapAggregatedFieldWells`\n\nThe aggregated field well for a geospatial map.\n*Required*: No\n*Type*: [GeospatialMapAggregatedFieldWells](./aws-properties-quicksight-analysis-geospatialmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapfieldwells.html#cfn-quicksight-analysis-geospatialmapfieldwells-geospatialmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.GeospatialMapState": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialMapState`\n\nThe map state properties for a map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstate.html", "Properties": { "Bounds": { "MarkdownDocumentation": "`Bounds`\n\nProperty description not available.\n*Required*: No\n*Type*: [GeospatialCoordinateBounds](./aws-properties-quicksight-analysis-geospatialcoordinatebounds.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstate.html#cfn-quicksight-analysis-geospatialmapstate-bounds", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCoordinateBounds" }, "MapNavigation": { "MarkdownDocumentation": "`MapNavigation`\n\nEnables or disables map navigation for a map.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstate.html#cfn-quicksight-analysis-geospatialmapstate-mapnavigation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialMapStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialMapStyle`\n\nThe map style properties for a map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstyle.html", "Properties": { "BaseMapStyle": { "MarkdownDocumentation": "`BaseMapStyle`\n\nThe selected base map style.\n*Required*: No\n*Type*: String\n*Allowed values*: `LIGHT_GRAY | DARK_GRAY | ST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LIGHT_GRAY", "DARK_GRAY", "STREET", "IMAGERY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstyle.html#cfn-quicksight-analysis-geospatialmapstyle-basemapstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseMapVisibility": { "MarkdownDocumentation": "`BaseMapVisibility`\n\nThe state of visibility for the base map.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstyle.html#cfn-quicksight-analysis-geospatialmapstyle-basemapvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color and opacity values for a map.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstyle.html#cfn-quicksight-analysis-geospatialmapstyle-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialMapStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialMapStyleOptions`\n\nThe map style options of the geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstyleoptions.html", "Properties": { "BaseMapStyle": { "MarkdownDocumentation": "`BaseMapStyle`\n\nThe base map style of the geospatial map.\n*Required*: No\n*Type*: String\n*Allowed values*: `LIGHT_GRAY | DARK_GRAY | ST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LIGHT_GRAY", "DARK_GRAY", "STREET", "IMAGERY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapstyleoptions.html#cfn-quicksight-analysis-geospatialmapstyleoptions-basemapstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialMapVisual`\n\nA geospatial map or a points on map visual.\nFor more information, see [Creating point maps](https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapvisual.html#cfn-quicksight-analysis-geospatialmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapvisual.html#cfn-quicksight-analysis-geospatialmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [GeospatialMapConfiguration](./aws-properties-quicksight-analysis-geospatialmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapvisual.html#cfn-quicksight-analysis-geospatialmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapvisual.html#cfn-quicksight-analysis-geospatialmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapvisual.html#cfn-quicksight-analysis-geospatialmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapvisual.html#cfn-quicksight-analysis-geospatialmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialmapvisual.html#cfn-quicksight-analysis-geospatialmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GeospatialNullDataSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialNullDataSettings`\n\nThe properties for the visualization of null data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialnulldatasettings.html", "Properties": { "SymbolStyle": { "MarkdownDocumentation": "`SymbolStyle`\n\nThe symbol style for null data.\n*Required*: Yes\n*Type*: [GeospatialNullSymbolStyle](./aws-properties-quicksight-analysis-geospatialnullsymbolstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialnulldatasettings.html#cfn-quicksight-analysis-geospatialnulldatasettings-symbolstyle", "UpdateType": "Mutable", "Required": true, "Type": "GeospatialNullSymbolStyle" } } }, "AWS::QuickSight::Analysis.GeospatialNullSymbolStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialNullSymbolStyle`\n\nThe symbol style for null data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialnullsymbolstyle.html", "Properties": { "FillColor": { "MarkdownDocumentation": "`FillColor`\n\nThe color and opacity values for the fill color.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialnullsymbolstyle.html#cfn-quicksight-analysis-geospatialnullsymbolstyle-fillcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StrokeWidth": { "MarkdownDocumentation": "`StrokeWidth`\n\nThe width of the border stroke.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialnullsymbolstyle.html#cfn-quicksight-analysis-geospatialnullsymbolstyle-strokewidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StrokeColor": { "MarkdownDocumentation": "`StrokeColor`\n\nThe color and opacity values for the stroke color.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialnullsymbolstyle.html#cfn-quicksight-analysis-geospatialnullsymbolstyle-strokecolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialPointLayer": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialPointLayer`\n\nThe geospatial Point layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpointlayer.html", "Properties": { "Style": { "MarkdownDocumentation": "`Style`\n\nThe visualization style for a point layer.\n*Required*: Yes\n*Type*: [GeospatialPointStyle](./aws-properties-quicksight-analysis-geospatialpointstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpointlayer.html#cfn-quicksight-analysis-geospatialpointlayer-style", "UpdateType": "Mutable", "Required": true, "Type": "GeospatialPointStyle" } } }, "AWS::QuickSight::Analysis.GeospatialPointStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialPointStyle`\n\nThe point style for a point layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpointstyle.html", "Properties": { "CircleSymbolStyle": { "MarkdownDocumentation": "`CircleSymbolStyle`\n\nThe circle symbol style for a point layer.\n*Required*: No\n*Type*: [GeospatialCircleSymbolStyle](./aws-properties-quicksight-analysis-geospatialcirclesymbolstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpointstyle.html#cfn-quicksight-analysis-geospatialpointstyle-circlesymbolstyle", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCircleSymbolStyle" } } }, "AWS::QuickSight::Analysis.GeospatialPointStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialPointStyleOptions`\n\nThe point style of the geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpointstyleoptions.html", "Properties": { "SelectedPointStyle": { "MarkdownDocumentation": "`SelectedPointStyle`\n\nThe selected point styles (point, cluster) of the geospatial map.\n*Required*: No\n*Type*: String\n*Allowed values*: `POINT | CLUSTER | HEATMAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POINT", "CLUSTER", "HEATMAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpointstyleoptions.html#cfn-quicksight-analysis-geospatialpointstyleoptions-selectedpointstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterMarkerConfiguration": { "MarkdownDocumentation": "`ClusterMarkerConfiguration`\n\nThe cluster marker configuration of the geospatial point style.\n*Required*: No\n*Type*: [ClusterMarkerConfiguration](./aws-properties-quicksight-analysis-clustermarkerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpointstyleoptions.html#cfn-quicksight-analysis-geospatialpointstyleoptions-clustermarkerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ClusterMarkerConfiguration" }, "HeatmapConfiguration": { "MarkdownDocumentation": "`HeatmapConfiguration`\n\nThe heatmap configuration of the geospatial point style.\n*Required*: No\n*Type*: [GeospatialHeatmapConfiguration](./aws-properties-quicksight-analysis-geospatialheatmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpointstyleoptions.html#cfn-quicksight-analysis-geospatialpointstyleoptions-heatmapconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialHeatmapConfiguration" } } }, "AWS::QuickSight::Analysis.GeospatialPolygonLayer": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialPolygonLayer`\n\nThe geospatial polygon layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpolygonlayer.html", "Properties": { "Style": { "MarkdownDocumentation": "`Style`\n\nThe visualization style for a polygon layer.\n*Required*: Yes\n*Type*: [GeospatialPolygonStyle](./aws-properties-quicksight-analysis-geospatialpolygonstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpolygonlayer.html#cfn-quicksight-analysis-geospatialpolygonlayer-style", "UpdateType": "Mutable", "Required": true, "Type": "GeospatialPolygonStyle" } } }, "AWS::QuickSight::Analysis.GeospatialPolygonStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialPolygonStyle`\n\nThe polygon style for a polygon layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpolygonstyle.html", "Properties": { "PolygonSymbolStyle": { "MarkdownDocumentation": "`PolygonSymbolStyle`\n\nThe polygon symbol style for a polygon layer.\n*Required*: No\n*Type*: [GeospatialPolygonSymbolStyle](./aws-properties-quicksight-analysis-geospatialpolygonsymbolstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpolygonstyle.html#cfn-quicksight-analysis-geospatialpolygonstyle-polygonsymbolstyle", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPolygonSymbolStyle" } } }, "AWS::QuickSight::Analysis.GeospatialPolygonSymbolStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialPolygonSymbolStyle`\n\nThe polygon symbol style for a polygon layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpolygonsymbolstyle.html", "Properties": { "FillColor": { "MarkdownDocumentation": "`FillColor`\n\nThe color and opacity values for the fill color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-analysis-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpolygonsymbolstyle.html#cfn-quicksight-analysis-geospatialpolygonsymbolstyle-fillcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" }, "StrokeWidth": { "MarkdownDocumentation": "`StrokeWidth`\n\nThe width of the border stroke.\n*Required*: No\n*Type*: [GeospatialLineWidth](./aws-properties-quicksight-analysis-geospatiallinewidth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpolygonsymbolstyle.html#cfn-quicksight-analysis-geospatialpolygonsymbolstyle-strokewidth", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineWidth" }, "StrokeColor": { "MarkdownDocumentation": "`StrokeColor`\n\nThe color and opacity values for the stroke color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-analysis-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialpolygonsymbolstyle.html#cfn-quicksight-analysis-geospatialpolygonsymbolstyle-strokecolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" } } }, "AWS::QuickSight::Analysis.GeospatialSolidColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialSolidColor`\n\nThe definition for a solid color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialsolidcolor.html", "Properties": { "State": { "MarkdownDocumentation": "`State`\n\nEnables and disables the view state of the color.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialsolidcolor.html#cfn-quicksight-analysis-geospatialsolidcolor-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color and opacity values for the color.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialsolidcolor.html#cfn-quicksight-analysis-geospatialsolidcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialStaticFileSource": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialStaticFileSource`\n\nThe source properties for a geospatial static file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialstaticfilesource.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the static file.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialstaticfilesource.html#cfn-quicksight-analysis-geospatialstaticfilesource-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GeospatialWindowOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GeospatialWindowOptions`\n\nThe window options of the geospatial map visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialwindowoptions.html", "Properties": { "Bounds": { "MarkdownDocumentation": "`Bounds`\n\nThe bounds options (north, south, west, east) of the geospatial window options.\n*Required*: No\n*Type*: [GeospatialCoordinateBounds](./aws-properties-quicksight-analysis-geospatialcoordinatebounds.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialwindowoptions.html#cfn-quicksight-analysis-geospatialwindowoptions-bounds", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCoordinateBounds" }, "MapZoomMode": { "MarkdownDocumentation": "`MapZoomMode`\n\nThe map zoom modes (manual, auto) of the geospatial window options.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-geospatialwindowoptions.html#cfn-quicksight-analysis-geospatialwindowoptions-mapzoommode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GlobalTableBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GlobalTableBorderOptions`\n\nDetermines the border options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-globaltableborderoptions.html", "Properties": { "UniformBorder": { "MarkdownDocumentation": "`UniformBorder`\n\nDetermines the options for uniform border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-analysis-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-globaltableborderoptions.html#cfn-quicksight-analysis-globaltableborderoptions-uniformborder", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "SideSpecificBorder": { "MarkdownDocumentation": "`SideSpecificBorder`\n\nDetermines the options for side specific border.\n*Required*: No\n*Type*: [TableSideBorderOptions](./aws-properties-quicksight-analysis-tablesideborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-globaltableborderoptions.html#cfn-quicksight-analysis-globaltableborderoptions-sidespecificborder", "UpdateType": "Mutable", "Required": false, "Type": "TableSideBorderOptions" } } }, "AWS::QuickSight::Analysis.GradientColor": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GradientColor`\n\nDetermines the gradient color settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gradientcolor.html", "Properties": { "Stops": { "MarkdownDocumentation": "`Stops`\n\nThe list of gradient color stops.\n*Required*: No\n*Type*: Array of [GradientStop](./aws-properties-quicksight-analysis-gradientstop.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gradientcolor.html#cfn-quicksight-analysis-gradientcolor-stops", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GradientStop", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GradientStop": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GradientStop`\n\nDetermines the gradient stop configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gradientstop.html", "Properties": { "GradientOffset": { "MarkdownDocumentation": "`GradientOffset`\n\nDetermines gradient offset value.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gradientstop.html#cfn-quicksight-analysis-gradientstop-gradientoffset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nDetermines the data value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gradientstop.html#cfn-quicksight-analysis-gradientstop-datavalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gradientstop.html#cfn-quicksight-analysis-gradientstop-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GridLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GridLayoutCanvasSizeOptions`\n\nConfiguration options for the canvas of a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutcanvassizeoptions.html", "Properties": { "ScreenCanvasSizeOptions": { "MarkdownDocumentation": "`ScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a grid layout.\n*Required*: No\n*Type*: [GridLayoutScreenCanvasSizeOptions](./aws-properties-quicksight-analysis-gridlayoutscreencanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutcanvassizeoptions.html#cfn-quicksight-analysis-gridlayoutcanvassizeoptions-screencanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutScreenCanvasSizeOptions" } } }, "AWS::QuickSight::Analysis.GridLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GridLayoutConfiguration`\n\nThe configuration for a grid layout. Also called a tiled layout.\nVisuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [GridLayoutCanvasSizeOptions](./aws-properties-quicksight-analysis-gridlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutconfiguration.html#cfn-quicksight-analysis-gridlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutCanvasSizeOptions" }, "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in a grid layout.\n*Required*: Yes\n*Type*: Array of [GridLayoutElement](./aws-properties-quicksight-analysis-gridlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutconfiguration.html#cfn-quicksight-analysis-gridlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GridLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.GridLayoutElement": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GridLayoutElement`\n\nAn element within a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutelement.html", "Properties": { "ElementType": { "MarkdownDocumentation": "`ElementType`\n\nThe type of element.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VISUAL | FILTER_CONTROL | P...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VISUAL", "FILTER_CONTROL", "PARAMETER_CONTROL", "TEXT_BOX", "IMAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutelement.html#cfn-quicksight-analysis-gridlayoutelement-elementtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnSpan": { "MarkdownDocumentation": "`ColumnSpan`\n\nThe width of a grid element expressed as a number of grid columns.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutelement.html#cfn-quicksight-analysis-gridlayoutelement-columnspan", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "ColumnIndex": { "MarkdownDocumentation": "`ColumnIndex`\n\nThe column index for the upper left corner of an element.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `35`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutelement.html#cfn-quicksight-analysis-gridlayoutelement-columnindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "RowIndex": { "MarkdownDocumentation": "`RowIndex`\n\nThe row index for the upper left corner of an element.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `9009`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutelement.html#cfn-quicksight-analysis-gridlayoutelement-rowindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "RowSpan": { "MarkdownDocumentation": "`RowSpan`\n\nThe height of a grid element expressed as a number of grid rows.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `21`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutelement.html#cfn-quicksight-analysis-gridlayoutelement-rowspan", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "ElementId": { "MarkdownDocumentation": "`ElementId`\n\nA unique identifier for an element within a grid layout.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutelement.html#cfn-quicksight-analysis-gridlayoutelement-elementid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GridLayoutScreenCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GridLayoutScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutscreencanvassizeoptions.html", "Properties": { "OptimizedViewPortWidth": { "MarkdownDocumentation": "`OptimizedViewPortWidth`\n\nThe width that the view port will be optimized for when the layout renders.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-analysis-gridlayoutscreencanvassizeoptions-optimizedviewportwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResizeOption": { "MarkdownDocumentation": "`ResizeOption`\n\nThis value determines the layout behavior when the viewport is resized.\n* `FIXED`: A fixed width will be used when optimizing the layout. In\n the Quick Sight console, this option is called `Classic`.\n* `RESPONSIVE`: The width of the canvas will be responsive and\n optimized to the view port. In the Quick Sight console, this option is called `Tiled`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIXED | RESPONSIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIXED", "RESPONSIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-analysis-gridlayoutscreencanvassizeoptions-resizeoption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.GrowthRateComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.GrowthRateComputation`\n\nThe growth rate computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-growthratecomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-growthratecomputation.html#cfn-quicksight-analysis-growthratecomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-growthratecomputation.html#cfn-quicksight-analysis-growthratecomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "PeriodSize": { "MarkdownDocumentation": "`PeriodSize`\n\nThe period size setup of a growth rate computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `2`\n*Maximum*: `52`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-growthratecomputation.html#cfn-quicksight-analysis-growthratecomputation-periodsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-growthratecomputation.html#cfn-quicksight-analysis-growthratecomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-growthratecomputation.html#cfn-quicksight-analysis-growthratecomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.HeaderFooterSectionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HeaderFooterSectionConfiguration`\n\nThe configuration of a header or footer section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-headerfootersectionconfiguration.html", "Properties": { "Layout": { "MarkdownDocumentation": "`Layout`\n\nThe layout configuration of the header or footer section.\n*Required*: Yes\n*Type*: [SectionLayoutConfiguration](./aws-properties-quicksight-analysis-sectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-headerfootersectionconfiguration.html#cfn-quicksight-analysis-headerfootersectionconfiguration-layout", "UpdateType": "Mutable", "Required": true, "Type": "SectionLayoutConfiguration" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style options of a header or footer section.\n*Required*: No\n*Type*: [SectionStyle](./aws-properties-quicksight-analysis-sectionstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-headerfootersectionconfiguration.html#cfn-quicksight-analysis-headerfootersectionconfiguration-style", "UpdateType": "Mutable", "Required": false, "Type": "SectionStyle" }, "SectionId": { "MarkdownDocumentation": "`SectionId`\n\nThe unique identifier of the header or footer section.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-headerfootersectionconfiguration.html#cfn-quicksight-analysis-headerfootersectionconfiguration-sectionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.HeatMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HeatMapAggregatedFieldWells`\n\nThe aggregated field wells of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well of a heat map.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapaggregatedfieldwells.html#cfn-quicksight-analysis-heatmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe columns field well of a heat map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapaggregatedfieldwells.html#cfn-quicksight-analysis-heatmapaggregatedfieldwells-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Rows": { "MarkdownDocumentation": "`Rows`\n\nThe rows field well of a heat map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapaggregatedfieldwells.html#cfn-quicksight-analysis-heatmapaggregatedfieldwells-rows", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.HeatMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HeatMapConfiguration`\n\nThe configuration of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a heat map.\n*Required*: No\n*Type*: [HeatMapSortConfiguration](./aws-properties-quicksight-analysis-heatmapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapSortConfiguration" }, "ColumnLabelOptions": { "MarkdownDocumentation": "`ColumnLabelOptions`\n\nThe label options of the column that is displayed in a heat map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-columnlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [HeatMapFieldWells](./aws-properties-quicksight-analysis-heatmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "ColorScale": { "MarkdownDocumentation": "`ColorScale`\n\nThe color options (gradient color, point of divergence) in a heat map.\n*Required*: No\n*Type*: [ColorScale](./aws-properties-quicksight-analysis-colorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-colorscale", "UpdateType": "Mutable", "Required": false, "Type": "ColorScale" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "RowLabelOptions": { "MarkdownDocumentation": "`RowLabelOptions`\n\nThe label options of the row that is displayed in a `heat map`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapconfiguration.html#cfn-quicksight-analysis-heatmapconfiguration-rowlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" } } }, "AWS::QuickSight::Analysis.HeatMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HeatMapFieldWells`\n\nThe field well configuration of a heat map.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapfieldwells.html", "Properties": { "HeatMapAggregatedFieldWells": { "MarkdownDocumentation": "`HeatMapAggregatedFieldWells`\n\nThe aggregated field wells of a heat map.\n*Required*: No\n*Type*: [HeatMapAggregatedFieldWells](./aws-properties-quicksight-analysis-heatmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapfieldwells.html#cfn-quicksight-analysis-heatmapfieldwells-heatmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.HeatMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HeatMapSortConfiguration`\n\nThe sort configuration of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapsortconfiguration.html", "Properties": { "HeatMapRowSort": { "MarkdownDocumentation": "`HeatMapRowSort`\n\nThe field sort configuration of the rows fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapsortconfiguration.html#cfn-quicksight-analysis-heatmapsortconfiguration-heatmaprowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "HeatMapRowItemsLimitConfiguration": { "MarkdownDocumentation": "`HeatMapRowItemsLimitConfiguration`\n\nThe limit on the number of rows that are displayed in a heat map.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapsortconfiguration.html#cfn-quicksight-analysis-heatmapsortconfiguration-heatmaprowitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "HeatMapColumnItemsLimitConfiguration": { "MarkdownDocumentation": "`HeatMapColumnItemsLimitConfiguration`\n\nThe limit on the number of columns that are displayed in a heat map.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapsortconfiguration.html#cfn-quicksight-analysis-heatmapsortconfiguration-heatmapcolumnitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "HeatMapColumnSort": { "MarkdownDocumentation": "`HeatMapColumnSort`\n\nThe column sort configuration for heat map for columns that aren't a part of a field well.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapsortconfiguration.html#cfn-quicksight-analysis-heatmapsortconfiguration-heatmapcolumnsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.HeatMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HeatMapVisual`\n\nA heat map.\nFor more information, see [Using heat maps](https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapvisual.html#cfn-quicksight-analysis-heatmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapvisual.html#cfn-quicksight-analysis-heatmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a heat map.\n*Required*: No\n*Type*: [HeatMapConfiguration](./aws-properties-quicksight-analysis-heatmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapvisual.html#cfn-quicksight-analysis-heatmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapvisual.html#cfn-quicksight-analysis-heatmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapvisual.html#cfn-quicksight-analysis-heatmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapvisual.html#cfn-quicksight-analysis-heatmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-heatmapvisual.html#cfn-quicksight-analysis-heatmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.HistogramAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HistogramAggregatedFieldWells`\n\nThe field well configuration of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a histogram. Values are aggregated by `COUNT` or `DISTINCT_COUNT`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramaggregatedfieldwells.html#cfn-quicksight-analysis-histogramaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.HistogramBinOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HistogramBinOptions`\n\nThe options that determine the presentation of histogram bins.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogrambinoptions.html", "Properties": { "BinWidth": { "MarkdownDocumentation": "`BinWidth`\n\nThe options that determine the bin width of a histogram.\n*Required*: No\n*Type*: [BinWidthOptions](./aws-properties-quicksight-analysis-binwidthoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogrambinoptions.html#cfn-quicksight-analysis-histogrambinoptions-binwidth", "UpdateType": "Mutable", "Required": false, "Type": "BinWidthOptions" }, "StartValue": { "MarkdownDocumentation": "`StartValue`\n\nThe options that determine the bin start value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogrambinoptions.html#cfn-quicksight-analysis-histogrambinoptions-startvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "SelectedBinType": { "MarkdownDocumentation": "`SelectedBinType`\n\nThe options that determine the selected bin type.\n*Required*: No\n*Type*: String\n*Allowed values*: `BIN_COUNT | BIN_WIDTH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BIN_COUNT", "BIN_WIDTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogrambinoptions.html#cfn-quicksight-analysis-histogrambinoptions-selectedbintype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BinCount": { "MarkdownDocumentation": "`BinCount`\n\nThe options that determine the bin count of a histogram.\n*Required*: No\n*Type*: [BinCountOptions](./aws-properties-quicksight-analysis-bincountoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogrambinoptions.html#cfn-quicksight-analysis-histogrambinoptions-bincount", "UpdateType": "Mutable", "Required": false, "Type": "BinCountOptions" } } }, "AWS::QuickSight::Analysis.HistogramConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HistogramConfiguration`\n\nThe configuration for a `HistogramVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html", "Properties": { "YAxisDisplayOptions": { "MarkdownDocumentation": "`YAxisDisplayOptions`\n\nThe options that determine the presentation of the y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-yaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a histogram.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "BinOptions": { "MarkdownDocumentation": "`BinOptions`\n\nThe options that determine the presentation of histogram bins.\n*Required*: No\n*Type*: [HistogramBinOptions](./aws-properties-quicksight-analysis-histogrambinoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-binoptions", "UpdateType": "Mutable", "Required": false, "Type": "HistogramBinOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a histogram.\n*Required*: No\n*Type*: [HistogramFieldWells](./aws-properties-quicksight-analysis-histogramfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HistogramFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a histogram.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe options that determine the presentation of the x-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a histogram.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe options that determine the presentation of the x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramconfiguration.html#cfn-quicksight-analysis-histogramconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Analysis.HistogramFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HistogramFieldWells`\n\nThe field well configuration of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramfieldwells.html", "Properties": { "HistogramAggregatedFieldWells": { "MarkdownDocumentation": "`HistogramAggregatedFieldWells`\n\nThe field well configuration of a histogram.\n*Required*: No\n*Type*: [HistogramAggregatedFieldWells](./aws-properties-quicksight-analysis-histogramaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramfieldwells.html#cfn-quicksight-analysis-histogramfieldwells-histogramaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HistogramAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.HistogramVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.HistogramVisual`\n\nA histogram.\nFor more information, see [Using histograms](https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramvisual.html#cfn-quicksight-analysis-histogramvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramvisual.html#cfn-quicksight-analysis-histogramvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration for a `HistogramVisual`.\n*Required*: No\n*Type*: [HistogramConfiguration](./aws-properties-quicksight-analysis-histogramconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramvisual.html#cfn-quicksight-analysis-histogramvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HistogramConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramvisual.html#cfn-quicksight-analysis-histogramvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramvisual.html#cfn-quicksight-analysis-histogramvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-histogramvisual.html#cfn-quicksight-analysis-histogramvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ImageCustomAction": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ImageCustomAction`\n\nA custom action defined on an image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the custom action.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomaction.html#cfn-quicksight-analysis-imagecustomaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trigger": { "MarkdownDocumentation": "`Trigger`\n\nThe trigger of the `VisualCustomAction`.\nValid values are defined as follows:\n* `CLICK`: Initiates a custom action by a left pointer click on a data point.\n* `MENU`: Initiates a custom action by right pointer click from the menu.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLICK | MENU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLICK", "MENU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomaction.html#cfn-quicksight-analysis-imagecustomaction-trigger", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomActionId": { "MarkdownDocumentation": "`CustomActionId`\n\nThe ID of the custom action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomaction.html#cfn-quicksight-analysis-imagecustomaction-customactionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the custom action.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomaction.html#cfn-quicksight-analysis-imagecustomaction-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionOperations": { "MarkdownDocumentation": "`ActionOperations`\n\nA list of `ImageCustomActionOperations`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: Array of [ImageCustomActionOperation](./aws-properties-quicksight-analysis-imagecustomactionoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomaction.html#cfn-quicksight-analysis-imagecustomaction-actionoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ImageCustomActionOperation", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ImageCustomActionOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ImageCustomActionOperation`\n\nThe operation that is defined by the custom action.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomactionoperation.html", "Properties": { "NavigationOperation": { "MarkdownDocumentation": "`NavigationOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionNavigationOperation](./aws-properties-quicksight-analysis-customactionnavigationoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomactionoperation.html#cfn-quicksight-analysis-imagecustomactionoperation-navigationoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionNavigationOperation" }, "SetParametersOperation": { "MarkdownDocumentation": "`SetParametersOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionSetParametersOperation](./aws-properties-quicksight-analysis-customactionsetparametersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomactionoperation.html#cfn-quicksight-analysis-imagecustomactionoperation-setparametersoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionSetParametersOperation" }, "URLOperation": { "MarkdownDocumentation": "`URLOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionURLOperation](./aws-properties-quicksight-analysis-customactionurloperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagecustomactionoperation.html#cfn-quicksight-analysis-imagecustomactionoperation-urloperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionURLOperation" } } }, "AWS::QuickSight::Analysis.ImageInteractionOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ImageInteractionOptions`\n\nThe general image interactions setup for image publish options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imageinteractionoptions.html", "Properties": { "ImageMenuOption": { "MarkdownDocumentation": "`ImageMenuOption`\n\nThe menu options for the image.\n*Required*: No\n*Type*: [ImageMenuOption](./aws-properties-quicksight-analysis-imagemenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imageinteractionoptions.html#cfn-quicksight-analysis-imageinteractionoptions-imagemenuoption", "UpdateType": "Mutable", "Required": false, "Type": "ImageMenuOption" } } }, "AWS::QuickSight::Analysis.ImageMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ImageMenuOption`\n\nThe menu options for the interactions of an image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagemenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availability status of the image menu. If the value of this property is set to `ENABLED`, dashboard readers can interact with the image menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagemenuoption.html#cfn-quicksight-analysis-imagemenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ImageStaticFile": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ImageStaticFile`\n\nA static file that contains an image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagestaticfile.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the static file that contains an image.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagestaticfile.html#cfn-quicksight-analysis-imagestaticfile-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the image static file.\n*Required*: No\n*Type*: [StaticFileSource](./aws-properties-quicksight-analysis-staticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-imagestaticfile.html#cfn-quicksight-analysis-imagestaticfile-source", "UpdateType": "Mutable", "Required": false, "Type": "StaticFileSource" } } }, "AWS::QuickSight::Analysis.InnerFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.InnerFilter`\n\nThe `InnerFilter` defines the subset of data to be used with the `NestedFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-innerfilter.html", "Properties": { "CategoryInnerFilter": { "MarkdownDocumentation": "`CategoryInnerFilter`\n\nA `CategoryInnerFilter` filters text values for the `NestedFilter`.\n*Required*: No\n*Type*: [CategoryInnerFilter](./aws-properties-quicksight-analysis-categoryinnerfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-innerfilter.html#cfn-quicksight-analysis-innerfilter-categoryinnerfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryInnerFilter" } } }, "AWS::QuickSight::Analysis.InsightConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.InsightConfiguration`\n\nThe configuration of an insight visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightconfiguration.html", "Properties": { "Computations": { "MarkdownDocumentation": "`Computations`\n\nThe computations configurations of the insight visual\n*Required*: No\n*Type*: Array of [Computation](./aws-properties-quicksight-analysis-computation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightconfiguration.html#cfn-quicksight-analysis-insightconfiguration-computations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Computation", "DuplicatesAllowed": true }, "CustomNarrative": { "MarkdownDocumentation": "`CustomNarrative`\n\nThe custom narrative of the insight visual.\n*Required*: No\n*Type*: [CustomNarrativeOptions](./aws-properties-quicksight-analysis-customnarrativeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightconfiguration.html#cfn-quicksight-analysis-insightconfiguration-customnarrative", "UpdateType": "Mutable", "Required": false, "Type": "CustomNarrativeOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightconfiguration.html#cfn-quicksight-analysis-insightconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Analysis.InsightVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.InsightVisual`\n\nAn insight visual.\nFor more information, see [Working with insights](https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe dataset that is used in the insight visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InsightConfiguration": { "MarkdownDocumentation": "`InsightConfiguration`\n\nThe configuration of an insight visual.\n*Required*: No\n*Type*: [InsightConfiguration](./aws-properties-quicksight-analysis-insightconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-insightconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InsightConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-insightvisual.html#cfn-quicksight-analysis-insightvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.IntegerDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.IntegerDefaultValues`\n\nThe default values of the `IntegerParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerdefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `IntegerDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-analysis-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerdefaultvalues.html#cfn-quicksight-analysis-integerdefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `IntegerDefaultValues`.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerdefaultvalues.html#cfn-quicksight-analysis-integerdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.IntegerParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.IntegerParameter`\n\nAn integer parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values for the integer parameter.\n*Required*: Yes\n*Type*: Array of Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameter.html#cfn-quicksight-analysis-integerparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the integer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameter.html#cfn-quicksight-analysis-integerparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.IntegerParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.IntegerParameterDeclaration`\n\nA parameter declaration for the `Integer` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-analysis-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameterdeclaration.html#cfn-quicksight-analysis-integerparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [IntegerDefaultValues](./aws-properties-quicksight-analysis-integerdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameterdeclaration.html#cfn-quicksight-analysis-integerparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "IntegerDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameterdeclaration.html#cfn-quicksight-analysis-integerparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nA parameter declaration for the `Integer` data type.\n*Required*: No\n*Type*: [IntegerValueWhenUnsetConfiguration](./aws-properties-quicksight-analysis-integervaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameterdeclaration.html#cfn-quicksight-analysis-integerparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "IntegerValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameterdeclaration.html#cfn-quicksight-analysis-integerparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.IntegerValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.IntegerValueWhenUnsetConfiguration`\n\nA parameter declaration for the `Integer` data type.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integervaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integervaluewhenunsetconfiguration.html#cfn-quicksight-analysis-integervaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't set.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integervaluewhenunsetconfiguration.html#cfn-quicksight-analysis-integervaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.ItemsLimitConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ItemsLimitConfiguration`\n\nThe limit configuration of the visual display for an axis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-itemslimitconfiguration.html", "Properties": { "ItemsLimit": { "MarkdownDocumentation": "`ItemsLimit`\n\nThe limit on how many items of a field are showed in the chart. For\nexample, the number of slices that are displayed in a pie chart.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-itemslimitconfiguration.html#cfn-quicksight-analysis-itemslimitconfiguration-itemslimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "OtherCategories": { "MarkdownDocumentation": "`OtherCategories`\n\nThe `Show\nother` of an axis in the chart. Choose one of the following options:\n* `INCLUDE`\n* `EXCLUDE`\n*Required*: No\n*Type*: String\n*Allowed values*: `INCLUDE | EXCLUDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCLUDE", "EXCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-itemslimitconfiguration.html#cfn-quicksight-analysis-itemslimitconfiguration-othercategories", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.KPIActualValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIActualValueConditionalFormatting`\n\nThe conditional formatting for the actual value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiactualvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the actual value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiactualvalueconditionalformatting.html#cfn-quicksight-analysis-kpiactualvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the actual value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-analysis-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiactualvalueconditionalformatting.html#cfn-quicksight-analysis-kpiactualvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Analysis.KPIComparisonValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIComparisonValueConditionalFormatting`\n\nThe conditional formatting for the comparison value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpicomparisonvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the comparison value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-analysis-kpicomparisonvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the comparison value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-analysis-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-analysis-kpicomparisonvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Analysis.KPIConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIConditionalFormatting`\n\nThe conditional formatting of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nThe conditional formatting options of a KPI visual.\n*Required*: No\n*Type*: Array of [KPIConditionalFormattingOption](./aws-properties-quicksight-analysis-kpiconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformatting.html#cfn-quicksight-analysis-kpiconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KPIConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.KPIConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIConditionalFormattingOption`\n\nThe conditional formatting options of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformattingoption.html", "Properties": { "PrimaryValue": { "MarkdownDocumentation": "`PrimaryValue`\n\nThe conditional formatting for the primary value of a KPI visual.\n*Required*: No\n*Type*: [KPIPrimaryValueConditionalFormatting](./aws-properties-quicksight-analysis-kpiprimaryvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformattingoption.html#cfn-quicksight-analysis-kpiconditionalformattingoption-primaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIPrimaryValueConditionalFormatting" }, "ActualValue": { "MarkdownDocumentation": "`ActualValue`\n\nThe conditional formatting for the actual value of a KPI visual.\n*Required*: No\n*Type*: [KPIActualValueConditionalFormatting](./aws-properties-quicksight-analysis-kpiactualvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformattingoption.html#cfn-quicksight-analysis-kpiconditionalformattingoption-actualvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIActualValueConditionalFormatting" }, "ComparisonValue": { "MarkdownDocumentation": "`ComparisonValue`\n\nThe conditional formatting for the comparison value of a KPI visual.\n*Required*: No\n*Type*: [KPIComparisonValueConditionalFormatting](./aws-properties-quicksight-analysis-kpicomparisonvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformattingoption.html#cfn-quicksight-analysis-kpiconditionalformattingoption-comparisonvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIComparisonValueConditionalFormatting" }, "ProgressBar": { "MarkdownDocumentation": "`ProgressBar`\n\nThe conditional formatting for the progress bar of a KPI visual.\n*Required*: No\n*Type*: [KPIProgressBarConditionalFormatting](./aws-properties-quicksight-analysis-kpiprogressbarconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconditionalformattingoption.html#cfn-quicksight-analysis-kpiconditionalformattingoption-progressbar", "UpdateType": "Mutable", "Required": false, "Type": "KPIProgressBarConditionalFormatting" } } }, "AWS::QuickSight::Analysis.KPIConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIConfiguration`\n\nThe configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a KPI visual.\n*Required*: No\n*Type*: [KPISortConfiguration](./aws-properties-quicksight-analysis-kpisortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconfiguration.html#cfn-quicksight-analysis-kpiconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "KPISortConfiguration" }, "KPIOptions": { "MarkdownDocumentation": "`KPIOptions`\n\nThe options that determine the presentation of a KPI visual.\n*Required*: No\n*Type*: [KPIOptions](./aws-properties-quicksight-analysis-kpioptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconfiguration.html#cfn-quicksight-analysis-kpiconfiguration-kpioptions", "UpdateType": "Mutable", "Required": false, "Type": "KPIOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a KPI visual.\n*Required*: No\n*Type*: [KPIFieldWells](./aws-properties-quicksight-analysis-kpifieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconfiguration.html#cfn-quicksight-analysis-kpiconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "KPIFieldWells" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiconfiguration.html#cfn-quicksight-analysis-kpiconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Analysis.KPIFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIFieldWells`\n\nThe field well configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpifieldwells.html", "Properties": { "TargetValues": { "MarkdownDocumentation": "`TargetValues`\n\nThe target value field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpifieldwells.html#cfn-quicksight-analysis-kpifieldwells-targetvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "TrendGroups": { "MarkdownDocumentation": "`TrendGroups`\n\nThe trend group field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpifieldwells.html#cfn-quicksight-analysis-kpifieldwells-trendgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpifieldwells.html#cfn-quicksight-analysis-kpifieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.KPIOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIOptions`\n\nThe options that determine the presentation of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html", "Properties": { "SecondaryValueFontConfiguration": { "MarkdownDocumentation": "`SecondaryValueFontConfiguration`\n\nThe options that determine the secondary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-secondaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "VisualLayoutOptions": { "MarkdownDocumentation": "`VisualLayoutOptions`\n\nThe options that determine the layout a KPI visual.\n*Required*: No\n*Type*: [KPIVisualLayoutOptions](./aws-properties-quicksight-analysis-kpivisuallayoutoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-visuallayoutoptions", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisualLayoutOptions" }, "TrendArrows": { "MarkdownDocumentation": "`TrendArrows`\n\nThe options that determine the presentation of trend arrows in a KPI visual.\n*Required*: No\n*Type*: [TrendArrowOptions](./aws-properties-quicksight-analysis-trendarrowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-trendarrows", "UpdateType": "Mutable", "Required": false, "Type": "TrendArrowOptions" }, "SecondaryValue": { "MarkdownDocumentation": "`SecondaryValue`\n\nThe options that determine the presentation of the secondary value of a KPI visual.\n*Required*: No\n*Type*: [SecondaryValueOptions](./aws-properties-quicksight-analysis-secondaryvalueoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-secondaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "SecondaryValueOptions" }, "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe comparison configuration of a KPI visual.\n*Required*: No\n*Type*: [ComparisonConfiguration](./aws-properties-quicksight-analysis-comparisonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-comparison", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonConfiguration" }, "PrimaryValueDisplayType": { "MarkdownDocumentation": "`PrimaryValueDisplayType`\n\nThe options that determine the primary value display type.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | COMPARISON | ACTUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "COMPARISON", "ACTUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-primaryvaluedisplaytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProgressBar": { "MarkdownDocumentation": "`ProgressBar`\n\nThe options that determine the presentation of the progress bar of a KPI visual.\n*Required*: No\n*Type*: [ProgressBarOptions](./aws-properties-quicksight-analysis-progressbaroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-progressbar", "UpdateType": "Mutable", "Required": false, "Type": "ProgressBarOptions" }, "PrimaryValueFontConfiguration": { "MarkdownDocumentation": "`PrimaryValueFontConfiguration`\n\nThe options that determine the primary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-primaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Sparkline": { "MarkdownDocumentation": "`Sparkline`\n\nThe options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.\n*Required*: No\n*Type*: [KPISparklineOptions](./aws-properties-quicksight-analysis-kpisparklineoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpioptions.html#cfn-quicksight-analysis-kpioptions-sparkline", "UpdateType": "Mutable", "Required": false, "Type": "KPISparklineOptions" } } }, "AWS::QuickSight::Analysis.KPIPrimaryValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIPrimaryValueConditionalFormatting`\n\nThe conditional formatting for the primary value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiprimaryvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the primary value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-analysis-kpiprimaryvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the primary value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-analysis-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-analysis-kpiprimaryvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Analysis.KPIProgressBarConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIProgressBarConditionalFormatting`\n\nThe conditional formatting for the progress bar of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiprogressbarconditionalformatting.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe conditional formatting of the progress bar's foreground color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpiprogressbarconditionalformatting.html#cfn-quicksight-analysis-kpiprogressbarconditionalformatting-foregroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Analysis.KPISortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPISortConfiguration`\n\nThe sort configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpisortconfiguration.html", "Properties": { "TrendGroupSort": { "MarkdownDocumentation": "`TrendGroupSort`\n\nThe sort configuration of the trend group fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpisortconfiguration.html#cfn-quicksight-analysis-kpisortconfiguration-trendgroupsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.KPISparklineOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPISparklineOptions`\n\nThe options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpisparklineoptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the sparkline.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LINE | AREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINE", "AREA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpisparklineoptions.html#cfn-quicksight-analysis-kpisparklineoptions-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of the sparkline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpisparklineoptions.html#cfn-quicksight-analysis-kpisparklineoptions-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipVisibility": { "MarkdownDocumentation": "`TooltipVisibility`\n\nThe tooltip visibility of the sparkline.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpisparklineoptions.html#cfn-quicksight-analysis-kpisparklineoptions-tooltipvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the sparkline.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpisparklineoptions.html#cfn-quicksight-analysis-kpisparklineoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.KPIVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIVisual`\n\nA key performance indicator (KPI).\nFor more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html#cfn-quicksight-analysis-kpivisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a KPI visual.\n*Required*: No\n*Type*: [KPIConditionalFormatting](./aws-properties-quicksight-analysis-kpiconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html#cfn-quicksight-analysis-kpivisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "KPIConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html#cfn-quicksight-analysis-kpivisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a KPI visual.\n*Required*: No\n*Type*: [KPIConfiguration](./aws-properties-quicksight-analysis-kpiconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html#cfn-quicksight-analysis-kpivisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "KPIConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html#cfn-quicksight-analysis-kpivisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html#cfn-quicksight-analysis-kpivisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html#cfn-quicksight-analysis-kpivisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisual.html#cfn-quicksight-analysis-kpivisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.KPIVisualLayoutOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIVisualLayoutOptions`\n\nThe options that determine the layout a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisuallayoutoptions.html", "Properties": { "StandardLayout": { "MarkdownDocumentation": "`StandardLayout`\n\nThe standard layout of the KPI visual.\n*Required*: No\n*Type*: [KPIVisualStandardLayout](./aws-properties-quicksight-analysis-kpivisualstandardlayout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisuallayoutoptions.html#cfn-quicksight-analysis-kpivisuallayoutoptions-standardlayout", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisualStandardLayout" } } }, "AWS::QuickSight::Analysis.KPIVisualStandardLayout": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.KPIVisualStandardLayout`\n\nThe standard layout of the KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisualstandardlayout.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe standard layout type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLASSIC | VERTICAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLASSIC", "VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-kpivisualstandardlayout.html#cfn-quicksight-analysis-kpivisualstandardlayout-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.LabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LabelOptions`\n\nThe share label options for the labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-labeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe text for the label.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-labeloptions.html#cfn-quicksight-analysis-labeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the label is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-labeloptions.html#cfn-quicksight-analysis-labeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the label.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-labeloptions.html#cfn-quicksight-analysis-labeloptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Analysis.LayerCustomAction": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LayerCustomAction`\n\nA layer custom action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the `LayerCustomAction`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomaction.html#cfn-quicksight-analysis-layercustomaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trigger": { "MarkdownDocumentation": "`Trigger`\n\nThe trigger of the `LayerCustomAction`.\nValid values are defined as follows:\n* `DATA_POINT_CLICK`: Initiates a custom action by a left pointer click on a data point.\n* `DATA_POINT_MENU`: Initiates a custom action by right pointer click from the menu.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DATA_POINT_CLICK | DATA_POI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DATA_POINT_CLICK", "DATA_POINT_MENU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomaction.html#cfn-quicksight-analysis-layercustomaction-trigger", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomActionId": { "MarkdownDocumentation": "`CustomActionId`\n\nThe ID of the custom action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomaction.html#cfn-quicksight-analysis-layercustomaction-customactionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the custom action.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomaction.html#cfn-quicksight-analysis-layercustomaction-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionOperations": { "MarkdownDocumentation": "`ActionOperations`\n\nA list of `LayerCustomActionOperations`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: Array of [LayerCustomActionOperation](./aws-properties-quicksight-analysis-layercustomactionoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomaction.html#cfn-quicksight-analysis-layercustomaction-actionoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "LayerCustomActionOperation", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.LayerCustomActionOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LayerCustomActionOperation`\n\nThe operation that is defined by the custom action.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomactionoperation.html", "Properties": { "NavigationOperation": { "MarkdownDocumentation": "`NavigationOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionNavigationOperation](./aws-properties-quicksight-analysis-customactionnavigationoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomactionoperation.html#cfn-quicksight-analysis-layercustomactionoperation-navigationoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionNavigationOperation" }, "SetParametersOperation": { "MarkdownDocumentation": "`SetParametersOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionSetParametersOperation](./aws-properties-quicksight-analysis-customactionsetparametersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomactionoperation.html#cfn-quicksight-analysis-layercustomactionoperation-setparametersoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionSetParametersOperation" }, "FilterOperation": { "MarkdownDocumentation": "`FilterOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionFilterOperation](./aws-properties-quicksight-analysis-customactionfilteroperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomactionoperation.html#cfn-quicksight-analysis-layercustomactionoperation-filteroperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionFilterOperation" }, "URLOperation": { "MarkdownDocumentation": "`URLOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionURLOperation](./aws-properties-quicksight-analysis-customactionurloperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layercustomactionoperation.html#cfn-quicksight-analysis-layercustomactionoperation-urloperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionURLOperation" } } }, "AWS::QuickSight::Analysis.LayerMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LayerMapVisual`\n\nA layer map visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layermapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layermapvisual.html#cfn-quicksight-analysis-layermapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe ID of the visual.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layermapvisual.html#cfn-quicksight-analysis-layermapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [GeospatialLayerMapConfiguration](./aws-properties-quicksight-analysis-geospatiallayermapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layermapvisual.html#cfn-quicksight-analysis-layermapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLayerMapConfiguration" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe dataset that is used to create the layer map visual. You can't create a visual without a dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layermapvisual.html#cfn-quicksight-analysis-layermapvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layermapvisual.html#cfn-quicksight-analysis-layermapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layermapvisual.html#cfn-quicksight-analysis-layermapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.Layout": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.Layout`\n\nA `Layout` defines the placement of elements within a sheet.\nFor more information, see [Types of layout](https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the *Amazon Quick Suite User Guide*.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layout.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration that determines what the type of layout for a sheet.\n*Required*: Yes\n*Type*: [LayoutConfiguration](./aws-properties-quicksight-analysis-layoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layout.html#cfn-quicksight-analysis-layout-configuration", "UpdateType": "Mutable", "Required": true, "Type": "LayoutConfiguration" } } }, "AWS::QuickSight::Analysis.LayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LayoutConfiguration`\n\nThe configuration that determines what the type of layout will be used on a sheet.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layoutconfiguration.html", "Properties": { "GridLayout": { "MarkdownDocumentation": "`GridLayout`\n\nA type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: `FIXED` or `RESPONSIVE`.\n*Required*: No\n*Type*: [GridLayoutConfiguration](./aws-properties-quicksight-analysis-gridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layoutconfiguration.html#cfn-quicksight-analysis-layoutconfiguration-gridlayout", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutConfiguration" }, "FreeFormLayout": { "MarkdownDocumentation": "`FreeFormLayout`\n\nA free-form is optimized for a fixed width and has more control over the exact placement of layout elements.\n*Required*: No\n*Type*: [FreeFormLayoutConfiguration](./aws-properties-quicksight-analysis-freeformlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layoutconfiguration.html#cfn-quicksight-analysis-layoutconfiguration-freeformlayout", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutConfiguration" }, "SectionBasedLayout": { "MarkdownDocumentation": "`SectionBasedLayout`\n\nA section based layout organizes visuals into multiple sections and has customized header, footer and page break.\n*Required*: No\n*Type*: [SectionBasedLayoutConfiguration](./aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-layoutconfiguration.html#cfn-quicksight-analysis-layoutconfiguration-sectionbasedlayout", "UpdateType": "Mutable", "Required": false, "Type": "SectionBasedLayoutConfiguration" } } }, "AWS::QuickSight::Analysis.LegendOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LegendOptions`\n\nThe options for the legend setup of a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-legendoptions.html", "Properties": { "Position": { "MarkdownDocumentation": "`Position`\n\nThe positions for the legend. Choose one of the following\noptions:\n* `AUTO`\n* `RIGHT`\n* `BOTTOM`\n* `LEFT`\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTO | RIGHT | BOTTOM | TOP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "RIGHT", "BOTTOM", "TOP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-legendoptions.html#cfn-quicksight-analysis-legendoptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueFontConfiguration": { "MarkdownDocumentation": "`ValueFontConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-legendoptions.html#cfn-quicksight-analysis-legendoptions-valuefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe custom title for the legend.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-legendoptions.html#cfn-quicksight-analysis-legendoptions-title", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the legend is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-legendoptions.html#cfn-quicksight-analysis-legendoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of the legend. If this value is omitted, a default height is used when\nrendering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-legendoptions.html#cfn-quicksight-analysis-legendoptions-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of the legend. If this value is omitted, a default width is used when rendering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-legendoptions.html#cfn-quicksight-analysis-legendoptions-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.LineChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartAggregatedFieldWells`\n\nThe field well configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field wells of a line chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartaggregatedfieldwells.html#cfn-quicksight-analysis-linechartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field wells of a line chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartaggregatedfieldwells.html#cfn-quicksight-analysis-linechartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a line chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartaggregatedfieldwells.html#cfn-quicksight-analysis-linechartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a line chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartaggregatedfieldwells.html#cfn-quicksight-analysis-linechartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.LineChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartConfiguration`\n\nThe configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a line chart.\n*Required*: No\n*Type*: [LineChartSortConfiguration](./aws-properties-quicksight-analysis-linechartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend configuration of a line chart.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference lines configuration of a line chart.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-analysis-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a line chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a line chart.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SingleAxisOptions": { "MarkdownDocumentation": "`SingleAxisOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [SingleAxisOptions](./aws-properties-quicksight-analysis-singleaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-singleaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "SingleAxisOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-analysis-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n*Required*: No\n*Type*: [LineSeriesAxisDisplayOptions](./aws-properties-quicksight-analysis-lineseriesaxisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "LineSeriesAxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a line chart.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe options that determine the presentation of the x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DefaultSeriesSettings": { "MarkdownDocumentation": "`DefaultSeriesSettings`\n\nThe options that determine the default presentation of all line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartDefaultSeriesSettings](./aws-properties-quicksight-analysis-linechartdefaultseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-defaultseriessettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartDefaultSeriesSettings" }, "SecondaryYAxisLabelOptions": { "MarkdownDocumentation": "`SecondaryYAxisLabelOptions`\n\nThe options that determine the presentation of the secondary y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-secondaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "ForecastConfigurations": { "MarkdownDocumentation": "`ForecastConfigurations`\n\nThe forecast configuration of a line chart.\n*Required*: No\n*Type*: Array of [ForecastConfiguration](./aws-properties-quicksight-analysis-forecastconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-forecastconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ForecastConfiguration", "DuplicatesAllowed": true }, "Series": { "MarkdownDocumentation": "`Series`\n\nThe series item configuration of a line chart.\n*Required*: No\n*Type*: Array of [SeriesItem](./aws-properties-quicksight-analysis-seriesitem.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-series", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SeriesItem", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nDetermines the type of the line chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINE | AREA | STACKED_AREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINE", "AREA", "STACKED_AREA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe options that determine the presentation of the y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe default configuration of a line chart's contribution analysis.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-analysis-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a line chart.\n*Required*: No\n*Type*: [LineChartFieldWells](./aws-properties-quicksight-analysis-linechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "LineChartFieldWells" }, "SecondaryYAxisDisplayOptions": { "MarkdownDocumentation": "`SecondaryYAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n*Required*: No\n*Type*: [LineSeriesAxisDisplayOptions](./aws-properties-quicksight-analysis-lineseriesaxisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-secondaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "LineSeriesAxisDisplayOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe options that determine the presentation of the x-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartconfiguration.html#cfn-quicksight-analysis-linechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Analysis.LineChartDefaultSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartDefaultSeriesSettings`\n\nThe options that determine the default presentation of all line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartdefaultseriessettings.html", "Properties": { "LineStyleSettings": { "MarkdownDocumentation": "`LineStyleSettings`\n\nLine styles options for all line series in the visual.\n*Required*: No\n*Type*: [LineChartLineStyleSettings](./aws-properties-quicksight-analysis-linechartlinestylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartdefaultseriessettings.html#cfn-quicksight-analysis-linechartdefaultseriessettings-linestylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartLineStyleSettings" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis to which you are binding all line series to.\n*Required*: No\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartdefaultseriessettings.html#cfn-quicksight-analysis-linechartdefaultseriessettings-axisbinding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerStyleSettings": { "MarkdownDocumentation": "`MarkerStyleSettings`\n\nMarker styles options for all line series in the visual.\n*Required*: No\n*Type*: [LineChartMarkerStyleSettings](./aws-properties-quicksight-analysis-linechartmarkerstylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartdefaultseriessettings.html#cfn-quicksight-analysis-linechartdefaultseriessettings-markerstylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartMarkerStyleSettings" } } }, "AWS::QuickSight::Analysis.LineChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartFieldWells`\n\nThe field well configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartfieldwells.html", "Properties": { "LineChartAggregatedFieldWells": { "MarkdownDocumentation": "`LineChartAggregatedFieldWells`\n\nThe field well configuration of a line chart.\n*Required*: No\n*Type*: [LineChartAggregatedFieldWells](./aws-properties-quicksight-analysis-linechartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartfieldwells.html#cfn-quicksight-analysis-linechartfieldwells-linechartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "LineChartAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.LineChartLineStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartLineStyleSettings`\n\nLine styles options for a line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartlinestylesettings.html", "Properties": { "LineInterpolation": { "MarkdownDocumentation": "`LineInterpolation`\n\nInterpolation style for line series.\n* `LINEAR`: Show as default, linear style.\n* `SMOOTH`: Show as a smooth curve.\n* `STEPPED`: Show steps in line.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINEAR | SMOOTH | STEPPED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINEAR", "SMOOTH", "STEPPED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartlinestylesettings.html#cfn-quicksight-analysis-linechartlinestylesettings-lineinterpolation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineStyle": { "MarkdownDocumentation": "`LineStyle`\n\nLine style for line series.\n* `SOLID`: Show as a solid line.\n* `DOTTED`: Show as a dotted line.\n* `DASHED`: Show as a dashed line.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DOTTED | DASHED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DOTTED", "DASHED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartlinestylesettings.html#cfn-quicksight-analysis-linechartlinestylesettings-linestyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineVisibility": { "MarkdownDocumentation": "`LineVisibility`\n\nConfiguration option that determines whether to show the line for the series.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartlinestylesettings.html#cfn-quicksight-analysis-linechartlinestylesettings-linevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineWidth": { "MarkdownDocumentation": "`LineWidth`\n\nWidth that determines the line thickness.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartlinestylesettings.html#cfn-quicksight-analysis-linechartlinestylesettings-linewidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.LineChartMarkerStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartMarkerStyleSettings`\n\nMarker styles options for a line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartmarkerstylesettings.html", "Properties": { "MarkerShape": { "MarkdownDocumentation": "`MarkerShape`\n\nShape option for markers in the series.\n* `CIRCLE`: Show marker as a circle.\n* `TRIANGLE`: Show marker as a triangle.\n* `SQUARE`: Show marker as a square.\n* `DIAMOND`: Show marker as a diamond.\n* `ROUNDED_SQUARE`: Show marker as a rounded square.\n*Required*: No\n*Type*: String\n*Allowed values*: `CIRCLE | TRIANGLE | SQUARE ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIRCLE", "TRIANGLE", "SQUARE", "DIAMOND", "ROUNDED_SQUARE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartmarkerstylesettings.html#cfn-quicksight-analysis-linechartmarkerstylesettings-markershape", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerSize": { "MarkdownDocumentation": "`MarkerSize`\n\nSize of marker in the series.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartmarkerstylesettings.html#cfn-quicksight-analysis-linechartmarkerstylesettings-markersize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerVisibility": { "MarkdownDocumentation": "`MarkerVisibility`\n\nConfiguration option that determines whether to show the markers in the series.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartmarkerstylesettings.html#cfn-quicksight-analysis-linechartmarkerstylesettings-markervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerColor": { "MarkdownDocumentation": "`MarkerColor`\n\nColor of marker in the series.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartmarkerstylesettings.html#cfn-quicksight-analysis-linechartmarkerstylesettings-markercolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.LineChartSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartSeriesSettings`\n\nThe options that determine the presentation of a line series in the visual\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartseriessettings.html", "Properties": { "LineStyleSettings": { "MarkdownDocumentation": "`LineStyleSettings`\n\nLine styles options for a line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartLineStyleSettings](./aws-properties-quicksight-analysis-linechartlinestylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartseriessettings.html#cfn-quicksight-analysis-linechartseriessettings-linestylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartLineStyleSettings" }, "MarkerStyleSettings": { "MarkdownDocumentation": "`MarkerStyleSettings`\n\nMarker styles options for a line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartMarkerStyleSettings](./aws-properties-quicksight-analysis-linechartmarkerstylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartseriessettings.html#cfn-quicksight-analysis-linechartseriessettings-markerstylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartMarkerStyleSettings" } } }, "AWS::QuickSight::Analysis.LineChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartSortConfiguration`\n\nThe sort configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartsortconfiguration.html", "Properties": { "CategoryItemsLimitConfiguration": { "MarkdownDocumentation": "`CategoryItemsLimitConfiguration`\n\nThe limit on the number of categories that are displayed in a line chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartsortconfiguration.html#cfn-quicksight-analysis-linechartsortconfiguration-categoryitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "ColorItemsLimitConfiguration": { "MarkdownDocumentation": "`ColorItemsLimitConfiguration`\n\nThe limit on the number of lines that are displayed in a line chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartsortconfiguration.html#cfn-quicksight-analysis-linechartsortconfiguration-coloritemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartsortconfiguration.html#cfn-quicksight-analysis-linechartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartsortconfiguration.html#cfn-quicksight-analysis-linechartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartsortconfiguration.html#cfn-quicksight-analysis-linechartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Analysis.LineChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineChartVisual`\n\nA line chart.\nFor more information, see [Using line charts](https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartvisual.html#cfn-quicksight-analysis-linechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartvisual.html#cfn-quicksight-analysis-linechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a line chart.\n*Required*: No\n*Type*: [LineChartConfiguration](./aws-properties-quicksight-analysis-linechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartvisual.html#cfn-quicksight-analysis-linechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LineChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartvisual.html#cfn-quicksight-analysis-linechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartvisual.html#cfn-quicksight-analysis-linechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartvisual.html#cfn-quicksight-analysis-linechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-linechartvisual.html#cfn-quicksight-analysis-linechartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.LineSeriesAxisDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LineSeriesAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-lineseriesaxisdisplayoptions.html", "Properties": { "MissingDataConfigurations": { "MarkdownDocumentation": "`MissingDataConfigurations`\n\nThe configuration options that determine how missing data is treated during the rendering of a line chart.\n*Required*: No\n*Type*: Array of [MissingDataConfiguration](./aws-properties-quicksight-analysis-missingdataconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-lineseriesaxisdisplayoptions.html#cfn-quicksight-analysis-lineseriesaxisdisplayoptions-missingdataconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MissingDataConfiguration", "DuplicatesAllowed": true }, "AxisOptions": { "MarkdownDocumentation": "`AxisOptions`\n\nThe options that determine the presentation of the line series axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-lineseriesaxisdisplayoptions.html#cfn-quicksight-analysis-lineseriesaxisdisplayoptions-axisoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Analysis.ListControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ListControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontroldisplayoptions.html#cfn-quicksight-analysis-listcontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "SearchOptions": { "MarkdownDocumentation": "`SearchOptions`\n\nThe configuration of the search options in a list control.\n*Required*: No\n*Type*: [ListControlSearchOptions](./aws-properties-quicksight-analysis-listcontrolsearchoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontroldisplayoptions.html#cfn-quicksight-analysis-listcontroldisplayoptions-searchoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSearchOptions" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nThe configuration of the `Select all` options in a list control.\n*Required*: No\n*Type*: [ListControlSelectAllOptions](./aws-properties-quicksight-analysis-listcontrolselectalloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontroldisplayoptions.html#cfn-quicksight-analysis-listcontroldisplayoptions-selectalloptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSelectAllOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontroldisplayoptions.html#cfn-quicksight-analysis-listcontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Analysis.ListControlSearchOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ListControlSearchOptions`\n\nThe configuration of the search options in a list control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontrolsearchoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the search options in a list control.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontrolsearchoptions.html#cfn-quicksight-analysis-listcontrolsearchoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ListControlSelectAllOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ListControlSelectAllOptions`\n\nThe configuration of the `Select all` options in a list control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontrolselectalloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the `Select all` options in a list control.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-listcontrolselectalloptions.html#cfn-quicksight-analysis-listcontrolselectalloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.LoadingAnimation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LoadingAnimation`\n\nThe configuration of loading animation in free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-loadinganimation.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of `LoadingAnimation`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-loadinganimation.html#cfn-quicksight-analysis-loadinganimation-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.LocalNavigationConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LocalNavigationConfiguration`\n\nThe navigation configuration for `CustomActionNavigationOperation`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-localnavigationconfiguration.html", "Properties": { "TargetSheetId": { "MarkdownDocumentation": "`TargetSheetId`\n\nThe sheet that is targeted for navigation in the same analysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-localnavigationconfiguration.html#cfn-quicksight-analysis-localnavigationconfiguration-targetsheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.LongFormatText": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.LongFormatText`\n\nThe text format for a subtitle.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-longformattext.html", "Properties": { "RichText": { "MarkdownDocumentation": "`RichText`\n\nRich text. Examples of rich text include bold, underline, and italics.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-longformattext.html#cfn-quicksight-analysis-longformattext-richtext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nPlain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-longformattext.html#cfn-quicksight-analysis-longformattext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.MappedDataSetParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.MappedDataSetParameter`\n\nA dataset parameter that is mapped to an analysis parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-mappeddatasetparameter.html", "Properties": { "DataSetParameterName": { "MarkdownDocumentation": "`DataSetParameterName`\n\nThe name of the dataset parameter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-mappeddatasetparameter.html#cfn-quicksight-analysis-mappeddatasetparameter-datasetparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nA unique name that identifies a dataset within the analysis or dashboard.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-mappeddatasetparameter.html#cfn-quicksight-analysis-mappeddatasetparameter-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.MaximumLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.MaximumLabelType`\n\nThe maximum label of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-maximumlabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the maximum label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-maximumlabeltype.html#cfn-quicksight-analysis-maximumlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.MaximumMinimumComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.MaximumMinimumComputation`\n\nThe maximum and minimum computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-maximumminimumcomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of computation. Choose one of the following options:\n* MAXIMUM: A maximum computation.\n* MINIMUM: A minimum computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MAXIMUM | MINIMUM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MAXIMUM", "MINIMUM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-maximumminimumcomputation.html#cfn-quicksight-analysis-maximumminimumcomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-maximumminimumcomputation.html#cfn-quicksight-analysis-maximumminimumcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-maximumminimumcomputation.html#cfn-quicksight-analysis-maximumminimumcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-maximumminimumcomputation.html#cfn-quicksight-analysis-maximumminimumcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-maximumminimumcomputation.html#cfn-quicksight-analysis-maximumminimumcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.MeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.MeasureField`\n\nThe measure (metric) type field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-measurefield.html", "Properties": { "DateMeasureField": { "MarkdownDocumentation": "`DateMeasureField`\n\nThe measure type field with date type columns.\n*Required*: No\n*Type*: [DateMeasureField](./aws-properties-quicksight-analysis-datemeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-measurefield.html#cfn-quicksight-analysis-measurefield-datemeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "DateMeasureField" }, "NumericalMeasureField": { "MarkdownDocumentation": "`NumericalMeasureField`\n\nThe measure type field with numerical type columns.\n*Required*: No\n*Type*: [NumericalMeasureField](./aws-properties-quicksight-analysis-numericalmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-measurefield.html#cfn-quicksight-analysis-measurefield-numericalmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "NumericalMeasureField" }, "CategoricalMeasureField": { "MarkdownDocumentation": "`CategoricalMeasureField`\n\nThe measure type field with categorical type columns.\n*Required*: No\n*Type*: [CategoricalMeasureField](./aws-properties-quicksight-analysis-categoricalmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-measurefield.html#cfn-quicksight-analysis-measurefield-categoricalmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "CategoricalMeasureField" }, "CalculatedMeasureField": { "MarkdownDocumentation": "`CalculatedMeasureField`\n\nThe calculated measure field only used in pivot tables.\n*Required*: No\n*Type*: [CalculatedMeasureField](./aws-properties-quicksight-analysis-calculatedmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-measurefield.html#cfn-quicksight-analysis-measurefield-calculatedmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "CalculatedMeasureField" } } }, "AWS::QuickSight::Analysis.MetricComparisonComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.MetricComparisonComputation`\n\nThe metric comparison computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-metriccomparisoncomputation.html", "Properties": { "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nThe field that is used in a metric comparison to value setup.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-metriccomparisoncomputation.html#cfn-quicksight-analysis-metriccomparisoncomputation-targetvalue", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-metriccomparisoncomputation.html#cfn-quicksight-analysis-metriccomparisoncomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-metriccomparisoncomputation.html#cfn-quicksight-analysis-metriccomparisoncomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FromValue": { "MarkdownDocumentation": "`FromValue`\n\nThe field that is used in a metric comparison from value setup.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-metriccomparisoncomputation.html#cfn-quicksight-analysis-metriccomparisoncomputation-fromvalue", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-metriccomparisoncomputation.html#cfn-quicksight-analysis-metriccomparisoncomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.MinimumLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.MinimumLabelType`\n\nThe minimum label of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-minimumlabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the minimum label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-minimumlabeltype.html#cfn-quicksight-analysis-minimumlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.MissingDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.MissingDataConfiguration`\n\nThe configuration options that determine how missing data is treated during the rendering of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-missingdataconfiguration.html", "Properties": { "TreatmentOption": { "MarkdownDocumentation": "`TreatmentOption`\n\nThe treatment option that determines how missing data should be rendered. Choose\nfrom the following options:\n* `INTERPOLATE`: Interpolate missing values between the prior and the next known value.\n* `SHOW_AS_ZERO`: Show missing values as the value `0`.\n* `SHOW_AS_BLANK`: Display a blank space when rendering missing data.\n*Required*: No\n*Type*: String\n*Allowed values*: `INTERPOLATE | SHOW_AS_ZERO ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INTERPOLATE", "SHOW_AS_ZERO", "SHOW_AS_BLANK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-missingdataconfiguration.html#cfn-quicksight-analysis-missingdataconfiguration-treatmentoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NegativeValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-negativevalueconfiguration.html", "Properties": { "DisplayMode": { "MarkdownDocumentation": "`DisplayMode`\n\nDetermines the display mode of the negative value configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `POSITIVE | NEGATIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POSITIVE", "NEGATIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-negativevalueconfiguration.html#cfn-quicksight-analysis-negativevalueconfiguration-displaymode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NestedFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NestedFilter`\n\nA `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html#cfn-quicksight-analysis-nestedfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "InnerFilter": { "MarkdownDocumentation": "`InnerFilter`\n\nThe `InnerFilter` defines the subset of data to be used with the `NestedFilter`.\n*Required*: Yes\n*Type*: [InnerFilter](./aws-properties-quicksight-analysis-innerfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html#cfn-quicksight-analysis-nestedfilter-innerfilter", "UpdateType": "Mutable", "Required": true, "Type": "InnerFilter" }, "IncludeInnerSet": { "MarkdownDocumentation": "`IncludeInnerSet`\n\nA boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html#cfn-quicksight-analysis-nestedfilter-includeinnerset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html#cfn-quicksight-analysis-nestedfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NullValueFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nullvalueformatconfiguration.html", "Properties": { "NullString": { "MarkdownDocumentation": "`NullString`\n\nDetermines the null string of null values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nullvalueformatconfiguration.html#cfn-quicksight-analysis-nullvalueformatconfiguration-nullstring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumberDisplayFormatConfiguration`\n\nThe options that determine the number display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-analysis-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html#cfn-quicksight-analysis-numberdisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-analysis-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html#cfn-quicksight-analysis-numberdisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NumberScale": { "MarkdownDocumentation": "`NumberScale`\n\nDetermines the number scale value of the number format.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AUTO | THOUSANDS | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html#cfn-quicksight-analysis-numberdisplayformatconfiguration-numberscale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-analysis-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html#cfn-quicksight-analysis-numberdisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the number format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html#cfn-quicksight-analysis-numberdisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-analysis-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html#cfn-quicksight-analysis-numberdisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the number format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html#cfn-quicksight-analysis-numberdisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NumberFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumberFormatConfiguration`\n\nFormatting configuration for number fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberformatconfiguration.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe options that determine the numeric format configuration.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-analysis-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numberformatconfiguration.html#cfn-quicksight-analysis-numberformatconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" } } }, "AWS::QuickSight::Analysis.NumericAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericAxisOptions`\n\nThe options for an axis with a numeric field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericaxisoptions.html", "Properties": { "Scale": { "MarkdownDocumentation": "`Scale`\n\nThe scale setup of a numeric axis.\n*Required*: No\n*Type*: [AxisScale](./aws-properties-quicksight-analysis-axisscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericaxisoptions.html#cfn-quicksight-analysis-numericaxisoptions-scale", "UpdateType": "Mutable", "Required": false, "Type": "AxisScale" }, "Range": { "MarkdownDocumentation": "`Range`\n\nThe range setup of a numeric axis.\n*Required*: No\n*Type*: [AxisDisplayRange](./aws-properties-quicksight-analysis-axisdisplayrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericaxisoptions.html#cfn-quicksight-analysis-numericaxisoptions-range", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayRange" } } }, "AWS::QuickSight::Analysis.NumericEqualityDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericEqualityDrillDownFilter`\n\nThe numeric equality type drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalitydrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalitydrilldownfilter.html#cfn-quicksight-analysis-numericequalitydrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the double input numeric drill down filter.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalitydrilldownfilter.html#cfn-quicksight-analysis-numericequalitydrilldownfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.NumericEqualityFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericEqualityFilter`\n\nA `NumericEqualityFilter` filters values that are equal to the specified value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the filter.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-analysis-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe input value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_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)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NumericFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericFormatConfiguration`\n\nThe options that determine the numeric format configuration.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericformatconfiguration.html", "Properties": { "NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`NumberDisplayFormatConfiguration`\n\nThe options that determine the number display format configuration.\n*Required*: No\n*Type*: [NumberDisplayFormatConfiguration](./aws-properties-quicksight-analysis-numberdisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericformatconfiguration.html#cfn-quicksight-analysis-numericformatconfiguration-numberdisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberDisplayFormatConfiguration" }, "CurrencyDisplayFormatConfiguration": { "MarkdownDocumentation": "`CurrencyDisplayFormatConfiguration`\n\nThe options that determine the currency display format configuration.\n*Required*: No\n*Type*: [CurrencyDisplayFormatConfiguration](./aws-properties-quicksight-analysis-currencydisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericformatconfiguration.html#cfn-quicksight-analysis-numericformatconfiguration-currencydisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CurrencyDisplayFormatConfiguration" }, "PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`PercentageDisplayFormatConfiguration`\n\nThe options that determine the percentage display format configuration.\n*Required*: No\n*Type*: [PercentageDisplayFormatConfiguration](./aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericformatconfiguration.html#cfn-quicksight-analysis-numericformatconfiguration-percentagedisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PercentageDisplayFormatConfiguration" } } }, "AWS::QuickSight::Analysis.NumericRangeFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericRangeFilter`\n\nA `NumericRangeFilter` filters values that are within the value range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the filter.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-analysis-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "IncludeMaximum": { "MarkdownDocumentation": "`IncludeMaximum`\n\nDetermines whether the maximum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-includemaximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RangeMinimum": { "MarkdownDocumentation": "`RangeMinimum`\n\nThe minimum value for the filter value range.\n*Required*: No\n*Type*: [NumericRangeFilterValue](./aws-properties-quicksight-analysis-numericrangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-rangeminimum", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilterValue" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeMaximum": { "MarkdownDocumentation": "`RangeMaximum`\n\nThe maximum value for the filter value range.\n*Required*: No\n*Type*: [NumericRangeFilterValue](./aws-properties-quicksight-analysis-numericrangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-rangemaximum", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilterValue" }, "IncludeMinimum": { "MarkdownDocumentation": "`IncludeMinimum`\n\nDetermines whether the minimum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-includeminimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Analysis.NumericRangeFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericRangeFilterValue`\n\nThe value input pf the numeric range filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefiltervalue.html", "Properties": { "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nThe static value of the numeric range filter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefiltervalue.html#cfn-quicksight-analysis-numericrangefiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Parameter": { "MarkdownDocumentation": "`Parameter`\n\nThe parameter that is used in the numeric range.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefiltervalue.html#cfn-quicksight-analysis-numericrangefiltervalue-parameter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NumericSeparatorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericSeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericseparatorconfiguration.html", "Properties": { "DecimalSeparator": { "MarkdownDocumentation": "`DecimalSeparator`\n\nDetermines the decimal separator.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMMA | DOT | SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMMA", "DOT", "SPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericseparatorconfiguration.html#cfn-quicksight-analysis-numericseparatorconfiguration-decimalseparator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThousandsSeparator": { "MarkdownDocumentation": "`ThousandsSeparator`\n\nThe options that determine the thousands separator configuration.\n*Required*: No\n*Type*: [ThousandSeparatorOptions](./aws-properties-quicksight-analysis-thousandseparatoroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericseparatorconfiguration.html#cfn-quicksight-analysis-numericseparatorconfiguration-thousandsseparator", "UpdateType": "Mutable", "Required": false, "Type": "ThousandSeparatorOptions" } } }, "AWS::QuickSight::Analysis.NumericalAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericalAggregationFunction`\n\nAggregation for numerical values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalaggregationfunction.html", "Properties": { "PercentileAggregation": { "MarkdownDocumentation": "`PercentileAggregation`\n\nAn aggregation based on the percentile of values in a dimension or measure.\n*Required*: No\n*Type*: [PercentileAggregation](./aws-properties-quicksight-analysis-percentileaggregation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalaggregationfunction.html#cfn-quicksight-analysis-numericalaggregationfunction-percentileaggregation", "UpdateType": "Mutable", "Required": false, "Type": "PercentileAggregation" }, "SimpleNumericalAggregation": { "MarkdownDocumentation": "`SimpleNumericalAggregation`\n\nBuilt-in aggregation functions for numerical values.\n* `SUM`: The sum of a dimension or measure.\n* `AVERAGE`: The average of a dimension or measure.\n* `MIN`: The minimum value of a dimension or measure.\n* `MAX`: The maximum value of a dimension or measure.\n* `COUNT`: The count of a dimension or measure.\n* `DISTINCT_COUNT`: The count of distinct values in a dimension or measure.\n* `VAR`: The variance of a dimension or measure.\n* `VARP`: The partitioned variance of a dimension or measure.\n* `STDEV`: The standard deviation of a dimension or measure.\n* `STDEVP`: The partitioned standard deviation of a dimension or measure.\n* `MEDIAN`: The median value of a dimension or measure.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUM | AVERAGE | MIN | MAX |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUM", "AVERAGE", "MIN", "MAX", "COUNT", "DISTINCT_COUNT", "VAR", "VARP", "STDEV", "STDEVP", "MEDIAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalaggregationfunction.html#cfn-quicksight-analysis-numericalaggregationfunction-simplenumericalaggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NumericalDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericalDimensionField`\n\nThe dimension type field with numerical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericaldimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericaldimensionfield.html#cfn-quicksight-analysis-numericaldimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-analysis-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericaldimensionfield.html#cfn-quicksight-analysis-numericaldimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `NumericalDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericaldimensionfield.html#cfn-quicksight-analysis-numericaldimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericaldimensionfield.html#cfn-quicksight-analysis-numericaldimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.NumericalMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.NumericalMeasureField`\n\nThe measure type field with numerical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalmeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-analysis-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalmeasurefield.html#cfn-quicksight-analysis-numericalmeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "NumericalAggregationFunction" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-analysis-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalmeasurefield.html#cfn-quicksight-analysis-numericalmeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `NumericalMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalmeasurefield.html#cfn-quicksight-analysis-numericalmeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalmeasurefield.html#cfn-quicksight-analysis-numericalmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PaginationConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PaginationConfiguration`\n\nThe pagination configuration for a table visual or boxplot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-paginationconfiguration.html", "Properties": { "PageSize": { "MarkdownDocumentation": "`PageSize`\n\nIndicates how many items render in one page.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-paginationconfiguration.html#cfn-quicksight-analysis-paginationconfiguration-pagesize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "PageNumber": { "MarkdownDocumentation": "`PageNumber`\n\nIndicates the page number.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-paginationconfiguration.html#cfn-quicksight-analysis-paginationconfiguration-pagenumber", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.PanelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PanelConfiguration`\n\nA collection of options that configure how each panel displays in a small multiples chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html", "Properties": { "BorderThickness": { "MarkdownDocumentation": "`BorderThickness`\n\nSets the line thickness of panel borders.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-borderthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BorderStyle": { "MarkdownDocumentation": "`BorderStyle`\n\nSets the line style of panel borders.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DASHED | DOTTED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DASHED", "DOTTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-borderstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GutterSpacing": { "MarkdownDocumentation": "`GutterSpacing`\n\nSets the total amount of negative space to display between sibling panels.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-gutterspacing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundVisibility": { "MarkdownDocumentation": "`BackgroundVisibility`\n\nDetermines whether or not a background for each small multiples panel is rendered.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-backgroundvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BorderVisibility": { "MarkdownDocumentation": "`BorderVisibility`\n\nDetermines whether or not each panel displays a border.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-bordervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BorderColor": { "MarkdownDocumentation": "`BorderColor`\n\nSets the line color of panel borders.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-bordercolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nConfigures the title display within each small multiples panel.\n*Required*: No\n*Type*: [PanelTitleOptions](./aws-properties-quicksight-analysis-paneltitleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-title", "UpdateType": "Mutable", "Required": false, "Type": "PanelTitleOptions" }, "GutterVisibility": { "MarkdownDocumentation": "`GutterVisibility`\n\nDetermines whether or not negative space between sibling panels is rendered.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-guttervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nSets the background color for each panel.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-panelconfiguration.html#cfn-quicksight-analysis-panelconfiguration-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PanelTitleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PanelTitleOptions`\n\nThe options that determine the title styles for each small multiples\npanel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-paneltitleoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not panel titles are displayed.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-paneltitleoptions.html#cfn-quicksight-analysis-paneltitleoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-paneltitleoptions.html#cfn-quicksight-analysis-paneltitleoptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "HorizontalTextAlignment": { "MarkdownDocumentation": "`HorizontalTextAlignment`\n\nSets the horizontal text alignment of the title within each panel.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-paneltitleoptions.html#cfn-quicksight-analysis-paneltitleoptions-horizontaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ParameterControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterControl`\n\nThe control of a parameter that users can interact with in a dashboard or an analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametercontrol.html", "Properties": { "Slider": { "MarkdownDocumentation": "`Slider`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n*Required*: No\n*Type*: [ParameterSliderControl](./aws-properties-quicksight-analysis-parameterslidercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametercontrol.html#cfn-quicksight-analysis-parametercontrol-slider", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSliderControl" }, "TextArea": { "MarkdownDocumentation": "`TextArea`\n\nA control to display a text box that is used to enter multiple entries.\n*Required*: No\n*Type*: [ParameterTextAreaControl](./aws-properties-quicksight-analysis-parametertextareacontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametercontrol.html#cfn-quicksight-analysis-parametercontrol-textarea", "UpdateType": "Mutable", "Required": false, "Type": "ParameterTextAreaControl" }, "Dropdown": { "MarkdownDocumentation": "`Dropdown`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n*Required*: No\n*Type*: [ParameterDropDownControl](./aws-properties-quicksight-analysis-parameterdropdowncontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametercontrol.html#cfn-quicksight-analysis-parametercontrol-dropdown", "UpdateType": "Mutable", "Required": false, "Type": "ParameterDropDownControl" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nA control to display a text box that is used to enter a single entry.\n*Required*: No\n*Type*: [ParameterTextFieldControl](./aws-properties-quicksight-analysis-parametertextfieldcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametercontrol.html#cfn-quicksight-analysis-parametercontrol-textfield", "UpdateType": "Mutable", "Required": false, "Type": "ParameterTextFieldControl" }, "List": { "MarkdownDocumentation": "`List`\n\nA control to display a list with buttons or boxes that are used to select either a single value or multiple values.\n*Required*: No\n*Type*: [ParameterListControl](./aws-properties-quicksight-analysis-parameterlistcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametercontrol.html#cfn-quicksight-analysis-parametercontrol-list", "UpdateType": "Mutable", "Required": false, "Type": "ParameterListControl" }, "DateTimePicker": { "MarkdownDocumentation": "`DateTimePicker`\n\nA control from a date parameter that specifies date and time.\n*Required*: No\n*Type*: [ParameterDateTimePickerControl](./aws-properties-quicksight-analysis-parameterdatetimepickercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametercontrol.html#cfn-quicksight-analysis-parametercontrol-datetimepicker", "UpdateType": "Mutable", "Required": false, "Type": "ParameterDateTimePickerControl" } } }, "AWS::QuickSight::Analysis.ParameterDateTimePickerControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterDateTimePickerControl`\n\nA control from a date parameter that specifies date and time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdatetimepickercontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdatetimepickercontrol.html#cfn-quicksight-analysis-parameterdatetimepickercontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-analysis-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdatetimepickercontrol.html#cfn-quicksight-analysis-parameterdatetimepickercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe name of the `ParameterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdatetimepickercontrol.html#cfn-quicksight-analysis-parameterdatetimepickercontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterDateTimePickerControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdatetimepickercontrol.html#cfn-quicksight-analysis-parameterdatetimepickercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterDeclaration`\n\nThe declaration definition of a parameter.\nFor more information, see [Parameters in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the *Amazon Quick Suite User Guide*.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdeclaration.html", "Properties": { "StringParameterDeclaration": { "MarkdownDocumentation": "`StringParameterDeclaration`\n\nA parameter declaration for the `String` data type.\n*Required*: No\n*Type*: [StringParameterDeclaration](./aws-properties-quicksight-analysis-stringparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdeclaration.html#cfn-quicksight-analysis-parameterdeclaration-stringparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "StringParameterDeclaration" }, "DateTimeParameterDeclaration": { "MarkdownDocumentation": "`DateTimeParameterDeclaration`\n\nA parameter declaration for the `DateTime` data type.\n*Required*: No\n*Type*: [DateTimeParameterDeclaration](./aws-properties-quicksight-analysis-datetimeparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdeclaration.html#cfn-quicksight-analysis-parameterdeclaration-datetimeparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeParameterDeclaration" }, "DecimalParameterDeclaration": { "MarkdownDocumentation": "`DecimalParameterDeclaration`\n\nA parameter declaration for the `Decimal` data type.\n*Required*: No\n*Type*: [DecimalParameterDeclaration](./aws-properties-quicksight-analysis-decimalparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdeclaration.html#cfn-quicksight-analysis-parameterdeclaration-decimalparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalParameterDeclaration" }, "IntegerParameterDeclaration": { "MarkdownDocumentation": "`IntegerParameterDeclaration`\n\nA parameter declaration for the `Integer` data type.\n*Required*: No\n*Type*: [IntegerParameterDeclaration](./aws-properties-quicksight-analysis-integerparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdeclaration.html#cfn-quicksight-analysis-parameterdeclaration-integerparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "IntegerParameterDeclaration" } } }, "AWS::QuickSight::Analysis.ParameterDropDownControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterDropDownControl`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html#cfn-quicksight-analysis-parameterdropdowncontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type parameter name of the `ParameterDropDownControl`.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html#cfn-quicksight-analysis-parameterdropdowncontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-analysis-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html#cfn-quicksight-analysis-parameterdropdowncontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html#cfn-quicksight-analysis-parameterdropdowncontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-analysis-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html#cfn-quicksight-analysis-parameterdropdowncontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterDropDownControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html#cfn-quicksight-analysis-parameterdropdowncontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `ParameterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html#cfn-quicksight-analysis-parameterdropdowncontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [ParameterSelectableValues](./aws-properties-quicksight-analysis-parameterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterdropdowncontrol.html#cfn-quicksight-analysis-parameterdropdowncontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSelectableValues" } } }, "AWS::QuickSight::Analysis.ParameterListControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterListControl`\n\nA control to display a list with buttons or boxes that are used to select either a single value or multiple values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterlistcontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterlistcontrol.html#cfn-quicksight-analysis-parameterlistcontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of `ParameterListControl`.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterlistcontrol.html#cfn-quicksight-analysis-parameterlistcontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-analysis-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterlistcontrol.html#cfn-quicksight-analysis-parameterlistcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterlistcontrol.html#cfn-quicksight-analysis-parameterlistcontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-analysis-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterlistcontrol.html#cfn-quicksight-analysis-parameterlistcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterListControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterlistcontrol.html#cfn-quicksight-analysis-parameterlistcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [ParameterSelectableValues](./aws-properties-quicksight-analysis-parameterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterlistcontrol.html#cfn-quicksight-analysis-parameterlistcontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSelectableValues" } } }, "AWS::QuickSight::Analysis.ParameterSelectableValues": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterSelectableValues`\n\nA list of selectable values that are used in a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterselectablevalues.html", "Properties": { "LinkToDataSetColumn": { "MarkdownDocumentation": "`LinkToDataSetColumn`\n\nThe column identifier that fetches values from the data set.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterselectablevalues.html#cfn-quicksight-analysis-parameterselectablevalues-linktodatasetcolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are used in `ParameterSelectableValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterselectablevalues.html#cfn-quicksight-analysis-parameterselectablevalues-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ParameterSliderControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterSliderControl`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterslidercontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterslidercontrol.html#cfn-quicksight-analysis-parameterslidercontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterslidercontrol.html#cfn-quicksight-analysis-parameterslidercontrol-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-analysis-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterslidercontrol.html#cfn-quicksight-analysis-parameterslidercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterslidercontrol.html#cfn-quicksight-analysis-parameterslidercontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterSliderControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterslidercontrol.html#cfn-quicksight-analysis-parameterslidercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterslidercontrol.html#cfn-quicksight-analysis-parameterslidercontrol-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameterslidercontrol.html#cfn-quicksight-analysis-parameterslidercontrol-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.ParameterTextAreaControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterTextAreaControl`\n\nA control to display a text box that is used to enter multiple entries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextareacontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextareacontrol.html#cfn-quicksight-analysis-parametertextareacontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextareacontrol.html#cfn-quicksight-analysis-parametertextareacontrol-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-analysis-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextareacontrol.html#cfn-quicksight-analysis-parametertextareacontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextareacontrol.html#cfn-quicksight-analysis-parametertextareacontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextareacontrol.html#cfn-quicksight-analysis-parametertextareacontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ParameterTextFieldControl": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ParameterTextFieldControl`\n\nA control to display a text box that is used to enter a single entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextfieldcontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextfieldcontrol.html#cfn-quicksight-analysis-parametertextfieldcontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-analysis-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextfieldcontrol.html#cfn-quicksight-analysis-parametertextfieldcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextfieldcontrol.html#cfn-quicksight-analysis-parametertextfieldcontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterTextFieldControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parametertextfieldcontrol.html#cfn-quicksight-analysis-parametertextfieldcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.Parameters": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.Parameters`\n\nA list of Quick Sight parameters and the list's override values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html", "Properties": { "StringParameters": { "MarkdownDocumentation": "`StringParameters`\n\nThe parameters that have a data type of string.\n*Required*: No\n*Type*: Array of [StringParameter](./aws-properties-quicksight-analysis-stringparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html#cfn-quicksight-analysis-parameters-stringparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringParameter", "DuplicatesAllowed": true }, "DecimalParameters": { "MarkdownDocumentation": "`DecimalParameters`\n\nThe parameters that have a data type of decimal.\n*Required*: No\n*Type*: Array of [DecimalParameter](./aws-properties-quicksight-analysis-decimalparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html#cfn-quicksight-analysis-parameters-decimalparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DecimalParameter", "DuplicatesAllowed": true }, "IntegerParameters": { "MarkdownDocumentation": "`IntegerParameters`\n\nThe parameters that have a data type of integer.\n*Required*: No\n*Type*: Array of [IntegerParameter](./aws-properties-quicksight-analysis-integerparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html#cfn-quicksight-analysis-parameters-integerparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IntegerParameter", "DuplicatesAllowed": true }, "DateTimeParameters": { "MarkdownDocumentation": "`DateTimeParameters`\n\nThe parameters that have a data type of date-time.\n*Required*: No\n*Type*: Array of [DateTimeParameter](./aws-properties-quicksight-analysis-datetimeparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html#cfn-quicksight-analysis-parameters-datetimeparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateTimeParameter", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PercentVisibleRange": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PercentVisibleRange`\n\nThe percent range in the visible range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentvisiblerange.html", "Properties": { "From": { "MarkdownDocumentation": "`From`\n\nThe lower bound of the range.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentvisiblerange.html#cfn-quicksight-analysis-percentvisiblerange-from", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "To": { "MarkdownDocumentation": "`To`\n\nThe top bound of the range.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentvisiblerange.html#cfn-quicksight-analysis-percentvisiblerange-to", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PercentageDisplayFormatConfiguration`\n\nThe options that determine the percentage display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-analysis-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html#cfn-quicksight-analysis-percentagedisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-analysis-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html#cfn-quicksight-analysis-percentagedisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-analysis-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html#cfn-quicksight-analysis-percentagedisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the percentage format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html#cfn-quicksight-analysis-percentagedisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-analysis-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html#cfn-quicksight-analysis-percentagedisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the percentage format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentagedisplayformatconfiguration.html#cfn-quicksight-analysis-percentagedisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PercentileAggregation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PercentileAggregation`\n\nAn aggregation based on the percentile of values in a dimension or measure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentileaggregation.html", "Properties": { "PercentileValue": { "MarkdownDocumentation": "`PercentileValue`\n\nThe percentile value. This value can be any numeric constant 0\u2013100. A percentile value of 50 computes the median value of the measure.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentileaggregation.html#cfn-quicksight-analysis-percentileaggregation-percentilevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.PeriodOverPeriodComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PeriodOverPeriodComputation`\n\nThe period over period computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodoverperiodcomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodoverperiodcomputation.html#cfn-quicksight-analysis-periodoverperiodcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodoverperiodcomputation.html#cfn-quicksight-analysis-periodoverperiodcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodoverperiodcomputation.html#cfn-quicksight-analysis-periodoverperiodcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodoverperiodcomputation.html#cfn-quicksight-analysis-periodoverperiodcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PeriodToDateComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PeriodToDateComputation`\n\nThe period to date computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodtodatecomputation.html", "Properties": { "PeriodTimeGranularity": { "MarkdownDocumentation": "`PeriodTimeGranularity`\n\nThe time granularity setup of period to date computation. Choose from the following options:\n* YEAR: Year to date.\n* MONTH: Month to date.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodtodatecomputation.html#cfn-quicksight-analysis-periodtodatecomputation-periodtimegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodtodatecomputation.html#cfn-quicksight-analysis-periodtodatecomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodtodatecomputation.html#cfn-quicksight-analysis-periodtodatecomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodtodatecomputation.html#cfn-quicksight-analysis-periodtodatecomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-periodtodatecomputation.html#cfn-quicksight-analysis-periodtodatecomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PieChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PieChartAggregatedFieldWells`\n\nThe field well configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category (group/color) field wells of a pie chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartaggregatedfieldwells.html#cfn-quicksight-analysis-piechartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a pie chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartaggregatedfieldwells.html#cfn-quicksight-analysis-piechartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a pie chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartaggregatedfieldwells.html#cfn-quicksight-analysis-piechartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PieChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PieChartConfiguration`\n\nThe configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartSortConfiguration](./aws-properties-quicksight-analysis-piechartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PieChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe contribution analysis (anomaly configuration) setup of the visual.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-analysis-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options of the group/color that is displayed in a pie chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [PieChartFieldWells](./aws-properties-quicksight-analysis-piechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PieChartFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "DonutOptions": { "MarkdownDocumentation": "`DonutOptions`\n\nThe options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.\n*Required*: No\n*Type*: [DonutOptions](./aws-properties-quicksight-analysis-donutoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-donutoptions", "UpdateType": "Mutable", "Required": false, "Type": "DonutOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-analysis-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options for the value that is displayed in a pie chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartconfiguration.html#cfn-quicksight-analysis-piechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Analysis.PieChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PieChartFieldWells`\n\nThe field well configuration of a pie chart.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartfieldwells.html", "Properties": { "PieChartAggregatedFieldWells": { "MarkdownDocumentation": "`PieChartAggregatedFieldWells`\n\nThe field well configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartAggregatedFieldWells](./aws-properties-quicksight-analysis-piechartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartfieldwells.html#cfn-quicksight-analysis-piechartfieldwells-piechartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PieChartAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.PieChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PieChartSortConfiguration`\n\nThe sort configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartsortconfiguration.html", "Properties": { "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartsortconfiguration.html#cfn-quicksight-analysis-piechartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories that are displayed in a pie chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartsortconfiguration.html#cfn-quicksight-analysis-piechartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartsortconfiguration.html#cfn-quicksight-analysis-piechartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartsortconfiguration.html#cfn-quicksight-analysis-piechartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Analysis.PieChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PieChartVisual`\n\nA pie or donut chart.\nThe `PieChartVisual` structure describes a visual that is a member of the pie chart family.\nThe following charts can be described by using this structure:\n* Pie charts\n* Donut charts\nFor more information, see [Using pie charts](https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the *Amazon Quick Suite User Guide*.\nFor more information, see [Using donut charts](https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartvisual.html#cfn-quicksight-analysis-piechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartvisual.html#cfn-quicksight-analysis-piechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartConfiguration](./aws-properties-quicksight-analysis-piechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartvisual.html#cfn-quicksight-analysis-piechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PieChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartvisual.html#cfn-quicksight-analysis-piechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartvisual.html#cfn-quicksight-analysis-piechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartvisual.html#cfn-quicksight-analysis-piechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-piechartvisual.html#cfn-quicksight-analysis-piechartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PivotFieldSortOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotFieldSortOptions`\n\nThe field sort options for a pivot table sort configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivotfieldsortoptions.html", "Properties": { "SortBy": { "MarkdownDocumentation": "`SortBy`\n\nThe sort by field for the field sort options.\n*Required*: Yes\n*Type*: [PivotTableSortBy](./aws-properties-quicksight-analysis-pivottablesortby.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivotfieldsortoptions.html#cfn-quicksight-analysis-pivotfieldsortoptions-sortby", "UpdateType": "Mutable", "Required": true, "Type": "PivotTableSortBy" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for the field sort options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivotfieldsortoptions.html#cfn-quicksight-analysis-pivotfieldsortoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTableAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableAggregatedFieldWells`\n\nThe aggregated field well for the pivot table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are aggregated based on rows and columns fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableaggregatedfieldwells.html#cfn-quicksight-analysis-pivottableaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe columns field well for a pivot table. Values are grouped by columns fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableaggregatedfieldwells.html#cfn-quicksight-analysis-pivottableaggregatedfieldwells-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Rows": { "MarkdownDocumentation": "`Rows`\n\nThe rows field well for a pivot table. Values are grouped by rows fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableaggregatedfieldwells.html#cfn-quicksight-analysis-pivottableaggregatedfieldwells-rows", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PivotTableCellConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableCellConditionalFormatting`\n\nThe cell conditional formatting option for a pivot table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablecellconditionalformatting.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope of the cell for conditional formatting.\n*Required*: No\n*Type*: [PivotTableConditionalFormattingScope](./aws-properties-quicksight-analysis-pivottableconditionalformattingscope.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablecellconditionalformatting.html#cfn-quicksight-analysis-pivottablecellconditionalformatting-scope", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConditionalFormattingScope" }, "Scopes": { "MarkdownDocumentation": "`Scopes`\n\nA list of cell scopes for conditional formatting.\n*Required*: No\n*Type*: Array of [PivotTableConditionalFormattingScope](./aws-properties-quicksight-analysis-pivottableconditionalformattingscope.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablecellconditionalformatting.html#cfn-quicksight-analysis-pivottablecellconditionalformatting-scopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableConditionalFormattingScope", "DuplicatesAllowed": true }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the cell for conditional formatting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablecellconditionalformatting.html#cfn-quicksight-analysis-pivottablecellconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TextFormat": { "MarkdownDocumentation": "`TextFormat`\n\nThe text format of the cell for conditional formatting.\n*Required*: No\n*Type*: [TextConditionalFormat](./aws-properties-quicksight-analysis-textconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablecellconditionalformatting.html#cfn-quicksight-analysis-pivottablecellconditionalformatting-textformat", "UpdateType": "Mutable", "Required": false, "Type": "TextConditionalFormat" } } }, "AWS::QuickSight::Analysis.PivotTableConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options for a `PivotTableVisual`.\n*Required*: No\n*Type*: Array of [PivotTableConditionalFormattingOption](./aws-properties-quicksight-analysis-pivottableconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconditionalformatting.html#cfn-quicksight-analysis-pivottableconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PivotTableConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableConditionalFormattingOption`\n\nConditional formatting options for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconditionalformattingoption.html", "Properties": { "Cell": { "MarkdownDocumentation": "`Cell`\n\nThe cell conditional formatting option for a pivot table.\n*Required*: No\n*Type*: [PivotTableCellConditionalFormatting](./aws-properties-quicksight-analysis-pivottablecellconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconditionalformattingoption.html#cfn-quicksight-analysis-pivottableconditionalformattingoption-cell", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableCellConditionalFormatting" } } }, "AWS::QuickSight::Analysis.PivotTableConditionalFormattingScope": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableConditionalFormattingScope`\n\nThe scope of the cell for conditional formatting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconditionalformattingscope.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe role (field, field total, grand total) of the cell for conditional formatting.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIELD | FIELD_TOTAL | GRAND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIELD", "FIELD_TOTAL", "GRAND_TOTAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconditionalformattingscope.html#cfn-quicksight-analysis-pivottableconditionalformattingscope-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTableConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableConfiguration`\n\nThe configuration for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration for a `PivotTableVisual`.\n*Required*: No\n*Type*: [PivotTableSortConfiguration](./aws-properties-quicksight-analysis-pivottablesortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconfiguration.html#cfn-quicksight-analysis-pivottableconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableSortConfiguration" }, "PaginatedReportOptions": { "MarkdownDocumentation": "`PaginatedReportOptions`\n\nThe paginated report options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTablePaginatedReportOptions](./aws-properties-quicksight-analysis-pivottablepaginatedreportoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconfiguration.html#cfn-quicksight-analysis-pivottableconfiguration-paginatedreportoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTablePaginatedReportOptions" }, "TableOptions": { "MarkdownDocumentation": "`TableOptions`\n\nThe table options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableOptions](./aws-properties-quicksight-analysis-pivottableoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconfiguration.html#cfn-quicksight-analysis-pivottableconfiguration-tableoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [PivotTableFieldWells](./aws-properties-quicksight-analysis-pivottablefieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconfiguration.html#cfn-quicksight-analysis-pivottableconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableFieldWells" }, "FieldOptions": { "MarkdownDocumentation": "`FieldOptions`\n\nThe field options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableFieldOptions](./aws-properties-quicksight-analysis-pivottablefieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconfiguration.html#cfn-quicksight-analysis-pivottableconfiguration-fieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableFieldOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconfiguration.html#cfn-quicksight-analysis-pivottableconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "TotalOptions": { "MarkdownDocumentation": "`TotalOptions`\n\nThe total options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableTotalOptions](./aws-properties-quicksight-analysis-pivottabletotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableconfiguration.html#cfn-quicksight-analysis-pivottableconfiguration-totaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableTotalOptions" } } }, "AWS::QuickSight::Analysis.PivotTableDataPathOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableDataPathOption`\n\nThe data path options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottabledatapathoption.html", "Properties": { "DataPathList": { "MarkdownDocumentation": "`DataPathList`\n\nThe list of data path values for the data path options.\n*Required*: Yes\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-analysis-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottabledatapathoption.html#cfn-quicksight-analysis-pivottabledatapathoption-datapathlist", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of the data path 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottabledatapathoption.html#cfn-quicksight-analysis-pivottabledatapathoption-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTableFieldCollapseStateOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableFieldCollapseStateOption`\n\nThe collapse state options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldcollapsestateoption.html", "Properties": { "Target": { "MarkdownDocumentation": "`Target`\n\nA tagged-union object that sets the collapse state.\n*Required*: Yes\n*Type*: [PivotTableFieldCollapseStateTarget](./aws-properties-quicksight-analysis-pivottablefieldcollapsestatetarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldcollapsestateoption.html#cfn-quicksight-analysis-pivottablefieldcollapsestateoption-target", "UpdateType": "Mutable", "Required": true, "Type": "PivotTableFieldCollapseStateTarget" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the field target of a pivot table. Choose one of the following options:\n* `COLLAPSED`\n* `EXPANDED`\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)", "RefReturnValue": "", "AllowedValues": [ "COLLAPSED", "EXPANDED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldcollapsestateoption.html#cfn-quicksight-analysis-pivottablefieldcollapsestateoption-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTableFieldCollapseStateTarget": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableFieldCollapseStateTarget`\n\nThe target of a pivot table field collapse state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldcollapsestatetarget.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the pivot table that the collapse state needs to be set 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldcollapsestatetarget.html#cfn-quicksight-analysis-pivottablefieldcollapsestatetarget-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldDataPathValues": { "MarkdownDocumentation": "`FieldDataPathValues`\n\nThe data path of the pivot table's header. Used to set the collapse state.\n*Required*: No\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-analysis-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldcollapsestatetarget.html#cfn-quicksight-analysis-pivottablefieldcollapsestatetarget-fielddatapathvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PivotTableFieldOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableFieldOption`\n\nThe selected field options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldoption.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label of the pivot table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldoption.html#cfn-quicksight-analysis-pivottablefieldoption-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the pivot table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldoption.html#cfn-quicksight-analysis-pivottablefieldoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the pivot table field.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldoption.html#cfn-quicksight-analysis-pivottablefieldoption-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTableFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableFieldOptions`\n\nThe field options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldoptions.html", "Properties": { "CollapseStateOptions": { "MarkdownDocumentation": "`CollapseStateOptions`\n\nThe collapse state options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableFieldCollapseStateOption](./aws-properties-quicksight-analysis-pivottablefieldcollapsestateoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldoptions.html#cfn-quicksight-analysis-pivottablefieldoptions-collapsestateoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldCollapseStateOption", "DuplicatesAllowed": true }, "DataPathOptions": { "MarkdownDocumentation": "`DataPathOptions`\n\nThe data path options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableDataPathOption](./aws-properties-quicksight-analysis-pivottabledatapathoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldoptions.html#cfn-quicksight-analysis-pivottablefieldoptions-datapathoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableDataPathOption", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nThe selected field options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableFieldOption](./aws-properties-quicksight-analysis-pivottablefieldoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldoptions.html#cfn-quicksight-analysis-pivottablefieldoptions-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PivotTableFieldSubtotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableFieldSubtotalOptions`\n\nThe optional configuration of subtotals cells.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldsubtotaloptions.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the subtotal options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldsubtotaloptions.html#cfn-quicksight-analysis-pivottablefieldsubtotaloptions-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTableFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableFieldWells`\n\nThe field wells for a pivot table visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldwells.html", "Properties": { "PivotTableAggregatedFieldWells": { "MarkdownDocumentation": "`PivotTableAggregatedFieldWells`\n\nThe aggregated field well for the pivot table.\n*Required*: No\n*Type*: [PivotTableAggregatedFieldWells](./aws-properties-quicksight-analysis-pivottableaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablefieldwells.html#cfn-quicksight-analysis-pivottablefieldwells-pivottableaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.PivotTableOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableOptions`\n\nThe table options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html", "Properties": { "RowFieldNamesStyle": { "MarkdownDocumentation": "`RowFieldNamesStyle`\n\nThe table cell style of row field names.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-rowfieldnamesstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "RowHeaderStyle": { "MarkdownDocumentation": "`RowHeaderStyle`\n\nThe table cell style of the row headers.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-rowheaderstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "CollapsedRowDimensionsVisibility": { "MarkdownDocumentation": "`CollapsedRowDimensionsVisibility`\n\nThe visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is `HIDDEN`, all collapsed columns in a pivot table are automatically hidden. The default value is `VISIBLE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-collapsedrowdimensionsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowsLayout": { "MarkdownDocumentation": "`RowsLayout`\n\nThe layout for the row dimension headers of a pivot table. Choose one of the following options.\n* `TABULAR`: (Default) Each row field is displayed in a separate column.\n* `HIERARCHY`: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `TABULAR | HIERARCHY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TABULAR", "HIERARCHY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-rowslayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricPlacement": { "MarkdownDocumentation": "`MetricPlacement`\n\nThe metric placement (row, column) options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ROW | COLUMN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROW", "COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-metricplacement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultCellWidth": { "MarkdownDocumentation": "`DefaultCellWidth`\n\nThe default cell width of the pivot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-defaultcellwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnNamesVisibility": { "MarkdownDocumentation": "`ColumnNamesVisibility`\n\nThe visibility of the column names.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-columnnamesvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowsLabelOptions": { "MarkdownDocumentation": "`RowsLabelOptions`\n\nThe options for the label that is located above the row headers. This option is only applicable when `RowsLayout` is set to `HIERARCHY`.\n*Required*: No\n*Type*: [PivotTableRowsLabelOptions](./aws-properties-quicksight-analysis-pivottablerowslabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-rowslabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableRowsLabelOptions" }, "SingleMetricVisibility": { "MarkdownDocumentation": "`SingleMetricVisibility`\n\nThe visibility of the single metric options.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-singlemetricvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHeaderStyle": { "MarkdownDocumentation": "`ColumnHeaderStyle`\n\nThe table cell style of the column header.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-columnheaderstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "ToggleButtonsVisibility": { "MarkdownDocumentation": "`ToggleButtonsVisibility`\n\nDetermines the visibility of the pivot table.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-togglebuttonsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CellStyle": { "MarkdownDocumentation": "`CellStyle`\n\nThe table cell style of cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-cellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "RowAlternateColorOptions": { "MarkdownDocumentation": "`RowAlternateColorOptions`\n\nThe row alternate color options (widget status, row alternate colors).\n*Required*: No\n*Type*: [RowAlternateColorOptions](./aws-properties-quicksight-analysis-rowalternatecoloroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottableoptions.html#cfn-quicksight-analysis-pivottableoptions-rowalternatecoloroptions", "UpdateType": "Mutable", "Required": false, "Type": "RowAlternateColorOptions" } } }, "AWS::QuickSight::Analysis.PivotTablePaginatedReportOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTablePaginatedReportOptions`\n\nThe paginated report options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablepaginatedreportoptions.html", "Properties": { "OverflowColumnHeaderVisibility": { "MarkdownDocumentation": "`OverflowColumnHeaderVisibility`\n\nThe visibility of the repeating header rows on each page.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablepaginatedreportoptions.html#cfn-quicksight-analysis-pivottablepaginatedreportoptions-overflowcolumnheadervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VerticalOverflowVisibility": { "MarkdownDocumentation": "`VerticalOverflowVisibility`\n\nThe visibility of the printing table overflow across pages.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablepaginatedreportoptions.html#cfn-quicksight-analysis-pivottablepaginatedreportoptions-verticaloverflowvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTableRowsLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableRowsLabelOptions`\n\nThe options for the label thta is located above the row headers. This option is only applicable when `RowsLayout` is set to `HIERARCHY`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablerowslabeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the rows label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablerowslabeloptions.html#cfn-quicksight-analysis-pivottablerowslabeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the rows label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablerowslabeloptions.html#cfn-quicksight-analysis-pivottablerowslabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTableSortBy": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableSortBy`\n\nThe sort by field for the field sort options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablesortby.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field sort (field id, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [FieldSort](./aws-properties-quicksight-analysis-fieldsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablesortby.html#cfn-quicksight-analysis-pivottablesortby-field", "UpdateType": "Mutable", "Required": false, "Type": "FieldSort" }, "DataPath": { "MarkdownDocumentation": "`DataPath`\n\nThe data path sort (data path value, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [DataPathSort](./aws-properties-quicksight-analysis-datapathsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablesortby.html#cfn-quicksight-analysis-pivottablesortby-datapath", "UpdateType": "Mutable", "Required": false, "Type": "DataPathSort" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column sort (field id, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [ColumnSort](./aws-properties-quicksight-analysis-columnsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablesortby.html#cfn-quicksight-analysis-pivottablesortby-column", "UpdateType": "Mutable", "Required": false, "Type": "ColumnSort" } } }, "AWS::QuickSight::Analysis.PivotTableSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableSortConfiguration`\n\nThe sort configuration for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablesortconfiguration.html", "Properties": { "FieldSortOptions": { "MarkdownDocumentation": "`FieldSortOptions`\n\nThe field sort options for a pivot table sort configuration.\n*Required*: No\n*Type*: [Array](./aws-properties-quicksight-analysis-fieldsortoptions.html) of [PivotFieldSortOptions](./aws-properties-quicksight-analysis-pivotfieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablesortconfiguration.html#cfn-quicksight-analysis-pivottablesortconfiguration-fieldsortoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotFieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PivotTableTotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableTotalOptions`\n\nThe total options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottabletotaloptions.html", "Properties": { "ColumnSubtotalOptions": { "MarkdownDocumentation": "`ColumnSubtotalOptions`\n\nThe column subtotal options.\n*Required*: No\n*Type*: [SubtotalOptions](./aws-properties-quicksight-analysis-subtotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottabletotaloptions.html#cfn-quicksight-analysis-pivottabletotaloptions-columnsubtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "SubtotalOptions" }, "RowSubtotalOptions": { "MarkdownDocumentation": "`RowSubtotalOptions`\n\nThe row subtotal options.\n*Required*: No\n*Type*: [SubtotalOptions](./aws-properties-quicksight-analysis-subtotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottabletotaloptions.html#cfn-quicksight-analysis-pivottabletotaloptions-rowsubtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "SubtotalOptions" }, "RowTotalOptions": { "MarkdownDocumentation": "`RowTotalOptions`\n\nThe row total options.\n*Required*: No\n*Type*: [PivotTotalOptions](./aws-properties-quicksight-analysis-pivottotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottabletotaloptions.html#cfn-quicksight-analysis-pivottabletotaloptions-rowtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTotalOptions" }, "ColumnTotalOptions": { "MarkdownDocumentation": "`ColumnTotalOptions`\n\nThe column total options.\n*Required*: No\n*Type*: [PivotTotalOptions](./aws-properties-quicksight-analysis-pivottotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottabletotaloptions.html#cfn-quicksight-analysis-pivottabletotaloptions-columntotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTotalOptions" } } }, "AWS::QuickSight::Analysis.PivotTableVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTableVisual`\n\nA pivot table.\nFor more information, see [Using pivot tables](https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablevisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablevisual.html#cfn-quicksight-analysis-pivottablevisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n*Required*: No\n*Type*: [PivotTableConditionalFormatting](./aws-properties-quicksight-analysis-pivottableconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablevisual.html#cfn-quicksight-analysis-pivottablevisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablevisual.html#cfn-quicksight-analysis-pivottablevisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [PivotTableConfiguration](./aws-properties-quicksight-analysis-pivottableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablevisual.html#cfn-quicksight-analysis-pivottablevisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablevisual.html#cfn-quicksight-analysis-pivottablevisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablevisual.html#cfn-quicksight-analysis-pivottablevisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottablevisual.html#cfn-quicksight-analysis-pivottablevisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PivotTotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PivotTotalOptions`\n\nThe optional configuration of totals cells in a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html", "Properties": { "TotalAggregationOptions": { "MarkdownDocumentation": "`TotalAggregationOptions`\n\nThe total aggregation options for each value field.\n*Required*: No\n*Type*: Array of [TotalAggregationOption](./aws-properties-quicksight-analysis-totalaggregationoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-totalaggregationoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TotalAggregationOption", "DuplicatesAllowed": true }, "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the total cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueCellStyle": { "MarkdownDocumentation": "`ValueCellStyle`\n\nThe cell styling options for the totals of value cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-valuecellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "ScrollStatus": { "MarkdownDocumentation": "`ScrollStatus`\n\nThe scroll status (pinned, scrolled) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `PINNED | SCROLLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PINNED", "SCROLLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-scrollstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe placement (start, end) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `START | END | AUTO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "START", "END", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nThe cell styling options for the total cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricHeaderCellStyle": { "MarkdownDocumentation": "`MetricHeaderCellStyle`\n\nThe cell styling options for the total of header cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pivottotaloptions.html#cfn-quicksight-analysis-pivottotaloptions-metricheadercellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" } } }, "AWS::QuickSight::Analysis.PluginVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PluginVisual`\n\nA flexible visualization type that allows engineers\nto create new custom charts in Quick Sight.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisual.html#cfn-quicksight-analysis-pluginvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "PluginArn": { "MarkdownDocumentation": "`PluginArn`\n\nThe Amazon Resource Name (ARN) that reflects the plugin and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisual.html#cfn-quicksight-analysis-pluginvisual-pluginarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe ID of the visual that you want to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisual.html#cfn-quicksight-analysis-pluginvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nA description of the plugin field wells and their persisted properties.\n*Required*: No\n*Type*: [PluginVisualConfiguration](./aws-properties-quicksight-analysis-pluginvisualconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisual.html#cfn-quicksight-analysis-pluginvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisual.html#cfn-quicksight-analysis-pluginvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisual.html#cfn-quicksight-analysis-pluginvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PluginVisualConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PluginVisualConfiguration`\n\nThe plugin visual configuration. This includes the field wells, sorting options, and persisted options of the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of the plugin visual.\n*Required*: No\n*Type*: [PluginVisualSortConfiguration](./aws-properties-quicksight-analysis-pluginvisualsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualconfiguration.html#cfn-quicksight-analysis-pluginvisualconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualSortConfiguration" }, "VisualOptions": { "MarkdownDocumentation": "`VisualOptions`\n\nThe persisted properties of the plugin visual.\n*Required*: No\n*Type*: [PluginVisualOptions](./aws-properties-quicksight-analysis-pluginvisualoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualconfiguration.html#cfn-quicksight-analysis-pluginvisualconfiguration-visualoptions", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells configuration of the plugin visual.\n*Required*: No\n*Type*: Array of [PluginVisualFieldWell](./aws-properties-quicksight-analysis-pluginvisualfieldwell.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualconfiguration.html#cfn-quicksight-analysis-pluginvisualconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PluginVisualFieldWell", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PluginVisualFieldWell": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PluginVisualFieldWell`\n\nA collection of field wells for a plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualfieldwell.html", "Properties": { "Unaggregated": { "MarkdownDocumentation": "`Unaggregated`\n\nA list of unaggregated fields that exist in the field well.\n*Required*: No\n*Type*: Array of [UnaggregatedField](./aws-properties-quicksight-analysis-unaggregatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualfieldwell.html#cfn-quicksight-analysis-pluginvisualfieldwell-unaggregated", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UnaggregatedField", "DuplicatesAllowed": true }, "AxisName": { "MarkdownDocumentation": "`AxisName`\n\nThe semantic axis name for the field well.\n*Required*: No\n*Type*: String\n*Allowed values*: `GROUP_BY | VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GROUP_BY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualfieldwell.html#cfn-quicksight-analysis-pluginvisualfieldwell-axisname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Measures": { "MarkdownDocumentation": "`Measures`\n\nA list of measures that exist in the field well.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualfieldwell.html#cfn-quicksight-analysis-pluginvisualfieldwell-measures", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nA list of dimensions for the field well.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualfieldwell.html#cfn-quicksight-analysis-pluginvisualfieldwell-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PluginVisualItemsLimitConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PluginVisualItemsLimitConfiguration`\n\nA query limits configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualitemslimitconfiguration.html", "Properties": { "ItemsLimit": { "MarkdownDocumentation": "`ItemsLimit`\n\nDetermines how many values are be fetched at once.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualitemslimitconfiguration.html#cfn-quicksight-analysis-pluginvisualitemslimitconfiguration-itemslimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.PluginVisualOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PluginVisualOptions`\n\nThe options and persisted properties for the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualoptions.html", "Properties": { "VisualProperties": { "MarkdownDocumentation": "`VisualProperties`\n\nThe persisted properties and their values.\n*Required*: No\n*Type*: Array of [PluginVisualProperty](./aws-properties-quicksight-analysis-pluginvisualproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualoptions.html#cfn-quicksight-analysis-pluginvisualoptions-visualproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PluginVisualProperty", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PluginVisualProperty": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PluginVisualProperty`\n\nThe key value pair of the persisted property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualproperty.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the plugin visual 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualproperty.html#cfn-quicksight-analysis-pluginvisualproperty-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the plugin visual 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualproperty.html#cfn-quicksight-analysis-pluginvisualproperty-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.PluginVisualSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PluginVisualSortConfiguration`\n\nDetermines how the plugin visual sorts the data during query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualsortconfiguration.html", "Properties": { "PluginVisualTableQuerySort": { "MarkdownDocumentation": "`PluginVisualTableQuerySort`\n\nThe table query sorting options for the plugin visual.\n*Required*: No\n*Type*: [PluginVisualTableQuerySort](./aws-properties-quicksight-analysis-pluginvisualtablequerysort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualsortconfiguration.html#cfn-quicksight-analysis-pluginvisualsortconfiguration-pluginvisualtablequerysort", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualTableQuerySort" } } }, "AWS::QuickSight::Analysis.PluginVisualTableQuerySort": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PluginVisualTableQuerySort`\n\nThe table query sorting options for the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualtablequerysort.html", "Properties": { "ItemsLimitConfiguration": { "MarkdownDocumentation": "`ItemsLimitConfiguration`\n\nThe maximum amount of data to be returned by a query.\n*Required*: No\n*Type*: [PluginVisualItemsLimitConfiguration](./aws-properties-quicksight-analysis-pluginvisualitemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualtablequerysort.html#cfn-quicksight-analysis-pluginvisualtablequerysort-itemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualItemsLimitConfiguration" }, "RowSort": { "MarkdownDocumentation": "`RowSort`\n\nDetermines how data is sorted in the response.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-pluginvisualtablequerysort.html#cfn-quicksight-analysis-pluginvisualtablequerysort-rowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.PredefinedHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.PredefinedHierarchy`\n\nThe option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-predefinedhierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the predefined hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-predefinedhierarchy.html#cfn-quicksight-analysis-predefinedhierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the predefined hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-analysis-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-predefinedhierarchy.html#cfn-quicksight-analysis-predefinedhierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe list of columns that define the predefined hierarchy.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-predefinedhierarchy.html#cfn-quicksight-analysis-predefinedhierarchy-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ProgressBarOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ProgressBarOptions`\n\nThe options that determine the presentation of the progress bar of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-progressbaroptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the progress bar.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-progressbaroptions.html#cfn-quicksight-analysis-progressbaroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.QueryExecutionOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.QueryExecutionOptions`\n\nA structure that describes the query execution options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-queryexecutionoptions.html", "Properties": { "QueryExecutionMode": { "MarkdownDocumentation": "`QueryExecutionMode`\n\nA structure that describes the query execution 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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-queryexecutionoptions.html#cfn-quicksight-analysis-queryexecutionoptions-queryexecutionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.RadarChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RadarChartAggregatedFieldWells`\n\nThe aggregated field well configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe aggregated field well categories of a radar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartaggregatedfieldwells.html#cfn-quicksight-analysis-radarchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that are assigned to the aggregated field wells of a radar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartaggregatedfieldwells.html#cfn-quicksight-analysis-radarchartaggregatedfieldwells-color", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are assigned to the aggregated field wells of a radar chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartaggregatedfieldwells.html#cfn-quicksight-analysis-radarchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.RadarChartAreaStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RadarChartAreaStyleSettings`\n\nThe configured style settings of a radar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartareastylesettings.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility settings of a radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartareastylesettings.html#cfn-quicksight-analysis-radarchartareastylesettings-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.RadarChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RadarChartConfiguration`\n\nThe configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `RadarChartVisual`.\n*Required*: No\n*Type*: [RadarChartSortConfiguration](./aws-properties-quicksight-analysis-radarchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "Shape": { "MarkdownDocumentation": "`Shape`\n\nThe shape of the radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `CIRCLE | POLYGON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIRCLE", "POLYGON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-shape", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseSeriesSettings": { "MarkdownDocumentation": "`BaseSeriesSettings`\n\nThe base sreies settings of a radar chart.\n*Required*: No\n*Type*: [RadarChartSeriesSettings](./aws-properties-quicksight-analysis-radarchartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-baseseriessettings", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartSeriesSettings" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe color label options of a radar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe category label options of a radar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "AxesRangeScale": { "MarkdownDocumentation": "`AxesRangeScale`\n\nThe axis behavior options of a radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTO | INDEPENDENT | SHARED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "INDEPENDENT", "SHARED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-axesrangescale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "AlternateBandColorsVisibility": { "MarkdownDocumentation": "`AlternateBandColorsVisibility`\n\nDetermines the visibility of the colors of alternatign bands in a radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-alternatebandcolorsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartAngle": { "MarkdownDocumentation": "`StartAngle`\n\nThe start angle of a radar chart's axis.\n*Required*: No\n*Type*: Number\n*Minimum*: `-360`\n*Maximum*: `360`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-startangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe category axis of a radar chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `RadarChartVisual`.\n*Required*: No\n*Type*: [RadarChartFieldWells](./aws-properties-quicksight-analysis-radarchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartFieldWells" }, "ColorAxis": { "MarkdownDocumentation": "`ColorAxis`\n\nThe color axis of a radar chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-coloraxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "AlternateBandOddColor": { "MarkdownDocumentation": "`AlternateBandOddColor`\n\nThe color of the odd-numbered alternate bands of a radar chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-alternatebandoddcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "AlternateBandEvenColor": { "MarkdownDocumentation": "`AlternateBandEvenColor`\n\nThe color of the even-numbered alternate bands of a radar chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartconfiguration.html#cfn-quicksight-analysis-radarchartconfiguration-alternatebandevencolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.RadarChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RadarChartFieldWells`\n\nThe field wells of a radar chart visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartfieldwells.html", "Properties": { "RadarChartAggregatedFieldWells": { "MarkdownDocumentation": "`RadarChartAggregatedFieldWells`\n\nThe aggregated field wells of a radar chart visual.\n*Required*: No\n*Type*: [RadarChartAggregatedFieldWells](./aws-properties-quicksight-analysis-radarchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartfieldwells.html#cfn-quicksight-analysis-radarchartfieldwells-radarchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.RadarChartSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RadarChartSeriesSettings`\n\nThe series settings of a radar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartseriessettings.html", "Properties": { "AreaStyleSettings": { "MarkdownDocumentation": "`AreaStyleSettings`\n\nThe area style settings of a radar chart.\n*Required*: No\n*Type*: [RadarChartAreaStyleSettings](./aws-properties-quicksight-analysis-radarchartareastylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartseriessettings.html#cfn-quicksight-analysis-radarchartseriessettings-areastylesettings", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartAreaStyleSettings" } } }, "AWS::QuickSight::Analysis.RadarChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RadarChartSortConfiguration`\n\nThe sort configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartsortconfiguration.html", "Properties": { "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe color sort configuration of a radar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartsortconfiguration.html#cfn-quicksight-analysis-radarchartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe color items limit of a radar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartsortconfiguration.html#cfn-quicksight-analysis-radarchartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe category items limit for a radar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartsortconfiguration.html#cfn-quicksight-analysis-radarchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe category sort options of a radar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartsortconfiguration.html#cfn-quicksight-analysis-radarchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.RadarChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RadarChartVisual`\n\nA radar chart visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartvisual.html#cfn-quicksight-analysis-radarchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartvisual.html#cfn-quicksight-analysis-radarchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [RadarChartConfiguration](./aws-properties-quicksight-analysis-radarchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartvisual.html#cfn-quicksight-analysis-radarchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartvisual.html#cfn-quicksight-analysis-radarchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartvisual.html#cfn-quicksight-analysis-radarchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartvisual.html#cfn-quicksight-analysis-radarchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-radarchartvisual.html#cfn-quicksight-analysis-radarchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.RangeEndsLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RangeEndsLabelType`\n\nThe range ends label type of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rangeendslabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the range ends label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rangeendslabeltype.html#cfn-quicksight-analysis-rangeendslabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ReferenceLine": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ReferenceLine`\n\nThe reference line visual display options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referenceline.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the reference line. Choose one of the following options:\n* `ENABLE`\n* `DISABLE`\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referenceline.html#cfn-quicksight-analysis-referenceline-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataConfiguration": { "MarkdownDocumentation": "`DataConfiguration`\n\nThe data configuration of the reference line.\n*Required*: Yes\n*Type*: [ReferenceLineDataConfiguration](./aws-properties-quicksight-analysis-referencelinedataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referenceline.html#cfn-quicksight-analysis-referenceline-dataconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ReferenceLineDataConfiguration" }, "LabelConfiguration": { "MarkdownDocumentation": "`LabelConfiguration`\n\nThe label configuration of the reference line.\n*Required*: No\n*Type*: [ReferenceLineLabelConfiguration](./aws-properties-quicksight-analysis-referencelinelabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referenceline.html#cfn-quicksight-analysis-referenceline-labelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineLabelConfiguration" }, "StyleConfiguration": { "MarkdownDocumentation": "`StyleConfiguration`\n\nThe style configuration of the reference line.\n*Required*: No\n*Type*: [ReferenceLineStyleConfiguration](./aws-properties-quicksight-analysis-referencelinestyleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referenceline.html#cfn-quicksight-analysis-referenceline-styleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineStyleConfiguration" } } }, "AWS::QuickSight::Analysis.ReferenceLineCustomLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ReferenceLineCustomLabelConfiguration`\n\nThe configuration for a custom label on a `ReferenceLine`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinecustomlabelconfiguration.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe string text of the custom label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinecustomlabelconfiguration.html#cfn-quicksight-analysis-referencelinecustomlabelconfiguration-customlabel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ReferenceLineDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ReferenceLineDataConfiguration`\n\nThe data configuration of the reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedataconfiguration.html", "Properties": { "DynamicConfiguration": { "MarkdownDocumentation": "`DynamicConfiguration`\n\nThe dynamic configuration of the reference line data configuration.\n*Required*: No\n*Type*: [ReferenceLineDynamicDataConfiguration](./aws-properties-quicksight-analysis-referencelinedynamicdataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedataconfiguration.html#cfn-quicksight-analysis-referencelinedataconfiguration-dynamicconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineDynamicDataConfiguration" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis binding type of the reference line. Choose one of the following options:\n* `PrimaryY`\n* `SecondaryY`\n*Required*: No\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedataconfiguration.html#cfn-quicksight-analysis-referencelinedataconfiguration-axisbinding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeriesType": { "MarkdownDocumentation": "`SeriesType`\n\nThe series type of the reference line data configuration. Choose one of the following options:\n* `BAR`\n* `LINE`\n*Required*: No\n*Type*: String\n*Allowed values*: `BAR | LINE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedataconfiguration.html#cfn-quicksight-analysis-referencelinedataconfiguration-seriestype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StaticConfiguration": { "MarkdownDocumentation": "`StaticConfiguration`\n\nThe static data configuration of the reference line data configuration.\n*Required*: No\n*Type*: [ReferenceLineStaticDataConfiguration](./aws-properties-quicksight-analysis-referencelinestaticdataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedataconfiguration.html#cfn-quicksight-analysis-referencelinedataconfiguration-staticconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineStaticDataConfiguration" } } }, "AWS::QuickSight::Analysis.ReferenceLineDynamicDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ReferenceLineDynamicDataConfiguration`\n\nThe dynamic configuration of the reference line data configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedynamicdataconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the dynamic data targets.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedynamicdataconfiguration.html#cfn-quicksight-analysis-referencelinedynamicdataconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "MeasureAggregationFunction": { "MarkdownDocumentation": "`MeasureAggregationFunction`\n\nThe aggregation function that is used in the dynamic data.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-analysis-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedynamicdataconfiguration.html#cfn-quicksight-analysis-referencelinedynamicdataconfiguration-measureaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Calculation": { "MarkdownDocumentation": "`Calculation`\n\nThe calculation that is used in the dynamic data.\n*Required*: Yes\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-analysis-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinedynamicdataconfiguration.html#cfn-quicksight-analysis-referencelinedynamicdataconfiguration-calculation", "UpdateType": "Mutable", "Required": true, "Type": "NumericalAggregationFunction" } } }, "AWS::QuickSight::Analysis.ReferenceLineLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ReferenceLineLabelConfiguration`\n\nThe label configuration of a reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinelabelconfiguration.html", "Properties": { "HorizontalPosition": { "MarkdownDocumentation": "`HorizontalPosition`\n\nThe horizontal position configuration of the label in a reference line. Choose one of\nthe following options:\n* `LEFT`\n* `CENTER`\n* `RIGHT`\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinelabelconfiguration.html#cfn-quicksight-analysis-referencelinelabelconfiguration-horizontalposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueLabelConfiguration": { "MarkdownDocumentation": "`ValueLabelConfiguration`\n\nThe value label configuration of the label in a reference line.\n*Required*: No\n*Type*: [ReferenceLineValueLabelConfiguration](./aws-properties-quicksight-analysis-referencelinevaluelabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinelabelconfiguration.html#cfn-quicksight-analysis-referencelinelabelconfiguration-valuelabelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineValueLabelConfiguration" }, "CustomLabelConfiguration": { "MarkdownDocumentation": "`CustomLabelConfiguration`\n\nThe custom label configuration of the label in a reference line.\n*Required*: No\n*Type*: [ReferenceLineCustomLabelConfiguration](./aws-properties-quicksight-analysis-referencelinecustomlabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinelabelconfiguration.html#cfn-quicksight-analysis-referencelinelabelconfiguration-customlabelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineCustomLabelConfiguration" }, "FontColor": { "MarkdownDocumentation": "`FontColor`\n\nThe font color configuration of the label in a reference line.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinelabelconfiguration.html#cfn-quicksight-analysis-referencelinelabelconfiguration-fontcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the label in a reference line.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinelabelconfiguration.html#cfn-quicksight-analysis-referencelinelabelconfiguration-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "VerticalPosition": { "MarkdownDocumentation": "`VerticalPosition`\n\nThe vertical position configuration of the label in a reference line. Choose one of the following options:\n* `ABOVE`\n* `BELOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `ABOVE | BELOW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ABOVE", "BELOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinelabelconfiguration.html#cfn-quicksight-analysis-referencelinelabelconfiguration-verticalposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ReferenceLineStaticDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ReferenceLineStaticDataConfiguration`\n\nThe static data configuration of the reference line data configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinestaticdataconfiguration.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe double input of the static data.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinestaticdataconfiguration.html#cfn-quicksight-analysis-referencelinestaticdataconfiguration-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.ReferenceLineStyleConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ReferenceLineStyleConfiguration`\n\nThe style configuration of the reference\nline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinestyleconfiguration.html", "Properties": { "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nThe pattern type of the line style. Choose one of the following options:\n* `SOLID`\n* `DASHED`\n* `DOTTED`\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DASHED | DOTTED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DASHED", "DOTTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinestyleconfiguration.html#cfn-quicksight-analysis-referencelinestyleconfiguration-pattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe hex color of the reference line.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinestyleconfiguration.html#cfn-quicksight-analysis-referencelinestyleconfiguration-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ReferenceLineValueLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ReferenceLineValueLabelConfiguration`\n\nThe value label configuration of the label in a reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinevaluelabelconfiguration.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the value label.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-analysis-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinevaluelabelconfiguration.html#cfn-quicksight-analysis-referencelinevaluelabelconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "RelativePosition": { "MarkdownDocumentation": "`RelativePosition`\n\nThe relative position of the value label. Choose one of the following options:\n* `BEFORE_CUSTOM_LABEL`\n* `AFTER_CUSTOM_LABEL`\n*Required*: No\n*Type*: String\n*Allowed values*: `BEFORE_CUSTOM_LABEL | AFTER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BEFORE_CUSTOM_LABEL", "AFTER_CUSTOM_LABEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-referencelinevaluelabelconfiguration.html#cfn-quicksight-analysis-referencelinevaluelabelconfiguration-relativeposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.RelativeDateTimeControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RelativeDateTimeControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatetimecontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatetimecontroldisplayoptions.html#cfn-quicksight-analysis-relativedatetimecontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatetimecontroldisplayoptions.html#cfn-quicksight-analysis-relativedatetimecontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nCustomize how dates are formatted in controls.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatetimecontroldisplayoptions.html#cfn-quicksight-analysis-relativedatetimecontroldisplayoptions-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.RelativeDatesFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RelativeDatesFilter`\n\nA `RelativeDatesFilter` filters relative dates values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html", "Properties": { "RelativeDateValue": { "MarkdownDocumentation": "`RelativeDateValue`\n\nThe date value of the filter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-relativedatevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RelativeDateType": { "MarkdownDocumentation": "`RelativeDateType`\n\nThe range date type of the filter. Choose one of the options below:\n* `PREVIOUS`\n* `THIS`\n* `LAST`\n* `NOW`\n* `NEXT`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PREVIOUS | THIS | LAST | NO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PREVIOUS", "THIS", "LAST", "NOW", "NEXT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-relativedatetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-timegranularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AnchorDateConfiguration": { "MarkdownDocumentation": "`AnchorDateConfiguration`\n\nThe date configuration of the filter.\n*Required*: Yes\n*Type*: [AnchorDateConfiguration](./aws-properties-quicksight-analysis-anchordateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-anchordateconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "AnchorDateConfiguration" }, "MinimumGranularity": { "MarkdownDocumentation": "`MinimumGranularity`\n\nThe minimum granularity (period granularity) of the relative dates filter.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-minimumgranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExcludePeriodConfiguration": { "MarkdownDocumentation": "`ExcludePeriodConfiguration`\n\nThe configuration for the exclude period of the filter.\n*Required*: No\n*Type*: [ExcludePeriodConfiguration](./aws-properties-quicksight-analysis-excludeperiodconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-excludeperiodconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExcludePeriodConfiguration" } } }, "AWS::QuickSight::Analysis.ResourcePermission": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ResourcePermission`\n\nPermission for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe IAM action to grant or revoke permissions on.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.html#cfn-quicksight-analysis-resourcepermission-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe Amazon Resource Name (ARN) of the principal. This can be one of the following:\n* The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is\n common.)\n* The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard,\n template, or theme. (This is common.)\n* The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts. (This is\n less common.)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.html#cfn-quicksight-analysis-resourcepermission-principal", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.RollingDateConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RollingDateConfiguration`\n\nThe rolling date configuration of a date time filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rollingdateconfiguration.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the rolling date configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rollingdateconfiguration.html#cfn-quicksight-analysis-rollingdateconfiguration-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in the rolling date configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rollingdateconfiguration.html#cfn-quicksight-analysis-rollingdateconfiguration-datasetidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.RowAlternateColorOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.RowAlternateColorOptions`\n\nDetermines the row alternate color options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rowalternatecoloroptions.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nDetermines the widget status.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rowalternatecoloroptions.html#cfn-quicksight-analysis-rowalternatecoloroptions-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UsePrimaryBackgroundColor": { "MarkdownDocumentation": "`UsePrimaryBackgroundColor`\n\nThe primary background color options for alternate rows.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rowalternatecoloroptions.html#cfn-quicksight-analysis-rowalternatecoloroptions-useprimarybackgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowAlternateColors": { "MarkdownDocumentation": "`RowAlternateColors`\n\nDetermines the list of row alternate colors.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rowalternatecoloroptions.html#cfn-quicksight-analysis-rowalternatecoloroptions-rowalternatecolors", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.SameSheetTargetVisualConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SameSheetTargetVisualConfiguration`\n\nThe configuration of the same-sheet target visuals that you want to be filtered.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-samesheettargetvisualconfiguration.html", "Properties": { "TargetVisualOptions": { "MarkdownDocumentation": "`TargetVisualOptions`\n\nThe options that choose the target visual in the same sheet.\nValid values are defined as follows:\n* `ALL_VISUALS`: Applies the filter operation to all visuals in the same sheet.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VISUALS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VISUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-samesheettargetvisualconfiguration.html#cfn-quicksight-analysis-samesheettargetvisualconfiguration-targetvisualoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetVisuals": { "MarkdownDocumentation": "`TargetVisuals`\n\nA list of the target visual IDs that are located in the same sheet of the analysis.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `512 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-samesheettargetvisualconfiguration.html#cfn-quicksight-analysis-samesheettargetvisualconfiguration-targetvisuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.SankeyDiagramAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SankeyDiagramAggregatedFieldWells`\n\nThe field well configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramaggregatedfieldwells.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-analysis-sankeydiagramaggregatedfieldwells-destination", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-analysis-sankeydiagramaggregatedfieldwells-source", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe weight field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-analysis-sankeydiagramaggregatedfieldwells-weight", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.SankeyDiagramChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SankeyDiagramChartConfiguration`\n\nThe configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramSortConfiguration](./aws-properties-quicksight-analysis-sankeydiagramsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramchartconfiguration.html#cfn-quicksight-analysis-sankeydiagramchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramSortConfiguration" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a sankey diagram.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramchartconfiguration.html#cfn-quicksight-analysis-sankeydiagramchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramFieldWells](./aws-properties-quicksight-analysis-sankeydiagramfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramchartconfiguration.html#cfn-quicksight-analysis-sankeydiagramchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramFieldWells" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramchartconfiguration.html#cfn-quicksight-analysis-sankeydiagramchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Analysis.SankeyDiagramFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SankeyDiagramFieldWells`\n\nThe field well configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramfieldwells.html", "Properties": { "SankeyDiagramAggregatedFieldWells": { "MarkdownDocumentation": "`SankeyDiagramAggregatedFieldWells`\n\nThe field well configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramAggregatedFieldWells](./aws-properties-quicksight-analysis-sankeydiagramaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramfieldwells.html#cfn-quicksight-analysis-sankeydiagramfieldwells-sankeydiagramaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.SankeyDiagramSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SankeyDiagramSortConfiguration`\n\nThe sort configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramsortconfiguration.html", "Properties": { "WeightSort": { "MarkdownDocumentation": "`WeightSort`\n\nThe sort configuration of the weight fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramsortconfiguration.html#cfn-quicksight-analysis-sankeydiagramsortconfiguration-weightsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SourceItemsLimit": { "MarkdownDocumentation": "`SourceItemsLimit`\n\nThe limit on the number of source nodes that are displayed in a sankey diagram.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramsortconfiguration.html#cfn-quicksight-analysis-sankeydiagramsortconfiguration-sourceitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "DestinationItemsLimit": { "MarkdownDocumentation": "`DestinationItemsLimit`\n\nThe limit on the number of destination nodes that are displayed in a sankey diagram.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramsortconfiguration.html#cfn-quicksight-analysis-sankeydiagramsortconfiguration-destinationitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Analysis.SankeyDiagramVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SankeyDiagramVisual`\n\nA sankey diagram.\nFor more information, see [Using Sankey diagrams](https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramvisual.html#cfn-quicksight-analysis-sankeydiagramvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramvisual.html#cfn-quicksight-analysis-sankeydiagramvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramChartConfiguration](./aws-properties-quicksight-analysis-sankeydiagramchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramvisual.html#cfn-quicksight-analysis-sankeydiagramvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramvisual.html#cfn-quicksight-analysis-sankeydiagramvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramvisual.html#cfn-quicksight-analysis-sankeydiagramvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sankeydiagramvisual.html#cfn-quicksight-analysis-sankeydiagramvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ScatterPlotCategoricallyAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ScatterPlotCategoricallyAggregatedFieldWells`\n\nThe aggregated field well of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a scatter plot.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells-label", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe x-axis field well of a scatter plot.\nThe x-axis is aggregated by category.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe y-axis field well of a scatter plot.\nThe y-axis is aggregated by category.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ScatterPlotConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ScatterPlotConfiguration`\n\nThe configuration of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html", "Properties": { "YAxisLabelOptions": { "MarkdownDocumentation": "`YAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-yaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a scatter plot.\n*Required*: No\n*Type*: [ScatterPlotSortConfiguration](./aws-properties-quicksight-analysis-scatterplotsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "YAxisDisplayOptions": { "MarkdownDocumentation": "`YAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-yaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [ScatterPlotFieldWells](./aws-properties-quicksight-analysis-scatterplotfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotconfiguration.html#cfn-quicksight-analysis-scatterplotconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Analysis.ScatterPlotFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ScatterPlotFieldWells`\n\nThe field well configuration of a scatter plot.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotfieldwells.html", "Properties": { "ScatterPlotUnaggregatedFieldWells": { "MarkdownDocumentation": "`ScatterPlotUnaggregatedFieldWells`\n\nThe unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are\nunaggregated.\n*Required*: No\n*Type*: [ScatterPlotUnaggregatedFieldWells](./aws-properties-quicksight-analysis-scatterplotunaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotfieldwells.html#cfn-quicksight-analysis-scatterplotfieldwells-scatterplotunaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotUnaggregatedFieldWells" }, "ScatterPlotCategoricallyAggregatedFieldWells": { "MarkdownDocumentation": "`ScatterPlotCategoricallyAggregatedFieldWells`\n\nThe aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.\n*Required*: No\n*Type*: [ScatterPlotCategoricallyAggregatedFieldWells](./aws-properties-quicksight-analysis-scatterplotcategoricallyaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotfieldwells.html#cfn-quicksight-analysis-scatterplotfieldwells-scatterplotcategoricallyaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotCategoricallyAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.ScatterPlotSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ScatterPlotSortConfiguration`\n\nThe sort configuration of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotsortconfiguration.html", "Properties": { "ScatterPlotLimitConfiguration": { "MarkdownDocumentation": "`ScatterPlotLimitConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotsortconfiguration.html#cfn-quicksight-analysis-scatterplotsortconfiguration-scatterplotlimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Analysis.ScatterPlotUnaggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ScatterPlotUnaggregatedFieldWells`\n\nThe unaggregated field wells of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotunaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotunaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotunaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a scatter plot.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotunaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotunaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotunaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotunaggregatedfieldwells-label", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe x-axis field well of a scatter plot.\nThe x-axis is a dimension field and cannot be aggregated.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotunaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotunaggregatedfieldwells-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe y-axis field well of a scatter plot.\nThe y-axis is a dimension field and cannot be aggregated.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotunaggregatedfieldwells.html#cfn-quicksight-analysis-scatterplotunaggregatedfieldwells-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ScatterPlotVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ScatterPlotVisual`\n\nA scatter plot.\nFor more information, see [Using scatter plots](https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotvisual.html#cfn-quicksight-analysis-scatterplotvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotvisual.html#cfn-quicksight-analysis-scatterplotvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [ScatterPlotConfiguration](./aws-properties-quicksight-analysis-scatterplotconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotvisual.html#cfn-quicksight-analysis-scatterplotvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotvisual.html#cfn-quicksight-analysis-scatterplotvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotvisual.html#cfn-quicksight-analysis-scatterplotvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotvisual.html#cfn-quicksight-analysis-scatterplotvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scatterplotvisual.html#cfn-quicksight-analysis-scatterplotvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ScrollBarOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ScrollBarOptions`\n\nThe visual display options for a data zoom scroll bar.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scrollbaroptions.html", "Properties": { "VisibleRange": { "MarkdownDocumentation": "`VisibleRange`\n\nThe visibility range for the data zoom scroll bar.\n*Required*: No\n*Type*: [VisibleRangeOptions](./aws-properties-quicksight-analysis-visiblerangeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scrollbaroptions.html#cfn-quicksight-analysis-scrollbaroptions-visiblerange", "UpdateType": "Mutable", "Required": false, "Type": "VisibleRangeOptions" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the data zoom scroll bar.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-scrollbaroptions.html#cfn-quicksight-analysis-scrollbaroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SecondaryValueOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SecondaryValueOptions`\n\nThe options that determine the presentation of the secondary value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-secondaryvalueoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the secondary value.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-secondaryvalueoptions.html#cfn-quicksight-analysis-secondaryvalueoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SectionAfterPageBreak": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SectionAfterPageBreak`\n\nThe configuration of a page break after a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionafterpagebreak.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe option that enables or disables a page break at the end of a section.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionafterpagebreak.html#cfn-quicksight-analysis-sectionafterpagebreak-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SectionBasedLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SectionBasedLayoutCanvasSizeOptions`\n\nThe options for the canvas of a section-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutcanvassizeoptions.html", "Properties": { "PaperCanvasSizeOptions": { "MarkdownDocumentation": "`PaperCanvasSizeOptions`\n\nThe options for a paper canvas of a section-based layout.\n*Required*: No\n*Type*: [SectionBasedLayoutPaperCanvasSizeOptions](./aws-properties-quicksight-analysis-sectionbasedlayoutpapercanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutcanvassizeoptions.html#cfn-quicksight-analysis-sectionbasedlayoutcanvassizeoptions-papercanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "SectionBasedLayoutPaperCanvasSizeOptions" } } }, "AWS::QuickSight::Analysis.SectionBasedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SectionBasedLayoutConfiguration`\n\nThe configuration for a\nsection-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nThe options for the canvas of a section-based layout.\n*Required*: Yes\n*Type*: [SectionBasedLayoutCanvasSizeOptions](./aws-properties-quicksight-analysis-sectionbasedlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-sectionbasedlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "SectionBasedLayoutCanvasSizeOptions" }, "FooterSections": { "MarkdownDocumentation": "`FooterSections`\n\nA list of footer section configurations.\n*Required*: Yes\n*Type*: Array of [HeaderFooterSectionConfiguration](./aws-properties-quicksight-analysis-headerfootersectionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-sectionbasedlayoutconfiguration-footersections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HeaderFooterSectionConfiguration", "DuplicatesAllowed": true }, "BodySections": { "MarkdownDocumentation": "`BodySections`\n\nA list of body section configurations.\n*Required*: Yes\n*Type*: Array of [BodySectionConfiguration](./aws-properties-quicksight-analysis-bodysectionconfiguration.html)\n*Minimum*: `0`\n*Maximum*: `28`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-sectionbasedlayoutconfiguration-bodysections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "BodySectionConfiguration", "DuplicatesAllowed": true }, "HeaderSections": { "MarkdownDocumentation": "`HeaderSections`\n\nA list of header section configurations.\n*Required*: Yes\n*Type*: Array of [HeaderFooterSectionConfiguration](./aws-properties-quicksight-analysis-headerfootersectionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-sectionbasedlayoutconfiguration-headersections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HeaderFooterSectionConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.SectionBasedLayoutPaperCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SectionBasedLayoutPaperCanvasSizeOptions`\n\nThe options for a paper canvas of a section-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutpapercanvassizeoptions.html", "Properties": { "PaperMargin": { "MarkdownDocumentation": "`PaperMargin`\n\nDefines the spacing between the canvas content and the top, bottom, left, and right edges.\n*Required*: No\n*Type*: [Spacing](./aws-properties-quicksight-analysis-spacing.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-analysis-sectionbasedlayoutpapercanvassizeoptions-papermargin", "UpdateType": "Mutable", "Required": false, "Type": "Spacing" }, "PaperSize": { "MarkdownDocumentation": "`PaperSize`\n\nThe paper size that is used to define canvas dimensions.\n*Required*: No\n*Type*: String\n*Allowed values*: `US_LETTER | US_LEGAL | US_T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "US_LETTER", "US_LEGAL", "US_TABLOID_LEDGER", "A0", "A1", "A2", "A3", "A4", "A5", "JIS_B4", "JIS_B5" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-analysis-sectionbasedlayoutpapercanvassizeoptions-papersize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PaperOrientation": { "MarkdownDocumentation": "`PaperOrientation`\n\nThe paper orientation that\nis used to define canvas dimensions. Choose one of the following\noptions:\n* PORTRAIT\n* LANDSCAPE\n*Required*: No\n*Type*: String\n*Allowed values*: `PORTRAIT | LANDSCAPE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PORTRAIT", "LANDSCAPE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-analysis-sectionbasedlayoutpapercanvassizeoptions-paperorientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SectionLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SectionLayoutConfiguration`\n\nThe layout configuration of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionlayoutconfiguration.html", "Properties": { "FreeFormLayout": { "MarkdownDocumentation": "`FreeFormLayout`\n\nThe free-form layout configuration of a section.\n*Required*: Yes\n*Type*: [FreeFormSectionLayoutConfiguration](./aws-properties-quicksight-analysis-freeformsectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionlayoutconfiguration.html#cfn-quicksight-analysis-sectionlayoutconfiguration-freeformlayout", "UpdateType": "Mutable", "Required": true, "Type": "FreeFormSectionLayoutConfiguration" } } }, "AWS::QuickSight::Analysis.SectionPageBreakConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SectionPageBreakConfiguration`\n\nThe configuration of a page break for a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionpagebreakconfiguration.html", "Properties": { "After": { "MarkdownDocumentation": "`After`\n\nThe configuration of a page break after a section.\n*Required*: No\n*Type*: [SectionAfterPageBreak](./aws-properties-quicksight-analysis-sectionafterpagebreak.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionpagebreakconfiguration.html#cfn-quicksight-analysis-sectionpagebreakconfiguration-after", "UpdateType": "Mutable", "Required": false, "Type": "SectionAfterPageBreak" } } }, "AWS::QuickSight::Analysis.SectionStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SectionStyle`\n\nThe options that style a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionstyle.html", "Properties": { "Padding": { "MarkdownDocumentation": "`Padding`\n\nThe spacing between section content and its top, bottom, left, and right edges.\nThere is no padding by default.\n*Required*: No\n*Type*: [Spacing](./aws-properties-quicksight-analysis-spacing.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionstyle.html#cfn-quicksight-analysis-sectionstyle-padding", "UpdateType": "Mutable", "Required": false, "Type": "Spacing" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of a section.\nHeights can only be defined for header and footer sections. The default height margin is 0.5 inches.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionstyle.html#cfn-quicksight-analysis-sectionstyle-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SelectedSheetsFilterScopeConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SelectedSheetsFilterScopeConfiguration`\n\nThe configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-selectedsheetsfilterscopeconfiguration.html", "Properties": { "SheetVisualScopingConfigurations": { "MarkdownDocumentation": "`SheetVisualScopingConfigurations`\n\nThe sheet ID and visual IDs of the sheet and visuals that the filter is applied to.\n*Required*: No\n*Type*: Array of [SheetVisualScopingConfiguration](./aws-properties-quicksight-analysis-sheetvisualscopingconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-selectedsheetsfilterscopeconfiguration.html#cfn-quicksight-analysis-selectedsheetsfilterscopeconfiguration-sheetvisualscopingconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetVisualScopingConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.SeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SeriesItem`\n\nThe series item configuration of a line chart.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-seriesitem.html", "Properties": { "FieldSeriesItem": { "MarkdownDocumentation": "`FieldSeriesItem`\n\nThe field series item configuration of a line chart.\n*Required*: No\n*Type*: [FieldSeriesItem](./aws-properties-quicksight-analysis-fieldseriesitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-seriesitem.html#cfn-quicksight-analysis-seriesitem-fieldseriesitem", "UpdateType": "Mutable", "Required": false, "Type": "FieldSeriesItem" }, "DataFieldSeriesItem": { "MarkdownDocumentation": "`DataFieldSeriesItem`\n\nThe data field series item configuration of a line chart.\n*Required*: No\n*Type*: [DataFieldSeriesItem](./aws-properties-quicksight-analysis-datafieldseriesitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-seriesitem.html#cfn-quicksight-analysis-seriesitem-datafieldseriesitem", "UpdateType": "Mutable", "Required": false, "Type": "DataFieldSeriesItem" } } }, "AWS::QuickSight::Analysis.SetParameterValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SetParameterValueConfiguration`\n\nThe configuration of adding parameters in action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-setparametervalueconfiguration.html", "Properties": { "DestinationParameterName": { "MarkdownDocumentation": "`DestinationParameterName`\n\nThe destination parameter name of the `SetParameterValueConfiguration`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-setparametervalueconfiguration.html#cfn-quicksight-analysis-setparametervalueconfiguration-destinationparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [DestinationParameterValueConfiguration](./aws-properties-quicksight-analysis-destinationparametervalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-setparametervalueconfiguration.html#cfn-quicksight-analysis-setparametervalueconfiguration-value", "UpdateType": "Mutable", "Required": true, "Type": "DestinationParameterValueConfiguration" } } }, "AWS::QuickSight::Analysis.ShapeConditionalFormat": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ShapeConditionalFormat`\n\nThe shape conditional formatting of a filled map visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-shapeconditionalformat.html", "Properties": { "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting for the shape background color of a filled map visual.\n*Required*: Yes\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-shapeconditionalformat.html#cfn-quicksight-analysis-shapeconditionalformat-backgroundcolor", "UpdateType": "Mutable", "Required": true, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Analysis.Sheet": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.Sheet`\n\nA *sheet*, which is an object that contains a set of visuals that\nare viewed together on one page in Quick Sight. Every analysis and dashboard\ncontains at least one sheet. Each sheet contains at least one visualization widget, for\nexample a chart, pivot table, or narrative insight. Sheets can be associated with other\ncomponents, such as controls, filters, and so on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.html", "Properties": { "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe unique identifier associated with a sheet.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.html#cfn-quicksight-analysis-sheet-sheetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a sheet. This name is displayed on the sheet's tab in the Quick Sight\nconsole.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.html#cfn-quicksight-analysis-sheet-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetControlInfoIconLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetControlInfoIconLabelOptions`\n\nA control to display info icons for filters and parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of info icon label options.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-analysis-sheetcontrolinfoiconlabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InfoIconText": { "MarkdownDocumentation": "`InfoIconText`\n\nThe text content of info icon.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-analysis-sheetcontrolinfoiconlabeloptions-infoicontext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetControlLayout": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetControlLayout`\n\nA grid layout to define the placement of sheet control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetcontrollayout.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n*Required*: Yes\n*Type*: [SheetControlLayoutConfiguration](./aws-properties-quicksight-analysis-sheetcontrollayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetcontrollayout.html#cfn-quicksight-analysis-sheetcontrollayout-configuration", "UpdateType": "Mutable", "Required": true, "Type": "SheetControlLayoutConfiguration" } } }, "AWS::QuickSight::Analysis.SheetControlLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetControlLayoutConfiguration`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetcontrollayoutconfiguration.html", "Properties": { "GridLayout": { "MarkdownDocumentation": "`GridLayout`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n*Required*: No\n*Type*: [GridLayoutConfiguration](./aws-properties-quicksight-analysis-gridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetcontrollayoutconfiguration.html#cfn-quicksight-analysis-sheetcontrollayoutconfiguration-gridlayout", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutConfiguration" } } }, "AWS::QuickSight::Analysis.SheetDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetDefinition`\n\nA sheet is an object that contains a set of visuals that\nare viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterControls": { "MarkdownDocumentation": "`ParameterControls`\n\nThe list of parameter controls that are on a sheet.\nFor more information, see [Using a Control with a Parameter in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [ParameterControl](./aws-properties-quicksight-analysis-parametercontrol.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-parametercontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ParameterControl", "DuplicatesAllowed": true }, "TextBoxes": { "MarkdownDocumentation": "`TextBoxes`\n\nThe text boxes that are on a sheet.\n*Required*: No\n*Type*: Array of [SheetTextBox](./aws-properties-quicksight-analysis-sheettextbox.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-textboxes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetTextBox", "DuplicatesAllowed": true }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe layout content type of the sheet. Choose one of the following options:\n* `PAGINATED`: Creates a sheet for a paginated report.\n* `INTERACTIVE`: Creates a sheet for an interactive dashboard.\n*Required*: No\n*Type*: String\n*Allowed values*: `PAGINATED | INTERACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PAGINATED", "INTERACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Layouts": { "MarkdownDocumentation": "`Layouts`\n\nLayouts define how the components of a sheet are arranged.\nFor more information, see [Types of layout](https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [Layout](./aws-properties-quicksight-analysis-layout.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-layouts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Layout", "DuplicatesAllowed": true }, "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe unique identifier of a sheet.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-sheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FilterControls": { "MarkdownDocumentation": "`FilterControls`\n\nThe list of filter controls that are on a sheet.\nFor more information, see [Adding filter controls to analysis sheets](https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [FilterControl](./aws-properties-quicksight-analysis-filtercontrol.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-filtercontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterControl", "DuplicatesAllowed": true }, "Images": { "MarkdownDocumentation": "`Images`\n\nA list of images on a sheet.\n*Required*: No\n*Type*: Array of [SheetImage](./aws-properties-quicksight-analysis-sheetimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-images", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetImage", "DuplicatesAllowed": true }, "SheetControlLayouts": { "MarkdownDocumentation": "`SheetControlLayouts`\n\nThe control layouts of the sheet.\n*Required*: No\n*Type*: Array of [SheetControlLayout](./aws-properties-quicksight-analysis-sheetcontrollayout.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-sheetcontrollayouts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetControlLayout", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-title", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visuals": { "MarkdownDocumentation": "`Visuals`\n\nA list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.\n*Required*: No\n*Type*: Array of [Visual](./aws-properties-quicksight-analysis-visual.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-visuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Visual", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the sheet. This name is displayed on the sheet's tab in the Quick Suite\nconsole.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetElementConfigurationOverrides": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetElementConfigurationOverrides`\n\nThe override configuration of the rendering rules of a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetelementconfigurationoverrides.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the overrides are visible. Choose one of the following options:\n* `VISIBLE`\n* `HIDDEN`\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetelementconfigurationoverrides.html#cfn-quicksight-analysis-sheetelementconfigurationoverrides-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetElementRenderingRule": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetElementRenderingRule`\n\nThe rendering rules of a sheet that uses a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetelementrenderingrule.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the rendering rules of a sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetelementrenderingrule.html#cfn-quicksight-analysis-sheetelementrenderingrule-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConfigurationOverrides": { "MarkdownDocumentation": "`ConfigurationOverrides`\n\nThe override configuration of the rendering rules of a sheet.\n*Required*: Yes\n*Type*: [SheetElementConfigurationOverrides](./aws-properties-quicksight-analysis-sheetelementconfigurationoverrides.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetelementrenderingrule.html#cfn-quicksight-analysis-sheetelementrenderingrule-configurationoverrides", "UpdateType": "Mutable", "Required": true, "Type": "SheetElementConfigurationOverrides" } } }, "AWS::QuickSight::Analysis.SheetImage": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetImage`\n\nAn image that is located on a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nA list of custom actions that are configured for an image.\n*Required*: No\n*Type*: Array of [ImageCustomAction](./aws-properties-quicksight-analysis-imagecustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.html#cfn-quicksight-analysis-sheetimage-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ImageCustomAction", "DuplicatesAllowed": true }, "SheetImageId": { "MarkdownDocumentation": "`SheetImageId`\n\nThe ID of the sheet image.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.html#cfn-quicksight-analysis-sheetimage-sheetimageid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip to be shown when hovering over the image.\n*Required*: No\n*Type*: [SheetImageTooltipConfiguration](./aws-properties-quicksight-analysis-sheetimagetooltipconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.html#cfn-quicksight-analysis-sheetimage-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageTooltipConfiguration" }, "Scaling": { "MarkdownDocumentation": "`Scaling`\n\nDetermines how the image is scaled.\n*Required*: No\n*Type*: [SheetImageScalingConfiguration](./aws-properties-quicksight-analysis-sheetimagescalingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.html#cfn-quicksight-analysis-sheetimage-scaling", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageScalingConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general image interactions setup for an image.\n*Required*: No\n*Type*: [ImageInteractionOptions](./aws-properties-quicksight-analysis-imageinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.html#cfn-quicksight-analysis-sheetimage-interactions", "UpdateType": "Mutable", "Required": false, "Type": "ImageInteractionOptions" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the image.\n*Required*: Yes\n*Type*: [SheetImageSource](./aws-properties-quicksight-analysis-sheetimagesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.html#cfn-quicksight-analysis-sheetimage-source", "UpdateType": "Mutable", "Required": true, "Type": "SheetImageSource" }, "ImageContentAltText": { "MarkdownDocumentation": "`ImageContentAltText`\n\nThe alt text for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.html#cfn-quicksight-analysis-sheetimage-imagecontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetImageScalingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetImageScalingConfiguration`\n\nDetermines how the image is scaled\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagescalingconfiguration.html", "Properties": { "ScalingType": { "MarkdownDocumentation": "`ScalingType`\n\nThe scaling option to use when fitting the image inside the container.\nValid values are defined as follows:\n* `SCALE_TO_WIDTH`: The image takes up the entire width of the container. The image aspect ratio is preserved.\n* `SCALE_TO_HEIGHT`: The image takes up the entire height of the container. The image aspect ratio is preserved.\n* `SCALE_TO_CONTAINER`: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.\n* `SCALE_NONE`: The image is displayed in its original size and is not scaled to the container.\n*Required*: No\n*Type*: String\n*Allowed values*: `SCALE_TO_WIDTH | SCALE_TO_H...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SCALE_TO_WIDTH", "SCALE_TO_HEIGHT", "SCALE_TO_CONTAINER", "SCALE_NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagescalingconfiguration.html#cfn-quicksight-analysis-sheetimagescalingconfiguration-scalingtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetImageSource": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetImageSource`\n\nThe source of the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagesource.html", "Properties": { "SheetImageStaticFileSource": { "MarkdownDocumentation": "`SheetImageStaticFileSource`\n\nThe source of the static file that contains the image.\n*Required*: No\n*Type*: [SheetImageStaticFileSource](./aws-properties-quicksight-analysis-sheetimagestaticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagesource.html#cfn-quicksight-analysis-sheetimagesource-sheetimagestaticfilesource", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageStaticFileSource" } } }, "AWS::QuickSight::Analysis.SheetImageStaticFileSource": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetImageStaticFileSource`\n\nThe source of the static file that contains the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagestaticfilesource.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the static file that contains the image.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagestaticfilesource.html#cfn-quicksight-analysis-sheetimagestaticfilesource-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetImageTooltipConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetImageTooltipConfiguration`\n\nThe tooltip configuration for a sheet image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagetooltipconfiguration.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagetooltipconfiguration.html#cfn-quicksight-analysis-sheetimagetooltipconfiguration-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipText": { "MarkdownDocumentation": "`TooltipText`\n\nThe text that appears in the tooltip.\n*Required*: No\n*Type*: [SheetImageTooltipText](./aws-properties-quicksight-analysis-sheetimagetooltiptext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagetooltipconfiguration.html#cfn-quicksight-analysis-sheetimagetooltipconfiguration-tooltiptext", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageTooltipText" } } }, "AWS::QuickSight::Analysis.SheetImageTooltipText": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetImageTooltipText`\n\nThe text that appears in the sheet image tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagetooltiptext.html", "Properties": { "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nThe plain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimagetooltiptext.html#cfn-quicksight-analysis-sheetimagetooltiptext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetTextBox": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetTextBox`\n\nA text box.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheettextbox.html", "Properties": { "SheetTextBoxId": { "MarkdownDocumentation": "`SheetTextBoxId`\n\nThe unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheettextbox.html#cfn-quicksight-analysis-sheettextbox-sheettextboxid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe content that is displayed in the text box.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `150000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheettextbox.html#cfn-quicksight-analysis-sheettextbox-content", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SheetVisualScopingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SheetVisualScopingConfiguration`\n\nThe filter that is applied to the options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetvisualscopingconfiguration.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope of the applied entities. Choose one of the following options:\n* `ALL_VISUALS`\n* `SELECTED_VISUALS`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VISUALS | SELECTED_VISU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VISUALS", "SELECTED_VISUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetvisualscopingconfiguration.html#cfn-quicksight-analysis-sheetvisualscopingconfiguration-scope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe selected sheet that the filter is applied to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetvisualscopingconfiguration.html#cfn-quicksight-analysis-sheetvisualscopingconfiguration-sheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VisualIds": { "MarkdownDocumentation": "`VisualIds`\n\nThe selected visuals that the filter is applied to.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetvisualscopingconfiguration.html#cfn-quicksight-analysis-sheetvisualscopingconfiguration-visualids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.ShortFormatText": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ShortFormatText`\n\nThe text format for the title.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-shortformattext.html", "Properties": { "RichText": { "MarkdownDocumentation": "`RichText`\n\nRich text. Examples of rich text include bold, underline, and italics.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-shortformattext.html#cfn-quicksight-analysis-shortformattext-richtext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nPlain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-shortformattext.html#cfn-quicksight-analysis-shortformattext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SimpleClusterMarker": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SimpleClusterMarker`\n\nThe simple cluster marker of the cluster marker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-simpleclustermarker.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of the simple cluster marker.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-simpleclustermarker.html#cfn-quicksight-analysis-simpleclustermarker-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SingleAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SingleAxisOptions`\n\nThe settings of a chart's single axis configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-singleaxisoptions.html", "Properties": { "YAxisOptions": { "MarkdownDocumentation": "`YAxisOptions`\n\nThe Y axis options of a single axis configuration.\n*Required*: No\n*Type*: [YAxisOptions](./aws-properties-quicksight-analysis-yaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-singleaxisoptions.html#cfn-quicksight-analysis-singleaxisoptions-yaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "YAxisOptions" } } }, "AWS::QuickSight::Analysis.SliderControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SliderControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-slidercontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-slidercontroldisplayoptions.html#cfn-quicksight-analysis-slidercontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-slidercontroldisplayoptions.html#cfn-quicksight-analysis-slidercontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Analysis.SmallMultiplesAxisProperties": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SmallMultiplesAxisProperties`\n\nConfigures the properties of a chart's axes that are used by small multiples panels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesaxisproperties.html", "Properties": { "Placement": { "MarkdownDocumentation": "`Placement`\n\nDefines the placement of the axis. By default, axes are rendered `OUTSIDE` of the panels. Axes with `INDEPENDENT` scale are rendered `INSIDE` the panels.\n*Required*: No\n*Type*: String\n*Allowed values*: `OUTSIDE | INSIDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OUTSIDE", "INSIDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesaxisproperties.html#cfn-quicksight-analysis-smallmultiplesaxisproperties-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scale": { "MarkdownDocumentation": "`Scale`\n\nDetermines whether scale of the axes are shared or independent. The default value is `SHARED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHARED | INDEPENDENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SHARED", "INDEPENDENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesaxisproperties.html#cfn-quicksight-analysis-smallmultiplesaxisproperties-scale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SmallMultiplesOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SmallMultiplesOptions`\n\nOptions that determine the layout and display options of a chart's small multiples.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html", "Properties": { "MaxVisibleRows": { "MarkdownDocumentation": "`MaxVisibleRows`\n\nSets the maximum number of visible rows to display in the grid of small multiples panels.\nThe default value is `Auto`,\nwhich automatically adjusts the rows in the grid\nto fit the overall layout and size of the given chart.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-maxvisiblerows", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PanelConfiguration": { "MarkdownDocumentation": "`PanelConfiguration`\n\nConfigures the display options for each small multiples panel.\n*Required*: No\n*Type*: [PanelConfiguration](./aws-properties-quicksight-analysis-panelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-panelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PanelConfiguration" }, "MaxVisibleColumns": { "MarkdownDocumentation": "`MaxVisibleColumns`\n\nSets the maximum number of visible columns to display in the grid of small multiples panels.\nThe default is `Auto`, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-maxvisiblecolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe properties of a small multiples X axis.\n*Required*: No\n*Type*: [SmallMultiplesAxisProperties](./aws-properties-quicksight-analysis-smallmultiplesaxisproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesAxisProperties" }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe properties of a small multiples Y axis.\n*Required*: No\n*Type*: [SmallMultiplesAxisProperties](./aws-properties-quicksight-analysis-smallmultiplesaxisproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesAxisProperties" } } }, "AWS::QuickSight::Analysis.Spacing": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.Spacing`\n\nThe configuration of spacing (often a margin or padding).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-spacing.html", "Properties": { "Left": { "MarkdownDocumentation": "`Left`\n\nDefine the left spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-spacing.html#cfn-quicksight-analysis-spacing-left", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Top": { "MarkdownDocumentation": "`Top`\n\nDefine the top spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-spacing.html#cfn-quicksight-analysis-spacing-top", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Right": { "MarkdownDocumentation": "`Right`\n\nDefine the right spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-spacing.html#cfn-quicksight-analysis-spacing-right", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bottom": { "MarkdownDocumentation": "`Bottom`\n\nDefine the bottom spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-spacing.html#cfn-quicksight-analysis-spacing-bottom", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SpatialStaticFile": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SpatialStaticFile`\n\nA static file that contains the geospatial data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-spatialstaticfile.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the spatial static file.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-spatialstaticfile.html#cfn-quicksight-analysis-spatialstaticfile-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the spatial static file.\n*Required*: No\n*Type*: [StaticFileSource](./aws-properties-quicksight-analysis-staticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-spatialstaticfile.html#cfn-quicksight-analysis-spatialstaticfile-source", "UpdateType": "Mutable", "Required": false, "Type": "StaticFileSource" } } }, "AWS::QuickSight::Analysis.StaticFile": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StaticFile`\n\nThe static file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfile.html", "Properties": { "ImageStaticFile": { "MarkdownDocumentation": "`ImageStaticFile`\n\nThe image static file.\n*Required*: No\n*Type*: [ImageStaticFile](./aws-properties-quicksight-analysis-imagestaticfile.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfile.html#cfn-quicksight-analysis-staticfile-imagestaticfile", "UpdateType": "Mutable", "Required": false, "Type": "ImageStaticFile" }, "SpatialStaticFile": { "MarkdownDocumentation": "`SpatialStaticFile`\n\nThe spacial static file.\n*Required*: No\n*Type*: [SpatialStaticFile](./aws-properties-quicksight-analysis-spatialstaticfile.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfile.html#cfn-quicksight-analysis-staticfile-spatialstaticfile", "UpdateType": "Mutable", "Required": false, "Type": "SpatialStaticFile" } } }, "AWS::QuickSight::Analysis.StaticFileS3SourceOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StaticFileS3SourceOptions`\n\nThe structure that contains the Amazon S3 location to download the static file from.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfiles3sourceoptions.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfiles3sourceoptions.html#cfn-quicksight-analysis-staticfiles3sourceoptions-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ObjectKey": { "MarkdownDocumentation": "`ObjectKey`\n\nThe identifier of the static file 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfiles3sourceoptions.html#cfn-quicksight-analysis-staticfiles3sourceoptions-objectkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe Region of the Amazon S3 account that contains the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfiles3sourceoptions.html#cfn-quicksight-analysis-staticfiles3sourceoptions-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.StaticFileSource": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StaticFileSource`\n\nThe source of the static file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfilesource.html", "Properties": { "UrlOptions": { "MarkdownDocumentation": "`UrlOptions`\n\nThe structure that contains the URL to download the static file from.\n*Required*: No\n*Type*: [StaticFileUrlSourceOptions](./aws-properties-quicksight-analysis-staticfileurlsourceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfilesource.html#cfn-quicksight-analysis-staticfilesource-urloptions", "UpdateType": "Mutable", "Required": false, "Type": "StaticFileUrlSourceOptions" }, "S3Options": { "MarkdownDocumentation": "`S3Options`\n\nThe structure that contains the Amazon S3 location to download the static file from.\n*Required*: No\n*Type*: [StaticFileS3SourceOptions](./aws-properties-quicksight-analysis-staticfiles3sourceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfilesource.html#cfn-quicksight-analysis-staticfilesource-s3options", "UpdateType": "Mutable", "Required": false, "Type": "StaticFileS3SourceOptions" } } }, "AWS::QuickSight::Analysis.StaticFileUrlSourceOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StaticFileUrlSourceOptions`\n\nThe structure that contains the URL to download the static file from.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfileurlsourceoptions.html", "Properties": { "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL to download the static file 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-staticfileurlsourceoptions.html#cfn-quicksight-analysis-staticfileurlsourceoptions-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.StringDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StringDefaultValues`\n\nThe default values of the `StringParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringdefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `StringDefaultValues`. Different defaults displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-analysis-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringdefaultvalues.html#cfn-quicksight-analysis-stringdefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DecimalDefaultValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringdefaultvalues.html#cfn-quicksight-analysis-stringdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.StringFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StringFormatConfiguration`\n\nFormatting configuration for string fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringformatconfiguration.html", "Properties": { "NumericFormatConfiguration": { "MarkdownDocumentation": "`NumericFormatConfiguration`\n\nThe formatting configuration for numeric strings.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-analysis-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringformatconfiguration.html#cfn-quicksight-analysis-stringformatconfiguration-numericformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-analysis-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringformatconfiguration.html#cfn-quicksight-analysis-stringformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" } } }, "AWS::QuickSight::Analysis.StringParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StringParameter`\n\nA string parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values of a string parameter.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameter.html#cfn-quicksight-analysis-stringparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameter.html#cfn-quicksight-analysis-stringparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.StringParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StringParameterDeclaration`\n\nA parameter declaration for the `String` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-analysis-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.html#cfn-quicksight-analysis-stringparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [StringDefaultValues](./aws-properties-quicksight-analysis-stringdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.html#cfn-quicksight-analysis-stringparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "StringDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.html#cfn-quicksight-analysis-stringparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `String` parameter when a value has not been set.\n*Required*: No\n*Type*: [StringValueWhenUnsetConfiguration](./aws-properties-quicksight-analysis-stringvaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.html#cfn-quicksight-analysis-stringparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "StringValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameterdeclaration.html#cfn-quicksight-analysis-stringparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.StringValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.StringValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `String` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringvaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringvaluewhenunsetconfiguration.html#cfn-quicksight-analysis-stringvaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringvaluewhenunsetconfiguration.html#cfn-quicksight-analysis-stringvaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.SubtotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.SubtotalOptions`\n\nThe subtotal options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the subtotal cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html#cfn-quicksight-analysis-subtotaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldLevelOptions": { "MarkdownDocumentation": "`FieldLevelOptions`\n\nThe optional configuration of subtotal cells.\n*Required*: No\n*Type*: Array of [PivotTableFieldSubtotalOptions](./aws-properties-quicksight-analysis-pivottablefieldsubtotaloptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html#cfn-quicksight-analysis-subtotaloptions-fieldleveloptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldSubtotalOptions", "DuplicatesAllowed": true }, "ValueCellStyle": { "MarkdownDocumentation": "`ValueCellStyle`\n\nThe cell styling options for the subtotals of value cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html#cfn-quicksight-analysis-subtotaloptions-valuecellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nThe cell styling options for the subtotal cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html#cfn-quicksight-analysis-subtotaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the subtotal cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html#cfn-quicksight-analysis-subtotaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldLevel": { "MarkdownDocumentation": "`FieldLevel`\n\nThe field level (all, custom, last) for the subtotal cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL | CUSTOM | LAST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL", "CUSTOM", "LAST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html#cfn-quicksight-analysis-subtotaloptions-fieldlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricHeaderCellStyle": { "MarkdownDocumentation": "`MetricHeaderCellStyle`\n\nThe cell styling options for the subtotals of header cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html#cfn-quicksight-analysis-subtotaloptions-metricheadercellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "StyleTargets": { "MarkdownDocumentation": "`StyleTargets`\n\nThe style targets options for subtotals.\n*Required*: No\n*Type*: Array of [TableStyleTarget](./aws-properties-quicksight-analysis-tablestyletarget.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-subtotaloptions.html#cfn-quicksight-analysis-subtotaloptions-styletargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableStyleTarget", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.TableAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableAggregatedFieldWells`\n\nThe aggregated field well for the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well for a pivot table. Values are grouped by group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableaggregatedfieldwells.html#cfn-quicksight-analysis-tableaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableaggregatedfieldwells.html#cfn-quicksight-analysis-tableaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.TableBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableBorderOptions`\n\nThe border options for a table border.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableborderoptions.html", "Properties": { "Thickness": { "MarkdownDocumentation": "`Thickness`\n\nThe thickness of a table border.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableborderoptions.html#cfn-quicksight-analysis-tableborderoptions-thickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of a table border.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableborderoptions.html#cfn-quicksight-analysis-tableborderoptions-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style (none, solid) of a table border.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | SOLID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SOLID" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableborderoptions.html#cfn-quicksight-analysis-tableborderoptions-style", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TableCellConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableCellConditionalFormatting`\n\nThe cell conditional formatting option for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellconditionalformatting.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the cell for conditional formatting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellconditionalformatting.html#cfn-quicksight-analysis-tablecellconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TextFormat": { "MarkdownDocumentation": "`TextFormat`\n\nThe text format of the cell for conditional formatting.\n*Required*: No\n*Type*: [TextConditionalFormat](./aws-properties-quicksight-analysis-textconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellconditionalformatting.html#cfn-quicksight-analysis-tablecellconditionalformatting-textformat", "UpdateType": "Mutable", "Required": false, "Type": "TextConditionalFormat" } } }, "AWS::QuickSight::Analysis.TableCellImageSizingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableCellImageSizingConfiguration`\n\nThe sizing options for the table image configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellimagesizingconfiguration.html", "Properties": { "TableCellImageScalingConfiguration": { "MarkdownDocumentation": "`TableCellImageScalingConfiguration`\n\nThe cell scaling configuration of the sizing options for the table image configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIT_TO_CELL_HEIGHT | FIT_TO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIT_TO_CELL_HEIGHT", "FIT_TO_CELL_WIDTH", "DO_NOT_SCALE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellimagesizingconfiguration.html#cfn-quicksight-analysis-tablecellimagesizingconfiguration-tablecellimagescalingconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TableCellStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableCellStyle`\n\nThe table cell style for a cell in pivot table or table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html", "Properties": { "VerticalTextAlignment": { "MarkdownDocumentation": "`VerticalTextAlignment`\n\nThe vertical text alignment (top, middle, bottom) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `TOP | MIDDLE | BOTTOM | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "MIDDLE", "BOTTOM", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html#cfn-quicksight-analysis-tablecellstyle-verticaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html#cfn-quicksight-analysis-tablecellstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height color for the table cells.\n*Required*: No\n*Type*: Number\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html#cfn-quicksight-analysis-tablecellstyle-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the table cells.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html#cfn-quicksight-analysis-tablecellstyle-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Border": { "MarkdownDocumentation": "`Border`\n\nThe borders for the table cells.\n*Required*: No\n*Type*: [GlobalTableBorderOptions](./aws-properties-quicksight-analysis-globaltableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html#cfn-quicksight-analysis-tablecellstyle-border", "UpdateType": "Mutable", "Required": false, "Type": "GlobalTableBorderOptions" }, "TextWrap": { "MarkdownDocumentation": "`TextWrap`\n\nThe text wrap (none, wrap) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | WRAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "WRAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html#cfn-quicksight-analysis-tablecellstyle-textwrap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HorizontalTextAlignment": { "MarkdownDocumentation": "`HorizontalTextAlignment`\n\nThe horizontal text alignment (left, center, right, auto) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html#cfn-quicksight-analysis-tablecellstyle-horizontaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color for the table cells.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablecellstyle.html#cfn-quicksight-analysis-tablecellstyle-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TableConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options for a `PivotTableVisual`.\n*Required*: No\n*Type*: Array of [TableConditionalFormattingOption](./aws-properties-quicksight-analysis-tableconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconditionalformatting.html#cfn-quicksight-analysis-tableconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.TableConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableConditionalFormattingOption`\n\nConditional formatting options for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconditionalformattingoption.html", "Properties": { "Row": { "MarkdownDocumentation": "`Row`\n\nThe row conditional formatting option for a table.\n*Required*: No\n*Type*: [TableRowConditionalFormatting](./aws-properties-quicksight-analysis-tablerowconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconditionalformattingoption.html#cfn-quicksight-analysis-tableconditionalformattingoption-row", "UpdateType": "Mutable", "Required": false, "Type": "TableRowConditionalFormatting" }, "Cell": { "MarkdownDocumentation": "`Cell`\n\nThe cell conditional formatting option for a table.\n*Required*: No\n*Type*: [TableCellConditionalFormatting](./aws-properties-quicksight-analysis-tablecellconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconditionalformattingoption.html#cfn-quicksight-analysis-tableconditionalformattingoption-cell", "UpdateType": "Mutable", "Required": false, "Type": "TableCellConditionalFormatting" } } }, "AWS::QuickSight::Analysis.TableConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableConfiguration`\n\nThe configuration for a `TableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration for a `TableVisual`.\n*Required*: No\n*Type*: [TableSortConfiguration](./aws-properties-quicksight-analysis-tablesortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html#cfn-quicksight-analysis-tableconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableSortConfiguration" }, "PaginatedReportOptions": { "MarkdownDocumentation": "`PaginatedReportOptions`\n\nThe paginated report options for a table visual.\n*Required*: No\n*Type*: [TablePaginatedReportOptions](./aws-properties-quicksight-analysis-tablepaginatedreportoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html#cfn-quicksight-analysis-tableconfiguration-paginatedreportoptions", "UpdateType": "Mutable", "Required": false, "Type": "TablePaginatedReportOptions" }, "TableOptions": { "MarkdownDocumentation": "`TableOptions`\n\nThe table options for a table visual.\n*Required*: No\n*Type*: [TableOptions](./aws-properties-quicksight-analysis-tableoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html#cfn-quicksight-analysis-tableconfiguration-tableoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableOptions" }, "TableInlineVisualizations": { "MarkdownDocumentation": "`TableInlineVisualizations`\n\nA collection of inline visualizations to display within a chart.\n*Required*: No\n*Type*: Array of [TableInlineVisualization](./aws-properties-quicksight-analysis-tableinlinevisualization.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html#cfn-quicksight-analysis-tableconfiguration-tableinlinevisualizations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableInlineVisualization", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [TableFieldWells](./aws-properties-quicksight-analysis-tablefieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html#cfn-quicksight-analysis-tableconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldWells" }, "FieldOptions": { "MarkdownDocumentation": "`FieldOptions`\n\nThe field options for a table visual.\n*Required*: No\n*Type*: [TableFieldOptions](./aws-properties-quicksight-analysis-tablefieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html#cfn-quicksight-analysis-tableconfiguration-fieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html#cfn-quicksight-analysis-tableconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "TotalOptions": { "MarkdownDocumentation": "`TotalOptions`\n\nThe total options for a table visual.\n*Required*: No\n*Type*: [TotalOptions](./aws-properties-quicksight-analysis-totaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableconfiguration.html#cfn-quicksight-analysis-tableconfiguration-totaloptions", "UpdateType": "Mutable", "Required": false, "Type": "TotalOptions" } } }, "AWS::QuickSight::Analysis.TableFieldCustomIconContent": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldCustomIconContent`\n\nThe custom icon content for the table link content configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldcustomiconcontent.html", "Properties": { "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe icon set type (link) of the custom icon content for table URL link content.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINK`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "LINK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldcustomiconcontent.html#cfn-quicksight-analysis-tablefieldcustomiconcontent-icon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TableFieldCustomTextContent": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldCustomTextContent`\n\nThe custom text content (value, font configuration) for the table link content configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldcustomtextcontent.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe string value of the custom text content for the table URL link 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldcustomtextcontent.html#cfn-quicksight-analysis-tablefieldcustomtextcontent-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the custom text content for the table URL link content.\n*Required*: Yes\n*Type*: [FontConfiguration](./aws-properties-quicksight-analysis-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldcustomtextcontent.html#cfn-quicksight-analysis-tablefieldcustomtextcontent-fontconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Analysis.TableFieldImageConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldImageConfiguration`\n\nThe image configuration of a table field URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldimageconfiguration.html", "Properties": { "SizingOptions": { "MarkdownDocumentation": "`SizingOptions`\n\nThe sizing options for the table image configuration.\n*Required*: No\n*Type*: [TableCellImageSizingConfiguration](./aws-properties-quicksight-analysis-tablecellimagesizingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldimageconfiguration.html#cfn-quicksight-analysis-tablefieldimageconfiguration-sizingoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableCellImageSizingConfiguration" } } }, "AWS::QuickSight::Analysis.TableFieldLinkConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldLinkConfiguration`\n\nThe link configuration of a table field URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldlinkconfiguration.html", "Properties": { "Target": { "MarkdownDocumentation": "`Target`\n\nThe URL target (new tab, new window, same tab) for the table link configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW_TAB | NEW_WINDOW | SAME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_TAB", "NEW_WINDOW", "SAME_TAB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldlinkconfiguration.html#cfn-quicksight-analysis-tablefieldlinkconfiguration-target", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe URL content (text, icon) for the table link configuration.\n*Required*: Yes\n*Type*: [TableFieldLinkContentConfiguration](./aws-properties-quicksight-analysis-tablefieldlinkcontentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldlinkconfiguration.html#cfn-quicksight-analysis-tablefieldlinkconfiguration-content", "UpdateType": "Mutable", "Required": true, "Type": "TableFieldLinkContentConfiguration" } } }, "AWS::QuickSight::Analysis.TableFieldLinkContentConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldLinkContentConfiguration`\n\nThe URL content (text, icon) for the table link configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldlinkcontentconfiguration.html", "Properties": { "CustomIconContent": { "MarkdownDocumentation": "`CustomIconContent`\n\nThe custom icon content for the table link content configuration.\n*Required*: No\n*Type*: [TableFieldCustomIconContent](./aws-properties-quicksight-analysis-tablefieldcustomiconcontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldlinkcontentconfiguration.html#cfn-quicksight-analysis-tablefieldlinkcontentconfiguration-customiconcontent", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldCustomIconContent" }, "CustomTextContent": { "MarkdownDocumentation": "`CustomTextContent`\n\nThe custom text content (value, font configuration) for the table link content configuration.\n*Required*: No\n*Type*: [TableFieldCustomTextContent](./aws-properties-quicksight-analysis-tablefieldcustomtextcontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldlinkcontentconfiguration.html#cfn-quicksight-analysis-tablefieldlinkcontentconfiguration-customtextcontent", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldCustomTextContent" } } }, "AWS::QuickSight::Analysis.TableFieldOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldOption`\n\nThe options for a table field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoption.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label for a table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoption.html#cfn-quicksight-analysis-tablefieldoption-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "URLStyling": { "MarkdownDocumentation": "`URLStyling`\n\nThe URL configuration for a table field.\n*Required*: No\n*Type*: [TableFieldURLConfiguration](./aws-properties-quicksight-analysis-tablefieldurlconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoption.html#cfn-quicksight-analysis-tablefieldoption-urlstyling", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldURLConfiguration" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for a table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoption.html#cfn-quicksight-analysis-tablefieldoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of a table field.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoption.html#cfn-quicksight-analysis-tablefieldoption-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width for a table 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoption.html#cfn-quicksight-analysis-tablefieldoption-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TableFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldOptions`\n\nThe field options of a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoptions.html", "Properties": { "Order": { "MarkdownDocumentation": "`Order`\n\nThe order of the field IDs that are configured as field options for a table visual.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoptions.html#cfn-quicksight-analysis-tablefieldoptions-order", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PinnedFieldOptions": { "MarkdownDocumentation": "`PinnedFieldOptions`\n\nThe settings for the pinned columns of a table visual.\n*Required*: No\n*Type*: [TablePinnedFieldOptions](./aws-properties-quicksight-analysis-tablepinnedfieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoptions.html#cfn-quicksight-analysis-tablefieldoptions-pinnedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "TablePinnedFieldOptions" }, "TransposedTableOptions": { "MarkdownDocumentation": "`TransposedTableOptions`\n\nThe `TableOptions` of a transposed table.\n*Required*: No\n*Type*: Array of [TransposedTableOption](./aws-properties-quicksight-analysis-transposedtableoption.html)\n*Minimum*: `0`\n*Maximum*: `10001`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoptions.html#cfn-quicksight-analysis-tablefieldoptions-transposedtableoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TransposedTableOption", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nThe field options to be configured to a table.\n*Required*: No\n*Type*: Array of [TableFieldOption](./aws-properties-quicksight-analysis-tablefieldoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldoptions.html#cfn-quicksight-analysis-tablefieldoptions-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableFieldOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.TableFieldURLConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldURLConfiguration`\n\nThe URL configuration for a table field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldurlconfiguration.html", "Properties": { "LinkConfiguration": { "MarkdownDocumentation": "`LinkConfiguration`\n\nThe link configuration of a table field URL.\n*Required*: No\n*Type*: [TableFieldLinkConfiguration](./aws-properties-quicksight-analysis-tablefieldlinkconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldurlconfiguration.html#cfn-quicksight-analysis-tablefieldurlconfiguration-linkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldLinkConfiguration" }, "ImageConfiguration": { "MarkdownDocumentation": "`ImageConfiguration`\n\nThe image configuration of a table field URL.\n*Required*: No\n*Type*: [TableFieldImageConfiguration](./aws-properties-quicksight-analysis-tablefieldimageconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldurlconfiguration.html#cfn-quicksight-analysis-tablefieldurlconfiguration-imageconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldImageConfiguration" } } }, "AWS::QuickSight::Analysis.TableFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableFieldWells`\n\nThe field wells for a table visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldwells.html", "Properties": { "TableUnaggregatedFieldWells": { "MarkdownDocumentation": "`TableUnaggregatedFieldWells`\n\nThe unaggregated field well for the table.\n*Required*: No\n*Type*: [TableUnaggregatedFieldWells](./aws-properties-quicksight-analysis-tableunaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldwells.html#cfn-quicksight-analysis-tablefieldwells-tableunaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableUnaggregatedFieldWells" }, "TableAggregatedFieldWells": { "MarkdownDocumentation": "`TableAggregatedFieldWells`\n\nThe aggregated field well for the table.\n*Required*: No\n*Type*: [TableAggregatedFieldWells](./aws-properties-quicksight-analysis-tableaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablefieldwells.html#cfn-quicksight-analysis-tablefieldwells-tableaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.TableInlineVisualization": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableInlineVisualization`\n\nThe inline visualization of a specific type to display within a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableinlinevisualization.html", "Properties": { "DataBars": { "MarkdownDocumentation": "`DataBars`\n\nThe configuration of the inline visualization of the data bars within a chart.\n*Required*: No\n*Type*: [DataBarsOptions](./aws-properties-quicksight-analysis-databarsoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableinlinevisualization.html#cfn-quicksight-analysis-tableinlinevisualization-databars", "UpdateType": "Mutable", "Required": false, "Type": "DataBarsOptions" } } }, "AWS::QuickSight::Analysis.TableOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableOptions`\n\nThe table options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableoptions.html", "Properties": { "HeaderStyle": { "MarkdownDocumentation": "`HeaderStyle`\n\nThe table cell style of a table header.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableoptions.html#cfn-quicksight-analysis-tableoptions-headerstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "CellStyle": { "MarkdownDocumentation": "`CellStyle`\n\nThe table cell style of table cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableoptions.html#cfn-quicksight-analysis-tableoptions-cellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "Orientation": { "MarkdownDocumentation": "`Orientation`\n\nThe orientation (vertical, horizontal) for a table.\n*Required*: No\n*Type*: String\n*Allowed values*: `VERTICAL | HORIZONTAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VERTICAL", "HORIZONTAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableoptions.html#cfn-quicksight-analysis-tableoptions-orientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowAlternateColorOptions": { "MarkdownDocumentation": "`RowAlternateColorOptions`\n\nThe row alternate color options (widget status, row alternate colors) for a table.\n*Required*: No\n*Type*: [RowAlternateColorOptions](./aws-properties-quicksight-analysis-rowalternatecoloroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableoptions.html#cfn-quicksight-analysis-tableoptions-rowalternatecoloroptions", "UpdateType": "Mutable", "Required": false, "Type": "RowAlternateColorOptions" } } }, "AWS::QuickSight::Analysis.TablePaginatedReportOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TablePaginatedReportOptions`\n\nThe paginated report options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablepaginatedreportoptions.html", "Properties": { "OverflowColumnHeaderVisibility": { "MarkdownDocumentation": "`OverflowColumnHeaderVisibility`\n\nThe visibility of repeating header rows on each page.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablepaginatedreportoptions.html#cfn-quicksight-analysis-tablepaginatedreportoptions-overflowcolumnheadervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VerticalOverflowVisibility": { "MarkdownDocumentation": "`VerticalOverflowVisibility`\n\nThe visibility of printing table overflow across pages.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablepaginatedreportoptions.html#cfn-quicksight-analysis-tablepaginatedreportoptions-verticaloverflowvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TablePinnedFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TablePinnedFieldOptions`\n\nThe settings for the pinned columns of a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablepinnedfieldoptions.html", "Properties": { "PinnedLeftFields": { "MarkdownDocumentation": "`PinnedLeftFields`\n\nA list of columns to be pinned to the left of a table visual.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 201`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablepinnedfieldoptions.html#cfn-quicksight-analysis-tablepinnedfieldoptions-pinnedleftfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.TableRowConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableRowConditionalFormatting`\n\nThe conditional formatting of a table row.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablerowconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting color (solid, gradient) of the text for a table row.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablerowconditionalformatting.html#cfn-quicksight-analysis-tablerowconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting color (solid, gradient) of the background for a table row.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablerowconditionalformatting.html#cfn-quicksight-analysis-tablerowconditionalformatting-backgroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Analysis.TableSideBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableSideBorderOptions`\n\nThe side border options for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesideborderoptions.html", "Properties": { "Left": { "MarkdownDocumentation": "`Left`\n\nThe table border options of the left border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-analysis-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesideborderoptions.html#cfn-quicksight-analysis-tablesideborderoptions-left", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Top": { "MarkdownDocumentation": "`Top`\n\nThe table border options of the top border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-analysis-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesideborderoptions.html#cfn-quicksight-analysis-tablesideborderoptions-top", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "InnerHorizontal": { "MarkdownDocumentation": "`InnerHorizontal`\n\nThe table border options of the inner horizontal border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-analysis-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesideborderoptions.html#cfn-quicksight-analysis-tablesideborderoptions-innerhorizontal", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Right": { "MarkdownDocumentation": "`Right`\n\nThe table border options of the right border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-analysis-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesideborderoptions.html#cfn-quicksight-analysis-tablesideborderoptions-right", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Bottom": { "MarkdownDocumentation": "`Bottom`\n\nThe table border options of the bottom border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-analysis-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesideborderoptions.html#cfn-quicksight-analysis-tablesideborderoptions-bottom", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "InnerVertical": { "MarkdownDocumentation": "`InnerVertical`\n\nThe table border options of the inner vertical border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-analysis-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesideborderoptions.html#cfn-quicksight-analysis-tablesideborderoptions-innervertical", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" } } }, "AWS::QuickSight::Analysis.TableSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableSortConfiguration`\n\nThe sort configuration for a `TableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesortconfiguration.html", "Properties": { "RowSort": { "MarkdownDocumentation": "`RowSort`\n\nThe field sort options for rows in the table.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesortconfiguration.html#cfn-quicksight-analysis-tablesortconfiguration-rowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "PaginationConfiguration": { "MarkdownDocumentation": "`PaginationConfiguration`\n\nThe pagination configuration (page size, page number) for the table.\n*Required*: No\n*Type*: [PaginationConfiguration](./aws-properties-quicksight-analysis-paginationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablesortconfiguration.html#cfn-quicksight-analysis-tablesortconfiguration-paginationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PaginationConfiguration" } } }, "AWS::QuickSight::Analysis.TableStyleTarget": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableStyleTarget`\n\nThe table style target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablestyletarget.html", "Properties": { "CellType": { "MarkdownDocumentation": "`CellType`\n\nThe cell type of the table style target.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOTAL | METRIC_HEADER | VAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOTAL", "METRIC_HEADER", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablestyletarget.html#cfn-quicksight-analysis-tablestyletarget-celltype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TableUnaggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableUnaggregatedFieldWells`\n\nThe unaggregated field well for the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableunaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are unaggregated for an unaggregated table.\n*Required*: No\n*Type*: Array of [UnaggregatedField](./aws-properties-quicksight-analysis-unaggregatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tableunaggregatedfieldwells.html#cfn-quicksight-analysis-tableunaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UnaggregatedField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.TableVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TableVisual`\n\nA table visual.\nFor more information, see [Using tables as visuals](https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablevisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablevisual.html#cfn-quicksight-analysis-tablevisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n*Required*: No\n*Type*: [TableConditionalFormatting](./aws-properties-quicksight-analysis-tableconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablevisual.html#cfn-quicksight-analysis-tablevisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "TableConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablevisual.html#cfn-quicksight-analysis-tablevisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [TableConfiguration](./aws-properties-quicksight-analysis-tableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablevisual.html#cfn-quicksight-analysis-tablevisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablevisual.html#cfn-quicksight-analysis-tablevisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablevisual.html#cfn-quicksight-analysis-tablevisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tablevisual.html#cfn-quicksight-analysis-tablevisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TextAreaControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TextAreaControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textareacontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textareacontroldisplayoptions.html#cfn-quicksight-analysis-textareacontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "PlaceholderOptions": { "MarkdownDocumentation": "`PlaceholderOptions`\n\nThe configuration of the placeholder options in a text area control.\n*Required*: No\n*Type*: [TextControlPlaceholderOptions](./aws-properties-quicksight-analysis-textcontrolplaceholderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textareacontroldisplayoptions.html#cfn-quicksight-analysis-textareacontroldisplayoptions-placeholderoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextControlPlaceholderOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textareacontroldisplayoptions.html#cfn-quicksight-analysis-textareacontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Analysis.TextConditionalFormat": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TextConditionalFormat`\n\nThe conditional formatting for the text.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textconditionalformat.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting for the text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textconditionalformat.html#cfn-quicksight-analysis-textconditionalformat-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting for the icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-analysis-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textconditionalformat.html#cfn-quicksight-analysis-textconditionalformat-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting for the text background color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-analysis-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textconditionalformat.html#cfn-quicksight-analysis-textconditionalformat-backgroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Analysis.TextControlPlaceholderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TextControlPlaceholderOptions`\n\nThe configuration of the placeholder options in a text control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textcontrolplaceholderoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the placeholder options in a text control.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textcontrolplaceholderoptions.html#cfn-quicksight-analysis-textcontrolplaceholderoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TextFieldControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TextFieldControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textfieldcontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-analysis-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textfieldcontroldisplayoptions.html#cfn-quicksight-analysis-textfieldcontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "PlaceholderOptions": { "MarkdownDocumentation": "`PlaceholderOptions`\n\nThe configuration of the placeholder options in a text field control.\n*Required*: No\n*Type*: [TextControlPlaceholderOptions](./aws-properties-quicksight-analysis-textcontrolplaceholderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textfieldcontroldisplayoptions.html#cfn-quicksight-analysis-textfieldcontroldisplayoptions-placeholderoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextControlPlaceholderOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-analysis-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-textfieldcontroldisplayoptions.html#cfn-quicksight-analysis-textfieldcontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Analysis.ThousandSeparatorOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ThousandSeparatorOptions`\n\nThe options that determine the thousands separator configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-thousandseparatoroptions.html", "Properties": { "Symbol": { "MarkdownDocumentation": "`Symbol`\n\nDetermines the thousands separator symbol.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMMA | DOT | SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMMA", "DOT", "SPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-thousandseparatoroptions.html#cfn-quicksight-analysis-thousandseparatoroptions-symbol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the thousands separator.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-thousandseparatoroptions.html#cfn-quicksight-analysis-thousandseparatoroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupingStyle": { "MarkdownDocumentation": "`GroupingStyle`\n\nDetermines the way numbers are styled to accommodate different readability standards. The `DEFAULT` value uses the standard international grouping system and groups numbers by the thousands. The `LAKHS` value uses the Indian numbering system and groups numbers by lakhs and crores.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | LAKHS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "LAKHS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-thousandseparatoroptions.html#cfn-quicksight-analysis-thousandseparatoroptions-groupingstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TimeBasedForecastProperties": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TimeBasedForecastProperties`\n\nThe forecast properties setup of a forecast in the line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timebasedforecastproperties.html", "Properties": { "PeriodsBackward": { "MarkdownDocumentation": "`PeriodsBackward`\n\nThe periods backward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timebasedforecastproperties.html#cfn-quicksight-analysis-timebasedforecastproperties-periodsbackward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PeriodsForward": { "MarkdownDocumentation": "`PeriodsForward`\n\nThe periods forward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timebasedforecastproperties.html#cfn-quicksight-analysis-timebasedforecastproperties-periodsforward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PredictionInterval": { "MarkdownDocumentation": "`PredictionInterval`\n\nThe prediction interval setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `50`\n*Maximum*: `95`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timebasedforecastproperties.html#cfn-quicksight-analysis-timebasedforecastproperties-predictioninterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Seasonality": { "MarkdownDocumentation": "`Seasonality`\n\nThe seasonality setup of a forecast computation. Choose one of the following options:\n* `NULL`: The input is set to `NULL`.\n* `NON_NULL`: The input is set to a custom value.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `180`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timebasedforecastproperties.html#cfn-quicksight-analysis-timebasedforecastproperties-seasonality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "UpperBoundary": { "MarkdownDocumentation": "`UpperBoundary`\n\nThe upper boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timebasedforecastproperties.html#cfn-quicksight-analysis-timebasedforecastproperties-upperboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "LowerBoundary": { "MarkdownDocumentation": "`LowerBoundary`\n\nThe lower boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timebasedforecastproperties.html#cfn-quicksight-analysis-timebasedforecastproperties-lowerboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Analysis.TimeEqualityFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TimeEqualityFilter`\n\nA `TimeEqualityFilter` filters values that are equal to a given value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timeequalityfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timeequalityfilter.html#cfn-quicksight-analysis-timeequalityfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date input for the `TimeEquality` filter.\nThis field is mutually exclusive to `Value` and `ParameterName`.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-analysis-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timeequalityfilter.html#cfn-quicksight-analysis-timeequalityfilter-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a `TimeEquality` filter.\nThis field is mutually exclusive to `RollingDate` and `ParameterName`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timeequalityfilter.html#cfn-quicksight-analysis-timeequalityfilter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timeequalityfilter.html#cfn-quicksight-analysis-timeequalityfilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\nThis field is mutually exclusive to `Value` and `RollingDate`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timeequalityfilter.html#cfn-quicksight-analysis-timeequalityfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timeequalityfilter.html#cfn-quicksight-analysis-timeequalityfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timeequalityfilter.html#cfn-quicksight-analysis-timeequalityfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TimeRangeDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TimeRangeDrillDownFilter`\n\nThe time range drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangedrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangedrilldownfilter.html#cfn-quicksight-analysis-timerangedrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RangeMinimum": { "MarkdownDocumentation": "`RangeMinimum`\n\nThe minimum value for the filter value range.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangedrilldownfilter.html#cfn-quicksight-analysis-timerangedrilldownfilter-rangeminimum", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangedrilldownfilter.html#cfn-quicksight-analysis-timerangedrilldownfilter-timegranularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeMaximum": { "MarkdownDocumentation": "`RangeMaximum`\n\nThe maximum value for the filter value range.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangedrilldownfilter.html#cfn-quicksight-analysis-timerangedrilldownfilter-rangemaximum", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TimeRangeFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TimeRangeFilter`\n\nA `TimeRangeFilter` filters values that are between two specified values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html", "Properties": { "RangeMinimumValue": { "MarkdownDocumentation": "`RangeMinimumValue`\n\nThe minimum value for the filter value range.\n*Required*: No\n*Type*: [TimeRangeFilterValue](./aws-properties-quicksight-analysis-timerangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-rangeminimumvalue", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilterValue" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RangeMaximumValue": { "MarkdownDocumentation": "`RangeMaximumValue`\n\nThe maximum value for the filter value range.\n*Required*: No\n*Type*: [TimeRangeFilterValue](./aws-properties-quicksight-analysis-timerangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-rangemaximumvalue", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilterValue" }, "IncludeMaximum": { "MarkdownDocumentation": "`IncludeMaximum`\n\nDetermines whether the maximum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-includemaximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IncludeMinimum": { "MarkdownDocumentation": "`IncludeMinimum`\n\nDetermines whether the minimum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-includeminimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExcludePeriodConfiguration": { "MarkdownDocumentation": "`ExcludePeriodConfiguration`\n\nThe exclude period of the time range filter.\n*Required*: No\n*Type*: [ExcludePeriodConfiguration](./aws-properties-quicksight-analysis-excludeperiodconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-excludeperiodconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExcludePeriodConfiguration" } } }, "AWS::QuickSight::Analysis.TimeRangeFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TimeRangeFilterValue`\n\nThe value of a time range filter.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefiltervalue.html", "Properties": { "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date input value.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-analysis-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefiltervalue.html#cfn-quicksight-analysis-timerangefiltervalue-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nThe static input 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefiltervalue.html#cfn-quicksight-analysis-timerangefiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameter": { "MarkdownDocumentation": "`Parameter`\n\nThe parameter type input value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefiltervalue.html#cfn-quicksight-analysis-timerangefiltervalue-parameter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TooltipItem`\n\nThe tooltip.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipitem.html", "Properties": { "FieldTooltipItem": { "MarkdownDocumentation": "`FieldTooltipItem`\n\nThe tooltip item for the fields.\n*Required*: No\n*Type*: [FieldTooltipItem](./aws-properties-quicksight-analysis-fieldtooltipitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipitem.html#cfn-quicksight-analysis-tooltipitem-fieldtooltipitem", "UpdateType": "Mutable", "Required": false, "Type": "FieldTooltipItem" }, "ColumnTooltipItem": { "MarkdownDocumentation": "`ColumnTooltipItem`\n\nThe tooltip item for the columns that are not part of a field well.\n*Required*: No\n*Type*: [ColumnTooltipItem](./aws-properties-quicksight-analysis-columntooltipitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipitem.html#cfn-quicksight-analysis-tooltipitem-columntooltipitem", "UpdateType": "Mutable", "Required": false, "Type": "ColumnTooltipItem" } } }, "AWS::QuickSight::Analysis.TooltipOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TooltipOptions`\n\nThe display options for the visual tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipoptions.html", "Properties": { "SelectedTooltipType": { "MarkdownDocumentation": "`SelectedTooltipType`\n\nThe selected type for the tooltip. Choose one of the following options:\n* `BASIC`: A basic tooltip.\n* `DETAILED`: A detailed tooltip.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC | DETAILED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "DETAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipoptions.html#cfn-quicksight-analysis-tooltipoptions-selectedtooltiptype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipVisibility": { "MarkdownDocumentation": "`TooltipVisibility`\n\nDetermines whether or not the tooltip is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipoptions.html#cfn-quicksight-analysis-tooltipoptions-tooltipvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldBasedTooltip": { "MarkdownDocumentation": "`FieldBasedTooltip`\n\nThe setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.\n*Required*: No\n*Type*: [FieldBasedTooltip](./aws-properties-quicksight-analysis-fieldbasedtooltip.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-tooltipoptions.html#cfn-quicksight-analysis-tooltipoptions-fieldbasedtooltip", "UpdateType": "Mutable", "Required": false, "Type": "FieldBasedTooltip" } } }, "AWS::QuickSight::Analysis.TopBottomFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TopBottomFilter`\n\nA `TopBottomFilter` filters values that are at the top or the bottom.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html", "Properties": { "AggregationSortConfigurations": { "MarkdownDocumentation": "`AggregationSortConfigurations`\n\nThe aggregation and sort configuration of the top bottom filter.\n*Required*: Yes\n*Type*: Array of [AggregationSortConfiguration](./aws-properties-quicksight-analysis-aggregationsortconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-aggregationsortconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AggregationSortConfiguration", "DuplicatesAllowed": true }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nThe number of items to include in the top bottom filter results.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-analysis-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomfilter.html#cfn-quicksight-analysis-topbottomfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TopBottomMoversComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TopBottomMoversComputation`\n\nThe top movers and bottom movers computation setup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe computation type. Choose from the following options:\n* TOP: Top movers computation.\n* BOTTOM: Bottom movers computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOP | BOTTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "BOTTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html#cfn-quicksight-analysis-topbottommoverscomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html#cfn-quicksight-analysis-topbottommoverscomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html#cfn-quicksight-analysis-topbottommoverscomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "SortOrder": { "MarkdownDocumentation": "`SortOrder`\n\nThe sort order setup of the top and bottom movers computation.\n*Required*: No\n*Type*: String\n*Allowed values*: `PERCENT_DIFFERENCE | ABSOLU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PERCENT_DIFFERENCE", "ABSOLUTE_DIFFERENCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html#cfn-quicksight-analysis-topbottommoverscomputation-sortorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html#cfn-quicksight-analysis-topbottommoverscomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "MoverSize": { "MarkdownDocumentation": "`MoverSize`\n\nThe mover size setup of the top and bottom movers computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html#cfn-quicksight-analysis-topbottommoverscomputation-moversize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html#cfn-quicksight-analysis-topbottommoverscomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottommoverscomputation.html#cfn-quicksight-analysis-topbottommoverscomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TopBottomRankedComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TopBottomRankedComputation`\n\nThe top ranked and bottom ranked computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomrankedcomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe computation type. Choose one of the following options:\n* TOP: A top ranked computation.\n* BOTTOM: A bottom ranked computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOP | BOTTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "BOTTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomrankedcomputation.html#cfn-quicksight-analysis-topbottomrankedcomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomrankedcomputation.html#cfn-quicksight-analysis-topbottomrankedcomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ResultSize": { "MarkdownDocumentation": "`ResultSize`\n\nThe result size of a top and bottom ranked computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomrankedcomputation.html#cfn-quicksight-analysis-topbottomrankedcomputation-resultsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomrankedcomputation.html#cfn-quicksight-analysis-topbottomrankedcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomrankedcomputation.html#cfn-quicksight-analysis-topbottomrankedcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-topbottomrankedcomputation.html#cfn-quicksight-analysis-topbottomrankedcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TotalAggregationComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TotalAggregationComputation`\n\nThe total aggregation computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationcomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationcomputation.html#cfn-quicksight-analysis-totalaggregationcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationcomputation.html#cfn-quicksight-analysis-totalaggregationcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationcomputation.html#cfn-quicksight-analysis-totalaggregationcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TotalAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TotalAggregationFunction`\n\nAn aggregation function that aggregates the total values of a measure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationfunction.html", "Properties": { "SimpleTotalAggregationFunction": { "MarkdownDocumentation": "`SimpleTotalAggregationFunction`\n\nA built in aggregation function for total values.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | SUM | AVERAGE | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "SUM", "AVERAGE", "MIN", "MAX", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationfunction.html#cfn-quicksight-analysis-totalaggregationfunction-simpletotalaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TotalAggregationOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TotalAggregationOption`\n\nThe total aggregation settings map of a field id.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationoption.html", "Properties": { "TotalAggregationFunction": { "MarkdownDocumentation": "`TotalAggregationFunction`\n\nThe total aggregation function that you want to set for a specified field id.\n*Required*: Yes\n*Type*: [TotalAggregationFunction](./aws-properties-quicksight-analysis-totalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationoption.html#cfn-quicksight-analysis-totalaggregationoption-totalaggregationfunction", "UpdateType": "Mutable", "Required": true, "Type": "TotalAggregationFunction" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field id that's associated with the total aggregation option.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totalaggregationoption.html#cfn-quicksight-analysis-totalaggregationoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TotalOptions`\n\nThe total options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totaloptions.html", "Properties": { "TotalAggregationOptions": { "MarkdownDocumentation": "`TotalAggregationOptions`\n\nThe total aggregation settings for each value field.\n*Required*: No\n*Type*: Array of [TotalAggregationOption](./aws-properties-quicksight-analysis-totalaggregationoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totaloptions.html#cfn-quicksight-analysis-totaloptions-totalaggregationoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TotalAggregationOption", "DuplicatesAllowed": true }, "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the total cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totaloptions.html#cfn-quicksight-analysis-totaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScrollStatus": { "MarkdownDocumentation": "`ScrollStatus`\n\nThe scroll status (pinned, scrolled) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `PINNED | SCROLLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PINNED", "SCROLLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totaloptions.html#cfn-quicksight-analysis-totaloptions-scrollstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe placement (start, end) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `START | END | AUTO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "START", "END", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totaloptions.html#cfn-quicksight-analysis-totaloptions-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nCell styling options for the total cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-analysis-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totaloptions.html#cfn-quicksight-analysis-totaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-totaloptions.html#cfn-quicksight-analysis-totaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TransposedTableOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TransposedTableOption`\n\nThe column option of the transposed table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-transposedtableoption.html", "Properties": { "ColumnWidth": { "MarkdownDocumentation": "`ColumnWidth`\n\nThe width of a column in a transposed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-transposedtableoption.html#cfn-quicksight-analysis-transposedtableoption-columnwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnIndex": { "MarkdownDocumentation": "`ColumnIndex`\n\nThe index of a columns in a transposed table. The index range is 0-9999.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `9999`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-transposedtableoption.html#cfn-quicksight-analysis-transposedtableoption-columnindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ColumnType": { "MarkdownDocumentation": "`ColumnType`\n\nThe column type of the column in a transposed table. Choose one of the following options:\n* `ROW_HEADER_COLUMN`: Refers to the leftmost column of the row header in the transposed table.\n* `VALUE_COLUMN`: Refers to all value columns in the transposed table.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ROW_HEADER_COLUMN | VALUE_C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROW_HEADER_COLUMN", "VALUE_COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-transposedtableoption.html#cfn-quicksight-analysis-transposedtableoption-columntype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.TreeMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TreeMapAggregatedFieldWells`\n\nAggregated field wells of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapaggregatedfieldwells.html", "Properties": { "Sizes": { "MarkdownDocumentation": "`Sizes`\n\nThe size field well of a tree map. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapaggregatedfieldwells.html#cfn-quicksight-analysis-treemapaggregatedfieldwells-sizes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field well of a tree map. Values are grouped by aggregations based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapaggregatedfieldwells.html#cfn-quicksight-analysis-treemapaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe group by field well of a tree map. Values are grouped based on group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapaggregatedfieldwells.html#cfn-quicksight-analysis-treemapaggregatedfieldwells-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.TreeMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TreeMapConfiguration`\n\nThe configuration of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a tree map.\n*Required*: No\n*Type*: [TreeMapSortConfiguration](./aws-properties-quicksight-analysis-treemapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility) for the colors displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SizeLabelOptions": { "MarkdownDocumentation": "`SizeLabelOptions`\n\nThe label options (label text, label visibility) of the sizes that are displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-sizelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [TreeMapFieldWells](./aws-properties-quicksight-analysis-treemapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-analysis-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "ColorScale": { "MarkdownDocumentation": "`ColorScale`\n\nThe color options (gradient color, point of divergence) of a tree map.\n*Required*: No\n*Type*: [ColorScale](./aws-properties-quicksight-analysis-colorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-colorscale", "UpdateType": "Mutable", "Required": false, "Type": "ColorScale" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "GroupLabelOptions": { "MarkdownDocumentation": "`GroupLabelOptions`\n\nThe label options (label text, label visibility) of the groups that are displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapconfiguration.html#cfn-quicksight-analysis-treemapconfiguration-grouplabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" } } }, "AWS::QuickSight::Analysis.TreeMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TreeMapFieldWells`\n\nThe field wells of a tree map.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapfieldwells.html", "Properties": { "TreeMapAggregatedFieldWells": { "MarkdownDocumentation": "`TreeMapAggregatedFieldWells`\n\nThe aggregated field wells of a tree map.\n*Required*: No\n*Type*: [TreeMapAggregatedFieldWells](./aws-properties-quicksight-analysis-treemapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapfieldwells.html#cfn-quicksight-analysis-treemapfieldwells-treemapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.TreeMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TreeMapSortConfiguration`\n\nThe sort configuration of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapsortconfiguration.html", "Properties": { "TreeMapSort": { "MarkdownDocumentation": "`TreeMapSort`\n\nThe sort configuration of group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapsortconfiguration.html#cfn-quicksight-analysis-treemapsortconfiguration-treemapsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "TreeMapGroupItemsLimitConfiguration": { "MarkdownDocumentation": "`TreeMapGroupItemsLimitConfiguration`\n\nThe limit on the number of groups that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapsortconfiguration.html#cfn-quicksight-analysis-treemapsortconfiguration-treemapgroupitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Analysis.TreeMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TreeMapVisual`\n\nA tree map.\nFor more information, see [Using tree maps](https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapvisual.html#cfn-quicksight-analysis-treemapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapvisual.html#cfn-quicksight-analysis-treemapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [TreeMapConfiguration](./aws-properties-quicksight-analysis-treemapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapvisual.html#cfn-quicksight-analysis-treemapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapvisual.html#cfn-quicksight-analysis-treemapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapvisual.html#cfn-quicksight-analysis-treemapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapvisual.html#cfn-quicksight-analysis-treemapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-treemapvisual.html#cfn-quicksight-analysis-treemapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.TrendArrowOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.TrendArrowOptions`\n\nThe options that determine the presentation of trend arrows in a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-trendarrowoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the trend arrows.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-trendarrowoptions.html#cfn-quicksight-analysis-trendarrowoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.UnaggregatedField": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.UnaggregatedField`\n\nThe unaggregated field for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-unaggregatedfield.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [FormatConfiguration](./aws-properties-quicksight-analysis-formatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-unaggregatedfield.html#cfn-quicksight-analysis-unaggregatedfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `UnaggregatedField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-analysis-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-unaggregatedfield.html#cfn-quicksight-analysis-unaggregatedfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-unaggregatedfield.html#cfn-quicksight-analysis-unaggregatedfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.UniqueValuesComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.UniqueValuesComputation`\n\nThe unique values computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-uniquevaluescomputation.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-uniquevaluescomputation.html#cfn-quicksight-analysis-uniquevaluescomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-uniquevaluescomputation.html#cfn-quicksight-analysis-uniquevaluescomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-uniquevaluescomputation.html#cfn-quicksight-analysis-uniquevaluescomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.ValidationStrategy": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.ValidationStrategy`\n\nThe option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to `LENIENT`, validation is skipped for specific errors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-validationstrategy.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe mode of validation for the asset to be created or updated. When you set this value to `STRICT`, strict validation for every error is enforced. When you set this value to `LENIENT`, validation is skipped for specific UI errors.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRICT | LENIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRICT", "LENIENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-validationstrategy.html#cfn-quicksight-analysis-validationstrategy-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.VisibleRangeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.VisibleRangeOptions`\n\nThe range options for the data zoom scroll bar.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visiblerangeoptions.html", "Properties": { "PercentRange": { "MarkdownDocumentation": "`PercentRange`\n\nThe percent range in the visible range.\n*Required*: No\n*Type*: [PercentVisibleRange](./aws-properties-quicksight-analysis-percentvisiblerange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visiblerangeoptions.html#cfn-quicksight-analysis-visiblerangeoptions-percentrange", "UpdateType": "Mutable", "Required": false, "Type": "PercentVisibleRange" } } }, "AWS::QuickSight::Analysis.Visual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.Visual`\n\nA visual displayed on a sheet in an analysis, dashboard, or template.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html", "Properties": { "FunnelChartVisual": { "MarkdownDocumentation": "`FunnelChartVisual`\n\nA funnel chart.\nFor more information, see [Using funnel charts](https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [FunnelChartVisual](./aws-properties-quicksight-analysis-funnelchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-funnelchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartVisual" }, "BoxPlotVisual": { "MarkdownDocumentation": "`BoxPlotVisual`\n\nA box plot.\nFor more information, see [Using box plots](https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [BoxPlotVisual](./aws-properties-quicksight-analysis-boxplotvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-boxplotvisual", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotVisual" }, "LayerMapVisual": { "MarkdownDocumentation": "`LayerMapVisual`\n\nThe properties for a layer map visual\n*Required*: No\n*Type*: [LayerMapVisual](./aws-properties-quicksight-analysis-layermapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-layermapvisual", "UpdateType": "Mutable", "Required": false, "Type": "LayerMapVisual" }, "GeospatialMapVisual": { "MarkdownDocumentation": "`GeospatialMapVisual`\n\nA geospatial map or a points on map visual.\nFor more information, see [Creating point maps](https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [GeospatialMapVisual](./aws-properties-quicksight-analysis-geospatialmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-geospatialmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapVisual" }, "ScatterPlotVisual": { "MarkdownDocumentation": "`ScatterPlotVisual`\n\nA scatter plot.\nFor more information, see [Using scatter plots](https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [ScatterPlotVisual](./aws-properties-quicksight-analysis-scatterplotvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-scatterplotvisual", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotVisual" }, "RadarChartVisual": { "MarkdownDocumentation": "`RadarChartVisual`\n\nA radar chart visual.\nFor more information, see [Using radar charts](https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [RadarChartVisual](./aws-properties-quicksight-analysis-radarchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-radarchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartVisual" }, "ComboChartVisual": { "MarkdownDocumentation": "`ComboChartVisual`\n\nA combo chart.\nFor more information, see [Using combo charts](https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [ComboChartVisual](./aws-properties-quicksight-analysis-combochartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-combochartvisual", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartVisual" }, "WordCloudVisual": { "MarkdownDocumentation": "`WordCloudVisual`\n\nA word cloud.\nFor more information, see [Using word clouds](https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [WordCloudVisual](./aws-properties-quicksight-analysis-wordcloudvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-wordcloudvisual", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudVisual" }, "SankeyDiagramVisual": { "MarkdownDocumentation": "`SankeyDiagramVisual`\n\nA sankey diagram.\nFor more information, see [Using Sankey diagrams](https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [SankeyDiagramVisual](./aws-properties-quicksight-analysis-sankeydiagramvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-sankeydiagramvisual", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramVisual" }, "GaugeChartVisual": { "MarkdownDocumentation": "`GaugeChartVisual`\n\nA gauge chart.\nFor more information, see [Using gauge charts](https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [GaugeChartVisual](./aws-properties-quicksight-analysis-gaugechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-gaugechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartVisual" }, "FilledMapVisual": { "MarkdownDocumentation": "`FilledMapVisual`\n\nA filled map.\nFor more information, see [Creating filled maps](https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [FilledMapVisual](./aws-properties-quicksight-analysis-filledmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-filledmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapVisual" }, "WaterfallVisual": { "MarkdownDocumentation": "`WaterfallVisual`\n\nA waterfall chart.\nFor more information, see [Using waterfall charts](https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [WaterfallVisual](./aws-properties-quicksight-analysis-waterfallvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-waterfallvisual", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallVisual" }, "CustomContentVisual": { "MarkdownDocumentation": "`CustomContentVisual`\n\nA visual that contains custom content.\nFor more information, see [Using custom visual content](https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [CustomContentVisual](./aws-properties-quicksight-analysis-customcontentvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-customcontentvisual", "UpdateType": "Mutable", "Required": false, "Type": "CustomContentVisual" }, "PieChartVisual": { "MarkdownDocumentation": "`PieChartVisual`\n\nA pie or donut chart.\nFor more information, see [Using pie charts](https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [PieChartVisual](./aws-properties-quicksight-analysis-piechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-piechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "PieChartVisual" }, "KPIVisual": { "MarkdownDocumentation": "`KPIVisual`\n\nA key performance indicator (KPI).\nFor more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [KPIVisual](./aws-properties-quicksight-analysis-kpivisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-kpivisual", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisual" }, "HistogramVisual": { "MarkdownDocumentation": "`HistogramVisual`\n\nA histogram.\nFor more information, see [Using histograms](https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [HistogramVisual](./aws-properties-quicksight-analysis-histogramvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-histogramvisual", "UpdateType": "Mutable", "Required": false, "Type": "HistogramVisual" }, "PluginVisual": { "MarkdownDocumentation": "`PluginVisual`\n\nThe custom plugin visual type.\n*Required*: No\n*Type*: [PluginVisual](./aws-properties-quicksight-analysis-pluginvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-pluginvisual", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisual" }, "TableVisual": { "MarkdownDocumentation": "`TableVisual`\n\nA table visual.\nFor more information, see [Using tables as visuals](https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [TableVisual](./aws-properties-quicksight-analysis-tablevisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-tablevisual", "UpdateType": "Mutable", "Required": false, "Type": "TableVisual" }, "PivotTableVisual": { "MarkdownDocumentation": "`PivotTableVisual`\n\nA pivot table.\nFor more information, see [Using pivot tables](https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [PivotTableVisual](./aws-properties-quicksight-analysis-pivottablevisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-pivottablevisual", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableVisual" }, "BarChartVisual": { "MarkdownDocumentation": "`BarChartVisual`\n\nA bar chart.\nFor more information, see [Using bar charts](https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [BarChartVisual](./aws-properties-quicksight-analysis-barchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-barchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "BarChartVisual" }, "HeatMapVisual": { "MarkdownDocumentation": "`HeatMapVisual`\n\nA heat map.\nFor more information, see [Using heat maps](https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [HeatMapVisual](./aws-properties-quicksight-analysis-heatmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-heatmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapVisual" }, "TreeMapVisual": { "MarkdownDocumentation": "`TreeMapVisual`\n\nA tree map.\nFor more information, see [Using tree maps](https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [TreeMapVisual](./aws-properties-quicksight-analysis-treemapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-treemapvisual", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapVisual" }, "InsightVisual": { "MarkdownDocumentation": "`InsightVisual`\n\nAn insight visual.\nFor more information, see [Working with insights](https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [InsightVisual](./aws-properties-quicksight-analysis-insightvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-insightvisual", "UpdateType": "Mutable", "Required": false, "Type": "InsightVisual" }, "LineChartVisual": { "MarkdownDocumentation": "`LineChartVisual`\n\nA line chart.\nFor more information, see [Using line charts](https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [LineChartVisual](./aws-properties-quicksight-analysis-linechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-linechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "LineChartVisual" }, "EmptyVisual": { "MarkdownDocumentation": "`EmptyVisual`\n\nAn empty visual.\n*Required*: No\n*Type*: [EmptyVisual](./aws-properties-quicksight-analysis-emptyvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-emptyvisual", "UpdateType": "Mutable", "Required": false, "Type": "EmptyVisual" } } }, "AWS::QuickSight::Analysis.VisualCustomAction": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.VisualCustomAction`\n\nA custom action defined on a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the `VisualCustomAction`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomaction.html#cfn-quicksight-analysis-visualcustomaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trigger": { "MarkdownDocumentation": "`Trigger`\n\nThe trigger of the `VisualCustomAction`.\nValid values are defined as follows:\n* `DATA_POINT_CLICK`: Initiates a custom action by a left pointer click on a data point.\n* `DATA_POINT_MENU`: Initiates a custom action by right pointer click from the menu.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DATA_POINT_CLICK | DATA_POI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DATA_POINT_CLICK", "DATA_POINT_MENU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomaction.html#cfn-quicksight-analysis-visualcustomaction-trigger", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomActionId": { "MarkdownDocumentation": "`CustomActionId`\n\nThe ID of the `VisualCustomAction`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomaction.html#cfn-quicksight-analysis-visualcustomaction-customactionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the `VisualCustomAction`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomaction.html#cfn-quicksight-analysis-visualcustomaction-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionOperations": { "MarkdownDocumentation": "`ActionOperations`\n\nA list of `VisualCustomActionOperations`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: Array of [VisualCustomActionOperation](./aws-properties-quicksight-analysis-visualcustomactionoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomaction.html#cfn-quicksight-analysis-visualcustomaction-actionoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "VisualCustomActionOperation", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.VisualCustomActionOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.VisualCustomActionOperation`\n\nThe operation that is defined by the custom action.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomactionoperation.html", "Properties": { "NavigationOperation": { "MarkdownDocumentation": "`NavigationOperation`\n\nThe navigation operation that navigates between different sheets in the same analysis.\n*Required*: No\n*Type*: [CustomActionNavigationOperation](./aws-properties-quicksight-analysis-customactionnavigationoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomactionoperation.html#cfn-quicksight-analysis-visualcustomactionoperation-navigationoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionNavigationOperation" }, "SetParametersOperation": { "MarkdownDocumentation": "`SetParametersOperation`\n\nThe set parameter operation that sets parameters in custom action.\n*Required*: No\n*Type*: [CustomActionSetParametersOperation](./aws-properties-quicksight-analysis-customactionsetparametersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomactionoperation.html#cfn-quicksight-analysis-visualcustomactionoperation-setparametersoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionSetParametersOperation" }, "FilterOperation": { "MarkdownDocumentation": "`FilterOperation`\n\nThe filter operation that filters data included in a visual or in an entire sheet.\n*Required*: No\n*Type*: [CustomActionFilterOperation](./aws-properties-quicksight-analysis-customactionfilteroperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomactionoperation.html#cfn-quicksight-analysis-visualcustomactionoperation-filteroperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionFilterOperation" }, "URLOperation": { "MarkdownDocumentation": "`URLOperation`\n\nThe URL operation that opens a link to another webpage.\n*Required*: No\n*Type*: [CustomActionURLOperation](./aws-properties-quicksight-analysis-customactionurloperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualcustomactionoperation.html#cfn-quicksight-analysis-visualcustomactionoperation-urloperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionURLOperation" } } }, "AWS::QuickSight::Analysis.VisualInteractionOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.VisualInteractionOptions`\n\nThe general visual interactions setup for visual publish options\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualinteractionoptions.html", "Properties": { "ContextMenuOption": { "MarkdownDocumentation": "`ContextMenuOption`\n\nThe context menu options for a visual.\n*Required*: No\n*Type*: [ContextMenuOption](./aws-properties-quicksight-analysis-contextmenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualinteractionoptions.html#cfn-quicksight-analysis-visualinteractionoptions-contextmenuoption", "UpdateType": "Mutable", "Required": false, "Type": "ContextMenuOption" }, "VisualMenuOption": { "MarkdownDocumentation": "`VisualMenuOption`\n\nThe on-visual menu options for a visual.\n*Required*: No\n*Type*: [VisualMenuOption](./aws-properties-quicksight-analysis-visualmenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualinteractionoptions.html#cfn-quicksight-analysis-visualinteractionoptions-visualmenuoption", "UpdateType": "Mutable", "Required": false, "Type": "VisualMenuOption" } } }, "AWS::QuickSight::Analysis.VisualMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.VisualMenuOption`\n\nThe menu options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualmenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availaiblity status of a visual's menu options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualmenuoption.html#cfn-quicksight-analysis-visualmenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.VisualPalette": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.VisualPalette`\n\nThe visual display options for the visual palette.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualpalette.html", "Properties": { "ChartColor": { "MarkdownDocumentation": "`ChartColor`\n\nThe chart color options for the visual palette.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualpalette.html#cfn-quicksight-analysis-visualpalette-chartcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColorMap": { "MarkdownDocumentation": "`ColorMap`\n\nThe color map options for the visual palette.\n*Required*: No\n*Type*: Array of [DataPathColor](./aws-properties-quicksight-analysis-datapathcolor.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualpalette.html#cfn-quicksight-analysis-visualpalette-colormap", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataPathColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.VisualSubtitleLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.VisualSubtitleLabelOptions`\n\nThe subtitle label options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the subtitle label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html#cfn-quicksight-analysis-visualsubtitlelabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatText": { "MarkdownDocumentation": "`FormatText`\n\nThe long text format of the subtitle label, such as plain text or rich text.\n*Required*: No\n*Type*: [LongFormatText](./aws-properties-quicksight-analysis-longformattext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html#cfn-quicksight-analysis-visualsubtitlelabeloptions-formattext", "UpdateType": "Mutable", "Required": false, "Type": "LongFormatText" } } }, "AWS::QuickSight::Analysis.VisualTitleLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.VisualTitleLabelOptions`\n\nThe title label options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualtitlelabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the title label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualtitlelabeloptions.html#cfn-quicksight-analysis-visualtitlelabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatText": { "MarkdownDocumentation": "`FormatText`\n\nThe short text format of the title label, such as plain text or rich text.\n*Required*: No\n*Type*: [ShortFormatText](./aws-properties-quicksight-analysis-shortformattext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visualtitlelabeloptions.html#cfn-quicksight-analysis-visualtitlelabeloptions-formattext", "UpdateType": "Mutable", "Required": false, "Type": "ShortFormatText" } } }, "AWS::QuickSight::Analysis.WaterfallChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WaterfallChartAggregatedFieldWells`\n\nThe field well configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartaggregatedfieldwells.html", "Properties": { "Categories": { "MarkdownDocumentation": "`Categories`\n\nThe category field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartaggregatedfieldwells.html#cfn-quicksight-analysis-waterfallchartaggregatedfieldwells-categories", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Breakdowns": { "MarkdownDocumentation": "`Breakdowns`\n\nThe breakdown field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartaggregatedfieldwells.html#cfn-quicksight-analysis-waterfallchartaggregatedfieldwells-breakdowns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartaggregatedfieldwells.html#cfn-quicksight-analysis-waterfallchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.WaterfallChartColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WaterfallChartColorConfiguration`\n\nThe color configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartcolorconfiguration.html", "Properties": { "GroupColorConfiguration": { "MarkdownDocumentation": "`GroupColorConfiguration`\n\nThe color configuration for individual groups within a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartGroupColorConfiguration](./aws-properties-quicksight-analysis-waterfallchartgroupcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartcolorconfiguration.html#cfn-quicksight-analysis-waterfallchartcolorconfiguration-groupcolorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartGroupColorConfiguration" } } }, "AWS::QuickSight::Analysis.WaterfallChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WaterfallChartConfiguration`\n\nThe configuration for a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html", "Properties": { "CategoryAxisLabelOptions": { "MarkdownDocumentation": "`CategoryAxisLabelOptions`\n\nThe options that determine the presentation of the category axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-categoryaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartSortConfiguration](./aws-properties-quicksight-analysis-waterfallchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend configuration of a waterfall visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-analysis-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a waterfall visual.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-analysis-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe options that determine the presentation of the y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartFieldWells](./aws-properties-quicksight-analysis-waterfallchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartFieldWells" }, "WaterfallChartOptions": { "MarkdownDocumentation": "`WaterfallChartOptions`\n\nThe options that determine the presentation of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartOptions](./aws-properties-quicksight-analysis-waterfallchartoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-waterfallchartoptions", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartOptions" }, "ColorConfiguration": { "MarkdownDocumentation": "`ColorConfiguration`\n\nThe color configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartColorConfiguration](./aws-properties-quicksight-analysis-waterfallchartcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-colorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartColorConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "CategoryAxisDisplayOptions": { "MarkdownDocumentation": "`CategoryAxisDisplayOptions`\n\nThe options that determine the presentation of the category axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-categoryaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe options that determine the presentation of the y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-analysis-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a waterfall visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-analysis-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartconfiguration.html#cfn-quicksight-analysis-waterfallchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Analysis.WaterfallChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WaterfallChartFieldWells`\n\nThe field well configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartfieldwells.html", "Properties": { "WaterfallChartAggregatedFieldWells": { "MarkdownDocumentation": "`WaterfallChartAggregatedFieldWells`\n\nThe field well configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartAggregatedFieldWells](./aws-properties-quicksight-analysis-waterfallchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartfieldwells.html#cfn-quicksight-analysis-waterfallchartfieldwells-waterfallchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.WaterfallChartGroupColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WaterfallChartGroupColorConfiguration`\n\nThe color configuration for individual groups within a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartgroupcolorconfiguration.html", "Properties": { "NegativeBarColor": { "MarkdownDocumentation": "`NegativeBarColor`\n\nDefines the color for the negative bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-analysis-waterfallchartgroupcolorconfiguration-negativebarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalBarColor": { "MarkdownDocumentation": "`TotalBarColor`\n\nDefines the color for the total bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-analysis-waterfallchartgroupcolorconfiguration-totalbarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PositiveBarColor": { "MarkdownDocumentation": "`PositiveBarColor`\n\nDefines the color for the positive bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-analysis-waterfallchartgroupcolorconfiguration-positivebarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.WaterfallChartOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WaterfallChartOptions`\n\nThe options that determine the presentation of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartoptions.html", "Properties": { "TotalBarLabel": { "MarkdownDocumentation": "`TotalBarLabel`\n\nThis option determines the total bar label of a waterfall visual.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartoptions.html#cfn-quicksight-analysis-waterfallchartoptions-totalbarlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.WaterfallChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WaterfallChartSortConfiguration`\n\nThe sort configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartsortconfiguration.html", "Properties": { "BreakdownItemsLimit": { "MarkdownDocumentation": "`BreakdownItemsLimit`\n\nThe limit on the number of bar groups that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartsortconfiguration.html#cfn-quicksight-analysis-waterfallchartsortconfiguration-breakdownitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallchartsortconfiguration.html#cfn-quicksight-analysis-waterfallchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.WaterfallVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WaterfallVisual`\n\nA waterfall chart.\nFor more information, see [Using waterfall charts](https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallvisual.html#cfn-quicksight-analysis-waterfallvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallvisual.html#cfn-quicksight-analysis-waterfallvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration for a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartConfiguration](./aws-properties-quicksight-analysis-waterfallchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallvisual.html#cfn-quicksight-analysis-waterfallvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallvisual.html#cfn-quicksight-analysis-waterfallvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallvisual.html#cfn-quicksight-analysis-waterfallvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallvisual.html#cfn-quicksight-analysis-waterfallvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-waterfallvisual.html#cfn-quicksight-analysis-waterfallvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.WhatIfPointScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WhatIfPointScenario`\n\nProvides the forecast to meet the target for a particular date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-whatifpointscenario.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe target value that you want to meet for the provided date.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-whatifpointscenario.html#cfn-quicksight-analysis-whatifpointscenario-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Date": { "MarkdownDocumentation": "`Date`\n\nThe date that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-whatifpointscenario.html#cfn-quicksight-analysis-whatifpointscenario-date", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.WhatIfRangeScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WhatIfRangeScenario`\n\nProvides the forecast to meet the target for a particular date range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-whatifrangescenario.html", "Properties": { "StartDate": { "MarkdownDocumentation": "`StartDate`\n\nThe start date in the date range that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-whatifrangescenario.html#cfn-quicksight-analysis-whatifrangescenario-startdate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe target value that you want to meet for the provided date range.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-whatifrangescenario.html#cfn-quicksight-analysis-whatifrangescenario-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "EndDate": { "MarkdownDocumentation": "`EndDate`\n\nThe end date in the date range that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-whatifrangescenario.html#cfn-quicksight-analysis-whatifrangescenario-enddate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.WordCloudAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WordCloudAggregatedFieldWells`\n\nThe aggregated field wells of a word cloud.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well of a word cloud. Values are grouped by group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-analysis-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudaggregatedfieldwells.html#cfn-quicksight-analysis-wordcloudaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a word cloud. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-analysis-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudaggregatedfieldwells.html#cfn-quicksight-analysis-wordcloudaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.WordCloudChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WordCloudChartConfiguration`\n\nThe configuration of a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a word cloud visual.\n*Required*: No\n*Type*: [WordCloudSortConfiguration](./aws-properties-quicksight-analysis-wordcloudsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudchartconfiguration.html#cfn-quicksight-analysis-wordcloudchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudSortConfiguration" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) for the word cloud category.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-analysis-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudchartconfiguration.html#cfn-quicksight-analysis-wordcloudchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [WordCloudFieldWells](./aws-properties-quicksight-analysis-wordcloudfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudchartconfiguration.html#cfn-quicksight-analysis-wordcloudchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudFieldWells" }, "WordCloudOptions": { "MarkdownDocumentation": "`WordCloudOptions`\n\nThe options for a word cloud visual.\n*Required*: No\n*Type*: [WordCloudOptions](./aws-properties-quicksight-analysis-wordcloudoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudchartconfiguration.html#cfn-quicksight-analysis-wordcloudchartconfiguration-wordcloudoptions", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-analysis-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudchartconfiguration.html#cfn-quicksight-analysis-wordcloudchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Analysis.WordCloudFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WordCloudFieldWells`\n\nThe field wells of a word cloud visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudfieldwells.html", "Properties": { "WordCloudAggregatedFieldWells": { "MarkdownDocumentation": "`WordCloudAggregatedFieldWells`\n\nThe aggregated field wells of a word cloud.\n*Required*: No\n*Type*: [WordCloudAggregatedFieldWells](./aws-properties-quicksight-analysis-wordcloudaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudfieldwells.html#cfn-quicksight-analysis-wordcloudfieldwells-wordcloudaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudAggregatedFieldWells" } } }, "AWS::QuickSight::Analysis.WordCloudOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WordCloudOptions`\n\nThe word cloud options for a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudoptions.html", "Properties": { "WordOrientation": { "MarkdownDocumentation": "`WordOrientation`\n\nThe word orientation options (horizontal, horizontal\\_and\\_vertical) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `HORIZONTAL | HORIZONTAL_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HORIZONTAL", "HORIZONTAL_AND_VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudoptions.html#cfn-quicksight-analysis-wordcloudoptions-wordorientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WordScaling": { "MarkdownDocumentation": "`WordScaling`\n\nThe word scaling options (emphasize, normal) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `EMPHASIZE | NORMAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EMPHASIZE", "NORMAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudoptions.html#cfn-quicksight-analysis-wordcloudoptions-wordscaling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudLayout": { "MarkdownDocumentation": "`CloudLayout`\n\nThe cloud layout options (fluid, normal) of a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLUID | NORMAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FLUID", "NORMAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudoptions.html#cfn-quicksight-analysis-wordcloudoptions-cloudlayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaximumStringLength": { "MarkdownDocumentation": "`MaximumStringLength`\n\nThe length limit of each word from 1-100.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudoptions.html#cfn-quicksight-analysis-wordcloudoptions-maximumstringlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "WordCasing": { "MarkdownDocumentation": "`WordCasing`\n\nThe word casing options (lower\\_case, existing\\_case) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `LOWER_CASE | EXISTING_CASE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOWER_CASE", "EXISTING_CASE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudoptions.html#cfn-quicksight-analysis-wordcloudoptions-wordcasing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WordPadding": { "MarkdownDocumentation": "`WordPadding`\n\nThe word padding options (none, small, medium, large) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | SMALL | MEDIUM | LAR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SMALL", "MEDIUM", "LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudoptions.html#cfn-quicksight-analysis-wordcloudoptions-wordpadding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Analysis.WordCloudSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WordCloudSortConfiguration`\n\nThe sort configuration of a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudsortconfiguration.html", "Properties": { "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of groups that are displayed in a word cloud.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-analysis-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudsortconfiguration.html#cfn-quicksight-analysis-wordcloudsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-analysis-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudsortconfiguration.html#cfn-quicksight-analysis-wordcloudsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.WordCloudVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.WordCloudVisual`\n\nA word cloud.\nFor more information, see [Using word clouds](https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-analysis-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudvisual.html#cfn-quicksight-analysis-wordcloudvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudvisual.html#cfn-quicksight-analysis-wordcloudvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [WordCloudChartConfiguration](./aws-properties-quicksight-analysis-wordcloudchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudvisual.html#cfn-quicksight-analysis-wordcloudvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-analysis-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudvisual.html#cfn-quicksight-analysis-wordcloudvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-analysis-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudvisual.html#cfn-quicksight-analysis-wordcloudvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudvisual.html#cfn-quicksight-analysis-wordcloudvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-analysis-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-wordcloudvisual.html#cfn-quicksight-analysis-wordcloudvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Analysis.YAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis.YAxisOptions`\n\nThe options that are available for a single Y axis in a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-yaxisoptions.html", "Properties": { "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe Y axis type to be used in the chart.\nIf you choose `PRIMARY_Y_AXIS`, the primary Y Axis is located on the leftmost vertical axis of the chart.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_Y_AXIS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_Y_AXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-yaxisoptions.html#cfn-quicksight-analysis-yaxisoptions-yaxis", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::CustomPermissions.Capabilities": { "MarkdownDocumentation": "`AWS::QuickSight::CustomPermissions.Capabilities`\n\nA set of actions that correspond to Amazon Quick Sight permissions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html", "Properties": { "IncludeContentInScheduledReportsEmail": { "MarkdownDocumentation": "`IncludeContentInScheduledReportsEmail`\n\nThe ability to include content in scheduled email reports.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-includecontentinscheduledreportsemail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExportToCsvInScheduledReports": { "MarkdownDocumentation": "`ExportToCsvInScheduledReports`\n\nThe ability to export to CSV files in scheduled email reports.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttocsvinscheduledreports", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateAndUpdateDataSources": { "MarkdownDocumentation": "`CreateAndUpdateDataSources`\n\nThe ability to create and update data sources.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-createandupdatedatasources", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ViewAccountSPICECapacity": { "MarkdownDocumentation": "`ViewAccountSPICECapacity`\n\nThe ability to view account SPICE capacity.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-viewaccountspicecapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dashboard": { "MarkdownDocumentation": "`Dashboard`\n\nThe ability to perform dashboard-related actions.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-dashboard", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExportToPdfInScheduledReports": { "MarkdownDocumentation": "`ExportToPdfInScheduledReports`\n\nThe ability to export to PDF files in scheduled email reports.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttopdfinscheduledreports", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateSPICEDataset": { "MarkdownDocumentation": "`CreateSPICEDataset`\n\nThe ability to create a SPICE dataset.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-createspicedataset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateAndUpdateDatasets": { "MarkdownDocumentation": "`CreateAndUpdateDatasets`\n\nThe ability to create and update datasets.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-createandupdatedatasets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrintReports": { "MarkdownDocumentation": "`PrintReports`\n\nThe ability to print reports.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-printreports", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ShareDatasets": { "MarkdownDocumentation": "`ShareDatasets`\n\nThe ability to share datasets.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-sharedatasets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExportToExcelInScheduledReports": { "MarkdownDocumentation": "`ExportToExcelInScheduledReports`\n\nThe ability to export to Excel files in scheduled email reports.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttoexcelinscheduledreports", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateAndUpdateDashboardEmailReports": { "MarkdownDocumentation": "`CreateAndUpdateDashboardEmailReports`\n\nThe ability to create and update email reports.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-createandupdatedashboardemailreports", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateAndUpdateThresholdAlerts": { "MarkdownDocumentation": "`CreateAndUpdateThresholdAlerts`\n\nThe ability to create and update threshold alerts.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-createandupdatethresholdalerts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateSharedFolders": { "MarkdownDocumentation": "`CreateSharedFolders`\n\nThe ability to create shared folders.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-createsharedfolders", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ShareDashboards": { "MarkdownDocumentation": "`ShareDashboards`\n\nThe ability to share dashboards.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-sharedashboards", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RenameSharedFolders": { "MarkdownDocumentation": "`RenameSharedFolders`\n\nThe ability to rename shared folders.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-renamesharedfolders", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AddOrRunAnomalyDetectionForAnalyses": { "MarkdownDocumentation": "`AddOrRunAnomalyDetectionForAnalyses`\n\nThe ability to add or run anomaly detection.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-addorrunanomalydetectionforanalyses", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ShareDataSources": { "MarkdownDocumentation": "`ShareDataSources`\n\nThe ability to share data sources.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-sharedatasources", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExportToExcel": { "MarkdownDocumentation": "`ExportToExcel`\n\nThe ability to export to Excel files from the UI.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttoexcel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExportToPdf": { "MarkdownDocumentation": "`ExportToPdf`\n\nThe ability to export to PDF files from the UI.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttopdf", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ShareAnalyses": { "MarkdownDocumentation": "`ShareAnalyses`\n\nThe ability to share analyses.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-shareanalyses", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubscribeDashboardEmailReports": { "MarkdownDocumentation": "`SubscribeDashboardEmailReports`\n\nThe ability to subscribe to email reports.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-subscribedashboardemailreports", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Analysis": { "MarkdownDocumentation": "`Analysis`\n\nThe ability to perform analysis-related actions.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-analysis", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExportToCsv": { "MarkdownDocumentation": "`ExportToCsv`\n\nThe ability to export to CSV files from the UI.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-exporttocsv", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateAndUpdateThemes": { "MarkdownDocumentation": "`CreateAndUpdateThemes`\n\nThe ability to export to Create and Update themes.\n*Required*: No\n*Type*: String\n*Allowed values*: `DENY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.html#cfn-quicksight-custompermissions-capabilities-createandupdatethemes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.AdHocFilteringOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AdHocFilteringOption`\n\nAn ad hoc (one-time) filtering option.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-adhocfilteringoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nAvailability status.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-adhocfilteringoption.html#cfn-quicksight-dashboard-adhocfilteringoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.AggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AggregationFunction`\n\nAn aggregation function aggregates values from a dimension or measure.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationfunction.html", "Properties": { "AttributeAggregationFunction": { "MarkdownDocumentation": "`AttributeAggregationFunction`\n\nAggregation for attributes.\n*Required*: No\n*Type*: [AttributeAggregationFunction](./aws-properties-quicksight-dashboard-attributeaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationfunction.html#cfn-quicksight-dashboard-aggregationfunction-attributeaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AttributeAggregationFunction" }, "DateAggregationFunction": { "MarkdownDocumentation": "`DateAggregationFunction`\n\nAggregation for date values.\n* `COUNT`: Aggregate by the total number of values, including duplicates.\n* `DISTINCT_COUNT`: Aggregate by the total number of distinct values.\n* `MIN`: Select the smallest date value.\n* `MAX`: Select the largest date value.\n*Required*: No\n*Type*: String\n*Allowed values*: `COUNT | DISTINCT_COUNT | MI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT", "MIN", "MAX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationfunction.html#cfn-quicksight-dashboard-aggregationfunction-dateaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumericalAggregationFunction": { "MarkdownDocumentation": "`NumericalAggregationFunction`\n\nAggregation for numerical values.\n*Required*: No\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-dashboard-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationfunction.html#cfn-quicksight-dashboard-aggregationfunction-numericalaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "NumericalAggregationFunction" }, "CategoricalAggregationFunction": { "MarkdownDocumentation": "`CategoricalAggregationFunction`\n\nAggregation for categorical values.\n* `COUNT`: Aggregate by the total number of values, including duplicates.\n* `DISTINCT_COUNT`: Aggregate by the total number of distinct values.\n*Required*: No\n*Type*: String\n*Allowed values*: `COUNT | DISTINCT_COUNT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationfunction.html#cfn-quicksight-dashboard-aggregationfunction-categoricalaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.AggregationSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AggregationSortConfiguration`\n\nThe configuration options to sort aggregated values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationsortconfiguration.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe function that aggregates the values in `Column`.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-dashboard-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationsortconfiguration.html#cfn-quicksight-dashboard-aggregationsortconfiguration-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "SortDirection": { "MarkdownDocumentation": "`SortDirection`\n\nThe sort direction of values.\n* `ASC`: Sort in ascending order.\n* `DESC`: Sort in descending order.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationsortconfiguration.html#cfn-quicksight-dashboard-aggregationsortconfiguration-sortdirection", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that determines the sort order of aggregated values.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationsortconfiguration.html#cfn-quicksight-dashboard-aggregationsortconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Dashboard.AnalysisDefaults": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AnalysisDefaults`\n\nThe configuration for default analysis settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-analysisdefaults.html", "Properties": { "DefaultNewSheetConfiguration": { "MarkdownDocumentation": "`DefaultNewSheetConfiguration`\n\nThe configuration for default new sheet settings.\n*Required*: Yes\n*Type*: [DefaultNewSheetConfiguration](./aws-properties-quicksight-dashboard-defaultnewsheetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-analysisdefaults.html#cfn-quicksight-dashboard-analysisdefaults-defaultnewsheetconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "DefaultNewSheetConfiguration" } } }, "AWS::QuickSight::Dashboard.AnchorDateConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AnchorDateConfiguration`\n\nThe date configuration of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-anchordateconfiguration.html", "Properties": { "AnchorOption": { "MarkdownDocumentation": "`AnchorOption`\n\nThe options for the date configuration. Choose one of the options below:\n* `NOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `NOW`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "NOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-anchordateconfiguration.html#cfn-quicksight-dashboard-anchordateconfiguration-anchoroption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe name of the parameter that is used for the anchor date configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-anchordateconfiguration.html#cfn-quicksight-dashboard-anchordateconfiguration-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ArcAxisConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ArcAxisConfiguration`\n\nThe arc axis configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcaxisconfiguration.html", "Properties": { "Range": { "MarkdownDocumentation": "`Range`\n\nThe arc axis range of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcAxisDisplayRange](./aws-properties-quicksight-dashboard-arcaxisdisplayrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcaxisconfiguration.html#cfn-quicksight-dashboard-arcaxisconfiguration-range", "UpdateType": "Mutable", "Required": false, "Type": "ArcAxisDisplayRange" }, "ReserveRange": { "MarkdownDocumentation": "`ReserveRange`\n\nThe reserved range of the arc axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcaxisconfiguration.html#cfn-quicksight-dashboard-arcaxisconfiguration-reserverange", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.ArcAxisDisplayRange": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ArcAxisDisplayRange`\n\nThe arc axis range of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcaxisdisplayrange.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum value of the arc axis range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcaxisdisplayrange.html#cfn-quicksight-dashboard-arcaxisdisplayrange-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum value of the arc axis range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcaxisdisplayrange.html#cfn-quicksight-dashboard-arcaxisdisplayrange-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.ArcConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ArcConfiguration`\n\nThe arc configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcconfiguration.html", "Properties": { "ArcAngle": { "MarkdownDocumentation": "`ArcAngle`\n\nThe option that determines the arc angle of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcconfiguration.html#cfn-quicksight-dashboard-arcconfiguration-arcangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ArcThickness": { "MarkdownDocumentation": "`ArcThickness`\n\nThe options that determine the arc thickness of a `GaugeChartVisual`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SMALL | MEDIUM | LARGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SMALL", "MEDIUM", "LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcconfiguration.html#cfn-quicksight-dashboard-arcconfiguration-arcthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ArcOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ArcOptions`\n\nThe options that determine the arc thickness of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcoptions.html", "Properties": { "ArcThickness": { "MarkdownDocumentation": "`ArcThickness`\n\nThe arc thickness of a `GaugeChartVisual`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SMALL | MEDIUM | LARGE | WH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SMALL", "MEDIUM", "LARGE", "WHOLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-arcoptions.html#cfn-quicksight-dashboard-arcoptions-arcthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.AssetOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AssetOptions`\n\nAn array of analysis level configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-assetoptions.html", "Properties": { "Timezone": { "MarkdownDocumentation": "`Timezone`\n\nDetermines the timezone for the analysis.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-assetoptions.html#cfn-quicksight-dashboard-assetoptions-timezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WeekStart": { "MarkdownDocumentation": "`WeekStart`\n\nDetermines the week start day for an analysis.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUNDAY | MONDAY | TUESDAY |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-assetoptions.html#cfn-quicksight-dashboard-assetoptions-weekstart", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "QBusinessInsightsStatus": { "MarkdownDocumentation": "`QBusinessInsightsStatus`\n\nDetermines whether insight summaries from Amazon Q Business are allowed in Dashboard Q&A.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-assetoptions.html#cfn-quicksight-dashboard-assetoptions-qbusinessinsightsstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExcludedDataSetArns": { "MarkdownDocumentation": "`ExcludedDataSetArns`\n\nA list of dataset ARNS to exclude from Dashboard Q&A.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-assetoptions.html#cfn-quicksight-dashboard-assetoptions-excludeddatasetarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.AttributeAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AttributeAggregationFunction`\n\nAggregation for attributes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-attributeaggregationfunction.html", "Properties": { "SimpleAttributeAggregation": { "MarkdownDocumentation": "`SimpleAttributeAggregation`\n\nThe built-in aggregation functions for attributes.\n* `UNIQUE_VALUE`: Returns the unique value for a field, aggregated by the dimension fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNIQUE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNIQUE_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-attributeaggregationfunction.html#cfn-quicksight-dashboard-attributeaggregationfunction-simpleattributeaggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueForMultipleValues": { "MarkdownDocumentation": "`ValueForMultipleValues`\n\nUsed by the `UNIQUE_VALUE` aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-attributeaggregationfunction.html#cfn-quicksight-dashboard-attributeaggregationfunction-valueformultiplevalues", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.AxisDataOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisDataOptions`\n\nThe data options for an axis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdataoptions.html", "Properties": { "DateAxisOptions": { "MarkdownDocumentation": "`DateAxisOptions`\n\nThe options for an axis with a date field.\n*Required*: No\n*Type*: [DateAxisOptions](./aws-properties-quicksight-dashboard-dateaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdataoptions.html#cfn-quicksight-dashboard-axisdataoptions-dateaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateAxisOptions" }, "NumericAxisOptions": { "MarkdownDocumentation": "`NumericAxisOptions`\n\nThe options for an axis with a numeric field.\n*Required*: No\n*Type*: [NumericAxisOptions](./aws-properties-quicksight-dashboard-numericaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdataoptions.html#cfn-quicksight-dashboard-axisdataoptions-numericaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "NumericAxisOptions" } } }, "AWS::QuickSight::Dashboard.AxisDisplayMinMaxRange": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisDisplayMinMaxRange`\n\nThe minimum and maximum setup for an axis display range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayminmaxrange.html", "Properties": { "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nThe minimum setup for an axis display range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayminmaxrange.html#cfn-quicksight-dashboard-axisdisplayminmaxrange-minimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Maximum": { "MarkdownDocumentation": "`Maximum`\n\nThe maximum setup for an axis display range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayminmaxrange.html#cfn-quicksight-dashboard-axisdisplayminmaxrange-maximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.AxisDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisDisplayOptions`\n\nThe display options for the axis label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayoptions.html", "Properties": { "DataOptions": { "MarkdownDocumentation": "`DataOptions`\n\nThe data options for an axis.\n*Required*: No\n*Type*: [AxisDataOptions](./aws-properties-quicksight-dashboard-axisdataoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-axisdisplayoptions-dataoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDataOptions" }, "TickLabelOptions": { "MarkdownDocumentation": "`TickLabelOptions`\n\nThe tick label options of an axis.\n*Required*: No\n*Type*: [AxisTickLabelOptions](./aws-properties-quicksight-dashboard-axisticklabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-axisdisplayoptions-ticklabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisTickLabelOptions" }, "AxisOffset": { "MarkdownDocumentation": "`AxisOffset`\n\nThe offset value that determines the starting placement of the axis within a visual's bounds.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-axisdisplayoptions-axisoffset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AxisLineVisibility": { "MarkdownDocumentation": "`AxisLineVisibility`\n\nDetermines whether or not the axis line is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-axisdisplayoptions-axislinevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GridLineVisibility": { "MarkdownDocumentation": "`GridLineVisibility`\n\nDetermines whether or not the grid line is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-axisdisplayoptions-gridlinevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScrollbarOptions": { "MarkdownDocumentation": "`ScrollbarOptions`\n\nThe scroll bar options for an axis.\n*Required*: No\n*Type*: [ScrollBarOptions](./aws-properties-quicksight-dashboard-scrollbaroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-axisdisplayoptions-scrollbaroptions", "UpdateType": "Mutable", "Required": false, "Type": "ScrollBarOptions" } } }, "AWS::QuickSight::Dashboard.AxisDisplayRange": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisDisplayRange`\n\nThe range setup of a numeric axis display range.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayrange.html", "Properties": { "DataDriven": { "MarkdownDocumentation": "`DataDriven`\n\nThe data-driven setup of an axis display range.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayrange.html#cfn-quicksight-dashboard-axisdisplayrange-datadriven", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MinMax": { "MarkdownDocumentation": "`MinMax`\n\nThe minimum and maximum setup of an axis display range.\n*Required*: No\n*Type*: [AxisDisplayMinMaxRange](./aws-properties-quicksight-dashboard-axisdisplayminmaxrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayrange.html#cfn-quicksight-dashboard-axisdisplayrange-minmax", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayMinMaxRange" } } }, "AWS::QuickSight::Dashboard.AxisLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisLabelOptions`\n\nThe label options for a chart axis. You must specify the field that the label is targeted to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislabeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe text for the axis label.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislabeloptions.html#cfn-quicksight-dashboard-axislabeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplyTo": { "MarkdownDocumentation": "`ApplyTo`\n\nThe options that indicate which field the label belongs to.\n*Required*: No\n*Type*: [AxisLabelReferenceOptions](./aws-properties-quicksight-dashboard-axislabelreferenceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislabeloptions.html#cfn-quicksight-dashboard-axislabeloptions-applyto", "UpdateType": "Mutable", "Required": false, "Type": "AxisLabelReferenceOptions" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the axis label.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislabeloptions.html#cfn-quicksight-dashboard-axislabeloptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Dashboard.AxisLabelReferenceOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisLabelReferenceOptions`\n\nThe reference that specifies where the axis label is applied to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislabelreferenceoptions.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the axis label is targeted to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislabelreferenceoptions.html#cfn-quicksight-dashboard-axislabelreferenceoptions-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field that the axis label is targeted to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislabelreferenceoptions.html#cfn-quicksight-dashboard-axislabelreferenceoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.AxisLinearScale": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisLinearScale`\n\nThe liner axis scale setup.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislinearscale.html", "Properties": { "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe step size setup of a linear axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislinearscale.html#cfn-quicksight-dashboard-axislinearscale-stepsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StepCount": { "MarkdownDocumentation": "`StepCount`\n\nThe step count setup of a linear axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislinearscale.html#cfn-quicksight-dashboard-axislinearscale-stepcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.AxisLogarithmicScale": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisLogarithmicScale`\n\nThe logarithmic axis scale setup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislogarithmicscale.html", "Properties": { "Base": { "MarkdownDocumentation": "`Base`\n\nThe base setup of a logarithmic axis scale.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axislogarithmicscale.html#cfn-quicksight-dashboard-axislogarithmicscale-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.AxisScale": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisScale`\n\nThe scale setup\noptions for a numeric axis display.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisscale.html", "Properties": { "Logarithmic": { "MarkdownDocumentation": "`Logarithmic`\n\nThe logarithmic axis scale setup.\n*Required*: No\n*Type*: [AxisLogarithmicScale](./aws-properties-quicksight-dashboard-axislogarithmicscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisscale.html#cfn-quicksight-dashboard-axisscale-logarithmic", "UpdateType": "Mutable", "Required": false, "Type": "AxisLogarithmicScale" }, "Linear": { "MarkdownDocumentation": "`Linear`\n\nThe linear axis scale setup.\n*Required*: No\n*Type*: [AxisLinearScale](./aws-properties-quicksight-dashboard-axislinearscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisscale.html#cfn-quicksight-dashboard-axisscale-linear", "UpdateType": "Mutable", "Required": false, "Type": "AxisLinearScale" } } }, "AWS::QuickSight::Dashboard.AxisTickLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.AxisTickLabelOptions`\n\nThe tick label options of an axis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisticklabeloptions.html", "Properties": { "RotationAngle": { "MarkdownDocumentation": "`RotationAngle`\n\nThe rotation angle of the axis tick labels.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisticklabeloptions.html#cfn-quicksight-dashboard-axisticklabeloptions-rotationangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "LabelOptions": { "MarkdownDocumentation": "`LabelOptions`\n\nDetermines whether or not the axis ticks are visible.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisticklabeloptions.html#cfn-quicksight-dashboard-axisticklabeloptions-labeloptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" } } }, "AWS::QuickSight::Dashboard.BarChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BarChartAggregatedFieldWells`\n\nThe aggregated field wells of a bar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category (y-axis) field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartaggregatedfieldwells.html#cfn-quicksight-dashboard-barchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color (group/color) field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartaggregatedfieldwells.html#cfn-quicksight-dashboard-barchartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a bar chart. Values are aggregated by\ncategory.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartaggregatedfieldwells.html#cfn-quicksight-dashboard-barchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartaggregatedfieldwells.html#cfn-quicksight-dashboard-barchartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.BarChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BarChartConfiguration`\n\nThe configuration of a `BarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `BarChartVisual`.\n*Required*: No\n*Type*: [BarChartSortConfiguration](./aws-properties-quicksight-dashboard-barchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BarChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-dashboard-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a bar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-dashboard-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "Orientation": { "MarkdownDocumentation": "`Orientation`\n\nThe orientation of the bars in a bar chart visual. There are two valid values in this structure:\n* `HORIZONTAL`: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.\n* `VERTICAL`: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.\n*Required*: No\n*Type*: String\n*Allowed values*: `HORIZONTAL | VERTICAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HORIZONTAL", "VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-orientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a bar chart value.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "BarsArrangement": { "MarkdownDocumentation": "`BarsArrangement`\n\nDetermines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLUSTERED | STACKED | STACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLUSTERED", "STACKED", "STACKED_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-barsarrangement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe label display options (grid line, range, scale, axis step) for bar chart category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe contribution analysis (anomaly configuration) setup of the visual.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-dashboard-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [BarChartFieldWells](./aws-properties-quicksight-dashboard-barchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BarChartFieldWells" }, "ValueAxis": { "MarkdownDocumentation": "`ValueAxis`\n\nThe label display options (grid line, range, scale, axis step) for a bar chart value.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-valueaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Dashboard.BarChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BarChartFieldWells`\n\nThe field wells of a `BarChartVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartfieldwells.html", "Properties": { "BarChartAggregatedFieldWells": { "MarkdownDocumentation": "`BarChartAggregatedFieldWells`\n\nThe aggregated field wells of a bar chart.\n*Required*: No\n*Type*: [BarChartAggregatedFieldWells](./aws-properties-quicksight-dashboard-barchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartfieldwells.html#cfn-quicksight-dashboard-barchartfieldwells-barchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BarChartAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.BarChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BarChartSortConfiguration`\n\nsort-configuration-description\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartsortconfiguration.html", "Properties": { "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-barchartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe sort configuration of color fields in a bar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-barchartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe limit on the number of values displayed in a bar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-barchartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories displayed in a bar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-barchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-barchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-barchartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Dashboard.BarChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BarChartVisual`\n\nA bar chart.\nThe `BarChartVisual` structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:\n* Horizontal bar chart\n* Vertical bar chart\n* Horizontal stacked bar chart\n* Vertical stacked bar chart\n* Horizontal stacked 100% bar chart\n* Vertical stacked 100% bar chart\nFor more information, see [Using bar charts](https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [BarChartConfiguration](./aws-properties-quicksight-dashboard-barchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BarChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.BinCountOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BinCountOptions`\n\nThe options that determine the bin count of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bincountoptions.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe options that determine the bin count value.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bincountoptions.html#cfn-quicksight-dashboard-bincountoptions-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.BinWidthOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BinWidthOptions`\n\nThe options that determine the bin width of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-binwidthoptions.html", "Properties": { "BinCountLimit": { "MarkdownDocumentation": "`BinCountLimit`\n\nThe options that determine the bin count limit.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-binwidthoptions.html#cfn-quicksight-dashboard-binwidthoptions-bincountlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe options that determine the bin width value.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-binwidthoptions.html#cfn-quicksight-dashboard-binwidthoptions-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.BodySectionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BodySectionConfiguration`\n\nThe configuration of a body section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionconfiguration.html", "Properties": { "Content": { "MarkdownDocumentation": "`Content`\n\nThe configuration of content in a body section.\n*Required*: Yes\n*Type*: [BodySectionContent](./aws-properties-quicksight-dashboard-bodysectioncontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionconfiguration.html#cfn-quicksight-dashboard-bodysectionconfiguration-content", "UpdateType": "Mutable", "Required": true, "Type": "BodySectionContent" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style options of a body section.\n*Required*: No\n*Type*: [SectionStyle](./aws-properties-quicksight-dashboard-sectionstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionconfiguration.html#cfn-quicksight-dashboard-bodysectionconfiguration-style", "UpdateType": "Mutable", "Required": false, "Type": "SectionStyle" }, "PageBreakConfiguration": { "MarkdownDocumentation": "`PageBreakConfiguration`\n\nThe configuration of a page break for a section.\n*Required*: No\n*Type*: [SectionPageBreakConfiguration](./aws-properties-quicksight-dashboard-sectionpagebreakconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionconfiguration.html#cfn-quicksight-dashboard-bodysectionconfiguration-pagebreakconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SectionPageBreakConfiguration" }, "SectionId": { "MarkdownDocumentation": "`SectionId`\n\nThe unique identifier of a body section.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionconfiguration.html#cfn-quicksight-dashboard-bodysectionconfiguration-sectionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RepeatConfiguration": { "MarkdownDocumentation": "`RepeatConfiguration`\n\nDescribes the configurations that are required to declare a section as repeating.\n*Required*: No\n*Type*: [BodySectionRepeatConfiguration](./aws-properties-quicksight-dashboard-bodysectionrepeatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionconfiguration.html#cfn-quicksight-dashboard-bodysectionconfiguration-repeatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionRepeatConfiguration" } } }, "AWS::QuickSight::Dashboard.BodySectionContent": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BodySectionContent`\n\nThe configuration of content in a body section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectioncontent.html", "Properties": { "Layout": { "MarkdownDocumentation": "`Layout`\n\nThe layout configuration of a body section.\n*Required*: No\n*Type*: [SectionLayoutConfiguration](./aws-properties-quicksight-dashboard-sectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectioncontent.html#cfn-quicksight-dashboard-bodysectioncontent-layout", "UpdateType": "Mutable", "Required": false, "Type": "SectionLayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.BodySectionDynamicCategoryDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BodySectionDynamicCategoryDimensionConfiguration`\n\nDescribes the **Category** dataset column and constraints for the dynamic values used to repeat the contents of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectiondynamiccategorydimensionconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-dashboard-bodysectiondynamiccategorydimensionconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "SortByMetrics": { "MarkdownDocumentation": "`SortByMetrics`\n\nSort criteria on the column values that you use for repetition.\n*Required*: No\n*Type*: Array of [ColumnSort](./aws-properties-quicksight-dashboard-columnsort.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-dashboard-bodysectiondynamiccategorydimensionconfiguration-sortbymetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSort", "DuplicatesAllowed": true }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nNumber of values to use from the column for repetition.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-dashboard-bodysectiondynamiccategorydimensionconfiguration-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.BodySectionDynamicNumericDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BodySectionDynamicNumericDimensionConfiguration`\n\nDescribes the **Numeric** dataset column and constraints for the dynamic values used to repeat the contents of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectiondynamicnumericdimensionconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-dashboard-bodysectiondynamicnumericdimensionconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "SortByMetrics": { "MarkdownDocumentation": "`SortByMetrics`\n\nSort criteria on the column values that you use for repetition.\n*Required*: No\n*Type*: Array of [ColumnSort](./aws-properties-quicksight-dashboard-columnsort.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-dashboard-bodysectiondynamicnumericdimensionconfiguration-sortbymetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSort", "DuplicatesAllowed": true }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nNumber of values to use from the column for repetition.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-dashboard-bodysectiondynamicnumericdimensionconfiguration-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.BodySectionRepeatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BodySectionRepeatConfiguration`\n\nDescribes the configurations that are required to declare a section as repeating.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatconfiguration.html", "Properties": { "DimensionConfigurations": { "MarkdownDocumentation": "`DimensionConfigurations`\n\nList of `BodySectionRepeatDimensionConfiguration` values that describe the dataset column and constraints for the column used to repeat the contents of a section.\n*Required*: No\n*Type*: Array of [BodySectionRepeatDimensionConfiguration](./aws-properties-quicksight-dashboard-bodysectionrepeatdimensionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatconfiguration.html#cfn-quicksight-dashboard-bodysectionrepeatconfiguration-dimensionconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BodySectionRepeatDimensionConfiguration", "DuplicatesAllowed": true }, "NonRepeatingVisuals": { "MarkdownDocumentation": "`NonRepeatingVisuals`\n\nList of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatconfiguration.html#cfn-quicksight-dashboard-bodysectionrepeatconfiguration-nonrepeatingvisuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PageBreakConfiguration": { "MarkdownDocumentation": "`PageBreakConfiguration`\n\nPage break configuration to apply for each repeating instance.\n*Required*: No\n*Type*: [BodySectionRepeatPageBreakConfiguration](./aws-properties-quicksight-dashboard-bodysectionrepeatpagebreakconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatconfiguration.html#cfn-quicksight-dashboard-bodysectionrepeatconfiguration-pagebreakconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionRepeatPageBreakConfiguration" } } }, "AWS::QuickSight::Dashboard.BodySectionRepeatDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BodySectionRepeatDimensionConfiguration`\n\nDescribes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either **Category** or **Numeric** column configuration\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatdimensionconfiguration.html", "Properties": { "DynamicNumericDimensionConfiguration": { "MarkdownDocumentation": "`DynamicNumericDimensionConfiguration`\n\nDescribes the **Numeric** dataset column and constraints around the dynamic values used to repeat the contents of a section.\n*Required*: No\n*Type*: [BodySectionDynamicNumericDimensionConfiguration](./aws-properties-quicksight-dashboard-bodysectiondynamicnumericdimensionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatdimensionconfiguration.html#cfn-quicksight-dashboard-bodysectionrepeatdimensionconfiguration-dynamicnumericdimensionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionDynamicNumericDimensionConfiguration" }, "DynamicCategoryDimensionConfiguration": { "MarkdownDocumentation": "`DynamicCategoryDimensionConfiguration`\n\nDescribes the **Category** dataset column and constraints around the dynamic values that will be used in repeating the section contents.\n*Required*: No\n*Type*: [BodySectionDynamicCategoryDimensionConfiguration](./aws-properties-quicksight-dashboard-bodysectiondynamiccategorydimensionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatdimensionconfiguration.html#cfn-quicksight-dashboard-bodysectionrepeatdimensionconfiguration-dynamiccategorydimensionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionDynamicCategoryDimensionConfiguration" } } }, "AWS::QuickSight::Dashboard.BodySectionRepeatPageBreakConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BodySectionRepeatPageBreakConfiguration`\n\nThe page break configuration to apply for each repeating instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatpagebreakconfiguration.html", "Properties": { "After": { "MarkdownDocumentation": "`After`\n\nProperty description not available.\n*Required*: No\n*Type*: [SectionAfterPageBreak](./aws-properties-quicksight-dashboard-sectionafterpagebreak.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-bodysectionrepeatpagebreakconfiguration.html#cfn-quicksight-dashboard-bodysectionrepeatpagebreakconfiguration-after", "UpdateType": "Mutable", "Required": false, "Type": "SectionAfterPageBreak" } } }, "AWS::QuickSight::Dashboard.BoxPlotAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BoxPlotAggregatedFieldWells`\n\nThe aggregated field well for a box plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well of a box plot chart. Values are grouped based on group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotaggregatedfieldwells.html#cfn-quicksight-dashboard-boxplotaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field well of a box plot chart. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotaggregatedfieldwells.html#cfn-quicksight-dashboard-boxplotaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.BoxPlotChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BoxPlotChartConfiguration`\n\nThe configuration of a `BoxPlotVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `BoxPlotVisual`.\n*Required*: No\n*Type*: [BoxPlotSortConfiguration](./aws-properties-quicksight-dashboard-boxplotsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nProperty description not available.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-dashboard-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe label display options (grid line, range, scale, axis step) of a box plot category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) of a box plot value.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility and sort Icon visibility) of a box plot category.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [BoxPlotFieldWells](./aws-properties-quicksight-dashboard-boxplotfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "BoxPlotOptions": { "MarkdownDocumentation": "`BoxPlotOptions`\n\nThe box plot chart options for a box plot visual\n*Required*: No\n*Type*: [BoxPlotOptions](./aws-properties-quicksight-dashboard-boxplotoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-boxplotoptions", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, axis step) of a box plot category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Dashboard.BoxPlotFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BoxPlotFieldWells`\n\nThe field wells of a `BoxPlotVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotfieldwells.html", "Properties": { "BoxPlotAggregatedFieldWells": { "MarkdownDocumentation": "`BoxPlotAggregatedFieldWells`\n\nThe aggregated field wells of a box plot.\n*Required*: No\n*Type*: [BoxPlotAggregatedFieldWells](./aws-properties-quicksight-dashboard-boxplotaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotfieldwells.html#cfn-quicksight-dashboard-boxplotfieldwells-boxplotaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.BoxPlotOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BoxPlotOptions`\n\nThe options of a box plot visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotoptions.html", "Properties": { "StyleOptions": { "MarkdownDocumentation": "`StyleOptions`\n\nThe style options of the box plot.\n*Required*: No\n*Type*: [BoxPlotStyleOptions](./aws-properties-quicksight-dashboard-boxplotstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotoptions.html#cfn-quicksight-dashboard-boxplotoptions-styleoptions", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotStyleOptions" }, "OutlierVisibility": { "MarkdownDocumentation": "`OutlierVisibility`\n\nDetermines the visibility of the outlier in a box plot.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotoptions.html#cfn-quicksight-dashboard-boxplotoptions-outliervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllDataPointsVisibility": { "MarkdownDocumentation": "`AllDataPointsVisibility`\n\nDetermines the visibility of all data points of the box plot.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotoptions.html#cfn-quicksight-dashboard-boxplotoptions-alldatapointsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.BoxPlotSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BoxPlotSortConfiguration`\n\nThe sort configuration of a `BoxPlotVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotsortconfiguration.html", "Properties": { "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of a group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotsortconfiguration.html#cfn-quicksight-dashboard-boxplotsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "PaginationConfiguration": { "MarkdownDocumentation": "`PaginationConfiguration`\n\nThe pagination configuration of a table visual or box plot.\n*Required*: No\n*Type*: [PaginationConfiguration](./aws-properties-quicksight-dashboard-paginationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotsortconfiguration.html#cfn-quicksight-dashboard-boxplotsortconfiguration-paginationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PaginationConfiguration" } } }, "AWS::QuickSight::Dashboard.BoxPlotStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BoxPlotStyleOptions`\n\nThe style options of the box plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotstyleoptions.html", "Properties": { "FillStyle": { "MarkdownDocumentation": "`FillStyle`\n\nThe fill styles (solid, transparent) of the box plot.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | TRANSPARENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "TRANSPARENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotstyleoptions.html#cfn-quicksight-dashboard-boxplotstyleoptions-fillstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.BoxPlotVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.BoxPlotVisual`\n\nA box plot.\nFor more information, see [Using box plots](https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [BoxPlotChartConfiguration](./aws-properties-quicksight-dashboard-boxplotchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.CalculatedField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CalculatedField`\n\nThe calculated field of an analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-calculatedfield.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the calculated field.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-calculatedfield.html#cfn-quicksight-dashboard-calculatedfield-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in this calculated field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-calculatedfield.html#cfn-quicksight-dashboard-calculatedfield-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the calculated field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-calculatedfield.html#cfn-quicksight-dashboard-calculatedfield-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CalculatedMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CalculatedMeasureField`\n\nThe table calculation measure field for pivot tables.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-calculatedmeasurefield.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression in the table calculation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-calculatedmeasurefield.html#cfn-quicksight-dashboard-calculatedmeasurefield-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-calculatedmeasurefield.html#cfn-quicksight-dashboard-calculatedmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CascadingControlConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-cascadingcontrolconfiguration.html", "Properties": { "SourceControls": { "MarkdownDocumentation": "`SourceControls`\n\nA list of source controls that determine the values that are used in the current control.\n*Required*: No\n*Type*: Array of [CascadingControlSource](./aws-properties-quicksight-dashboard-cascadingcontrolsource.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-cascadingcontrolconfiguration.html#cfn-quicksight-dashboard-cascadingcontrolconfiguration-sourcecontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CascadingControlSource", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.CascadingControlSource": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CascadingControlSource`\n\nThe source controls that are used in a `CascadingControlConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-cascadingcontrolsource.html", "Properties": { "SourceSheetControlId": { "MarkdownDocumentation": "`SourceSheetControlId`\n\nThe source sheet control ID of a `CascadingControlSource`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-cascadingcontrolsource.html#cfn-quicksight-dashboard-cascadingcontrolsource-sourcesheetcontrolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnToMatch": { "MarkdownDocumentation": "`ColumnToMatch`\n\nThe column identifier that determines which column to look up for the source sheet control.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-cascadingcontrolsource.html#cfn-quicksight-dashboard-cascadingcontrolsource-columntomatch", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Dashboard.CategoricalDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CategoricalDimensionField`\n\nThe dimension type field with categorical type columns..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html#cfn-quicksight-dashboard-categoricaldimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-dashboard-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html#cfn-quicksight-dashboard-categoricaldimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `CategoricalDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html#cfn-quicksight-dashboard-categoricaldimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricaldimensionfield.html#cfn-quicksight-dashboard-categoricaldimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CategoricalMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CategoricalMeasureField`\n\nThe measure type field with categorical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricalmeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [String](./aws-properties-quicksight-dashboard-aggregationfunction.html)\n*Allowed values*: `COUNT | DISTINCT_COUNT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricalmeasurefield.html#cfn-quicksight-dashboard-categoricalmeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-dashboard-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricalmeasurefield.html#cfn-quicksight-dashboard-categoricalmeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `CategoricalMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricalmeasurefield.html#cfn-quicksight-dashboard-categoricalmeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoricalmeasurefield.html#cfn-quicksight-dashboard-categoricalmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CategoryDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CategoryDrillDownFilter`\n\nThe category drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categorydrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categorydrilldownfilter.html#cfn-quicksight-dashboard-categorydrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nA list of the string inputs that are the values of the category drill down filter.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categorydrilldownfilter.html#cfn-quicksight-dashboard-categorydrilldownfilter-categoryvalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.CategoryFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CategoryFilter`\n\nA `CategoryFilter` filters text values.\nFor more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilter.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration for a `CategoryFilter`.\n*Required*: Yes\n*Type*: [CategoryFilterConfiguration](./aws-properties-quicksight-dashboard-categoryfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilter.html#cfn-quicksight-dashboard-categoryfilter-configuration", "UpdateType": "Mutable", "Required": true, "Type": "CategoryFilterConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilter.html#cfn-quicksight-dashboard-categoryfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilter.html#cfn-quicksight-dashboard-categoryfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilter.html#cfn-quicksight-dashboard-categoryfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CategoryFilterConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CategoryFilterConfiguration`\n\nThe configuration for a `CategoryFilter`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilterconfiguration.html", "Properties": { "CustomFilterListConfiguration": { "MarkdownDocumentation": "`CustomFilterListConfiguration`\n\nA list of custom filter values. In the Quick Sight console, this filter type is called a custom filter list.\n*Required*: No\n*Type*: [CustomFilterListConfiguration](./aws-properties-quicksight-dashboard-customfilterlistconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilterconfiguration.html#cfn-quicksight-dashboard-categoryfilterconfiguration-customfilterlistconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomFilterListConfiguration" }, "CustomFilterConfiguration": { "MarkdownDocumentation": "`CustomFilterConfiguration`\n\nA custom filter that filters based on a single value. This filter can be partially matched.\n*Required*: No\n*Type*: [CustomFilterConfiguration](./aws-properties-quicksight-dashboard-customfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilterconfiguration.html#cfn-quicksight-dashboard-categoryfilterconfiguration-customfilterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomFilterConfiguration" }, "FilterListConfiguration": { "MarkdownDocumentation": "`FilterListConfiguration`\n\nA list of filter configurations. In the Quick Sight console, this filter type is called a filter list.\n*Required*: No\n*Type*: [FilterListConfiguration](./aws-properties-quicksight-dashboard-filterlistconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilterconfiguration.html#cfn-quicksight-dashboard-categoryfilterconfiguration-filterlistconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilterListConfiguration" } } }, "AWS::QuickSight::Dashboard.CategoryInnerFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CategoryInnerFilter`\n\nA `CategoryInnerFilter` filters text values for the `NestedFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryinnerfilter.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [CategoryFilterConfiguration](./aws-properties-quicksight-dashboard-categoryfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryinnerfilter.html#cfn-quicksight-dashboard-categoryinnerfilter-configuration", "UpdateType": "Mutable", "Required": true, "Type": "CategoryFilterConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryinnerfilter.html#cfn-quicksight-dashboard-categoryinnerfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryinnerfilter.html#cfn-quicksight-dashboard-categoryinnerfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" } } }, "AWS::QuickSight::Dashboard.ChartAxisLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ChartAxisLabelOptions`\n\nThe label options for an axis on a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-chartaxislabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of an axis label on a chart. Choose one of the following options:\n* `VISIBLE`: Shows the axis.\n* `HIDDEN`: Hides the axis.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-chartaxislabeloptions.html#cfn-quicksight-dashboard-chartaxislabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SortIconVisibility": { "MarkdownDocumentation": "`SortIconVisibility`\n\nThe visibility configuration of the sort icon on a chart's axis label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-chartaxislabeloptions.html#cfn-quicksight-dashboard-chartaxislabeloptions-sorticonvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AxisLabelOptions": { "MarkdownDocumentation": "`AxisLabelOptions`\n\nThe label options for a chart axis.\n*Required*: No\n*Type*: [Array](./aws-properties-quicksight-dashboard-axislabeloptions.html) of [AxisLabelOptions](./aws-properties-quicksight-dashboard-axislabeloptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-chartaxislabeloptions.html#cfn-quicksight-dashboard-chartaxislabeloptions-axislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AxisLabelOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ClusterMarker": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ClusterMarker`\n\nThe cluster marker that is a part of the cluster marker\nconfiguration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-clustermarker.html", "Properties": { "SimpleClusterMarker": { "MarkdownDocumentation": "`SimpleClusterMarker`\n\nThe simple cluster marker of the cluster marker.\n*Required*: No\n*Type*: [SimpleClusterMarker](./aws-properties-quicksight-dashboard-simpleclustermarker.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-clustermarker.html#cfn-quicksight-dashboard-clustermarker-simpleclustermarker", "UpdateType": "Mutable", "Required": false, "Type": "SimpleClusterMarker" } } }, "AWS::QuickSight::Dashboard.ClusterMarkerConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ClusterMarkerConfiguration`\n\nThe cluster marker configuration of the geospatial map selected point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-clustermarkerconfiguration.html", "Properties": { "ClusterMarker": { "MarkdownDocumentation": "`ClusterMarker`\n\nThe cluster marker that is a part of the cluster marker configuration.\n*Required*: No\n*Type*: [ClusterMarker](./aws-properties-quicksight-dashboard-clustermarker.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-clustermarkerconfiguration.html#cfn-quicksight-dashboard-clustermarkerconfiguration-clustermarker", "UpdateType": "Mutable", "Required": false, "Type": "ClusterMarker" } } }, "AWS::QuickSight::Dashboard.ColorScale": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ColorScale`\n\nDetermines the color scale that is applied to the visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-colorscale.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nDetermines the list of colors that are applied to the visual.\n*Required*: Yes\n*Type*: Array of [DataColor](./aws-properties-quicksight-dashboard-datacolor.html)\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-colorscale.html#cfn-quicksight-dashboard-colorscale-colors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataColor", "DuplicatesAllowed": true }, "ColorFillType": { "MarkdownDocumentation": "`ColorFillType`\n\nDetermines the color fill type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DISCRETE | GRADIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISCRETE", "GRADIENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-colorscale.html#cfn-quicksight-dashboard-colorscale-colorfilltype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NullValueColor": { "MarkdownDocumentation": "`NullValueColor`\n\nDetermines the color that is applied to null values.\n*Required*: No\n*Type*: [DataColor](./aws-properties-quicksight-dashboard-datacolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-colorscale.html#cfn-quicksight-dashboard-colorscale-nullvaluecolor", "UpdateType": "Mutable", "Required": false, "Type": "DataColor" } } }, "AWS::QuickSight::Dashboard.ColorsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ColorsConfiguration`\n\nThe color configurations for a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-colorsconfiguration.html", "Properties": { "CustomColors": { "MarkdownDocumentation": "`CustomColors`\n\nA list of up to 50 custom colors.\n*Required*: No\n*Type*: Array of [CustomColor](./aws-properties-quicksight-dashboard-customcolor.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-colorsconfiguration.html#cfn-quicksight-dashboard-colorsconfiguration-customcolors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ColumnConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ColumnConfiguration`\n\nThe general configuration of a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnconfiguration.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe role of the column.\n*Required*: No\n*Type*: String\n*Allowed values*: `DIMENSION | MEASURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIMENSION", "MEASURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnconfiguration.html#cfn-quicksight-dashboard-columnconfiguration-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of a column.\n*Required*: No\n*Type*: [FormatConfiguration](./aws-properties-quicksight-dashboard-formatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnconfiguration.html#cfn-quicksight-dashboard-columnconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnconfiguration.html#cfn-quicksight-dashboard-columnconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "ColorsConfiguration": { "MarkdownDocumentation": "`ColorsConfiguration`\n\nThe color configurations of the column.\n*Required*: No\n*Type*: [ColorsConfiguration](./aws-properties-quicksight-dashboard-colorsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnconfiguration.html#cfn-quicksight-dashboard-columnconfiguration-colorsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ColorsConfiguration" } } }, "AWS::QuickSight::Dashboard.ColumnHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ColumnHierarchy`\n\nThe option that determines the hierarchy of the fields for a visual element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnhierarchy.html", "Properties": { "DateTimeHierarchy": { "MarkdownDocumentation": "`DateTimeHierarchy`\n\nThe option that determines the hierarchy of any `DateTime` fields.\n*Required*: No\n*Type*: [DateTimeHierarchy](./aws-properties-quicksight-dashboard-datetimehierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnhierarchy.html#cfn-quicksight-dashboard-columnhierarchy-datetimehierarchy", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeHierarchy" }, "ExplicitHierarchy": { "MarkdownDocumentation": "`ExplicitHierarchy`\n\nThe option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.\n*Required*: No\n*Type*: [ExplicitHierarchy](./aws-properties-quicksight-dashboard-explicithierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnhierarchy.html#cfn-quicksight-dashboard-columnhierarchy-explicithierarchy", "UpdateType": "Mutable", "Required": false, "Type": "ExplicitHierarchy" }, "PredefinedHierarchy": { "MarkdownDocumentation": "`PredefinedHierarchy`\n\nThe option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.\n*Required*: No\n*Type*: [PredefinedHierarchy](./aws-properties-quicksight-dashboard-predefinedhierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnhierarchy.html#cfn-quicksight-dashboard-columnhierarchy-predefinedhierarchy", "UpdateType": "Mutable", "Required": false, "Type": "PredefinedHierarchy" } } }, "AWS::QuickSight::Dashboard.ColumnIdentifier": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ColumnIdentifier`\n\nA column of a data set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnidentifier.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnidentifier.html#cfn-quicksight-dashboard-columnidentifier-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that the column belongs to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnidentifier.html#cfn-quicksight-dashboard-columnidentifier-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ColumnSort": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ColumnSort`\n\nThe sort configuration for a column that is not used in a field well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnsort.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function that is defined in the column sort.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-dashboard-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnsort.html#cfn-quicksight-dashboard-columnsort-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "SortBy": { "MarkdownDocumentation": "`SortBy`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnsort.html#cfn-quicksight-dashboard-columnsort-sortby", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe sort direction.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnsort.html#cfn-quicksight-dashboard-columnsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ColumnTooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ColumnTooltipItem`\n\nThe tooltip item for the columns that are not part of a field well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columntooltipitem.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nThe aggregation function of the column tooltip item.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-dashboard-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columntooltipitem.html#cfn-quicksight-dashboard-columntooltipitem-aggregation", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "TooltipTarget": { "MarkdownDocumentation": "`TooltipTarget`\n\nDetermines the target of the column tooltip item in a combo chart visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `BOTH | BAR | LINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BOTH", "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columntooltipitem.html#cfn-quicksight-dashboard-columntooltipitem-tooltiptarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe target column of the tooltip item.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columntooltipitem.html#cfn-quicksight-dashboard-columntooltipitem-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label of the tooltip item.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columntooltipitem.html#cfn-quicksight-dashboard-columntooltipitem-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip item.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columntooltipitem.html#cfn-quicksight-dashboard-columntooltipitem-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ComboChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ComboChartAggregatedFieldWells`\n\nThe aggregated field wells of a combo chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartaggregatedfieldwells.html", "Properties": { "BarValues": { "MarkdownDocumentation": "`BarValues`\n\nThe aggregated `BarValues` field well of a combo chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartaggregatedfieldwells.html#cfn-quicksight-dashboard-combochartaggregatedfieldwells-barvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe aggregated category field wells of a combo chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartaggregatedfieldwells.html#cfn-quicksight-dashboard-combochartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe aggregated colors field well of a combo chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartaggregatedfieldwells.html#cfn-quicksight-dashboard-combochartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "LineValues": { "MarkdownDocumentation": "`LineValues`\n\nThe aggregated `LineValues` field well of a combo chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartaggregatedfieldwells.html#cfn-quicksight-dashboard-combochartaggregatedfieldwells-linevalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ComboChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ComboChartConfiguration`\n\nThe configuration of a `ComboChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `ComboChartVisual`.\n*Required*: No\n*Type*: [ComboChartSortConfiguration](./aws-properties-quicksight-dashboard-combochartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-dashboard-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "BarDataLabels": { "MarkdownDocumentation": "`BarDataLabels`\n\nThe options that determine if visual data labels are displayed.\nThe data label options for a bar in a combo chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-bardatalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SingleAxisOptions": { "MarkdownDocumentation": "`SingleAxisOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [SingleAxisOptions](./aws-properties-quicksight-dashboard-singleaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-singleaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "SingleAxisOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "BarsArrangement": { "MarkdownDocumentation": "`BarsArrangement`\n\nDetermines the bar arrangement in a combo chart. The following are valid values in this structure:\n* `CLUSTERED`: For clustered bar combo charts.\n* `STACKED`: For stacked bar combo charts.\n* `STACKED_PERCENT`: Do not use. If you use this value, the operation returns a validation error.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLUSTERED | STACKED | STACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLUSTERED", "STACKED", "STACKED_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-barsarrangement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecondaryYAxisLabelOptions": { "MarkdownDocumentation": "`SecondaryYAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-secondaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "LineDataLabels": { "MarkdownDocumentation": "`LineDataLabels`\n\nThe options that determine if visual data labels are displayed.\nThe data label options for a line in a combo chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-linedatalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe category axis of a combo chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [ComboChartFieldWells](./aws-properties-quicksight-dashboard-combochartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartFieldWells" }, "SecondaryYAxisDisplayOptions": { "MarkdownDocumentation": "`SecondaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-secondaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Dashboard.ComboChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ComboChartFieldWells`\n\nThe field wells of the visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartfieldwells.html", "Properties": { "ComboChartAggregatedFieldWells": { "MarkdownDocumentation": "`ComboChartAggregatedFieldWells`\n\nThe aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.\n*Required*: No\n*Type*: [ComboChartAggregatedFieldWells](./aws-properties-quicksight-dashboard-combochartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartfieldwells.html#cfn-quicksight-dashboard-combochartfieldwells-combochartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.ComboChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ComboChartSortConfiguration`\n\nThe sort configuration of a `ComboChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartsortconfiguration.html", "Properties": { "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe sort configuration of the color field well in a combo chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartsortconfiguration.html#cfn-quicksight-dashboard-combochartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe item limit configuration of the color field well in a combo chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartsortconfiguration.html#cfn-quicksight-dashboard-combochartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe item limit configuration for the category field well of a combo chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartsortconfiguration.html#cfn-quicksight-dashboard-combochartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category field well in a combo chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartsortconfiguration.html#cfn-quicksight-dashboard-combochartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ComboChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ComboChartVisual`\n\nA combo chart.\nThe `ComboChartVisual` includes stacked bar combo charts and clustered bar combo charts\nFor more information, see [Using combo charts](https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [ComboChartConfiguration](./aws-properties-quicksight-dashboard-combochartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ComparisonConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ComparisonConfiguration`\n\nThe comparison display configuration of a KPI or gauge chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-comparisonconfiguration.html", "Properties": { "ComparisonMethod": { "MarkdownDocumentation": "`ComparisonMethod`\n\nThe method of the comparison. Choose from the following options:\n* `DIFFERENCE`\n* `PERCENT_DIFFERENCE`\n* `PERCENT`\n*Required*: No\n*Type*: String\n*Allowed values*: `DIFFERENCE | PERCENT_DIFFER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIFFERENCE", "PERCENT_DIFFERENCE", "PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-comparisonconfiguration.html#cfn-quicksight-dashboard-comparisonconfiguration-comparisonmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComparisonFormat": { "MarkdownDocumentation": "`ComparisonFormat`\n\nThe format of the comparison.\n*Required*: No\n*Type*: [ComparisonFormatConfiguration](./aws-properties-quicksight-dashboard-comparisonformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-comparisonconfiguration.html#cfn-quicksight-dashboard-comparisonconfiguration-comparisonformat", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonFormatConfiguration" } } }, "AWS::QuickSight::Dashboard.ComparisonFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ComparisonFormatConfiguration`\n\nThe format of the comparison.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-comparisonformatconfiguration.html", "Properties": { "NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`NumberDisplayFormatConfiguration`\n\nThe number display format.\n*Required*: No\n*Type*: [NumberDisplayFormatConfiguration](./aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-comparisonformatconfiguration.html#cfn-quicksight-dashboard-comparisonformatconfiguration-numberdisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberDisplayFormatConfiguration" }, "PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`PercentageDisplayFormatConfiguration`\n\nThe percentage display format.\n*Required*: No\n*Type*: [PercentageDisplayFormatConfiguration](./aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-comparisonformatconfiguration.html#cfn-quicksight-dashboard-comparisonformatconfiguration-percentagedisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PercentageDisplayFormatConfiguration" } } }, "AWS::QuickSight::Dashboard.Computation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.Computation`\n\nThe computation union that is used in an insight visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html", "Properties": { "PeriodToDate": { "MarkdownDocumentation": "`PeriodToDate`\n\nThe period to `DataSetIdentifier` computation configuration.\n*Required*: No\n*Type*: [PeriodToDateComputation](./aws-properties-quicksight-dashboard-periodtodatecomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-periodtodate", "UpdateType": "Mutable", "Required": false, "Type": "PeriodToDateComputation" }, "GrowthRate": { "MarkdownDocumentation": "`GrowthRate`\n\nThe growth rate computation configuration.\n*Required*: No\n*Type*: [GrowthRateComputation](./aws-properties-quicksight-dashboard-growthratecomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-growthrate", "UpdateType": "Mutable", "Required": false, "Type": "GrowthRateComputation" }, "TopBottomRanked": { "MarkdownDocumentation": "`TopBottomRanked`\n\nThe top ranked and bottom ranked computation configuration.\n*Required*: No\n*Type*: [TopBottomRankedComputation](./aws-properties-quicksight-dashboard-topbottomrankedcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-topbottomranked", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomRankedComputation" }, "TotalAggregation": { "MarkdownDocumentation": "`TotalAggregation`\n\nThe total aggregation computation configuration.\n*Required*: No\n*Type*: [TotalAggregationComputation](./aws-properties-quicksight-dashboard-totalaggregationcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-totalaggregation", "UpdateType": "Mutable", "Required": false, "Type": "TotalAggregationComputation" }, "Forecast": { "MarkdownDocumentation": "`Forecast`\n\nThe forecast computation configuration.\n*Required*: No\n*Type*: [ForecastComputation](./aws-properties-quicksight-dashboard-forecastcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-forecast", "UpdateType": "Mutable", "Required": false, "Type": "ForecastComputation" }, "MaximumMinimum": { "MarkdownDocumentation": "`MaximumMinimum`\n\nThe maximum and minimum computation configuration.\n*Required*: No\n*Type*: [MaximumMinimumComputation](./aws-properties-quicksight-dashboard-maximumminimumcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-maximumminimum", "UpdateType": "Mutable", "Required": false, "Type": "MaximumMinimumComputation" }, "PeriodOverPeriod": { "MarkdownDocumentation": "`PeriodOverPeriod`\n\nThe period over period computation configuration.\n*Required*: No\n*Type*: [PeriodOverPeriodComputation](./aws-properties-quicksight-dashboard-periodoverperiodcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-periodoverperiod", "UpdateType": "Mutable", "Required": false, "Type": "PeriodOverPeriodComputation" }, "MetricComparison": { "MarkdownDocumentation": "`MetricComparison`\n\nThe metric comparison computation configuration.\n*Required*: No\n*Type*: [MetricComparisonComputation](./aws-properties-quicksight-dashboard-metriccomparisoncomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-metriccomparison", "UpdateType": "Mutable", "Required": false, "Type": "MetricComparisonComputation" }, "TopBottomMovers": { "MarkdownDocumentation": "`TopBottomMovers`\n\nThe top movers and bottom movers computation configuration.\n*Required*: No\n*Type*: [TopBottomMoversComputation](./aws-properties-quicksight-dashboard-topbottommoverscomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-topbottommovers", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomMoversComputation" }, "UniqueValues": { "MarkdownDocumentation": "`UniqueValues`\n\nThe unique values computation configuration.\n*Required*: No\n*Type*: [UniqueValuesComputation](./aws-properties-quicksight-dashboard-uniquevaluescomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-computation-uniquevalues", "UpdateType": "Mutable", "Required": false, "Type": "UniqueValuesComputation" } } }, "AWS::QuickSight::Dashboard.ConditionalFormattingColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ConditionalFormattingColor`\n\nThe formatting configuration for the color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcolor.html", "Properties": { "Gradient": { "MarkdownDocumentation": "`Gradient`\n\nFormatting configuration for gradient color.\n*Required*: No\n*Type*: [ConditionalFormattingGradientColor](./aws-properties-quicksight-dashboard-conditionalformattinggradientcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcolor.html#cfn-quicksight-dashboard-conditionalformattingcolor-gradient", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingGradientColor" }, "Solid": { "MarkdownDocumentation": "`Solid`\n\nFormatting configuration for solid color.\n*Required*: No\n*Type*: [ConditionalFormattingSolidColor](./aws-properties-quicksight-dashboard-conditionalformattingsolidcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcolor.html#cfn-quicksight-dashboard-conditionalformattingcolor-solid", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingSolidColor" } } }, "AWS::QuickSight::Dashboard.ConditionalFormattingCustomIconCondition": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ConditionalFormattingCustomIconCondition`\n\nDetermines the custom condition for an icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconcondition.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the condition of the icon set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconcondition.html#cfn-quicksight-dashboard-conditionalformattingcustomiconcondition-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color of the icon.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconcondition.html#cfn-quicksight-dashboard-conditionalformattingcustomiconcondition-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayConfiguration": { "MarkdownDocumentation": "`DisplayConfiguration`\n\nDetermines the icon display configuration.\n*Required*: No\n*Type*: [ConditionalFormattingIconDisplayConfiguration](./aws-properties-quicksight-dashboard-conditionalformattingicondisplayconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconcondition.html#cfn-quicksight-dashboard-conditionalformattingcustomiconcondition-displayconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIconDisplayConfiguration" }, "IconOptions": { "MarkdownDocumentation": "`IconOptions`\n\nCustom icon options for an icon set.\n*Required*: Yes\n*Type*: [ConditionalFormattingCustomIconOptions](./aws-properties-quicksight-dashboard-conditionalformattingcustomiconoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconcondition.html#cfn-quicksight-dashboard-conditionalformattingcustomiconcondition-iconoptions", "UpdateType": "Mutable", "Required": true, "Type": "ConditionalFormattingCustomIconOptions" } } }, "AWS::QuickSight::Dashboard.ConditionalFormattingCustomIconOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ConditionalFormattingCustomIconOptions`\n\nCustom icon options for an icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconoptions.html", "Properties": { "UnicodeIcon": { "MarkdownDocumentation": "`UnicodeIcon`\n\nDetermines the Unicode icon type.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000-\\u00FF]$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconoptions.html#cfn-quicksight-dashboard-conditionalformattingcustomiconoptions-unicodeicon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nDetermines the type of icon.\n*Required*: No\n*Type*: String\n*Allowed values*: `CARET_UP | CARET_DOWN | PLU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CARET_UP", "CARET_DOWN", "PLUS", "MINUS", "ARROW_UP", "ARROW_DOWN", "ARROW_LEFT", "ARROW_UP_LEFT", "ARROW_DOWN_LEFT", "ARROW_RIGHT", "ARROW_UP_RIGHT", "ARROW_DOWN_RIGHT", "FACE_UP", "FACE_DOWN", "FACE_FLAT", "ONE_BAR", "TWO_BAR", "THREE_BAR", "CIRCLE", "TRIANGLE", "SQUARE", "FLAG", "THUMBS_UP", "THUMBS_DOWN", "CHECKMARK", "X" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconoptions.html#cfn-quicksight-dashboard-conditionalformattingcustomiconoptions-icon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ConditionalFormattingGradientColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ConditionalFormattingGradientColor`\n\nFormatting configuration for gradient color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattinggradientcolor.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for gradient color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattinggradientcolor.html#cfn-quicksight-dashboard-conditionalformattinggradientcolor-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\n*Required*: Yes\n*Type*: [GradientColor](./aws-properties-quicksight-dashboard-gradientcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattinggradientcolor.html#cfn-quicksight-dashboard-conditionalformattinggradientcolor-color", "UpdateType": "Mutable", "Required": true, "Type": "GradientColor" } } }, "AWS::QuickSight::Dashboard.ConditionalFormattingIcon": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ConditionalFormattingIcon`\n\nThe formatting configuration for the icon.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingicon.html", "Properties": { "CustomCondition": { "MarkdownDocumentation": "`CustomCondition`\n\nDetermines the custom condition for an icon set.\n*Required*: No\n*Type*: [ConditionalFormattingCustomIconCondition](./aws-properties-quicksight-dashboard-conditionalformattingcustomiconcondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingicon.html#cfn-quicksight-dashboard-conditionalformattingicon-customcondition", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingCustomIconCondition" }, "IconSet": { "MarkdownDocumentation": "`IconSet`\n\nFormatting configuration for icon set.\n*Required*: No\n*Type*: [ConditionalFormattingIconSet](./aws-properties-quicksight-dashboard-conditionalformattingiconset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingicon.html#cfn-quicksight-dashboard-conditionalformattingicon-iconset", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIconSet" } } }, "AWS::QuickSight::Dashboard.ConditionalFormattingIconDisplayConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ConditionalFormattingIconDisplayConfiguration`\n\nDetermines the icon display configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingicondisplayconfiguration.html", "Properties": { "IconDisplayOption": { "MarkdownDocumentation": "`IconDisplayOption`\n\nDetermines the icon display configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `ICON_ONLY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ICON_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingicondisplayconfiguration.html#cfn-quicksight-dashboard-conditionalformattingicondisplayconfiguration-icondisplayoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ConditionalFormattingIconSet": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ConditionalFormattingIconSet`\n\nFormatting configuration for icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingiconset.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for the icon set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingiconset.html#cfn-quicksight-dashboard-conditionalformattingiconset-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IconSetType": { "MarkdownDocumentation": "`IconSetType`\n\nDetermines the icon set type.\n*Required*: No\n*Type*: String\n*Allowed values*: `PLUS_MINUS | CHECK_X | THRE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PLUS_MINUS", "CHECK_X", "THREE_COLOR_ARROW", "THREE_GRAY_ARROW", "CARET_UP_MINUS_DOWN", "THREE_SHAPE", "THREE_CIRCLE", "FLAGS", "BARS", "FOUR_COLOR_ARROW", "FOUR_GRAY_ARROW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingiconset.html#cfn-quicksight-dashboard-conditionalformattingiconset-iconsettype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ConditionalFormattingSolidColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ConditionalFormattingSolidColor`\n\nFormatting configuration for solid color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingsolidcolor.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for solid color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingsolidcolor.html#cfn-quicksight-dashboard-conditionalformattingsolidcolor-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingsolidcolor.html#cfn-quicksight-dashboard-conditionalformattingsolidcolor-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ContextMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ContextMenuOption`\n\nThe context menu options for a visual's interactions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-contextmenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availability status of the context menu options. If the value of this property is set to `ENABLED`, dashboard readers can interact with the context menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-contextmenuoption.html#cfn-quicksight-dashboard-contextmenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ContributionAnalysisDefault": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ContributionAnalysisDefault`\n\nThe contribution analysis visual display for a line, pie, or bar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-contributionanalysisdefault.html", "Properties": { "MeasureFieldId": { "MarkdownDocumentation": "`MeasureFieldId`\n\nThe measure field that is used in the contribution analysis.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-contributionanalysisdefault.html#cfn-quicksight-dashboard-contributionanalysisdefault-measurefieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContributorDimensions": { "MarkdownDocumentation": "`ContributorDimensions`\n\nThe dimensions columns that are used in the contribution analysis,\nusually a list of `ColumnIdentifiers`.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-contributionanalysisdefault.html#cfn-quicksight-dashboard-contributionanalysisdefault-contributordimensions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.CurrencyDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CurrencyDisplayFormatConfiguration`\n\nThe options that determine the currency display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-dashboard-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-dashboard-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NumberScale": { "MarkdownDocumentation": "`NumberScale`\n\nDetermines the number scale value for the currency format.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AUTO | THOUSANDS | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-numberscale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-dashboard-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the currency format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-dashboard-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Symbol": { "MarkdownDocumentation": "`Symbol`\n\nDetermines the symbol for the currency format.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Z]{3}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-symbol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the currency format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CustomActionFilterOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomActionFilterOperation`\n\nThe filter operation that filters data included in a visual or in an entire sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionfilteroperation.html", "Properties": { "SelectedFieldsConfiguration": { "MarkdownDocumentation": "`SelectedFieldsConfiguration`\n\nThe configuration that chooses the fields to be filtered.\n*Required*: Yes\n*Type*: [FilterOperationSelectedFieldsConfiguration](./aws-properties-quicksight-dashboard-filteroperationselectedfieldsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionfilteroperation.html#cfn-quicksight-dashboard-customactionfilteroperation-selectedfieldsconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterOperationSelectedFieldsConfiguration" }, "TargetVisualsConfiguration": { "MarkdownDocumentation": "`TargetVisualsConfiguration`\n\nThe configuration that chooses the target visuals to be filtered.\n*Required*: Yes\n*Type*: [FilterOperationTargetVisualsConfiguration](./aws-properties-quicksight-dashboard-filteroperationtargetvisualsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionfilteroperation.html#cfn-quicksight-dashboard-customactionfilteroperation-targetvisualsconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterOperationTargetVisualsConfiguration" } } }, "AWS::QuickSight::Dashboard.CustomActionNavigationOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomActionNavigationOperation`\n\nThe navigation operation that navigates between different sheets in the same analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionnavigationoperation.html", "Properties": { "LocalNavigationConfiguration": { "MarkdownDocumentation": "`LocalNavigationConfiguration`\n\nThe configuration that chooses the navigation target.\n*Required*: No\n*Type*: [LocalNavigationConfiguration](./aws-properties-quicksight-dashboard-localnavigationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionnavigationoperation.html#cfn-quicksight-dashboard-customactionnavigationoperation-localnavigationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LocalNavigationConfiguration" } } }, "AWS::QuickSight::Dashboard.CustomActionSetParametersOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomActionSetParametersOperation`\n\nThe set parameter operation that sets parameters in custom action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionsetparametersoperation.html", "Properties": { "ParameterValueConfigurations": { "MarkdownDocumentation": "`ParameterValueConfigurations`\n\nThe parameter that determines the value configuration.\n*Required*: Yes\n*Type*: Array of [SetParameterValueConfiguration](./aws-properties-quicksight-dashboard-setparametervalueconfiguration.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionsetparametersoperation.html#cfn-quicksight-dashboard-customactionsetparametersoperation-parametervalueconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SetParameterValueConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.CustomActionURLOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomActionURLOperation`\n\nThe URL operation that opens a link to another webpage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionurloperation.html", "Properties": { "URLTemplate": { "MarkdownDocumentation": "`URLTemplate`\n\nTHe URL link of the `CustomActionURLOperation`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionurloperation.html#cfn-quicksight-dashboard-customactionurloperation-urltemplate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "URLTarget": { "MarkdownDocumentation": "`URLTarget`\n\nThe target of the `CustomActionURLOperation`.\nValid values are defined as follows:\n* `NEW_TAB`: Opens the target URL in a new browser tab.\n* `NEW_WINDOW`: Opens the target URL in a new browser window.\n* `SAME_TAB`: Opens the target URL in the same browser tab.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW_TAB | NEW_WINDOW | SAME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_TAB", "NEW_WINDOW", "SAME_TAB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customactionurloperation.html#cfn-quicksight-dashboard-customactionurloperation-urltarget", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CustomColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomColor`\n\nDetermines the color that's applied to a particular data value in a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcolor.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that is applied to the data value.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcolor.html#cfn-quicksight-dashboard-customcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe data value that the color is applied to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcolor.html#cfn-quicksight-dashboard-customcolor-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpecialValue": { "MarkdownDocumentation": "`SpecialValue`\n\nThe value of a special data value.\n*Required*: No\n*Type*: String\n*Allowed values*: `EMPTY | NULL | OTHER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EMPTY", "NULL", "OTHER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcolor.html#cfn-quicksight-dashboard-customcolor-specialvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CustomContentConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomContentConfiguration`\n\nThe configuration of a `CustomContentVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentconfiguration.html", "Properties": { "ContentUrl": { "MarkdownDocumentation": "`ContentUrl`\n\nThe input URL that links to the custom content that you want in the custom visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentconfiguration.html#cfn-quicksight-dashboard-customcontentconfiguration-contenturl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe content type of the custom content visual. You can use this to have the visual render as an image.\n*Required*: No\n*Type*: String\n*Allowed values*: `IMAGE | OTHER_EMBEDDED_CONT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IMAGE", "OTHER_EMBEDDED_CONTENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentconfiguration.html#cfn-quicksight-dashboard-customcontentconfiguration-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImageScaling": { "MarkdownDocumentation": "`ImageScaling`\n\nThe sizing options for the size of the custom content visual. This structure is required when the `ContentType` of the visual is `'IMAGE'`.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIT_TO_HEIGHT | FIT_TO_WIDT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIT_TO_HEIGHT", "FIT_TO_WIDTH", "DO_NOT_SCALE", "SCALE_TO_VISUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentconfiguration.html#cfn-quicksight-dashboard-customcontentconfiguration-imagescaling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentconfiguration.html#cfn-quicksight-dashboard-customcontentconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Dashboard.CustomContentVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomContentVisual`\n\nA visual that contains custom content.\nFor more information, see [Using custom visual content](https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `CustomContentVisual`.\n*Required*: No\n*Type*: [CustomContentConfiguration](./aws-properties-quicksight-dashboard-customcontentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomContentConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe dataset that is used to create the custom content visual. You can't create a visual without a dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CustomFilterConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomFilterConfiguration`\n\nA custom filter that filters based on a single value. This filter can be partially matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html", "Properties": { "CategoryValue": { "MarkdownDocumentation": "`CategoryValue`\n\nThe category value for the filter.\nThis field is mutually exclusive to `ParameterName`.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-categoryvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\nThis field is mutually exclusive to `CategoryValue`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CustomFilterListConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomFilterListConfiguration`\n\nA list of custom filter values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterlistconfiguration.html", "Properties": { "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nThe list of category values for the filter.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterlistconfiguration.html#cfn-quicksight-dashboard-customfilterlistconfiguration-categoryvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterlistconfiguration.html#cfn-quicksight-dashboard-customfilterlistconfiguration-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterlistconfiguration.html#cfn-quicksight-dashboard-customfilterlistconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterlistconfiguration.html#cfn-quicksight-dashboard-customfilterlistconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CustomNarrativeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomNarrativeOptions`\n\nThe custom narrative options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customnarrativeoptions.html", "Properties": { "Narrative": { "MarkdownDocumentation": "`Narrative`\n\nThe string input of custom narrative.\n*Required*: Yes\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `150000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customnarrativeoptions.html#cfn-quicksight-dashboard-customnarrativeoptions-narrative", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.CustomParameterValues": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomParameterValues`\n\nThe customized parameter values.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customparametervalues.html", "Properties": { "DecimalValues": { "MarkdownDocumentation": "`DecimalValues`\n\nA list of decimal-type parameter values.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customparametervalues.html#cfn-quicksight-dashboard-customparametervalues-decimalvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "IntegerValues": { "MarkdownDocumentation": "`IntegerValues`\n\nA list of integer-type parameter values.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customparametervalues.html#cfn-quicksight-dashboard-customparametervalues-integervalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "StringValues": { "MarkdownDocumentation": "`StringValues`\n\nA list of string-type parameter values.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customparametervalues.html#cfn-quicksight-dashboard-customparametervalues-stringvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DateTimeValues": { "MarkdownDocumentation": "`DateTimeValues`\n\nA list of datetime-type parameter values.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customparametervalues.html#cfn-quicksight-dashboard-customparametervalues-datetimevalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.CustomValuesConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.CustomValuesConfiguration`\n\nThe configuration of custom values for the destination parameter in `DestinationParameterValueConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customvaluesconfiguration.html", "Properties": { "IncludeNullValue": { "MarkdownDocumentation": "`IncludeNullValue`\n\nIncludes the null value in custom action parameter values.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customvaluesconfiguration.html#cfn-quicksight-dashboard-customvaluesconfiguration-includenullvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CustomValues": { "MarkdownDocumentation": "`CustomValues`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [CustomParameterValues](./aws-properties-quicksight-dashboard-customparametervalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customvaluesconfiguration.html#cfn-quicksight-dashboard-customvaluesconfiguration-customvalues", "UpdateType": "Mutable", "Required": true, "Type": "CustomParameterValues" } } }, "AWS::QuickSight::Dashboard.DashboardError": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DashboardError`\n\nDashboard error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nType.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCESS_DENIED | SOURCE_NOT_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html#cfn-quicksight-dashboard-dashboarderror-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nMessage.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html#cfn-quicksight-dashboard-dashboarderror-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ViolatedEntities": { "MarkdownDocumentation": "`ViolatedEntities`\n\nLists the violated entities that caused the dashboard error.\n*Required*: No\n*Type*: Array of [Entity](./aws-properties-quicksight-dashboard-entity.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html#cfn-quicksight-dashboard-dashboarderror-violatedentities", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Entity", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.DashboardPublishOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DashboardPublishOptions`\n\nDashboard publish options:\n* `AvailabilityStatus` for `AdHocFilteringOption` - This\n status can be either `ENABLED` or `DISABLED`. When this is\n set to `DISABLED`, Amazon Quick Sight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is `ENABLED` by default.\n* `AvailabilityStatus` for `ExportToCSVOption` - This\n status can be either `ENABLED` or `DISABLED`. The visual\n option to export data to .CSV format isn't enabled when this is set to\n `DISABLED`. This option is `ENABLED` by default.\n* `VisibilityState` for `SheetControlsOption` - This\n visibility state can be either `COLLAPSED` or `EXPANDED`.\n This option is `COLLAPSED` by default.\n* `AvailabilityStatus` for `QuickSuiteActionsOption` - This status\n can be either `ENABLED` or `DISABLED`. Features related to Actions in Amazon\n Quick Suite on dashboards are disabled when this is set to `DISABLED`. This option is\n `DISABLED` by default.\n* `AvailabilityStatus` for `ExecutiveSummaryOption` - This status\n can be either `ENABLED` or `DISABLED`. The option to build an executive\n summary is disabled when this is set to `DISABLED`. This option is `ENABLED`\n by default.\n* `AvailabilityStatus` for `DataStoriesSharingOption` - This status\n can be either `ENABLED` or `DISABLED`. The option to share a data story is\n disabled when this is set to `DISABLED`. This option is `ENABLED`\n by default.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html", "Properties": { "SheetControlsOption": { "MarkdownDocumentation": "`SheetControlsOption`\n\nSheet controls option.\n*Required*: No\n*Type*: [SheetControlsOption](./aws-properties-quicksight-dashboard-sheetcontrolsoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-sheetcontrolsoption", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlsOption" }, "DataPointDrillUpDownOption": { "MarkdownDocumentation": "`DataPointDrillUpDownOption`\n\nThe drill-down options of data points in a dashboard.\n*Required*: No\n*Type*: [DataPointDrillUpDownOption](./aws-properties-quicksight-dashboard-datapointdrillupdownoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointdrillupdownoption", "UpdateType": "Mutable", "Required": false, "Type": "DataPointDrillUpDownOption" }, "AdHocFilteringOption": { "MarkdownDocumentation": "`AdHocFilteringOption`\n\nAd hoc (one-time) filtering option.\n*Required*: No\n*Type*: [AdHocFilteringOption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-adhocfilteringoption", "UpdateType": "Mutable", "Required": false, "Type": "AdHocFilteringOption" }, "VisualPublishOptions": { "MarkdownDocumentation": "`VisualPublishOptions`\n\nThe visual publish options of a visual in a dashboard.\n*Required*: No\n*Type*: [DashboardVisualPublishOptions](./aws-properties-quicksight-dashboard-dashboardvisualpublishoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualpublishoptions", "UpdateType": "Mutable", "Required": false, "Type": "DashboardVisualPublishOptions" }, "DataStoriesSharingOption": { "MarkdownDocumentation": "`DataStoriesSharingOption`\n\nData stories sharing option.\n*Required*: No\n*Type*: [DataStoriesSharingOption](./aws-properties-quicksight-dashboard-datastoriessharingoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datastoriessharingoption", "UpdateType": "Mutable", "Required": false, "Type": "DataStoriesSharingOption" }, "VisualAxisSortOption": { "MarkdownDocumentation": "`VisualAxisSortOption`\n\nThe axis sort options of a dashboard.\n*Required*: No\n*Type*: [VisualAxisSortOption](./aws-properties-quicksight-dashboard-visualaxissortoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualaxissortoption", "UpdateType": "Mutable", "Required": false, "Type": "VisualAxisSortOption" }, "ExportWithHiddenFieldsOption": { "MarkdownDocumentation": "`ExportWithHiddenFieldsOption`\n\nDetermines if hidden fields are exported with a dashboard.\n*Required*: No\n*Type*: [ExportWithHiddenFieldsOption](./aws-properties-quicksight-dashboard-exportwithhiddenfieldsoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-exportwithhiddenfieldsoption", "UpdateType": "Mutable", "Required": false, "Type": "ExportWithHiddenFieldsOption" }, "QuickSuiteActionsOption": { "MarkdownDocumentation": "`QuickSuiteActionsOption`\n\nDetermines if Actions in Amazon Quick Suite are enabled in a dashboard.\n*Required*: No\n*Type*: [QuickSuiteActionsOption](./aws-properties-quicksight-dashboard-quicksuiteactionsoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-quicksuiteactionsoption", "UpdateType": "Mutable", "Required": false, "Type": "QuickSuiteActionsOption" }, "ExecutiveSummaryOption": { "MarkdownDocumentation": "`ExecutiveSummaryOption`\n\nExecutive summary option.\n*Required*: No\n*Type*: [ExecutiveSummaryOption](./aws-properties-quicksight-dashboard-executivesummaryoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-executivesummaryoption", "UpdateType": "Mutable", "Required": false, "Type": "ExecutiveSummaryOption" }, "ExportToCSVOption": { "MarkdownDocumentation": "`ExportToCSVOption`\n\nExport to .csv option.\n*Required*: No\n*Type*: [ExportToCSVOption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-exporttocsvoption", "UpdateType": "Mutable", "Required": false, "Type": "ExportToCSVOption" }, "DataPointMenuLabelOption": { "MarkdownDocumentation": "`DataPointMenuLabelOption`\n\nThe data point menu label options of a dashboard.\n*Required*: No\n*Type*: [DataPointMenuLabelOption](./aws-properties-quicksight-dashboard-datapointmenulabeloption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointmenulabeloption", "UpdateType": "Mutable", "Required": false, "Type": "DataPointMenuLabelOption" }, "VisualMenuOption": { "MarkdownDocumentation": "`VisualMenuOption`\n\nThe menu options of a visual in a dashboard.\n*Required*: No\n*Type*: [VisualMenuOption](./aws-properties-quicksight-dashboard-visualmenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualmenuoption", "UpdateType": "Mutable", "Required": false, "Type": "VisualMenuOption" }, "DataPointTooltipOption": { "MarkdownDocumentation": "`DataPointTooltipOption`\n\nThe data point tool tip options of a dashboard.\n*Required*: No\n*Type*: [DataPointTooltipOption](./aws-properties-quicksight-dashboard-datapointtooltipoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointtooltipoption", "UpdateType": "Mutable", "Required": false, "Type": "DataPointTooltipOption" }, "DataQAEnabledOption": { "MarkdownDocumentation": "`DataQAEnabledOption`\n\nAdds Q&A capabilities to an Quick Sight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.\n*Required*: No\n*Type*: [DataQAEnabledOption](./aws-properties-quicksight-dashboard-dataqaenabledoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-dataqaenabledoption", "UpdateType": "Mutable", "Required": false, "Type": "DataQAEnabledOption" }, "SheetLayoutElementMaximizationOption": { "MarkdownDocumentation": "`SheetLayoutElementMaximizationOption`\n\nThe sheet layout maximization options of a dashbaord.\n*Required*: No\n*Type*: [SheetLayoutElementMaximizationOption](./aws-properties-quicksight-dashboard-sheetlayoutelementmaximizationoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-sheetlayoutelementmaximizationoption", "UpdateType": "Mutable", "Required": false, "Type": "SheetLayoutElementMaximizationOption" } } }, "AWS::QuickSight::Dashboard.DashboardSourceEntity": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DashboardSourceEntity`\n\nDashboard source entity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourceentity.html", "Properties": { "SourceTemplate": { "MarkdownDocumentation": "`SourceTemplate`\n\nSource template.\n*Required*: No\n*Type*: [DashboardSourceTemplate](./aws-properties-quicksight-dashboard-dashboardsourcetemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourceentity.html#cfn-quicksight-dashboard-dashboardsourceentity-sourcetemplate", "UpdateType": "Mutable", "Required": false, "Type": "DashboardSourceTemplate" } } }, "AWS::QuickSight::Dashboard.DashboardSourceTemplate": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DashboardSourceTemplate`\n\nDashboard source template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourcetemplate.html", "Properties": { "DataSetReferences": { "MarkdownDocumentation": "`DataSetReferences`\n\nDataset references.\n*Required*: Yes\n*Type*: Array of [DataSetReference](./aws-properties-quicksight-dashboard-datasetreference.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourcetemplate.html#cfn-quicksight-dashboard-dashboardsourcetemplate-datasetreferences", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataSetReference", "DuplicatesAllowed": true }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourcetemplate.html#cfn-quicksight-dashboard-dashboardsourcetemplate-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DashboardVersion": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DashboardVersion`\n\nDashboard version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe HTTP status of the request.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATION_IN_PROGRESS | CREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "PENDING_UPDATE", "DELETED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Errors": { "MarkdownDocumentation": "`Errors`\n\nErrors associated with this dashboard version.\n*Required*: No\n*Type*: Array of [DashboardError](./aws-properties-quicksight-dashboard-dashboarderror.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-errors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DashboardError", "DuplicatesAllowed": true }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nDescription.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSetArns": { "MarkdownDocumentation": "`DataSetArns`\n\nThe Amazon Resource Numbers (ARNs) for the datasets that are associated with this\nversion of the dashboard.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-datasetarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ThemeArn": { "MarkdownDocumentation": "`ThemeArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-themearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceEntityArn": { "MarkdownDocumentation": "`SourceEntityArn`\n\nSource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-sourceentityarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VersionNumber": { "MarkdownDocumentation": "`VersionNumber`\n\nVersion number for this version of the dashboard.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-versionnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Sheets": { "MarkdownDocumentation": "`Sheets`\n\nA list of the associated sheets with the unique identifier and name of each sheet.\n*Required*: No\n*Type*: Array of [Sheet](./aws-properties-quicksight-dashboard-sheet.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-sheets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Sheet", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.DashboardVersionDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DashboardVersionDefinition`\n\nThe contents of a dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nAn array of option definitions for a dashboard.\n*Required*: No\n*Type*: [AssetOptions](./aws-properties-quicksight-dashboard-assetoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-options", "UpdateType": "Mutable", "Required": false, "Type": "AssetOptions" }, "FilterGroups": { "MarkdownDocumentation": "`FilterGroups`\n\nThe filter definitions for a dashboard.\nFor more information, see [Filtering Data in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [FilterGroup](./aws-properties-quicksight-dashboard-filtergroup.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-filtergroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterGroup", "DuplicatesAllowed": true }, "StaticFiles": { "MarkdownDocumentation": "`StaticFiles`\n\nThe static files for the definition.\n*Required*: No\n*Type*: Array of [StaticFile](./aws-properties-quicksight-dashboard-staticfile.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-staticfiles", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StaticFile", "DuplicatesAllowed": true }, "CalculatedFields": { "MarkdownDocumentation": "`CalculatedFields`\n\nAn array of calculated field definitions for the dashboard.\n*Required*: No\n*Type*: Array of [CalculatedField](./aws-properties-quicksight-dashboard-calculatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-calculatedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CalculatedField", "DuplicatesAllowed": true }, "DataSetIdentifierDeclarations": { "MarkdownDocumentation": "`DataSetIdentifierDeclarations`\n\nAn array of dataset identifier declarations. With\nthis mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.\n*Required*: Yes\n*Type*: Array of [DataSetIdentifierDeclaration](./aws-properties-quicksight-dashboard-datasetidentifierdeclaration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-datasetidentifierdeclarations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataSetIdentifierDeclaration", "DuplicatesAllowed": true }, "ColumnConfigurations": { "MarkdownDocumentation": "`ColumnConfigurations`\n\nAn array of dashboard-level column configurations. Column configurations\nare used to set the default formatting for a column that\nis used throughout a dashboard.\n*Required*: No\n*Type*: Array of [ColumnConfiguration](./aws-properties-quicksight-dashboard-columnconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-columnconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnConfiguration", "DuplicatesAllowed": true }, "AnalysisDefaults": { "MarkdownDocumentation": "`AnalysisDefaults`\n\nProperty description not available.\n*Required*: No\n*Type*: [AnalysisDefaults](./aws-properties-quicksight-dashboard-analysisdefaults.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-analysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisDefaults" }, "Sheets": { "MarkdownDocumentation": "`Sheets`\n\nAn array of sheet definitions for a dashboard.\n*Required*: No\n*Type*: Array of [SheetDefinition](./aws-properties-quicksight-dashboard-sheetdefinition.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-sheets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetDefinition", "DuplicatesAllowed": true }, "ParameterDeclarations": { "MarkdownDocumentation": "`ParameterDeclarations`\n\nThe parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.\nFor more information, see [Parameters in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [ParameterDeclaration](./aws-properties-quicksight-dashboard-parameterdeclaration.html)\n*Minimum*: `0`\n*Maximum*: `400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-parameterdeclarations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ParameterDeclaration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.DashboardVisualPublishOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DashboardVisualPublishOptions`\n\nThe visual publish options of a visual in a dashboard\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardvisualpublishoptions.html", "Properties": { "ExportHiddenFieldsOption": { "MarkdownDocumentation": "`ExportHiddenFieldsOption`\n\nDetermines if hidden fields are included in an exported dashboard.\n*Required*: No\n*Type*: [ExportHiddenFieldsOption](./aws-properties-quicksight-dashboard-exporthiddenfieldsoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardvisualpublishoptions.html#cfn-quicksight-dashboard-dashboardvisualpublishoptions-exporthiddenfieldsoption", "UpdateType": "Mutable", "Required": false, "Type": "ExportHiddenFieldsOption" } } }, "AWS::QuickSight::Dashboard.DataBarsOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataBarsOptions`\n\nThe options for data bars.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-databarsoptions.html", "Properties": { "PositiveColor": { "MarkdownDocumentation": "`PositiveColor`\n\nThe color of the positive data bar.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-databarsoptions.html#cfn-quicksight-dashboard-databarsoptions-positivecolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for the data bars options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-databarsoptions.html#cfn-quicksight-dashboard-databarsoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NegativeColor": { "MarkdownDocumentation": "`NegativeColor`\n\nThe color of the negative data bar.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-databarsoptions.html#cfn-quicksight-dashboard-databarsoptions-negativecolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataColor`\n\nDetermines the color that is applied to a particular data value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datacolor.html", "Properties": { "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nThe data value that the color is applied to.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datacolor.html#cfn-quicksight-dashboard-datacolor-datavalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that is applied to the data value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datacolor.html#cfn-quicksight-dashboard-datacolor-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataFieldSeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataFieldSeriesItem`\n\nThe data field series item configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datafieldseriesitem.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that you are setting the axis binding to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datafieldseriesitem.html#cfn-quicksight-dashboard-datafieldseriesitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis that you are binding the field to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datafieldseriesitem.html#cfn-quicksight-dashboard-datafieldseriesitem-axisbinding", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe field value of the field that you are setting the axis binding 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datafieldseriesitem.html#cfn-quicksight-dashboard-datafieldseriesitem-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nThe options that determine the presentation of line series associated to the field.\n*Required*: No\n*Type*: [LineChartSeriesSettings](./aws-properties-quicksight-dashboard-linechartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datafieldseriesitem.html#cfn-quicksight-dashboard-datafieldseriesitem-settings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSeriesSettings" } } }, "AWS::QuickSight::Dashboard.DataLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html", "Properties": { "DataLabelTypes": { "MarkdownDocumentation": "`DataLabelTypes`\n\nThe option that determines the data label type.\n*Required*: No\n*Type*: Array of [DataLabelType](./aws-properties-quicksight-dashboard-datalabeltype.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-datalabeltypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataLabelType", "DuplicatesAllowed": true }, "MeasureLabelVisibility": { "MarkdownDocumentation": "`MeasureLabelVisibility`\n\nDetermines the visibility of the measure field labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-measurelabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nDetermines the position of the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSIDE | OUTSIDE | LEFT | T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSIDE", "OUTSIDE", "LEFT", "TOP", "BOTTOM", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelContent": { "MarkdownDocumentation": "`LabelContent`\n\nDetermines the content of the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `VALUE | PERCENT | VALUE_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VALUE", "PERCENT", "VALUE_AND_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-labelcontent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nDetermines the visibility of the total.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Overlap": { "MarkdownDocumentation": "`Overlap`\n\nDetermines whether overlap is enabled or disabled for the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLE_OVERLAP | ENABLE_OV...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLE_OVERLAP", "ENABLE_OVERLAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-overlap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryLabelVisibility": { "MarkdownDocumentation": "`CategoryLabelVisibility`\n\nDetermines the visibility of the category field labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-categorylabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelColor": { "MarkdownDocumentation": "`LabelColor`\n\nDetermines the color of the data labels.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-labelcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelFontConfiguration": { "MarkdownDocumentation": "`LabelFontConfiguration`\n\nDetermines the font configuration of the data labels.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-labelfontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Dashboard.DataLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataLabelType`\n\nThe option that determines the data label type.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeltype.html", "Properties": { "MaximumLabelType": { "MarkdownDocumentation": "`MaximumLabelType`\n\nDetermines the label configuration for the maximum value in a visual.\n*Required*: No\n*Type*: [MaximumLabelType](./aws-properties-quicksight-dashboard-maximumlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeltype.html#cfn-quicksight-dashboard-datalabeltype-maximumlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "MaximumLabelType" }, "DataPathLabelType": { "MarkdownDocumentation": "`DataPathLabelType`\n\nThe option that specifies individual data values for labels.\n*Required*: No\n*Type*: [DataPathLabelType](./aws-properties-quicksight-dashboard-datapathlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeltype.html#cfn-quicksight-dashboard-datalabeltype-datapathlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "DataPathLabelType" }, "RangeEndsLabelType": { "MarkdownDocumentation": "`RangeEndsLabelType`\n\nDetermines the label configuration for range end value in a visual.\n*Required*: No\n*Type*: [RangeEndsLabelType](./aws-properties-quicksight-dashboard-rangeendslabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeltype.html#cfn-quicksight-dashboard-datalabeltype-rangeendslabeltype", "UpdateType": "Mutable", "Required": false, "Type": "RangeEndsLabelType" }, "FieldLabelType": { "MarkdownDocumentation": "`FieldLabelType`\n\nDetermines the label configuration for the entire field.\n*Required*: No\n*Type*: [FieldLabelType](./aws-properties-quicksight-dashboard-fieldlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeltype.html#cfn-quicksight-dashboard-datalabeltype-fieldlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "FieldLabelType" }, "MinimumLabelType": { "MarkdownDocumentation": "`MinimumLabelType`\n\nDetermines the label configuration for the minimum value in a visual.\n*Required*: No\n*Type*: [MinimumLabelType](./aws-properties-quicksight-dashboard-minimumlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeltype.html#cfn-quicksight-dashboard-datalabeltype-minimumlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "MinimumLabelType" } } }, "AWS::QuickSight::Dashboard.DataPathColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataPathColor`\n\nThe color map that determines the color options for a particular element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathcolor.html", "Properties": { "Element": { "MarkdownDocumentation": "`Element`\n\nThe element that the color needs to be applied to.\n*Required*: Yes\n*Type*: [DataPathValue](./aws-properties-quicksight-dashboard-datapathvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathcolor.html#cfn-quicksight-dashboard-datapathcolor-element", "UpdateType": "Mutable", "Required": true, "Type": "DataPathValue" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that needs to be applied to the element.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathcolor.html#cfn-quicksight-dashboard-datapathcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe time granularity of the field that the color needs to be applied to.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathcolor.html#cfn-quicksight-dashboard-datapathcolor-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataPathLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataPathLabelType`\n\nThe option that specifies individual data values for labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathlabeltype.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that the data label needs to be applied to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathlabeltype.html#cfn-quicksight-dashboard-datapathlabeltype-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the data label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathlabeltype.html#cfn-quicksight-dashboard-datapathlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe actual value of the field that is labeled.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathlabeltype.html#cfn-quicksight-dashboard-datapathlabeltype-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataPathSort": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataPathSort`\n\nAllows data paths to be sorted by a specific data value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathsort.html", "Properties": { "SortPaths": { "MarkdownDocumentation": "`SortPaths`\n\nThe list of data paths that need to be sorted.\n*Required*: Yes\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-dashboard-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathsort.html#cfn-quicksight-dashboard-datapathsort-sortpaths", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nDetermines the sort direction.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathsort.html#cfn-quicksight-dashboard-datapathsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataPathType": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataPathType`\n\nThe type of the data path value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathtype.html", "Properties": { "PivotTableDataPathType": { "MarkdownDocumentation": "`PivotTableDataPathType`\n\nThe type of data path value utilized in a pivot table. Choose one of the following options:\n* `HIERARCHY_ROWS_LAYOUT_COLUMN` - The type of data path for the rows layout column, when `RowsLayout` is set to `HIERARCHY`.\n* `MULTIPLE_ROW_METRICS_COLUMN` - The type of data path for the metric column when the row is set to Metric Placement.\n* `EMPTY_COLUMN_HEADER` - The type of data path for the column with empty column header, when there is no field in `ColumnsFieldWell` and the row is set to Metric Placement.\n* `COUNT_METRIC_COLUMN` - The type of data path for the column with `COUNT` as the metric, when there is no field in the `ValuesFieldWell`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIERARCHY_ROWS_LAYOUT_COLUM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIERARCHY_ROWS_LAYOUT_COLUMN", "MULTIPLE_ROW_METRICS_COLUMN", "EMPTY_COLUMN_HEADER", "COUNT_METRIC_COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathtype.html#cfn-quicksight-dashboard-datapathtype-pivottabledatapathtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataPathValue": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataPathValue`\n\nThe data path that needs to be sorted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathvalue.html", "Properties": { "DataPathType": { "MarkdownDocumentation": "`DataPathType`\n\nThe type configuration of the field.\n*Required*: No\n*Type*: [DataPathType](./aws-properties-quicksight-dashboard-datapathtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathvalue.html#cfn-quicksight-dashboard-datapathvalue-datapathtype", "UpdateType": "Mutable", "Required": false, "Type": "DataPathType" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that needs to be sorted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathvalue.html#cfn-quicksight-dashboard-datapathvalue-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe actual value of the field that needs to be sorted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapathvalue.html#cfn-quicksight-dashboard-datapathvalue-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataPointDrillUpDownOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataPointDrillUpDownOption`\n\nThe drill down options for data points in a dashbaord.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointdrillupdownoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe status of the drill down options of data points.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointdrillupdownoption.html#cfn-quicksight-dashboard-datapointdrillupdownoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataPointMenuLabelOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataPointMenuLabelOption`\n\nThe data point menu options of a dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointmenulabeloption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe status of the data point menu options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointmenulabeloption.html#cfn-quicksight-dashboard-datapointmenulabeloption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataPointTooltipOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataPointTooltipOption`\n\nThe data point tooltip options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointtooltipoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe status of the data point tool tip options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointtooltipoption.html#cfn-quicksight-dashboard-datapointtooltipoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataQAEnabledOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataQAEnabledOption`\n\nAdds Q&A capabilities to a dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is enabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dataqaenabledoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe status of the Data Q&A option on the dashboard.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dataqaenabledoption.html#cfn-quicksight-dashboard-dataqaenabledoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataSetIdentifierDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataSetIdentifierDeclaration`\n\nA data set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetidentifierdeclaration.html", "Properties": { "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nThe identifier of the data set, typically the data set's name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetidentifierdeclaration.html#cfn-quicksight-dashboard-datasetidentifierdeclaration-identifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetArn": { "MarkdownDocumentation": "`DataSetArn`\n\nThe Amazon Resource Name (ARN) of the data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetidentifierdeclaration.html#cfn-quicksight-dashboard-datasetidentifierdeclaration-datasetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataSetReference": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataSetReference`\n\nDataset reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetreference.html", "Properties": { "DataSetArn": { "MarkdownDocumentation": "`DataSetArn`\n\nDataset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetreference.html#cfn-quicksight-dashboard-datasetreference-datasetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetPlaceholder": { "MarkdownDocumentation": "`DataSetPlaceholder`\n\nDataset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetreference.html#cfn-quicksight-dashboard-datasetreference-datasetplaceholder", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DataStoriesSharingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DataStoriesSharingOption`\n\nExecutive summary option.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datastoriessharingoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nAvailability status.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datastoriessharingoption.html#cfn-quicksight-dashboard-datastoriessharingoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DateAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateAxisOptions`\n\nThe options that determine how a date axis is displayed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dateaxisoptions.html", "Properties": { "MissingDateVisibility": { "MarkdownDocumentation": "`MissingDateVisibility`\n\nDetermines whether or not missing dates are displayed.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dateaxisoptions.html#cfn-quicksight-dashboard-dateaxisoptions-missingdatevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DateDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateDimensionField`\n\nThe dimension type field with date type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-dashboard-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `DateDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DateGranularity": { "MarkdownDocumentation": "`DateGranularity`\n\nThe date granularity of the `DateDimensionField`. Choose one of the following options:\n* `YEAR`\n* `QUARTER`\n* `MONTH`\n* `WEEK`\n* `DAY`\n* `HOUR`\n* `MINUTE`\n* `SECOND`\n* `MILLISECOND`\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-dategranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DateMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateMeasureField`\n\nThe measure type field with date type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datemeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [String](./aws-properties-quicksight-dashboard-aggregationfunction.html)\n*Allowed values*: `COUNT | DISTINCT_COUNT | MI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT", "MIN", "MAX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datemeasurefield.html#cfn-quicksight-dashboard-datemeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-dashboard-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datemeasurefield.html#cfn-quicksight-dashboard-datemeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `DateMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datemeasurefield.html#cfn-quicksight-dashboard-datemeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datemeasurefield.html#cfn-quicksight-dashboard-datemeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DateTimeDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateTimeDefaultValues`\n\nThe default values of the `DateTimeParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimedefaultvalues.html", "Properties": { "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date of the `DataTimeDefaultValues`. The date is determined from the dataset based on input expression.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-dashboard-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimedefaultvalues.html#cfn-quicksight-dashboard-datetimedefaultvalues-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `DataTimeDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-dashboard-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimedefaultvalues.html#cfn-quicksight-dashboard-datetimedefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DataTimeDefaultValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimedefaultvalues.html#cfn-quicksight-dashboard-datetimedefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.DateTimeFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateTimeFormatConfiguration`\n\nFormatting configuration for `DateTime` fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeformatconfiguration.html", "Properties": { "NumericFormatConfiguration": { "MarkdownDocumentation": "`NumericFormatConfiguration`\n\nThe formatting configuration for numeric `DateTime` fields.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-dashboard-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeformatconfiguration.html#cfn-quicksight-dashboard-datetimeformatconfiguration-numericformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-dashboard-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeformatconfiguration.html#cfn-quicksight-dashboard-datetimeformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nDetermines the `DateTime` format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeformatconfiguration.html#cfn-quicksight-dashboard-datetimeformatconfiguration-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DateTimeHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateTimeHierarchy`\n\nThe option that determines the hierarchy of any `DateTime` fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimehierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the `DateTime` hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimehierarchy.html#cfn-quicksight-dashboard-datetimehierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the\n`DateTime` hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-dashboard-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimehierarchy.html#cfn-quicksight-dashboard-datetimehierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.DateTimeParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateTimeParameter`\n\nA date-time parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values for the date-time parameter.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameter.html#cfn-quicksight-dashboard-datetimeparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the date-time 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameter.html#cfn-quicksight-dashboard-datetimeparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DateTimeParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateTimeParameterDeclaration`\n\nA parameter declaration for the `DateTime` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-dashboard-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [DateTimeDefaultValues](./aws-properties-quicksight-dashboard-datetimedefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeDefaultValues" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `DateTime` parameter when a value has not been set.\n*Required*: No\n*Type*: [DateTimeValueWhenUnsetConfiguration](./aws-properties-quicksight-dashboard-datetimevaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DateTimePickerControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateTimePickerControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html#cfn-quicksight-dashboard-datetimepickercontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html#cfn-quicksight-dashboard-datetimepickercontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" }, "HelperTextVisibility": { "MarkdownDocumentation": "`HelperTextVisibility`\n\nThe helper text visibility of the `DateTimePickerControlDisplayOptions`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html#cfn-quicksight-dashboard-datetimepickercontroldisplayoptions-helpertextvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DateIconVisibility": { "MarkdownDocumentation": "`DateIconVisibility`\n\nThe date icon visibility of the `DateTimePickerControlDisplayOptions`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html#cfn-quicksight-dashboard-datetimepickercontroldisplayoptions-dateiconvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nCustomize how dates are formatted in controls.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html#cfn-quicksight-dashboard-datetimepickercontroldisplayoptions-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DateTimeValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DateTimeValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `DateTime` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimevaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-datetimevaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-datetimevaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DecimalDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DecimalDefaultValues`\n\nThe default values of the `DecimalParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimaldefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `DecimalDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-dashboard-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimaldefaultvalues.html#cfn-quicksight-dashboard-decimaldefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DecimalDefaultValues`.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimaldefaultvalues.html#cfn-quicksight-dashboard-decimaldefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.DecimalParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DecimalParameter`\n\nA decimal parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values for the decimal parameter.\n*Required*: Yes\n*Type*: Array of Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameter.html#cfn-quicksight-dashboard-decimalparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the decimal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameter.html#cfn-quicksight-dashboard-decimalparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DecimalParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DecimalParameterDeclaration`\n\nA parameter declaration for the `Decimal` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-dashboard-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-decimalparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [DecimalDefaultValues](./aws-properties-quicksight-dashboard-decimaldefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-decimalparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "DecimalDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-decimalparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `Decimal` parameter when a value has not been set.\n*Required*: No\n*Type*: [DecimalValueWhenUnsetConfiguration](./aws-properties-quicksight-dashboard-decimalvaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-decimalparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "DecimalValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-decimalparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DecimalPlacesConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalplacesconfiguration.html", "Properties": { "DecimalPlaces": { "MarkdownDocumentation": "`DecimalPlaces`\n\nThe values of the decimal places.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalplacesconfiguration.html#cfn-quicksight-dashboard-decimalplacesconfiguration-decimalplaces", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.DecimalValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DecimalValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `Decimal` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalvaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-decimalvaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't set.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-decimalvaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.DefaultDateTimePickerControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultDateTimePickerControlOptions`\n\nThe default options that correspond to the filter control type of a `DateTimePicker`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultdatetimepickercontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe date time picker type of the `DefaultDateTimePickerControlOptions`. Choose one of the following options:\n* `SINGLE_VALUED`: The filter condition is a fixed date.\n* `DATE_RANGE`: The filter condition is a date time range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_VALUED | DATE_RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_VALUED", "DATE_RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultdatetimepickercontroloptions.html#cfn-quicksight-dashboard-defaultdatetimepickercontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultdatetimepickercontroloptions.html#cfn-quicksight-dashboard-defaultdatetimepickercontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `DateTimePickerControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultdatetimepickercontroloptions.html#cfn-quicksight-dashboard-defaultdatetimepickercontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultFilterControlConfiguration`\n\nThe default configuration for all dependent controls of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html", "Properties": { "ControlOptions": { "MarkdownDocumentation": "`ControlOptions`\n\nThe control option for the `DefaultFilterControlConfiguration`.\n*Required*: Yes\n*Type*: [DefaultFilterControlOptions](./aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html#cfn-quicksight-dashboard-defaultfiltercontrolconfiguration-controloptions", "UpdateType": "Mutable", "Required": true, "Type": "DefaultFilterControlOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `DefaultFilterControlConfiguration`. This title is shared by all controls that are tied to this filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html#cfn-quicksight-dashboard-defaultfiltercontrolconfiguration-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DefaultFilterControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultFilterControlOptions`\n\nThe option that corresponds to the control type of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html", "Properties": { "DefaultSliderOptions": { "MarkdownDocumentation": "`DefaultSliderOptions`\n\nThe default options that correspond to the `Slider` filter control type.\n*Required*: No\n*Type*: [DefaultSliderControlOptions](./aws-properties-quicksight-dashboard-defaultslidercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-defaultfiltercontroloptions-defaultslideroptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSliderControlOptions" }, "DefaultRelativeDateTimeOptions": { "MarkdownDocumentation": "`DefaultRelativeDateTimeOptions`\n\nThe default options that correspond to the `RelativeDateTime` filter control type.\n*Required*: No\n*Type*: [DefaultRelativeDateTimeControlOptions](./aws-properties-quicksight-dashboard-defaultrelativedatetimecontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-defaultfiltercontroloptions-defaultrelativedatetimeoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultRelativeDateTimeControlOptions" }, "DefaultTextFieldOptions": { "MarkdownDocumentation": "`DefaultTextFieldOptions`\n\nThe default options that correspond to the `TextField` filter control type.\n*Required*: No\n*Type*: [DefaultTextFieldControlOptions](./aws-properties-quicksight-dashboard-defaulttextfieldcontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-defaultfiltercontroloptions-defaulttextfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultTextFieldControlOptions" }, "DefaultTextAreaOptions": { "MarkdownDocumentation": "`DefaultTextAreaOptions`\n\nThe default options that correspond to the `TextArea` filter control type.\n*Required*: No\n*Type*: [DefaultTextAreaControlOptions](./aws-properties-quicksight-dashboard-defaulttextareacontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-defaultfiltercontroloptions-defaulttextareaoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultTextAreaControlOptions" }, "DefaultDropdownOptions": { "MarkdownDocumentation": "`DefaultDropdownOptions`\n\nThe default options that correspond to the `Dropdown` filter control type.\n*Required*: No\n*Type*: [DefaultFilterDropDownControlOptions](./aws-properties-quicksight-dashboard-defaultfilterdropdowncontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-defaultfiltercontroloptions-defaultdropdownoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterDropDownControlOptions" }, "DefaultDateTimePickerOptions": { "MarkdownDocumentation": "`DefaultDateTimePickerOptions`\n\nThe default options that correspond to the filter control type of a `DateTimePicker`.\n*Required*: No\n*Type*: [DefaultDateTimePickerControlOptions](./aws-properties-quicksight-dashboard-defaultdatetimepickercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-defaultfiltercontroloptions-defaultdatetimepickeroptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultDateTimePickerControlOptions" }, "DefaultListOptions": { "MarkdownDocumentation": "`DefaultListOptions`\n\nThe default options that correspond to the `List` filter control type.\n*Required*: No\n*Type*: [DefaultFilterListControlOptions](./aws-properties-quicksight-dashboard-defaultfilterlistcontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-defaultfiltercontroloptions-defaultlistoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterListControlOptions" } } }, "AWS::QuickSight::Dashboard.DefaultFilterDropDownControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultFilterDropDownControlOptions`\n\nThe default options that correspond to the `Dropdown` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterdropdowncontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterdropdowncontroloptions.html#cfn-quicksight-dashboard-defaultfilterdropdowncontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-dashboard-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterdropdowncontroloptions.html#cfn-quicksight-dashboard-defaultfilterdropdowncontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterdropdowncontroloptions.html#cfn-quicksight-dashboard-defaultfilterdropdowncontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-dashboard-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterdropdowncontroloptions.html#cfn-quicksight-dashboard-defaultfilterdropdowncontroloptions-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Dashboard.DefaultFilterListControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultFilterListControlOptions`\n\nThe default options that correspond to the `List` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterlistcontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `DefaultFilterListControlOptions`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from the list.\n* `SINGLE_SELECT`: The user can select a single entry from the list.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterlistcontroloptions.html#cfn-quicksight-dashboard-defaultfilterlistcontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-dashboard-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterlistcontroloptions.html#cfn-quicksight-dashboard-defaultfilterlistcontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-dashboard-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterlistcontroloptions.html#cfn-quicksight-dashboard-defaultfilterlistcontroloptions-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Dashboard.DefaultFreeFormLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultFreeFormLayoutConfiguration`\n\nThe options that determine the default settings of a free-form layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfreeformlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a free-form layout.\n*Required*: Yes\n*Type*: [FreeFormLayoutCanvasSizeOptions](./aws-properties-quicksight-dashboard-freeformlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfreeformlayoutconfiguration.html#cfn-quicksight-dashboard-defaultfreeformlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "FreeFormLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Dashboard.DefaultGridLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultGridLayoutConfiguration`\n\nThe options that determine the default settings for a grid layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultgridlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a grid layout.\n*Required*: Yes\n*Type*: [GridLayoutCanvasSizeOptions](./aws-properties-quicksight-dashboard-gridlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultgridlayoutconfiguration.html#cfn-quicksight-dashboard-defaultgridlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "GridLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Dashboard.DefaultInteractiveLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultInteractiveLayoutConfiguration`\n\nThe options that determine the default settings for interactive layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultinteractivelayoutconfiguration.html", "Properties": { "FreeForm": { "MarkdownDocumentation": "`FreeForm`\n\nThe options that determine the default settings of a free-form layout configuration.\n*Required*: No\n*Type*: [DefaultFreeFormLayoutConfiguration](./aws-properties-quicksight-dashboard-defaultfreeformlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultinteractivelayoutconfiguration.html#cfn-quicksight-dashboard-defaultinteractivelayoutconfiguration-freeform", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFreeFormLayoutConfiguration" }, "Grid": { "MarkdownDocumentation": "`Grid`\n\nThe options that determine the default settings for a grid layout configuration.\n*Required*: No\n*Type*: [DefaultGridLayoutConfiguration](./aws-properties-quicksight-dashboard-defaultgridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultinteractivelayoutconfiguration.html#cfn-quicksight-dashboard-defaultinteractivelayoutconfiguration-grid", "UpdateType": "Mutable", "Required": false, "Type": "DefaultGridLayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.DefaultNewSheetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultNewSheetConfiguration`\n\nThe configuration for default new sheet settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultnewsheetconfiguration.html", "Properties": { "SheetContentType": { "MarkdownDocumentation": "`SheetContentType`\n\nThe option that determines the sheet content type.\n*Required*: No\n*Type*: String\n*Allowed values*: `PAGINATED | INTERACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PAGINATED", "INTERACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultnewsheetconfiguration.html#cfn-quicksight-dashboard-defaultnewsheetconfiguration-sheetcontenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InteractiveLayoutConfiguration": { "MarkdownDocumentation": "`InteractiveLayoutConfiguration`\n\nThe options that determine the default settings for interactive layout configuration.\n*Required*: No\n*Type*: [DefaultInteractiveLayoutConfiguration](./aws-properties-quicksight-dashboard-defaultinteractivelayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultnewsheetconfiguration.html#cfn-quicksight-dashboard-defaultnewsheetconfiguration-interactivelayoutconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultInteractiveLayoutConfiguration" }, "PaginatedLayoutConfiguration": { "MarkdownDocumentation": "`PaginatedLayoutConfiguration`\n\nThe options that determine the default settings for a paginated layout configuration.\n*Required*: No\n*Type*: [DefaultPaginatedLayoutConfiguration](./aws-properties-quicksight-dashboard-defaultpaginatedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultnewsheetconfiguration.html#cfn-quicksight-dashboard-defaultnewsheetconfiguration-paginatedlayoutconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultPaginatedLayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.DefaultPaginatedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultPaginatedLayoutConfiguration`\n\nThe options that determine the default settings for a paginated layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultpaginatedlayoutconfiguration.html", "Properties": { "SectionBased": { "MarkdownDocumentation": "`SectionBased`\n\nThe options that determine the default settings for a section-based layout configuration.\n*Required*: No\n*Type*: [DefaultSectionBasedLayoutConfiguration](./aws-properties-quicksight-dashboard-defaultsectionbasedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultpaginatedlayoutconfiguration.html#cfn-quicksight-dashboard-defaultpaginatedlayoutconfiguration-sectionbased", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSectionBasedLayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.DefaultRelativeDateTimeControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultRelativeDateTimeControlOptions`\n\nThe default options that correspond to the `RelativeDateTime` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultrelativedatetimecontroloptions.html", "Properties": { "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [RelativeDateTimeControlDisplayOptions](./aws-properties-quicksight-dashboard-relativedatetimecontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultrelativedatetimecontroloptions.html#cfn-quicksight-dashboard-defaultrelativedatetimecontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDateTimeControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `RelativeDateTimeControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultrelativedatetimecontroloptions.html#cfn-quicksight-dashboard-defaultrelativedatetimecontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DefaultSectionBasedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultSectionBasedLayoutConfiguration`\n\nThe options that determine the default settings for a section-based layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultsectionbasedlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a section-based layout.\n*Required*: Yes\n*Type*: [SectionBasedLayoutCanvasSizeOptions](./aws-properties-quicksight-dashboard-sectionbasedlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultsectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-defaultsectionbasedlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "SectionBasedLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Dashboard.DefaultSliderControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultSliderControlOptions`\n\nThe default options that correspond to the `Slider` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultslidercontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `DefaultSliderControlOptions`. Choose one of the following options:\n* `SINGLE_POINT`: Filter against(equals) a single data point.\n* `RANGE`: Filter data that is in a specified range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_POINT | RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_POINT", "RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-defaultslidercontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-defaultslidercontroloptions-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-dashboard-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-defaultslidercontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-defaultslidercontroloptions-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-defaultslidercontroloptions-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.DefaultTextAreaControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultTextAreaControlOptions`\n\nThe default options that correspond to the `TextArea` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaulttextareacontroloptions.html", "Properties": { "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaulttextareacontroloptions.html#cfn-quicksight-dashboard-defaulttextareacontroloptions-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-dashboard-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaulttextareacontroloptions.html#cfn-quicksight-dashboard-defaulttextareacontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" } } }, "AWS::QuickSight::Dashboard.DefaultTextFieldControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DefaultTextFieldControlOptions`\n\nThe default options that correspond to the `TextField` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaulttextfieldcontroloptions.html", "Properties": { "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-dashboard-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaulttextfieldcontroloptions.html#cfn-quicksight-dashboard-defaulttextfieldcontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" } } }, "AWS::QuickSight::Dashboard.DestinationParameterValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DestinationParameterValueConfiguration`\n\nThe configuration of destination parameter values.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html", "Properties": { "CustomValuesConfiguration": { "MarkdownDocumentation": "`CustomValuesConfiguration`\n\nThe configuration of custom values for destination parameter in `DestinationParameterValueConfiguration`.\n*Required*: No\n*Type*: [CustomValuesConfiguration](./aws-properties-quicksight-dashboard-customvaluesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-customvaluesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomValuesConfiguration" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the destination parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-sourceparametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectAllValueOptions": { "MarkdownDocumentation": "`SelectAllValueOptions`\n\nThe configuration that selects all options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VALUES`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-selectallvalueoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceField": { "MarkdownDocumentation": "`SourceField`\n\nThe source field ID of the destination parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-sourcefield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceColumn": { "MarkdownDocumentation": "`SourceColumn`\n\nA column of a data set.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-sourcecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Dashboard.DimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DimensionField`\n\nThe dimension type field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dimensionfield.html", "Properties": { "DateDimensionField": { "MarkdownDocumentation": "`DateDimensionField`\n\nThe dimension type field with date type columns.\n*Required*: No\n*Type*: [DateDimensionField](./aws-properties-quicksight-dashboard-datedimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dimensionfield.html#cfn-quicksight-dashboard-dimensionfield-datedimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "DateDimensionField" }, "NumericalDimensionField": { "MarkdownDocumentation": "`NumericalDimensionField`\n\nThe dimension type field with numerical type columns.\n*Required*: No\n*Type*: [NumericalDimensionField](./aws-properties-quicksight-dashboard-numericaldimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dimensionfield.html#cfn-quicksight-dashboard-dimensionfield-numericaldimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "NumericalDimensionField" }, "CategoricalDimensionField": { "MarkdownDocumentation": "`CategoricalDimensionField`\n\nThe dimension type field with categorical type columns.\n*Required*: No\n*Type*: [CategoricalDimensionField](./aws-properties-quicksight-dashboard-categoricaldimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dimensionfield.html#cfn-quicksight-dashboard-dimensionfield-categoricaldimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "CategoricalDimensionField" } } }, "AWS::QuickSight::Dashboard.DonutCenterOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DonutCenterOptions`\n\nThe label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-donutcenteroptions.html", "Properties": { "LabelVisibility": { "MarkdownDocumentation": "`LabelVisibility`\n\nDetermines the visibility of the label in a donut chart. In the Quick Sight console, this option is called `'Show total'`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-donutcenteroptions.html#cfn-quicksight-dashboard-donutcenteroptions-labelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.DonutOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DonutOptions`\n\nThe options for configuring a donut chart or pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-donutoptions.html", "Properties": { "DonutCenterOptions": { "MarkdownDocumentation": "`DonutCenterOptions`\n\nThe label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.\n*Required*: No\n*Type*: [DonutCenterOptions](./aws-properties-quicksight-dashboard-donutcenteroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-donutoptions.html#cfn-quicksight-dashboard-donutoptions-donutcenteroptions", "UpdateType": "Mutable", "Required": false, "Type": "DonutCenterOptions" }, "ArcOptions": { "MarkdownDocumentation": "`ArcOptions`\n\nThe option for define the arc of the chart shape. Valid values are as follows:\n* `WHOLE` - A pie chart\n* `SMALL`- A small-sized donut chart\n* `MEDIUM`- A medium-sized donut chart\n* `LARGE`- A large-sized donut chart\n*Required*: No\n*Type*: [ArcOptions](./aws-properties-quicksight-dashboard-arcoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-donutoptions.html#cfn-quicksight-dashboard-donutoptions-arcoptions", "UpdateType": "Mutable", "Required": false, "Type": "ArcOptions" } } }, "AWS::QuickSight::Dashboard.DrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DrillDownFilter`\n\nThe drill down filter for the column hierarchies.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-drilldownfilter.html", "Properties": { "NumericEqualityFilter": { "MarkdownDocumentation": "`NumericEqualityFilter`\n\nThe numeric equality type drill down filter. This filter is used for number type columns.\n*Required*: No\n*Type*: [NumericEqualityDrillDownFilter](./aws-properties-quicksight-dashboard-numericequalitydrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-drilldownfilter.html#cfn-quicksight-dashboard-drilldownfilter-numericequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericEqualityDrillDownFilter" }, "TimeRangeFilter": { "MarkdownDocumentation": "`TimeRangeFilter`\n\nThe time range drill down filter. This filter is used for date time columns.\n*Required*: No\n*Type*: [TimeRangeDrillDownFilter](./aws-properties-quicksight-dashboard-timerangedrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-drilldownfilter.html#cfn-quicksight-dashboard-drilldownfilter-timerangefilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeDrillDownFilter" }, "CategoryFilter": { "MarkdownDocumentation": "`CategoryFilter`\n\nThe category type drill down filter. This filter is used for string type columns.\n*Required*: No\n*Type*: [CategoryDrillDownFilter](./aws-properties-quicksight-dashboard-categorydrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-drilldownfilter.html#cfn-quicksight-dashboard-drilldownfilter-categoryfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryDrillDownFilter" } } }, "AWS::QuickSight::Dashboard.DropDownControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DropDownControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dropdowncontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dropdowncontroldisplayoptions.html#cfn-quicksight-dashboard-dropdowncontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nThe configuration of the `Select all` options in a\ndropdown control.\n*Required*: No\n*Type*: [ListControlSelectAllOptions](./aws-properties-quicksight-dashboard-listcontrolselectalloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dropdowncontroldisplayoptions.html#cfn-quicksight-dashboard-dropdowncontroldisplayoptions-selectalloptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSelectAllOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dropdowncontroldisplayoptions.html#cfn-quicksight-dashboard-dropdowncontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Dashboard.DynamicDefaultValue": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.DynamicDefaultValue`\n\nDefines different defaults to the users or groups based on mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dynamicdefaultvalue.html", "Properties": { "GroupNameColumn": { "MarkdownDocumentation": "`GroupNameColumn`\n\nThe column that contains the group name.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dynamicdefaultvalue.html#cfn-quicksight-dashboard-dynamicdefaultvalue-groupnamecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" }, "DefaultValueColumn": { "MarkdownDocumentation": "`DefaultValueColumn`\n\nThe column that contains the default value of each user or group.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dynamicdefaultvalue.html#cfn-quicksight-dashboard-dynamicdefaultvalue-defaultvaluecolumn", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "UserNameColumn": { "MarkdownDocumentation": "`UserNameColumn`\n\nThe column that contains the username.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dynamicdefaultvalue.html#cfn-quicksight-dashboard-dynamicdefaultvalue-usernamecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Dashboard.EmptyVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.EmptyVisual`\n\nAn empty visual.\nEmpty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an `EmptyVisual` until a visual type is selected.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-emptyvisual.html", "Properties": { "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-emptyvisual.html#cfn-quicksight-dashboard-emptyvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-emptyvisual.html#cfn-quicksight-dashboard-emptyvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in the empty visual. Every visual requires a dataset to render.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-emptyvisual.html#cfn-quicksight-dashboard-emptyvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.Entity": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.Entity`\n\nAn object, structure, or sub-structure of an analysis, template, or dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-entity.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe hierarchical path of the entity within the analysis, template, or dashboard definition tree.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-entity.html#cfn-quicksight-dashboard-entity-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ExcludePeriodConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ExcludePeriodConfiguration`\n\nThe exclude period of `TimeRangeFilter` or `RelativeDatesFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-excludeperiodconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the exclude period. Choose from the following options:\n* `ENABLED`\n* `DISABLED`\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-excludeperiodconfiguration.html#cfn-quicksight-dashboard-excludeperiodconfiguration-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Amount": { "MarkdownDocumentation": "`Amount`\n\nThe amount or number of the exclude period.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-excludeperiodconfiguration.html#cfn-quicksight-dashboard-excludeperiodconfiguration-amount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Granularity": { "MarkdownDocumentation": "`Granularity`\n\nThe granularity or unit (day, month, year) of the exclude period.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-excludeperiodconfiguration.html#cfn-quicksight-dashboard-excludeperiodconfiguration-granularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ExecutiveSummaryOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ExecutiveSummaryOption`\n\nData stories sharing option.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-executivesummaryoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nAvailability status.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-executivesummaryoption.html#cfn-quicksight-dashboard-executivesummaryoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ExplicitHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ExplicitHierarchy`\n\nThe option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-explicithierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the explicit hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-explicithierarchy.html#cfn-quicksight-dashboard-explicithierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the explicit hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-dashboard-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-explicithierarchy.html#cfn-quicksight-dashboard-explicithierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe list of columns that define the explicit hierarchy.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-explicithierarchy.html#cfn-quicksight-dashboard-explicithierarchy-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ExportHiddenFieldsOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ExportHiddenFieldsOption`\n\nDetermines if hidden fields are included in an exported dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exporthiddenfieldsoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe status of the export hidden fields options of a dashbaord.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exporthiddenfieldsoption.html#cfn-quicksight-dashboard-exporthiddenfieldsoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ExportToCSVOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ExportToCSVOption`\n\nExport to .csv option.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exporttocsvoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nAvailability status.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exporttocsvoption.html#cfn-quicksight-dashboard-exporttocsvoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ExportWithHiddenFieldsOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ExportWithHiddenFieldsOption`\n\nDetermines whether or not hidden fields are visible on exported dashbaords.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exportwithhiddenfieldsoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe status of the export with hidden fields options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exportwithhiddenfieldsoption.html#cfn-quicksight-dashboard-exportwithhiddenfieldsoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FieldBasedTooltip": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FieldBasedTooltip`\n\nThe setup for the detailed tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html", "Properties": { "TooltipFields": { "MarkdownDocumentation": "`TooltipFields`\n\nThe fields configuration in the\ntooltip.\n*Required*: No\n*Type*: Array of [TooltipItem](./aws-properties-quicksight-dashboard-tooltipitem.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html#cfn-quicksight-dashboard-fieldbasedtooltip-tooltipfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TooltipItem", "DuplicatesAllowed": true }, "AggregationVisibility": { "MarkdownDocumentation": "`AggregationVisibility`\n\nThe visibility of `Show aggregations`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html#cfn-quicksight-dashboard-fieldbasedtooltip-aggregationvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipTitleType": { "MarkdownDocumentation": "`TooltipTitleType`\n\nThe type for the >tooltip title. Choose one of the following options:\n* `NONE`: Doesn't use the primary value as the title.\n* `PRIMARY_VALUE`: Uses primary value as the title.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | PRIMARY_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "PRIMARY_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html#cfn-quicksight-dashboard-fieldbasedtooltip-tooltiptitletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FieldLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FieldLabelType`\n\nThe field label type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldlabeltype.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nIndicates the field that is targeted by the field\nlabel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldlabeltype.html#cfn-quicksight-dashboard-fieldlabeltype-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the field label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldlabeltype.html#cfn-quicksight-dashboard-fieldlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FieldSeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FieldSeriesItem`\n\nThe field series item configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldseriesitem.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field for which you are setting the axis binding.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldseriesitem.html#cfn-quicksight-dashboard-fieldseriesitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis that you are binding the field to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldseriesitem.html#cfn-quicksight-dashboard-fieldseriesitem-axisbinding", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nThe options that determine the presentation of line series associated to the field.\n*Required*: No\n*Type*: [LineChartSeriesSettings](./aws-properties-quicksight-dashboard-linechartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldseriesitem.html#cfn-quicksight-dashboard-fieldseriesitem-settings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSeriesSettings" } } }, "AWS::QuickSight::Dashboard.FieldSort": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FieldSort`\n\nThe sort configuration for a field in a\nfield well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldsort.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe sort configuration target field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldsort.html#cfn-quicksight-dashboard-fieldsort-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe sort direction. Choose one of the following\noptions:\n* `ASC`: Ascending\n* `DESC`: Descending\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldsort.html#cfn-quicksight-dashboard-fieldsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FieldSortOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FieldSortOptions`\n\nThe field sort options in a chart configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldsortoptions.html", "Properties": { "FieldSort": { "MarkdownDocumentation": "`FieldSort`\n\nThe sort configuration for a field in a field well.\n*Required*: No\n*Type*: [FieldSort](./aws-properties-quicksight-dashboard-fieldsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldsortoptions.html#cfn-quicksight-dashboard-fieldsortoptions-fieldsort", "UpdateType": "Mutable", "Required": false, "Type": "FieldSort" }, "ColumnSort": { "MarkdownDocumentation": "`ColumnSort`\n\nThe sort configuration for a column that is not used in a field well.\n*Required*: No\n*Type*: [ColumnSort](./aws-properties-quicksight-dashboard-columnsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldsortoptions.html#cfn-quicksight-dashboard-fieldsortoptions-columnsort", "UpdateType": "Mutable", "Required": false, "Type": "ColumnSort" } } }, "AWS::QuickSight::Dashboard.FieldTooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FieldTooltipItem`\n\nThe tooltip item for the fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html", "Properties": { "TooltipTarget": { "MarkdownDocumentation": "`TooltipTarget`\n\nDetermines the target of the field tooltip item in a combo chart visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `BOTH | BAR | LINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BOTH", "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-tooltiptarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe unique ID of the field that is targeted by the tooltip.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label of the tooltip item.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip item.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilledMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilledMapAggregatedFieldWells`\n\nThe aggregated field well of the filled map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe aggregated color field well of a filled map. Values are aggregated based on location fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapaggregatedfieldwells.html#cfn-quicksight-dashboard-filledmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Geospatial": { "MarkdownDocumentation": "`Geospatial`\n\nThe aggregated location field well of the filled map. Values are grouped by location fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapaggregatedfieldwells.html#cfn-quicksight-dashboard-filledmapaggregatedfieldwells-geospatial", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.FilledMapConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilledMapConditionalFormatting`\n\nThe conditional formatting of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options of a `FilledMapVisual`.\n*Required*: Yes\n*Type*: Array of [FilledMapConditionalFormattingOption](./aws-properties-quicksight-dashboard-filledmapconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconditionalformatting.html#cfn-quicksight-dashboard-filledmapconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FilledMapConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.FilledMapConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilledMapConditionalFormattingOption`\n\nConditional formatting options of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconditionalformattingoption.html", "Properties": { "Shape": { "MarkdownDocumentation": "`Shape`\n\nThe conditional formatting that determines the shape of the filled map.\n*Required*: Yes\n*Type*: [FilledMapShapeConditionalFormatting](./aws-properties-quicksight-dashboard-filledmapshapeconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconditionalformattingoption.html#cfn-quicksight-dashboard-filledmapconditionalformattingoption-shape", "UpdateType": "Mutable", "Required": true, "Type": "FilledMapShapeConditionalFormatting" } } }, "AWS::QuickSight::Dashboard.FilledMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilledMapConfiguration`\n\nThe configuration for a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `FilledMapVisual`.\n*Required*: No\n*Type*: [FilledMapSortConfiguration](./aws-properties-quicksight-dashboard-filledmapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "MapStyleOptions": { "MarkdownDocumentation": "`MapStyleOptions`\n\nThe map style options of the filled map visual.\n*Required*: No\n*Type*: [GeospatialMapStyleOptions](./aws-properties-quicksight-dashboard-geospatialmapstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-mapstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapStyleOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [FilledMapFieldWells](./aws-properties-quicksight-dashboard-filledmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "WindowOptions": { "MarkdownDocumentation": "`WindowOptions`\n\nThe window options of the filled map visual.\n*Required*: No\n*Type*: [GeospatialWindowOptions](./aws-properties-quicksight-dashboard-geospatialwindowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-windowoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialWindowOptions" } } }, "AWS::QuickSight::Dashboard.FilledMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilledMapFieldWells`\n\nThe field wells of a `FilledMapVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapfieldwells.html", "Properties": { "FilledMapAggregatedFieldWells": { "MarkdownDocumentation": "`FilledMapAggregatedFieldWells`\n\nThe aggregated field well of the filled map.\n*Required*: No\n*Type*: [FilledMapAggregatedFieldWells](./aws-properties-quicksight-dashboard-filledmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapfieldwells.html#cfn-quicksight-dashboard-filledmapfieldwells-filledmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.FilledMapShapeConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilledMapShapeConditionalFormatting`\n\nThe conditional formatting that determines the shape of the filled map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapshapeconditionalformatting.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe conditional formatting that determines the background color of a filled map's shape.\n*Required*: No\n*Type*: [ShapeConditionalFormat](./aws-properties-quicksight-dashboard-shapeconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapshapeconditionalformatting.html#cfn-quicksight-dashboard-filledmapshapeconditionalformatting-format", "UpdateType": "Mutable", "Required": false, "Type": "ShapeConditionalFormat" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the filled map shape.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapshapeconditionalformatting.html#cfn-quicksight-dashboard-filledmapshapeconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilledMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilledMapSortConfiguration`\n\nThe sort configuration of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapsortconfiguration.html", "Properties": { "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the location fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapsortconfiguration.html#cfn-quicksight-dashboard-filledmapsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.FilledMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilledMapVisual`\n\nA filled map.\nFor more information, see [Creating filled maps](https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a `FilledMapVisual`.\n*Required*: No\n*Type*: [FilledMapConditionalFormatting](./aws-properties-quicksight-dashboard-filledmapconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [FilledMapConfiguration](./aws-properties-quicksight-dashboard-filledmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.Filter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.Filter`\n\nWith a `Filter`, you can remove portions of data from a particular visual or view.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html", "Properties": { "NestedFilter": { "MarkdownDocumentation": "`NestedFilter`\n\nA `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.\n*Required*: No\n*Type*: [NestedFilter](./aws-properties-quicksight-dashboard-nestedfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-nestedfilter", "UpdateType": "Mutable", "Required": false, "Type": "NestedFilter" }, "NumericEqualityFilter": { "MarkdownDocumentation": "`NumericEqualityFilter`\n\nA `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value.\n*Required*: No\n*Type*: [NumericEqualityFilter](./aws-properties-quicksight-dashboard-numericequalityfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-numericequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericEqualityFilter" }, "NumericRangeFilter": { "MarkdownDocumentation": "`NumericRangeFilter`\n\nA `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range.\n*Required*: No\n*Type*: [NumericRangeFilter](./aws-properties-quicksight-dashboard-numericrangefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-numericrangefilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilter" }, "TimeRangeFilter": { "MarkdownDocumentation": "`TimeRangeFilter`\n\nA `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range.\n*Required*: No\n*Type*: [TimeRangeFilter](./aws-properties-quicksight-dashboard-timerangefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-timerangefilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilter" }, "RelativeDatesFilter": { "MarkdownDocumentation": "`RelativeDatesFilter`\n\nA `RelativeDatesFilter` filters date values that are relative to a given date.\n*Required*: No\n*Type*: [RelativeDatesFilter](./aws-properties-quicksight-dashboard-relativedatesfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-relativedatesfilter", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDatesFilter" }, "TopBottomFilter": { "MarkdownDocumentation": "`TopBottomFilter`\n\nA `TopBottomFilter` filters data to the top or bottom values for a given column.\n*Required*: No\n*Type*: [TopBottomFilter](./aws-properties-quicksight-dashboard-topbottomfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-topbottomfilter", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomFilter" }, "TimeEqualityFilter": { "MarkdownDocumentation": "`TimeEqualityFilter`\n\nA `TimeEqualityFilter` filters date-time values that equal or do not equal\na given date/time value.\n*Required*: No\n*Type*: [TimeEqualityFilter](./aws-properties-quicksight-dashboard-timeequalityfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-timeequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeEqualityFilter" }, "CategoryFilter": { "MarkdownDocumentation": "`CategoryFilter`\n\nA `CategoryFilter` filters text values.\nFor more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [CategoryFilter](./aws-properties-quicksight-dashboard-categoryfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-categoryfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryFilter" } } }, "AWS::QuickSight::Dashboard.FilterControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterControl`\n\nThe control of a filter that is used to interact with a dashboard or an analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html", "Properties": { "Slider": { "MarkdownDocumentation": "`Slider`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n*Required*: No\n*Type*: [FilterSliderControl](./aws-properties-quicksight-dashboard-filterslidercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-slider", "UpdateType": "Mutable", "Required": false, "Type": "FilterSliderControl" }, "TextArea": { "MarkdownDocumentation": "`TextArea`\n\nA control to display a text box that is used to enter multiple entries.\n*Required*: No\n*Type*: [FilterTextAreaControl](./aws-properties-quicksight-dashboard-filtertextareacontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-textarea", "UpdateType": "Mutable", "Required": false, "Type": "FilterTextAreaControl" }, "Dropdown": { "MarkdownDocumentation": "`Dropdown`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n*Required*: No\n*Type*: [FilterDropDownControl](./aws-properties-quicksight-dashboard-filterdropdowncontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-dropdown", "UpdateType": "Mutable", "Required": false, "Type": "FilterDropDownControl" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nA control to display a text box that is used to enter a single entry.\n*Required*: No\n*Type*: [FilterTextFieldControl](./aws-properties-quicksight-dashboard-filtertextfieldcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-textfield", "UpdateType": "Mutable", "Required": false, "Type": "FilterTextFieldControl" }, "List": { "MarkdownDocumentation": "`List`\n\nA control to display a list of buttons or boxes. This is used to select either a single value or multiple values.\n*Required*: No\n*Type*: [FilterListControl](./aws-properties-quicksight-dashboard-filterlistcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-list", "UpdateType": "Mutable", "Required": false, "Type": "FilterListControl" }, "DateTimePicker": { "MarkdownDocumentation": "`DateTimePicker`\n\nA control from a date filter that is used to specify date and time.\n*Required*: No\n*Type*: [FilterDateTimePickerControl](./aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-datetimepicker", "UpdateType": "Mutable", "Required": false, "Type": "FilterDateTimePickerControl" }, "RelativeDateTime": { "MarkdownDocumentation": "`RelativeDateTime`\n\nA control from a date filter that is used to specify the relative date.\n*Required*: No\n*Type*: [FilterRelativeDateTimeControl](./aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-relativedatetime", "UpdateType": "Mutable", "Required": false, "Type": "FilterRelativeDateTimeControl" }, "CrossSheet": { "MarkdownDocumentation": "`CrossSheet`\n\nA control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet\n*Required*: No\n*Type*: [FilterCrossSheetControl](./aws-properties-quicksight-dashboard-filtercrosssheetcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-crosssheet", "UpdateType": "Mutable", "Required": false, "Type": "FilterCrossSheetControl" } } }, "AWS::QuickSight::Dashboard.FilterCrossSheetControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterCrossSheetControl`\n\nA control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercrosssheetcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterCrossSheetControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercrosssheetcontrol.html#cfn-quicksight-dashboard-filtercrosssheetcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-dashboard-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercrosssheetcontrol.html#cfn-quicksight-dashboard-filtercrosssheetcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterCrossSheetControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercrosssheetcontrol.html#cfn-quicksight-dashboard-filtercrosssheetcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilterDateTimePickerControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterDateTimePickerControl`\n\nA control from a date filter that is used to specify date and time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_VALUED | DATE_RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_VALUED", "DATE_RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterDateTimePickerControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configurationof the Apply button on a `DateTimePickerControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilterDropDownControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterDropDownControl`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of the `FilterDropDownControl`.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-dashboard-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-dashboard-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterDropDownControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-dashboard-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Dashboard.FilterGroup": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterGroup`\n\nA grouping of individual filters. Filter groups are applied to the same group of visuals.\nFor more information, see [Adding filter conditions (group filters) with AND and OR operators](https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtergroup.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the `FilterGroup`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtergroup.html#cfn-quicksight-dashboard-filtergroup-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe list of filters that are present in a `FilterGroup`.\n*Required*: Yes\n*Type*: Array of [Filter](./aws-properties-quicksight-dashboard-filter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtergroup.html#cfn-quicksight-dashboard-filtergroup-filters", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": true }, "CrossDataset": { "MarkdownDocumentation": "`CrossDataset`\n\nThe filter new feature which can apply filter group to all data sets. Choose one of the following options:\n* `ALL_DATASETS`\n* `SINGLE_DATASET`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_DATASETS | SINGLE_DATAS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_DATASETS", "SINGLE_DATASET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtergroup.html#cfn-quicksight-dashboard-filtergroup-crossdataset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ScopeConfiguration": { "MarkdownDocumentation": "`ScopeConfiguration`\n\nThe configuration that specifies what scope to apply to a `FilterGroup`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: [FilterScopeConfiguration](./aws-properties-quicksight-dashboard-filterscopeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtergroup.html#cfn-quicksight-dashboard-filtergroup-scopeconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterScopeConfiguration" }, "FilterGroupId": { "MarkdownDocumentation": "`FilterGroupId`\n\nThe value that uniquely identifies a `FilterGroup` within a dashboard, template, or analysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtergroup.html#cfn-quicksight-dashboard-filtergroup-filtergroupid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilterListConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterListConfiguration`\n\nA list of filter configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html", "Properties": { "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nThe list of category values for the filter.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-categoryvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-nulloption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilterListControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterListControl`\n\nA control to display a list of buttons or boxes. This is used to select either a single value or multiple values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterListControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from the list.\n* `SINGLE_SELECT`: The user can select a single entry from the list.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-dashboard-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-dashboard-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterListControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-dashboard-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Dashboard.FilterOperationSelectedFieldsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterOperationSelectedFieldsConfiguration`\n\nThe configuration of selected fields in the`CustomActionFilterOperation`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filteroperationselectedfieldsconfiguration.html", "Properties": { "SelectedColumns": { "MarkdownDocumentation": "`SelectedColumns`\n\nThe selected columns of a dataset.\n*Required*: No\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-dashboard-filteroperationselectedfieldsconfiguration-selectedcolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true }, "SelectedFields": { "MarkdownDocumentation": "`SelectedFields`\n\nChooses the fields that are filtered in `CustomActionFilterOperation`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `512 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-dashboard-filteroperationselectedfieldsconfiguration-selectedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nA structure that contains the options that choose which fields are filtered in the `CustomActionFilterOperation`.\nValid values are defined as follows:\n* `ALL_FIELDS`: Applies the filter operation to all fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_FIELDS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL_FIELDS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-dashboard-filteroperationselectedfieldsconfiguration-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilterOperationTargetVisualsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterOperationTargetVisualsConfiguration`\n\nThe configuration of target visuals that you want to be filtered.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filteroperationtargetvisualsconfiguration.html", "Properties": { "SameSheetTargetVisualConfiguration": { "MarkdownDocumentation": "`SameSheetTargetVisualConfiguration`\n\nThe configuration of the same-sheet target visuals that you want to be filtered.\n*Required*: No\n*Type*: [SameSheetTargetVisualConfiguration](./aws-properties-quicksight-dashboard-samesheettargetvisualconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filteroperationtargetvisualsconfiguration.html#cfn-quicksight-dashboard-filteroperationtargetvisualsconfiguration-samesheettargetvisualconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SameSheetTargetVisualConfiguration" } } }, "AWS::QuickSight::Dashboard.FilterRelativeDateTimeControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterRelativeDateTimeControl`\n\nA control from a date filter that is used to specify the relative date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [RelativeDateTimeControlDisplayOptions](./aws-properties-quicksight-dashboard-relativedatetimecontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDateTimeControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterRelativeDateTimeControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilterScopeConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterScopeConfiguration`\n\nThe scope configuration for a `FilterGroup`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterscopeconfiguration.html", "Properties": { "AllSheets": { "MarkdownDocumentation": "`AllSheets`\n\nThe configuration that applies a filter to all sheets. When you choose `AllSheets` as the value for a `FilterScopeConfiguration`, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The `AllSheetsFilterScopeConfiguration` is chosen.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterscopeconfiguration.html#cfn-quicksight-dashboard-filterscopeconfiguration-allsheets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "SelectedSheets": { "MarkdownDocumentation": "`SelectedSheets`\n\nThe configuration for applying a filter to specific sheets.\n*Required*: No\n*Type*: [SelectedSheetsFilterScopeConfiguration](./aws-properties-quicksight-dashboard-selectedsheetsfilterscopeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterscopeconfiguration.html#cfn-quicksight-dashboard-filterscopeconfiguration-selectedsheets", "UpdateType": "Mutable", "Required": false, "Type": "SelectedSheetsFilterScopeConfiguration" } } }, "AWS::QuickSight::Dashboard.FilterSelectableValues": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterSelectableValues`\n\nA list of selectable values that are used in a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterselectablevalues.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are used in the `FilterSelectableValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterselectablevalues.html#cfn-quicksight-dashboard-filterselectablevalues-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.FilterSliderControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterSliderControl`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterSliderControl`. Choose one of the following options:\n* `SINGLE_POINT`: Filter against(equals) a single data point.\n* `RANGE`: Filter data that is in a specified range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_POINT | RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_POINT", "RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-dashboard-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterSliderControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.FilterTextAreaControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterTextAreaControl`\n\nA control to display a text box that is used to enter multiple entries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-dashboard-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FilterTextFieldControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FilterTextFieldControl`\n\nA control to display a text box that is used to enter a single entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextfieldcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextfieldcontrol.html#cfn-quicksight-dashboard-filtertextfieldcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-dashboard-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextfieldcontrol.html#cfn-quicksight-dashboard-filtertextfieldcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextFieldControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextfieldcontrol.html#cfn-quicksight-dashboard-filtertextfieldcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextfieldcontrol.html#cfn-quicksight-dashboard-filtertextfieldcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FontConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FontConfiguration`\n\nConfigures the display properties of the given text.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html", "Properties": { "FontFamily": { "MarkdownDocumentation": "`FontFamily`\n\nThe font family that you want 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-fontconfiguration-fontfamily", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontStyle": { "MarkdownDocumentation": "`FontStyle`\n\nDetermines the text display face that is inherited by the given font family.\n*Required*: No\n*Type*: String\n*Allowed values*: `NORMAL | ITALIC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NORMAL", "ITALIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-fontconfiguration-fontstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontSize": { "MarkdownDocumentation": "`FontSize`\n\nThe option that determines the text display size.\n*Required*: No\n*Type*: [FontSize](./aws-properties-quicksight-dashboard-fontsize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-fontconfiguration-fontsize", "UpdateType": "Mutable", "Required": false, "Type": "FontSize" }, "FontDecoration": { "MarkdownDocumentation": "`FontDecoration`\n\nDetermines the appearance of decorative lines on the text.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNDERLINE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNDERLINE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-fontconfiguration-fontdecoration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontColor": { "MarkdownDocumentation": "`FontColor`\n\nDetermines the color of the text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-fontconfiguration-fontcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontWeight": { "MarkdownDocumentation": "`FontWeight`\n\nThe option that determines the text display weight, or boldness.\n*Required*: No\n*Type*: [FontWeight](./aws-properties-quicksight-dashboard-fontweight.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-fontconfiguration-fontweight", "UpdateType": "Mutable", "Required": false, "Type": "FontWeight" } } }, "AWS::QuickSight::Dashboard.FontSize": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FontSize`\n\nThe option that determines the text display size.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontsize.html", "Properties": { "Relative": { "MarkdownDocumentation": "`Relative`\n\nThe lexical name for the text size, proportional to its surrounding context.\n*Required*: No\n*Type*: String\n*Allowed values*: `EXTRA_SMALL | SMALL | MEDIU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontsize.html#cfn-quicksight-dashboard-fontsize-relative", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Absolute": { "MarkdownDocumentation": "`Absolute`\n\nThe font size that you want to use in px.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontsize.html#cfn-quicksight-dashboard-fontsize-absolute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FontWeight": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FontWeight`\n\nThe option that determines the text display weight, or boldness.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontweight.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe lexical name for the level of boldness of the text display.\n*Required*: No\n*Type*: String\n*Allowed values*: `NORMAL | BOLD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NORMAL", "BOLD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontweight.html#cfn-quicksight-dashboard-fontweight-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ForecastComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ForecastComputation`\n\nThe forecast computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html", "Properties": { "PeriodsBackward": { "MarkdownDocumentation": "`PeriodsBackward`\n\nThe periods backward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-periodsbackward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PeriodsForward": { "MarkdownDocumentation": "`PeriodsForward`\n\nThe periods forward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-periodsforward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PredictionInterval": { "MarkdownDocumentation": "`PredictionInterval`\n\nThe prediction interval setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `50`\n*Maximum*: `95`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-predictioninterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Seasonality": { "MarkdownDocumentation": "`Seasonality`\n\nThe seasonality setup of a forecast computation. Choose one of the following options:\n* `AUTOMATIC`\n* `CUSTOM`: Checks the custom seasonality value.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTOMATIC | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-seasonality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomSeasonalityValue": { "MarkdownDocumentation": "`CustomSeasonalityValue`\n\nThe custom seasonality value setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `180`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-customseasonalityvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "UpperBoundary": { "MarkdownDocumentation": "`UpperBoundary`\n\nThe upper boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-upperboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LowerBoundary": { "MarkdownDocumentation": "`LowerBoundary`\n\nThe lower boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-lowerboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.ForecastConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ForecastConfiguration`\n\nThe forecast configuration that is used in a line chart's display properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastconfiguration.html", "Properties": { "ForecastProperties": { "MarkdownDocumentation": "`ForecastProperties`\n\nThe forecast properties setup of a forecast in the line\nchart.\n*Required*: No\n*Type*: [TimeBasedForecastProperties](./aws-properties-quicksight-dashboard-timebasedforecastproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastconfiguration.html#cfn-quicksight-dashboard-forecastconfiguration-forecastproperties", "UpdateType": "Mutable", "Required": false, "Type": "TimeBasedForecastProperties" }, "Scenario": { "MarkdownDocumentation": "`Scenario`\n\nThe forecast scenario of a forecast in the line chart.\n*Required*: No\n*Type*: [ForecastScenario](./aws-properties-quicksight-dashboard-forecastscenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastconfiguration.html#cfn-quicksight-dashboard-forecastconfiguration-scenario", "UpdateType": "Mutable", "Required": false, "Type": "ForecastScenario" } } }, "AWS::QuickSight::Dashboard.ForecastScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ForecastScenario`\n\nThe forecast scenario of a forecast in the line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastscenario.html", "Properties": { "WhatIfRangeScenario": { "MarkdownDocumentation": "`WhatIfRangeScenario`\n\nThe what-if analysis forecast setup with the date range.\n*Required*: No\n*Type*: [WhatIfRangeScenario](./aws-properties-quicksight-dashboard-whatifrangescenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastscenario.html#cfn-quicksight-dashboard-forecastscenario-whatifrangescenario", "UpdateType": "Mutable", "Required": false, "Type": "WhatIfRangeScenario" }, "WhatIfPointScenario": { "MarkdownDocumentation": "`WhatIfPointScenario`\n\nThe what-if analysis forecast setup with the target date.\n*Required*: No\n*Type*: [WhatIfPointScenario](./aws-properties-quicksight-dashboard-whatifpointscenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastscenario.html#cfn-quicksight-dashboard-forecastscenario-whatifpointscenario", "UpdateType": "Mutable", "Required": false, "Type": "WhatIfPointScenario" } } }, "AWS::QuickSight::Dashboard.FormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FormatConfiguration`\n\nThe formatting configuration for all types of field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-formatconfiguration.html", "Properties": { "NumberFormatConfiguration": { "MarkdownDocumentation": "`NumberFormatConfiguration`\n\nFormatting configuration for number fields.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-dashboard-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-formatconfiguration.html#cfn-quicksight-dashboard-formatconfiguration-numberformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "DateTimeFormatConfiguration": { "MarkdownDocumentation": "`DateTimeFormatConfiguration`\n\nFormatting configuration for `DateTime` fields.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-dashboard-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-formatconfiguration.html#cfn-quicksight-dashboard-formatconfiguration-datetimeformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "StringFormatConfiguration": { "MarkdownDocumentation": "`StringFormatConfiguration`\n\nFormatting configuration for string fields.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-dashboard-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-formatconfiguration.html#cfn-quicksight-dashboard-formatconfiguration-stringformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" } } }, "AWS::QuickSight::Dashboard.FreeFormLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FreeFormLayoutCanvasSizeOptions`\n\nConfiguration options for the canvas of a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutcanvassizeoptions.html", "Properties": { "ScreenCanvasSizeOptions": { "MarkdownDocumentation": "`ScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a free-form layout.\n*Required*: No\n*Type*: [FreeFormLayoutScreenCanvasSizeOptions](./aws-properties-quicksight-dashboard-freeformlayoutscreencanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutcanvassizeoptions.html#cfn-quicksight-dashboard-freeformlayoutcanvassizeoptions-screencanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutScreenCanvasSizeOptions" } } }, "AWS::QuickSight::Dashboard.FreeFormLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FreeFormLayoutConfiguration`\n\nThe configuration of a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [FreeFormLayoutCanvasSizeOptions](./aws-properties-quicksight-dashboard-freeformlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutconfiguration.html#cfn-quicksight-dashboard-freeformlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutCanvasSizeOptions" }, "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in a free-form layout.\n*Required*: Yes\n*Type*: Array of [FreeFormLayoutElement](./aws-properties-quicksight-dashboard-freeformlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutconfiguration.html#cfn-quicksight-dashboard-freeformlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FreeFormLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.FreeFormLayoutElement": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FreeFormLayoutElement`\n\nAn element within a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html", "Properties": { "ElementType": { "MarkdownDocumentation": "`ElementType`\n\nThe type of element.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VISUAL | FILTER_CONTROL | P...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VISUAL", "FILTER_CONTROL", "PARAMETER_CONTROL", "TEXT_BOX", "IMAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-elementtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BorderStyle": { "MarkdownDocumentation": "`BorderStyle`\n\nThe border style configuration of a free-form layout element.\n*Required*: No\n*Type*: [FreeFormLayoutElementBorderStyle](./aws-properties-quicksight-dashboard-freeformlayoutelementborderstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-borderstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBorderStyle" }, "BorderRadius": { "MarkdownDocumentation": "`BorderRadius`\n\nThe border radius of a free-form layout element.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-borderradius", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RenderingRules": { "MarkdownDocumentation": "`RenderingRules`\n\nThe rendering rules that determine when an element should be displayed within a free-form layout.\n*Required*: No\n*Type*: Array of [SheetElementRenderingRule](./aws-properties-quicksight-dashboard-sheetelementrenderingrule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-renderingrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetElementRenderingRule", "DuplicatesAllowed": true }, "YAxisLocation": { "MarkdownDocumentation": "`YAxisLocation`\n\nThe y-axis coordinate of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-yaxislocation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BackgroundStyle": { "MarkdownDocumentation": "`BackgroundStyle`\n\nThe background style configuration of a free-form layout element.\n*Required*: No\n*Type*: [FreeFormLayoutElementBackgroundStyle](./aws-properties-quicksight-dashboard-freeformlayoutelementbackgroundstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-backgroundstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBackgroundStyle" }, "XAxisLocation": { "MarkdownDocumentation": "`XAxisLocation`\n\nThe x-axis coordinate of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-xaxislocation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Padding": { "MarkdownDocumentation": "`Padding`\n\nThe padding of a free-form layout element.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-padding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-height", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of an element within a free-form layout.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadingAnimation": { "MarkdownDocumentation": "`LoadingAnimation`\n\nThe loading animation configuration of a free-form layout element.\n*Required*: No\n*Type*: [LoadingAnimation](./aws-properties-quicksight-dashboard-loadinganimation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-loadinganimation", "UpdateType": "Mutable", "Required": false, "Type": "LoadingAnimation" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-width", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ElementId": { "MarkdownDocumentation": "`ElementId`\n\nA unique identifier for an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-elementid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectedBorderStyle": { "MarkdownDocumentation": "`SelectedBorderStyle`\n\nThe border style configuration of a free-form layout element. This border style is used when the element is selected.\n*Required*: No\n*Type*: [FreeFormLayoutElementBorderStyle](./aws-properties-quicksight-dashboard-freeformlayoutelementborderstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-selectedborderstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBorderStyle" } } }, "AWS::QuickSight::Dashboard.FreeFormLayoutElementBackgroundStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FreeFormLayoutElementBackgroundStyle`\n\nThe background style configuration of a free-form layout element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelementbackgroundstyle.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe background color of a free-form layout element.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-dashboard-freeformlayoutelementbackgroundstyle-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe background visibility of a free-form layout element.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-dashboard-freeformlayoutelementbackgroundstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FreeFormLayoutElementBorderStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FreeFormLayoutElementBorderStyle`\n\nThe background style configuration of a free-form layout element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelementborderstyle.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe border color of a free-form layout element.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelementborderstyle.html#cfn-quicksight-dashboard-freeformlayoutelementborderstyle-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe border visibility of a free-form layout element.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelementborderstyle.html#cfn-quicksight-dashboard-freeformlayoutelementborderstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe border width of a free-form layout element.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelementborderstyle.html#cfn-quicksight-dashboard-freeformlayoutelementborderstyle-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FreeFormLayoutScreenCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FreeFormLayoutScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutscreencanvassizeoptions.html", "Properties": { "OptimizedViewPortWidth": { "MarkdownDocumentation": "`OptimizedViewPortWidth`\n\nThe width that the view port will be optimized for when the layout renders.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutscreencanvassizeoptions.html#cfn-quicksight-dashboard-freeformlayoutscreencanvassizeoptions-optimizedviewportwidth", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.FreeFormSectionLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FreeFormSectionLayoutConfiguration`\n\nThe free-form layout configuration of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformsectionlayoutconfiguration.html", "Properties": { "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in the free-form layout.\n*Required*: Yes\n*Type*: Array of [FreeFormLayoutElement](./aws-properties-quicksight-dashboard-freeformlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformsectionlayoutconfiguration.html#cfn-quicksight-dashboard-freeformsectionlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FreeFormLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.FunnelChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FunnelChartAggregatedFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field wells of a funnel chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartaggregatedfieldwells.html#cfn-quicksight-dashboard-funnelchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a funnel chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartaggregatedfieldwells.html#cfn-quicksight-dashboard-funnelchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.FunnelChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FunnelChartConfiguration`\n\nThe configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartSortConfiguration](./aws-properties-quicksight-dashboard-funnelchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartSortConfiguration" }, "DataLabelOptions": { "MarkdownDocumentation": "`DataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n*Required*: No\n*Type*: [FunnelChartDataLabelOptions](./aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-datalabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartDataLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options of the categories that are displayed in a `FunnelChartVisual`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartFieldWells](./aws-properties-quicksight-dashboard-funnelchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options for the values that are displayed in a `FunnelChartVisual`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Dashboard.FunnelChartDataLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FunnelChartDataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html", "Properties": { "MeasureLabelVisibility": { "MarkdownDocumentation": "`MeasureLabelVisibility`\n\nThe visibility of the measure labels within the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-measurelabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nDetermines the positioning of the data label relative to a section of the funnel.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSIDE | OUTSIDE | LEFT | T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSIDE", "OUTSIDE", "LEFT", "TOP", "BOTTOM", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility option that determines if data labels are displayed.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryLabelVisibility": { "MarkdownDocumentation": "`CategoryLabelVisibility`\n\nThe visibility of the category labels within the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-categorylabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelColor": { "MarkdownDocumentation": "`LabelColor`\n\nThe color of the data label text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-labelcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MeasureDataLabelStyle": { "MarkdownDocumentation": "`MeasureDataLabelStyle`\n\nDetermines the style of the metric labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `VALUE_ONLY | PERCENTAGE_BY_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VALUE_ONLY", "PERCENTAGE_BY_FIRST_STAGE", "PERCENTAGE_BY_PREVIOUS_STAGE", "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-measuredatalabelstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelFontConfiguration": { "MarkdownDocumentation": "`LabelFontConfiguration`\n\nThe font configuration for the data labels.\nOnly the `FontSize` attribute of the font configuration is used for data labels.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-labelfontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Dashboard.FunnelChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FunnelChartFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartfieldwells.html", "Properties": { "FunnelChartAggregatedFieldWells": { "MarkdownDocumentation": "`FunnelChartAggregatedFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartAggregatedFieldWells](./aws-properties-quicksight-dashboard-funnelchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartfieldwells.html#cfn-quicksight-dashboard-funnelchartfieldwells-funnelchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.FunnelChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FunnelChartSortConfiguration`\n\nThe sort configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartsortconfiguration.html", "Properties": { "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartsortconfiguration.html#cfn-quicksight-dashboard-funnelchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartsortconfiguration.html#cfn-quicksight-dashboard-funnelchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.FunnelChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.FunnelChartVisual`\n\nA funnel chart.\nFor more information, see [Using funnel charts](https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartConfiguration](./aws-properties-quicksight-dashboard-funnelchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GaugeChartArcConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartArcConditionalFormatting`\n\nThe options that determine the presentation of the arc of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartarcconditionalformatting.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe conditional formatting of the arc foreground color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartarcconditionalformatting.html#cfn-quicksight-dashboard-gaugechartarcconditionalformatting-foregroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Dashboard.GaugeChartColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartColorConfiguration`\n\nThe color configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartcolorconfiguration.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe foreground color configuration of a `GaugeChartVisual`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartcolorconfiguration.html#cfn-quicksight-dashboard-gaugechartcolorconfiguration-foregroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color configuration of a `GaugeChartVisual`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartcolorconfiguration.html#cfn-quicksight-dashboard-gaugechartcolorconfiguration-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GaugeChartConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartConditionalFormatting`\n\nThe conditional formatting of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [GaugeChartConditionalFormattingOption](./aws-properties-quicksight-dashboard-gaugechartconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconditionalformatting.html#cfn-quicksight-dashboard-gaugechartconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GaugeChartConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GaugeChartConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartConditionalFormattingOption`\n\nConditional formatting options of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconditionalformattingoption.html", "Properties": { "Arc": { "MarkdownDocumentation": "`Arc`\n\nThe options that determine the presentation of the arc of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartArcConditionalFormatting](./aws-properties-quicksight-dashboard-gaugechartarcconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconditionalformattingoption.html#cfn-quicksight-dashboard-gaugechartconditionalformattingoption-arc", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartArcConditionalFormatting" }, "PrimaryValue": { "MarkdownDocumentation": "`PrimaryValue`\n\nThe conditional formatting for the primary value of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartPrimaryValueConditionalFormatting](./aws-properties-quicksight-dashboard-gaugechartprimaryvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconditionalformattingoption.html#cfn-quicksight-dashboard-gaugechartconditionalformattingoption-primaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartPrimaryValueConditionalFormatting" } } }, "AWS::QuickSight::Dashboard.GaugeChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartConfiguration`\n\nThe configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html", "Properties": { "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartFieldWells](./aws-properties-quicksight-dashboard-gaugechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartFieldWells" }, "TooltipOptions": { "MarkdownDocumentation": "`TooltipOptions`\n\nThe tooltip configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-tooltipoptions", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "GaugeChartOptions": { "MarkdownDocumentation": "`GaugeChartOptions`\n\nThe options that determine the presentation of the `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartOptions](./aws-properties-quicksight-dashboard-gaugechartoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-gaugechartoptions", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartOptions" }, "ColorConfiguration": { "MarkdownDocumentation": "`ColorConfiguration`\n\nThe color configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartColorConfiguration](./aws-properties-quicksight-dashboard-gaugechartcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-colorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartColorConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Dashboard.GaugeChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartFieldWells`\n\nThe field well configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartfieldwells.html", "Properties": { "TargetValues": { "MarkdownDocumentation": "`TargetValues`\n\nThe target value field wells of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartfieldwells.html#cfn-quicksight-dashboard-gaugechartfieldwells-targetvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartfieldwells.html#cfn-quicksight-dashboard-gaugechartfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GaugeChartOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartOptions`\n\nThe options that determine the presentation of the `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html", "Properties": { "Arc": { "MarkdownDocumentation": "`Arc`\n\nThe arc configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcConfiguration](./aws-properties-quicksight-dashboard-arcconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-gaugechartoptions-arc", "UpdateType": "Mutable", "Required": false, "Type": "ArcConfiguration" }, "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe comparison configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ComparisonConfiguration](./aws-properties-quicksight-dashboard-comparisonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-gaugechartoptions-comparison", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonConfiguration" }, "PrimaryValueDisplayType": { "MarkdownDocumentation": "`PrimaryValueDisplayType`\n\nThe options that determine the primary value display type.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | COMPARISON | ACTUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "COMPARISON", "ACTUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-gaugechartoptions-primaryvaluedisplaytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ArcAxis": { "MarkdownDocumentation": "`ArcAxis`\n\nThe arc axis configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcAxisConfiguration](./aws-properties-quicksight-dashboard-arcaxisconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-gaugechartoptions-arcaxis", "UpdateType": "Mutable", "Required": false, "Type": "ArcAxisConfiguration" }, "PrimaryValueFontConfiguration": { "MarkdownDocumentation": "`PrimaryValueFontConfiguration`\n\nThe options that determine the primary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-gaugechartoptions-primaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Dashboard.GaugeChartPrimaryValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartPrimaryValueConditionalFormatting`\n\nThe conditional formatting for the primary value of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartprimaryvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the primary value text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-dashboard-gaugechartprimaryvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the primary value icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-dashboard-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-dashboard-gaugechartprimaryvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Dashboard.GaugeChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GaugeChartVisual`\n\nA gauge chart.\nFor more information, see [Using gauge charts](https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartConditionalFormatting](./aws-properties-quicksight-dashboard-gaugechartconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartConfiguration](./aws-properties-quicksight-dashboard-gaugechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialCategoricalColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialCategoricalColor`\n\nThe definition for a categorical color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcategoricalcolor.html", "Properties": { "CategoryDataColors": { "MarkdownDocumentation": "`CategoryDataColors`\n\nA list of categorical data colors for each category.\n*Required*: Yes\n*Type*: Array of [GeospatialCategoricalDataColor](./aws-properties-quicksight-dashboard-geospatialcategoricaldatacolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcategoricalcolor.html#cfn-quicksight-dashboard-geospatialcategoricalcolor-categorydatacolors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GeospatialCategoricalDataColor", "DuplicatesAllowed": true }, "DefaultOpacity": { "MarkdownDocumentation": "`DefaultOpacity`\n\nThe default opacity of a categorical color.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcategoricalcolor.html#cfn-quicksight-dashboard-geospatialcategoricalcolor-defaultopacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "NullDataVisibility": { "MarkdownDocumentation": "`NullDataVisibility`\n\nThe state of visibility for null data.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcategoricalcolor.html#cfn-quicksight-dashboard-geospatialcategoricalcolor-nulldatavisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullDataSettings": { "MarkdownDocumentation": "`NullDataSettings`\n\nThe null data visualization settings.\n*Required*: No\n*Type*: [GeospatialNullDataSettings](./aws-properties-quicksight-dashboard-geospatialnulldatasettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcategoricalcolor.html#cfn-quicksight-dashboard-geospatialcategoricalcolor-nulldatasettings", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialNullDataSettings" } } }, "AWS::QuickSight::Dashboard.GeospatialCategoricalDataColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialCategoricalDataColor`\n\nThe categorical data color for a single category.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcategoricaldatacolor.html", "Properties": { "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nThe data value for the category data color.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcategoricaldatacolor.html#cfn-quicksight-dashboard-geospatialcategoricaldatacolor-datavalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color and opacity values for the category data color.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcategoricaldatacolor.html#cfn-quicksight-dashboard-geospatialcategoricaldatacolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialCircleRadius": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialCircleRadius`\n\nThe geospatial radius for a circle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcircleradius.html", "Properties": { "Radius": { "MarkdownDocumentation": "`Radius`\n\nThe positive value for the radius of a circle.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcircleradius.html#cfn-quicksight-dashboard-geospatialcircleradius-radius", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.GeospatialCircleSymbolStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialCircleSymbolStyle`\n\nThe properties for a circle symbol style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcirclesymbolstyle.html", "Properties": { "FillColor": { "MarkdownDocumentation": "`FillColor`\n\nThe color and opacity values for the fill color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-dashboard-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcirclesymbolstyle.html#cfn-quicksight-dashboard-geospatialcirclesymbolstyle-fillcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" }, "StrokeWidth": { "MarkdownDocumentation": "`StrokeWidth`\n\nThe width of the stroke (border).\n*Required*: No\n*Type*: [GeospatialLineWidth](./aws-properties-quicksight-dashboard-geospatiallinewidth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcirclesymbolstyle.html#cfn-quicksight-dashboard-geospatialcirclesymbolstyle-strokewidth", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineWidth" }, "StrokeColor": { "MarkdownDocumentation": "`StrokeColor`\n\nThe color and opacity values for the stroke color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-dashboard-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcirclesymbolstyle.html#cfn-quicksight-dashboard-geospatialcirclesymbolstyle-strokecolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" }, "CircleRadius": { "MarkdownDocumentation": "`CircleRadius`\n\nThe radius of the circle.\n*Required*: No\n*Type*: [GeospatialCircleRadius](./aws-properties-quicksight-dashboard-geospatialcircleradius.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcirclesymbolstyle.html#cfn-quicksight-dashboard-geospatialcirclesymbolstyle-circleradius", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCircleRadius" } } }, "AWS::QuickSight::Dashboard.GeospatialColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialColor`\n\nThe visualization properties for solid, gradient, and categorical colors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcolor.html", "Properties": { "Gradient": { "MarkdownDocumentation": "`Gradient`\n\nThe visualization properties for the gradient color.\n*Required*: No\n*Type*: [GeospatialGradientColor](./aws-properties-quicksight-dashboard-geospatialgradientcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcolor.html#cfn-quicksight-dashboard-geospatialcolor-gradient", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialGradientColor" }, "Categorical": { "MarkdownDocumentation": "`Categorical`\n\nThe visualization properties for the categorical color.\n*Required*: No\n*Type*: [GeospatialCategoricalColor](./aws-properties-quicksight-dashboard-geospatialcategoricalcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcolor.html#cfn-quicksight-dashboard-geospatialcolor-categorical", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCategoricalColor" }, "Solid": { "MarkdownDocumentation": "`Solid`\n\nThe visualization properties for the solid color.\n*Required*: No\n*Type*: [GeospatialSolidColor](./aws-properties-quicksight-dashboard-geospatialsolidcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcolor.html#cfn-quicksight-dashboard-geospatialcolor-solid", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialSolidColor" } } }, "AWS::QuickSight::Dashboard.GeospatialCoordinateBounds": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialCoordinateBounds`\n\nThe bound\noptions (north, south, west, east) of the geospatial window options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcoordinatebounds.html", "Properties": { "West": { "MarkdownDocumentation": "`West`\n\nThe longitude of the west bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-1800`\n*Maximum*: `1800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcoordinatebounds.html#cfn-quicksight-dashboard-geospatialcoordinatebounds-west", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "South": { "MarkdownDocumentation": "`South`\n\nThe latitude of the south bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-90`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcoordinatebounds.html#cfn-quicksight-dashboard-geospatialcoordinatebounds-south", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "North": { "MarkdownDocumentation": "`North`\n\nThe latitude of the north bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-90`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcoordinatebounds.html#cfn-quicksight-dashboard-geospatialcoordinatebounds-north", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "East": { "MarkdownDocumentation": "`East`\n\nThe longitude of the east bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-1800`\n*Maximum*: `1800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialcoordinatebounds.html#cfn-quicksight-dashboard-geospatialcoordinatebounds-east", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.GeospatialDataSourceItem": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialDataSourceItem`\n\nThe data source properties for the geospatial data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialdatasourceitem.html", "Properties": { "StaticFileDataSource": { "MarkdownDocumentation": "`StaticFileDataSource`\n\nThe static file data source properties for the geospatial data.\n*Required*: No\n*Type*: [GeospatialStaticFileSource](./aws-properties-quicksight-dashboard-geospatialstaticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialdatasourceitem.html#cfn-quicksight-dashboard-geospatialdatasourceitem-staticfiledatasource", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialStaticFileSource" } } }, "AWS::QuickSight::Dashboard.GeospatialGradientColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialGradientColor`\n\nThe definition for a gradient color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialgradientcolor.html", "Properties": { "DefaultOpacity": { "MarkdownDocumentation": "`DefaultOpacity`\n\nThe default opacity for the gradient color.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialgradientcolor.html#cfn-quicksight-dashboard-geospatialgradientcolor-defaultopacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StepColors": { "MarkdownDocumentation": "`StepColors`\n\nA list of gradient step colors for the gradient.\n*Required*: Yes\n*Type*: Array of [GeospatialGradientStepColor](./aws-properties-quicksight-dashboard-geospatialgradientstepcolor.html)\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialgradientcolor.html#cfn-quicksight-dashboard-geospatialgradientcolor-stepcolors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GeospatialGradientStepColor", "DuplicatesAllowed": true }, "NullDataVisibility": { "MarkdownDocumentation": "`NullDataVisibility`\n\nThe state of visibility for null data.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialgradientcolor.html#cfn-quicksight-dashboard-geospatialgradientcolor-nulldatavisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullDataSettings": { "MarkdownDocumentation": "`NullDataSettings`\n\nThe null data visualization settings.\n*Required*: No\n*Type*: [GeospatialNullDataSettings](./aws-properties-quicksight-dashboard-geospatialnulldatasettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialgradientcolor.html#cfn-quicksight-dashboard-geospatialgradientcolor-nulldatasettings", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialNullDataSettings" } } }, "AWS::QuickSight::Dashboard.GeospatialGradientStepColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialGradientStepColor`\n\nThe gradient step color for a single step.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialgradientstepcolor.html", "Properties": { "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nThe data value for the gradient step color.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialgradientstepcolor.html#cfn-quicksight-dashboard-geospatialgradientstepcolor-datavalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color and opacity values for the gradient step color.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialgradientstepcolor.html#cfn-quicksight-dashboard-geospatialgradientstepcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialHeatmapColorScale": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialHeatmapColorScale`\n\nThe color scale specification for the heatmap point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialheatmapcolorscale.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe list of colors to be used in heatmap point style.\n*Required*: No\n*Type*: Array of [GeospatialHeatmapDataColor](./aws-properties-quicksight-dashboard-geospatialheatmapdatacolor.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialheatmapcolorscale.html#cfn-quicksight-dashboard-geospatialheatmapcolorscale-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GeospatialHeatmapDataColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GeospatialHeatmapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialHeatmapConfiguration`\n\nThe heatmap configuration of the geospatial point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialheatmapconfiguration.html", "Properties": { "HeatmapColor": { "MarkdownDocumentation": "`HeatmapColor`\n\nThe color scale specification for the heatmap point style.\n*Required*: No\n*Type*: [GeospatialHeatmapColorScale](./aws-properties-quicksight-dashboard-geospatialheatmapcolorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialheatmapconfiguration.html#cfn-quicksight-dashboard-geospatialheatmapconfiguration-heatmapcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialHeatmapColorScale" } } }, "AWS::QuickSight::Dashboard.GeospatialHeatmapDataColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialHeatmapDataColor`\n\nThe color to be used in the heatmap point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialheatmapdatacolor.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe hex color to be used in the heatmap point style.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialheatmapdatacolor.html#cfn-quicksight-dashboard-geospatialheatmapdatacolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialLayerColorField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLayerColorField`\n\nThe color field that defines a gradient or categorical style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayercolorfield.html", "Properties": { "ColorValuesFields": { "MarkdownDocumentation": "`ColorValuesFields`\n\nA list of color measure fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayercolorfield.html#cfn-quicksight-dashboard-geospatiallayercolorfield-colorvaluesfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "ColorDimensionsFields": { "MarkdownDocumentation": "`ColorDimensionsFields`\n\nA list of color dimension fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayercolorfield.html#cfn-quicksight-dashboard-geospatiallayercolorfield-colordimensionsfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GeospatialLayerDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLayerDefinition`\n\nThe definition properties for a geospatial layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayerdefinition.html", "Properties": { "PointLayer": { "MarkdownDocumentation": "`PointLayer`\n\nThe definition for a point layer.\n*Required*: No\n*Type*: [GeospatialPointLayer](./aws-properties-quicksight-dashboard-geospatialpointlayer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayerdefinition.html#cfn-quicksight-dashboard-geospatiallayerdefinition-pointlayer", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPointLayer" }, "PolygonLayer": { "MarkdownDocumentation": "`PolygonLayer`\n\nThe definition for a polygon layer.\n*Required*: No\n*Type*: [GeospatialPolygonLayer](./aws-properties-quicksight-dashboard-geospatialpolygonlayer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayerdefinition.html#cfn-quicksight-dashboard-geospatiallayerdefinition-polygonlayer", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPolygonLayer" }, "LineLayer": { "MarkdownDocumentation": "`LineLayer`\n\nThe definition for a line layer.\n*Required*: No\n*Type*: [GeospatialLineLayer](./aws-properties-quicksight-dashboard-geospatiallinelayer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayerdefinition.html#cfn-quicksight-dashboard-geospatiallayerdefinition-linelayer", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineLayer" } } }, "AWS::QuickSight::Dashboard.GeospatialLayerItem": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLayerItem`\n\nThe properties for a single geospatial layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html", "Properties": { "LayerId": { "MarkdownDocumentation": "`LayerId`\n\nThe ID of the layer.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-layerid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "JoinDefinition": { "MarkdownDocumentation": "`JoinDefinition`\n\nThe join definition properties for a layer.\n*Required*: No\n*Type*: [GeospatialLayerJoinDefinition](./aws-properties-quicksight-dashboard-geospatiallayerjoindefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-joindefinition", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLayerJoinDefinition" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nA list of custom actions for a layer.\n*Required*: No\n*Type*: Array of [LayerCustomAction](./aws-properties-quicksight-dashboard-layercustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LayerCustomAction", "DuplicatesAllowed": true }, "LayerType": { "MarkdownDocumentation": "`LayerType`\n\nThe layer type.\n*Required*: No\n*Type*: String\n*Allowed values*: `POINT | LINE | POLYGON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POINT", "LINE", "POLYGON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-layertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LayerDefinition": { "MarkdownDocumentation": "`LayerDefinition`\n\nThe definition properties for a layer.\n*Required*: No\n*Type*: [GeospatialLayerDefinition](./aws-properties-quicksight-dashboard-geospatiallayerdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-layerdefinition", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLayerDefinition" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nProperty description not available.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label that is displayed for the layer.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe state of visibility for the layer.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nThe data source for the layer.\n*Required*: No\n*Type*: [GeospatialDataSourceItem](./aws-properties-quicksight-dashboard-geospatialdatasourceitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayeritem.html#cfn-quicksight-dashboard-geospatiallayeritem-datasource", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialDataSourceItem" } } }, "AWS::QuickSight::Dashboard.GeospatialLayerJoinDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLayerJoinDefinition`\n\nThe custom actions for a layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayerjoindefinition.html", "Properties": { "ColorField": { "MarkdownDocumentation": "`ColorField`\n\nThe geospatial color field for the join definition.\n*Required*: No\n*Type*: [GeospatialLayerColorField](./aws-properties-quicksight-dashboard-geospatiallayercolorfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayerjoindefinition.html#cfn-quicksight-dashboard-geospatiallayerjoindefinition-colorfield", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLayerColorField" }, "ShapeKeyField": { "MarkdownDocumentation": "`ShapeKeyField`\n\nThe name of the field or property in the geospatial 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayerjoindefinition.html#cfn-quicksight-dashboard-geospatiallayerjoindefinition-shapekeyfield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatasetKeyField": { "MarkdownDocumentation": "`DatasetKeyField`\n\nProperty description not available.\n*Required*: No\n*Type*: [UnaggregatedField](./aws-properties-quicksight-dashboard-unaggregatedfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayerjoindefinition.html#cfn-quicksight-dashboard-geospatiallayerjoindefinition-datasetkeyfield", "UpdateType": "Mutable", "Required": false, "Type": "UnaggregatedField" } } }, "AWS::QuickSight::Dashboard.GeospatialLayerMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLayerMapConfiguration`\n\nThe map definition that defines map state, map style, and geospatial layers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayermapconfiguration.html", "Properties": { "Legend": { "MarkdownDocumentation": "`Legend`\n\nProperty description not available.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayermapconfiguration.html#cfn-quicksight-dashboard-geospatiallayermapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "MapState": { "MarkdownDocumentation": "`MapState`\n\nThe map state properties for the map.\n*Required*: No\n*Type*: [GeospatialMapState](./aws-properties-quicksight-dashboard-geospatialmapstate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayermapconfiguration.html#cfn-quicksight-dashboard-geospatiallayermapconfiguration-mapstate", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapState" }, "MapStyle": { "MarkdownDocumentation": "`MapStyle`\n\nThe map style properties for the map.\n*Required*: No\n*Type*: [GeospatialMapStyle](./aws-properties-quicksight-dashboard-geospatialmapstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayermapconfiguration.html#cfn-quicksight-dashboard-geospatiallayermapconfiguration-mapstyle", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapStyle" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayermapconfiguration.html#cfn-quicksight-dashboard-geospatiallayermapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "MapLayers": { "MarkdownDocumentation": "`MapLayers`\n\nThe geospatial layers to visualize on the map.\n*Required*: No\n*Type*: Array of [GeospatialLayerItem](./aws-properties-quicksight-dashboard-geospatiallayeritem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallayermapconfiguration.html#cfn-quicksight-dashboard-geospatiallayermapconfiguration-maplayers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GeospatialLayerItem", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GeospatialLineLayer": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLineLayer`\n\nThe geospatial Line layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinelayer.html", "Properties": { "Style": { "MarkdownDocumentation": "`Style`\n\nThe visualization style for a line layer.\n*Required*: Yes\n*Type*: [GeospatialLineStyle](./aws-properties-quicksight-dashboard-geospatiallinestyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinelayer.html#cfn-quicksight-dashboard-geospatiallinelayer-style", "UpdateType": "Mutable", "Required": true, "Type": "GeospatialLineStyle" } } }, "AWS::QuickSight::Dashboard.GeospatialLineStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLineStyle`\n\nThe visualization style for a line layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinestyle.html", "Properties": { "LineSymbolStyle": { "MarkdownDocumentation": "`LineSymbolStyle`\n\nThe symbol style for a line style.\n*Required*: No\n*Type*: [GeospatialLineSymbolStyle](./aws-properties-quicksight-dashboard-geospatiallinesymbolstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinestyle.html#cfn-quicksight-dashboard-geospatiallinestyle-linesymbolstyle", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineSymbolStyle" } } }, "AWS::QuickSight::Dashboard.GeospatialLineSymbolStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLineSymbolStyle`\n\nThe symbol style for a line layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinesymbolstyle.html", "Properties": { "FillColor": { "MarkdownDocumentation": "`FillColor`\n\nThe color and opacity values for the fill color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-dashboard-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinesymbolstyle.html#cfn-quicksight-dashboard-geospatiallinesymbolstyle-fillcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" }, "LineWidth": { "MarkdownDocumentation": "`LineWidth`\n\nThe width value for a line.\n*Required*: No\n*Type*: [GeospatialLineWidth](./aws-properties-quicksight-dashboard-geospatiallinewidth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinesymbolstyle.html#cfn-quicksight-dashboard-geospatiallinesymbolstyle-linewidth", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineWidth" } } }, "AWS::QuickSight::Dashboard.GeospatialLineWidth": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialLineWidth`\n\nThe width properties for a line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinewidth.html", "Properties": { "LineWidth": { "MarkdownDocumentation": "`LineWidth`\n\nThe positive value for the width of a line.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatiallinewidth.html#cfn-quicksight-dashboard-geospatiallinewidth-linewidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.GeospatialMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialMapAggregatedFieldWells`\n\nThe aggregated field wells for a geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapaggregatedfieldwells.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field wells of a geospatial map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapaggregatedfieldwells.html#cfn-quicksight-dashboard-geospatialmapaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe size field wells of a geospatial map. Values are aggregated based on geospatial fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapaggregatedfieldwells.html#cfn-quicksight-dashboard-geospatialmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Geospatial": { "MarkdownDocumentation": "`Geospatial`\n\nThe geospatial field wells of a geospatial map. Values are grouped by geospatial fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapaggregatedfieldwells.html#cfn-quicksight-dashboard-geospatialmapaggregatedfieldwells-geospatial", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GeospatialMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialMapConfiguration`\n\nThe configuration of a `GeospatialMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html", "Properties": { "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "MapStyleOptions": { "MarkdownDocumentation": "`MapStyleOptions`\n\nThe map style options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialMapStyleOptions](./aws-properties-quicksight-dashboard-geospatialmapstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-mapstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapStyleOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [GeospatialMapFieldWells](./aws-properties-quicksight-dashboard-geospatialmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "WindowOptions": { "MarkdownDocumentation": "`WindowOptions`\n\nThe window options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialWindowOptions](./aws-properties-quicksight-dashboard-geospatialwindowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-windowoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialWindowOptions" }, "PointStyleOptions": { "MarkdownDocumentation": "`PointStyleOptions`\n\nThe point style options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialPointStyleOptions](./aws-properties-quicksight-dashboard-geospatialpointstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-pointstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPointStyleOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Dashboard.GeospatialMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialMapFieldWells`\n\nThe field wells of a `GeospatialMapVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapfieldwells.html", "Properties": { "GeospatialMapAggregatedFieldWells": { "MarkdownDocumentation": "`GeospatialMapAggregatedFieldWells`\n\nThe aggregated field well for a geospatial map.\n*Required*: No\n*Type*: [GeospatialMapAggregatedFieldWells](./aws-properties-quicksight-dashboard-geospatialmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapfieldwells.html#cfn-quicksight-dashboard-geospatialmapfieldwells-geospatialmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.GeospatialMapState": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialMapState`\n\nThe map state properties for a map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstate.html", "Properties": { "Bounds": { "MarkdownDocumentation": "`Bounds`\n\nProperty description not available.\n*Required*: No\n*Type*: [GeospatialCoordinateBounds](./aws-properties-quicksight-dashboard-geospatialcoordinatebounds.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstate.html#cfn-quicksight-dashboard-geospatialmapstate-bounds", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCoordinateBounds" }, "MapNavigation": { "MarkdownDocumentation": "`MapNavigation`\n\nEnables or disables map navigation for a map.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstate.html#cfn-quicksight-dashboard-geospatialmapstate-mapnavigation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialMapStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialMapStyle`\n\nThe map style properties for a map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstyle.html", "Properties": { "BaseMapStyle": { "MarkdownDocumentation": "`BaseMapStyle`\n\nThe selected base map style.\n*Required*: No\n*Type*: String\n*Allowed values*: `LIGHT_GRAY | DARK_GRAY | ST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LIGHT_GRAY", "DARK_GRAY", "STREET", "IMAGERY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstyle.html#cfn-quicksight-dashboard-geospatialmapstyle-basemapstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseMapVisibility": { "MarkdownDocumentation": "`BaseMapVisibility`\n\nThe state of visibility for the base map.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstyle.html#cfn-quicksight-dashboard-geospatialmapstyle-basemapvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color and opacity values for a map.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstyle.html#cfn-quicksight-dashboard-geospatialmapstyle-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialMapStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialMapStyleOptions`\n\nThe map style options of the geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstyleoptions.html", "Properties": { "BaseMapStyle": { "MarkdownDocumentation": "`BaseMapStyle`\n\nThe base map style of the geospatial map.\n*Required*: No\n*Type*: String\n*Allowed values*: `LIGHT_GRAY | DARK_GRAY | ST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LIGHT_GRAY", "DARK_GRAY", "STREET", "IMAGERY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapstyleoptions.html#cfn-quicksight-dashboard-geospatialmapstyleoptions-basemapstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialMapVisual`\n\nA geospatial map or a points on map visual.\nFor more information, see [Creating point maps](https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [GeospatialMapConfiguration](./aws-properties-quicksight-dashboard-geospatialmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GeospatialNullDataSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialNullDataSettings`\n\nThe properties for the visualization of null data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialnulldatasettings.html", "Properties": { "SymbolStyle": { "MarkdownDocumentation": "`SymbolStyle`\n\nThe symbol style for null data.\n*Required*: Yes\n*Type*: [GeospatialNullSymbolStyle](./aws-properties-quicksight-dashboard-geospatialnullsymbolstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialnulldatasettings.html#cfn-quicksight-dashboard-geospatialnulldatasettings-symbolstyle", "UpdateType": "Mutable", "Required": true, "Type": "GeospatialNullSymbolStyle" } } }, "AWS::QuickSight::Dashboard.GeospatialNullSymbolStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialNullSymbolStyle`\n\nThe symbol style for null data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialnullsymbolstyle.html", "Properties": { "FillColor": { "MarkdownDocumentation": "`FillColor`\n\nThe color and opacity values for the fill color.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialnullsymbolstyle.html#cfn-quicksight-dashboard-geospatialnullsymbolstyle-fillcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StrokeWidth": { "MarkdownDocumentation": "`StrokeWidth`\n\nThe width of the border stroke.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialnullsymbolstyle.html#cfn-quicksight-dashboard-geospatialnullsymbolstyle-strokewidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StrokeColor": { "MarkdownDocumentation": "`StrokeColor`\n\nThe color and opacity values for the stroke color.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialnullsymbolstyle.html#cfn-quicksight-dashboard-geospatialnullsymbolstyle-strokecolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialPointLayer": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialPointLayer`\n\nThe geospatial Point layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointlayer.html", "Properties": { "Style": { "MarkdownDocumentation": "`Style`\n\nThe visualization style for a point layer.\n*Required*: Yes\n*Type*: [GeospatialPointStyle](./aws-properties-quicksight-dashboard-geospatialpointstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointlayer.html#cfn-quicksight-dashboard-geospatialpointlayer-style", "UpdateType": "Mutable", "Required": true, "Type": "GeospatialPointStyle" } } }, "AWS::QuickSight::Dashboard.GeospatialPointStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialPointStyle`\n\nThe point style for a point layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointstyle.html", "Properties": { "CircleSymbolStyle": { "MarkdownDocumentation": "`CircleSymbolStyle`\n\nThe circle symbol style for a point layer.\n*Required*: No\n*Type*: [GeospatialCircleSymbolStyle](./aws-properties-quicksight-dashboard-geospatialcirclesymbolstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointstyle.html#cfn-quicksight-dashboard-geospatialpointstyle-circlesymbolstyle", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCircleSymbolStyle" } } }, "AWS::QuickSight::Dashboard.GeospatialPointStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialPointStyleOptions`\n\nThe point style of the geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointstyleoptions.html", "Properties": { "SelectedPointStyle": { "MarkdownDocumentation": "`SelectedPointStyle`\n\nThe selected point styles (point, cluster) of the geospatial map.\n*Required*: No\n*Type*: String\n*Allowed values*: `POINT | CLUSTER | HEATMAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POINT", "CLUSTER", "HEATMAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointstyleoptions.html#cfn-quicksight-dashboard-geospatialpointstyleoptions-selectedpointstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterMarkerConfiguration": { "MarkdownDocumentation": "`ClusterMarkerConfiguration`\n\nThe cluster marker configuration of the geospatial point style.\n*Required*: No\n*Type*: [ClusterMarkerConfiguration](./aws-properties-quicksight-dashboard-clustermarkerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointstyleoptions.html#cfn-quicksight-dashboard-geospatialpointstyleoptions-clustermarkerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ClusterMarkerConfiguration" }, "HeatmapConfiguration": { "MarkdownDocumentation": "`HeatmapConfiguration`\n\nThe heatmap configuration of the geospatial point style.\n*Required*: No\n*Type*: [GeospatialHeatmapConfiguration](./aws-properties-quicksight-dashboard-geospatialheatmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointstyleoptions.html#cfn-quicksight-dashboard-geospatialpointstyleoptions-heatmapconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialHeatmapConfiguration" } } }, "AWS::QuickSight::Dashboard.GeospatialPolygonLayer": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialPolygonLayer`\n\nThe geospatial polygon layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpolygonlayer.html", "Properties": { "Style": { "MarkdownDocumentation": "`Style`\n\nThe visualization style for a polygon layer.\n*Required*: Yes\n*Type*: [GeospatialPolygonStyle](./aws-properties-quicksight-dashboard-geospatialpolygonstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpolygonlayer.html#cfn-quicksight-dashboard-geospatialpolygonlayer-style", "UpdateType": "Mutable", "Required": true, "Type": "GeospatialPolygonStyle" } } }, "AWS::QuickSight::Dashboard.GeospatialPolygonStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialPolygonStyle`\n\nThe polygon style for a polygon layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpolygonstyle.html", "Properties": { "PolygonSymbolStyle": { "MarkdownDocumentation": "`PolygonSymbolStyle`\n\nThe polygon symbol style for a polygon layer.\n*Required*: No\n*Type*: [GeospatialPolygonSymbolStyle](./aws-properties-quicksight-dashboard-geospatialpolygonsymbolstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpolygonstyle.html#cfn-quicksight-dashboard-geospatialpolygonstyle-polygonsymbolstyle", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPolygonSymbolStyle" } } }, "AWS::QuickSight::Dashboard.GeospatialPolygonSymbolStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialPolygonSymbolStyle`\n\nThe polygon symbol style for a polygon layer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpolygonsymbolstyle.html", "Properties": { "FillColor": { "MarkdownDocumentation": "`FillColor`\n\nThe color and opacity values for the fill color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-dashboard-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpolygonsymbolstyle.html#cfn-quicksight-dashboard-geospatialpolygonsymbolstyle-fillcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" }, "StrokeWidth": { "MarkdownDocumentation": "`StrokeWidth`\n\nThe width of the border stroke.\n*Required*: No\n*Type*: [GeospatialLineWidth](./aws-properties-quicksight-dashboard-geospatiallinewidth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpolygonsymbolstyle.html#cfn-quicksight-dashboard-geospatialpolygonsymbolstyle-strokewidth", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLineWidth" }, "StrokeColor": { "MarkdownDocumentation": "`StrokeColor`\n\nThe color and opacity values for the stroke color.\n*Required*: No\n*Type*: [GeospatialColor](./aws-properties-quicksight-dashboard-geospatialcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpolygonsymbolstyle.html#cfn-quicksight-dashboard-geospatialpolygonsymbolstyle-strokecolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialColor" } } }, "AWS::QuickSight::Dashboard.GeospatialSolidColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialSolidColor`\n\nThe definition for a solid color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialsolidcolor.html", "Properties": { "State": { "MarkdownDocumentation": "`State`\n\nEnables and disables the view state of the color.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialsolidcolor.html#cfn-quicksight-dashboard-geospatialsolidcolor-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color and opacity values for the color.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialsolidcolor.html#cfn-quicksight-dashboard-geospatialsolidcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialStaticFileSource": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialStaticFileSource`\n\nThe source properties for a geospatial static file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialstaticfilesource.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the static file.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialstaticfilesource.html#cfn-quicksight-dashboard-geospatialstaticfilesource-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GeospatialWindowOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GeospatialWindowOptions`\n\nThe window options of the geospatial map visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialwindowoptions.html", "Properties": { "Bounds": { "MarkdownDocumentation": "`Bounds`\n\nThe bounds options (north, south, west, east) of the geospatial window options.\n*Required*: No\n*Type*: [GeospatialCoordinateBounds](./aws-properties-quicksight-dashboard-geospatialcoordinatebounds.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialwindowoptions.html#cfn-quicksight-dashboard-geospatialwindowoptions-bounds", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCoordinateBounds" }, "MapZoomMode": { "MarkdownDocumentation": "`MapZoomMode`\n\nThe map zoom modes (manual, auto) of the geospatial window options.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialwindowoptions.html#cfn-quicksight-dashboard-geospatialwindowoptions-mapzoommode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GlobalTableBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GlobalTableBorderOptions`\n\nDetermines the border options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-globaltableborderoptions.html", "Properties": { "UniformBorder": { "MarkdownDocumentation": "`UniformBorder`\n\nDetermines the options for uniform border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-dashboard-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-globaltableborderoptions.html#cfn-quicksight-dashboard-globaltableborderoptions-uniformborder", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "SideSpecificBorder": { "MarkdownDocumentation": "`SideSpecificBorder`\n\nDetermines the options for side specific border.\n*Required*: No\n*Type*: [TableSideBorderOptions](./aws-properties-quicksight-dashboard-tablesideborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-globaltableborderoptions.html#cfn-quicksight-dashboard-globaltableborderoptions-sidespecificborder", "UpdateType": "Mutable", "Required": false, "Type": "TableSideBorderOptions" } } }, "AWS::QuickSight::Dashboard.GradientColor": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GradientColor`\n\nDetermines the gradient color settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientcolor.html", "Properties": { "Stops": { "MarkdownDocumentation": "`Stops`\n\nThe list of gradient color stops.\n*Required*: No\n*Type*: Array of [GradientStop](./aws-properties-quicksight-dashboard-gradientstop.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientcolor.html#cfn-quicksight-dashboard-gradientcolor-stops", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GradientStop", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GradientStop": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GradientStop`\n\nDetermines the gradient stop configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientstop.html", "Properties": { "GradientOffset": { "MarkdownDocumentation": "`GradientOffset`\n\nDetermines gradient offset value.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientstop.html#cfn-quicksight-dashboard-gradientstop-gradientoffset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nDetermines the data value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientstop.html#cfn-quicksight-dashboard-gradientstop-datavalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientstop.html#cfn-quicksight-dashboard-gradientstop-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GridLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GridLayoutCanvasSizeOptions`\n\nConfiguration options for the canvas of a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutcanvassizeoptions.html", "Properties": { "ScreenCanvasSizeOptions": { "MarkdownDocumentation": "`ScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a grid layout.\n*Required*: No\n*Type*: [GridLayoutScreenCanvasSizeOptions](./aws-properties-quicksight-dashboard-gridlayoutscreencanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutcanvassizeoptions.html#cfn-quicksight-dashboard-gridlayoutcanvassizeoptions-screencanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutScreenCanvasSizeOptions" } } }, "AWS::QuickSight::Dashboard.GridLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GridLayoutConfiguration`\n\nThe configuration for a grid layout. Also called a tiled layout.\nVisuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [GridLayoutCanvasSizeOptions](./aws-properties-quicksight-dashboard-gridlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutconfiguration.html#cfn-quicksight-dashboard-gridlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutCanvasSizeOptions" }, "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in a grid layout.\n*Required*: Yes\n*Type*: Array of [GridLayoutElement](./aws-properties-quicksight-dashboard-gridlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutconfiguration.html#cfn-quicksight-dashboard-gridlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GridLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.GridLayoutElement": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GridLayoutElement`\n\nAn element within a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html", "Properties": { "ElementType": { "MarkdownDocumentation": "`ElementType`\n\nThe type of element.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VISUAL | FILTER_CONTROL | P...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VISUAL", "FILTER_CONTROL", "PARAMETER_CONTROL", "TEXT_BOX", "IMAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-elementtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnSpan": { "MarkdownDocumentation": "`ColumnSpan`\n\nThe width of a grid element expressed as a number of grid columns.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-columnspan", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "ColumnIndex": { "MarkdownDocumentation": "`ColumnIndex`\n\nThe column index for the upper left corner of an element.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `35`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-columnindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "RowIndex": { "MarkdownDocumentation": "`RowIndex`\n\nThe row index for the upper left corner of an element.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `9009`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-rowindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "BorderStyle": { "MarkdownDocumentation": "`BorderStyle`\n\nThe border style configuration of a grid layout element.\n*Required*: No\n*Type*: [GridLayoutElementBorderStyle](./aws-properties-quicksight-dashboard-gridlayoutelementborderstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-borderstyle", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutElementBorderStyle" }, "BorderRadius": { "MarkdownDocumentation": "`BorderRadius`\n\nThe border radius of a grid layout element.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-borderradius", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowSpan": { "MarkdownDocumentation": "`RowSpan`\n\nThe height of a grid element expressed as a number of grid rows.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `21`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-rowspan", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Padding": { "MarkdownDocumentation": "`Padding`\n\nThe padding of a grid layout element.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-padding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadingAnimation": { "MarkdownDocumentation": "`LoadingAnimation`\n\nProperty description not available.\n*Required*: No\n*Type*: [LoadingAnimation](./aws-properties-quicksight-dashboard-loadinganimation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-loadinganimation", "UpdateType": "Mutable", "Required": false, "Type": "LoadingAnimation" }, "BackgroundStyle": { "MarkdownDocumentation": "`BackgroundStyle`\n\nThe background style configuration of a grid layout element.\n*Required*: No\n*Type*: [GridLayoutElementBackgroundStyle](./aws-properties-quicksight-dashboard-gridlayoutelementbackgroundstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-backgroundstyle", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutElementBackgroundStyle" }, "ElementId": { "MarkdownDocumentation": "`ElementId`\n\nA unique identifier for an element within a grid layout.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-elementid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectedBorderStyle": { "MarkdownDocumentation": "`SelectedBorderStyle`\n\nThe border style configuration of a grid layout element. This border style is used when the element is selected.\n*Required*: No\n*Type*: [GridLayoutElementBorderStyle](./aws-properties-quicksight-dashboard-gridlayoutelementborderstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-selectedborderstyle", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutElementBorderStyle" } } }, "AWS::QuickSight::Dashboard.GridLayoutElementBackgroundStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GridLayoutElementBackgroundStyle`\n\nThe background style configuration of a grid layout element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelementbackgroundstyle.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe background color of a grid layout element.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelementbackgroundstyle.html#cfn-quicksight-dashboard-gridlayoutelementbackgroundstyle-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe background visibility of a grid layout element.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelementbackgroundstyle.html#cfn-quicksight-dashboard-gridlayoutelementbackgroundstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GridLayoutElementBorderStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GridLayoutElementBorderStyle`\n\nThe border style configuration of a grid layout element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelementborderstyle.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe border color of a grid layout element.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelementborderstyle.html#cfn-quicksight-dashboard-gridlayoutelementborderstyle-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe border visibility of a grid layout element.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelementborderstyle.html#cfn-quicksight-dashboard-gridlayoutelementborderstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe border width of a grid layout element.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelementborderstyle.html#cfn-quicksight-dashboard-gridlayoutelementborderstyle-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GridLayoutScreenCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GridLayoutScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutscreencanvassizeoptions.html", "Properties": { "OptimizedViewPortWidth": { "MarkdownDocumentation": "`OptimizedViewPortWidth`\n\nThe width that the view port will be optimized for when the layout renders.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-dashboard-gridlayoutscreencanvassizeoptions-optimizedviewportwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResizeOption": { "MarkdownDocumentation": "`ResizeOption`\n\nThis value determines the layout behavior when the viewport is resized.\n* `FIXED`: A fixed width will be used when optimizing the layout. In\n the Quick Sight console, this option is called `Classic`.\n* `RESPONSIVE`: The width of the canvas will be responsive and\n optimized to the view port. In the Quick Sight console, this option is called `Tiled`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIXED | RESPONSIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIXED", "RESPONSIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-dashboard-gridlayoutscreencanvassizeoptions-resizeoption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.GrowthRateComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.GrowthRateComputation`\n\nThe growth rate computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-growthratecomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-growthratecomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-growthratecomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "PeriodSize": { "MarkdownDocumentation": "`PeriodSize`\n\nThe period size setup of a growth rate computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `2`\n*Maximum*: `52`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-growthratecomputation-periodsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-growthratecomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-growthratecomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.HeaderFooterSectionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HeaderFooterSectionConfiguration`\n\nThe configuration of a header or footer section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html", "Properties": { "Layout": { "MarkdownDocumentation": "`Layout`\n\nThe layout configuration of the header or footer section.\n*Required*: Yes\n*Type*: [SectionLayoutConfiguration](./aws-properties-quicksight-dashboard-sectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html#cfn-quicksight-dashboard-headerfootersectionconfiguration-layout", "UpdateType": "Mutable", "Required": true, "Type": "SectionLayoutConfiguration" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style options of a header or footer section.\n*Required*: No\n*Type*: [SectionStyle](./aws-properties-quicksight-dashboard-sectionstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html#cfn-quicksight-dashboard-headerfootersectionconfiguration-style", "UpdateType": "Mutable", "Required": false, "Type": "SectionStyle" }, "SectionId": { "MarkdownDocumentation": "`SectionId`\n\nThe unique identifier of the header or footer section.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html#cfn-quicksight-dashboard-headerfootersectionconfiguration-sectionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.HeatMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HeatMapAggregatedFieldWells`\n\nThe aggregated field wells of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well of a heat map.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapaggregatedfieldwells.html#cfn-quicksight-dashboard-heatmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe columns field well of a heat map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapaggregatedfieldwells.html#cfn-quicksight-dashboard-heatmapaggregatedfieldwells-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Rows": { "MarkdownDocumentation": "`Rows`\n\nThe rows field well of a heat map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapaggregatedfieldwells.html#cfn-quicksight-dashboard-heatmapaggregatedfieldwells-rows", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.HeatMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HeatMapConfiguration`\n\nThe configuration of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a heat map.\n*Required*: No\n*Type*: [HeatMapSortConfiguration](./aws-properties-quicksight-dashboard-heatmapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapSortConfiguration" }, "ColumnLabelOptions": { "MarkdownDocumentation": "`ColumnLabelOptions`\n\nThe label options of the column that is displayed in a heat map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-columnlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [HeatMapFieldWells](./aws-properties-quicksight-dashboard-heatmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "ColorScale": { "MarkdownDocumentation": "`ColorScale`\n\nThe color options (gradient color, point of divergence) in a heat map.\n*Required*: No\n*Type*: [ColorScale](./aws-properties-quicksight-dashboard-colorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-colorscale", "UpdateType": "Mutable", "Required": false, "Type": "ColorScale" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "RowLabelOptions": { "MarkdownDocumentation": "`RowLabelOptions`\n\nThe label options of the row that is displayed in a `heat map`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-rowlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" } } }, "AWS::QuickSight::Dashboard.HeatMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HeatMapFieldWells`\n\nThe field well configuration of a heat map.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapfieldwells.html", "Properties": { "HeatMapAggregatedFieldWells": { "MarkdownDocumentation": "`HeatMapAggregatedFieldWells`\n\nThe aggregated field wells of a heat map.\n*Required*: No\n*Type*: [HeatMapAggregatedFieldWells](./aws-properties-quicksight-dashboard-heatmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapfieldwells.html#cfn-quicksight-dashboard-heatmapfieldwells-heatmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.HeatMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HeatMapSortConfiguration`\n\nThe sort configuration of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapsortconfiguration.html", "Properties": { "HeatMapRowSort": { "MarkdownDocumentation": "`HeatMapRowSort`\n\nThe field sort configuration of the rows fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapsortconfiguration.html#cfn-quicksight-dashboard-heatmapsortconfiguration-heatmaprowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "HeatMapRowItemsLimitConfiguration": { "MarkdownDocumentation": "`HeatMapRowItemsLimitConfiguration`\n\nThe limit on the number of rows that are displayed in a heat map.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapsortconfiguration.html#cfn-quicksight-dashboard-heatmapsortconfiguration-heatmaprowitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "HeatMapColumnItemsLimitConfiguration": { "MarkdownDocumentation": "`HeatMapColumnItemsLimitConfiguration`\n\nThe limit on the number of columns that are displayed in a heat map.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapsortconfiguration.html#cfn-quicksight-dashboard-heatmapsortconfiguration-heatmapcolumnitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "HeatMapColumnSort": { "MarkdownDocumentation": "`HeatMapColumnSort`\n\nThe column sort configuration for heat map for columns that aren't a part of a field well.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapsortconfiguration.html#cfn-quicksight-dashboard-heatmapsortconfiguration-heatmapcolumnsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.HeatMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HeatMapVisual`\n\nA heat map.\nFor more information, see [Using heat maps](https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a heat map.\n*Required*: No\n*Type*: [HeatMapConfiguration](./aws-properties-quicksight-dashboard-heatmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.HistogramAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HistogramAggregatedFieldWells`\n\nThe field well configuration of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a histogram. Values are aggregated by `COUNT` or `DISTINCT_COUNT`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramaggregatedfieldwells.html#cfn-quicksight-dashboard-histogramaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.HistogramBinOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HistogramBinOptions`\n\nThe options that determine the presentation of histogram bins.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogrambinoptions.html", "Properties": { "BinWidth": { "MarkdownDocumentation": "`BinWidth`\n\nThe options that determine the bin width of a histogram.\n*Required*: No\n*Type*: [BinWidthOptions](./aws-properties-quicksight-dashboard-binwidthoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogrambinoptions.html#cfn-quicksight-dashboard-histogrambinoptions-binwidth", "UpdateType": "Mutable", "Required": false, "Type": "BinWidthOptions" }, "StartValue": { "MarkdownDocumentation": "`StartValue`\n\nThe options that determine the bin start value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogrambinoptions.html#cfn-quicksight-dashboard-histogrambinoptions-startvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "SelectedBinType": { "MarkdownDocumentation": "`SelectedBinType`\n\nThe options that determine the selected bin type.\n*Required*: No\n*Type*: String\n*Allowed values*: `BIN_COUNT | BIN_WIDTH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BIN_COUNT", "BIN_WIDTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogrambinoptions.html#cfn-quicksight-dashboard-histogrambinoptions-selectedbintype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BinCount": { "MarkdownDocumentation": "`BinCount`\n\nThe options that determine the bin count of a histogram.\n*Required*: No\n*Type*: [BinCountOptions](./aws-properties-quicksight-dashboard-bincountoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogrambinoptions.html#cfn-quicksight-dashboard-histogrambinoptions-bincount", "UpdateType": "Mutable", "Required": false, "Type": "BinCountOptions" } } }, "AWS::QuickSight::Dashboard.HistogramConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HistogramConfiguration`\n\nThe configuration for a `HistogramVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html", "Properties": { "YAxisDisplayOptions": { "MarkdownDocumentation": "`YAxisDisplayOptions`\n\nThe options that determine the presentation of the y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-yaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a histogram.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "BinOptions": { "MarkdownDocumentation": "`BinOptions`\n\nThe options that determine the presentation of histogram bins.\n*Required*: No\n*Type*: [HistogramBinOptions](./aws-properties-quicksight-dashboard-histogrambinoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-binoptions", "UpdateType": "Mutable", "Required": false, "Type": "HistogramBinOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a histogram.\n*Required*: No\n*Type*: [HistogramFieldWells](./aws-properties-quicksight-dashboard-histogramfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HistogramFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a histogram.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe options that determine the presentation of the x-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a histogram.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe options that determine the presentation of the x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Dashboard.HistogramFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HistogramFieldWells`\n\nThe field well configuration of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramfieldwells.html", "Properties": { "HistogramAggregatedFieldWells": { "MarkdownDocumentation": "`HistogramAggregatedFieldWells`\n\nThe field well configuration of a histogram.\n*Required*: No\n*Type*: [HistogramAggregatedFieldWells](./aws-properties-quicksight-dashboard-histogramaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramfieldwells.html#cfn-quicksight-dashboard-histogramfieldwells-histogramaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HistogramAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.HistogramVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.HistogramVisual`\n\nA histogram.\nFor more information, see [Using histograms](https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramvisual.html#cfn-quicksight-dashboard-histogramvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramvisual.html#cfn-quicksight-dashboard-histogramvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration for a `HistogramVisual`.\n*Required*: No\n*Type*: [HistogramConfiguration](./aws-properties-quicksight-dashboard-histogramconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramvisual.html#cfn-quicksight-dashboard-histogramvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HistogramConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramvisual.html#cfn-quicksight-dashboard-histogramvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramvisual.html#cfn-quicksight-dashboard-histogramvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramvisual.html#cfn-quicksight-dashboard-histogramvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ImageCustomAction": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ImageCustomAction`\n\nA custom action defined on an image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the custom action.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trigger": { "MarkdownDocumentation": "`Trigger`\n\nThe trigger of the `VisualCustomAction`.\nValid values are defined as follows:\n* `CLICK`: Initiates a custom action by a left pointer click on a data point.\n* `MENU`: Initiates a custom action by right pointer click from the menu.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLICK | MENU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLICK", "MENU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-trigger", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomActionId": { "MarkdownDocumentation": "`CustomActionId`\n\nThe ID of the custom action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-customactionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the custom action.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionOperations": { "MarkdownDocumentation": "`ActionOperations`\n\nA list of `ImageCustomActionOperations`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: Array of [ImageCustomActionOperation](./aws-properties-quicksight-dashboard-imagecustomactionoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomaction.html#cfn-quicksight-dashboard-imagecustomaction-actionoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ImageCustomActionOperation", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ImageCustomActionOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ImageCustomActionOperation`\n\nThe operation that is defined by the custom action.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomactionoperation.html", "Properties": { "NavigationOperation": { "MarkdownDocumentation": "`NavigationOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionNavigationOperation](./aws-properties-quicksight-dashboard-customactionnavigationoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomactionoperation.html#cfn-quicksight-dashboard-imagecustomactionoperation-navigationoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionNavigationOperation" }, "SetParametersOperation": { "MarkdownDocumentation": "`SetParametersOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionSetParametersOperation](./aws-properties-quicksight-dashboard-customactionsetparametersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomactionoperation.html#cfn-quicksight-dashboard-imagecustomactionoperation-setparametersoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionSetParametersOperation" }, "URLOperation": { "MarkdownDocumentation": "`URLOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionURLOperation](./aws-properties-quicksight-dashboard-customactionurloperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagecustomactionoperation.html#cfn-quicksight-dashboard-imagecustomactionoperation-urloperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionURLOperation" } } }, "AWS::QuickSight::Dashboard.ImageInteractionOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ImageInteractionOptions`\n\nThe general image interactions setup for image publish options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imageinteractionoptions.html", "Properties": { "ImageMenuOption": { "MarkdownDocumentation": "`ImageMenuOption`\n\nThe menu options for the image.\n*Required*: No\n*Type*: [ImageMenuOption](./aws-properties-quicksight-dashboard-imagemenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imageinteractionoptions.html#cfn-quicksight-dashboard-imageinteractionoptions-imagemenuoption", "UpdateType": "Mutable", "Required": false, "Type": "ImageMenuOption" } } }, "AWS::QuickSight::Dashboard.ImageMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ImageMenuOption`\n\nThe menu options for the interactions of an image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagemenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availability status of the image menu. If the value of this property is set to `ENABLED`, dashboard readers can interact with the image menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagemenuoption.html#cfn-quicksight-dashboard-imagemenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ImageStaticFile": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ImageStaticFile`\n\nA static file that contains an image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagestaticfile.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the static file that contains an image.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagestaticfile.html#cfn-quicksight-dashboard-imagestaticfile-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the image static file.\n*Required*: No\n*Type*: [StaticFileSource](./aws-properties-quicksight-dashboard-staticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-imagestaticfile.html#cfn-quicksight-dashboard-imagestaticfile-source", "UpdateType": "Mutable", "Required": false, "Type": "StaticFileSource" } } }, "AWS::QuickSight::Dashboard.InnerFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.InnerFilter`\n\nThe `InnerFilter` defines the subset of data to be used with the `NestedFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-innerfilter.html", "Properties": { "CategoryInnerFilter": { "MarkdownDocumentation": "`CategoryInnerFilter`\n\nA `CategoryInnerFilter` filters text values for the `NestedFilter`.\n*Required*: No\n*Type*: [CategoryInnerFilter](./aws-properties-quicksight-dashboard-categoryinnerfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-innerfilter.html#cfn-quicksight-dashboard-innerfilter-categoryinnerfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryInnerFilter" } } }, "AWS::QuickSight::Dashboard.InsightConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.InsightConfiguration`\n\nThe configuration of an insight visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightconfiguration.html", "Properties": { "Computations": { "MarkdownDocumentation": "`Computations`\n\nThe computations configurations of the insight visual\n*Required*: No\n*Type*: Array of [Computation](./aws-properties-quicksight-dashboard-computation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightconfiguration.html#cfn-quicksight-dashboard-insightconfiguration-computations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Computation", "DuplicatesAllowed": true }, "CustomNarrative": { "MarkdownDocumentation": "`CustomNarrative`\n\nThe custom narrative of the insight visual.\n*Required*: No\n*Type*: [CustomNarrativeOptions](./aws-properties-quicksight-dashboard-customnarrativeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightconfiguration.html#cfn-quicksight-dashboard-insightconfiguration-customnarrative", "UpdateType": "Mutable", "Required": false, "Type": "CustomNarrativeOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightconfiguration.html#cfn-quicksight-dashboard-insightconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Dashboard.InsightVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.InsightVisual`\n\nAn insight visual.\nFor more information, see [Working with insights](https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe dataset that is used in the insight visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InsightConfiguration": { "MarkdownDocumentation": "`InsightConfiguration`\n\nThe configuration of an insight visual.\n*Required*: No\n*Type*: [InsightConfiguration](./aws-properties-quicksight-dashboard-insightconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-insightconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InsightConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.IntegerDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.IntegerDefaultValues`\n\nThe default values of the `IntegerParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerdefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `IntegerDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-dashboard-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerdefaultvalues.html#cfn-quicksight-dashboard-integerdefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `IntegerDefaultValues`.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerdefaultvalues.html#cfn-quicksight-dashboard-integerdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.IntegerParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.IntegerParameter`\n\nAn integer parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values for the integer parameter.\n*Required*: Yes\n*Type*: Array of Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameter.html#cfn-quicksight-dashboard-integerparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the integer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameter.html#cfn-quicksight-dashboard-integerparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.IntegerParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.IntegerParameterDeclaration`\n\nA parameter declaration for the `Integer` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-dashboard-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-integerparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [IntegerDefaultValues](./aws-properties-quicksight-dashboard-integerdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-integerparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "IntegerDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-integerparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nA parameter declaration for the `Integer` data type.\n*Required*: No\n*Type*: [IntegerValueWhenUnsetConfiguration](./aws-properties-quicksight-dashboard-integervaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-integerparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "IntegerValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-integerparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.IntegerValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.IntegerValueWhenUnsetConfiguration`\n\nA parameter declaration for the `Integer` data type.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integervaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integervaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-integervaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't set.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integervaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-integervaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.ItemsLimitConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ItemsLimitConfiguration`\n\nThe limit configuration of the visual display for an axis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-itemslimitconfiguration.html", "Properties": { "ItemsLimit": { "MarkdownDocumentation": "`ItemsLimit`\n\nThe limit on how many items of a field are showed in the chart. For\nexample, the number of slices that are displayed in a pie chart.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-itemslimitconfiguration.html#cfn-quicksight-dashboard-itemslimitconfiguration-itemslimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "OtherCategories": { "MarkdownDocumentation": "`OtherCategories`\n\nThe `Show\nother` of an axis in the chart. Choose one of the following options:\n* `INCLUDE`\n* `EXCLUDE`\n*Required*: No\n*Type*: String\n*Allowed values*: `INCLUDE | EXCLUDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCLUDE", "EXCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-itemslimitconfiguration.html#cfn-quicksight-dashboard-itemslimitconfiguration-othercategories", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.KPIActualValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIActualValueConditionalFormatting`\n\nThe conditional formatting for the actual value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiactualvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the actual value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiactualvalueconditionalformatting.html#cfn-quicksight-dashboard-kpiactualvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the actual value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-dashboard-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiactualvalueconditionalformatting.html#cfn-quicksight-dashboard-kpiactualvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Dashboard.KPIComparisonValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIComparisonValueConditionalFormatting`\n\nThe conditional formatting for the comparison value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpicomparisonvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the comparison value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-dashboard-kpicomparisonvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the comparison value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-dashboard-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-dashboard-kpicomparisonvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Dashboard.KPIConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIConditionalFormatting`\n\nThe conditional formatting of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nThe conditional formatting options of a KPI visual.\n*Required*: No\n*Type*: Array of [KPIConditionalFormattingOption](./aws-properties-quicksight-dashboard-kpiconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconditionalformatting.html#cfn-quicksight-dashboard-kpiconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KPIConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.KPIConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIConditionalFormattingOption`\n\nThe conditional formatting options of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconditionalformattingoption.html", "Properties": { "PrimaryValue": { "MarkdownDocumentation": "`PrimaryValue`\n\nThe conditional formatting for the primary value of a KPI visual.\n*Required*: No\n*Type*: [KPIPrimaryValueConditionalFormatting](./aws-properties-quicksight-dashboard-kpiprimaryvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconditionalformattingoption.html#cfn-quicksight-dashboard-kpiconditionalformattingoption-primaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIPrimaryValueConditionalFormatting" }, "ActualValue": { "MarkdownDocumentation": "`ActualValue`\n\nThe conditional formatting for the actual value of a KPI visual.\n*Required*: No\n*Type*: [KPIActualValueConditionalFormatting](./aws-properties-quicksight-dashboard-kpiactualvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconditionalformattingoption.html#cfn-quicksight-dashboard-kpiconditionalformattingoption-actualvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIActualValueConditionalFormatting" }, "ComparisonValue": { "MarkdownDocumentation": "`ComparisonValue`\n\nThe conditional formatting for the comparison value of a KPI visual.\n*Required*: No\n*Type*: [KPIComparisonValueConditionalFormatting](./aws-properties-quicksight-dashboard-kpicomparisonvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconditionalformattingoption.html#cfn-quicksight-dashboard-kpiconditionalformattingoption-comparisonvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIComparisonValueConditionalFormatting" }, "ProgressBar": { "MarkdownDocumentation": "`ProgressBar`\n\nThe conditional formatting for the progress bar of a KPI visual.\n*Required*: No\n*Type*: [KPIProgressBarConditionalFormatting](./aws-properties-quicksight-dashboard-kpiprogressbarconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconditionalformattingoption.html#cfn-quicksight-dashboard-kpiconditionalformattingoption-progressbar", "UpdateType": "Mutable", "Required": false, "Type": "KPIProgressBarConditionalFormatting" } } }, "AWS::QuickSight::Dashboard.KPIConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIConfiguration`\n\nThe configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a KPI visual.\n*Required*: No\n*Type*: [KPISortConfiguration](./aws-properties-quicksight-dashboard-kpisortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconfiguration.html#cfn-quicksight-dashboard-kpiconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "KPISortConfiguration" }, "KPIOptions": { "MarkdownDocumentation": "`KPIOptions`\n\nThe options that determine the presentation of a KPI visual.\n*Required*: No\n*Type*: [KPIOptions](./aws-properties-quicksight-dashboard-kpioptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconfiguration.html#cfn-quicksight-dashboard-kpiconfiguration-kpioptions", "UpdateType": "Mutable", "Required": false, "Type": "KPIOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a KPI visual.\n*Required*: No\n*Type*: [KPIFieldWells](./aws-properties-quicksight-dashboard-kpifieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconfiguration.html#cfn-quicksight-dashboard-kpiconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "KPIFieldWells" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconfiguration.html#cfn-quicksight-dashboard-kpiconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Dashboard.KPIFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIFieldWells`\n\nThe field well configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpifieldwells.html", "Properties": { "TargetValues": { "MarkdownDocumentation": "`TargetValues`\n\nThe target value field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpifieldwells.html#cfn-quicksight-dashboard-kpifieldwells-targetvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "TrendGroups": { "MarkdownDocumentation": "`TrendGroups`\n\nThe trend group field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpifieldwells.html#cfn-quicksight-dashboard-kpifieldwells-trendgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpifieldwells.html#cfn-quicksight-dashboard-kpifieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.KPIOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIOptions`\n\nThe options that determine the presentation of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html", "Properties": { "SecondaryValueFontConfiguration": { "MarkdownDocumentation": "`SecondaryValueFontConfiguration`\n\nThe options that determine the secondary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-secondaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "VisualLayoutOptions": { "MarkdownDocumentation": "`VisualLayoutOptions`\n\nThe options that determine the layout a KPI visual.\n*Required*: No\n*Type*: [KPIVisualLayoutOptions](./aws-properties-quicksight-dashboard-kpivisuallayoutoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-visuallayoutoptions", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisualLayoutOptions" }, "TrendArrows": { "MarkdownDocumentation": "`TrendArrows`\n\nThe options that determine the presentation of trend arrows in a KPI visual.\n*Required*: No\n*Type*: [TrendArrowOptions](./aws-properties-quicksight-dashboard-trendarrowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-trendarrows", "UpdateType": "Mutable", "Required": false, "Type": "TrendArrowOptions" }, "SecondaryValue": { "MarkdownDocumentation": "`SecondaryValue`\n\nThe options that determine the presentation of the secondary value of a KPI visual.\n*Required*: No\n*Type*: [SecondaryValueOptions](./aws-properties-quicksight-dashboard-secondaryvalueoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-secondaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "SecondaryValueOptions" }, "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe comparison configuration of a KPI visual.\n*Required*: No\n*Type*: [ComparisonConfiguration](./aws-properties-quicksight-dashboard-comparisonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-comparison", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonConfiguration" }, "PrimaryValueDisplayType": { "MarkdownDocumentation": "`PrimaryValueDisplayType`\n\nThe options that determine the primary value display type.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | COMPARISON | ACTUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "COMPARISON", "ACTUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-primaryvaluedisplaytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProgressBar": { "MarkdownDocumentation": "`ProgressBar`\n\nThe options that determine the presentation of the progress bar of a KPI visual.\n*Required*: No\n*Type*: [ProgressBarOptions](./aws-properties-quicksight-dashboard-progressbaroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-progressbar", "UpdateType": "Mutable", "Required": false, "Type": "ProgressBarOptions" }, "PrimaryValueFontConfiguration": { "MarkdownDocumentation": "`PrimaryValueFontConfiguration`\n\nThe options that determine the primary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-primaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Sparkline": { "MarkdownDocumentation": "`Sparkline`\n\nThe options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.\n*Required*: No\n*Type*: [KPISparklineOptions](./aws-properties-quicksight-dashboard-kpisparklineoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-sparkline", "UpdateType": "Mutable", "Required": false, "Type": "KPISparklineOptions" } } }, "AWS::QuickSight::Dashboard.KPIPrimaryValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIPrimaryValueConditionalFormatting`\n\nThe conditional formatting for the primary value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiprimaryvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the primary value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-dashboard-kpiprimaryvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the primary value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-dashboard-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-dashboard-kpiprimaryvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Dashboard.KPIProgressBarConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIProgressBarConditionalFormatting`\n\nThe conditional formatting for the progress bar of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiprogressbarconditionalformatting.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe conditional formatting of the progress bar's foreground color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiprogressbarconditionalformatting.html#cfn-quicksight-dashboard-kpiprogressbarconditionalformatting-foregroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Dashboard.KPISortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPISortConfiguration`\n\nThe sort configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpisortconfiguration.html", "Properties": { "TrendGroupSort": { "MarkdownDocumentation": "`TrendGroupSort`\n\nThe sort configuration of the trend group fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpisortconfiguration.html#cfn-quicksight-dashboard-kpisortconfiguration-trendgroupsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.KPISparklineOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPISparklineOptions`\n\nThe options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpisparklineoptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the sparkline.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LINE | AREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINE", "AREA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpisparklineoptions.html#cfn-quicksight-dashboard-kpisparklineoptions-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of the sparkline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpisparklineoptions.html#cfn-quicksight-dashboard-kpisparklineoptions-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipVisibility": { "MarkdownDocumentation": "`TooltipVisibility`\n\nThe tooltip visibility of the sparkline.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpisparklineoptions.html#cfn-quicksight-dashboard-kpisparklineoptions-tooltipvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the sparkline.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpisparklineoptions.html#cfn-quicksight-dashboard-kpisparklineoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.KPIVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIVisual`\n\nA key performance indicator (KPI).\nFor more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a KPI visual.\n*Required*: No\n*Type*: [KPIConditionalFormatting](./aws-properties-quicksight-dashboard-kpiconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "KPIConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a KPI visual.\n*Required*: No\n*Type*: [KPIConfiguration](./aws-properties-quicksight-dashboard-kpiconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "KPIConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.KPIVisualLayoutOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIVisualLayoutOptions`\n\nThe options that determine the layout a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisuallayoutoptions.html", "Properties": { "StandardLayout": { "MarkdownDocumentation": "`StandardLayout`\n\nThe standard layout of the KPI visual.\n*Required*: No\n*Type*: [KPIVisualStandardLayout](./aws-properties-quicksight-dashboard-kpivisualstandardlayout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisuallayoutoptions.html#cfn-quicksight-dashboard-kpivisuallayoutoptions-standardlayout", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisualStandardLayout" } } }, "AWS::QuickSight::Dashboard.KPIVisualStandardLayout": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.KPIVisualStandardLayout`\n\nThe standard layout of the KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisualstandardlayout.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe standard layout type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLASSIC | VERTICAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLASSIC", "VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisualstandardlayout.html#cfn-quicksight-dashboard-kpivisualstandardlayout-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.LabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LabelOptions`\n\nThe share label options for the labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-labeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe text for the label.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-labeloptions.html#cfn-quicksight-dashboard-labeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the label is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-labeloptions.html#cfn-quicksight-dashboard-labeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the label.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-labeloptions.html#cfn-quicksight-dashboard-labeloptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Dashboard.LayerCustomAction": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LayerCustomAction`\n\nA layer custom action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the `LayerCustomAction`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomaction.html#cfn-quicksight-dashboard-layercustomaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trigger": { "MarkdownDocumentation": "`Trigger`\n\nThe trigger of the `LayerCustomAction`.\nValid values are defined as follows:\n* `DATA_POINT_CLICK`: Initiates a custom action by a left pointer click on a data point.\n* `DATA_POINT_MENU`: Initiates a custom action by right pointer click from the menu.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DATA_POINT_CLICK | DATA_POI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DATA_POINT_CLICK", "DATA_POINT_MENU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomaction.html#cfn-quicksight-dashboard-layercustomaction-trigger", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomActionId": { "MarkdownDocumentation": "`CustomActionId`\n\nThe ID of the custom action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomaction.html#cfn-quicksight-dashboard-layercustomaction-customactionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the custom action.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomaction.html#cfn-quicksight-dashboard-layercustomaction-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionOperations": { "MarkdownDocumentation": "`ActionOperations`\n\nA list of `LayerCustomActionOperations`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: Array of [LayerCustomActionOperation](./aws-properties-quicksight-dashboard-layercustomactionoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomaction.html#cfn-quicksight-dashboard-layercustomaction-actionoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "LayerCustomActionOperation", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.LayerCustomActionOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LayerCustomActionOperation`\n\nThe operation that is defined by the custom action.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomactionoperation.html", "Properties": { "NavigationOperation": { "MarkdownDocumentation": "`NavigationOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionNavigationOperation](./aws-properties-quicksight-dashboard-customactionnavigationoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomactionoperation.html#cfn-quicksight-dashboard-layercustomactionoperation-navigationoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionNavigationOperation" }, "SetParametersOperation": { "MarkdownDocumentation": "`SetParametersOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionSetParametersOperation](./aws-properties-quicksight-dashboard-customactionsetparametersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomactionoperation.html#cfn-quicksight-dashboard-layercustomactionoperation-setparametersoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionSetParametersOperation" }, "FilterOperation": { "MarkdownDocumentation": "`FilterOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionFilterOperation](./aws-properties-quicksight-dashboard-customactionfilteroperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomactionoperation.html#cfn-quicksight-dashboard-layercustomactionoperation-filteroperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionFilterOperation" }, "URLOperation": { "MarkdownDocumentation": "`URLOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionURLOperation](./aws-properties-quicksight-dashboard-customactionurloperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layercustomactionoperation.html#cfn-quicksight-dashboard-layercustomactionoperation-urloperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionURLOperation" } } }, "AWS::QuickSight::Dashboard.LayerMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LayerMapVisual`\n\nA layer map visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layermapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layermapvisual.html#cfn-quicksight-dashboard-layermapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe ID of the visual.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layermapvisual.html#cfn-quicksight-dashboard-layermapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [GeospatialLayerMapConfiguration](./aws-properties-quicksight-dashboard-geospatiallayermapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layermapvisual.html#cfn-quicksight-dashboard-layermapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialLayerMapConfiguration" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe dataset that is used to create the layer map visual. You can't create a visual without a dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layermapvisual.html#cfn-quicksight-dashboard-layermapvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layermapvisual.html#cfn-quicksight-dashboard-layermapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layermapvisual.html#cfn-quicksight-dashboard-layermapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.Layout": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.Layout`\n\nA `Layout` defines the placement of elements within a sheet.\nFor more information, see [Types of layout](https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the *Amazon Quick Suite User Guide*.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layout.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration that determines what the type of layout for a sheet.\n*Required*: Yes\n*Type*: [LayoutConfiguration](./aws-properties-quicksight-dashboard-layoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layout.html#cfn-quicksight-dashboard-layout-configuration", "UpdateType": "Mutable", "Required": true, "Type": "LayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.LayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LayoutConfiguration`\n\nThe configuration that determines what the type of layout will be used on a sheet.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layoutconfiguration.html", "Properties": { "GridLayout": { "MarkdownDocumentation": "`GridLayout`\n\nA type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: `FIXED` or `RESPONSIVE`.\n*Required*: No\n*Type*: [GridLayoutConfiguration](./aws-properties-quicksight-dashboard-gridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layoutconfiguration.html#cfn-quicksight-dashboard-layoutconfiguration-gridlayout", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutConfiguration" }, "FreeFormLayout": { "MarkdownDocumentation": "`FreeFormLayout`\n\nA free-form is optimized for a fixed width and has more control over the exact placement of layout elements.\n*Required*: No\n*Type*: [FreeFormLayoutConfiguration](./aws-properties-quicksight-dashboard-freeformlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layoutconfiguration.html#cfn-quicksight-dashboard-layoutconfiguration-freeformlayout", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutConfiguration" }, "SectionBasedLayout": { "MarkdownDocumentation": "`SectionBasedLayout`\n\nA section based layout organizes visuals into multiple sections and has customized header, footer and page break.\n*Required*: No\n*Type*: [SectionBasedLayoutConfiguration](./aws-properties-quicksight-dashboard-sectionbasedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-layoutconfiguration.html#cfn-quicksight-dashboard-layoutconfiguration-sectionbasedlayout", "UpdateType": "Mutable", "Required": false, "Type": "SectionBasedLayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.LegendOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LegendOptions`\n\nThe options for the legend setup of a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html", "Properties": { "Position": { "MarkdownDocumentation": "`Position`\n\nThe positions for the legend. Choose one of the following\noptions:\n* `AUTO`\n* `RIGHT`\n* `BOTTOM`\n* `LEFT`\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTO | RIGHT | BOTTOM | TOP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "RIGHT", "BOTTOM", "TOP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueFontConfiguration": { "MarkdownDocumentation": "`ValueFontConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-valuefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe custom title for the legend.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-title", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the legend is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of the legend. If this value is omitted, a default height is used when\nrendering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of the legend. If this value is omitted, a default width is used when rendering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.LineChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartAggregatedFieldWells`\n\nThe field well configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field wells of a line chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartaggregatedfieldwells.html#cfn-quicksight-dashboard-linechartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field wells of a line chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartaggregatedfieldwells.html#cfn-quicksight-dashboard-linechartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a line chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartaggregatedfieldwells.html#cfn-quicksight-dashboard-linechartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a line chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartaggregatedfieldwells.html#cfn-quicksight-dashboard-linechartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.LineChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartConfiguration`\n\nThe configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a line chart.\n*Required*: No\n*Type*: [LineChartSortConfiguration](./aws-properties-quicksight-dashboard-linechartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend configuration of a line chart.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference lines configuration of a line chart.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-dashboard-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a line chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a line chart.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SingleAxisOptions": { "MarkdownDocumentation": "`SingleAxisOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [SingleAxisOptions](./aws-properties-quicksight-dashboard-singleaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-singleaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "SingleAxisOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-dashboard-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n*Required*: No\n*Type*: [LineSeriesAxisDisplayOptions](./aws-properties-quicksight-dashboard-lineseriesaxisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "LineSeriesAxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a line chart.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe options that determine the presentation of the x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DefaultSeriesSettings": { "MarkdownDocumentation": "`DefaultSeriesSettings`\n\nThe options that determine the default presentation of all line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartDefaultSeriesSettings](./aws-properties-quicksight-dashboard-linechartdefaultseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-defaultseriessettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartDefaultSeriesSettings" }, "SecondaryYAxisLabelOptions": { "MarkdownDocumentation": "`SecondaryYAxisLabelOptions`\n\nThe options that determine the presentation of the secondary y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-secondaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "ForecastConfigurations": { "MarkdownDocumentation": "`ForecastConfigurations`\n\nThe forecast configuration of a line chart.\n*Required*: No\n*Type*: Array of [ForecastConfiguration](./aws-properties-quicksight-dashboard-forecastconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-forecastconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ForecastConfiguration", "DuplicatesAllowed": true }, "Series": { "MarkdownDocumentation": "`Series`\n\nThe series item configuration of a line chart.\n*Required*: No\n*Type*: Array of [SeriesItem](./aws-properties-quicksight-dashboard-seriesitem.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-series", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SeriesItem", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nDetermines the type of the line chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINE | AREA | STACKED_AREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINE", "AREA", "STACKED_AREA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe options that determine the presentation of the y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe default configuration of a line chart's contribution analysis.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-dashboard-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a line chart.\n*Required*: No\n*Type*: [LineChartFieldWells](./aws-properties-quicksight-dashboard-linechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "LineChartFieldWells" }, "SecondaryYAxisDisplayOptions": { "MarkdownDocumentation": "`SecondaryYAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n*Required*: No\n*Type*: [LineSeriesAxisDisplayOptions](./aws-properties-quicksight-dashboard-lineseriesaxisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-secondaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "LineSeriesAxisDisplayOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe options that determine the presentation of the x-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Dashboard.LineChartDefaultSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartDefaultSeriesSettings`\n\nThe options that determine the default presentation of all line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartdefaultseriessettings.html", "Properties": { "LineStyleSettings": { "MarkdownDocumentation": "`LineStyleSettings`\n\nLine styles options for all line series in the visual.\n*Required*: No\n*Type*: [LineChartLineStyleSettings](./aws-properties-quicksight-dashboard-linechartlinestylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartdefaultseriessettings.html#cfn-quicksight-dashboard-linechartdefaultseriessettings-linestylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartLineStyleSettings" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis to which you are binding all line series to.\n*Required*: No\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartdefaultseriessettings.html#cfn-quicksight-dashboard-linechartdefaultseriessettings-axisbinding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerStyleSettings": { "MarkdownDocumentation": "`MarkerStyleSettings`\n\nMarker styles options for all line series in the visual.\n*Required*: No\n*Type*: [LineChartMarkerStyleSettings](./aws-properties-quicksight-dashboard-linechartmarkerstylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartdefaultseriessettings.html#cfn-quicksight-dashboard-linechartdefaultseriessettings-markerstylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartMarkerStyleSettings" } } }, "AWS::QuickSight::Dashboard.LineChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartFieldWells`\n\nThe field well configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartfieldwells.html", "Properties": { "LineChartAggregatedFieldWells": { "MarkdownDocumentation": "`LineChartAggregatedFieldWells`\n\nThe field well configuration of a line chart.\n*Required*: No\n*Type*: [LineChartAggregatedFieldWells](./aws-properties-quicksight-dashboard-linechartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartfieldwells.html#cfn-quicksight-dashboard-linechartfieldwells-linechartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "LineChartAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.LineChartLineStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartLineStyleSettings`\n\nLine styles options for a line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartlinestylesettings.html", "Properties": { "LineInterpolation": { "MarkdownDocumentation": "`LineInterpolation`\n\nInterpolation style for line series.\n* `LINEAR`: Show as default, linear style.\n* `SMOOTH`: Show as a smooth curve.\n* `STEPPED`: Show steps in line.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINEAR | SMOOTH | STEPPED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINEAR", "SMOOTH", "STEPPED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartlinestylesettings.html#cfn-quicksight-dashboard-linechartlinestylesettings-lineinterpolation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineStyle": { "MarkdownDocumentation": "`LineStyle`\n\nLine style for line series.\n* `SOLID`: Show as a solid line.\n* `DOTTED`: Show as a dotted line.\n* `DASHED`: Show as a dashed line.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DOTTED | DASHED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DOTTED", "DASHED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartlinestylesettings.html#cfn-quicksight-dashboard-linechartlinestylesettings-linestyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineVisibility": { "MarkdownDocumentation": "`LineVisibility`\n\nConfiguration option that determines whether to show the line for the series.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartlinestylesettings.html#cfn-quicksight-dashboard-linechartlinestylesettings-linevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineWidth": { "MarkdownDocumentation": "`LineWidth`\n\nWidth that determines the line thickness.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartlinestylesettings.html#cfn-quicksight-dashboard-linechartlinestylesettings-linewidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.LineChartMarkerStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartMarkerStyleSettings`\n\nMarker styles options for a line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartmarkerstylesettings.html", "Properties": { "MarkerShape": { "MarkdownDocumentation": "`MarkerShape`\n\nShape option for markers in the series.\n* `CIRCLE`: Show marker as a circle.\n* `TRIANGLE`: Show marker as a triangle.\n* `SQUARE`: Show marker as a square.\n* `DIAMOND`: Show marker as a diamond.\n* `ROUNDED_SQUARE`: Show marker as a rounded square.\n*Required*: No\n*Type*: String\n*Allowed values*: `CIRCLE | TRIANGLE | SQUARE ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIRCLE", "TRIANGLE", "SQUARE", "DIAMOND", "ROUNDED_SQUARE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartmarkerstylesettings.html#cfn-quicksight-dashboard-linechartmarkerstylesettings-markershape", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerSize": { "MarkdownDocumentation": "`MarkerSize`\n\nSize of marker in the series.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartmarkerstylesettings.html#cfn-quicksight-dashboard-linechartmarkerstylesettings-markersize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerVisibility": { "MarkdownDocumentation": "`MarkerVisibility`\n\nConfiguration option that determines whether to show the markers in the series.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartmarkerstylesettings.html#cfn-quicksight-dashboard-linechartmarkerstylesettings-markervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerColor": { "MarkdownDocumentation": "`MarkerColor`\n\nColor of marker in the series.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartmarkerstylesettings.html#cfn-quicksight-dashboard-linechartmarkerstylesettings-markercolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.LineChartSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartSeriesSettings`\n\nThe options that determine the presentation of a line series in the visual\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartseriessettings.html", "Properties": { "LineStyleSettings": { "MarkdownDocumentation": "`LineStyleSettings`\n\nLine styles options for a line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartLineStyleSettings](./aws-properties-quicksight-dashboard-linechartlinestylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartseriessettings.html#cfn-quicksight-dashboard-linechartseriessettings-linestylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartLineStyleSettings" }, "MarkerStyleSettings": { "MarkdownDocumentation": "`MarkerStyleSettings`\n\nMarker styles options for a line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartMarkerStyleSettings](./aws-properties-quicksight-dashboard-linechartmarkerstylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartseriessettings.html#cfn-quicksight-dashboard-linechartseriessettings-markerstylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartMarkerStyleSettings" } } }, "AWS::QuickSight::Dashboard.LineChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartSortConfiguration`\n\nThe sort configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartsortconfiguration.html", "Properties": { "CategoryItemsLimitConfiguration": { "MarkdownDocumentation": "`CategoryItemsLimitConfiguration`\n\nThe limit on the number of categories that are displayed in a line chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-linechartsortconfiguration-categoryitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "ColorItemsLimitConfiguration": { "MarkdownDocumentation": "`ColorItemsLimitConfiguration`\n\nThe limit on the number of lines that are displayed in a line chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-linechartsortconfiguration-coloritemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-linechartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-linechartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-linechartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Dashboard.LineChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineChartVisual`\n\nA line chart.\nFor more information, see [Using line charts](https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a line chart.\n*Required*: No\n*Type*: [LineChartConfiguration](./aws-properties-quicksight-dashboard-linechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LineChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.LineSeriesAxisDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LineSeriesAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-lineseriesaxisdisplayoptions.html", "Properties": { "MissingDataConfigurations": { "MarkdownDocumentation": "`MissingDataConfigurations`\n\nThe configuration options that determine how missing data is treated during the rendering of a line chart.\n*Required*: No\n*Type*: Array of [MissingDataConfiguration](./aws-properties-quicksight-dashboard-missingdataconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-lineseriesaxisdisplayoptions.html#cfn-quicksight-dashboard-lineseriesaxisdisplayoptions-missingdataconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MissingDataConfiguration", "DuplicatesAllowed": true }, "AxisOptions": { "MarkdownDocumentation": "`AxisOptions`\n\nThe options that determine the presentation of the line series axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-lineseriesaxisdisplayoptions.html#cfn-quicksight-dashboard-lineseriesaxisdisplayoptions-axisoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Dashboard.LinkSharingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LinkSharingConfiguration`\n\nA structure that contains the configuration of a shareable link to the\ndashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linksharingconfiguration.html", "Properties": { "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nA structure that contains the permissions of a shareable link.\n*Required*: No\n*Type*: Array of [ResourcePermission](./aws-properties-quicksight-dashboard-resourcepermission.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linksharingconfiguration.html#cfn-quicksight-dashboard-linksharingconfiguration-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourcePermission", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ListControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ListControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontroldisplayoptions.html#cfn-quicksight-dashboard-listcontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "SearchOptions": { "MarkdownDocumentation": "`SearchOptions`\n\nThe configuration of the search options in a list control.\n*Required*: No\n*Type*: [ListControlSearchOptions](./aws-properties-quicksight-dashboard-listcontrolsearchoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontroldisplayoptions.html#cfn-quicksight-dashboard-listcontroldisplayoptions-searchoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSearchOptions" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nThe configuration of the `Select all` options in a list control.\n*Required*: No\n*Type*: [ListControlSelectAllOptions](./aws-properties-quicksight-dashboard-listcontrolselectalloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontroldisplayoptions.html#cfn-quicksight-dashboard-listcontroldisplayoptions-selectalloptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSelectAllOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontroldisplayoptions.html#cfn-quicksight-dashboard-listcontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Dashboard.ListControlSearchOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ListControlSearchOptions`\n\nThe configuration of the search options in a list control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontrolsearchoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the search options in a list control.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontrolsearchoptions.html#cfn-quicksight-dashboard-listcontrolsearchoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ListControlSelectAllOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ListControlSelectAllOptions`\n\nThe configuration of the `Select all` options in a list control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontrolselectalloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the `Select all` options in a list control.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-listcontrolselectalloptions.html#cfn-quicksight-dashboard-listcontrolselectalloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.LoadingAnimation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LoadingAnimation`\n\nThe configuration of loading animation in free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-loadinganimation.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of `LoadingAnimation`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-loadinganimation.html#cfn-quicksight-dashboard-loadinganimation-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.LocalNavigationConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LocalNavigationConfiguration`\n\nThe navigation configuration for `CustomActionNavigationOperation`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-localnavigationconfiguration.html", "Properties": { "TargetSheetId": { "MarkdownDocumentation": "`TargetSheetId`\n\nThe sheet that is targeted for navigation in the same analysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-localnavigationconfiguration.html#cfn-quicksight-dashboard-localnavigationconfiguration-targetsheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.LongFormatText": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.LongFormatText`\n\nThe text format for a subtitle.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-longformattext.html", "Properties": { "RichText": { "MarkdownDocumentation": "`RichText`\n\nRich text. Examples of rich text include bold, underline, and italics.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-longformattext.html#cfn-quicksight-dashboard-longformattext-richtext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nPlain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-longformattext.html#cfn-quicksight-dashboard-longformattext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.MappedDataSetParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.MappedDataSetParameter`\n\nA dataset parameter that is mapped to an analysis parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-mappeddatasetparameter.html", "Properties": { "DataSetParameterName": { "MarkdownDocumentation": "`DataSetParameterName`\n\nThe name of the dataset parameter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-mappeddatasetparameter.html#cfn-quicksight-dashboard-mappeddatasetparameter-datasetparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nA unique name that identifies a dataset within the analysis or dashboard.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-mappeddatasetparameter.html#cfn-quicksight-dashboard-mappeddatasetparameter-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.MaximumLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.MaximumLabelType`\n\nThe maximum label of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumlabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the maximum label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumlabeltype.html#cfn-quicksight-dashboard-maximumlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.MaximumMinimumComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.MaximumMinimumComputation`\n\nThe maximum and minimum computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumminimumcomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of computation. Choose one of the following options:\n* MAXIMUM: A maximum computation.\n* MINIMUM: A minimum computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MAXIMUM | MINIMUM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MAXIMUM", "MINIMUM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-maximumminimumcomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-maximumminimumcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-maximumminimumcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-maximumminimumcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-maximumminimumcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.MeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.MeasureField`\n\nThe measure (metric) type field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html", "Properties": { "DateMeasureField": { "MarkdownDocumentation": "`DateMeasureField`\n\nThe measure type field with date type columns.\n*Required*: No\n*Type*: [DateMeasureField](./aws-properties-quicksight-dashboard-datemeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-datemeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "DateMeasureField" }, "NumericalMeasureField": { "MarkdownDocumentation": "`NumericalMeasureField`\n\nThe measure type field with numerical type columns.\n*Required*: No\n*Type*: [NumericalMeasureField](./aws-properties-quicksight-dashboard-numericalmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-numericalmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "NumericalMeasureField" }, "CategoricalMeasureField": { "MarkdownDocumentation": "`CategoricalMeasureField`\n\nThe measure type field with categorical type columns.\n*Required*: No\n*Type*: [CategoricalMeasureField](./aws-properties-quicksight-dashboard-categoricalmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-categoricalmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "CategoricalMeasureField" }, "CalculatedMeasureField": { "MarkdownDocumentation": "`CalculatedMeasureField`\n\nThe calculated measure field only used in pivot tables.\n*Required*: No\n*Type*: [CalculatedMeasureField](./aws-properties-quicksight-dashboard-calculatedmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-calculatedmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "CalculatedMeasureField" } } }, "AWS::QuickSight::Dashboard.MetricComparisonComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.MetricComparisonComputation`\n\nThe metric comparison computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-metriccomparisoncomputation.html", "Properties": { "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nThe field that is used in a metric comparison to value setup.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-metriccomparisoncomputation-targetvalue", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-metriccomparisoncomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-metriccomparisoncomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FromValue": { "MarkdownDocumentation": "`FromValue`\n\nThe field that is used in a metric comparison from value setup.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-metriccomparisoncomputation-fromvalue", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-metriccomparisoncomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.MinimumLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.MinimumLabelType`\n\nThe minimum label of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-minimumlabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the minimum label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-minimumlabeltype.html#cfn-quicksight-dashboard-minimumlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.MissingDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.MissingDataConfiguration`\n\nThe configuration options that determine how missing data is treated during the rendering of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-missingdataconfiguration.html", "Properties": { "TreatmentOption": { "MarkdownDocumentation": "`TreatmentOption`\n\nThe treatment option that determines how missing data should be rendered. Choose\nfrom the following options:\n* `INTERPOLATE`: Interpolate missing values between the prior and the next known value.\n* `SHOW_AS_ZERO`: Show missing values as the value `0`.\n* `SHOW_AS_BLANK`: Display a blank space when rendering missing data.\n*Required*: No\n*Type*: String\n*Allowed values*: `INTERPOLATE | SHOW_AS_ZERO ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INTERPOLATE", "SHOW_AS_ZERO", "SHOW_AS_BLANK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-missingdataconfiguration.html#cfn-quicksight-dashboard-missingdataconfiguration-treatmentoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NegativeValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-negativevalueconfiguration.html", "Properties": { "DisplayMode": { "MarkdownDocumentation": "`DisplayMode`\n\nDetermines the display mode of the negative value configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `POSITIVE | NEGATIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POSITIVE", "NEGATIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-negativevalueconfiguration.html#cfn-quicksight-dashboard-negativevalueconfiguration-displaymode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NestedFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NestedFilter`\n\nA `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-nestedfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-nestedfilter.html#cfn-quicksight-dashboard-nestedfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "InnerFilter": { "MarkdownDocumentation": "`InnerFilter`\n\nThe `InnerFilter` defines the subset of data to be used with the `NestedFilter`.\n*Required*: Yes\n*Type*: [InnerFilter](./aws-properties-quicksight-dashboard-innerfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-nestedfilter.html#cfn-quicksight-dashboard-nestedfilter-innerfilter", "UpdateType": "Mutable", "Required": true, "Type": "InnerFilter" }, "IncludeInnerSet": { "MarkdownDocumentation": "`IncludeInnerSet`\n\nA boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-nestedfilter.html#cfn-quicksight-dashboard-nestedfilter-includeinnerset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-nestedfilter.html#cfn-quicksight-dashboard-nestedfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NullValueFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-nullvalueformatconfiguration.html", "Properties": { "NullString": { "MarkdownDocumentation": "`NullString`\n\nDetermines the null string of null values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-nullvalueformatconfiguration.html#cfn-quicksight-dashboard-nullvalueformatconfiguration-nullstring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumberDisplayFormatConfiguration`\n\nThe options that determine the number display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-dashboard-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-numberdisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-dashboard-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-numberdisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NumberScale": { "MarkdownDocumentation": "`NumberScale`\n\nDetermines the number scale value of the number format.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AUTO | THOUSANDS | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-numberdisplayformatconfiguration-numberscale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-dashboard-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-numberdisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the number format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-numberdisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-dashboard-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-numberdisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the number format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-numberdisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NumberFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumberFormatConfiguration`\n\nFormatting configuration for number fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberformatconfiguration.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe options that determine the numeric format configuration.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-dashboard-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numberformatconfiguration.html#cfn-quicksight-dashboard-numberformatconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" } } }, "AWS::QuickSight::Dashboard.NumericAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericAxisOptions`\n\nThe options for an axis with a numeric field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericaxisoptions.html", "Properties": { "Scale": { "MarkdownDocumentation": "`Scale`\n\nThe scale setup of a numeric axis.\n*Required*: No\n*Type*: [AxisScale](./aws-properties-quicksight-dashboard-axisscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericaxisoptions.html#cfn-quicksight-dashboard-numericaxisoptions-scale", "UpdateType": "Mutable", "Required": false, "Type": "AxisScale" }, "Range": { "MarkdownDocumentation": "`Range`\n\nThe range setup of a numeric axis.\n*Required*: No\n*Type*: [AxisDisplayRange](./aws-properties-quicksight-dashboard-axisdisplayrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericaxisoptions.html#cfn-quicksight-dashboard-numericaxisoptions-range", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayRange" } } }, "AWS::QuickSight::Dashboard.NumericEqualityDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericEqualityDrillDownFilter`\n\nThe numeric equality type drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalitydrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalitydrilldownfilter.html#cfn-quicksight-dashboard-numericequalitydrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the double input numeric drill down filter.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalitydrilldownfilter.html#cfn-quicksight-dashboard-numericequalitydrilldownfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.NumericEqualityFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericEqualityFilter`\n\nA `NumericEqualityFilter` filters values that are equal to the specified value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the filter.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-dashboard-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe input value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_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)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NumericFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericFormatConfiguration`\n\nThe options that determine the numeric format configuration.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericformatconfiguration.html", "Properties": { "NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`NumberDisplayFormatConfiguration`\n\nThe options that determine the number display format configuration.\n*Required*: No\n*Type*: [NumberDisplayFormatConfiguration](./aws-properties-quicksight-dashboard-numberdisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericformatconfiguration.html#cfn-quicksight-dashboard-numericformatconfiguration-numberdisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberDisplayFormatConfiguration" }, "CurrencyDisplayFormatConfiguration": { "MarkdownDocumentation": "`CurrencyDisplayFormatConfiguration`\n\nThe options that determine the currency display format configuration.\n*Required*: No\n*Type*: [CurrencyDisplayFormatConfiguration](./aws-properties-quicksight-dashboard-currencydisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericformatconfiguration.html#cfn-quicksight-dashboard-numericformatconfiguration-currencydisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CurrencyDisplayFormatConfiguration" }, "PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`PercentageDisplayFormatConfiguration`\n\nThe options that determine the percentage display format configuration.\n*Required*: No\n*Type*: [PercentageDisplayFormatConfiguration](./aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericformatconfiguration.html#cfn-quicksight-dashboard-numericformatconfiguration-percentagedisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PercentageDisplayFormatConfiguration" } } }, "AWS::QuickSight::Dashboard.NumericRangeFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericRangeFilter`\n\nA `NumericRangeFilter` filters values that are within the value range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the filter.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-dashboard-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "IncludeMaximum": { "MarkdownDocumentation": "`IncludeMaximum`\n\nDetermines whether the maximum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-includemaximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RangeMinimum": { "MarkdownDocumentation": "`RangeMinimum`\n\nThe minimum value for the filter value range.\n*Required*: No\n*Type*: [NumericRangeFilterValue](./aws-properties-quicksight-dashboard-numericrangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-rangeminimum", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilterValue" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeMaximum": { "MarkdownDocumentation": "`RangeMaximum`\n\nThe maximum value for the filter value range.\n*Required*: No\n*Type*: [NumericRangeFilterValue](./aws-properties-quicksight-dashboard-numericrangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-rangemaximum", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilterValue" }, "IncludeMinimum": { "MarkdownDocumentation": "`IncludeMinimum`\n\nDetermines whether the minimum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-includeminimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Dashboard.NumericRangeFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericRangeFilterValue`\n\nThe value input pf the numeric range filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefiltervalue.html", "Properties": { "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nThe static value of the numeric range filter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefiltervalue.html#cfn-quicksight-dashboard-numericrangefiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Parameter": { "MarkdownDocumentation": "`Parameter`\n\nThe parameter that is used in the numeric range.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefiltervalue.html#cfn-quicksight-dashboard-numericrangefiltervalue-parameter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NumericSeparatorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericSeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericseparatorconfiguration.html", "Properties": { "DecimalSeparator": { "MarkdownDocumentation": "`DecimalSeparator`\n\nDetermines the decimal separator.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMMA | DOT | SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMMA", "DOT", "SPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericseparatorconfiguration.html#cfn-quicksight-dashboard-numericseparatorconfiguration-decimalseparator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThousandsSeparator": { "MarkdownDocumentation": "`ThousandsSeparator`\n\nThe options that determine the thousands separator configuration.\n*Required*: No\n*Type*: [ThousandSeparatorOptions](./aws-properties-quicksight-dashboard-thousandseparatoroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericseparatorconfiguration.html#cfn-quicksight-dashboard-numericseparatorconfiguration-thousandsseparator", "UpdateType": "Mutable", "Required": false, "Type": "ThousandSeparatorOptions" } } }, "AWS::QuickSight::Dashboard.NumericalAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericalAggregationFunction`\n\nAggregation for numerical values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericalaggregationfunction.html", "Properties": { "PercentileAggregation": { "MarkdownDocumentation": "`PercentileAggregation`\n\nAn aggregation based on the percentile of values in a dimension or measure.\n*Required*: No\n*Type*: [PercentileAggregation](./aws-properties-quicksight-dashboard-percentileaggregation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericalaggregationfunction.html#cfn-quicksight-dashboard-numericalaggregationfunction-percentileaggregation", "UpdateType": "Mutable", "Required": false, "Type": "PercentileAggregation" }, "SimpleNumericalAggregation": { "MarkdownDocumentation": "`SimpleNumericalAggregation`\n\nBuilt-in aggregation functions for numerical values.\n* `SUM`: The sum of a dimension or measure.\n* `AVERAGE`: The average of a dimension or measure.\n* `MIN`: The minimum value of a dimension or measure.\n* `MAX`: The maximum value of a dimension or measure.\n* `COUNT`: The count of a dimension or measure.\n* `DISTINCT_COUNT`: The count of distinct values in a dimension or measure.\n* `VAR`: The variance of a dimension or measure.\n* `VARP`: The partitioned variance of a dimension or measure.\n* `STDEV`: The standard deviation of a dimension or measure.\n* `STDEVP`: The partitioned standard deviation of a dimension or measure.\n* `MEDIAN`: The median value of a dimension or measure.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUM | AVERAGE | MIN | MAX |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUM", "AVERAGE", "MIN", "MAX", "COUNT", "DISTINCT_COUNT", "VAR", "VARP", "STDEV", "STDEVP", "MEDIAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericalaggregationfunction.html#cfn-quicksight-dashboard-numericalaggregationfunction-simplenumericalaggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NumericalDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericalDimensionField`\n\nThe dimension type field with numerical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericaldimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericaldimensionfield.html#cfn-quicksight-dashboard-numericaldimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-dashboard-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericaldimensionfield.html#cfn-quicksight-dashboard-numericaldimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `NumericalDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericaldimensionfield.html#cfn-quicksight-dashboard-numericaldimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericaldimensionfield.html#cfn-quicksight-dashboard-numericaldimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.NumericalMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.NumericalMeasureField`\n\nThe measure type field with numerical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericalmeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-dashboard-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericalmeasurefield.html#cfn-quicksight-dashboard-numericalmeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "NumericalAggregationFunction" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-dashboard-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericalmeasurefield.html#cfn-quicksight-dashboard-numericalmeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `NumericalMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericalmeasurefield.html#cfn-quicksight-dashboard-numericalmeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericalmeasurefield.html#cfn-quicksight-dashboard-numericalmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PaginationConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PaginationConfiguration`\n\nThe pagination configuration for a table visual or boxplot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-paginationconfiguration.html", "Properties": { "PageSize": { "MarkdownDocumentation": "`PageSize`\n\nIndicates how many items render in one page.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-paginationconfiguration.html#cfn-quicksight-dashboard-paginationconfiguration-pagesize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "PageNumber": { "MarkdownDocumentation": "`PageNumber`\n\nIndicates the page number.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-paginationconfiguration.html#cfn-quicksight-dashboard-paginationconfiguration-pagenumber", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.PanelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PanelConfiguration`\n\nA collection of options that configure how each panel displays in a small multiples chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html", "Properties": { "BorderThickness": { "MarkdownDocumentation": "`BorderThickness`\n\nSets the line thickness of panel borders.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-borderthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BorderStyle": { "MarkdownDocumentation": "`BorderStyle`\n\nSets the line style of panel borders.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DASHED | DOTTED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DASHED", "DOTTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-borderstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GutterSpacing": { "MarkdownDocumentation": "`GutterSpacing`\n\nSets the total amount of negative space to display between sibling panels.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-gutterspacing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundVisibility": { "MarkdownDocumentation": "`BackgroundVisibility`\n\nDetermines whether or not a background for each small multiples panel is rendered.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-backgroundvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BorderVisibility": { "MarkdownDocumentation": "`BorderVisibility`\n\nDetermines whether or not each panel displays a border.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-bordervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BorderColor": { "MarkdownDocumentation": "`BorderColor`\n\nSets the line color of panel borders.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-bordercolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nConfigures the title display within each small multiples panel.\n*Required*: No\n*Type*: [PanelTitleOptions](./aws-properties-quicksight-dashboard-paneltitleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-title", "UpdateType": "Mutable", "Required": false, "Type": "PanelTitleOptions" }, "GutterVisibility": { "MarkdownDocumentation": "`GutterVisibility`\n\nDetermines whether or not negative space between sibling panels is rendered.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-guttervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nSets the background color for each panel.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PanelTitleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PanelTitleOptions`\n\nThe options that determine the title styles for each small multiples\npanel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-paneltitleoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not panel titles are displayed.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-paneltitleoptions.html#cfn-quicksight-dashboard-paneltitleoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-paneltitleoptions.html#cfn-quicksight-dashboard-paneltitleoptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "HorizontalTextAlignment": { "MarkdownDocumentation": "`HorizontalTextAlignment`\n\nSets the horizontal text alignment of the title within each panel.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-paneltitleoptions.html#cfn-quicksight-dashboard-paneltitleoptions-horizontaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ParameterControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterControl`\n\nThe control of a parameter that users can interact with in a dashboard or an analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html", "Properties": { "Slider": { "MarkdownDocumentation": "`Slider`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n*Required*: No\n*Type*: [ParameterSliderControl](./aws-properties-quicksight-dashboard-parameterslidercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-slider", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSliderControl" }, "TextArea": { "MarkdownDocumentation": "`TextArea`\n\nA control to display a text box that is used to enter multiple entries.\n*Required*: No\n*Type*: [ParameterTextAreaControl](./aws-properties-quicksight-dashboard-parametertextareacontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-textarea", "UpdateType": "Mutable", "Required": false, "Type": "ParameterTextAreaControl" }, "Dropdown": { "MarkdownDocumentation": "`Dropdown`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n*Required*: No\n*Type*: [ParameterDropDownControl](./aws-properties-quicksight-dashboard-parameterdropdowncontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-dropdown", "UpdateType": "Mutable", "Required": false, "Type": "ParameterDropDownControl" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nA control to display a text box that is used to enter a single entry.\n*Required*: No\n*Type*: [ParameterTextFieldControl](./aws-properties-quicksight-dashboard-parametertextfieldcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-textfield", "UpdateType": "Mutable", "Required": false, "Type": "ParameterTextFieldControl" }, "List": { "MarkdownDocumentation": "`List`\n\nA control to display a list with buttons or boxes that are used to select either a single value or multiple values.\n*Required*: No\n*Type*: [ParameterListControl](./aws-properties-quicksight-dashboard-parameterlistcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-list", "UpdateType": "Mutable", "Required": false, "Type": "ParameterListControl" }, "DateTimePicker": { "MarkdownDocumentation": "`DateTimePicker`\n\nA control from a date parameter that specifies date and time.\n*Required*: No\n*Type*: [ParameterDateTimePickerControl](./aws-properties-quicksight-dashboard-parameterdatetimepickercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-datetimepicker", "UpdateType": "Mutable", "Required": false, "Type": "ParameterDateTimePickerControl" } } }, "AWS::QuickSight::Dashboard.ParameterDateTimePickerControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterDateTimePickerControl`\n\nA control from a date parameter that specifies date and time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdatetimepickercontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdatetimepickercontrol.html#cfn-quicksight-dashboard-parameterdatetimepickercontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdatetimepickercontrol.html#cfn-quicksight-dashboard-parameterdatetimepickercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe name of the `ParameterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdatetimepickercontrol.html#cfn-quicksight-dashboard-parameterdatetimepickercontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterDateTimePickerControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdatetimepickercontrol.html#cfn-quicksight-dashboard-parameterdatetimepickercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterDeclaration`\n\nThe declaration definition of a parameter.\nFor more information, see [Parameters in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the *Amazon Quick Suite User Guide*.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdeclaration.html", "Properties": { "StringParameterDeclaration": { "MarkdownDocumentation": "`StringParameterDeclaration`\n\nA parameter declaration for the `String` data type.\n*Required*: No\n*Type*: [StringParameterDeclaration](./aws-properties-quicksight-dashboard-stringparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdeclaration.html#cfn-quicksight-dashboard-parameterdeclaration-stringparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "StringParameterDeclaration" }, "DateTimeParameterDeclaration": { "MarkdownDocumentation": "`DateTimeParameterDeclaration`\n\nA parameter declaration for the `DateTime` data type.\n*Required*: No\n*Type*: [DateTimeParameterDeclaration](./aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdeclaration.html#cfn-quicksight-dashboard-parameterdeclaration-datetimeparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeParameterDeclaration" }, "DecimalParameterDeclaration": { "MarkdownDocumentation": "`DecimalParameterDeclaration`\n\nA parameter declaration for the `Decimal` data type.\n*Required*: No\n*Type*: [DecimalParameterDeclaration](./aws-properties-quicksight-dashboard-decimalparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdeclaration.html#cfn-quicksight-dashboard-parameterdeclaration-decimalparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalParameterDeclaration" }, "IntegerParameterDeclaration": { "MarkdownDocumentation": "`IntegerParameterDeclaration`\n\nA parameter declaration for the `Integer` data type.\n*Required*: No\n*Type*: [IntegerParameterDeclaration](./aws-properties-quicksight-dashboard-integerparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdeclaration.html#cfn-quicksight-dashboard-parameterdeclaration-integerparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "IntegerParameterDeclaration" } } }, "AWS::QuickSight::Dashboard.ParameterDropDownControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterDropDownControl`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type parameter name of the `ParameterDropDownControl`.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-dashboard-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-dashboard-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterDropDownControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `ParameterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [ParameterSelectableValues](./aws-properties-quicksight-dashboard-parameterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSelectableValues" } } }, "AWS::QuickSight::Dashboard.ParameterListControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterListControl`\n\nA control to display a list with buttons or boxes that are used to select either a single value or multiple values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of `ParameterListControl`.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-dashboard-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-dashboard-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterListControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [ParameterSelectableValues](./aws-properties-quicksight-dashboard-parameterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSelectableValues" } } }, "AWS::QuickSight::Dashboard.ParameterSelectableValues": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterSelectableValues`\n\nA list of selectable values that are used in a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterselectablevalues.html", "Properties": { "LinkToDataSetColumn": { "MarkdownDocumentation": "`LinkToDataSetColumn`\n\nThe column identifier that fetches values from the data set.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterselectablevalues.html#cfn-quicksight-dashboard-parameterselectablevalues-linktodatasetcolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are used in `ParameterSelectableValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterselectablevalues.html#cfn-quicksight-dashboard-parameterselectablevalues-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ParameterSliderControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterSliderControl`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-dashboard-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterSliderControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.ParameterTextAreaControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterTextAreaControl`\n\nA control to display a text box that is used to enter multiple entries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-dashboard-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ParameterTextFieldControl": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ParameterTextFieldControl`\n\nA control to display a text box that is used to enter a single entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextfieldcontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextfieldcontrol.html#cfn-quicksight-dashboard-parametertextfieldcontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-dashboard-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextfieldcontrol.html#cfn-quicksight-dashboard-parametertextfieldcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextfieldcontrol.html#cfn-quicksight-dashboard-parametertextfieldcontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterTextFieldControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextfieldcontrol.html#cfn-quicksight-dashboard-parametertextfieldcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.Parameters": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.Parameters`\n\nA list of Quick Sight parameters and the list's override values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html", "Properties": { "StringParameters": { "MarkdownDocumentation": "`StringParameters`\n\nThe parameters that have a data type of string.\n*Required*: No\n*Type*: Array of [StringParameter](./aws-properties-quicksight-dashboard-stringparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html#cfn-quicksight-dashboard-parameters-stringparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringParameter", "DuplicatesAllowed": true }, "DecimalParameters": { "MarkdownDocumentation": "`DecimalParameters`\n\nThe parameters that have a data type of decimal.\n*Required*: No\n*Type*: Array of [DecimalParameter](./aws-properties-quicksight-dashboard-decimalparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html#cfn-quicksight-dashboard-parameters-decimalparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DecimalParameter", "DuplicatesAllowed": true }, "IntegerParameters": { "MarkdownDocumentation": "`IntegerParameters`\n\nThe parameters that have a data type of integer.\n*Required*: No\n*Type*: Array of [IntegerParameter](./aws-properties-quicksight-dashboard-integerparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html#cfn-quicksight-dashboard-parameters-integerparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IntegerParameter", "DuplicatesAllowed": true }, "DateTimeParameters": { "MarkdownDocumentation": "`DateTimeParameters`\n\nThe parameters that have a data type of date-time.\n*Required*: No\n*Type*: Array of [DateTimeParameter](./aws-properties-quicksight-dashboard-datetimeparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html#cfn-quicksight-dashboard-parameters-datetimeparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateTimeParameter", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PercentVisibleRange": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PercentVisibleRange`\n\nThe percent range in the visible range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentvisiblerange.html", "Properties": { "From": { "MarkdownDocumentation": "`From`\n\nThe lower bound of the range.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentvisiblerange.html#cfn-quicksight-dashboard-percentvisiblerange-from", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "To": { "MarkdownDocumentation": "`To`\n\nThe top bound of the range.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentvisiblerange.html#cfn-quicksight-dashboard-percentvisiblerange-to", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PercentageDisplayFormatConfiguration`\n\nThe options that determine the percentage display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-dashboard-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-percentagedisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-dashboard-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-percentagedisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-dashboard-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-percentagedisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the percentage format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-percentagedisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-dashboard-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-percentagedisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the percentage format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-percentagedisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PercentileAggregation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PercentileAggregation`\n\nAn aggregation based on the percentile of values in a dimension or measure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentileaggregation.html", "Properties": { "PercentileValue": { "MarkdownDocumentation": "`PercentileValue`\n\nThe percentile value. This value can be any numeric constant 0\u2013100. A percentile value of 50 computes the median value of the measure.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentileaggregation.html#cfn-quicksight-dashboard-percentileaggregation-percentilevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.PeriodOverPeriodComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PeriodOverPeriodComputation`\n\nThe period over period computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodoverperiodcomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodoverperiodcomputation.html#cfn-quicksight-dashboard-periodoverperiodcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodoverperiodcomputation.html#cfn-quicksight-dashboard-periodoverperiodcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodoverperiodcomputation.html#cfn-quicksight-dashboard-periodoverperiodcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodoverperiodcomputation.html#cfn-quicksight-dashboard-periodoverperiodcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PeriodToDateComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PeriodToDateComputation`\n\nThe period to date computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodtodatecomputation.html", "Properties": { "PeriodTimeGranularity": { "MarkdownDocumentation": "`PeriodTimeGranularity`\n\nThe time granularity setup of period to date computation. Choose from the following options:\n* YEAR: Year to date.\n* MONTH: Month to date.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-periodtodatecomputation-periodtimegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-periodtodatecomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-periodtodatecomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-periodtodatecomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-periodtodatecomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PieChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PieChartAggregatedFieldWells`\n\nThe field well configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category (group/color) field wells of a pie chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartaggregatedfieldwells.html#cfn-quicksight-dashboard-piechartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a pie chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartaggregatedfieldwells.html#cfn-quicksight-dashboard-piechartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a pie chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartaggregatedfieldwells.html#cfn-quicksight-dashboard-piechartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PieChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PieChartConfiguration`\n\nThe configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartSortConfiguration](./aws-properties-quicksight-dashboard-piechartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PieChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe contribution analysis (anomaly configuration) setup of the visual.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-dashboard-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options of the group/color that is displayed in a pie chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [PieChartFieldWells](./aws-properties-quicksight-dashboard-piechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PieChartFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "DonutOptions": { "MarkdownDocumentation": "`DonutOptions`\n\nThe options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.\n*Required*: No\n*Type*: [DonutOptions](./aws-properties-quicksight-dashboard-donutoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-donutoptions", "UpdateType": "Mutable", "Required": false, "Type": "DonutOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-dashboard-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options for the value that is displayed in a pie chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Dashboard.PieChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PieChartFieldWells`\n\nThe field well configuration of a pie chart.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartfieldwells.html", "Properties": { "PieChartAggregatedFieldWells": { "MarkdownDocumentation": "`PieChartAggregatedFieldWells`\n\nThe field well configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartAggregatedFieldWells](./aws-properties-quicksight-dashboard-piechartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartfieldwells.html#cfn-quicksight-dashboard-piechartfieldwells-piechartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PieChartAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.PieChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PieChartSortConfiguration`\n\nThe sort configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartsortconfiguration.html", "Properties": { "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartsortconfiguration.html#cfn-quicksight-dashboard-piechartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories that are displayed in a pie chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartsortconfiguration.html#cfn-quicksight-dashboard-piechartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartsortconfiguration.html#cfn-quicksight-dashboard-piechartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartsortconfiguration.html#cfn-quicksight-dashboard-piechartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Dashboard.PieChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PieChartVisual`\n\nA pie or donut chart.\nThe `PieChartVisual` structure describes a visual that is a member of the pie chart family.\nThe following charts can be described by using this structure:\n* Pie charts\n* Donut charts\nFor more information, see [Using pie charts](https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the *Amazon Quick Suite User Guide*.\nFor more information, see [Using donut charts](https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartConfiguration](./aws-properties-quicksight-dashboard-piechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PieChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PivotFieldSortOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotFieldSortOptions`\n\nThe field sort options for a pivot table sort configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivotfieldsortoptions.html", "Properties": { "SortBy": { "MarkdownDocumentation": "`SortBy`\n\nThe sort by field for the field sort options.\n*Required*: Yes\n*Type*: [PivotTableSortBy](./aws-properties-quicksight-dashboard-pivottablesortby.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivotfieldsortoptions.html#cfn-quicksight-dashboard-pivotfieldsortoptions-sortby", "UpdateType": "Mutable", "Required": true, "Type": "PivotTableSortBy" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for the field sort options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivotfieldsortoptions.html#cfn-quicksight-dashboard-pivotfieldsortoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTableAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableAggregatedFieldWells`\n\nThe aggregated field well for the pivot table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are aggregated based on rows and columns fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableaggregatedfieldwells.html#cfn-quicksight-dashboard-pivottableaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe columns field well for a pivot table. Values are grouped by columns fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableaggregatedfieldwells.html#cfn-quicksight-dashboard-pivottableaggregatedfieldwells-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Rows": { "MarkdownDocumentation": "`Rows`\n\nThe rows field well for a pivot table. Values are grouped by rows fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableaggregatedfieldwells.html#cfn-quicksight-dashboard-pivottableaggregatedfieldwells-rows", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PivotTableCellConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableCellConditionalFormatting`\n\nThe cell conditional formatting option for a pivot table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablecellconditionalformatting.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope of the cell for conditional formatting.\n*Required*: No\n*Type*: [PivotTableConditionalFormattingScope](./aws-properties-quicksight-dashboard-pivottableconditionalformattingscope.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablecellconditionalformatting.html#cfn-quicksight-dashboard-pivottablecellconditionalformatting-scope", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConditionalFormattingScope" }, "Scopes": { "MarkdownDocumentation": "`Scopes`\n\nA list of cell scopes for conditional formatting.\n*Required*: No\n*Type*: Array of [PivotTableConditionalFormattingScope](./aws-properties-quicksight-dashboard-pivottableconditionalformattingscope.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablecellconditionalformatting.html#cfn-quicksight-dashboard-pivottablecellconditionalformatting-scopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableConditionalFormattingScope", "DuplicatesAllowed": true }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the cell for conditional formatting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablecellconditionalformatting.html#cfn-quicksight-dashboard-pivottablecellconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TextFormat": { "MarkdownDocumentation": "`TextFormat`\n\nThe text format of the cell for conditional formatting.\n*Required*: No\n*Type*: [TextConditionalFormat](./aws-properties-quicksight-dashboard-textconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablecellconditionalformatting.html#cfn-quicksight-dashboard-pivottablecellconditionalformatting-textformat", "UpdateType": "Mutable", "Required": false, "Type": "TextConditionalFormat" } } }, "AWS::QuickSight::Dashboard.PivotTableConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options for a `PivotTableVisual`.\n*Required*: No\n*Type*: Array of [PivotTableConditionalFormattingOption](./aws-properties-quicksight-dashboard-pivottableconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconditionalformatting.html#cfn-quicksight-dashboard-pivottableconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PivotTableConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableConditionalFormattingOption`\n\nConditional formatting options for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconditionalformattingoption.html", "Properties": { "Cell": { "MarkdownDocumentation": "`Cell`\n\nThe cell conditional formatting option for a pivot table.\n*Required*: No\n*Type*: [PivotTableCellConditionalFormatting](./aws-properties-quicksight-dashboard-pivottablecellconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconditionalformattingoption.html#cfn-quicksight-dashboard-pivottableconditionalformattingoption-cell", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableCellConditionalFormatting" } } }, "AWS::QuickSight::Dashboard.PivotTableConditionalFormattingScope": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableConditionalFormattingScope`\n\nThe scope of the cell for conditional formatting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconditionalformattingscope.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe role (field, field total, grand total) of the cell for conditional formatting.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIELD | FIELD_TOTAL | GRAND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIELD", "FIELD_TOTAL", "GRAND_TOTAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconditionalformattingscope.html#cfn-quicksight-dashboard-pivottableconditionalformattingscope-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTableConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableConfiguration`\n\nThe configuration for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration for a `PivotTableVisual`.\n*Required*: No\n*Type*: [PivotTableSortConfiguration](./aws-properties-quicksight-dashboard-pivottablesortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableSortConfiguration" }, "PaginatedReportOptions": { "MarkdownDocumentation": "`PaginatedReportOptions`\n\nThe paginated report options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTablePaginatedReportOptions](./aws-properties-quicksight-dashboard-pivottablepaginatedreportoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-paginatedreportoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTablePaginatedReportOptions" }, "TableOptions": { "MarkdownDocumentation": "`TableOptions`\n\nThe table options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableOptions](./aws-properties-quicksight-dashboard-pivottableoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-tableoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [PivotTableFieldWells](./aws-properties-quicksight-dashboard-pivottablefieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableFieldWells" }, "FieldOptions": { "MarkdownDocumentation": "`FieldOptions`\n\nThe field options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableFieldOptions](./aws-properties-quicksight-dashboard-pivottablefieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-fieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableFieldOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "TotalOptions": { "MarkdownDocumentation": "`TotalOptions`\n\nThe total options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableTotalOptions](./aws-properties-quicksight-dashboard-pivottabletotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-totaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableTotalOptions" } } }, "AWS::QuickSight::Dashboard.PivotTableDataPathOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableDataPathOption`\n\nThe data path options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabledatapathoption.html", "Properties": { "DataPathList": { "MarkdownDocumentation": "`DataPathList`\n\nThe list of data path values for the data path options.\n*Required*: Yes\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-dashboard-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabledatapathoption.html#cfn-quicksight-dashboard-pivottabledatapathoption-datapathlist", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of the data path 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabledatapathoption.html#cfn-quicksight-dashboard-pivottabledatapathoption-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTableFieldCollapseStateOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableFieldCollapseStateOption`\n\nThe collapse state options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldcollapsestateoption.html", "Properties": { "Target": { "MarkdownDocumentation": "`Target`\n\nA tagged-union object that sets the collapse state.\n*Required*: Yes\n*Type*: [PivotTableFieldCollapseStateTarget](./aws-properties-quicksight-dashboard-pivottablefieldcollapsestatetarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldcollapsestateoption.html#cfn-quicksight-dashboard-pivottablefieldcollapsestateoption-target", "UpdateType": "Mutable", "Required": true, "Type": "PivotTableFieldCollapseStateTarget" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the field target of a pivot table. Choose one of the following options:\n* `COLLAPSED`\n* `EXPANDED`\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)", "RefReturnValue": "", "AllowedValues": [ "COLLAPSED", "EXPANDED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldcollapsestateoption.html#cfn-quicksight-dashboard-pivottablefieldcollapsestateoption-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTableFieldCollapseStateTarget": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableFieldCollapseStateTarget`\n\nThe target of a pivot table field collapse state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldcollapsestatetarget.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the pivot table that the collapse state needs to be set 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldcollapsestatetarget.html#cfn-quicksight-dashboard-pivottablefieldcollapsestatetarget-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldDataPathValues": { "MarkdownDocumentation": "`FieldDataPathValues`\n\nThe data path of the pivot table's header. Used to set the collapse state.\n*Required*: No\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-dashboard-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldcollapsestatetarget.html#cfn-quicksight-dashboard-pivottablefieldcollapsestatetarget-fielddatapathvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PivotTableFieldOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableFieldOption`\n\nThe selected field options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoption.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label of the pivot table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoption.html#cfn-quicksight-dashboard-pivottablefieldoption-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the pivot table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoption.html#cfn-quicksight-dashboard-pivottablefieldoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the pivot table field.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoption.html#cfn-quicksight-dashboard-pivottablefieldoption-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTableFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableFieldOptions`\n\nThe field options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoptions.html", "Properties": { "CollapseStateOptions": { "MarkdownDocumentation": "`CollapseStateOptions`\n\nThe collapse state options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableFieldCollapseStateOption](./aws-properties-quicksight-dashboard-pivottablefieldcollapsestateoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-pivottablefieldoptions-collapsestateoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldCollapseStateOption", "DuplicatesAllowed": true }, "DataPathOptions": { "MarkdownDocumentation": "`DataPathOptions`\n\nThe data path options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableDataPathOption](./aws-properties-quicksight-dashboard-pivottabledatapathoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-pivottablefieldoptions-datapathoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableDataPathOption", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nThe selected field options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableFieldOption](./aws-properties-quicksight-dashboard-pivottablefieldoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-pivottablefieldoptions-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PivotTableFieldSubtotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableFieldSubtotalOptions`\n\nThe optional configuration of subtotals cells.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldsubtotaloptions.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the subtotal options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldsubtotaloptions.html#cfn-quicksight-dashboard-pivottablefieldsubtotaloptions-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTableFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableFieldWells`\n\nThe field wells for a pivot table visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldwells.html", "Properties": { "PivotTableAggregatedFieldWells": { "MarkdownDocumentation": "`PivotTableAggregatedFieldWells`\n\nThe aggregated field well for the pivot table.\n*Required*: No\n*Type*: [PivotTableAggregatedFieldWells](./aws-properties-quicksight-dashboard-pivottableaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldwells.html#cfn-quicksight-dashboard-pivottablefieldwells-pivottableaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.PivotTableOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableOptions`\n\nThe table options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html", "Properties": { "RowFieldNamesStyle": { "MarkdownDocumentation": "`RowFieldNamesStyle`\n\nThe table cell style of row field names.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-rowfieldnamesstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "RowHeaderStyle": { "MarkdownDocumentation": "`RowHeaderStyle`\n\nThe table cell style of the row headers.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-rowheaderstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "CollapsedRowDimensionsVisibility": { "MarkdownDocumentation": "`CollapsedRowDimensionsVisibility`\n\nThe visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is `HIDDEN`, all collapsed columns in a pivot table are automatically hidden. The default value is `VISIBLE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-collapsedrowdimensionsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowsLayout": { "MarkdownDocumentation": "`RowsLayout`\n\nThe layout for the row dimension headers of a pivot table. Choose one of the following options.\n* `TABULAR`: (Default) Each row field is displayed in a separate column.\n* `HIERARCHY`: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `TABULAR | HIERARCHY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TABULAR", "HIERARCHY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-rowslayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricPlacement": { "MarkdownDocumentation": "`MetricPlacement`\n\nThe metric placement (row, column) options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ROW | COLUMN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROW", "COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-metricplacement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultCellWidth": { "MarkdownDocumentation": "`DefaultCellWidth`\n\nThe default cell width of the pivot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-defaultcellwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnNamesVisibility": { "MarkdownDocumentation": "`ColumnNamesVisibility`\n\nThe visibility of the column names.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-columnnamesvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowsLabelOptions": { "MarkdownDocumentation": "`RowsLabelOptions`\n\nThe options for the label that is located above the row headers. This option is only applicable when `RowsLayout` is set to `HIERARCHY`.\n*Required*: No\n*Type*: [PivotTableRowsLabelOptions](./aws-properties-quicksight-dashboard-pivottablerowslabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-rowslabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableRowsLabelOptions" }, "SingleMetricVisibility": { "MarkdownDocumentation": "`SingleMetricVisibility`\n\nThe visibility of the single metric options.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-singlemetricvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHeaderStyle": { "MarkdownDocumentation": "`ColumnHeaderStyle`\n\nThe table cell style of the column header.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-columnheaderstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "ToggleButtonsVisibility": { "MarkdownDocumentation": "`ToggleButtonsVisibility`\n\nDetermines the visibility of the pivot table.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-togglebuttonsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CellStyle": { "MarkdownDocumentation": "`CellStyle`\n\nThe table cell style of cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-cellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "RowAlternateColorOptions": { "MarkdownDocumentation": "`RowAlternateColorOptions`\n\nThe row alternate color options (widget status, row alternate colors).\n*Required*: No\n*Type*: [RowAlternateColorOptions](./aws-properties-quicksight-dashboard-rowalternatecoloroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-rowalternatecoloroptions", "UpdateType": "Mutable", "Required": false, "Type": "RowAlternateColorOptions" } } }, "AWS::QuickSight::Dashboard.PivotTablePaginatedReportOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTablePaginatedReportOptions`\n\nThe paginated report options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablepaginatedreportoptions.html", "Properties": { "OverflowColumnHeaderVisibility": { "MarkdownDocumentation": "`OverflowColumnHeaderVisibility`\n\nThe visibility of the repeating header rows on each page.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablepaginatedreportoptions.html#cfn-quicksight-dashboard-pivottablepaginatedreportoptions-overflowcolumnheadervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VerticalOverflowVisibility": { "MarkdownDocumentation": "`VerticalOverflowVisibility`\n\nThe visibility of the printing table overflow across pages.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablepaginatedreportoptions.html#cfn-quicksight-dashboard-pivottablepaginatedreportoptions-verticaloverflowvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTableRowsLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableRowsLabelOptions`\n\nThe options for the label thta is located above the row headers. This option is only applicable when `RowsLayout` is set to `HIERARCHY`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablerowslabeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the rows label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablerowslabeloptions.html#cfn-quicksight-dashboard-pivottablerowslabeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the rows label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablerowslabeloptions.html#cfn-quicksight-dashboard-pivottablerowslabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTableSortBy": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableSortBy`\n\nThe sort by field for the field sort options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablesortby.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field sort (field id, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [FieldSort](./aws-properties-quicksight-dashboard-fieldsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablesortby.html#cfn-quicksight-dashboard-pivottablesortby-field", "UpdateType": "Mutable", "Required": false, "Type": "FieldSort" }, "DataPath": { "MarkdownDocumentation": "`DataPath`\n\nThe data path sort (data path value, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [DataPathSort](./aws-properties-quicksight-dashboard-datapathsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablesortby.html#cfn-quicksight-dashboard-pivottablesortby-datapath", "UpdateType": "Mutable", "Required": false, "Type": "DataPathSort" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column sort (field id, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [ColumnSort](./aws-properties-quicksight-dashboard-columnsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablesortby.html#cfn-quicksight-dashboard-pivottablesortby-column", "UpdateType": "Mutable", "Required": false, "Type": "ColumnSort" } } }, "AWS::QuickSight::Dashboard.PivotTableSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableSortConfiguration`\n\nThe sort configuration for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablesortconfiguration.html", "Properties": { "FieldSortOptions": { "MarkdownDocumentation": "`FieldSortOptions`\n\nThe field sort options for a pivot table sort configuration.\n*Required*: No\n*Type*: [Array](./aws-properties-quicksight-dashboard-fieldsortoptions.html) of [PivotFieldSortOptions](./aws-properties-quicksight-dashboard-pivotfieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablesortconfiguration.html#cfn-quicksight-dashboard-pivottablesortconfiguration-fieldsortoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotFieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PivotTableTotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableTotalOptions`\n\nThe total options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabletotaloptions.html", "Properties": { "ColumnSubtotalOptions": { "MarkdownDocumentation": "`ColumnSubtotalOptions`\n\nThe column subtotal options.\n*Required*: No\n*Type*: [SubtotalOptions](./aws-properties-quicksight-dashboard-subtotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabletotaloptions.html#cfn-quicksight-dashboard-pivottabletotaloptions-columnsubtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "SubtotalOptions" }, "RowSubtotalOptions": { "MarkdownDocumentation": "`RowSubtotalOptions`\n\nThe row subtotal options.\n*Required*: No\n*Type*: [SubtotalOptions](./aws-properties-quicksight-dashboard-subtotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabletotaloptions.html#cfn-quicksight-dashboard-pivottabletotaloptions-rowsubtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "SubtotalOptions" }, "RowTotalOptions": { "MarkdownDocumentation": "`RowTotalOptions`\n\nThe row total options.\n*Required*: No\n*Type*: [PivotTotalOptions](./aws-properties-quicksight-dashboard-pivottotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabletotaloptions.html#cfn-quicksight-dashboard-pivottabletotaloptions-rowtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTotalOptions" }, "ColumnTotalOptions": { "MarkdownDocumentation": "`ColumnTotalOptions`\n\nThe column total options.\n*Required*: No\n*Type*: [PivotTotalOptions](./aws-properties-quicksight-dashboard-pivottotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabletotaloptions.html#cfn-quicksight-dashboard-pivottabletotaloptions-columntotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTotalOptions" } } }, "AWS::QuickSight::Dashboard.PivotTableVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTableVisual`\n\nA pivot table.\nFor more information, see [Using pivot tables](https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n*Required*: No\n*Type*: [PivotTableConditionalFormatting](./aws-properties-quicksight-dashboard-pivottableconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [PivotTableConfiguration](./aws-properties-quicksight-dashboard-pivottableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PivotTotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PivotTotalOptions`\n\nThe optional configuration of totals cells in a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html", "Properties": { "TotalAggregationOptions": { "MarkdownDocumentation": "`TotalAggregationOptions`\n\nThe total aggregation options for each value field.\n*Required*: No\n*Type*: Array of [TotalAggregationOption](./aws-properties-quicksight-dashboard-totalaggregationoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-totalaggregationoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TotalAggregationOption", "DuplicatesAllowed": true }, "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the total cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueCellStyle": { "MarkdownDocumentation": "`ValueCellStyle`\n\nThe cell styling options for the totals of value cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-valuecellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "ScrollStatus": { "MarkdownDocumentation": "`ScrollStatus`\n\nThe scroll status (pinned, scrolled) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `PINNED | SCROLLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PINNED", "SCROLLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-scrollstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe placement (start, end) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `START | END | AUTO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "START", "END", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nThe cell styling options for the total cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricHeaderCellStyle": { "MarkdownDocumentation": "`MetricHeaderCellStyle`\n\nThe cell styling options for the total of header cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-metricheadercellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" } } }, "AWS::QuickSight::Dashboard.PluginVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PluginVisual`\n\nA flexible visualization type that allows engineers\nto create new custom charts in Quick Sight.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisual.html#cfn-quicksight-dashboard-pluginvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "PluginArn": { "MarkdownDocumentation": "`PluginArn`\n\nThe Amazon Resource Name (ARN) that reflects the plugin and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisual.html#cfn-quicksight-dashboard-pluginvisual-pluginarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe ID of the visual that you want to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisual.html#cfn-quicksight-dashboard-pluginvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nA description of the plugin field wells and their persisted properties.\n*Required*: No\n*Type*: [PluginVisualConfiguration](./aws-properties-quicksight-dashboard-pluginvisualconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisual.html#cfn-quicksight-dashboard-pluginvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisual.html#cfn-quicksight-dashboard-pluginvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisual.html#cfn-quicksight-dashboard-pluginvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PluginVisualConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PluginVisualConfiguration`\n\nThe plugin visual configuration. This includes the field wells, sorting options, and persisted options of the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of the plugin visual.\n*Required*: No\n*Type*: [PluginVisualSortConfiguration](./aws-properties-quicksight-dashboard-pluginvisualsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualconfiguration.html#cfn-quicksight-dashboard-pluginvisualconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualSortConfiguration" }, "VisualOptions": { "MarkdownDocumentation": "`VisualOptions`\n\nThe persisted properties of the plugin visual.\n*Required*: No\n*Type*: [PluginVisualOptions](./aws-properties-quicksight-dashboard-pluginvisualoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualconfiguration.html#cfn-quicksight-dashboard-pluginvisualconfiguration-visualoptions", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells configuration of the plugin visual.\n*Required*: No\n*Type*: Array of [PluginVisualFieldWell](./aws-properties-quicksight-dashboard-pluginvisualfieldwell.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualconfiguration.html#cfn-quicksight-dashboard-pluginvisualconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PluginVisualFieldWell", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PluginVisualFieldWell": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PluginVisualFieldWell`\n\nA collection of field wells for a plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualfieldwell.html", "Properties": { "Unaggregated": { "MarkdownDocumentation": "`Unaggregated`\n\nA list of unaggregated fields that exist in the field well.\n*Required*: No\n*Type*: Array of [UnaggregatedField](./aws-properties-quicksight-dashboard-unaggregatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualfieldwell.html#cfn-quicksight-dashboard-pluginvisualfieldwell-unaggregated", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UnaggregatedField", "DuplicatesAllowed": true }, "AxisName": { "MarkdownDocumentation": "`AxisName`\n\nThe semantic axis name for the field well.\n*Required*: No\n*Type*: String\n*Allowed values*: `GROUP_BY | VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GROUP_BY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualfieldwell.html#cfn-quicksight-dashboard-pluginvisualfieldwell-axisname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Measures": { "MarkdownDocumentation": "`Measures`\n\nA list of measures that exist in the field well.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualfieldwell.html#cfn-quicksight-dashboard-pluginvisualfieldwell-measures", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nA list of dimensions for the field well.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualfieldwell.html#cfn-quicksight-dashboard-pluginvisualfieldwell-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PluginVisualItemsLimitConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PluginVisualItemsLimitConfiguration`\n\nA query limits configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualitemslimitconfiguration.html", "Properties": { "ItemsLimit": { "MarkdownDocumentation": "`ItemsLimit`\n\nDetermines how many values are be fetched at once.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualitemslimitconfiguration.html#cfn-quicksight-dashboard-pluginvisualitemslimitconfiguration-itemslimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.PluginVisualOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PluginVisualOptions`\n\nThe options and persisted properties for the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualoptions.html", "Properties": { "VisualProperties": { "MarkdownDocumentation": "`VisualProperties`\n\nThe persisted properties and their values.\n*Required*: No\n*Type*: Array of [PluginVisualProperty](./aws-properties-quicksight-dashboard-pluginvisualproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualoptions.html#cfn-quicksight-dashboard-pluginvisualoptions-visualproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PluginVisualProperty", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PluginVisualProperty": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PluginVisualProperty`\n\nThe key value pair of the persisted property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualproperty.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the plugin visual 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualproperty.html#cfn-quicksight-dashboard-pluginvisualproperty-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the plugin visual 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualproperty.html#cfn-quicksight-dashboard-pluginvisualproperty-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.PluginVisualSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PluginVisualSortConfiguration`\n\nDetermines how the plugin visual sorts the data during query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualsortconfiguration.html", "Properties": { "PluginVisualTableQuerySort": { "MarkdownDocumentation": "`PluginVisualTableQuerySort`\n\nThe table query sorting options for the plugin visual.\n*Required*: No\n*Type*: [PluginVisualTableQuerySort](./aws-properties-quicksight-dashboard-pluginvisualtablequerysort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualsortconfiguration.html#cfn-quicksight-dashboard-pluginvisualsortconfiguration-pluginvisualtablequerysort", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualTableQuerySort" } } }, "AWS::QuickSight::Dashboard.PluginVisualTableQuerySort": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PluginVisualTableQuerySort`\n\nThe table query sorting options for the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualtablequerysort.html", "Properties": { "ItemsLimitConfiguration": { "MarkdownDocumentation": "`ItemsLimitConfiguration`\n\nThe maximum amount of data to be returned by a query.\n*Required*: No\n*Type*: [PluginVisualItemsLimitConfiguration](./aws-properties-quicksight-dashboard-pluginvisualitemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualtablequerysort.html#cfn-quicksight-dashboard-pluginvisualtablequerysort-itemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualItemsLimitConfiguration" }, "RowSort": { "MarkdownDocumentation": "`RowSort`\n\nDetermines how data is sorted in the response.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pluginvisualtablequerysort.html#cfn-quicksight-dashboard-pluginvisualtablequerysort-rowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.PredefinedHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.PredefinedHierarchy`\n\nThe option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-predefinedhierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the predefined hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-predefinedhierarchy.html#cfn-quicksight-dashboard-predefinedhierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the predefined hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-dashboard-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-predefinedhierarchy.html#cfn-quicksight-dashboard-predefinedhierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe list of columns that define the predefined hierarchy.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-predefinedhierarchy.html#cfn-quicksight-dashboard-predefinedhierarchy-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ProgressBarOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ProgressBarOptions`\n\nThe options that determine the presentation of the progress bar of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-progressbaroptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the progress bar.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-progressbaroptions.html#cfn-quicksight-dashboard-progressbaroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.QuickSuiteActionsOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.QuickSuiteActionsOption`\n\nDetermines if Actions in Amazon Quick Suite are enabled in a dashboard..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-quicksuiteactionsoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nAvailability status.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-quicksuiteactionsoption.html#cfn-quicksight-dashboard-quicksuiteactionsoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.RadarChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RadarChartAggregatedFieldWells`\n\nThe aggregated field well configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe aggregated field well categories of a radar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartaggregatedfieldwells.html#cfn-quicksight-dashboard-radarchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that are assigned to the aggregated field wells of a radar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartaggregatedfieldwells.html#cfn-quicksight-dashboard-radarchartaggregatedfieldwells-color", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are assigned to the aggregated field wells of a radar chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartaggregatedfieldwells.html#cfn-quicksight-dashboard-radarchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.RadarChartAreaStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RadarChartAreaStyleSettings`\n\nThe configured style settings of a radar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartareastylesettings.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility settings of a radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartareastylesettings.html#cfn-quicksight-dashboard-radarchartareastylesettings-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.RadarChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RadarChartConfiguration`\n\nThe configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `RadarChartVisual`.\n*Required*: No\n*Type*: [RadarChartSortConfiguration](./aws-properties-quicksight-dashboard-radarchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "Shape": { "MarkdownDocumentation": "`Shape`\n\nThe shape of the radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `CIRCLE | POLYGON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIRCLE", "POLYGON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-shape", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseSeriesSettings": { "MarkdownDocumentation": "`BaseSeriesSettings`\n\nThe base sreies settings of a radar chart.\n*Required*: No\n*Type*: [RadarChartSeriesSettings](./aws-properties-quicksight-dashboard-radarchartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-baseseriessettings", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartSeriesSettings" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe color label options of a radar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe category label options of a radar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "AxesRangeScale": { "MarkdownDocumentation": "`AxesRangeScale`\n\nThe axis behavior options of a radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTO | INDEPENDENT | SHARED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "INDEPENDENT", "SHARED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-axesrangescale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "AlternateBandColorsVisibility": { "MarkdownDocumentation": "`AlternateBandColorsVisibility`\n\nDetermines the visibility of the colors of alternatign bands in a radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-alternatebandcolorsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartAngle": { "MarkdownDocumentation": "`StartAngle`\n\nThe start angle of a radar chart's axis.\n*Required*: No\n*Type*: Number\n*Minimum*: `-360`\n*Maximum*: `360`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-startangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe category axis of a radar chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `RadarChartVisual`.\n*Required*: No\n*Type*: [RadarChartFieldWells](./aws-properties-quicksight-dashboard-radarchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartFieldWells" }, "ColorAxis": { "MarkdownDocumentation": "`ColorAxis`\n\nThe color axis of a radar chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-coloraxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "AlternateBandOddColor": { "MarkdownDocumentation": "`AlternateBandOddColor`\n\nThe color of the odd-numbered alternate bands of a radar chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-alternatebandoddcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "AlternateBandEvenColor": { "MarkdownDocumentation": "`AlternateBandEvenColor`\n\nThe color of the even-numbered alternate bands of a radar chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-alternatebandevencolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.RadarChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RadarChartFieldWells`\n\nThe field wells of a radar chart visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartfieldwells.html", "Properties": { "RadarChartAggregatedFieldWells": { "MarkdownDocumentation": "`RadarChartAggregatedFieldWells`\n\nThe aggregated field wells of a radar chart visual.\n*Required*: No\n*Type*: [RadarChartAggregatedFieldWells](./aws-properties-quicksight-dashboard-radarchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartfieldwells.html#cfn-quicksight-dashboard-radarchartfieldwells-radarchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.RadarChartSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RadarChartSeriesSettings`\n\nThe series settings of a radar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartseriessettings.html", "Properties": { "AreaStyleSettings": { "MarkdownDocumentation": "`AreaStyleSettings`\n\nThe area style settings of a radar chart.\n*Required*: No\n*Type*: [RadarChartAreaStyleSettings](./aws-properties-quicksight-dashboard-radarchartareastylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartseriessettings.html#cfn-quicksight-dashboard-radarchartseriessettings-areastylesettings", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartAreaStyleSettings" } } }, "AWS::QuickSight::Dashboard.RadarChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RadarChartSortConfiguration`\n\nThe sort configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartsortconfiguration.html", "Properties": { "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe color sort configuration of a radar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartsortconfiguration.html#cfn-quicksight-dashboard-radarchartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe color items limit of a radar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartsortconfiguration.html#cfn-quicksight-dashboard-radarchartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe category items limit for a radar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartsortconfiguration.html#cfn-quicksight-dashboard-radarchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe category sort options of a radar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartsortconfiguration.html#cfn-quicksight-dashboard-radarchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.RadarChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RadarChartVisual`\n\nA radar chart visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [RadarChartConfiguration](./aws-properties-quicksight-dashboard-radarchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.RangeEndsLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RangeEndsLabelType`\n\nThe range ends label type of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rangeendslabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the range ends label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rangeendslabeltype.html#cfn-quicksight-dashboard-rangeendslabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ReferenceLine": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ReferenceLine`\n\nThe reference line visual display options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referenceline.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the reference line. Choose one of the following options:\n* `ENABLE`\n* `DISABLE`\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referenceline.html#cfn-quicksight-dashboard-referenceline-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataConfiguration": { "MarkdownDocumentation": "`DataConfiguration`\n\nThe data configuration of the reference line.\n*Required*: Yes\n*Type*: [ReferenceLineDataConfiguration](./aws-properties-quicksight-dashboard-referencelinedataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referenceline.html#cfn-quicksight-dashboard-referenceline-dataconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ReferenceLineDataConfiguration" }, "LabelConfiguration": { "MarkdownDocumentation": "`LabelConfiguration`\n\nThe label configuration of the reference line.\n*Required*: No\n*Type*: [ReferenceLineLabelConfiguration](./aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referenceline.html#cfn-quicksight-dashboard-referenceline-labelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineLabelConfiguration" }, "StyleConfiguration": { "MarkdownDocumentation": "`StyleConfiguration`\n\nThe style configuration of the reference line.\n*Required*: No\n*Type*: [ReferenceLineStyleConfiguration](./aws-properties-quicksight-dashboard-referencelinestyleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referenceline.html#cfn-quicksight-dashboard-referenceline-styleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineStyleConfiguration" } } }, "AWS::QuickSight::Dashboard.ReferenceLineCustomLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ReferenceLineCustomLabelConfiguration`\n\nThe configuration for a custom label on a `ReferenceLine`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinecustomlabelconfiguration.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe string text of the custom label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinecustomlabelconfiguration.html#cfn-quicksight-dashboard-referencelinecustomlabelconfiguration-customlabel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ReferenceLineDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ReferenceLineDataConfiguration`\n\nThe data configuration of the reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedataconfiguration.html", "Properties": { "DynamicConfiguration": { "MarkdownDocumentation": "`DynamicConfiguration`\n\nThe dynamic configuration of the reference line data configuration.\n*Required*: No\n*Type*: [ReferenceLineDynamicDataConfiguration](./aws-properties-quicksight-dashboard-referencelinedynamicdataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedataconfiguration.html#cfn-quicksight-dashboard-referencelinedataconfiguration-dynamicconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineDynamicDataConfiguration" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis binding type of the reference line. Choose one of the following options:\n* `PrimaryY`\n* `SecondaryY`\n*Required*: No\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedataconfiguration.html#cfn-quicksight-dashboard-referencelinedataconfiguration-axisbinding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeriesType": { "MarkdownDocumentation": "`SeriesType`\n\nThe series type of the reference line data configuration. Choose one of the following options:\n* `BAR`\n* `LINE`\n*Required*: No\n*Type*: String\n*Allowed values*: `BAR | LINE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedataconfiguration.html#cfn-quicksight-dashboard-referencelinedataconfiguration-seriestype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StaticConfiguration": { "MarkdownDocumentation": "`StaticConfiguration`\n\nThe static data configuration of the reference line data configuration.\n*Required*: No\n*Type*: [ReferenceLineStaticDataConfiguration](./aws-properties-quicksight-dashboard-referencelinestaticdataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedataconfiguration.html#cfn-quicksight-dashboard-referencelinedataconfiguration-staticconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineStaticDataConfiguration" } } }, "AWS::QuickSight::Dashboard.ReferenceLineDynamicDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ReferenceLineDynamicDataConfiguration`\n\nThe dynamic configuration of the reference line data configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedynamicdataconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the dynamic data targets.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedynamicdataconfiguration.html#cfn-quicksight-dashboard-referencelinedynamicdataconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "MeasureAggregationFunction": { "MarkdownDocumentation": "`MeasureAggregationFunction`\n\nThe aggregation function that is used in the dynamic data.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-dashboard-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedynamicdataconfiguration.html#cfn-quicksight-dashboard-referencelinedynamicdataconfiguration-measureaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Calculation": { "MarkdownDocumentation": "`Calculation`\n\nThe calculation that is used in the dynamic data.\n*Required*: Yes\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-dashboard-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedynamicdataconfiguration.html#cfn-quicksight-dashboard-referencelinedynamicdataconfiguration-calculation", "UpdateType": "Mutable", "Required": true, "Type": "NumericalAggregationFunction" } } }, "AWS::QuickSight::Dashboard.ReferenceLineLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ReferenceLineLabelConfiguration`\n\nThe label configuration of a reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html", "Properties": { "HorizontalPosition": { "MarkdownDocumentation": "`HorizontalPosition`\n\nThe horizontal position configuration of the label in a reference line. Choose one of\nthe following options:\n* `LEFT`\n* `CENTER`\n* `RIGHT`\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-horizontalposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueLabelConfiguration": { "MarkdownDocumentation": "`ValueLabelConfiguration`\n\nThe value label configuration of the label in a reference line.\n*Required*: No\n*Type*: [ReferenceLineValueLabelConfiguration](./aws-properties-quicksight-dashboard-referencelinevaluelabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-valuelabelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineValueLabelConfiguration" }, "CustomLabelConfiguration": { "MarkdownDocumentation": "`CustomLabelConfiguration`\n\nThe custom label configuration of the label in a reference line.\n*Required*: No\n*Type*: [ReferenceLineCustomLabelConfiguration](./aws-properties-quicksight-dashboard-referencelinecustomlabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-customlabelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineCustomLabelConfiguration" }, "FontColor": { "MarkdownDocumentation": "`FontColor`\n\nThe font color configuration of the label in a reference line.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-fontcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the label in a reference line.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "VerticalPosition": { "MarkdownDocumentation": "`VerticalPosition`\n\nThe vertical position configuration of the label in a reference line. Choose one of the following options:\n* `ABOVE`\n* `BELOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `ABOVE | BELOW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ABOVE", "BELOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-verticalposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ReferenceLineStaticDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ReferenceLineStaticDataConfiguration`\n\nThe static data configuration of the reference line data configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinestaticdataconfiguration.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe double input of the static data.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinestaticdataconfiguration.html#cfn-quicksight-dashboard-referencelinestaticdataconfiguration-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.ReferenceLineStyleConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ReferenceLineStyleConfiguration`\n\nThe style configuration of the reference\nline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinestyleconfiguration.html", "Properties": { "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nThe pattern type of the line style. Choose one of the following options:\n* `SOLID`\n* `DASHED`\n* `DOTTED`\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DASHED | DOTTED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DASHED", "DOTTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinestyleconfiguration.html#cfn-quicksight-dashboard-referencelinestyleconfiguration-pattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe hex color of the reference line.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinestyleconfiguration.html#cfn-quicksight-dashboard-referencelinestyleconfiguration-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ReferenceLineValueLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ReferenceLineValueLabelConfiguration`\n\nThe value label configuration of the label in a reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinevaluelabelconfiguration.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the value label.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-dashboard-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinevaluelabelconfiguration.html#cfn-quicksight-dashboard-referencelinevaluelabelconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "RelativePosition": { "MarkdownDocumentation": "`RelativePosition`\n\nThe relative position of the value label. Choose one of the following options:\n* `BEFORE_CUSTOM_LABEL`\n* `AFTER_CUSTOM_LABEL`\n*Required*: No\n*Type*: String\n*Allowed values*: `BEFORE_CUSTOM_LABEL | AFTER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BEFORE_CUSTOM_LABEL", "AFTER_CUSTOM_LABEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinevaluelabelconfiguration.html#cfn-quicksight-dashboard-referencelinevaluelabelconfiguration-relativeposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.RelativeDateTimeControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RelativeDateTimeControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatetimecontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatetimecontroldisplayoptions.html#cfn-quicksight-dashboard-relativedatetimecontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatetimecontroldisplayoptions.html#cfn-quicksight-dashboard-relativedatetimecontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nCustomize how dates are formatted in controls.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatetimecontroldisplayoptions.html#cfn-quicksight-dashboard-relativedatetimecontroldisplayoptions-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.RelativeDatesFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RelativeDatesFilter`\n\nA `RelativeDatesFilter` filters relative dates values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html", "Properties": { "RelativeDateValue": { "MarkdownDocumentation": "`RelativeDateValue`\n\nThe date value of the filter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-relativedatevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RelativeDateType": { "MarkdownDocumentation": "`RelativeDateType`\n\nThe range date type of the filter. Choose one of the options below:\n* `PREVIOUS`\n* `THIS`\n* `LAST`\n* `NOW`\n* `NEXT`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PREVIOUS | THIS | LAST | NO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PREVIOUS", "THIS", "LAST", "NOW", "NEXT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-relativedatetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-timegranularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AnchorDateConfiguration": { "MarkdownDocumentation": "`AnchorDateConfiguration`\n\nThe date configuration of the filter.\n*Required*: Yes\n*Type*: [AnchorDateConfiguration](./aws-properties-quicksight-dashboard-anchordateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-anchordateconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "AnchorDateConfiguration" }, "MinimumGranularity": { "MarkdownDocumentation": "`MinimumGranularity`\n\nThe minimum granularity (period granularity) of the relative dates filter.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-minimumgranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExcludePeriodConfiguration": { "MarkdownDocumentation": "`ExcludePeriodConfiguration`\n\nThe configuration for the exclude period of the filter.\n*Required*: No\n*Type*: [ExcludePeriodConfiguration](./aws-properties-quicksight-dashboard-excludeperiodconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-excludeperiodconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExcludePeriodConfiguration" } } }, "AWS::QuickSight::Dashboard.ResourcePermission": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ResourcePermission`\n\nPermission for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-resourcepermission.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe IAM action to grant or revoke permissions on.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-resourcepermission.html#cfn-quicksight-dashboard-resourcepermission-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe Amazon Resource Name (ARN) of the principal. This can be one of the following:\n* The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is\n common.)\n* The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard,\n template, or theme. (This is common.)\n* The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts. (This is\n less common.)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-resourcepermission.html#cfn-quicksight-dashboard-resourcepermission-principal", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.RollingDateConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RollingDateConfiguration`\n\nThe rolling date configuration of a date time filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rollingdateconfiguration.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the rolling date configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rollingdateconfiguration.html#cfn-quicksight-dashboard-rollingdateconfiguration-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in the rolling date configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rollingdateconfiguration.html#cfn-quicksight-dashboard-rollingdateconfiguration-datasetidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.RowAlternateColorOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.RowAlternateColorOptions`\n\nDetermines the row alternate color options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rowalternatecoloroptions.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nDetermines the widget status.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rowalternatecoloroptions.html#cfn-quicksight-dashboard-rowalternatecoloroptions-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UsePrimaryBackgroundColor": { "MarkdownDocumentation": "`UsePrimaryBackgroundColor`\n\nThe primary background color options for alternate rows.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rowalternatecoloroptions.html#cfn-quicksight-dashboard-rowalternatecoloroptions-useprimarybackgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowAlternateColors": { "MarkdownDocumentation": "`RowAlternateColors`\n\nDetermines the list of row alternate colors.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rowalternatecoloroptions.html#cfn-quicksight-dashboard-rowalternatecoloroptions-rowalternatecolors", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.SameSheetTargetVisualConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SameSheetTargetVisualConfiguration`\n\nThe configuration of the same-sheet target visuals that you want to be filtered.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-samesheettargetvisualconfiguration.html", "Properties": { "TargetVisualOptions": { "MarkdownDocumentation": "`TargetVisualOptions`\n\nThe options that choose the target visual in the same sheet.\nValid values are defined as follows:\n* `ALL_VISUALS`: Applies the filter operation to all visuals in the same sheet.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VISUALS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VISUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-samesheettargetvisualconfiguration.html#cfn-quicksight-dashboard-samesheettargetvisualconfiguration-targetvisualoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetVisuals": { "MarkdownDocumentation": "`TargetVisuals`\n\nA list of the target visual IDs that are located in the same sheet of the analysis.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `512 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-samesheettargetvisualconfiguration.html#cfn-quicksight-dashboard-samesheettargetvisualconfiguration-targetvisuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.SankeyDiagramAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SankeyDiagramAggregatedFieldWells`\n\nThe field well configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramaggregatedfieldwells.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-dashboard-sankeydiagramaggregatedfieldwells-destination", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-dashboard-sankeydiagramaggregatedfieldwells-source", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe weight field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-dashboard-sankeydiagramaggregatedfieldwells-weight", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.SankeyDiagramChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SankeyDiagramChartConfiguration`\n\nThe configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramSortConfiguration](./aws-properties-quicksight-dashboard-sankeydiagramsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramchartconfiguration.html#cfn-quicksight-dashboard-sankeydiagramchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramSortConfiguration" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a sankey diagram.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramchartconfiguration.html#cfn-quicksight-dashboard-sankeydiagramchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramFieldWells](./aws-properties-quicksight-dashboard-sankeydiagramfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramchartconfiguration.html#cfn-quicksight-dashboard-sankeydiagramchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramFieldWells" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramchartconfiguration.html#cfn-quicksight-dashboard-sankeydiagramchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Dashboard.SankeyDiagramFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SankeyDiagramFieldWells`\n\nThe field well configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramfieldwells.html", "Properties": { "SankeyDiagramAggregatedFieldWells": { "MarkdownDocumentation": "`SankeyDiagramAggregatedFieldWells`\n\nThe field well configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramAggregatedFieldWells](./aws-properties-quicksight-dashboard-sankeydiagramaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramfieldwells.html#cfn-quicksight-dashboard-sankeydiagramfieldwells-sankeydiagramaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.SankeyDiagramSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SankeyDiagramSortConfiguration`\n\nThe sort configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramsortconfiguration.html", "Properties": { "WeightSort": { "MarkdownDocumentation": "`WeightSort`\n\nThe sort configuration of the weight fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramsortconfiguration.html#cfn-quicksight-dashboard-sankeydiagramsortconfiguration-weightsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SourceItemsLimit": { "MarkdownDocumentation": "`SourceItemsLimit`\n\nThe limit on the number of source nodes that are displayed in a sankey diagram.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramsortconfiguration.html#cfn-quicksight-dashboard-sankeydiagramsortconfiguration-sourceitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "DestinationItemsLimit": { "MarkdownDocumentation": "`DestinationItemsLimit`\n\nThe limit on the number of destination nodes that are displayed in a sankey diagram.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramsortconfiguration.html#cfn-quicksight-dashboard-sankeydiagramsortconfiguration-destinationitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Dashboard.SankeyDiagramVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SankeyDiagramVisual`\n\nA sankey diagram.\nFor more information, see [Using Sankey diagrams](https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramvisual.html#cfn-quicksight-dashboard-sankeydiagramvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramvisual.html#cfn-quicksight-dashboard-sankeydiagramvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramChartConfiguration](./aws-properties-quicksight-dashboard-sankeydiagramchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramvisual.html#cfn-quicksight-dashboard-sankeydiagramvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramvisual.html#cfn-quicksight-dashboard-sankeydiagramvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramvisual.html#cfn-quicksight-dashboard-sankeydiagramvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramvisual.html#cfn-quicksight-dashboard-sankeydiagramvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ScatterPlotCategoricallyAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ScatterPlotCategoricallyAggregatedFieldWells`\n\nThe aggregated field well of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a scatter plot.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells-label", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe x-axis field well of a scatter plot.\nThe x-axis is aggregated by category.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe y-axis field well of a scatter plot.\nThe y-axis is aggregated by category.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ScatterPlotConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ScatterPlotConfiguration`\n\nThe configuration of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html", "Properties": { "YAxisLabelOptions": { "MarkdownDocumentation": "`YAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-yaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a scatter plot.\n*Required*: No\n*Type*: [ScatterPlotSortConfiguration](./aws-properties-quicksight-dashboard-scatterplotsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "YAxisDisplayOptions": { "MarkdownDocumentation": "`YAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-yaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [ScatterPlotFieldWells](./aws-properties-quicksight-dashboard-scatterplotfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Dashboard.ScatterPlotFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ScatterPlotFieldWells`\n\nThe field well configuration of a scatter plot.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotfieldwells.html", "Properties": { "ScatterPlotUnaggregatedFieldWells": { "MarkdownDocumentation": "`ScatterPlotUnaggregatedFieldWells`\n\nThe unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are\nunaggregated.\n*Required*: No\n*Type*: [ScatterPlotUnaggregatedFieldWells](./aws-properties-quicksight-dashboard-scatterplotunaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotfieldwells.html#cfn-quicksight-dashboard-scatterplotfieldwells-scatterplotunaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotUnaggregatedFieldWells" }, "ScatterPlotCategoricallyAggregatedFieldWells": { "MarkdownDocumentation": "`ScatterPlotCategoricallyAggregatedFieldWells`\n\nThe aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.\n*Required*: No\n*Type*: [ScatterPlotCategoricallyAggregatedFieldWells](./aws-properties-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotfieldwells.html#cfn-quicksight-dashboard-scatterplotfieldwells-scatterplotcategoricallyaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotCategoricallyAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.ScatterPlotSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ScatterPlotSortConfiguration`\n\nThe sort configuration of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotsortconfiguration.html", "Properties": { "ScatterPlotLimitConfiguration": { "MarkdownDocumentation": "`ScatterPlotLimitConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotsortconfiguration.html#cfn-quicksight-dashboard-scatterplotsortconfiguration-scatterplotlimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Dashboard.ScatterPlotUnaggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ScatterPlotUnaggregatedFieldWells`\n\nThe unaggregated field wells of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotunaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotunaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a scatter plot.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotunaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotunaggregatedfieldwells-label", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe x-axis field well of a scatter plot.\nThe x-axis is a dimension field and cannot be aggregated.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotunaggregatedfieldwells-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe y-axis field well of a scatter plot.\nThe y-axis is a dimension field and cannot be aggregated.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotunaggregatedfieldwells-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ScatterPlotVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ScatterPlotVisual`\n\nA scatter plot.\nFor more information, see [Using scatter plots](https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [ScatterPlotConfiguration](./aws-properties-quicksight-dashboard-scatterplotconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ScrollBarOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ScrollBarOptions`\n\nThe visual display options for a data zoom scroll bar.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scrollbaroptions.html", "Properties": { "VisibleRange": { "MarkdownDocumentation": "`VisibleRange`\n\nThe visibility range for the data zoom scroll bar.\n*Required*: No\n*Type*: [VisibleRangeOptions](./aws-properties-quicksight-dashboard-visiblerangeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scrollbaroptions.html#cfn-quicksight-dashboard-scrollbaroptions-visiblerange", "UpdateType": "Mutable", "Required": false, "Type": "VisibleRangeOptions" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the data zoom scroll bar.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scrollbaroptions.html#cfn-quicksight-dashboard-scrollbaroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SecondaryValueOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SecondaryValueOptions`\n\nThe options that determine the presentation of the secondary value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-secondaryvalueoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the secondary value.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-secondaryvalueoptions.html#cfn-quicksight-dashboard-secondaryvalueoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SectionAfterPageBreak": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SectionAfterPageBreak`\n\nThe configuration of a page break after a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionafterpagebreak.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe option that enables or disables a page break at the end of a section.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionafterpagebreak.html#cfn-quicksight-dashboard-sectionafterpagebreak-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SectionBasedLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SectionBasedLayoutCanvasSizeOptions`\n\nThe options for the canvas of a section-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutcanvassizeoptions.html", "Properties": { "PaperCanvasSizeOptions": { "MarkdownDocumentation": "`PaperCanvasSizeOptions`\n\nThe options for a paper canvas of a section-based layout.\n*Required*: No\n*Type*: [SectionBasedLayoutPaperCanvasSizeOptions](./aws-properties-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutcanvassizeoptions.html#cfn-quicksight-dashboard-sectionbasedlayoutcanvassizeoptions-papercanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "SectionBasedLayoutPaperCanvasSizeOptions" } } }, "AWS::QuickSight::Dashboard.SectionBasedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SectionBasedLayoutConfiguration`\n\nThe configuration for a\nsection-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nThe options for the canvas of a section-based layout.\n*Required*: Yes\n*Type*: [SectionBasedLayoutCanvasSizeOptions](./aws-properties-quicksight-dashboard-sectionbasedlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-sectionbasedlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "SectionBasedLayoutCanvasSizeOptions" }, "FooterSections": { "MarkdownDocumentation": "`FooterSections`\n\nA list of footer section configurations.\n*Required*: Yes\n*Type*: Array of [HeaderFooterSectionConfiguration](./aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-sectionbasedlayoutconfiguration-footersections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HeaderFooterSectionConfiguration", "DuplicatesAllowed": true }, "BodySections": { "MarkdownDocumentation": "`BodySections`\n\nA list of body section configurations.\n*Required*: Yes\n*Type*: Array of [BodySectionConfiguration](./aws-properties-quicksight-dashboard-bodysectionconfiguration.html)\n*Minimum*: `0`\n*Maximum*: `28`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-sectionbasedlayoutconfiguration-bodysections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "BodySectionConfiguration", "DuplicatesAllowed": true }, "HeaderSections": { "MarkdownDocumentation": "`HeaderSections`\n\nA list of header section configurations.\n*Required*: Yes\n*Type*: Array of [HeaderFooterSectionConfiguration](./aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-sectionbasedlayoutconfiguration-headersections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HeaderFooterSectionConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.SectionBasedLayoutPaperCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SectionBasedLayoutPaperCanvasSizeOptions`\n\nThe options for a paper canvas of a section-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions.html", "Properties": { "PaperMargin": { "MarkdownDocumentation": "`PaperMargin`\n\nDefines the spacing between the canvas content and the top, bottom, left, and right edges.\n*Required*: No\n*Type*: [Spacing](./aws-properties-quicksight-dashboard-spacing.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions-papermargin", "UpdateType": "Mutable", "Required": false, "Type": "Spacing" }, "PaperSize": { "MarkdownDocumentation": "`PaperSize`\n\nThe paper size that is used to define canvas dimensions.\n*Required*: No\n*Type*: String\n*Allowed values*: `US_LETTER | US_LEGAL | US_T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "US_LETTER", "US_LEGAL", "US_TABLOID_LEDGER", "A0", "A1", "A2", "A3", "A4", "A5", "JIS_B4", "JIS_B5" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions-papersize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PaperOrientation": { "MarkdownDocumentation": "`PaperOrientation`\n\nThe paper orientation that\nis used to define canvas dimensions. Choose one of the following\noptions:\n* PORTRAIT\n* LANDSCAPE\n*Required*: No\n*Type*: String\n*Allowed values*: `PORTRAIT | LANDSCAPE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PORTRAIT", "LANDSCAPE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions-paperorientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SectionLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SectionLayoutConfiguration`\n\nThe layout configuration of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionlayoutconfiguration.html", "Properties": { "FreeFormLayout": { "MarkdownDocumentation": "`FreeFormLayout`\n\nThe free-form layout configuration of a section.\n*Required*: Yes\n*Type*: [FreeFormSectionLayoutConfiguration](./aws-properties-quicksight-dashboard-freeformsectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionlayoutconfiguration.html#cfn-quicksight-dashboard-sectionlayoutconfiguration-freeformlayout", "UpdateType": "Mutable", "Required": true, "Type": "FreeFormSectionLayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.SectionPageBreakConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SectionPageBreakConfiguration`\n\nThe configuration of a page break for a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionpagebreakconfiguration.html", "Properties": { "After": { "MarkdownDocumentation": "`After`\n\nThe configuration of a page break after a section.\n*Required*: No\n*Type*: [SectionAfterPageBreak](./aws-properties-quicksight-dashboard-sectionafterpagebreak.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionpagebreakconfiguration.html#cfn-quicksight-dashboard-sectionpagebreakconfiguration-after", "UpdateType": "Mutable", "Required": false, "Type": "SectionAfterPageBreak" } } }, "AWS::QuickSight::Dashboard.SectionStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SectionStyle`\n\nThe options that style a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionstyle.html", "Properties": { "Padding": { "MarkdownDocumentation": "`Padding`\n\nThe spacing between section content and its top, bottom, left, and right edges.\nThere is no padding by default.\n*Required*: No\n*Type*: [Spacing](./aws-properties-quicksight-dashboard-spacing.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionstyle.html#cfn-quicksight-dashboard-sectionstyle-padding", "UpdateType": "Mutable", "Required": false, "Type": "Spacing" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of a section.\nHeights can only be defined for header and footer sections. The default height margin is 0.5 inches.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionstyle.html#cfn-quicksight-dashboard-sectionstyle-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SelectedSheetsFilterScopeConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SelectedSheetsFilterScopeConfiguration`\n\nThe configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-selectedsheetsfilterscopeconfiguration.html", "Properties": { "SheetVisualScopingConfigurations": { "MarkdownDocumentation": "`SheetVisualScopingConfigurations`\n\nThe sheet ID and visual IDs of the sheet and visuals that the filter is applied to.\n*Required*: No\n*Type*: Array of [SheetVisualScopingConfiguration](./aws-properties-quicksight-dashboard-sheetvisualscopingconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-selectedsheetsfilterscopeconfiguration.html#cfn-quicksight-dashboard-selectedsheetsfilterscopeconfiguration-sheetvisualscopingconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetVisualScopingConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.SeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SeriesItem`\n\nThe series item configuration of a line chart.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-seriesitem.html", "Properties": { "FieldSeriesItem": { "MarkdownDocumentation": "`FieldSeriesItem`\n\nThe field series item configuration of a line chart.\n*Required*: No\n*Type*: [FieldSeriesItem](./aws-properties-quicksight-dashboard-fieldseriesitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-seriesitem.html#cfn-quicksight-dashboard-seriesitem-fieldseriesitem", "UpdateType": "Mutable", "Required": false, "Type": "FieldSeriesItem" }, "DataFieldSeriesItem": { "MarkdownDocumentation": "`DataFieldSeriesItem`\n\nThe data field series item configuration of a line chart.\n*Required*: No\n*Type*: [DataFieldSeriesItem](./aws-properties-quicksight-dashboard-datafieldseriesitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-seriesitem.html#cfn-quicksight-dashboard-seriesitem-datafieldseriesitem", "UpdateType": "Mutable", "Required": false, "Type": "DataFieldSeriesItem" } } }, "AWS::QuickSight::Dashboard.SetParameterValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SetParameterValueConfiguration`\n\nThe configuration of adding parameters in action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-setparametervalueconfiguration.html", "Properties": { "DestinationParameterName": { "MarkdownDocumentation": "`DestinationParameterName`\n\nThe destination parameter name of the `SetParameterValueConfiguration`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-setparametervalueconfiguration.html#cfn-quicksight-dashboard-setparametervalueconfiguration-destinationparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [DestinationParameterValueConfiguration](./aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-setparametervalueconfiguration.html#cfn-quicksight-dashboard-setparametervalueconfiguration-value", "UpdateType": "Mutable", "Required": true, "Type": "DestinationParameterValueConfiguration" } } }, "AWS::QuickSight::Dashboard.ShapeConditionalFormat": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ShapeConditionalFormat`\n\nThe shape conditional formatting of a filled map visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-shapeconditionalformat.html", "Properties": { "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting for the shape background color of a filled map visual.\n*Required*: Yes\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-shapeconditionalformat.html#cfn-quicksight-dashboard-shapeconditionalformat-backgroundcolor", "UpdateType": "Mutable", "Required": true, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Dashboard.Sheet": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.Sheet`\n\nA *sheet*, which is an object that contains a set of visuals that\nare viewed together on one page in Quick Sight. Every analysis and dashboard\ncontains at least one sheet. Each sheet contains at least one visualization widget, for\nexample a chart, pivot table, or narrative insight. Sheets can be associated with other\ncomponents, such as controls, filters, and so on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheet.html", "Properties": { "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe unique identifier associated with a sheet.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheet.html#cfn-quicksight-dashboard-sheet-sheetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a sheet. This name is displayed on the sheet's tab in the Quick Sight\nconsole.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheet.html#cfn-quicksight-dashboard-sheet-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetControlInfoIconLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetControlInfoIconLabelOptions`\n\nA control to display info icons for filters and parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of info icon label options.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-dashboard-sheetcontrolinfoiconlabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InfoIconText": { "MarkdownDocumentation": "`InfoIconText`\n\nThe text content of info icon.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-dashboard-sheetcontrolinfoiconlabeloptions-infoicontext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetControlLayout": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetControlLayout`\n\nA grid layout to define the placement of sheet control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrollayout.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n*Required*: Yes\n*Type*: [SheetControlLayoutConfiguration](./aws-properties-quicksight-dashboard-sheetcontrollayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrollayout.html#cfn-quicksight-dashboard-sheetcontrollayout-configuration", "UpdateType": "Mutable", "Required": true, "Type": "SheetControlLayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.SheetControlLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetControlLayoutConfiguration`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrollayoutconfiguration.html", "Properties": { "GridLayout": { "MarkdownDocumentation": "`GridLayout`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n*Required*: No\n*Type*: [GridLayoutConfiguration](./aws-properties-quicksight-dashboard-gridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrollayoutconfiguration.html#cfn-quicksight-dashboard-sheetcontrollayoutconfiguration-gridlayout", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutConfiguration" } } }, "AWS::QuickSight::Dashboard.SheetControlsOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetControlsOption`\n\nSheet controls option.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrolsoption.html", "Properties": { "VisibilityState": { "MarkdownDocumentation": "`VisibilityState`\n\nVisibility state.\n*Required*: No\n*Type*: String\n*Allowed values*: `EXPANDED | COLLAPSED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXPANDED", "COLLAPSED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrolsoption.html#cfn-quicksight-dashboard-sheetcontrolsoption-visibilitystate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetDefinition`\n\nA sheet is an object that contains a set of visuals that\nare viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterControls": { "MarkdownDocumentation": "`ParameterControls`\n\nThe list of parameter controls that are on a sheet.\nFor more information, see [Using a Control with a Parameter in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [ParameterControl](./aws-properties-quicksight-dashboard-parametercontrol.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-parametercontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ParameterControl", "DuplicatesAllowed": true }, "TextBoxes": { "MarkdownDocumentation": "`TextBoxes`\n\nThe text boxes that are on a sheet.\n*Required*: No\n*Type*: Array of [SheetTextBox](./aws-properties-quicksight-dashboard-sheettextbox.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-textboxes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetTextBox", "DuplicatesAllowed": true }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe layout content type of the sheet. Choose one of the following options:\n* `PAGINATED`: Creates a sheet for a paginated report.\n* `INTERACTIVE`: Creates a sheet for an interactive dashboard.\n*Required*: No\n*Type*: String\n*Allowed values*: `PAGINATED | INTERACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PAGINATED", "INTERACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Layouts": { "MarkdownDocumentation": "`Layouts`\n\nLayouts define how the components of a sheet are arranged.\nFor more information, see [Types of layout](https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [Layout](./aws-properties-quicksight-dashboard-layout.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-layouts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Layout", "DuplicatesAllowed": true }, "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe unique identifier of a sheet.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-sheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FilterControls": { "MarkdownDocumentation": "`FilterControls`\n\nThe list of filter controls that are on a sheet.\nFor more information, see [Adding filter controls to analysis sheets](https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [FilterControl](./aws-properties-quicksight-dashboard-filtercontrol.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-filtercontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterControl", "DuplicatesAllowed": true }, "Images": { "MarkdownDocumentation": "`Images`\n\nA list of images on a sheet.\n*Required*: No\n*Type*: Array of [SheetImage](./aws-properties-quicksight-dashboard-sheetimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-images", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetImage", "DuplicatesAllowed": true }, "SheetControlLayouts": { "MarkdownDocumentation": "`SheetControlLayouts`\n\nThe control layouts of the sheet.\n*Required*: No\n*Type*: Array of [SheetControlLayout](./aws-properties-quicksight-dashboard-sheetcontrollayout.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-sheetcontrollayouts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetControlLayout", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-title", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visuals": { "MarkdownDocumentation": "`Visuals`\n\nA list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.\n*Required*: No\n*Type*: Array of [Visual](./aws-properties-quicksight-dashboard-visual.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-visuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Visual", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the sheet. This name is displayed on the sheet's tab in the Quick Suite\nconsole.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetElementConfigurationOverrides": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetElementConfigurationOverrides`\n\nThe override configuration of the rendering rules of a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetelementconfigurationoverrides.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the overrides are visible. Choose one of the following options:\n* `VISIBLE`\n* `HIDDEN`\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetelementconfigurationoverrides.html#cfn-quicksight-dashboard-sheetelementconfigurationoverrides-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetElementRenderingRule": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetElementRenderingRule`\n\nThe rendering rules of a sheet that uses a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetelementrenderingrule.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the rendering rules of a sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetelementrenderingrule.html#cfn-quicksight-dashboard-sheetelementrenderingrule-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConfigurationOverrides": { "MarkdownDocumentation": "`ConfigurationOverrides`\n\nThe override configuration of the rendering rules of a sheet.\n*Required*: Yes\n*Type*: [SheetElementConfigurationOverrides](./aws-properties-quicksight-dashboard-sheetelementconfigurationoverrides.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetelementrenderingrule.html#cfn-quicksight-dashboard-sheetelementrenderingrule-configurationoverrides", "UpdateType": "Mutable", "Required": true, "Type": "SheetElementConfigurationOverrides" } } }, "AWS::QuickSight::Dashboard.SheetImage": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetImage`\n\nAn image that is located on a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimage.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nA list of custom actions that are configured for an image.\n*Required*: No\n*Type*: Array of [ImageCustomAction](./aws-properties-quicksight-dashboard-imagecustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimage.html#cfn-quicksight-dashboard-sheetimage-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ImageCustomAction", "DuplicatesAllowed": true }, "SheetImageId": { "MarkdownDocumentation": "`SheetImageId`\n\nThe ID of the sheet image.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimage.html#cfn-quicksight-dashboard-sheetimage-sheetimageid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip to be shown when hovering over the image.\n*Required*: No\n*Type*: [SheetImageTooltipConfiguration](./aws-properties-quicksight-dashboard-sheetimagetooltipconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimage.html#cfn-quicksight-dashboard-sheetimage-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageTooltipConfiguration" }, "Scaling": { "MarkdownDocumentation": "`Scaling`\n\nDetermines how the image is scaled.\n*Required*: No\n*Type*: [SheetImageScalingConfiguration](./aws-properties-quicksight-dashboard-sheetimagescalingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimage.html#cfn-quicksight-dashboard-sheetimage-scaling", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageScalingConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general image interactions setup for an image.\n*Required*: No\n*Type*: [ImageInteractionOptions](./aws-properties-quicksight-dashboard-imageinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimage.html#cfn-quicksight-dashboard-sheetimage-interactions", "UpdateType": "Mutable", "Required": false, "Type": "ImageInteractionOptions" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the image.\n*Required*: Yes\n*Type*: [SheetImageSource](./aws-properties-quicksight-dashboard-sheetimagesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimage.html#cfn-quicksight-dashboard-sheetimage-source", "UpdateType": "Mutable", "Required": true, "Type": "SheetImageSource" }, "ImageContentAltText": { "MarkdownDocumentation": "`ImageContentAltText`\n\nThe alt text for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimage.html#cfn-quicksight-dashboard-sheetimage-imagecontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetImageScalingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetImageScalingConfiguration`\n\nDetermines how the image is scaled\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagescalingconfiguration.html", "Properties": { "ScalingType": { "MarkdownDocumentation": "`ScalingType`\n\nThe scaling option to use when fitting the image inside the container.\nValid values are defined as follows:\n* `SCALE_TO_WIDTH`: The image takes up the entire width of the container. The image aspect ratio is preserved.\n* `SCALE_TO_HEIGHT`: The image takes up the entire height of the container. The image aspect ratio is preserved.\n* `SCALE_TO_CONTAINER`: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.\n* `SCALE_NONE`: The image is displayed in its original size and is not scaled to the container.\n*Required*: No\n*Type*: String\n*Allowed values*: `SCALE_TO_WIDTH | SCALE_TO_H...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SCALE_TO_WIDTH", "SCALE_TO_HEIGHT", "SCALE_TO_CONTAINER", "SCALE_NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagescalingconfiguration.html#cfn-quicksight-dashboard-sheetimagescalingconfiguration-scalingtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetImageSource": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetImageSource`\n\nThe source of the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagesource.html", "Properties": { "SheetImageStaticFileSource": { "MarkdownDocumentation": "`SheetImageStaticFileSource`\n\nThe source of the static file that contains the image.\n*Required*: No\n*Type*: [SheetImageStaticFileSource](./aws-properties-quicksight-dashboard-sheetimagestaticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagesource.html#cfn-quicksight-dashboard-sheetimagesource-sheetimagestaticfilesource", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageStaticFileSource" } } }, "AWS::QuickSight::Dashboard.SheetImageStaticFileSource": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetImageStaticFileSource`\n\nThe source of the static file that contains the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagestaticfilesource.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the static file that contains the image.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagestaticfilesource.html#cfn-quicksight-dashboard-sheetimagestaticfilesource-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetImageTooltipConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetImageTooltipConfiguration`\n\nThe tooltip configuration for a sheet image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagetooltipconfiguration.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagetooltipconfiguration.html#cfn-quicksight-dashboard-sheetimagetooltipconfiguration-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipText": { "MarkdownDocumentation": "`TooltipText`\n\nThe text that appears in the tooltip.\n*Required*: No\n*Type*: [SheetImageTooltipText](./aws-properties-quicksight-dashboard-sheetimagetooltiptext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagetooltipconfiguration.html#cfn-quicksight-dashboard-sheetimagetooltipconfiguration-tooltiptext", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageTooltipText" } } }, "AWS::QuickSight::Dashboard.SheetImageTooltipText": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetImageTooltipText`\n\nThe text that appears in the sheet image tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagetooltiptext.html", "Properties": { "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nThe plain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetimagetooltiptext.html#cfn-quicksight-dashboard-sheetimagetooltiptext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetLayoutElementMaximizationOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetLayoutElementMaximizationOption`\n\nThe sheet layout maximization options of a dashbaord.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetlayoutelementmaximizationoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe status of the sheet layout maximization options of a dashbaord.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetlayoutelementmaximizationoption.html#cfn-quicksight-dashboard-sheetlayoutelementmaximizationoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetTextBox": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetTextBox`\n\nA text box.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheettextbox.html", "Properties": { "SheetTextBoxId": { "MarkdownDocumentation": "`SheetTextBoxId`\n\nThe unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheettextbox.html#cfn-quicksight-dashboard-sheettextbox-sheettextboxid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe content that is displayed in the text box.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `150000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheettextbox.html#cfn-quicksight-dashboard-sheettextbox-content", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SheetVisualScopingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SheetVisualScopingConfiguration`\n\nThe filter that is applied to the options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetvisualscopingconfiguration.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope of the applied entities. Choose one of the following options:\n* `ALL_VISUALS`\n* `SELECTED_VISUALS`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VISUALS | SELECTED_VISU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VISUALS", "SELECTED_VISUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetvisualscopingconfiguration.html#cfn-quicksight-dashboard-sheetvisualscopingconfiguration-scope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe selected sheet that the filter is applied to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetvisualscopingconfiguration.html#cfn-quicksight-dashboard-sheetvisualscopingconfiguration-sheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VisualIds": { "MarkdownDocumentation": "`VisualIds`\n\nThe selected visuals that the filter is applied to.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetvisualscopingconfiguration.html#cfn-quicksight-dashboard-sheetvisualscopingconfiguration-visualids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.ShortFormatText": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ShortFormatText`\n\nThe text format for the title.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-shortformattext.html", "Properties": { "RichText": { "MarkdownDocumentation": "`RichText`\n\nRich text. Examples of rich text include bold, underline, and italics.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-shortformattext.html#cfn-quicksight-dashboard-shortformattext-richtext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nPlain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-shortformattext.html#cfn-quicksight-dashboard-shortformattext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SimpleClusterMarker": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SimpleClusterMarker`\n\nThe simple cluster marker of the cluster marker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-simpleclustermarker.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of the simple cluster marker.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-simpleclustermarker.html#cfn-quicksight-dashboard-simpleclustermarker-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SingleAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SingleAxisOptions`\n\nThe settings of a chart's single axis configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-singleaxisoptions.html", "Properties": { "YAxisOptions": { "MarkdownDocumentation": "`YAxisOptions`\n\nThe Y axis options of a single axis configuration.\n*Required*: No\n*Type*: [YAxisOptions](./aws-properties-quicksight-dashboard-yaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-singleaxisoptions.html#cfn-quicksight-dashboard-singleaxisoptions-yaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "YAxisOptions" } } }, "AWS::QuickSight::Dashboard.SliderControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SliderControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-slidercontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-slidercontroldisplayoptions.html#cfn-quicksight-dashboard-slidercontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-slidercontroldisplayoptions.html#cfn-quicksight-dashboard-slidercontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Dashboard.SmallMultiplesAxisProperties": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SmallMultiplesAxisProperties`\n\nConfigures the properties of a chart's axes that are used by small multiples panels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesaxisproperties.html", "Properties": { "Placement": { "MarkdownDocumentation": "`Placement`\n\nDefines the placement of the axis. By default, axes are rendered `OUTSIDE` of the panels. Axes with `INDEPENDENT` scale are rendered `INSIDE` the panels.\n*Required*: No\n*Type*: String\n*Allowed values*: `OUTSIDE | INSIDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OUTSIDE", "INSIDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesaxisproperties.html#cfn-quicksight-dashboard-smallmultiplesaxisproperties-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scale": { "MarkdownDocumentation": "`Scale`\n\nDetermines whether scale of the axes are shared or independent. The default value is `SHARED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHARED | INDEPENDENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SHARED", "INDEPENDENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesaxisproperties.html#cfn-quicksight-dashboard-smallmultiplesaxisproperties-scale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SmallMultiplesOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SmallMultiplesOptions`\n\nOptions that determine the layout and display options of a chart's small multiples.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesoptions.html", "Properties": { "MaxVisibleRows": { "MarkdownDocumentation": "`MaxVisibleRows`\n\nSets the maximum number of visible rows to display in the grid of small multiples panels.\nThe default value is `Auto`,\nwhich automatically adjusts the rows in the grid\nto fit the overall layout and size of the given chart.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesoptions.html#cfn-quicksight-dashboard-smallmultiplesoptions-maxvisiblerows", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PanelConfiguration": { "MarkdownDocumentation": "`PanelConfiguration`\n\nConfigures the display options for each small multiples panel.\n*Required*: No\n*Type*: [PanelConfiguration](./aws-properties-quicksight-dashboard-panelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesoptions.html#cfn-quicksight-dashboard-smallmultiplesoptions-panelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PanelConfiguration" }, "MaxVisibleColumns": { "MarkdownDocumentation": "`MaxVisibleColumns`\n\nSets the maximum number of visible columns to display in the grid of small multiples panels.\nThe default is `Auto`, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesoptions.html#cfn-quicksight-dashboard-smallmultiplesoptions-maxvisiblecolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe properties of a small multiples X axis.\n*Required*: No\n*Type*: [SmallMultiplesAxisProperties](./aws-properties-quicksight-dashboard-smallmultiplesaxisproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesoptions.html#cfn-quicksight-dashboard-smallmultiplesoptions-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesAxisProperties" }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe properties of a small multiples Y axis.\n*Required*: No\n*Type*: [SmallMultiplesAxisProperties](./aws-properties-quicksight-dashboard-smallmultiplesaxisproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-smallmultiplesoptions.html#cfn-quicksight-dashboard-smallmultiplesoptions-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesAxisProperties" } } }, "AWS::QuickSight::Dashboard.Spacing": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.Spacing`\n\nThe configuration of spacing (often a margin or padding).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spacing.html", "Properties": { "Left": { "MarkdownDocumentation": "`Left`\n\nDefine the left spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spacing.html#cfn-quicksight-dashboard-spacing-left", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Top": { "MarkdownDocumentation": "`Top`\n\nDefine the top spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spacing.html#cfn-quicksight-dashboard-spacing-top", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Right": { "MarkdownDocumentation": "`Right`\n\nDefine the right spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spacing.html#cfn-quicksight-dashboard-spacing-right", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bottom": { "MarkdownDocumentation": "`Bottom`\n\nDefine the bottom spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spacing.html#cfn-quicksight-dashboard-spacing-bottom", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SpatialStaticFile": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SpatialStaticFile`\n\nA static file that contains the geospatial data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spatialstaticfile.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the spatial static file.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spatialstaticfile.html#cfn-quicksight-dashboard-spatialstaticfile-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the spatial static file.\n*Required*: No\n*Type*: [StaticFileSource](./aws-properties-quicksight-dashboard-staticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spatialstaticfile.html#cfn-quicksight-dashboard-spatialstaticfile-source", "UpdateType": "Mutable", "Required": false, "Type": "StaticFileSource" } } }, "AWS::QuickSight::Dashboard.StaticFile": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StaticFile`\n\nThe static file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfile.html", "Properties": { "ImageStaticFile": { "MarkdownDocumentation": "`ImageStaticFile`\n\nThe image static file.\n*Required*: No\n*Type*: [ImageStaticFile](./aws-properties-quicksight-dashboard-imagestaticfile.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfile.html#cfn-quicksight-dashboard-staticfile-imagestaticfile", "UpdateType": "Mutable", "Required": false, "Type": "ImageStaticFile" }, "SpatialStaticFile": { "MarkdownDocumentation": "`SpatialStaticFile`\n\nThe spacial static file.\n*Required*: No\n*Type*: [SpatialStaticFile](./aws-properties-quicksight-dashboard-spatialstaticfile.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfile.html#cfn-quicksight-dashboard-staticfile-spatialstaticfile", "UpdateType": "Mutable", "Required": false, "Type": "SpatialStaticFile" } } }, "AWS::QuickSight::Dashboard.StaticFileS3SourceOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StaticFileS3SourceOptions`\n\nThe structure that contains the Amazon S3 location to download the static file from.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfiles3sourceoptions.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfiles3sourceoptions.html#cfn-quicksight-dashboard-staticfiles3sourceoptions-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ObjectKey": { "MarkdownDocumentation": "`ObjectKey`\n\nThe identifier of the static file 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfiles3sourceoptions.html#cfn-quicksight-dashboard-staticfiles3sourceoptions-objectkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe Region of the Amazon S3 account that contains the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfiles3sourceoptions.html#cfn-quicksight-dashboard-staticfiles3sourceoptions-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.StaticFileSource": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StaticFileSource`\n\nThe source of the static file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfilesource.html", "Properties": { "UrlOptions": { "MarkdownDocumentation": "`UrlOptions`\n\nThe structure that contains the URL to download the static file from.\n*Required*: No\n*Type*: [StaticFileUrlSourceOptions](./aws-properties-quicksight-dashboard-staticfileurlsourceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfilesource.html#cfn-quicksight-dashboard-staticfilesource-urloptions", "UpdateType": "Mutable", "Required": false, "Type": "StaticFileUrlSourceOptions" }, "S3Options": { "MarkdownDocumentation": "`S3Options`\n\nThe structure that contains the Amazon S3 location to download the static file from.\n*Required*: No\n*Type*: [StaticFileS3SourceOptions](./aws-properties-quicksight-dashboard-staticfiles3sourceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfilesource.html#cfn-quicksight-dashboard-staticfilesource-s3options", "UpdateType": "Mutable", "Required": false, "Type": "StaticFileS3SourceOptions" } } }, "AWS::QuickSight::Dashboard.StaticFileUrlSourceOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StaticFileUrlSourceOptions`\n\nThe structure that contains the URL to download the static file from.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfileurlsourceoptions.html", "Properties": { "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL to download the static file 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-staticfileurlsourceoptions.html#cfn-quicksight-dashboard-staticfileurlsourceoptions-url", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.StringDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StringDefaultValues`\n\nThe default values of the `StringParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringdefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `StringDefaultValues`. Different defaults displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-dashboard-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringdefaultvalues.html#cfn-quicksight-dashboard-stringdefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DecimalDefaultValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringdefaultvalues.html#cfn-quicksight-dashboard-stringdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.StringFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StringFormatConfiguration`\n\nFormatting configuration for string fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringformatconfiguration.html", "Properties": { "NumericFormatConfiguration": { "MarkdownDocumentation": "`NumericFormatConfiguration`\n\nThe formatting configuration for numeric strings.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-dashboard-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringformatconfiguration.html#cfn-quicksight-dashboard-stringformatconfiguration-numericformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-dashboard-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringformatconfiguration.html#cfn-quicksight-dashboard-stringformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" } } }, "AWS::QuickSight::Dashboard.StringParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StringParameter`\n\nA string parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values of a string parameter.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameter.html#cfn-quicksight-dashboard-stringparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameter.html#cfn-quicksight-dashboard-stringparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.StringParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StringParameterDeclaration`\n\nA parameter declaration for the `String` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-dashboard-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-stringparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [StringDefaultValues](./aws-properties-quicksight-dashboard-stringdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-stringparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "StringDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-stringparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `String` parameter when a value has not been set.\n*Required*: No\n*Type*: [StringValueWhenUnsetConfiguration](./aws-properties-quicksight-dashboard-stringvaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-stringparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "StringValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-stringparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.StringValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.StringValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `String` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringvaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-stringvaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-stringvaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.SubtotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.SubtotalOptions`\n\nThe subtotal options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the subtotal cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldLevelOptions": { "MarkdownDocumentation": "`FieldLevelOptions`\n\nThe optional configuration of subtotal cells.\n*Required*: No\n*Type*: Array of [PivotTableFieldSubtotalOptions](./aws-properties-quicksight-dashboard-pivottablefieldsubtotaloptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-fieldleveloptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldSubtotalOptions", "DuplicatesAllowed": true }, "ValueCellStyle": { "MarkdownDocumentation": "`ValueCellStyle`\n\nThe cell styling options for the subtotals of value cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-valuecellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nThe cell styling options for the subtotal cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the subtotal cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldLevel": { "MarkdownDocumentation": "`FieldLevel`\n\nThe field level (all, custom, last) for the subtotal cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL | CUSTOM | LAST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL", "CUSTOM", "LAST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-fieldlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricHeaderCellStyle": { "MarkdownDocumentation": "`MetricHeaderCellStyle`\n\nThe cell styling options for the subtotals of header cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-metricheadercellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "StyleTargets": { "MarkdownDocumentation": "`StyleTargets`\n\nThe style targets options for subtotals.\n*Required*: No\n*Type*: Array of [TableStyleTarget](./aws-properties-quicksight-dashboard-tablestyletarget.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-styletargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableStyleTarget", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.TableAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableAggregatedFieldWells`\n\nThe aggregated field well for the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well for a pivot table. Values are grouped by group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableaggregatedfieldwells.html#cfn-quicksight-dashboard-tableaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableaggregatedfieldwells.html#cfn-quicksight-dashboard-tableaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.TableBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableBorderOptions`\n\nThe border options for a table border.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableborderoptions.html", "Properties": { "Thickness": { "MarkdownDocumentation": "`Thickness`\n\nThe thickness of a table border.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableborderoptions.html#cfn-quicksight-dashboard-tableborderoptions-thickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of a table border.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableborderoptions.html#cfn-quicksight-dashboard-tableborderoptions-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style (none, solid) of a table border.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | SOLID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SOLID" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableborderoptions.html#cfn-quicksight-dashboard-tableborderoptions-style", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TableCellConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableCellConditionalFormatting`\n\nThe cell conditional formatting option for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellconditionalformatting.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the cell for conditional formatting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellconditionalformatting.html#cfn-quicksight-dashboard-tablecellconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TextFormat": { "MarkdownDocumentation": "`TextFormat`\n\nThe text format of the cell for conditional formatting.\n*Required*: No\n*Type*: [TextConditionalFormat](./aws-properties-quicksight-dashboard-textconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellconditionalformatting.html#cfn-quicksight-dashboard-tablecellconditionalformatting-textformat", "UpdateType": "Mutable", "Required": false, "Type": "TextConditionalFormat" } } }, "AWS::QuickSight::Dashboard.TableCellImageSizingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableCellImageSizingConfiguration`\n\nThe sizing options for the table image configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellimagesizingconfiguration.html", "Properties": { "TableCellImageScalingConfiguration": { "MarkdownDocumentation": "`TableCellImageScalingConfiguration`\n\nThe cell scaling configuration of the sizing options for the table image configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIT_TO_CELL_HEIGHT | FIT_TO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIT_TO_CELL_HEIGHT", "FIT_TO_CELL_WIDTH", "DO_NOT_SCALE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellimagesizingconfiguration.html#cfn-quicksight-dashboard-tablecellimagesizingconfiguration-tablecellimagescalingconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TableCellStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableCellStyle`\n\nThe table cell style for a cell in pivot table or table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html", "Properties": { "VerticalTextAlignment": { "MarkdownDocumentation": "`VerticalTextAlignment`\n\nThe vertical text alignment (top, middle, bottom) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `TOP | MIDDLE | BOTTOM | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "MIDDLE", "BOTTOM", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-verticaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height color for the table cells.\n*Required*: No\n*Type*: Number\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the table cells.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Border": { "MarkdownDocumentation": "`Border`\n\nThe borders for the table cells.\n*Required*: No\n*Type*: [GlobalTableBorderOptions](./aws-properties-quicksight-dashboard-globaltableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-border", "UpdateType": "Mutable", "Required": false, "Type": "GlobalTableBorderOptions" }, "TextWrap": { "MarkdownDocumentation": "`TextWrap`\n\nThe text wrap (none, wrap) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | WRAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "WRAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-textwrap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HorizontalTextAlignment": { "MarkdownDocumentation": "`HorizontalTextAlignment`\n\nThe horizontal text alignment (left, center, right, auto) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-horizontaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color for the table cells.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TableConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options for a `PivotTableVisual`.\n*Required*: No\n*Type*: Array of [TableConditionalFormattingOption](./aws-properties-quicksight-dashboard-tableconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconditionalformatting.html#cfn-quicksight-dashboard-tableconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.TableConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableConditionalFormattingOption`\n\nConditional formatting options for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconditionalformattingoption.html", "Properties": { "Row": { "MarkdownDocumentation": "`Row`\n\nThe row conditional formatting option for a table.\n*Required*: No\n*Type*: [TableRowConditionalFormatting](./aws-properties-quicksight-dashboard-tablerowconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconditionalformattingoption.html#cfn-quicksight-dashboard-tableconditionalformattingoption-row", "UpdateType": "Mutable", "Required": false, "Type": "TableRowConditionalFormatting" }, "Cell": { "MarkdownDocumentation": "`Cell`\n\nThe cell conditional formatting option for a table.\n*Required*: No\n*Type*: [TableCellConditionalFormatting](./aws-properties-quicksight-dashboard-tablecellconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconditionalformattingoption.html#cfn-quicksight-dashboard-tableconditionalformattingoption-cell", "UpdateType": "Mutable", "Required": false, "Type": "TableCellConditionalFormatting" } } }, "AWS::QuickSight::Dashboard.TableConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableConfiguration`\n\nThe configuration for a `TableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration for a `TableVisual`.\n*Required*: No\n*Type*: [TableSortConfiguration](./aws-properties-quicksight-dashboard-tablesortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableSortConfiguration" }, "PaginatedReportOptions": { "MarkdownDocumentation": "`PaginatedReportOptions`\n\nThe paginated report options for a table visual.\n*Required*: No\n*Type*: [TablePaginatedReportOptions](./aws-properties-quicksight-dashboard-tablepaginatedreportoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-paginatedreportoptions", "UpdateType": "Mutable", "Required": false, "Type": "TablePaginatedReportOptions" }, "TableOptions": { "MarkdownDocumentation": "`TableOptions`\n\nThe table options for a table visual.\n*Required*: No\n*Type*: [TableOptions](./aws-properties-quicksight-dashboard-tableoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-tableoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableOptions" }, "TableInlineVisualizations": { "MarkdownDocumentation": "`TableInlineVisualizations`\n\nA collection of inline visualizations to display within a chart.\n*Required*: No\n*Type*: Array of [TableInlineVisualization](./aws-properties-quicksight-dashboard-tableinlinevisualization.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-tableinlinevisualizations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableInlineVisualization", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [TableFieldWells](./aws-properties-quicksight-dashboard-tablefieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldWells" }, "FieldOptions": { "MarkdownDocumentation": "`FieldOptions`\n\nThe field options for a table visual.\n*Required*: No\n*Type*: [TableFieldOptions](./aws-properties-quicksight-dashboard-tablefieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-fieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "TotalOptions": { "MarkdownDocumentation": "`TotalOptions`\n\nThe total options for a table visual.\n*Required*: No\n*Type*: [TotalOptions](./aws-properties-quicksight-dashboard-totaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-totaloptions", "UpdateType": "Mutable", "Required": false, "Type": "TotalOptions" } } }, "AWS::QuickSight::Dashboard.TableFieldCustomIconContent": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldCustomIconContent`\n\nThe custom icon content for the table link content configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldcustomiconcontent.html", "Properties": { "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe icon set type (link) of the custom icon content for table URL link content.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINK`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "LINK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldcustomiconcontent.html#cfn-quicksight-dashboard-tablefieldcustomiconcontent-icon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TableFieldCustomTextContent": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldCustomTextContent`\n\nThe custom text content (value, font configuration) for the table link content configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldcustomtextcontent.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe string value of the custom text content for the table URL link 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldcustomtextcontent.html#cfn-quicksight-dashboard-tablefieldcustomtextcontent-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the custom text content for the table URL link content.\n*Required*: Yes\n*Type*: [FontConfiguration](./aws-properties-quicksight-dashboard-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldcustomtextcontent.html#cfn-quicksight-dashboard-tablefieldcustomtextcontent-fontconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Dashboard.TableFieldImageConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldImageConfiguration`\n\nThe image configuration of a table field URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldimageconfiguration.html", "Properties": { "SizingOptions": { "MarkdownDocumentation": "`SizingOptions`\n\nThe sizing options for the table image configuration.\n*Required*: No\n*Type*: [TableCellImageSizingConfiguration](./aws-properties-quicksight-dashboard-tablecellimagesizingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldimageconfiguration.html#cfn-quicksight-dashboard-tablefieldimageconfiguration-sizingoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableCellImageSizingConfiguration" } } }, "AWS::QuickSight::Dashboard.TableFieldLinkConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldLinkConfiguration`\n\nThe link configuration of a table field URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldlinkconfiguration.html", "Properties": { "Target": { "MarkdownDocumentation": "`Target`\n\nThe URL target (new tab, new window, same tab) for the table link configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW_TAB | NEW_WINDOW | SAME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_TAB", "NEW_WINDOW", "SAME_TAB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldlinkconfiguration.html#cfn-quicksight-dashboard-tablefieldlinkconfiguration-target", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe URL content (text, icon) for the table link configuration.\n*Required*: Yes\n*Type*: [TableFieldLinkContentConfiguration](./aws-properties-quicksight-dashboard-tablefieldlinkcontentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldlinkconfiguration.html#cfn-quicksight-dashboard-tablefieldlinkconfiguration-content", "UpdateType": "Mutable", "Required": true, "Type": "TableFieldLinkContentConfiguration" } } }, "AWS::QuickSight::Dashboard.TableFieldLinkContentConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldLinkContentConfiguration`\n\nThe URL content (text, icon) for the table link configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldlinkcontentconfiguration.html", "Properties": { "CustomIconContent": { "MarkdownDocumentation": "`CustomIconContent`\n\nThe custom icon content for the table link content configuration.\n*Required*: No\n*Type*: [TableFieldCustomIconContent](./aws-properties-quicksight-dashboard-tablefieldcustomiconcontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldlinkcontentconfiguration.html#cfn-quicksight-dashboard-tablefieldlinkcontentconfiguration-customiconcontent", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldCustomIconContent" }, "CustomTextContent": { "MarkdownDocumentation": "`CustomTextContent`\n\nThe custom text content (value, font configuration) for the table link content configuration.\n*Required*: No\n*Type*: [TableFieldCustomTextContent](./aws-properties-quicksight-dashboard-tablefieldcustomtextcontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldlinkcontentconfiguration.html#cfn-quicksight-dashboard-tablefieldlinkcontentconfiguration-customtextcontent", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldCustomTextContent" } } }, "AWS::QuickSight::Dashboard.TableFieldOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldOption`\n\nThe options for a table field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoption.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label for a table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoption.html#cfn-quicksight-dashboard-tablefieldoption-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "URLStyling": { "MarkdownDocumentation": "`URLStyling`\n\nThe URL configuration for a table field.\n*Required*: No\n*Type*: [TableFieldURLConfiguration](./aws-properties-quicksight-dashboard-tablefieldurlconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoption.html#cfn-quicksight-dashboard-tablefieldoption-urlstyling", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldURLConfiguration" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for a table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoption.html#cfn-quicksight-dashboard-tablefieldoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of a table field.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoption.html#cfn-quicksight-dashboard-tablefieldoption-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width for a table 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoption.html#cfn-quicksight-dashboard-tablefieldoption-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TableFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldOptions`\n\nThe field options of a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoptions.html", "Properties": { "Order": { "MarkdownDocumentation": "`Order`\n\nThe order of the field IDs that are configured as field options for a table visual.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoptions.html#cfn-quicksight-dashboard-tablefieldoptions-order", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PinnedFieldOptions": { "MarkdownDocumentation": "`PinnedFieldOptions`\n\nThe settings for the pinned columns of a table visual.\n*Required*: No\n*Type*: [TablePinnedFieldOptions](./aws-properties-quicksight-dashboard-tablepinnedfieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoptions.html#cfn-quicksight-dashboard-tablefieldoptions-pinnedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "TablePinnedFieldOptions" }, "TransposedTableOptions": { "MarkdownDocumentation": "`TransposedTableOptions`\n\nThe `TableOptions` of a transposed table.\n*Required*: No\n*Type*: Array of [TransposedTableOption](./aws-properties-quicksight-dashboard-transposedtableoption.html)\n*Minimum*: `0`\n*Maximum*: `10001`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoptions.html#cfn-quicksight-dashboard-tablefieldoptions-transposedtableoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TransposedTableOption", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nThe field options to be configured to a table.\n*Required*: No\n*Type*: Array of [TableFieldOption](./aws-properties-quicksight-dashboard-tablefieldoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoptions.html#cfn-quicksight-dashboard-tablefieldoptions-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableFieldOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.TableFieldURLConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldURLConfiguration`\n\nThe URL configuration for a table field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldurlconfiguration.html", "Properties": { "LinkConfiguration": { "MarkdownDocumentation": "`LinkConfiguration`\n\nThe link configuration of a table field URL.\n*Required*: No\n*Type*: [TableFieldLinkConfiguration](./aws-properties-quicksight-dashboard-tablefieldlinkconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldurlconfiguration.html#cfn-quicksight-dashboard-tablefieldurlconfiguration-linkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldLinkConfiguration" }, "ImageConfiguration": { "MarkdownDocumentation": "`ImageConfiguration`\n\nThe image configuration of a table field URL.\n*Required*: No\n*Type*: [TableFieldImageConfiguration](./aws-properties-quicksight-dashboard-tablefieldimageconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldurlconfiguration.html#cfn-quicksight-dashboard-tablefieldurlconfiguration-imageconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldImageConfiguration" } } }, "AWS::QuickSight::Dashboard.TableFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableFieldWells`\n\nThe field wells for a table visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldwells.html", "Properties": { "TableUnaggregatedFieldWells": { "MarkdownDocumentation": "`TableUnaggregatedFieldWells`\n\nThe unaggregated field well for the table.\n*Required*: No\n*Type*: [TableUnaggregatedFieldWells](./aws-properties-quicksight-dashboard-tableunaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldwells.html#cfn-quicksight-dashboard-tablefieldwells-tableunaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableUnaggregatedFieldWells" }, "TableAggregatedFieldWells": { "MarkdownDocumentation": "`TableAggregatedFieldWells`\n\nThe aggregated field well for the table.\n*Required*: No\n*Type*: [TableAggregatedFieldWells](./aws-properties-quicksight-dashboard-tableaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldwells.html#cfn-quicksight-dashboard-tablefieldwells-tableaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.TableInlineVisualization": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableInlineVisualization`\n\nThe inline visualization of a specific type to display within a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableinlinevisualization.html", "Properties": { "DataBars": { "MarkdownDocumentation": "`DataBars`\n\nThe configuration of the inline visualization of the data bars within a chart.\n*Required*: No\n*Type*: [DataBarsOptions](./aws-properties-quicksight-dashboard-databarsoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableinlinevisualization.html#cfn-quicksight-dashboard-tableinlinevisualization-databars", "UpdateType": "Mutable", "Required": false, "Type": "DataBarsOptions" } } }, "AWS::QuickSight::Dashboard.TableOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableOptions`\n\nThe table options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableoptions.html", "Properties": { "HeaderStyle": { "MarkdownDocumentation": "`HeaderStyle`\n\nThe table cell style of a table header.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableoptions.html#cfn-quicksight-dashboard-tableoptions-headerstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "CellStyle": { "MarkdownDocumentation": "`CellStyle`\n\nThe table cell style of table cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableoptions.html#cfn-quicksight-dashboard-tableoptions-cellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "Orientation": { "MarkdownDocumentation": "`Orientation`\n\nThe orientation (vertical, horizontal) for a table.\n*Required*: No\n*Type*: String\n*Allowed values*: `VERTICAL | HORIZONTAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VERTICAL", "HORIZONTAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableoptions.html#cfn-quicksight-dashboard-tableoptions-orientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowAlternateColorOptions": { "MarkdownDocumentation": "`RowAlternateColorOptions`\n\nThe row alternate color options (widget status, row alternate colors) for a table.\n*Required*: No\n*Type*: [RowAlternateColorOptions](./aws-properties-quicksight-dashboard-rowalternatecoloroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableoptions.html#cfn-quicksight-dashboard-tableoptions-rowalternatecoloroptions", "UpdateType": "Mutable", "Required": false, "Type": "RowAlternateColorOptions" } } }, "AWS::QuickSight::Dashboard.TablePaginatedReportOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TablePaginatedReportOptions`\n\nThe paginated report options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablepaginatedreportoptions.html", "Properties": { "OverflowColumnHeaderVisibility": { "MarkdownDocumentation": "`OverflowColumnHeaderVisibility`\n\nThe visibility of repeating header rows on each page.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablepaginatedreportoptions.html#cfn-quicksight-dashboard-tablepaginatedreportoptions-overflowcolumnheadervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VerticalOverflowVisibility": { "MarkdownDocumentation": "`VerticalOverflowVisibility`\n\nThe visibility of printing table overflow across pages.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablepaginatedreportoptions.html#cfn-quicksight-dashboard-tablepaginatedreportoptions-verticaloverflowvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TablePinnedFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TablePinnedFieldOptions`\n\nThe settings for the pinned columns of a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablepinnedfieldoptions.html", "Properties": { "PinnedLeftFields": { "MarkdownDocumentation": "`PinnedLeftFields`\n\nA list of columns to be pinned to the left of a table visual.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 201`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablepinnedfieldoptions.html#cfn-quicksight-dashboard-tablepinnedfieldoptions-pinnedleftfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.TableRowConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableRowConditionalFormatting`\n\nThe conditional formatting of a table row.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablerowconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting color (solid, gradient) of the text for a table row.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablerowconditionalformatting.html#cfn-quicksight-dashboard-tablerowconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting color (solid, gradient) of the background for a table row.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablerowconditionalformatting.html#cfn-quicksight-dashboard-tablerowconditionalformatting-backgroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Dashboard.TableSideBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableSideBorderOptions`\n\nThe side border options for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html", "Properties": { "Left": { "MarkdownDocumentation": "`Left`\n\nThe table border options of the left border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-dashboard-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-left", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Top": { "MarkdownDocumentation": "`Top`\n\nThe table border options of the top border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-dashboard-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-top", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "InnerHorizontal": { "MarkdownDocumentation": "`InnerHorizontal`\n\nThe table border options of the inner horizontal border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-dashboard-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-innerhorizontal", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Right": { "MarkdownDocumentation": "`Right`\n\nThe table border options of the right border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-dashboard-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-right", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Bottom": { "MarkdownDocumentation": "`Bottom`\n\nThe table border options of the bottom border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-dashboard-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-bottom", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "InnerVertical": { "MarkdownDocumentation": "`InnerVertical`\n\nThe table border options of the inner vertical border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-dashboard-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-innervertical", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" } } }, "AWS::QuickSight::Dashboard.TableSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableSortConfiguration`\n\nThe sort configuration for a `TableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesortconfiguration.html", "Properties": { "RowSort": { "MarkdownDocumentation": "`RowSort`\n\nThe field sort options for rows in the table.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesortconfiguration.html#cfn-quicksight-dashboard-tablesortconfiguration-rowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "PaginationConfiguration": { "MarkdownDocumentation": "`PaginationConfiguration`\n\nThe pagination configuration (page size, page number) for the table.\n*Required*: No\n*Type*: [PaginationConfiguration](./aws-properties-quicksight-dashboard-paginationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesortconfiguration.html#cfn-quicksight-dashboard-tablesortconfiguration-paginationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PaginationConfiguration" } } }, "AWS::QuickSight::Dashboard.TableStyleTarget": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableStyleTarget`\n\nThe table style target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablestyletarget.html", "Properties": { "CellType": { "MarkdownDocumentation": "`CellType`\n\nThe cell type of the table style target.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOTAL | METRIC_HEADER | VAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOTAL", "METRIC_HEADER", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablestyletarget.html#cfn-quicksight-dashboard-tablestyletarget-celltype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TableUnaggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableUnaggregatedFieldWells`\n\nThe unaggregated field well for the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableunaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are unaggregated for an unaggregated table.\n*Required*: No\n*Type*: Array of [UnaggregatedField](./aws-properties-quicksight-dashboard-unaggregatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableunaggregatedfieldwells.html#cfn-quicksight-dashboard-tableunaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UnaggregatedField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.TableVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TableVisual`\n\nA table visual.\nFor more information, see [Using tables as visuals](https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n*Required*: No\n*Type*: [TableConditionalFormatting](./aws-properties-quicksight-dashboard-tableconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "TableConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [TableConfiguration](./aws-properties-quicksight-dashboard-tableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TextAreaControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TextAreaControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textareacontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textareacontroldisplayoptions.html#cfn-quicksight-dashboard-textareacontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "PlaceholderOptions": { "MarkdownDocumentation": "`PlaceholderOptions`\n\nThe configuration of the placeholder options in a text area control.\n*Required*: No\n*Type*: [TextControlPlaceholderOptions](./aws-properties-quicksight-dashboard-textcontrolplaceholderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textareacontroldisplayoptions.html#cfn-quicksight-dashboard-textareacontroldisplayoptions-placeholderoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextControlPlaceholderOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textareacontroldisplayoptions.html#cfn-quicksight-dashboard-textareacontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Dashboard.TextConditionalFormat": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TextConditionalFormat`\n\nThe conditional formatting for the text.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textconditionalformat.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting for the text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textconditionalformat.html#cfn-quicksight-dashboard-textconditionalformat-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting for the icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-dashboard-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textconditionalformat.html#cfn-quicksight-dashboard-textconditionalformat-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting for the text background color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-dashboard-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textconditionalformat.html#cfn-quicksight-dashboard-textconditionalformat-backgroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Dashboard.TextControlPlaceholderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TextControlPlaceholderOptions`\n\nThe configuration of the placeholder options in a text control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textcontrolplaceholderoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the placeholder options in a text control.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textcontrolplaceholderoptions.html#cfn-quicksight-dashboard-textcontrolplaceholderoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TextFieldControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TextFieldControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textfieldcontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-dashboard-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textfieldcontroldisplayoptions.html#cfn-quicksight-dashboard-textfieldcontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "PlaceholderOptions": { "MarkdownDocumentation": "`PlaceholderOptions`\n\nThe configuration of the placeholder options in a text field control.\n*Required*: No\n*Type*: [TextControlPlaceholderOptions](./aws-properties-quicksight-dashboard-textcontrolplaceholderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textfieldcontroldisplayoptions.html#cfn-quicksight-dashboard-textfieldcontroldisplayoptions-placeholderoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextControlPlaceholderOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-dashboard-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textfieldcontroldisplayoptions.html#cfn-quicksight-dashboard-textfieldcontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Dashboard.ThousandSeparatorOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ThousandSeparatorOptions`\n\nThe options that determine the thousands separator configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-thousandseparatoroptions.html", "Properties": { "Symbol": { "MarkdownDocumentation": "`Symbol`\n\nDetermines the thousands separator symbol.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMMA | DOT | SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMMA", "DOT", "SPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-thousandseparatoroptions.html#cfn-quicksight-dashboard-thousandseparatoroptions-symbol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the thousands separator.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-thousandseparatoroptions.html#cfn-quicksight-dashboard-thousandseparatoroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupingStyle": { "MarkdownDocumentation": "`GroupingStyle`\n\nDetermines the way numbers are styled to accommodate different readability standards. The `DEFAULT` value uses the standard international grouping system and groups numbers by the thousands. The `LAKHS` value uses the Indian numbering system and groups numbers by lakhs and crores.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | LAKHS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "LAKHS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-thousandseparatoroptions.html#cfn-quicksight-dashboard-thousandseparatoroptions-groupingstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TimeBasedForecastProperties": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TimeBasedForecastProperties`\n\nThe forecast properties setup of a forecast in the line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html", "Properties": { "PeriodsBackward": { "MarkdownDocumentation": "`PeriodsBackward`\n\nThe periods backward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-periodsbackward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PeriodsForward": { "MarkdownDocumentation": "`PeriodsForward`\n\nThe periods forward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-periodsforward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PredictionInterval": { "MarkdownDocumentation": "`PredictionInterval`\n\nThe prediction interval setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `50`\n*Maximum*: `95`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-predictioninterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Seasonality": { "MarkdownDocumentation": "`Seasonality`\n\nThe seasonality setup of a forecast computation. Choose one of the following options:\n* `NULL`: The input is set to `NULL`.\n* `NON_NULL`: The input is set to a custom value.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `180`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-seasonality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "UpperBoundary": { "MarkdownDocumentation": "`UpperBoundary`\n\nThe upper boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-upperboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "LowerBoundary": { "MarkdownDocumentation": "`LowerBoundary`\n\nThe lower boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-lowerboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Dashboard.TimeEqualityFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TimeEqualityFilter`\n\nA `TimeEqualityFilter` filters values that are equal to a given value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timeequalityfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-timeequalityfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date input for the `TimeEquality` filter.\nThis field is mutually exclusive to `Value` and `ParameterName`.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-dashboard-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-timeequalityfilter-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a `TimeEquality` filter.\nThis field is mutually exclusive to `RollingDate` and `ParameterName`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-timeequalityfilter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-timeequalityfilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\nThis field is mutually exclusive to `Value` and `RollingDate`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-timeequalityfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-timeequalityfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-timeequalityfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TimeRangeDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TimeRangeDrillDownFilter`\n\nThe time range drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangedrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangedrilldownfilter.html#cfn-quicksight-dashboard-timerangedrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RangeMinimum": { "MarkdownDocumentation": "`RangeMinimum`\n\nThe minimum value for the filter value range.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangedrilldownfilter.html#cfn-quicksight-dashboard-timerangedrilldownfilter-rangeminimum", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangedrilldownfilter.html#cfn-quicksight-dashboard-timerangedrilldownfilter-timegranularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeMaximum": { "MarkdownDocumentation": "`RangeMaximum`\n\nThe maximum value for the filter value range.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangedrilldownfilter.html#cfn-quicksight-dashboard-timerangedrilldownfilter-rangemaximum", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TimeRangeFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TimeRangeFilter`\n\nA `TimeRangeFilter` filters values that are between two specified values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html", "Properties": { "RangeMinimumValue": { "MarkdownDocumentation": "`RangeMinimumValue`\n\nThe minimum value for the filter value range.\n*Required*: No\n*Type*: [TimeRangeFilterValue](./aws-properties-quicksight-dashboard-timerangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-rangeminimumvalue", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilterValue" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RangeMaximumValue": { "MarkdownDocumentation": "`RangeMaximumValue`\n\nThe maximum value for the filter value range.\n*Required*: No\n*Type*: [TimeRangeFilterValue](./aws-properties-quicksight-dashboard-timerangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-rangemaximumvalue", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilterValue" }, "IncludeMaximum": { "MarkdownDocumentation": "`IncludeMaximum`\n\nDetermines whether the maximum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-includemaximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IncludeMinimum": { "MarkdownDocumentation": "`IncludeMinimum`\n\nDetermines whether the minimum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-includeminimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExcludePeriodConfiguration": { "MarkdownDocumentation": "`ExcludePeriodConfiguration`\n\nThe exclude period of the time range filter.\n*Required*: No\n*Type*: [ExcludePeriodConfiguration](./aws-properties-quicksight-dashboard-excludeperiodconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-excludeperiodconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExcludePeriodConfiguration" } } }, "AWS::QuickSight::Dashboard.TimeRangeFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TimeRangeFilterValue`\n\nThe value of a time range filter.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefiltervalue.html", "Properties": { "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date input value.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-dashboard-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefiltervalue.html#cfn-quicksight-dashboard-timerangefiltervalue-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nThe static input 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefiltervalue.html#cfn-quicksight-dashboard-timerangefiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameter": { "MarkdownDocumentation": "`Parameter`\n\nThe parameter type input value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefiltervalue.html#cfn-quicksight-dashboard-timerangefiltervalue-parameter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TooltipItem`\n\nThe tooltip.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipitem.html", "Properties": { "FieldTooltipItem": { "MarkdownDocumentation": "`FieldTooltipItem`\n\nThe tooltip item for the fields.\n*Required*: No\n*Type*: [FieldTooltipItem](./aws-properties-quicksight-dashboard-fieldtooltipitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipitem.html#cfn-quicksight-dashboard-tooltipitem-fieldtooltipitem", "UpdateType": "Mutable", "Required": false, "Type": "FieldTooltipItem" }, "ColumnTooltipItem": { "MarkdownDocumentation": "`ColumnTooltipItem`\n\nThe tooltip item for the columns that are not part of a field well.\n*Required*: No\n*Type*: [ColumnTooltipItem](./aws-properties-quicksight-dashboard-columntooltipitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipitem.html#cfn-quicksight-dashboard-tooltipitem-columntooltipitem", "UpdateType": "Mutable", "Required": false, "Type": "ColumnTooltipItem" } } }, "AWS::QuickSight::Dashboard.TooltipOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TooltipOptions`\n\nThe display options for the visual tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipoptions.html", "Properties": { "SelectedTooltipType": { "MarkdownDocumentation": "`SelectedTooltipType`\n\nThe selected type for the tooltip. Choose one of the following options:\n* `BASIC`: A basic tooltip.\n* `DETAILED`: A detailed tooltip.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC | DETAILED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "DETAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipoptions.html#cfn-quicksight-dashboard-tooltipoptions-selectedtooltiptype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipVisibility": { "MarkdownDocumentation": "`TooltipVisibility`\n\nDetermines whether or not the tooltip is visible.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipoptions.html#cfn-quicksight-dashboard-tooltipoptions-tooltipvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldBasedTooltip": { "MarkdownDocumentation": "`FieldBasedTooltip`\n\nThe setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.\n*Required*: No\n*Type*: [FieldBasedTooltip](./aws-properties-quicksight-dashboard-fieldbasedtooltip.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipoptions.html#cfn-quicksight-dashboard-tooltipoptions-fieldbasedtooltip", "UpdateType": "Mutable", "Required": false, "Type": "FieldBasedTooltip" } } }, "AWS::QuickSight::Dashboard.TopBottomFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TopBottomFilter`\n\nA `TopBottomFilter` filters values that are at the top or the bottom.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html", "Properties": { "AggregationSortConfigurations": { "MarkdownDocumentation": "`AggregationSortConfigurations`\n\nThe aggregation and sort configuration of the top bottom filter.\n*Required*: Yes\n*Type*: Array of [AggregationSortConfiguration](./aws-properties-quicksight-dashboard-aggregationsortconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-aggregationsortconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AggregationSortConfiguration", "DuplicatesAllowed": true }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nThe number of items to include in the top bottom filter results.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TopBottomMoversComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TopBottomMoversComputation`\n\nThe top movers and bottom movers computation setup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe computation type. Choose from the following options:\n* TOP: Top movers computation.\n* BOTTOM: Bottom movers computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOP | BOTTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "BOTTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "SortOrder": { "MarkdownDocumentation": "`SortOrder`\n\nThe sort order setup of the top and bottom movers computation.\n*Required*: No\n*Type*: String\n*Allowed values*: `PERCENT_DIFFERENCE | ABSOLU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PERCENT_DIFFERENCE", "ABSOLUTE_DIFFERENCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-sortorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "MoverSize": { "MarkdownDocumentation": "`MoverSize`\n\nThe mover size setup of the top and bottom movers computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-moversize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TopBottomRankedComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TopBottomRankedComputation`\n\nThe top ranked and bottom ranked computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe computation type. Choose one of the following options:\n* TOP: A top ranked computation.\n* BOTTOM: A bottom ranked computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOP | BOTTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "BOTTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ResultSize": { "MarkdownDocumentation": "`ResultSize`\n\nThe result size of a top and bottom ranked computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-resultsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TotalAggregationComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TotalAggregationComputation`\n\nThe total aggregation computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationcomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationcomputation.html#cfn-quicksight-dashboard-totalaggregationcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationcomputation.html#cfn-quicksight-dashboard-totalaggregationcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationcomputation.html#cfn-quicksight-dashboard-totalaggregationcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TotalAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TotalAggregationFunction`\n\nAn aggregation function that aggregates the total values of a measure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationfunction.html", "Properties": { "SimpleTotalAggregationFunction": { "MarkdownDocumentation": "`SimpleTotalAggregationFunction`\n\nA built in aggregation function for total values.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | SUM | AVERAGE | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "SUM", "AVERAGE", "MIN", "MAX", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationfunction.html#cfn-quicksight-dashboard-totalaggregationfunction-simpletotalaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TotalAggregationOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TotalAggregationOption`\n\nThe total aggregation settings map of a field id.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationoption.html", "Properties": { "TotalAggregationFunction": { "MarkdownDocumentation": "`TotalAggregationFunction`\n\nThe total aggregation function that you want to set for a specified field id.\n*Required*: Yes\n*Type*: [TotalAggregationFunction](./aws-properties-quicksight-dashboard-totalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationoption.html#cfn-quicksight-dashboard-totalaggregationoption-totalaggregationfunction", "UpdateType": "Mutable", "Required": true, "Type": "TotalAggregationFunction" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field id that's associated with the total aggregation option.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totalaggregationoption.html#cfn-quicksight-dashboard-totalaggregationoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TotalOptions`\n\nThe total options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html", "Properties": { "TotalAggregationOptions": { "MarkdownDocumentation": "`TotalAggregationOptions`\n\nThe total aggregation settings for each value field.\n*Required*: No\n*Type*: Array of [TotalAggregationOption](./aws-properties-quicksight-dashboard-totalaggregationoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-totalaggregationoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TotalAggregationOption", "DuplicatesAllowed": true }, "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the total cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScrollStatus": { "MarkdownDocumentation": "`ScrollStatus`\n\nThe scroll status (pinned, scrolled) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `PINNED | SCROLLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PINNED", "SCROLLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-scrollstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe placement (start, end) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `START | END | AUTO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "START", "END", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nCell styling options for the total cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-dashboard-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TransposedTableOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TransposedTableOption`\n\nThe column option of the transposed table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-transposedtableoption.html", "Properties": { "ColumnWidth": { "MarkdownDocumentation": "`ColumnWidth`\n\nThe width of a column in a transposed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-transposedtableoption.html#cfn-quicksight-dashboard-transposedtableoption-columnwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnIndex": { "MarkdownDocumentation": "`ColumnIndex`\n\nThe index of a columns in a transposed table. The index range is 0-9999.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `9999`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-transposedtableoption.html#cfn-quicksight-dashboard-transposedtableoption-columnindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ColumnType": { "MarkdownDocumentation": "`ColumnType`\n\nThe column type of the column in a transposed table. Choose one of the following options:\n* `ROW_HEADER_COLUMN`: Refers to the leftmost column of the row header in the transposed table.\n* `VALUE_COLUMN`: Refers to all value columns in the transposed table.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ROW_HEADER_COLUMN | VALUE_C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROW_HEADER_COLUMN", "VALUE_COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-transposedtableoption.html#cfn-quicksight-dashboard-transposedtableoption-columntype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.TreeMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TreeMapAggregatedFieldWells`\n\nAggregated field wells of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapaggregatedfieldwells.html", "Properties": { "Sizes": { "MarkdownDocumentation": "`Sizes`\n\nThe size field well of a tree map. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapaggregatedfieldwells.html#cfn-quicksight-dashboard-treemapaggregatedfieldwells-sizes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field well of a tree map. Values are grouped by aggregations based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapaggregatedfieldwells.html#cfn-quicksight-dashboard-treemapaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe group by field well of a tree map. Values are grouped based on group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapaggregatedfieldwells.html#cfn-quicksight-dashboard-treemapaggregatedfieldwells-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.TreeMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TreeMapConfiguration`\n\nThe configuration of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a tree map.\n*Required*: No\n*Type*: [TreeMapSortConfiguration](./aws-properties-quicksight-dashboard-treemapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility) for the colors displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SizeLabelOptions": { "MarkdownDocumentation": "`SizeLabelOptions`\n\nThe label options (label text, label visibility) of the sizes that are displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-sizelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [TreeMapFieldWells](./aws-properties-quicksight-dashboard-treemapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-dashboard-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "ColorScale": { "MarkdownDocumentation": "`ColorScale`\n\nThe color options (gradient color, point of divergence) of a tree map.\n*Required*: No\n*Type*: [ColorScale](./aws-properties-quicksight-dashboard-colorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-colorscale", "UpdateType": "Mutable", "Required": false, "Type": "ColorScale" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "GroupLabelOptions": { "MarkdownDocumentation": "`GroupLabelOptions`\n\nThe label options (label text, label visibility) of the groups that are displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-grouplabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" } } }, "AWS::QuickSight::Dashboard.TreeMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TreeMapFieldWells`\n\nThe field wells of a tree map.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapfieldwells.html", "Properties": { "TreeMapAggregatedFieldWells": { "MarkdownDocumentation": "`TreeMapAggregatedFieldWells`\n\nThe aggregated field wells of a tree map.\n*Required*: No\n*Type*: [TreeMapAggregatedFieldWells](./aws-properties-quicksight-dashboard-treemapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapfieldwells.html#cfn-quicksight-dashboard-treemapfieldwells-treemapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.TreeMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TreeMapSortConfiguration`\n\nThe sort configuration of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapsortconfiguration.html", "Properties": { "TreeMapSort": { "MarkdownDocumentation": "`TreeMapSort`\n\nThe sort configuration of group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapsortconfiguration.html#cfn-quicksight-dashboard-treemapsortconfiguration-treemapsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "TreeMapGroupItemsLimitConfiguration": { "MarkdownDocumentation": "`TreeMapGroupItemsLimitConfiguration`\n\nThe limit on the number of groups that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapsortconfiguration.html#cfn-quicksight-dashboard-treemapsortconfiguration-treemapgroupitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Dashboard.TreeMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TreeMapVisual`\n\nA tree map.\nFor more information, see [Using tree maps](https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [TreeMapConfiguration](./aws-properties-quicksight-dashboard-treemapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.TrendArrowOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.TrendArrowOptions`\n\nThe options that determine the presentation of trend arrows in a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-trendarrowoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the trend arrows.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-trendarrowoptions.html#cfn-quicksight-dashboard-trendarrowoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.UnaggregatedField": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.UnaggregatedField`\n\nThe unaggregated field for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-unaggregatedfield.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [FormatConfiguration](./aws-properties-quicksight-dashboard-formatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-unaggregatedfield.html#cfn-quicksight-dashboard-unaggregatedfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `UnaggregatedField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-dashboard-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-unaggregatedfield.html#cfn-quicksight-dashboard-unaggregatedfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-unaggregatedfield.html#cfn-quicksight-dashboard-unaggregatedfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.UniqueValuesComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.UniqueValuesComputation`\n\nThe unique values computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-uniquevaluescomputation.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-uniquevaluescomputation.html#cfn-quicksight-dashboard-uniquevaluescomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-uniquevaluescomputation.html#cfn-quicksight-dashboard-uniquevaluescomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-uniquevaluescomputation.html#cfn-quicksight-dashboard-uniquevaluescomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.ValidationStrategy": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.ValidationStrategy`\n\nThe option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to `LENIENT`, validation is skipped for specific errors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-validationstrategy.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe mode of validation for the asset to be created or updated. When you set this value to `STRICT`, strict validation for every error is enforced. When you set this value to `LENIENT`, validation is skipped for specific UI errors.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRICT | LENIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRICT", "LENIENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-validationstrategy.html#cfn-quicksight-dashboard-validationstrategy-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.VisibleRangeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisibleRangeOptions`\n\nThe range options for the data zoom scroll bar.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visiblerangeoptions.html", "Properties": { "PercentRange": { "MarkdownDocumentation": "`PercentRange`\n\nThe percent range in the visible range.\n*Required*: No\n*Type*: [PercentVisibleRange](./aws-properties-quicksight-dashboard-percentvisiblerange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visiblerangeoptions.html#cfn-quicksight-dashboard-visiblerangeoptions-percentrange", "UpdateType": "Mutable", "Required": false, "Type": "PercentVisibleRange" } } }, "AWS::QuickSight::Dashboard.Visual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.Visual`\n\nA visual displayed on a sheet in an analysis, dashboard, or template.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html", "Properties": { "FunnelChartVisual": { "MarkdownDocumentation": "`FunnelChartVisual`\n\nA funnel chart.\nFor more information, see [Using funnel charts](https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [FunnelChartVisual](./aws-properties-quicksight-dashboard-funnelchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-funnelchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartVisual" }, "BoxPlotVisual": { "MarkdownDocumentation": "`BoxPlotVisual`\n\nA box plot.\nFor more information, see [Using box plots](https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [BoxPlotVisual](./aws-properties-quicksight-dashboard-boxplotvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-boxplotvisual", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotVisual" }, "LayerMapVisual": { "MarkdownDocumentation": "`LayerMapVisual`\n\nThe properties for a layer map visual\n*Required*: No\n*Type*: [LayerMapVisual](./aws-properties-quicksight-dashboard-layermapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-layermapvisual", "UpdateType": "Mutable", "Required": false, "Type": "LayerMapVisual" }, "GeospatialMapVisual": { "MarkdownDocumentation": "`GeospatialMapVisual`\n\nA geospatial map or a points on map visual.\nFor more information, see [Creating point maps](https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [GeospatialMapVisual](./aws-properties-quicksight-dashboard-geospatialmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-geospatialmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapVisual" }, "ScatterPlotVisual": { "MarkdownDocumentation": "`ScatterPlotVisual`\n\nA scatter plot.\nFor more information, see [Using scatter plots](https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [ScatterPlotVisual](./aws-properties-quicksight-dashboard-scatterplotvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-scatterplotvisual", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotVisual" }, "RadarChartVisual": { "MarkdownDocumentation": "`RadarChartVisual`\n\nA radar chart visual.\nFor more information, see [Using radar charts](https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [RadarChartVisual](./aws-properties-quicksight-dashboard-radarchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-radarchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartVisual" }, "ComboChartVisual": { "MarkdownDocumentation": "`ComboChartVisual`\n\nA combo chart.\nFor more information, see [Using combo charts](https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [ComboChartVisual](./aws-properties-quicksight-dashboard-combochartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-combochartvisual", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartVisual" }, "WordCloudVisual": { "MarkdownDocumentation": "`WordCloudVisual`\n\nA word cloud.\nFor more information, see [Using word clouds](https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [WordCloudVisual](./aws-properties-quicksight-dashboard-wordcloudvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-wordcloudvisual", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudVisual" }, "SankeyDiagramVisual": { "MarkdownDocumentation": "`SankeyDiagramVisual`\n\nA sankey diagram.\nFor more information, see [Using Sankey diagrams](https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [SankeyDiagramVisual](./aws-properties-quicksight-dashboard-sankeydiagramvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-sankeydiagramvisual", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramVisual" }, "GaugeChartVisual": { "MarkdownDocumentation": "`GaugeChartVisual`\n\nA gauge chart.\nFor more information, see [Using gauge charts](https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [GaugeChartVisual](./aws-properties-quicksight-dashboard-gaugechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-gaugechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartVisual" }, "FilledMapVisual": { "MarkdownDocumentation": "`FilledMapVisual`\n\nA filled map.\nFor more information, see [Creating filled maps](https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [FilledMapVisual](./aws-properties-quicksight-dashboard-filledmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-filledmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapVisual" }, "WaterfallVisual": { "MarkdownDocumentation": "`WaterfallVisual`\n\nA waterfall chart.\nFor more information, see [Using waterfall charts](https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [WaterfallVisual](./aws-properties-quicksight-dashboard-waterfallvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-waterfallvisual", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallVisual" }, "CustomContentVisual": { "MarkdownDocumentation": "`CustomContentVisual`\n\nA visual that contains custom content.\nFor more information, see [Using custom visual content](https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [CustomContentVisual](./aws-properties-quicksight-dashboard-customcontentvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-customcontentvisual", "UpdateType": "Mutable", "Required": false, "Type": "CustomContentVisual" }, "PieChartVisual": { "MarkdownDocumentation": "`PieChartVisual`\n\nA pie or donut chart.\nFor more information, see [Using pie charts](https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [PieChartVisual](./aws-properties-quicksight-dashboard-piechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-piechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "PieChartVisual" }, "KPIVisual": { "MarkdownDocumentation": "`KPIVisual`\n\nA key performance indicator (KPI).\nFor more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [KPIVisual](./aws-properties-quicksight-dashboard-kpivisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-kpivisual", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisual" }, "HistogramVisual": { "MarkdownDocumentation": "`HistogramVisual`\n\nA histogram.\nFor more information, see [Using histograms](https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [HistogramVisual](./aws-properties-quicksight-dashboard-histogramvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-histogramvisual", "UpdateType": "Mutable", "Required": false, "Type": "HistogramVisual" }, "PluginVisual": { "MarkdownDocumentation": "`PluginVisual`\n\nThe custom plugin visual type.\n*Required*: No\n*Type*: [PluginVisual](./aws-properties-quicksight-dashboard-pluginvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-pluginvisual", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisual" }, "TableVisual": { "MarkdownDocumentation": "`TableVisual`\n\nA table visual.\nFor more information, see [Using tables as visuals](https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [TableVisual](./aws-properties-quicksight-dashboard-tablevisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-tablevisual", "UpdateType": "Mutable", "Required": false, "Type": "TableVisual" }, "PivotTableVisual": { "MarkdownDocumentation": "`PivotTableVisual`\n\nA pivot table.\nFor more information, see [Using pivot tables](https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [PivotTableVisual](./aws-properties-quicksight-dashboard-pivottablevisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-pivottablevisual", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableVisual" }, "BarChartVisual": { "MarkdownDocumentation": "`BarChartVisual`\n\nA bar chart.\nFor more information, see [Using bar charts](https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [BarChartVisual](./aws-properties-quicksight-dashboard-barchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-barchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "BarChartVisual" }, "HeatMapVisual": { "MarkdownDocumentation": "`HeatMapVisual`\n\nA heat map.\nFor more information, see [Using heat maps](https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [HeatMapVisual](./aws-properties-quicksight-dashboard-heatmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-heatmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapVisual" }, "TreeMapVisual": { "MarkdownDocumentation": "`TreeMapVisual`\n\nA tree map.\nFor more information, see [Using tree maps](https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [TreeMapVisual](./aws-properties-quicksight-dashboard-treemapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-treemapvisual", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapVisual" }, "InsightVisual": { "MarkdownDocumentation": "`InsightVisual`\n\nAn insight visual.\nFor more information, see [Working with insights](https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [InsightVisual](./aws-properties-quicksight-dashboard-insightvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-insightvisual", "UpdateType": "Mutable", "Required": false, "Type": "InsightVisual" }, "LineChartVisual": { "MarkdownDocumentation": "`LineChartVisual`\n\nA line chart.\nFor more information, see [Using line charts](https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [LineChartVisual](./aws-properties-quicksight-dashboard-linechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-linechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "LineChartVisual" }, "EmptyVisual": { "MarkdownDocumentation": "`EmptyVisual`\n\nAn empty visual.\n*Required*: No\n*Type*: [EmptyVisual](./aws-properties-quicksight-dashboard-emptyvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-emptyvisual", "UpdateType": "Mutable", "Required": false, "Type": "EmptyVisual" } } }, "AWS::QuickSight::Dashboard.VisualAxisSortOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisualAxisSortOption`\n\nThe axis sort options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualaxissortoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availaiblity status of a visual's axis sort options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualaxissortoption.html#cfn-quicksight-dashboard-visualaxissortoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.VisualCustomAction": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisualCustomAction`\n\nA custom action defined on a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the `VisualCustomAction`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trigger": { "MarkdownDocumentation": "`Trigger`\n\nThe trigger of the `VisualCustomAction`.\nValid values are defined as follows:\n* `DATA_POINT_CLICK`: Initiates a custom action by a left pointer click on a data point.\n* `DATA_POINT_MENU`: Initiates a custom action by right pointer click from the menu.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DATA_POINT_CLICK | DATA_POI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DATA_POINT_CLICK", "DATA_POINT_MENU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-trigger", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomActionId": { "MarkdownDocumentation": "`CustomActionId`\n\nThe ID of the `VisualCustomAction`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-customactionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the `VisualCustomAction`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionOperations": { "MarkdownDocumentation": "`ActionOperations`\n\nA list of `VisualCustomActionOperations`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: Array of [VisualCustomActionOperation](./aws-properties-quicksight-dashboard-visualcustomactionoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-actionoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "VisualCustomActionOperation", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.VisualCustomActionOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisualCustomActionOperation`\n\nThe operation that is defined by the custom action.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomactionoperation.html", "Properties": { "NavigationOperation": { "MarkdownDocumentation": "`NavigationOperation`\n\nThe navigation operation that navigates between different sheets in the same analysis.\n*Required*: No\n*Type*: [CustomActionNavigationOperation](./aws-properties-quicksight-dashboard-customactionnavigationoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomactionoperation.html#cfn-quicksight-dashboard-visualcustomactionoperation-navigationoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionNavigationOperation" }, "SetParametersOperation": { "MarkdownDocumentation": "`SetParametersOperation`\n\nThe set parameter operation that sets parameters in custom action.\n*Required*: No\n*Type*: [CustomActionSetParametersOperation](./aws-properties-quicksight-dashboard-customactionsetparametersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomactionoperation.html#cfn-quicksight-dashboard-visualcustomactionoperation-setparametersoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionSetParametersOperation" }, "FilterOperation": { "MarkdownDocumentation": "`FilterOperation`\n\nThe filter operation that filters data included in a visual or in an entire sheet.\n*Required*: No\n*Type*: [CustomActionFilterOperation](./aws-properties-quicksight-dashboard-customactionfilteroperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomactionoperation.html#cfn-quicksight-dashboard-visualcustomactionoperation-filteroperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionFilterOperation" }, "URLOperation": { "MarkdownDocumentation": "`URLOperation`\n\nThe URL operation that opens a link to another webpage.\n*Required*: No\n*Type*: [CustomActionURLOperation](./aws-properties-quicksight-dashboard-customactionurloperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomactionoperation.html#cfn-quicksight-dashboard-visualcustomactionoperation-urloperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionURLOperation" } } }, "AWS::QuickSight::Dashboard.VisualInteractionOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisualInteractionOptions`\n\nThe general visual interactions setup for visual publish options\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualinteractionoptions.html", "Properties": { "ContextMenuOption": { "MarkdownDocumentation": "`ContextMenuOption`\n\nThe context menu options for a visual.\n*Required*: No\n*Type*: [ContextMenuOption](./aws-properties-quicksight-dashboard-contextmenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualinteractionoptions.html#cfn-quicksight-dashboard-visualinteractionoptions-contextmenuoption", "UpdateType": "Mutable", "Required": false, "Type": "ContextMenuOption" }, "VisualMenuOption": { "MarkdownDocumentation": "`VisualMenuOption`\n\nThe on-visual menu options for a visual.\n*Required*: No\n*Type*: [VisualMenuOption](./aws-properties-quicksight-dashboard-visualmenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualinteractionoptions.html#cfn-quicksight-dashboard-visualinteractionoptions-visualmenuoption", "UpdateType": "Mutable", "Required": false, "Type": "VisualMenuOption" } } }, "AWS::QuickSight::Dashboard.VisualMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisualMenuOption`\n\nThe menu options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualmenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availaiblity status of a visual's menu options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualmenuoption.html#cfn-quicksight-dashboard-visualmenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.VisualPalette": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisualPalette`\n\nThe visual display options for the visual palette.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualpalette.html", "Properties": { "ChartColor": { "MarkdownDocumentation": "`ChartColor`\n\nThe chart color options for the visual palette.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualpalette.html#cfn-quicksight-dashboard-visualpalette-chartcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColorMap": { "MarkdownDocumentation": "`ColorMap`\n\nThe color map options for the visual palette.\n*Required*: No\n*Type*: Array of [DataPathColor](./aws-properties-quicksight-dashboard-datapathcolor.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualpalette.html#cfn-quicksight-dashboard-visualpalette-colormap", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataPathColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.VisualSubtitleLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisualSubtitleLabelOptions`\n\nThe subtitle label options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the subtitle label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html#cfn-quicksight-dashboard-visualsubtitlelabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatText": { "MarkdownDocumentation": "`FormatText`\n\nThe long text format of the subtitle label, such as plain text or rich text.\n*Required*: No\n*Type*: [LongFormatText](./aws-properties-quicksight-dashboard-longformattext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html#cfn-quicksight-dashboard-visualsubtitlelabeloptions-formattext", "UpdateType": "Mutable", "Required": false, "Type": "LongFormatText" } } }, "AWS::QuickSight::Dashboard.VisualTitleLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.VisualTitleLabelOptions`\n\nThe title label options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualtitlelabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the title label.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualtitlelabeloptions.html#cfn-quicksight-dashboard-visualtitlelabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatText": { "MarkdownDocumentation": "`FormatText`\n\nThe short text format of the title label, such as plain text or rich text.\n*Required*: No\n*Type*: [ShortFormatText](./aws-properties-quicksight-dashboard-shortformattext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualtitlelabeloptions.html#cfn-quicksight-dashboard-visualtitlelabeloptions-formattext", "UpdateType": "Mutable", "Required": false, "Type": "ShortFormatText" } } }, "AWS::QuickSight::Dashboard.WaterfallChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WaterfallChartAggregatedFieldWells`\n\nThe field well configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartaggregatedfieldwells.html", "Properties": { "Categories": { "MarkdownDocumentation": "`Categories`\n\nThe category field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartaggregatedfieldwells.html#cfn-quicksight-dashboard-waterfallchartaggregatedfieldwells-categories", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Breakdowns": { "MarkdownDocumentation": "`Breakdowns`\n\nThe breakdown field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartaggregatedfieldwells.html#cfn-quicksight-dashboard-waterfallchartaggregatedfieldwells-breakdowns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartaggregatedfieldwells.html#cfn-quicksight-dashboard-waterfallchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.WaterfallChartColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WaterfallChartColorConfiguration`\n\nThe color configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartcolorconfiguration.html", "Properties": { "GroupColorConfiguration": { "MarkdownDocumentation": "`GroupColorConfiguration`\n\nThe color configuration for individual groups within a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartGroupColorConfiguration](./aws-properties-quicksight-dashboard-waterfallchartgroupcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartcolorconfiguration.html#cfn-quicksight-dashboard-waterfallchartcolorconfiguration-groupcolorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartGroupColorConfiguration" } } }, "AWS::QuickSight::Dashboard.WaterfallChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WaterfallChartConfiguration`\n\nThe configuration for a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html", "Properties": { "CategoryAxisLabelOptions": { "MarkdownDocumentation": "`CategoryAxisLabelOptions`\n\nThe options that determine the presentation of the category axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-categoryaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartSortConfiguration](./aws-properties-quicksight-dashboard-waterfallchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend configuration of a waterfall visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-dashboard-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a waterfall visual.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-dashboard-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe options that determine the presentation of the y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartFieldWells](./aws-properties-quicksight-dashboard-waterfallchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartFieldWells" }, "WaterfallChartOptions": { "MarkdownDocumentation": "`WaterfallChartOptions`\n\nThe options that determine the presentation of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartOptions](./aws-properties-quicksight-dashboard-waterfallchartoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-waterfallchartoptions", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartOptions" }, "ColorConfiguration": { "MarkdownDocumentation": "`ColorConfiguration`\n\nThe color configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartColorConfiguration](./aws-properties-quicksight-dashboard-waterfallchartcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-colorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartColorConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "CategoryAxisDisplayOptions": { "MarkdownDocumentation": "`CategoryAxisDisplayOptions`\n\nThe options that determine the presentation of the category axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-categoryaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe options that determine the presentation of the y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-dashboard-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a waterfall visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-dashboard-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Dashboard.WaterfallChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WaterfallChartFieldWells`\n\nThe field well configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartfieldwells.html", "Properties": { "WaterfallChartAggregatedFieldWells": { "MarkdownDocumentation": "`WaterfallChartAggregatedFieldWells`\n\nThe field well configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartAggregatedFieldWells](./aws-properties-quicksight-dashboard-waterfallchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartfieldwells.html#cfn-quicksight-dashboard-waterfallchartfieldwells-waterfallchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.WaterfallChartGroupColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WaterfallChartGroupColorConfiguration`\n\nThe color configuration for individual groups within a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartgroupcolorconfiguration.html", "Properties": { "NegativeBarColor": { "MarkdownDocumentation": "`NegativeBarColor`\n\nDefines the color for the negative bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-dashboard-waterfallchartgroupcolorconfiguration-negativebarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalBarColor": { "MarkdownDocumentation": "`TotalBarColor`\n\nDefines the color for the total bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-dashboard-waterfallchartgroupcolorconfiguration-totalbarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PositiveBarColor": { "MarkdownDocumentation": "`PositiveBarColor`\n\nDefines the color for the positive bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-dashboard-waterfallchartgroupcolorconfiguration-positivebarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.WaterfallChartOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WaterfallChartOptions`\n\nThe options that determine the presentation of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartoptions.html", "Properties": { "TotalBarLabel": { "MarkdownDocumentation": "`TotalBarLabel`\n\nThis option determines the total bar label of a waterfall visual.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartoptions.html#cfn-quicksight-dashboard-waterfallchartoptions-totalbarlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.WaterfallChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WaterfallChartSortConfiguration`\n\nThe sort configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartsortconfiguration.html", "Properties": { "BreakdownItemsLimit": { "MarkdownDocumentation": "`BreakdownItemsLimit`\n\nThe limit on the number of bar groups that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartsortconfiguration.html#cfn-quicksight-dashboard-waterfallchartsortconfiguration-breakdownitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartsortconfiguration.html#cfn-quicksight-dashboard-waterfallchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.WaterfallVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WaterfallVisual`\n\nA waterfall chart.\nFor more information, see [Using waterfall charts](https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration for a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartConfiguration](./aws-properties-quicksight-dashboard-waterfallchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.WhatIfPointScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WhatIfPointScenario`\n\nProvides the forecast to meet the target for a particular date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-whatifpointscenario.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe target value that you want to meet for the provided date.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-whatifpointscenario.html#cfn-quicksight-dashboard-whatifpointscenario-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Date": { "MarkdownDocumentation": "`Date`\n\nThe date that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-whatifpointscenario.html#cfn-quicksight-dashboard-whatifpointscenario-date", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.WhatIfRangeScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WhatIfRangeScenario`\n\nProvides the forecast to meet the target for a particular date range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-whatifrangescenario.html", "Properties": { "StartDate": { "MarkdownDocumentation": "`StartDate`\n\nThe start date in the date range that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-whatifrangescenario.html#cfn-quicksight-dashboard-whatifrangescenario-startdate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe target value that you want to meet for the provided date range.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-whatifrangescenario.html#cfn-quicksight-dashboard-whatifrangescenario-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "EndDate": { "MarkdownDocumentation": "`EndDate`\n\nThe end date in the date range that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-whatifrangescenario.html#cfn-quicksight-dashboard-whatifrangescenario-enddate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.WordCloudAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WordCloudAggregatedFieldWells`\n\nThe aggregated field wells of a word cloud.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well of a word cloud. Values are grouped by group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-dashboard-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudaggregatedfieldwells.html#cfn-quicksight-dashboard-wordcloudaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a word cloud. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-dashboard-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudaggregatedfieldwells.html#cfn-quicksight-dashboard-wordcloudaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.WordCloudChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WordCloudChartConfiguration`\n\nThe configuration of a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a word cloud visual.\n*Required*: No\n*Type*: [WordCloudSortConfiguration](./aws-properties-quicksight-dashboard-wordcloudsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudchartconfiguration.html#cfn-quicksight-dashboard-wordcloudchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudSortConfiguration" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) for the word cloud category.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-dashboard-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudchartconfiguration.html#cfn-quicksight-dashboard-wordcloudchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [WordCloudFieldWells](./aws-properties-quicksight-dashboard-wordcloudfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudchartconfiguration.html#cfn-quicksight-dashboard-wordcloudchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudFieldWells" }, "WordCloudOptions": { "MarkdownDocumentation": "`WordCloudOptions`\n\nThe options for a word cloud visual.\n*Required*: No\n*Type*: [WordCloudOptions](./aws-properties-quicksight-dashboard-wordcloudoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudchartconfiguration.html#cfn-quicksight-dashboard-wordcloudchartconfiguration-wordcloudoptions", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-dashboard-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudchartconfiguration.html#cfn-quicksight-dashboard-wordcloudchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Dashboard.WordCloudFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WordCloudFieldWells`\n\nThe field wells of a word cloud visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudfieldwells.html", "Properties": { "WordCloudAggregatedFieldWells": { "MarkdownDocumentation": "`WordCloudAggregatedFieldWells`\n\nThe aggregated field wells of a word cloud.\n*Required*: No\n*Type*: [WordCloudAggregatedFieldWells](./aws-properties-quicksight-dashboard-wordcloudaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudfieldwells.html#cfn-quicksight-dashboard-wordcloudfieldwells-wordcloudaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudAggregatedFieldWells" } } }, "AWS::QuickSight::Dashboard.WordCloudOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WordCloudOptions`\n\nThe word cloud options for a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html", "Properties": { "WordOrientation": { "MarkdownDocumentation": "`WordOrientation`\n\nThe word orientation options (horizontal, horizontal\\_and\\_vertical) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `HORIZONTAL | HORIZONTAL_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HORIZONTAL", "HORIZONTAL_AND_VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordorientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WordScaling": { "MarkdownDocumentation": "`WordScaling`\n\nThe word scaling options (emphasize, normal) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `EMPHASIZE | NORMAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EMPHASIZE", "NORMAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordscaling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudLayout": { "MarkdownDocumentation": "`CloudLayout`\n\nThe cloud layout options (fluid, normal) of a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLUID | NORMAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FLUID", "NORMAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-cloudlayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaximumStringLength": { "MarkdownDocumentation": "`MaximumStringLength`\n\nThe length limit of each word from 1-100.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-maximumstringlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "WordCasing": { "MarkdownDocumentation": "`WordCasing`\n\nThe word casing options (lower\\_case, existing\\_case) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `LOWER_CASE | EXISTING_CASE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOWER_CASE", "EXISTING_CASE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordcasing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WordPadding": { "MarkdownDocumentation": "`WordPadding`\n\nThe word padding options (none, small, medium, large) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | SMALL | MEDIUM | LAR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SMALL", "MEDIUM", "LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordpadding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Dashboard.WordCloudSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WordCloudSortConfiguration`\n\nThe sort configuration of a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudsortconfiguration.html", "Properties": { "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of groups that are displayed in a word cloud.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-dashboard-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudsortconfiguration.html#cfn-quicksight-dashboard-wordcloudsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-dashboard-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudsortconfiguration.html#cfn-quicksight-dashboard-wordcloudsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.WordCloudVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.WordCloudVisual`\n\nA word cloud.\nFor more information, see [Using word clouds](https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-dashboard-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [WordCloudChartConfiguration](./aws-properties-quicksight-dashboard-wordcloudchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-dashboard-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-dashboard-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-dashboard-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Dashboard.YAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard.YAxisOptions`\n\nThe options that are available for a single Y axis in a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-yaxisoptions.html", "Properties": { "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe Y axis type to be used in the chart.\nIf you choose `PRIMARY_Y_AXIS`, the primary Y Axis is located on the leftmost vertical axis of the chart.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_Y_AXIS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_Y_AXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-yaxisoptions.html#cfn-quicksight-dashboard-yaxisoptions-yaxis", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.AggregateOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.AggregateOperation`\n\nA transform operation that groups rows by specified columns and applies aggregation functions\nto calculate summary values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html", "Properties": { "GroupByColumnNames": { "MarkdownDocumentation": "`GroupByColumnNames`\n\nThe list of column names to group by when performing the aggregation. Rows with the same values in\nthese columns will be grouped together.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `127 | 128`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-groupbycolumnnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Aggregations": { "MarkdownDocumentation": "`Aggregations`\n\nThe list of aggregation functions to apply to the grouped data, such as `SUM`,\n`COUNT`, or `AVERAGE`.\n*Required*: Yes\n*Type*: Array of [Aggregation](./aws-properties-quicksight-dataset-aggregation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-aggregations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Aggregation", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source transform operation that provides input data for the aggregation.\n*Required*: Yes\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-source", "UpdateType": "Mutable", "Required": true, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.Aggregation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.Aggregation`\n\nDefines an aggregation function to be applied to grouped data, creating a new column with\nthe calculated result.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function to apply, such as `SUM`, `COUNT`, `AVERAGE`,\n`MIN`, `MAX`\n*Required*: Yes\n*Type*: [DataPrepAggregationFunction](./aws-properties-quicksight-dataset-dataprepaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-aggregationfunction", "UpdateType": "Mutable", "Required": true, "Type": "DataPrepAggregationFunction" }, "NewColumnName": { "MarkdownDocumentation": "`NewColumnName`\n\nThe name for the new column that will contain the aggregated values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-newcolumnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NewColumnId": { "MarkdownDocumentation": "`NewColumnId`\n\nA unique identifier for the new column that will contain the aggregated values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-newcolumnid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.AppendOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.AppendOperation`\n\nA transform operation that combines rows from two data sources by stacking them vertically (union operation).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html", "Properties": { "AppendedColumns": { "MarkdownDocumentation": "`AppendedColumns`\n\nThe list of columns to include in the appended result, mapping columns from both sources.\n*Required*: Yes\n*Type*: Array of [AppendedColumn](./aws-properties-quicksight-dataset-appendedcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html#cfn-quicksight-dataset-appendoperation-appendedcolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AppendedColumn", "DuplicatesAllowed": true }, "SecondSource": { "MarkdownDocumentation": "`SecondSource`\n\nThe second data source to be appended to the first source.\n*Required*: No\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html#cfn-quicksight-dataset-appendoperation-secondsource", "UpdateType": "Mutable", "Required": false, "Type": "TransformOperationSource" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html#cfn-quicksight-dataset-appendoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FirstSource": { "MarkdownDocumentation": "`FirstSource`\n\nThe first data source to be included in the append operation.\n*Required*: No\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html#cfn-quicksight-dataset-appendoperation-firstsource", "UpdateType": "Mutable", "Required": false, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.AppendedColumn": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.AppendedColumn`\n\nRepresents a column that will be included in the result of an append operation, combining data from multiple sources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendedcolumn.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the column to include in the appended result.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendedcolumn.html#cfn-quicksight-dataset-appendedcolumn-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NewColumnId": { "MarkdownDocumentation": "`NewColumnId`\n\nA unique identifier for the column in the appended 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendedcolumn.html#cfn-quicksight-dataset-appendedcolumn-newcolumnid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.CalculatedColumn": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.CalculatedColumn`\n\nA calculated column for a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html", "Properties": { "ColumnId": { "MarkdownDocumentation": "`ColumnId`\n\nA unique ID to identify a calculated column. During a dataset update, if the column ID\nof a calculated column matches that of an existing calculated column, Quick Sight\npreserves the existing calculated column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html#cfn-quicksight-dataset-calculatedcolumn-columnid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nColumn name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html#cfn-quicksight-dataset-calculatedcolumn-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nAn expression that defines the calculated column.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `250000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html#cfn-quicksight-dataset-calculatedcolumn-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.CastColumnTypeOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.CastColumnTypeOperation`\n\nA transform operation that casts a column to a different type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nColumn name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubType": { "MarkdownDocumentation": "`SubType`\n\nThe sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLOAT | FIXED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FLOAT", "FIXED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-subtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Format": { "MarkdownDocumentation": "`Format`\n\nWhen casting a column from string to datetime type, you can supply a string in a\nformat supported by Quick Sight to denote the source data format.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-format", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NewColumnType": { "MarkdownDocumentation": "`NewColumnType`\n\nNew column data type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRING | INTEGER | DECIMAL ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "INTEGER", "DECIMAL", "DATETIME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-newcolumntype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.CastColumnTypesOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.CastColumnTypesOperation`\n\nA transform operation that changes the data types of one or more columns in the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypesoperation.html", "Properties": { "CastColumnTypeOperations": { "MarkdownDocumentation": "`CastColumnTypeOperations`\n\nThe list of column type casting operations to perform.\n*Required*: Yes\n*Type*: Array of [CastColumnTypeOperation](./aws-properties-quicksight-dataset-castcolumntypeoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypesoperation.html#cfn-quicksight-dataset-castcolumntypesoperation-castcolumntypeoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CastColumnTypeOperation", "DuplicatesAllowed": true }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypesoperation.html#cfn-quicksight-dataset-castcolumntypesoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source transform operation that provides input data for the type casting.\n*Required*: Yes\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypesoperation.html#cfn-quicksight-dataset-castcolumntypesoperation-source", "UpdateType": "Mutable", "Required": true, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.ColumnGroup": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ColumnGroup`\n\nGroupings of columns that work together in certain Quick Sight features. This is\na variant type structure. For this structure to be valid, only one of the attributes can\nbe non-null.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columngroup.html", "Properties": { "GeoSpatialColumnGroup": { "MarkdownDocumentation": "`GeoSpatialColumnGroup`\n\nGeospatial column group that denotes a hierarchy.\n*Required*: No\n*Type*: [GeoSpatialColumnGroup](./aws-properties-quicksight-dataset-geospatialcolumngroup.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columngroup.html#cfn-quicksight-dataset-columngroup-geospatialcolumngroup", "UpdateType": "Mutable", "Required": false, "Type": "GeoSpatialColumnGroup" } } }, "AWS::QuickSight::DataSet.ColumnLevelPermissionRule": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ColumnLevelPermissionRule`\n\nA rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To\ncreate a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least\none user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that\ncolumn.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html", "Properties": { "ColumnNames": { "MarkdownDocumentation": "`ColumnNames`\n\nAn array of column names.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html#cfn-quicksight-dataset-columnlevelpermissionrule-columnnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principals": { "MarkdownDocumentation": "`Principals`\n\nAn array of Amazon Resource Names (ARNs) for Quick Suite users or groups.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html#cfn-quicksight-dataset-columnlevelpermissionrule-principals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.ColumnToUnpivot": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ColumnToUnpivot`\n\nSpecifies a column to be unpivoted, transforming it from a column into rows with associated values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntounpivot.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the column to unpivot from the source data.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntounpivot.html#cfn-quicksight-dataset-columntounpivot-columnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NewValue": { "MarkdownDocumentation": "`NewValue`\n\nThe value to assign to this column in the unpivoted result, typically the column name or a descriptive label.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `2047`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntounpivot.html#cfn-quicksight-dataset-columntounpivot-newvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.CreateColumnsOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.CreateColumnsOperation`\n\nA transform operation that creates calculated columns. Columns created in one such\noperation form a lexical closure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-createcolumnsoperation.html", "Properties": { "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-createcolumnsoperation.html#cfn-quicksight-dataset-createcolumnsoperation-alias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nCalculated columns to create.\n*Required*: Yes\n*Type*: Array of [CalculatedColumn](./aws-properties-quicksight-dataset-calculatedcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-createcolumnsoperation.html#cfn-quicksight-dataset-createcolumnsoperation-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CalculatedColumn", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source transform operation that provides input data for creating new calculated columns.\n*Required*: No\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-createcolumnsoperation.html#cfn-quicksight-dataset-createcolumnsoperation-source", "UpdateType": "Mutable", "Required": false, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.CustomSql": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.CustomSql`\n\nA physical table type built from the results of the custom SQL query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html", "Properties": { "DataSourceArn": { "MarkdownDocumentation": "`DataSourceArn`\n\nThe Amazon Resource Name (ARN) of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-datasourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SqlQuery": { "MarkdownDocumentation": "`SqlQuery`\n\nThe SQL query.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `168000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-sqlquery", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe column schema from the SQL query result set.\n*Required*: Yes\n*Type*: Array of [InputColumn](./aws-properties-quicksight-dataset-inputcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "InputColumn", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the SQL query result.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.DataPrepAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataPrepAggregationFunction`\n\nDefines the type of aggregation function to apply to data during data preparation, supporting simple\nand list aggregations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepaggregationfunction.html", "Properties": { "PercentileAggregation": { "MarkdownDocumentation": "`PercentileAggregation`\n\nProperty description not available.\n*Required*: No\n*Type*: [DataPrepPercentileAggregationFunction](./aws-properties-quicksight-dataset-datapreppercentileaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepaggregationfunction.html#cfn-quicksight-dataset-dataprepaggregationfunction-percentileaggregation", "UpdateType": "Mutable", "Required": false, "Type": "DataPrepPercentileAggregationFunction" }, "SimpleAggregation": { "MarkdownDocumentation": "`SimpleAggregation`\n\nA simple aggregation function such as `SUM`, `COUNT`, `AVERAGE`,\n`MIN`, `MAX`, `MEDIAN`, `VARIANCE`, or `STANDARD_DEVIATION`.\n*Required*: No\n*Type*: [DataPrepSimpleAggregationFunction](./aws-properties-quicksight-dataset-dataprepsimpleaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepaggregationfunction.html#cfn-quicksight-dataset-dataprepaggregationfunction-simpleaggregation", "UpdateType": "Mutable", "Required": false, "Type": "DataPrepSimpleAggregationFunction" }, "ListAggregation": { "MarkdownDocumentation": "`ListAggregation`\n\nA list aggregation function that concatenates values from multiple rows into a single delimited string.\n*Required*: No\n*Type*: [DataPrepListAggregationFunction](./aws-properties-quicksight-dataset-datapreplistaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepaggregationfunction.html#cfn-quicksight-dataset-dataprepaggregationfunction-listaggregation", "UpdateType": "Mutable", "Required": false, "Type": "DataPrepListAggregationFunction" } } }, "AWS::QuickSight::DataSet.DataPrepConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataPrepConfiguration`\n\nConfiguration for data preparation operations, defining the complete pipeline from source tables\nthrough transformations to destination tables.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepconfiguration.html", "Properties": { "DestinationTableMap": { "MarkdownDocumentation": "`DestinationTableMap`\n\nA map of destination tables that receive the final prepared data.\n*Required*: Yes\n*Type*: Object of [DestinationTable](./aws-properties-quicksight-dataset-destinationtable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepconfiguration.html#cfn-quicksight-dataset-dataprepconfiguration-destinationtablemap", "UpdateType": "Mutable", "Required": true, "Type": "Map", "ItemType": "DestinationTable" }, "TransformStepMap": { "MarkdownDocumentation": "`TransformStepMap`\n\nA map of transformation steps that process the data.\n*Required*: Yes\n*Type*: Object of [TransformStep](./aws-properties-quicksight-dataset-transformstep.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepconfiguration.html#cfn-quicksight-dataset-dataprepconfiguration-transformstepmap", "UpdateType": "Mutable", "Required": true, "Type": "Map", "ItemType": "TransformStep" }, "SourceTableMap": { "MarkdownDocumentation": "`SourceTableMap`\n\nA map of source tables that provide information about underlying sources.\n*Required*: Yes\n*Type*: Object of [SourceTable](./aws-properties-quicksight-dataset-sourcetable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepconfiguration.html#cfn-quicksight-dataset-dataprepconfiguration-sourcetablemap", "UpdateType": "Mutable", "Required": true, "Type": "Map", "ItemType": "SourceTable" } } }, "AWS::QuickSight::DataSet.DataPrepListAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataPrepListAggregationFunction`\n\nAn aggregation function that concatenates values from multiple rows into a single string with a specified\nseparator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreplistaggregationfunction.html", "Properties": { "Distinct": { "MarkdownDocumentation": "`Distinct`\n\nWhether to include only distinct values in the concatenated result, removing duplicates.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreplistaggregationfunction.html#cfn-quicksight-dataset-datapreplistaggregationfunction-distinct", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "InputColumnName": { "MarkdownDocumentation": "`InputColumnName`\n\nThe name of the column containing values to be concatenated.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreplistaggregationfunction.html#cfn-quicksight-dataset-datapreplistaggregationfunction-inputcolumnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Separator": { "MarkdownDocumentation": "`Separator`\n\nThe string used to separate values in the concatenated result.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreplistaggregationfunction.html#cfn-quicksight-dataset-datapreplistaggregationfunction-separator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.DataPrepPercentileAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataPrepPercentileAggregationFunction`\n\nThe `DataPrepPercentileAggregationFunction` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](./aws-resource-quicksight-dataset.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreppercentileaggregationfunction.html", "Properties": { "InputColumnName": { "MarkdownDocumentation": "`InputColumnName`\n\nProperty description not available.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreppercentileaggregationfunction.html#cfn-quicksight-dataset-datapreppercentileaggregationfunction-inputcolumnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PercentileValue": { "MarkdownDocumentation": "`PercentileValue`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreppercentileaggregationfunction.html#cfn-quicksight-dataset-datapreppercentileaggregationfunction-percentilevalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::DataSet.DataPrepSimpleAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataPrepSimpleAggregationFunction`\n\nA simple aggregation function that performs standard statistical operations on a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepsimpleaggregationfunction.html", "Properties": { "FunctionType": { "MarkdownDocumentation": "`FunctionType`\n\nThe type of aggregation function to perform, such as `COUNT`, `SUM`, `AVERAGE`,\n`MIN`, `MAX`, `MEDIAN`, `VARIANCE`, or `STANDARD_DEVIATION`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `COUNT | DISTINCT_COUNT | SU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT", "SUM", "AVERAGE", "MEDIAN", "MAX", "MIN", "VARIANCE", "STANDARD_DEVIATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepsimpleaggregationfunction.html#cfn-quicksight-dataset-dataprepsimpleaggregationfunction-functiontype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputColumnName": { "MarkdownDocumentation": "`InputColumnName`\n\nThe name of the column on which to perform the aggregation function.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepsimpleaggregationfunction.html#cfn-quicksight-dataset-dataprepsimpleaggregationfunction-inputcolumnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.DataSetColumnIdMapping": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetColumnIdMapping`\n\nThe `DataSetColumnIdMapping` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](./aws-resource-quicksight-dataset.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetcolumnidmapping.html", "Properties": { "SourceColumnId": { "MarkdownDocumentation": "`SourceColumnId`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetcolumnidmapping.html#cfn-quicksight-dataset-datasetcolumnidmapping-sourcecolumnid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetColumnId": { "MarkdownDocumentation": "`TargetColumnId`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetcolumnidmapping.html#cfn-quicksight-dataset-datasetcolumnidmapping-targetcolumnid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.DataSetDateComparisonFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetDateComparisonFilterCondition`\n\nA filter condition that compares date values using operators like `BEFORE`, `AFTER`, or\ntheir inclusive variants.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatecomparisonfiltercondition.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe comparison operator to use, such as `BEFORE`, `BEFORE_OR_EQUALS_TO`, `AFTER`,\nor `AFTER_OR_EQUALS_TO`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BEFORE | BEFORE_OR_EQUALS_T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BEFORE", "BEFORE_OR_EQUALS_TO", "AFTER", "AFTER_OR_EQUALS_TO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatecomparisonfiltercondition.html#cfn-quicksight-dataset-datasetdatecomparisonfiltercondition-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe date value to compare against.\n*Required*: No\n*Type*: [DataSetDateFilterValue](./aws-properties-quicksight-dataset-datasetdatefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatecomparisonfiltercondition.html#cfn-quicksight-dataset-datasetdatecomparisonfiltercondition-value", "UpdateType": "Mutable", "Required": false, "Type": "DataSetDateFilterValue" } } }, "AWS::QuickSight::DataSet.DataSetDateFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetDateFilterCondition`\n\nA filter condition for date columns, supporting both comparison and range-based filtering.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltercondition.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the date column to filter.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltercondition.html#cfn-quicksight-dataset-datasetdatefiltercondition-columnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeFilterCondition": { "MarkdownDocumentation": "`RangeFilterCondition`\n\nA range-based filter condition for the date column, filtering values between minimum and maximum dates.\n*Required*: No\n*Type*: [DataSetDateRangeFilterCondition](./aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltercondition.html#cfn-quicksight-dataset-datasetdatefiltercondition-rangefiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetDateRangeFilterCondition" }, "ComparisonFilterCondition": { "MarkdownDocumentation": "`ComparisonFilterCondition`\n\nA comparison-based filter condition for the date column.\n*Required*: No\n*Type*: [DataSetDateComparisonFilterCondition](./aws-properties-quicksight-dataset-datasetdatecomparisonfiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltercondition.html#cfn-quicksight-dataset-datasetdatefiltercondition-comparisonfiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetDateComparisonFilterCondition" } } }, "AWS::QuickSight::DataSet.DataSetDateFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetDateFilterValue`\n\nRepresents a date value used in filter conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltervalue.html", "Properties": { "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nA static date value used for filtering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltervalue.html#cfn-quicksight-dataset-datasetdatefiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.DataSetDateRangeFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetDateRangeFilterCondition`\n\nA filter condition that filters date values within a specified range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html", "Properties": { "IncludeMaximum": { "MarkdownDocumentation": "`IncludeMaximum`\n\nWhether to include the maximum value in the filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html#cfn-quicksight-dataset-datasetdaterangefiltercondition-includemaximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RangeMinimum": { "MarkdownDocumentation": "`RangeMinimum`\n\nThe minimum date value for the range filter.\n*Required*: No\n*Type*: [DataSetDateFilterValue](./aws-properties-quicksight-dataset-datasetdatefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html#cfn-quicksight-dataset-datasetdaterangefiltercondition-rangeminimum", "UpdateType": "Mutable", "Required": false, "Type": "DataSetDateFilterValue" }, "RangeMaximum": { "MarkdownDocumentation": "`RangeMaximum`\n\nThe maximum date value for the range filter.\n*Required*: No\n*Type*: [DataSetDateFilterValue](./aws-properties-quicksight-dataset-datasetdatefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html#cfn-quicksight-dataset-datasetdaterangefiltercondition-rangemaximum", "UpdateType": "Mutable", "Required": false, "Type": "DataSetDateFilterValue" }, "IncludeMinimum": { "MarkdownDocumentation": "`IncludeMinimum`\n\nWhether to include the minimum value in the filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html#cfn-quicksight-dataset-datasetdaterangefiltercondition-includeminimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::DataSet.DataSetNumericComparisonFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetNumericComparisonFilterCondition`\n\nA filter condition that compares numeric values using operators like `EQUALS`, `GREATER_THAN`,\nor `LESS_THAN`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericcomparisonfiltercondition.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe comparison operator to use, such as `EQUALS`, `GREATER_THAN`, `LESS_THAN`,\nor their variants.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | G...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUALS_TO", "LESS_THAN", "LESS_THAN_OR_EQUALS_TO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericcomparisonfiltercondition.html#cfn-quicksight-dataset-datasetnumericcomparisonfiltercondition-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe numeric value to compare against.\n*Required*: No\n*Type*: [DataSetNumericFilterValue](./aws-properties-quicksight-dataset-datasetnumericfiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericcomparisonfiltercondition.html#cfn-quicksight-dataset-datasetnumericcomparisonfiltercondition-value", "UpdateType": "Mutable", "Required": false, "Type": "DataSetNumericFilterValue" } } }, "AWS::QuickSight::DataSet.DataSetNumericFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetNumericFilterCondition`\n\nA filter condition for numeric columns, supporting both comparison and range-based filtering.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltercondition.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the numeric column to filter.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltercondition.html#cfn-quicksight-dataset-datasetnumericfiltercondition-columnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeFilterCondition": { "MarkdownDocumentation": "`RangeFilterCondition`\n\nA range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.\n*Required*: No\n*Type*: [DataSetNumericRangeFilterCondition](./aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltercondition.html#cfn-quicksight-dataset-datasetnumericfiltercondition-rangefiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetNumericRangeFilterCondition" }, "ComparisonFilterCondition": { "MarkdownDocumentation": "`ComparisonFilterCondition`\n\nA comparison-based filter condition for the numeric column.\n*Required*: No\n*Type*: [DataSetNumericComparisonFilterCondition](./aws-properties-quicksight-dataset-datasetnumericcomparisonfiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltercondition.html#cfn-quicksight-dataset-datasetnumericfiltercondition-comparisonfiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetNumericComparisonFilterCondition" } } }, "AWS::QuickSight::DataSet.DataSetNumericFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetNumericFilterValue`\n\nRepresents a numeric value used in filter conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltervalue.html", "Properties": { "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nA static numeric value used for filtering.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltervalue.html#cfn-quicksight-dataset-datasetnumericfiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::DataSet.DataSetNumericRangeFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetNumericRangeFilterCondition`\n\nA filter condition that filters numeric values within a specified range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html", "Properties": { "IncludeMaximum": { "MarkdownDocumentation": "`IncludeMaximum`\n\nWhether to include the maximum value in the filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html#cfn-quicksight-dataset-datasetnumericrangefiltercondition-includemaximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RangeMinimum": { "MarkdownDocumentation": "`RangeMinimum`\n\nThe minimum numeric value for the range filter.\n*Required*: No\n*Type*: [DataSetNumericFilterValue](./aws-properties-quicksight-dataset-datasetnumericfiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html#cfn-quicksight-dataset-datasetnumericrangefiltercondition-rangeminimum", "UpdateType": "Mutable", "Required": false, "Type": "DataSetNumericFilterValue" }, "RangeMaximum": { "MarkdownDocumentation": "`RangeMaximum`\n\nThe maximum numeric value for the range filter.\n*Required*: No\n*Type*: [DataSetNumericFilterValue](./aws-properties-quicksight-dataset-datasetnumericfiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html#cfn-quicksight-dataset-datasetnumericrangefiltercondition-rangemaximum", "UpdateType": "Mutable", "Required": false, "Type": "DataSetNumericFilterValue" }, "IncludeMinimum": { "MarkdownDocumentation": "`IncludeMinimum`\n\nWhether to include the minimum value in the filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html#cfn-quicksight-dataset-datasetnumericrangefiltercondition-includeminimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::DataSet.DataSetRefreshProperties": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetRefreshProperties`\n\nThe refresh properties of a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetrefreshproperties.html", "Properties": { "RefreshConfiguration": { "MarkdownDocumentation": "`RefreshConfiguration`\n\nThe refresh configuration for a dataset.\n*Required*: No\n*Type*: [RefreshConfiguration](./aws-properties-quicksight-dataset-refreshconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetrefreshproperties.html#cfn-quicksight-dataset-datasetrefreshproperties-refreshconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RefreshConfiguration" }, "FailureConfiguration": { "MarkdownDocumentation": "`FailureConfiguration`\n\nThe failure configuration for a dataset.\n*Required*: No\n*Type*: [RefreshFailureConfiguration](./aws-properties-quicksight-dataset-refreshfailureconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetrefreshproperties.html#cfn-quicksight-dataset-datasetrefreshproperties-failureconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RefreshFailureConfiguration" } } }, "AWS::QuickSight::DataSet.DataSetStringComparisonFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetStringComparisonFilterCondition`\n\nA filter condition that compares string values using operators like `EQUALS`, `CONTAINS`,\nor `STARTS_WITH`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringcomparisonfiltercondition.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe comparison operator to use, such as `EQUALS`, `CONTAINS`, `STARTS_WITH`,\n`ENDS_WITH`, or their negations.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringcomparisonfiltercondition.html#cfn-quicksight-dataset-datasetstringcomparisonfiltercondition-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe string value to compare against.\n*Required*: No\n*Type*: [DataSetStringFilterValue](./aws-properties-quicksight-dataset-datasetstringfiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringcomparisonfiltercondition.html#cfn-quicksight-dataset-datasetstringcomparisonfiltercondition-value", "UpdateType": "Mutable", "Required": false, "Type": "DataSetStringFilterValue" } } }, "AWS::QuickSight::DataSet.DataSetStringFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetStringFilterCondition`\n\nA filter condition for string columns, supporting both comparison and list-based filtering.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltercondition.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the string column to filter.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltercondition.html#cfn-quicksight-dataset-datasetstringfiltercondition-columnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComparisonFilterCondition": { "MarkdownDocumentation": "`ComparisonFilterCondition`\n\nA comparison-based filter condition for the string column.\n*Required*: No\n*Type*: [DataSetStringComparisonFilterCondition](./aws-properties-quicksight-dataset-datasetstringcomparisonfiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltercondition.html#cfn-quicksight-dataset-datasetstringfiltercondition-comparisonfiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetStringComparisonFilterCondition" }, "ListFilterCondition": { "MarkdownDocumentation": "`ListFilterCondition`\n\nA list-based filter condition that includes or excludes values from a specified list.\n*Required*: No\n*Type*: [DataSetStringListFilterCondition](./aws-properties-quicksight-dataset-datasetstringlistfiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltercondition.html#cfn-quicksight-dataset-datasetstringfiltercondition-listfiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetStringListFilterCondition" } } }, "AWS::QuickSight::DataSet.DataSetStringFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetStringFilterValue`\n\nRepresents a string value used in filter conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltervalue.html", "Properties": { "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nA static string value used for filtering.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltervalue.html#cfn-quicksight-dataset-datasetstringfiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.DataSetStringListFilterCondition": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetStringListFilterCondition`\n\nA filter condition that includes or excludes string values from a specified list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltercondition.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe list operator to use, either `INCLUDE` to match values in the list or `EXCLUDE` to\nfilter out values in the list.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INCLUDE | EXCLUDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCLUDE", "EXCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltercondition.html#cfn-quicksight-dataset-datasetstringlistfiltercondition-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe list of string values to include or exclude in the filter.\n*Required*: No\n*Type*: [DataSetStringListFilterValue](./aws-properties-quicksight-dataset-datasetstringlistfiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltercondition.html#cfn-quicksight-dataset-datasetstringlistfiltercondition-values", "UpdateType": "Mutable", "Required": false, "Type": "DataSetStringListFilterValue" } } }, "AWS::QuickSight::DataSet.DataSetStringListFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetStringListFilterValue`\n\nRepresents a list of string values used in filter conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltervalue.html", "Properties": { "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nA list of static string values used for filtering.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltervalue.html#cfn-quicksight-dataset-datasetstringlistfiltervalue-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.DataSetUsageConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DataSetUsageConfiguration`\n\nThe usage configuration to apply to child datasets that reference this dataset as a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html", "Properties": { "DisableUseAsImportedSource": { "MarkdownDocumentation": "`DisableUseAsImportedSource`\n\nAn option that controls whether a child dataset that's stored in Quick Sight 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasimportedsource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DisableUseAsDirectQuerySource": { "MarkdownDocumentation": "`DisableUseAsDirectQuerySource`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasdirectquerysource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::DataSet.DatasetParameter": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DatasetParameter`\n\nThe parameter declarations of the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html", "Properties": { "IntegerDatasetParameter": { "MarkdownDocumentation": "`IntegerDatasetParameter`\n\nAn integer parameter that is created in the dataset.\n*Required*: No\n*Type*: [IntegerDatasetParameter](./aws-properties-quicksight-dataset-integerdatasetparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html#cfn-quicksight-dataset-datasetparameter-integerdatasetparameter", "UpdateType": "Mutable", "Required": false, "Type": "IntegerDatasetParameter" }, "DateTimeDatasetParameter": { "MarkdownDocumentation": "`DateTimeDatasetParameter`\n\nA date time parameter that is created in the dataset.\n*Required*: No\n*Type*: [DateTimeDatasetParameter](./aws-properties-quicksight-dataset-datetimedatasetparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html#cfn-quicksight-dataset-datasetparameter-datetimedatasetparameter", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeDatasetParameter" }, "DecimalDatasetParameter": { "MarkdownDocumentation": "`DecimalDatasetParameter`\n\nA decimal parameter that is created in the dataset.\n*Required*: No\n*Type*: [DecimalDatasetParameter](./aws-properties-quicksight-dataset-decimaldatasetparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html#cfn-quicksight-dataset-datasetparameter-decimaldatasetparameter", "UpdateType": "Mutable", "Required": false, "Type": "DecimalDatasetParameter" }, "StringDatasetParameter": { "MarkdownDocumentation": "`StringDatasetParameter`\n\nA string parameter that is created in the dataset.\n*Required*: No\n*Type*: [StringDatasetParameter](./aws-properties-quicksight-dataset-stringdatasetparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html#cfn-quicksight-dataset-datasetparameter-stringdatasetparameter", "UpdateType": "Mutable", "Required": false, "Type": "StringDatasetParameter" } } }, "AWS::QuickSight::DataSet.DateTimeDatasetParameter": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DateTimeDatasetParameter`\n\nA date time parameter that is created in the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html", "Properties": { "ValueType": { "MarkdownDocumentation": "`ValueType`\n\nThe value type of the dataset parameter. Valid values are `single value` or `multi value`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-valuetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe time granularity of the date time parameter.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nA list of default values for a given date time parameter. This structure only accepts static values.\n*Required*: No\n*Type*: [DateTimeDatasetParameterDefaultValues](./aws-properties-quicksight-dataset-datetimedatasetparameterdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeDatasetParameterDefaultValues" }, "Id": { "MarkdownDocumentation": "`Id`\n\nAn identifier for the parameter that is created in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the date time parameter that is created in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.DateTimeDatasetParameterDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DateTimeDatasetParameterDefaultValues`\n\nThe `DateTimeDatasetParameterDefaultValues` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](./aws-resource-quicksight-dataset.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameterdefaultvalues.html", "Properties": { "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nA list of static default values for a given date time parameter. The valid format for this property is `yyyy-MM-dd\u2019T\u2019HH:mm:ss\u2019Z\u2019`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameterdefaultvalues.html#cfn-quicksight-dataset-datetimedatasetparameterdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.DecimalDatasetParameter": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DecimalDatasetParameter`\n\nA decimal parameter that is created in the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html", "Properties": { "ValueType": { "MarkdownDocumentation": "`ValueType`\n\nThe value type of the dataset parameter. Valid values are `single value` or `multi value`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html#cfn-quicksight-dataset-decimaldatasetparameter-valuetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nA list of default values for a given decimal parameter. This structure only accepts static values.\n*Required*: No\n*Type*: [DecimalDatasetParameterDefaultValues](./aws-properties-quicksight-dataset-decimaldatasetparameterdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html#cfn-quicksight-dataset-decimaldatasetparameter-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "DecimalDatasetParameterDefaultValues" }, "Id": { "MarkdownDocumentation": "`Id`\n\nAn identifier for the decimal parameter created in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html#cfn-quicksight-dataset-decimaldatasetparameter-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the decimal parameter that is created in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html#cfn-quicksight-dataset-decimaldatasetparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.DecimalDatasetParameterDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DecimalDatasetParameterDefaultValues`\n\nA list of default values for a given decimal parameter. This structure only accepts static values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameterdefaultvalues.html", "Properties": { "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nA list of static default values for a given decimal parameter.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameterdefaultvalues.html#cfn-quicksight-dataset-decimaldatasetparameterdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.DestinationTable": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DestinationTable`\n\nDefines a destination table in data preparation that receives the final transformed data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtable.html", "Properties": { "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for the destination 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtable.html#cfn-quicksight-dataset-destinationtable-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source configuration that specifies which transform operation provides data to this destination table.\n*Required*: Yes\n*Type*: [DestinationTableSource](./aws-properties-quicksight-dataset-destinationtablesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtable.html#cfn-quicksight-dataset-destinationtable-source", "UpdateType": "Mutable", "Required": true, "Type": "DestinationTableSource" } } }, "AWS::QuickSight::DataSet.DestinationTableSource": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.DestinationTableSource`\n\nSpecifies the source of data for a destination table, including the transform operation and column mappings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtablesource.html", "Properties": { "TransformOperationId": { "MarkdownDocumentation": "`TransformOperationId`\n\nThe identifier of the transform operation that provides data to the destination table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtablesource.html#cfn-quicksight-dataset-destinationtablesource-transformoperationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.FieldFolder": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.FieldFolder`\n\nA FieldFolder element is a folder that contains fields and nested subfolders.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfolder.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for a field folder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfolder.html#cfn-quicksight-dataset-fieldfolder-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nA folder has a list of columns. A column can only be in one folder.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfolder.html#cfn-quicksight-dataset-fieldfolder-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.FilterOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.FilterOperation`\n\nA transform operation that filters rows based on a condition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html", "Properties": { "DateFilterCondition": { "MarkdownDocumentation": "`DateFilterCondition`\n\nA date-based filter condition within a filter operation.\n*Required*: No\n*Type*: [DataSetDateFilterCondition](./aws-properties-quicksight-dataset-datasetdatefiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html#cfn-quicksight-dataset-filteroperation-datefiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetDateFilterCondition" }, "StringFilterCondition": { "MarkdownDocumentation": "`StringFilterCondition`\n\nA string-based filter condition within a filter operation.\n*Required*: No\n*Type*: [DataSetStringFilterCondition](./aws-properties-quicksight-dataset-datasetstringfiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html#cfn-quicksight-dataset-filteroperation-stringfiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetStringFilterCondition" }, "ConditionExpression": { "MarkdownDocumentation": "`ConditionExpression`\n\nAn expression that must evaluate to a Boolean value. Rows for which the expression\nevaluates to true are kept in the dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html#cfn-quicksight-dataset-filteroperation-conditionexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumericFilterCondition": { "MarkdownDocumentation": "`NumericFilterCondition`\n\nA numeric-based filter condition within a filter operation.\n*Required*: No\n*Type*: [DataSetNumericFilterCondition](./aws-properties-quicksight-dataset-datasetnumericfiltercondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html#cfn-quicksight-dataset-filteroperation-numericfiltercondition", "UpdateType": "Mutable", "Required": false, "Type": "DataSetNumericFilterCondition" } } }, "AWS::QuickSight::DataSet.FiltersOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.FiltersOperation`\n\nA transform operation that applies one or more filter conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filtersoperation.html", "Properties": { "FilterOperations": { "MarkdownDocumentation": "`FilterOperations`\n\nThe list of filter operations to apply.\n*Required*: Yes\n*Type*: Array of [FilterOperation](./aws-properties-quicksight-dataset-filteroperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filtersoperation.html#cfn-quicksight-dataset-filtersoperation-filteroperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FilterOperation", "DuplicatesAllowed": true }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filtersoperation.html#cfn-quicksight-dataset-filtersoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source transform operation that provides input data for filtering.\n*Required*: Yes\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filtersoperation.html#cfn-quicksight-dataset-filtersoperation-source", "UpdateType": "Mutable", "Required": true, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.GeoSpatialColumnGroup": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.GeoSpatialColumnGroup`\n\nGeospatial column group that denotes a hierarchy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialcolumngroup.html", "Properties": { "Columns": { "MarkdownDocumentation": "`Columns`\n\nColumns in this hierarchy.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `127 | 16`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialcolumngroup.html#cfn-quicksight-dataset-geospatialcolumngroup-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CountryCode": { "MarkdownDocumentation": "`CountryCode`\n\nCountry code.\n*Required*: No\n*Type*: String\n*Allowed values*: `US`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "US" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialcolumngroup.html#cfn-quicksight-dataset-geospatialcolumngroup-countrycode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialcolumngroup.html#cfn-quicksight-dataset-geospatialcolumngroup-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.ImportTableOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ImportTableOperation`\n\nA transform operation that imports data from a source table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperation.html", "Properties": { "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperation.html#cfn-quicksight-dataset-importtableoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source configuration that specifies which source table to import and any column mappings.\n*Required*: Yes\n*Type*: [ImportTableOperationSource](./aws-properties-quicksight-dataset-importtableoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperation.html#cfn-quicksight-dataset-importtableoperation-source", "UpdateType": "Mutable", "Required": true, "Type": "ImportTableOperationSource" } } }, "AWS::QuickSight::DataSet.ImportTableOperationSource": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ImportTableOperationSource`\n\nSpecifies the source table and column mappings for an import table operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperationsource.html", "Properties": { "SourceTableId": { "MarkdownDocumentation": "`SourceTableId`\n\nThe identifier of the source table to import data from.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperationsource.html#cfn-quicksight-dataset-importtableoperationsource-sourcetableid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnIdMappings": { "MarkdownDocumentation": "`ColumnIdMappings`\n\nThe mappings between source column identifiers and target column identifiers during the import.\n*Required*: No\n*Type*: Array of [DataSetColumnIdMapping](./aws-properties-quicksight-dataset-datasetcolumnidmapping.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperationsource.html#cfn-quicksight-dataset-importtableoperationsource-columnidmappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataSetColumnIdMapping", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.IncrementalRefresh": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.IncrementalRefresh`\n\nThe incremental refresh configuration for a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-incrementalrefresh.html", "Properties": { "LookbackWindow": { "MarkdownDocumentation": "`LookbackWindow`\n\nThe lookback window setup for an incremental refresh configuration.\n*Required*: Yes\n*Type*: [LookbackWindow](./aws-properties-quicksight-dataset-lookbackwindow.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-incrementalrefresh.html#cfn-quicksight-dataset-incrementalrefresh-lookbackwindow", "UpdateType": "Mutable", "Required": true, "Type": "LookbackWindow" } } }, "AWS::QuickSight::DataSet.IngestionWaitPolicy": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.IngestionWaitPolicy`\n\nThe wait policy to use when creating or updating a Dataset. The default is to wait for SPICE ingestion to finish\nwith timeout of 36 hours.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html", "Properties": { "WaitForSpiceIngestion": { "MarkdownDocumentation": "`WaitForSpiceIngestion`\n\nWait for SPICE ingestion to finish to mark dataset creation or update as successful. Default (true). Applicable\nonly when `DataSetImportMode` mode is set to SPICE.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html#cfn-quicksight-dataset-ingestionwaitpolicy-waitforspiceingestion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IngestionWaitTimeInHours": { "MarkdownDocumentation": "`IngestionWaitTimeInHours`\n\nThe maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours. Applicable only when\n`DataSetImportMode` mode is set to SPICE and `WaitForSpiceIngestion` is set to true.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html#cfn-quicksight-dataset-ingestionwaitpolicy-ingestionwaittimeinhours", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::DataSet.InputColumn": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.InputColumn`\n\nMetadata for a column that is used as the input of a transform operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe data type of the column.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRING | INTEGER | DECIMAL ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html#cfn-quicksight-dataset-inputcolumn-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubType": { "MarkdownDocumentation": "`SubType`\n\nThe sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLOAT | FIXED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FLOAT", "FIXED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html#cfn-quicksight-dataset-inputcolumn-subtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA unique identifier for the input column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html#cfn-quicksight-dataset-inputcolumn-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of this column in the underlying data source.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html#cfn-quicksight-dataset-inputcolumn-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.IntegerDatasetParameter": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.IntegerDatasetParameter`\n\nAn integer parameter that is created in the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html", "Properties": { "ValueType": { "MarkdownDocumentation": "`ValueType`\n\nThe value type of the dataset parameter. Valid values are `single value` or `multi value`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html#cfn-quicksight-dataset-integerdatasetparameter-valuetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nA list of default values for a given integer parameter. This structure only accepts static values.\n*Required*: No\n*Type*: [IntegerDatasetParameterDefaultValues](./aws-properties-quicksight-dataset-integerdatasetparameterdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html#cfn-quicksight-dataset-integerdatasetparameter-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "IntegerDatasetParameterDefaultValues" }, "Id": { "MarkdownDocumentation": "`Id`\n\nAn identifier for the integer parameter created in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html#cfn-quicksight-dataset-integerdatasetparameter-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the integer parameter that is created in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html#cfn-quicksight-dataset-integerdatasetparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.IntegerDatasetParameterDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.IntegerDatasetParameterDefaultValues`\n\nA list of default values for a given integer parameter. This structure only accepts static values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameterdefaultvalues.html", "Properties": { "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nA list of static default values for a given integer parameter.\n*Required*: No\n*Type*: Array of Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameterdefaultvalues.html#cfn-quicksight-dataset-integerdatasetparameterdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Long", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.JoinOperandProperties": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.JoinOperandProperties`\n\nProperties that control how columns are handled for a join operand, including column name overrides.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperandproperties.html", "Properties": { "OutputColumnNameOverrides": { "MarkdownDocumentation": "`OutputColumnNameOverrides`\n\nA list of column name overrides to apply to the join operand's output columns.\n*Required*: Yes\n*Type*: Array of [OutputColumnNameOverride](./aws-properties-quicksight-dataset-outputcolumnnameoverride.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperandproperties.html#cfn-quicksight-dataset-joinoperandproperties-outputcolumnnameoverrides", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "OutputColumnNameOverride", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.JoinOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.JoinOperation`\n\nA transform operation that combines data from two sources based on specified join conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html", "Properties": { "OnClause": { "MarkdownDocumentation": "`OnClause`\n\nThe join condition that specifies how to match rows between the left and right operands.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-onclause", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of join to perform, such as `INNER`, `LEFT`, `RIGHT`, or `OUTER`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INNER | OUTER | LEFT | RIGH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INNER", "OUTER", "LEFT", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RightOperandProperties": { "MarkdownDocumentation": "`RightOperandProperties`\n\nProperties that control how the right operand's columns are handled in the join result.\n*Required*: No\n*Type*: [JoinOperandProperties](./aws-properties-quicksight-dataset-joinoperandproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-rightoperandproperties", "UpdateType": "Mutable", "Required": false, "Type": "JoinOperandProperties" }, "LeftOperandProperties": { "MarkdownDocumentation": "`LeftOperandProperties`\n\nProperties that control how the left operand's columns are handled in the join result.\n*Required*: No\n*Type*: [JoinOperandProperties](./aws-properties-quicksight-dataset-joinoperandproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-leftoperandproperties", "UpdateType": "Mutable", "Required": false, "Type": "JoinOperandProperties" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LeftOperand": { "MarkdownDocumentation": "`LeftOperand`\n\nThe left operand for the join operation.\n*Required*: Yes\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-leftoperand", "UpdateType": "Mutable", "Required": true, "Type": "TransformOperationSource" }, "RightOperand": { "MarkdownDocumentation": "`RightOperand`\n\nThe right operand for the join operation.\n*Required*: Yes\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-rightoperand", "UpdateType": "Mutable", "Required": true, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.LookbackWindow": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.LookbackWindow`\n\nThe lookback window setup of an incremental refresh configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the lookback window column.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html#cfn-quicksight-dataset-lookbackwindow-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SizeUnit": { "MarkdownDocumentation": "`SizeUnit`\n\nThe size unit that is used for the lookback window column. Valid values for this structure are `HOUR`, `DAY`, and `WEEK`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HOUR | DAY | WEEK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HOUR", "DAY", "WEEK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html#cfn-quicksight-dataset-lookbackwindow-sizeunit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe lookback window column size.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html#cfn-quicksight-dataset-lookbackwindow-size", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::DataSet.OutputColumn": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.OutputColumn`\n\nOutput column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe data type of the column.\n*Required*: No\n*Type*: String\n*Allowed values*: `STRING | INTEGER | DECIMAL ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "INTEGER", "DECIMAL", "DATETIME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for a column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubType": { "MarkdownDocumentation": "`SubType`\n\nThe sub data type of the column.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLOAT | FIXED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FLOAT", "FIXED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-subtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA unique identifier for the output column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe display name of the column..\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.OutputColumnNameOverride": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.OutputColumnNameOverride`\n\nSpecifies a mapping to override the name of an output column from a transform operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumnnameoverride.html", "Properties": { "OutputColumnName": { "MarkdownDocumentation": "`OutputColumnName`\n\nThe new name to assign to the column in the output.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumnnameoverride.html#cfn-quicksight-dataset-outputcolumnnameoverride-outputcolumnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceColumnName": { "MarkdownDocumentation": "`SourceColumnName`\n\nThe original name of the column from the source transform operation.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumnnameoverride.html#cfn-quicksight-dataset-outputcolumnnameoverride-sourcecolumnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.ParentDataSet": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ParentDataSet`\n\nReferences a parent dataset that serves as a data source, including its columns and metadata.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-parentdataset.html", "Properties": { "InputColumns": { "MarkdownDocumentation": "`InputColumns`\n\nThe list of input columns available from the parent dataset.\n*Required*: Yes\n*Type*: Array of [InputColumn](./aws-properties-quicksight-dataset-inputcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-parentdataset.html#cfn-quicksight-dataset-parentdataset-inputcolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "InputColumn", "DuplicatesAllowed": true }, "DataSetArn": { "MarkdownDocumentation": "`DataSetArn`\n\nThe Amazon Resource Name (ARN) of the parent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-parentdataset.html#cfn-quicksight-dataset-parentdataset-datasetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.PerformanceConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.PerformanceConfiguration`\n\nThe `PerformanceConfiguration` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](./aws-resource-quicksight-dataset.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-performanceconfiguration.html", "Properties": { "UniqueKeys": { "MarkdownDocumentation": "`UniqueKeys`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [UniqueKey](./aws-properties-quicksight-dataset-uniquekey.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-performanceconfiguration.html#cfn-quicksight-dataset-performanceconfiguration-uniquekeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UniqueKey", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.PhysicalTable": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.PhysicalTable`\n\nA view of a data source that contains information about the shape of the data in the\nunderlying source. This is a variant type structure. For this structure to be valid,\nonly one of the attributes can be non-null.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html", "Properties": { "SaaSTable": { "MarkdownDocumentation": "`SaaSTable`\n\nA physical table type for Software-as-a-Service (SaaS) sources.\n*Required*: No\n*Type*: [SaaSTable](./aws-properties-quicksight-dataset-saastable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html#cfn-quicksight-dataset-physicaltable-saastable", "UpdateType": "Mutable", "Required": false, "Type": "SaaSTable" }, "RelationalTable": { "MarkdownDocumentation": "`RelationalTable`\n\nA physical table type for relational data sources.\n*Required*: No\n*Type*: [RelationalTable](./aws-properties-quicksight-dataset-relationaltable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html#cfn-quicksight-dataset-physicaltable-relationaltable", "UpdateType": "Mutable", "Required": false, "Type": "RelationalTable" }, "CustomSql": { "MarkdownDocumentation": "`CustomSql`\n\nA physical table type built from the results of the custom SQL query.\n*Required*: No\n*Type*: [CustomSql](./aws-properties-quicksight-dataset-customsql.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html#cfn-quicksight-dataset-physicaltable-customsql", "UpdateType": "Mutable", "Required": false, "Type": "CustomSql" }, "S3Source": { "MarkdownDocumentation": "`S3Source`\n\nA physical table type for as S3 data source.\n*Required*: No\n*Type*: [S3Source](./aws-properties-quicksight-dataset-s3source.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html#cfn-quicksight-dataset-physicaltable-s3source", "UpdateType": "Mutable", "Required": false, "Type": "S3Source" } } }, "AWS::QuickSight::DataSet.PivotConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.PivotConfiguration`\n\nConfiguration for a pivot operation, specifying which column contains labels and how to pivot them.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotconfiguration.html", "Properties": { "LabelColumnName": { "MarkdownDocumentation": "`LabelColumnName`\n\nThe name of the column that contains the labels to be pivoted into separate columns.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotconfiguration.html#cfn-quicksight-dataset-pivotconfiguration-labelcolumnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PivotedLabels": { "MarkdownDocumentation": "`PivotedLabels`\n\nThe list of specific label values to pivot into separate columns.\n*Required*: Yes\n*Type*: Array of [PivotedLabel](./aws-properties-quicksight-dataset-pivotedlabel.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotconfiguration.html#cfn-quicksight-dataset-pivotconfiguration-pivotedlabels", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PivotedLabel", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.PivotOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.PivotOperation`\n\nA transform operation that pivots data by converting row values into columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html", "Properties": { "PivotConfiguration": { "MarkdownDocumentation": "`PivotConfiguration`\n\nConfiguration that specifies which labels to pivot and how to structure the resulting columns.\n*Required*: Yes\n*Type*: [PivotConfiguration](./aws-properties-quicksight-dataset-pivotconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-pivotconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PivotConfiguration" }, "GroupByColumnNames": { "MarkdownDocumentation": "`GroupByColumnNames`\n\nThe list of column names to group by when performing the pivot operation.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `127 | 128`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-groupbycolumnnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueColumnConfiguration": { "MarkdownDocumentation": "`ValueColumnConfiguration`\n\nConfiguration for how to aggregate values when multiple rows map to the same pivoted column.\n*Required*: Yes\n*Type*: [ValueColumnConfiguration](./aws-properties-quicksight-dataset-valuecolumnconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-valuecolumnconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ValueColumnConfiguration" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source transform operation that provides input data for pivoting.\n*Required*: Yes\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-source", "UpdateType": "Mutable", "Required": true, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.PivotedLabel": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.PivotedLabel`\n\nSpecifies a label value to be pivoted into a separate column, including the new column name and identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotedlabel.html", "Properties": { "NewColumnName": { "MarkdownDocumentation": "`NewColumnName`\n\nThe name for the new column created from this pivoted label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotedlabel.html#cfn-quicksight-dataset-pivotedlabel-newcolumnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NewColumnId": { "MarkdownDocumentation": "`NewColumnId`\n\nA unique identifier for the new column created from this pivoted label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotedlabel.html#cfn-quicksight-dataset-pivotedlabel-newcolumnid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LabelName": { "MarkdownDocumentation": "`LabelName`\n\nThe label value from the source data to be pivoted.\n*Required*: Yes\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `2047`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotedlabel.html#cfn-quicksight-dataset-pivotedlabel-labelname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.ProjectOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ProjectOperation`\n\nA transform operation that projects columns. Operations that come after a projection\ncan only refer to projected columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-projectoperation.html", "Properties": { "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-projectoperation.html#cfn-quicksight-dataset-projectoperation-alias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProjectedColumns": { "MarkdownDocumentation": "`ProjectedColumns`\n\nProjected columns.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-projectoperation.html#cfn-quicksight-dataset-projectoperation-projectedcolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source transform operation that provides input data for column projection.\n*Required*: No\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-projectoperation.html#cfn-quicksight-dataset-projectoperation-source", "UpdateType": "Mutable", "Required": false, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.RefreshConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RefreshConfiguration`\n\nThe refresh configuration of a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshconfiguration.html", "Properties": { "IncrementalRefresh": { "MarkdownDocumentation": "`IncrementalRefresh`\n\nThe incremental refresh for the dataset.\n*Required*: Yes\n*Type*: [IncrementalRefresh](./aws-properties-quicksight-dataset-incrementalrefresh.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshconfiguration.html#cfn-quicksight-dataset-refreshconfiguration-incrementalrefresh", "UpdateType": "Mutable", "Required": true, "Type": "IncrementalRefresh" } } }, "AWS::QuickSight::DataSet.RefreshFailureConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RefreshFailureConfiguration`\n\nThe failure configuration of a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureconfiguration.html", "Properties": { "EmailAlert": { "MarkdownDocumentation": "`EmailAlert`\n\nThe email alert configuration for a dataset refresh failure.\n*Required*: No\n*Type*: [RefreshFailureEmailAlert](./aws-properties-quicksight-dataset-refreshfailureemailalert.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureconfiguration.html#cfn-quicksight-dataset-refreshfailureconfiguration-emailalert", "UpdateType": "Mutable", "Required": false, "Type": "RefreshFailureEmailAlert" } } }, "AWS::QuickSight::DataSet.RefreshFailureEmailAlert": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RefreshFailureEmailAlert`\n\nThe configuration settings for the email alerts that are sent when a dataset refresh fails.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureemailalert.html", "Properties": { "AlertStatus": { "MarkdownDocumentation": "`AlertStatus`\n\nThe status value that determines if email alerts are sent.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureemailalert.html#cfn-quicksight-dataset-refreshfailureemailalert-alertstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.RelationalTable": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RelationalTable`\n\nA physical table type for relational data sources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html", "Properties": { "DataSourceArn": { "MarkdownDocumentation": "`DataSourceArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-datasourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputColumns": { "MarkdownDocumentation": "`InputColumns`\n\nThe column schema of the table.\n*Required*: Yes\n*Type*: Array of [InputColumn](./aws-properties-quicksight-dataset-inputcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-inputcolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "InputColumn", "DuplicatesAllowed": true }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe schema name. This name applies to certain relational database engines.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-schema", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Catalog": { "MarkdownDocumentation": "`Catalog`\n\nThe catalog associated with a table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-catalog", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the relational table.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.RenameColumnOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RenameColumnOperation`\n\nA transform operation that renames a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnoperation.html", "Properties": { "NewColumnName": { "MarkdownDocumentation": "`NewColumnName`\n\nThe new name for the column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnoperation.html#cfn-quicksight-dataset-renamecolumnoperation-newcolumnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the column to be renamed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnoperation.html#cfn-quicksight-dataset-renamecolumnoperation-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.RenameColumnsOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RenameColumnsOperation`\n\nA transform operation that renames one or more columns in the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnsoperation.html", "Properties": { "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnsoperation.html#cfn-quicksight-dataset-renamecolumnsoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RenameColumnOperations": { "MarkdownDocumentation": "`RenameColumnOperations`\n\nThe list of column rename operations to perform, specifying old and new column names.\n*Required*: Yes\n*Type*: Array of [RenameColumnOperation](./aws-properties-quicksight-dataset-renamecolumnoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnsoperation.html#cfn-quicksight-dataset-renamecolumnsoperation-renamecolumnoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RenameColumnOperation", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source transform operation that provides input data for column renaming.\n*Required*: Yes\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnsoperation.html#cfn-quicksight-dataset-renamecolumnsoperation-source", "UpdateType": "Mutable", "Required": true, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.ResourcePermission": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ResourcePermission`\n\nPermission for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-resourcepermission.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe IAM action to grant or revoke permisions on\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-resourcepermission.html#cfn-quicksight-dataset-resourcepermission-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe Amazon Resource Name (ARN) of the principal. This can be one of the following:\n* The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is\n common.)\n* The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard,\n template, or theme. (This is common.)\n* The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts. (This is\n less common.)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-resourcepermission.html#cfn-quicksight-dataset-resourcepermission-principal", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.RowLevelPermissionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RowLevelPermissionConfiguration`\n\nConfiguration for row level security.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissionconfiguration.html", "Properties": { "TagConfiguration": { "MarkdownDocumentation": "`TagConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [RowLevelPermissionTagConfiguration](./aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissionconfiguration.html#cfn-quicksight-dataset-rowlevelpermissionconfiguration-tagconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RowLevelPermissionTagConfiguration" }, "RowLevelPermissionDataSet": { "MarkdownDocumentation": "`RowLevelPermissionDataSet`\n\nProperty description not available.\n*Required*: No\n*Type*: [RowLevelPermissionDataSet](./aws-properties-quicksight-dataset-rowlevelpermissiondataset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissionconfiguration.html#cfn-quicksight-dataset-rowlevelpermissionconfiguration-rowlevelpermissiondataset", "UpdateType": "Mutable", "Required": false, "Type": "RowLevelPermissionDataSet" } } }, "AWS::QuickSight::DataSet.RowLevelPermissionDataSet": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RowLevelPermissionDataSet`\n\nInformation about a dataset that contains permissions for row-level security (RLS).\nThe permissions dataset maps fields to users or groups. For more information, see\n[Using Row-Level Security (RLS) to Restrict Access to a Dataset](https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html) in the *Quick Sight User\nGuide*.\nThe option to deny permissions by setting `PermissionPolicy` to `DENY_ACCESS` is\nnot supported for new RLS datasets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the row-level security permission dataset. If enabled, the status is `ENABLED`. If disabled, the status is `DISABLED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatVersion": { "MarkdownDocumentation": "`FormatVersion`\n\nThe user or group rules associated with the dataset that contains permissions for RLS.\nBy default, `FormatVersion` is `VERSION_1`. When `FormatVersion` is `VERSION_1`, `UserName` and `GroupName` are required. When `FormatVersion` is `VERSION_2`, `UserARN` and `GroupARN` are required, and `Namespace` must not exist.\n*Required*: No\n*Type*: String\n*Allowed values*: `VERSION_1 | VERSION_2...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VERSION_1", "VERSION_2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-formatversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace associated with the dataset that contains permissions for RLS.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._-]*$`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PermissionPolicy": { "MarkdownDocumentation": "`PermissionPolicy`\n\nThe type of permissions to use when interpreting the permissions for RLS. `DENY_ACCESS`\nis included for backward compatibility only.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GRANT_ACCESS | DENY_ACCESS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GRANT_ACCESS", "DENY_ACCESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-permissionpolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.RowLevelPermissionTagConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RowLevelPermissionTagConfiguration`\n\nThe element you can use to define tags for row-level security.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of row-level security tags. If enabled, the status is `ENABLED`. If disabled, the status is `DISABLED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagRules": { "MarkdownDocumentation": "`TagRules`\n\nA set of rules associated with row-level security, such as the tag names and columns that they are assigned to.\n*Required*: Yes\n*Type*: Array of [RowLevelPermissionTagRule](./aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-tagrules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RowLevelPermissionTagRule", "DuplicatesAllowed": true }, "TagRuleConfigurations": { "MarkdownDocumentation": "`TagRuleConfigurations`\n\nThe configuration of tags on a dataset to set row-level security.\n*Required*: No\n*Type*: Array of Array\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-tagruleconfigurations", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::DataSet.RowLevelPermissionTagRule": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.RowLevelPermissionTagRule`\n\nA set of rules associated with a tag.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe column name that a tag key is assigned 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html#cfn-quicksight-dataset-rowlevelpermissiontagrule-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TagKey": { "MarkdownDocumentation": "`TagKey`\n\nThe unique key for a tag.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html#cfn-quicksight-dataset-rowlevelpermissiontagrule-tagkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchAllValue": { "MarkdownDocumentation": "`MatchAllValue`\n\nA string that you want to use to filter by all the values in a column in the dataset and don\u2019t want to list the values one by one. For example, you can use an asterisk as your match all value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html#cfn-quicksight-dataset-rowlevelpermissiontagrule-matchallvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagMultiValueDelimiter": { "MarkdownDocumentation": "`TagMultiValueDelimiter`\n\nA string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html#cfn-quicksight-dataset-rowlevelpermissiontagrule-tagmultivaluedelimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.S3Source": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.S3Source`\n\nA physical table type for an S3 data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html", "Properties": { "DataSourceArn": { "MarkdownDocumentation": "`DataSourceArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-datasourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputColumns": { "MarkdownDocumentation": "`InputColumns`\n\nA physical table type for an S3 data source.\n###### Note\nFor files that aren't JSON, only `STRING` data types are supported in input columns.\n*Required*: Yes\n*Type*: Array of [InputColumn](./aws-properties-quicksight-dataset-inputcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-inputcolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "InputColumn", "DuplicatesAllowed": true }, "UploadSettings": { "MarkdownDocumentation": "`UploadSettings`\n\nInformation about the format for the S3 source file or files.\n*Required*: No\n*Type*: [UploadSettings](./aws-properties-quicksight-dataset-uploadsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-uploadsettings", "UpdateType": "Mutable", "Required": false, "Type": "UploadSettings" } } }, "AWS::QuickSight::DataSet.SaaSTable": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.SaaSTable`\n\nA table from a Software-as-a-Service (SaaS) data source, including connection details and column definitions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-saastable.html", "Properties": { "DataSourceArn": { "MarkdownDocumentation": "`DataSourceArn`\n\nThe Amazon Resource Name (ARN) of the SaaS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-saastable.html#cfn-quicksight-dataset-saastable-datasourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InputColumns": { "MarkdownDocumentation": "`InputColumns`\n\nThe list of input columns available from the SaaS table.\n*Required*: Yes\n*Type*: Array of [InputColumn](./aws-properties-quicksight-dataset-inputcolumn.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-saastable.html#cfn-quicksight-dataset-saastable-inputcolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "InputColumn", "DuplicatesAllowed": true }, "TablePath": { "MarkdownDocumentation": "`TablePath`\n\nThe hierarchical path to the table within the SaaS data source.\n*Required*: Yes\n*Type*: Array of [TablePathElement](./aws-properties-quicksight-dataset-tablepathelement.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-saastable.html#cfn-quicksight-dataset-saastable-tablepath", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TablePathElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.SemanticModelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.SemanticModelConfiguration`\n\nConfiguration for the semantic model that defines how prepared data is structured for analysis and reporting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semanticmodelconfiguration.html", "Properties": { "TableMap": { "MarkdownDocumentation": "`TableMap`\n\nA map of semantic tables that define the analytical structure.\n*Required*: No\n*Type*: Object of [SemanticTable](./aws-properties-quicksight-dataset-semantictable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semanticmodelconfiguration.html#cfn-quicksight-dataset-semanticmodelconfiguration-tablemap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "SemanticTable" } } }, "AWS::QuickSight::DataSet.SemanticTable": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.SemanticTable`\n\nA semantic table that represents the final analytical structure of the data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semantictable.html", "Properties": { "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for the semantic 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semantictable.html#cfn-quicksight-dataset-semantictable-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DestinationTableId": { "MarkdownDocumentation": "`DestinationTableId`\n\nThe identifier of the destination table from data preparation that provides data to this semantic table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semantictable.html#cfn-quicksight-dataset-semantictable-destinationtableid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RowLevelPermissionConfiguration": { "MarkdownDocumentation": "`RowLevelPermissionConfiguration`\n\nConfiguration for row level security that control data access for this semantic table.\n*Required*: No\n*Type*: [RowLevelPermissionConfiguration](./aws-properties-quicksight-dataset-rowlevelpermissionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semantictable.html#cfn-quicksight-dataset-semantictable-rowlevelpermissionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RowLevelPermissionConfiguration" } } }, "AWS::QuickSight::DataSet.SourceTable": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.SourceTable`\n\nA source table that provides initial data from either a physical table or parent dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-sourcetable.html", "Properties": { "PhysicalTableId": { "MarkdownDocumentation": "`PhysicalTableId`\n\nThe identifier of the physical table that serves as the data source.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-sourcetable.html#cfn-quicksight-dataset-sourcetable-physicaltableid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSet": { "MarkdownDocumentation": "`DataSet`\n\nA parent dataset that serves as the data source instead of a physical table.\n*Required*: No\n*Type*: [ParentDataSet](./aws-properties-quicksight-dataset-parentdataset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-sourcetable.html#cfn-quicksight-dataset-sourcetable-dataset", "UpdateType": "Mutable", "Required": false, "Type": "ParentDataSet" } } }, "AWS::QuickSight::DataSet.StringDatasetParameter": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.StringDatasetParameter`\n\nA string parameter that is created in the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html", "Properties": { "ValueType": { "MarkdownDocumentation": "`ValueType`\n\nThe value type of the dataset parameter. Valid values are `single value` or `multi value`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html#cfn-quicksight-dataset-stringdatasetparameter-valuetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nA list of default values for a given string dataset parameter type. This structure only accepts static values.\n*Required*: No\n*Type*: [StringDatasetParameterDefaultValues](./aws-properties-quicksight-dataset-stringdatasetparameterdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html#cfn-quicksight-dataset-stringdatasetparameter-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "StringDatasetParameterDefaultValues" }, "Id": { "MarkdownDocumentation": "`Id`\n\nAn identifier for the string parameter that is created in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html#cfn-quicksight-dataset-stringdatasetparameter-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the string parameter that is created in the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html#cfn-quicksight-dataset-stringdatasetparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.StringDatasetParameterDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.StringDatasetParameterDefaultValues`\n\nA list of default values for a given string dataset parameter type. This structure only accepts static values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameterdefaultvalues.html", "Properties": { "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nA list of static default values for a given string parameter.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 32`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameterdefaultvalues.html#cfn-quicksight-dataset-stringdatasetparameterdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.TablePathElement": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.TablePathElement`\n\nAn element in the hierarchical path to a table within a data source, containing both name and identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tablepathelement.html", "Properties": { "Id": { "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the path element.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tablepathelement.html#cfn-quicksight-dataset-tablepathelement-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the path element.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tablepathelement.html#cfn-quicksight-dataset-tablepathelement-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.TransformOperationSource": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.TransformOperationSource`\n\nSpecifies the source of data for a transform operation, including the source operation and column mappings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperationsource.html", "Properties": { "TransformOperationId": { "MarkdownDocumentation": "`TransformOperationId`\n\nThe identifier of the transform operation that provides input data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperationsource.html#cfn-quicksight-dataset-transformoperationsource-transformoperationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnIdMappings": { "MarkdownDocumentation": "`ColumnIdMappings`\n\nThe mappings between source column identifiers and target column identifiers for this transformation.\n*Required*: No\n*Type*: Array of [DataSetColumnIdMapping](./aws-properties-quicksight-dataset-datasetcolumnidmapping.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperationsource.html#cfn-quicksight-dataset-transformoperationsource-columnidmappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataSetColumnIdMapping", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.TransformStep": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.TransformStep`\n\nA step in data preparation that performs a specific operation on the data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html", "Properties": { "ProjectStep": { "MarkdownDocumentation": "`ProjectStep`\n\nProperty description not available.\n*Required*: No\n*Type*: [ProjectOperation](./aws-properties-quicksight-dataset-projectoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-projectstep", "UpdateType": "Mutable", "Required": false, "Type": "ProjectOperation" }, "CreateColumnsStep": { "MarkdownDocumentation": "`CreateColumnsStep`\n\nProperty description not available.\n*Required*: No\n*Type*: [CreateColumnsOperation](./aws-properties-quicksight-dataset-createcolumnsoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-createcolumnsstep", "UpdateType": "Mutable", "Required": false, "Type": "CreateColumnsOperation" }, "RenameColumnsStep": { "MarkdownDocumentation": "`RenameColumnsStep`\n\nA transform step that changes the names of one or more columns.\n*Required*: No\n*Type*: [RenameColumnsOperation](./aws-properties-quicksight-dataset-renamecolumnsoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-renamecolumnsstep", "UpdateType": "Mutable", "Required": false, "Type": "RenameColumnsOperation" }, "CastColumnTypesStep": { "MarkdownDocumentation": "`CastColumnTypesStep`\n\nA transform step that changes the data types of one or more columns.\n*Required*: No\n*Type*: [CastColumnTypesOperation](./aws-properties-quicksight-dataset-castcolumntypesoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-castcolumntypesstep", "UpdateType": "Mutable", "Required": false, "Type": "CastColumnTypesOperation" }, "ImportTableStep": { "MarkdownDocumentation": "`ImportTableStep`\n\nA transform step that brings data from a source table.\n*Required*: No\n*Type*: [ImportTableOperation](./aws-properties-quicksight-dataset-importtableoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-importtablestep", "UpdateType": "Mutable", "Required": false, "Type": "ImportTableOperation" }, "UnpivotStep": { "MarkdownDocumentation": "`UnpivotStep`\n\nA transform step that converts columns into rows to normalize the data structure.\n*Required*: No\n*Type*: [UnpivotOperation](./aws-properties-quicksight-dataset-unpivotoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-unpivotstep", "UpdateType": "Mutable", "Required": false, "Type": "UnpivotOperation" }, "JoinStep": { "MarkdownDocumentation": "`JoinStep`\n\nA transform step that combines data from two sources based on specified join conditions.\n*Required*: No\n*Type*: [JoinOperation](./aws-properties-quicksight-dataset-joinoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-joinstep", "UpdateType": "Mutable", "Required": false, "Type": "JoinOperation" }, "AppendStep": { "MarkdownDocumentation": "`AppendStep`\n\nA transform step that combines rows from multiple sources by stacking them vertically.\n*Required*: No\n*Type*: [AppendOperation](./aws-properties-quicksight-dataset-appendoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-appendstep", "UpdateType": "Mutable", "Required": false, "Type": "AppendOperation" }, "FiltersStep": { "MarkdownDocumentation": "`FiltersStep`\n\nA transform step that applies filter conditions.\n*Required*: No\n*Type*: [FiltersOperation](./aws-properties-quicksight-dataset-filtersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-filtersstep", "UpdateType": "Mutable", "Required": false, "Type": "FiltersOperation" }, "AggregateStep": { "MarkdownDocumentation": "`AggregateStep`\n\nA transform step that groups data and applies aggregation functions to calculate summary values.\n*Required*: No\n*Type*: [AggregateOperation](./aws-properties-quicksight-dataset-aggregateoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-aggregatestep", "UpdateType": "Mutable", "Required": false, "Type": "AggregateOperation" }, "PivotStep": { "MarkdownDocumentation": "`PivotStep`\n\nA transform step that converts row values into columns to reshape the data structure.\n*Required*: No\n*Type*: [PivotOperation](./aws-properties-quicksight-dataset-pivotoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-pivotstep", "UpdateType": "Mutable", "Required": false, "Type": "PivotOperation" } } }, "AWS::QuickSight::DataSet.UniqueKey": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.UniqueKey`\n\nThe `UniqueKey` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](./aws-resource-quicksight-dataset.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uniquekey.html", "Properties": { "ColumnNames": { "MarkdownDocumentation": "`ColumnNames`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `127 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uniquekey.html#cfn-quicksight-dataset-uniquekey-columnnames", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSet.UnpivotOperation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.UnpivotOperation`\n\nA transform operation that converts columns into rows, normalizing the data structure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html", "Properties": { "UnpivotedLabelColumnName": { "MarkdownDocumentation": "`UnpivotedLabelColumnName`\n\nThe name for the new column that will contain the unpivoted column names.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-unpivotedlabelcolumnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnsToUnpivot": { "MarkdownDocumentation": "`ColumnsToUnpivot`\n\nThe list of columns to unpivot from the source data.\n*Required*: Yes\n*Type*: Array of [ColumnToUnpivot](./aws-properties-quicksight-dataset-columntounpivot.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-columnstounpivot", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnToUnpivot", "DuplicatesAllowed": true }, "UnpivotedLabelColumnId": { "MarkdownDocumentation": "`UnpivotedLabelColumnId`\n\nA unique identifier for the new column that will contain the unpivoted column names.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-unpivotedlabelcolumnid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nAlias for this operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-alias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UnpivotedValueColumnId": { "MarkdownDocumentation": "`UnpivotedValueColumnId`\n\nA unique identifier for the new column that will contain the unpivoted values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-unpivotedvaluecolumnid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UnpivotedValueColumnName": { "MarkdownDocumentation": "`UnpivotedValueColumnName`\n\nThe name for the new column that will contain the unpivoted values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-unpivotedvaluecolumnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source transform operation that provides input data for unpivoting.\n*Required*: Yes\n*Type*: [TransformOperationSource](./aws-properties-quicksight-dataset-transformoperationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-source", "UpdateType": "Mutable", "Required": true, "Type": "TransformOperationSource" } } }, "AWS::QuickSight::DataSet.UploadSettings": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.UploadSettings`\n\nInformation about the format for a source file or files.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html", "Properties": { "ContainsHeader": { "MarkdownDocumentation": "`ContainsHeader`\n\nWhether the file has a header row, or the files each have a header row.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-containsheader", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TextQualifier": { "MarkdownDocumentation": "`TextQualifier`\n\nText qualifier.\n*Required*: No\n*Type*: String\n*Allowed values*: `DOUBLE_QUOTE | SINGLE_QUOTE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DOUBLE_QUOTE", "SINGLE_QUOTE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-textqualifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Format": { "MarkdownDocumentation": "`Format`\n\nFile format.\n*Required*: No\n*Type*: String\n*Allowed values*: `CSV | TSV | CLF | ELF | XLS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CSV", "TSV", "CLF", "ELF", "XLSX", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-format", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartFromRow": { "MarkdownDocumentation": "`StartFromRow`\n\nA row number to start reading data from.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-startfromrow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter between values in the file.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSet.ValueColumnConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet.ValueColumnConfiguration`\n\nConfiguration for how to handle value columns in pivot operations, including aggregation settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-valuecolumnconfiguration.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function to apply when multiple values map to the same pivoted cell.\n*Required*: No\n*Type*: [DataPrepAggregationFunction](./aws-properties-quicksight-dataset-dataprepaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-valuecolumnconfiguration.html#cfn-quicksight-dataset-valuecolumnconfiguration-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "DataPrepAggregationFunction" } } }, "AWS::QuickSight::DataSource.AmazonElasticsearchParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.AmazonElasticsearchParameters`\n\nThe parameters for OpenSearch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-amazonelasticsearchparameters.html", "Properties": { "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe OpenSearch domain.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-amazonelasticsearchparameters.html#cfn-quicksight-datasource-amazonelasticsearchparameters-domain", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.AmazonOpenSearchParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.AmazonOpenSearchParameters`\n\nThe parameters for OpenSearch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-amazonopensearchparameters.html", "Properties": { "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe OpenSearch domain.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-amazonopensearchparameters.html#cfn-quicksight-datasource-amazonopensearchparameters-domain", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.AthenaParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.AthenaParameters`\n\nParameters for Amazon Athena.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html", "Properties": { "WorkGroup": { "MarkdownDocumentation": "`WorkGroup`\n\nThe workgroup that Amazon Athena uses.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-workgroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdentityCenterConfiguration": { "MarkdownDocumentation": "`IdentityCenterConfiguration`\n\nAn optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.\nThis parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.\n*Required*: No\n*Type*: [IdentityCenterConfiguration](./aws-properties-quicksight-datasource-identitycenterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-identitycenterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IdentityCenterConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nUse the `RoleArn` structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use `RoleArn` to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.AuroraParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.AuroraParameters`\n\nParameters for Amazon Aurora.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.AuroraPostgreSqlParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.AuroraPostgreSqlParameters`\n\nParameters for Amazon Aurora PostgreSQL-Compatible Edition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nThe port that Amazon Aurora PostgreSQL is listening on.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nThe Amazon Aurora PostgreSQL database to connect to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThe Amazon Aurora PostgreSQL-Compatible host to connect to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.CredentialPair": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.CredentialPair`\n\nThe combination of user name and password that are used as credentials.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html", "Properties": { "AlternateDataSourceParameters": { "MarkdownDocumentation": "`AlternateDataSourceParameters`\n\nA set of alternate data source parameters that you want to share for these\ncredentials. The credentials are applied in tandem with the data source parameters when\nyou copy a data source by using a create or update request. The API operation compares\nthe `DataSourceParameters` structure that's in the request with the\nstructures in the `AlternateDataSourceParameters` allow list. If the\nstructures are an exact match, the request is allowed to use the new data source with\nthe existing credentials. If the `AlternateDataSourceParameters` list is\nnull, the `DataSourceParameters` originally used with these\n`Credentials` is automatically allowed.\n*Required*: No\n*Type*: Array of [DataSourceParameters](./aws-properties-quicksight-datasource-datasourceparameters.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-alternatedatasourceparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataSourceParameters", "DuplicatesAllowed": true }, "Username": { "MarkdownDocumentation": "`Username`\n\nUser name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-username", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nPassword.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-password", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.DataSourceCredentials": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.DataSourceCredentials`\n\nData source credentials. This is a variant type structure. For this structure to be\nvalid, only one of the attributes can be non-null.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CopySourceArn": { "MarkdownDocumentation": "`CopySourceArn`\n\nThe Amazon Resource Name (ARN) of a data source that has the credential pair that you\nwant to use. When `CopySourceArn` is not null, the credential pair from the\ndata source in the ARN is used as the credentials for the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-copysourcearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CredentialPair": { "MarkdownDocumentation": "`CredentialPair`\n\nCredential pair. For more information, see\n`[CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html)`.\n*Required*: No\n*Type*: [CredentialPair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-credentialpair", "UpdateType": "Mutable", "Required": false, "Type": "CredentialPair" } } }, "AWS::QuickSight::DataSource.DataSourceErrorInfo": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.DataSourceErrorInfo`\n\nError information for the data source creation or update.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceerrorinfo.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nError type.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCESS_DENIED | COPY_SOURCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceerrorinfo.html#cfn-quicksight-datasource-datasourceerrorinfo-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nError 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceerrorinfo.html#cfn-quicksight-datasource-datasourceerrorinfo-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.DataSourceParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.DataSourceParameters`\n\nThe parameters that Quick Sight uses to connect to your underlying data source.\nThis is a variant type structure. For this structure to be valid, only one of the\nattributes can be non-null.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html", "Properties": { "AuroraPostgreSqlParameters": { "MarkdownDocumentation": "`AuroraPostgreSqlParameters`\n\nThe parameters for Amazon Aurora.\n*Required*: No\n*Type*: [AuroraPostgreSqlParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-aurorapostgresqlparameters", "UpdateType": "Mutable", "Required": false, "Type": "AuroraPostgreSqlParameters" }, "TeradataParameters": { "MarkdownDocumentation": "`TeradataParameters`\n\nThe parameters for Teradata.\n*Required*: No\n*Type*: [TeradataParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-teradataparameters", "UpdateType": "Mutable", "Required": false, "Type": "TeradataParameters" }, "RdsParameters": { "MarkdownDocumentation": "`RdsParameters`\n\nThe parameters for Amazon RDS.\n*Required*: No\n*Type*: [RdsParameters](./aws-properties-quicksight-datasource-rdsparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-rdsparameters", "UpdateType": "Mutable", "Required": false, "Type": "RdsParameters" }, "AthenaParameters": { "MarkdownDocumentation": "`AthenaParameters`\n\nThe parameters for Amazon Athena.\n*Required*: No\n*Type*: [AthenaParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-athenaparameters", "UpdateType": "Mutable", "Required": false, "Type": "AthenaParameters" }, "SparkParameters": { "MarkdownDocumentation": "`SparkParameters`\n\nThe parameters for Spark.\n*Required*: No\n*Type*: [SparkParameters](./aws-properties-quicksight-datasource-sparkparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-sparkparameters", "UpdateType": "Mutable", "Required": false, "Type": "SparkParameters" }, "MariaDbParameters": { "MarkdownDocumentation": "`MariaDbParameters`\n\nThe parameters for MariaDB.\n*Required*: No\n*Type*: [MariaDbParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-mariadbparameters", "UpdateType": "Mutable", "Required": false, "Type": "MariaDbParameters" }, "OracleParameters": { "MarkdownDocumentation": "`OracleParameters`\n\nOracle parameters.\n*Required*: No\n*Type*: [OracleParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-oracleparameters", "UpdateType": "Mutable", "Required": false, "Type": "OracleParameters" }, "PrestoParameters": { "MarkdownDocumentation": "`PrestoParameters`\n\nThe parameters for Presto.\n*Required*: No\n*Type*: [PrestoParameters](./aws-properties-quicksight-datasource-prestoparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-prestoparameters", "UpdateType": "Mutable", "Required": false, "Type": "PrestoParameters" }, "StarburstParameters": { "MarkdownDocumentation": "`StarburstParameters`\n\nThe parameters that are required to connect to a Starburst data source.\n*Required*: No\n*Type*: [StarburstParameters](./aws-properties-quicksight-datasource-starburstparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-starburstparameters", "UpdateType": "Mutable", "Required": false, "Type": "StarburstParameters" }, "RedshiftParameters": { "MarkdownDocumentation": "`RedshiftParameters`\n\nThe parameters for Amazon Redshift.\n*Required*: No\n*Type*: [RedshiftParameters](./aws-properties-quicksight-datasource-redshiftparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-redshiftparameters", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftParameters" }, "MySqlParameters": { "MarkdownDocumentation": "`MySqlParameters`\n\nThe parameters for MySQL.\n*Required*: No\n*Type*: [MySqlParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-mysqlparameters", "UpdateType": "Mutable", "Required": false, "Type": "MySqlParameters" }, "SqlServerParameters": { "MarkdownDocumentation": "`SqlServerParameters`\n\nThe parameters for SQL Server.\n*Required*: No\n*Type*: [SqlServerParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-sqlserverparameters", "UpdateType": "Mutable", "Required": false, "Type": "SqlServerParameters" }, "SnowflakeParameters": { "MarkdownDocumentation": "`SnowflakeParameters`\n\nThe parameters for Snowflake.\n*Required*: No\n*Type*: [SnowflakeParameters](./aws-properties-quicksight-datasource-snowflakeparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-snowflakeparameters", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeParameters" }, "AmazonElasticsearchParameters": { "MarkdownDocumentation": "`AmazonElasticsearchParameters`\n\nThe parameters for OpenSearch.\n*Required*: No\n*Type*: [AmazonElasticsearchParameters](./aws-properties-quicksight-datasource-amazonelasticsearchparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-amazonelasticsearchparameters", "UpdateType": "Mutable", "Required": false, "Type": "AmazonElasticsearchParameters" }, "AmazonOpenSearchParameters": { "MarkdownDocumentation": "`AmazonOpenSearchParameters`\n\nThe parameters for OpenSearch.\n*Required*: No\n*Type*: [AmazonOpenSearchParameters](./aws-properties-quicksight-datasource-amazonopensearchparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-amazonopensearchparameters", "UpdateType": "Mutable", "Required": false, "Type": "AmazonOpenSearchParameters" }, "PostgreSqlParameters": { "MarkdownDocumentation": "`PostgreSqlParameters`\n\nThe parameters for PostgreSQL.\n*Required*: No\n*Type*: [PostgreSqlParameters](./aws-properties-quicksight-datasource-postgresqlparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-postgresqlparameters", "UpdateType": "Mutable", "Required": false, "Type": "PostgreSqlParameters" }, "AuroraParameters": { "MarkdownDocumentation": "`AuroraParameters`\n\nThe parameters for Amazon Aurora MySQL.\n*Required*: No\n*Type*: [AuroraParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-auroraparameters", "UpdateType": "Mutable", "Required": false, "Type": "AuroraParameters" }, "S3Parameters": { "MarkdownDocumentation": "`S3Parameters`\n\nThe parameters for S3.\n*Required*: No\n*Type*: [S3Parameters](./aws-properties-quicksight-datasource-s3parameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-s3parameters", "UpdateType": "Mutable", "Required": false, "Type": "S3Parameters" }, "TrinoParameters": { "MarkdownDocumentation": "`TrinoParameters`\n\nThe parameters that are required to connect to a Trino data source.\n*Required*: No\n*Type*: [TrinoParameters](./aws-properties-quicksight-datasource-trinoparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-trinoparameters", "UpdateType": "Mutable", "Required": false, "Type": "TrinoParameters" }, "DatabricksParameters": { "MarkdownDocumentation": "`DatabricksParameters`\n\nThe required parameters that are needed to connect to a Databricks data source.\n*Required*: No\n*Type*: [DatabricksParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html#cfn-quicksight-datasource-datasourceparameters-databricksparameters", "UpdateType": "Mutable", "Required": false, "Type": "DatabricksParameters" } } }, "AWS::QuickSight::DataSource.DatabricksParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.DatabricksParameters`\n\nThe required parameters that are needed to connect to a Databricks data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nThe port for the Databricks data source.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.html#cfn-quicksight-datasource-databricksparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.html#cfn-quicksight-datasource-databricksparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SqlEndpointPath": { "MarkdownDocumentation": "`SqlEndpointPath`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.html#cfn-quicksight-datasource-databricksparameters-sqlendpointpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.IdentityCenterConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.IdentityCenterConfiguration`\n\nThe parameters for an IAM Identity Center configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-identitycenterconfiguration.html", "Properties": { "EnableIdentityPropagation": { "MarkdownDocumentation": "`EnableIdentityPropagation`\n\nA Boolean option that controls whether Trusted Identity Propagation should be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-identitycenterconfiguration.html#cfn-quicksight-datasource-identitycenterconfiguration-enableidentitypropagation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::DataSource.ManifestFileLocation": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.ManifestFileLocation`\n\nAmazon S3 manifest file location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-manifestfilelocation.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-manifestfilelocation.html#cfn-quicksight-datasource-manifestfilelocation-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-manifestfilelocation.html#cfn-quicksight-datasource-manifestfilelocation-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.MariaDbParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.MariaDbParameters`\n\nThe parameters for MariaDB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.MySqlParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.MySqlParameters`\n\nThe parameters for MySQL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.OAuthParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.OAuthParameters`\n\nAn object that contains information needed to create a data source connection that uses OAuth client credentials. This option is available for data source connections that are made with Snowflake and Starburst.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html", "Properties": { "TokenProviderUrl": { "MarkdownDocumentation": "`TokenProviderUrl`\n\nThe token endpoint URL of the identity provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html#cfn-quicksight-datasource-oauthparameters-tokenproviderurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OAuthScope": { "MarkdownDocumentation": "`OAuthScope`\n\nThe OAuth scope.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html#cfn-quicksight-datasource-oauthparameters-oauthscope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdentityProviderVpcConnectionProperties": { "MarkdownDocumentation": "`IdentityProviderVpcConnectionProperties`\n\nProperty description not available.\n*Required*: No\n*Type*: [VpcConnectionProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html#cfn-quicksight-datasource-oauthparameters-identityprovidervpcconnectionproperties", "UpdateType": "Mutable", "Required": false, "Type": "VpcConnectionProperties" }, "IdentityProviderResourceUri": { "MarkdownDocumentation": "`IdentityProviderResourceUri`\n\nThe resource uri of the identity provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html#cfn-quicksight-datasource-oauthparameters-identityproviderresourceuri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.OracleParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.OracleParameters`\n\nOracle parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html", "Properties": { "UseServiceName": { "MarkdownDocumentation": "`UseServiceName`\n\nA Boolean value that indicates whether the `Database` uses a service name or an SID. If this value is left blank, the default value is `SID`. If this value is set to `false`, the value is `SID`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-useservicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.PostgreSqlParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.PostgreSqlParameters`\n\nThe parameters for PostgreSQL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.PrestoParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.PrestoParameters`\n\nThe parameters for Presto.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Catalog": { "MarkdownDocumentation": "`Catalog`\n\nCatalog.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-catalog", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.RdsParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.RdsParameters`\n\nThe parameters for Amazon RDS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-rdsparameters.html", "Properties": { "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\nInstance ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-rdsparameters.html#cfn-quicksight-datasource-rdsparameters-instanceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-rdsparameters.html#cfn-quicksight-datasource-rdsparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.RedshiftIAMParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.RedshiftIAMParameters`\n\nA structure that grants Quick Sight access to your cluster and make a call to the `redshift:GetClusterCredentials` API. For more information on the `redshift:GetClusterCredentials` API, see [`GetClusterCredentials`](https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html", "Properties": { "AutoCreateDatabaseUser": { "MarkdownDocumentation": "`AutoCreateDatabaseUser`\n\nAutomatically creates a database user. If your database doesn't have a `DatabaseUser`, set this parameter to `True`. If there is no `DatabaseUser`, Quick Sight can't connect to your cluster. The `RoleArn` that you use for this operation must grant access to `redshift:CreateClusterUser` to successfully create the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-autocreatedatabaseuser", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DatabaseUser": { "MarkdownDocumentation": "`DatabaseUser`\n\nThe user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of `AutoCreateDatabaseUser` to `True` to create a new user with PUBLIC permissions.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databaseuser", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nUse the `RoleArn` structure to allow Quick Sight to call `redshift:GetClusterCredentials` on your cluster. The calling principal must have `iam:PassRole` access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseGroups": { "MarkdownDocumentation": "`DatabaseGroups`\n\nA list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the `DatabaseUser`. If you choose to include this parameter, the `RoleArn` must grant access to `redshift:JoinGroup`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databasegroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::DataSource.RedshiftParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.RedshiftParameters`\n\nThe parameters for Amazon Redshift. The `ClusterId` field can be blank if\n`Host` and `Port` are both set. The `Host` and `Port` fields can be blank if the `ClusterId` field is set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html", "Properties": { "IAMParameters": { "MarkdownDocumentation": "`IAMParameters`\n\nAn optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of [DataSourceCredentials](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html).\n*Required*: No\n*Type*: [RedshiftIAMParameters](./aws-properties-quicksight-datasource-redshiftiamparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-iamparameters", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftIAMParameters" }, "ClusterId": { "MarkdownDocumentation": "`ClusterId`\n\nCluster ID. This field can be blank if the `Host` and `Port` are\nprovided.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-clusterid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nPort. This field can be blank if the `ClusterId` is provided.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost. This field can be blank if `ClusterId` is provided.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-host", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdentityCenterConfiguration": { "MarkdownDocumentation": "`IdentityCenterConfiguration`\n\nAn optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.\nThis parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.\n*Required*: No\n*Type*: [IdentityCenterConfiguration](./aws-properties-quicksight-datasource-identitycenterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-identitycenterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IdentityCenterConfiguration" } } }, "AWS::QuickSight::DataSource.ResourcePermission": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.ResourcePermission`\n\nPermission for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe IAM action to grant or revoke permissions on.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html#cfn-quicksight-datasource-resourcepermission-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Resource": { "MarkdownDocumentation": "`Resource`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html#cfn-quicksight-datasource-resourcepermission-resource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe Amazon Resource Name (ARN) of the principal. This can be one of the following:\n* The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is\n common.)\n* The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard,\n template, or theme. (This is common.)\n* The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts. (This is\n less common.)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html#cfn-quicksight-datasource-resourcepermission-principal", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.S3Parameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.S3Parameters`\n\nThe parameters for S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html", "Properties": { "ManifestFileLocation": { "MarkdownDocumentation": "`ManifestFileLocation`\n\nLocation of the Amazon S3 manifest file. This is NULL if the manifest file was\nuploaded into Quick Sight.\n*Required*: Yes\n*Type*: [ManifestFileLocation](./aws-properties-quicksight-datasource-manifestfilelocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html#cfn-quicksight-datasource-s3parameters-manifestfilelocation", "UpdateType": "Mutable", "Required": true, "Type": "ManifestFileLocation" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nUse the `RoleArn` structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use `RoleArn` to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html#cfn-quicksight-datasource-s3parameters-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.SnowflakeParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.SnowflakeParameters`\n\nThe parameters for Snowflake.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html", "Properties": { "Warehouse": { "MarkdownDocumentation": "`Warehouse`\n\nWarehouse.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-warehouse", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseAccessControlRole": { "MarkdownDocumentation": "`DatabaseAccessControlRole`\n\nThe database access control role.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-databaseaccesscontrolrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OAuthParameters": { "MarkdownDocumentation": "`OAuthParameters`\n\nAn object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.\n*Required*: No\n*Type*: [OAuthParameters](./aws-properties-quicksight-datasource-oauthparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-oauthparameters", "UpdateType": "Mutable", "Required": false, "Type": "OAuthParameters" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthenticationType": { "MarkdownDocumentation": "`AuthenticationType`\n\nThe authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.\n*Required*: No\n*Type*: String\n*Allowed values*: `PASSWORD | TOKEN | X509...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PASSWORD", "TOKEN", "X509" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-authenticationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.SparkParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.SparkParameters`\n\nThe parameters for Spark.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sparkparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sparkparameters.html#cfn-quicksight-datasource-sparkparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sparkparameters.html#cfn-quicksight-datasource-sparkparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.SqlServerParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.SqlServerParameters`\n\nThe parameters for SQL Server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.SslProperties": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.SslProperties`\n\nSecure Socket Layer (SSL) properties that apply when Quick Sight connects to your\nunderlying data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sslproperties.html", "Properties": { "DisableSsl": { "MarkdownDocumentation": "`DisableSsl`\n\nA Boolean option to control whether SSL should 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sslproperties.html#cfn-quicksight-datasource-sslproperties-disablessl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::DataSource.StarburstParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.StarburstParameters`\n\nThe parameters that are required to connect to a Starburst data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nThe port for the Starburst data source.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DatabaseAccessControlRole": { "MarkdownDocumentation": "`DatabaseAccessControlRole`\n\nThe database access control role.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-databaseaccesscontrolrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProductType": { "MarkdownDocumentation": "`ProductType`\n\nThe product type for the Starburst data source.\n*Required*: No\n*Type*: String\n*Allowed values*: `GALAXY | ENTERPRISE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GALAXY", "ENTERPRISE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-producttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OAuthParameters": { "MarkdownDocumentation": "`OAuthParameters`\n\nAn object that contains information needed to create a data source connection between an Quick Sight account and Starburst.\n*Required*: No\n*Type*: [OAuthParameters](./aws-properties-quicksight-datasource-oauthparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-oauthparameters", "UpdateType": "Mutable", "Required": false, "Type": "OAuthParameters" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThe host name of the Starburst 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Catalog": { "MarkdownDocumentation": "`Catalog`\n\nThe catalog name for the Starburst data source.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-catalog", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthenticationType": { "MarkdownDocumentation": "`AuthenticationType`\n\nThe authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.\n*Required*: No\n*Type*: String\n*Allowed values*: `PASSWORD | TOKEN | X509...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PASSWORD", "TOKEN", "X509" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-authenticationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.TeradataParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.TeradataParameters`\n\nThe parameters for Teradata.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nPort.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Database": { "MarkdownDocumentation": "`Database`\n\nDatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-database", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nHost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.TrinoParameters": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.TrinoParameters`\n\nThe parameters that are required to connect to a Trino data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-trinoparameters.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nThe port for the Trino data source.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-trinoparameters.html#cfn-quicksight-datasource-trinoparameters-port", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThe host name of the Trino 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-trinoparameters.html#cfn-quicksight-datasource-trinoparameters-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Catalog": { "MarkdownDocumentation": "`Catalog`\n\nThe catalog name for the Trino data source.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-trinoparameters.html#cfn-quicksight-datasource-trinoparameters-catalog", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::DataSource.VpcConnectionProperties": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource.VpcConnectionProperties`\n\nVPC connection properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-vpcconnectionproperties.html", "Properties": { "VpcConnectionArn": { "MarkdownDocumentation": "`VpcConnectionArn`\n\nThe Amazon Resource Name (ARN) for the VPC connection.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-vpcconnectionproperties.html#cfn-quicksight-datasource-vpcconnectionproperties-vpcconnectionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Folder.ResourcePermission": { "MarkdownDocumentation": "`AWS::QuickSight::Folder.ResourcePermission`\n\nThe `ResourcePermission` property type specifies Property description not available. for an [AWS::QuickSight::Folder](./aws-resource-quicksight-folder.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-folder-resourcepermission.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-folder-resourcepermission.html#cfn-quicksight-folder-resourcepermission-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-folder-resourcepermission.html#cfn-quicksight-folder-resourcepermission-principal", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::RefreshSchedule.RefreshOnDay": { "MarkdownDocumentation": "`AWS::QuickSight::RefreshSchedule.RefreshOnDay`\n\nThe day that you want yout dataset to refresh.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshonday.html", "Properties": { "DayOfWeek": { "MarkdownDocumentation": "`DayOfWeek`\n\nThe day of the week that you want to schedule the refresh on. This value is required for weekly and monthly\nrefresh intervals.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUNDAY | MONDAY | TUESDAY |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshonday.html#cfn-quicksight-refreshschedule-refreshonday-dayofweek", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DayOfMonth": { "MarkdownDocumentation": "`DayOfMonth`\n\nThe day of the month that you want your dataset to refresh. This value is required for monthly refresh\nintervals.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshonday.html#cfn-quicksight-refreshschedule-refreshonday-dayofmonth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::RefreshSchedule.RefreshScheduleMap": { "MarkdownDocumentation": "`AWS::QuickSight::RefreshSchedule.RefreshScheduleMap`\n\nA summary of a configured refresh schedule for a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html", "Properties": { "StartAfterDateTime": { "MarkdownDocumentation": "`StartAfterDateTime`\n\nTime after which the refresh schedule can be started, expressed in `YYYY-MM-DDTHH:MM:SS`\nformat.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-startafterdatetime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScheduleId": { "MarkdownDocumentation": "`ScheduleId`\n\nAn identifier for the refresh schedule.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-scheduleid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ScheduleFrequency": { "MarkdownDocumentation": "`ScheduleFrequency`\n\nThe frequency for the refresh schedule.\n*Required*: No\n*Type*: [ScheduleFrequency](./aws-properties-quicksight-refreshschedule-schedulefrequency.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-schedulefrequency", "UpdateType": "Mutable", "Required": false, "Type": "ScheduleFrequency" }, "RefreshType": { "MarkdownDocumentation": "`RefreshType`\n\nThe type of refresh that a dataset undergoes. Valid values are as follows:\n* `FULL_REFRESH`: A complete refresh of a dataset.\n* `INCREMENTAL_REFRESH`: A partial refresh of some rows of a dataset, based on the time window\n specified.\nFor more information on full and incremental refreshes, see [Refreshing SPICE data](https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html) in the *Quick Suite User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `FULL_REFRESH | INCREMENTAL_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FULL_REFRESH", "INCREMENTAL_REFRESH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-refreshtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::RefreshSchedule.ScheduleFrequency": { "MarkdownDocumentation": "`AWS::QuickSight::RefreshSchedule.ScheduleFrequency`\n\nThe frequency for the refresh schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html", "Properties": { "TimeZone": { "MarkdownDocumentation": "`TimeZone`\n\nThe timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on\n`java.util.time.getAvailableIDs()`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-timezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RefreshOnDay": { "MarkdownDocumentation": "`RefreshOnDay`\n\nThe day of the week that you want to schedule the refresh on. This value is required for weekly and monthly\nrefresh intervals.\n*Required*: No\n*Type*: [RefreshOnDay](./aws-properties-quicksight-refreshschedule-refreshonday.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-refreshonday", "UpdateType": "Mutable", "Required": false, "Type": "RefreshOnDay" }, "TimeOfTheDay": { "MarkdownDocumentation": "`TimeOfTheDay`\n\nThe time of day that you want the dataset to refresh. This value is expressed in HH:MM format. This field is not\nrequired for schedules that refresh hourly.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-timeoftheday", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interval": { "MarkdownDocumentation": "`Interval`\n\nThe interval between scheduled refreshes. Valid values are as follows:\n* `MINUTE15`: The dataset refreshes every 15 minutes. This value is only supported for incremental\n refreshes. This interval can only be used for one schedule per dataset.\n* `MINUTE30`: The dataset refreshes every 30 minutes. This value is only supported for incremental\n refreshes. This interval can only be used for one schedule per dataset.\n* `HOURLY`: The dataset refreshes every hour. This interval can only be used for one schedule per\n dataset.\n* `DAILY`: The dataset refreshes every day.\n* `WEEKLY`: The dataset refreshes every week.\n* `MONTHLY`: The dataset refreshes every month.\n*Required*: No\n*Type*: String\n*Allowed values*: `MINUTE15 | MINUTE30 | HOURL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MINUTE15", "MINUTE30", "HOURLY", "DAILY", "WEEKLY", "MONTHLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-schedulefrequency.html#cfn-quicksight-refreshschedule-schedulefrequency-interval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.AggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AggregationFunction`\n\nAn aggregation function aggregates values from a dimension or measure.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html", "Properties": { "AttributeAggregationFunction": { "MarkdownDocumentation": "`AttributeAggregationFunction`\n\nAggregation for attributes.\n*Required*: No\n*Type*: [AttributeAggregationFunction](./aws-properties-quicksight-template-attributeaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html#cfn-quicksight-template-aggregationfunction-attributeaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AttributeAggregationFunction" }, "DateAggregationFunction": { "MarkdownDocumentation": "`DateAggregationFunction`\n\nAggregation for date values.\n* `COUNT`: Aggregate by the total number of values, including duplicates.\n* `DISTINCT_COUNT`: Aggregate by the total number of distinct values.\n* `MIN`: Select the smallest date value.\n* `MAX`: Select the largest date value.\n*Required*: No\n*Type*: String\n*Allowed values*: `COUNT | DISTINCT_COUNT | MI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT", "MIN", "MAX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html#cfn-quicksight-template-aggregationfunction-dateaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumericalAggregationFunction": { "MarkdownDocumentation": "`NumericalAggregationFunction`\n\nAggregation for numerical values.\n*Required*: No\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-template-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html#cfn-quicksight-template-aggregationfunction-numericalaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "NumericalAggregationFunction" }, "CategoricalAggregationFunction": { "MarkdownDocumentation": "`CategoricalAggregationFunction`\n\nAggregation for categorical values.\n* `COUNT`: Aggregate by the total number of values, including duplicates.\n* `DISTINCT_COUNT`: Aggregate by the total number of distinct values.\n*Required*: No\n*Type*: String\n*Allowed values*: `COUNT | DISTINCT_COUNT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html#cfn-quicksight-template-aggregationfunction-categoricalaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.AggregationSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AggregationSortConfiguration`\n\nThe configuration options to sort aggregated values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationsortconfiguration.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe function that aggregates the values in `Column`.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-template-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationsortconfiguration.html#cfn-quicksight-template-aggregationsortconfiguration-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "SortDirection": { "MarkdownDocumentation": "`SortDirection`\n\nThe sort direction of values.\n* `ASC`: Sort in ascending order.\n* `DESC`: Sort in descending order.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationsortconfiguration.html#cfn-quicksight-template-aggregationsortconfiguration-sortdirection", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that determines the sort order of aggregated values.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationsortconfiguration.html#cfn-quicksight-template-aggregationsortconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Template.AnalysisDefaults": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AnalysisDefaults`\n\nThe configuration for default analysis settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-analysisdefaults.html", "Properties": { "DefaultNewSheetConfiguration": { "MarkdownDocumentation": "`DefaultNewSheetConfiguration`\n\nThe configuration for default new sheet settings.\n*Required*: Yes\n*Type*: [DefaultNewSheetConfiguration](./aws-properties-quicksight-template-defaultnewsheetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-analysisdefaults.html#cfn-quicksight-template-analysisdefaults-defaultnewsheetconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "DefaultNewSheetConfiguration" } } }, "AWS::QuickSight::Template.AnchorDateConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AnchorDateConfiguration`\n\nThe date configuration of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-anchordateconfiguration.html", "Properties": { "AnchorOption": { "MarkdownDocumentation": "`AnchorOption`\n\nThe options for the date configuration. Choose one of the options below:\n* `NOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `NOW`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "NOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-anchordateconfiguration.html#cfn-quicksight-template-anchordateconfiguration-anchoroption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe name of the parameter that is used for the anchor date configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-anchordateconfiguration.html#cfn-quicksight-template-anchordateconfiguration-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ArcAxisConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ArcAxisConfiguration`\n\nThe arc axis configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisconfiguration.html", "Properties": { "Range": { "MarkdownDocumentation": "`Range`\n\nThe arc axis range of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcAxisDisplayRange](./aws-properties-quicksight-template-arcaxisdisplayrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisconfiguration.html#cfn-quicksight-template-arcaxisconfiguration-range", "UpdateType": "Mutable", "Required": false, "Type": "ArcAxisDisplayRange" }, "ReserveRange": { "MarkdownDocumentation": "`ReserveRange`\n\nThe reserved range of the arc axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisconfiguration.html#cfn-quicksight-template-arcaxisconfiguration-reserverange", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.ArcAxisDisplayRange": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ArcAxisDisplayRange`\n\nThe arc axis range of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisdisplayrange.html", "Properties": { "Min": { "MarkdownDocumentation": "`Min`\n\nThe minimum value of the arc axis range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisdisplayrange.html#cfn-quicksight-template-arcaxisdisplayrange-min", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Max": { "MarkdownDocumentation": "`Max`\n\nThe maximum value of the arc axis range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisdisplayrange.html#cfn-quicksight-template-arcaxisdisplayrange-max", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.ArcConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ArcConfiguration`\n\nThe arc configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcconfiguration.html", "Properties": { "ArcAngle": { "MarkdownDocumentation": "`ArcAngle`\n\nThe option that determines the arc angle of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcconfiguration.html#cfn-quicksight-template-arcconfiguration-arcangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ArcThickness": { "MarkdownDocumentation": "`ArcThickness`\n\nThe options that determine the arc thickness of a `GaugeChartVisual`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SMALL | MEDIUM | LARGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SMALL", "MEDIUM", "LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcconfiguration.html#cfn-quicksight-template-arcconfiguration-arcthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ArcOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ArcOptions`\n\nThe options that determine the arc thickness of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcoptions.html", "Properties": { "ArcThickness": { "MarkdownDocumentation": "`ArcThickness`\n\nThe arc thickness of a `GaugeChartVisual`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SMALL | MEDIUM | LARGE | WH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SMALL", "MEDIUM", "LARGE", "WHOLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcoptions.html#cfn-quicksight-template-arcoptions-arcthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.AssetOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AssetOptions`\n\nAn array of analysis level configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-assetoptions.html", "Properties": { "Timezone": { "MarkdownDocumentation": "`Timezone`\n\nDetermines the timezone for the analysis.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-assetoptions.html#cfn-quicksight-template-assetoptions-timezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WeekStart": { "MarkdownDocumentation": "`WeekStart`\n\nDetermines the week start day for an analysis.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUNDAY | MONDAY | TUESDAY |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-assetoptions.html#cfn-quicksight-template-assetoptions-weekstart", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.AttributeAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AttributeAggregationFunction`\n\nAggregation for attributes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-attributeaggregationfunction.html", "Properties": { "SimpleAttributeAggregation": { "MarkdownDocumentation": "`SimpleAttributeAggregation`\n\nThe built-in aggregation functions for attributes.\n* `UNIQUE_VALUE`: Returns the unique value for a field, aggregated by the dimension fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNIQUE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNIQUE_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-attributeaggregationfunction.html#cfn-quicksight-template-attributeaggregationfunction-simpleattributeaggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueForMultipleValues": { "MarkdownDocumentation": "`ValueForMultipleValues`\n\nUsed by the `UNIQUE_VALUE` aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-attributeaggregationfunction.html#cfn-quicksight-template-attributeaggregationfunction-valueformultiplevalues", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.AxisDataOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisDataOptions`\n\nThe data options for an axis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdataoptions.html", "Properties": { "DateAxisOptions": { "MarkdownDocumentation": "`DateAxisOptions`\n\nThe options for an axis with a date field.\n*Required*: No\n*Type*: [DateAxisOptions](./aws-properties-quicksight-template-dateaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdataoptions.html#cfn-quicksight-template-axisdataoptions-dateaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateAxisOptions" }, "NumericAxisOptions": { "MarkdownDocumentation": "`NumericAxisOptions`\n\nThe options for an axis with a numeric field.\n*Required*: No\n*Type*: [NumericAxisOptions](./aws-properties-quicksight-template-numericaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdataoptions.html#cfn-quicksight-template-axisdataoptions-numericaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "NumericAxisOptions" } } }, "AWS::QuickSight::Template.AxisDisplayMinMaxRange": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisDisplayMinMaxRange`\n\nThe minimum and maximum setup for an axis display range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayminmaxrange.html", "Properties": { "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nThe minimum setup for an axis display range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayminmaxrange.html#cfn-quicksight-template-axisdisplayminmaxrange-minimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Maximum": { "MarkdownDocumentation": "`Maximum`\n\nThe maximum setup for an axis display range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayminmaxrange.html#cfn-quicksight-template-axisdisplayminmaxrange-maximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.AxisDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisDisplayOptions`\n\nThe display options for the axis label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html", "Properties": { "DataOptions": { "MarkdownDocumentation": "`DataOptions`\n\nThe data options for an axis.\n*Required*: No\n*Type*: [AxisDataOptions](./aws-properties-quicksight-template-axisdataoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-dataoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDataOptions" }, "TickLabelOptions": { "MarkdownDocumentation": "`TickLabelOptions`\n\nThe tick label options of an axis.\n*Required*: No\n*Type*: [AxisTickLabelOptions](./aws-properties-quicksight-template-axisticklabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-ticklabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisTickLabelOptions" }, "AxisOffset": { "MarkdownDocumentation": "`AxisOffset`\n\nThe offset value that determines the starting placement of the axis within a visual's bounds.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-axisoffset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AxisLineVisibility": { "MarkdownDocumentation": "`AxisLineVisibility`\n\nDetermines whether or not the axis line is visible.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-axislinevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "GridLineVisibility": { "MarkdownDocumentation": "`GridLineVisibility`\n\nDetermines whether or not the grid line is visible.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-gridlinevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "ScrollbarOptions": { "MarkdownDocumentation": "`ScrollbarOptions`\n\nThe scroll bar options for an axis.\n*Required*: No\n*Type*: [ScrollBarOptions](./aws-properties-quicksight-template-scrollbaroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-scrollbaroptions", "UpdateType": "Mutable", "Required": false, "Type": "ScrollBarOptions" } } }, "AWS::QuickSight::Template.AxisDisplayRange": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisDisplayRange`\n\nThe range setup of a numeric axis display range.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayrange.html", "Properties": { "DataDriven": { "MarkdownDocumentation": "`DataDriven`\n\nThe data-driven setup of an axis display range.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayrange.html#cfn-quicksight-template-axisdisplayrange-datadriven", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MinMax": { "MarkdownDocumentation": "`MinMax`\n\nThe minimum and maximum setup of an axis display range.\n*Required*: No\n*Type*: [AxisDisplayMinMaxRange](./aws-properties-quicksight-template-axisdisplayminmaxrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayrange.html#cfn-quicksight-template-axisdisplayrange-minmax", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayMinMaxRange" } } }, "AWS::QuickSight::Template.AxisLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisLabelOptions`\n\nThe label options for a chart axis. You must specify the field that the label is targeted to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe text for the axis label.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplyTo": { "MarkdownDocumentation": "`ApplyTo`\n\nThe options that indicate which field the label belongs to.\n*Required*: No\n*Type*: [AxisLabelReferenceOptions](./aws-properties-quicksight-template-axislabelreferenceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-applyto", "UpdateType": "Mutable", "Required": false, "Type": "AxisLabelReferenceOptions" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the axis label.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Template.AxisLabelReferenceOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisLabelReferenceOptions`\n\nThe reference that specifies where the axis label is applied to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabelreferenceoptions.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the axis label is targeted to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabelreferenceoptions.html#cfn-quicksight-template-axislabelreferenceoptions-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field that the axis label is targeted to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabelreferenceoptions.html#cfn-quicksight-template-axislabelreferenceoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.AxisLinearScale": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisLinearScale`\n\nThe liner axis scale setup.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislinearscale.html", "Properties": { "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe step size setup of a linear axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislinearscale.html#cfn-quicksight-template-axislinearscale-stepsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "StepCount": { "MarkdownDocumentation": "`StepCount`\n\nThe step count setup of a linear axis.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislinearscale.html#cfn-quicksight-template-axislinearscale-stepcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.AxisLogarithmicScale": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisLogarithmicScale`\n\nThe logarithmic axis scale setup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislogarithmicscale.html", "Properties": { "Base": { "MarkdownDocumentation": "`Base`\n\nThe base setup of a logarithmic axis scale.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislogarithmicscale.html#cfn-quicksight-template-axislogarithmicscale-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.AxisScale": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisScale`\n\nThe scale setup\noptions for a numeric axis display.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisscale.html", "Properties": { "Logarithmic": { "MarkdownDocumentation": "`Logarithmic`\n\nThe logarithmic axis scale setup.\n*Required*: No\n*Type*: [AxisLogarithmicScale](./aws-properties-quicksight-template-axislogarithmicscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisscale.html#cfn-quicksight-template-axisscale-logarithmic", "UpdateType": "Mutable", "Required": false, "Type": "AxisLogarithmicScale" }, "Linear": { "MarkdownDocumentation": "`Linear`\n\nThe linear axis scale setup.\n*Required*: No\n*Type*: [AxisLinearScale](./aws-properties-quicksight-template-axislinearscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisscale.html#cfn-quicksight-template-axisscale-linear", "UpdateType": "Mutable", "Required": false, "Type": "AxisLinearScale" } } }, "AWS::QuickSight::Template.AxisTickLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.AxisTickLabelOptions`\n\nThe tick label options of an axis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisticklabeloptions.html", "Properties": { "RotationAngle": { "MarkdownDocumentation": "`RotationAngle`\n\nThe rotation angle of the axis tick labels.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisticklabeloptions.html#cfn-quicksight-template-axisticklabeloptions-rotationangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "LabelOptions": { "MarkdownDocumentation": "`LabelOptions`\n\nDetermines whether or not the axis ticks are visible.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisticklabeloptions.html#cfn-quicksight-template-axisticklabeloptions-labeloptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" } } }, "AWS::QuickSight::Template.BarChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BarChartAggregatedFieldWells`\n\nThe aggregated field wells of a bar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category (y-axis) field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html#cfn-quicksight-template-barchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color (group/color) field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html#cfn-quicksight-template-barchartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a bar chart. Values are aggregated by\ncategory.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html#cfn-quicksight-template-barchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a bar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html#cfn-quicksight-template-barchartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.BarChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BarChartConfiguration`\n\nThe configuration of a `BarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `BarChartVisual`.\n*Required*: No\n*Type*: [BarChartSortConfiguration](./aws-properties-quicksight-template-barchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BarChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-template-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a bar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-template-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "Orientation": { "MarkdownDocumentation": "`Orientation`\n\nThe orientation of the bars in a bar chart visual. There are two valid values in this structure:\n* `HORIZONTAL`: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.\n* `VERTICAL`: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.\n*Required*: No\n*Type*: String\n*Allowed values*: `HORIZONTAL | VERTICAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HORIZONTAL", "VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-orientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) for a bar chart value.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "BarsArrangement": { "MarkdownDocumentation": "`BarsArrangement`\n\nDetermines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLUSTERED | STACKED | STACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLUSTERED", "STACKED", "STACKED_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-barsarrangement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe label display options (grid line, range, scale, axis step) for bar chart category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe contribution analysis (anomaly configuration) setup of the visual.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-template-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [BarChartFieldWells](./aws-properties-quicksight-template-barchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BarChartFieldWells" }, "ValueAxis": { "MarkdownDocumentation": "`ValueAxis`\n\nThe label display options (grid line, range, scale, axis step) for a bar chart value.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-valueaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Template.BarChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BarChartFieldWells`\n\nThe field wells of a `BarChartVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartfieldwells.html", "Properties": { "BarChartAggregatedFieldWells": { "MarkdownDocumentation": "`BarChartAggregatedFieldWells`\n\nThe aggregated field wells of a bar chart.\n*Required*: No\n*Type*: [BarChartAggregatedFieldWells](./aws-properties-quicksight-template-barchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartfieldwells.html#cfn-quicksight-template-barchartfieldwells-barchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BarChartAggregatedFieldWells" } } }, "AWS::QuickSight::Template.BarChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BarChartSortConfiguration`\n\nsort-configuration-description\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html", "Properties": { "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe sort configuration of color fields in a bar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe limit on the number of values displayed in a bar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories displayed in a bar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Template.BarChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BarChartVisual`\n\nA bar chart.\nThe `BarChartVisual` structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:\n* Horizontal bar chart\n* Vertical bar chart\n* Horizontal stacked bar chart\n* Vertical stacked bar chart\n* Horizontal stacked 100% bar chart\n* Vertical stacked 100% bar chart\nFor more information, see [Using bar charts](https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [BarChartConfiguration](./aws-properties-quicksight-template-barchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BarChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.BinCountOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BinCountOptions`\n\nThe options that determine the bin count of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bincountoptions.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe options that determine the bin count value.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bincountoptions.html#cfn-quicksight-template-bincountoptions-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.BinWidthOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BinWidthOptions`\n\nThe options that determine the bin width of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-binwidthoptions.html", "Properties": { "BinCountLimit": { "MarkdownDocumentation": "`BinCountLimit`\n\nThe options that determine the bin count limit.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-binwidthoptions.html#cfn-quicksight-template-binwidthoptions-bincountlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe options that determine the bin width value.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-binwidthoptions.html#cfn-quicksight-template-binwidthoptions-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.BodySectionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BodySectionConfiguration`\n\nThe configuration of a body section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html", "Properties": { "Content": { "MarkdownDocumentation": "`Content`\n\nThe configuration of content in a body section.\n*Required*: Yes\n*Type*: [BodySectionContent](./aws-properties-quicksight-template-bodysectioncontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-content", "UpdateType": "Mutable", "Required": true, "Type": "BodySectionContent" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style options of a body section.\n*Required*: No\n*Type*: [SectionStyle](./aws-properties-quicksight-template-sectionstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-style", "UpdateType": "Mutable", "Required": false, "Type": "SectionStyle" }, "PageBreakConfiguration": { "MarkdownDocumentation": "`PageBreakConfiguration`\n\nThe configuration of a page break for a section.\n*Required*: No\n*Type*: [SectionPageBreakConfiguration](./aws-properties-quicksight-template-sectionpagebreakconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-pagebreakconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SectionPageBreakConfiguration" }, "SectionId": { "MarkdownDocumentation": "`SectionId`\n\nThe unique identifier of a body section.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-sectionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RepeatConfiguration": { "MarkdownDocumentation": "`RepeatConfiguration`\n\nDescribes the configurations that are required to declare a section as repeating.\n*Required*: No\n*Type*: [BodySectionRepeatConfiguration](./aws-properties-quicksight-template-bodysectionrepeatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-repeatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionRepeatConfiguration" } } }, "AWS::QuickSight::Template.BodySectionContent": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BodySectionContent`\n\nThe configuration of content in a body section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectioncontent.html", "Properties": { "Layout": { "MarkdownDocumentation": "`Layout`\n\nThe layout configuration of a body section.\n*Required*: No\n*Type*: [SectionLayoutConfiguration](./aws-properties-quicksight-template-sectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectioncontent.html#cfn-quicksight-template-bodysectioncontent-layout", "UpdateType": "Mutable", "Required": false, "Type": "SectionLayoutConfiguration" } } }, "AWS::QuickSight::Template.BodySectionDynamicCategoryDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BodySectionDynamicCategoryDimensionConfiguration`\n\nDescribes the **Category** dataset column and constraints for the dynamic values used to repeat the contents of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamiccategorydimensionconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "SortByMetrics": { "MarkdownDocumentation": "`SortByMetrics`\n\nSort criteria on the column values that you use for repetition.\n*Required*: No\n*Type*: Array of [ColumnSort](./aws-properties-quicksight-template-columnsort.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamiccategorydimensionconfiguration-sortbymetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSort", "DuplicatesAllowed": true }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nNumber of values to use from the column for repetition.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamiccategorydimensionconfiguration-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.BodySectionDynamicNumericDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BodySectionDynamicNumericDimensionConfiguration`\n\nDescribes the **Numeric** dataset column and constraints for the dynamic values used to repeat the contents of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamicnumericdimensionconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "SortByMetrics": { "MarkdownDocumentation": "`SortByMetrics`\n\nSort criteria on the column values that you use for repetition.\n*Required*: No\n*Type*: Array of [ColumnSort](./aws-properties-quicksight-template-columnsort.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamicnumericdimensionconfiguration-sortbymetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSort", "DuplicatesAllowed": true }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nNumber of values to use from the column for repetition.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamicnumericdimensionconfiguration-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.BodySectionRepeatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BodySectionRepeatConfiguration`\n\nDescribes the configurations that are required to declare a section as repeating.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatconfiguration.html", "Properties": { "DimensionConfigurations": { "MarkdownDocumentation": "`DimensionConfigurations`\n\nList of `BodySectionRepeatDimensionConfiguration` values that describe the dataset column and constraints for the column used to repeat the contents of a section.\n*Required*: No\n*Type*: Array of [BodySectionRepeatDimensionConfiguration](./aws-properties-quicksight-template-bodysectionrepeatdimensionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatconfiguration.html#cfn-quicksight-template-bodysectionrepeatconfiguration-dimensionconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BodySectionRepeatDimensionConfiguration", "DuplicatesAllowed": true }, "NonRepeatingVisuals": { "MarkdownDocumentation": "`NonRepeatingVisuals`\n\nList of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatconfiguration.html#cfn-quicksight-template-bodysectionrepeatconfiguration-nonrepeatingvisuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PageBreakConfiguration": { "MarkdownDocumentation": "`PageBreakConfiguration`\n\nPage break configuration to apply for each repeating instance.\n*Required*: No\n*Type*: [BodySectionRepeatPageBreakConfiguration](./aws-properties-quicksight-template-bodysectionrepeatpagebreakconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatconfiguration.html#cfn-quicksight-template-bodysectionrepeatconfiguration-pagebreakconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionRepeatPageBreakConfiguration" } } }, "AWS::QuickSight::Template.BodySectionRepeatDimensionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BodySectionRepeatDimensionConfiguration`\n\nDescribes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either **Category** or **Numeric** column configuration\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatdimensionconfiguration.html", "Properties": { "DynamicNumericDimensionConfiguration": { "MarkdownDocumentation": "`DynamicNumericDimensionConfiguration`\n\nDescribes the **Numeric** dataset column and constraints around the dynamic values used to repeat the contents of a section.\n*Required*: No\n*Type*: [BodySectionDynamicNumericDimensionConfiguration](./aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatdimensionconfiguration.html#cfn-quicksight-template-bodysectionrepeatdimensionconfiguration-dynamicnumericdimensionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionDynamicNumericDimensionConfiguration" }, "DynamicCategoryDimensionConfiguration": { "MarkdownDocumentation": "`DynamicCategoryDimensionConfiguration`\n\nDescribes the **Category** dataset column and constraints around the dynamic values that will be used in repeating the section contents.\n*Required*: No\n*Type*: [BodySectionDynamicCategoryDimensionConfiguration](./aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatdimensionconfiguration.html#cfn-quicksight-template-bodysectionrepeatdimensionconfiguration-dynamiccategorydimensionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BodySectionDynamicCategoryDimensionConfiguration" } } }, "AWS::QuickSight::Template.BodySectionRepeatPageBreakConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BodySectionRepeatPageBreakConfiguration`\n\nThe page break configuration to apply for each repeating instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatpagebreakconfiguration.html", "Properties": { "After": { "MarkdownDocumentation": "`After`\n\nProperty description not available.\n*Required*: No\n*Type*: [SectionAfterPageBreak](./aws-properties-quicksight-template-sectionafterpagebreak.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatpagebreakconfiguration.html#cfn-quicksight-template-bodysectionrepeatpagebreakconfiguration-after", "UpdateType": "Mutable", "Required": false, "Type": "SectionAfterPageBreak" } } }, "AWS::QuickSight::Template.BoxPlotAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BoxPlotAggregatedFieldWells`\n\nThe aggregated field well for a box plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well of a box plot chart. Values are grouped based on group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotaggregatedfieldwells.html#cfn-quicksight-template-boxplotaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field well of a box plot chart. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotaggregatedfieldwells.html#cfn-quicksight-template-boxplotaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.BoxPlotChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BoxPlotChartConfiguration`\n\nThe configuration of a `BoxPlotVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `BoxPlotVisual`.\n*Required*: No\n*Type*: [BoxPlotSortConfiguration](./aws-properties-quicksight-template-boxplotsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nProperty description not available.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-template-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe label display options (grid line, range, scale, axis step) of a box plot category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe label options (label text, label visibility and sort icon visibility) of a box plot value.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility and sort Icon visibility) of a box plot category.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [BoxPlotFieldWells](./aws-properties-quicksight-template-boxplotfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "BoxPlotOptions": { "MarkdownDocumentation": "`BoxPlotOptions`\n\nThe box plot chart options for a box plot visual\n*Required*: No\n*Type*: [BoxPlotOptions](./aws-properties-quicksight-template-boxplotoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-boxplotoptions", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, axis step) of a box plot category.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Template.BoxPlotFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BoxPlotFieldWells`\n\nThe field wells of a `BoxPlotVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotfieldwells.html", "Properties": { "BoxPlotAggregatedFieldWells": { "MarkdownDocumentation": "`BoxPlotAggregatedFieldWells`\n\nThe aggregated field wells of a box plot.\n*Required*: No\n*Type*: [BoxPlotAggregatedFieldWells](./aws-properties-quicksight-template-boxplotaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotfieldwells.html#cfn-quicksight-template-boxplotfieldwells-boxplotaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotAggregatedFieldWells" } } }, "AWS::QuickSight::Template.BoxPlotOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BoxPlotOptions`\n\nThe options of a box plot visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotoptions.html", "Properties": { "StyleOptions": { "MarkdownDocumentation": "`StyleOptions`\n\nThe style options of the box plot.\n*Required*: No\n*Type*: [BoxPlotStyleOptions](./aws-properties-quicksight-template-boxplotstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotoptions.html#cfn-quicksight-template-boxplotoptions-styleoptions", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotStyleOptions" }, "OutlierVisibility": { "MarkdownDocumentation": "`OutlierVisibility`\n\nDetermines the visibility of the outlier in a box plot.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotoptions.html#cfn-quicksight-template-boxplotoptions-outliervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "AllDataPointsVisibility": { "MarkdownDocumentation": "`AllDataPointsVisibility`\n\nDetermines the visibility of all data points of the box plot.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotoptions.html#cfn-quicksight-template-boxplotoptions-alldatapointsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.BoxPlotSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BoxPlotSortConfiguration`\n\nThe sort configuration of a `BoxPlotVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotsortconfiguration.html", "Properties": { "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of a group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotsortconfiguration.html#cfn-quicksight-template-boxplotsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "PaginationConfiguration": { "MarkdownDocumentation": "`PaginationConfiguration`\n\nThe pagination configuration of a table visual or box plot.\n*Required*: No\n*Type*: [PaginationConfiguration](./aws-properties-quicksight-template-paginationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotsortconfiguration.html#cfn-quicksight-template-boxplotsortconfiguration-paginationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PaginationConfiguration" } } }, "AWS::QuickSight::Template.BoxPlotStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BoxPlotStyleOptions`\n\nThe style options of the box plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotstyleoptions.html", "Properties": { "FillStyle": { "MarkdownDocumentation": "`FillStyle`\n\nThe fill styles (solid, transparent) of the box plot.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | TRANSPARENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "TRANSPARENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotstyleoptions.html#cfn-quicksight-template-boxplotstyleoptions-fillstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.BoxPlotVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.BoxPlotVisual`\n\nA box plot.\nFor more information, see [Using box plots](https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [BoxPlotChartConfiguration](./aws-properties-quicksight-template-boxplotchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.CalculatedField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CalculatedField`\n\nThe calculated field of an analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedfield.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the calculated field.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedfield.html#cfn-quicksight-template-calculatedfield-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in this calculated field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedfield.html#cfn-quicksight-template-calculatedfield-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the calculated field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedfield.html#cfn-quicksight-template-calculatedfield-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CalculatedMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CalculatedMeasureField`\n\nThe table calculation measure field for pivot tables.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedmeasurefield.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression in the table calculation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedmeasurefield.html#cfn-quicksight-template-calculatedmeasurefield-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedmeasurefield.html#cfn-quicksight-template-calculatedmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CascadingControlConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolconfiguration.html", "Properties": { "SourceControls": { "MarkdownDocumentation": "`SourceControls`\n\nA list of source controls that determine the values that are used in the current control.\n*Required*: No\n*Type*: Array of [CascadingControlSource](./aws-properties-quicksight-template-cascadingcontrolsource.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolconfiguration.html#cfn-quicksight-template-cascadingcontrolconfiguration-sourcecontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CascadingControlSource", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.CascadingControlSource": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CascadingControlSource`\n\nThe source controls that are used in a `CascadingControlConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolsource.html", "Properties": { "SourceSheetControlId": { "MarkdownDocumentation": "`SourceSheetControlId`\n\nThe source sheet control ID of a `CascadingControlSource`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolsource.html#cfn-quicksight-template-cascadingcontrolsource-sourcesheetcontrolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnToMatch": { "MarkdownDocumentation": "`ColumnToMatch`\n\nThe column identifier that determines which column to look up for the source sheet control.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolsource.html#cfn-quicksight-template-cascadingcontrolsource-columntomatch", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Template.CategoricalDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CategoricalDimensionField`\n\nThe dimension type field with categorical type columns..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-template-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `CategoricalDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CategoricalMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CategoricalMeasureField`\n\nThe measure type field with categorical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [String](./aws-properties-quicksight-template-aggregationfunction.html)\n*Allowed values*: `COUNT | DISTINCT_COUNT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-template-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `CategoricalMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CategoryDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CategoryDrillDownFilter`\n\nThe category drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categorydrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categorydrilldownfilter.html#cfn-quicksight-template-categorydrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nA list of the string inputs that are the values of the category drill down filter.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categorydrilldownfilter.html#cfn-quicksight-template-categorydrilldownfilter-categoryvalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.CategoryFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CategoryFilter`\n\nA `CategoryFilter` filters text values.\nFor more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration for a `CategoryFilter`.\n*Required*: Yes\n*Type*: [CategoryFilterConfiguration](./aws-properties-quicksight-template-categoryfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.html#cfn-quicksight-template-categoryfilter-configuration", "UpdateType": "Mutable", "Required": true, "Type": "CategoryFilterConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.html#cfn-quicksight-template-categoryfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.html#cfn-quicksight-template-categoryfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.html#cfn-quicksight-template-categoryfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CategoryFilterConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CategoryFilterConfiguration`\n\nThe configuration for a `CategoryFilter`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html", "Properties": { "CustomFilterListConfiguration": { "MarkdownDocumentation": "`CustomFilterListConfiguration`\n\nA list of custom filter values. In the Quick Sight console, this filter type is called a custom filter list.\n*Required*: No\n*Type*: [CustomFilterListConfiguration](./aws-properties-quicksight-template-customfilterlistconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-customfilterlistconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomFilterListConfiguration" }, "CustomFilterConfiguration": { "MarkdownDocumentation": "`CustomFilterConfiguration`\n\nA custom filter that filters based on a single value. This filter can be partially matched.\n*Required*: No\n*Type*: [CustomFilterConfiguration](./aws-properties-quicksight-template-customfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-customfilterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomFilterConfiguration" }, "FilterListConfiguration": { "MarkdownDocumentation": "`FilterListConfiguration`\n\nA list of filter configurations. In the Quick Sight console, this filter type is called a filter list.\n*Required*: No\n*Type*: [FilterListConfiguration](./aws-properties-quicksight-template-filterlistconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-filterlistconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilterListConfiguration" } } }, "AWS::QuickSight::Template.CategoryInnerFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CategoryInnerFilter`\n\nA `CategoryInnerFilter` filters text values for the `NestedFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryinnerfilter.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [CategoryFilterConfiguration](./aws-properties-quicksight-template-categoryfilterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryinnerfilter.html#cfn-quicksight-template-categoryinnerfilter-configuration", "UpdateType": "Mutable", "Required": true, "Type": "CategoryFilterConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryinnerfilter.html#cfn-quicksight-template-categoryinnerfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryinnerfilter.html#cfn-quicksight-template-categoryinnerfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" } } }, "AWS::QuickSight::Template.ChartAxisLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ChartAxisLabelOptions`\n\nThe label options for an axis on a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-chartaxislabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of an axis label on a chart. Choose one of the following options:\n* `VISIBLE`: Shows the axis.\n* `HIDDEN`: Hides the axis.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-chartaxislabeloptions.html#cfn-quicksight-template-chartaxislabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "SortIconVisibility": { "MarkdownDocumentation": "`SortIconVisibility`\n\nThe visibility configuration of the sort icon on a chart's axis label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-chartaxislabeloptions.html#cfn-quicksight-template-chartaxislabeloptions-sorticonvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "AxisLabelOptions": { "MarkdownDocumentation": "`AxisLabelOptions`\n\nThe label options for a chart axis.\n*Required*: No\n*Type*: [Array](./aws-properties-quicksight-template-axislabeloptions.html) of [AxisLabelOptions](./aws-properties-quicksight-template-axislabeloptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-chartaxislabeloptions.html#cfn-quicksight-template-chartaxislabeloptions-axislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AxisLabelOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ClusterMarker": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ClusterMarker`\n\nThe cluster marker that is a part of the cluster marker\nconfiguration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-clustermarker.html", "Properties": { "SimpleClusterMarker": { "MarkdownDocumentation": "`SimpleClusterMarker`\n\nThe simple cluster marker of the cluster marker.\n*Required*: No\n*Type*: [SimpleClusterMarker](./aws-properties-quicksight-template-simpleclustermarker.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-clustermarker.html#cfn-quicksight-template-clustermarker-simpleclustermarker", "UpdateType": "Mutable", "Required": false, "Type": "SimpleClusterMarker" } } }, "AWS::QuickSight::Template.ClusterMarkerConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ClusterMarkerConfiguration`\n\nThe cluster marker configuration of the geospatial map selected point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-clustermarkerconfiguration.html", "Properties": { "ClusterMarker": { "MarkdownDocumentation": "`ClusterMarker`\n\nThe cluster marker that is a part of the cluster marker configuration.\n*Required*: No\n*Type*: [ClusterMarker](./aws-properties-quicksight-template-clustermarker.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-clustermarkerconfiguration.html#cfn-quicksight-template-clustermarkerconfiguration-clustermarker", "UpdateType": "Mutable", "Required": false, "Type": "ClusterMarker" } } }, "AWS::QuickSight::Template.ColorScale": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColorScale`\n\nDetermines the color scale that is applied to the visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorscale.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nDetermines the list of colors that are applied to the visual.\n*Required*: Yes\n*Type*: Array of [DataColor](./aws-properties-quicksight-template-datacolor.html)\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorscale.html#cfn-quicksight-template-colorscale-colors", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataColor", "DuplicatesAllowed": true }, "ColorFillType": { "MarkdownDocumentation": "`ColorFillType`\n\nDetermines the color fill type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DISCRETE | GRADIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISCRETE", "GRADIENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorscale.html#cfn-quicksight-template-colorscale-colorfilltype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NullValueColor": { "MarkdownDocumentation": "`NullValueColor`\n\nDetermines the color that is applied to null values.\n*Required*: No\n*Type*: [DataColor](./aws-properties-quicksight-template-datacolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorscale.html#cfn-quicksight-template-colorscale-nullvaluecolor", "UpdateType": "Mutable", "Required": false, "Type": "DataColor" } } }, "AWS::QuickSight::Template.ColorsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColorsConfiguration`\n\nThe color configurations for a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorsconfiguration.html", "Properties": { "CustomColors": { "MarkdownDocumentation": "`CustomColors`\n\nA list of up to 50 custom colors.\n*Required*: No\n*Type*: Array of [CustomColor](./aws-properties-quicksight-template-customcolor.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorsconfiguration.html#cfn-quicksight-template-colorsconfiguration-customcolors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ColumnConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColumnConfiguration`\n\nThe general configuration of a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe role of the column.\n*Required*: No\n*Type*: String\n*Allowed values*: `DIMENSION | MEASURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIMENSION", "MEASURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of a column.\n*Required*: No\n*Type*: [FormatConfiguration](./aws-properties-quicksight-template-formatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "ColorsConfiguration": { "MarkdownDocumentation": "`ColorsConfiguration`\n\nThe color configurations of the column.\n*Required*: No\n*Type*: [ColorsConfiguration](./aws-properties-quicksight-template-colorsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-colorsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ColorsConfiguration" } } }, "AWS::QuickSight::Template.ColumnGroupColumnSchema": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColumnGroupColumnSchema`\n\nA structure describing the name, data type, and geographic role of the columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.html#cfn-quicksight-template-columngroupcolumnschema-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ColumnGroupSchema": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColumnGroupSchema`\n\nThe column group schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html", "Properties": { "ColumnGroupColumnSchemaList": { "MarkdownDocumentation": "`ColumnGroupColumnSchemaList`\n\nA structure containing the list of schemas for column group columns.\n*Required*: No\n*Type*: Array of [ColumnGroupColumnSchema](./aws-properties-quicksight-template-columngroupcolumnschema.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html#cfn-quicksight-template-columngroupschema-columngroupcolumnschemalist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnGroupColumnSchema", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html#cfn-quicksight-template-columngroupschema-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ColumnHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColumnHierarchy`\n\nThe option that determines the hierarchy of the fields for a visual element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html", "Properties": { "DateTimeHierarchy": { "MarkdownDocumentation": "`DateTimeHierarchy`\n\nThe option that determines the hierarchy of any `DateTime` fields.\n*Required*: No\n*Type*: [DateTimeHierarchy](./aws-properties-quicksight-template-datetimehierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html#cfn-quicksight-template-columnhierarchy-datetimehierarchy", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeHierarchy" }, "ExplicitHierarchy": { "MarkdownDocumentation": "`ExplicitHierarchy`\n\nThe option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.\n*Required*: No\n*Type*: [ExplicitHierarchy](./aws-properties-quicksight-template-explicithierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html#cfn-quicksight-template-columnhierarchy-explicithierarchy", "UpdateType": "Mutable", "Required": false, "Type": "ExplicitHierarchy" }, "PredefinedHierarchy": { "MarkdownDocumentation": "`PredefinedHierarchy`\n\nThe option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.\n*Required*: No\n*Type*: [PredefinedHierarchy](./aws-properties-quicksight-template-predefinedhierarchy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html#cfn-quicksight-template-columnhierarchy-predefinedhierarchy", "UpdateType": "Mutable", "Required": false, "Type": "PredefinedHierarchy" } } }, "AWS::QuickSight::Template.ColumnIdentifier": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColumnIdentifier`\n\nA column of a data set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnidentifier.html", "Properties": { "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnidentifier.html#cfn-quicksight-template-columnidentifier-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that the column belongs to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnidentifier.html#cfn-quicksight-template-columnidentifier-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ColumnSchema": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColumnSchema`\n\nThe column schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html", "Properties": { "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-datatype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GeographicRole": { "MarkdownDocumentation": "`GeographicRole`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-geographicrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ColumnSort": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColumnSort`\n\nThe sort configuration for a column that is not used in a field well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnsort.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function that is defined in the column sort.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-template-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnsort.html#cfn-quicksight-template-columnsort-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "SortBy": { "MarkdownDocumentation": "`SortBy`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnsort.html#cfn-quicksight-template-columnsort-sortby", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe sort direction.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnsort.html#cfn-quicksight-template-columnsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ColumnTooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ColumnTooltipItem`\n\nThe tooltip item for the columns that are not part of a field well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nThe aggregation function of the column tooltip item.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-template-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-aggregation", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "TooltipTarget": { "MarkdownDocumentation": "`TooltipTarget`\n\nDetermines the target of the column tooltip item in a combo chart visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `BOTH | BAR | LINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BOTH", "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-tooltiptarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe target column of the tooltip item.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label of the tooltip item.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip item.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.ComboChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ComboChartAggregatedFieldWells`\n\nThe aggregated field wells of a combo chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html", "Properties": { "BarValues": { "MarkdownDocumentation": "`BarValues`\n\nThe aggregated `BarValues` field well of a combo chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html#cfn-quicksight-template-combochartaggregatedfieldwells-barvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe aggregated category field wells of a combo chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html#cfn-quicksight-template-combochartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe aggregated colors field well of a combo chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html#cfn-quicksight-template-combochartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "LineValues": { "MarkdownDocumentation": "`LineValues`\n\nThe aggregated `LineValues` field well of a combo chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html#cfn-quicksight-template-combochartaggregatedfieldwells-linevalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ComboChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ComboChartConfiguration`\n\nThe configuration of a `ComboChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `ComboChartVisual`.\n*Required*: No\n*Type*: [ComboChartSortConfiguration](./aws-properties-quicksight-template-combochartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference line setup of the visual.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-template-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "BarDataLabels": { "MarkdownDocumentation": "`BarDataLabels`\n\nThe options that determine if visual data labels are displayed.\nThe data label options for a bar in a combo chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-bardatalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SingleAxisOptions": { "MarkdownDocumentation": "`SingleAxisOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [SingleAxisOptions](./aws-properties-quicksight-template-singleaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-singleaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "SingleAxisOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "BarsArrangement": { "MarkdownDocumentation": "`BarsArrangement`\n\nDetermines the bar arrangement in a combo chart. The following are valid values in this structure:\n* `CLUSTERED`: For clustered bar combo charts.\n* `STACKED`: For stacked bar combo charts.\n* `STACKED_PERCENT`: Do not use. If you use this value, the operation returns a validation error.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLUSTERED | STACKED | STACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLUSTERED", "STACKED", "STACKED_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-barsarrangement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecondaryYAxisLabelOptions": { "MarkdownDocumentation": "`SecondaryYAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-secondaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "LineDataLabels": { "MarkdownDocumentation": "`LineDataLabels`\n\nThe options that determine if visual data labels are displayed.\nThe data label options for a line in a combo chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-linedatalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe category axis of a combo chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [ComboChartFieldWells](./aws-properties-quicksight-template-combochartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartFieldWells" }, "SecondaryYAxisDisplayOptions": { "MarkdownDocumentation": "`SecondaryYAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-secondaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Template.ComboChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ComboChartFieldWells`\n\nThe field wells of the visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartfieldwells.html", "Properties": { "ComboChartAggregatedFieldWells": { "MarkdownDocumentation": "`ComboChartAggregatedFieldWells`\n\nThe aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.\n*Required*: No\n*Type*: [ComboChartAggregatedFieldWells](./aws-properties-quicksight-template-combochartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartfieldwells.html#cfn-quicksight-template-combochartfieldwells-combochartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartAggregatedFieldWells" } } }, "AWS::QuickSight::Template.ComboChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ComboChartSortConfiguration`\n\nThe sort configuration of a `ComboChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html", "Properties": { "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe sort configuration of the color field well in a combo chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html#cfn-quicksight-template-combochartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe item limit configuration of the color field well in a combo chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html#cfn-quicksight-template-combochartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe item limit configuration for the category field well of a combo chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html#cfn-quicksight-template-combochartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category field well in a combo chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html#cfn-quicksight-template-combochartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ComboChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ComboChartVisual`\n\nA combo chart.\nThe `ComboChartVisual` includes stacked bar combo charts and clustered bar combo charts\nFor more information, see [Using combo charts](https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [ComboChartConfiguration](./aws-properties-quicksight-template-combochartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ComparisonConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ComparisonConfiguration`\n\nThe comparison display configuration of a KPI or gauge chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonconfiguration.html", "Properties": { "ComparisonMethod": { "MarkdownDocumentation": "`ComparisonMethod`\n\nThe method of the comparison. Choose from the following options:\n* `DIFFERENCE`\n* `PERCENT_DIFFERENCE`\n* `PERCENT`\n*Required*: No\n*Type*: String\n*Allowed values*: `DIFFERENCE | PERCENT_DIFFER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIFFERENCE", "PERCENT_DIFFERENCE", "PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonconfiguration.html#cfn-quicksight-template-comparisonconfiguration-comparisonmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComparisonFormat": { "MarkdownDocumentation": "`ComparisonFormat`\n\nThe format of the comparison.\n*Required*: No\n*Type*: [ComparisonFormatConfiguration](./aws-properties-quicksight-template-comparisonformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonconfiguration.html#cfn-quicksight-template-comparisonconfiguration-comparisonformat", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonFormatConfiguration" } } }, "AWS::QuickSight::Template.ComparisonFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ComparisonFormatConfiguration`\n\nThe format of the comparison.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonformatconfiguration.html", "Properties": { "NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`NumberDisplayFormatConfiguration`\n\nThe number display format.\n*Required*: No\n*Type*: [NumberDisplayFormatConfiguration](./aws-properties-quicksight-template-numberdisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonformatconfiguration.html#cfn-quicksight-template-comparisonformatconfiguration-numberdisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberDisplayFormatConfiguration" }, "PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`PercentageDisplayFormatConfiguration`\n\nThe percentage display format.\n*Required*: No\n*Type*: [PercentageDisplayFormatConfiguration](./aws-properties-quicksight-template-percentagedisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonformatconfiguration.html#cfn-quicksight-template-comparisonformatconfiguration-percentagedisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PercentageDisplayFormatConfiguration" } } }, "AWS::QuickSight::Template.Computation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.Computation`\n\nThe computation union that is used in an insight visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html", "Properties": { "PeriodToDate": { "MarkdownDocumentation": "`PeriodToDate`\n\nThe period to `DataSetIdentifier` computation configuration.\n*Required*: No\n*Type*: [PeriodToDateComputation](./aws-properties-quicksight-template-periodtodatecomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-periodtodate", "UpdateType": "Mutable", "Required": false, "Type": "PeriodToDateComputation" }, "GrowthRate": { "MarkdownDocumentation": "`GrowthRate`\n\nThe growth rate computation configuration.\n*Required*: No\n*Type*: [GrowthRateComputation](./aws-properties-quicksight-template-growthratecomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-growthrate", "UpdateType": "Mutable", "Required": false, "Type": "GrowthRateComputation" }, "TopBottomRanked": { "MarkdownDocumentation": "`TopBottomRanked`\n\nThe top ranked and bottom ranked computation configuration.\n*Required*: No\n*Type*: [TopBottomRankedComputation](./aws-properties-quicksight-template-topbottomrankedcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-topbottomranked", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomRankedComputation" }, "TotalAggregation": { "MarkdownDocumentation": "`TotalAggregation`\n\nThe total aggregation computation configuration.\n*Required*: No\n*Type*: [TotalAggregationComputation](./aws-properties-quicksight-template-totalaggregationcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-totalaggregation", "UpdateType": "Mutable", "Required": false, "Type": "TotalAggregationComputation" }, "Forecast": { "MarkdownDocumentation": "`Forecast`\n\nThe forecast computation configuration.\n*Required*: No\n*Type*: [ForecastComputation](./aws-properties-quicksight-template-forecastcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-forecast", "UpdateType": "Mutable", "Required": false, "Type": "ForecastComputation" }, "MaximumMinimum": { "MarkdownDocumentation": "`MaximumMinimum`\n\nThe maximum and minimum computation configuration.\n*Required*: No\n*Type*: [MaximumMinimumComputation](./aws-properties-quicksight-template-maximumminimumcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-maximumminimum", "UpdateType": "Mutable", "Required": false, "Type": "MaximumMinimumComputation" }, "PeriodOverPeriod": { "MarkdownDocumentation": "`PeriodOverPeriod`\n\nThe period over period computation configuration.\n*Required*: No\n*Type*: [PeriodOverPeriodComputation](./aws-properties-quicksight-template-periodoverperiodcomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-periodoverperiod", "UpdateType": "Mutable", "Required": false, "Type": "PeriodOverPeriodComputation" }, "MetricComparison": { "MarkdownDocumentation": "`MetricComparison`\n\nThe metric comparison computation configuration.\n*Required*: No\n*Type*: [MetricComparisonComputation](./aws-properties-quicksight-template-metriccomparisoncomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-metriccomparison", "UpdateType": "Mutable", "Required": false, "Type": "MetricComparisonComputation" }, "TopBottomMovers": { "MarkdownDocumentation": "`TopBottomMovers`\n\nThe top movers and bottom movers computation configuration.\n*Required*: No\n*Type*: [TopBottomMoversComputation](./aws-properties-quicksight-template-topbottommoverscomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-topbottommovers", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomMoversComputation" }, "UniqueValues": { "MarkdownDocumentation": "`UniqueValues`\n\nThe unique values computation configuration.\n*Required*: No\n*Type*: [UniqueValuesComputation](./aws-properties-quicksight-template-uniquevaluescomputation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-uniquevalues", "UpdateType": "Mutable", "Required": false, "Type": "UniqueValuesComputation" } } }, "AWS::QuickSight::Template.ConditionalFormattingColor": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ConditionalFormattingColor`\n\nThe formatting configuration for the color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcolor.html", "Properties": { "Gradient": { "MarkdownDocumentation": "`Gradient`\n\nFormatting configuration for gradient color.\n*Required*: No\n*Type*: [ConditionalFormattingGradientColor](./aws-properties-quicksight-template-conditionalformattinggradientcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcolor.html#cfn-quicksight-template-conditionalformattingcolor-gradient", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingGradientColor" }, "Solid": { "MarkdownDocumentation": "`Solid`\n\nFormatting configuration for solid color.\n*Required*: No\n*Type*: [ConditionalFormattingSolidColor](./aws-properties-quicksight-template-conditionalformattingsolidcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcolor.html#cfn-quicksight-template-conditionalformattingcolor-solid", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingSolidColor" } } }, "AWS::QuickSight::Template.ConditionalFormattingCustomIconCondition": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ConditionalFormattingCustomIconCondition`\n\nDetermines the custom condition for an icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the condition of the icon set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html#cfn-quicksight-template-conditionalformattingcustomiconcondition-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color of the icon.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html#cfn-quicksight-template-conditionalformattingcustomiconcondition-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayConfiguration": { "MarkdownDocumentation": "`DisplayConfiguration`\n\nDetermines the icon display configuration.\n*Required*: No\n*Type*: [ConditionalFormattingIconDisplayConfiguration](./aws-properties-quicksight-template-conditionalformattingicondisplayconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html#cfn-quicksight-template-conditionalformattingcustomiconcondition-displayconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIconDisplayConfiguration" }, "IconOptions": { "MarkdownDocumentation": "`IconOptions`\n\nCustom icon options for an icon set.\n*Required*: Yes\n*Type*: [ConditionalFormattingCustomIconOptions](./aws-properties-quicksight-template-conditionalformattingcustomiconoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html#cfn-quicksight-template-conditionalformattingcustomiconcondition-iconoptions", "UpdateType": "Mutable", "Required": true, "Type": "ConditionalFormattingCustomIconOptions" } } }, "AWS::QuickSight::Template.ConditionalFormattingCustomIconOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ConditionalFormattingCustomIconOptions`\n\nCustom icon options for an icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconoptions.html", "Properties": { "UnicodeIcon": { "MarkdownDocumentation": "`UnicodeIcon`\n\nDetermines the Unicode icon type.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\u0000-\\u00FF]$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconoptions.html#cfn-quicksight-template-conditionalformattingcustomiconoptions-unicodeicon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nDetermines the type of icon.\n*Required*: No\n*Type*: String\n*Allowed values*: `CARET_UP | CARET_DOWN | PLU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CARET_UP", "CARET_DOWN", "PLUS", "MINUS", "ARROW_UP", "ARROW_DOWN", "ARROW_LEFT", "ARROW_UP_LEFT", "ARROW_DOWN_LEFT", "ARROW_RIGHT", "ARROW_UP_RIGHT", "ARROW_DOWN_RIGHT", "FACE_UP", "FACE_DOWN", "FACE_FLAT", "ONE_BAR", "TWO_BAR", "THREE_BAR", "CIRCLE", "TRIANGLE", "SQUARE", "FLAG", "THUMBS_UP", "THUMBS_DOWN", "CHECKMARK", "X" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconoptions.html#cfn-quicksight-template-conditionalformattingcustomiconoptions-icon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ConditionalFormattingGradientColor": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ConditionalFormattingGradientColor`\n\nFormatting configuration for gradient color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattinggradientcolor.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for gradient color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattinggradientcolor.html#cfn-quicksight-template-conditionalformattinggradientcolor-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\n*Required*: Yes\n*Type*: [GradientColor](./aws-properties-quicksight-template-gradientcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattinggradientcolor.html#cfn-quicksight-template-conditionalformattinggradientcolor-color", "UpdateType": "Mutable", "Required": true, "Type": "GradientColor" } } }, "AWS::QuickSight::Template.ConditionalFormattingIcon": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ConditionalFormattingIcon`\n\nThe formatting configuration for the icon.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicon.html", "Properties": { "CustomCondition": { "MarkdownDocumentation": "`CustomCondition`\n\nDetermines the custom condition for an icon set.\n*Required*: No\n*Type*: [ConditionalFormattingCustomIconCondition](./aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicon.html#cfn-quicksight-template-conditionalformattingicon-customcondition", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingCustomIconCondition" }, "IconSet": { "MarkdownDocumentation": "`IconSet`\n\nFormatting configuration for icon set.\n*Required*: No\n*Type*: [ConditionalFormattingIconSet](./aws-properties-quicksight-template-conditionalformattingiconset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicon.html#cfn-quicksight-template-conditionalformattingicon-iconset", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIconSet" } } }, "AWS::QuickSight::Template.ConditionalFormattingIconDisplayConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ConditionalFormattingIconDisplayConfiguration`\n\nDetermines the icon display configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicondisplayconfiguration.html", "Properties": { "IconDisplayOption": { "MarkdownDocumentation": "`IconDisplayOption`\n\nDetermines the icon display configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `ICON_ONLY`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ICON_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicondisplayconfiguration.html#cfn-quicksight-template-conditionalformattingicondisplayconfiguration-icondisplayoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ConditionalFormattingIconSet": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ConditionalFormattingIconSet`\n\nFormatting configuration for icon set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingiconset.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for the icon set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingiconset.html#cfn-quicksight-template-conditionalformattingiconset-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IconSetType": { "MarkdownDocumentation": "`IconSetType`\n\nDetermines the icon set type.\n*Required*: No\n*Type*: String\n*Allowed values*: `PLUS_MINUS | CHECK_X | THRE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PLUS_MINUS", "CHECK_X", "THREE_COLOR_ARROW", "THREE_GRAY_ARROW", "CARET_UP_MINUS_DOWN", "THREE_SHAPE", "THREE_CIRCLE", "FLAGS", "BARS", "FOUR_COLOR_ARROW", "FOUR_GRAY_ARROW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingiconset.html#cfn-quicksight-template-conditionalformattingiconset-iconsettype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ConditionalFormattingSolidColor": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ConditionalFormattingSolidColor`\n\nFormatting configuration for solid color.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingsolidcolor.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression that determines the formatting configuration for solid color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingsolidcolor.html#cfn-quicksight-template-conditionalformattingsolidcolor-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingsolidcolor.html#cfn-quicksight-template-conditionalformattingsolidcolor-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ContextMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ContextMenuOption`\n\nThe context menu options for a visual's interactions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contextmenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availability status of the context menu options. If the value of this property is set to `ENABLED`, dashboard readers can interact with the context menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contextmenuoption.html#cfn-quicksight-template-contextmenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ContributionAnalysisDefault": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ContributionAnalysisDefault`\n\nThe contribution analysis visual display for a line, pie, or bar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contributionanalysisdefault.html", "Properties": { "MeasureFieldId": { "MarkdownDocumentation": "`MeasureFieldId`\n\nThe measure field that is used in the contribution analysis.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contributionanalysisdefault.html#cfn-quicksight-template-contributionanalysisdefault-measurefieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContributorDimensions": { "MarkdownDocumentation": "`ContributorDimensions`\n\nThe dimensions columns that are used in the contribution analysis,\nusually a list of `ColumnIdentifiers`.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contributionanalysisdefault.html#cfn-quicksight-template-contributionanalysisdefault-contributordimensions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.CurrencyDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CurrencyDisplayFormatConfiguration`\n\nThe options that determine the currency display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-template-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-template-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NumberScale": { "MarkdownDocumentation": "`NumberScale`\n\nDetermines the number scale value for the currency format.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AUTO | THOUSANDS | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-numberscale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-template-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the currency format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-template-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Symbol": { "MarkdownDocumentation": "`Symbol`\n\nDetermines the symbol for the currency format.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Z]{3}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-symbol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the currency format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CustomActionFilterOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomActionFilterOperation`\n\nThe filter operation that filters data included in a visual or in an entire sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionfilteroperation.html", "Properties": { "SelectedFieldsConfiguration": { "MarkdownDocumentation": "`SelectedFieldsConfiguration`\n\nThe configuration that chooses the fields to be filtered.\n*Required*: Yes\n*Type*: [FilterOperationSelectedFieldsConfiguration](./aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionfilteroperation.html#cfn-quicksight-template-customactionfilteroperation-selectedfieldsconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterOperationSelectedFieldsConfiguration" }, "TargetVisualsConfiguration": { "MarkdownDocumentation": "`TargetVisualsConfiguration`\n\nThe configuration that chooses the target visuals to be filtered.\n*Required*: Yes\n*Type*: [FilterOperationTargetVisualsConfiguration](./aws-properties-quicksight-template-filteroperationtargetvisualsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionfilteroperation.html#cfn-quicksight-template-customactionfilteroperation-targetvisualsconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterOperationTargetVisualsConfiguration" } } }, "AWS::QuickSight::Template.CustomActionNavigationOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomActionNavigationOperation`\n\nThe navigation operation that navigates between different sheets in the same analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionnavigationoperation.html", "Properties": { "LocalNavigationConfiguration": { "MarkdownDocumentation": "`LocalNavigationConfiguration`\n\nThe configuration that chooses the navigation target.\n*Required*: No\n*Type*: [LocalNavigationConfiguration](./aws-properties-quicksight-template-localnavigationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionnavigationoperation.html#cfn-quicksight-template-customactionnavigationoperation-localnavigationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LocalNavigationConfiguration" } } }, "AWS::QuickSight::Template.CustomActionSetParametersOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomActionSetParametersOperation`\n\nThe set parameter operation that sets parameters in custom action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionsetparametersoperation.html", "Properties": { "ParameterValueConfigurations": { "MarkdownDocumentation": "`ParameterValueConfigurations`\n\nThe parameter that determines the value configuration.\n*Required*: Yes\n*Type*: Array of [SetParameterValueConfiguration](./aws-properties-quicksight-template-setparametervalueconfiguration.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionsetparametersoperation.html#cfn-quicksight-template-customactionsetparametersoperation-parametervalueconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SetParameterValueConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.CustomActionURLOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomActionURLOperation`\n\nThe URL operation that opens a link to another webpage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionurloperation.html", "Properties": { "URLTemplate": { "MarkdownDocumentation": "`URLTemplate`\n\nTHe URL link of the `CustomActionURLOperation`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionurloperation.html#cfn-quicksight-template-customactionurloperation-urltemplate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "URLTarget": { "MarkdownDocumentation": "`URLTarget`\n\nThe target of the `CustomActionURLOperation`.\nValid values are defined as follows:\n* `NEW_TAB`: Opens the target URL in a new browser tab.\n* `NEW_WINDOW`: Opens the target URL in a new browser window.\n* `SAME_TAB`: Opens the target URL in the same browser tab.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW_TAB | NEW_WINDOW | SAME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_TAB", "NEW_WINDOW", "SAME_TAB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionurloperation.html#cfn-quicksight-template-customactionurloperation-urltarget", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CustomColor": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomColor`\n\nDetermines the color that's applied to a particular data value in a column.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcolor.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that is applied to the data value.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcolor.html#cfn-quicksight-template-customcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe data value that the color is applied to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcolor.html#cfn-quicksight-template-customcolor-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpecialValue": { "MarkdownDocumentation": "`SpecialValue`\n\nThe value of a special data value.\n*Required*: No\n*Type*: String\n*Allowed values*: `EMPTY | NULL | OTHER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EMPTY", "NULL", "OTHER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcolor.html#cfn-quicksight-template-customcolor-specialvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CustomContentConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomContentConfiguration`\n\nThe configuration of a `CustomContentVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html", "Properties": { "ContentUrl": { "MarkdownDocumentation": "`ContentUrl`\n\nThe input URL that links to the custom content that you want in the custom visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-contenturl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe content type of the custom content visual. You can use this to have the visual render as an image.\n*Required*: No\n*Type*: String\n*Allowed values*: `IMAGE | OTHER_EMBEDDED_CONT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IMAGE", "OTHER_EMBEDDED_CONTENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImageScaling": { "MarkdownDocumentation": "`ImageScaling`\n\nThe sizing options for the size of the custom content visual. This structure is required when the `ContentType` of the visual is `'IMAGE'`.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIT_TO_HEIGHT | FIT_TO_WIDT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIT_TO_HEIGHT", "FIT_TO_WIDTH", "DO_NOT_SCALE", "SCALE_TO_VISUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-imagescaling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Template.CustomContentVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomContentVisual`\n\nA visual that contains custom content.\nFor more information, see [Using custom visual content](https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `CustomContentVisual`.\n*Required*: No\n*Type*: [CustomContentConfiguration](./aws-properties-quicksight-template-customcontentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomContentConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe dataset that is used to create the custom content visual. You can't create a visual without a dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CustomFilterConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomFilterConfiguration`\n\nA custom filter that filters based on a single value. This filter can be partially matched.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html", "Properties": { "CategoryValue": { "MarkdownDocumentation": "`CategoryValue`\n\nThe category value for the filter.\nThis field is mutually exclusive to `ParameterName`.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-categoryvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\nThis field is mutually exclusive to `CategoryValue`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CustomFilterListConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomFilterListConfiguration`\n\nA list of custom filter values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html", "Properties": { "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nThe list of category values for the filter.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html#cfn-quicksight-template-customfilterlistconfiguration-categoryvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html#cfn-quicksight-template-customfilterlistconfiguration-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html#cfn-quicksight-template-customfilterlistconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html#cfn-quicksight-template-customfilterlistconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CustomNarrativeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomNarrativeOptions`\n\nThe custom narrative options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customnarrativeoptions.html", "Properties": { "Narrative": { "MarkdownDocumentation": "`Narrative`\n\nThe string input of custom narrative.\n*Required*: Yes\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `150000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customnarrativeoptions.html#cfn-quicksight-template-customnarrativeoptions-narrative", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.CustomParameterValues": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomParameterValues`\n\nThe customized parameter values.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html", "Properties": { "DecimalValues": { "MarkdownDocumentation": "`DecimalValues`\n\nA list of decimal-type parameter values.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html#cfn-quicksight-template-customparametervalues-decimalvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "IntegerValues": { "MarkdownDocumentation": "`IntegerValues`\n\nA list of integer-type parameter values.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html#cfn-quicksight-template-customparametervalues-integervalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "StringValues": { "MarkdownDocumentation": "`StringValues`\n\nA list of string-type parameter values.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html#cfn-quicksight-template-customparametervalues-stringvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DateTimeValues": { "MarkdownDocumentation": "`DateTimeValues`\n\nA list of datetime-type parameter values.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html#cfn-quicksight-template-customparametervalues-datetimevalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.CustomValuesConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.CustomValuesConfiguration`\n\nThe configuration of custom values for the destination parameter in `DestinationParameterValueConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customvaluesconfiguration.html", "Properties": { "IncludeNullValue": { "MarkdownDocumentation": "`IncludeNullValue`\n\nIncludes the null value in custom action parameter values.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customvaluesconfiguration.html#cfn-quicksight-template-customvaluesconfiguration-includenullvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CustomValues": { "MarkdownDocumentation": "`CustomValues`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [CustomParameterValues](./aws-properties-quicksight-template-customparametervalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customvaluesconfiguration.html#cfn-quicksight-template-customvaluesconfiguration-customvalues", "UpdateType": "Mutable", "Required": true, "Type": "CustomParameterValues" } } }, "AWS::QuickSight::Template.DataBarsOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataBarsOptions`\n\nThe options for data bars.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-databarsoptions.html", "Properties": { "PositiveColor": { "MarkdownDocumentation": "`PositiveColor`\n\nThe color of the positive data bar.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-databarsoptions.html#cfn-quicksight-template-databarsoptions-positivecolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for the data bars options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-databarsoptions.html#cfn-quicksight-template-databarsoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NegativeColor": { "MarkdownDocumentation": "`NegativeColor`\n\nThe color of the negative data bar.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-databarsoptions.html#cfn-quicksight-template-databarsoptions-negativecolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DataColor": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataColor`\n\nDetermines the color that is applied to a particular data value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datacolor.html", "Properties": { "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nThe data value that the color is applied to.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datacolor.html#cfn-quicksight-template-datacolor-datavalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that is applied to the data value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datacolor.html#cfn-quicksight-template-datacolor-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DataFieldSeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataFieldSeriesItem`\n\nThe data field series item configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that you are setting the axis binding to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html#cfn-quicksight-template-datafieldseriesitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis that you are binding the field to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html#cfn-quicksight-template-datafieldseriesitem-axisbinding", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe field value of the field that you are setting the axis binding 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html#cfn-quicksight-template-datafieldseriesitem-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nThe options that determine the presentation of line series associated to the field.\n*Required*: No\n*Type*: [LineChartSeriesSettings](./aws-properties-quicksight-template-linechartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html#cfn-quicksight-template-datafieldseriesitem-settings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSeriesSettings" } } }, "AWS::QuickSight::Template.DataLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html", "Properties": { "DataLabelTypes": { "MarkdownDocumentation": "`DataLabelTypes`\n\nThe option that determines the data label type.\n*Required*: No\n*Type*: Array of [DataLabelType](./aws-properties-quicksight-template-datalabeltype.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-datalabeltypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataLabelType", "DuplicatesAllowed": true }, "MeasureLabelVisibility": { "MarkdownDocumentation": "`MeasureLabelVisibility`\n\nDetermines the visibility of the measure field labels.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-measurelabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Position": { "MarkdownDocumentation": "`Position`\n\nDetermines the position of the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSIDE | OUTSIDE | LEFT | T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSIDE", "OUTSIDE", "LEFT", "TOP", "BOTTOM", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelContent": { "MarkdownDocumentation": "`LabelContent`\n\nDetermines the content of the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `VALUE | PERCENT | VALUE_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VALUE", "PERCENT", "VALUE_AND_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-labelcontent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the data labels.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nDetermines the visibility of the total.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Overlap": { "MarkdownDocumentation": "`Overlap`\n\nDetermines whether overlap is enabled or disabled for the data labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLE_OVERLAP | ENABLE_OV...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLE_OVERLAP", "ENABLE_OVERLAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-overlap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryLabelVisibility": { "MarkdownDocumentation": "`CategoryLabelVisibility`\n\nDetermines the visibility of the category field labels.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-categorylabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LabelColor": { "MarkdownDocumentation": "`LabelColor`\n\nDetermines the color of the data labels.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-labelcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelFontConfiguration": { "MarkdownDocumentation": "`LabelFontConfiguration`\n\nDetermines the font configuration of the data labels.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-labelfontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Template.DataLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataLabelType`\n\nThe option that determines the data label type.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html", "Properties": { "MaximumLabelType": { "MarkdownDocumentation": "`MaximumLabelType`\n\nDetermines the label configuration for the maximum value in a visual.\n*Required*: No\n*Type*: [MaximumLabelType](./aws-properties-quicksight-template-maximumlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-maximumlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "MaximumLabelType" }, "DataPathLabelType": { "MarkdownDocumentation": "`DataPathLabelType`\n\nThe option that specifies individual data values for labels.\n*Required*: No\n*Type*: [DataPathLabelType](./aws-properties-quicksight-template-datapathlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-datapathlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "DataPathLabelType" }, "RangeEndsLabelType": { "MarkdownDocumentation": "`RangeEndsLabelType`\n\nDetermines the label configuration for range end value in a visual.\n*Required*: No\n*Type*: [RangeEndsLabelType](./aws-properties-quicksight-template-rangeendslabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-rangeendslabeltype", "UpdateType": "Mutable", "Required": false, "Type": "RangeEndsLabelType" }, "FieldLabelType": { "MarkdownDocumentation": "`FieldLabelType`\n\nDetermines the label configuration for the entire field.\n*Required*: No\n*Type*: [FieldLabelType](./aws-properties-quicksight-template-fieldlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-fieldlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "FieldLabelType" }, "MinimumLabelType": { "MarkdownDocumentation": "`MinimumLabelType`\n\nDetermines the label configuration for the minimum value in a visual.\n*Required*: No\n*Type*: [MinimumLabelType](./aws-properties-quicksight-template-minimumlabeltype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-minimumlabeltype", "UpdateType": "Mutable", "Required": false, "Type": "MinimumLabelType" } } }, "AWS::QuickSight::Template.DataPathColor": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataPathColor`\n\nThe color map that determines the color options for a particular element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathcolor.html", "Properties": { "Element": { "MarkdownDocumentation": "`Element`\n\nThe element that the color needs to be applied to.\n*Required*: Yes\n*Type*: [DataPathValue](./aws-properties-quicksight-template-datapathvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathcolor.html#cfn-quicksight-template-datapathcolor-element", "UpdateType": "Mutable", "Required": true, "Type": "DataPathValue" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that needs to be applied to the element.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathcolor.html#cfn-quicksight-template-datapathcolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe time granularity of the field that the color needs to be applied to.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathcolor.html#cfn-quicksight-template-datapathcolor-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DataPathLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataPathLabelType`\n\nThe option that specifies individual data values for labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathlabeltype.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that the data label needs to be applied to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathlabeltype.html#cfn-quicksight-template-datapathlabeltype-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the data label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathlabeltype.html#cfn-quicksight-template-datapathlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe actual value of the field that is labeled.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathlabeltype.html#cfn-quicksight-template-datapathlabeltype-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DataPathSort": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataPathSort`\n\nAllows data paths to be sorted by a specific data value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathsort.html", "Properties": { "SortPaths": { "MarkdownDocumentation": "`SortPaths`\n\nThe list of data paths that need to be sorted.\n*Required*: Yes\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-template-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathsort.html#cfn-quicksight-template-datapathsort-sortpaths", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nDetermines the sort direction.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathsort.html#cfn-quicksight-template-datapathsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DataPathType": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataPathType`\n\nThe type of the data path value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathtype.html", "Properties": { "PivotTableDataPathType": { "MarkdownDocumentation": "`PivotTableDataPathType`\n\nThe type of data path value utilized in a pivot table. Choose one of the following options:\n* `HIERARCHY_ROWS_LAYOUT_COLUMN` - The type of data path for the rows layout column, when `RowsLayout` is set to `HIERARCHY`.\n* `MULTIPLE_ROW_METRICS_COLUMN` - The type of data path for the metric column when the row is set to Metric Placement.\n* `EMPTY_COLUMN_HEADER` - The type of data path for the column with empty column header, when there is no field in `ColumnsFieldWell` and the row is set to Metric Placement.\n* `COUNT_METRIC_COLUMN` - The type of data path for the column with `COUNT` as the metric, when there is no field in the `ValuesFieldWell`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIERARCHY_ROWS_LAYOUT_COLUM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIERARCHY_ROWS_LAYOUT_COLUMN", "MULTIPLE_ROW_METRICS_COLUMN", "EMPTY_COLUMN_HEADER", "COUNT_METRIC_COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathtype.html#cfn-quicksight-template-datapathtype-pivottabledatapathtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DataPathValue": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataPathValue`\n\nThe data path that needs to be sorted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathvalue.html", "Properties": { "DataPathType": { "MarkdownDocumentation": "`DataPathType`\n\nThe type configuration of the field.\n*Required*: No\n*Type*: [DataPathType](./aws-properties-quicksight-template-datapathtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathvalue.html#cfn-quicksight-template-datapathvalue-datapathtype", "UpdateType": "Mutable", "Required": false, "Type": "DataPathType" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field that needs to be sorted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathvalue.html#cfn-quicksight-template-datapathvalue-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldValue": { "MarkdownDocumentation": "`FieldValue`\n\nThe actual value of the field that needs to be sorted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathvalue.html#cfn-quicksight-template-datapathvalue-fieldvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DataSetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataSetConfiguration`\n\nDataset configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html", "Properties": { "Placeholder": { "MarkdownDocumentation": "`Placeholder`\n\nPlaceholder.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-placeholder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSetSchema": { "MarkdownDocumentation": "`DataSetSchema`\n\nDataset schema.\n*Required*: No\n*Type*: [DataSetSchema](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-datasetschema", "UpdateType": "Mutable", "Required": false, "Type": "DataSetSchema" }, "ColumnGroupSchemaList": { "MarkdownDocumentation": "`ColumnGroupSchemaList`\n\nA structure containing the list of column group schemas.\n*Required*: No\n*Type*: Array of [ColumnGroupSchema](./aws-properties-quicksight-template-columngroupschema.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-columngroupschemalist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnGroupSchema", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.DataSetReference": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataSetReference`\n\nDataset reference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html", "Properties": { "DataSetArn": { "MarkdownDocumentation": "`DataSetArn`\n\nDataset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html#cfn-quicksight-template-datasetreference-datasetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetPlaceholder": { "MarkdownDocumentation": "`DataSetPlaceholder`\n\nDataset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html#cfn-quicksight-template-datasetreference-datasetplaceholder", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DataSetSchema": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DataSetSchema`\n\nDataset schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.html", "Properties": { "ColumnSchemaList": { "MarkdownDocumentation": "`ColumnSchemaList`\n\nA structure containing the list of column schemas.\n*Required*: No\n*Type*: Array of [ColumnSchema](./aws-properties-quicksight-template-columnschema.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.html#cfn-quicksight-template-datasetschema-columnschemalist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnSchema", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.DateAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateAxisOptions`\n\nThe options that determine how a date axis is displayed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dateaxisoptions.html", "Properties": { "MissingDateVisibility": { "MarkdownDocumentation": "`MissingDateVisibility`\n\nDetermines whether or not missing dates are displayed.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dateaxisoptions.html#cfn-quicksight-template-dateaxisoptions-missingdatevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.DateDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateDimensionField`\n\nThe dimension type field with date type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-template-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `DateDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DateGranularity": { "MarkdownDocumentation": "`DateGranularity`\n\nThe date granularity of the `DateDimensionField`. Choose one of the following options:\n* `YEAR`\n* `QUARTER`\n* `MONTH`\n* `WEEK`\n* `DAY`\n* `HOUR`\n* `MINUTE`\n* `SECOND`\n* `MILLISECOND`\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-dategranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DateMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateMeasureField`\n\nThe measure type field with date type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [String](./aws-properties-quicksight-template-aggregationfunction.html)\n*Allowed values*: `COUNT | DISTINCT_COUNT | MI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COUNT", "DISTINCT_COUNT", "MIN", "MAX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html#cfn-quicksight-template-datemeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-template-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html#cfn-quicksight-template-datemeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `DateMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html#cfn-quicksight-template-datemeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html#cfn-quicksight-template-datemeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DateTimeDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateTimeDefaultValues`\n\nThe default values of the `DateTimeParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimedefaultvalues.html", "Properties": { "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date of the `DataTimeDefaultValues`. The date is determined from the dataset based on input expression.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-template-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimedefaultvalues.html#cfn-quicksight-template-datetimedefaultvalues-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `DataTimeDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-template-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimedefaultvalues.html#cfn-quicksight-template-datetimedefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DataTimeDefaultValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimedefaultvalues.html#cfn-quicksight-template-datetimedefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.DateTimeFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateTimeFormatConfiguration`\n\nFormatting configuration for `DateTime` fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeformatconfiguration.html", "Properties": { "NumericFormatConfiguration": { "MarkdownDocumentation": "`NumericFormatConfiguration`\n\nThe formatting configuration for numeric `DateTime` fields.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-template-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeformatconfiguration.html#cfn-quicksight-template-datetimeformatconfiguration-numericformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-template-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeformatconfiguration.html#cfn-quicksight-template-datetimeformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nDetermines the `DateTime` format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeformatconfiguration.html#cfn-quicksight-template-datetimeformatconfiguration-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DateTimeHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateTimeHierarchy`\n\nThe option that determines the hierarchy of any `DateTime` fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimehierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the `DateTime` hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimehierarchy.html#cfn-quicksight-template-datetimehierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the\n`DateTime` hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-template-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimehierarchy.html#cfn-quicksight-template-datetimehierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.DateTimeParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateTimeParameterDeclaration`\n\nA parameter declaration for the `DateTime` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-template-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [DateTimeDefaultValues](./aws-properties-quicksight-template-datetimedefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeDefaultValues" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `DateTime` parameter when a value has not been set.\n*Required*: No\n*Type*: [DateTimeValueWhenUnsetConfiguration](./aws-properties-quicksight-template-datetimevaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DateTimePickerControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateTimePickerControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" }, "HelperTextVisibility": { "MarkdownDocumentation": "`HelperTextVisibility`\n\nThe helper text visibility of the `DateTimePickerControlDisplayOptions`.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-helpertextvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DateIconVisibility": { "MarkdownDocumentation": "`DateIconVisibility`\n\nThe date icon visibility of the `DateTimePickerControlDisplayOptions`.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-dateiconvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nCustomize how dates are formatted in controls.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DateTimeValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DateTimeValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `DateTime` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimevaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-template-datetimevaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-template-datetimevaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DecimalDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DecimalDefaultValues`\n\nThe default values of the `DecimalParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimaldefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `DecimalDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-template-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimaldefaultvalues.html#cfn-quicksight-template-decimaldefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DecimalDefaultValues`.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimaldefaultvalues.html#cfn-quicksight-template-decimaldefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.DecimalParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DecimalParameterDeclaration`\n\nA parameter declaration for the `Decimal` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-template-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [DecimalDefaultValues](./aws-properties-quicksight-template-decimaldefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "DecimalDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `Decimal` parameter when a value has not been set.\n*Required*: No\n*Type*: [DecimalValueWhenUnsetConfiguration](./aws-properties-quicksight-template-decimalvaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "DecimalValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DecimalPlacesConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalplacesconfiguration.html", "Properties": { "DecimalPlaces": { "MarkdownDocumentation": "`DecimalPlaces`\n\nThe values of the decimal places.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalplacesconfiguration.html#cfn-quicksight-template-decimalplacesconfiguration-decimalplaces", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.DecimalValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DecimalValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `Decimal` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalvaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-template-decimalvaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't set.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-template-decimalvaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.DefaultDateTimePickerControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultDateTimePickerControlOptions`\n\nThe default options that correspond to the filter control type of a `DateTimePicker`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultdatetimepickercontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe date time picker type of the `DefaultDateTimePickerControlOptions`. Choose one of the following options:\n* `SINGLE_VALUED`: The filter condition is a fixed date.\n* `DATE_RANGE`: The filter condition is a date time range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_VALUED | DATE_RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_VALUED", "DATE_RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultdatetimepickercontroloptions.html#cfn-quicksight-template-defaultdatetimepickercontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultdatetimepickercontroloptions.html#cfn-quicksight-template-defaultdatetimepickercontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `DateTimePickerControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultdatetimepickercontroloptions.html#cfn-quicksight-template-defaultdatetimepickercontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultFilterControlConfiguration`\n\nThe default configuration for all dependent controls of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html", "Properties": { "ControlOptions": { "MarkdownDocumentation": "`ControlOptions`\n\nThe control option for the `DefaultFilterControlConfiguration`.\n*Required*: Yes\n*Type*: [DefaultFilterControlOptions](./aws-properties-quicksight-template-defaultfiltercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html#cfn-quicksight-template-defaultfiltercontrolconfiguration-controloptions", "UpdateType": "Mutable", "Required": true, "Type": "DefaultFilterControlOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `DefaultFilterControlConfiguration`. This title is shared by all controls that are tied to this filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html#cfn-quicksight-template-defaultfiltercontrolconfiguration-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DefaultFilterControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultFilterControlOptions`\n\nThe option that corresponds to the control type of the filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html", "Properties": { "DefaultSliderOptions": { "MarkdownDocumentation": "`DefaultSliderOptions`\n\nThe default options that correspond to the `Slider` filter control type.\n*Required*: No\n*Type*: [DefaultSliderControlOptions](./aws-properties-quicksight-template-defaultslidercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultslideroptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSliderControlOptions" }, "DefaultRelativeDateTimeOptions": { "MarkdownDocumentation": "`DefaultRelativeDateTimeOptions`\n\nThe default options that correspond to the `RelativeDateTime` filter control type.\n*Required*: No\n*Type*: [DefaultRelativeDateTimeControlOptions](./aws-properties-quicksight-template-defaultrelativedatetimecontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultrelativedatetimeoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultRelativeDateTimeControlOptions" }, "DefaultTextFieldOptions": { "MarkdownDocumentation": "`DefaultTextFieldOptions`\n\nThe default options that correspond to the `TextField` filter control type.\n*Required*: No\n*Type*: [DefaultTextFieldControlOptions](./aws-properties-quicksight-template-defaulttextfieldcontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaulttextfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultTextFieldControlOptions" }, "DefaultTextAreaOptions": { "MarkdownDocumentation": "`DefaultTextAreaOptions`\n\nThe default options that correspond to the `TextArea` filter control type.\n*Required*: No\n*Type*: [DefaultTextAreaControlOptions](./aws-properties-quicksight-template-defaulttextareacontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaulttextareaoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultTextAreaControlOptions" }, "DefaultDropdownOptions": { "MarkdownDocumentation": "`DefaultDropdownOptions`\n\nThe default options that correspond to the `Dropdown` filter control type.\n*Required*: No\n*Type*: [DefaultFilterDropDownControlOptions](./aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultdropdownoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterDropDownControlOptions" }, "DefaultDateTimePickerOptions": { "MarkdownDocumentation": "`DefaultDateTimePickerOptions`\n\nThe default options that correspond to the filter control type of a `DateTimePicker`.\n*Required*: No\n*Type*: [DefaultDateTimePickerControlOptions](./aws-properties-quicksight-template-defaultdatetimepickercontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultdatetimepickeroptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultDateTimePickerControlOptions" }, "DefaultListOptions": { "MarkdownDocumentation": "`DefaultListOptions`\n\nThe default options that correspond to the `List` filter control type.\n*Required*: No\n*Type*: [DefaultFilterListControlOptions](./aws-properties-quicksight-template-defaultfilterlistcontroloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultlistoptions", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterListControlOptions" } } }, "AWS::QuickSight::Template.DefaultFilterDropDownControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultFilterDropDownControlOptions`\n\nThe default options that correspond to the `Dropdown` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html#cfn-quicksight-template-defaultfilterdropdowncontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-template-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html#cfn-quicksight-template-defaultfilterdropdowncontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html#cfn-quicksight-template-defaultfilterdropdowncontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-template-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html#cfn-quicksight-template-defaultfilterdropdowncontroloptions-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Template.DefaultFilterListControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultFilterListControlOptions`\n\nThe default options that correspond to the `List` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterlistcontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `DefaultFilterListControlOptions`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from the list.\n* `SINGLE_SELECT`: The user can select a single entry from the list.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterlistcontroloptions.html#cfn-quicksight-template-defaultfilterlistcontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-template-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterlistcontroloptions.html#cfn-quicksight-template-defaultfilterlistcontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-template-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterlistcontroloptions.html#cfn-quicksight-template-defaultfilterlistcontroloptions-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Template.DefaultFreeFormLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultFreeFormLayoutConfiguration`\n\nThe options that determine the default settings of a free-form layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfreeformlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a free-form layout.\n*Required*: Yes\n*Type*: [FreeFormLayoutCanvasSizeOptions](./aws-properties-quicksight-template-freeformlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfreeformlayoutconfiguration.html#cfn-quicksight-template-defaultfreeformlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "FreeFormLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Template.DefaultGridLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultGridLayoutConfiguration`\n\nThe options that determine the default settings for a grid layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultgridlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a grid layout.\n*Required*: Yes\n*Type*: [GridLayoutCanvasSizeOptions](./aws-properties-quicksight-template-gridlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultgridlayoutconfiguration.html#cfn-quicksight-template-defaultgridlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "GridLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Template.DefaultInteractiveLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultInteractiveLayoutConfiguration`\n\nThe options that determine the default settings for interactive layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultinteractivelayoutconfiguration.html", "Properties": { "FreeForm": { "MarkdownDocumentation": "`FreeForm`\n\nThe options that determine the default settings of a free-form layout configuration.\n*Required*: No\n*Type*: [DefaultFreeFormLayoutConfiguration](./aws-properties-quicksight-template-defaultfreeformlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultinteractivelayoutconfiguration.html#cfn-quicksight-template-defaultinteractivelayoutconfiguration-freeform", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFreeFormLayoutConfiguration" }, "Grid": { "MarkdownDocumentation": "`Grid`\n\nThe options that determine the default settings for a grid layout configuration.\n*Required*: No\n*Type*: [DefaultGridLayoutConfiguration](./aws-properties-quicksight-template-defaultgridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultinteractivelayoutconfiguration.html#cfn-quicksight-template-defaultinteractivelayoutconfiguration-grid", "UpdateType": "Mutable", "Required": false, "Type": "DefaultGridLayoutConfiguration" } } }, "AWS::QuickSight::Template.DefaultNewSheetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultNewSheetConfiguration`\n\nThe configuration for default new sheet settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultnewsheetconfiguration.html", "Properties": { "SheetContentType": { "MarkdownDocumentation": "`SheetContentType`\n\nThe option that determines the sheet content type.\n*Required*: No\n*Type*: String\n*Allowed values*: `PAGINATED | INTERACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PAGINATED", "INTERACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultnewsheetconfiguration.html#cfn-quicksight-template-defaultnewsheetconfiguration-sheetcontenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InteractiveLayoutConfiguration": { "MarkdownDocumentation": "`InteractiveLayoutConfiguration`\n\nThe options that determine the default settings for interactive layout configuration.\n*Required*: No\n*Type*: [DefaultInteractiveLayoutConfiguration](./aws-properties-quicksight-template-defaultinteractivelayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultnewsheetconfiguration.html#cfn-quicksight-template-defaultnewsheetconfiguration-interactivelayoutconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultInteractiveLayoutConfiguration" }, "PaginatedLayoutConfiguration": { "MarkdownDocumentation": "`PaginatedLayoutConfiguration`\n\nThe options that determine the default settings for a paginated layout configuration.\n*Required*: No\n*Type*: [DefaultPaginatedLayoutConfiguration](./aws-properties-quicksight-template-defaultpaginatedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultnewsheetconfiguration.html#cfn-quicksight-template-defaultnewsheetconfiguration-paginatedlayoutconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultPaginatedLayoutConfiguration" } } }, "AWS::QuickSight::Template.DefaultPaginatedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultPaginatedLayoutConfiguration`\n\nThe options that determine the default settings for a paginated layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultpaginatedlayoutconfiguration.html", "Properties": { "SectionBased": { "MarkdownDocumentation": "`SectionBased`\n\nThe options that determine the default settings for a section-based layout configuration.\n*Required*: No\n*Type*: [DefaultSectionBasedLayoutConfiguration](./aws-properties-quicksight-template-defaultsectionbasedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultpaginatedlayoutconfiguration.html#cfn-quicksight-template-defaultpaginatedlayoutconfiguration-sectionbased", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSectionBasedLayoutConfiguration" } } }, "AWS::QuickSight::Template.DefaultRelativeDateTimeControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultRelativeDateTimeControlOptions`\n\nThe default options that correspond to the `RelativeDateTime` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultrelativedatetimecontroloptions.html", "Properties": { "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [RelativeDateTimeControlDisplayOptions](./aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultrelativedatetimecontroloptions.html#cfn-quicksight-template-defaultrelativedatetimecontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDateTimeControlDisplayOptions" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `RelativeDateTimeControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultrelativedatetimecontroloptions.html#cfn-quicksight-template-defaultrelativedatetimecontroloptions-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.DefaultSectionBasedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultSectionBasedLayoutConfiguration`\n\nThe options that determine the default settings for a section-based layout configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultsectionbasedlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nDetermines the screen canvas size options for a section-based layout.\n*Required*: Yes\n*Type*: [SectionBasedLayoutCanvasSizeOptions](./aws-properties-quicksight-template-sectionbasedlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultsectionbasedlayoutconfiguration.html#cfn-quicksight-template-defaultsectionbasedlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "SectionBasedLayoutCanvasSizeOptions" } } }, "AWS::QuickSight::Template.DefaultSliderControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultSliderControlOptions`\n\nThe default options that correspond to the `Slider` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `DefaultSliderControlOptions`. Choose one of the following options:\n* `SINGLE_POINT`: Filter against(equals) a single data point.\n* `RANGE`: Filter data that is in a specified range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_POINT | RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_POINT", "RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-template-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.DefaultTextAreaControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultTextAreaControlOptions`\n\nThe default options that correspond to the `TextArea` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextareacontroloptions.html", "Properties": { "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextareacontroloptions.html#cfn-quicksight-template-defaulttextareacontroloptions-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-template-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextareacontroloptions.html#cfn-quicksight-template-defaulttextareacontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" } } }, "AWS::QuickSight::Template.DefaultTextFieldControlOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DefaultTextFieldControlOptions`\n\nThe default options that correspond to the `TextField` filter control type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextfieldcontroloptions.html", "Properties": { "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-template-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextfieldcontroloptions.html#cfn-quicksight-template-defaulttextfieldcontroloptions-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" } } }, "AWS::QuickSight::Template.DestinationParameterValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DestinationParameterValueConfiguration`\n\nThe configuration of destination parameter values.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html", "Properties": { "CustomValuesConfiguration": { "MarkdownDocumentation": "`CustomValuesConfiguration`\n\nThe configuration of custom values for destination parameter in `DestinationParameterValueConfiguration`.\n*Required*: No\n*Type*: [CustomValuesConfiguration](./aws-properties-quicksight-template-customvaluesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-customvaluesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomValuesConfiguration" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the destination parameter.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-sourceparametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectAllValueOptions": { "MarkdownDocumentation": "`SelectAllValueOptions`\n\nThe configuration that selects all options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VALUES`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-selectallvalueoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceField": { "MarkdownDocumentation": "`SourceField`\n\nThe source field ID of the destination parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-sourcefield", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceColumn": { "MarkdownDocumentation": "`SourceColumn`\n\nA column of a data set.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-sourcecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Template.DimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DimensionField`\n\nThe dimension type field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dimensionfield.html", "Properties": { "DateDimensionField": { "MarkdownDocumentation": "`DateDimensionField`\n\nThe dimension type field with date type columns.\n*Required*: No\n*Type*: [DateDimensionField](./aws-properties-quicksight-template-datedimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dimensionfield.html#cfn-quicksight-template-dimensionfield-datedimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "DateDimensionField" }, "NumericalDimensionField": { "MarkdownDocumentation": "`NumericalDimensionField`\n\nThe dimension type field with numerical type columns.\n*Required*: No\n*Type*: [NumericalDimensionField](./aws-properties-quicksight-template-numericaldimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dimensionfield.html#cfn-quicksight-template-dimensionfield-numericaldimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "NumericalDimensionField" }, "CategoricalDimensionField": { "MarkdownDocumentation": "`CategoricalDimensionField`\n\nThe dimension type field with categorical type columns.\n*Required*: No\n*Type*: [CategoricalDimensionField](./aws-properties-quicksight-template-categoricaldimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dimensionfield.html#cfn-quicksight-template-dimensionfield-categoricaldimensionfield", "UpdateType": "Mutable", "Required": false, "Type": "CategoricalDimensionField" } } }, "AWS::QuickSight::Template.DonutCenterOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DonutCenterOptions`\n\nThe label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutcenteroptions.html", "Properties": { "LabelVisibility": { "MarkdownDocumentation": "`LabelVisibility`\n\nDetermines the visibility of the label in a donut chart. In the Quick Sight console, this option is called `'Show total'`.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutcenteroptions.html#cfn-quicksight-template-donutcenteroptions-labelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.DonutOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DonutOptions`\n\nThe options for configuring a donut chart or pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutoptions.html", "Properties": { "DonutCenterOptions": { "MarkdownDocumentation": "`DonutCenterOptions`\n\nThe label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.\n*Required*: No\n*Type*: [DonutCenterOptions](./aws-properties-quicksight-template-donutcenteroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutoptions.html#cfn-quicksight-template-donutoptions-donutcenteroptions", "UpdateType": "Mutable", "Required": false, "Type": "DonutCenterOptions" }, "ArcOptions": { "MarkdownDocumentation": "`ArcOptions`\n\nThe option for define the arc of the chart shape. Valid values are as follows:\n* `WHOLE` - A pie chart\n* `SMALL`- A small-sized donut chart\n* `MEDIUM`- A medium-sized donut chart\n* `LARGE`- A large-sized donut chart\n*Required*: No\n*Type*: [ArcOptions](./aws-properties-quicksight-template-arcoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutoptions.html#cfn-quicksight-template-donutoptions-arcoptions", "UpdateType": "Mutable", "Required": false, "Type": "ArcOptions" } } }, "AWS::QuickSight::Template.DrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DrillDownFilter`\n\nThe drill down filter for the column hierarchies.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-drilldownfilter.html", "Properties": { "NumericEqualityFilter": { "MarkdownDocumentation": "`NumericEqualityFilter`\n\nThe numeric equality type drill down filter. This filter is used for number type columns.\n*Required*: No\n*Type*: [NumericEqualityDrillDownFilter](./aws-properties-quicksight-template-numericequalitydrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-drilldownfilter.html#cfn-quicksight-template-drilldownfilter-numericequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericEqualityDrillDownFilter" }, "TimeRangeFilter": { "MarkdownDocumentation": "`TimeRangeFilter`\n\nThe time range drill down filter. This filter is used for date time columns.\n*Required*: No\n*Type*: [TimeRangeDrillDownFilter](./aws-properties-quicksight-template-timerangedrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-drilldownfilter.html#cfn-quicksight-template-drilldownfilter-timerangefilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeDrillDownFilter" }, "CategoryFilter": { "MarkdownDocumentation": "`CategoryFilter`\n\nThe category type drill down filter. This filter is used for string type columns.\n*Required*: No\n*Type*: [CategoryDrillDownFilter](./aws-properties-quicksight-template-categorydrilldownfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-drilldownfilter.html#cfn-quicksight-template-drilldownfilter-categoryfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryDrillDownFilter" } } }, "AWS::QuickSight::Template.DropDownControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DropDownControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dropdowncontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dropdowncontroldisplayoptions.html#cfn-quicksight-template-dropdowncontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nThe configuration of the `Select all` options in a\ndropdown control.\n*Required*: No\n*Type*: [ListControlSelectAllOptions](./aws-properties-quicksight-template-listcontrolselectalloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dropdowncontroldisplayoptions.html#cfn-quicksight-template-dropdowncontroldisplayoptions-selectalloptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSelectAllOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dropdowncontroldisplayoptions.html#cfn-quicksight-template-dropdowncontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Template.DynamicDefaultValue": { "MarkdownDocumentation": "`AWS::QuickSight::Template.DynamicDefaultValue`\n\nDefines different defaults to the users or groups based on mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dynamicdefaultvalue.html", "Properties": { "GroupNameColumn": { "MarkdownDocumentation": "`GroupNameColumn`\n\nThe column that contains the group name.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dynamicdefaultvalue.html#cfn-quicksight-template-dynamicdefaultvalue-groupnamecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" }, "DefaultValueColumn": { "MarkdownDocumentation": "`DefaultValueColumn`\n\nThe column that contains the default value of each user or group.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dynamicdefaultvalue.html#cfn-quicksight-template-dynamicdefaultvalue-defaultvaluecolumn", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "UserNameColumn": { "MarkdownDocumentation": "`UserNameColumn`\n\nThe column that contains the username.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dynamicdefaultvalue.html#cfn-quicksight-template-dynamicdefaultvalue-usernamecolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" } } }, "AWS::QuickSight::Template.EmptyVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.EmptyVisual`\n\nAn empty visual.\nEmpty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an `EmptyVisual` until a visual type is selected.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-emptyvisual.html", "Properties": { "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-emptyvisual.html#cfn-quicksight-template-emptyvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-emptyvisual.html#cfn-quicksight-template-emptyvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in the empty visual. Every visual requires a dataset to render.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-emptyvisual.html#cfn-quicksight-template-emptyvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.Entity": { "MarkdownDocumentation": "`AWS::QuickSight::Template.Entity`\n\nAn object, structure, or sub-structure of an analysis, template, or dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-entity.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe hierarchical path of the entity within the analysis, template, or dashboard definition tree.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-entity.html#cfn-quicksight-template-entity-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ExcludePeriodConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ExcludePeriodConfiguration`\n\nThe exclude period of `TimeRangeFilter` or `RelativeDatesFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-excludeperiodconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the exclude period. Choose from the following options:\n* `ENABLED`\n* `DISABLED`\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-excludeperiodconfiguration.html#cfn-quicksight-template-excludeperiodconfiguration-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Amount": { "MarkdownDocumentation": "`Amount`\n\nThe amount or number of the exclude period.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-excludeperiodconfiguration.html#cfn-quicksight-template-excludeperiodconfiguration-amount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Granularity": { "MarkdownDocumentation": "`Granularity`\n\nThe granularity or unit (day, month, year) of the exclude period.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-excludeperiodconfiguration.html#cfn-quicksight-template-excludeperiodconfiguration-granularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ExplicitHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ExplicitHierarchy`\n\nThe option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-explicithierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the explicit hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-explicithierarchy.html#cfn-quicksight-template-explicithierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the explicit hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-template-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-explicithierarchy.html#cfn-quicksight-template-explicithierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe list of columns that define the explicit hierarchy.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-explicithierarchy.html#cfn-quicksight-template-explicithierarchy-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FieldBasedTooltip": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FieldBasedTooltip`\n\nThe setup for the detailed tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.html", "Properties": { "TooltipFields": { "MarkdownDocumentation": "`TooltipFields`\n\nThe fields configuration in the\ntooltip.\n*Required*: No\n*Type*: Array of [TooltipItem](./aws-properties-quicksight-template-tooltipitem.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.html#cfn-quicksight-template-fieldbasedtooltip-tooltipfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TooltipItem", "DuplicatesAllowed": true }, "AggregationVisibility": { "MarkdownDocumentation": "`AggregationVisibility`\n\nThe visibility of `Show aggregations`.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.html#cfn-quicksight-template-fieldbasedtooltip-aggregationvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TooltipTitleType": { "MarkdownDocumentation": "`TooltipTitleType`\n\nThe type for the >tooltip title. Choose one of the following options:\n* `NONE`: Doesn't use the primary value as the title.\n* `PRIMARY_VALUE`: Uses primary value as the title.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | PRIMARY_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "PRIMARY_VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.html#cfn-quicksight-template-fieldbasedtooltip-tooltiptitletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FieldLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FieldLabelType`\n\nThe field label type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldlabeltype.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nIndicates the field that is targeted by the field\nlabel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldlabeltype.html#cfn-quicksight-template-fieldlabeltype-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the field label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldlabeltype.html#cfn-quicksight-template-fieldlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.FieldSeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FieldSeriesItem`\n\nThe field series item configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldseriesitem.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the field for which you are setting the axis binding.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldseriesitem.html#cfn-quicksight-template-fieldseriesitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis that you are binding the field to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldseriesitem.html#cfn-quicksight-template-fieldseriesitem-axisbinding", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nThe options that determine the presentation of line series associated to the field.\n*Required*: No\n*Type*: [LineChartSeriesSettings](./aws-properties-quicksight-template-linechartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldseriesitem.html#cfn-quicksight-template-fieldseriesitem-settings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSeriesSettings" } } }, "AWS::QuickSight::Template.FieldSort": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FieldSort`\n\nThe sort configuration for a field in a\nfield well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsort.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe sort configuration target field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsort.html#cfn-quicksight-template-fieldsort-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nThe sort direction. Choose one of the following\noptions:\n* `ASC`: Ascending\n* `DESC`: Descending\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ASC | DESC`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ASC", "DESC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsort.html#cfn-quicksight-template-fieldsort-direction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FieldSortOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FieldSortOptions`\n\nThe field sort options in a chart configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsortoptions.html", "Properties": { "FieldSort": { "MarkdownDocumentation": "`FieldSort`\n\nThe sort configuration for a field in a field well.\n*Required*: No\n*Type*: [FieldSort](./aws-properties-quicksight-template-fieldsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsortoptions.html#cfn-quicksight-template-fieldsortoptions-fieldsort", "UpdateType": "Mutable", "Required": false, "Type": "FieldSort" }, "ColumnSort": { "MarkdownDocumentation": "`ColumnSort`\n\nThe sort configuration for a column that is not used in a field well.\n*Required*: No\n*Type*: [ColumnSort](./aws-properties-quicksight-template-columnsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsortoptions.html#cfn-quicksight-template-fieldsortoptions-columnsort", "UpdateType": "Mutable", "Required": false, "Type": "ColumnSort" } } }, "AWS::QuickSight::Template.FieldTooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FieldTooltipItem`\n\nThe tooltip item for the fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html", "Properties": { "TooltipTarget": { "MarkdownDocumentation": "`TooltipTarget`\n\nDetermines the target of the field tooltip item in a combo chart visual.\n*Required*: No\n*Type*: String\n*Allowed values*: `BOTH | BAR | LINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BOTH", "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html#cfn-quicksight-template-fieldtooltipitem-tooltiptarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe unique ID of the field that is targeted by the tooltip.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html#cfn-quicksight-template-fieldtooltipitem-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label of the tooltip item.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html#cfn-quicksight-template-fieldtooltipitem-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip item.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html#cfn-quicksight-template-fieldtooltipitem-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.FilledMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilledMapAggregatedFieldWells`\n\nThe aggregated field well of the filled map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe aggregated color field well of a filled map. Values are aggregated based on location fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapaggregatedfieldwells.html#cfn-quicksight-template-filledmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Geospatial": { "MarkdownDocumentation": "`Geospatial`\n\nThe aggregated location field well of the filled map. Values are grouped by location fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapaggregatedfieldwells.html#cfn-quicksight-template-filledmapaggregatedfieldwells-geospatial", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FilledMapConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilledMapConditionalFormatting`\n\nThe conditional formatting of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options of a `FilledMapVisual`.\n*Required*: Yes\n*Type*: Array of [FilledMapConditionalFormattingOption](./aws-properties-quicksight-template-filledmapconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconditionalformatting.html#cfn-quicksight-template-filledmapconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FilledMapConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FilledMapConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilledMapConditionalFormattingOption`\n\nConditional formatting options of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconditionalformattingoption.html", "Properties": { "Shape": { "MarkdownDocumentation": "`Shape`\n\nThe conditional formatting that determines the shape of the filled map.\n*Required*: Yes\n*Type*: [FilledMapShapeConditionalFormatting](./aws-properties-quicksight-template-filledmapshapeconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconditionalformattingoption.html#cfn-quicksight-template-filledmapconditionalformattingoption-shape", "UpdateType": "Mutable", "Required": true, "Type": "FilledMapShapeConditionalFormatting" } } }, "AWS::QuickSight::Template.FilledMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilledMapConfiguration`\n\nThe configuration for a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `FilledMapVisual`.\n*Required*: No\n*Type*: [FilledMapSortConfiguration](./aws-properties-quicksight-template-filledmapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "MapStyleOptions": { "MarkdownDocumentation": "`MapStyleOptions`\n\nThe map style options of the filled map visual.\n*Required*: No\n*Type*: [GeospatialMapStyleOptions](./aws-properties-quicksight-template-geospatialmapstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-mapstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapStyleOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [FilledMapFieldWells](./aws-properties-quicksight-template-filledmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "WindowOptions": { "MarkdownDocumentation": "`WindowOptions`\n\nThe window options of the filled map visual.\n*Required*: No\n*Type*: [GeospatialWindowOptions](./aws-properties-quicksight-template-geospatialwindowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-windowoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialWindowOptions" } } }, "AWS::QuickSight::Template.FilledMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilledMapFieldWells`\n\nThe field wells of a `FilledMapVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapfieldwells.html", "Properties": { "FilledMapAggregatedFieldWells": { "MarkdownDocumentation": "`FilledMapAggregatedFieldWells`\n\nThe aggregated field well of the filled map.\n*Required*: No\n*Type*: [FilledMapAggregatedFieldWells](./aws-properties-quicksight-template-filledmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapfieldwells.html#cfn-quicksight-template-filledmapfieldwells-filledmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapAggregatedFieldWells" } } }, "AWS::QuickSight::Template.FilledMapShapeConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilledMapShapeConditionalFormatting`\n\nThe conditional formatting that determines the shape of the filled map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapshapeconditionalformatting.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe conditional formatting that determines the background color of a filled map's shape.\n*Required*: No\n*Type*: [ShapeConditionalFormat](./aws-properties-quicksight-template-shapeconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapshapeconditionalformatting.html#cfn-quicksight-template-filledmapshapeconditionalformatting-format", "UpdateType": "Mutable", "Required": false, "Type": "ShapeConditionalFormat" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the filled map shape.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapshapeconditionalformatting.html#cfn-quicksight-template-filledmapshapeconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FilledMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilledMapSortConfiguration`\n\nThe sort configuration of a `FilledMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapsortconfiguration.html", "Properties": { "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the location fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapsortconfiguration.html#cfn-quicksight-template-filledmapsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FilledMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilledMapVisual`\n\nA filled map.\nFor more information, see [Creating filled maps](https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a `FilledMapVisual`.\n*Required*: No\n*Type*: [FilledMapConditionalFormatting](./aws-properties-quicksight-template-filledmapconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [FilledMapConfiguration](./aws-properties-quicksight-template-filledmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.Filter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.Filter`\n\nWith a `Filter`, you can remove portions of data from a particular visual or view.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html", "Properties": { "NestedFilter": { "MarkdownDocumentation": "`NestedFilter`\n\nA `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.\n*Required*: No\n*Type*: [NestedFilter](./aws-properties-quicksight-template-nestedfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-nestedfilter", "UpdateType": "Mutable", "Required": false, "Type": "NestedFilter" }, "NumericEqualityFilter": { "MarkdownDocumentation": "`NumericEqualityFilter`\n\nA `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value.\n*Required*: No\n*Type*: [NumericEqualityFilter](./aws-properties-quicksight-template-numericequalityfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-numericequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericEqualityFilter" }, "NumericRangeFilter": { "MarkdownDocumentation": "`NumericRangeFilter`\n\nA `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range.\n*Required*: No\n*Type*: [NumericRangeFilter](./aws-properties-quicksight-template-numericrangefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-numericrangefilter", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilter" }, "TimeRangeFilter": { "MarkdownDocumentation": "`TimeRangeFilter`\n\nA `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range.\n*Required*: No\n*Type*: [TimeRangeFilter](./aws-properties-quicksight-template-timerangefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-timerangefilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilter" }, "RelativeDatesFilter": { "MarkdownDocumentation": "`RelativeDatesFilter`\n\nA `RelativeDatesFilter` filters date values that are relative to a given date.\n*Required*: No\n*Type*: [RelativeDatesFilter](./aws-properties-quicksight-template-relativedatesfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-relativedatesfilter", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDatesFilter" }, "TopBottomFilter": { "MarkdownDocumentation": "`TopBottomFilter`\n\nA `TopBottomFilter` filters data to the top or bottom values for a given column.\n*Required*: No\n*Type*: [TopBottomFilter](./aws-properties-quicksight-template-topbottomfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-topbottomfilter", "UpdateType": "Mutable", "Required": false, "Type": "TopBottomFilter" }, "TimeEqualityFilter": { "MarkdownDocumentation": "`TimeEqualityFilter`\n\nA `TimeEqualityFilter` filters date-time values that equal or do not equal\na given date/time value.\n*Required*: No\n*Type*: [TimeEqualityFilter](./aws-properties-quicksight-template-timeequalityfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-timeequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "TimeEqualityFilter" }, "CategoryFilter": { "MarkdownDocumentation": "`CategoryFilter`\n\nA `CategoryFilter` filters text values.\nFor more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [CategoryFilter](./aws-properties-quicksight-template-categoryfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-categoryfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryFilter" } } }, "AWS::QuickSight::Template.FilterControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterControl`\n\nThe control of a filter that is used to interact with a dashboard or an analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html", "Properties": { "Slider": { "MarkdownDocumentation": "`Slider`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n*Required*: No\n*Type*: [FilterSliderControl](./aws-properties-quicksight-template-filterslidercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-slider", "UpdateType": "Mutable", "Required": false, "Type": "FilterSliderControl" }, "TextArea": { "MarkdownDocumentation": "`TextArea`\n\nA control to display a text box that is used to enter multiple entries.\n*Required*: No\n*Type*: [FilterTextAreaControl](./aws-properties-quicksight-template-filtertextareacontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-textarea", "UpdateType": "Mutable", "Required": false, "Type": "FilterTextAreaControl" }, "Dropdown": { "MarkdownDocumentation": "`Dropdown`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n*Required*: No\n*Type*: [FilterDropDownControl](./aws-properties-quicksight-template-filterdropdowncontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-dropdown", "UpdateType": "Mutable", "Required": false, "Type": "FilterDropDownControl" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nA control to display a text box that is used to enter a single entry.\n*Required*: No\n*Type*: [FilterTextFieldControl](./aws-properties-quicksight-template-filtertextfieldcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-textfield", "UpdateType": "Mutable", "Required": false, "Type": "FilterTextFieldControl" }, "List": { "MarkdownDocumentation": "`List`\n\nA control to display a list of buttons or boxes. This is used to select either a single value or multiple values.\n*Required*: No\n*Type*: [FilterListControl](./aws-properties-quicksight-template-filterlistcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-list", "UpdateType": "Mutable", "Required": false, "Type": "FilterListControl" }, "DateTimePicker": { "MarkdownDocumentation": "`DateTimePicker`\n\nA control from a date filter that is used to specify date and time.\n*Required*: No\n*Type*: [FilterDateTimePickerControl](./aws-properties-quicksight-template-filterdatetimepickercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-datetimepicker", "UpdateType": "Mutable", "Required": false, "Type": "FilterDateTimePickerControl" }, "RelativeDateTime": { "MarkdownDocumentation": "`RelativeDateTime`\n\nA control from a date filter that is used to specify the relative date.\n*Required*: No\n*Type*: [FilterRelativeDateTimeControl](./aws-properties-quicksight-template-filterrelativedatetimecontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-relativedatetime", "UpdateType": "Mutable", "Required": false, "Type": "FilterRelativeDateTimeControl" }, "CrossSheet": { "MarkdownDocumentation": "`CrossSheet`\n\nA control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet\n*Required*: No\n*Type*: [FilterCrossSheetControl](./aws-properties-quicksight-template-filtercrosssheetcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-crosssheet", "UpdateType": "Mutable", "Required": false, "Type": "FilterCrossSheetControl" } } }, "AWS::QuickSight::Template.FilterCrossSheetControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterCrossSheetControl`\n\nA control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercrosssheetcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterCrossSheetControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercrosssheetcontrol.html#cfn-quicksight-template-filtercrosssheetcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-template-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercrosssheetcontrol.html#cfn-quicksight-template-filtercrosssheetcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterCrossSheetControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercrosssheetcontrol.html#cfn-quicksight-template-filtercrosssheetcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FilterDateTimePickerControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterDateTimePickerControl`\n\nA control from a date filter that is used to specify date and time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_VALUED | DATE_RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_VALUED", "DATE_RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterDateTimePickerControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configurationof the Apply button on a `DateTimePickerControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FilterDropDownControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterDropDownControl`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterDropDownControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from a dropdown menu.\n* `SINGLE_SELECT`: The user can select a single entry from a dropdown menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of the `FilterDropDownControl`.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-template-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-template-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterDropDownControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-template-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Template.FilterGroup": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterGroup`\n\nA grouping of individual filters. Filter groups are applied to the same group of visuals.\nFor more information, see [Adding filter conditions (group filters) with AND and OR operators](https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the `FilterGroup`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe list of filters that are present in a `FilterGroup`.\n*Required*: Yes\n*Type*: Array of [Filter](./aws-properties-quicksight-template-filter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-filters", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": true }, "CrossDataset": { "MarkdownDocumentation": "`CrossDataset`\n\nThe filter new feature which can apply filter group to all data sets. Choose one of the following options:\n* `ALL_DATASETS`\n* `SINGLE_DATASET`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_DATASETS | SINGLE_DATAS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_DATASETS", "SINGLE_DATASET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-crossdataset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ScopeConfiguration": { "MarkdownDocumentation": "`ScopeConfiguration`\n\nThe configuration that specifies what scope to apply to a `FilterGroup`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: [FilterScopeConfiguration](./aws-properties-quicksight-template-filterscopeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-scopeconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FilterScopeConfiguration" }, "FilterGroupId": { "MarkdownDocumentation": "`FilterGroupId`\n\nThe value that uniquely identifies a `FilterGroup` within a dashboard, template, or analysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-filtergroupid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FilterListConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterListConfiguration`\n\nA list of filter configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html", "Properties": { "CategoryValues": { "MarkdownDocumentation": "`CategoryValues`\n\nThe list of category values for the filter.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `512 | 100000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html#cfn-quicksight-template-filterlistconfiguration-categoryvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html#cfn-quicksight-template-filterlistconfiguration-nulloption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_NOT_EQUAL | C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html#cfn-quicksight-template-filterlistconfiguration-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html#cfn-quicksight-template-filterlistconfiguration-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FilterListControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterListControl`\n\nA control to display a list of buttons or boxes. This is used to select either a single value or multiple values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterListControl`. Choose one of the following options:\n* `MULTI_SELECT`: The user can select multiple entries from the list.\n* `SINGLE_SELECT`: The user can select a single entry from the list.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-template-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-template-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterListControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [FilterSelectableValues](./aws-properties-quicksight-template-filterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "FilterSelectableValues" } } }, "AWS::QuickSight::Template.FilterOperationSelectedFieldsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterOperationSelectedFieldsConfiguration`\n\nThe configuration of selected fields in the`CustomActionFilterOperation`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.html", "Properties": { "SelectedColumns": { "MarkdownDocumentation": "`SelectedColumns`\n\nThe selected columns of a dataset.\n*Required*: No\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-template-filteroperationselectedfieldsconfiguration-selectedcolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true }, "SelectedFields": { "MarkdownDocumentation": "`SelectedFields`\n\nChooses the fields that are filtered in `CustomActionFilterOperation`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `512 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-template-filteroperationselectedfieldsconfiguration-selectedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nA structure that contains the options that choose which fields are filtered in the `CustomActionFilterOperation`.\nValid values are defined as follows:\n* `ALL_FIELDS`: Applies the filter operation to all fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_FIELDS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL_FIELDS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-template-filteroperationselectedfieldsconfiguration-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FilterOperationTargetVisualsConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterOperationTargetVisualsConfiguration`\n\nThe configuration of target visuals that you want to be filtered.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationtargetvisualsconfiguration.html", "Properties": { "SameSheetTargetVisualConfiguration": { "MarkdownDocumentation": "`SameSheetTargetVisualConfiguration`\n\nThe configuration of the same-sheet target visuals that you want to be filtered.\n*Required*: No\n*Type*: [SameSheetTargetVisualConfiguration](./aws-properties-quicksight-template-samesheettargetvisualconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationtargetvisualsconfiguration.html#cfn-quicksight-template-filteroperationtargetvisualsconfiguration-samesheettargetvisualconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SameSheetTargetVisualConfiguration" } } }, "AWS::QuickSight::Template.FilterRelativeDateTimeControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterRelativeDateTimeControl`\n\nA control from a date filter that is used to specify the relative date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [RelativeDateTimeControlDisplayOptions](./aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "RelativeDateTimeControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `FilterRelativeDateTimeControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FilterScopeConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterScopeConfiguration`\n\nThe scope configuration for a `FilterGroup`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterscopeconfiguration.html", "Properties": { "AllSheets": { "MarkdownDocumentation": "`AllSheets`\n\nThe configuration that applies a filter to all sheets. When you choose `AllSheets` as the value for a `FilterScopeConfiguration`, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The `AllSheetsFilterScopeConfiguration` is chosen.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterscopeconfiguration.html#cfn-quicksight-template-filterscopeconfiguration-allsheets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "SelectedSheets": { "MarkdownDocumentation": "`SelectedSheets`\n\nThe configuration for applying a filter to specific sheets.\n*Required*: No\n*Type*: [SelectedSheetsFilterScopeConfiguration](./aws-properties-quicksight-template-selectedsheetsfilterscopeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterscopeconfiguration.html#cfn-quicksight-template-filterscopeconfiguration-selectedsheets", "UpdateType": "Mutable", "Required": false, "Type": "SelectedSheetsFilterScopeConfiguration" } } }, "AWS::QuickSight::Template.FilterSelectableValues": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterSelectableValues`\n\nA list of selectable values that are used in a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterselectablevalues.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are used in the `FilterSelectableValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterselectablevalues.html#cfn-quicksight-template-filterselectablevalues-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FilterSliderControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterSliderControl`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the `FilterSliderControl`. Choose one of the following options:\n* `SINGLE_POINT`: Filter against(equals) a single data point.\n* `RANGE`: Filter data that is in a specified range.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_POINT | RANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_POINT", "RANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-template-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterSliderControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.FilterTextAreaControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterTextAreaControl`\n\nA control to display a text box that is used to enter multiple entries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-template-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FilterTextFieldControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FilterTextFieldControl`\n\nA control to display a text box that is used to enter a single entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html", "Properties": { "FilterControlId": { "MarkdownDocumentation": "`FilterControlId`\n\nThe ID of the `FilterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html#cfn-quicksight-template-filtertextfieldcontrol-filtercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-template-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html#cfn-quicksight-template-filtertextfieldcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `FilterTextFieldControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html#cfn-quicksight-template-filtertextfieldcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceFilterId": { "MarkdownDocumentation": "`SourceFilterId`\n\nThe source filter ID of the `FilterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html#cfn-quicksight-template-filtertextfieldcontrol-sourcefilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FontConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FontConfiguration`\n\nConfigures the display properties of the given text.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html", "Properties": { "FontFamily": { "MarkdownDocumentation": "`FontFamily`\n\nThe font family that you want 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontfamily", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontStyle": { "MarkdownDocumentation": "`FontStyle`\n\nDetermines the text display face that is inherited by the given font family.\n*Required*: No\n*Type*: String\n*Allowed values*: `NORMAL | ITALIC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NORMAL", "ITALIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontSize": { "MarkdownDocumentation": "`FontSize`\n\nThe option that determines the text display size.\n*Required*: No\n*Type*: [FontSize](./aws-properties-quicksight-template-fontsize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontsize", "UpdateType": "Mutable", "Required": false, "Type": "FontSize" }, "FontDecoration": { "MarkdownDocumentation": "`FontDecoration`\n\nDetermines the appearance of decorative lines on the text.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNDERLINE | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNDERLINE", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontdecoration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontColor": { "MarkdownDocumentation": "`FontColor`\n\nDetermines the color of the text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontWeight": { "MarkdownDocumentation": "`FontWeight`\n\nThe option that determines the text display weight, or boldness.\n*Required*: No\n*Type*: [FontWeight](./aws-properties-quicksight-template-fontweight.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontweight", "UpdateType": "Mutable", "Required": false, "Type": "FontWeight" } } }, "AWS::QuickSight::Template.FontSize": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FontSize`\n\nThe option that determines the text display size.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontsize.html", "Properties": { "Relative": { "MarkdownDocumentation": "`Relative`\n\nThe lexical name for the text size, proportional to its surrounding context.\n*Required*: No\n*Type*: String\n*Allowed values*: `EXTRA_SMALL | SMALL | MEDIU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontsize.html#cfn-quicksight-template-fontsize-relative", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Absolute": { "MarkdownDocumentation": "`Absolute`\n\nThe font size that you want to use in px.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontsize.html#cfn-quicksight-template-fontsize-absolute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FontWeight": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FontWeight`\n\nThe option that determines the text display weight, or boldness.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontweight.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe lexical name for the level of boldness of the text display.\n*Required*: No\n*Type*: String\n*Allowed values*: `NORMAL | BOLD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NORMAL", "BOLD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontweight.html#cfn-quicksight-template-fontweight-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ForecastComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ForecastComputation`\n\nThe forecast computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html", "Properties": { "PeriodsBackward": { "MarkdownDocumentation": "`PeriodsBackward`\n\nThe periods backward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-periodsbackward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PeriodsForward": { "MarkdownDocumentation": "`PeriodsForward`\n\nThe periods forward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-periodsforward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PredictionInterval": { "MarkdownDocumentation": "`PredictionInterval`\n\nThe prediction interval setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `50`\n*Maximum*: `95`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-predictioninterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Seasonality": { "MarkdownDocumentation": "`Seasonality`\n\nThe seasonality setup of a forecast computation. Choose one of the following options:\n* `AUTOMATIC`\n* `CUSTOM`: Checks the custom seasonality value.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTOMATIC | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-seasonality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomSeasonalityValue": { "MarkdownDocumentation": "`CustomSeasonalityValue`\n\nThe custom seasonality value setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `180`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-customseasonalityvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "UpperBoundary": { "MarkdownDocumentation": "`UpperBoundary`\n\nThe upper boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-upperboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LowerBoundary": { "MarkdownDocumentation": "`LowerBoundary`\n\nThe lower boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-lowerboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.ForecastConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ForecastConfiguration`\n\nThe forecast configuration that is used in a line chart's display properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastconfiguration.html", "Properties": { "ForecastProperties": { "MarkdownDocumentation": "`ForecastProperties`\n\nThe forecast properties setup of a forecast in the line\nchart.\n*Required*: No\n*Type*: [TimeBasedForecastProperties](./aws-properties-quicksight-template-timebasedforecastproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastconfiguration.html#cfn-quicksight-template-forecastconfiguration-forecastproperties", "UpdateType": "Mutable", "Required": false, "Type": "TimeBasedForecastProperties" }, "Scenario": { "MarkdownDocumentation": "`Scenario`\n\nThe forecast scenario of a forecast in the line chart.\n*Required*: No\n*Type*: [ForecastScenario](./aws-properties-quicksight-template-forecastscenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastconfiguration.html#cfn-quicksight-template-forecastconfiguration-scenario", "UpdateType": "Mutable", "Required": false, "Type": "ForecastScenario" } } }, "AWS::QuickSight::Template.ForecastScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ForecastScenario`\n\nThe forecast scenario of a forecast in the line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastscenario.html", "Properties": { "WhatIfRangeScenario": { "MarkdownDocumentation": "`WhatIfRangeScenario`\n\nThe what-if analysis forecast setup with the date range.\n*Required*: No\n*Type*: [WhatIfRangeScenario](./aws-properties-quicksight-template-whatifrangescenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastscenario.html#cfn-quicksight-template-forecastscenario-whatifrangescenario", "UpdateType": "Mutable", "Required": false, "Type": "WhatIfRangeScenario" }, "WhatIfPointScenario": { "MarkdownDocumentation": "`WhatIfPointScenario`\n\nThe what-if analysis forecast setup with the target date.\n*Required*: No\n*Type*: [WhatIfPointScenario](./aws-properties-quicksight-template-whatifpointscenario.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastscenario.html#cfn-quicksight-template-forecastscenario-whatifpointscenario", "UpdateType": "Mutable", "Required": false, "Type": "WhatIfPointScenario" } } }, "AWS::QuickSight::Template.FormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FormatConfiguration`\n\nThe formatting configuration for all types of field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-formatconfiguration.html", "Properties": { "NumberFormatConfiguration": { "MarkdownDocumentation": "`NumberFormatConfiguration`\n\nFormatting configuration for number fields.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-template-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-formatconfiguration.html#cfn-quicksight-template-formatconfiguration-numberformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "DateTimeFormatConfiguration": { "MarkdownDocumentation": "`DateTimeFormatConfiguration`\n\nFormatting configuration for `DateTime` fields.\n*Required*: No\n*Type*: [DateTimeFormatConfiguration](./aws-properties-quicksight-template-datetimeformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-formatconfiguration.html#cfn-quicksight-template-formatconfiguration-datetimeformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeFormatConfiguration" }, "StringFormatConfiguration": { "MarkdownDocumentation": "`StringFormatConfiguration`\n\nFormatting configuration for string fields.\n*Required*: No\n*Type*: [StringFormatConfiguration](./aws-properties-quicksight-template-stringformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-formatconfiguration.html#cfn-quicksight-template-formatconfiguration-stringformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StringFormatConfiguration" } } }, "AWS::QuickSight::Template.FreeFormLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FreeFormLayoutCanvasSizeOptions`\n\nConfiguration options for the canvas of a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutcanvassizeoptions.html", "Properties": { "ScreenCanvasSizeOptions": { "MarkdownDocumentation": "`ScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a free-form layout.\n*Required*: No\n*Type*: [FreeFormLayoutScreenCanvasSizeOptions](./aws-properties-quicksight-template-freeformlayoutscreencanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutcanvassizeoptions.html#cfn-quicksight-template-freeformlayoutcanvassizeoptions-screencanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutScreenCanvasSizeOptions" } } }, "AWS::QuickSight::Template.FreeFormLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FreeFormLayoutConfiguration`\n\nThe configuration of a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [FreeFormLayoutCanvasSizeOptions](./aws-properties-quicksight-template-freeformlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutconfiguration.html#cfn-quicksight-template-freeformlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutCanvasSizeOptions" }, "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in a free-form layout.\n*Required*: Yes\n*Type*: Array of [FreeFormLayoutElement](./aws-properties-quicksight-template-freeformlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutconfiguration.html#cfn-quicksight-template-freeformlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FreeFormLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FreeFormLayoutElement": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FreeFormLayoutElement`\n\nAn element within a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html", "Properties": { "ElementType": { "MarkdownDocumentation": "`ElementType`\n\nThe type of element.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VISUAL | FILTER_CONTROL | P...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VISUAL", "FILTER_CONTROL", "PARAMETER_CONTROL", "TEXT_BOX", "IMAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-elementtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BorderStyle": { "MarkdownDocumentation": "`BorderStyle`\n\nThe border style configuration of a free-form layout element.\n*Required*: No\n*Type*: [FreeFormLayoutElementBorderStyle](./aws-properties-quicksight-template-freeformlayoutelementborderstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-borderstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBorderStyle" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-height", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of an element within a free-form layout.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "RenderingRules": { "MarkdownDocumentation": "`RenderingRules`\n\nThe rendering rules that determine when an element should be displayed within a free-form layout.\n*Required*: No\n*Type*: Array of [SheetElementRenderingRule](./aws-properties-quicksight-template-sheetelementrenderingrule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-renderingrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetElementRenderingRule", "DuplicatesAllowed": true }, "YAxisLocation": { "MarkdownDocumentation": "`YAxisLocation`\n\nThe y-axis coordinate of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-yaxislocation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LoadingAnimation": { "MarkdownDocumentation": "`LoadingAnimation`\n\nThe loading animation configuration of a free-form layout element.\n*Required*: No\n*Type*: [LoadingAnimation](./aws-properties-quicksight-template-loadinganimation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-loadinganimation", "UpdateType": "Mutable", "Required": false, "Type": "LoadingAnimation" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-width", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BackgroundStyle": { "MarkdownDocumentation": "`BackgroundStyle`\n\nThe background style configuration of a free-form layout element.\n*Required*: No\n*Type*: [FreeFormLayoutElementBackgroundStyle](./aws-properties-quicksight-template-freeformlayoutelementbackgroundstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-backgroundstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBackgroundStyle" }, "ElementId": { "MarkdownDocumentation": "`ElementId`\n\nA unique identifier for an element within a free-form layout.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-elementid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "XAxisLocation": { "MarkdownDocumentation": "`XAxisLocation`\n\nThe x-axis coordinate of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-xaxislocation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectedBorderStyle": { "MarkdownDocumentation": "`SelectedBorderStyle`\n\nThe border style configuration of a free-form layout element. This border style is used when the element is selected.\n*Required*: No\n*Type*: [FreeFormLayoutElementBorderStyle](./aws-properties-quicksight-template-freeformlayoutelementborderstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-selectedborderstyle", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutElementBorderStyle" } } }, "AWS::QuickSight::Template.FreeFormLayoutElementBackgroundStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FreeFormLayoutElementBackgroundStyle`\n\nThe background style configuration of a free-form layout element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementbackgroundstyle.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe background color of a free-form layout element.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-template-freeformlayoutelementbackgroundstyle-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe background visibility of a free-form layout element.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-template-freeformlayoutelementbackgroundstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.FreeFormLayoutElementBorderStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FreeFormLayoutElementBorderStyle`\n\nThe background style configuration of a free-form layout element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementborderstyle.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe border color of a free-form layout element.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementborderstyle.html#cfn-quicksight-template-freeformlayoutelementborderstyle-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe border visibility of a free-form layout element.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementborderstyle.html#cfn-quicksight-template-freeformlayoutelementborderstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.FreeFormLayoutScreenCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FreeFormLayoutScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutscreencanvassizeoptions.html", "Properties": { "OptimizedViewPortWidth": { "MarkdownDocumentation": "`OptimizedViewPortWidth`\n\nThe width that the view port will be optimized for when the layout renders.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutscreencanvassizeoptions.html#cfn-quicksight-template-freeformlayoutscreencanvassizeoptions-optimizedviewportwidth", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.FreeFormSectionLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FreeFormSectionLayoutConfiguration`\n\nThe free-form layout configuration of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformsectionlayoutconfiguration.html", "Properties": { "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in the free-form layout.\n*Required*: Yes\n*Type*: Array of [FreeFormLayoutElement](./aws-properties-quicksight-template-freeformlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformsectionlayoutconfiguration.html#cfn-quicksight-template-freeformsectionlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FreeFormLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FunnelChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FunnelChartAggregatedFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field wells of a funnel chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartaggregatedfieldwells.html#cfn-quicksight-template-funnelchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a funnel chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartaggregatedfieldwells.html#cfn-quicksight-template-funnelchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FunnelChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FunnelChartConfiguration`\n\nThe configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartSortConfiguration](./aws-properties-quicksight-template-funnelchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartSortConfiguration" }, "DataLabelOptions": { "MarkdownDocumentation": "`DataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n*Required*: No\n*Type*: [FunnelChartDataLabelOptions](./aws-properties-quicksight-template-funnelchartdatalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-datalabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartDataLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options of the categories that are displayed in a `FunnelChartVisual`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartFieldWells](./aws-properties-quicksight-template-funnelchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options for the values that are displayed in a `FunnelChartVisual`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Template.FunnelChartDataLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FunnelChartDataLabelOptions`\n\nThe options that determine the presentation of the data labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html", "Properties": { "MeasureLabelVisibility": { "MarkdownDocumentation": "`MeasureLabelVisibility`\n\nThe visibility of the measure labels within the data labels.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-measurelabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Position": { "MarkdownDocumentation": "`Position`\n\nDetermines the positioning of the data label relative to a section of the funnel.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSIDE | OUTSIDE | LEFT | T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSIDE", "OUTSIDE", "LEFT", "TOP", "BOTTOM", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility option that determines if data labels are displayed.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "CategoryLabelVisibility": { "MarkdownDocumentation": "`CategoryLabelVisibility`\n\nThe visibility of the category labels within the data labels.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-categorylabelvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LabelColor": { "MarkdownDocumentation": "`LabelColor`\n\nThe color of the data label text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-labelcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MeasureDataLabelStyle": { "MarkdownDocumentation": "`MeasureDataLabelStyle`\n\nDetermines the style of the metric labels.\n*Required*: No\n*Type*: String\n*Allowed values*: `VALUE_ONLY | PERCENTAGE_BY_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VALUE_ONLY", "PERCENTAGE_BY_FIRST_STAGE", "PERCENTAGE_BY_PREVIOUS_STAGE", "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-measuredatalabelstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LabelFontConfiguration": { "MarkdownDocumentation": "`LabelFontConfiguration`\n\nThe font configuration for the data labels.\nOnly the `FontSize` attribute of the font configuration is used for data labels.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-labelfontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Template.FunnelChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FunnelChartFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartfieldwells.html", "Properties": { "FunnelChartAggregatedFieldWells": { "MarkdownDocumentation": "`FunnelChartAggregatedFieldWells`\n\nThe field well configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartAggregatedFieldWells](./aws-properties-quicksight-template-funnelchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartfieldwells.html#cfn-quicksight-template-funnelchartfieldwells-funnelchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartAggregatedFieldWells" } } }, "AWS::QuickSight::Template.FunnelChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FunnelChartSortConfiguration`\n\nThe sort configuration of a `FunnelChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartsortconfiguration.html", "Properties": { "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartsortconfiguration.html#cfn-quicksight-template-funnelchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartsortconfiguration.html#cfn-quicksight-template-funnelchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.FunnelChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.FunnelChartVisual`\n\nA funnel chart.\nFor more information, see [Using funnel charts](https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `FunnelChartVisual`.\n*Required*: No\n*Type*: [FunnelChartConfiguration](./aws-properties-quicksight-template-funnelchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.GaugeChartArcConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartArcConditionalFormatting`\n\nThe options that determine the presentation of the arc of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartarcconditionalformatting.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe conditional formatting of the arc foreground color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartarcconditionalformatting.html#cfn-quicksight-template-gaugechartarcconditionalformatting-foregroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Template.GaugeChartColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartColorConfiguration`\n\nThe color configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartcolorconfiguration.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe foreground color configuration of a `GaugeChartVisual`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartcolorconfiguration.html#cfn-quicksight-template-gaugechartcolorconfiguration-foregroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color configuration of a `GaugeChartVisual`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartcolorconfiguration.html#cfn-quicksight-template-gaugechartcolorconfiguration-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.GaugeChartConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartConditionalFormatting`\n\nThe conditional formatting of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [GaugeChartConditionalFormattingOption](./aws-properties-quicksight-template-gaugechartconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformatting.html#cfn-quicksight-template-gaugechartconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GaugeChartConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.GaugeChartConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartConditionalFormattingOption`\n\nConditional formatting options of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformattingoption.html", "Properties": { "Arc": { "MarkdownDocumentation": "`Arc`\n\nThe options that determine the presentation of the arc of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartArcConditionalFormatting](./aws-properties-quicksight-template-gaugechartarcconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformattingoption.html#cfn-quicksight-template-gaugechartconditionalformattingoption-arc", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartArcConditionalFormatting" }, "PrimaryValue": { "MarkdownDocumentation": "`PrimaryValue`\n\nThe conditional formatting for the primary value of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartPrimaryValueConditionalFormatting](./aws-properties-quicksight-template-gaugechartprimaryvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformattingoption.html#cfn-quicksight-template-gaugechartconditionalformattingoption-primaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartPrimaryValueConditionalFormatting" } } }, "AWS::QuickSight::Template.GaugeChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartConfiguration`\n\nThe configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html", "Properties": { "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartFieldWells](./aws-properties-quicksight-template-gaugechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartFieldWells" }, "TooltipOptions": { "MarkdownDocumentation": "`TooltipOptions`\n\nThe tooltip configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-tooltipoptions", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "GaugeChartOptions": { "MarkdownDocumentation": "`GaugeChartOptions`\n\nThe options that determine the presentation of the `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartOptions](./aws-properties-quicksight-template-gaugechartoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-gaugechartoptions", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartOptions" }, "ColorConfiguration": { "MarkdownDocumentation": "`ColorConfiguration`\n\nThe color configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartColorConfiguration](./aws-properties-quicksight-template-gaugechartcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-colorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartColorConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Template.GaugeChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartFieldWells`\n\nThe field well configuration of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartfieldwells.html", "Properties": { "TargetValues": { "MarkdownDocumentation": "`TargetValues`\n\nThe target value field wells of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartfieldwells.html#cfn-quicksight-template-gaugechartfieldwells-targetvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a `GaugeChartVisual`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartfieldwells.html#cfn-quicksight-template-gaugechartfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.GaugeChartOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartOptions`\n\nThe options that determine the presentation of the `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html", "Properties": { "Arc": { "MarkdownDocumentation": "`Arc`\n\nThe arc configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcConfiguration](./aws-properties-quicksight-template-arcconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-arc", "UpdateType": "Mutable", "Required": false, "Type": "ArcConfiguration" }, "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe comparison configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ComparisonConfiguration](./aws-properties-quicksight-template-comparisonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-comparison", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonConfiguration" }, "PrimaryValueDisplayType": { "MarkdownDocumentation": "`PrimaryValueDisplayType`\n\nThe options that determine the primary value display type.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | COMPARISON | ACTUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "COMPARISON", "ACTUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-primaryvaluedisplaytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ArcAxis": { "MarkdownDocumentation": "`ArcAxis`\n\nThe arc axis configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [ArcAxisConfiguration](./aws-properties-quicksight-template-arcaxisconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-arcaxis", "UpdateType": "Mutable", "Required": false, "Type": "ArcAxisConfiguration" }, "PrimaryValueFontConfiguration": { "MarkdownDocumentation": "`PrimaryValueFontConfiguration`\n\nThe options that determine the primary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-primaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Template.GaugeChartPrimaryValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartPrimaryValueConditionalFormatting`\n\nThe conditional formatting for the primary value of a `GaugeChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartprimaryvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the primary value text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-template-gaugechartprimaryvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the primary value icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-template-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-template-gaugechartprimaryvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Template.GaugeChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GaugeChartVisual`\n\nA gauge chart.\nFor more information, see [Using gauge charts](https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartConditionalFormatting](./aws-properties-quicksight-template-gaugechartconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a `GaugeChartVisual`.\n*Required*: No\n*Type*: [GaugeChartConfiguration](./aws-properties-quicksight-template-gaugechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.GeospatialCoordinateBounds": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialCoordinateBounds`\n\nThe bound\noptions (north, south, west, east) of the geospatial window options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html", "Properties": { "West": { "MarkdownDocumentation": "`West`\n\nThe longitude of the west bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-1800`\n*Maximum*: `1800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html#cfn-quicksight-template-geospatialcoordinatebounds-west", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "South": { "MarkdownDocumentation": "`South`\n\nThe latitude of the south bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-90`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html#cfn-quicksight-template-geospatialcoordinatebounds-south", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "North": { "MarkdownDocumentation": "`North`\n\nThe latitude of the north bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-90`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html#cfn-quicksight-template-geospatialcoordinatebounds-north", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "East": { "MarkdownDocumentation": "`East`\n\nThe longitude of the east bound of the geospatial coordinate bounds.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `-1800`\n*Maximum*: `1800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html#cfn-quicksight-template-geospatialcoordinatebounds-east", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.GeospatialHeatmapColorScale": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialHeatmapColorScale`\n\nThe color scale specification for the heatmap point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapcolorscale.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe list of colors to be used in heatmap point style.\n*Required*: No\n*Type*: Array of [GeospatialHeatmapDataColor](./aws-properties-quicksight-template-geospatialheatmapdatacolor.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapcolorscale.html#cfn-quicksight-template-geospatialheatmapcolorscale-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GeospatialHeatmapDataColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.GeospatialHeatmapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialHeatmapConfiguration`\n\nThe heatmap configuration of the geospatial point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapconfiguration.html", "Properties": { "HeatmapColor": { "MarkdownDocumentation": "`HeatmapColor`\n\nThe color scale specification for the heatmap point style.\n*Required*: No\n*Type*: [GeospatialHeatmapColorScale](./aws-properties-quicksight-template-geospatialheatmapcolorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapconfiguration.html#cfn-quicksight-template-geospatialheatmapconfiguration-heatmapcolor", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialHeatmapColorScale" } } }, "AWS::QuickSight::Template.GeospatialHeatmapDataColor": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialHeatmapDataColor`\n\nThe color to be used in the heatmap point style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapdatacolor.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe hex color to be used in the heatmap point style.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapdatacolor.html#cfn-quicksight-template-geospatialheatmapdatacolor-color", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.GeospatialMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialMapAggregatedFieldWells`\n\nThe aggregated field wells for a geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapaggregatedfieldwells.html", "Properties": { "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field wells of a geospatial map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapaggregatedfieldwells.html#cfn-quicksight-template-geospatialmapaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe size field wells of a geospatial map. Values are aggregated based on geospatial fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapaggregatedfieldwells.html#cfn-quicksight-template-geospatialmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Geospatial": { "MarkdownDocumentation": "`Geospatial`\n\nThe geospatial field wells of a geospatial map. Values are grouped by geospatial fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapaggregatedfieldwells.html#cfn-quicksight-template-geospatialmapaggregatedfieldwells-geospatial", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.GeospatialMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialMapConfiguration`\n\nThe configuration of a `GeospatialMapVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html", "Properties": { "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "MapStyleOptions": { "MarkdownDocumentation": "`MapStyleOptions`\n\nThe map style options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialMapStyleOptions](./aws-properties-quicksight-template-geospatialmapstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-mapstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapStyleOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [GeospatialMapFieldWells](./aws-properties-quicksight-template-geospatialmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "WindowOptions": { "MarkdownDocumentation": "`WindowOptions`\n\nThe window options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialWindowOptions](./aws-properties-quicksight-template-geospatialwindowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-windowoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialWindowOptions" }, "PointStyleOptions": { "MarkdownDocumentation": "`PointStyleOptions`\n\nThe point style options of the geospatial map.\n*Required*: No\n*Type*: [GeospatialPointStyleOptions](./aws-properties-quicksight-template-geospatialpointstyleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-pointstyleoptions", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialPointStyleOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Template.GeospatialMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialMapFieldWells`\n\nThe field wells of a `GeospatialMapVisual`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapfieldwells.html", "Properties": { "GeospatialMapAggregatedFieldWells": { "MarkdownDocumentation": "`GeospatialMapAggregatedFieldWells`\n\nThe aggregated field well for a geospatial map.\n*Required*: No\n*Type*: [GeospatialMapAggregatedFieldWells](./aws-properties-quicksight-template-geospatialmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapfieldwells.html#cfn-quicksight-template-geospatialmapfieldwells-geospatialmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapAggregatedFieldWells" } } }, "AWS::QuickSight::Template.GeospatialMapStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialMapStyleOptions`\n\nThe map style options of the geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapstyleoptions.html", "Properties": { "BaseMapStyle": { "MarkdownDocumentation": "`BaseMapStyle`\n\nThe base map style of the geospatial map.\n*Required*: No\n*Type*: String\n*Allowed values*: `LIGHT_GRAY | DARK_GRAY | ST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LIGHT_GRAY", "DARK_GRAY", "STREET", "IMAGERY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapstyleoptions.html#cfn-quicksight-template-geospatialmapstyleoptions-basemapstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.GeospatialMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialMapVisual`\n\nA geospatial map or a points on map visual.\nFor more information, see [Creating point maps](https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [GeospatialMapConfiguration](./aws-properties-quicksight-template-geospatialmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.GeospatialPointStyleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialPointStyleOptions`\n\nThe point style of the geospatial map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialpointstyleoptions.html", "Properties": { "SelectedPointStyle": { "MarkdownDocumentation": "`SelectedPointStyle`\n\nThe selected point styles (point, cluster) of the geospatial map.\n*Required*: No\n*Type*: String\n*Allowed values*: `POINT | CLUSTER | HEATMAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POINT", "CLUSTER", "HEATMAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialpointstyleoptions.html#cfn-quicksight-template-geospatialpointstyleoptions-selectedpointstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterMarkerConfiguration": { "MarkdownDocumentation": "`ClusterMarkerConfiguration`\n\nThe cluster marker configuration of the geospatial point style.\n*Required*: No\n*Type*: [ClusterMarkerConfiguration](./aws-properties-quicksight-template-clustermarkerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialpointstyleoptions.html#cfn-quicksight-template-geospatialpointstyleoptions-clustermarkerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ClusterMarkerConfiguration" }, "HeatmapConfiguration": { "MarkdownDocumentation": "`HeatmapConfiguration`\n\nThe heatmap configuration of the geospatial point style.\n*Required*: No\n*Type*: [GeospatialHeatmapConfiguration](./aws-properties-quicksight-template-geospatialheatmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialpointstyleoptions.html#cfn-quicksight-template-geospatialpointstyleoptions-heatmapconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialHeatmapConfiguration" } } }, "AWS::QuickSight::Template.GeospatialWindowOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GeospatialWindowOptions`\n\nThe window options of the geospatial map visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialwindowoptions.html", "Properties": { "Bounds": { "MarkdownDocumentation": "`Bounds`\n\nThe bounds options (north, south, west, east) of the geospatial window options.\n*Required*: No\n*Type*: [GeospatialCoordinateBounds](./aws-properties-quicksight-template-geospatialcoordinatebounds.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialwindowoptions.html#cfn-quicksight-template-geospatialwindowoptions-bounds", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialCoordinateBounds" }, "MapZoomMode": { "MarkdownDocumentation": "`MapZoomMode`\n\nThe map zoom modes (manual, auto) of the geospatial window options.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialwindowoptions.html#cfn-quicksight-template-geospatialwindowoptions-mapzoommode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.GlobalTableBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GlobalTableBorderOptions`\n\nDetermines the border options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-globaltableborderoptions.html", "Properties": { "UniformBorder": { "MarkdownDocumentation": "`UniformBorder`\n\nDetermines the options for uniform border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-template-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-globaltableborderoptions.html#cfn-quicksight-template-globaltableborderoptions-uniformborder", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "SideSpecificBorder": { "MarkdownDocumentation": "`SideSpecificBorder`\n\nDetermines the options for side specific border.\n*Required*: No\n*Type*: [TableSideBorderOptions](./aws-properties-quicksight-template-tablesideborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-globaltableborderoptions.html#cfn-quicksight-template-globaltableborderoptions-sidespecificborder", "UpdateType": "Mutable", "Required": false, "Type": "TableSideBorderOptions" } } }, "AWS::QuickSight::Template.GradientColor": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GradientColor`\n\nDetermines the gradient color settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientcolor.html", "Properties": { "Stops": { "MarkdownDocumentation": "`Stops`\n\nThe list of gradient color stops.\n*Required*: No\n*Type*: Array of [GradientStop](./aws-properties-quicksight-template-gradientstop.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientcolor.html#cfn-quicksight-template-gradientcolor-stops", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GradientStop", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.GradientStop": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GradientStop`\n\nDetermines the gradient stop configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientstop.html", "Properties": { "GradientOffset": { "MarkdownDocumentation": "`GradientOffset`\n\nDetermines gradient offset value.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientstop.html#cfn-quicksight-template-gradientstop-gradientoffset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DataValue": { "MarkdownDocumentation": "`DataValue`\n\nDetermines the data value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientstop.html#cfn-quicksight-template-gradientstop-datavalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nDetermines the color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientstop.html#cfn-quicksight-template-gradientstop-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.GridLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GridLayoutCanvasSizeOptions`\n\nConfiguration options for the canvas of a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutcanvassizeoptions.html", "Properties": { "ScreenCanvasSizeOptions": { "MarkdownDocumentation": "`ScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a grid layout.\n*Required*: No\n*Type*: [GridLayoutScreenCanvasSizeOptions](./aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutcanvassizeoptions.html#cfn-quicksight-template-gridlayoutcanvassizeoptions-screencanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutScreenCanvasSizeOptions" } } }, "AWS::QuickSight::Template.GridLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GridLayoutConfiguration`\n\nThe configuration for a grid layout. Also called a tiled layout.\nVisuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [GridLayoutCanvasSizeOptions](./aws-properties-quicksight-template-gridlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutconfiguration.html#cfn-quicksight-template-gridlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutCanvasSizeOptions" }, "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements that are included in a grid layout.\n*Required*: Yes\n*Type*: Array of [GridLayoutElement](./aws-properties-quicksight-template-gridlayoutelement.html)\n*Minimum*: `0`\n*Maximum*: `430`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutconfiguration.html#cfn-quicksight-template-gridlayoutconfiguration-elements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GridLayoutElement", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.GridLayoutElement": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GridLayoutElement`\n\nAn element within a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html", "Properties": { "ElementType": { "MarkdownDocumentation": "`ElementType`\n\nThe type of element.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VISUAL | FILTER_CONTROL | P...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VISUAL", "FILTER_CONTROL", "PARAMETER_CONTROL", "TEXT_BOX", "IMAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-elementtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ColumnSpan": { "MarkdownDocumentation": "`ColumnSpan`\n\nThe width of a grid element expressed as a number of grid columns.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-columnspan", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "ColumnIndex": { "MarkdownDocumentation": "`ColumnIndex`\n\nThe column index for the upper left corner of an element.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `35`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-columnindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "RowIndex": { "MarkdownDocumentation": "`RowIndex`\n\nThe row index for the upper left corner of an element.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `9009`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-rowindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "RowSpan": { "MarkdownDocumentation": "`RowSpan`\n\nThe height of a grid element expressed as a number of grid rows.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `21`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-rowspan", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "ElementId": { "MarkdownDocumentation": "`ElementId`\n\nA unique identifier for an element within a grid layout.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-elementid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.GridLayoutScreenCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GridLayoutScreenCanvasSizeOptions`\n\nThe options that determine the sizing of the canvas used in a grid layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.html", "Properties": { "OptimizedViewPortWidth": { "MarkdownDocumentation": "`OptimizedViewPortWidth`\n\nThe width that the view port will be optimized for when the layout renders.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-template-gridlayoutscreencanvassizeoptions-optimizedviewportwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResizeOption": { "MarkdownDocumentation": "`ResizeOption`\n\nThis value determines the layout behavior when the viewport is resized.\n* `FIXED`: A fixed width will be used when optimizing the layout. In\n the Quick Sight console, this option is called `Classic`.\n* `RESPONSIVE`: The width of the canvas will be responsive and\n optimized to the view port. In the Quick Sight console, this option is called `Tiled`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIXED | RESPONSIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIXED", "RESPONSIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-template-gridlayoutscreencanvassizeoptions-resizeoption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.GrowthRateComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.GrowthRateComputation`\n\nThe growth rate computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "PeriodSize": { "MarkdownDocumentation": "`PeriodSize`\n\nThe period size setup of a growth rate computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `2`\n*Maximum*: `52`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-periodsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.HeaderFooterSectionConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HeaderFooterSectionConfiguration`\n\nThe configuration of a header or footer section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-headerfootersectionconfiguration.html", "Properties": { "Layout": { "MarkdownDocumentation": "`Layout`\n\nThe layout configuration of the header or footer section.\n*Required*: Yes\n*Type*: [SectionLayoutConfiguration](./aws-properties-quicksight-template-sectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-headerfootersectionconfiguration.html#cfn-quicksight-template-headerfootersectionconfiguration-layout", "UpdateType": "Mutable", "Required": true, "Type": "SectionLayoutConfiguration" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style options of a header or footer section.\n*Required*: No\n*Type*: [SectionStyle](./aws-properties-quicksight-template-sectionstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-headerfootersectionconfiguration.html#cfn-quicksight-template-headerfootersectionconfiguration-style", "UpdateType": "Mutable", "Required": false, "Type": "SectionStyle" }, "SectionId": { "MarkdownDocumentation": "`SectionId`\n\nThe unique identifier of the header or footer section.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-headerfootersectionconfiguration.html#cfn-quicksight-template-headerfootersectionconfiguration-sectionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.HeatMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HeatMapAggregatedFieldWells`\n\nThe aggregated field wells of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well of a heat map.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapaggregatedfieldwells.html#cfn-quicksight-template-heatmapaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe columns field well of a heat map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapaggregatedfieldwells.html#cfn-quicksight-template-heatmapaggregatedfieldwells-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Rows": { "MarkdownDocumentation": "`Rows`\n\nThe rows field well of a heat map.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapaggregatedfieldwells.html#cfn-quicksight-template-heatmapaggregatedfieldwells-rows", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.HeatMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HeatMapConfiguration`\n\nThe configuration of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a heat map.\n*Required*: No\n*Type*: [HeatMapSortConfiguration](./aws-properties-quicksight-template-heatmapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapSortConfiguration" }, "ColumnLabelOptions": { "MarkdownDocumentation": "`ColumnLabelOptions`\n\nThe label options of the column that is displayed in a heat map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-columnlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [HeatMapFieldWells](./aws-properties-quicksight-template-heatmapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "ColorScale": { "MarkdownDocumentation": "`ColorScale`\n\nThe color options (gradient color, point of divergence) in a heat map.\n*Required*: No\n*Type*: [ColorScale](./aws-properties-quicksight-template-colorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-colorscale", "UpdateType": "Mutable", "Required": false, "Type": "ColorScale" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "RowLabelOptions": { "MarkdownDocumentation": "`RowLabelOptions`\n\nThe label options of the row that is displayed in a `heat map`.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-rowlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" } } }, "AWS::QuickSight::Template.HeatMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HeatMapFieldWells`\n\nThe field well configuration of a heat map.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapfieldwells.html", "Properties": { "HeatMapAggregatedFieldWells": { "MarkdownDocumentation": "`HeatMapAggregatedFieldWells`\n\nThe aggregated field wells of a heat map.\n*Required*: No\n*Type*: [HeatMapAggregatedFieldWells](./aws-properties-quicksight-template-heatmapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapfieldwells.html#cfn-quicksight-template-heatmapfieldwells-heatmapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapAggregatedFieldWells" } } }, "AWS::QuickSight::Template.HeatMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HeatMapSortConfiguration`\n\nThe sort configuration of a heat map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html", "Properties": { "HeatMapRowSort": { "MarkdownDocumentation": "`HeatMapRowSort`\n\nThe field sort configuration of the rows fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html#cfn-quicksight-template-heatmapsortconfiguration-heatmaprowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "HeatMapRowItemsLimitConfiguration": { "MarkdownDocumentation": "`HeatMapRowItemsLimitConfiguration`\n\nThe limit on the number of rows that are displayed in a heat map.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html#cfn-quicksight-template-heatmapsortconfiguration-heatmaprowitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "HeatMapColumnItemsLimitConfiguration": { "MarkdownDocumentation": "`HeatMapColumnItemsLimitConfiguration`\n\nThe limit on the number of columns that are displayed in a heat map.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html#cfn-quicksight-template-heatmapsortconfiguration-heatmapcolumnitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "HeatMapColumnSort": { "MarkdownDocumentation": "`HeatMapColumnSort`\n\nThe column sort configuration for heat map for columns that aren't a part of a field well.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html#cfn-quicksight-template-heatmapsortconfiguration-heatmapcolumnsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.HeatMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HeatMapVisual`\n\nA heat map.\nFor more information, see [Using heat maps](https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a heat map.\n*Required*: No\n*Type*: [HeatMapConfiguration](./aws-properties-quicksight-template-heatmapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.HistogramAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HistogramAggregatedFieldWells`\n\nThe field well configuration of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a histogram. Values are aggregated by `COUNT` or `DISTINCT_COUNT`.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramaggregatedfieldwells.html#cfn-quicksight-template-histogramaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.HistogramBinOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HistogramBinOptions`\n\nThe options that determine the presentation of histogram bins.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html", "Properties": { "BinWidth": { "MarkdownDocumentation": "`BinWidth`\n\nThe options that determine the bin width of a histogram.\n*Required*: No\n*Type*: [BinWidthOptions](./aws-properties-quicksight-template-binwidthoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html#cfn-quicksight-template-histogrambinoptions-binwidth", "UpdateType": "Mutable", "Required": false, "Type": "BinWidthOptions" }, "StartValue": { "MarkdownDocumentation": "`StartValue`\n\nThe options that determine the bin start value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html#cfn-quicksight-template-histogrambinoptions-startvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "SelectedBinType": { "MarkdownDocumentation": "`SelectedBinType`\n\nThe options that determine the selected bin type.\n*Required*: No\n*Type*: String\n*Allowed values*: `BIN_COUNT | BIN_WIDTH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BIN_COUNT", "BIN_WIDTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html#cfn-quicksight-template-histogrambinoptions-selectedbintype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BinCount": { "MarkdownDocumentation": "`BinCount`\n\nThe options that determine the bin count of a histogram.\n*Required*: No\n*Type*: [BinCountOptions](./aws-properties-quicksight-template-bincountoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html#cfn-quicksight-template-histogrambinoptions-bincount", "UpdateType": "Mutable", "Required": false, "Type": "BinCountOptions" } } }, "AWS::QuickSight::Template.HistogramConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HistogramConfiguration`\n\nThe configuration for a `HistogramVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html", "Properties": { "YAxisDisplayOptions": { "MarkdownDocumentation": "`YAxisDisplayOptions`\n\nThe options that determine the presentation of the y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-yaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a histogram.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "BinOptions": { "MarkdownDocumentation": "`BinOptions`\n\nThe options that determine the presentation of histogram bins.\n*Required*: No\n*Type*: [HistogramBinOptions](./aws-properties-quicksight-template-histogrambinoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-binoptions", "UpdateType": "Mutable", "Required": false, "Type": "HistogramBinOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a histogram.\n*Required*: No\n*Type*: [HistogramFieldWells](./aws-properties-quicksight-template-histogramfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HistogramFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a histogram.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe options that determine the presentation of the x-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a histogram.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe options that determine the presentation of the x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Template.HistogramFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HistogramFieldWells`\n\nThe field well configuration of a histogram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramfieldwells.html", "Properties": { "HistogramAggregatedFieldWells": { "MarkdownDocumentation": "`HistogramAggregatedFieldWells`\n\nThe field well configuration of a histogram.\n*Required*: No\n*Type*: [HistogramAggregatedFieldWells](./aws-properties-quicksight-template-histogramaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramfieldwells.html#cfn-quicksight-template-histogramfieldwells-histogramaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "HistogramAggregatedFieldWells" } } }, "AWS::QuickSight::Template.HistogramVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.HistogramVisual`\n\nA histogram.\nFor more information, see [Using histograms](https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration for a `HistogramVisual`.\n*Required*: No\n*Type*: [HistogramConfiguration](./aws-properties-quicksight-template-histogramconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HistogramConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ImageCustomAction": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ImageCustomAction`\n\nA custom action defined on an image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the custom action.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trigger": { "MarkdownDocumentation": "`Trigger`\n\nThe trigger of the `VisualCustomAction`.\nValid values are defined as follows:\n* `CLICK`: Initiates a custom action by a left pointer click on a data point.\n* `MENU`: Initiates a custom action by right pointer click from the menu.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLICK | MENU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLICK", "MENU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-trigger", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomActionId": { "MarkdownDocumentation": "`CustomActionId`\n\nThe ID of the custom action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-customactionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the custom action.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionOperations": { "MarkdownDocumentation": "`ActionOperations`\n\nA list of `ImageCustomActionOperations`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: Array of [ImageCustomActionOperation](./aws-properties-quicksight-template-imagecustomactionoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-actionoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ImageCustomActionOperation", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ImageCustomActionOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ImageCustomActionOperation`\n\nThe operation that is defined by the custom action.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomactionoperation.html", "Properties": { "NavigationOperation": { "MarkdownDocumentation": "`NavigationOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionNavigationOperation](./aws-properties-quicksight-template-customactionnavigationoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomactionoperation.html#cfn-quicksight-template-imagecustomactionoperation-navigationoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionNavigationOperation" }, "SetParametersOperation": { "MarkdownDocumentation": "`SetParametersOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionSetParametersOperation](./aws-properties-quicksight-template-customactionsetparametersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomactionoperation.html#cfn-quicksight-template-imagecustomactionoperation-setparametersoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionSetParametersOperation" }, "URLOperation": { "MarkdownDocumentation": "`URLOperation`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomActionURLOperation](./aws-properties-quicksight-template-customactionurloperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomactionoperation.html#cfn-quicksight-template-imagecustomactionoperation-urloperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionURLOperation" } } }, "AWS::QuickSight::Template.ImageInteractionOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ImageInteractionOptions`\n\nThe general image interactions setup for image publish options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imageinteractionoptions.html", "Properties": { "ImageMenuOption": { "MarkdownDocumentation": "`ImageMenuOption`\n\nThe menu options for the image.\n*Required*: No\n*Type*: [ImageMenuOption](./aws-properties-quicksight-template-imagemenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imageinteractionoptions.html#cfn-quicksight-template-imageinteractionoptions-imagemenuoption", "UpdateType": "Mutable", "Required": false, "Type": "ImageMenuOption" } } }, "AWS::QuickSight::Template.ImageMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ImageMenuOption`\n\nThe menu options for the interactions of an image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagemenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availability status of the image menu. If the value of this property is set to `ENABLED`, dashboard readers can interact with the image menu.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagemenuoption.html#cfn-quicksight-template-imagemenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.InnerFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.InnerFilter`\n\nThe `InnerFilter` defines the subset of data to be used with the `NestedFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-innerfilter.html", "Properties": { "CategoryInnerFilter": { "MarkdownDocumentation": "`CategoryInnerFilter`\n\nA `CategoryInnerFilter` filters text values for the `NestedFilter`.\n*Required*: No\n*Type*: [CategoryInnerFilter](./aws-properties-quicksight-template-categoryinnerfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-innerfilter.html#cfn-quicksight-template-innerfilter-categoryinnerfilter", "UpdateType": "Mutable", "Required": false, "Type": "CategoryInnerFilter" } } }, "AWS::QuickSight::Template.InsightConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.InsightConfiguration`\n\nThe configuration of an insight visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightconfiguration.html", "Properties": { "Computations": { "MarkdownDocumentation": "`Computations`\n\nThe computations configurations of the insight visual\n*Required*: No\n*Type*: Array of [Computation](./aws-properties-quicksight-template-computation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightconfiguration.html#cfn-quicksight-template-insightconfiguration-computations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Computation", "DuplicatesAllowed": true }, "CustomNarrative": { "MarkdownDocumentation": "`CustomNarrative`\n\nThe custom narrative of the insight visual.\n*Required*: No\n*Type*: [CustomNarrativeOptions](./aws-properties-quicksight-template-customnarrativeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightconfiguration.html#cfn-quicksight-template-insightconfiguration-customnarrative", "UpdateType": "Mutable", "Required": false, "Type": "CustomNarrativeOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightconfiguration.html#cfn-quicksight-template-insightconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Template.InsightVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.InsightVisual`\n\nAn insight visual.\nFor more information, see [Working with insights](https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe dataset that is used in the insight visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InsightConfiguration": { "MarkdownDocumentation": "`InsightConfiguration`\n\nThe configuration of an insight visual.\n*Required*: No\n*Type*: [InsightConfiguration](./aws-properties-quicksight-template-insightconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-insightconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InsightConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.IntegerDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Template.IntegerDefaultValues`\n\nThe default values of the `IntegerParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerdefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `IntegerDefaultValues`. Different defaults are displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-template-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerdefaultvalues.html#cfn-quicksight-template-integerdefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `IntegerDefaultValues`.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerdefaultvalues.html#cfn-quicksight-template-integerdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.IntegerParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.IntegerParameterDeclaration`\n\nA parameter declaration for the `Integer` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-template-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [IntegerDefaultValues](./aws-properties-quicksight-template-integerdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "IntegerDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nA parameter declaration for the `Integer` data type.\n*Required*: No\n*Type*: [IntegerValueWhenUnsetConfiguration](./aws-properties-quicksight-template-integervaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "IntegerValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.IntegerValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.IntegerValueWhenUnsetConfiguration`\n\nA parameter declaration for the `Integer` data type.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integervaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integervaluewhenunsetconfiguration.html#cfn-quicksight-template-integervaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't set.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integervaluewhenunsetconfiguration.html#cfn-quicksight-template-integervaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.ItemsLimitConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ItemsLimitConfiguration`\n\nThe limit configuration of the visual display for an axis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-itemslimitconfiguration.html", "Properties": { "ItemsLimit": { "MarkdownDocumentation": "`ItemsLimit`\n\nThe limit on how many items of a field are showed in the chart. For\nexample, the number of slices that are displayed in a pie chart.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-itemslimitconfiguration.html#cfn-quicksight-template-itemslimitconfiguration-itemslimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "OtherCategories": { "MarkdownDocumentation": "`OtherCategories`\n\nThe `Show\nother` of an axis in the chart. Choose one of the following options:\n* `INCLUDE`\n* `EXCLUDE`\n*Required*: No\n*Type*: String\n*Allowed values*: `INCLUDE | EXCLUDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCLUDE", "EXCLUDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-itemslimitconfiguration.html#cfn-quicksight-template-itemslimitconfiguration-othercategories", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.KPIActualValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIActualValueConditionalFormatting`\n\nThe conditional formatting for the actual value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiactualvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the actual value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiactualvalueconditionalformatting.html#cfn-quicksight-template-kpiactualvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the actual value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-template-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiactualvalueconditionalformatting.html#cfn-quicksight-template-kpiactualvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Template.KPIComparisonValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIComparisonValueConditionalFormatting`\n\nThe conditional formatting for the comparison value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpicomparisonvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the comparison value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-template-kpicomparisonvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the comparison value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-template-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-template-kpicomparisonvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Template.KPIConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIConditionalFormatting`\n\nThe conditional formatting of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nThe conditional formatting options of a KPI visual.\n*Required*: No\n*Type*: Array of [KPIConditionalFormattingOption](./aws-properties-quicksight-template-kpiconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformatting.html#cfn-quicksight-template-kpiconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "KPIConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.KPIConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIConditionalFormattingOption`\n\nThe conditional formatting options of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html", "Properties": { "PrimaryValue": { "MarkdownDocumentation": "`PrimaryValue`\n\nThe conditional formatting for the primary value of a KPI visual.\n*Required*: No\n*Type*: [KPIPrimaryValueConditionalFormatting](./aws-properties-quicksight-template-kpiprimaryvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-primaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIPrimaryValueConditionalFormatting" }, "ActualValue": { "MarkdownDocumentation": "`ActualValue`\n\nThe conditional formatting for the actual value of a KPI visual.\n*Required*: No\n*Type*: [KPIActualValueConditionalFormatting](./aws-properties-quicksight-template-kpiactualvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-actualvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIActualValueConditionalFormatting" }, "ComparisonValue": { "MarkdownDocumentation": "`ComparisonValue`\n\nThe conditional formatting for the comparison value of a KPI visual.\n*Required*: No\n*Type*: [KPIComparisonValueConditionalFormatting](./aws-properties-quicksight-template-kpicomparisonvalueconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-comparisonvalue", "UpdateType": "Mutable", "Required": false, "Type": "KPIComparisonValueConditionalFormatting" }, "ProgressBar": { "MarkdownDocumentation": "`ProgressBar`\n\nThe conditional formatting for the progress bar of a KPI visual.\n*Required*: No\n*Type*: [KPIProgressBarConditionalFormatting](./aws-properties-quicksight-template-kpiprogressbarconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-progressbar", "UpdateType": "Mutable", "Required": false, "Type": "KPIProgressBarConditionalFormatting" } } }, "AWS::QuickSight::Template.KPIConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIConfiguration`\n\nThe configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a KPI visual.\n*Required*: No\n*Type*: [KPISortConfiguration](./aws-properties-quicksight-template-kpisortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html#cfn-quicksight-template-kpiconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "KPISortConfiguration" }, "KPIOptions": { "MarkdownDocumentation": "`KPIOptions`\n\nThe options that determine the presentation of a KPI visual.\n*Required*: No\n*Type*: [KPIOptions](./aws-properties-quicksight-template-kpioptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html#cfn-quicksight-template-kpiconfiguration-kpioptions", "UpdateType": "Mutable", "Required": false, "Type": "KPIOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a KPI visual.\n*Required*: No\n*Type*: [KPIFieldWells](./aws-properties-quicksight-template-kpifieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html#cfn-quicksight-template-kpiconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "KPIFieldWells" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html#cfn-quicksight-template-kpiconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Template.KPIFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIFieldWells`\n\nThe field well configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpifieldwells.html", "Properties": { "TargetValues": { "MarkdownDocumentation": "`TargetValues`\n\nThe target value field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpifieldwells.html#cfn-quicksight-template-kpifieldwells-targetvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "TrendGroups": { "MarkdownDocumentation": "`TrendGroups`\n\nThe trend group field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpifieldwells.html#cfn-quicksight-template-kpifieldwells-trendgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a KPI visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpifieldwells.html#cfn-quicksight-template-kpifieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.KPIOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIOptions`\n\nThe options that determine the presentation of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html", "Properties": { "SecondaryValueFontConfiguration": { "MarkdownDocumentation": "`SecondaryValueFontConfiguration`\n\nThe options that determine the secondary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-secondaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "VisualLayoutOptions": { "MarkdownDocumentation": "`VisualLayoutOptions`\n\nThe options that determine the layout a KPI visual.\n*Required*: No\n*Type*: [KPIVisualLayoutOptions](./aws-properties-quicksight-template-kpivisuallayoutoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-visuallayoutoptions", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisualLayoutOptions" }, "TrendArrows": { "MarkdownDocumentation": "`TrendArrows`\n\nThe options that determine the presentation of trend arrows in a KPI visual.\n*Required*: No\n*Type*: [TrendArrowOptions](./aws-properties-quicksight-template-trendarrowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-trendarrows", "UpdateType": "Mutable", "Required": false, "Type": "TrendArrowOptions" }, "SecondaryValue": { "MarkdownDocumentation": "`SecondaryValue`\n\nThe options that determine the presentation of the secondary value of a KPI visual.\n*Required*: No\n*Type*: [SecondaryValueOptions](./aws-properties-quicksight-template-secondaryvalueoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-secondaryvalue", "UpdateType": "Mutable", "Required": false, "Type": "SecondaryValueOptions" }, "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe comparison configuration of a KPI visual.\n*Required*: No\n*Type*: [ComparisonConfiguration](./aws-properties-quicksight-template-comparisonconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-comparison", "UpdateType": "Mutable", "Required": false, "Type": "ComparisonConfiguration" }, "PrimaryValueDisplayType": { "MarkdownDocumentation": "`PrimaryValueDisplayType`\n\nThe options that determine the primary value display type.\n*Required*: No\n*Type*: String\n*Allowed values*: `HIDDEN | COMPARISON | ACTUA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "COMPARISON", "ACTUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-primaryvaluedisplaytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProgressBar": { "MarkdownDocumentation": "`ProgressBar`\n\nThe options that determine the presentation of the progress bar of a KPI visual.\n*Required*: No\n*Type*: [ProgressBarOptions](./aws-properties-quicksight-template-progressbaroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-progressbar", "UpdateType": "Mutable", "Required": false, "Type": "ProgressBarOptions" }, "PrimaryValueFontConfiguration": { "MarkdownDocumentation": "`PrimaryValueFontConfiguration`\n\nThe options that determine the primary value font configuration.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-primaryvaluefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Sparkline": { "MarkdownDocumentation": "`Sparkline`\n\nThe options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.\n*Required*: No\n*Type*: [KPISparklineOptions](./aws-properties-quicksight-template-kpisparklineoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-sparkline", "UpdateType": "Mutable", "Required": false, "Type": "KPISparklineOptions" } } }, "AWS::QuickSight::Template.KPIPrimaryValueConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIPrimaryValueConditionalFormatting`\n\nThe conditional formatting for the primary value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprimaryvalueconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting of the primary value's text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-template-kpiprimaryvalueconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting of the primary value's icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-template-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-template-kpiprimaryvalueconditionalformatting-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" } } }, "AWS::QuickSight::Template.KPIProgressBarConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIProgressBarConditionalFormatting`\n\nThe conditional formatting for the progress bar of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprogressbarconditionalformatting.html", "Properties": { "ForegroundColor": { "MarkdownDocumentation": "`ForegroundColor`\n\nThe conditional formatting of the progress bar's foreground color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprogressbarconditionalformatting.html#cfn-quicksight-template-kpiprogressbarconditionalformatting-foregroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Template.KPISortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPISortConfiguration`\n\nThe sort configuration of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisortconfiguration.html", "Properties": { "TrendGroupSort": { "MarkdownDocumentation": "`TrendGroupSort`\n\nThe sort configuration of the trend group fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisortconfiguration.html#cfn-quicksight-template-kpisortconfiguration-trendgroupsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.KPISparklineOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPISparklineOptions`\n\nThe options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the sparkline.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LINE | AREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINE", "AREA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of the sparkline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipVisibility": { "MarkdownDocumentation": "`TooltipVisibility`\n\nThe tooltip visibility of the sparkline.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-tooltipvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the sparkline.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.KPIVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIVisual`\n\nA key performance indicator (KPI).\nFor more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting of a KPI visual.\n*Required*: No\n*Type*: [KPIConditionalFormatting](./aws-properties-quicksight-template-kpiconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "KPIConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a KPI visual.\n*Required*: No\n*Type*: [KPIConfiguration](./aws-properties-quicksight-template-kpiconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "KPIConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.KPIVisualLayoutOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIVisualLayoutOptions`\n\nThe options that determine the layout a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisuallayoutoptions.html", "Properties": { "StandardLayout": { "MarkdownDocumentation": "`StandardLayout`\n\nThe standard layout of the KPI visual.\n*Required*: No\n*Type*: [KPIVisualStandardLayout](./aws-properties-quicksight-template-kpivisualstandardlayout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisuallayoutoptions.html#cfn-quicksight-template-kpivisuallayoutoptions-standardlayout", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisualStandardLayout" } } }, "AWS::QuickSight::Template.KPIVisualStandardLayout": { "MarkdownDocumentation": "`AWS::QuickSight::Template.KPIVisualStandardLayout`\n\nThe standard layout of the KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisualstandardlayout.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe standard layout type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLASSIC | VERTICAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLASSIC", "VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisualstandardlayout.html#cfn-quicksight-template-kpivisualstandardlayout-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.LabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LabelOptions`\n\nThe share label options for the labels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-labeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe text for the label.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-labeloptions.html#cfn-quicksight-template-labeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the label is visible.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-labeloptions.html#cfn-quicksight-template-labeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the label.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-labeloptions.html#cfn-quicksight-template-labeloptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Template.Layout": { "MarkdownDocumentation": "`AWS::QuickSight::Template.Layout`\n\nA `Layout` defines the placement of elements within a sheet.\nFor more information, see [Types of layout](https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the *Amazon Quick Suite User Guide*.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layout.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration that determines what the type of layout for a sheet.\n*Required*: Yes\n*Type*: [LayoutConfiguration](./aws-properties-quicksight-template-layoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layout.html#cfn-quicksight-template-layout-configuration", "UpdateType": "Mutable", "Required": true, "Type": "LayoutConfiguration" } } }, "AWS::QuickSight::Template.LayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LayoutConfiguration`\n\nThe configuration that determines what the type of layout will be used on a sheet.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layoutconfiguration.html", "Properties": { "GridLayout": { "MarkdownDocumentation": "`GridLayout`\n\nA type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: `FIXED` or `RESPONSIVE`.\n*Required*: No\n*Type*: [GridLayoutConfiguration](./aws-properties-quicksight-template-gridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layoutconfiguration.html#cfn-quicksight-template-layoutconfiguration-gridlayout", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutConfiguration" }, "FreeFormLayout": { "MarkdownDocumentation": "`FreeFormLayout`\n\nA free-form is optimized for a fixed width and has more control over the exact placement of layout elements.\n*Required*: No\n*Type*: [FreeFormLayoutConfiguration](./aws-properties-quicksight-template-freeformlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layoutconfiguration.html#cfn-quicksight-template-layoutconfiguration-freeformlayout", "UpdateType": "Mutable", "Required": false, "Type": "FreeFormLayoutConfiguration" }, "SectionBasedLayout": { "MarkdownDocumentation": "`SectionBasedLayout`\n\nA section based layout organizes visuals into multiple sections and has customized header, footer and page break.\n*Required*: No\n*Type*: [SectionBasedLayoutConfiguration](./aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layoutconfiguration.html#cfn-quicksight-template-layoutconfiguration-sectionbasedlayout", "UpdateType": "Mutable", "Required": false, "Type": "SectionBasedLayoutConfiguration" } } }, "AWS::QuickSight::Template.LegendOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LegendOptions`\n\nThe options for the legend setup of a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html", "Properties": { "Position": { "MarkdownDocumentation": "`Position`\n\nThe positions for the legend. Choose one of the following\noptions:\n* `AUTO`\n* `RIGHT`\n* `BOTTOM`\n* `LEFT`\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTO | RIGHT | BOTTOM | TOP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "RIGHT", "BOTTOM", "TOP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueFontConfiguration": { "MarkdownDocumentation": "`ValueFontConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-valuefontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe custom title for the legend.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-title", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the legend is visible.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of the legend. If this value is omitted, a default height is used when\nrendering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of the legend. If this value is omitted, a default width is used when rendering.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.LineChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartAggregatedFieldWells`\n\nThe field well configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field wells of a line chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html#cfn-quicksight-template-linechartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field wells of a line chart. Values are grouped by category fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html#cfn-quicksight-template-linechartaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a line chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html#cfn-quicksight-template-linechartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a line chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html#cfn-quicksight-template-linechartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.LineChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartConfiguration`\n\nThe configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a line chart.\n*Required*: No\n*Type*: [LineChartSortConfiguration](./aws-properties-quicksight-template-linechartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LineChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend configuration of a line chart.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "ReferenceLines": { "MarkdownDocumentation": "`ReferenceLines`\n\nThe reference lines configuration of a line chart.\n*Required*: No\n*Type*: Array of [ReferenceLine](./aws-properties-quicksight-template-referenceline.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-referencelines", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReferenceLine", "DuplicatesAllowed": true }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a line chart.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip configuration of a line chart.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "SingleAxisOptions": { "MarkdownDocumentation": "`SingleAxisOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [SingleAxisOptions](./aws-properties-quicksight-template-singleaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-singleaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "SingleAxisOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-template-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n*Required*: No\n*Type*: [LineSeriesAxisDisplayOptions](./aws-properties-quicksight-template-lineseriesaxisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "LineSeriesAxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a line chart.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe options that determine the presentation of the x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DefaultSeriesSettings": { "MarkdownDocumentation": "`DefaultSeriesSettings`\n\nThe options that determine the default presentation of all line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartDefaultSeriesSettings](./aws-properties-quicksight-template-linechartdefaultseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-defaultseriessettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartDefaultSeriesSettings" }, "SecondaryYAxisLabelOptions": { "MarkdownDocumentation": "`SecondaryYAxisLabelOptions`\n\nThe options that determine the presentation of the secondary y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-secondaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "ForecastConfigurations": { "MarkdownDocumentation": "`ForecastConfigurations`\n\nThe forecast configuration of a line chart.\n*Required*: No\n*Type*: Array of [ForecastConfiguration](./aws-properties-quicksight-template-forecastconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-forecastconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ForecastConfiguration", "DuplicatesAllowed": true }, "Series": { "MarkdownDocumentation": "`Series`\n\nThe series item configuration of a line chart.\n*Required*: No\n*Type*: Array of [SeriesItem](./aws-properties-quicksight-template-seriesitem.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-series", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SeriesItem", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nDetermines the type of the line chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINE | AREA | STACKED_AREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINE", "AREA", "STACKED_AREA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe options that determine the presentation of the y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe default configuration of a line chart's contribution analysis.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-template-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a line chart.\n*Required*: No\n*Type*: [LineChartFieldWells](./aws-properties-quicksight-template-linechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "LineChartFieldWells" }, "SecondaryYAxisDisplayOptions": { "MarkdownDocumentation": "`SecondaryYAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n*Required*: No\n*Type*: [LineSeriesAxisDisplayOptions](./aws-properties-quicksight-template-lineseriesaxisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-secondaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "LineSeriesAxisDisplayOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe options that determine the presentation of the x-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Template.LineChartDefaultSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartDefaultSeriesSettings`\n\nThe options that determine the default presentation of all line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartdefaultseriessettings.html", "Properties": { "LineStyleSettings": { "MarkdownDocumentation": "`LineStyleSettings`\n\nLine styles options for all line series in the visual.\n*Required*: No\n*Type*: [LineChartLineStyleSettings](./aws-properties-quicksight-template-linechartlinestylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartdefaultseriessettings.html#cfn-quicksight-template-linechartdefaultseriessettings-linestylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartLineStyleSettings" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis to which you are binding all line series to.\n*Required*: No\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartdefaultseriessettings.html#cfn-quicksight-template-linechartdefaultseriessettings-axisbinding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerStyleSettings": { "MarkdownDocumentation": "`MarkerStyleSettings`\n\nMarker styles options for all line series in the visual.\n*Required*: No\n*Type*: [LineChartMarkerStyleSettings](./aws-properties-quicksight-template-linechartmarkerstylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartdefaultseriessettings.html#cfn-quicksight-template-linechartdefaultseriessettings-markerstylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartMarkerStyleSettings" } } }, "AWS::QuickSight::Template.LineChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartFieldWells`\n\nThe field well configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartfieldwells.html", "Properties": { "LineChartAggregatedFieldWells": { "MarkdownDocumentation": "`LineChartAggregatedFieldWells`\n\nThe field well configuration of a line chart.\n*Required*: No\n*Type*: [LineChartAggregatedFieldWells](./aws-properties-quicksight-template-linechartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartfieldwells.html#cfn-quicksight-template-linechartfieldwells-linechartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "LineChartAggregatedFieldWells" } } }, "AWS::QuickSight::Template.LineChartLineStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartLineStyleSettings`\n\nLine styles options for a line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html", "Properties": { "LineInterpolation": { "MarkdownDocumentation": "`LineInterpolation`\n\nInterpolation style for line series.\n* `LINEAR`: Show as default, linear style.\n* `SMOOTH`: Show as a smooth curve.\n* `STEPPED`: Show steps in line.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINEAR | SMOOTH | STEPPED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINEAR", "SMOOTH", "STEPPED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html#cfn-quicksight-template-linechartlinestylesettings-lineinterpolation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineStyle": { "MarkdownDocumentation": "`LineStyle`\n\nLine style for line series.\n* `SOLID`: Show as a solid line.\n* `DOTTED`: Show as a dotted line.\n* `DASHED`: Show as a dashed line.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DOTTED | DASHED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DOTTED", "DASHED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html#cfn-quicksight-template-linechartlinestylesettings-linestyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LineVisibility": { "MarkdownDocumentation": "`LineVisibility`\n\nConfiguration option that determines whether to show the line for the series.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html#cfn-quicksight-template-linechartlinestylesettings-linevisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LineWidth": { "MarkdownDocumentation": "`LineWidth`\n\nWidth that determines the line thickness.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html#cfn-quicksight-template-linechartlinestylesettings-linewidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.LineChartMarkerStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartMarkerStyleSettings`\n\nMarker styles options for a line series in `LineChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html", "Properties": { "MarkerShape": { "MarkdownDocumentation": "`MarkerShape`\n\nShape option for markers in the series.\n* `CIRCLE`: Show marker as a circle.\n* `TRIANGLE`: Show marker as a triangle.\n* `SQUARE`: Show marker as a square.\n* `DIAMOND`: Show marker as a diamond.\n* `ROUNDED_SQUARE`: Show marker as a rounded square.\n*Required*: No\n*Type*: String\n*Allowed values*: `CIRCLE | TRIANGLE | SQUARE ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIRCLE", "TRIANGLE", "SQUARE", "DIAMOND", "ROUNDED_SQUARE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html#cfn-quicksight-template-linechartmarkerstylesettings-markershape", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerSize": { "MarkdownDocumentation": "`MarkerSize`\n\nSize of marker in the series.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html#cfn-quicksight-template-linechartmarkerstylesettings-markersize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MarkerVisibility": { "MarkdownDocumentation": "`MarkerVisibility`\n\nConfiguration option that determines whether to show the markers in the series.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html#cfn-quicksight-template-linechartmarkerstylesettings-markervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MarkerColor": { "MarkdownDocumentation": "`MarkerColor`\n\nColor of marker in the series.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html#cfn-quicksight-template-linechartmarkerstylesettings-markercolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.LineChartSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartSeriesSettings`\n\nThe options that determine the presentation of a line series in the visual\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartseriessettings.html", "Properties": { "LineStyleSettings": { "MarkdownDocumentation": "`LineStyleSettings`\n\nLine styles options for a line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartLineStyleSettings](./aws-properties-quicksight-template-linechartlinestylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartseriessettings.html#cfn-quicksight-template-linechartseriessettings-linestylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartLineStyleSettings" }, "MarkerStyleSettings": { "MarkdownDocumentation": "`MarkerStyleSettings`\n\nMarker styles options for a line series in `LineChartVisual`.\n*Required*: No\n*Type*: [LineChartMarkerStyleSettings](./aws-properties-quicksight-template-linechartmarkerstylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartseriessettings.html#cfn-quicksight-template-linechartseriessettings-markerstylesettings", "UpdateType": "Mutable", "Required": false, "Type": "LineChartMarkerStyleSettings" } } }, "AWS::QuickSight::Template.LineChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartSortConfiguration`\n\nThe sort configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html", "Properties": { "CategoryItemsLimitConfiguration": { "MarkdownDocumentation": "`CategoryItemsLimitConfiguration`\n\nThe limit on the number of categories that are displayed in a line chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-categoryitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "ColorItemsLimitConfiguration": { "MarkdownDocumentation": "`ColorItemsLimitConfiguration`\n\nThe limit on the number of lines that are displayed in a line chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-coloritemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Template.LineChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineChartVisual`\n\nA line chart.\nFor more information, see [Using line charts](https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a line chart.\n*Required*: No\n*Type*: [LineChartConfiguration](./aws-properties-quicksight-template-linechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LineChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.LineSeriesAxisDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LineSeriesAxisDisplayOptions`\n\nThe series axis configuration of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-lineseriesaxisdisplayoptions.html", "Properties": { "MissingDataConfigurations": { "MarkdownDocumentation": "`MissingDataConfigurations`\n\nThe configuration options that determine how missing data is treated during the rendering of a line chart.\n*Required*: No\n*Type*: Array of [MissingDataConfiguration](./aws-properties-quicksight-template-missingdataconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-lineseriesaxisdisplayoptions.html#cfn-quicksight-template-lineseriesaxisdisplayoptions-missingdataconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MissingDataConfiguration", "DuplicatesAllowed": true }, "AxisOptions": { "MarkdownDocumentation": "`AxisOptions`\n\nThe options that determine the presentation of the line series axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-lineseriesaxisdisplayoptions.html#cfn-quicksight-template-lineseriesaxisdisplayoptions-axisoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Template.ListControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ListControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html#cfn-quicksight-template-listcontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "SearchOptions": { "MarkdownDocumentation": "`SearchOptions`\n\nThe configuration of the search options in a list control.\n*Required*: No\n*Type*: [ListControlSearchOptions](./aws-properties-quicksight-template-listcontrolsearchoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html#cfn-quicksight-template-listcontroldisplayoptions-searchoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSearchOptions" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nThe configuration of the `Select all` options in a list control.\n*Required*: No\n*Type*: [ListControlSelectAllOptions](./aws-properties-quicksight-template-listcontrolselectalloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html#cfn-quicksight-template-listcontroldisplayoptions-selectalloptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlSelectAllOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html#cfn-quicksight-template-listcontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Template.ListControlSearchOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ListControlSearchOptions`\n\nThe configuration of the search options in a list control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontrolsearchoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the search options in a list control.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontrolsearchoptions.html#cfn-quicksight-template-listcontrolsearchoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.ListControlSelectAllOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ListControlSelectAllOptions`\n\nThe configuration of the `Select all` options in a list control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontrolselectalloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the `Select all` options in a list control.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontrolselectalloptions.html#cfn-quicksight-template-listcontrolselectalloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.LoadingAnimation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LoadingAnimation`\n\nThe configuration of loading animation in free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-loadinganimation.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of `LoadingAnimation`.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-loadinganimation.html#cfn-quicksight-template-loadinganimation-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.LocalNavigationConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LocalNavigationConfiguration`\n\nThe navigation configuration for `CustomActionNavigationOperation`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-localnavigationconfiguration.html", "Properties": { "TargetSheetId": { "MarkdownDocumentation": "`TargetSheetId`\n\nThe sheet that is targeted for navigation in the same analysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-localnavigationconfiguration.html#cfn-quicksight-template-localnavigationconfiguration-targetsheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.LongFormatText": { "MarkdownDocumentation": "`AWS::QuickSight::Template.LongFormatText`\n\nThe text format for a subtitle.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-longformattext.html", "Properties": { "RichText": { "MarkdownDocumentation": "`RichText`\n\nRich text. Examples of rich text include bold, underline, and italics.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-longformattext.html#cfn-quicksight-template-longformattext-richtext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nPlain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-longformattext.html#cfn-quicksight-template-longformattext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.MappedDataSetParameter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.MappedDataSetParameter`\n\nA dataset parameter that is mapped to an analysis parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-mappeddatasetparameter.html", "Properties": { "DataSetParameterName": { "MarkdownDocumentation": "`DataSetParameterName`\n\nThe name of the dataset parameter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-mappeddatasetparameter.html#cfn-quicksight-template-mappeddatasetparameter-datasetparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nA unique name that identifies a dataset within the analysis or dashboard.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-mappeddatasetparameter.html#cfn-quicksight-template-mappeddatasetparameter-datasetidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.MaximumLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Template.MaximumLabelType`\n\nThe maximum label of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumlabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the maximum label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumlabeltype.html#cfn-quicksight-template-maximumlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.MaximumMinimumComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.MaximumMinimumComputation`\n\nThe maximum and minimum computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of computation. Choose one of the following options:\n* MAXIMUM: A maximum computation.\n* MINIMUM: A minimum computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MAXIMUM | MINIMUM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MAXIMUM", "MINIMUM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.MeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.MeasureField`\n\nThe measure (metric) type field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html", "Properties": { "DateMeasureField": { "MarkdownDocumentation": "`DateMeasureField`\n\nThe measure type field with date type columns.\n*Required*: No\n*Type*: [DateMeasureField](./aws-properties-quicksight-template-datemeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html#cfn-quicksight-template-measurefield-datemeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "DateMeasureField" }, "NumericalMeasureField": { "MarkdownDocumentation": "`NumericalMeasureField`\n\nThe measure type field with numerical type columns.\n*Required*: No\n*Type*: [NumericalMeasureField](./aws-properties-quicksight-template-numericalmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html#cfn-quicksight-template-measurefield-numericalmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "NumericalMeasureField" }, "CategoricalMeasureField": { "MarkdownDocumentation": "`CategoricalMeasureField`\n\nThe measure type field with categorical type columns.\n*Required*: No\n*Type*: [CategoricalMeasureField](./aws-properties-quicksight-template-categoricalmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html#cfn-quicksight-template-measurefield-categoricalmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "CategoricalMeasureField" }, "CalculatedMeasureField": { "MarkdownDocumentation": "`CalculatedMeasureField`\n\nThe calculated measure field only used in pivot tables.\n*Required*: No\n*Type*: [CalculatedMeasureField](./aws-properties-quicksight-template-calculatedmeasurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html#cfn-quicksight-template-measurefield-calculatedmeasurefield", "UpdateType": "Mutable", "Required": false, "Type": "CalculatedMeasureField" } } }, "AWS::QuickSight::Template.MetricComparisonComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.MetricComparisonComputation`\n\nThe metric comparison computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html", "Properties": { "TargetValue": { "MarkdownDocumentation": "`TargetValue`\n\nThe field that is used in a metric comparison to value setup.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-targetvalue", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FromValue": { "MarkdownDocumentation": "`FromValue`\n\nThe field that is used in a metric comparison from value setup.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-fromvalue", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.MinimumLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Template.MinimumLabelType`\n\nThe minimum label of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-minimumlabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the minimum label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-minimumlabeltype.html#cfn-quicksight-template-minimumlabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.MissingDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.MissingDataConfiguration`\n\nThe configuration options that determine how missing data is treated during the rendering of a line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-missingdataconfiguration.html", "Properties": { "TreatmentOption": { "MarkdownDocumentation": "`TreatmentOption`\n\nThe treatment option that determines how missing data should be rendered. Choose\nfrom the following options:\n* `INTERPOLATE`: Interpolate missing values between the prior and the next known value.\n* `SHOW_AS_ZERO`: Show missing values as the value `0`.\n* `SHOW_AS_BLANK`: Display a blank space when rendering missing data.\n*Required*: No\n*Type*: String\n*Allowed values*: `INTERPOLATE | SHOW_AS_ZERO ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INTERPOLATE", "SHOW_AS_ZERO", "SHOW_AS_BLANK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-missingdataconfiguration.html#cfn-quicksight-template-missingdataconfiguration-treatmentoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NegativeValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-negativevalueconfiguration.html", "Properties": { "DisplayMode": { "MarkdownDocumentation": "`DisplayMode`\n\nDetermines the display mode of the negative value configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `POSITIVE | NEGATIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "POSITIVE", "NEGATIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-negativevalueconfiguration.html#cfn-quicksight-template-negativevalueconfiguration-displaymode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NestedFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NestedFilter`\n\nA `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "InnerFilter": { "MarkdownDocumentation": "`InnerFilter`\n\nThe `InnerFilter` defines the subset of data to be used with the `NestedFilter`.\n*Required*: Yes\n*Type*: [InnerFilter](./aws-properties-quicksight-template-innerfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-innerfilter", "UpdateType": "Mutable", "Required": true, "Type": "InnerFilter" }, "IncludeInnerSet": { "MarkdownDocumentation": "`IncludeInnerSet`\n\nA boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-includeinnerset", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NullValueFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nullvalueformatconfiguration.html", "Properties": { "NullString": { "MarkdownDocumentation": "`NullString`\n\nDetermines the null string of null values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nullvalueformatconfiguration.html#cfn-quicksight-template-nullvalueformatconfiguration-nullstring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumberDisplayFormatConfiguration`\n\nThe options that determine the number display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-template-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-template-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NumberScale": { "MarkdownDocumentation": "`NumberScale`\n\nDetermines the number scale value of the number format.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AUTO | THOUSANDS | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-numberscale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-template-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the number format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-template-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the number format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NumberFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumberFormatConfiguration`\n\nFormatting configuration for number fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberformatconfiguration.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe options that determine the numeric format configuration.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-template-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberformatconfiguration.html#cfn-quicksight-template-numberformatconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" } } }, "AWS::QuickSight::Template.NumericAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericAxisOptions`\n\nThe options for an axis with a numeric field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaxisoptions.html", "Properties": { "Scale": { "MarkdownDocumentation": "`Scale`\n\nThe scale setup of a numeric axis.\n*Required*: No\n*Type*: [AxisScale](./aws-properties-quicksight-template-axisscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaxisoptions.html#cfn-quicksight-template-numericaxisoptions-scale", "UpdateType": "Mutable", "Required": false, "Type": "AxisScale" }, "Range": { "MarkdownDocumentation": "`Range`\n\nThe range setup of a numeric axis.\n*Required*: No\n*Type*: [AxisDisplayRange](./aws-properties-quicksight-template-axisdisplayrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaxisoptions.html#cfn-quicksight-template-numericaxisoptions-range", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayRange" } } }, "AWS::QuickSight::Template.NumericEqualityDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericEqualityDrillDownFilter`\n\nThe numeric equality type drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalitydrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalitydrilldownfilter.html#cfn-quicksight-template-numericequalitydrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the double input numeric drill down filter.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalitydrilldownfilter.html#cfn-quicksight-template-numericequalitydrilldownfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.NumericEqualityFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericEqualityFilter`\n\nA `NumericEqualityFilter` filters values that are equal to the specified value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the filter.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-template-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe input value.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchOperator": { "MarkdownDocumentation": "`MatchOperator`\n\nThe match operator that is used to determine if a filter should be applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | DOES_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)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "DOES_NOT_EQUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-matchoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NumericFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericFormatConfiguration`\n\nThe options that determine the numeric format configuration.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericformatconfiguration.html", "Properties": { "NumberDisplayFormatConfiguration": { "MarkdownDocumentation": "`NumberDisplayFormatConfiguration`\n\nThe options that determine the number display format configuration.\n*Required*: No\n*Type*: [NumberDisplayFormatConfiguration](./aws-properties-quicksight-template-numberdisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericformatconfiguration.html#cfn-quicksight-template-numericformatconfiguration-numberdisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberDisplayFormatConfiguration" }, "CurrencyDisplayFormatConfiguration": { "MarkdownDocumentation": "`CurrencyDisplayFormatConfiguration`\n\nThe options that determine the currency display format configuration.\n*Required*: No\n*Type*: [CurrencyDisplayFormatConfiguration](./aws-properties-quicksight-template-currencydisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericformatconfiguration.html#cfn-quicksight-template-numericformatconfiguration-currencydisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CurrencyDisplayFormatConfiguration" }, "PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`PercentageDisplayFormatConfiguration`\n\nThe options that determine the percentage display format configuration.\n*Required*: No\n*Type*: [PercentageDisplayFormatConfiguration](./aws-properties-quicksight-template-percentagedisplayformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericformatconfiguration.html#cfn-quicksight-template-numericformatconfiguration-percentagedisplayformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PercentageDisplayFormatConfiguration" } } }, "AWS::QuickSight::Template.NumericRangeFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericRangeFilter`\n\nA `NumericRangeFilter` filters values that are within the value range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the filter.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-template-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "IncludeMaximum": { "MarkdownDocumentation": "`IncludeMaximum`\n\nDetermines whether the maximum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-includemaximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RangeMinimum": { "MarkdownDocumentation": "`RangeMinimum`\n\nThe minimum value for the filter value range.\n*Required*: No\n*Type*: [NumericRangeFilterValue](./aws-properties-quicksight-template-numericrangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-rangeminimum", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilterValue" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectAllOptions": { "MarkdownDocumentation": "`SelectAllOptions`\n\nSelect all of the values. Null is not the assigned value of select all.\n* `FILTER_ALL_VALUES`\n*Required*: No\n*Type*: String\n*Allowed values*: `FILTER_ALL_VALUES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILTER_ALL_VALUES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-selectalloptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeMaximum": { "MarkdownDocumentation": "`RangeMaximum`\n\nThe maximum value for the filter value range.\n*Required*: No\n*Type*: [NumericRangeFilterValue](./aws-properties-quicksight-template-numericrangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-rangemaximum", "UpdateType": "Mutable", "Required": false, "Type": "NumericRangeFilterValue" }, "IncludeMinimum": { "MarkdownDocumentation": "`IncludeMinimum`\n\nDetermines whether the minimum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-includeminimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Template.NumericRangeFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericRangeFilterValue`\n\nThe value input pf the numeric range filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefiltervalue.html", "Properties": { "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nThe static value of the numeric range filter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefiltervalue.html#cfn-quicksight-template-numericrangefiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Parameter": { "MarkdownDocumentation": "`Parameter`\n\nThe parameter that is used in the numeric range.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefiltervalue.html#cfn-quicksight-template-numericrangefiltervalue-parameter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NumericSeparatorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericSeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericseparatorconfiguration.html", "Properties": { "DecimalSeparator": { "MarkdownDocumentation": "`DecimalSeparator`\n\nDetermines the decimal separator.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMMA | DOT | SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMMA", "DOT", "SPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericseparatorconfiguration.html#cfn-quicksight-template-numericseparatorconfiguration-decimalseparator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThousandsSeparator": { "MarkdownDocumentation": "`ThousandsSeparator`\n\nThe options that determine the thousands separator configuration.\n*Required*: No\n*Type*: [ThousandSeparatorOptions](./aws-properties-quicksight-template-thousandseparatoroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericseparatorconfiguration.html#cfn-quicksight-template-numericseparatorconfiguration-thousandsseparator", "UpdateType": "Mutable", "Required": false, "Type": "ThousandSeparatorOptions" } } }, "AWS::QuickSight::Template.NumericalAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericalAggregationFunction`\n\nAggregation for numerical values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalaggregationfunction.html", "Properties": { "PercentileAggregation": { "MarkdownDocumentation": "`PercentileAggregation`\n\nAn aggregation based on the percentile of values in a dimension or measure.\n*Required*: No\n*Type*: [PercentileAggregation](./aws-properties-quicksight-template-percentileaggregation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalaggregationfunction.html#cfn-quicksight-template-numericalaggregationfunction-percentileaggregation", "UpdateType": "Mutable", "Required": false, "Type": "PercentileAggregation" }, "SimpleNumericalAggregation": { "MarkdownDocumentation": "`SimpleNumericalAggregation`\n\nBuilt-in aggregation functions for numerical values.\n* `SUM`: The sum of a dimension or measure.\n* `AVERAGE`: The average of a dimension or measure.\n* `MIN`: The minimum value of a dimension or measure.\n* `MAX`: The maximum value of a dimension or measure.\n* `COUNT`: The count of a dimension or measure.\n* `DISTINCT_COUNT`: The count of distinct values in a dimension or measure.\n* `VAR`: The variance of a dimension or measure.\n* `VARP`: The partitioned variance of a dimension or measure.\n* `STDEV`: The standard deviation of a dimension or measure.\n* `STDEVP`: The partitioned standard deviation of a dimension or measure.\n* `MEDIAN`: The median value of a dimension or measure.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUM | AVERAGE | MIN | MAX |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUM", "AVERAGE", "MIN", "MAX", "COUNT", "DISTINCT_COUNT", "VAR", "VARP", "STDEV", "STDEVP", "MEDIAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalaggregationfunction.html#cfn-quicksight-template-numericalaggregationfunction-simplenumericalaggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NumericalDimensionField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericalDimensionField`\n\nThe dimension type field with numerical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe custom hierarchy ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html#cfn-quicksight-template-numericaldimensionfield-hierarchyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-template-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html#cfn-quicksight-template-numericaldimensionfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `NumericalDimensionField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html#cfn-quicksight-template-numericaldimensionfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html#cfn-quicksight-template-numericaldimensionfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.NumericalMeasureField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.NumericalMeasureField`\n\nThe measure type field with numerical type columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html", "Properties": { "AggregationFunction": { "MarkdownDocumentation": "`AggregationFunction`\n\nThe aggregation function of the measure field.\n*Required*: No\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-template-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html#cfn-quicksight-template-numericalmeasurefield-aggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "NumericalAggregationFunction" }, "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [NumberFormatConfiguration](./aws-properties-quicksight-template-numberformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html#cfn-quicksight-template-numericalmeasurefield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumberFormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `NumericalMeasureField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html#cfn-quicksight-template-numericalmeasurefield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html#cfn-quicksight-template-numericalmeasurefield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PaginationConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PaginationConfiguration`\n\nThe pagination configuration for a table visual or boxplot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paginationconfiguration.html", "Properties": { "PageSize": { "MarkdownDocumentation": "`PageSize`\n\nIndicates how many items render in one page.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paginationconfiguration.html#cfn-quicksight-template-paginationconfiguration-pagesize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "PageNumber": { "MarkdownDocumentation": "`PageNumber`\n\nIndicates the page number.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paginationconfiguration.html#cfn-quicksight-template-paginationconfiguration-pagenumber", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.PanelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PanelConfiguration`\n\nA collection of options that configure how each panel displays in a small multiples chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html", "Properties": { "BorderThickness": { "MarkdownDocumentation": "`BorderThickness`\n\nSets the line thickness of panel borders.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-borderthickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BorderStyle": { "MarkdownDocumentation": "`BorderStyle`\n\nSets the line style of panel borders.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DASHED | DOTTED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DASHED", "DOTTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-borderstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GutterSpacing": { "MarkdownDocumentation": "`GutterSpacing`\n\nSets the total amount of negative space to display between sibling panels.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-gutterspacing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundVisibility": { "MarkdownDocumentation": "`BackgroundVisibility`\n\nDetermines whether or not a background for each small multiples panel is rendered.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-backgroundvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "BorderVisibility": { "MarkdownDocumentation": "`BorderVisibility`\n\nDetermines whether or not each panel displays a border.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-bordervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "BorderColor": { "MarkdownDocumentation": "`BorderColor`\n\nSets the line color of panel borders.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-bordercolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nConfigures the title display within each small multiples panel.\n*Required*: No\n*Type*: [PanelTitleOptions](./aws-properties-quicksight-template-paneltitleoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-title", "UpdateType": "Mutable", "Required": false, "Type": "PanelTitleOptions" }, "GutterVisibility": { "MarkdownDocumentation": "`GutterVisibility`\n\nDetermines whether or not negative space between sibling panels is rendered.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-guttervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nSets the background color for each panel.\n*Required*: No\n*Type*: String\n*Pattern*: `^#[A-F0-9]{6}(?:[A-F0-9]{2})?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PanelTitleOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PanelTitleOptions`\n\nThe options that determine the title styles for each small multiples\npanel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paneltitleoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not panel titles are displayed.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paneltitleoptions.html#cfn-quicksight-template-paneltitleoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paneltitleoptions.html#cfn-quicksight-template-paneltitleoptions-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "HorizontalTextAlignment": { "MarkdownDocumentation": "`HorizontalTextAlignment`\n\nSets the horizontal text alignment of the title within each panel.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paneltitleoptions.html#cfn-quicksight-template-paneltitleoptions-horizontaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ParameterControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterControl`\n\nThe control of a parameter that users can interact with in a dashboard or an analysis.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html", "Properties": { "Slider": { "MarkdownDocumentation": "`Slider`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n*Required*: No\n*Type*: [ParameterSliderControl](./aws-properties-quicksight-template-parameterslidercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-slider", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSliderControl" }, "TextArea": { "MarkdownDocumentation": "`TextArea`\n\nA control to display a text box that is used to enter multiple entries.\n*Required*: No\n*Type*: [ParameterTextAreaControl](./aws-properties-quicksight-template-parametertextareacontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-textarea", "UpdateType": "Mutable", "Required": false, "Type": "ParameterTextAreaControl" }, "Dropdown": { "MarkdownDocumentation": "`Dropdown`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n*Required*: No\n*Type*: [ParameterDropDownControl](./aws-properties-quicksight-template-parameterdropdowncontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-dropdown", "UpdateType": "Mutable", "Required": false, "Type": "ParameterDropDownControl" }, "TextField": { "MarkdownDocumentation": "`TextField`\n\nA control to display a text box that is used to enter a single entry.\n*Required*: No\n*Type*: [ParameterTextFieldControl](./aws-properties-quicksight-template-parametertextfieldcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-textfield", "UpdateType": "Mutable", "Required": false, "Type": "ParameterTextFieldControl" }, "List": { "MarkdownDocumentation": "`List`\n\nA control to display a list with buttons or boxes that are used to select either a single value or multiple values.\n*Required*: No\n*Type*: [ParameterListControl](./aws-properties-quicksight-template-parameterlistcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-list", "UpdateType": "Mutable", "Required": false, "Type": "ParameterListControl" }, "DateTimePicker": { "MarkdownDocumentation": "`DateTimePicker`\n\nA control from a date parameter that specifies date and time.\n*Required*: No\n*Type*: [ParameterDateTimePickerControl](./aws-properties-quicksight-template-parameterdatetimepickercontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-datetimepicker", "UpdateType": "Mutable", "Required": false, "Type": "ParameterDateTimePickerControl" } } }, "AWS::QuickSight::Template.ParameterDateTimePickerControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterDateTimePickerControl`\n\nA control from a date parameter that specifies date and time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html#cfn-quicksight-template-parameterdatetimepickercontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DateTimePickerControlDisplayOptions](./aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html#cfn-quicksight-template-parameterdatetimepickercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DateTimePickerControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe name of the `ParameterDateTimePickerControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html#cfn-quicksight-template-parameterdatetimepickercontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterDateTimePickerControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html#cfn-quicksight-template-parameterdatetimepickercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterDeclaration`\n\nThe declaration definition of a parameter.\nFor more information, see [Parameters in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the *Amazon Quick Suite User Guide*.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html", "Properties": { "StringParameterDeclaration": { "MarkdownDocumentation": "`StringParameterDeclaration`\n\nA parameter declaration for the `String` data type.\n*Required*: No\n*Type*: [StringParameterDeclaration](./aws-properties-quicksight-template-stringparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html#cfn-quicksight-template-parameterdeclaration-stringparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "StringParameterDeclaration" }, "DateTimeParameterDeclaration": { "MarkdownDocumentation": "`DateTimeParameterDeclaration`\n\nA parameter declaration for the `DateTime` data type.\n*Required*: No\n*Type*: [DateTimeParameterDeclaration](./aws-properties-quicksight-template-datetimeparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html#cfn-quicksight-template-parameterdeclaration-datetimeparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "DateTimeParameterDeclaration" }, "DecimalParameterDeclaration": { "MarkdownDocumentation": "`DecimalParameterDeclaration`\n\nA parameter declaration for the `Decimal` data type.\n*Required*: No\n*Type*: [DecimalParameterDeclaration](./aws-properties-quicksight-template-decimalparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html#cfn-quicksight-template-parameterdeclaration-decimalparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalParameterDeclaration" }, "IntegerParameterDeclaration": { "MarkdownDocumentation": "`IntegerParameterDeclaration`\n\nA parameter declaration for the `Integer` data type.\n*Required*: No\n*Type*: [IntegerParameterDeclaration](./aws-properties-quicksight-template-integerparameterdeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html#cfn-quicksight-template-parameterdeclaration-integerparameterdeclaration", "UpdateType": "Mutable", "Required": false, "Type": "IntegerParameterDeclaration" } } }, "AWS::QuickSight::Template.ParameterDropDownControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterDropDownControl`\n\nA control to display a dropdown list with buttons that are used to select a single value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type parameter name of the `ParameterDropDownControl`.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [DropDownControlDisplayOptions](./aws-properties-quicksight-template-dropdowncontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "DropDownControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterDropDownControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-template-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterDropDownControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CommitMode": { "MarkdownDocumentation": "`CommitMode`\n\nThe visibility configuration of the Apply button on a `ParameterDropDownControl`.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-commitmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [ParameterSelectableValues](./aws-properties-quicksight-template-parameterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSelectableValues" } } }, "AWS::QuickSight::Template.ParameterListControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterListControl`\n\nA control to display a list with buttons or boxes that are used to select either a single value or multiple values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of `ParameterListControl`.\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_SELECT | SINGLE_SELEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_SELECT", "SINGLE_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [ListControlDisplayOptions](./aws-properties-quicksight-template-listcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "ListControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterListControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CascadingControlConfiguration": { "MarkdownDocumentation": "`CascadingControlConfiguration`\n\nThe values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.\n*Required*: No\n*Type*: [CascadingControlConfiguration](./aws-properties-quicksight-template-cascadingcontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-cascadingcontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CascadingControlConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterListControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SelectableValues": { "MarkdownDocumentation": "`SelectableValues`\n\nA list of selectable values that are used in a control.\n*Required*: No\n*Type*: [ParameterSelectableValues](./aws-properties-quicksight-template-parameterselectablevalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-selectablevalues", "UpdateType": "Mutable", "Required": false, "Type": "ParameterSelectableValues" } } }, "AWS::QuickSight::Template.ParameterSelectableValues": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterSelectableValues`\n\nA list of selectable values that are used in a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterselectablevalues.html", "Properties": { "LinkToDataSetColumn": { "MarkdownDocumentation": "`LinkToDataSetColumn`\n\nThe column identifier that fetches values from the data set.\n*Required*: No\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterselectablevalues.html#cfn-quicksight-template-parameterselectablevalues-linktodatasetcolumn", "UpdateType": "Mutable", "Required": false, "Type": "ColumnIdentifier" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are used in `ParameterSelectableValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterselectablevalues.html#cfn-quicksight-template-parameterselectablevalues-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ParameterSliderControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterSliderControl`\n\nA control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StepSize": { "MarkdownDocumentation": "`StepSize`\n\nThe number of increments that the slider bar is divided into.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-stepsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [SliderControlDisplayOptions](./aws-properties-quicksight-template-slidercontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "SliderControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterSliderControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterSliderControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaximumValue": { "MarkdownDocumentation": "`MaximumValue`\n\nThe larger value that is displayed at the right of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-maximumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MinimumValue": { "MarkdownDocumentation": "`MinimumValue`\n\nThe smaller value that is displayed at the left of the slider.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-minimumvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.ParameterTextAreaControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterTextAreaControl`\n\nA control to display a text box that is used to enter multiple entries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThe delimiter that is used to separate the lines in text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextAreaControlDisplayOptions](./aws-properties-quicksight-template-textareacontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextAreaControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterTextAreaControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterTextAreaControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ParameterTextFieldControl": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ParameterTextFieldControl`\n\nA control to display a text box that is used to enter a single entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html", "Properties": { "ParameterControlId": { "MarkdownDocumentation": "`ParameterControlId`\n\nThe ID of the `ParameterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html#cfn-quicksight-template-parametertextfieldcontrol-parametercontrolid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayOptions": { "MarkdownDocumentation": "`DisplayOptions`\n\nThe display options of a control.\n*Required*: No\n*Type*: [TextFieldControlDisplayOptions](./aws-properties-quicksight-template-textfieldcontroldisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html#cfn-quicksight-template-parametertextfieldcontrol-displayoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextFieldControlDisplayOptions" }, "SourceParameterName": { "MarkdownDocumentation": "`SourceParameterName`\n\nThe source parameter name of the `ParameterTextFieldControl`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html#cfn-quicksight-template-parametertextfieldcontrol-sourceparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the `ParameterTextFieldControl`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html#cfn-quicksight-template-parametertextfieldcontrol-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PercentVisibleRange": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PercentVisibleRange`\n\nThe percent range in the visible range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentvisiblerange.html", "Properties": { "From": { "MarkdownDocumentation": "`From`\n\nThe lower bound of the range.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentvisiblerange.html#cfn-quicksight-template-percentvisiblerange-from", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "To": { "MarkdownDocumentation": "`To`\n\nThe top bound of the range.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentvisiblerange.html#cfn-quicksight-template-percentvisiblerange-to", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.PercentageDisplayFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PercentageDisplayFormatConfiguration`\n\nThe options that determine the percentage display format configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html", "Properties": { "NegativeValueConfiguration": { "MarkdownDocumentation": "`NegativeValueConfiguration`\n\nThe options that determine the negative value configuration.\n*Required*: No\n*Type*: [NegativeValueConfiguration](./aws-properties-quicksight-template-negativevalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-negativevalueconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NegativeValueConfiguration" }, "DecimalPlacesConfiguration": { "MarkdownDocumentation": "`DecimalPlacesConfiguration`\n\nThe option that determines the decimal places configuration.\n*Required*: No\n*Type*: [DecimalPlacesConfiguration](./aws-properties-quicksight-template-decimalplacesconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-decimalplacesconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DecimalPlacesConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-template-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nDetermines the suffix value of the percentage format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeparatorConfiguration": { "MarkdownDocumentation": "`SeparatorConfiguration`\n\nThe options that determine the numeric separator configuration.\n*Required*: No\n*Type*: [NumericSeparatorConfiguration](./aws-properties-quicksight-template-numericseparatorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-separatorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericSeparatorConfiguration" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nDetermines the prefix value of the percentage format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PercentileAggregation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PercentileAggregation`\n\nAn aggregation based on the percentile of values in a dimension or measure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentileaggregation.html", "Properties": { "PercentileValue": { "MarkdownDocumentation": "`PercentileValue`\n\nThe percentile value. This value can be any numeric constant 0\u2013100. A percentile value of 50 computes the median value of the measure.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentileaggregation.html#cfn-quicksight-template-percentileaggregation-percentilevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.PeriodOverPeriodComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PeriodOverPeriodComputation`\n\nThe period over period computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html#cfn-quicksight-template-periodoverperiodcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html#cfn-quicksight-template-periodoverperiodcomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html#cfn-quicksight-template-periodoverperiodcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html#cfn-quicksight-template-periodoverperiodcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PeriodToDateComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PeriodToDateComputation`\n\nThe period to date computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html", "Properties": { "PeriodTimeGranularity": { "MarkdownDocumentation": "`PeriodTimeGranularity`\n\nThe time granularity setup of period to date computation. Choose from the following options:\n* YEAR: Year to date.\n* MONTH: Month to date.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-periodtimegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PieChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PieChartAggregatedFieldWells`\n\nThe field well configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category (group/color) field wells of a pie chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartaggregatedfieldwells.html#cfn-quicksight-template-piechartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a pie chart. Values are aggregated based on categories.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartaggregatedfieldwells.html#cfn-quicksight-template-piechartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "SmallMultiples": { "MarkdownDocumentation": "`SmallMultiples`\n\nThe small multiples field well of a pie chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartaggregatedfieldwells.html#cfn-quicksight-template-piechartaggregatedfieldwells-smallmultiples", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PieChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PieChartConfiguration`\n\nThe configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartSortConfiguration](./aws-properties-quicksight-template-piechartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PieChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ContributionAnalysisDefaults": { "MarkdownDocumentation": "`ContributionAnalysisDefaults`\n\nThe contribution analysis (anomaly configuration) setup of the visual.\n*Required*: No\n*Type*: Array of [ContributionAnalysisDefault](./aws-properties-quicksight-template-contributionanalysisdefault.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-contributionanalysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContributionAnalysisDefault", "DuplicatesAllowed": true }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options of the group/color that is displayed in a pie chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [PieChartFieldWells](./aws-properties-quicksight-template-piechartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PieChartFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "DonutOptions": { "MarkdownDocumentation": "`DonutOptions`\n\nThe options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.\n*Required*: No\n*Type*: [DonutOptions](./aws-properties-quicksight-template-donutoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-donutoptions", "UpdateType": "Mutable", "Required": false, "Type": "DonutOptions" }, "SmallMultiplesOptions": { "MarkdownDocumentation": "`SmallMultiplesOptions`\n\nThe small multiples setup for the visual.\n*Required*: No\n*Type*: [SmallMultiplesOptions](./aws-properties-quicksight-template-smallmultiplesoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-smallmultiplesoptions", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "ValueLabelOptions": { "MarkdownDocumentation": "`ValueLabelOptions`\n\nThe label options for the value that is displayed in a pie chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-valuelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Template.PieChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PieChartFieldWells`\n\nThe field well configuration of a pie chart.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartfieldwells.html", "Properties": { "PieChartAggregatedFieldWells": { "MarkdownDocumentation": "`PieChartAggregatedFieldWells`\n\nThe field well configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartAggregatedFieldWells](./aws-properties-quicksight-template-piechartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartfieldwells.html#cfn-quicksight-template-piechartfieldwells-piechartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PieChartAggregatedFieldWells" } } }, "AWS::QuickSight::Template.PieChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PieChartSortConfiguration`\n\nThe sort configuration of a pie chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html", "Properties": { "SmallMultiplesSort": { "MarkdownDocumentation": "`SmallMultiplesSort`\n\nThe sort configuration of the small multiples field.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html#cfn-quicksight-template-piechartsortconfiguration-smallmultiplessort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of categories that are displayed in a pie chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html#cfn-quicksight-template-piechartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html#cfn-quicksight-template-piechartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SmallMultiplesLimitConfiguration": { "MarkdownDocumentation": "`SmallMultiplesLimitConfiguration`\n\nThe limit on the number of small multiples panels that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html#cfn-quicksight-template-piechartsortconfiguration-smallmultipleslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Template.PieChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PieChartVisual`\n\nA pie or donut chart.\nThe `PieChartVisual` structure describes a visual that is a member of the pie chart family.\nThe following charts can be described by using this structure:\n* Pie charts\n* Donut charts\nFor more information, see [Using pie charts](https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the *Amazon Quick Suite User Guide*.\nFor more information, see [Using donut charts](https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a pie chart.\n*Required*: No\n*Type*: [PieChartConfiguration](./aws-properties-quicksight-template-piechartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PieChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PivotFieldSortOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotFieldSortOptions`\n\nThe field sort options for a pivot table sort configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.html", "Properties": { "SortBy": { "MarkdownDocumentation": "`SortBy`\n\nThe sort by field for the field sort options.\n*Required*: Yes\n*Type*: [PivotTableSortBy](./aws-properties-quicksight-template-pivottablesortby.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.html#cfn-quicksight-template-pivotfieldsortoptions-sortby", "UpdateType": "Mutable", "Required": true, "Type": "PivotTableSortBy" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for the field sort options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.html#cfn-quicksight-template-pivotfieldsortoptions-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PivotTableAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableAggregatedFieldWells`\n\nThe aggregated field well for the pivot table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are aggregated based on rows and columns fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableaggregatedfieldwells.html#cfn-quicksight-template-pivottableaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe columns field well for a pivot table. Values are grouped by columns fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableaggregatedfieldwells.html#cfn-quicksight-template-pivottableaggregatedfieldwells-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Rows": { "MarkdownDocumentation": "`Rows`\n\nThe rows field well for a pivot table. Values are grouped by rows fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableaggregatedfieldwells.html#cfn-quicksight-template-pivottableaggregatedfieldwells-rows", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PivotTableCellConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableCellConditionalFormatting`\n\nThe cell conditional formatting option for a pivot table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope of the cell for conditional formatting.\n*Required*: No\n*Type*: [PivotTableConditionalFormattingScope](./aws-properties-quicksight-template-pivottableconditionalformattingscope.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html#cfn-quicksight-template-pivottablecellconditionalformatting-scope", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConditionalFormattingScope" }, "Scopes": { "MarkdownDocumentation": "`Scopes`\n\nA list of cell scopes for conditional formatting.\n*Required*: No\n*Type*: Array of [PivotTableConditionalFormattingScope](./aws-properties-quicksight-template-pivottableconditionalformattingscope.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html#cfn-quicksight-template-pivottablecellconditionalformatting-scopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableConditionalFormattingScope", "DuplicatesAllowed": true }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the cell for conditional formatting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html#cfn-quicksight-template-pivottablecellconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TextFormat": { "MarkdownDocumentation": "`TextFormat`\n\nThe text format of the cell for conditional formatting.\n*Required*: No\n*Type*: [TextConditionalFormat](./aws-properties-quicksight-template-textconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html#cfn-quicksight-template-pivottablecellconditionalformatting-textformat", "UpdateType": "Mutable", "Required": false, "Type": "TextConditionalFormat" } } }, "AWS::QuickSight::Template.PivotTableConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options for a `PivotTableVisual`.\n*Required*: No\n*Type*: Array of [PivotTableConditionalFormattingOption](./aws-properties-quicksight-template-pivottableconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformatting.html#cfn-quicksight-template-pivottableconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PivotTableConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableConditionalFormattingOption`\n\nConditional formatting options for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformattingoption.html", "Properties": { "Cell": { "MarkdownDocumentation": "`Cell`\n\nThe cell conditional formatting option for a pivot table.\n*Required*: No\n*Type*: [PivotTableCellConditionalFormatting](./aws-properties-quicksight-template-pivottablecellconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformattingoption.html#cfn-quicksight-template-pivottableconditionalformattingoption-cell", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableCellConditionalFormatting" } } }, "AWS::QuickSight::Template.PivotTableConditionalFormattingScope": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableConditionalFormattingScope`\n\nThe scope of the cell for conditional formatting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformattingscope.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe role (field, field total, grand total) of the cell for conditional formatting.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIELD | FIELD_TOTAL | GRAND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIELD", "FIELD_TOTAL", "GRAND_TOTAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformattingscope.html#cfn-quicksight-template-pivottableconditionalformattingscope-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PivotTableConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableConfiguration`\n\nThe configuration for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration for a `PivotTableVisual`.\n*Required*: No\n*Type*: [PivotTableSortConfiguration](./aws-properties-quicksight-template-pivottablesortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableSortConfiguration" }, "PaginatedReportOptions": { "MarkdownDocumentation": "`PaginatedReportOptions`\n\nThe paginated report options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTablePaginatedReportOptions](./aws-properties-quicksight-template-pivottablepaginatedreportoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-paginatedreportoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTablePaginatedReportOptions" }, "TableOptions": { "MarkdownDocumentation": "`TableOptions`\n\nThe table options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableOptions](./aws-properties-quicksight-template-pivottableoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-tableoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [PivotTableFieldWells](./aws-properties-quicksight-template-pivottablefieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableFieldWells" }, "FieldOptions": { "MarkdownDocumentation": "`FieldOptions`\n\nThe field options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableFieldOptions](./aws-properties-quicksight-template-pivottablefieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-fieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableFieldOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "TotalOptions": { "MarkdownDocumentation": "`TotalOptions`\n\nThe total options for a pivot table visual.\n*Required*: No\n*Type*: [PivotTableTotalOptions](./aws-properties-quicksight-template-pivottabletotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-totaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableTotalOptions" } } }, "AWS::QuickSight::Template.PivotTableDataPathOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableDataPathOption`\n\nThe data path options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabledatapathoption.html", "Properties": { "DataPathList": { "MarkdownDocumentation": "`DataPathList`\n\nThe list of data path values for the data path options.\n*Required*: Yes\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-template-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabledatapathoption.html#cfn-quicksight-template-pivottabledatapathoption-datapathlist", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width of the data path 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabledatapathoption.html#cfn-quicksight-template-pivottabledatapathoption-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PivotTableFieldCollapseStateOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableFieldCollapseStateOption`\n\nThe collapse state options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestateoption.html", "Properties": { "Target": { "MarkdownDocumentation": "`Target`\n\nA tagged-union object that sets the collapse state.\n*Required*: Yes\n*Type*: [PivotTableFieldCollapseStateTarget](./aws-properties-quicksight-template-pivottablefieldcollapsestatetarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestateoption.html#cfn-quicksight-template-pivottablefieldcollapsestateoption-target", "UpdateType": "Mutable", "Required": true, "Type": "PivotTableFieldCollapseStateTarget" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the field target of a pivot table. Choose one of the following options:\n* `COLLAPSED`\n* `EXPANDED`\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)", "RefReturnValue": "", "AllowedValues": [ "COLLAPSED", "EXPANDED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestateoption.html#cfn-quicksight-template-pivottablefieldcollapsestateoption-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PivotTableFieldCollapseStateTarget": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableFieldCollapseStateTarget`\n\nThe target of a pivot table field collapse state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestatetarget.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the pivot table that the collapse state needs to be set 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestatetarget.html#cfn-quicksight-template-pivottablefieldcollapsestatetarget-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldDataPathValues": { "MarkdownDocumentation": "`FieldDataPathValues`\n\nThe data path of the pivot table's header. Used to set the collapse state.\n*Required*: No\n*Type*: Array of [DataPathValue](./aws-properties-quicksight-template-datapathvalue.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestatetarget.html#cfn-quicksight-template-pivottablefieldcollapsestatetarget-fielddatapathvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataPathValue", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PivotTableFieldOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableFieldOption`\n\nThe selected field options for the pivot table field options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoption.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label of the pivot table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoption.html#cfn-quicksight-template-pivottablefieldoption-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the pivot table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoption.html#cfn-quicksight-template-pivottablefieldoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the pivot table field.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoption.html#cfn-quicksight-template-pivottablefieldoption-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.PivotTableFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableFieldOptions`\n\nThe field options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html", "Properties": { "CollapseStateOptions": { "MarkdownDocumentation": "`CollapseStateOptions`\n\nThe collapse state options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableFieldCollapseStateOption](./aws-properties-quicksight-template-pivottablefieldcollapsestateoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-collapsestateoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldCollapseStateOption", "DuplicatesAllowed": true }, "DataPathOptions": { "MarkdownDocumentation": "`DataPathOptions`\n\nThe data path options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableDataPathOption](./aws-properties-quicksight-template-pivottabledatapathoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-datapathoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableDataPathOption", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nThe selected field options for the pivot table field options.\n*Required*: No\n*Type*: Array of [PivotTableFieldOption](./aws-properties-quicksight-template-pivottablefieldoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PivotTableFieldSubtotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableFieldSubtotalOptions`\n\nThe optional configuration of subtotals cells.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldsubtotaloptions.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the subtotal options.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldsubtotaloptions.html#cfn-quicksight-template-pivottablefieldsubtotaloptions-fieldid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PivotTableFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableFieldWells`\n\nThe field wells for a pivot table visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldwells.html", "Properties": { "PivotTableAggregatedFieldWells": { "MarkdownDocumentation": "`PivotTableAggregatedFieldWells`\n\nThe aggregated field well for the pivot table.\n*Required*: No\n*Type*: [PivotTableAggregatedFieldWells](./aws-properties-quicksight-template-pivottableaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldwells.html#cfn-quicksight-template-pivottablefieldwells-pivottableaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableAggregatedFieldWells" } } }, "AWS::QuickSight::Template.PivotTableOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableOptions`\n\nThe table options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html", "Properties": { "RowFieldNamesStyle": { "MarkdownDocumentation": "`RowFieldNamesStyle`\n\nThe table cell style of row field names.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowfieldnamesstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "RowHeaderStyle": { "MarkdownDocumentation": "`RowHeaderStyle`\n\nThe table cell style of the row headers.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowheaderstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "CollapsedRowDimensionsVisibility": { "MarkdownDocumentation": "`CollapsedRowDimensionsVisibility`\n\nThe visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is `HIDDEN`, all collapsed columns in a pivot table are automatically hidden. The default value is `VISIBLE`.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-collapsedrowdimensionsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "RowsLayout": { "MarkdownDocumentation": "`RowsLayout`\n\nThe layout for the row dimension headers of a pivot table. Choose one of the following options.\n* `TABULAR`: (Default) Each row field is displayed in a separate column.\n* `HIERARCHY`: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.\n*Required*: No\n*Type*: String\n*Allowed values*: `TABULAR | HIERARCHY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TABULAR", "HIERARCHY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowslayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricPlacement": { "MarkdownDocumentation": "`MetricPlacement`\n\nThe metric placement (row, column) options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ROW | COLUMN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROW", "COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-metricplacement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultCellWidth": { "MarkdownDocumentation": "`DefaultCellWidth`\n\nThe default cell width of the pivot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-defaultcellwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnNamesVisibility": { "MarkdownDocumentation": "`ColumnNamesVisibility`\n\nThe visibility of the column names.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-columnnamesvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "RowsLabelOptions": { "MarkdownDocumentation": "`RowsLabelOptions`\n\nThe options for the label that is located above the row headers. This option is only applicable when `RowsLayout` is set to `HIERARCHY`.\n*Required*: No\n*Type*: [PivotTableRowsLabelOptions](./aws-properties-quicksight-template-pivottablerowslabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowslabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableRowsLabelOptions" }, "SingleMetricVisibility": { "MarkdownDocumentation": "`SingleMetricVisibility`\n\nThe visibility of the single metric options.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-singlemetricvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "ColumnHeaderStyle": { "MarkdownDocumentation": "`ColumnHeaderStyle`\n\nThe table cell style of the column header.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-columnheaderstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "ToggleButtonsVisibility": { "MarkdownDocumentation": "`ToggleButtonsVisibility`\n\nDetermines the visibility of the pivot table.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-togglebuttonsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "CellStyle": { "MarkdownDocumentation": "`CellStyle`\n\nThe table cell style of cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-cellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "RowAlternateColorOptions": { "MarkdownDocumentation": "`RowAlternateColorOptions`\n\nThe row alternate color options (widget status, row alternate colors).\n*Required*: No\n*Type*: [RowAlternateColorOptions](./aws-properties-quicksight-template-rowalternatecoloroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowalternatecoloroptions", "UpdateType": "Mutable", "Required": false, "Type": "RowAlternateColorOptions" } } }, "AWS::QuickSight::Template.PivotTablePaginatedReportOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTablePaginatedReportOptions`\n\nThe paginated report options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablepaginatedreportoptions.html", "Properties": { "OverflowColumnHeaderVisibility": { "MarkdownDocumentation": "`OverflowColumnHeaderVisibility`\n\nThe visibility of the repeating header rows on each page.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablepaginatedreportoptions.html#cfn-quicksight-template-pivottablepaginatedreportoptions-overflowcolumnheadervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "VerticalOverflowVisibility": { "MarkdownDocumentation": "`VerticalOverflowVisibility`\n\nThe visibility of the printing table overflow across pages.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablepaginatedreportoptions.html#cfn-quicksight-template-pivottablepaginatedreportoptions-verticaloverflowvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.PivotTableRowsLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableRowsLabelOptions`\n\nThe options for the label thta is located above the row headers. This option is only applicable when `RowsLayout` is set to `HIERARCHY`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablerowslabeloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the rows label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablerowslabeloptions.html#cfn-quicksight-template-pivottablerowslabeloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the rows label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablerowslabeloptions.html#cfn-quicksight-template-pivottablerowslabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.PivotTableSortBy": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableSortBy`\n\nThe sort by field for the field sort options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortby.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field sort (field id, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [FieldSort](./aws-properties-quicksight-template-fieldsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortby.html#cfn-quicksight-template-pivottablesortby-field", "UpdateType": "Mutable", "Required": false, "Type": "FieldSort" }, "DataPath": { "MarkdownDocumentation": "`DataPath`\n\nThe data path sort (data path value, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [DataPathSort](./aws-properties-quicksight-template-datapathsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortby.html#cfn-quicksight-template-pivottablesortby-datapath", "UpdateType": "Mutable", "Required": false, "Type": "DataPathSort" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column sort (field id, direction) for the pivot table sort by options.\n*Required*: No\n*Type*: [ColumnSort](./aws-properties-quicksight-template-columnsort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortby.html#cfn-quicksight-template-pivottablesortby-column", "UpdateType": "Mutable", "Required": false, "Type": "ColumnSort" } } }, "AWS::QuickSight::Template.PivotTableSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableSortConfiguration`\n\nThe sort configuration for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortconfiguration.html", "Properties": { "FieldSortOptions": { "MarkdownDocumentation": "`FieldSortOptions`\n\nThe field sort options for a pivot table sort configuration.\n*Required*: No\n*Type*: [Array](./aws-properties-quicksight-template-fieldsortoptions.html) of [PivotFieldSortOptions](./aws-properties-quicksight-template-pivotfieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortconfiguration.html#cfn-quicksight-template-pivottablesortconfiguration-fieldsortoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotFieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PivotTableTotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableTotalOptions`\n\nThe total options for a pivot table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html", "Properties": { "ColumnSubtotalOptions": { "MarkdownDocumentation": "`ColumnSubtotalOptions`\n\nThe column subtotal options.\n*Required*: No\n*Type*: [SubtotalOptions](./aws-properties-quicksight-template-subtotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html#cfn-quicksight-template-pivottabletotaloptions-columnsubtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "SubtotalOptions" }, "RowSubtotalOptions": { "MarkdownDocumentation": "`RowSubtotalOptions`\n\nThe row subtotal options.\n*Required*: No\n*Type*: [SubtotalOptions](./aws-properties-quicksight-template-subtotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html#cfn-quicksight-template-pivottabletotaloptions-rowsubtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "SubtotalOptions" }, "RowTotalOptions": { "MarkdownDocumentation": "`RowTotalOptions`\n\nThe row total options.\n*Required*: No\n*Type*: [PivotTotalOptions](./aws-properties-quicksight-template-pivottotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html#cfn-quicksight-template-pivottabletotaloptions-rowtotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTotalOptions" }, "ColumnTotalOptions": { "MarkdownDocumentation": "`ColumnTotalOptions`\n\nThe column total options.\n*Required*: No\n*Type*: [PivotTotalOptions](./aws-properties-quicksight-template-pivottotaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html#cfn-quicksight-template-pivottabletotaloptions-columntotaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PivotTotalOptions" } } }, "AWS::QuickSight::Template.PivotTableVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTableVisual`\n\nA pivot table.\nFor more information, see [Using pivot tables](https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n*Required*: No\n*Type*: [PivotTableConditionalFormatting](./aws-properties-quicksight-template-pivottableconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [PivotTableConfiguration](./aws-properties-quicksight-template-pivottableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PivotTotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PivotTotalOptions`\n\nThe optional configuration of totals cells in a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html", "Properties": { "TotalAggregationOptions": { "MarkdownDocumentation": "`TotalAggregationOptions`\n\nThe total aggregation options for each value field.\n*Required*: No\n*Type*: Array of [TotalAggregationOption](./aws-properties-quicksight-template-totalaggregationoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-totalaggregationoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TotalAggregationOption", "DuplicatesAllowed": true }, "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the total cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueCellStyle": { "MarkdownDocumentation": "`ValueCellStyle`\n\nThe cell styling options for the totals of value cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-valuecellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "ScrollStatus": { "MarkdownDocumentation": "`ScrollStatus`\n\nThe scroll status (pinned, scrolled) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `PINNED | SCROLLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PINNED", "SCROLLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-scrollstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe placement (start, end) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `START | END | AUTO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "START", "END", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nThe cell styling options for the total cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the total cells.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MetricHeaderCellStyle": { "MarkdownDocumentation": "`MetricHeaderCellStyle`\n\nThe cell styling options for the total of header cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-metricheadercellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" } } }, "AWS::QuickSight::Template.PluginVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PluginVisual`\n\nA flexible visualization type that allows engineers\nto create new custom charts in Quick Sight.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "PluginArn": { "MarkdownDocumentation": "`PluginArn`\n\nThe Amazon Resource Name (ARN) that reflects the plugin and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-pluginarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe ID of the visual that you want to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nA description of the plugin field wells and their persisted properties.\n*Required*: No\n*Type*: [PluginVisualConfiguration](./aws-properties-quicksight-template-pluginvisualconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualConfiguration" }, "Title": { "MarkdownDocumentation": "`Title`\n\nProperty description not available.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PluginVisualConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PluginVisualConfiguration`\n\nThe plugin visual configuration. This includes the field wells, sorting options, and persisted options of the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of the plugin visual.\n*Required*: No\n*Type*: [PluginVisualSortConfiguration](./aws-properties-quicksight-template-pluginvisualsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualconfiguration.html#cfn-quicksight-template-pluginvisualconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualSortConfiguration" }, "VisualOptions": { "MarkdownDocumentation": "`VisualOptions`\n\nThe persisted properties of the plugin visual.\n*Required*: No\n*Type*: [PluginVisualOptions](./aws-properties-quicksight-template-pluginvisualoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualconfiguration.html#cfn-quicksight-template-pluginvisualconfiguration-visualoptions", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells configuration of the plugin visual.\n*Required*: No\n*Type*: Array of [PluginVisualFieldWell](./aws-properties-quicksight-template-pluginvisualfieldwell.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualconfiguration.html#cfn-quicksight-template-pluginvisualconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PluginVisualFieldWell", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PluginVisualFieldWell": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PluginVisualFieldWell`\n\nA collection of field wells for a plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html", "Properties": { "Unaggregated": { "MarkdownDocumentation": "`Unaggregated`\n\nA list of unaggregated fields that exist in the field well.\n*Required*: No\n*Type*: Array of [UnaggregatedField](./aws-properties-quicksight-template-unaggregatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html#cfn-quicksight-template-pluginvisualfieldwell-unaggregated", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UnaggregatedField", "DuplicatesAllowed": true }, "AxisName": { "MarkdownDocumentation": "`AxisName`\n\nThe semantic axis name for the field well.\n*Required*: No\n*Type*: String\n*Allowed values*: `GROUP_BY | VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GROUP_BY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html#cfn-quicksight-template-pluginvisualfieldwell-axisname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Measures": { "MarkdownDocumentation": "`Measures`\n\nA list of measures that exist in the field well.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html#cfn-quicksight-template-pluginvisualfieldwell-measures", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nA list of dimensions for the field well.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html#cfn-quicksight-template-pluginvisualfieldwell-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PluginVisualItemsLimitConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PluginVisualItemsLimitConfiguration`\n\nA query limits configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualitemslimitconfiguration.html", "Properties": { "ItemsLimit": { "MarkdownDocumentation": "`ItemsLimit`\n\nDetermines how many values are be fetched at once.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualitemslimitconfiguration.html#cfn-quicksight-template-pluginvisualitemslimitconfiguration-itemslimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.PluginVisualOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PluginVisualOptions`\n\nThe options and persisted properties for the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualoptions.html", "Properties": { "VisualProperties": { "MarkdownDocumentation": "`VisualProperties`\n\nThe persisted properties and their values.\n*Required*: No\n*Type*: Array of [PluginVisualProperty](./aws-properties-quicksight-template-pluginvisualproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualoptions.html#cfn-quicksight-template-pluginvisualoptions-visualproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PluginVisualProperty", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PluginVisualProperty": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PluginVisualProperty`\n\nThe key value pair of the persisted property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualproperty.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the plugin visual 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualproperty.html#cfn-quicksight-template-pluginvisualproperty-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the plugin visual 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualproperty.html#cfn-quicksight-template-pluginvisualproperty-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.PluginVisualSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PluginVisualSortConfiguration`\n\nDetermines how the plugin visual sorts the data during query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualsortconfiguration.html", "Properties": { "PluginVisualTableQuerySort": { "MarkdownDocumentation": "`PluginVisualTableQuerySort`\n\nThe table query sorting options for the plugin visual.\n*Required*: No\n*Type*: [PluginVisualTableQuerySort](./aws-properties-quicksight-template-pluginvisualtablequerysort.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualsortconfiguration.html#cfn-quicksight-template-pluginvisualsortconfiguration-pluginvisualtablequerysort", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualTableQuerySort" } } }, "AWS::QuickSight::Template.PluginVisualTableQuerySort": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PluginVisualTableQuerySort`\n\nThe table query sorting options for the plugin visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualtablequerysort.html", "Properties": { "ItemsLimitConfiguration": { "MarkdownDocumentation": "`ItemsLimitConfiguration`\n\nThe maximum amount of data to be returned by a query.\n*Required*: No\n*Type*: [PluginVisualItemsLimitConfiguration](./aws-properties-quicksight-template-pluginvisualitemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualtablequerysort.html#cfn-quicksight-template-pluginvisualtablequerysort-itemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisualItemsLimitConfiguration" }, "RowSort": { "MarkdownDocumentation": "`RowSort`\n\nDetermines how data is sorted in the response.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualtablequerysort.html#cfn-quicksight-template-pluginvisualtablequerysort-rowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.PredefinedHierarchy": { "MarkdownDocumentation": "`AWS::QuickSight::Template.PredefinedHierarchy`\n\nThe option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-predefinedhierarchy.html", "Properties": { "HierarchyId": { "MarkdownDocumentation": "`HierarchyId`\n\nThe hierarchy ID of the predefined hierarchy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-predefinedhierarchy.html#cfn-quicksight-template-predefinedhierarchy-hierarchyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DrillDownFilters": { "MarkdownDocumentation": "`DrillDownFilters`\n\nThe option that determines the drill down filters for the predefined hierarchy.\n*Required*: No\n*Type*: Array of [DrillDownFilter](./aws-properties-quicksight-template-drilldownfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-predefinedhierarchy.html#cfn-quicksight-template-predefinedhierarchy-drilldownfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DrillDownFilter", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe list of columns that define the predefined hierarchy.\n*Required*: Yes\n*Type*: Array of [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-predefinedhierarchy.html#cfn-quicksight-template-predefinedhierarchy-columns", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ColumnIdentifier", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ProgressBarOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ProgressBarOptions`\n\nThe options that determine the presentation of the progress bar of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-progressbaroptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the progress bar.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-progressbaroptions.html#cfn-quicksight-template-progressbaroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.QueryExecutionOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.QueryExecutionOptions`\n\nA structure that describes the query execution options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-queryexecutionoptions.html", "Properties": { "QueryExecutionMode": { "MarkdownDocumentation": "`QueryExecutionMode`\n\nA structure that describes the query execution 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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-queryexecutionoptions.html#cfn-quicksight-template-queryexecutionoptions-queryexecutionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.RadarChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RadarChartAggregatedFieldWells`\n\nThe aggregated field well configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe aggregated field well categories of a radar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html#cfn-quicksight-template-radarchartaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color that are assigned to the aggregated field wells of a radar chart.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html#cfn-quicksight-template-radarchartaggregatedfieldwells-color", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values that are assigned to the aggregated field wells of a radar chart.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html#cfn-quicksight-template-radarchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.RadarChartAreaStyleSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RadarChartAreaStyleSettings`\n\nThe configured style settings of a radar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartareastylesettings.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility settings of a radar chart.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartareastylesettings.html#cfn-quicksight-template-radarchartareastylesettings-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.RadarChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RadarChartConfiguration`\n\nThe configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a `RadarChartVisual`.\n*Required*: No\n*Type*: [RadarChartSortConfiguration](./aws-properties-quicksight-template-radarchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "Shape": { "MarkdownDocumentation": "`Shape`\n\nThe shape of the radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `CIRCLE | POLYGON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIRCLE", "POLYGON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-shape", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseSeriesSettings": { "MarkdownDocumentation": "`BaseSeriesSettings`\n\nThe base sreies settings of a radar chart.\n*Required*: No\n*Type*: [RadarChartSeriesSettings](./aws-properties-quicksight-template-radarchartseriessettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-baseseriessettings", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartSeriesSettings" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe color label options of a radar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe category label options of a radar chart.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "AxesRangeScale": { "MarkdownDocumentation": "`AxesRangeScale`\n\nThe axis behavior options of a radar chart.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTO | INDEPENDENT | SHARED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "INDEPENDENT", "SHARED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-axesrangescale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "AlternateBandColorsVisibility": { "MarkdownDocumentation": "`AlternateBandColorsVisibility`\n\nDetermines the visibility of the colors of alternatign bands in a radar chart.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-alternatebandcolorsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "StartAngle": { "MarkdownDocumentation": "`StartAngle`\n\nThe start angle of a radar chart's axis.\n*Required*: No\n*Type*: Number\n*Minimum*: `-360`\n*Maximum*: `360`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-startangle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "CategoryAxis": { "MarkdownDocumentation": "`CategoryAxis`\n\nThe category axis of a radar chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-categoryaxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a `RadarChartVisual`.\n*Required*: No\n*Type*: [RadarChartFieldWells](./aws-properties-quicksight-template-radarchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartFieldWells" }, "ColorAxis": { "MarkdownDocumentation": "`ColorAxis`\n\nThe color axis of a radar chart.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-coloraxis", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "AlternateBandOddColor": { "MarkdownDocumentation": "`AlternateBandOddColor`\n\nThe color of the odd-numbered alternate bands of a radar chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-alternatebandoddcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "AlternateBandEvenColor": { "MarkdownDocumentation": "`AlternateBandEvenColor`\n\nThe color of the even-numbered alternate bands of a radar chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-alternatebandevencolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.RadarChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RadarChartFieldWells`\n\nThe field wells of a radar chart visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartfieldwells.html", "Properties": { "RadarChartAggregatedFieldWells": { "MarkdownDocumentation": "`RadarChartAggregatedFieldWells`\n\nThe aggregated field wells of a radar chart visual.\n*Required*: No\n*Type*: [RadarChartAggregatedFieldWells](./aws-properties-quicksight-template-radarchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartfieldwells.html#cfn-quicksight-template-radarchartfieldwells-radarchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartAggregatedFieldWells" } } }, "AWS::QuickSight::Template.RadarChartSeriesSettings": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RadarChartSeriesSettings`\n\nThe series settings of a radar chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartseriessettings.html", "Properties": { "AreaStyleSettings": { "MarkdownDocumentation": "`AreaStyleSettings`\n\nThe area style settings of a radar chart.\n*Required*: No\n*Type*: [RadarChartAreaStyleSettings](./aws-properties-quicksight-template-radarchartareastylesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartseriessettings.html#cfn-quicksight-template-radarchartseriessettings-areastylesettings", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartAreaStyleSettings" } } }, "AWS::QuickSight::Template.RadarChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RadarChartSortConfiguration`\n\nThe sort configuration of a `RadarChartVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html", "Properties": { "ColorSort": { "MarkdownDocumentation": "`ColorSort`\n\nThe color sort configuration of a radar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html#cfn-quicksight-template-radarchartsortconfiguration-colorsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "ColorItemsLimit": { "MarkdownDocumentation": "`ColorItemsLimit`\n\nThe color items limit of a radar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html#cfn-quicksight-template-radarchartsortconfiguration-coloritemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe category items limit for a radar chart.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html#cfn-quicksight-template-radarchartsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe category sort options of a radar chart.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html#cfn-quicksight-template-radarchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.RadarChartVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RadarChartVisual`\n\nA radar chart visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [RadarChartConfiguration](./aws-properties-quicksight-template-radarchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.RangeEndsLabelType": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RangeEndsLabelType`\n\nThe range ends label type of a data path label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rangeendslabeltype.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the range ends label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rangeendslabeltype.html#cfn-quicksight-template-rangeendslabeltype-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.ReferenceLine": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ReferenceLine`\n\nThe reference line visual display options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the reference line. Choose one of the following options:\n* `ENABLE`\n* `DISABLE`\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataConfiguration": { "MarkdownDocumentation": "`DataConfiguration`\n\nThe data configuration of the reference line.\n*Required*: Yes\n*Type*: [ReferenceLineDataConfiguration](./aws-properties-quicksight-template-referencelinedataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-dataconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ReferenceLineDataConfiguration" }, "LabelConfiguration": { "MarkdownDocumentation": "`LabelConfiguration`\n\nThe label configuration of the reference line.\n*Required*: No\n*Type*: [ReferenceLineLabelConfiguration](./aws-properties-quicksight-template-referencelinelabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-labelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineLabelConfiguration" }, "StyleConfiguration": { "MarkdownDocumentation": "`StyleConfiguration`\n\nThe style configuration of the reference line.\n*Required*: No\n*Type*: [ReferenceLineStyleConfiguration](./aws-properties-quicksight-template-referencelinestyleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-styleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineStyleConfiguration" } } }, "AWS::QuickSight::Template.ReferenceLineCustomLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ReferenceLineCustomLabelConfiguration`\n\nThe configuration for a custom label on a `ReferenceLine`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinecustomlabelconfiguration.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe string text of the custom label.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinecustomlabelconfiguration.html#cfn-quicksight-template-referencelinecustomlabelconfiguration-customlabel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ReferenceLineDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ReferenceLineDataConfiguration`\n\nThe data configuration of the reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html", "Properties": { "DynamicConfiguration": { "MarkdownDocumentation": "`DynamicConfiguration`\n\nThe dynamic configuration of the reference line data configuration.\n*Required*: No\n*Type*: [ReferenceLineDynamicDataConfiguration](./aws-properties-quicksight-template-referencelinedynamicdataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html#cfn-quicksight-template-referencelinedataconfiguration-dynamicconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineDynamicDataConfiguration" }, "AxisBinding": { "MarkdownDocumentation": "`AxisBinding`\n\nThe axis binding type of the reference line. Choose one of the following options:\n* `PrimaryY`\n* `SecondaryY`\n*Required*: No\n*Type*: String\n*Allowed values*: `PRIMARY_YAXIS | SECONDARY_Y...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_YAXIS", "SECONDARY_YAXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html#cfn-quicksight-template-referencelinedataconfiguration-axisbinding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SeriesType": { "MarkdownDocumentation": "`SeriesType`\n\nThe series type of the reference line data configuration. Choose one of the following options:\n* `BAR`\n* `LINE`\n*Required*: No\n*Type*: String\n*Allowed values*: `BAR | LINE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "BAR", "LINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html#cfn-quicksight-template-referencelinedataconfiguration-seriestype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StaticConfiguration": { "MarkdownDocumentation": "`StaticConfiguration`\n\nThe static data configuration of the reference line data configuration.\n*Required*: No\n*Type*: [ReferenceLineStaticDataConfiguration](./aws-properties-quicksight-template-referencelinestaticdataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html#cfn-quicksight-template-referencelinedataconfiguration-staticconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineStaticDataConfiguration" } } }, "AWS::QuickSight::Template.ReferenceLineDynamicDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ReferenceLineDynamicDataConfiguration`\n\nThe dynamic configuration of the reference line data configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedynamicdataconfiguration.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the dynamic data targets.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedynamicdataconfiguration.html#cfn-quicksight-template-referencelinedynamicdataconfiguration-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "MeasureAggregationFunction": { "MarkdownDocumentation": "`MeasureAggregationFunction`\n\nThe aggregation function that is used in the dynamic data.\n*Required*: No\n*Type*: [AggregationFunction](./aws-properties-quicksight-template-aggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedynamicdataconfiguration.html#cfn-quicksight-template-referencelinedynamicdataconfiguration-measureaggregationfunction", "UpdateType": "Mutable", "Required": false, "Type": "AggregationFunction" }, "Calculation": { "MarkdownDocumentation": "`Calculation`\n\nThe calculation that is used in the dynamic data.\n*Required*: Yes\n*Type*: [NumericalAggregationFunction](./aws-properties-quicksight-template-numericalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedynamicdataconfiguration.html#cfn-quicksight-template-referencelinedynamicdataconfiguration-calculation", "UpdateType": "Mutable", "Required": true, "Type": "NumericalAggregationFunction" } } }, "AWS::QuickSight::Template.ReferenceLineLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ReferenceLineLabelConfiguration`\n\nThe label configuration of a reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html", "Properties": { "HorizontalPosition": { "MarkdownDocumentation": "`HorizontalPosition`\n\nThe horizontal position configuration of the label in a reference line. Choose one of\nthe following options:\n* `LEFT`\n* `CENTER`\n* `RIGHT`\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-horizontalposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueLabelConfiguration": { "MarkdownDocumentation": "`ValueLabelConfiguration`\n\nThe value label configuration of the label in a reference line.\n*Required*: No\n*Type*: [ReferenceLineValueLabelConfiguration](./aws-properties-quicksight-template-referencelinevaluelabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-valuelabelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineValueLabelConfiguration" }, "CustomLabelConfiguration": { "MarkdownDocumentation": "`CustomLabelConfiguration`\n\nThe custom label configuration of the label in a reference line.\n*Required*: No\n*Type*: [ReferenceLineCustomLabelConfiguration](./aws-properties-quicksight-template-referencelinecustomlabelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-customlabelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReferenceLineCustomLabelConfiguration" }, "FontColor": { "MarkdownDocumentation": "`FontColor`\n\nThe font color configuration of the label in a reference line.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-fontcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the label in a reference line.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "VerticalPosition": { "MarkdownDocumentation": "`VerticalPosition`\n\nThe vertical position configuration of the label in a reference line. Choose one of the following options:\n* `ABOVE`\n* `BELOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `ABOVE | BELOW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ABOVE", "BELOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-verticalposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ReferenceLineStaticDataConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ReferenceLineStaticDataConfiguration`\n\nThe static data configuration of the reference line data configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestaticdataconfiguration.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe double input of the static data.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestaticdataconfiguration.html#cfn-quicksight-template-referencelinestaticdataconfiguration-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.ReferenceLineStyleConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ReferenceLineStyleConfiguration`\n\nThe style configuration of the reference\nline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestyleconfiguration.html", "Properties": { "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nThe pattern type of the line style. Choose one of the following options:\n* `SOLID`\n* `DASHED`\n* `DOTTED`\n*Required*: No\n*Type*: String\n*Allowed values*: `SOLID | DASHED | DOTTED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOLID", "DASHED", "DOTTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestyleconfiguration.html#cfn-quicksight-template-referencelinestyleconfiguration-pattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe hex color of the reference line.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestyleconfiguration.html#cfn-quicksight-template-referencelinestyleconfiguration-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ReferenceLineValueLabelConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ReferenceLineValueLabelConfiguration`\n\nThe value label configuration of the label in a reference line.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinevaluelabelconfiguration.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the value label.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-template-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinevaluelabelconfiguration.html#cfn-quicksight-template-referencelinevaluelabelconfiguration-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "RelativePosition": { "MarkdownDocumentation": "`RelativePosition`\n\nThe relative position of the value label. Choose one of the following options:\n* `BEFORE_CUSTOM_LABEL`\n* `AFTER_CUSTOM_LABEL`\n*Required*: No\n*Type*: String\n*Allowed values*: `BEFORE_CUSTOM_LABEL | AFTER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BEFORE_CUSTOM_LABEL", "AFTER_CUSTOM_LABEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinevaluelabelconfiguration.html#cfn-quicksight-template-referencelinevaluelabelconfiguration-relativeposition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.RelativeDateTimeControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RelativeDateTimeControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html#cfn-quicksight-template-relativedatetimecontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html#cfn-quicksight-template-relativedatetimecontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" }, "DateTimeFormat": { "MarkdownDocumentation": "`DateTimeFormat`\n\nCustomize how dates are formatted in controls.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html#cfn-quicksight-template-relativedatetimecontroldisplayoptions-datetimeformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.RelativeDatesFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RelativeDatesFilter`\n\nA `RelativeDatesFilter` filters relative dates values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html", "Properties": { "RelativeDateValue": { "MarkdownDocumentation": "`RelativeDateValue`\n\nThe date value of the filter.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-relativedatevalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RelativeDateType": { "MarkdownDocumentation": "`RelativeDateType`\n\nThe range date type of the filter. Choose one of the options below:\n* `PREVIOUS`\n* `THIS`\n* `LAST`\n* `NOW`\n* `NEXT`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PREVIOUS | THIS | LAST | NO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PREVIOUS", "THIS", "LAST", "NOW", "NEXT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-relativedatetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-timegranularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AnchorDateConfiguration": { "MarkdownDocumentation": "`AnchorDateConfiguration`\n\nThe date configuration of the filter.\n*Required*: Yes\n*Type*: [AnchorDateConfiguration](./aws-properties-quicksight-template-anchordateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-anchordateconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "AnchorDateConfiguration" }, "MinimumGranularity": { "MarkdownDocumentation": "`MinimumGranularity`\n\nThe minimum granularity (period granularity) of the relative dates filter.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-minimumgranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExcludePeriodConfiguration": { "MarkdownDocumentation": "`ExcludePeriodConfiguration`\n\nThe configuration for the exclude period of the filter.\n*Required*: No\n*Type*: [ExcludePeriodConfiguration](./aws-properties-quicksight-template-excludeperiodconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-excludeperiodconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExcludePeriodConfiguration" } } }, "AWS::QuickSight::Template.ResourcePermission": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ResourcePermission`\n\nPermission for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe IAM action to grant or revoke permissions on.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html#cfn-quicksight-template-resourcepermission-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe Amazon Resource Name (ARN) of the principal. This can be one of the following:\n* The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is\n common.)\n* The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard,\n template, or theme. (This is common.)\n* The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts. (This is\n less common.)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html#cfn-quicksight-template-resourcepermission-principal", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.RollingDateConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RollingDateConfiguration`\n\nThe rolling date configuration of a date time filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rollingdateconfiguration.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the rolling date configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rollingdateconfiguration.html#cfn-quicksight-template-rollingdateconfiguration-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSetIdentifier": { "MarkdownDocumentation": "`DataSetIdentifier`\n\nThe data set that is used in the rolling date configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rollingdateconfiguration.html#cfn-quicksight-template-rollingdateconfiguration-datasetidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.RowAlternateColorOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.RowAlternateColorOptions`\n\nDetermines the row alternate color options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rowalternatecoloroptions.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nDetermines the widget status.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rowalternatecoloroptions.html#cfn-quicksight-template-rowalternatecoloroptions-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UsePrimaryBackgroundColor": { "MarkdownDocumentation": "`UsePrimaryBackgroundColor`\n\nThe primary background color options for alternate rows.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rowalternatecoloroptions.html#cfn-quicksight-template-rowalternatecoloroptions-useprimarybackgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowAlternateColors": { "MarkdownDocumentation": "`RowAlternateColors`\n\nDetermines the list of row alternate colors.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rowalternatecoloroptions.html#cfn-quicksight-template-rowalternatecoloroptions-rowalternatecolors", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.SameSheetTargetVisualConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SameSheetTargetVisualConfiguration`\n\nThe configuration of the same-sheet target visuals that you want to be filtered.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-samesheettargetvisualconfiguration.html", "Properties": { "TargetVisualOptions": { "MarkdownDocumentation": "`TargetVisualOptions`\n\nThe options that choose the target visual in the same sheet.\nValid values are defined as follows:\n* `ALL_VISUALS`: Applies the filter operation to all visuals in the same sheet.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL_VISUALS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VISUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-samesheettargetvisualconfiguration.html#cfn-quicksight-template-samesheettargetvisualconfiguration-targetvisualoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetVisuals": { "MarkdownDocumentation": "`TargetVisuals`\n\nA list of the target visual IDs that are located in the same sheet of the analysis.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `512 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-samesheettargetvisualconfiguration.html#cfn-quicksight-template-samesheettargetvisualconfiguration-targetvisuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.SankeyDiagramAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SankeyDiagramAggregatedFieldWells`\n\nThe field well configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-template-sankeydiagramaggregatedfieldwells-destination", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-template-sankeydiagramaggregatedfieldwells-source", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe weight field wells of a sankey diagram.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-template-sankeydiagramaggregatedfieldwells-weight", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.SankeyDiagramChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SankeyDiagramChartConfiguration`\n\nThe configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramSortConfiguration](./aws-properties-quicksight-template-sankeydiagramsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html#cfn-quicksight-template-sankeydiagramchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramSortConfiguration" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a sankey diagram.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html#cfn-quicksight-template-sankeydiagramchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramFieldWells](./aws-properties-quicksight-template-sankeydiagramfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html#cfn-quicksight-template-sankeydiagramchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramFieldWells" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html#cfn-quicksight-template-sankeydiagramchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Template.SankeyDiagramFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SankeyDiagramFieldWells`\n\nThe field well configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramfieldwells.html", "Properties": { "SankeyDiagramAggregatedFieldWells": { "MarkdownDocumentation": "`SankeyDiagramAggregatedFieldWells`\n\nThe field well configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramAggregatedFieldWells](./aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramfieldwells.html#cfn-quicksight-template-sankeydiagramfieldwells-sankeydiagramaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramAggregatedFieldWells" } } }, "AWS::QuickSight::Template.SankeyDiagramSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SankeyDiagramSortConfiguration`\n\nThe sort configuration of a sankey diagram.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramsortconfiguration.html", "Properties": { "WeightSort": { "MarkdownDocumentation": "`WeightSort`\n\nThe sort configuration of the weight fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramsortconfiguration.html#cfn-quicksight-template-sankeydiagramsortconfiguration-weightsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "SourceItemsLimit": { "MarkdownDocumentation": "`SourceItemsLimit`\n\nThe limit on the number of source nodes that are displayed in a sankey diagram.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramsortconfiguration.html#cfn-quicksight-template-sankeydiagramsortconfiguration-sourceitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "DestinationItemsLimit": { "MarkdownDocumentation": "`DestinationItemsLimit`\n\nThe limit on the number of destination nodes that are displayed in a sankey diagram.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramsortconfiguration.html#cfn-quicksight-template-sankeydiagramsortconfiguration-destinationitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Template.SankeyDiagramVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SankeyDiagramVisual`\n\nA sankey diagram.\nFor more information, see [Using Sankey diagrams](https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration of a sankey diagram.\n*Required*: No\n*Type*: [SankeyDiagramChartConfiguration](./aws-properties-quicksight-template-sankeydiagramchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ScatterPlotCategoricallyAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ScatterPlotCategoricallyAggregatedFieldWells`\n\nThe aggregated field well of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a scatter plot.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-label", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe x-axis field well of a scatter plot.\nThe x-axis is aggregated by category.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe y-axis field well of a scatter plot.\nThe y-axis is aggregated by category.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ScatterPlotConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ScatterPlotConfiguration`\n\nThe configuration of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html", "Properties": { "YAxisLabelOptions": { "MarkdownDocumentation": "`YAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-yaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a scatter plot.\n*Required*: No\n*Type*: [ScatterPlotSortConfiguration](./aws-properties-quicksight-template-scatterplotsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "YAxisDisplayOptions": { "MarkdownDocumentation": "`YAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-yaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [ScatterPlotFieldWells](./aws-properties-quicksight-template-scatterplotfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "XAxisLabelOptions": { "MarkdownDocumentation": "`XAxisLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-xaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe palette (chart color) display setup of the visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" }, "XAxisDisplayOptions": { "MarkdownDocumentation": "`XAxisDisplayOptions`\n\nThe label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-xaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" } } }, "AWS::QuickSight::Template.ScatterPlotFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ScatterPlotFieldWells`\n\nThe field well configuration of a scatter plot.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotfieldwells.html", "Properties": { "ScatterPlotUnaggregatedFieldWells": { "MarkdownDocumentation": "`ScatterPlotUnaggregatedFieldWells`\n\nThe unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are\nunaggregated.\n*Required*: No\n*Type*: [ScatterPlotUnaggregatedFieldWells](./aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotfieldwells.html#cfn-quicksight-template-scatterplotfieldwells-scatterplotunaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotUnaggregatedFieldWells" }, "ScatterPlotCategoricallyAggregatedFieldWells": { "MarkdownDocumentation": "`ScatterPlotCategoricallyAggregatedFieldWells`\n\nThe aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.\n*Required*: No\n*Type*: [ScatterPlotCategoricallyAggregatedFieldWells](./aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotfieldwells.html#cfn-quicksight-template-scatterplotfieldwells-scatterplotcategoricallyaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotCategoricallyAggregatedFieldWells" } } }, "AWS::QuickSight::Template.ScatterPlotSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ScatterPlotSortConfiguration`\n\nThe sort configuration of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotsortconfiguration.html", "Properties": { "ScatterPlotLimitConfiguration": { "MarkdownDocumentation": "`ScatterPlotLimitConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotsortconfiguration.html#cfn-quicksight-template-scatterplotsortconfiguration-scatterplotlimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Template.ScatterPlotUnaggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ScatterPlotUnaggregatedFieldWells`\n\nThe unaggregated field wells of a scatter plot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-category", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a scatter plot.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe label field well of a scatter plot.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-label", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe x-axis field well of a scatter plot.\nThe x-axis is a dimension field and cannot be aggregated.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe y-axis field well of a scatter plot.\nThe y-axis is a dimension field and cannot be aggregated.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ScatterPlotVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ScatterPlotVisual`\n\nA scatter plot.\nFor more information, see [Using scatter plots](https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [ScatterPlotConfiguration](./aws-properties-quicksight-template-scatterplotconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ScrollBarOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ScrollBarOptions`\n\nThe visual display options for a data zoom scroll bar.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scrollbaroptions.html", "Properties": { "VisibleRange": { "MarkdownDocumentation": "`VisibleRange`\n\nThe visibility range for the data zoom scroll bar.\n*Required*: No\n*Type*: [VisibleRangeOptions](./aws-properties-quicksight-template-visiblerangeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scrollbaroptions.html#cfn-quicksight-template-scrollbaroptions-visiblerange", "UpdateType": "Mutable", "Required": false, "Type": "VisibleRangeOptions" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the data zoom scroll bar.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scrollbaroptions.html#cfn-quicksight-template-scrollbaroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.SecondaryValueOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SecondaryValueOptions`\n\nThe options that determine the presentation of the secondary value of a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-secondaryvalueoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the secondary value.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-secondaryvalueoptions.html#cfn-quicksight-template-secondaryvalueoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.SectionAfterPageBreak": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SectionAfterPageBreak`\n\nThe configuration of a page break after a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionafterpagebreak.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe option that enables or disables a page break at the end of a section.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionafterpagebreak.html#cfn-quicksight-template-sectionafterpagebreak-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SectionBasedLayoutCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SectionBasedLayoutCanvasSizeOptions`\n\nThe options for the canvas of a section-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutcanvassizeoptions.html", "Properties": { "PaperCanvasSizeOptions": { "MarkdownDocumentation": "`PaperCanvasSizeOptions`\n\nThe options for a paper canvas of a section-based layout.\n*Required*: No\n*Type*: [SectionBasedLayoutPaperCanvasSizeOptions](./aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutcanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutcanvassizeoptions-papercanvassizeoptions", "UpdateType": "Mutable", "Required": false, "Type": "SectionBasedLayoutPaperCanvasSizeOptions" } } }, "AWS::QuickSight::Template.SectionBasedLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SectionBasedLayoutConfiguration`\n\nThe configuration for a\nsection-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html", "Properties": { "CanvasSizeOptions": { "MarkdownDocumentation": "`CanvasSizeOptions`\n\nThe options for the canvas of a section-based layout.\n*Required*: Yes\n*Type*: [SectionBasedLayoutCanvasSizeOptions](./aws-properties-quicksight-template-sectionbasedlayoutcanvassizeoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-canvassizeoptions", "UpdateType": "Mutable", "Required": true, "Type": "SectionBasedLayoutCanvasSizeOptions" }, "FooterSections": { "MarkdownDocumentation": "`FooterSections`\n\nA list of footer section configurations.\n*Required*: Yes\n*Type*: Array of [HeaderFooterSectionConfiguration](./aws-properties-quicksight-template-headerfootersectionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-footersections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HeaderFooterSectionConfiguration", "DuplicatesAllowed": true }, "BodySections": { "MarkdownDocumentation": "`BodySections`\n\nA list of body section configurations.\n*Required*: Yes\n*Type*: Array of [BodySectionConfiguration](./aws-properties-quicksight-template-bodysectionconfiguration.html)\n*Minimum*: `0`\n*Maximum*: `28`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-bodysections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "BodySectionConfiguration", "DuplicatesAllowed": true }, "HeaderSections": { "MarkdownDocumentation": "`HeaderSections`\n\nA list of header section configurations.\n*Required*: Yes\n*Type*: Array of [HeaderFooterSectionConfiguration](./aws-properties-quicksight-template-headerfootersectionconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-headersections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HeaderFooterSectionConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.SectionBasedLayoutPaperCanvasSizeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SectionBasedLayoutPaperCanvasSizeOptions`\n\nThe options for a paper canvas of a section-based layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html", "Properties": { "PaperMargin": { "MarkdownDocumentation": "`PaperMargin`\n\nDefines the spacing between the canvas content and the top, bottom, left, and right edges.\n*Required*: No\n*Type*: [Spacing](./aws-properties-quicksight-template-spacing.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-papermargin", "UpdateType": "Mutable", "Required": false, "Type": "Spacing" }, "PaperSize": { "MarkdownDocumentation": "`PaperSize`\n\nThe paper size that is used to define canvas dimensions.\n*Required*: No\n*Type*: String\n*Allowed values*: `US_LETTER | US_LEGAL | US_T...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "US_LETTER", "US_LEGAL", "US_TABLOID_LEDGER", "A0", "A1", "A2", "A3", "A4", "A5", "JIS_B4", "JIS_B5" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-papersize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PaperOrientation": { "MarkdownDocumentation": "`PaperOrientation`\n\nThe paper orientation that\nis used to define canvas dimensions. Choose one of the following\noptions:\n* PORTRAIT\n* LANDSCAPE\n*Required*: No\n*Type*: String\n*Allowed values*: `PORTRAIT | LANDSCAPE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PORTRAIT", "LANDSCAPE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-paperorientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SectionLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SectionLayoutConfiguration`\n\nThe layout configuration of a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionlayoutconfiguration.html", "Properties": { "FreeFormLayout": { "MarkdownDocumentation": "`FreeFormLayout`\n\nThe free-form layout configuration of a section.\n*Required*: Yes\n*Type*: [FreeFormSectionLayoutConfiguration](./aws-properties-quicksight-template-freeformsectionlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionlayoutconfiguration.html#cfn-quicksight-template-sectionlayoutconfiguration-freeformlayout", "UpdateType": "Mutable", "Required": true, "Type": "FreeFormSectionLayoutConfiguration" } } }, "AWS::QuickSight::Template.SectionPageBreakConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SectionPageBreakConfiguration`\n\nThe configuration of a page break for a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionpagebreakconfiguration.html", "Properties": { "After": { "MarkdownDocumentation": "`After`\n\nThe configuration of a page break after a section.\n*Required*: No\n*Type*: [SectionAfterPageBreak](./aws-properties-quicksight-template-sectionafterpagebreak.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionpagebreakconfiguration.html#cfn-quicksight-template-sectionpagebreakconfiguration-after", "UpdateType": "Mutable", "Required": false, "Type": "SectionAfterPageBreak" } } }, "AWS::QuickSight::Template.SectionStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SectionStyle`\n\nThe options that style a section.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionstyle.html", "Properties": { "Padding": { "MarkdownDocumentation": "`Padding`\n\nThe spacing between section content and its top, bottom, left, and right edges.\nThere is no padding by default.\n*Required*: No\n*Type*: [Spacing](./aws-properties-quicksight-template-spacing.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionstyle.html#cfn-quicksight-template-sectionstyle-padding", "UpdateType": "Mutable", "Required": false, "Type": "Spacing" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height of a section.\nHeights can only be defined for header and footer sections. The default height margin is 0.5 inches.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionstyle.html#cfn-quicksight-template-sectionstyle-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SelectedSheetsFilterScopeConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SelectedSheetsFilterScopeConfiguration`\n\nThe configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-selectedsheetsfilterscopeconfiguration.html", "Properties": { "SheetVisualScopingConfigurations": { "MarkdownDocumentation": "`SheetVisualScopingConfigurations`\n\nThe sheet ID and visual IDs of the sheet and visuals that the filter is applied to.\n*Required*: No\n*Type*: Array of [SheetVisualScopingConfiguration](./aws-properties-quicksight-template-sheetvisualscopingconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-selectedsheetsfilterscopeconfiguration.html#cfn-quicksight-template-selectedsheetsfilterscopeconfiguration-sheetvisualscopingconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetVisualScopingConfiguration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.SeriesItem": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SeriesItem`\n\nThe series item configuration of a line chart.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-seriesitem.html", "Properties": { "FieldSeriesItem": { "MarkdownDocumentation": "`FieldSeriesItem`\n\nThe field series item configuration of a line chart.\n*Required*: No\n*Type*: [FieldSeriesItem](./aws-properties-quicksight-template-fieldseriesitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-seriesitem.html#cfn-quicksight-template-seriesitem-fieldseriesitem", "UpdateType": "Mutable", "Required": false, "Type": "FieldSeriesItem" }, "DataFieldSeriesItem": { "MarkdownDocumentation": "`DataFieldSeriesItem`\n\nThe data field series item configuration of a line chart.\n*Required*: No\n*Type*: [DataFieldSeriesItem](./aws-properties-quicksight-template-datafieldseriesitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-seriesitem.html#cfn-quicksight-template-seriesitem-datafieldseriesitem", "UpdateType": "Mutable", "Required": false, "Type": "DataFieldSeriesItem" } } }, "AWS::QuickSight::Template.SetParameterValueConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SetParameterValueConfiguration`\n\nThe configuration of adding parameters in action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-setparametervalueconfiguration.html", "Properties": { "DestinationParameterName": { "MarkdownDocumentation": "`DestinationParameterName`\n\nThe destination parameter name of the `SetParameterValueConfiguration`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-setparametervalueconfiguration.html#cfn-quicksight-template-setparametervalueconfiguration-destinationparametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [DestinationParameterValueConfiguration](./aws-properties-quicksight-template-destinationparametervalueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-setparametervalueconfiguration.html#cfn-quicksight-template-setparametervalueconfiguration-value", "UpdateType": "Mutable", "Required": true, "Type": "DestinationParameterValueConfiguration" } } }, "AWS::QuickSight::Template.ShapeConditionalFormat": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ShapeConditionalFormat`\n\nThe shape conditional formatting of a filled map visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shapeconditionalformat.html", "Properties": { "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting for the shape background color of a filled map visual.\n*Required*: Yes\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shapeconditionalformat.html#cfn-quicksight-template-shapeconditionalformat-backgroundcolor", "UpdateType": "Mutable", "Required": true, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Template.Sheet": { "MarkdownDocumentation": "`AWS::QuickSight::Template.Sheet`\n\nA *sheet*, which is an object that contains a set of visuals that\nare viewed together on one page in Quick Sight. Every analysis and dashboard\ncontains at least one sheet. Each sheet contains at least one visualization widget, for\nexample a chart, pivot table, or narrative insight. Sheets can be associated with other\ncomponents, such as controls, filters, and so on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html", "Properties": { "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe unique identifier associated with a sheet.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html#cfn-quicksight-template-sheet-sheetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a sheet. This name is displayed on the sheet's tab in the Quick Sight\nconsole.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html#cfn-quicksight-template-sheet-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SheetControlInfoIconLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetControlInfoIconLabelOptions`\n\nA control to display info icons for filters and parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of info icon label options.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-template-sheetcontrolinfoiconlabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "InfoIconText": { "MarkdownDocumentation": "`InfoIconText`\n\nThe text content of info icon.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-template-sheetcontrolinfoiconlabeloptions-infoicontext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SheetControlLayout": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetControlLayout`\n\nA grid layout to define the placement of sheet control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrollayout.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n*Required*: Yes\n*Type*: [SheetControlLayoutConfiguration](./aws-properties-quicksight-template-sheetcontrollayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrollayout.html#cfn-quicksight-template-sheetcontrollayout-configuration", "UpdateType": "Mutable", "Required": true, "Type": "SheetControlLayoutConfiguration" } } }, "AWS::QuickSight::Template.SheetControlLayoutConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetControlLayoutConfiguration`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrollayoutconfiguration.html", "Properties": { "GridLayout": { "MarkdownDocumentation": "`GridLayout`\n\nThe configuration that determines the elements and canvas size options of sheet control.\n*Required*: No\n*Type*: [GridLayoutConfiguration](./aws-properties-quicksight-template-gridlayoutconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrollayoutconfiguration.html#cfn-quicksight-template-sheetcontrollayoutconfiguration-gridlayout", "UpdateType": "Mutable", "Required": false, "Type": "GridLayoutConfiguration" } } }, "AWS::QuickSight::Template.SheetDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetDefinition`\n\nA sheet is an object that contains a set of visuals that\nare viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterControls": { "MarkdownDocumentation": "`ParameterControls`\n\nThe list of parameter controls that are on a sheet.\nFor more information, see [Using a Control with a Parameter in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [ParameterControl](./aws-properties-quicksight-template-parametercontrol.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-parametercontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ParameterControl", "DuplicatesAllowed": true }, "TextBoxes": { "MarkdownDocumentation": "`TextBoxes`\n\nThe text boxes that are on a sheet.\n*Required*: No\n*Type*: Array of [SheetTextBox](./aws-properties-quicksight-template-sheettextbox.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-textboxes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetTextBox", "DuplicatesAllowed": true }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe layout content type of the sheet. Choose one of the following options:\n* `PAGINATED`: Creates a sheet for a paginated report.\n* `INTERACTIVE`: Creates a sheet for an interactive dashboard.\n*Required*: No\n*Type*: String\n*Allowed values*: `PAGINATED | INTERACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PAGINATED", "INTERACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Layouts": { "MarkdownDocumentation": "`Layouts`\n\nLayouts define how the components of a sheet are arranged.\nFor more information, see [Types of layout](https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [Layout](./aws-properties-quicksight-template-layout.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-layouts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Layout", "DuplicatesAllowed": true }, "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe unique identifier of a sheet.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-sheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FilterControls": { "MarkdownDocumentation": "`FilterControls`\n\nThe list of filter controls that are on a sheet.\nFor more information, see [Adding filter controls to analysis sheets](https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [FilterControl](./aws-properties-quicksight-template-filtercontrol.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-filtercontrols", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterControl", "DuplicatesAllowed": true }, "Images": { "MarkdownDocumentation": "`Images`\n\nA list of images on a sheet.\n*Required*: No\n*Type*: Array of [SheetImage](./aws-properties-quicksight-template-sheetimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-images", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetImage", "DuplicatesAllowed": true }, "SheetControlLayouts": { "MarkdownDocumentation": "`SheetControlLayouts`\n\nThe control layouts of the sheet.\n*Required*: No\n*Type*: Array of [SheetControlLayout](./aws-properties-quicksight-template-sheetcontrollayout.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-sheetcontrollayouts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetControlLayout", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-title", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visuals": { "MarkdownDocumentation": "`Visuals`\n\nA list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.\n*Required*: No\n*Type*: Array of [Visual](./aws-properties-quicksight-template-visual.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-visuals", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Visual", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the sheet. This name is displayed on the sheet's tab in the Quick Suite\nconsole.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SheetElementConfigurationOverrides": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetElementConfigurationOverrides`\n\nThe override configuration of the rendering rules of a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementconfigurationoverrides.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines whether or not the overrides are visible. Choose one of the following options:\n* `VISIBLE`\n* `HIDDEN`\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementconfigurationoverrides.html#cfn-quicksight-template-sheetelementconfigurationoverrides-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.SheetElementRenderingRule": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetElementRenderingRule`\n\nThe rendering rules of a sheet that uses a free-form layout.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementrenderingrule.html", "Properties": { "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe expression of the rendering rules of a sheet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementrenderingrule.html#cfn-quicksight-template-sheetelementrenderingrule-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConfigurationOverrides": { "MarkdownDocumentation": "`ConfigurationOverrides`\n\nThe override configuration of the rendering rules of a sheet.\n*Required*: Yes\n*Type*: [SheetElementConfigurationOverrides](./aws-properties-quicksight-template-sheetelementconfigurationoverrides.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementrenderingrule.html#cfn-quicksight-template-sheetelementrenderingrule-configurationoverrides", "UpdateType": "Mutable", "Required": true, "Type": "SheetElementConfigurationOverrides" } } }, "AWS::QuickSight::Template.SheetImage": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetImage`\n\nAn image that is located on a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nA list of custom actions that are configured for an image.\n*Required*: No\n*Type*: Array of [ImageCustomAction](./aws-properties-quicksight-template-imagecustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ImageCustomAction", "DuplicatesAllowed": true }, "SheetImageId": { "MarkdownDocumentation": "`SheetImageId`\n\nThe ID of the sheet image.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-sheetimageid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip to be shown when hovering over the image.\n*Required*: No\n*Type*: [SheetImageTooltipConfiguration](./aws-properties-quicksight-template-sheetimagetooltipconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageTooltipConfiguration" }, "Scaling": { "MarkdownDocumentation": "`Scaling`\n\nDetermines how the image is scaled.\n*Required*: No\n*Type*: [SheetImageScalingConfiguration](./aws-properties-quicksight-template-sheetimagescalingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-scaling", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageScalingConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general image interactions setup for an image.\n*Required*: No\n*Type*: [ImageInteractionOptions](./aws-properties-quicksight-template-imageinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-interactions", "UpdateType": "Mutable", "Required": false, "Type": "ImageInteractionOptions" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the image.\n*Required*: Yes\n*Type*: [SheetImageSource](./aws-properties-quicksight-template-sheetimagesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-source", "UpdateType": "Mutable", "Required": true, "Type": "SheetImageSource" }, "ImageContentAltText": { "MarkdownDocumentation": "`ImageContentAltText`\n\nThe alt text for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-imagecontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SheetImageScalingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetImageScalingConfiguration`\n\nDetermines how the image is scaled\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagescalingconfiguration.html", "Properties": { "ScalingType": { "MarkdownDocumentation": "`ScalingType`\n\nThe scaling option to use when fitting the image inside the container.\nValid values are defined as follows:\n* `SCALE_TO_WIDTH`: The image takes up the entire width of the container. The image aspect ratio is preserved.\n* `SCALE_TO_HEIGHT`: The image takes up the entire height of the container. The image aspect ratio is preserved.\n* `SCALE_TO_CONTAINER`: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.\n* `SCALE_NONE`: The image is displayed in its original size and is not scaled to the container.\n*Required*: No\n*Type*: String\n*Allowed values*: `SCALE_TO_WIDTH | SCALE_TO_H...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SCALE_TO_WIDTH", "SCALE_TO_HEIGHT", "SCALE_TO_CONTAINER", "SCALE_NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagescalingconfiguration.html#cfn-quicksight-template-sheetimagescalingconfiguration-scalingtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SheetImageSource": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetImageSource`\n\nThe source of the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagesource.html", "Properties": { "SheetImageStaticFileSource": { "MarkdownDocumentation": "`SheetImageStaticFileSource`\n\nThe source of the static file that contains the image.\n*Required*: No\n*Type*: [SheetImageStaticFileSource](./aws-properties-quicksight-template-sheetimagestaticfilesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagesource.html#cfn-quicksight-template-sheetimagesource-sheetimagestaticfilesource", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageStaticFileSource" } } }, "AWS::QuickSight::Template.SheetImageStaticFileSource": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetImageStaticFileSource`\n\nThe source of the static file that contains the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagestaticfilesource.html", "Properties": { "StaticFileId": { "MarkdownDocumentation": "`StaticFileId`\n\nThe ID of the static file that contains the image.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagestaticfilesource.html#cfn-quicksight-template-sheetimagestaticfilesource-staticfileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SheetImageTooltipConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetImageTooltipConfiguration`\n\nThe tooltip configuration for a sheet image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltipconfiguration.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the tooltip.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltipconfiguration.html#cfn-quicksight-template-sheetimagetooltipconfiguration-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TooltipText": { "MarkdownDocumentation": "`TooltipText`\n\nThe text that appears in the tooltip.\n*Required*: No\n*Type*: [SheetImageTooltipText](./aws-properties-quicksight-template-sheetimagetooltiptext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltipconfiguration.html#cfn-quicksight-template-sheetimagetooltipconfiguration-tooltiptext", "UpdateType": "Mutable", "Required": false, "Type": "SheetImageTooltipText" } } }, "AWS::QuickSight::Template.SheetImageTooltipText": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetImageTooltipText`\n\nThe text that appears in the sheet image tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltiptext.html", "Properties": { "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nThe plain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltiptext.html#cfn-quicksight-template-sheetimagetooltiptext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SheetTextBox": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetTextBox`\n\nA text box.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheettextbox.html", "Properties": { "SheetTextBoxId": { "MarkdownDocumentation": "`SheetTextBoxId`\n\nThe unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheettextbox.html#cfn-quicksight-template-sheettextbox-sheettextboxid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe content that is displayed in the text box.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `150000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheettextbox.html#cfn-quicksight-template-sheettextbox-content", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SheetVisualScopingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SheetVisualScopingConfiguration`\n\nThe filter that is applied to the options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetvisualscopingconfiguration.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope of the applied entities. Choose one of the following options:\n* `ALL_VISUALS`\n* `SELECTED_VISUALS`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VISUALS | SELECTED_VISU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VISUALS", "SELECTED_VISUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetvisualscopingconfiguration.html#cfn-quicksight-template-sheetvisualscopingconfiguration-scope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SheetId": { "MarkdownDocumentation": "`SheetId`\n\nThe selected sheet that the filter is applied to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetvisualscopingconfiguration.html#cfn-quicksight-template-sheetvisualscopingconfiguration-sheetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VisualIds": { "MarkdownDocumentation": "`VisualIds`\n\nThe selected visuals that the filter is applied to.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetvisualscopingconfiguration.html#cfn-quicksight-template-sheetvisualscopingconfiguration-visualids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.ShortFormatText": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ShortFormatText`\n\nThe text format for the title.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shortformattext.html", "Properties": { "RichText": { "MarkdownDocumentation": "`RichText`\n\nRich text. Examples of rich text include bold, underline, and italics.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shortformattext.html#cfn-quicksight-template-shortformattext-richtext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlainText": { "MarkdownDocumentation": "`PlainText`\n\nPlain text format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shortformattext.html#cfn-quicksight-template-shortformattext-plaintext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SimpleClusterMarker": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SimpleClusterMarker`\n\nThe simple cluster marker of the cluster marker.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-simpleclustermarker.html", "Properties": { "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of the simple cluster marker.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-simpleclustermarker.html#cfn-quicksight-template-simpleclustermarker-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SingleAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SingleAxisOptions`\n\nThe settings of a chart's single axis configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-singleaxisoptions.html", "Properties": { "YAxisOptions": { "MarkdownDocumentation": "`YAxisOptions`\n\nThe Y axis options of a single axis configuration.\n*Required*: No\n*Type*: [YAxisOptions](./aws-properties-quicksight-template-yaxisoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-singleaxisoptions.html#cfn-quicksight-template-singleaxisoptions-yaxisoptions", "UpdateType": "Mutable", "Required": false, "Type": "YAxisOptions" } } }, "AWS::QuickSight::Template.SliderControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SliderControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-slidercontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-slidercontroldisplayoptions.html#cfn-quicksight-template-slidercontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-slidercontroldisplayoptions.html#cfn-quicksight-template-slidercontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Template.SmallMultiplesAxisProperties": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SmallMultiplesAxisProperties`\n\nConfigures the properties of a chart's axes that are used by small multiples panels.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesaxisproperties.html", "Properties": { "Placement": { "MarkdownDocumentation": "`Placement`\n\nDefines the placement of the axis. By default, axes are rendered `OUTSIDE` of the panels. Axes with `INDEPENDENT` scale are rendered `INSIDE` the panels.\n*Required*: No\n*Type*: String\n*Allowed values*: `OUTSIDE | INSIDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OUTSIDE", "INSIDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesaxisproperties.html#cfn-quicksight-template-smallmultiplesaxisproperties-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scale": { "MarkdownDocumentation": "`Scale`\n\nDetermines whether scale of the axes are shared or independent. The default value is `SHARED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHARED | INDEPENDENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SHARED", "INDEPENDENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesaxisproperties.html#cfn-quicksight-template-smallmultiplesaxisproperties-scale", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SmallMultiplesOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SmallMultiplesOptions`\n\nOptions that determine the layout and display options of a chart's small multiples.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html", "Properties": { "MaxVisibleRows": { "MarkdownDocumentation": "`MaxVisibleRows`\n\nSets the maximum number of visible rows to display in the grid of small multiples panels.\nThe default value is `Auto`,\nwhich automatically adjusts the rows in the grid\nto fit the overall layout and size of the given chart.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-maxvisiblerows", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PanelConfiguration": { "MarkdownDocumentation": "`PanelConfiguration`\n\nConfigures the display options for each small multiples panel.\n*Required*: No\n*Type*: [PanelConfiguration](./aws-properties-quicksight-template-panelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-panelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PanelConfiguration" }, "MaxVisibleColumns": { "MarkdownDocumentation": "`MaxVisibleColumns`\n\nSets the maximum number of visible columns to display in the grid of small multiples panels.\nThe default is `Auto`, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-maxvisiblecolumns", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "XAxis": { "MarkdownDocumentation": "`XAxis`\n\nThe properties of a small multiples X axis.\n*Required*: No\n*Type*: [SmallMultiplesAxisProperties](./aws-properties-quicksight-template-smallmultiplesaxisproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-xaxis", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesAxisProperties" }, "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe properties of a small multiples Y axis.\n*Required*: No\n*Type*: [SmallMultiplesAxisProperties](./aws-properties-quicksight-template-smallmultiplesaxisproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-yaxis", "UpdateType": "Mutable", "Required": false, "Type": "SmallMultiplesAxisProperties" } } }, "AWS::QuickSight::Template.Spacing": { "MarkdownDocumentation": "`AWS::QuickSight::Template.Spacing`\n\nThe configuration of spacing (often a margin or padding).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html", "Properties": { "Left": { "MarkdownDocumentation": "`Left`\n\nDefine the left spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html#cfn-quicksight-template-spacing-left", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Top": { "MarkdownDocumentation": "`Top`\n\nDefine the top spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html#cfn-quicksight-template-spacing-top", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Right": { "MarkdownDocumentation": "`Right`\n\nDefine the right spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html#cfn-quicksight-template-spacing-right", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bottom": { "MarkdownDocumentation": "`Bottom`\n\nDefine the bottom spacing.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html#cfn-quicksight-template-spacing-bottom", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.StringDefaultValues": { "MarkdownDocumentation": "`AWS::QuickSight::Template.StringDefaultValues`\n\nThe default values of the `StringParameterDeclaration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringdefaultvalues.html", "Properties": { "DynamicValue": { "MarkdownDocumentation": "`DynamicValue`\n\nThe dynamic value of the `StringDefaultValues`. Different defaults displayed according to users, groups, and values mapping.\n*Required*: No\n*Type*: [DynamicDefaultValue](./aws-properties-quicksight-template-dynamicdefaultvalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringdefaultvalues.html#cfn-quicksight-template-stringdefaultvalues-dynamicvalue", "UpdateType": "Mutable", "Required": false, "Type": "DynamicDefaultValue" }, "StaticValues": { "MarkdownDocumentation": "`StaticValues`\n\nThe static values of the `DecimalDefaultValues`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringdefaultvalues.html#cfn-quicksight-template-stringdefaultvalues-staticvalues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.StringFormatConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.StringFormatConfiguration`\n\nFormatting configuration for string fields.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringformatconfiguration.html", "Properties": { "NumericFormatConfiguration": { "MarkdownDocumentation": "`NumericFormatConfiguration`\n\nThe formatting configuration for numeric strings.\n*Required*: No\n*Type*: [NumericFormatConfiguration](./aws-properties-quicksight-template-numericformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringformatconfiguration.html#cfn-quicksight-template-stringformatconfiguration-numericformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NumericFormatConfiguration" }, "NullValueFormatConfiguration": { "MarkdownDocumentation": "`NullValueFormatConfiguration`\n\nThe options that determine the null value format configuration.\n*Required*: No\n*Type*: [NullValueFormatConfiguration](./aws-properties-quicksight-template-nullvalueformatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringformatconfiguration.html#cfn-quicksight-template-stringformatconfiguration-nullvalueformatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NullValueFormatConfiguration" } } }, "AWS::QuickSight::Template.StringParameterDeclaration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.StringParameterDeclaration`\n\nA parameter declaration for the `String` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html", "Properties": { "MappedDataSetParameters": { "MarkdownDocumentation": "`MappedDataSetParameters`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MappedDataSetParameter](./aws-properties-quicksight-template-mappeddatasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-mappeddatasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MappedDataSetParameter", "DuplicatesAllowed": true }, "DefaultValues": { "MarkdownDocumentation": "`DefaultValues`\n\nThe default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.\n*Required*: No\n*Type*: [StringDefaultValues](./aws-properties-quicksight-template-stringdefaultvalues.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-defaultvalues", "UpdateType": "Mutable", "Required": false, "Type": "StringDefaultValues" }, "ParameterValueType": { "MarkdownDocumentation": "`ParameterValueType`\n\nThe value type determines whether the parameter is a single-value or multi-value parameter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MULTI_VALUED | SINGLE_VALUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MULTI_VALUED", "SINGLE_VALUED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-parametervaluetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValueWhenUnset": { "MarkdownDocumentation": "`ValueWhenUnset`\n\nThe configuration that defines the default value of a `String` parameter when a value has not been set.\n*Required*: No\n*Type*: [StringValueWhenUnsetConfiguration](./aws-properties-quicksight-template-stringvaluewhenunsetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-valuewhenunset", "UpdateType": "Mutable", "Required": false, "Type": "StringValueWhenUnsetConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter that is being declared.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.StringValueWhenUnsetConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.StringValueWhenUnsetConfiguration`\n\nThe configuration that defines the default value of a `String` parameter when a value has not been set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringvaluewhenunsetconfiguration.html", "Properties": { "ValueWhenUnsetOption": { "MarkdownDocumentation": "`ValueWhenUnsetOption`\n\nThe built-in options for default values. The value can be one of the following:\n* `RECOMMENDED`: The recommended value.\n* `NULL`: The `NULL` value.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECOMMENDED_VALUE | NULL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECOMMENDED_VALUE", "NULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringvaluewhenunsetconfiguration.html#cfn-quicksight-template-stringvaluewhenunsetconfiguration-valuewhenunsetoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomValue": { "MarkdownDocumentation": "`CustomValue`\n\nA custom value that's used when the value of a parameter isn't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringvaluewhenunsetconfiguration.html#cfn-quicksight-template-stringvaluewhenunsetconfiguration-customvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.SubtotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.SubtotalOptions`\n\nThe subtotal options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the subtotal cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldLevelOptions": { "MarkdownDocumentation": "`FieldLevelOptions`\n\nThe optional configuration of subtotal cells.\n*Required*: No\n*Type*: Array of [PivotTableFieldSubtotalOptions](./aws-properties-quicksight-template-pivottablefieldsubtotaloptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-fieldleveloptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PivotTableFieldSubtotalOptions", "DuplicatesAllowed": true }, "ValueCellStyle": { "MarkdownDocumentation": "`ValueCellStyle`\n\nThe cell styling options for the subtotals of value cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-valuecellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nThe cell styling options for the subtotal cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the subtotal cells.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "FieldLevel": { "MarkdownDocumentation": "`FieldLevel`\n\nThe field level (all, custom, last) for the subtotal cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL | CUSTOM | LAST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL", "CUSTOM", "LAST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-fieldlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricHeaderCellStyle": { "MarkdownDocumentation": "`MetricHeaderCellStyle`\n\nThe cell styling options for the subtotals of header cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-metricheadercellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "StyleTargets": { "MarkdownDocumentation": "`StyleTargets`\n\nThe style targets options for subtotals.\n*Required*: No\n*Type*: Array of [TableStyleTarget](./aws-properties-quicksight-template-tablestyletarget.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-styletargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableStyleTarget", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TableAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableAggregatedFieldWells`\n\nThe aggregated field well for the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well for a pivot table. Values are grouped by group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableaggregatedfieldwells.html#cfn-quicksight-template-tableaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableaggregatedfieldwells.html#cfn-quicksight-template-tableaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TableBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableBorderOptions`\n\nThe border options for a table border.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableborderoptions.html", "Properties": { "Thickness": { "MarkdownDocumentation": "`Thickness`\n\nThe thickness of a table border.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableborderoptions.html#cfn-quicksight-template-tableborderoptions-thickness", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Color": { "MarkdownDocumentation": "`Color`\n\nThe color of a table border.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableborderoptions.html#cfn-quicksight-template-tableborderoptions-color", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe style (none, solid) of a table border.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | SOLID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SOLID" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableborderoptions.html#cfn-quicksight-template-tableborderoptions-style", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TableCellConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableCellConditionalFormatting`\n\nThe cell conditional formatting option for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellconditionalformatting.html", "Properties": { "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID of the cell for conditional formatting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellconditionalformatting.html#cfn-quicksight-template-tablecellconditionalformatting-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TextFormat": { "MarkdownDocumentation": "`TextFormat`\n\nThe text format of the cell for conditional formatting.\n*Required*: No\n*Type*: [TextConditionalFormat](./aws-properties-quicksight-template-textconditionalformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellconditionalformatting.html#cfn-quicksight-template-tablecellconditionalformatting-textformat", "UpdateType": "Mutable", "Required": false, "Type": "TextConditionalFormat" } } }, "AWS::QuickSight::Template.TableCellImageSizingConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableCellImageSizingConfiguration`\n\nThe sizing options for the table image configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellimagesizingconfiguration.html", "Properties": { "TableCellImageScalingConfiguration": { "MarkdownDocumentation": "`TableCellImageScalingConfiguration`\n\nThe cell scaling configuration of the sizing options for the table image configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIT_TO_CELL_HEIGHT | FIT_TO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIT_TO_CELL_HEIGHT", "FIT_TO_CELL_WIDTH", "DO_NOT_SCALE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellimagesizingconfiguration.html#cfn-quicksight-template-tablecellimagesizingconfiguration-tablecellimagescalingconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TableCellStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableCellStyle`\n\nThe table cell style for a cell in pivot table or table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html", "Properties": { "VerticalTextAlignment": { "MarkdownDocumentation": "`VerticalTextAlignment`\n\nThe vertical text alignment (top, middle, bottom) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `TOP | MIDDLE | BOTTOM | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "MIDDLE", "BOTTOM", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-verticaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the table cells.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Height": { "MarkdownDocumentation": "`Height`\n\nThe height color for the table cells.\n*Required*: No\n*Type*: Number\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-height", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the table cells.\n*Required*: No\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-fontconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FontConfiguration" }, "Border": { "MarkdownDocumentation": "`Border`\n\nThe borders for the table cells.\n*Required*: No\n*Type*: [GlobalTableBorderOptions](./aws-properties-quicksight-template-globaltableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-border", "UpdateType": "Mutable", "Required": false, "Type": "GlobalTableBorderOptions" }, "TextWrap": { "MarkdownDocumentation": "`TextWrap`\n\nThe text wrap (none, wrap) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | WRAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "WRAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-textwrap", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HorizontalTextAlignment": { "MarkdownDocumentation": "`HorizontalTextAlignment`\n\nThe horizontal text alignment (left, center, right, auto) for the table cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEFT | CENTER | RIGHT | AUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEFT", "CENTER", "RIGHT", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-horizontaltextalignment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe background color for the table cells.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-backgroundcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TableConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformatting.html", "Properties": { "ConditionalFormattingOptions": { "MarkdownDocumentation": "`ConditionalFormattingOptions`\n\nConditional formatting options for a `PivotTableVisual`.\n*Required*: No\n*Type*: Array of [TableConditionalFormattingOption](./aws-properties-quicksight-template-tableconditionalformattingoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformatting.html#cfn-quicksight-template-tableconditionalformatting-conditionalformattingoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableConditionalFormattingOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TableConditionalFormattingOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableConditionalFormattingOption`\n\nConditional formatting options for a `PivotTableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformattingoption.html", "Properties": { "Row": { "MarkdownDocumentation": "`Row`\n\nThe row conditional formatting option for a table.\n*Required*: No\n*Type*: [TableRowConditionalFormatting](./aws-properties-quicksight-template-tablerowconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformattingoption.html#cfn-quicksight-template-tableconditionalformattingoption-row", "UpdateType": "Mutable", "Required": false, "Type": "TableRowConditionalFormatting" }, "Cell": { "MarkdownDocumentation": "`Cell`\n\nThe cell conditional formatting option for a table.\n*Required*: No\n*Type*: [TableCellConditionalFormatting](./aws-properties-quicksight-template-tablecellconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformattingoption.html#cfn-quicksight-template-tableconditionalformattingoption-cell", "UpdateType": "Mutable", "Required": false, "Type": "TableCellConditionalFormatting" } } }, "AWS::QuickSight::Template.TableConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableConfiguration`\n\nThe configuration for a `TableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration for a `TableVisual`.\n*Required*: No\n*Type*: [TableSortConfiguration](./aws-properties-quicksight-template-tablesortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableSortConfiguration" }, "PaginatedReportOptions": { "MarkdownDocumentation": "`PaginatedReportOptions`\n\nThe paginated report options for a table visual.\n*Required*: No\n*Type*: [TablePaginatedReportOptions](./aws-properties-quicksight-template-tablepaginatedreportoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-paginatedreportoptions", "UpdateType": "Mutable", "Required": false, "Type": "TablePaginatedReportOptions" }, "TableOptions": { "MarkdownDocumentation": "`TableOptions`\n\nThe table options for a table visual.\n*Required*: No\n*Type*: [TableOptions](./aws-properties-quicksight-template-tableoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-tableoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableOptions" }, "TableInlineVisualizations": { "MarkdownDocumentation": "`TableInlineVisualizations`\n\nA collection of inline visualizations to display within a chart.\n*Required*: No\n*Type*: Array of [TableInlineVisualization](./aws-properties-quicksight-template-tableinlinevisualization.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-tableinlinevisualizations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableInlineVisualization", "DuplicatesAllowed": true }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [TableFieldWells](./aws-properties-quicksight-template-tablefieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldWells" }, "FieldOptions": { "MarkdownDocumentation": "`FieldOptions`\n\nThe field options for a table visual.\n*Required*: No\n*Type*: [TableFieldOptions](./aws-properties-quicksight-template-tablefieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-fieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "TotalOptions": { "MarkdownDocumentation": "`TotalOptions`\n\nThe total options for a table visual.\n*Required*: No\n*Type*: [TotalOptions](./aws-properties-quicksight-template-totaloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-totaloptions", "UpdateType": "Mutable", "Required": false, "Type": "TotalOptions" } } }, "AWS::QuickSight::Template.TableFieldCustomIconContent": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldCustomIconContent`\n\nThe custom icon content for the table link content configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomiconcontent.html", "Properties": { "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe icon set type (link) of the custom icon content for table URL link content.\n*Required*: No\n*Type*: String\n*Allowed values*: `LINK`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "LINK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomiconcontent.html#cfn-quicksight-template-tablefieldcustomiconcontent-icon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TableFieldCustomTextContent": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldCustomTextContent`\n\nThe custom text content (value, font configuration) for the table link content configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomtextcontent.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe string value of the custom text content for the table URL link 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomtextcontent.html#cfn-quicksight-template-tablefieldcustomtextcontent-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FontConfiguration": { "MarkdownDocumentation": "`FontConfiguration`\n\nThe font configuration of the custom text content for the table URL link content.\n*Required*: Yes\n*Type*: [FontConfiguration](./aws-properties-quicksight-template-fontconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomtextcontent.html#cfn-quicksight-template-tablefieldcustomtextcontent-fontconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "FontConfiguration" } } }, "AWS::QuickSight::Template.TableFieldImageConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldImageConfiguration`\n\nThe image configuration of a table field URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldimageconfiguration.html", "Properties": { "SizingOptions": { "MarkdownDocumentation": "`SizingOptions`\n\nThe sizing options for the table image configuration.\n*Required*: No\n*Type*: [TableCellImageSizingConfiguration](./aws-properties-quicksight-template-tablecellimagesizingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldimageconfiguration.html#cfn-quicksight-template-tablefieldimageconfiguration-sizingoptions", "UpdateType": "Mutable", "Required": false, "Type": "TableCellImageSizingConfiguration" } } }, "AWS::QuickSight::Template.TableFieldLinkConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldLinkConfiguration`\n\nThe link configuration of a table field URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkconfiguration.html", "Properties": { "Target": { "MarkdownDocumentation": "`Target`\n\nThe URL target (new tab, new window, same tab) for the table link configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW_TAB | NEW_WINDOW | SAME...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW_TAB", "NEW_WINDOW", "SAME_TAB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkconfiguration.html#cfn-quicksight-template-tablefieldlinkconfiguration-target", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe URL content (text, icon) for the table link configuration.\n*Required*: Yes\n*Type*: [TableFieldLinkContentConfiguration](./aws-properties-quicksight-template-tablefieldlinkcontentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkconfiguration.html#cfn-quicksight-template-tablefieldlinkconfiguration-content", "UpdateType": "Mutable", "Required": true, "Type": "TableFieldLinkContentConfiguration" } } }, "AWS::QuickSight::Template.TableFieldLinkContentConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldLinkContentConfiguration`\n\nThe URL content (text, icon) for the table link configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkcontentconfiguration.html", "Properties": { "CustomIconContent": { "MarkdownDocumentation": "`CustomIconContent`\n\nThe custom icon content for the table link content configuration.\n*Required*: No\n*Type*: [TableFieldCustomIconContent](./aws-properties-quicksight-template-tablefieldcustomiconcontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkcontentconfiguration.html#cfn-quicksight-template-tablefieldlinkcontentconfiguration-customiconcontent", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldCustomIconContent" }, "CustomTextContent": { "MarkdownDocumentation": "`CustomTextContent`\n\nThe custom text content (value, font configuration) for the table link content configuration.\n*Required*: No\n*Type*: [TableFieldCustomTextContent](./aws-properties-quicksight-template-tablefieldcustomtextcontent.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkcontentconfiguration.html#cfn-quicksight-template-tablefieldlinkcontentconfiguration-customtextcontent", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldCustomTextContent" } } }, "AWS::QuickSight::Template.TableFieldOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldOption`\n\nThe options for a table field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html", "Properties": { "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label for a table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "URLStyling": { "MarkdownDocumentation": "`URLStyling`\n\nThe URL configuration for a table field.\n*Required*: No\n*Type*: [TableFieldURLConfiguration](./aws-properties-quicksight-template-tablefieldurlconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-urlstyling", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldURLConfiguration" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field ID for a table field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of a table field.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Width": { "MarkdownDocumentation": "`Width`\n\nThe width for a table 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-width", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TableFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldOptions`\n\nThe field options of a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html", "Properties": { "Order": { "MarkdownDocumentation": "`Order`\n\nThe order of the field IDs that are configured as field options for a table visual.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html#cfn-quicksight-template-tablefieldoptions-order", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PinnedFieldOptions": { "MarkdownDocumentation": "`PinnedFieldOptions`\n\nThe settings for the pinned columns of a table visual.\n*Required*: No\n*Type*: [TablePinnedFieldOptions](./aws-properties-quicksight-template-tablepinnedfieldoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html#cfn-quicksight-template-tablefieldoptions-pinnedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "TablePinnedFieldOptions" }, "TransposedTableOptions": { "MarkdownDocumentation": "`TransposedTableOptions`\n\nThe `TableOptions` of a transposed table.\n*Required*: No\n*Type*: Array of [TransposedTableOption](./aws-properties-quicksight-template-transposedtableoption.html)\n*Minimum*: `0`\n*Maximum*: `10001`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html#cfn-quicksight-template-tablefieldoptions-transposedtableoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TransposedTableOption", "DuplicatesAllowed": true }, "SelectedFieldOptions": { "MarkdownDocumentation": "`SelectedFieldOptions`\n\nThe field options to be configured to a table.\n*Required*: No\n*Type*: Array of [TableFieldOption](./aws-properties-quicksight-template-tablefieldoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html#cfn-quicksight-template-tablefieldoptions-selectedfieldoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TableFieldOption", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TableFieldURLConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldURLConfiguration`\n\nThe URL configuration for a table field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldurlconfiguration.html", "Properties": { "LinkConfiguration": { "MarkdownDocumentation": "`LinkConfiguration`\n\nThe link configuration of a table field URL.\n*Required*: No\n*Type*: [TableFieldLinkConfiguration](./aws-properties-quicksight-template-tablefieldlinkconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldurlconfiguration.html#cfn-quicksight-template-tablefieldurlconfiguration-linkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldLinkConfiguration" }, "ImageConfiguration": { "MarkdownDocumentation": "`ImageConfiguration`\n\nThe image configuration of a table field URL.\n*Required*: No\n*Type*: [TableFieldImageConfiguration](./aws-properties-quicksight-template-tablefieldimageconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldurlconfiguration.html#cfn-quicksight-template-tablefieldurlconfiguration-imageconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableFieldImageConfiguration" } } }, "AWS::QuickSight::Template.TableFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableFieldWells`\n\nThe field wells for a table visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldwells.html", "Properties": { "TableUnaggregatedFieldWells": { "MarkdownDocumentation": "`TableUnaggregatedFieldWells`\n\nThe unaggregated field well for the table.\n*Required*: No\n*Type*: [TableUnaggregatedFieldWells](./aws-properties-quicksight-template-tableunaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldwells.html#cfn-quicksight-template-tablefieldwells-tableunaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableUnaggregatedFieldWells" }, "TableAggregatedFieldWells": { "MarkdownDocumentation": "`TableAggregatedFieldWells`\n\nThe aggregated field well for the table.\n*Required*: No\n*Type*: [TableAggregatedFieldWells](./aws-properties-quicksight-template-tableaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldwells.html#cfn-quicksight-template-tablefieldwells-tableaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TableAggregatedFieldWells" } } }, "AWS::QuickSight::Template.TableInlineVisualization": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableInlineVisualization`\n\nThe inline visualization of a specific type to display within a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableinlinevisualization.html", "Properties": { "DataBars": { "MarkdownDocumentation": "`DataBars`\n\nThe configuration of the inline visualization of the data bars within a chart.\n*Required*: No\n*Type*: [DataBarsOptions](./aws-properties-quicksight-template-databarsoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableinlinevisualization.html#cfn-quicksight-template-tableinlinevisualization-databars", "UpdateType": "Mutable", "Required": false, "Type": "DataBarsOptions" } } }, "AWS::QuickSight::Template.TableOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableOptions`\n\nThe table options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html", "Properties": { "HeaderStyle": { "MarkdownDocumentation": "`HeaderStyle`\n\nThe table cell style of a table header.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html#cfn-quicksight-template-tableoptions-headerstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "CellStyle": { "MarkdownDocumentation": "`CellStyle`\n\nThe table cell style of table cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html#cfn-quicksight-template-tableoptions-cellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "Orientation": { "MarkdownDocumentation": "`Orientation`\n\nThe orientation (vertical, horizontal) for a table.\n*Required*: No\n*Type*: String\n*Allowed values*: `VERTICAL | HORIZONTAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VERTICAL", "HORIZONTAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html#cfn-quicksight-template-tableoptions-orientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RowAlternateColorOptions": { "MarkdownDocumentation": "`RowAlternateColorOptions`\n\nThe row alternate color options (widget status, row alternate colors) for a table.\n*Required*: No\n*Type*: [RowAlternateColorOptions](./aws-properties-quicksight-template-rowalternatecoloroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html#cfn-quicksight-template-tableoptions-rowalternatecoloroptions", "UpdateType": "Mutable", "Required": false, "Type": "RowAlternateColorOptions" } } }, "AWS::QuickSight::Template.TablePaginatedReportOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TablePaginatedReportOptions`\n\nThe paginated report options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepaginatedreportoptions.html", "Properties": { "OverflowColumnHeaderVisibility": { "MarkdownDocumentation": "`OverflowColumnHeaderVisibility`\n\nThe visibility of repeating header rows on each page.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepaginatedreportoptions.html#cfn-quicksight-template-tablepaginatedreportoptions-overflowcolumnheadervisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "VerticalOverflowVisibility": { "MarkdownDocumentation": "`VerticalOverflowVisibility`\n\nThe visibility of printing table overflow across pages.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepaginatedreportoptions.html#cfn-quicksight-template-tablepaginatedreportoptions-verticaloverflowvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.TablePinnedFieldOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TablePinnedFieldOptions`\n\nThe settings for the pinned columns of a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepinnedfieldoptions.html", "Properties": { "PinnedLeftFields": { "MarkdownDocumentation": "`PinnedLeftFields`\n\nA list of columns to be pinned to the left of a table visual.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `512 | 201`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepinnedfieldoptions.html#cfn-quicksight-template-tablepinnedfieldoptions-pinnedleftfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TableRowConditionalFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableRowConditionalFormatting`\n\nThe conditional formatting of a table row.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablerowconditionalformatting.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting color (solid, gradient) of the text for a table row.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablerowconditionalformatting.html#cfn-quicksight-template-tablerowconditionalformatting-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting color (solid, gradient) of the background for a table row.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablerowconditionalformatting.html#cfn-quicksight-template-tablerowconditionalformatting-backgroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Template.TableSideBorderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableSideBorderOptions`\n\nThe side border options for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html", "Properties": { "Left": { "MarkdownDocumentation": "`Left`\n\nThe table border options of the left border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-template-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-left", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Top": { "MarkdownDocumentation": "`Top`\n\nThe table border options of the top border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-template-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-top", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "InnerHorizontal": { "MarkdownDocumentation": "`InnerHorizontal`\n\nThe table border options of the inner horizontal border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-template-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-innerhorizontal", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Right": { "MarkdownDocumentation": "`Right`\n\nThe table border options of the right border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-template-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-right", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "Bottom": { "MarkdownDocumentation": "`Bottom`\n\nThe table border options of the bottom border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-template-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-bottom", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" }, "InnerVertical": { "MarkdownDocumentation": "`InnerVertical`\n\nThe table border options of the inner vertical border.\n*Required*: No\n*Type*: [TableBorderOptions](./aws-properties-quicksight-template-tableborderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-innervertical", "UpdateType": "Mutable", "Required": false, "Type": "TableBorderOptions" } } }, "AWS::QuickSight::Template.TableSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableSortConfiguration`\n\nThe sort configuration for a `TableVisual`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesortconfiguration.html", "Properties": { "RowSort": { "MarkdownDocumentation": "`RowSort`\n\nThe field sort options for rows in the table.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesortconfiguration.html#cfn-quicksight-template-tablesortconfiguration-rowsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "PaginationConfiguration": { "MarkdownDocumentation": "`PaginationConfiguration`\n\nThe pagination configuration (page size, page number) for the table.\n*Required*: No\n*Type*: [PaginationConfiguration](./aws-properties-quicksight-template-paginationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesortconfiguration.html#cfn-quicksight-template-tablesortconfiguration-paginationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PaginationConfiguration" } } }, "AWS::QuickSight::Template.TableStyleTarget": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableStyleTarget`\n\nThe table style target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablestyletarget.html", "Properties": { "CellType": { "MarkdownDocumentation": "`CellType`\n\nThe cell type of the table style target.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOTAL | METRIC_HEADER | VAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOTAL", "METRIC_HEADER", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablestyletarget.html#cfn-quicksight-template-tablestyletarget-celltype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TableUnaggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableUnaggregatedFieldWells`\n\nThe unaggregated field well for the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableunaggregatedfieldwells.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe values field well for a pivot table. Values are unaggregated for an unaggregated table.\n*Required*: No\n*Type*: Array of [UnaggregatedField](./aws-properties-quicksight-template-unaggregatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableunaggregatedfieldwells.html#cfn-quicksight-template-tableunaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UnaggregatedField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TableVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TableVisual`\n\nA table visual.\nFor more information, see [Using tables as visuals](https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "ConditionalFormatting": { "MarkdownDocumentation": "`ConditionalFormatting`\n\nThe conditional formatting for a `PivotTableVisual`.\n*Required*: No\n*Type*: [TableConditionalFormatting](./aws-properties-quicksight-template-tableconditionalformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-conditionalformatting", "UpdateType": "Mutable", "Required": false, "Type": "TableConditionalFormatting" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [TableConfiguration](./aws-properties-quicksight-template-tableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TableConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TemplateError": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TemplateError`\n\nList of errors that occurred when the template version creation failed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nType of error.\n*Required*: No\n*Type*: String\n*Allowed values*: `SOURCE_NOT_FOUND | DATA_SET...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html#cfn-quicksight-template-templateerror-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nDescription 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html#cfn-quicksight-template-templateerror-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ViolatedEntities": { "MarkdownDocumentation": "`ViolatedEntities`\n\nAn error path that shows which entities caused the template error.\n*Required*: No\n*Type*: Array of [Entity](./aws-properties-quicksight-template-entity.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html#cfn-quicksight-template-templateerror-violatedentities", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Entity", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TemplateSourceAnalysis": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TemplateSourceAnalysis`\n\nThe source analysis of the template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceanalysis.html", "Properties": { "DataSetReferences": { "MarkdownDocumentation": "`DataSetReferences`\n\nA structure containing information about the dataset references used as placeholders\nin the template.\n*Required*: Yes\n*Type*: Array of [DataSetReference](./aws-properties-quicksight-template-datasetreference.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceanalysis.html#cfn-quicksight-template-templatesourceanalysis-datasetreferences", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataSetReference", "DuplicatesAllowed": true }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceanalysis.html#cfn-quicksight-template-templatesourceanalysis-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TemplateSourceEntity": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TemplateSourceEntity`\n\nThe source entity of the template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html", "Properties": { "SourceAnalysis": { "MarkdownDocumentation": "`SourceAnalysis`\n\nThe source analysis, if it is based on an analysis.\n*Required*: No\n*Type*: [TemplateSourceAnalysis](./aws-properties-quicksight-template-templatesourceanalysis.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html#cfn-quicksight-template-templatesourceentity-sourceanalysis", "UpdateType": "Mutable", "Required": false, "Type": "TemplateSourceAnalysis" }, "SourceTemplate": { "MarkdownDocumentation": "`SourceTemplate`\n\nThe source template, if it is based on an template.\n*Required*: No\n*Type*: [TemplateSourceTemplate](./aws-properties-quicksight-template-templatesourcetemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html#cfn-quicksight-template-templatesourceentity-sourcetemplate", "UpdateType": "Mutable", "Required": false, "Type": "TemplateSourceTemplate" } } }, "AWS::QuickSight::Template.TemplateSourceTemplate": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TemplateSourceTemplate`\n\nThe source template of the template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourcetemplate.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourcetemplate.html#cfn-quicksight-template-templatesourcetemplate-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TemplateVersion": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TemplateVersion`\n\nA version of a template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe 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_IN_PROGRESS | CREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "PENDING_UPDATE", "DELETED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Errors": { "MarkdownDocumentation": "`Errors`\n\nErrors associated with this template version.\n*Required*: No\n*Type*: Array of [TemplateError](./aws-properties-quicksight-template-templateerror.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-errors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TemplateError", "DuplicatesAllowed": true }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThemeArn": { "MarkdownDocumentation": "`ThemeArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-themearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSetConfigurations": { "MarkdownDocumentation": "`DataSetConfigurations`\n\nSchema of the dataset identified by the placeholder. Any dashboard created from this\ntemplate should be bound to new datasets matching the same schema described through this\nAPI operation.\n*Required*: No\n*Type*: Array of [DataSetConfiguration](./aws-properties-quicksight-template-datasetconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-datasetconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataSetConfiguration", "DuplicatesAllowed": true }, "SourceEntityArn": { "MarkdownDocumentation": "`SourceEntityArn`\n\nThe Amazon Resource Name (ARN) of an analysis or template that was used to create this\ntemplate.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-sourceentityarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VersionNumber": { "MarkdownDocumentation": "`VersionNumber`\n\nThe version number of the template version.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-versionnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Sheets": { "MarkdownDocumentation": "`Sheets`\n\nA list of the associated sheets with the unique identifier and name of each sheet.\n*Required*: No\n*Type*: Array of [Sheet](./aws-properties-quicksight-template-sheet.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-sheets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Sheet", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TemplateVersionDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TemplateVersionDefinition`\n\nThe detailed definition of a template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nAn array of option definitions for a template.\n*Required*: No\n*Type*: [AssetOptions](./aws-properties-quicksight-template-assetoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-options", "UpdateType": "Mutable", "Required": false, "Type": "AssetOptions" }, "FilterGroups": { "MarkdownDocumentation": "`FilterGroups`\n\nFilter definitions for a template.\nFor more information, see [Filtering Data](https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [FilterGroup](./aws-properties-quicksight-template-filtergroup.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-filtergroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterGroup", "DuplicatesAllowed": true }, "QueryExecutionOptions": { "MarkdownDocumentation": "`QueryExecutionOptions`\n\nProperty description not available.\n*Required*: No\n*Type*: [QueryExecutionOptions](./aws-properties-quicksight-template-queryexecutionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-queryexecutionoptions", "UpdateType": "Mutable", "Required": false, "Type": "QueryExecutionOptions" }, "CalculatedFields": { "MarkdownDocumentation": "`CalculatedFields`\n\nAn array of calculated field definitions for the template.\n*Required*: No\n*Type*: Array of [CalculatedField](./aws-properties-quicksight-template-calculatedfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-calculatedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CalculatedField", "DuplicatesAllowed": true }, "DataSetConfigurations": { "MarkdownDocumentation": "`DataSetConfigurations`\n\nAn array of dataset configurations. These configurations define the required columns for each dataset used within a template.\n*Required*: Yes\n*Type*: Array of [DataSetConfiguration](./aws-properties-quicksight-template-datasetconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-datasetconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataSetConfiguration", "DuplicatesAllowed": true }, "ColumnConfigurations": { "MarkdownDocumentation": "`ColumnConfigurations`\n\nAn array of template-level column\nconfigurations. Column configurations are used to set default formatting for a column that's used throughout a template.\n*Required*: No\n*Type*: Array of [ColumnConfiguration](./aws-properties-quicksight-template-columnconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-columnconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnConfiguration", "DuplicatesAllowed": true }, "AnalysisDefaults": { "MarkdownDocumentation": "`AnalysisDefaults`\n\nProperty description not available.\n*Required*: No\n*Type*: [AnalysisDefaults](./aws-properties-quicksight-template-analysisdefaults.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-analysisdefaults", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisDefaults" }, "Sheets": { "MarkdownDocumentation": "`Sheets`\n\nAn array of sheet definitions for a template.\n*Required*: No\n*Type*: Array of [SheetDefinition](./aws-properties-quicksight-template-sheetdefinition.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-sheets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SheetDefinition", "DuplicatesAllowed": true }, "ParameterDeclarations": { "MarkdownDocumentation": "`ParameterDeclarations`\n\nAn array of parameter declarations for a template.\n*Parameters* are named variables that can transfer a value for use by an action or an object.\nFor more information, see [Parameters in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the\n*Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: Array of [ParameterDeclaration](./aws-properties-quicksight-template-parameterdeclaration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-parameterdeclarations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ParameterDeclaration", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TextAreaControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TextAreaControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textareacontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textareacontroldisplayoptions.html#cfn-quicksight-template-textareacontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "PlaceholderOptions": { "MarkdownDocumentation": "`PlaceholderOptions`\n\nThe configuration of the placeholder options in a text area control.\n*Required*: No\n*Type*: [TextControlPlaceholderOptions](./aws-properties-quicksight-template-textcontrolplaceholderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textareacontroldisplayoptions.html#cfn-quicksight-template-textareacontroldisplayoptions-placeholderoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextControlPlaceholderOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textareacontroldisplayoptions.html#cfn-quicksight-template-textareacontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Template.TextConditionalFormat": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TextConditionalFormat`\n\nThe conditional formatting for the text.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textconditionalformat.html", "Properties": { "TextColor": { "MarkdownDocumentation": "`TextColor`\n\nThe conditional formatting for the text color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textconditionalformat.html#cfn-quicksight-template-textconditionalformat-textcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" }, "Icon": { "MarkdownDocumentation": "`Icon`\n\nThe conditional formatting for the icon.\n*Required*: No\n*Type*: [ConditionalFormattingIcon](./aws-properties-quicksight-template-conditionalformattingicon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textconditionalformat.html#cfn-quicksight-template-textconditionalformat-icon", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingIcon" }, "BackgroundColor": { "MarkdownDocumentation": "`BackgroundColor`\n\nThe conditional formatting for the text background color.\n*Required*: No\n*Type*: [ConditionalFormattingColor](./aws-properties-quicksight-template-conditionalformattingcolor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textconditionalformat.html#cfn-quicksight-template-textconditionalformat-backgroundcolor", "UpdateType": "Mutable", "Required": false, "Type": "ConditionalFormattingColor" } } }, "AWS::QuickSight::Template.TextControlPlaceholderOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TextControlPlaceholderOptions`\n\nThe configuration of the placeholder options in a text control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textcontrolplaceholderoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility configuration of the placeholder options in a text control.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textcontrolplaceholderoptions.html#cfn-quicksight-template-textcontrolplaceholderoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.TextFieldControlDisplayOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TextFieldControlDisplayOptions`\n\nThe display options of a control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textfieldcontroldisplayoptions.html", "Properties": { "TitleOptions": { "MarkdownDocumentation": "`TitleOptions`\n\nThe options to configure the title visibility, name, and font size.\n*Required*: No\n*Type*: [LabelOptions](./aws-properties-quicksight-template-labeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textfieldcontroldisplayoptions.html#cfn-quicksight-template-textfieldcontroldisplayoptions-titleoptions", "UpdateType": "Mutable", "Required": false, "Type": "LabelOptions" }, "PlaceholderOptions": { "MarkdownDocumentation": "`PlaceholderOptions`\n\nThe configuration of the placeholder options in a text field control.\n*Required*: No\n*Type*: [TextControlPlaceholderOptions](./aws-properties-quicksight-template-textcontrolplaceholderoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textfieldcontroldisplayoptions.html#cfn-quicksight-template-textfieldcontroldisplayoptions-placeholderoptions", "UpdateType": "Mutable", "Required": false, "Type": "TextControlPlaceholderOptions" }, "InfoIconLabelOptions": { "MarkdownDocumentation": "`InfoIconLabelOptions`\n\nThe configuration of info icon label options.\n*Required*: No\n*Type*: [SheetControlInfoIconLabelOptions](./aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textfieldcontroldisplayoptions.html#cfn-quicksight-template-textfieldcontroldisplayoptions-infoiconlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "SheetControlInfoIconLabelOptions" } } }, "AWS::QuickSight::Template.ThousandSeparatorOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ThousandSeparatorOptions`\n\nThe options that determine the thousands separator configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-thousandseparatoroptions.html", "Properties": { "Symbol": { "MarkdownDocumentation": "`Symbol`\n\nDetermines the thousands separator symbol.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMMA | DOT | SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMMA", "DOT", "SPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-thousandseparatoroptions.html#cfn-quicksight-template-thousandseparatoroptions-symbol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nDetermines the visibility of the thousands separator.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-thousandseparatoroptions.html#cfn-quicksight-template-thousandseparatoroptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "GroupingStyle": { "MarkdownDocumentation": "`GroupingStyle`\n\nDetermines the way numbers are styled to accommodate different readability standards. The `DEFAULT` value uses the standard international grouping system and groups numbers by the thousands. The `LAKHS` value uses the Indian numbering system and groups numbers by lakhs and crores.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | LAKHS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "LAKHS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-thousandseparatoroptions.html#cfn-quicksight-template-thousandseparatoroptions-groupingstyle", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TimeBasedForecastProperties": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TimeBasedForecastProperties`\n\nThe forecast properties setup of a forecast in the line chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html", "Properties": { "PeriodsBackward": { "MarkdownDocumentation": "`PeriodsBackward`\n\nThe periods backward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-periodsbackward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PeriodsForward": { "MarkdownDocumentation": "`PeriodsForward`\n\nThe periods forward setup of a forecast computation.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-periodsforward", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "PredictionInterval": { "MarkdownDocumentation": "`PredictionInterval`\n\nThe prediction interval setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `50`\n*Maximum*: `95`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-predictioninterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Seasonality": { "MarkdownDocumentation": "`Seasonality`\n\nThe seasonality setup of a forecast computation. Choose one of the following options:\n* `NULL`: The input is set to `NULL`.\n* `NON_NULL`: The input is set to a custom value.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `180`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-seasonality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "UpperBoundary": { "MarkdownDocumentation": "`UpperBoundary`\n\nThe upper boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-upperboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "LowerBoundary": { "MarkdownDocumentation": "`LowerBoundary`\n\nThe lower boundary setup of a forecast computation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-lowerboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Template.TimeEqualityFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TimeEqualityFilter`\n\nA `TimeEqualityFilter` filters values that are equal to a given value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date input for the `TimeEquality` filter.\nThis field is mutually exclusive to `Value` and `ParameterName`.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-template-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a `TimeEquality` filter.\nThis field is mutually exclusive to `RollingDate` and `ParameterName`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\nThis field is mutually exclusive to `Value` and `RollingDate`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TimeRangeDrillDownFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TimeRangeDrillDownFilter`\n\nThe time range drill down filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html", "Properties": { "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html#cfn-quicksight-template-timerangedrilldownfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RangeMinimum": { "MarkdownDocumentation": "`RangeMinimum`\n\nThe minimum value for the filter value range.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html#cfn-quicksight-template-timerangedrilldownfilter-rangeminimum", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html#cfn-quicksight-template-timerangedrilldownfilter-timegranularity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RangeMaximum": { "MarkdownDocumentation": "`RangeMaximum`\n\nThe maximum value for the filter value range.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html#cfn-quicksight-template-timerangedrilldownfilter-rangemaximum", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TimeRangeFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TimeRangeFilter`\n\nA `TimeRangeFilter` filters values that are between two specified values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html", "Properties": { "RangeMinimumValue": { "MarkdownDocumentation": "`RangeMinimumValue`\n\nThe minimum value for the filter value range.\n*Required*: No\n*Type*: [TimeRangeFilterValue](./aws-properties-quicksight-template-timerangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-rangeminimumvalue", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilterValue" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "RangeMaximumValue": { "MarkdownDocumentation": "`RangeMaximumValue`\n\nThe maximum value for the filter value range.\n*Required*: No\n*Type*: [TimeRangeFilterValue](./aws-properties-quicksight-template-timerangefiltervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-rangemaximumvalue", "UpdateType": "Mutable", "Required": false, "Type": "TimeRangeFilterValue" }, "IncludeMaximum": { "MarkdownDocumentation": "`IncludeMaximum`\n\nDetermines whether the maximum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-includemaximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NullOption": { "MarkdownDocumentation": "`NullOption`\n\nThis option determines how null values should be treated when filtering data.\n* `ALL_VALUES`: Include null values in filtered results.\n* `NULLS_ONLY`: Only include null values in filtered results.\n* `NON_NULLS_ONLY`: Exclude null values from filtered results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_VALUES | NULLS_ONLY | N...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_VALUES", "NULLS_ONLY", "NON_NULLS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-nulloption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IncludeMinimum": { "MarkdownDocumentation": "`IncludeMinimum`\n\nDetermines whether the minimum value in the filter value range should be included in the filtered results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-includeminimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExcludePeriodConfiguration": { "MarkdownDocumentation": "`ExcludePeriodConfiguration`\n\nThe exclude period of the time range filter.\n*Required*: No\n*Type*: [ExcludePeriodConfiguration](./aws-properties-quicksight-template-excludeperiodconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-excludeperiodconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExcludePeriodConfiguration" } } }, "AWS::QuickSight::Template.TimeRangeFilterValue": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TimeRangeFilterValue`\n\nThe value of a time range filter.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefiltervalue.html", "Properties": { "RollingDate": { "MarkdownDocumentation": "`RollingDate`\n\nThe rolling date input value.\n*Required*: No\n*Type*: [RollingDateConfiguration](./aws-properties-quicksight-template-rollingdateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefiltervalue.html#cfn-quicksight-template-timerangefiltervalue-rollingdate", "UpdateType": "Mutable", "Required": false, "Type": "RollingDateConfiguration" }, "StaticValue": { "MarkdownDocumentation": "`StaticValue`\n\nThe static input 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefiltervalue.html#cfn-quicksight-template-timerangefiltervalue-staticvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameter": { "MarkdownDocumentation": "`Parameter`\n\nThe parameter type input value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefiltervalue.html#cfn-quicksight-template-timerangefiltervalue-parameter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TooltipItem": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TooltipItem`\n\nThe tooltip.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipitem.html", "Properties": { "FieldTooltipItem": { "MarkdownDocumentation": "`FieldTooltipItem`\n\nThe tooltip item for the fields.\n*Required*: No\n*Type*: [FieldTooltipItem](./aws-properties-quicksight-template-fieldtooltipitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipitem.html#cfn-quicksight-template-tooltipitem-fieldtooltipitem", "UpdateType": "Mutable", "Required": false, "Type": "FieldTooltipItem" }, "ColumnTooltipItem": { "MarkdownDocumentation": "`ColumnTooltipItem`\n\nThe tooltip item for the columns that are not part of a field well.\n*Required*: No\n*Type*: [ColumnTooltipItem](./aws-properties-quicksight-template-columntooltipitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipitem.html#cfn-quicksight-template-tooltipitem-columntooltipitem", "UpdateType": "Mutable", "Required": false, "Type": "ColumnTooltipItem" } } }, "AWS::QuickSight::Template.TooltipOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TooltipOptions`\n\nThe display options for the visual tooltip.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipoptions.html", "Properties": { "SelectedTooltipType": { "MarkdownDocumentation": "`SelectedTooltipType`\n\nThe selected type for the tooltip. Choose one of the following options:\n* `BASIC`: A basic tooltip.\n* `DETAILED`: A detailed tooltip.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC | DETAILED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "DETAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipoptions.html#cfn-quicksight-template-tooltipoptions-selectedtooltiptype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TooltipVisibility": { "MarkdownDocumentation": "`TooltipVisibility`\n\nDetermines whether or not the tooltip is visible.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipoptions.html#cfn-quicksight-template-tooltipoptions-tooltipvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "FieldBasedTooltip": { "MarkdownDocumentation": "`FieldBasedTooltip`\n\nThe setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.\n*Required*: No\n*Type*: [FieldBasedTooltip](./aws-properties-quicksight-template-fieldbasedtooltip.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipoptions.html#cfn-quicksight-template-tooltipoptions-fieldbasedtooltip", "UpdateType": "Mutable", "Required": false, "Type": "FieldBasedTooltip" } } }, "AWS::QuickSight::Template.TopBottomFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TopBottomFilter`\n\nA `TopBottomFilter` filters values that are at the top or the bottom.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html", "Properties": { "AggregationSortConfigurations": { "MarkdownDocumentation": "`AggregationSortConfigurations`\n\nThe aggregation and sort configuration of the top bottom filter.\n*Required*: Yes\n*Type*: Array of [AggregationSortConfiguration](./aws-properties-quicksight-template-aggregationsortconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-aggregationsortconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AggregationSortConfiguration", "DuplicatesAllowed": true }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that the filter is applied to.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `YEAR | QUARTER | MONTH | WE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe parameter whose value should be used for the filter value.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-parametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nThe number of items to include in the top bottom filter results.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-limit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "DefaultFilterControlConfiguration": { "MarkdownDocumentation": "`DefaultFilterControlConfiguration`\n\nThe default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.\n*Required*: No\n*Type*: [DefaultFilterControlConfiguration](./aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-defaultfiltercontrolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFilterControlConfiguration" }, "FilterId": { "MarkdownDocumentation": "`FilterId`\n\nAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-filterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TopBottomMoversComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TopBottomMoversComputation`\n\nThe top movers and bottom movers computation setup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe computation type. Choose from the following options:\n* TOP: Top movers computation.\n* BOTTOM: Bottom movers computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOP | BOTTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "BOTTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "SortOrder": { "MarkdownDocumentation": "`SortOrder`\n\nThe sort order setup of the top and bottom movers computation.\n*Required*: No\n*Type*: String\n*Allowed values*: `PERCENT_DIFFERENCE | ABSOLU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PERCENT_DIFFERENCE", "ABSOLUTE_DIFFERENCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-sortorder", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Time": { "MarkdownDocumentation": "`Time`\n\nThe time field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-time", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "MoverSize": { "MarkdownDocumentation": "`MoverSize`\n\nThe mover size setup of the top and bottom movers computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-moversize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TopBottomRankedComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TopBottomRankedComputation`\n\nThe top ranked and bottom ranked computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe computation type. Choose one of the following options:\n* TOP: A top ranked computation.\n* BOTTOM: A bottom ranked computation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TOP | BOTTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TOP", "BOTTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ResultSize": { "MarkdownDocumentation": "`ResultSize`\n\nThe result size of a top and bottom ranked computation.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-resultsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TotalAggregationComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TotalAggregationComputation`\n\nThe total aggregation computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationcomputation.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value field that is used in a computation.\n*Required*: No\n*Type*: [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationcomputation.html#cfn-quicksight-template-totalaggregationcomputation-value", "UpdateType": "Mutable", "Required": false, "Type": "MeasureField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationcomputation.html#cfn-quicksight-template-totalaggregationcomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationcomputation.html#cfn-quicksight-template-totalaggregationcomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TotalAggregationFunction": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TotalAggregationFunction`\n\nAn aggregation function that aggregates the total values of a measure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationfunction.html", "Properties": { "SimpleTotalAggregationFunction": { "MarkdownDocumentation": "`SimpleTotalAggregationFunction`\n\nA built in aggregation function for total values.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | SUM | AVERAGE | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "SUM", "AVERAGE", "MIN", "MAX", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationfunction.html#cfn-quicksight-template-totalaggregationfunction-simpletotalaggregationfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TotalAggregationOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TotalAggregationOption`\n\nThe total aggregation settings map of a field id.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationoption.html", "Properties": { "TotalAggregationFunction": { "MarkdownDocumentation": "`TotalAggregationFunction`\n\nThe total aggregation function that you want to set for a specified field id.\n*Required*: Yes\n*Type*: [TotalAggregationFunction](./aws-properties-quicksight-template-totalaggregationfunction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationoption.html#cfn-quicksight-template-totalaggregationoption-totalaggregationfunction", "UpdateType": "Mutable", "Required": true, "Type": "TotalAggregationFunction" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe field id that's associated with the total aggregation option.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationoption.html#cfn-quicksight-template-totalaggregationoption-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TotalOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TotalOptions`\n\nThe total options for a table visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html", "Properties": { "TotalAggregationOptions": { "MarkdownDocumentation": "`TotalAggregationOptions`\n\nThe total aggregation settings for each value field.\n*Required*: No\n*Type*: Array of [TotalAggregationOption](./aws-properties-quicksight-template-totalaggregationoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalaggregationoptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TotalAggregationOption", "DuplicatesAllowed": true }, "CustomLabel": { "MarkdownDocumentation": "`CustomLabel`\n\nThe custom label string for the total cells.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-customlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScrollStatus": { "MarkdownDocumentation": "`ScrollStatus`\n\nThe scroll status (pinned, scrolled) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `PINNED | SCROLLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PINNED", "SCROLLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-scrollstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe placement (start, end) for the total cells.\n*Required*: No\n*Type*: String\n*Allowed values*: `START | END | AUTO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "START", "END", "AUTO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-placement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalCellStyle": { "MarkdownDocumentation": "`TotalCellStyle`\n\nCell styling options for the total cells.\n*Required*: No\n*Type*: [TableCellStyle](./aws-properties-quicksight-template-tablecellstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalcellstyle", "UpdateType": "Mutable", "Required": false, "Type": "TableCellStyle" }, "TotalsVisibility": { "MarkdownDocumentation": "`TotalsVisibility`\n\nThe visibility configuration for the total cells.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalsvisibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.TransposedTableOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TransposedTableOption`\n\nThe column option of the transposed table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-transposedtableoption.html", "Properties": { "ColumnWidth": { "MarkdownDocumentation": "`ColumnWidth`\n\nThe width of a column in a transposed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-transposedtableoption.html#cfn-quicksight-template-transposedtableoption-columnwidth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnIndex": { "MarkdownDocumentation": "`ColumnIndex`\n\nThe index of a columns in a transposed table. The index range is 0-9999.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `9999`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-transposedtableoption.html#cfn-quicksight-template-transposedtableoption-columnindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ColumnType": { "MarkdownDocumentation": "`ColumnType`\n\nThe column type of the column in a transposed table. Choose one of the following options:\n* `ROW_HEADER_COLUMN`: Refers to the leftmost column of the row header in the transposed table.\n* `VALUE_COLUMN`: Refers to all value columns in the transposed table.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ROW_HEADER_COLUMN | VALUE_C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ROW_HEADER_COLUMN", "VALUE_COLUMN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-transposedtableoption.html#cfn-quicksight-template-transposedtableoption-columntype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.TreeMapAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TreeMapAggregatedFieldWells`\n\nAggregated field wells of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapaggregatedfieldwells.html", "Properties": { "Sizes": { "MarkdownDocumentation": "`Sizes`\n\nThe size field well of a tree map. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapaggregatedfieldwells.html#cfn-quicksight-template-treemapaggregatedfieldwells-sizes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe color field well of a tree map. Values are grouped by aggregations based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapaggregatedfieldwells.html#cfn-quicksight-template-treemapaggregatedfieldwells-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe group by field well of a tree map. Values are grouped based on group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapaggregatedfieldwells.html#cfn-quicksight-template-treemapaggregatedfieldwells-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TreeMapConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TreeMapConfiguration`\n\nThe configuration of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a tree map.\n*Required*: No\n*Type*: [TreeMapSortConfiguration](./aws-properties-quicksight-template-treemapsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend display setup of the visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe options that determine if visual data labels are displayed.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "ColorLabelOptions": { "MarkdownDocumentation": "`ColorLabelOptions`\n\nThe label options (label text, label visibility) for the colors displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-colorlabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SizeLabelOptions": { "MarkdownDocumentation": "`SizeLabelOptions`\n\nThe label options (label text, label visibility) of the sizes that are displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-sizelabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [TreeMapFieldWells](./aws-properties-quicksight-template-treemapfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapFieldWells" }, "Tooltip": { "MarkdownDocumentation": "`Tooltip`\n\nThe tooltip display setup of the visual.\n*Required*: No\n*Type*: [TooltipOptions](./aws-properties-quicksight-template-tooltipoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-tooltip", "UpdateType": "Mutable", "Required": false, "Type": "TooltipOptions" }, "ColorScale": { "MarkdownDocumentation": "`ColorScale`\n\nThe color options (gradient color, point of divergence) of a tree map.\n*Required*: No\n*Type*: [ColorScale](./aws-properties-quicksight-template-colorscale.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-colorscale", "UpdateType": "Mutable", "Required": false, "Type": "ColorScale" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "GroupLabelOptions": { "MarkdownDocumentation": "`GroupLabelOptions`\n\nThe label options (label text, label visibility) of the groups that are displayed in a tree map.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-grouplabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" } } }, "AWS::QuickSight::Template.TreeMapFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TreeMapFieldWells`\n\nThe field wells of a tree map.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapfieldwells.html", "Properties": { "TreeMapAggregatedFieldWells": { "MarkdownDocumentation": "`TreeMapAggregatedFieldWells`\n\nThe aggregated field wells of a tree map.\n*Required*: No\n*Type*: [TreeMapAggregatedFieldWells](./aws-properties-quicksight-template-treemapaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapfieldwells.html#cfn-quicksight-template-treemapfieldwells-treemapaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapAggregatedFieldWells" } } }, "AWS::QuickSight::Template.TreeMapSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TreeMapSortConfiguration`\n\nThe sort configuration of a tree map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapsortconfiguration.html", "Properties": { "TreeMapSort": { "MarkdownDocumentation": "`TreeMapSort`\n\nThe sort configuration of group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapsortconfiguration.html#cfn-quicksight-template-treemapsortconfiguration-treemapsort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true }, "TreeMapGroupItemsLimitConfiguration": { "MarkdownDocumentation": "`TreeMapGroupItemsLimitConfiguration`\n\nThe limit on the number of groups that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapsortconfiguration.html#cfn-quicksight-template-treemapsortconfiguration-treemapgroupitemslimitconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" } } }, "AWS::QuickSight::Template.TreeMapVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TreeMapVisual`\n\nA tree map.\nFor more information, see [Using tree maps](https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [TreeMapConfiguration](./aws-properties-quicksight-template-treemapconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.TrendArrowOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.TrendArrowOptions`\n\nThe options that determine the presentation of trend arrows in a KPI visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-trendarrowoptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the trend arrows.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-trendarrowoptions.html#cfn-quicksight-template-trendarrowoptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::QuickSight::Template.UnaggregatedField": { "MarkdownDocumentation": "`AWS::QuickSight::Template.UnaggregatedField`\n\nThe unaggregated field for a table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-unaggregatedfield.html", "Properties": { "FormatConfiguration": { "MarkdownDocumentation": "`FormatConfiguration`\n\nThe format configuration of the field.\n*Required*: No\n*Type*: [FormatConfiguration](./aws-properties-quicksight-template-formatconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-unaggregatedfield.html#cfn-quicksight-template-unaggregatedfield-formatconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FormatConfiguration" }, "Column": { "MarkdownDocumentation": "`Column`\n\nThe column that is used in the `UnaggregatedField`.\n*Required*: Yes\n*Type*: [ColumnIdentifier](./aws-properties-quicksight-template-columnidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-unaggregatedfield.html#cfn-quicksight-template-unaggregatedfield-column", "UpdateType": "Mutable", "Required": true, "Type": "ColumnIdentifier" }, "FieldId": { "MarkdownDocumentation": "`FieldId`\n\nThe custom field ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-unaggregatedfield.html#cfn-quicksight-template-unaggregatedfield-fieldid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.UniqueValuesComputation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.UniqueValuesComputation`\n\nThe unique values computation configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-uniquevaluescomputation.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category field that is used in a computation.\n*Required*: No\n*Type*: [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-uniquevaluescomputation.html#cfn-quicksight-template-uniquevaluescomputation-category", "UpdateType": "Mutable", "Required": false, "Type": "DimensionField" }, "ComputationId": { "MarkdownDocumentation": "`ComputationId`\n\nThe ID for a computation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-uniquevaluescomputation.html#cfn-quicksight-template-uniquevaluescomputation-computationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a computation.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-uniquevaluescomputation.html#cfn-quicksight-template-uniquevaluescomputation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.ValidationStrategy": { "MarkdownDocumentation": "`AWS::QuickSight::Template.ValidationStrategy`\n\nThe option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to `LENIENT`, validation is skipped for specific errors.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-validationstrategy.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe mode of validation for the asset to be created or updated. When you set this value to `STRICT`, strict validation for every error is enforced. When you set this value to `LENIENT`, validation is skipped for specific UI errors.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRICT | LENIENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRICT", "LENIENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-validationstrategy.html#cfn-quicksight-template-validationstrategy-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.VisibleRangeOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.VisibleRangeOptions`\n\nThe range options for the data zoom scroll bar.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visiblerangeoptions.html", "Properties": { "PercentRange": { "MarkdownDocumentation": "`PercentRange`\n\nThe percent range in the visible range.\n*Required*: No\n*Type*: [PercentVisibleRange](./aws-properties-quicksight-template-percentvisiblerange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visiblerangeoptions.html#cfn-quicksight-template-visiblerangeoptions-percentrange", "UpdateType": "Mutable", "Required": false, "Type": "PercentVisibleRange" } } }, "AWS::QuickSight::Template.Visual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.Visual`\n\nA visual displayed on a sheet in an analysis, dashboard, or template.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html", "Properties": { "FunnelChartVisual": { "MarkdownDocumentation": "`FunnelChartVisual`\n\nA funnel chart.\nFor more information, see [Using funnel charts](https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [FunnelChartVisual](./aws-properties-quicksight-template-funnelchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-funnelchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "FunnelChartVisual" }, "FilledMapVisual": { "MarkdownDocumentation": "`FilledMapVisual`\n\nA filled map.\nFor more information, see [Creating filled maps](https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [FilledMapVisual](./aws-properties-quicksight-template-filledmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-filledmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "FilledMapVisual" }, "BoxPlotVisual": { "MarkdownDocumentation": "`BoxPlotVisual`\n\nA box plot.\nFor more information, see [Using box plots](https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [BoxPlotVisual](./aws-properties-quicksight-template-boxplotvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-boxplotvisual", "UpdateType": "Mutable", "Required": false, "Type": "BoxPlotVisual" }, "WaterfallVisual": { "MarkdownDocumentation": "`WaterfallVisual`\n\nA waterfall chart.\nFor more information, see [Using waterfall charts](https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [WaterfallVisual](./aws-properties-quicksight-template-waterfallvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-waterfallvisual", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallVisual" }, "CustomContentVisual": { "MarkdownDocumentation": "`CustomContentVisual`\n\nA visual that contains custom content.\nFor more information, see [Using custom visual content](https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [CustomContentVisual](./aws-properties-quicksight-template-customcontentvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-customcontentvisual", "UpdateType": "Mutable", "Required": false, "Type": "CustomContentVisual" }, "PieChartVisual": { "MarkdownDocumentation": "`PieChartVisual`\n\nA pie or donut chart.\nFor more information, see [Using pie charts](https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [PieChartVisual](./aws-properties-quicksight-template-piechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-piechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "PieChartVisual" }, "KPIVisual": { "MarkdownDocumentation": "`KPIVisual`\n\nA key performance indicator (KPI).\nFor more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [KPIVisual](./aws-properties-quicksight-template-kpivisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-kpivisual", "UpdateType": "Mutable", "Required": false, "Type": "KPIVisual" }, "HistogramVisual": { "MarkdownDocumentation": "`HistogramVisual`\n\nA histogram.\nFor more information, see [Using histograms](https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [HistogramVisual](./aws-properties-quicksight-template-histogramvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-histogramvisual", "UpdateType": "Mutable", "Required": false, "Type": "HistogramVisual" }, "PluginVisual": { "MarkdownDocumentation": "`PluginVisual`\n\nThe custom plugin visual type.\n*Required*: No\n*Type*: [PluginVisual](./aws-properties-quicksight-template-pluginvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-pluginvisual", "UpdateType": "Mutable", "Required": false, "Type": "PluginVisual" }, "GeospatialMapVisual": { "MarkdownDocumentation": "`GeospatialMapVisual`\n\nA geospatial map or a points on map visual.\nFor more information, see [Creating point maps](https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [GeospatialMapVisual](./aws-properties-quicksight-template-geospatialmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-geospatialmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "GeospatialMapVisual" }, "TableVisual": { "MarkdownDocumentation": "`TableVisual`\n\nA table visual.\nFor more information, see [Using tables as visuals](https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [TableVisual](./aws-properties-quicksight-template-tablevisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-tablevisual", "UpdateType": "Mutable", "Required": false, "Type": "TableVisual" }, "PivotTableVisual": { "MarkdownDocumentation": "`PivotTableVisual`\n\nA pivot table.\nFor more information, see [Using pivot tables](https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [PivotTableVisual](./aws-properties-quicksight-template-pivottablevisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-pivottablevisual", "UpdateType": "Mutable", "Required": false, "Type": "PivotTableVisual" }, "ScatterPlotVisual": { "MarkdownDocumentation": "`ScatterPlotVisual`\n\nA scatter plot.\nFor more information, see [Using scatter plots](https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [ScatterPlotVisual](./aws-properties-quicksight-template-scatterplotvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-scatterplotvisual", "UpdateType": "Mutable", "Required": false, "Type": "ScatterPlotVisual" }, "RadarChartVisual": { "MarkdownDocumentation": "`RadarChartVisual`\n\nA radar chart visual.\nFor more information, see [Using radar charts](https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [RadarChartVisual](./aws-properties-quicksight-template-radarchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-radarchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "RadarChartVisual" }, "BarChartVisual": { "MarkdownDocumentation": "`BarChartVisual`\n\nA bar chart.\nFor more information, see [Using bar charts](https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [BarChartVisual](./aws-properties-quicksight-template-barchartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-barchartvisual", "UpdateType": "Mutable", "Required": false, "Type": "BarChartVisual" }, "HeatMapVisual": { "MarkdownDocumentation": "`HeatMapVisual`\n\nA heat map.\nFor more information, see [Using heat maps](https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [HeatMapVisual](./aws-properties-quicksight-template-heatmapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-heatmapvisual", "UpdateType": "Mutable", "Required": false, "Type": "HeatMapVisual" }, "TreeMapVisual": { "MarkdownDocumentation": "`TreeMapVisual`\n\nA tree map.\nFor more information, see [Using tree maps](https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [TreeMapVisual](./aws-properties-quicksight-template-treemapvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-treemapvisual", "UpdateType": "Mutable", "Required": false, "Type": "TreeMapVisual" }, "ComboChartVisual": { "MarkdownDocumentation": "`ComboChartVisual`\n\nA combo chart.\nFor more information, see [Using combo charts](https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [ComboChartVisual](./aws-properties-quicksight-template-combochartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-combochartvisual", "UpdateType": "Mutable", "Required": false, "Type": "ComboChartVisual" }, "WordCloudVisual": { "MarkdownDocumentation": "`WordCloudVisual`\n\nA word cloud.\nFor more information, see [Using word clouds](https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [WordCloudVisual](./aws-properties-quicksight-template-wordcloudvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-wordcloudvisual", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudVisual" }, "InsightVisual": { "MarkdownDocumentation": "`InsightVisual`\n\nAn insight visual.\nFor more information, see [Working with insights](https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [InsightVisual](./aws-properties-quicksight-template-insightvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-insightvisual", "UpdateType": "Mutable", "Required": false, "Type": "InsightVisual" }, "SankeyDiagramVisual": { "MarkdownDocumentation": "`SankeyDiagramVisual`\n\nA sankey diagram.\nFor more information, see [Using Sankey diagrams](https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [SankeyDiagramVisual](./aws-properties-quicksight-template-sankeydiagramvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-sankeydiagramvisual", "UpdateType": "Mutable", "Required": false, "Type": "SankeyDiagramVisual" }, "GaugeChartVisual": { "MarkdownDocumentation": "`GaugeChartVisual`\n\nA gauge chart.\nFor more information, see [Using gauge charts](https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [GaugeChartVisual](./aws-properties-quicksight-template-gaugechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-gaugechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "GaugeChartVisual" }, "LineChartVisual": { "MarkdownDocumentation": "`LineChartVisual`\n\nA line chart.\nFor more information, see [Using line charts](https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the *Amazon Quick Suite User Guide*.\n*Required*: No\n*Type*: [LineChartVisual](./aws-properties-quicksight-template-linechartvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-linechartvisual", "UpdateType": "Mutable", "Required": false, "Type": "LineChartVisual" }, "EmptyVisual": { "MarkdownDocumentation": "`EmptyVisual`\n\nAn empty visual.\n*Required*: No\n*Type*: [EmptyVisual](./aws-properties-quicksight-template-emptyvisual.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-emptyvisual", "UpdateType": "Mutable", "Required": false, "Type": "EmptyVisual" } } }, "AWS::QuickSight::Template.VisualCustomAction": { "MarkdownDocumentation": "`AWS::QuickSight::Template.VisualCustomAction`\n\nA custom action defined on a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the `VisualCustomAction`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Trigger": { "MarkdownDocumentation": "`Trigger`\n\nThe trigger of the `VisualCustomAction`.\nValid values are defined as follows:\n* `DATA_POINT_CLICK`: Initiates a custom action by a left pointer click on a data point.\n* `DATA_POINT_MENU`: Initiates a custom action by right pointer click from the menu.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DATA_POINT_CLICK | DATA_POI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DATA_POINT_CLICK", "DATA_POINT_MENU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-trigger", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomActionId": { "MarkdownDocumentation": "`CustomActionId`\n\nThe ID of the `VisualCustomAction`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-customactionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the `VisualCustomAction`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionOperations": { "MarkdownDocumentation": "`ActionOperations`\n\nA list of `VisualCustomActionOperations`.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n*Required*: Yes\n*Type*: Array of [VisualCustomActionOperation](./aws-properties-quicksight-template-visualcustomactionoperation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-actionoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "VisualCustomActionOperation", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.VisualCustomActionOperation": { "MarkdownDocumentation": "`AWS::QuickSight::Template.VisualCustomActionOperation`\n\nThe operation that is defined by the custom action.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html", "Properties": { "NavigationOperation": { "MarkdownDocumentation": "`NavigationOperation`\n\nThe navigation operation that navigates between different sheets in the same analysis.\n*Required*: No\n*Type*: [CustomActionNavigationOperation](./aws-properties-quicksight-template-customactionnavigationoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html#cfn-quicksight-template-visualcustomactionoperation-navigationoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionNavigationOperation" }, "SetParametersOperation": { "MarkdownDocumentation": "`SetParametersOperation`\n\nThe set parameter operation that sets parameters in custom action.\n*Required*: No\n*Type*: [CustomActionSetParametersOperation](./aws-properties-quicksight-template-customactionsetparametersoperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html#cfn-quicksight-template-visualcustomactionoperation-setparametersoperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionSetParametersOperation" }, "FilterOperation": { "MarkdownDocumentation": "`FilterOperation`\n\nThe filter operation that filters data included in a visual or in an entire sheet.\n*Required*: No\n*Type*: [CustomActionFilterOperation](./aws-properties-quicksight-template-customactionfilteroperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html#cfn-quicksight-template-visualcustomactionoperation-filteroperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionFilterOperation" }, "URLOperation": { "MarkdownDocumentation": "`URLOperation`\n\nThe URL operation that opens a link to another webpage.\n*Required*: No\n*Type*: [CustomActionURLOperation](./aws-properties-quicksight-template-customactionurloperation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html#cfn-quicksight-template-visualcustomactionoperation-urloperation", "UpdateType": "Mutable", "Required": false, "Type": "CustomActionURLOperation" } } }, "AWS::QuickSight::Template.VisualInteractionOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.VisualInteractionOptions`\n\nThe general visual interactions setup for visual publish options\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualinteractionoptions.html", "Properties": { "ContextMenuOption": { "MarkdownDocumentation": "`ContextMenuOption`\n\nThe context menu options for a visual.\n*Required*: No\n*Type*: [ContextMenuOption](./aws-properties-quicksight-template-contextmenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualinteractionoptions.html#cfn-quicksight-template-visualinteractionoptions-contextmenuoption", "UpdateType": "Mutable", "Required": false, "Type": "ContextMenuOption" }, "VisualMenuOption": { "MarkdownDocumentation": "`VisualMenuOption`\n\nThe on-visual menu options for a visual.\n*Required*: No\n*Type*: [VisualMenuOption](./aws-properties-quicksight-template-visualmenuoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualinteractionoptions.html#cfn-quicksight-template-visualinteractionoptions-visualmenuoption", "UpdateType": "Mutable", "Required": false, "Type": "VisualMenuOption" } } }, "AWS::QuickSight::Template.VisualMenuOption": { "MarkdownDocumentation": "`AWS::QuickSight::Template.VisualMenuOption`\n\nThe menu options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualmenuoption.html", "Properties": { "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availaiblity status of a visual's menu options.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualmenuoption.html#cfn-quicksight-template-visualmenuoption-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.VisualPalette": { "MarkdownDocumentation": "`AWS::QuickSight::Template.VisualPalette`\n\nThe visual display options for the visual palette.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualpalette.html", "Properties": { "ChartColor": { "MarkdownDocumentation": "`ChartColor`\n\nThe chart color options for the visual palette.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualpalette.html#cfn-quicksight-template-visualpalette-chartcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColorMap": { "MarkdownDocumentation": "`ColorMap`\n\nThe color map options for the visual palette.\n*Required*: No\n*Type*: Array of [DataPathColor](./aws-properties-quicksight-template-datapathcolor.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualpalette.html#cfn-quicksight-template-visualpalette-colormap", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataPathColor", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.VisualSubtitleLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.VisualSubtitleLabelOptions`\n\nThe subtitle label options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualsubtitlelabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the subtitle label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualsubtitlelabeloptions.html#cfn-quicksight-template-visualsubtitlelabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "FormatText": { "MarkdownDocumentation": "`FormatText`\n\nThe long text format of the subtitle label, such as plain text or rich text.\n*Required*: No\n*Type*: [LongFormatText](./aws-properties-quicksight-template-longformattext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualsubtitlelabeloptions.html#cfn-quicksight-template-visualsubtitlelabeloptions-formattext", "UpdateType": "Mutable", "Required": false, "Type": "LongFormatText" } } }, "AWS::QuickSight::Template.VisualTitleLabelOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.VisualTitleLabelOptions`\n\nThe title label options for a visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualtitlelabeloptions.html", "Properties": { "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nThe visibility of the title label.\n*Required*: No\n*Type*:\n*Allowed values*: `HIDDEN | VISIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HIDDEN", "VISIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualtitlelabeloptions.html#cfn-quicksight-template-visualtitlelabeloptions-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "FormatText": { "MarkdownDocumentation": "`FormatText`\n\nThe short text format of the title label, such as plain text or rich text.\n*Required*: No\n*Type*: [ShortFormatText](./aws-properties-quicksight-template-shortformattext.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualtitlelabeloptions.html#cfn-quicksight-template-visualtitlelabeloptions-formattext", "UpdateType": "Mutable", "Required": false, "Type": "ShortFormatText" } } }, "AWS::QuickSight::Template.WaterfallChartAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WaterfallChartAggregatedFieldWells`\n\nThe field well configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html", "Properties": { "Categories": { "MarkdownDocumentation": "`Categories`\n\nThe category field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html#cfn-quicksight-template-waterfallchartaggregatedfieldwells-categories", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Breakdowns": { "MarkdownDocumentation": "`Breakdowns`\n\nThe breakdown field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html#cfn-quicksight-template-waterfallchartaggregatedfieldwells-breakdowns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe value field wells of a waterfall visual.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html#cfn-quicksight-template-waterfallchartaggregatedfieldwells-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.WaterfallChartColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WaterfallChartColorConfiguration`\n\nThe color configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartcolorconfiguration.html", "Properties": { "GroupColorConfiguration": { "MarkdownDocumentation": "`GroupColorConfiguration`\n\nThe color configuration for individual groups within a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartGroupColorConfiguration](./aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartcolorconfiguration.html#cfn-quicksight-template-waterfallchartcolorconfiguration-groupcolorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartGroupColorConfiguration" } } }, "AWS::QuickSight::Template.WaterfallChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WaterfallChartConfiguration`\n\nThe configuration for a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html", "Properties": { "CategoryAxisLabelOptions": { "MarkdownDocumentation": "`CategoryAxisLabelOptions`\n\nThe options that determine the presentation of the category axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-categoryaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartSortConfiguration](./aws-properties-quicksight-template-waterfallchartsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartSortConfiguration" }, "Legend": { "MarkdownDocumentation": "`Legend`\n\nThe legend configuration of a waterfall visual.\n*Required*: No\n*Type*: [LegendOptions](./aws-properties-quicksight-template-legendoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-legend", "UpdateType": "Mutable", "Required": false, "Type": "LegendOptions" }, "DataLabels": { "MarkdownDocumentation": "`DataLabels`\n\nThe data label configuration of a waterfall visual.\n*Required*: No\n*Type*: [DataLabelOptions](./aws-properties-quicksight-template-datalabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-datalabels", "UpdateType": "Mutable", "Required": false, "Type": "DataLabelOptions" }, "PrimaryYAxisLabelOptions": { "MarkdownDocumentation": "`PrimaryYAxisLabelOptions`\n\nThe options that determine the presentation of the y-axis label.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-primaryyaxislabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field well configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartFieldWells](./aws-properties-quicksight-template-waterfallchartfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartFieldWells" }, "WaterfallChartOptions": { "MarkdownDocumentation": "`WaterfallChartOptions`\n\nThe options that determine the presentation of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartOptions](./aws-properties-quicksight-template-waterfallchartoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-waterfallchartoptions", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartOptions" }, "ColorConfiguration": { "MarkdownDocumentation": "`ColorConfiguration`\n\nThe color configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartColorConfiguration](./aws-properties-quicksight-template-waterfallchartcolorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-colorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartColorConfiguration" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" }, "CategoryAxisDisplayOptions": { "MarkdownDocumentation": "`CategoryAxisDisplayOptions`\n\nThe options that determine the presentation of the category axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-categoryaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "PrimaryYAxisDisplayOptions": { "MarkdownDocumentation": "`PrimaryYAxisDisplayOptions`\n\nThe options that determine the presentation of the y-axis.\n*Required*: No\n*Type*: [AxisDisplayOptions](./aws-properties-quicksight-template-axisdisplayoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-primaryyaxisdisplayoptions", "UpdateType": "Mutable", "Required": false, "Type": "AxisDisplayOptions" }, "VisualPalette": { "MarkdownDocumentation": "`VisualPalette`\n\nThe visual palette configuration of a waterfall visual.\n*Required*: No\n*Type*: [VisualPalette](./aws-properties-quicksight-template-visualpalette.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-visualpalette", "UpdateType": "Mutable", "Required": false, "Type": "VisualPalette" } } }, "AWS::QuickSight::Template.WaterfallChartFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WaterfallChartFieldWells`\n\nThe field well configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartfieldwells.html", "Properties": { "WaterfallChartAggregatedFieldWells": { "MarkdownDocumentation": "`WaterfallChartAggregatedFieldWells`\n\nThe field well configuration of a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartAggregatedFieldWells](./aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartfieldwells.html#cfn-quicksight-template-waterfallchartfieldwells-waterfallchartaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartAggregatedFieldWells" } } }, "AWS::QuickSight::Template.WaterfallChartGroupColorConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WaterfallChartGroupColorConfiguration`\n\nThe color configuration for individual groups within a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.html", "Properties": { "NegativeBarColor": { "MarkdownDocumentation": "`NegativeBarColor`\n\nDefines the color for the negative bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-template-waterfallchartgroupcolorconfiguration-negativebarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TotalBarColor": { "MarkdownDocumentation": "`TotalBarColor`\n\nDefines the color for the total bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-template-waterfallchartgroupcolorconfiguration-totalbarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PositiveBarColor": { "MarkdownDocumentation": "`PositiveBarColor`\n\nDefines the color for the positive bars of a waterfall chart.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-template-waterfallchartgroupcolorconfiguration-positivebarcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.WaterfallChartOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WaterfallChartOptions`\n\nThe options that determine the presentation of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartoptions.html", "Properties": { "TotalBarLabel": { "MarkdownDocumentation": "`TotalBarLabel`\n\nThis option determines the total bar label of a waterfall visual.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartoptions.html#cfn-quicksight-template-waterfallchartoptions-totalbarlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.WaterfallChartSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WaterfallChartSortConfiguration`\n\nThe sort configuration of a waterfall visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.html", "Properties": { "BreakdownItemsLimit": { "MarkdownDocumentation": "`BreakdownItemsLimit`\n\nThe limit on the number of bar groups that are displayed.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.html#cfn-quicksight-template-waterfallchartsortconfiguration-breakdownitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of the category fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.html#cfn-quicksight-template-waterfallchartsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.WaterfallVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WaterfallVisual`\n\nA waterfall chart.\nFor more information, see [Using waterfall charts](https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration for a waterfall visual.\n*Required*: No\n*Type*: [WaterfallChartConfiguration](./aws-properties-quicksight-template-waterfallchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WaterfallChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.WhatIfPointScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WhatIfPointScenario`\n\nProvides the forecast to meet the target for a particular date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifpointscenario.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe target value that you want to meet for the provided date.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifpointscenario.html#cfn-quicksight-template-whatifpointscenario-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Date": { "MarkdownDocumentation": "`Date`\n\nThe date that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifpointscenario.html#cfn-quicksight-template-whatifpointscenario-date", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.WhatIfRangeScenario": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WhatIfRangeScenario`\n\nProvides the forecast to meet the target for a particular date range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html", "Properties": { "StartDate": { "MarkdownDocumentation": "`StartDate`\n\nThe start date in the date range that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-startdate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe target value that you want to meet for the provided date range.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "EndDate": { "MarkdownDocumentation": "`EndDate`\n\nThe end date in the date range that you need the forecast results for.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-enddate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.WordCloudAggregatedFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WordCloudAggregatedFieldWells`\n\nThe aggregated field wells of a word cloud.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudaggregatedfieldwells.html", "Properties": { "GroupBy": { "MarkdownDocumentation": "`GroupBy`\n\nThe group by field well of a word cloud. Values are grouped by group by fields.\n*Required*: No\n*Type*: Array of [DimensionField](./aws-properties-quicksight-template-dimensionfield.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudaggregatedfieldwells.html#cfn-quicksight-template-wordcloudaggregatedfieldwells-groupby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionField", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size field well of a word cloud. Values are aggregated based on group by fields.\n*Required*: No\n*Type*: Array of [MeasureField](./aws-properties-quicksight-template-measurefield.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudaggregatedfieldwells.html#cfn-quicksight-template-wordcloudaggregatedfieldwells-size", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MeasureField", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.WordCloudChartConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WordCloudChartConfiguration`\n\nThe configuration of a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html", "Properties": { "SortConfiguration": { "MarkdownDocumentation": "`SortConfiguration`\n\nThe sort configuration of a word cloud visual.\n*Required*: No\n*Type*: [WordCloudSortConfiguration](./aws-properties-quicksight-template-wordcloudsortconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-sortconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudSortConfiguration" }, "CategoryLabelOptions": { "MarkdownDocumentation": "`CategoryLabelOptions`\n\nThe label options (label text, label visibility, and sort icon visibility) for the word cloud category.\n*Required*: No\n*Type*: [ChartAxisLabelOptions](./aws-properties-quicksight-template-chartaxislabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-categorylabeloptions", "UpdateType": "Mutable", "Required": false, "Type": "ChartAxisLabelOptions" }, "FieldWells": { "MarkdownDocumentation": "`FieldWells`\n\nThe field wells of the visual.\n*Required*: No\n*Type*: [WordCloudFieldWells](./aws-properties-quicksight-template-wordcloudfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-fieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudFieldWells" }, "WordCloudOptions": { "MarkdownDocumentation": "`WordCloudOptions`\n\nThe options for a word cloud visual.\n*Required*: No\n*Type*: [WordCloudOptions](./aws-properties-quicksight-template-wordcloudoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-wordcloudoptions", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudOptions" }, "Interactions": { "MarkdownDocumentation": "`Interactions`\n\nThe general visual interactions setup for a visual.\n*Required*: No\n*Type*: [VisualInteractionOptions](./aws-properties-quicksight-template-visualinteractionoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-interactions", "UpdateType": "Mutable", "Required": false, "Type": "VisualInteractionOptions" } } }, "AWS::QuickSight::Template.WordCloudFieldWells": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WordCloudFieldWells`\n\nThe field wells of a word cloud visual.\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudfieldwells.html", "Properties": { "WordCloudAggregatedFieldWells": { "MarkdownDocumentation": "`WordCloudAggregatedFieldWells`\n\nThe aggregated field wells of a word cloud.\n*Required*: No\n*Type*: [WordCloudAggregatedFieldWells](./aws-properties-quicksight-template-wordcloudaggregatedfieldwells.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudfieldwells.html#cfn-quicksight-template-wordcloudfieldwells-wordcloudaggregatedfieldwells", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudAggregatedFieldWells" } } }, "AWS::QuickSight::Template.WordCloudOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WordCloudOptions`\n\nThe word cloud options for a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html", "Properties": { "WordOrientation": { "MarkdownDocumentation": "`WordOrientation`\n\nThe word orientation options (horizontal, horizontal\\_and\\_vertical) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `HORIZONTAL | HORIZONTAL_AND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HORIZONTAL", "HORIZONTAL_AND_VERTICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-wordorientation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WordScaling": { "MarkdownDocumentation": "`WordScaling`\n\nThe word scaling options (emphasize, normal) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `EMPHASIZE | NORMAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EMPHASIZE", "NORMAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-wordscaling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CloudLayout": { "MarkdownDocumentation": "`CloudLayout`\n\nThe cloud layout options (fluid, normal) of a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `FLUID | NORMAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FLUID", "NORMAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-cloudlayout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaximumStringLength": { "MarkdownDocumentation": "`MaximumStringLength`\n\nThe length limit of each word from 1-100.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-maximumstringlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "WordCasing": { "MarkdownDocumentation": "`WordCasing`\n\nThe word casing options (lower\\_case, existing\\_case) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `LOWER_CASE | EXISTING_CASE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOWER_CASE", "EXISTING_CASE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-wordcasing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WordPadding": { "MarkdownDocumentation": "`WordPadding`\n\nThe word padding options (none, small, medium, large) for the words in a word cloud.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | SMALL | MEDIUM | LAR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SMALL", "MEDIUM", "LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-wordpadding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Template.WordCloudSortConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WordCloudSortConfiguration`\n\nThe sort configuration of a word cloud visual.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudsortconfiguration.html", "Properties": { "CategoryItemsLimit": { "MarkdownDocumentation": "`CategoryItemsLimit`\n\nThe limit on the number of groups that are displayed in a word cloud.\n*Required*: No\n*Type*: [ItemsLimitConfiguration](./aws-properties-quicksight-template-itemslimitconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudsortconfiguration.html#cfn-quicksight-template-wordcloudsortconfiguration-categoryitemslimit", "UpdateType": "Mutable", "Required": false, "Type": "ItemsLimitConfiguration" }, "CategorySort": { "MarkdownDocumentation": "`CategorySort`\n\nThe sort configuration of group by fields.\n*Required*: No\n*Type*: Array of [FieldSortOptions](./aws-properties-quicksight-template-fieldsortoptions.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudsortconfiguration.html#cfn-quicksight-template-wordcloudsortconfiguration-categorysort", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldSortOptions", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.WordCloudVisual": { "MarkdownDocumentation": "`AWS::QuickSight::Template.WordCloudVisual`\n\nA word cloud.\nFor more information, see [Using word clouds](https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the *Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html", "Properties": { "Subtitle": { "MarkdownDocumentation": "`Subtitle`\n\nThe subtitle that is displayed on the visual.\n*Required*: No\n*Type*: [VisualSubtitleLabelOptions](./aws-properties-quicksight-template-visualsubtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-subtitle", "UpdateType": "Mutable", "Required": false, "Type": "VisualSubtitleLabelOptions" }, "VisualId": { "MarkdownDocumentation": "`VisualId`\n\nThe unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-visualid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChartConfiguration": { "MarkdownDocumentation": "`ChartConfiguration`\n\nThe configuration settings of the visual.\n*Required*: No\n*Type*: [WordCloudChartConfiguration](./aws-properties-quicksight-template-wordcloudchartconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-chartconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WordCloudChartConfiguration" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of custom actions that are configured for a visual.\n*Required*: No\n*Type*: Array of [VisualCustomAction](./aws-properties-quicksight-template-visualcustomaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualCustomAction", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title that is displayed on the visual.\n*Required*: No\n*Type*: [VisualTitleLabelOptions](./aws-properties-quicksight-template-visualtitlelabeloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-title", "UpdateType": "Mutable", "Required": false, "Type": "VisualTitleLabelOptions" }, "VisualContentAltText": { "MarkdownDocumentation": "`VisualContentAltText`\n\nThe alt text for the visual.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-visualcontentalttext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnHierarchies": { "MarkdownDocumentation": "`ColumnHierarchies`\n\nThe column hierarchy that is used during drill-downs and drill-ups.\n*Required*: No\n*Type*: Array of [ColumnHierarchy](./aws-properties-quicksight-template-columnhierarchy.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-columnhierarchies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnHierarchy", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Template.YAxisOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Template.YAxisOptions`\n\nThe options that are available for a single Y axis in a chart.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-yaxisoptions.html", "Properties": { "YAxis": { "MarkdownDocumentation": "`YAxis`\n\nThe Y axis type to be used in the chart.\nIf you choose `PRIMARY_Y_AXIS`, the primary Y Axis is located on the leftmost vertical axis of the chart.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PRIMARY_Y_AXIS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY_Y_AXIS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-yaxisoptions.html#cfn-quicksight-template-yaxisoptions-yaxis", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Theme.BorderStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.BorderStyle`\n\nThe display options for tile borders for visuals.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-borderstyle.html", "Properties": { "Show": { "MarkdownDocumentation": "`Show`\n\nThe option to enable display of borders for visuals.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-borderstyle.html#cfn-quicksight-theme-borderstyle-show", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Theme.DataColorPalette": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.DataColorPalette`\n\nThe theme colors that are used for data colors in charts. The colors description is a\nhexadecimal color code that consists of six alphanumerical characters, prefixed with\n`#`, for example #37BFF5.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html", "Properties": { "EmptyFillColor": { "MarkdownDocumentation": "`EmptyFillColor`\n\nThe hexadecimal code of a color that applies to charts where a lack of data is\nhighlighted.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html#cfn-quicksight-theme-datacolorpalette-emptyfillcolor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Colors": { "MarkdownDocumentation": "`Colors`\n\nThe hexadecimal codes for the colors.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html#cfn-quicksight-theme-datacolorpalette-colors", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MinMaxGradient": { "MarkdownDocumentation": "`MinMaxGradient`\n\nThe minimum and maximum hexadecimal codes that describe a color gradient.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html#cfn-quicksight-theme-datacolorpalette-minmaxgradient", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Theme.Font": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.Font`\n\nDetermines the font settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html", "Properties": { "FontFamily": { "MarkdownDocumentation": "`FontFamily`\n\nDetermines the font family 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html#cfn-quicksight-theme-font-fontfamily", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Theme.GutterStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.GutterStyle`\n\nThe display options for gutter spacing between tiles on a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-gutterstyle.html", "Properties": { "Show": { "MarkdownDocumentation": "`Show`\n\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-gutterstyle.html#cfn-quicksight-theme-gutterstyle-show", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Theme.MarginStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.MarginStyle`\n\nThe display options for margins around the outside edge of sheets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-marginstyle.html", "Properties": { "Show": { "MarkdownDocumentation": "`Show`\n\nThis Boolean value controls whether to display sheet margins.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-marginstyle.html#cfn-quicksight-theme-marginstyle-show", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Theme.ResourcePermission": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.ResourcePermission`\n\nPermission for the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe IAM action to grant or revoke permissions on.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html#cfn-quicksight-theme-resourcepermission-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe Amazon Resource Name (ARN) of the principal. This can be one of the following:\n* The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is\n common.)\n* The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard,\n template, or theme. (This is common.)\n* The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts. (This is\n less common.)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html#cfn-quicksight-theme-resourcepermission-principal", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Theme.SheetStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.SheetStyle`\n\nThe theme display options for sheets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-sheetstyle.html", "Properties": { "TileLayout": { "MarkdownDocumentation": "`TileLayout`\n\nThe layout options for tiles.\n*Required*: No\n*Type*: [TileLayoutStyle](./aws-properties-quicksight-theme-tilelayoutstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-sheetstyle.html#cfn-quicksight-theme-sheetstyle-tilelayout", "UpdateType": "Mutable", "Required": false, "Type": "TileLayoutStyle" }, "Tile": { "MarkdownDocumentation": "`Tile`\n\nThe display options for tiles.\n*Required*: No\n*Type*: [TileStyle](./aws-properties-quicksight-theme-tilestyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-sheetstyle.html#cfn-quicksight-theme-sheetstyle-tile", "UpdateType": "Mutable", "Required": false, "Type": "TileStyle" } } }, "AWS::QuickSight::Theme.ThemeConfiguration": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.ThemeConfiguration`\n\nThe theme configuration. This configuration contains all of the display properties for\na theme.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html", "Properties": { "DataColorPalette": { "MarkdownDocumentation": "`DataColorPalette`\n\nColor properties that apply to chart data colors.\n*Required*: No\n*Type*: [DataColorPalette](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html#cfn-quicksight-theme-themeconfiguration-datacolorpalette", "UpdateType": "Mutable", "Required": false, "Type": "DataColorPalette" }, "UIColorPalette": { "MarkdownDocumentation": "`UIColorPalette`\n\nColor properties that apply to the UI and to charts, excluding the colors that apply\nto data.\n*Required*: No\n*Type*: [UIColorPalette](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html#cfn-quicksight-theme-themeconfiguration-uicolorpalette", "UpdateType": "Mutable", "Required": false, "Type": "UIColorPalette" }, "Sheet": { "MarkdownDocumentation": "`Sheet`\n\nDisplay options related to sheets.\n*Required*: No\n*Type*: [SheetStyle](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html#cfn-quicksight-theme-themeconfiguration-sheet", "UpdateType": "Mutable", "Required": false, "Type": "SheetStyle" }, "Typography": { "MarkdownDocumentation": "`Typography`\n\nDetermines the typography options.\n*Required*: No\n*Type*: [Typography](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html#cfn-quicksight-theme-themeconfiguration-typography", "UpdateType": "Mutable", "Required": false, "Type": "Typography" } } }, "AWS::QuickSight::Theme.ThemeError": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.ThemeError`\n\nTheme error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "INTERNAL_FAILURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html#cfn-quicksight-theme-themeerror-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html#cfn-quicksight-theme-themeerror-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Theme.ThemeVersion": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.ThemeVersion`\n\nA version of a theme.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the theme version.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATION_IN_PROGRESS | CREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "PENDING_UPDATE", "DELETED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Errors": { "MarkdownDocumentation": "`Errors`\n\nErrors associated with the theme.\n*Required*: No\n*Type*: Array of [ThemeError](./aws-properties-quicksight-theme-themeerror.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-errors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ThemeError", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedTime": { "MarkdownDocumentation": "`CreatedTime`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-createdtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe theme configuration, which contains all the theme display properties.\n*Required*: No\n*Type*: [ThemeConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-configuration", "UpdateType": "Mutable", "Required": false, "Type": "ThemeConfiguration" }, "BaseThemeId": { "MarkdownDocumentation": "`BaseThemeId`\n\nThe Quick Sight-defined ID of the theme that a custom theme inherits from. All\nthemes initially inherit from a default Quick Sight theme.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-basethemeid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VersionNumber": { "MarkdownDocumentation": "`VersionNumber`\n\nThe version number of the theme.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-versionnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::QuickSight::Theme.TileLayoutStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.TileLayoutStyle`\n\nThe display options for the layout of tiles on a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilelayoutstyle.html", "Properties": { "Gutter": { "MarkdownDocumentation": "`Gutter`\n\nThe gutter settings that apply between tiles.\n*Required*: No\n*Type*: [GutterStyle](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilelayoutstyle.html#cfn-quicksight-theme-tilelayoutstyle-gutter", "UpdateType": "Mutable", "Required": false, "Type": "GutterStyle" }, "Margin": { "MarkdownDocumentation": "`Margin`\n\nThe margin settings that apply around the outside edge of sheets.\n*Required*: No\n*Type*: [MarginStyle](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilelayoutstyle.html#cfn-quicksight-theme-tilelayoutstyle-margin", "UpdateType": "Mutable", "Required": false, "Type": "MarginStyle" } } }, "AWS::QuickSight::Theme.TileStyle": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.TileStyle`\n\nDisplay options related to tiles on a sheet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilestyle.html", "Properties": { "Border": { "MarkdownDocumentation": "`Border`\n\nThe border around a tile.\n*Required*: No\n*Type*: [BorderStyle](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilestyle.html#cfn-quicksight-theme-tilestyle-border", "UpdateType": "Mutable", "Required": false, "Type": "BorderStyle" } } }, "AWS::QuickSight::Theme.Typography": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.Typography`\n\nDetermines the typography options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html", "Properties": { "FontFamilies": { "MarkdownDocumentation": "`FontFamilies`\n\nDetermines the list of font families.\n*Required*: No\n*Type*: Array of [Font](./aws-properties-quicksight-theme-font.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html#cfn-quicksight-theme-typography-fontfamilies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Font", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Theme.UIColorPalette": { "MarkdownDocumentation": "`AWS::QuickSight::Theme.UIColorPalette`\n\nThe theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexadecimal\ncolor code that consists of six alphanumerical characters, prefixed with `#`, for example #37BFF5. For\nmore information, see [Using Themes\nin Amazon Quick Suite](https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the *Amazon Quick Suite User Guide.*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html", "Properties": { "Warning": { "MarkdownDocumentation": "`Warning`\n\nThis color that applies to warning and informational messages.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-warning", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Accent": { "MarkdownDocumentation": "`Accent`\n\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-accent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccentForeground": { "MarkdownDocumentation": "`AccentForeground`\n\nThe foreground color that applies to any text or other elements that appear over the\naccent color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-accentforeground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecondaryBackground": { "MarkdownDocumentation": "`SecondaryBackground`\n\nThe background color that applies to the sheet background and sheet controls.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-secondarybackground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DangerForeground": { "MarkdownDocumentation": "`DangerForeground`\n\nThe foreground color that applies to any text or other elements that appear over the\nerror color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dangerforeground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrimaryBackground": { "MarkdownDocumentation": "`PrimaryBackground`\n\nThe background color that applies to visuals and other high emphasis UI.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-primarybackground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dimension": { "MarkdownDocumentation": "`Dimension`\n\nThe color that applies to the names of fields that are identified as\ndimensions.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dimension", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecondaryForeground": { "MarkdownDocumentation": "`SecondaryForeground`\n\nThe foreground color that applies to any sheet title, sheet control text, or UI that\nappears over the secondary background.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-secondaryforeground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WarningForeground": { "MarkdownDocumentation": "`WarningForeground`\n\nThe foreground color that applies to any text or other elements that appear over the\nwarning color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-warningforeground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DimensionForeground": { "MarkdownDocumentation": "`DimensionForeground`\n\nThe foreground color that applies to any text or other elements that appear over the\ndimension color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dimensionforeground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrimaryForeground": { "MarkdownDocumentation": "`PrimaryForeground`\n\nThe color of text and other foreground elements that appear over the primary\nbackground regions, such as grid lines, borders, table banding, icons, and so on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-primaryforeground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Success": { "MarkdownDocumentation": "`Success`\n\nThe color that applies to success messages, for example the check mark for a\nsuccessful download.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-success", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Danger": { "MarkdownDocumentation": "`Danger`\n\nThe color that applies to error messages.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-danger", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SuccessForeground": { "MarkdownDocumentation": "`SuccessForeground`\n\nThe foreground color that applies to any text or other elements that appear over the\nsuccess color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-successforeground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Measure": { "MarkdownDocumentation": "`Measure`\n\nThe color that applies to the names of fields that are identified as measures.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-measure", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MeasureForeground": { "MarkdownDocumentation": "`MeasureForeground`\n\nThe foreground color that applies to any text or other elements that appear over the\nmeasure color.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-measureforeground", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.CellValueSynonym": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.CellValueSynonym`\n\nA structure that represents the cell value synonym.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-cellvaluesynonym.html", "Properties": { "Synonyms": { "MarkdownDocumentation": "`Synonyms`\n\nOther names or aliases for the cell value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-cellvaluesynonym.html#cfn-quicksight-topic-cellvaluesynonym-synonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CellValue": { "MarkdownDocumentation": "`CellValue`\n\nThe cell value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-cellvaluesynonym.html#cfn-quicksight-topic-cellvaluesynonym-cellvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.CollectiveConstant": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.CollectiveConstant`\n\nA structure that represents a collective constant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-collectiveconstant.html", "Properties": { "ValueList": { "MarkdownDocumentation": "`ValueList`\n\nA list of values for the collective constant.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-collectiveconstant.html#cfn-quicksight-topic-collectiveconstant-valuelist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Topic.ComparativeOrder": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.ComparativeOrder`\n\nThe order in which data is displayed for the column when\nit's used in a comparative context.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-comparativeorder.html", "Properties": { "SpecifedOrder": { "MarkdownDocumentation": "`SpecifedOrder`\n\nThe list of columns to be used in the ordering.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-comparativeorder.html#cfn-quicksight-topic-comparativeorder-specifedorder", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UseOrdering": { "MarkdownDocumentation": "`UseOrdering`\n\nThe ordering type for a column. Valid values for this structure are `GREATER_IS_BETTER`, `LESSER_IS_BETTER` and `SPECIFIED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `GREATER_IS_BETTER | LESSER_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-comparativeorder.html#cfn-quicksight-topic-comparativeorder-useordering", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TreatUndefinedSpecifiedValues": { "MarkdownDocumentation": "`TreatUndefinedSpecifiedValues`\n\nThe treat of undefined specified values. Valid values for this structure are `LEAST` and `MOST`.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEAST | MOST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEAST", "MOST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-comparativeorder.html#cfn-quicksight-topic-comparativeorder-treatundefinedspecifiedvalues", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.CustomInstructions": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.CustomInstructions`\n\nThe `CustomInstructions` property type specifies Property description not available. for an [AWS::QuickSight::Topic](./aws-resource-quicksight-topic.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-custominstructions.html", "Properties": { "CustomInstructionsString": { "MarkdownDocumentation": "`CustomInstructionsString`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-custominstructions.html#cfn-quicksight-topic-custominstructions-custominstructionsstring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.DataAggregation": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.DataAggregation`\n\nThe definition of a data aggregation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-dataaggregation.html", "Properties": { "DatasetRowDateGranularity": { "MarkdownDocumentation": "`DatasetRowDateGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `SECOND | MINUTE | HOUR | DA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-dataaggregation.html#cfn-quicksight-topic-dataaggregation-datasetrowdategranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultDateColumnName": { "MarkdownDocumentation": "`DefaultDateColumnName`\n\nThe column name for the default date.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-dataaggregation.html#cfn-quicksight-topic-dataaggregation-defaultdatecolumnname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.DatasetMetadata": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.DatasetMetadata`\n\nA structure that represents a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html", "Properties": { "DatasetArn": { "MarkdownDocumentation": "`DatasetArn`\n\nThe Amazon Resource Name (ARN) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-datasetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe list of filter definitions.\n*Required*: No\n*Type*: Array of [TopicFilter](./aws-properties-quicksight-topic-topicfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-filters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TopicFilter", "DuplicatesAllowed": true }, "NamedEntities": { "MarkdownDocumentation": "`NamedEntities`\n\nThe list of named entities definitions.\n*Required*: No\n*Type*: Array of [TopicNamedEntity](./aws-properties-quicksight-topic-topicnamedentity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-namedentities", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TopicNamedEntity", "DuplicatesAllowed": true }, "DatasetName": { "MarkdownDocumentation": "`DatasetName`\n\nThe name of the dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-datasetname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CalculatedFields": { "MarkdownDocumentation": "`CalculatedFields`\n\nThe list of calculated field definitions.\n*Required*: No\n*Type*: Array of [TopicCalculatedField](./aws-properties-quicksight-topic-topiccalculatedfield.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-calculatedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TopicCalculatedField", "DuplicatesAllowed": true }, "Columns": { "MarkdownDocumentation": "`Columns`\n\nThe list of column definitions.\n*Required*: No\n*Type*: Array of [TopicColumn](./aws-properties-quicksight-topic-topiccolumn.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-columns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TopicColumn", "DuplicatesAllowed": true }, "DataAggregation": { "MarkdownDocumentation": "`DataAggregation`\n\nThe definition of a data aggregation.\n*Required*: No\n*Type*: [DataAggregation](./aws-properties-quicksight-topic-dataaggregation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-dataaggregation", "UpdateType": "Mutable", "Required": false, "Type": "DataAggregation" }, "DatasetDescription": { "MarkdownDocumentation": "`DatasetDescription`\n\nThe description of the dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.html#cfn-quicksight-topic-datasetmetadata-datasetdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.DefaultFormatting": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.DefaultFormatting`\n\nA structure that represents a default formatting definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-defaultformatting.html", "Properties": { "DisplayFormatOptions": { "MarkdownDocumentation": "`DisplayFormatOptions`\n\nThe additional options for display formatting.\n*Required*: No\n*Type*: [DisplayFormatOptions](./aws-properties-quicksight-topic-displayformatoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-defaultformatting.html#cfn-quicksight-topic-defaultformatting-displayformatoptions", "UpdateType": "Mutable", "Required": false, "Type": "DisplayFormatOptions" }, "DisplayFormat": { "MarkdownDocumentation": "`DisplayFormat`\n\nThe display format. Valid values for this structure are `AUTO`,\n`PERCENT`, `CURRENCY`, `NUMBER`, `DATE`, and\n`STRING`.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTO | PERCENT | CURRENCY |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-defaultformatting.html#cfn-quicksight-topic-defaultformatting-displayformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.DisplayFormatOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.DisplayFormatOptions`\n\nA structure that represents additional options for display formatting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html", "Properties": { "DecimalSeparator": { "MarkdownDocumentation": "`DecimalSeparator`\n\nDetermines the decimal separator.\n*Required*: No\n*Type*: String\n*Allowed values*: `COMMA | DOT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMMA", "DOT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-decimalseparator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FractionDigits": { "MarkdownDocumentation": "`FractionDigits`\n\nDetermines the number of fraction digits.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-fractiondigits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nThe suffix value for a display format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DateFormat": { "MarkdownDocumentation": "`DateFormat`\n\nDetermines the `DateTime` format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-dateformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UnitScaler": { "MarkdownDocumentation": "`UnitScaler`\n\nThe unit scaler. Valid values for this structure are: `NONE`,\n`AUTO`, `THOUSANDS`, `MILLIONS`,\n`BILLIONS`,\nand `TRILLIONS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AUTO | THOUSANDS | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-unitscaler", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NegativeFormat": { "MarkdownDocumentation": "`NegativeFormat`\n\nThe negative format.\n*Required*: No\n*Type*: [NegativeFormat](./aws-properties-quicksight-topic-negativeformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-negativeformat", "UpdateType": "Mutable", "Required": false, "Type": "NegativeFormat" }, "UseBlankCellFormat": { "MarkdownDocumentation": "`UseBlankCellFormat`\n\nA Boolean value that indicates whether to use blank cell 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-useblankcellformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe prefix value for a display format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlankCellFormat": { "MarkdownDocumentation": "`BlankCellFormat`\n\nDetermines the blank cell format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-blankcellformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CurrencySymbol": { "MarkdownDocumentation": "`CurrencySymbol`\n\nThe currency symbol, such as `USD`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-currencysymbol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GroupingSeparator": { "MarkdownDocumentation": "`GroupingSeparator`\n\nDetermines the grouping separator.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-groupingseparator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UseGrouping": { "MarkdownDocumentation": "`UseGrouping`\n\nA Boolean value that indicates whether to use grouping.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-displayformatoptions.html#cfn-quicksight-topic-displayformatoptions-usegrouping", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Topic.NamedEntityDefinition": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.NamedEntityDefinition`\n\nA structure that represents a named entity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html", "Properties": { "PropertyName": { "MarkdownDocumentation": "`PropertyName`\n\nThe property name to be used for the named entity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyUsage": { "MarkdownDocumentation": "`PropertyUsage`\n\nThe property usage. Valid values for this structure are `INHERIT`,\n`DIMENSION`,\nand `MEASURE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `INHERIT | DIMENSION | MEASU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INHERIT", "DIMENSION", "MEASURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyusage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropertyRole": { "MarkdownDocumentation": "`PropertyRole`\n\nThe property role. Valid values for this structure are `PRIMARY` and `ID`.\n*Required*: No\n*Type*: String\n*Allowed values*: `PRIMARY | ID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY", "ID" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nThe definition of a metric.\n*Required*: No\n*Type*: [NamedEntityDefinitionMetric](./aws-properties-quicksight-topic-namedentitydefinitionmetric.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-metric", "UpdateType": "Mutable", "Required": false, "Type": "NamedEntityDefinitionMetric" }, "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the entity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-fieldname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.NamedEntityDefinitionMetric": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.NamedEntityDefinitionMetric`\n\nA structure that represents a metric.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinitionmetric.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nThe aggregation of a named entity. Valid values for this structure are `SUM`,\n`MIN`, `MAX`, `COUNT`, `AVERAGE`,\n`DISTINCT_COUNT`, `STDEV`, `STDEVP`, `VAR`,\n`VARP`, `PERCENTILE`,\n`MEDIAN`,\nand `CUSTOM`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUM | MIN | MAX | COUNT | A...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinitionmetric.html#cfn-quicksight-topic-namedentitydefinitionmetric-aggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AggregationFunctionParameters": { "MarkdownDocumentation": "`AggregationFunctionParameters`\n\nThe additional parameters for an aggregation function.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinitionmetric.html#cfn-quicksight-topic-namedentitydefinitionmetric-aggregationfunctionparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } } }, "AWS::QuickSight::Topic.NegativeFormat": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.NegativeFormat`\n\nA structure that represents a negative format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-negativeformat.html", "Properties": { "Suffix": { "MarkdownDocumentation": "`Suffix`\n\nThe suffix for a negative format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-negativeformat.html#cfn-quicksight-topic-negativeformat-suffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe prefix for a negative format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-negativeformat.html#cfn-quicksight-topic-negativeformat-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.RangeConstant": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.RangeConstant`\n\nThe value of the constant that is used to specify the endpoints of a range filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-rangeconstant.html", "Properties": { "Minimum": { "MarkdownDocumentation": "`Minimum`\n\nThe minimum value for a range constant.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-rangeconstant.html#cfn-quicksight-topic-rangeconstant-minimum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Maximum": { "MarkdownDocumentation": "`Maximum`\n\nThe maximum value for a range constant.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-rangeconstant.html#cfn-quicksight-topic-rangeconstant-maximum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.SemanticEntityType": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.SemanticEntityType`\n\nA structure that represents a semantic entity type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semanticentitytype.html", "Properties": { "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe semantic entity type name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semanticentitytype.html#cfn-quicksight-topic-semanticentitytype-typename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeParameters": { "MarkdownDocumentation": "`TypeParameters`\n\nThe semantic entity type parameters.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semanticentitytype.html#cfn-quicksight-topic-semanticentitytype-typeparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "SubTypeName": { "MarkdownDocumentation": "`SubTypeName`\n\nThe semantic entity sub type name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semanticentitytype.html#cfn-quicksight-topic-semanticentitytype-subtypename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.SemanticType": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.SemanticType`\n\nA structure that represents a semantic type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html", "Properties": { "TruthyCellValueSynonyms": { "MarkdownDocumentation": "`TruthyCellValueSynonyms`\n\nThe other names or aliases for the true cell value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-truthycellvaluesynonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe semantic type name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-typename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeParameters": { "MarkdownDocumentation": "`TypeParameters`\n\nThe semantic type parameters.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-typeparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "SubTypeName": { "MarkdownDocumentation": "`SubTypeName`\n\nThe semantic type sub type name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-subtypename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TruthyCellValue": { "MarkdownDocumentation": "`TruthyCellValue`\n\nThe semantic type truthy cell 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-truthycellvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FalseyCellValue": { "MarkdownDocumentation": "`FalseyCellValue`\n\nThe semantic type falsey cell 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-falseycellvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FalseyCellValueSynonyms": { "MarkdownDocumentation": "`FalseyCellValueSynonyms`\n\nThe other names or aliases for the false cell value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-semantictype.html#cfn-quicksight-topic-semantictype-falseycellvaluesynonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Topic.TopicCalculatedField": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicCalculatedField`\n\nA structure that represents a calculated field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html", "Properties": { "SemanticType": { "MarkdownDocumentation": "`SemanticType`\n\nThe semantic type.\n*Required*: No\n*Type*: [SemanticType](./aws-properties-quicksight-topic-semantictype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-semantictype", "UpdateType": "Mutable", "Required": false, "Type": "SemanticType" }, "NotAllowedAggregations": { "MarkdownDocumentation": "`NotAllowedAggregations`\n\nThe list of aggregation types that are not allowed for the calculated field. Valid\nvalues for this structure are `COUNT`, `DISTINCT_COUNT`,\n`MIN`, `MAX`, `MEDIAN`, `SUM`,\n`AVERAGE`, `STDEV`, `STDEVP`, `VAR`,\n`VARP`, and `PERCENTILE`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-notallowedaggregations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DefaultFormatting": { "MarkdownDocumentation": "`DefaultFormatting`\n\nThe default formatting definition.\n*Required*: No\n*Type*: [DefaultFormatting](./aws-properties-quicksight-topic-defaultformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-defaultformatting", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFormatting" }, "AllowedAggregations": { "MarkdownDocumentation": "`AllowedAggregations`\n\nThe list of aggregation types that are allowed for the calculated field. Valid values\nfor this structure are `COUNT`, `DISTINCT_COUNT`, `MIN`,\n`MAX`, `MEDIAN`, `SUM`, `AVERAGE`,\n`STDEV`, `STDEVP`, `VAR`,\n`VARP`, and `PERCENTILE`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-allowedaggregations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CalculatedFieldDescription": { "MarkdownDocumentation": "`CalculatedFieldDescription`\n\nThe calculated field description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfielddescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CalculatedFieldSynonyms": { "MarkdownDocumentation": "`CalculatedFieldSynonyms`\n\nThe other names or aliases for the calculated field.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfieldsynonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IsIncludedInTopic": { "MarkdownDocumentation": "`IsIncludedInTopic`\n\nA boolean value that indicates if a calculated field is included in the topic.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-isincludedintopic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ColumnDataRole": { "MarkdownDocumentation": "`ColumnDataRole`\n\nThe column data role for a calculated field. Valid values for this structure are `DIMENSION` and `MEASURE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `DIMENSION | MEASURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIMENSION", "MEASURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-columndatarole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nThe default aggregation. Valid values for this structure are `SUM`,\n`MAX`, `MIN`, `COUNT`,\n`DISTINCT_COUNT`,\nand `AVERAGE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUM | MAX | MIN | COUNT | D...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE", "MEDIAN", "STDEV", "STDEVP", "VAR", "VARP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-aggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nThe calculated field expression.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NonAdditive": { "MarkdownDocumentation": "`NonAdditive`\n\nThe non additive for the table style 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-nonadditive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CalculatedFieldName": { "MarkdownDocumentation": "`CalculatedFieldName`\n\nThe calculated field name.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NeverAggregateInFilter": { "MarkdownDocumentation": "`NeverAggregateInFilter`\n\nA Boolean value that indicates whether to never aggregate calculated field in filters.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-neveraggregateinfilter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `SECOND | MINUTE | HOUR | DA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisableIndexing": { "MarkdownDocumentation": "`DisableIndexing`\n\nA Boolean value that indicates if a calculated field is visible in the autocomplete.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-disableindexing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ComparativeOrder": { "MarkdownDocumentation": "`ComparativeOrder`\n\nThe order in which data is displayed for the calculated field when\nit's used in a comparative context.\n*Required*: No\n*Type*: [ComparativeOrder](./aws-properties-quicksight-topic-comparativeorder.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-comparativeorder", "UpdateType": "Mutable", "Required": false, "Type": "ComparativeOrder" }, "CellValueSynonyms": { "MarkdownDocumentation": "`CellValueSynonyms`\n\nThe other\nnames or aliases for the calculated field cell value.\n*Required*: No\n*Type*: Array of [CellValueSynonym](./aws-properties-quicksight-topic-cellvaluesynonym.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-cellvaluesynonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CellValueSynonym", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Topic.TopicCategoryFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicCategoryFilter`\n\nA structure that represents a category filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html", "Properties": { "CategoryFilterType": { "MarkdownDocumentation": "`CategoryFilterType`\n\nThe category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.\n*Required*: No\n*Type*: String\n*Allowed values*: `CUSTOM_FILTER | CUSTOM_FILT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CUSTOM_FILTER", "CUSTOM_FILTER_LIST", "FILTER_LIST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-categoryfiltertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CategoryFilterFunction": { "MarkdownDocumentation": "`CategoryFilterFunction`\n\nThe category filter function. Valid values for this structure are `EXACT` and `CONTAINS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `EXACT | CONTAINS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXACT", "CONTAINS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-categoryfilterfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Constant": { "MarkdownDocumentation": "`Constant`\n\nThe constant used in a category filter.\n*Required*: No\n*Type*: [TopicCategoryFilterConstant](./aws-properties-quicksight-topic-topiccategoryfilterconstant.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-constant", "UpdateType": "Mutable", "Required": false, "Type": "TopicCategoryFilterConstant" }, "Inverse": { "MarkdownDocumentation": "`Inverse`\n\nA Boolean value that indicates if the filter is inverse.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-inverse", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Topic.TopicCategoryFilterConstant": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicCategoryFilterConstant`\n\nA constant used in a category filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilterconstant.html", "Properties": { "SingularConstant": { "MarkdownDocumentation": "`SingularConstant`\n\nA singular constant used in a category filter. This element is used to specify a single value for the constant.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilterconstant.html#cfn-quicksight-topic-topiccategoryfilterconstant-singularconstant", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConstantType": { "MarkdownDocumentation": "`ConstantType`\n\nThe type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are `SINGULAR` and `COLLECTIVE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGULAR | RANGE | COLLECTI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGULAR", "RANGE", "COLLECTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilterconstant.html#cfn-quicksight-topic-topiccategoryfilterconstant-constanttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CollectiveConstant": { "MarkdownDocumentation": "`CollectiveConstant`\n\nA collective constant used in a category filter. This element is used to specify a list of values for the constant.\n*Required*: No\n*Type*: [CollectiveConstant](./aws-properties-quicksight-topic-collectiveconstant.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilterconstant.html#cfn-quicksight-topic-topiccategoryfilterconstant-collectiveconstant", "UpdateType": "Mutable", "Required": false, "Type": "CollectiveConstant" } } }, "AWS::QuickSight::Topic.TopicColumn": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicColumn`\n\nRepresents a column in a dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html", "Properties": { "SemanticType": { "MarkdownDocumentation": "`SemanticType`\n\nThe semantic type of data contained in the column.\n*Required*: No\n*Type*: [SemanticType](./aws-properties-quicksight-topic-semantictype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-semantictype", "UpdateType": "Mutable", "Required": false, "Type": "SemanticType" }, "NotAllowedAggregations": { "MarkdownDocumentation": "`NotAllowedAggregations`\n\nThe list of aggregation types that are not allowed for the column. Valid values for this\nstructure are `COUNT`, `DISTINCT_COUNT`, `MIN`,\n`MAX`, `MEDIAN`, `SUM`, `AVERAGE`,\n`STDEV`, `STDEVP`, `VAR`,\n`VARP`,\nand `PERCENTILE`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-notallowedaggregations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedAggregations": { "MarkdownDocumentation": "`AllowedAggregations`\n\nThe list of aggregation types that are allowed for the column. Valid values for this\nstructure are `COUNT`, `DISTINCT_COUNT`, `MIN`,\n`MAX`, `MEDIAN`, `SUM`, `AVERAGE`,\n`STDEV`, `STDEVP`, `VAR`,\n`VARP`,\nand `PERCENTILE`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-allowedaggregations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DefaultFormatting": { "MarkdownDocumentation": "`DefaultFormatting`\n\nThe default formatting used for values in the column.\n*Required*: No\n*Type*: [DefaultFormatting](./aws-properties-quicksight-topic-defaultformatting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-defaultformatting", "UpdateType": "Mutable", "Required": false, "Type": "DefaultFormatting" }, "ColumnDescription": { "MarkdownDocumentation": "`ColumnDescription`\n\nA description of the column and its contents.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columndescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IsIncludedInTopic": { "MarkdownDocumentation": "`IsIncludedInTopic`\n\nA Boolean value that indicates whether the column is included in the query results.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-isincludedintopic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ColumnDataRole": { "MarkdownDocumentation": "`ColumnDataRole`\n\nThe role of the column in the data. Valid values are `DIMENSION` and `MEASURE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `DIMENSION | MEASURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIMENSION", "MEASURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columndatarole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nThe type of aggregation that is performed on the column data when\nit's queried.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUM | MAX | MIN | COUNT | D...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE", "MEDIAN", "STDEV", "STDEVP", "VAR", "VARP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-aggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnName": { "MarkdownDocumentation": "`ColumnName`\n\nThe name of the column.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NonAdditive": { "MarkdownDocumentation": "`NonAdditive`\n\nThe non additive value for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-nonadditive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ColumnSynonyms": { "MarkdownDocumentation": "`ColumnSynonyms`\n\nThe other names or aliases for the column.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnsynonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NeverAggregateInFilter": { "MarkdownDocumentation": "`NeverAggregateInFilter`\n\nA Boolean\nvalue that indicates whether to aggregate the column data when\nit's used in a filter context.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-neveraggregateinfilter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `SECOND | MINUTE | HOUR | DA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnFriendlyName": { "MarkdownDocumentation": "`ColumnFriendlyName`\n\nA user-friendly name for the column.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnfriendlyname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisableIndexing": { "MarkdownDocumentation": "`DisableIndexing`\n\nA Boolean value that indicates whether the column shows in the autocomplete functionality.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-disableindexing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ComparativeOrder": { "MarkdownDocumentation": "`ComparativeOrder`\n\nThe order in which data is displayed for the column when\nit's used in a comparative context.\n*Required*: No\n*Type*: [ComparativeOrder](./aws-properties-quicksight-topic-comparativeorder.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-comparativeorder", "UpdateType": "Mutable", "Required": false, "Type": "ComparativeOrder" }, "CellValueSynonyms": { "MarkdownDocumentation": "`CellValueSynonyms`\n\nThe other names or aliases for the column cell value.\n*Required*: No\n*Type*: Array of [CellValueSynonym](./aws-properties-quicksight-topic-cellvaluesynonym.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-cellvaluesynonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CellValueSynonym", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Topic.TopicConfigOptions": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicConfigOptions`\n\nConfiguration options for a `Topic`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicconfigoptions.html", "Properties": { "QBusinessInsightsEnabled": { "MarkdownDocumentation": "`QBusinessInsightsEnabled`\n\nEnables Amazon Q Business Insights for a `Topic`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicconfigoptions.html#cfn-quicksight-topic-topicconfigoptions-qbusinessinsightsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::QuickSight::Topic.TopicDateRangeFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicDateRangeFilter`\n\nA filter used to restrict data based on a range of dates or times.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicdaterangefilter.html", "Properties": { "Inclusive": { "MarkdownDocumentation": "`Inclusive`\n\nA Boolean value that indicates whether the date range filter should include the boundary values. If\nset to true, the filter includes the start and end dates. If set to false, the filter\nexcludes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicdaterangefilter.html#cfn-quicksight-topic-topicdaterangefilter-inclusive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Constant": { "MarkdownDocumentation": "`Constant`\n\nThe constant used in a date range filter.\n*Required*: No\n*Type*: [TopicRangeFilterConstant](./aws-properties-quicksight-topic-topicrangefilterconstant.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicdaterangefilter.html#cfn-quicksight-topic-topicdaterangefilter-constant", "UpdateType": "Mutable", "Required": false, "Type": "TopicRangeFilterConstant" } } }, "AWS::QuickSight::Topic.TopicFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicFilter`\n\nA structure that represents a filter used to select items for a topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html", "Properties": { "FilterClass": { "MarkdownDocumentation": "`FilterClass`\n\nThe class of the filter. Valid values for this structure are\n`ENFORCED_VALUE_FILTER`,\n`CONDITIONAL_VALUE_FILTER`,\nand `NAMED_VALUE_FILTER`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENFORCED_VALUE_FILTER | CON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filterclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FilterSynonyms": { "MarkdownDocumentation": "`FilterSynonyms`\n\nThe other names or aliases for the filter.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtersynonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "FilterType": { "MarkdownDocumentation": "`FilterType`\n\nThe type of the filter. Valid values for this structure are\n`CATEGORY_FILTER`, `NUMERIC_EQUALITY_FILTER`,\n`NUMERIC_RANGE_FILTER`,\n`DATE_RANGE_FILTER`,\nand `RELATIVE_DATE_FILTER`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CATEGORY_FILTER | NUMERIC_E...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RelativeDateFilter": { "MarkdownDocumentation": "`RelativeDateFilter`\n\nThe relative date filter.\n*Required*: No\n*Type*: [TopicRelativeDateFilter](./aws-properties-quicksight-topic-topicrelativedatefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-relativedatefilter", "UpdateType": "Mutable", "Required": false, "Type": "TopicRelativeDateFilter" }, "OperandFieldName": { "MarkdownDocumentation": "`OperandFieldName`\n\nThe name of the field that the filter operates on.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-operandfieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NumericEqualityFilter": { "MarkdownDocumentation": "`NumericEqualityFilter`\n\nThe numeric equality filter.\n*Required*: No\n*Type*: [TopicNumericEqualityFilter](./aws-properties-quicksight-topic-topicnumericequalityfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-numericequalityfilter", "UpdateType": "Mutable", "Required": false, "Type": "TopicNumericEqualityFilter" }, "FilterDescription": { "MarkdownDocumentation": "`FilterDescription`\n\nA description of the filter used to select items for a topic.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filterdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumericRangeFilter": { "MarkdownDocumentation": "`NumericRangeFilter`\n\nThe numeric range filter.\n*Required*: No\n*Type*: [TopicNumericRangeFilter](./aws-properties-quicksight-topic-topicnumericrangefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-numericrangefilter", "UpdateType": "Mutable", "Required": false, "Type": "TopicNumericRangeFilter" }, "DateRangeFilter": { "MarkdownDocumentation": "`DateRangeFilter`\n\nThe date range filter.\n*Required*: No\n*Type*: [TopicDateRangeFilter](./aws-properties-quicksight-topic-topicdaterangefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-daterangefilter", "UpdateType": "Mutable", "Required": false, "Type": "TopicDateRangeFilter" }, "FilterName": { "MarkdownDocumentation": "`FilterName`\n\nThe name of the filter.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-filtername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CategoryFilter": { "MarkdownDocumentation": "`CategoryFilter`\n\nThe category filter that is associated with this filter.\n*Required*: No\n*Type*: [TopicCategoryFilter](./aws-properties-quicksight-topic-topiccategoryfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicfilter.html#cfn-quicksight-topic-topicfilter-categoryfilter", "UpdateType": "Mutable", "Required": false, "Type": "TopicCategoryFilter" } } }, "AWS::QuickSight::Topic.TopicNamedEntity": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicNamedEntity`\n\nA structure that represents a named entity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html", "Properties": { "EntitySynonyms": { "MarkdownDocumentation": "`EntitySynonyms`\n\nThe other\nnames or aliases for the named entity.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitysynonyms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EntityName": { "MarkdownDocumentation": "`EntityName`\n\nThe name of the named entity.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entityname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SemanticEntityType": { "MarkdownDocumentation": "`SemanticEntityType`\n\nThe type of named entity that a topic represents.\n*Required*: No\n*Type*: [SemanticEntityType](./aws-properties-quicksight-topic-semanticentitytype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-semanticentitytype", "UpdateType": "Mutable", "Required": false, "Type": "SemanticEntityType" }, "EntityDescription": { "MarkdownDocumentation": "`EntityDescription`\n\nThe description of the named entity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitydescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe definition of a named entity.\n*Required*: No\n*Type*: Array of [NamedEntityDefinition](./aws-properties-quicksight-topic-namedentitydefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-definition", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NamedEntityDefinition", "DuplicatesAllowed": true } } }, "AWS::QuickSight::Topic.TopicNumericEqualityFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicNumericEqualityFilter`\n\nA filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericequalityfilter.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nAn aggregation function that specifies how to calculate the value of a numeric field for\na topic. Valid values for this structure are `NO_AGGREGATION`, `SUM`,\n`AVERAGE`, `COUNT`, `DISTINCT_COUNT`, `MAX`,\n`MEDIAN`, `MIN`, `STDEV`, `STDEVP`,\n`VAR`,\nand `VARP`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NO_AGGREGATION | SUM | AVER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", "VARP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericequalityfilter.html#cfn-quicksight-topic-topicnumericequalityfilter-aggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Constant": { "MarkdownDocumentation": "`Constant`\n\nThe constant used in a numeric equality filter.\n*Required*: No\n*Type*: [TopicSingularFilterConstant](./aws-properties-quicksight-topic-topicsingularfilterconstant.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericequalityfilter.html#cfn-quicksight-topic-topicnumericequalityfilter-constant", "UpdateType": "Mutable", "Required": false, "Type": "TopicSingularFilterConstant" } } }, "AWS::QuickSight::Topic.TopicNumericRangeFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicNumericRangeFilter`\n\nA filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericrangefilter.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nAn aggregation function that specifies how to calculate the value of a numeric field for\na topic, Valid values for this structure are `NO_AGGREGATION`, `SUM`,\n`AVERAGE`, `COUNT`, `DISTINCT_COUNT`, `MAX`,\n`MEDIAN`, `MIN`, `STDEV`, `STDEVP`,\n`VAR`,\nand `VARP`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NO_AGGREGATION | SUM | AVER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", "VARP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericrangefilter.html#cfn-quicksight-topic-topicnumericrangefilter-aggregation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inclusive": { "MarkdownDocumentation": "`Inclusive`\n\nA Boolean value that indicates whether the endpoints of the numeric range are included in the filter.\nIf set to true, topics whose numeric field value is equal to the endpoint values will be\nincluded in the filter. If set to false, topics whose numeric field value is equal to the\nendpoint values will be excluded from the filter.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericrangefilter.html#cfn-quicksight-topic-topicnumericrangefilter-inclusive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Constant": { "MarkdownDocumentation": "`Constant`\n\nThe constant used in a\nnumeric range filter.\n*Required*: No\n*Type*: [TopicRangeFilterConstant](./aws-properties-quicksight-topic-topicrangefilterconstant.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnumericrangefilter.html#cfn-quicksight-topic-topicnumericrangefilter-constant", "UpdateType": "Mutable", "Required": false, "Type": "TopicRangeFilterConstant" } } }, "AWS::QuickSight::Topic.TopicRangeFilterConstant": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicRangeFilterConstant`\n\nA constant value that is used in a range filter to specify the endpoints of the range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrangefilterconstant.html", "Properties": { "ConstantType": { "MarkdownDocumentation": "`ConstantType`\n\nThe data type of the constant value that is used in a range filter. Valid values for this structure are `RANGE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGULAR | RANGE | COLLECTI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGULAR", "RANGE", "COLLECTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrangefilterconstant.html#cfn-quicksight-topic-topicrangefilterconstant-constanttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RangeConstant": { "MarkdownDocumentation": "`RangeConstant`\n\nThe value of the constant that is used to specify the endpoints of a range filter.\n*Required*: No\n*Type*: [RangeConstant](./aws-properties-quicksight-topic-rangeconstant.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrangefilterconstant.html#cfn-quicksight-topic-topicrangefilterconstant-rangeconstant", "UpdateType": "Mutable", "Required": false, "Type": "RangeConstant" } } }, "AWS::QuickSight::Topic.TopicRelativeDateFilter": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicRelativeDateFilter`\n\nA structure that represents a relative date filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrelativedatefilter.html", "Properties": { "RelativeDateFilterFunction": { "MarkdownDocumentation": "`RelativeDateFilterFunction`\n\nThe function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are `BEFORE`, `AFTER`, and `BETWEEN`.\n*Required*: No\n*Type*: String\n*Allowed values*: `PREVIOUS | THIS | LAST | NE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PREVIOUS", "THIS", "LAST", "NEXT", "NOW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrelativedatefilter.html#cfn-quicksight-topic-topicrelativedatefilter-relativedatefilterfunction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Constant": { "MarkdownDocumentation": "`Constant`\n\nThe constant used in a\nrelative date filter.\n*Required*: No\n*Type*: [TopicSingularFilterConstant](./aws-properties-quicksight-topic-topicsingularfilterconstant.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrelativedatefilter.html#cfn-quicksight-topic-topicrelativedatefilter-constant", "UpdateType": "Mutable", "Required": false, "Type": "TopicSingularFilterConstant" }, "TimeGranularity": { "MarkdownDocumentation": "`TimeGranularity`\n\nThe level of time precision that is used to aggregate `DateTime` values.\n*Required*: No\n*Type*: String\n*Allowed values*: `SECOND | MINUTE | HOUR | DA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicrelativedatefilter.html#cfn-quicksight-topic-topicrelativedatefilter-timegranularity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::Topic.TopicSingularFilterConstant": { "MarkdownDocumentation": "`AWS::QuickSight::Topic.TopicSingularFilterConstant`\n\nA structure that represents a singular filter constant, used in filters to specify a single value to match against.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicsingularfilterconstant.html", "Properties": { "SingularConstant": { "MarkdownDocumentation": "`SingularConstant`\n\nThe value of the singular filter constant.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicsingularfilterconstant.html#cfn-quicksight-topic-topicsingularfilterconstant-singularconstant", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConstantType": { "MarkdownDocumentation": "`ConstantType`\n\nThe type of the singular filter constant. Valid values for this structure are `SINGULAR`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGULAR | RANGE | COLLECTI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGULAR", "RANGE", "COLLECTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicsingularfilterconstant.html#cfn-quicksight-topic-topicsingularfilterconstant-constanttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::QuickSight::VPCConnection.NetworkInterface": { "MarkdownDocumentation": "`AWS::QuickSight::VPCConnection.NetworkInterface`\n\nThe structure that contains information about a network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-vpcconnection-networkinterface.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the network interface.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATING | AVAILABLE | CREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATING", "AVAILABLE", "CREATION_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED", "DELETION_FAILED", "DELETION_SCHEDULED", "ATTACHMENT_FAILED_ROLLBACK_FAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-vpcconnection-networkinterface.html#cfn-quicksight-vpcconnection-networkinterface-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe availability zone that the network interface resides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-vpcconnection-networkinterface.html#cfn-quicksight-vpcconnection-networkinterface-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe subnet ID associated with the network interface.\n*Required*: No\n*Type*: String\n*Pattern*: `^subnet-[0-9a-z]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-vpcconnection-networkinterface.html#cfn-quicksight-vpcconnection-networkinterface-subnetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ErrorMessage": { "MarkdownDocumentation": "`ErrorMessage`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-vpcconnection-networkinterface.html#cfn-quicksight-vpcconnection-networkinterface-errormessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe network interface ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^eni-[0-9a-z]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-vpcconnection-networkinterface.html#cfn-quicksight-vpcconnection-networkinterface-networkinterfaceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBCluster.DBClusterRole": { "MarkdownDocumentation": "`AWS::RDS::DBCluster.DBClusterRole`\n\nDescribes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html", "Properties": { "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FeatureName": { "MarkdownDocumentation": "`FeatureName`\n\nThe name of the feature associated with the AWS Identity and Access Management (IAM)\nrole. IAM roles that are associated with a DB cluster grant permission for the DB\ncluster to access other AWS services on your behalf. For the list of supported feature\nnames, see the `SupportedFeatureNames` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-featurename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBCluster.Endpoint": { "MarkdownDocumentation": "`AWS::RDS::DBCluster.Endpoint`\n\nThe `Endpoint` return value specifies the connection endpoint for the primary instance of the DB cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html#cfn-rds-dbcluster-endpoint-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html#cfn-rds-dbcluster-endpoint-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBCluster.MasterUserSecret": { "MarkdownDocumentation": "`AWS::RDS::DBCluster.MasterUserSecret`\n\nThe `MasterUserSecret` return value specifies 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)\nin the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)\nin the *Amazon Aurora User Guide.*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the `Fn::GetAtt`\nintrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBCluster.ReadEndpoint": { "MarkdownDocumentation": "`AWS::RDS::DBCluster.ReadEndpoint`\n\nThe `ReadEndpoint` return value specifies the reader endpoint for the DB cluster.\nThe reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster.\nAs clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas\nin the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.\nIf a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection\nis dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the\nreader endpoint.\nFor more information about Aurora endpoints, see [Amazon Aurora connection management](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html)\nin the *Amazon Aurora User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html#cfn-rds-dbcluster-readendpoint-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBCluster.ScalingConfiguration": { "MarkdownDocumentation": "`AWS::RDS::DBCluster.ScalingConfiguration`\n\nThe `ScalingConfiguration` property type specifies the scaling\nconfiguration of an Aurora Serverless v1 DB cluster.\nFor more information, see [Using Amazon Aurora\nServerless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*.\nThis property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the `ServerlessV2ScalingConfiguration` property.\nValid for: Aurora Serverless v1 DB clusters only\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html", "Properties": { "TimeoutAction": { "MarkdownDocumentation": "`TimeoutAction`\n\nThe 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.\n###### Important\nIf you specify `ForceApplyCapacityChange`, connections that\nprevent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-timeoutaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecondsBeforeTimeout": { "MarkdownDocumentation": "`SecondsBeforeTimeout`\n\nThe amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsbeforetimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SecondsUntilAutoPause": { "MarkdownDocumentation": "`SecondsUntilAutoPause`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsuntilautopause", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AutoPause": { "MarkdownDocumentation": "`AutoPause`\n\nIndicates whether to allow or disallow automatic pause for an Aurora DB cluster in `serverless` DB engine mode.\nA DB cluster can be paused only when it's idle (it has no connections).\n###### Note\nIf a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\nIn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-autopause", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MinCapacity": { "MarkdownDocumentation": "`MinCapacity`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration": { "MarkdownDocumentation": "`AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration`\n\nThe `ServerlessV2ScalingConfiguration` property type specifies the scaling\nconfiguration of an Aurora Serverless V2 DB cluster. For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User\nGuide*.\nIf you have an Aurora cluster, you must set this attribute before you add a DB instance\nthat uses the `db.serverless` DB instance class. For more information, see\n[Clusters that use Aurora Serverless v2 must have a capacity range specified](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html#aurora-serverless-v2.requirements.capacity-range) in\nthe *Amazon Aurora User Guide*.\nThis property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use the `ScalingConfiguration` property.\nValid for: Aurora Serverless v2 DB clusters\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html", "Properties": { "SecondsUntilAutoPause": { "MarkdownDocumentation": "`SecondsUntilAutoPause`\n\nSpecifies the number of seconds an Aurora Serverless v2 DB instance must be idle before\nAurora attempts to automatically pause it.\nSpecify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-secondsuntilautopause", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinCapacity": { "MarkdownDocumentation": "`MinCapacity`\n\nThe minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\nYou can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on.\nFor Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0.\nFor versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-mincapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\nYou can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\nthat 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\n*Amazon Aurora User Guide*.\nAurora automatically sets certain parameters for Aurora Serverless V2 DB instances to\nvalues that depend on the maximum ACU value in the capacity range. When you update the\nmaximum capacity value, the `ParameterApplyStatus` value for the DB instance\nchanges to `pending-reboot`. You can update the parameter values by rebooting\nthe DB instance after changing the capacity range.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-maxcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::RDS::DBInstance.CertificateDetails": { "MarkdownDocumentation": "`AWS::RDS::DBInstance.CertificateDetails`\n\nThe details of the DB instance\u2019s server certificate.\nFor more information, see [Using SSL/TLS to encrypt a connection to a DB\ninstance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and\n[Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora\nUser Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html", "Properties": { "ValidTill": { "MarkdownDocumentation": "`ValidTill`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html#cfn-rds-dbinstance-certificatedetails-validtill", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CAIdentifier": { "MarkdownDocumentation": "`CAIdentifier`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html#cfn-rds-dbinstance-certificatedetails-caidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBInstance.DBInstanceRole": { "MarkdownDocumentation": "`AWS::RDS::DBInstance.DBInstanceRole`\n\nInformation about an AWS Identity and Access Management (IAM) role that is associated with a DB instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html", "Properties": { "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that is associated with the DB\ninstance.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html#cfn-rds-dbinstance-dbinstancerole-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FeatureName": { "MarkdownDocumentation": "`FeatureName`\n\nThe name of the feature associated with the AWS Identity and Access Management (IAM)\nrole. IAM roles that are associated with a DB instance grant permission for the DB\ninstance to access other AWS services on your behalf. For the list of supported feature\nnames, see the `SupportedFeatureNames` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html#cfn-rds-dbinstance-dbinstancerole-featurename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::RDS::DBInstance.DBInstanceStatusInfo": { "MarkdownDocumentation": "`AWS::RDS::DBInstance.DBInstanceStatusInfo`\n\nProvides a list of status information for a DB instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancestatusinfo.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the DB instance. For a StatusType of read replica, the values can be\nreplicating, replication stop point set, replication stop point reached, error, stopped,\nor terminated.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancestatusinfo.html#cfn-rds-dbinstance-dbinstancestatusinfo-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nDetails of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancestatusinfo.html#cfn-rds-dbinstance-dbinstancestatusinfo-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusType": { "MarkdownDocumentation": "`StatusType`\n\nThis value is currently \"read replication.\"\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancestatusinfo.html#cfn-rds-dbinstance-dbinstancestatusinfo-statustype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Normal": { "MarkdownDocumentation": "`Normal`\n\nIndicates whether the instance is operating normally (TRUE) or is in an error state (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancestatusinfo.html#cfn-rds-dbinstance-dbinstancestatusinfo-normal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::RDS::DBInstance.Endpoint": { "MarkdownDocumentation": "`AWS::RDS::DBInstance.Endpoint`\n\nThis data type represents the information you need to connect to an Amazon RDS DB instance.\nThis data type is used as a response element in the following actions:\n* `CreateDBInstance`\n* `DescribeDBInstances`\n* `DeleteDBInstance`\nFor the data structure that represents Amazon Aurora DB cluster endpoints,\nsee `DBClusterEndpoint`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-hostedzoneid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBInstance.MasterUserSecret": { "MarkdownDocumentation": "`AWS::RDS::DBInstance.MasterUserSecret`\n\nThe `MasterUserSecret` return value specifies 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)\nin the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)\nin the *Amazon Aurora User Guide.*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the `Fn::GetAtt`\nintrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html#cfn-rds-dbinstance-masterusersecret-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html#cfn-rds-dbinstance-masterusersecret-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBInstance.ProcessorFeature": { "MarkdownDocumentation": "`AWS::RDS::DBInstance.ProcessorFeature`\n\nThe `ProcessorFeature` property type specifies the processor features of a\nDB instance class.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of a processor feature.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html#cfn-rds-dbinstance-processorfeature-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the processor feature. Valid names are `coreCount` and `threadsPerCore`.\n*Required*: No\n*Type*: String\n*Allowed values*: `coreCount | threadsPerCore...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "coreCount", "threadsPerCore" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html#cfn-rds-dbinstance-processorfeature-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBProxy.AuthFormat": { "MarkdownDocumentation": "`AWS::RDS::DBProxy.AuthFormat`\n\nSpecifies the details of authentication used by a proxy to log in as a specific database user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\nto the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IAMAuth": { "MarkdownDocumentation": "`IAMAuth`\n\nA value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.\nThe `ENABLED` value is valid only for proxies with RDS for Microsoft SQL Server.\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLED | REQUIRED | ENABL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "REQUIRED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-iamauth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClientPasswordAuthType": { "MarkdownDocumentation": "`ClientPasswordAuthType`\n\nSpecifies the details of authentication used by a proxy to log in as a specific database user.\n*Required*: No\n*Type*: String\n*Allowed values*: `MYSQL_NATIVE_PASSWORD | MYS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MYSQL_NATIVE_PASSWORD", "MYSQL_CACHING_SHA2_PASSWORD", "POSTGRES_SCRAM_SHA_256", "POSTGRES_MD5", "SQL_SERVER_AUTHENTICATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-clientpasswordauthtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthScheme": { "MarkdownDocumentation": "`AuthScheme`\n\nThe type of authentication that the proxy uses for connections from the proxy to the underlying database.\n*Required*: No\n*Type*: String\n*Allowed values*: `SECRETS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "SECRETS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-authscheme", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBProxy.TagFormat": { "MarkdownDocumentation": "`AWS::RDS::DBProxy.TagFormat`\n\nMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\nFor more information, see\n[Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or\n[Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nA value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only 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*Pattern*: `(\\w|\\d|\\s|\\\\|-|\\.:=+-)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nA key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only 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*Pattern*: `(\\w|\\d|\\s|\\\\|-|\\.:=+-)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBProxyEndpoint.TagFormat": { "MarkdownDocumentation": "`AWS::RDS::DBProxyEndpoint.TagFormat`\n\nMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\nFor more information, see\n[Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or\n[Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nA value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only 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*Pattern*: `(\\w|\\d|\\s|\\\\|-|\\.:=+-)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nA key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only 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*Pattern*: `(\\w|\\d|\\s|\\\\|-|\\.:=+-)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::DBProxyTargetGroup.ConnectionPoolConfigurationInfoFormat": { "MarkdownDocumentation": "`AWS::RDS::DBProxyTargetGroup.ConnectionPoolConfigurationInfoFormat`\n\nSpecifies the settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html", "Properties": { "MaxIdleConnectionsPercent": { "MarkdownDocumentation": "`MaxIdleConnectionsPercent`\n\nA value that controls how actively the proxy closes idle database connections in the connection pool.\nThe 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.\nWith 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\n`MaxIdleConnectionsPercent` is 40. If the value of `MaxConnectionsPercent` isn't specified, then for SQL Server, `MaxIdleConnectionsPercent` is `5`, and\nfor all other engines, the default is `50`.\nConstraints:\n* Must be between 0 and the value of `MaxConnectionsPercent`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-maxidleconnectionspercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxConnectionsPercent": { "MarkdownDocumentation": "`MaxConnectionsPercent`\n\nThe maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n`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:\n* Must be between 1 and 100.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-maxconnectionspercent", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "InitQuery": { "MarkdownDocumentation": "`InitQuery`\n\nAdd an initialization query, or modify the current one. You can specify one or more SQL statements for the proxy to run when opening each new database connection.\nThe setting is typically used with `SET` statements to make sure that each connection has identical settings.\nMake sure the query added here is valid. This is an optional field, so you can choose to leave it empty.\nFor including multiple variables in a single SET statement, use a comma separator.\nFor example: `SET variable1=value1, variable2=value2`\nDefault: no initialization query\n###### Important\nSince you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods.\nAnyone with access to view or manage your proxy target group configuration can view the initialization query.\nYou should not add sensitive data, such as passwords or long-lived encryption keys, to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-initquery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionBorrowTimeout": { "MarkdownDocumentation": "`ConnectionBorrowTimeout`\n\nThe number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the\nproxy has opened its maximum number of connections and all connections are busy with client sessions.\nDefault: `120`\nConstraints:\n* Must be between 0 and 300.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-connectionborrowtimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SessionPinningFilters": { "MarkdownDocumentation": "`SessionPinningFilters`\n\nEach item in the list represents a class of SQL operations that normally cause all later statements\nin a session using a proxy to be pinned to the same underlying database connection. Including an item\nin the list exempts that class of SQL operations from the pinning behavior.\nDefault: no session pinning filters\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-sessionpinningfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::RDS::DBSecurityGroup.Ingress": { "MarkdownDocumentation": "`AWS::RDS::DBSecurityGroup.Ingress`\n\nThe `Ingress` property type specifies an individual ingress rule within an\n`AWS::RDS::DBSecurityGroup` resource.\n###### Note\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that\nyou migrate as soon as possible. For more information, see [Migrate from EC2-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the\n*Amazon EC2 User Guide*, the blog [EC2-Classic Networking is Retiring \u2013\nHere\u2019s How to Prepare](https://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and [Moving a DB instance not in a VPC\ninto a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html", "Properties": { "CIDRIP": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-cidrip", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "EC2SecurityGroupId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EC2SecurityGroupName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EC2SecurityGroupOwnerId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupownerid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" } } }, "AWS::RDS::GlobalCluster.GlobalEndpoint": { "MarkdownDocumentation": "`AWS::RDS::GlobalCluster.GlobalEndpoint`\n\nThe writer endpoint for the new global database cluster. This endpoint always\npoints to the writer DB instance in the current primary cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-globalcluster-globalendpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe writer endpoint for the new global database cluster. This endpoint always\npoints to the writer DB instance in the current primary 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-globalcluster-globalendpoint.html#cfn-rds-globalcluster-globalendpoint-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RDS::OptionGroup.OptionConfiguration": { "MarkdownDocumentation": "`AWS::RDS::OptionGroup.OptionConfiguration`\n\nThe `OptionConfiguration` property type specifies an individual option, and\nits settings, within an `AWS::RDS::OptionGroup` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html", "Properties": { "OptionVersion": { "MarkdownDocumentation": "`OptionVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSecurityGroupMemberships": { "MarkdownDocumentation": "`VpcSecurityGroupMemberships`\n\nA list of VPC security group names used for this option.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-vpcsecuritygroupmemberships", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "OptionSettings": { "MarkdownDocumentation": "`OptionSettings`\n\nThe option settings to include in an option group.\n*Required*: No\n*Type*: Array of [OptionSetting](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OptionSetting", "DuplicatesAllowed": true }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OptionName": { "MarkdownDocumentation": "`OptionName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DBSecurityGroupMemberships": { "MarkdownDocumentation": "`DBSecurityGroupMemberships`\n\nA list of DB security groups used for this option.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-dbsecuritygroupmemberships", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::RDS::OptionGroup.OptionSetting": { "MarkdownDocumentation": "`AWS::RDS::OptionGroup.OptionSetting`\n\nThe `OptionSetting` property type specifies the value for an option within\nan `OptionSetting` property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe current value of the option 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html#cfn-rds-optiongroup-optionsetting-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the option that has settings that you can 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html#cfn-rds-optiongroup-optionsetting-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RUM::AppMonitor.AppMonitorConfiguration": { "MarkdownDocumentation": "`AWS::RUM::AppMonitor.AppMonitorConfiguration`\n\nThis structure contains much of the configuration data for the app monitor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html", "Properties": { "MetricDestinations": { "MarkdownDocumentation": "`MetricDestinations`\n\nAn array of structures that each define a destination that this app monitor will send extended metrics to.\n*Required*: No\n*Type*: Array of [MetricDestination](./aws-properties-rum-appmonitor-metricdestination.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-metricdestinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDestination", "DuplicatesAllowed": false }, "IncludedPages": { "MarkdownDocumentation": "`IncludedPages`\n\nIf 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*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-includedpages", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExcludedPages": { "MarkdownDocumentation": "`ExcludedPages`\n\nA list of URLs in your website or application to exclude from RUM data collection.\nYou can't include both `ExcludedPages` and `IncludedPages` in the same app monitor.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-excludedpages", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "FavoritePages": { "MarkdownDocumentation": "`FavoritePages`\n\nA list of pages in your application that are to be displayed with a \"favorite\" icon\nin the CloudWatch RUM console.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-favoritepages", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SessionSampleRate": { "MarkdownDocumentation": "`SessionSampleRate`\n\nSpecifies the portion of user sessions to use for CloudWatch RUM data collection. Choosing a higher portion gives you\nmore 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\nit 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*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-sessionsamplerate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "AllowCookies": { "MarkdownDocumentation": "`AllowCookies`\n\nIf you set this to `true`, the CloudWatch RUM web client sets two cookies, a session\ncookie and a user cookie. The cookies allow the CloudWatch RUM web client to collect data relating to\nthe number of users an application has and the behavior of the application across a\nsequence of events. Cookies are stored in the top-level domain of the current page.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-allowcookies", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Telemetries": { "MarkdownDocumentation": "`Telemetries`\n\nAn 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\n by your application.\n* `performance` indicates that RUM collects performance data about how your application\n 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-telemetries", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IdentityPoolId": { "MarkdownDocumentation": "`IdentityPoolId`\n\nThe ID of the Amazon Cognito identity pool\nthat is used to authorize the sending of data to CloudWatch RUM.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w-]+:[0-9a-f-]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-identitypoolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GuestRoleArn": { "MarkdownDocumentation": "`GuestRoleArn`\n\nThe ARN of the guest IAM role that is attached to the Amazon Cognito identity pool\nthat is used to authorize the sending of data to CloudWatch RUM.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-guestrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableXRay": { "MarkdownDocumentation": "`EnableXRay`\n\nIf you set this to `true`, CloudWatch RUM sends client-side traces to\nX-Ray for each sampled session. You can then see traces and\nsegments from these user sessions\nin the RUM dashboard and the CloudWatch ServiceLens console. For more information,\nsee [What is AWS X-Ray?](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-enablexray", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::RUM::AppMonitor.CustomEvents": { "MarkdownDocumentation": "`AWS::RUM::AppMonitor.CustomEvents`\n\nThis structure specifies whether this app monitor allows the web client to define and send custom events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-customevents.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSet 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*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-customevents.html#cfn-rum-appmonitor-customevents-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RUM::AppMonitor.DeobfuscationConfiguration": { "MarkdownDocumentation": "`AWS::RUM::AppMonitor.DeobfuscationConfiguration`\n\nA structure that contains the configuration for how an app monitor can deobfuscate stack traces.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-deobfuscationconfiguration.html", "Properties": { "JavaScriptSourceMaps": { "MarkdownDocumentation": "`JavaScriptSourceMaps`\n\nA structure that contains the configuration for how an app monitor can unminify JavaScript error stack traces using source maps.\n*Required*: No\n*Type*: [JavaScriptSourceMaps](./aws-properties-rum-appmonitor-javascriptsourcemaps.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-deobfuscationconfiguration.html#cfn-rum-appmonitor-deobfuscationconfiguration-javascriptsourcemaps", "UpdateType": "Mutable", "Required": false, "Type": "JavaScriptSourceMaps" } } }, "AWS::RUM::AppMonitor.JavaScriptSourceMaps": { "MarkdownDocumentation": "`AWS::RUM::AppMonitor.JavaScriptSourceMaps`\n\nA structure that contains the configuration for how an app monitor can unminify JavaScript error stack traces using source maps.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-javascriptsourcemaps.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies whether JavaScript error stack traces should be unminified for this app monitor. The default is for JavaScript error stack trace unminification to be `DISABLED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-javascriptsourcemaps.html#cfn-rum-appmonitor-javascriptsourcemaps-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe S3Uri of the bucket or folder that stores the source map files. It is required if status is ENABLED.\n*Required*: No\n*Type*: String\n*Pattern*: `^s3://[a-z0-9][-.a-z0-9]{1,62}(?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-javascriptsourcemaps.html#cfn-rum-appmonitor-javascriptsourcemaps-s3uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RUM::AppMonitor.MetricDefinition": { "MarkdownDocumentation": "`AWS::RUM::AppMonitor.MetricDefinition`\n\nSpecifies one custom metric or extended metric that you want the CloudWatch RUM app monitor to\nsend to a destination. Valid\ndestinations include CloudWatch and Evidently.\nBy default, RUM app monitors send some metrics to CloudWatch. These default metrics\nare listed in [CloudWatch metrics that you can collect.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html)\nIn addition to these default metrics, you can choose to send extended metrics or custom metrics or both.\n* Extended metrics enable you to send metrics with additional dimensions not included\n in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch.\n The valid dimension names for the additional dimensions for extended metrics are\n `BrowserName`, `CountryCode`, `DeviceType`,\n `FileType`, `OSName`, and `PageId`. For more information, see\n [Extended metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html).\n* Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or\n to CloudWatch Evidently or to both. With custom metrics,\n you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events,\n custom attributes, or default attributes.\n \n You can't send custom metrics to the `AWS/RUM` namespace. You must send custom metrics to a\n custom namespace that you define. The namespace that you use can't start with `AWS/`.\n CloudWatch RUM prepends `RUM/CustomMetrics/` to the custom namespace that you define,\n so the final namespace for your metrics in CloudWatch is\n `RUM/CustomMetrics/your-custom-namespace`.\nFor information about syntax rules for specifying custom metrics and extended metrics,\nsee\n[MetridDefinitionRequest](https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_MetricDefinitionRequest.html)\nin the *CloudWatch RUM API Reference*.\nThe maximum number of metric definitions that one destination can contain is 2000.\nExtended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension\nvalue counts as a custom metric.\nIf some metric definitions that you specify are not valid,\nthen the operation will not modify any metric definitions even if other metric definitions specified are valid.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html", "Properties": { "EventPattern": { "MarkdownDocumentation": "`EventPattern`\n\nThe pattern that defines the metric. RUM checks events that happen in a user's session\nagainst the pattern, and events that match the pattern are sent to the metric destination.\nIf the metrics destination\nis `CloudWatch` and the event\nalso matches a value in `DimensionKeys`, then the metric is published with the specified dimensions.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-eventpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValueKey": { "MarkdownDocumentation": "`ValueKey`\n\nThe field within the event object that the metric value is sourced from.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-valuekey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UnitLabel": { "MarkdownDocumentation": "`UnitLabel`\n\nUse this field only if you are sending this metric to CloudWatch. It defines\nthe CloudWatch metric unit that this metric is measured in.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-unitlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DimensionKeys": { "MarkdownDocumentation": "`DimensionKeys`\n\nThis field is a map of field paths to dimension names. It defines the dimensions to associate with this\nmetric in CloudWatch. The value of this field is used only if the metric destination is `CloudWatch`.\nIf the metric destination is `Evidently`, the value of `DimensionKeys` is ignored.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^(?!:).*[^\\s].*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-dimensionkeys", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nIf you are creating a custom metric instead of an extended metrics, use this parameter to define\nthe metric namespace for that custom metric. Do not specify this parameter if you are creating an extended metric.\nYou can't use any string that starts with `AWS/` for your namespace.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-._/#:]+$`\n*Minimum*: `1`\n*Maximum*: `237`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the metric that is defined in this structure.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::RUM::AppMonitor.MetricDestination": { "MarkdownDocumentation": "`AWS::RUM::AppMonitor.MetricDestination`\n\nCreates or updates a destination to receive extended metrics from CloudWatch RUM. You can send\nextended metrics to CloudWatch or to a CloudWatch Evidently experiment.\nFor more information about extended metrics, see\n[Extended metrics that you can send to CloudWatch and CloudWatch Evidently](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nDefines the destination to send the metrics to. Valid values are `CloudWatch` and\n`Evidently`. If\nyou specify `Evidently`, you must also specify the ARN of the\nCloudWatchEvidently experiment that is to\nbe the destination and an IAM role that has permission to write to the experiment.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CloudWatch | Evidently...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CloudWatch", "Evidently" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html#cfn-rum-appmonitor-metricdestination-destination", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThis parameter is required if `Destination` is `Evidently`. If `Destination` is\n`CloudWatch`, do not use this parameter.\nThis parameter specifies\nthe ARN of an IAM role that RUM will assume to write to the Evidently\nexperiment that you are sending metrics to. This role must have permission to write to that experiment.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html#cfn-rum-appmonitor-metricdestination-iamrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricDefinitions": { "MarkdownDocumentation": "`MetricDefinitions`\n\nAn array of structures which define the metrics that you want to send.\n*Required*: No\n*Type*: Array of [MetricDefinition](./aws-properties-rum-appmonitor-metricdefinition.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html#cfn-rum-appmonitor-metricdestination-metricdefinitions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDefinition", "DuplicatesAllowed": false }, "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nUse this parameter only if `Destination` is `Evidently`. This parameter specifies\nthe ARN of the Evidently experiment that will receive the extended metrics.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html#cfn-rum-appmonitor-metricdestination-destinationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RUM::AppMonitor.ResourcePolicy": { "MarkdownDocumentation": "`AWS::RUM::AppMonitor.ResourcePolicy`\n\nUse this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can\nhave one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see [Using resource-based policies with CloudWatch RUM](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-policies.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-resourcepolicy.html", "Properties": { "PolicyRevisionId": { "MarkdownDocumentation": "`PolicyRevisionId`\n\nA string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.\nWhen you assign a policy revision ID, then later requests about that policy will be rejected with an `InvalidPolicyRevisionIdException` error if they don't provide the correct current revision ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-resourcepolicy.html#cfn-rum-appmonitor-resourcepolicy-policyrevisionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe JSON to use as the resource policy. The document can be up to 4 KB in size. For more information about the contents and syntax\nfor this policy, see [Using resource-based policies with CloudWatch RUM](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-resourcepolicy.html#cfn-rum-appmonitor-resourcepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Rbin::Rule.ResourceTag": { "MarkdownDocumentation": "`AWS::Rbin::Rule.ResourceTag`\n\n[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention\nrule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-resourcetag.html", "Properties": { "ResourceTagValue": { "MarkdownDocumentation": "`ResourceTagValue`\n\nThe tag value.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-resourcetag.html#cfn-rbin-rule-resourcetag-resourcetagvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceTagKey": { "MarkdownDocumentation": "`ResourceTagKey`\n\nThe tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-resourcetag.html#cfn-rbin-rule-resourcetag-resourcetagkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Rbin::Rule.RetentionPeriod": { "MarkdownDocumentation": "`AWS::Rbin::Rule.RetentionPeriod`\n\nInformation about the retention period for which the retention rule is to\nretain resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html", "Properties": { "RetentionPeriodUnit": { "MarkdownDocumentation": "`RetentionPeriodUnit`\n\nThe unit of time in which the retention period is measured. Currently, only `DAYS`\nis supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DAYS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DAYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodunit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RetentionPeriodValue": { "MarkdownDocumentation": "`RetentionPeriodValue`\n\nThe period value for which the retention rule is to retain resources, measured in days.\nThe supported retention periods are:\n* EBS volumes: 1 - 7 days\n* EBS snapshots and EBS-backed AMIs: 1 - 365 days\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `3650`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Rbin::Rule.UnlockDelay": { "MarkdownDocumentation": "`AWS::Rbin::Rule.UnlockDelay`\n\nInformation about the retention rule unlock delay. The unlock delay is the period after which\na retention rule can be modified or edited after it has been unlocked by a user with the required\npermissions. The retention rule can't be modified or deleted during the unlock delay.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-unlockdelay.html", "Properties": { "UnlockDelayValue": { "MarkdownDocumentation": "`UnlockDelayValue`\n\nThe unlock delay period, measured in the unit specified for **UnlockDelayUnit**.\n*Required*: No\n*Type*: Integer\n*Minimum*: `7`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-unlockdelay.html#cfn-rbin-rule-unlockdelay-unlockdelayvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UnlockDelayUnit": { "MarkdownDocumentation": "`UnlockDelayUnit`\n\nThe unit of time in which to measure the unlock delay. Currently, the unlock delay can\nbe measured only in days.\n*Required*: No\n*Type*: String\n*Allowed values*: `DAYS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DAYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-unlockdelay.html#cfn-rbin-rule-unlockdelay-unlockdelayunit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Redshift::Cluster.Endpoint": { "MarkdownDocumentation": "`AWS::Redshift::Cluster.Endpoint`\n\nDescribes a connection endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe DNS address of the cluster. This property is read only.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html#cfn-redshift-cluster-endpoint-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port that the database engine is listening on. This property is read 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html#cfn-redshift-cluster-endpoint-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Redshift::Cluster.LoggingProperties": { "MarkdownDocumentation": "`AWS::Redshift::Cluster.LoggingProperties`\n\nSpecifies logging information, such as queries and connection attempts, for the\nspecified Amazon Redshift cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of an existing S3 bucket where the log files are to be stored.\nConstraints:\n* Must be in the same region as the cluster\n* The cluster must have read bucket and put object permissions\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3KeyPrefix": { "MarkdownDocumentation": "`S3KeyPrefix`\n\nThe prefix applied to the log file names.\nValid characters are any letter from any language, any whitespace character, any numeric character, and the following characters:\nunderscore (`_`), period (`.`), colon (`:`), slash (`/`), equal (`=`), plus (`+`), backslash (`\\`),\nhyphen (`-`), at symbol (`@`).\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-s3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogDestinationType": { "MarkdownDocumentation": "`LogDestinationType`\n\nThe log destination type. An enum with possible values of `s3` and `cloudwatch`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-logdestinationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogExports": { "MarkdownDocumentation": "`LogExports`\n\nThe collection of exported log types. Possible values are `connectionlog`, `useractivitylog`, and `userlog`.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-logexports", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Redshift::ClusterParameterGroup.Parameter": { "MarkdownDocumentation": "`AWS::Redshift::ClusterParameterGroup.Parameter`\n\nDescribes a parameter in a cluster parameter group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nThe value of the parameter. If `ParameterName` is `wlm_json_configuration`,\nthen the maximum size of `ParameterValue` is 8000 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html#cfn-redshift-clusterparametergroup-parameter-parametervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParameterName": { "MarkdownDocumentation": "`ParameterName`\n\nThe name of the parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html#cfn-redshift-clusterparametergroup-parameter-parametername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Redshift::EndpointAccess.NetworkInterface": { "MarkdownDocumentation": "`AWS::Redshift::EndpointAccess.NetworkInterface`\n\nDescribes a network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html", "Properties": { "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html#cfn-redshift-endpointaccess-networkinterface-privateipaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html#cfn-redshift-endpointaccess-networkinterface-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html#cfn-redshift-endpointaccess-networkinterface-subnetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html#cfn-redshift-endpointaccess-networkinterface-networkinterfaceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Redshift::EndpointAccess.VpcEndpoint": { "MarkdownDocumentation": "`AWS::Redshift::EndpointAccess.VpcEndpoint`\n\nThe connection endpoint for connecting to an Amazon Redshift cluster through the proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcendpoint.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcendpoint.html#cfn-redshift-endpointaccess-vpcendpoint-vpcid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaces": { "MarkdownDocumentation": "`NetworkInterfaces`\n\nOne or more network interfaces of the endpoint. Also known as an interface endpoint.\n*Required*: No\n*Type*: Array of [NetworkInterface](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcendpoint.html#cfn-redshift-endpointaccess-vpcendpoint-networkinterfaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NetworkInterface", "DuplicatesAllowed": true }, "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcendpoint.html#cfn-redshift-endpointaccess-vpcendpoint-vpcendpointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Redshift::EndpointAccess.VpcSecurityGroup": { "MarkdownDocumentation": "`AWS::Redshift::EndpointAccess.VpcSecurityGroup`\n\nThe security groups associated with the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcsecuritygroup.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcsecuritygroup.html#cfn-redshift-endpointaccess-vpcsecuritygroup-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSecurityGroupId": { "MarkdownDocumentation": "`VpcSecurityGroupId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcsecuritygroup.html#cfn-redshift-endpointaccess-vpcsecuritygroup-vpcsecuritygroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Redshift::ScheduledAction.PauseClusterMessage": { "MarkdownDocumentation": "`AWS::Redshift::ScheduledAction.PauseClusterMessage`\n\nDescribes a pause cluster operation. For example, a scheduled action to run the `PauseCluster` API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-pauseclustermessage.html", "Properties": { "ClusterIdentifier": { "MarkdownDocumentation": "`ClusterIdentifier`\n\nThe identifier of the cluster to be paused.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-pauseclustermessage.html#cfn-redshift-scheduledaction-pauseclustermessage-clusteridentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Redshift::ScheduledAction.ResizeClusterMessage": { "MarkdownDocumentation": "`AWS::Redshift::ScheduledAction.ResizeClusterMessage`\n\nDescribes a resize cluster operation. For example, a scheduled action to run the `ResizeCluster` API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html", "Properties": { "NodeType": { "MarkdownDocumentation": "`NodeType`\n\nThe new node type for the nodes you are adding. If not specified, the cluster's current node type is used.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-nodetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumberOfNodes": { "MarkdownDocumentation": "`NumberOfNodes`\n\nThe new number of nodes for the cluster. If not specified, the cluster's current number of nodes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-numberofnodes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ClusterType": { "MarkdownDocumentation": "`ClusterType`\n\nThe new cluster type for the specified cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-clustertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Classic": { "MarkdownDocumentation": "`Classic`\n\nA boolean value indicating whether the resize operation is using the classic resize\nprocess. If you don't provide this parameter or set the value to\n`false`, the resize type is elastic.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-classic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ClusterIdentifier": { "MarkdownDocumentation": "`ClusterIdentifier`\n\nThe unique identifier for the cluster to resize.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-clusteridentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Redshift::ScheduledAction.ResumeClusterMessage": { "MarkdownDocumentation": "`AWS::Redshift::ScheduledAction.ResumeClusterMessage`\n\nDescribes a resume cluster operation. For example, a scheduled action to run the `ResumeCluster` API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resumeclustermessage.html", "Properties": { "ClusterIdentifier": { "MarkdownDocumentation": "`ClusterIdentifier`\n\nThe identifier of the cluster to be resumed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resumeclustermessage.html#cfn-redshift-scheduledaction-resumeclustermessage-clusteridentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Redshift::ScheduledAction.ScheduledActionType": { "MarkdownDocumentation": "`AWS::Redshift::ScheduledAction.ScheduledActionType`\n\nThe action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-scheduledactiontype.html", "Properties": { "PauseCluster": { "MarkdownDocumentation": "`PauseCluster`\n\nAn action that runs a `PauseCluster` API operation.\n*Required*: No\n*Type*: [PauseClusterMessage](./aws-properties-redshift-scheduledaction-pauseclustermessage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-scheduledactiontype.html#cfn-redshift-scheduledaction-scheduledactiontype-pausecluster", "UpdateType": "Mutable", "Required": false, "Type": "PauseClusterMessage" }, "ResumeCluster": { "MarkdownDocumentation": "`ResumeCluster`\n\nAn action that runs a `ResumeCluster` API operation.\n*Required*: No\n*Type*: [ResumeClusterMessage](./aws-properties-redshift-scheduledaction-resumeclustermessage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-scheduledactiontype.html#cfn-redshift-scheduledaction-scheduledactiontype-resumecluster", "UpdateType": "Mutable", "Required": false, "Type": "ResumeClusterMessage" }, "ResizeCluster": { "MarkdownDocumentation": "`ResizeCluster`\n\nAn action that runs a `ResizeCluster` API operation.\n*Required*: No\n*Type*: [ResizeClusterMessage](./aws-properties-redshift-scheduledaction-resizeclustermessage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-scheduledactiontype.html#cfn-redshift-scheduledaction-scheduledactiontype-resizecluster", "UpdateType": "Mutable", "Required": false, "Type": "ResizeClusterMessage" } } }, "AWS::RedshiftServerless::Namespace.Namespace": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Namespace.Namespace`\n\nA collection of database objects and users.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the namespace.\n*Required*: No\n*Type*: String\n*Allowed values*: `AVAILABLE | MODIFYING | DEL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AVAILABLE", "MODIFYING", "DELETING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreationDate": { "MarkdownDocumentation": "`CreationDate`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-creationdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamRoles": { "MarkdownDocumentation": "`IamRoles`\n\nA list of IAM roles to associate with the namespace.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-iamroles", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdminPasswordSecretKmsKeyId": { "MarkdownDocumentation": "`AdminPasswordSecretKmsKeyId`\n\nThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretkmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultIamRoleArn": { "MarkdownDocumentation": "`DefaultIamRoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-defaultiamrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdminPasswordSecretArn": { "MarkdownDocumentation": "`AdminPasswordSecretArn`\n\nThe Amazon Resource Name (ARN) for the namespace's admin user credentials 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NamespaceName": { "MarkdownDocumentation": "`NamespaceName`\n\nThe name of the namespace.\nMust be between 3-64 alphanumeric characters in lowercase,\nand it cannot be a reserved word. A list of reserved words can be found\nin [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*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespacename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdminUsername": { "MarkdownDocumentation": "`AdminUsername`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminusername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NamespaceArn": { "MarkdownDocumentation": "`NamespaceArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespacearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DbName": { "MarkdownDocumentation": "`DbName`\n\nThe name of the first database created in the namespace.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-dbname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NamespaceId": { "MarkdownDocumentation": "`NamespaceId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespaceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogExports": { "MarkdownDocumentation": "`LogExports`\n\nThe types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-logexports", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::RedshiftServerless::Namespace.SnapshotCopyConfiguration": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Namespace.SnapshotCopyConfiguration`\n\nThe object that you configure to copy snapshots from one namespace to a namespace in another AWS Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html", "Properties": { "SnapshotRetentionPeriod": { "MarkdownDocumentation": "`SnapshotRetentionPeriod`\n\nThe retention period of snapshots that are copied to the destination AWS Region.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-snapshotretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DestinationKmsKeyId": { "MarkdownDocumentation": "`DestinationKmsKeyId`\n\nThe ID of the KMS key to use to encrypt your snapshots in the destination AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationkmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationRegion": { "MarkdownDocumentation": "`DestinationRegion`\n\nThe destination AWS Region to copy snapshots 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationregion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::RedshiftServerless::Snapshot.Snapshot": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Snapshot.Snapshot`\n\nA snapshot object that contains databases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the snapshot.\n*Required*: No\n*Type*: String\n*Allowed values*: `AVAILABLE | CREATING | DELE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AVAILABLE", "CREATING", "DELETED", "CANCELLED", "FAILED", "COPYING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NamespaceName": { "MarkdownDocumentation": "`NamespaceName`\n\nThe name of the namepsace.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-namespacename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdminUsername": { "MarkdownDocumentation": "`AdminUsername`\n\nThe username of the database within a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-adminusername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnapshotCreateTime": { "MarkdownDocumentation": "`SnapshotCreateTime`\n\nThe timestamp of when the snapshot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-snapshotcreatetime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NamespaceArn": { "MarkdownDocumentation": "`NamespaceArn`\n\nThe Amazon Resource Name (ARN) of the namespace the snapshot was created 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-namespacearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe unique identifier of the KMS key used to encrypt the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnapshotArn": { "MarkdownDocumentation": "`SnapshotArn`\n\nThe Amazon Resource Name (ARN) of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-snapshotarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OwnerAccount": { "MarkdownDocumentation": "`OwnerAccount`\n\nThe owner AWS; account of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-owneraccount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RetentionPeriod": { "MarkdownDocumentation": "`RetentionPeriod`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-retentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SnapshotName": { "MarkdownDocumentation": "`SnapshotName`\n\nThe name of the snapshot.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-snapshot-snapshot.html#cfn-redshiftserverless-snapshot-snapshot-snapshotname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RedshiftServerless::Workgroup.ConfigParameter": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Workgroup.ConfigParameter`\n\nA array of parameters to set for more control over a serverless database.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.html", "Properties": { "ParameterValue": { "MarkdownDocumentation": "`ParameterValue`\n\nThe value of the parameter to set.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `15000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.html#cfn-redshiftserverless-workgroup-configparameter-parametervalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterKey": { "MarkdownDocumentation": "`ParameterKey`\n\nThe key of the parameter. The options are `auto_mv`, `datestyle`, `enable_case_sensitive_identifier`,\n`enable_user_activity_logging`, `query_group`, `search_path`, `require_ssl`, `use_fips_ssl`,\nand query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see\n[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*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.html#cfn-redshiftserverless-workgroup-configparameter-parameterkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RedshiftServerless::Workgroup.Endpoint": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Workgroup.Endpoint`\n\nThe VPC endpoint object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html#cfn-redshiftserverless-workgroup-endpoint-address", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcEndpoints": { "MarkdownDocumentation": "`VpcEndpoints`\n\nAn array of `VpcEndpoint` objects.\n*Required*: No\n*Type*: Array of [VpcEndpoint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html#cfn-redshiftserverless-workgroup-endpoint-vpcendpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VpcEndpoint", "DuplicatesAllowed": true }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html#cfn-redshiftserverless-workgroup-endpoint-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::RedshiftServerless::Workgroup.NetworkInterface": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Workgroup.NetworkInterface`\n\nContains information about a network interface\nin an Amazon Redshift Serverless managed VPC endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html", "Properties": { "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html#cfn-redshiftserverless-workgroup-networkinterface-privateipaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html#cfn-redshiftserverless-workgroup-networkinterface-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html#cfn-redshiftserverless-workgroup-networkinterface-subnetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html#cfn-redshiftserverless-workgroup-networkinterface-networkinterfaceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RedshiftServerless::Workgroup.PerformanceTarget": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Workgroup.PerformanceTarget`\n\nAn object that represents the price performance target settings for the workgroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-performancetarget.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nWhether the price performance target is enabled for the workgroup.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-performancetarget.html#cfn-redshiftserverless-workgroup-performancetarget-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Level": { "MarkdownDocumentation": "`Level`\n\nThe target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100.\nThese correspond to the price performance levels LOW\\_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH\\_PERFORMANCE.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-performancetarget.html#cfn-redshiftserverless-workgroup-performancetarget-level", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::RedshiftServerless::Workgroup.VpcEndpoint": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Workgroup.VpcEndpoint`\n\nThe connection endpoint for connecting to Amazon Redshift Serverless through the proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html#cfn-redshiftserverless-workgroup-vpcendpoint-vpcid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaces": { "MarkdownDocumentation": "`NetworkInterfaces`\n\nOne or more network interfaces of the endpoint. Also known as an interface endpoint.\n*Required*: No\n*Type*: Array of [NetworkInterface](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html#cfn-redshiftserverless-workgroup-vpcendpoint-networkinterfaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NetworkInterface", "DuplicatesAllowed": true }, "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html#cfn-redshiftserverless-workgroup-vpcendpoint-vpcendpointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RedshiftServerless::Workgroup.Workgroup": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Workgroup.Workgroup`\n\nThe collection of computing resources from which an endpoint is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the workgroup.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATING | AVAILABLE | MODI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATING", "AVAILABLE", "MODIFYING", "DELETING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreationDate": { "MarkdownDocumentation": "`CreationDate`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-creationdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WorkgroupName": { "MarkdownDocumentation": "`WorkgroupName`\n\nThe name of the workgroup.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9-]*$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-workgroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WorkgroupArn": { "MarkdownDocumentation": "`WorkgroupArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-workgrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseCapacity": { "MarkdownDocumentation": "`BaseCapacity`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-basecapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnhancedVpcRouting": { "MarkdownDocumentation": "`EnhancedVpcRouting`\n\nThe value that specifies whether to enable enhanced virtual\nprivate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-enhancedvpcrouting", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "WorkgroupId": { "MarkdownDocumentation": "`WorkgroupId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-workgroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nAn array of security group IDs to associate with the workgroup.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nAn array of subnet IDs the workgroup is associated with.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NamespaceName": { "MarkdownDocumentation": "`NamespaceName`\n\nThe namespace the workgroup is associated with.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-namespacename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint that is created from the workgroup.\n*Required*: No\n*Type*: [Endpoint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-endpoint", "UpdateType": "Mutable", "Required": false, "Type": "Endpoint" }, "ConfigParameters": { "MarkdownDocumentation": "`ConfigParameters`\n\nAn array of parameters to set for advanced control over a database. The\noptions are `auto_mv`, `datestyle`, `enable_case_sensitive_identifier`, `enable_user_activity_logging`,\n`query_group`, `search_path`, `require_ssl`, `use_fips_ssl`, and query monitoring metrics that let you define performance boundaries.\nFor 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*: Array of [ConfigParameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-configparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConfigParameter", "DuplicatesAllowed": false }, "TrackName": { "MarkdownDocumentation": "`TrackName`\n\nThe name of the track for the workgroup.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-trackname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-publiclyaccessible", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PricePerformanceTarget": { "MarkdownDocumentation": "`PricePerformanceTarget`\n\nAn object that represents the price performance target settings for the workgroup.\n*Required*: No\n*Type*: [PerformanceTarget](./aws-properties-redshiftserverless-workgroup-performancetarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-priceperformancetarget", "UpdateType": "Mutable", "Required": false, "Type": "PerformanceTarget" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-maxcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::RefactorSpaces::Application.ApiGatewayProxyInput": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Application.ApiGatewayProxyInput`\n\nA wrapper object holding the Amazon API Gateway endpoint input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html", "Properties": { "StageName": { "MarkdownDocumentation": "`StageName`\n\nThe name of the API Gateway stage. The name defaults to `prod`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[-a-zA-Z0-9_]*$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-stagename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EndpointType": { "MarkdownDocumentation": "`EndpointType`\n\nThe type of endpoint to use for the API Gateway proxy. If no value is specified in\nthe request, the value is set to `REGIONAL` by default.\nIf the value is set to `PRIVATE` in the request, this creates a private API\nendpoint that is isolated from the public internet. The private endpoint can only be accessed\nby using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private\nconnection with Refactor Spaces and interface endpoint (AWS PrivateLink) availability,\nsee [Access\nRefactor Spaces using an interface endpoint (AWS PrivateLink)](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/vpc-interface-endpoints.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `REGIONAL | PRIVATE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "REGIONAL", "PRIVATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-endpointtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RefactorSpaces::Route.DefaultRouteInput": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Route.DefaultRouteInput`\n\nThe configuration for the default route type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-defaultrouteinput.html", "Properties": { "ActivationState": { "MarkdownDocumentation": "`ActivationState`\n\nIf set to `ACTIVE`, traffic is forwarded to this route\u2019s service after the\nroute is created.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INACTIVE | ACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INACTIVE", "ACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-defaultrouteinput.html#cfn-refactorspaces-route-defaultrouteinput-activationstate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::RefactorSpaces::Route.UriPathRouteInput": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Route.UriPathRouteInput`\n\nThe configuration for the URI path route type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html", "Properties": { "SourcePath": { "MarkdownDocumentation": "`SourcePath`\n\nThis is the path that Refactor Spaces uses to match traffic. Paths must start with\n`/` and are relative to the base of the application. To use path parameters in\nthe source path, add a variable in curly braces. For example, the resource path {user}\nrepresents a path parameter called 'user'.\n*Required*: No\n*Type*: String\n*Pattern*: `^(/([a-zA-Z0-9._:-]+|\\{[a-zA-Z0-9._:-]+\\}))+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-sourcepath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AppendSourcePath": { "MarkdownDocumentation": "`AppendSourcePath`\n\nIf set to `true`, this option appends the source path to the service URL\nendpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-appendsourcepath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ActivationState": { "MarkdownDocumentation": "`ActivationState`\n\nIf set to `ACTIVE`, traffic is forwarded to this route\u2019s service after the\nroute is created.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INACTIVE | ACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INACTIVE", "ACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-activationstate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Methods": { "MarkdownDocumentation": "`Methods`\n\nA list of HTTP methods to match. An empty list matches all values. If a method is present,\nonly HTTP requests using that method are forwarded to this route\u2019s service.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-methods", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IncludeChildPaths": { "MarkdownDocumentation": "`IncludeChildPaths`\n\nIndicates whether to match all subpaths of the given source path. If this value is\n`false`, requests must match the source path exactly before they are forwarded to\nthis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-includechildpaths", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::RefactorSpaces::Service.LambdaEndpointInput": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Service.LambdaEndpointInput`\n\nThe input for the AWS Lambda endpoint type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-lambdaendpointinput.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the Lambda function or alias.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-lambdaendpointinput.html#cfn-refactorspaces-service-lambdaendpointinput-arn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::RefactorSpaces::Service.UrlEndpointInput": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Service.UrlEndpointInput`\n\nThe configuration for the URL endpoint type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-urlendpointinput.html", "Properties": { "HealthUrl": { "MarkdownDocumentation": "`HealthUrl`\n\nThe health check URL of the URL endpoint type. If the URL is a public endpoint, the\n`HealthUrl` must also be a public endpoint. If the URL is a private endpoint\ninside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the\nhost must be the same as the URL.\n*Required*: No\n*Type*: String\n*Pattern*: `^https?://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-urlendpointinput.html#cfn-refactorspaces-service-urlendpointinput-healthurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL to route traffic to. The URL must be an [rfc3986-formatted URL](https://datatracker.ietf.org/doc/html/rfc3986). If the\nhost is a domain name, the name must be resolvable over the public internet. If the scheme is\n`https`, the top level domain of the host must be listed in the [IANA root zone database](https://www.iana.org/domains/root/db).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https?://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-urlendpointinput.html#cfn-refactorspaces-service-urlendpointinput-url", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Rekognition::StreamProcessor.BoundingBox": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor.BoundingBox`\n\nIdentifies the bounding box around the label, face, text, or personal protective equipment.\nThe `left` (x-coordinate) and `top` (y-coordinate) are coordinates representing the top and\nleft sides of the bounding box. Note that the upper-left corner of the image is the origin\n(0,0).\nThe `top` and `left` values returned are ratios of the overall\nimage size. For example, if the input image is 700x200 pixels, and the top-left coordinate of\nthe bounding box is 350x50 pixels, the API returns a `left` value of 0.5 (350/700)\nand a `top` value of 0.25 (50/200).\nThe `width` and `height` values represent the dimensions of the\nbounding box as a ratio of the overall image dimension. For example, if the input image is\n700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. For more information, see\n[BoundingBox](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_BoundingBox).\n###### Note\nThe bounding box coordinates can have negative values. For example, if Amazon Rekognition is\nable to detect a face that is at the image edge and is only partially visible, the service\ncan return coordinates that are outside the image bounds and, depending on the image edge,\nyou might get negative values or values greater than 1 for the `left` or\n`top` values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-boundingbox.html", "Properties": { "Left": { "MarkdownDocumentation": "`Left`\n\nLeft coordinate of the bounding box as a ratio of overall image width.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-boundingbox.html#cfn-rekognition-streamprocessor-boundingbox-left", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" }, "Top": { "MarkdownDocumentation": "`Top`\n\nTop coordinate of the bounding box as a ratio of overall image height.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-boundingbox.html#cfn-rekognition-streamprocessor-boundingbox-top", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" }, "Height": { "MarkdownDocumentation": "`Height`\n\nHeight of the bounding box as a ratio of the overall image height.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-boundingbox.html#cfn-rekognition-streamprocessor-boundingbox-height", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" }, "Width": { "MarkdownDocumentation": "`Width`\n\nWidth of the bounding box as a ratio of the overall image width.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-boundingbox.html#cfn-rekognition-streamprocessor-boundingbox-width", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::Rekognition::StreamProcessor.ConnectedHomeSettings": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor.ConnectedHomeSettings`\n\nConnected home settings to use on a streaming video. Defining the settings is required in the request parameter for `CreateStreamProcessor`.\nIncluding this setting in the CreateStreamProcessor request lets you use the stream processor for connected home features. You can then select\nwhat you want the stream processor to detect, such as people or pets.\nWhen the stream processor has started, one notification is sent\nfor each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is\ndetected and one SNS notification is published the first time a pet is detected. An end-of-session summary is also published.\nFor more information, see the ConnectedHome section of [StreamProcessorSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorSettings).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html", "Properties": { "MinConfidence": { "MarkdownDocumentation": "`MinConfidence`\n\nThe minimum confidence required to label an object in the video.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html#cfn-rekognition-streamprocessor-connectedhomesettings-minconfidence", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "Labels": { "MarkdownDocumentation": "`Labels`\n\nSpecifies what you want to detect in the video, such as people, packages, or pets.\nThe current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\".\n*Required*: Yes\n*Type*: Array of String\n*Maximum*: `128`\n*Minimum*: `1 | 1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html#cfn-rekognition-streamprocessor-connectedhomesettings-labels", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::Rekognition::StreamProcessor.DataSharingPreference": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor.DataSharingPreference`\n\nAllows you to opt in or opt out to share data with Rekognition to improve model performance.\nYou 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.\nFor more information, see [StreamProcessorDataSharingPreference](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorDataSharingPreference).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-datasharingpreference.html", "Properties": { "OptIn": { "MarkdownDocumentation": "`OptIn`\n\nDescribes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-datasharingpreference.html#cfn-rekognition-streamprocessor-datasharingpreference-optin", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::Rekognition::StreamProcessor.FaceSearchSettings": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor.FaceSearchSettings`\n\nThe input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor. `FaceSearchSettings` is a request\nparameter for [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor).\nFor more information, see [FaceSearchSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_FaceSearchSettings).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html", "Properties": { "CollectionId": { "MarkdownDocumentation": "`CollectionId`\n\nThe ID of a collection that contains faces that you want to search for.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\A[a-zA-Z0-9_\\.\\-]+$`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html#cfn-rekognition-streamprocessor-facesearchsettings-collectionid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FaceMatchThreshold": { "MarkdownDocumentation": "`FaceMatchThreshold`\n\nMinimum face match confidence score that must be met to return a result for a recognized face. The default is 80.\n0 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*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html#cfn-rekognition-streamprocessor-facesearchsettings-facematchthreshold", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Rekognition::StreamProcessor.KinesisDataStream": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor.KinesisDataStream`\n\nAmazon Rekognition Video Stream Processor take as input a Kinesis video stream (Input) and a Kinesis data stream (Output).\nThis is the Amazon Kinesis Data Streams instance to which the Amazon Rekognition stream processor streams the analysis results.\nThis must be created within the constraints specified at\n[KinesisDataStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisDataStream).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisdatastream.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nARN 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*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisdatastream.html#cfn-rekognition-streamprocessor-kinesisdatastream-arn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Rekognition::StreamProcessor.KinesisVideoStream": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor.KinesisVideoStream`\n\nThe Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor. For more information, see\n[KinesisVideoStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisVideoStream).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisvideostream.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nARN 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*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisvideostream.html#cfn-rekognition-streamprocessor-kinesisvideostream-arn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Rekognition::StreamProcessor.NotificationChannel": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor.NotificationChannel`\n\nThe Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.\nAmazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream.\nAmazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.\nFor more information, see [StreamProcessorNotificationChannel](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorNotificationChannel).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-notificationchannel.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe ARN of the SNS topic that receives notifications.\n*Required*: Yes\n*Type*: String\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-notificationchannel.html#cfn-rekognition-streamprocessor-notificationchannel-arn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Rekognition::StreamProcessor.S3Destination": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor.S3Destination`\n\nThe Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.\nThese results include the name of the stream processor resource, the session ID of the stream processing session,\nand labeled timestamps and bounding boxes for detected labels. For more information, see\n[S3Destination](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_S3Destination).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-s3destination.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nDescribes the destination Amazon Simple Storage Service (Amazon S3) bucket name of a stream processor's exports.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-s3destination.html#cfn-rekognition-streamprocessor-s3destination-bucketname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ObjectKeyPrefix": { "MarkdownDocumentation": "`ObjectKeyPrefix`\n\nDescribes the destination Amazon Simple Storage Service (Amazon S3) object keys of a stream processor's exports.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-s3destination.html#cfn-rekognition-streamprocessor-s3destination-objectkeyprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ResilienceHub::App.EventSubscription": { "MarkdownDocumentation": "`AWS::ResilienceHub::App.EventSubscription`\n\nIndicates an event you would like to subscribe and get notification for. Currently,\nAWS Resilience Hub supports notifications only for **Drift\ndetected** and **Scheduled assessment failure**\nevents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-eventsubscription.html", "Properties": { "EventType": { "MarkdownDocumentation": "`EventType`\n\nThe type of event you would like to subscribe and get notification for. Currently, AWS Resilience Hub supports notifications only for **Drift\ndetected** (`DriftDetected`) and **Scheduled\nassessment failure** (`ScheduledAssessmentFailure`) events.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ScheduledAssessmentFailure ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ScheduledAssessmentFailure", "DriftDetected" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-eventsubscription.html#cfn-resiliencehub-app-eventsubscription-eventtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SnsTopicArn": { "MarkdownDocumentation": "`SnsTopicArn`\n\nAmazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN\nis: `arn:partition:sns:region:account:topic-name`. For more information about ARNs,\nsee [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the\n*AWS General Reference* guide.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-eventsubscription.html#cfn-resiliencehub-app-eventsubscription-snstopicarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nUnique name to identify an event subscription.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-eventsubscription.html#cfn-resiliencehub-app-eventsubscription-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ResilienceHub::App.PermissionModel": { "MarkdownDocumentation": "`AWS::ResilienceHub::App.PermissionModel`\n\nDefines the roles and credentials that AWS Resilience Hub would use while creating the\napplication, importing its resources, and running an assessment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-permissionmodel.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nDefines how AWS Resilience Hub scans your resources. It can scan for the resources by\nusing a pre-existing role in your AWS account, or by using the credentials of\nthe current IAM user.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LegacyIAMUser | RoleBased...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LegacyIAMUser", "RoleBased" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-permissionmodel.html#cfn-resiliencehub-app-permissionmodel-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CrossAccountRoleArns": { "MarkdownDocumentation": "`CrossAccountRoleArns`\n\nDefines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These\nARNs are used for querying purposes while importing resources and assessing your\napplication.\n###### Note\n* These ARNs are required only when your resources are in other accounts and you have\n different role name in these accounts. Else, the invoker role name will be used in the\n other accounts.\n* These roles must have a trust policy with `iam:AssumeRole` permission to\n the invoker role in the primary account.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-permissionmodel.html#cfn-resiliencehub-app-permissionmodel-crossaccountrolearns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "InvokerRoleName": { "MarkdownDocumentation": "`InvokerRoleName`\n\nExisting AWS\nIAM role name in the primary AWS account that will be assumed by\nAWS Resilience Hub Service Principle to obtain a read-only access to your application\nresources while running an assessment.\nIf your IAM role includes a path, you must include the path in the `invokerRoleName` parameter.\nFor example, if your IAM role's ARN is `arn:aws:iam:123456789012:role/my-path/role-name`, you should pass `my-path/role-name`.\n###### Note\n* You must have `iam:passRole` permission for this role while creating or\n updating the application.\n* Currently, `invokerRoleName` accepts only `[A-Za-z0-9_+=,.@-]`\n characters.\n*Required*: No\n*Type*: String\n*Pattern*: `((\\u002F[\\u0021-\\u007E]+\\u002F){1,511})?[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-permissionmodel.html#cfn-resiliencehub-app-permissionmodel-invokerrolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ResilienceHub::App.PhysicalResourceId": { "MarkdownDocumentation": "`AWS::ResilienceHub::App.PhysicalResourceId`\n\nDefines a physical resource identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of physical resource identifier.\nArn\nThe resource identifier is an Amazon Resource Name (ARN) and it can identify the\nfollowing list of resources:\n* `AWS::ECS::Service`\n* `AWS::EFS::FileSystem`\n* `AWS::ElasticLoadBalancingV2::LoadBalancer`\n* `AWS::Lambda::Function`\n* `AWS::SNS::Topic`\n\nNative\nThe resource identifier is an AWS Resilience Hub-native identifier and it can\nidentify the following list of resources:\n* `AWS::ApiGateway::RestApi`\n* `AWS::ApiGatewayV2::Api`\n* `AWS::AutoScaling::AutoScalingGroup`\n* `AWS::DocDB::DBCluster`\n* `AWS::DocDB::DBGlobalCluster`\n* `AWS::DocDB::DBInstance`\n* `AWS::DynamoDB::GlobalTable`\n* `AWS::DynamoDB::Table`\n* `AWS::EC2::EC2Fleet`\n* `AWS::EC2::Instance`\n* `AWS::EC2::NatGateway`\n* `AWS::EC2::Volume`\n* `AWS::ElasticLoadBalancing::LoadBalancer`\n* `AWS::RDS::DBCluster`\n* `AWS::RDS::DBInstance`\n* `AWS::RDS::GlobalCluster`\n* `AWS::Route53::RecordSet`\n* `AWS::S3::Bucket`\n* `AWS::SQS::Queue`\n\n*Required*: Yes\n*Type*: String\n*Pattern*: `Arn|Native`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html#cfn-resiliencehub-app-physicalresourceid-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nIdentifier of the physical resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html#cfn-resiliencehub-app-physicalresourceid-identifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AwsRegion": { "MarkdownDocumentation": "`AwsRegion`\n\nThe AWS Region that the physical resource is located in.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html#cfn-resiliencehub-app-physicalresourceid-awsregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe AWS account that owns the physical resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html#cfn-resiliencehub-app-physicalresourceid-awsaccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ResilienceHub::App.ResourceMapping": { "MarkdownDocumentation": "`AWS::ResilienceHub::App.ResourceMapping`\n\nDefines a resource mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-resourcemapping.html", "Properties": { "MappingType": { "MarkdownDocumentation": "`MappingType`\n\nSpecifies the type of resource mapping.\n*Required*: Yes\n*Type*: String\n*Pattern*: `CfnStack|Resource|Terraform|EKS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-resourcemapping.html#cfn-resiliencehub-app-resourcemapping-mappingtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogicalStackName": { "MarkdownDocumentation": "`LogicalStackName`\n\nName of the CloudFormation stack this resource is mapped to when the `mappingType` is `CfnStack`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-resourcemapping.html#cfn-resiliencehub-app-resourcemapping-logicalstackname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceName": { "MarkdownDocumentation": "`ResourceName`\n\nName of the resource that this resource is mapped to when the `mappingType` is `Resource`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-resourcemapping.html#cfn-resiliencehub-app-resourcemapping-resourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TerraformSourceName": { "MarkdownDocumentation": "`TerraformSourceName`\n\nName of the Terraform source that this resource is mapped to when the `mappingType` is `Terraform`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-resourcemapping.html#cfn-resiliencehub-app-resourcemapping-terraformsourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PhysicalResourceId": { "MarkdownDocumentation": "`PhysicalResourceId`\n\nIdentifier of the physical resource.\n*Required*: Yes\n*Type*: [PhysicalResourceId](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-resourcemapping.html#cfn-resiliencehub-app-resourcemapping-physicalresourceid", "UpdateType": "Mutable", "Required": true, "Type": "PhysicalResourceId" }, "EksSourceName": { "MarkdownDocumentation": "`EksSourceName`\n\nName of the Amazon Elastic Kubernetes Service cluster and namespace that this resource is mapped to when the `mappingType` is\n`EKS`.\n###### Note\nThis parameter accepts values in \"eks-cluster/namespace\" 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-resourcemapping.html#cfn-resiliencehub-app-resourcemapping-ekssourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ResilienceHub::ResiliencyPolicy.FailurePolicy": { "MarkdownDocumentation": "`AWS::ResilienceHub::ResiliencyPolicy.FailurePolicy`\n\nDefines a failure policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html", "Properties": { "RpoInSecs": { "MarkdownDocumentation": "`RpoInSecs`\n\nRecovery 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html#cfn-resiliencehub-resiliencypolicy-failurepolicy-rpoinsecs", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "RtoInSecs": { "MarkdownDocumentation": "`RtoInSecs`\n\nRecovery 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html#cfn-resiliencehub-resiliencypolicy-failurepolicy-rtoinsecs", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::ResilienceHub::ResiliencyPolicy.PolicyMap": { "MarkdownDocumentation": "`AWS::ResilienceHub::ResiliencyPolicy.PolicyMap`\n\nThe type of resiliency policy to be created, including the recovery time objective (RTO)\nand recovery point objective (RPO) in seconds.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html", "Properties": { "AZ": { "MarkdownDocumentation": "`AZ`\n\nDefines the RTO and RPO targets for Availability Zone disruption.\n*Required*: Yes\n*Type*: [FailurePolicy](./aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html#cfn-resiliencehub-resiliencypolicy-policymap-az", "UpdateType": "Mutable", "Required": true, "Type": "FailurePolicy" }, "Region": { "MarkdownDocumentation": "`Region`\n\nDefines the RTO and RPO targets for Regional disruption.\n*Required*: No\n*Type*: [FailurePolicy](./aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html#cfn-resiliencehub-resiliencypolicy-policymap-region", "UpdateType": "Mutable", "Required": false, "Type": "FailurePolicy" }, "Hardware": { "MarkdownDocumentation": "`Hardware`\n\nDefines the RTO and RPO targets for hardware disruption.\n*Required*: Yes\n*Type*: [FailurePolicy](./aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html#cfn-resiliencehub-resiliencypolicy-policymap-hardware", "UpdateType": "Mutable", "Required": true, "Type": "FailurePolicy" }, "Software": { "MarkdownDocumentation": "`Software`\n\nDefines the RTO and RPO targets for software disruption.\n*Required*: Yes\n*Type*: [FailurePolicy](./aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html#cfn-resiliencehub-resiliencypolicy-policymap-software", "UpdateType": "Mutable", "Required": true, "Type": "FailurePolicy" } } }, "AWS::ResourceExplorer2::View.IncludedProperty": { "MarkdownDocumentation": "`AWS::ResourceExplorer2::View.IncludedProperty`\n\nInformation about an additional property that describes a resource, that you can\noptionally include in a view.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.html#cfn-resourceexplorer2-view-includedproperty-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ResourceExplorer2::View.SearchFilter": { "MarkdownDocumentation": "`AWS::ResourceExplorer2::View.SearchFilter`\n\nA search filter defines which resources can be part of a search query result\nset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-searchfilter.html", "Properties": { "FilterString": { "MarkdownDocumentation": "`FilterString`\n\nThe string that contains the search keywords, prefixes, and operators to control the\nresults that can be returned by a Search operation.\nFor information about the supported syntax, see [Search query\nreference](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User\nGuide*.\n###### Important\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\n`region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the\nletters `us` and are *not* tagged with a key\n`Stage` that has the value `prod`.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-searchfilter.html#cfn-resourceexplorer2-view-searchfilter-filterstring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ResourceGroups::Group.ConfigurationItem": { "MarkdownDocumentation": "`AWS::ResourceGroups::Group.ConfigurationItem`\n\nOne of the items in the service configuration assigned to a resource group. A service\nconfiguration can consist of one or more items. For details service configurations and\nhow to construct them, see [Service configurations for resource\ngroups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of configuration item. Each item must have a unique value for type.\nFor the list of the types that you can specify for a configuration item, see [Supported resource types and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `AWS::[a-zA-Z0-9]+::[a-zA-Z0-9]+`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html#cfn-resourcegroups-group-configurationitem-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nA collection of parameters for this configuration item. For the list of parameters\nthat you can use with each configuration item `Type`, see [Supported resource types and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User Guide*.\n*Required*: No\n*Type*: Array of [ConfigurationParameter](./aws-properties-resourcegroups-group-configurationparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html#cfn-resourcegroups-group-configurationitem-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConfigurationParameter", "DuplicatesAllowed": true } } }, "AWS::ResourceGroups::Group.ConfigurationParameter": { "MarkdownDocumentation": "`AWS::ResourceGroups::Group.ConfigurationParameter`\n\nOne parameter for a group configuration item. For details about service configurations\nand how to construct them, see [Service configurations for resource\ngroups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe value or values to be used for the specified parameter. For the list of values you\ncan use with each parameter, see [Supported resource\ntypes and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html#cfn-resourcegroups-group-configurationparameter-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the group configuration parameter. For the list of parameters that you can\nuse with each configuration item type, see [Supported resource\ntypes and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-z-]+`\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html#cfn-resourcegroups-group-configurationparameter-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ResourceGroups::Group.Query": { "MarkdownDocumentation": "`AWS::ResourceGroups::Group.Query`\n\nSpecifies details within a `ResourceQuery` structure that determines the\nmembership of the resource group. The contents required in the `Query`\nstructure are determined by the `Type` property of the containing\n`ResourceQuery` structure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html", "Properties": { "TagFilters": { "MarkdownDocumentation": "`TagFilters`\n\nA list of key-value pair objects that limit which resources can be members of the\nresource group. This property is required when the `ResourceQuery.Type`\nproperty is `TAG_FILTERS_1_0`.\nA resource must have a tag that matches every filter that is provided in the\n`TagFilters` list.\n*Required*: Conditional\n*Type*: Array of [TagFilter](./aws-properties-resourcegroups-group-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-tagfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagFilter", "DuplicatesAllowed": true }, "ResourceTypeFilters": { "MarkdownDocumentation": "`ResourceTypeFilters`\n\nSpecifies limits to the types of resources that can be included in the resource group.\nFor example, if `ResourceTypeFilters` is `[\"AWS::EC2::Instance\",\n\"AWS::DynamoDB::Table\"]`, only EC2 instances or DynamoDB tables can be members\nof this resource group. The default value is `[\"AWS::AllSupported\"]`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-resourcetypefilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "StackIdentifier": { "MarkdownDocumentation": "`StackIdentifier`\n\nSpecifies the ARN of a CloudFormation stack. All supported resources of the\nCloudFormation stack are members of the resource group. If you don't specify an ARN,\nthis parameter defaults to the current stack that you are defining, which means that all\nthe resources of the current stack are grouped.\nYou can specify a value for `StackIdentifier` only when the\n`ResourceQuery.Type` property is\n`CLOUDFORMATION_STACK_1_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-stackidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ResourceGroups::Group.ResourceQuery": { "MarkdownDocumentation": "`AWS::ResourceGroups::Group.ResourceQuery`\n\nThe query used to dynamically define the members of a group. For more information\nabout how to construct a query, see [Build queries and groups in\nAWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/gettingstarted-query.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of resource query that determines this group's membership. There\nare two valid query types:\n* `TAG_FILTERS_1_0` indicates that the group is a tag-based group.\n To complete the group membership, you must include the `TagFilters`\n property to specify the tag filters to use in the query.\n* `CLOUDFORMATION_STACK_1_0`, the default, indicates that the\n group is a CloudFormation stack-based group. Group membership is based on the\n CloudFormation stack. You must specify the `StackIdentifier` property\n in the query to define which stack to associate the group with, or leave it\n empty to default to the stack where the group is defined.\n*Required*: No\n*Type*: String\n*Allowed values*: `TAG_FILTERS_1_0 | CLOUDFORM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TAG_FILTERS_1_0", "CLOUDFORMATION_STACK_1_0" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html#cfn-resourcegroups-group-resourcequery-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Query": { "MarkdownDocumentation": "`Query`\n\nThe query that defines the membership of the group. This is a structure with\nproperties that depend on the `Type`.\nThe `Query` structure must be included in the following scenarios:\n* When the `Type` is `TAG_FILTERS_1_0`, you must specify a\n `Query` structure that contains a `TagFilters` list of\n tags. Resources with tags that match those in the `TagFilter` list\n become members of the resource group.\n* When the `Type` is `CLOUDFORMATION_STACK_1_0` then this\n field is required only when you must specify a CloudFormation stack other than\n the one you are defining. To do this, the `Query` structure must\n contain the `StackIdentifier` property. If you don't specify either a\n `Query` structure or a `StackIdentifier` within that\n `Query`, then it defaults to the CloudFormation stack that you're\n currently constructing.\n*Required*: No\n*Type*: [Query](./aws-properties-resourcegroups-group-query.html)\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html#cfn-resourcegroups-group-resourcequery-query", "UpdateType": "Mutable", "Required": false, "Type": "Query" } } }, "AWS::ResourceGroups::Group.TagFilter": { "MarkdownDocumentation": "`AWS::ResourceGroups::Group.TagFilter`\n\nSpecifies a single tag key and optional values that you can use to specify membership\nin a tag-based group. An AWS resource that doesn't have a matching tag\nkey and value is rejected as a member of the group.\nA `TagFilter` object includes two properties: `Key` (a string)\nand `Values` (a list of strings). Only resources in the account that are\ntagged with a matching key-value pair are members of the group. The `Values`\nproperty of `TagFilter` is optional, but specifying it narrows the query\nresults.\nAs an example, suppose the `TagFilters` string is `[{\"Key\": \"Stage\",\n\"Values\": [\"Test\", \"Beta\"]}, {\"Key\": \"Storage\"}]`. In this case, only\nresources with all of the following tags are members of the group:\n* `Stage` tag key with a value of either `Test` or\n `Beta`\n* `Storage` tag key with any value\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nA list of tag values that can be included in the tag-based resource group. This is\noptional. If you don't specify a value or values for a key, then an AWS\nresource with any value for that key is a member.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html#cfn-resourcegroups-group-tagfilter-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Key": { "MarkdownDocumentation": "`Key`\n\nA string that defines a tag key. Only resources in the account that are tagged with a\nspecified tag key are members of the tag-based resource group.\nThis field is required when the `ResourceQuery` structure's\n`Type` property is `TAG_FILTERS_1_0`. You must specify at\nleast one tag key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html#cfn-resourcegroups-group-tagfilter-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::RoboMaker::RobotApplication.RobotSoftwareSuite": { "MarkdownDocumentation": "`AWS::RoboMaker::RobotApplication.RobotSoftwareSuite`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html", "Properties": { "Version": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html#cfn-robomaker-robotapplication-robotsoftwaresuite-version", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html#cfn-robomaker-robotapplication-robotsoftwaresuite-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::RoboMaker::RobotApplication.SourceConfig": { "MarkdownDocumentation": "`AWS::RoboMaker::RobotApplication.SourceConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html", "Properties": { "S3Bucket": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html#cfn-robomaker-robotapplication-sourceconfig-s3bucket", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Architecture": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html#cfn-robomaker-robotapplication-sourceconfig-architecture", "PrimitiveType": "String", "UpdateType": "Mutable" }, "S3Key": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html#cfn-robomaker-robotapplication-sourceconfig-s3key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::RoboMaker::SimulationApplication.RenderingEngine": { "MarkdownDocumentation": "`AWS::RoboMaker::SimulationApplication.RenderingEngine`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-renderingengine.html", "Properties": { "Version": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-renderingengine.html#cfn-robomaker-simulationapplication-renderingengine-version", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-renderingengine.html#cfn-robomaker-simulationapplication-renderingengine-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite": { "MarkdownDocumentation": "`AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html", "Properties": { "Version": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html#cfn-robomaker-simulationapplication-robotsoftwaresuite-version", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html#cfn-robomaker-simulationapplication-robotsoftwaresuite-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::RoboMaker::SimulationApplication.SimulationSoftwareSuite": { "MarkdownDocumentation": "`AWS::RoboMaker::SimulationApplication.SimulationSoftwareSuite`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-simulationsoftwaresuite.html", "Properties": { "Version": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-simulationsoftwaresuite.html#cfn-robomaker-simulationapplication-simulationsoftwaresuite-version", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-simulationsoftwaresuite.html#cfn-robomaker-simulationapplication-simulationsoftwaresuite-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::RoboMaker::SimulationApplication.SourceConfig": { "MarkdownDocumentation": "`AWS::RoboMaker::SimulationApplication.SourceConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html", "Properties": { "S3Bucket": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html#cfn-robomaker-simulationapplication-sourceconfig-s3bucket", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Architecture": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html#cfn-robomaker-simulationapplication-sourceconfig-architecture", "PrimitiveType": "String", "UpdateType": "Mutable" }, "S3Key": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html#cfn-robomaker-simulationapplication-sourceconfig-s3key", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::RolesAnywhere::Profile.AttributeMapping": { "MarkdownDocumentation": "`AWS::RolesAnywhere::Profile.AttributeMapping`\n\nA mapping applied to the authenticating end-entity certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-profile-attributemapping.html", "Properties": { "MappingRules": { "MarkdownDocumentation": "`MappingRules`\n\nA list of mapping entries for every supported specifier or sub-field.\n*Required*: Yes\n*Type*: Array of [MappingRule](./aws-properties-rolesanywhere-profile-mappingrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-profile-attributemapping.html#cfn-rolesanywhere-profile-attributemapping-mappingrules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MappingRule", "DuplicatesAllowed": true }, "CertificateField": { "MarkdownDocumentation": "`CertificateField`\n\nFields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `x509Subject | x509Issuer | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "x509Subject", "x509Issuer", "x509SAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-profile-attributemapping.html#cfn-rolesanywhere-profile-attributemapping-certificatefield", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::RolesAnywhere::Profile.MappingRule": { "MarkdownDocumentation": "`AWS::RolesAnywhere::Profile.MappingRule`\n\nA single mapping entry for each supported specifier or sub-field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-profile-mappingrule.html", "Properties": { "Specifier": { "MarkdownDocumentation": "`Specifier`\n\nSpecifier within a certificate field, such as CN, OU, or UID from the Subject field.\n*Required*: Yes\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-profile-mappingrule.html#cfn-rolesanywhere-profile-mappingrule-specifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::RolesAnywhere::TrustAnchor.NotificationSetting": { "MarkdownDocumentation": "`AWS::RolesAnywhere::TrustAnchor.NotificationSetting`\n\nCustomizable notification settings that will be applied to notification events.\nIAM Roles Anywhere consumes these settings while notifying across multiple channels - CloudWatch metrics, EventBridge, and AWS Health Dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html", "Properties": { "Channel": { "MarkdownDocumentation": "`Channel`\n\nThe specified channel of notification.\nIAM Roles Anywhere uses CloudWatch metrics, EventBridge, and AWS Health Dashboard to notify for an event.\n###### Note\nIn the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-channel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether the notification setting 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Event": { "MarkdownDocumentation": "`Event`\n\nThe event to which this notification setting is applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CA_CERTIFICATE_EXPIRY | END...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-event", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\nThe number of days before a notification event. This value is required for a notification setting that is enabled.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `360`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-threshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::RolesAnywhere::TrustAnchor.Source": { "MarkdownDocumentation": "`AWS::RolesAnywhere::TrustAnchor.Source`\n\nObject representing the TrustAnchor type and its related certificate data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.html", "Properties": { "SourceType": { "MarkdownDocumentation": "`SourceType`\n\nThe type of the TrustAnchor.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS_ACM_PCA | CERTIFICATE_B...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS_ACM_PCA", "CERTIFICATE_BUNDLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.html#cfn-rolesanywhere-trustanchor-source-sourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceData": { "MarkdownDocumentation": "`SourceData`\n\nA union object representing the data field of the TrustAnchor depending on its type\n*Required*: Yes\n*Type*: [SourceData](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.html#cfn-rolesanywhere-trustanchor-source-sourcedata", "UpdateType": "Mutable", "Required": true, "Type": "SourceData" } } }, "AWS::RolesAnywhere::TrustAnchor.SourceData": { "MarkdownDocumentation": "`AWS::RolesAnywhere::TrustAnchor.SourceData`\n\nA union object representing the data field of the TrustAnchor depending on its type\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.html", "Properties": { "AcmPcaArn": { "MarkdownDocumentation": "`AcmPcaArn`\n\nThe root certificate of the AWS Private Certificate Authority specified by this ARN is used in trust\nvalidation for temporary credential requests. Included for trust anchors of type `AWS_ACM_PCA`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.html#cfn-rolesanywhere-trustanchor-sourcedata-acmpcaarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "X509CertificateData": { "MarkdownDocumentation": "`X509CertificateData`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.html#cfn-rolesanywhere-trustanchor-sourcedata-x509certificatedata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Route53::CidrCollection.Location": { "MarkdownDocumentation": "`AWS::Route53::CidrCollection.Location`\n\nSpecifies the list of CIDR blocks for a CIDR location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html", "Properties": { "CidrList": { "MarkdownDocumentation": "`CidrList`\n\nList of CIDR blocks.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html#cfn-route53-cidrcollection-location-cidrlist", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "LocationName": { "MarkdownDocumentation": "`LocationName`\n\nThe CIDR collection location name.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html#cfn-route53-cidrcollection-location-locationname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53::HealthCheck.AlarmIdentifier": { "MarkdownDocumentation": "`AWS::Route53::HealthCheck.AlarmIdentifier`\n\nA complex type that identifies the CloudWatch alarm that you want Amazon Route 53\nhealth checkers to use to determine whether the specified health check is\nhealthy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html", "Properties": { "Region": { "MarkdownDocumentation": "`Region`\n\nFor the CloudWatch alarm that you want Route 53 health checkers to use to determine\nwhether 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\nquotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web Services General\nReference*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `us-east-1 | us-east-2 | us-...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-west-1", "eu-west-2", "eu-west-3", "ap-east-1", "me-south-1", "me-central-1", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "eu-north-1", "sa-east-1", "cn-northwest-1", "cn-north-1", "af-south-1", "eu-south-1", "eu-south-2", "us-gov-west-1", "us-gov-east-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1", "ap-southeast-4", "il-central-1", "ca-west-1", "ap-southeast-5", "mx-central-1", "us-isof-south-1", "us-isof-east-1", "ap-southeast-7", "ap-east-2", "eu-isoe-west-1", "ap-southeast-6", "us-isob-west-1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use\nto determine whether this health check is healthy.\n###### Note\nRoute 53 supports CloudWatch alarms with the following features:\n* Standard-resolution metrics. High-resolution metrics aren't supported. For\n more information, see [High-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) in the *Amazon CloudWatch User\n Guide*.\n* Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53::HealthCheck.HealthCheckConfig": { "MarkdownDocumentation": "`AWS::Route53::HealthCheck.HealthCheckConfig`\n\nA complex type that contains information about the health check.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html", "Properties": { "EnableSNI": { "MarkdownDocumentation": "`EnableSNI`\n\nSpecify whether you want Amazon Route 53 to send the value of\n`FullyQualifiedDomainName` to the endpoint in the\n`client_hello` message during TLS negotiation. This allows the endpoint\nto respond to `HTTPS` health check requests with the applicable SSL/TLS\ncertificate.\nSome endpoints require that `HTTPS` requests include the host name in the\n`client_hello` message. If you don't enable SNI, the status of the health\ncheck will be `SSL alert handshake_failure`. A health check can also have\nthat status for other reasons. If SNI is enabled and you're still getting the error,\ncheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\nvalid.\nThe SSL/TLS certificate on your endpoint includes a domain name in the `Common\nName` field and possibly several more in the `Subject Alternative\nNames` field. One of the domain names in the certificate should match the\nvalue that you specify for `FullyQualifiedDomainName`. If the endpoint\nresponds to the `client_hello` message with a certificate that does not\ninclude the domain name that you specified in `FullyQualifiedDomainName`, a\nhealth checker will retry the handshake. In the second attempt, the health checker will\nomit `FullyQualifiedDomainName` from the `client_hello`\nmessage.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-enablesni", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ChildHealthChecks": { "MarkdownDocumentation": "`ChildHealthChecks`\n\n(CALCULATED Health Checks Only) A complex type that contains one\n`ChildHealthCheck` element for each health check that you want to\nassociate with a `CALCULATED` health check.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-childhealthchecks", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MeasureLatency": { "MarkdownDocumentation": "`MeasureLatency`\n\nSpecify whether you want Amazon Route 53 to measure the latency between health\ncheckers in multiple AWS regions and your endpoint, and to display\nCloudWatch latency graphs on the **Health Checks** page in\nthe Route 53 console.\n`MeasureLatency` is not supported when you specify a value for\n`Type` of `RECOVERY_CONTROL`.\n###### Important\nYou can't change the value of `MeasureLatency` after you create a\nhealth 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-measurelatency", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port on the endpoint that you want Amazon Route 53 to perform health checks on.\n###### Note\nDon't specify a value for `Port` when you specify a value for\n[Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type)\nof `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Regions": { "MarkdownDocumentation": "`Regions`\n\nA complex type that contains one `Region` element for each region from\nwhich 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\nchecks from all of the regions that are listed under **Valid\nValues**.\nIf you update a health check to remove a region that has been performing health\nchecks, Route 53 will briefly continue to perform checks from that region to ensure that\nsome health checkers are always checking the endpoint (for example, if you replace three\nregions with four different regions).\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-regions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "InsufficientDataHealthStatus": { "MarkdownDocumentation": "`InsufficientDataHealthStatus`\n\nWhen CloudWatch has insufficient data about the metric to determine the alarm state,\nthe status that you want Amazon Route 53 to assign to the health check:\n* `Healthy`: Route 53 considers the health check to be\n healthy.\n* `Unhealthy`: Route 53 considers the health check to be\n unhealthy.\n* `LastKnownStatus`: Route 53 uses the status of the health check\n from the last time that CloudWatch had sufficient data to determine the alarm\n state. For new health checks that have no last known status, the default status\n for the health check is healthy.\n*Required*: No\n*Type*: String\n*Allowed values*: `Healthy | LastKnownStatus |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Healthy", "LastKnownStatus", "Unhealthy" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-insufficientdatahealthstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SearchString": { "MarkdownDocumentation": "`SearchString`\n\nIf the value of Type is `HTTP_STR_MATCH` or `HTTPS_STR_MATCH`,\nthe string that you want Amazon Route 53 to search for in the response body from the\nspecified resource. If the string appears in the response body, Route 53 considers the\nresource healthy.\nRoute 53 considers case when searching for `SearchString` in the response\nbody.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of health check that you want to create, which indicates how Amazon Route 53\ndetermines whether an endpoint is healthy.\n###### Important\nYou can't change the value of `Type` after you create a health\ncheck.\nYou can create the following types of health checks:\n* **HTTP**: Route 53 tries to establish a TCP\n connection. If successful, Route 53 submits an HTTP request and waits for an\n HTTP status code of 200 or greater and less than 400.\n* **HTTPS**: Route 53 tries to establish a TCP\n connection. If successful, Route 53 submits an HTTPS request and waits for an\n HTTP status code of 200 or greater and less than 400.\n \n ###### Important\n \n If you specify `HTTPS` for the value of `Type`, the\n endpoint must support TLS v1.0 or later.\n* **HTTP\\_STR\\_MATCH**: Route 53 tries to establish a\n TCP connection. If successful, Route 53 submits an HTTP request and searches the\n first 5,120 bytes of the response body for the string that you specify in\n `SearchString`.\n* **HTTPS\\_STR\\_MATCH**: Route 53 tries to establish\n a TCP connection. If successful, Route 53 submits an `HTTPS` request\n and searches the first 5,120 bytes of the response body for the string that you\n specify in `SearchString`.\n* **TCP**: Route 53 tries to establish a TCP\n connection.\n* **CLOUDWATCH\\_METRIC**: The health check is\n associated with a CloudWatch alarm. If the state of the alarm is\n `OK`, the health check is considered healthy. If the state is\n `ALARM`, the health check is considered unhealthy. If CloudWatch\n doesn't have sufficient data to determine whether the state is `OK`\n or `ALARM`, the health check status depends on the setting for\n `InsufficientDataHealthStatus`: `Healthy`,\n `Unhealthy`, or `LastKnownStatus`.\n \n ###### Note\n \n Route 53 supports CloudWatch alarms with the following features:\n \n + Standard-resolution metrics. High-resolution metrics aren't supported. For\n more information, see [High-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) in the *Amazon CloudWatch User\n Guide*.\n + Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended\n statistics aren't supported.\n* **CALCULATED**: For health checks that monitor\n the status of other health checks, Route 53 adds up the number of health checks\n that Route 53 health checkers consider to be healthy and compares that number\n with the value of `HealthThreshold`.\n* **RECOVERY\\_CONTROL**: The health check is\n assocated with a Route53 Application Recovery Controller routing control. If the\n routing control state is `ON`, the health check is considered\n healthy. If the state is `OFF`, the health check is considered\n 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\n*Amazon Route 53 Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CALCULATED | CLOUDWATCH_MET...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CALCULATED", "CLOUDWATCH_METRIC", "HTTP", "HTTP_STR_MATCH", "HTTPS", "HTTPS_STR_MATCH", "TCP", "RECOVERY_CONTROL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourcePath": { "MarkdownDocumentation": "`ResourcePath`\n\nThe path, if any, that you want Amazon Route 53 to request when performing health\nchecks. The path can be any value for which your endpoint will return an HTTP status\ncode of 2xx or 3xx when the endpoint is healthy, for example, the file\n/docs/route53-health-check.html. You can also include query string parameters, for\nexample, `/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-resourcepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoutingControlArn": { "MarkdownDocumentation": "`RoutingControlArn`\n\nThe Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller\nrouting 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-routingcontrolarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FullyQualifiedDomainName": { "MarkdownDocumentation": "`FullyQualifiedDomainName`\n\nAmazon 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`\nin the `Host` header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint\non 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\n `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\n `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\n `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\n`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\n`RequestInterval`. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.\n###### Note\nIf you don't specify a value for `IPAddress`, Route 53 uses only IPv4 to send health checks to the endpoint. If there's\nno record with a type of A for the name that you specify for `FullyQualifiedDomainName`, the health check fails with a\n\"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\nchoose to specify the endpoint only by `FullyQualifiedDomainName`, we recommend that you create a separate health check\nfor each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of\n`FullyQualifiedDomainName`, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the\nrecords (www.example.com).\n###### Important\nIn this configuration, if you create a health check for which the value of `FullyQualifiedDomainName` matches the name of the\nrecords 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\n`HTTPS_STR_MATCH`, Route 53 passes the value of `FullyQualifiedDomainName` in the `Host` header, as it does when you\nspecify 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Inverted": { "MarkdownDocumentation": "`Inverted`\n\nSpecify whether you want Amazon Route 53 to invert the status of a health check, for\nexample, to consider a health check unhealthy when it otherwise would be considered\nhealthy.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-inverted", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "HealthThreshold": { "MarkdownDocumentation": "`HealthThreshold`\n\nThe number of child health checks that are associated with a `CALCULATED`\nhealth check that Amazon Route 53 must consider healthy for the `CALCULATED`\nhealth check to be considered healthy. To specify the child health checks that you want\nto 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\n 53 always considers this health check to be unhealthy.\n* If you specify `0`, Route 53 always considers this health check to\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-healththreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RequestInterval": { "MarkdownDocumentation": "`RequestInterval`\n\nThe number of seconds between the time that Amazon Route 53 gets a response from your\nendpoint and the time that it sends the next health check request. Each Route 53 health\nchecker makes requests at this interval.\n`RequestInterval` is not supported when you specify a value for\n`Type` of `RECOVERY_CONTROL`.\n###### Important\nYou can't change the value of `RequestInterval` after you create a\nhealth check.\nIf you don't specify a value for `RequestInterval`, the default value is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-requestinterval", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "AlarmIdentifier": { "MarkdownDocumentation": "`AlarmIdentifier`\n\nA complex type that identifies the CloudWatch alarm that you want Amazon Route 53\nhealth checkers to use to determine whether the specified health check is\nhealthy.\n*Required*: No\n*Type*: [AlarmIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-alarmidentifier", "UpdateType": "Mutable", "Required": false, "Type": "AlarmIdentifier" }, "FailureThreshold": { "MarkdownDocumentation": "`FailureThreshold`\n\nThe number of consecutive health checks that an endpoint must pass or fail for Amazon\nRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\nversa. 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\n*Amazon Route 53 Developer Guide*.\n`FailureThreshold` is not supported when you specify a value for\n`Type` of `RECOVERY_CONTROL`.\nOtherwise, if you don't specify a value for `FailureThreshold`, the default value is\nthree 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IPAddress": { "MarkdownDocumentation": "`IPAddress`\n\nThe IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform\nhealth checks on. If you don't specify a value for `IPAddress`, Route 53\nsends a DNS request to resolve the domain name that you specify in\n`FullyQualifiedDomainName` at the interval that you specify in\n`RequestInterval`. Using an IP address returned by DNS, Route 53 then\nchecks 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,\n separated by periods (.), for example, `192.0.2.44`.\n* **IPv6 address**: eight groups of four\n hexadecimal values, separated by colons (:), for example,\n `2001:0db8:85a3:0000:0000:abcd:0001:2345`. You can also shorten\n IPv6 addresses as described in RFC 5952, for example,\n `2001:db8:85a3::abcd:1:2345`.\nIf the endpoint is an EC2 instance, we recommend that you create an Elastic IP\naddress, associate it with your EC2 instance, and specify the Elastic IP address for\n`IPAddress`. This ensures that the IP address of your instance will never\nchange.\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\nin local, private, non-routable, or multicast ranges. For more information about IP\naddresses for which you can't create health checks, see the following documents:\n* [RFC 5735, Special Use IPv4\n Addresses](https://tools.ietf.org/html/rfc5735)\n* [RFC 6598, IANA-Reserved IPv4\n Prefix for Shared Address Space](https://tools.ietf.org/html/rfc6598)\n* [RFC 5156, Special-Use IPv6\n Addresses](https://tools.ietf.org/html/rfc5156)\nWhen the value of `Type` is `CALCULATED` or\n`CLOUDWATCH_METRIC`, omit `IPAddress`.\n*Required*: No\n*Type*: String\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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-ipaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Route53::HealthCheck.HealthCheckTag": { "MarkdownDocumentation": "`AWS::Route53::HealthCheck.HealthCheckTag`\n\nThe `HealthCheckTag` property describes one key-value pair that is associated with an `AWS::Route53::HealthCheck` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of `Value` depends on the operation that you want to\nperform:\n* **Add a tag to a health check or hosted zone**:\n `Value` is the value that you want to give the new tag.\n* **Edit a tag**: `Value` is the new\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe value of `Key` depends on the operation that you want to\nperform:\n* **Add a tag to a health check or hosted zone**:\n `Key` is the name that you want to give the new tag.\n* **Edit a tag**: `Key` is the name of\n the tag that you want to change the `Value` for.\n* **Delete a key**: `Key` is the name\n of the tag you want to remove.\n* **Give a name to a health check**: Edit the\n default `Name` tag. In the Amazon Route 53 console, the list of your\n health checks includes a **Name** column that lets\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthcheck-healthchecktag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53::HostedZone.HostedZoneConfig": { "MarkdownDocumentation": "`AWS::Route53::HostedZone.HostedZoneConfig`\n\nA complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the\n`HostedZoneConfig` and `Comment` elements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nAny comments that you want to include about the hosted zone.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html#cfn-route53-hostedzone-hostedzoneconfig-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Route53::HostedZone.HostedZoneFeatures": { "MarkdownDocumentation": "`AWS::Route53::HostedZone.HostedZoneFeatures`\n\nRepresents the features configuration for a hosted zone, including the status of various features and any associated failure reasons.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonefeatures.html", "Properties": { "EnableAcceleratedRecovery": { "MarkdownDocumentation": "`EnableAcceleratedRecovery`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonefeatures.html#cfn-route53-hostedzone-hostedzonefeatures-enableacceleratedrecovery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Route53::HostedZone.HostedZoneTag": { "MarkdownDocumentation": "`AWS::Route53::HostedZone.HostedZoneTag`\n\nA complex type that contains information about a tag that you want to add or edit for\nthe specified health check or hosted zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of `Value` depends on the operation that you want to\nperform:\n* **Add a tag to a health check or hosted zone**:\n `Value` is the value that you want to give the new tag.\n* **Edit a tag**: `Value` is the new\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html#cfn-route53-hostedzone-hostedzonetag-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe value of `Key` depends on the operation that you want to\nperform:\n* **Add a tag to a health check or hosted zone**:\n `Key` is the name that you want to give the new tag.\n* **Edit a tag**: `Key` is the name of\n the tag that you want to change the `Value` for.\n* **Delete a key**: `Key` is the name\n of the tag you want to remove.\n* **Give a name to a health check**: Edit the\n default `Name` tag. In the Amazon Route 53 console, the list of your\n health checks includes a **Name** column that lets\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetag.html#cfn-route53-hostedzone-hostedzonetag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53::HostedZone.QueryLoggingConfig": { "MarkdownDocumentation": "`AWS::Route53::HostedZone.QueryLoggingConfig`\n\nA complex type that contains information about a configuration for DNS query\nlogging.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html", "Properties": { "CloudWatchLogsLogGroupArn": { "MarkdownDocumentation": "`CloudWatchLogsLogGroupArn`\n\nThe Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53\nis publishing logs 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html#cfn-route53-hostedzone-queryloggingconfig-cloudwatchlogsloggrouparn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53::HostedZone.VPC": { "MarkdownDocumentation": "`AWS::Route53::HostedZone.VPC`\n\n*Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver\nuses the records in the private hosted zone to route traffic in that VPC.\n###### Note\nFor public hosted zones, omit `VPCs`, `VPCId`, and `VPCRegion`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html", "Properties": { "VPCRegion": { "MarkdownDocumentation": "`VPCRegion`\n\n*Private hosted zones only:* The region that an Amazon VPC was created in.\n###### Note\nFor public hosted zones, omit `VPCs`, `VPCId`, and `VPCRegion`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `us-east-1 | us-east-2 | us-...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-central-2", "ap-east-1", "me-south-1", "us-gov-west-1", "us-gov-east-1", "us-iso-east-1", "us-iso-west-1", "us-isob-east-1", "me-central-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-south-1", "ap-south-2", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "eu-north-1", "sa-east-1", "ca-central-1", "cn-north-1", "cn-northwest-1", "af-south-1", "eu-south-1", "eu-south-2", "ap-southeast-4", "il-central-1", "ca-west-1", "ap-southeast-5", "mx-central-1", "us-isof-south-1", "us-isof-east-1", "ap-southeast-7", "ap-east-2", "eu-isoe-west-1", "ap-southeast-6", "us-isob-west-1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html#cfn-route53-hostedzone-vpc-vpcregion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VPCId": { "MarkdownDocumentation": "`VPCId`\n\n*Private hosted zones only:* The ID of an Amazon VPC.\n###### Note\nFor public hosted zones, omit `VPCs`, `VPCId`, and `VPCRegion`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html#cfn-route53-hostedzone-vpc-vpcid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53::RecordSet.AliasTarget": { "MarkdownDocumentation": "`AWS::Route53::RecordSet.AliasTarget`\n\n*Alias records only:* Information about the AWS resource, such as a CloudFront distribution or\nan Amazon S3 bucket, that you want to route traffic to.\nWhen creating records for a private hosted zone, note the following:\n* Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported.\n* For information about creating failover records in a private hosted zone, see\n [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html", "Properties": { "DNSName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "EvaluateTargetHealth": { "MarkdownDocumentation": "`EvaluateTargetHealth`\n\n*Applies only to alias, failover alias, geolocation alias, latency alias, and\nweighted alias resource record sets:* When\n`EvaluateTargetHealth` is `true`, an alias resource record set\ninherits the health of the referenced AWS resource, such as an ELB load\nbalancer or another resource record set in the hosted zone.\nNote the following:\nCloudFront distributions\nYou can't set `EvaluateTargetHealth` to `true` when\nthe alias target is a CloudFront distribution.\n\nElastic Beanstalk environments that have regionalized subdomains\nIf you specify an Elastic Beanstalk environment in `DNSName`\nand the environment contains an ELB load balancer, Elastic Load Balancing\nroutes queries only to the healthy Amazon EC2 instances that are registered\nwith the load balancer. (An environment automatically contains an ELB load\nbalancer if it includes more than one Amazon EC2 instance.) If you set\n`EvaluateTargetHealth` to `true` and either no\nAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\nRoute 53 routes queries to other available resources that are healthy, if\nany.\nIf the environment contains a single Amazon EC2 instance, there are no\nspecial requirements.\n\nELB load balancers\nHealth checking behavior depends on the type of load balancer:\n* **Classic Load Balancers**: If you\n specify an ELB Classic Load Balancer in `DNSName`,\n Elastic Load Balancing routes queries only to the healthy Amazon EC2\n instances that are registered with the load balancer. If you set\n `EvaluateTargetHealth` to `true` and\n either no EC2 instances are healthy or the load balancer itself is\n unhealthy, Route 53 routes queries to other resources.\n* **Application and Network Load\n Balancers**: If you specify an ELB Application or\n Network Load Balancer and you set `EvaluateTargetHealth`\n to `true`, Route 53 routes queries to the load balancer\n based on the health of the target groups that are associated with\n the load balancer:\n \n + For an Application or Network Load Balancer to be\n considered healthy, every target group that contains targets\n must contain at least one healthy target. If any target\n group contains only unhealthy targets, the load balancer is\n considered unhealthy, and Route 53 routes queries to other\n resources.\n + A target group that has no registered targets is\n considered unhealthy.\n###### Note\nWhen you create a load balancer, you configure settings for Elastic\nLoad Balancing health checks; they're not Route 53 health checks, but\nthey perform a similar function. Do not create Route 53 health checks\nfor the EC2 instances that you register with an ELB load balancer.\n\nAPI Gateway APIs\nThere are no special requirements for setting\n`EvaluateTargetHealth` to `true` when the alias\ntarget is an API Gateway API. However, because API Gateway is highly\navailable by design, `EvaluateTargetHealth` provides no\noperational benefit and [Route 53 health\nchecks](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) are recommended instead for failover scenarios.\n\nS3 buckets\nThere are no special requirements for setting\n`EvaluateTargetHealth` to `true` when the alias\ntarget is an S3 bucket. However, because S3 buckets are highly available by\ndesign, `EvaluateTargetHealth` provides no operational benefit\nand [Route 53 health\nchecks](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) are recommended instead for failover scenarios.\n\nVPC interface endpoints\nThere are no special requirements for setting\n`EvaluateTargetHealth` to `true` when the alias\ntarget is a VPC interface endpoint. However, because VPC interface endpoints\nare highly available by design, `EvaluateTargetHealth` provides\nno operational benefit and [Route 53 health\nchecks](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) are recommended instead for failover scenarios.\n\nOther records in the same hosted zone\nIf the AWS resource that you specify in\n`DNSName` is a record or a group of records (for example, a\ngroup of weighted records) but is not another alias record, we recommend\nthat you associate a health check with all of the records in the alias\ntarget. 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\n*Amazon Route 53 Developer Guide*.\n\n###### Note\nWhile `EvaluateTargetHealth` can be set to `true` for highly\navailable AWS services (such as S3 buckets, VPC interface endpoints,\nand API Gateway), these services are designed for high availability and rarely\nexperience outages that would be detected by this feature. For failover scenarios\nwith these services, consider using [Route 53 health\nchecks](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) that monitor your application's ability to access the service\ninstead.\nFor more information and examples, see [Amazon Route 53 Health Checks\nand DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in the *Amazon Route 53 Developer\nGuide*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\n*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\n[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`.\n\nAmazon Virtual Private Cloud interface VPC endpoint\nSpecify the hosted zone ID for your interface endpoint. You can get the value of `HostedZoneId`\nusing the AWS CLI command\n[describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html).\n\nCloudFront distribution\nSpecify `Z2FDTNDATAQYW2`. This is always the hosted zone ID when you create an alias record that\nroutes traffic to a CloudFront distribution.\n###### Note\nAlias records for CloudFront can't be created in a private zone.\n\nElastic Beanstalk environment\nSpecify the hosted zone ID for the region that you created the environment in. The environment\nmust have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see\n[AWS Elastic Beanstalk endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the *Amazon Web Services General Reference*.\n\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\n in the \"Elastic Load Balancing Endpoints and Quotas\" topic in the\n *Amazon Web Services General Reference*: Use the value that corresponds with\n the region that you created your load balancer in. Note that there are separate columns for\n Application and Classic Load Balancers and for Network Load Balancers.\n* **AWS Management Console**: Go to the Amazon EC2 page, choose\n **Load Balancers** in the navigation pane, select the load balancer, and get the value of the\n **Hosted zone** field on the **Description** tab.\n* **Elastic Load Balancing API**: Use `DescribeLoadBalancers` to get the applicable value.\n For more information, see the applicable guide:\n \n + Classic Load Balancers: Use\n [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html)\n to get the value of `CanonicalHostedZoneNameID`.\n + Application and Network Load Balancers: Use\n [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)\n to get the value of `CanonicalHostedZoneID`.\n* **CloudFormation Fn::GetAtt intrinsic function**: Use the\n [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)\n intrinsic function to get the applicable value:\n \n + Classic Load Balancers: Get\n [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\n [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.\n For more information, see the applicable guide:\n \n + Classic Load Balancers: Use\n [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)\n to get the value of `CanonicalHostedZoneNameID`.\n + Application and Network Load Balancers: Use\n [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html)\n to get the value of `CanonicalHostedZoneID`.\n\nGlobal Accelerator accelerator\nSpecify `Z2BJ6XQ5FK7U4H`.\n\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\nvalid values, see the table\n[Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints)\nin the *Amazon Web Services General Reference*.\n\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\nin a different hosted zone.)\n\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSet.CidrRoutingConfig": { "MarkdownDocumentation": "`AWS::Route53::RecordSet.CidrRoutingConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html", "Properties": { "CollectionId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-collectionid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LocationName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-locationname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSet.Coordinates": { "MarkdownDocumentation": "`AWS::Route53::RecordSet.Coordinates`\n\nA complex type that lists the coordinates for a geoproximity resource record.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-coordinates.html", "Properties": { "Latitude": { "MarkdownDocumentation": "`Latitude`\n\nSpecifies a coordinate of the north\u2013south position of a geographic point on the surface of\nthe Earth (-90 - 90).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[-+]?[0-9]{1,2}(\\.[0-9]{0,2})?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-coordinates.html#cfn-route53-recordset-coordinates-latitude", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Longitude": { "MarkdownDocumentation": "`Longitude`\n\nSpecifies a coordinate of the east\u2013west position of a geographic point on the surface of\nthe Earth (-180 - 180).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[-+]?[0-9]{1,3}(\\.[0-9]{0,2})?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-coordinates.html#cfn-route53-recordset-coordinates-longitude", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSet.GeoLocation": { "MarkdownDocumentation": "`AWS::Route53::RecordSet.GeoLocation`\n\nA complex type that contains information about a geographic location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html", "Properties": { "ContinentCode": { "MarkdownDocumentation": "`ContinentCode`\n\nFor 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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CountryCode": { "MarkdownDocumentation": "`CountryCode`\n\nFor geolocation resource record sets, the two-letter code for a country.\nRoute 53 uses the two-letter country codes that are specified in\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SubdivisionCode": { "MarkdownDocumentation": "`SubdivisionCode`\n\nFor geolocation resource record sets, the two-letter code for a state of the United States.\nRoute 53 doesn't support any other values for `SubdivisionCode`. For a list of state abbreviations, see\n[Appendix B: Two\u2013Letter State and Possession Abbreviations](https://pe.usps.com/text/pub28/28apb.htm)\non 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSet.GeoProximityLocation": { "MarkdownDocumentation": "`AWS::Route53::RecordSet.GeoProximityLocation`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html", "Properties": { "AWSRegion": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html#cfn-route53-geoproximitylocation-awsregion", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Bias": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html#cfn-route53-geoproximitylocation-bias", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "Coordinates": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html#cfn-route53-geoproximitylocation-coordinates", "Required": false, "Type": "Coordinates", "UpdateType": "Mutable" }, "LocalZoneGroup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html#cfn-route53-geoproximitylocation-LocalZoneGroup", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSetGroup.AliasTarget": { "MarkdownDocumentation": "`AWS::Route53::RecordSetGroup.AliasTarget`\n\n*Alias records only:* Information about the AWS resource, such as a CloudFront distribution or\nan Amazon S3 bucket, that you want to route traffic to.\nWhen creating records for a private hosted zone, note the following:\n* Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported.\n* For information about creating failover records in a private hosted zone, see\n [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html", "Properties": { "DNSName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "EvaluateTargetHealth": { "MarkdownDocumentation": "`EvaluateTargetHealth`\n\n*Applies only to alias, failover alias, geolocation alias, latency alias, and\nweighted alias resource record sets:* When\n`EvaluateTargetHealth` is `true`, an alias resource record set\ninherits the health of the referenced AWS resource, such as an ELB load\nbalancer or another resource record set in the hosted zone.\nNote the following:\nCloudFront distributions\nYou can't set `EvaluateTargetHealth` to `true` when\nthe alias target is a CloudFront distribution.\n\nElastic Beanstalk environments that have regionalized subdomains\nIf you specify an Elastic Beanstalk environment in `DNSName`\nand the environment contains an ELB load balancer, Elastic Load Balancing\nroutes queries only to the healthy Amazon EC2 instances that are registered\nwith the load balancer. (An environment automatically contains an ELB load\nbalancer if it includes more than one Amazon EC2 instance.) If you set\n`EvaluateTargetHealth` to `true` and either no\nAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\nRoute 53 routes queries to other available resources that are healthy, if\nany.\nIf the environment contains a single Amazon EC2 instance, there are no\nspecial requirements.\n\nELB load balancers\nHealth checking behavior depends on the type of load balancer:\n* **Classic Load Balancers**: If you\n specify an ELB Classic Load Balancer in `DNSName`,\n Elastic Load Balancing routes queries only to the healthy Amazon EC2\n instances that are registered with the load balancer. If you set\n `EvaluateTargetHealth` to `true` and\n either no EC2 instances are healthy or the load balancer itself is\n unhealthy, Route 53 routes queries to other resources.\n* **Application and Network Load\n Balancers**: If you specify an ELB Application or\n Network Load Balancer and you set `EvaluateTargetHealth`\n to `true`, Route 53 routes queries to the load balancer\n based on the health of the target groups that are associated with\n the load balancer:\n \n + For an Application or Network Load Balancer to be\n considered healthy, every target group that contains targets\n must contain at least one healthy target. If any target\n group contains only unhealthy targets, the load balancer is\n considered unhealthy, and Route 53 routes queries to other\n resources.\n + A target group that has no registered targets is\n considered unhealthy.\n###### Note\nWhen you create a load balancer, you configure settings for Elastic\nLoad Balancing health checks; they're not Route 53 health checks, but\nthey perform a similar function. Do not create Route 53 health checks\nfor the EC2 instances that you register with an ELB load balancer.\n\nAPI Gateway APIs\nThere are no special requirements for setting\n`EvaluateTargetHealth` to `true` when the alias\ntarget is an API Gateway API. However, because API Gateway is highly\navailable by design, `EvaluateTargetHealth` provides no\noperational benefit and [Route 53 health\nchecks](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) are recommended instead for failover scenarios.\n\nS3 buckets\nThere are no special requirements for setting\n`EvaluateTargetHealth` to `true` when the alias\ntarget is an S3 bucket. However, because S3 buckets are highly available by\ndesign, `EvaluateTargetHealth` provides no operational benefit\nand [Route 53 health\nchecks](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) are recommended instead for failover scenarios.\n\nVPC interface endpoints\nThere are no special requirements for setting\n`EvaluateTargetHealth` to `true` when the alias\ntarget is a VPC interface endpoint. However, because VPC interface endpoints\nare highly available by design, `EvaluateTargetHealth` provides\nno operational benefit and [Route 53 health\nchecks](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) are recommended instead for failover scenarios.\n\nOther records in the same hosted zone\nIf the AWS resource that you specify in\n`DNSName` is a record or a group of records (for example, a\ngroup of weighted records) but is not another alias record, we recommend\nthat you associate a health check with all of the records in the alias\ntarget. 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\n*Amazon Route 53 Developer Guide*.\n\n###### Note\nWhile `EvaluateTargetHealth` can be set to `true` for highly\navailable AWS services (such as S3 buckets, VPC interface endpoints,\nand API Gateway), these services are designed for high availability and rarely\nexperience outages that would be detected by this feature. For failover scenarios\nwith these services, consider using [Route 53 health\nchecks](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) that monitor your application's ability to access the service\ninstead.\nFor more information and examples, see [Amazon Route 53 Health Checks\nand DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in the *Amazon Route 53 Developer\nGuide*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\n*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\n[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`.\n\nAmazon Virtual Private Cloud interface VPC endpoint\nSpecify the hosted zone ID for your interface endpoint. You can get the value of `HostedZoneId`\nusing the AWS CLI command\n[describe-vpc-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html).\n\nCloudFront distribution\nSpecify `Z2FDTNDATAQYW2`. This is always the hosted zone ID when you create an alias record that\nroutes traffic to a CloudFront distribution.\n###### Note\nAlias records for CloudFront can't be created in a private zone.\n\nElastic Beanstalk environment\nSpecify the hosted zone ID for the region that you created the environment in. The environment\nmust have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see\n[AWS Elastic Beanstalk endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the *Amazon Web Services General Reference*.\n\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\n in the \"Elastic Load Balancing Endpoints and Quotas\" topic in the\n *Amazon Web Services General Reference*: Use the value that corresponds with\n the region that you created your load balancer in. Note that there are separate columns for\n Application and Classic Load Balancers and for Network Load Balancers.\n* **AWS Management Console**: Go to the Amazon EC2 page, choose\n **Load Balancers** in the navigation pane, select the load balancer, and get the value of the\n **Hosted zone** field on the **Description** tab.\n* **Elastic Load Balancing API**: Use `DescribeLoadBalancers` to get the applicable value.\n For more information, see the applicable guide:\n \n + Classic Load Balancers: Use\n [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html)\n to get the value of `CanonicalHostedZoneNameID`.\n + Application and Network Load Balancers: Use\n [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)\n to get the value of `CanonicalHostedZoneID`.\n* **CloudFormation Fn::GetAtt intrinsic function**: Use the\n [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)\n intrinsic function to get the applicable value:\n \n + Classic Load Balancers: Get\n [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\n [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.\n For more information, see the applicable guide:\n \n + Classic Load Balancers: Use\n [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)\n to get the value of `CanonicalHostedZoneNameID`.\n + Application and Network Load Balancers: Use\n [describe-load-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html)\n to get the value of `CanonicalHostedZoneID`.\n\nGlobal Accelerator accelerator\nSpecify `Z2BJ6XQ5FK7U4H`.\n\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\nvalid values, see the table\n[Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints)\nin the *Amazon Web Services General Reference*.\n\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\nin a different hosted zone.)\n\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSetGroup.CidrRoutingConfig": { "MarkdownDocumentation": "`AWS::Route53::RecordSetGroup.CidrRoutingConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html", "Properties": { "CollectionId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-collectionid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LocationName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html#cfn-route53-cidrroutingconfig-locationname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSetGroup.Coordinates": { "MarkdownDocumentation": "`AWS::Route53::RecordSetGroup.Coordinates`\n\nA complex type that lists the coordinates for a geoproximity resource record.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-coordinates.html", "Properties": { "Latitude": { "MarkdownDocumentation": "`Latitude`\n\nSpecifies a coordinate of the north\u2013south position of a geographic point on the surface of\nthe Earth (-90 - 90).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[-+]?[0-9]{1,2}(\\.[0-9]{0,2})?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-coordinates.html#cfn-route53-recordsetgroup-coordinates-latitude", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Longitude": { "MarkdownDocumentation": "`Longitude`\n\nSpecifies a coordinate of the east\u2013west position of a geographic point on the surface of\nthe Earth (-180 - 180).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[-+]?[0-9]{1,3}(\\.[0-9]{0,2})?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-coordinates.html#cfn-route53-recordsetgroup-coordinates-longitude", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSetGroup.GeoLocation": { "MarkdownDocumentation": "`AWS::Route53::RecordSetGroup.GeoLocation`\n\nA complex type that contains information about a geographic location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html", "Properties": { "ContinentCode": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordsetgroup-geolocation-continentcode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CountryCode": { "MarkdownDocumentation": "`CountryCode`\n\nFor geolocation resource record sets, the two-letter code for a country.\nRoute 53 uses the two-letter country codes that are specified in\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SubdivisionCode": { "MarkdownDocumentation": "`SubdivisionCode`\n\nFor geolocation resource record sets, the two-letter code for a state of the United States.\nRoute 53 doesn't support any other values for `SubdivisionCode`. For a list of state abbreviations, see\n[Appendix B: Two\u2013Letter State and Possession Abbreviations](https://pe.usps.com/text/pub28/28apb.htm)\non 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSetGroup.GeoProximityLocation": { "MarkdownDocumentation": "`AWS::Route53::RecordSetGroup.GeoProximityLocation`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html", "Properties": { "AWSRegion": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html#cfn-route53-geoproximitylocation-awsregion", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Bias": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html#cfn-route53-geoproximitylocation-bias", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "Coordinates": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html#cfn-route53-geoproximitylocation-coordinates", "Required": false, "Type": "Coordinates", "UpdateType": "Mutable" }, "LocalZoneGroup": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-geoproximitylocation.html#cfn-route53-geoproximitylocation-LocalZoneGroup", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSetGroup.RecordSet": { "MarkdownDocumentation": "`AWS::Route53::RecordSetGroup.RecordSet`\n\nInformation about the record that you want to create.\nThe `AWS::Route53::RecordSet` type can be used as a standalone resource or as an embedded property in the\n`AWS::Route53::RecordSetGroup` type. Note that some `AWS::Route53::RecordSet` properties are valid\nonly when used within `AWS::Route53::RecordSetGroup`.\nFor more information, see [ChangeResourceRecordSets](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html)\nin the *Amazon Route 53 API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html", "Properties": { "AliasTarget": { "MarkdownDocumentation": "`AliasTarget`\n\n*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that\nyou want to route traffic to.\nIf you're creating resource records sets for a private hosted zone, note the\nfollowing:\n* You can't create an alias resource record set in a private hosted zone to\n route traffic to a CloudFront distribution.\n* For information about creating failover resource record sets in a private\n 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\n *Amazon Route 53 Developer Guide*.\n*Required*: No\n*Type*: [AliasTarget](./aws-properties-route53-recordset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget", "Required": false, "Type": "AliasTarget", "UpdateType": "Mutable" }, "CidrRoutingConfig": { "MarkdownDocumentation": "`CidrRoutingConfig`\n\nThe object that is specified in resource record set object when you are linking a\nresource record set to a CIDR location.\nA `LocationName` with an asterisk \u201c\\*\u201d can be used to create a default CIDR\nrecord. `CollectionId` is still required for default record.\n*Required*: No\n*Type*: [CidrRoutingConfig](./aws-properties-route53-recordset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-cidrroutingconfig", "Required": false, "Type": "CidrRoutingConfig", "UpdateType": "Mutable" }, "Failover": { "MarkdownDocumentation": "`Failover`\n\n*Failover resource record sets only:* To configure failover, you\nadd the `Failover` element to two resource record sets. For one resource\nrecord set, you specify `PRIMARY` as the value for `Failover`; for\nthe other resource record set, you specify `SECONDARY`. In addition, you\ninclude the `HealthCheckId` element and specify the health check that you\nwant Amazon Route 53 to perform for each resource record set.\nExcept where noted, the following failover behaviors assume that you have included the\n`HealthCheckId` element in both resource record sets:\n* When the primary resource record set is healthy, Route 53 responds to DNS\n queries with the applicable value from the primary resource record set\n regardless of the health of the secondary resource record set.\n* When the primary resource record set is unhealthy and the secondary resource\n record set is healthy, Route 53 responds to DNS queries with the applicable\n value from the secondary resource record set.\n* When the secondary resource record set is unhealthy, Route 53 responds to DNS\n queries with the applicable value from the primary resource record set\n regardless of the health of the primary resource record set.\n* If you omit the `HealthCheckId` element for the secondary resource\n record set, and if the primary resource record set is unhealthy, Route 53 always\n responds to DNS queries with the applicable value from the secondary resource\n record set. This is true regardless of the health of the associated\n endpoint.\nYou can't create non-failover resource record sets that have the same values for the\n`Name` and `Type` elements as failover resource record\nsets.\nFor failover alias resource record sets, you must also include the\n`EvaluateTargetHealth` element and set the value to true.\nFor more information about configuring failover for Route 53, see the following topics\nin the *Amazon Route 53 Developer Guide*:\n* [Route 53 Health Checks\n 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)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY", "SECONDARY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "GeoLocation": { "MarkdownDocumentation": "`GeoLocation`\n\n*Geolocation resource record sets only:* A complex type that lets you\ncontrol how Amazon Route 53 responds to DNS queries based on the geographic origin of\nthe query. For example, if you want all queries from Africa to be routed to a web server\nwith an IP address of `192.0.2.111`, create a resource record set with a\n`Type` of `A` and a `ContinentCode` of\n`AF`.\nIf you create separate resource record sets for overlapping geographic regions (for\nexample, one resource record set for a continent and one for a country on the same\ncontinent), priority goes to the smallest geographic region. This allows you to route\nmost queries for a continent to one resource and to route queries for a country on that\ncontinent to a different resource.\nYou can't create two geolocation resource record sets that specify the same geographic\nlocation.\nThe value `*` in the `CountryCode` element matches all\ngeographic locations that aren't specified in other geolocation resource record sets\nthat have the same values for the `Name` and `Type`\nelements.\n###### Important\nGeolocation works by mapping IP addresses to locations. However, some IP addresses\naren't mapped to geographic locations, so even if you create geolocation resource\nrecord sets that cover all seven continents, Route 53 will receive some DNS queries\nfrom locations that it can't identify. We recommend that you create a resource\nrecord set for which the value of `CountryCode` is `*`. Two\ngroups of queries are routed to the resource that you specify in this record:\nqueries that come from locations for which you haven't created geolocation resource\nrecord sets and queries from IP addresses that aren't mapped to a location. If you\ndon't create a `*` resource record set, Route 53 returns a \"no answer\"\nresponse for queries from those locations.\nYou can't create non-geolocation resource record sets that have the same values for\nthe `Name` and `Type` elements as geolocation resource record\nsets.\n*Required*: No\n*Type*: [GeoLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation", "Required": false, "Type": "GeoLocation", "UpdateType": "Mutable" }, "GeoProximityLocation": { "MarkdownDocumentation": "`GeoProximityLocation`\n\n *GeoproximityLocation resource record sets only:* A complex type that lets you control how\nRoute\u00a053 responds to DNS queries based on the geographic origin of the\nquery and your resources.\n*Required*: No\n*Type*: [GeoProximityLocation](./aws-properties-route53-recordset-geoproximitylocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geoproximitylocation", "Required": false, "Type": "GeoProximityLocation", "UpdateType": "Mutable" }, "HealthCheckId": { "MarkdownDocumentation": "`HealthCheckId`\n\nIf you want Amazon Route 53 to return this resource record set in response to a DNS\nquery only when the status of a health check is healthy, include the\n`HealthCheckId` element and specify the ID of the applicable health\ncheck.\nRoute 53 determines whether a resource record set is healthy based on one of the\nfollowing:\n* By periodically sending a request to the endpoint that is specified in the\n health check\n* By aggregating the status of a specified group of health checks (calculated\n health checks)\n* By determining the current state of a CloudWatch alarm (CloudWatch metric\n health checks)\n###### Important\nRoute 53 doesn't check the health of the endpoint that is specified in the\nresource record set, for example, the endpoint specified by the IP address in the\n`Value` element. When you add a `HealthCheckId` element to\na resource record set, Route 53 checks the health of the endpoint that you specified\nin the health check.\nFor more information, see the following topics in the *Amazon Route 53\nDeveloper Guide*:\n* [How Amazon Route 53 Determines Whether an Endpoint Is\n Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)\n* [Route 53 Health Checks\n 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\nchoosing between two or more resource record sets to respond to a DNS query, and you\nwant Route 53 to base the choice in part on the status of a health check. Configuring\nhealth checks makes sense only in the following configurations:\n* **Non-alias resource record sets**: You're\n checking the health of a group of non-alias resource record sets that have the\n same routing policy, name, and type (such as multiple weighted records named\n www.example.com with a type of A) and you specify health check IDs for all the\n resource record sets.\n \n If the health check status for a resource record set is healthy, Route 53\n includes the record among the records that it responds to DNS queries\n with.\n \n If the health check status for a resource record set is unhealthy, Route 53\n stops responding to DNS queries using the value for that resource record\n set.\n \n If the health check status for all resource record sets in the group is\n unhealthy, Route 53 considers all resource record sets in the group healthy and\n responds to DNS queries accordingly.\n* **Alias resource record sets**: You specify the\n following settings:\n \n + You set `EvaluateTargetHealth` to true for an alias\n resource record set in a group of resource record sets that have the\n same routing policy, name, and type (such as multiple weighted records\n named www.example.com with a type of A).\n + You configure the alias resource record set to route traffic to a\n non-alias resource record set in the same hosted zone.\n + You specify a health check ID for the non-alias resource record set.\n \n If the health check status is healthy, Route 53 considers the alias resource\n record set to be healthy and includes the alias record among the records that it\n responds to DNS queries with.\n \n If the health check status is unhealthy, Route 53 stops responding to DNS\n queries using the alias resource record set.\n \n ###### Note\n \n The alias resource record set can also route traffic to a\n *group* of non-alias resource record sets that have\n the same routing policy, name, and type. In that configuration, associate\n health checks with all of the resource record sets in the group of non-alias\n resource record sets.\n**Geolocation Routing**\nFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\na resource record set for the larger, associated geographic region. For example, suppose\nyou have resource record sets for a state in the United States, for the entire United\nStates, for North America, and a resource record set that has `*` for\n`CountryCode` is `*`, which applies to all locations. If the\nendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\nresource record sets in the following order until it finds a resource record set for\nwhich the endpoint is healthy:\n* The United States\n* North America\n* The default resource record set\n**Specifying the Health Check Endpoint by Domain\nName**\nIf your health checks specify the endpoint only by domain name, we recommend that you\ncreate a separate health check for each endpoint. For example, create a health check for\neach `HTTP` server that is serving content for `www.example.com`.\nFor the value of `FullyQualifiedDomainName`, specify the domain name of the\nserver (such as `us-east-2-www.example.com`), not the name of the resource\nrecord sets (`www.example.com`).\n###### Important\nHealth check results will be unpredictable if you do the following:\n* Create a health check that has the same value for\n `FullyQualifiedDomainName` as the name of a resource record\n set.\n* Associate that health check with the resource record set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nThe 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\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "HostedZoneName": { "MarkdownDocumentation": "`HostedZoneName`\n\nThe 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\nthe `HostedZoneName`.\nWhen you create a stack using an AWS::Route53::RecordSet that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone\nwhose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one\nhosted 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\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "MultiValueAnswer": { "MarkdownDocumentation": "`MultiValueAnswer`\n\n*Multivalue answer resource record sets only*: To route traffic\napproximately randomly to multiple resources, such as web servers, create one multivalue\nanswer record for each resource and specify `true` for\n`MultiValueAnswer`. Note the following:\n* If you associate a health check with a multivalue answer resource record set,\n Amazon Route 53 responds to DNS queries with the corresponding IP address only\n when the health check is healthy.\n* If you don't associate a health check with a multivalue answer record, Route\n 53 always considers the record to be healthy.\n* Route 53 responds to DNS queries with up to eight healthy records; if you have\n eight or fewer healthy records, Route 53 responds to all DNS queries with all\n the healthy records.\n* If you have more than eight healthy records, Route 53 responds to different\n DNS resolvers with different combinations of healthy records.\n* When all records are unhealthy, Route 53 responds to DNS queries with up to\n eight unhealthy records.\n* If a resource becomes unavailable after a resolver caches a response, client\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the record that you want to create, update, or delete.\nEnter a fully qualified domain name, for example, `www.example.com`. You\ncan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\nassumes that the domain name that you specify is fully qualified. This means that Route\n53 treats `www.example.com` (without a trailing dot) and\n`www.example.com.` (with a trailing dot) as identical.\nFor information about how to specify characters other than `a-z`,\n`0-9`, and `-` (hyphen) and how to specify internationalized\ndomain names, see [DNS Domain Name\nFormat](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,\nfor example, `*.example.com`. Note the following:\n* The \\* must replace the entire label. For example, you can't specify\n `*prod.example.com` or `prod*.example.com`.\n* The \\* can't replace any of the middle labels, for example,\n marketing.\\*.example.com.\n* If you include \\* in any position other than the leftmost label in a domain\n name, DNS treats it as an \\* character (ASCII 42), not as a wildcard.\n \n ###### Important\n \n You can't use the \\* wildcard for resource records sets that have a type of\n NS.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Region": { "MarkdownDocumentation": "`Region`\n\n*Latency-based resource record sets only:* The Amazon EC2 Region\nwhere you created the resource that this resource record set refers to. The resource\ntypically is an AWS resource, such as an EC2 instance or an ELB load\nbalancer, and is referred to by an IP address or a DNS domain name, depending on the\nrecord type.\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you\nhave created latency resource record sets, Route 53 selects the latency resource record\nset that has the lowest latency between the end user and the associated Amazon EC2\nRegion. Route 53 then returns the value that is associated with the selected resource\nrecord set.\nNote the following:\n* You can only specify one `ResourceRecord` per latency resource\n record set.\n* You can only create one latency resource record set for each Amazon EC2\n Region.\n* You aren't required to create latency resource record sets for all Amazon EC2\n Regions. Route 53 will choose the region with the best latency from among the\n regions that you create latency resource record sets for.\n* You can't create non-latency resource record sets that have the same values\n for the `Name` and `Type` elements as latency resource\n record sets.\n*Required*: No\n*Type*: String\n*Allowed values*: `us-east-1 | us-east-2 | us-...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-central-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "eu-north-1", "sa-east-1", "cn-north-1", "cn-northwest-1", "ap-east-1", "me-south-1", "me-central-1", "ap-south-1", "ap-south-2", "af-south-1", "eu-south-1", "eu-south-2", "ap-southeast-4", "il-central-1", "ca-west-1", "ap-southeast-5", "mx-central-1", "ap-southeast-7", "us-gov-east-1", "us-gov-west-1", "ap-east-2", "ap-southeast-6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ResourceRecords": { "MarkdownDocumentation": "`ResourceRecords`\n\nOne or more values that correspond with the value that you specified for the `Type` property. For example, if you specified\n`A` for `Type`, you specify one or more IP addresses in IPv4 format for `ResourceRecords`.\nFor information about the format of values for each record type, see\n[Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html)\nin 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "SetIdentifier": { "MarkdownDocumentation": "`SetIdentifier`\n\n*Resource record sets that have a routing policy other than\nsimple:* An identifier that differentiates among multiple resource record\nsets that have the same combination of name and type, such as multiple weighted resource\nrecord sets named acme.example.com that have a type of A. In a group of resource record\nsets that have the same name and type, the value of `SetIdentifier` must be\nunique for each resource record set.\nFor information about routing policies, see [Choosing a Routing\nPolicy](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "TTL": { "MarkdownDocumentation": "`TTL`\n\nThe 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\n `TTL`. Amazon Route 53 uses the value of `TTL` for the\n alias target.\n* If you're associating this resource record set with a health check (if you're\n adding a `HealthCheckId` element), we recommend that you specify a\n `TTL` of 60 seconds or less so clients respond quickly to changes\n in health status.\n* All of the resource record sets in a group of weighted resource record sets\n must have the same value for `TTL`.\n* If a group of weighted resource record sets includes one or more weighted\n alias resource record sets for which the alias target is an ELB load balancer,\n we recommend that you specify a `TTL` of 60 seconds for all of the\n non-alias weighted resource record sets that have the same name and type. Values\n other than 60 seconds (the TTL for load balancers) will change the effect of the\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe DNS record type. For information about different record types and how data is\nencoded for them, see [Supported DNS Resource\nRecord Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer\nGuide*.\nValid values for basic resource record sets: `A` | `AAAA` |\n`CAA` | `CNAME` | `DS` |`MX` |\n`NAPTR` | `NS` | `PTR` | `SOA` |\n`SPF` | `SRV` | `TXT`| `TLSA`| `SSHFP`| `SVCB`| `HTTPS`\nValues for weighted, latency, geolocation, and failover resource record sets: `A`\n| `AAAA` | `CAA` | `CNAME` | `MX` |\n`NAPTR` | `PTR` | `SPF` | `SRV` |\n`TXT`| `TLSA`| `SSHFP`| `SVCB`|\n`HTTPS`. When creating a group of weighted, latency, geolocation, or\nfailover resource record sets, specify the same value for all of the resource record\nsets in the group.\nValid values for multivalue answer resource record sets: `A` |\n`AAAA` | `MX` | `NAPTR` | `PTR` |\n`SPF` | `SRV` | `TXT`| `CAA`| `TLSA`| `SSHFP`| `SVCB`| `HTTPS`\n###### Note\nSPF records were formerly used to verify the identity of the sender of email\nmessages. However, we no longer recommend that you create resource record sets for\nwhich the value of `Type` is `SPF`. RFC 7208, *Sender\nPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n1*, has been updated to say, \"...[I]ts existence and mechanism defined\nin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\nlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n7208, see section 14.1, [The SPF DNS Record Type](http://tools.ietf.org/html/rfc7208#section-14.1).\nValues for alias resource record sets:\n* **Amazon API Gateway custom regional APIs and\n edge-optimized APIs:**\n `A`\n* **CloudFront distributions:**\n `A`\n \n If IPv6 is enabled for the distribution, create two resource record sets to\n route traffic to your distribution, one with a value of `A` and one\n with a value of `AAAA`.\n* **Amazon API Gateway environment that has a regionalized\n subdomain**: `A`\n* **ELB load balancers:**`A` | `AAAA`\n* **Amazon S3 buckets:**\n `A`\n* **Amazon Virtual Private Cloud interface VPC\n endpoints**\n `A`\n* **Another resource record set in this hosted\n zone:** Specify the type of the resource record set that you're\n creating the alias for. All values are supported except `NS` and\n `SOA`.\n \n ###### Note\n \n If you're creating an alias record that has the same name as the hosted\n zone (known as the zone apex), you can't route traffic to a record for which\n the value of `Type` is `CNAME`. This is because the\n alias record must have the same type as the record you're routing traffic\n to, and creating a CNAME record for the zone apex isn't supported even for\n an alias record.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SOA | A | TXT | NS | CNAME ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "NAPTR", "PTR", "SRV", "SPF", "AAAA", "CAA", "DS", "TLSA", "SSHFP", "SVCB", "HTTPS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\n*Weighted resource record sets only:* Among resource record sets\nthat have the same combination of DNS name and type, a value that determines the\nproportion of DNS queries that Amazon Route 53 responds to using the current resource\nrecord set. Route 53 calculates the sum of the weights for the resource record sets that\nhave the same combination of DNS name and type. Route 53 then responds to queries based\non 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\n weighted resource record set.\n* You can only specify one `ResourceRecord` per weighted resource\n record set.\n* You can't create latency, failover, or geolocation resource record sets that\n have the same values for the `Name` and `Type` elements as\n weighted resource record sets.\n* You can create a maximum of 100 weighted resource record sets that have the\n same values for the `Name` and `Type` elements.\n* For weighted (but not weighted alias) resource record sets, if you set\n `Weight` to `0` for a resource record set, Route 53\n never responds to queries with the applicable value for that resource record\n set. However, if you set `Weight` to `0` for all resource\n record sets that have the same combination of DNS name and type, traffic is\n routed to all resources with equal probability.\n \n The effect of setting `Weight` to `0` is different when\n you associate health checks with weighted resource record sets. For more\n information, see [Options for Configuring Route 53 Active-Active and Active-Passive\n Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) in the *Amazon Route 53 Developer\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Route53Resolver::FirewallRuleGroup.FirewallRule": { "MarkdownDocumentation": "`AWS::Route53Resolver::FirewallRuleGroup.FirewallRule`\n\nA single firewall rule in a rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html", "Properties": { "Qtype": { "MarkdownDocumentation": "`Qtype`\n\nThe DNS query type you want the rule to evaluate. Allowed values are;\n* A: Returns an IPv4 address.\n* AAAA: Returns an Ipv6 address.\n* CAA: Restricts CAs that can create SSL/TLS certifications for the domain.\n* CNAME: Returns another domain name.\n* DS: Record that identifies the DNSSEC signing key of a delegated zone.\n* MX: Specifies mail servers.\n* NAPTR: Regular-expression-based rewriting of domain names.\n* NS: Authoritative name servers.\n* PTR: Maps an IP address to a domain name.\n* SOA: Start of authority record for the zone.\n* SPF: Lists the servers authorized to send emails from a domain.\n* SRV: Application specific values that identify servers.\n* TXT: Verifies email senders and application-specific values.\n* A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be\n defined as TYPENUMBER, where the\n NUMBER can be 1-65334, for\n example, TYPE28. For more information, see\n [List of DNS record types](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-qtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list,\nor a threat in a DNS Firewall Advvanced rule:\n* `ALLOW` - Permit the request to go through. Not available for DNS Firewall Advanced rules.\n* `ALERT` - Permit the request to go through but send an alert to the logs.\n* `BLOCK` - Disallow the request. If this is specified,then `BlockResponse` must also be specified.\n \n if `BlockResponse` is `OVERRIDE`, then all of the\n following `OVERRIDE` attributes must be specified:\n \n + `BlockOverrideDnsType`\n + `BlockOverrideDomain`\n + `BlockOverrideTtl`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALLOW | BLOCK | ALERT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "BLOCK", "ALERT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "BlockOverrideDomain": { "MarkdownDocumentation": "`BlockOverrideDomain`\n\nThe custom DNS record to send back in response to the query. Used for the rule action `BLOCK` with a `BlockResponse` setting of `OVERRIDE`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-blockoverridedomain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DnsThreatProtection": { "MarkdownDocumentation": "`DnsThreatProtection`\n\nThe type of the DNS Firewall Advanced rule. Valid values are:\n* `DGA`: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains\n to to launch malware attacks.\n* `DNS_TUNNELING`: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without\n making a network connection to the client.\n*Required*: No\n*Type*: String\n*Allowed values*: `DGA | DNS_TUNNELING | DICTI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DGA", "DNS_TUNNELING", "DICTIONARY_DGA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-dnsthreatprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FirewallDomainListId": { "MarkdownDocumentation": "`FirewallDomainListId`\n\nThe ID of the domain list that's used in the rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-firewalldomainlistid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FirewallThreatProtectionId": { "MarkdownDocumentation": "`FirewallThreatProtectionId`\n\nID of the DNS Firewall Advanced rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-firewallthreatprotectionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfidenceThreshold": { "MarkdownDocumentation": "`ConfidenceThreshold`\n\nThe confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence\nlevel values mean:\n* `LOW`: Provides the highest detection rate for threats, but also increases false positives.\n* `MEDIUM`: Provides a balance between detecting threats and false positives.\n* `HIGH`: Detects only the most well corroborated threats with a low rate of false positives.\n*Required*: No\n*Type*: String\n*Allowed values*: `LOW | MEDIUM | HIGH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOW", "MEDIUM", "HIGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-confidencethreshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlockResponse": { "MarkdownDocumentation": "`BlockResponse`\n\nThe way that you want DNS Firewall to block the request. Used for the rule action setting `BLOCK`.\n* `NODATA` - Respond indicating that the query was successful, but no response is available for it.\n* `NXDOMAIN` - Respond indicating that the domain name that's in the query doesn't exist.\n* `OVERRIDE` - Provide a custom override in the response. This option requires custom handling details in the rule's `BlockOverride*` settings.\n*Required*: No\n*Type*: String\n*Allowed values*: `NODATA | NXDOMAIN | OVERRID...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NODATA", "NXDOMAIN", "OVERRIDE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-blockresponse", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlockOverrideTtl": { "MarkdownDocumentation": "`BlockOverrideTtl`\n\nThe recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action `BLOCK` with a `BlockResponse` setting of `OVERRIDE`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `604800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-blockoverridettl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "BlockOverrideDnsType": { "MarkdownDocumentation": "`BlockOverrideDnsType`\n\nThe DNS record's type. This determines the format of the record value that you provided in `BlockOverrideDomain`. Used for the rule action `BLOCK` with a `BlockResponse` setting of `OVERRIDE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CNAME`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "CNAME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-blockoverridednstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FirewallDomainRedirectionAction": { "MarkdownDocumentation": "`FirewallDomainRedirectionAction`\n\nHow you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, or DNAME.\n`Inspect_Redirection_Domain` (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be\nadded to the domain list.\n`Trust_Redirection_Domain` inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to\nthe domain list.\n*Required*: No\n*Type*: String\n*Allowed values*: `INSPECT_REDIRECTION_DOMAIN ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSPECT_REDIRECTION_DOMAIN", "TRUST_REDIRECTION_DOMAIN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-firewalldomainredirectionaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Route53Resolver::ResolverEndpoint.IpAddressRequest": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverEndpoint.IpAddressRequest`\n\nIn a\n[CreateResolverEndpoint](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html)\nrequest, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).\n`IpAddressRequest` also includes the ID of the subnet that contains the IP address.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html", "Properties": { "Ipv6": { "MarkdownDocumentation": "`Ipv6`\n\nThe IPv6 address that you want to use for DNS queries.\n*Required*: No\n*Type*: String\n*Minimum*: `7`\n*Maximum*: `39`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html#cfn-route53resolver-resolverendpoint-ipaddressrequest-ipv6", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ip": { "MarkdownDocumentation": "`Ip`\n\nThe IPv4 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html#cfn-route53resolver-resolverendpoint-ipaddressrequest-ip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html#cfn-route53resolver-resolverendpoint-ipaddressrequest-subnetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53Resolver::ResolverRule.TargetAddress": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverRule.TargetAddress`\n\nIn a\n[CreateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html)\nrequest, an array of the IPs that you want to forward DNS queries to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html", "Properties": { "Ipv6": { "MarkdownDocumentation": "`Ipv6`\n\nOne IPv6 address that you want to forward DNS queries to.\n*Required*: No\n*Type*: String\n*Minimum*: `7`\n*Maximum*: `39`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html#cfn-route53resolver-resolverrule-targetaddress-ipv6", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ip": { "MarkdownDocumentation": "`Ip`\n\nOne IPv4 address that you want to forward DNS queries to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html#cfn-route53resolver-resolverrule-targetaddress-ip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html#cfn-route53resolver-resolverrule-targetaddress-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocols for the target address. The protocol you choose needs to be supported by the outbound endpoint of the Resolver rule.\n*Required*: No\n*Type*: String\n*Allowed values*: `Do53 | DoH`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "Do53", "DoH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html#cfn-route53resolver-resolverrule-targetaddress-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerNameIndication": { "MarkdownDocumentation": "`ServerNameIndication`\n\nThe Server Name Indication of the DoH server that you want to forward queries to.\nThis is only used if the Protocol of the `TargetAddress` is `DoH`.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html#cfn-route53resolver-resolverrule-targetaddress-servernameindication", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::AccessGrant.AccessGrantsLocationConfiguration": { "MarkdownDocumentation": "`AWS::S3::AccessGrant.AccessGrantsLocationConfiguration`\n\nThe configuration options of the S3 Access Grants location. It contains the `S3SubPrefix` field. The grant scope, the data to which you are granting access, is the result of appending the `Subprefix` field to the scope of the registered location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-accessgrantslocationconfiguration.html", "Properties": { "S3SubPrefix": { "MarkdownDocumentation": "`S3SubPrefix`\n\nThe `S3SubPrefix` is appended to the location scope creating the grant scope. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location `s3://` because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location `s3://`, the `S3SubPrefx` can be a `/*`, so the full grant scope path would be `s3:///*`. Or the `S3SubPrefx` can be `/*`, so the full grant scope path would be `s3:///*`.\nIf the `S3SubPrefix` includes a prefix, append the wildcard character `*` after the prefix to indicate that you want to include all object key names in the bucket that start with that prefix.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-accessgrantslocationconfiguration.html#cfn-s3-accessgrant-accessgrantslocationconfiguration-s3subprefix", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::AccessGrant.Grantee": { "MarkdownDocumentation": "`AWS::S3::AccessGrant.Grantee`\n\nThe user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to AWSIAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-grantee.html", "Properties": { "GranteeType": { "MarkdownDocumentation": "`GranteeType`\n\nThe type of the grantee to which access has been granted. It can be one of the following values:\n* `IAM` - An IAM user or role.\n* `DIRECTORY_USER` - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.\n* `DIRECTORY_GROUP` - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IAM | DIRECTORY_USER | DIRE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IAM", "DIRECTORY_USER", "DIRECTORY_GROUP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-grantee.html#cfn-s3-accessgrant-grantee-granteetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GranteeIdentifier": { "MarkdownDocumentation": "`GranteeIdentifier`\n\nThe unique identifier of the `Grantee`. If the grantee type is `IAM`, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. You can obtain this UUID from your AWSIAM Identity Center 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-grantee.html#cfn-s3-accessgrant-grantee-granteeidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::AccessPoint.PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`AWS::S3::AccessPoint.PublicAccessBlockConfiguration`\n\nThe PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can\nenable the configuration options in any combination. Bucket-level settings work alongside\naccount-level settings (which may inherit from organization-level policies). For more\ninformation 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html", "Properties": { "RestrictPublicBuckets": { "MarkdownDocumentation": "`RestrictPublicBuckets`\n\nSpecifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element\nto `TRUE` restricts access to this bucket to only AWS service principals and\nauthorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and\ncross-account access within any public bucket policy, including non-public delegation to specific\naccounts, is blocked.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-restrictpublicbuckets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicPolicy": { "MarkdownDocumentation": "`BlockPublicPolicy`\n\nSpecifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to\n`TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy\nallows public access.\nEnabling this setting doesn't affect existing bucket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-blockpublicpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicAcls": { "MarkdownDocumentation": "`BlockPublicAcls`\n\nSpecifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects\nin 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-blockpublicacls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IgnorePublicAcls": { "MarkdownDocumentation": "`IgnorePublicAcls`\n\nSpecifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting\nthis element to `TRUE` causes Amazon S3 to ignore all public ACLs on this bucket and objects in\nthis bucket.\nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new\npublic ACLs from being 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-ignorepublicacls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3::AccessPoint.VpcConfiguration": { "MarkdownDocumentation": "`AWS::S3::AccessPoint.VpcConfiguration`\n\nThe Virtual Private Cloud (VPC) configuration for this access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nIf this field is specified, the access point will only allow connections from the\nspecified VPC ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html#cfn-s3-accesspoint-vpcconfiguration-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.AbortIncompleteMultipartUpload": { "MarkdownDocumentation": "`AWS::S3::Bucket.AbortIncompleteMultipartUpload`\n\nSpecifies the days since the initiation of an incomplete multipart upload that Amazon S3\nwill wait before permanently removing all parts of the upload. For more information, see\n[Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the\n*Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-abortincompletemultipartupload.html", "Properties": { "DaysAfterInitiation": { "MarkdownDocumentation": "`DaysAfterInitiation`\n\nSpecifies the number of days after which Amazon S3 stops an incomplete multipart\nupload.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-abortincompletemultipartupload.html#cfn-s3-bucket-abortincompletemultipartupload-daysafterinitiation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::S3::Bucket.AccelerateConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.AccelerateConfiguration`\n\nConfigures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer\nAcceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html", "Properties": { "AccelerationStatus": { "MarkdownDocumentation": "`AccelerationStatus`\n\nSpecifies the transfer acceleration status of the bucket.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Enabled | Suspended...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Suspended" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html#cfn-s3-bucket-accelerateconfiguration-accelerationstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.AccessControlTranslation": { "MarkdownDocumentation": "`AWS::S3::Bucket.AccessControlTranslation`\n\nSpecify this only in a cross-account scenario (where source and destination bucket owners are not\nthe same), and you want to change replica ownership to the AWS account that owns the destination\nbucket. If this is not specified in the replication configuration, the replicas are owned by same\nAWS account that owns the source object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html", "Properties": { "Owner": { "MarkdownDocumentation": "`Owner`\n\nSpecifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the\n*Amazon S3 API Reference*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Destination...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Destination" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html#cfn-s3-bucket-accesscontroltranslation-owner", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.AnalyticsConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.AnalyticsConfiguration`\n\nSpecifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html", "Properties": { "StorageClassAnalysis": { "MarkdownDocumentation": "`StorageClassAnalysis`\n\nContains data related to access patterns to be collected and made available to analyze the\ntradeoffs between different storage classes.\n*Required*: Yes\n*Type*: [StorageClassAnalysis](./aws-properties-s3-bucket-storageclassanalysis.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-storageclassanalysis", "UpdateType": "Mutable", "Required": true, "Type": "StorageClassAnalysis" }, "TagFilters": { "MarkdownDocumentation": "`TagFilters`\n\nThe tags to use when evaluating an analytics filter.\nThe analytics only includes objects that meet the filter's criteria. If no filter is\nspecified, all of the contents of the bucket are included in the analysis.\n*Required*: No\n*Type*: Array of [TagFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-tagfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagFilter", "DuplicatesAllowed": false }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID that identifies the analytics 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe prefix that an object must have to be included in the analytics 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.BlockedEncryptionTypes": { "MarkdownDocumentation": "`AWS::S3::Bucket.BlockedEncryptionTypes`\n\nA bucket-level setting for Amazon S3 general purpose buckets used to prevent the upload of new objects encrypted with the specified server-side encryption type. For example, blocking an encryption type will block `PutObject`, `CopyObject`, `PostObject`, multipart upload, and replication requests to the bucket for objects with the specified encryption type. However, you can continue to read and list any pre-existing objects already encrypted with the specified encryption type. For more information, see [Blocking or unblocking SSE-C for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html).\nThis data type is used with the following actions:\n* [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)\n* [GetBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)\n* [DeleteBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)\nPermissions\nYou must have the `s3:PutEncryptionConfiguration` permission to block or unblock an encryption type for a bucket.\nYou must have the `s3:GetEncryptionConfiguration` permission to view a bucket's encryption type.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-blockedencryptiontypes.html", "Properties": { "EncryptionType": { "MarkdownDocumentation": "`EncryptionType`\n\nThe object encryption type that you want to block or unblock for an Amazon S3 general purpose bucket.\n###### Note\nCurrently, this parameter only supports blocking or unblocking server side encryption with customer-provided keys (SSE-C). For more information about SSE-C, see [Using server-side encryption with customer-provided keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `NONE | SSE-C...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SSE-C" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-blockedencryptiontypes.html#cfn-s3-bucket-blockedencryptiontypes-encryptiontype", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::S3::Bucket.BucketEncryption": { "MarkdownDocumentation": "`AWS::S3::Bucket.BucketEncryption`\n\nSpecifies default encryption for a bucket using server-side encryption with Amazon\nS3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For\ninformation about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3\nBuckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html", "Properties": { "ServerSideEncryptionConfiguration": { "MarkdownDocumentation": "`ServerSideEncryptionConfiguration`\n\nSpecifies the default server-side-encryption configuration.\n*Required*: Yes\n*Type*: Array of [ServerSideEncryptionRule](./aws-properties-s3-bucket-serversideencryptionrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html#cfn-s3-bucket-bucketencryption-serversideencryptionconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ServerSideEncryptionRule", "DuplicatesAllowed": false } } }, "AWS::S3::Bucket.CorsConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.CorsConfiguration`\n\nDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information,\nsee [Enabling Cross-Origin Resource\nSharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsconfiguration.html", "Properties": { "CorsRules": { "MarkdownDocumentation": "`CorsRules`\n\nA set of origins and methods (cross-origin access that you want to allow). You can add up to 100\nrules to the configuration.\n*Required*: Yes\n*Type*: Array of [CorsRule](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsconfiguration.html#cfn-s3-bucket-corsconfiguration-corsrules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CorsRule", "DuplicatesAllowed": false } } }, "AWS::S3::Bucket.CorsRule": { "MarkdownDocumentation": "`AWS::S3::Bucket.CorsRule`\n\nSpecifies a cross-origin access rule for an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html", "Properties": { "ExposedHeaders": { "MarkdownDocumentation": "`ExposedHeaders`\n\nOne or more headers in the response that you want customers to be able to access from\ntheir applications (for example, from a JavaScript `XMLHttpRequest` object).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-exposedheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AllowedMethods": { "MarkdownDocumentation": "`AllowedMethods`\n\nAn HTTP method that you allow the origin to run.\n*Allowed values*: `GET` | `PUT` | ...`\n`HEAD` | `POST` | `DELETE`\n*Required*: Yes\n*Type*: Array of String\n*Allowed values*: `GET | PUT | HEAD | POST | DELETE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GET`", "`PUT` ", "" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-allowedmethods", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AllowedOrigins": { "MarkdownDocumentation": "`AllowedOrigins`\n\nOne or more origins you want customers to be able to access the bucket from.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-allowedorigins", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AllowedHeaders": { "MarkdownDocumentation": "`AllowedHeaders`\n\nHeaders that are specified in the `Access-Control-Request-Headers` header. These headers\nare allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns\nany requested headers that are allowed.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-allowedheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MaxAge": { "MarkdownDocumentation": "`MaxAge`\n\nThe time in seconds that your browser is to cache the preflight response for the specified\nresource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-maxage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA unique identifier for this rule. The value must be no more than 255 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.DataExport": { "MarkdownDocumentation": "`AWS::S3::Bucket.DataExport`\n\nSpecifies how data related to the storage class analysis for an Amazon S3 bucket should be\nexported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe place to store the data for an analysis.\n*Required*: Yes\n*Type*: [Destination](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-destination", "UpdateType": "Mutable", "Required": true, "Type": "Destination" }, "OutputSchemaVersion": { "MarkdownDocumentation": "`OutputSchemaVersion`\n\nThe version of the output schema to use when exporting data. Must be `V_1`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `V_1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "V_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-outputschemaversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.DefaultRetention": { "MarkdownDocumentation": "`AWS::S3::Bucket.DefaultRetention`\n\nThe container element for optionally specifying the default Object Lock retention settings for new\nobjects placed in the specified bucket.\n###### Note\n* The `DefaultRetention` settings require both a mode and a period.\n* The `DefaultRetention` period can be either `Days` or `Years`\n but you must select one. You cannot specify `Days` and `Years` at the same\n time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html", "Properties": { "Years": { "MarkdownDocumentation": "`Years`\n\nThe number of years that you want to specify for the default retention period. If Object\nLock is turned on, you must specify `Mode` and specify either `Days` or\n`Years`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-years", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Days": { "MarkdownDocumentation": "`Days`\n\nThe number of days that you want to specify for the default retention period. If Object\nLock is turned on, you must specify `Mode` and specify either `Days` or\n`Years`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-days", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe default Object Lock retention mode you want to apply to new objects placed in the\nspecified bucket. If Object Lock is turned on, you must specify `Mode` and specify\neither `Days` or `Years`.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `COMPLIANCE | GOVERNANCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMPLIANCE", "GOVERNANCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.DeleteMarkerReplication": { "MarkdownDocumentation": "`AWS::S3::Bucket.DeleteMarkerReplication`\n\nSpecifies whether Amazon S3 replicates delete markers. If you specify a `Filter` in your\nreplication configuration, you must also include a `DeleteMarkerReplication` element. If your\n`Filter` includes a `Tag` element, the `DeleteMarkerReplication``Status` must be set to Disabled, because Amazon S3 does not support replicating delete markers\nfor tag-based rules. For an example configuration, see [Basic Rule\nConfiguration](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).\n###### Note\nIf you are using an earlier version of the replication configuration, Amazon S3 handles replication of\ndelete 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-deletemarkerreplication.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nIndicates whether to replicate delete markers.\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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-deletemarkerreplication.html#cfn-s3-bucket-deletemarkerreplication-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.Destination": { "MarkdownDocumentation": "`AWS::S3::Bucket.Destination`\n\nSpecifies information about where to publish analysis or configuration results for an\nAmazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html", "Properties": { "BucketArn": { "MarkdownDocumentation": "`BucketArn`\n\nThe Amazon Resource Name (ARN) of the bucket to which data is exported.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Format": { "MarkdownDocumentation": "`Format`\n\nSpecifies the file format used when exporting data to Amazon S3.\n*Allowed values*: `CSV` | `ORC` | ...`\n`Parquet`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CSV | 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)", "RefReturnValue": "", "AllowedValues": [ "CSV`", "`ORC` ", "" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-format", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketAccountId": { "MarkdownDocumentation": "`BucketAccountId`\n\nThe account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not\nvalidated before exporting data.\n###### Note\nAlthough this value is optional, we strongly recommend that you set it to help prevent problems\nif the destination bucket ownership changes.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketaccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.EncryptionConfiguration`\n\nSpecifies encryption-related information for an Amazon S3 bucket that is a destination for replicated\nobjects.\n###### Note\nIf you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key\nARN. If you use a KMS key alias instead, then AWS KMS resolves the key within the requester\u2019s account.\nThis behavior can result in data that's encrypted with a KMS key that belongs to the requester, and\nnot the bucket owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html", "Properties": { "ReplicaKmsKeyID": { "MarkdownDocumentation": "`ReplicaKmsKeyID`\n\nSpecifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key\nManagement Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3\nonly 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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html#cfn-s3-bucket-encryptionconfiguration-replicakmskeyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.EventBridgeConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.EventBridgeConfiguration`\n\nAmazon S3 can send events to Amazon EventBridge whenever certain events happen in your\nbucket, see [Using\nEventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*.\nUnlike other destinations, delivery of events to EventBridge can be either enabled or\ndisabled for a bucket. If enabled, all events will be sent to EventBridge and you can use\nEventBridge rules to route events to additional targets. For more information, see [What Is Amazon\nEventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-eventbridgeconfiguration.html", "Properties": { "EventBridgeEnabled": { "MarkdownDocumentation": "`EventBridgeEnabled`\n\nEnables delivery of events to Amazon EventBridge.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-eventbridgeconfiguration.html#cfn-s3-bucket-eventbridgeconfiguration-eventbridgeenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::S3::Bucket.FilterRule": { "MarkdownDocumentation": "`AWS::S3::Bucket.FilterRule`\n\nSpecifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an\nobject in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key\nname. A prefix is a specific string of characters at the beginning of an object key name, which you can\nuse to organize objects. For example, you can start the key names of related objects with a prefix, such\nas `2023-` or `engineering/`. Then, you can use `FilterRule` to find\nobjects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is\nat the end of the object key name instead of at the beginning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-filterrule.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value that the filter searches for in object key names.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-filterrule.html#cfn-s3-bucket-filterrule-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe object key name prefix or suffix identifying one or more objects to which the filtering rule\napplies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported.\nFor more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-filterrule.html#cfn-s3-bucket-filterrule-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.IntelligentTieringConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.IntelligentTieringConfiguration`\n\nSpecifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.\nFor information about the S3 Intelligent-Tiering storage class, see [Storage class for\nautomatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies the status of the configuration.\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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tierings": { "MarkdownDocumentation": "`Tierings`\n\nSpecifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At\nleast one tier must be defined in the list. At most, you can specify two tiers in the list,\none for each available AccessTier: `ARCHIVE_ACCESS` and\n`DEEP_ARCHIVE_ACCESS`.\n###### Note\nYou only need Intelligent Tiering Configuration enabled on a bucket if you want to\nautomatically move objects stored in the Intelligent-Tiering storage class to Archive Access\nor Deep Archive Access tiers.\n*Required*: Yes\n*Type*: Array of [Tiering](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-tierings", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Tiering", "DuplicatesAllowed": false }, "TagFilters": { "MarkdownDocumentation": "`TagFilters`\n\nA container for a key-value pair.\n*Required*: No\n*Type*: Array of [TagFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-tagfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagFilter", "DuplicatesAllowed": false }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID used to identify the S3 Intelligent-Tiering 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nAn object key name prefix that identifies the subset of objects to which the rule\napplies.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.InventoryConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.InventoryConfiguration`\n\nSpecifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket\ninventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nContains information about where to publish the inventory results.\n*Required*: Yes\n*Type*: [Destination](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-destination", "UpdateType": "Mutable", "Required": true, "Type": "Destination" }, "OptionalFields": { "MarkdownDocumentation": "`OptionalFields`\n\nContains the optional fields that are included in the inventory results.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `Size | LastModifiedDate | S...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier", "BucketKeyStatus", "ChecksumAlgorithm", "ObjectAccessControlList", "ObjectOwner", "LifecycleExpirationDate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-optionalfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "IncludedObjectVersions": { "MarkdownDocumentation": "`IncludedObjectVersions`\n\nObject versions to include in the inventory list. If set to `All`, the list includes all\nthe object versions, which adds the version-related fields `VersionId`,\n`IsLatest`, and `DeleteMarker` to the list. If set to `Current`, the\nlist does not contain these version-related fields.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `All | Current...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "All", "Current" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-includedobjectversions", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether the inventory is enabled or disabled. If set to `True`, an inventory\nlist is generated. If set to `False`, no inventory list is generated.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID used to identify the inventory 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nSpecifies the inventory filter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScheduleFrequency": { "MarkdownDocumentation": "`ScheduleFrequency`\n\nSpecifies the schedule for generating inventory results.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Daily | Weekly...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Daily", "Weekly" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-schedulefrequency", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.InventoryTableConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.InventoryTableConfiguration`\n\nThe inventory table configuration for an S3 Metadata configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventorytableconfiguration.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the inventory 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventorytableconfiguration.html#cfn-s3-bucket-inventorytableconfiguration-tablename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfigurationState": { "MarkdownDocumentation": "`ConfigurationState`\n\nThe configuration state of the inventory table, indicating whether the inventory table is enabled\nor disabled.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventorytableconfiguration.html#cfn-s3-bucket-inventorytableconfiguration-configurationstate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableArn": { "MarkdownDocumentation": "`TableArn`\n\nThe Amazon Resource Name (ARN) for the inventory 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventorytableconfiguration.html#cfn-s3-bucket-inventorytableconfiguration-tablearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption configuration for the inventory table.\n*Required*: No\n*Type*: [MetadataTableEncryptionConfiguration](./aws-properties-s3-bucket-metadatatableencryptionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventorytableconfiguration.html#cfn-s3-bucket-inventorytableconfiguration-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MetadataTableEncryptionConfiguration" } } }, "AWS::S3::Bucket.JournalTableConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.JournalTableConfiguration`\n\nThe journal table configuration for an S3 Metadata configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-journaltableconfiguration.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the journal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-journaltableconfiguration.html#cfn-s3-bucket-journaltableconfiguration-tablename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TableArn": { "MarkdownDocumentation": "`TableArn`\n\nThe Amazon Resource Name (ARN) for the journal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-journaltableconfiguration.html#cfn-s3-bucket-journaltableconfiguration-tablearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption configuration for the journal table.\n*Required*: No\n*Type*: [MetadataTableEncryptionConfiguration](./aws-properties-s3-bucket-metadatatableencryptionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-journaltableconfiguration.html#cfn-s3-bucket-journaltableconfiguration-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MetadataTableEncryptionConfiguration" }, "RecordExpiration": { "MarkdownDocumentation": "`RecordExpiration`\n\nThe journal table record expiration settings for the journal table.\n*Required*: Yes\n*Type*: [RecordExpiration](./aws-properties-s3-bucket-recordexpiration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-journaltableconfiguration.html#cfn-s3-bucket-journaltableconfiguration-recordexpiration", "UpdateType": "Mutable", "Required": true, "Type": "RecordExpiration" } } }, "AWS::S3::Bucket.LambdaConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.LambdaConfiguration`\n\nDescribes the AWS Lambda functions to invoke and the events for which to invoke them.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lambdaconfiguration.html", "Properties": { "Function": { "MarkdownDocumentation": "`Function`\n\nThe Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event\ntype occurs.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lambdaconfiguration.html#cfn-s3-bucket-lambdaconfiguration-function", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe filtering rules that determine which objects invoke the AWS Lambda\nfunction. For example, you can create a filter so that only image files with a\n`.jpg` extension invoke the function when they are added to the Amazon S3\nbucket.\n*Required*: No\n*Type*: [NotificationFilter](./aws-properties-s3-bucket-notificationfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lambdaconfiguration.html#cfn-s3-bucket-lambdaconfiguration-filter", "UpdateType": "Mutable", "Required": false, "Type": "NotificationFilter" }, "Event": { "MarkdownDocumentation": "`Event`\n\nThe Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in\nthe *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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lambdaconfiguration.html#cfn-s3-bucket-lambdaconfiguration-event", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.LifecycleConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.LifecycleConfiguration`\n\nSpecifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see\n[Object Lifecycle\nManagement](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfiguration.html", "Properties": { "TransitionDefaultMinimumObjectSize": { "MarkdownDocumentation": "`TransitionDefaultMinimumObjectSize`\n\nIndicates which default minimum object size behavior is applied to the lifecycle\nconfiguration.\n###### Note\nThis parameter applies to general purpose buckets only. It isn't supported for\ndirectory bucket lifecycle configurations.\n\n* `all_storage_classes_128K` - Objects smaller than 128 KB will not transition to any storage class by default.\n* `varies_by_storage_class` - Objects smaller than 128 KB will\n transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By\n default, all other storage classes will prevent transitions smaller than 128 KB.\nTo customize the minimum object size for any transition you can add a filter that\nspecifies a custom `ObjectSizeGreaterThan` or `ObjectSizeLessThan` in\nthe body of your transition rule. Custom filters always take precedence over the default\ntransition behavior.\n*Required*: No\n*Type*: String\n*Allowed values*: `varies_by_storage_class | a...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "varies_by_storage_class", "all_storage_classes_128K" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfiguration.html#cfn-s3-bucket-lifecycleconfiguration-transitiondefaultminimumobjectsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nA lifecycle rule for individual objects in an Amazon S3 bucket.\n*Required*: Yes\n*Type*: Array of [Rule](./aws-properties-s3-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfiguration.html#cfn-s3-bucket-lifecycleconfiguration-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": false } } }, "AWS::S3::Bucket.LoggingConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.LoggingConfiguration`\n\nDescribes where logs are stored and the prefix that Amazon S3 assigns to all log object\nkeys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the\n*Amazon S3 API Reference*.\n###### Note\nTo successfully complete the `AWS::S3::Bucket LoggingConfiguration` request,\nyou must have `s3:PutObject` and `s3:PutObjectAcl` in your IAM\npermissions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfiguration.html", "Properties": { "TargetObjectKeyFormat": { "MarkdownDocumentation": "`TargetObjectKeyFormat`\n\nAmazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed.\n*Required*: No\n*Type*: [TargetObjectKeyFormat](./aws-properties-s3-bucket-targetobjectkeyformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfiguration.html#cfn-s3-bucket-loggingconfiguration-targetobjectkeyformat", "UpdateType": "Mutable", "Required": false, "Type": "TargetObjectKeyFormat" }, "LogFilePrefix": { "MarkdownDocumentation": "`LogFilePrefix`\n\nA prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single\nbucket, you can use a prefix to distinguish which log files came from which 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfiguration.html#cfn-s3-bucket-loggingconfiguration-logfileprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationBucketName": { "MarkdownDocumentation": "`DestinationBucketName`\n\nThe name of the bucket where Amazon S3 should store server access log files. You can store\nlog files in any bucket that you own. By default, logs are stored in the bucket where the\n`LoggingConfiguration` property is defined.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfiguration.html#cfn-s3-bucket-loggingconfiguration-destinationbucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.MetadataConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.MetadataConfiguration`\n\nCreates a V2 Amazon S3 Metadata configuration of a general purpose bucket.\nFor more information, see\n[Accelerating data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadataconfiguration.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe destination information for the S3 Metadata configuration.\n*Required*: No\n*Type*: [MetadataDestination](./aws-properties-s3-bucket-metadatadestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadataconfiguration.html#cfn-s3-bucket-metadataconfiguration-destination", "UpdateType": "Mutable", "Required": false, "Type": "MetadataDestination" }, "JournalTableConfiguration": { "MarkdownDocumentation": "`JournalTableConfiguration`\n\nThe journal table configuration for a metadata configuration.\n*Required*: Yes\n*Type*: [JournalTableConfiguration](./aws-properties-s3-bucket-journaltableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadataconfiguration.html#cfn-s3-bucket-metadataconfiguration-journaltableconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "JournalTableConfiguration" }, "InventoryTableConfiguration": { "MarkdownDocumentation": "`InventoryTableConfiguration`\n\nThe inventory table configuration for a metadata configuration.\n*Required*: No\n*Type*: [InventoryTableConfiguration](./aws-properties-s3-bucket-inventorytableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadataconfiguration.html#cfn-s3-bucket-metadataconfiguration-inventorytableconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InventoryTableConfiguration" } } }, "AWS::S3::Bucket.MetadataDestination": { "MarkdownDocumentation": "`AWS::S3::Bucket.MetadataDestination`\n\nThe destination information for the S3 Metadata configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatadestination.html", "Properties": { "TableBucketArn": { "MarkdownDocumentation": "`TableBucketArn`\n\nThe Amazon Resource Name (ARN) of the table bucket where the metadata configuration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatadestination.html#cfn-s3-bucket-metadatadestination-tablebucketarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TableBucketType": { "MarkdownDocumentation": "`TableBucketType`\n\nThe type of the table bucket where the metadata configuration is stored. The `aws`\nvalue indicates an AWS managed table bucket, and the `customer` value indicates a\ncustomer-managed table bucket. V2 metadata configurations are stored in AWS managed table\nbuckets, and V1 metadata configurations are stored in customer-managed table buckets.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `aws | customer...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "aws", "customer" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatadestination.html#cfn-s3-bucket-metadatadestination-tablebuckettype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableNamespace": { "MarkdownDocumentation": "`TableNamespace`\n\nThe namespace in the table bucket where the metadata tables for a metadata configuration are\nstored.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatadestination.html#cfn-s3-bucket-metadatadestination-tablenamespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.MetadataTableConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.MetadataTableConfiguration`\n\n###### Important\nWe recommend that you create your S3 Metadata configurations by using the V2\n[MetadataConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-s3-bucket-metadataconfiguration.html) resource type. We no longer recommend using the V1\n`MetadataTableConfiguration` resource type.\nIf you created your S3 Metadata configuration before July 15, 2025, we recommend that you\ndelete and re-create your configuration by using the\n[MetadataConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-s3-bucket-metadataconfiguration.html) resource type so that you can expire journal table records and\ncreate a live inventory table.\nCreates a V1 S3 Metadata configuration for a general purpose bucket. For more information, see\n[Accelerating\ndata discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatatableconfiguration.html", "Properties": { "S3TablesDestination": { "MarkdownDocumentation": "`S3TablesDestination`\n\nThe destination information for the metadata table configuration. The destination table bucket must\nbe in the same Region and AWS account as the general purpose bucket. The specified metadata table name\nmust be unique within the `aws_s3_metadata` namespace in the destination table bucket.\n*Required*: Yes\n*Type*: [S3TablesDestination](./aws-properties-s3-bucket-s3tablesdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatatableconfiguration.html#cfn-s3-bucket-metadatatableconfiguration-s3tablesdestination", "UpdateType": "Mutable", "Required": true, "Type": "S3TablesDestination" } } }, "AWS::S3::Bucket.MetadataTableEncryptionConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.MetadataTableEncryptionConfiguration`\n\nThe encryption settings for an S3 Metadata journal table or inventory table configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatatableencryptionconfiguration.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nIf server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS) is specified, you must also\nspecify the KMS key Amazon Resource Name (ARN). You must specify a customer-managed KMS key\nthat's located in the same Region as the general purpose bucket that corresponds to the metadata\ntable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatatableencryptionconfiguration.html#cfn-s3-bucket-metadatatableencryptionconfiguration-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SseAlgorithm": { "MarkdownDocumentation": "`SseAlgorithm`\n\nThe encryption type specified for a metadata table. To specify server-side encryption with\nAWS Key Management Service (AWS KMS) keys (SSE-KMS), use the `aws:kms` value. To specify server-side\nencryption with Amazon S3 managed keys (SSE-S3), use the `AES256` value.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `aws:kms | AES256...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "aws:kms", "AES256" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metadatatableencryptionconfiguration.html#cfn-s3-bucket-metadatatableencryptionconfiguration-ssealgorithm", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.Metrics": { "MarkdownDocumentation": "`AWS::S3::Bucket.Metrics`\n\nA container specifying replication metrics-related settings enabling replication metrics and\nevents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies whether the replication metrics are 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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html#cfn-s3-bucket-metrics-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EventThreshold": { "MarkdownDocumentation": "`EventThreshold`\n\nA container specifying the time threshold for emitting the\n`s3:Replication:OperationMissedThreshold` event.\n*Required*: No\n*Type*: [ReplicationTimeValue](./aws-properties-s3-bucket-replicationtimevalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html#cfn-s3-bucket-metrics-eventthreshold", "UpdateType": "Mutable", "Required": false, "Type": "ReplicationTimeValue" } } }, "AWS::S3::Bucket.MetricsConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.MetricsConfiguration`\n\nSpecifies a metrics configuration for the CloudWatch request metrics (specified by the\nmetrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics\nconfiguration, note that this is a full replacement of the existing metrics configuration. If\nyou don't include the elements you want to keep, they are erased. For examples, see [AWS::S3::Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#aws-properties-s3-bucket--examples). For more information, see [PUT Bucket metrics](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html)\nin the *Amazon S3 API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html", "Properties": { "AccessPointArn": { "MarkdownDocumentation": "`AccessPointArn`\n\nThe access point that was used while performing operations on the object. The metrics\nconfiguration only includes objects that meet the filter's criteria.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-accesspointarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagFilters": { "MarkdownDocumentation": "`TagFilters`\n\nSpecifies a list of tag filters to use as a metrics configuration filter. The metrics\nconfiguration includes only objects that meet the filter's criteria.\n*Required*: No\n*Type*: Array of [TagFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-tagfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagFilter", "DuplicatesAllowed": false }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID used to identify the metrics configuration. This can be any value you choose that\nhelps you identify your metrics 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe prefix that an object must have to be included in the metrics 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.NoncurrentVersionExpiration": { "MarkdownDocumentation": "`AWS::S3::Bucket.NoncurrentVersionExpiration`\n\nSpecifies when noncurrent object versions expire. Upon expiration, Amazon S3\npermanently deletes the noncurrent object versions. You set this lifecycle configuration\naction on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's\nlifetime. For more information about setting a lifecycle rule configuration, see [AWS::S3::Bucket Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversionexpiration.html", "Properties": { "NoncurrentDays": { "MarkdownDocumentation": "`NoncurrentDays`\n\nSpecifies the number of days an object is noncurrent before Amazon S3 can\nperform the associated action. For information about the noncurrent days calculations, see\n[How\nAmazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3\nUser Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversionexpiration.html#cfn-s3-bucket-noncurrentversionexpiration-noncurrentdays", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "NewerNoncurrentVersions": { "MarkdownDocumentation": "`NewerNoncurrentVersions`\n\nSpecifies how many noncurrent versions Amazon S3 will retain. If there are this\nmany more recent noncurrent versions, Amazon S3 will take the associated action. For\nmore information about noncurrent versions, see [Lifecycle configuration\nelements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversionexpiration.html#cfn-s3-bucket-noncurrentversionexpiration-newernoncurrentversions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::S3::Bucket.NoncurrentVersionTransition": { "MarkdownDocumentation": "`AWS::S3::Bucket.NoncurrentVersionTransition`\n\nContainer for the transition rule that describes when noncurrent objects transition to the\n`STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`,\n`GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class.\nIf your bucket is versioning-enabled (or versioning is suspended), you can set this action to\nrequest that Amazon S3 transition noncurrent object versions to the `STANDARD_IA`,\n`ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`,\n`GLACIER`, or `DEEP_ARCHIVE` storage class at a specific period in the\nobject's lifetime. If you specify this property, don't specify the\n`NoncurrentVersionTransitions` property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversiontransition.html", "Properties": { "StorageClass": { "MarkdownDocumentation": "`StorageClass`\n\nThe class of storage used to store the object.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEEP_ARCHIVE | GLACIER | Gl...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEEP_ARCHIVE", "GLACIER", "Glacier", "GLACIER_IR", "INTELLIGENT_TIERING", "ONEZONE_IA", "STANDARD_IA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversiontransition.html#cfn-s3-bucket-noncurrentversiontransition-storageclass", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TransitionInDays": { "MarkdownDocumentation": "`TransitionInDays`\n\nSpecifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.\nFor information about the noncurrent days calculations, see [How Amazon S3 Calculates\nHow Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversiontransition.html#cfn-s3-bucket-noncurrentversiontransition-transitionindays", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "NewerNoncurrentVersions": { "MarkdownDocumentation": "`NewerNoncurrentVersions`\n\nSpecifies how many noncurrent versions Amazon S3 will retain. If there are this\nmany more recent noncurrent versions, Amazon S3 will take the associated action. For\nmore information about noncurrent versions, see [Lifecycle configuration\nelements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversiontransition.html#cfn-s3-bucket-noncurrentversiontransition-newernoncurrentversions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::S3::Bucket.NotificationConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.NotificationConfiguration`\n\nDescribes the notification configuration for an Amazon S3 bucket.\n###### Note\nIf you create the target resource and related permissions in the same template, you\nmight have a circular dependency.\nFor example, you might use the `AWS::Lambda::Permission` resource to grant\nthe bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to\ninvoke the function (AWS CloudFormation checks whether the bucket can\ninvoke the function). If you're using Refs to pass the bucket name, this leads to a circular\ndependency.\nTo avoid this dependency, you can create all resources without specifying the\nnotification configuration. Then, update the stack with a notification configuration.\nFor more information on permissions, see [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) and [Granting Permissions to Publish Event Notification Messages to a\nDestination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration.html", "Properties": { "TopicConfigurations": { "MarkdownDocumentation": "`TopicConfigurations`\n\nThe topic to which notifications are sent and the events for which notifications are\ngenerated.\n*Required*: No\n*Type*: Array of [TopicConfiguration](./aws-properties-s3-bucket-topicconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration.html#cfn-s3-bucket-notificationconfiguration-topicconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TopicConfiguration", "DuplicatesAllowed": false }, "QueueConfigurations": { "MarkdownDocumentation": "`QueueConfigurations`\n\nThe Amazon Simple Queue Service queues to publish messages to and the events for which to publish\nmessages.\n*Required*: No\n*Type*: Array of [QueueConfiguration](./aws-properties-s3-bucket-queueconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration.html#cfn-s3-bucket-notificationconfiguration-queueconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "QueueConfiguration", "DuplicatesAllowed": false }, "LambdaConfigurations": { "MarkdownDocumentation": "`LambdaConfigurations`\n\nDescribes the AWS Lambda functions to invoke and the events for which to invoke them.\n*Required*: No\n*Type*: Array of [LambdaConfiguration](./aws-properties-s3-bucket-lambdaconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration.html#cfn-s3-bucket-notificationconfiguration-lambdaconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LambdaConfiguration", "DuplicatesAllowed": false }, "EventBridgeConfiguration": { "MarkdownDocumentation": "`EventBridgeConfiguration`\n\nEnables delivery of events to Amazon EventBridge.\n*Required*: No\n*Type*: [EventBridgeConfiguration](./aws-properties-s3-bucket-eventbridgeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration.html#cfn-s3-bucket-notificationconfiguration-eventbridgeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EventBridgeConfiguration" } } }, "AWS::S3::Bucket.NotificationFilter": { "MarkdownDocumentation": "`AWS::S3::Bucket.NotificationFilter`\n\nSpecifies object key name filtering rules. For information about key name filtering, see [Configuring\nevent notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the\n*Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationfilter.html", "Properties": { "S3Key": { "MarkdownDocumentation": "`S3Key`\n\nA container for object key name prefix and suffix filtering rules.\n*Required*: Yes\n*Type*: [S3KeyFilter](./aws-properties-s3-bucket-s3keyfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationfilter.html#cfn-s3-bucket-notificationfilter-s3key", "UpdateType": "Mutable", "Required": true, "Type": "S3KeyFilter" } } }, "AWS::S3::Bucket.ObjectLockConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.ObjectLockConfiguration`\n\nPlaces an Object Lock configuration on the specified bucket. The rule specified in the\nObject Lock configuration will be applied by default to every new object placed in the\nspecified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html", "Properties": { "ObjectLockEnabled": { "MarkdownDocumentation": "`ObjectLockEnabled`\n\nIndicates whether this bucket has an Object Lock configuration enabled. Enable\n`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)\n", "RefReturnValue": "", "AllowedValues": [ "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-objectlockenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Rule": { "MarkdownDocumentation": "`Rule`\n\nSpecifies the Object Lock rule for the specified object. Enable this rule when you apply\n`ObjectLockConfiguration` to a bucket. If Object Lock is turned on, bucket\nsettings require both `Mode` and a period of either `Days` or\n`Years`. You cannot specify `Days` and `Years` at the same\ntime. 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-rule", "UpdateType": "Mutable", "Required": false, "Type": "ObjectLockRule" } } }, "AWS::S3::Bucket.ObjectLockRule": { "MarkdownDocumentation": "`AWS::S3::Bucket.ObjectLockRule`\n\nSpecifies the Object Lock rule for the specified object. Enable the this rule when you\napply `ObjectLockConfiguration` to a bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html", "Properties": { "DefaultRetention": { "MarkdownDocumentation": "`DefaultRetention`\n\nThe default Object Lock retention mode and period that you want to apply to new objects\nplaced in the specified bucket. If Object Lock is turned on, bucket settings require both\n`Mode` and a period of either `Days` or `Years`. You cannot\nspecify `Days` and `Years` at the same time. For more information about\nallowable 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html#cfn-s3-bucket-objectlockrule-defaultretention", "UpdateType": "Mutable", "Required": false, "Type": "DefaultRetention" } } }, "AWS::S3::Bucket.OwnershipControls": { "MarkdownDocumentation": "`AWS::S3::Bucket.OwnershipControls`\n\nSpecifies the container element for Object Ownership rules.\nS3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable\naccess control lists (ACLs) and take ownership of every object in your bucket, simplifying\naccess management for data stored in Amazon S3. For more information, see [Controlling\nownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nSpecifies the container element for Object Ownership rules.\n*Required*: Yes\n*Type*: Array of [OwnershipControlsRule](./aws-properties-s3-bucket-ownershipcontrolsrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html#cfn-s3-bucket-ownershipcontrols-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "OwnershipControlsRule", "DuplicatesAllowed": false } } }, "AWS::S3::Bucket.OwnershipControlsRule": { "MarkdownDocumentation": "`AWS::S3::Bucket.OwnershipControlsRule`\n\nSpecifies an Object Ownership rule.\nS3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable\naccess control lists (ACLs) and take ownership of every object in your bucket, simplifying\naccess management for data stored in Amazon S3. For more information, see [Controlling\nownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrolsrule.html", "Properties": { "ObjectOwnership": { "MarkdownDocumentation": "`ObjectOwnership`\n\nSpecifies an object ownership rule.\n*Required*: No\n*Type*: String\n*Allowed values*: `ObjectWriter | BucketOwnerP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ObjectWriter", "BucketOwnerPreferred", "BucketOwnerEnforced" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrolsrule.html#cfn-s3-bucket-ownershipcontrolsrule-objectownership", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.PartitionedPrefix": { "MarkdownDocumentation": "`AWS::S3::Bucket.PartitionedPrefix`\n\nAmazon S3 keys for log objects are partitioned in the following format:\n`[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`\nPartitionedPrefix defaults to EventTime delivery when server access logs are delivered.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-partitionedprefix.html", "Properties": { "PartitionDateSource": { "MarkdownDocumentation": "`PartitionDateSource`\n\nSpecifies the partition date source for the partitioned prefix. `PartitionDateSource` can\nbe `EventTime` or `DeliveryTime`.\nFor `DeliveryTime`, the time in the log file names corresponds to the delivery time for\nthe log files.\nFor `EventTime`, The logs delivered are for a specific day only. The year, month, and\nday correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00\nin the key.\n*Required*: No\n*Type*: String\n*Allowed values*: `EventTime | DeliveryTime...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EventTime", "DeliveryTime" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-partitionedprefix.html#cfn-s3-bucket-partitionedprefix-partitiondatesource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.PublicAccessBlockConfiguration`\n\nThe PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can\nenable the configuration options in any combination. Bucket-level settings work alongside\naccount-level settings (which may inherit from organization-level policies). For more\ninformation 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html", "Properties": { "RestrictPublicBuckets": { "MarkdownDocumentation": "`RestrictPublicBuckets`\n\nSpecifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element\nto `TRUE` restricts access to this bucket to only AWS service principals and\nauthorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and\ncross-account access within any public bucket policy, including non-public delegation to specific\naccounts, is blocked.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-restrictpublicbuckets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicPolicy": { "MarkdownDocumentation": "`BlockPublicPolicy`\n\nSpecifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to\n`TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy\nallows public access.\nEnabling this setting doesn't affect existing bucket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicAcls": { "MarkdownDocumentation": "`BlockPublicAcls`\n\nSpecifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects\nin 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicacls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IgnorePublicAcls": { "MarkdownDocumentation": "`IgnorePublicAcls`\n\nSpecifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting\nthis element to `TRUE` causes Amazon S3 to ignore all public ACLs on this bucket and objects in\nthis bucket.\nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new\npublic ACLs from being 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-ignorepublicacls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3::Bucket.QueueConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.QueueConfiguration`\n\nSpecifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS)\nqueue when Amazon S3 detects specified events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe filtering rules that determine which objects trigger notifications. For example, you\ncan create a filter so that Amazon S3 sends notifications only when image files with a\n`.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\n*Amazon S3 User Guide*.\n*Required*: No\n*Type*: [NotificationFilter](./aws-properties-s3-bucket-notificationfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-filter", "UpdateType": "Mutable", "Required": false, "Type": "NotificationFilter" }, "Event": { "MarkdownDocumentation": "`Event`\n\nThe Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For\nmore information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-event", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Queue": { "MarkdownDocumentation": "`Queue`\n\nThe Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a\nmessage when it detects events of the specified type. FIFO queues are not allowed when\nenabling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-queue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.RecordExpiration": { "MarkdownDocumentation": "`AWS::S3::Bucket.RecordExpiration`\n\nThe journal table record expiration settings for a journal table in an S3 Metadata configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-recordexpiration.html", "Properties": { "Days": { "MarkdownDocumentation": "`Days`\n\nIf you enable journal table record expiration, you can set the number of days to retain your\njournal table records. Journal table records must be retained for a minimum of 7 days. To set\nthis value, specify any whole number from `7` to `2147483647`. For example,\nto retain your journal table records for one year, set this value to `365`.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-recordexpiration.html#cfn-s3-bucket-recordexpiration-days", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Expiration": { "MarkdownDocumentation": "`Expiration`\n\nSpecifies whether journal table record expiration is enabled or disabled.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-recordexpiration.html#cfn-s3-bucket-recordexpiration-expiration", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.RedirectAllRequestsTo": { "MarkdownDocumentation": "`AWS::S3::Bucket.RedirectAllRequestsTo`\n\nSpecifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectallrequeststo.html", "Properties": { "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nProtocol to use when redirecting requests. The default is the protocol that is used in the original\nrequest.\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)", "RefReturnValue": "", "AllowedValues": [ "http", "https" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectallrequeststo.html#cfn-s3-bucket-redirectallrequeststo-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostName": { "MarkdownDocumentation": "`HostName`\n\nName of the host where requests are redirected.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectallrequeststo.html#cfn-s3-bucket-redirectallrequeststo-hostname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.RedirectRule": { "MarkdownDocumentation": "`AWS::S3::Bucket.RedirectRule`\n\nSpecifies how requests are redirected. In the event of an error, you can specify a different error\ncode to return.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html", "Properties": { "ReplaceKeyWith": { "MarkdownDocumentation": "`ReplaceKeyWith`\n\nThe specific object key to use in the redirect request. For example, redirect request to\n`error.html`. Not required if one of the siblings is present. Can be present only if\n`ReplaceKeyPrefixWith` is not provided.\n###### Important\nReplacement must be made for object keys containing special characters (such as carriage returns) when using\nXML 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-replacekeywith", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpRedirectCode": { "MarkdownDocumentation": "`HttpRedirectCode`\n\nThe HTTP redirect code to use on the response. Not required if one of the siblings is\npresent.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-httpredirectcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nProtocol to use when redirecting requests. The default is the protocol that is used in the original\nrequest.\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)", "RefReturnValue": "", "AllowedValues": [ "http", "https" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostName": { "MarkdownDocumentation": "`HostName`\n\nThe host name to use in the redirect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-hostname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReplaceKeyPrefixWith": { "MarkdownDocumentation": "`ReplaceKeyPrefixWith`\n\nThe object key prefix to use in the redirect request. For example, to redirect requests for all\npages with prefix `docs/` (objects in the `docs/` folder) to\n`documents/`, you can set a condition block with `KeyPrefixEquals` set to\n`docs/` and in the Redirect set `ReplaceKeyPrefixWith` to\n`/documents`. Not required if one of the siblings is present. Can be present only if\n`ReplaceKeyWith` is not provided.\n###### Important\nReplacement must be made for object keys containing special characters (such as carriage returns) when using\nXML 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-redirectrule.html#cfn-s3-bucket-redirectrule-replacekeyprefixwith", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.ReplicaModifications": { "MarkdownDocumentation": "`AWS::S3::Bucket.ReplicaModifications`\n\nA filter that you can specify for selection for modifications on replicas.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicamodifications.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies whether Amazon S3 replicates modifications on replicas.\n*Allowed values*: `Enabled` | `Disabled...`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Enabled | Disabled`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled`", "`Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicamodifications.html#cfn-s3-bucket-replicamodifications-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.ReplicationConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.ReplicationConfiguration`\n\nA container for replication rules. You can add up to 1,000 rules. The maximum size of a\nreplication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see\n[Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in\nthe *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating\nobjects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nA container for one or more replication rules. A replication configuration must have at least one\nrule and can contain a maximum of 1,000 rules.\n*Required*: Yes\n*Type*: Array of [ReplicationRule](./aws-properties-s3-bucket-replicationrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ReplicationRule", "DuplicatesAllowed": false } } }, "AWS::S3::Bucket.ReplicationDestination": { "MarkdownDocumentation": "`AWS::S3::Bucket.ReplicationDestination`\n\nA container for information about the replication destination and its configurations including\nenabling the S3 Replication Time Control (S3 RTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html", "Properties": { "AccessControlTranslation": { "MarkdownDocumentation": "`AccessControlTranslation`\n\nSpecify this only in a cross-account scenario (where source and destination bucket owners are not\nthe same), and you want to change replica ownership to the AWS account that owns the destination\nbucket. If this is not specified in the replication configuration, the replicas are owned by same\nAWS account that owns the source object.\n*Required*: No\n*Type*: [AccessControlTranslation](./aws-properties-s3-bucket-accesscontroltranslation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-accesscontroltranslation", "UpdateType": "Mutable", "Required": false, "Type": "AccessControlTranslation" }, "Account": { "MarkdownDocumentation": "`Account`\n\nDestination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3\nto change replica ownership to the AWS account that owns the destination\nbucket by specifying the `AccessControlTranslation` property, this is the account\nID of the destination bucket owner. For more information, see [Cross-Region Replication Additional\nConfiguration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User\nGuide*.\nIf you specify the `AccessControlTranslation` property, the\n`Account` property 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-account", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Metrics": { "MarkdownDocumentation": "`Metrics`\n\nA container specifying replication metrics-related settings enabling replication metrics and\nevents.\n*Required*: No\n*Type*: [Metrics](./aws-properties-s3-bucket-metrics.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-metrics", "UpdateType": "Mutable", "Required": false, "Type": "Metrics" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nSpecifies encryption-related information.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfiguration" }, "StorageClass": { "MarkdownDocumentation": "`StorageClass`\n\nThe storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By\ndefault, Amazon S3 uses the storage class of the source object to create the object replica.\nFor valid values, see the `StorageClass` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the\n*Amazon S3 API Reference*.\n`FSX_OPENZFS` is not an accepted value when replicating objects.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEEP_ARCHIVE | GLACIER | GL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEEP_ARCHIVE", "GLACIER", "GLACIER_IR", "INTELLIGENT_TIERING", "ONEZONE_IA", "REDUCED_REDUNDANCY", "STANDARD", "STANDARD_IA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-storageclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReplicationTime": { "MarkdownDocumentation": "`ReplicationTime`\n\nA container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all\nobjects and operations on objects must be replicated. Must be specified together with a\n`Metrics` block.\n*Required*: No\n*Type*: [ReplicationTime](./aws-properties-s3-bucket-replicationtime.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-replicationtime", "UpdateType": "Mutable", "Required": false, "Type": "ReplicationTime" } } }, "AWS::S3::Bucket.ReplicationRule": { "MarkdownDocumentation": "`AWS::S3::Bucket.ReplicationRule`\n\nSpecifies which Amazon S3 objects to replicate and where to store the replicas.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies 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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html#cfn-s3-bucket-replicationrule-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Destination": { "MarkdownDocumentation": "`Destination`\n\nA container for information about the replication destination and its configurations including\nenabling the S3 Replication Time Control (S3 RTC).\n*Required*: Yes\n*Type*: [ReplicationDestination](./aws-properties-s3-bucket-replicationdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html#cfn-s3-bucket-replicationrule-destination", "UpdateType": "Mutable", "Required": true, "Type": "ReplicationDestination" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nA filter that identifies the subset of objects to which the replication rule applies. A\n`Filter` must specify exactly one `Prefix`, `TagFilter`, or\nan `And` child element. The use of the filter field indicates that this is a V2\nreplication configuration. This field isn't supported in a V1 replication\nconfiguration.\n###### Note\nV1 replication configuration only supports filtering by key prefix. To filter using a V1\nreplication configuration, add the `Prefix` directly as a child element of the\n`Rule` element.\n*Required*: No\n*Type*: [ReplicationRuleFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html#cfn-s3-bucket-replicationrule-filter", "UpdateType": "Mutable", "Required": false, "Type": "ReplicationRuleFilter" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority indicates which rule has precedence whenever two or more replication rules conflict.\nAmazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or\nmore rules with the same destination bucket, then objects will be replicated according to the rule with\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html#cfn-s3-bucket-replicationrule-priority", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SourceSelectionCriteria": { "MarkdownDocumentation": "`SourceSelectionCriteria`\n\nA container that describes additional filters for identifying the source objects that you\nwant to replicate. You can choose to enable or disable the replication of these\nobjects.\n*Required*: No\n*Type*: [SourceSelectionCriteria](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html#cfn-s3-bucket-replicationrule-sourceselectioncriteria", "UpdateType": "Mutable", "Required": false, "Type": "SourceSelectionCriteria" }, "Id": { "MarkdownDocumentation": "`Id`\n\nA unique identifier for the rule. The maximum value is 255 characters. If you don't\nspecify a value, AWS CloudFormation generates a random ID. When using a V2\nreplication configuration this property is capitalized as \"ID\".\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html#cfn-s3-bucket-replicationrule-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nAn object key name prefix that identifies the object or objects to which the rule applies.\nThe maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an\nempty string. To filter using a V1 replication configuration, add the `Prefix`\ndirectly as a child element of the `Rule` element.\n###### Important\nReplacement must be made for object keys containing special characters (such as carriage\nreturns) when using XML requests. For more information, see [XML\nrelated 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html#cfn-s3-bucket-replicationrule-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeleteMarkerReplication": { "MarkdownDocumentation": "`DeleteMarkerReplication`\n\nSpecifies whether Amazon S3 replicates delete markers. If you specify a `Filter` in your\nreplication configuration, you must also include a `DeleteMarkerReplication` element. If your\n`Filter` includes a `Tag` element, the `DeleteMarkerReplication``Status` must be set to Disabled, because Amazon S3 does not support replicating delete markers\nfor tag-based rules. For an example configuration, see [Basic Rule\nConfiguration](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).\n###### Note\nIf you are using an earlier version of the replication configuration, Amazon S3 handles replication of\ndelete 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrule.html#cfn-s3-bucket-replicationrule-deletemarkerreplication", "UpdateType": "Mutable", "Required": false, "Type": "DeleteMarkerReplication" } } }, "AWS::S3::Bucket.ReplicationRuleAndOperator": { "MarkdownDocumentation": "`AWS::S3::Bucket.ReplicationRuleAndOperator`\n\nA container for specifying rule filters. The filters determine the subset of objects to\nwhich the rule applies. This element is required only if you specify more than one filter.\nFor example:\n* If you specify both a `Prefix` and a `TagFilter`, wrap these\n filters in an `And` tag.\n* If you specify a filter based on multiple tags, wrap the `TagFilter`\n elements in an `And` tag\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html", "Properties": { "TagFilters": { "MarkdownDocumentation": "`TagFilters`\n\nAn array of tags containing key and value pairs.\n*Required*: No\n*Type*: Array of [TagFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html#cfn-s3-bucket-replicationruleandoperator-tagfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagFilter", "DuplicatesAllowed": false }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nAn object key name prefix that identifies the subset of objects to which the rule applies.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html#cfn-s3-bucket-replicationruleandoperator-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.ReplicationRuleFilter": { "MarkdownDocumentation": "`AWS::S3::Bucket.ReplicationRuleFilter`\n\nA filter that identifies the subset of objects to which the replication rule applies. A\n`Filter` must specify exactly one `Prefix`, `TagFilter`, or\nan `And` child element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html", "Properties": { "And": { "MarkdownDocumentation": "`And`\n\nA container for specifying rule filters. The filters determine the subset of objects to\nwhich the rule applies. This element is required only if you specify more than one filter. For\nexample:\n* If you specify both a `Prefix` and a `TagFilter`, wrap these\n filters in an `And` tag.\n* If you specify a filter based on multiple tags, wrap the `TagFilter`\n elements in an `And` tag.\n*Required*: No\n*Type*: [ReplicationRuleAndOperator](./aws-properties-s3-bucket-replicationruleandoperator.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-and", "UpdateType": "Mutable", "Required": false, "Type": "ReplicationRuleAndOperator" }, "TagFilter": { "MarkdownDocumentation": "`TagFilter`\n\nA container for specifying a tag key and value.\nThe rule applies only to objects that have the tag in their tag set.\n*Required*: No\n*Type*: [TagFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-tagfilter", "UpdateType": "Mutable", "Required": false, "Type": "TagFilter" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nAn object key name prefix that identifies the subset of objects to which the rule applies.\n###### Important\nReplacement must be made for object keys containing special characters (such as carriage returns) when using\nXML 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.ReplicationTime": { "MarkdownDocumentation": "`AWS::S3::Bucket.ReplicationTime`\n\nA container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and\nthe time when all objects and operations on objects must be replicated. Must be specified together with\na `Metrics` block.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies whether the replication time 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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html#cfn-s3-bucket-replicationtime-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Time": { "MarkdownDocumentation": "`Time`\n\nA container specifying the time by which replication should be complete for all objects and\noperations on objects.\n*Required*: Yes\n*Type*: [ReplicationTimeValue](./aws-properties-s3-bucket-replicationtimevalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html#cfn-s3-bucket-replicationtime-time", "UpdateType": "Mutable", "Required": true, "Type": "ReplicationTimeValue" } } }, "AWS::S3::Bucket.ReplicationTimeValue": { "MarkdownDocumentation": "`AWS::S3::Bucket.ReplicationTimeValue`\n\nA container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics\n`EventThreshold`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtimevalue.html", "Properties": { "Minutes": { "MarkdownDocumentation": "`Minutes`\n\nContains an integer specifying time in minutes.\nValid value: 15\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtimevalue.html#cfn-s3-bucket-replicationtimevalue-minutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::S3::Bucket.RoutingRule": { "MarkdownDocumentation": "`AWS::S3::Bucket.RoutingRule`\n\nSpecifies the redirect behavior and when a redirect is applied. For more information about routing\nrules, see [Configuring\nadvanced conditional redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-routingrule.html", "Properties": { "RedirectRule": { "MarkdownDocumentation": "`RedirectRule`\n\nContainer for redirect information. You can redirect requests to another host, to another page, or\nwith another protocol. In the event of an error, you can specify a different error code to\nreturn.\n*Required*: Yes\n*Type*: [RedirectRule](./aws-properties-s3-bucket-redirectrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-routingrule.html#cfn-s3-bucket-routingrule-redirectrule", "UpdateType": "Mutable", "Required": true, "Type": "RedirectRule" }, "RoutingRuleCondition": { "MarkdownDocumentation": "`RoutingRuleCondition`\n\nA container for describing a condition that must be met for the specified redirect to apply. For\nexample, 1. If request is for pages in the `/docs` folder, redirect to the\n`/documents` folder. 2. If request results in HTTP error 4xx, redirect request to another\nhost where you might process the error.\n*Required*: No\n*Type*: [RoutingRuleCondition](./aws-properties-s3-bucket-routingrulecondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-routingrule.html#cfn-s3-bucket-routingrule-routingrulecondition", "UpdateType": "Mutable", "Required": false, "Type": "RoutingRuleCondition" } } }, "AWS::S3::Bucket.RoutingRuleCondition": { "MarkdownDocumentation": "`AWS::S3::Bucket.RoutingRuleCondition`\n\nA container for describing a condition that must be met for the specified redirect to apply. For\nexample, 1. If request is for pages in the `/docs` folder, redirect to the\n`/documents` folder. 2. If request results in HTTP error 4xx, redirect request to another\nhost where you might process the error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-routingrulecondition.html", "Properties": { "KeyPrefixEquals": { "MarkdownDocumentation": "`KeyPrefixEquals`\n\nThe object key name prefix when the redirect is applied. For example, to redirect requests\nfor `ExamplePage.html`, the key prefix will be `ExamplePage.html`. To\nredirect request for all pages with the prefix `docs/`, the key prefix will be\n`docs/`, which identifies all objects in the docs/ folder.\nRequired when the parent element `Condition` is specified and sibling\n`HttpErrorCodeReturnedEquals` is not specified. If both conditions are specified,\nboth must be true for the redirect to be applied.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-routingrulecondition.html#cfn-s3-bucket-routingrulecondition-keyprefixequals", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpErrorCodeReturnedEquals": { "MarkdownDocumentation": "`HttpErrorCodeReturnedEquals`\n\nThe HTTP error code when the redirect is applied. In the event of an error, if the error\ncode equals this value, then the specified redirect is applied.\nRequired when parent element `Condition` is specified and sibling\n`KeyPrefixEquals` is not specified. If both are specified, then both must be true\nfor the redirect to be applied.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-routingrulecondition.html#cfn-s3-bucket-routingrulecondition-httperrorcodereturnedequals", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.Rule": { "MarkdownDocumentation": "`AWS::S3::Bucket.Rule`\n\nSpecifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket\nLifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference*.\nYou must specify at least one of the following properties:\n`AbortIncompleteMultipartUpload`, `ExpirationDate`,\n`ExpirationInDays`, `NoncurrentVersionExpirationInDays`,\n`NoncurrentVersionTransition`, `NoncurrentVersionTransitions`,\n`Transition`, or `Transitions`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nIf `Enabled`, the rule is currently being applied. If `Disabled`, the rule is\nnot currently being applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Enabled | Disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExpiredObjectDeleteMarker": { "MarkdownDocumentation": "`ExpiredObjectDeleteMarker`\n\nIndicates whether Amazon S3 will remove a delete marker without any noncurrent versions.\nIf set to true, the delete marker will be removed if there are no noncurrent versions. This\ncannot be specified with `ExpirationInDays`, `ExpirationDate`, or\n`TagFilters`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-expiredobjectdeletemarker", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NoncurrentVersionExpirationInDays": { "MarkdownDocumentation": "`NoncurrentVersionExpirationInDays`\n\n(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in\ndays, between when a new version of the object is uploaded to the bucket and when old versions\nof the object expire. When object versions expire, Amazon S3 permanently deletes them. If you\nspecify a transition and expiration time, the expiration time must be later than the\ntransition 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-noncurrentversionexpirationindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Transitions": { "MarkdownDocumentation": "`Transitions`\n\nOne or more transition rules that specify when an object transitions to a specified\nstorage class. If you specify an expiration and transition time, you must use the same time\nunit for both properties (either in days or by date). The expiration time must also be later\nthan the transition time. If you specify this property, don't specify the\n`Transition` property.\n*Required*: Conditional\n*Type*: Array of [Transition](./aws-properties-s3-bucket-transition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-transitions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Transition", "DuplicatesAllowed": false }, "ObjectSizeGreaterThan": { "MarkdownDocumentation": "`ObjectSizeGreaterThan`\n\nSpecifies the minimum object size in bytes for this rule to apply to. Objects must be\nlarger 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\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-objectsizegreaterthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagFilters": { "MarkdownDocumentation": "`TagFilters`\n\nTags to use to identify a subset of objects to which the lifecycle rule applies.\n*Required*: No\n*Type*: Array of [TagFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-tagfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagFilter", "DuplicatesAllowed": false }, "NoncurrentVersionTransitions": { "MarkdownDocumentation": "`NoncurrentVersionTransitions`\n\nFor buckets with versioning enabled (or suspended), one or more transition rules that\nspecify when non-current objects transition to a specified storage class. If you specify a\ntransition and expiration time, the expiration time must be later than the transition time. If\nyou specify this property, don't specify the `NoncurrentVersionTransition`\nproperty.\n*Required*: Conditional\n*Type*: Array of [NoncurrentVersionTransition](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-noncurrentversiontransitions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NoncurrentVersionTransition", "DuplicatesAllowed": false }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nObject key prefix that identifies one or more objects to which this rule applies.\n###### Important\nReplacement must be made for object keys containing special characters (such as carriage returns) when using\nXML 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ObjectSizeLessThan": { "MarkdownDocumentation": "`ObjectSizeLessThan`\n\nSpecifies the maximum object size in bytes for this rule to apply to. Objects must be\nsmaller 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\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-objectsizelessthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NoncurrentVersionTransition": { "MarkdownDocumentation": "`NoncurrentVersionTransition`\n\n(Deprecated.) For buckets with versioning enabled (or suspended), specifies when\nnon-current objects transition to a specified storage class. If you specify a transition and\nexpiration time, the expiration time must be later than the transition time. If you specify\nthis property, don't specify the `NoncurrentVersionTransitions` property.\n*Required*: Conditional\n*Type*: [NoncurrentVersionTransition](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-noncurrentversiontransition", "UpdateType": "Mutable", "Required": false, "Type": "NoncurrentVersionTransition" }, "ExpirationDate": { "MarkdownDocumentation": "`ExpirationDate`\n\nIndicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value\nmust be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and\ntransition time, you must use the same time unit for both properties (either in days or by\ndate). The expiration time must also be later than the transition time.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^(\\d{4})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-expirationdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NoncurrentVersionExpiration": { "MarkdownDocumentation": "`NoncurrentVersionExpiration`\n\nSpecifies when noncurrent object versions expire. Upon expiration, Amazon S3\npermanently deletes the noncurrent object versions. You set this lifecycle configuration\naction on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's\nlifetime.\n*Required*: No\n*Type*: [NoncurrentVersionExpiration](./aws-properties-s3-bucket-noncurrentversionexpiration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-noncurrentversionexpiration", "UpdateType": "Mutable", "Required": false, "Type": "NoncurrentVersionExpiration" }, "ExpirationInDays": { "MarkdownDocumentation": "`ExpirationInDays`\n\nIndicates the number of days after creation when objects are deleted from Amazon S3 and\nAmazon S3 Glacier. If you specify an expiration and transition time, you must use the same\ntime unit for both properties (either in days or by date). The expiration time must also be\nlater 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-expirationindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Transition": { "MarkdownDocumentation": "`Transition`\n\n(Deprecated.) Specifies when an object transitions to a specified storage class. If you\nspecify an expiration and transition time, you must use the same time unit for both properties\n(either in days or by date). The expiration time must also be later than the transition time.\nIf you specify this property, don't specify the `Transitions` property.\n*Required*: Conditional\n*Type*: [Transition](./aws-properties-s3-bucket-transition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-transition", "UpdateType": "Mutable", "Required": false, "Type": "Transition" }, "Id": { "MarkdownDocumentation": "`Id`\n\nUnique identifier for the rule. The value can't be longer than 255 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AbortIncompleteMultipartUpload": { "MarkdownDocumentation": "`AbortIncompleteMultipartUpload`\n\nSpecifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3\nbucket.\n*Required*: Conditional\n*Type*: [AbortIncompleteMultipartUpload](./aws-properties-s3-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-rule.html#cfn-s3-bucket-rule-abortincompletemultipartupload", "UpdateType": "Mutable", "Required": false, "Type": "AbortIncompleteMultipartUpload" } } }, "AWS::S3::Bucket.S3KeyFilter": { "MarkdownDocumentation": "`AWS::S3::Bucket.S3KeyFilter`\n\nA container for object key name prefix and suffix filtering rules. For more information\nabout object key name filtering, see [Configuring event\nnotifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User\nGuide*.\n###### Note\nThe same type of filter rule cannot be used more than once. For example, you cannot\nspecify two prefix rules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-s3keyfilter.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nA list of containers for the key-value pair that defines the criteria for the filter rule.\n*Required*: Yes\n*Type*: Array of [FilterRule](./aws-properties-s3-bucket-filterrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-s3keyfilter.html#cfn-s3-bucket-s3keyfilter-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FilterRule", "DuplicatesAllowed": false } } }, "AWS::S3::Bucket.S3TablesDestination": { "MarkdownDocumentation": "`AWS::S3::Bucket.S3TablesDestination`\n\nThe destination information for a V1 S3 Metadata configuration. The destination table bucket must\nbe in the same Region and AWS account as the general purpose bucket. The specified metadata table name\nmust be unique within the `aws_s3_metadata` namespace in the destination table bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-s3tablesdestination.html", "Properties": { "TableBucketArn": { "MarkdownDocumentation": "`TableBucketArn`\n\nThe Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the\nmetadata table configuration. The destination table bucket must be in the same Region and AWS account\nas the general purpose 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-s3tablesdestination.html#cfn-s3-bucket-s3tablesdestination-tablebucketarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name for the metadata table in your metadata table configuration. The specified metadata table\nname must be unique within the `aws_s3_metadata` namespace in the destination table 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-s3tablesdestination.html#cfn-s3-bucket-s3tablesdestination-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableArn": { "MarkdownDocumentation": "`TableArn`\n\nThe Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-s3tablesdestination.html#cfn-s3-bucket-s3tablesdestination-tablearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TableNamespace": { "MarkdownDocumentation": "`TableNamespace`\n\nThe table bucket namespace for the metadata table in your metadata table configuration. This value is always `aws_s3_metadata`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-s3tablesdestination.html#cfn-s3-bucket-s3tablesdestination-tablenamespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.ServerSideEncryptionByDefault": { "MarkdownDocumentation": "`AWS::S3::Bucket.ServerSideEncryptionByDefault`\n\nDescribes the default server-side encryption to apply to new objects in the bucket. If a PUT Object\nrequest doesn't specify any server-side encryption, this default encryption will be applied. For more\ninformation, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html).\n###### Note\n* **General purpose buckets** - If you don't specify a customer managed key\n at configuration, Amazon S3 automatically creates an AWS KMS key (`aws/s3`) in your AWS\n account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3\n uses this KMS key for SSE-KMS.\n* **Directory buckets** -\n Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) per directory bucket's lifetime.\n The [AWS managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) (`aws/s3`) isn't supported.\n* **Directory buckets** -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html", "Properties": { "SSEAlgorithm": { "MarkdownDocumentation": "`SSEAlgorithm`\n\nServer-side encryption algorithm to use for the default encryption.\n###### Note\nFor directory buckets, there are only two supported values for server-side encryption: `AES256` and `aws:kms`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `aws:kms | AES256 | aws:kms:...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "aws:kms", "AES256", "aws:kms:dsse" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-ssealgorithm", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KMSMasterKeyID": { "MarkdownDocumentation": "`KMSMasterKeyID`\n\nAWS Key Management Service (KMS) customer managed key ID to use for the default encryption.\n###### Note\n* **General purpose buckets** - This parameter is allowed if and\n only if `SSEAlgorithm` is set to `aws:kms` or\n `aws:kms:dsse`.\n* **Directory buckets** - This parameter is allowed if and\n only if `SSEAlgorithm` is set to `aws:kms`.\nYou can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.\n* Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n* Key ARN:\n `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n* Key Alias: `alias/alias-name`\nIf you are using encryption with cross-account or AWS service operations, you must use a fully\nqualified KMS key ARN. For more information, see [Using\nencryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).\n###### Note\n* **General purpose buckets** - If you're specifying a customer\n managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key\n alias instead, then AWS KMS resolves the key within the requester\u2019s account. This behavior can\n result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket\n owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when\n creating a VPC flow log.\n* **Directory buckets** -\n When you specify an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.\n###### Important\nAmazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in\nAWS KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *AWS Key Management 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-kmsmasterkeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.ServerSideEncryptionRule": { "MarkdownDocumentation": "`AWS::S3::Bucket.ServerSideEncryptionRule`\n\nSpecifies the default server-side encryption configuration.\n###### Note\n* **General purpose buckets** - If you're specifying a customer\n managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key\n alias instead, then AWS KMS resolves the key within the requester\u2019s account. This behavior can\n result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket\n owner.\n* **Directory buckets** -\n When you specify an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html", "Properties": { "BucketKeyEnabled": { "MarkdownDocumentation": "`BucketKeyEnabled`\n\nSpecifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using\nKMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the\n`BucketKeyEnabled` element to `true` causes Amazon S3 to use an S3\nBucket Key. By default, S3 Bucket Key is not enabled.\nFor more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the\n*Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-bucketkeyenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockedEncryptionTypes": { "MarkdownDocumentation": "`BlockedEncryptionTypes`\n\nA bucket-level setting for Amazon S3 general purpose buckets used to prevent the upload of new objects encrypted with the specified server-side encryption type. For example, blocking an encryption type will block `PutObject`, `CopyObject`, `PostObject`, multipart upload, and replication requests to the bucket for objects with the specified encryption type. However, you can continue to read and list any pre-existing objects already encrypted with the specified encryption type. For more information, see [Blocking or unblocking SSE-C for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html).\n###### Note\nCurrently, this parameter only supports blocking or unblocking server-side encryption with customer-provided keys (SSE-C). For more information about SSE-C, see [Using server-side encryption with customer-provided keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).\n*Required*: No\n*Type*: [BlockedEncryptionTypes](./aws-properties-s3-bucket-blockedencryptiontypes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-blockedencryptiontypes", "UpdateType": "Mutable", "Required": false, "Type": "BlockedEncryptionTypes" }, "ServerSideEncryptionByDefault": { "MarkdownDocumentation": "`ServerSideEncryptionByDefault`\n\nSpecifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object\nrequest doesn't specify any server-side encryption, this default encryption will be applied.\n*Required*: No\n*Type*: [ServerSideEncryptionByDefault](./aws-properties-s3-bucket-serversideencryptionbydefault.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-serversideencryptionbydefault", "UpdateType": "Mutable", "Required": false, "Type": "ServerSideEncryptionByDefault" } } }, "AWS::S3::Bucket.SourceSelectionCriteria": { "MarkdownDocumentation": "`AWS::S3::Bucket.SourceSelectionCriteria`\n\nA container that describes additional filters for identifying the source objects that you\nwant to replicate. You can choose to enable or disable the replication of these\nobjects.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html", "Properties": { "ReplicaModifications": { "MarkdownDocumentation": "`ReplicaModifications`\n\nA filter that you can specify for selection for modifications on replicas.\n*Required*: No\n*Type*: [ReplicaModifications](./aws-properties-s3-bucket-replicamodifications.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html#cfn-s3-bucket-sourceselectioncriteria-replicamodifications", "UpdateType": "Mutable", "Required": false, "Type": "ReplicaModifications" }, "SseKmsEncryptedObjects": { "MarkdownDocumentation": "`SseKmsEncryptedObjects`\n\nA container for filter information for the selection of Amazon S3 objects encrypted with\nAWS KMS.\n*Required*: No\n*Type*: [SseKmsEncryptedObjects](./aws-properties-s3-bucket-ssekmsencryptedobjects.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html#cfn-s3-bucket-sourceselectioncriteria-ssekmsencryptedobjects", "UpdateType": "Mutable", "Required": false, "Type": "SseKmsEncryptedObjects" } } }, "AWS::S3::Bucket.SseKmsEncryptedObjects": { "MarkdownDocumentation": "`AWS::S3::Bucket.SseKmsEncryptedObjects`\n\nA container for filter information for the selection of S3 objects encrypted with AWS KMS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nSpecifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key\nstored in AWS Key Management Service.\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)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Enabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html#cfn-s3-bucket-ssekmsencryptedobjects-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.StorageClassAnalysis": { "MarkdownDocumentation": "`AWS::S3::Bucket.StorageClassAnalysis`\n\nSpecifies data related to access patterns to be collected and made available to analyze the\ntradeoffs between different storage classes for an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html", "Properties": { "DataExport": { "MarkdownDocumentation": "`DataExport`\n\nSpecifies how data related to the storage class analysis for an Amazon S3 bucket should be\nexported.\n*Required*: No\n*Type*: [DataExport](./aws-properties-s3-bucket-dataexport.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html#cfn-s3-bucket-storageclassanalysis-dataexport", "UpdateType": "Mutable", "Required": false, "Type": "DataExport" } } }, "AWS::S3::Bucket.TagFilter": { "MarkdownDocumentation": "`AWS::S3::Bucket.TagFilter`\n\nSpecifies tags to use to identify a subset of objects for an Amazon S3 bucket. For more information, see [Categorizing your storage using tags](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html) in the *Amazon Simple Storage Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe tag 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe tag 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.TargetObjectKeyFormat": { "MarkdownDocumentation": "`AWS::S3::Bucket.TargetObjectKeyFormat`\n\nAmazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is\nallowed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-targetobjectkeyformat.html", "Properties": { "PartitionedPrefix": { "MarkdownDocumentation": "`PartitionedPrefix`\n\nPartitioned S3 key for log objects.\n*Required*: No\n*Type*: [PartitionedPrefix](./aws-properties-s3-bucket-partitionedprefix.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-targetobjectkeyformat.html#cfn-s3-bucket-targetobjectkeyformat-partitionedprefix", "UpdateType": "Mutable", "Required": false, "Type": "PartitionedPrefix" }, "SimplePrefix": { "MarkdownDocumentation": "`SimplePrefix`\n\nTo use the simple format for S3 keys for log objects. To specify SimplePrefix format, set\nSimplePrefix to {}.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-targetobjectkeyformat.html#cfn-s3-bucket-targetobjectkeyformat-simpleprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::S3::Bucket.Tiering": { "MarkdownDocumentation": "`AWS::S3::Bucket.Tiering`\n\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically\nmoving data to the most cost-effective storage access tier, without additional operational\noverhead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html", "Properties": { "AccessTier": { "MarkdownDocumentation": "`AccessTier`\n\nS3 Intelligent-Tiering access tier. See [Storage class for\nautomatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access\ntiers in the S3 Intelligent-Tiering storage class.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ARCHIVE_ACCESS | DEEP_ARCHI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ARCHIVE_ACCESS", "DEEP_ARCHIVE_ACCESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html#cfn-s3-bucket-tiering-accesstier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Days": { "MarkdownDocumentation": "`Days`\n\nThe number of consecutive days of no access after which an object will be eligible to be\ntransitioned to the corresponding tier. The minimum number of days specified for Archive Access tier\nmust be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to\n2 years (730 days).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html#cfn-s3-bucket-tiering-days", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::S3::Bucket.TopicConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.TopicConfiguration`\n\nA container for specifying the configuration for publication of messages to an Amazon Simple\nNotification Service (Amazon SNS) topic when Amazon S3 detects specified events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-topicconfiguration.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe filtering rules that determine for which objects to send notifications. For example,\nyou can create a filter so that Amazon S3 sends notifications only when image files with a\n`.jpg` extension are added to the bucket.\n*Required*: No\n*Type*: [NotificationFilter](./aws-properties-s3-bucket-notificationfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-topicconfiguration.html#cfn-s3-bucket-topicconfiguration-filter", "UpdateType": "Mutable", "Required": false, "Type": "NotificationFilter" }, "Event": { "MarkdownDocumentation": "`Event`\n\nThe Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in\nthe *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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-topicconfiguration.html#cfn-s3-bucket-topicconfiguration-event", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Topic": { "MarkdownDocumentation": "`Topic`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it\ndetects events of the specified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-topicconfiguration.html#cfn-s3-bucket-topicconfiguration-topic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.Transition": { "MarkdownDocumentation": "`AWS::S3::Bucket.Transition`\n\nSpecifies when an object transitions to a specified storage class. For more information about Amazon S3\nlifecycle configuration rules, see [Transitioning Objects Using\nAmazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-transition.html", "Properties": { "TransitionDate": { "MarkdownDocumentation": "`TransitionDate`\n\nIndicates when objects are transitioned to the specified storage class. The date value must be in\nISO 8601 format. The time is always midnight UTC.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^(\\d{4})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-transition.html#cfn-s3-bucket-transition-transitiondate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StorageClass": { "MarkdownDocumentation": "`StorageClass`\n\nThe storage class to which you want the object to transition.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEEP_ARCHIVE | GLACIER | Gl...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEEP_ARCHIVE", "GLACIER", "Glacier", "GLACIER_IR", "INTELLIGENT_TIERING", "ONEZONE_IA", "STANDARD_IA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-transition.html#cfn-s3-bucket-transition-storageclass", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TransitionInDays": { "MarkdownDocumentation": "`TransitionInDays`\n\nIndicates the number of days after creation when objects are transitioned to the specified storage\nclass. If the specified storage class is `INTELLIGENT_TIERING`, `GLACIER_IR`,\n`GLACIER`, or `DEEP_ARCHIVE`, valid values are `0` or positive\nintegers. If the specified storage class is `STANDARD_IA` or `ONEZONE_IA`, valid\nvalues are positive integers greater than `30`. Be aware that some storage classes have a\nminimum storage duration and that you're charged for transitioning objects before their minimum storage\nduration. For more information, see [Constraints and considerations for transitions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-transition-general-considerations.html#lifecycle-configuration-constraints) in the *Amazon S3 User\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-transition.html#cfn-s3-bucket-transition-transitionindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::S3::Bucket.VersioningConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.VersioningConfiguration`\n\nDescribes the versioning state of an Amazon S3 bucket. For more information, see [PUT\nBucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*.\nKeep the following timing in mind when enabling, suspending, or transitioning between versioning states:\n* **Enabling versioning** - Changes may take up to 15 minutes to propagate across all AWS regions for full consistency.\n* **Suspending versioning** - Takes effect immediately with no propagation delay.\n* **Transitioning between states** - Any change from Suspended to Enabled has a 15-minute delay.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe versioning state of the bucket.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Enabled | Suspended...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Suspended" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfiguration.html#cfn-s3-bucket-versioningconfiguration-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::Bucket.WebsiteConfiguration": { "MarkdownDocumentation": "`AWS::S3::Bucket.WebsiteConfiguration`\n\nSpecifies website configuration parameters for an Amazon S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html", "Properties": { "IndexDocument": { "MarkdownDocumentation": "`IndexDocument`\n\nThe name of the index document for the website.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-indexdocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RedirectAllRequestsTo": { "MarkdownDocumentation": "`RedirectAllRequestsTo`\n\nThe redirect behavior for every request to this bucket's website endpoint.\n###### Important\nIf you specify this property, you can't specify any other property.\n*Required*: No\n*Type*: [RedirectAllRequestsTo](./aws-properties-s3-bucket-redirectallrequeststo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-redirectallrequeststo", "UpdateType": "Mutable", "Required": false, "Type": "RedirectAllRequestsTo" }, "RoutingRules": { "MarkdownDocumentation": "`RoutingRules`\n\nRules that define when a redirect is applied and the redirect behavior.\n*Required*: No\n*Type*: Array of [RoutingRule](./aws-properties-s3-bucket-routingrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-routingrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RoutingRule", "DuplicatesAllowed": true }, "ErrorDocument": { "MarkdownDocumentation": "`ErrorDocument`\n\nThe name of the error document for the website.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-errordocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::MultiRegionAccessPoint.PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`AWS::S3::MultiRegionAccessPoint.PublicAccessBlockConfiguration`\n\nThe PublicAccessBlock configuration that you want to apply to this Amazon S3 Multi-Region\nAccess Point. You can enable the configuration options in any combination. For more\ninformation about when Amazon S3 considers an 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html", "Properties": { "RestrictPublicBuckets": { "MarkdownDocumentation": "`RestrictPublicBuckets`\n\nSpecifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element\nto `TRUE` restricts access to this bucket to only AWS service principals and\nauthorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and\ncross-account access within any public bucket policy, including non-public delegation to specific\naccounts, is blocked.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration-restrictpublicbuckets", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicPolicy": { "MarkdownDocumentation": "`BlockPublicPolicy`\n\nSpecifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to\n`TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy\nallows 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration-blockpublicpolicy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicAcls": { "MarkdownDocumentation": "`BlockPublicAcls`\n\nSpecifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration-blockpublicacls", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "IgnorePublicAcls": { "MarkdownDocumentation": "`IgnorePublicAcls`\n\nSpecifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting\nthis element to `TRUE` causes Amazon S3 to ignore all public ACLs on this bucket and objects in\nthis bucket.\nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new\npublic ACLs from being set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration-ignorepublicacls", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3::MultiRegionAccessPoint.Region": { "MarkdownDocumentation": "`AWS::S3::MultiRegionAccessPoint.Region`\n\nA bucket associated with a specific Region when creating Multi-Region Access\nPoints.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-region.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the associated bucket for the Region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-region.html#cfn-s3-multiregionaccesspoint-region-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BucketAccountId": { "MarkdownDocumentation": "`BucketAccountId`\n\nThe AWS account ID that owns the Amazon S3 bucket that's associated with this Multi-Region Access Point.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-region.html#cfn-s3-multiregionaccesspoint-region-bucketaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3::MultiRegionAccessPointPolicy.PolicyStatus": { "MarkdownDocumentation": "`AWS::S3::MultiRegionAccessPointPolicy.PolicyStatus`\n\nThe container element for a bucket's policy status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspointpolicy-policystatus.html", "Properties": { "IsPublic": { "MarkdownDocumentation": "`IsPublic`\n\nThe policy status for this bucket. `TRUE` indicates that this bucket is public.\n`FALSE` indicates that the bucket is not public.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `true | false...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "true", "false" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspointpolicy-policystatus.html#cfn-s3-multiregionaccesspointpolicy-policystatus-ispublic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::StorageLens.AccountLevel": { "MarkdownDocumentation": "`AWS::S3::StorageLens.AccountLevel`\n\nThis resource contains the details of the account-level metrics for Amazon S3 Storage\nLens.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html", "Properties": { "AdvancedDataProtectionMetrics": { "MarkdownDocumentation": "`AdvancedDataProtectionMetrics`\n\nThis property contains the details of account-level advanced data protection metrics for\nS3 Storage Lens.\n*Required*: No\n*Type*: [AdvancedDataProtectionMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-advanceddataprotectionmetrics", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedDataProtectionMetrics" }, "StorageLensGroupLevel": { "MarkdownDocumentation": "`StorageLensGroupLevel`\n\nThis property determines the scope of Storage Lens group data that is displayed in the\nStorage Lens dashboard.\n*Required*: No\n*Type*: [StorageLensGroupLevel](./aws-properties-s3-storagelens-storagelensgrouplevel.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-storagelensgrouplevel", "UpdateType": "Mutable", "Required": false, "Type": "StorageLensGroupLevel" }, "ActivityMetrics": { "MarkdownDocumentation": "`ActivityMetrics`\n\nThis property contains the details of account-level activity metrics for S3 Storage\nLens.\n*Required*: No\n*Type*: [ActivityMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-activitymetrics", "UpdateType": "Mutable", "Required": false, "Type": "ActivityMetrics" }, "AdvancedPerformanceMetrics": { "MarkdownDocumentation": "`AdvancedPerformanceMetrics`\n\nThis property contains the account-level details for S3 Storage Lens advanced\nperformance metrics.\n*Required*: No\n*Type*: [AdvancedPerformanceMetrics](./aws-properties-s3-storagelens-advancedperformancemetrics.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-advancedperformancemetrics", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedPerformanceMetrics" }, "BucketLevel": { "MarkdownDocumentation": "`BucketLevel`\n\nThis property contains the details of the account-level bucket-level configurations for\nAmazon S3 Storage Lens. To enable bucket-level configurations, make sure to also set the same metrics at the account level.\n*Required*: Yes\n*Type*: [BucketLevel](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-bucketlevel", "UpdateType": "Mutable", "Required": true, "Type": "BucketLevel" }, "AdvancedCostOptimizationMetrics": { "MarkdownDocumentation": "`AdvancedCostOptimizationMetrics`\n\nThis property contains the details of account-level advanced cost optimization metrics for\nS3 Storage Lens.\n*Required*: No\n*Type*: [AdvancedCostOptimizationMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-advancedcostoptimizationmetrics", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedCostOptimizationMetrics" }, "DetailedStatusCodesMetrics": { "MarkdownDocumentation": "`DetailedStatusCodesMetrics`\n\nThis property contains the details of account-level detailed status code metrics for S3\nStorage Lens.\n*Required*: No\n*Type*: [DetailedStatusCodesMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-detailedstatuscodesmetrics", "UpdateType": "Mutable", "Required": false, "Type": "DetailedStatusCodesMetrics" } } }, "AWS::S3::StorageLens.ActivityMetrics": { "MarkdownDocumentation": "`AWS::S3::StorageLens.ActivityMetrics`\n\nThis resource enables Amazon S3 Storage Lens activity metrics. Activity metrics\nshow details about how your storage is requested, such as requests (for example, All requests,\nGet requests, Put requests), bytes uploaded or downloaded, and errors.\nFor more information, see [Assessing your storage activity and usage\nwith S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a\ncomplete list of metrics, see [S3 Storage Lens metrics\nglossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html#cfn-s3-storagelens-activitymetrics-isenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3::StorageLens.AdvancedCostOptimizationMetrics": { "MarkdownDocumentation": "`AWS::S3::StorageLens.AdvancedCostOptimizationMetrics`\n\nThis resource enables Amazon S3 Storage Lens advanced cost optimization metrics.\nAdvanced cost optimization metrics provide insights that you can use to manage and optimize\nyour storage costs, for example, lifecycle rule counts for transitions, expirations, and\nincomplete multipart uploads.\nFor more information, see [Assessing your storage activity and usage\nwith S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a\ncomplete list of metrics, see [S3 Storage Lens metrics\nglossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html#cfn-s3-storagelens-advancedcostoptimizationmetrics-isenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3::StorageLens.AdvancedDataProtectionMetrics": { "MarkdownDocumentation": "`AWS::S3::StorageLens.AdvancedDataProtectionMetrics`\n\nThis resource enables Amazon S3 Storage Lens advanced data protection metrics.\nAdvanced data protection metrics provide insights that you can use to perform audits and\nprotect your data, for example replication rule counts within and across Regions.\nFor more information, see [Assessing your storage activity and usage\nwith S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a\ncomplete list of metrics, see [S3 Storage Lens metrics\nglossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html#cfn-s3-storagelens-advanceddataprotectionmetrics-isenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3::StorageLens.AdvancedPerformanceMetrics": { "MarkdownDocumentation": "`AWS::S3::StorageLens.AdvancedPerformanceMetrics`\n\nA property for S3 Storage Lens advanced performance metrics. Advanced performance metrics provide insights into application performance such as access patterns and network originality metrics.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedperformancemetrics.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nThis property indicates whether the advanced performance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedperformancemetrics.html#cfn-s3-storagelens-advancedperformancemetrics-isenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3::StorageLens.AwsOrg": { "MarkdownDocumentation": "`AWS::S3::StorageLens.AwsOrg`\n\nThis resource contains the details of the AWS Organization for Amazon S3\nStorage Lens.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-awsorg.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-awsorg.html#cfn-s3-storagelens-awsorg-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::StorageLens.BucketLevel": { "MarkdownDocumentation": "`AWS::S3::StorageLens.BucketLevel`\n\nA property for the bucket-level storage metrics for Amazon S3 Storage Lens.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html", "Properties": { "AdvancedDataProtectionMetrics": { "MarkdownDocumentation": "`AdvancedDataProtectionMetrics`\n\nA property for bucket-level advanced data protection metrics for S3 Storage Lens.\n*Required*: No\n*Type*: [AdvancedDataProtectionMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-advanceddataprotectionmetrics", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedDataProtectionMetrics" }, "PrefixLevel": { "MarkdownDocumentation": "`PrefixLevel`\n\nA property for bucket-level prefix-level storage metrics for S3 Storage Lens.\n*Required*: No\n*Type*: [PrefixLevel](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-prefixlevel", "UpdateType": "Mutable", "Required": false, "Type": "PrefixLevel" }, "ActivityMetrics": { "MarkdownDocumentation": "`ActivityMetrics`\n\nA property for bucket-level activity metrics for S3 Storage Lens.\n*Required*: No\n*Type*: [ActivityMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-activitymetrics", "UpdateType": "Mutable", "Required": false, "Type": "ActivityMetrics" }, "AdvancedPerformanceMetrics": { "MarkdownDocumentation": "`AdvancedPerformanceMetrics`\n\nA property for bucket-level advanced performance metrics for S3 Storage Lens.\n*Required*: No\n*Type*: [AdvancedPerformanceMetrics](./aws-properties-s3-storagelens-advancedperformancemetrics.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-advancedperformancemetrics", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedPerformanceMetrics" }, "AdvancedCostOptimizationMetrics": { "MarkdownDocumentation": "`AdvancedCostOptimizationMetrics`\n\nA property for bucket-level advanced cost optimization metrics for S3 Storage Lens.\n*Required*: No\n*Type*: [AdvancedCostOptimizationMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-advancedcostoptimizationmetrics", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedCostOptimizationMetrics" }, "DetailedStatusCodesMetrics": { "MarkdownDocumentation": "`DetailedStatusCodesMetrics`\n\nA property for bucket-level detailed status code metrics for S3 Storage Lens.\n*Required*: No\n*Type*: [DetailedStatusCodesMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-detailedstatuscodesmetrics", "UpdateType": "Mutable", "Required": false, "Type": "DetailedStatusCodesMetrics" } } }, "AWS::S3::StorageLens.BucketsAndRegions": { "MarkdownDocumentation": "`AWS::S3::StorageLens.BucketsAndRegions`\n\nThis resource contains the details of the buckets and Regions for the Amazon S3 Storage\nLens configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html", "Properties": { "Regions": { "MarkdownDocumentation": "`Regions`\n\nThis property contains the details of the Regions for the S3 Storage Lens\nconfiguration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html#cfn-s3-storagelens-bucketsandregions-regions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Buckets": { "MarkdownDocumentation": "`Buckets`\n\nThis property contains the details of the buckets for the Amazon S3 Storage Lens\nconfiguration. This should be the bucket Amazon Resource Name(ARN). For valid values, see\n[Buckets ARN\nformat 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html#cfn-s3-storagelens-bucketsandregions-buckets", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::S3::StorageLens.CloudWatchMetrics": { "MarkdownDocumentation": "`AWS::S3::StorageLens.CloudWatchMetrics`\n\nThis resource enables the Amazon CloudWatch publishing option for Amazon S3\nStorage Lens metrics.\nFor more information, see [Monitor S3\nStorage Lens metrics in CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html) in the *Amazon S3 User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-cloudwatchmetrics.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nThis property identifies whether the CloudWatch publishing option for S3 Storage\nLens 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-cloudwatchmetrics.html#cfn-s3-storagelens-cloudwatchmetrics-isenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::S3::StorageLens.DataExport": { "MarkdownDocumentation": "`AWS::S3::StorageLens.DataExport`\n\nThis resource contains the details of the Amazon S3 Storage Lens metrics export.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html", "Properties": { "StorageLensTableDestination": { "MarkdownDocumentation": "`StorageLensTableDestination`\n\nThis property contains the details of the S3 table bucket where the S3 Storage Lens default metrics report will be placed. This property enables you to store your Storage Lens metrics in read-only S3 Tables.\n*Required*: No\n*Type*: [StorageLensTableDestination](./aws-properties-s3-storagelens-storagelenstabledestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html#cfn-s3-storagelens-dataexport-storagelenstabledestination", "UpdateType": "Mutable", "Required": false, "Type": "StorageLensTableDestination" }, "S3BucketDestination": { "MarkdownDocumentation": "`S3BucketDestination`\n\nThis property contains the details of the bucket where the S3 Storage Lens metrics export\nwill be placed.\n*Required*: No\n*Type*: [S3BucketDestination](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html#cfn-s3-storagelens-dataexport-s3bucketdestination", "UpdateType": "Mutable", "Required": false, "Type": "S3BucketDestination" }, "CloudWatchMetrics": { "MarkdownDocumentation": "`CloudWatchMetrics`\n\nThis property enables the Amazon CloudWatch publishing option for S3 Storage Lens\nmetrics.\n*Required*: No\n*Type*: [CloudWatchMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html#cfn-s3-storagelens-dataexport-cloudwatchmetrics", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchMetrics" } } }, "AWS::S3::StorageLens.DetailedStatusCodesMetrics": { "MarkdownDocumentation": "`AWS::S3::StorageLens.DetailedStatusCodesMetrics`\n\nThis resource enables Amazon S3 Storage Lens detailed status code metrics.\nDetailed status code metrics generate metrics for HTTP status codes, such as `200\nOK`, `403 Forbidden`, `503 Service Unavailable` and others.\nFor more information, see [Assessing your storage activity and usage\nwith S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a\ncomplete list of metrics, see [S3 Storage Lens metrics\nglossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html#cfn-s3-storagelens-detailedstatuscodesmetrics-isenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3::StorageLens.Encryption": { "MarkdownDocumentation": "`AWS::S3::StorageLens.Encryption`\n\nThis resource contains the type of server-side encryption used to encrypt an Amazon S3\nStorage Lens metrics export. For valid values, see the [StorageLensDataExportEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_StorageLensDataExportEncryption.html) in the *Amazon S3 API\nReference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-encryption.html", "Properties": { "SSEKMS": { "MarkdownDocumentation": "`SSEKMS`\n\nSpecifies the use of AWS Key Management Service keys (SSE-KMS) to encrypt the S3 Storage Lens\nmetrics export file.\n*Required*: No\n*Type*: [SSEKMS](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-encryption.html#cfn-s3-storagelens-encryption-ssekms", "UpdateType": "Mutable", "Required": false, "Type": "SSEKMS" }, "SSES3": { "MarkdownDocumentation": "`SSES3`\n\nSpecifies the use of an Amazon S3-managed key (SSE-S3) to encrypt the S3 Storage Lens\nmetrics 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-encryption.html#cfn-s3-storagelens-encryption-sses3", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::S3::StorageLens.PrefixLevel": { "MarkdownDocumentation": "`AWS::S3::StorageLens.PrefixLevel`\n\nThis resource contains the details of the prefix-level of the Amazon S3 Storage\nLens.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html", "Properties": { "StorageMetrics": { "MarkdownDocumentation": "`StorageMetrics`\n\nA property for the prefix-level storage metrics for Amazon S3 Storage Lens.\n*Required*: Yes\n*Type*: [PrefixLevelStorageMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html#cfn-s3-storagelens-prefixlevel-storagemetrics", "UpdateType": "Mutable", "Required": true, "Type": "PrefixLevelStorageMetrics" } } }, "AWS::S3::StorageLens.PrefixLevelStorageMetrics": { "MarkdownDocumentation": "`AWS::S3::StorageLens.PrefixLevelStorageMetrics`\n\nThis resource contains the details of the prefix-level storage metrics for Amazon S3\nStorage Lens.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nThis property identifies whether the details of the prefix-level storage metrics for S3\nStorage Lens 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html#cfn-s3-storagelens-prefixlevelstoragemetrics-isenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SelectionCriteria": { "MarkdownDocumentation": "`SelectionCriteria`\n\nThis property identifies whether the details of the prefix-level storage metrics for S3\nStorage Lens are enabled.\n*Required*: No\n*Type*: [SelectionCriteria](./aws-properties-s3-storagelens-selectioncriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html#cfn-s3-storagelens-prefixlevelstoragemetrics-selectioncriteria", "UpdateType": "Mutable", "Required": false, "Type": "SelectionCriteria" } } }, "AWS::S3::StorageLens.S3BucketDestination": { "MarkdownDocumentation": "`AWS::S3::StorageLens.S3BucketDestination`\n\nThis resource contains the details of the bucket where the Amazon S3 Storage Lens metrics\nexport will be placed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html", "Properties": { "OutputSchemaVersion": { "MarkdownDocumentation": "`OutputSchemaVersion`\n\nThis property contains the details of the output schema version of the S3 Storage Lens\nexport bucket destination.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `V_1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "V_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-outputschemaversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Format": { "MarkdownDocumentation": "`Format`\n\nThis property contains the details of the format of the S3 Storage Lens export bucket\ndestination.\n*Required*: Yes\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)", "RefReturnValue": "", "AllowedValues": [ "CSV", "Parquet" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-format", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThis property contains the details of the AWS account ID of the S3\nStorage 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-accountid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThis property contains the details of the prefix of the bucket destination of the S3\nStorage 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nThis property contains the details of the encryption of the bucket destination of the\nAmazon S3 Storage Lens metrics export.\n*Required*: No\n*Type*: [Encryption](./aws-properties-s3-storagelens-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-encryption", "UpdateType": "Mutable", "Required": false, "Type": "Encryption" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThis property contains the details of the ARN of the bucket destination of the S3 Storage\nLens export.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::StorageLens.SSEKMS": { "MarkdownDocumentation": "`AWS::S3::StorageLens.SSEKMS`\n\nSpecifies the use of server-side encryption using an AWS Key Management Service key (SSE-KMS)\nto encrypt the delivered S3 Storage Lens metrics export file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.html", "Properties": { "KeyId": { "MarkdownDocumentation": "`KeyId`\n\nSpecifies the Amazon Resource Name (ARN) of the customer managed AWS KMS key to\nuse for encrypting the S3 Storage Lens metrics export file. Amazon S3 only supports symmetric\nencryption keys. For more information, see [Special-purpose keys](https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.html#cfn-s3-storagelens-ssekms-keyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3::StorageLens.SelectionCriteria": { "MarkdownDocumentation": "`AWS::S3::StorageLens.SelectionCriteria`\n\nThis resource contains the details of the Amazon S3 Storage Lens selection\ncriteria.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html", "Properties": { "Delimiter": { "MarkdownDocumentation": "`Delimiter`\n\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-delimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxDepth": { "MarkdownDocumentation": "`MaxDepth`\n\nThis property contains the details of the max depth that S3 Storage Lens will collect\nmetrics 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-maxdepth", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinStorageBytesPercentage": { "MarkdownDocumentation": "`MinStorageBytesPercentage`\n\nThis property contains the details of the minimum storage bytes percentage threshold that\nS3 Storage Lens will collect metrics up to.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-minstoragebytespercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::S3::StorageLens.StorageLensConfiguration": { "MarkdownDocumentation": "`AWS::S3::StorageLens.StorageLensConfiguration`\n\nThis is the property of the Amazon S3 Storage Lens configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html", "Properties": { "AccountLevel": { "MarkdownDocumentation": "`AccountLevel`\n\nThis property contains the details of the account-level metrics for Amazon S3 Storage Lens\nconfiguration.\n*Required*: Yes\n*Type*: [AccountLevel](./aws-properties-s3-storagelens-accountlevel.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-accountlevel", "UpdateType": "Mutable", "Required": true, "Type": "AccountLevel" }, "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nThis property contains the details of the bucket and or Regions excluded for Amazon S3\nStorage Lens configuration.\n*Required*: No\n*Type*: [BucketsAndRegions](./aws-properties-s3-storagelens-bucketsandregions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-exclude", "UpdateType": "Mutable", "Required": false, "Type": "BucketsAndRegions" }, "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nThis property contains the details of whether the Amazon S3 Storage Lens configuration is\nenabled.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-isenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Include": { "MarkdownDocumentation": "`Include`\n\nThis property contains the details of the bucket and or Regions included for Amazon S3\nStorage Lens configuration.\n*Required*: No\n*Type*: [BucketsAndRegions](./aws-properties-s3-storagelens-bucketsandregions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-include", "UpdateType": "Mutable", "Required": false, "Type": "BucketsAndRegions" }, "PrefixDelimiter": { "MarkdownDocumentation": "`PrefixDelimiter`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-prefixdelimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AwsOrg": { "MarkdownDocumentation": "`AwsOrg`\n\nThis property contains the details of the AWS Organization for the S3\nStorage Lens configuration.\n*Required*: No\n*Type*: [AwsOrg](./aws-properties-s3-storagelens-awsorg.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-awsorg", "UpdateType": "Mutable", "Required": false, "Type": "AwsOrg" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThis property contains the details of the ID of the S3 Storage Lens configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\-_.]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-id", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StorageLensArn": { "MarkdownDocumentation": "`StorageLensArn`\n\nThis property contains the details of the ARN of the S3 Storage Lens configuration. This\nproperty is read-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-storagelensarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataExport": { "MarkdownDocumentation": "`DataExport`\n\nThis property contains the details of this S3 Storage Lens configuration's metrics\nexport.\n*Required*: No\n*Type*: [DataExport](./aws-properties-s3-storagelens-dataexport.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-dataexport", "UpdateType": "Mutable", "Required": false, "Type": "DataExport" }, "ExpandedPrefixesDataExport": { "MarkdownDocumentation": "`ExpandedPrefixesDataExport`\n\nThis property configures your S3 Storage Lens expanded prefixes metrics\nreport.\n*Required*: No\n*Type*: [StorageLensExpandedPrefixesDataExport](./aws-properties-s3-storagelens-storagelensexpandedprefixesdataexport.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-expandedprefixesdataexport", "UpdateType": "Mutable", "Required": false, "Type": "StorageLensExpandedPrefixesDataExport" } } }, "AWS::S3::StorageLens.StorageLensExpandedPrefixesDataExport": { "MarkdownDocumentation": "`AWS::S3::StorageLens.StorageLensExpandedPrefixesDataExport`\n\nThis resource specifies the properties of your S3 Storage Lens Expanded Prefixes metrics export.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensexpandedprefixesdataexport.html", "Properties": { "StorageLensTableDestination": { "MarkdownDocumentation": "`StorageLensTableDestination`\n\nThis property configures S3 Storage Lens Expanded Prefixes metrics report to read-only S3 table buckets.\n*Required*: No\n*Type*: [StorageLensTableDestination](./aws-properties-s3-storagelens-storagelenstabledestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensexpandedprefixesdataexport.html#cfn-s3-storagelens-storagelensexpandedprefixesdataexport-storagelenstabledestination", "UpdateType": "Mutable", "Required": false, "Type": "StorageLensTableDestination" }, "S3BucketDestination": { "MarkdownDocumentation": "`S3BucketDestination`\n\nThis property specifies the general purpose bucket where the S3 Storage Lens Expanded Prefixes metrics export files are located. At least one export destination must be specified.\n*Required*: No\n*Type*: [S3BucketDestination](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensexpandedprefixesdataexport.html#cfn-s3-storagelens-storagelensexpandedprefixesdataexport-s3bucketdestination", "UpdateType": "Mutable", "Required": false, "Type": "S3BucketDestination" } } }, "AWS::S3::StorageLens.StorageLensGroupLevel": { "MarkdownDocumentation": "`AWS::S3::StorageLens.StorageLensGroupLevel`\n\nThis resource determines the scope of Storage Lens group data that is displayed in the\nStorage Lens dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgrouplevel.html", "Properties": { "StorageLensGroupSelectionCriteria": { "MarkdownDocumentation": "`StorageLensGroupSelectionCriteria`\n\nThis property indicates which Storage Lens group ARNs to include or exclude in the Storage\nLens group aggregation. If this value is left null, then all Storage Lens groups are\nselected.\n*Required*: No\n*Type*: [StorageLensGroupSelectionCriteria](./aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgrouplevel.html#cfn-s3-storagelens-storagelensgrouplevel-storagelensgroupselectioncriteria", "UpdateType": "Mutable", "Required": false, "Type": "StorageLensGroupSelectionCriteria" } } }, "AWS::S3::StorageLens.StorageLensGroupSelectionCriteria": { "MarkdownDocumentation": "`AWS::S3::StorageLens.StorageLensGroupSelectionCriteria`\n\nThis resource indicates which Storage Lens group ARNs to include or exclude in the Storage\nLens group aggregation. You can only attach Storage Lens groups to your dashboard if they're\nincluded in your Storage Lens group aggregation. If this value is left null, then all Storage\nLens groups are selected.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html", "Properties": { "Exclude": { "MarkdownDocumentation": "`Exclude`\n\nThis property indicates which Storage Lens group ARNs to exclude from the Storage Lens\ngroup aggregation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html#cfn-s3-storagelens-storagelensgroupselectioncriteria-exclude", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Include": { "MarkdownDocumentation": "`Include`\n\nThis property indicates which Storage Lens group ARNs to include in the Storage Lens group\naggregation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html#cfn-s3-storagelens-storagelensgroupselectioncriteria-include", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::S3::StorageLens.StorageLensTableDestination": { "MarkdownDocumentation": "`AWS::S3::StorageLens.StorageLensTableDestination`\n\nThis resource configures your S3 Storage Lens reports to export to read-only S3 table\nbuckets. With this resource, you can store your Storage Lens metrics in S3 Tables that are created in a read-only S3 table bucket called aws-s3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelenstabledestination.html", "Properties": { "IsEnabled": { "MarkdownDocumentation": "`IsEnabled`\n\nThis property indicates whether the export to read-only S3 table buckets is enabled\nfor your S3 Storage Lens configuration. When set to true, Storage Lens reports are\nautomatically exported to tables in addition to other configured destinations.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelenstabledestination.html#cfn-s3-storagelens-storagelenstabledestination-isenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nThis resource configures your data encryption settings for Storage Lens metrics in\nread-only S3 table buckets.\n*Required*: No\n*Type*: [Encryption](./aws-properties-s3-storagelens-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelenstabledestination.html#cfn-s3-storagelens-storagelenstabledestination-encryption", "UpdateType": "Mutable", "Required": false, "Type": "Encryption" } } }, "AWS::S3::StorageLensGroup.And": { "MarkdownDocumentation": "`AWS::S3::StorageLensGroup.And`\n\nThis resource is a logical operator that allows multiple filter conditions to be joined\nfor more complex comparisons of Storage Lens group data. Objects must match all of the listed\nfilter conditions that are joined by the `And` logical operator. Only one of each\nfilter condition is allowed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-and.html", "Properties": { "MatchObjectAge": { "MarkdownDocumentation": "`MatchObjectAge`\n\nThis property contains `DaysGreaterThan` and `DaysLessThan`\nproperties to define the object age range (minimum and maximum number of days).\n*Required*: No\n*Type*: [MatchObjectAge](./aws-properties-s3-storagelensgroup-matchobjectage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-and.html#cfn-s3-storagelensgroup-and-matchobjectage", "UpdateType": "Mutable", "Required": false, "Type": "MatchObjectAge" }, "MatchAnyPrefix": { "MarkdownDocumentation": "`MatchAnyPrefix`\n\nThis property contains a list of prefixes. At least one prefix must be specified. Up to 10\nprefixes are allowed.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-and.html#cfn-s3-storagelensgroup-and-matchanyprefix", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MatchAnyTag": { "MarkdownDocumentation": "`MatchAnyTag`\n\nThis property contains the list of object tags. At least one object tag must be specified.\nUp to 10 object tags are allowed.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-storagelensgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-and.html#cfn-s3-storagelensgroup-and-matchanytag", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "MatchAnySuffix": { "MarkdownDocumentation": "`MatchAnySuffix`\n\nThis property contains a list of suffixes. At least one suffix must be specified. Up to 10\nsuffixes are allowed.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-and.html#cfn-s3-storagelensgroup-and-matchanysuffix", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MatchObjectSize": { "MarkdownDocumentation": "`MatchObjectSize`\n\nThis property contains `BytesGreaterThan` and `BytesLessThan` to\ndefine the object size range (minimum and maximum number of Bytes).\n*Required*: No\n*Type*: [MatchObjectSize](./aws-properties-s3-storagelensgroup-matchobjectsize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-and.html#cfn-s3-storagelensgroup-and-matchobjectsize", "UpdateType": "Mutable", "Required": false, "Type": "MatchObjectSize" } } }, "AWS::S3::StorageLensGroup.Filter": { "MarkdownDocumentation": "`AWS::S3::StorageLensGroup.Filter`\n\nThis resource sets the criteria for the Storage Lens group data that is displayed. For\nmultiple filter conditions, the `AND` or `OR` logical operator is\nused.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html", "Properties": { "MatchObjectAge": { "MarkdownDocumentation": "`MatchObjectAge`\n\nThis property contains `DaysGreaterThan` and `DaysLessThan` to\ndefine the object age range (minimum and maximum number of days).\n*Required*: No\n*Type*: [MatchObjectAge](./aws-properties-s3-storagelensgroup-matchobjectage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchobjectage", "UpdateType": "Mutable", "Required": false, "Type": "MatchObjectAge" }, "Or": { "MarkdownDocumentation": "`Or`\n\nThis property contains the `Or` logical operator, which allows multiple filter\nconditions to be joined. Objects can match any of the listed filter conditions, which are\njoined by the `Or` logical operator. Only one of each filter condition is\nallowed.\n*Required*: No\n*Type*: [Or](./aws-properties-s3-storagelensgroup-or.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-or", "UpdateType": "Mutable", "Required": false, "Type": "Or" }, "And": { "MarkdownDocumentation": "`And`\n\nThis property contains the `And` logical operator, which allows multiple filter\nconditions to be joined for more complex comparisons of Storage Lens group data. Objects must\nmatch all of the listed filter conditions that are joined by the `And` logical\noperator. Only one of each filter condition is allowed.\n*Required*: No\n*Type*: [And](./aws-properties-s3-storagelensgroup-and.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-and", "UpdateType": "Mutable", "Required": false, "Type": "And" }, "MatchAnyPrefix": { "MarkdownDocumentation": "`MatchAnyPrefix`\n\nThis property contains a list of prefixes. At least one prefix must be specified. Up to 10\nprefixes are allowed.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchanyprefix", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MatchAnyTag": { "MarkdownDocumentation": "`MatchAnyTag`\n\nThis property contains the list of S3 object tags. At least one object tag must be\nspecified. Up to 10 object tags are allowed.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-storagelensgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchanytag", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "MatchAnySuffix": { "MarkdownDocumentation": "`MatchAnySuffix`\n\nThis property contains a list of suffixes. At least one suffix must be specified. Up to 10\nsuffixes are allowed.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchanysuffix", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MatchObjectSize": { "MarkdownDocumentation": "`MatchObjectSize`\n\nThis property contains `BytesGreaterThan` and `BytesLessThan` to\ndefine the object size range (minimum and maximum number of Bytes).\n*Required*: No\n*Type*: [MatchObjectSize](./aws-properties-s3-storagelensgroup-matchobjectsize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchobjectsize", "UpdateType": "Mutable", "Required": false, "Type": "MatchObjectSize" } } }, "AWS::S3::StorageLensGroup.MatchObjectAge": { "MarkdownDocumentation": "`AWS::S3::StorageLensGroup.MatchObjectAge`\n\nThis resource contains `DaysGreaterThan` and `DaysLessThan` to\ndefine the object age range (minimum and maximum number of days).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-matchobjectage.html", "Properties": { "DaysLessThan": { "MarkdownDocumentation": "`DaysLessThan`\n\nThis property indicates the maximum object age in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-matchobjectage.html#cfn-s3-storagelensgroup-matchobjectage-dayslessthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DaysGreaterThan": { "MarkdownDocumentation": "`DaysGreaterThan`\n\nThis property indicates the minimum object age in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-matchobjectage.html#cfn-s3-storagelensgroup-matchobjectage-daysgreaterthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::S3::StorageLensGroup.MatchObjectSize": { "MarkdownDocumentation": "`AWS::S3::StorageLensGroup.MatchObjectSize`\n\nThis resource filters objects that match the specified object size range.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-matchobjectsize.html", "Properties": { "BytesLessThan": { "MarkdownDocumentation": "`BytesLessThan`\n\nThis property specifies the maximum object size in bytes. The value must be a positive\nnumber, greater than the minimum object size and less than 5 TB.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-matchobjectsize.html#cfn-s3-storagelensgroup-matchobjectsize-byteslessthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "BytesGreaterThan": { "MarkdownDocumentation": "`BytesGreaterThan`\n\nThis property specifies the minimum object size in bytes. The value must be a positive\nnumber, greater than 0 and less than 5 TB.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-matchobjectsize.html#cfn-s3-storagelensgroup-matchobjectsize-bytesgreaterthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" } } }, "AWS::S3::StorageLensGroup.Or": { "MarkdownDocumentation": "`AWS::S3::StorageLensGroup.Or`\n\nThis resource contains the `Or` logical operator, which allows multiple filter\nconditions to be joined for more complex comparisons of Storage Lens group data. Objects can\nmatch any of the listed filter conditions that are joined by the `Or` logical\noperator. Only one of each filter condition is allowed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-or.html", "Properties": { "MatchObjectAge": { "MarkdownDocumentation": "`MatchObjectAge`\n\nThis property filters objects that match the specified object age range.\n*Required*: No\n*Type*: [MatchObjectAge](./aws-properties-s3-storagelensgroup-matchobjectage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-or.html#cfn-s3-storagelensgroup-or-matchobjectage", "UpdateType": "Mutable", "Required": false, "Type": "MatchObjectAge" }, "MatchAnyPrefix": { "MarkdownDocumentation": "`MatchAnyPrefix`\n\nThis property contains a list of prefixes. At least one prefix must be specified. Up to 10\nprefixes are allowed.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-or.html#cfn-s3-storagelensgroup-or-matchanyprefix", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MatchAnyTag": { "MarkdownDocumentation": "`MatchAnyTag`\n\nThis property contains the list of S3 object tags. At least one object tag must be\nspecified. Up to 10 object tags are allowed.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-storagelensgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-or.html#cfn-s3-storagelensgroup-or-matchanytag", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "MatchAnySuffix": { "MarkdownDocumentation": "`MatchAnySuffix`\n\nThis property contains the list of suffixes. At least one suffix must be specified. Up to\n10 suffixes are allowed.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-or.html#cfn-s3-storagelensgroup-or-matchanysuffix", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MatchObjectSize": { "MarkdownDocumentation": "`MatchObjectSize`\n\nThis property contains the `BytesGreaterThan` and `BytesLessThan`\nvalues to define the object size range (minimum and maximum number of Bytes).\n*Required*: No\n*Type*: [MatchObjectSize](./aws-properties-s3-storagelensgroup-matchobjectsize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-or.html#cfn-s3-storagelensgroup-or-matchobjectsize", "UpdateType": "Mutable", "Required": false, "Type": "MatchObjectSize" } } }, "AWS::S3Express::AccessPoint.PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`AWS::S3Express::AccessPoint.PublicAccessBlockConfiguration`\n\nPublic access is blocked by default to access points for directory buckets.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-publicaccessblockconfiguration.html", "Properties": { "RestrictPublicBuckets": { "MarkdownDocumentation": "`RestrictPublicBuckets`\n\nSpecifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element\nto `TRUE` restricts access to this bucket to only AWS service principals and\nauthorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and\ncross-account access within any public bucket policy, including non-public delegation to specific\naccounts, is blocked.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-publicaccessblockconfiguration.html#cfn-s3express-accesspoint-publicaccessblockconfiguration-restrictpublicbuckets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicPolicy": { "MarkdownDocumentation": "`BlockPublicPolicy`\n\nSpecifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to\n`TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy\nallows public access.\nEnabling this setting doesn't affect existing bucket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-publicaccessblockconfiguration.html#cfn-s3express-accesspoint-publicaccessblockconfiguration-blockpublicpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicAcls": { "MarkdownDocumentation": "`BlockPublicAcls`\n\nSpecifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects\nin 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-publicaccessblockconfiguration.html#cfn-s3express-accesspoint-publicaccessblockconfiguration-blockpublicacls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IgnorePublicAcls": { "MarkdownDocumentation": "`IgnorePublicAcls`\n\nSpecifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting\nthis element to `TRUE` causes Amazon S3 to ignore all public ACLs on this bucket and objects in\nthis bucket.\nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new\npublic ACLs from being 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-publicaccessblockconfiguration.html#cfn-s3express-accesspoint-publicaccessblockconfiguration-ignorepublicacls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3Express::AccessPoint.Scope": { "MarkdownDocumentation": "`AWS::S3Express::AccessPoint.Scope`\n\nYou can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.\nFor more information, see [Manage the scope of your access points for directory buckets.](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets-manage-scope.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-scope.html", "Properties": { "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nYou can include one or more API operations as permissions.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `GetObject | GetObjectAttrib...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GetObject", "GetObjectAttributes", "ListMultipartUploadParts", "ListBucket", "ListBucketMultipartUploads", "PutObject", "DeleteObject", "AbortMultipartUpload" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-scope.html#cfn-s3express-accesspoint-scope-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Prefixes": { "MarkdownDocumentation": "`Prefixes`\n\nYou can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-scope.html#cfn-s3express-accesspoint-scope-prefixes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::S3Express::AccessPoint.VpcConfiguration": { "MarkdownDocumentation": "`AWS::S3Express::AccessPoint.VpcConfiguration`\n\nThe `VpcConfiguration` property type specifies Property description not available. for an [AWS::S3Express::AccessPoint](./aws-resource-s3express-accesspoint.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-vpcconfiguration.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nIf this field is specified, this access point will only allow connections from the specified VPC ID.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-accesspoint-vpcconfiguration.html#cfn-s3express-accesspoint-vpcconfiguration-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Express::DirectoryBucket.AbortIncompleteMultipartUpload": { "MarkdownDocumentation": "`AWS::S3Express::DirectoryBucket.AbortIncompleteMultipartUpload`\n\nSpecifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before\npermanently removing all parts of the upload. For more information, see [Aborting\nIncomplete Multipart Uploads Using a Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the\n*Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-abortincompletemultipartupload.html", "Properties": { "DaysAfterInitiation": { "MarkdownDocumentation": "`DaysAfterInitiation`\n\nSpecifies the number of days after which Amazon S3 aborts an incomplete multipart upload.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-abortincompletemultipartupload.html#cfn-s3express-directorybucket-abortincompletemultipartupload-daysafterinitiation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::S3Express::DirectoryBucket.BucketEncryption": { "MarkdownDocumentation": "`AWS::S3Express::DirectoryBucket.BucketEncryption`\n\nSpecifies default encryption for a bucket using server-side encryption with Amazon S3\nmanaged keys (SSE-S3) or AWS KMS keys (SSE-KMS). For information about\ndefault encryption for directory buckets, see [Setting and monitoring\ndefault encryption for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html) in the *Amazon S3 User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-bucketencryption.html", "Properties": { "ServerSideEncryptionConfiguration": { "MarkdownDocumentation": "`ServerSideEncryptionConfiguration`\n\nSpecifies the default server-side-encryption configuration.\n*Required*: Yes\n*Type*: Array of [ServerSideEncryptionRule](./aws-properties-s3express-directorybucket-serversideencryptionrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-bucketencryption.html#cfn-s3express-directorybucket-bucketencryption-serversideencryptionconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ServerSideEncryptionRule", "DuplicatesAllowed": false } } }, "AWS::S3Express::DirectoryBucket.LifecycleConfiguration": { "MarkdownDocumentation": "`AWS::S3Express::DirectoryBucket.LifecycleConfiguration`\n\nContainer for lifecycle rules. You can add as many as 1000 rules.\nFor more information see, [Creating and managing a lifecycle configuration for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-lifecycle.html ) in the\n*Amazon S3 User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-lifecycleconfiguration.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nA lifecycle rule for individual objects in an Amazon S3 Express bucket.\n*Required*: Yes\n*Type*: Array of [Rule](./aws-properties-s3express-directorybucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-lifecycleconfiguration.html#cfn-s3express-directorybucket-lifecycleconfiguration-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": false } } }, "AWS::S3Express::DirectoryBucket.Rule": { "MarkdownDocumentation": "`AWS::S3Express::DirectoryBucket.Rule`\n\nSpecifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket\nLifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference*. For\nexamples, see [Put Bucket Lifecycle Configuration Examples](https://docs.aws.amazon.com//AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html#API_PutBucketLifecycleConfiguration_Examples).\nYou must specify at least one of the following properties:\n`AbortIncompleteMultipartUpload`, or `ExpirationInDays`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-rule.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nIf `Enabled`, the rule is currently being applied. If `Disabled`, the rule is\nnot currently being applied.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Enabled | Disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-rule.html#cfn-s3express-directorybucket-rule-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExpirationInDays": { "MarkdownDocumentation": "`ExpirationInDays`\n\nIndicates the number of days after creation when objects are deleted from Amazon S3 and\nAmazon S3 Glacier. If you specify an expiration and transition time, you must use the same\ntime unit for both properties (either in days or by date). The expiration time must also be\nlater than the transition 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-rule.html#cfn-s3express-directorybucket-rule-expirationindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ObjectSizeGreaterThan": { "MarkdownDocumentation": "`ObjectSizeGreaterThan`\n\nSpecifies the minimum object size in bytes for this rule to apply to. Objects must be\nlarger 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\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-rule.html#cfn-s3express-directorybucket-rule-objectsizegreaterthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nUnique identifier for the rule. The value can't be longer than 255 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-rule.html#cfn-s3express-directorybucket-rule-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nObject key prefix that identifies one or more objects to which this rule applies.\n###### Important\nReplacement must be made for object keys containing special characters (such as carriage returns) when using\nXML 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-rule.html#cfn-s3express-directorybucket-rule-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AbortIncompleteMultipartUpload": { "MarkdownDocumentation": "`AbortIncompleteMultipartUpload`\n\nSpecifies the days since the initiation of an incomplete multipart upload that Amazon S3\nwill wait before permanently removing all parts of the upload.\n*Required*: No\n*Type*: [AbortIncompleteMultipartUpload](./aws-properties-s3express-directorybucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-rule.html#cfn-s3express-directorybucket-rule-abortincompletemultipartupload", "UpdateType": "Mutable", "Required": false, "Type": "AbortIncompleteMultipartUpload" }, "ObjectSizeLessThan": { "MarkdownDocumentation": "`ObjectSizeLessThan`\n\nSpecifies the maximum object size in bytes for this rule to apply to. Objects must be\nsmaller 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\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-rule.html#cfn-s3express-directorybucket-rule-objectsizelessthan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Express::DirectoryBucket.ServerSideEncryptionByDefault": { "MarkdownDocumentation": "`AWS::S3Express::DirectoryBucket.ServerSideEncryptionByDefault`\n\nDescribes the default server-side encryption to apply to new objects in the bucket. If a\nPUT Object request doesn't specify any server-side encryption, this default encryption will\nbe applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in\nthe *Amazon S3 API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-serversideencryptionbydefault.html", "Properties": { "SSEAlgorithm": { "MarkdownDocumentation": "`SSEAlgorithm`\n\nServer-side encryption algorithm to use for the default encryption.\n###### Note\nFor directory buckets, there are only two supported values for server-side encryption: `AES256` and `aws:kms`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `aws:kms | AES256...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "aws:kms", "AES256" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-serversideencryptionbydefault.html#cfn-s3express-directorybucket-serversideencryptionbydefault-ssealgorithm", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KMSMasterKeyID": { "MarkdownDocumentation": "`KMSMasterKeyID`\n\nAWS Key Management Service (KMS) customer managed key ID to use for the\ndefault encryption. This parameter is allowed only if `SSEAlgorithm` is set to\n`aws:kms`.\nYou can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the\nKMS key. You can\u2019t use the key alias of the KMS key.\n* Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n* Key ARN:\n `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\nIf you are using encryption with cross-account or AWS service operations,\nyou must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html#s3-express-bucket-encryption-update-bucket-policy).\n###### Note\nYour SSE-KMS configuration can only support 1 [customer managed\nkey](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) per directory bucket for the lifetime of the bucket. [AWS managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) (`aws/s3`) isn't supported. Also,\nafter you specify a customer managed key for SSE-KMS and upload objects with this\nconfiguration, you can't override the customer managed key for your SSE-KMS\nconfiguration. To use a new customer manager key for your data, we recommend copying\nyour existing objects to a new directory bucket with a new customer managed key.\n\n###### Important\nAmazon S3 only supports symmetric encryption KMS keys. For more information, see\n[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*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-serversideencryptionbydefault.html#cfn-s3express-directorybucket-serversideencryptionbydefault-kmsmasterkeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Express::DirectoryBucket.ServerSideEncryptionRule": { "MarkdownDocumentation": "`AWS::S3Express::DirectoryBucket.ServerSideEncryptionRule`\n\nSpecifies the default server-side encryption configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-serversideencryptionrule.html", "Properties": { "BucketKeyEnabled": { "MarkdownDocumentation": "`BucketKeyEnabled`\n\nSpecifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption\nusing KMS (SSE-KMS) for new objects in the bucket. S3 Bucket Keys are always enabled for\n`GET` and `PUT` operations on a directory bucket and can\u2019t be\ndisabled. It's only allowed to set the `BucketKeyEnabled` element to\n`true`.\nS3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general\npurpose buckets to directory buckets, from directory buckets to general purpose buckets, or\nbetween directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html), [the Copy operation\nin Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job). In this case,\nAmazon S3 makes a call to AWS KMS every time a copy request is made for a\nKMS-encrypted object.\nFor more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-UsingKMSEncryption.html#s3-express-sse-kms-bucket-keys) in the *Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-serversideencryptionrule.html#cfn-s3express-directorybucket-serversideencryptionrule-bucketkeyenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ServerSideEncryptionByDefault": { "MarkdownDocumentation": "`ServerSideEncryptionByDefault`\n\nSpecifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object\nrequest doesn't specify any server-side encryption, this default encryption will be applied.\n*Required*: No\n*Type*: [ServerSideEncryptionByDefault](./aws-properties-s3express-directorybucket-serversideencryptionbydefault.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-serversideencryptionrule.html#cfn-s3express-directorybucket-serversideencryptionrule-serversideencryptionbydefault", "UpdateType": "Mutable", "Required": false, "Type": "ServerSideEncryptionByDefault" } } }, "AWS::S3ObjectLambda::AccessPoint.Alias": { "MarkdownDocumentation": "`AWS::S3ObjectLambda::AccessPoint.Alias`\n\nThe alias of an Object Lambda Access Point. For more information, see [How to use a\nbucket-style alias for your S3 bucket Object Lambda Access Point](https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-use.html#ol-access-points-alias).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-alias.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the Object Lambda Access Point alias. If the status is `PROVISIONING`, the Object Lambda Access Point\nis provisioning the alias and the alias is not ready for use yet. If the status is\n`READY`, the Object Lambda Access Point alias is successfully provisioned and ready for\nuse.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-alias.html#cfn-s3objectlambda-accesspoint-alias-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe alias value of the Object Lambda Access Point.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-alias.html#cfn-s3objectlambda-accesspoint-alias-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3ObjectLambda::AccessPoint.AwsLambda": { "MarkdownDocumentation": "`AWS::S3ObjectLambda::AccessPoint.AwsLambda`\n\nThe `AwsLambda` property type specifies Property description not available. for an [AWS::S3ObjectLambda::AccessPoint](./aws-resource-s3objectlambda-accesspoint.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-awslambda.html", "Properties": { "FunctionArn": { "MarkdownDocumentation": "`FunctionArn`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-awslambda.html#cfn-s3objectlambda-accesspoint-awslambda-functionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FunctionPayload": { "MarkdownDocumentation": "`FunctionPayload`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-awslambda.html#cfn-s3objectlambda-accesspoint-awslambda-functionpayload", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3ObjectLambda::AccessPoint.ContentTransformation": { "MarkdownDocumentation": "`AWS::S3ObjectLambda::AccessPoint.ContentTransformation`\n\nThe `ContentTransformation` property type specifies Property description not available. for an [AWS::S3ObjectLambda::AccessPoint](./aws-resource-s3objectlambda-accesspoint.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-contenttransformation.html", "Properties": { "AwsLambda": { "MarkdownDocumentation": "`AwsLambda`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [AwsLambda](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-contenttransformation.html#cfn-s3objectlambda-accesspoint-contenttransformation-awslambda", "UpdateType": "Mutable", "Required": true, "Type": "AwsLambda" } } }, "AWS::S3ObjectLambda::AccessPoint.ObjectLambdaConfiguration": { "MarkdownDocumentation": "`AWS::S3ObjectLambda::AccessPoint.ObjectLambdaConfiguration`\n\nA configuration used when creating an Object Lambda Access Point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-objectlambdaconfiguration.html", "Properties": { "SupportingAccessPoint": { "MarkdownDocumentation": "`SupportingAccessPoint`\n\nStandard access point associated with the Object Lambda Access Point.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-objectlambdaconfiguration.html#cfn-s3objectlambda-accesspoint-objectlambdaconfiguration-supportingaccesspoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TransformationConfigurations": { "MarkdownDocumentation": "`TransformationConfigurations`\n\nA container for transformation configurations for an Object Lambda Access Point.\n*Required*: Yes\n*Type*: Array of [TransformationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-objectlambdaconfiguration.html#cfn-s3objectlambda-accesspoint-objectlambdaconfiguration-transformationconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TransformationConfiguration", "DuplicatesAllowed": false }, "AllowedFeatures": { "MarkdownDocumentation": "`AllowedFeatures`\n\nA container for allowed features. Valid inputs are `GetObject-Range`,\n`GetObject-PartNumber`, `HeadObject-Range`, and\n`HeadObject-PartNumber`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-objectlambdaconfiguration.html#cfn-s3objectlambda-accesspoint-objectlambdaconfiguration-allowedfeatures", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "CloudWatchMetricsEnabled": { "MarkdownDocumentation": "`CloudWatchMetricsEnabled`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-objectlambdaconfiguration.html#cfn-s3objectlambda-accesspoint-objectlambdaconfiguration-cloudwatchmetricsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3ObjectLambda::AccessPoint.PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`AWS::S3ObjectLambda::AccessPoint.PublicAccessBlockConfiguration`\n\nThe `PublicAccessBlock` configuration that you want to apply to this Amazon S3\naccount. You can enable the configuration options in any combination. For more information\nabout 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*.\nThis data type is not supported for Amazon S3 on Outposts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-publicaccessblockconfiguration.html", "Properties": { "RestrictPublicBuckets": { "MarkdownDocumentation": "`RestrictPublicBuckets`\n\nSpecifies whether Amazon S3 should restrict public bucket policies for buckets in this\naccount. Setting this element to `TRUE` restricts access to buckets with public\npolicies to only AWS service principals and authorized users within this\naccount.\nEnabling this setting doesn't affect previously stored bucket policies, except that\npublic and cross-account access within any public bucket policy, including non-public\ndelegation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-publicaccessblockconfiguration.html#cfn-s3objectlambda-accesspoint-publicaccessblockconfiguration-restrictpublicbuckets", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicPolicy": { "MarkdownDocumentation": "`BlockPublicPolicy`\n\nSpecifies whether Amazon S3 should block public bucket policies for buckets in this account.\nSetting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy\nif 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-publicaccessblockconfiguration.html#cfn-s3objectlambda-accesspoint-publicaccessblockconfiguration-blockpublicpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BlockPublicAcls": { "MarkdownDocumentation": "`BlockPublicAcls`\n\nSpecifies whether Amazon S3 should block public access control lists (ACLs) for buckets in\nthis account. Setting this element to `TRUE` causes the following\nbehavior:\n* `PutBucketAcl` and `PutObjectAcl` calls fail if the\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-publicaccessblockconfiguration.html#cfn-s3objectlambda-accesspoint-publicaccessblockconfiguration-blockpublicacls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IgnorePublicAcls": { "MarkdownDocumentation": "`IgnorePublicAcls`\n\nSpecifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting\nthis element to `TRUE` causes Amazon S3 to ignore all public ACLs on buckets in this\naccount and any objects that they contain.\nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't\nprevent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-publicaccessblockconfiguration.html#cfn-s3objectlambda-accesspoint-publicaccessblockconfiguration-ignorepublicacls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::S3ObjectLambda::AccessPoint.TransformationConfiguration": { "MarkdownDocumentation": "`AWS::S3ObjectLambda::AccessPoint.TransformationConfiguration`\n\nA configuration used when creating an Object Lambda Access Point transformation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-transformationconfiguration.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nA container for the action of an Object Lambda Access Point configuration. Valid\ninputs are `GetObject`, `HeadObject`, `ListObject`, and\n`ListObjectV2`.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-transformationconfiguration.html#cfn-s3objectlambda-accesspoint-transformationconfiguration-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ContentTransformation": { "MarkdownDocumentation": "`ContentTransformation`\n\nA container for the content transformation of an Object Lambda Access Point\nconfiguration. Can include the FunctionArn and FunctionPayload. For more information,\nsee [AwsLambdaTransformation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AwsLambdaTransformation.html) in the *Amazon S3 API\nReference*.\n*Required*: Yes\n*Type*: [ContentTransformation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-transformationconfiguration.html#cfn-s3objectlambda-accesspoint-transformationconfiguration-contenttransformation", "UpdateType": "Mutable", "Required": true, "Type": "ContentTransformation" } } }, "AWS::S3Outposts::AccessPoint.VpcConfiguration": { "MarkdownDocumentation": "`AWS::S3Outposts::AccessPoint.VpcConfiguration`\n\nContains the virtual private cloud (VPC) configuration for the specified access\npoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-accesspoint-vpcconfiguration.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-accesspoint-vpcconfiguration.html#cfn-s3outposts-accesspoint-vpcconfiguration-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Outposts::Bucket.AbortIncompleteMultipartUpload": { "MarkdownDocumentation": "`AWS::S3Outposts::Bucket.AbortIncompleteMultipartUpload`\n\nSpecifies the days since the initiation of an incomplete multipart upload that Amazon S3 on Outposts waits\nbefore permanently removing all parts of the upload. For more information, see [Aborting Incomplete\nMultipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-abortincompletemultipartupload.html", "Properties": { "DaysAfterInitiation": { "MarkdownDocumentation": "`DaysAfterInitiation`\n\nSpecifies the number of days after initiation that Amazon S3 on Outposts aborts an incomplete multipart upload.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-abortincompletemultipartupload.html#cfn-s3outposts-bucket-abortincompletemultipartupload-daysafterinitiation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::S3Outposts::Bucket.Filter": { "MarkdownDocumentation": "`AWS::S3Outposts::Bucket.Filter`\n\nThe `Filter` property type specifies Property description not available. for an [AWS::S3Outposts::Bucket](./aws-resource-s3outposts-bucket.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html", "Properties": { "AndOperator": { "MarkdownDocumentation": "`AndOperator`\n\nProperty description not available.\n*Required*: No\n*Type*: [FilterAndOperator](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html#cfn-s3outposts-bucket-filter-andoperator", "UpdateType": "Mutable", "Required": false, "Type": "FilterAndOperator" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html#cfn-s3outposts-bucket-filter-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tag": { "MarkdownDocumentation": "`Tag`\n\nProperty description not available.\n*Required*: No\n*Type*: [FilterTag](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html#cfn-s3outposts-bucket-filter-tag", "UpdateType": "Mutable", "Required": false, "Type": "FilterTag" } } }, "AWS::S3Outposts::Bucket.FilterAndOperator": { "MarkdownDocumentation": "`AWS::S3Outposts::Bucket.FilterAndOperator`\n\nThe `FilterAndOperator` property type specifies Property description not available. for an [AWS::S3Outposts::Bucket](./aws-resource-s3outposts-bucket.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filterandoperator.html", "Properties": { "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filterandoperator.html#cfn-s3outposts-bucket-filterandoperator-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [FilterTag](./aws-properties-s3outposts-bucket-filtertag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filterandoperator.html#cfn-s3outposts-bucket-filterandoperator-tags", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FilterTag", "DuplicatesAllowed": false } } }, "AWS::S3Outposts::Bucket.FilterTag": { "MarkdownDocumentation": "`AWS::S3Outposts::Bucket.FilterTag`\n\nThe `FilterTag` property type specifies Property description not available. for an [AWS::S3Outposts::Bucket](./aws-resource-s3outposts-bucket.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html#cfn-s3outposts-bucket-filtertag-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html#cfn-s3outposts-bucket-filtertag-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3Outposts::Bucket.LifecycleConfiguration": { "MarkdownDocumentation": "`AWS::S3Outposts::Bucket.LifecycleConfiguration`\n\nThe container for the lifecycle configuration for the objects stored in an S3 on Outposts bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-lifecycleconfiguration.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe container for the lifecycle configuration rules for the objects stored in the S3 on Outposts bucket.\n*Required*: Yes\n*Type*: Array of [Rule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-lifecycleconfiguration.html#cfn-s3outposts-bucket-lifecycleconfiguration-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": false } } }, "AWS::S3Outposts::Bucket.Rule": { "MarkdownDocumentation": "`AWS::S3Outposts::Bucket.Rule`\n\nA container for an Amazon S3 on Outposts bucket lifecycle rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nIf `Enabled`, the rule is currently being applied. If `Disabled`,\nthe rule is not currently being applied.\n*Required*: No\n*Type*: String\n*Allowed values*: `Enabled | Disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html#cfn-s3outposts-bucket-rule-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExpirationDate": { "MarkdownDocumentation": "`ExpirationDate`\n\nSpecifies the expiration for the lifecycle of the object by specifying an expiry date.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html#cfn-s3outposts-bucket-rule-expirationdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Filter": { "MarkdownDocumentation": "`Filter`\n\nThe container for the filter of the lifecycle rule.\n*Required*: No\n*Type*: [Filter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html#cfn-s3outposts-bucket-rule-filter", "UpdateType": "Mutable", "Required": false, "Type": "Filter" }, "ExpirationInDays": { "MarkdownDocumentation": "`ExpirationInDays`\n\nSpecifies 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html#cfn-s3outposts-bucket-rule-expirationindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Id": { "MarkdownDocumentation": "`Id`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html#cfn-s3outposts-bucket-rule-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AbortIncompleteMultipartUpload": { "MarkdownDocumentation": "`AbortIncompleteMultipartUpload`\n\nThe container for the abort incomplete multipart upload rule.\n*Required*: No\n*Type*: [AbortIncompleteMultipartUpload](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html#cfn-s3outposts-bucket-rule-abortincompletemultipartupload", "UpdateType": "Mutable", "Required": false, "Type": "AbortIncompleteMultipartUpload" } } }, "AWS::S3Outposts::Endpoint.FailedReason": { "MarkdownDocumentation": "`AWS::S3Outposts::Endpoint.FailedReason`\n\nThe failure reason, if any, for a create or delete endpoint operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-failedreason.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nAdditional error details describing the endpoint failure and recommended 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-failedreason.html#cfn-s3outposts-endpoint-failedreason-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ErrorCode": { "MarkdownDocumentation": "`ErrorCode`\n\nThe failure code, if any, for a create or delete endpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-failedreason.html#cfn-s3outposts-endpoint-failedreason-errorcode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Outposts::Endpoint.NetworkInterface": { "MarkdownDocumentation": "`AWS::S3Outposts::Endpoint.NetworkInterface`\n\nThe container for the network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-networkinterface.html", "Properties": { "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID for the network 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-endpoint-networkinterface.html#cfn-s3outposts-endpoint-networkinterface-networkinterfaceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3Tables::Table.Compaction": { "MarkdownDocumentation": "`AWS::S3Tables::Table.Compaction`\n\nContains details about the compaction settings for an Iceberg table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-compaction.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the maintenance configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `enabled | disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enabled", "disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-compaction.html#cfn-s3tables-table-compaction-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetFileSizeMB": { "MarkdownDocumentation": "`TargetFileSizeMB`\n\nThe target file size for the table in MB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `64`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-compaction.html#cfn-s3tables-table-compaction-targetfilesizemb", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::S3Tables::Table.IcebergMetadata": { "MarkdownDocumentation": "`AWS::S3Tables::Table.IcebergMetadata`\n\nContains details about the metadata for an Iceberg table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html", "Properties": { "IcebergSchema": { "MarkdownDocumentation": "`IcebergSchema`\n\nThe schema for an Iceberg table.\n*Required*: Yes\n*Type*: [IcebergSchema](./aws-properties-s3tables-table-icebergschema.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-icebergschema", "UpdateType": "Immutable", "Required": true, "Type": "IcebergSchema" } } }, "AWS::S3Tables::Table.IcebergSchema": { "MarkdownDocumentation": "`AWS::S3Tables::Table.IcebergSchema`\n\nContains details about the schema for an Iceberg table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschema.html", "Properties": { "SchemaFieldList": { "MarkdownDocumentation": "`SchemaFieldList`\n\nThe schema fields for the table\n*Required*: Yes\n*Type*: Array of [SchemaField](./aws-properties-s3tables-table-schemafield.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschema.html#cfn-s3tables-table-icebergschema-schemafieldlist", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "SchemaField", "DuplicatesAllowed": true } } }, "AWS::S3Tables::Table.SchemaField": { "MarkdownDocumentation": "`AWS::S3Tables::Table.SchemaField`\n\nContains details about a schema field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemafield.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the [Apache Iceberg documentation](https://iceberg.apache.org/spec/#primitive-types).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemafield.html#cfn-s3tables-table-schemafield-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Required": { "MarkdownDocumentation": "`Required`\n\nA Boolean value that specifies whether values are required for each row in this field. By default, this is `false` and null values are allowed in the field. If this is `true` the field does not allow null values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemafield.html#cfn-s3tables-table-schemafield-required", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the field.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemafield.html#cfn-s3tables-table-schemafield-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3Tables::Table.SnapshotManagement": { "MarkdownDocumentation": "`AWS::S3Tables::Table.SnapshotManagement`\n\nContains details about the snapshot management settings for an Iceberg table. The oldest snapshot expires when its age exceeds the `maxSnapshotAgeHours` and the total number of snapshots exceeds the value for the minimum number of snapshots to keep `minSnapshotsToKeep`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-snapshotmanagement.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the maintenance configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `enabled | disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enabled", "disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-snapshotmanagement.html#cfn-s3tables-table-snapshotmanagement-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinSnapshotsToKeep": { "MarkdownDocumentation": "`MinSnapshotsToKeep`\n\nThe minimum number of snapshots to keep.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-snapshotmanagement.html#cfn-s3tables-table-snapshotmanagement-minsnapshotstokeep", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxSnapshotAgeHours": { "MarkdownDocumentation": "`MaxSnapshotAgeHours`\n\nThe maximum age of a snapshot before it can be expired.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-snapshotmanagement.html#cfn-s3tables-table-snapshotmanagement-maxsnapshotagehours", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::S3Tables::Table.StorageClassConfiguration": { "MarkdownDocumentation": "`AWS::S3Tables::Table.StorageClassConfiguration`\n\nThe configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-storageclassconfiguration.html", "Properties": { "StorageClass": { "MarkdownDocumentation": "`StorageClass`\n\nThe storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | INTELLIGENT_TIER...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "INTELLIGENT_TIERING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-storageclassconfiguration.html#cfn-s3tables-table-storageclassconfiguration-storageclass", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Tables::TableBucket.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::S3Tables::TableBucket.EncryptionConfiguration`\n\nConfiguration specifying how data should be encrypted. This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.html", "Properties": { "KMSKeyArn": { "MarkdownDocumentation": "`KMSKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when `sseAlgorithm` is set to `aws:kms`.\n*Required*: No\n*Type*: String\n*Pattern*: `(arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.html#cfn-s3tables-tablebucket-encryptionconfiguration-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SSEAlgorithm": { "MarkdownDocumentation": "`SSEAlgorithm`\n\nThe server-side encryption algorithm to use. Valid values are `AES256` for S3-managed encryption keys, or `aws:kms` for AWS KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see [Permissions requirements for S3 Tables SSE-KMS encryption](https://docs.aws.amazon.com//AmazonS3/latest/userguide/s3-tables-kms-permissions.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `AES256 | aws:kms...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AES256", "aws:kms" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.html#cfn-s3tables-tablebucket-encryptionconfiguration-ssealgorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Tables::TableBucket.MetricsConfiguration": { "MarkdownDocumentation": "`AWS::S3Tables::TableBucket.MetricsConfiguration`\n\nThe `MetricsConfiguration` property type specifies Property description not available. for an [AWS::S3Tables::TableBucket](./aws-resource-s3tables-tablebucket.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-metricsconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `Enabled | Disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-metricsconfiguration.html#cfn-s3tables-tablebucket-metricsconfiguration-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Tables::TableBucket.StorageClassConfiguration": { "MarkdownDocumentation": "`AWS::S3Tables::TableBucket.StorageClassConfiguration`\n\nThe configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-storageclassconfiguration.html", "Properties": { "StorageClass": { "MarkdownDocumentation": "`StorageClass`\n\nThe storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | INTELLIGENT_TIER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "INTELLIGENT_TIERING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-storageclassconfiguration.html#cfn-s3tables-tablebucket-storageclassconfiguration-storageclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Tables::TableBucket.UnreferencedFileRemoval": { "MarkdownDocumentation": "`AWS::S3Tables::TableBucket.UnreferencedFileRemoval`\n\nThe unreferenced file removal settings for your table bucket. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. For more information, see the [*Amazon S3 User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the unreferenced file removal configuration for your table bucket.\n*Required*: No\n*Type*: String\n*Allowed values*: `Enabled | Disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.html#cfn-s3tables-tablebucket-unreferencedfileremoval-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NoncurrentDays": { "MarkdownDocumentation": "`NoncurrentDays`\n\nThe number of days an object can be noncurrent before Amazon S3 deletes it.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.html#cfn-s3tables-tablebucket-unreferencedfileremoval-noncurrentdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "UnreferencedDays": { "MarkdownDocumentation": "`UnreferencedDays`\n\nThe number of days an object must be unreferenced by your table before Amazon S3 marks the object as noncurrent.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.html#cfn-s3tables-tablebucket-unreferencedfileremoval-unreferenceddays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::S3Vectors::Index.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::S3Vectors::Index.EncryptionConfiguration`\n\nThe encryption configuration for a vector bucket or index. By default, if you don't specify, all\nnew vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed\nkeys (SSE-S3), specifically `AES256`. You can optionally override bucket level encryption settings, and set a specific encryption configuration for a vector index at the time of index creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-encryptionconfiguration.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nAWS Key Management Service (KMS) customer managed key ID to use for the encryption\nconfiguration. This parameter is allowed if and only if `sseType` is set to\n`aws:kms`.\nTo specify the KMS key, you must use the format of the KMS key\nAmazon Resource Name (ARN).\nFor example, specify Key ARN in the following format:\n`arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-encryptionconfiguration.html#cfn-s3vectors-index-encryptionconfiguration-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SseType": { "MarkdownDocumentation": "`SseType`\n\nThe server-side encryption type to use for the encryption configuration of the vector\nbucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use\nserver-side encryption with Amazon S3 managed keys (SSE-S3), specifically\n`AES256`.\n*Required*: No\n*Type*: String\n*Allowed values*: `AES256 | aws:kms...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AES256", "aws:kms" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-encryptionconfiguration.html#cfn-s3vectors-index-encryptionconfiguration-ssetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::S3Vectors::Index.MetadataConfiguration": { "MarkdownDocumentation": "`AWS::S3Vectors::Index.MetadataConfiguration`\n\nThe metadata configuration for the vector index. This configuration allows you to specify which metadata keys should be treated as non-filterable.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-metadataconfiguration.html", "Properties": { "NonFilterableMetadataKeys": { "MarkdownDocumentation": "`NonFilterableMetadataKeys`\n\nNon-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys can't be used as query filters. Non-filterable metadata keys can be retrieved but can't be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.\nYou can specify 1 to 10 non-filterable metadata keys. Each key must be 1 to 63 characters long.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `63 | 10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-metadataconfiguration.html#cfn-s3vectors-index-metadataconfiguration-nonfilterablemetadatakeys", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::S3Vectors::VectorBucket.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::S3Vectors::VectorBucket.EncryptionConfiguration`\n\nSpecifies the encryption configuration for the vector bucket. By default, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nAWS Key Management Service (KMS) customer managed key ARN to use for the encryption configuration. This parameter is required if and only if `SseType` is set to `aws:kms`.\nYou must specify the full ARN of the KMS key. Key IDs or key aliases aren't supported.\n###### Important\nAmazon S3 Vectors 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*: No\n*Type*: String\n*Pattern*: `^(arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html#cfn-s3vectors-vectorbucket-encryptionconfiguration-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SseType": { "MarkdownDocumentation": "`SseType`\n\nThe server-side encryption type to use for the encryption configuration of the vector bucket. Valid values are `AES256` for Amazon S3 managed keys and `aws:kms` for AWS KMS keys.\n*Required*: No\n*Type*: String\n*Allowed values*: `AES256 | aws:kms...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AES256", "aws:kms" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html#cfn-s3vectors-vectorbucket-encryptionconfiguration-ssetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSet.DashboardOptions": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet.DashboardOptions`\n\nAn object containing additional settings for your VDM configuration as applicable to\nthe Dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-dashboardoptions.html", "Properties": { "EngagementMetrics": { "MarkdownDocumentation": "`EngagementMetrics`\n\nSpecifies the status of your VDM engagement metrics collection. Can be one of the\nfollowing:\n* `ENABLED` \u2013 Amazon SES enables engagement metrics for the\n configuration set.\n* `DISABLED` \u2013 Amazon SES disables engagement metrics for the\n configuration set.\n*Required*: Yes\n*Type*: String\n*Pattern*: `ENABLED|DISABLED`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-dashboardoptions.html#cfn-ses-configurationset-dashboardoptions-engagementmetrics", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSet.DeliveryOptions": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet.DeliveryOptions`\n\nSpecifies the name of the dedicated IP pool to associate with the configuration set\nand whether messages that use the configuration set are required to use Transport Layer\nSecurity (TLS).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-deliveryoptions.html", "Properties": { "MaxDeliverySeconds": { "MarkdownDocumentation": "`MaxDeliverySeconds`\n\nThe name of the configuration set used when sent through a configuration set with archiving\nenabled.\n*Required*: No\n*Type*: Number\n*Minimum*: `300`\n*Maximum*: `50400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-deliveryoptions.html#cfn-ses-configurationset-deliveryoptions-maxdeliveryseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "SendingPoolName": { "MarkdownDocumentation": "`SendingPoolName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-deliveryoptions.html#cfn-ses-configurationset-deliveryoptions-sendingpoolname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TlsPolicy": { "MarkdownDocumentation": "`TlsPolicy`\n\nSpecifies whether messages that use the configuration set are required to use\nTransport Layer Security (TLS). If the value is `REQUIRE`, messages are only\ndelivered if a TLS connection can be established. If the value is `OPTIONAL`,\nmessages 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*Pattern*: `REQUIRE|OPTIONAL`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-deliveryoptions.html#cfn-ses-configurationset-deliveryoptions-tlspolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSet.GuardianOptions": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet.GuardianOptions`\n\nAn object containing additional settings for your VDM configuration as applicable to\nthe Guardian.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-guardianoptions.html", "Properties": { "OptimizedSharedDelivery": { "MarkdownDocumentation": "`OptimizedSharedDelivery`\n\nSpecifies the status of your VDM optimized shared delivery. Can be one of the\nfollowing:\n* `ENABLED` \u2013 Amazon SES enables optimized shared delivery for the\n configuration set.\n* `DISABLED` \u2013 Amazon SES disables optimized shared delivery for the\n configuration set.\n*Required*: Yes\n*Type*: String\n*Pattern*: `ENABLED|DISABLED`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-guardianoptions.html#cfn-ses-configurationset-guardianoptions-optimizedshareddelivery", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSet.ReputationOptions": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet.ReputationOptions`\n\nEnable or disable collection of reputation metrics for emails that you send using this\nconfiguration set in the current AWS Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-reputationoptions.html", "Properties": { "ReputationMetricsEnabled": { "MarkdownDocumentation": "`ReputationMetricsEnabled`\n\nIf `true`, tracking of reputation metrics is enabled for the configuration\nset. If `false`, tracking of reputation metrics is disabled for the\nconfiguration set.\n*Required*: No\n*Type*: Boolean\n*Pattern*: `true|false`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-reputationoptions.html#cfn-ses-configurationset-reputationoptions-reputationmetricsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SES::ConfigurationSet.SendingOptions": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet.SendingOptions`\n\nUsed to enable or disable email sending for messages that use this configuration set\nin the current AWS Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-sendingoptions.html", "Properties": { "SendingEnabled": { "MarkdownDocumentation": "`SendingEnabled`\n\nIf `true`, email sending is enabled for the configuration set. If\n`false`, email sending is disabled for the configuration set.\n*Required*: No\n*Type*: Boolean\n*Pattern*: `true|false`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-sendingoptions.html#cfn-ses-configurationset-sendingoptions-sendingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SES::ConfigurationSet.SuppressionOptions": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet.SuppressionOptions`\n\nAn object that contains information about the suppression list preferences for your\naccount.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-suppressionoptions.html", "Properties": { "SuppressedReasons": { "MarkdownDocumentation": "`SuppressedReasons`\n\nA list that contains the reasons that email addresses are automatically added to the\nsuppression list for your account. This list can contain any or all of the\nfollowing:\n* `COMPLAINT` \u2013 Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a\n complaint.\n* `BOUNCE` \u2013 Amazon SES adds an email address to the suppression list\n for your account when a message sent to that address results in a hard\n bounce.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-suppressionoptions.html#cfn-ses-configurationset-suppressionoptions-suppressedreasons", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SES::ConfigurationSet.TrackingOptions": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet.TrackingOptions`\n\nAn object that defines the tracking options for a configuration set. When you use the\nAmazon SES API v2 to send an email, it contains an invisible image that's used to track\nwhen recipients open your email. If your email contains links, those links are changed\nslightly in order to track when recipients click them.\nYou can optionally configure a custom subdomain that is used to redirect email\nrecipients to an Amazon SES-operated domain. This domain captures open and click events\ngenerated by Amazon SES emails.\nFor more information, see [Configuring Custom\nDomains to Handle Open and Click Tracking](https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html) in the *Amazon SES\nDeveloper Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.html", "Properties": { "HttpsPolicy": { "MarkdownDocumentation": "`HttpsPolicy`\n\nThe name of the configuration set used when sent through a configuration set with archiving\nenabled.\n*Required*: No\n*Type*: String\n*Pattern*: `REQUIRE|REQUIRE_OPEN_ONLY|OPTIONAL`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.html#cfn-ses-configurationset-trackingoptions-httpspolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomRedirectDomain": { "MarkdownDocumentation": "`CustomRedirectDomain`\n\nThe custom subdomain that is used to redirect email recipients to the Amazon SES event\ntracking 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.html#cfn-ses-configurationset-trackingoptions-customredirectdomain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSet.VdmOptions": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet.VdmOptions`\n\nThe Virtual Deliverability Manager (VDM) options that apply to a configuration\nset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html", "Properties": { "DashboardOptions": { "MarkdownDocumentation": "`DashboardOptions`\n\nSpecifies additional settings for your VDM configuration as applicable to the\nDashboard.\n*Required*: No\n*Type*: [DashboardOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html#cfn-ses-configurationset-vdmoptions-dashboardoptions", "UpdateType": "Mutable", "Required": false, "Type": "DashboardOptions" }, "GuardianOptions": { "MarkdownDocumentation": "`GuardianOptions`\n\nSpecifies additional settings for your VDM configuration as applicable to the\nGuardian.\n*Required*: No\n*Type*: [GuardianOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html#cfn-ses-configurationset-vdmoptions-guardianoptions", "UpdateType": "Mutable", "Required": false, "Type": "GuardianOptions" } } }, "AWS::SES::ConfigurationSetEventDestination.CloudWatchDestination": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSetEventDestination.CloudWatchDestination`\n\nAn object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\nmonitor and gain insights on your email sending metrics.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html", "Properties": { "DimensionConfigurations": { "MarkdownDocumentation": "`DimensionConfigurations`\n\nAn array of objects that define the dimensions to use when you send email events to\nAmazon CloudWatch.\n*Required*: No\n*Type*: Array of [DimensionConfiguration](./aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html#cfn-ses-configurationseteventdestination-cloudwatchdestination-dimensionconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DimensionConfiguration", "DuplicatesAllowed": true } } }, "AWS::SES::ConfigurationSetEventDestination.DimensionConfiguration": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSetEventDestination.DimensionConfiguration`\n\nAn object that defines the dimension configuration to use when you send email events\nto Amazon CloudWatch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html", "Properties": { "DimensionValueSource": { "MarkdownDocumentation": "`DimensionValueSource`\n\nThe location where the Amazon SES API v2 finds the value of a dimension to publish to\nAmazon CloudWatch. To use the message tags that you specify using an\n`X-SES-MESSAGE-TAGS` header or a parameter to the `SendEmail`\nor `SendRawEmail` API, choose `messageTag`. To use your own email\nheaders, choose `emailHeader`. To use link tags, choose\n`linkTag`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `messageTag | emailHeader | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "messageTag", "emailHeader", "linkTag" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionvaluesource", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultDimensionValue": { "MarkdownDocumentation": "`DefaultDimensionValue`\n\nThe default value of the dimension that is published to Amazon CloudWatch if you don't provide the\nvalue of the dimension when you send an email. This value has to meet the following\ncriteria:\n* Can only contain ASCII letters (a\u2013z, A\u2013Z), numbers (0\u20139),\n underscores (\\_), or dashes (-), at signs (@), and periods (.).\n* It can contain no more than 256 characters.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,256}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-defaultdimensionvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DimensionName": { "MarkdownDocumentation": "`DimensionName`\n\nThe name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to\nmeet the following criteria:\n* It can only contain ASCII letters (a\u2013z, A\u2013Z), numbers (0\u20139),\n underscores (\\_), or dashes (-).\n* It can contain no more than 256 characters.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_:-]{1,256}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSetEventDestination.EventBridgeDestination": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSetEventDestination.EventBridgeDestination`\n\nAn object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to\nsend notifications when certain email events occur.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventbridgedestination.html", "Properties": { "EventBusArn": { "MarkdownDocumentation": "`EventBusArn`\n\nThe Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z0-9-]*:events:[a-z0-9-]+:\\d{12}:event-bus/[^:]+$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventbridgedestination.html#cfn-ses-configurationseteventdestination-eventbridgedestination-eventbusarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSetEventDestination.EventDestination": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSetEventDestination.EventDestination`\n\nIn the Amazon SES API v2, *events* include message sends, deliveries, opens,\nclicks, bounces, complaints and delivery delays. *Event destinations*\nare places that you can send information about these events to. For example, you can\nsend event data to Amazon SNS to receive notifications when you receive bounces or\ncomplaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html", "Properties": { "SnsDestination": { "MarkdownDocumentation": "`SnsDestination`\n\nAn object that contains the topic ARN associated with an Amazon Simple Notification\nService (Amazon SNS) event destination.\n*Required*: No\n*Type*: [SnsDestination](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-snsdestination", "UpdateType": "Mutable", "Required": false, "Type": "SnsDestination" }, "CloudWatchDestination": { "MarkdownDocumentation": "`CloudWatchDestination`\n\nAn object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\nmonitor and gain insights on your email sending metrics.\n*Required*: No\n*Type*: [CloudWatchDestination](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-cloudwatchdestination", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchDestination" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIf `true`, the event destination is enabled. When the event destination is\nenabled, the specified event types are sent to the destinations in this\n`EventDestinationDefinition`.\nIf `false`, the event destination is disabled. When the event destination\nis disabled, events aren't sent to the specified destinations.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MatchingEventTypes": { "MarkdownDocumentation": "`MatchingEventTypes`\n\nThe types of events that Amazon SES sends to the specified event destinations.\n* `SEND` - The send request was successful and SES will\n attempt to deliver the message to the recipient\u2019s mail server. (If account-level\n or global suppression is being used, SES will still count it as a send,\n but delivery is suppressed.)\n* `REJECT` - SES accepted the email, but determined that it\n contained a virus and didn\u2019t attempt to deliver it to the recipient\u2019s mail\n server.\n* `BOUNCE` - (*Hard bounce*) The recipient's\n mail server permanently rejected the email. (*Soft bounces*\n are only included when SES fails to deliver the email after retrying for\n a period of time.)\n* `COMPLAINT` - The email was successfully delivered to the\n recipient\u2019s mail server, but the recipient marked it as spam.\n* `DELIVERY` - SES successfully delivered the email to the\n recipient's mail server.\n* `OPEN` - The recipient received the message and opened it in their\n email client.\n* `CLICK` - The recipient clicked one or more links in the\n email.\n* `RENDERING_FAILURE` - The email wasn't sent because of a\n template rendering issue. This event type can occur when template data is\n missing, or when there is a mismatch between template parameters and data. (This\n event type only occurs when you send email using the [`SendEmail`](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html) or [`SendBulkEmail`](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendBulkEmail.html) API operations.)\n* `DELIVERY_DELAY` - The email couldn't be delivered to the\n recipient\u2019s mail server because a temporary issue occurred. Delivery delays can\n occur, for example, when the recipient's inbox is full, or when the\n receiving email server experiences a transient issue.\n* `SUBSCRIPTION` - The email was successfully delivered, but the\n recipient updated their subscription preferences by clicking on an\n *unsubscribe* link as part of your [subscription\n management](https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html).\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-matchingeventtypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EventBridgeDestination": { "MarkdownDocumentation": "`EventBridgeDestination`\n\nAn object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to\nsend notifications when certain email events occur.\n*Required*: No\n*Type*: [EventBridgeDestination](./aws-properties-ses-configurationseteventdestination-eventbridgedestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-eventbridgedestination", "UpdateType": "Mutable", "Required": false, "Type": "EventBridgeDestination" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the event destination. The name must meet the following\nrequirements:\n* Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (\\_), or\n dashes (-).\n* Contain 64 characters or fewer.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{0,64}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KinesisFirehoseDestination": { "MarkdownDocumentation": "`KinesisFirehoseDestination`\n\nAn object that contains the delivery stream ARN and the IAM role ARN associated with\nan Amazon Kinesis Firehose event destination.\n*Required*: No\n*Type*: [KinesisFirehoseDestination](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-kinesisfirehosedestination", "UpdateType": "Mutable", "Required": false, "Type": "KinesisFirehoseDestination" } } }, "AWS::SES::ConfigurationSetEventDestination.KinesisFirehoseDestination": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSetEventDestination.KinesisFirehoseDestination`\n\nAn object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\nstream data to other services, such as Amazon S3 and Amazon Redshift.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html", "Properties": { "IAMRoleARN": { "MarkdownDocumentation": "`IAMRoleARN`\n\nThe Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email\nevents to the Amazon Kinesis Data 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-iamrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DeliveryStreamARN": { "MarkdownDocumentation": "`DeliveryStreamARN`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-deliverystreamarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSetEventDestination.SnsDestination": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSetEventDestination.SnsDestination`\n\nContains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.\nEvent destinations, such as Amazon SNS, are associated with configuration sets, which\nenable you to publish email sending events. For information about using configuration\nsets, see the [Amazon SES Developer\nGuide](https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-snsdestination.html", "Properties": { "TopicARN": { "MarkdownDocumentation": "`TopicARN`\n\nThe ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic\nby 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*Pattern*: `^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-snsdestination.html#cfn-ses-configurationseteventdestination-snsdestination-topicarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::ContactList.Topic": { "MarkdownDocumentation": "`AWS::SES::ContactList.Topic`\n\nAn interest group, theme, or label within a list. Lists can have multiple\ntopics.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of what the topic is about, which the contact will see.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html#cfn-ses-contactlist-topic-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe name of the topic the contact will see.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html#cfn-ses-contactlist-topic-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultSubscriptionStatus": { "MarkdownDocumentation": "`DefaultSubscriptionStatus`\n\nThe default subscription status to be applied to a contact if the contact has not\nnoted their preference for subscribing to a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html#cfn-ses-contactlist-topic-defaultsubscriptionstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TopicName": { "MarkdownDocumentation": "`TopicName`\n\nThe name of the topic.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-contactlist-topic.html#cfn-ses-contactlist-topic-topicname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::EmailIdentity.ConfigurationSetAttributes": { "MarkdownDocumentation": "`AWS::SES::EmailIdentity.ConfigurationSetAttributes`\n\nUsed to associate a configuration set with an email identity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-configurationsetattributes.html", "Properties": { "ConfigurationSetName": { "MarkdownDocumentation": "`ConfigurationSetName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-configurationsetattributes.html#cfn-ses-emailidentity-configurationsetattributes-configurationsetname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::EmailIdentity.DkimAttributes": { "MarkdownDocumentation": "`AWS::SES::EmailIdentity.DkimAttributes`\n\nUsed to enable or disable DKIM authentication for an email identity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimattributes.html", "Properties": { "SigningEnabled": { "MarkdownDocumentation": "`SigningEnabled`\n\nSets the DKIM signing configuration for the identity.\nWhen you set this value `true`, then the messages that are sent from the\nidentity are signed using DKIM. If you set this value to `false`, your\nmessages 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimattributes.html#cfn-ses-emailidentity-dkimattributes-signingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SES::EmailIdentity.DkimSigningAttributes": { "MarkdownDocumentation": "`AWS::SES::EmailIdentity.DkimSigningAttributes`\n\nUsed to configure or change the DKIM authentication settings for an email domain\nidentity. You can use this operation to do any of the following:\n* Update the signing attributes for an identity that uses Bring Your Own DKIM\n (BYODKIM).\n* Update the key length that should be used for Easy DKIM.\n* Change from using no DKIM authentication to using Easy DKIM.\n* Change from using no DKIM authentication to using BYODKIM.\n* Change from using Easy DKIM to using BYODKIM.\n* Change from using BYODKIM to using Easy DKIM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimsigningattributes.html", "Properties": { "DomainSigningPrivateKey": { "MarkdownDocumentation": "`DomainSigningPrivateKey`\n\n[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\nbase64 encoding.\n###### Important\nRather than embedding sensitive information directly in your CFN templates, we\nrecommend you use dynamic parameters in the stack template to reference sensitive\ninformation that is stored and managed outside of CFN, such as in the AWS Systems Manager Parameter Store or AWS Secrets\nManager.\nFor more information, see the [Do not embed\ncredentials 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimsigningattributes.html#cfn-ses-emailidentity-dkimsigningattributes-domainsigningprivatekey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainSigningSelector": { "MarkdownDocumentation": "`DomainSigningSelector`\n\n[Bring Your Own DKIM] A string that's used to identify a public key in the DNS\nconfiguration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimsigningattributes.html#cfn-ses-emailidentity-dkimsigningattributes-domainsigningselector", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NextSigningKeyLength": { "MarkdownDocumentation": "`NextSigningKeyLength`\n\n[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be\nchanged at most once per day.\nValid Values: `RSA_1024_BIT | RSA_2048_BIT`\n*Required*: No\n*Type*: String\n*Pattern*: `RSA_1024_BIT|RSA_2048_BIT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimsigningattributes.html#cfn-ses-emailidentity-dkimsigningattributes-nextsigningkeylength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::EmailIdentity.FeedbackAttributes": { "MarkdownDocumentation": "`AWS::SES::EmailIdentity.FeedbackAttributes`\n\nUsed to enable or disable feedback forwarding for an identity. This setting determines\nwhat happens when an identity is used to send an email that results in a bounce or\ncomplaint event.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-feedbackattributes.html", "Properties": { "EmailForwardingEnabled": { "MarkdownDocumentation": "`EmailForwardingEnabled`\n\nSets the feedback forwarding configuration for the identity.\nIf the value is `true`, you receive email notifications when bounce or\ncomplaint events occur. These notifications are sent to the address that you specified\nin the `Return-Path` header of the original email.\nYou're required to have a method of tracking bounces and complaints. If you haven't\nset up another mechanism for receiving bounce or complaint notifications (for example,\nby setting up an event destination), you receive an email notification when these events\noccur (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-feedbackattributes.html#cfn-ses-emailidentity-feedbackattributes-emailforwardingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SES::EmailIdentity.MailFromAttributes": { "MarkdownDocumentation": "`AWS::SES::EmailIdentity.MailFromAttributes`\n\nUsed to enable or disable the custom Mail-From domain configuration for an email\nidentity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-mailfromattributes.html", "Properties": { "MailFromDomain": { "MarkdownDocumentation": "`MailFromDomain`\n\nThe custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM\ndomain 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\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-mailfromattributes.html#cfn-ses-emailidentity-mailfromattributes-mailfromdomain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BehaviorOnMxFailure": { "MarkdownDocumentation": "`BehaviorOnMxFailure`\n\nThe action to take if the required MX record isn't found when you send an email. When\nyou set this value to `USE_DEFAULT_VALUE`, the mail is sent using\n*amazonses.com* as the MAIL FROM domain. When you set this value\nto `REJECT_MESSAGE`, the Amazon SES API v2 returns a\n`MailFromDomainNotVerified` error, and doesn't attempt to deliver the\nemail.\nThese behaviors are taken when the custom MAIL FROM domain configuration is in the\n`Pending`, `Failed`, and `TemporaryFailure`\nstates.\nValid Values: `USE_DEFAULT_VALUE | REJECT_MESSAGE`\n*Required*: No\n*Type*: String\n*Pattern*: `USE_DEFAULT_VALUE|REJECT_MESSAGE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-mailfromattributes.html#cfn-ses-emailidentity-mailfromattributes-behavioronmxfailure", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerArchive.ArchiveRetention": { "MarkdownDocumentation": "`AWS::SES::MailManagerArchive.ArchiveRetention`\n\nThe retention policy for an email archive that specifies how long emails are kept\nbefore being automatically deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerarchive-archiveretention.html", "Properties": { "RetentionPeriod": { "MarkdownDocumentation": "`RetentionPeriod`\n\nThe enum value sets the period for retaining emails in an archive.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `THREE_MONTHS | SIX_MONTHS |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "THREE_MONTHS", "SIX_MONTHS", "NINE_MONTHS", "ONE_YEAR", "EIGHTEEN_MONTHS", "TWO_YEARS", "THIRTY_MONTHS", "THREE_YEARS", "FOUR_YEARS", "FIVE_YEARS", "SIX_YEARS", "SEVEN_YEARS", "EIGHT_YEARS", "NINE_YEARS", "TEN_YEARS", "PERMANENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerarchive-archiveretention.html#cfn-ses-mailmanagerarchive-archiveretention-retentionperiod", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerIngressPoint.IngressPointConfiguration": { "MarkdownDocumentation": "`AWS::SES::MailManagerIngressPoint.IngressPointConfiguration`\n\nThe configuration of the ingress endpoint resource.\n###### Important\nThis data type is a UNION, so only one of the following members can be specified\nwhen used or returned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-ingresspointconfiguration.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe SecretsManager::Secret ARN of the ingress endpoint resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\\d{12}:secret:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-ingresspointconfiguration.html#cfn-ses-mailmanageringresspoint-ingresspointconfiguration-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SmtpPassword": { "MarkdownDocumentation": "`SmtpPassword`\n\nThe password of the ingress endpoint resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9!@#$%^&*()_+\\-=\\[\\]{}|.,?]+$`\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-ingresspointconfiguration.html#cfn-ses-mailmanageringresspoint-ingresspointconfiguration-smtppassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerIngressPoint.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::SES::MailManagerIngressPoint.NetworkConfiguration`\n\nThe network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-networkconfiguration.html", "Properties": { "PublicNetworkConfiguration": { "MarkdownDocumentation": "`PublicNetworkConfiguration`\n\nSpecifies the network configuration for the public ingress point.\n*Required*: No\n*Type*: [PublicNetworkConfiguration](./aws-properties-ses-mailmanageringresspoint-publicnetworkconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-networkconfiguration.html#cfn-ses-mailmanageringresspoint-networkconfiguration-publicnetworkconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "PublicNetworkConfiguration" }, "PrivateNetworkConfiguration": { "MarkdownDocumentation": "`PrivateNetworkConfiguration`\n\nSpecifies the network configuration for the private ingress point.\n*Required*: No\n*Type*: [PrivateNetworkConfiguration](./aws-properties-ses-mailmanageringresspoint-privatenetworkconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-networkconfiguration.html#cfn-ses-mailmanageringresspoint-networkconfiguration-privatenetworkconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "PrivateNetworkConfiguration" } } }, "AWS::SES::MailManagerIngressPoint.PrivateNetworkConfiguration": { "MarkdownDocumentation": "`AWS::SES::MailManagerIngressPoint.PrivateNetworkConfiguration`\n\nSpecifies the network configuration for the private ingress point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-privatenetworkconfiguration.html", "Properties": { "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe identifier of the VPC endpoint to associate with this private ingress point.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^vpce-[a-zA-Z0-9]{17}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-privatenetworkconfiguration.html#cfn-ses-mailmanageringresspoint-privatenetworkconfiguration-vpcendpointid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerIngressPoint.PublicNetworkConfiguration": { "MarkdownDocumentation": "`AWS::SES::MailManagerIngressPoint.PublicNetworkConfiguration`\n\nSpecifies the network configuration for the public ingress point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-publicnetworkconfiguration.html", "Properties": { "IpType": { "MarkdownDocumentation": "`IpType`\n\nThe IP address type for the public ingress point. Valid values are IPV4 and DUAL\\_STACK.\n*Required*: Yes\n*Type*:\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-publicnetworkconfiguration.html#cfn-ses-mailmanageringresspoint-publicnetworkconfiguration-iptype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::SES::MailManagerRelay.RelayAuthentication": { "MarkdownDocumentation": "`AWS::SES::MailManagerRelay.RelayAuthentication`\n\nAuthentication for the relay destination server\u2014specify the secretARN where the SMTP\ncredentials are stored, or specify an empty NoAuthentication structure if the relay\ndestination server does not require SMTP credential authentication.\n###### Important\nThis data type is a UNION, so only one of the following members can be specified\nwhen used or returned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerrelay-relayauthentication.html", "Properties": { "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\\d{12}:secret:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerrelay-relayauthentication.html#cfn-ses-mailmanagerrelay-relayauthentication-secretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NoAuthentication": { "MarkdownDocumentation": "`NoAuthentication`\n\nKeep an empty structure if the relay destination server does not require SMTP credential authentication.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerrelay-relayauthentication.html#cfn-ses-mailmanagerrelay-relayauthentication-noauthentication", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::SES::MailManagerRuleSet.AddHeaderAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.AddHeaderAction`\n\nThe action to add a header to a message. When executed, this action will add the given\nheader to the message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-addheaderaction.html", "Properties": { "HeaderValue": { "MarkdownDocumentation": "`HeaderValue`\n\nThe value of the header to add to the email.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-addheaderaction.html#cfn-ses-mailmanagerruleset-addheaderaction-headervalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HeaderName": { "MarkdownDocumentation": "`HeaderName`\n\nThe name of the header to add to an email. The header must be prefixed with\n\"X-\". Headers are added regardless of whether the header name pre-existed in\nthe email.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[xX]\\-[a-zA-Z0-9\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-addheaderaction.html#cfn-ses-mailmanagerruleset-addheaderaction-headername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.Analysis": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.Analysis`\n\nThe result of an analysis can be used in conditions to trigger actions. Analyses can\ninspect the email content and report a certain aspect of the email.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-analysis.html", "Properties": { "Analyzer": { "MarkdownDocumentation": "`Analyzer`\n\nThe Amazon Resource Name (ARN) of an Add On.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-analysis.html#cfn-ses-mailmanagerruleset-analysis-analyzer", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResultField": { "MarkdownDocumentation": "`ResultField`\n\nThe returned value from an Add On.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(addon\\.)?[\\sa-zA-Z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-analysis.html#cfn-ses-mailmanagerruleset-analysis-resultfield", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.ArchiveAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.ArchiveAction`\n\nThe action to archive the email by delivering the email to an Amazon SES archive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-archiveaction.html", "Properties": { "TargetArchive": { "MarkdownDocumentation": "`TargetArchive`\n\nThe identifier of the archive to send the email to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:_/+=,@.#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-archiveaction.html#cfn-ses-mailmanagerruleset-archiveaction-targetarchive", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionFailurePolicy": { "MarkdownDocumentation": "`ActionFailurePolicy`\n\nA policy that states what to do in the case of failure. The action will fail if there\nare configuration errors. For example, the specified archive has been deleted.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-archiveaction.html#cfn-ses-mailmanagerruleset-archiveaction-actionfailurepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.DeliverToMailboxAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.DeliverToMailboxAction`\n\nThis action to delivers an email to a mailbox.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertomailboxaction.html", "Properties": { "MailboxArn": { "MarkdownDocumentation": "`MailboxArn`\n\nThe Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:_/+=,@.#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertomailboxaction.html#cfn-ses-mailmanagerruleset-delivertomailboxaction-mailboxarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionFailurePolicy": { "MarkdownDocumentation": "`ActionFailurePolicy`\n\nA policy that states what to do in the case of failure. The action will fail if there\nare configuration errors. For example, the mailbox ARN is no longer valid.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertomailboxaction.html#cfn-ses-mailmanagerruleset-delivertomailboxaction-actionfailurepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to\nthe workmail:DeliverToMailbox API.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:_/+=,@.#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertomailboxaction.html#cfn-ses-mailmanagerruleset-delivertomailboxaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.DeliverToQBusinessAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.DeliverToQBusinessAction`\n\nThe action to deliver incoming emails to an Amazon Q Business application for indexing.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html", "Properties": { "IndexId": { "MarkdownDocumentation": "`IndexId`\n\nThe identifier of the knowledge base index within the Amazon Q Business application\nwhere the email content will be stored and indexed.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-indexid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionFailurePolicy": { "MarkdownDocumentation": "`ActionFailurePolicy`\n\nA policy that states what to do in the case of failure. The action will fail if there are\nconfiguration errors. For example, the specified application has been deleted or the role lacks\nnecessary permissions to call the `qbusiness:BatchPutDocument` API.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-actionfailurepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationId": { "MarkdownDocumentation": "`ApplicationId`\n\nThe unique identifier of the Amazon Q Business application instance where the email\ncontent will be delivered.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9-]+$`\n*Minimum*: `36`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-applicationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access\nto the `qbusiness:BatchPutDocument` API for the given application and index.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:_/+=,@.#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.RelayAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RelayAction`\n\nThe action relays the email via SMTP to another specific SMTP server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-relayaction.html", "Properties": { "Relay": { "MarkdownDocumentation": "`Relay`\n\nThe identifier of the relay resource to be used when relaying an email.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:_/+=,@.#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-relayaction.html#cfn-ses-mailmanagerruleset-relayaction-relay", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MailFrom": { "MarkdownDocumentation": "`MailFrom`\n\nThis action specifies whether to preserve or replace original mail from address while\nrelaying received emails to a destination server.\n*Required*: No\n*Type*: String\n*Allowed values*: `REPLACE | PRESERVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REPLACE", "PRESERVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-relayaction.html#cfn-ses-mailmanagerruleset-relayaction-mailfrom", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ActionFailurePolicy": { "MarkdownDocumentation": "`ActionFailurePolicy`\n\nA policy that states what to do in the case of failure. The action will fail if there\nare configuration errors. For example, the specified relay has been deleted.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-relayaction.html#cfn-ses-mailmanagerruleset-relayaction-actionfailurepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.ReplaceRecipientAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.ReplaceRecipientAction`\n\nThis action replaces the email envelope recipients with the given list of recipients.\nIf the condition of this action applies only to a subset of recipients, only those\nrecipients are replaced with the recipients specified in the action. The message\ncontents and headers are unaffected by this action, only the envelope recipients are\nupdated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-replacerecipientaction.html", "Properties": { "ReplaceWith": { "MarkdownDocumentation": "`ReplaceWith`\n\nThis action specifies the replacement recipient email addresses to insert.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 1`\n*Maximum*: `254 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-replacerecipientaction.html#cfn-ses-mailmanagerruleset-replacerecipientaction-replacewith", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::SES::MailManagerRuleSet.Rule": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.Rule`\n\nA rule contains conditions, \"unless conditions\" and actions. For each\nenvelope recipient of an email, if all conditions match and none of the \"unless\nconditions\" match, then all of the actions are executed sequentially. If no\nconditions are provided, the rule always applies and the actions are implicitly\nexecuted. If only \"unless conditions\" are provided, the rule applies if the\nemail does not match the evaluation of the \"unless conditions\".\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rule.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe list of actions to execute when the conditions match the incoming email, and none\nof the \"unless conditions\" match.\n*Required*: Yes\n*Type*: Array of [RuleAction](./aws-properties-ses-mailmanagerruleset-ruleaction.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rule.html#cfn-ses-mailmanagerruleset-rule-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RuleAction", "DuplicatesAllowed": true }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe conditions of this rule. All conditions must match the email for the actions to be\nexecuted. An empty list of conditions means that all emails match, but are still subject\nto any \"unless conditions\"\n*Required*: No\n*Type*: Array of [RuleCondition](./aws-properties-ses-mailmanagerruleset-rulecondition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rule.html#cfn-ses-mailmanagerruleset-rule-conditions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RuleCondition", "DuplicatesAllowed": true }, "Unless": { "MarkdownDocumentation": "`Unless`\n\nThe \"unless conditions\" of this rule. None of the conditions can match the\nemail for the actions to be executed. If any of these conditions do match the email,\nthen the actions are not executed.\n*Required*: No\n*Type*: Array of [RuleCondition](./aws-properties-ses-mailmanagerruleset-rulecondition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rule.html#cfn-ses-mailmanagerruleset-rule-unless", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RuleCondition", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe user-friendly name of the rule.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rule.html#cfn-ses-mailmanagerruleset-rule-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.RuleAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleAction`\n\nThe action for a rule to take. Only one of the contained actions can be set.\n###### Important\nThis data type is a UNION, so only one of the following members can be specified\nwhen used or returned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html", "Properties": { "AddHeader": { "MarkdownDocumentation": "`AddHeader`\n\nThis action adds a header. This can be used to add arbitrary email headers.\n*Required*: No\n*Type*: [AddHeaderAction](./aws-properties-ses-mailmanagerruleset-addheaderaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-addheader", "UpdateType": "Mutable", "Required": false, "Type": "AddHeaderAction" }, "Relay": { "MarkdownDocumentation": "`Relay`\n\nThis action relays the email to another SMTP server.\n*Required*: No\n*Type*: [RelayAction](./aws-properties-ses-mailmanagerruleset-relayaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-relay", "UpdateType": "Mutable", "Required": false, "Type": "RelayAction" }, "DeliverToMailbox": { "MarkdownDocumentation": "`DeliverToMailbox`\n\nThis action delivers an email to a WorkMail mailbox.\n*Required*: No\n*Type*: [DeliverToMailboxAction](./aws-properties-ses-mailmanagerruleset-delivertomailboxaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-delivertomailbox", "UpdateType": "Mutable", "Required": false, "Type": "DeliverToMailboxAction" }, "Archive": { "MarkdownDocumentation": "`Archive`\n\nThis action archives the email. This can be used to deliver an email to an\narchive.\n*Required*: No\n*Type*: [ArchiveAction](./aws-properties-ses-mailmanagerruleset-archiveaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-archive", "UpdateType": "Mutable", "Required": false, "Type": "ArchiveAction" }, "ReplaceRecipient": { "MarkdownDocumentation": "`ReplaceRecipient`\n\nThe action replaces certain or all recipients with a different set of\nrecipients.\n*Required*: No\n*Type*: [ReplaceRecipientAction](./aws-properties-ses-mailmanagerruleset-replacerecipientaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-replacerecipient", "UpdateType": "Mutable", "Required": false, "Type": "ReplaceRecipientAction" }, "WriteToS3": { "MarkdownDocumentation": "`WriteToS3`\n\nThis action writes the MIME content of the email to an S3 bucket.\n*Required*: No\n*Type*: [S3Action](./aws-properties-ses-mailmanagerruleset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-writetos3", "UpdateType": "Mutable", "Required": false, "Type": "S3Action" }, "PublishToSns": { "MarkdownDocumentation": "`PublishToSns`\n\nThis action publishes the email content to an Amazon SNS topic.\n*Required*: No\n*Type*: [SnsAction](./aws-properties-ses-mailmanagerruleset-snsaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-publishtosns", "UpdateType": "Mutable", "Required": false, "Type": "SnsAction" }, "DeliverToQBusiness": { "MarkdownDocumentation": "`DeliverToQBusiness`\n\nThis action delivers an email to an Amazon Q Business application for ingestion into\nits knowledge base.\n*Required*: No\n*Type*: [DeliverToQBusinessAction](./aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-delivertoqbusiness", "UpdateType": "Mutable", "Required": false, "Type": "DeliverToQBusinessAction" }, "Drop": { "MarkdownDocumentation": "`Drop`\n\nThis action terminates the evaluation of rules in the rule set.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-drop", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Send": { "MarkdownDocumentation": "`Send`\n\nThis action sends the email to the internet.\n*Required*: No\n*Type*: [SendAction](./aws-properties-ses-mailmanagerruleset-sendaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-send", "UpdateType": "Mutable", "Required": false, "Type": "SendAction" } } }, "AWS::SES::MailManagerRuleSet.RuleBooleanExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleBooleanExpression`\n\nA boolean expression to be used in a rule condition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleanexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe matching operator for a boolean condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IS_TRUE | IS_FALSE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IS_TRUE", "IS_FALSE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleanexpression.html#cfn-ses-mailmanagerruleset-rulebooleanexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe operand on which to perform a boolean condition operation.\n*Required*: Yes\n*Type*: [RuleBooleanToEvaluate](./aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleanexpression.html#cfn-ses-mailmanagerruleset-rulebooleanexpression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "RuleBooleanToEvaluate" } } }, "AWS::SES::MailManagerRuleSet.RuleBooleanToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleBooleanToEvaluate`\n\nThe union type representing the allowed types of operands for a boolean\ncondition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.html", "Properties": { "IsInAddressList": { "MarkdownDocumentation": "`IsInAddressList`\n\nThe structure representing the address lists and address list attribute that will be used in evaluation of boolean expression.\n*Required*: No\n*Type*: [RuleIsInAddressList](./aws-properties-ses-mailmanagerruleset-ruleisinaddresslist.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.html#cfn-ses-mailmanagerruleset-rulebooleantoevaluate-isinaddresslist", "UpdateType": "Mutable", "Required": false, "Type": "RuleIsInAddressList" }, "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe boolean type representing the allowed attribute types for an email.\n*Required*: No\n*Type*: String\n*Allowed values*: `READ_RECEIPT_REQUESTED | TL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "READ_RECEIPT_REQUESTED", "TLS", "TLS_WRAPPED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.html#cfn-ses-mailmanagerruleset-rulebooleantoevaluate-attribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Analysis": { "MarkdownDocumentation": "`Analysis`\n\nThe Add On ARN and its returned value to evaluate in a boolean condition expression.\n*Required*: No\n*Type*: [Analysis](./aws-properties-ses-mailmanagerruleset-analysis.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.html#cfn-ses-mailmanagerruleset-rulebooleantoevaluate-analysis", "UpdateType": "Mutable", "Required": false, "Type": "Analysis" } } }, "AWS::SES::MailManagerRuleSet.RuleCondition": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleCondition`\n\nThe conditional expression used to evaluate an email for determining if a rule action\nshould be taken.\n###### Important\nThis data type is a UNION, so only one of the following members can be specified\nwhen used or returned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html", "Properties": { "BooleanExpression": { "MarkdownDocumentation": "`BooleanExpression`\n\nThe condition applies to a boolean expression passed in this field.\n*Required*: No\n*Type*: [RuleBooleanExpression](./aws-properties-ses-mailmanagerruleset-rulebooleanexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-booleanexpression", "UpdateType": "Mutable", "Required": false, "Type": "RuleBooleanExpression" }, "VerdictExpression": { "MarkdownDocumentation": "`VerdictExpression`\n\nThe condition applies to a verdict expression passed in this field.\n*Required*: No\n*Type*: [RuleVerdictExpression](./aws-properties-ses-mailmanagerruleset-ruleverdictexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-verdictexpression", "UpdateType": "Mutable", "Required": false, "Type": "RuleVerdictExpression" }, "StringExpression": { "MarkdownDocumentation": "`StringExpression`\n\nThe condition applies to a string expression passed in this field.\n*Required*: No\n*Type*: [RuleStringExpression](./aws-properties-ses-mailmanagerruleset-rulestringexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-stringexpression", "UpdateType": "Mutable", "Required": false, "Type": "RuleStringExpression" }, "DmarcExpression": { "MarkdownDocumentation": "`DmarcExpression`\n\nThe condition applies to a DMARC policy expression passed in this field.\n*Required*: No\n*Type*: [RuleDmarcExpression](./aws-properties-ses-mailmanagerruleset-ruledmarcexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-dmarcexpression", "UpdateType": "Mutable", "Required": false, "Type": "RuleDmarcExpression" }, "NumberExpression": { "MarkdownDocumentation": "`NumberExpression`\n\nThe condition applies to a number expression passed in this field.\n*Required*: No\n*Type*: [RuleNumberExpression](./aws-properties-ses-mailmanagerruleset-rulenumberexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-numberexpression", "UpdateType": "Mutable", "Required": false, "Type": "RuleNumberExpression" }, "IpExpression": { "MarkdownDocumentation": "`IpExpression`\n\nThe condition applies to an IP address expression passed in this field.\n*Required*: No\n*Type*: [RuleIpExpression](./aws-properties-ses-mailmanagerruleset-ruleipexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-ipexpression", "UpdateType": "Mutable", "Required": false, "Type": "RuleIpExpression" } } }, "AWS::SES::MailManagerRuleSet.RuleDmarcExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleDmarcExpression`\n\nA DMARC policy expression. The condition matches if the given DMARC policy matches\nthat of the incoming email.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruledmarcexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe operator to apply to the DMARC policy of the incoming email.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | NOT_EQUALS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "NOT_EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruledmarcexpression.html#cfn-ses-mailmanagerruleset-ruledmarcexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values to use for the given DMARC policy operator. For the operator EQUALS, if\nmultiple values are given, they are evaluated as an OR. That is, if any of the given\nvalues match, the condition is deemed to match. For the operator NOT\\_EQUALS, if multiple\nvalues are given, they are evaluated as an AND. That is, only if the email's DMARC\npolicy is not equal to any of the given values, then the condition is deemed to\nmatch.\n*Required*: Yes\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruledmarcexpression.html#cfn-ses-mailmanagerruleset-ruledmarcexpression-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SES::MailManagerRuleSet.RuleIpExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleIpExpression`\n\nAn IP address expression matching certain IP addresses within a given range of IP\naddresses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleipexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe operator to evaluate the IP address.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CIDR_MATCHES | NOT_CIDR_MAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIDR_MATCHES", "NOT_CIDR_MATCHES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleipexpression.html#cfn-ses-mailmanagerruleset-ruleipexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe IP address to evaluate in this condition.\n*Required*: Yes\n*Type*: [RuleIpToEvaluate](./aws-properties-ses-mailmanagerruleset-ruleiptoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleipexpression.html#cfn-ses-mailmanagerruleset-ruleipexpression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "RuleIpToEvaluate" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe IP CIDR blocks in format \"x.y.z.w/n\" (eg 10.0.0.0/8) to match with the\nemail's IP address. For the operator CIDR\\_MATCHES, if multiple values are given, they\nare evaluated as an OR. That is, if the IP address is contained within any of the given\nCIDR ranges, the condition is deemed to match. For NOT\\_CIDR\\_MATCHES, if multiple CIDR\nranges are given, the condition is deemed to match if the IP address is not contained in\nany of the given CIDR ranges.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `43 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleipexpression.html#cfn-ses-mailmanagerruleset-ruleipexpression-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SES::MailManagerRuleSet.RuleIpToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleIpToEvaluate`\n\nThe IP address to evaluate for this condition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleiptoevaluate.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe attribute of the email to evaluate.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SOURCE_IP`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "SOURCE_IP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleiptoevaluate.html#cfn-ses-mailmanagerruleset-ruleiptoevaluate-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.RuleIsInAddressList": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleIsInAddressList`\n\nThe structure type for a boolean condition that provides the address lists and address list attribute to evaluate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleisinaddresslist.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe email attribute that needs to be evaluated against the address list.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RECIPIENT | MAIL_FROM | SEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RECIPIENT", "MAIL_FROM", "SENDER", "FROM", "TO", "CC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleisinaddresslist.html#cfn-ses-mailmanagerruleset-ruleisinaddresslist-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AddressLists": { "MarkdownDocumentation": "`AddressLists`\n\nThe address lists that will be used for evaluation.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleisinaddresslist.html#cfn-ses-mailmanagerruleset-ruleisinaddresslist-addresslists", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::SES::MailManagerRuleSet.RuleNumberExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleNumberExpression`\n\nA number expression to match numeric conditions with integers from the incoming\nemail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumberexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe operator for a numeric condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | NOT_EQUALS | LESS_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "NOT_EQUALS", "LESS_THAN", "GREATER_THAN", "LESS_THAN_OR_EQUAL", "GREATER_THAN_OR_EQUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumberexpression.html#cfn-ses-mailmanagerruleset-rulenumberexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe number to evaluate in a numeric condition expression.\n*Required*: Yes\n*Type*: [RuleNumberToEvaluate](./aws-properties-ses-mailmanagerruleset-rulenumbertoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumberexpression.html#cfn-ses-mailmanagerruleset-rulenumberexpression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "RuleNumberToEvaluate" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value to evaluate in a numeric condition expression.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumberexpression.html#cfn-ses-mailmanagerruleset-rulenumberexpression-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::SES::MailManagerRuleSet.RuleNumberToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleNumberToEvaluate`\n\nThe number to evaluate in a numeric condition expression.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumbertoevaluate.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nAn email attribute that is used as the number to evaluate.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MESSAGE_SIZE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MESSAGE_SIZE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumbertoevaluate.html#cfn-ses-mailmanagerruleset-rulenumbertoevaluate-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.RuleStringExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleStringExpression`\n\nA string expression is evaluated against strings or substrings of the email.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe matching operator for a string condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | NOT_EQUALS | START...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "NOT_EQUALS", "STARTS_WITH", "ENDS_WITH", "CONTAINS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringexpression.html#cfn-ses-mailmanagerruleset-rulestringexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe string to evaluate in a string condition expression.\n*Required*: Yes\n*Type*: [RuleStringToEvaluate](./aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringexpression.html#cfn-ses-mailmanagerruleset-rulestringexpression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "RuleStringToEvaluate" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe string(s) to be evaluated in a string condition expression. For all operators,\nexcept for NOT\\_EQUALS, if multiple values are given, the values are processed as an OR.\nThat is, if any of the values match the email's string using the given operator, the\ncondition is deemed to match. However, for NOT\\_EQUALS, the condition is only deemed to\nmatch if none of the given strings match the email's string.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `4096 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringexpression.html#cfn-ses-mailmanagerruleset-rulestringexpression-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SES::MailManagerRuleSet.RuleStringToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleStringToEvaluate`\n\nThe string to evaluate in a string condition expression.\n###### Important\nThis data type is a UNION, so only one of the following members can be specified\nwhen used or returned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe email attribute to evaluate in a string condition expression.\n*Required*: No\n*Type*: String\n*Allowed values*: `MAIL_FROM | HELO | RECIPIEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MAIL_FROM", "HELO", "RECIPIENT", "SENDER", "FROM", "SUBJECT", "TO", "CC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.html#cfn-ses-mailmanagerruleset-rulestringtoevaluate-attribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MimeHeaderAttribute": { "MarkdownDocumentation": "`MimeHeaderAttribute`\n\nThe email MIME X-Header attribute to evaluate in a string condition expression.\n*Required*: No\n*Type*: String\n*Pattern*: `^X-[a-zA-Z0-9-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.html#cfn-ses-mailmanagerruleset-rulestringtoevaluate-mimeheaderattribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Analysis": { "MarkdownDocumentation": "`Analysis`\n\nThe Add On ARN and its returned value to evaluate in a string condition expression.\n*Required*: No\n*Type*: [Analysis](./aws-properties-ses-mailmanagerruleset-analysis.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.html#cfn-ses-mailmanagerruleset-rulestringtoevaluate-analysis", "UpdateType": "Mutable", "Required": false, "Type": "Analysis" } } }, "AWS::SES::MailManagerRuleSet.RuleVerdictExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleVerdictExpression`\n\nA verdict expression is evaluated against verdicts of the email.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdictexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe matching operator for a verdict condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | NOT_EQUALS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "NOT_EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdictexpression.html#cfn-ses-mailmanagerruleset-ruleverdictexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe verdict to evaluate in a verdict condition expression.\n*Required*: Yes\n*Type*: [RuleVerdictToEvaluate](./aws-properties-ses-mailmanagerruleset-ruleverdicttoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdictexpression.html#cfn-ses-mailmanagerruleset-ruleverdictexpression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "RuleVerdictToEvaluate" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe values to match with the email's verdict using the given operator. For the EQUALS\noperator, if multiple values are given, the condition is deemed to match if any of the\ngiven verdicts match that of the email. For the NOT\\_EQUALS operator, if multiple values\nare given, the condition is deemed to match of none of the given verdicts match the\nverdict of the email.\n*Required*: Yes\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdictexpression.html#cfn-ses-mailmanagerruleset-ruleverdictexpression-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SES::MailManagerRuleSet.RuleVerdictToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.RuleVerdictToEvaluate`\n\nThe verdict to evaluate in a verdict condition expression.\n###### Important\nThis data type is a UNION, so only one of the following members can be specified\nwhen used or returned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdicttoevaluate.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe email verdict attribute to evaluate in a string verdict expression.\n*Required*: No\n*Type*: String\n*Allowed values*: `SPF | DKIM`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "SPF", "DKIM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdicttoevaluate.html#cfn-ses-mailmanagerruleset-ruleverdicttoevaluate-attribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Analysis": { "MarkdownDocumentation": "`Analysis`\n\nThe Add On ARN and its returned value to evaluate in a verdict condition\nexpression.\n*Required*: No\n*Type*: [Analysis](./aws-properties-ses-mailmanagerruleset-analysis.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdicttoevaluate.html#cfn-ses-mailmanagerruleset-ruleverdicttoevaluate-analysis", "UpdateType": "Mutable", "Required": false, "Type": "Analysis" } } }, "AWS::SES::MailManagerRuleSet.S3Action": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.S3Action`\n\nWrites the MIME content of the email to an S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html", "Properties": { "S3SseKmsKeyId": { "MarkdownDocumentation": "`S3SseKmsKeyId`\n\nThe KMS Key ID to use to encrypt the message in S3.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-:/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-s3ssekmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nThe bucket name of the S3 bucket to write to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9.-]+$`\n*Minimum*: `1`\n*Maximum*: `62`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-s3bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3Prefix": { "MarkdownDocumentation": "`S3Prefix`\n\nThe S3 prefix to use for the write to the s3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9!_.*'()/-]+$`\n*Minimum*: `1`\n*Maximum*: `62`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-s3prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ActionFailurePolicy": { "MarkdownDocumentation": "`ActionFailurePolicy`\n\nA policy that states what to do in the case of failure. The action will fail if there\nare configuration errors. For example, the specified the bucket has been deleted.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-actionfailurepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to\nthe s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:_/+=,@.#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.SendAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.SendAction`\n\nSends the email to the internet using the ses:SendRawEmail API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-sendaction.html", "Properties": { "ActionFailurePolicy": { "MarkdownDocumentation": "`ActionFailurePolicy`\n\nA policy that states what to do in the case of failure. The action will fail if there\nare configuration errors. For example, the caller does not have the permissions to call\nthe sendRawEmail API.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-sendaction.html#cfn-ses-mailmanagerruleset-sendaction-actionfailurepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the\nses:SendRawEmail API.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:_/+=,@.#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-sendaction.html#cfn-ses-mailmanagerruleset-sendaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerRuleSet.SnsAction": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet.SnsAction`\n\nThe action to publish the email content to an Amazon SNS topic. When executed, this action\nwill send the email as a notification to the specified SNS topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html", "Properties": { "TopicArn": { "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov):sns:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:[\\w\\-]{1,256}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-topicarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Encoding": { "MarkdownDocumentation": "`Encoding`\n\nThe encoding to use for the email within the Amazon SNS notification. The default value is `UTF-8`.\nUse `BASE64` if you need to preserve all special characters, especially when the original message uses\na different encoding format.\n*Required*: No\n*Type*: String\n*Allowed values*: `UTF-8 | BASE64...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UTF-8", "BASE64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-encoding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ActionFailurePolicy": { "MarkdownDocumentation": "`ActionFailurePolicy`\n\nA policy that states what to do in the case of failure. The action will fail if there are configuration errors.\nFor example, specified SNS topic has been deleted or the role lacks necessary permissions to call the `sns:Publish` API.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-actionfailurepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to\nthe `sns:Publish` API for the given topic.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:_/+=,@.#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PayloadType": { "MarkdownDocumentation": "`PayloadType`\n\nThe expected payload type within the Amazon SNS notification. `CONTENT` attempts to publish the full email\ncontent with 20KB of headers content. `HEADERS` extracts up to 100KB of header content to include in the notification,\nemail content will not be included to the notification. The default value is `CONTENT`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CONTENT | HEADERS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONTENT", "HEADERS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-payloadtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerTrafficPolicy.IngressAnalysis": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressAnalysis`\n\nThe Add On ARN and its returned value that is evaluated in a policy statement's\nconditional expression to either deny or block the incoming email.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressanalysis.html", "Properties": { "Analyzer": { "MarkdownDocumentation": "`Analyzer`\n\nThe Amazon Resource Name (ARN) of an Add On.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressanalysis.html#cfn-ses-mailmanagertrafficpolicy-ingressanalysis-analyzer", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResultField": { "MarkdownDocumentation": "`ResultField`\n\nThe returned value from an Add On.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(addon\\.)?[\\sa-zA-Z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressanalysis.html#cfn-ses-mailmanagertrafficpolicy-ingressanalysis-resultfield", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerTrafficPolicy.IngressBooleanExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressBooleanExpression`\n\nThe structure for a boolean condition matching on the incoming mail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressbooleanexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe matching operator for a boolean condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IS_TRUE | IS_FALSE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IS_TRUE", "IS_FALSE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressbooleanexpression.html#cfn-ses-mailmanagertrafficpolicy-ingressbooleanexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe operand on which to perform a boolean condition operation.\n*Required*: Yes\n*Type*: [IngressBooleanToEvaluate](./aws-properties-ses-mailmanagertrafficpolicy-ingressbooleantoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressbooleanexpression.html#cfn-ses-mailmanagertrafficpolicy-ingressbooleanexpression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "IngressBooleanToEvaluate" } } }, "AWS::SES::MailManagerTrafficPolicy.IngressBooleanToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressBooleanToEvaluate`\n\nThe union type representing the allowed types of operands for a boolean\ncondition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressbooleantoevaluate.html", "Properties": { "IsInAddressList": { "MarkdownDocumentation": "`IsInAddressList`\n\nThe structure type for a boolean condition that provides the address lists to evaluate incoming traffic on.\n*Required*: No\n*Type*: [IngressIsInAddressList](./aws-properties-ses-mailmanagertrafficpolicy-ingressisinaddresslist.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressbooleantoevaluate.html#cfn-ses-mailmanagertrafficpolicy-ingressbooleantoevaluate-isinaddresslist", "UpdateType": "Mutable", "Required": false, "Type": "IngressIsInAddressList" }, "Analysis": { "MarkdownDocumentation": "`Analysis`\n\nThe structure type for a boolean condition stating the Add On ARN and its returned\nvalue.\n*Required*: No\n*Type*: [IngressAnalysis](./aws-properties-ses-mailmanagertrafficpolicy-ingressanalysis.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressbooleantoevaluate.html#cfn-ses-mailmanagertrafficpolicy-ingressbooleantoevaluate-analysis", "UpdateType": "Mutable", "Required": false, "Type": "IngressAnalysis" } } }, "AWS::SES::MailManagerTrafficPolicy.IngressIpToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressIpToEvaluate`\n\nThe structure for an IP based condition matching on the incoming mail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressiptoevaluate.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nAn enum type representing the allowed attribute types for an IP condition.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SENDER_IP`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "SENDER_IP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressiptoevaluate.html#cfn-ses-mailmanagertrafficpolicy-ingressiptoevaluate-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerTrafficPolicy.IngressIpv4Expression": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressIpv4Expression`\n\nThe union type representing the allowed types for the left hand side of an IP\ncondition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv4expression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe matching operator for an IP condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CIDR_MATCHES | NOT_CIDR_MAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIDR_MATCHES", "NOT_CIDR_MATCHES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv4expression.html#cfn-ses-mailmanagertrafficpolicy-ingressipv4expression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe left hand side argument of an IP condition expression.\n*Required*: Yes\n*Type*: [IngressIpToEvaluate](./aws-properties-ses-mailmanagertrafficpolicy-ingressiptoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv4expression.html#cfn-ses-mailmanagertrafficpolicy-ingressipv4expression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "IngressIpToEvaluate" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe right hand side argument of an IP condition expression.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv4expression.html#cfn-ses-mailmanagertrafficpolicy-ingressipv4expression-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SES::MailManagerTrafficPolicy.IngressIpv6Expression": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressIpv6Expression`\n\nThe union type representing the allowed types for the left hand side of an IPv6 condition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv6expression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe matching operator for an IPv6 condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CIDR_MATCHES | NOT_CIDR_MAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CIDR_MATCHES", "NOT_CIDR_MATCHES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv6expression.html#cfn-ses-mailmanagertrafficpolicy-ingressipv6expression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe left hand side argument of an IPv6 condition expression.\n*Required*: Yes\n*Type*: [IngressIpv6ToEvaluate](./aws-properties-ses-mailmanagertrafficpolicy-ingressipv6toevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv6expression.html#cfn-ses-mailmanagertrafficpolicy-ingressipv6expression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "IngressIpv6ToEvaluate" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe right hand side argument of an IPv6 condition expression.\n*Required*: Yes\n*Type*: Array of String\n*Maximum*: `49`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv6expression.html#cfn-ses-mailmanagertrafficpolicy-ingressipv6expression-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SES::MailManagerTrafficPolicy.IngressIpv6ToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressIpv6ToEvaluate`\n\nThe structure for an IPv6 based condition matching on the incoming mail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv6toevaluate.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nAn enum type representing the allowed attribute types for an IPv6 condition.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SENDER_IPV6...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SENDER_IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressipv6toevaluate.html#cfn-ses-mailmanagertrafficpolicy-ingressipv6toevaluate-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerTrafficPolicy.IngressIsInAddressList": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressIsInAddressList`\n\nThe address lists and the address list attribute value that is evaluated in a policy statement's\nconditional expression to either deny or block the incoming email.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressisinaddresslist.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe email attribute that needs to be evaluated against the address list.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RECIPIENT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "RECIPIENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressisinaddresslist.html#cfn-ses-mailmanagertrafficpolicy-ingressisinaddresslist-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AddressLists": { "MarkdownDocumentation": "`AddressLists`\n\nThe address lists that will be used for evaluation.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressisinaddresslist.html#cfn-ses-mailmanagertrafficpolicy-ingressisinaddresslist-addresslists", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::SES::MailManagerTrafficPolicy.IngressStringExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressStringExpression`\n\nThe structure for a string based condition matching on the incoming mail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressstringexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | NOT_EQUALS | START...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "NOT_EQUALS", "STARTS_WITH", "ENDS_WITH", "CONTAINS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressstringexpression.html#cfn-ses-mailmanagertrafficpolicy-ingressstringexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe left hand side argument of a string condition expression.\n*Required*: Yes\n*Type*: [IngressStringToEvaluate](./aws-properties-ses-mailmanagertrafficpolicy-ingressstringtoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressstringexpression.html#cfn-ses-mailmanagertrafficpolicy-ingressstringexpression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "IngressStringToEvaluate" }, "Values": { "MarkdownDocumentation": "`Values`\n\nThe right hand side argument of a string condition expression.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressstringexpression.html#cfn-ses-mailmanagertrafficpolicy-ingressstringexpression-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SES::MailManagerTrafficPolicy.IngressStringToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressStringToEvaluate`\n\nThe union type representing the allowed types for the left hand side of a string\ncondition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressstringtoevaluate.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe enum type representing the allowed attribute types for a string condition.\n*Required*: No\n*Type*: String\n*Allowed values*: `RECIPIENT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "RECIPIENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressstringtoevaluate.html#cfn-ses-mailmanagertrafficpolicy-ingressstringtoevaluate-attribute", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Analysis": { "MarkdownDocumentation": "`Analysis`\n\nThe structure type for a string condition stating the Add On ARN and its returned value.\n*Required*: No\n*Type*: [IngressAnalysis](./aws-properties-ses-mailmanagertrafficpolicy-ingressanalysis.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingressstringtoevaluate.html#cfn-ses-mailmanagertrafficpolicy-ingressstringtoevaluate-analysis", "UpdateType": "Mutable", "Required": false, "Type": "IngressAnalysis" } } }, "AWS::SES::MailManagerTrafficPolicy.IngressTlsProtocolExpression": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressTlsProtocolExpression`\n\nThe structure for a TLS related condition matching on the incoming mail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingresstlsprotocolexpression.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe matching operator for a TLS condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MINIMUM_TLS_VERSION | IS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MINIMUM_TLS_VERSION", "IS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingresstlsprotocolexpression.html#cfn-ses-mailmanagertrafficpolicy-ingresstlsprotocolexpression-operator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Evaluate": { "MarkdownDocumentation": "`Evaluate`\n\nThe left hand side argument of a TLS condition expression.\n*Required*: Yes\n*Type*: [IngressTlsProtocolToEvaluate](./aws-properties-ses-mailmanagertrafficpolicy-ingresstlsprotocoltoevaluate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingresstlsprotocolexpression.html#cfn-ses-mailmanagertrafficpolicy-ingresstlsprotocolexpression-evaluate", "UpdateType": "Mutable", "Required": true, "Type": "IngressTlsProtocolToEvaluate" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe right hand side argument of a TLS condition expression.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TLS1_2 | TLS1_3...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TLS1_2", "TLS1_3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingresstlsprotocolexpression.html#cfn-ses-mailmanagertrafficpolicy-ingresstlsprotocolexpression-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerTrafficPolicy.IngressTlsProtocolToEvaluate": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.IngressTlsProtocolToEvaluate`\n\nThe union type representing the allowed types for the left hand side of a TLS\ncondition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingresstlsprotocoltoevaluate.html", "Properties": { "Attribute": { "MarkdownDocumentation": "`Attribute`\n\nThe enum type representing the allowed attribute types for the TLS condition.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TLS_PROTOCOL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TLS_PROTOCOL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-ingresstlsprotocoltoevaluate.html#cfn-ses-mailmanagertrafficpolicy-ingresstlsprotocoltoevaluate-attribute", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::MailManagerTrafficPolicy.PolicyCondition": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.PolicyCondition`\n\nThe email traffic filtering conditions which are contained in a traffic policy\nresource.\n###### Important\nThis data type is a UNION, so only one of the following members can be specified\nwhen used or returned.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policycondition.html", "Properties": { "Ipv6Expression": { "MarkdownDocumentation": "`Ipv6Expression`\n\nThis represents an IPv6 based condition matching on the incoming mail. It performs the\noperation configured in 'Operator' and evaluates the 'Protocol' object against the\n'Value'.\n*Required*: No\n*Type*: [IngressIpv6Expression](./aws-properties-ses-mailmanagertrafficpolicy-ingressipv6expression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policycondition.html#cfn-ses-mailmanagertrafficpolicy-policycondition-ipv6expression", "UpdateType": "Mutable", "Required": false, "Type": "IngressIpv6Expression" }, "BooleanExpression": { "MarkdownDocumentation": "`BooleanExpression`\n\nThis represents a boolean type condition matching on the incoming mail. It performs\nthe boolean operation configured in 'Operator' and evaluates the 'Protocol' object\nagainst the 'Value'.\n*Required*: No\n*Type*: [IngressBooleanExpression](./aws-properties-ses-mailmanagertrafficpolicy-ingressbooleanexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policycondition.html#cfn-ses-mailmanagertrafficpolicy-policycondition-booleanexpression", "UpdateType": "Mutable", "Required": false, "Type": "IngressBooleanExpression" }, "StringExpression": { "MarkdownDocumentation": "`StringExpression`\n\nThis represents a string based condition matching on the incoming mail. It performs\nthe string operation configured in 'Operator' and evaluates the 'Protocol' object\nagainst the 'Value'.\n*Required*: No\n*Type*: [IngressStringExpression](./aws-properties-ses-mailmanagertrafficpolicy-ingressstringexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policycondition.html#cfn-ses-mailmanagertrafficpolicy-policycondition-stringexpression", "UpdateType": "Mutable", "Required": false, "Type": "IngressStringExpression" }, "TlsExpression": { "MarkdownDocumentation": "`TlsExpression`\n\nThis represents a TLS based condition matching on the incoming mail. It performs the\noperation configured in 'Operator' and evaluates the 'Protocol' object against the\n'Value'.\n*Required*: No\n*Type*: [IngressTlsProtocolExpression](./aws-properties-ses-mailmanagertrafficpolicy-ingresstlsprotocolexpression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policycondition.html#cfn-ses-mailmanagertrafficpolicy-policycondition-tlsexpression", "UpdateType": "Mutable", "Required": false, "Type": "IngressTlsProtocolExpression" }, "IpExpression": { "MarkdownDocumentation": "`IpExpression`\n\nThis represents an IP based condition matching on the incoming mail. It performs the\noperation configured in 'Operator' and evaluates the 'Protocol' object against the\n'Value'.\n*Required*: No\n*Type*: [IngressIpv4Expression](./aws-properties-ses-mailmanagertrafficpolicy-ingressipv4expression.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policycondition.html#cfn-ses-mailmanagertrafficpolicy-policycondition-ipexpression", "UpdateType": "Mutable", "Required": false, "Type": "IngressIpv4Expression" } } }, "AWS::SES::MailManagerTrafficPolicy.PolicyStatement": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy.PolicyStatement`\n\nThe structure containing traffic policy conditions and actions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policystatement.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that informs a traffic policy resource to either allow or block the email\nif it matches a condition in the policy statement.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALLOW | DENY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policystatement.html#cfn-ses-mailmanagertrafficpolicy-policystatement-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe list of conditions to apply to incoming messages for filtering email\ntraffic.\n*Required*: Yes\n*Type*: Array of [PolicyCondition](./aws-properties-ses-mailmanagertrafficpolicy-policycondition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagertrafficpolicy-policystatement.html#cfn-ses-mailmanagertrafficpolicy-policystatement-conditions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PolicyCondition", "DuplicatesAllowed": true } } }, "AWS::SES::MultiRegionEndpoint.Details": { "MarkdownDocumentation": "`AWS::SES::MultiRegionEndpoint.Details`\n\nAn object that contains configuration details of multi-region endpoint (global-endpoint).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-multiregionendpoint-details.html", "Properties": { "RouteDetails": { "MarkdownDocumentation": "`RouteDetails`\n\nA list of route configuration details. Must contain exactly one route configuration.\n*Required*: Yes\n*Type*: Array of [RouteDetailsItems](./aws-properties-ses-multiregionendpoint-routedetailsitems.html)\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-multiregionendpoint-details.html#cfn-ses-multiregionendpoint-details-routedetails", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "RouteDetailsItems", "DuplicatesAllowed": false } } }, "AWS::SES::MultiRegionEndpoint.RouteDetailsItems": { "MarkdownDocumentation": "`AWS::SES::MultiRegionEndpoint.RouteDetailsItems`\n\nAn object that contains route configuration. Includes secondary region name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-multiregionendpoint-routedetailsitems.html", "Properties": { "Region": { "MarkdownDocumentation": "`Region`\n\nThe name of an AWS-Region to be a secondary region for the multi-region endpoint (global-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-multiregionendpoint-routedetailsitems.html#cfn-ses-multiregionendpoint-routedetailsitems-region", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::ReceiptFilter.Filter": { "MarkdownDocumentation": "`AWS::SES::ReceiptFilter.Filter`\n\nSpecifies an IP address filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html", "Properties": { "IpFilter": { "Type": "IpFilter", "Required": true, "MarkdownDocumentation": "`IpFilter`\n\nA structure that provides the IP addresses to block or allow, and whether to block or\nallow incoming mail from them.\n*Required*: Yes\n*Type*: [IpFilter](./aws-properties-ses-receiptfilter-ipfilter.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html#cfn-ses-receiptfilter-filter-ipfilter", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the IP address filter. The name must meet the following\nrequirements:\n* Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (\\_), or\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html#cfn-ses-receiptfilter-filter-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptFilter.IpFilter": { "MarkdownDocumentation": "`AWS::SES::ReceiptFilter.IpFilter`\n\nA receipt IP address filter enables you to specify whether to accept or reject mail\noriginating from an IP address or range of IP addresses.\nFor information about setting up IP address filters, see the [Amazon SES\nDeveloper Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html", "Properties": { "Policy": { "Required": true, "MarkdownDocumentation": "`Policy`\n\nIndicates whether to block or allow incoming mail from the specified IP\naddresses.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Block | Allow...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Block", "Allow" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html#cfn-ses-receiptfilter-ipfilter-policy", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Cidr": { "Required": true, "MarkdownDocumentation": "`Cidr`\n\nA single IP address or a range of IP addresses to block or allow, specified in\nClassless Inter-Domain Routing (CIDR) notation. An example of a single email address is\n10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information\nabout CIDR notation, see [RFC\n2317](https://tools.ietf.org/html/rfc2317).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html#cfn-ses-receiptfilter-ipfilter-cidr", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.Action": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.Action`\n\nAn action that Amazon SES can take when it receives an email on behalf of one or more email\naddresses or domains that you own. An instance of this data type can represent only one\naction.\nFor information about setting up receipt rules, see the [Amazon SES\nDeveloper Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html", "Properties": { "ConnectAction": { "Type": "ConnectAction", "Required": false, "MarkdownDocumentation": "`ConnectAction`\n\nThe action that informs a traffic policy resource to either allow or block the email\nif it matches a condition in the policy statement.\n*Required*: No\n*Type*: [ConnectAction](./aws-properties-ses-receiptrule-connectaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-connectaction", "UpdateType": "Mutable" }, "BounceAction": { "Type": "BounceAction", "Required": false, "MarkdownDocumentation": "`BounceAction`\n\nRejects the received email by returning a bounce response to the sender and,\noptionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).\n*Required*: No\n*Type*: [BounceAction](./aws-properties-ses-receiptrule-bounceaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-bounceaction", "UpdateType": "Mutable" }, "S3Action": { "Type": "S3Action", "Required": false, "MarkdownDocumentation": "`S3Action`\n\nSaves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a\nnotification to Amazon SNS.\n*Required*: No\n*Type*: [S3Action](./aws-properties-ses-receiptrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-s3action", "UpdateType": "Mutable" }, "StopAction": { "Type": "StopAction", "Required": false, "MarkdownDocumentation": "`StopAction`\n\nTerminates the evaluation of the receipt rule set and optionally publishes a\nnotification to Amazon SNS.\n*Required*: No\n*Type*: [StopAction](./aws-properties-ses-receiptrule-stopaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-stopaction", "UpdateType": "Mutable" }, "SNSAction": { "Type": "SNSAction", "Required": false, "MarkdownDocumentation": "`SNSAction`\n\nPublishes the email content within a notification to Amazon SNS.\n*Required*: No\n*Type*: [SNSAction](./aws-properties-ses-receiptrule-snsaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-snsaction", "UpdateType": "Mutable" }, "WorkmailAction": { "Type": "WorkmailAction", "Required": false, "MarkdownDocumentation": "`WorkmailAction`\n\nCalls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.\n*Required*: No\n*Type*: [WorkmailAction](./aws-properties-ses-receiptrule-workmailaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-workmailaction", "UpdateType": "Mutable" }, "AddHeaderAction": { "Type": "AddHeaderAction", "Required": false, "MarkdownDocumentation": "`AddHeaderAction`\n\nAdds a header to the received email.\n*Required*: No\n*Type*: [AddHeaderAction](./aws-properties-ses-receiptrule-addheaderaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-addheaderaction", "UpdateType": "Mutable" }, "LambdaAction": { "Type": "LambdaAction", "Required": false, "MarkdownDocumentation": "`LambdaAction`\n\nCalls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.\n*Required*: No\n*Type*: [LambdaAction](./aws-properties-ses-receiptrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-lambdaaction", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.AddHeaderAction": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.AddHeaderAction`\n\nWhen included in a receipt rule, this action adds a header to the received\nemail.\nFor information about adding a header using a receipt rule, see the [Amazon\nSES Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html", "Properties": { "HeaderValue": { "Required": true, "MarkdownDocumentation": "`HeaderValue`\n\nThe content to include in the header. This value can contain up to 2048 characters. It\ncan't contain newline (`\\n`) or carriage return (`\\r`)\ncharacters.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headervalue", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HeaderName": { "Required": true, "MarkdownDocumentation": "`HeaderName`\n\nThe name of the header to add to the incoming message. The name must contain at least\none character, and can contain up to 50 characters. It consists of alphanumeric\n(`a\u2013z, A\u2013Z, 0\u20139`) characters and dashes.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headername", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.BounceAction": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.BounceAction`\n\nWhen included in a receipt rule, this action rejects the received email by returning a\nbounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service\n(Amazon SNS).\nFor information about sending a bounce message in response to a received email, see\nthe [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-bounce.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html", "Properties": { "Sender": { "Required": true, "MarkdownDocumentation": "`Sender`\n\nThe email address of the sender of the bounced email. This is the address from which\nthe bounce message is sent.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-sender", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SmtpReplyCode": { "Required": true, "MarkdownDocumentation": "`SmtpReplyCode`\n\nThe SMTP reply code, as defined by [RFC 5321](https://tools.ietf.org/html/rfc5321).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-smtpreplycode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Message": { "Required": true, "MarkdownDocumentation": "`Message`\n\nHuman-readable text to include in the bounce 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-message", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TopicArn": { "Required": false, "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is\ntaken. You can find the ARN of a topic by using the [ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) operation in\nAmazon SNS.\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*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-topicarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StatusCode": { "Required": false, "MarkdownDocumentation": "`StatusCode`\n\nThe SMTP enhanced status code, as defined by [RFC 3463](https://tools.ietf.org/html/rfc3463).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-statuscode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.ConnectAction": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.ConnectAction`\n\nWhen included in a receipt rule, this action parses the received message and\nstarts an email contact in Amazon Connect on your behalf.\n###### Note\nWhen you receive emails, the maximum email size (including headers) is 40 MB.\nAdditionally, emails may only have up to 10 attachments.\nEmails larger than 40 MB or with more than 10 attachments will be bounced.\nWe recommend that you configure this action via Amazon Connect.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-connectaction.html", "Properties": { "InstanceARN": { "Required": true, "MarkdownDocumentation": "`InstanceARN`\n\nThe Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting\nemail contacts.\nFor more information about Amazon Connect instances, see the [Amazon Connect Administrator Guide](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html)\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-connectaction.html#cfn-ses-receiptrule-connectaction-instancearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IAMRoleARN": { "Required": true, "MarkdownDocumentation": "`IAMRoleARN`\n\nThe Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts\nto the Amazon Connect instance. This role should have permission to invoke `connect:StartEmailContact`\nfor the given Amazon Connect instance.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:[\\w-]+:iam::[0-9]+:role/[\\w-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-connectaction.html#cfn-ses-receiptrule-connectaction-iamrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.LambdaAction": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.LambdaAction`\n\nWhen included in a receipt rule, this action calls an AWS Lambda function and,\noptionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).\nTo enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of\nanother account, Amazon SES must have permission to access those resources. For information\nabout giving permissions, see the [Amazon SES Developer\nGuide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html).\nFor information about using AWS Lambda actions in receipt rules, see the [Amazon SES\nDeveloper Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html", "Properties": { "FunctionArn": { "Required": true, "MarkdownDocumentation": "`FunctionArn`\n\nThe Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda\nfunction ARN is `arn:aws:lambda:us-west-2:account-id:function:MyFunction`.\nFor more information about AWS Lambda, see the [AWS Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/welcome.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-functionarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TopicArn": { "Required": false, "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is\nexecuted. You can find the ARN of a topic by using the [ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) operation in\nAmazon SNS.\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*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-topicarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InvocationType": { "Required": false, "MarkdownDocumentation": "`InvocationType`\n\nThe invocation type of the AWS Lambda function. An invocation type of\n`RequestResponse` means that the execution of the function immediately\nresults in a response, and a value of `Event` means that the function is\ninvoked asynchronously. The default value is `Event`. For information about\nAWS Lambda invocation types, see the [AWS Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html).\n###### Important\nThere is a 30-second timeout on `RequestResponse` invocations. You\nshould use `Event` invocation in most cases. Use\n`RequestResponse` only to make a mail flow decision, such as whether\nto stop the receipt rule or the receipt rule set.\n*Required*: No\n*Type*: String\n*Allowed values*: `Event | RequestResponse...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Event", "RequestResponse" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-invocationtype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.Rule": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.Rule`\n\nReceipt rules enable you to specify which actions Amazon SES should take when it receives\nmail on behalf of one or more email addresses or domains that you own.\nEach receipt rule defines a set of email addresses or domains that it applies to. If\nthe email addresses or domains match at least one recipient address of the message,\nAmazon SES executes all of the receipt rule's actions on the message.\nFor information about setting up receipt rules, see the [Amazon SES\nDeveloper Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html", "Properties": { "ScanEnabled": { "Required": false, "MarkdownDocumentation": "`ScanEnabled`\n\nIf `true`, then messages that this receipt rule applies to are scanned for\nspam 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-scanenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Recipients": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Recipients`\n\nThe recipient domains and email addresses that the receipt rule applies to. If this\nfield is not specified, this rule matches all recipients on all verified domains.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-recipients", "UpdateType": "Mutable" }, "Actions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Actions`\n\nAn ordered list of actions to perform on messages that match at least one of the\nrecipient email addresses or domains specified in the receipt rule.\n*Required*: No\n*Type*: Array of [Action](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-actions", "ItemType": "Action", "UpdateType": "Mutable" }, "Enabled": { "Required": false, "MarkdownDocumentation": "`Enabled`\n\nIf `true`, the receipt rule is active. The default value is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe 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\n (-), 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-name", "PrimitiveType": "String", "UpdateType": "Immutable" }, "TlsPolicy": { "Required": false, "MarkdownDocumentation": "`TlsPolicy`\n\nSpecifies whether Amazon SES should require that incoming email is delivered over a\nconnection encrypted with Transport Layer Security (TLS). If this parameter is set to\n`Require`, Amazon SES bounces emails that are not received over TLS. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-tlspolicy", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.S3Action": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.S3Action`\n\nWhen included in a receipt rule, this action saves the received message to an Amazon\nSimple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to\nAmazon Simple Notification Service (Amazon SNS).\nTo enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account,\nAmazon SES must have permission to access those resources. For information about\ngranting permissions, see the [Amazon SES Developer\nGuide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html).\n###### Note\nWhen you save your emails to an Amazon S3 bucket, the maximum email size\n(including headers) is 30 MB. Emails larger than that bounces.\nFor information about specifying Amazon S3 actions in receipt rules, see the [Amazon SES\nDeveloper Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html", "Properties": { "BucketName": { "Required": true, "MarkdownDocumentation": "`BucketName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-bucketname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KmsKeyArn": { "Required": false, "MarkdownDocumentation": "`KmsKeyArn`\n\nThe customer managed key that Amazon SES should use to encrypt your emails before saving\nthem to the Amazon S3 bucket. You can use the AWS managed key or a customer managed key\nthat you created in AWS KMS as follows:\n* To use the AWS managed key, provide an ARN in the form of\n `arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses`.\n For example, if your AWS account ID is 123456789012 and you want to use the\n AWS managed key in the US West (Oregon) Region, the ARN of the AWS managed\n key would be `arn:aws:kms:us-west-2:123456789012:alias/aws/ses`. If\n you use the AWS managed key, you don't need to perform any extra steps to give\n Amazon SES permission to use the key.\n* To use a customer managed key that you created in AWS KMS, provide the ARN\n of the customer managed key and ensure that you add a statement to your key's\n policy to give Amazon SES permission to use it. For more information about giving\n permissions, see the [Amazon SES Developer\n Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html).\nFor more information about key policies, see the [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html). If\nyou do not specify an AWS KMS key, Amazon SES does not encrypt your emails.\n###### Important\nYour mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail\nis submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side\nencryption. This means that you must use the Amazon S3 encryption client to decrypt the\nemail after retrieving it from Amazon S3, as the service has no access to use your\nAWS KMS keys for decryption. This encryption client is currently available with\nthe [AWS SDK for Java](https://aws.amazon.com/sdk-for-java/) and\n[AWS SDK for Ruby](https://aws.amazon.com/sdk-for-ruby/) only. For\nmore information about client-side encryption using AWS KMS managed keys, see the\n[Amazon S3 Developer Guide](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-kmskeyarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TopicArn": { "Required": false, "MarkdownDocumentation": "`TopicArn`\n\nThe ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You\ncan find the ARN of a topic by using the [ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) operation in\nAmazon SNS.\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*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-topicarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ObjectKeyPrefix": { "Required": false, "MarkdownDocumentation": "`ObjectKeyPrefix`\n\nThe key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that\nenables you to store similar data under the same directory in a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-objectkeyprefix", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IamRoleArn": { "Required": false, "MarkdownDocumentation": "`IamRoleArn`\n\nThe ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket,\noptionally encrypting your mail via the provided customer managed key, and publishing to\nthe Amazon SNS topic. This role should have access to the following APIs:\n* `s3:PutObject`, `kms:Encrypt` and\n `kms:GenerateDataKey` for the given Amazon S3 bucket.\n* `kms:GenerateDataKey` for the given AWS KMS customer managed key.\n* `sns:Publish` for the given Amazon SNS topic.\n###### Note\nIf an IAM role ARN is provided, the role (and only the role) is used to access all\nthe given resources (Amazon S3 bucket, AWS KMS customer managed key and Amazon SNS topic).\nTherefore, setting up individual resource access permissions is not required.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w-]+:iam::[0-9]+:role/[\\w-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-iamrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.SNSAction": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.SNSAction`\n\nThe action to publish the email content to an Amazon SNS topic. When executed, this action\nwill send the email as a notification to the specified SNS topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html", "Properties": { "TopicArn": { "Required": false, "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-topicarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Encoding": { "Required": false, "MarkdownDocumentation": "`Encoding`\n\nThe encoding to use for the email within the Amazon SNS notification. The default value is `UTF-8`.\nUse `BASE64` if you need to preserve all special characters, especially when the original message uses\na different encoding format.\n*Required*: No\n*Type*: String\n*Allowed values*: `UTF-8 | Base64...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UTF-8", "Base64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-encoding", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.StopAction": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.StopAction`\n\nWhen included in a receipt rule, this action terminates the evaluation of the receipt\nrule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).\nFor information about setting a stop action in a receipt rule, see the [Amazon SES\nDeveloper Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-stop.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html", "Properties": { "Scope": { "Required": true, "MarkdownDocumentation": "`Scope`\n\nThe scope of the StopAction. The only acceptable value is `RuleSet`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RuleSet`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "RuleSet" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-scope", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TopicArn": { "Required": false, "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is\ntaken. 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*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-topicarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::ReceiptRule.WorkmailAction": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule.WorkmailAction`\n\nWhen included in a receipt rule, this action calls Amazon WorkMail and, optionally,\npublishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up\nmanually, because Amazon WorkMail adds the rule automatically during its setup\nprocedure.\nFor information using a receipt rule to call Amazon WorkMail, see the [Amazon SES\nDeveloper Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html", "Properties": { "TopicArn": { "Required": false, "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action\nis called. You can find the ARN of a topic by using the [ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) operation in\nAmazon SNS.\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*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-topicarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OrganizationArn": { "Required": true, "MarkdownDocumentation": "`OrganizationArn`\n\nThe Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail\nARNs use the following format:\n`arn:aws:workmail:::organization/`\nYou can find the ID of your organization by using the [ListOrganizations](https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListOrganizations.html) operation in Amazon WorkMail. Amazon WorkMail\norganization IDs begin with \"`m-`\", followed by a string of alphanumeric\ncharacters.\nFor information about Amazon WorkMail organizations, see the [Amazon WorkMail Administrator Guide](https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-organizationarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SES::Template.Template": { "MarkdownDocumentation": "`AWS::SES::Template.Template`\n\nAn object that defines the email template to use for an email message, and the values\nto use for any message variables in that template. An *email\ntemplate* is a type of message template that contains content that you\nwant to reuse in email messages that you send. You can specifiy the email template by providing\nthe name or ARN of an *email template*\npreviously saved in your Amazon SES account or by providing the full template content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html", "Properties": { "HtmlPart": { "MarkdownDocumentation": "`HtmlPart`\n\nThe HTML 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-htmlpart", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TextPart": { "MarkdownDocumentation": "`TextPart`\n\nThe email body that is visible to recipients whose email clients do not display HTML\ncontent.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-textpart", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TemplateName": { "MarkdownDocumentation": "`TemplateName`\n\nThe name of the template. You will refer to this name when you send email using the\n`SendEmail` or `SendBulkEmail` operations.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-templatename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubjectPart": { "MarkdownDocumentation": "`SubjectPart`\n\nThe subject line of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-subjectpart", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::Tenant.ResourceAssociation": { "MarkdownDocumentation": "`AWS::SES::Tenant.ResourceAssociation`\n\nThe resource to associate with the tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-tenant-resourceassociation.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the resource associated with the tenant.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-tenant-resourceassociation.html#cfn-ses-tenant-resourceassociation-resourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SES::VdmAttributes.DashboardAttributes": { "MarkdownDocumentation": "`AWS::SES::VdmAttributes.DashboardAttributes`\n\nAn object containing additional settings for your VDM configuration as applicable to\nthe Dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-dashboardattributes.html", "Properties": { "EngagementMetrics": { "MarkdownDocumentation": "`EngagementMetrics`\n\nSpecifies the status of your VDM engagement metrics collection. Can be one of the\nfollowing:\n* `ENABLED` \u2013 Amazon SES enables engagement metrics for your\n account.\n* `DISABLED` \u2013 Amazon SES disables engagement metrics for your\n account.\n*Required*: No\n*Type*: String\n*Pattern*: `ENABLED|DISABLED`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-dashboardattributes.html#cfn-ses-vdmattributes-dashboardattributes-engagementmetrics", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::VdmAttributes.GuardianAttributes": { "MarkdownDocumentation": "`AWS::SES::VdmAttributes.GuardianAttributes`\n\nAn object containing additional settings for your VDM configuration as applicable to\nthe Guardian.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-guardianattributes.html", "Properties": { "OptimizedSharedDelivery": { "MarkdownDocumentation": "`OptimizedSharedDelivery`\n\nSpecifies the status of your VDM optimized shared delivery. Can be one of the\nfollowing:\n* `ENABLED` \u2013 Amazon SES enables optimized shared delivery for your\n account.\n* `DISABLED` \u2013 Amazon SES disables optimized shared delivery for\n your account.\n*Required*: No\n*Type*: String\n*Pattern*: `ENABLED|DISABLED`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-guardianattributes.html#cfn-ses-vdmattributes-guardianattributes-optimizedshareddelivery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::ConfigurationSet.CloudWatchLogsDestination": { "MarkdownDocumentation": "`AWS::SMSVOICE::ConfigurationSet.CloudWatchLogsDestination`\n\nContains the destination configuration to use when publishing message sending events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-cloudwatchlogsdestination.html", "Properties": { "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe Amazon Resource Name (ARN) of an AWS Identity and Access Management role\nthat is able to write event data to an Amazon CloudWatch destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-cloudwatchlogsdestination.html#cfn-smsvoice-configurationset-cloudwatchlogsdestination-iamrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe name of the Amazon CloudWatch log group that you want to record events in.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-cloudwatchlogsdestination.html#cfn-smsvoice-configurationset-cloudwatchlogsdestination-loggrouparn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::ConfigurationSet.EventDestination": { "MarkdownDocumentation": "`AWS::SMSVOICE::ConfigurationSet.EventDestination`\n\nContains information about an event destination.\nEvent destinations are associated with configuration sets, which enable you to publish\nmessage sending events to CloudWatch, Firehose, or Amazon SNS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html", "Properties": { "EventDestinationName": { "MarkdownDocumentation": "`EventDestinationName`\n\nThe name of the EventDestination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-eventdestinationname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SnsDestination": { "MarkdownDocumentation": "`SnsDestination`\n\nAn object that contains information about an event destination that sends logging\nevents to Amazon SNS.\n*Required*: No\n*Type*: [SnsDestination](./aws-properties-smsvoice-configurationset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-snsdestination", "UpdateType": "Mutable", "Required": false, "Type": "SnsDestination" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhen set to true events will be logged.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "MatchingEventTypes": { "MarkdownDocumentation": "`MatchingEventTypes`\n\nAn array of event types that determine which events to log.\n###### Note\nThe `TEXT_SENT` event type is not supported.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-matchingeventtypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "CloudWatchLogsDestination": { "MarkdownDocumentation": "`CloudWatchLogsDestination`\n\nAn object that contains information about an event destination that sends logging\nevents to Amazon CloudWatch logs.\n*Required*: No\n*Type*: [CloudWatchLogsDestination](./aws-properties-smsvoice-configurationset-cloudwatchlogsdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-cloudwatchlogsdestination", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLogsDestination" }, "KinesisFirehoseDestination": { "MarkdownDocumentation": "`KinesisFirehoseDestination`\n\nAn object that contains information about an event destination for logging to Amazon Data Firehose.\n*Required*: No\n*Type*: [KinesisFirehoseDestination](./aws-properties-smsvoice-configurationset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-kinesisfirehosedestination", "UpdateType": "Mutable", "Required": false, "Type": "KinesisFirehoseDestination" } } }, "AWS::SMSVOICE::ConfigurationSet.KinesisFirehoseDestination": { "MarkdownDocumentation": "`AWS::SMSVOICE::ConfigurationSet.KinesisFirehoseDestination`\n\nContains the delivery stream Amazon Resource Name (ARN), and the ARN of the AWS Identity and Access Management (IAM) role associated with a Firehose event\ndestination.\nEvent destinations, such as Firehose, are associated with configuration\nsets, which enable you to publish message sending events.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-kinesisfirehosedestination.html", "Properties": { "DeliveryStreamArn": { "MarkdownDocumentation": "`DeliveryStreamArn`\n\nThe Amazon Resource Name (ARN) of the delivery stream.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-kinesisfirehosedestination.html#cfn-smsvoice-configurationset-kinesisfirehosedestination-deliverystreamarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe ARN of an AWS Identity and Access Management role that is able to write\nevent data to an Amazon Data Firehose destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-kinesisfirehosedestination.html#cfn-smsvoice-configurationset-kinesisfirehosedestination-iamrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::ConfigurationSet.SnsDestination": { "MarkdownDocumentation": "`AWS::SMSVOICE::ConfigurationSet.SnsDestination`\n\nAn object that defines an Amazon SNS destination for events. You can use\nAmazon SNS to send notification when certain events occur.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-snsdestination.html", "Properties": { "TopicArn": { "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic that you want to\npublish events to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-snsdestination.html#cfn-smsvoice-configurationset-snsdestination-topicarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::PhoneNumber.MandatoryKeyword": { "MarkdownDocumentation": "`AWS::SMSVOICE::PhoneNumber.MandatoryKeyword`\n\nThe keywords `HELP` and `STOP` are mandatory keywords that each phone number must have. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeyword.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nThe message associated with the keyword.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeyword.html#cfn-smsvoice-phonenumber-mandatorykeyword-message", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::PhoneNumber.MandatoryKeywords": { "MarkdownDocumentation": "`AWS::SMSVOICE::PhoneNumber.MandatoryKeywords`\n\nThe keywords `HELP` and `STOP` are mandatory keywords that each phone number must have. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html", "Properties": { "HELP": { "MarkdownDocumentation": "`HELP`\n\nSpecifies the `HELP` keyword that customers use to obtain customer support for this phone number. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n*Required*: Yes\n*Type*: [MandatoryKeyword](./aws-properties-smsvoice-phonenumber-mandatorykeyword.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html#cfn-smsvoice-phonenumber-mandatorykeywords-help", "UpdateType": "Mutable", "Required": true, "Type": "MandatoryKeyword" }, "STOP": { "MarkdownDocumentation": "`STOP`\n\nSpecifies the `STOP` keyword that customers use to opt out of receiving messages from this phone number. For more information, see\n[Required opt-out keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords-required.html) in the AWS End User Messaging SMS User Guide.\n*Required*: Yes\n*Type*: [MandatoryKeyword](./aws-properties-smsvoice-phonenumber-mandatorykeyword.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html#cfn-smsvoice-phonenumber-mandatorykeywords-stop", "UpdateType": "Mutable", "Required": true, "Type": "MandatoryKeyword" } } }, "AWS::SMSVOICE::PhoneNumber.OptionalKeyword": { "MarkdownDocumentation": "`AWS::SMSVOICE::PhoneNumber.OptionalKeyword`\n\nThe `OptionalKeyword` configuration. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action to perform when the keyword is used.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AUTOMATIC_RESPONSE | OPT_OU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC_RESPONSE", "OPT_OUT", "OPT_IN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Keyword": { "MarkdownDocumentation": "`Keyword`\n\nThe new keyword to add.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!.*(?i)(stop|help))[ \\S]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-keyword", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nThe message associated with the keyword.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-message", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::PhoneNumber.TwoWay": { "MarkdownDocumentation": "`AWS::SMSVOICE::PhoneNumber.TwoWay`\n\nThe phone number's two-way SMS configuration object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html", "Properties": { "ChannelArn": { "MarkdownDocumentation": "`ChannelArn`\n\nThe Amazon Resource Name (ARN) of the two way channel.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html#cfn-smsvoice-phonenumber-twoway-channelarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ChannelRole": { "MarkdownDocumentation": "`ChannelRole`\n\nAn optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html#cfn-smsvoice-phonenumber-twoway-channelrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nBy default this is set to false. When set to true you can receive incoming text\nmessages from your end recipients using the TwoWayChannelArn.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html#cfn-smsvoice-phonenumber-twoway-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::SMSVOICE::Pool.MandatoryKeyword": { "MarkdownDocumentation": "`AWS::SMSVOICE::Pool.MandatoryKeyword`\n\nThe keywords `HELP` and `STOP` are mandatory keywords that each phone number must have. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-mandatorykeyword.html", "Properties": { "Message": { "MarkdownDocumentation": "`Message`\n\nThe message associated with the keyword.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-mandatorykeyword.html#cfn-smsvoice-pool-mandatorykeyword-message", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::Pool.MandatoryKeywords": { "MarkdownDocumentation": "`AWS::SMSVOICE::Pool.MandatoryKeywords`\n\nThe manadatory keywords, `HELP` and `STOP` to add to the pool. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-mandatorykeywords.html", "Properties": { "HELP": { "MarkdownDocumentation": "`HELP`\n\nSpecifies the pool's `HELP` keyword. For more information, see\n[Opt out list required keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/opt-out-list-keywords.html) in the AWS End User Messaging SMS User Guide.\n*Required*: Yes\n*Type*: [MandatoryKeyword](./aws-properties-smsvoice-pool-mandatorykeyword.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-mandatorykeywords.html#cfn-smsvoice-pool-mandatorykeywords-help", "UpdateType": "Mutable", "Required": true, "Type": "MandatoryKeyword" }, "STOP": { "MarkdownDocumentation": "`STOP`\n\nSpecifies the pool's opt-out keyword. For more information, see\n[Required opt-out keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords-required.html) in the AWS End User Messaging SMS User Guide.\n*Required*: Yes\n*Type*: [MandatoryKeyword](./aws-properties-smsvoice-pool-mandatorykeyword.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-mandatorykeywords.html#cfn-smsvoice-pool-mandatorykeywords-stop", "UpdateType": "Mutable", "Required": true, "Type": "MandatoryKeyword" } } }, "AWS::SMSVOICE::Pool.OptionalKeyword": { "MarkdownDocumentation": "`AWS::SMSVOICE::Pool.OptionalKeyword`\n\nThe pool's `OptionalKeyword` configuration. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-optionalkeyword.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action to perform when the keyword is used.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AUTOMATIC_RESPONSE | OPT_OU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC_RESPONSE", "OPT_OUT", "OPT_IN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-optionalkeyword.html#cfn-smsvoice-pool-optionalkeyword-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Keyword": { "MarkdownDocumentation": "`Keyword`\n\nThe new keyword to add.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!.*(?i)(stop|help))[ \\S]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-optionalkeyword.html#cfn-smsvoice-pool-optionalkeyword-keyword", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nThe message associated with the keyword.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-optionalkeyword.html#cfn-smsvoice-pool-optionalkeyword-message", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::Pool.TwoWay": { "MarkdownDocumentation": "`AWS::SMSVOICE::Pool.TwoWay`\n\nThe pool's two-way SMS configuration object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-twoway.html", "Properties": { "ChannelArn": { "MarkdownDocumentation": "`ChannelArn`\n\nThe Amazon Resource Name (ARN) of the two way channel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-twoway.html#cfn-smsvoice-pool-twoway-channelarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ChannelRole": { "MarkdownDocumentation": "`ChannelRole`\n\nAn optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-twoway.html#cfn-smsvoice-pool-twoway-channelrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nBy default this is set to false. When set to true you can receive incoming text\nmessages from your end recipients using the TwoWayChannelArn.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-twoway.html#cfn-smsvoice-pool-twoway-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::SMSVOICE::ProtectConfiguration.CountryRule": { "MarkdownDocumentation": "`AWS::SMSVOICE::ProtectConfiguration.CountryRule`\n\nSpecifies the type of protection to use for a country.\nFor example, to set Canada as allowed, the `CountryRule` would be formatted as follows:\n```\n{\n \"CountryCode\": \"CA\",\n \"ProtectStatus\": \"ALLOW\" \n}\n```\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryrule.html", "Properties": { "ProtectStatus": { "MarkdownDocumentation": "`ProtectStatus`\n\nThe types of protection that can be used.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALLOW | BLOCK | MONITOR | F...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "BLOCK", "MONITOR", "FILTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryrule.html#cfn-smsvoice-protectconfiguration-countryrule-protectstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CountryCode": { "MarkdownDocumentation": "`CountryCode`\n\nThe two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryrule.html#cfn-smsvoice-protectconfiguration-countryrule-countrycode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SMSVOICE::ProtectConfiguration.CountryRuleSet": { "MarkdownDocumentation": "`AWS::SMSVOICE::ProtectConfiguration.CountryRuleSet`\n\nThe set of `CountryRules` you specify to control which countries AWS End User Messaging SMS can send your messages to.\n###### Note\nIf you don't specify all available ISO country codes in the `CountryRuleSet` for each number capability, the CloudFormation drift detection feature\nwill detect drift. This is because AWS End User Messaging SMS always returns all country codes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryruleset.html", "Properties": { "VOICE": { "MarkdownDocumentation": "`VOICE`\n\nThe set of `CountryRule`s to control which destination countries AWS End User Messaging SMS can send your VOICE messages to.\n*Required*: No\n*Type*: Array of [CountryRule](./aws-properties-smsvoice-protectconfiguration-countryrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryruleset.html#cfn-smsvoice-protectconfiguration-countryruleset-voice", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CountryRule", "DuplicatesAllowed": false }, "MMS": { "MarkdownDocumentation": "`MMS`\n\nThe set of `CountryRule`s to control which destination countries AWS End User Messaging SMS can send your MMS messages to.\n*Required*: No\n*Type*: Array of [CountryRule](./aws-properties-smsvoice-protectconfiguration-countryrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryruleset.html#cfn-smsvoice-protectconfiguration-countryruleset-mms", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CountryRule", "DuplicatesAllowed": false }, "SMS": { "MarkdownDocumentation": "`SMS`\n\nThe set of `CountryRule`s to control which destination countries AWS End User Messaging SMS can send your SMS messages to.\n*Required*: No\n*Type*: Array of [CountryRule](./aws-properties-smsvoice-protectconfiguration-countryrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryruleset.html#cfn-smsvoice-protectconfiguration-countryruleset-sms", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CountryRule", "DuplicatesAllowed": false } } }, "AWS::SNS::Topic.LoggingConfig": { "MarkdownDocumentation": "`AWS::SNS::Topic.LoggingConfig`\n\nThe `LoggingConfig` property type specifies the `Delivery` status\nlogging configuration for an [`AWS::SNS::Topic`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html", "Properties": { "FailureFeedbackRoleArn": { "MarkdownDocumentation": "`FailureFeedbackRoleArn`\n\nThe IAM role ARN to be used when logging failed message deliveries in Amazon\nCloudWatch.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html#cfn-sns-topic-loggingconfig-failurefeedbackrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SuccessFeedbackSampleRate": { "MarkdownDocumentation": "`SuccessFeedbackSampleRate`\n\nThe percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid\npercentage values range from 0 to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html#cfn-sns-topic-loggingconfig-successfeedbacksamplerate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SuccessFeedbackRoleArn": { "MarkdownDocumentation": "`SuccessFeedbackRoleArn`\n\nThe IAM role ARN to be used when logging successful message deliveries in Amazon\nCloudWatch.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html#cfn-sns-topic-loggingconfig-successfeedbackrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nIndicates one of the supported protocols for the Amazon SNS topic.\n###### Note\nAt least one of the other three `LoggingConfig` properties is recommend\nalong with `Protocol`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `http/s | sqs | lambda | fir...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "http/s", "sqs", "lambda", "firehose", "application" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html#cfn-sns-topic-loggingconfig-protocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SNS::Topic.Subscription": { "MarkdownDocumentation": "`AWS::SNS::Topic.Subscription`\n\n`Subscription` is an embedded property that describes the subscription endpoints\nof an Amazon SNS topic.\n###### Note\nFor full control over subscription behavior (for example, delivery policy, filtering,\nraw message delivery, and cross-region subscriptions), use the [AWS::SNS::Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html", "Properties": { "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint that receives notifications from the Amazon SNS topic. The endpoint\nvalue depends on the protocol that you specify. For more information, see the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html#cfn-sns-topic-subscription-endpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe subscription's protocol. For more information, see the `Protocol`\nparameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html#cfn-sns-topic-subscription-protocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSM::Association.InstanceAssociationOutputLocation": { "MarkdownDocumentation": "`AWS::SSM::Association.InstanceAssociationOutputLocation`\n\n`InstanceAssociationOutputLocation` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket\nwhere you want to store the results of this association request.\nFor the minimal permissions required to enable Amazon S3 output for an\nassociation, see [Creating\nassociations](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html) in the *Systems Manager User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html", "Properties": { "S3Location": { "MarkdownDocumentation": "`S3Location`\n\n`S3OutputLocation` is a property of the [InstanceAssociationOutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html) property that specifies an Amazon S3 bucket where you want to store the results of this request.\n*Required*: No\n*Type*: [S3OutputLocation](./aws-properties-ssm-association-s3outputlocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html#cfn-ssm-association-instanceassociationoutputlocation-s3location", "UpdateType": "Mutable", "Required": false, "Type": "S3OutputLocation" } } }, "AWS::SSM::Association.S3OutputLocation": { "MarkdownDocumentation": "`AWS::SSM::Association.S3OutputLocation`\n\n`S3OutputLocation` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket\nwhere you want to store the results of this association request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html", "Properties": { "OutputS3KeyPrefix": { "MarkdownDocumentation": "`OutputS3KeyPrefix`\n\nThe S3 bucket subfolder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputS3Region": { "MarkdownDocumentation": "`OutputS3Region`\n\nThe AWS Region of the S3 bucket.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3region", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputS3BucketName": { "MarkdownDocumentation": "`OutputS3BucketName`\n\nThe name of the S3 bucket.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::Association.Target": { "MarkdownDocumentation": "`AWS::SSM::Association.Target`\n\n`Target` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies the targets for an SSM\ndocument in Systems Manager. You can target all instances in an AWS account by specifying the `InstanceIds` key with a value of\n`*`. To view a JSON and a YAML example that targets all instances, see\nthe example \"Create an association for all managed instances in an AWS account\" later in this page.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nUser-defined criteria that maps to `Key`. For example, if you specified\n`tag:ServerRole`, you could specify `value:WebServer` to run a command on\ninstances 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\nthe global maximum of 50.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Key": { "MarkdownDocumentation": "`Key`\n\nUser-defined criteria for sending commands that target managed nodes that meet the\ncriteria.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]{1,128}$|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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSM::Document.AttachmentsSource": { "MarkdownDocumentation": "`AWS::SSM::Document.AttachmentsSource`\n\nIdentifying information about a document attachment, including the file name and a key-value\npair that identifies the location of an attachment to a document.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe value of a key-value pair that identifies the location of an attachment to a document.\nThe format for **Value** depends on the type of key you\nspecify.\n* For the key *SourceUrl*, the value is an S3 bucket location. For\n example:\n \n `\"Values\": [ \"s3://amzn-s3-demo-bucket/my-prefix\" ]`\n* For the key *S3FileUrl*, the value is a file in an S3 bucket. For\n example:\n \n `\"Values\": [ \"s3://amzn-s3-demo-bucket/my-prefix/my-file.py\" ]`\n* For the key *AttachmentReference*, the value is constructed from the\n name of another SSM document in your account, a version number of that document, and a file\n attached to that document version that you want to reuse. For example:\n \n `\"Values\": [ \"MyOtherDocument/3/my-other-file.py\" ]`\n \n However, if the SSM document is shared with you from another account, the full SSM\n document ARN must be specified instead of the document name only. For example:\n \n `\"Values\": [\n \"arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py\"\n ]`\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100000 | 1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-values", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of a key-value pair that identifies the location of an attachment to a\ndocument.\n*Required*: No\n*Type*: String\n*Allowed values*: `SourceUrl | S3FileUrl | Att...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SourceUrl", "S3FileUrl", "AttachmentReference" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-key", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the document attachment file.\n*Required*: No\n*Type*: String\n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-name", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::Document.DocumentRequires": { "MarkdownDocumentation": "`AWS::SSM::Document.DocumentRequires`\n\nAn SSM document required by the current document.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nThe document version required by the current document.\n*Required*: No\n*Type*: String\n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)`\n*Maximum*: `8`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-version", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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,200}$`\n*Maximum*: `200`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-name", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTarget.Targets": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTarget.Targets`\n\nThe `Targets` property type specifies adding a target to a maintenance\nwindow target in AWS Systems Manager.\n`Targets` is a property of the [AWS::SSM::MaintenanceWindowTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nUser-defined criteria that maps to `Key`. For example, if you specified\n`tag:ServerRole`, you could specify `value:WebServer` to run a command on\ninstances 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\nthe global maximum of 50.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Key": { "MarkdownDocumentation": "`Key`\n\nUser-defined criteria for sending commands that target managed nodes that meet the\ncriteria.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$|resource-groups:ResourceTypeFilters|resource-groups:Name`\n*Minimum*: `1`\n*Maximum*: `163`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTask.CloudWatchOutputConfig": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.CloudWatchOutputConfig`\n\nConfiguration options for sending command output to Amazon CloudWatch Logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html", "Properties": { "CloudWatchOutputEnabled": { "MarkdownDocumentation": "`CloudWatchOutputEnabled`\n\nEnables Systems Manager to send command output to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchoutputenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CloudWatchLogGroupName": { "MarkdownDocumentation": "`CloudWatchLogGroupName`\n\nThe name of the CloudWatch Logs log group where you want to send command output. If you\ndon't specify a group name, AWS Systems Manager automatically creates a log group for you. The log group\nuses the following naming format:\n`aws/ssm/SystemsManagerDocumentName`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchloggroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTask.LoggingInfo": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.LoggingInfo`\n\n###### Note\n`LoggingInfo` has been deprecated. To specify an Amazon S3\nbucket to contain logs, instead use the `OutputS3BucketName` and\n`OutputS3KeyPrefix` options in the\n`TaskInvocationParameters` structure. For information about how\nSystems Manager handles these options for the supported maintenance window\ntask types, see [AWS::SSM::MaintenanceWindowTask\nMaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html).\nThe `LoggingInfo` property type specifies information about the Amazon S3 bucket to write instance-level logs to.\n`LoggingInfo` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html", "Properties": { "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3Prefix": { "MarkdownDocumentation": "`S3Prefix`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTask.MaintenanceWindowAutomationParameters": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.MaintenanceWindowAutomationParameters`\n\nThe `MaintenanceWindowAutomationParameters` property type specifies the\nparameters for an `AUTOMATION` task type for a maintenance window task in\nAWS Systems Manager.\n`MaintenanceWindowAutomationParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.\nFor information about available parameters in Automation runbooks, you can view the\ncontent of the runbook itself in the Systems Manager console. For information, see\n[View runbook content](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-documents-reference-details.html#view-automation-json) in the *AWS Systems Manager User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters for the `AUTOMATION` type task.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-parameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DocumentVersion": { "MarkdownDocumentation": "`DocumentVersion`\n\nThe version of an Automation runbook to use during task execution.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-documentversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTask.MaintenanceWindowLambdaParameters": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.MaintenanceWindowLambdaParameters`\n\nThe `MaintenanceWindowLambdaParameters` property type specifies the\nparameters for a `LAMBDA` task type for a maintenance window task in AWS Systems Manager.\n`MaintenanceWindowLambdaParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html", "Properties": { "ClientContext": { "MarkdownDocumentation": "`ClientContext`\n\nClient-specific information to pass to the AWS Lambda function that\nyou're invoking. You can then use the `context` variable to process the\nclient information in your AWS Lambda function.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-clientcontext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Qualifier": { "MarkdownDocumentation": "`Qualifier`\n\nAn AWS Lambda function version or alias name. If you specify a function\nversion, the action uses the qualified function Amazon Resource Name (ARN) to invoke a\nspecific Lambda function. If you specify an alias name, the action uses\nthe alias ARN to invoke the Lambda function version that the alias points\nto.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-qualifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Payload": { "MarkdownDocumentation": "`Payload`\n\nJSON to provide to your AWS Lambda function as input.\n###### Important\nAlthough `Type` is listed as \"String\" for this property, the payload\ncontent must be formatted as a Base64-encoded binary data object.\n*Length Constraint:* 4096\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-payload", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTask.MaintenanceWindowRunCommandParameters": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.MaintenanceWindowRunCommandParameters`\n\nThe `MaintenanceWindowRunCommandParameters` property type specifies the\nparameters for a `RUN_COMMAND` task type for a maintenance window task in\nAWS Systems Manager. This means that these parameters are the same as those for\nthe `SendCommand` API call. For more information about\n`SendCommand` parameters, see [SendCommand](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_SendCommand.html)\nin the *AWS Systems Manager API Reference*.\nFor information about available parameters in SSM Command documents, you can view the\ncontent of the document itself in the Systems Manager console. For information, see\n[Viewing SSM\ncommand document content](https://docs.aws.amazon.com/systems-manager/latest/userguide/viewing-ssm-document-content.html) in the *AWS Systems Manager User\nGuide*.\n`MaintenanceWindowRunCommandParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html", "Properties": { "TimeoutSeconds": { "MarkdownDocumentation": "`TimeoutSeconds`\n\nIf this time is reached and the command hasn't already started running, it doesn't\nrun.\n*Required*: No\n*Type*: Integer\n*Minimum*: `30`\n*Maximum*: `2592000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Comment": { "MarkdownDocumentation": "`Comment`\n\nInformation about the command or commands to run.\n*Required*: No\n*Type*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputS3KeyPrefix": { "MarkdownDocumentation": "`OutputS3KeyPrefix`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters for the `RUN_COMMAND` task execution.\nThe supported parameters are the same as those for the `SendCommand` API\ncall. For more information, see [SendCommand](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_SendCommand.html)\nin the *AWS Systems Manager API Reference*.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "CloudWatchOutputConfig": { "MarkdownDocumentation": "`CloudWatchOutputConfig`\n\nConfiguration options for sending command output to Amazon CloudWatch Logs.\n*Required*: No\n*Type*: [CloudWatchOutputConfig](./aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-cloudwatchoutputconfig", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchOutputConfig" }, "DocumentHashType": { "MarkdownDocumentation": "`DocumentHashType`\n\nThe SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.\n*Required*: No\n*Type*: String\n*Allowed values*: `Sha256 | Sha1...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Sha256", "Sha1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceRoleArn": { "MarkdownDocumentation": "`ServiceRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM service role for\nAWS Systems Manager to assume when running a maintenance window task. If you do not specify a\nservice role ARN, Systems Manager uses a service-linked role in your account. If no\nappropriate service-linked role for Systems Manager exists in your account, it is created when\nyou run `RegisterTaskWithMaintenanceWindow`.\nHowever, for an improved security posture, we strongly recommend creating a custom\npolicy and custom service role for running your maintenance window tasks. The policy\ncan be crafted to provide only the permissions needed for your particular\nmaintenance window tasks. For more information, see [Setting up Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html) in the in the\n*AWS Systems Manager 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-servicerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NotificationConfig": { "MarkdownDocumentation": "`NotificationConfig`\n\nConfigurations for sending notifications about command status changes on a per-managed node\nbasis.\n*Required*: No\n*Type*: [NotificationConfig](./aws-properties-ssm-maintenancewindowtask-notificationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig", "UpdateType": "Mutable", "Required": false, "Type": "NotificationConfig" }, "DocumentVersion": { "MarkdownDocumentation": "`DocumentVersion`\n\nThe AWS Systems Manager document (SSM document) version to use in the request. You can specify\n`$DEFAULT`, `$LATEST`, or a specific version number. If you run commands\nby using the AWS CLI, then you must escape the first two options by using a backslash. If you\nspecify a version number, then you don't need to use the backslash. For example:\n`--document-version \"\\$DEFAULT\"`\n`--document-version \"\\$LATEST\"`\n`--document-version \"3\"`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documentversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputS3BucketName": { "MarkdownDocumentation": "`OutputS3BucketName`\n\nThe name of the Amazon Simple Storage Service (Amazon S3) bucket.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DocumentHash": { "MarkdownDocumentation": "`DocumentHash`\n\nThe SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes\nhave been deprecated.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters`\n\nThe `MaintenanceWindowStepFunctionsParameters` property type specifies the\nparameters for the execution of a `STEP_FUNCTIONS` task in a Systems Manager maintenance window.\n`MaintenanceWindowStepFunctionsParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html", "Properties": { "Input": { "MarkdownDocumentation": "`Input`\n\nThe inputs for the `STEP_FUNCTIONS` task.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the `STEP_FUNCTIONS` task.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTask.NotificationConfig": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.NotificationConfig`\n\nThe `NotificationConfig` property type specifies configurations for sending\nnotifications for a maintenance window task in AWS Systems Manager.\n`NotificationConfig` is a property of the [MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html", "Properties": { "NotificationArn": { "MarkdownDocumentation": "`NotificationArn`\n\nAn Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run\nCommand pushes notifications about command status changes to this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NotificationType": { "MarkdownDocumentation": "`NotificationType`\n\nThe notification type.\n* `Command`: Receive notification when the status of a command\n changes.\n* `Invocation`: For commands sent to multiple instances, receive\n notification on a per-instance basis when the status of a command\n changes.\n*Required*: No\n*Type*: String\n*Allowed values*: `Command | Invocation...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Command", "Invocation" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NotificationEvents": { "MarkdownDocumentation": "`NotificationEvents`\n\nThe different events that you can receive notifications for. These events include the\nfollowing: `All` (events), `InProgress`, `Success`,\n`TimedOut`, `Cancelled`, `Failed`. To learn more\nabout these events, see [Configuring\nAmazon SNS Notifications for AWS Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) in the\n*AWS Systems Manager User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SSM::MaintenanceWindowTask.Target": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.Target`\n\nThe `Target` property type specifies targets (either instances or window\ntarget IDs). You specify instances by using `Key=InstanceIds,Values=,`. You specify window target IDs using\n`Key=WindowTargetIds,Values=,` for a maintenance window task in\nAWS Systems Manager.\n`Target` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) property type.\n###### Note\nTo use `resource-groups:Name` as the key for a maintenance window\ntarget, specify the resource group as a\n`AWS::SSM::MaintenanceWindowTarget` type, and use the\n`Ref` function to specify the target for\n`AWS::SSM::MaintenanceWindowTask`. For an example, see **Create a Run Command task that targets instances using a resource\ngroup name** in [AWS::SSM::MaintenanceWindowTask Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#aws-resource-ssm-maintenancewindowtask--examples).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nUser-defined criteria that maps to `Key`. For example, if you specify\n`InstanceIds`, you can specify\n`i-1234567890abcdef0,i-9876543210abcdef0` to run a command on two EC2\ninstances. For more information about how to target instances within a maintenance\nwindow task, see [About\n'register-task-with-maintenance-window' Options and Values](https://docs.aws.amazon.com/systems-manager/latest/userguide/register-tasks-options.html) in the\n*AWS Systems Manager User Guide*.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Key": { "MarkdownDocumentation": "`Key`\n\nUser-defined criteria for sending commands that target instances that meet the\ncriteria. `Key` can be `InstanceIds` or\n`WindowTargetIds`. For more information about how to target instances\nwithin a maintenance window task, see [About\n'register-task-with-maintenance-window' Options and Values](https://docs.aws.amazon.com/systems-manager/latest/userguide/register-tasks-options.html) in the\n*AWS Systems Manager User Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$|resource-groups:ResourceTypeFilters|resource-groups:Name`\n*Minimum*: `1`\n*Maximum*: `163`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters`\n\nThe `TaskInvocationParameters` property type specifies the task execution\nparameters for a maintenance window task in AWS Systems Manager.\n`TaskInvocationParameters` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html", "Properties": { "MaintenanceWindowRunCommandParameters": { "MarkdownDocumentation": "`MaintenanceWindowRunCommandParameters`\n\nThe parameters for a `RUN_COMMAND` task type.\n*Required*: No\n*Type*: [MaintenanceWindowRunCommandParameters](./aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowruncommandparameters", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceWindowRunCommandParameters" }, "MaintenanceWindowAutomationParameters": { "MarkdownDocumentation": "`MaintenanceWindowAutomationParameters`\n\nThe parameters for an `AUTOMATION` task type.\n*Required*: No\n*Type*: [MaintenanceWindowAutomationParameters](./aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowautomationparameters", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceWindowAutomationParameters" }, "MaintenanceWindowStepFunctionsParameters": { "MarkdownDocumentation": "`MaintenanceWindowStepFunctionsParameters`\n\nThe parameters for a `STEP_FUNCTIONS` task type.\n*Required*: No\n*Type*: [MaintenanceWindowStepFunctionsParameters](./aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowstepfunctionsparameters", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceWindowStepFunctionsParameters" }, "MaintenanceWindowLambdaParameters": { "MarkdownDocumentation": "`MaintenanceWindowLambdaParameters`\n\nThe parameters for a `LAMBDA` task type.\n*Required*: No\n*Type*: [MaintenanceWindowLambdaParameters](./aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowlambdaparameters", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceWindowLambdaParameters" } } }, "AWS::SSM::PatchBaseline.PatchFilter": { "MarkdownDocumentation": "`AWS::SSM::PatchBaseline.PatchFilter`\n\nThe `PatchFilter` property type defines a patch filter for an AWS Systems Manager patch baseline.\nThe `PatchFilters` property of the [PatchFilterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html) property type contains a list of `PatchFilter`\nproperty types.\nYou can view lists of valid values for the patch properties by running the\n`DescribePatchProperties` command. For more information, see [DescribePatchProperties](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribePatchProperties.html) in the *AWS Systems Manager API\nReference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe value for the filter key.\nFor information about valid values for each key based on operating system type, see\n[PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html)\nin the *AWS Systems Manager API Reference*.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `64 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key for the filter.\nFor information about valid keys, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html)\nin the *AWS Systems Manager API Reference*.\n*Required*: No\n*Type*: String\n*Allowed values*: `ADVISORY_ID | ARCH | BUGZIL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ADVISORY_ID", "ARCH", "BUGZILLA_ID", "CLASSIFICATION", "CVE_ID", "EPOCH", "MSRC_SEVERITY", "NAME", "PATCH_ID", "PATCH_SET", "PRIORITY", "PRODUCT", "PRODUCT_FAMILY", "RELEASE", "REPOSITORY", "SECTION", "SECURITY", "SEVERITY", "VERSION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::PatchBaseline.PatchFilterGroup": { "MarkdownDocumentation": "`AWS::SSM::PatchBaseline.PatchFilterGroup`\n\nThe `PatchFilterGroup` property type specifies a set of patch filters for\nan AWS Systems Manager patch baseline, typically used for approval rules for a\nSystems Manager patch baseline.\n`PatchFilterGroup` is the property type for the `GlobalFilters`\nproperty of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource and the `PatchFilterGroup`\nproperty of the [Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html) property type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html", "Properties": { "PatchFilters": { "MarkdownDocumentation": "`PatchFilters`\n\nThe set of patch filters that make up the group.\n*Required*: No\n*Type*: Array of [PatchFilter](./aws-properties-ssm-patchbaseline-patchfilter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PatchFilter", "DuplicatesAllowed": true } } }, "AWS::SSM::PatchBaseline.PatchSource": { "MarkdownDocumentation": "`AWS::SSM::PatchBaseline.PatchSource`\n\n`PatchSource` is the property type for the `Sources` resource of\nthe [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource.\nThe AWS CloudFormation`AWS::SSM::PatchSource` resource is used to\nprovide information about the patches to use to update target instances, including\ntarget operating systems and source repository. Applies to Linux managed nodes\nonly.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html", "Properties": { "Products": { "MarkdownDocumentation": "`Products`\n\nThe specific operating system versions a patch repository applies to, such as\n\"Ubuntu16.04\", \"RedhatEnterpriseLinux7.2\" or \"Suse12.7\". For lists of supported product\nvalues, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html)\nin the *AWS Systems Manager API Reference*.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `128 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-products", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe value of the repo configuration.\n**Example for yum repositories**\n`[main]`\n`name=MyCustomRepository`\n`baseurl=https://my-custom-repository`\n`enabled=1`\nFor information about other options available for your yum repository configuration, see\n[dnf.conf(5)](https://man7.org/linux/man-pages/man5/dnf.conf.5.html) on the\n*man7.org* website.\n**Examples for Ubuntu Server and Debian Server**\n`deb http://security.ubuntu.com/ubuntu jammy main`\n`deb https://site.example.com/debian distribution component1 component2 component3`\nRepo information for Ubuntu Server repositories must be specifed in a single line. For more\nexamples and information, see [jammy (5)\nsources.list.5.gz](https://manpages.ubuntu.com/manpages/jammy/man5/sources.list.5.html) on the *Ubuntu Server Manuals* website and [sources.list format](https://wiki.debian.org/SourcesList#sources.list_format) on the\n*Debian Wiki*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-configuration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name specified to identify the patch source.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,50}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::PatchBaseline.Rule": { "MarkdownDocumentation": "`AWS::SSM::PatchBaseline.Rule`\n\nThe `Rule` property type specifies an approval rule for a Systems Manager patch baseline.\nThe `PatchRules` property of the [RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html) property type contains a list of `Rule` property\ntypes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html", "Properties": { "ApproveUntilDate": { "MarkdownDocumentation": "`ApproveUntilDate`\n\nThe cutoff date for auto approval of released patches. Any patches released on or before\nthis date are installed automatically.\nEnter dates in the format `YYYY-MM-DD`. For example,\n`2025-11-16`.\nPatch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If you\nenter the date `2025-11-16`, patches released between\n`2025-11-16T00:00:00Z` and `2025-11-16T23:59:59Z` will be included in the\napproval.\nThis parameter is marked as `Required: No`, but your request must include a value\nfor either `ApproveUntilDate` or `ApproveAfterDays`.\nNot supported for Debian Server or Ubuntu Server.\n###### Important\nUse caution when setting this value for Windows Server patch baselines. Because patch\nupdates that are replaced by later updates are removed, setting too broad a value for this\nparameter can result in crucial patches not being installed. For more information, see the\n**Windows Server** tab in the topic [How security\npatches are selected](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-selecting-patches.html) in the *AWS Systems Manager User Guide*.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveuntildate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableNonSecurity": { "MarkdownDocumentation": "`EnableNonSecurity`\n\nFor managed nodes identified by the approval rule filters, enables a patch baseline to apply\nnon-security updates available in the specified repository. The default value is\n`false`. Applies to Linux managed nodes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-enablenonsecurity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PatchFilterGroup": { "MarkdownDocumentation": "`PatchFilterGroup`\n\nThe patch filter group that defines the criteria for the rule.\n*Required*: No\n*Type*: [PatchFilterGroup](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-patchfiltergroup", "UpdateType": "Mutable", "Required": false, "Type": "PatchFilterGroup" }, "ApproveAfterDays": { "MarkdownDocumentation": "`ApproveAfterDays`\n\nThe number of days after the release date of each patch matched by the rule that the patch\nis marked as approved in the patch baseline. For example, a value of `7` means that\npatches are approved seven days after they are released.\nPatch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If the\nday represented by `7` is `2025-11-16`, patches released between\n`2025-11-16T00:00:00Z` and `2025-11-16T23:59:59Z` will be included in the\napproval.\nThis parameter is marked as `Required: No`, but your request must include a value\nfor either `ApproveAfterDays` or `ApproveUntilDate`.\nNot supported for Debian Server or Ubuntu Server.\n###### Important\nUse caution when setting this value for Windows Server patch baselines. Because patch\nupdates that are replaced by later updates are removed, setting too broad a value for this\nparameter can result in crucial patches not being installed. For more information, see the\n**Windows Server** tab in the topic [How security\npatches are selected](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-selecting-patches.html) in the *AWS Systems Manager User Guide*.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `360`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveafterdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ComplianceLevel": { "MarkdownDocumentation": "`ComplianceLevel`\n\nA compliance severity level for all approved patches in a patch baseline. Valid\ncompliance severity levels include the following: `UNSPECIFIED`,\n`CRITICAL`, `HIGH`, `MEDIUM`, `LOW`, and\n`INFORMATIONAL`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CRITICAL | HIGH | INFORMATI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CRITICAL", "HIGH", "INFORMATIONAL", "LOW", "MEDIUM", "UNSPECIFIED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-compliancelevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::PatchBaseline.RuleGroup": { "MarkdownDocumentation": "`AWS::SSM::PatchBaseline.RuleGroup`\n\nThe `RuleGroup` property type specifies a set of rules that define the\napproval rules for an AWS Systems Manager patch baseline.\n`RuleGroup` is the property type for the `ApprovalRules`\nproperty of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html", "Properties": { "PatchRules": { "MarkdownDocumentation": "`PatchRules`\n\nThe rules that make up the rule group.\n*Required*: No\n*Type*: Array of [Rule](./aws-properties-ssm-patchbaseline-rule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html#cfn-ssm-patchbaseline-rulegroup-patchrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true } } }, "AWS::SSM::ResourceDataSync.AwsOrganizationsSource": { "MarkdownDocumentation": "`AWS::SSM::ResourceDataSync.AwsOrganizationsSource`\n\nInformation about the `AwsOrganizationsSource` resource data sync source. A sync\nsource of this type can synchronize data from AWS Organizations or, if an AWS organization isn't\npresent, from multiple AWS Regions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html", "Properties": { "OrganizationSourceType": { "MarkdownDocumentation": "`OrganizationSourceType`\n\nIf an AWS organization is present, this is either `OrganizationalUnits` or\n`EntireOrganization`. For `OrganizationalUnits`, the data is aggregated\nfrom a set of organization units. For `EntireOrganization`, the data is aggregated\nfrom the entire AWS organization.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationsourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OrganizationalUnits": { "MarkdownDocumentation": "`OrganizationalUnits`\n\nThe AWS Organizations organization units included in the sync.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationalunits", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SSM::ResourceDataSync.S3Destination": { "MarkdownDocumentation": "`AWS::SSM::ResourceDataSync.S3Destination`\n\nInformation about the target S3 bucket for the resource data sync.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html", "Properties": { "KMSKeyArn": { "MarkdownDocumentation": "`KMSKeyArn`\n\nThe ARN of an encryption key for a destination in Amazon S3. Must belong to the same\nRegion as the destination S3 bucket.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the S3 bucket where the aggregated data is stored.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BucketRegion": { "MarkdownDocumentation": "`BucketRegion`\n\nThe AWS Region with the S3 bucket targeted by the resource data sync.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketregion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SyncFormat": { "MarkdownDocumentation": "`SyncFormat`\n\nA supported sync format. The following format is currently supported: JsonSerDe\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-syncformat", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nAn Amazon S3 prefix for the bucket.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::ResourceDataSync.SyncSource": { "MarkdownDocumentation": "`AWS::SSM::ResourceDataSync.SyncSource`\n\nInformation about the source of the data included in the resource data sync.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html", "Properties": { "SourceType": { "MarkdownDocumentation": "`SourceType`\n\nThe type of data source for the resource data sync. `SourceType` is either\n`AwsOrganizations` (if an organization is present in AWS Organizations) or\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AwsOrganizationsSource": { "MarkdownDocumentation": "`AwsOrganizationsSource`\n\nInformation about the AwsOrganizationsSource resource data sync source. A sync source\nof this type can synchronize data from AWS Organizations.\n*Required*: No\n*Type*: [AwsOrganizationsSource](./aws-properties-ssm-resourcedatasync-awsorganizationssource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-awsorganizationssource", "UpdateType": "Mutable", "Required": false, "Type": "AwsOrganizationsSource" }, "IncludeFutureRegions": { "MarkdownDocumentation": "`IncludeFutureRegions`\n\nWhether to automatically synchronize and aggregate data from new AWS Regions when those\nRegions come online.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-includefutureregions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SourceRegions": { "MarkdownDocumentation": "`SourceRegions`\n\nThe `SyncSource`AWS Regions included in the resource data sync.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourceregions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SSMContacts::Contact.ChannelTargetInfo": { "MarkdownDocumentation": "`AWS::SSMContacts::Contact.ChannelTargetInfo`\n\nInformation about the contact channel that Incident Manager uses to engage the\ncontact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-channeltargetinfo.html", "Properties": { "RetryIntervalInMinutes": { "MarkdownDocumentation": "`RetryIntervalInMinutes`\n\nThe number of minutes to wait before retrying to send engagement if the engagement\ninitially failed.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-channeltargetinfo.html#cfn-ssmcontacts-contact-channeltargetinfo-retryintervalinminutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ChannelId": { "MarkdownDocumentation": "`ChannelId`\n\nThe Amazon Resource Name (ARN) of the contact channel.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-])*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-channeltargetinfo.html#cfn-ssmcontacts-contact-channeltargetinfo-channelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMContacts::Contact.ContactTargetInfo": { "MarkdownDocumentation": "`AWS::SSMContacts::Contact.ContactTargetInfo`\n\nThe contact that Incident Manager is engaging during an incident.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-contacttargetinfo.html", "Properties": { "ContactId": { "MarkdownDocumentation": "`ContactId`\n\nThe Amazon Resource Name (ARN) of the contact.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-])*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-contacttargetinfo.html#cfn-ssmcontacts-contact-contacttargetinfo-contactid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IsEssential": { "MarkdownDocumentation": "`IsEssential`\n\nA Boolean value determining if the contact's acknowledgement stops the progress of\nstages in the plan.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-contacttargetinfo.html#cfn-ssmcontacts-contact-contacttargetinfo-isessential", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::SSMContacts::Contact.Stage": { "MarkdownDocumentation": "`AWS::SSMContacts::Contact.Stage`\n\nThe `Stage` property type specifies a set amount of time that an escalation\nplan or engagement plan engages the specified contacts or contact methods.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html", "Properties": { "DurationInMinutes": { "MarkdownDocumentation": "`DurationInMinutes`\n\nThe time to wait until beginning the next stage. The duration can only be set to 0 if a\ntarget is specified.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html#cfn-ssmcontacts-contact-stage-durationinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RotationIds": { "MarkdownDocumentation": "`RotationIds`\n\nThe Amazon Resource Names (ARNs) of the on-call rotations associated with the\nplan.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html#cfn-ssmcontacts-contact-stage-rotationids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe contacts or contact methods that the escalation plan or engagement plan is\nengaging.\n*Required*: No\n*Type*: [Array](./aws-properties-ssmcontacts-contact-targets.html) of [Targets](./aws-properties-ssmcontacts-contact-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html#cfn-ssmcontacts-contact-stage-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Targets", "DuplicatesAllowed": true } } }, "AWS::SSMContacts::Contact.Targets": { "MarkdownDocumentation": "`AWS::SSMContacts::Contact.Targets`\n\nThe contact or contact channel that's being engaged.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html", "Properties": { "ChannelTargetInfo": { "MarkdownDocumentation": "`ChannelTargetInfo`\n\nInformation about the contact channel that Incident Manager engages.\n*Required*: No\n*Type*: [ChannelTargetInfo](./aws-properties-ssmcontacts-contact-channeltargetinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html#cfn-ssmcontacts-contact-targets-channeltargetinfo", "UpdateType": "Mutable", "Required": false, "Type": "ChannelTargetInfo" }, "ContactTargetInfo": { "MarkdownDocumentation": "`ContactTargetInfo`\n\nThe contact that Incident Manager is engaging during an incident.\n*Required*: No\n*Type*: [ContactTargetInfo](./aws-properties-ssmcontacts-contact-contacttargetinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html#cfn-ssmcontacts-contact-targets-contacttargetinfo", "UpdateType": "Mutable", "Required": false, "Type": "ContactTargetInfo" } } }, "AWS::SSMContacts::Plan.ChannelTargetInfo": { "MarkdownDocumentation": "`AWS::SSMContacts::Plan.ChannelTargetInfo`\n\nInformation about the contact channel that Incident Manager uses to engage the\ncontact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html", "Properties": { "RetryIntervalInMinutes": { "MarkdownDocumentation": "`RetryIntervalInMinutes`\n\nThe number of minutes to wait before retrying to send engagement if the engagement\ninitially failed.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html#cfn-ssmcontacts-plan-channeltargetinfo-retryintervalinminutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ChannelId": { "MarkdownDocumentation": "`ChannelId`\n\nThe Amazon Resource Name (ARN) of the contact channel.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-])*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html#cfn-ssmcontacts-plan-channeltargetinfo-channelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMContacts::Plan.ContactTargetInfo": { "MarkdownDocumentation": "`AWS::SSMContacts::Plan.ContactTargetInfo`\n\nThe contact that Incident Manager is engaging during an incident.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html", "Properties": { "ContactId": { "MarkdownDocumentation": "`ContactId`\n\nThe Amazon Resource Name (ARN) of the contact.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-])*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html#cfn-ssmcontacts-plan-contacttargetinfo-contactid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IsEssential": { "MarkdownDocumentation": "`IsEssential`\n\nA Boolean value determining if the contact's acknowledgement stops the progress of\nstages in the plan.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html#cfn-ssmcontacts-plan-contacttargetinfo-isessential", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::SSMContacts::Plan.Stage": { "MarkdownDocumentation": "`AWS::SSMContacts::Plan.Stage`\n\nA set amount of time that an escalation plan or engagement plan engages the specified\ncontacts or contact methods.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html", "Properties": { "DurationInMinutes": { "MarkdownDocumentation": "`DurationInMinutes`\n\nThe time to wait until beginning the next stage. The duration can only be set to 0 if a\ntarget is specified.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html#cfn-ssmcontacts-plan-stage-durationinminutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe contacts or contact methods that the escalation plan or engagement plan is\nengaging.\n*Required*: No\n*Type*: [Array](./aws-properties-ssmcontacts-plan-targets.html) of [Targets](./aws-properties-ssmcontacts-plan-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html#cfn-ssmcontacts-plan-stage-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Targets", "DuplicatesAllowed": true } } }, "AWS::SSMContacts::Plan.Targets": { "MarkdownDocumentation": "`AWS::SSMContacts::Plan.Targets`\n\nThe contact or contact channel that's being engaged.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html", "Properties": { "ChannelTargetInfo": { "MarkdownDocumentation": "`ChannelTargetInfo`\n\nInformation about the contact channel that Incident Manager engages.\n*Required*: No\n*Type*: [ChannelTargetInfo](./aws-properties-ssmcontacts-plan-channeltargetinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html#cfn-ssmcontacts-plan-targets-channeltargetinfo", "UpdateType": "Mutable", "Required": false, "Type": "ChannelTargetInfo" }, "ContactTargetInfo": { "MarkdownDocumentation": "`ContactTargetInfo`\n\nInformation about the contact that Incident Manager engages.\n*Required*: No\n*Type*: [ContactTargetInfo](./aws-properties-ssmcontacts-plan-contacttargetinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html#cfn-ssmcontacts-plan-targets-contacttargetinfo", "UpdateType": "Mutable", "Required": false, "Type": "ContactTargetInfo" } } }, "AWS::SSMContacts::Rotation.CoverageTime": { "MarkdownDocumentation": "`AWS::SSMContacts::Rotation.CoverageTime`\n\nInformation about when an on-call shift begins and ends.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-coveragetime.html", "Properties": { "EndTime": { "MarkdownDocumentation": "`EndTime`\n\nInformation about when an on-call rotation shift ends.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9]|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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-coveragetime.html#cfn-ssmcontacts-rotation-coveragetime-endtime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nInformation about when an on-call rotation shift begins.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9]|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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-coveragetime.html#cfn-ssmcontacts-rotation-coveragetime-starttime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMContacts::Rotation.MonthlySetting": { "MarkdownDocumentation": "`AWS::SSMContacts::Rotation.MonthlySetting`\n\nInformation about on-call rotations that recur monthly.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-monthlysetting.html", "Properties": { "DayOfMonth": { "MarkdownDocumentation": "`DayOfMonth`\n\nThe day of the month when monthly recurring on-call rotations begin.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `31`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-monthlysetting.html#cfn-ssmcontacts-rotation-monthlysetting-dayofmonth", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "HandOffTime": { "MarkdownDocumentation": "`HandOffTime`\n\nThe time of day when a monthly recurring on-call shift rotation begins.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9]|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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-monthlysetting.html#cfn-ssmcontacts-rotation-monthlysetting-handofftime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMContacts::Rotation.RecurrenceSettings": { "MarkdownDocumentation": "`AWS::SSMContacts::Rotation.RecurrenceSettings`\n\nInformation about when an on-call rotation is in effect and how long the rotation period\nlasts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html", "Properties": { "DailySettings": { "MarkdownDocumentation": "`DailySettings`\n\nInformation about on-call rotations that recur daily.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-dailysettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NumberOfOnCalls": { "MarkdownDocumentation": "`NumberOfOnCalls`\n\nThe number of contacts, or shift team members designated to be on call concurrently\nduring a shift. For example, in an on-call schedule that contains ten contacts, a value of\n`2` designates that two of them are on call at any given time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-numberofoncalls", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ShiftCoverages": { "MarkdownDocumentation": "`ShiftCoverages`\n\nInformation about the days of the week included in on-call rotation coverage.\n*Required*: No\n*Type*: Array of [ShiftCoverage](./aws-properties-ssmcontacts-rotation-shiftcoverage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-shiftcoverages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ShiftCoverage", "DuplicatesAllowed": true }, "WeeklySettings": { "MarkdownDocumentation": "`WeeklySettings`\n\nInformation about on-call rotations that recur weekly.\n*Required*: No\n*Type*: Array of [WeeklySetting](./aws-properties-ssmcontacts-rotation-weeklysetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-weeklysettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "WeeklySetting", "DuplicatesAllowed": true }, "RecurrenceMultiplier": { "MarkdownDocumentation": "`RecurrenceMultiplier`\n\nThe number of days, weeks, or months a single rotation lasts.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-recurrencemultiplier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "MonthlySettings": { "MarkdownDocumentation": "`MonthlySettings`\n\nInformation about on-call rotations that recur monthly.\n*Required*: No\n*Type*: Array of [MonthlySetting](./aws-properties-ssmcontacts-rotation-monthlysetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-monthlysettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MonthlySetting", "DuplicatesAllowed": true } } }, "AWS::SSMContacts::Rotation.ShiftCoverage": { "MarkdownDocumentation": "`AWS::SSMContacts::Rotation.ShiftCoverage`\n\nInformation about the days of the week that the on-call rotation coverage\nincludes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-shiftcoverage.html", "Properties": { "DayOfWeek": { "MarkdownDocumentation": "`DayOfWeek`\n\nA list of days on which the schedule is active.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MON | TUE | WED | THU | FRI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-shiftcoverage.html#cfn-ssmcontacts-rotation-shiftcoverage-dayofweek", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CoverageTimes": { "MarkdownDocumentation": "`CoverageTimes`\n\nThe start and end times of the shift.\n*Required*: Yes\n*Type*: Array of [CoverageTime](./aws-properties-ssmcontacts-rotation-coveragetime.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-shiftcoverage.html#cfn-ssmcontacts-rotation-shiftcoverage-coveragetimes", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CoverageTime", "DuplicatesAllowed": true } } }, "AWS::SSMContacts::Rotation.WeeklySetting": { "MarkdownDocumentation": "`AWS::SSMContacts::Rotation.WeeklySetting`\n\nInformation about rotations that recur weekly.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-weeklysetting.html", "Properties": { "DayOfWeek": { "MarkdownDocumentation": "`DayOfWeek`\n\nThe day of the week when weekly recurring on-call shift rotations begins.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MON | TUE | WED | THU | FRI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-weeklysetting.html#cfn-ssmcontacts-rotation-weeklysetting-dayofweek", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HandOffTime": { "MarkdownDocumentation": "`HandOffTime`\n\nThe time of day when a weekly recurring on-call shift rotation begins.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9]|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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-weeklysetting.html#cfn-ssmcontacts-rotation-weeklysetting-handofftime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMGuiConnect::Preferences.ConnectionRecordingPreferences": { "MarkdownDocumentation": "`AWS::SSMGuiConnect::Preferences.ConnectionRecordingPreferences`\n\nThe set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-connectionrecordingpreferences.html", "Properties": { "KMSKeyArn": { "MarkdownDocumentation": "`KMSKeyArn`\n\nThe ARN of a AWS KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-connectionrecordingpreferences.html#cfn-ssmguiconnect-preferences-connectionrecordingpreferences-kmskeyarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RecordingDestinations": { "MarkdownDocumentation": "`RecordingDestinations`\n\nDetermines where recordings of RDP connections are stored.\n*Required*: Yes\n*Type*: [RecordingDestinations](./aws-properties-ssmguiconnect-preferences-recordingdestinations.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-connectionrecordingpreferences.html#cfn-ssmguiconnect-preferences-connectionrecordingpreferences-recordingdestinations", "UpdateType": "Mutable", "Required": true, "Type": "RecordingDestinations" } } }, "AWS::SSMGuiConnect::Preferences.RecordingDestinations": { "MarkdownDocumentation": "`AWS::SSMGuiConnect::Preferences.RecordingDestinations`\n\nDetermines where recordings of RDP connections are stored.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-recordingdestinations.html", "Properties": { "S3Buckets": { "MarkdownDocumentation": "`S3Buckets`\n\nThe S3 bucket where RDP connection recordings are stored.\n*Required*: Yes\n*Type*: Array of [S3Bucket](./aws-properties-ssmguiconnect-preferences-s3bucket.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-recordingdestinations.html#cfn-ssmguiconnect-preferences-recordingdestinations-s3buckets", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "S3Bucket", "DuplicatesAllowed": false } } }, "AWS::SSMGuiConnect::Preferences.S3Bucket": { "MarkdownDocumentation": "`AWS::SSMGuiConnect::Preferences.S3Bucket`\n\nThe S3 bucket where RDP connection recordings are stored.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-s3bucket.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the S3 bucket where RDP connection recordings are stored.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-s3bucket.html#cfn-ssmguiconnect-preferences-s3bucket-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketOwner": { "MarkdownDocumentation": "`BucketOwner`\n\nThe AWS account number that owns the S3 bucket.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmguiconnect-preferences-s3bucket.html#cfn-ssmguiconnect-preferences-s3bucket-bucketowner", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ReplicationSet.RegionConfiguration": { "MarkdownDocumentation": "`AWS::SSMIncidents::ReplicationSet.RegionConfiguration`\n\nThe `RegionConfiguration` property specifies the Region and AWS Key Management Service key to add\nto the replication set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-replicationset-regionconfiguration.html", "Properties": { "SseKmsKeyId": { "MarkdownDocumentation": "`SseKmsKeyId`\n\nThe AWS Key Management Service key ID to use to encrypt your replication set.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-replicationset-regionconfiguration.html#cfn-ssmincidents-replicationset-regionconfiguration-ssekmskeyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ReplicationSet.ReplicationRegion": { "MarkdownDocumentation": "`AWS::SSMIncidents::ReplicationSet.ReplicationRegion`\n\nThe `ReplicationRegion` property type specifies the Region and AWS Key Management Service key to\nadd to the replication set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-replicationset-replicationregion.html", "Properties": { "RegionConfiguration": { "MarkdownDocumentation": "`RegionConfiguration`\n\nSpecifies the Region configuration.\n*Required*: No\n*Type*: [RegionConfiguration](./aws-properties-ssmincidents-replicationset-regionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-replicationset-replicationregion.html#cfn-ssmincidents-replicationset-replicationregion-regionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RegionConfiguration" }, "RegionName": { "MarkdownDocumentation": "`RegionName`\n\nSpecifies the region name to add to the replication set.\n*Required*: No\n*Type*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-replicationset-replicationregion.html#cfn-ssmincidents-replicationset-replicationregion-regionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ResponsePlan.Action": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.Action`\n\nThe `Action` property type specifies the configuration to launch.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-action.html", "Properties": { "SsmAutomation": { "MarkdownDocumentation": "`SsmAutomation`\n\nDetails about the Systems Manager automation document that will be used as a\nrunbook during an incident.\n*Required*: No\n*Type*: [SsmAutomation](./aws-properties-ssmincidents-responseplan-ssmautomation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-action.html#cfn-ssmincidents-responseplan-action-ssmautomation", "UpdateType": "Mutable", "Required": false, "Type": "SsmAutomation" } } }, "AWS::SSMIncidents::ResponsePlan.ChatChannel": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.ChatChannel`\n\nThe Amazon Q Developer in chat applications chat channel used for collaboration during an\nincident.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-chatchannel.html", "Properties": { "ChatbotSns": { "MarkdownDocumentation": "`ChatbotSns`\n\nThe Amazon SNS targets that Amazon Q Developer in chat applications uses to notify the chat channel of updates\nto an incident. You can also make updates to the incident through the chat channel by\nusing the Amazon SNS topics\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-chatchannel.html#cfn-ssmincidents-responseplan-chatchannel-chatbotsns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::SSMIncidents::ResponsePlan.DynamicSsmParameter": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.DynamicSsmParameter`\n\nWhen you add a runbook to a response plan, you can specify the parameters for the runbook\nto use at runtime. Response plans support parameters with both static and dynamic\nvalues. For static values, you enter the value when you define the parameter in the\nresponse plan. For dynamic values, the system determines the correct parameter value by\ncollecting information from the incident. Incident Manager supports the\nfollowing dynamic parameters:\n**Incident ARN**\nWhen Incident Manager creates an incident, the system captures the Amazon\nResource Name (ARN) of the corresponding incident record and enters it for this\nparameter in the runbook.\n###### Note\nThis value can only be assigned to parameters of type `String`. If\nassigned to a parameter of any other type, the runbook fails to run.\n**Involved resources**\nWhen Incident Manager creates an incident, the system captures the ARNs of\nthe resources involved in the incident. These resource ARNs are then assigned to this\nparameter in the runbook.\n###### Note\nThis value can only be assigned to parameters of type `StringList`. If\nassigned to a parameter of any other type, the runbook fails to run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe dynamic parameter value.\n*Required*: Yes\n*Type*: [DynamicSsmParameterValue](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.html#cfn-ssmincidents-responseplan-dynamicssmparameter-value", "UpdateType": "Mutable", "Required": true, "Type": "DynamicSsmParameterValue" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key parameter to use when running the Systems Manager Automation\nrunbook.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.html#cfn-ssmincidents-responseplan-dynamicssmparameter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ResponsePlan.DynamicSsmParameterValue": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.DynamicSsmParameterValue`\n\nThe dynamic parameter value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparametervalue.html", "Properties": { "Variable": { "MarkdownDocumentation": "`Variable`\n\nVariable dynamic parameters. A parameter value is determined when an incident is\ncreated.\n*Required*: No\n*Type*: String\n*Allowed values*: `INCIDENT_RECORD_ARN | INVOL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INCIDENT_RECORD_ARN", "INVOLVED_RESOURCES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparametervalue.html#cfn-ssmincidents-responseplan-dynamicssmparametervalue-variable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ResponsePlan.IncidentTemplate": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.IncidentTemplate`\n\nThe `IncidentTemplate` property type specifies details used to create an\nincident when using this response plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html", "Properties": { "Impact": { "MarkdownDocumentation": "`Impact`\n\nDefines the impact to the customers. Providing an impact overwrites the impact\nprovided by a response plan.\n###### Possible impacts:\n* `1` - Critical impact, this typically relates to full application\n failure that impacts many to all customers.\n* `2` - High impact, partial application failure with impact to many\n customers.\n* `3` - Medium impact, the application is providing reduced service\n to customers.\n* `4` - Low impact, customer might aren't impacted by the problem\n yet.\n* `5` - No impact, customers aren't currently impacted but urgent\n action is needed to avoid impact.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-impact", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "IncidentTags": { "MarkdownDocumentation": "`IncidentTags`\n\nTags to assign to the template. When the `StartIncident` API action is\ncalled, Incident Manager assigns the tags specified in the template to the\nincident.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ssmincidents-responseplan-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-incidenttags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Summary": { "MarkdownDocumentation": "`Summary`\n\nThe summary describes what has happened during the incident.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-summary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nThe title of the incident is a brief and easily recognizable.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-title", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NotificationTargets": { "MarkdownDocumentation": "`NotificationTargets`\n\nThe Amazon Simple Notification Service (Amazon SNS) targets that Amazon Q Developer in chat applications uses to notify the chat channel of updates\nto an incident. You can also make updates to the incident through the chat channel using\nthe Amazon SNS topics.\n*Required*: No\n*Type*: Array of [NotificationTargetItem](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-notificationtargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NotificationTargetItem", "DuplicatesAllowed": true }, "DedupeString": { "MarkdownDocumentation": "`DedupeString`\n\nUsed to create only one incident record for an incident.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-dedupestring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ResponsePlan.Integration": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.Integration`\n\nInformation about third-party services integrated into a response plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-integration.html", "Properties": { "PagerDutyConfiguration": { "MarkdownDocumentation": "`PagerDutyConfiguration`\n\nInformation about the PagerDuty service where the response plan creates an\nincident.\n*Required*: No\n*Type*: [PagerDutyConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-integration.html#cfn-ssmincidents-responseplan-integration-pagerdutyconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PagerDutyConfiguration" } } }, "AWS::SSMIncidents::ResponsePlan.NotificationTargetItem": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.NotificationTargetItem`\n\nThe Amazon SNS topic that's used by Amazon Q Developer in chat applications to notify the incidents chat\nchannel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-notificationtargetitem.html", "Properties": { "SnsTopicArn": { "MarkdownDocumentation": "`SnsTopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-notificationtargetitem.html#cfn-ssmincidents-responseplan-notificationtargetitem-snstopicarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ResponsePlan.PagerDutyConfiguration": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.PagerDutyConfiguration`\n\nDetails about the PagerDuty configuration for a response plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html", "Properties": { "SecretId": { "MarkdownDocumentation": "`SecretId`\n\nThe ID of the AWS Secrets Manager secret that stores your PagerDuty key, either a\nGeneral Access REST API Key or User Token REST API Key, and other user\ncredentials.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html#cfn-ssmincidents-responseplan-pagerdutyconfiguration-secretid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PagerDutyIncidentConfiguration": { "MarkdownDocumentation": "`PagerDutyIncidentConfiguration`\n\nDetails about the PagerDuty service associated with the configuration.\n*Required*: Yes\n*Type*: [PagerDutyIncidentConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html#cfn-ssmincidents-responseplan-pagerdutyconfiguration-pagerdutyincidentconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "PagerDutyIncidentConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the PagerDuty configuration.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html#cfn-ssmincidents-responseplan-pagerdutyconfiguration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ResponsePlan.PagerDutyIncidentConfiguration": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.PagerDutyIncidentConfiguration`\n\nDetails about the PagerDuty service where the response plan creates an\nincident.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyincidentconfiguration.html", "Properties": { "ServiceId": { "MarkdownDocumentation": "`ServiceId`\n\nThe ID of the PagerDuty service that the response plan associates with an incident\nwhen it launches.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyincidentconfiguration.html#cfn-ssmincidents-responseplan-pagerdutyincidentconfiguration-serviceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ResponsePlan.SsmAutomation": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.SsmAutomation`\n\nThe `SsmAutomation` property type specifies details about the\nSystems Manager Automation runbook that will be used as the runbook during an incident.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe key-value pair parameters to use when running the runbook.\n*Required*: No\n*Type*: Array of [SsmParameter](./aws-properties-ssmincidents-responseplan-ssmparameter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SsmParameter", "DuplicatesAllowed": false }, "TargetAccount": { "MarkdownDocumentation": "`TargetAccount`\n\nThe account that the automation document will be run in. This can be in either the\nmanagement account or an application account.\n*Required*: No\n*Type*: String\n*Allowed values*: `IMPACTED_ACCOUNT | RESPONSE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IMPACTED_ACCOUNT", "RESPONSE_PLAN_OWNER_ACCOUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-targetaccount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DynamicParameters": { "MarkdownDocumentation": "`DynamicParameters`\n\nThe key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.\n*Required*: No\n*Type*: Array of [DynamicSsmParameter](./aws-properties-ssmincidents-responseplan-dynamicssmparameter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-dynamicparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DynamicSsmParameter", "DuplicatesAllowed": false }, "DocumentVersion": { "MarkdownDocumentation": "`DocumentVersion`\n\nThe version of the runbook to use when running.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-documentversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the role that the automation document will assume\nwhen running commands.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DocumentName": { "MarkdownDocumentation": "`DocumentName`\n\nThe automation document's name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-documentname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMIncidents::ResponsePlan.SsmParameter": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan.SsmParameter`\n\nThe key-value pair parameters to use when running the Automation runbook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmparameter.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nThe value parameter to use when running the Automation runbook.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmparameter.html#cfn-ssmincidents-responseplan-ssmparameter-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key parameter to use when running the Automation runbook.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmparameter.html#cfn-ssmincidents-responseplan-ssmparameter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSMQuickSetup::ConfigurationManager.ConfigurationDefinition": { "MarkdownDocumentation": "`AWS::SSMQuickSetup::ConfigurationManager.ConfigurationDefinition`\n\nThe definition of a Quick Setup configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the Quick Setup configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,200}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters for the configuration definition type. Parameters for configuration\ndefinitions vary based the configuration type. The following lists outline the\nparameters for each configuration type.\nAWS Config Recording (Type: AWSQuickSetupType-CFGRecording)\n* `RecordAllResources`\n \n + Description: (Optional) A boolean value that\n determines whether all supported resources are\n recorded. The default value is\n \"`true`\".\n* `ResourceTypesToRecord`\n \n + Description: (Optional) A comma separated\n list of resource types you want to record.\n* `RecordGlobalResourceTypes`\n \n + Description: (Optional) A boolean value that\n determines whether global resources are recorded\n with all resource configurations. The default\n value is \"`false`\".\n* `GlobalResourceTypesRegion`\n \n + Description: (Optional) Determines the\n AWS Region where global resources\n are recorded.\n* `UseCustomBucket`\n \n + Description: (Optional) A boolean value that\n determines whether a custom Amazon S3\n bucket is used for delivery. The default value is\n \"`false`\".\n* `DeliveryBucketName`\n \n + Description: (Optional) The name of the\n Amazon S3 bucket you want AWS Config to deliver configuration snapshots and\n configuration history files to.\n* `DeliveryBucketPrefix`\n \n + Description: (Optional) The key prefix you\n want to use in the custom Amazon S3\n bucket.\n* `NotificationOptions`\n \n + Description: (Optional) Determines the\n notification configuration for the recorder. The\n valid values are `NoStreaming`,\n `UseExistingTopic`, and\n `CreateTopic`. The default value is\n `NoStreaming`.\n* `CustomDeliveryTopicAccountId`\n \n + Description: (Optional) The ID of the\n AWS account where the Amazon SNS topic you want to use for notifications\n resides. You must specify a value for this\n parameter if you use the\n `UseExistingTopic` notification\n option.\n* `CustomDeliveryTopicName`\n \n + Description: (Optional) The name of the\n Amazon SNS topic you want to use for\n notifications. You must specify a value for this\n parameter if you use the\n `UseExistingTopic` notification\n option.\n* `RemediationSchedule`\n \n + Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are `rate(30 days)`,\n `rate(7 days)`, `rate(1\n days)`, and `none`. The default\n value is \"`none`\".\n* `TargetAccounts`\n \n + Description: (Optional) The ID of the\n AWS account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either `TargetAccounts` or\n `TargetOrganizationalUnits`.\n* `TargetOrganizationalUnits`\n \n + Description: (Optional) The ID of the root\n of your Organization. This configuration type\n doesn't currently support choosing specific OUs.\n The configuration will be deployed to all the OUs\n in the Organization.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nChange Manager (Type: AWSQuickSetupType-SSMChangeMgr)\n* `DelegatedAccountId`\n \n + Description: (Required) The ID of the\n delegated administrator account.\n* `JobFunction`\n \n + Description: (Required) The name for the\n Change Manager job function.\n* `PermissionType`\n \n + Description: (Optional) Specifies whether\n you want to use default administrator permissions\n for the job function role, or provide a custom\n IAM policy. The valid values are\n `CustomPermissions` and\n `AdminPermissions`. The default value\n for the parameter is\n `CustomerPermissions`.\n* `CustomPermissions`\n \n + Description: (Optional) A JSON string\n containing the IAM policy you want\n your job function to use. You must provide a value\n for this parameter if you specify\n `CustomPermissions` for the\n `PermissionType` parameter.\n* `TargetOrganizationalUnits`\n \n + Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nConformance Packs (Type: AWSQuickSetupType-CFGCPacks)\n* `DelegatedAccountId`\n \n + Description: (Optional) The ID of the\n delegated administrator account. This parameter is\n required for Organization deployments.\n* `RemediationSchedule`\n \n + Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are `rate(30 days)`,\n `rate(14 days)`, `rate(2\n days)`, and `none`. The default\n value is \"`none`\".\n* `CPackNames`\n \n + Description: (Required) A comma separated\n list of AWS Config conformance\n packs.\n* `TargetAccounts`\n \n + Description: (Optional) The ID of the\n AWS account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either `TargetAccounts` or\n `TargetOrganizationalUnits`.\n* `TargetOrganizationalUnits`\n \n + Description: (Optional) The ID of the root\n of your Organization. This configuration type\n doesn't currently support choosing specific OUs.\n The configuration will be deployed to all the OUs\n in the Organization.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nDefault Host Management Configuration (Type: AWSQuickSetupType-DHMC)\n* `UpdateSsmAgent`\n \n + Description: (Optional) A boolean value that\n determines whether the SSM Agent is updated on the\n target instances every 2 weeks. The default value\n is \"`true`\".\n* `TargetOrganizationalUnits`\n \n + Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nDevOps\u00a0Guru (Type: AWSQuickSetupType-DevOpsGuru)\n* `AnalyseAllResources`\n \n + Description: (Optional) A boolean value that\n determines whether DevOps\u00a0Guru analyzes all\n CloudFormation stacks in the account. The\n default value is \"`false`\".\n* `EnableSnsNotifications`\n \n + Description: (Optional) A boolean value that\n determines whether DevOps\u00a0Guru sends\n notifications when an insight is created. The\n default value is \"`true`\".\n* `EnableSsmOpsItems`\n \n + Description: (Optional) A boolean value that\n determines whether DevOps\u00a0Guru creates an\n OpsCenter OpsItem when an insight is created. The\n default value is \"`true`\".\n* `EnableDriftRemediation`\n \n + Description: (Optional) A boolean value that\n determines whether a drift remediation schedule is\n used. The default value is\n \"`false`\".\n* `RemediationSchedule`\n \n + Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are `rate(30 days)`,\n `rate(14 days)`, `rate(1\n days)`, and `none`. The default\n value is \"`none`\".\n* `TargetAccounts`\n \n + Description: (Optional) The ID of the\n AWS account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either `TargetAccounts` or\n `TargetOrganizationalUnits`.\n* `TargetOrganizationalUnits`\n \n + Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nDistributor (Type: AWSQuickSetupType-Distributor)\n* `PackagesToInstall`\n \n + Description: (Required) A comma separated\n list of packages you want to install on the target\n instances. The valid values are\n `AWSEFSTools`, `AWSCWAgent`,\n and `AWSEC2LaunchAgent`.\n* `RemediationSchedule`\n \n + Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are `rate(30 days)`,\n `rate(14 days)`, `rate(2\n days)`, and `none`. The default\n value is \"`rate(30 days)`\".\n* `IsPolicyAttachAllowed`\n \n + Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies to\n instances profiles already associated with the\n target instances. The default value is\n \"`false`\".\n* `TargetType`\n \n + Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are `*`,\n `InstanceIds`,\n `ResourceGroups`, and\n `Tags`. Use `*` to target\n all instances in the account.\n* `TargetInstances`\n \n + Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n `InstanceIds` for the\n `TargetType` parameter.\n* `TargetTagKey`\n \n + Description: (Required) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n `Tags` for the `TargetType`\n parameter.\n* `TargetTagValue`\n \n + Description: (Required) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify `Tags` for the\n `TargetType` parameter.\n* `ResourceGroupName`\n \n + Description: (Required) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n `ResourceGroups` for the\n `TargetType` parameter.\n* `TargetAccounts`\n \n + Description: (Optional) The ID of the\n AWS account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either `TargetAccounts` or\n `TargetOrganizationalUnits`.\n* `TargetOrganizationalUnits`\n \n + Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nHost Management (Type: AWSQuickSetupType-SSMHostMgmt)\n* `UpdateSsmAgent`\n \n + Description: (Optional) A boolean value that\n determines whether the SSM Agent is updated on the\n target instances every 2 weeks. The default value\n is \"`true`\".\n* `UpdateEc2LaunchAgent`\n \n + Description: (Optional) A boolean value that\n determines whether the EC2 Launch agent is updated\n on the target instances every month. The default\n value is \"`false`\".\n* `CollectInventory`\n \n + Description: (Optional) A boolean value that\n determines whether instance metadata is collected\n on the target instances every 30 minutes. The\n default value is \"`true`\".\n* `ScanInstances`\n \n + Description: (Optional) A boolean value that\n determines whether the target instances are\n scanned daily for available patches. The default\n value is \"`true`\".\n* `InstallCloudWatchAgent`\n \n + Description: (Optional) A boolean value that\n determines whether the Amazon CloudWatch agent\n is installed on the target instances. The default\n value is \"`false`\".\n* `UpdateCloudWatchAgent`\n \n + Description: (Optional) A boolean value that\n determines whether the Amazon CloudWatch agent\n is updated on the target instances every month.\n The default value is \"`false`\".\n* `IsPolicyAttachAllowed`\n \n + Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies to\n instances profiles already associated with the\n target instances. The default value is\n \"`false`\".\n* `TargetType`\n \n + Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are `*`,\n `InstanceIds`,\n `ResourceGroups`, and\n `Tags`. Use `*` to target\n all instances in the account.\n* `TargetInstances`\n \n + Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n `InstanceIds` for the\n `TargetType` parameter.\n* `TargetTagKey`\n \n + Description: (Optional) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n `Tags` for the `TargetType`\n parameter.\n* `TargetTagValue`\n \n + Description: (Optional) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify `Tags` for the\n `TargetType` parameter.\n* `ResourceGroupName`\n \n + Description: (Optional) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n `ResourceGroups` for the\n `TargetType` parameter.\n* `TargetAccounts`\n \n + Description: (Optional) The ID of the\n AWS account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either `TargetAccounts` or\n `TargetOrganizationalUnits`.\n* `TargetOrganizationalUnits`\n \n + Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nOpsCenter (Type: AWSQuickSetupType-SSMOpsCenter)\n* `DelegatedAccountId`\n \n + Description: (Required) The ID of the\n delegated administrator account.\n* `TargetOrganizationalUnits`\n \n + Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nPatch Policy (Type: AWSQuickSetupType-PatchPolicy)\n* `PatchPolicyName`\n \n + Description: (Required) A name for the patch\n policy. The value you provide is applied to target\n Amazon EC2 instances as a tag.\n* `SelectedPatchBaselines`\n \n + Description: (Required) An array of JSON\n objects containing the information for the patch\n baselines to include in your patch policy.\n* `PatchBaselineUseDefault`\n \n + Description: (Optional) A value that\n determines whether the selected patch baselines\n are all AWS provided. Supported\n values are `default` and\n `custom`.\n* `PatchBaselineRegion`\n \n + Description: (Required) The AWS Region where the patch baseline\n exist.\n* `ConfigurationOptionsPatchOperation`\n \n + Description: (Optional) Determines whether\n target instances scan for available patches, or\n scan and install available patches. The valid\n values are `Scan` and\n `ScanAndInstall`. The default value for\n the parameter is `Scan`.\n* `ConfigurationOptionsScanValue`\n \n + Description: (Optional) A cron expression\n that is used as the schedule for when instances\n scan for available patches.\n* `ConfigurationOptionsInstallValue`\n \n + Description: (Optional) A cron expression\n that is used as the schedule for when instances\n install available patches.\n* `ConfigurationOptionsScanNextInterval`\n \n + Description: (Optional) A boolean value that\n determines whether instances should scan for\n available patches at the next cron interval. The\n default value is \"`false`\".\n* `ConfigurationOptionsInstallNextInterval`\n \n + Description: (Optional) A boolean value that\n determines whether instances should scan for\n available patches at the next cron interval. The\n default value is \"`false`\".\n* `RebootOption`\n \n + Description: (Optional) Determines whether\n instances are rebooted after patches are\n installed. Valid values are\n `RebootIfNeeded` and\n `NoReboot`.\n* `IsPolicyAttachAllowed`\n \n + Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies to\n instances profiles already associated with the\n target instances. The default value is\n \"`false`\".\n* `OutputLogEnableS3`\n \n + Description: (Optional) A boolean value that\n determines whether command output logs are sent to\n Amazon S3.\n* `OutputS3Location`\n \n + Description: (Optional) Information about\n the Amazon S3 bucket where you want to\n store the output details of the request.\n \n - `OutputBucketRegion`\n \n * Description: (Optional) The AWS Region where the Amazon S3\n bucket you want to deliver command output to is\n located.\n - `OutputS3BucketName`\n \n * Description: (Optional) The name of the\n Amazon S3 bucket you want to deliver\n command output to.\n - `OutputS3KeyPrefix`\n \n * Description: (Optional) The key prefix you\n want to use in the custom Amazon S3\n bucket.\n* `TargetType`\n \n + Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are `*`,\n `InstanceIds`,\n `ResourceGroups`, and\n `Tags`. Use `*` to target\n all instances in the account.\n* `TargetInstances`\n \n + Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n `InstanceIds` for the\n `TargetType` parameter.\n* `TargetTagKey`\n \n + Description: (Required) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n `Tags` for the `TargetType`\n parameter.\n* `TargetTagValue`\n \n + Description: (Required) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify `Tags` for the\n `TargetType` parameter.\n* `ResourceGroupName`\n \n + Description: (Required) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n `ResourceGroups` for the\n `TargetType` parameter.\n* `TargetAccounts`\n \n + Description: (Optional) The ID of the\n AWS account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either `TargetAccounts` or\n `TargetOrganizationalUnits`.\n* `TargetOrganizationalUnits`\n \n + Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nResource Explorer (Type: AWSQuickSetupType-ResourceExplorer)\n* `SelectedAggregatorRegion`\n \n + Description: (Required) The AWS Region where you want to create the\n aggregator index.\n* `ReplaceExistingAggregator`\n \n + Description: (Required) A boolean value that\n determines whether to demote an existing\n aggregator if it is in a Region that differs from\n the value you specify for the\n `SelectedAggregatorRegion`.\n* `TargetOrganizationalUnits`\n \n + Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\nResource Scheduler (Type: AWSQuickSetupType-Scheduler)\n* `TargetTagKey`\n \n + Description: (Required) The tag key assigned\n to the instances you want to target.\n* `TargetTagValue`\n \n + Description: (Required) The value of the tag\n key assigned to the instances you want to\n target.\n* `ICalendarString`\n \n + Description: (Required) An iCalendar\n formatted string containing the schedule you want\n Change Manager to use.\n* `TargetAccounts`\n \n + Description: (Optional) The ID of the\n AWS account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either `TargetAccounts` or\n `TargetOrganizationalUnits`.\n* `TargetOrganizationalUnits`\n \n + Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.\n* `TargetRegions`\n \n + Description: (Required) A comma separated\n list of AWS Regions you want to\n deploy the configuration to.\n\n*Required*: Yes\n*Type*: Object of String\n*Pattern*: `^[A-Za-z0-9+=@_\\/\\s-]+$`\n*Maximum*: `40960`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-parameters", "UpdateType": "Mutable", "Required": true, "Type": "Map", "PrimitiveItemType": "String" }, "LocalDeploymentExecutionRoleName": { "MarkdownDocumentation": "`LocalDeploymentExecutionRoleName`\n\nThe name of the IAM role used to deploy local\nconfigurations.\n###### Note\nAlthough this element is listed as \"Required: No\", a value can be omitted\nonly for organizational deployments of types other than\n`AWSQuickSetupType-PatchPolicy`. A value must be provided\nwhen you are running an organizational deployment for a patch policy or\nrunning any type of deployment for a single account.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-localdeploymentexecutionrolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeVersion": { "MarkdownDocumentation": "`TypeVersion`\n\nThe version of the Quick Setup type used.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-typeversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LocalDeploymentAdministrationRoleArn": { "MarkdownDocumentation": "`LocalDeploymentAdministrationRoleArn`\n\nThe ARN of the IAM role used to administrate local configuration\ndeployments.\n###### Note\nAlthough this element is listed as \"Required: No\", a value can be omitted\nonly for organizational deployments of types other than\n`AWSQuickSetupType-PatchPolicy`. A value must be provided\nwhen you are running an organizational deployment for a patch policy or\nrunning any type of deployment for a single account.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-cn|-us-gov)?: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-localdeploymentadministrationrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "id": { "MarkdownDocumentation": "`id`\n\nThe ID of the configuration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSMQuickSetup::ConfigurationManager.StatusSummary": { "MarkdownDocumentation": "`AWS::SSMQuickSetup::ConfigurationManager.StatusSummary`\n\nA summarized description of the status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe current status.\n*Required*: No\n*Type*: String\n*Allowed values*: `INITIALIZING | DEPLOYING | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INITIALIZING", "DEPLOYING", "SUCCEEDED", "DELETING", "STOPPING", "FAILED", "STOPPED", "DELETE_FAILED", "STOP_FAILED", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LastUpdatedAt": { "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe datetime stamp when the status was last 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-lastupdatedat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StatusType": { "MarkdownDocumentation": "`StatusType`\n\nThe type of a status summary.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Deployment | AsyncExecution...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Deployment", "AsyncExecutions" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-statustype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StatusDetails": { "MarkdownDocumentation": "`StatusDetails`\n\nDetails about the status.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-statusdetails", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "StatusMessage": { "MarkdownDocumentation": "`StatusMessage`\n\nWhen applicable, returns an informational message relevant to the current status\nand status type of the status summary object. We don't recommend implementing\nparsing logic around this value since the messages returned can vary in\nformat.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-statusmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSO::Application.PortalOptionsConfiguration": { "MarkdownDocumentation": "`AWS::SSO::Application.PortalOptionsConfiguration`\n\nA structure that describes the options for the portal associated with an\napplication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-portaloptionsconfiguration.html", "Properties": { "SignInOptions": { "MarkdownDocumentation": "`SignInOptions`\n\nA structure that describes the sign-in options for the access portal.\n*Required*: No\n*Type*: [SignInOptions](./aws-properties-sso-application-signinoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-portaloptionsconfiguration.html#cfn-sso-application-portaloptionsconfiguration-signinoptions", "UpdateType": "Mutable", "Required": false, "Type": "SignInOptions" }, "Visibility": { "MarkdownDocumentation": "`Visibility`\n\nIndicates whether this application is visible in the access portal.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-portaloptionsconfiguration.html#cfn-sso-application-portaloptionsconfiguration-visibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSO::Application.SignInOptions": { "MarkdownDocumentation": "`AWS::SSO::Application.SignInOptions`\n\nA structure that describes the sign-in options for an application portal.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-signinoptions.html", "Properties": { "Origin": { "MarkdownDocumentation": "`Origin`\n\nThis determines how IAM Identity Center navigates the user to the target application. It can be one\nof the following values:\n* `APPLICATION`: IAM Identity Center redirects the customer to the configured\n `ApplicationUrl`.\n* `IDENTITY_CENTER`: IAM Identity Center uses SAML identity-provider initiated\n authentication to sign the customer directly into a SAML-based\n application.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IDENTITY_CENTER | APPLICATI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IDENTITY_CENTER", "APPLICATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-signinoptions.html#cfn-sso-application-signinoptions-origin", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApplicationUrl": { "MarkdownDocumentation": "`ApplicationUrl`\n\nThe URL that accepts authentication requests for an application. This is a required\nparameter if the `Origin` parameter is `APPLICATION`.\n*Required*: No\n*Type*: String\n*Pattern*: `^http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-signinoptions.html#cfn-sso-application-signinoptions-applicationurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttribute": { "MarkdownDocumentation": "`AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttribute`\n\nThese are IAM Identity Center identity store attributes that you can configure for use\nin attributes-based access control (ABAC). You can create permissions policies that\ndetermine who can access your AWS resources based upon the configured\nattribute values. When you enable ABAC and specify `AccessControlAttributes`,\nIAM Identity Center passes the attribute values of the authenticated user into IAM for\nuse in policy evaluation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value used for mapping a specified attribute to an identity source.\n*Required*: Yes\n*Type*: [AccessControlAttributeValue](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html#cfn-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute-value", "UpdateType": "Mutable", "Required": true, "Type": "AccessControlAttributeValue" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name of the attribute associated with your identities in your identity source. This\nis used to map a specified attribute in your identity source with an attribute in IAM Identity Center.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html#cfn-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttributeValue": { "MarkdownDocumentation": "`AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttributeValue`\n\nThe value used for mapping a specified attribute to an identity source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributevalue.html", "Properties": { "Source": { "MarkdownDocumentation": "`Source`\n\nThe identity source to use when mapping a specified attribute to IAM Identity Center.\n*Required*: Yes\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributevalue.html#cfn-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributevalue-source", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SSO::PermissionSet.CustomerManagedPolicyReference": { "MarkdownDocumentation": "`AWS::SSO::PermissionSet.CustomerManagedPolicyReference`\n\nSpecifies 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe path to the IAM policy that you have configured in each account where you want\nto deploy your permission set. The default is `/`. For more information, see\n[Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `((/[A-Za-z0-9\\.,\\+@=_-]+)*)/`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html#cfn-sso-permissionset-customermanagedpolicyreference-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the IAM policy that you have configured in each account where you want\nto deploy your permission set.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html#cfn-sso-permissionset-customermanagedpolicyreference-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSO::PermissionSet.PermissionsBoundary": { "MarkdownDocumentation": "`AWS::SSO::PermissionSet.PermissionsBoundary`\n\nSpecifies the configuration of the AWS managed or customer managed policy that you\nwant to set as a permissions boundary. Specify either\n`CustomerManagedPolicyReference` to use the name and path of a customer\nmanaged policy, or `ManagedPolicyArn` to use the ARN of an AWS managed\npolicy. A permissions boundary represents the maximum permissions that any policy can\ngrant your role. For more information, see [Permissions boundaries\nfor IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.\n###### Important\nPolicies used as permissions boundaries don't provide permissions. You must also\nattach an IAM policy to the role. To learn how the effective permissions for a\nrole are evaluated, see [IAM JSON\npolicy evaluation logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html", "Properties": { "CustomerManagedPolicyReference": { "MarkdownDocumentation": "`CustomerManagedPolicyReference`\n\nSpecifies 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html#cfn-sso-permissionset-permissionsboundary-customermanagedpolicyreference", "UpdateType": "Mutable", "Required": false, "Type": "CustomerManagedPolicyReference" }, "ManagedPolicyArn": { "MarkdownDocumentation": "`ManagedPolicyArn`\n\nThe AWS managed policy ARN that you want to attach to a permission set as a\npermissions boundary.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html#cfn-sso-permissionset-permissionsboundary-managedpolicyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::App.ResourceSpec": { "MarkdownDocumentation": "`AWS::SageMaker::App.ResourceSpec`\n\nSpecifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that\nthe version runs on.\n###### Note\nWhen both `SageMakerImageVersionArn` and `SageMakerImageArn` are passed, `SageMakerImageVersionArn` is used. Any updates to `SageMakerImageArn` will not take effect if `SageMakerImageVersionArn` already exists in the `ResourceSpec` because `SageMakerImageVersionArn` always takes precedence. To clear the value set for `SageMakerImageVersionArn`, pass `None` as the value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html", "Properties": { "LifecycleConfigArn": { "MarkdownDocumentation": "`LifecycleConfigArn`\n\nThe Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the\nResource.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-lifecycleconfigarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SageMakerImageArn": { "MarkdownDocumentation": "`SageMakerImageArn`\n\nThe ARN of the SageMaker AI image that the image version belongs to.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-sagemakerimagearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type that the image version runs on.\n###### Note\n**JupyterServer apps** only support the `system` value.\nFor **KernelGateway apps**, the `system`\nvalue is translated to `ml.t3.medium`. KernelGateway apps also support all other values for available\ninstance types.\n*Required*: No\n*Type*: String\n*Allowed values*: `system | ml.t3.micro | ml.t...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "system", "ml.t3.micro", "ml.t3.small", "ml.t3.medium", "ml.t3.large", "ml.t3.xlarge", "ml.t3.2xlarge", "ml.m5.large", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.8xlarge", "ml.m5.12xlarge", "ml.m5.16xlarge", "ml.m5.24xlarge", "ml.m5d.large", "ml.m5d.xlarge", "ml.m5d.2xlarge", "ml.m5d.4xlarge", "ml.m5d.8xlarge", "ml.m5d.12xlarge", "ml.m5d.16xlarge", "ml.m5d.24xlarge", "ml.c5.large", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.12xlarge", "ml.c5.18xlarge", "ml.c5.24xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", "ml.g4dn.xlarge", "ml.g4dn.2xlarge", "ml.g4dn.4xlarge", "ml.g4dn.8xlarge", "ml.g4dn.12xlarge", "ml.g4dn.16xlarge", "ml.r5.large", "ml.r5.xlarge", "ml.r5.2xlarge", "ml.r5.4xlarge", "ml.r5.8xlarge", "ml.r5.12xlarge", "ml.r5.16xlarge", "ml.r5.24xlarge", "ml.g5.xlarge", "ml.g5.2xlarge", "ml.g5.4xlarge", "ml.g5.8xlarge", "ml.g5.12xlarge", "ml.g5.16xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", "ml.g6.xlarge", "ml.g6.2xlarge", "ml.g6.4xlarge", "ml.g6.8xlarge", "ml.g6.12xlarge", "ml.g6.16xlarge", "ml.g6.24xlarge", "ml.g6.48xlarge", "ml.g6e.xlarge", "ml.g6e.2xlarge", "ml.g6e.4xlarge", "ml.g6e.8xlarge", "ml.g6e.12xlarge", "ml.g6e.16xlarge", "ml.g6e.24xlarge", "ml.g6e.48xlarge", "ml.geospatial.interactive", "ml.p4d.24xlarge", "ml.p4de.24xlarge", "ml.trn1.2xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.p5.48xlarge", "ml.p5e.48xlarge", "ml.p5en.48xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", "ml.m6i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.12xlarge", "ml.m6i.16xlarge", "ml.m6i.24xlarge", "ml.m6i.32xlarge", "ml.m7i.large", "ml.m7i.xlarge", "ml.m7i.2xlarge", "ml.m7i.4xlarge", "ml.m7i.8xlarge", "ml.m7i.12xlarge", "ml.m7i.16xlarge", "ml.m7i.24xlarge", "ml.m7i.48xlarge", "ml.c6i.large", "ml.c6i.xlarge", "ml.c6i.2xlarge", "ml.c6i.4xlarge", "ml.c6i.8xlarge", "ml.c6i.12xlarge", "ml.c6i.16xlarge", "ml.c6i.24xlarge", "ml.c6i.32xlarge", "ml.c7i.large", "ml.c7i.xlarge", "ml.c7i.2xlarge", "ml.c7i.4xlarge", "ml.c7i.8xlarge", "ml.c7i.12xlarge", "ml.c7i.16xlarge", "ml.c7i.24xlarge", "ml.c7i.48xlarge", "ml.r6i.large", "ml.r6i.xlarge", "ml.r6i.2xlarge", "ml.r6i.4xlarge", "ml.r6i.8xlarge", "ml.r6i.12xlarge", "ml.r6i.16xlarge", "ml.r6i.24xlarge", "ml.r6i.32xlarge", "ml.r7i.large", "ml.r7i.xlarge", "ml.r7i.2xlarge", "ml.r7i.4xlarge", "ml.r7i.8xlarge", "ml.r7i.12xlarge", "ml.r7i.16xlarge", "ml.r7i.24xlarge", "ml.r7i.48xlarge", "ml.m6id.large", "ml.m6id.xlarge", "ml.m6id.2xlarge", "ml.m6id.4xlarge", "ml.m6id.8xlarge", "ml.m6id.12xlarge", "ml.m6id.16xlarge", "ml.m6id.24xlarge", "ml.m6id.32xlarge", "ml.c6id.large", "ml.c6id.xlarge", "ml.c6id.2xlarge", "ml.c6id.4xlarge", "ml.c6id.8xlarge", "ml.c6id.12xlarge", "ml.c6id.16xlarge", "ml.c6id.24xlarge", "ml.c6id.32xlarge", "ml.r6id.large", "ml.r6id.xlarge", "ml.r6id.2xlarge", "ml.r6id.4xlarge", "ml.r6id.8xlarge", "ml.r6id.12xlarge", "ml.r6id.16xlarge", "ml.r6id.24xlarge", "ml.r6id.32xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-instancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SageMakerImageVersionArn": { "MarkdownDocumentation": "`SageMakerImageVersionArn`\n\nThe ARN of the image version created on the instance. To clear the value set for `SageMakerImageVersionArn`, pass `None` as the value.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-sagemakerimageversionarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::AppImageConfig.CodeEditorAppImageConfig": { "MarkdownDocumentation": "`AWS::SageMaker::AppImageConfig.CodeEditorAppImageConfig`\n\nThe configuration for the file system and kernels in a SageMaker image running as a Code Editor app.\nThe `FileSystemConfig` object is not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-codeeditorappimageconfig.html", "Properties": { "ContainerConfig": { "MarkdownDocumentation": "`ContainerConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [ContainerConfig](./aws-properties-sagemaker-appimageconfig-containerconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-codeeditorappimageconfig.html#cfn-sagemaker-appimageconfig-codeeditorappimageconfig-containerconfig", "UpdateType": "Mutable", "Required": false, "Type": "ContainerConfig" } } }, "AWS::SageMaker::AppImageConfig.ContainerConfig": { "MarkdownDocumentation": "`AWS::SageMaker::AppImageConfig.ContainerConfig`\n\nThe configuration used to run the application image container.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html", "Properties": { "ContainerEntrypoint": { "MarkdownDocumentation": "`ContainerEntrypoint`\n\nThe entrypoint used to run the application in the container.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerentrypoint", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ContainerEnvironmentVariables": { "MarkdownDocumentation": "`ContainerEnvironmentVariables`\n\nThe environment variables to set in the container\n*Required*: No\n*Type*: Array of [CustomImageContainerEnvironmentVariable](./aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerenvironmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomImageContainerEnvironmentVariable", "DuplicatesAllowed": true }, "ContainerArguments": { "MarkdownDocumentation": "`ContainerArguments`\n\nThe arguments for the container when you're running the application.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerarguments", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::AppImageConfig.CustomImageContainerEnvironmentVariable": { "MarkdownDocumentation": "`AWS::SageMaker::AppImageConfig.CustomImageContainerEnvironmentVariable`\n\nThe environment variables to set in the container\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the container environment variable.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html#cfn-sagemaker-appimageconfig-customimagecontainerenvironmentvariable-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key that identifies a container environment variable.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html#cfn-sagemaker-appimageconfig-customimagecontainerenvironmentvariable-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::AppImageConfig.FileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::AppImageConfig.FileSystemConfig`\n\nThe Amazon Elastic File System storage configuration for a SageMaker AI image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html", "Properties": { "MountPath": { "MarkdownDocumentation": "`MountPath`\n\nThe path within the image to mount the user's EFS home directory. The directory\nshould be empty. If not specified, defaults to */home/sagemaker-user*.\n*Required*: No\n*Type*: String\n*Pattern*: `^/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-mountpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultGid": { "MarkdownDocumentation": "`DefaultGid`\n\nThe default POSIX group ID (GID). If not specified, defaults to `100`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-defaultgid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DefaultUid": { "MarkdownDocumentation": "`DefaultUid`\n\nThe default POSIX user ID (UID). If not specified, defaults to `1000`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-defaultuid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::AppImageConfig.JupyterLabAppImageConfig": { "MarkdownDocumentation": "`AWS::SageMaker::AppImageConfig.JupyterLabAppImageConfig`\n\nThe configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app. The `FileSystemConfig` object is not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-jupyterlabappimageconfig.html", "Properties": { "ContainerConfig": { "MarkdownDocumentation": "`ContainerConfig`\n\nThe configuration used to run the application image container.\n*Required*: No\n*Type*: [ContainerConfig](./aws-properties-sagemaker-appimageconfig-containerconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-jupyterlabappimageconfig.html#cfn-sagemaker-appimageconfig-jupyterlabappimageconfig-containerconfig", "UpdateType": "Mutable", "Required": false, "Type": "ContainerConfig" } } }, "AWS::SageMaker::AppImageConfig.KernelGatewayImageConfig": { "MarkdownDocumentation": "`AWS::SageMaker::AppImageConfig.KernelGatewayImageConfig`\n\nThe configuration for the file system and kernels in a SageMaker AI image running as a\nKernelGateway app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html", "Properties": { "KernelSpecs": { "MarkdownDocumentation": "`KernelSpecs`\n\nThe specification of the Jupyter kernels in the image.\n*Required*: Yes\n*Type*: Array of [KernelSpec](./aws-properties-sagemaker-appimageconfig-kernelspec.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig-kernelspecs", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "KernelSpec", "DuplicatesAllowed": true }, "FileSystemConfig": { "MarkdownDocumentation": "`FileSystemConfig`\n\nThe Amazon Elastic File System storage configuration for a SageMaker AI image.\n*Required*: No\n*Type*: [FileSystemConfig](./aws-properties-sagemaker-appimageconfig-filesystemconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig-filesystemconfig", "UpdateType": "Mutable", "Required": false, "Type": "FileSystemConfig" } } }, "AWS::SageMaker::AppImageConfig.KernelSpec": { "MarkdownDocumentation": "`AWS::SageMaker::AppImageConfig.KernelSpec`\n\nThe specification of a Jupyter kernel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html", "Properties": { "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the kernel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html#cfn-sagemaker-appimageconfig-kernelspec-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Jupyter kernel in the image. This value is case sensitive.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html#cfn-sagemaker-appimageconfig-kernelspec-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Cluster.AlarmDetails": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.AlarmDetails`\n\nThe details of the alarm to monitor during the AMI update.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-alarmdetails.html", "Properties": { "AlarmName": { "MarkdownDocumentation": "`AlarmName`\n\nThe name of the alarm.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?!\\s*$).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-alarmdetails.html#cfn-sagemaker-cluster-alarmdetails-alarmname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Cluster.CapacitySizeConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.CapacitySizeConfig`\n\nThe configuration of the size measurements of the AMI update. Using this configuration,\nyou can specify whether SageMaker should update your instance group by an amount or percentage\nof instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-capacitysizeconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies whether SageMaker should process the update by amount or percentage of\ninstances.\n*Required*: Yes\n*Type*: String\n*Pattern*: `INSTANCE_COUNT|CAPACITY_PERCENTAGE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-capacitysizeconfig.html#cfn-sagemaker-cluster-capacitysizeconfig-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nSpecifies the amount or percentage of instances SageMaker updates at a time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-capacitysizeconfig.html#cfn-sagemaker-cluster-capacitysizeconfig-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Cluster.ClusterAutoScalingConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterAutoScalingConfig`\n\nSpecifies the autoscaling configuration for a HyperPod cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterautoscalingconfig.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nDescribes whether autoscaling is enabled or disabled for the cluster. Valid values are\n`Enable` and `Disable`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Enable | Disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enable", "Disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterautoscalingconfig.html#cfn-sagemaker-cluster-clusterautoscalingconfig-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AutoScalerType": { "MarkdownDocumentation": "`AutoScalerType`\n\nThe type of autoscaler to use. Currently supported value is\n`Karpenter`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Karpenter`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "Karpenter" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterautoscalingconfig.html#cfn-sagemaker-cluster-clusterautoscalingconfig-autoscalertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Cluster.ClusterCapacityRequirements": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterCapacityRequirements`\n\nDefines the instance capacity requirements for an instance group,\nincluding configurations for both Spot and On-Demand capacity types.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clustercapacityrequirements.html", "Properties": { "Spot": { "MarkdownDocumentation": "`Spot`\n\nConfiguration options specific to Spot instances.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clustercapacityrequirements.html#cfn-sagemaker-cluster-clustercapacityrequirements-spot", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "OnDemand": { "MarkdownDocumentation": "`OnDemand`\n\nConfiguration options specific to On-Demand instances.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clustercapacityrequirements.html#cfn-sagemaker-cluster-clustercapacityrequirements-ondemand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::SageMaker::Cluster.ClusterEbsVolumeConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterEbsVolumeConfig`\n\nDefines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\nvolume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see [SageMaker HyperPod release notes: June 20, 2024](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html", "Properties": { "VolumeSizeInGB": { "MarkdownDocumentation": "`VolumeSizeInGB`\n\nThe size in gigabytes (GB) of the additional EBS volume to be attached to the instances\nin the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each\ninstance within the SageMaker HyperPod cluster instance group and mounted to\n`/opt/sagemaker`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumesizeingb", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeKmsKeyId": { "MarkdownDocumentation": "`VolumeKmsKeyId`\n\nThe ID of a KMS key to encrypt the Amazon EBS volume.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9:/_-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumekmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RootVolume": { "MarkdownDocumentation": "`RootVolume`\n\nSpecifies whether the configuration is for the cluster's root or secondary Amazon EBS\nvolume. You can specify two `ClusterEbsVolumeConfig` fields to configure both\nthe root and secondary volumes. Set the value to `True` if you'd like to provide\nyour own customer managed AWS KMS key to encrypt the root volume. When\n`True`:\n* The configuration is applied to the root volume.\n* You can't specify the `VolumeSizeInGB` field. The size of the root\n volume is determined for you.\n* You must specify a KMS key ID for `VolumeKmsKeyId` to encrypt the\n root volume with your own KMS key instead of an AWS owned\n KMS key.\nOtherwise, by default, the value is `False`, and the following\napplies:\n* The configuration is applied to the secondary volume, while the root volume is\n encrypted with an AWS owned key.\n* You must specify the `VolumeSizeInGB` field.\n* You can optionally specify the `VolumeKmsKeyId` to encrypt the\n secondary volume with your own KMS key instead of an AWS owned\n KMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html#cfn-sagemaker-cluster-clusterebsvolumeconfig-rootvolume", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SageMaker::Cluster.ClusterInstanceGroup": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterInstanceGroup`\n\nThe configuration information of the instance group within the HyperPod cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html", "Properties": { "CapacityRequirements": { "MarkdownDocumentation": "`CapacityRequirements`\n\nProperty description not available.\n*Required*: No\n*Type*: [ClusterCapacityRequirements](./aws-properties-sagemaker-cluster-clustercapacityrequirements.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-capacityrequirements", "UpdateType": "Mutable", "Required": false, "Type": "ClusterCapacityRequirements" }, "InstanceGroupName": { "MarkdownDocumentation": "`InstanceGroupName`\n\nThe name of the instance group of a SageMaker HyperPod cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancegroupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InstanceStorageConfigs": { "MarkdownDocumentation": "`InstanceStorageConfigs`\n\nThe configurations of additional storage specified to the instance group where the\ninstance (node) is launched.\n*Required*: No\n*Type*: Array of [ClusterInstanceStorageConfig](./aws-properties-sagemaker-cluster-clusterinstancestorageconfig.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancestorageconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ClusterInstanceStorageConfig", "DuplicatesAllowed": true }, "KubernetesConfig": { "MarkdownDocumentation": "`KubernetesConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [ClusterKubernetesConfig](./aws-properties-sagemaker-cluster-clusterkubernetesconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-kubernetesconfig", "UpdateType": "Mutable", "Required": false, "Type": "ClusterKubernetesConfig" }, "LifeCycleConfig": { "MarkdownDocumentation": "`LifeCycleConfig`\n\nThe lifecycle configuration for a SageMaker HyperPod cluster.\n*Required*: Yes\n*Type*: [ClusterLifeCycleConfig](./aws-properties-sagemaker-cluster-clusterlifecycleconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-lifecycleconfig", "UpdateType": "Mutable", "Required": true, "Type": "ClusterLifeCycleConfig" }, "TrainingPlanArn": { "MarkdownDocumentation": "`TrainingPlanArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-plan/.*$`\n*Minimum*: `50`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-trainingplanarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThreadsPerCore": { "MarkdownDocumentation": "`ThreadsPerCore`\n\nThe number of threads per CPU core you specified under\n`CreateCluster`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-threadspercore", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OverrideVpcConfig": { "MarkdownDocumentation": "`OverrideVpcConfig`\n\nThe customized Amazon VPC configuration at the instance group level that\noverrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-sagemaker-cluster-vpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-overridevpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfig" }, "InstanceCount": { "MarkdownDocumentation": "`InstanceCount`\n\nThe number of instances in an instance group of the SageMaker HyperPod cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancecount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "OnStartDeepHealthChecks": { "MarkdownDocumentation": "`OnStartDeepHealthChecks`\n\nA flag indicating whether deep health checks should be performed when the HyperPod\ncluster instance group is created or updated. Deep health checks are comprehensive,\ninvasive tests that validate the health of the underlying hardware and infrastructure\ncomponents.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-onstartdeephealthchecks", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^ami-[0-9a-fA-F]{8,17}|default$`\n*Minimum*: `7`\n*Maximum*: `21`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-imageid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CurrentCount": { "MarkdownDocumentation": "`CurrentCount`\n\nThe number of instances that are currently in the instance group of a SageMaker HyperPod\ncluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-currentcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ScheduledUpdateConfig": { "MarkdownDocumentation": "`ScheduledUpdateConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [ScheduledUpdateConfig](./aws-properties-sagemaker-cluster-scheduledupdateconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-scheduledupdateconfig", "UpdateType": "Mutable", "Required": false, "Type": "ScheduledUpdateConfig" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type of the instance group of a SageMaker HyperPod cluster.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ml.p4d.24xlarge | ml.p4de.2...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ml.p4d.24xlarge", "ml.p4de.24xlarge", "ml.p5.48xlarge", "ml.p5.4xlarge", "ml.p6e-gb200.36xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.g5.xlarge", "ml.g5.2xlarge", "ml.g5.4xlarge", "ml.g5.8xlarge", "ml.g5.12xlarge", "ml.g5.16xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", "ml.c5.large", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.12xlarge", "ml.c5.18xlarge", "ml.c5.24xlarge", "ml.c5n.large", "ml.c5n.2xlarge", "ml.c5n.4xlarge", "ml.c5n.9xlarge", "ml.c5n.18xlarge", "ml.m5.large", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.8xlarge", "ml.m5.12xlarge", "ml.m5.16xlarge", "ml.m5.24xlarge", "ml.t3.medium", "ml.t3.large", "ml.t3.xlarge", "ml.t3.2xlarge", "ml.g6.xlarge", "ml.g6.2xlarge", "ml.g6.4xlarge", "ml.g6.8xlarge", "ml.g6.16xlarge", "ml.g6.12xlarge", "ml.g6.24xlarge", "ml.g6.48xlarge", "ml.gr6.4xlarge", "ml.gr6.8xlarge", "ml.g6e.xlarge", "ml.g6e.2xlarge", "ml.g6e.4xlarge", "ml.g6e.8xlarge", "ml.g6e.16xlarge", "ml.g6e.12xlarge", "ml.g6e.24xlarge", "ml.g6e.48xlarge", "ml.p5e.48xlarge", "ml.p5en.48xlarge", "ml.p6-b200.48xlarge", "ml.trn2.3xlarge", "ml.trn2.48xlarge", "ml.c6i.large", "ml.c6i.xlarge", "ml.c6i.2xlarge", "ml.c6i.4xlarge", "ml.c6i.8xlarge", "ml.c6i.12xlarge", "ml.c6i.16xlarge", "ml.c6i.24xlarge", "ml.c6i.32xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", "ml.m6i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.12xlarge", "ml.m6i.16xlarge", "ml.m6i.24xlarge", "ml.m6i.32xlarge", "ml.r6i.large", "ml.r6i.xlarge", "ml.r6i.2xlarge", "ml.r6i.4xlarge", "ml.r6i.8xlarge", "ml.r6i.12xlarge", "ml.r6i.16xlarge", "ml.r6i.24xlarge", "ml.r6i.32xlarge", "ml.i3en.large", "ml.i3en.xlarge", "ml.i3en.2xlarge", "ml.i3en.3xlarge", "ml.i3en.6xlarge", "ml.i3en.12xlarge", "ml.i3en.24xlarge", "ml.m7i.large", "ml.m7i.xlarge", "ml.m7i.2xlarge", "ml.m7i.4xlarge", "ml.m7i.8xlarge", "ml.m7i.12xlarge", "ml.m7i.16xlarge", "ml.m7i.24xlarge", "ml.m7i.48xlarge", "ml.r7i.large", "ml.r7i.xlarge", "ml.r7i.2xlarge", "ml.r7i.4xlarge", "ml.r7i.8xlarge", "ml.r7i.12xlarge", "ml.r7i.16xlarge", "ml.r7i.24xlarge", "ml.r7i.48xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe execution role for the instance group to assume.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MinInstanceCount": { "MarkdownDocumentation": "`MinInstanceCount`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-mininstancecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Cluster.ClusterInstanceStorageConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterInstanceStorageConfig`\n\nDefines the configuration for attaching additional storage to the instances in the\nSageMaker HyperPod cluster instance group. To learn more, see [SageMaker HyperPod release notes: June 20, 2024](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancestorageconfig.html", "Properties": { "EbsVolumeConfig": { "MarkdownDocumentation": "`EbsVolumeConfig`\n\nDefines the configuration for attaching additional Amazon Elastic Block Store (EBS)\nvolumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is\nattached to each instance within the SageMaker HyperPod cluster instance group and mounted to\n`/opt/sagemaker`.\n*Required*: No\n*Type*: [ClusterEbsVolumeConfig](./aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancestorageconfig.html#cfn-sagemaker-cluster-clusterinstancestorageconfig-ebsvolumeconfig", "UpdateType": "Mutable", "Required": false, "Type": "ClusterEbsVolumeConfig" } } }, "AWS::SageMaker::Cluster.ClusterKubernetesConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterKubernetesConfig`\n\nKubernetes configuration that specifies labels and taints to be applied\nto cluster nodes in an instance group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterkubernetesconfig.html", "Properties": { "Labels": { "MarkdownDocumentation": "`Labels`\n\nKey-value pairs of labels to be applied to cluster nodes.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterkubernetesconfig.html#cfn-sagemaker-cluster-clusterkubernetesconfig-labels", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Taints": { "MarkdownDocumentation": "`Taints`\n\nList of taints to be applied to cluster nodes.\n*Required*: No\n*Type*: Array of [ClusterKubernetesTaint](./aws-properties-sagemaker-cluster-clusterkubernetestaint.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterkubernetesconfig.html#cfn-sagemaker-cluster-clusterkubernetesconfig-taints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ClusterKubernetesTaint", "DuplicatesAllowed": true } } }, "AWS::SageMaker::Cluster.ClusterKubernetesTaint": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterKubernetesTaint`\n\nA Kubernetes taint that can be applied to cluster nodes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterkubernetestaint.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the taint.\n*Required*: No\n*Type*: String\n*Pattern*: `(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterkubernetestaint.html#cfn-sagemaker-cluster-clusterkubernetestaint-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Effect": { "MarkdownDocumentation": "`Effect`\n\nThe effect of the taint. Valid values are\n`NoSchedule`, `PreferNoSchedule`,\nand `NoExecute`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NoSchedule | PreferNoSchedu...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NoSchedule", "PreferNoSchedule", "NoExecute" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterkubernetestaint.html#cfn-sagemaker-cluster-clusterkubernetestaint-effect", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the taint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?[A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?`\n*Minimum*: `1`\n*Maximum*: `317`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterkubernetestaint.html#cfn-sagemaker-cluster-clusterkubernetestaint-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Cluster.ClusterLifeCycleConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterLifeCycleConfig`\n\nThe lifecycle configuration for a SageMaker HyperPod cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html", "Properties": { "SourceS3Uri": { "MarkdownDocumentation": "`SourceS3Uri`\n\nAn Amazon S3 bucket path where your lifecycle scripts are stored.\n###### Important\nMake sure that the S3 bucket path starts with `s3://sagemaker-`. The\n[IAM role for SageMaker HyperPod](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-iam-role-for-hyperpod) has the managed [`AmazonSageMakerClusterInstanceRolePolicy`](https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-cluster.html) attached, which\nallows access to S3 buckets with the specific prefix `sagemaker-`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html#cfn-sagemaker-cluster-clusterlifecycleconfig-sources3uri", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "OnCreate": { "MarkdownDocumentation": "`OnCreate`\n\nThe file name of the entrypoint script of lifecycle scripts under\n`SourceS3Uri`. This entrypoint script runs during cluster creation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\S\\s]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html#cfn-sagemaker-cluster-clusterlifecycleconfig-oncreate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Cluster.ClusterOrchestratorEksConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterOrchestratorEksConfig`\n\nThe configuration for the Amazon EKS cluster that is used as the orchestrator for the\nSageMaker HyperPod cluster. This includes the Amazon Resource Name (ARN) of the EKS\ncluster\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterorchestratoreksconfig.html", "Properties": { "ClusterArn": { "MarkdownDocumentation": "`ClusterArn`\n\nThe Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterorchestratoreksconfig.html#cfn-sagemaker-cluster-clusterorchestratoreksconfig-clusterarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Cluster.ClusterRestrictedInstanceGroup": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ClusterRestrictedInstanceGroup`\n\nThe `ClusterRestrictedInstanceGroup` property type specifies Property description not available. for an [AWS::SageMaker::Cluster](./aws-resource-sagemaker-cluster.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html", "Properties": { "OverrideVpcConfig": { "MarkdownDocumentation": "`OverrideVpcConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-sagemaker-cluster-vpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-overridevpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfig" }, "InstanceCount": { "MarkdownDocumentation": "`InstanceCount`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancecount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "OnStartDeepHealthChecks": { "MarkdownDocumentation": "`OnStartDeepHealthChecks`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-onstartdeephealthchecks", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnvironmentConfig": { "MarkdownDocumentation": "`EnvironmentConfig`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [EnvironmentConfig](./aws-properties-sagemaker-cluster-environmentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-environmentconfig", "UpdateType": "Mutable", "Required": true, "Type": "EnvironmentConfig" }, "InstanceGroupName": { "MarkdownDocumentation": "`InstanceGroupName`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancegroupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InstanceStorageConfigs": { "MarkdownDocumentation": "`InstanceStorageConfigs`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [ClusterInstanceStorageConfig](./aws-properties-sagemaker-cluster-clusterinstancestorageconfig.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancestorageconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ClusterInstanceStorageConfig", "DuplicatesAllowed": true }, "CurrentCount": { "MarkdownDocumentation": "`CurrentCount`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-currentcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TrainingPlanArn": { "MarkdownDocumentation": "`TrainingPlanArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-plan/.*$`\n*Minimum*: `50`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-trainingplanarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ThreadsPerCore": { "MarkdownDocumentation": "`ThreadsPerCore`\n\nProperty description not available.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-threadspercore", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Cluster.DeploymentConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.DeploymentConfig`\n\nThe deployment configuration for an endpoint, which contains the desired deployment\nstrategy and rollback configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deploymentconfig.html", "Properties": { "AutoRollbackConfiguration": { "MarkdownDocumentation": "`AutoRollbackConfiguration`\n\nAutomatic rollback configuration for handling endpoint deployment failures and\nrecovery.\n*Required*: No\n*Type*: Array of [AlarmDetails](./aws-properties-sagemaker-cluster-alarmdetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deploymentconfig.html#cfn-sagemaker-cluster-deploymentconfig-autorollbackconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AlarmDetails", "DuplicatesAllowed": true }, "RollingUpdatePolicy": { "MarkdownDocumentation": "`RollingUpdatePolicy`\n\nSpecifies a rolling deployment strategy for updating a SageMaker endpoint.\n*Required*: No\n*Type*: [RollingUpdatePolicy](./aws-properties-sagemaker-cluster-rollingupdatepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deploymentconfig.html#cfn-sagemaker-cluster-deploymentconfig-rollingupdatepolicy", "UpdateType": "Mutable", "Required": false, "Type": "RollingUpdatePolicy" }, "WaitIntervalInSeconds": { "MarkdownDocumentation": "`WaitIntervalInSeconds`\n\nProperty description not available.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deploymentconfig.html#cfn-sagemaker-cluster-deploymentconfig-waitintervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Cluster.EnvironmentConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.EnvironmentConfig`\n\nThe configuration for the restricted instance groups (RIG) environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-environmentconfig.html", "Properties": { "FSxLustreConfig": { "MarkdownDocumentation": "`FSxLustreConfig`\n\nConfiguration settings for an Amazon FSx for Lustre file system to be used with the cluster.\n*Required*: No\n*Type*: [FSxLustreConfig](./aws-properties-sagemaker-cluster-fsxlustreconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-environmentconfig.html#cfn-sagemaker-cluster-environmentconfig-fsxlustreconfig", "UpdateType": "Mutable", "Required": false, "Type": "FSxLustreConfig" } } }, "AWS::SageMaker::Cluster.FSxLustreConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.FSxLustreConfig`\n\nConfiguration settings for an Amazon FSx for Lustre file system to be used with the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-fsxlustreconfig.html", "Properties": { "SizeInGiB": { "MarkdownDocumentation": "`SizeInGiB`\n\nThe storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1200`\n*Maximum*: `100800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-fsxlustreconfig.html#cfn-sagemaker-cluster-fsxlustreconfig-sizeingib", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "PerUnitStorageThroughput": { "MarkdownDocumentation": "`PerUnitStorageThroughput`\n\nThe throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of\nstorage.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `125`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-fsxlustreconfig.html#cfn-sagemaker-cluster-fsxlustreconfig-perunitstoragethroughput", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Cluster.Orchestrator": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.Orchestrator`\n\nThe orchestrator for a SageMaker HyperPod cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-orchestrator.html", "Properties": { "Eks": { "MarkdownDocumentation": "`Eks`\n\nThe configuration of the Amazon EKS orchestrator cluster for the SageMaker HyperPod\ncluster.\n*Required*: Yes\n*Type*: [ClusterOrchestratorEksConfig](./aws-properties-sagemaker-cluster-clusterorchestratoreksconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-orchestrator.html#cfn-sagemaker-cluster-orchestrator-eks", "UpdateType": "Immutable", "Required": true, "Type": "ClusterOrchestratorEksConfig" } } }, "AWS::SageMaker::Cluster.RollingUpdatePolicy": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.RollingUpdatePolicy`\n\nSpecifies a rolling deployment strategy for updating a SageMaker endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-rollingupdatepolicy.html", "Properties": { "MaximumBatchSize": { "MarkdownDocumentation": "`MaximumBatchSize`\n\nBatch size for each rolling step to provision capacity and turn on traffic on the new\nendpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between\n5% to 50% of the variant's total instance count.\n*Required*: Yes\n*Type*: [CapacitySizeConfig](./aws-properties-sagemaker-cluster-capacitysizeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-rollingupdatepolicy.html#cfn-sagemaker-cluster-rollingupdatepolicy-maximumbatchsize", "UpdateType": "Mutable", "Required": true, "Type": "CapacitySizeConfig" }, "RollbackMaximumBatchSize": { "MarkdownDocumentation": "`RollbackMaximumBatchSize`\n\nBatch size for rollback to the old endpoint fleet. Each rolling step to provision\ncapacity and turn on traffic on the old endpoint fleet, and terminate capacity on the\nnew endpoint fleet. If this field is absent, the default value will be set to 100% of\ntotal capacity which means to bring up the whole capacity of the old fleet at once\nduring rollback.\n*Required*: No\n*Type*: [CapacitySizeConfig](./aws-properties-sagemaker-cluster-capacitysizeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-rollingupdatepolicy.html#cfn-sagemaker-cluster-rollingupdatepolicy-rollbackmaximumbatchsize", "UpdateType": "Mutable", "Required": false, "Type": "CapacitySizeConfig" } } }, "AWS::SageMaker::Cluster.ScheduledUpdateConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.ScheduledUpdateConfig`\n\nThe configuration object of the schedule that SageMaker follows when updating the AMI.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-scheduledupdateconfig.html", "Properties": { "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nA cron expression that specifies the schedule that SageMaker follows when updating the\nAMI.\n*Required*: Yes\n*Type*: String\n*Pattern*: `cron\\((?:[0-5][0-9]|[0-9]|) (?:[01][0-9]|2[0-3]|[0-9]) (?:[1-9]|0[1-9]|[12][0-9]|3[01]|\\?) (?:[1-9]|0[1-9]|1[0-2]|\\*|\\*/(?:[1-9]|1[0-2])|) (?:MON|TUE|WED|THU|FRI|SAT|SUN|[1-7]|\\?|L|(?:[1-7]#[1-5])|(?:[1-7]L)) (?:20[2-9][0-9]|\\*|)\\)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-scheduledupdateconfig.html#cfn-sagemaker-cluster-scheduledupdateconfig-scheduleexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DeploymentConfig": { "MarkdownDocumentation": "`DeploymentConfig`\n\nThe configuration to use when updating the AMI versions.\n*Required*: No\n*Type*: [DeploymentConfig](./aws-properties-sagemaker-cluster-deploymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-scheduledupdateconfig.html#cfn-sagemaker-cluster-scheduledupdateconfig-deploymentconfig", "UpdateType": "Mutable", "Required": false, "Type": "DeploymentConfig" } } }, "AWS::SageMaker::Cluster.TieredStorageConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.TieredStorageConfig`\n\nThe `TieredStorageConfig` property type specifies Property description not available. for an [AWS::SageMaker::Cluster](./aws-resource-sagemaker-cluster.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-tieredstorageconfig.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Enable | Disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enable", "Disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-tieredstorageconfig.html#cfn-sagemaker-cluster-tieredstorageconfig-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InstanceMemoryAllocationPercentage": { "MarkdownDocumentation": "`InstanceMemoryAllocationPercentage`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-tieredstorageconfig.html#cfn-sagemaker-cluster-tieredstorageconfig-instancememoryallocationpercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Cluster.VpcConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster.VpcConfig`\n\nSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources\nhave access to. You can control access to and from your resources by configuring a VPC.\nFor more information, see [Give SageMaker Access to\nResources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-vpcconfig.html", "Properties": { "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe VPC security group IDs, in the form `sg-xxxxxxxx`. Specify the security\ngroups for the VPC that is specified in the `Subnets` field.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `32 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-vpcconfig.html#cfn-sagemaker-cluster-vpcconfig-securitygroupids", "UpdateType": "Conditional", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe ID of the subnets in the VPC to which you want to connect your training job or\nmodel. For information about the availability of specific instance types, see [Supported\nInstance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html).\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `32 | 16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-vpcconfig.html#cfn-sagemaker-cluster-vpcconfig-subnets", "UpdateType": "Conditional", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::CodeRepository.GitConfig": { "MarkdownDocumentation": "`AWS::SageMaker::CodeRepository.GitConfig`\n\nSpecifies configuration details for a Git repository in your AWS\naccount.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html", "Properties": { "SecretArn": { "Required": false, "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret that\ncontains the credentials used to access the git repository. The secret must have a\nstaging label of `AWSCURRENT` and must be in the following format:\n`{\"username\": UserName, \"password\":\nPassword}`\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-secretarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Branch": { "Required": false, "MarkdownDocumentation": "`Branch`\n\nThe default branch for the Git repository.\n*Required*: No\n*Type*: String\n*Pattern*: `[^ ~^:?*\\[]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-branch", "PrimitiveType": "String", "UpdateType": "Immutable" }, "RepositoryUrl": { "Required": true, "MarkdownDocumentation": "`RepositoryUrl`\n\nThe URL where the Git repository is located.\n*Required*: Yes\n*Type*: String\n*Pattern*: `https://([^/]+)/?.{3,1016}`\n*Minimum*: `11`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-repositoryurl", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::DataQualityJobDefinition.BatchTransformInput": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.BatchTransformInput`\n\nInput object for the batch transform job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html", "Properties": { "DatasetFormat": { "MarkdownDocumentation": "`DatasetFormat`\n\nThe dataset format for your batch transform job.\n*Required*: Yes\n*Type*: [DatasetFormat](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-datasetformat", "UpdateType": "Immutable", "Required": true, "Type": "DatasetFormat" }, "S3DataDistributionType": { "MarkdownDocumentation": "`S3DataDistributionType`\n\nWhether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.\nDefaults to `FullyReplicated`\n*Required*: No\n*Type*: String\n*Allowed values*: `FullyReplicated | ShardedBy...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FullyReplicated", "ShardedByS3Key" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-s3datadistributiontype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DataCapturedDestinationS3Uri": { "MarkdownDocumentation": "`DataCapturedDestinationS3Uri`\n\nThe Amazon S3 location being used to capture the data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-datacaptureddestinations3uri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3InputMode": { "MarkdownDocumentation": "`S3InputMode`\n\nWhether the `Pipe` or `File` is used as the input mode for\ntransferring data for the monitoring job. `Pipe` mode is recommended for large\ndatasets. `File` mode is useful for small files that fit in memory. Defaults to\n`File`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Pipe | File...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Pipe", "File" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-s3inputmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LocalPath": { "MarkdownDocumentation": "`LocalPath`\n\nPath to the filesystem where the batch transform data is available to the container.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-localpath", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ExcludeFeaturesAttribute": { "MarkdownDocumentation": "`ExcludeFeaturesAttribute`\n\nThe attributes of the input data to exclude from the analysis.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-excludefeaturesattribute", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::DataQualityJobDefinition.ClusterConfig": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.ClusterConfig`\n\nThe configuration for the cluster of resources used to run the processing job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html", "Properties": { "InstanceCount": { "MarkdownDocumentation": "`InstanceCount`\n\nThe number of ML compute instances to use in the model monitoring job. For distributed\nprocessing jobs, specify a value greater than 1. The default value is 1.\n*Required*: Yes\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html#cfn-sagemaker-dataqualityjobdefinition-clusterconfig-instancecount", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "VolumeSizeInGB": { "MarkdownDocumentation": "`VolumeSizeInGB`\n\nThe size of the ML storage volume, in gigabytes, that you want to provision. You must\nspecify sufficient ML storage for your scenario.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `16384`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html#cfn-sagemaker-dataqualityjobdefinition-clusterconfig-volumesizeingb", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "VolumeKmsKeyId": { "MarkdownDocumentation": "`VolumeKmsKeyId`\n\nThe AWS Key Management Service (AWS KMS) key that\nAmazon SageMaker uses to encrypt data on the storage volume attached to the ML compute\ninstance(s) that run the model monitoring job.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html#cfn-sagemaker-dataqualityjobdefinition-clusterconfig-volumekmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html#cfn-sagemaker-dataqualityjobdefinition-clusterconfig-instancetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::DataQualityJobDefinition.ConstraintsResource": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.ConstraintsResource`\n\nThe constraints resource for a monitoring job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-constraintsresource.html", "Properties": { "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe Amazon S3 URI for the constraints resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-constraintsresource.html#cfn-sagemaker-dataqualityjobdefinition-constraintsresource-s3uri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::DataQualityJobDefinition.Csv": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.Csv`\n\nThe `Csv` property type specifies Property description not available. for an [AWS::SageMaker::DataQualityJobDefinition](./aws-resource-sagemaker-dataqualityjobdefinition.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-csv.html", "Properties": { "Header": { "MarkdownDocumentation": "`Header`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-csv.html#cfn-sagemaker-dataqualityjobdefinition-csv-header", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SageMaker::DataQualityJobDefinition.DataQualityAppSpecification": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.DataQualityAppSpecification`\n\nInformation about the container that a data quality monitoring job runs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html", "Properties": { "ContainerEntrypoint": { "MarkdownDocumentation": "`ContainerEntrypoint`\n\nThe entrypoint for a container used to run a monitoring job.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `256 | 100`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-containerentrypoint", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PostAnalyticsProcessorSourceUri": { "MarkdownDocumentation": "`PostAnalyticsProcessorSourceUri`\n\nAn Amazon S3 URI to a script that is called after analysis has been performed. Applicable\nonly for the built-in (first party) containers.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-postanalyticsprocessorsourceuri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RecordPreprocessorSourceUri": { "MarkdownDocumentation": "`RecordPreprocessorSourceUri`\n\nAn Amazon S3 URI to a script that is called per row prior to running analysis. It can\nbase64 decode the payload and convert it into a flattened JSON so that the built-in container can use\nthe converted data. Applicable only for the built-in (first party) containers.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-recordpreprocessorsourceuri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nSets the environment variables in the container that the monitoring job runs.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `[a-zA-Z_][a-zA-Z0-9_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-environment", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ImageUri": { "MarkdownDocumentation": "`ImageUri`\n\nThe container image that the data quality monitoring job runs.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-imageuri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ContainerArguments": { "MarkdownDocumentation": "`ContainerArguments`\n\nThe arguments to send to the container that the monitoring job runs.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `256 | 50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-containerarguments", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::DataQualityJobDefinition.DataQualityBaselineConfig": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.DataQualityBaselineConfig`\n\nConfiguration for monitoring constraints and monitoring statistics. These baseline resources are\ncompared against the results of the current job from the series of jobs scheduled to collect data\nperiodically.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig.html", "Properties": { "StatisticsResource": { "MarkdownDocumentation": "`StatisticsResource`\n\nConfiguration for monitoring constraints and monitoring statistics. These baseline\nresources are compared against the results of the current job from the series of jobs\nscheduled to collect data periodically.\n*Required*: No\n*Type*: [StatisticsResource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig-statisticsresource", "UpdateType": "Immutable", "Required": false, "Type": "StatisticsResource" }, "ConstraintsResource": { "MarkdownDocumentation": "`ConstraintsResource`\n\nThe constraints resource for a monitoring job.\n*Required*: No\n*Type*: [ConstraintsResource](./aws-properties-sagemaker-dataqualityjobdefinition-constraintsresource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig-constraintsresource", "UpdateType": "Immutable", "Required": false, "Type": "ConstraintsResource" }, "BaseliningJobName": { "MarkdownDocumentation": "`BaseliningJobName`\n\nThe name of the job that performs baselining for the data quality monitoring job.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig-baseliningjobname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::DataQualityJobDefinition.DataQualityJobInput": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.DataQualityJobInput`\n\nThe input for the data quality monitoring job. Currently endpoints are supported for\ninput.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityjobinput.html", "Properties": { "BatchTransformInput": { "MarkdownDocumentation": "`BatchTransformInput`\n\nInput object for the batch transform job.\n*Required*: No\n*Type*: [BatchTransformInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityjobinput.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjobinput-batchtransforminput", "UpdateType": "Immutable", "Required": false, "Type": "BatchTransformInput" }, "EndpointInput": { "MarkdownDocumentation": "`EndpointInput`\n\nInput object for the endpoint\n*Required*: No\n*Type*: [EndpointInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityjobinput.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjobinput-endpointinput", "UpdateType": "Immutable", "Required": false, "Type": "EndpointInput" } } }, "AWS::SageMaker::DataQualityJobDefinition.DatasetFormat": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.DatasetFormat`\n\nThe `DatasetFormat` property type specifies Property description not available. for an [AWS::SageMaker::DataQualityJobDefinition](./aws-resource-sagemaker-dataqualityjobdefinition.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html", "Properties": { "Parquet": { "MarkdownDocumentation": "`Parquet`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html#cfn-sagemaker-dataqualityjobdefinition-datasetformat-parquet", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Csv": { "MarkdownDocumentation": "`Csv`\n\nProperty description not available.\n*Required*: No\n*Type*: [Csv](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html#cfn-sagemaker-dataqualityjobdefinition-datasetformat-csv", "UpdateType": "Immutable", "Required": false, "Type": "Csv" }, "Json": { "MarkdownDocumentation": "`Json`\n\nProperty description not available.\n*Required*: No\n*Type*: [Json](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html#cfn-sagemaker-dataqualityjobdefinition-datasetformat-json", "UpdateType": "Immutable", "Required": false, "Type": "Json" } } }, "AWS::SageMaker::DataQualityJobDefinition.EndpointInput": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.EndpointInput`\n\nInput object for the endpoint\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html", "Properties": { "S3DataDistributionType": { "MarkdownDocumentation": "`S3DataDistributionType`\n\nWhether input data distributed in Amazon S3 is fully replicated or sharded by an\nAmazon S3 key. Defaults to `FullyReplicated`\n*Required*: No\n*Type*: String\n*Allowed values*: `FullyReplicated | ShardedBy...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FullyReplicated", "ShardedByS3Key" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-s3datadistributiontype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nAn endpoint in customer's account which has enabled `DataCaptureConfig`\nenabled.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-endpointname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3InputMode": { "MarkdownDocumentation": "`S3InputMode`\n\nWhether the `Pipe` or `File` is used as the input mode for\ntransferring data for the monitoring job. `Pipe` mode is recommended for large\ndatasets. `File` mode is useful for small files that fit in memory. Defaults to\n`File`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Pipe | File...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Pipe", "File" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-s3inputmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LocalPath": { "MarkdownDocumentation": "`LocalPath`\n\nPath to the filesystem where the endpoint data is available to the container.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-localpath", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ExcludeFeaturesAttribute": { "MarkdownDocumentation": "`ExcludeFeaturesAttribute`\n\nThe attributes of the input data to exclude from the analysis.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-excludefeaturesattribute", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::DataQualityJobDefinition.Json": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.Json`\n\nThe `Json` property type specifies Property description not available. for an [AWS::SageMaker::DataQualityJobDefinition](./aws-resource-sagemaker-dataqualityjobdefinition.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-json.html", "Properties": { "Line": { "MarkdownDocumentation": "`Line`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-json.html#cfn-sagemaker-dataqualityjobdefinition-json-line", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SageMaker::DataQualityJobDefinition.MonitoringOutput": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.MonitoringOutput`\n\nThe output object for a monitoring job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutput.html", "Properties": { "S3Output": { "MarkdownDocumentation": "`S3Output`\n\nThe Amazon S3 storage location where the results of a monitoring job are\nsaved.\n*Required*: Yes\n*Type*: [S3Output](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutput.html#cfn-sagemaker-dataqualityjobdefinition-monitoringoutput-s3output", "UpdateType": "Immutable", "Required": true, "Type": "S3Output" } } }, "AWS::SageMaker::DataQualityJobDefinition.MonitoringOutputConfig": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.MonitoringOutputConfig`\n\nThe output configuration for monitoring jobs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutputconfig.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS Key Management Service (AWS KMS) key that Amazon SageMaker AI uses to\nencrypt the model artifacts at rest using Amazon S3 server-side encryption.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-dataqualityjobdefinition-monitoringoutputconfig-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MonitoringOutputs": { "MarkdownDocumentation": "`MonitoringOutputs`\n\nMonitoring outputs for monitoring jobs. This is where the output of the periodic\nmonitoring jobs is uploaded.\n*Required*: Yes\n*Type*: Array of [MonitoringOutput](./aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutput.html)\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-dataqualityjobdefinition-monitoringoutputconfig-monitoringoutputs", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "MonitoringOutput", "DuplicatesAllowed": true } } }, "AWS::SageMaker::DataQualityJobDefinition.MonitoringResources": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.MonitoringResources`\n\nIdentifies the resources to deploy for a monitoring job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringresources.html", "Properties": { "ClusterConfig": { "MarkdownDocumentation": "`ClusterConfig`\n\nThe configuration for the cluster resources used to run the processing job.\n*Required*: Yes\n*Type*: [ClusterConfig](./aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringresources.html#cfn-sagemaker-dataqualityjobdefinition-monitoringresources-clusterconfig", "UpdateType": "Immutable", "Required": true, "Type": "ClusterConfig" } } }, "AWS::SageMaker::DataQualityJobDefinition.NetworkConfig": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.NetworkConfig`\n\nNetworking options for a job, such as network traffic encryption between containers,\nwhether to allow inbound and outbound network calls to and from containers, and the VPC\nsubnets and security groups to use for VPC-enabled jobs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-networkconfig.html", "Properties": { "EnableNetworkIsolation": { "MarkdownDocumentation": "`EnableNetworkIsolation`\n\nWhether to allow inbound and outbound network calls to and from the containers used for\nthe processing job.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-networkconfig.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig-enablenetworkisolation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableInterContainerTrafficEncryption": { "MarkdownDocumentation": "`EnableInterContainerTrafficEncryption`\n\nWhether to encrypt all communications between distributed processing jobs. Choose\n`True` to encrypt communications. Encryption provides greater security\nfor distributed processing jobs, but the processing might take longer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-networkconfig.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig-enableintercontainertrafficencryption", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nSpecifies a VPC that your training jobs and hosted models have access to. Control access\nto and from your training and model containers by configuring the VPC.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-sagemaker-dataqualityjobdefinition-vpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-networkconfig.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig-vpcconfig", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfig" } } }, "AWS::SageMaker::DataQualityJobDefinition.S3Output": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.S3Output`\n\nThe Amazon S3 storage location where the results of a monitoring job are saved.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-s3output.html", "Properties": { "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nA URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the\nresults of a monitoring job.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-s3output.html#cfn-sagemaker-dataqualityjobdefinition-s3output-s3uri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LocalPath": { "MarkdownDocumentation": "`LocalPath`\n\nThe local path to the Amazon S3 storage location where Amazon SageMaker saves the\nresults of a monitoring job. LocalPath is an absolute path for the output data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-s3output.html#cfn-sagemaker-dataqualityjobdefinition-s3output-localpath", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3UploadMode": { "MarkdownDocumentation": "`S3UploadMode`\n\nWhether to upload the results of the monitoring job continuously or after the job\ncompletes.\n*Required*: No\n*Type*: String\n*Allowed values*: `Continuous | EndOfJob...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Continuous", "EndOfJob" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-s3output.html#cfn-sagemaker-dataqualityjobdefinition-s3output-s3uploadmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::DataQualityJobDefinition.StatisticsResource": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.StatisticsResource`\n\nThe statistics resource for a monitoring job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-statisticsresource.html", "Properties": { "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe Amazon S3 URI for the statistics resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-statisticsresource.html#cfn-sagemaker-dataqualityjobdefinition-statisticsresource-s3uri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::DataQualityJobDefinition.StoppingCondition": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.StoppingCondition`\n\nSpecifies a limit to how long a job can run. When the job reaches the time limit, SageMaker\nends the job. Use this API to cap costs.\nTo stop a training job, SageMaker sends the algorithm the `SIGTERM` signal,\nwhich delays job termination for 120 seconds. Algorithms can use this 120-second window\nto save the model artifacts, so the results of training are not lost.\nThe training algorithms provided by SageMaker automatically save the intermediate results\nof a model training job when possible. This attempt to save artifacts is only a best\neffort case as model might not be in a state from which it can be saved. For example, if\ntraining has just started, the model might not be ready to save. When saved, this\nintermediate data is a valid model artifact. You can use it to create a model with\n`CreateModel`.\n###### Note\nThe Neural Topic Model (NTM) currently does not support saving intermediate model\nartifacts. When training NTMs, make sure that the maximum runtime is sufficient for\nthe training job to complete.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-stoppingcondition.html", "Properties": { "MaxRuntimeInSeconds": { "MarkdownDocumentation": "`MaxRuntimeInSeconds`\n\nThe maximum length of time, in seconds, that a training or compilation job can run\nbefore it is stopped.\nFor compilation jobs, if the job does not complete during this time, a\n`TimeOut` error is generated. We recommend starting with 900 seconds and\nincreasing as necessary based on your model.\nFor all other jobs, if the job does not complete during this time, SageMaker ends the job.\nWhen `RetryStrategy` is specified in the job request,\n`MaxRuntimeInSeconds` specifies the maximum time for all of the attempts\nin total, not each individual attempt. The default value is 1 day. The maximum value is\n28 days.\nThe maximum time that a `TrainingJob` can run in total, including any time\nspent publishing metrics or archiving and uploading models after it has been stopped, is\n30 days.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `86400`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-stoppingcondition.html#cfn-sagemaker-dataqualityjobdefinition-stoppingcondition-maxruntimeinseconds", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::DataQualityJobDefinition.VpcConfig": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition.VpcConfig`\n\nSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models,\nand compute resources have access to. You can control access to and from your resources by\nconfiguring a VPC. For more information, see [Give SageMaker Access to\nResources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-vpcconfig.html", "Properties": { "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe ID of the subnets in the VPC to which you want to connect your training job or\nmodel. For information about the availability of specific instance types, see [Supported\nInstance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html).\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `32 | 16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-vpcconfig.html#cfn-sagemaker-dataqualityjobdefinition-vpcconfig-subnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe VPC security group IDs, in the form `sg-xxxxxxxx`. Specify the security\ngroups for the VPC that is specified in the `Subnets` field.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `32 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-vpcconfig.html#cfn-sagemaker-dataqualityjobdefinition-vpcconfig-securitygroupids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::Device.Device": { "MarkdownDocumentation": "`AWS::SageMaker::Device.Device`\n\nInformation of a particular device.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-device-device.html", "Properties": { "IotThingName": { "MarkdownDocumentation": "`IotThingName`\n\nAWS Internet of Things (IoT) object name.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-device-device.html#cfn-sagemaker-device-device-iotthingname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nDescription of the device.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\S\\s]+`\n*Minimum*: `1`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-device-device.html#cfn-sagemaker-device-device-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe name of the device.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-device-device.html#cfn-sagemaker-device-device-devicename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::DeviceFleet.EdgeOutputConfig": { "MarkdownDocumentation": "`AWS::SageMaker::DeviceFleet.EdgeOutputConfig`\n\nThe output configuration for storing sample data collected by the fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-devicefleet-edgeoutputconfig.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS Key Management Service (AWS KMS) key that\nAmazon SageMaker uses to encrypt data on the storage volume after compilation job. If you\ndon't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for\nyour role's account.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-devicefleet-edgeoutputconfig.html#cfn-sagemaker-devicefleet-edgeoutputconfig-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3OutputLocation": { "MarkdownDocumentation": "`S3OutputLocation`\n\nThe Amazon Simple Storage (S3) bucket URI.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^s3://([^/]+)/?(.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-devicefleet-edgeoutputconfig.html#cfn-sagemaker-devicefleet-edgeoutputconfig-s3outputlocation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.AppLifecycleManagement": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.AppLifecycleManagement`\n\nSettings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\napplications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-applifecyclemanagement.html", "Properties": { "IdleSettings": { "MarkdownDocumentation": "`IdleSettings`\n\nSettings related to idle shutdown of Studio applications.\n*Required*: No\n*Type*: [IdleSettings](./aws-properties-sagemaker-domain-idlesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-applifecyclemanagement.html#cfn-sagemaker-domain-applifecyclemanagement-idlesettings", "UpdateType": "Mutable", "Required": false, "Type": "IdleSettings" } } }, "AWS::SageMaker::Domain.CodeEditorAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.CodeEditorAppSettings`\n\nThe Code Editor application settings.\nFor more information about Code Editor, see [Get started with Code\nEditor in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html", "Properties": { "CustomImages": { "MarkdownDocumentation": "`CustomImages`\n\nA list of custom SageMaker images that are configured to run as a Code Editor app.\n*Required*: No\n*Type*: Array of [CustomImage](./aws-properties-sagemaker-domain-customimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-customimages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomImage", "DuplicatesAllowed": true }, "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker\nimage used by the Code Editor app.\n*Required*: No\n*Type*: [ResourceSpec](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "LifecycleConfigArns": { "MarkdownDocumentation": "`LifecycleConfigArns`\n\nThe Amazon Resource Name (ARN) of the Code Editor application\nlifecycle configuration.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-lifecycleconfigarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BuiltInLifecycleConfigArn": { "MarkdownDocumentation": "`BuiltInLifecycleConfigArn`\n\nThe lifecycle configuration that runs before the default lifecycle configuration. It can\noverride changes made in the default lifecycle configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-builtinlifecycleconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AppLifecycleManagement": { "MarkdownDocumentation": "`AppLifecycleManagement`\n\nSettings that are used to configure and manage the lifecycle of CodeEditor\napplications.\n*Required*: No\n*Type*: [AppLifecycleManagement](./aws-properties-sagemaker-domain-applifecyclemanagement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-applifecyclemanagement", "UpdateType": "Mutable", "Required": false, "Type": "AppLifecycleManagement" } } }, "AWS::SageMaker::Domain.CodeRepository": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.CodeRepository`\n\nA Git repository that SageMaker AI automatically displays to users for cloning in the\nJupyterServer application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-coderepository.html", "Properties": { "RepositoryUrl": { "MarkdownDocumentation": "`RepositoryUrl`\n\nThe URL of the Git repository.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-coderepository.html#cfn-sagemaker-domain-coderepository-repositoryurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.CustomFileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.CustomFileSystemConfig`\n\nThe settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\nStudio.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html", "Properties": { "EFSFileSystemConfig": { "MarkdownDocumentation": "`EFSFileSystemConfig`\n\nThe settings for a custom Amazon EFS file system.\n*Required*: No\n*Type*: [EFSFileSystemConfig](./aws-properties-sagemaker-domain-efsfilesystemconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html#cfn-sagemaker-domain-customfilesystemconfig-efsfilesystemconfig", "UpdateType": "Mutable", "Required": false, "Type": "EFSFileSystemConfig" }, "S3FileSystemConfig": { "MarkdownDocumentation": "`S3FileSystemConfig`\n\nConfiguration settings for a custom Amazon S3 file system.\n*Required*: No\n*Type*: [S3FileSystemConfig](./aws-properties-sagemaker-domain-s3filesystemconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html#cfn-sagemaker-domain-customfilesystemconfig-s3filesystemconfig", "UpdateType": "Mutable", "Required": false, "Type": "S3FileSystemConfig" }, "FSxLustreFileSystemConfig": { "MarkdownDocumentation": "`FSxLustreFileSystemConfig`\n\nThe settings for a custom Amazon FSx for Lustre file system.\n*Required*: No\n*Type*: [FSxLustreFileSystemConfig](./aws-properties-sagemaker-domain-fsxlustrefilesystemconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html#cfn-sagemaker-domain-customfilesystemconfig-fsxlustrefilesystemconfig", "UpdateType": "Mutable", "Required": false, "Type": "FSxLustreFileSystemConfig" } } }, "AWS::SageMaker::Domain.CustomImage": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.CustomImage`\n\nA custom SageMaker AI image. For more information, see\n[Bring your own SageMaker AI image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html", "Properties": { "ImageName": { "MarkdownDocumentation": "`ImageName`\n\nThe name of the CustomImage. Must be unique to your account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html#cfn-sagemaker-domain-customimage-imagename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AppImageConfigName": { "MarkdownDocumentation": "`AppImageConfigName`\n\nThe name of the AppImageConfig.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html#cfn-sagemaker-domain-customimage-appimageconfigname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImageVersionNumber": { "MarkdownDocumentation": "`ImageVersionNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html#cfn-sagemaker-domain-customimage-imageversionnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Domain.CustomPosixUserConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.CustomPosixUserConfig`\n\nDetails about the POSIX identity that is used for file system operations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customposixuserconfig.html", "Properties": { "Uid": { "MarkdownDocumentation": "`Uid`\n\nThe POSIX user ID.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `10000`\n*Maximum*: `4000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customposixuserconfig.html#cfn-sagemaker-domain-customposixuserconfig-uid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Gid": { "MarkdownDocumentation": "`Gid`\n\nThe POSIX group ID.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1001`\n*Maximum*: `4000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customposixuserconfig.html#cfn-sagemaker-domain-customposixuserconfig-gid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Domain.DefaultEbsStorageSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.DefaultEbsStorageSettings`\n\nA collection of default EBS storage settings that apply to spaces created within a domain or user profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultebsstoragesettings.html", "Properties": { "MaximumEbsVolumeSizeInGb": { "MarkdownDocumentation": "`MaximumEbsVolumeSizeInGb`\n\nThe maximum size of the EBS storage volume for a space.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `5`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultebsstoragesettings.html#cfn-sagemaker-domain-defaultebsstoragesettings-maximumebsvolumesizeingb", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DefaultEbsVolumeSizeInGb": { "MarkdownDocumentation": "`DefaultEbsVolumeSizeInGb`\n\nThe default size of the EBS storage volume for a space.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `5`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultebsstoragesettings.html#cfn-sagemaker-domain-defaultebsstoragesettings-defaultebsvolumesizeingb", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Domain.DefaultSpaceSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.DefaultSpaceSettings`\n\nThe default settings for shared spaces that users create in the domain.\nSageMaker applies these settings only to shared spaces. It doesn't apply them to private\nspaces.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security group IDs for the Amazon VPC that the space uses for\ncommunication.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `32 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "JupyterLabAppSettings": { "MarkdownDocumentation": "`JupyterLabAppSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [JupyterLabAppSettings](./aws-properties-sagemaker-domain-jupyterlabappsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-jupyterlabappsettings", "UpdateType": "Mutable", "Required": false, "Type": "JupyterLabAppSettings" }, "KernelGatewayAppSettings": { "MarkdownDocumentation": "`KernelGatewayAppSettings`\n\nThe KernelGateway app settings.\n*Required*: No\n*Type*: [KernelGatewayAppSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-kernelgatewayappsettings", "UpdateType": "Mutable", "Required": false, "Type": "KernelGatewayAppSettings" }, "JupyterServerAppSettings": { "MarkdownDocumentation": "`JupyterServerAppSettings`\n\nThe JupyterServer app settings.\n*Required*: No\n*Type*: [JupyterServerAppSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-jupyterserverappsettings", "UpdateType": "Mutable", "Required": false, "Type": "JupyterServerAppSettings" }, "CustomFileSystemConfigs": { "MarkdownDocumentation": "`CustomFileSystemConfigs`\n\nThe settings for assigning a custom file system to a domain. Permitted users can access\nthis file system in Amazon SageMaker AI Studio.\n*Required*: No\n*Type*: Array of [CustomFileSystemConfig](./aws-properties-sagemaker-domain-customfilesystemconfig.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-customfilesystemconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomFileSystemConfig", "DuplicatesAllowed": false }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe ARN of the execution role for the space.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SpaceStorageSettings": { "MarkdownDocumentation": "`SpaceStorageSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [DefaultSpaceStorageSettings](./aws-properties-sagemaker-domain-defaultspacestoragesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-spacestoragesettings", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSpaceStorageSettings" }, "CustomPosixUserConfig": { "MarkdownDocumentation": "`CustomPosixUserConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomPosixUserConfig](./aws-properties-sagemaker-domain-customposixuserconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-customposixuserconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomPosixUserConfig" } } }, "AWS::SageMaker::Domain.DefaultSpaceStorageSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.DefaultSpaceStorageSettings`\n\nThe default storage settings for a space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacestoragesettings.html", "Properties": { "DefaultEbsStorageSettings": { "MarkdownDocumentation": "`DefaultEbsStorageSettings`\n\nThe default EBS storage settings for a space.\n*Required*: No\n*Type*: [DefaultEbsStorageSettings](./aws-properties-sagemaker-domain-defaultebsstoragesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacestoragesettings.html#cfn-sagemaker-domain-defaultspacestoragesettings-defaultebsstoragesettings", "UpdateType": "Mutable", "Required": false, "Type": "DefaultEbsStorageSettings" } } }, "AWS::SageMaker::Domain.DockerSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.DockerSettings`\n\nA collection of settings that configure the domain's Docker interaction.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-dockersettings.html", "Properties": { "VpcOnlyTrustedAccounts": { "MarkdownDocumentation": "`VpcOnlyTrustedAccounts`\n\nThe list of AWS accounts that are trusted when the domain is created in\nVPC-only mode.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `12 | 0`\n*Maximum*: `12 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-dockersettings.html#cfn-sagemaker-domain-dockersettings-vpconlytrustedaccounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnableDockerAccess": { "MarkdownDocumentation": "`EnableDockerAccess`\n\nIndicates whether the domain can access Docker.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-dockersettings.html#cfn-sagemaker-domain-dockersettings-enabledockeraccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.DomainSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.DomainSettings`\n\nA collection of settings that apply to the `SageMaker Domain`. These settings\nare specified through the `CreateDomain` API call.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html", "Properties": { "DockerSettings": { "MarkdownDocumentation": "`DockerSettings`\n\nA collection of settings that configure the domain's Docker interaction.\n*Required*: No\n*Type*: [DockerSettings](./aws-properties-sagemaker-domain-dockersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-dockersettings", "UpdateType": "Mutable", "Required": false, "Type": "DockerSettings" }, "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address type for the domain. Specify `ipv4` for IPv4-only\nconnectivity or `dualstack` for both IPv4 and IPv6 connectivity. When you\nspecify `dualstack`, the subnet must support IPv6 CIDR blocks. If not specified,\ndefaults to `ipv4`.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | DUALSTACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "DUALSTACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRoleIdentityConfig": { "MarkdownDocumentation": "`ExecutionRoleIdentityConfig`\n\nThe configuration for attaching a SageMaker AI user profile name to the execution\nrole as a [sts:SourceIdentity key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `USER_PROFILE_NAME | DISABLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "USER_PROFILE_NAME", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-executionroleidentityconfig", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UnifiedStudioSettings": { "MarkdownDocumentation": "`UnifiedStudioSettings`\n\nThe settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.\n*Required*: No\n*Type*: [UnifiedStudioSettings](./aws-properties-sagemaker-domain-unifiedstudiosettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-unifiedstudiosettings", "UpdateType": "Mutable", "Required": false, "Type": "UnifiedStudioSettings" }, "RStudioServerProDomainSettings": { "MarkdownDocumentation": "`RStudioServerProDomainSettings`\n\nA collection of settings that configure the `RStudioServerPro` Domain-level\napp.\n*Required*: No\n*Type*: [RStudioServerProDomainSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-rstudioserverprodomainsettings", "UpdateType": "Mutable", "Required": false, "Type": "RStudioServerProDomainSettings" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe security groups for the Amazon Virtual Private Cloud that the `Domain` uses for\ncommunication between Domain-level apps and user apps.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `32 | 3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::Domain.EFSFileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.EFSFileSystemConfig`\n\nThe settings for assigning a custom Amazon EFS file system to a user profile or\nspace for an Amazon SageMaker AI Domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-efsfilesystemconfig.html", "Properties": { "FileSystemPath": { "MarkdownDocumentation": "`FileSystemPath`\n\nThe path to the file system directory that is accessible in Amazon SageMaker AI Studio.\nPermitted users can access only this directory and below.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\/\\S*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-efsfilesystemconfig.html#cfn-sagemaker-domain-efsfilesystemconfig-filesystempath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe ID of your Amazon EFS file system.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(fs-[0-9a-f]{8,})$`\n*Minimum*: `11`\n*Maximum*: `21`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-efsfilesystemconfig.html#cfn-sagemaker-domain-efsfilesystemconfig-filesystemid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.FSxLustreFileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.FSxLustreFileSystemConfig`\n\nThe settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an\nAmazon SageMaker Domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-fsxlustrefilesystemconfig.html", "Properties": { "FileSystemPath": { "MarkdownDocumentation": "`FileSystemPath`\n\nThe path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted\nusers can access only this directory and below.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\/\\S*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-fsxlustrefilesystemconfig.html#cfn-sagemaker-domain-fsxlustrefilesystemconfig-filesystempath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(fs-[0-9a-f]{8,})$`\n*Minimum*: `11`\n*Maximum*: `21`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-fsxlustrefilesystemconfig.html#cfn-sagemaker-domain-fsxlustrefilesystemconfig-filesystemid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.HiddenSageMakerImage": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.HiddenSageMakerImage`\n\nThe SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker\nimage name and version aliases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-hiddensagemakerimage.html", "Properties": { "SageMakerImageName": { "MarkdownDocumentation": "`SageMakerImageName`\n\nThe SageMaker image name that you are hiding from the Studio user interface.\n*Required*: No\n*Type*: String\n*Allowed values*: `sagemaker_distribution...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "sagemaker_distribution" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-hiddensagemakerimage.html#cfn-sagemaker-domain-hiddensagemakerimage-sagemakerimagename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VersionAliases": { "MarkdownDocumentation": "`VersionAliases`\n\nThe version aliases you are hiding from the Studio user interface.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-hiddensagemakerimage.html#cfn-sagemaker-domain-hiddensagemakerimage-versionaliases", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::Domain.IdleSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.IdleSettings`\n\nSettings related to idle shutdown of Studio applications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html", "Properties": { "MaxIdleTimeoutInMinutes": { "MarkdownDocumentation": "`MaxIdleTimeoutInMinutes`\n\nThe maximum value in minutes that custom idle shutdown can be set to by the user.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `525600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-maxidletimeoutinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IdleTimeoutInMinutes": { "MarkdownDocumentation": "`IdleTimeoutInMinutes`\n\nThe time that SageMaker waits after the application becomes idle before shutting it\ndown.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `525600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-idletimeoutinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinIdleTimeoutInMinutes": { "MarkdownDocumentation": "`MinIdleTimeoutInMinutes`\n\nThe minimum value in minutes that custom idle shutdown can be set to by the user.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `525600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-minidletimeoutinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LifecycleManagement": { "MarkdownDocumentation": "`LifecycleManagement`\n\nIndicates whether idle shutdown is activated for the application type.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-lifecyclemanagement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.JupyterLabAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.JupyterLabAppSettings`\n\nThe settings for the JupyterLab application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html", "Properties": { "CustomImages": { "MarkdownDocumentation": "`CustomImages`\n\nA list of custom SageMaker images that are configured to run as a JupyterLab app.\n*Required*: No\n*Type*: Array of [CustomImage](./aws-properties-sagemaker-domain-customimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-customimages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomImage", "DuplicatesAllowed": true }, "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker\nimage used by the JupyterLab app.\n*Required*: No\n*Type*: [ResourceSpec](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "LifecycleConfigArns": { "MarkdownDocumentation": "`LifecycleConfigArns`\n\nThe Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-lifecycleconfigarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BuiltInLifecycleConfigArn": { "MarkdownDocumentation": "`BuiltInLifecycleConfigArn`\n\nThe lifecycle configuration that runs before the default lifecycle configuration. It can\noverride changes made in the default lifecycle configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-builtinlifecycleconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CodeRepositories": { "MarkdownDocumentation": "`CodeRepositories`\n\nA list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.\n*Required*: No\n*Type*: Array of [CodeRepository](./aws-properties-sagemaker-domain-coderepository.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-coderepositories", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CodeRepository", "DuplicatesAllowed": true }, "AppLifecycleManagement": { "MarkdownDocumentation": "`AppLifecycleManagement`\n\nIndicates whether idle shutdown is activated for JupyterLab applications.\n*Required*: No\n*Type*: [AppLifecycleManagement](./aws-properties-sagemaker-domain-applifecyclemanagement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-applifecyclemanagement", "UpdateType": "Mutable", "Required": false, "Type": "AppLifecycleManagement" } } }, "AWS::SageMaker::Domain.JupyterServerAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.JupyterServerAppSettings`\n\nThe JupyterServer app settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html", "Properties": { "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker\nimage used by the JupyterServer app.\n*Required*: No\n*Type*: [ResourceSpec](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html#cfn-sagemaker-domain-jupyterserverappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "LifecycleConfigArns": { "MarkdownDocumentation": "`LifecycleConfigArns`\n\nThe Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the\nJupyterServerApp. If you use this parameter, the `DefaultResourceSpec` parameter is\nalso required.\n###### Note\nTo remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty\nlist.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html#cfn-sagemaker-domain-jupyterserverappsettings-lifecycleconfigarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::Domain.KernelGatewayAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.KernelGatewayAppSettings`\n\nThe KernelGateway app settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html", "Properties": { "CustomImages": { "MarkdownDocumentation": "`CustomImages`\n\nA list of custom SageMaker AI images that are configured to run as a KernelGateway\napp.\nThe maximum number of custom images are as follows.\n* On a domain level: 200\n* On a space level: 5\n* On a user profile level: 5\n*Required*: No\n*Type*: Array of [CustomImage](./aws-properties-sagemaker-domain-customimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-kernelgatewayappsettings-customimages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomImage", "DuplicatesAllowed": true }, "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.\n###### Note\nThe Amazon SageMaker AI Studio UI does not use the default instance type value set\nhere. The default instance type set here is used when Apps are created using the AWS CLI or CloudFormation and the instance type parameter value is not\npassed.\n*Required*: No\n*Type*: [ResourceSpec](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-kernelgatewayappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "LifecycleConfigArns": { "MarkdownDocumentation": "`LifecycleConfigArns`\n\nThe Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user\nprofile or domain.\n###### Note\nTo remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty\nlist.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-kernelgatewayappsettings-lifecycleconfigarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::Domain.RSessionAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.RSessionAppSettings`\n\nA collection of settings that apply to an `RSessionGateway` app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rsessionappsettings.html", "Properties": { "CustomImages": { "MarkdownDocumentation": "`CustomImages`\n\nA list of custom SageMaker AI images that are configured to run as a RSession\napp.\n*Required*: No\n*Type*: Array of [CustomImage](./aws-properties-sagemaker-domain-customimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rsessionappsettings.html#cfn-sagemaker-domain-rsessionappsettings-customimages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomImage", "DuplicatesAllowed": true }, "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nSpecifies the ARNs of a SageMaker image and SageMaker image version, and the instance\ntype that the version runs on.\n*Required*: No\n*Type*: [ResourceSpec](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rsessionappsettings.html#cfn-sagemaker-domain-rsessionappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" } } }, "AWS::SageMaker::Domain.RStudioServerProAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.RStudioServerProAppSettings`\n\nA collection of settings that configure user interaction with the\n`RStudioServerPro` app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html", "Properties": { "AccessStatus": { "MarkdownDocumentation": "`AccessStatus`\n\nIndicates whether the current user has access to the `RStudioServerPro`\napp.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html#cfn-sagemaker-domain-rstudioserverproappsettings-accessstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserGroup": { "MarkdownDocumentation": "`UserGroup`\n\nThe level of permissions that the user has within the `RStudioServerPro` app.\nThis value defaults to `User`. The `Admin` value allows the user access to the RStudio\nAdministrative Dashboard.\n*Required*: No\n*Type*: String\n*Allowed values*: `R_STUDIO_ADMIN | R_STUDIO_U...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "R_STUDIO_ADMIN", "R_STUDIO_USER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html#cfn-sagemaker-domain-rstudioserverproappsettings-usergroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.RStudioServerProDomainSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.RStudioServerProDomainSettings`\n\nA collection of settings that configure the `RStudioServerPro` Domain-level\napp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html", "Properties": { "DomainExecutionRoleArn": { "MarkdownDocumentation": "`DomainExecutionRoleArn`\n\nThe ARN of the execution role for the `RStudioServerPro` Domain-level\napp.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-domainexecutionrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RStudioConnectUrl": { "MarkdownDocumentation": "`RStudioConnectUrl`\n\nA URL pointing to an RStudio Connect server.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https:|http:|www\\.)\\S*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-rstudioconnecturl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nA collection that defines the default `InstanceType`,\n`SageMakerImageArn`, and `SageMakerImageVersionArn` for the\nDomain.\n*Required*: No\n*Type*: [ResourceSpec](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-defaultresourcespec", "UpdateType": "Immutable", "Required": false, "Type": "ResourceSpec" }, "RStudioPackageManagerUrl": { "MarkdownDocumentation": "`RStudioPackageManagerUrl`\n\nA URL pointing to an RStudio Package Manager server.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https:|http:|www\\.)\\S*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-rstudiopackagemanagerurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.ResourceSpec": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.ResourceSpec`\n\nSpecifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that\nthe version runs on.\n###### Note\nWhen both `SageMakerImageVersionArn` and `SageMakerImageArn` are passed, `SageMakerImageVersionArn` is used. Any updates to `SageMakerImageArn` will not take effect if `SageMakerImageVersionArn` already exists in the `ResourceSpec` because `SageMakerImageVersionArn` always takes precedence. To clear the value set for `SageMakerImageVersionArn`, pass `None` as the value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html", "Properties": { "SageMakerImageArn": { "MarkdownDocumentation": "`SageMakerImageArn`\n\nThe ARN of the SageMaker AI image that the image version belongs to.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-sagemakerimagearn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type that the image version runs on.\n###### Note\n**JupyterServer apps** only support the `system` value.\nFor **KernelGateway apps**, the `system`\nvalue is translated to `ml.t3.medium`. KernelGateway apps also support all other values for available\ninstance types.\n*Required*: No\n*Type*: String\n*Allowed values*: `system | ml.t3.micro | ml.t...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "system", "ml.t3.micro", "ml.t3.small", "ml.t3.medium", "ml.t3.large", "ml.t3.xlarge", "ml.t3.2xlarge", "ml.m5.large", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.8xlarge", "ml.m5.12xlarge", "ml.m5.16xlarge", "ml.m5.24xlarge", "ml.m5d.large", "ml.m5d.xlarge", "ml.m5d.2xlarge", "ml.m5d.4xlarge", "ml.m5d.8xlarge", "ml.m5d.12xlarge", "ml.m5d.16xlarge", "ml.m5d.24xlarge", "ml.c5.large", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.12xlarge", "ml.c5.18xlarge", "ml.c5.24xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", "ml.g4dn.xlarge", "ml.g4dn.2xlarge", "ml.g4dn.4xlarge", "ml.g4dn.8xlarge", "ml.g4dn.12xlarge", "ml.g4dn.16xlarge", "ml.r5.large", "ml.r5.xlarge", "ml.r5.2xlarge", "ml.r5.4xlarge", "ml.r5.8xlarge", "ml.r5.12xlarge", "ml.r5.16xlarge", "ml.r5.24xlarge", "ml.g5.xlarge", "ml.g5.2xlarge", "ml.g5.4xlarge", "ml.g5.8xlarge", "ml.g5.12xlarge", "ml.g5.16xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", "ml.g6.xlarge", "ml.g6.2xlarge", "ml.g6.4xlarge", "ml.g6.8xlarge", "ml.g6.12xlarge", "ml.g6.16xlarge", "ml.g6.24xlarge", "ml.g6.48xlarge", "ml.g6e.xlarge", "ml.g6e.2xlarge", "ml.g6e.4xlarge", "ml.g6e.8xlarge", "ml.g6e.12xlarge", "ml.g6e.16xlarge", "ml.g6e.24xlarge", "ml.g6e.48xlarge", "ml.geospatial.interactive", "ml.p4d.24xlarge", "ml.p4de.24xlarge", "ml.trn1.2xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.p5.48xlarge", "ml.p5e.48xlarge", "ml.p5en.48xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", "ml.m6i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.12xlarge", "ml.m6i.16xlarge", "ml.m6i.24xlarge", "ml.m6i.32xlarge", "ml.m7i.large", "ml.m7i.xlarge", "ml.m7i.2xlarge", "ml.m7i.4xlarge", "ml.m7i.8xlarge", "ml.m7i.12xlarge", "ml.m7i.16xlarge", "ml.m7i.24xlarge", "ml.m7i.48xlarge", "ml.c6i.large", "ml.c6i.xlarge", "ml.c6i.2xlarge", "ml.c6i.4xlarge", "ml.c6i.8xlarge", "ml.c6i.12xlarge", "ml.c6i.16xlarge", "ml.c6i.24xlarge", "ml.c6i.32xlarge", "ml.c7i.large", "ml.c7i.xlarge", "ml.c7i.2xlarge", "ml.c7i.4xlarge", "ml.c7i.8xlarge", "ml.c7i.12xlarge", "ml.c7i.16xlarge", "ml.c7i.24xlarge", "ml.c7i.48xlarge", "ml.r6i.large", "ml.r6i.xlarge", "ml.r6i.2xlarge", "ml.r6i.4xlarge", "ml.r6i.8xlarge", "ml.r6i.12xlarge", "ml.r6i.16xlarge", "ml.r6i.24xlarge", "ml.r6i.32xlarge", "ml.r7i.large", "ml.r7i.xlarge", "ml.r7i.2xlarge", "ml.r7i.4xlarge", "ml.r7i.8xlarge", "ml.r7i.12xlarge", "ml.r7i.16xlarge", "ml.r7i.24xlarge", "ml.r7i.48xlarge", "ml.m6id.large", "ml.m6id.xlarge", "ml.m6id.2xlarge", "ml.m6id.4xlarge", "ml.m6id.8xlarge", "ml.m6id.12xlarge", "ml.m6id.16xlarge", "ml.m6id.24xlarge", "ml.m6id.32xlarge", "ml.c6id.large", "ml.c6id.xlarge", "ml.c6id.2xlarge", "ml.c6id.4xlarge", "ml.c6id.8xlarge", "ml.c6id.12xlarge", "ml.c6id.16xlarge", "ml.c6id.24xlarge", "ml.c6id.32xlarge", "ml.r6id.large", "ml.r6id.xlarge", "ml.r6id.2xlarge", "ml.r6id.4xlarge", "ml.r6id.8xlarge", "ml.r6id.12xlarge", "ml.r6id.16xlarge", "ml.r6id.24xlarge", "ml.r6id.32xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-instancetype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "LifecycleConfigArn": { "MarkdownDocumentation": "`LifecycleConfigArn`\n\nThe Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the\nResource.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-lifecycleconfigarn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SageMakerImageVersionArn": { "MarkdownDocumentation": "`SageMakerImageVersionArn`\n\nThe ARN of the image version created on the instance. To clear the value set for `SageMakerImageVersionArn`, pass `None` as the value.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-sagemakerimageversionarn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.S3FileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.S3FileSystemConfig`\n\nConfiguration for the custom Amazon S3 file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-s3filesystemconfig.html", "Properties": { "MountPath": { "MarkdownDocumentation": "`MountPath`\n\nThe file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker\nStudio environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-s3filesystemconfig.html#cfn-sagemaker-domain-s3filesystemconfig-mountpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe Amazon S3 URI of the S3 file system configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `(s3)://([^/]+)/?(.*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-s3filesystemconfig.html#cfn-sagemaker-domain-s3filesystemconfig-s3uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.SharingSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.SharingSettings`\n\nSpecifies options when sharing an Amazon SageMaker Studio notebook. These settings are\nspecified as part of `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is\ncalled, and as part of `UserSettings` when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html)\nAPI is called.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html", "Properties": { "NotebookOutputOption": { "MarkdownDocumentation": "`NotebookOutputOption`\n\nWhether to include the notebook cell output when sharing the notebook. The default is\n`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)", "RefReturnValue": "", "AllowedValues": [ "Allowed", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-notebookoutputoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3KmsKeyId": { "MarkdownDocumentation": "`S3KmsKeyId`\n\nWhen `NotebookOutputOption` is `Allowed`, the AWS Key\nManagement Service (KMS) encryption key ID used to encrypt the notebook cell output in the\nAmazon S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-s3kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3OutputPath": { "MarkdownDocumentation": "`S3OutputPath`\n\nWhen `NotebookOutputOption` is `Allowed`, the Amazon S3\nbucket used to store the shared notebook snapshots.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-s3outputpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.StudioWebPortalSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.StudioWebPortalSettings`\n\nStudio settings. If these settings are applied on a user level, they take priority over\nthe settings applied on a domain level.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html", "Properties": { "HiddenSageMakerImageVersionAliases": { "MarkdownDocumentation": "`HiddenSageMakerImageVersionAliases`\n\nThe version aliases you are hiding from the Studio user interface.\n*Required*: No\n*Type*: Array of [HiddenSageMakerImage](./aws-properties-sagemaker-domain-hiddensagemakerimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddensagemakerimageversionaliases", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HiddenSageMakerImage", "DuplicatesAllowed": false }, "HiddenAppTypes": { "MarkdownDocumentation": "`HiddenAppTypes`\n\nThe [Applications supported in Studio](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-apps.html) that are hidden from the Studio left navigation\npane.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddenapptypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HiddenInstanceTypes": { "MarkdownDocumentation": "`HiddenInstanceTypes`\n\nThe instance types you are hiding from the Studio user interface.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddeninstancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HiddenMlTools": { "MarkdownDocumentation": "`HiddenMlTools`\n\nThe machine learning tools that are hidden from the Studio left navigation pane.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddenmltools", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::SageMaker::Domain.UnifiedStudioSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.UnifiedStudioSettings`\n\nThe settings that apply to an Amazon SageMaker AI domain when you use it in\nAmazon SageMaker Unified Studio.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html", "Properties": { "EnvironmentId": { "MarkdownDocumentation": "`EnvironmentId`\n\nThe ID of the environment that Amazon SageMaker Unified Studio associates with the domain.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-environmentid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainId": { "MarkdownDocumentation": "`DomainId`\n\nThe ID of the Amazon SageMaker Unified Studio domain associated with this domain.\n*Required*: No\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProjectS3Path": { "MarkdownDocumentation": "`ProjectS3Path`\n\nThe location where Amazon S3 stores temporary execution data and other artifacts\nfor the project that corresponds to the domain.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w\\.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-projects3path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainAccountId": { "MarkdownDocumentation": "`DomainAccountId`\n\nThe ID of the AWS account that has the Amazon SageMaker Unified Studio domain. The default value, if\nyou don't specify an ID, is the ID of the account that has the Amazon SageMaker AI\ndomain.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d+$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainaccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProjectId": { "MarkdownDocumentation": "`ProjectId`\n\nThe ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-projectid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainRegion": { "MarkdownDocumentation": "`DomainRegion`\n\nThe AWS Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if\nyou don't specify a Region, is the Region where the Amazon SageMaker AI domain is\nlocated.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z]{2}-[a-zA-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StudioWebPortalAccess": { "MarkdownDocumentation": "`StudioWebPortalAccess`\n\nSets whether you can access the domain in Amazon SageMaker Studio:\nENABLED\nYou can access the domain in Amazon SageMaker Studio. If you migrate the domain to\nAmazon SageMaker Unified Studio, you can access it in both studio interfaces.\n\nDISABLED\nYou can't access the domain in Amazon SageMaker Studio. If you migrate the domain to\nAmazon SageMaker Unified Studio, you can access it only in that studio interface.\n\nTo migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you\nuse the UpdateDomain action.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-studiowebportalaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Domain.UserSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Domain.UserSettings`\n\nA collection of settings that apply to users of Amazon SageMaker Studio. These settings\nare specified when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html)\nAPI is called, and as `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is\ncalled.\n`SecurityGroups` is aggregated when specified in both calls. For all other\nsettings in `UserSettings`, the values specified in\n`CreateUserProfile` take precedence over those specified in\n`CreateDomain`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for\ncommunication.\nOptional when the `CreateDomain.AppNetworkAccessType` parameter is set to\n`PublicInternetOnly`.\nRequired when the `CreateDomain.AppNetworkAccessType` parameter is set to\n`VpcOnly`, unless specified as part of the `DefaultUserSettings` for\nthe domain.\nAmazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the\nmaximum number shown.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `32 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "JupyterLabAppSettings": { "MarkdownDocumentation": "`JupyterLabAppSettings`\n\nThe settings for the JupyterLab application.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: [JupyterLabAppSettings](./aws-properties-sagemaker-domain-jupyterlabappsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-jupyterlabappsettings", "UpdateType": "Mutable", "Required": false, "Type": "JupyterLabAppSettings" }, "KernelGatewayAppSettings": { "MarkdownDocumentation": "`KernelGatewayAppSettings`\n\nThe kernel gateway app settings.\n*Required*: No\n*Type*: [KernelGatewayAppSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-kernelgatewayappsettings", "UpdateType": "Mutable", "Required": false, "Type": "KernelGatewayAppSettings" }, "StudioWebPortalSettings": { "MarkdownDocumentation": "`StudioWebPortalSettings`\n\nStudio settings. If these settings are applied on a user level, they take priority over\nthe settings applied on a domain level.\n*Required*: No\n*Type*: [StudioWebPortalSettings](./aws-properties-sagemaker-domain-studiowebportalsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-studiowebportalsettings", "UpdateType": "Mutable", "Required": false, "Type": "StudioWebPortalSettings" }, "CustomFileSystemConfigs": { "MarkdownDocumentation": "`CustomFileSystemConfigs`\n\nThe settings for assigning a custom file system to a user profile. Permitted users can\naccess this file system in Amazon SageMaker AI Studio.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: Array of [CustomFileSystemConfig](./aws-properties-sagemaker-domain-customfilesystemconfig.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-customfilesystemconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomFileSystemConfig", "DuplicatesAllowed": false }, "CustomPosixUserConfig": { "MarkdownDocumentation": "`CustomPosixUserConfig`\n\nDetails about the POSIX identity that is used for file system operations.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: [CustomPosixUserConfig](./aws-properties-sagemaker-domain-customposixuserconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-customposixuserconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomPosixUserConfig" }, "CodeEditorAppSettings": { "MarkdownDocumentation": "`CodeEditorAppSettings`\n\nThe Code Editor application settings.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: [CodeEditorAppSettings](./aws-properties-sagemaker-domain-codeeditorappsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-codeeditorappsettings", "UpdateType": "Mutable", "Required": false, "Type": "CodeEditorAppSettings" }, "RStudioServerProAppSettings": { "MarkdownDocumentation": "`RStudioServerProAppSettings`\n\nA collection of settings that configure user interaction with the\n`RStudioServerPro` app.\n*Required*: No\n*Type*: [RStudioServerProAppSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-rstudioserverproappsettings", "UpdateType": "Mutable", "Required": false, "Type": "RStudioServerProAppSettings" }, "StudioWebPortal": { "MarkdownDocumentation": "`StudioWebPortal`\n\nWhether the user can access Studio. If this value is set to `DISABLED`, the\nuser cannot access Studio, even if that is the default experience for the domain.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-studiowebportal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RSessionAppSettings": { "MarkdownDocumentation": "`RSessionAppSettings`\n\nA collection of settings that configure the `RSessionGateway` app.\n*Required*: No\n*Type*: [RSessionAppSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-rsessionappsettings", "UpdateType": "Mutable", "Required": false, "Type": "RSessionAppSettings" }, "JupyterServerAppSettings": { "MarkdownDocumentation": "`JupyterServerAppSettings`\n\nThe Jupyter server's app settings.\n*Required*: No\n*Type*: [JupyterServerAppSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-jupyterserverappsettings", "UpdateType": "Mutable", "Required": false, "Type": "JupyterServerAppSettings" }, "AutoMountHomeEFS": { "MarkdownDocumentation": "`AutoMountHomeEFS`\n\nIndicates whether auto-mounting of an EFS volume is supported for the user profile. The\n`DefaultAsDomain` value is only supported for user profiles. Do not use the\n`DefaultAsDomain` value when setting this parameter for a domain.\nSageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.\n*Required*: No\n*Type*: String\n*Allowed values*: `Enabled | Disabled | Defaul...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled", "DefaultAsDomain" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-automounthomeefs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultLandingUri": { "MarkdownDocumentation": "`DefaultLandingUri`\n\nThe default experience that the user is directed to when accessing the domain. The\nsupported values are:\n* `studio::`: Indicates that Studio is the default experience. This value can\n only be passed if `StudioWebPortal` is set to `ENABLED`.\n* `app:JupyterServer:`: Indicates that Studio Classic is the default\n experience.\n*Required*: No\n*Type*: String\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-defaultlandinguri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe execution role for the user.\nSageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SpaceStorageSettings": { "MarkdownDocumentation": "`SpaceStorageSettings`\n\nThe storage settings for a space.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: [DefaultSpaceStorageSettings](./aws-properties-sagemaker-domain-defaultspacestoragesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-spacestoragesettings", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSpaceStorageSettings" }, "SharingSettings": { "MarkdownDocumentation": "`SharingSettings`\n\nSpecifies options for sharing Amazon SageMaker AI Studio notebooks.\n*Required*: No\n*Type*: [SharingSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-sharingsettings", "UpdateType": "Mutable", "Required": false, "Type": "SharingSettings" } } }, "AWS::SageMaker::Endpoint.Alarm": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint.Alarm`\n\nAn Amazon CloudWatch alarm configured to monitor metrics on an endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-alarm.html", "Properties": { "AlarmName": { "Required": true, "MarkdownDocumentation": "`AlarmName`\n\nThe name of a CloudWatch alarm in your account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?!\\s*$).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-alarm.html#cfn-sagemaker-endpoint-alarm-alarmname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Endpoint.AutoRollbackConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint.AutoRollbackConfig`\n\nAutomatic rollback configuration for handling endpoint deployment failures and\nrecovery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-autorollbackconfig.html", "Properties": { "Alarms": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Alarms`\n\nList of CloudWatch alarms in your account that are configured to monitor metrics on an\nendpoint. If any alarms are tripped during a deployment, SageMaker rolls back the\ndeployment.\n*Required*: Yes\n*Type*: Array of [Alarm](./aws-properties-sagemaker-endpoint-alarm.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-autorollbackconfig.html#cfn-sagemaker-endpoint-autorollbackconfig-alarms", "ItemType": "Alarm", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Endpoint.BlueGreenUpdatePolicy": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint.BlueGreenUpdatePolicy`\n\nUpdate policy for a blue/green deployment. If this update policy is specified, SageMaker\ncreates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\ntraffic to the new fleet according to the specified traffic routing configuration. Only\none update policy should be used in the deployment configuration. If no update policy is\nspecified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\nby default.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html", "Properties": { "MaximumExecutionTimeoutInSeconds": { "Required": false, "MarkdownDocumentation": "`MaximumExecutionTimeoutInSeconds`\n\nMaximum execution timeout for the deployment. Note that the timeout value should be\nlarger than the total waiting time specified in `TerminationWaitInSeconds`\nand `WaitIntervalInSeconds`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `600`\n*Maximum*: `28800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html#cfn-sagemaker-endpoint-bluegreenupdatepolicy-maximumexecutiontimeoutinseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TerminationWaitInSeconds": { "Required": false, "MarkdownDocumentation": "`TerminationWaitInSeconds`\n\nAdditional waiting time in seconds after the completion of an endpoint deployment\nbefore terminating the old endpoint fleet. Default is 0.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html#cfn-sagemaker-endpoint-bluegreenupdatepolicy-terminationwaitinseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TrafficRoutingConfiguration": { "Type": "TrafficRoutingConfig", "Required": true, "MarkdownDocumentation": "`TrafficRoutingConfiguration`\n\nDefines the traffic routing strategy to shift traffic from the old fleet to the new\nfleet during an endpoint deployment.\n*Required*: Yes\n*Type*: [TrafficRoutingConfig](./aws-properties-sagemaker-endpoint-trafficroutingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html#cfn-sagemaker-endpoint-bluegreenupdatepolicy-trafficroutingconfiguration", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Endpoint.CapacitySize": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint.CapacitySize`\n\nSpecifies the type and size of the endpoint capacity to activate for a blue/green\ndeployment, a rolling deployment, or a rollback strategy. You can specify your batches\nas either instance count or the overall percentage or your fleet.\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\nthe `Value` to 100%, then SageMaker uses a blue/green rollback strategy and rolls\nall traffic back to the blue fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-capacitysize.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nSpecifies the endpoint capacity type.\n* `INSTANCE_COUNT`: The endpoint activates based on the number of\n instances.\n* `CAPACITY_PERCENT`: The endpoint activates based on the specified\n percentage of capacity.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INSTANCE_COUNT | CAPACITY_P...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSTANCE_COUNT", "CAPACITY_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-capacitysize.html#cfn-sagemaker-endpoint-capacitysize-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nDefines the capacity size, either as a number of instances or a capacity\npercentage.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-capacitysize.html#cfn-sagemaker-endpoint-capacitysize-value", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Endpoint.DeploymentConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint.DeploymentConfig`\n\nThe deployment configuration for an endpoint, which contains the desired deployment\nstrategy and rollback configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html", "Properties": { "AutoRollbackConfiguration": { "Type": "AutoRollbackConfig", "Required": false, "MarkdownDocumentation": "`AutoRollbackConfiguration`\n\nAutomatic rollback configuration for handling endpoint deployment failures and\nrecovery.\n*Required*: No\n*Type*: [AutoRollbackConfig](./aws-properties-sagemaker-endpoint-autorollbackconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-autorollbackconfiguration", "UpdateType": "Mutable" }, "RollingUpdatePolicy": { "Type": "RollingUpdatePolicy", "Required": false, "MarkdownDocumentation": "`RollingUpdatePolicy`\n\nSpecifies a rolling deployment strategy for updating a SageMaker endpoint.\n*Required*: No\n*Type*: [RollingUpdatePolicy](./aws-properties-sagemaker-endpoint-rollingupdatepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-rollingupdatepolicy", "UpdateType": "Mutable" }, "BlueGreenUpdatePolicy": { "Type": "BlueGreenUpdatePolicy", "Required": false, "MarkdownDocumentation": "`BlueGreenUpdatePolicy`\n\nUpdate policy for a blue/green deployment. If this update policy is specified, SageMaker\ncreates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\ntraffic to the new fleet according to the specified traffic routing configuration. Only\none update policy should be used in the deployment configuration. If no update policy is\nspecified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\nby default.\n*Required*: No\n*Type*: [BlueGreenUpdatePolicy](./aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-bluegreenupdatepolicy", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Endpoint.RollingUpdatePolicy": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint.RollingUpdatePolicy`\n\nSpecifies a rolling deployment strategy for updating a SageMaker endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html", "Properties": { "MaximumExecutionTimeoutInSeconds": { "Required": false, "MarkdownDocumentation": "`MaximumExecutionTimeoutInSeconds`\n\nThe time limit for the total deployment. Exceeding this limit causes a timeout.\n*Required*: No\n*Type*: Integer\n*Minimum*: `600`\n*Maximum*: `28800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html#cfn-sagemaker-endpoint-rollingupdatepolicy-maximumexecutiontimeoutinseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MaximumBatchSize": { "Type": "CapacitySize", "Required": true, "MarkdownDocumentation": "`MaximumBatchSize`\n\nBatch size for each rolling step to provision capacity and turn on traffic on the new\nendpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between\n5% to 50% of the variant's total instance count.\n*Required*: Yes\n*Type*: [CapacitySize](./aws-properties-sagemaker-endpoint-capacitysize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html#cfn-sagemaker-endpoint-rollingupdatepolicy-maximumbatchsize", "UpdateType": "Mutable" }, "WaitIntervalInSeconds": { "Required": true, "MarkdownDocumentation": "`WaitIntervalInSeconds`\n\nThe length of the baking period, during which SageMaker monitors alarms for each batch on\nthe new fleet.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html#cfn-sagemaker-endpoint-rollingupdatepolicy-waitintervalinseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RollbackMaximumBatchSize": { "Type": "CapacitySize", "Required": false, "MarkdownDocumentation": "`RollbackMaximumBatchSize`\n\nBatch size for rollback to the old endpoint fleet. Each rolling step to provision\ncapacity and turn on traffic on the old endpoint fleet, and terminate capacity on the\nnew endpoint fleet. If this field is absent, the default value will be set to 100% of\ntotal capacity which means to bring up the whole capacity of the old fleet at once\nduring rollback.\n*Required*: No\n*Type*: [CapacitySize](./aws-properties-sagemaker-endpoint-capacitysize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html#cfn-sagemaker-endpoint-rollingupdatepolicy-rollbackmaximumbatchsize", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Endpoint.TrafficRoutingConfig": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint.TrafficRoutingConfig`\n\nDefines the traffic routing strategy during an endpoint deployment to shift traffic\nfrom the old fleet to the new fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nTraffic routing strategy type.\n* `ALL_AT_ONCE`: Endpoint traffic shifts to the new fleet in a single\n step.\n* `CANARY`: Endpoint traffic shifts to the new fleet in two steps.\n The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.\n* `LINEAR`: Endpoint traffic shifts to the new fleet in n steps of a\n configurable size.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL_AT_ONCE | CANARY | LINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL_AT_ONCE", "CANARY", "LINEAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html#cfn-sagemaker-endpoint-trafficroutingconfig-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "LinearStepSize": { "Type": "CapacitySize", "Required": false, "MarkdownDocumentation": "`LinearStepSize`\n\nBatch size for each step to turn on traffic on the new endpoint fleet.\n`Value` must be 10-50% of the variant's total instance count.\n*Required*: No\n*Type*: [CapacitySize](./aws-properties-sagemaker-endpoint-capacitysize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html#cfn-sagemaker-endpoint-trafficroutingconfig-linearstepsize", "UpdateType": "Mutable" }, "CanarySize": { "Type": "CapacitySize", "Required": false, "MarkdownDocumentation": "`CanarySize`\n\nBatch size for the first step to turn on traffic on the new endpoint fleet.\n`Value` must be less than or equal to 50% of the variant's total instance\ncount.\n*Required*: No\n*Type*: [CapacitySize](./aws-properties-sagemaker-endpoint-capacitysize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html#cfn-sagemaker-endpoint-trafficroutingconfig-canarysize", "UpdateType": "Mutable" }, "WaitIntervalInSeconds": { "Required": false, "MarkdownDocumentation": "`WaitIntervalInSeconds`\n\nThe waiting time (in seconds) between incremental steps to turn on traffic on the new\nendpoint fleet.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html#cfn-sagemaker-endpoint-trafficroutingconfig-waitintervalinseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Endpoint.VariantProperty": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint.VariantProperty`\n\nSpecifies a production variant property type for an Endpoint.\nIf you are updating an Endpoint with the [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) option set to `true`, the\n`VarientProperty` objects listed in [ExcludeRetainedVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-ExcludeRetainedVariantProperties) override the existing variant properties of\nthe Endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html", "Properties": { "VariantPropertyType": { "Required": false, "MarkdownDocumentation": "`VariantPropertyType`\n\nThe type of variant property. The supported values are:\n* `DesiredInstanceCount`: Overrides the existing variant instance counts\n using the [InitialInstanceCount](https://docs.aws.amazon.com/sagemaker/latest/dg/API_ProductionVariant.html#SageMaker-Type-ProductionVariant-InitialInstanceCount) values in the [ProductionVariants](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html#SageMaker-CreateEndpointConfig-request-ProductionVariants).\n* `DesiredWeight`: Overrides the existing variant weights using the [InitialVariantWeight](https://docs.aws.amazon.com/sagemaker/latest/dg/API_ProductionVariant.html#SageMaker-Type-ProductionVariant-InitialVariantWeight) values in the [ProductionVariants](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html#SageMaker-CreateEndpointConfig-request-ProductionVariants).\n* `DataCaptureConfig`: (Not currently 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html#cfn-sagemaker-endpoint-variantproperty-variantpropertytype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SageMaker::EndpointConfig.AsyncInferenceClientConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.AsyncInferenceClientConfig`\n\nConfigures the behavior of the client used by SageMaker to interact with the model\ncontainer during asynchronous inference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceclientconfig.html", "Properties": { "MaxConcurrentInvocationsPerInstance": { "Required": false, "MarkdownDocumentation": "`MaxConcurrentInvocationsPerInstance`\n\nThe maximum number of concurrent requests sent by the SageMaker client to the model\ncontainer. If no value is provided, SageMaker will choose an optimal value for you.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceclientconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceclientconfig-maxconcurrentinvocationsperinstance", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.AsyncInferenceConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.AsyncInferenceConfig`\n\nSpecifies configuration for how an endpoint performs asynchronous inference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceconfig.html", "Properties": { "OutputConfig": { "Type": "AsyncInferenceOutputConfig", "Required": true, "MarkdownDocumentation": "`OutputConfig`\n\nSpecifies the configuration for asynchronous inference invocation outputs.\n*Required*: Yes\n*Type*: [AsyncInferenceOutputConfig](./aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceconfig-outputconfig", "UpdateType": "Immutable" }, "ClientConfig": { "Type": "AsyncInferenceClientConfig", "Required": false, "MarkdownDocumentation": "`ClientConfig`\n\nConfigures the behavior of the client used by SageMaker to interact with the model\ncontainer during asynchronous inference.\n*Required*: No\n*Type*: [AsyncInferenceClientConfig](./aws-properties-sagemaker-endpointconfig-asyncinferenceclientconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceconfig-clientconfig", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.AsyncInferenceNotificationConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.AsyncInferenceNotificationConfig`\n\nSpecifies the configuration for notifications of inference results for asynchronous\ninference.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferencenotificationconfig.html", "Properties": { "IncludeInferenceResponseIn": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`IncludeInferenceResponseIn`\n\nThe Amazon SNS topics where you want the inference response to be included.\n###### Note\nThe inference response is included only if the response size is less than or equal\nto 128 KB.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferencenotificationconfig.html#cfn-sagemaker-endpointconfig-asyncinferencenotificationconfig-includeinferenceresponsein", "UpdateType": "Immutable" }, "SuccessTopic": { "Required": false, "MarkdownDocumentation": "`SuccessTopic`\n\nAmazon SNS topic to post a notification to when an inference completes successfully. If\nno topic is provided, no notification is sent on success.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferencenotificationconfig.html#cfn-sagemaker-endpointconfig-asyncinferencenotificationconfig-successtopic", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ErrorTopic": { "Required": false, "MarkdownDocumentation": "`ErrorTopic`\n\nAmazon SNS topic to post a notification to when an inference fails. If no topic is\nprovided, no notification is sent on failure.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferencenotificationconfig.html#cfn-sagemaker-endpointconfig-asyncinferencenotificationconfig-errortopic", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.AsyncInferenceOutputConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.AsyncInferenceOutputConfig`\n\nSpecifies the configuration for asynchronous inference invocation outputs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html", "Properties": { "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS Key Management Service (AWS KMS) key that Amazon\nSageMaker uses to encrypt the asynchronous inference output in Amazon S3.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceoutputconfig-kmskeyid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "NotificationConfig": { "Type": "AsyncInferenceNotificationConfig", "Required": false, "MarkdownDocumentation": "`NotificationConfig`\n\nSpecifies the configuration for notifications of inference results for asynchronous\ninference.\n*Required*: No\n*Type*: [AsyncInferenceNotificationConfig](./aws-properties-sagemaker-endpointconfig-asyncinferencenotificationconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceoutputconfig-notificationconfig", "UpdateType": "Immutable" }, "S3OutputPath": { "Required": false, "MarkdownDocumentation": "`S3OutputPath`\n\nThe Amazon S3 location to upload inference responses 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceoutputconfig-s3outputpath", "PrimitiveType": "String", "UpdateType": "Immutable" }, "S3FailurePath": { "Required": false, "MarkdownDocumentation": "`S3FailurePath`\n\nThe Amazon S3 location to upload failure inference responses to.\n*Required*: No\n*Type*: String\n*Pattern*: `(https|s3)://([^/])/?(.*)`\n*Minimum*: `0`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceoutputconfig-s3failurepath", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.CapacityReservationConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.CapacityReservationConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-capacityreservationconfig.html", "Properties": { "MlReservationArn": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-capacityreservationconfig.html#cfn-sagemaker-endpointconfig-capacityreservationconfig-mlreservationarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CapacityReservationPreference": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-capacityreservationconfig.html#cfn-sagemaker-endpointconfig-capacityreservationconfig-capacityreservationpreference", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.CaptureContentTypeHeader": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.CaptureContentTypeHeader`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader.html", "Properties": { "JsonContentTypes": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader.html#cfn-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader-jsoncontenttypes", "UpdateType": "Immutable" }, "CsvContentTypes": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader.html#cfn-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader-csvcontenttypes", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.CaptureOption": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.CaptureOption`\n\nSpecifies whether the endpoint captures input data or output data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-captureoption.html", "Properties": { "CaptureMode": { "Required": true, "MarkdownDocumentation": "`CaptureMode`\n\nSpecifies whether the endpoint captures input data or output data.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Input | Output | InputAndOu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Input", "Output", "InputAndOutput" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-captureoption.html#cfn-sagemaker-endpointconfig-captureoption-capturemode", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ClarifyExplainerConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ClarifyExplainerConfig`\n\nThe configuration parameters for the SageMaker Clarify explainer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html", "Properties": { "InferenceConfig": { "Type": "ClarifyInferenceConfig", "Required": false, "MarkdownDocumentation": "`InferenceConfig`\n\nThe inference configuration parameter for the model container.\n*Required*: No\n*Type*: [ClarifyInferenceConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html#cfn-sagemaker-endpointconfig-clarifyexplainerconfig-inferenceconfig", "UpdateType": "Immutable" }, "EnableExplanations": { "Required": false, "MarkdownDocumentation": "`EnableExplanations`\n\nA JMESPath boolean expression used to filter which records to explain. Explanations\nare activated by default. See [`EnableExplanations`](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable)for additional information.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html#cfn-sagemaker-endpointconfig-clarifyexplainerconfig-enableexplanations", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ShapConfig": { "Type": "ClarifyShapConfig", "Required": true, "MarkdownDocumentation": "`ShapConfig`\n\nThe configuration for SHAP analysis.\n*Required*: Yes\n*Type*: [ClarifyShapConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html#cfn-sagemaker-endpointconfig-clarifyexplainerconfig-shapconfig", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ClarifyFeatureType": { "Required": false, "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ClarifyFeatureType`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyfeaturetype.html", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AWS::SageMaker::EndpointConfig.ClarifyHeader": { "Required": false, "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ClarifyHeader`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyheader.html", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AWS::SageMaker::EndpointConfig.ClarifyInferenceConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ClarifyInferenceConfig`\n\nThe inference configuration parameter for the model container.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html", "Properties": { "ContentTemplate": { "Required": false, "MarkdownDocumentation": "`ContentTemplate`\n\nA template string used to format a JSON record into an acceptable model container\ninput. For example, a `ContentTemplate` string\n`'{\"myfeatures\":$features}'` will format a list of features\n`[1,2,3]` into the record string `'{\"myfeatures\":[1,2,3]}'`.\nRequired only when the model container input is in JSON Lines format.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-contenttemplate", "PrimitiveType": "String", "UpdateType": "Immutable" }, "LabelHeaders": { "Type": "List", "Required": false, "MarkdownDocumentation": "`LabelHeaders`\n\nFor multiclass classification problems, the label headers are the names of the\nclasses. Otherwise, the label header is the name of the predicted label. These are used\nto help readability for the output of the `InvokeEndpoint` API. See the\n[response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under **Invoke the endpoint**\nin the Developer Guide for more information. If there are no label headers in the model\ncontainer output, provide them manually using this parameter.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `16`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelheaders", "ItemType": "ClarifyHeader", "UpdateType": "Immutable" }, "MaxPayloadInMB": { "Required": false, "MarkdownDocumentation": "`MaxPayloadInMB`\n\nThe maximum payload size (MB) allowed of a request from the explainer to the model\ncontainer. Defaults to `6` MB.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `25`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-maxpayloadinmb", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "ProbabilityIndex": { "Required": false, "MarkdownDocumentation": "`ProbabilityIndex`\n\nA zero-based index used to extract a probability value (score) or list from model\ncontainer output in CSV format. If this value is not provided, the entire model\ncontainer output will be treated as a probability value (score) or list.\n**Example for a single class model:** If the model\ncontainer output consists of a string-formatted prediction label followed by its\nprobability: `'1,0.6'`, set `ProbabilityIndex` to `1`\nto select the probability value `0.6`.\n**Example for a multiclass model:** If the model\ncontainer output consists of a string-formatted prediction label followed by its\nprobability: `'\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"'`, set\n`ProbabilityIndex` to `1` to select the probability values\n`[0.1,0.6,0.3]`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-probabilityindex", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "LabelAttribute": { "Required": false, "MarkdownDocumentation": "`LabelAttribute`\n\nA JMESPath expression used to locate the list of label headers in the model container\noutput.\n**Example**: If the model container output of a batch\nrequest is `'{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}'`,\nthen set `LabelAttribute` to `'labels'` to extract the list of\nlabel headers `[\"cat\",\"dog\",\"fish\"]`\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelattribute", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FeatureTypes": { "Type": "List", "Required": false, "MarkdownDocumentation": "`FeatureTypes`\n\nA list of data types of the features (optional). Applicable only to NLP\nexplainability. If provided, `FeatureTypes` must have at least one\n`'text'` string (for example, `['text']`). If\n`FeatureTypes` is not provided, the explainer infers the feature types\nbased on the baseline data. The feature types are included in the endpoint response\npayload. For additional information see the [response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under **Invoke the endpoint**\nin the Developer Guide for more information.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featuretypes", "ItemType": "ClarifyFeatureType", "UpdateType": "Immutable" }, "FeatureHeaders": { "Type": "List", "Required": false, "MarkdownDocumentation": "`FeatureHeaders`\n\nThe names of the features. If provided, these are included in the endpoint response\npayload to help readability of the `InvokeEndpoint` output. See the [Response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under **Invoke the endpoint**\nin the Developer Guide for more information.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featureheaders", "ItemType": "ClarifyHeader", "UpdateType": "Immutable" }, "LabelIndex": { "Required": false, "MarkdownDocumentation": "`LabelIndex`\n\nA zero-based index used to extract a label header or list of label headers from model\ncontainer output in CSV format.\n**Example for a multiclass model:** If the model\ncontainer output consists of label headers followed by probabilities:\n`'\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"'`, set\n`LabelIndex` to `0` to select the label headers\n`['cat','dog','fish']`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelindex", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "ProbabilityAttribute": { "Required": false, "MarkdownDocumentation": "`ProbabilityAttribute`\n\nA JMESPath expression used to extract the probability (or score) from the model\ncontainer output if the model container is in JSON Lines format.\n**Example**: If the model container output of a single\nrequest is `'{\"predicted_label\":1,\"probability\":0.6}'`, then set\n`ProbabilityAttribute` to `'probability'`.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-probabilityattribute", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FeaturesAttribute": { "Required": false, "MarkdownDocumentation": "`FeaturesAttribute`\n\nProvides the JMESPath expression to extract the features from a model container input\nin JSON Lines format. For example, if `FeaturesAttribute` is the JMESPath\nexpression `'myfeatures'`, it extracts a list of features\n`[1,2,3]` from request data `'{\"myfeatures\":[1,2,3]}'`.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featuresattribute", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MaxRecordCount": { "Required": false, "MarkdownDocumentation": "`MaxRecordCount`\n\nThe maximum number of records in a request that the model container can process when\nquerying the model container for the predictions of a [synthetic dataset](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic). A record is a unit of input data that inference can be\nmade on, for example, a single line in CSV data. If `MaxRecordCount` is\n`1`, the model container expects one record per request. A value of 2 or\ngreater means that the model expects batch requests, which can reduce overhead and speed\nup the inferencing process. If this parameter is not provided, the explainer will tune\nthe record count per request according to the model container's capacity at\nruntime.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-maxrecordcount", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ClarifyShapBaselineConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ClarifyShapBaselineConfig`\n\nThe configuration for the [SHAP\nbaseline](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html) (also called the background or reference dataset) of the Kernal\nSHAP algorithm.\n###### Note\n* The number of records in the baseline data determines the size of the\n synthetic dataset, which has an impact on latency of explainability\n requests. For more information, see the **Synthetic\n data** of [Configure and create an endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html).\n* `ShapBaseline` and `ShapBaselineUri` are mutually\n exclusive parameters. One or the either is required to configure a SHAP\n baseline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html", "Properties": { "ShapBaseline": { "Required": false, "MarkdownDocumentation": "`ShapBaseline`\n\nThe inline SHAP baseline data in string format. `ShapBaseline` can have one\nor multiple records to be used as the baseline dataset. The format of the SHAP baseline\nfile should be the same format as the training dataset. For example, if the training\ndataset is in CSV format and each record contains four features, and all features are\nnumerical, then the format of the baseline data should also share these characteristics.\nFor natural language processing (NLP) of text columns, the baseline value should be the\nvalue used to replace the unit of text specified by the `Granularity` of the\n`TextConfig` parameter. The size limit for `ShapBasline` is 4\nKB. Use the `ShapBaselineUri` parameter if you want to provide more than 4 KB\nof baseline data.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-shapbaseline", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ShapBaselineUri": { "Required": false, "MarkdownDocumentation": "`ShapBaselineUri`\n\nThe uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is\nstored. The format of the SHAP baseline file should be the same format as the format of\nthe training dataset. For example, if the training dataset is in CSV format, and each\nrecord in the training dataset has four features, and all features are numerical, then\nthe baseline file should also have this same format. Each record should contain only the\nfeatures. If you are using a virtual private cloud (VPC), the\n`ShapBaselineUri` should be accessible to the VPC. For more information\nabout setting up endpoints with Amazon Virtual Private Cloud, see [Give SageMaker access to\nResources in your Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\n*Required*: No\n*Type*: String\n*Pattern*: `(https|s3)://([^/]+)/?(.*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-shapbaselineuri", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MimeType": { "Required": false, "MarkdownDocumentation": "`MimeType`\n\nThe MIME type of the baseline data. Choose from `'text/csv'` or\n`'application/jsonlines'`. Defaults to `'text/csv'`.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*`\n*Minimum*: `0`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-mimetype", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ClarifyShapConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ClarifyShapConfig`\n\nThe configuration for SHAP analysis using SageMaker Clarify Explainer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html", "Properties": { "TextConfig": { "Type": "ClarifyTextConfig", "Required": false, "MarkdownDocumentation": "`TextConfig`\n\nA parameter that indicates if text features are treated as text and explanations are\nprovided for individual units of text. Required for natural language processing (NLP)\nexplainability only.\n*Required*: No\n*Type*: [ClarifyTextConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-textconfig", "UpdateType": "Immutable" }, "UseLogit": { "Required": false, "MarkdownDocumentation": "`UseLogit`\n\nA Boolean toggle to indicate if you want to use the logit function (true) or log-odds\nunits (false) for model predictions. Defaults to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-uselogit", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "Seed": { "Required": false, "MarkdownDocumentation": "`Seed`\n\nThe starting value used to initialize the random number generator in the explainer.\nProvide a value for this parameter to obtain a deterministic SHAP result.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-seed", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "ShapBaselineConfig": { "Type": "ClarifyShapBaselineConfig", "Required": true, "MarkdownDocumentation": "`ShapBaselineConfig`\n\nThe configuration for the SHAP baseline of the Kernal SHAP algorithm.\n*Required*: Yes\n*Type*: [ClarifyShapBaselineConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-shapbaselineconfig", "UpdateType": "Immutable" }, "NumberOfSamples": { "Required": false, "MarkdownDocumentation": "`NumberOfSamples`\n\nThe number of samples to be used for analysis by the Kernal SHAP algorithm.\n###### Note\nThe number of samples determines the size of the synthetic dataset, which has an\nimpact on latency of explainability requests. For more information, see the\n**Synthetic data** of [Configure and create an endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-numberofsamples", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ClarifyTextConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ClarifyTextConfig`\n\nA parameter used to configure the SageMaker Clarify explainer to treat text features as text so\nthat explanations are provided for individual units of text. Required only for natural\nlanguage processing (NLP) explainability.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html", "Properties": { "Language": { "Required": true, "MarkdownDocumentation": "`Language`\n\nSpecifies the language of the text features in [ISO 639-1]( https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or\n[ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code of a\nsupported language.\n###### Note\nFor a mix of multiple languages, use code `'xx'`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `af | sq | ar | hy | eu | bn...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "af", "sq", "ar", "hy", "eu", "bn", "bg", "ca", "zh", "hr", "cs", "da", "nl", "en", "et", "fi", "fr", "de", "el", "gu", "he", "hi", "hu", "is", "id", "ga", "it", "kn", "ky", "lv", "lt", "lb", "mk", "ml", "mr", "ne", "nb", "fa", "pl", "pt", "ro", "ru", "sa", "sr", "tn", "si", "sk", "sl", "es", "sv", "tl", "ta", "tt", "te", "tr", "uk", "ur", "yo", "lij", "xx" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html#cfn-sagemaker-endpointconfig-clarifytextconfig-language", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Granularity": { "Required": true, "MarkdownDocumentation": "`Granularity`\n\nThe unit of granularity for the analysis of text features. For example, if the unit is\n`'token'`, then each token (like a word in English) of the text is\ntreated as a feature. SHAP values are computed for each unit/feature.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `token | sentence | paragrap...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "token", "sentence", "paragraph" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html#cfn-sagemaker-endpointconfig-clarifytextconfig-granularity", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.DataCaptureConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.DataCaptureConfig`\n\nSpecifies the configuration of your endpoint for model monitor data capture.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html", "Properties": { "CaptureOptions": { "Type": "List", "Required": true, "MarkdownDocumentation": "`CaptureOptions`\n\nSpecifies whether the endpoint captures input data to your model, output data from your\nmodel, or both.\n*Required*: Yes\n*Type*: Array of [CaptureOption](./aws-properties-sagemaker-endpointconfig-captureoption.html)\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-captureoptions", "ItemType": "CaptureOption", "UpdateType": "Immutable" }, "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS Key Management Service (AWS KMS) key that\nAmazon SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side\nencryption. The KmsKeyId can be any of the following formats: Key ID:\n1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:\narn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:\nalias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias If\nyou don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for\nyour role's account. For more information, see KMS-Managed Encryption Keys\n(https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the Amazon\nSimple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM\nrole that you specify in your CreateModel\n(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API\\_CreateModel.html) request.\nFor more information, see Using Key Policies in AWS KMS\n(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*Pattern*: `[a-zA-Z0-9:/_-]*`\n*Minimum*: `0`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-kmskeyid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DestinationS3Uri": { "Required": true, "MarkdownDocumentation": "`DestinationS3Uri`\n\nThe S3 bucket where model monitor stores captured data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(https|s3)://([^/])/?(.*)`\n*Minimum*: `0`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-destinations3uri", "PrimitiveType": "String", "UpdateType": "Immutable" }, "InitialSamplingPercentage": { "Required": true, "MarkdownDocumentation": "`InitialSamplingPercentage`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-initialsamplingpercentage", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "CaptureContentTypeHeader": { "Type": "CaptureContentTypeHeader", "Required": false, "MarkdownDocumentation": "`CaptureContentTypeHeader`\n\nA list of the JSON and CSV content type that the endpoint captures.\n*Required*: No\n*Type*: [CaptureContentTypeHeader](./aws-properties-sagemaker-endpointconfig-capturecontenttypeheader.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader", "UpdateType": "Immutable" }, "EnableCapture": { "Required": false, "MarkdownDocumentation": "`EnableCapture`\n\nSet to `True` to enable data capture.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-enablecapture", "PrimitiveType": "Boolean", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ExplainerConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ExplainerConfig`\n\nA parameter to activate explainers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-explainerconfig.html", "Properties": { "ClarifyExplainerConfig": { "Type": "ClarifyExplainerConfig", "Required": false, "MarkdownDocumentation": "`ClarifyExplainerConfig`\n\nA member of `ExplainerConfig` that contains configuration parameters for\nthe SageMaker Clarify explainer.\n*Required*: No\n*Type*: [ClarifyExplainerConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-explainerconfig.html#cfn-sagemaker-endpointconfig-explainerconfig-clarifyexplainerconfig", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ManagedInstanceScaling": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ManagedInstanceScaling`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-managedinstancescaling.html", "Properties": { "Status": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-managedinstancescaling.html#cfn-sagemaker-endpointconfig-productionvariant-managedinstancescaling-status", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MaxInstanceCount": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-managedinstancescaling.html#cfn-sagemaker-endpointconfig-productionvariant-managedinstancescaling-maxinstancecount", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "MinInstanceCount": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-managedinstancescaling.html#cfn-sagemaker-endpointconfig-productionvariant-managedinstancescaling-mininstancecount", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ProductionVariant": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ProductionVariant`\n\nSpecifies a model that you want to host and the resources to deploy for hosting it.\nIf you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among\nthe models by specifying the `InitialVariantWeight` objects.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html", "Properties": { "ManagedInstanceScaling": { "Type": "ManagedInstanceScaling", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-managedinstancescaling", "UpdateType": "Mutable" }, "ModelName": { "Required": false, "MarkdownDocumentation": "`ModelName`\n\nThe name of the model that you want to host. This is the name that you specified\nwhen creating the model.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?`\n*Minimum*: `0`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-modelname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "VolumeSizeInGB": { "Required": false, "MarkdownDocumentation": "`VolumeSizeInGB`\n\nThe size, in GB, of the ML storage volume attached to individual inference instance\nassociated with the production variant. Currently only Amazon EBS gp2 storage volumes are\nsupported.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-volumesizeingb", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "EnableSSMAccess": { "Required": false, "MarkdownDocumentation": "`EnableSSMAccess`\n\nYou can use this parameter to turn on native AWS Systems Manager (SSM)\naccess for a production variant behind an endpoint. By default, SSM access is disabled\nfor all production variants behind an endpoint. You can turn on or turn off SSM access\nfor a production variant behind an existing endpoint by creating a new endpoint\nconfiguration and calling `UpdateEndpoint`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-enablessmaccess", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "VariantName": { "Required": true, "MarkdownDocumentation": "`VariantName`\n\nThe name of the production variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `0`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-variantname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "InitialInstanceCount": { "Required": false, "MarkdownDocumentation": "`InitialInstanceCount`\n\nNumber 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-initialinstancecount", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "RoutingConfig": { "Type": "RoutingConfig", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-routingconfig", "UpdateType": "Mutable" }, "InitialVariantWeight": { "Required": false, "MarkdownDocumentation": "`InitialVariantWeight`\n\nDetermines initial traffic distribution among all of the models that you specify in\nthe endpoint configuration. The traffic to a production variant is determined by the\nratio of the `VariantWeight` to the sum of all `VariantWeight`\nvalues across all ProductionVariants. If unspecified, it defaults to 1.0.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-initialvariantweight", "PrimitiveType": "Double", "UpdateType": "Immutable" }, "ModelDataDownloadTimeoutInSeconds": { "Required": false, "MarkdownDocumentation": "`ModelDataDownloadTimeoutInSeconds`\n\nThe timeout value, in seconds, to download and extract the model that you want to host\nfrom Amazon S3 to the individual inference instance associated with this production\nvariant.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `3600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-modeldatadownloadtimeoutinseconds", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "CapacityReservationConfig": { "Type": "CapacityReservationConfig", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-capacityreservationconfig", "UpdateType": "Immutable" }, "InferenceAmiVersion": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-inferenceamiversion", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ContainerStartupHealthCheckTimeoutInSeconds": { "Required": false, "MarkdownDocumentation": "`ContainerStartupHealthCheckTimeoutInSeconds`\n\nThe timeout value, in seconds, for your inference container to pass health check by\nSageMaker Hosting. For more information about health check, see [How Your Container Should Respond to Health Check (Ping) Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests).\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `3600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-containerstartuphealthchecktimeoutinseconds", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "ServerlessConfig": { "Type": "ServerlessConfig", "Required": false, "MarkdownDocumentation": "`ServerlessConfig`\n\nThe serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.\n*Required*: No\n*Type*: [ServerlessConfig](./aws-properties-sagemaker-endpointconfig-serverlessconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-serverlessconfig", "UpdateType": "Mutable" }, "InstanceType": { "Required": false, "MarkdownDocumentation": "`InstanceType`\n\nThe ML compute instance type.\n*Required*: No\n*Type*: String\n*Allowed values*: `ml.t2.medium | ml.t2.large ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ml.t2.medium", "ml.t2.large", "ml.t2.xlarge", "ml.t2.2xlarge", "ml.m4.xlarge", "ml.m4.2xlarge", "ml.m4.4xlarge", "ml.m4.10xlarge", "ml.m4.16xlarge", "ml.m5.large", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.12xlarge", "ml.m5.24xlarge", "ml.m5d.large", "ml.m5d.xlarge", "ml.m5d.2xlarge", "ml.m5d.4xlarge", "ml.m5d.12xlarge", "ml.m5d.24xlarge", "ml.c4.large", "ml.c4.xlarge", "ml.c4.2xlarge", "ml.c4.4xlarge", "ml.c4.8xlarge", "ml.p2.xlarge", "ml.p2.8xlarge", "ml.p2.16xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.c5.large", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.18xlarge", "ml.c5d.large", "ml.c5d.xlarge", "ml.c5d.2xlarge", "ml.c5d.4xlarge", "ml.c5d.9xlarge", "ml.c5d.18xlarge", "ml.g4dn.xlarge", "ml.g4dn.2xlarge", "ml.g4dn.4xlarge", "ml.g4dn.8xlarge", "ml.g4dn.12xlarge", "ml.g4dn.16xlarge", "ml.r5.large", "ml.r5.xlarge", "ml.r5.2xlarge", "ml.r5.4xlarge", "ml.r5.12xlarge", "ml.r5.24xlarge", "ml.r5d.large", "ml.r5d.xlarge", "ml.r5d.2xlarge", "ml.r5d.4xlarge", "ml.r5d.12xlarge", "ml.r5d.24xlarge", "ml.inf1.xlarge", "ml.inf1.2xlarge", "ml.inf1.6xlarge", "ml.inf1.24xlarge", "ml.dl1.24xlarge", "ml.c6i.large", "ml.c6i.xlarge", "ml.c6i.2xlarge", "ml.c6i.4xlarge", "ml.c6i.8xlarge", "ml.c6i.12xlarge", "ml.c6i.16xlarge", "ml.c6i.24xlarge", "ml.c6i.32xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", "ml.m6i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.12xlarge", "ml.m6i.16xlarge", "ml.m6i.24xlarge", "ml.m6i.32xlarge", "ml.r6i.large", "ml.r6i.xlarge", "ml.r6i.2xlarge", "ml.r6i.4xlarge", "ml.r6i.8xlarge", "ml.r6i.12xlarge", "ml.r6i.16xlarge", "ml.r6i.24xlarge", "ml.r6i.32xlarge", "ml.g5.xlarge", "ml.g5.2xlarge", "ml.g5.4xlarge", "ml.g5.8xlarge", "ml.g5.12xlarge", "ml.g5.16xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", "ml.g6.xlarge", "ml.g6.2xlarge", "ml.g6.4xlarge", "ml.g6.8xlarge", "ml.g6.12xlarge", "ml.g6.16xlarge", "ml.g6.24xlarge", "ml.g6.48xlarge", "ml.r8g.medium", "ml.r8g.large", "ml.r8g.xlarge", "ml.r8g.2xlarge", "ml.r8g.4xlarge", "ml.r8g.8xlarge", "ml.r8g.12xlarge", "ml.r8g.16xlarge", "ml.r8g.24xlarge", "ml.r8g.48xlarge", "ml.g6e.xlarge", "ml.g6e.2xlarge", "ml.g6e.4xlarge", "ml.g6e.8xlarge", "ml.g6e.12xlarge", "ml.g6e.16xlarge", "ml.g6e.24xlarge", "ml.g6e.48xlarge", "ml.p4d.24xlarge", "ml.c7g.large", "ml.c7g.xlarge", "ml.c7g.2xlarge", "ml.c7g.4xlarge", "ml.c7g.8xlarge", "ml.c7g.12xlarge", "ml.c7g.16xlarge", "ml.m6g.large", "ml.m6g.xlarge", "ml.m6g.2xlarge", "ml.m6g.4xlarge", "ml.m6g.8xlarge", "ml.m6g.12xlarge", "ml.m6g.16xlarge", "ml.m6gd.large", "ml.m6gd.xlarge", "ml.m6gd.2xlarge", "ml.m6gd.4xlarge", "ml.m6gd.8xlarge", "ml.m6gd.12xlarge", "ml.m6gd.16xlarge", "ml.c6g.large", "ml.c6g.xlarge", "ml.c6g.2xlarge", "ml.c6g.4xlarge", "ml.c6g.8xlarge", "ml.c6g.12xlarge", "ml.c6g.16xlarge", "ml.c6gd.large", "ml.c6gd.xlarge", "ml.c6gd.2xlarge", "ml.c6gd.4xlarge", "ml.c6gd.8xlarge", "ml.c6gd.12xlarge", "ml.c6gd.16xlarge", "ml.c6gn.large", "ml.c6gn.xlarge", "ml.c6gn.2xlarge", "ml.c6gn.4xlarge", "ml.c6gn.8xlarge", "ml.c6gn.12xlarge", "ml.c6gn.16xlarge", "ml.r6g.large", "ml.r6g.xlarge", "ml.r6g.2xlarge", "ml.r6g.4xlarge", "ml.r6g.8xlarge", "ml.r6g.12xlarge", "ml.r6g.16xlarge", "ml.r6gd.large", "ml.r6gd.xlarge", "ml.r6gd.2xlarge", "ml.r6gd.4xlarge", "ml.r6gd.8xlarge", "ml.r6gd.12xlarge", "ml.r6gd.16xlarge", "ml.p4de.24xlarge", "ml.trn1.2xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.trn2.48xlarge", "ml.inf2.xlarge", "ml.inf2.8xlarge", "ml.inf2.24xlarge", "ml.inf2.48xlarge", "ml.p5.48xlarge", "ml.p5e.48xlarge", "ml.p5en.48xlarge", "ml.m7i.large", "ml.m7i.xlarge", "ml.m7i.2xlarge", "ml.m7i.4xlarge", "ml.m7i.8xlarge", "ml.m7i.12xlarge", "ml.m7i.16xlarge", "ml.m7i.24xlarge", "ml.m7i.48xlarge", "ml.c7i.large", "ml.c7i.xlarge", "ml.c7i.2xlarge", "ml.c7i.4xlarge", "ml.c7i.8xlarge", "ml.c7i.12xlarge", "ml.c7i.16xlarge", "ml.c7i.24xlarge", "ml.c7i.48xlarge", "ml.r7i.large", "ml.r7i.xlarge", "ml.r7i.2xlarge", "ml.r7i.4xlarge", "ml.r7i.8xlarge", "ml.r7i.12xlarge", "ml.r7i.16xlarge", "ml.r7i.24xlarge", "ml.r7i.48xlarge", "ml.c8g.medium", "ml.c8g.large", "ml.c8g.xlarge", "ml.c8g.2xlarge", "ml.c8g.4xlarge", "ml.c8g.8xlarge", "ml.c8g.12xlarge", "ml.c8g.16xlarge", "ml.c8g.24xlarge", "ml.c8g.48xlarge", "ml.r7gd.medium", "ml.r7gd.large", "ml.r7gd.xlarge", "ml.r7gd.2xlarge", "ml.r7gd.4xlarge", "ml.r7gd.8xlarge", "ml.r7gd.12xlarge", "ml.r7gd.16xlarge", "ml.m8g.medium", "ml.m8g.large", "ml.m8g.xlarge", "ml.m8g.2xlarge", "ml.m8g.4xlarge", "ml.m8g.8xlarge", "ml.m8g.12xlarge", "ml.m8g.16xlarge", "ml.m8g.24xlarge", "ml.m8g.48xlarge", "ml.c6in.large", "ml.c6in.xlarge", "ml.c6in.2xlarge", "ml.c6in.4xlarge", "ml.c6in.8xlarge", "ml.c6in.12xlarge", "ml.c6in.16xlarge", "ml.c6in.24xlarge", "ml.c6in.32xlarge", "ml.p6-b200.48xlarge", "ml.p6e-gb200.36xlarge", "ml.p5.4xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-instancetype", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.RoutingConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.RoutingConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-routingconfig.html", "Properties": { "RoutingStrategy": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-routingconfig.html#cfn-sagemaker-endpointconfig-productionvariant-routingconfig-routingstrategy", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.ServerlessConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.ServerlessConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html", "Properties": { "MaxConcurrency": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html#cfn-sagemaker-endpointconfig-productionvariant-serverlessconfig-maxconcurrency", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "MemorySizeInMB": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html#cfn-sagemaker-endpointconfig-productionvariant-serverlessconfig-memorysizeinmb", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "ProvisionedConcurrency": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html#cfn-sagemaker-endpointconfig-productionvariant-serverlessconfig-provisionedconcurrency", "PrimitiveType": "Integer", "UpdateType": "Immutable" } } }, "AWS::SageMaker::EndpointConfig.VpcConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig.VpcConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-vpcconfig.html", "Properties": { "Subnets": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-vpcconfig.html#cfn-sagemaker-endpointconfig-vpcconfig-subnets", "UpdateType": "Immutable" }, "SecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-vpcconfig.html#cfn-sagemaker-endpointconfig-vpcconfig-securitygroupids", "UpdateType": "Immutable" } } }, "AWS::SageMaker::FeatureGroup.DataCatalogConfig": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup.DataCatalogConfig`\n\nThe meta data of the Glue table which serves as data catalog for the\n`OfflineStore`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the Glue table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF ]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-tablename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Database": { "MarkdownDocumentation": "`Database`\n\nThe name of the Glue table database.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF ]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-database", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Catalog": { "MarkdownDocumentation": "`Catalog`\n\nThe name of the Glue table catalog.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF ]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-catalog", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::FeatureGroup.FeatureDefinition": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup.FeatureDefinition`\n\nA list of features. You must include `FeatureName` and\n`FeatureType`. Valid feature `FeatureType`s are\n`Integral`, `Fractional` and `String`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html", "Properties": { "FeatureType": { "MarkdownDocumentation": "`FeatureType`\n\nThe value type of a feature. Valid values are Integral, Fractional, or String.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Integral | Fractional | Str...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Integral", "Fractional", "String" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html#cfn-sagemaker-featuregroup-featuredefinition-featuretype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FeatureName": { "MarkdownDocumentation": "`FeatureName`\n\nThe name of a feature. The type must be a string. `FeatureName` cannot be any\nof the following: `is_deleted`, `write_time`,\n`api_invocation_time`.\nThe name:\n* Must start with an alphanumeric character.\n* Can only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html#cfn-sagemaker-featuregroup-featuredefinition-featurename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::FeatureGroup.OfflineStoreConfig": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup.OfflineStoreConfig`\n\nThe configuration of an `OfflineStore`.\nProvide an `OfflineStoreConfig` in a request to\n`CreateFeatureGroup` to create an `OfflineStore`.\nTo encrypt an `OfflineStore` using at rest data encryption, specify AWS Key Management Service (KMS) key ID, or `KMSKeyId`, in\n`S3StorageConfig`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html", "Properties": { "DataCatalogConfig": { "MarkdownDocumentation": "`DataCatalogConfig`\n\nThe meta data of the Glue table that is autogenerated when an `OfflineStore`\nis created.\n*Required*: No\n*Type*: [DataCatalogConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-datacatalogconfig", "UpdateType": "Immutable", "Required": false, "Type": "DataCatalogConfig" }, "S3StorageConfig": { "MarkdownDocumentation": "`S3StorageConfig`\n\nThe Amazon Simple Storage (Amazon S3) location of `OfflineStore`.\n*Required*: Yes\n*Type*: [S3StorageConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-s3storageconfig", "UpdateType": "Immutable", "Required": true, "Type": "S3StorageConfig" }, "DisableGlueTableCreation": { "MarkdownDocumentation": "`DisableGlueTableCreation`\n\nSet to `True` to disable the automatic creation of an AWS Glue\ntable when configuring an `OfflineStore`. If set to `False`, Feature\nStore will name the `OfflineStore` Glue table following [Athena's\nnaming recommendations](https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-disablegluetablecreation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "TableFormat": { "MarkdownDocumentation": "`TableFormat`\n\nFormat for the offline store table. Supported formats are Glue (Default) and [Apache Iceberg](https://iceberg.apache.org/).\n*Required*: No\n*Type*: String\n*Allowed values*: `Iceberg | Glue...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Iceberg", "Glue" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-tableformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::FeatureGroup.OnlineStoreConfig": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup.OnlineStoreConfig`\n\nUse this to specify the AWS Key Management Service (KMS) Key ID, or\n`KMSKeyId`, for at rest data encryption. You can turn\n`OnlineStore` on or off by specifying the `EnableOnlineStore` flag\nat General Assembly.\nThe default value is `False`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html", "Properties": { "EnableOnlineStore": { "MarkdownDocumentation": "`EnableOnlineStore`\n\nTurn `OnlineStore` off by specifying `False` for the\n`EnableOnlineStore` flag. Turn `OnlineStore` on by specifying\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-enableonlinestore", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "StorageType": { "MarkdownDocumentation": "`StorageType`\n\nOption for different tiers of low latency storage for real-time data retrieval.\n* `Standard`: A managed low latency data store for feature groups.\n* `InMemory`: A managed data store for feature groups that supports very\n low latency retrieval.\n*Required*: No\n*Type*: String\n*Allowed values*: `Standard | InMemory...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Standard", "InMemory" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-storagetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityConfig": { "MarkdownDocumentation": "`SecurityConfig`\n\nUse to specify KMS Key ID (`KMSKeyId`) for at-rest encryption of your\n`OnlineStore`.\n*Required*: No\n*Type*: [OnlineStoreSecurityConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-securityconfig", "UpdateType": "Immutable", "Required": false, "Type": "OnlineStoreSecurityConfig" }, "TtlDuration": { "MarkdownDocumentation": "`TtlDuration`\n\nTime to live duration, where the record is hard deleted after the expiration time is\nreached; `ExpiresAt` = `EventTime` + `TtlDuration`. For\ninformation on HardDelete, see the [DeleteRecord](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) API in the Amazon SageMaker API Reference guide.\n*Required*: No\n*Type*: [TtlDuration](./aws-properties-sagemaker-featuregroup-ttlduration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-ttlduration", "UpdateType": "Mutable", "Required": false, "Type": "TtlDuration" } } }, "AWS::SageMaker::FeatureGroup.OnlineStoreSecurityConfig": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup.OnlineStoreSecurityConfig`\n\nThe security configuration for `OnlineStore`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoresecurityconfig.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS Key Management Service (KMS) key ARN that SageMaker Feature Store\nuses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side\nencryption.\nThe caller (either user or IAM role) of `CreateFeatureGroup` must have below\npermissions 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\n(`PutRecord`, `GetRecord`, `DeleteRecord`) must have the\nfollowing permissions to the `KmsKeyId`:\n* `\"kms:Decrypt\"`\n*Required*: No\n*Type*: String\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoresecurityconfig.html#cfn-sagemaker-featuregroup-onlinestoresecurityconfig-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::FeatureGroup.S3StorageConfig": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup.S3StorageConfig`\n\nThe Amazon Simple Storage (Amazon S3) location and security configuration for\n`OfflineStore`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS Key Management Service (KMS) key ARN of the key used to encrypt\nany objects written into the `OfflineStore` S3 location.\nThe IAM `roleARN` that is passed as a parameter to\n`CreateFeatureGroup` must have below permissions to the\n`KmsKeyId`:\n* `\"kms:GenerateDataKey\"`\n*Required*: No\n*Type*: String\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html#cfn-sagemaker-featuregroup-s3storageconfig-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe S3 URI, or location in Amazon S3, of `OfflineStore`.\nS3 URIs have a format similar to the following:\n`s3://example-bucket/prefix/`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html#cfn-sagemaker-featuregroup-s3storageconfig-s3uri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::FeatureGroup.ThroughputConfig": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup.ThroughputConfig`\n\nUsed to set feature group throughput configuration. There are two modes:\n`ON_DEMAND` and `PROVISIONED`. With on-demand mode, you are\ncharged for data reads and writes that your application performs on your feature group. You\ndo not need to specify read and write throughput because Feature Store accommodates your\nworkloads as they ramp up and down. You can switch a feature group to on-demand only once\nin a 24 hour period. With provisioned throughput mode, you specify the read and write\ncapacity per second that you expect your application to require, and you are billed based\non those limits. Exceeding provisioned throughput will result in your requests being\nthrottled.\nNote: `PROVISIONED` throughput mode is supported only for feature groups that\nare offline-only, or use the [`Standard`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) tier online store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html", "Properties": { "ProvisionedReadCapacityUnits": { "MarkdownDocumentation": "`ProvisionedReadCapacityUnits`\n\nFor provisioned feature groups with online store enabled, this indicates the read\nthroughput you are billed for and can consume without throttling.\nThis field is not applicable for on-demand feature groups.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `10000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-provisionedreadcapacityunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ProvisionedWriteCapacityUnits": { "MarkdownDocumentation": "`ProvisionedWriteCapacityUnits`\n\nFor provisioned feature groups, this indicates the write throughput you are billed for\nand can consume without throttling.\nThis field is not applicable for on-demand feature groups.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `10000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-provisionedwritecapacityunits", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ThroughputMode": { "MarkdownDocumentation": "`ThroughputMode`\n\nThe mode used for your feature group throughput: `ON_DEMAND` or\n`PROVISIONED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OnDemand | Provisioned...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OnDemand", "Provisioned" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-throughputmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::FeatureGroup.TtlDuration": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup.TtlDuration`\n\nTime to live duration, where the record is hard deleted after the expiration time is\nreached; `ExpiresAt` = `EventTime` + `TtlDuration`. For\ninformation on HardDelete, see the [DeleteRecord](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) API in the Amazon SageMaker API Reference guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\n`TtlDuration` time 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html#cfn-sagemaker-featuregroup-ttlduration-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\n`TtlDuration` time unit.\n*Required*: No\n*Type*: String\n*Allowed values*: `Seconds | Minutes | Hours |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Seconds", "Minutes", "Hours", "Days", "Weeks" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html#cfn-sagemaker-featuregroup-ttlduration-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::InferenceComponent.Alarm": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.Alarm`\n\nAn Amazon CloudWatch alarm configured to monitor metrics on an endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-alarm.html", "Properties": { "AlarmName": { "MarkdownDocumentation": "`AlarmName`\n\nThe name of a CloudWatch alarm in your account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-alarm.html#cfn-sagemaker-inferencecomponent-alarm-alarmname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::InferenceComponent.AutoRollbackConfiguration": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.AutoRollbackConfiguration`\n\nThe `AutoRollbackConfiguration` property type specifies Property description not available. for an [AWS::SageMaker::InferenceComponent](./aws-resource-sagemaker-inferencecomponent.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-autorollbackconfiguration.html", "Properties": { "Alarms": { "MarkdownDocumentation": "`Alarms`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [Alarm](./aws-properties-sagemaker-inferencecomponent-alarm.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-autorollbackconfiguration.html#cfn-sagemaker-inferencecomponent-autorollbackconfiguration-alarms", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Alarm", "DuplicatesAllowed": true } } }, "AWS::SageMaker::InferenceComponent.DeployedImage": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.DeployedImage`\n\nGets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this [ProductionVariant](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html).\nIf you used the `registry/repository[:tag]` form to specify the image path\nof the primary container when you created the model hosted in this\n`ProductionVariant`, the path resolves to a path of the form\n`registry/repository[@digest]`. A digest is a hash value that identifies\na specific version of an image. For information about Amazon ECR paths, see [Pulling an Image](https://docs.aws.amazon.com//AmazonECR/latest/userguide/docker-pull-ecr-image.html) in the *Amazon ECR User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html", "Properties": { "ResolutionTime": { "MarkdownDocumentation": "`ResolutionTime`\n\nThe date and time when the image path for the model resolved to the\n`ResolvedImage`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-resolutiontime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpecifiedImage": { "MarkdownDocumentation": "`SpecifiedImage`\n\nThe image path you specified when you created the model.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\S]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-specifiedimage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResolvedImage": { "MarkdownDocumentation": "`ResolvedImage`\n\nThe specific digest path of the image hosted in this\n`ProductionVariant`.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\S]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-resolvedimage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::InferenceComponent.InferenceComponentCapacitySize": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.InferenceComponentCapacitySize`\n\nSpecifies the type and size of the endpoint capacity to activate for a rolling\ndeployment or a rollback strategy. You can specify your batches as either of the\nfollowing:\n* A count of inference component copies\n* The overall percentage or your fleet\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\nthe `Value` parameter to 100%, then SageMaker AI uses a blue/green rollback\nstrategy and rolls all traffic back to the blue fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysize.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the endpoint capacity type.\nCOPY\\_COUNT\nThe endpoint activates based on the number of inference component\ncopies.\n\nCAPACITY\\_PERCENT\nThe endpoint activates based on the specified percentage of capacity.\n\n*Required*: Yes\n*Type*: String\n*Allowed values*: `COPY_COUNT | CAPACITY_PERCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COPY_COUNT", "CAPACITY_PERCENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysize.html#cfn-sagemaker-inferencecomponent-inferencecomponentcapacitysize-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nDefines the capacity size, either as a number of inference component copies or a\ncapacity percentage.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysize.html#cfn-sagemaker-inferencecomponent-inferencecomponentcapacitysize-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::InferenceComponent.InferenceComponentComputeResourceRequirements": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.InferenceComponentComputeResourceRequirements`\n\nDefines the compute resources to allocate to run a model, plus any adapter models, that\nyou assign to an inference component. These resources include CPU cores, accelerators, and\nmemory.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html", "Properties": { "NumberOfAcceleratorDevicesRequired": { "MarkdownDocumentation": "`NumberOfAcceleratorDevicesRequired`\n\nThe number of accelerators to allocate to run a model that you assign to an inference\ncomponent. Accelerators include GPUs and AWS Inferentia.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofacceleratordevicesrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MaxMemoryRequiredInMb": { "MarkdownDocumentation": "`MaxMemoryRequiredInMb`\n\nThe maximum MB of memory to allocate to run a model that you assign to an inference\ncomponent.\n*Required*: No\n*Type*: Integer\n*Minimum*: `128`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-maxmemoryrequiredinmb", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinMemoryRequiredInMb": { "MarkdownDocumentation": "`MinMemoryRequiredInMb`\n\nThe minimum MB of memory to allocate to run a model that you assign to an inference\ncomponent.\n*Required*: No\n*Type*: Integer\n*Minimum*: `128`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-minmemoryrequiredinmb", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NumberOfCpuCoresRequired": { "MarkdownDocumentation": "`NumberOfCpuCoresRequired`\n\nThe number of CPU cores to allocate to run a model that you assign to an inference\ncomponent.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofcpucoresrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::SageMaker::InferenceComponent.InferenceComponentContainerSpecification": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.InferenceComponentContainerSpecification`\n\nDefines a container that provides the runtime environment for a model that you deploy\nwith an inference component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html", "Properties": { "ArtifactUrl": { "MarkdownDocumentation": "`ArtifactUrl`\n\nThe Amazon S3 path where the model artifacts, which result from model training,\nare stored. This path must point to a single gzip compressed tar archive (.tar.gz\nsuffix).\n*Required*: No\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-artifacturl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nThe environment variables to set in the Docker container. Each key and value in the\nEnvironment string-to-string map can have length of up to 1024. We support up to 16 entries\nin the map.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z_][a-zA-Z0-9_]{1,1024}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-environment", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "DeployedImage": { "MarkdownDocumentation": "`DeployedImage`\n\nProperty description not available.\n*Required*: No\n*Type*: [DeployedImage](./aws-properties-sagemaker-inferencecomponent-deployedimage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-deployedimage", "UpdateType": "Mutable", "Required": false, "Type": "DeployedImage" }, "Image": { "MarkdownDocumentation": "`Image`\n\nThe Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\S]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-image", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::InferenceComponent.InferenceComponentDeploymentConfig": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.InferenceComponentDeploymentConfig`\n\nThe deployment configuration for an endpoint that hosts inference components. The\nconfiguration includes the desired deployment strategy and rollback settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig.html", "Properties": { "AutoRollbackConfiguration": { "MarkdownDocumentation": "`AutoRollbackConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [AutoRollbackConfiguration](./aws-properties-sagemaker-inferencecomponent-autorollbackconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig-autorollbackconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AutoRollbackConfiguration" }, "RollingUpdatePolicy": { "MarkdownDocumentation": "`RollingUpdatePolicy`\n\nSpecifies a rolling deployment strategy for updating a SageMaker AI\nendpoint.\n*Required*: No\n*Type*: [InferenceComponentRollingUpdatePolicy](./aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig-rollingupdatepolicy", "UpdateType": "Mutable", "Required": false, "Type": "InferenceComponentRollingUpdatePolicy" } } }, "AWS::SageMaker::InferenceComponent.InferenceComponentRollingUpdatePolicy": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.InferenceComponentRollingUpdatePolicy`\n\nSpecifies a rolling deployment strategy for updating a SageMaker AI inference\ncomponent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html", "Properties": { "MaximumExecutionTimeoutInSeconds": { "MarkdownDocumentation": "`MaximumExecutionTimeoutInSeconds`\n\nThe time limit for the total deployment. Exceeding this limit causes a timeout.\n*Required*: No\n*Type*: Integer\n*Minimum*: `600`\n*Maximum*: `28800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html#cfn-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy-maximumexecutiontimeoutinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumBatchSize": { "MarkdownDocumentation": "`MaximumBatchSize`\n\nThe batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet,\nand terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of\nthe copy count of the inference component.\n*Required*: No\n*Type*: [InferenceComponentCapacitySize](./aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html#cfn-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy-maximumbatchsize", "UpdateType": "Mutable", "Required": false, "Type": "InferenceComponentCapacitySize" }, "WaitIntervalInSeconds": { "MarkdownDocumentation": "`WaitIntervalInSeconds`\n\nThe length of the baking period, during which SageMaker AI monitors alarms for each\nbatch on the new fleet.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html#cfn-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy-waitintervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RollbackMaximumBatchSize": { "MarkdownDocumentation": "`RollbackMaximumBatchSize`\n\nThe batch size for a rollback to the old endpoint fleet. If this field is absent, the\nvalue is set to the default, which is 100% of the total capacity. When the default is used,\nSageMaker AI provisions the entire capacity of the old fleet at once during\nrollback.\n*Required*: No\n*Type*: [InferenceComponentCapacitySize](./aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysize.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html#cfn-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy-rollbackmaximumbatchsize", "UpdateType": "Mutable", "Required": false, "Type": "InferenceComponentCapacitySize" } } }, "AWS::SageMaker::InferenceComponent.InferenceComponentRuntimeConfig": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.InferenceComponentRuntimeConfig`\n\nRuntime settings for a model that is deployed with an inference component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html", "Properties": { "CurrentCopyCount": { "MarkdownDocumentation": "`CurrentCopyCount`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-currentcopycount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DesiredCopyCount": { "MarkdownDocumentation": "`DesiredCopyCount`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-desiredcopycount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CopyCount": { "MarkdownDocumentation": "`CopyCount`\n\nThe number of runtime copies of the model container to deploy with the inference\ncomponent. Each copy can serve inference requests.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-copycount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::InferenceComponent.InferenceComponentSpecification": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.InferenceComponentSpecification`\n\nDetails about the resources to deploy with this inference component, including the\nmodel, container, and compute resources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html", "Properties": { "Container": { "MarkdownDocumentation": "`Container`\n\nDefines a container that provides the runtime environment for a model that you deploy\nwith an inference component.\n*Required*: No\n*Type*: [InferenceComponentContainerSpecification](./aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-container", "UpdateType": "Mutable", "Required": false, "Type": "InferenceComponentContainerSpecification" }, "ModelName": { "MarkdownDocumentation": "`ModelName`\n\nThe name of an existing SageMaker AI model object in your account that you want to\ndeploy with the inference component.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-modelname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComputeResourceRequirements": { "MarkdownDocumentation": "`ComputeResourceRequirements`\n\nThe compute resources allocated to run the model, plus any\nadapter models, that you assign to the inference component.\nOmit this parameter if your request is meant to create an adapter inference component.\nAn adapter inference component is loaded by a base inference component, and it uses the\ncompute resources of the base inference component.\n*Required*: No\n*Type*: [InferenceComponentComputeResourceRequirements](./aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-computeresourcerequirements", "UpdateType": "Mutable", "Required": false, "Type": "InferenceComponentComputeResourceRequirements" }, "BaseInferenceComponentName": { "MarkdownDocumentation": "`BaseInferenceComponentName`\n\nThe name of an existing inference component that is to contain the inference component\nthat you're creating with your request.\nSpecify this parameter only if your request is meant to create an adapter inference\ncomponent. An adapter inference component contains the path to an adapter model. The\npurpose of the adapter model is to tailor the inference output of a base foundation model,\nwhich is hosted by the base inference component. The adapter inference component uses the\ncompute resources that you assigned to the base inference component.\nWhen you create an adapter inference component, use the `Container` parameter\nto specify the location of the adapter artifacts. In the parameter value, use the\n`ArtifactUrl` parameter of the\n`InferenceComponentContainerSpecification` data type.\nBefore you can create an adapter inference component, you must have an existing\ninference component that contains the foundation model that you want to adapt.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-baseinferencecomponentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartupParameters": { "MarkdownDocumentation": "`StartupParameters`\n\nSettings that take effect while the model container starts up.\n*Required*: No\n*Type*: [InferenceComponentStartupParameters](./aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-startupparameters", "UpdateType": "Mutable", "Required": false, "Type": "InferenceComponentStartupParameters" } } }, "AWS::SageMaker::InferenceComponent.InferenceComponentStartupParameters": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent.InferenceComponentStartupParameters`\n\nSettings that take effect while the model container starts up.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html", "Properties": { "ModelDataDownloadTimeoutInSeconds": { "MarkdownDocumentation": "`ModelDataDownloadTimeoutInSeconds`\n\nThe timeout value, in seconds, to download and extract the model that you want to host\nfrom Amazon S3 to the individual inference instance associated with this inference\ncomponent.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-modeldatadownloadtimeoutinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ContainerStartupHealthCheckTimeoutInSeconds": { "MarkdownDocumentation": "`ContainerStartupHealthCheckTimeoutInSeconds`\n\nThe timeout value, in seconds, for your inference container to pass health check by\nAmazon S3 Hosting. For more information about health check, see [How Your Container Should Respond to Health Check (Ping) Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests).\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `3600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-containerstartuphealthchecktimeoutinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::InferenceExperiment.CaptureContentTypeHeader": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.CaptureContentTypeHeader`\n\nConfiguration specifying how to treat different headers. If no headers are specified\nAmazon SageMaker AI will by default base64 encode when capturing the data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html", "Properties": { "JsonContentTypes": { "MarkdownDocumentation": "`JsonContentTypes`\n\nThe list of all content type headers that SageMaker AI will treat as JSON and\ncapture accordingly.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `256 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html#cfn-sagemaker-inferenceexperiment-capturecontenttypeheader-jsoncontenttypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "CsvContentTypes": { "MarkdownDocumentation": "`CsvContentTypes`\n\nThe list of all content type headers that Amazon SageMaker AI will treat as CSV and\ncapture accordingly.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `256 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html#cfn-sagemaker-inferenceexperiment-capturecontenttypeheader-csvcontenttypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::InferenceExperiment.DataStorageConfig": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.DataStorageConfig`\n\nThe Amazon S3 location and configuration for storing inference request and response data.\nThis is an optional parameter that you can use for data capture. For more information, see [Capture data](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe Amazon S3 bucket where the inference request and response data is stored.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(https|s3)://([^/])/?(.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-destination", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nConfiguration specifying how to treat different headers. If no headers are specified\nSageMaker will by default base64 encode when capturing the data.\n*Required*: No\n*Type*: [CaptureContentTypeHeader](./aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-contenttype", "UpdateType": "Mutable", "Required": false, "Type": "CaptureContentTypeHeader" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nThe AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3\nserver-side encryption.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-kmskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::InferenceExperiment.EndpointMetadata": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.EndpointMetadata`\n\nThe metadata of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-endpointmetadata.html", "Properties": { "EndpointStatus": { "MarkdownDocumentation": "`EndpointStatus`\n\nThe status of the endpoint. For possible values of the status of an endpoint, see\n.\n*Required*: No\n*Type*: String\n*Allowed values*: `Creating | Updating | Syste...`\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)", "RefReturnValue": "", "AllowedValues": [ "Creating", "Updating", "SystemUpdating", "RollingBack", "InService", "OutOfService", "Deleting", "Failed" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-endpointmetadata.html#cfn-sagemaker-inferenceexperiment-endpointmetadata-endpointstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nThe name of the endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-endpointmetadata.html#cfn-sagemaker-inferenceexperiment-endpointmetadata-endpointname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EndpointConfigName": { "MarkdownDocumentation": "`EndpointConfigName`\n\nThe name of the endpoint configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-endpointmetadata.html#cfn-sagemaker-inferenceexperiment-endpointmetadata-endpointconfigname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::InferenceExperiment.InferenceExperimentSchedule": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.InferenceExperimentSchedule`\n\nThe start and end times of an inference experiment.\nThe maximum duration that you can set for an inference experiment is 30 days.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html", "Properties": { "EndTime": { "MarkdownDocumentation": "`EndTime`\n\nThe timestamp at which the inference experiment ended or will end.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html#cfn-sagemaker-inferenceexperiment-inferenceexperimentschedule-endtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe timestamp at which the inference experiment started or will 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html#cfn-sagemaker-inferenceexperiment-inferenceexperimentschedule-starttime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::InferenceExperiment.ModelInfrastructureConfig": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.ModelInfrastructureConfig`\n\nThe configuration for the infrastructure that the model will be deployed to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html", "Properties": { "InfrastructureType": { "MarkdownDocumentation": "`InfrastructureType`\n\nThe inference option to which to deploy your model. Possible values are the following:\n* `RealTime`: Deploy to real-time inference.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RealTimeInference...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RealTimeInference" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html#cfn-sagemaker-inferenceexperiment-modelinfrastructureconfig-infrastructuretype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RealTimeInferenceConfig": { "MarkdownDocumentation": "`RealTimeInferenceConfig`\n\nThe infrastructure configuration for deploying the model to real-time inference.\n*Required*: Yes\n*Type*: [RealTimeInferenceConfig](./aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html#cfn-sagemaker-inferenceexperiment-modelinfrastructureconfig-realtimeinferenceconfig", "UpdateType": "Mutable", "Required": true, "Type": "RealTimeInferenceConfig" } } }, "AWS::SageMaker::InferenceExperiment.ModelVariantConfig": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.ModelVariantConfig`\n\nContains information about the deployment options of a model.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html", "Properties": { "ModelName": { "MarkdownDocumentation": "`ModelName`\n\nThe name of the Amazon SageMaker Model entity.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-modelname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VariantName": { "MarkdownDocumentation": "`VariantName`\n\nThe name of the variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-variantname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InfrastructureConfig": { "MarkdownDocumentation": "`InfrastructureConfig`\n\nThe configuration for the infrastructure that the model will be deployed to.\n*Required*: Yes\n*Type*: [ModelInfrastructureConfig](./aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-infrastructureconfig", "UpdateType": "Mutable", "Required": true, "Type": "ModelInfrastructureConfig" } } }, "AWS::SageMaker::InferenceExperiment.RealTimeInferenceConfig": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.RealTimeInferenceConfig`\n\nThe infrastructure configuration for deploying the model to a real-time inference endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html", "Properties": { "InstanceCount": { "MarkdownDocumentation": "`InstanceCount`\n\nThe number of instances of the type specified by `InstanceType`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html#cfn-sagemaker-inferenceexperiment-realtimeinferenceconfig-instancecount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type the model is deployed to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ml.t2.medium | ml.t2.large ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ml.t2.medium", "ml.t2.large", "ml.t2.xlarge", "ml.t2.2xlarge", "ml.t3.medium", "ml.t3.large", "ml.t3.xlarge", "ml.t3.2xlarge", "ml.m4.xlarge", "ml.m4.2xlarge", "ml.m4.4xlarge", "ml.m4.10xlarge", "ml.m4.16xlarge", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.12xlarge", "ml.m5.24xlarge", "ml.m5d.large", "ml.m5d.xlarge", "ml.m5d.2xlarge", "ml.m5d.4xlarge", "ml.m5d.8xlarge", "ml.m5d.12xlarge", "ml.m5d.16xlarge", "ml.m5d.24xlarge", "ml.c4.xlarge", "ml.c4.2xlarge", "ml.c4.4xlarge", "ml.c4.8xlarge", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.18xlarge", "ml.c5d.xlarge", "ml.c5d.2xlarge", "ml.c5d.4xlarge", "ml.c5d.9xlarge", "ml.c5d.18xlarge", "ml.p2.xlarge", "ml.p2.8xlarge", "ml.p2.16xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", "ml.g4dn.xlarge", "ml.g4dn.2xlarge", "ml.g4dn.4xlarge", "ml.g4dn.8xlarge", "ml.g4dn.12xlarge", "ml.g4dn.16xlarge", "ml.r5.large", "ml.r5.xlarge", "ml.r5.2xlarge", "ml.r5.4xlarge", "ml.r5.8xlarge", "ml.r5.12xlarge", "ml.r5.16xlarge", "ml.r5.24xlarge", "ml.g5.xlarge", "ml.g5.2xlarge", "ml.g5.4xlarge", "ml.g5.8xlarge", "ml.g5.16xlarge", "ml.g5.12xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", "ml.inf1.xlarge", "ml.inf1.2xlarge", "ml.inf1.6xlarge", "ml.inf1.24xlarge", "ml.trn1.2xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.inf2.xlarge", "ml.inf2.8xlarge", "ml.inf2.24xlarge", "ml.inf2.48xlarge", "ml.p4d.24xlarge", "ml.p4de.24xlarge", "ml.p5.48xlarge", "ml.p6-b200.48xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", "ml.m6i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.12xlarge", "ml.m6i.16xlarge", "ml.m6i.24xlarge", "ml.m6i.32xlarge", "ml.m7i.large", "ml.m7i.xlarge", "ml.m7i.2xlarge", "ml.m7i.4xlarge", "ml.m7i.8xlarge", "ml.m7i.12xlarge", "ml.m7i.16xlarge", "ml.m7i.24xlarge", "ml.m7i.48xlarge", "ml.c6i.large", "ml.c6i.xlarge", "ml.c6i.2xlarge", "ml.c6i.4xlarge", "ml.c6i.8xlarge", "ml.c6i.12xlarge", "ml.c6i.16xlarge", "ml.c6i.24xlarge", "ml.c6i.32xlarge", "ml.c7i.large", "ml.c7i.xlarge", "ml.c7i.2xlarge", "ml.c7i.4xlarge", "ml.c7i.8xlarge", "ml.c7i.12xlarge", "ml.c7i.16xlarge", "ml.c7i.24xlarge", "ml.c7i.48xlarge", "ml.r6i.large", "ml.r6i.xlarge", "ml.r6i.2xlarge", "ml.r6i.4xlarge", "ml.r6i.8xlarge", "ml.r6i.12xlarge", "ml.r6i.16xlarge", "ml.r6i.24xlarge", "ml.r6i.32xlarge", "ml.r7i.large", "ml.r7i.xlarge", "ml.r7i.2xlarge", "ml.r7i.4xlarge", "ml.r7i.8xlarge", "ml.r7i.12xlarge", "ml.r7i.16xlarge", "ml.r7i.24xlarge", "ml.r7i.48xlarge", "ml.m6id.large", "ml.m6id.xlarge", "ml.m6id.2xlarge", "ml.m6id.4xlarge", "ml.m6id.8xlarge", "ml.m6id.12xlarge", "ml.m6id.16xlarge", "ml.m6id.24xlarge", "ml.m6id.32xlarge", "ml.c6id.large", "ml.c6id.xlarge", "ml.c6id.2xlarge", "ml.c6id.4xlarge", "ml.c6id.8xlarge", "ml.c6id.12xlarge", "ml.c6id.16xlarge", "ml.c6id.24xlarge", "ml.c6id.32xlarge", "ml.r6id.large", "ml.r6id.xlarge", "ml.r6id.2xlarge", "ml.r6id.4xlarge", "ml.r6id.8xlarge", "ml.r6id.12xlarge", "ml.r6id.16xlarge", "ml.r6id.24xlarge", "ml.r6id.32xlarge", "ml.g6.xlarge", "ml.g6.2xlarge", "ml.g6.4xlarge", "ml.g6.8xlarge", "ml.g6.12xlarge", "ml.g6.16xlarge", "ml.g6.24xlarge", "ml.g6.48xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html#cfn-sagemaker-inferenceexperiment-realtimeinferenceconfig-instancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::InferenceExperiment.ShadowModeConfig": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.ShadowModeConfig`\n\nThe configuration of `ShadowMode` inference experiment type, which specifies a production variant\nto take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the\ninference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html", "Properties": { "SourceModelVariantName": { "MarkdownDocumentation": "`SourceModelVariantName`\n\nThe name of the production variant, which takes all the inference requests.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig-sourcemodelvariantname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ShadowModelVariants": { "MarkdownDocumentation": "`ShadowModelVariants`\n\nList of shadow variant configurations.\n*Required*: Yes\n*Type*: Array of [ShadowModelVariantConfig](./aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig-shadowmodelvariants", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ShadowModelVariantConfig", "DuplicatesAllowed": true } } }, "AWS::SageMaker::InferenceExperiment.ShadowModelVariantConfig": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment.ShadowModelVariantConfig`\n\nThe name and sampling percentage of a shadow variant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html", "Properties": { "ShadowModelVariantName": { "MarkdownDocumentation": "`ShadowModelVariantName`\n\nThe name of the shadow variant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodelvariantconfig-shadowmodelvariantname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SamplingPercentage": { "MarkdownDocumentation": "`SamplingPercentage`\n\nThe percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.\n*Required*: Yes\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodelvariantconfig-samplingpercentage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Model.AdditionalModelDataSource": { "MarkdownDocumentation": "`AWS::SageMaker::Model.AdditionalModelDataSource`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-additionalmodeldatasource.html", "Properties": { "ChannelName": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-additionalmodeldatasource.html#cfn-sagemaker-model-additionalmodeldatasource-channelname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "S3DataSource": { "Type": "S3DataSource", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-additionalmodeldatasource.html#cfn-sagemaker-model-additionalmodeldatasource-s3datasource", "UpdateType": "Immutable" } } }, "AWS::SageMaker::Model.ContainerDefinition": { "MarkdownDocumentation": "`AWS::SageMaker::Model.ContainerDefinition`\n\nDescribes the container, as part of model definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html", "Properties": { "ImageConfig": { "Type": "ImageConfig", "Required": false, "MarkdownDocumentation": "`ImageConfig`\n\nSpecifies whether the model container is in Amazon ECR or a private Docker registry\naccessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\nprivate Docker registry, see [Use a\nPrivate Docker Registry for Real-Time Inference Containers](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html).\n###### Note\nThe model artifacts in an Amazon S3 bucket and the Docker image for inference container\nin Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\ncreating.\n*Required*: No\n*Type*: [ImageConfig](./aws-properties-sagemaker-model-imageconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-imageconfig", "UpdateType": "Immutable" }, "InferenceSpecificationName": { "Required": false, "MarkdownDocumentation": "`InferenceSpecificationName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-inferencespecificationname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ContainerHostname": { "Required": false, "MarkdownDocumentation": "`ContainerHostname`\n\nThis parameter is ignored for models that contain only a\n`PrimaryContainer`.\nWhen a `ContainerDefinition` is part of an inference pipeline, the value of\nthe parameter uniquely identifies the container for the purposes of logging and metrics.\nFor information, see [Use Logs and Metrics\nto Monitor an Inference Pipeline](https://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html). If you don't specify a value for this\nparameter for a `ContainerDefinition` that is part of an inference pipeline,\na unique name is automatically assigned based on the position of the\n`ContainerDefinition` in the pipeline. If you specify a value for the\n`ContainerHostName` for any `ContainerDefinition` that is part\nof an inference pipeline, you must specify a value for the\n`ContainerHostName` parameter of every `ContainerDefinition`\nin that pipeline.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `0`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-containerhostname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ModelPackageName": { "Required": false, "MarkdownDocumentation": "`ModelPackageName`\n\nThe name or Amazon Resource Name (ARN) of the model package to use to create the\nmodel.\n*Required*: No\n*Type*: String\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})(?//`.\n*Required*: No\n*Type*: String\n*Pattern*: `(s3)://([^/]+)/?(.*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-s3filesystem.html#cfn-sagemaker-space-s3filesystem-s3uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::Space.SpaceAppLifecycleManagement": { "MarkdownDocumentation": "`AWS::SageMaker::Space.SpaceAppLifecycleManagement`\n\nSettings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\napplications in a space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spaceapplifecyclemanagement.html", "Properties": { "IdleSettings": { "MarkdownDocumentation": "`IdleSettings`\n\nSettings related to idle shutdown of Studio applications.\n*Required*: No\n*Type*: [SpaceIdleSettings](./aws-properties-sagemaker-space-spaceidlesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spaceapplifecyclemanagement.html#cfn-sagemaker-space-spaceapplifecyclemanagement-idlesettings", "UpdateType": "Mutable", "Required": false, "Type": "SpaceIdleSettings" } } }, "AWS::SageMaker::Space.SpaceCodeEditorAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Space.SpaceCodeEditorAppSettings`\n\nThe application settings for a Code Editor space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacecodeeditorappsettings.html", "Properties": { "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nSpecifies the ARNs of a SageMaker image and SageMaker image version, and the instance\ntype that the version runs on.\n*Required*: No\n*Type*: [ResourceSpec](./aws-properties-sagemaker-space-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacecodeeditorappsettings.html#cfn-sagemaker-space-spacecodeeditorappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "AppLifecycleManagement": { "MarkdownDocumentation": "`AppLifecycleManagement`\n\nSettings that are used to configure and manage the lifecycle of CodeEditor applications in\na space.\n*Required*: No\n*Type*: [SpaceAppLifecycleManagement](./aws-properties-sagemaker-space-spaceapplifecyclemanagement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacecodeeditorappsettings.html#cfn-sagemaker-space-spacecodeeditorappsettings-applifecyclemanagement", "UpdateType": "Mutable", "Required": false, "Type": "SpaceAppLifecycleManagement" } } }, "AWS::SageMaker::Space.SpaceIdleSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Space.SpaceIdleSettings`\n\nSettings related to idle shutdown of Studio applications in a space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spaceidlesettings.html", "Properties": { "IdleTimeoutInMinutes": { "MarkdownDocumentation": "`IdleTimeoutInMinutes`\n\nThe time that SageMaker waits after the application becomes idle before shutting it\ndown.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `525600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spaceidlesettings.html#cfn-sagemaker-space-spaceidlesettings-idletimeoutinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::Space.SpaceJupyterLabAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Space.SpaceJupyterLabAppSettings`\n\nThe settings for the JupyterLab application within a space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html", "Properties": { "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nSpecifies the ARNs of a SageMaker image and SageMaker image version, and the instance\ntype that the version runs on.\n*Required*: No\n*Type*: [ResourceSpec](./aws-properties-sagemaker-space-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html#cfn-sagemaker-space-spacejupyterlabappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "CodeRepositories": { "MarkdownDocumentation": "`CodeRepositories`\n\nA list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.\n*Required*: No\n*Type*: Array of [CodeRepository](./aws-properties-sagemaker-space-coderepository.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html#cfn-sagemaker-space-spacejupyterlabappsettings-coderepositories", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CodeRepository", "DuplicatesAllowed": true }, "AppLifecycleManagement": { "MarkdownDocumentation": "`AppLifecycleManagement`\n\nSettings that are used to configure and manage the lifecycle of JupyterLab applications in\na space.\n*Required*: No\n*Type*: [SpaceAppLifecycleManagement](./aws-properties-sagemaker-space-spaceapplifecyclemanagement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html#cfn-sagemaker-space-spacejupyterlabappsettings-applifecyclemanagement", "UpdateType": "Mutable", "Required": false, "Type": "SpaceAppLifecycleManagement" } } }, "AWS::SageMaker::Space.SpaceSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Space.SpaceSettings`\n\nA collection of space settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html", "Properties": { "JupyterLabAppSettings": { "MarkdownDocumentation": "`JupyterLabAppSettings`\n\nThe settings for the JupyterLab application.\n*Required*: No\n*Type*: [SpaceJupyterLabAppSettings](./aws-properties-sagemaker-space-spacejupyterlabappsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-jupyterlabappsettings", "UpdateType": "Mutable", "Required": false, "Type": "SpaceJupyterLabAppSettings" }, "KernelGatewayAppSettings": { "MarkdownDocumentation": "`KernelGatewayAppSettings`\n\nThe KernelGateway app settings.\n*Required*: No\n*Type*: [KernelGatewayAppSettings](./aws-properties-sagemaker-space-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-kernelgatewayappsettings", "UpdateType": "Mutable", "Required": false, "Type": "KernelGatewayAppSettings" }, "CodeEditorAppSettings": { "MarkdownDocumentation": "`CodeEditorAppSettings`\n\nThe Code Editor application settings.\n*Required*: No\n*Type*: [SpaceCodeEditorAppSettings](./aws-properties-sagemaker-space-spacecodeeditorappsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-codeeditorappsettings", "UpdateType": "Mutable", "Required": false, "Type": "SpaceCodeEditorAppSettings" }, "SpaceManagedResources": { "MarkdownDocumentation": "`SpaceManagedResources`\n\nIf you enable this option, SageMaker AI creates the following resources on your\nbehalf when you create the space:\n* The user profile that possesses the space.\n* The app that the space contains.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-spacemanagedresources", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RemoteAccess": { "MarkdownDocumentation": "`RemoteAccess`\n\nA setting that enables or disables remote access for a SageMaker space. When enabled, this\nallows you to connect to the remote space from your local IDE.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-remoteaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JupyterServerAppSettings": { "MarkdownDocumentation": "`JupyterServerAppSettings`\n\nThe JupyterServer app settings.\n*Required*: No\n*Type*: [JupyterServerAppSettings](./aws-properties-sagemaker-space-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-jupyterserverappsettings", "UpdateType": "Mutable", "Required": false, "Type": "JupyterServerAppSettings" }, "CustomFileSystems": { "MarkdownDocumentation": "`CustomFileSystems`\n\nA file system, created by you, that you assign to a space for an Amazon SageMaker AI\nDomain. Permitted users can access this file system in Amazon SageMaker AI Studio.\n*Required*: No\n*Type*: Array of [CustomFileSystem](./aws-properties-sagemaker-space-customfilesystem.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-customfilesystems", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomFileSystem", "DuplicatesAllowed": false }, "AppType": { "MarkdownDocumentation": "`AppType`\n\nThe type of app created within the space.\nIf using the [UpdateSpace](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateSpace.html) API, you can't change the app type of your\nspace by specifying a different value for this field.\n*Required*: No\n*Type*: String\n*Allowed values*: `JupyterServer | KernelGatew...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JupyterServer", "KernelGateway", "TensorBoard", "RStudioServerPro", "RSessionGateway", "JupyterLab", "CodeEditor" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-apptype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpaceStorageSettings": { "MarkdownDocumentation": "`SpaceStorageSettings`\n\nThe storage settings for a space.\n*Required*: No\n*Type*: [SpaceStorageSettings](./aws-properties-sagemaker-space-spacestoragesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-spacestoragesettings", "UpdateType": "Mutable", "Required": false, "Type": "SpaceStorageSettings" } } }, "AWS::SageMaker::Space.SpaceSharingSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Space.SpaceSharingSettings`\n\nA collection of space sharing settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesharingsettings.html", "Properties": { "SharingType": { "MarkdownDocumentation": "`SharingType`\n\nSpecifies the sharing type of the space.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Private | Shared...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Private", "Shared" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesharingsettings.html#cfn-sagemaker-space-spacesharingsettings-sharingtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::Space.SpaceStorageSettings": { "MarkdownDocumentation": "`AWS::SageMaker::Space.SpaceStorageSettings`\n\nThe storage settings for a space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacestoragesettings.html", "Properties": { "EbsStorageSettings": { "MarkdownDocumentation": "`EbsStorageSettings`\n\nA collection of EBS storage settings for a space.\n*Required*: No\n*Type*: [EbsStorageSettings](./aws-properties-sagemaker-space-ebsstoragesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacestoragesettings.html#cfn-sagemaker-space-spacestoragesettings-ebsstoragesettings", "UpdateType": "Mutable", "Required": false, "Type": "EbsStorageSettings" } } }, "AWS::SageMaker::UserProfile.AppLifecycleManagement": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.AppLifecycleManagement`\n\nSettings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\napplications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-applifecyclemanagement.html", "Properties": { "IdleSettings": { "MarkdownDocumentation": "`IdleSettings`\n\nSettings related to idle shutdown of Studio applications.\n*Required*: No\n*Type*: [IdleSettings](./aws-properties-sagemaker-userprofile-idlesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-applifecyclemanagement.html#cfn-sagemaker-userprofile-applifecyclemanagement-idlesettings", "UpdateType": "Mutable", "Required": false, "Type": "IdleSettings" } } }, "AWS::SageMaker::UserProfile.CodeEditorAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.CodeEditorAppSettings`\n\nThe Code Editor application settings.\nFor more information about Code Editor, see [Get started with Code\nEditor in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html", "Properties": { "CustomImages": { "MarkdownDocumentation": "`CustomImages`\n\nA list of custom SageMaker images that are configured to run as a Code Editor app.\n*Required*: No\n*Type*: Array of [CustomImage](./aws-properties-sagemaker-userprofile-customimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-customimages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomImage", "DuplicatesAllowed": true }, "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker\nimage used by the Code Editor app.\n*Required*: No\n*Type*: [ResourceSpec](./aws-properties-sagemaker-userprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "LifecycleConfigArns": { "MarkdownDocumentation": "`LifecycleConfigArns`\n\nThe Amazon Resource Name (ARN) of the Code Editor application\nlifecycle configuration.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-lifecycleconfigarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BuiltInLifecycleConfigArn": { "MarkdownDocumentation": "`BuiltInLifecycleConfigArn`\n\nThe lifecycle configuration that runs before the default lifecycle configuration. It can\noverride changes made in the default lifecycle configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-builtinlifecycleconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AppLifecycleManagement": { "MarkdownDocumentation": "`AppLifecycleManagement`\n\nSettings that are used to configure and manage the lifecycle of CodeEditor\napplications.\n*Required*: No\n*Type*: [AppLifecycleManagement](./aws-properties-sagemaker-userprofile-applifecyclemanagement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-applifecyclemanagement", "UpdateType": "Mutable", "Required": false, "Type": "AppLifecycleManagement" } } }, "AWS::SageMaker::UserProfile.CodeRepository": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.CodeRepository`\n\nA Git repository that SageMaker AI automatically displays to users for cloning in the\nJupyterServer application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-coderepository.html", "Properties": { "RepositoryUrl": { "MarkdownDocumentation": "`RepositoryUrl`\n\nThe URL of the Git repository.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-coderepository.html#cfn-sagemaker-userprofile-coderepository-repositoryurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::UserProfile.CustomFileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.CustomFileSystemConfig`\n\nThe settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\nStudio.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customfilesystemconfig.html", "Properties": { "EFSFileSystemConfig": { "MarkdownDocumentation": "`EFSFileSystemConfig`\n\nThe settings for a custom Amazon EFS file system.\n*Required*: No\n*Type*: [EFSFileSystemConfig](./aws-properties-sagemaker-userprofile-efsfilesystemconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customfilesystemconfig.html#cfn-sagemaker-userprofile-customfilesystemconfig-efsfilesystemconfig", "UpdateType": "Mutable", "Required": false, "Type": "EFSFileSystemConfig" }, "S3FileSystemConfig": { "MarkdownDocumentation": "`S3FileSystemConfig`\n\nConfiguration settings for a custom Amazon S3 file system.\n*Required*: No\n*Type*: [S3FileSystemConfig](./aws-properties-sagemaker-userprofile-s3filesystemconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customfilesystemconfig.html#cfn-sagemaker-userprofile-customfilesystemconfig-s3filesystemconfig", "UpdateType": "Mutable", "Required": false, "Type": "S3FileSystemConfig" }, "FSxLustreFileSystemConfig": { "MarkdownDocumentation": "`FSxLustreFileSystemConfig`\n\nThe settings for a custom Amazon FSx for Lustre file system.\n*Required*: No\n*Type*: [FSxLustreFileSystemConfig](./aws-properties-sagemaker-userprofile-fsxlustrefilesystemconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customfilesystemconfig.html#cfn-sagemaker-userprofile-customfilesystemconfig-fsxlustrefilesystemconfig", "UpdateType": "Mutable", "Required": false, "Type": "FSxLustreFileSystemConfig" } } }, "AWS::SageMaker::UserProfile.CustomImage": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.CustomImage`\n\nA custom SageMaker AI image. For more information, see\n[Bring your own SageMaker AI image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customimage.html", "Properties": { "ImageName": { "MarkdownDocumentation": "`ImageName`\n\nThe name of the CustomImage. Must be unique to your account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customimage.html#cfn-sagemaker-userprofile-customimage-imagename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AppImageConfigName": { "MarkdownDocumentation": "`AppImageConfigName`\n\nThe name of the AppImageConfig.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customimage.html#cfn-sagemaker-userprofile-customimage-appimageconfigname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImageVersionNumber": { "MarkdownDocumentation": "`ImageVersionNumber`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customimage.html#cfn-sagemaker-userprofile-customimage-imageversionnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::UserProfile.CustomPosixUserConfig": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.CustomPosixUserConfig`\n\nDetails about the POSIX identity that is used for file system operations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customposixuserconfig.html", "Properties": { "Uid": { "MarkdownDocumentation": "`Uid`\n\nThe POSIX user ID.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `10000`\n*Maximum*: `4000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customposixuserconfig.html#cfn-sagemaker-userprofile-customposixuserconfig-uid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Gid": { "MarkdownDocumentation": "`Gid`\n\nThe POSIX group ID.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1001`\n*Maximum*: `4000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customposixuserconfig.html#cfn-sagemaker-userprofile-customposixuserconfig-gid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::UserProfile.DefaultEbsStorageSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.DefaultEbsStorageSettings`\n\nA collection of default EBS storage settings that apply to spaces created within a domain or user profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-defaultebsstoragesettings.html", "Properties": { "MaximumEbsVolumeSizeInGb": { "MarkdownDocumentation": "`MaximumEbsVolumeSizeInGb`\n\nThe maximum size of the EBS storage volume for a space.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `5`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-defaultebsstoragesettings.html#cfn-sagemaker-userprofile-defaultebsstoragesettings-maximumebsvolumesizeingb", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DefaultEbsVolumeSizeInGb": { "MarkdownDocumentation": "`DefaultEbsVolumeSizeInGb`\n\nThe default size of the EBS storage volume for a space.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `5`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-defaultebsstoragesettings.html#cfn-sagemaker-userprofile-defaultebsstoragesettings-defaultebsvolumesizeingb", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::SageMaker::UserProfile.DefaultSpaceStorageSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.DefaultSpaceStorageSettings`\n\nThe default storage settings for a space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-defaultspacestoragesettings.html", "Properties": { "DefaultEbsStorageSettings": { "MarkdownDocumentation": "`DefaultEbsStorageSettings`\n\nThe default EBS storage settings for a space.\n*Required*: No\n*Type*: [DefaultEbsStorageSettings](./aws-properties-sagemaker-userprofile-defaultebsstoragesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-defaultspacestoragesettings.html#cfn-sagemaker-userprofile-defaultspacestoragesettings-defaultebsstoragesettings", "UpdateType": "Mutable", "Required": false, "Type": "DefaultEbsStorageSettings" } } }, "AWS::SageMaker::UserProfile.EFSFileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.EFSFileSystemConfig`\n\nThe settings for assigning a custom Amazon EFS file system to a user profile or\nspace for an Amazon SageMaker AI Domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-efsfilesystemconfig.html", "Properties": { "FileSystemPath": { "MarkdownDocumentation": "`FileSystemPath`\n\nThe path to the file system directory that is accessible in Amazon SageMaker AI Studio.\nPermitted users can access only this directory and below.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\/\\S*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-efsfilesystemconfig.html#cfn-sagemaker-userprofile-efsfilesystemconfig-filesystempath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe ID of your Amazon EFS file system.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(fs-[0-9a-f]{8,})$`\n*Minimum*: `11`\n*Maximum*: `21`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-efsfilesystemconfig.html#cfn-sagemaker-userprofile-efsfilesystemconfig-filesystemid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::UserProfile.FSxLustreFileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.FSxLustreFileSystemConfig`\n\nThe settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an\nAmazon SageMaker Domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-fsxlustrefilesystemconfig.html", "Properties": { "FileSystemPath": { "MarkdownDocumentation": "`FileSystemPath`\n\nThe path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted\nusers can access only this directory and below.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\/\\S*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-fsxlustrefilesystemconfig.html#cfn-sagemaker-userprofile-fsxlustrefilesystemconfig-filesystempath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(fs-[0-9a-f]{8,})$`\n*Minimum*: `11`\n*Maximum*: `21`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-fsxlustrefilesystemconfig.html#cfn-sagemaker-userprofile-fsxlustrefilesystemconfig-filesystemid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SageMaker::UserProfile.HiddenSageMakerImage": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.HiddenSageMakerImage`\n\nThe SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker\nimage name and version aliases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-hiddensagemakerimage.html", "Properties": { "SageMakerImageName": { "MarkdownDocumentation": "`SageMakerImageName`\n\nThe SageMaker image name that you are hiding from the Studio user interface.\n*Required*: No\n*Type*: String\n*Allowed values*: `sagemaker_distribution...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "sagemaker_distribution" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-hiddensagemakerimage.html#cfn-sagemaker-userprofile-hiddensagemakerimage-sagemakerimagename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VersionAliases": { "MarkdownDocumentation": "`VersionAliases`\n\nThe version aliases you are hiding from the Studio user interface.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-hiddensagemakerimage.html#cfn-sagemaker-userprofile-hiddensagemakerimage-versionaliases", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::UserProfile.IdleSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.IdleSettings`\n\nSettings related to idle shutdown of Studio applications.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-idlesettings.html", "Properties": { "MaxIdleTimeoutInMinutes": { "MarkdownDocumentation": "`MaxIdleTimeoutInMinutes`\n\nThe maximum value in minutes that custom idle shutdown can be set to by the user.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `525600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-idlesettings.html#cfn-sagemaker-userprofile-idlesettings-maxidletimeoutinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IdleTimeoutInMinutes": { "MarkdownDocumentation": "`IdleTimeoutInMinutes`\n\nThe time that SageMaker waits after the application becomes idle before shutting it\ndown.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `525600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-idlesettings.html#cfn-sagemaker-userprofile-idlesettings-idletimeoutinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinIdleTimeoutInMinutes": { "MarkdownDocumentation": "`MinIdleTimeoutInMinutes`\n\nThe minimum value in minutes that custom idle shutdown can be set to by the user.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `525600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-idlesettings.html#cfn-sagemaker-userprofile-idlesettings-minidletimeoutinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LifecycleManagement": { "MarkdownDocumentation": "`LifecycleManagement`\n\nIndicates whether idle shutdown is activated for the application type.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-idlesettings.html#cfn-sagemaker-userprofile-idlesettings-lifecyclemanagement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::UserProfile.JupyterLabAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.JupyterLabAppSettings`\n\nThe settings for the JupyterLab application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html", "Properties": { "CustomImages": { "MarkdownDocumentation": "`CustomImages`\n\nA list of custom SageMaker images that are configured to run as a JupyterLab app.\n*Required*: No\n*Type*: Array of [CustomImage](./aws-properties-sagemaker-userprofile-customimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-customimages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomImage", "DuplicatesAllowed": true }, "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker\nimage used by the JupyterLab app.\n*Required*: No\n*Type*: [ResourceSpec](./aws-properties-sagemaker-userprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "LifecycleConfigArns": { "MarkdownDocumentation": "`LifecycleConfigArns`\n\nThe Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-lifecycleconfigarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BuiltInLifecycleConfigArn": { "MarkdownDocumentation": "`BuiltInLifecycleConfigArn`\n\nThe lifecycle configuration that runs before the default lifecycle configuration. It can\noverride changes made in the default lifecycle configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-builtinlifecycleconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CodeRepositories": { "MarkdownDocumentation": "`CodeRepositories`\n\nA list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.\n*Required*: No\n*Type*: Array of [CodeRepository](./aws-properties-sagemaker-userprofile-coderepository.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-coderepositories", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CodeRepository", "DuplicatesAllowed": true }, "AppLifecycleManagement": { "MarkdownDocumentation": "`AppLifecycleManagement`\n\nIndicates whether idle shutdown is activated for JupyterLab applications.\n*Required*: No\n*Type*: [AppLifecycleManagement](./aws-properties-sagemaker-userprofile-applifecyclemanagement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-applifecyclemanagement", "UpdateType": "Mutable", "Required": false, "Type": "AppLifecycleManagement" } } }, "AWS::SageMaker::UserProfile.JupyterServerAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.JupyterServerAppSettings`\n\nThe JupyterServer app settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterserverappsettings.html", "Properties": { "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker\nimage used by the JupyterServer app.\n*Required*: No\n*Type*: [ResourceSpec](./aws-properties-sagemaker-userprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterserverappsettings.html#cfn-sagemaker-userprofile-jupyterserverappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "LifecycleConfigArns": { "MarkdownDocumentation": "`LifecycleConfigArns`\n\nThe Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the\nJupyterServerApp. If you use this parameter, the `DefaultResourceSpec` parameter is\nalso required.\n###### Note\nTo remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty\nlist.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterserverappsettings.html#cfn-sagemaker-userprofile-jupyterserverappsettings-lifecycleconfigarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::UserProfile.KernelGatewayAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.KernelGatewayAppSettings`\n\nThe KernelGateway app settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-kernelgatewayappsettings.html", "Properties": { "CustomImages": { "MarkdownDocumentation": "`CustomImages`\n\nA list of custom SageMaker AI images that are configured to run as a KernelGateway\napp.\nThe maximum number of custom images are as follows.\n* On a domain level: 200\n* On a space level: 5\n* On a user profile level: 5\n*Required*: No\n*Type*: Array of [CustomImage](./aws-properties-sagemaker-userprofile-customimage.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-kernelgatewayappsettings.html#cfn-sagemaker-userprofile-kernelgatewayappsettings-customimages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomImage", "DuplicatesAllowed": true }, "DefaultResourceSpec": { "MarkdownDocumentation": "`DefaultResourceSpec`\n\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.\n###### Note\nThe Amazon SageMaker AI Studio UI does not use the default instance type value set\nhere. The default instance type set here is used when Apps are created using the AWS CLI or CloudFormation and the instance type parameter value is not\npassed.\n*Required*: No\n*Type*: [ResourceSpec](./aws-properties-sagemaker-userprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-kernelgatewayappsettings.html#cfn-sagemaker-userprofile-kernelgatewayappsettings-defaultresourcespec", "UpdateType": "Mutable", "Required": false, "Type": "ResourceSpec" }, "LifecycleConfigArns": { "MarkdownDocumentation": "`LifecycleConfigArns`\n\nThe Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user\nprofile or domain.\n###### Note\nTo remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty\nlist.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-kernelgatewayappsettings.html#cfn-sagemaker-userprofile-kernelgatewayappsettings-lifecycleconfigarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::SageMaker::UserProfile.RStudioServerProAppSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.RStudioServerProAppSettings`\n\nA collection of settings that configure user interaction with the\n`RStudioServerPro` app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-rstudioserverproappsettings.html", "Properties": { "AccessStatus": { "MarkdownDocumentation": "`AccessStatus`\n\nIndicates whether the current user has access to the `RStudioServerPro`\napp.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-rstudioserverproappsettings.html#cfn-sagemaker-userprofile-rstudioserverproappsettings-accessstatus", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UserGroup": { "MarkdownDocumentation": "`UserGroup`\n\nThe level of permissions that the user has within the `RStudioServerPro` app.\nThis value defaults to `User`. The `Admin` value allows the user access to the RStudio\nAdministrative Dashboard.\n*Required*: No\n*Type*: String\n*Allowed values*: `R_STUDIO_ADMIN | R_STUDIO_U...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "R_STUDIO_ADMIN", "R_STUDIO_USER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-rstudioserverproappsettings.html#cfn-sagemaker-userprofile-rstudioserverproappsettings-usergroup", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::UserProfile.ResourceSpec": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.ResourceSpec`\n\nSpecifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that\nthe version runs on.\n###### Note\nWhen both `SageMakerImageVersionArn` and `SageMakerImageArn` are passed, `SageMakerImageVersionArn` is used. Any updates to `SageMakerImageArn` will not take effect if `SageMakerImageVersionArn` already exists in the `ResourceSpec` because `SageMakerImageVersionArn` always takes precedence. To clear the value set for `SageMakerImageVersionArn`, pass `None` as the value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html", "Properties": { "LifecycleConfigArn": { "MarkdownDocumentation": "`LifecycleConfigArn`\n\nThe Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the\nResource.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html#cfn-sagemaker-userprofile-resourcespec-lifecycleconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SageMakerImageArn": { "MarkdownDocumentation": "`SageMakerImageArn`\n\nThe ARN of the SageMaker AI image that the image version belongs to.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html#cfn-sagemaker-userprofile-resourcespec-sagemakerimagearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type that the image version runs on.\n###### Note\n**JupyterServer apps** only support the `system` value.\nFor **KernelGateway apps**, the `system`\nvalue is translated to `ml.t3.medium`. KernelGateway apps also support all other values for available\ninstance types.\n*Required*: No\n*Type*: String\n*Allowed values*: `system | ml.t3.micro | ml.t...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "system", "ml.t3.micro", "ml.t3.small", "ml.t3.medium", "ml.t3.large", "ml.t3.xlarge", "ml.t3.2xlarge", "ml.m5.large", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.8xlarge", "ml.m5.12xlarge", "ml.m5.16xlarge", "ml.m5.24xlarge", "ml.m5d.large", "ml.m5d.xlarge", "ml.m5d.2xlarge", "ml.m5d.4xlarge", "ml.m5d.8xlarge", "ml.m5d.12xlarge", "ml.m5d.16xlarge", "ml.m5d.24xlarge", "ml.c5.large", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.12xlarge", "ml.c5.18xlarge", "ml.c5.24xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", "ml.g4dn.xlarge", "ml.g4dn.2xlarge", "ml.g4dn.4xlarge", "ml.g4dn.8xlarge", "ml.g4dn.12xlarge", "ml.g4dn.16xlarge", "ml.r5.large", "ml.r5.xlarge", "ml.r5.2xlarge", "ml.r5.4xlarge", "ml.r5.8xlarge", "ml.r5.12xlarge", "ml.r5.16xlarge", "ml.r5.24xlarge", "ml.g5.xlarge", "ml.g5.2xlarge", "ml.g5.4xlarge", "ml.g5.8xlarge", "ml.g5.12xlarge", "ml.g5.16xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", "ml.g6.xlarge", "ml.g6.2xlarge", "ml.g6.4xlarge", "ml.g6.8xlarge", "ml.g6.12xlarge", "ml.g6.16xlarge", "ml.g6.24xlarge", "ml.g6.48xlarge", "ml.g6e.xlarge", "ml.g6e.2xlarge", "ml.g6e.4xlarge", "ml.g6e.8xlarge", "ml.g6e.12xlarge", "ml.g6e.16xlarge", "ml.g6e.24xlarge", "ml.g6e.48xlarge", "ml.geospatial.interactive", "ml.p4d.24xlarge", "ml.p4de.24xlarge", "ml.trn1.2xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.p5.48xlarge", "ml.p5e.48xlarge", "ml.p5en.48xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", "ml.m6i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.12xlarge", "ml.m6i.16xlarge", "ml.m6i.24xlarge", "ml.m6i.32xlarge", "ml.m7i.large", "ml.m7i.xlarge", "ml.m7i.2xlarge", "ml.m7i.4xlarge", "ml.m7i.8xlarge", "ml.m7i.12xlarge", "ml.m7i.16xlarge", "ml.m7i.24xlarge", "ml.m7i.48xlarge", "ml.c6i.large", "ml.c6i.xlarge", "ml.c6i.2xlarge", "ml.c6i.4xlarge", "ml.c6i.8xlarge", "ml.c6i.12xlarge", "ml.c6i.16xlarge", "ml.c6i.24xlarge", "ml.c6i.32xlarge", "ml.c7i.large", "ml.c7i.xlarge", "ml.c7i.2xlarge", "ml.c7i.4xlarge", "ml.c7i.8xlarge", "ml.c7i.12xlarge", "ml.c7i.16xlarge", "ml.c7i.24xlarge", "ml.c7i.48xlarge", "ml.r6i.large", "ml.r6i.xlarge", "ml.r6i.2xlarge", "ml.r6i.4xlarge", "ml.r6i.8xlarge", "ml.r6i.12xlarge", "ml.r6i.16xlarge", "ml.r6i.24xlarge", "ml.r6i.32xlarge", "ml.r7i.large", "ml.r7i.xlarge", "ml.r7i.2xlarge", "ml.r7i.4xlarge", "ml.r7i.8xlarge", "ml.r7i.12xlarge", "ml.r7i.16xlarge", "ml.r7i.24xlarge", "ml.r7i.48xlarge", "ml.m6id.large", "ml.m6id.xlarge", "ml.m6id.2xlarge", "ml.m6id.4xlarge", "ml.m6id.8xlarge", "ml.m6id.12xlarge", "ml.m6id.16xlarge", "ml.m6id.24xlarge", "ml.m6id.32xlarge", "ml.c6id.large", "ml.c6id.xlarge", "ml.c6id.2xlarge", "ml.c6id.4xlarge", "ml.c6id.8xlarge", "ml.c6id.12xlarge", "ml.c6id.16xlarge", "ml.c6id.24xlarge", "ml.c6id.32xlarge", "ml.r6id.large", "ml.r6id.xlarge", "ml.r6id.2xlarge", "ml.r6id.4xlarge", "ml.r6id.8xlarge", "ml.r6id.12xlarge", "ml.r6id.16xlarge", "ml.r6id.24xlarge", "ml.r6id.32xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html#cfn-sagemaker-userprofile-resourcespec-instancetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SageMakerImageVersionArn": { "MarkdownDocumentation": "`SageMakerImageVersionArn`\n\nThe ARN of the image version created on the instance. To clear the value set for `SageMakerImageVersionArn`, pass `None` as the value.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html#cfn-sagemaker-userprofile-resourcespec-sagemakerimageversionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::UserProfile.S3FileSystemConfig": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.S3FileSystemConfig`\n\nConfiguration for the custom Amazon S3 file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-s3filesystemconfig.html", "Properties": { "MountPath": { "MarkdownDocumentation": "`MountPath`\n\nThe file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker\nStudio environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-s3filesystemconfig.html#cfn-sagemaker-userprofile-s3filesystemconfig-mountpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Uri": { "MarkdownDocumentation": "`S3Uri`\n\nThe Amazon S3 URI of the S3 file system configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `(s3)://([^/]+)/?(.*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-s3filesystemconfig.html#cfn-sagemaker-userprofile-s3filesystemconfig-s3uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::UserProfile.SharingSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.SharingSettings`\n\nSpecifies options when sharing an Amazon SageMaker Studio notebook. These settings are\nspecified as part of `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is\ncalled, and as part of `UserSettings` when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html)\nAPI is called.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html", "Properties": { "NotebookOutputOption": { "MarkdownDocumentation": "`NotebookOutputOption`\n\nWhether to include the notebook cell output when sharing the notebook. The default is\n`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)", "RefReturnValue": "", "AllowedValues": [ "Allowed", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-notebookoutputoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3KmsKeyId": { "MarkdownDocumentation": "`S3KmsKeyId`\n\nWhen `NotebookOutputOption` is `Allowed`, the AWS Key\nManagement Service (KMS) encryption key ID used to encrypt the notebook cell output in the\nAmazon S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-s3kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3OutputPath": { "MarkdownDocumentation": "`S3OutputPath`\n\nWhen `NotebookOutputOption` is `Allowed`, the Amazon S3\nbucket used to store the shared notebook snapshots.\n*Required*: No\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-s3outputpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SageMaker::UserProfile.StudioWebPortalSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.StudioWebPortalSettings`\n\nStudio settings. If these settings are applied on a user level, they take priority over\nthe settings applied on a domain level.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-studiowebportalsettings.html", "Properties": { "HiddenSageMakerImageVersionAliases": { "MarkdownDocumentation": "`HiddenSageMakerImageVersionAliases`\n\nThe version aliases you are hiding from the Studio user interface.\n*Required*: No\n*Type*: Array of [HiddenSageMakerImage](./aws-properties-sagemaker-userprofile-hiddensagemakerimage.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-studiowebportalsettings.html#cfn-sagemaker-userprofile-studiowebportalsettings-hiddensagemakerimageversionaliases", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HiddenSageMakerImage", "DuplicatesAllowed": false }, "HiddenAppTypes": { "MarkdownDocumentation": "`HiddenAppTypes`\n\nThe [Applications supported in Studio](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-apps.html) that are hidden from the Studio left navigation\npane.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-studiowebportalsettings.html#cfn-sagemaker-userprofile-studiowebportalsettings-hiddenapptypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HiddenInstanceTypes": { "MarkdownDocumentation": "`HiddenInstanceTypes`\n\nThe instance types you are hiding from the Studio user interface.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-studiowebportalsettings.html#cfn-sagemaker-userprofile-studiowebportalsettings-hiddeninstancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HiddenMlTools": { "MarkdownDocumentation": "`HiddenMlTools`\n\nThe machine learning tools that are hidden from the Studio left navigation pane.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-studiowebportalsettings.html#cfn-sagemaker-userprofile-studiowebportalsettings-hiddenmltools", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } } }, "AWS::SageMaker::UserProfile.UserSettings": { "MarkdownDocumentation": "`AWS::SageMaker::UserProfile.UserSettings`\n\nA collection of settings that apply to users of Amazon SageMaker Studio. These settings\nare specified when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html)\nAPI is called, and as `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is\ncalled.\n`SecurityGroups` is aggregated when specified in both calls. For all other\nsettings in `UserSettings`, the values specified in\n`CreateUserProfile` take precedence over those specified in\n`CreateDomain`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for\ncommunication.\nOptional when the `CreateDomain.AppNetworkAccessType` parameter is set to\n`PublicInternetOnly`.\nRequired when the `CreateDomain.AppNetworkAccessType` parameter is set to\n`VpcOnly`, unless specified as part of the `DefaultUserSettings` for\nthe domain.\nAmazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the\nmaximum number shown.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `32 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "JupyterLabAppSettings": { "MarkdownDocumentation": "`JupyterLabAppSettings`\n\nThe settings for the JupyterLab application.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: [JupyterLabAppSettings](./aws-properties-sagemaker-userprofile-jupyterlabappsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-jupyterlabappsettings", "UpdateType": "Mutable", "Required": false, "Type": "JupyterLabAppSettings" }, "KernelGatewayAppSettings": { "MarkdownDocumentation": "`KernelGatewayAppSettings`\n\nThe kernel gateway app settings.\n*Required*: No\n*Type*: [KernelGatewayAppSettings](./aws-properties-sagemaker-userprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-kernelgatewayappsettings", "UpdateType": "Mutable", "Required": false, "Type": "KernelGatewayAppSettings" }, "StudioWebPortalSettings": { "MarkdownDocumentation": "`StudioWebPortalSettings`\n\nStudio settings. If these settings are applied on a user level, they take priority over\nthe settings applied on a domain level.\n*Required*: No\n*Type*: [StudioWebPortalSettings](./aws-properties-sagemaker-userprofile-studiowebportalsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-studiowebportalsettings", "UpdateType": "Mutable", "Required": false, "Type": "StudioWebPortalSettings" }, "CustomFileSystemConfigs": { "MarkdownDocumentation": "`CustomFileSystemConfigs`\n\nThe settings for assigning a custom file system to a user profile. Permitted users can\naccess this file system in Amazon SageMaker AI Studio.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: Array of [CustomFileSystemConfig](./aws-properties-sagemaker-userprofile-customfilesystemconfig.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-customfilesystemconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomFileSystemConfig", "DuplicatesAllowed": false }, "CustomPosixUserConfig": { "MarkdownDocumentation": "`CustomPosixUserConfig`\n\nDetails about the POSIX identity that is used for file system operations.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: [CustomPosixUserConfig](./aws-properties-sagemaker-userprofile-customposixuserconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-customposixuserconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomPosixUserConfig" }, "CodeEditorAppSettings": { "MarkdownDocumentation": "`CodeEditorAppSettings`\n\nThe Code Editor application settings.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: [CodeEditorAppSettings](./aws-properties-sagemaker-userprofile-codeeditorappsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-codeeditorappsettings", "UpdateType": "Mutable", "Required": false, "Type": "CodeEditorAppSettings" }, "RStudioServerProAppSettings": { "MarkdownDocumentation": "`RStudioServerProAppSettings`\n\nA collection of settings that configure user interaction with the\n`RStudioServerPro` app.\n*Required*: No\n*Type*: [RStudioServerProAppSettings](./aws-properties-sagemaker-userprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-rstudioserverproappsettings", "UpdateType": "Mutable", "Required": false, "Type": "RStudioServerProAppSettings" }, "StudioWebPortal": { "MarkdownDocumentation": "`StudioWebPortal`\n\nWhether the user can access Studio. If this value is set to `DISABLED`, the\nuser cannot access Studio, even if that is the default experience for the domain.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-studiowebportal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JupyterServerAppSettings": { "MarkdownDocumentation": "`JupyterServerAppSettings`\n\nThe Jupyter server's app settings.\n*Required*: No\n*Type*: [JupyterServerAppSettings](./aws-properties-sagemaker-userprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-jupyterserverappsettings", "UpdateType": "Mutable", "Required": false, "Type": "JupyterServerAppSettings" }, "AutoMountHomeEFS": { "MarkdownDocumentation": "`AutoMountHomeEFS`\n\nIndicates whether auto-mounting of an EFS volume is supported for the user profile. The\n`DefaultAsDomain` value is only supported for user profiles. Do not use the\n`DefaultAsDomain` value when setting this parameter for a domain.\nSageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.\n*Required*: No\n*Type*: String\n*Allowed values*: `Enabled | Disabled | Defaul...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled", "DefaultAsDomain" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-automounthomeefs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultLandingUri": { "MarkdownDocumentation": "`DefaultLandingUri`\n\nThe default experience that the user is directed to when accessing the domain. The\nsupported values are:\n* `studio::`: Indicates that Studio is the default experience. This value can\n only be passed if `StudioWebPortal` is set to `ENABLED`.\n* `app:JupyterServer:`: Indicates that Studio Classic is the default\n experience.\n*Required*: No\n*Type*: String\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-defaultlandinguri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe execution role for the user.\nSageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-executionrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SpaceStorageSettings": { "MarkdownDocumentation": "`SpaceStorageSettings`\n\nThe storage settings for a space.\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.\n*Required*: No\n*Type*: [DefaultSpaceStorageSettings](./aws-properties-sagemaker-userprofile-defaultspacestoragesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-spacestoragesettings", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSpaceStorageSettings" }, "SharingSettings": { "MarkdownDocumentation": "`SharingSettings`\n\nSpecifies options for sharing Amazon SageMaker AI Studio notebooks.\n*Required*: No\n*Type*: [SharingSettings](./aws-properties-sagemaker-userprofile-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-sharingsettings", "UpdateType": "Mutable", "Required": false, "Type": "SharingSettings" } } }, "AWS::SageMaker::Workteam.CognitoMemberDefinition": { "MarkdownDocumentation": "`AWS::SageMaker::Workteam.CognitoMemberDefinition`\n\nIdentifies a Amazon Cognito user group. A user group can be used in on or more work\nteams.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html", "Properties": { "CognitoUserPool": { "Required": true, "MarkdownDocumentation": "`CognitoUserPool`\n\nAn identifier for a user pool. The user pool must be in the same region as the service\nthat you are calling.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitouserpool", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CognitoClientId": { "Required": true, "MarkdownDocumentation": "`CognitoClientId`\n\nAn identifier for an application client. You must create the app client ID using Amazon Cognito.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitoclientid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CognitoUserGroup": { "Required": true, "MarkdownDocumentation": "`CognitoUserGroup`\n\nAn identifier for a user 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitousergroup", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Workteam.MemberDefinition": { "MarkdownDocumentation": "`AWS::SageMaker::Workteam.MemberDefinition`\n\nDefines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html", "Properties": { "OidcMemberDefinition": { "Type": "OidcMemberDefinition", "Required": false, "MarkdownDocumentation": "`OidcMemberDefinition`\n\nA list user groups that exist in your OIDC Identity Provider (IdP).\nOne to ten groups can be used to create a single private work team.\nWhen you add a user group to the list of `Groups`, you can add that user group to one or more\nprivate work teams. If you add a user group to a private work team, all workers in that user group\nare added to the work team.\n*Required*: No\n*Type*: [OidcMemberDefinition](./aws-properties-sagemaker-workteam-oidcmemberdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html#cfn-sagemaker-workteam-memberdefinition-oidcmemberdefinition", "UpdateType": "Mutable" }, "CognitoMemberDefinition": { "Type": "CognitoMemberDefinition", "Required": false, "MarkdownDocumentation": "`CognitoMemberDefinition`\n\nThe Amazon Cognito user group that is part of the work team.\n*Required*: No\n*Type*: [CognitoMemberDefinition](./aws-properties-sagemaker-workteam-cognitomemberdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html#cfn-sagemaker-workteam-memberdefinition-cognitomemberdefinition", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Workteam.NotificationConfiguration": { "MarkdownDocumentation": "`AWS::SageMaker::Workteam.NotificationConfiguration`\n\nConfigures Amazon SNS notifications of available or expiring work items for work\nteams.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-notificationconfiguration.html", "Properties": { "NotificationTopicArn": { "Required": true, "MarkdownDocumentation": "`NotificationTopicArn`\n\nThe ARN for the Amazon SNS topic to which notifications should be published.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-notificationconfiguration.html#cfn-sagemaker-workteam-notificationconfiguration-notificationtopicarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SageMaker::Workteam.OidcMemberDefinition": { "MarkdownDocumentation": "`AWS::SageMaker::Workteam.OidcMemberDefinition`\n\nA list of user groups that exist in your OIDC Identity Provider (IdP).\nOne to ten groups can be used to create a single private work team.\nWhen you add a user group to the list of `Groups`, you can add that user group to one or more\nprivate work teams. If you add a user group to a private work team, all workers in that user group\nare added to the work team.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-oidcmemberdefinition.html", "Properties": { "OidcGroups": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`OidcGroups`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-oidcmemberdefinition.html#cfn-sagemaker-workteam-oidcmemberdefinition-oidcgroups", "UpdateType": "Mutable" } } }, "AWS::Scheduler::Schedule.AwsVpcConfiguration": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.AwsVpcConfiguration`\n\nThis structure specifies 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nSpecifies 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.\nIf you do not specify a security group, the default security group for the VPC is used.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `1000 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nSpecifies 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*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `1000 | 16`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-subnets", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AssignPublicIp": { "MarkdownDocumentation": "`AssignPublicIp`\n\nSpecifies 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*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-assignpublicip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.CapacityProviderStrategyItem": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.CapacityProviderStrategyItem`\n\nThe details of a capacity provider strategy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html", "Properties": { "CapacityProvider": { "MarkdownDocumentation": "`CapacityProvider`\n\nThe short name of the capacity provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-capacityprovider", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe 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\nbase value, if defined, is satisfied.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Base": { "MarkdownDocumentation": "`Base`\n\nThe 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.\nIf no value is specified, the default value of `0` is used.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-base", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Scheduler::Schedule.DeadLetterConfig": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.DeadLetterConfig`\n\nAn object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-deadletterconfig.html", "Properties": { "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z-]*:sqs:[a-z0-9\\-]+:\\d{12}:[a-zA-Z0-9\\-_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-deadletterconfig.html#cfn-scheduler-schedule-deadletterconfig-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.EcsParameters": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.EcsParameters`\n\nThe templated target type for the Amazon ECS[`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html", "Properties": { "PlatformVersion": { "MarkdownDocumentation": "`PlatformVersion`\n\nSpecifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-platformversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Group": { "MarkdownDocumentation": "`Group`\n\nSpecifies an Amazon ECS task group for the task. The maximum length is 255 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-group", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableECSManagedTags": { "MarkdownDocumentation": "`EnableECSManagedTags`\n\nSpecifies 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)\nin the *Amazon ECS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-enableecsmanagedtags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TaskCount": { "MarkdownDocumentation": "`TaskCount`\n\nThe number of tasks to create based on `TaskDefinition`. The default is `1`.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-taskcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "EnableExecuteCommand": { "MarkdownDocumentation": "`EnableExecuteCommand`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-enableexecutecommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PlacementConstraints": { "MarkdownDocumentation": "`PlacementConstraints`\n\nAn 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*: Array of [PlacementConstraint](./aws-properties-scheduler-schedule-placementconstraint.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-placementconstraints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlacementConstraint", "DuplicatesAllowed": true }, "PropagateTags": { "MarkdownDocumentation": "`PropagateTags`\n\nSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated.\nTags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS[`TagResource`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html)\nAPI action.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "TASK_DEFINITION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-propagatetags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlacementStrategy": { "MarkdownDocumentation": "`PlacementStrategy`\n\nThe task placement strategy for a task or service.\n*Required*: No\n*Type*: [Array](./aws-properties-scheduler-schedule-placementstrategy.html) of [PlacementStrategy](./aws-properties-scheduler-schedule-placementstrategy.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-placementstrategy", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlacementStrategy", "DuplicatesAllowed": true }, "LaunchType": { "MarkdownDocumentation": "`LaunchType`\n\nSpecifies 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.\nThe `FARGATE` value is supported only in the Regions where Fargate with Amazon ECS is supported.\nFor more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) in the *Amazon ECS Developer Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `EC2 | FARGATE | EXTERNAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EC2", "FARGATE", "EXTERNAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-launchtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityProviderStrategy": { "MarkdownDocumentation": "`CapacityProviderStrategy`\n\nThe capacity provider strategy to use for the task.\n*Required*: No\n*Type*: Array of [CapacityProviderStrategyItem](./aws-properties-scheduler-schedule-capacityproviderstrategyitem.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-capacityproviderstrategy", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CapacityProviderStrategyItem", "DuplicatesAllowed": true }, "ReferenceId": { "MarkdownDocumentation": "`ReferenceId`\n\nThe reference ID to use for the task.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-referenceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThis structure specifies the network configuration for an ECS task.\n*Required*: No\n*Type*: [NetworkConfiguration](./aws-properties-scheduler-schedule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NetworkConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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.\nFor more information, see [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) in the *Amazon ECS API Reference*.\n*Required*: No\n*Type*: Array of Object\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-tags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TaskDefinitionArn": { "MarkdownDocumentation": "`TaskDefinitionArn`\n\nThe Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-taskdefinitionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.EventBridgeParameters": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.EventBridgeParameters`\n\nThe templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html", "Properties": { "DetailType": { "MarkdownDocumentation": "`DetailType`\n\nA free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html#cfn-scheduler-schedule-eventbridgeparameters-detailtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the event.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html#cfn-scheduler-schedule-eventbridgeparameters-source", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.FlexibleTimeWindow": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.FlexibleTimeWindow`\n\nAllows you to configure a time window during which EventBridge Scheduler invokes the schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nDetermines whether the schedule is invoked within a flexible time window. You must use quotation marks when you specify this value in your JSON or YAML template.\n*Allowed Values*: `\"OFF\"` | `\"FLEXIBLE\"`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OFF | FLEXIBLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OFF", "FLEXIBLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html#cfn-scheduler-schedule-flexibletimewindow-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaximumWindowInMinutes": { "MarkdownDocumentation": "`MaximumWindowInMinutes`\n\nThe maximum time window during which a schedule can be invoked.\n*Minimum*: `1`\n*Maximum*: `1440`\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html#cfn-scheduler-schedule-flexibletimewindow-maximumwindowinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Scheduler::Schedule.KinesisParameters": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.KinesisParameters`\n\nThe templated target type for the Amazon Kinesis [`PutRecord`](kinesis/latest/APIReference/API_PutRecord.html) API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-kinesisparameters.html", "Properties": { "PartitionKey": { "MarkdownDocumentation": "`PartitionKey`\n\nSpecifies the shard to which EventBridge Scheduler sends the event. For more information, see [Amazon Kinesis Data Streams terminology and concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html) in the\n*Amazon Kinesis Streams Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-kinesisparameters.html#cfn-scheduler-schedule-kinesisparameters-partitionkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.NetworkConfiguration": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.NetworkConfiguration`\n\nSpecifies the network configuration for an ECS task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-networkconfiguration.html", "Properties": { "AwsvpcConfiguration": { "MarkdownDocumentation": "`AwsvpcConfiguration`\n\nSpecifies the Amazon 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](./aws-properties-scheduler-schedule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-networkconfiguration.html#cfn-scheduler-schedule-networkconfiguration-awsvpcconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AwsVpcConfiguration" } } }, "AWS::Scheduler::Schedule.PlacementConstraint": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.PlacementConstraint`\n\nAn object representing a constraint on task placement.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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*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)", "RefReturnValue": "", "AllowedValues": [ "distinctInstance", "memberOf" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html#cfn-scheduler-schedule-placementconstraint-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nA cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is `distinctInstance`.\nFor more information, see [Cluster query language](https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html) in the *Amazon ECS Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html#cfn-scheduler-schedule-placementconstraint-expression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.PlacementStrategy": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.PlacementStrategy`\n\nThe task placement strategy for a task or service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nThe field to apply the placement strategy against. For the spread placement strategy, valid values are `instanceId` (or `instanceId`, which has the same effect),\nor 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\n`cpu` and `memory`. For the random placement strategy, this field is not used.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html#cfn-scheduler-schedule-placementstrategy-field", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates\nevenly 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.\nFor 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*Allowed values*: `random | spread | binpack...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "random", "spread", "binpack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html#cfn-scheduler-schedule-placementstrategy-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.RetryPolicy": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.RetryPolicy`\n\nA `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html", "Properties": { "MaximumRetryAttempts": { "MarkdownDocumentation": "`MaximumRetryAttempts`\n\nThe maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or\nuntil the duration of the `MaximumEventAgeInSeconds` is reached.\n*Required*: No\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `185`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html#cfn-scheduler-schedule-retrypolicy-maximumretryattempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "MaximumEventAgeInSeconds": { "MarkdownDocumentation": "`MaximumEventAgeInSeconds`\n\nThe maximum amount of time, in seconds, to continue to make retry attempts.\n*Required*: No\n*Type*: Number\n*Minimum*: `60`\n*Maximum*: `86400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html#cfn-scheduler-schedule-retrypolicy-maximumeventageinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::Scheduler::Schedule.SageMakerPipelineParameter": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.SageMakerPipelineParameter`\n\nThe name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nValue of parameter to start execution of a SageMaker Model Building Pipeline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html#cfn-scheduler-schedule-sagemakerpipelineparameter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of parameter to start execution of a SageMaker Model Building Pipeline.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9\\-_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html#cfn-scheduler-schedule-sagemakerpipelineparameter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.SageMakerPipelineParameters": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.SageMakerPipelineParameters`\n\nThe templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameters.html", "Properties": { "PipelineParameterList": { "MarkdownDocumentation": "`PipelineParameterList`\n\nList of parameter names and values to use when executing the SageMaker Model Building Pipeline.\n*Required*: No\n*Type*: Array of [SageMakerPipelineParameter](./aws-properties-scheduler-schedule-sagemakerpipelineparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameters.html#cfn-scheduler-schedule-sagemakerpipelineparameters-pipelineparameterlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SageMakerPipelineParameter", "DuplicatesAllowed": true } } }, "AWS::Scheduler::Schedule.SqsParameters": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.SqsParameters`\n\nThe templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation.\nContains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled.\nFor more information, see [Using the Amazon SQS message deduplication ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the\n*Amazon SQS Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html", "Properties": { "MessageGroupId": { "MarkdownDocumentation": "`MessageGroupId`\n\nThe FIFO message group ID to use as the target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html#cfn-scheduler-schedule-sqsparameters-messagegroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Scheduler::Schedule.Target": { "MarkdownDocumentation": "`AWS::Scheduler::Schedule.Target`\n\nThe schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to\ninvoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html", "Properties": { "Input": { "MarkdownDocumentation": "`Input`\n\nThe text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target,\nthe input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, Amazon EventBridge Scheduler\ndelivers a default notification to the target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SqsParameters": { "MarkdownDocumentation": "`SqsParameters`\n\nThe templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation.\nContains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled.\nFor more information, see [Using the Amazon SQS message deduplication ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the\n*Amazon SQS Developer Guide*.\n*Required*: No\n*Type*: [SqsParameters](./aws-properties-scheduler-schedule-sqsparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-sqsparameters", "UpdateType": "Mutable", "Required": false, "Type": "SqsParameters" }, "DeadLetterConfig": { "MarkdownDocumentation": "`DeadLetterConfig`\n\nAn object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.\n*Required*: No\n*Type*: [DeadLetterConfig](./aws-properties-scheduler-schedule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig", "UpdateType": "Mutable", "Required": false, "Type": "DeadLetterConfig" }, "EcsParameters": { "MarkdownDocumentation": "`EcsParameters`\n\nThe templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.\n*Required*: No\n*Type*: [EcsParameters](./aws-properties-scheduler-schedule-ecsparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-ecsparameters", "UpdateType": "Mutable", "Required": false, "Type": "EcsParameters" }, "EventBridgeParameters": { "MarkdownDocumentation": "`EventBridgeParameters`\n\nThe templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.\n*Required*: No\n*Type*: [EventBridgeParameters](./aws-properties-scheduler-schedule-eventbridgeparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-eventbridgeparameters", "UpdateType": "Mutable", "Required": false, "Type": "EventBridgeParameters" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the target.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KinesisParameters": { "MarkdownDocumentation": "`KinesisParameters`\n\nThe templated target type for the Amazon Kinesis [`PutRecord`](kinesis/latest/APIReference/API_PutRecord.html) API operation.\n*Required*: No\n*Type*: [KinesisParameters](./aws-properties-scheduler-schedule-kinesisparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-kinesisparameters", "UpdateType": "Mutable", "Required": false, "Type": "KinesisParameters" }, "SageMakerPipelineParameters": { "MarkdownDocumentation": "`SageMakerPipelineParameters`\n\nThe templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.\n*Required*: No\n*Type*: [SageMakerPipelineParameters](./aws-properties-scheduler-schedule-sagemakerpipelineparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-sagemakerpipelineparameters", "UpdateType": "Mutable", "Required": false, "Type": "SageMakerPipelineParameters" }, "RetryPolicy": { "MarkdownDocumentation": "`RetryPolicy`\n\nA `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.\n*Required*: No\n*Type*: [RetryPolicy](./aws-properties-scheduler-schedule-retrypolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy", "UpdateType": "Mutable", "Required": false, "Type": "RetryPolicy" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z-]*:iam::\\d{12}:role\\/[\\w+=,.@\\/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecretsManager::RotationSchedule.ExternalSecretRotationMetadataItem": { "MarkdownDocumentation": "`AWS::SecretsManager::RotationSchedule.ExternalSecretRotationMetadataItem`\n\nThe metadata needed to successfully rotate a managed external secret. A list of key\nvalue pairs in JSON format specified by the partner. For more information, see [Managed\nexternal secret partners](https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-externalsecretrotationmetadataitem.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the specified item.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-externalsecretrotationmetadataitem.html#cfn-secretsmanager-rotationschedule-externalsecretrotationmetadataitem-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key that identifies the item.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-externalsecretrotationmetadataitem.html#cfn-secretsmanager-rotationschedule-externalsecretrotationmetadataitem-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecretsManager::RotationSchedule.HostedRotationLambda": { "MarkdownDocumentation": "`AWS::SecretsManager::RotationSchedule.HostedRotationLambda`\n\nCreates a new Lambda rotation\nfunction based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html).\nYou must specify `Transform:\nAWS::SecretsManager-2024-09-16` at the beginning of the CloudFormation\ntemplate.\nFor Amazon RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).\nFor Amazon Redshift admin user credentials, see [AWS::Redshift::Cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html", "Properties": { "Runtime": { "MarkdownDocumentation": "`Runtime`\n\n###### Important\nDo not set this value if you are using `Transform: AWS::SecretsManager-2024-09-16`. Over time, the updated rotation lambda artifacts vended by AWS may not be compatible with the code or shared object files defined in the rotation function deployment package.\nOnly define the `Runtime` key if:\n1. You are using `Transform: AWS::SecretsManager-2020-07-23`.\n2. The code or shared object files defined in the rotation function deployment package are incompatible with Python 3.10.\nThe Python Runtime version for with the rotation function. By default, CloudFormation deploys Python 3.10 binaries for the rotation function. To use a different version of Python, you must do the following two steps:\n1. Deploy the matching version Python binaries with your rotation function.\n2. Set the version number in this field. For example, for Python 3.10, enter **python3.10**.\nIf you only do one of the steps, your rotation function will be incompatible with the binaries. For more information, see [Why did my Lambda rotation function fail with a \"pg module not found\" error](https://repost.aws/knowledge-center/secrets-manager-lambda-rotation).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-runtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the KMS key that Secrets Manager uses to encrypt the secret. If you don't\nspecify this value, then Secrets Manager uses the key `aws/secretsmanager`. If\n`aws/secretsmanager` doesn't yet exist, then Secrets Manager creates it for you\nautomatically the first time it encrypts the secret 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterSecretArn": { "MarkdownDocumentation": "`MasterSecretArn`\n\nThe ARN of the secret that contains superuser credentials, if you use the\n [Alternating users rotation strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users). CloudFormation grants the execution role for the Lambda rotation function `GetSecretValue` permission to the secret in this property. For more information, see [Lambda rotation function execution role permissions for Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html).\nYou must create the superuser secret before you can set this property.\nYou must also include the superuser secret ARN as a key in the JSON of the rotating secret so that the Lambda rotation function can find it. CloudFormation does not hardcode secret ARNs in the Lambda rotation function, so you can use the function to rotate multiple secrets. For more information, see [JSON structure of Secrets Manager secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html).\nYou can specify `MasterSecretArn` or `SuperuserSecretArn` but not both. They represent the same superuser 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-mastersecretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RotationLambdaName": { "MarkdownDocumentation": "`RotationLambdaName`\n\nThe name of the Lambda rotation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-rotationlambdaname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RotationType": { "MarkdownDocumentation": "`RotationType`\n\nThe rotation template to base the rotation function on, one of the following:\n* `Db2SingleUser` to use the template [SecretsManagerRDSDb2RotationSingleUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-db2-singleuser).\n* `Db2MultiUser` to use the template [SecretsManagerRDSDb2RotationMultiUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-db2-multiuser).\n* `MySQLSingleUser` to use the template [SecretsManagerRDSMySQLRotationSingleUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-mysql-singleuser).\n* `MySQLMultiUser` to use the template [SecretsManagerRDSMySQLRotationMultiUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-mysql-multiuser).\n* `PostgreSQLSingleUser` to use the template [SecretsManagerRDSPostgreSQLRotationSingleUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-postgre-singleuser)\n* `PostgreSQLMultiUser` to use the template [SecretsManagerRDSPostgreSQLRotationMultiUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-postgre-multiuser).\n* `OracleSingleUser` to use the template [SecretsManagerRDSOracleRotationSingleUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-oracle-singleuser).\n* `OracleMultiUser` to use the template [SecretsManagerRDSOracleRotationMultiUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-oracle-multiuser).\n* `MariaDBSingleUser` to use the template [SecretsManagerRDSMariaDBRotationSingleUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-mariadb-singleuser).\n* `MariaDBMultiUser` to use the template [SecretsManagerRDSMariaDBRotationMultiUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-mariadb-multiuser).\n* `SQLServerSingleUser` to use the template [SecretsManagerRDSSQLServerRotationSingleUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-sqlserver-singleuser).\n* `SQLServerMultiUser` to use the template [SecretsManagerRDSSQLServerRotationMultiUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-sqlserver-multiuser).\n* `RedshiftSingleUser` to use the template [SecretsManagerRedshiftRotationSingleUsr](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-redshift-singleuser).\n* `RedshiftMultiUser` to use the template [SecretsManagerRedshiftRotationMultiUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-redshift-multiuser).\n* `MongoDBSingleUser` to use the template [SecretsManagerMongoDBRotationSingleUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-mongodb-singleuser).\n* `MongoDBMultiUser` to use the template [SecretsManagerMongoDBRotationMultiUser](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html#sar-template-mongodb-multiuser).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-rotationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExcludeCharacters": { "MarkdownDocumentation": "`ExcludeCharacters`\n\nA string of the characters that you don't want in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-excludecharacters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nA comma-separated list of security group IDs applied to the target database.\nThe template applies the same security groups as on the Lambda rotation function that is\ncreated as part of this stack.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterSecretKmsKeyArn": { "MarkdownDocumentation": "`MasterSecretKmsKeyArn`\n\nThe ARN of the KMS key that Secrets Manager used to encrypt the superuser secret, if\nyou use the [alternating users strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users) and the superuser secret is encrypted with a customer managed key. You don't need to specify this property if the superuser secret is encrypted using the key `aws/secretsmanager`. CloudFormation grants the execution role for the Lambda rotation function `Decrypt`, `DescribeKey`, and `GenerateDataKey` permission to the key in this property. For more information, see [Lambda rotation function execution role permissions for Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html).\nYou can specify `MasterSecretKmsKeyArn` or `SuperuserSecretKmsKeyArn` but not both. They represent the same superuser secret KMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-mastersecretkmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SuperuserSecretArn": { "MarkdownDocumentation": "`SuperuserSecretArn`\n\nThe ARN of the secret that contains superuser credentials, if you use the\n [Alternating users rotation strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users). CloudFormation grants the execution role for the Lambda rotation function `GetSecretValue` permission to the secret in this property. For more information, see [Lambda rotation function execution role permissions for Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html).\nYou must create the superuser secret before you can set this property.\nYou must also include the superuser secret ARN as a key in the JSON of the rotating secret so that the Lambda rotation function can find it. CloudFormation does not hardcode secret ARNs in the Lambda rotation function, so you can use the function to rotate multiple secrets. For more information, see [JSON structure of Secrets Manager secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html).\nYou can specify `MasterSecretArn` or `SuperuserSecretArn` but not both. They represent the same superuser 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-superusersecretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SuperuserSecretKmsKeyArn": { "MarkdownDocumentation": "`SuperuserSecretKmsKeyArn`\n\nThe ARN of the KMS key that Secrets Manager used to encrypt the superuser secret, if\nyou use the [alternating users strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users) and the superuser secret is encrypted with a customer managed key. You don't need to specify this property if the superuser secret is encrypted using the key `aws/secretsmanager`. CloudFormation grants the execution role for the Lambda rotation function `Decrypt`, `DescribeKey`, and `GenerateDataKey` permission to the key in this property. For more information, see [Lambda rotation function execution role permissions for Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html).\nYou can specify `MasterSecretKmsKeyArn` or `SuperuserSecretKmsKeyArn` but not both. They represent the same superuser secret KMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-superusersecretkmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSubnetIds": { "MarkdownDocumentation": "`VpcSubnetIds`\n\nA comma separated list of VPC subnet IDs of the target database network. The Lambda\nrotation function is in the same subnet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-hostedrotationlambda.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda-vpcsubnetids", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecretsManager::RotationSchedule.RotationRules": { "MarkdownDocumentation": "`AWS::SecretsManager::RotationSchedule.RotationRules`\n\nThe rotation schedule and window. We recommend you use `ScheduleExpression` to\nset a cron or rate expression for the schedule and `Duration` to set the length of\nthe rotation window.\n###### Important\nWhen changing an existing rotation schedule and setting\n`RotateImmediatelyOnUpdate` to `false`:\n* If using `AutomaticallyAfterDays` or a\n `ScheduleExpression` with `rate()`, the previously scheduled\n rotation might still occur.\n* To prevent unintended rotations, use a `ScheduleExpression` with\n `cron()` for granular control over rotation windows.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-rotationrules.html", "Properties": { "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nA `cron()` or `rate()` expression that defines the schedule for\nrotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.\nSecrets Manager `rate()` expressions represent the interval in hours or days that you\nwant to rotate your secret, for example `rate(12 hours)` or\n`rate(10 days)`. You can rotate a secret as often as every four hours. If you\nuse a `rate()` expression, the rotation\nwindow starts at midnight. For a rate in hours, the default rotation window closes after one\nhour. For a rate in days, the default rotation window closes at the end of the day. You can\nset the `Duration` to change the rotation window. The rotation window must not\nextend into the next UTC day or into the next rotation window.\nYou can use a `cron()` expression to create a rotation schedule that is\nmore detailed than a rotation interval. For more information, including examples, see\n[Schedule expressions in\nSecrets Manager rotation](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html) in the *Secrets Manager Users Guide*. For a cron expression\nthat represents a schedule in hours, the default rotation window closes after one hour. For\na cron expression that represents a schedule in days, the default rotation window closes at\nthe end of the day. You can set the `Duration` to change the rotation window. The\nrotation window must not extend into the next UTC day or into the next rotation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-rotationrules.html#cfn-secretsmanager-rotationschedule-rotationrules-scheduleexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Duration": { "MarkdownDocumentation": "`Duration`\n\nThe length of the rotation window in hours, for example `3h` for a three\nhour window. Secrets Manager rotates your secret at any time during this window. The window must not\nextend into the next rotation window or the next UTC day. The window starts according to the `ScheduleExpression`. If you don't specify a `Duration`,\nfor a `ScheduleExpression` in hours, the window automatically closes after one\nhour. For a `ScheduleExpression` in days, the window automatically closes at the\nend of the UTC day. For\nmore information, including examples, see [Schedule expressions\nin Secrets Manager rotation](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html) in the *Secrets Manager Users 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-rotationrules.html#cfn-secretsmanager-rotationschedule-rotationrules-duration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutomaticallyAfterDays": { "MarkdownDocumentation": "`AutomaticallyAfterDays`\n\nThe number of days between automatic scheduled rotations of the secret. You can use this\nvalue to check that your secret meets your compliance guidelines for how often secrets must\nbe rotated.\nIn `DescribeSecret` and `ListSecrets`, this value is calculated from\nthe rotation schedule after every successful rotation. In `RotateSecret`, you can\nset the rotation schedule in `RotationRules` with `AutomaticallyAfterDays`\nor `ScheduleExpression`, but not both.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-rotationschedule-rotationrules.html#cfn-secretsmanager-rotationschedule-rotationrules-automaticallyafterdays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SecretsManager::Secret.GenerateSecretString": { "MarkdownDocumentation": "`AWS::SecretsManager::Secret.GenerateSecretString`\n\nGenerates a random password. We recommend that you specify the maximum length and include\nevery character type that the system you are generating a password for can support.\n**Required permissions:** `secretsmanager:GetRandomPassword`. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control\nin Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html", "Properties": { "ExcludeUppercase": { "MarkdownDocumentation": "`ExcludeUppercase`\n\nSpecifies whether to exclude uppercase letters from the password. If you\ndon't include this switch, the password can contain uppercase letters.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludeuppercase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequireEachIncludedType": { "MarkdownDocumentation": "`RequireEachIncludedType`\n\nSpecifies whether to include at least one upper and lowercase letter, one number, and one punctuation.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-requireeachincludedtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IncludeSpace": { "MarkdownDocumentation": "`IncludeSpace`\n\nSpecifies whether to include the space character. If you\ninclude 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-includespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExcludeCharacters": { "MarkdownDocumentation": "`ExcludeCharacters`\n\nA string of the characters that you don't want in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludecharacters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GenerateStringKey": { "MarkdownDocumentation": "`GenerateStringKey`\n\nThe JSON key name for the key/value pair, where the value is the generated password. This\npair is added to the JSON structure specified by the `SecretStringTemplate`\nparameter. If you specify this parameter, then you must also specify\n`SecretStringTemplate`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-generatestringkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PasswordLength": { "MarkdownDocumentation": "`PasswordLength`\n\nThe length of the password. If you don't include this parameter, the\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-passwordlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ExcludePunctuation": { "MarkdownDocumentation": "`ExcludePunctuation`\n\nSpecifies whether to exclude the following punctuation characters from the password:\n`! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~`.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludepunctuation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExcludeLowercase": { "MarkdownDocumentation": "`ExcludeLowercase`\n\nSpecifies whether to exclude lowercase letters from the password. If\nyou don't include this switch, the password can contain lowercase letters.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludelowercase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SecretStringTemplate": { "MarkdownDocumentation": "`SecretStringTemplate`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-secretstringtemplate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExcludeNumbers": { "MarkdownDocumentation": "`ExcludeNumbers`\n\nSpecifies whether to exclude numbers from the password. If you don't\ninclude this switch, the password can contain numbers.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludenumbers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SecretsManager::Secret.ReplicaRegion": { "MarkdownDocumentation": "`AWS::SecretsManager::Secret.ReplicaRegion`\n\nSpecifies a `Region` and the `KmsKeyId` for a replica secret.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-replicaregion.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-replicaregion.html#cfn-secretsmanager-secret-replicaregion-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Region": { "MarkdownDocumentation": "`Region`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-replicaregion.html#cfn-secretsmanager-secret-replicaregion-region", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRule.AutomationRulesAction": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.AutomationRulesAction`\n\nOne or more actions that AWS Security Hub CSPM takes when a finding matches the defined criteria\nof a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesaction.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of action that Security Hub CSPM takes when a finding matches the defined criteria of a rule.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FINDING_FIELDS_UPDATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FINDING_FIELDS_UPDATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesaction.html#cfn-securityhub-automationrule-automationrulesaction-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FindingFieldsUpdate": { "MarkdownDocumentation": "`FindingFieldsUpdate`\n\nSpecifies that the automation rule action is an update to a finding field.\n*Required*: Yes\n*Type*: [AutomationRulesFindingFieldsUpdate](./aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesaction.html#cfn-securityhub-automationrule-automationrulesaction-findingfieldsupdate", "UpdateType": "Mutable", "Required": true, "Type": "AutomationRulesFindingFieldsUpdate" } } }, "AWS::SecurityHub::AutomationRule.AutomationRulesFindingFieldsUpdate": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.AutomationRulesFindingFieldsUpdate`\n\nIdentifies the finding fields that the automation rule action updates when a finding matches the defined criteria.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html", "Properties": { "Types": { "MarkdownDocumentation": "`Types`\n\nThe rule action updates the `Types` field of a finding.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-types", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Confidence": { "MarkdownDocumentation": "`Confidence`\n\nThe rule action updates the `Confidence` field of a finding.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-confidence", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Note": { "MarkdownDocumentation": "`Note`\n\nThe rule action will update the `Note` field of a finding.\n*Required*: No\n*Type*: [NoteUpdate](./aws-properties-securityhub-automationrule-noteupdate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-note", "UpdateType": "Mutable", "Required": false, "Type": "NoteUpdate" }, "VerificationState": { "MarkdownDocumentation": "`VerificationState`\n\nThe rule action updates the `VerificationState` field of a finding.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNKNOWN | TRUE_POSITIVE | F...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNKNOWN", "TRUE_POSITIVE", "FALSE_POSITIVE", "BENIGN_POSITIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-verificationstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RelatedFindings": { "MarkdownDocumentation": "`RelatedFindings`\n\nThe rule action will update the `RelatedFindings` field of a finding.\n*Required*: No\n*Type*: Array of [RelatedFinding](./aws-properties-securityhub-automationrule-relatedfinding.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-relatedfindings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RelatedFinding", "DuplicatesAllowed": true }, "Workflow": { "MarkdownDocumentation": "`Workflow`\n\nThe rule action will update the `Workflow` field of a finding.\n*Required*: No\n*Type*: [WorkflowUpdate](./aws-properties-securityhub-automationrule-workflowupdate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-workflow", "UpdateType": "Mutable", "Required": false, "Type": "WorkflowUpdate" }, "Severity": { "MarkdownDocumentation": "`Severity`\n\nThe rule action will update the `Severity` field of a finding.\n*Required*: No\n*Type*: [SeverityUpdate](./aws-properties-securityhub-automationrule-severityupdate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-severity", "UpdateType": "Mutable", "Required": false, "Type": "SeverityUpdate" }, "UserDefinedFields": { "MarkdownDocumentation": "`UserDefinedFields`\n\nThe rule action updates the `UserDefinedFields` field of a finding.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[-_+=.:/@\\w\\s]{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-userdefinedfields", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Criticality": { "MarkdownDocumentation": "`Criticality`\n\nThe rule action updates the `Criticality` field of a finding.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-criticality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SecurityHub::AutomationRule.AutomationRulesFindingFilters": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.AutomationRulesFindingFilters`\n\nThe criteria that determine which findings a rule applies to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html", "Properties": { "ProductArn": { "MarkdownDocumentation": "`ProductArn`\n\nThe Amazon Resource Name (ARN) for a third-party product that generated a finding in\nSecurity Hub CSPM.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-productarn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "SourceUrl": { "MarkdownDocumentation": "`SourceUrl`\n\nProvides a URL that links to a page about the current finding in the finding product.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-sourceurl", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ResourceDetailsOther": { "MarkdownDocumentation": "`ResourceDetailsOther`\n\nCustom fields and values about the resource that a finding pertains to.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [MapFilter](./aws-properties-securityhub-automationrule-mapfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcedetailsother", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MapFilter", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nA finding's description.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-description", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ProductName": { "MarkdownDocumentation": "`ProductName`\n\nProvides the name of the product that generated the finding. For\ncontrol-based findings, the product name is Security Hub CSPM.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-productname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nA list of AWS tags associated with a resource at the time the finding was processed.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [MapFilter](./aws-properties-securityhub-automationrule-mapfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MapFilter", "DuplicatesAllowed": true }, "FirstObservedAt": { "MarkdownDocumentation": "`FirstObservedAt`\n\nA timestamp that indicates when the potential security issue captured by a\nfinding was first observed by the security findings product.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-automationrule-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-firstobservedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nA timestamp that indicates when this finding record was created.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-automationrule-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-createdat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "NoteText": { "MarkdownDocumentation": "`NoteText`\n\nThe text of a user-defined note that's added to a finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-notetext", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "LastObservedAt": { "MarkdownDocumentation": "`LastObservedAt`\n\nA timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-automationrule-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-lastobservedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "UserDefinedFields": { "MarkdownDocumentation": "`UserDefinedFields`\n\nA list of user-defined name and value string pairs added to a finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [MapFilter](./aws-properties-securityhub-automationrule-mapfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-userdefinedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MapFilter", "DuplicatesAllowed": true }, "NoteUpdatedAt": { "MarkdownDocumentation": "`NoteUpdatedAt`\n\nThe timestamp of when the note was updated.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-automationrule-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-noteupdatedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "ComplianceSecurityControlId": { "MarkdownDocumentation": "`ComplianceSecurityControlId`\n\nThe security control ID for which a finding was generated. Security control IDs are the same across standards.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-compliancesecuritycontrolid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "CompanyName": { "MarkdownDocumentation": "`CompanyName`\n\nThe name of the company for the product that generated the finding.\nFor control-based findings, the company is AWS.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-companyname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ResourceRegion": { "MarkdownDocumentation": "`ResourceRegion`\n\nThe AWS Region where the resource that a finding pertains to is located.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourceregion", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "NoteUpdatedBy": { "MarkdownDocumentation": "`NoteUpdatedBy`\n\nThe principal that created a note.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-noteupdatedby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "Confidence": { "MarkdownDocumentation": "`Confidence`\n\nThe likelihood that a finding accurately identifies the behavior or issue that it was\nintended to identify. `Confidence` is scored on a 0\u2013100 basis using a ratio\nscale. A value of `0` means 0 percent confidence, and a value of\n`100` means 100 percent confidence. For example, a data exfiltration\ndetection based on a statistical deviation of network traffic has low confidence because an\nactual exfiltration hasn't been verified. For more information, see [Confidence](https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence) in the *AWS Security Hub CSPM User Guide*.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-automationrule-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-confidence", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": true }, "ResourcePartition": { "MarkdownDocumentation": "`ResourcePartition`\n\nThe partition in which the resource that the finding pertains to is located.\nA partition is a group of AWS Regions. Each AWS account is scoped to one partition.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcepartition", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "VerificationState": { "MarkdownDocumentation": "`VerificationState`\n\nProvides the veracity of a finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-verificationstate", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "Criticality": { "MarkdownDocumentation": "`Criticality`\n\nThe level of importance that is assigned to the resources that are associated with a\nfinding. `Criticality` is scored on a 0\u2013100 basis, using a ratio scale that supports\nonly full integers. A score of `0` means that the underlying resources have no\ncriticality, and a score of `100` is reserved for the most critical resources. For\nmore information, see [Criticality](https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality) in the *AWS Security Hub CSPM User Guide*.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-automationrule-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-criticality", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": true }, "SeverityLabel": { "MarkdownDocumentation": "`SeverityLabel`\n\nThe severity value of the finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-severitylabel", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "RelatedFindingsProductArn": { "MarkdownDocumentation": "`RelatedFindingsProductArn`\n\nThe ARN for the product that generated a related finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-relatedfindingsproductarn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ComplianceStatus": { "MarkdownDocumentation": "`ComplianceStatus`\n\nThe result of a security check. This field is only used for findings generated\nfrom controls.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-compliancestatus", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "GeneratorId": { "MarkdownDocumentation": "`GeneratorId`\n\nThe identifier for the solution-specific component that\ngenerated a finding.\nArray Members: Minimum number of 1 item. Maximum number of 100 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-generatorid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "RecordState": { "MarkdownDocumentation": "`RecordState`\n\nProvides the current state of a finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-recordstate", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "Title": { "MarkdownDocumentation": "`Title`\n\nA finding's title.\nArray Members: Minimum number of 1 item. Maximum number of 100 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-title", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nA finding's title.\nArray Members: Minimum number of 1 item. Maximum number of 100 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcetype", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ComplianceAssociatedStandardsId": { "MarkdownDocumentation": "`ComplianceAssociatedStandardsId`\n\nThe unique identifier of a standard in which a control is enabled. This field consists of the resource portion of\nthe Amazon Resource Name (ARN) returned for a standard in the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API response.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-complianceassociatedstandardsid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "UpdatedAt": { "MarkdownDocumentation": "`UpdatedAt`\n\nA timestamp that indicates when the finding record was most recently updated.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-automationrule-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-updatedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": true }, "RelatedFindingsId": { "MarkdownDocumentation": "`RelatedFindingsId`\n\nThe product-generated identifier for a related finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-relatedfindingsid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "WorkflowStatus": { "MarkdownDocumentation": "`WorkflowStatus`\n\nProvides information about the status of the investigation into a finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-workflowstatus", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nOne or more finding types in the format of namespace/category/classifier that classify\na finding. For a list of namespaces, classifiers, and categories, see [Types\ntaxonomy for ASFF](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html) in the *AWS Security Hub CSPM User Guide*.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-type", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe identifier for the given resource type. For AWS resources that are identified by\nAmazon Resource Names (ARNs), this is the ARN. For AWS resources that lack ARNs,\nthis is the identifier as defined by the AWS service that created the resource.\nFor non-AWS resources, this is a unique identifier that is associated with the\nresource.\nArray Members: Minimum number of 1 item. Maximum number of 100 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourceid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe AWS account ID in which a finding was generated.\nArray Members: Minimum number of 1 item. Maximum number of 100 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-awsaccountid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe product-specific identifier for a finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-automationrule-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-id", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": true } } }, "AWS::SecurityHub::AutomationRule.DateFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.DateFilter`\n\nA date filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html", "Properties": { "DateRange": { "MarkdownDocumentation": "`DateRange`\n\nA date range for the date filter.\n*Required*: No\n*Type*: [DateRange](./aws-properties-securityhub-automationrule-daterange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-daterange", "UpdateType": "Mutable", "Required": false, "Type": "DateRange" }, "Start": { "MarkdownDocumentation": "`Start`\n\nA timestamp that provides the start date for the date filter.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: String\n*Pattern*: `^(\\d\\d\\d\\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\\d)|[3][0-1])[T](?:([0-1](\\d)|[2][0-3]):[0-5](\\d):[0-5](\\d)|23:59:60)(?:\\.(\\d)+)?([Z]|[+-](\\d\\d)(:?(\\d\\d))?)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-start", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "End": { "MarkdownDocumentation": "`End`\n\nA timestamp that provides the end date for the date filter.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: String\n*Pattern*: `^(\\d\\d\\d\\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\\d)|[3][0-1])[T](?:([0-1](\\d)|[2][0-3]):[0-5](\\d):[0-5](\\d)|23:59:60)(?:\\.(\\d)+)?([Z]|[+-](\\d\\d)(:?(\\d\\d))?)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-end", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRule.DateRange": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.DateRange`\n\nA date range for the date filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nA date range value for the date filter.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.html#cfn-securityhub-automationrule-daterange-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nA date range unit for the date filter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DAYS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DAYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.html#cfn-securityhub-automationrule-daterange-unit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRule.MapFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.MapFilter`\n\nA map filter for filtering AWS Security Hub CSPM findings. Each map filter provides the field to check for, the\nvalue to check for, and the comparison operator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html", "Properties": { "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe condition to apply to the key value when filtering Security Hub CSPM findings with a map\nfilter.\nTo search for values that have the filter value, use one of the following comparison operators:\n* To search for values that include the filter value, use `CONTAINS`. For example, for the\n `ResourceTags` field, the filter `Department CONTAINS Security` matches findings that\n include the value `Security` for the `Department` tag. In the same example, a finding with a value of\n `Security team` for the `Department` tag is a match.\n* To search for values that exactly match the filter value, use `EQUALS`. For example, for\n the `ResourceTags` field, the filter `Department EQUALS Security` matches findings that\n have the value `Security` for the `Department` tag.\n`CONTAINS` and `EQUALS` filters on the same field are joined by `OR`. A\nfinding matches if it matches any one of those filters. For example, the filters `Department CONTAINS Security OR\nDepartment CONTAINS Finance` match a finding that includes either `Security`,\n`Finance`, or both values.\nTo search for values that don't have the filter value, use one of the following comparison operators:\n* To search for values that exclude the filter value, use `NOT_CONTAINS`. For example, for\n the `ResourceTags` field, the filter `Department NOT_CONTAINS Finance` matches findings\n that exclude the value `Finance` for the `Department` tag.\n* To search for values other than the filter value, use `NOT_EQUALS`. For example, for the\n `ResourceTags` field, the filter `Department NOT_EQUALS Finance` matches findings that\n don\u2019t have the value `Finance` for the `Department` tag.\n`NOT_CONTAINS` and `NOT_EQUALS` filters on the same field are joined by `AND`.\nA finding matches only if it matches all of those filters. For example, the filters `Department NOT_CONTAINS Security AND\nDepartment NOT_CONTAINS Finance` match a finding that excludes both the `Security` and\n`Finance` values.\n`CONTAINS` filters can only be used with other `CONTAINS` filters. `NOT_CONTAINS`\nfilters can only be used with other `NOT_CONTAINS` filters.\nYou can\u2019t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field.\nSimilarly, you can\u2019t have both an `EQUALS` filter and a `NOT_EQUALS` filter on the same field.\nCombining filters in this way returns an error.\n`CONTAINS` and `NOT_CONTAINS` operators can be used only with automation rules. For more information,\nsee [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *AWS Security Hub CSPM User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | NOT_EQUALS | CONTA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "NOT_EQUALS", "CONTAINS", "NOT_CONTAINS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-comparison", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the key in the map filter. Filter values are case sensitive. For example,\none of the values for a tag called `Department` might be `Security`.\nIf you provide `security` as the filter value, then there's no match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the map filter. For example, for `ResourceTags`, `Key`\nidentifies the name of the tag. For `UserDefinedFields`, `Key` is the\nname of the field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRule.NoteUpdate": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.NoteUpdate`\n\nThe updated note.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.html", "Properties": { "UpdatedBy": { "MarkdownDocumentation": "`UpdatedBy`\n\nThe principal that updated the note.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.html#cfn-securityhub-automationrule-noteupdate-updatedby", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Text": { "MarkdownDocumentation": "`Text`\n\nThe updated note text.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.html#cfn-securityhub-automationrule-noteupdate-text", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRule.NumberFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.NumberFilter`\n\nA number filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.html", "Properties": { "Gte": { "MarkdownDocumentation": "`Gte`\n\nThe greater-than-equal condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-gte", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Eq": { "MarkdownDocumentation": "`Eq`\n\nThe equal-to condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-eq", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Lte": { "MarkdownDocumentation": "`Lte`\n\nThe less-than-equal condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-lte", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::SecurityHub::AutomationRule.RelatedFinding": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.RelatedFinding`\n\nProvides details about a list of findings that the current finding relates to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html", "Properties": { "ProductArn": { "MarkdownDocumentation": "`ProductArn`\n\nThe Amazon Resource Name (ARN) for the product that generated a related finding.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso-?[a-z]{0,2}):[A-Za-z0-9]{1,63}:[a-z]+-([a-z]{1,10}-)?[a-z]+-[0-9]+:([0-9]{12})?:.+$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html#cfn-securityhub-automationrule-relatedfinding-productarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe product-generated identifier for a related finding.\nArray Members: Minimum number of 1 item. Maximum number of 20 items.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html#cfn-securityhub-automationrule-relatedfinding-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::SecurityHub::AutomationRule.SeverityUpdate": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.SeverityUpdate`\n\nUpdates to the severity information for a finding.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html", "Properties": { "Normalized": { "MarkdownDocumentation": "`Normalized`\n\nThe normalized severity for the finding. This attribute is to be deprecated in favor of\n`Label`.\nIf you provide `Normalized` and don't provide `Label`,\n`Label` is set automatically as follows.\n* 0 - `INFORMATIONAL`\n* 1\u201339 - `LOW`\n* 40\u201369 - `MEDIUM`\n* 70\u201389 - `HIGH`\n* 90\u2013100 - `CRITICAL`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-normalized", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Label": { "MarkdownDocumentation": "`Label`\n\nThe severity value of the finding. The allowed values are the following.\n* `INFORMATIONAL` - No issue was found.\n* `LOW` - The issue does not require action on its own.\n* `MEDIUM` - The issue must be addressed but not urgently.\n* `HIGH` - The issue must be addressed as a priority.\n* `CRITICAL` - The issue must be remediated immediately to avoid it\n escalating.\n*Required*: No\n*Type*: String\n*Allowed values*: `INFORMATIONAL | LOW | MEDIU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-label", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Product": { "MarkdownDocumentation": "`Product`\n\nThe native severity as defined by the AWS service or integrated partner product that\ngenerated the finding.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-product", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::SecurityHub::AutomationRule.StringFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.StringFilter`\n\nA string filter for filtering AWS Security Hub CSPM findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.html", "Properties": { "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe condition to apply to a string value when filtering Security Hub CSPM findings.\nTo search for values that have the filter value, use one of the following comparison operators:\n* To search for values that include the filter value, use `CONTAINS`. For example, the\n filter `Title CONTAINS CloudFront` matches findings that have a `Title` that\n includes the string CloudFront.\n* To search for values that exactly match the filter value, use `EQUALS`. For example,\n the filter `AwsAccountId EQUALS 123456789012` only matches findings that have an account ID of\n `123456789012`.\n* To search for values that start with the filter value, use `PREFIX`. For example, the\n filter `ResourceRegion PREFIX us` matches findings that have a `ResourceRegion` that starts\n with `us`. A `ResourceRegion` that starts with a different value, such as `af`,\n `ap`, or `ca`, doesn't match.\n`CONTAINS`, `EQUALS`, and `PREFIX` filters on the same field are joined by\n`OR`. A finding matches if it matches any one of those filters. For example, the filters `Title CONTAINS CloudFront OR\nTitle CONTAINS CloudWatch` match a finding that includes either `CloudFront`,\n`CloudWatch`, or both strings in the title.\nTo search for values that don\u2019t have the filter value, use one of the following comparison operators:\n* To search for values that exclude the filter value, use `NOT_CONTAINS`. For example, the\n filter `Title NOT_CONTAINS CloudFront` matches findings that have a `Title` that\n excludes the string CloudFront.\n* To search for values other than the filter value, use `NOT_EQUALS`. For\n example, the filter `AwsAccountId NOT_EQUALS 123456789012` only matches findings that have an account\n ID other than `123456789012`.\n* To search for values that don't start with the filter value, use `PREFIX_NOT_EQUALS`. For\n example, the filter `ResourceRegion PREFIX_NOT_EQUALS us` matches findings with a\n `ResourceRegion` that starts with a value other than `us`.\n`NOT_CONTAINS`, `NOT_EQUALS`, and `PREFIX_NOT_EQUALS` filters on the same field\nare joined by `AND`. A finding matches only if it matches all of those filters. For example, the filters `Title NOT_CONTAINS CloudFront AND\nTitle NOT_CONTAINS CloudWatch` match a finding that excludes both `CloudFront` and\n`CloudWatch` in the title.\nYou can\u2019t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field. Similarly,\nyou can't provide both an `EQUALS` filter and a `NOT_EQUALS` or\n`PREFIX_NOT_EQUALS` filter on the same field. Combining filters in this way returns an error. `CONTAINS` filters\ncan only be used with other `CONTAINS` filters. `NOT_CONTAINS` filters can only be used with\nother `NOT_CONTAINS` filters.\nYou can combine `PREFIX` filters with `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters for the same field.\nSecurity Hub CSPM first processes the `PREFIX` filters, and then the `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters.\nFor example, for the following filters, Security Hub CSPM first identifies findings that have resource types\nthat start with either `AwsIam` or `AwsEc2`. It then excludes findings that have a resource\ntype of `AwsIamPolicy` and findings that have a resource type of `AwsEc2NetworkInterface`.\n* `ResourceType PREFIX AwsIam`\n* `ResourceType PREFIX AwsEc2`\n* `ResourceType NOT_EQUALS AwsIamPolicy`\n* `ResourceType NOT_EQUALS AwsEc2NetworkInterface`\n`CONTAINS` and `NOT_CONTAINS` operators can be used only with automation rules V1.\n`CONTAINS_WORD` operator is only supported in `GetFindingsV2`, `GetFindingStatisticsV2`, `GetResourcesV2`, and `GetResourceStatisticsV2` APIs.\nFor more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *AWS Security Hub CSPM User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | PREFIX | 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)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "PREFIX", "NOT_EQUALS", "PREFIX_NOT_EQUALS", "CONTAINS", "NOT_CONTAINS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.html#cfn-securityhub-automationrule-stringfilter-comparison", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe string filter value. Filter values are case sensitive. For example, the product name\nfor control-based findings is `Security Hub CSPM`. If you provide `security hub`\nas the filter value, there's no match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.html#cfn-securityhub-automationrule-stringfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRule.WorkflowUpdate": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRule.WorkflowUpdate`\n\nUsed to update information about the investigation into the finding.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-workflowupdate.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to `SUPPRESSED` or `RESOLVED` does not prevent a new finding for the same issue.\nThe allowed values are the following.\n* `NEW` - The initial state of a finding, before it is reviewed.\n \n Security Hub CSPM also resets `WorkFlowStatus` from `NOTIFIED` or\n `RESOLVED` to `NEW` in the following cases:\n \n + The record state changes from `ARCHIVED` to\n `ACTIVE`.\n + The compliance status changes from `PASSED` to either\n `WARNING`, `FAILED`, or\n `NOT_AVAILABLE`.\n* `NOTIFIED` - Indicates that you notified the resource owner about the\n security issue. Used when the initial reviewer is not the resource owner, and needs\n intervention from the resource owner.\n* `RESOLVED` - The finding was reviewed and remediated and is now\n considered resolved.\n* `SUPPRESSED` - Indicates that you reviewed the finding and don't believe that any action is needed. The finding is no longer updated.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NEW | NOTIFIED | RESOLVED |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NEW", "NOTIFIED", "RESOLVED", "SUPPRESSED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-workflowupdate.html#cfn-securityhub-automationrule-workflowupdate-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.AutomationRulesActionV2": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.AutomationRulesActionV2`\n\nAllows you to configure automated responses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesactionv2.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of action that Security Hub CSPM takes when a finding matches the defined criteria of a rule.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FINDING_FIELDS_UPDATE | EXT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FINDING_FIELDS_UPDATE", "EXTERNAL_INTEGRATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesactionv2.html#cfn-securityhub-automationrulev2-automationrulesactionv2-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExternalIntegrationConfiguration": { "MarkdownDocumentation": "`ExternalIntegrationConfiguration`\n\nThe settings for integrating automation rule actions with external systems or service.\n*Required*: No\n*Type*: [ExternalIntegrationConfiguration](./aws-properties-securityhub-automationrulev2-externalintegrationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesactionv2.html#cfn-securityhub-automationrulev2-automationrulesactionv2-externalintegrationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExternalIntegrationConfiguration" }, "FindingFieldsUpdate": { "MarkdownDocumentation": "`FindingFieldsUpdate`\n\nSpecifies that the automation rule action is an update to a finding field.\n*Required*: No\n*Type*: [AutomationRulesFindingFieldsUpdateV2](./aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesactionv2.html#cfn-securityhub-automationrulev2-automationrulesactionv2-findingfieldsupdate", "UpdateType": "Mutable", "Required": false, "Type": "AutomationRulesFindingFieldsUpdateV2" } } }, "AWS::SecurityHub::AutomationRuleV2.AutomationRulesFindingFieldsUpdateV2": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.AutomationRulesFindingFieldsUpdateV2`\n\nAllows you to define the structure for modifying specific fields in security findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nNotes or contextual information for findings that are modified by the automation rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html#cfn-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusId": { "MarkdownDocumentation": "`StatusId`\n\nThe status to be applied to findings that match automation rule criteria.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html#cfn-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2-statusid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SeverityId": { "MarkdownDocumentation": "`SeverityId`\n\nThe severity level to be assigned to findings that match the automation rule criteria.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2.html#cfn-securityhub-automationrulev2-automationrulesfindingfieldsupdatev2-severityid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SecurityHub::AutomationRuleV2.BooleanFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.BooleanFilter`\n\nBoolean filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-booleanfilter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the boolean.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-booleanfilter.html#cfn-securityhub-automationrulev2-booleanfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::SecurityHub::AutomationRuleV2.CompositeFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.CompositeFilter`\n\nEnables the creation of filtering criteria for security findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html", "Properties": { "Operator": { "MarkdownDocumentation": "`Operator`\n\nThe logical operator used to combine multiple filter conditions.\n*Required*: No\n*Type*: String\n*Allowed values*: `AND | OR`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "AND", "OR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-operator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StringFilters": { "MarkdownDocumentation": "`StringFilters`\n\nEnables filtering based on string field values.\n*Required*: No\n*Type*: Array of [OcsfStringFilter](./aws-properties-securityhub-automationrulev2-ocsfstringfilter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-stringfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OcsfStringFilter", "DuplicatesAllowed": false }, "BooleanFilters": { "MarkdownDocumentation": "`BooleanFilters`\n\nEnables filtering based on boolean field values.\n*Required*: No\n*Type*: Array of [OcsfBooleanFilter](./aws-properties-securityhub-automationrulev2-ocsfbooleanfilter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-booleanfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OcsfBooleanFilter", "DuplicatesAllowed": false }, "DateFilters": { "MarkdownDocumentation": "`DateFilters`\n\nEnables filtering based on date and timestamp fields.\n*Required*: No\n*Type*: Array of [OcsfDateFilter](./aws-properties-securityhub-automationrulev2-ocsfdatefilter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-datefilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OcsfDateFilter", "DuplicatesAllowed": false }, "NumberFilters": { "MarkdownDocumentation": "`NumberFilters`\n\nEnables filtering based on numerical field values.\n*Required*: No\n*Type*: Array of [OcsfNumberFilter](./aws-properties-securityhub-automationrulev2-ocsfnumberfilter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-numberfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OcsfNumberFilter", "DuplicatesAllowed": false }, "MapFilters": { "MarkdownDocumentation": "`MapFilters`\n\nEnables the creation of filtering criteria for security findings.\n*Required*: No\n*Type*: Array of [OcsfMapFilter](./aws-properties-securityhub-automationrulev2-ocsfmapfilter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-compositefilter.html#cfn-securityhub-automationrulev2-compositefilter-mapfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OcsfMapFilter", "DuplicatesAllowed": true } } }, "AWS::SecurityHub::AutomationRuleV2.Criteria": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.Criteria`\n\nThe filtering type and configuration of the automation rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-criteria.html", "Properties": { "OcsfFindingCriteria": { "MarkdownDocumentation": "`OcsfFindingCriteria`\n\nThe filtering conditions that align with OCSF standards.\n*Required*: No\n*Type*: [OcsfFindingFilters](./aws-properties-securityhub-automationrulev2-ocsffindingfilters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-criteria.html#cfn-securityhub-automationrulev2-criteria-ocsffindingcriteria", "UpdateType": "Mutable", "Required": false, "Type": "OcsfFindingFilters" } } }, "AWS::SecurityHub::AutomationRuleV2.DateFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.DateFilter`\n\nA date filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-datefilter.html", "Properties": { "DateRange": { "MarkdownDocumentation": "`DateRange`\n\nA date range for the date filter.\n*Required*: No\n*Type*: [DateRange](./aws-properties-securityhub-automationrulev2-daterange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-datefilter.html#cfn-securityhub-automationrulev2-datefilter-daterange", "UpdateType": "Mutable", "Required": false, "Type": "DateRange" }, "Start": { "MarkdownDocumentation": "`Start`\n\nA timestamp that provides the start date for the date filter.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: String\n*Pattern*: `^(\\d\\d\\d\\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\\d)|[3][0-1])[T](?:([0-1](\\d)|[2][0-3]):[0-5](\\d):[0-5](\\d)|23:59:60)(?:\\.(\\d)+)?([Z]|[+-](\\d\\d)(:?(\\d\\d))?)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-datefilter.html#cfn-securityhub-automationrulev2-datefilter-start", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "End": { "MarkdownDocumentation": "`End`\n\nA timestamp that provides the end date for the date filter.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: String\n*Pattern*: `^(\\d\\d\\d\\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\\d)|[3][0-1])[T](?:([0-1](\\d)|[2][0-3]):[0-5](\\d):[0-5](\\d)|23:59:60)(?:\\.(\\d)+)?([Z]|[+-](\\d\\d)(:?(\\d\\d))?)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-datefilter.html#cfn-securityhub-automationrulev2-datefilter-end", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.DateRange": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.DateRange`\n\nA date range for the date filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-daterange.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nA date range value for the date filter.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-daterange.html#cfn-securityhub-automationrulev2-daterange-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nA date range unit for the date filter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DAYS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DAYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-daterange.html#cfn-securityhub-automationrulev2-daterange-unit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.ExternalIntegrationConfiguration": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.ExternalIntegrationConfiguration`\n\nThe settings for integrating automation rule actions with external systems or service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-externalintegrationconfiguration.html", "Properties": { "ConnectorArn": { "MarkdownDocumentation": "`ConnectorArn`\n\nThe ARN of the connector that establishes the integration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-externalintegrationconfiguration.html#cfn-securityhub-automationrulev2-externalintegrationconfiguration-connectorarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.MapFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.MapFilter`\n\nA map filter for filtering AWS Security Hub CSPM findings. Each map filter provides the field to check for, the\nvalue to check for, and the comparison operator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-mapfilter.html", "Properties": { "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe condition to apply to the key value when filtering Security Hub CSPM findings with a map\nfilter.\nTo search for values that have the filter value, use one of the following comparison operators:\n* To search for values that include the filter value, use `CONTAINS`. For example, for the\n `ResourceTags` field, the filter `Department CONTAINS Security` matches findings that\n include the value `Security` for the `Department` tag. In the same example, a finding with a value of\n `Security team` for the `Department` tag is a match.\n* To search for values that exactly match the filter value, use `EQUALS`. For example, for\n the `ResourceTags` field, the filter `Department EQUALS Security` matches findings that\n have the value `Security` for the `Department` tag.\n`CONTAINS` and `EQUALS` filters on the same field are joined by `OR`. A\nfinding matches if it matches any one of those filters. For example, the filters `Department CONTAINS Security OR\nDepartment CONTAINS Finance` match a finding that includes either `Security`,\n`Finance`, or both values.\nTo search for values that don't have the filter value, use one of the following comparison operators:\n* To search for values that exclude the filter value, use `NOT_CONTAINS`. For example, for\n the `ResourceTags` field, the filter `Department NOT_CONTAINS Finance` matches findings\n that exclude the value `Finance` for the `Department` tag.\n* To search for values other than the filter value, use `NOT_EQUALS`. For example, for the\n `ResourceTags` field, the filter `Department NOT_EQUALS Finance` matches findings that\n don\u2019t have the value `Finance` for the `Department` tag.\n`NOT_CONTAINS` and `NOT_EQUALS` filters on the same field are joined by `AND`.\nA finding matches only if it matches all of those filters. For example, the filters `Department NOT_CONTAINS Security AND\nDepartment NOT_CONTAINS Finance` match a finding that excludes both the `Security` and\n`Finance` values.\n`CONTAINS` filters can only be used with other `CONTAINS` filters. `NOT_CONTAINS`\nfilters can only be used with other `NOT_CONTAINS` filters.\nYou can\u2019t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field.\nSimilarly, you can\u2019t have both an `EQUALS` filter and a `NOT_EQUALS` filter on the same field.\nCombining filters in this way returns an error.\n`CONTAINS` and `NOT_CONTAINS` operators can be used only with automation rules. For more information,\nsee [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *AWS Security Hub CSPM User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | NOT_EQUALS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "NOT_EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-mapfilter.html#cfn-securityhub-automationrulev2-mapfilter-comparison", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the key in the map filter. Filter values are case sensitive. For example,\none of the values for a tag called `Department` might be `Security`.\nIf you provide `security` as the filter value, then there's no match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-mapfilter.html#cfn-securityhub-automationrulev2-mapfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the map filter. For example, for `ResourceTags`, `Key`\nidentifies the name of the tag. For `UserDefinedFields`, `Key` is the\nname of the field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-mapfilter.html#cfn-securityhub-automationrulev2-mapfilter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.NumberFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.NumberFilter`\n\nA number filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-numberfilter.html", "Properties": { "Gte": { "MarkdownDocumentation": "`Gte`\n\nThe greater-than-equal condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-numberfilter.html#cfn-securityhub-automationrulev2-numberfilter-gte", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Eq": { "MarkdownDocumentation": "`Eq`\n\nThe equal-to condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-numberfilter.html#cfn-securityhub-automationrulev2-numberfilter-eq", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Lte": { "MarkdownDocumentation": "`Lte`\n\nThe less-than-equal condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-numberfilter.html#cfn-securityhub-automationrulev2-numberfilter-lte", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::SecurityHub::AutomationRuleV2.OcsfBooleanFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.OcsfBooleanFilter`\n\nEnables filtering of security findings based on boolean field values in OCSF.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfbooleanfilter.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nEnables filtering of security findings based on boolean field values in OCSF.\n*Required*: Yes\n*Type*: [BooleanFilter](./aws-properties-securityhub-automationrulev2-booleanfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfbooleanfilter.html#cfn-securityhub-automationrulev2-ocsfbooleanfilter-filter", "UpdateType": "Mutable", "Required": true, "Type": "BooleanFilter" }, "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `compliance.assessments.meet...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "compliance.assessments.meets_criteria", "vulnerabilities.is_exploit_available", "vulnerabilities.is_fix_available" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfbooleanfilter.html#cfn-securityhub-automationrulev2-ocsfbooleanfilter-fieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.OcsfDateFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.OcsfDateFilter`\n\nEnables filtering of security findings based on date and timestamp fields in OCSF.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfdatefilter.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nEnables filtering of security findings based on date and timestamp fields in OCSF.\n*Required*: Yes\n*Type*: [DateFilter](./aws-properties-securityhub-automationrulev2-datefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfdatefilter.html#cfn-securityhub-automationrulev2-ocsfdatefilter-filter", "UpdateType": "Mutable", "Required": true, "Type": "DateFilter" }, "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `finding_info.created_time_d...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "finding_info.created_time_dt", "finding_info.first_seen_time_dt", "finding_info.last_seen_time_dt", "finding_info.modified_time_dt" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfdatefilter.html#cfn-securityhub-automationrulev2-ocsfdatefilter-fieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.OcsfFindingFilters": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.OcsfFindingFilters`\n\nSpecifies the filtering criteria for security findings using OCSF.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsffindingfilters.html", "Properties": { "CompositeFilters": { "MarkdownDocumentation": "`CompositeFilters`\n\nEnables the creation of complex filtering conditions by combining filter criteria.\n*Required*: No\n*Type*: Array of [CompositeFilter](./aws-properties-securityhub-automationrulev2-compositefilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsffindingfilters.html#cfn-securityhub-automationrulev2-ocsffindingfilters-compositefilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CompositeFilter", "DuplicatesAllowed": false }, "CompositeOperator": { "MarkdownDocumentation": "`CompositeOperator`\n\nThe logical operators used to combine the filtering on multiple `CompositeFilters`.\n*Required*: No\n*Type*: String\n*Allowed values*: `AND | OR`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "AND", "OR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsffindingfilters.html#cfn-securityhub-automationrulev2-ocsffindingfilters-compositeoperator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.OcsfMapFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.OcsfMapFilter`\n\nEnables filtering of security findings based on map field values in OCSF.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfmapfilter.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nEnables filtering of security findings based on map field values in OCSF.\n*Required*: Yes\n*Type*: [MapFilter](./aws-properties-securityhub-automationrulev2-mapfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfmapfilter.html#cfn-securityhub-automationrulev2-ocsfmapfilter-filter", "UpdateType": "Mutable", "Required": true, "Type": "MapFilter" }, "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `resources.tags...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "resources.tags" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfmapfilter.html#cfn-securityhub-automationrulev2-ocsfmapfilter-fieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.OcsfNumberFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.OcsfNumberFilter`\n\nEnables filtering of security findings based on numerical field values in OCSF.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfnumberfilter.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nEnables filtering of security findings based on numerical field values in OCSF.\n*Required*: Yes\n*Type*: [NumberFilter](./aws-properties-securityhub-automationrulev2-numberfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfnumberfilter.html#cfn-securityhub-automationrulev2-ocsfnumberfilter-filter", "UpdateType": "Mutable", "Required": true, "Type": "NumberFilter" }, "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `activity_id | compliance.st...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "activity_id", "compliance.status_id", "confidence_score", "finding_info.related_events_count", "vendor_attributes.severity_id" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfnumberfilter.html#cfn-securityhub-automationrulev2-ocsfnumberfilter-fieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.OcsfStringFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.OcsfStringFilter`\n\nEnables filtering of security findings based on string field values in OCSF.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfstringfilter.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nEnables filtering of security findings based on string field values in OCSF.\n*Required*: Yes\n*Type*: [StringFilter](./aws-properties-securityhub-automationrulev2-stringfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfstringfilter.html#cfn-securityhub-automationrulev2-ocsfstringfilter-filter", "UpdateType": "Mutable", "Required": true, "Type": "StringFilter" }, "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe name of the field.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `activity_name | cloud.accou...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "activity_name", "cloud.account.name", "cloud.account.uid", "cloud.provider", "cloud.region", "compliance.assessments.category", "compliance.assessments.name", "compliance.control", "compliance.status", "compliance.standards", "finding_info.desc", "finding_info.src_url", "finding_info.title", "finding_info.types", "finding_info.uid", "finding_info.related_events.uid", "finding_info.related_events.product.uid", "finding_info.related_events.title", "metadata.product.feature.uid", "metadata.product.name", "metadata.product.uid", "metadata.product.vendor_name", "remediation.desc", "remediation.references", "resources.cloud_partition", "resources.name", "resources.region", "resources.type", "resources.uid", "vulnerabilities.fix_coverage", "class_name", "vendor_attributes.severity" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-ocsfstringfilter.html#cfn-securityhub-automationrulev2-ocsfstringfilter-fieldname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::AutomationRuleV2.StringFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::AutomationRuleV2.StringFilter`\n\nA string filter for filtering AWS Security Hub CSPM findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-stringfilter.html", "Properties": { "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe condition to apply to a string value when filtering Security Hub CSPM findings.\nTo search for values that have the filter value, use one of the following comparison operators:\n* To search for values that include the filter value, use `CONTAINS`. For example, the\n filter `Title CONTAINS CloudFront` matches findings that have a `Title` that\n includes the string CloudFront.\n* To search for values that exactly match the filter value, use `EQUALS`. For example,\n the filter `AwsAccountId EQUALS 123456789012` only matches findings that have an account ID of\n `123456789012`.\n* To search for values that start with the filter value, use `PREFIX`. For example, the\n filter `ResourceRegion PREFIX us` matches findings that have a `ResourceRegion` that starts\n with `us`. A `ResourceRegion` that starts with a different value, such as `af`,\n `ap`, or `ca`, doesn't match.\n`CONTAINS`, `EQUALS`, and `PREFIX` filters on the same field are joined by\n`OR`. A finding matches if it matches any one of those filters. For example, the filters `Title CONTAINS CloudFront OR\nTitle CONTAINS CloudWatch` match a finding that includes either `CloudFront`,\n`CloudWatch`, or both strings in the title.\nTo search for values that don\u2019t have the filter value, use one of the following comparison operators:\n* To search for values that exclude the filter value, use `NOT_CONTAINS`. For example, the\n filter `Title NOT_CONTAINS CloudFront` matches findings that have a `Title` that\n excludes the string CloudFront.\n* To search for values other than the filter value, use `NOT_EQUALS`. For\n example, the filter `AwsAccountId NOT_EQUALS 123456789012` only matches findings that have an account\n ID other than `123456789012`.\n* To search for values that don't start with the filter value, use `PREFIX_NOT_EQUALS`. For\n example, the filter `ResourceRegion PREFIX_NOT_EQUALS us` matches findings with a\n `ResourceRegion` that starts with a value other than `us`.\n`NOT_CONTAINS`, `NOT_EQUALS`, and `PREFIX_NOT_EQUALS` filters on the same field\nare joined by `AND`. A finding matches only if it matches all of those filters. For example, the filters `Title NOT_CONTAINS CloudFront AND\nTitle NOT_CONTAINS CloudWatch` match a finding that excludes both `CloudFront` and\n`CloudWatch` in the title.\nYou can\u2019t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field. Similarly,\nyou can't provide both an `EQUALS` filter and a `NOT_EQUALS` or\n`PREFIX_NOT_EQUALS` filter on the same field. Combining filters in this way returns an error. `CONTAINS` filters\ncan only be used with other `CONTAINS` filters. `NOT_CONTAINS` filters can only be used with\nother `NOT_CONTAINS` filters.\nYou can combine `PREFIX` filters with `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters for the same field.\nSecurity Hub CSPM first processes the `PREFIX` filters, and then the `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters.\nFor example, for the following filters, Security Hub CSPM first identifies findings that have resource types\nthat start with either `AwsIam` or `AwsEc2`. It then excludes findings that have a resource\ntype of `AwsIamPolicy` and findings that have a resource type of `AwsEc2NetworkInterface`.\n* `ResourceType PREFIX AwsIam`\n* `ResourceType PREFIX AwsEc2`\n* `ResourceType NOT_EQUALS AwsIamPolicy`\n* `ResourceType NOT_EQUALS AwsEc2NetworkInterface`\n`CONTAINS` and `NOT_CONTAINS` operators can be used only with automation rules V1.\n`CONTAINS_WORD` operator is only supported in `GetFindingsV2`, `GetFindingStatisticsV2`, `GetResourcesV2`, and `GetResourceStatisticsV2` APIs.\nFor more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *AWS Security Hub CSPM User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | PREFIX | 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)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "PREFIX", "NOT_EQUALS", "PREFIX_NOT_EQUALS", "CONTAINS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-stringfilter.html#cfn-securityhub-automationrulev2-stringfilter-comparison", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe string filter value. Filter values are case sensitive. For example, the product name\nfor control-based findings is `Security Hub CSPM`. If you provide `security hub`\nas the filter value, there's no match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrulev2-stringfilter.html#cfn-securityhub-automationrulev2-stringfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::ConfigurationPolicy.ParameterConfiguration": { "MarkdownDocumentation": "`AWS::SecurityHub::ConfigurationPolicy.ParameterConfiguration`\n\nAn object that provides the current value of a security control parameter and identifies whether it has been customized.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parameterconfiguration.html", "Properties": { "ValueType": { "MarkdownDocumentation": "`ValueType`\n\nIdentifies whether a control parameter uses a custom user-defined value or subscribes to the default\nAWS Security Hub CSPM behavior.\nWhen `ValueType` is set equal to `DEFAULT`, the default\nbehavior can be a specific Security Hub CSPM default value, or the default behavior can be to ignore a specific parameter.\nWhen `ValueType` is set equal to `DEFAULT`, Security Hub CSPM ignores user-provided input for\nthe `Value` field.\nWhen `ValueType` is set equal to `CUSTOM`, the `Value` field can't be empty.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEFAULT | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parameterconfiguration.html#cfn-securityhub-configurationpolicy-parameterconfiguration-valuetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe current value of a control parameter.\n*Required*: No\n*Type*: [ParameterValue](./aws-properties-securityhub-configurationpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parameterconfiguration.html#cfn-securityhub-configurationpolicy-parameterconfiguration-value", "UpdateType": "Mutable", "Required": false, "Type": "ParameterValue" } } }, "AWS::SecurityHub::ConfigurationPolicy.ParameterValue": { "MarkdownDocumentation": "`AWS::SecurityHub::ConfigurationPolicy.ParameterValue`\n\nAn object that includes the data type of a security control parameter and its current value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html", "Properties": { "Enum": { "MarkdownDocumentation": "`Enum`\n\nA control parameter that is an enum.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-enum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Integer": { "MarkdownDocumentation": "`Integer`\n\nA control parameter that is an integer.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-integer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StringList": { "MarkdownDocumentation": "`StringList`\n\nA control parameter that is a list of strings.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-stringlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EnumList": { "MarkdownDocumentation": "`EnumList`\n\nA control parameter that is a list of enums.\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-enumlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "IntegerList": { "MarkdownDocumentation": "`IntegerList`\n\nA control parameter that is a list of integers.\n*Required*: No\n*Type*: Array of Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-integerlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": false }, "String": { "MarkdownDocumentation": "`String`\n\nA control parameter that is a string.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-string", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Boolean": { "MarkdownDocumentation": "`Boolean`\n\nA control parameter that is a boolean.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-boolean", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Double": { "MarkdownDocumentation": "`Double`\n\nA control parameter that is a double.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-double", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::SecurityHub::ConfigurationPolicy.Policy": { "MarkdownDocumentation": "`AWS::SecurityHub::ConfigurationPolicy.Policy`\n\nAn object that defines how AWS Security Hub CSPM is configured. It includes whether Security Hub CSPM is\nenabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls.\nIf you provide a list of security controls that are enabled in the configuration policy, Security Hub CSPM\ndisables all other controls (including newly released controls). If you provide a list of security controls that\nare disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly\nreleased controls).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-policy.html", "Properties": { "SecurityHub": { "MarkdownDocumentation": "`SecurityHub`\n\nThe AWS service that the configuration policy applies to.\n*Required*: No\n*Type*: [SecurityHubPolicy](./aws-properties-securityhub-configurationpolicy-securityhubpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-policy.html#cfn-securityhub-configurationpolicy-policy-securityhub", "UpdateType": "Mutable", "Required": false, "Type": "SecurityHubPolicy" } } }, "AWS::SecurityHub::ConfigurationPolicy.SecurityControlCustomParameter": { "MarkdownDocumentation": "`AWS::SecurityHub::ConfigurationPolicy.SecurityControlCustomParameter`\n\nA list of security controls and control parameter values that are included in a configuration policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolcustomparameter.html", "Properties": { "SecurityControlId": { "MarkdownDocumentation": "`SecurityControlId`\n\nThe ID of the security control.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolcustomparameter.html#cfn-securityhub-configurationpolicy-securitycontrolcustomparameter-securitycontrolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nAn object that specifies parameter values for a control in a configuration policy.\n*Required*: No\n*Type*: Object of [ParameterConfiguration](./aws-properties-securityhub-configurationpolicy-parameterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolcustomparameter.html#cfn-securityhub-configurationpolicy-securitycontrolcustomparameter-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ParameterConfiguration" } } }, "AWS::SecurityHub::ConfigurationPolicy.SecurityControlsConfiguration": { "MarkdownDocumentation": "`AWS::SecurityHub::ConfigurationPolicy.SecurityControlsConfiguration`\n\nAn object that defines which security controls are enabled in an AWS Security Hub CSPM configuration policy.\nThe enablement status of a control is aligned across all of the enabled standards in an account.\nThis property is required only if `ServiceEnabled` is set to `true` in your configuration policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.html", "Properties": { "DisabledSecurityControlIdentifiers": { "MarkdownDocumentation": "`DisabledSecurityControlIdentifiers`\n\nA list of security controls that are disabled in the configuration policy.\nProvide only one of `EnabledSecurityControlIdentifiers` or\n`DisabledSecurityControlIdentifiers`.\nIf you provide `DisabledSecurityControlIdentifiers`, Security Hub CSPM enables all other controls not in\nthe list, and enables\n[AutoEnableControls](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_UpdateSecurityHubConfiguration.html#securityhub-UpdateSecurityHubConfiguration-request-AutoEnableControls).\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048 | 1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.html#cfn-securityhub-configurationpolicy-securitycontrolsconfiguration-disabledsecuritycontrolidentifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EnabledSecurityControlIdentifiers": { "MarkdownDocumentation": "`EnabledSecurityControlIdentifiers`\n\nA list of security controls that are enabled in the configuration policy.\nProvide only one of `EnabledSecurityControlIdentifiers` or\n`DisabledSecurityControlIdentifiers`.\nIf you provide `EnabledSecurityControlIdentifiers`, Security Hub CSPM disables all other controls not in\nthe list, and disables\n[AutoEnableControls](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_UpdateSecurityHubConfiguration.html#securityhub-UpdateSecurityHubConfiguration-request-AutoEnableControls).\n*Required*: No\n*Type*: Array of String\n*Maximum*: `2048 | 1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.html#cfn-securityhub-configurationpolicy-securitycontrolsconfiguration-enabledsecuritycontrolidentifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SecurityControlCustomParameters": { "MarkdownDocumentation": "`SecurityControlCustomParameters`\n\nA list of security controls and control parameter values that are included in a configuration policy.\n*Required*: No\n*Type*: Array of [SecurityControlCustomParameter](./aws-properties-securityhub-configurationpolicy-securitycontrolcustomparameter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.html#cfn-securityhub-configurationpolicy-securitycontrolsconfiguration-securitycontrolcustomparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SecurityControlCustomParameter", "DuplicatesAllowed": false } } }, "AWS::SecurityHub::ConfigurationPolicy.SecurityHubPolicy": { "MarkdownDocumentation": "`AWS::SecurityHub::ConfigurationPolicy.SecurityHubPolicy`\n\nAn object that defines how AWS Security Hub CSPM is configured. The configuration policy includes whether\nSecurity Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or\ndisabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration\npolicy, Security Hub CSPM disables all other controls (including newly released controls). If you provide a\nlist of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other\ncontrols (including newly released controls).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securityhubpolicy.html", "Properties": { "EnabledStandardIdentifiers": { "MarkdownDocumentation": "`EnabledStandardIdentifiers`\n\nA list that defines which security standards are enabled in the configuration policy.\nThis property is required only if `ServiceEnabled` is set to `true` in your configuration policy.\n*Required*: Conditional\n*Type*: Array of String\n*Maximum*: `2048 | 1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securityhubpolicy.html#cfn-securityhub-configurationpolicy-securityhubpolicy-enabledstandardidentifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ServiceEnabled": { "MarkdownDocumentation": "`ServiceEnabled`\n\nIndicates whether Security Hub CSPM is enabled in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securityhubpolicy.html#cfn-securityhub-configurationpolicy-securityhubpolicy-serviceenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SecurityControlsConfiguration": { "MarkdownDocumentation": "`SecurityControlsConfiguration`\n\nAn object that defines which security controls are enabled in the configuration policy. The enablement status\nof a control is aligned across all of the enabled standards in an account.\nThis property is required only if `ServiceEnabled` is set to true in your configuration policy.\n*Required*: Conditional\n*Type*: [SecurityControlsConfiguration](./aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securityhubpolicy.html#cfn-securityhub-configurationpolicy-securityhubpolicy-securitycontrolsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SecurityControlsConfiguration" } } }, "AWS::SecurityHub::ConnectorV2.JiraCloudProviderConfiguration": { "MarkdownDocumentation": "`AWS::SecurityHub::ConnectorV2.JiraCloudProviderConfiguration`\n\nThe initial configuration settings required to establish an integration between Security Hub CSPM and Jira Cloud.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-jiracloudproviderconfiguration.html", "Properties": { "ProjectKey": { "MarkdownDocumentation": "`ProjectKey`\n\nThe project key for a JiraCloud instance.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-jiracloudproviderconfiguration.html#cfn-securityhub-connectorv2-jiracloudproviderconfiguration-projectkey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::ConnectorV2.Provider": { "MarkdownDocumentation": "`AWS::SecurityHub::ConnectorV2.Provider`\n\nThe third-party provider detail for a service configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-provider.html", "Properties": { "ServiceNow": { "MarkdownDocumentation": "`ServiceNow`\n\nDetails about a ServiceNow ITSM integration.\n*Required*: No\n*Type*: [ServiceNowProviderConfiguration](./aws-properties-securityhub-connectorv2-servicenowproviderconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-provider.html#cfn-securityhub-connectorv2-provider-servicenow", "UpdateType": "Mutable", "Required": false, "Type": "ServiceNowProviderConfiguration" }, "JiraCloud": { "MarkdownDocumentation": "`JiraCloud`\n\nDetails about a Jira Cloud integration.\n*Required*: No\n*Type*: [JiraCloudProviderConfiguration](./aws-properties-securityhub-connectorv2-jiracloudproviderconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-provider.html#cfn-securityhub-connectorv2-provider-jiracloud", "UpdateType": "Mutable", "Required": false, "Type": "JiraCloudProviderConfiguration" } } }, "AWS::SecurityHub::ConnectorV2.ServiceNowProviderConfiguration": { "MarkdownDocumentation": "`AWS::SecurityHub::ConnectorV2.ServiceNowProviderConfiguration`\n\nThe initial configuration settings required to establish an integration between Security Hub CSPM and ServiceNow ITSM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-servicenowproviderconfiguration.html", "Properties": { "InstanceName": { "MarkdownDocumentation": "`InstanceName`\n\nThe instance name of ServiceNow ITSM.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-servicenowproviderconfiguration.html#cfn-securityhub-connectorv2-servicenowproviderconfiguration-instancename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecretArn": { "MarkdownDocumentation": "`SecretArn`\n\nThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the ServiceNow credentials.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connectorv2-servicenowproviderconfiguration.html#cfn-securityhub-connectorv2-servicenowproviderconfiguration-secretarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::Insight.AwsSecurityFindingFilters": { "MarkdownDocumentation": "`AWS::SecurityHub::Insight.AwsSecurityFindingFilters`\n\nA collection of filters that are applied to all active findings aggregated by AWS Security Hub CSPM.\nYou can filter by up to ten finding attributes. For each attribute, you can provide up to\n20 filter values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html", "Properties": { "ResourceAwsEc2InstanceIamInstanceProfileArn": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceIamInstanceProfileArn`\n\nThe IAM profile ARN of the instance.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instanceiaminstanceprofilearn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "SourceUrl": { "MarkdownDocumentation": "`SourceUrl`\n\nA URL that links to a page about the current finding in the security findings provider's\nsolution.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-sourceurl", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ProcessName": { "MarkdownDocumentation": "`ProcessName`\n\nThe name of the process.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-processname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "FindingProviderFieldsConfidence": { "MarkdownDocumentation": "`FindingProviderFieldsConfidence`\n\nThe finding provider value for the finding confidence. Confidence is defined as the likelihood\nthat a finding accurately identifies the behavior or issue that it was intended to\nidentify.\nConfidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\nconfidence and 100 means 100 percent confidence.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-insight-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-findingproviderfieldsconfidence", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": false }, "FirstObservedAt": { "MarkdownDocumentation": "`FirstObservedAt`\n\nA timestamp that indicates when the security findings provider first\nobserved the potential security issue that a finding captured.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-firstobservedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nA timestamp that indicates when the security findings provider\ncreated the potential security issue that a finding reflects.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-createdat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "MalwareState": { "MarkdownDocumentation": "`MalwareState`\n\nThe state of the malware that was observed.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-malwarestate", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "UserDefinedFields": { "MarkdownDocumentation": "`UserDefinedFields`\n\nA list of name/value string pairs associated with the finding. These are custom,\nuser-defined fields added to a finding.\n*Required*: No\n*Type*: Array of [MapFilter](./aws-properties-securityhub-insight-mapfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-userdefinedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MapFilter", "DuplicatesAllowed": false }, "NetworkSourcePort": { "MarkdownDocumentation": "`NetworkSourcePort`\n\nThe source port of network-related information about a finding.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-insight-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networksourceport", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": false }, "ResourceAwsIamUserUserName": { "MarkdownDocumentation": "`ResourceAwsIamUserUserName`\n\nThe name of an IAM user.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsiamuserusername", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkSourceDomain": { "MarkdownDocumentation": "`NetworkSourceDomain`\n\nThe source domain of network-related information about a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networksourcedomain", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourcePartition": { "MarkdownDocumentation": "`ResourcePartition`\n\nThe canonical AWS partition name that the Region is assigned to.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourcepartition", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "FindingProviderFieldsRelatedFindingsId": { "MarkdownDocumentation": "`FindingProviderFieldsRelatedFindingsId`\n\nThe finding identifier of a related finding that is identified by the finding provider.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-findingproviderfieldsrelatedfindingsid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkDirection": { "MarkdownDocumentation": "`NetworkDirection`\n\nIndicates the direction of network traffic associated with a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networkdirection", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "Criticality": { "MarkdownDocumentation": "`Criticality`\n\nThe level of importance assigned to the resources associated with the finding.\nA score of 0 means that the underlying resources have no criticality, and a score of 100\nis reserved for the most critical resources.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-insight-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-criticality", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": false }, "ResourceApplicationArn": { "MarkdownDocumentation": "`ResourceApplicationArn`\n\nThe ARN of the application that is related to a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceapplicationarn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ComplianceSecurityControlParametersValue": { "MarkdownDocumentation": "`ComplianceSecurityControlParametersValue`\n\nThe current value of a security control parameter.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-compliancesecuritycontrolparametersvalue", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "SeverityLabel": { "MarkdownDocumentation": "`SeverityLabel`\n\nThe label of a finding's severity.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-severitylabel", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "RelatedFindingsProductArn": { "MarkdownDocumentation": "`RelatedFindingsProductArn`\n\nThe ARN of the solution that generated a related finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-relatedfindingsproductarn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsIamAccessKeyPrincipalName": { "MarkdownDocumentation": "`ResourceAwsIamAccessKeyPrincipalName`\n\nThe name of the principal that is associated with an IAM access key.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsiamaccesskeyprincipalname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ThreatIntelIndicatorCategory": { "MarkdownDocumentation": "`ThreatIntelIndicatorCategory`\n\nThe category of a threat intelligence indicator.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-threatintelindicatorcategory", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ComplianceStatus": { "MarkdownDocumentation": "`ComplianceStatus`\n\nExclusive to findings that are generated as the result of a check run against a specific\nrule in a supported standard, such as CIS AWS Foundations. Contains security\nstandard-related finding details.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-compliancestatus", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ThreatIntelIndicatorValue": { "MarkdownDocumentation": "`ThreatIntelIndicatorValue`\n\nThe value of a threat intelligence indicator.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-threatintelindicatorvalue", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceContainerImageName": { "MarkdownDocumentation": "`ResourceContainerImageName`\n\nThe name of the image related to a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourcecontainerimagename", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "MalwareType": { "MarkdownDocumentation": "`MalwareType`\n\nThe type of the malware that was observed.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-malwaretype", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ThreatIntelIndicatorSource": { "MarkdownDocumentation": "`ThreatIntelIndicatorSource`\n\nThe source of the threat intelligence.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-threatintelindicatorsource", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsIamAccessKeyCreatedAt": { "MarkdownDocumentation": "`ResourceAwsIamAccessKeyCreatedAt`\n\nThe creation date/time of the IAM access key related to a finding.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsiamaccesskeycreatedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "ResourceAwsEc2InstanceType": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceType`\n\nThe instance type of the instance.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instancetype", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "RecommendationText": { "MarkdownDocumentation": "`RecommendationText`\n\nThe recommendation of what to do about the issue described in a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-recommendationtext", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "AwsAccountName": { "MarkdownDocumentation": "`AwsAccountName`\n\nThe name of the AWS account in which a finding is generated.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-awsaccountname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "FindingProviderFieldsRelatedFindingsProductArn": { "MarkdownDocumentation": "`FindingProviderFieldsRelatedFindingsProductArn`\n\nThe ARN of the solution that generated a related finding that is identified by the finding provider.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-findingproviderfieldsrelatedfindingsproductarn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe AWS account ID in which a finding is generated.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-awsaccountid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe security findings provider-specific identifier for a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-id", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ProcessParentPid": { "MarkdownDocumentation": "`ProcessParentPid`\n\nThe parent process ID. This field accepts positive integers between `O` and `2147483647`.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-insight-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-processparentpid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": false }, "ResourceApplicationName": { "MarkdownDocumentation": "`ResourceApplicationName`\n\nThe name of the application that is related to a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceapplicationname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ProductArn": { "MarkdownDocumentation": "`ProductArn`\n\nThe ARN generated by Security Hub CSPM that uniquely identifies a third-party company\n(security findings provider) after this provider's product (solution that generates\nfindings) is registered with Security Hub CSPM.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-productarn", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsEc2InstanceIpV6Addresses": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceIpV6Addresses`\n\nThe IPv6 addresses associated with the instance.\n*Required*: No\n*Type*: Array of [IpFilter](./aws-properties-securityhub-insight-ipfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instanceipv6addresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpFilter", "DuplicatesAllowed": false }, "MalwareName": { "MarkdownDocumentation": "`MalwareName`\n\nThe name of the malware that was observed.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-malwarename", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "Description": { "MarkdownDocumentation": "`Description`\n\nA finding's description.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-description", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceContainerLaunchedAt": { "MarkdownDocumentation": "`ResourceContainerLaunchedAt`\n\nA timestamp that identifies when the container was started.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourcecontainerlaunchedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "ProcessPid": { "MarkdownDocumentation": "`ProcessPid`\n\nThe process ID.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-insight-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-processpid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": false }, "NoteText": { "MarkdownDocumentation": "`NoteText`\n\nThe text of a note.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-notetext", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsEc2InstanceKeyName": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceKeyName`\n\nThe key name associated with the instance.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instancekeyname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "FindingProviderFieldsTypes": { "MarkdownDocumentation": "`FindingProviderFieldsTypes`\n\nOne or more finding types that the finding provider assigned to the finding. Uses the format of `namespace/category/classifier`\nthat classify a finding.\nValid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\nBehaviors | Sensitive Data Identifications\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-findingproviderfieldstypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ComplianceSecurityControlId": { "MarkdownDocumentation": "`ComplianceSecurityControlId`\n\nThe unique identifier of a control across standards. Values for this field typically consist of an\nAWS service and a number, such as APIGateway.5.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-compliancesecuritycontrolid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NoteUpdatedBy": { "MarkdownDocumentation": "`NoteUpdatedBy`\n\nThe principal that created a note.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-noteupdatedby", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "VerificationState": { "MarkdownDocumentation": "`VerificationState`\n\nThe veracity of a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-verificationstate", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "GeneratorId": { "MarkdownDocumentation": "`GeneratorId`\n\nThe identifier for the solution-specific component (a discrete unit of logic) that\ngenerated a finding. In various security findings providers' solutions, this generator can\nbe called a rule, a check, a detector, a plugin, etc.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-generatorid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nSpecifies the type of the resource that details are provided for.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourcetype", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkProtocol": { "MarkdownDocumentation": "`NetworkProtocol`\n\nThe protocol of network-related information about a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networkprotocol", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "UpdatedAt": { "MarkdownDocumentation": "`UpdatedAt`\n\nA timestamp that indicates when the security findings provider last\nupdated the finding record.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-updatedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "ProcessPath": { "MarkdownDocumentation": "`ProcessPath`\n\nThe path to the process executable.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-processpath", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "WorkflowStatus": { "MarkdownDocumentation": "`WorkflowStatus`\n\nThe status of the investigation into a finding. Allowed values are the following.\n* `NEW` - The initial state of a finding, before it is reviewed.\n \n Security Hub CSPM also resets the workflow status from `NOTIFIED` or\n `RESOLVED` to `NEW` in the following cases:\n \n + `RecordState` changes from `ARCHIVED` to `ACTIVE`.\n + `Compliance.Status` changes from `PASSED` to either `WARNING`,\n `FAILED`, or `NOT_AVAILABLE`.\n* `NOTIFIED` - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.\n \n If one of the following occurs, the workflow status is changed automatically from\n `NOTIFIED` to `NEW`:\n \n + `RecordState` changes from `ARCHIVED` to\n `ACTIVE`.\n + `Compliance.Status` changes from `PASSED` to `FAILED`,\n `WARNING`, or `NOT_AVAILABLE`.\n* `SUPPRESSED` - Indicates that you reviewed the finding and don't believe that any action is\n needed.\n \n The workflow status of a `SUPPRESSED` finding does not change if\n `RecordState` changes from `ARCHIVED` to\n `ACTIVE`.\n* `RESOLVED` - The finding was reviewed and remediated and is now\n considered resolved.\n \n The finding remains `RESOLVED` unless one of the following occurs:\n \n + `RecordState` changes from `ARCHIVED` to\n `ACTIVE`.\n + `Compliance.Status` changes from `PASSED` to `FAILED`,\n `WARNING`, or `NOT_AVAILABLE`.\n \n In those cases, the workflow status is automatically reset to `NEW`.\n \n For findings from controls, if `Compliance.Status` is `PASSED`,\n then Security Hub CSPM automatically sets the workflow status to `RESOLVED`.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-workflowstatus", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceContainerName": { "MarkdownDocumentation": "`ResourceContainerName`\n\nThe name of the container related to a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourcecontainername", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "Type": { "MarkdownDocumentation": "`Type`\n\nA finding type in the format of `namespace/category/classifier` that\nclassifies a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-type", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe canonical identifier for the given resource type.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkDestinationDomain": { "MarkdownDocumentation": "`NetworkDestinationDomain`\n\nThe destination domain of network-related information about a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networkdestinationdomain", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ProductName": { "MarkdownDocumentation": "`ProductName`\n\nThe name of the solution (product) that generates findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-productname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nA list of AWS tags associated with a resource at the time the finding was\nprocessed.\n*Required*: No\n*Type*: Array of [MapFilter](./aws-properties-securityhub-insight-mapfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MapFilter", "DuplicatesAllowed": false }, "ResourceAwsEc2InstanceVpcId": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceVpcId`\n\nThe identifier of the VPC that the instance was launched in.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instancevpcid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsS3BucketOwnerName": { "MarkdownDocumentation": "`ResourceAwsS3BucketOwnerName`\n\nThe display name of the owner of the S3 bucket.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawss3bucketownername", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "LastObservedAt": { "MarkdownDocumentation": "`LastObservedAt`\n\nA timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-lastobservedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "ComplianceSecurityControlParametersName": { "MarkdownDocumentation": "`ComplianceSecurityControlParametersName`\n\nThe name of a security control parameter.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-compliancesecuritycontrolparametersname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkSourceIpV4": { "MarkdownDocumentation": "`NetworkSourceIpV4`\n\nThe source IPv4 address of network-related information about a finding.\n*Required*: No\n*Type*: Array of [IpFilter](./aws-properties-securityhub-insight-ipfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networksourceipv4", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpFilter", "DuplicatesAllowed": false }, "ProcessLaunchedAt": { "MarkdownDocumentation": "`ProcessLaunchedAt`\n\nA timestamp that identifies when the process was launched.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-processlaunchedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "ResourceAwsEc2InstanceLaunchedAt": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceLaunchedAt`\n\nThe date and time the instance was launched.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instancelaunchedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "NoteUpdatedAt": { "MarkdownDocumentation": "`NoteUpdatedAt`\n\nThe timestamp of when the note was updated.\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-noteupdatedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "ThreatIntelIndicatorType": { "MarkdownDocumentation": "`ThreatIntelIndicatorType`\n\nThe type of a threat intelligence indicator.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-threatintelindicatortype", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "CompanyName": { "MarkdownDocumentation": "`CompanyName`\n\nThe name of the findings provider (company) that owns the solution (product) that\ngenerates findings.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-companyname", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceRegion": { "MarkdownDocumentation": "`ResourceRegion`\n\nThe canonical AWS external Region name where this resource is located.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceregion", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsIamAccessKeyStatus": { "MarkdownDocumentation": "`ResourceAwsIamAccessKeyStatus`\n\nThe status of the IAM access key related to a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsiamaccesskeystatus", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkSourceIpV6": { "MarkdownDocumentation": "`NetworkSourceIpV6`\n\nThe source IPv6 address of network-related information about a finding.\n*Required*: No\n*Type*: Array of [IpFilter](./aws-properties-securityhub-insight-ipfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networksourceipv6", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpFilter", "DuplicatesAllowed": false }, "Confidence": { "MarkdownDocumentation": "`Confidence`\n\nA finding's confidence. Confidence is defined as the likelihood that a finding\naccurately identifies the behavior or issue that it was intended to identify.\nConfidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\nconfidence and 100 means 100 percent confidence.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-insight-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-confidence", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": false }, "ProductFields": { "MarkdownDocumentation": "`ProductFields`\n\nA data type where security findings providers can include additional solution-specific\ndetails that aren't part of the defined `AwsSecurityFinding` format.\n*Required*: No\n*Type*: Array of [MapFilter](./aws-properties-securityhub-insight-mapfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-productfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MapFilter", "DuplicatesAllowed": false }, "ThreatIntelIndicatorLastObservedAt": { "MarkdownDocumentation": "`ThreatIntelIndicatorLastObservedAt`\n\nA timestamp that identifies the last observation of a threat intelligence indicator.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-threatintelindicatorlastobservedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "ResourceAwsEc2InstanceSubnetId": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceSubnetId`\n\nThe identifier of the subnet that the instance was launched in.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instancesubnetid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ComplianceAssociatedStandardsId": { "MarkdownDocumentation": "`ComplianceAssociatedStandardsId`\n\nThe unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the\nAmazon Resource Name (ARN) returned for a standard in the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API response.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-complianceassociatedstandardsid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsEc2InstanceImageId": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceImageId`\n\nThe Amazon Machine Image (AMI) ID of the instance.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instanceimageid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsEc2InstanceIpV4Addresses": { "MarkdownDocumentation": "`ResourceAwsEc2InstanceIpV4Addresses`\n\nThe IPv4 addresses associated with the instance.\n*Required*: No\n*Type*: Array of [IpFilter](./aws-properties-securityhub-insight-ipfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawsec2instanceipv4addresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpFilter", "DuplicatesAllowed": false }, "RelatedFindingsId": { "MarkdownDocumentation": "`RelatedFindingsId`\n\nThe solution-generated identifier for a related finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-relatedfindingsid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ProcessTerminatedAt": { "MarkdownDocumentation": "`ProcessTerminatedAt`\n\nA timestamp that identifies when the process was terminated.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: Array of [DateFilter](./aws-properties-securityhub-insight-datefilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-processterminatedat", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DateFilter", "DuplicatesAllowed": false }, "ResourceContainerImageId": { "MarkdownDocumentation": "`ResourceContainerImageId`\n\nThe identifier of the image related to a finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourcecontainerimageid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkDestinationIpV4": { "MarkdownDocumentation": "`NetworkDestinationIpV4`\n\nThe destination IPv4 address of network-related information about a finding.\n*Required*: No\n*Type*: Array of [IpFilter](./aws-properties-securityhub-insight-ipfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networkdestinationipv4", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpFilter", "DuplicatesAllowed": false }, "Region": { "MarkdownDocumentation": "`Region`\n\nThe Region from which the finding was generated.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-region", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkDestinationIpV6": { "MarkdownDocumentation": "`NetworkDestinationIpV6`\n\nThe destination IPv6 address of network-related information about a finding.\n*Required*: No\n*Type*: Array of [IpFilter](./aws-properties-securityhub-insight-ipfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networkdestinationipv6", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpFilter", "DuplicatesAllowed": false }, "VulnerabilitiesExploitAvailable": { "MarkdownDocumentation": "`VulnerabilitiesExploitAvailable`\n\nIndicates whether a software vulnerability in your environment has a known exploit. You can filter findings by this\nfield only if you use Security Hub CSPM and Amazon Inspector.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-vulnerabilitiesexploitavailable", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "FindingProviderFieldsCriticality": { "MarkdownDocumentation": "`FindingProviderFieldsCriticality`\n\nThe finding provider value for the level of importance assigned to the resources associated with\nthe findings.\nA score of 0 means that the underlying resources have no criticality, and a score of 100\nis reserved for the most critical resources.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-insight-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-findingproviderfieldscriticality", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": false }, "NetworkDestinationPort": { "MarkdownDocumentation": "`NetworkDestinationPort`\n\nThe destination port of network-related information about a finding.\n*Required*: No\n*Type*: Array of [NumberFilter](./aws-properties-securityhub-insight-numberfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networkdestinationport", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NumberFilter", "DuplicatesAllowed": false }, "ResourceDetailsOther": { "MarkdownDocumentation": "`ResourceDetailsOther`\n\nThe details of a resource that doesn't have a specific subfield for the resource type\ndefined.\n*Required*: No\n*Type*: Array of [MapFilter](./aws-properties-securityhub-insight-mapfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourcedetailsother", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MapFilter", "DuplicatesAllowed": false }, "FindingProviderFieldsSeverityLabel": { "MarkdownDocumentation": "`FindingProviderFieldsSeverityLabel`\n\nThe finding provider value for the severity label.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-findingproviderfieldsseveritylabel", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ThreatIntelIndicatorSourceUrl": { "MarkdownDocumentation": "`ThreatIntelIndicatorSourceUrl`\n\nThe URL for more details from the source of the threat intelligence.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-threatintelindicatorsourceurl", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "FindingProviderFieldsSeverityOriginal": { "MarkdownDocumentation": "`FindingProviderFieldsSeverityOriginal`\n\nThe finding provider's original value for the severity.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-findingproviderfieldsseverityoriginal", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "MalwarePath": { "MarkdownDocumentation": "`MalwarePath`\n\nThe filesystem path of the malware that was observed.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-malwarepath", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "Sample": { "MarkdownDocumentation": "`Sample`\n\nIndicates whether or not sample findings are included in the filter results.\n*Required*: No\n*Type*: Array of [BooleanFilter](./aws-properties-securityhub-insight-booleanfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-sample", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BooleanFilter", "DuplicatesAllowed": false }, "RecordState": { "MarkdownDocumentation": "`RecordState`\n\nThe updated record state for the finding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-recordstate", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "Title": { "MarkdownDocumentation": "`Title`\n\nA finding's title.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-title", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "WorkflowState": { "MarkdownDocumentation": "`WorkflowState`\n\nThe workflow state of a finding.\nNote that this field is deprecated. To search for a finding based on its workflow\nstatus, use `WorkflowStatus`.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-workflowstate", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "NetworkSourceMac": { "MarkdownDocumentation": "`NetworkSourceMac`\n\nThe source media access control (MAC) address of network-related information about a\nfinding.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-networksourcemac", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "ResourceAwsS3BucketOwnerId": { "MarkdownDocumentation": "`ResourceAwsS3BucketOwnerId`\n\nThe canonical user ID of the owner of the S3 bucket.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-resourceawss3bucketownerid", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false }, "VulnerabilitiesFixAvailable": { "MarkdownDocumentation": "`VulnerabilitiesFixAvailable`\n\nIndicates whether a vulnerability is fixed in a newer version of the affected software packages. You can filter\nfindings by this field only if you use Security Hub CSPM and Amazon Inspector.\n*Required*: No\n*Type*: Array of [StringFilter](./aws-properties-securityhub-insight-stringfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-awssecurityfindingfilters.html#cfn-securityhub-insight-awssecurityfindingfilters-vulnerabilitiesfixavailable", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StringFilter", "DuplicatesAllowed": false } } }, "AWS::SecurityHub::Insight.BooleanFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::Insight.BooleanFilter`\n\nBoolean filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-booleanfilter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the boolean.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-booleanfilter.html#cfn-securityhub-insight-booleanfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::SecurityHub::Insight.DateFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::Insight.DateFilter`\n\nA date filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-datefilter.html", "Properties": { "DateRange": { "MarkdownDocumentation": "`DateRange`\n\nA date range for the date filter.\n*Required*: No\n*Type*: [DateRange](./aws-properties-securityhub-insight-daterange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-datefilter.html#cfn-securityhub-insight-datefilter-daterange", "UpdateType": "Mutable", "Required": false, "Type": "DateRange" }, "Start": { "MarkdownDocumentation": "`Start`\n\nA timestamp that provides the start date for the date filter.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: String\n*Pattern*: `^([\\+-]?\\d{4}(?!\\d{2}))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([tT]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-datefilter.html#cfn-securityhub-insight-datefilter-start", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "End": { "MarkdownDocumentation": "`End`\n\nA timestamp that provides the end date for the date filter.\nFor more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).\n*Required*: No\n*Type*: String\n*Pattern*: `^([\\+-]?\\d{4}(?!\\d{2}))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([tT]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-datefilter.html#cfn-securityhub-insight-datefilter-end", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityHub::Insight.DateRange": { "MarkdownDocumentation": "`AWS::SecurityHub::Insight.DateRange`\n\nA date range for the date filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-daterange.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nA date range value for the date filter.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-daterange.html#cfn-securityhub-insight-daterange-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nA date range unit for the date filter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DAYS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DAYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-daterange.html#cfn-securityhub-insight-daterange-unit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::Insight.IpFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::Insight.IpFilter`\n\nThe IP filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-ipfilter.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nA finding's CIDR value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-ipfilter.html#cfn-securityhub-insight-ipfilter-cidr", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::Insight.MapFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::Insight.MapFilter`\n\nA map filter for filtering AWS Security Hub CSPM findings. Each map filter provides the field to check for, the\nvalue to check for, and the comparison operator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-mapfilter.html", "Properties": { "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe condition to apply to the key value when filtering Security Hub CSPM findings with a map\nfilter.\nTo search for values that have the filter value, use one of the following comparison operators:\n* To search for values that include the filter value, use `CONTAINS`. For example, for the\n `ResourceTags` field, the filter `Department CONTAINS Security` matches findings that\n include the value `Security` for the `Department` tag. In the same example, a finding with a value of\n `Security team` for the `Department` tag is a match.\n* To search for values that exactly match the filter value, use `EQUALS`. For example, for\n the `ResourceTags` field, the filter `Department EQUALS Security` matches findings that\n have the value `Security` for the `Department` tag.\n`CONTAINS` and `EQUALS` filters on the same field are joined by `OR`. A\nfinding matches if it matches any one of those filters. For example, the filters `Department CONTAINS Security OR\nDepartment CONTAINS Finance` match a finding that includes either `Security`,\n`Finance`, or both values.\nTo search for values that don't have the filter value, use one of the following comparison operators:\n* To search for values that exclude the filter value, use `NOT_CONTAINS`. For example, for\n the `ResourceTags` field, the filter `Department NOT_CONTAINS Finance` matches findings\n that exclude the value `Finance` for the `Department` tag.\n* To search for values other than the filter value, use `NOT_EQUALS`. For example, for the\n `ResourceTags` field, the filter `Department NOT_EQUALS Finance` matches findings that\n don\u2019t have the value `Finance` for the `Department` tag.\n`NOT_CONTAINS` and `NOT_EQUALS` filters on the same field are joined by `AND`.\nA finding matches only if it matches all of those filters. For example, the filters `Department NOT_CONTAINS Security AND\nDepartment NOT_CONTAINS Finance` match a finding that excludes both the `Security` and\n`Finance` values.\n`CONTAINS` filters can only be used with other `CONTAINS` filters. `NOT_CONTAINS`\nfilters can only be used with other `NOT_CONTAINS` filters.\nYou can\u2019t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field.\nSimilarly, you can\u2019t have both an `EQUALS` filter and a `NOT_EQUALS` filter on the same field.\nCombining filters in this way returns an error.\n`CONTAINS` and `NOT_CONTAINS` operators can be used only with automation rules. For more information,\nsee [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *AWS Security Hub CSPM User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | NOT_EQUALS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "NOT_EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-mapfilter.html#cfn-securityhub-insight-mapfilter-comparison", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the key in the map filter. Filter values are case sensitive. For example,\none of the values for a tag called `Department` might be `Security`.\nIf you provide `security` as the filter value, then there's no match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-mapfilter.html#cfn-securityhub-insight-mapfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key of the map filter. For example, for `ResourceTags`, `Key`\nidentifies the name of the tag. For `UserDefinedFields`, `Key` is the\nname of the field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-mapfilter.html#cfn-securityhub-insight-mapfilter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::Insight.NumberFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::Insight.NumberFilter`\n\nA number filter for querying findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-numberfilter.html", "Properties": { "Gte": { "MarkdownDocumentation": "`Gte`\n\nThe greater-than-equal condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-numberfilter.html#cfn-securityhub-insight-numberfilter-gte", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Eq": { "MarkdownDocumentation": "`Eq`\n\nThe equal-to condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-numberfilter.html#cfn-securityhub-insight-numberfilter-eq", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Lte": { "MarkdownDocumentation": "`Lte`\n\nThe less-than-equal condition to be applied to a single field when querying for\nfindings.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-numberfilter.html#cfn-securityhub-insight-numberfilter-lte", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::SecurityHub::Insight.StringFilter": { "MarkdownDocumentation": "`AWS::SecurityHub::Insight.StringFilter`\n\nA string filter for filtering AWS Security Hub CSPM findings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-stringfilter.html", "Properties": { "Comparison": { "MarkdownDocumentation": "`Comparison`\n\nThe condition to apply to a string value when filtering Security Hub CSPM findings.\nTo search for values that have the filter value, use one of the following comparison operators:\n* To search for values that include the filter value, use `CONTAINS`. For example, the\n filter `Title CONTAINS CloudFront` matches findings that have a `Title` that\n includes the string CloudFront.\n* To search for values that exactly match the filter value, use `EQUALS`. For example,\n the filter `AwsAccountId EQUALS 123456789012` only matches findings that have an account ID of\n `123456789012`.\n* To search for values that start with the filter value, use `PREFIX`. For example, the\n filter `ResourceRegion PREFIX us` matches findings that have a `ResourceRegion` that starts\n with `us`. A `ResourceRegion` that starts with a different value, such as `af`,\n `ap`, or `ca`, doesn't match.\n`CONTAINS`, `EQUALS`, and `PREFIX` filters on the same field are joined by\n`OR`. A finding matches if it matches any one of those filters. For example, the filters `Title CONTAINS CloudFront OR\nTitle CONTAINS CloudWatch` match a finding that includes either `CloudFront`,\n`CloudWatch`, or both strings in the title.\nTo search for values that don\u2019t have the filter value, use one of the following comparison operators:\n* To search for values that exclude the filter value, use `NOT_CONTAINS`. For example, the\n filter `Title NOT_CONTAINS CloudFront` matches findings that have a `Title` that\n excludes the string CloudFront.\n* To search for values other than the filter value, use `NOT_EQUALS`. For\n example, the filter `AwsAccountId NOT_EQUALS 123456789012` only matches findings that have an account\n ID other than `123456789012`.\n* To search for values that don't start with the filter value, use `PREFIX_NOT_EQUALS`. For\n example, the filter `ResourceRegion PREFIX_NOT_EQUALS us` matches findings with a\n `ResourceRegion` that starts with a value other than `us`.\n`NOT_CONTAINS`, `NOT_EQUALS`, and `PREFIX_NOT_EQUALS` filters on the same field\nare joined by `AND`. A finding matches only if it matches all of those filters. For example, the filters `Title NOT_CONTAINS CloudFront AND\nTitle NOT_CONTAINS CloudWatch` match a finding that excludes both `CloudFront` and\n`CloudWatch` in the title.\nYou can\u2019t have both a `CONTAINS` filter and a `NOT_CONTAINS` filter on the same field. Similarly,\nyou can't provide both an `EQUALS` filter and a `NOT_EQUALS` or\n`PREFIX_NOT_EQUALS` filter on the same field. Combining filters in this way returns an error. `CONTAINS` filters\ncan only be used with other `CONTAINS` filters. `NOT_CONTAINS` filters can only be used with\nother `NOT_CONTAINS` filters.\nYou can combine `PREFIX` filters with `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters for the same field.\nSecurity Hub CSPM first processes the `PREFIX` filters, and then the `NOT_EQUALS` or `PREFIX_NOT_EQUALS` filters.\nFor example, for the following filters, Security Hub CSPM first identifies findings that have resource types\nthat start with either `AwsIam` or `AwsEc2`. It then excludes findings that have a resource\ntype of `AwsIamPolicy` and findings that have a resource type of `AwsEc2NetworkInterface`.\n* `ResourceType PREFIX AwsIam`\n* `ResourceType PREFIX AwsEc2`\n* `ResourceType NOT_EQUALS AwsIamPolicy`\n* `ResourceType NOT_EQUALS AwsEc2NetworkInterface`\n`CONTAINS` and `NOT_CONTAINS` operators can be used only with automation rules V1.\n`CONTAINS_WORD` operator is only supported in `GetFindingsV2`, `GetFindingStatisticsV2`, `GetResourcesV2`, and `GetResourceStatisticsV2` APIs.\nFor more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *AWS Security Hub CSPM User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQUALS | PREFIX | 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)", "RefReturnValue": "", "AllowedValues": [ "EQUALS", "PREFIX", "NOT_EQUALS", "PREFIX_NOT_EQUALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-stringfilter.html#cfn-securityhub-insight-stringfilter-comparison", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe string filter value. Filter values are case sensitive. For example, the product name\nfor control-based findings is `Security Hub CSPM`. If you provide `security hub`\nas the filter value, there's no match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-insight-stringfilter.html#cfn-securityhub-insight-stringfilter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityHub::SecurityControl.ParameterConfiguration": { "MarkdownDocumentation": "`AWS::SecurityHub::SecurityControl.ParameterConfiguration`\n\nAn object that provides the current value of a security control parameter and identifies whether it has been customized.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parameterconfiguration.html", "Properties": { "ValueType": { "MarkdownDocumentation": "`ValueType`\n\nIdentifies whether a control parameter uses a custom user-defined value or subscribes to the default\nAWS Security Hub CSPM behavior.\nWhen `ValueType` is set equal to `DEFAULT`, the default\nbehavior can be a specific Security Hub CSPM default value, or the default behavior can be to ignore a specific parameter.\nWhen `ValueType` is set equal to `DEFAULT`, Security Hub CSPM ignores user-provided input for\nthe `Value` field.\nWhen `ValueType` is set equal to `CUSTOM`, the `Value` field can't be empty.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEFAULT | CUSTOM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parameterconfiguration.html#cfn-securityhub-securitycontrol-parameterconfiguration-valuetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe current value of a control parameter.\n*Required*: No\n*Type*: [ParameterValue](./aws-properties-securityhub-securitycontrol-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parameterconfiguration.html#cfn-securityhub-securitycontrol-parameterconfiguration-value", "UpdateType": "Mutable", "Required": false, "Type": "ParameterValue" } } }, "AWS::SecurityHub::SecurityControl.ParameterValue": { "MarkdownDocumentation": "`AWS::SecurityHub::SecurityControl.ParameterValue`\n\nAn object that includes the data type of a security control parameter and its current value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html", "Properties": { "Enum": { "MarkdownDocumentation": "`Enum`\n\nA control parameter that is an enum.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html#cfn-securityhub-securitycontrol-parametervalue-enum", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Integer": { "MarkdownDocumentation": "`Integer`\n\nA control parameter that is an integer.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html#cfn-securityhub-securitycontrol-parametervalue-integer", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StringList": { "MarkdownDocumentation": "`StringList`\n\nA control parameter that is a list of strings.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html#cfn-securityhub-securitycontrol-parametervalue-stringlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnumList": { "MarkdownDocumentation": "`EnumList`\n\nA control parameter that is a list of enums.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html#cfn-securityhub-securitycontrol-parametervalue-enumlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IntegerList": { "MarkdownDocumentation": "`IntegerList`\n\nA control parameter that is a list of integers.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html#cfn-securityhub-securitycontrol-parametervalue-integerlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "String": { "MarkdownDocumentation": "`String`\n\nA control parameter that is a string.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html#cfn-securityhub-securitycontrol-parametervalue-string", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Boolean": { "MarkdownDocumentation": "`Boolean`\n\nA control parameter that is a boolean.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html#cfn-securityhub-securitycontrol-parametervalue-boolean", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Double": { "MarkdownDocumentation": "`Double`\n\nA control parameter that is a double.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html#cfn-securityhub-securitycontrol-parametervalue-double", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } } }, "AWS::SecurityHub::Standard.StandardsControl": { "MarkdownDocumentation": "`AWS::SecurityHub::Standard.StandardsControl`\n\nProvides details about an individual security control. For a list of Security Hub CSPM controls, see [Security Hub CSPM controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html) in the *AWS Security Hub CSPM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-standard-standardscontrol.html", "Properties": { "StandardsControlArn": { "MarkdownDocumentation": "`StandardsControlArn`\n\nThe Amazon Resource Name (ARN) of the control.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws\\S*:securityhub:\\S*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-standard-standardscontrol.html#cfn-securityhub-standard-standardscontrol-standardscontrolarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Reason": { "MarkdownDocumentation": "`Reason`\n\nA user-defined reason for changing a control's enablement status in a\nspecified standard. If you are disabling a control, then this property is required.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-standard-standardscontrol.html#cfn-securityhub-standard-standardscontrol-reason", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityLake::DataLake.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::SecurityLake::DataLake.EncryptionConfiguration`\n\nProvides encryption details of the Amazon Security Lake object. The AWS shared responsibility model applies to data protection in Amazon Security Lake. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. For more details, see [Data protection](https://docs.aws.amazon.com//security-lake/latest/userguide/data-protection.html) in the Amazon Security Lake User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-encryptionconfiguration.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe ID of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-encryptionconfiguration.html#cfn-securitylake-datalake-encryptionconfiguration-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityLake::DataLake.Expiration": { "MarkdownDocumentation": "`AWS::SecurityLake::DataLake.Expiration`\n\nProvides data expiration details of the Amazon Security Lake object. You can specify your preferred Amazon S3 storage class and the time period for S3 objects to stay in that storage class before they expire. For more information about Amazon S3 Lifecycle\nconfigurations, see [Managing your storage\nlifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) in the *Amazon Simple Storage Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-expiration.html", "Properties": { "Days": { "MarkdownDocumentation": "`Days`\n\nThe number of days before data expires in the Amazon Security Lake object.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-expiration.html#cfn-securitylake-datalake-expiration-days", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SecurityLake::DataLake.LifecycleConfiguration": { "MarkdownDocumentation": "`AWS::SecurityLake::DataLake.LifecycleConfiguration`\n\nProvides lifecycle details of Amazon Security Lake object. To manage your data so that it is stored cost effectively, you can configure retention settings for the data. You can specify your preferred Amazon S3 storage class and the\ntime period for Amazon S3 objects to stay in that storage class before they transition to a\ndifferent storage class or expire. For more information about Amazon S3 Lifecycle\nconfigurations, see [Managing your storage\nlifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) in the *Amazon Simple Storage Service User Guide*.\nIn Security Lake, you specify retention settings at the Region level. For example, you\nmight choose to transition all S3 objects in a specific AWS Region to the `S3\nStandard-IA` storage class 30 days after they're written to the data lake.\nThe default Amazon S3 storage class is S3 Standard.\n###### Important\nSecurity Lake doesn't support Amazon S3 Object Lock. When the data lake buckets are created, S3 Object Lock is disabled by\ndefault. Enabling S3 Object Lock with default retention mode interrupts the delivery of normalized log data to the data lake.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-lifecycleconfiguration.html", "Properties": { "Transitions": { "MarkdownDocumentation": "`Transitions`\n\nProvides data storage transition details of Amazon Security Lake object. By configuring these settings, you can specify your preferred Amazon S3 storage class and the time period for S3 objects to stay in that storage class before they transition to a different storage class.\n*Required*: No\n*Type*: [Array](./aws-properties-securitylake-datalake-transitions.html) of [Transitions](./aws-properties-securitylake-datalake-transitions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-lifecycleconfiguration.html#cfn-securitylake-datalake-lifecycleconfiguration-transitions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Transitions", "DuplicatesAllowed": true }, "Expiration": { "MarkdownDocumentation": "`Expiration`\n\nProvides data expiration details of the Amazon Security Lake object.\n*Required*: No\n*Type*: [Expiration](./aws-properties-securitylake-datalake-expiration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-lifecycleconfiguration.html#cfn-securitylake-datalake-lifecycleconfiguration-expiration", "UpdateType": "Mutable", "Required": false, "Type": "Expiration" } } }, "AWS::SecurityLake::DataLake.ReplicationConfiguration": { "MarkdownDocumentation": "`AWS::SecurityLake::DataLake.ReplicationConfiguration`\n\nProvides replication configuration details for objects stored in the Amazon Security Lake data lake.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-replicationconfiguration.html", "Properties": { "Regions": { "MarkdownDocumentation": "`Regions`\n\nSpecifies one or more centralized rollup Regions. The AWS Region specified in the\nregion parameter of the `CreateDataLake` or\n`UpdateDataLake` operations contributes data to the\nrollup Region or Regions specified in this parameter.\nReplication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same AWS account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-replicationconfiguration.html#cfn-securitylake-datalake-replicationconfiguration-regions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nReplication settings for the Amazon S3 buckets. This parameter uses the AWS Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-replicationconfiguration.html#cfn-securitylake-datalake-replicationconfiguration-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityLake::DataLake.Transitions": { "MarkdownDocumentation": "`AWS::SecurityLake::DataLake.Transitions`\n\nProvides transition lifecycle details of the Amazon Security Lake object. For more information about Amazon S3 Lifecycle\nconfigurations, see [Managing your storage\nlifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) in the *Amazon Simple Storage Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-transitions.html", "Properties": { "StorageClass": { "MarkdownDocumentation": "`StorageClass`\n\nThe list of storage classes that you can choose from based on the data access,\nresiliency, and cost requirements of your workloads.\nThe default storage class is **S3 Standard**.\nFor information about other storage classes, see\n[Setting the storage class of an object](https://docs.aws.amazon.com/AmazonS3/latest/userguide/sc-howtoset.html)\nin the *Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-transitions.html#cfn-securitylake-datalake-transitions-storageclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Days": { "MarkdownDocumentation": "`Days`\n\nThe number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-transitions.html#cfn-securitylake-datalake-transitions-days", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SecurityLake::Subscriber.AwsLogSource": { "MarkdownDocumentation": "`AWS::SecurityLake::Subscriber.AwsLogSource`\n\nAdds a natively supported AWS service as an Amazon Security Lake source. Enables source types for member accounts in required AWS Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an AWS service as a source, Security Lake starts collecting logs and events from it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-awslogsource.html", "Properties": { "SourceName": { "MarkdownDocumentation": "`SourceName`\n\nSource name of the natively supported AWS service that is supported as an Amazon Security Lake source. For the list of sources supported by Amazon Security Lake see [Collecting data from AWS services](https://docs.aws.amazon.com//security-lake/latest/userguide/internal-sources.html) in the Amazon Security Lake 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-awslogsource.html#cfn-securitylake-subscriber-awslogsource-sourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceVersion": { "MarkdownDocumentation": "`SourceVersion`\n\nSource version of the natively supported AWS service that is supported as an Amazon Security Lake source. For more details about source versions supported by Amazon Security Lake see [OCSF source identification](https://docs.aws.amazon.com//security-lake/latest/userguide/open-cybersecurity-schema-framework.html#ocsf-source-identification) in the Amazon Security Lake User Guide.\n*Required*: No\n*Type*: String\n*Pattern*: `^(latest|[0-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-awslogsource.html#cfn-securitylake-subscriber-awslogsource-sourceversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityLake::Subscriber.CustomLogSource": { "MarkdownDocumentation": "`AWS::SecurityLake::Subscriber.CustomLogSource`\n\nThird-party custom log source that meets the requirements to be added to Amazon Security Lake. For more details, see [Custom log source](https://docs.aws.amazon.com//security-lake/latest/userguide/custom-sources.html#iam-roles-custom-sources) in the *Amazon Security Lake User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-customlogsource.html", "Properties": { "SourceName": { "MarkdownDocumentation": "`SourceName`\n\nThe name of the custom log source.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\\\\\w\\-_:/.]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-customlogsource.html#cfn-securitylake-subscriber-customlogsource-sourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceVersion": { "MarkdownDocumentation": "`SourceVersion`\n\nThe source version of the custom log source.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9\\-\\.\\_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-customlogsource.html#cfn-securitylake-subscriber-customlogsource-sourceversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityLake::Subscriber.Source": { "MarkdownDocumentation": "`AWS::SecurityLake::Subscriber.Source`\n\nSources are logs and events generated from a single system that match a specific event class in the Open Cybersecurity Schema Framework (OCSF) schema. Amazon Security Lake can collect logs and events from a variety of sources, including natively supported AWS services and third-party custom sources.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-source.html", "Properties": { "AwsLogSource": { "MarkdownDocumentation": "`AwsLogSource`\n\nThe natively supported AWS service which is used a Amazon Security Lake source to collect logs and events from.\n*Required*: No\n*Type*: [AwsLogSource](./aws-properties-securitylake-subscriber-awslogsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-source.html#cfn-securitylake-subscriber-source-awslogsource", "UpdateType": "Mutable", "Required": false, "Type": "AwsLogSource" }, "CustomLogSource": { "MarkdownDocumentation": "`CustomLogSource`\n\nThe custom log source AWS which is used a Amazon Security Lake source to collect logs and events from.\n*Required*: No\n*Type*: [CustomLogSource](./aws-properties-securitylake-subscriber-customlogsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-source.html#cfn-securitylake-subscriber-source-customlogsource", "UpdateType": "Mutable", "Required": false, "Type": "CustomLogSource" } } }, "AWS::SecurityLake::Subscriber.SubscriberIdentity": { "MarkdownDocumentation": "`AWS::SecurityLake::Subscriber.SubscriberIdentity`\n\nSpecify the AWS account ID and external ID that the subscriber will use to access source data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-subscriberidentity.html", "Properties": { "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nThe external ID is a unique identifier that the subscriber provides to you.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w+=,.@:/-]*$`\n*Minimum*: `2`\n*Maximum*: `1224`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-subscriberidentity.html#cfn-securitylake-subscriber-subscriberidentity-externalid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nPrincipals can include accounts, users, roles, federated users, or AWS services.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9]{12}|[a-z0-9\\.\\-]*\\.(amazonaws|amazon)\\.com)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-subscriberidentity.html#cfn-securitylake-subscriber-subscriberidentity-principal", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SecurityLake::SubscriberNotification.HttpsNotificationConfiguration": { "MarkdownDocumentation": "`AWS::SecurityLake::SubscriberNotification.HttpsNotificationConfiguration`\n\nSpecify the configurations you want to use for HTTPS subscriber notification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html", "Properties": { "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe subscription endpoint in Security Lake. If you prefer notification with an HTTPS\nendpoint, populate this field.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-endpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetRoleArn": { "MarkdownDocumentation": "`TargetRoleArn`\n\nThe Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you\ncreated. For more information about ARNs and how to use them in policies, see [Managing data access](https://docs.aws.amazon.com///security-lake/latest/userguide/subscriber-data-access.html) and [AWS\nManaged Policies](https://docs.aws.amazon.com//security-lake/latest/userguide/security-iam-awsmanpol.html) in the *Amazon Security Lake User Guide*.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-targetrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthorizationApiKeyValue": { "MarkdownDocumentation": "`AuthorizationApiKeyValue`\n\nThe key value for the notification subscription.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizationApiKeyName": { "MarkdownDocumentation": "`AuthorizationApiKeyName`\n\nThe key name for the notification subscription.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-authorizationapikeyname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpMethod": { "MarkdownDocumentation": "`HttpMethod`\n\nThe HTTPS method used for the notification subscription.\n*Required*: No\n*Type*: String\n*Allowed values*: `POST | PUT`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "POST", "PUT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html#cfn-securitylake-subscribernotification-httpsnotificationconfiguration-httpmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SecurityLake::SubscriberNotification.NotificationConfiguration": { "MarkdownDocumentation": "`AWS::SecurityLake::SubscriberNotification.NotificationConfiguration`\n\nSpecify the configurations you want to use for subscriber notification. The subscriber is notified when new data is written to the data lake for sources that the subscriber\nconsumes in Security Lake.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-notificationconfiguration.html", "Properties": { "HttpsNotificationConfiguration": { "MarkdownDocumentation": "`HttpsNotificationConfiguration`\n\nThe configurations used for HTTPS subscriber notification.\n*Required*: No\n*Type*: [HttpsNotificationConfiguration](./aws-properties-securitylake-subscribernotification-httpsnotificationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-notificationconfiguration.html#cfn-securitylake-subscribernotification-notificationconfiguration-httpsnotificationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HttpsNotificationConfiguration" }, "SqsNotificationConfiguration": { "MarkdownDocumentation": "`SqsNotificationConfiguration`\n\nThe configurations for SQS subscriber notification. The members of this structure are context-dependent.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscribernotification-notificationconfiguration.html#cfn-securitylake-subscribernotification-notificationconfiguration-sqsnotificationconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::ServiceCatalog::CloudFormationProduct.CodeStarParameters": { "MarkdownDocumentation": "`AWS::ServiceCatalog::CloudFormationProduct.CodeStarParameters`\n\nThe subtype containing details about the Codestar connection `Type`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html", "Properties": { "ArtifactPath": { "Required": true, "MarkdownDocumentation": "`ArtifactPath`\n\nThe absolute path wehre the artifact resides within the repo and branch, formatted as\n\"folder/file.json.\"\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html#cfn-servicecatalog-cloudformationproduct-codestarparameters-artifactpath", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Repository": { "Required": true, "MarkdownDocumentation": "`Repository`\n\nThe specific repository where the product\u2019s artifact-to-be-synced resides, formatted as\n\"Account/Repo.\"\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html#cfn-servicecatalog-cloudformationproduct-codestarparameters-repository", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Branch": { "Required": true, "MarkdownDocumentation": "`Branch`\n\nThe specific branch where the artifact resides.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html#cfn-servicecatalog-cloudformationproduct-codestarparameters-branch", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ConnectionArn": { "Required": true, "MarkdownDocumentation": "`ConnectionArn`\n\nThe CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:[a-z0-9][-.a-z0-9]{0,62}:(codestar-connections|codeconnections):([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:[^/].{0,1023}$`\n*Minimum*: `1`\n*Maximum*: `1224`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html#cfn-servicecatalog-cloudformationproduct-codestarparameters-connectionarn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::ServiceCatalog::CloudFormationProduct.ConnectionParameters": { "MarkdownDocumentation": "`AWS::ServiceCatalog::CloudFormationProduct.ConnectionParameters`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-sourceconnection-connectionparameters.html", "Properties": { "CodeStar": { "Type": "CodeStarParameters", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-sourceconnection-connectionparameters.html#cfn-servicecatalog-cloudformationproduct-sourceconnection-connectionparameters-codestar", "UpdateType": "Mutable" } } }, "AWS::ServiceCatalog::CloudFormationProduct.ProvisioningArtifactProperties": { "MarkdownDocumentation": "`AWS::ServiceCatalog::CloudFormationProduct.ProvisioningArtifactProperties`\n\nInformation about a provisioning artifact (also known as a version) for a product.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html", "Properties": { "Type": { "Required": false, "MarkdownDocumentation": "`Type`\n\nThe type of provisioning artifact.\n* `CLOUD_FORMATION_TEMPLATE` - AWS CloudFormation template\n* `TERRAFORM_OPEN_SOURCE` - Terraform Open Source configuration file\n* `TERRAFORM_CLOUD` - Terraform Cloud configuration file\n* `EXTERNAL` - External configuration file\n*Required*: No\n*Type*: String\n*Allowed values*: `CLOUD_FORMATION_TEMPLATE | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE_AMI", "MARKETPLACE_CAR", "TERRAFORM_OPEN_SOURCE", "EXTERNAL", "TERRAFORM_CLOUD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DisableTemplateValidation": { "Required": false, "MarkdownDocumentation": "`DisableTemplateValidation`\n\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-disabletemplatevalidation", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Info": { "Required": true, "MarkdownDocumentation": "`Info`\n\nSpecify the template source with one of the following options, but not both.\nKeys accepted: [ `LoadTemplateFromURL`, `ImportFromPhysicalId` ]\nThe URL of the AWS CloudFormation template in Amazon S3 in JSON format.\nSpecify 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\ntemplate. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON\nformat 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-info", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::ServiceCatalog::CloudFormationProduct.SourceConnection": { "MarkdownDocumentation": "`AWS::ServiceCatalog::CloudFormationProduct.SourceConnection`\n\nA top level `ProductViewDetail` response containing details about the product\u2019s connection.\nAWS Service Catalog returns this field for the `CreateProduct`, `UpdateProduct`,\n`DescribeProductAsAdmin`, and `SearchProductAsAdmin` APIs.\nThis response contains the same fields as the `ConnectionParameters` request, with the\naddition of the `LastSync` response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-sourceconnection.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe only supported `SourceConnection` type is Codestar.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-sourceconnection.html#cfn-servicecatalog-cloudformationproduct-sourceconnection-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ConnectionParameters": { "Type": "ConnectionParameters", "Required": true, "MarkdownDocumentation": "`ConnectionParameters`\n\nThe connection details based on the connection `Type`.\n*Required*: Yes\n*Type*: [ConnectionParameters](./aws-properties-servicecatalog-cloudformationproduct-connectionparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-sourceconnection.html#cfn-servicecatalog-cloudformationproduct-sourceconnection-connectionparameters", "UpdateType": "Mutable" } } }, "AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningParameter": { "MarkdownDocumentation": "`AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningParameter`\n\nInformation about a parameter used to provision a product.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe parameter value.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe parameter key.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningPreferences": { "MarkdownDocumentation": "`AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningPreferences`\n\nThe user-defined preferences that will be applied when updating a provisioned\nproduct. Not all preferences are applicable to all provisioned product type\nOne or more AWS accounts that will have access to the provisioned product.\nApplicable only to a `CFN_STACKSET` provisioned product type.\nThe AWS accounts specified should be within the list of accounts in the\n`STACKSET` constraint. To get the list of accounts in the\n`STACKSET` constraint, use the `DescribeProvisioningParameters`\noperation.\nIf no values are specified, the default value is all accounts from the\n`STACKSET` constraint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html", "Properties": { "StackSetAccounts": { "MarkdownDocumentation": "`StackSetAccounts`\n\nOne or more AWS accounts where the provisioned product will be available.\nApplicable only to a `CFN_STACKSET` provisioned product type.\nThe specified accounts should be within the list of accounts from the `STACKSET` constraint. To get the list of accounts in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.\nIf no values are specified, the default value is all acounts from the `STACKSET` constraint.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetaccounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "StackSetFailureToleranceCount": { "MarkdownDocumentation": "`StackSetFailureToleranceCount`\n\nThe number of accounts, per Region, for which this operation can fail before AWS Service Catalog stops the operation in that Region. If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.\nApplicable only to a `CFN_STACKSET` provisioned product type.\nConditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.\nThe default value is `0` if no value is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetfailuretolerancecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StackSetMaxConcurrencyPercentage": { "MarkdownDocumentation": "`StackSetMaxConcurrencyPercentage`\n\nThe maximum percentage of accounts in which to perform this operation at one time.\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as `1` instead.\nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.\nApplicable only to a `CFN_STACKSET` provisioned product type.\nConditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetmaxconcurrencypercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StackSetMaxConcurrencyCount": { "MarkdownDocumentation": "`StackSetMaxConcurrencyCount`\n\nThe maximum number of accounts in which to perform this operation at one time. This is dependent on the value of `StackSetFailureToleranceCount`. `StackSetMaxConcurrentCount` is at most one more than the `StackSetFailureToleranceCount`.\nNote that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.\nApplicable only to a `CFN_STACKSET` provisioned product type.\nConditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetmaxconcurrencycount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StackSetRegions": { "MarkdownDocumentation": "`StackSetRegions`\n\nOne or more AWS Regions where the provisioned product will be available.\nApplicable only to a `CFN_STACKSET` provisioned product type.\nThe specified Regions should be within the list of Regions from the `STACKSET` constraint. To get the list of Regions in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.\nIf no values are specified, the default value is all Regions from the `STACKSET` constraint.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetregions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "StackSetOperationType": { "MarkdownDocumentation": "`StackSetOperationType`\n\nDetermines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is `UPDATE` if nothing is specified.\nApplicable only to a `CFN_STACKSET` provisioned product type.\nCREATE\nCreates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.\n\nUPDATE\nUpdates the stack set represented by the provisioned product and also its stack instances.\n\nDELETE\nDeletes a stack instance in the stack set represented by the provisioned product.\n\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATE | UPDATE | DELETE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATE", "UPDATE", "DELETE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetoperationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StackSetFailureTolerancePercentage": { "MarkdownDocumentation": "`StackSetFailureTolerancePercentage`\n\nThe percentage of accounts, per Region, for which this stack operation can fail before AWS Service Catalog stops the operation in that Region. If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.\nApplicable only to a `CFN_STACKSET` provisioned product type.\nConditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetfailuretolerancepercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::ServiceCatalog::ServiceAction.DefinitionParameter": { "MarkdownDocumentation": "`AWS::ServiceCatalog::ServiceAction.DefinitionParameter`\n\nThe list of parameters in JSON format.\nFor example: `[{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TARGET\\\"}] or [{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TEXT_VALUE\\\"}]`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-serviceaction-definitionparameter.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the parameter.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-serviceaction-definitionparameter.html#cfn-servicecatalog-serviceaction-definitionparameter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe parameter key.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-serviceaction-definitionparameter.html#cfn-servicecatalog-serviceaction-definitionparameter-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ServiceDiscovery::PrivateDnsNamespace.PrivateDnsPropertiesMutable": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::PrivateDnsNamespace.PrivateDnsPropertiesMutable`\n\nDNS properties for\nthe private DNS namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-privatednspropertiesmutable.html", "Properties": { "SOA": { "Type": "SOA", "Required": false, "MarkdownDocumentation": "`SOA`\n\nFields for the Start\nof Authority (SOA) record for the hosted zone for the private DNS\nnamespace.\n*Required*: No\n*Type*: [SOA](./aws-properties-servicediscovery-privatednsnamespace-soa.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-privatednspropertiesmutable.html#cfn-servicediscovery-privatednsnamespace-privatednspropertiesmutable-soa", "UpdateType": "Mutable" } } }, "AWS::ServiceDiscovery::PrivateDnsNamespace.Properties": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::PrivateDnsNamespace.Properties`\n\nProperties for the\nprivate DNS namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-properties.html", "Properties": { "DnsProperties": { "Type": "PrivateDnsPropertiesMutable", "Required": false, "MarkdownDocumentation": "`DnsProperties`\n\nDNS properties for\nthe private DNS namespace.\n*Required*: No\n*Type*: [PrivateDnsPropertiesMutable](./aws-properties-servicediscovery-privatednsnamespace-privatednspropertiesmutable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-properties.html#cfn-servicediscovery-privatednsnamespace-properties-dnsproperties", "UpdateType": "Mutable" } } }, "AWS::ServiceDiscovery::PrivateDnsNamespace.SOA": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::PrivateDnsNamespace.SOA`\n\nStart of Authority\n(SOA) properties for a public or private DNS namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-soa.html", "Properties": { "TTL": { "Required": false, "MarkdownDocumentation": "`TTL`\n\nThe time to live\n(TTL) for purposes of negative caching.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-soa.html#cfn-servicediscovery-privatednsnamespace-soa-ttl", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::ServiceDiscovery::PublicDnsNamespace.Properties": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::PublicDnsNamespace.Properties`\n\nProperties for the\npublic DNS namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-publicdnsnamespace-properties.html", "Properties": { "DnsProperties": { "Type": "PublicDnsPropertiesMutable", "Required": false, "MarkdownDocumentation": "`DnsProperties`\n\nDNS properties for\nthe public DNS namespace.\n*Required*: No\n*Type*: [PublicDnsPropertiesMutable](./aws-properties-servicediscovery-publicdnsnamespace-publicdnspropertiesmutable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-publicdnsnamespace-properties.html#cfn-servicediscovery-publicdnsnamespace-properties-dnsproperties", "UpdateType": "Mutable" } } }, "AWS::ServiceDiscovery::PublicDnsNamespace.PublicDnsPropertiesMutable": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::PublicDnsNamespace.PublicDnsPropertiesMutable`\n\nDNS properties for\nthe public DNS namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-publicdnsnamespace-publicdnspropertiesmutable.html", "Properties": { "SOA": { "Type": "SOA", "Required": false, "MarkdownDocumentation": "`SOA`\n\nStart of Authority\n(SOA) record for the hosted zone for the public DNS namespace.\n*Required*: No\n*Type*: [SOA](./aws-properties-servicediscovery-publicdnsnamespace-soa.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-publicdnsnamespace-publicdnspropertiesmutable.html#cfn-servicediscovery-publicdnsnamespace-publicdnspropertiesmutable-soa", "UpdateType": "Mutable" } } }, "AWS::ServiceDiscovery::PublicDnsNamespace.SOA": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::PublicDnsNamespace.SOA`\n\nStart of Authority\n(SOA) properties for a public or private DNS namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-publicdnsnamespace-soa.html", "Properties": { "TTL": { "Required": false, "MarkdownDocumentation": "`TTL`\n\nThe time to live\n(TTL) for purposes of negative caching.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-publicdnsnamespace-soa.html#cfn-servicediscovery-publicdnsnamespace-soa-ttl", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::ServiceDiscovery::Service.DnsConfig": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::Service.DnsConfig`\n\nA complex type that contains information about the Amazon Route\u00a053 DNS records that you want\nAWS Cloud Map to create when you register an instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html", "Properties": { "DnsRecords": { "Type": "List", "Required": true, "MarkdownDocumentation": "`DnsRecords`\n\nAn array that contains one `DnsRecord` object for each Route\u00a053 DNS record\nthat you want AWS Cloud Map to create when you register an instance.\n###### Important\nThe record type of a service can't be updated directly and can only be changed by\ndeleting the service and recreating it with a new `DnsConfig`.\n*Required*: Yes\n*Type*: Array of [DnsRecord](./aws-properties-servicediscovery-service-dnsrecord.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-dnsrecords", "ItemType": "DnsRecord", "UpdateType": "Mutable" }, "RoutingPolicy": { "Required": false, "MarkdownDocumentation": "`RoutingPolicy`\n\nThe routing policy that you want to apply to all Route\u00a053 DNS records that AWS Cloud Map creates\nwhen you register an instance and specify this service.\n###### Note\nIf you want to use this service to register instances that create alias records, specify\n`WEIGHTED` for the routing policy.\nYou can specify the following values:\nMULTIVALUE\nIf you define a health check for the service and the health check is healthy, Route\u00a053\nreturns the applicable value for up to eight instances.\nFor example, suppose that the service includes configurations for one `A`\nrecord and a health check. You use the service to register 10 instances. Route\u00a053 responds to DNS\nqueries with IP addresses for up to eight healthy instances. If fewer than eight instances are\nhealthy, Route\u00a053 responds to every DNS query with the IP addresses for all of the healthy\ninstances.\nIf you don't define a health check for the service, Route\u00a053 assumes that all instances are\nhealthy and returns the values for up to eight instances.\nFor more information about the multivalue routing policy, see [Multivalue\nAnswer Routing](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue) in the *Route\u00a053 Developer Guide*.\n\nWEIGHTED\nRoute\u00a053 returns the applicable value from one randomly selected instance from among the\ninstances that you registered using the same service. Currently, all records have the same\nweight, so you can't route more or less traffic to any instances.\nFor example, suppose that the service includes configurations for one `A`\nrecord and a health check. You use the service to register 10 instances. Route\u00a053 responds to DNS\nqueries with the IP address for one randomly selected instance from among the healthy\ninstances. If no instances are healthy, Route\u00a053 responds to DNS queries as if all of the\ninstances were healthy.\nIf you don't define a health check for the service, Route\u00a053 assumes that all instances are\nhealthy and returns the applicable value for one randomly selected instance.\nFor more information about the weighted routing policy, see [Weighted\nRouting](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted) in the *Route\u00a053 Developer Guide*.\n\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTIVALUE | WEIGHTED...`\n*Update requires*: Updates are not supported.", "RefReturnValue": "", "AllowedValues": [ "MULTIVALUE", "WEIGHTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-routingpolicy", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NamespaceId": { "Required": false, "MarkdownDocumentation": "`NamespaceId`\n\n*Use\nNamespaceId in [Service](https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html) instead.*\nThe ID of the namespace to use for DNS configuration.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-namespaceid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::ServiceDiscovery::Service.DnsRecord": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::Service.DnsRecord`\n\nA complex type that contains information about the Route\u00a053 DNS records that you want\nAWS Cloud Map to create when you register an instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of the resource, which indicates the type of value that Route 53 returns in\nresponse to DNS queries. You can specify values for `Type` in the following\ncombinations:\n* `A`\n* `AAAA`\n* `A` and `AAAA`\n* `SRV`\n* `CNAME`\nIf you want AWS Cloud Map to create a Route 53 alias record when you register an\ninstance, specify `A` or `AAAA` for `Type`.\nYou specify other settings, such as the IP address for `A` and\n`AAAA` records, when you register an instance. For more information, see\n[RegisterInstance](https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html).\nThe following values are supported:\nA\nRoute 53 returns the IP address of the resource in IPv4 format, such as\n192.0.2.44.\n\nAAAA\nRoute 53 returns the IP address of the resource in IPv6 format, such as\n2001:0db8:85a3:0000:0000:abcd:0001:2345.\n\nCNAME\nRoute 53 returns the domain name of the resource, such as www.example.com. Note\nthe following:\n* You specify the domain name that you want to route traffic to when you\n register an instance. For more information, see [Attributes](https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes) in the topic [RegisterInstance](https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html).\n* You must specify `WEIGHTED` for the value of\n `RoutingPolicy`.\n* You can't specify both `CNAME` for `Type` and\n settings for `HealthCheckConfig`. If you do, the request will\n fail with an `InvalidInput` error.\n\nSRV\nRoute 53 returns the value for an `SRV` record. The value for an\n`SRV` record uses the following values:\n`priority weight port service-hostname`\nNote the following about the values:\n* The values of `priority` and `weight` are both set\n to `1` and can't be changed.\n* The value of `port` comes from the value that you specify for\n the `AWS_INSTANCE_PORT` attribute when you submit a [RegisterInstance](https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) request.\n* The value of `service-hostname` is a concatenation of the\n following values:\n \n + The value that you specify for `InstanceId` when you\n register an instance.\n + The name of the service.\n + The name of the namespace.\n \n For example, if the value of `InstanceId` is\n `test`, the name of the service is `backend`, and the\n name of the namespace is `example.com`, the value of\n `service-hostname` is:\n \n `test.backend.example.com`\nIf you specify settings for an `SRV` record and if you specify\nvalues for `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both\nin the `RegisterInstance` request, AWS Cloud Map automatically\ncreates `A` and/or `AAAA` records that have the same name as\nthe value of `service-hostname` in the `SRV` record. You can\nignore these records.\n\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SRV | A | AAAA | CNAME...`\n*Update requires*: Updates are not supported.", "RefReturnValue": "", "AllowedValues": [ "SRV", "A", "AAAA", "CNAME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html#cfn-servicediscovery-service-dnsrecord-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TTL": { "Required": true, "MarkdownDocumentation": "`TTL`\n\nThe amount of time, in seconds, that you want DNS resolvers to cache the settings for this\nrecord.\n###### Note\nAlias records don't include a TTL because Route\u00a053 uses the TTL for the AWS resource that an\nalias record routes traffic to. If you include the `AWS_ALIAS_DNS_NAME` attribute\nwhen you submit a [RegisterInstance](https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) request, the\n`TTL` value is ignored. Always specify a TTL for the service; you can use a service\nto register instances that create either alias or non-alias records.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html#cfn-servicediscovery-service-dnsrecord-ttl", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::ServiceDiscovery::Service.HealthCheckConfig": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::Service.HealthCheckConfig`\n\n*Public DNS and HTTP namespaces only.* A complex type that contains\nsettings for an optional health check. If you specify settings for a health check, AWS Cloud Map\nassociates the health check with the records that you specify in `DnsConfig`.\n###### Important\nIf you specify a health check configuration, you can specify either\n`HealthCheckCustomConfig` or `HealthCheckConfig` but not both.\nHealth checks are basic Route\u00a053 health checks that monitor an AWS endpoint. For\ninformation about pricing for health checks, see [Amazon Route\u00a053 Pricing](https://aws.amazon.com/route53/pricing/).\nNote the following about configuring health checks.\nA and AAAA records\nIf `DnsConfig` includes configurations for both `A` and\n`AAAA` records, AWS Cloud Map creates a health check that uses the IPv4 address to\ncheck the health of the resource. If the endpoint tthat's specified by the IPv4 address is\nunhealthy, Route\u00a053 considers both the `A` and `AAAA` records to be\nunhealthy.\n\nCNAME records\nYou can't specify settings for `HealthCheckConfig` when the\n`DNSConfig` includes `CNAME` for the value of `Type`. If you\ndo, the `CreateService` request will fail with an `InvalidInput`\nerror.\n\nRequest interval\nA Route\u00a053 health checker in each health-checking AWS Region sends a health check request\nto an endpoint every 30 seconds. On average, your endpoint receives a health check request\nabout every two seconds. However, health checkers don't coordinate with one another.\nTherefore, you might sometimes see several requests in one second that's followed by a few\nseconds with no health checks at all.\n\nHealth checking regions\nHealth checkers perform checks from all Route\u00a053 health-checking Regions. For a list of the\ncurrent Regions, see [Regions](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions).\n\nAlias records\nWhen you register an instance, if you include the `AWS_ALIAS_DNS_NAME`\nattribute, AWS Cloud Map creates a Route\u00a053 alias record. Note the following:\n* Route\u00a053 automatically sets `EvaluateTargetHealth` to true for alias records.\n When `EvaluateTargetHealth` is true, the alias record inherits the health of the\n referenced AWS resource. such as an ELB load balancer. For more information, see [EvaluateTargetHealth](https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth).\n* If you include `HealthCheckConfig` and then use the service to register an\n instance that creates an alias record, Route\u00a053 doesn't create the health check.\n\nCharges for health checks\nHealth checks are basic Route\u00a053 health checks that monitor an AWS endpoint. For\ninformation about pricing for health checks, see [Amazon Route\u00a053 Pricing](https://aws.amazon.com/route53/pricing/).\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of health check that you want to create, which indicates how Route\u00a053 determines\nwhether an endpoint is healthy.\n###### Important\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\u00a053 tries to establish a TCP connection. If\n successful, Route\u00a053 submits an HTTP request and waits for an HTTP status code of 200 or greater\n and less than 400.\n* **HTTPS**: Route\u00a053 tries to establish a TCP connection. If\n successful, Route\u00a053 submits an HTTPS request and waits for an HTTP status code of 200 or greater\n and less than 400.\n \n ###### Important\n \n If you specify HTTPS for the value of `Type`, the endpoint must support TLS\n v1.0 or later.\n* **TCP**: Route\u00a053 tries to establish a TCP connection.\n \n If you specify `TCP` for `Type`, don't specify a value for\n `ResourcePath`.\nFor more information, see [How Route\u00a053\nDetermines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the\n*Route\u00a053 Developer Guide*.\n*Required*: Yes\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)", "RefReturnValue": "", "AllowedValues": [ "HTTP", "HTTPS", "TCP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResourcePath": { "Required": false, "MarkdownDocumentation": "`ResourcePath`\n\nThe path that you want Route\u00a053 to request when performing health checks. The path can be any\nvalue that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint\nis healthy. An example file is `/docs/route53-health-check.html`. Route\u00a053 automatically\nadds the DNS name for the service. If you don't specify a value for `ResourcePath`,\nthe default value is `/`.\nIf you specify `TCP` for `Type`, you must *not*\nspecify a value for `ResourcePath`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-resourcepath", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FailureThreshold": { "Required": false, "MarkdownDocumentation": "`FailureThreshold`\n\nThe number of consecutive health checks that an endpoint must pass or fail for Route\u00a053 to\nchange the current status of the endpoint from unhealthy to healthy or the other way around. For\nmore information, see [How Route\u00a053\nDetermines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the\n*Route\u00a053 Developer Guide*.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-failurethreshold", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::ServiceDiscovery::Service.HealthCheckCustomConfig": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::Service.HealthCheckCustomConfig`\n\nA complex type that contains information about an optional custom health check. A custom\nhealth check, which requires that you use a third-party health checker to evaluate the health of\nyour resources, is useful in the following circumstances:\n* You can't use a health check that's defined by `HealthCheckConfig` because the\n resource isn't available over the internet. For example, you can use a custom health check when\n the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health\n checker must also be in the VPC.)\n* You want to use a third-party health checker regardless of where your resources are\n located.\n###### Important\nIf you specify a health check configuration, you can specify either\n`HealthCheckCustomConfig` or `HealthCheckConfig` but not both.\nTo change the status of a custom health check, submit an\n`UpdateInstanceCustomHealthStatus` request. AWS Cloud Map doesn't monitor the status of the\nresource, it just keeps a record of the status specified in the most recent\n`UpdateInstanceCustomHealthStatus` request.\nHere's how custom health checks work:\n1. You create a service.\n2. You register an instance.\n3. You configure a third-party health checker to monitor the resource that's associated with\n the new instance.\n \n ###### Note\n \n AWS Cloud Map doesn't check the health of the resource directly.\n4. The third-party health-checker determines that the resource is unhealthy and notifies your\n application.\n5. Your application submits an `UpdateInstanceCustomHealthStatus` request.\n6. AWS Cloud Map waits for 30 seconds.\n7. If another `UpdateInstanceCustomHealthStatus` request doesn't arrive during\n that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the\n resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckcustomconfig.html", "Properties": { "FailureThreshold": { "Required": false, "MarkdownDocumentation": "`FailureThreshold`\n\n###### Important\nThis parameter is no longer supported and is always set to 1. AWS Cloud Map waits for\napproximately 30 seconds after receiving an `UpdateInstanceCustomHealthStatus`\nrequest before changing the status of the service instance.\nThe number of 30-second intervals that you want AWS Cloud Map to wait after receiving an\n`UpdateInstanceCustomHealthStatus` request before it changes the health status of a\nservice instance.\nSending a second or subsequent `UpdateInstanceCustomHealthStatus` request with\nthe same value before 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits\n`30` seconds after the first request to make the change.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckcustomconfig.html#cfn-servicediscovery-service-healthcheckcustomconfig-failurethreshold", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::Shield::ProactiveEngagement.EmergencyContact": { "MarkdownDocumentation": "`AWS::Shield::ProactiveEngagement.EmergencyContact`\n\nContact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-proactiveengagement-emergencycontact.html", "Properties": { "ContactNotes": { "MarkdownDocumentation": "`ContactNotes`\n\nAdditional notes regarding the contact.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\s\\.\\-,:/()+@]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-proactiveengagement-emergencycontact.html#cfn-shield-proactiveengagement-emergencycontact-contactnotes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PhoneNumber": { "MarkdownDocumentation": "`PhoneNumber`\n\nThe phone number for the contact.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\+[1-9]\\d{1,14}$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-proactiveengagement-emergencycontact.html#cfn-shield-proactiveengagement-emergencycontact-phonenumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EmailAddress": { "MarkdownDocumentation": "`EmailAddress`\n\nThe email address for the contact.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\S+@\\S+\\.\\S+$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-proactiveengagement-emergencycontact.html#cfn-shield-proactiveengagement-emergencycontact-emailaddress", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Shield::Protection.Action": { "MarkdownDocumentation": "`AWS::Shield::Protection.Action`\n\nSpecifies the action setting that Shield Advanced should use in the AWS WAF rules that it creates on behalf of the\nprotected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,\nwhen you enable or update automatic mitigation. Shield Advanced creates the AWS WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-protection-action.html", "Properties": { "Block": { "MarkdownDocumentation": "`Block`\n\nSpecifies that Shield Advanced should configure its AWS WAF rules with the AWS WAF`Block` action.\nYou must specify exactly one action, either `Block` or `Count`.\nExample JSON: `{ \"Block\": {} }`\nExample YAML: `Block: {}`\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-protection-action.html#cfn-shield-protection-action-block", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Count": { "MarkdownDocumentation": "`Count`\n\nSpecifies that Shield Advanced should configure its AWS WAF rules with the AWS WAF`Count` action.\nYou must specify exactly one action, either `Block` or `Count`.\nExample JSON: `{ \"Count\": {} }`\nExample YAML: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-protection-action.html#cfn-shield-protection-action-count", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::Shield::Protection.ApplicationLayerAutomaticResponseConfiguration": { "MarkdownDocumentation": "`AWS::Shield::Protection.ApplicationLayerAutomaticResponseConfiguration`\n\nThe automatic application layer DDoS mitigation settings for a [AWS::Shield::Protection](./aws-resource-shield-protection.html).\nThis configuration determines whether Shield Advanced automatically\nmanages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.\nIf you use CloudFormation to manage the web ACLs that you use with Shield Advanced automatic mitigation, see the guidance\nfor the `AWS::WAFv2::WebACL` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-protection-applicationlayerautomaticresponseconfiguration.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nIndicates whether automatic application layer DDoS mitigation is enabled for the protection.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-protection-applicationlayerautomaticresponseconfiguration.html#cfn-shield-protection-applicationlayerautomaticresponseconfiguration-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nSpecifies the action setting that Shield Advanced should use in the AWS WAF rules that it creates on behalf of the\nprotected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,\nwhen you enable or update automatic mitigation. Shield Advanced creates the AWS WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.\n*Required*: Yes\n*Type*: [Action](./aws-properties-shield-protection-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-protection-applicationlayerautomaticresponseconfiguration.html#cfn-shield-protection-applicationlayerautomaticresponseconfiguration-action", "UpdateType": "Mutable", "Required": true, "Type": "Action" } } }, "AWS::Signer::SigningProfile.SignatureValidityPeriod": { "MarkdownDocumentation": "`AWS::Signer::SigningProfile.SignatureValidityPeriod`\n\nThe validity period for the signing job.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingprofile-signaturevalidityperiod.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe time unit for signature validity: DAYS | MONTHS | YEARS.\n*Required*: No\n*Type*: String\n*Allowed values*: `DAYS | MONTHS | YEARS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DAYS", "MONTHS", "YEARS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingprofile-signaturevalidityperiod.html#cfn-signer-signingprofile-signaturevalidityperiod-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingprofile-signaturevalidityperiod.html#cfn-signer-signingprofile-signaturevalidityperiod-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::SimSpaceWeaver::Simulation.S3Location": { "MarkdownDocumentation": "`AWS::SimSpaceWeaver::Simulation.S3Location`\n\nA location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip\nfiles and schema file. For more information about Amazon S3, see the [*Amazon Simple Storage Service User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simspaceweaver-simulation-s3location.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of an Amazon S3 bucket. For more information about buckets, see [Creating,\nconfiguring, 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\nGuide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_\\-]{3,63}$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simspaceweaver-simulation-s3location.html#cfn-simspaceweaver-simulation-s3location-bucketname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ObjectKey": { "MarkdownDocumentation": "`ObjectKey`\n\nThe key name of an object in Amazon S3. For more information about Amazon S3 objects and object\nkeys, see [Uploading,\ndownloading, 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\nGuide*.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simspaceweaver-simulation-s3location.html#cfn-simspaceweaver-simulation-s3location-objectkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::StepFunctions::Activity.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::StepFunctions::Activity.EncryptionConfiguration`\n\nSettings to configure server-side encryption for an activity. By default, Step Functions provides transparent server-side encryption. With this configuration, you can specify a customer managed AWS KMS key for encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nEncryption option for an activity.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CUSTOMER_MANAGED_KMS_KEY | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nAn alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KmsDataKeyReusePeriodSeconds": { "MarkdownDocumentation": "`KmsDataKeyReusePeriodSeconds`\n\nMaximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call `GenerateDataKey`. Only applies to customer managed keys.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `900`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-kmsdatakeyreuseperiodseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::StepFunctions::Activity.TagsEntry": { "MarkdownDocumentation": "`AWS::StepFunctions::Activity.TagsEntry`\n\nThe `TagsEntry` property specifies *tags* to identify an\nactivity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe `value` for a key-value pair in a tag entry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html#cfn-stepfunctions-activity-tagsentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe `key` for a key-value pair in a tag entry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html#cfn-stepfunctions-activity-tagsentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::StepFunctions::StateMachine.CloudWatchLogsLogGroup": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachine.CloudWatchLogsLogGroup`\n\nDefines a CloudWatch log group.\n###### Note\nFor more information see [Standard Versus\nExpress Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-standard-vs-express.html) in the AWS Step Functions Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-cloudwatchlogsloggroup.html", "Properties": { "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN\nmust end with `:*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-cloudwatchlogsloggroup.html#cfn-stepfunctions-statemachine-cloudwatchlogsloggroup-loggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::StepFunctions::StateMachine.EncryptionConfiguration": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachine.EncryptionConfiguration`\n\nSettings to configure server-side encryption for a state machine. By default, Step Functions provides transparent server-side encryption. With this configuration, you can specify a customer managed AWS KMS key for encryption.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nEncryption option for a state machine.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CUSTOMER_MANAGED_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)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.html#cfn-stepfunctions-statemachine-encryptionconfiguration-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nAn alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.html#cfn-stepfunctions-statemachine-encryptionconfiguration-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsDataKeyReusePeriodSeconds": { "MarkdownDocumentation": "`KmsDataKeyReusePeriodSeconds`\n\nMaximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call `GenerateDataKey`. Only applies to customer managed keys.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.html#cfn-stepfunctions-statemachine-encryptionconfiguration-kmsdatakeyreuseperiodseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::StepFunctions::StateMachine.LogDestination": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachine.LogDestination`\n\nDefines a destination for `LoggingConfiguration`.\n###### Note\nFor more information on logging with `EXPRESS` workflows, see [Logging Express\nWorkflows Using CloudWatch Logs](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination.html", "Properties": { "CloudWatchLogsLogGroup": { "MarkdownDocumentation": "`CloudWatchLogsLogGroup`\n\nAn object describing a CloudWatch log group. For more information, see [AWS::Logs::LogGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) in the CloudFormation User Guide.\n*Required*: No\n*Type*: [CloudWatchLogsLogGroup](./aws-properties-stepfunctions-statemachine-cloudwatchlogsloggroup.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination.html#cfn-stepfunctions-statemachine-logdestination-cloudwatchlogsloggroup", "UpdateType": "Mutable", "Required": false, "Type": "CloudWatchLogsLogGroup" } } }, "AWS::StepFunctions::StateMachine.LoggingConfiguration": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachine.LoggingConfiguration`\n\nDefines what execution history events are logged and where they are logged.\nStep Functions provides the log levels \u2014 `OFF`, `ALL`, `ERROR`, and `FATAL`. No event types log when set to `OFF` and all event types do when set to `ALL`.\n###### Note\nBy default, the `level` is set to `OFF`. For more information see\n[Log\nLevels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html", "Properties": { "IncludeExecutionData": { "MarkdownDocumentation": "`IncludeExecutionData`\n\nDetermines whether execution data is included in your log. When set to `false`,\ndata is excluded.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-includeexecutiondata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nAn array of objects that describes where your execution history events will be logged.\nLimited to size 1. Required, if your log level is not set to `OFF`.\n*Required*: No\n*Type*: Array of [LogDestination](./aws-properties-stepfunctions-statemachine-logdestination.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-destinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LogDestination", "DuplicatesAllowed": true }, "Level": { "MarkdownDocumentation": "`Level`\n\nDefines which category of execution history events are logged.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL | ERROR | FATAL | OFF...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL", "ERROR", "FATAL", "OFF" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-level", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::StepFunctions::StateMachine.S3Location": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachine.S3Location`\n\nDefines the S3 bucket location where a state machine definition is stored. The state machine definition must be a JSON or YAML file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the S3 bucket where the state machine definition JSON or YAML file is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-bucket", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nFor versioning-enabled buckets, a specific version of the state machine\ndefinition.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name of the state machine definition file (Amazon S3 object 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::StepFunctions::StateMachine.TagsEntry": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachine.TagsEntry`\n\nThe `TagsEntry` property specifies *tags* to identify a\nstate machine.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe `value` for a key-value pair in a tag entry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html#cfn-stepfunctions-statemachine-tagsentry-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe `key` for a key-value pair in a tag entry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html#cfn-stepfunctions-statemachine-tagsentry-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::StepFunctions::StateMachine.TracingConfiguration": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachine.TracingConfiguration`\n\nSelects whether or not the state machine's AWS X-Ray tracing is enabled. To configure\nyour state machine to send trace data to X-Ray, set `Enabled` to\n`true`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tracingconfiguration.html", "Properties": { "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tracingconfiguration.html#cfn-stepfunctions-statemachine-tracingconfiguration-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::StepFunctions::StateMachineAlias.DeploymentPreference": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachineAlias.DeploymentPreference`\n\nEnables gradual state machine deployments.\nCloudFormation\nautomatically shifts traffic from the version the alias currently points to, to a new state machine version that you specify.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of deployment you want to perform. You can specify one of the following types:\n* `LINEAR` - Shifts traffic to the new version in equal increments with an equal number of minutes between each increment.\n \n For example, if you specify the increment percent as `20` with an interval of `600` minutes, this deployment increases traffic by 20 percent every 600 minutes until the new version receives 100 percent of the traffic.\n This deployment immediately rolls back the new version if any\n CloudWatch\n alarms are triggered.\n* `ALL_AT_ONCE` - Shifts 100 percent of traffic to the new version immediately.\n CloudFormation\n monitors the new version and rolls it back automatically to the previous version if any\n CloudWatch\n alarms are triggered.\n* `CANARY` - Shifts traffic in two increments.\n \n In the first increment, a small percentage of traffic, for example, 10 percent is shifted to the new version. In the second increment, before a specified time interval in seconds gets over, the remaining traffic is shifted to the new version. The shift to the new version for the remaining traffic takes place only if no\n CloudWatch\n alarms are triggered during the specified time interval.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LINEAR | ALL_AT_ONCE | CANA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LINEAR", "ALL_AT_ONCE", "CANARY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StateMachineVersionArn": { "MarkdownDocumentation": "`StateMachineVersionArn`\n\nThe Amazon Resource Name (ARN) of the [`AWS::StepFunctions::StateMachineVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachineversion.html) resource that will be the final version to which the alias points to when the traffic shifting is complete.\nWhile performing gradual deployments, you can only provide a single state machine version ARN. To explicitly set version weights in a\nCloudFormation\ntemplate, use `RoutingConfiguration` instead.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-statemachineversionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Percentage": { "MarkdownDocumentation": "`Percentage`\n\nThe percentage of traffic to shift to the new version in each increment.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `99`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-percentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Alarms": { "MarkdownDocumentation": "`Alarms`\n\nA list of\nAmazon CloudWatch\nalarm names to be monitored during the deployment. The deployment fails and rolls back if any of these alarms go into the `ALARM` state.\n###### Important\nAmazon CloudWatch\nconsiders nonexistent alarms to have an `OK` state. If you provide an invalid alarm name or provide the ARN of an alarm instead of its name, your deployment may not roll back correctly.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `256 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-alarms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Interval": { "MarkdownDocumentation": "`Interval`\n\nThe time in minutes between each traffic shifting increment.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `2100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-interval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::StepFunctions::StateMachineAlias.RoutingConfigurationVersion": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachineAlias.RoutingConfigurationVersion`\n\nThe state machine version to which you want to route the execution traffic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-routingconfigurationversion.html", "Properties": { "StateMachineVersionArn": { "MarkdownDocumentation": "`StateMachineVersionArn`\n\nThe Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.\nIf you specify the ARN of a second version, it must belong to the same state machine as the first version.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-routingconfigurationversion.html#cfn-stepfunctions-statemachinealias-routingconfigurationversion-statemachineversionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\nThe percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-routingconfigurationversion.html#cfn-stepfunctions-statemachinealias-routingconfigurationversion-weight", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Synthetics::Canary.ArtifactConfig": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.ArtifactConfig`\n\nA structure that contains the configuration for canary artifacts,\nincluding the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-artifactconfig.html", "Properties": { "S3Encryption": { "MarkdownDocumentation": "`S3Encryption`\n\nA structure that contains the configuration\nof the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.\nArtifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3\nor later. For more information, see\n[Encrypting canary artifacts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html).\n*Required*: No\n*Type*: [S3Encryption](./aws-properties-synthetics-canary-s3encryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-artifactconfig.html#cfn-synthetics-canary-artifactconfig-s3encryption", "UpdateType": "Mutable", "Required": false, "Type": "S3Encryption" } } }, "AWS::Synthetics::Canary.BaseScreenshot": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.BaseScreenshot`\n\nA structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html", "Properties": { "IgnoreCoordinates": { "MarkdownDocumentation": "`IgnoreCoordinates`\n\nCoordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the\nCloudWatch console to draw the boundaries on the screen. For more information, see\n[Edit or delete a canary](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html#cfn-synthetics-canary-basescreenshot-ignorecoordinates", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ScreenshotName": { "MarkdownDocumentation": "`ScreenshotName`\n\nThe name of the screenshot. This is generated the first time the canary is run after the `UpdateCanary` operation that\nspecified for this canary to perform visual monitoring.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html#cfn-synthetics-canary-basescreenshot-screenshotname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Synthetics::Canary.BrowserConfig": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.BrowserConfig`\n\nA structure that specifies the browser type to use for a canary run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-browserconfig.html", "Properties": { "BrowserType": { "MarkdownDocumentation": "`BrowserType`\n\nThe browser type associated with this browser configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CHROME | FIREFOX...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CHROME", "FIREFOX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-browserconfig.html#cfn-synthetics-canary-browserconfig-browsertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Synthetics::Canary.Code": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.Code`\n\nUse this structure to input your script code for the canary. This structure contains the\nLambda handler with the location where the canary should start running the script. If the\nscript is stored in an S3 bucket, the bucket name, key, and version are also included. If\nthe script is passed into the canary directly, the script code is contained in the value\nof `Script`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html", "Properties": { "Script": { "MarkdownDocumentation": "`Script`\n\nIf you input your canary script directly into the canary instead of referring to an S3\nlocation, the value of this parameter is the script in plain text. It can be\nup to 5 MB.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-script", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3ObjectVersion": { "MarkdownDocumentation": "`S3ObjectVersion`\n\nThe Amazon S3 version ID of your script.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3objectversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Bucket": { "MarkdownDocumentation": "`S3Bucket`\n\nIf your canary script is located in S3, specify the bucket name here. The bucket\nmust already exist.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3bucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Key": { "MarkdownDocumentation": "`S3Key`\n\nThe Amazon S3 key of your script. For more information, see [Working with Amazon S3 Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html).\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlueprintTypes": { "MarkdownDocumentation": "`BlueprintTypes`\n\n`BlueprintTypes` are a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. `multi-checks` is the only supported value.\nWhen you specify `BlueprintTypes`, the `Handler` field cannot be specified since the blueprint provides a pre-defined entry point.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-blueprinttypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Handler": { "MarkdownDocumentation": "`Handler`\n\nThe entry point to use for the source code when running the canary. For canaries that use the\n`syn-python-selenium-1.0` runtime\nor a `syn-nodejs.puppeteer` runtime earlier than `syn-nodejs.puppeteer-3.4`,\nthe handler must be specified as `fileName.handler`. For\n`syn-python-selenium-1.1`, `syn-nodejs.puppeteer-3.4`, and later runtimes, the handler can be specified as\n`fileName.functionName`, or\nyou can specify a folder where canary scripts reside as\n`folder/fileName.functionName`.\nThis field is required when you don't specify `BlueprintTypes` and is not allowed when you specify `BlueprintTypes`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^(([0-9a-zA-Z_-]+(\\/|\\.))*[0-9A-Za-z_\\\\-]+(\\.|::)[A-Za-z_][A-Za-z0-9_]*)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-handler", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceLocationArn": { "MarkdownDocumentation": "`SourceLocationArn`\n\nThe ARN of the Lambda layer where Synthetics stores the canary script 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-sourcelocationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dependencies": { "MarkdownDocumentation": "`Dependencies`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Dependency](./aws-properties-synthetics-canary-dependency.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-dependencies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Dependency", "DuplicatesAllowed": true } } }, "AWS::Synthetics::Canary.Dependency": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.Dependency`\n\nA structure that contains information about a dependency for a canary.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-dependency.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of dependency. Valid value is `LambdaLayer`.\n*Required*: No\n*Type*: String\n*Allowed values*: `LambdaLayer...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LambdaLayer" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-dependency.html#cfn-synthetics-canary-dependency-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Reference": { "MarkdownDocumentation": "`Reference`\n\nThe dependency reference. For Lambda layers, this is the ARN of the Lambda layer. For more information\nabout Lambda ARN format, see [Lambda](https://docs.aws.amazon.com/lambda/latest/api/API_Layer.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-dependency.html#cfn-synthetics-canary-dependency-reference", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Synthetics::Canary.RetryConfig": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.RetryConfig`\n\nThe canary's retry configuration information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-retryconfig.html", "Properties": { "MaxRetries": { "MarkdownDocumentation": "`MaxRetries`\n\nThe maximum number of retries. The value must be less than or equal to two.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-retryconfig.html#cfn-synthetics-canary-retryconfig-maxretries", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Synthetics::Canary.RunConfig": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.RunConfig`\n\nA structure that contains input information for a canary run. This structure\nis required.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html", "Properties": { "TimeoutInSeconds": { "MarkdownDocumentation": "`TimeoutInSeconds`\n\nHow long the canary is allowed to run before it must stop. You can't set this time to be longer\nthan the frequency of the runs of this canary.\nIf you omit this field, the\nfrequency of the canary is used as this value, up to a maximum of 900 seconds.\n*Required*: No\n*Type*: Integer\n*Minimum*: `3`\n*Maximum*: `840`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-timeoutinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnvironmentVariables": { "MarkdownDocumentation": "`EnvironmentVariables`\n\nSpecifies the keys and values to use for any environment variables\nused in the canary script. Use the following format:\n{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}\nKeys must start with a letter and be at least two characters. The total size\nof your environment variables cannot exceed 4 KB. You can't specify any Lambda\nreserved environment variables as the keys for your environment variables. For\nmore information about reserved keys, see [Runtime environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime).\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-environmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "MemoryInMB": { "MarkdownDocumentation": "`MemoryInMB`\n\nThe maximum amount of memory that the\ncanary can use while running. This value must be a multiple of 64. The range is 960 to 3008.\n*Required*: No\n*Type*: Integer\n*Minimum*: `960`\n*Maximum*: `3008`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-memoryinmb", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EphemeralStorage": { "MarkdownDocumentation": "`EphemeralStorage`\n\nSpecifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3\nbucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-ephemeralstorage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ActiveTracing": { "MarkdownDocumentation": "`ActiveTracing`\n\nSpecifies whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing\nenables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the\ncanary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing\nincurs charges. For more information, see\n[Canaries and X-Ray tracing](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html).\nYou can enable active tracing only for canaries that use version `syn-nodejs-2.0` or later\nfor their canary runtime.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-activetracing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::Synthetics::Canary.S3Encryption": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.S3Encryption`\n\nA structure that contains the configuration\nof the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.\nArtifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3\nor later. For more information, see\n[Encrypting canary artifacts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the customer-managed AWS KMS key to use, if you specify `SSE-KMS`\nfor `EncryptionMode`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html#cfn-synthetics-canary-s3encryption-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionMode": { "MarkdownDocumentation": "`EncryptionMode`\n\nThe encryption method to use\nfor artifacts created by this canary. Specify `SSE_S3` to use\nserver-side encryption (SSE) with an Amazon S3-managed\nkey. Specify `SSE-KMS` to use server-side encryption with a customer-managed AWS KMS key.\nIf you omit this parameter, an\nAWS-managed AWS KMS key 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html#cfn-synthetics-canary-s3encryption-encryptionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Synthetics::Canary.Schedule": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.Schedule`\n\nThis structure specifies how often a canary is to make runs and the date and time\nwhen it should stop making runs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html", "Properties": { "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nHow long, in seconds, for the canary to continue making regular runs according to\nthe schedule in the `Expression` value. If you specify 0, the canary continues\nmaking runs until you stop it. If you omit this field, the default of 0 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html#cfn-synthetics-canary-schedule-durationinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RetryConfig": { "MarkdownDocumentation": "`RetryConfig`\n\nThe canary's retry configuration information.\n*Required*: No\n*Type*: [RetryConfig](./aws-properties-synthetics-canary-retryconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html#cfn-synthetics-canary-schedule-retryconfig", "UpdateType": "Mutable", "Required": false, "Type": "RetryConfig" }, "Expression": { "MarkdownDocumentation": "`Expression`\n\nA `rate` expression or a `cron` expression that defines how often the canary is to run.\nFor a rate expression, The syntax is\n`rate(number unit)`. *unit*\ncan be `minute`, `minutes`, or `hour`.\nFor example, `rate(1 minute)` runs the canary once a minute, `rate(10 minutes)` runs it once every\n10 minutes, and `rate(1 hour)` runs it once every hour. You can\nspecify a frequency between `rate(1 minute)` and `rate(1 hour)`.\nSpecifying `rate(0 minute)` or `rate(0 hour)` is a special value\nthat causes the\ncanary to run only once when it is started.\nUse `cron(expression)` to specify a cron\nexpression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see\n[Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html#cfn-synthetics-canary-schedule-expression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Synthetics::Canary.VPCConfig": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.VPCConfig`\n\nIf this canary is to test an endpoint in a VPC, this structure contains\ninformation about the subnet and security groups of the VPC endpoint.\nFor more information, see [Running a Canary in a VPC](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html", "Properties": { "Ipv6AllowedForDualStack": { "MarkdownDocumentation": "`Ipv6AllowedForDualStack`\n\nSet this to `true` to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-ipv6allowedfordualstack", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC where this canary is to run.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-vpcid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of the subnets where this canary is to run.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the security groups for this canary.\n*Required*: Yes\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-securitygroupids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Synthetics::Canary.VisualReference": { "MarkdownDocumentation": "`AWS::Synthetics::Canary.VisualReference`\n\nDefines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this\nparameter, no changes are made to any baseline screenshots that the canary might be using already.\nVisual monitoring is supported only on canaries running the **syn-puppeteer-node-3.2**\nruntime or later. For more information, see [Visual monitoring](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) and [Visual monitoring blueprint](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-visualreference.html", "Properties": { "BaseScreenshots": { "MarkdownDocumentation": "`BaseScreenshots`\n\nAn array of screenshots that are used as the baseline for comparisons during visual monitoring.\n*Required*: No\n*Type*: Array of [BaseScreenshot](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-visualreference.html#cfn-synthetics-canary-visualreference-basescreenshots", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BaseScreenshot", "DuplicatesAllowed": true }, "BrowserType": { "MarkdownDocumentation": "`BrowserType`\n\nThe browser type associated with this visual reference configuration. Valid values are `CHROME` and `FIREFOX`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CHROME | FIREFOX...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CHROME", "FIREFOX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-visualreference.html#cfn-synthetics-canary-visualreference-browsertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseCanaryRunId": { "MarkdownDocumentation": "`BaseCanaryRunId`\n\nSpecifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are\n`nextrun` to use the screenshots from the next run after this update is made, `lastrun` to use the screenshots from the most recent run\nbefore 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-visualreference.html#cfn-synthetics-canary-visualreference-basecanaryrunid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SystemsManagerSAP::Application.ComponentInfo": { "MarkdownDocumentation": "`AWS::SystemsManagerSAP::Application.ComponentInfo`\n\nThis is information about the component of\nyour SAP application, such as Web Dispatcher.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-systemsmanagersap-application-componentinfo.html", "Properties": { "Ec2InstanceId": { "MarkdownDocumentation": "`Ec2InstanceId`\n\nThis is the Amazon EC2 instance on which your SAP component is running.\nAccepted values are alphanumeric.\n*Required*: No\n*Type*: String\n*Pattern*: `^i-[\\w\\d]{8}$|^i-[\\w\\d]{17}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-systemsmanagersap-application-componentinfo.html#cfn-systemsmanagersap-application-componentinfo-ec2instanceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ComponentType": { "MarkdownDocumentation": "`ComponentType`\n\nThis string is the type of the component.\nAccepted value is `WD`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HANA | HANA_NODE | ABAP | A...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "HANA", "HANA_NODE", "ABAP", "ASCS", "DIALOG", "WEBDISP", "WD", "ERS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-systemsmanagersap-application-componentinfo.html#cfn-systemsmanagersap-application-componentinfo-componenttype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Sid": { "MarkdownDocumentation": "`Sid`\n\nThis string is the SAP System ID of the component.\nAccepted values are alphanumeric.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Z][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-systemsmanagersap-application-componentinfo.html#cfn-systemsmanagersap-application-componentinfo-sid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SystemsManagerSAP::Application.Credential": { "MarkdownDocumentation": "`AWS::SystemsManagerSAP::Application.Credential`\n\nThe credentials of your SAP application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-systemsmanagersap-application-credential.html", "Properties": { "SecretId": { "MarkdownDocumentation": "`SecretId`\n\nThe secret ID created in AWS Secrets Manager to store the credentials\nof the SAP application.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?=.{1,100}$).*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-systemsmanagersap-application-credential.html#cfn-systemsmanagersap-application-credential-secretid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the SAP HANA database.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?=.{1,100}$).*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-systemsmanagersap-application-credential.html#cfn-systemsmanagersap-application-credential-databasename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CredentialType": { "MarkdownDocumentation": "`CredentialType`\n\nThe type of the application credentials.\n*Required*: No\n*Type*: String\n*Allowed values*: `ADMIN`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ADMIN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-systemsmanagersap-application-credential.html#cfn-systemsmanagersap-application-credential-credentialtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Timestream::InfluxDBInstance.LogDeliveryConfiguration": { "MarkdownDocumentation": "`AWS::Timestream::InfluxDBInstance.LogDeliveryConfiguration`\n\nConfiguration for sending InfluxDB engine logs to a specified S3 bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-logdeliveryconfiguration.html", "Properties": { "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nConfiguration for S3 bucket log delivery\n*Required*: Yes\n*Type*: [S3Configuration](./aws-properties-timestream-influxdbinstance-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-logdeliveryconfiguration.html#cfn-timestream-influxdbinstance-logdeliveryconfiguration-s3configuration", "UpdateType": "Mutable", "Required": true, "Type": "S3Configuration" } } }, "AWS::Timestream::InfluxDBInstance.S3Configuration": { "MarkdownDocumentation": "`AWS::Timestream::InfluxDBInstance.S3Configuration`\n\nConfiguration for S3 bucket log delivery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-s3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe bucket name of the customer S3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-s3configuration.html#cfn-timestream-influxdbinstance-s3configuration-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether log delivery to the S3 bucket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-s3configuration.html#cfn-timestream-influxdbinstance-s3configuration-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::Timestream::ScheduledQuery.DimensionMapping": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.DimensionMapping`\n\nThis type is used to map column(s) from the query result to a dimension in the destination\ntable.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-dimensionmapping.html", "Properties": { "DimensionValueType": { "MarkdownDocumentation": "`DimensionValueType`\n\nType for the dimension: VARCHAR\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VARCHAR`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "VARCHAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-dimensionmapping.html#cfn-timestream-scheduledquery-dimensionmapping-dimensionvaluetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nColumn name from query result.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-dimensionmapping.html#cfn-timestream-scheduledquery-dimensionmapping-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Timestream::ScheduledQuery.ErrorReportConfiguration": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`\n\nConfiguration required for error reporting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-errorreportconfiguration.html", "Properties": { "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nThe S3 configuration for the error reports.\n*Required*: Yes\n*Type*: [S3Configuration](./aws-properties-timestream-scheduledquery-s3configuration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-errorreportconfiguration.html#cfn-timestream-scheduledquery-errorreportconfiguration-s3configuration", "UpdateType": "Immutable", "Required": true, "Type": "S3Configuration" } } }, "AWS::Timestream::ScheduledQuery.MixedMeasureMapping": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.MixedMeasureMapping`\n\nMixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow\nand multi measures in the derived table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html", "Properties": { "MeasureName": { "MarkdownDocumentation": "`MeasureName`\n\nRefers to the value of measure\\_name in a result row. This field is required if\nMeasureNameColumn is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-measurename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceColumn": { "MarkdownDocumentation": "`SourceColumn`\n\nThis field refers to the source column from which measure-value is to be read for result\nmaterialization.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-sourcecolumn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TargetMeasureName": { "MarkdownDocumentation": "`TargetMeasureName`\n\nTarget measure name to be used. If not provided, the target measure name by default would\nbe measure-name if provided, or sourceColumn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-targetmeasurename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MeasureValueType": { "MarkdownDocumentation": "`MeasureValueType`\n\nType of the value that is to be read from sourceColumn. If the mapping is for MULTI, use\nMeasureValueType.MULTI.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BIGINT | BOOLEAN | DOUBLE |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "BIGINT", "BOOLEAN", "DOUBLE", "VARCHAR", "MULTI" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-measurevaluetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MultiMeasureAttributeMappings": { "MarkdownDocumentation": "`MultiMeasureAttributeMappings`\n\nRequired when measureValueType is MULTI. Attribute mappings for MULTI value\nmeasures.\n*Required*: No\n*Type*: Array of [MultiMeasureAttributeMapping](./aws-properties-timestream-scheduledquery-multimeasureattributemapping.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-multimeasureattributemappings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "MultiMeasureAttributeMapping", "DuplicatesAllowed": true } } }, "AWS::Timestream::ScheduledQuery.MultiMeasureAttributeMapping": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.MultiMeasureAttributeMapping`\n\nAttribute mapping for MULTI value measures.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemapping.html", "Properties": { "SourceColumn": { "MarkdownDocumentation": "`SourceColumn`\n\nSource column from where the attribute value is to be read.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemapping.html#cfn-timestream-scheduledquery-multimeasureattributemapping-sourcecolumn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetMultiMeasureAttributeName": { "MarkdownDocumentation": "`TargetMultiMeasureAttributeName`\n\nCustom name to be used for attribute name in derived table. If not provided, source column\nname would be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemapping.html#cfn-timestream-scheduledquery-multimeasureattributemapping-targetmultimeasureattributename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MeasureValueType": { "MarkdownDocumentation": "`MeasureValueType`\n\nType of the attribute to be read from the source column.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BIGINT | BOOLEAN | DOUBLE |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "BIGINT", "BOOLEAN", "DOUBLE", "VARCHAR", "TIMESTAMP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemapping.html#cfn-timestream-scheduledquery-multimeasureattributemapping-measurevaluetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Timestream::ScheduledQuery.MultiMeasureMappings": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.MultiMeasureMappings`\n\nOnly one of MixedMeasureMappings or MultiMeasureMappings is to be provided.\nMultiMeasureMappings can be used to ingest data as multi measures in the derived table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasuremappings.html", "Properties": { "TargetMultiMeasureName": { "MarkdownDocumentation": "`TargetMultiMeasureName`\n\nThe name of the target multi-measure name in the derived table. This input is required\nwhen measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that\ncolumn will be used as multi-measure 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasuremappings.html#cfn-timestream-scheduledquery-multimeasuremappings-targetmultimeasurename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MultiMeasureAttributeMappings": { "MarkdownDocumentation": "`MultiMeasureAttributeMappings`\n\nRequired. Attribute mappings to be used for mapping query results to ingest data for\nmulti-measure attributes.\n*Required*: Yes\n*Type*: Array of [MultiMeasureAttributeMapping](./aws-properties-timestream-scheduledquery-multimeasureattributemapping.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasuremappings.html#cfn-timestream-scheduledquery-multimeasuremappings-multimeasureattributemappings", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "MultiMeasureAttributeMapping", "DuplicatesAllowed": true } } }, "AWS::Timestream::ScheduledQuery.NotificationConfiguration": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.NotificationConfiguration`\n\nNotification configuration for a scheduled query. A notification is sent by Timestream\nwhen a scheduled query is created, its state is updated or when it is deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-notificationconfiguration.html", "Properties": { "SnsConfiguration": { "MarkdownDocumentation": "`SnsConfiguration`\n\nDetails on SNS configuration.\n*Required*: Yes\n*Type*: [SnsConfiguration](./aws-properties-timestream-scheduledquery-snsconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-notificationconfiguration.html#cfn-timestream-scheduledquery-notificationconfiguration-snsconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "SnsConfiguration" } } }, "AWS::Timestream::ScheduledQuery.S3Configuration": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.S3Configuration`\n\nDetails on S3 location for error reports that result from running a query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-s3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nName of the S3 bucket under which error reports will be created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-s3configuration.html#cfn-timestream-scheduledquery-s3configuration-bucketname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ObjectKeyPrefix": { "MarkdownDocumentation": "`ObjectKeyPrefix`\n\nPrefix for the error report key. Timestream by default adds the following prefix to the\nerror report path.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+`\n*Minimum*: `1`\n*Maximum*: `896`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-s3configuration.html#cfn-timestream-scheduledquery-s3configuration-objectkeyprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EncryptionOption": { "MarkdownDocumentation": "`EncryptionOption`\n\nEncryption at rest options for the error reports. If no encryption option is specified,\nTimestream will choose SSE\\_S3 as default.\n*Required*: No\n*Type*: String\n*Allowed values*: `SSE_S3 | SSE_KMS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SSE_S3", "SSE_KMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-s3configuration.html#cfn-timestream-scheduledquery-s3configuration-encryptionoption", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Timestream::ScheduledQuery.ScheduleConfiguration": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.ScheduleConfiguration`\n\nConfiguration of the schedule of the query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-scheduleconfiguration.html", "Properties": { "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nAn expression that denotes when to trigger the scheduled query run. This can be a cron\nexpression or a rate expression.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-scheduleconfiguration.html#cfn-timestream-scheduledquery-scheduleconfiguration-scheduleexpression", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Timestream::ScheduledQuery.SnsConfiguration": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.SnsConfiguration`\n\nDetails on SNS that are required to send the notification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-snsconfiguration.html", "Properties": { "TopicArn": { "MarkdownDocumentation": "`TopicArn`\n\nSNS topic ARN that the scheduled query status notifications will be sent to.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-snsconfiguration.html#cfn-timestream-scheduledquery-snsconfiguration-topicarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Timestream::ScheduledQuery.TargetConfiguration": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.TargetConfiguration`\n\nConfiguration used for writing the output of a query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-targetconfiguration.html", "Properties": { "TimestreamConfiguration": { "MarkdownDocumentation": "`TimestreamConfiguration`\n\nConfiguration needed to write data into the Timestream database and table.\n*Required*: Yes\n*Type*: [TimestreamConfiguration](./aws-properties-timestream-scheduledquery-timestreamconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-targetconfiguration.html#cfn-timestream-scheduledquery-targetconfiguration-timestreamconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "TimestreamConfiguration" } } }, "AWS::Timestream::ScheduledQuery.TimestreamConfiguration": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery.TimestreamConfiguration`\n\nConfiguration to write data into Timestream database and table. This configuration allows\nthe user to map the query result select columns into the destination table columns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html", "Properties": { "TimeColumn": { "MarkdownDocumentation": "`TimeColumn`\n\nColumn from query result that should be used as the time column in destination table.\nColumn type for this should be TIMESTAMP.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-timecolumn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nName of Timestream table that the query result will be written to. The table should be\nwithin the same database that is provided in Timestream 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-tablename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DimensionMappings": { "MarkdownDocumentation": "`DimensionMappings`\n\nThis is to allow mapping column(s) from the query result to the dimension in the\ndestination table.\n*Required*: Yes\n*Type*: Array of [DimensionMapping](./aws-properties-timestream-scheduledquery-dimensionmapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-dimensionmappings", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "DimensionMapping", "DuplicatesAllowed": true }, "MixedMeasureMappings": { "MarkdownDocumentation": "`MixedMeasureMappings`\n\nSpecifies how to map measures to multi-measure records.\n*Required*: No\n*Type*: Array of [MixedMeasureMapping](./aws-properties-timestream-scheduledquery-mixedmeasuremapping.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-mixedmeasuremappings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "MixedMeasureMapping", "DuplicatesAllowed": true }, "MeasureNameColumn": { "MarkdownDocumentation": "`MeasureNameColumn`\n\nName of the measure column. Also see `MultiMeasureMappings` and\n`MixedMeasureMappings` for how measure name properties on those relate to\n`MeasureNameColumn`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-measurenamecolumn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nName of Timestream database to which the query result will be written.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MultiMeasureMappings": { "MarkdownDocumentation": "`MultiMeasureMappings`\n\nMulti-measure mappings.\n*Required*: No\n*Type*: [MultiMeasureMappings](./aws-properties-timestream-scheduledquery-multimeasuremappings.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-multimeasuremappings", "UpdateType": "Immutable", "Required": false, "Type": "MultiMeasureMappings" } } }, "AWS::Timestream::Table.MagneticStoreRejectedDataLocation": { "MarkdownDocumentation": "`AWS::Timestream::Table.MagneticStoreRejectedDataLocation`\n\nThe location to write error reports for records rejected, asynchronously, during magnetic store writes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html", "Properties": { "S3Configuration": { "MarkdownDocumentation": "`S3Configuration`\n\nConfiguration of an S3 location to write error reports for records rejected, asynchronously, during magnetic\nstore writes.\n*Required*: No\n*Type*: [S3Configuration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html#cfn-timestream-table-magneticstorerejecteddatalocation-s3configuration", "UpdateType": "Mutable", "Required": false, "Type": "S3Configuration" } } }, "AWS::Timestream::Table.MagneticStoreWriteProperties": { "MarkdownDocumentation": "`AWS::Timestream::Table.MagneticStoreWriteProperties`\n\nThe set of properties on a table for configuring magnetic store writes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorewriteproperties.html", "Properties": { "EnableMagneticStoreWrites": { "MarkdownDocumentation": "`EnableMagneticStoreWrites`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorewriteproperties.html#cfn-timestream-table-magneticstorewriteproperties-enablemagneticstorewrites", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "MagneticStoreRejectedDataLocation": { "MarkdownDocumentation": "`MagneticStoreRejectedDataLocation`\n\nThe location to write error reports for records rejected asynchronously during magnetic store writes.\n*Required*: No\n*Type*: [MagneticStoreRejectedDataLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorewriteproperties.html#cfn-timestream-table-magneticstorewriteproperties-magneticstorerejecteddatalocation", "UpdateType": "Mutable", "Required": false, "Type": "MagneticStoreRejectedDataLocation" } } }, "AWS::Timestream::Table.PartitionKey": { "MarkdownDocumentation": "`AWS::Timestream::Table.PartitionKey`\n\nAn attribute used in partitioning data in a table. A dimension key partitions data using the values of the\ndimension specified by the dimension-name as partition key, while a measure key partitions data using measure names\n(values of the 'measure\\_name' column).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DIMENSION | MEASURE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIMENSION", "MEASURE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnforcementInRecord": { "MarkdownDocumentation": "`EnforcementInRecord`\n\nThe level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED\n(dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).\n*Required*: No\n*Type*: String\n*Allowed values*: `REQUIRED | OPTIONAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REQUIRED", "OPTIONAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-enforcementinrecord", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the attribute used for a dimension 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Timestream::Table.RetentionProperties": { "MarkdownDocumentation": "`AWS::Timestream::Table.RetentionProperties`\n\nRetention properties contain the duration for which your time-series data must be stored in the magnetic store\nand the memory store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-retentionproperties.html", "Properties": { "MagneticStoreRetentionPeriodInDays": { "MarkdownDocumentation": "`MagneticStoreRetentionPeriodInDays`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-retentionproperties.html#cfn-timestream-table-retentionproperties-magneticstoreretentionperiodindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MemoryStoreRetentionPeriodInHours": { "MarkdownDocumentation": "`MemoryStoreRetentionPeriodInHours`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-retentionproperties.html#cfn-timestream-table-retentionproperties-memorystoreretentionperiodinhours", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Timestream::Table.S3Configuration": { "MarkdownDocumentation": "`AWS::Timestream::Table.S3Configuration`\n\nThe configuration that specifies an S3 location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe bucket name of the customer S3 bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS KMS key ID for the customer S3 location when encrypting with an AWS managed\nkey.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ObjectKeyPrefix": { "MarkdownDocumentation": "`ObjectKeyPrefix`\n\nThe object key preview for the customer S3 location.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+`\n*Minimum*: `1`\n*Maximum*: `928`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-objectkeyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionOption": { "MarkdownDocumentation": "`EncryptionOption`\n\nThe encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key\nor AWS managed key.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SSE_S3 | 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)", "RefReturnValue": "", "AllowedValues": [ "SSE_S3", "SSE_KMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-encryptionoption", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Timestream::Table.Schema": { "MarkdownDocumentation": "`AWS::Timestream::Table.Schema`\n\nA Schema specifies the expected data model of the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-schema.html", "Properties": { "CompositePartitionKey": { "MarkdownDocumentation": "`CompositePartitionKey`\n\nA non-empty list of partition keys defining the attributes used to partition the table data. The order of the\nlist determines the partition hierarchy. The name and type of each partition key as well as the partition key order\ncannot be changed after the table is created. However, the enforcement level of each partition key can be changed.\n*Required*: No\n*Type*: Array of [PartitionKey](./aws-properties-timestream-table-partitionkey.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-schema.html#cfn-timestream-table-schema-compositepartitionkey", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PartitionKey", "DuplicatesAllowed": true } } }, "AWS::Transfer::Agreement.CustomDirectories": { "MarkdownDocumentation": "`AWS::Transfer::Agreement.CustomDirectories`\n\nThe `CustomDirectories` property type specifies Property description not available. for an [AWS::Transfer::Agreement](./aws-resource-transfer-agreement.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-agreement-customdirectories.html", "Properties": { "FailedFilesDirectory": { "MarkdownDocumentation": "`FailedFilesDirectory`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-agreement-customdirectories.html#cfn-transfer-agreement-customdirectories-failedfilesdirectory", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TemporaryFilesDirectory": { "MarkdownDocumentation": "`TemporaryFilesDirectory`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-agreement-customdirectories.html#cfn-transfer-agreement-customdirectories-temporaryfilesdirectory", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MdnFilesDirectory": { "MarkdownDocumentation": "`MdnFilesDirectory`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-agreement-customdirectories.html#cfn-transfer-agreement-customdirectories-mdnfilesdirectory", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PayloadFilesDirectory": { "MarkdownDocumentation": "`PayloadFilesDirectory`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-agreement-customdirectories.html#cfn-transfer-agreement-customdirectories-payloadfilesdirectory", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StatusFilesDirectory": { "MarkdownDocumentation": "`StatusFilesDirectory`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-agreement-customdirectories.html#cfn-transfer-agreement-customdirectories-statusfilesdirectory", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Transfer::Connector.As2Config": { "MarkdownDocumentation": "`AWS::Transfer::Connector.As2Config`\n\nA structure that contains the parameters for an AS2 connector object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html", "Properties": { "Compression": { "MarkdownDocumentation": "`Compression`\n\nSpecifies whether the AS2 file is compressed.\n*Required*: No\n*Type*: String\n*Allowed values*: `ZLIB | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ZLIB", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-compression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MessageSubject": { "MarkdownDocumentation": "`MessageSubject`\n\nUsed as the `Subject` HTTP header attribute in AS2 messages that are being\nsent with the connector.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\u007E\\t]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-messagesubject", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BasicAuthSecretId": { "MarkdownDocumentation": "`BasicAuthSecretId`\n\nProvides Basic authentication support to the AS2 Connectors API. To use Basic\nauthentication, you must provide the name or Amazon Resource Name (ARN) of a secret in\nAWS Secrets Manager.\nThe default value for this parameter is `null`, which indicates that Basic\nauthentication is not enabled for the connector.\nIf the connector should use Basic authentication, the secret needs to be in the\nfollowing format:\n`{ \"Username\": \"user-name\", \"Password\": \"user-password\" }`\nReplace `user-name` and `user-password` with the credentials for\nthe actual user that is being authenticated.\nNote the following:\n* You are storing these credentials in Secrets Manager, *not passing\n them directly* into this API.\n* If you are using the API, SDKs, or CloudFormation to configure your connector,\n then you must create the secret before you can enable Basic authentication.\n However, if you are using the AWS management console, you can\n have the system create the secret for you.\nIf you have previously enabled Basic authentication for a connector, you can disable\nit by using the `UpdateConnector` API call. For example, if you are using the\nCLI, you can run the following command to remove Basic authentication:\n`update-connector --connector-id my-connector-id --as2-config\n'BasicAuthSecretId=\"\"'`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-basicauthsecretid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PartnerProfileId": { "MarkdownDocumentation": "`PartnerProfileId`\n\nA unique identifier for the partner profile for the connector.\n*Required*: No\n*Type*: String\n*Pattern*: `^p-([0-9a-f]{17})$`\n*Minimum*: `19`\n*Maximum*: `19`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-partnerprofileid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionAlgorithm": { "MarkdownDocumentation": "`EncryptionAlgorithm`\n\nThe algorithm that is used to encrypt the file.\nNote the following:\n* Do not use the `DES_EDE3_CBC` algorithm unless you must support a\n legacy client that requires it, as it is a weak encryption algorithm.\n* You can only specify `NONE` if the URL for your connector uses\n HTTPS. Using HTTPS ensures that no traffic is sent in clear text.\n*Required*: No\n*Type*: String\n*Allowed values*: `AES128_CBC | AES192_CBC | A...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AES128_CBC", "AES192_CBC", "AES256_CBC", "NONE", "DES_EDE3_CBC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-encryptionalgorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SigningAlgorithm": { "MarkdownDocumentation": "`SigningAlgorithm`\n\nThe algorithm that is used to sign the AS2 messages sent with the connector.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHA256 | SHA384 | SHA512 | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SHA256", "SHA384", "SHA512", "SHA1", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-signingalgorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LocalProfileId": { "MarkdownDocumentation": "`LocalProfileId`\n\nA unique identifier for the AS2 local profile.\n*Required*: No\n*Type*: String\n*Pattern*: `^p-([0-9a-f]{17})$`\n*Minimum*: `19`\n*Maximum*: `19`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-localprofileid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MdnResponse": { "MarkdownDocumentation": "`MdnResponse`\n\nUsed for outbound requests (from an AWS Transfer Family connector to a partner AS2 server) to determine whether\nthe partner response for transfers is synchronous or asynchronous. Specify either of the following values:\n* `SYNC`: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).\n* `NONE`: Specifies that no MDN response is required.\n*Required*: No\n*Type*: String\n*Allowed values*: `SYNC | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SYNC", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-mdnresponse", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MdnSigningAlgorithm": { "MarkdownDocumentation": "`MdnSigningAlgorithm`\n\nThe signing algorithm for the MDN response.\n###### Note\nIf set to DEFAULT (or not set at all), the value for `SigningAlgorithm`\nis used.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHA256 | SHA384 | SHA512 | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SHA256", "SHA384", "SHA512", "SHA1", "NONE", "DEFAULT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-mdnsigningalgorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreserveContentType": { "MarkdownDocumentation": "`PreserveContentType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-preservecontenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Connector.ConnectorEgressConfig": { "MarkdownDocumentation": "`AWS::Transfer::Connector.ConnectorEgressConfig`\n\nConfiguration structure that defines how traffic is routed from the connector to the\nSFTP server. Contains VPC Lattice settings when using VPC\\_LATTICE egress type for\nprivate connectivity through customer VPCs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-connectoregressconfig.html", "Properties": { "VpcLattice": { "MarkdownDocumentation": "`VpcLattice`\n\nVPC\\_LATTICE configuration for routing connector traffic through customer VPCs. Enables\nprivate connectivity to SFTP servers without requiring public internet access or complex\nnetwork configurations.\n*Required*: Yes\n*Type*: [ConnectorVpcLatticeEgressConfig](./aws-properties-transfer-connector-connectorvpclatticeegressconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-connectoregressconfig.html#cfn-transfer-connector-connectoregressconfig-vpclattice", "UpdateType": "Mutable", "Required": true, "Type": "ConnectorVpcLatticeEgressConfig" } } }, "AWS::Transfer::Connector.ConnectorVpcLatticeEgressConfig": { "MarkdownDocumentation": "`AWS::Transfer::Connector.ConnectorVpcLatticeEgressConfig`\n\nVPC\\_LATTICE egress configuration that specifies the Resource Configuration ARN and\nport for connecting to SFTP servers through customer VPCs. Requires a valid Resource\nConfiguration with appropriate network access.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-connectorvpclatticeegressconfig.html", "Properties": { "ResourceConfigurationArn": { "MarkdownDocumentation": "`ResourceConfigurationArn`\n\nARN of the VPC\\_LATTICE Resource Configuration that defines the target SFTP server\nlocation. Must point to a valid Resource Configuration in the customer's VPC with\nappropriate network connectivity to the SFTP server.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-connectorvpclatticeegressconfig.html#cfn-transfer-connector-connectorvpclatticeegressconfig-resourceconfigurationarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PortNumber": { "MarkdownDocumentation": "`PortNumber`\n\nPort number for connecting to the SFTP server through VPC\\_LATTICE. Defaults to 22 if\nnot specified. Must match the port on which the target SFTP server is listening.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-connectorvpclatticeegressconfig.html#cfn-transfer-connector-connectorvpclatticeegressconfig-portnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Transfer::Connector.SftpConfig": { "MarkdownDocumentation": "`AWS::Transfer::Connector.SftpConfig`\n\nA structure that contains the parameters for an SFTP connector object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html", "Properties": { "TrustedHostKeys": { "MarkdownDocumentation": "`TrustedHostKeys`\n\nThe public portion of the host key, or keys, that are used to identify the external\nserver to which you are connecting. You can use the `ssh-keyscan` command\nagainst the SFTP server to retrieve the necessary key.\n###### Note\n`TrustedHostKeys` is optional for `CreateConnector`. If not\nprovided, you can use `TestConnection` to retrieve the server host key\nduring the initial connection attempt, and subsequently update the connector with\nthe observed host key.\nWhen creating connectors with egress config (VPC\\_LATTICE type connectors), since host\nname is not something we can verify, the only accepted trusted host key format is\n`key-type key-body` without the host name. For example: `ssh-rsa\nAAAAB3Nza...`\nThe three standard SSH public key format elements are ``,\n``, and an optional ``, with\nspaces between each element. Specify only the `` and\n``: do not enter the `` portion of\nthe key.\nFor the trusted host key, AWS Transfer Family accepts RSA and ECDSA keys.\n* For RSA keys, the `` string is\n `ssh-rsa`.\n* For ECDSA keys, the `` string is either\n `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or\n `ecdsa-sha2-nistp521`, depending on the size of the key you\n generated.\nRun this command to retrieve the SFTP server host key, where your SFTP server name is\n`ftp.host.com`.\n`ssh-keyscan ftp.host.com`\nThis prints the public host key to standard output.\n`ftp.host.com ssh-rsa\nAAAAB3Nza...`\nCopy and paste this string into the `TrustedHostKeys` field for the\n`create-connector` command or into the **Trusted host\nkeys** field in the console.\nFor VPC Lattice type connectors (VPC\\_LATTICE), remove the hostname from the key and\nuse only the `key-type key-body` format. In this example, it should be:\n`ssh-rsa AAAAB3Nza...`\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html#cfn-transfer-connector-sftpconfig-trustedhostkeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UserSecretId": { "MarkdownDocumentation": "`UserSecretId`\n\nThe identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's\nprivate key, password, or both. The identifier must be the Amazon Resource Name (ARN) of\nthe secret.\n###### Note\n* Required when creating an SFTP connector\n* Optional when updating an existing SFTP connector\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html#cfn-transfer-connector-sftpconfig-usersecretid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxConcurrentConnections": { "MarkdownDocumentation": "`MaxConcurrentConnections`\n\nSpecify the number of concurrent connections that your connector creates to the remote\nserver. The default value is `1`. The maximum values is\n`5`.\n###### Note\nIf you are using the AWS Management Console, the default value is\n`5`.\nThis parameter specifies the number of active connections that your connector can\nestablish with the remote server at the same time. Increasing this value can enhance\nconnector performance when transferring large file batches by enabling parallel\noperations.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html#cfn-transfer-connector-sftpconfig-maxconcurrentconnections", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Transfer::Server.EndpointDetails": { "MarkdownDocumentation": "`AWS::Transfer::Server.EndpointDetails`\n\nThe virtual private cloud (VPC) endpoint settings that are configured for your server.\nWhen you host your endpoint within your VPC, you can make your endpoint accessible only to resources\nwithin your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over\nthe internet. Your VPC's default security groups are automatically assigned to your\nendpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html", "Properties": { "AddressAllocationIds": { "MarkdownDocumentation": "`AddressAllocationIds`\n\nA list of address allocation IDs that are required to attach an Elastic IP address to\nyour server's endpoint.\nAn address allocation ID corresponds to the allocation ID of an Elastic IP address.\nThis value can be retrieved from the `allocationId` field from the Amazon EC2\n[Address](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html) data type. One way to retrieve this value is by calling the EC2\n[DescribeAddresses](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html) API.\nThis parameter is optional. Set this parameter if you want to make your VPC endpoint\npublic-facing. For details, see [Create an internet-facing endpoint for your server](https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint).\n###### Note\nThis property can only be set as follows:\n* `EndpointType` must be set to `VPC`\n* The Transfer Family server must be offline.\n* You cannot set this parameter for Transfer Family servers that use the FTP\n protocol.\n* The server must already have `SubnetIds` populated\n (`SubnetIds` and `AddressAllocationIds` cannot be\n updated simultaneously).\n* `AddressAllocationIds` can't contain duplicates, and must be\n equal in length to `SubnetIds`. For example, if you have three\n subnet IDs, you must also specify three address allocation IDs.\n* Call the `UpdateServer` API to set or change this\n parameter.\n* You can't set address allocation IDs for servers that have an\n `IpAddressType` set to `DUALSTACK` You can only\n set this property if `IpAddressType` is set to\n `IPV4`.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-addressallocationids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe VPC ID of the virtual private cloud in which the server's endpoint will be\nhosted.\n###### Note\nThis property can only be set when `EndpointType` is set to\n`VPC` .\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe ID of the VPC endpoint.\n###### Note\nThis property can only be set when `EndpointType` is set to\n`VPC_ENDPOINT` .\n*Required*: No\n*Type*: String\n*Pattern*: `^vpce-[0-9a-f]{17}$`\n*Minimum*: `22`\n*Maximum*: `22`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcendpointid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of subnet IDs that are required to host your server endpoint in your\nVPC.\n###### Note\nThis property can only be set when `EndpointType` is set to\n`VPC` .\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-subnetids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of security groups IDs that are available to attach to your server's\nendpoint.\n###### Note\nWhile `SecurityGroupIds` appears in the response syntax for consistency\nwith `CreateServer` and `UpdateServer` operations, this field\nis not populated in `DescribeServer` responses. Security groups are\nmanaged at the VPC endpoint level and can be modified outside of the Transfer Family\nservice. To retrieve current security group information, use the EC2\n`DescribeVpcEndpoints` API with the `VpcEndpointId`\nreturned in the response.\nThis property can only be set when `EndpointType` is set to\n`VPC`.\nYou can edit the `SecurityGroupIds` property in the [UpdateServer](https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html) API only if you are changing the `EndpointType`\nfrom `PUBLIC` or `VPC_ENDPOINT` to `VPC`. To change\nsecurity groups associated with your server's VPC endpoint after creation, use\nthe Amazon EC2 [ModifyVpcEndpoint](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html) API.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `11`\n*Maximum*: `20`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-securitygroupids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Transfer::Server.IdentityProviderDetails": { "MarkdownDocumentation": "`AWS::Transfer::Server.IdentityProviderDetails`\n\nRequired when `IdentityProviderType` is set to\n`AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA` or\n`API_GATEWAY`. Accepts an array containing all of the information\nrequired to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a\ncustomer-supplied authentication API, including the API Gateway URL. Cannot be specified\nwhen `IdentityProviderType` is set to `SERVICE_MANAGED`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html", "Properties": { "Function": { "MarkdownDocumentation": "`Function`\n\nThe ARN for a Lambda function to use for the Identity provider.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[a-z-]+:lambda:.*$`\n*Minimum*: `1`\n*Maximum*: `170`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-function", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DirectoryId": { "MarkdownDocumentation": "`DirectoryId`\n\nThe identifier of the AWS Directory Service directory that you want to use as your identity\nprovider.\n*Required*: No\n*Type*: String\n*Pattern*: `^d-[0-9a-f]{10}$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-directoryid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InvocationRole": { "MarkdownDocumentation": "`InvocationRole`\n\nThis parameter is only applicable if your `IdentityProviderType` is\n`API_GATEWAY`. Provides the type of `InvocationRole` used to\nauthenticate the user account.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:.*role/\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-invocationrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Url": { "MarkdownDocumentation": "`Url`\n\nProvides the location of the service endpoint used to authenticate users.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SftpAuthenticationMethods": { "MarkdownDocumentation": "`SftpAuthenticationMethods`\n\nFor SFTP-enabled servers, and for custom identity providers *only*,\nyou can specify whether to authenticate using a password, SSH key pair, or both.\n* `PASSWORD` - users must provide their password to connect.\n* `PUBLIC_KEY` - users must provide their private key to\n connect.\n* `PUBLIC_KEY_OR_PASSWORD` - users can authenticate with either their\n password or their key. This is the default value.\n* `PUBLIC_KEY_AND_PASSWORD` - users must provide both their private\n key and their password to connect. The server checks the key first, and then if\n the key is valid, the system prompts for a password. If the private key provided\n does not match the public key that is stored, authentication fails.\n*Required*: No\n*Type*: String\n*Allowed values*: `PASSWORD | PUBLIC_KEY | PUB...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PASSWORD", "PUBLIC_KEY", "PUBLIC_KEY_OR_PASSWORD", "PUBLIC_KEY_AND_PASSWORD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html#cfn-transfer-server-identityproviderdetails-sftpauthenticationmethods", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Server.ProtocolDetails": { "MarkdownDocumentation": "`AWS::Transfer::Server.ProtocolDetails`\n\nThe protocol settings that are configured for your server.\n###### Note\nAvoid placing Network Load Balancers (NLBs) or NAT gateways in front of AWS Transfer Family servers,\nas this increases costs and can cause performance issues, including reduced connection limits for FTPS.\nFor more details, see [Avoid placing NLBs and NATs in front of AWS Transfer Family](https://docs.aws.amazon.com/transfer/latest/userguide/infrastructure-security.html#nlb-considerations).\n* To indicate passive mode (for FTP and FTPS protocols), use the `PassiveIp` parameter.\n 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\n uploading to an Amazon S3 bucket, use the `SetStatOption` parameter. To have the AWS Transfer Family server ignore the\n `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to\n `ENABLE_NO_OP`. If you set the `SetStatOption` parameter to `ENABLE_NO_OP`, Transfer Family\n generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT`\n call.\n* To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the\n `TlsSessionResumptionMode` parameter.\n* `As2Transports` indicates the transport method for the AS2 messages. Currently, only HTTP is supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html", "Properties": { "As2Transports": { "MarkdownDocumentation": "`As2Transports`\n\nList of `As2Transport` objects.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html#cfn-transfer-server-protocoldetails-as2transports", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PassiveIp": { "MarkdownDocumentation": "`PassiveIp`\n\nIndicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such\nas 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\nto use.\n###### Note\nIf you change the `PassiveIp` value, you must stop and then restart\nyour Transfer Family server for the change to take effect. For details on using\npassive mode (PASV) in a NAT environment, see [Configuring your FTPS server behind a firewall or NAT with AWS Transfer Family](https://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/).\nAdditionally, avoid placing Network Load Balancers (NLBs) or NAT gateways in front\nof AWS Transfer Family servers. This configuration increases costs and can cause performance\nissues. When NLBs or NATs are in the communication path, Transfer Family cannot accurately\nrecognize client IP addresses, which impacts connection sharding and limits FTPS\nservers to only 300 simultaneous connections instead of 10,000. If you must use an\nNLB, use port 21 for health checks and enable TLS session resumption by setting\n`TlsSessionResumptionMode = ENFORCED`. For optimal performance,\nmigrate to VPC endpoints with Elastic IP addresses instead of using NLBs. For more\ndetails, see [Avoid placing NLBs and NATs in front of AWS Transfer Family](https://docs.aws.amazon.com/transfer/latest/userguide/infrastructure-security.html#nlb-considerations).\n*Special values*\nThe `AUTO` and `0.0.0.0` are special values for the\n`PassiveIp` parameter. The value `PassiveIp=AUTO` is assigned\nby default to FTP and FTPS type servers. In this case, the server automatically responds\nwith one of the endpoint IPs within the PASV response. `PassiveIp=0.0.0.0`\nhas a more unique application for its usage. For example, if you have a High\nAvailability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you\ncan only specify a single IP address using the `PassiveIp` parameter. This\nreduces the effectiveness of having High Availability. In this case, you can specify\n`PassiveIp=0.0.0.0`. This tells the client to use the same IP address as\nthe Control connection and utilize all AZs for their connections. Note, however, that\nnot all FTP clients support the `PassiveIp=0.0.0.0` response. FileZilla and\nWinSCP do support it. If you are using other clients, check to see if your client\nsupports the `PassiveIp=0.0.0.0` response.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html#cfn-transfer-server-protocoldetails-passiveip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SetStatOption": { "MarkdownDocumentation": "`SetStatOption`\n\nUse the `SetStatOption` to ignore the error that is generated when the\nclient attempts to use `SETSTAT` on a file you are uploading to an S3\nbucket.\nSome SFTP file transfer clients can attempt to change the attributes of remote files,\nincluding timestamp and permissions, using commands, such as `SETSTAT` when\nuploading the file. However, these commands are not compatible with object storage\nsystems, such as Amazon S3. Due to this incompatibility, file uploads from these\nclients can result in errors even when the file is otherwise successfully\nuploaded.\nSet the value to `ENABLE_NO_OP` to have the Transfer Family server ignore\nthe `SETSTAT` command, and upload files without needing to make any changes\nto your SFTP client. While the `SetStatOption``ENABLE_NO_OP` setting ignores the error, it does generate a log entry in\nAmazon CloudWatch Logs, so you can determine when the client is making a\n`SETSTAT` call.\n###### Note\nIf you want to preserve the original timestamp for your file, and modify other\nfile attributes using `SETSTAT`, you can use Amazon EFS as\nbackend 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)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "ENABLE_NO_OP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html#cfn-transfer-server-protocoldetails-setstatoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TlsSessionResumptionMode": { "MarkdownDocumentation": "`TlsSessionResumptionMode`\n\nA property used with Transfer Family servers that use the FTPS protocol. TLS Session\nResumption provides a mechanism to resume or share a negotiated secret key between the\ncontrol and data connection for an FTPS session. `TlsSessionResumptionMode`\ndetermines whether or not the server resumes recent, negotiated sessions through a\nunique session ID. This property is available during `CreateServer` and\n`UpdateServer` calls. If a `TlsSessionResumptionMode` value is\nnot specified during `CreateServer`, it is set to `ENFORCED` by\ndefault.\n* `DISABLED`: the server does not process TLS session resumption\n client requests and creates a new TLS session for each request.\n* `ENABLED`: the server processes and accepts clients that are\n performing TLS session resumption. The server doesn't reject client data\n connections that do not perform the TLS session resumption client\n processing.\n* `ENFORCED`: the server processes and accepts clients that are\n performing TLS session resumption. The server rejects client data connections\n that do not perform the TLS session resumption client processing. Before you set\n the value to `ENFORCED`, test your clients.\n \n ###### Note\n \n Not all FTPS clients perform TLS session resumption. So, if you choose to\n enforce TLS session resumption, you prevent any connections from FTPS\n clients that don't perform the protocol negotiation. To determine whether or\n not you can use the `ENFORCED` value, you need to test your\n clients.\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLED | ENABLED | ENFORC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED", "ENFORCED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html#cfn-transfer-server-protocoldetails-tlssessionresumptionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Server.S3StorageOptions": { "MarkdownDocumentation": "`AWS::Transfer::Server.S3StorageOptions`\n\nThe Amazon S3 storage options that are configured for your server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-s3storageoptions.html", "Properties": { "DirectoryListingOptimization": { "MarkdownDocumentation": "`DirectoryListingOptimization`\n\nSpecifies whether or not performance for your Amazon S3 directories is optimized.\n* If using the console, this is enabled by default.\n* If using the API or CLI, this is disabled by default.\nBy default, home directory mappings have a `TYPE` of `DIRECTORY`. If you enable this option, you would then need to explicitly set the `HomeDirectoryMapEntry``Type` to `FILE` if you want a mapping to have a file target.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-s3storageoptions.html#cfn-transfer-server-s3storageoptions-directorylistingoptimization", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Server.WorkflowDetail": { "MarkdownDocumentation": "`AWS::Transfer::Server.WorkflowDetail`\n\nSpecifies the workflow ID for the workflow to assign and the execution role that's\nused for executing the workflow.\nIn addition to a workflow to execute when a file is uploaded completely,\n`WorkflowDetails` can also contain a workflow ID (and execution role) for\na workflow to execute on partial upload. A partial upload occurs when a file is open\nwhen the session disconnects.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html", "Properties": { "WorkflowId": { "MarkdownDocumentation": "`WorkflowId`\n\nA unique identifier for the workflow.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^w-([a-z0-9]{17})$`\n*Minimum*: `19`\n*Maximum*: `19`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html#cfn-transfer-server-workflowdetail-workflowid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nIncludes the necessary permissions for S3, EFS, and Lambda operations that Transfer\ncan assume, so that all workflow steps can operate on the required resources\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*role/\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html#cfn-transfer-server-workflowdetail-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Transfer::Server.WorkflowDetails": { "MarkdownDocumentation": "`AWS::Transfer::Server.WorkflowDetails`\n\nContainer for the `WorkflowDetail` data type. It is used by actions that\ntrigger a workflow to begin execution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html", "Properties": { "OnUpload": { "MarkdownDocumentation": "`OnUpload`\n\nA trigger that starts a workflow: the workflow begins to execute after a file is\nuploaded.\nTo remove an associated workflow from a server, you can provide an empty\n`OnUpload` object, as in the following example.\n`aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'`\n###### Note\n`OnUpload` can contain a maximum of one `WorkflowDetail`\nobject.\n*Required*: No\n*Type*: Array of [WorkflowDetail](./aws-properties-transfer-server-workflowdetail.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html#cfn-transfer-server-workflowdetails-onupload", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "WorkflowDetail", "DuplicatesAllowed": true }, "OnPartialUpload": { "MarkdownDocumentation": "`OnPartialUpload`\n\nA trigger that starts a workflow if a file is only partially uploaded. You can attach\na workflow to a server that executes whenever there is a partial upload.\nA *partial upload* occurs when a file is open when the session\ndisconnects.\n###### Note\n`OnPartialUpload` can contain a maximum of one\n`WorkflowDetail` object.\n*Required*: No\n*Type*: Array of [WorkflowDetail](./aws-properties-transfer-server-workflowdetail.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html#cfn-transfer-server-workflowdetails-onpartialupload", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "WorkflowDetail", "DuplicatesAllowed": true } } }, "AWS::Transfer::User.HomeDirectoryMapEntry": { "MarkdownDocumentation": "`AWS::Transfer::User.HomeDirectoryMapEntry`\n\nRepresents an object that contains entries and targets for\n`HomeDirectoryMappings` .\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html", "Properties": { "Entry": { "MarkdownDocumentation": "`Entry`\n\nRepresents an entry for `HomeDirectoryMappings`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^/.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html#cfn-transfer-user-homedirectorymapentry-entry", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Target": { "MarkdownDocumentation": "`Target`\n\nRepresents the map target that is used in a `HomeDirectoryMapEntry`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^/.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html#cfn-transfer-user-homedirectorymapentry-target", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of mapping. Set the type to `FILE` if you want the\nmapping to point to a file, or `DIRECTORY` for the directory to point to a\ndirectory.\n###### Note\nBy default, home directory mappings have a `Type` of\n`DIRECTORY` when you create a Transfer Family server. You would need to\nexplicitly set `Type` to `FILE` if you want a mapping to have\na file target.\n*Required*: No\n*Type*: String\n*Allowed values*: `FILE | DIRECTORY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FILE", "DIRECTORY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html#cfn-transfer-user-homedirectorymapentry-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::User.PosixProfile": { "MarkdownDocumentation": "`AWS::Transfer::User.PosixProfile`\n\nThe full POSIX identity, including user ID (`Uid`), group ID\n(`Gid`), and any secondary groups IDs (`SecondaryGids`), that\ncontrols your users' access to your Amazon EFS file systems. The POSIX permissions that\nare set on files and directories in your file system determine the level of access your\nusers get when transferring files into and out of your Amazon EFS file systems.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html", "Properties": { "Uid": { "MarkdownDocumentation": "`Uid`\n\nThe POSIX user ID used for all EFS operations by this user.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `4294967295`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html#cfn-transfer-user-posixprofile-uid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "SecondaryGids": { "MarkdownDocumentation": "`SecondaryGids`\n\nThe secondary POSIX group IDs used for all EFS operations by this user.\n*Required*: No\n*Type*: Array of Number\n*Minimum*: `0 | 0`\n*Maximum*: `16 | 4294967295`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html#cfn-transfer-user-posixprofile-secondarygids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Double", "DuplicatesAllowed": true }, "Gid": { "MarkdownDocumentation": "`Gid`\n\nThe POSIX group ID used for all EFS operations by this user.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `4294967295`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html#cfn-transfer-user-posixprofile-gid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } } }, "AWS::Transfer::WebApp.IdentityProviderDetails": { "MarkdownDocumentation": "`AWS::Transfer::WebApp.IdentityProviderDetails`\n\nA structure that describes the values to use for the IAM Identity Center settings when\nyou create or update a web app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-identityproviderdetails.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nThe IAM role in IAM Identity Center used for the web app.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[a-z-]+:iam::[0-9]{12}:role[:/]\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-identityproviderdetails.html#cfn-transfer-webapp-identityproviderdetails-role", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationArn": { "MarkdownDocumentation": "`ApplicationArn`\n\nThe Amazon Resource Name (ARN) for the IAM Identity Center application: this value is\nset automatically when you create your web app.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-identityproviderdetails.html#cfn-transfer-webapp-identityproviderdetails-applicationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceArn": { "MarkdownDocumentation": "`InstanceArn`\n\nThe Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-identityproviderdetails.html#cfn-transfer-webapp-identityproviderdetails-instancearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::WebApp.WebAppCustomization": { "MarkdownDocumentation": "`AWS::Transfer::WebApp.WebAppCustomization`\n\nA structure that contains the customization fields for the web app. You can provide a\ntitle, logo, and icon to customize the appearance of your web app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappcustomization.html", "Properties": { "FaviconFile": { "MarkdownDocumentation": "`FaviconFile`\n\nReturns an icon file data string (in base64 encoding).\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `20960`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappcustomization.html#cfn-transfer-webapp-webappcustomization-faviconfile", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Title": { "MarkdownDocumentation": "`Title`\n\nReturns the page title that you defined for your web app.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappcustomization.html#cfn-transfer-webapp-webappcustomization-title", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogoFile": { "MarkdownDocumentation": "`LogoFile`\n\nReturns a logo file data string (in base64 encoding).\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappcustomization.html#cfn-transfer-webapp-webappcustomization-logofile", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::WebApp.WebAppUnits": { "MarkdownDocumentation": "`AWS::Transfer::WebApp.WebAppUnits`\n\nContains an integer value that represents the value for number of concurrent\nconnections or the user sessions on your web app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappunits.html", "Properties": { "Provisioned": { "MarkdownDocumentation": "`Provisioned`\n\nAn integer that represents the number of units for your desired number of concurrent\nconnections, or the number of user sessions on your web app at the same time.\nEach increment allows an additional 250 concurrent sessions: a value of `1`\nsets the number of concurrent sessions to 250; `2` sets a value of 500, and\nso on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-webapp-webappunits.html#cfn-transfer-webapp-webappunits-provisioned", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::Transfer::Workflow.CopyStepDetails": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.CopyStepDetails`\n\nDetails for a step that performs a file copy.\nConsists 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.\n The default is `FALSE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html", "Properties": { "DestinationFileLocation": { "MarkdownDocumentation": "`DestinationFileLocation`\n\nSpecifies the location for the file being copied. Use\n`${Transfer:UserName}` or `${Transfer:UploadDate}` in this\nfield to parametrize the destination prefix by username or uploaded date.\n* Set the value of `DestinationFileLocation` to\n `${Transfer:UserName}` to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family\n user that uploaded the file.\n* Set the value of `DestinationFileLocation` to\n `${Transfer:UploadDate}` to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.\n \n ###### Note\n \n The system resolves `UploadDate` to a date format of\n *YYYY-MM-DD*, based on the date the file is uploaded\n in UTC.\n*Required*: No\n*Type*: [S3FileLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html#cfn-transfer-workflow-copystepdetails-destinationfilelocation", "UpdateType": "Immutable", "Required": false, "Type": "S3FileLocation" }, "SourceFileLocation": { "MarkdownDocumentation": "`SourceFileLocation`\n\nSpecifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\nfor the workflow.\n* To use the previous file as the input, enter `${previous.file}`.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.\n* To use the originally uploaded file location as input for this step, enter `${original.file}`.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\$\\{(\\w+.)+\\w+\\}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html#cfn-transfer-workflow-copystepdetails-sourcefilelocation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the step, used as an identifier.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w-]*$`\n*Minimum*: `0`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html#cfn-transfer-workflow-copystepdetails-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OverwriteExisting": { "MarkdownDocumentation": "`OverwriteExisting`\n\nA flag that indicates whether to overwrite an existing file of the same name.\nThe default is `FALSE`.\nIf the workflow is processing a file that has the same name as an existing file, the behavior is as follows:\n* If `OverwriteExisting` is `TRUE`, the existing file is replaced with the file being processed.\n* If `OverwriteExisting` is `FALSE`, nothing happens, and the workflow processing stops.\n*Required*: No\n*Type*: String\n*Allowed values*: `TRUE | FALSE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TRUE", "FALSE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html#cfn-transfer-workflow-copystepdetails-overwriteexisting", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Workflow.CustomStepDetails": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.CustomStepDetails`\n\nDetails for a step that invokes an AWS Lambda function.\nConsists of the Lambda function's name, target, and timeout (in seconds).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-customstepdetails.html", "Properties": { "TimeoutSeconds": { "MarkdownDocumentation": "`TimeoutSeconds`\n\nTimeout, in seconds, for the step.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `1800`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-customstepdetails.html#cfn-transfer-workflow-customstepdetails-timeoutseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Target": { "MarkdownDocumentation": "`Target`\n\nThe ARN for the Lambda function that is being called.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[a-z-]+:lambda:.*$`\n*Minimum*: `0`\n*Maximum*: `170`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-customstepdetails.html#cfn-transfer-workflow-customstepdetails-target", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceFileLocation": { "MarkdownDocumentation": "`SourceFileLocation`\n\nSpecifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\nfor the workflow.\n* To use the previous file as the input, enter `${previous.file}`.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.\n* To use the originally uploaded file location as input for this step, enter `${original.file}`.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\$\\{(\\w+.)+\\w+\\}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-customstepdetails.html#cfn-transfer-workflow-customstepdetails-sourcefilelocation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the step, used as an identifier.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w-]*$`\n*Minimum*: `0`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-customstepdetails.html#cfn-transfer-workflow-customstepdetails-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Workflow.DecryptStepDetails": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.DecryptStepDetails`\n\nDetails for a step that decrypts an encrypted file.\nConsists of the following values:\n* A descriptive name\n* An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the\n source file to decrypt.\n* An S3 or Amazon EFS location for the destination of the file\n decryption.\n* A flag that indicates whether to overwrite an existing file of the same name.\n The default is `FALSE`.\n* The type of encryption that's used. Currently, only PGP encryption is\n supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html", "Properties": { "DestinationFileLocation": { "MarkdownDocumentation": "`DestinationFileLocation`\n\nSpecifies the location for the file being decrypted. Use\n`${Transfer:UserName}` or `${Transfer:UploadDate}` in this\nfield to parametrize the destination prefix by username or uploaded date.\n* Set the value of `DestinationFileLocation` to\n `${Transfer:UserName}` to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family\n user that uploaded the file.\n* Set the value of `DestinationFileLocation` to\n `${Transfer:UploadDate}` to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.\n \n ###### Note\n \n The system resolves `UploadDate` to a date format of\n *YYYY-MM-DD*, based on the date the file is uploaded\n in UTC.\n*Required*: Yes\n*Type*: [InputFileLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html#cfn-transfer-workflow-decryptstepdetails-destinationfilelocation", "UpdateType": "Immutable", "Required": true, "Type": "InputFileLocation" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of encryption used. Currently, this value must be `PGP`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PGP`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "PGP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html#cfn-transfer-workflow-decryptstepdetails-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceFileLocation": { "MarkdownDocumentation": "`SourceFileLocation`\n\nSpecifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\nfor the workflow.\n* To use the previous file as the input, enter `${previous.file}`.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.\n* To use the originally uploaded file location as input for this step, enter `${original.file}`.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\$\\{(\\w+.)+\\w+\\}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html#cfn-transfer-workflow-decryptstepdetails-sourcefilelocation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the step, used as an identifier.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w-]*$`\n*Minimum*: `0`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html#cfn-transfer-workflow-decryptstepdetails-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OverwriteExisting": { "MarkdownDocumentation": "`OverwriteExisting`\n\nA flag that indicates whether to overwrite an existing file of the same name.\nThe default is `FALSE`.\nIf the workflow is processing a file that has the same name as an existing file, the behavior is as follows:\n* If `OverwriteExisting` is `TRUE`, the existing file is replaced with the file being processed.\n* If `OverwriteExisting` is `FALSE`, nothing happens, and the workflow processing stops.\n*Required*: No\n*Type*: String\n*Allowed values*: `TRUE | FALSE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TRUE", "FALSE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html#cfn-transfer-workflow-decryptstepdetails-overwriteexisting", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Workflow.DeleteStepDetails": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.DeleteStepDetails`\n\nAn object that contains the name and file location for a file being deleted by a\nworkflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-deletestepdetails.html", "Properties": { "SourceFileLocation": { "MarkdownDocumentation": "`SourceFileLocation`\n\nSpecifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\nfor the workflow.\n* To use the previous file as the input, enter `${previous.file}`.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.\n* To use the originally uploaded file location as input for this step, enter `${original.file}`.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\$\\{(\\w+.)+\\w+\\}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-deletestepdetails.html#cfn-transfer-workflow-deletestepdetails-sourcefilelocation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the step, used as an identifier.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w-]*$`\n*Minimum*: `0`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-deletestepdetails.html#cfn-transfer-workflow-deletestepdetails-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Workflow.EfsInputFileLocation": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.EfsInputFileLocation`\n\nSpecifies the Amazon EFS identifier and the path for the file being used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-efsinputfilelocation.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe pathname for the folder being used by a workflow.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\x00]+$`\n*Minimum*: `1`\n*Maximum*: `65536`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-efsinputfilelocation.html#cfn-transfer-workflow-efsinputfilelocation-path", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe identifier of the file system, assigned by Amazon EFS.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-efsinputfilelocation.html#cfn-transfer-workflow-efsinputfilelocation-filesystemid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Workflow.InputFileLocation": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.InputFileLocation`\n\nSpecifies the location for the file that's being processed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-inputfilelocation.html", "Properties": { "EfsFileLocation": { "MarkdownDocumentation": "`EfsFileLocation`\n\nSpecifies the details for the Amazon Elastic File System (Amazon EFS) file that's\nbeing decrypted.\n*Required*: No\n*Type*: [EfsInputFileLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-inputfilelocation.html#cfn-transfer-workflow-inputfilelocation-efsfilelocation", "UpdateType": "Immutable", "Required": false, "Type": "EfsInputFileLocation" }, "S3FileLocation": { "MarkdownDocumentation": "`S3FileLocation`\n\nSpecifies the details for the Amazon S3 file that's being copied or decrypted.\n*Required*: No\n*Type*: [S3InputFileLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-inputfilelocation.html#cfn-transfer-workflow-inputfilelocation-s3filelocation", "UpdateType": "Immutable", "Required": false, "Type": "S3InputFileLocation" } } }, "AWS::Transfer::Workflow.S3FileLocation": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.S3FileLocation`\n\nSpecifies the S3 details for the file being used, such as bucket, ETag, and so\nforth.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3filelocation.html", "Properties": { "S3FileLocation": { "MarkdownDocumentation": "`S3FileLocation`\n\nSpecifies the details for the file location for the file that's being used in the\nworkflow. Only applicable if you are using Amazon S3 storage.\n*Required*: No\n*Type*: [S3InputFileLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3filelocation.html#cfn-transfer-workflow-s3filelocation-s3filelocation", "UpdateType": "Immutable", "Required": false, "Type": "S3InputFileLocation" } } }, "AWS::Transfer::Workflow.S3InputFileLocation": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.S3InputFileLocation`\n\nSpecifies the details for the Amazon S3 location for an input file to a\nworkflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nSpecifies the S3 bucket for the customer input file.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html#cfn-transfer-workflow-s3inputfilelocation-bucket", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html#cfn-transfer-workflow-s3inputfilelocation-key", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Workflow.S3Tag": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.S3Tag`\n\nSpecifies the key-value pair that are assigned to a file during the execution of a\nTagging step.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3tag.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value that corresponds to the key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3tag.html#cfn-transfer-workflow-s3tag-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe name assigned to the tag that you create.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3tag.html#cfn-transfer-workflow-s3tag-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Transfer::Workflow.TagStepDetails": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.TagStepDetails`\n\nDetails for a step that creates one or more tags.\nYou specify one or more tags. Each tag contains a key-value pair.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-tagstepdetails.html", "Properties": { "SourceFileLocation": { "MarkdownDocumentation": "`SourceFileLocation`\n\nSpecifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\nfor the workflow.\n* To use the previous file as the input, enter `${previous.file}`.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.\n* To use the originally uploaded file location as input for this step, enter `${original.file}`.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\$\\{(\\w+.)+\\w+\\}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-tagstepdetails.html#cfn-transfer-workflow-tagstepdetails-sourcefilelocation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nArray that contains from 1 to 10 key/value pairs.\n*Required*: No\n*Type*: Array of [S3Tag](./aws-properties-transfer-workflow-s3tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-tagstepdetails.html#cfn-transfer-workflow-tagstepdetails-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "S3Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the step, used as an identifier.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w-]*$`\n*Minimum*: `0`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-tagstepdetails.html#cfn-transfer-workflow-tagstepdetails-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Transfer::Workflow.WorkflowStep": { "MarkdownDocumentation": "`AWS::Transfer::Workflow.WorkflowStep`\n\nThe basic building block of a workflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html", "Properties": { "CustomStepDetails": { "MarkdownDocumentation": "`CustomStepDetails`\n\nDetails 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-customstepdetails", "UpdateType": "Immutable", "Required": false, "Type": "CustomStepDetails" }, "CopyStepDetails": { "MarkdownDocumentation": "`CopyStepDetails`\n\nDetails for a step that performs a file copy.\nConsists 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.\n The default is `FALSE`.\n*Required*: No\n*Type*: [CopyStepDetails](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-copystepdetails", "UpdateType": "Immutable", "Required": false, "Type": "CopyStepDetails" }, "DecryptStepDetails": { "MarkdownDocumentation": "`DecryptStepDetails`\n\nDetails for a step that decrypts an encrypted file.\nConsists of the following values:\n* A descriptive name\n* An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the\n source file to decrypt.\n* An S3 or Amazon EFS location for the destination of the file\n decryption.\n* A flag that indicates whether to overwrite an existing file of the same name.\n The default is `FALSE`.\n* The type of encryption that's used. Currently, only PGP encryption is\n supported.\n*Required*: No\n*Type*: [DecryptStepDetails](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-decryptstepdetails", "UpdateType": "Immutable", "Required": false, "Type": "DecryptStepDetails" }, "Type": { "MarkdownDocumentation": "`Type`\n\nCurrently, 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*Allowed values*: `COPY | CUSTOM | DECRYPT | D...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "COPY", "CUSTOM", "DECRYPT", "DELETE", "TAG" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TagStepDetails": { "MarkdownDocumentation": "`TagStepDetails`\n\nDetails 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-tagstepdetails", "UpdateType": "Immutable", "Required": false, "Type": "TagStepDetails" }, "DeleteStepDetails": { "MarkdownDocumentation": "`DeleteStepDetails`\n\nDetails for a step that deletes the file.\n*Required*: No\n*Type*: [DeleteStepDetails](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-deletestepdetails", "UpdateType": "Immutable", "Required": false, "Type": "DeleteStepDetails" } } }, "AWS::VerifiedPermissions::IdentitySource.CognitoGroupConfiguration": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource.CognitoGroupConfiguration`\n\nThe type of entity that a policy store maps to groups from an Amazon Cognito user\npool identity source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitogroupconfiguration.html", "Properties": { "GroupEntityType": { "MarkdownDocumentation": "`GroupEntityType`\n\nThe name of the schema entity type that's mapped to the user pool group. Defaults\nto `AWS::CognitoGroup`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitogroupconfiguration.html#cfn-verifiedpermissions-identitysource-cognitogroupconfiguration-groupentitytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::IdentitySource.CognitoUserPoolConfiguration": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource.CognitoUserPoolConfiguration`\n\nA structure that contains configuration information used when creating or updating an\nidentity source that represents a connection to an Amazon Cognito user pool used as\nan identity provider for Verified Permissions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html", "Properties": { "UserPoolArn": { "MarkdownDocumentation": "`UserPoolArn`\n\nThe [Amazon Resource Name (ARN)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) of the Amazon Cognito user pool that\ncontains the identities to be authorized.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[a-zA-Z0-9-]+:cognito-idp:(([a-zA-Z0-9-]+:\\d{12}:userpool/[\\w-]+_[0-9a-zA-Z]+))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html#cfn-verifiedpermissions-identitysource-cognitouserpoolconfiguration-userpoolarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GroupConfiguration": { "MarkdownDocumentation": "`GroupConfiguration`\n\nThe type of entity that a policy store maps to groups from an Amazon Cognito user\npool identity source.\n*Required*: No\n*Type*: [CognitoGroupConfiguration](./aws-properties-verifiedpermissions-identitysource-cognitogroupconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html#cfn-verifiedpermissions-identitysource-cognitouserpoolconfiguration-groupconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CognitoGroupConfiguration" }, "ClientIds": { "MarkdownDocumentation": "`ClientIds`\n\nThe unique application client IDs that are associated with the specified Amazon Cognito user\npool.\nExample: `\"ClientIds\": [\"&ExampleCogClientId;\"]`\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `255 | 1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html#cfn-verifiedpermissions-identitysource-cognitouserpoolconfiguration-clientids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::VerifiedPermissions::IdentitySource.IdentitySourceConfiguration": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource.IdentitySourceConfiguration`\n\nA structure that contains configuration information used when creating or updating a\nnew identity source.\n###### Note\nAt this time, the only valid member of this structure is a Amazon Cognito user\npool configuration.\nYou must specify a `userPoolArn`, and optionally, a\n`ClientId`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-identitysourceconfiguration.html", "Properties": { "CognitoUserPoolConfiguration": { "MarkdownDocumentation": "`CognitoUserPoolConfiguration`\n\nA structure that contains configuration information used when creating or updating an\nidentity source that represents a connection to an Amazon Cognito user pool used as\nan identity provider for Verified Permissions.\n*Required*: No\n*Type*: [CognitoUserPoolConfiguration](./aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-identitysourceconfiguration.html#cfn-verifiedpermissions-identitysource-identitysourceconfiguration-cognitouserpoolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CognitoUserPoolConfiguration" }, "OpenIdConnectConfiguration": { "MarkdownDocumentation": "`OpenIdConnectConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [OpenIdConnectConfiguration](./aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-identitysourceconfiguration.html#cfn-verifiedpermissions-identitysource-identitysourceconfiguration-openidconnectconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "OpenIdConnectConfiguration" } } }, "AWS::VerifiedPermissions::IdentitySource.OpenIdConnectAccessTokenConfiguration": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource.OpenIdConnectAccessTokenConfiguration`\n\nThe configuration of an OpenID Connect (OIDC) identity source for handling access token\nclaims. Contains the claim that you want to identify as the principal in an authorization\nrequest, and the values of the `aud` claim, or audiences, that you want to\naccept.\nThis data type is part of a [OpenIdConnectTokenSelection](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelection.html) structure, which is a parameter of [CreateIdentitySource](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html", "Properties": { "Audiences": { "MarkdownDocumentation": "`Audiences`\n\nThe access token `aud` claim values that you want to accept in your policy\nstore. For example, `https://myapp.example.com, https://myapp2.example.com`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `255 | 255`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration-audiences", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PrincipalIdClaim": { "MarkdownDocumentation": "`PrincipalIdClaim`\n\nThe claim that determines the principal in OIDC access tokens. For example,\n`sub`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration-principalidclaim", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::IdentitySource.OpenIdConnectConfiguration": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource.OpenIdConnectConfiguration`\n\nContains configuration details of an OpenID Connect (OIDC) identity provider, or\nidentity source, that Verified Permissions can use to generate entities from authenticated identities. It\nspecifies the issuer URL, token type that you want to use, and policy store entity\ndetails.\nThis data type is part of a [Configuration](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html) structure, which\nis a parameter to [CreateIdentitySource](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html", "Properties": { "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nThe issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\nendpoint at the path `.well-known/openid-configuration`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^https://.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectconfiguration-issuer", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TokenSelection": { "MarkdownDocumentation": "`TokenSelection`\n\nThe token type that you want to process from your OIDC identity provider. Your policy\nstore can process either identity (ID) or access tokens from a given OIDC identity\nsource.\n*Required*: Yes\n*Type*: [OpenIdConnectTokenSelection](./aws-properties-verifiedpermissions-identitysource-openidconnecttokenselection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectconfiguration-tokenselection", "UpdateType": "Mutable", "Required": true, "Type": "OpenIdConnectTokenSelection" }, "GroupConfiguration": { "MarkdownDocumentation": "`GroupConfiguration`\n\nThe claim in OIDC identity provider tokens that indicates a user's group membership, and\nthe entity type that you want to map it to. For example, this object can map the contents\nof a `groups` claim to `MyCorp::UserGroup`.\n*Required*: No\n*Type*: [OpenIdConnectGroupConfiguration](./aws-properties-verifiedpermissions-identitysource-openidconnectgroupconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectconfiguration-groupconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "OpenIdConnectGroupConfiguration" }, "EntityIdPrefix": { "MarkdownDocumentation": "`EntityIdPrefix`\n\nA descriptive string that you want to prefix to user entities from your OIDC identity\nprovider. For example, if you set an `entityIdPrefix` of\n`MyOIDCProvider`, you can reference principals in your policies in the format\n`MyCorp::User::MyOIDCProvider|Carlos`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectconfiguration-entityidprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::IdentitySource.OpenIdConnectGroupConfiguration": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource.OpenIdConnectGroupConfiguration`\n\nThe claim in OIDC identity provider tokens that indicates a user's group membership, and\nthe entity type that you want to map it to. For example, this object can map the contents\nof a `groups` claim to `MyCorp::UserGroup`.\nThis data type is part of a [OpenIdConnectConfiguration](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfiguration.html) structure, which is a parameter of [CreateIdentitySource](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectgroupconfiguration.html", "Properties": { "GroupEntityType": { "MarkdownDocumentation": "`GroupEntityType`\n\nThe policy store entity type that you want to map your users' group claim to. For example,\n`MyCorp::UserGroup`. A group entity type is an entity that can have a user\nentity type as a member.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectgroupconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectgroupconfiguration-groupentitytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GroupClaim": { "MarkdownDocumentation": "`GroupClaim`\n\nThe token claim that you want Verified Permissions to interpret as group membership. For example,\n`groups`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectgroupconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectgroupconfiguration-groupclaim", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::IdentitySource.OpenIdConnectIdentityTokenConfiguration": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource.OpenIdConnectIdentityTokenConfiguration`\n\nThe configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)\ntoken claims. Contains the claim that you want to identify as the principal in an\nauthorization request, and the values of the `aud` claim, or audiences, that\nyou want to accept.\nThis data type is part of a [OpenIdConnectTokenSelection](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelection.html) structure, which is a parameter of [CreateIdentitySource](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration.html", "Properties": { "ClientIds": { "MarkdownDocumentation": "`ClientIds`\n\nThe ID token audience, or client ID, claim values that you want to accept in your policy\nstore from an OIDC identity provider. For example, `1example23456789,\n2example10111213`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `255 | 1000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration-clientids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PrincipalIdClaim": { "MarkdownDocumentation": "`PrincipalIdClaim`\n\nThe claim that determines the principal in OIDC access tokens. For example,\n`sub`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration-principalidclaim", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::IdentitySource.OpenIdConnectTokenSelection": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource.OpenIdConnectTokenSelection`\n\nThe token type that you want to process from your OIDC identity provider. Your policy\nstore can process either identity (ID) or access tokens from a given OIDC identity\nsource.\nThis data type is part of a [OpenIdConnectConfiguration](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfiguration.html) structure, which is a parameter of [CreateIdentitySource](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnecttokenselection.html", "Properties": { "AccessTokenOnly": { "MarkdownDocumentation": "`AccessTokenOnly`\n\nThe OIDC configuration for processing access tokens. Contains allowed audience claims,\nfor example `https://auth.example.com`, and the claim that you want to map to the\nprincipal, for example `sub`.\n*Required*: No\n*Type*: [OpenIdConnectAccessTokenConfiguration](./aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnecttokenselection.html#cfn-verifiedpermissions-identitysource-openidconnecttokenselection-accesstokenonly", "UpdateType": "Mutable", "Required": false, "Type": "OpenIdConnectAccessTokenConfiguration" }, "IdentityTokenOnly": { "MarkdownDocumentation": "`IdentityTokenOnly`\n\nThe OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\nclaims, for example `1example23456789`, and the claim that you want to map to\nthe principal, for example `sub`.\n*Required*: No\n*Type*: [OpenIdConnectIdentityTokenConfiguration](./aws-properties-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnecttokenselection.html#cfn-verifiedpermissions-identitysource-openidconnecttokenselection-identitytokenonly", "UpdateType": "Mutable", "Required": false, "Type": "OpenIdConnectIdentityTokenConfiguration" } } }, "AWS::VerifiedPermissions::Policy.EntityIdentifier": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::Policy.EntityIdentifier`\n\nContains the identifier of an entity in a policy, including its ID and type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-entityidentifier.html", "Properties": { "EntityType": { "MarkdownDocumentation": "`EntityType`\n\nThe type of an entity.\nExample: `\"entityType\":\"typeName\"`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-entityidentifier.html#cfn-verifiedpermissions-policy-entityidentifier-entitytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EntityId": { "MarkdownDocumentation": "`EntityId`\n\nThe identifier of an entity.\n`\"entityId\":\"identifier\"`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-entityidentifier.html#cfn-verifiedpermissions-policy-entityidentifier-entityid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::Policy.PolicyDefinition": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::Policy.PolicyDefinition`\n\nA structure that defines a Cedar policy. It includes the policy type, a description,\nand a policy body. This is a top level data type used to create a policy.\nThis data type is used as a request parameter for the [CreatePolicy](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html) operation. This structure must always have either an\n`Static` or a `TemplateLinked` element.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.html", "Properties": { "Static": { "MarkdownDocumentation": "`Static`\n\nA structure that describes a static policy. An static policy doesn't use a template or allow\nplaceholders for entities.\n*Required*: No\n*Type*: [StaticPolicyDefinition](./aws-properties-verifiedpermissions-policy-staticpolicydefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.html#cfn-verifiedpermissions-policy-policydefinition-static", "UpdateType": "Mutable", "Required": false, "Type": "StaticPolicyDefinition" }, "TemplateLinked": { "MarkdownDocumentation": "`TemplateLinked`\n\nA structure that describes a policy that was instantiated from a template. The\ntemplate can specify placeholders for `principal` and `resource`.\nWhen you use [CreatePolicy](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html) to create a policy from a template, you specify the exact\nprincipal and resource to use for the instantiated policy.\n*Required*: No\n*Type*: [TemplateLinkedPolicyDefinition](./aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.html#cfn-verifiedpermissions-policy-policydefinition-templatelinked", "UpdateType": "Mutable", "Required": false, "Type": "TemplateLinkedPolicyDefinition" } } }, "AWS::VerifiedPermissions::Policy.StaticPolicyDefinition": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::Policy.StaticPolicyDefinition`\n\nA structure that defines a static policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-staticpolicydefinition.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the static policy.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-staticpolicydefinition.html#cfn-verifiedpermissions-policy-staticpolicydefinition-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Statement": { "MarkdownDocumentation": "`Statement`\n\nThe policy content of the static policy, written in the Cedar policy language.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-staticpolicydefinition.html#cfn-verifiedpermissions-policy-staticpolicydefinition-statement", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::Policy.TemplateLinkedPolicyDefinition": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::Policy.TemplateLinkedPolicyDefinition`\n\nA structure that describes a policy created by instantiating a policy template.\n###### Note\nYou can't directly update a template-linked policy. You must update the associated\npolicy template instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html", "Properties": { "Resource": { "MarkdownDocumentation": "`Resource`\n\nThe resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n`?resource` placeholder in the policy template when it evaluates an authorization\nrequest.\n*Required*: No\n*Type*: [EntityIdentifier](./aws-properties-verifiedpermissions-policy-entityidentifier.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html#cfn-verifiedpermissions-policy-templatelinkedpolicydefinition-resource", "UpdateType": "Mutable", "Required": false, "Type": "EntityIdentifier" }, "PolicyTemplateId": { "MarkdownDocumentation": "`PolicyTemplateId`\n\nThe unique identifier of the policy template used to create this policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]*$`\n*Minimum*: `1`\n*Maximum*: `200`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html#cfn-verifiedpermissions-policy-templatelinkedpolicydefinition-policytemplateid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n`?principal` placeholder in the policy template when it evaluates an authorization\nrequest.\n*Required*: No\n*Type*: [EntityIdentifier](./aws-properties-verifiedpermissions-policy-entityidentifier.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html#cfn-verifiedpermissions-policy-templatelinkedpolicydefinition-principal", "UpdateType": "Mutable", "Required": false, "Type": "EntityIdentifier" } } }, "AWS::VerifiedPermissions::PolicyStore.DeletionProtection": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::PolicyStore.DeletionProtection`\n\nSpecifies whether the policy store can be deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policystore-deletionprotection.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nSpecifies whether the policy store can be deleted. If enabled, the policy store can't\nbe deleted.\nThe default state is `DISABLED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policystore-deletionprotection.html#cfn-verifiedpermissions-policystore-deletionprotection-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::PolicyStore.SchemaDefinition": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::PolicyStore.SchemaDefinition`\n\nContains a list of principal types, resource types, and actions that can be specified\nin policies stored in the same policy store. If the validation mode for the policy store is set to\n`STRICT`, then policies that can't be validated by this schema are\nrejected by Verified Permissions and can't be stored in the policy store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policystore-schemadefinition.html", "Properties": { "CedarJson": { "MarkdownDocumentation": "`CedarJson`\n\nA JSON string representation of the schema supported by applications that use this\npolicy store. For more information, see [Policy store schema](https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html)\nin the AVP User Guide.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policystore-schemadefinition.html#cfn-verifiedpermissions-policystore-schemadefinition-cedarjson", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CedarFormat": { "MarkdownDocumentation": "`CedarFormat`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policystore-schemadefinition.html#cfn-verifiedpermissions-policystore-schemadefinition-cedarformat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VerifiedPermissions::PolicyStore.ValidationSettings": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::PolicyStore.ValidationSettings`\n\nA structure that contains Cedar policy validation settings for the policy store. The\nvalidation mode determines which validation failures that Cedar considers serious enough\nto block acceptance of a new or edited static policy or policy template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policystore-validationsettings.html", "Properties": { "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe validation mode currently configured for this policy store. The valid values\nare:\n* **OFF** \u2013 Neither Verified Permissions nor Cedar\n perform any validation on policies. No validation errors are reported by either\n service.\n* **STRICT** \u2013 Requires a schema to be present in\n the policy store. Cedar performs validation on all submitted new or updated\n static policies and policy templates. Any that fail validation are rejected and\n Cedar doesn't store them in the policy store.\n###### Important\nIf `Mode=STRICT` and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no\nschema to validate against.\nTo submit a static policy or policy template without a schema, you must turn off\nvalidation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OFF | STRICT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OFF", "STRICT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policystore-validationsettings.html#cfn-verifiedpermissions-policystore-validationsettings-mode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VpcLattice::DomainVerification.TxtMethodConfig": { "MarkdownDocumentation": "`AWS::VpcLattice::DomainVerification.TxtMethodConfig`\n\nConfiguration for TXT record-based domain verification method.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-domainverification-txtmethodconfig.html", "Properties": { "name": { "MarkdownDocumentation": "`name`\n\nThe name of the TXT record that must be created for domain verification.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-domainverification-txtmethodconfig.html#cfn-vpclattice-domainverification-txtmethodconfig-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "value": { "MarkdownDocumentation": "`value`\n\nThe value that must be added to the TXT record for domain verification.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-domainverification-txtmethodconfig.html#cfn-vpclattice-domainverification-txtmethodconfig-value", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VpcLattice::Listener.DefaultAction": { "MarkdownDocumentation": "`AWS::VpcLattice::Listener.DefaultAction`\n\nThe action for the default rule. Each listener has a default rule. The default rule is used\nif no other rules match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-defaultaction.html", "Properties": { "Forward": { "MarkdownDocumentation": "`Forward`\n\nDescribes a forward action. You can use forward actions to route requests to one or more\ntarget groups.\n*Required*: No\n*Type*: [Forward](./aws-properties-vpclattice-listener-forward.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-defaultaction.html#cfn-vpclattice-listener-defaultaction-forward", "UpdateType": "Mutable", "Required": false, "Type": "Forward" }, "FixedResponse": { "MarkdownDocumentation": "`FixedResponse`\n\nDescribes an action that returns a custom HTTP response.\n*Required*: No\n*Type*: [FixedResponse](./aws-properties-vpclattice-listener-fixedresponse.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-defaultaction.html#cfn-vpclattice-listener-defaultaction-fixedresponse", "UpdateType": "Mutable", "Required": false, "Type": "FixedResponse" } } }, "AWS::VpcLattice::Listener.FixedResponse": { "MarkdownDocumentation": "`AWS::VpcLattice::Listener.FixedResponse`\n\nDescribes an action that returns a custom HTTP response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-fixedresponse.html", "Properties": { "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe HTTP response code. Only `404` and `500` status codes are supported.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `100`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-fixedresponse.html#cfn-vpclattice-listener-fixedresponse-statuscode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::VpcLattice::Listener.Forward": { "MarkdownDocumentation": "`AWS::VpcLattice::Listener.Forward`\n\nThe forward action. Traffic that matches the rule is forwarded to the specified target\ngroups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-forward.html", "Properties": { "TargetGroups": { "MarkdownDocumentation": "`TargetGroups`\n\nThe target groups. Traffic matching the rule is forwarded to the specified target groups.\nWith forward actions, you can assign a weight that controls the prioritization and selection of\neach target group. This means that requests are distributed to individual target groups based on\ntheir weights. For example, if two target groups have the same weight, each target group receives\nhalf of the traffic.\nThe default value is 1. This means that if only one target group is provided, there is no\nneed to set the weight; 100% of the traffic goes to that target group.\n*Required*: Yes\n*Type*: Array of [WeightedTargetGroup](./aws-properties-vpclattice-listener-weightedtargetgroup.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-forward.html#cfn-vpclattice-listener-forward-targetgroups", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "WeightedTargetGroup", "DuplicatesAllowed": true } } }, "AWS::VpcLattice::Listener.WeightedTargetGroup": { "MarkdownDocumentation": "`AWS::VpcLattice::Listener.WeightedTargetGroup`\n\nDescribes the weight of a target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-weightedtargetgroup.html", "Properties": { "Weight": { "MarkdownDocumentation": "`Weight`\n\nOnly required if you specify multiple target groups for a forward action. The weight\ndetermines how requests are distributed to the target group. For example, if you specify two\ntarget groups, each with a weight of 10, each target group receives half the requests. If you\nspecify two target groups, one with a weight of 10 and the other with a weight of 20, the target\ngroup with a weight of 20 receives twice as many requests as the other target group. If there's\nonly one target group specified, then the default value is 100.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-weightedtargetgroup.html#cfn-vpclattice-listener-weightedtargetgroup-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetGroupIdentifier": { "MarkdownDocumentation": "`TargetGroupIdentifier`\n\nThe ID of the target group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((tg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:targetgroup/tg-[0-9a-z]{17}))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-weightedtargetgroup.html#cfn-vpclattice-listener-weightedtargetgroup-targetgroupidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VpcLattice::ResourceConfiguration.DnsResource": { "MarkdownDocumentation": "`AWS::VpcLattice::ResourceConfiguration.DnsResource`\n\nThe domain name of the resource configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-resourceconfiguration-dnsresource.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address type for the resource configuration. Dualstack is not currently supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IPV4 | IPV6 | DUALSTACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6", "DUALSTACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-resourceconfiguration-dnsresource.html#cfn-vpclattice-resourceconfiguration-dnsresource-ipaddresstype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name of the resource configuration.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-resourceconfiguration-dnsresource.html#cfn-vpclattice-resourceconfiguration-dnsresource-domainname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VpcLattice::ResourceConfiguration.ResourceConfigurationDefinition": { "MarkdownDocumentation": "`AWS::VpcLattice::ResourceConfiguration.ResourceConfigurationDefinition`\n\nIdentifies the resource configuration in one of the following ways:\n* **Amazon Resource Name (ARN)** - Supported resource-types\n that are provisioned by AWS services, such as RDS databases, can be identified\n by their ARN.\n* **Domain name** - Any domain name that is publicly\n resolvable.\n* **IP address** - For IPv4 and IPv6, only IP addresses in the\n VPC are supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-resourceconfiguration-resourceconfigurationdefinition.html", "Properties": { "IpResource": { "MarkdownDocumentation": "`IpResource`\n\nThe IP address of the resource configuration.\n*Required*: No\n*Type*: String\n*Minimum*: `4`\n*Maximum*: `39`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-resourceconfiguration-resourceconfigurationdefinition.html#cfn-vpclattice-resourceconfiguration-resourceconfigurationdefinition-ipresource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DnsResource": { "MarkdownDocumentation": "`DnsResource`\n\nThe DNS name of the resource configuration.\n*Required*: No\n*Type*: [DnsResource](./aws-properties-vpclattice-resourceconfiguration-dnsresource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-resourceconfiguration-resourceconfigurationdefinition.html#cfn-vpclattice-resourceconfiguration-resourceconfigurationdefinition-dnsresource", "UpdateType": "Mutable", "Required": false, "Type": "DnsResource" }, "ArnResource": { "MarkdownDocumentation": "`ArnResource`\n\nThe Amazon Resource Name (ARN) of the resource configuration. For the ARN syntax and format, see [ARN format](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html#arns-syntax) in\nthe *AWS Identity and Access Management user guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn.*`\n*Maximum*: `1224`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-resourceconfiguration-resourceconfigurationdefinition.html#cfn-vpclattice-resourceconfiguration-resourceconfigurationdefinition-arnresource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VpcLattice::Rule.Action": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.Action`\n\nDescribes the action for a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-action.html", "Properties": { "Forward": { "MarkdownDocumentation": "`Forward`\n\nThe forward action. Traffic that matches the rule is forwarded to the specified target\ngroups.\n*Required*: No\n*Type*: [Forward](./aws-properties-vpclattice-rule-forward.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-action.html#cfn-vpclattice-rule-action-forward", "UpdateType": "Mutable", "Required": false, "Type": "Forward" }, "FixedResponse": { "MarkdownDocumentation": "`FixedResponse`\n\nThe fixed response action. The rule returns a custom HTTP response.\n*Required*: No\n*Type*: [FixedResponse](./aws-properties-vpclattice-rule-fixedresponse.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-action.html#cfn-vpclattice-rule-action-fixedresponse", "UpdateType": "Mutable", "Required": false, "Type": "FixedResponse" } } }, "AWS::VpcLattice::Rule.FixedResponse": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.FixedResponse`\n\nDescribes an action that returns a custom HTTP response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-fixedresponse.html", "Properties": { "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe HTTP response code. Only `404` and `500` status codes are supported.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `100`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-fixedresponse.html#cfn-vpclattice-rule-fixedresponse-statuscode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::VpcLattice::Rule.Forward": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.Forward`\n\nThe forward action. Traffic that matches the rule is forwarded to the specified target\ngroups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-forward.html", "Properties": { "TargetGroups": { "MarkdownDocumentation": "`TargetGroups`\n\nThe target groups. Traffic matching the rule is forwarded to the specified target groups.\nWith forward actions, you can assign a weight that controls the prioritization and selection of\neach target group. This means that requests are distributed to individual target groups based on\ntheir weights. For example, if two target groups have the same weight, each target group receives\nhalf of the traffic.\nThe default value is 1. This means that if only one target group is provided, there is no\nneed to set the weight; 100% of the traffic goes to that target group.\n*Required*: Yes\n*Type*: Array of [WeightedTargetGroup](./aws-properties-vpclattice-rule-weightedtargetgroup.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-forward.html#cfn-vpclattice-rule-forward-targetgroups", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "WeightedTargetGroup", "DuplicatesAllowed": true } } }, "AWS::VpcLattice::Rule.HeaderMatch": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.HeaderMatch`\n\nDescribes the constraints for a header match. Matches incoming requests with rule based on\nrequest header value before applying rule action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatch.html", "Properties": { "CaseSensitive": { "MarkdownDocumentation": "`CaseSensitive`\n\nIndicates whether the match is case sensitive.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatch.html#cfn-vpclattice-rule-headermatch-casesensitive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the header.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatch.html#cfn-vpclattice-rule-headermatch-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Match": { "MarkdownDocumentation": "`Match`\n\nThe header match type.\n*Required*: Yes\n*Type*: [HeaderMatchType](./aws-properties-vpclattice-rule-headermatchtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatch.html#cfn-vpclattice-rule-headermatch-match", "UpdateType": "Mutable", "Required": true, "Type": "HeaderMatchType" } } }, "AWS::VpcLattice::Rule.HeaderMatchType": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.HeaderMatchType`\n\nDescribes a header match type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatchtype.html", "Properties": { "Contains": { "MarkdownDocumentation": "`Contains`\n\nA contains type match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatchtype.html#cfn-vpclattice-rule-headermatchtype-contains", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Exact": { "MarkdownDocumentation": "`Exact`\n\nAn exact type match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatchtype.html#cfn-vpclattice-rule-headermatchtype-exact", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nA prefix type match. Matches the value with the prefix.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatchtype.html#cfn-vpclattice-rule-headermatchtype-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VpcLattice::Rule.HttpMatch": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.HttpMatch`\n\nDescribes criteria that can be applied to incoming requests.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-httpmatch.html", "Properties": { "HeaderMatches": { "MarkdownDocumentation": "`HeaderMatches`\n\nThe header matches. Matches incoming requests with rule based on request header value before\napplying rule action.\n*Required*: No\n*Type*: Array of [HeaderMatch](./aws-properties-vpclattice-rule-headermatch.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-httpmatch.html#cfn-vpclattice-rule-httpmatch-headermatches", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HeaderMatch", "DuplicatesAllowed": true }, "PathMatch": { "MarkdownDocumentation": "`PathMatch`\n\nThe path match.\n*Required*: No\n*Type*: [PathMatch](./aws-properties-vpclattice-rule-pathmatch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-httpmatch.html#cfn-vpclattice-rule-httpmatch-pathmatch", "UpdateType": "Mutable", "Required": false, "Type": "PathMatch" }, "Method": { "MarkdownDocumentation": "`Method`\n\nThe HTTP method type.\n*Required*: No\n*Type*: String\n*Allowed values*: `CONNECT | DELETE | GET | HE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "POST", "PUT", "TRACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-httpmatch.html#cfn-vpclattice-rule-httpmatch-method", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VpcLattice::Rule.Match": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.Match`\n\nDescribes a rule match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-match.html", "Properties": { "HttpMatch": { "MarkdownDocumentation": "`HttpMatch`\n\nThe HTTP criteria that a rule must match.\n*Required*: Yes\n*Type*: [HttpMatch](./aws-properties-vpclattice-rule-httpmatch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-match.html#cfn-vpclattice-rule-match-httpmatch", "UpdateType": "Mutable", "Required": true, "Type": "HttpMatch" } } }, "AWS::VpcLattice::Rule.PathMatch": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.PathMatch`\n\nDescribes the conditions that can be applied when matching a path for incoming\nrequests.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatch.html", "Properties": { "CaseSensitive": { "MarkdownDocumentation": "`CaseSensitive`\n\nIndicates whether the match is case sensitive.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatch.html#cfn-vpclattice-rule-pathmatch-casesensitive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Match": { "MarkdownDocumentation": "`Match`\n\nThe type of path match.\n*Required*: Yes\n*Type*: [PathMatchType](./aws-properties-vpclattice-rule-pathmatchtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatch.html#cfn-vpclattice-rule-pathmatch-match", "UpdateType": "Mutable", "Required": true, "Type": "PathMatchType" } } }, "AWS::VpcLattice::Rule.PathMatchType": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.PathMatchType`\n\nDescribes a path match type. Each rule can include only one of the following types of\npaths.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatchtype.html", "Properties": { "Exact": { "MarkdownDocumentation": "`Exact`\n\nAn exact match of the path.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\/[a-zA-Z0-9@:%_+.~#?&\\/=-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatchtype.html#cfn-vpclattice-rule-pathmatchtype-exact", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nA prefix match of the path.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\/[a-zA-Z0-9@:%_+.~#?&\\/=-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatchtype.html#cfn-vpclattice-rule-pathmatchtype-prefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VpcLattice::Rule.WeightedTargetGroup": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule.WeightedTargetGroup`\n\nDescribes the weight of a target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html", "Properties": { "Weight": { "MarkdownDocumentation": "`Weight`\n\nOnly required if you specify multiple target groups for a forward action. The weight\ndetermines how requests are distributed to the target group. For example, if you specify two\ntarget groups, each with a weight of 10, each target group receives half the requests. If you\nspecify two target groups, one with a weight of 10 and the other with a weight of 20, the target\ngroup with a weight of 20 receives twice as many requests as the other target group. If there's\nonly one target group specified, then the default value is 100.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html#cfn-vpclattice-rule-weightedtargetgroup-weight", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetGroupIdentifier": { "MarkdownDocumentation": "`TargetGroupIdentifier`\n\nThe ID of the target group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((tg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:targetgroup/tg-[0-9a-z]{17}))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html#cfn-vpclattice-rule-weightedtargetgroup-targetgroupidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VpcLattice::Service.DnsEntry": { "MarkdownDocumentation": "`AWS::VpcLattice::Service.DnsEntry`\n\nDescribes the DNS information of a service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.html", "Properties": { "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.html#cfn-vpclattice-service-dnsentry-domainname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.html#cfn-vpclattice-service-dnsentry-hostedzoneid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VpcLattice::ServiceNetwork.SharingConfig": { "MarkdownDocumentation": "`AWS::VpcLattice::ServiceNetwork.SharingConfig`\n\nSpecify if the service network should be enabled for sharing.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-servicenetwork-sharingconfig.html", "Properties": { "enabled": { "MarkdownDocumentation": "`enabled`\n\nSpecify if the service network should be enabled for sharing.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-servicenetwork-sharingconfig.html#cfn-vpclattice-servicenetwork-sharingconfig-enabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::VpcLattice::ServiceNetworkServiceAssociation.DnsEntry": { "MarkdownDocumentation": "`AWS::VpcLattice::ServiceNetworkServiceAssociation.DnsEntry`\n\nThe DNS information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-servicenetworkserviceassociation-dnsentry.html", "Properties": { "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-servicenetworkserviceassociation-dnsentry.html#cfn-vpclattice-servicenetworkserviceassociation-dnsentry-domainname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-servicenetworkserviceassociation-dnsentry.html#cfn-vpclattice-servicenetworkserviceassociation-dnsentry-hostedzoneid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VpcLattice::ServiceNetworkVpcAssociation.DnsOptions": { "MarkdownDocumentation": "`AWS::VpcLattice::ServiceNetworkVpcAssociation.DnsOptions`\n\nThe DNS configuration options.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-servicenetworkvpcassociation-dnsoptions.html", "Properties": { "PrivateDnsSpecifiedDomains": { "MarkdownDocumentation": "`PrivateDnsSpecifiedDomains`\n\nIndicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is `VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS` or `SPECIFIED_DOMAINS_ONLY`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `255 | 10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-servicenetworkvpcassociation-dnsoptions.html#cfn-vpclattice-servicenetworkvpcassociation-dnsoptions-privatednsspecifieddomains", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PrivateDnsPreference": { "MarkdownDocumentation": "`PrivateDnsPreference`\n\nThe preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.\n*Required*: No\n*Type*: String\n*Allowed values*: `VERIFIED_DOMAINS_ONLY | ALL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "VERIFIED_DOMAINS_ONLY", "ALL_DOMAINS", "VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS", "SPECIFIED_DOMAINS_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-servicenetworkvpcassociation-dnsoptions.html#cfn-vpclattice-servicenetworkvpcassociation-dnsoptions-privatednspreference", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::VpcLattice::TargetGroup.HealthCheckConfig": { "MarkdownDocumentation": "`AWS::VpcLattice::TargetGroup.HealthCheckConfig`\n\nDescribes the health check configuration of a target group. Health check configurations\naren't used for target groups of type `LAMBDA` or `ALB`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe destination for health checks on the targets. If the protocol version is\n`HTTP/1.1` or `HTTP/2`, specify a valid URI (for example,\n`/path?query`). The default path is `/`. Health checks are not supported\nif the protocol version is `gRPC`, however, you can choose `HTTP/1.1` or\n`HTTP/2` and specify a valid URI.\n*Required*: No\n*Type*: String\n*Pattern*: `(^/[a-zA-Z0-9@:%_+.~#?&/=-]*$|(^$))`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HealthCheckIntervalSeconds": { "MarkdownDocumentation": "`HealthCheckIntervalSeconds`\n\nThe approximate amount of time, in seconds, between health checks of an individual target.\nThe range is 5\u2013300 seconds. The default is 30 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-healthcheckintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Matcher": { "MarkdownDocumentation": "`Matcher`\n\nThe codes to use when checking for a successful response from a target.\n*Required*: No\n*Type*: [Matcher](./aws-properties-vpclattice-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-matcher", "UpdateType": "Mutable", "Required": false, "Type": "Matcher" }, "HealthyThresholdCount": { "MarkdownDocumentation": "`HealthyThresholdCount`\n\nThe number of consecutive successful health checks required before considering an unhealthy\ntarget healthy. The range is 2\u201310. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-healthythresholdcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port used when performing health checks on targets. The default setting is the port that\na target receives traffic 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether health checking 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol used when performing health checks on targets. The possible protocols are\n`HTTP` and `HTTPS`. The default is `HTTP`.\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)", "RefReturnValue": "", "AllowedValues": [ "HTTP", "HTTPS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProtocolVersion": { "MarkdownDocumentation": "`ProtocolVersion`\n\nThe protocol version used when performing health checks on targets. The possible protocol\nversions are `HTTP1` and `HTTP2`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTP1 | HTTP2...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HTTP1", "HTTP2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-protocolversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UnhealthyThresholdCount": { "MarkdownDocumentation": "`UnhealthyThresholdCount`\n\nThe number of consecutive failed health checks required before considering a target\nunhealthy. The range is 2\u201310. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-unhealthythresholdcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HealthCheckTimeoutSeconds": { "MarkdownDocumentation": "`HealthCheckTimeoutSeconds`\n\nThe amount of time, in seconds, to wait before reporting a target as unhealthy. The range is\n1\u2013120 seconds. The default is 5 seconds.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-healthcheckconfig.html#cfn-vpclattice-targetgroup-healthcheckconfig-healthchecktimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::VpcLattice::TargetGroup.Matcher": { "MarkdownDocumentation": "`AWS::VpcLattice::TargetGroup.Matcher`\n\nDescribes the codes to use when checking for a successful response from a target for health\nchecks.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-matcher.html", "Properties": { "HttpCode": { "MarkdownDocumentation": "`HttpCode`\n\nThe HTTP code to use when checking for a successful response from a target.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9-,]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-matcher.html#cfn-vpclattice-targetgroup-matcher-httpcode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VpcLattice::TargetGroup.Target": { "MarkdownDocumentation": "`AWS::VpcLattice::TargetGroup.Target`\n\nDescribes a target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-target.html", "Properties": { "Port": { "MarkdownDocumentation": "`Port`\n\nThe port on which the target is listening. For HTTP, the default is 80. For HTTPS, the\ndefault is 443.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-target.html#cfn-vpclattice-targetgroup-target-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe ID of the target. If the target group type is `INSTANCE`, this is an instance\nID. If the target group type is `IP`, this is an IP address. If the target group type\nis `LAMBDA`, this is the ARN of a Lambda function. If the target group type is\n`ALB`, this is the ARN of an Application Load Balancer.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-target.html#cfn-vpclattice-targetgroup-target-id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VpcLattice::TargetGroup.TargetGroupConfig": { "MarkdownDocumentation": "`AWS::VpcLattice::TargetGroup.TargetGroupConfig`\n\nDescribes the configuration of a target group.\nFor more information, see [Target groups](https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-groups.html) in the\n*Amazon VPC Lattice User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe type of IP address used for the target group. Supported only if the target group type is\n`IP`. The default is `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)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-ipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the\ndefault is 443. Not supported if the target group type is `LAMBDA`.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-port", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "HealthCheck": { "MarkdownDocumentation": "`HealthCheck`\n\nThe health check configuration. Not supported if the target group type is\n`LAMBDA` or `ALB`.\n*Required*: No\n*Type*: [HealthCheckConfig](./aws-properties-vpclattice-targetgroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-healthcheck", "UpdateType": "Mutable", "Required": false, "Type": "HealthCheckConfig" }, "LambdaEventStructureVersion": { "MarkdownDocumentation": "`LambdaEventStructureVersion`\n\nThe version of the event structure that your Lambda function receives. Supported only if the\ntarget group type is `LAMBDA`. The default is `V1`.\n*Required*: No\n*Type*: String\n*Allowed values*: `V1 | V2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "V1", "V2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-lambdaeventstructureversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcIdentifier": { "MarkdownDocumentation": "`VpcIdentifier`\n\nThe ID of the VPC. Not supported if the target group type is `LAMBDA`.\n*Required*: No\n*Type*: String\n*Pattern*: `^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$`\n*Minimum*: `5`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-vpcidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol to use for routing traffic to the targets. The default is the protocol of the\ntarget group. Not supported if the target group type is `LAMBDA`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTP | HTTPS | TCP...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "HTTP", "HTTPS", "TCP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ProtocolVersion": { "MarkdownDocumentation": "`ProtocolVersion`\n\nThe protocol version. The default is `HTTP1`. Not supported if the target group\ntype is `LAMBDA`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTP1 | HTTP2 | GRPC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "HTTP1", "HTTP2", "GRPC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-protocolversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAF::ByteMatchSet.ByteMatchTuple": { "MarkdownDocumentation": "`AWS::WAF::ByteMatchSet.ByteMatchTuple`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html", "Properties": { "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of a web request that you want to inspect, such as a specified header or a query string.\n*Required*: Yes\n*Type*: [FieldToMatch](./aws-properties-waf-bytematchset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch", "Required": true, "Type": "FieldToMatch", "UpdateType": "Mutable" }, "PositionalConstraint": { "MarkdownDocumentation": "`PositionalConstraint`\n\nWithin the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:\n**CONTAINS**\nThe specified part of the web request must include the value of `TargetString`, but the location doesn't matter.\n**CONTAINS\\_WORD**\nThe specified part of the web request must include the value of `TargetString`, and\n`TargetString` must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or \\_). In addition,\n`TargetString` must be a word, which means one of the following:\n* `TargetString` exactly matches the value of the specified part of the web request, such as the value of a\n header.\n* `TargetString` is at the beginning of the specified part of the web request and is followed by a character\n other than an alphanumeric character or underscore (\\_), for example, `BadBot;`.\n* `TargetString` is at the end of the specified part of the web request and is preceded by a character\n other than an alphanumeric character or underscore (\\_), for example, `;BadBot`.\n* `TargetString` is in the middle of the specified part of the web request and is preceded and followed\n by characters other than alphanumeric characters or underscore (\\_), for example, `-BadBot;`.\n**EXACTLY**\nThe value of the specified part of the web request must exactly match the value of `TargetString`.\n**STARTS\\_WITH**\nThe value of `TargetString` must appear at the beginning of the specified part of the web request.\n**ENDS\\_WITH**\nThe value of `TargetString` must appear at the end of the specified part of the web request.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EXACTLY | STARTS_WITH | END...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXACTLY", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "CONTAINS_WORD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-positionalconstraint", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "TargetString": { "MarkdownDocumentation": "`TargetString`\n\nThe value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you\nspecified in `FieldToMatch`. The maximum length of the value is 50 bytes.\nYou must specify this property or the `TargetStringBase64` property.\nValid values depend on the values that you specified for `FieldToMatch`:\n* `HEADER`: The value that you want AWS WAF to search for in the request header that you specified in\n `FieldToMatch`, for example, the value of the `User-Agent` or `Referer` header.\n* `METHOD`: The HTTP method, which indicates the type of operation specified in the request.\n Amazon CloudFront supports the following methods: `DELETE`, `GET`, `HEAD`, `OPTIONS`,\n `PATCH`, `POST`, and `PUT`.\n* `QUERY_STRING`: The value that you want AWS WAF to search for in the query string, which is the part\n of a URL that appears after a `?` character.\n* `URI`: The value that you want AWS WAF to search for in the part of a URL that identifies a resource,\n for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but instead of\n inspecting a single parameter, AWS WAF inspects all parameters within the query\n string for the value or regex pattern that you specify in\n `TargetString`.\nIf `TargetString` includes alphabetic characters A-Z and a-z, note that the value is case sensitive.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-targetstring", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "TargetStringBase64": { "MarkdownDocumentation": "`TargetStringBase64`\n\nThe base64-encoded value that AWS WAF searches for. AWS CloudFormation sends this value to AWS WAF without encoding it.\nYou must specify this property or the `TargetString` property.\nAWS WAF searches for this value in a specific part of web requests, which you define in the `FieldToMatch` property.\nValid values depend on the Type value in the `FieldToMatch` property. For example, for a `METHOD` type, you must specify HTTP methods such as `DELETE, GET, HEAD, OPTIONS, PATCH, POST`, and `PUT`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-targetstringbase64", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "TextTransformation": { "MarkdownDocumentation": "`TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.\nIf 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\ncommand and using unusual formatting to disguise some or all of the command, use this\noption 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\nthe following operations:\n* Replaces `(ampersand)quot;` with `\"`\n* Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160\n* Replaces `(ampersand)lt;` with a \"less than\" symbol\n* Replaces `(ampersand)gt;` with `>`\n* Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding\n characters\n* Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding\n 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*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-texttransformation", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::ByteMatchSet.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAF::ByteMatchSet.FieldToMatch`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies where in a web request to look for `TargetString`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html", "Properties": { "Data": { "MarkdownDocumentation": "`Data`\n\nWhen the value of `Type` is `HEADER`, enter the name of the header that you want AWS WAF to search,\nfor example, `User-Agent` or `Referer`. The name of the header is not case sensitive.\nWhen the value of `Type` is `SINGLE_QUERY_ARG`, enter the name of the parameter that you want AWS WAF to search,\nfor example, `UserName` or `SalesRegion`. The parameter name is not case sensitive.\nIf the value of `Type` is any other value, omit `Data`.\n*Required*: No\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch-data", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:\n* `HEADER`: A specified request header, for example, the value of the `User-Agent` or `Referer` header.\n If you choose `HEADER` for the type, specify the name of the header in `Data`.\n* `METHOD`: The HTTP method, which indicated the type of operation that the request is asking the origin to perform.\n Amazon CloudFront supports the following methods: `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`,\n `POST`, and `PUT`.\n* `QUERY_STRING`: A query string, which is the part of a URL that appears after a `?` character, if any.\n* `URI`: The part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in\n `TargetString`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `URI | QUERY_STRING | HEADER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY", "SINGLE_QUERY_ARG", "ALL_QUERY_ARGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::IPSet.IPSetDescriptor": { "MarkdownDocumentation": "`AWS::WAF::IPSet.IPSetDescriptor`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies the IP address type (`IPV4` or `IPV6`) and the IP address range (in CIDR format) that web requests originate from.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-ipset-ipsetdescriptors.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecify `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)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-ipset-ipsetdescriptors.html#cfn-waf-ipset-ipsetdescriptors-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Value": { "MarkdownDocumentation": "`Value`\n\nSpecify an IPv4 address by using CIDR notation. For example:\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\n `192.0.2.0/24`.\nFor more information about CIDR notation, see the Wikipedia entry\n[Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\nSpecify an IPv6 address by using CIDR notation. For example:\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`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-ipset-ipsetdescriptors.html#cfn-waf-ipset-ipsetdescriptors-value", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::Rule.Predicate": { "MarkdownDocumentation": "`AWS::WAF::Rule.Predicate`\n\nSpecifies the `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, and `SizeConstraintSet` objects\nthat you want to add to a `Rule` and, for each object, indicates whether you want to negate the settings, for example, requests that do\nNOT originate from the IP address 192.0.2.44.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html", "Properties": { "DataId": { "MarkdownDocumentation": "`DataId`\n\nA unique identifier for a predicate in a `Rule`, such as `ByteMatchSetId` or `IPSetId`.\nThe ID is returned by the corresponding `Create` or `List` command.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-dataid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Negated": { "MarkdownDocumentation": "`Negated`\n\nSet `Negated` to `False` if you want AWS WAF to allow, block, or count requests based on the settings in the\nspecified `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, or `SizeConstraintSet`.\nFor example, if an `IPSet` includes the IP address `192.0.2.44`, AWS WAF will allow or block requests based on that IP address.\nSet `Negated` to `True` if you want AWS WAF to allow or block a request based on the negation\nof the settings in the `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, or `SizeConstraintSet`.\nFor example, if an `IPSet` includes the IP address `192.0.2.44`, AWS WAF will allow, block, or count requests based on\nall IP addresses *except*`192.0.2.44`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-negated", "PrimitiveType": "Boolean", "Required": true, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of predicate in a `Rule`, such as `ByteMatch` or `IPSet`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IPMatch | ByteMatch | SqlIn...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPMatch", "ByteMatch", "SqlInjectionMatch", "GeoMatch", "SizeConstraint", "XssMatch", "RegexMatch" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::SizeConstraintSet.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAF::SizeConstraintSet.FieldToMatch`\n\nThe part of a web request that you want to inspect, such as a specified header or a query string.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint-fieldtomatch.html", "Properties": { "Data": { "MarkdownDocumentation": "`Data`\n\nWhen the value of `Type` is `HEADER`, enter the name of the header that you want AWS WAF to search,\nfor example, `User-Agent` or `Referer`. The name of the header is not case sensitive.\nWhen the value of `Type` is `SINGLE_QUERY_ARG`, enter the name of the parameter that you want AWS WAF to search,\nfor example, `UserName` or `SalesRegion`. The parameter name is not case sensitive.\nIf the value of `Type` is any other value, omit `Data`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-data", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:\n* `HEADER`: A specified request header, for example, the value of the `User-Agent` or `Referer` header.\n If you choose `HEADER` for the type, specify the name of the header in `Data`.\n* `METHOD`: The HTTP method, which indicated the type of operation that the request is asking the origin to perform.\n Amazon CloudFront supports the following methods: `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`,\n `POST`, and `PUT`.\n* `QUERY_STRING`: A query string, which is the part of a URL that appears after a `?` character, if any.\n* `URI`: The part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in\n `TargetString`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `URI | QUERY_STRING | HEADER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY", "SINGLE_QUERY_ARG", "ALL_QUERY_ARGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::SizeConstraintSet.SizeConstraint": { "MarkdownDocumentation": "`AWS::WAF::SizeConstraintSet.SizeConstraint`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies a constraint on the size of a part of the web request. AWS WAF uses the `Size`, `ComparisonOperator`, and `FieldToMatch` to build\nan expression in the form of \"`Size``ComparisonOperator` size in bytes of `FieldToMatch`\". If that expression is true, the\n`SizeConstraint` is considered to match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided `Size` and `FieldToMatch`\nto build an expression in the form of \"`Size``ComparisonOperator` size in bytes of `FieldToMatch`\". If that expression\nis true, the `SizeConstraint` is considered to match.\n**EQ**: Used to test if the `Size` is equal to the size of the `FieldToMatch`\n**NE**: Used to test if the `Size` is not equal to the size of the `FieldToMatch`\n**LE**: Used to test if the `Size` is less than or equal to the size of the `FieldToMatch`\n**LT**: Used to test if the `Size` is strictly less than the size of the `FieldToMatch`\n**GE**: Used to test if the `Size` is greater than or equal to the size of the `FieldToMatch`\n**GT**: Used to test if the `Size` is strictly greater than the size of the `FieldToMatch`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQ | NE | LE | LT | GE | GT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQ", "NE", "LE", "LT", "GE", "GT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-comparisonoperator", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of a web request that you want to inspect, such as a specified header or a query string.\n*Required*: Yes\n*Type*: [FieldToMatch](./aws-properties-waf-sizeconstraintset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch", "Required": true, "Type": "FieldToMatch", "UpdateType": "Mutable" }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size in bytes that you want AWS WAF to compare against the size of the specified `FieldToMatch`. AWS WAF uses this in combination\nwith `ComparisonOperator` and `FieldToMatch` to build an expression in the form of \"`Size``ComparisonOperator` size\nin bytes of `FieldToMatch`\". If that expression is true, the `SizeConstraint` is considered to match.\nValid values for size are 0 - 21474836480 bytes (0 - 20 GB).\nIf you specify `URI` for the value of `Type`, the / in the URI path that you specify counts as one character.\nFor example, the URI `/logo.jpg` is nine characters long.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-size", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "TextTransformation": { "MarkdownDocumentation": "`TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.\nIf 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.\nNote that if you choose `BODY` for the value of `Type`, you must choose `NONE` for `TextTransformation`\nbecause Amazon CloudFront forwards only the first 8192 bytes for inspection.\n**NONE**\nSpecify `NONE` if you don't want to perform any text transformations.\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\nthe following operations:\n* Replaces `(ampersand)quot;` with `\"`\n* Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160\n* Replaces `(ampersand)lt;` with a \"less than\" symbol\n* Replaces `(ampersand)gt;` with `>`\n* Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding\n characters\n* Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding\n 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*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-texttransformation", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::SqlInjectionMatchSet.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAF::SqlInjectionMatchSet.FieldToMatch`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies where in a web request to look for `TargetString`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html", "Properties": { "Data": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-data", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple": { "MarkdownDocumentation": "`AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html", "Properties": { "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of a web request that you want to inspect, such as a specified header or a query string.\n*Required*: Yes\n*Type*: [FieldToMatch](./aws-properties-waf-sqlinjectionmatchset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples-fieldtomatch", "Required": true, "Type": "FieldToMatch", "UpdateType": "Mutable" }, "TextTransformation": { "MarkdownDocumentation": "`TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.\nIf 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\ncommand and using unusual formatting to disguise some or all of the command, use this\noption 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\nthe following operations:\n* Replaces `(ampersand)quot;` with `\"`\n* Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160\n* Replaces `(ampersand)lt;` with a \"less than\" symbol\n* Replaces `(ampersand)gt;` with `>`\n* Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding\n characters\n* Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding\n 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*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples-texttransformation", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::WebACL.ActivatedRule": { "MarkdownDocumentation": "`AWS::WAF::WebACL.ActivatedRule`\n\nThe `ActivatedRule` object in an `UpdateWebACL` request specifies a `Rule` that you want to insert or delete,\nthe priority of the `Rule` in the `WebACL`, and the action that you want AWS WAF to take when a web request matches the `Rule`\n(`ALLOW`, `BLOCK`, or `COUNT`).\nTo specify whether to insert or delete a `Rule`, use the `Action` parameter in the `WebACLUpdate` data type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nSpecifies the action that Amazon CloudFront or AWS WAF takes when a web request matches the conditions in the `Rule`.\nValid values for `Action` include the following:\n* `ALLOW`: CloudFront responds with the requested object.\n* `BLOCK`: CloudFront responds with an HTTP 403 (Forbidden) status code.\n* `COUNT`: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to\n inspect the web request based on the remaining rules in the web ACL.\n`ActivatedRule|OverrideAction` applies only when updating or adding a\n`RuleGroup` to a `WebACL`. In this\ncase,\nyou do not use `ActivatedRule|Action`. For all other update requests,\n`ActivatedRule|Action` is used instead of\n`ActivatedRule|OverrideAction`.\n*Required*: No\n*Type*: [WafAction](./aws-properties-waf-webacl-wafaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-action", "Required": false, "Type": "WafAction", "UpdateType": "Mutable" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nSpecifies the order in which the `Rules` in a `WebACL` are evaluated. Rules with a lower value for\n`Priority` are evaluated before `Rules` with a higher value. The value must be a unique integer. If you add multiple\n`Rules` to a `WebACL`, the values don't need to be consecutive.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-priority", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "RuleId": { "MarkdownDocumentation": "`RuleId`\n\nThe `RuleId` for a `Rule`. You use `RuleId` to get more information about a `Rule`,\nupdate a `Rule`, insert a `Rule` into a `WebACL` or delete a\none from a `WebACL`, or delete a `Rule` from AWS WAF.\n`RuleId` is returned by `CreateRule` and by `ListRules`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-ruleid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::WebACL.WafAction": { "MarkdownDocumentation": "`AWS::WAF::WebACL.WafAction`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nFor the action that is associated with a rule in a `WebACL`, specifies the action that you want AWS WAF to perform when a\nweb request matches all of the conditions in a rule. For the default action in a `WebACL`, specifies the action that you want\nAWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a `WebACL`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-action.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies how you want AWS WAF to respond to requests that match the settings in a `Rule`. Valid settings include the following:\n* `ALLOW`: AWS WAF allows requests\n* `BLOCK`: AWS WAF blocks requests\n* `COUNT`: AWS WAF increments a counter of the requests that match all of the conditions in the rule.\n AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify `COUNT`\n for the default action for a `WebACL`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BLOCK | ALLOW | COUNT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BLOCK", "ALLOW", "COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-action.html#cfn-waf-webacl-action-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::XssMatchSet.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAF::XssMatchSet.FieldToMatch`\n\nThe part of a web request that you want to inspect, such as a specified header or a query string.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple-fieldtomatch.html", "Properties": { "Data": { "MarkdownDocumentation": "`Data`\n\nWhen the value of `Type` is `HEADER`, enter the name of the header that you want AWS WAF to search,\nfor example, `User-Agent` or `Referer`. The name of the header is not case sensitive.\nWhen the value of `Type` is `SINGLE_QUERY_ARG`, enter the name of the parameter that you want AWS WAF to search,\nfor example, `UserName` or `SalesRegion`. The parameter name is not case sensitive.\nIf the value of `Type` is any other value, omit `Data`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple-fieldtomatch.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch-data", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:\n* `HEADER`: A specified request header, for example, the value of the `User-Agent` or `Referer` header.\n If you choose `HEADER` for the type, specify the name of the header in `Data`.\n* `METHOD`: The HTTP method, which indicated the type of operation that the request is asking the origin to perform.\n Amazon CloudFront supports the following methods: `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`,\n `POST`, and `PUT`.\n* `QUERY_STRING`: A query string, which is the part of a URL that appears after a `?` character, if any.\n* `URI`: The part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in\n `TargetString`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `URI | QUERY_STRING | HEADER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY", "SINGLE_QUERY_ARG", "ALL_QUERY_ARGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple-fieldtomatch.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAF::XssMatchSet.XssMatchTuple": { "MarkdownDocumentation": "`AWS::WAF::XssMatchSet.XssMatchTuple`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple.html", "Properties": { "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of a web request that you want to inspect, such as a specified header or a query string.\n*Required*: Yes\n*Type*: [FieldToMatch](./aws-properties-waf-xssmatchset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch", "Required": true, "Type": "FieldToMatch", "UpdateType": "Mutable" }, "TextTransformation": { "MarkdownDocumentation": "`TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.\nIf 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\ncommand and using unusual formatting to disguise some or all of the command, use this\noption 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\nthe following operations:\n* Replaces `(ampersand)quot;` with `\"`\n* Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160\n* Replaces `(ampersand)lt;` with a \"less than\" symbol\n* Replaces `(ampersand)gt;` with `>`\n* Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding\n characters\n* Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding\n 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*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple.html#cfn-waf-xssmatchset-xssmatchtuple-texttransformation", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::WAFRegional::ByteMatchSet.ByteMatchTuple": { "MarkdownDocumentation": "`AWS::WAFRegional::ByteMatchSet.ByteMatchTuple`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html", "Properties": { "TargetString": { "Required": false, "MarkdownDocumentation": "`TargetString`\n\nThe value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you\nspecified in `FieldToMatch`. The maximum length of the value is 50 bytes.\nYou must specify this property or the `TargetStringBase64` property.\nValid values depend on the values that you specified for `FieldToMatch`:\n* `HEADER`: The value that you want AWS WAF to search for in the request header that you specified in\n `FieldToMatch`, for example, the value of the `User-Agent` or `Referer` header.\n* `METHOD`: The HTTP method, which indicates the type of operation specified in the request.\n* `QUERY_STRING`: The value that you want AWS WAF to search for in the query string, which is the part\n of a URL that appears after a `?` character.\n* `URI`: The value that you want AWS WAF to search for in the part of a URL that identifies a resource,\n for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but instead of\n inspecting a single parameter, AWS WAF inspects all parameters within the query\n string for the value or regex pattern that you specify in\n `TargetString`.\nIf `TargetString` includes alphabetic characters A-Z and a-z, note that the value is case sensitive.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-targetstring", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TargetStringBase64": { "Required": false, "MarkdownDocumentation": "`TargetStringBase64`\n\nThe base64-encoded value that AWS WAF searches for. AWS CloudFormation sends this value to AWS WAF without encoding it.\nYou must specify this property or the `TargetString` property.\nAWS WAF searches for this value in a specific part of web requests, which you define in the `FieldToMatch` property.\nValid values depend on the Type value in the `FieldToMatch` property. For example, for a `METHOD` type, you must specify HTTP methods such as `DELETE, GET, HEAD, OPTIONS, PATCH, POST`, and `PUT`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-targetstringbase64", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PositionalConstraint": { "Required": true, "MarkdownDocumentation": "`PositionalConstraint`\n\nWithin the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:\n**CONTAINS**\nThe specified part of the web request must include the value of `TargetString`, but the location doesn't matter.\n**CONTAINS\\_WORD**\nThe specified part of the web request must include the value of `TargetString`, and\n`TargetString` must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or \\_). In addition,\n`TargetString` must be a word, which means one of the following:\n* `TargetString` exactly matches the value of the specified part of the web request, such as the value of a\n header.\n* `TargetString` is at the beginning of the specified part of the web request and is followed by a character\n other than an alphanumeric character or underscore (\\_), for example, `BadBot;`.\n* `TargetString` is at the end of the specified part of the web request and is preceded by a character\n other than an alphanumeric character or underscore (\\_), for example, `;BadBot`.\n* `TargetString` is in the middle of the specified part of the web request and is preceded and followed\n by characters other than alphanumeric characters or underscore (\\_), for example, `-BadBot;`.\n**EXACTLY**\nThe value of the specified part of the web request must exactly match the value of `TargetString`.\n**STARTS\\_WITH**\nThe value of `TargetString` must appear at the beginning of the specified part of the web request.\n**ENDS\\_WITH**\nThe value of `TargetString` must appear at the end of the specified part of the web request.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EXACTLY | STARTS_WITH | END...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXACTLY", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "CONTAINS_WORD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-positionalconstraint", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TextTransformation": { "Required": true, "MarkdownDocumentation": "`TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.\nIf 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\ncommand and using unusual formatting to disguise some or all of the command, use this\noption 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\nthe following operations:\n* Replaces `(ampersand)quot;` with `\"`\n* Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160\n* Replaces `(ampersand)lt;` with a \"less than\" symbol\n* Replaces `(ampersand)gt;` with `>`\n* Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding\n characters\n* Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding\n 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*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-texttransformation", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FieldToMatch": { "Type": "FieldToMatch", "Required": true, "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of a web request that you want AWS WAF to inspect, such as a specific header or a query string.\n*Required*: Yes\n*Type*: [FieldToMatch](./aws-properties-wafregional-bytematchset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-fieldtomatch", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::ByteMatchSet.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAFRegional::ByteMatchSet.FieldToMatch`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies where in a web request to look for `TargetString`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-fieldtomatch.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:\n* `HEADER`: A specified request header, for example, the value of the `User-Agent` or `Referer` header.\n If you choose `HEADER` for the type, specify the name of the header in `Data`.\n* `METHOD`: The HTTP method, which indicated the type of operation that the request is asking the origin to perform.\n* `QUERY_STRING`: A query string, which is the part of a URL that appears after a `?` character, if any.\n* `URI`: The part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in\n `TargetString`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `URI | QUERY_STRING | HEADER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY", "SINGLE_QUERY_ARG", "ALL_QUERY_ARGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-fieldtomatch.html#cfn-wafregional-bytematchset-fieldtomatch-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Data": { "Required": false, "MarkdownDocumentation": "`Data`\n\nWhen the value of `Type` is `HEADER`, enter the name of the header that you want AWS WAF to search,\nfor example, `User-Agent` or `Referer`. The name of the header is not case sensitive.\nWhen the value of `Type` is `SINGLE_QUERY_ARG`, enter the name of the parameter that you want AWS WAF to search,\nfor example, `UserName` or `SalesRegion`. The parameter name is not case sensitive.\nIf the value of `Type` is any other value, omit `Data`.\n*Required*: No\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-fieldtomatch.html#cfn-wafregional-bytematchset-fieldtomatch-data", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint": { "MarkdownDocumentation": "`AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nThe country from which web requests originate that you want AWS WAF to search for.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-geomatchset-geomatchconstraint.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of geographical area you want AWS WAF to search for. Currently `Country` is the only valid value.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Country`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "Country" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-geomatchset-geomatchconstraint.html#cfn-wafregional-geomatchset-geomatchconstraint-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nThe country that you want AWS WAF to search for.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AF | AX | AL | DZ | AS | AD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-geomatchset-geomatchconstraint.html#cfn-wafregional-geomatchset-geomatchconstraint-value", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::IPSet.IPSetDescriptor": { "MarkdownDocumentation": "`AWS::WAFRegional::IPSet.IPSetDescriptor`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies the IP address type (`IPV4` or `IPV6`) and the IP address range (in CIDR format) that web requests originate from.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ipset-ipsetdescriptor.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nSpecify `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)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ipset-ipsetdescriptor.html#cfn-wafregional-ipset-ipsetdescriptor-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Value": { "Required": true, "MarkdownDocumentation": "`Value`\n\nSpecify an IPv4 address by using CIDR notation. For example:\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\n `192.0.2.0/24`.\nFor more information about CIDR notation, see the Wikipedia entry\n[Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\nSpecify an IPv6 address by using CIDR notation. For example:\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`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ipset-ipsetdescriptor.html#cfn-wafregional-ipset-ipsetdescriptor-value", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::RateBasedRule.Predicate": { "MarkdownDocumentation": "`AWS::WAFRegional::RateBasedRule.Predicate`\n\nSpecifies the `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, and `SizeConstraintSet` objects\nthat you want to add to a `Rule` and, for each object, indicates whether you want to negate the settings, for example, requests that do\nNOT originate from the IP address 192.0.2.44.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ratebasedrule-predicate.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of predicate in a `Rule`, such as `ByteMatch` or `IPSet`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IPMatch | ByteMatch | SqlIn...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPMatch", "ByteMatch", "SqlInjectionMatch", "GeoMatch", "SizeConstraint", "XssMatch", "RegexMatch" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ratebasedrule-predicate.html#cfn-wafregional-ratebasedrule-predicate-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DataId": { "Required": true, "MarkdownDocumentation": "`DataId`\n\nA unique identifier for a predicate in a `Rule`, such as `ByteMatchSetId` or `IPSetId`.\nThe ID is returned by the corresponding `Create` or `List` command.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ratebasedrule-predicate.html#cfn-wafregional-ratebasedrule-predicate-dataid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Negated": { "Required": true, "MarkdownDocumentation": "`Negated`\n\nSet `Negated` to `False` if you want AWS WAF to allow, block, or count requests based on the settings in the\nspecified `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, or `SizeConstraintSet`.\nFor example, if an `IPSet` includes the IP address `192.0.2.44`, AWS WAF will allow or block requests based on that IP address.\nSet `Negated` to `True` if you want AWS WAF to allow or block a request based on the negation\nof the settings in the `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, or `SizeConstraintSet`>.\nFor example, if an `IPSet` includes the IP address `192.0.2.44`, AWS WAF will allow, block, or count requests based on\nall IP addresses *except*`192.0.2.44`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ratebasedrule-predicate.html#cfn-wafregional-ratebasedrule-predicate-negated", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::Rule.Predicate": { "MarkdownDocumentation": "`AWS::WAFRegional::Rule.Predicate`\n\nSpecifies the `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, and `SizeConstraintSet` objects\nthat you want to add to a `Rule` and, for each object, indicates whether you want to negate the settings, for example, requests that do\nNOT originate from the IP address 192.0.2.44.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of predicate in a `Rule`, such as `ByteMatch` or `IPSet`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IPMatch | ByteMatch | SqlIn...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPMatch", "ByteMatch", "SqlInjectionMatch", "GeoMatch", "SizeConstraint", "XssMatch", "RegexMatch" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DataId": { "Required": true, "MarkdownDocumentation": "`DataId`\n\nA unique identifier for a predicate in a `Rule`, such as `ByteMatchSetId` or `IPSetId`.\nThe ID is returned by the corresponding `Create` or `List` command.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-dataid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Negated": { "Required": true, "MarkdownDocumentation": "`Negated`\n\nSet `Negated` to `False` if you want AWS WAF to allow, block, or count requests based on the settings in the\nspecified `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, or `SizeConstraintSet`.\nFor example, if an `IPSet` includes the IP address `192.0.2.44`, AWS WAF will allow or block requests based on that IP address.\nSet `Negated` to `True` if you want AWS WAF to allow or block a request based on the negation\nof the settings in the `ByteMatchSet`, `IPSet`, `SqlInjectionMatchSet`, `XssMatchSet`, `RegexMatchSet`, `GeoMatchSet`, or `SizeConstraintSet`.\nFor example, if an `IPSet` includes the IP address `192.0.2.44`, AWS WAF will allow, block, or count requests based on\nall IP addresses *except*`192.0.2.44`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-negated", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::SizeConstraintSet.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAFRegional::SizeConstraintSet.FieldToMatch`\n\nThe part of a web request that you want AWS WAF to inspect, such as a specific header or a query string.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-fieldtomatch.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:\n* `HEADER`: A specified request header, for example, the value of the `User-Agent` or `Referer` header.\n If you choose `HEADER` for the type, specify the name of the header in `Data`.\n* `METHOD`: The HTTP method, which indicates the type of operation that the request is asking the origin to perform.\n* `QUERY_STRING`: A query string, which is the part of a URL that appears after a `?` character, if any.\n* `URI`: The part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in\n `TargetString`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `URI | QUERY_STRING | HEADER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY", "SINGLE_QUERY_ARG", "ALL_QUERY_ARGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-fieldtomatch.html#cfn-wafregional-sizeconstraintset-fieldtomatch-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Data": { "Required": false, "MarkdownDocumentation": "`Data`\n\nWhen the value of `Type` is `HEADER`, enter the name of the header that you want AWS WAF to search,\nfor example, `User-Agent` or `Referer`. The name of the header is not case sensitive.\nWhen the value of `Type` is `SINGLE_QUERY_ARG`, enter the name of the parameter that you want AWS WAF to search,\nfor example, `UserName` or `SalesRegion`. The parameter name is not case sensitive.\nIf the value of `Type` is any other value, omit `Data`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-fieldtomatch.html#cfn-wafregional-sizeconstraintset-fieldtomatch-data", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::SizeConstraintSet.SizeConstraint": { "MarkdownDocumentation": "`AWS::WAFRegional::SizeConstraintSet.SizeConstraint`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies a constraint on the size of a part of the web request. AWS WAF uses the `Size`, `ComparisonOperator`, and `FieldToMatch` to build\nan expression in the form of \"`Size``ComparisonOperator` size in bytes of `FieldToMatch`\". If that expression is true, the\n`SizeConstraint` is considered to match.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html", "Properties": { "ComparisonOperator": { "Required": true, "MarkdownDocumentation": "`ComparisonOperator`\n\nThe type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided `Size` and `FieldToMatch`\nto build an expression in the form of \"`Size``ComparisonOperator` size in bytes of `FieldToMatch`\". If that expression\nis true, the `SizeConstraint` is considered to match.\n**EQ**: Used to test if the `Size` is equal to the size of the `FieldToMatch`\n**NE**: Used to test if the `Size` is not equal to the size of the `FieldToMatch`\n**LE**: Used to test if the `Size` is less than or equal to the size of the `FieldToMatch`\n**LT**: Used to test if the `Size` is strictly less than the size of the `FieldToMatch`\n**GE**: Used to test if the `Size` is greater than or equal to the size of the `FieldToMatch`\n**GT**: Used to test if the `Size` is strictly greater than the size of the `FieldToMatch`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQ | NE | LE | LT | GE | GT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQ", "NE", "LE", "LT", "GE", "GT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-comparisonoperator", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Size": { "Required": true, "MarkdownDocumentation": "`Size`\n\nThe size in bytes that you want AWS WAF to compare against the size of the specified `FieldToMatch`. AWS WAF uses this in combination\nwith `ComparisonOperator` and `FieldToMatch` to build an expression in the form of \"`Size``ComparisonOperator` size\nin bytes of `FieldToMatch`\". If that expression is true, the `SizeConstraint` is considered to match.\nValid values for size are 0 - 21474836480 bytes (0 - 20 GB).\nIf you specify `URI` for the value of `Type`, the / in the URI path that you specify counts as one character.\nFor example, the URI `/logo.jpg` is nine characters long.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-size", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TextTransformation": { "Required": true, "MarkdownDocumentation": "`TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.\nIf you specify a transformation, AWS WAF performs the transformation on `FieldToMatch` before inspecting a request for a match.\nYou can only specify a single type of TextTransformation.\nNote that if you choose `BODY` for the value of `Type`, you must choose `NONE` for `TextTransformation`\nbecause the API Gateway API or Application Load Balancer forward only the first 8192 bytes for inspection.\n**NONE**\nSpecify `NONE` if you don't want to perform any text transformations.\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\nthe following operations:\n* Replaces `(ampersand)quot;` with `\"`\n* Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160\n* Replaces `(ampersand)lt;` with a \"less than\" symbol\n* Replaces `(ampersand)gt;` with `>`\n* Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding\n characters\n* Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding\n 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*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-texttransformation", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FieldToMatch": { "Type": "FieldToMatch", "Required": true, "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of a web request that you want AWS WAF to inspect, such as a specific header or a query string.\n*Required*: Yes\n*Type*: [FieldToMatch](./aws-properties-wafregional-sizeconstraintset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-fieldtomatch", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::SqlInjectionMatchSet.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAFRegional::SqlInjectionMatchSet.FieldToMatch`\n\nThe part of a web request that you want AWS WAF to inspect, such as a specific header or a query string.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-fieldtomatch.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:\n* `HEADER`: A specified request header, for example, the value of the `User-Agent` or `Referer` header.\n If you choose `HEADER` for the type, specify the name of the header in `Data`.\n* `METHOD`: The HTTP method, which indicates the type of operation that the request is asking the origin to perform.\n* `QUERY_STRING`: A query string, which is the part of a URL that appears after a `?` character, if any.\n* `URI`: The part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in\n `TargetString`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `URI | QUERY_STRING | HEADER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY", "SINGLE_QUERY_ARG", "ALL_QUERY_ARGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-fieldtomatch.html#cfn-wafregional-sqlinjectionmatchset-fieldtomatch-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Data": { "Required": false, "MarkdownDocumentation": "`Data`\n\nWhen the value of `Type` is `HEADER`, enter the name of the header that you want AWS WAF to search,\nfor example, `User-Agent` or `Referer`. The name of the header is not case sensitive.\nWhen the value of `Type` is `SINGLE_QUERY_ARG`, enter the name of the parameter that you want AWS WAF to search,\nfor example, `UserName` or `SalesRegion`. The parameter name is not case sensitive.\nIf the value of `Type` is any other value, omit `Data`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-fieldtomatch.html#cfn-wafregional-sqlinjectionmatchset-fieldtomatch-data", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple": { "MarkdownDocumentation": "`AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html", "Properties": { "TextTransformation": { "Required": true, "MarkdownDocumentation": "`TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.\nIf 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\ncommand and using unusual formatting to disguise some or all of the command, use this\noption 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\nthe following operations:\n* Replaces `(ampersand)quot;` with `\"`\n* Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160\n* Replaces `(ampersand)lt;` with a \"less than\" symbol\n* Replaces `(ampersand)gt;` with `>`\n* Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding\n characters\n* Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding\n 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*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple-texttransformation", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FieldToMatch": { "Type": "FieldToMatch", "Required": true, "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of a web request that you want AWS WAF to inspect, such as a specific header or a query string.\n*Required*: Yes\n*Type*: [FieldToMatch](./aws-properties-wafregional-sqlinjectionmatchset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple-fieldtomatch", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::WebACL.Action": { "MarkdownDocumentation": "`AWS::WAFRegional::WebACL.Action`\n\nSpecifies the action AWS WAF takes when a web request matches or doesn't match all rule conditions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-action.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nFor actions that are associated with a rule, the action that AWS WAF takes when a web request matches all conditions in a rule.\nFor the default action of a web access control list (ACL), the action that AWS WAF takes when a web request doesn't match all conditions in any rule.\nValid settings include the following:\n* `ALLOW`: AWS WAF allows requests\n* `BLOCK`: AWS WAF blocks requests\n* `COUNT`: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify `COUNT` for the default action for a WebACL.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-action.html#cfn-wafregional-webacl-action-type", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::WebACL.Rule": { "MarkdownDocumentation": "`AWS::WAFRegional::WebACL.Rule`\n\nA combination of `ByteMatchSet`, `IPSet`, and/or `SqlInjectionMatchSet` objects that identify the web requests that you\nwant to allow, block, or count. For example, you might create a `Rule` that includes the following predicates:\n* An `IPSet` that causes AWS WAF to search for web requests that originate from the IP address `192.0.2.44`\n* A `ByteMatchSet` that causes AWS WAF to search for web requests for which the value of the `User-Agent`\n header is `BadBot`.\nTo match the settings in this `Rule`, a request must originate from `192.0.2.44` AND include a `User-Agent`\nheader for which the value is `BadBot`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html", "Properties": { "Action": { "Type": "Action", "Required": true, "MarkdownDocumentation": "`Action`\n\nThe action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.\n*Required*: Yes\n*Type*: [Action](./aws-properties-wafregional-webacl-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-action", "UpdateType": "Mutable" }, "Priority": { "Required": true, "MarkdownDocumentation": "`Priority`\n\nThe order in which AWS WAF evaluates the rules in a web ACL. AWS WAF evaluates rules with a lower value before rules with a higher value. The value must be a unique integer. If you have multiple rules in a web ACL, the priority numbers do not need to be consecutive.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-priority", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "RuleId": { "Required": true, "MarkdownDocumentation": "`RuleId`\n\nThe ID of an AWS WAF Regional rule to associate with a web ACL.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-ruleid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::XssMatchSet.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAFRegional::XssMatchSet.FieldToMatch`\n\nThe part of a web request that you want AWS WAF to inspect, such as a specific header or a query string.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-fieldtomatch.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:\n* `HEADER`: A specified request header, for example, the value of the `User-Agent` or `Referer` header.\n If you choose `HEADER` for the type, specify the name of the header in `Data`.\n* `METHOD`: The HTTP method, which indicates the type of operation that the request is asking the origin to perform.\n* `QUERY_STRING`: A query string, which is the part of a URL that appears after a `?` character, if any.\n* `URI`: The part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`.\n* `BODY`: The part of a request that contains any additional data that you want to send to your web server\n as the HTTP request body, such as data from a form. The request body immediately follows the request headers.\n Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection.\n To allow or block requests based on the length of the body, you can create a size constraint set.\n* `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.\n* `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in\n `TargetString`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `URI | QUERY_STRING | HEADER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY", "SINGLE_QUERY_ARG", "ALL_QUERY_ARGS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-fieldtomatch.html#cfn-wafregional-xssmatchset-fieldtomatch-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Data": { "Required": false, "MarkdownDocumentation": "`Data`\n\nWhen the value of `Type` is `HEADER`, enter the name of the header that you want AWS WAF to search,\nfor example, `User-Agent` or `Referer`. The name of the header is not case sensitive.\nWhen the value of `Type` is `SINGLE_QUERY_ARG`, enter the name of the parameter that you want AWS WAF to search,\nfor example, `UserName` or `SalesRegion`. The parameter name is not case sensitive.\nIf the value of `Type` is any other value, omit `Data`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-fieldtomatch.html#cfn-wafregional-xssmatchset-fieldtomatch-data", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::XssMatchSet.XssMatchTuple": { "MarkdownDocumentation": "`AWS::WAFRegional::XssMatchSet.XssMatchTuple`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nSpecifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html", "Properties": { "TextTransformation": { "Required": true, "MarkdownDocumentation": "`TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.\nIf 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\ncommand and using unusual formatting to disguise some or all of the command, use this\noption 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\nthe following operations:\n* Replaces `(ampersand)quot;` with `\"`\n* Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160\n* Replaces `(ampersand)lt;` with a \"less than\" symbol\n* Replaces `(ampersand)gt;` with `>`\n* Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding\n characters\n* Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding\n 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*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html#cfn-wafregional-xssmatchset-xssmatchtuple-texttransformation", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FieldToMatch": { "Type": "FieldToMatch", "Required": true, "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of a web request that you want AWS WAF to inspect, such as a specified header or a query string.\n*Required*: Yes\n*Type*: [FieldToMatch](./aws-properties-wafregional-xssmatchset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html#cfn-wafregional-xssmatchset-xssmatchtuple-fieldtomatch", "UpdateType": "Mutable" } } }, "AWS::WAFv2::LoggingConfiguration.ActionCondition": { "MarkdownDocumentation": "`AWS::WAFv2::LoggingConfiguration.ActionCondition`\n\nA single action condition for a condition in a logging filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-actioncondition.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe 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.\nThe value `EXCLUDED_AS_COUNT` matches on\nexcluded rules and also on rules that have a rule action override of Count.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALLOW | BLOCK | COUNT | CAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "BLOCK", "COUNT", "CAPTCHA", "CHALLENGE", "EXCLUDED_AS_COUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-actioncondition.html#cfn-wafv2-loggingconfiguration-actioncondition-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::LoggingConfiguration.Condition": { "MarkdownDocumentation": "`AWS::WAFv2::LoggingConfiguration.Condition`\n\nA single match condition for a log filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-condition.html", "Properties": { "LabelNameCondition": { "MarkdownDocumentation": "`LabelNameCondition`\n\nA single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition.\nFully 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-condition.html#cfn-wafv2-loggingconfiguration-condition-labelnamecondition", "UpdateType": "Mutable", "Required": false, "Type": "LabelNameCondition" }, "ActionCondition": { "MarkdownDocumentation": "`ActionCondition`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-condition.html#cfn-wafv2-loggingconfiguration-condition-actioncondition", "UpdateType": "Mutable", "Required": false, "Type": "ActionCondition" } } }, "AWS::WAFv2::LoggingConfiguration.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAFv2::LoggingConfiguration.FieldToMatch`\n\nThe parts of the request that you want to keep out of the logs. This is used in the\nlogging configuration `RedactedFields` specification.\nExample JSON for a `QueryString` field to match:\n `\"FieldToMatch\": { \"QueryString\": {} }`\nExample JSON for a `Method` field to match specification:\n `\"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html", "Properties": { "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nRedact the query string. This is the part of a URL that appears after a `?`\ncharacter, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-querystring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "UriPath": { "MarkdownDocumentation": "`UriPath`\n\nRedact the request URI path. This is the part of the web request that identifies a\nresource, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-uripath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Method": { "MarkdownDocumentation": "`Method`\n\nRedact the indicated HTTP method. The method indicates the type of operation that the\nrequest 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-method", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "SingleHeader": { "MarkdownDocumentation": "`SingleHeader`\n\nRedact a single header. Provide the name of the header to inspect, for example,\n`User-Agent` or `Referer`. This setting isn't case\nsensitive.\nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }`\n*Required*: No\n*Type*: [SingleHeader](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-singleheader", "UpdateType": "Mutable", "Required": false, "Type": "SingleHeader" } } }, "AWS::WAFv2::LoggingConfiguration.Filter": { "MarkdownDocumentation": "`AWS::WAFv2::LoggingConfiguration.Filter`\n\nA single logging filter, used in `LoggingFilter`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-filter.html", "Properties": { "Requirement": { "MarkdownDocumentation": "`Requirement`\n\nLogic to apply to the filtering conditions. You can specify that, in order to satisfy\nthe 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)", "RefReturnValue": "", "AllowedValues": [ "MEETS_ALL", "MEETS_ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-filter.html#cfn-wafv2-loggingconfiguration-filter-requirement", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Behavior": { "MarkdownDocumentation": "`Behavior`\n\nHow to handle logs that satisfy the filter's conditions and requirement.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `KEEP | DROP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEEP", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-filter.html#cfn-wafv2-loggingconfiguration-filter-behavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nMatch conditions for the filter.\n*Required*: Yes\n*Type*: Array of [Condition](./aws-properties-wafv2-loggingconfiguration-condition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-filter.html#cfn-wafv2-loggingconfiguration-filter-conditions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Condition", "DuplicatesAllowed": true } } }, "AWS::WAFv2::LoggingConfiguration.LabelNameCondition": { "MarkdownDocumentation": "`AWS::WAFv2::LoggingConfiguration.LabelNameCondition`\n\nA single label name condition for a condition in a logging filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-labelnamecondition.html", "Properties": { "LabelName": { "MarkdownDocumentation": "`LabelName`\n\nThe label name that a log record must contain in order to meet the condition. This must\nbe 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*Pattern*: `^[0-9A-Za-z_\\-:]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-labelnamecondition.html#cfn-wafv2-loggingconfiguration-labelnamecondition-labelname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::LoggingConfiguration.LoggingFilter": { "MarkdownDocumentation": "`AWS::WAFv2::LoggingConfiguration.LoggingFilter`\n\nFiltering that specifies which web requests are kept in the logs and which are dropped,\ndefined for a web ACL's `LoggingConfiguration`.\nYou can filter on the rule action and on the web request labels that were applied by\nmatching rules during web ACL evaluation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-loggingfilter.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nThe filters that you want to apply to the logs.\n*Required*: Yes\n*Type*: Array of [Filter](./aws-properties-wafv2-loggingconfiguration-filter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-loggingfilter.html#cfn-wafv2-loggingconfiguration-loggingfilter-filters", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Filter", "DuplicatesAllowed": true }, "DefaultBehavior": { "MarkdownDocumentation": "`DefaultBehavior`\n\nDefault handling for logs that don't match any of the specified filtering conditions.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `KEEP | DROP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KEEP", "DROP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-loggingfilter.html#cfn-wafv2-loggingconfiguration-loggingfilter-defaultbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::LoggingConfiguration.SingleHeader": { "MarkdownDocumentation": "`AWS::WAFv2::LoggingConfiguration.SingleHeader`\n\nInspect one of the headers in the web request, identified by name, for example,\n`User-Agent` or `Referer`. The name isn't case sensitive.\nYou can filter and inspect all headers with the `FieldToMatch` setting\n`Headers`.\nThis is used to indicate the web request component to inspect, in the\n`FieldToMatch` specification.\nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-singleheader.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the query header to inspect.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-singleheader.html#cfn-wafv2-loggingconfiguration-singleheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.AllowAction": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.AllowAction`\n\nSpecifies that AWS WAF should allow the request and optionally defines\nadditional custom handling for the request.\nThis is used in the context of other settings, for example to specify values for\n`RuleAction` and web ACL `DefaultAction`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-allowaction.html", "Properties": { "CustomRequestHandling": { "MarkdownDocumentation": "`CustomRequestHandling`\n\nDefines custom handling for the web request.\nFor information about customizing web requests and responses,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomRequestHandling](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-allowaction.html#cfn-wafv2-rulegroup-allowaction-customrequesthandling", "UpdateType": "Mutable", "Required": false, "Type": "CustomRequestHandling" } } }, "AWS::WAFv2::RuleGroup.AndStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.AndStatement`\n\nA logical rule statement used to combine other rule statements with AND logic. You\nprovide more than one `Statement` within the `AndStatement`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html", "Properties": { "Statements": { "MarkdownDocumentation": "`Statements`\n\nThe statements to combine with AND logic. You can use any statements that can be nested.\n*Required*: Yes\n*Type*: Array of [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html#cfn-wafv2-rulegroup-andstatement-statements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Statement", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.AsnMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.AsnMatchStatement`\n\nA rule statement that inspects web traffic based on the Autonomous System Number (ASN) associated with the request's IP address.\nFor additional details, see [ASN match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-asn-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-asnmatchstatement.html", "Properties": { "ForwardedIPConfig": { "MarkdownDocumentation": "`ForwardedIPConfig`\n\nThe configuration for inspecting IP addresses to match against an ASN in an HTTP header that you specify,\ninstead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header,\nbut you can specify any header name.\n*Required*: No\n*Type*: [ForwardedIPConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-asnmatchstatement.html#cfn-wafv2-rulegroup-asnmatchstatement-forwardedipconfig", "UpdateType": "Mutable", "Required": false, "Type": "ForwardedIPConfiguration" }, "AsnList": { "MarkdownDocumentation": "`AsnList`\n\nContains one or more Autonomous System Numbers (ASNs).\nASNs are unique identifiers assigned to large internet networks managed by organizations such as\ninternet service providers, enterprises, universities, or government agencies.\n*Required*: No\n*Type*: Array of Integer\n*Minimum*: `0`\n*Maximum*: `4294967295`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-asnmatchstatement.html#cfn-wafv2-rulegroup-asnmatchstatement-asnlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.BlockAction": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.BlockAction`\n\nSpecifies that AWS WAF should block the request and optionally defines\nadditional custom handling for the response to the web request.\nThis is used in the context of other settings, for example to specify values for\n`RuleAction` and web ACL `DefaultAction`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-blockaction.html", "Properties": { "CustomResponse": { "MarkdownDocumentation": "`CustomResponse`\n\nDefines a custom response for the web request.\nFor information about customizing web requests and responses,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomResponse](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-blockaction.html#cfn-wafv2-rulegroup-blockaction-customresponse", "UpdateType": "Mutable", "Required": false, "Type": "CustomResponse" } } }, "AWS::WAFv2::RuleGroup.Body": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.Body`\n\nInspect the body of the web request. The body immediately follows the request\nheaders.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-body.html", "Properties": { "OversizeHandling": { "MarkdownDocumentation": "`OversizeHandling`\n\nWhat AWS WAF should do if the body is larger than AWS WAF can inspect.\nAWS WAF does not support inspecting the entire contents of the web request body if the body\nexceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service\nonly forwards the contents that are within the limit to AWS WAF for inspection.\n* For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n* For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and\n you can increase the limit for each resource type in the web ACL `AssociationConfig`, for additional processing fees.\n* For AWS Amplify, use the CloudFront limit.\nThe options for oversize handling are the following:\n* `CONTINUE` - Inspect the available body contents normally, according to the rule inspection criteria.\n* `MATCH` - Treat the web request as matching the rule statement. AWS WAF\n applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n statement.\nYou can combine the `MATCH` or `NO_MATCH`\nsettings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-body.html#cfn-wafv2-rulegroup-body-oversizehandling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.ByteMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.ByteMatchStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html", "Properties": { "SearchStringBase64": { "MarkdownDocumentation": "`SearchStringBase64`\n\nString to search for in a web request component, base64-encoded. If you don't want to\nencode the string, specify the unencoded value in `SearchString` instead.\nYou must specify either `SearchString` or `SearchStringBase64` in\na `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-searchstringbase64", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "PositionalConstraint": { "MarkdownDocumentation": "`PositionalConstraint`\n\nThe area within the portion of the web request that you want AWS WAF to search for\n`SearchString`. Valid values include the following:\n**CONTAINS**\nThe specified part of the web request must include the value of\n`SearchString`, but the location doesn't matter.\n**CONTAINS\\_WORD**\nThe specified part of the web request must include the value of\n`SearchString`, and `SearchString` must contain only alphanumeric\ncharacters or underscore (A-Z, a-z, 0-9, or \\_). In addition, `SearchString` must\nbe a word, which means that both of the following are true:\n* `SearchString` is at the beginning of the specified part of the web\n request or is preceded by a character other than an alphanumeric character or\n underscore (\\_). Examples include the value of a header and\n `;BadBot`.\n* `SearchString` is at the end of the specified part of the web request or\n is followed by a character other than an alphanumeric character or underscore (\\_),\n for example, `BadBot;` and `-BadBot;`.\n**EXACTLY**\nThe value of the specified part of the web request must exactly match the value of\n`SearchString`.\n**STARTS\\_WITH**\nThe value of `SearchString` must appear at the beginning of the specified\npart of the web request.\n**ENDS\\_WITH**\nThe value of `SearchString` must appear at the end of the specified part of\nthe web request.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EXACTLY | STARTS_WITH | END...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXACTLY", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "CONTAINS_WORD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-positionalconstraint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SearchString": { "MarkdownDocumentation": "`SearchString`\n\nA string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for\ninspection in `FieldToMatch`. The maximum length of the value is 200 bytes. For\nalphabetic 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\nsearch for. AWS CloudFormation automatically base64 encodes the value for you.\nFor example, suppose the value of `Type` is `HEADER` and the value\nof `Data` is `User-Agent`. If you want to search the\n`User-Agent` header for the value `BadBot`, you provide the string\n`BadBot` in the value of `SearchString`.\nYou must specify either `SearchString` or `SearchStringBase64` in\na `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-searchstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::RuleGroup.CaptchaAction": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.CaptchaAction`\n\nSpecifies that AWS WAF should run a `CAPTCHA` check against the request:\n* If the request includes a valid, unexpired `CAPTCHA` token,\n AWS WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to\n proceed to the next rule, similar to a `CountAction`.\n* If the request doesn't include a valid, unexpired token, AWS WAF\n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.\n \n AWS WAF generates a response that it sends back to the client, which includes the following:\n \n + The header `x-amzn-waf-action` with a value of `captcha`.\n + The HTTP status code `405 Method Not Allowed`.\n + If the request contains an `Accept` header with a value of `text/html`, the response includes a `CAPTCHA` JavaScript page interstitial.\nYou can configure the expiration time\nin the `CaptchaConfig``ImmunityTimeProperty` setting at the rule and web ACL level. The rule setting overrides the web ACL setting.\nThis action option is available for rules. It isn't available for web ACL default actions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-captchaaction.html", "Properties": { "CustomRequestHandling": { "MarkdownDocumentation": "`CustomRequestHandling`\n\nDefines 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,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomRequestHandling](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-captchaaction.html#cfn-wafv2-rulegroup-captchaaction-customrequesthandling", "UpdateType": "Mutable", "Required": false, "Type": "CustomRequestHandling" } } }, "AWS::WAFv2::RuleGroup.CaptchaConfig": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.CaptchaConfig`\n\nSpecifies how AWS WAF should handle `CAPTCHA` evaluations. This is\navailable at the web ACL level and in each rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-captchaconfig.html", "Properties": { "ImmunityTimeProperty": { "MarkdownDocumentation": "`ImmunityTimeProperty`\n\nDetermines how long a `CAPTCHA` timestamp in the token remains valid after the client\nsuccessfully solves a `CAPTCHA` puzzle.\n*Required*: No\n*Type*: [ImmunityTimeProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-captchaconfig.html#cfn-wafv2-rulegroup-captchaconfig-immunitytimeproperty", "UpdateType": "Mutable", "Required": false, "Type": "ImmunityTimeProperty" } } }, "AWS::WAFv2::RuleGroup.ChallengeAction": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.ChallengeAction`\n\nSpecifies that AWS WAF should run a `Challenge` check against the request to verify that the request is coming from a legitimate client session:\n* If the request includes a valid, unexpired challenge token,\n AWS WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to\n proceed to the next rule, similar to a `CountAction`.\n* If the request doesn't include a valid, unexpired challenge token, AWS WAF\n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.\n \n AWS WAF then generates a challenge response that it sends back to the client, which includes the following:\n \n + The header `x-amzn-waf-action` with a value of `challenge`.\n + The HTTP status code `202 Request Accepted`.\n + If the request contains an `Accept` header with a value of `text/html`, the response includes a JavaScript page interstitial with a challenge script.\n \n Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.\n \n A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.\n \n After the client session successfully responds to\n the challenge, it receives a new token from AWS WAF, which the challenge script uses to resubmit the original request.\nYou can configure the expiration time\nin the `ChallengeConfig``ImmunityTimeProperty` setting at the rule and web ACL level. The rule setting overrides the web ACL setting.\nThis action option is available for rules. It isn't available for web ACL default actions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeaction.html", "Properties": { "CustomRequestHandling": { "MarkdownDocumentation": "`CustomRequestHandling`\n\nDefines 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,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomRequestHandling](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeaction.html#cfn-wafv2-rulegroup-challengeaction-customrequesthandling", "UpdateType": "Mutable", "Required": false, "Type": "CustomRequestHandling" } } }, "AWS::WAFv2::RuleGroup.ChallengeConfig": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.ChallengeConfig`\n\nSpecifies how AWS WAF should handle `Challenge` evaluations.\nThis is available at the web ACL level and in each rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeconfig.html", "Properties": { "ImmunityTimeProperty": { "MarkdownDocumentation": "`ImmunityTimeProperty`\n\nDetermines how long a challenge timestamp in the token remains valid after the client\nsuccessfully responds to a challenge.\n*Required*: No\n*Type*: [ImmunityTimeProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeconfig.html#cfn-wafv2-rulegroup-challengeconfig-immunitytimeproperty", "UpdateType": "Mutable", "Required": false, "Type": "ImmunityTimeProperty" } } }, "AWS::WAFv2::RuleGroup.CookieMatchPattern": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.CookieMatchPattern`\n\nThe 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\": [ \"session-id-time\", \"session-id\" ] }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookiematchpattern.html", "Properties": { "All": { "MarkdownDocumentation": "`All`\n\nInspect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookiematchpattern.html#cfn-wafv2-rulegroup-cookiematchpattern-all", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "IncludedCookies": { "MarkdownDocumentation": "`IncludedCookies`\n\nInspect only the cookies that have a key that matches one of the strings specified here.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `60 | 199`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookiematchpattern.html#cfn-wafv2-rulegroup-cookiematchpattern-includedcookies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExcludedCookies": { "MarkdownDocumentation": "`ExcludedCookies`\n\nInspect only the cookies whose keys don't match any of the strings specified here.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `60 | 199`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookiematchpattern.html#cfn-wafv2-rulegroup-cookiematchpattern-excludedcookies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.Cookies": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.Cookies`\n\nInspect the cookies in the web request. You can specify the parts of the cookies to\ninspect and you can narrow the set of cookies to inspect by including or excluding specific\nkeys.\nThis is used to indicate the web request component to inspect, in the\n`FieldToMatch` specification.\nExample JSON: `\"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n\"OversizeHandling\": \"MATCH\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookies.html", "Properties": { "MatchScope": { "MarkdownDocumentation": "`MatchScope`\n\nThe parts of the cookies to inspect with the rule inspection criteria. If you specify\n`ALL`, AWS WAF inspects both keys and values.\n`All` does not require a match to be found in the keys\nand a match to be found in the values. It requires a match to be found in the keys\nor the values or both. To require a match in the keys and in the values, use a logical `AND` statement\nto combine two match rules, one that inspects the keys and another that inspects the 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)", "RefReturnValue": "", "AllowedValues": [ "ALL", "KEY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookies.html#cfn-wafv2-rulegroup-cookies-matchscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchPattern": { "MarkdownDocumentation": "`MatchPattern`\n\nThe 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\": [ \"session-id-time\", \"session-id\" ] }`\n*Required*: Yes\n*Type*: [CookieMatchPattern](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookies.html#cfn-wafv2-rulegroup-cookies-matchpattern", "UpdateType": "Mutable", "Required": true, "Type": "CookieMatchPattern" }, "OversizeHandling": { "MarkdownDocumentation": "`OversizeHandling`\n\nWhat AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect.\nAWS WAF does not support inspecting the entire contents of request cookies\nwhen they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies\nand at most 8 KB of cookie contents to AWS WAF.\nThe options for oversize handling are the following:\n* `CONTINUE` - Inspect the available cookies normally, according to the rule inspection criteria.\n* `MATCH` - Treat the web request as matching the rule statement. AWS WAF\n applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n 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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookies.html#cfn-wafv2-rulegroup-cookies-oversizehandling", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.CountAction": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.CountAction`\n\nSpecifies that AWS WAF should count the request. Optionally defines\nadditional custom handling for the request.\nThis is used in the context of other settings, for example to specify values for\n`RuleAction` and web ACL `DefaultAction`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-countaction.html", "Properties": { "CustomRequestHandling": { "MarkdownDocumentation": "`CustomRequestHandling`\n\nDefines custom handling for the web request.\nFor information about customizing web requests and responses,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomRequestHandling](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-countaction.html#cfn-wafv2-rulegroup-countaction-customrequesthandling", "UpdateType": "Mutable", "Required": false, "Type": "CustomRequestHandling" } } }, "AWS::WAFv2::RuleGroup.CustomHTTPHeader": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.CustomHTTPHeader`\n\nA custom header for custom request and response handling. This is used in\n`CustomResponse` and `CustomRequestHandling`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the custom header.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html#cfn-wafv2-rulegroup-customhttpheader-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the custom header.\nFor custom request header insertion, when AWS WAF inserts the header into the request,\nit prefixes this name `x-amzn-waf-`, to avoid confusion with the headers that\nare already in the request. For example, for the header name `sample`, AWS WAF\ninserts the header `x-amzn-waf-sample`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html#cfn-wafv2-rulegroup-customhttpheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.CustomRequestHandling": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.CustomRequestHandling`\n\nCustom request handling behavior that inserts custom headers into a web request. You can\nadd custom request handling for AWS WAF to use when the rule action doesn't block the request.\nFor example, `CaptchaAction` for requests with valid t okens, and `AllowAction`.\nFor information about customizing web requests and responses,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html", "Properties": { "InsertHeaders": { "MarkdownDocumentation": "`InsertHeaders`\n\nThe 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)\nin the *AWS WAF Developer Guide*.\n*Required*: Yes\n*Type*: Array of [CustomHTTPHeader](./aws-properties-wafv2-rulegroup-customhttpheader.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html#cfn-wafv2-rulegroup-customrequesthandling-insertheaders", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CustomHTTPHeader", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.CustomResponse": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.CustomResponse`\n\nA custom response to send to the client. You can define a custom response for rule\nactions and default web ACL actions that are set to `Block`.\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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html", "Properties": { "ResponseCode": { "MarkdownDocumentation": "`ResponseCode`\n\nThe 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)\nin the *AWS WAF Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html#cfn-wafv2-rulegroup-customresponse-responsecode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "CustomResponseBodyKey": { "MarkdownDocumentation": "`CustomResponseBodyKey`\n\nReferences the response body that you want AWS WAF to return to the web request\nclient. You can define a custom response for a rule action or a default web ACL action that\nis set to block. To do this, you first define the response body key and value in the\n`CustomResponseBodies` setting for the [AWS::WAFv2::WebACL](./aws-resource-wafv2-webacl.html) or [AWS::WAFv2::RuleGroup](./aws-resource-wafv2-rulegroup.html) where you want to use it. Then, in the rule action or web ACL\ndefault action `BlockAction` setting, you reference the response body using this\nkey.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html#cfn-wafv2-rulegroup-customresponse-customresponsebodykey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseHeaders": { "MarkdownDocumentation": "`ResponseHeaders`\n\nThe HTTP headers to use in the response. You can specify any header name except for `content-type`. 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)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: Array of [CustomHTTPHeader](./aws-properties-wafv2-rulegroup-customhttpheader.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html#cfn-wafv2-rulegroup-customresponse-responseheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomHTTPHeader", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.CustomResponseBody": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.CustomResponseBody`\n\nThe response body to use in a custom response to a web request. This is referenced by\nkey from [CustomResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html#cfn-wafv2-webacl-blockaction-customresponse)`CustomResponseBodyKey`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponsebody.html", "Properties": { "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe type of content in the payload that you are defining in the `Content`\nstring.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEXT_PLAIN | TEXT_HTML | AP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TEXT_PLAIN", "TEXT_HTML", "APPLICATION_JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponsebody.html#cfn-wafv2-rulegroup-customresponsebody-contenttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe payload of the custom response.\nYou can use JSON escape strings in JSON content. To do this, you must specify JSON\ncontent 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)\nin the *AWS WAF Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponsebody.html#cfn-wafv2-rulegroup-customresponsebody-content", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.FieldToMatch`\n\nSpecifies a web request component to be used in a rule match statement or in a logging configuration.\n* In a rule statement, this is the part of the web request that you want AWS WAF to inspect. Include the single\n `FieldToMatch` type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n `FieldToMatch` for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.\n \n Example JSON for a `QueryString` field to match:\n \n `\"FieldToMatch\": { \"QueryString\": {} }`\n \n Example JSON for a `Method` field to match specification:\n \n `\"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }`\n* In a logging configuration, this is used in the `RedactedFields` property to specify a field to\n redact from the logging records. For this use case, note the following:\n \n + Even though all `FieldToMatch` settings\n are available, the only valid settings for field redaction are `UriPath`, `QueryString`, `SingleHeader`, and `Method`.\n + In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect,\n but for field redaction, you are specifying the component type to redact from the logs.\n + If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling.\n You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration\n or by configuring data protection for the web ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html", "Properties": { "AllQueryArguments": { "MarkdownDocumentation": "`AllQueryArguments`\n\nInspect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-allqueryarguments", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "JA3Fingerprint": { "MarkdownDocumentation": "`JA3Fingerprint`\n\nAvailable for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each\nrequest that has enough TLS Client Hello information for the calculation. Almost\nall web requests include this information.\n###### Note\nYou can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to\n`EXACTLY`.\nYou can obtain the JA3 fingerprint for client requests from the web ACL logs.\nIf AWS WAF is able to calculate the fingerprint, it includes it in the logs.\nFor information about the logging fields,\nsee [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide*.\nProvide the JA3 fingerprint string from the logs in your string match statement\nspecification, to match with any future requests that have the same TLS configuration.\n*Required*: No\n*Type*: [JA3Fingerprint](./aws-properties-wafv2-rulegroup-ja3fingerprint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-ja3fingerprint", "UpdateType": "Mutable", "Required": false, "Type": "JA3Fingerprint" }, "SingleQueryArgument": { "MarkdownDocumentation": "`SingleQueryArgument`\n\nInspect a single query argument. Provide the name of the query argument to inspect, such\nas *UserName* or *SalesRegion*. The name can be up to\n30 characters long and isn't case sensitive.\nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }`\n*Required*: No\n*Type*: [SingleQueryArgument](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singlequeryargument", "UpdateType": "Mutable", "Required": false, "Type": "SingleQueryArgument" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nInspect the query string. This is the part of a URL that appears after a `?`\ncharacter, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-querystring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Headers": { "MarkdownDocumentation": "`Headers`\n\nInspect the request headers. You must configure scope and pattern matching filters in\nthe `Headers` object, to define the set of headers to and the parts of the\nheaders that AWS WAF inspects.\nOnly the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers\nare forwarded to AWS WAF for inspection by the underlying host service. You must\nconfigure how to handle any oversize header content in the `Headers` object.\nAWS WAF applies the pattern matching filters to the headers that it receives from the\nunderlying host service.\n*Required*: No\n*Type*: [Headers](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-headers", "UpdateType": "Mutable", "Required": false, "Type": "Headers" }, "Method": { "MarkdownDocumentation": "`Method`\n\nInspect the HTTP method. The method indicates the type of operation that the request is\nasking 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-method", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "UriFragment": { "MarkdownDocumentation": "`UriFragment`\n\nInspect fragments of the request URI. You must configure scope and pattern matching filters in\nthe `UriFragment` object, to define the fragment of a URI that AWS WAF inspects.\nOnly the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments\nare forwarded to AWS WAF for inspection by the underlying host service. You must\nconfigure how to handle any oversize URI fragment content in the `UriFragment` object.\nAWS WAF applies the pattern matching filters to the cookies that it receives from the\nunderlying host service.\n*Required*: No\n*Type*: [UriFragment](./aws-properties-wafv2-rulegroup-urifragment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-urifragment", "UpdateType": "Mutable", "Required": false, "Type": "UriFragment" }, "JsonBody": { "MarkdownDocumentation": "`JsonBody`\n\nInspect the request body as JSON. The request body immediately follows the request\nheaders. This is the part of a request that contains any additional data that you want to\nsend to your web server as the HTTP request body, such as data from a form.\nAWS WAF does not support inspecting the entire contents of the web request body if the body\nexceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service\nonly forwards the contents that are within the limit to AWS WAF for inspection.\n* For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n* For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and\n you can increase the limit for each resource type in the web ACL `AssociationConfig`, for additional processing fees.\n* For AWS Amplify, use the CloudFront limit.\nFor information about how to handle oversized\nrequest bodies, see the `JsonBody` object configuration.\n*Required*: No\n*Type*: [JsonBody](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-jsonbody", "UpdateType": "Mutable", "Required": false, "Type": "JsonBody" }, "UriPath": { "MarkdownDocumentation": "`UriPath`\n\nInspect the request URI path. This is the part of the web request that identifies a\nresource, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-uripath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Cookies": { "MarkdownDocumentation": "`Cookies`\n\nInspect the request cookies. You must configure scope and pattern matching filters in\nthe `Cookies` object, to define the set of cookies and the parts of the cookies\nthat AWS WAF inspects.\nOnly the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies\nare forwarded to AWS WAF for inspection by the underlying host service. You must\nconfigure how to handle any oversize cookie content in the `Cookies` object.\nAWS WAF applies the pattern matching filters to the cookies that it receives from the\nunderlying host service.\n*Required*: No\n*Type*: [Cookies](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-cookies", "UpdateType": "Mutable", "Required": false, "Type": "Cookies" }, "JA4Fingerprint": { "MarkdownDocumentation": "`JA4Fingerprint`\n\nAvailable for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each\nrequest that has enough TLS Client Hello information for the calculation. Almost\nall web requests include this information.\n###### Note\nYou can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to\n`EXACTLY`.\nYou can obtain the JA4 fingerprint for client requests from the web ACL logs.\nIf AWS WAF is able to calculate the fingerprint, it includes it in the logs.\nFor information about the logging fields,\nsee [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide*.\nProvide the JA4 fingerprint string from the logs in your string match statement\nspecification, to match with any future requests that have the same TLS configuration.\n*Required*: No\n*Type*: [JA4Fingerprint](./aws-properties-wafv2-rulegroup-ja4fingerprint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-ja4fingerprint", "UpdateType": "Mutable", "Required": false, "Type": "JA4Fingerprint" }, "Body": { "MarkdownDocumentation": "`Body`\n\nInspect the request body as plain text. The request body immediately follows the request\nheaders. This is the part of a request that contains any additional data that you want to\nsend to your web server as the HTTP request body, such as data from a form.\nAWS WAF does not support inspecting the entire contents of the web request body if the body\nexceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service\nonly forwards the contents that are within the limit to AWS WAF for inspection.\n* For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n* For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and\n you can increase the limit for each resource type in the web ACL `AssociationConfig`, for additional processing fees.\n* For AWS Amplify, use the CloudFront limit.\nFor information about how to handle oversized\nrequest bodies, see the `Body` object configuration.\n*Required*: No\n*Type*: [Body](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-body", "UpdateType": "Mutable", "Required": false, "Type": "Body" }, "SingleHeader": { "MarkdownDocumentation": "`SingleHeader`\n\nInspect a single header. Provide the name of the header to inspect, for example,\n`User-Agent` or `Referer`. This setting isn't case\nsensitive.\nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }`\nAlternately, you can filter and inspect all headers with the `Headers``FieldToMatch` setting.\n*Required*: No\n*Type*: [SingleHeader](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singleheader", "UpdateType": "Mutable", "Required": false, "Type": "SingleHeader" } } }, "AWS::WAFv2::RuleGroup.ForwardedIPConfiguration": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.ForwardedIPConfiguration`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.\nThis configuration is used for [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-geomatchstatement), [AsnMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-asnmatchstatement), and\n[RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ratebasedstatement). For [IPSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ipsetreferencestatement), use [IPSetForwardedIPConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html#cfn-wafv2-rulegroup-ipsetreferencestatement-ipsetforwardedipconfig) instead.\nAWS WAF only evaluates the first IP address found in the specified HTTP header.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if the request doesn't have a valid IP address in the specified position.\n###### Note\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html#cfn-wafv2-rulegroup-forwardedipconfiguration-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HeaderName": { "MarkdownDocumentation": "`HeaderName`\n\nThe 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`.\n###### Note\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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html#cfn-wafv2-rulegroup-forwardedipconfiguration-headername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.GeoMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.GeoMatchStatement`\n\nA 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.\nAWS 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html", "Properties": { "ForwardedIPConfig": { "MarkdownDocumentation": "`ForwardedIPConfig`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html#cfn-wafv2-rulegroup-geomatchstatement-forwardedipconfig", "UpdateType": "Mutable", "Required": false, "Type": "ForwardedIPConfiguration" }, "CountryCodes": { "MarkdownDocumentation": "`CountryCodes`\n\nAn array of two-character country codes that you want to match against, for example, `[ \"US\", \"CN\" ]`, from\nthe 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*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html#cfn-wafv2-rulegroup-geomatchstatement-countrycodes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.HeaderMatchPattern": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.HeaderMatchPattern`\n\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headermatchpattern.html", "Properties": { "All": { "MarkdownDocumentation": "`All`\n\nInspect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headermatchpattern.html#cfn-wafv2-rulegroup-headermatchpattern-all", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "IncludedHeaders": { "MarkdownDocumentation": "`IncludedHeaders`\n\nInspect only the headers that have a key that matches one of the strings specified here.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 199`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headermatchpattern.html#cfn-wafv2-rulegroup-headermatchpattern-includedheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExcludedHeaders": { "MarkdownDocumentation": "`ExcludedHeaders`\n\nInspect only the headers whose keys don't match any of the strings specified here.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 199`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headermatchpattern.html#cfn-wafv2-rulegroup-headermatchpattern-excludedheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.Headers": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.Headers`\n\nInspect all headers in the web request. You can specify the parts of the headers to\ninspect and you can narrow the set of headers to inspect by including or excluding specific\nkeys.\nThis is used to indicate the web request component to inspect, in the\n`FieldToMatch` specification.\nIf you want to inspect just the value of a single header, use the\n`SingleHeader``FieldToMatch` setting instead.\nExample JSON: `\"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n\"OversizeHandling\": \"MATCH\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headers.html", "Properties": { "MatchScope": { "MarkdownDocumentation": "`MatchScope`\n\nThe parts of the headers to match with the rule inspection criteria. If you specify\n`ALL`, AWS WAF inspects both keys and values.\n`All` does not require a match to be found in the keys\nand a match to be found in the values. It requires a match to be found in the keys\nor the values or both. To require a match in the keys and in the values, use a logical `AND` statement\nto combine two match rules, one that inspects the keys and another that inspects the 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)", "RefReturnValue": "", "AllowedValues": [ "ALL", "KEY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headers.html#cfn-wafv2-rulegroup-headers-matchscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchPattern": { "MarkdownDocumentation": "`MatchPattern`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headers.html#cfn-wafv2-rulegroup-headers-matchpattern", "UpdateType": "Mutable", "Required": true, "Type": "HeaderMatchPattern" }, "OversizeHandling": { "MarkdownDocumentation": "`OversizeHandling`\n\nWhat AWS WAF should do if the headers determined by your match scope are more numerous or larger than AWS WAF can inspect.\nAWS WAF does not support inspecting the entire contents of request headers\nwhen they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\nand at most 8 KB of header contents to AWS WAF.\nThe options for oversize handling are the following:\n* `CONTINUE` - Inspect the available headers normally, according to the rule inspection criteria.\n* `MATCH` - Treat the web request as matching the rule statement. AWS WAF\n applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n 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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headers.html#cfn-wafv2-rulegroup-headers-oversizehandling", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.IPSetForwardedIPConfiguration": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.IPSetForwardedIPConfiguration`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.\nThis configuration is used only for [IPSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ipsetreferencestatement). For [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-geomatchstatement) and [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ratebasedstatement), use [ForwardedIPConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-asnmatchstatement.html#cfn-wafv2-webacl-asnmatchstatement-forwardedipconfig) instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if the request doesn't have a valid IP address in the specified position.\n###### Note\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HeaderName": { "MarkdownDocumentation": "`HeaderName`\n\nThe 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`.\n###### Note\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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-headername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nThe position in the header to search for the IP address. The header can contain IP\naddresses of the original client and also of proxies. For example, the header value could\nbe `10.1.1.1, 127.0.0.0, 10.10.10.10` where the first IP address identifies the\noriginal 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\n header. This is usually the client's original IP.\n* LAST - Inspect the last IP address in the list of IP addresses in the\n header.\n* ANY - Inspect all IP addresses in the header for a match. If the header\n contains more than 10 IP addresses, AWS WAF inspects the last 10.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIRST | LAST | ANY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIRST", "LAST", "ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html#cfn-wafv2-rulegroup-ipsetforwardedipconfiguration-position", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.IPSetReferenceStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.IPSetReferenceStatement`\n\nA rule statement used to detect web requests coming from particular IP addresses or\naddress ranges. To use this, create an [AWS::WAFv2::IPSet](./aws-resource-wafv2-ipset.html) that specifies the addresses\nyou 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\nindependent of your rules. This allows you to use the single set in multiple rules. When\nyou update the referenced set, AWS WAF automatically updates all rules that\nreference it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html", "Properties": { "IPSetForwardedIPConfig": { "MarkdownDocumentation": "`IPSetForwardedIPConfig`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html#cfn-wafv2-rulegroup-ipsetreferencestatement-ipsetforwardedipconfig", "UpdateType": "Mutable", "Required": false, "Type": "IPSetForwardedIPConfiguration" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the [AWS::WAFv2::IPSet](./aws-resource-wafv2-ipset.html) that this statement\nreferences.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html#cfn-wafv2-rulegroup-ipsetreferencestatement-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.ImmunityTimeProperty": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.ImmunityTimeProperty`\n\nUsed for CAPTCHA and challenge token settings. Determines\nhow long a `CAPTCHA` or challenge timestamp remains valid after AWS WAF updates it for a successful `CAPTCHA` or challenge response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html", "Properties": { "ImmunityTime": { "MarkdownDocumentation": "`ImmunityTime`\n\nThe amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF. The default\nsetting is 300.\nFor the Challenge action, the minimum setting is 300.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `259200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html#cfn-wafv2-rulegroup-immunitytimeproperty-immunitytime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::WAFv2::RuleGroup.JA3Fingerprint": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.JA3Fingerprint`\n\nAvailable for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each\nrequest that has enough TLS Client Hello information for the calculation. Almost\nall web requests include this information.\n###### Note\nYou can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to\n`EXACTLY`.\nYou can obtain the JA3 fingerprint for client requests from the web ACL logs.\nIf AWS WAF is able to calculate the fingerprint, it includes it in the logs.\nFor information about the logging fields,\nsee [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide*.\nProvide the JA3 fingerprint string from the logs in your string match statement\nspecification, to match with any future requests that have the same TLS configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ja3fingerprint.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if the request doesn't have a JA3 fingerprint.\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ja3fingerprint.html#cfn-wafv2-rulegroup-ja3fingerprint-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.JA4Fingerprint": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.JA4Fingerprint`\n\nAvailable for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each\nrequest that has enough TLS Client Hello information for the calculation. Almost\nall web requests include this information.\n###### Note\nYou can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to\n`EXACTLY`.\nYou can obtain the JA4 fingerprint for client requests from the web ACL logs.\nIf AWS WAF is able to calculate the fingerprint, it includes it in the logs.\nFor information about the logging fields,\nsee [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide*.\nProvide the JA4 fingerprint string from the logs in your string match statement\nspecification, to match with any future requests that have the same TLS configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ja4fingerprint.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if the request doesn't have a JA4 fingerprint.\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ja4fingerprint.html#cfn-wafv2-rulegroup-ja4fingerprint-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.JsonBody": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.JsonBody`\n\nInspect the body of the web request as JSON. The body immediately follows the request\nheaders.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\nUse the specifications in this object to indicate which parts of the JSON body to\ninspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON\nthat result from the matches that you indicate.\nExample JSON: `\"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n}`\nFor additional information about this request component option, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html", "Properties": { "MatchScope": { "MarkdownDocumentation": "`MatchScope`\n\nThe parts of the JSON to match against using the `MatchPattern`. If you\nspecify `ALL`, AWS WAF matches against keys and values.\n`All` does not require a match to be found in the keys\nand a match to be found in the values. It requires a match to be found in the keys\nor the values or both. To require a match in the keys and in the values, use a logical `AND` statement\nto combine two match rules, one that inspects the keys and another that inspects the 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)", "RefReturnValue": "", "AllowedValues": [ "ALL", "KEY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html#cfn-wafv2-rulegroup-jsonbody-matchscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchPattern": { "MarkdownDocumentation": "`MatchPattern`\n\nThe patterns to look for in the JSON body. AWS WAF inspects the results of these\npattern matches against the rule inspection criteria.\n*Required*: Yes\n*Type*: [JsonMatchPattern](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html#cfn-wafv2-rulegroup-jsonbody-matchpattern", "UpdateType": "Mutable", "Required": true, "Type": "JsonMatchPattern" }, "InvalidFallbackBehavior": { "MarkdownDocumentation": "`InvalidFallbackBehavior`\n\nWhat AWS WAF should do if it fails to completely parse the JSON body. The options are\nthe following:\n* `EVALUATE_AS_STRING` - Inspect the body as plain text. AWS WAF\n applies the text transformations and inspection criteria that you defined for the\n JSON inspection to the body text string.\n* `MATCH` - Treat the web request as matching the rule statement.\n AWS WAF applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n statement.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the\nfirst parsing failure that it encounters.\n###### Note\nAWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When\nparsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information,\nsee [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `MATCH | NO_MATCH | EVALUATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH", "EVALUATE_AS_STRING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html#cfn-wafv2-rulegroup-jsonbody-invalidfallbackbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OversizeHandling": { "MarkdownDocumentation": "`OversizeHandling`\n\nWhat AWS WAF should do if the body is larger than AWS WAF can inspect.\nAWS WAF does not support inspecting the entire contents of the web request body if the body\nexceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service\nonly forwards the contents that are within the limit to AWS WAF for inspection.\n* For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n* For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and\n you can increase the limit for each resource type in the web ACL `AssociationConfig`, for additional processing fees.\n* For AWS Amplify, use the CloudFront limit.\nThe options for oversize handling are the following:\n* `CONTINUE` - Inspect the available body contents normally, according to the rule inspection criteria.\n* `MATCH` - Treat the web request as matching the rule statement. AWS WAF\n applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n statement.\nYou can combine the `MATCH` or `NO_MATCH`\nsettings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html#cfn-wafv2-rulegroup-jsonbody-oversizehandling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.JsonMatchPattern": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.JsonMatchPattern`\n\nThe patterns to look for in the JSON body. AWS WAF inspects the results of these\npattern matches against the rule inspection criteria. This is used with the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) option `JsonBody`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html", "Properties": { "All": { "MarkdownDocumentation": "`All`\n\nMatch all of the elements. See also `MatchScope` in the `JsonBody``FieldToMatch` specification.\nYou must specify either this setting or the `IncludedPaths` setting, but not\nboth.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html#cfn-wafv2-rulegroup-jsonmatchpattern-all", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "IncludedPaths": { "MarkdownDocumentation": "`IncludedPaths`\n\nMatch only the specified include paths. See also `MatchScope` in the\n`JsonBody``FieldToMatch` specification.\nProvide the include paths using JSON Pointer syntax. For example, `\"IncludedPaths\":\n[\"/dogs/0/name\", \"/dogs/1/name\"]`. For information about this syntax, see the\nInternet Engineering Task Force (IETF) documentation [JavaScript Object Notation (JSON)\nPointer](https://tools.ietf.org/html/rfc6901).\nYou must specify either this setting or the `All` setting, but not\nboth.\n###### Note\nDon't use this option to include all paths. Instead, use the `All`\nsetting.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html#cfn-wafv2-rulegroup-jsonmatchpattern-includedpaths", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.Label": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.Label`\n\nA single label container. This is used as an element of a label array in\n`RuleLabels` inside a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-label.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe label string.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_:-]{1,1024}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-label.html#cfn-wafv2-rulegroup-label-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.LabelMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.LabelMatchStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nSpecify 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)", "RefReturnValue": "", "AllowedValues": [ "LABEL", "NAMESPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html#cfn-wafv2-rulegroup-labelmatchstatement-scope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe string to match against. The setting you provide for this depends on the match\nstatement's `Scope` setting:\n* If the `Scope` indicates `LABEL`, then this specification\n must include the name and can include any number of preceding namespace\n specifications and prefix up to providing the fully qualified label name.\n* If the `Scope` indicates `NAMESPACE`, then this\n specification can include any number of contiguous namespace strings, and can include\n the entire label namespace prefix from the rule group or web ACL where the label\n originates.\nLabels are case sensitive and components of a label must be separated by colon, for\nexample `NS1:NS2:name`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_:-]{1,1024}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html#cfn-wafv2-rulegroup-labelmatchstatement-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.LabelSummary": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.LabelSummary`\n\nList of labels used by one or more of the rules of a [AWS::WAFv2::RuleGroup](./aws-resource-wafv2-rulegroup.html). This\nsummary object is used for the following rule group lists:\n* `AvailableLabels` - Labels that rules add to matching requests. These\n labels are defined in the `RuleLabels` for a rule.\n* `ConsumedLabels` - Labels that rules match against. These labels are\n 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nAn individual label specification.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_:-]{1,1024}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html#cfn-wafv2-rulegroup-labelsummary-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.NotStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.NotStatement`\n\nA logical rule statement used to negate the results of another rule statement. You\nprovide one `Statement` within the `NotStatement`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html", "Properties": { "Statement": { "MarkdownDocumentation": "`Statement`\n\nThe statement to negate. You can use any statement that can be nested.\n*Required*: Yes\n*Type*: [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html#cfn-wafv2-rulegroup-notstatement-statement", "UpdateType": "Mutable", "Required": true, "Type": "Statement" } } }, "AWS::WAFv2::RuleGroup.OrStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.OrStatement`\n\nA logical rule statement used to combine other rule statements with OR logic. You\nprovide more than one `Statement` within the `OrStatement`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html", "Properties": { "Statements": { "MarkdownDocumentation": "`Statements`\n\nThe statements to combine with OR logic. You can use any statements that can be\nnested.\n*Required*: Yes\n*Type*: Array of [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html#cfn-wafv2-rulegroup-orstatement-statements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Statement", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.RateBasedStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateBasedStatement`\n\nA rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.\n###### Note\nIf you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.\nYou can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.\nEach unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.\nFor example, assume the rule evaluates web requests with the following IP address and HTTP method values:\n* IP address 10.1.1.1, HTTP method POST\n* IP address 10.1.1.1, HTTP method GET\n* IP address 127.0.0.0, HTTP method POST\n* IP address 10.1.1.1, HTTP method GET\nThe rule would create different aggregation instances according to your aggregation criteria, for example:\n* If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:\n \n + IP address 10.1.1.1: count 3\n + IP address 127.0.0.0: count 1\n* If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:\n \n + HTTP method POST: count 2\n + HTTP method GET: count 2\n* If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:\n \n + IP address 10.1.1.1, HTTP method POST: count 1\n + IP address 10.1.1.1, HTTP method GET: count 2\n + IP address 127.0.0.0, HTTP method POST: count 1\nFor any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the 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.\nFor additional information about the options, see [Rate limiting web requests using rate-based rules](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html)\nin the *AWS WAF Developer Guide*.\nIf you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF\nis currently rate limiting for a rule through the API call `GetRateBasedStatementManagedKeys`. This option is not available\nfor other aggregation configurations.\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html", "Properties": { "AggregateKeyType": { "MarkdownDocumentation": "`AggregateKeyType`\n\nSetting that indicates how to aggregate the request counts.\n###### Note\nWeb requests that are missing any of the components specified in the aggregation keys\nare omitted from the rate-based rule evaluation and handling.\n\n* `CONSTANT` - Count and limit the requests that match the rate-based rule's scope-down\n statement. With this option, the counted requests aren't further aggregated. The scope-down statement\n is the only specification used. When the count of all requests that satisfy the scope-down statement\n goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.\n \n With this option, you must configure the `ScopeDownStatement` property.\n* `CUSTOM_KEYS` - Aggregate the request counts using one or more web request components as the aggregate keys.\n \n With this option, you must specify the aggregate keys in the `CustomKeys` property.\n \n To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate\n key type to `IP` or `FORWARDED_IP`.\n* `FORWARDED_IP` - Aggregate the request counts on the first IP address in an HTTP header.\n \n With this option, you must specify the header to use in the `ForwardedIPConfig` property.\n \n To aggregate on a combination of the forwarded IP address with other aggregate keys, use `CUSTOM_KEYS`.\n* `IP` - Aggregate the request counts on the IP address from the web request\n origin.\n \n To aggregate on a combination of the IP address with other aggregate keys, use `CUSTOM_KEYS`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IP | FORWARDED_IP | CONSTAN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IP", "FORWARDED_IP", "CONSTANT", "CUSTOM_KEYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-aggregatekeytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomKeys": { "MarkdownDocumentation": "`CustomKeys`\n\nSpecifies the aggregate keys to use in a rate-base rule.\n*Required*: No\n*Type*: Array of [RateBasedStatementCustomKey](./aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-customkeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RateBasedStatementCustomKey", "DuplicatesAllowed": true }, "ForwardedIPConfig": { "MarkdownDocumentation": "`ForwardedIPConfig`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\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 you specify a forwarded IP in the rule's aggregate key settings.\n*Required*: No\n*Type*: [ForwardedIPConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-forwardedipconfig", "UpdateType": "Mutable", "Required": false, "Type": "ForwardedIPConfiguration" }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nThe limit on requests during the specified evaluation window for a single aggregation instance for the rate-based rule.\nIf the rate-based statement includes a `ScopeDownStatement`, this limit is applied only to the\nrequests that match the statement.\nExamples:\n* If you aggregate on just the IP address, this is the limit on requests from any single IP address.\n* If you aggregate on the HTTP method and the query argument name \"city\", then this is the limit on\n requests for any single method, city pair.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `10`\n*Maximum*: `2000000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-limit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "EvaluationWindowSec": { "MarkdownDocumentation": "`EvaluationWindowSec`\n\nThe amount of time, in seconds, that AWS WAF\nshould include in its request counts, looking back from the current time. For example,\nfor a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding\nthe current time. Valid settings are 60, 120, 300, and 600.\nThis setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each\ntime it checks. AWS WAF checks the rate about every 10 seconds.\nDefault: `300` (5 minutes)\n*Required*: No\n*Type*: Integer\n*Allowed values*: `60 | 120 | 300 | 600...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "60", "120", "300", "600" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-evaluationwindowsec", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ScopeDownStatement": { "MarkdownDocumentation": "`ScopeDownStatement`\n\nAn optional nested statement that narrows the scope of the web requests that are\nevaluated and managed by the rate-based statement. When you use a scope-down statement,\nthe rate-based rule only tracks and rate limits\nrequests that 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\nlevel, the same as you can for a rule statement.\n*Required*: No\n*Type*: [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-scopedownstatement", "UpdateType": "Mutable", "Required": false, "Type": "Statement" } } }, "AWS::WAFv2::RuleGroup.RateBasedStatementCustomKey": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateBasedStatementCustomKey`\n\nSpecifies a single custom aggregate key for a rate-base rule.\n###### Note\nWeb requests that are missing any of the components specified in the aggregation keys\nare omitted from the rate-based rule evaluation and handling.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html", "Properties": { "Cookie": { "MarkdownDocumentation": "`Cookie`\n\nUse the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\ncookie as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitCookie](./aws-properties-wafv2-rulegroup-ratelimitcookie.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-cookie", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitCookie" }, "ForwardedIP": { "MarkdownDocumentation": "`ForwardedIP`\n\nUse the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.\nWhen you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\nYou can aggregate on only the forwarded IP address by specifying `FORWARDED_IP` in your rate-based statement's `AggregateKeyType`.\nWith this option, you must specify the header to use in the rate-based rule's `ForwardedIPConfig` property.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-forwardedip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "QueryArgument": { "MarkdownDocumentation": "`QueryArgument`\n\nUse the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you\nuse a single query argument as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitQueryArgument](./aws-properties-wafv2-rulegroup-ratelimitqueryargument.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-queryargument", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitQueryArgument" }, "JA3Fingerprint": { "MarkdownDocumentation": "`JA3Fingerprint`\n\nUse the request's JA3 fingerprint as an aggregate key. If you use a single\nJA3 fingerprint as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitJA3Fingerprint](./aws-properties-wafv2-rulegroup-ratelimitja3fingerprint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-ja3fingerprint", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitJA3Fingerprint" }, "Header": { "MarkdownDocumentation": "`Header`\n\nUse the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single\nheader as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitHeader](./aws-properties-wafv2-rulegroup-ratelimitheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-header", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitHeader" }, "HTTPMethod": { "MarkdownDocumentation": "`HTTPMethod`\n\nUse the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\nas your custom key, then each method fully defines an aggregation instance.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-httpmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nUse the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the\nquery string as your custom key, then each string fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitQueryString](./aws-properties-wafv2-rulegroup-ratelimitquerystring.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-querystring", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitQueryString" }, "UriPath": { "MarkdownDocumentation": "`UriPath`\n\nUse the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the\nURI path as your custom key, then each URI path fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitUriPath](./aws-properties-wafv2-rulegroup-ratelimituripath.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-uripath", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitUriPath" }, "IP": { "MarkdownDocumentation": "`IP`\n\nUse the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.\nWhen you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\nYou can aggregate on only the IP address by specifying `IP` in your rate-based statement's `AggregateKeyType`.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-ip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "JA4Fingerprint": { "MarkdownDocumentation": "`JA4Fingerprint`\n\nUse the request's JA4 fingerprint as an aggregate key. If you use a single\nJA4 fingerprint as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitJA4Fingerprint](./aws-properties-wafv2-rulegroup-ratelimitja4fingerprint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-ja4fingerprint", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitJA4Fingerprint" }, "ASN": { "MarkdownDocumentation": "`ASN`\n\nUse an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key.\nEach distinct ASN contributes to the aggregation instance.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-asn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LabelNamespace": { "MarkdownDocumentation": "`LabelNamespace`\n\nUse the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.\nThis uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.\nFor information about label namespaces and names, see\n[Label syntax and naming requirements](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) in the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [RateLimitLabelNamespace](./aws-properties-wafv2-rulegroup-ratelimitlabelnamespace.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatementcustomkey.html#cfn-wafv2-rulegroup-ratebasedstatementcustomkey-labelnamespace", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitLabelNamespace" } } }, "AWS::WAFv2::RuleGroup.RateLimitCookie": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateLimitCookie`\n\nSpecifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\ncookie as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitcookie.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitcookie.html#cfn-wafv2-rulegroup-ratelimitcookie-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the cookie to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitcookie.html#cfn-wafv2-rulegroup-ratelimitcookie-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.RateLimitHeader": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateLimitHeader`\n\nSpecifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single\nheader as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitheader.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitheader.html#cfn-wafv2-rulegroup-ratelimitheader-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the header to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitheader.html#cfn-wafv2-rulegroup-ratelimitheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.RateLimitJA3Fingerprint": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateLimitJA3Fingerprint`\n\nUse the request's JA3 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single\nJA3 fingerprint as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitja3fingerprint.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if there is insufficient TSL Client Hello information to compute the JA3 fingerprint.\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitja3fingerprint.html#cfn-wafv2-rulegroup-ratelimitja3fingerprint-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.RateLimitJA4Fingerprint": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateLimitJA4Fingerprint`\n\nUse the request's JA4 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single\nJA4 fingerprint as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitja4fingerprint.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if there is insufficient TSL Client Hello information to compute the JA4 fingerprint.\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitja4fingerprint.html#cfn-wafv2-rulegroup-ratelimitja4fingerprint-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.RateLimitLabelNamespace": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateLimitLabelNamespace`\n\nSpecifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.\nThis uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.\nFor information about label namespaces and names, see\n[Label syntax and naming requirements](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) in the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitlabelnamespace.html", "Properties": { "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace to use for aggregation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_:-]{1,1024}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitlabelnamespace.html#cfn-wafv2-rulegroup-ratelimitlabelnamespace-namespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.RateLimitQueryArgument": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateLimitQueryArgument`\n\nSpecifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you\nuse a single query argument as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitqueryargument.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitqueryargument.html#cfn-wafv2-rulegroup-ratelimitqueryargument-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the query argument to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitqueryargument.html#cfn-wafv2-rulegroup-ratelimitqueryargument-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.RateLimitQueryString": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateLimitQueryString`\n\nSpecifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the\nquery string as your custom key, then each string fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitquerystring.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitquerystring.html#cfn-wafv2-rulegroup-ratelimitquerystring-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.RateLimitUriPath": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RateLimitUriPath`\n\nSpecifies the request's URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the\nURI path as your custom key, then each URI path fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimituripath.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimituripath.html#cfn-wafv2-rulegroup-ratelimituripath-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true } } }, "AWS::WAFv2::RuleGroup.RegexMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RegexMatchStatement`\n\nA rule statement used to search web request components for a match against a single regular expression.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexmatchstatement.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexmatchstatement.html#cfn-wafv2-rulegroup-regexmatchstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "RegexString": { "MarkdownDocumentation": "`RegexString`\n\nThe string representing the regular expression.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexmatchstatement.html#cfn-wafv2-rulegroup-regexmatchstatement-regexstring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexmatchstatement.html#cfn-wafv2-rulegroup-regexmatchstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement`\n\nA rule statement used to search web request components for matches with regular\nexpressions. To use this, create a [AWS::WAFv2::RegexPatternSet](./aws-resource-wafv2-regexpatternset.html) that specifies the\nexpressions that you want to detect, then use the ARN of that set in this statement. A web\nrequest matches the pattern set rule statement if the request component matches any of the\npatterns in the set.\nEach regex pattern set rule statement references a regex pattern set. You create and\nmaintain the set independent of your rules. This allows you to use the single set in\nmultiple rules. When you update the referenced set, AWS WAF automatically\nupdates all rules that reference it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the [AWS::WAFv2::RegexPatternSet](./aws-resource-wafv2-regexpatternset.html) that this\nstatement references.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::RuleGroup.Rule": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.Rule`\n\nA single rule, which you can use in a [AWS::WAFv2::WebACL](./aws-resource-wafv2-webacl.html) or [AWS::WAFv2::RuleGroup](./aws-resource-wafv2-rulegroup.html) to identify web requests that you want to manage in some way.\nEach rule includes one top-level [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-statement) that AWS WAF uses to\nidentify matching web requests, and parameters that govern how AWS WAF handles them.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that AWS WAF should take on a web request when it matches the\nrule statement. Settings at the web ACL level can override the rule action setting.\n*Required*: No\n*Type*: [RuleAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-action", "UpdateType": "Mutable", "Required": false, "Type": "RuleAction" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nIf you define more than one `Rule` in a `WebACL`, AWS WAF\nevaluates each request against the `Rules` in order based on the value of\n`Priority`. AWS WAF processes rules with lower priority first. The priorities\ndon'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Statement": { "MarkdownDocumentation": "`Statement`\n\nThe AWS WAF processing statement for the rule, for example [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-bytematchstatement) or [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-sizeconstraintstatement).\n*Required*: Yes\n*Type*: [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-statement", "UpdateType": "Mutable", "Required": true, "Type": "Statement" }, "ChallengeConfig": { "MarkdownDocumentation": "`ChallengeConfig`\n\nSpecifies how AWS WAF should handle `Challenge` evaluations.\nIf you don't specify this, AWS WAF uses the challenge configuration that's\ndefined for the web ACL.\n*Required*: No\n*Type*: [ChallengeConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-challengeconfig", "UpdateType": "Mutable", "Required": false, "Type": "ChallengeConfig" }, "RuleLabels": { "MarkdownDocumentation": "`RuleLabels`\n\nLabels to apply to web requests that match the rule match statement. AWS WAF applies\nfully qualified labels to matching web requests. A fully qualified label is the\nconcatenation of a label namespace and a rule label. The rule's rule group or web ACL\ndefines the label namespace.\n###### Note\nAny rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests.\nRules that run after this rule in the web ACL can match against these labels using a\n`LabelMatchStatement`.\nFor each label, provide a case-sensitive string containing optional namespaces and a\nlabel 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:\n `aws`, `waf`, `managed`, `rulegroup`,\n `webacl`, `regexpatternset`, or `ipset`.\nFor example, `myLabelName` or `nameSpace1:nameSpace2:myLabelName`.\n*Required*: No\n*Type*: Array of [Label](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-rulelabels", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Label", "DuplicatesAllowed": true }, "VisibilityConfig": { "MarkdownDocumentation": "`VisibilityConfig`\n\nDefines and enables Amazon CloudWatch metrics and web request sample collection.\nIf you change the name of a `Rule` after you create\nit and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF\ndoesn't automatically update the metric name.\n*Required*: Yes\n*Type*: [VisibilityConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-visibilityconfig", "UpdateType": "Mutable", "Required": true, "Type": "VisibilityConfig" }, "CaptchaConfig": { "MarkdownDocumentation": "`CaptchaConfig`\n\nSpecifies 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-captchaconfig", "UpdateType": "Mutable", "Required": false, "Type": "CaptchaConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule.\nIf you change the name of a `Rule` after you create\nit and you want the rule's metric name to reflect the change, update the metric name in the rule's `VisibilityConfig` settings. AWS WAF\ndoesn't automatically update the metric name when you update the rule name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.RuleAction": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.RuleAction`\n\nThe action that AWS WAF should take on a web request when it matches a rule's\nstatement. Settings at the web ACL level can override the rule action setting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html", "Properties": { "Captcha": { "MarkdownDocumentation": "`Captcha`\n\nSpecifies that AWS WAF should run a `CAPTCHA` check against\nthe 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\n to a `CountAction`.\n* If the request doesn't include a valid, unexpired `CAPTCHA` token,\n AWS WAF discontinues the web ACL evaluation of the request and blocks\n it from going to its intended destination.\n \n AWS WAF generates a response that it sends back to the client, which\n includes the following:\n \n + The header `x-amzn-waf-action` with a value of\n `captcha`.\n + The HTTP status code `405 Method Not Allowed`.\n + If the request contains an `Accept` header with a value of\n `text/html`, the response includes a `CAPTCHA`\n challenge.\nYou can configure the expiration time in the `CaptchaConfig``ImmunityTimeProperty` setting at the rule and web ACL level. The rule setting\noverrides the web ACL setting.\nThis action option is available for rules. It isn't available for web ACL default\nactions.\n*Required*: No\n*Type*: [CaptchaAction](./aws-properties-wafv2-rulegroup-captchaaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-captcha", "UpdateType": "Mutable", "Required": false, "Type": "CaptchaAction" }, "Block": { "MarkdownDocumentation": "`Block`\n\nInstructs AWS WAF to block the web request.\n*Required*: No\n*Type*: [BlockAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-block", "UpdateType": "Mutable", "Required": false, "Type": "BlockAction" }, "Count": { "MarkdownDocumentation": "`Count`\n\nInstructs 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-count", "UpdateType": "Mutable", "Required": false, "Type": "CountAction" }, "Allow": { "MarkdownDocumentation": "`Allow`\n\nInstructs AWS WAF to allow the web request.\n*Required*: No\n*Type*: [AllowAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-allow", "UpdateType": "Mutable", "Required": false, "Type": "AllowAction" }, "Challenge": { "MarkdownDocumentation": "`Challenge`\n\nInstructs AWS WAF to run a `Challenge` check against the web\nrequest.\n*Required*: No\n*Type*: [ChallengeAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-challenge", "UpdateType": "Mutable", "Required": false, "Type": "ChallengeAction" } } }, "AWS::WAFv2::RuleGroup.SingleHeader": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.SingleHeader`\n\nInspect one of the headers in the web request, identified by name, for example,\n`User-Agent` or `Referer`. The name isn't case sensitive.\nYou can filter and inspect all headers with the `FieldToMatch` setting\n`Headers`.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singleheader.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the query header to inspect.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singleheader.html#cfn-wafv2-rulegroup-singleheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.SingleQueryArgument": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.SingleQueryArgument`\n\nInspect one query argument in the web request, identified by name, for example\n*UserName* or *SalesRegion*. The name isn't case\nsensitive.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singlequeryargument.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the query argument to inspect.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singlequeryargument.html#cfn-wafv2-rulegroup-singlequeryargument-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.SizeConstraintStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.SizeConstraintStatement`\n\nA 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 number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see `Body` and `JsonBody` settings for the `FieldToMatch` data type.\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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe operator to use to compare the request part to the size setting.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQ | NE | LE | LT | GE | GT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQ", "NE", "LE", "LT", "GE", "GT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-comparisonoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size, in byte, to compare to the request part, after any transformations.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `21474836480`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-size", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::RuleGroup.SqliMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.SqliMatchStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html", "Properties": { "SensitivityLevel": { "MarkdownDocumentation": "`SensitivityLevel`\n\nThe 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,\nespecially if your web requests frequently contain unusual strings.\nFor information about identifying and mitigating false positives, see\n[Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the\n*AWS WAF Developer Guide*.\n`LOW` is generally a better choice for resources that already have other\nprotections against SQL injection attacks or that have a low tolerance for false positives.\nDefault: `LOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `LOW | HIGH`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "LOW", "HIGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-sensitivitylevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::RuleGroup.Statement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.Statement`\n\nThe processing guidance for a rule, used by AWS WAF to determine whether a\nweb request matches the rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html", "Properties": { "SizeConstraintStatement": { "MarkdownDocumentation": "`SizeConstraintStatement`\n\nA 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 number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see `Body` and `JsonBody` settings for the `FieldToMatch` data type.\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement", "UpdateType": "Mutable", "Required": false, "Type": "SizeConstraintStatement" }, "AndStatement": { "MarkdownDocumentation": "`AndStatement`\n\nA logical rule statement used to combine other rule statements with AND logic. You\nprovide more than one `Statement` within the `AndStatement`.\n*Required*: No\n*Type*: [AndStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-andstatement", "UpdateType": "Mutable", "Required": false, "Type": "AndStatement" }, "XssMatchStatement": { "MarkdownDocumentation": "`XssMatchStatement`\n\nA rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker\nuses 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-xssmatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "XssMatchStatement" }, "NotStatement": { "MarkdownDocumentation": "`NotStatement`\n\nA logical rule statement used to negate the results of another rule statement. You\nprovide one `Statement` within the `NotStatement`.\n*Required*: No\n*Type*: [NotStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-notstatement", "UpdateType": "Mutable", "Required": false, "Type": "NotStatement" }, "ByteMatchStatement": { "MarkdownDocumentation": "`ByteMatchStatement`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement", "UpdateType": "Mutable", "Required": false, "Type": "ByteMatchStatement" }, "RateBasedStatement": { "MarkdownDocumentation": "`RateBasedStatement`\n\nA rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.\n###### Note\nIf you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.\nYou can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.\nEach unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.\nFor example, assume the rule evaluates web requests with the following IP address and HTTP method values:\n* IP address 10.1.1.1, HTTP method POST\n* IP address 10.1.1.1, HTTP method GET\n* IP address 127.0.0.0, HTTP method POST\n* IP address 10.1.1.1, HTTP method GET\nThe rule would create different aggregation instances according to your aggregation criteria, for example:\n* If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:\n \n + IP address 10.1.1.1: count 3\n + IP address 127.0.0.0: count 1\n* If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:\n \n + HTTP method POST: count 2\n + HTTP method GET: count 2\n* If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:\n \n + IP address 10.1.1.1, HTTP method POST: count 1\n + IP address 10.1.1.1, HTTP method GET: count 2\n + IP address 127.0.0.0, HTTP method POST: count 1\nFor any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the 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.\nFor additional information about the options, see [Rate limiting web requests using rate-based rules](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html)\nin the *AWS WAF Developer Guide*.\nIf you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF\nis currently rate limiting for a rule through the API call `GetRateBasedStatementManagedKeys`. This option is not available\nfor other aggregation configurations.\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF.\n*Required*: No\n*Type*: [RateBasedStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-ratebasedstatement", "UpdateType": "Mutable", "Required": false, "Type": "RateBasedStatement" }, "GeoMatchStatement": { "MarkdownDocumentation": "`GeoMatchStatement`\n\nA 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.\nAWS 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-geomatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "GeoMatchStatement" }, "LabelMatchStatement": { "MarkdownDocumentation": "`LabelMatchStatement`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-labelmatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "LabelMatchStatement" }, "RegexMatchStatement": { "MarkdownDocumentation": "`RegexMatchStatement`\n\nA rule statement used to search web request components for a match against a single regular expression.\n*Required*: No\n*Type*: [RegexMatchStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-regexmatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "RegexMatchStatement" }, "SqliMatchStatement": { "MarkdownDocumentation": "`SqliMatchStatement`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sqlimatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "SqliMatchStatement" }, "RegexPatternSetReferenceStatement": { "MarkdownDocumentation": "`RegexPatternSetReferenceStatement`\n\nA rule statement used to search web request components for matches with regular\nexpressions. To use this, create a [AWS::WAFv2::RegexPatternSet](./aws-resource-wafv2-regexpatternset.html) that specifies the\nexpressions that you want to detect, then use the ARN of that set in this statement. A web\nrequest matches the pattern set rule statement if the request component matches any of the\npatterns in the set.\nEach regex pattern set rule statement references a regex pattern set. You create and\nmaintain the set independent of your rules. This allows you to use the single set in\nmultiple rules. When you update the referenced set, AWS WAF automatically\nupdates all rules that reference it.\n*Required*: No\n*Type*: [RegexPatternSetReferenceStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-regexpatternsetreferencestatement", "UpdateType": "Mutable", "Required": false, "Type": "RegexPatternSetReferenceStatement" }, "OrStatement": { "MarkdownDocumentation": "`OrStatement`\n\nA logical rule statement used to combine other rule statements with OR logic. You\nprovide more than one `Statement` within the `OrStatement`.\n*Required*: No\n*Type*: [OrStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-orstatement", "UpdateType": "Mutable", "Required": false, "Type": "OrStatement" }, "AsnMatchStatement": { "MarkdownDocumentation": "`AsnMatchStatement`\n\nA rule statement that inspects web traffic based on the Autonomous System Number (ASN) associated with the request's IP address.\nFor additional details, see [ASN match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-asn-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\n*Required*: No\n*Type*: [AsnMatchStatement](./aws-properties-wafv2-rulegroup-asnmatchstatement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-asnmatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "AsnMatchStatement" }, "IPSetReferenceStatement": { "MarkdownDocumentation": "`IPSetReferenceStatement`\n\nA rule statement used to detect web requests coming from particular IP addresses or\naddress ranges. To use this, create an [AWS::WAFv2::IPSet](./aws-resource-wafv2-ipset.html) that specifies the addresses\nyou 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\nindependent of your rules. This allows you to use the single set in multiple rules. When\nyou update the referenced set, AWS WAF automatically updates all rules that\nreference it.\n*Required*: No\n*Type*: [IPSetReferenceStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-ipsetreferencestatement", "UpdateType": "Mutable", "Required": false, "Type": "IPSetReferenceStatement" } } }, "AWS::WAFv2::RuleGroup.TextTransformation": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nFor detailed descriptions of each of the transformation types, see [Text transformations](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-transformation.html)\nin the *AWS WAF Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE", "BASE64_DECODE", "HEX_DECODE", "MD5", "REPLACE_COMMENTS", "ESCAPE_SEQ_DECODE", "SQL_HEX_DECODE", "CSS_DECODE", "JS_DECODE", "NORMALIZE_PATH", "NORMALIZE_PATH_WIN", "REMOVE_NULLS", "REPLACE_NULLS", "BASE64_DECODE_EXT", "URL_DECODE_UNI", "UTF8_TO_UNICODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html#cfn-wafv2-rulegroup-texttransformation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nSets the relative processing order for multiple transformations.\nAWS WAF processes all transformations, from lowest priority to highest,\nbefore inspecting the transformed content. The priorities don't need to be consecutive, but\nthey 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html#cfn-wafv2-rulegroup-texttransformation-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::WAFv2::RuleGroup.UriFragment": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.UriFragment`\n\nInspect fragments of the request URI. You can specify the parts of the URI fragment to\ninspect and you can narrow the set of URI fragments to inspect by including or excluding specific\nkeys.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\nExample JSON: `\"UriFragment\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n\"OversizeHandling\": \"MATCH\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-urifragment.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nWhat AWS WAF should do if it fails to completely parse the JSON body. The options are\nthe following:\n* `EVALUATE_AS_STRING` - Inspect the body as plain text. AWS WAF\n applies the text transformations and inspection criteria that you defined for the\n JSON inspection to the body text string.\n* `MATCH` - Treat the web request as matching the rule statement.\n AWS WAF applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n statement.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the\nfirst parsing failure that it encounters.\nExample JSON: `{ \"UriFragment\": { \"FallbackBehavior\": \"MATCH\"} }`\n###### Note\nAWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When\nparsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information,\nsee [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body)\nin the *AWS WAF Developer Guide*.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-urifragment.html#cfn-wafv2-rulegroup-urifragment-fallbackbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::RuleGroup.VisibilityConfig": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.VisibilityConfig`\n\nDefines and enables Amazon CloudWatch metrics and web request sample collection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nA name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9,\n- (hyphen), and \\_ (underscore). The name can be from one to 128 characters long. It can't\ncontain whitespace or metric names that are reserved for AWS WAF, for example `All` and\n`Default_Action`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SampledRequestsEnabled": { "MarkdownDocumentation": "`SampledRequestsEnabled`\n\nIndicates whether AWS WAF should store a sampling of the web requests that\nmatch the rules. You can view the sampled requests through the AWS WAF console.\nIf you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.\n###### Note\nRequest sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling.\nYou can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration\nor by configuring data protection for the web ACL.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-sampledrequestsenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "CloudWatchMetricsEnabled": { "MarkdownDocumentation": "`CloudWatchMetricsEnabled`\n\nIndicates whether the associated resource sends metrics to Amazon CloudWatch. For the\nlist of available metrics, see [AWS WAF\nMetrics](https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics) in the *AWS WAF Developer Guide*.\nFor web ACLs, the metrics are for web requests that have the web ACL default action applied.\nAWS WAF applies the default action to web requests that pass the inspection of all rules\nin the web ACL without being either allowed or blocked. For more information,\nsee [The web ACL default action](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html) in the *AWS WAF Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-cloudwatchmetricsenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::WAFv2::RuleGroup.XssMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup.XssMatchStatement`\n\nA rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker\nuses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-rulegroup-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::WebACL.AWSManagedRulesACFPRuleSet": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.AWSManagedRulesACFPRuleSet`\n\nDetails for your use of the account creation fraud prevention managed rule group, `AWSManagedRulesACFPRuleSet`. This configuration is used in `ManagedRuleGroupConfig`.\nFor additional information about this and the other intelligent threat mitigation rule groups,\nsee [Intelligent threat mitigation in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-managed-protections)\nand [AWS Managed Rules rule groups list](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesacfpruleset.html", "Properties": { "RegistrationPagePath": { "MarkdownDocumentation": "`RegistrationPagePath`\n\nThe path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.\n###### Note\nThis page must accept `GET` text/html requests.\nFor example, for the URL `https://example.com/web/registration`, you would provide\nthe path `/web/registration`. Registration page paths that\nstart with the path that you provide are considered a match. For example\n`/web/registration` matches the registration paths\n`/web/registration`, `/web/registration/`,\n`/web/registrationPage`, and\n`/web/registration/thisPage`, but doesn't match the path\n`/home/web/registration` or\n`/website/registration`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesacfpruleset.html#cfn-wafv2-webacl-awsmanagedrulesacfpruleset-registrationpagepath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResponseInspection": { "MarkdownDocumentation": "`ResponseInspection`\n\nThe criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.\n###### Note\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.\nThe ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels\nand mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.\n*Required*: No\n*Type*: [ResponseInspection](./aws-properties-wafv2-webacl-responseinspection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesacfpruleset.html#cfn-wafv2-webacl-awsmanagedrulesacfpruleset-responseinspection", "UpdateType": "Mutable", "Required": false, "Type": "ResponseInspection" }, "CreationPath": { "MarkdownDocumentation": "`CreationPath`\n\nThe path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept `POST` requests.\nFor example, for the URL `https://example.com/web/newaccount`, you would provide\nthe path `/web/newaccount`. Account creation page paths that\nstart with the path that you provide are considered a match. For example\n`/web/newaccount` matches the account creation paths\n`/web/newaccount`, `/web/newaccount/`,\n`/web/newaccountPage`, and\n`/web/newaccount/thisPage`, but doesn't match the path\n`/home/web/newaccount` or\n`/website/newaccount`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesacfpruleset.html#cfn-wafv2-webacl-awsmanagedrulesacfpruleset-creationpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnableRegexInPath": { "MarkdownDocumentation": "`EnableRegexInPath`\n\nAllow the use of regular expressions in the registration page path and the account creation path.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesacfpruleset.html#cfn-wafv2-webacl-awsmanagedrulesacfpruleset-enableregexinpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RequestInspection": { "MarkdownDocumentation": "`RequestInspection`\n\nThe criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.\n*Required*: Yes\n*Type*: [RequestInspectionACFP](./aws-properties-wafv2-webacl-requestinspectionacfp.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesacfpruleset.html#cfn-wafv2-webacl-awsmanagedrulesacfpruleset-requestinspection", "UpdateType": "Mutable", "Required": true, "Type": "RequestInspectionACFP" } } }, "AWS::WAFv2::WebACL.AWSManagedRulesATPRuleSet": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.AWSManagedRulesATPRuleSet`\n\nDetails for your use of the account takeover prevention managed rule group, `AWSManagedRulesATPRuleSet`. This configuration is used in `ManagedRuleGroupConfig`.\nFor additional information about this and the other intelligent threat mitigation rule groups,\nsee [Intelligent threat mitigation in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-managed-protections)\nand [AWS Managed Rules rule groups list](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesatpruleset.html", "Properties": { "ResponseInspection": { "MarkdownDocumentation": "`ResponseInspection`\n\nThe criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.\n###### Note\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.\nThe ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels\nand mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.\n*Required*: No\n*Type*: [ResponseInspection](./aws-properties-wafv2-webacl-responseinspection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesatpruleset.html#cfn-wafv2-webacl-awsmanagedrulesatpruleset-responseinspection", "UpdateType": "Mutable", "Required": false, "Type": "ResponseInspection" }, "EnableRegexInPath": { "MarkdownDocumentation": "`EnableRegexInPath`\n\nAllow the use of regular expressions in the login page path.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesatpruleset.html#cfn-wafv2-webacl-awsmanagedrulesatpruleset-enableregexinpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LoginPath": { "MarkdownDocumentation": "`LoginPath`\n\nThe path of the login endpoint for your application. For example, for the URL\n`https://example.com/web/login`, you would provide the path\n`/web/login`. Login paths that start with the path that you provide are considered a match. For example `/web/login` matches the login paths `/web/login`, `/web/login/`, `/web/loginPage`, and `/web/login/thisPage`, but doesn't match the login path `/home/web/login` or `/website/login`.\nThe rule group inspects only HTTP `POST` requests to your specified login 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesatpruleset.html#cfn-wafv2-webacl-awsmanagedrulesatpruleset-loginpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RequestInspection": { "MarkdownDocumentation": "`RequestInspection`\n\nThe criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.\n*Required*: No\n*Type*: [RequestInspection](./aws-properties-wafv2-webacl-requestinspection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesatpruleset.html#cfn-wafv2-webacl-awsmanagedrulesatpruleset-requestinspection", "UpdateType": "Mutable", "Required": false, "Type": "RequestInspection" } } }, "AWS::WAFv2::WebACL.AWSManagedRulesAntiDDoSRuleSet": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.AWSManagedRulesAntiDDoSRuleSet`\n\nConfigures the use of the anti-DDoS managed rule group, `AWSManagedRulesAntiDDoSRuleSet`. This configuration is used in `ManagedRuleGroupConfig`.\nThe configuration that you provide here determines whether and how the rules in the rule group are used.\nFor additional information about this and the other intelligent threat mitigation rule groups,\nsee [Intelligent threat mitigation in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-managed-protections)\nand [AWS Managed Rules rule groups list](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesantiddosruleset.html", "Properties": { "ClientSideActionConfig": { "MarkdownDocumentation": "`ClientSideActionConfig`\n\nConfigures the request handling that's applied by the managed rule group rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` during a distributed denial of service (DDoS) attack.\n*Required*: Yes\n*Type*: [ClientSideActionConfig](./aws-properties-wafv2-webacl-clientsideactionconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesantiddosruleset.html#cfn-wafv2-webacl-awsmanagedrulesantiddosruleset-clientsideactionconfig", "UpdateType": "Mutable", "Required": true, "Type": "ClientSideActionConfig" }, "SensitivityToBlock": { "MarkdownDocumentation": "`SensitivityToBlock`\n\nThe sensitivity that the rule group rule `DDoSRequests` uses when matching against the\nDDoS suspicion labeling on a request. The managed rule group adds the labeling during DDoS events, before the `DDoSRequests` rule runs.\nThe higher the sensitivity, the more levels of labeling that the rule matches:\n* Low sensitivity is less sensitive, causing the rule to match only on the most likely participants in an attack, which are the requests with the high suspicion label `awswaf:managed:aws:anti-ddos:high-suspicion-ddos-request`.\n* Medium sensitivity causes the rule to match on the medium and high suspicion labels.\n* High sensitivity causes the rule to match on all of the suspicion labels: low, medium, and high.\nDefault: `LOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `LOW | MEDIUM | HIGH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOW", "MEDIUM", "HIGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesantiddosruleset.html#cfn-wafv2-webacl-awsmanagedrulesantiddosruleset-sensitivitytoblock", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.AWSManagedRulesBotControlRuleSet": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.AWSManagedRulesBotControlRuleSet`\n\nDetails for your use of the Bot Control managed rule group, `AWSManagedRulesBotControlRuleSet`. This configuration is used in `ManagedRuleGroupConfig`.\nFor additional information about this and the other intelligent threat mitigation rule groups,\nsee [Intelligent threat mitigation in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-managed-protections)\nand [AWS Managed Rules rule groups list](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesbotcontrolruleset.html", "Properties": { "InspectionLevel": { "MarkdownDocumentation": "`InspectionLevel`\n\nThe inspection level to use for the Bot Control rule group. The common level is the least expensive. The\ntargeted level includes all common level rules and adds rules with more advanced inspection criteria. For\ndetails, see [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html)\nin the *AWS WAF Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `COMMON | TARGETED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COMMON", "TARGETED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesbotcontrolruleset.html#cfn-wafv2-webacl-awsmanagedrulesbotcontrolruleset-inspectionlevel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnableMachineLearning": { "MarkdownDocumentation": "`EnableMachineLearning`\n\nApplies only to the targeted inspection level.\nDetermines whether to use machine learning (ML) to\nanalyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules `TGT_ML_CoordinatedActivityLow` and `TGT_ML_CoordinatedActivityMedium`, which\ninspect for anomalous behavior that might indicate distributed, coordinated bot activity.\nFor more information about this choice, see the listing for these rules in the table at [Bot Control rules listing](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html#aws-managed-rule-groups-bot-rules) in the\n*AWS WAF Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesbotcontrolruleset.html#cfn-wafv2-webacl-awsmanagedrulesbotcontrolruleset-enablemachinelearning", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::WAFv2::WebACL.AllowAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.AllowAction`\n\nSpecifies that AWS WAF should allow the request and optionally defines\nadditional custom handling for the request.\nThis is used in the context of other settings, for example to specify values for a rule\naction or a web ACL default action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-allowaction.html", "Properties": { "CustomRequestHandling": { "MarkdownDocumentation": "`CustomRequestHandling`\n\nDefines custom handling for the web request.\nFor information about customizing web requests and responses,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomRequestHandling](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-allowaction.html#cfn-wafv2-webacl-allowaction-customrequesthandling", "UpdateType": "Mutable", "Required": false, "Type": "CustomRequestHandling" } } }, "AWS::WAFv2::WebACL.AndStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.AndStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatement.html", "Properties": { "Statements": { "MarkdownDocumentation": "`Statements`\n\nThe statements to combine with AND logic. You can use any statements that can be nested.\n*Required*: Yes\n*Type*: Array of [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatement.html#cfn-wafv2-webacl-andstatement-statements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Statement", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.ApplicationAttribute": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ApplicationAttribute`\n\nApplication details defined during the web ACL creation process. Application attributes help AWS WAF give recommendations for protection packs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-applicationattribute.html", "Properties": { "Values": { "MarkdownDocumentation": "`Values`\n\nSpecifies the attribute value.\n*Required*: Yes\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-applicationattribute.html#cfn-wafv2-webacl-applicationattribute-values", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nSpecifies the attribute name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-applicationattribute.html#cfn-wafv2-webacl-applicationattribute-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.ApplicationConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ApplicationConfig`\n\nA list of `ApplicationAttribute`s that contains information about the application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-applicationconfig.html", "Properties": { "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nContains the attribute name and a list of values for that attribute.\n*Required*: Yes\n*Type*: Array of [ApplicationAttribute](./aws-properties-wafv2-webacl-applicationattribute.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-applicationconfig.html#cfn-wafv2-webacl-applicationconfig-attributes", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ApplicationAttribute", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.AsnMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.AsnMatchStatement`\n\nA rule statement that inspects web traffic based on the Autonomous System Number (ASN) associated with the request's IP address.\nFor additional details, see [ASN match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-asn-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-asnmatchstatement.html", "Properties": { "ForwardedIPConfig": { "MarkdownDocumentation": "`ForwardedIPConfig`\n\nThe configuration for inspecting IP addresses to match against an ASN in an HTTP header that you specify,\ninstead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header,\nbut you can specify any header name.\n*Required*: No\n*Type*: [ForwardedIPConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-asnmatchstatement.html#cfn-wafv2-webacl-asnmatchstatement-forwardedipconfig", "UpdateType": "Mutable", "Required": false, "Type": "ForwardedIPConfiguration" }, "AsnList": { "MarkdownDocumentation": "`AsnList`\n\nContains one or more Autonomous System Numbers (ASNs).\nASNs are unique identifiers assigned to large internet networks managed by organizations such as\ninternet service providers, enterprises, universities, or government agencies.\n*Required*: No\n*Type*: Array of Integer\n*Minimum*: `0`\n*Maximum*: `4294967295`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-asnmatchstatement.html#cfn-wafv2-webacl-asnmatchstatement-asnlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.AssociationConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.AssociationConfig`\n\nSpecifies custom configurations for the associations between the web ACL and protected resources.\nUse this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can\ncustomize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).\n###### Note\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [AWS WAF Pricing](https://aws.amazon.com/waf/pricing/).\nFor Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-associationconfig.html", "Properties": { "RequestBody": { "MarkdownDocumentation": "`RequestBody`\n\nCustomizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.\n###### Note\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [AWS WAF Pricing](https://aws.amazon.com/waf/pricing/).\nExample JSON: `{\n\"API_GATEWAY\": \"KB_48\",\n\"APP_RUNNER_SERVICE\": \"KB_32\"\n}`\nFor Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n*Required*: No\n*Type*: Object of [RequestBodyAssociatedResourceTypeConfig](./aws-properties-wafv2-webacl-requestbodyassociatedresourcetypeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-associationconfig.html#cfn-wafv2-webacl-associationconfig-requestbody", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "RequestBodyAssociatedResourceTypeConfig" } } }, "AWS::WAFv2::WebACL.BlockAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.BlockAction`\n\nSpecifies that AWS WAF should block the request and optionally defines\nadditional custom handling for the response to the web request.\nThis is used in the context of other settings, for example to specify values for a rule\naction or a web ACL default action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html", "Properties": { "CustomResponse": { "MarkdownDocumentation": "`CustomResponse`\n\nDefines a custom response for the web request.\nFor information about customizing web requests and responses,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomResponse](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html#cfn-wafv2-webacl-blockaction-customresponse", "UpdateType": "Mutable", "Required": false, "Type": "CustomResponse" } } }, "AWS::WAFv2::WebACL.Body": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.Body`\n\nInspect the body of the web request. The body immediately follows the request\nheaders.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-body.html", "Properties": { "OversizeHandling": { "MarkdownDocumentation": "`OversizeHandling`\n\nWhat AWS WAF should do if the body is larger than AWS WAF can inspect.\nAWS WAF does not support inspecting the entire contents of the web request body if the body\nexceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service\nonly forwards the contents that are within the limit to AWS WAF for inspection.\n* For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n* For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and\n you can increase the limit for each resource type in the web ACL `AssociationConfig`, for additional processing fees.\n* For AWS Amplify, use the CloudFront limit.\nThe options for oversize handling are the following:\n* `CONTINUE` - Inspect the available body contents normally, according to the rule inspection criteria.\n* `MATCH` - Treat the web request as matching the rule statement. AWS WAF\n applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n statement.\nYou can combine the `MATCH` or `NO_MATCH`\nsettings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-body.html#cfn-wafv2-webacl-body-oversizehandling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.ByteMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ByteMatchStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html", "Properties": { "SearchStringBase64": { "MarkdownDocumentation": "`SearchStringBase64`\n\nString to search for in a web request component, base64-encoded. If you don't want to\nencode the string, specify the unencoded value in `SearchString` instead.\nYou must specify either `SearchString` or `SearchStringBase64` in\na `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-searchstringbase64", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "PositionalConstraint": { "MarkdownDocumentation": "`PositionalConstraint`\n\nThe area within the portion of the web request that you want AWS WAF to search for\n`SearchString`. Valid values include the following:\n**CONTAINS**\nThe specified part of the web request must include the value of\n`SearchString`, but the location doesn't matter.\n**CONTAINS\\_WORD**\nThe specified part of the web request must include the value of\n`SearchString`, and `SearchString` must contain only alphanumeric\ncharacters or underscore (A-Z, a-z, 0-9, or \\_). In addition, `SearchString` must\nbe a word, which means that both of the following are true:\n* `SearchString` is at the beginning of the specified part of the web\n request or is preceded by a character other than an alphanumeric character or\n underscore (\\_). Examples include the value of a header and\n `;BadBot`.\n* `SearchString` is at the end of the specified part of the web request or\n is followed by a character other than an alphanumeric character or underscore (\\_),\n for example, `BadBot;` and `-BadBot;`.\n**EXACTLY**\nThe value of the specified part of the web request must exactly match the value of\n`SearchString`.\n**STARTS\\_WITH**\nThe value of `SearchString` must appear at the beginning of the specified\npart of the web request.\n**ENDS\\_WITH**\nThe value of `SearchString` must appear at the end of the specified part of\nthe web request.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EXACTLY | STARTS_WITH | END...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXACTLY", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "CONTAINS_WORD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-positionalconstraint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SearchString": { "MarkdownDocumentation": "`SearchString`\n\nA string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for\ninspection in `FieldToMatch`. The maximum length of the value is 200 bytes. For\nalphabetic 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\nsearch for. AWS CloudFormation automatically base64 encodes the value for you.\nFor example, suppose the value of `Type` is `HEADER` and the value\nof `Data` is `User-Agent`. If you want to search the\n`User-Agent` header for the value `BadBot`, you provide the string\n`BadBot` in the value of `SearchString`.\nYou must specify either `SearchString` or `SearchStringBase64` in\na `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-searchstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html#cfn-wafv2-webacl-bytematchstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::WebACL.CaptchaAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.CaptchaAction`\n\nSpecifies that AWS WAF should run a `CAPTCHA` check against\nthe 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\n to a `CountAction`.\n* If the request doesn't include a valid, unexpired `CAPTCHA` token,\n AWS WAF discontinues the web ACL evaluation of the request and blocks\n it from going to its intended destination.\n \n AWS WAF generates a response that it sends back to the client, which\n includes the following:\n \n + The header `x-amzn-waf-action` with a value of\n `captcha`.\n + The HTTP status code `405 Method Not Allowed`.\n + If the request contains an `Accept` header with a value of\n `text/html`, the response includes a `CAPTCHA`\n challenge.\nYou can configure the expiration time in the `CaptchaConfig``ImmunityTimeProperty` setting at the rule and web ACL level. The rule setting\noverrides the web ACL setting.\nThis action option is available for rules. It isn't available for web ACL default\nactions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-captchaaction.html", "Properties": { "CustomRequestHandling": { "MarkdownDocumentation": "`CustomRequestHandling`\n\nDefines 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,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomRequestHandling](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-captchaaction.html#cfn-wafv2-webacl-captchaaction-customrequesthandling", "UpdateType": "Mutable", "Required": false, "Type": "CustomRequestHandling" } } }, "AWS::WAFv2::WebACL.CaptchaConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.CaptchaConfig`\n\nSpecifies 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-captchaconfig.html", "Properties": { "ImmunityTimeProperty": { "MarkdownDocumentation": "`ImmunityTimeProperty`\n\nDetermines how long a `CAPTCHA` timestamp in the token remains valid after the client\nsuccessfully solves a `CAPTCHA` puzzle.\n*Required*: No\n*Type*: [ImmunityTimeProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-captchaconfig.html#cfn-wafv2-webacl-captchaconfig-immunitytimeproperty", "UpdateType": "Mutable", "Required": false, "Type": "ImmunityTimeProperty" } } }, "AWS::WAFv2::WebACL.ChallengeAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ChallengeAction`\n\nSpecifies that AWS WAF should run a `Challenge` check against\nthe request to verify that the request is coming from a legitimate client session:\n* If the request includes a valid, unexpired challenge token, AWS WAF\n applies any custom request handling and labels that you've configured and then allows\n the web request inspection to proceed to the next rule, similar to a\n `CountAction`.\n* If the request doesn't include a valid, unexpired challenge token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from\n going to its intended destination.\n \n AWS WAF then generates a challenge response that it sends back to the\n client, which includes the following:\n \n + The header `x-amzn-waf-action` with a value of\n `challenge`.\n + The HTTP status code `202 Request Accepted`.\n + If the request contains an `Accept` header with a value of\n `text/html`, the response includes a JavaScript page interstitial\n with a challenge script.\n \n Challenges run silent browser interrogations in the background, and don't\n generally affect the end user experience.\n \n A challenge enforces token acquisition using an interstitial JavaScript challenge\n that inspects the client session for legitimate behavior. The challenge blocks bots\n or at least increases the cost of operating sophisticated bots.\n \n After the client session successfully responds to the challenge, it receives a new\n token from AWS WAF, which the challenge script uses to resubmit the\n original request.\nYou can configure the expiration time in the `ChallengeConfig``ImmunityTimeProperty` setting at the rule and web ACL level. The rule setting\noverrides the web ACL setting.\nThis action option is available for rules. It isn't available for web ACL default\nactions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeaction.html", "Properties": { "CustomRequestHandling": { "MarkdownDocumentation": "`CustomRequestHandling`\n\nDefines custom handling for the web request, used when the challenge inspection\ndetermines 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeaction.html#cfn-wafv2-webacl-challengeaction-customrequesthandling", "UpdateType": "Mutable", "Required": false, "Type": "CustomRequestHandling" } } }, "AWS::WAFv2::WebACL.ChallengeConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ChallengeConfig`\n\nSpecifies how AWS WAF should handle `Challenge` evaluations.\nThis is available at the web ACL level and in each rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeconfig.html", "Properties": { "ImmunityTimeProperty": { "MarkdownDocumentation": "`ImmunityTimeProperty`\n\nDetermines how long a challenge timestamp in the token remains valid after the client\nsuccessfully responds to a challenge.\n*Required*: No\n*Type*: [ImmunityTimeProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeconfig.html#cfn-wafv2-webacl-challengeconfig-immunitytimeproperty", "UpdateType": "Mutable", "Required": false, "Type": "ImmunityTimeProperty" } } }, "AWS::WAFv2::WebACL.ClientSideAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ClientSideAction`\n\nThis is part of the `AWSManagedRulesAntiDDoSRuleSet``ClientSideActionConfig` configuration in `ManagedRuleGroupConfig`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-clientsideaction.html", "Properties": { "UsageOfAction": { "MarkdownDocumentation": "`UsageOfAction`\n\nDetermines whether to use the `AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` in the rule group evaluation and the related label `awswaf:managed:aws:anti-ddos:challengeable-request`.\n* If usage is enabled:\n \n + The managed rule group adds the label `awswaf:managed:aws:anti-ddos:challengeable-request` to any web request whose URL does *NOT* match the regular expressions provided in the\n `ClientSideAction` setting `ExemptUriRegularExpressions`.\n + The two rules are evaluated against web requests for protected resources that are experiencing a DDoS attack.\n The two rules only apply their action to matching requests that have the label `awswaf:managed:aws:anti-ddos:challengeable-request`.\n* If usage is disabled:\n \n + The managed rule group doesn't add the label `awswaf:managed:aws:anti-ddos:challengeable-request` to any web requests.\n + The two rules are not evaluated.\n + None of the other `ClientSideAction` settings have any effect.\n###### Note\nThis setting only enables or disables the use of the two anti-DDOS rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` in the anti-DDoS managed rule group.\nThis setting doesn't alter the action setting in the two rules. To override the actions\nused by the rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests`,\nenable this setting, and then override the rule actions in the usual way, in your managed rule group configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-clientsideaction.html#cfn-wafv2-webacl-clientsideaction-usageofaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Sensitivity": { "MarkdownDocumentation": "`Sensitivity`\n\nThe sensitivity that the rule group rule `ChallengeDDoSRequests` uses when matching against the\nDDoS suspicion labeling on a request. The managed rule group adds the labeling during DDoS events, before the `ChallengeDDoSRequests` rule runs.\nThe higher the sensitivity, the more levels of labeling that the rule matches:\n* Low sensitivity is less sensitive, causing the rule to match only on the most likely participants in an attack, which are the requests with the high suspicion label `awswaf:managed:aws:anti-ddos:high-suspicion-ddos-request`.\n* Medium sensitivity causes the rule to match on the medium and high suspicion labels.\n* High sensitivity causes the rule to match on all of the suspicion labels: low, medium, and high.\nDefault: `HIGH`\n*Required*: No\n*Type*: String\n*Allowed values*: `LOW | MEDIUM | HIGH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOW", "MEDIUM", "HIGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-clientsideaction.html#cfn-wafv2-webacl-clientsideaction-sensitivity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExemptUriRegularExpressions": { "MarkdownDocumentation": "`ExemptUriRegularExpressions`\n\nThe regular expression to match against the web request URI, used to identify requests\nthat can't handle a silent browser challenge. When the `ClientSideAction` setting `UsageOfAction` is enabled,\nthe managed rule group uses this setting to determine which requests to label with\n`awswaf:managed:aws:anti-ddos:challengeable-request`. If `UsageOfAction` is disabled, this setting\nhas no effect and the managed rule group doesn't add the label to any requests.\nThe anti-DDoS managed rule group doesn't\nevaluate the rules `ChallengeDDoSRequests` or `ChallengeAllDuringEvent` for web requests whose URIs match this regex. This\nis true regardless of whether you override the rule action for either of the rules in your web ACL configuration.\nAWS recommends using a regular expression.\nThis setting is required if `UsageOfAction` is set to `ENABLED`. If required, you can provide\nbetween 1 and 5 regex objects in the array of settings.\nAWS recommends starting with the following setting. Review and update it for your application's needs:\n`\\/api\\/|\\.(acc|avi|css|gif|jpe?g|js|mp[34]|ogg|otf|pdf|png|tiff?|ttf|webm|webp|woff2?)$`\n*Required*: No\n*Type*: Array of [Regex](./aws-properties-wafv2-webacl-regex.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-clientsideaction.html#cfn-wafv2-webacl-clientsideaction-exempturiregularexpressions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Regex", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.ClientSideActionConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ClientSideActionConfig`\n\nThis is part of the configuration for the managed rules `AWSManagedRulesAntiDDoSRuleSet`\nin `ManagedRuleGroupConfig`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-clientsideactionconfig.html", "Properties": { "Challenge": { "MarkdownDocumentation": "`Challenge`\n\nConfiguration for the use of the `AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests`.\n###### Note\nThis setting isn't related to the configuration of the `Challenge` action itself. It only\nconfigures the use of the two anti-DDoS rules named here.\nYou can enable or disable the use of these rules, and you can configure how to use them when they are enabled.\n*Required*: Yes\n*Type*: [ClientSideAction](./aws-properties-wafv2-webacl-clientsideaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-clientsideactionconfig.html#cfn-wafv2-webacl-clientsideactionconfig-challenge", "UpdateType": "Mutable", "Required": true, "Type": "ClientSideAction" } } }, "AWS::WAFv2::WebACL.CookieMatchPattern": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.CookieMatchPattern`\n\nThe 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\": [ \"session-id-time\", \"session-id\" ] }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookiematchpattern.html", "Properties": { "All": { "MarkdownDocumentation": "`All`\n\nInspect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookiematchpattern.html#cfn-wafv2-webacl-cookiematchpattern-all", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "IncludedCookies": { "MarkdownDocumentation": "`IncludedCookies`\n\nInspect only the cookies that have a key that matches one of the strings specified here.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `60 | 199`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookiematchpattern.html#cfn-wafv2-webacl-cookiematchpattern-includedcookies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExcludedCookies": { "MarkdownDocumentation": "`ExcludedCookies`\n\nInspect only the cookies whose keys don't match any of the strings specified here.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `60 | 199`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookiematchpattern.html#cfn-wafv2-webacl-cookiematchpattern-excludedcookies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.Cookies": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.Cookies`\n\nInspect the cookies in the web request. You can specify the parts of the cookies to\ninspect and you can narrow the set of cookies to inspect by including or excluding specific\nkeys.\nThis is used to indicate the web request component to inspect, in the\n`FieldToMatch` specification.\nExample JSON: `\"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n\"OversizeHandling\": \"MATCH\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookies.html", "Properties": { "MatchScope": { "MarkdownDocumentation": "`MatchScope`\n\nThe parts of the cookies to inspect with the rule inspection criteria. If you specify\n`ALL`, AWS WAF inspects both keys and values.\n`All` does not require a match to be found in the keys\nand a match to be found in the values. It requires a match to be found in the keys\nor the values or both. To require a match in the keys and in the values, use a logical `AND` statement\nto combine two match rules, one that inspects the keys and another that inspects the 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)", "RefReturnValue": "", "AllowedValues": [ "ALL", "KEY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookies.html#cfn-wafv2-webacl-cookies-matchscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchPattern": { "MarkdownDocumentation": "`MatchPattern`\n\nThe 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\": [ \"session-id-time\", \"session-id\" ] }`\n*Required*: Yes\n*Type*: [CookieMatchPattern](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookies.html#cfn-wafv2-webacl-cookies-matchpattern", "UpdateType": "Mutable", "Required": true, "Type": "CookieMatchPattern" }, "OversizeHandling": { "MarkdownDocumentation": "`OversizeHandling`\n\nWhat AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect.\nAWS WAF does not support inspecting the entire contents of request cookies\nwhen they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies\nand at most 8 KB of cookie contents to AWS WAF.\nThe options for oversize handling are the following:\n* `CONTINUE` - Inspect the available cookies normally, according to the rule inspection criteria.\n* `MATCH` - Treat the web request as matching the rule statement. AWS WAF\n applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n 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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookies.html#cfn-wafv2-webacl-cookies-oversizehandling", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.CountAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.CountAction`\n\nSpecifies that AWS WAF should count the request. Optionally defines\nadditional custom handling for the request.\nThis is used in the context of other settings, for example to specify values for a rule\naction or a web ACL default action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html", "Properties": { "CustomRequestHandling": { "MarkdownDocumentation": "`CustomRequestHandling`\n\nDefines custom handling for the web request.\nFor information about customizing web requests and responses,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [CustomRequestHandling](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html#cfn-wafv2-webacl-countaction-customrequesthandling", "UpdateType": "Mutable", "Required": false, "Type": "CustomRequestHandling" } } }, "AWS::WAFv2::WebACL.CustomHTTPHeader": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.CustomHTTPHeader`\n\nA custom header for custom request and response handling. This is used in [CustomResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html#cfn-wafv2-webacl-blockaction-customresponse) and [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html#cfn-wafv2-webacl-countaction-customrequesthandling).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customhttpheader.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value of the custom header.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customhttpheader.html#cfn-wafv2-webacl-customhttpheader-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the custom header.\nFor custom request header insertion, when AWS WAF inserts the header into the request,\nit prefixes this name `x-amzn-waf-`, to avoid confusion with the headers that\nare already in the request. For example, for the header name `sample`, AWS WAF\ninserts the header `x-amzn-waf-sample`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customhttpheader.html#cfn-wafv2-webacl-customhttpheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.CustomRequestHandling": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.CustomRequestHandling`\n\nCustom request handling behavior that inserts custom headers into a web request. You can\nadd custom request handling for AWS WAF to use when the rule action doesn't block the request.\nFor example, `CaptchaAction` for requests with valid t okens, and `AllowAction`.\nFor information about customizing web requests and responses,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html", "Properties": { "InsertHeaders": { "MarkdownDocumentation": "`InsertHeaders`\n\nThe 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)\nin the *AWS WAF Developer Guide*.\n*Required*: Yes\n*Type*: Array of [CustomHTTPHeader](./aws-properties-wafv2-webacl-customhttpheader.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html#cfn-wafv2-webacl-customrequesthandling-insertheaders", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CustomHTTPHeader", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.CustomResponse": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.CustomResponse`\n\nA custom response to send to the client. You can define a custom response for rule\nactions and default web ACL actions that are set to the block action.\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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponse.html", "Properties": { "ResponseCode": { "MarkdownDocumentation": "`ResponseCode`\n\nThe 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)\nin the *AWS WAF Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponse.html#cfn-wafv2-webacl-customresponse-responsecode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "CustomResponseBodyKey": { "MarkdownDocumentation": "`CustomResponseBodyKey`\n\nReferences the response body that you want AWS WAF to return to the web request\nclient. You can define a custom response for a rule action or a default web ACL action that\nis set to block. To do this, you first define the response body key and value in the\n`CustomResponseBodies` setting for the [AWS::WAFv2::WebACL](./aws-resource-wafv2-webacl.html) or [AWS::WAFv2::RuleGroup](./aws-resource-wafv2-rulegroup.html) where you want to use it. Then, in the rule action or web ACL\ndefault action `BlockAction` setting, you reference the response body using this\nkey.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponse.html#cfn-wafv2-webacl-customresponse-customresponsebodykey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseHeaders": { "MarkdownDocumentation": "`ResponseHeaders`\n\nThe HTTP headers to use in the response. You can specify any header name except for `content-type`. 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)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: Array of [CustomHTTPHeader](./aws-properties-wafv2-webacl-customhttpheader.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponse.html#cfn-wafv2-webacl-customresponse-responseheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomHTTPHeader", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.CustomResponseBody": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.CustomResponseBody`\n\nThe response body to use in a custom response to a web request. This is referenced by\nkey from [CustomResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html#cfn-wafv2-webacl-blockaction-customresponse)`CustomResponseBodyKey`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponsebody.html", "Properties": { "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe type of content in the payload that you are defining in the `Content`\nstring.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEXT_PLAIN | TEXT_HTML | AP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TEXT_PLAIN", "TEXT_HTML", "APPLICATION_JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponsebody.html#cfn-wafv2-webacl-customresponsebody-contenttype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe payload of the custom response.\nYou can use JSON escape strings in JSON content. To do this, you must specify JSON\ncontent 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)\nin the *AWS WAF Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponsebody.html#cfn-wafv2-webacl-customresponsebody-content", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.DataProtect": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.DataProtect`\n\nThe `DataProtect` property type specifies Property description not available. for an [AWS::WAFv2::WebACL](./aws-resource-wafv2-webacl.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-dataprotect.html", "Properties": { "Field": { "MarkdownDocumentation": "`Field`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [FieldToProtect](./aws-properties-wafv2-webacl-fieldtoprotect.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-dataprotect.html#cfn-wafv2-webacl-dataprotect-field", "UpdateType": "Mutable", "Required": true, "Type": "FieldToProtect" }, "Action": { "MarkdownDocumentation": "`Action`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SUBSTITUTION | HASH...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUBSTITUTION", "HASH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-dataprotect.html#cfn-wafv2-webacl-dataprotect-action", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExcludeRateBasedDetails": { "MarkdownDocumentation": "`ExcludeRateBasedDetails`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-dataprotect.html#cfn-wafv2-webacl-dataprotect-excluderatebaseddetails", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExcludeRuleMatchDetails": { "MarkdownDocumentation": "`ExcludeRuleMatchDetails`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-dataprotect.html#cfn-wafv2-webacl-dataprotect-excluderulematchdetails", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::WAFv2::WebACL.DataProtectionConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.DataProtectionConfig`\n\nSpecifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.\nThe data protection that you configure for the web ACL alters the data that's available for any other data collection activity,\nincluding your AWS WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.\nThis is part of the data protection configuration for a web ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-dataprotectionconfig.html", "Properties": { "DataProtections": { "MarkdownDocumentation": "`DataProtections`\n\nAn array of data protection configurations for specific web request field types. This is defined for each\nweb ACL. AWS WAF applies the specified protection to all web requests that the web ACL inspects.\n*Required*: Yes\n*Type*: Array of [DataProtect](./aws-properties-wafv2-webacl-dataprotect.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-dataprotectionconfig.html#cfn-wafv2-webacl-dataprotectionconfig-dataprotections", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataProtect", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.DefaultAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.DefaultAction`\n\nIn a [AWS::WAFv2::WebACL](./aws-resource-wafv2-webacl.html), this is the action that you want AWS WAF to perform\nwhen a web request doesn't match any of the rules in the `WebACL`. The default\naction must be a terminating action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html", "Properties": { "Block": { "MarkdownDocumentation": "`Block`\n\nSpecifies that AWS WAF should block requests by default.\n*Required*: No\n*Type*: [BlockAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html#cfn-wafv2-webacl-defaultaction-block", "UpdateType": "Mutable", "Required": false, "Type": "BlockAction" }, "Allow": { "MarkdownDocumentation": "`Allow`\n\nSpecifies that AWS WAF should allow requests by default.\n*Required*: No\n*Type*: [AllowAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html#cfn-wafv2-webacl-defaultaction-allow", "UpdateType": "Mutable", "Required": false, "Type": "AllowAction" } } }, "AWS::WAFv2::WebACL.ExcludedRule": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ExcludedRule`\n\nSpecifies a single rule in a rule group whose action you want to override to `Count`.\n###### Note\nInstead of this option, use `RuleActionOverrides`. It accepts any valid action setting, including `Count`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule whose action you want to override to `Count`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html#cfn-wafv2-webacl-excludedrule-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.FieldIdentifier": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.FieldIdentifier`\n\nThe identifier of a field in the web request payload that contains customer data.\nThis data type is used to specify fields in the `RequestInspection` and\n`RequestInspectionACFP` configurations, which are used in the managed rule\ngroup configurations `AWSManagedRulesATPRuleSet` and\n`AWSManagedRulesACFPRuleSet`, respectively.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html", "Properties": { "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nThe name of the field.\nWhen the `PayloadType` in the request inspection is `JSON`, this\nidentifier must be in JSON pointer syntax. For example `/form/username`. For\ninformation about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF)\ndocumentation [JavaScript Object Notation\n(JSON) Pointer](https://tools.ietf.org/html/rfc6901).\nWhen the `PayloadType` is `FORM_ENCODED`, use the HTML form names.\nFor example, `username`.\nFor more information, see the descriptions for each field type in the request inspection\nproperties.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html#cfn-wafv2-webacl-fieldidentifier-identifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.FieldToMatch": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.FieldToMatch`\n\nSpecifies a web request component to be used in a rule match statement or in a logging configuration.\n* In a rule statement, this is the part of the web request that you want AWS WAF to inspect. Include the single\n `FieldToMatch` type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n `FieldToMatch` for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.\n \n Example JSON for a `QueryString` field to match:\n \n `\"FieldToMatch\": { \"QueryString\": {} }`\n \n Example JSON for a `Method` field to match specification:\n \n `\"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }`\n* In a logging configuration, this is used in the `RedactedFields` property to specify a field to\n redact from the logging records. For this use case, note the following:\n \n + Even though all `FieldToMatch` settings\n are available, the only valid settings for field redaction are `UriPath`, `QueryString`, `SingleHeader`, and `Method`.\n + In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect,\n but for field redaction, you are specifying the component type to redact from the logs.\n + If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling.\n You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration\n or by configuring data protection for the web ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html", "Properties": { "AllQueryArguments": { "MarkdownDocumentation": "`AllQueryArguments`\n\nInspect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-allqueryarguments", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "JA3Fingerprint": { "MarkdownDocumentation": "`JA3Fingerprint`\n\nAvailable for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each\nrequest that has enough TLS Client Hello information for the calculation. Almost\nall web requests include this information.\n###### Note\nYou can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to\n`EXACTLY`.\nYou can obtain the JA3 fingerprint for client requests from the web ACL logs.\nIf AWS WAF is able to calculate the fingerprint, it includes it in the logs.\nFor information about the logging fields,\nsee [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide*.\nProvide the JA3 fingerprint string from the logs in your string match statement\nspecification, to match with any future requests that have the same TLS configuration.\n*Required*: No\n*Type*: [JA3Fingerprint](./aws-properties-wafv2-webacl-ja3fingerprint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-ja3fingerprint", "UpdateType": "Mutable", "Required": false, "Type": "JA3Fingerprint" }, "SingleQueryArgument": { "MarkdownDocumentation": "`SingleQueryArgument`\n\nInspect a single query argument. Provide the name of the query argument to inspect, such\nas *UserName* or *SalesRegion*. The name can be up to\n30 characters long and isn't case sensitive.\nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }`\n*Required*: No\n*Type*: [SingleQueryArgument](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-singlequeryargument", "UpdateType": "Mutable", "Required": false, "Type": "SingleQueryArgument" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nInspect the query string. This is the part of a URL that appears after a `?`\ncharacter, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-querystring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Headers": { "MarkdownDocumentation": "`Headers`\n\nInspect the request headers. You must configure scope and pattern matching filters in\nthe `Headers` object, to define the set of headers to and the parts of the\nheaders that AWS WAF inspects.\nOnly the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers\nare forwarded to AWS WAF for inspection by the underlying host service. You must\nconfigure how to handle any oversize header content in the `Headers` object.\nAWS WAF applies the pattern matching filters to the headers that it receives from the\nunderlying host service.\n*Required*: No\n*Type*: [Headers](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-headers", "UpdateType": "Mutable", "Required": false, "Type": "Headers" }, "Method": { "MarkdownDocumentation": "`Method`\n\nInspect the HTTP method. The method indicates the type of operation that the request is\nasking 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-method", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "UriFragment": { "MarkdownDocumentation": "`UriFragment`\n\nInspect fragments of the request URI. You must configure scope and pattern matching filters in\nthe `UriFragment` object, to define the fragment of a URI that AWS WAF inspects.\nOnly the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments\nare forwarded to AWS WAF for inspection by the underlying host service. You must\nconfigure how to handle any oversize URI fragment content in the `UriFragment` object.\nAWS WAF applies the pattern matching filters to the cookies that it receives from the\nunderlying host service.\n*Required*: No\n*Type*: [UriFragment](./aws-properties-wafv2-webacl-urifragment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-urifragment", "UpdateType": "Mutable", "Required": false, "Type": "UriFragment" }, "JsonBody": { "MarkdownDocumentation": "`JsonBody`\n\nInspect the request body as JSON. The request body immediately follows the request\nheaders. This is the part of a request that contains any additional data that you want to\nsend to your web server as the HTTP request body, such as data from a form.\nAWS WAF does not support inspecting the entire contents of the web request body if the body\nexceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service\nonly forwards the contents that are within the limit to AWS WAF for inspection.\n* For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n* For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and\n you can increase the limit for each resource type in the web ACL `AssociationConfig`, for additional processing fees.\n* For AWS Amplify, use the CloudFront limit.\nFor information about how to handle oversized\nrequest bodies, see the `JsonBody` object configuration.\n*Required*: No\n*Type*: [JsonBody](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-jsonbody", "UpdateType": "Mutable", "Required": false, "Type": "JsonBody" }, "UriPath": { "MarkdownDocumentation": "`UriPath`\n\nInspect the request URI path. This is the part of the web request that identifies a\nresource, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-uripath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Cookies": { "MarkdownDocumentation": "`Cookies`\n\nInspect the request cookies. You must configure scope and pattern matching filters in\nthe `Cookies` object, to define the set of cookies and the parts of the cookies\nthat AWS WAF inspects.\nOnly the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies\nare forwarded to AWS WAF for inspection by the underlying host service. You must\nconfigure how to handle any oversize cookie content in the `Cookies` object.\nAWS WAF applies the pattern matching filters to the cookies that it receives from the\nunderlying host service.\n*Required*: No\n*Type*: [Cookies](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-cookies", "UpdateType": "Mutable", "Required": false, "Type": "Cookies" }, "JA4Fingerprint": { "MarkdownDocumentation": "`JA4Fingerprint`\n\nAvailable for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each\nrequest that has enough TLS Client Hello information for the calculation. Almost\nall web requests include this information.\n###### Note\nYou can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to\n`EXACTLY`.\nYou can obtain the JA4 fingerprint for client requests from the web ACL logs.\nIf AWS WAF is able to calculate the fingerprint, it includes it in the logs.\nFor information about the logging fields,\nsee [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide*.\nProvide the JA4 fingerprint string from the logs in your string match statement\nspecification, to match with any future requests that have the same TLS configuration.\n*Required*: No\n*Type*: [JA4Fingerprint](./aws-properties-wafv2-webacl-ja4fingerprint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-ja4fingerprint", "UpdateType": "Mutable", "Required": false, "Type": "JA4Fingerprint" }, "Body": { "MarkdownDocumentation": "`Body`\n\nInspect the request body as plain text. The request body immediately follows the request\nheaders. This is the part of a request that contains any additional data that you want to\nsend to your web server as the HTTP request body, such as data from a form.\nAWS WAF does not support inspecting the entire contents of the web request body if the body\nexceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service\nonly forwards the contents that are within the limit to AWS WAF for inspection.\n* For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n* For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and\n you can increase the limit for each resource type in the web ACL `AssociationConfig`, for additional processing fees.\n* For AWS Amplify, use the CloudFront limit.\nFor information about how to handle oversized\nrequest bodies, see the `Body` object configuration.\n*Required*: No\n*Type*: [Body](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-body", "UpdateType": "Mutable", "Required": false, "Type": "Body" }, "SingleHeader": { "MarkdownDocumentation": "`SingleHeader`\n\nInspect a single header. Provide the name of the header to inspect, for example,\n`User-Agent` or `Referer`. This setting isn't case\nsensitive.\nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }`\nAlternately, you can filter and inspect all headers with the `Headers``FieldToMatch` setting.\n*Required*: No\n*Type*: [SingleHeader](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html#cfn-wafv2-webacl-fieldtomatch-singleheader", "UpdateType": "Mutable", "Required": false, "Type": "SingleHeader" } } }, "AWS::WAFv2::WebACL.FieldToProtect": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.FieldToProtect`\n\nSpecifies a field type and keys to protect in stored web request data. This is part of the data protection configuration for a web ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtoprotect.html", "Properties": { "FieldKeys": { "MarkdownDocumentation": "`FieldKeys`\n\nSpecifies the keys to protect for the specified field type. If you don't specify any key, then all keys for the field type are protected.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtoprotect.html#cfn-wafv2-webacl-fieldtoprotect-fieldkeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "FieldType": { "MarkdownDocumentation": "`FieldType`\n\nSpecifies the web request component type to protect.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SINGLE_HEADER | SINGLE_COOK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_HEADER", "SINGLE_COOKIE", "SINGLE_QUERY_ARGUMENT", "QUERY_STRING", "BODY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtoprotect.html#cfn-wafv2-webacl-fieldtoprotect-fieldtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.ForwardedIPConfiguration": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ForwardedIPConfiguration`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.\nThis configuration is used for [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-geomatchstatement), [AsnMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-asnmatchstatement), and\n[RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ratebasedstatement). For [IPSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ipsetreferencestatement), use [IPSetForwardedIPConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html#cfn-wafv2-rulegroup-ipsetreferencestatement-ipsetforwardedipconfig) instead.\nAWS WAF only evaluates the first IP address found in the specified HTTP header.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if the request doesn't have a valid IP address in the specified position.\n###### Note\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html#cfn-wafv2-webacl-forwardedipconfiguration-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HeaderName": { "MarkdownDocumentation": "`HeaderName`\n\nThe 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`.\n###### Note\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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html#cfn-wafv2-webacl-forwardedipconfiguration-headername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.GeoMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.GeoMatchStatement`\n\nA 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.\nAWS 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html", "Properties": { "ForwardedIPConfig": { "MarkdownDocumentation": "`ForwardedIPConfig`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html#cfn-wafv2-webacl-geomatchstatement-forwardedipconfig", "UpdateType": "Mutable", "Required": false, "Type": "ForwardedIPConfiguration" }, "CountryCodes": { "MarkdownDocumentation": "`CountryCodes`\n\nAn array of two-character country codes that you want to match against, for example, `[ \"US\", \"CN\" ]`, from\nthe 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*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html#cfn-wafv2-webacl-geomatchstatement-countrycodes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.HeaderMatchPattern": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.HeaderMatchPattern`\n\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html", "Properties": { "All": { "MarkdownDocumentation": "`All`\n\nInspect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html#cfn-wafv2-webacl-headermatchpattern-all", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "IncludedHeaders": { "MarkdownDocumentation": "`IncludedHeaders`\n\nInspect only the headers that have a key that matches one of the strings specified here.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 199`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html#cfn-wafv2-webacl-headermatchpattern-includedheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExcludedHeaders": { "MarkdownDocumentation": "`ExcludedHeaders`\n\nInspect only the headers whose keys don't match any of the strings specified here.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `64 | 199`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html#cfn-wafv2-webacl-headermatchpattern-excludedheaders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.Headers": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.Headers`\n\nInspect all headers in the web request. You can specify the parts of the headers to\ninspect and you can narrow the set of headers to inspect by including or excluding specific\nkeys.\nThis is used to indicate the web request component to inspect, in the\n`FieldToMatch` specification.\nIf you want to inspect just the value of a single header, use the\n`SingleHeader``FieldToMatch` setting instead.\nExample JSON: `\"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n\"OversizeHandling\": \"MATCH\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headers.html", "Properties": { "MatchScope": { "MarkdownDocumentation": "`MatchScope`\n\nThe parts of the headers to match with the rule inspection criteria. If you specify\n`ALL`, AWS WAF inspects both keys and values.\n`All` does not require a match to be found in the keys\nand a match to be found in the values. It requires a match to be found in the keys\nor the values or both. To require a match in the keys and in the values, use a logical `AND` statement\nto combine two match rules, one that inspects the keys and another that inspects the 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)", "RefReturnValue": "", "AllowedValues": [ "ALL", "KEY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headers.html#cfn-wafv2-webacl-headers-matchscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchPattern": { "MarkdownDocumentation": "`MatchPattern`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headers.html#cfn-wafv2-webacl-headers-matchpattern", "UpdateType": "Mutable", "Required": true, "Type": "HeaderMatchPattern" }, "OversizeHandling": { "MarkdownDocumentation": "`OversizeHandling`\n\nWhat AWS WAF should do if the headers determined by your match scope are more numerous or larger than AWS WAF can inspect.\nAWS WAF does not support inspecting the entire contents of request headers\nwhen they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\nand at most 8 KB of header contents to AWS WAF.\nThe options for oversize handling are the following:\n* `CONTINUE` - Inspect the available headers normally, according to the rule inspection criteria.\n* `MATCH` - Treat the web request as matching the rule statement. AWS WAF\n applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n 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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headers.html#cfn-wafv2-webacl-headers-oversizehandling", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.IPSetForwardedIPConfiguration": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.IPSetForwardedIPConfiguration`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.\nThis configuration is used only for [IPSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ipsetreferencestatement). For [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-geomatchstatement) and [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ratebasedstatement), use [ForwardedIPConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-asnmatchstatement.html#cfn-wafv2-webacl-asnmatchstatement-forwardedipconfig) instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if the request doesn't have a valid IP address in the specified position.\n###### Note\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html#cfn-wafv2-webacl-ipsetforwardedipconfiguration-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HeaderName": { "MarkdownDocumentation": "`HeaderName`\n\nThe 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`.\n###### Note\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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html#cfn-wafv2-webacl-ipsetforwardedipconfiguration-headername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nThe position in the header to search for the IP address. The header can contain IP\naddresses of the original client and also of proxies. For example, the header value could\nbe `10.1.1.1, 127.0.0.0, 10.10.10.10` where the first IP address identifies the\noriginal 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\n header. This is usually the client's original IP.\n* LAST - Inspect the last IP address in the list of IP addresses in the\n header.\n* ANY - Inspect all IP addresses in the header for a match. If the header\n contains more than 10 IP addresses, AWS WAF inspects the last 10.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FIRST | LAST | ANY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIRST", "LAST", "ANY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html#cfn-wafv2-webacl-ipsetforwardedipconfiguration-position", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.IPSetReferenceStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.IPSetReferenceStatement`\n\nA rule statement used to detect web requests coming from particular IP addresses or\naddress ranges. To use this, create an [AWS::WAFv2::IPSet](./aws-resource-wafv2-ipset.html) that specifies the addresses\nyou 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\nindependent of your rules. This allows you to use the single set in multiple rules. When\nyou update the referenced set, AWS WAF automatically updates all rules that\nreference it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html", "Properties": { "IPSetForwardedIPConfig": { "MarkdownDocumentation": "`IPSetForwardedIPConfig`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html#cfn-wafv2-webacl-ipsetreferencestatement-ipsetforwardedipconfig", "UpdateType": "Mutable", "Required": false, "Type": "IPSetForwardedIPConfiguration" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the [AWS::WAFv2::IPSet](./aws-resource-wafv2-ipset.html) that this statement\nreferences.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html#cfn-wafv2-webacl-ipsetreferencestatement-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.ImmunityTimeProperty": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ImmunityTimeProperty`\n\nUsed for CAPTCHA and challenge token settings. Determines\nhow long a `CAPTCHA` or challenge timestamp remains valid after AWS WAF updates it for a successful `CAPTCHA` or challenge response.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html", "Properties": { "ImmunityTime": { "MarkdownDocumentation": "`ImmunityTime`\n\nThe amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF. The default\nsetting is 300.\nFor the Challenge action, the minimum setting is 300.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `259200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html#cfn-wafv2-webacl-immunitytimeproperty-immunitytime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::WAFv2::WebACL.JA3Fingerprint": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.JA3Fingerprint`\n\nAvailable for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each\nrequest that has enough TLS Client Hello information for the calculation. Almost\nall web requests include this information.\n###### Note\nYou can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to\n`EXACTLY`.\nYou can obtain the JA3 fingerprint for client requests from the web ACL logs.\nIf AWS WAF is able to calculate the fingerprint, it includes it in the logs.\nFor information about the logging fields,\nsee [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide*.\nProvide the JA3 fingerprint string from the logs in your string match statement\nspecification, to match with any future requests that have the same TLS configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ja3fingerprint.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if the request doesn't have a JA3 fingerprint.\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ja3fingerprint.html#cfn-wafv2-webacl-ja3fingerprint-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.JA4Fingerprint": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.JA4Fingerprint`\n\nAvailable for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each\nrequest that has enough TLS Client Hello information for the calculation. Almost\nall web requests include this information.\n###### Note\nYou can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to\n`EXACTLY`.\nYou can obtain the JA4 fingerprint for client requests from the web ACL logs.\nIf AWS WAF is able to calculate the fingerprint, it includes it in the logs.\nFor information about the logging fields,\nsee [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide*.\nProvide the JA4 fingerprint string from the logs in your string match statement\nspecification, to match with any future requests that have the same TLS configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ja4fingerprint.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if the request doesn't have a JA4 fingerprint.\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ja4fingerprint.html#cfn-wafv2-webacl-ja4fingerprint-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.JsonBody": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.JsonBody`\n\nInspect the body of the web request as JSON. The body immediately follows the request\nheaders.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\nUse the specifications in this object to indicate which parts of the JSON body to\ninspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON\nthat result from the matches that you indicate.\nExample JSON: `\"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n}`\nFor additional information about this request component option, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html", "Properties": { "MatchScope": { "MarkdownDocumentation": "`MatchScope`\n\nThe parts of the JSON to match against using the `MatchPattern`. If you\nspecify `ALL`, AWS WAF matches against keys and values.\n`All` does not require a match to be found in the keys\nand a match to be found in the values. It requires a match to be found in the keys\nor the values or both. To require a match in the keys and in the values, use a logical `AND` statement\nto combine two match rules, one that inspects the keys and another that inspects the 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)", "RefReturnValue": "", "AllowedValues": [ "ALL", "KEY", "VALUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html#cfn-wafv2-webacl-jsonbody-matchscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MatchPattern": { "MarkdownDocumentation": "`MatchPattern`\n\nThe patterns to look for in the JSON body. AWS WAF inspects the results of these\npattern matches against the rule inspection criteria.\n*Required*: Yes\n*Type*: [JsonMatchPattern](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html#cfn-wafv2-webacl-jsonbody-matchpattern", "UpdateType": "Mutable", "Required": true, "Type": "JsonMatchPattern" }, "InvalidFallbackBehavior": { "MarkdownDocumentation": "`InvalidFallbackBehavior`\n\nWhat AWS WAF should do if it fails to completely parse the JSON body. The options are\nthe following:\n* `EVALUATE_AS_STRING` - Inspect the body as plain text. AWS WAF\n applies the text transformations and inspection criteria that you defined for the\n JSON inspection to the body text string.\n* `MATCH` - Treat the web request as matching the rule statement.\n AWS WAF applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n statement.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the\nfirst parsing failure that it encounters.\n###### Note\nAWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When\nparsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information,\nsee [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `MATCH | NO_MATCH | EVALUATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH", "EVALUATE_AS_STRING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html#cfn-wafv2-webacl-jsonbody-invalidfallbackbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OversizeHandling": { "MarkdownDocumentation": "`OversizeHandling`\n\nWhat AWS WAF should do if the body is larger than AWS WAF can inspect.\nAWS WAF does not support inspecting the entire contents of the web request body if the body\nexceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service\nonly forwards the contents that are within the limit to AWS WAF for inspection.\n* For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n* For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and\n you can increase the limit for each resource type in the web ACL `AssociationConfig`, for additional processing fees.\n* For AWS Amplify, use the CloudFront limit.\nThe options for oversize handling are the following:\n* `CONTINUE` - Inspect the available body contents normally, according to the rule inspection criteria.\n* `MATCH` - Treat the web request as matching the rule statement. AWS WAF\n applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n statement.\nYou can combine the `MATCH` or `NO_MATCH`\nsettings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.\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)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE", "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html#cfn-wafv2-webacl-jsonbody-oversizehandling", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.JsonMatchPattern": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.JsonMatchPattern`\n\nThe patterns to look for in the JSON body. AWS WAF inspects the results of these\npattern matches against the rule inspection criteria. This is used with the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) option `JsonBody`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonmatchpattern.html", "Properties": { "All": { "MarkdownDocumentation": "`All`\n\nMatch all of the elements. See also `MatchScope` in the `JsonBody``FieldToMatch` specification.\nYou must specify either this setting or the `IncludedPaths` setting, but not\nboth.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonmatchpattern.html#cfn-wafv2-webacl-jsonmatchpattern-all", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "IncludedPaths": { "MarkdownDocumentation": "`IncludedPaths`\n\nMatch only the specified include paths. See also `MatchScope` in the\n`JsonBody``FieldToMatch` specification.\nProvide the include paths using JSON Pointer syntax. For example, `\"IncludedPaths\":\n[\"/dogs/0/name\", \"/dogs/1/name\"]`. For information about this syntax, see the\nInternet Engineering Task Force (IETF) documentation [JavaScript Object Notation (JSON)\nPointer](https://tools.ietf.org/html/rfc6901).\nYou must specify either this setting or the `All` setting, but not\nboth.\n###### Note\nDon't use this option to include all paths. Instead, use the `All`\nsetting.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonmatchpattern.html#cfn-wafv2-webacl-jsonmatchpattern-includedpaths", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.Label": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.Label`\n\nA single label container. This is used as an element of a label array in\n`RuleLabels` inside a rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-label.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe label string.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_:-]{1,1024}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-label.html#cfn-wafv2-webacl-label-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.LabelMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.LabelMatchStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html", "Properties": { "Scope": { "MarkdownDocumentation": "`Scope`\n\nSpecify 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)", "RefReturnValue": "", "AllowedValues": [ "LABEL", "NAMESPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html#cfn-wafv2-webacl-labelmatchstatement-scope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe string to match against. The setting you provide for this depends on the match\nstatement's `Scope` setting:\n* If the `Scope` indicates `LABEL`, then this specification\n must include the name and can include any number of preceding namespace\n specifications and prefix up to providing the fully qualified label name.\n* If the `Scope` indicates `NAMESPACE`, then this\n specification can include any number of contiguous namespace strings, and can include\n the entire label namespace prefix from the rule group or web ACL where the label\n originates.\nLabels are case sensitive and components of a label must be separated by colon, for\nexample `NS1:NS2:name`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_:-]{1,1024}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html#cfn-wafv2-webacl-labelmatchstatement-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.ManagedRuleGroupConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ManagedRuleGroupConfig`\n\nAdditional information that's used by a managed rule group. Many managed rule groups\ndon't require this.\nThe rule groups used for intelligent threat mitigation require additional configuration:\n* Use the `AWSManagedRulesACFPRuleSet` configuration object to configure\n the account creation fraud prevention managed rule group. The configuration includes\n the registration and sign-up pages of your application and the locations in the\n account creation request payload of data, such as the user email and phone number\n fields.\n* Use the `AWSManagedRulesATPRuleSet` configuration object to configure\n the account takeover prevention managed rule group. The configuration includes the\n sign-in page of your application and the locations in the login request payload of\n data such as the username and password.\n* Use the `AWSManagedRulesBotControlRuleSet` configuration object to\n configure the protection level that you want the Bot Control rule group to use.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html", "Properties": { "AWSManagedRulesAntiDDoSRuleSet": { "MarkdownDocumentation": "`AWSManagedRulesAntiDDoSRuleSet`\n\nAdditional configuration for using the anti-DDoS managed rule group, `AWSManagedRulesAntiDDoSRuleSet`.\nUse this to configure anti-DDoS behavior for the rule group.\nFor information\nabout using the anti-DDoS managed rule group, see [AWS WAF Anti-DDoS rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-anti-ddos.html)\nand [Distributed Denial of Service (DDoS) prevention](https://docs.aws.amazon.com/waf/latest/developerguide/waf-anti-ddos.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [AWSManagedRulesAntiDDoSRuleSet](./aws-properties-wafv2-webacl-awsmanagedrulesantiddosruleset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html#cfn-wafv2-webacl-managedrulegroupconfig-awsmanagedrulesantiddosruleset", "UpdateType": "Mutable", "Required": false, "Type": "AWSManagedRulesAntiDDoSRuleSet" }, "UsernameField": { "MarkdownDocumentation": "`UsernameField`\n\n###### Note\nInstead of this setting, provide your configuration under the request inspection configuration for `AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`.\n*Required*: No\n*Type*: [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html#cfn-wafv2-webacl-managedrulegroupconfig-usernamefield", "UpdateType": "Mutable", "Required": false, "Type": "FieldIdentifier" }, "LoginPath": { "MarkdownDocumentation": "`LoginPath`\n\n###### Note\nInstead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet`.\n*Required*: No\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html#cfn-wafv2-webacl-managedrulegroupconfig-loginpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AWSManagedRulesATPRuleSet": { "MarkdownDocumentation": "`AWSManagedRulesATPRuleSet`\n\nAdditional configuration for using the account takeover prevention (ATP) managed rule group, `AWSManagedRulesATPRuleSet`.\nUse this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\nthe information about how your distribution responds to login requests.\nThis configuration replaces the individual configuration fields in `ManagedRuleGroupConfig` and provides additional feature configuration.\nFor information\nabout using the ATP managed rule group, see [AWS WAF Fraud Control account takeover prevention (ATP) rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-atp.html)\nand [AWS WAF Fraud Control account takeover prevention (ATP)](https://docs.aws.amazon.com/waf/latest/developerguide/waf-atp.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [AWSManagedRulesATPRuleSet](./aws-properties-wafv2-webacl-awsmanagedrulesatpruleset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html#cfn-wafv2-webacl-managedrulegroupconfig-awsmanagedrulesatpruleset", "UpdateType": "Mutable", "Required": false, "Type": "AWSManagedRulesATPRuleSet" }, "AWSManagedRulesBotControlRuleSet": { "MarkdownDocumentation": "`AWSManagedRulesBotControlRuleSet`\n\nAdditional configuration for using the Bot Control managed rule group. Use this to specify the\ninspection level that you want to use. For information\nabout 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)\nand [AWS WAF Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [AWSManagedRulesBotControlRuleSet](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html#cfn-wafv2-webacl-managedrulegroupconfig-awsmanagedrulesbotcontrolruleset", "UpdateType": "Mutable", "Required": false, "Type": "AWSManagedRulesBotControlRuleSet" }, "PasswordField": { "MarkdownDocumentation": "`PasswordField`\n\n###### Note\nInstead of this setting, provide your configuration under the request inspection configuration for `AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`.\n*Required*: No\n*Type*: [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html#cfn-wafv2-webacl-managedrulegroupconfig-passwordfield", "UpdateType": "Mutable", "Required": false, "Type": "FieldIdentifier" }, "AWSManagedRulesACFPRuleSet": { "MarkdownDocumentation": "`AWSManagedRulesACFPRuleSet`\n\nAdditional configuration for using the account creation fraud prevention (ACFP) managed rule group, `AWSManagedRulesACFPRuleSet`.\nUse this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\nthe information about how your distribution responds to account creation requests.\nFor information\nabout using the ACFP managed rule group, see [AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-acfp.html)\nand [AWS WAF Fraud Control account creation fraud prevention (ACFP)](https://docs.aws.amazon.com/waf/latest/developerguide/waf-acfp.html)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [AWSManagedRulesACFPRuleSet](./aws-properties-wafv2-webacl-awsmanagedrulesacfpruleset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html#cfn-wafv2-webacl-managedrulegroupconfig-awsmanagedrulesacfpruleset", "UpdateType": "Mutable", "Required": false, "Type": "AWSManagedRulesACFPRuleSet" }, "PayloadType": { "MarkdownDocumentation": "`PayloadType`\n\n###### Note\nInstead of this setting, provide your configuration under the request inspection configuration for `AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`.\n*Required*: No\n*Type*: String\n*Allowed values*: `JSON | FORM_ENCODED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JSON", "FORM_ENCODED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html#cfn-wafv2-webacl-managedrulegroupconfig-payloadtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.ManagedRuleGroupStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ManagedRuleGroupStatement`\n\nA rule statement used to run the rules that are defined in a managed rule group. To use\nthis, provide the vendor name and the name of the rule group in this statement. You can\nretrieve the required names through the API call\n`ListAvailableManagedRuleGroups`.\nYou cannot nest a `ManagedRuleGroupStatement`, for example for use inside a\n`NotStatement` or `OrStatement`. You cannot use a managed rule\ngroup statement inside another rule group. You can only use a managed rule group statement\nas a top-level statement in a rule that you define in a web ACL.\n###### Note\nYou are charged additional fees when you use the AWS WAF Bot Control\nmanaged rule group `AWSManagedRulesBotControlRuleSet`, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group\n`AWSManagedRulesATPRuleSet`, or the AWS WAF Fraud Control\naccount creation fraud prevention (ACFP) managed rule group\n`AWSManagedRulesACFPRuleSet`. For more information, see [AWS WAF Pricing](https://aws.amazon.com/waf/pricing/).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html", "Properties": { "VendorName": { "MarkdownDocumentation": "`VendorName`\n\nThe name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-vendorname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of the managed rule group to use. If you specify this, the version setting\nis fixed until you change it. If you don't specify this, AWS WAF uses the vendor's\ndefault version, and then keeps the version at the vendor's default when the vendor updates\nthe managed rule group settings.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w#:\\.\\-/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleActionOverrides": { "MarkdownDocumentation": "`RuleActionOverrides`\n\nAction 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.\n###### Note\nVerify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.\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*: Array of [RuleActionOverride](./aws-properties-wafv2-webacl-ruleactionoverride.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-ruleactionoverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RuleActionOverride", "DuplicatesAllowed": true }, "ManagedRuleGroupConfigs": { "MarkdownDocumentation": "`ManagedRuleGroupConfigs`\n\nAdditional information that's used by a managed rule group. Many managed rule groups don't require this.\nThe rule groups used for intelligent threat mitigation require additional configuration:\n* Use the `AWSManagedRulesACFPRuleSet` configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.\n* Use the `AWSManagedRulesAntiDDoSRuleSet` configuration object to configure the anti-DDoS managed rule group. The configuration includes the sensitivity levels to use in the rules that typically block and challenge requests that might be participating in DDoS attacks and the specification to use to indicate whether a request can handle a silent browser challenge.\n* Use the `AWSManagedRulesATPRuleSet` configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.\n* Use the `AWSManagedRulesBotControlRuleSet` configuration object to configure the\n protection level that you want the Bot Control rule group to use.\n*Required*: No\n*Type*: Array of [ManagedRuleGroupConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-managedrulegroupconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ManagedRuleGroupConfig", "DuplicatesAllowed": true }, "ExcludedRules": { "MarkdownDocumentation": "`ExcludedRules`\n\nRules in the referenced rule group whose actions are set to `Count`.\n###### Note\nInstead of this option, use `RuleActionOverrides`. It accepts any valid action setting, including `Count`.\n*Required*: No\n*Type*: Array of [ExcludedRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-excludedrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ExcludedRule", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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*Pattern*: `^[0-9A-Za-z_-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ScopeDownStatement": { "MarkdownDocumentation": "`ScopeDownStatement`\n\nAn optional nested statement that narrows the scope of the web requests that are\nevaluated by the managed rule group. Requests are only evaluated by the rule group if they\nmatch 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\nscope-down statement, and you can nest statements at any level, the same as you can for a\nrule statement.\n*Required*: No\n*Type*: [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-scopedownstatement", "UpdateType": "Mutable", "Required": false, "Type": "Statement" } } }, "AWS::WAFv2::WebACL.NotStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.NotStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html", "Properties": { "Statement": { "MarkdownDocumentation": "`Statement`\n\nThe statement to negate. You can use any statement that can be nested.\n*Required*: Yes\n*Type*: [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement", "UpdateType": "Mutable", "Required": true, "Type": "Statement" } } }, "AWS::WAFv2::WebACL.OnSourceDDoSProtectionConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.OnSourceDDoSProtectionConfig`\n\nConfigures the level of DDoS protection that applies to web ACLs associated with Application Load Balancers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-onsourceddosprotectionconfig.html", "Properties": { "ALBLowReputationMode": { "MarkdownDocumentation": "`ALBLowReputationMode`\n\nThe level of DDoS protection that applies to web ACLs associated with Application Load Balancers. `ACTIVE_UNDER_DDOS` protection is enabled by default whenever a web ACL is associated with an Application Load Balancer.\nIn the event that an Application Load Balancer experiences high-load conditions or suspected DDoS attacks, the `ACTIVE_UNDER_DDOS` protection automatically rate limits traffic from known low reputation sources without disrupting Application Load Balancer availability.\n`ALWAYS_ON` protection provides constant, always-on monitoring of known low reputation sources for suspected DDoS attacks. While this provides a higher level of protection, there may be potential impacts on legitimate traffic.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ACTIVE_UNDER_DDOS | ALWAYS_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACTIVE_UNDER_DDOS", "ALWAYS_ON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-onsourceddosprotectionconfig.html#cfn-wafv2-webacl-onsourceddosprotectionconfig-alblowreputationmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.OrStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.OrStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatement.html", "Properties": { "Statements": { "MarkdownDocumentation": "`Statements`\n\nThe statements to combine with OR logic. You can use any statements that can be\nnested.\n*Required*: Yes\n*Type*: Array of [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatement.html#cfn-wafv2-webacl-orstatement-statements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Statement", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.OverrideAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.OverrideAction`\n\nThe action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.\nYou can only use this for rule statements that reference a rule group, like `RuleGroupReferenceStatement` and `ManagedRuleGroupStatement`.\n###### Note\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\nmatches, do not use this and instead use the rule action override option, with `Count` action, in your rule group reference statement settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html", "Properties": { "Count": { "MarkdownDocumentation": "`Count`\n\nOverride the rule group evaluation result to count only.\n###### Note\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\nmatches, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html#cfn-wafv2-webacl-overrideaction-count", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "None": { "MarkdownDocumentation": "`None`\n\nDon'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html#cfn-wafv2-webacl-overrideaction-none", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::WAFv2::WebACL.RateBasedStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateBasedStatement`\n\nA rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.\n###### Note\nIf you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.\nYou can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.\nEach unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.\nFor example, assume the rule evaluates web requests with the following IP address and HTTP method values:\n* IP address 10.1.1.1, HTTP method POST\n* IP address 10.1.1.1, HTTP method GET\n* IP address 127.0.0.0, HTTP method POST\n* IP address 10.1.1.1, HTTP method GET\nThe rule would create different aggregation instances according to your aggregation criteria, for example:\n* If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:\n \n + IP address 10.1.1.1: count 3\n + IP address 127.0.0.0: count 1\n* If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:\n \n + HTTP method POST: count 2\n + HTTP method GET: count 2\n* If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:\n \n + IP address 10.1.1.1, HTTP method POST: count 1\n + IP address 10.1.1.1, HTTP method GET: count 2\n + IP address 127.0.0.0, HTTP method POST: count 1\nFor any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the 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.\nFor additional information about the options, see [Rate limiting web requests using rate-based rules](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html)\nin the *AWS WAF Developer Guide*.\nIf you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF\nis currently rate limiting for a rule through the API call `GetRateBasedStatementManagedKeys`. This option is not available\nfor other aggregation configurations.\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html", "Properties": { "AggregateKeyType": { "MarkdownDocumentation": "`AggregateKeyType`\n\nSetting that indicates how to aggregate the request counts.\n###### Note\nWeb requests that are missing any of the components specified in the aggregation keys\nare omitted from the rate-based rule evaluation and handling.\n\n* `CONSTANT` - Count and limit the requests that match the rate-based rule's scope-down\n statement. With this option, the counted requests aren't further aggregated. The scope-down statement\n is the only specification used. When the count of all requests that satisfy the scope-down statement\n goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.\n \n With this option, you must configure the `ScopeDownStatement` property.\n* `CUSTOM_KEYS` - Aggregate the request counts using one or more web request components as the aggregate keys.\n \n With this option, you must specify the aggregate keys in the `CustomKeys` property.\n \n To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate\n key type to `IP` or `FORWARDED_IP`.\n* `FORWARDED_IP` - Aggregate the request counts on the first IP address in an HTTP header.\n \n With this option, you must specify the header to use in the `ForwardedIPConfig` property.\n \n To aggregate on a combination of the forwarded IP address with other aggregate keys, use `CUSTOM_KEYS`.\n* `IP` - Aggregate the request counts on the IP address from the web request\n origin.\n \n To aggregate on a combination of the IP address with other aggregate keys, use `CUSTOM_KEYS`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CONSTANT | IP | FORWARDED_I...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONSTANT", "IP", "FORWARDED_IP", "CUSTOM_KEYS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html#cfn-wafv2-webacl-ratebasedstatement-aggregatekeytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CustomKeys": { "MarkdownDocumentation": "`CustomKeys`\n\nSpecifies the aggregate keys to use in a rate-base rule.\n*Required*: No\n*Type*: Array of [RateBasedStatementCustomKey](./aws-properties-wafv2-webacl-ratebasedstatementcustomkey.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html#cfn-wafv2-webacl-ratebasedstatement-customkeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RateBasedStatementCustomKey", "DuplicatesAllowed": true }, "ForwardedIPConfig": { "MarkdownDocumentation": "`ForwardedIPConfig`\n\nThe configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.\n###### Note\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 you specify a forwarded IP in the rule's aggregate key settings.\n*Required*: No\n*Type*: [ForwardedIPConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html#cfn-wafv2-webacl-ratebasedstatement-forwardedipconfig", "UpdateType": "Mutable", "Required": false, "Type": "ForwardedIPConfiguration" }, "Limit": { "MarkdownDocumentation": "`Limit`\n\nThe limit on requests during the specified evaluation window for a single aggregation instance for the rate-based rule.\nIf the rate-based statement includes a `ScopeDownStatement`, this limit is applied only to the\nrequests that match the statement.\nExamples:\n* If you aggregate on just the IP address, this is the limit on requests from any single IP address.\n* If you aggregate on the HTTP method and the query argument name \"city\", then this is the limit on\n requests for any single method, city pair.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `10`\n*Maximum*: `2000000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html#cfn-wafv2-webacl-ratebasedstatement-limit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "EvaluationWindowSec": { "MarkdownDocumentation": "`EvaluationWindowSec`\n\nThe amount of time, in seconds, that AWS WAF\nshould include in its request counts, looking back from the current time. For example,\nfor a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding\nthe current time. Valid settings are 60, 120, 300, and 600.\nThis setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each\ntime it checks. AWS WAF checks the rate about every 10 seconds.\nDefault: `300` (5 minutes)\n*Required*: No\n*Type*: Integer\n*Allowed values*: `60 | 120 | 300 | 600...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "60", "120", "300", "600" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html#cfn-wafv2-webacl-ratebasedstatement-evaluationwindowsec", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ScopeDownStatement": { "MarkdownDocumentation": "`ScopeDownStatement`\n\nAn optional nested statement that narrows the scope of the web requests that are\nevaluated and managed by the rate-based statement. When you use a scope-down statement,\nthe rate-based rule only tracks and rate limits\nrequests that 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\nlevel, the same as you can for a rule statement.\n*Required*: No\n*Type*: [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html#cfn-wafv2-webacl-ratebasedstatement-scopedownstatement", "UpdateType": "Mutable", "Required": false, "Type": "Statement" } } }, "AWS::WAFv2::WebACL.RateBasedStatementCustomKey": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateBasedStatementCustomKey`\n\nSpecifies a single custom aggregate key for a rate-base rule.\n###### Note\nWeb requests that are missing any of the components specified in the aggregation keys\nare omitted from the rate-based rule evaluation and handling.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html", "Properties": { "Cookie": { "MarkdownDocumentation": "`Cookie`\n\nUse the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\ncookie as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitCookie](./aws-properties-wafv2-webacl-ratelimitcookie.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-cookie", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitCookie" }, "ForwardedIP": { "MarkdownDocumentation": "`ForwardedIP`\n\nUse the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.\nWhen you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\nYou can aggregate on only the forwarded IP address by specifying `FORWARDED_IP` in your rate-based statement's `AggregateKeyType`.\nWith this option, you must specify the header to use in the rate-based rule's `ForwardedIPConfig` property.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-forwardedip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "QueryArgument": { "MarkdownDocumentation": "`QueryArgument`\n\nUse the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you\nuse a single query argument as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitQueryArgument](./aws-properties-wafv2-webacl-ratelimitqueryargument.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-queryargument", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitQueryArgument" }, "JA3Fingerprint": { "MarkdownDocumentation": "`JA3Fingerprint`\n\nUse the request's JA3 fingerprint as an aggregate key. If you use a single\nJA3 fingerprint as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitJA3Fingerprint](./aws-properties-wafv2-webacl-ratelimitja3fingerprint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-ja3fingerprint", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitJA3Fingerprint" }, "Header": { "MarkdownDocumentation": "`Header`\n\nUse the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single\nheader as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitHeader](./aws-properties-wafv2-webacl-ratelimitheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-header", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitHeader" }, "HTTPMethod": { "MarkdownDocumentation": "`HTTPMethod`\n\nUse the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\nas your custom key, then each method fully defines an aggregation instance.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-httpmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nUse the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the\nquery string as your custom key, then each string fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitQueryString](./aws-properties-wafv2-webacl-ratelimitquerystring.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-querystring", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitQueryString" }, "UriPath": { "MarkdownDocumentation": "`UriPath`\n\nUse the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the\nURI path as your custom key, then each URI path fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitUriPath](./aws-properties-wafv2-webacl-ratelimituripath.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-uripath", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitUriPath" }, "IP": { "MarkdownDocumentation": "`IP`\n\nUse the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.\nWhen you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\nYou can aggregate on only the IP address by specifying `IP` in your rate-based statement's `AggregateKeyType`.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-ip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "JA4Fingerprint": { "MarkdownDocumentation": "`JA4Fingerprint`\n\nUse the request's JA4 fingerprint as an aggregate key. If you use a single\nJA4 fingerprint as your custom key, then each value fully defines an aggregation instance.\n*Required*: No\n*Type*: [RateLimitJA4Fingerprint](./aws-properties-wafv2-webacl-ratelimitja4fingerprint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-ja4fingerprint", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitJA4Fingerprint" }, "ASN": { "MarkdownDocumentation": "`ASN`\n\nUse an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key.\nEach distinct ASN contributes to the aggregation instance.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-asn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LabelNamespace": { "MarkdownDocumentation": "`LabelNamespace`\n\nUse the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.\nThis uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.\nFor information about label namespaces and names, see\n[Label syntax and naming requirements](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) in the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: [RateLimitLabelNamespace](./aws-properties-wafv2-webacl-ratelimitlabelnamespace.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-labelnamespace", "UpdateType": "Mutable", "Required": false, "Type": "RateLimitLabelNamespace" } } }, "AWS::WAFv2::WebACL.RateLimitCookie": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateLimitCookie`\n\nSpecifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\ncookie as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitcookie.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitcookie.html#cfn-wafv2-webacl-ratelimitcookie-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the cookie to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitcookie.html#cfn-wafv2-webacl-ratelimitcookie-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RateLimitHeader": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateLimitHeader`\n\nSpecifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single\nheader as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitheader.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitheader.html#cfn-wafv2-webacl-ratelimitheader-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the header to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitheader.html#cfn-wafv2-webacl-ratelimitheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RateLimitJA3Fingerprint": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateLimitJA3Fingerprint`\n\nUse the request's JA3 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single\nJA3 fingerprint as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitja3fingerprint.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if there is insufficient TSL Client Hello information to compute the JA3 fingerprint.\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitja3fingerprint.html#cfn-wafv2-webacl-ratelimitja3fingerprint-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RateLimitJA4Fingerprint": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateLimitJA4Fingerprint`\n\nUse the request's JA4 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single\nJA4 fingerprint as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitja4fingerprint.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nThe match status to assign to the web request if there is insufficient TSL Client Hello information to compute the JA4 fingerprint.\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitja4fingerprint.html#cfn-wafv2-webacl-ratelimitja4fingerprint-fallbackbehavior", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RateLimitLabelNamespace": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateLimitLabelNamespace`\n\nSpecifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.\nThis uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.\nFor information about label namespaces and names, see\n[Label syntax and naming requirements](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) in the *AWS WAF Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitlabelnamespace.html", "Properties": { "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace to use for aggregation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_:-]{1,1024}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitlabelnamespace.html#cfn-wafv2-webacl-ratelimitlabelnamespace-namespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RateLimitQueryArgument": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateLimitQueryArgument`\n\nSpecifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you\nuse a single query argument as your custom key, then each value fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitqueryargument.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitqueryargument.html#cfn-wafv2-webacl-ratelimitqueryargument-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the query argument to use.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitqueryargument.html#cfn-wafv2-webacl-ratelimitqueryargument-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RateLimitQueryString": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateLimitQueryString`\n\nSpecifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the\nquery string as your custom key, then each string fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitquerystring.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimitquerystring.html#cfn-wafv2-webacl-ratelimitquerystring-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.RateLimitUriPath": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RateLimitUriPath`\n\nSpecifies the request's URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the\nURI path as your custom key, then each URI path fully defines an aggregation instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimituripath.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratelimituripath.html#cfn-wafv2-webacl-ratelimituripath-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.Regex": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.Regex`\n\nA single regular expression. This is used in a [AWS::WAFv2::RegexPatternSet](./aws-resource-wafv2-regexpatternset.html) and\nalso in the configuration for the AWS Managed Rules rule group `AWSManagedRulesAntiDDoSRuleSet`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regex.html", "Properties": { "RegexString": { "MarkdownDocumentation": "`RegexString`\n\nThe string representing the regular expression.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regex.html#cfn-wafv2-webacl-regex-regexstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RegexMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RegexMatchStatement`\n\nA rule statement used to search web request components for a match against a single regular expression.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexmatchstatement.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexmatchstatement.html#cfn-wafv2-webacl-regexmatchstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "RegexString": { "MarkdownDocumentation": "`RegexString`\n\nThe string representing the regular expression.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexmatchstatement.html#cfn-wafv2-webacl-regexmatchstatement-regexstring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexmatchstatement.html#cfn-wafv2-webacl-regexmatchstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement`\n\nA rule statement used to search web request components for matches with regular\nexpressions. To use this, create a [AWS::WAFv2::RegexPatternSet](./aws-resource-wafv2-regexpatternset.html) that specifies the\nexpressions that you want to detect, then use that set in this statement. A web request\nmatches the pattern set rule statement if the request component matches any of the patterns\nin the set.\nEach regex pattern set rule statement references a regex pattern set. You create and\nmaintain the set independent of your rules. This allows you to use the single set in\nmultiple rules. When you update the referenced set, AWS WAF automatically\nupdates all rules that reference it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the [AWS::WAFv2::RegexPatternSet](./aws-resource-wafv2-regexpatternset.html) that this\nstatement references.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html#cfn-wafv2-webacl-regexpatternsetreferencestatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::WebACL.RequestBodyAssociatedResourceTypeConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RequestBodyAssociatedResourceTypeConfig`\n\nCustomizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.\n###### Note\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [AWS WAF Pricing](https://aws.amazon.com/waf/pricing/).\nExample JSON: `{\n\"API_GATEWAY\": \"KB_48\",\n\"APP_RUNNER_SERVICE\": \"KB_32\"\n}`\nFor Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\nThis is used in the `AssociationConfig` of the web ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestbodyassociatedresourcetypeconfig.html", "Properties": { "DefaultSizeInspectionLimit": { "MarkdownDocumentation": "`DefaultSizeInspectionLimit`\n\nSpecifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.\nDefault: `16 KB (16,384 bytes)`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `KB_16 | KB_32 | KB_48 | KB_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "KB_16", "KB_32", "KB_48", "KB_64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestbodyassociatedresourcetypeconfig.html#cfn-wafv2-webacl-requestbodyassociatedresourcetypeconfig-defaultsizeinspectionlimit", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RequestInspection": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RequestInspection`\n\nThe criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.\nThis is part of the `AWSManagedRulesATPRuleSet` configuration in `ManagedRuleGroupConfig`.\nIn these settings, you specify how your application accepts login attempts\nby providing the request payload type and the names of the fields\nwithin the request body where the username and password are provided.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspection.html", "Properties": { "UsernameField": { "MarkdownDocumentation": "`UsernameField`\n\nThe name of the field in the request payload that contains your customer's username.\nHow you specify this depends on the request inspection payload type.\n* For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation [JavaScript\n Object Notation (JSON) Pointer](https://tools.ietf.org/html/rfc6901).\n \n For example, for the JSON payload `{ \"form\": { \"username\": \"THE_USERNAME\" } }`,\n the username field specification is `/form/username`.\n* For form encoded payload types, use the HTML form names.\n \n For example, for an HTML form with the input element\n named `username1`, the username field specification is\n `username1`\n*Required*: Yes\n*Type*: [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspection.html#cfn-wafv2-webacl-requestinspection-usernamefield", "UpdateType": "Mutable", "Required": true, "Type": "FieldIdentifier" }, "PasswordField": { "MarkdownDocumentation": "`PasswordField`\n\nThe name of the field in the request payload that contains your customer's password.\nHow you specify this depends on the request inspection payload type.\n* For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation [JavaScript\n Object Notation (JSON) Pointer](https://tools.ietf.org/html/rfc6901).\n \n For example, for the JSON payload `{ \"form\": { \"password\": \"THE_PASSWORD\" } }`,\n the password field specification is `/form/password`.\n* For form encoded payload types, use the HTML form names.\n \n For example, for an HTML form with the input element\n named `password1`, the password field specification is `password1`.\n*Required*: Yes\n*Type*: [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspection.html#cfn-wafv2-webacl-requestinspection-passwordfield", "UpdateType": "Mutable", "Required": true, "Type": "FieldIdentifier" }, "PayloadType": { "MarkdownDocumentation": "`PayloadType`\n\nThe payload type for your login endpoint, either JSON or form encoded.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `JSON | FORM_ENCODED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JSON", "FORM_ENCODED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspection.html#cfn-wafv2-webacl-requestinspection-payloadtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RequestInspectionACFP": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RequestInspectionACFP`\n\nThe criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.\nThis is part of the `AWSManagedRulesACFPRuleSet` configuration in `ManagedRuleGroupConfig`.\nIn these settings, you specify how your application accepts account creation attempts\nby providing the request payload type and the names of the fields\nwithin the request body where the username, password, email, and primary address and phone number fields are provided.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspectionacfp.html", "Properties": { "UsernameField": { "MarkdownDocumentation": "`UsernameField`\n\nThe name of the field in the request payload that contains your customer's username.\nHow you specify this depends on the request inspection payload type.\n* For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation [JavaScript\n Object Notation (JSON) Pointer](https://tools.ietf.org/html/rfc6901).\n \n For example, for the JSON payload `{ \"form\": { \"username\": \"THE_USERNAME\" } }`,\n the username field specification is `/form/username`.\n* For form encoded payload types, use the HTML form names.\n \n For example, for an HTML form with the input element\n named `username1`, the username field specification is\n `username1`\n*Required*: No\n*Type*: [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspectionacfp.html#cfn-wafv2-webacl-requestinspectionacfp-usernamefield", "UpdateType": "Mutable", "Required": false, "Type": "FieldIdentifier" }, "EmailField": { "MarkdownDocumentation": "`EmailField`\n\nThe name of the field in the request payload that contains your customer's email.\nHow you specify this depends on the request inspection payload type.\n* For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation [JavaScript\n Object Notation (JSON) Pointer](https://tools.ietf.org/html/rfc6901).\n \n For example, for the JSON payload `{ \"form\": { \"email\": \"THE_EMAIL\" } }`,\n the email field specification is `/form/email`.\n* For form encoded payload types, use the HTML form names.\n \n For example, for an HTML form with the input element\n named `email1`, the email field specification is `email1`.\n*Required*: No\n*Type*: [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspectionacfp.html#cfn-wafv2-webacl-requestinspectionacfp-emailfield", "UpdateType": "Mutable", "Required": false, "Type": "FieldIdentifier" }, "PasswordField": { "MarkdownDocumentation": "`PasswordField`\n\nThe name of the field in the request payload that contains your customer's password.\nHow you specify this depends on the request inspection payload type.\n* For JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation [JavaScript\n Object Notation (JSON) Pointer](https://tools.ietf.org/html/rfc6901).\n \n For example, for the JSON payload `{ \"form\": { \"password\": \"THE_PASSWORD\" } }`,\n the password field specification is `/form/password`.\n* For form encoded payload types, use the HTML form names.\n \n For example, for an HTML form with the input element\n named `password1`, the password field specification is `password1`.\n*Required*: No\n*Type*: [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspectionacfp.html#cfn-wafv2-webacl-requestinspectionacfp-passwordfield", "UpdateType": "Mutable", "Required": false, "Type": "FieldIdentifier" }, "AddressFields": { "MarkdownDocumentation": "`AddressFields`\n\nThe names of the fields in the request payload that contain your customer's primary physical address.\nOrder the address fields in the array exactly as they are ordered in the request payload.\nHow you specify the address fields depends on the request inspection payload type.\n* For JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation [JavaScript\n Object Notation (JSON) Pointer](https://tools.ietf.org/html/rfc6901).\n \n For example, for the JSON payload `{ \"form\": { \"primaryaddressline1\": \"THE_ADDRESS1\", \"primaryaddressline2\": \"THE_ADDRESS2\", \"primaryaddressline3\": \"THE_ADDRESS3\" } }`,\n the address field idenfiers are `/form/primaryaddressline1`, `/form/primaryaddressline2`, and `/form/primaryaddressline3`.\n* For form encoded payload types, use the HTML form names.\n \n For example, for an HTML form with input elements\n named `primaryaddressline1`, `primaryaddressline2`, and `primaryaddressline3`, the address fields identifiers are `primaryaddressline1`, `primaryaddressline2`, and `primaryaddressline3`.\n*Required*: No\n*Type*: Array of [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspectionacfp.html#cfn-wafv2-webacl-requestinspectionacfp-addressfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldIdentifier", "DuplicatesAllowed": true }, "PayloadType": { "MarkdownDocumentation": "`PayloadType`\n\nThe payload type for your account creation endpoint, either JSON or form encoded.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `JSON | FORM_ENCODED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JSON", "FORM_ENCODED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspectionacfp.html#cfn-wafv2-webacl-requestinspectionacfp-payloadtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PhoneNumberFields": { "MarkdownDocumentation": "`PhoneNumberFields`\n\nThe names of the fields in the request payload that contain your customer's primary phone number.\nOrder the phone number fields in the array exactly as they are ordered in the request payload.\nHow you specify the phone number fields depends on the request inspection payload type.\n* For JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation [JavaScript\n Object Notation (JSON) Pointer](https://tools.ietf.org/html/rfc6901).\n \n For example, for the JSON payload `{ \"form\": { \"primaryphoneline1\": \"THE_PHONE1\", \"primaryphoneline2\": \"THE_PHONE2\", \"primaryphoneline3\": \"THE_PHONE3\" } }`,\n the phone number field identifiers are `/form/primaryphoneline1`, `/form/primaryphoneline2`, and `/form/primaryphoneline3`.\n* For form encoded payload types, use the HTML form names.\n \n For example, for an HTML form with input elements\n named `primaryphoneline1`, `primaryphoneline2`, and `primaryphoneline3`, the phone number field identifiers are `primaryphoneline1`, `primaryphoneline2`, and `primaryphoneline3`.\n*Required*: No\n*Type*: Array of [FieldIdentifier](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspectionacfp.html#cfn-wafv2-webacl-requestinspectionacfp-phonenumberfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldIdentifier", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.ResponseInspection": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ResponseInspection`\n\nThe criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates.\n###### Note\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.\nThe rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels\nand mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time.\nThis is part of the `AWSManagedRulesATPRuleSet` and `AWSManagedRulesACFPRuleSet` configurations in `ManagedRuleGroupConfig`.\nEnable response inspection by configuring exactly one component of the response to inspect, for example, `Header` or `StatusCode`. You can't configure more than one component for inspection. If you don't configure any of the response inspection options, response inspection is disabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspection.html", "Properties": { "Header": { "MarkdownDocumentation": "`Header`\n\nConfigures inspection of the response header for success and failure indicators.\n*Required*: No\n*Type*: [ResponseInspectionHeader](./aws-properties-wafv2-webacl-responseinspectionheader.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspection.html#cfn-wafv2-webacl-responseinspection-header", "UpdateType": "Mutable", "Required": false, "Type": "ResponseInspectionHeader" }, "BodyContains": { "MarkdownDocumentation": "`BodyContains`\n\nConfigures inspection of the response body for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.\n*Required*: No\n*Type*: [ResponseInspectionBodyContains](./aws-properties-wafv2-webacl-responseinspectionbodycontains.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspection.html#cfn-wafv2-webacl-responseinspection-bodycontains", "UpdateType": "Mutable", "Required": false, "Type": "ResponseInspectionBodyContains" }, "Json": { "MarkdownDocumentation": "`Json`\n\nConfigures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.\n*Required*: No\n*Type*: [ResponseInspectionJson](./aws-properties-wafv2-webacl-responseinspectionjson.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspection.html#cfn-wafv2-webacl-responseinspection-json", "UpdateType": "Mutable", "Required": false, "Type": "ResponseInspectionJson" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nConfigures inspection of the response status code for success and failure indicators.\n*Required*: No\n*Type*: [ResponseInspectionStatusCode](./aws-properties-wafv2-webacl-responseinspectionstatuscode.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspection.html#cfn-wafv2-webacl-responseinspection-statuscode", "UpdateType": "Mutable", "Required": false, "Type": "ResponseInspectionStatusCode" } } }, "AWS::WAFv2::WebACL.ResponseInspectionBodyContains": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ResponseInspectionBodyContains`\n\nConfigures inspection of the response body. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.\nThis is part of the `ResponseInspection` configuration for `AWSManagedRulesATPRuleSet` and `AWSManagedRulesACFPRuleSet`.\n###### Note\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionbodycontains.html", "Properties": { "SuccessStrings": { "MarkdownDocumentation": "`SuccessStrings`\n\nStrings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.\nJSON examples: `\"SuccessStrings\": [ \"Login successful\" ]` and `\"SuccessStrings\": [ \"Account creation successful\", \"Welcome to our site!\" ]`\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionbodycontains.html#cfn-wafv2-webacl-responseinspectionbodycontains-successstrings", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "FailureStrings": { "MarkdownDocumentation": "`FailureStrings`\n\nStrings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.\nJSON example: `\"FailureStrings\": [ \"Request failed\" ]`\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionbodycontains.html#cfn-wafv2-webacl-responseinspectionbodycontains-failurestrings", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.ResponseInspectionHeader": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ResponseInspectionHeader`\n\nConfigures inspection of the response header.\nThis is part of the `ResponseInspection` configuration for `AWSManagedRulesATPRuleSet` and `AWSManagedRulesACFPRuleSet`.\n###### Note\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionheader.html", "Properties": { "SuccessValues": { "MarkdownDocumentation": "`SuccessValues`\n\nValues in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.\nJSON examples: `\"SuccessValues\": [ \"LoginPassed\", \"Successful login\" ]` and `\"SuccessValues\": [ \"AccountCreated\", \"Successful account creation\" ]`\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionheader.html#cfn-wafv2-webacl-responseinspectionheader-successvalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "FailureValues": { "MarkdownDocumentation": "`FailureValues`\n\nValues in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.\nJSON examples: `\"FailureValues\": [ \"LoginFailed\", \"Failed login\" ]` and `\"FailureValues\": [ \"AccountCreationFailed\" ]`\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionheader.html#cfn-wafv2-webacl-responseinspectionheader-failurevalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the header to match against. The name must be an exact match, including case.\nJSON example: `\"Name\": [ \"RequestResult\" ]`\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionheader.html#cfn-wafv2-webacl-responseinspectionheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.ResponseInspectionJson": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ResponseInspectionJson`\n\nConfigures inspection of the response JSON. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.\nThis is part of the `ResponseInspection` configuration for `AWSManagedRulesATPRuleSet` and `AWSManagedRulesACFPRuleSet`.\n###### Note\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionjson.html", "Properties": { "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nThe identifier for the value to match against in the JSON. The identifier must be an exact match, including case.\nJSON examples: `\"Identifier\": [ \"/login/success\" ]` and `\"Identifier\": [ \"/sign-up/success\" ]`\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionjson.html#cfn-wafv2-webacl-responseinspectionjson-identifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SuccessValues": { "MarkdownDocumentation": "`SuccessValues`\n\nValues for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.\nJSON example: `\"SuccessValues\": [ \"True\", \"Succeeded\" ]`\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionjson.html#cfn-wafv2-webacl-responseinspectionjson-successvalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "FailureValues": { "MarkdownDocumentation": "`FailureValues`\n\nValues for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.\nJSON example: `\"FailureValues\": [ \"False\", \"Failed\" ]`\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `100 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionjson.html#cfn-wafv2-webacl-responseinspectionjson-failurevalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.ResponseInspectionStatusCode": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.ResponseInspectionStatusCode`\n\nConfigures inspection of the response status code.\nThis is part of the `ResponseInspection` configuration for `AWSManagedRulesATPRuleSet` and `AWSManagedRulesACFPRuleSet`.\n###### Note\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionstatuscode.html", "Properties": { "SuccessCodes": { "MarkdownDocumentation": "`SuccessCodes`\n\nStatus codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.\nJSON example: `\"SuccessCodes\": [ 200, 201 ]`\n*Required*: Yes\n*Type*: Array of Integer\n*Minimum*: `0 | 1`\n*Maximum*: `999 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionstatuscode.html#cfn-wafv2-webacl-responseinspectionstatuscode-successcodes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true }, "FailureCodes": { "MarkdownDocumentation": "`FailureCodes`\n\nStatus codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.\nJSON example: `\"FailureCodes\": [ 400, 404 ]`\n*Required*: Yes\n*Type*: Array of Integer\n*Minimum*: `0 | 1`\n*Maximum*: `999 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionstatuscode.html#cfn-wafv2-webacl-responseinspectionstatuscode-failurecodes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "Integer", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.Rule": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.Rule`\n\nA single rule, which you can use in a [AWS::WAFv2::WebACL](./aws-resource-wafv2-webacl.html) or [AWS::WAFv2::RuleGroup](./aws-resource-wafv2-rulegroup.html) to identify web requests that you want to manage in some way.\nEach rule includes one top-level [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-statement) that AWS WAF uses to\nidentify matching web requests, and parameters that govern how AWS WAF handles them.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that AWS WAF should take on a web request when it matches\nthe 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\nstatements that reference a rule group are `RuleGroupReferenceStatement` and\n`ManagedRuleGroupStatement`.\nYou must set either this `Action` setting or the rule's\n`OverrideAction`, but not both:\n* If the rule statement doesn't reference a rule group, you must set this rule\n 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\n setting, because the actions are already set on the rules inside the rule group. You\n must set the rule's override action setting to indicate specifically whether to\n override the actions that are set on the rules in the rule group.\n*Required*: Conditional\n*Type*: [RuleAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-action", "UpdateType": "Mutable", "Required": false, "Type": "RuleAction" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nIf you define more than one `Rule` in a `WebACL`, AWS WAF\nevaluates each request against the `Rules` in order based on the value of\n`Priority`. AWS WAF processes rules with lower priority first. The priorities\ndon'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Statement": { "MarkdownDocumentation": "`Statement`\n\nThe AWS WAF processing statement for the rule, for example [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-bytematchstatement) or [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-sizeconstraintstatement).\n*Required*: Yes\n*Type*: [Statement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-statement", "UpdateType": "Mutable", "Required": true, "Type": "Statement" }, "ChallengeConfig": { "MarkdownDocumentation": "`ChallengeConfig`\n\nSpecifies how AWS WAF should handle `Challenge` evaluations.\nIf you don't specify this, AWS WAF uses the challenge configuration that's\ndefined for the web ACL.\n*Required*: No\n*Type*: [ChallengeConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-challengeconfig", "UpdateType": "Mutable", "Required": false, "Type": "ChallengeConfig" }, "OverrideAction": { "MarkdownDocumentation": "`OverrideAction`\n\nThe override action to apply to the rules in a rule group, instead of the individual\nrule action settings. This is used only for rules whose statements reference a rule group.\nRule statements that reference a rule group are `RuleGroupReferenceStatement`\nand `ManagedRuleGroupStatement`.\nSet the override action to none to leave the rule group rule actions in effect. Set it\nto count to only count matches, regardless of the rule action settings.\nYou must set either this `OverrideAction` setting or the `Action`\nsetting, but not both:\n* If the rule statement references a rule group, you must set this override action\n 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\n setting and you must not set the rule's override action setting.\n*Required*: Conditional\n*Type*: [OverrideAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-overrideaction", "UpdateType": "Mutable", "Required": false, "Type": "OverrideAction" }, "RuleLabels": { "MarkdownDocumentation": "`RuleLabels`\n\nLabels to apply to web requests that match the rule match statement. AWS WAF applies\nfully qualified labels to matching web requests. A fully qualified label is the\nconcatenation of a label namespace and a rule label. The rule's rule group or web ACL\ndefines the label namespace.\n###### Note\nAny rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests.\nRules that run after this rule in the web ACL can match against these labels using a\n`LabelMatchStatement`.\nFor each label, provide a case-sensitive string containing optional namespaces and a\nlabel 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:\n `aws`, `waf`, `managed`, `rulegroup`,\n `webacl`, `regexpatternset`, or `ipset`.\nFor example, `myLabelName` or `nameSpace1:nameSpace2:myLabelName`.\n*Required*: No\n*Type*: Array of [Label](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-rulelabels", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Label", "DuplicatesAllowed": true }, "VisibilityConfig": { "MarkdownDocumentation": "`VisibilityConfig`\n\nDefines and enables Amazon CloudWatch metrics and web request sample collection.\nIf you change the name of a `Rule` after you create\nit and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF\ndoesn't automatically update the metric name.\n*Required*: Yes\n*Type*: [VisibilityConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-visibilityconfig", "UpdateType": "Mutable", "Required": true, "Type": "VisibilityConfig" }, "CaptchaConfig": { "MarkdownDocumentation": "`CaptchaConfig`\n\nSpecifies 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-captchaconfig", "UpdateType": "Mutable", "Required": false, "Type": "CaptchaConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule.\nIf you change the name of a `Rule` after you create\nit and you want the rule's metric name to reflect the change, update the metric name in the rule's `VisibilityConfig` settings. AWS WAF\ndoesn't automatically update the metric name when you update the rule name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RuleAction": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RuleAction`\n\nThe action that AWS WAF should take on a web request when it matches a rule's\nstatement. Settings at the web ACL level can override the rule action setting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html", "Properties": { "Captcha": { "MarkdownDocumentation": "`Captcha`\n\nSpecifies that AWS WAF should run a `CAPTCHA` check against\nthe 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\n to a `CountAction`.\n* If the request doesn't include a valid, unexpired `CAPTCHA` token,\n AWS WAF discontinues the web ACL evaluation of the request and blocks\n it from going to its intended destination.\n \n AWS WAF generates a response that it sends back to the client, which\n includes the following:\n \n + The header `x-amzn-waf-action` with a value of\n `captcha`.\n + The HTTP status code `405 Method Not Allowed`.\n + If the request contains an `Accept` header with a value of\n `text/html`, the response includes a `CAPTCHA`\n challenge.\nYou can configure the expiration time in the `CaptchaConfig``ImmunityTimeProperty` setting at the rule and web ACL level. The rule setting\noverrides the web ACL setting.\nThis action option is available for rules. It isn't available for web ACL default\nactions.\n*Required*: No\n*Type*: [CaptchaAction](./aws-properties-wafv2-webacl-captchaaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-captcha", "UpdateType": "Mutable", "Required": false, "Type": "CaptchaAction" }, "Block": { "MarkdownDocumentation": "`Block`\n\nInstructs AWS WAF to block the web request.\n*Required*: No\n*Type*: [BlockAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-block", "UpdateType": "Mutable", "Required": false, "Type": "BlockAction" }, "Count": { "MarkdownDocumentation": "`Count`\n\nInstructs 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-count", "UpdateType": "Mutable", "Required": false, "Type": "CountAction" }, "Allow": { "MarkdownDocumentation": "`Allow`\n\nInstructs AWS WAF to allow the web request.\n*Required*: No\n*Type*: [AllowAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-allow", "UpdateType": "Mutable", "Required": false, "Type": "AllowAction" }, "Challenge": { "MarkdownDocumentation": "`Challenge`\n\nInstructs AWS WAF to run a `Challenge` check against the web\nrequest.\n*Required*: No\n*Type*: [ChallengeAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html#cfn-wafv2-webacl-ruleaction-challenge", "UpdateType": "Mutable", "Required": false, "Type": "ChallengeAction" } } }, "AWS::WAFv2::WebACL.RuleActionOverride": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RuleActionOverride`\n\nAction setting to use in the place of a rule action that is configured inside the rule\ngroup. 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\n`Count` and then monitor the resulting count metrics to understand how the\nrule group would handle your web traffic. You can also permanently override some or all\nactions, to modify how the rule group manages your web traffic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html", "Properties": { "ActionToUse": { "MarkdownDocumentation": "`ActionToUse`\n\nThe override action to use, in place of the configured action of the rule in the rule\ngroup.\n*Required*: Yes\n*Type*: [RuleAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html#cfn-wafv2-webacl-ruleactionoverride-actiontouse", "UpdateType": "Mutable", "Required": true, "Type": "RuleAction" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule to override.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html#cfn-wafv2-webacl-ruleactionoverride-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.RuleGroupReferenceStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.RuleGroupReferenceStatement`\n\nA rule statement used to run the rules that are defined in a [AWS::WAFv2::RuleGroup](./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 cannot use a rule group\nreference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html", "Properties": { "RuleActionOverrides": { "MarkdownDocumentation": "`RuleActionOverrides`\n\nAction 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.\n###### Note\nVerify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.\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*: Array of [RuleActionOverride](./aws-properties-wafv2-webacl-ruleactionoverride.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-ruleactionoverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RuleActionOverride", "DuplicatesAllowed": true }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the entity.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-arn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExcludedRules": { "MarkdownDocumentation": "`ExcludedRules`\n\nRules in the referenced rule group whose actions are set to `Count`.\n###### Note\nInstead of this option, use `RuleActionOverrides`. It accepts any valid action setting, including `Count`.\n*Required*: No\n*Type*: Array of [ExcludedRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-excludedrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ExcludedRule", "DuplicatesAllowed": true } } }, "AWS::WAFv2::WebACL.SingleHeader": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.SingleHeader`\n\nInspect one of the headers in the web request, identified by name, for example,\n`User-Agent` or `Referer`. The name isn't case sensitive.\nYou can filter and inspect all headers with the `FieldToMatch` setting\n`Headers`.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singleheader.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the query header to inspect.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singleheader.html#cfn-wafv2-webacl-singleheader-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.SingleQueryArgument": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.SingleQueryArgument`\n\nInspect one query argument in the web request, identified by name, for example\n*UserName* or *SalesRegion*. The name isn't case\nsensitive.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singlequeryargument.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the query argument to inspect.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singlequeryargument.html#cfn-wafv2-webacl-singlequeryargument-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.SizeConstraintStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.SizeConstraintStatement`\n\nA 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 number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see `Body` and `JsonBody` settings for the `FieldToMatch` data type.\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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html", "Properties": { "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe operator to use to compare the request part to the size setting.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EQ | NE | LE | LT | GE | GT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EQ", "NE", "LE", "LT", "GE", "GT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-comparisonoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size, in byte, to compare to the request part, after any transformations.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\n*Maximum*: `21474836480`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-size", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html#cfn-wafv2-webacl-sizeconstraintstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::WebACL.SqliMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.SqliMatchStatement`\n\nA 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html", "Properties": { "SensitivityLevel": { "MarkdownDocumentation": "`SensitivityLevel`\n\nThe 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,\nespecially if your web requests frequently contain unusual strings.\nFor information about identifying and mitigating false positives, see\n[Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the\n*AWS WAF Developer Guide*.\n`LOW` is generally a better choice for resources that already have other\nprotections against SQL injection attacks or that have a low tolerance for false positives.\nDefault: `LOW`\n*Required*: No\n*Type*: String\n*Allowed values*: `LOW | HIGH`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "LOW", "HIGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html#cfn-wafv2-webacl-sqlimatchstatement-sensitivitylevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html#cfn-wafv2-webacl-sqlimatchstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html#cfn-wafv2-webacl-sqlimatchstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WAFv2::WebACL.Statement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.Statement`\n\nThe processing guidance for a rule, used by AWS WAF to determine whether a\nweb request matches the rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html", "Properties": { "SizeConstraintStatement": { "MarkdownDocumentation": "`SizeConstraintStatement`\n\nA 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 number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see `Body` and `JsonBody` settings for the `FieldToMatch` data type.\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-sizeconstraintstatement", "UpdateType": "Mutable", "Required": false, "Type": "SizeConstraintStatement" }, "AndStatement": { "MarkdownDocumentation": "`AndStatement`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-andstatement", "UpdateType": "Mutable", "Required": false, "Type": "AndStatement" }, "XssMatchStatement": { "MarkdownDocumentation": "`XssMatchStatement`\n\nA rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker\nuses 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-xssmatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "XssMatchStatement" }, "NotStatement": { "MarkdownDocumentation": "`NotStatement`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-notstatement", "UpdateType": "Mutable", "Required": false, "Type": "NotStatement" }, "ByteMatchStatement": { "MarkdownDocumentation": "`ByteMatchStatement`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-bytematchstatement", "UpdateType": "Mutable", "Required": false, "Type": "ByteMatchStatement" }, "RateBasedStatement": { "MarkdownDocumentation": "`RateBasedStatement`\n\nA rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.\n###### Note\nIf you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.\nYou can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.\nEach unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.\nFor example, assume the rule evaluates web requests with the following IP address and HTTP method values:\n* IP address 10.1.1.1, HTTP method POST\n* IP address 10.1.1.1, HTTP method GET\n* IP address 127.0.0.0, HTTP method POST\n* IP address 10.1.1.1, HTTP method GET\nThe rule would create different aggregation instances according to your aggregation criteria, for example:\n* If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:\n \n + IP address 10.1.1.1: count 3\n + IP address 127.0.0.0: count 1\n* If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:\n \n + HTTP method POST: count 2\n + HTTP method GET: count 2\n* If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:\n \n + IP address 10.1.1.1, HTTP method POST: count 1\n + IP address 10.1.1.1, HTTP method GET: count 2\n + IP address 127.0.0.0, HTTP method POST: count 1\nFor any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.\nYou can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the 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.\nFor additional information about the options, see [Rate limiting web requests using rate-based rules](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html)\nin the *AWS WAF Developer Guide*.\nIf you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF\nis currently rate limiting for a rule through the API call `GetRateBasedStatementManagedKeys`. This option is not available\nfor other aggregation configurations.\nAWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF.\n*Required*: No\n*Type*: [RateBasedStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ratebasedstatement", "UpdateType": "Mutable", "Required": false, "Type": "RateBasedStatement" }, "GeoMatchStatement": { "MarkdownDocumentation": "`GeoMatchStatement`\n\nA 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.\nAWS 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-geomatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "GeoMatchStatement" }, "RuleGroupReferenceStatement": { "MarkdownDocumentation": "`RuleGroupReferenceStatement`\n\nA rule statement used to run the rules that are defined in a [AWS::WAFv2::RuleGroup](./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 cannot use a rule group\nreference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.\n*Required*: No\n*Type*: [RuleGroupReferenceStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-rulegroupreferencestatement", "UpdateType": "Mutable", "Required": false, "Type": "RuleGroupReferenceStatement" }, "LabelMatchStatement": { "MarkdownDocumentation": "`LabelMatchStatement`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-labelmatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "LabelMatchStatement" }, "RegexMatchStatement": { "MarkdownDocumentation": "`RegexMatchStatement`\n\nA rule statement used to search web request components for a match against a single regular expression.\n*Required*: No\n*Type*: [RegexMatchStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-regexmatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "RegexMatchStatement" }, "SqliMatchStatement": { "MarkdownDocumentation": "`SqliMatchStatement`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-sqlimatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "SqliMatchStatement" }, "RegexPatternSetReferenceStatement": { "MarkdownDocumentation": "`RegexPatternSetReferenceStatement`\n\nA rule statement used to search web request components for matches with regular\nexpressions. To use this, create a [AWS::WAFv2::RegexPatternSet](./aws-resource-wafv2-regexpatternset.html) that specifies the\nexpressions that you want to detect, then use the ARN of that set in this statement. A web\nrequest matches the pattern set rule statement if the request component matches any of the\npatterns in the set.\nEach regex pattern set rule statement references a regex pattern set. You create and\nmaintain the set independent of your rules. This allows you to use the single set in\nmultiple rules. When you update the referenced set, AWS WAF automatically\nupdates all rules that reference it.\n*Required*: No\n*Type*: [RegexPatternSetReferenceStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-regexpatternsetreferencestatement", "UpdateType": "Mutable", "Required": false, "Type": "RegexPatternSetReferenceStatement" }, "OrStatement": { "MarkdownDocumentation": "`OrStatement`\n\nA logical rule statement used to combine other rule statements with OR logic. You\nprovide more than one `Statement` within the `OrStatement`.\n*Required*: No\n*Type*: [OrStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-orstatement", "UpdateType": "Mutable", "Required": false, "Type": "OrStatement" }, "AsnMatchStatement": { "MarkdownDocumentation": "`AsnMatchStatement`\n\nA rule statement that inspects web traffic based on the Autonomous System Number (ASN) associated with the request's IP address.\nFor additional details, see [ASN match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-asn-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\n*Required*: No\n*Type*: [AsnMatchStatement](./aws-properties-wafv2-webacl-asnmatchstatement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-asnmatchstatement", "UpdateType": "Mutable", "Required": false, "Type": "AsnMatchStatement" }, "ManagedRuleGroupStatement": { "MarkdownDocumentation": "`ManagedRuleGroupStatement`\n\nA rule statement used to run the rules that are defined in a managed rule group. To use\nthis, provide the vendor name and the name of the rule group in this statement. You can\nretrieve the required names through the API call\n`ListAvailableManagedRuleGroups`.\nYou cannot nest a `ManagedRuleGroupStatement`, for example for use inside a\n`NotStatement` or `OrStatement`. It can only be referenced as a\ntop-level statement within a rule.\n###### Note\nYou are charged additional fees when you use the AWS WAF Bot Control\nmanaged rule group `AWSManagedRulesBotControlRuleSet`, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group\n`AWSManagedRulesATPRuleSet`, or the AWS WAF Fraud Control\naccount creation fraud prevention (ACFP) managed rule group\n`AWSManagedRulesACFPRuleSet`. For more information, see [AWS WAF Pricing](https://aws.amazon.com/waf/pricing/).\n*Required*: No\n*Type*: [ManagedRuleGroupStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-managedrulegroupstatement", "UpdateType": "Mutable", "Required": false, "Type": "ManagedRuleGroupStatement" }, "IPSetReferenceStatement": { "MarkdownDocumentation": "`IPSetReferenceStatement`\n\nA rule statement used to detect web requests coming from particular IP addresses or\naddress ranges. To use this, create an [AWS::WAFv2::IPSet](./aws-resource-wafv2-ipset.html) that specifies the addresses\nyou 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\nindependent of your rules. This allows you to use the single set in multiple rules. When\nyou update the referenced set, AWS WAF automatically updates all rules that\nreference it.\n*Required*: No\n*Type*: [IPSetReferenceStatement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html#cfn-wafv2-webacl-statement-ipsetreferencestatement", "UpdateType": "Mutable", "Required": false, "Type": "IPSetReferenceStatement" } } }, "AWS::WAFv2::WebACL.TextTransformation": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.TextTransformation`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nFor detailed descriptions of each of the transformation types, see [Text transformations](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-transformation.html)\nin the *AWS WAF Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | COMPRESS_WHITE_SPACE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE", "BASE64_DECODE", "HEX_DECODE", "MD5", "REPLACE_COMMENTS", "ESCAPE_SEQ_DECODE", "SQL_HEX_DECODE", "CSS_DECODE", "JS_DECODE", "NORMALIZE_PATH", "NORMALIZE_PATH_WIN", "REMOVE_NULLS", "REPLACE_NULLS", "BASE64_DECODE_EXT", "URL_DECODE_UNI", "UTF8_TO_UNICODE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html#cfn-wafv2-webacl-texttransformation-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nSets the relative processing order for multiple transformations.\nAWS WAF processes all transformations, from lowest priority to highest,\nbefore inspecting the transformed content. The priorities don't need to be consecutive, but\nthey 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html#cfn-wafv2-webacl-texttransformation-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } } }, "AWS::WAFv2::WebACL.UriFragment": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.UriFragment`\n\nInspect fragments of the request URI. You can specify the parts of the URI fragment to\ninspect and you can narrow the set of URI fragments to inspect by including or excluding specific\nkeys.\nThis is used to indicate the web request component to inspect, in the [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch) specification.\nExample JSON: `\"UriFragment\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n\"OversizeHandling\": \"MATCH\" }`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-urifragment.html", "Properties": { "FallbackBehavior": { "MarkdownDocumentation": "`FallbackBehavior`\n\nWhat AWS WAF should do if it fails to completely parse the JSON body. The options are\nthe following:\n* `EVALUATE_AS_STRING` - Inspect the body as plain text. AWS WAF\n applies the text transformations and inspection criteria that you defined for the\n JSON inspection to the body text string.\n* `MATCH` - Treat the web request as matching the rule statement.\n AWS WAF applies the rule action to the request.\n* `NO_MATCH` - Treat the web request as not matching the rule\n statement.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the\nfirst parsing failure that it encounters.\nExample JSON: `{ \"UriFragment\": { \"FallbackBehavior\": \"MATCH\"} }`\n###### Note\nAWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When\nparsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information,\nsee [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body)\nin the *AWS WAF Developer Guide*.\n*Required*: No\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)", "RefReturnValue": "", "AllowedValues": [ "MATCH", "NO_MATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-urifragment.html#cfn-wafv2-webacl-urifragment-fallbackbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::WAFv2::WebACL.VisibilityConfig": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.VisibilityConfig`\n\nDefines and enables Amazon CloudWatch metrics and web request sample collection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nA name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9,\n- (hyphen), and \\_ (underscore). The name can be from one to 128 characters long. It can't\ncontain whitespace or metric names that are reserved for AWS WAF, for example `All` and\n`Default_Action`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SampledRequestsEnabled": { "MarkdownDocumentation": "`SampledRequestsEnabled`\n\nIndicates whether AWS WAF should store a sampling of the web requests that\nmatch the rules. You can view the sampled requests through the AWS WAF console.\nIf you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.\n###### Note\nRequest sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling.\nYou can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration\nor by configuring data protection for the web ACL.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-sampledrequestsenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "CloudWatchMetricsEnabled": { "MarkdownDocumentation": "`CloudWatchMetricsEnabled`\n\nIndicates whether the associated resource sends metrics to Amazon CloudWatch. For the\nlist of available metrics, see [AWS WAF\nMetrics](https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics) in the *AWS WAF Developer Guide*.\nFor web ACLs, the metrics are for web requests that have the web ACL default action applied.\nAWS WAF applies the default action to web requests that pass the inspection of all rules\nin the web ACL without being either allowed or blocked. For more information,\nsee [The web ACL default action](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html) in the *AWS WAF Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html#cfn-wafv2-webacl-visibilityconfig-cloudwatchmetricsenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } } }, "AWS::WAFv2::WebACL.XssMatchStatement": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL.XssMatchStatement`\n\nA rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker\nuses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html", "Properties": { "TextTransformations": { "MarkdownDocumentation": "`TextTransformations`\n\nText transformations eliminate some of the unusual formatting that attackers use in web\nrequests in an effort to bypass detection. If you specify one or more transformations in a\nrule statement, AWS WAF performs all transformations on the content of the\nrequest component identified by `FieldToMatch`, starting from the lowest\npriority setting, before inspecting the content for a match.\n*Required*: Yes\n*Type*: Array of [TextTransformation](./aws-properties-wafv2-webacl-texttransformation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html#cfn-wafv2-webacl-xssmatchstatement-texttransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TextTransformation", "DuplicatesAllowed": true }, "FieldToMatch": { "MarkdownDocumentation": "`FieldToMatch`\n\nThe part of the web request that you want AWS WAF to inspect.\n*Required*: Yes\n*Type*: [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html#cfn-wafv2-webacl-xssmatchstatement-fieldtomatch", "UpdateType": "Mutable", "Required": true, "Type": "FieldToMatch" } } }, "AWS::WorkSpaces::Workspace.WorkspaceProperties": { "MarkdownDocumentation": "`AWS::WorkSpaces::Workspace.WorkspaceProperties`\n\nInformation about a WorkSpace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html", "Properties": { "ComputeTypeName": { "MarkdownDocumentation": "`ComputeTypeName`\n\nThe compute type. For more information, see [Amazon WorkSpaces\nBundles](https://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles).\n*Required*: No\n*Type*: String\n*Allowed values*: `VALUE | STANDARD | PERFORMA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VALUE", "STANDARD", "PERFORMANCE", "POWER", "GRAPHICS", "POWERPRO", "GENERALPURPOSE_4XLARGE", "GENERALPURPOSE_8XLARGE", "GRAPHICSPRO", "GRAPHICS_G4DN", "GRAPHICSPRO_G4DN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-computetypename", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "RootVolumeSizeGib": { "MarkdownDocumentation": "`RootVolumeSizeGib`\n\nThe size of the root volume. For important information about how to modify the size of\nthe root and user volumes, see [Modify a\nWorkSpace](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-rootvolumesizegib", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "RunningMode": { "MarkdownDocumentation": "`RunningMode`\n\nThe running mode. For more information, see [Manage the WorkSpace Running\nMode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTO_STOP | ALWAYS_ON | MAN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTO_STOP", "ALWAYS_ON", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-runningmode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "RunningModeAutoStopTimeoutInMinutes": { "MarkdownDocumentation": "`RunningModeAutoStopTimeoutInMinutes`\n\nThe time after a user logs off when WorkSpaces are automatically stopped. Configured in\n60-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-runningmodeautostoptimeoutinminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "UserVolumeSizeGib": { "MarkdownDocumentation": "`UserVolumeSizeGib`\n\nThe size of the user storage. For important information about how to modify the size of\nthe root and user volumes, see [Modify a\nWorkSpace](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html#cfn-workspaces-workspace-workspaceproperties-uservolumesizegib", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::XRay::Group.InsightsConfiguration": { "MarkdownDocumentation": "`AWS::XRay::Group.InsightsConfiguration`\n\nThe structure containing configurations related to insights.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-insightsconfiguration.html", "Properties": { "NotificationsEnabled": { "MarkdownDocumentation": "`NotificationsEnabled`\n\nSet the NotificationsEnabled value to true to enable insights notifications. Notifications can only be\nenabled 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-insightsconfiguration.html#cfn-xray-group-insightsconfiguration-notificationsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InsightsEnabled": { "MarkdownDocumentation": "`InsightsEnabled`\n\nSet the InsightsEnabled value to true to enable insights or false to disable\ninsights.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-insightsconfiguration.html#cfn-xray-group-insightsconfiguration-insightsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::XRay::SamplingRule.SamplingRule": { "MarkdownDocumentation": "`AWS::XRay::SamplingRule.SamplingRule`\n\nA sampling rule that services use to decide whether to instrument a request. Rule\nfields can match properties of the service, or properties of a request. The service can ignore\nrules that don't match its properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html", "Properties": { "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority of the sampling rule.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `9999`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ReservoirSize": { "MarkdownDocumentation": "`ReservoirSize`\n\nA fixed number of matching requests to instrument per second, prior to applying the\nfixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-reservoirsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "RuleARN": { "MarkdownDocumentation": "`RuleARN`\n\nThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.\n###### Note\nSpecifying a sampling rule by name is recommended, as specifying by\nARN will be deprecated in future.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-rulearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "URLPath": { "MarkdownDocumentation": "`URLPath`\n\nMatches the path from a request URL.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-urlpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nMatches 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*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-attributes", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "FixedRate": { "MarkdownDocumentation": "`FixedRate`\n\nThe percentage of matching requests to instrument, after the reservoir is\nexhausted.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-fixedrate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Host": { "MarkdownDocumentation": "`Host`\n\nMatches the hostname from a request URL.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-host", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceARN": { "MarkdownDocumentation": "`ResourceARN`\n\nMatches the ARN of the AWS resource on which the service runs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-resourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HTTPMethod": { "MarkdownDocumentation": "`HTTPMethod`\n\nMatches the HTTP method of a request.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-httpmethod", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nMatches the `name` that the service uses to identify itself in segments.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-servicename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version of the sampling rule. `Version` can only be set when creating a new sampling rule.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-version", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ServiceType": { "MarkdownDocumentation": "`ServiceType`\n\nMatches the `origin` that the service uses to identify its type in segments.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-servicetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nThe name of the sampling rule. Specify a rule by either name or ARN, but not both.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html#cfn-xray-samplingrule-samplingrule-rulename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "Alexa::ASK::Skill.AuthenticationConfiguration": { "MarkdownDocumentation": "`Alexa::ASK::Skill.AuthenticationConfiguration`\n\nThe `AuthenticationConfiguration` property type specifies the Login with\nAmazon (LWA) configuration used to authenticate with the Alexa service. Only Login with\nAmazon security profiles created through the [Build Skills with the Alexa Skills Kit developer documentation](https://developer.amazon.com/docs/ask-overviews/build-skills-with-the-alexa-skills-kit.html) are supported for authentication. A client ID, client secret, and\nrefresh token are required. You can generate a client ID and client secret by creating a\nnew [security profile](https://developer.amazon.com/lwa/sp/create-security-profile.html) on the Amazon Developer Portal or you can retrieve them\nfrom an existing profile. You can then retrieve the refresh token using the Alexa Skills\nKit CLI. For instructions, see [util-command](https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html#util-command)\nin the [ASK CLI Command Reference](https://developer.amazon.com/docs/smapi/ask-cli-command-reference.html).\n`AuthenticationConfiguration` is a property of the\n`Alexa::ASK::Skill` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html", "Properties": { "RefreshToken": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-refreshtoken", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ClientSecret": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-clientsecret", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ClientId": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-clientid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "Alexa::ASK::Skill.Overrides": { "MarkdownDocumentation": "`Alexa::ASK::Skill.Overrides`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-overrides.html", "Properties": { "Manifest": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-overrides.html#cfn-ask-skill-overrides-manifest", "PrimitiveType": "Json", "UpdateType": "Mutable" } } }, "Alexa::ASK::Skill.SkillPackage": { "MarkdownDocumentation": "`Alexa::ASK::Skill.SkillPackage`\n\nThe `SkillPackage` property type contains configuration details for the\nskill package that contains the components of the Alexa skill. Skill packages are\nretrieved from an Amazon S3 bucket and key and used to create and update the skill. More\ndetails about the skill package format are located in the [Skill Package API Reference](https://developer.amazon.com/docs/smapi/skill-package-api-reference.html#skill-package-format).\n`SkillPackage` is a property of the `Alexa::ASK::Skill`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html", "Properties": { "S3BucketRole": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucketrole", "PrimitiveType": "String", "UpdateType": "Mutable" }, "S3ObjectVersion": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3objectversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "S3Bucket": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucket", "PrimitiveType": "String", "UpdateType": "Mutable" }, "S3Key": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3key", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Overrides": { "Type": "Overrides", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-overrides", "UpdateType": "Mutable" } } }, "Tag": { "MarkdownDocumentation": "`Tag`\n\nYou can apply tags to resources by using the `Tags` property in your CloudFormation\ntemplate, which can help you identify and categorize those resources.\nFor information about which resources support the `Tags` property, see the\nindividual resources in the [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-template-resource-type-ref.html). If a resource doesn't yet support the\n`Tags` property, the resource's service might support tagging using its own API\noperations. For more information, refer to the documentation for that service.\nIn addition to any tags you define, CloudFormation automatically creates the following\nstack-level tags with the `aws:` prefix:\n* `aws:cloudformation:logical-id`\n* `aws:cloudformation:stack-id`\n* `aws:cloudformation:stack-name`\nThe `aws:` prefix is reserved for AWS use. This prefix is case-insensitive. If\nyou use this prefix in the `Key` or `Value` property, you can't update\nor delete the tag. Tags with this prefix don't count toward the number of tags per\nresource.\nThe propagation of stack-level tags to resources, including tags with the `aws:`\nprefix, varies by resource type. For example, tags aren't propagated to Amazon EBS volumes that are\ncreated from block device mappings.\n###### Note\nSome resources require explicit tag propagation settings. For example, the\n`AWS::AutoScaling::AutoScalingGroup` resource must have its\n`PropagateAtLaunch` property set to `true` to propagate tags to\nits EC2 instances. However, stack-level tags are automatically applied to EC2 instances\nregardless of the `PropagateAtLaunch` setting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html", "Properties": { "Value": { "MarkdownDocumentation": "`Value`\n\nThe value for the tag. You can specify a value that's 1 to 256 characters in\nlength. You can use any of the following characters: the set of Unicode letters,\ndigits, whitespace, `_`, `.`, `/`,\n`=`, `+`, and `-`.\n*Required*: Yes\n*Type*: String\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html#cfn-resource-tags-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nThe key name of the tag. You can specify a value that's 1 to 128 Unicode\ncharacters in length and can't be prefixed with `aws:`. You can use any\nof the following characters: the set of Unicode letters, digits, whitespace,\n`_`, `.`, `:`, `/`, `=`,\n`+`, `@`, `-`, and `\"`.\n*Required*: Yes\n*Type*: String\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html#cfn-resource-tags-key", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } } }, "ResourceTypes": { "AWS::ACMPCA::Certificate": { "MarkdownDocumentation": "`AWS::ACMPCA::Certificate`\n\nThe `AWS::ACMPCA::Certificate` resource is used to issue a certificate\nusing your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.\n", "RefReturnValue": "\nThis reference should not be used in CloudFormation templates. Instead, use\n`AWS::ACMPCA::Certificate.Arn` to identify a certificate, and use\n`AWS::ACMPCA::Certificate.CertificateAuthorityArn` to identify a\ncertificate authority.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html", "Properties": { "TemplateArn": { "MarkdownDocumentation": "`TemplateArn`\n\nSpecifies a custom configuration template to use when issuing a certificate. If this\nparameter is not provided, AWS Private CA defaults to the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-templatearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CertificateAuthorityArn": { "MarkdownDocumentation": "`CertificateAuthorityArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificateauthorityarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Validity": { "MarkdownDocumentation": "`Validity`\n\nThe period of time during which the certificate will be valid.\n*Required*: Yes\n*Type*: [Validity](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validity", "UpdateType": "Immutable", "Required": true, "Type": "Validity" }, "CertificateSigningRequest": { "MarkdownDocumentation": "`CertificateSigningRequest`\n\nThe certificate signing request (CSR) for the certificate.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificatesigningrequest", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SigningAlgorithm": { "MarkdownDocumentation": "`SigningAlgorithm`\n\nThe 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\nused to sign a CSR in the `CreateCertificateAuthority` action.\n###### Note\nThe specified signing algorithm family (RSA or ECDSA) must match the algorithm\nfamily of the CA's secret key.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SHA256WITHECDSA | SHA384WIT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SHA256WITHECDSA", "SHA384WITHECDSA", "SHA512WITHECDSA", "SHA256WITHRSA", "SHA384WITHRSA", "SHA512WITHRSA", "SM3WITHSM2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-signingalgorithm", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApiPassthrough": { "MarkdownDocumentation": "`ApiPassthrough`\n\nSpecifies X.509 certificate information to be included in the issued certificate. An\n`APIPassthrough` or `APICSRPassthrough` template variant must\nbe selected, or else this parameter is ignored.\n*Required*: No\n*Type*: [ApiPassthrough](./aws-properties-acmpca-certificate-apipassthrough.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-apipassthrough", "UpdateType": "Immutable", "Required": false, "Type": "ApiPassthrough" }, "ValidityNotBefore": { "MarkdownDocumentation": "`ValidityNotBefore`\n\nInformation describing the start of the validity period of the certificate. This\nparameter sets the \u201cNot Before\" date for the certificate.\nBy default, when issuing a certificate, AWS Private CA sets the \"Not\nBefore\" date to the issuance time minus 60 minutes. This compensates for clock\ninconsistencies across computer systems. The `ValidityNotBefore` parameter\ncan be used to customize the \u201cNot Before\u201d value.\nUnlike the `Validity` parameter, the `ValidityNotBefore`\nparameter is optional.\nThe `ValidityNotBefore` value is expressed as an explicit date and time,\nusing the `Validity` type value `ABSOLUTE`.\n*Required*: No\n*Type*: [Validity](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validitynotbefore", "UpdateType": "Immutable", "Required": false, "Type": "Validity" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the issued certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#Arn-fn::getatt" }, "Certificate": { "PrimitiveType": "String", "MarkdownDocumentation": "`Certificate`\n\nThe issued Base64 PEM-encoded certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#Certificate-fn::getatt" } } }, "AWS::ACMPCA::CertificateAuthority": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthority`\n\nUse the `AWS::ACMPCA::CertificateAuthority` resource to create a private\nCA. Once the CA exists, you can use the `AWS::ACMPCA::Certificate` resource\nto issue a new CA certificate. Alternatively, you can issue a CA certificate using an\non-premises CA, and then use the\n`AWS::ACMPCA::CertificateAuthorityActivation` resource to import the new\nCA certificate and activate the CA.\n###### Note\nBefore removing a `AWS::ACMPCA::CertificateAuthority` resource from the\nCloudFormation stack, disable the affected CA. Otherwise, the action will fail. You\ncan disable the CA by removing its associated\n`AWS::ACMPCA::CertificateAuthorityActivation` resource from\nCloudFormation.\n", "RefReturnValue": "\nThe Amazon Resource Name (ARN) of the certificate authority.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html", "Properties": { "CsrExtensions": { "MarkdownDocumentation": "`CsrExtensions`\n\nSpecifies information to be added to the extension section of the certificate signing\nrequest (CSR).\n*Required*: No\n*Type*: [CsrExtensions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-csrextensions", "UpdateType": "Immutable", "Required": false, "Type": "CsrExtensions" }, "Type": { "MarkdownDocumentation": "`Type`\n\nType 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)", "RefReturnValue": "", "AllowedValues": [ "ROOT", "SUBORDINATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RevocationConfiguration": { "MarkdownDocumentation": "`RevocationConfiguration`\n\nInformation about the Online Certificate Status Protocol (OCSP) configuration or\ncertificate revocation list (CRL) created and maintained by your private CA.\n*Required*: No\n*Type*: [RevocationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-revocationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RevocationConfiguration" }, "UsageMode": { "MarkdownDocumentation": "`UsageMode`\n\nSpecifies whether the CA issues general-purpose certificates that typically require a\nrevocation mechanism, or short-lived certificates that may optionally omit revocation\nbecause they expire quickly. Short-lived certificate validity is limited to seven\ndays.\nThe default value is GENERAL\\_PURPOSE.\n*Required*: No\n*Type*: String\n*Allowed values*: `GENERAL_PURPOSE | SHORT_LIV...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "GENERAL_PURPOSE", "SHORT_LIVED_CERTIFICATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-usagemode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SigningAlgorithm": { "MarkdownDocumentation": "`SigningAlgorithm`\n\nName of the algorithm your private CA uses to sign certificate requests.\nThis parameter should not be confused with the `SigningAlgorithm` parameter\nused to sign certificates when they are issued.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SHA256WITHECDSA | SHA384WIT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SHA256WITHECDSA", "SHA384WITHECDSA", "SHA512WITHECDSA", "SHA256WITHRSA", "SHA384WITHRSA", "SHA512WITHRSA", "SM3WITHSM2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-signingalgorithm", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KeyStorageSecurityStandard": { "MarkdownDocumentation": "`KeyStorageSecurityStandard`\n\nSpecifies a cryptographic key management compliance standard for handling and\nprotecting CA keys.\nDefault: FIPS\\_140\\_2\\_LEVEL\\_3\\_OR\\_HIGHER\n###### Note\nSome AWS Regions don't support the default value. When you create a CA in these\nRegions, you must use `CCPC_LEVEL_1_OR_HIGHER` for the\n`KeyStorageSecurityStandard` parameter. If you don't, the operation\nreturns an `InvalidArgsException` with this message: \"A certificate\nauthority cannot be created in this region with the specified security\nstandard.\"\nFor information about security standard support in different AWS Regions, see\n[Storage and security compliance of AWS Private CA private keys](https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys).\n*Required*: No\n*Type*: String\n*Allowed values*: `FIPS_140_2_LEVEL_2_OR_HIGHE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FIPS_140_2_LEVEL_2_OR_HIGHER", "FIPS_140_2_LEVEL_3_OR_HIGHER", "CCPC_LEVEL_1_OR_HIGHER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keystoragesecuritystandard", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Subject": { "MarkdownDocumentation": "`Subject`\n\nStructure that contains X.500 distinguished name information for your private\nCA.\n*Required*: Yes\n*Type*: [Subject](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-subject", "UpdateType": "Immutable", "Required": true, "Type": "Subject" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that will be attached to the new private CA. You can associate up to\n50 tags with a private CA. For information using tags with IAM to manage permissions,\nsee [Controlling Access Using IAM Tags](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-acmpca-certificateauthority-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "KeyAlgorithm": { "MarkdownDocumentation": "`KeyAlgorithm`\n\nType of the public key algorithm and size, in bits, of the key pair that your CA\ncreates when it issues a certificate. When you create a subordinate CA, you must use a\nkey algorithm supported by the parent CA.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RSA_2048 | RSA_3072 | RSA_4...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "RSA_2048", "RSA_3072", "RSA_4096", "EC_prime256v1", "EC_secp384r1", "EC_secp521r1", "SM2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keyalgorithm", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CertificateSigningRequest": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateSigningRequest`\n\nThe Base64 PEM-encoded certificate signing request (CSR) for your certificate\nauthority certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#CertificateSigningRequest-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the private CA that issued the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#Arn-fn::getatt" } } }, "AWS::ACMPCA::CertificateAuthorityActivation": { "MarkdownDocumentation": "`AWS::ACMPCA::CertificateAuthorityActivation`\n\nThe `AWS::ACMPCA::CertificateAuthorityActivation` resource creates and\ninstalls a CA certificate on a CA. If no status is specified, the\n`AWS::ACMPCA::CertificateAuthorityActivation` resource status defaults to\nACTIVE. Once the CA has a CA certificate installed, you can use the resource to toggle\nthe CA status field between `ACTIVE` and `DISABLED`.\n", "RefReturnValue": "\nThe Amazon Resource Name (ARN) of the certificate authority.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nStatus of your private CA.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateAuthorityArn": { "MarkdownDocumentation": "`CertificateAuthorityArn`\n\nThe Amazon Resource Name (ARN) of your private CA.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificateauthorityarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CertificateChain": { "MarkdownDocumentation": "`CertificateChain`\n\nThe Base64 PEM-encoded certificate chain that chains up to the root CA certificate\nthat you used to sign your private CA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificatechain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Certificate": { "MarkdownDocumentation": "`Certificate`\n\nThe Base64 PEM-encoded certificate authority certificate.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#cfn-acmpca-certificateauthorityactivation-certificate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CompleteCertificateChain": { "PrimitiveType": "String", "MarkdownDocumentation": "`CompleteCertificateChain`\n\nThe complete Base64 PEM-encoded certificate chain, including the certificate authority\ncertificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthorityactivation.html#CompleteCertificateChain-fn::getatt" } } }, "AWS::ACMPCA::Permission": { "MarkdownDocumentation": "`AWS::ACMPCA::Permission`\n\nGrants permissions to the AWS Certificate Manager (ACM) service\nprincipal (`acm.amazonaws.com`) to perform [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html), [GetCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html), and [ListPermissions](https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html)\nactions on a CA. These actions are needed for the ACM principal to renew private PKI\ncertificates requested through ACM and residing in the same AWS account\nas the CA.\n###### About permissions\n* If the private CA and the certificates it issues reside in the same account,\n you can use `AWS::ACMPCA::Permission` to grant permissions for ACM to\n carry out automatic certificate renewals.\n* For automatic certificate renewal to succeed, the ACM service principal needs\n permissions to create, retrieve, and list permissions.\n* If the private CA and the ACM certificates reside in different accounts, then\n permissions cannot be used to enable automatic renewals. Instead, the ACM\n certificate owner must set up a resource-based policy to enable cross-account\n issuance and renewals. For more information, see [Using a Resource Based Policy\n with AWS Private CA](https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html).\n###### Note\nTo update an `AWS::ACMPCA::Permission` resource, you must first delete\nthe existing permission resource from the CloudFormation stack and then create a new\npermission resource with updated properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html", "Properties": { "CertificateAuthorityArn": { "MarkdownDocumentation": "`CertificateAuthorityArn`\n\nThe Amazon Resource Number (ARN) of the private CA from which the permission was\nissued.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:acm-pca:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*`\n*Minimum*: `5`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-certificateauthorityarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe private CA actions that can be performed by the designated AWS\nservice. Supported actions are `IssueCertificate`,\n`GetCertificate`, and `ListPermissions`.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `3`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-actions", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SourceAccount": { "MarkdownDocumentation": "`SourceAccount`\n\nThe ID of the account that assigned the permission.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9]+`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-sourceaccount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe AWS service or entity that holds the permission. At this time, the only valid\nprincipal is `acm.amazonaws.com`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^*]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-permission.html#cfn-acmpca-permission-principal", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AIOps::InvestigationGroup": { "MarkdownDocumentation": "`AWS::AIOps::InvestigationGroup`\n\nCreates an *investigation group* in your account. Creating an\ninvestigation group is a one-time setup task for each Region in your account. It is a\nnecessary task to be able to perform investigations.\nSettings in the investigation group help you centrally manage the common properties of\nyour investigations, such as the following:\n* Who can access the investigations\n* Whether investigation data is encrypted with a customer managed AWS Key Management Service key.\n* How long investigations and their data are retained by default.\nCurrently, you can have one investigation group in each Region in your account. Each\ninvestigation in a Region is a part of the investigation group in that Region\nTo create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the `AIOpsConsoleAdminPolicy` or the\n`AdministratorAccess`\nIAM policy attached, or to an account that has similar permissions.\n###### Important\nYou can configure CloudWatch alarms to start investigations and add events to\ninvestigations. If you create your investigation group with\n`CreateInvestigationGroup` and you want to enable alarms to do this, you\nmust use `PutInvestigationGroupPolicy` to create a resource policy that grants this\npermission to CloudWatch alarms.\nFor more information about configuring CloudWatch alarms,\nsee [Using Amazon CloudWatch alarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the investigation group. For example,\n`arn:aws:aiops:Region:account-id:investigation-group:investigation-group-id`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html", "Properties": { "RetentionInDays": { "MarkdownDocumentation": "`RetentionInDays`\n\nSpecifies how long that investigation data is kept.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-retentionindays", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "CrossAccountConfigurations": { "MarkdownDocumentation": "`CrossAccountConfigurations`\n\nList of `sourceRoleArn` values that have been configured for cross-account access.\n*Required*: No\n*Type*: Array of [CrossAccountConfiguration](./aws-properties-aiops-investigationgroup-crossaccountconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-crossaccountconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CrossAccountConfiguration", "DuplicatesAllowed": false }, "InvestigationGroupPolicy": { "MarkdownDocumentation": "`InvestigationGroupPolicy`\n\nReturns the JSON of the IAM resource policy associated with the specified\ninvestigation group in a string. For example, `{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":[{\\\"Effect\\\":\\\"Allow\\\",\\\"Principal\\\":{\\\"Service\\\":\\\"aiops.alarms.cloudwatch.amazonaws.com\\\"},\\\"Action\\\":[\\\"aiops:CreateInvestigation\\\",\\\"aiops:CreateInvestigationEvent\\\"],\\\"Resource\\\":\\\"*\\\",\\\"Condition\\\":{\\\"StringEquals\\\":{\\\"aws:SourceAccount\\\":\\\"111122223333\\\"},\\\"ArnLike\\\":{\\\"aws:SourceArn\\\":\\\"arn:aws:cloudwatch:us-east-1:111122223333: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-investigationgrouppolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ChatbotNotificationChannels": { "MarkdownDocumentation": "`ChatbotNotificationChannels`\n\nUse this property to integrate CloudWatch investigations with chat applications. This\nproperty is an array. For the first string, specify the ARN of an Amazon SNS\ntopic. For the array of strings, specify the ARNs of one or more chat applications\nconfigurations that you want to associate with that topic. For more information about\nthese configuration ARNs, see [Getting started with Amazon Q in chat applications](https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html) and [Resource type defined by AWS Chatbot](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies).\n*Required*: No\n*Type*: Array of [ChatbotNotificationChannel](./aws-properties-aiops-investigationgroup-chatbotnotificationchannel.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-chatbotnotificationchannels", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ChatbotNotificationChannel", "DuplicatesAllowed": false }, "IsCloudTrailEventHistoryEnabled": { "MarkdownDocumentation": "`IsCloudTrailEventHistoryEnabled`\n\nSpecify `true` to enable CloudWatch investigations to have access to change events that are\nrecorded by CloudTrail. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-iscloudtraileventhistoryenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TagKeyBoundaries": { "MarkdownDocumentation": "`TagKeyBoundaries`\n\nDisplays the custom tag keys for custom applications in your system that you have\nspecified in the investigation group. Resource tags help CloudWatch investigations narrow the\nsearch space when it is unable to discover definite relationships between resources.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-tagkeyboundaries", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EncryptionConfig": { "MarkdownDocumentation": "`EncryptionConfig`\n\nSpecifies the customer managed AWS KMS key that the investigation group uses\nto encrypt data, if there is one. If not, the investigation group uses an AWS key to encrypt the data.\n*Required*: No\n*Type*: [EncryptionConfigMap](./aws-properties-aiops-investigationgroup-encryptionconfigmap.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-encryptionconfig", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfigMap" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that the investigation group uses for permissions\nto gather data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value pairs to associate with the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-aiops-investigationgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nSpecify either the name or the ARN of the investigation group that you want to\nview. This is used to set the name of the investigation group.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "LastModifiedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedBy`\n\nThe name of the user who created the investigation group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#LastModifiedBy-fn::getatt" }, "CreatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy`\n\nThe name of the user who created the investigation group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#CreatedBy-fn::getatt" }, "LastModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedAt`\n\nThe date and time that the investigation group was most recently modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#LastModifiedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the investigation group was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#CreatedAt-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the investigation group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#Arn-fn::getatt" } } }, "AWS::APS::AnomalyDetector": { "MarkdownDocumentation": "`AWS::APS::AnomalyDetector`\n\nAnomaly detection uses the Random Cut Forest algorithm for time-series analysis. The\nanomaly detector analyzes Amazon Managed Service for Prometheus metrics to identify unusual patterns\nand behaviors.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"Id\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe algorithm configuration of the anomaly detector.\n*Required*: Yes\n*Type*: [AnomalyDetectorConfiguration](./aws-properties-aps-anomalydetector-anomalydetectorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#cfn-aps-anomalydetector-configuration", "UpdateType": "Mutable", "Required": true, "Type": "AnomalyDetectorConfiguration" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nThe user-friendly name of the anomaly detector.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#cfn-aps-anomalydetector-alias", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MissingDataAction": { "MarkdownDocumentation": "`MissingDataAction`\n\nThe action taken when data is missing during evaluation.\n*Required*: No\n*Type*: [MissingDataAction](./aws-properties-aps-anomalydetector-missingdataaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#cfn-aps-anomalydetector-missingdataaction", "UpdateType": "Mutable", "Required": false, "Type": "MissingDataAction" }, "Labels": { "MarkdownDocumentation": "`Labels`\n\nThe Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.\n*Required*: No\n*Type*: Array of [Label](./aws-properties-aps-anomalydetector-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#cfn-aps-anomalydetector-labels", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Label", "DuplicatesAllowed": false }, "EvaluationIntervalInSeconds": { "MarkdownDocumentation": "`EvaluationIntervalInSeconds`\n\nThe frequency, in seconds, at which the anomaly detector evaluates metrics.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#cfn-aps-anomalydetector-evaluationintervalinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags applied to the anomaly detector.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-aps-anomalydetector-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#cfn-aps-anomalydetector-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Workspace": { "MarkdownDocumentation": "`Workspace`\n\nAn Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server\ndedicated to ingesting, storing, and querying your Prometheus-compatible metrics.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#cfn-aps-anomalydetector-workspace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the anomaly detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-anomalydetector.html#Arn-fn::getatt" } } }, "AWS::APS::ResourcePolicy": { "MarkdownDocumentation": "`AWS::APS::ResourcePolicy`\n\nUse resource-based policies to grant permissions to other AWS accounts\nor services to access your workspace.\nOnly Prometheus-compatible APIs can be used for workspace sharing. You can add\nnon-Prometheus-compatible APIs to the policy, but they will be ignored. For more\ninformation, see [Prometheus-compatible APIs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference-Prometheus-Compatible-Apis.html) in the *Amazon Managed Service for Prometheus User\nGuide*.\nIf your workspace uses customer-managed AWS KMS keys for encryption, you\nmust grant the principals in your resource-based policy access to those AWS KMS keys. You can do this by creating AWS KMS grants. For more information,\nsee [CreateGrant](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html) in the *AWS KMS API Reference*\nand [Encryption at rest](https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html) in the *Amazon Managed Service for Prometheus User\nGuide*.\nFor more information about working with IAM, see [Using Amazon Managed Service for Prometheus with IAM](https://docs.aws.amazon.com/prometheus/latest/userguide/security_iam_service-with-iam.html) in the *Amazon Managed Service for Prometheus User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-resourcepolicy.html", "Properties": { "WorkspaceArn": { "MarkdownDocumentation": "`WorkspaceArn`\n\nAn ARN identifying a Workspace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-resourcepolicy.html#cfn-aps-resourcepolicy-workspacearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe JSON to use as the Resource-based 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-resourcepolicy.html#cfn-aps-resourcepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::APS::RuleGroupsNamespace": { "MarkdownDocumentation": "`AWS::APS::RuleGroupsNamespace`\n\nThe definition of a rule groups namespace in an Amazon Managed Service for Prometheus\nworkspace. A rule groups namespace is associated with exactly one rules file. A\nworkspace can have multiple rule groups namespaces. For more information about rules\nfiles, see [Creating a rules\nfile](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-ruler-rulesfile.html), in the *Amazon Managed Service for Prometheus User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"Arn\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-rulegroupsnamespace.html", "Properties": { "Data": { "MarkdownDocumentation": "`Data`\n\nThe rules file used in the namespace.\nFor more details about the rules file, see [Creating a rules\nfile](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-ruler-rulesfile.html) in the *Amazon Managed Service for Prometheus 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-rulegroupsnamespace.html#cfn-aps-rulegroupsnamespace-data", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of tag keys and values that are associated with the rule groups\nnamespace.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-aps-rulegroupsnamespace-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-rulegroupsnamespace.html#cfn-aps-rulegroupsnamespace-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Workspace": { "MarkdownDocumentation": "`Workspace`\n\nThe ID of the workspace to add the rule groups namespace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-rulegroupsnamespace.html#cfn-aps-rulegroupsnamespace-workspace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule groups namespace.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-rulegroupsnamespace.html#cfn-aps-rulegroupsnamespace-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the rule groups namespace. For example,\n`arn:aws:aps::123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-rulegroupsnamespace.html#Arn-fn::getatt" } } }, "AWS::APS::Scraper": { "MarkdownDocumentation": "`AWS::APS::Scraper`\n\nA scraper is a fully-managed agentless collector that discovers and pulls metrics\nautomatically. A scraper pulls metrics from Prometheus-compatible sources within an\nAmazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus\nworkspace. Scrapers are flexible. You can configure the scraper to control what metrics\nare collected, the frequency of collection, what transformations are applied to the\nmetrics, and more.\nAn IAM role will be created for you that Amazon Managed Service for Prometheus uses to\naccess the metrics in your cluster. You must configure this role with a policy that\nallows it to scrape metrics from your cluster. For more information, see [Configuring your Amazon EKS cluster](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-eks-setup) in the *Amazon Managed Service\nfor Prometheus User Guide*.\nThe `scrapeConfiguration` parameter contains the YAML configuration for the\nscraper.\n###### Note\nFor more information about collectors, including what metrics are collected, and\nhow to configure the scraper, see [Using an AWS managed collector](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html) in the *Amazon Managed Service\nfor Prometheus User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"Id\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html", "Properties": { "ScrapeConfiguration": { "MarkdownDocumentation": "`ScrapeConfiguration`\n\nThe configuration in use by the scraper.\n*Required*: Yes\n*Type*: [ScrapeConfiguration](./aws-properties-aps-scraper-scrapeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-scrapeconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ScrapeConfiguration" }, "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe Amazon Managed Service for Prometheus workspace the scraper sends metrics\nto.\n*Required*: Yes\n*Type*: [Destination](./aws-properties-aps-scraper-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-destination", "UpdateType": "Mutable", "Required": true, "Type": "Destination" }, "ScraperLoggingConfiguration": { "MarkdownDocumentation": "`ScraperLoggingConfiguration`\n\nThe definition of logging configuration in an Amazon Managed Service for Prometheus workspace.\n*Required*: No\n*Type*: [ScraperLoggingConfiguration](./aws-properties-aps-scraper-scraperloggingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-scraperloggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScraperLoggingConfiguration" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nAn optional user-assigned scraper alias.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z][-.0-9A-Z_a-z]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-alias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleConfiguration": { "MarkdownDocumentation": "`RoleConfiguration`\n\nThe role configuration in an Amazon Managed Service for Prometheus scraper.\n*Required*: No\n*Type*: [RoleConfiguration](./aws-properties-aps-scraper-roleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-roleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RoleConfiguration" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe Amazon EKS cluster from which the scraper collects metrics.\n*Required*: Yes\n*Type*: [Source](./aws-properties-aps-scraper-source.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-source", "UpdateType": "Immutable", "Required": true, "Type": "Source" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\n(Optional) The list of tag keys and values associated with the scraper.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-aps-scraper-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ScraperId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ScraperId`\n\nThe ID of the scraper. For example,\n`s-example1-1234-abcd-5678-ef9012abcd34`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#ScraperId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the scraper. For example,\n`arn:aws:aps::123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#Arn-fn::getatt" }, "RoleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the\nscraper to discover and collect metrics on your behalf.\nFor example,\n`arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#RoleArn-fn::getatt" } } }, "AWS::APS::Workspace": { "MarkdownDocumentation": "`AWS::APS::Workspace`\n\nAn Amazon Managed Service for Prometheus workspace is a logical and isolated\nPrometheus server dedicated to ingesting, storing, and querying your\nPrometheus-compatible metrics.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"Id\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\n(optional) The ARN for a customer managed AWS KMS key to use for encrypting\ndata within your workspace. For more information about using your own key in your\nworkspace, see [Encryption at rest](https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html) in the *Amazon Managed Service for Prometheus\nUser Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "QueryLoggingConfiguration": { "MarkdownDocumentation": "`QueryLoggingConfiguration`\n\nThe definition of logging configuration in an Amazon Managed Service for Prometheus\nworkspace.\n*Required*: No\n*Type*: [QueryLoggingConfiguration](./aws-properties-aps-workspace-queryloggingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-queryloggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "QueryLoggingConfiguration" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nThe alias that is assigned to this workspace to help identify it. It does not need to\nbe unique.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-alias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoggingConfiguration": { "MarkdownDocumentation": "`LoggingConfiguration`\n\nContains information about the logging configuration for the workspace.\n*Required*: No\n*Type*: [LoggingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-loggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LoggingConfiguration" }, "WorkspaceConfiguration": { "MarkdownDocumentation": "`WorkspaceConfiguration`\n\nUse this structure to define label sets and the ingestion limits for time series that\nmatch label sets, and to specify the retention period of the workspace.\n*Required*: No\n*Type*: [WorkspaceConfiguration](./aws-properties-aps-workspace-workspaceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-workspaceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WorkspaceConfiguration" }, "AlertManagerDefinition": { "MarkdownDocumentation": "`AlertManagerDefinition`\n\nThe alert manager definition, a YAML configuration for the alert manager in your\nAmazon Managed Service for Prometheus workspace.\nFor details about the alert manager definition, see [Creating an alert\nmanager configuration files](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-config.html) in the *Amazon Managed Service for Prometheus User\nGuide*.\nThe following example shows part of a CloudFormation YAML file with an embedded alert\nmanager definition (following the `- |-`).\n```\n Workspace:\n Type: AWS::APS::Workspace\n ....\n Properties:\n ....\n AlertManagerDefinition:\n Fn::Sub:\n - |-\n alertmanager_config: |\n templates:\n - 'default_template'\n route:\n receiver: example-sns\n receivers:\n - name: example-sns\n sns_configs:\n - topic_arn: 'arn:aws:sns:${AWS::Region}:${AWS::AccountId}:${TopicName}'\n -\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-alertmanagerdefinition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of tag keys and values that are associated with the workspace.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-aps-workspace-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "PrometheusEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrometheusEndpoint`\n\nThe Prometheus endpoint available for this workspace. For example,\n`https://aps-workspaces..amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#PrometheusEndpoint-fn::getatt" }, "WorkspaceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`WorkspaceId`\n\nThe unique ID for the workspace. For example,\n`ws-example1-1234-abcd-5678-ef90abcd1234`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#WorkspaceId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the workspace. For example,\n`arn:aws:aps::123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#Arn-fn::getatt" } } }, "AWS::ARCRegionSwitch::Plan": { "MarkdownDocumentation": "`AWS::ARCRegionSwitch::Plan`\n\nRepresents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the plan.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrimaryRegion": { "MarkdownDocumentation": "`PrimaryRegion`\n\nThe primary Region for a plan.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z]{2}-[a-z-]+-\\d+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-primaryregion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Workflows": { "MarkdownDocumentation": "`Workflows`\n\nThe workflows for a plan.\n*Required*: Yes\n*Type*: Array of [Workflow](./aws-properties-arcregionswitch-plan-workflow.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-workflows", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Workflow", "DuplicatesAllowed": true }, "RecoveryTimeObjectiveMinutes": { "MarkdownDocumentation": "`RecoveryTimeObjectiveMinutes`\n\nThe recovery time objective for a plan.\n*Required*: No\n*Type*: Number\n*Minimum*: `1`\n*Maximum*: `10080`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-recoverytimeobjectiveminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Regions": { "MarkdownDocumentation": "`Regions`\n\nThe AWS Regions for a plan.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `2`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-regions", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Triggers": { "MarkdownDocumentation": "`Triggers`\n\nThe triggers for a plan.\n*Required*: No\n*Type*: Array of [Trigger](./aws-properties-arcregionswitch-plan-trigger.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-triggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Trigger", "DuplicatesAllowed": true }, "AssociatedAlarms": { "MarkdownDocumentation": "`AssociatedAlarms`\n\nThe associated application health alarms for a plan.\n*Required*: No\n*Type*: Object of [AssociatedAlarm](./aws-properties-arcregionswitch-plan-associatedalarm.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-associatedalarms", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "AssociatedAlarm" }, "RecoveryApproach": { "MarkdownDocumentation": "`RecoveryApproach`\n\nThe recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `activeActive | activePassiv...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "activeActive", "activePassive" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-recoveryapproach", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ReportConfiguration": { "MarkdownDocumentation": "`ReportConfiguration`\n\nThe report configuration for a plan.\n*Required*: No\n*Type*: [ReportConfiguration](./aws-properties-arcregionswitch-plan-reportconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-reportconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReportConfiguration" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe execution role for a plan.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-zA-Z0-9-]*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for a plan.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?$`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Owner": { "PrimitiveType": "String", "MarkdownDocumentation": "`Owner`\n\nThe owner of a plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#Owner-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version for the plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#Version-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#Arn-fn::getatt" }, "PlanHealthChecks": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`PlanHealthChecks`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#PlanHealthChecks-fn::getatt" } } }, "AWS::ARCZonalShift::AutoshiftObserverNotificationStatus": { "MarkdownDocumentation": "`AWS::ARCZonalShift::AutoshiftObserverNotificationStatus`\n\nThe `AWS::ARCZonalShift::AutoshiftObserverNotificationStatus` resource Property description not available. for ARCZonalShift.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-autoshiftobservernotificationstatus.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-autoshiftobservernotificationstatus.html#cfn-arczonalshift-autoshiftobservernotificationstatus-status", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-autoshiftobservernotificationstatus.html#AccountId-fn::getatt" }, "Region": { "PrimitiveType": "String", "MarkdownDocumentation": "`Region`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-autoshiftobservernotificationstatus.html#Region-fn::getatt" } } }, "AWS::ARCZonalShift::ZonalAutoshiftConfiguration": { "MarkdownDocumentation": "`AWS::ARCZonalShift::ZonalAutoshiftConfiguration`\n\nThe zonal autoshift configuration for a resource includes the practice run configuration and the status for\nrunning autoshifts, zonal autoshift status. When a resource has a practice run configuation, ARC\nstarts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice\nruns help you to make sure that your application can continue to operate normally with the loss of one\nAvailability Zone.\nYou can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal\nautoshift is `ENABLED`, you authorize AWS to shift away resource traffic for\nan application from an Availability Zone during events, on your behalf, to help reduce time to recovery.\nTraffic is also shifted away for the required weekly practice runs.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the resource.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-zonalautoshiftconfiguration.html", "Properties": { "ResourceIdentifier": { "MarkdownDocumentation": "`ResourceIdentifier`\n\nThe identifier for the resource that AWS shifts traffic for. The identifier is the Amazon Resource Name (ARN)\nfor the resource.\nAt this time, supported resources are Network Load Balancers and Application Load Balancers.\n*Required*: No\n*Type*: String\n*Minimum*: `8`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-zonalautoshiftconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-resourceidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ZonalAutoshiftStatus": { "MarkdownDocumentation": "`ZonalAutoshiftStatus`\n\nWhen zonal autoshift is `ENABLED`, you authorize AWS to shift away resource traffic for\nan application from an Availability Zone during events, on your behalf, to help reduce time to recovery.\nTraffic is also shifted away for the required weekly practice runs.\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)\n", "RefReturnValue": "", "AllowedValues": [ "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-zonalautoshiftconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-zonalautoshiftstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PracticeRunConfiguration": { "MarkdownDocumentation": "`PracticeRunConfiguration`\n\nA practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice\nrun, as well as any blocked dates or blocked windows for the practice run. When a resource has a practice run\nconfiguration, ARC shifts traffic for the resource weekly for practice runs.\nPractice runs are required for zonal autoshift. The zonal shifts that ARC starts for practice runs help you to ensure that\nshifting away traffic from an Availability Zone during an autoshift is safe for your application.\nYou can update or delete a practice run configuration. Before you delete a practice run configuration, you\nmust disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.\n*Required*: No\n*Type*: [PracticeRunConfiguration](./aws-properties-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-zonalautoshiftconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PracticeRunConfiguration" } } }, "AWS::AccessAnalyzer::Analyzer": { "MarkdownDocumentation": "`AWS::AccessAnalyzer::Analyzer`\n\nThe `AWS::AccessAnalyzer::Analyzer` resource specifies a new analyzer. The\nanalyzer is an object that represents the IAM Access Analyzer feature. An analyzer is\nrequired for Access Analyzer to become operational.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the analyzer created.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html", "Properties": { "ArchiveRules": { "MarkdownDocumentation": "`ArchiveRules`\n\nSpecifies the archive rules to add for the analyzer. Archive rules automatically archive\nfindings that meet the criteria you define for the rule.\n*Required*: No\n*Type*: Array of [ArchiveRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-archiverules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ArchiveRule", "DuplicatesAllowed": true }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type represents the zone of trust for the analyzer.\n*Allowed Values*: ACCOUNT | ORGANIZATION | ACCOUNT\\_UNUSED\\_ACCESS |\nACCOUNT\\_INTERNAL\\_ACCESS | ORGANIZATION\\_INTERNAL\\_ACCESS |\nORGANIZATION\\_UNUSED\\_ACCESS\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AnalyzerName": { "MarkdownDocumentation": "`AnalyzerName`\n\nThe name of the analyzer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-analyzername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the analyzer. You can use the set of Unicode\nletters, digits, whitespace, `_`, `.`, `/`,\n`=`, `+`, and `-`.\nFor the tag key, you can specify a value that is 1 to 128 characters in length and\ncannot be prefixed with `aws:`.\nFor the tag value, you can specify a value that is 0 to 256 characters in length.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-accessanalyzer-analyzer-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AnalyzerConfiguration": { "MarkdownDocumentation": "`AnalyzerConfiguration`\n\nContains information about the configuration of an analyzer for an AWS organization or\naccount.\n*Required*: No\n*Type*: [AnalyzerConfiguration](./aws-properties-accessanalyzer-analyzer-analyzerconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-analyzerconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "AnalyzerConfiguration" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the analyzer that was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#Arn-fn::getatt" } } }, "AWS::AmazonMQ::Broker": { "MarkdownDocumentation": "`AWS::AmazonMQ::Broker`\n\nCreates a broker. Note: This API is asynchronous.\nTo create a broker, you must either use the `AmazonMQFullAccess` IAM\npolicy or include the following EC2 permissions in your IAM policy.\n* `ec2:CreateNetworkInterface`\n \n This permission is required to allow Amazon MQ to create an elastic network\n interface (ENI) on behalf of your account.\n* `ec2:CreateNetworkInterfacePermission`\n \n This permission is required to attach the ENI to the broker instance.\n* `ec2:DeleteNetworkInterface`\n* `ec2:DeleteNetworkInterfacePermission`\n* `ec2:DetachNetworkInterface`\n* `ec2:DescribeInternetGateways`\n* `ec2:DescribeNetworkInterfaces`\n* `ec2:DescribeNetworkInterfacePermissions`\n* `ec2:DescribeRouteTables`\n* `ec2:DescribeSecurityGroups`\n* `ec2:DescribeSubnets`\n* `ec2:DescribeVpcs`\nFor more information, see [Create an IAM User and Get Your AWS Credentials](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user) and [Never Modify or Delete the Amazon MQ Elastic Network Interface](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface) in the\n*Amazon MQ Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon MQ broker ID. For example:\n`b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html", "Properties": { "DataReplicationPrimaryBrokerArn": { "MarkdownDocumentation": "`DataReplicationPrimaryBrokerArn`\n\nThe Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-datareplicationprimarybrokerarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe list of rules (1 minimum, 125 maximum) that authorize connections to\nbrokers.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the\n[ActiveMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html)\nand the [RabbitMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html)\nsections in the Amazon MQ 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StorageType": { "MarkdownDocumentation": "`StorageType`\n\nThe broker's storage type.\n*Required*: No\n*Type*: String\n*Allowed values*: `EBS | EFS`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "EBS", "EFS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-storagetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nA list of information about the configuration.\n*Required*: No\n*Type*: [ConfigurationId](./aws-properties-amazonmq-broker-configurationid.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration", "UpdateType": "Mutable", "Required": false, "Type": "ConfigurationId" }, "AuthenticationStrategy": { "MarkdownDocumentation": "`AuthenticationStrategy`\n\nOptional. The authentication strategy used to secure the broker. The default is\n`SIMPLE`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-authenticationstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaintenanceWindowStartTime": { "MarkdownDocumentation": "`MaintenanceWindowStartTime`\n\nThe parameters that determine the WeeklyStartTime.\n*Required*: No\n*Type*: [MaintenanceWindow](./aws-properties-amazonmq-broker-maintenancewindow.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceWindow" }, "HostInstanceType": { "MarkdownDocumentation": "`HostInstanceType`\n\nRequired. The broker's instance type.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-hostinstancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Users": { "MarkdownDocumentation": "`Users`\n\nThe list of broker users (persons or applications) who can access queues and topics.\nFor Amazon MQ for RabbitMQ brokers, one and only one administrative user is\naccepted and created when a broker is first provisioned. All subsequent broker users are created by making\nRabbitMQ API calls directly to brokers or via the RabbitMQ web console.\nWhen OAuth 2.0 is enabled, the broker accepts one or no users.\n*Required*: No\n*Type*: Array of [User](./aws-properties-amazonmq-broker-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-users", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "User", "DuplicatesAllowed": true }, "AutoMinorVersionUpgrade": { "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nEnables automatic upgrades to new patch versions for brokers\nas new versions are released and supported by Amazon MQ.\nAutomatic upgrades occur during the scheduled maintenance window\nor after a manual broker reboot. Set to `true` by default, if no value is specified.\n###### Note\nMust be set to `true` for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-autominorversionupgrade", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Logs": { "MarkdownDocumentation": "`Logs`\n\nEnables Amazon CloudWatch logging for brokers.\n*Required*: No\n*Type*: [LogList](./aws-properties-amazonmq-broker-loglist.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs", "UpdateType": "Mutable", "Required": false, "Type": "LogList" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you\nspecify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create\nVPC endpoints for your broker with multiple subnets in the same Availability Zone.\nA SINGLE\\_INSTANCE deployment requires one subnet (for example, the default subnet).\nAn ACTIVE\\_STANDBY\\_MULTI\\_AZ Amazon MQ for ActiveMQ deployment requires two subnets.\nA CLUSTER\\_MULTI\\_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.\n###### Important\nIf you specify subnets in a [shared VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html) for a RabbitMQ broker, the associated VPC to which\nthe specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-subnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DataReplicationMode": { "MarkdownDocumentation": "`DataReplicationMode`\n\nDefines whether this broker is a part of a data replication pair.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | CRDR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "CRDR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-datareplicationmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BrokerName": { "MarkdownDocumentation": "`BrokerName`\n\nRequired. The broker's name. This value must be unique in your AWS account, 1-50\ncharacters long, must contain only letters, numbers, dashes, and underscores, and\nmust not contain white spaces, brackets, wildcard characters, or special\ncharacters.\n###### Important\nDo not add personally identifiable information (PII) or other confidential or sensitive information in broker names.\nBroker names are accessible to other AWS services, including CloudWatch Logs. Broker names are not intended to be\nused for private or sensitive data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_-]{1,50}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-brokername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LdapServerMetadata": { "MarkdownDocumentation": "`LdapServerMetadata`\n\nOptional. The metadata of the LDAP server used to authenticate and authorize\nconnections to the broker. Does not apply to RabbitMQ brokers.\n*Required*: No\n*Type*: [LdapServerMetadata](./aws-properties-amazonmq-broker-ldapservermetadata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-ldapservermetadata", "UpdateType": "Mutable", "Required": false, "Type": "LdapServerMetadata" }, "DeploymentMode": { "MarkdownDocumentation": "`DeploymentMode`\n\nRequired. The broker's deployment mode.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SINGLE_INSTANCE | ACTIVE_ST...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ", "CLUSTER_MULTI_AZ" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EngineType": { "MarkdownDocumentation": "`EngineType`\n\nRequired. The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ACTIVEMQ | RABBITMQ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ACTIVEMQ", "RABBITMQ" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-enginetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nEnables connections from applications outside of the VPC that hosts the\nbroker's subnets. Set to `false` by default, if no value is provided.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-publiclyaccessible", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "EncryptionOptions": { "MarkdownDocumentation": "`EncryptionOptions`\n\nEncryption options for the broker.\n*Required*: No\n*Type*: [EncryptionOptions](./aws-properties-amazonmq-broker-encryptionoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-encryptionoptions", "UpdateType": "Immutable", "Required": false, "Type": "EncryptionOptions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nCreate tags when creating the broker.\n*Required*: No\n*Type*: Array of [TagsEntry](./aws-properties-amazonmq-broker-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagsEntry", "DuplicatesAllowed": true } }, "Attributes": { "IpAddresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`IpAddresses`\n\nThe IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.\n`['198.51.100.2', '203.0.113.9']`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#IpAddresses-fn::getatt" }, "OpenWireEndpoints": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`OpenWireEndpoints`\n\nThe OpenWire endpoints of each broker instance as a list of strings.\n`ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#OpenWireEndpoints-fn::getatt" }, "StompEndpoints": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`StompEndpoints`\n\nThe STOMP endpoints of each broker instance as a list of strings.\n`stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#StompEndpoints-fn::getatt" }, "MqttEndpoints": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`MqttEndpoints`\n\nThe MQTT endpoints of each broker instance as a list of strings.\n`mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#MqttEndpoints-fn::getatt" }, "ConfigurationRevision": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationRevision`\n\nThe revision number of the configuration.\n`1`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#ConfigurationRevision-fn::getatt" }, "AmqpEndpoints": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`AmqpEndpoints`\n\nThe AMQP endpoints of each broker instance as a list of strings.\n`amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#AmqpEndpoints-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#Id-fn::getatt" }, "ConsoleURLs": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ConsoleURLs`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#ConsoleURLs-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the Amazon MQ broker.\n`arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#Arn-fn::getatt" }, "ConfigurationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationId`\n\nThe unique ID that Amazon MQ generates for the configuration.\n`c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#ConfigurationId-fn::getatt" }, "EngineVersionCurrent": { "PrimitiveType": "String", "MarkdownDocumentation": "`EngineVersionCurrent`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#EngineVersionCurrent-fn::getatt" }, "WssEndpoints": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`WssEndpoints`\n\nThe WSS endpoints of each broker instance as a list of strings.\n`wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#WssEndpoints-fn::getatt" } } }, "AWS::AmazonMQ::Configuration": { "MarkdownDocumentation": "`AWS::AmazonMQ::Configuration`\n\nCreates a new configuration for the specified configuration name. Amazon MQ uses\nthe default configuration (the engine type and version).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon MQ configuration ID. For example:\n`c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html", "Properties": { "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the\n[ActiveMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html)\nand the [RabbitMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html)\nsections in the Amazon MQ 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-engineversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthenticationStrategy": { "MarkdownDocumentation": "`AuthenticationStrategy`\n\nOptional. The authentication strategy associated with the configuration. The\ndefault is `SIMPLE`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-authenticationstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EngineType": { "MarkdownDocumentation": "`EngineType`\n\nRequired. The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-enginetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Data": { "MarkdownDocumentation": "`Data`\n\nAmazon MQ for Active MQ: The base64-encoded XML configuration.\nAmazon MQ for RabbitMQ: the base64-encoded Cuttlefish 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-data", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nCreate tags when creating the configuration.\n*Required*: No\n*Type*: Array of [TagsEntry](./aws-properties-amazonmq-configuration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagsEntry", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nRequired. The name of the configuration. This value can contain only alphanumeric\ncharacters, dashes, periods, underscores, and tildes (- . \\_ ~). This value must be\n1-150 characters long.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Revision": { "PrimitiveType": "String", "MarkdownDocumentation": "`Revision`\n\nThe revision number of the configuration.\n`1`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#Revision-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the Amazon MQ configuration.\n`c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the Amazon MQ configuration.\n`arn:aws:mq:us-east-2:123456789012:configuration:MyConfigurationDevelopment:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#Arn-fn::getatt" } } }, "AWS::AmazonMQ::ConfigurationAssociation": { "MarkdownDocumentation": "`AWS::AmazonMQ::ConfigurationAssociation`\n\nThe `AWS::AmazonMQ::ConfigurationAssociation` resource Property description not available. for AmazonMQ.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon MQ configurationassociation ID. For example:\n`c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html", "Properties": { "Broker": { "MarkdownDocumentation": "`Broker`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#cfn-amazonmq-configurationassociation-broker", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nReturns information about all configurations.\n*Required*: Yes\n*Type*: [ConfigurationId](./aws-properties-amazonmq-configurationassociation-configurationid.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#cfn-amazonmq-configurationassociation-configuration", "UpdateType": "Mutable", "Required": true, "Type": "ConfigurationId" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#Id-fn::getatt" } } }, "AWS::Amplify::App": { "MarkdownDocumentation": "`AWS::Amplify::App`\n\nThe AWS::Amplify::App resource specifies Apps in Amplify Hosting. An App is a\ncollection of branches.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html", "Properties": { "AutoBranchCreationConfig": { "MarkdownDocumentation": "`AutoBranchCreationConfig`\n\nSets the configuration for your automatic branch creation.\n*Required*: No\n*Type*: [AutoBranchCreationConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-autobranchcreationconfig", "UpdateType": "Mutable", "Required": false, "Type": "AutoBranchCreationConfig" }, "OauthToken": { "MarkdownDocumentation": "`OauthToken`\n\nThe OAuth token for a third-party source control system for an Amplify app. The OAuth\ntoken is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth\ntoken is not stored.\nUse `OauthToken` for repository providers other than GitHub, such as Bitbucket\nor CodeCommit. To authorize access to GitHub as your repository provider, use\n`AccessToken`.\nYou must specify either `OauthToken` or `AccessToken` when you\ncreate a new app.\nExisting Amplify apps deployed from a GitHub repository using OAuth continue to work with\nCI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For\nmore 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\nUser Guide* .\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-oauthtoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the Amplify app.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Platform": { "MarkdownDocumentation": "`Platform`\n\nThe platform for the Amplify app. For a static app, set the platform type to\n`WEB`. For a dynamic server-side rendered (SSR) app, set the platform\ntype to `WEB_COMPUTE`. For an app requiring Amplify Hosting's original SSR\nsupport only, set the platform type to `WEB_DYNAMIC`.\nIf you are deploying an SSG only app with Next.js version 14 or later, you must set\nthe platform type to `WEB_COMPUTE` and set the artifacts\n`baseDirectory` to `.next` in the application's build\nsettings. For an example of the build specification settings, see [Amplify build settings for a Next.js 14 SSG application](https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14) in the\n*Amplify Hosting User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `WEB | WEB_DYNAMIC | WEB_COM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WEB", "WEB_DYNAMIC", "WEB_COMPUTE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-platform", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableBranchAutoDeletion": { "MarkdownDocumentation": "`EnableBranchAutoDeletion`\n\nAutomatically disconnect a branch in Amplify Hosting when you delete a branch from your\nGit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-enablebranchautodeletion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "JobConfig": { "MarkdownDocumentation": "`JobConfig`\n\nThe configuration details that apply to the jobs for an Amplify app.\n*Required*: No\n*Type*: [JobConfig](./aws-properties-amplify-app-jobconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-jobconfig", "UpdateType": "Mutable", "Required": false, "Type": "JobConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Amplify app.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ComputeRoleArn": { "MarkdownDocumentation": "`ComputeRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role for an SSR app. The\nCompute role allows the Amplify Hosting compute service to securely\naccess specific AWS resources based on the role's permissions. For more\ninformation about the SSR Compute role, see [Adding an SSR Compute\nrole](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html) in the *Amplify User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-computerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Repository": { "MarkdownDocumentation": "`Repository`\n\nThe Git repository for the Amplify app.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-repository", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentVariables": { "MarkdownDocumentation": "`EnvironmentVariables`\n\nThe environment variables for the Amplify app.\nFor a list of the environment variables that are accessible to Amplify by default, see\n[Amplify\nEnvironment variables](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html) in the *Amplify Hosting User\nGuide*.\n*Required*: No\n*Type*: Array of [EnvironmentVariable](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-environmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentVariable", "DuplicatesAllowed": true }, "AccessToken": { "MarkdownDocumentation": "`AccessToken`\n\nThe personal access token for a GitHub repository for an Amplify app. The personal access\ntoken is used to authorize access to a GitHub repository using the Amplify GitHub App. The\ntoken is not stored.\nUse `AccessToken` for GitHub repositories only. To authorize access to a\nrepository provider such as Bitbucket or CodeCommit, use `OauthToken`.\nYou must specify either `AccessToken` or `OauthToken` when you\ncreate a new app.\nExisting Amplify apps deployed from a GitHub repository using OAuth continue to work with\nCI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For\nmore 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\nUser 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-accesstoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BuildSpec": { "MarkdownDocumentation": "`BuildSpec`\n\nThe build specification (build spec) for an Amplify app.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).+`\n*Minimum*: `1`\n*Maximum*: `25000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-buildspec", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomRules": { "MarkdownDocumentation": "`CustomRules`\n\nThe custom rewrite and redirect rules for an Amplify app.\n*Required*: No\n*Type*: Array of [CustomRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomRule", "DuplicatesAllowed": true }, "BasicAuthConfig": { "MarkdownDocumentation": "`BasicAuthConfig`\n\nThe credentials for basic authorization for an Amplify app. You must base64-encode the\nauthorization credentials and provide them in the format\n`user:password`.\n*Required*: No\n*Type*: [BasicAuthConfig](./aws-properties-amplify-app-basicauthconfig.html)\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-basicauthconfig", "UpdateType": "Mutable", "Required": false, "Type": "BasicAuthConfig" }, "CacheConfig": { "MarkdownDocumentation": "`CacheConfig`\n\nThe cache configuration for the Amplify app. If you don't specify the\ncache configuration `type`, Amplify uses the default\n`AMPLIFY_MANAGED` setting.\n*Required*: No\n*Type*: [CacheConfig](./aws-properties-amplify-app-cacheconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-cacheconfig", "UpdateType": "Mutable", "Required": false, "Type": "CacheConfig" }, "CustomHeaders": { "MarkdownDocumentation": "`CustomHeaders`\n\nThe custom HTTP headers for an Amplify app.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\n*Minimum*: `0`\n*Maximum*: `25000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customheaders", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tag for an Amplify app.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-amplify-app-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "IAMServiceRole": { "MarkdownDocumentation": "`IAMServiceRole`\n\nAWS Identity and Access Management (IAM) service role for the Amazon Resource Name\n(ARN) of the Amplify app.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-iamservicerole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "AppId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AppId`\n\nUnique Id for the Amplify App.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#AppId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nARN for the Amplify App.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#Arn-fn::getatt" }, "DefaultDomain": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefaultDomain`\n\nDefault domain for the Amplify App.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#DefaultDomain-fn::getatt" }, "AppName": { "PrimitiveType": "String", "MarkdownDocumentation": "`AppName`\n\nName for the Amplify App.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#AppName-fn::getatt" } } }, "AWS::Amplify::Branch": { "MarkdownDocumentation": "`AWS::Amplify::Branch`\n\nThe AWS::Amplify::Branch resource specifies a new branch within an app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the branch that is part of an Amplify app.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnablePerformanceMode": { "MarkdownDocumentation": "`EnablePerformanceMode`\n\nEnables performance mode for the branch.\nPerformance mode optimizes for faster hosting performance by keeping content cached at\nthe edge for a longer interval. When performance mode is enabled, hosting configuration\nor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableperformancemode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ComputeRoleArn": { "MarkdownDocumentation": "`ComputeRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role to assign to a branch of\nan SSR app. The SSR Compute role allows the Amplify Hosting compute\nservice to securely access specific AWS resources based on the role's\npermissions. For more information about the SSR Compute role, see [Adding an SSR Compute role](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html) in the *Amplify User\nGuide*.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-computerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Backend": { "MarkdownDocumentation": "`Backend`\n\nThe backend for a `Branch` of an Amplify app. Use for a\nbackend created from an CloudFormation stack.\nThis field is available to Amplify Gen 2 apps only. When you deploy an\napplication with Amplify Gen 2, you provision the app's backend infrastructure using\nTypescript code.\n*Required*: No\n*Type*: [Backend](./aws-properties-amplify-branch-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-backend", "UpdateType": "Mutable", "Required": false, "Type": "Backend" }, "EnvironmentVariables": { "MarkdownDocumentation": "`EnvironmentVariables`\n\nThe environment variables for the branch.\n*Required*: No\n*Type*: Array of [EnvironmentVariable](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-environmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentVariable", "DuplicatesAllowed": true }, "AppId": { "MarkdownDocumentation": "`AppId`\n\nThe unique ID for an Amplify app.\n*Required*: Yes\n*Type*: String\n*Pattern*: `d[a-z0-9]+`\n*Minimum*: `1`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-appid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PullRequestEnvironmentName": { "MarkdownDocumentation": "`PullRequestEnvironmentName`\n\nIf pull request previews are enabled for this branch, you can use this property to\nspecify a dedicated backend environment for your previews. For example, you could specify an\nenvironment named `prod`, `test`, or `dev` that you\ninitialized with the Amplify CLI and mapped to this branch.\nTo enable pull request previews, set the `EnablePullRequestPreview` property\nto `true`.\nIf you don't specify an environment, Amplify Hosting provides backend support for each\npreview by automatically provisioning a temporary backend environment. Amplify Hosting deletes\nthis environment when the pull request is closed.\nFor more information about creating backend environments, see [Feature Branch\nDeployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting\nUser Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnablePullRequestPreview": { "MarkdownDocumentation": "`EnablePullRequestPreview`\n\nSpecifies whether Amplify Hosting creates a preview for each pull request that is made\nfor this branch. If this property is enabled, Amplify deploys your app to a unique preview URL\nafter each pull request is opened. Development and QA teams can use this preview to test the\npull request before it's merged into a production or integration branch.\nTo provide backend support for your preview, Amplify automatically provisions a\ntemporary backend environment that it deletes when the pull request is closed. If you want to\nspecify a dedicated backend environment for your previews, use the\n`PullRequestEnvironmentName` property.\nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableSkewProtection": { "MarkdownDocumentation": "`EnableSkewProtection`\n\nSpecifies whether the skew protection feature is enabled for the branch.\nDeployment skew protection is available to Amplify applications to\neliminate version skew issues between client and servers in web applications. When you\napply skew protection to a branch, you can ensure that your clients always interact with\nthe correct version of server-side assets, regardless of when a deployment occurs. For\nmore information about skew protection, see [Skew protection for Amplify deployments](https://docs.aws.amazon.com/amplify/latest/userguide/skew-protection.html) in the *Amplify User\nGuide*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableskewprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableAutoBuild": { "MarkdownDocumentation": "`EnableAutoBuild`\n\nEnables 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BuildSpec": { "MarkdownDocumentation": "`BuildSpec`\n\nThe build specification (build spec) for the branch.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).+`\n*Minimum*: `1`\n*Maximum*: `25000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-buildspec", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Stage": { "MarkdownDocumentation": "`Stage`\n\nDescribes the current stage for the branch.\n*Required*: No\n*Type*: String\n*Allowed values*: `EXPERIMENTAL | BETA | PULL_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXPERIMENTAL", "BETA", "PULL_REQUEST", "PRODUCTION", "DEVELOPMENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-stage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BranchName": { "MarkdownDocumentation": "`BranchName`\n\nThe name for the branch.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?s).+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-branchname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BasicAuthConfig": { "MarkdownDocumentation": "`BasicAuthConfig`\n\nThe basic authorization credentials for a branch of an Amplify app. You must\nbase64-encode the authorization credentials and provide them in the format\n`user:password`.\n*Required*: No\n*Type*: [BasicAuthConfig](./aws-properties-amplify-branch-basicauthconfig.html)\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-basicauthconfig", "UpdateType": "Mutable", "Required": false, "Type": "BasicAuthConfig" }, "Framework": { "MarkdownDocumentation": "`Framework`\n\nThe framework for the branch.\n*Required*: No\n*Type*: String\n*Pattern*: `(?s).*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-framework", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tag for the branch.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-amplify-branch-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "BranchName": { "PrimitiveType": "String", "MarkdownDocumentation": "`BranchName`\n\nName for a branch, part of an Amplify App.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#BranchName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nARN for a branch, part of an Amplify App.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#Arn-fn::getatt" } } }, "AWS::Amplify::Domain": { "MarkdownDocumentation": "`AWS::Amplify::Domain`\n\nSpecifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html", "Properties": { "SubDomainSettings": { "MarkdownDocumentation": "`SubDomainSettings`\n\nThe setting for the subdomain.\n*Required*: Yes\n*Type*: Array of [SubDomainSetting](./aws-properties-amplify-domain-subdomainsetting.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SubDomainSetting", "DuplicatesAllowed": true }, "AppId": { "MarkdownDocumentation": "`AppId`\n\nThe unique ID for an Amplify app.\n*Required*: Yes\n*Type*: String\n*Pattern*: `d[a-z0-9]+`\n*Minimum*: `1`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-appid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AutoSubDomainIAMRole": { "MarkdownDocumentation": "`AutoSubDomainIAMRole`\n\nThe required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name\n(ARN) for automatically creating subdomains.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|^arn:.+:iam::\\d{12}:role.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomainiamrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name for the domain association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CertificateSettings": { "MarkdownDocumentation": "`CertificateSettings`\n\nThe type of SSL/TLS certificate to use for your custom domain. If you don't specify a\ncertificate type, Amplify uses the default certificate that it provisions and manages\nfor you.\n*Required*: No\n*Type*: [CertificateSettings](./aws-properties-amplify-domain-certificatesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-certificatesettings", "UpdateType": "Mutable", "Required": false, "Type": "CertificateSettings" }, "EnableAutoSubDomain": { "MarkdownDocumentation": "`EnableAutoSubDomain`\n\nEnables the automated creation of subdomains for branches.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-enableautosubdomain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AutoSubDomainCreationPatterns": { "MarkdownDocumentation": "`AutoSubDomainCreationPatterns`\n\nSets the branch patterns for automatic subdomain creation.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomaincreationpatterns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "Certificate.CertificateArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#Certificate.CertificateArn-fn::getatt" }, "UpdateStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateStatus`\n\nThe status of the domain update operation that is currently in progress. The following\nlist describes the valid update states.\nREQUESTING\\_CERTIFICATE\nThe certificate is in the process of being updated.\n\nPENDING\\_VERIFICATION\nIndicates that an Amplify managed certificate is in the\nprocess of being verified. This occurs during the creation of a custom\ndomain or when a custom domain is updated to use a managed\ncertificate.\n\nIMPORTING\\_CUSTOM\\_CERTIFICATE\nIndicates that an Amplify custom certificate is in the\nprocess of being imported. This occurs during the creation of a custom\ndomain or when a custom domain is updated to use a custom\ncertificate.\n\nPENDING\\_DEPLOYMENT\nIndicates that the subdomain or certificate changes are being\npropagated.\n\nAWAITING\\_APP\\_CNAME\nAmplify is waiting for CNAME records corresponding to\nsubdomains to be propagated. If your custom domain is on Route\u00a053,\nAmplify handles this for you automatically. For more\ninformation about custom domains, see [Setting up custom\ndomains](https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html) in the *Amplify Hosting User\nGuide*.\n\nUPDATE\\_COMPLETE\nThe certificate has been associated with a domain.\n\nUPDATE\\_FAILED\nThe certificate has failed to be provisioned or associated, and there is\nno existing active certificate to roll back to.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#UpdateStatus-fn::getatt" }, "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nName of the domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#DomainName-fn::getatt" }, "StatusReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusReason`\n\nReason for the current status of the domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#StatusReason-fn::getatt" }, "AutoSubDomainCreationPatterns": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`AutoSubDomainCreationPatterns`\n\nBranch patterns for the automatically created subdomain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#AutoSubDomainCreationPatterns-fn::getatt" }, "CertificateRecord": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateRecord`\n\nDNS Record for certificate verification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#CertificateRecord-fn::getatt" }, "AutoSubDomainIAMRole": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutoSubDomainIAMRole`\n\nThe IAM service role for the subdomain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#AutoSubDomainIAMRole-fn::getatt" }, "EnableAutoSubDomain": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`EnableAutoSubDomain`\n\nSpecifies whether the automated creation of subdomains for branches is enabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#EnableAutoSubDomain-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nARN for the Domain Association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#Arn-fn::getatt" }, "DomainStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainStatus`\n\nStatus for the Domain Association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#DomainStatus-fn::getatt" }, "Certificate.CertificateType": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#Certificate.CertificateType-fn::getatt" }, "Certificate.CertificateVerificationDNSRecord": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#Certificate.CertificateVerificationDNSRecord-fn::getatt" }, "Certificate": { "Type": "Certificate", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#Certificate-fn::getatt" } } }, "AWS::AmplifyUIBuilder::Component": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Component`\n\nThe AWS::AmplifyUIBuilder::Component resource specifies a component within an Amplify app.\nA component is a user interface (UI) element that you can customize. Use\n`ComponentChild` to configure an instance of a `Component`. A\n`ComponentChild` instance inherits the configuration of the main\n`Component`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html", "Properties": { "ComponentType": { "MarkdownDocumentation": "`ComponentType`\n\nThe type of the component. This can be an Amplify custom UI component or\nanother custom component.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-componenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SchemaVersion": { "MarkdownDocumentation": "`SchemaVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-schemaversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentName": { "MarkdownDocumentation": "`EnvironmentName`\n\nThe name of the backend environment that is a part of the Amplify\napp.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-environmentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BindingProperties": { "MarkdownDocumentation": "`BindingProperties`\n\nThe information to connect a component's properties to data at runtime. You can't specify\n`tags` as a valid property for `bindingProperties`.\n*Required*: No\n*Type*: Object of [ComponentBindingPropertiesValue](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-bindingproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ComponentBindingPropertiesValue" }, "SourceId": { "MarkdownDocumentation": "`SourceId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-sourceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Properties": { "MarkdownDocumentation": "`Properties`\n\nDescribes the component's properties. You can't specify `tags` as a valid\nproperty for `properties`.\n*Required*: No\n*Type*: Object of [ComponentProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-properties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ComponentProperty" }, "CollectionProperties": { "MarkdownDocumentation": "`CollectionProperties`\n\nThe data binding configuration for the component's properties. Use this for a collection\ncomponent. You can't specify `tags` as a valid property for\n`collectionProperties`.\n*Required*: No\n*Type*: Object of [ComponentDataConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-collectionproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ComponentDataConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the component.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Variants": { "MarkdownDocumentation": "`Variants`\n\nA list of the component's variants. A variant is a unique style configuration of a main\ncomponent.\n*Required*: No\n*Type*: Array of [ComponentVariant](./aws-properties-amplifyuibuilder-component-componentvariant.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-variants", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ComponentVariant", "DuplicatesAllowed": true }, "AppId": { "MarkdownDocumentation": "`AppId`\n\nThe unique ID of the Amplify app associated with 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-appid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Events": { "MarkdownDocumentation": "`Events`\n\nDescribes the events that can be raised on the component. Use for the workflow feature in\nAmplify Studio that allows you to bind events and actions to\ncomponents.\n*Required*: No\n*Type*: Object of [ComponentEvent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-events", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ComponentEvent" }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nDescribes the component's properties that can be overriden in a customized instance of the\ncomponent. You can't specify `tags` as a valid property for\n`overrides`.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-overrides", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Children": { "MarkdownDocumentation": "`Children`\n\nA list of the component's `ComponentChild` instances.\n*Required*: No\n*Type*: Array of [ComponentChild](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-children", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ComponentChild", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOne or more key-value pairs to use when tagging the component.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe time that the component was modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#ModifiedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time that the component was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique ID of the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#Id-fn::getatt" } } }, "AWS::AmplifyUIBuilder::Form": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Form`\n\nThe AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html", "Properties": { "FormActionType": { "MarkdownDocumentation": "`FormActionType`\n\nSpecifies whether to perform a create or update action on the form.\n*Required*: No\n*Type*: String\n*Allowed values*: `create | update...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "create", "update" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-formactiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cta": { "MarkdownDocumentation": "`Cta`\n\nThe `FormCTA` object that stores the call to action configuration for the\nform.\n*Required*: No\n*Type*: [FormCTA](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-cta", "UpdateType": "Mutable", "Required": false, "Type": "FormCTA" }, "Fields": { "MarkdownDocumentation": "`Fields`\n\nThe configuration information for the form's fields.\n*Required*: No\n*Type*: Object of [FieldConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-fields", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "FieldConfig" }, "SchemaVersion": { "MarkdownDocumentation": "`SchemaVersion`\n\nThe schema version of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-schemaversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AppId": { "MarkdownDocumentation": "`AppId`\n\nThe unique ID of the Amplify app associated with the form.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-appid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentName": { "MarkdownDocumentation": "`EnvironmentName`\n\nThe name of the backend environment that is a part of the Amplify app.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-environmentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LabelDecorator": { "MarkdownDocumentation": "`LabelDecorator`\n\nSpecifies an icon or decoration to display on the form.\n*Required*: No\n*Type*: String\n*Allowed values*: `required | optional | none...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "required", "optional", "none" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-labeldecorator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SectionalElements": { "MarkdownDocumentation": "`SectionalElements`\n\nThe configuration information for the visual helper elements for the form. These elements\nare not associated with any data.\n*Required*: No\n*Type*: Object of [SectionalElement](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-sectionalelements", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "SectionalElement" }, "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe type of data source to use to create the form.\n*Required*: No\n*Type*: [FormDataTypeConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-datatype", "UpdateType": "Mutable", "Required": false, "Type": "FormDataTypeConfig" }, "Style": { "MarkdownDocumentation": "`Style`\n\nThe configuration for the form's style.\n*Required*: No\n*Type*: [FormStyle](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-style", "UpdateType": "Mutable", "Required": false, "Type": "FormStyle" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOne or more key-value pairs to use when tagging the form data.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the form.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID for the form.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#Id-fn::getatt" } } }, "AWS::AmplifyUIBuilder::Theme": { "MarkdownDocumentation": "`AWS::AmplifyUIBuilder::Theme`\n\nThe AWS::AmplifyUIBuilder::Theme resource specifies a theme within an Amplify app. A theme\nis a collection of style settings that apply globally to the components associated with the\napp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html", "Properties": { "AppId": { "MarkdownDocumentation": "`AppId`\n\nThe unique ID for the Amplify app associated with the theme.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-appid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentName": { "MarkdownDocumentation": "`EnvironmentName`\n\nThe name of the backend environment that is a part of the Amplify\napp.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-environmentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Values": { "MarkdownDocumentation": "`Values`\n\nA list of key-value pairs that defines the properties of the theme.\n*Required*: No\n*Type*: Array of [ThemeValues](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-values", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ThemeValues", "DuplicatesAllowed": true }, "Overrides": { "MarkdownDocumentation": "`Overrides`\n\nDescribes the properties that can be overriden to customize a theme.\n*Required*: No\n*Type*: Array of [ThemeValues](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-overrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ThemeValues", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOne or more key-value pairs to use when tagging the theme.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the theme.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe time that the theme was modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#ModifiedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time that the theme was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID for the theme.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#Id-fn::getatt" } } }, "AWS::ApiGateway::Account": { "MarkdownDocumentation": "`AWS::ApiGateway::Account`\n\nThe `AWS::ApiGateway::Account` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one `AWS::ApiGateway::Account` resource per region per account.\nWhen you delete a stack containing this resource, API Gateway can still assume the provided IAM role to write API logs to CloudWatch Logs. To deny API Gateway access to write API logs to CloudWatch logs, update the permissions policies or change the IAM role to deny access.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the resource, such as `mysta-accou-01234b567890example`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html", "Properties": { "CloudWatchRoleArn": { "MarkdownDocumentation": "`CloudWatchRoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID for the account. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#Id-fn::getatt" } } }, "AWS::ApiGateway::ApiKey": { "MarkdownDocumentation": "`AWS::ApiGateway::ApiKey`\n\nThe `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distribute to clients who are executing API Gateway `Method` resources that require an API key. To specify which API key clients must use, map the API key with the `RestApi` and `Stage` resources that include the methods that require a key.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the API key ID, such as `m2m1k7sybf`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StageKeys": { "MarkdownDocumentation": "`StageKeys`\n\nDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.\n*Required*: No\n*Type*: Array of [StageKey](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StageKey", "DuplicatesAllowed": false }, "Value": { "MarkdownDocumentation": "`Value`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CustomerId": { "MarkdownDocumentation": "`CustomerId`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GenerateDistinctId": { "MarkdownDocumentation": "`GenerateDistinctId`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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*: Array of [Tag](./aws-properties-apigateway-apikey-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the API key. If you don't specify a name, 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).\n###### Important\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "APIKeyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`APIKeyId`\n\nThe ID for the API key. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#APIKeyId-fn::getatt" } } }, "AWS::ApiGateway::Authorizer": { "MarkdownDocumentation": "`AWS::ApiGateway::Authorizer`\n\nThe `AWS::ApiGateway::Authorizer` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the authorizer's ID, such as `abcde1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html", "Properties": { "ProviderARNs": { "MarkdownDocumentation": "`ProviderARNs`\n\nA 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AuthorizerCredentials": { "MarkdownDocumentation": "`AuthorizerCredentials`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdentityValidationExpression": { "MarkdownDocumentation": "`IdentityValidationExpression`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthorizerUri": { "MarkdownDocumentation": "`AuthorizerUri`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizerResultTtlInSeconds": { "MarkdownDocumentation": "`AuthorizerResultTtlInSeconds`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IdentitySource": { "MarkdownDocumentation": "`IdentitySource`\n\nThe identity source for which authorization is requested. For a `TOKEN` or\n`COGNITO_USER_POOLS` authorizer, this is required and specifies the request\nheader mapping expression for the custom header holding the authorization token submitted by\nthe client. For example, if the token header name is `Auth`, the header mapping\nexpression is `method.request.header.Auth`. For the `REQUEST`\nauthorizer, this is required when authorization caching is enabled. The value is a\ncomma-separated string of one or more mapping expressions of the specified request parameters.\nFor example, if an `Auth` header, a `Name` query string parameter are\ndefined as identity sources, this value is `method.request.header.Auth,\nmethod.request.querystring.Name`. These parameters will be used to derive the\nauthorization caching key and to perform runtime validation of the `REQUEST`\nauthorizer by verifying all of the identity-related request parameters are present, not null\nand non-empty. Only when this is true does the authorizer invoke the authorizer Lambda\nfunction, otherwise, it returns a 401 Unauthorized response without calling the Lambda\nfunction. The valid value is a string of comma-separated mapping expressions of the specified\nrequest parameters. When the authorization caching is not enabled, this property is\noptional.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nOptional 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AuthorizerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AuthorizerId`\n\nThe ID for the authorizer. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#AuthorizerId-fn::getatt" } } }, "AWS::ApiGateway::BasePathMapping": { "MarkdownDocumentation": "`AWS::ApiGateway::BasePathMapping`\n\nThe `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients who call your API\nmust use in the invocation URL. Supported only for public custom domain names.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html", "Properties": { "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Stage": { "MarkdownDocumentation": "`Stage`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BasePath": { "MarkdownDocumentation": "`BasePath`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::BasePathMappingV2": { "MarkdownDocumentation": "`AWS::ApiGateway::BasePathMappingV2`\n\nThe `AWS::ApiGateway::BasePathMappingV2` resource creates a base path that clients who call your\nAPI must use in the invocation URL. Supported only for private custom domain names.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html", "Properties": { "DomainNameArn": { "MarkdownDocumentation": "`DomainNameArn`\n\nThe ARN of the domain name for the BasePathMappingV2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-domainnamearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe private API's identifier. This identifier is unique across all of your APIs in API Gateway.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-restapiid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Stage": { "MarkdownDocumentation": "`Stage`\n\nRepresents a unique identifier for a version of a deployed private RestApi that is callable by users. The Stage must depend on the `RestApi`'s stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-stage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BasePath": { "MarkdownDocumentation": "`BasePath`\n\nThe base path name that callers of the private 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-basepath", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "BasePathMappingArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#BasePathMappingArn-fn::getatt" } } }, "AWS::ApiGateway::ClientCertificate": { "MarkdownDocumentation": "`AWS::ApiGateway::ClientCertificate`\n\nThe `AWS::ApiGateway::ClientCertificate` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the client certificate name, such as `abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apigateway-clientcertificate-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ClientCertificateId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClientCertificateId`\n\nThe ID for the client certificate. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#ClientCertificateId-fn::getatt" } } }, "AWS::ApiGateway::Deployment": { "MarkdownDocumentation": "`AWS::ApiGateway::Deployment`\n\nThe `AWS::ApiGateway::Deployment` resource deploys an API Gateway `RestApi` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the deployment ID, such as `123abc`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StageDescription": { "MarkdownDocumentation": "`StageDescription`\n\nThe description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.\n*Required*: Conditional\n*Type*: [StageDescription](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription", "UpdateType": "Mutable", "Required": false, "Type": "StageDescription" }, "StageName": { "MarkdownDocumentation": "`StageName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeploymentCanarySettings": { "MarkdownDocumentation": "`DeploymentCanarySettings`\n\nThe input configuration for a canary deployment.\n*Required*: No\n*Type*: [DeploymentCanarySettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings", "UpdateType": "Immutable", "Required": false, "Type": "DeploymentCanarySettings" } }, "Attributes": { "DeploymentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeploymentId`\n\nThe ID for the deployment. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#DeploymentId-fn::getatt" } } }, "AWS::ApiGateway::DocumentationPart": { "MarkdownDocumentation": "`AWS::ApiGateway::DocumentationPart`\n\nThe `AWS::ApiGateway::DocumentationPart` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the documentation part, such as `abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html", "Properties": { "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Properties": { "MarkdownDocumentation": "`Properties`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe location of the targeted API entity of the to-be-created documentation part.\n*Required*: Yes\n*Type*: [Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location", "UpdateType": "Immutable", "Required": true, "Type": "Location" } }, "Attributes": { "DocumentationPartId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DocumentationPartId`\n\nThe ID for the documentation part.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#DocumentationPartId-fn::getatt" } } }, "AWS::ApiGateway::DocumentationVersion": { "MarkdownDocumentation": "`AWS::ApiGateway::DocumentationVersion`\n\nThe `AWS::ApiGateway::DocumentationVersion` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DocumentationVersion": { "MarkdownDocumentation": "`DocumentationVersion`\n\nThe version identifier of the to-be-updated documentation version.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe string identifier of the associated RestApi.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApiGateway::DomainName": { "MarkdownDocumentation": "`AWS::ApiGateway::DomainName`\n\nThe `AWS::ApiGateway::DomainName` resource specifies a public custom domain name for your API in API Gateway.\nTo create a custom domain name for private APIs, use\n[AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html).\nYou can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the domain name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html", "Properties": { "OwnershipVerificationCertificateArn": { "MarkdownDocumentation": "`OwnershipVerificationCertificateArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MutualTlsAuthentication": { "MarkdownDocumentation": "`MutualTlsAuthentication`\n\nThe mutual TLS authentication configuration for a custom domain name. If specified, API Gateway\nperforms two-way authentication between the client and the server. Clients must present a\ntrusted certificate to access your API.\n*Required*: No\n*Type*: [MutualTlsAuthentication](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication", "UpdateType": "Mutable", "Required": false, "Type": "MutualTlsAuthentication" }, "RoutingMode": { "MarkdownDocumentation": "`RoutingMode`\n\nThe routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your public APIs.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASE_PATH_MAPPING_ONLY | RO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASE_PATH_MAPPING_ONLY", "ROUTING_RULE_THEN_BASE_PATH_MAPPING", "ROUTING_RULE_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-routingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityPolicy": { "MarkdownDocumentation": "`SecurityPolicy`\n\nThe Transport Layer Security (TLS) version + cipher suite for this DomainName.\n*Required*: No\n*Type*: String\n*Allowed values*: `TLS_1_0 | TLS_1_2 | Securit...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointConfiguration": { "MarkdownDocumentation": "`EndpointConfiguration`\n\nThe endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.\n*Required*: No\n*Type*: [EndpointConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EndpointConfiguration" }, "RegionalCertificateArn": { "MarkdownDocumentation": "`RegionalCertificateArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apigateway-domainname-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe reference to an AWS-managed certificate that will be used by edge-optimized endpoint or private 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointAccessMode": { "MarkdownDocumentation": "`EndpointAccessMode`\n\nThe endpoint access mode for your DomainName.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointaccessmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "RegionalHostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegionalHostedZoneId`\n\nThe region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#RegionalHostedZoneId-fn::getatt" }, "RegionalDomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegionalDomainName`\n\nThe domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#RegionalDomainName-fn::getatt" }, "DomainNameArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainNameArn`\n\nThe ARN of the domain name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#DomainNameArn-fn::getatt" }, "DistributionHostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DistributionHostedZoneId`\n\nThe region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is `Z2FDTNDATAQYW2` for all regions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#DistributionHostedZoneId-fn::getatt" }, "DistributionDomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DistributionDomainName`\n\nThe Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is `EDGE`.\nExample: `d111111abcdef8.cloudfront.net`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#DistributionDomainName-fn::getatt" } } }, "AWS::ApiGateway::DomainNameAccessAssociation": { "MarkdownDocumentation": "`AWS::ApiGateway::DomainNameAccessAssociation`\n\nThe `AWS::ApiGateway::DomainNameAccessAssociation` resource creates a domain name access\nassociation between an access association source and a private custom domain name.\nUse a domain name access\nassociation to invoke a private custom domain name while isolated from the public internet.\nYou can only create or delete a DomainNameAccessAssociation using CloudFormation. To reject a domain name\naccess association, use the AWS CLI.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the domain name access association ARN.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html", "Properties": { "DomainNameArn": { "MarkdownDocumentation": "`DomainNameArn`\n\nThe ARN of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-domainnamearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccessAssociationSource": { "MarkdownDocumentation": "`AccessAssociationSource`\n\nThe identifier of the domain name access association source. For a `VPCE`, the value is the VPC endpoint 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-accessassociationsource", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccessAssociationSourceType": { "MarkdownDocumentation": "`AccessAssociationSourceType`\n\nThe type of the domain name access association source. Only `VPCE` is currently supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VPCE`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "VPCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-accessassociationsourcetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apigateway-domainnameaccessassociation-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "DomainNameAccessAssociationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainNameAccessAssociationArn`\n\nThe access association ARN. For example:\n`arn:aws:apigateway:us-west-2:111122223333:/accessassociations/domainname/private.example.com+abcd1234/vpcesource/vpce-abcd1234efg`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#DomainNameAccessAssociationArn-fn::getatt" } } }, "AWS::ApiGateway::DomainNameV2": { "MarkdownDocumentation": "`AWS::ApiGateway::DomainNameV2`\n\nThe `AWS::ApiGateway::DomainNameV2` resource specifies a custom domain name for your private APIs\nin API Gateway. You can use a private custom domain name to provide a URL for your private API that's more\nintuitive and easier to recall.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the domain name ARN.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nA stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method\nconfiguration. You can use `Fn::ToJsonString` to enter your `policy`. For more information,\nsee [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-policy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "RoutingMode": { "MarkdownDocumentation": "`RoutingMode`\n\nThe routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASE_PATH_MAPPING_ONLY | RO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASE_PATH_MAPPING_ONLY", "ROUTING_RULE_THEN_BASE_PATH_MAPPING", "ROUTING_RULE_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-routingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nRepresents a custom domain name as a user-friendly host name of an API (RestApi).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-domainname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityPolicy": { "MarkdownDocumentation": "`SecurityPolicy`\n\nThe Transport Layer Security (TLS) version + cipher suite for this DomainName.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-securitypolicy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EndpointConfiguration": { "MarkdownDocumentation": "`EndpointConfiguration`\n\nThe endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.\n*Required*: No\n*Type*: [EndpointConfiguration](./aws-properties-apigateway-domainnamev2-endpointconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-endpointconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EndpointConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apigateway-domainnamev2-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe reference to an AWS-managed certificate that will be used by the private 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointAccessMode": { "MarkdownDocumentation": "`EndpointAccessMode`\n\nThe endpoint access mode for your DomainName.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-endpointaccessmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "DomainNameId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainNameId`\n\nThe domain name ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#DomainNameId-fn::getatt" }, "DomainNameArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainNameArn`\n\nThe ARN of the domain name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#DomainNameArn-fn::getatt" } } }, "AWS::ApiGateway::GatewayResponse": { "MarkdownDocumentation": "`AWS::ApiGateway::GatewayResponse`\n\nThe `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for your API. When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html", "Properties": { "ResponseTemplates": { "MarkdownDocumentation": "`ResponseTemplates`\n\nResponse templates of the GatewayResponse as a string-to-string map of key-value pairs.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ResponseParameters": { "MarkdownDocumentation": "`ResponseParameters`\n\nResponse parameters (paths, query strings and headers) of the GatewayResponse as a\nstring-to-string map of key-value pairs.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StatusCode": { "MarkdownDocumentation": "`StatusCode`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseType": { "MarkdownDocumentation": "`ResponseType`\n\nThe response type of the associated GatewayResponse.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEFAULT_4XX | DEFAULT_5XX |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED", "WAF_FILTERED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID for the gateway response. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#Id-fn::getatt" } } }, "AWS::ApiGateway::Method": { "MarkdownDocumentation": "`AWS::ApiGateway::Method`\n\nThe `AWS::ApiGateway::Method` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the method ID, such as `mysta-metho-01234b567890example`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html", "Properties": { "Integration": { "MarkdownDocumentation": "`Integration`\n\nRepresents an `HTTP`, `HTTP_PROXY`, `AWS`, `AWS_PROXY`, or Mock integration.\n*Required*: No\n*Type*: [Integration](./aws-properties-apigateway-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration", "UpdateType": "Mutable", "Required": false, "Type": "Integration" }, "OperationName": { "MarkdownDocumentation": "`OperationName`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestModels": { "MarkdownDocumentation": "`RequestModels`\n\nA 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AuthorizationScopes": { "MarkdownDocumentation": "`AuthorizationScopes`\n\nA 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RequestValidatorId": { "MarkdownDocumentation": "`RequestValidatorId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestParameters": { "MarkdownDocumentation": "`RequestParameters`\n\nA 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "MethodResponses": { "MarkdownDocumentation": "`MethodResponses`\n\nGets a method response associated with a given HTTP status code.\n*Required*: No\n*Type*: Array of [MethodResponse](./aws-properties-apigateway-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MethodResponse", "DuplicatesAllowed": false }, "AuthorizerId": { "MarkdownDocumentation": "`AuthorizerId`\n\nThe identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe Resource identifier for the MethodResponse 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApiKeyRequired": { "MarkdownDocumentation": "`ApiKeyRequired`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AuthorizationType": { "MarkdownDocumentation": "`AuthorizationType`\n\nThe 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*.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HttpMethod": { "MarkdownDocumentation": "`HttpMethod`\n\nThe method's HTTP verb.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ApiGateway::Model": { "MarkdownDocumentation": "`AWS::ApiGateway::Model`\n\nThe `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an API method.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the model name, such as `myModel`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the model. If you don't specify a name, 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).\n###### Important\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ApiGateway::RequestValidator": { "MarkdownDocumentation": "`AWS::ApiGateway::RequestValidator`\n\nThe `AWS::ApiGateway::RequestValidator` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the request validator, such as `abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html", "Properties": { "ValidateRequestParameters": { "MarkdownDocumentation": "`ValidateRequestParameters`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ValidateRequestBody": { "MarkdownDocumentation": "`ValidateRequestBody`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "RequestValidatorId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RequestValidatorId`\n\nThe ID for the request validator. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#RequestValidatorId-fn::getatt" } } }, "AWS::ApiGateway::Resource": { "MarkdownDocumentation": "`AWS::ApiGateway::Resource`\n\nThe `AWS::ApiGateway::Resource` resource creates a resource in an API.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ID, such as `abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html", "Properties": { "ParentId": { "MarkdownDocumentation": "`ParentId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PathPart": { "MarkdownDocumentation": "`PathPart`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceId`\n\nThe ID for the resource. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#ResourceId-fn::getatt" } } }, "AWS::ApiGateway::RestApi": { "MarkdownDocumentation": "`AWS::ApiGateway::RestApi`\n\nThe `AWS::ApiGateway::RestApi` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.\n###### Note\nOn January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `RestApi` ID, such as `a1bcdef2gh`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "BodyS3Location": { "MarkdownDocumentation": "`BodyS3Location`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinimumCompressionSize": { "MarkdownDocumentation": "`MinimumCompressionSize`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nCustom 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "CloneFrom": { "MarkdownDocumentation": "`CloneFrom`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThis 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\nAPI identifier remains unchanged.\nFor `merge`, the new API definition is merged with the existing API.\nIf you don't specify this property, a default value is chosen. For REST APIs created before\nMarch 29, 2021, the default is `overwrite`. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.\nUse the default mode 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.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisableExecuteApiEndpoint": { "MarkdownDocumentation": "`DisableExecuteApiEndpoint`\n\nSpecifies whether clients can invoke your API by using the default `execute-api` endpoint.\nBy default, clients can invoke your API with the default\n`https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a\ncustom 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FailOnWarnings": { "MarkdownDocumentation": "`FailOnWarnings`\n\nA query parameter to indicate whether to rollback the API update (`true`) or not (`false`)\nwhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BinaryMediaTypes": { "MarkdownDocumentation": "`BinaryMediaTypes`\n\nThe 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityPolicy": { "MarkdownDocumentation": "`SecurityPolicy`\n\nThe Transport Layer Security (TLS) version + cipher suite for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-securitypolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiKeySourceType": { "MarkdownDocumentation": "`ApiKeySourceType`\n\nThe source of the API key for metering requests according to a usage plan. Valid values\nare: `HEADER` to read the API key from the `X-API-Key` header of a\nrequest. `AUTHORIZER` to read the API key from the `UsageIdentifierKey`\nfrom 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointConfiguration": { "MarkdownDocumentation": "`EndpointConfiguration`\n\nA list of the endpoint types and IP address 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EndpointConfiguration" }, "Body": { "MarkdownDocumentation": "`Body`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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*: Array of [Tag](./aws-properties-apigateway-restapi-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "EndpointAccessMode": { "MarkdownDocumentation": "`EndpointAccessMode`\n\nThe endpoint access mode for your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointaccessmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "RootResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RootResourceId`\n\nThe root resource ID for a `RestApi` resource, such as `a0bc123d4e`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#RootResourceId-fn::getatt" }, "RestApiId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RestApiId`\n\nThe string identifier of the associated RestApi.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#RestApiId-fn::getatt" } } }, "AWS::ApiGateway::Stage": { "MarkdownDocumentation": "`AWS::ApiGateway::Stage`\n\nThe `AWS::ApiGateway::Stage` resource creates a stage for a deployment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the stage, such as `MyTestStage`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html", "Properties": { "DeploymentId": { "MarkdownDocumentation": "`DeploymentId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StageName": { "MarkdownDocumentation": "`StageName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RestApiId": { "MarkdownDocumentation": "`RestApiId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CanarySetting": { "MarkdownDocumentation": "`CanarySetting`\n\nSettings for the canary deployment in this stage.\n*Required*: No\n*Type*: [CanarySetting](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting", "UpdateType": "Mutable", "Required": false, "Type": "CanarySetting" }, "ClientCertificateId": { "MarkdownDocumentation": "`ClientCertificateId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Variables": { "MarkdownDocumentation": "`Variables`\n\nA 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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "DocumentationVersion": { "MarkdownDocumentation": "`DocumentationVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TracingEnabled": { "MarkdownDocumentation": "`TracingEnabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MethodSettings": { "MarkdownDocumentation": "`MethodSettings`\n\nA 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*: Array of [MethodSetting](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MethodSetting", "DuplicatesAllowed": false }, "AccessLogSetting": { "MarkdownDocumentation": "`AccessLogSetting`\n\nAccess log settings, including the access log format and access log destination ARN.\n*Required*: No\n*Type*: [AccessLogSetting](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting", "UpdateType": "Mutable", "Required": false, "Type": "AccessLogSetting" }, "CacheClusterSize": { "MarkdownDocumentation": "`CacheClusterSize`\n\nThe 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 | 6.1 | 13.5 | 28...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apigateway-stage-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "CacheClusterEnabled": { "MarkdownDocumentation": "`CacheClusterEnabled`\n\nSpecifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set `CachingEnabled` to `true` for a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::ApiGateway::UsagePlan": { "MarkdownDocumentation": "`AWS::ApiGateway::UsagePlan`\n\nThe `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.\nIn some cases clients can exceed the targets that you set. Don\u2019t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs\nand [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the usage plan ID, such as `abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Quota": { "MarkdownDocumentation": "`Quota`\n\nThe target maximum number of permitted requests per a given unit time interval.\n*Required*: No\n*Type*: [QuotaSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota", "UpdateType": "Mutable", "Required": false, "Type": "QuotaSettings" }, "ApiStages": { "MarkdownDocumentation": "`ApiStages`\n\nThe associated API stages of a usage plan.\n*Required*: No\n*Type*: Array of [ApiStage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ApiStage", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apigateway-usageplan-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Throttle": { "MarkdownDocumentation": "`Throttle`\n\nA map containing method level throttling information for API stage in a usage plan.\n*Required*: No\n*Type*: [ThrottleSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle", "UpdateType": "Mutable", "Required": false, "Type": "ThrottleSettings" }, "UsagePlanName": { "MarkdownDocumentation": "`UsagePlanName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID for the usage plan. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#Id-fn::getatt" } } }, "AWS::ApiGateway::UsagePlanKey": { "MarkdownDocumentation": "`AWS::ApiGateway::UsagePlanKey`\n\nThe `AWS::ApiGateway::UsagePlanKey` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the key and ID of the usage plan combined with a \":\", such as `123abcdef:abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html", "Properties": { "KeyType": { "MarkdownDocumentation": "`KeyType`\n\nThe type of a UsagePlanKey resource for a plan customer.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `API_KEY`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "API_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UsagePlanId": { "MarkdownDocumentation": "`UsagePlanId`\n\nThe Id of the UsagePlan resource representing the usage plan containing the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KeyId": { "MarkdownDocumentation": "`KeyId`\n\nThe Id of the UsagePlanKey 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID for the usage plan key. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#Id-fn::getatt" } } }, "AWS::ApiGateway::VpcLink": { "MarkdownDocumentation": "`AWS::ApiGateway::VpcLink`\n\nThe `AWS::ApiGateway::VpcLink` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the `Amazon API Gateway REST API Reference`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the `VpcLink`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetArns": { "MarkdownDocumentation": "`TargetArns`\n\nThe 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*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of arbitrary tags (key-value pairs) to associate with the VPC link.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apigateway-vpclink-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "VpcLinkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcLinkId`\n\nThe ID for the VPC link. For example: `abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#VpcLinkId-fn::getatt" } } }, "AWS::ApiGatewayV2::Api": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Api`\n\nThe `AWS::ApiGatewayV2::Api` resource creates an API. WebSocket APIs\nand HTTP APIs are supported. For more information about\nWebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway\nDeveloper Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer\nGuide.*\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the API ID, such as `a1bcdef2gh`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address types that can invoke the API. Use `ipv4` to allow only IPv4 addresses to\ninvoke your API, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke your API.\nDon\u2019t use IP address type for an HTTP API based on an OpenAPI specification. Instead,\nspecify the IP address type in the OpenAPI 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RouteSelectionExpression": { "MarkdownDocumentation": "`RouteSelectionExpression`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BodyS3Location": { "MarkdownDocumentation": "`BodyS3Location`\n\nThe S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a `Body` or `BodyS3Location`. If you specify\na `Body` or `BodyS3Location`, don't specify CloudFormation resources such as `AWS::ApiGatewayV2::Authorizer` or `AWS::ApiGatewayV2::Route`.\nAPI Gateway doesn't support the combination of OpenAPI and CloudFormation resources.\n*Required*: Conditional\n*Type*: [BodyS3Location](./aws-properties-apigatewayv2-api-bodys3location.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location", "UpdateType": "Mutable", "Required": false, "Type": "BodyS3Location" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BasePath": { "MarkdownDocumentation": "`BasePath`\n\nSpecifies how to interpret the base path of the API during import. Valid values are `ignore`, `prepend`, and\n`split`. The default value is `ignore`. To learn more, see [Set the OpenAPI basePath\nProperty](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FailOnWarnings": { "MarkdownDocumentation": "`FailOnWarnings`\n\nSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DisableExecuteApiEndpoint": { "MarkdownDocumentation": "`DisableExecuteApiEndpoint`\n\nSpecifies whether clients can invoke your API by using the default\n`execute-api` endpoint. By default, clients can invoke your API\nwith the default https://{api\\_id}.execute-api.{region}.amazonaws.com endpoint.\nTo require that clients use a custom domain name to invoke your API, disable the\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DisableSchemaValidation": { "MarkdownDocumentation": "`DisableSchemaValidation`\n\nAvoid validating models when creating a deployment. Supported only for WebSocket APIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the API. Required unless you specify an OpenAPI definition for `Body` or `S3BodyLocation`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Target": { "MarkdownDocumentation": "`Target`\n\nThis property is part of quick create. Quick create produces an API with an\nintegration, a default catch-all route, and a default stage which is configured to\nautomatically deploy changes. For HTTP integrations, specify a fully qualified URL.\nFor Lambda integrations, specify a function ARN. The type of the integration will be\nHTTP\\_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CredentialsArn": { "MarkdownDocumentation": "`CredentialsArn`\n\nThis property is part of quick create. It specifies the credentials required for\nthe integration, if any. For a Lambda integration, three options are available. To\nspecify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name\n(ARN). To require that the caller's identity be passed through from the request,\nspecify `arn:aws:iam::*:user/*`. To use resource-based permissions on\nsupported AWS services, specify `null`. Currently, this property is not used for HTTP\nintegrations. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CorsConfiguration": { "MarkdownDocumentation": "`CorsConfiguration`\n\nA CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.\n*Required*: No\n*Type*: [Cors](./aws-properties-apigatewayv2-api-cors.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "Cors" }, "Version": { "MarkdownDocumentation": "`Version`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProtocolType": { "MarkdownDocumentation": "`ProtocolType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RouteKey": { "MarkdownDocumentation": "`RouteKey`\n\nThis property is part of quick create. If you don't specify a\n`routeKey`, a default route of `$default` is created. The\n`$default` route acts as a catch-all for any request made to your API,\nfor a particular stage. The `$default` route key can't be modified. You\ncan add routes after creating the API, and you can update the route keys of\nadditional 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Body": { "MarkdownDocumentation": "`Body`\n\nThe OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a `Body` or `BodyS3Location`. If you specify\na `Body` or `BodyS3Location`, don't specify CloudFormation resources such as `AWS::ApiGatewayV2::Authorizer` or `AWS::ApiGatewayV2::Route`.\nAPI Gateway doesn't support the combination of OpenAPI and CloudFormation resources.\n*Required*: Conditional\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ApiKeySelectionExpression": { "MarkdownDocumentation": "`ApiKeySelectionExpression`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ApiEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApiEndpoint`\n\nThe default endpoint for an API. For example: `https://abcdef.execute-api.us-west-2.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#ApiEndpoint-fn::getatt" }, "ApiId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApiId`\n\nThe API identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#ApiId-fn::getatt" } } }, "AWS::ApiGatewayV2::ApiGatewayManagedOverrides": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::ApiGatewayManagedOverrides`\n\nThe `AWS::ApiGatewayV2::ApiGatewayManagedOverrides` resource overrides the\ndefault properties of API Gateway-managed resources that are implicitly configured for\nyou when you use quick create. When you create an API by using quick create, an\n`AWS::ApiGatewayV2::Route`, `AWS::ApiGatewayV2::Integration`,\nand `AWS::ApiGatewayV2::Stage` are created for you and associated with your\n`AWS::ApiGatewayV2::Api`. The\n`AWS::ApiGatewayV2::ApiGatewayManagedOverrides` resource enables you to\nset, or override the properties of these implicit resources. Supported only for HTTP\nAPIs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html", "Properties": { "Integration": { "Type": "IntegrationOverrides", "Required": false, "MarkdownDocumentation": "`Integration`\n\nOverrides the integration configuration for an API Gateway-managed integration.\n*Required*: No\n*Type*: [IntegrationOverrides](./aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integration", "UpdateType": "Mutable" }, "Stage": { "Type": "StageOverrides", "Required": false, "MarkdownDocumentation": "`Stage`\n\nOverrides the stage configuration for an API Gateway-managed stage.\n*Required*: No\n*Type*: [StageOverrides](./aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stage", "UpdateType": "Mutable" }, "ApiId": { "Required": true, "MarkdownDocumentation": "`ApiId`\n\nThe ID of the API for which to override the configuration of API Gateway-managed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-apiid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Route": { "Type": "RouteOverrides", "Required": false, "MarkdownDocumentation": "`Route`\n\nOverrides the route configuration for an API Gateway-managed route.\n*Required*: No\n*Type*: [RouteOverrides](./aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-route", "UpdateType": "Mutable" } } }, "AWS::ApiGatewayV2::ApiMapping": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::ApiMapping`\n\nThe `AWS::ApiGatewayV2::ApiMapping` resource contains an API mapping.\nAn API mapping relates a path of your custom domain name to a stage of your API. A\ncustom domain name can have multiple API mappings, but the paths can't overlap. A\ncustom domain can map only to APIs of the same protocol type. For more\ninformation, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API\nReference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the API mapping resource ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html", "Properties": { "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Stage": { "MarkdownDocumentation": "`Stage`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApiMappingKey": { "MarkdownDocumentation": "`ApiMappingKey`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ApiMappingId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApiMappingId`\n\nThe API mapping resource ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#ApiMappingId-fn::getatt" } } }, "AWS::ApiGatewayV2::Authorizer": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Authorizer`\n\nThe `AWS::ApiGatewayV2::Authorizer` resource creates an authorizer for a\nWebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and\n[Controlling and\nmanaging access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway\nDeveloper Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the authorizer's ID, such as\n`abcde1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html", "Properties": { "IdentityValidationExpression": { "MarkdownDocumentation": "`IdentityValidationExpression`\n\nThis parameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizerUri": { "MarkdownDocumentation": "`AuthorizerUri`\n\nThe authorizer's Uniform Resource Identifier (URI). For `REQUEST`\nauthorizers, this must be a well-formed Lambda function URI, for example,\n`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`.\nIn general, the URI has this form:\n`arn:aws:apigateway:{region}:lambda:path/{service_api}`, where *{region}* is the same as the region hosting the\nLambda function, path indicates that the remaining substring in the URI should be\ntreated as the path to the resource, including the initial `/`. For\nLambda functions, this is usually of the form\n`/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizerCredentialsArn": { "MarkdownDocumentation": "`AuthorizerCredentialsArn`\n\nSpecifies 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. Supported only for `REQUEST` authorizers.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizerType": { "MarkdownDocumentation": "`AuthorizerType`\n\nThe authorizer type. Specify `REQUEST` for a Lambda function using incoming request parameters. Specify `JWT` to use JSON Web Tokens (supported only for HTTP APIs).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "JwtConfiguration": { "MarkdownDocumentation": "`JwtConfiguration`\n\nThe `JWTConfiguration` property specifies the configuration of a JWT\nauthorizer. Required for the `JWT` authorizer type. Supported only for\nHTTP APIs.\n*Required*: No\n*Type*: [JWTConfiguration](./aws-properties-apigatewayv2-authorizer-jwtconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "JWTConfiguration" }, "AuthorizerResultTtlInSeconds": { "MarkdownDocumentation": "`AuthorizerResultTtlInSeconds`\n\nThe time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization\ncaching is disabled. If it is greater than 0, API Gateway caches authorizer\nresponses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IdentitySource": { "MarkdownDocumentation": "`IdentitySource`\n\nThe identity source for which authorization is requested.\nFor a `REQUEST` authorizer, this is optional. The value is a set of\none or more mapping expressions of the specified request parameters. The\nidentity source can be headers, query string parameters, stage variables, and\ncontext parameters. For example, if an Auth header and a Name query string\nparameter are defined as identity sources, this value is\nroute.request.header.Auth, route.request.querystring.Name for WebSocket APIs.\nFor HTTP APIs, use selection expressions prefixed with `$`, for\nexample, `$request.header.Auth`,\n`$request.querystring.Name`. These parameters are used to perform\nruntime validation for Lambda-based authorizers by verifying all of the\nidentity-related request parameters are present in the request, not null, and\nnon-empty. Only when this is true does the authorizer invoke the authorizer\nLambda function. Otherwise, it returns a 401 Unauthorized response without\ncalling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).\nFor `JWT`, a single entry that specifies where to extract the JSON\nWeb Token (JWT) from inbound requests. Currently only header-based and query\nparameter-based selections are supported, for example\n`$request.header.Authorization`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AuthorizerPayloadFormatVersion": { "MarkdownDocumentation": "`AuthorizerPayloadFormatVersion`\n\nSpecifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are `1.0` and `2.0`. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerpayloadformatversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableSimpleResponses": { "MarkdownDocumentation": "`EnableSimpleResponses`\n\nSpecifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-enablesimpleresponses", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AuthorizerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AuthorizerId`\n\nThe authorizer ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#AuthorizerId-fn::getatt" } } }, "AWS::ApiGatewayV2::Deployment": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Deployment`\n\nThe `AWS::ApiGatewayV2::Deployment` resource creates a deployment for\nan API.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the deployment ID, such as\n`123abc`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the deployment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StageName": { "MarkdownDocumentation": "`StageName`\n\nThe name of an existing stage to associate with the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-stagename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DeploymentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeploymentId`\n\nThe deployment ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#DeploymentId-fn::getatt" } } }, "AWS::ApiGatewayV2::DomainName": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::DomainName`\n\nThe `AWS::ApiGatewayV2::DomainName` resource specifies a custom domain\nname for your API in Amazon API Gateway (API Gateway).\nYou can use a custom domain name to provide a URL that's more intuitive and easier\nto recall. For more information about using custom domain names, see [Set up\nCustom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API\nGateway Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the domain name, such as\n`example.mydomain.com`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html", "Properties": { "MutualTlsAuthentication": { "MarkdownDocumentation": "`MutualTlsAuthentication`\n\nThe mutual TLS authentication configuration for a custom domain name.\n*Required*: No\n*Type*: [MutualTlsAuthentication](./aws-properties-apigatewayv2-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication", "UpdateType": "Mutable", "Required": false, "Type": "MutualTlsAuthentication" }, "RoutingMode": { "MarkdownDocumentation": "`RoutingMode`\n\nThe routing mode API Gateway uses to route traffic to your APIs.\n*Required*: No\n*Type*: String\n*Allowed values*: `API_MAPPING_ONLY | ROUTING_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "API_MAPPING_ONLY", "ROUTING_RULE_THEN_API_MAPPING", "ROUTING_RULE_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-routingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe custom domain name for your API in Amazon API Gateway. Uppercase letters and the underscore\n(`_`) character are not supported.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DomainNameConfigurations": { "MarkdownDocumentation": "`DomainNameConfigurations`\n\nThe domain name configurations.\n*Required*: No\n*Type*: Array of [DomainNameConfiguration](./aws-properties-apigatewayv2-domainname-domainnameconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DomainNameConfiguration", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags associated with a domain name.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "RegionalHostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegionalHostedZoneId`\n\nThe region-specific Amazon Route 53 Hosted Zone ID of the regional\nendpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#RegionalHostedZoneId-fn::getatt" }, "RegionalDomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegionalDomainName`\n\nThe domain name associated with the regional endpoint for this custom domain name.\nYou set up this association by adding a DNS record that points the custom domain\nname to this regional domain name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#RegionalDomainName-fn::getatt" }, "DomainNameArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainNameArn`\n\nRepresents an Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#DomainNameArn-fn::getatt" } } }, "AWS::ApiGatewayV2::Integration": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Integration`\n\nThe `AWS::ApiGatewayV2::Integration` resource creates an integration\nfor an API.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Integration resource ID, such as\n`abcd123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TemplateSelectionExpression": { "MarkdownDocumentation": "`TemplateSelectionExpression`\n\nThe template selection expression for the integration. Supported only for WebSocket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionType": { "MarkdownDocumentation": "`ConnectionType`\n\nThe type of the network connection to the integration endpoint. Specify `INTERNET` for connections through the public routable internet or\n`VPC_LINK` for private connections between API Gateway and resources 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseParameters": { "MarkdownDocumentation": "`ResponseParameters`\n\nSupported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend\nintegration before returning the response to clients. Specify a key-value map from a selection key to response\nparameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type [`ResponseParameterList`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameterlist.html). To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html).\n*Required*: No\n*Type*: Object of [ResponseParameterMap](./aws-properties-apigatewayv2-integration-responseparametermap.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-responseparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ResponseParameterMap" }, "IntegrationMethod": { "MarkdownDocumentation": "`IntegrationMethod`\n\nSpecifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to `POST`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PassthroughBehavior": { "MarkdownDocumentation": "`PassthroughBehavior`\n\nSpecifies the pass-through behavior for incoming requests based on the `Content-Type` header in the request, and the available mapping templates specified as the `requestTemplates` property on the `Integration` resource. There are three valid values: `WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, and `NEVER`. Supported only for WebSocket APIs.\n`WHEN_NO_MATCH` passes the request body for unmapped content types through to the integration backend without transformation.\n`NEVER` rejects unmapped content types with an `HTTP 415 Unsupported Media Type` response.\n`WHEN_NO_TEMPLATES` allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same `HTTP 415 Unsupported Media Type` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestParameters": { "MarkdownDocumentation": "`RequestParameters`\n\nFor WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. 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.\nFor HTTP API integrations with a specified `integrationSubtype`, request parameters are a key-value map specifying parameters that are passed to `AWS_PROXY` integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Working with AWS service integrations for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html).\nFor HTTP API integrations without a specified `integrationSubtype` request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :. where action can be `append`, `overwrite` or `remove`. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html).\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ConnectionId": { "MarkdownDocumentation": "`ConnectionId`\n\nThe ID of the VPC link for a private integration. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegrationUri": { "MarkdownDocumentation": "`IntegrationUri`\n\nFor a Lambda integration, specify the URI of a Lambda function.\nFor an HTTP integration, specify a fully-qualified URL.\nFor an HTTP API private integration, specify the ARN of an Application Load\nBalancer listener, Network Load Balancer listener, or AWS Cloud Map service. If\nyou specify the ARN of an AWS Cloud Map service, API Gateway uses\n`DiscoverInstances` to identify resources. You can use query\nparameters to target specific resources. To learn more, see [DiscoverInstances](https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). For private integrations, all resources must be\nowned by the same AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PayloadFormatVersion": { "MarkdownDocumentation": "`PayloadFormatVersion`\n\nSpecifies the format of the payload sent to an integration. Required for HTTP\nAPIs. For HTTP APIs, supported values for Lambda proxy integrations are\n`1.0` and `2.0`. For all other integrations,\n`1.0` is the only supported value. To learn more, see\n[Working with AWS Lambda proxy integrations for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CredentialsArn": { "MarkdownDocumentation": "`CredentialsArn`\n\nSpecifies 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, don't specify this parameter.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws|aws-cn|aws-us-gov):iam::[0-9]*:(role|user|group)\\/.*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestTemplates": { "MarkdownDocumentation": "`RequestTemplates`\n\nRepresents 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. Supported only for WebSocket APIs.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "TimeoutInMillis": { "MarkdownDocumentation": "`TimeoutInMillis`\n\nCustom timeout between 50 and 29,000 milliseconds for WebSocket APIs and\nbetween 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29\nseconds for WebSocket APIs and 30 seconds for HTTP APIs.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TlsConfig": { "MarkdownDocumentation": "`TlsConfig`\n\nThe TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS\nprotocol. Supported only for HTTP APIs.\n*Required*: No\n*Type*: [TlsConfig](./aws-properties-apigatewayv2-integration-tlsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-tlsconfig", "UpdateType": "Mutable", "Required": false, "Type": "TlsConfig" }, "ContentHandlingStrategy": { "MarkdownDocumentation": "`ContentHandlingStrategy`\n\nSupported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:\n`CONVERT_TO_BINARY`: Converts a response payload from a Base64-encoded string to the corresponding binary blob.\n`CONVERT_TO_TEXT`: Converts a response payload from a binary blob to a Base64-encoded string.\nIf this property is not defined, the response payload will be passed through from the integration response to the route response or method response 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegrationSubtype": { "MarkdownDocumentation": "`IntegrationSubtype`\n\nSupported only for HTTP API `AWS_PROXY` integrations. Specifies the AWS service action to invoke. To learn more, see [Integration subtype reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationsubtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IntegrationType": { "MarkdownDocumentation": "`IntegrationType`\n\nThe integration type of an integration. One of the following:\n`AWS`: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.\n`AWS_PROXY`: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.\n`HTTP`: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.\n`HTTP_PROXY`: for integrating the route or method request with an\nHTTP endpoint, with the\nclient request passed through as-is. This is also referred to as HTTP proxy\nintegration. For HTTP API private integrations, use an `HTTP_PROXY`\nintegration.\n`MOCK`: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "IntegrationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IntegrationId`\n\nThe integration ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#IntegrationId-fn::getatt" } } }, "AWS::ApiGatewayV2::IntegrationResponse": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::IntegrationResponse`\n\nThe `AWS::ApiGatewayV2::IntegrationResponse` resource updates an\nintegration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the\n*API Gateway Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the integration response resource ID, such as\n`abcd123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html", "Properties": { "ResponseTemplates": { "MarkdownDocumentation": "`ResponseTemplates`\n\nThe collection of response templates for the integration response as a string-to-string map of key-value pairs. 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*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responsetemplates", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TemplateSelectionExpression": { "MarkdownDocumentation": "`TemplateSelectionExpression`\n\nThe template selection expression for the integration response. Supported only for WebSocket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseParameters": { "MarkdownDocumentation": "`ResponseParameters`\n\nA key-value map specifying response parameters that are passed to the method\nresponse from the backend. The key is a method response header parameter name and\nthe mapped value is an integration response header value, a static value enclosed\nwithin a pair of single quotes, or a JSON expression from the integration response\nbody. The mapping key must match the pattern of\n`method.response.header.{name}`, where name is a valid and unique header name. The mapped non-static value\nmust match the pattern of\n`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*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responseparameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "ContentHandlingStrategy": { "MarkdownDocumentation": "`ContentHandlingStrategy`\n\nSupported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:\n`CONVERT_TO_BINARY`: Converts a response payload from a Base64-encoded string to the corresponding binary blob.\n`CONVERT_TO_TEXT`: Converts a response payload from a binary blob to a Base64-encoded string.\nIf this property is not defined, the response payload will be passed through from the integration response to the route response or method response 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-contenthandlingstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegrationId": { "MarkdownDocumentation": "`IntegrationId`\n\nThe integration 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IntegrationResponseKey": { "MarkdownDocumentation": "`IntegrationResponseKey`\n\nThe integration response 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationresponsekey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "IntegrationResponseId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IntegrationResponseId`\n\nThe integration response ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#IntegrationResponseId-fn::getatt" } } }, "AWS::ApiGatewayV2::Model": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Model`\n\nThe `AWS::ApiGatewayV2::Model` resource updates data model for a\nWebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the model ID, such as `abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nThe content-type for the model, for example, \"application/json\".\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-contenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe schema for the model. For application/json models, this should be JSON schema draft 4 model.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-schema", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ModelId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModelId`\n\nThe model ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#ModelId-fn::getatt" } } }, "AWS::ApiGatewayV2::Route": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Route`\n\nThe `AWS::ApiGatewayV2::Route` resource creates a route for an\nAPI.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Route resource ID, such as\n`abcd123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html", "Properties": { "Target": { "MarkdownDocumentation": "`Target`\n\nThe target for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RouteResponseSelectionExpression": { "MarkdownDocumentation": "`RouteResponseSelectionExpression`\n\nThe route response selection expression for the route. Supported only for WebSocket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestModels": { "MarkdownDocumentation": "`RequestModels`\n\nThe request models for the route. Supported only for WebSocket APIs.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "OperationName": { "MarkdownDocumentation": "`OperationName`\n\nThe operation name for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizerId": { "MarkdownDocumentation": "`AuthorizerId`\n\nThe identifier of the `Authorizer` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizationScopes": { "MarkdownDocumentation": "`AuthorizationScopes`\n\nThe authorization scopes supported by this route.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ApiKeyRequired": { "MarkdownDocumentation": "`ApiKeyRequired`\n\nSpecifies whether an API key is required for the route. Supported only for WebSocket APIs.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RouteKey": { "MarkdownDocumentation": "`RouteKey`\n\nThe route key for the route. For HTTP APIs, the route key can be either `$default`, or a combination of an HTTP method and resource path, for example, `GET /pets`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthorizationType": { "MarkdownDocumentation": "`AuthorizationType`\n\nThe authorization type for the route. For WebSocket APIs, valid values are\n`NONE` for open access, `AWS_IAM` for using AWS IAM\npermissions, and `CUSTOM` for using a Lambda\nauthorizer. For HTTP APIs, valid values are `NONE` for open access, `JWT` for using JSON Web Tokens, `AWS_IAM` for using AWS IAM\npermissions, and `CUSTOM` for using 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ModelSelectionExpression": { "MarkdownDocumentation": "`ModelSelectionExpression`\n\nThe model selection expression for the route. Supported only for WebSocket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RequestParameters": { "MarkdownDocumentation": "`RequestParameters`\n\nThe request parameters for the route. Supported only for WebSocket APIs.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } }, "Attributes": { "RouteId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RouteId`\n\nThe route ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#RouteId-fn::getatt" } } }, "AWS::ApiGatewayV2::RouteResponse": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RouteResponse`\n\nThe `AWS::ApiGatewayV2::RouteResponse` resource creates a route\nresponse for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the\n*API Gateway Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Route Response resource ID, such as\n`abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html", "Properties": { "RouteResponseKey": { "MarkdownDocumentation": "`RouteResponseKey`\n\nThe route response 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResponseParameters": { "MarkdownDocumentation": "`ResponseParameters`\n\nThe route response parameters.\n*Required*: No\n*Type*: [ParameterConstraints](./aws-properties-apigatewayv2-routeresponse-parameterconstraints.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ParameterConstraints" }, "RouteId": { "MarkdownDocumentation": "`RouteId`\n\nThe route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ModelSelectionExpression": { "MarkdownDocumentation": "`ModelSelectionExpression`\n\nThe model selection expression for the route response. Supported only for WebSocket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResponseModels": { "MarkdownDocumentation": "`ResponseModels`\n\nThe response models for the route response.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } }, "Attributes": { "RouteResponseId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RouteResponseId`\n\nThe route response ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#RouteResponseId-fn::getatt" } } }, "AWS::ApiGatewayV2::RoutingRule": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::RoutingRule`\n\nRepresents a routing rule. When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the routing rule, such as `a1b2c3e`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html", "Properties": { "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe resulting action based on matching a routing rules condition. Only InvokeApi is supported.\n*Required*: Yes\n*Type*: Array of [Action](./aws-properties-apigatewayv2-routingrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#cfn-apigatewayv2-routingrule-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Action", "DuplicatesAllowed": true }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe order in which API Gateway evaluates a rule. Priority is evaluated from the lowest value to the highest value. Rules can't have the same priority. Priority values 1-1,000,000 are supported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#cfn-apigatewayv2-routingrule-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DomainNameArn": { "MarkdownDocumentation": "`DomainNameArn`\n\nThe ARN of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#cfn-apigatewayv2-routingrule-domainnamearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe conditions of the routing rule.\n*Required*: Yes\n*Type*: Array of [Condition](./aws-properties-apigatewayv2-routingrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#cfn-apigatewayv2-routingrule-conditions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Condition", "DuplicatesAllowed": true } }, "Attributes": { "RoutingRuleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoutingRuleArn`\n\nRepresents an Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#RoutingRuleArn-fn::getatt" }, "RoutingRuleId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoutingRuleId`\n\nThe identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#RoutingRuleId-fn::getatt" } } }, "AWS::ApiGatewayV2::Stage": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::Stage`\n\nThe `AWS::ApiGatewayV2::Stage` resource specifies a stage for an API. Each stage is a named\nreference to a deployment of the API and is made available for client applications to call. To learn more, see\n[Working with stages for\nHTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) and [Deploy a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the stage name, such as\n`MyTestStage`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html", "Properties": { "ClientCertificateId": { "Required": false, "MarkdownDocumentation": "`ClientCertificateId`\n\nThe identifier of a client certificate for a `Stage`. Supported only for WebSocket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DeploymentId": { "Required": false, "MarkdownDocumentation": "`DeploymentId`\n\nThe deployment identifier for the API stage. Can't be updated if `autoDeploy` is enabled.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe description for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AccessLogSettings": { "Type": "AccessLogSettings", "Required": false, "MarkdownDocumentation": "`AccessLogSettings`\n\nSettings for logging access in this stage.\n*Required*: No\n*Type*: [AccessLogSettings](./aws-properties-apigatewayv2-stage-accesslogsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings", "UpdateType": "Mutable" }, "AutoDeploy": { "Required": false, "MarkdownDocumentation": "`AutoDeploy`\n\nSpecifies whether updates to an API automatically trigger a new deployment. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "RouteSettings": { "Required": false, "MarkdownDocumentation": "`RouteSettings`\n\nRoute settings for the stage.\n*Required*: No\n*Type*: [Json](./aws-properties-apigatewayv2-stage-routesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "StageName": { "Required": true, "MarkdownDocumentation": "`StageName`\n\nThe stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be `$default`. Maximum length is 128 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "StageVariables": { "Required": false, "MarkdownDocumentation": "`StageVariables`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "AccessPolicyId": { "Required": false, "MarkdownDocumentation": "`AccessPolicyId`\n\nThis parameter is not currently 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesspolicyid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ApiId": { "Required": true, "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DefaultRouteSettings": { "Type": "RouteSettings", "Required": false, "MarkdownDocumentation": "`DefaultRouteSettings`\n\nThe default route settings for the stage.\n*Required*: No\n*Type*: [RouteSettings](./aws-properties-apigatewayv2-stage-routesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" } } }, "AWS::ApiGatewayV2::VpcLink": { "MarkdownDocumentation": "`AWS::ApiGatewayV2::VpcLink`\n\nThe `AWS::ApiGatewayV2::VpcLink` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition\nfrom `PENDING` to `AVAILABLE` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see\n[Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)\nin the *API Gateway Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the VPC link's ID, such as\n`abcde1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html", "Properties": { "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of subnet IDs to include in the VPC link.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html#cfn-apigatewayv2-vpclink-subnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of security group IDs for the VPC link.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html#cfn-apigatewayv2-vpclink-securitygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe collection of tags. Each tag element is associated with a given resource.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html#cfn-apigatewayv2-vpclink-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html#cfn-apigatewayv2-vpclink-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "VpcLinkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcLinkId`\n\nThe VPC link ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html#VpcLinkId-fn::getatt" } } }, "AWS::AppConfig::Application": { "MarkdownDocumentation": "`AWS::AppConfig::Application`\n\nThe `AWS::AppConfig::Application` resource creates an application. In AWS AppConfig, an application is simply an organizational construct like a folder. This\norganizational construct has a relationship with some unit of executable code. For example,\nyou could create an application called MyMobileApp to organize and manage configuration data\nfor a mobile application installed by your users.\nAWS AppConfig requires that you create resources and deploy a configuration in the\nfollowing order:\n1. Create an application\n2. Create an environment\n3. Create a configuration profile\n4. Choose a pre-defined deployment strategy or create your own\n5. Deploy the configuration\nFor more information, see [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html#cfn-appconfig-application-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which\nyou define.\n*Required*: No\n*Type*: [Array](./aws-properties-appconfig-application-tags.html) of [Tags](./aws-properties-appconfig-application-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html#cfn-appconfig-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tags", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html#cfn-appconfig-application-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ApplicationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApplicationId`\n\nThe application ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-application.html#ApplicationId-fn::getatt" } } }, "AWS::AppConfig::ConfigurationProfile": { "MarkdownDocumentation": "`AWS::AppConfig::ConfigurationProfile`\n\nThe `AWS::AppConfig::ConfigurationProfile` resource creates a configuration\nprofile that enables AWS AppConfig to access the configuration source. Valid\nconfiguration sources include AWS Systems Manager (SSM) documents, SSM Parameter Store\nparameters, and Amazon S3. A configuration profile includes the following\ninformation.\n* The Uri location of the configuration data.\n* The AWS Identity and Access Management (IAM) role that provides access to the\n configuration data.\n* A validator for the configuration data. Available validators include either a JSON\n Schema or the Amazon Resource Name (ARN) of an AWS Lambda function.\nAWS AppConfig requires that you create resources and deploy a configuration in the\nfollowing order:\n1. Create an application\n2. Create an environment\n3. Create a configuration profile\n4. Choose a pre-defined deployment strategy or create your own\n5. Deploy the configuration\nFor more information, see [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the configuration profile ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html", "Properties": { "LocationUri": { "MarkdownDocumentation": "`LocationUri`\n\nA URI to locate the configuration. You can specify the following:\n* For the AWS AppConfig hosted configuration store and for feature flags,\n specify `hosted`.\n* For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in\n the format `ssm-parameter://` or the ARN.\n* For an AWS\n CodePipeline pipeline, specify the URI in the following format:\n `codepipeline`://.\n* For an AWS Secrets Manager secret, specify the URI in the following format:\n `secretsmanager`://.\n* For an Amazon S3 object, specify the URI in the following format:\n `s3:///` . Here is an example:\n `s3://amzn-s3-demo-bucket/my-app/us-east-1/my-config.json`\n* For an SSM document, specify either the document name in the format\n `ssm-document://` or the Amazon Resource Name\n (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-locationuri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of configurations contained in the profile. AWS AppConfig supports\n`feature flags` and `freeform` configurations. We recommend you\ncreate feature flag configurations to enable or disable new features and freeform\nconfigurations to distribute configurations to an application. When calling this API, enter\none 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyIdentifier": { "MarkdownDocumentation": "`KmsKeyIdentifier`\n\nThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when\nthe resource was created or updated.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-kmskeyidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Validators": { "MarkdownDocumentation": "`Validators`\n\nA list of methods for validating the configuration.\n*Required*: No\n*Type*: [Array](./aws-properties-appconfig-configurationprofile-validators.html) of [Validators](./aws-properties-appconfig-configurationprofile-validators.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-validators", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Validators", "DuplicatesAllowed": true }, "RetrievalRoleArn": { "MarkdownDocumentation": "`RetrievalRoleArn`\n\nThe ARN of an IAM role with permission to access the configuration at the specified\n`LocationUri`.\n###### Important\nA retrieval role ARN is not required for configurations stored in AWS CodePipeline or the AWS AppConfig hosted configuration store. It is required for all other sources that\nstore your configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov|aws-eusc):(iam)::\\d{12}:role[/].*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-retrievalrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeletionProtectionCheck": { "MarkdownDocumentation": "`DeletionProtectionCheck`\n\nA parameter to configure deletion protection. Deletion protection prevents a user from\ndeleting a configuration profile if your application has called either [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) or [GetConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_GetConfiguration.html) for the\nconfiguration profile during the specified interval.\nThis parameter supports the following values:\n* `BYPASS`: Instructs AWS AppConfig to bypass the deletion\n protection check and delete a configuration profile even if deletion protection would\n have otherwise prevented it.\n* `APPLY`: Instructs the deletion protection check to run, even if\n deletion protection is disabled at the account level. `APPLY` also forces\n the deletion protection check to run against resources created in the past hour,\n which are normally excluded from deletion protection checks.\n* `ACCOUNT_DEFAULT`: The default setting, which instructs AWS AppConfig to implement the deletion protection value specified in the\n `UpdateAccountSettings` API.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCOUNT_DEFAULT | APPLY | B...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACCOUNT_DEFAULT", "APPLY", "BYPASS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-deletionprotectioncheck", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationId": { "MarkdownDocumentation": "`ApplicationId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-applicationid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata to assign to the configuration profile. Tags help organize and categorize your\nAWS AppConfig resources. Each tag consists of a key and an optional value, both of\nwhich you define.\n*Required*: No\n*Type*: [Array](./aws-properties-appconfig-configurationprofile-tags.html) of [Tags](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tags", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ConfigurationProfileId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationProfileId`\n\nThe configuration profile ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#ConfigurationProfileId-fn::getatt" }, "KmsKeyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration\ndata versions in the AWS AppConfig hosted configuration store. This attribute is only\nused for `hosted` configuration types. To encrypt data managed in other\nconfiguration stores, see the documentation for how to specify an AWS KMS key\nfor that particular service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#KmsKeyArn-fn::getatt" } } }, "AWS::AppConfig::Deployment": { "MarkdownDocumentation": "`AWS::AppConfig::Deployment`\n\nThe `AWS::AppConfig::Deployment` resource starts a deployment. Starting a\ndeployment in AWS AppConfig calls the `StartDeployment` API action. This\ncall includes the IDs of the AWS AppConfig application, the environment, the\nconfiguration profile, and (optionally) the configuration data version to deploy. The call\nalso includes the ID of the deployment strategy to use, which determines how the configuration\ndata is deployed.\nAWS AppConfig monitors the distribution to all hosts and reports status. If a\ndistribution fails, then AWS AppConfig rolls back the configuration.\nAWS AppConfig requires that you create resources and deploy a configuration in the\nfollowing order:\n1. Create an application\n2. Create an environment\n3. Create a configuration profile\n4. Choose a pre-defined deployment strategy or create your own\n5. Deploy the configuration\nFor more information, see [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html", "Properties": { "DeploymentStrategyId": { "MarkdownDocumentation": "`DeploymentStrategyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-deploymentstrategyid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ConfigurationProfileId": { "MarkdownDocumentation": "`ConfigurationProfileId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationprofileid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EnvironmentId": { "MarkdownDocumentation": "`EnvironmentId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-environmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyIdentifier": { "MarkdownDocumentation": "`KmsKeyIdentifier`\n\nThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when\nthe resource was created or updated.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\\d{1}:\\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-kmskeyidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConfigurationVersion": { "MarkdownDocumentation": "`ConfigurationVersion`\n\nThe configuration version to deploy. If deploying an AWS AppConfig hosted\nconfiguration version, you can specify either the version number or version label. For all\nother configurations, you must specify the version number.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationversion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplicationId": { "MarkdownDocumentation": "`ApplicationId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-applicationid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DynamicExtensionParameters": { "MarkdownDocumentation": "`DynamicExtensionParameters`\n\nA map of dynamic extension parameter names to values to pass to associated extensions\nwith `PRE_START_DEPLOYMENT` actions.\n*Required*: No\n*Type*: [Array](./aws-properties-appconfig-deployment-dynamicextensionparameters.html) of [DynamicExtensionParameters](./aws-properties-appconfig-deployment-dynamicextensionparameters.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-dynamicextensionparameters", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "DynamicExtensionParameters", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata 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\nyou define.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appconfig-deployment-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#State-fn::getatt" }, "DeploymentNumber": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeploymentNumber`\n\nThe sequence number of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#DeploymentNumber-fn::getatt" } } }, "AWS::AppConfig::DeploymentStrategy": { "MarkdownDocumentation": "`AWS::AppConfig::DeploymentStrategy`\n\nThe `AWS::AppConfig::DeploymentStrategy` resource creates an AWS AppConfig deployment strategy. A deployment strategy defines important criteria for\nrolling out your configuration to the designated targets. A deployment strategy includes: the\noverall duration required, a percentage of targets to receive the deployment during each\ninterval, an algorithm that defines how percentage grows, and bake time.\nAWS AppConfig requires that you create resources and deploy a configuration in the\nfollowing order:\n1. Create an application\n2. Create an environment\n3. Create a configuration profile\n4. Choose a pre-defined deployment strategy or create your own\n5. Deploy the configuration\nFor more information, see [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the deployment strategy ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html", "Properties": { "ReplicateTo": { "MarkdownDocumentation": "`ReplicateTo`\n\nSave the deployment strategy to a Systems Manager (SSM) document.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | SSM_DOCUMENT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SSM_DOCUMENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-replicateto", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GrowthType": { "MarkdownDocumentation": "`GrowthType`\n\nThe algorithm used to define how percentage grows over time. AWS AppConfig\nsupports the following growth types:\n**Linear**: For this type, AWS AppConfig processes\nthe deployment by dividing the total number of targets by the value specified for\n`Step percentage`. For example, a linear deployment that uses a `Step\npercentage` of 10 deploys the configuration to 10 percent of the hosts. After\nthose deployments are complete, the system deploys the configuration to the next 10\npercent. This continues until 100% of the targets have successfully received the\nconfiguration.\n**Exponential**: For this type, AWS AppConfig\nprocesses the deployment exponentially using the following formula: `G*(2^N)`.\nIn this formula, `G` is the growth factor specified by the user and\n`N` is the number of steps until the configuration is deployed to all\ntargets. For example, if you specify a growth factor of 2, then the system rolls out the\nconfiguration 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\ntargets, 8% of the targets, and continues until the configuration has been deployed to all\ntargets.\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)", "RefReturnValue": "", "AllowedValues": [ "EXPONENTIAL", "LINEAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-growthtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeploymentDurationInMinutes": { "MarkdownDocumentation": "`DeploymentDurationInMinutes`\n\nTotal amount of time for a deployment to last.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-deploymentdurationinminutes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "GrowthFactor": { "MarkdownDocumentation": "`GrowthFactor`\n\nThe percentage of targets to receive a deployed configuration during each\ninterval.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-growthfactor", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "FinalBakeTimeInMinutes": { "MarkdownDocumentation": "`FinalBakeTimeInMinutes`\n\nSpecifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the\nconfiguration has been deployed to 100% of its targets, before considering the deployment\nto be complete. If an alarm is triggered during this time, AWS AppConfig rolls back\nthe deployment. You must configure permissions for AWS AppConfig to roll back based\non 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\n*AWS AppConfig User Guide*.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-finalbaketimeinminutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAssigns metadata to an AWS AppConfig resource. Tags help organize and categorize\nyour AWS AppConfig resources. Each tag consists of a key and an optional value, both\nof which you define. You can specify a maximum of 50 tags for a resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appconfig-deploymentstrategy-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe deployment strategy ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#Id-fn::getatt" } } }, "AWS::AppConfig::Environment": { "MarkdownDocumentation": "`AWS::AppConfig::Environment`\n\nThe `AWS::AppConfig::Environment` resource creates an environment, which is a\nlogical deployment group of AWS AppConfig targets, such as applications in a\n`Beta` or `Production` environment. You define one or more\nenvironments for each AWS AppConfig application. You can also define environments for\napplication subcomponents such as the `Web`, `Mobile` and\n`Back-end` components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a\nconfiguration deployment. If an alarm is triggered, the system rolls back the\nconfiguration.\nAWS AppConfig requires that you create resources and deploy a configuration in the\nfollowing order:\n1. Create an application\n2. Create an environment\n3. Create a configuration profile\n4. Choose a pre-defined deployment strategy or create your own\n5. Deploy the configuration\nFor more information, see [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the environment ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Monitors": { "MarkdownDocumentation": "`Monitors`\n\nAmazon CloudWatch alarms to monitor during the deployment process.\n*Required*: No\n*Type*: Array of [Monitor](./aws-properties-appconfig-environment-monitor.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-monitors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Monitor", "DuplicatesAllowed": true }, "DeletionProtectionCheck": { "MarkdownDocumentation": "`DeletionProtectionCheck`\n\nA parameter to configure deletion protection. Deletion protection prevents a user from\ndeleting an environment if your application called either [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) or [GetConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_GetConfiguration.html) in the\nenvironment during the specified interval.\nThis parameter supports the following values:\n* `BYPASS`: Instructs AWS AppConfig to bypass the deletion\n protection check and delete a configuration profile even if deletion protection would\n have otherwise prevented it.\n* `APPLY`: Instructs the deletion protection check to run, even if\n deletion protection is disabled at the account level. `APPLY` also forces\n the deletion protection check to run against resources created in the past hour,\n which are normally excluded from deletion protection checks.\n* `ACCOUNT_DEFAULT`: The default setting, which instructs AWS AppConfig to implement the deletion protection value specified in the\n `UpdateAccountSettings` API.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCOUNT_DEFAULT | APPLY | B...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACCOUNT_DEFAULT", "APPLY", "BYPASS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-deletionprotectioncheck", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationId": { "MarkdownDocumentation": "`ApplicationId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-applicationid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which\nyou define.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appconfig-environment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "EnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentId`\n\nThe environment ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#EnvironmentId-fn::getatt" } } }, "AWS::AppConfig::Extension": { "MarkdownDocumentation": "`AWS::AppConfig::Extension`\n\nCreates an AWS AppConfig extension. An extension augments your ability to inject\nlogic or behavior at different points during the AWS AppConfig workflow of creating\nor deploying a configuration.\nYou can create your own extensions or use the AWS authored extensions provided by\nAWS AppConfig. For an AWS AppConfig extension that uses AWS Lambda, you must create a Lambda function to perform any computation and processing\ndefined in the extension. If you plan to create custom versions of the AWS\nauthored notification extensions, you only need to specify an Amazon Resource Name (ARN) in\nthe `Uri` field for the new extension version.\n* For a custom EventBridge notification extension, enter the ARN of the EventBridge\n default events in the `Uri` field.\n* For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS\n topic in the `Uri` field.\n* For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS\n message queue in the `Uri` field.\nFor more information about extensions, see [Extending\nworkflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns information about the extension.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nInformation about the extension.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters accepted by the extension. You specify parameter values when you\nassociate the extension to an AWS AppConfig resource by using the\n`CreateExtensionAssociation` API action. For AWS Lambda extension\nactions, these parameters are included in the Lambda request object.\n*Required*: No\n*Type*: Object of [Parameter](./aws-properties-appconfig-extension-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "Parameter" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions defined in the extension.\n*Required*: Yes\n*Type*: Array of [Action](./aws-properties-appconfig-extension-action.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-actions", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "LatestVersionNumber": { "MarkdownDocumentation": "`LatestVersionNumber`\n\nYou can omit this field when you create an extension. When you create a new version,\nspecify the most recent current version number. For example, you create version 3, enter 2\nfor this field.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-latestversionnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAdds one or more tags for the specified extension. Tags are metadata that help you\ncategorize resources in different ways, for example, by purpose, owner, or environment.\nEach tag consists of a key and an optional value, both of which you define.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appconfig-extension-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the extension. Each extension name in your account must be unique. Extension\nversions use the same name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\/#:\\n]{1,64}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe system-generated ID of the extension.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe system-generated Amazon Resource Name (ARN) for the extension.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#Arn-fn::getatt" }, "VersionNumber": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`VersionNumber`\n\nThe extension version number.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#VersionNumber-fn::getatt" } } }, "AWS::AppConfig::ExtensionAssociation": { "MarkdownDocumentation": "`AWS::AppConfig::ExtensionAssociation`\n\nWhen you create an extension or configure an AWS authored extension, you\nassociate the extension with an AWS AppConfig application, environment, or\nconfiguration profile. For example, you can choose to run the `AWS AppConfig\ndeployment events to Amazon SNS`AWS authored extension and receive notifications on an Amazon SNS\ntopic anytime a configuration deployment is started for a specific application. Defining\nwhich extension to associate with an AWS AppConfig resource is called an\n*extension association*. An extension association is a specified\nrelationship between an extension and an AWS AppConfig resource, such as an\napplication or a configuration profile. For more information about extensions and\nassociations, see [Extending\nworkflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the *AWS AppConfig User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns information about the extension association.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html", "Properties": { "ResourceIdentifier": { "MarkdownDocumentation": "`ResourceIdentifier`\n\nThe ARN of an application, configuration profile, or environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#cfn-appconfig-extensionassociation-resourceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameter names and values defined in the extensions. Extension parameters marked\n`Required` must be entered for this field.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#cfn-appconfig-extensionassociation-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ExtensionIdentifier": { "MarkdownDocumentation": "`ExtensionIdentifier`\n\nThe name, the ID, or the Amazon Resource Name (ARN) of the extension.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#cfn-appconfig-extensionassociation-extensionidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExtensionVersionNumber": { "MarkdownDocumentation": "`ExtensionVersionNumber`\n\nThe version number of the extension. If not specified, AWS AppConfig uses the\nmaximum version of the extension.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#cfn-appconfig-extensionassociation-extensionversionnumber", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAdds one or more tags for the specified extension association. Tags are metadata that\nhelp you categorize resources in different ways, for example, by purpose, owner, or\nenvironment. Each tag consists of a key and an optional value, both of which you define.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appconfig-extensionassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#cfn-appconfig-extensionassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nThe ARNs of applications, configuration profiles, or environments defined in the\nassociation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#ResourceArn-fn::getatt" }, "ExtensionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ExtensionArn`\n\nThe ARN of the extension defined in the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#ExtensionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe system-generated ID for the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the extension defined in the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extensionassociation.html#Arn-fn::getatt" } } }, "AWS::AppConfig::HostedConfigurationVersion": { "MarkdownDocumentation": "`AWS::AppConfig::HostedConfigurationVersion`\n\nCreate a new configuration in the AWS AppConfig hosted configuration store.\nConfigurations must be 1 MB or smaller. The AWS AppConfig hosted configuration store\nprovides the following benefits over other configuration store options.\n* You don't need to set up and configure other services such as Amazon Simple Storage Service\n (Amazon S3) or Parameter Store.\n* You don't need to configure AWS Identity and Access Management (IAM)\n permissions to use the configuration store.\n* You can store configurations in any content type.\n* There is no cost to use the store.\n* You can create a configuration and add it to the store when you create a configuration\n profile.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the version number.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html", "Properties": { "ConfigurationProfileId": { "MarkdownDocumentation": "`ConfigurationProfileId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html#cfn-appconfig-hostedconfigurationversion-configurationprofileid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the configuration.\n###### Note\nDue to HTTP limitations, this field only supports ASCII characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html#cfn-appconfig-hostedconfigurationversion-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ContentType": { "MarkdownDocumentation": "`ContentType`\n\nA standard MIME type describing the format of the configuration content. For more\ninformation, see [Content-Type](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html#cfn-appconfig-hostedconfigurationversion-contenttype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LatestVersionNumber": { "MarkdownDocumentation": "`LatestVersionNumber`\n\nAn optional locking token used to prevent race conditions from overwriting configuration\nupdates when creating a new version. To ensure your data is not overwritten when creating\nmultiple hosted configuration versions in rapid succession, specify the version number of\nthe latest hosted configuration version.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html#cfn-appconfig-hostedconfigurationversion-latestversionnumber", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe configuration data, as bytes.\n###### Note\nAWS AppConfig accepts any type of data, including text formats like JSON or\nTOML, or binary formats like protocol buffers or compressed data.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html#cfn-appconfig-hostedconfigurationversion-content", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VersionLabel": { "MarkdownDocumentation": "`VersionLabel`\n\nA user-defined label for an AWS AppConfig hosted configuration version.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|.*[^0-9].*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html#cfn-appconfig-hostedconfigurationversion-versionlabel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ApplicationId": { "MarkdownDocumentation": "`ApplicationId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html#cfn-appconfig-hostedconfigurationversion-applicationid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "VersionNumber": { "PrimitiveType": "String", "MarkdownDocumentation": "`VersionNumber`\n\nThe configuration version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-hostedconfigurationversion.html#VersionNumber-fn::getatt" } } }, "AWS::AppFlow::Connector": { "MarkdownDocumentation": "`AWS::AppFlow::Connector`\n\nCreates a new connector profile associated with your AWS account. There is\na soft quota of 100 connector profiles per AWS account. If you need more\nconnector profiles than this quota allows, you can submit a request to the Amazon AppFlow\nteam through the Amazon AppFlow support channel. In each connector profile that you\ncreate, you can provide the credentials and properties for only one connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connector.html", "Properties": { "ConnectorLabel": { "MarkdownDocumentation": "`ConnectorLabel`\n\nThe label used for registering the connector.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connector.html#cfn-appflow-connector-connectorlabel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConnectorProvisioningType": { "MarkdownDocumentation": "`ConnectorProvisioningType`\n\nThe provisioning type used to register the connector.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connector.html#cfn-appflow-connector-connectorprovisioningtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description about the connector runtime setting.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\w/!@#+=.-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connector.html#cfn-appflow-connector-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectorProvisioningConfig": { "MarkdownDocumentation": "`ConnectorProvisioningConfig`\n\nThe configuration required for registering the connector.\n*Required*: Yes\n*Type*: [ConnectorProvisioningConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connector.html#cfn-appflow-connector-connectorprovisioningconfig", "UpdateType": "Mutable", "Required": true, "Type": "ConnectorProvisioningConfig" } }, "Attributes": { "ConnectorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectorArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connector.html#ConnectorArn-fn::getatt" } } }, "AWS::AppFlow::ConnectorProfile": { "MarkdownDocumentation": "`AWS::AppFlow::ConnectorProfile`\n\nThe `AWS::AppFlow::ConnectorProfile` resource is an Amazon AppFlow resource\ntype that specifies the configuration profile for an instance of a connector. This includes\nthe provided name, credentials ARN, connection-mode, and so on. The fields that are common to\nall types of connector profiles are explicitly specified under the `Properties`\nfield. The rest of the connector-specific properties are specified under\n`Properties/ConnectorProfileConfig`.\n###### Note\nIf you want to use CloudFormation to create a connector profile for connectors\nthat implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must\nfetch the access and refresh tokens. You can do this by implementing your own UI for OAuth,\nor by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow\nconsole to create the connector profile, and then use that connector profile in the flow\ncreation CloudFormation template.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the connector profile name. For example:\n`{ \"Ref\": \"myConnectorProfile\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html", "Properties": { "ConnectorLabel": { "MarkdownDocumentation": "`ConnectorLabel`\n\nThe label for the connector profile being created.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w!@#.-]+`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html#cfn-appflow-connectorprofile-connectorlabel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConnectorProfileName": { "MarkdownDocumentation": "`ConnectorProfileName`\n\nThe name of the connector profile. The name is unique for each\n`ConnectorProfile` in the AWS account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w/!@#+=.-]+`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html#cfn-appflow-connectorprofile-connectorprofilename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KMSArn": { "MarkdownDocumentation": "`KMSArn`\n\nThe ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\nencryption. This is required if you do not want to use the Amazon AppFlow-managed KMS\nkey. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws:kms:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html#cfn-appflow-connectorprofile-kmsarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectorType": { "MarkdownDocumentation": "`ConnectorType`\n\nThe type of connector, such as Salesforce, Amplitude, and so on.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Salesforce | Pardot | Singu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Salesforce", "Pardot", "Singular", "Slack", "Redshift", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "SAPOData", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "CustomConnector" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html#cfn-appflow-connectorprofile-connectortype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ConnectionMode": { "MarkdownDocumentation": "`ConnectionMode`\n\nIndicates the connection mode and if it is public or private.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Public | Private...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Public", "Private" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html#cfn-appflow-connectorprofile-connectionmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConnectorProfileConfig": { "MarkdownDocumentation": "`ConnectorProfileConfig`\n\nDefines the connector-specific configuration and credentials.\n*Required*: No\n*Type*: [ConnectorProfileConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html#cfn-appflow-connectorprofile-connectorprofileconfig", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorProfileConfig" } }, "Attributes": { "CredentialsArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CredentialsArn`\n\nThe Amazon Resource Name (ARN) of the connector profile credentials.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html#CredentialsArn-fn::getatt" }, "ConnectorProfileArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectorProfileArn`\n\nThe Amazon Resource Name (ARN) of the connector profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html#ConnectorProfileArn-fn::getatt" } } }, "AWS::AppFlow::Flow": { "MarkdownDocumentation": "`AWS::AppFlow::Flow`\n\nThe `AWS::AppFlow::Flow` resource is an Amazon AppFlow resource type that\nspecifies a new flow.\n###### Note\nIf you want to use CloudFormation to create a connector profile for connectors\nthat implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must\nfetch the access and refresh tokens. You can do this by implementing your own UI for OAuth,\nor by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow\nconsole to create the connector profile, and then use that connector profile in the flow\ncreation CloudFormation template.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the flow name. For example:\n`{ \"Ref\": \"myFlowName\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA user-entered description of the flow.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w!@#\\-.?,\\s]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KMSArn": { "MarkdownDocumentation": "`KMSArn`\n\nThe ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\nencryption. This is required if you do not want to use the Amazon AppFlow-managed KMS\nkey. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws:kms:.*:[0-9]+:.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-kmsarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tasks": { "MarkdownDocumentation": "`Tasks`\n\nA list of tasks that Amazon AppFlow performs while transferring the data in the flow\nrun.\n*Required*: Yes\n*Type*: Array of [Task](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-tasks", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Task", "DuplicatesAllowed": true }, "FlowName": { "MarkdownDocumentation": "`FlowName`\n\nThe specified name of the flow. Spaces are not allowed. Use underscores (\\_) or hyphens\n(-) only.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-flowname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TriggerConfig": { "MarkdownDocumentation": "`TriggerConfig`\n\nThe trigger settings that determine how and when Amazon AppFlow runs the specified\nflow.\n*Required*: Yes\n*Type*: [TriggerConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-triggerconfig", "UpdateType": "Mutable", "Required": true, "Type": "TriggerConfig" }, "DestinationFlowConfigList": { "MarkdownDocumentation": "`DestinationFlowConfigList`\n\nThe configuration that controls how Amazon AppFlow places data in the destination\nconnector.\n*Required*: Yes\n*Type*: Array of [DestinationFlowConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-destinationflowconfiglist", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DestinationFlowConfig", "DuplicatesAllowed": true }, "SourceFlowConfig": { "MarkdownDocumentation": "`SourceFlowConfig`\n\nContains information about the configuration of the source connector used in the flow.\n*Required*: Yes\n*Type*: [SourceFlowConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-sourceflowconfig", "UpdateType": "Mutable", "Required": true, "Type": "SourceFlowConfig" }, "FlowStatus": { "MarkdownDocumentation": "`FlowStatus`\n\nSets the status of the flow. You can specify one of the following values:\nActive\nThe flow runs based on the trigger settings that you defined. Active scheduled flows run\nas scheduled, and active event-triggered flows run when the specified change event occurs.\nHowever, active on-demand flows run only when you manually start them by using Amazon\nAppFlow.\n\nSuspended\nYou can use this option to deactivate an active flow. Scheduled and event-triggered\nflows will cease to run until you reactive them. This value only affects scheduled and\nevent-triggered flows. It has no effect for on-demand flows.\n\nIf you omit the FlowStatus parameter, Amazon AppFlow creates the flow with a default\nstatus. The default status for on-demand flows is Active. The default status for scheduled and\nevent-triggered flows is Draft, which means they\u2019re not yet active.\n*Required*: No\n*Type*: String\n*Allowed values*: `Active | Suspended | Draft...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Active", "Suspended", "Draft" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-flowstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for your flow.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appflow-flow-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "MetadataCatalogConfig": { "MarkdownDocumentation": "`MetadataCatalogConfig`\n\nSpecifies the configuration that Amazon AppFlow uses when it catalogs your data. When\nAmazon AppFlow catalogs your data, it stores metadata in a data catalog.\n*Required*: No\n*Type*: [MetadataCatalogConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#cfn-appflow-flow-metadatacatalogconfig", "UpdateType": "Mutable", "Required": false, "Type": "MetadataCatalogConfig" } }, "Attributes": { "FlowArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FlowArn`\n\nThe flow's Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html#FlowArn-fn::getatt" } } }, "AWS::AppMesh::GatewayRoute": { "MarkdownDocumentation": "`AWS::AppMesh::GatewayRoute`\n\nCreates a gateway route.\nA gateway route is attached to a virtual gateway and routes traffic to an existing\nvirtual service. If a route matches a request, it can distribute traffic to a target\nvirtual service.\nFor more information about gateway routes, see [Gateway routes](https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myGatewayRoute\" }`\nWhen you pass the logical ID of an `AWS::AppMesh::GatewayRoute` resource to\nthe intrinsic Ref function, the function returns the gateway route ARN, such as\n`arn:aws:appmesh:us-east-1:555555555555:gatewayRoute/myGatewayRoute`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html", "Attributes": { "Uid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Uid`\n\nThe unique identifier for the gateway route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#Uid-fn::getatt" }, "MeshName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh that the gateway route resides in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#MeshName-fn::getatt" }, "VirtualGatewayName": { "PrimitiveType": "String", "MarkdownDocumentation": "`VirtualGatewayName`\n\nThe name of the virtual gateway that the gateway route is associated with.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#VirtualGatewayName-fn::getatt" }, "MeshOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is\nnot your own, then it's the ID of the account that shared the mesh with your account. For\nmore information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#MeshOwner-fn::getatt" }, "ResourceOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceOwner`\n\nThe IAM account ID of the resource owner. If the account ID is not your\nown, then it's the ID of the mesh owner or of another account that the mesh is shared with.\nFor more information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#ResourceOwner-fn::getatt" }, "GatewayRouteName": { "PrimitiveType": "String", "MarkdownDocumentation": "`GatewayRouteName`\n\nThe name of the gateway route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#GatewayRouteName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe full Amazon Resource Name (ARN) for the gateway route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#Arn-fn::getatt" } }, "Properties": { "MeshName": { "Required": true, "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh that the resource resides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "VirtualGatewayName": { "Required": true, "MarkdownDocumentation": "`VirtualGatewayName`\n\nThe virtual gateway that the gateway route is associated with.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-virtualgatewayname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MeshOwner": { "Required": false, "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\nthe ID of the account that shared the mesh with your account. For more information about mesh sharing, see [Working with shared meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n*Required*: No\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshowner", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GatewayRouteName": { "Required": false, "MarkdownDocumentation": "`GatewayRouteName`\n\nThe name of the gateway route.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-gatewayroutename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Spec": { "Type": "GatewayRouteSpec", "Required": true, "MarkdownDocumentation": "`Spec`\n\nThe specifications of the gateway route.\n*Required*: Yes\n*Type*: [GatewayRouteSpec](./aws-properties-appmesh-gatewayroute-gatewayroutespec.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you can apply to the gateway route to assist with categorization\nand organization. Each tag consists of a key and an optional value, both of which you\ndefine. Tag keys can have a maximum character length of 128 characters, and tag values can have\na maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appmesh-gatewayroute-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Mesh": { "MarkdownDocumentation": "`AWS::AppMesh::Mesh`\n\nCreates a service mesh.\nA service mesh is a logical boundary for network traffic between services that are\nrepresented by resources within the mesh. After you create your service mesh, you can\ncreate virtual services, virtual nodes, virtual routers, and routes to distribute traffic\nbetween the applications in your mesh.\nFor more information about service meshes, see [Service meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myMesh\" }`\nWhen you pass the logical ID of an `AWS::AppMesh::Mesh` resource to the\nintrinsic Ref function, the function returns the mesh ARN, such as\n`arn:aws:appmesh:us-east-1:555555555555:mesh/myMesh`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html", "Attributes": { "Uid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Uid`\n\nThe unique identifier for the mesh.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#Uid-fn::getatt" }, "MeshName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#MeshName-fn::getatt" }, "MeshOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshOwner`\n\nThe IAM account ID of the service mesh owner. If the account ID is not\nyour own, then it's the ID of the account that shared the mesh with your account. For more\ninformation about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#MeshOwner-fn::getatt" }, "ResourceOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceOwner`\n\nThe IAM account ID of the resource owner. If the account ID is not your\nown, then it's the ID of the mesh owner or of another account that the mesh is shared with.\nFor more information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#ResourceOwner-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe full Amazon Resource Name (ARN) for the mesh.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#Arn-fn::getatt" } }, "Properties": { "MeshName": { "Required": false, "MarkdownDocumentation": "`MeshName`\n\nThe name to use for the service mesh.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-meshname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Spec": { "Type": "MeshSpec", "Required": false, "MarkdownDocumentation": "`Spec`\n\nThe service mesh specification to apply.\n*Required*: No\n*Type*: [MeshSpec](./aws-properties-appmesh-mesh-meshspec.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-spec", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you can apply to the service mesh to assist with categorization\nand organization. Each tag consists of a key and an optional value, both of which you\ndefine. Tag keys can have a maximum character length of 128 characters, and tag values can have\na maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appmesh-mesh-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::AppMesh::Route": { "MarkdownDocumentation": "`AWS::AppMesh::Route`\n\nCreates a route that is associated with a virtual router.\nYou can route several different protocols and define a retry policy for a route.\nTraffic can be routed to one or more virtual nodes.\nFor more information about routes, see [Routes](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myRoute\" }`\nWhen you pass the logical ID of an `AWS::AppMesh::Route` resource to the\nintrinsic Ref function, the function returns the route ARN, such as\n`arn:aws:appmesh:us-east-1:555555555555:route/myRoute`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html", "Attributes": { "Uid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Uid`\n\nThe unique identifier for the route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#Uid-fn::getatt" }, "MeshName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh that the route resides in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#MeshName-fn::getatt" }, "VirtualRouterName": { "PrimitiveType": "String", "MarkdownDocumentation": "`VirtualRouterName`\n\nThe name of the virtual router that the route is associated with.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#VirtualRouterName-fn::getatt" }, "MeshOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is\nnot your own, then it's the ID of the account that shared the mesh with your account. For\nmore information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#MeshOwner-fn::getatt" }, "ResourceOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceOwner`\n\nThe AWS IAM account ID of the resource owner. If the account ID is not\nyour own, then it's the ID of the mesh owner or of another account that the mesh is shared\nwith. For more information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#ResourceOwner-fn::getatt" }, "RouteName": { "PrimitiveType": "String", "MarkdownDocumentation": "`RouteName`\n\nThe name of the route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#RouteName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe full Amazon Resource Name (ARN) for the route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#Arn-fn::getatt" } }, "Properties": { "MeshName": { "Required": true, "MarkdownDocumentation": "`MeshName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-meshname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "VirtualRouterName": { "Required": true, "MarkdownDocumentation": "`VirtualRouterName`\n\nThe name of the virtual router in which to create the route. If the virtual router is in\na shared mesh, then you must be the owner of the virtual router resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-virtualroutername", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MeshOwner": { "Required": false, "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\nthe account that you specify must share the mesh with your account before you can create\nthe resource in the service mesh. For more information about mesh sharing, see [Working with shared meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n*Required*: No\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-meshowner", "PrimitiveType": "String", "UpdateType": "Immutable" }, "RouteName": { "Required": false, "MarkdownDocumentation": "`RouteName`\n\nThe name to use for the route.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-routename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Spec": { "Type": "RouteSpec", "Required": true, "MarkdownDocumentation": "`Spec`\n\nThe route specification to apply.\n*Required*: Yes\n*Type*: [RouteSpec](./aws-properties-appmesh-route-routespec.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-spec", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you can apply to the route to assist with categorization and\norganization. Each tag consists of a key and an optional value, both of which you define.\nTag keys can have a maximum character length of 128 characters, and tag values can have\na maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appmesh-route-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualGateway": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualGateway`\n\nCreates a virtual gateway.\nA virtual gateway allows resources outside your mesh to communicate to resources that\nare inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a\nvirtual node, which represents an Envoy running with an application, a virtual gateway\nrepresents Envoy deployed by itself.\nFor more information about virtual gateways, see [Virtual gateways](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myVirtualGateway\" }`\nWhen you pass the logical ID of an `AWS::AppMesh::VirtualGateway` resource to\nthe intrinsic Ref function, the function returns the gateway route ARN, such as\n`arn:aws:appmesh:us-east-1:555555555555:virtualGateway/myVirtualGateway`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html", "Attributes": { "Uid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Uid`\n\nThe unique identifier for the virtual gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#Uid-fn::getatt" }, "VirtualGatewayName": { "PrimitiveType": "String", "MarkdownDocumentation": "`VirtualGatewayName`\n\nThe name of the virtual gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#VirtualGatewayName-fn::getatt" }, "MeshName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh that the virtual gateway resides in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#MeshName-fn::getatt" }, "MeshOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is\nnot your own, then it's the ID of the account that shared the mesh with your account. For\nmore information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#MeshOwner-fn::getatt" }, "ResourceOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceOwner`\n\nThe AWS IAM account ID of the resource owner. If the account ID is not\nyour own, then it's the ID of the mesh owner or of another account that the mesh is shared\nwith. For more information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#ResourceOwner-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe full Amazon Resource Name (ARN) for the virtual gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#Arn-fn::getatt" } }, "Properties": { "VirtualGatewayName": { "Required": false, "MarkdownDocumentation": "`VirtualGatewayName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#cfn-appmesh-virtualgateway-virtualgatewayname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MeshName": { "Required": true, "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh that the virtual gateway resides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#cfn-appmesh-virtualgateway-meshname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MeshOwner": { "Required": false, "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\nthe ID of the account that shared the mesh with your account. For more information about mesh sharing, see [Working with shared meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n*Required*: No\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#cfn-appmesh-virtualgateway-meshowner", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Spec": { "Type": "VirtualGatewaySpec", "Required": true, "MarkdownDocumentation": "`Spec`\n\nThe specifications of the virtual gateway.\n*Required*: Yes\n*Type*: [VirtualGatewaySpec](./aws-properties-appmesh-virtualgateway-virtualgatewayspec.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#cfn-appmesh-virtualgateway-spec", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you can apply to the virtual gateway to assist with\ncategorization and organization. Each tag consists of a key and an optional value, both of\nwhich you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\na maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appmesh-virtualgateway-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualgateway.html#cfn-appmesh-virtualgateway-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualNode": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualNode`\n\nCreates a virtual node within a service mesh.\nA virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can\nspecify the service discovery information for your task group, and whether the proxy\nrunning in a task group will communicate with other proxies using Transport Layer Security\n(TLS).\nYou define a `listener` for any inbound traffic that your virtual node\nexpects. Any virtual service that your virtual node expects to communicate to is specified\nas a `backend`.\nThe response metadata for your new virtual node contains the `arn` that is\nassociated with the virtual node. Set this value to the full ARN; for example,\n`arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp`)\nas the `APPMESH_RESOURCE_ARN` environment variable for your task group's Envoy\nproxy container in your task definition or pod spec. This is then mapped to the\n`node.id` and `node.cluster` Envoy parameters.\n###### Note\nBy default, App Mesh uses the name of the resource you specified in\n`APPMESH_RESOURCE_ARN` when Envoy is referring to itself in metrics and\ntraces. You can override this behavior by setting the\n`APPMESH_RESOURCE_CLUSTER` environment variable with your own name.\nFor more information about virtual nodes, see [Virtual nodes](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html). You must be using `1.15.0` or later of the Envoy image when\nsetting these variables. For more information aboutApp Mesh Envoy variables, see\n[Envoy\nimage](https://docs.aws.amazon.com/app-mesh/latest/userguide/envoy.html) in the AWS App Mesh User Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myVirtualNode\" }`\nWhen you pass the logical ID of an `AWS::AppMesh::VirtualNode` resource to\nthe intrinsic Ref function, the function returns the virtual node ARN, such as\n`arn:aws:appmesh:us-east-1:555555555555:virtualNode/myVirtualNode`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html", "Attributes": { "Uid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Uid`\n\nThe unique identifier for the virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#Uid-fn::getatt" }, "MeshName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh that the virtual node resides in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#MeshName-fn::getatt" }, "MeshOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is\nnot your own, then it's the ID of the account that shared the mesh with your account. For\nmore information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#MeshOwner-fn::getatt" }, "ResourceOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceOwner`\n\nThe AWS IAM account ID of the resource owner. If the account ID is not\nyour own, then it's the ID of the mesh owner or of another account that the mesh is shared\nwith. For more information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#ResourceOwner-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe full Amazon Resource Name (ARN) for the virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#Arn-fn::getatt" }, "VirtualNodeName": { "PrimitiveType": "String", "MarkdownDocumentation": "`VirtualNodeName`\n\nThe name of the virtual node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#VirtualNodeName-fn::getatt" } }, "Properties": { "MeshName": { "Required": true, "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh to create the virtual node 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-meshname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MeshOwner": { "Required": false, "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\nthe account that you specify must share the mesh with your account before you can create\nthe resource in the service mesh. For more information about mesh sharing, see [Working with shared meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n*Required*: No\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-meshowner", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Spec": { "Type": "VirtualNodeSpec", "Required": true, "MarkdownDocumentation": "`Spec`\n\nThe virtual node specification to apply.\n*Required*: Yes\n*Type*: [VirtualNodeSpec](./aws-properties-appmesh-virtualnode-virtualnodespec.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-spec", "UpdateType": "Mutable" }, "VirtualNodeName": { "Required": false, "MarkdownDocumentation": "`VirtualNodeName`\n\nThe name to use for the virtual node.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-virtualnodename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you can apply to the virtual node to assist with categorization\nand organization. Each tag consists of a key and an optional value, both of which you\ndefine. Tag keys can have a maximum character length of 128 characters, and tag values can have\na maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appmesh-virtualnode-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html#cfn-appmesh-virtualnode-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualRouter": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualRouter`\n\nCreates a virtual router within a service mesh.\nSpecify a `listener` for any inbound traffic that your virtual router\nreceives. Create a virtual router for each protocol and port that you need to route.\nVirtual routers handle traffic for one or more virtual services within your mesh. After you\ncreate your virtual router, create and associate routes for your virtual router that direct\nincoming requests to different virtual nodes.\nFor more information about virtual routers, see [Virtual routers](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myVirtualRouter\" }`\nWhen you pass the logical ID of an `AWS::AppMesh::VirtualRouter` resource to\nthe intrinsic Ref function, the function returns the virtual router ARN, such as\n`arn:aws:appmesh:us-east-1:555555555555:virtualRouter/myVirtualRouter`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html", "Attributes": { "Uid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Uid`\n\nThe unique identifier for the virtual router.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#Uid-fn::getatt" }, "MeshName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh that the virtual router resides in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#MeshName-fn::getatt" }, "VirtualRouterName": { "PrimitiveType": "String", "MarkdownDocumentation": "`VirtualRouterName`\n\nThe name of the virtual router.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#VirtualRouterName-fn::getatt" }, "MeshOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is\nnot your own, then it's the ID of the account that shared the mesh with your account. For\nmore information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#MeshOwner-fn::getatt" }, "ResourceOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceOwner`\n\nThe AWS IAM account ID of the resource owner. If the account ID is not\nyour own, then it's the ID of the mesh owner or of another account that the mesh is shared\nwith. For more information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#ResourceOwner-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe full Amazon Resource Name (ARN) for the virtual router.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#Arn-fn::getatt" } }, "Properties": { "MeshName": { "Required": true, "MarkdownDocumentation": "`MeshName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-meshname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "VirtualRouterName": { "Required": false, "MarkdownDocumentation": "`VirtualRouterName`\n\nThe name to use for the virtual router.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-virtualroutername", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MeshOwner": { "Required": false, "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\nthe account that you specify must share the mesh with your account before you can create\nthe resource in the service mesh. For more information about mesh sharing, see [Working with shared meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n*Required*: No\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-meshowner", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Spec": { "Type": "VirtualRouterSpec", "Required": true, "MarkdownDocumentation": "`Spec`\n\nThe virtual router specification to apply.\n*Required*: Yes\n*Type*: [VirtualRouterSpec](./aws-properties-appmesh-virtualrouter-virtualrouterspec.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-spec", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you can apply to the virtual router to assist with categorization\nand organization. Each tag consists of a key and an optional value, both of which you\ndefine. Tag keys can have a maximum character length of 128 characters, and tag values can have\na maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appmesh-virtualrouter-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::AppMesh::VirtualService": { "MarkdownDocumentation": "`AWS::AppMesh::VirtualService`\n\nCreates a virtual service within a service mesh.\nA virtual service is an abstraction of a real service that is provided by a virtual node\ndirectly or indirectly by means of a virtual router. Dependent services call your virtual\nservice by its `virtualServiceName`, and those requests are routed to the\nvirtual node or virtual router that is specified as the provider for the virtual\nservice.\nFor more information about virtual services, see [Virtual services](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myVirtualService\" }`\nWhen you pass the logical ID of an `AWS::AppMesh::VirtualService` resource to\nthe intrinsic Ref function, the function returns the virtual service ARN, such as\n`arn:aws:appmesh:us-east-1:555555555555:virtualService/myVirtualService`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html", "Attributes": { "Uid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Uid`\n\nThe unique identifier for the virtual service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#Uid-fn::getatt" }, "MeshName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshName`\n\nThe name of the service mesh that the virtual service resides in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#MeshName-fn::getatt" }, "MeshOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is\nnot your own, then it's the ID of the account that shared the mesh with your account. For\nmore information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#MeshOwner-fn::getatt" }, "ResourceOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceOwner`\n\nThe AWS IAM account ID of the resource owner. If the account ID is not\nyour own, then it's the ID of the mesh owner or of another account that the mesh is shared\nwith. For more information about mesh sharing, see [Working with Shared Meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#ResourceOwner-fn::getatt" }, "VirtualServiceName": { "PrimitiveType": "String", "MarkdownDocumentation": "`VirtualServiceName`\n\nThe name of the virtual service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#VirtualServiceName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe full Amazon Resource Name (ARN) for the virtual service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#Arn-fn::getatt" } }, "Properties": { "MeshName": { "Required": true, "MarkdownDocumentation": "`MeshName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-meshname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MeshOwner": { "Required": false, "MarkdownDocumentation": "`MeshOwner`\n\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\nthe account that you specify must share the mesh with your account before you can create\nthe resource in the service mesh. For more information about mesh sharing, see [Working with shared meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).\n*Required*: No\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-meshowner", "PrimitiveType": "String", "UpdateType": "Immutable" }, "VirtualServiceName": { "Required": true, "MarkdownDocumentation": "`VirtualServiceName`\n\nThe name to use for the virtual 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-virtualservicename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Spec": { "Type": "VirtualServiceSpec", "Required": true, "MarkdownDocumentation": "`Spec`\n\nThe virtual service specification to apply.\n*Required*: Yes\n*Type*: [VirtualServiceSpec](./aws-properties-appmesh-virtualservice-virtualservicespec.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-spec", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you can apply to the virtual service to assist with\ncategorization and organization. Each tag consists of a key and an optional value, both of\nwhich you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\na maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appmesh-virtualservice-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::AppRunner::AutoScalingConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::AutoScalingConfiguration`\n\nThe `AWS::AppRunner::AutoScalingConfiguration` resource is an AWS App Runner resource type that specifies an App Runner\nautomatic scaling configuration.\nApp Runner requires this resource to set\nnon-default auto scaling settings for instances used to process the web requests. You can share an auto scaling configuration across multiple services.\nCreate multiple revisions of a configuration by calling this action multiple times using the same `AutoScalingConfigurationName`. The call\nreturns incremental `AutoScalingConfigurationRevision` values. When you create a service and configure an auto scaling configuration resource,\nthe service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific\nrevision.\nConfigure a higher `MinSize` to increase the spread of your App Runner service over more Availability Zones in the AWS Region. The tradeoff is\na higher minimal cost.\nConfigure a lower `MaxSize` to control your cost. The tradeoff is lower responsiveness during peak demand.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html", "Properties": { "MinSize": { "MarkdownDocumentation": "`MinSize`\n\nThe minimum number of instances that App Runner provisions for a service. The service always has at least `MinSize` provisioned instances. Some\nof them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be\nquickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.\nApp Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html#cfn-apprunner-autoscalingconfiguration-minsize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MaxConcurrency": { "MarkdownDocumentation": "`MaxConcurrency`\n\nThe maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service\nup.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html#cfn-apprunner-autoscalingconfiguration-maxconcurrency", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "AutoScalingConfigurationName": { "MarkdownDocumentation": "`AutoScalingConfigurationName`\n\nThe customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}`\n*Minimum*: `4`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html#cfn-apprunner-autoscalingconfiguration-autoscalingconfigurationname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaxSize": { "MarkdownDocumentation": "`MaxSize`\n\nThe maximum number of instances that a service scales up to. At most `MaxSize` instances actively serve traffic for your service.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html#cfn-apprunner-autoscalingconfiguration-maxsize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apprunner-autoscalingconfiguration-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html#cfn-apprunner-autoscalingconfiguration-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "AutoScalingConfigurationRevision": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AutoScalingConfigurationRevision`\n\nThe revision of this auto scaling configuration. It's unique among all the active configurations that share the same `AutoScalingConfigurationName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html#AutoScalingConfigurationRevision-fn::getatt" }, "AutoScalingConfigurationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutoScalingConfigurationArn`\n\nThe Amazon Resource Name (ARN) of this auto scaling configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html#AutoScalingConfigurationArn-fn::getatt" }, "Latest": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`Latest`\n\nIt's set to true for the configuration with the highest `Revision` among all configurations that share the same `AutoScalingConfigurationName`.\nIt's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-autoscalingconfiguration.html#Latest-fn::getatt" } } }, "AWS::AppRunner::ObservabilityConfiguration": { "MarkdownDocumentation": "`AWS::AppRunner::ObservabilityConfiguration`\n\nThe `AWS::AppRunner::ObservabilityConfiguration` resource is an AWS App Runner resource type that specifies an App Runner\nobservability configuration.\nApp Runner requires this resource when you specify App Runner services and you want to enable non-default observability features.\nYou can share an observability configuration across multiple services.\nCreate multiple revisions of a configuration by specifying this resource multiple times using the same `ObservabilityConfigurationName`.\nApp Runner creates multiple resources with incremental `ObservabilityConfigurationRevision` values. When you specify a service and\nconfigure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can\noptionally configure the service to use a specific revision.\nThe observability configuration resource is designed to configure multiple features (currently one feature, tracing). This resource takes optional\nparameters that describe the configuration of these features (currently one parameter, `TraceConfiguration`). If you don't specify a feature\nparameter, App Runner doesn't enable the feature.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html", "Properties": { "TraceConfiguration": { "MarkdownDocumentation": "`TraceConfiguration`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-traceconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "TraceConfiguration" }, "ObservabilityConfigurationName": { "MarkdownDocumentation": "`ObservabilityConfigurationName`\n\nA name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number\n`1` of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.\n###### Note\nThe name `DefaultConfiguration` is reserved. You can't use it to create a new observability configuration, and you can't create a\nrevision of it.\nWhen you want to use your own observability configuration for your App Runner service, *create a configuration with a different name*,\nand then provide it when you create or update your service.\nIf you don't specify a name, CloudFormation generates a name for your observability configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}`\n*Minimum*: `4`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-observabilityconfigurationname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA 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*: Array of [Tag](./aws-properties-apprunner-observabilityconfiguration-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ObservabilityConfigurationRevision": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ObservabilityConfigurationRevision`\n\nThe revision of this observability configuration. It's unique among all the active configurations (`\"Status\": \"ACTIVE\"`) that share the\nsame `ObservabilityConfigurationName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#ObservabilityConfigurationRevision-fn::getatt" }, "ObservabilityConfigurationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ObservabilityConfigurationArn`\n\nThe Amazon Resource Name (ARN) of this observability configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#ObservabilityConfigurationArn-fn::getatt" }, "Latest": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`Latest`\n\nIt's set to `true` for the configuration with the highest `Revision` among all configurations that share the same\n`ObservabilityConfigurationName`. It's set to `false` otherwise.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#Latest-fn::getatt" } } }, "AWS::AppRunner::Service": { "MarkdownDocumentation": "`AWS::AppRunner::Service`\n\nThe `AWS::AppRunner::Service` resource is an AWS App Runner resource type that specifies an App Runner service.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ARN of the App Runner service.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html", "Properties": { "HealthCheckConfiguration": { "MarkdownDocumentation": "`HealthCheckConfiguration`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-healthcheckconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HealthCheckConfiguration" }, "InstanceConfiguration": { "MarkdownDocumentation": "`InstanceConfiguration`\n\nThe runtime configuration of instances (scaling units) of your service.\n*Required*: No\n*Type*: [InstanceConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-instanceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InstanceConfiguration" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nAn 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,\nApp Runner uses an AWS managed key.\n*Required*: No\n*Type*: [EncryptionConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-encryptionconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EncryptionConfiguration" }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nA 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, CloudFormation generates a name for your service.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9][A-Za-z0-9-_]{3,39}`\n*Minimum*: `4`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-servicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ObservabilityConfiguration": { "MarkdownDocumentation": "`ObservabilityConfiguration`\n\nThe observability configuration of your service.\n*Required*: No\n*Type*: [ServiceObservabilityConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-observabilityconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ServiceObservabilityConfiguration" }, "SourceConfiguration": { "MarkdownDocumentation": "`SourceConfiguration`\n\nThe source to deploy to the App Runner service. It can be a code or an image repository.\n*Required*: Yes\n*Type*: [SourceConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-sourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "SourceConfiguration" }, "AutoScalingConfigurationArn": { "MarkdownDocumentation": "`AutoScalingConfigurationArn`\n\nThe 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\nassociates 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:\n`arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3`\nSpecify just the name to associate the latest revision. For example:\n`arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability`\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-autoscalingconfigurationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nConfiguration settings related to network traffic of the web application that the App Runner service runs.\n*Required*: No\n*Type*: [NetworkConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NetworkConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-apprunner-service-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current state of the App Runner service. These particular values mean the following.\n* `CREATE_FAILED` \u2013 The service failed to create. The failed service isn't usable, and still counts towards your service quota. To\n troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using\n `UpdateService`.\n* `DELETE_FAILED` \u2013 The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#Status-fn::getatt" }, "ServiceUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceUrl`\n\nA subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#ServiceUrl-fn::getatt" }, "ServiceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceArn`\n\nThe Amazon Resource Name (ARN) of this service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#ServiceArn-fn::getatt" }, "ServiceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceId`\n\nAn ID that App Runner generated for this service. It's unique within the AWS Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#ServiceId-fn::getatt" } } }, "AWS::AppRunner::VpcConnector": { "MarkdownDocumentation": "`AWS::AppRunner::VpcConnector`\n\nThe `AWS::AppRunner::VpcConnector` resource is an AWS App Runner resource type that specifies an App Runner VPC connector.\nApp Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nA 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\ndefault security group of the Amazon VPC. The default security group allows all outbound traffic.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-securitygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nA 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\nAmazon VPC. App Runner determines the Amazon VPC from the subnets you specify.\n###### Note\nApp Runner only supports subnets of IP address type *IPv4* and *dual stack* (IPv4 and IPv6).\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-subnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "VpcConnectorName": { "MarkdownDocumentation": "`VpcConnectorName`\n\nA name for the VPC connector.\nIf you don't specify a name, CloudFormation generates a name for your VPC connector.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9][A-Za-z0-9-\\\\_]{3,39}$`\n*Minimum*: `4`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-vpcconnectorname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.\n###### Note\nA `VpcConnector` is immutable, so you cannot update its tags. To change the\ntags, replace the resource. To replace a `VpcConnector`, you must provide a new\ncombination of security groups.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-apprunner-vpcconnector-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "VpcConnectorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcConnectorArn`\n\nThe Amazon Resource Name (ARN) of this VPC connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#VpcConnectorArn-fn::getatt" }, "VpcConnectorRevision": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`VpcConnectorRevision`\n\nThe revision of this VPC connector. It's unique among all the active connectors (`\"Status\": \"ACTIVE\"`) that share the same\n`Name`.\n###### Note\nAt this time, App Runner supports only one revision per name.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#VpcConnectorRevision-fn::getatt" } } }, "AWS::AppRunner::VpcIngressConnection": { "MarkdownDocumentation": "`AWS::AppRunner::VpcIngressConnection`\n\nThe `AWS::AppRunner::VpcIngressConnection` resource is an AWS App Runner resource type that specifies an App Runner VPC\nIngress Connection.\nApp Runner requires this resource when you want to associate your App Runner service to an Amazon VPC endpoint.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcingressconnection.html", "Properties": { "VpcIngressConnectionName": { "MarkdownDocumentation": "`VpcIngressConnectionName`\n\nThe customer-provided VPC Ingress Connection name.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}`\n*Minimum*: `4`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcingressconnection.html#cfn-apprunner-vpcingressconnection-vpcingressconnectionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServiceArn": { "MarkdownDocumentation": "`ServiceArn`\n\nThe 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*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}`\n*Minimum*: `1`\n*Maximum*: `1011`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcingressconnection.html#cfn-apprunner-vpcingressconnection-servicearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-apprunner-vpcingressconnection-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcingressconnection.html#cfn-apprunner-vpcingressconnection-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "IngressVpcConfiguration": { "MarkdownDocumentation": "`IngressVpcConfiguration`\n\nSpecifications for the customer\u2019s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection\nresource.\n*Required*: Yes\n*Type*: [IngressVpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcingressconnection.html#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "IngressVpcConfiguration" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the VPC Ingress Connection.\nThe VPC Ingress Connection displays one of the following statuses: `AVAILABLE`, `PENDING_CREATION`, `PENDING_UPDATE`, `PENDING_DELETION`,`FAILED_CREATION`, `FAILED_UPDATE`, `FAILED_DELETION`, and `DELETED`..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcingressconnection.html#Status-fn::getatt" }, "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nThe domain name associated with the VPC Ingress Connection resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcingressconnection.html#DomainName-fn::getatt" }, "VpcIngressConnectionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcIngressConnectionArn`\n\nThe Amazon Resource Name (ARN) of the VPC Ingress Connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcingressconnection.html#VpcIngressConnectionArn-fn::getatt" } } }, "AWS::AppStream::AppBlock": { "MarkdownDocumentation": "`AWS::AppStream::AppBlock`\n\nThis resource creates an app block. App blocks store details about the virtual hard disk that\ncontains the files for the application in an S3 bucket. It also stores the setup script\nwith details about how to mount the virtual hard disk. App blocks are only supported for\nElastic fleets.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function,\n`Ref` returns the `Arn` of the app block, such as\n`arn:aws:appstream:us-west-2:123456789123:app-block/abcdefg`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html", "Properties": { "SetupScriptDetails": { "MarkdownDocumentation": "`SetupScriptDetails`\n\nThe setup script details of the app block.\n*Required*: No\n*Type*: [ScriptDetails](./aws-properties-appstream-appblock-scriptdetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-setupscriptdetails", "UpdateType": "Immutable", "Required": false, "Type": "ScriptDetails" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PostSetupScriptDetails": { "MarkdownDocumentation": "`PostSetupScriptDetails`\n\nThe post setup script details of the app block.\n*Required*: No\n*Type*: [ScriptDetails](./aws-properties-appstream-appblock-scriptdetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-postsetupscriptdetails", "UpdateType": "Immutable", "Required": false, "Type": "ScriptDetails" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-displayname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceS3Location": { "MarkdownDocumentation": "`SourceS3Location`\n\nThe source S3 location of the app block.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-appstream-appblock-s3location.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-sources3location", "UpdateType": "Immutable", "Required": true, "Type": "S3Location" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags of the app block.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appstream-appblock-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "PackagingType": { "MarkdownDocumentation": "`PackagingType`\n\nThe packaging type of the app block.\n*Required*: No\n*Type*: String\n*Allowed values*: `CUSTOM | APPSTREAM2...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CUSTOM", "APPSTREAM2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-packagingtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the app block.\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time when the app block was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#CreatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the app block.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#Arn-fn::getatt" } } }, "AWS::AppStream::AppBlockBuilder": { "MarkdownDocumentation": "`AWS::AppStream::AppBlockBuilder`\n\nCreates an app block builder.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function,\n`Ref` returns the `Name` of the app block builder, such as\n`abcdefAppBlockBuilder`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the app block builder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Platform": { "MarkdownDocumentation": "`Platform`\n\nThe platform of the app block builder.\n*Allowed values*: `WINDOWS_SERVER_2019...`\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS_SERVER_2019" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-platform", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nThe VPC configuration for the app block builder.\n*Required*: Yes\n*Type*: [VpcConfig](./aws-properties-appstream-appblockbuilder-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-vpcconfig", "UpdateType": "Mutable", "Required": true, "Type": "VpcConfig" }, "AppBlockArns": { "MarkdownDocumentation": "`AppBlockArns`\n\nThe ARN of the app block.\n*Maximum*: `1`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-appblockarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EnableDefaultInternetAccess": { "MarkdownDocumentation": "`EnableDefaultInternetAccess`\n\nIndicates whether default internet access is enabled for the app block builder.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-enabledefaultinternetaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the app block builder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe ARN of the IAM role that is applied to the app block builder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-iamrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type of the app block builder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-instancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags of the app block builder.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appstream-appblockbuilder-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the app block builder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccessEndpoints": { "MarkdownDocumentation": "`AccessEndpoints`\n\nThe access endpoints of the app block builder.\n*Required*: No\n*Type*: Array of [AccessEndpoint](./aws-properties-appstream-appblockbuilder-accessendpoint.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-accessendpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AccessEndpoint", "DuplicatesAllowed": false } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time when the app block builder was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#CreatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the app block builder.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#Arn-fn::getatt" } } }, "AWS::AppStream::Application": { "MarkdownDocumentation": "`AWS::AppStream::Application`\n\nThis resource creates an application. Applications store the details about how to launch applications on streaming instances. This is only supported for Elastic fleets.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function,\n`Ref` returns the `Arn` of the application, such as\n`arn:aws:appstream:us-west-2:123456789123:application/abcdefg`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html", "Properties": { "WorkingDirectory": { "MarkdownDocumentation": "`WorkingDirectory`\n\nThe working directory of the application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-workingdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Platforms": { "MarkdownDocumentation": "`Platforms`\n\nThe platforms the application supports.\n*Allowed Values*: `WINDOWS_SERVER_2019` | `AMAZON_LINUX2`\n*Required*: Yes\n*Type*: Array of String\n*Maximum*: `4`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-platforms", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AppBlockArn": { "MarkdownDocumentation": "`AppBlockArn`\n\nThe app block ARN with which the application should be associated.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-appblockarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceFamilies": { "MarkdownDocumentation": "`InstanceFamilies`\n\nThe instance families the application supports.\n*Allowed Values*: `GENERAL_PURPOSE` | `GRAPHICS_G4`\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-instancefamilies", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AttributesToDelete": { "MarkdownDocumentation": "`AttributesToDelete`\n\nA list of attributes to delete from an application.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-attributestodelete", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the application. This name is visible to users in the application catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchPath": { "MarkdownDocumentation": "`LaunchPath`\n\nThe launch path of the application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-launchpath", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LaunchParameters": { "MarkdownDocumentation": "`LaunchParameters`\n\nThe launch parameters of the application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-launchparameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags of the application.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appstream-application-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the application. This name is visible to users when a name is not specified in the\nDisplayName property.\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IconS3Location": { "MarkdownDocumentation": "`IconS3Location`\n\nThe icon S3 location of the application.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-appstream-application-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-icons3location", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time when the application was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#CreatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#Arn-fn::getatt" } } }, "AWS::AppStream::ApplicationEntitlementAssociation": { "MarkdownDocumentation": "`AWS::AppStream::ApplicationEntitlementAssociation`\n\nAssociates an application to an entitlement.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function,\n`Ref` returns the combination of the `StackName`,\n`EntitlementName`, and `ApplicationIdentifier`, such as\n`abcdefStack|abcdefEntitlement|abcdefApplication`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html", "Properties": { "EntitlementName": { "MarkdownDocumentation": "`EntitlementName`\n\nThe name of the entitlement.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html#cfn-appstream-applicationentitlementassociation-entitlementname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplicationIdentifier": { "MarkdownDocumentation": "`ApplicationIdentifier`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html#cfn-appstream-applicationentitlementassociation-applicationidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StackName": { "MarkdownDocumentation": "`StackName`\n\nThe name of the stack.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html#cfn-appstream-applicationentitlementassociation-stackname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppStream::ApplicationFleetAssociation": { "MarkdownDocumentation": "`AWS::AppStream::ApplicationFleetAssociation`\n\nThis resource associates the specified application with the specified fleet. This is only supported for Elastic fleets.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function,\n`Ref` returns a combination of the `FleetName` and\n`ApplicationArn`, such as\n`aabcdefgFleet|arn:aws:appstream:us-west-2:123456789123:application/abcdefg`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationfleetassociation.html", "Properties": { "FleetName": { "MarkdownDocumentation": "`FleetName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationfleetassociation.html#cfn-appstream-applicationfleetassociation-fleetname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplicationArn": { "MarkdownDocumentation": "`ApplicationArn`\n\nThe ARN of the application.\n*Required*: Yes\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*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationfleetassociation.html#cfn-appstream-applicationfleetassociation-applicationarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppStream::DirectoryConfig": { "MarkdownDocumentation": "`AWS::AppStream::DirectoryConfig`\n\nThe `AWS::AppStream::DirectoryConfig` resource specifies the configuration information required to join Amazon AppStream 2.0 fleets\nand image builders to Microsoft Active Directory domains.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html", "Properties": { "OrganizationalUnitDistinguishedNames": { "MarkdownDocumentation": "`OrganizationalUnitDistinguishedNames`\n\nThe distinguished names of the organizational units for computer accounts.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-organizationalunitdistinguishednames", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ServiceAccountCredentials": { "MarkdownDocumentation": "`ServiceAccountCredentials`\n\nThe credentials for the service account used by the streaming instance to connect to\nthe directory. Do not use this parameter directly. Use `ServiceAccountCredentials` as an input parameter with `noEcho` as shown in\nthe [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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-serviceaccountcredentials", "UpdateType": "Mutable", "Required": true, "Type": "ServiceAccountCredentials" }, "CertificateBasedAuthProperties": { "MarkdownDocumentation": "`CertificateBasedAuthProperties`\n\nThe certificate-based authentication properties used to authenticate SAML 2.0 Identity\nProvider (IdP) user identities to Active Directory domain-joined streaming instances.\n*Required*: No\n*Type*: [CertificateBasedAuthProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-certificatebasedauthproperties", "UpdateType": "Mutable", "Required": false, "Type": "CertificateBasedAuthProperties" }, "DirectoryName": { "MarkdownDocumentation": "`DirectoryName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-directoryname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::AppStream::Entitlement": { "MarkdownDocumentation": "`AWS::AppStream::Entitlement`\n\nCreates an entitlement to control access, based on user attributes, to specific\napplications within a stack. Entitlements apply to SAML 2.0 federated user identities.\nAmazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in\na stack. Entitlements don't apply to the desktop stream view application or to applications\nmanaged by a dynamic app provider using the Dynamic Application Framework.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function,\n`Ref` returns the combination of the `StackName` and\n`Name`, such as `abcdefStack|abcdefEntitlement`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html", "Properties": { "AppVisibility": { "MarkdownDocumentation": "`AppVisibility`\n\nSpecifies whether to entitle all apps or only selected apps.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL | ASSOCIATED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL", "ASSOCIATED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-appvisibility", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the entitlement.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Attributes": { "MarkdownDocumentation": "`Attributes`\n\nThe attributes of the entitlement.\n*Required*: Yes\n*Type*: Array of [Attribute](./aws-properties-appstream-entitlement-attribute.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-attributes", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Attribute", "DuplicatesAllowed": false }, "StackName": { "MarkdownDocumentation": "`StackName`\n\nThe name of the stack.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-stackname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the entitlement.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time when the entitlement was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#CreatedTime-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe time when the entitlement was last modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#LastModifiedTime-fn::getatt" } } }, "AWS::AppStream::Fleet": { "MarkdownDocumentation": "`AWS::AppStream::Fleet`\n\nThe `AWS::AppStream::Fleet` resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html", "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe description to display.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ComputeCapacity": { "Type": "ComputeCapacity", "Required": false, "MarkdownDocumentation": "`ComputeCapacity`\n\nThe desired capacity for the fleet. This is not allowed for Elastic fleets.\n*Required*: No\n*Type*: [ComputeCapacity](./aws-properties-appstream-fleet-computecapacity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-computecapacity", "UpdateType": "Mutable" }, "Platform": { "Required": false, "MarkdownDocumentation": "`Platform`\n\nThe platform of the fleet. Platform is a required setting for Elastic fleets, and is not used for other fleet types.\n*Required*: No\n*Type*: String\n*Allowed values*: `WINDOWS | WINDOWS_SERVER_20...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019", "WINDOWS_SERVER_2022", "WINDOWS_SERVER_2025", "AMAZON_LINUX2", "RHEL8", "ROCKY_LINUX8", "UBUNTU_PRO_2404" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-platform", "PrimitiveType": "String", "UpdateType": "Mutable" }, "VpcConfig": { "Type": "VpcConfig", "Required": false, "MarkdownDocumentation": "`VpcConfig`\n\nThe VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-appstream-fleet-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-vpcconfig", "UpdateType": "Mutable" }, "FleetType": { "Required": false, "MarkdownDocumentation": "`FleetType`\n\nThe fleet type.\nALWAYS\\_ON\nProvides users with instant-on access to their apps.\nYou are charged for all running instances in your fleet, even if no users are streaming apps.\n\nON\\_DEMAND\nProvide users with access to applications after they connect, which takes one to two minutes.\nYou are charged for instance streaming when users are connected and a\nsmall hourly fee for instances that are not streaming apps.\n\nELASTIC\nThe pool of streaming instances is managed by Amazon AppStream 2.0. When a\nuser selects their application or desktop to launch, they will start streaming\nafter the app block has been downloaded and mounted to a streaming\ninstance.\n\n*Allowed Values*: `ALWAYS_ON` | `ELASTIC` | `ON_DEMAND`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-fleettype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "RootVolumeConfig": { "Type": "VolumeConfig", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-rootvolumeconfig", "UpdateType": "Mutable" }, "EnableDefaultInternetAccess": { "Required": false, "MarkdownDocumentation": "`EnableDefaultInternetAccess`\n\nEnables or disables default internet access for the fleet.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-enabledefaultinternetaccess", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DomainJoinInfo": { "Type": "DomainJoinInfo", "Required": false, "MarkdownDocumentation": "`DomainJoinInfo`\n\nThe name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.\n*Required*: No\n*Type*: [DomainJoinInfo](./aws-properties-appstream-fleet-domainjoininfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-domainjoininfo", "UpdateType": "Mutable" }, "SessionScriptS3Location": { "Type": "S3Location", "Required": false, "MarkdownDocumentation": "`SessionScriptS3Location`\n\nThe S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.\n*Required*: No\n*Type*: [S3Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-sessionscripts3location", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-name", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ImageName": { "Required": false, "MarkdownDocumentation": "`ImageName`\n\nThe name of the image used to create the fleet.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-imagename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaxUserDurationInSeconds": { "Required": false, "MarkdownDocumentation": "`MaxUserDurationInSeconds`\n\nThe 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 432000.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-maxuserdurationinseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "IdleDisconnectTimeoutInSeconds": { "Required": false, "MarkdownDocumentation": "`IdleDisconnectTimeoutInSeconds`\n\nThe amount of time that users can be idle (inactive) before they are disconnected\nfrom their streaming session and the `DisconnectTimeoutInSeconds` time\ninterval begins. Users are notified before they are disconnected due to inactivity. If\nthey try to reconnect to the streaming session before the time interval specified in\n`DisconnectTimeoutInSeconds` elapses, they are connected to their\nprevious session. Users are considered idle when they stop providing keyboard or mouse\ninput during their streaming session. File uploads and downloads, audio in, audio out,\nand pixels changing do not qualify as user activity. If users continue to be idle after\nthe time interval in `IdleDisconnectTimeoutInSeconds` elapses, they are\ndisconnected.\nTo prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000.\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-idledisconnecttimeoutinseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "UsbDeviceFilterStrings": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`UsbDeviceFilterStrings`\n\nThe 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-usbdevicefilterstrings", "UpdateType": "Mutable" }, "DisconnectTimeoutInSeconds": { "Required": false, "MarkdownDocumentation": "`DisconnectTimeoutInSeconds`\n\nThe amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.\nSpecify a value between 60 and 36000.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-disconnecttimeoutinseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DisplayName": { "Required": false, "MarkdownDocumentation": "`DisplayName`\n\nThe fleet name to display.\n*Required*: No\n*Type*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-displayname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StreamView": { "Required": false, "MarkdownDocumentation": "`StreamView`\n\nThe WorkSpaces Applications 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)", "RefReturnValue": "", "AllowedValues": [ "APP", "DESKTOP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-streamview", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IamRoleArn": { "Required": false, "MarkdownDocumentation": "`IamRoleArn`\n\nThe ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service`AssumeRole` API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the **appstream\\_machine\\_role** credential profile on the instance.\nFor more information, see [Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances](https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) in the *Amazon AppStream 2.0 Administration Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-iamrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaxSessionsPerInstance": { "Required": false, "MarkdownDocumentation": "`MaxSessionsPerInstance`\n\nMax number of user sessions on an instance. This is applicable only for multi-session fleets.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-maxsessionsperinstance", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "InstanceType": { "Required": true, "MarkdownDocumentation": "`InstanceType`\n\nThe instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:\n* stream.standard.small\n* stream.standard.medium\n* stream.standard.large\n* stream.compute.large\n* stream.compute.xlarge\n* stream.compute.2xlarge\n* stream.compute.4xlarge\n* stream.compute.8xlarge\n* stream.memory.large\n* stream.memory.xlarge\n* stream.memory.2xlarge\n* stream.memory.4xlarge\n* stream.memory.8xlarge\n* stream.memory.z1d.large\n* stream.memory.z1d.xlarge\n* stream.memory.z1d.2xlarge\n* stream.memory.z1d.3xlarge\n* stream.memory.z1d.6xlarge\n* stream.memory.z1d.12xlarge\n* stream.graphics-design.large\n* stream.graphics-design.xlarge\n* stream.graphics-design.2xlarge\n* stream.graphics-design.4xlarge\n* stream.graphics.g4dn.xlarge\n* stream.graphics.g4dn.2xlarge\n* stream.graphics.g4dn.4xlarge\n* stream.graphics.g4dn.8xlarge\n* stream.graphics.g4dn.12xlarge\n* stream.graphics.g4dn.16xlarge\n* stream.graphics.g5.xlarge\n* stream.graphics.g5.2xlarge\n* stream.graphics.g5.4xlarge\n* stream.graphics.g5.8xlarge\n* stream.graphics.g5.16xlarge\n* stream.graphics.g5.12xlarge\n* stream.graphics.g5.24xlarge\n* stream.graphics.g6.xlarge\n* stream.graphics.g6.2xlarge\n* stream.graphics.g6.4xlarge\n* stream.graphics.g6.8xlarge\n* stream.graphics.g6.16xlarge\n* stream.graphics.g6.12xlarge\n* stream.graphics.g6.24xlarge\n* stream.graphics.gr6.4xlarge\n* stream.graphics.gr6.8xlarge\n* stream.graphics.g6f.large\n* stream.graphics.g6f.xlarge\n* stream.graphics.g6f.2xlarge\n* stream.graphics.g6f.4xlarge\n* stream.graphics.gr6f.4xlarge\nThe following instance types are available for Elastic fleets:\n* stream.standard.small\n* stream.standard.medium\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-instancetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MaxConcurrentSessions": { "Required": false, "MarkdownDocumentation": "`MaxConcurrentSessions`\n\nThe maximum number of concurrent sessions that can be run on an Elastic fleet. This setting is\nrequired for Elastic fleets, but is not used for other fleet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-maxconcurrentsessions", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appstream-fleet-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "ImageArn": { "Required": false, "MarkdownDocumentation": "`ImageArn`\n\nThe ARN of the public, private, or shared image to use.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-imagearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppStream::ImageBuilder": { "MarkdownDocumentation": "`AWS::AppStream::ImageBuilder`\n\nThe `AWS::AppStream::ImageBuilder` resource creates an image builder for Amazon AppStream 2.0. An image builder is a virtual machine that is used to create an image.\nThe initial state of the image builder is `PENDING`. When it is ready, the state is `RUNNING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description to display.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nThe VPC configuration for the image builder. You can specify only one subnet.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-appstream-imagebuilder-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-vpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfig" }, "EnableDefaultInternetAccess": { "MarkdownDocumentation": "`EnableDefaultInternetAccess`\n\nEnables or disables default internet access for the image builder.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-enabledefaultinternetaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DomainJoinInfo": { "MarkdownDocumentation": "`DomainJoinInfo`\n\nThe name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.\n*Required*: No\n*Type*: [DomainJoinInfo](./aws-properties-appstream-imagebuilder-domainjoininfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-domainjoininfo", "UpdateType": "Mutable", "Required": false, "Type": "DomainJoinInfo" }, "AppstreamAgentVersion": { "MarkdownDocumentation": "`AppstreamAgentVersion`\n\nThe version of the WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications agent, specify [LATEST].\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-appstreamagentversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA unique name for the image builder.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImageName": { "MarkdownDocumentation": "`ImageName`\n\nThe name of the image used to create the image builder.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-imagename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe image builder name to display.\n*Required*: No\n*Type*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service`AssumeRole` API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the **appstream\\_machine\\_role** credential profile on the instance.\nFor more information, see [Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances](https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) in the *Amazon AppStream 2.0 Administration Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-iamrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type to use when launching the image builder. The following instance types are available:\n* stream.standard.small\n* stream.standard.medium\n* stream.standard.large\n* stream.compute.large\n* stream.compute.xlarge\n* stream.compute.2xlarge\n* stream.compute.4xlarge\n* stream.compute.8xlarge\n* stream.memory.large\n* stream.memory.xlarge\n* stream.memory.2xlarge\n* stream.memory.4xlarge\n* stream.memory.8xlarge\n* stream.memory.z1d.large\n* stream.memory.z1d.xlarge\n* stream.memory.z1d.2xlarge\n* stream.memory.z1d.3xlarge\n* stream.memory.z1d.6xlarge\n* stream.memory.z1d.12xlarge\n* stream.graphics-design.large\n* stream.graphics-design.xlarge\n* stream.graphics-design.2xlarge\n* stream.graphics-design.4xlarge\n* stream.graphics.g4dn.xlarge\n* stream.graphics.g4dn.2xlarge\n* stream.graphics.g4dn.4xlarge\n* stream.graphics.g4dn.8xlarge\n* stream.graphics.g4dn.12xlarge\n* stream.graphics.g4dn.16xlarge\n* stream.graphics.g5.xlarge\n* stream.graphics.g5.2xlarge\n* stream.graphics.g5.4xlarge\n* stream.graphics.g5.8xlarge\n* stream.graphics.g5.16xlarge\n* stream.graphics.g5.12xlarge\n* stream.graphics.g5.24xlarge\n* stream.graphics.g6.xlarge\n* stream.graphics.g6.2xlarge\n* stream.graphics.g6.4xlarge\n* stream.graphics.g6.8xlarge\n* stream.graphics.g6.16xlarge\n* stream.graphics.g6.12xlarge\n* stream.graphics.g6.24xlarge\n* stream.graphics.gr6.4xlarge\n* stream.graphics.gr6.8xlarge\n* stream.graphics.g6f.large\n* stream.graphics.g6f.xlarge\n* stream.graphics.g6f.2xlarge\n* stream.graphics.g6f.4xlarge\n* stream.graphics.gr6f.4xlarge\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-instancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appstream-imagebuilder-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ImageArn": { "MarkdownDocumentation": "`ImageArn`\n\nThe ARN of the public, private, or shared image to use.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-imagearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessEndpoints": { "MarkdownDocumentation": "`AccessEndpoints`\n\nThe list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.\n*Required*: No\n*Type*: Array of [AccessEndpoint](./aws-properties-appstream-imagebuilder-accessendpoint.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-accessendpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AccessEndpoint", "DuplicatesAllowed": true } }, "Attributes": { "StreamingUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`StreamingUrl`\n\nThe URL to start an image builder streaming session, returned as a string.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#StreamingUrl-fn::getatt" } } }, "AWS::AppStream::Stack": { "MarkdownDocumentation": "`AWS::AppStream::Stack`\n\nThe `AWS::AppStream::Stack` resource creates a stack to start streaming applications to Amazon AppStream 2.0 users. A stack consists of an associated fleet, user access policies, and storage configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html", "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe description to display.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StorageConnectors": { "Type": "List", "Required": false, "MarkdownDocumentation": "`StorageConnectors`\n\nThe storage connectors to enable.\n*Required*: No\n*Type*: Array of [StorageConnector](./aws-properties-appstream-stack-storageconnector.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-storageconnectors", "ItemType": "StorageConnector", "UpdateType": "Mutable" }, "DeleteStorageConnectors": { "Required": false, "MarkdownDocumentation": "`DeleteStorageConnectors`\n\n*This parameter has been deprecated.*\nDeletes the storage connectors currently enabled for the stack.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-deletestorageconnectors", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "EmbedHostDomains": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`EmbedHostDomains`\n\nThe domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-embedhostdomains", "UpdateType": "Mutable" }, "UserSettings": { "Type": "List", "Required": false, "MarkdownDocumentation": "`UserSettings`\n\nThe actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.\n*Required*: No\n*Type*: Array of [UserSetting](./aws-properties-appstream-stack-usersetting.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-usersettings", "ItemType": "UserSetting", "UpdateType": "Mutable" }, "AttributesToDelete": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AttributesToDelete`\n\nThe stack attributes to delete.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-attributestodelete", "UpdateType": "Mutable" }, "RedirectURL": { "Required": false, "MarkdownDocumentation": "`RedirectURL`\n\nThe URL that users are redirected to after their streaming session ends.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-redirecturl", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StreamingExperienceSettings": { "Type": "StreamingExperienceSettings", "Required": false, "MarkdownDocumentation": "`StreamingExperienceSettings`\n\nThe streaming protocol that you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.\n*Required*: No\n*Type*: [StreamingExperienceSettings](./aws-properties-appstream-stack-streamingexperiencesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-streamingexperiencesettings", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the stack.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-name", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FeedbackURL": { "Required": false, "MarkdownDocumentation": "`FeedbackURL`\n\nThe URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-feedbackurl", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ApplicationSettings": { "Type": "ApplicationSettings", "Required": false, "MarkdownDocumentation": "`ApplicationSettings`\n\nThe persistent application settings for users of the stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.\n*Required*: No\n*Type*: [ApplicationSettings](./aws-properties-appstream-stack-applicationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-applicationsettings", "UpdateType": "Mutable" }, "DisplayName": { "Required": false, "MarkdownDocumentation": "`DisplayName`\n\nThe stack name to display.\n*Required*: No\n*Type*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-displayname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appstream-stack-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "AccessEndpoints": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AccessEndpoints`\n\nThe list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.\n*Required*: No\n*Type*: Array of [AccessEndpoint](./aws-properties-appstream-stack-accessendpoint.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-accessendpoints", "ItemType": "AccessEndpoint", "UpdateType": "Mutable" } } }, "AWS::AppStream::StackFleetAssociation": { "MarkdownDocumentation": "`AWS::AppStream::StackFleetAssociation`\n\nThe `AWS::AppStream::StackFleetAssociation` resource associates the specified fleet with the specified stack for Amazon AppStream 2.0.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackfleetassociation.html", "Properties": { "FleetName": { "Required": true, "MarkdownDocumentation": "`FleetName`\n\nThe name of the fleet.\nTo associate a fleet with a stack, you must specify a dependency on the fleet resource. For more information, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackfleetassociation.html#cfn-appstream-stackfleetassociation-fleetname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StackName": { "Required": true, "MarkdownDocumentation": "`StackName`\n\nThe name of the stack.\nTo associate a fleet with a stack, you must specify a dependency on the stack resource. For more information, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackfleetassociation.html#cfn-appstream-stackfleetassociation-stackname", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::AppStream::StackUserAssociation": { "MarkdownDocumentation": "`AWS::AppStream::StackUserAssociation`\n\nThe `AWS::AppStream::StackUserAssociation` resource associates the specified users with the specified stacks for Amazon AppStream 2.0. Users in an AppStream 2.0 user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html", "Properties": { "SendEmailNotification": { "Required": false, "MarkdownDocumentation": "`SendEmailNotification`\n\nSpecifies whether a welcome email is sent to a user after the user is created in the user pool.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html#cfn-appstream-stackuserassociation-sendemailnotification", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "UserName": { "Required": true, "MarkdownDocumentation": "`UserName`\n\nThe email address of the user who is associated with the stack.\n###### Note\nUsers' email addresses are case-sensitive.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html#cfn-appstream-stackuserassociation-username", "PrimitiveType": "String", "UpdateType": "Immutable" }, "StackName": { "Required": true, "MarkdownDocumentation": "`StackName`\n\nThe name of the stack that is associated with 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html#cfn-appstream-stackuserassociation-stackname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AuthenticationType": { "Required": true, "MarkdownDocumentation": "`AuthenticationType`\n\nThe authentication type for the user who is associated with the stack. You must specify USERPOOL.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `API | SAML | USERPOOL | AWS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "API", "SAML", "USERPOOL", "AWS_AD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stackuserassociation.html#cfn-appstream-stackuserassociation-authenticationtype", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::AppStream::User": { "MarkdownDocumentation": "`AWS::AppStream::User`\n\nThe `AWS::AppStream::User` resource creates a new user in the AppStream 2.0 user pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html", "Properties": { "UserName": { "Required": true, "MarkdownDocumentation": "`UserName`\n\nThe email address of the user.\nUsers' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-username", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FirstName": { "Required": false, "MarkdownDocumentation": "`FirstName`\n\nThe first name, or given name, of the user.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_\\-\\s]+$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-firstname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MessageAction": { "Required": false, "MarkdownDocumentation": "`MessageAction`\n\nThe action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.\n###### Note\nThe temporary password in the welcome email is valid for only 7 days. If users don\u2019t set their passwords within 7 days, you must send them a new welcome email.\n*Required*: No\n*Type*: String\n*Allowed values*: `SUPPRESS | RESEND...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SUPPRESS", "RESEND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-messageaction", "PrimitiveType": "String", "UpdateType": "Immutable" }, "LastName": { "Required": false, "MarkdownDocumentation": "`LastName`\n\nThe last name, or surname, of the user.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_\\-\\s]+$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-lastname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AuthenticationType": { "Required": true, "MarkdownDocumentation": "`AuthenticationType`\n\nThe authentication type for the user. You must specify USERPOOL.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `API | SAML | USERPOOL | AWS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "API", "SAML", "USERPOOL", "AWS_AD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-authenticationtype", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::AppSync::Api": { "MarkdownDocumentation": "`AWS::AppSync::Api`\n\nThe `AWS::AppSync::Api` resource creates an AWS AppSync API that\nyou can use for an AWS AppSync API with your preferred configuration, such as an\nEvent API that provides real-time message publishing and message subscriptions over\nWebSockets.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns The Amazon Resource Name (ARN) of the AWS AppSync Api. For example:\n`arn:aws:appsync:us-east-1:123456789012:apis/eventapiId`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html", "Properties": { "OwnerContact": { "MarkdownDocumentation": "`OwnerContact`\n\nThe owner contact information for an API resource.\nThis field accepts any string input with a length of 0 - 256 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9_\\-\\ \\.]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-ownercontact", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventConfig": { "MarkdownDocumentation": "`EventConfig`\n\nDescribes the authorization configuration for connections, message publishing, message\nsubscriptions, and logging for an Event API.\n*Required*: No\n*Type*: [EventConfig](./aws-properties-appsync-api-eventconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-eventconfig", "UpdateType": "Mutable", "Required": false, "Type": "EventConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA set of tags (key-value pairs) for this API.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appsync-api-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the `Api`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9_\\-\\ ]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Dns.Realtime": { "PrimitiveType": "String", "MarkdownDocumentation": "`Dns.Realtime`\n\nThe domain name of the Api's real-time endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#Dns.Realtime-fn::getatt" }, "ApiArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApiArn`\n\nThe Amazon Resource Name (ARN) of the AWS AppSync Api.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#ApiArn-fn::getatt" }, "Dns": { "Type": "DnsMap", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#Dns-fn::getatt" }, "Dns.Http": { "PrimitiveType": "String", "MarkdownDocumentation": "`Dns.Http`\n\nThe domain name of the Api's HTTP endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#Dns.Http-fn::getatt" }, "ApiId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApiId`\n\nThe unique identifier for the AWS AppSync Api generated by the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#ApiId-fn::getatt" } } }, "AWS::AppSync::ApiCache": { "MarkdownDocumentation": "`AWS::AppSync::ApiCache`\n\nThe `AWS::AppSync::ApiCache` resource represents the input of a\n`CreateApiCache` operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html", "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe cache instance type. Valid values are\n* `SMALL`\n* `MEDIUM`\n* `LARGE`\n* `XLARGE`\n* `LARGE_2X`\n* `LARGE_4X`\n* `LARGE_8X` (not available in all regions)\n* `LARGE_12X`\nHistorically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.\nThe following legacy instance types are available, but their use is discouraged:\n* **T2\\_SMALL**: A t2.small instance type.\n* **T2\\_MEDIUM**: A t2.medium instance type.\n* **R4\\_LARGE**: A r4.large instance type.\n* **R4\\_XLARGE**: A r4.xlarge instance type.\n* **R4\\_2XLARGE**: A r4.2xlarge instance type.\n* **R4\\_4XLARGE**: A r4.4xlarge instance type.\n* **R4\\_8XLARGE**: A r4.8xlarge instance type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `T2_SMALL | T2_MEDIUM | R4_L...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "T2_SMALL", "T2_MEDIUM", "R4_LARGE", "R4_XLARGE", "R4_2XLARGE", "R4_4XLARGE", "R4_8XLARGE", "SMALL", "MEDIUM", "LARGE", "XLARGE", "LARGE_2X", "LARGE_4X", "LARGE_8X", "LARGE_12X" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-type", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TransitEncryptionEnabled": { "Required": false, "MarkdownDocumentation": "`TransitEncryptionEnabled`\n\n*This parameter has been deprecated*.\nTransit encryption flag when connecting to cache. You cannot update this setting after creation.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-transitencryptionenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "HealthMetricsConfig": { "Required": false, "MarkdownDocumentation": "`HealthMetricsConfig`\n\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics\ninclude:\n* **NetworkBandwidthOutAllowanceExceeded**: The\n network packets dropped because the throughput exceeded the aggregated bandwidth\n limit. This is useful for diagnosing bottlenecks in a cache\n configuration.\n* **EngineCPUUtilization**: The CPU utilization\n (percentage) allocated to the Redis process. This is useful for diagnosing\n bottlenecks in a cache configuration.\nMetrics will be recorded by API ID. You can set the value to `ENABLED` or\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-healthmetricsconfig", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AtRestEncryptionEnabled": { "Required": false, "MarkdownDocumentation": "`AtRestEncryptionEnabled`\n\n*This parameter has been deprecated*.\nAt-rest encryption flag for cache. You cannot update this setting after creation.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-atrestencryptionenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ApiId": { "Required": true, "MarkdownDocumentation": "`ApiId`\n\nThe GraphQL API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apiid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ApiCachingBehavior": { "Required": true, "MarkdownDocumentation": "`ApiCachingBehavior`\n\nCaching behavior.\n* **FULL\\_REQUEST\\_CACHING**: All requests from\n the same user are cached. Individual resolvers are automatically cached. All API\n calls will try to return responses from the cache.\n* **PER\\_RESOLVER\\_CACHING**: Individual resolvers\n that you specify are cached.\n* **OPERATION\\_LEVEL\\_CACHING**: Full requests are\n cached together and returned without executing resolvers.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FULL_REQUEST_CACHING | PER_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FULL_REQUEST_CACHING", "PER_RESOLVER_CACHING", "OPERATION_LEVEL_CACHING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apicachingbehavior", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Ttl": { "Required": true, "MarkdownDocumentation": "`Ttl`\n\nTTL in seconds for cache entries.\nValid values are 1\u20133,600 seconds.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-ttl", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::AppSync::ApiKey": { "MarkdownDocumentation": "`AWS::AppSync::ApiKey`\n\nThe `AWS::AppSync::ApiKey` resource creates a unique key that you can\ndistribute to clients who are executing GraphQL operations with AWS AppSync that require an API key.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AppSync::ApiKey` resource to the\nintrinsic `Ref` function, the function returns the ARN of the API key, such\nas\n`arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html", "Attributes": { "ApiKey": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApiKey`\n\nThe API key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#ApiKey-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the API key, such as\n`arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#Arn-fn::getatt" } }, "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nUnique description of your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ApiKeyId": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apikeyid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Expires": { "Required": false, "MarkdownDocumentation": "`Expires`\n\nThe time after which the API key expires. The date is represented as seconds since the epoch, rounded down\nto the nearest hour.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "ApiId": { "Required": true, "MarkdownDocumentation": "`ApiId`\n\nUnique AWS AppSync GraphQL API ID for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apiid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::AppSync::ChannelNamespace": { "MarkdownDocumentation": "`AWS::AppSync::ChannelNamespace`\n\nThe `AWS::AppSync::ChannelNamespace` resource creates a channel namespace\nassociated with an `Api`. The `ChannelNamespace` contains the\ndefinitions for code handlers for the `Api`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns The Amazon Resource Name (ARN) of the channel namespace.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html", "Properties": { "SubscribeAuthModes": { "MarkdownDocumentation": "`SubscribeAuthModes`\n\nThe authorization mode to use for subscribing to messages on the channel namespace.\nThis configuration overrides the default `Api`authorization\nconfiguration.\n*Required*: No\n*Type*: Array of [AuthMode](./aws-properties-appsync-channelnamespace-authmode.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-subscribeauthmodes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AuthMode", "DuplicatesAllowed": true }, "CodeS3Location": { "MarkdownDocumentation": "`CodeS3Location`\n\nThe Amazon S3 endpoint where the code is located.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-codes3location", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PublishAuthModes": { "MarkdownDocumentation": "`PublishAuthModes`\n\nThe authorization mode to use for publishing messages on the channel namespace. This\nconfiguration overrides the default `Api`authorization configuration.\n*Required*: No\n*Type*: Array of [AuthMode](./aws-properties-appsync-channelnamespace-authmode.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-publishauthmodes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AuthMode", "DuplicatesAllowed": true }, "CodeHandlers": { "MarkdownDocumentation": "`CodeHandlers`\n\nThe event handler functions that run custom business logic to process published events\nand subscribe requests.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32768`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-codehandlers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HandlerConfigs": { "MarkdownDocumentation": "`HandlerConfigs`\n\nThe configuration for the `OnPublish` and `OnSubscribe`\nhandlers.\n*Required*: No\n*Type*: [HandlerConfigs](./aws-properties-appsync-channelnamespace-handlerconfigs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-handlerconfigs", "UpdateType": "Mutable", "Required": false, "Type": "HandlerConfigs" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe `Api` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA set of tags (key-value pairs) for this channel namespace.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appsync-channelnamespace-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the channel namespace. This name must be unique within the\n`Api`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,48}[A-Za-z0-9])?)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ChannelNamespaceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ChannelNamespaceArn`\n\nThe Amazon Resource Name (ARN) of the channel namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#ChannelNamespaceArn-fn::getatt" } } }, "AWS::AppSync::DataSource": { "MarkdownDocumentation": "`AWS::AppSync::DataSource`\n\nThe `AWS::AppSync::DataSource` resource creates data sources for resolvers\nin AWS AppSync to connect to, such as Amazon DynamoDB, AWS Lambda, and Amazon OpenSearch Service. Resolvers use these data sources to\nfetch data when clients make GraphQL calls.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AppSync::DataSource` resource to\nthe intrinsic `Ref` function, the function returns the ARN of the Data\nSource, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html", "Properties": { "OpenSearchServiceConfig": { "MarkdownDocumentation": "`OpenSearchServiceConfig`\n\nAWS Region and Endpoints for an Amazon OpenSearch Service domain in\nyour account.\n*Required*: No\n*Type*: [OpenSearchServiceConfig](./aws-properties-appsync-datasource-opensearchserviceconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-opensearchserviceconfig", "UpdateType": "Mutable", "Required": false, "Type": "OpenSearchServiceConfig" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the data source.\n* **AWS\\_LAMBDA**: The data source is an AWS Lambda function.\n* **AMAZON\\_DYNAMODB**: The data source is an\n Amazon DynamoDB table.\n* **AMAZON\\_ELASTICSEARCH**: The data source is an\n Amazon OpenSearch Service domain.\n* **AMAZON\\_EVENTBRIDGE**: The data source is an\n Amazon EventBridge event bus.\n* **AMAZON\\_OPENSEARCH\\_SERVICE**: The data source is\n an Amazon OpenSearch Service domain.\n* **AMAZON\\_BEDROCK\\_RUNTIME**: The data source is\n the Amazon Bedrock runtime.\n* **NONE**: There is no data source. This type is\n used when you wish to invoke a GraphQL operation without connecting to a data\n source, such as performing data transformation with resolvers or triggering a\n subscription to be invoked from a mutation.\n* **HTTP**: The data source is an HTTP\n endpoint.\n* **RELATIONAL\\_DATABASE**: The data source is a\n relational database.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS_LAMBDA | AMAZON_DYNAMOD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS_LAMBDA", "AMAZON_DYNAMODB", "AMAZON_ELASTICSEARCH", "NONE", "HTTP", "RELATIONAL_DATABASE", "AMAZON_OPENSEARCH_SERVICE", "AMAZON_EVENTBRIDGE", "AMAZON_BEDROCK_RUNTIME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceRoleArn": { "MarkdownDocumentation": "`ServiceRoleArn`\n\nThe AWS Identity and Access Management service role ARN for the data source. The system assumes\nthis role when accessing the data source.\nRequired if `Type` is specified as `AWS_LAMBDA`,\n`AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`,\n`AMAZON_EVENTBRIDGE`, `AMAZON_OPENSEARCH_SERVICE`,\n`RELATIONAL_DATABASE`, or `AMAZON_BEDROCK_RUNTIME`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventBridgeConfig": { "MarkdownDocumentation": "`EventBridgeConfig`\n\nAn EventBridge configuration that contains a valid ARN of an event bus.\n*Required*: No\n*Type*: [EventBridgeConfig](./aws-properties-appsync-datasource-eventbridgeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-eventbridgeconfig", "UpdateType": "Mutable", "Required": false, "Type": "EventBridgeConfig" }, "HttpConfig": { "MarkdownDocumentation": "`HttpConfig`\n\nEndpoints for an HTTP data source.\n*Required*: No\n*Type*: [HttpConfig](./aws-properties-appsync-datasource-httpconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-httpconfig", "UpdateType": "Mutable", "Required": false, "Type": "HttpConfig" }, "RelationalDatabaseConfig": { "MarkdownDocumentation": "`RelationalDatabaseConfig`\n\nRelational Database configuration of the relational database data source.\n*Required*: No\n*Type*: [RelationalDatabaseConfig](./aws-properties-appsync-datasource-relationaldatabaseconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-relationaldatabaseconfig", "UpdateType": "Mutable", "Required": false, "Type": "RelationalDatabaseConfig" }, "LambdaConfig": { "MarkdownDocumentation": "`LambdaConfig`\n\nAn ARN of a Lambda function in valid ARN format. This can be the ARN of a Lambda\nfunction that exists in the current account or in another account.\n*Required*: No\n*Type*: [LambdaConfig](./aws-properties-appsync-datasource-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-lambdaconfig", "UpdateType": "Mutable", "Required": false, "Type": "LambdaConfig" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nUnique AWS AppSync GraphQL API identifier where this data source will be\ncreated.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MetricsConfig": { "MarkdownDocumentation": "`MetricsConfig`\n\nEnables or disables enhanced data source metrics for specified data sources. Note that\n`MetricsConfig` won't be used unless the\n`dataSourceLevelMetricsBehavior` value is set to\n`PER_DATA_SOURCE_METRICS`. If the\n`dataSourceLevelMetricsBehavior` is set to\n`FULL_REQUEST_DATA_SOURCE_METRICS` instead, `MetricsConfig`\nwill be ignored. However, you can still set its value.\n`MetricsConfig` can be `ENABLED` or\n`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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-metricsconfig", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nFriendly name for you to identify your AppSync data source after creation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DynamoDBConfig": { "MarkdownDocumentation": "`DynamoDBConfig`\n\nAWS Region and TableName for an Amazon DynamoDB table in\nyour account.\n*Required*: No\n*Type*: [DynamoDBConfig](./aws-properties-appsync-datasource-dynamodbconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-dynamodbconfig", "UpdateType": "Mutable", "Required": false, "Type": "DynamoDBConfig" } }, "Attributes": { "DataSourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataSourceArn`\n\nThe Amazon Resource Name (ARN) of the API key, such as\n`arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#DataSourceArn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nFriendly name for you to identify your AWS AppSync data source after\ncreation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#Name-fn::getatt" } } }, "AWS::AppSync::DomainName": { "MarkdownDocumentation": "`AWS::AppSync::DomainName`\n\nThe `AWS::AppSync::DomainName` resource creates a\n`DomainNameConfig` object to configure a custom domain.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AppSync::DomainName` resource to\nthe intrinsic `Ref` function, the function returns the domain name.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe decription for your domain name.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#cfn-appsync-domainname-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(\\*[a-z\\d-]*\\.)?([a-z\\d-]+\\.)+[a-z\\d-]+$`\n*Minimum*: `1`\n*Maximum*: `253`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#cfn-appsync-domainname-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA set of tags (key-value pairs) for this domain name.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appsync-domainname-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#cfn-appsync-domainname-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[a-z-]*:acm:[a-z0-9-]*:\\d{12}:certificate/[0-9A-Za-z_/-]*$`\n*Minimum*: `3`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#cfn-appsync-domainname-certificatearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AppSyncDomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`AppSyncDomainName`\n\nThe domain name provided by AWS AppSync.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#AppSyncDomainName-fn::getatt" }, "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nThe domain name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#DomainName-fn::getatt" }, "HostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`HostedZoneId`\n\nThe ID of your Amazon Route\u00a053 hosted zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#HostedZoneId-fn::getatt" }, "DomainNameArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainNameArn`\n\nThe Amazon resource name (ARN) of the domain name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html#DomainNameArn-fn::getatt" } } }, "AWS::AppSync::DomainNameApiAssociation": { "MarkdownDocumentation": "`AWS::AppSync::DomainNameApiAssociation`\n\nThe `AWS::AppSync::DomainNameApiAssociation` resource represents the\nmapping of your custom domain name to the assigned API URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainnameapiassociation.html", "Properties": { "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(\\*[a-z\\d-]*\\.)?([a-z\\d-]+\\.)+[a-z\\d-]+$`\n*Minimum*: `1`\n*Maximum*: `253`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainnameapiassociation.html#cfn-appsync-domainnameapiassociation-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe API 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainnameapiassociation.html#cfn-appsync-domainnameapiassociation-apiid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ApiAssociationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainnameapiassociation.html#ApiAssociationIdentifier-fn::getatt" } } }, "AWS::AppSync::FunctionConfiguration": { "MarkdownDocumentation": "`AWS::AppSync::FunctionConfiguration`\n\nThe `AWS::AppSync::FunctionConfiguration` resource defines the functions in\nGraphQL APIs to perform certain operations. You can use pipeline resolvers to attach\nfunctions. For more information, see [Pipeline Resolvers](https://docs.aws.amazon.com/appsync/latest/devguide/pipeline-resolvers.html) in\nthe *AWS AppSync Developer Guide*.\n###### Note\nWhen you submit an update, AWS CloudFormation updates resources based on\ndifferences between what you submit and the stack's current template. To cause this\nresource to be updated you must change a property value for this resource in the\nCloudFormation template. Changing the Amazon S3 file content\nwithout changing a property value will not result in an update operation.\nSee [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AppSync::FunctionConfiguration`\nresource to the intrinsic `Ref` function, the function returns the ARN of the\nFunctionConfiguration, such as\n`arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionid`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe `Function` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestMappingTemplate": { "MarkdownDocumentation": "`RequestMappingTemplate`\n\nThe `Function` request mapping template. Functions support only the 2018-05-29 version of the\nrequest mapping template.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-requestmappingtemplate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseMappingTemplate": { "MarkdownDocumentation": "`ResponseMappingTemplate`\n\nThe `Function` response mapping template.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-responsemappingtemplate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxBatchSize": { "MarkdownDocumentation": "`MaxBatchSize`\n\nThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-maxbatchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SyncConfig": { "MarkdownDocumentation": "`SyncConfig`\n\nDescribes a Sync configuration for a resolver.\nSpecifies which Conflict Detection strategy and Resolution strategy to use when the resolver is\ninvoked.\n*Required*: No\n*Type*: [SyncConfig](./aws-properties-appsync-functionconfiguration-syncconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-syncconfig", "UpdateType": "Mutable", "Required": false, "Type": "SyncConfig" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe `resolver` code that contains the request and response functions. When\ncode is used, the `runtime` is required. The runtime value must be\n`APPSYNC_JS`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResponseMappingTemplateS3Location": { "MarkdownDocumentation": "`ResponseMappingTemplateS3Location`\n\nThe location of a response mapping template in an Amazon S3 bucket. Use this\nif you want to provision with a template file in Amazon S3 rather than\nembedding it in your CloudFormation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-responsemappingtemplates3location", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nDescribes a runtime used by an AWS AppSync resolver or AWS AppSync function. Specifies the name and version of the runtime to use.\nNote that if a runtime is specified, code must also be specified.\n*Required*: No\n*Type*: [AppSyncRuntime](./aws-properties-appsync-functionconfiguration-appsyncruntime.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-runtime", "UpdateType": "Mutable", "Required": false, "Type": "AppSyncRuntime" }, "CodeS3Location": { "MarkdownDocumentation": "`CodeS3Location`\n\nThe Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-codes3location", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSourceName": { "MarkdownDocumentation": "`DataSourceName`\n\nThe name of data source this function will attach.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-datasourcename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FunctionVersion": { "MarkdownDocumentation": "`FunctionVersion`\n\nThe version of the request mapping template. Currently, only the 2018-05-29 version of the template is\nsupported.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-functionversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestMappingTemplateS3Location": { "MarkdownDocumentation": "`RequestMappingTemplateS3Location`\n\nDescribes a Sync configuration for a resolver.\nContains information on which Conflict Detection, as well as Resolution strategy,\nshould be performed when the resolver is invoked.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-requestmappingtemplates3location", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe AWS AppSync GraphQL API that you want to attach using this\nfunction.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "FunctionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FunctionId`\n\nThe unique ID of this function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#FunctionId-fn::getatt" }, "FunctionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FunctionArn`\n\nARN of the function, such as\n`arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#FunctionArn-fn::getatt" }, "DataSourceName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataSourceName`\n\nThe name of data source this function will attach.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#DataSourceName-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#Name-fn::getatt" } } }, "AWS::AppSync::GraphQLApi": { "MarkdownDocumentation": "`AWS::AppSync::GraphQLApi`\n\nThe `AWS::AppSync::GraphQLApi` resource creates a new AWS AppSync\nGraphQL API. This is the top-level construct for your application. For more information,\nsee [Quick\nStart](https://docs.aws.amazon.com/appsync/latest/devguide/quickstart.html) in the *AWS AppSync Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AppSync::GraphQLApi` resource to\nthe intrinsic `Ref` function, the function returns the ARN of the GraphQL\nAPI, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html", "Attributes": { "RealtimeUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`RealtimeUrl`\n\nThe GraphQL API real-time endpoint URL. For more information, see [Discovering the real-time endpoint from the GraphQL endpoint](https://docs.aws.amazon.com/appsync/latest/devguide/real-time-websocket-client.html#handshake-details-to-establish-the-websocket-connection).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#RealtimeUrl-fn::getatt" }, "GraphQLUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`GraphQLUrl`\n\nThe Endpoint URL of your GraphQL API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#GraphQLUrl-fn::getatt" }, "GraphQLDns": { "PrimitiveType": "String", "MarkdownDocumentation": "`GraphQLDns`\n\nThe fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#GraphQLDns-fn::getatt" }, "RealtimeDns": { "PrimitiveType": "String", "MarkdownDocumentation": "`RealtimeDns`\n\nThe fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL\nAPI.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#RealtimeDns-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the API key, such as\n`arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#Arn-fn::getatt" }, "ApiId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApiId`\n\nUnique AWS AppSync GraphQL API identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#ApiId-fn::getatt" }, "GraphQLEndpointArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GraphQLEndpointArn`\n\nThe GraphQL endpoint ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#GraphQLEndpointArn-fn::getatt" } }, "Properties": { "QueryDepthLimit": { "Required": false, "MarkdownDocumentation": "`QueryDepthLimit`\n\nThe maximum depth a query can have in a single request. Depth refers to the amount of\nnested levels allowed in the body of query. The default value is `0` (or\nunspecified), which indicates there's no depth limit. If you set a limit, it can be\nbetween `1` and `75` nested levels. This field will produce a\nlimit error if the operation falls out of bounds. Note that fields can still be set to\nnullable or non-nullable. If a non-nullable field produces an error, the error will be\nthrown upwards to the first nullable field 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-querydepthlimit", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "OpenIDConnectConfig": { "Type": "OpenIDConnectConfig", "Required": false, "MarkdownDocumentation": "`OpenIDConnectConfig`\n\nThe OpenID Connect configuration.\n*Required*: No\n*Type*: [OpenIDConnectConfig](./aws-properties-appsync-graphqlapi-openidconnectconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig", "UpdateType": "Mutable" }, "IntrospectionConfig": { "Required": false, "MarkdownDocumentation": "`IntrospectionConfig`\n\nSets the value of the GraphQL API to enable (`ENABLED`) or disable\n(`DISABLED`) introspection. If no value is provided, the introspection\nconfiguration will be set to `ENABLED` by default. This field will produce an\nerror if the operation attempts to use the introspection feature while this field is\ndisabled.\nFor more information about introspection, see [GraphQL introspection](https://graphql.org/learn/introspection/).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-introspectionconfig", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MergedApiExecutionRoleArn": { "Required": false, "MarkdownDocumentation": "`MergedApiExecutionRoleArn`\n\nThe AWS Identity and Access Management service role ARN for a merged\nAPI. The AppSync service assumes this role on behalf of the Merged API to validate\naccess to source APIs at runtime and to prompt the `AUTO_MERGE` to update the\nmerged API endpoint with the source API changes automatically.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-mergedapiexecutionrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EnhancedMetricsConfig": { "Type": "EnhancedMetricsConfig", "Required": false, "MarkdownDocumentation": "`EnhancedMetricsConfig`\n\nEnables and controls the enhanced metrics feature. Enhanced metrics emit granular data\non API usage and performance such as AppSync request and error counts, latency, and\ncache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you\ncan configure the types of data that will be sent.\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\nFor more information, see [Monitoring and\nlogging](https://docs.aws.amazon.com//appsync/latest/devguide/monitoring.html#cw-metrics) in the *AWS AppSync User Guide*.\n*Required*: No\n*Type*: [EnhancedMetricsConfig](./aws-properties-appsync-graphqlapi-enhancedmetricsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-enhancedmetricsconfig", "UpdateType": "Mutable" }, "OwnerContact": { "Required": false, "MarkdownDocumentation": "`OwnerContact`\n\nThe owner contact information for an API resource.\nThis field accepts any string input with a length of 0 - 256 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-ownercontact", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResolverCountLimit": { "Required": false, "MarkdownDocumentation": "`ResolverCountLimit`\n\nThe maximum number of resolvers that can be invoked in a single request. The default\nvalue is `0` (or unspecified), which will set the limit to\n`10000`. When specified, the limit value can be between `1` and\n`10000`. This field will produce a limit error if the operation falls out\nof bounds.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-resolvercountlimit", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe API name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[_A-Za-z][_0-9A-Za-z]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AdditionalAuthenticationProviders": { "Type": "List", "Required": false, "MarkdownDocumentation": "`AdditionalAuthenticationProviders`\n\nA list of additional authentication providers for the `GraphqlApi` API.\n*Required*: No\n*Type*: Array of [AdditionalAuthenticationProvider](./aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-additionalauthenticationproviders", "ItemType": "AdditionalAuthenticationProvider", "UpdateType": "Mutable" }, "EnvironmentVariables": { "Required": false, "MarkdownDocumentation": "`EnvironmentVariables`\n\nA map containing the list of resources with their properties and environment\nvariables. For more information, see [Environmental\nvariables](https://docs.aws.amazon.com/appsync/latest/devguide/environmental-variables.html).\n*Pattern*: `^[A-Za-z]+\\\\w*$\\\\`\n*Minimum*: 2\n*Maximum*: 64\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[A-Za-z]+\\w*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-environmentvariables", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "ApiType": { "Required": false, "MarkdownDocumentation": "`ApiType`\n\nThe value that indicates whether the GraphQL API is a standard API\n(`GRAPHQL`) or merged API (`MERGED`).\n**WARNING**: If the `ApiType` has not been\ndefined, **explicitly** setting it to `GRAPHQL`\nin a template/stack update will result in an API replacement and new DNS values.\nThe following values are valid:\n`GRAPHQL | MERGED`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-apitype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "LambdaAuthorizerConfig": { "Type": "LambdaAuthorizerConfig", "Required": false, "MarkdownDocumentation": "`LambdaAuthorizerConfig`\n\nA `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.\nBe aware that an AWS AppSync API may have only one Lambda authorizer\nconfigured at a time.\n*Required*: No\n*Type*: [LambdaAuthorizerConfig](./aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-lambdaauthorizerconfig", "UpdateType": "Mutable" }, "XrayEnabled": { "Required": false, "MarkdownDocumentation": "`XrayEnabled`\n\nA flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-xrayenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Visibility": { "Required": false, "MarkdownDocumentation": "`Visibility`\n\nSets the scope of the GraphQL API to public (`GLOBAL`) or private\n(`PRIVATE`). By default, the scope is set to `Global` if no\nvalue is provided.\n**WARNING**: If `Visibility` has not been\ndefined, **explicitly** setting it to `GLOBAL`\nin a template/stack update will result in an API replacement and new DNS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-visibility", "PrimitiveType": "String", "UpdateType": "Mutable" }, "UserPoolConfig": { "Type": "UserPoolConfig", "Required": false, "MarkdownDocumentation": "`UserPoolConfig`\n\nOptional authorization configuration for using Amazon Cognito user pools with your\nGraphQL endpoint.\n*Required*: No\n*Type*: [UserPoolConfig](./aws-properties-appsync-graphqlapi-userpoolconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key-value pairs) for this GraphQL API.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-appsync-graphqlapi-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "AuthenticationType": { "Required": true, "MarkdownDocumentation": "`AuthenticationType`\n\nSecurity configuration for your GraphQL API. For allowed values (such as\n`API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`,\n`OPENID_CONNECT`, or `AWS_LAMBDA`), see [Security](https://docs.aws.amazon.com/appsync/latest/devguide/security.html) in\nthe *AWS AppSync Developer Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `API_KEY | AWS_IAM | AMAZON_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS", "OPENID_CONNECT", "AWS_LAMBDA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-authenticationtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "LogConfig": { "Type": "LogConfig", "Required": false, "MarkdownDocumentation": "`LogConfig`\n\nThe Amazon CloudWatch Logs configuration.\n*Required*: No\n*Type*: [LogConfig](./aws-properties-appsync-graphqlapi-logconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-logconfig", "UpdateType": "Mutable" } } }, "AWS::AppSync::GraphQLSchema": { "MarkdownDocumentation": "`AWS::AppSync::GraphQLSchema`\n\nThe `AWS::AppSync::GraphQLSchema` resource is used for your AWS AppSync GraphQL schema that controls the data model for your API. Schema\nfiles are text written in Schema Definition Language (SDL) format. For more information\nabout schema authoring, see [Designing a GraphQL\nAPI](https://docs.aws.amazon.com/appsync/latest/devguide/designing-a-graphql-api.html) in the *AWS AppSync Developer\nGuide*.\n###### Note\nWhen you submit an update, AWS CloudFormation updates resources based on\ndifferences between what you submit and the stack's current template. To cause this\nresource to be updated you must change a property value for this resource in the\nCloudFormation template. Changing the Amazon S3 file\ncontent without changing a property value will not result in an update\noperation.\nSee [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AppSync::GraphQLSchema` resource\nto the intrinsic `Ref` function, the function returns the GraphQL API ID with\nthe literal String GraphQLSchema attached to it.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html", "Properties": { "Definition": { "Required": false, "MarkdownDocumentation": "`Definition`\n\nThe text representation of a GraphQL schema in SDL format.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definition", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DefinitionS3Location": { "Required": false, "MarkdownDocumentation": "`DefinitionS3Location`\n\nThe location of a GraphQL schema file in an Amazon S3 bucket. Use this if\nyou want to provision with the schema living in Amazon S3 rather than\nembedding it in your CloudFormation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definitions3location", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ApiId": { "Required": true, "MarkdownDocumentation": "`ApiId`\n\nThe AWS AppSync GraphQL API identifier to which you want to apply this\nschema.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-apiid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::AppSync::Resolver": { "MarkdownDocumentation": "`AWS::AppSync::Resolver`\n\nThe `AWS::AppSync::Resolver` resource defines the logical GraphQL resolver\nthat you attach to fields in a schema. Request and response templates for resolvers are\nwritten in Apache Velocity Template Language (VTL) format. For more information about\nresolvers, see [Resolver\nMapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).\n###### Note\nWhen you submit an update, AWS CloudFormation updates resources based on\ndifferences between what you submit and the stack's current template. To cause this\nresource to be updated you must change a property value for this resource in the\nCloudFormation template. Changing the Amazon S3 file\ncontent without changing a property value will not result in an update\noperation.\nSee [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AppSync::Resolver` resource to the\nintrinsic `Ref` function, the function returns the ARN of the Resolver, such\nas\n`arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/types/typename/resolvers/resolvername`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html", "Properties": { "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe GraphQL type that invokes this resolver.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-typename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PipelineConfig": { "MarkdownDocumentation": "`PipelineConfig`\n\nFunctions linked with the pipeline resolver.\n*Required*: No\n*Type*: [PipelineConfig](./aws-properties-appsync-resolver-pipelineconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-pipelineconfig", "UpdateType": "Mutable", "Required": false, "Type": "PipelineConfig" }, "RequestMappingTemplate": { "MarkdownDocumentation": "`RequestMappingTemplate`\n\nThe request mapping template.\nRequest mapping templates are optional when using a Lambda data source. For all other\ndata sources, a request mapping template is required.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-requestmappingtemplate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseMappingTemplate": { "MarkdownDocumentation": "`ResponseMappingTemplate`\n\nThe response mapping template.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-responsemappingtemplate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxBatchSize": { "MarkdownDocumentation": "`MaxBatchSize`\n\nThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-maxbatchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SyncConfig": { "MarkdownDocumentation": "`SyncConfig`\n\nThe `SyncConfig` for a resolver attached to a versioned data source.\n*Required*: No\n*Type*: [SyncConfig](./aws-properties-appsync-resolver-syncconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-syncconfig", "UpdateType": "Mutable", "Required": false, "Type": "SyncConfig" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe `resolver` code that contains the request and response functions. When\ncode is used, the `runtime` is required. The runtime value must be\n`APPSYNC_JS`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-code", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricsConfig": { "MarkdownDocumentation": "`MetricsConfig`\n\nEnables or disables enhanced resolver metrics for specified resolvers. Note that\n`MetricsConfig` won't be used unless the\n`resolverLevelMetricsBehavior` value is set to\n`PER_RESOLVER_METRICS`. If the `resolverLevelMetricsBehavior`\nis set to `FULL_REQUEST_RESOLVER_METRICS` instead, `MetricsConfig`\nwill be ignored. However, you can still set its value.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-metricsconfig", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResponseMappingTemplateS3Location": { "MarkdownDocumentation": "`ResponseMappingTemplateS3Location`\n\nThe location of a response mapping template in an Amazon S3 bucket. Use this\nif you want to provision with a template file in Amazon S3 rather than\nembedding it in your CloudFormation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-responsemappingtemplates3location", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nDescribes a runtime used by an AWS AppSync resolver or AWS AppSync function. Specifies the name and version of the runtime to use.\nNote that if a runtime is specified, code must also be specified.\n*Required*: No\n*Type*: [AppSyncRuntime](./aws-properties-appsync-resolver-appsyncruntime.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-runtime", "UpdateType": "Mutable", "Required": false, "Type": "AppSyncRuntime" }, "CodeS3Location": { "MarkdownDocumentation": "`CodeS3Location`\n\nThe Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-codes3location", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSourceName": { "MarkdownDocumentation": "`DataSourceName`\n\nThe resolver data source name.\n*Required*: No\n*Type*: String\n*Pattern*: `[_A-Za-z][_0-9A-Za-z]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-datasourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Kind": { "MarkdownDocumentation": "`Kind`\n\nThe resolver type.\n* **UNIT**: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.\n* **PIPELINE**: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of `Function` objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNIT | PIPELINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UNIT", "PIPELINE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-kind", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CachingConfig": { "MarkdownDocumentation": "`CachingConfig`\n\nThe caching configuration for the resolver.\n*Required*: No\n*Type*: [CachingConfig](./aws-properties-appsync-resolver-cachingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-cachingconfig", "UpdateType": "Mutable", "Required": false, "Type": "CachingConfig" }, "RequestMappingTemplateS3Location": { "MarkdownDocumentation": "`RequestMappingTemplateS3Location`\n\nThe location of a request mapping template in an Amazon S3 bucket. Use this\nif you want to provision with a template file in Amazon S3 rather than\nembedding it in your CloudFormation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-requestmappingtemplates3location", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApiId": { "MarkdownDocumentation": "`ApiId`\n\nThe AWS AppSync GraphQL API to which you want to attach this\nresolver.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-apiid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FieldName": { "MarkdownDocumentation": "`FieldName`\n\nThe GraphQL field on a type that invokes the resolver.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-fieldname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "TypeName": { "PrimitiveType": "String", "MarkdownDocumentation": "`TypeName`\n\nThe GraphQL type that invokes this resolver.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#TypeName-fn::getatt" }, "ResolverArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResolverArn`\n\nARN of the resolver, such as\n`arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/types/typename/resolvers/resolvername`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#ResolverArn-fn::getatt" }, "FieldName": { "PrimitiveType": "String", "MarkdownDocumentation": "`FieldName`\n\nThe GraphQL field on a type that invokes the resolver.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#FieldName-fn::getatt" } } }, "AWS::AppSync::SourceApiAssociation": { "MarkdownDocumentation": "`AWS::AppSync::SourceApiAssociation`\n\nDescribes the configuration of a source API. A source API is a GraphQL API that is\nlinked to a merged API. There can be multiple source APIs attached to each merged API.\nWhen linked to a merged API, the source API's schema, data sources, and resolvers will\nbe combined with other linked source API data to form a new, singular API. Source APIs\ncan originate from your account or from other accounts via Resource Access Manager.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AppSync::SourceApiAssociation`\nresource to the intrinsic `Ref` function, the function returns the ARN of the\nsource API association.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description field of the association 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#cfn-appsync-sourceapiassociation-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceApiAssociationConfig": { "MarkdownDocumentation": "`SourceApiAssociationConfig`\n\nThe `SourceApiAssociationConfig` object data.\n*Required*: No\n*Type*: [SourceApiAssociationConfig](./aws-properties-appsync-sourceapiassociation-sourceapiassociationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#cfn-appsync-sourceapiassociation-sourceapiassociationconfig", "UpdateType": "Mutable", "Required": false, "Type": "SourceApiAssociationConfig" }, "MergedApiIdentifier": { "MarkdownDocumentation": "`MergedApiIdentifier`\n\nThe identifier of the AppSync Merged API. This is generated by the AppSync service. In\nmost cases, Merged APIs (especially in your account) only require the API ID value or\nARN of the merged API. However, Merged APIs from other accounts (cross-account use\ncases) strictly require the full resource ARN of the merged API.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#cfn-appsync-sourceapiassociation-mergedapiidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceApiIdentifier": { "MarkdownDocumentation": "`SourceApiIdentifier`\n\nThe identifier of the AppSync Source API. This is generated by the AppSync service. In\nmost cases, source APIs (especially in your account) only require the API ID value or\nARN of the source API. However, source APIs from other accounts (cross-account use\ncases) strictly require the full resource ARN of the source API.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#cfn-appsync-sourceapiassociation-sourceapiidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "AssociationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationArn`\n\nThe Amazon Resource Name (ARN) of the source API association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#AssociationArn-fn::getatt" }, "MergedApiId": { "PrimitiveType": "String", "MarkdownDocumentation": "`MergedApiId`\n\nThe ID of the merged API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#MergedApiId-fn::getatt" }, "SourceApiArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceApiArn`\n\nThe source API's Amazon Resource Name (ARN) value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#SourceApiArn-fn::getatt" }, "LastSuccessfulMergeDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastSuccessfulMergeDate`\n\nThe datetime value of the last successful merge of the source API association. The\nresult will be in UTC format and your local time zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#LastSuccessfulMergeDate-fn::getatt" }, "SourceApiAssociationStatusDetail": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceApiAssociationStatusDetail`\n\nThe message describing the state of the source API association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#SourceApiAssociationStatusDetail-fn::getatt" }, "MergedApiArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MergedApiArn`\n\nThe Amazon Resource Name (ARN) of the merged API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#MergedApiArn-fn::getatt" }, "AssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationId`\n\nThe ID generated by the AppSync service for the source API association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#AssociationId-fn::getatt" }, "SourceApiAssociationStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceApiAssociationStatus`\n\nThe state of the source API association.\nThe following values are valid:\n`MERGE_SCHEDULED | MERGE_FAILED | MERGE_SUCCESS | MERGE_IN_PROGRESS |\nAUTO_MERGE_SCHEDULE_FAILED | DELETION_SCHEDULED | DELETION_IN_PROGRESS |\nDELETION_FAILED`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#SourceApiAssociationStatus-fn::getatt" }, "SourceApiId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceApiId`\n\nThe ID of the source API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#SourceApiId-fn::getatt" } } }, "AWS::ApplicationAutoScaling::ScalableTarget": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalableTarget`\n\nThe `AWS::ApplicationAutoScaling::ScalableTarget` resource specifies a resource\nthat Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service\nresource.\nFor more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the\n*Application Auto Scaling User Guide*.\n###### Note\nIf the resource that you want Application Auto Scaling to scale is not yet created in\nyour account, add a dependency on the resource when registering it as a scalable target\nusing the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)\nattribute.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic\nfunction, `Ref` returns the CloudFormation-generated ID of the resource. For\nexample:\n`service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH|ecs:service:DesiredCount|ecs`.\nCloudFormation uses the following format to generate the ID:\n`service/resource_ID|scalable_dimension|service_namespace`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html", "Properties": { "ScheduledActions": { "MarkdownDocumentation": "`ScheduledActions`\n\nThe scheduled actions for the scalable target. Duplicates aren't allowed.\n*Required*: No\n*Type*: Array of [ScheduledAction](./aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scheduledactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ScheduledAction", "DuplicatesAllowed": false }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe identifier of the resource associated with the scalable target.\nThis string consists of the resource type and unique identifier.\n* ECS service - The resource type is `service` and the unique identifier is the cluster name\n and service name. Example: `service/my-cluster/my-service`.\n* Spot Fleet - The resource type is `spot-fleet-request` and the unique identifier is the\n Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.\n* EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID.\n Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`.\n* AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name.\n Example: `fleet/sample-fleet`.\n* DynamoDB table - The resource type is `table` and the unique identifier is the table name.\n Example: `table/my-table`.\n* DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name.\n Example: `table/my-table/index/my-table-index`.\n* Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name.\n Example: `cluster:my-db-cluster`.\n* SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID.\n Example: `endpoint/my-end-point/variant/KMeansClustering`.\n* Custom resources are not supported with a resource type. This parameter must specify the `OutputValue` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our [GitHub\n repository](https://github.com/aws/aws-auto-scaling-custom-resource).\n* Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`.\n* Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`.\n* Lambda provisioned concurrency - The resource type is `function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST`.\n Example: `function:my-function:prod` or `function:my-function:1`.\n* Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name.\n Example: `keyspace/mykeyspace/table/mytable`.\n* Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.\n Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`.\n* Amazon ElastiCache replication group - The resource type is `replication-group` and the unique identifier is the replication group name.\n Example: `replication-group/mycluster`.\n* Amazon ElastiCache cache cluster - The resource type is `cache-cluster` and the unique identifier is the cache cluster name.\n Example: `cache-cluster/mycluster`.\n* Neptune cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster`.\n* SageMaker serverless endpoint - The resource type is `variant` and the unique identifier is the resource ID.\n Example: `endpoint/my-end-point/variant/KMeansClustering`.\n* SageMaker inference component - The resource type is `inference-component` and the unique identifier is the resource ID.\n Example: `inference-component/my-inference-component`.\n* Pool of WorkSpaces - The resource type is `workspacespool` and the unique identifier is the pool ID.\n Example: `workspacespool/wspool-123456`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `1600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-resourceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ServiceNamespace": { "MarkdownDocumentation": "`ServiceNamespace`\n\nThe namespace of the AWS service that provides the resource, or a\n`custom-resource`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ecs | elasticmapreduce | ec...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ecs", "elasticmapreduce", "ec2", "appstream", "dynamodb", "rds", "sagemaker", "custom-resource", "comprehend", "lambda", "cassandra", "kafka", "elasticache", "neptune", "workspaces" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-servicenamespace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ScalableDimension": { "MarkdownDocumentation": "`ScalableDimension`\n\nThe scalable dimension associated with the scalable target.\nThis string consists of the service namespace, resource type, and scaling property.\n* `ecs:service:DesiredCount` - The task count of an ECS service.\n* `elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group.\n* `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet.\n* `appstream:fleet:DesiredCapacity` - The capacity of an AppStream 2.0 fleet.\n* `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table.\n* `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table.\n* `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index.\n* `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index.\n* `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.\n* `sagemaker:variant:DesiredInstanceCount` - The number of EC2 instances for a SageMaker model endpoint variant.\n* `custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service.\n* `comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint.\n* `comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.\n* `lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function.\n* `cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table.\n* `cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table.\n* `kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.\n* `elasticache:cache-cluster:Nodes` - The number of nodes for an Amazon ElastiCache cache cluster.\n* `elasticache:replication-group:NodeGroups` - The number of node groups for an Amazon ElastiCache replication group.\n* `elasticache:replication-group:Replicas` - The number of replicas per node group for an Amazon ElastiCache replication group.\n* `neptune:cluster:ReadReplicaCount` - The count of read replicas in an Amazon Neptune DB cluster.\n* `sagemaker:variant:DesiredProvisionedConcurrency` - The provisioned concurrency for a SageMaker serverless endpoint.\n* `sagemaker:inference-component:DesiredCopyCount` - The number of copies across an endpoint for a SageMaker inference component.\n* `workspaces:workspacespool:DesiredUserSessions` - The number of user sessions for the WorkSpaces in the pool.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ecs:service:DesiredCount | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "elasticmapreduce:instancegroup:InstanceCount", "appstream:fleet:DesiredCapacity", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits", "rds:cluster:ReadReplicaCount", "sagemaker:variant:DesiredInstanceCount", "custom-resource:ResourceType:Property", "comprehend:document-classifier-endpoint:DesiredInferenceUnits", "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits", "lambda:function:ProvisionedConcurrency", "cassandra:table:ReadCapacityUnits", "cassandra:table:WriteCapacityUnits", "kafka:broker-storage:VolumeSize", "elasticache:cache-cluster:Nodes", "elasticache:replication-group:NodeGroups", "elasticache:replication-group:Replicas", "neptune:cluster:ReadReplicaCount", "sagemaker:variant:DesiredProvisionedConcurrency", "sagemaker:inference-component:DesiredCopyCount", "workspaces:workspacespool:DesiredUserSessions" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scalabledimension", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SuspendedState": { "MarkdownDocumentation": "`SuspendedState`\n\nAn embedded object that contains attributes and attribute values that are used to suspend\nand resume automatic scaling. Setting the value of an attribute to `true` suspends\nthe specified scaling activities. Setting it to `false` (default) resumes the\nspecified scaling activities.\n**Suspension Outcomes**\n* For `DynamicScalingInSuspended`, while a suspension is in effect, all\n scale-in activities that are triggered by a scaling policy are suspended.\n* For `DynamicScalingOutSuspended`, while a suspension is in effect, all\n scale-out activities that are triggered by a scaling policy are suspended.\n* For `ScheduledScalingSuspended`, while a suspension is in effect, all\n scaling activities that involve scheduled actions are suspended.\n*Required*: No\n*Type*: [SuspendedState](./aws-properties-applicationautoscaling-scalabletarget-suspendedstate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-suspendedstate", "UpdateType": "Mutable", "Required": false, "Type": "SuspendedState" }, "MinCapacity": { "MarkdownDocumentation": "`MinCapacity`\n\nThe minimum value that you plan to scale in to. When a scaling policy is in effect,\nApplication Auto Scaling can scale in (contract) as needed to the minimum capacity limit in\nresponse to changing demand.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-mincapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nSpecify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\nthat allows Application Auto Scaling to modify the scalable target on your behalf. This can be\neither an IAM service role that Application Auto Scaling can assume to make calls to other\nAWS resources on your behalf, or a service-linked role for the specified\nservice. For more information, see [How Application\nAuto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User\nGuide*.\nTo automatically create a service-linked role (recommended), specify the full ARN of the\nservice-linked role in your stack template. To find the exact ARN of the service-linked role\nfor your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User\nGuide*. Look for the ARN in the table at the bottom of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum value that you plan to scale out to. When a scaling policy is in effect,\nApplication Auto Scaling can scale out (expand) as needed to the maximum capacity limit in\nresponse to changing demand.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-maxcapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#Id-fn::getatt" } } }, "AWS::ApplicationAutoScaling::ScalingPolicy": { "MarkdownDocumentation": "`AWS::ApplicationAutoScaling::ScalingPolicy`\n\nThe `AWS::ApplicationAutoScaling::ScalingPolicy` resource defines a scaling\npolicy that Application Auto Scaling uses to adjust the capacity of a scalable target.\nFor more information, see [Target\ntracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User\nGuide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic\nfunction, `Ref` returns the Application Auto Scaling scaling policy Amazon Resource\nName (ARN). For example:\n`arn:aws:autoscaling:us-east-2:123456789012:scalingPolicy:12ab3c4d-56789-0ef1-2345-6ghi7jk8lm90:resource/ecs/service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH:policyName/MyStepPolicy`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html", "Properties": { "PolicyType": { "MarkdownDocumentation": "`PolicyType`\n\nThe scaling policy type.\nThe following policy types are supported:\n`TargetTrackingScaling`\u2014Not supported for Amazon EMR\n`StepScaling`\u2014Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\nNeptune.\n`PredictiveScaling`\u2014Only supported for Amazon ECS\n*Required*: Yes\n*Type*: String\n*Allowed values*: `StepScaling | TargetTrackin...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "StepScaling", "TargetTrackingScaling", "PredictiveScaling" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policytype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe identifier of the resource associated with the scaling policy.\nThis string consists of the resource type and unique identifier.\n* ECS service - The resource type is `service` and the unique identifier is the cluster name\n and service name. Example: `service/my-cluster/my-service`.\n* Spot Fleet - The resource type is `spot-fleet-request` and the unique identifier is the\n Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.\n* EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID.\n Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`.\n* AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name.\n Example: `fleet/sample-fleet`.\n* DynamoDB table - The resource type is `table` and the unique identifier is the table name.\n Example: `table/my-table`.\n* DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name.\n Example: `table/my-table/index/my-table-index`.\n* Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name.\n Example: `cluster:my-db-cluster`.\n* SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID.\n Example: `endpoint/my-end-point/variant/KMeansClustering`.\n* Custom resources are not supported with a resource type. This parameter must specify the `OutputValue` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our [GitHub\n repository](https://github.com/aws/aws-auto-scaling-custom-resource).\n* Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`.\n* Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`.\n* Lambda provisioned concurrency - The resource type is `function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST`.\n Example: `function:my-function:prod` or `function:my-function:1`.\n* Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name.\n Example: `keyspace/mykeyspace/table/mytable`.\n* Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.\n Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`.\n* Amazon ElastiCache replication group - The resource type is `replication-group` and the unique identifier is the replication group name.\n Example: `replication-group/mycluster`.\n* Amazon ElastiCache cache cluster - The resource type is `cache-cluster` and the unique identifier is the cache cluster name.\n Example: `cache-cluster/mycluster`.\n* Neptune cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster`.\n* SageMaker serverless endpoint - The resource type is `variant` and the unique identifier is the resource ID.\n Example: `endpoint/my-end-point/variant/KMeansClustering`.\n* SageMaker inference component - The resource type is `inference-component` and the unique identifier is the resource ID.\n Example: `inference-component/my-inference-component`.\n* Pool of WorkSpaces - The resource type is `workspacespool` and the unique identifier is the pool ID.\n Example: `workspacespool/wspool-123456`.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `1`\n*Maximum*: `1600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-resourceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ScalingTargetId": { "MarkdownDocumentation": "`ScalingTargetId`\n\nThe CloudFormation-generated ID of an Application Auto Scaling scalable target. For more\ninformation about the ID, see the Return Value section of the\n`AWS::ApplicationAutoScaling::ScalableTarget` resource.\n###### Important\nYou must specify either the `ScalingTargetId` property, or the\n`ResourceId`, `ScalableDimension`, and `ServiceNamespace`\nproperties, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-scalingtargetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the scaling policy.\nUpdates to the name of a target tracking scaling policy are not supported, unless you also\nupdate the metric used for scaling. To change only a target tracking scaling policy's name,\nfirst delete the policy by removing the existing\n`AWS::ApplicationAutoScaling::ScalingPolicy` resource from the template and\nupdating the stack. Then, recreate the resource with the same settings and a different\nname.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\p{Print}+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ServiceNamespace": { "MarkdownDocumentation": "`ServiceNamespace`\n\nThe namespace of the AWS service that provides the resource, or a\n`custom-resource`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ecs | elasticmapreduce | ec...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ecs", "elasticmapreduce", "ec2", "appstream", "dynamodb", "rds", "sagemaker", "custom-resource", "comprehend", "lambda", "cassandra", "kafka", "elasticache", "neptune", "workspaces" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-servicenamespace", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ScalableDimension": { "MarkdownDocumentation": "`ScalableDimension`\n\nThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n* `ecs:service:DesiredCount` - The task count of an ECS service.\n* `elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group.\n* `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet.\n* `appstream:fleet:DesiredCapacity` - The capacity of an AppStream 2.0 fleet.\n* `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table.\n* `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table.\n* `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index.\n* `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index.\n* `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.\n* `sagemaker:variant:DesiredInstanceCount` - The number of EC2 instances for a SageMaker model endpoint variant.\n* `custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service.\n* `comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint.\n* `comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.\n* `lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function.\n* `cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table.\n* `cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table.\n* `kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.\n* `elasticache:cache-cluster:Nodes` - The number of nodes for an Amazon ElastiCache cache cluster.\n* `elasticache:replication-group:NodeGroups` - The number of node groups for an Amazon ElastiCache replication group.\n* `elasticache:replication-group:Replicas` - The number of replicas per node group for an Amazon ElastiCache replication group.\n* `neptune:cluster:ReadReplicaCount` - The count of read replicas in an Amazon Neptune DB cluster.\n* `sagemaker:variant:DesiredProvisionedConcurrency` - The provisioned concurrency for a SageMaker serverless endpoint.\n* `sagemaker:inference-component:DesiredCopyCount` - The number of copies across an endpoint for a SageMaker inference component.\n* `workspaces:workspacespool:DesiredUserSessions` - The number of user sessions for the WorkSpaces in the pool.\n*Required*: No\n*Type*: String\n*Allowed values*: `ecs:service:DesiredCount | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "elasticmapreduce:instancegroup:InstanceCount", "appstream:fleet:DesiredCapacity", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits", "rds:cluster:ReadReplicaCount", "sagemaker:variant:DesiredInstanceCount", "custom-resource:ResourceType:Property", "comprehend:document-classifier-endpoint:DesiredInferenceUnits", "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits", "lambda:function:ProvisionedConcurrency", "cassandra:table:ReadCapacityUnits", "cassandra:table:WriteCapacityUnits", "kafka:broker-storage:VolumeSize", "elasticache:cache-cluster:Nodes", "elasticache:replication-group:NodeGroups", "elasticache:replication-group:Replicas", "neptune:cluster:ReadReplicaCount", "sagemaker:variant:DesiredProvisionedConcurrency", "sagemaker:inference-component:DesiredCopyCount", "workspaces:workspacespool:DesiredUserSessions" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-scalabledimension", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TargetTrackingScalingPolicyConfiguration": { "MarkdownDocumentation": "`TargetTrackingScalingPolicyConfiguration`\n\nA target tracking scaling policy.\n*Required*: No\n*Type*: [TargetTrackingScalingPolicyConfiguration](./aws-properties-applicationautoscaling-scalingpolicy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TargetTrackingScalingPolicyConfiguration" }, "StepScalingPolicyConfiguration": { "MarkdownDocumentation": "`StepScalingPolicyConfiguration`\n\nA step scaling policy.\n*Required*: No\n*Type*: [StepScalingPolicyConfiguration](./aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StepScalingPolicyConfiguration" }, "PredictiveScalingPolicyConfiguration": { "MarkdownDocumentation": "`PredictiveScalingPolicyConfiguration`\n\nThe predictive scaling policy configuration.\n*Required*: No\n*Type*: [PredictiveScalingPolicyConfiguration](./aws-properties-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-predictivescalingpolicyconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingPolicyConfiguration" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of a scaling policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#Arn-fn::getatt" } } }, "AWS::ApplicationInsights::Application": { "MarkdownDocumentation": "`AWS::ApplicationInsights::Application`\n\nThe `AWS::ApplicationInsights::Application` resource adds an application that is created from a resource group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the application, such as\n`arn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html", "Properties": { "AutoConfigurationEnabled": { "MarkdownDocumentation": "`AutoConfigurationEnabled`\n\nIf set to `true`, the application components will be configured with the monitoring configuration recommended by Application 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-autoconfigurationenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "OpsItemSNSTopicArn": { "MarkdownDocumentation": "`OpsItemSNSTopicArn`\n\nThe SNS topic provided to Application Insights that is associated with the created\nOpsItems to receive SNS notifications for opsItem updates.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$`\n*Minimum*: `20`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-opsitemsnstopicarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OpsCenterEnabled": { "MarkdownDocumentation": "`OpsCenterEnabled`\n\nIndicates whether Application Insights will create OpsItems for any problem that is\ndetected by Application Insights for an application.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-opscenterenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CustomComponents": { "MarkdownDocumentation": "`CustomComponents`\n\nDescribes a custom component by grouping similar standalone instances to monitor.\n*Required*: No\n*Type*: Array of [CustomComponent](./aws-properties-applicationinsights-application-customcomponent.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-customcomponents", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomComponent", "DuplicatesAllowed": true }, "SNSNotificationArn": { "MarkdownDocumentation": "`SNSNotificationArn`\n\nThe SNS topic ARN that is associated with SNS notifications for updates or issues.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$`\n*Minimum*: `20`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-snsnotificationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttachMissingPermission": { "MarkdownDocumentation": "`AttachMissingPermission`\n\nIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-attachmissingpermission", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LogPatternSets": { "MarkdownDocumentation": "`LogPatternSets`\n\nThe log pattern sets.\n*Required*: No\n*Type*: Array of [LogPatternSet](./aws-properties-applicationinsights-application-logpatternset.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-logpatternsets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LogPatternSet", "DuplicatesAllowed": true }, "GroupingType": { "MarkdownDocumentation": "`GroupingType`\n\nApplication Insights can create applications based on a resource group or on an account.\nTo create an account-based application using all of the resources in the account, set this\nparameter to `ACCOUNT_BASED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCOUNT_BASED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ACCOUNT_BASED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-groupingtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ComponentMonitoringSettings": { "MarkdownDocumentation": "`ComponentMonitoringSettings`\n\nThe monitoring settings of the components. Not required to set up default monitoring for all components. To set up default monitoring for all components, set `AutoConfigurationEnabled` to `true`.\n*Required*: No\n*Type*: Array of [ComponentMonitoringSetting](./aws-properties-applicationinsights-application-componentmonitoringsetting.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-componentmonitoringsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ComponentMonitoringSetting", "DuplicatesAllowed": true }, "CWEMonitorEnabled": { "MarkdownDocumentation": "`CWEMonitorEnabled`\n\nIndicates whether Application Insights can listen to CloudWatch events for the application resources, such as `instance terminated`, `failed deployment`, and others.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-cwemonitorenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of `Tags`.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-applicationinsights-application-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ResourceGroupName": { "MarkdownDocumentation": "`ResourceGroupName`\n\nThe name of the resource group used for the application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9.-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-resourcegroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ApplicationARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApplicationARN`\n\nReturns the Amazon Resource Name (ARN) of the application, such as\n `arn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#ApplicationARN-fn::getatt" } } }, "AWS::ApplicationSignals::Discovery": { "MarkdownDocumentation": "`AWS::ApplicationSignals::Discovery`\n\n###### Note\nIf you have existing `AWS::ApplicationSignals::Discovery` resources that were created prior to the Application Map release, you will need to delete and recreate these resources in your account to enable Application Map.\nEnables this AWS account to be able to use CloudWatch Application Signals by creating the `AWSServiceRoleForCloudWatchApplicationSignals` service-linked role. This service-linked role has the following permissions:\n* `xray:GetServiceGraph`\n* `logs:StartQuery`\n* `logs:GetQueryResults`\n* `cloudwatch:GetMetricData`\n* `cloudwatch:ListMetrics`\n* `tag:GetResources`\n* `autoscaling:DescribeAutoScalingGroups`\nA service-linked CloudTrail event channel is created to process CloudTrail events and return change event information. This includes last deployment time, userName, eventName, and other event metadata.\nAfter completing this step, you still need to instrument your Java and Python applications to send data to Application Signals. For more information, see\n[Enabling Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Signals-Enable.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the 12 digit AWS Account ID for the account.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-discovery.html", "Properties": {}, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe 12 digit AWS Account ID for the account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-discovery.html#AccountId-fn::getatt" } } }, "AWS::ApplicationSignals::GroupingConfiguration": { "MarkdownDocumentation": "`AWS::ApplicationSignals::GroupingConfiguration`\n\nA structure that contains the complete grouping configuration for an account, including all defined grouping attributes and metadata about when it was last updated.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the 12 digit AWS Account ID for the account.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-groupingconfiguration.html", "Properties": { "GroupingAttributeDefinitions": { "MarkdownDocumentation": "`GroupingAttributeDefinitions`\n\nAn array of grouping attribute definitions that specify how services should be grouped based on various attributes and source keys.\n*Required*: Yes\n*Type*: Array of [GroupingAttributeDefinition](./aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-groupingconfiguration.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinitions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GroupingAttributeDefinition", "DuplicatesAllowed": true } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe 12 digit AWS Account ID for the account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-groupingconfiguration.html#AccountId-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when this grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-groupingconfiguration.html#UpdatedAt-fn::getatt" } } }, "AWS::ApplicationSignals::ServiceLevelObjective": { "MarkdownDocumentation": "`AWS::ApplicationSignals::ServiceLevelObjective`\n\nCreates or updates a service level objective (SLO), which can help you ensure that your critical business operations are\nmeeting customer expectations. Use SLOs to set and track specific target levels for the\nreliability and availability of your applications and services. SLOs use service level indicators (SLIs) to\ncalculate whether the application is performing at the level that you want.\nCreate an SLO to set a target for a service operation, or service dependency's availability or latency. CloudWatch\nmeasures this target frequently you can find whether it has been breached.\nThe target performance quality that is defined for an SLO is the *attainment goal*. An\nattainment goal is the percentage of time or requests that the SLI is expected to meet the threshold over each time interval.\nFor example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the\nperiods to be in healthy state.\nWhen you create an SLO, you specify whether it is a *period-based SLO*\nor a *request-based SLO*. Each type of SLO has a different way of evaluating\nyour application's performance against its attainment goal.\n* A *period-based SLO* uses defined *periods* of time within\n a specified total time interval. For each period of time, Application Signals determines whether the\n application met its goal. The attainment rate is calculated as the `number of good periods/number of total periods`.\n \n For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its\n performance goal during at least 99.9% of the\n time periods.\n* A *request-based SLO* doesn't use pre-defined periods of time. Instead,\n the SLO measures `number of good requests/number of total requests` during the interval. At any time, you can find the ratio of\n good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.\nAfter you have created an SLO, you can retrieve error budget reports for it.\nAn *error budget* is the amount of time or amount of requests that your application can be non-compliant\nwith the SLO's goal, and still have your application meet the goal.\n* For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold,\n while still meeting the overall goal. The *remaining error budget* decreases with every failed period\n that is recorded. The error budget within one interval can never increase.\n \n For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month\n translates to an error budget of 21.9 minutes of downtime per month.\n* For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on\n the ratio of good requests to total requests.\nWhen you call this operation, Application Signals creates the *AWSServiceRoleForCloudWatchApplicationSignals* service-linked role,\nif it doesn't already exist in your account. This service-\nlinked role has the following permissions:\n* `xray:GetServiceGraph`\n* `logs:StartQuery`\n* `logs:GetQueryResults`\n* `cloudwatch:GetMetricData`\n* `cloudwatch:ListMetrics`\n* `tag:GetResources`\n* `autoscaling:DescribeAutoScalingGroups`\nYou can easily set SLO targets for your applications, and their dependencies, that are discovered by Application Signals, using critical metrics such as latency and availability.\nYou can also set SLOs against any CloudWatch metric or math expression that produces a time series.\n###### Note\nYou can't create an SLO for a service operation that was discovered by Application Signals until after that operation has reported standard\nmetrics to Application Signals.\nYou cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.\nFor more information about SLOs, see [Service level objectives (SLOs)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the SLO. For example, `arn:aws:cloudwatch:us-west-1:123456789012:slo:my-slo-name`\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html", "Properties": { "BurnRateConfigurations": { "MarkdownDocumentation": "`BurnRateConfigurations`\n\nEach object in this array defines the length of the look-back window used to calculate one burn rate metric\nfor this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.\n*Required*: No\n*Type*: Array of [BurnRateConfiguration](./aws-properties-applicationsignals-servicelevelobjective-burnrateconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#cfn-applicationsignals-servicelevelobjective-burnrateconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BurnRateConfiguration", "DuplicatesAllowed": false }, "Sli": { "MarkdownDocumentation": "`Sli`\n\nA structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.\n*Required*: No\n*Type*: [Sli](./aws-properties-applicationsignals-servicelevelobjective-sli.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#cfn-applicationsignals-servicelevelobjective-sli", "UpdateType": "Mutable", "Required": false, "Type": "Sli" }, "Goal": { "MarkdownDocumentation": "`Goal`\n\nThis structure contains the attributes that determine the goal of an SLO. This includes\nthe time period for evaluation and the attainment threshold.\n*Required*: No\n*Type*: [Goal](./aws-properties-applicationsignals-servicelevelobjective-goal.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#cfn-applicationsignals-servicelevelobjective-goal", "UpdateType": "Mutable", "Required": false, "Type": "Goal" }, "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description for this SLO.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#cfn-applicationsignals-servicelevelobjective-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestBasedSli": { "MarkdownDocumentation": "`RequestBasedSli`\n\nA structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.\n*Required*: No\n*Type*: [RequestBasedSli](./aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli", "UpdateType": "Mutable", "Required": false, "Type": "RequestBasedSli" }, "ExclusionWindows": { "MarkdownDocumentation": "`ExclusionWindows`\n\nThe time window to be excluded from the SLO performance metrics.\n*Required*: No\n*Type*: Array of [ExclusionWindow](./aws-properties-applicationsignals-servicelevelobjective-exclusionwindow.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#cfn-applicationsignals-servicelevelobjective-exclusionwindows", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ExclusionWindow", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission.\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.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-applicationsignals-servicelevelobjective-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#cfn-applicationsignals-servicelevelobjective-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for this SLO.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#cfn-applicationsignals-servicelevelobjective-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`CreatedTime`\n\nThe date and time that this SLO was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe time that this SLO was most recently updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#LastUpdatedTime-fn::getatt" }, "EvaluationType": { "PrimitiveType": "String", "MarkdownDocumentation": "`EvaluationType`\n\nDisplays whether this is a period-based SLO or a request-based SLO.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#EvaluationType-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of this SLO.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-servicelevelobjective.html#Arn-fn::getatt" } } }, "AWS::Athena::CapacityReservation": { "MarkdownDocumentation": "`AWS::Athena::CapacityReservation`\n\nSpecifies a capacity reservation with the provided name and number of requested data\nprocessing units.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the capacity reservation.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html", "Properties": { "TargetDpus": { "MarkdownDocumentation": "`TargetDpus`\n\nThe number of data processing units requested.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#cfn-athena-capacityreservation-targetdpus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Long" }, "CapacityAssignmentConfiguration": { "MarkdownDocumentation": "`CapacityAssignmentConfiguration`\n\nAssigns Athena workgroups (and hence their queries) to capacity reservations. A\ncapacity reservation can have only one capacity assignment configuration, but the\ncapacity assignment configuration can be made up of multiple individual assignments.\nEach assignment specifies how Athena queries can consume capacity from the capacity\nreservation that their workgroup is mapped to.\n*Required*: No\n*Type*: [CapacityAssignmentConfiguration](./aws-properties-athena-capacityreservation-capacityassignmentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#cfn-athena-capacityreservation-capacityassignmentconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CapacityAssignmentConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the capacity reservation.\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-athena-capacityreservation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#cfn-athena-capacityreservation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the capacity reservation.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#cfn-athena-capacityreservation-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the capacity reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#Status-fn::getatt" }, "AllocatedDpus": { "PrimitiveType": "Long", "MarkdownDocumentation": "`AllocatedDpus`\n\nThe number of data processing units currently allocated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#AllocatedDpus-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time in UTC epoch millis when the capacity reservation was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#CreationTime-fn::getatt" }, "LastSuccessfulAllocationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastSuccessfulAllocationTime`\n\nThe time of the most recent capacity allocation that succeeded.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#LastSuccessfulAllocationTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the capacity reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#Arn-fn::getatt" } } }, "AWS::Athena::DataCatalog": { "MarkdownDocumentation": "`AWS::Athena::DataCatalog`\n\nThe AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which\ncontains a name, description, type, parameters, and tags. For more information, see\n[DataCatalog](https://docs.aws.amazon.com/athena/latest/APIReference/API_DataCatalog.html) in the *Amazon Athena API Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the data catalog.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the creation or deletion of the data catalog.\n* The `LAMBDA`, `GLUE`, and `HIVE` data catalog\n types are created synchronously. Their status is either\n `CREATE_COMPLETE` or `CREATE_FAILED`.\n* The `FEDERATED` data catalog type is created asynchronously.\nData catalog creation status:\n* `CREATE_IN_PROGRESS`: Federated data catalog creation in\n progress.\n* `CREATE_COMPLETE`: Data catalog creation complete.\n* `CREATE_FAILED`: Data catalog could not be created.\n* `CREATE_FAILED_CLEANUP_IN_PROGRESS`: Federated data catalog\n creation failed and is being removed.\n* `CREATE_FAILED_CLEANUP_COMPLETE`: Federated data catalog creation\n failed and was removed.\n* `CREATE_FAILED_CLEANUP_FAILED`: Federated data catalog creation\n failed but could not be removed.\nData catalog deletion status:\n* `DELETE_IN_PROGRESS`: Federated data catalog deletion in\n progress.\n* `DELETE_COMPLETE`: Federated data catalog deleted.\n* `DELETE_FAILED`: Federated data catalog could not be\n deleted.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATE_IN_PROGRESS | CREATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of data catalog: `LAMBDA` for a federated catalog,\n`GLUE` for AWS Glue Catalog, or `HIVE` for an external hive\nmetastore.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LAMBDA | GLUE | HIVE | FEDE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LAMBDA", "GLUE", "HIVE", "FEDERATED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the data catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nSpecifies the Lambda function or functions to use for creating the data\ncatalog. This is a mapping whose values depend on the catalog type.\n* For the `HIVE` data catalog type, use the following syntax. The\n `metadata-function` parameter is required. `The\n sdk-version` parameter is optional and defaults to the currently\n supported version.\n \n `metadata-function=lambda_arn,\n sdk-version=version_number`\n* For the `LAMBDA` data catalog type, use one of the following sets\n of required parameters, but not both.\n \n + If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.\n \n `metadata-function=lambda_arn,\n record-function=lambda_arn`\n + If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.\n \n `function=lambda_arn`\n* The `GLUE` type takes a catalog ID parameter and is required. The\n `catalog_id` is the account ID of the\n AWS account to which the AWS Glue Data Catalog\n belongs.\n \n `catalog-id=catalog_id`\n \n + The `GLUE` data catalog type also applies to the default\n `AwsDataCatalog` that already exists in your account, of\n which you can have only one and cannot modify.\n* The `FEDERATED` data catalog type uses one of the following\n parameters, but not both. Use `connection-arn` for an existing\n AWS Glue connection. Use `connection-type` and\n `connection-properties` to specify the configuration setting for\n a new connection.\n \n + `connection-arn:`\n + `lambda-role-arn` (optional): The execution role to use for the\n Lambda function. If not provided, one is created.\n + `connection-type:MYSQL|REDSHIFT|....,\n connection-properties:\"\"`\n \n For *``*, use escaped\n JSON text, as in the following example.\n \n `\"{\\\"spill_bucket\\\":\\\"my_spill\\\",\\\"spill_prefix\\\":\\\"athena-spill\\\",\\\"host\\\":\\\"abc12345.snowflakecomputing.com\\\",\\\"port\\\":\\\"1234\\\",\\\"warehouse\\\":\\\"DEV_WH\\\",\\\"database\\\":\\\"TEST\\\",\\\"schema\\\":\\\"PUBLIC\\\",\\\"SecretArn\\\":\\\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\\\"}\"`\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.*`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ConnectionType": { "MarkdownDocumentation": "`ConnectionType`\n\nThe type of connection for a `FEDERATED` data catalog (for example,\n`REDSHIFT`, `MYSQL`, or `SQLSERVER`). For\ninformation about individual connectors, see [Available data source\nconnectors](https://docs.aws.amazon.com/athena/latest/ug/connectors-available.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `DYNAMODB | MYSQL | POSTGRES...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DYNAMODB", "MYSQL", "POSTGRESQL", "REDSHIFT", "ORACLE", "SYNAPSE", "SQLSERVER", "DB2", "OPENSEARCH", "BIGQUERY", "GOOGLECLOUDSTORAGE", "HBASE", "DOCUMENTDB", "CMDB", "TPCDS", "TIMESTREAM", "SAPHANA", "SNOWFLAKE", "DATALAKEGEN2", "DB2AS400" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-connectiontype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Error": { "MarkdownDocumentation": "`Error`\n\nText of the error that occurred during data catalog creation or deletion.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-error", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags (key-value pairs) to associate with this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-athena-datacatalog-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign,\nor hyphen characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-datacatalog.html#cfn-athena-datacatalog-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Athena::NamedQuery": { "MarkdownDocumentation": "`AWS::Athena::NamedQuery`\n\nThe `AWS::Athena::NamedQuery` resource specifies an Amazon Athena saved query, where `QueryString` contains the SQL query statements that\nmake up the query.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html", "Properties": { "WorkGroup": { "MarkdownDocumentation": "`WorkGroup`\n\nThe name of the workgroup that contains the named query.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-workgroup", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe query description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nThe SQL statements that make up the query.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `262144`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-querystring", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Database": { "MarkdownDocumentation": "`Database`\n\nThe database to which the query belongs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-database", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe query name.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "NamedQueryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`NamedQueryId`\n\nThe unique ID of the query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#NamedQueryId-fn::getatt" } } }, "AWS::Athena::PreparedStatement": { "MarkdownDocumentation": "`AWS::Athena::PreparedStatement`\n\nSpecifies a prepared statement for use with SQL queries in Athena.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the prepared statement.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-preparedstatement.html", "Properties": { "StatementName": { "MarkdownDocumentation": "`StatementName`\n\nThe name of the prepared statement.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-preparedstatement.html#cfn-athena-preparedstatement-statementname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "WorkGroup": { "MarkdownDocumentation": "`WorkGroup`\n\nThe workgroup to which the prepared statement belongs.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-preparedstatement.html#cfn-athena-preparedstatement-workgroup", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the prepared statement.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-preparedstatement.html#cfn-athena-preparedstatement-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "QueryStatement": { "MarkdownDocumentation": "`QueryStatement`\n\nThe query string for the prepared statement.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `262144`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-preparedstatement.html#cfn-athena-preparedstatement-querystatement", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Athena::WorkGroup": { "MarkdownDocumentation": "`AWS::Athena::WorkGroup`\n\nThe AWS::Athena::WorkGroup resource specifies an Amazon Athena workgroup,\nwhich contains a name, description, creation time, state, and other configuration,\nlisted under [WorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-workgroupconfiguration). Each workgroup enables you to\nisolate queries for you or your group from other queries in the same account. For more\ninformation, see [CreateWorkGroup](https://docs.aws.amazon.com/athena/latest/APIReference/API_CreateWorkGroup.html) in\nthe *Amazon Athena API Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the WorkGroup. For example:\n`{ \"Ref\": \"myWorkGroup\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html", "Properties": { "RecursiveDeleteOption": { "MarkdownDocumentation": "`RecursiveDeleteOption`\n\nThe option to delete a workgroup and its contents even if the workgroup contains any\nnamed queries. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-recursivedeleteoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "WorkGroupConfiguration": { "MarkdownDocumentation": "`WorkGroupConfiguration`\n\nThe configuration of the workgroup, which includes the location in Amazon S3 where\nquery results are stored, the encryption option, if any, used for query results, whether\nAmazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of\nbytes scanned (cutoff) per query, if it is specified. The [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration) option determines whether workgroup\nsettings override client-side query settings.\n*Required*: No\n*Type*: [WorkGroupConfiguration](./aws-properties-athena-workgroup-workgroupconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-workgroupconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WorkGroupConfiguration" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe workgroup description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the workgroup: ENABLED or DISABLED.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags (key-value pairs) to associate with this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-athena-workgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe workgroup name.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe date and time the workgroup was created, as a UNIX timestamp in seconds. For\nexample: `1582761016`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#CreationTime-fn::getatt" }, "WorkGroupConfiguration.EngineVersion.EffectiveEngineVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`WorkGroupConfiguration.EngineVersion.EffectiveEngineVersion`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#WorkGroupConfiguration.EngineVersion.EffectiveEngineVersion-fn::getatt" } } }, "AWS::AuditManager::Assessment": { "MarkdownDocumentation": "`AWS::AuditManager::Assessment`\n\nThe `AWS::AuditManager::Assessment` resource is an Audit Manager\nresource type that defines the scope of audit evidence collected by Audit Manager. An\nAudit Manager assessment is an implementation of an Audit Manager framework.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the assessment ID. For example:\n`{ \"Ref\": \"111A1A1A-22B2-33C3-DDD4-55E5E5E555E5\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe overall status of the assessment.\nWhen you create a new assessment, the initial `Status` value is always\n`ACTIVE`. When you create an assessment, even if you specify the value as\n`INACTIVE`, the value overrides to `ACTIVE`.\nAfter you create an assessment, you can change the value of the `Status`\nproperty at any time. For example, when you want to stop collecting evidence for your\nassessment, you can change the assessment status to `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)", "RefReturnValue": "", "AllowedValues": [ "ACTIVE", "INACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssessmentReportsDestination": { "MarkdownDocumentation": "`AssessmentReportsDestination`\n\nThe destination that evidence reports are stored in for the assessment.\n*Required*: No\n*Type*: [AssessmentReportsDestination](./aws-properties-auditmanager-assessment-assessmentreportsdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-assessmentreportsdestination", "UpdateType": "Mutable", "Required": false, "Type": "AssessmentReportsDestination" }, "Delegations": { "MarkdownDocumentation": "`Delegations`\n\nThe delegations that are associated with the assessment.\n*Required*: No\n*Type*: Array of [Delegation](./aws-properties-auditmanager-assessment-delegation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-delegations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Delegation", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the assessment.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\W\\s\\S]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe wrapper of AWS accounts and services that are in scope for the\nassessment.\n*Required*: No\n*Type*: [Scope](./aws-properties-auditmanager-assessment-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-scope", "UpdateType": "Mutable", "Required": false, "Type": "Scope" }, "AwsAccount": { "MarkdownDocumentation": "`AwsAccount`\n\nThe AWS account that's associated with the assessment.\n*Required*: No\n*Type*: [AWSAccount](./aws-properties-auditmanager-assessment-awsaccount.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-awsaccount", "UpdateType": "Immutable", "Required": false, "Type": "AWSAccount" }, "Roles": { "MarkdownDocumentation": "`Roles`\n\nThe roles that are associated with the assessment.\n*Required*: No\n*Type*: Array of [Role](./aws-properties-auditmanager-assessment-role.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-roles", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Role", "DuplicatesAllowed": true }, "FrameworkId": { "MarkdownDocumentation": "`FrameworkId`\n\nThe unique identifier for the framework.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|.*\\S.*)$`\n*Minimum*: `32`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-frameworkid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that are associated with the assessment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-auditmanager-assessment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the assessment.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_\\.]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "AssessmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssessmentId`\n\nThe unique identifier for the assessment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#AssessmentId-fn::getatt" }, "CreationTime": { "PrimitiveType": "Double", "MarkdownDocumentation": "`CreationTime`\n\nSpecifies when the assessment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#CreationTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the assessment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#Arn-fn::getatt" } } }, "AWS::AutoScaling::AutoScalingGroup": { "MarkdownDocumentation": "`AWS::AutoScaling::AutoScalingGroup`\n\nThe `AWS::AutoScaling::AutoScalingGroup` resource defines an Amazon EC2 Auto\nScaling group, which is a collection of Amazon EC2 instances that are treated as a logical\ngrouping for the purposes of automatic scaling and management.\nFor more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling\nUser Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html).\n###### Note\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group\nusing either a [launch\ntemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use\nlaunch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html)\nin the *Amazon EC2 Auto Scaling User Guide*.\nFor help migrating from launch configurations to launch templates, see [Migrate AWS CloudFormation stacks from launch configurations to launch\ntemplates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`mystack-myasgroup-NT5EUXTNTXXD`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html", "Properties": { "LifecycleHookSpecificationList": { "MarkdownDocumentation": "`LifecycleHookSpecificationList`\n\nOne or more lifecycle hooks to add to the Auto Scaling group before instances are\nlaunched.\n*Required*: No\n*Type*: Array of [LifecycleHookSpecification](./aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecificationlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LifecycleHookSpecification", "DuplicatesAllowed": true }, "LoadBalancerNames": { "MarkdownDocumentation": "`LoadBalancerNames`\n\nA list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers,\nspecify the `TargetGroupARNs` property instead.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-loadbalancernames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LaunchConfigurationName": { "MarkdownDocumentation": "`LaunchConfigurationName`\n\nThe name of the launch configuration to use to launch instances.\nRequired only if you don't specify `LaunchTemplate`,\n`MixedInstancesPolicy`, or `InstanceId`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-launchconfigurationname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "ServiceLinkedRoleARN": { "MarkdownDocumentation": "`ServiceLinkedRoleARN`\n\nThe Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\ncall other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\nnamed `AWSServiceRoleForAutoScaling`, which it creates if it does not exist.\nFor more information, see [Service-linked\nroles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-servicelinkedrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneImpairmentPolicy": { "MarkdownDocumentation": "`AvailabilityZoneImpairmentPolicy`\n\nThe Availability Zone impairment policy for the Auto Scaling group.\n*Required*: No\n*Type*: [AvailabilityZoneImpairmentPolicy](./aws-properties-autoscaling-autoscalinggroup-availabilityzoneimpairmentpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-availabilityzoneimpairmentpolicy", "UpdateType": "Mutable", "Required": false, "Type": "AvailabilityZoneImpairmentPolicy" }, "TargetGroupARNs": { "MarkdownDocumentation": "`TargetGroupARNs`\n\nThe Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling\ngroup. Instances are registered as targets with the target groups. The target groups\nreceive incoming traffic and route requests to one or more registered targets. For more\ninformation, see [Use Elastic Load Balancing to\ndistribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-targetgrouparns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Cooldown": { "MarkdownDocumentation": "`Cooldown`\n\n*Only needed if you use simple scaling policies.*\nThe amount of time, in seconds, between one scaling activity ending and another one\nstarting due to simple scaling policies. For more information, see [Scaling\ncooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*.\nDefault: `300` seconds\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-cooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NotificationConfigurations": { "MarkdownDocumentation": "`NotificationConfigurations`\n\nConfigures an Auto Scaling group to send notifications when specified events take\nplace.\n*Required*: No\n*Type*: Array of [NotificationConfiguration](./aws-properties-autoscaling-autoscalinggroup-notificationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-notificationconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NotificationConfiguration", "DuplicatesAllowed": true }, "DesiredCapacity": { "MarkdownDocumentation": "`DesiredCapacity`\n\nThe desired capacity is the initial capacity of the Auto Scaling group at the time of its\ncreation and the capacity it attempts to maintain. It can scale beyond this capacity if you\nconfigure automatic scaling.\nThe number must be greater than or equal to the minimum size of the group and less than or\nequal to the maximum size of the group. If you do not specify a desired capacity when creating\nthe stack, the default is the minimum size of the group.\nCloudFormation marks the Auto Scaling group as successful (by setting its status to\nCREATE\\_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set\nin the launch template or launch configuration that you specified, then desired capacity is\nnot used as a criteria for success. Whether your request is fulfilled depends on Spot Instance\ncapacity and your maximum price.\n*Required*: No\n*Type*: String\n*Pattern*: `^[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-desiredcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HealthCheckGracePeriod": { "MarkdownDocumentation": "`HealthCheckGracePeriod`\n\nThe amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\nof an EC2 instance that has come into service and marking it unhealthy due to a failed\nhealth check. This is useful if your instances do not immediately pass their health\nchecks after they enter the `InService` state. For more information, see\n[Set the health check\ngrace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\nDefault: `0` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-healthcheckgraceperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "InstanceLifecyclePolicy": { "MarkdownDocumentation": "`InstanceLifecyclePolicy`\n\nThe instance lifecycle policy for the Auto Scaling group.\n*Required*: No\n*Type*: [InstanceLifecyclePolicy](./aws-properties-autoscaling-autoscalinggroup-instancelifecyclepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-instancelifecyclepolicy", "UpdateType": "Mutable", "Required": false, "Type": "InstanceLifecyclePolicy" }, "DefaultInstanceWarmup": { "MarkdownDocumentation": "`DefaultInstanceWarmup`\n\nThe amount of time, in seconds, until a new instance is considered to have finished\ninitializing and resource consumption to become stable after it enters the\n`InService` state.\nDuring an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an\ninstance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the\nwarm-up period before aggregating the metrics for new instances with existing instances\nin the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage\ndata. For more information, see [Set\nthe default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\n###### Important\nTo manage various warm-up settings at the group level, we recommend that you set\nthe default instance warmup, *even if it is set to 0 seconds*. To\nremove a value that you previously set, include the property but specify\n`-1` for the value. However, we strongly recommend keeping the\ndefault instance warmup enabled by specifying a value of `0` or other\nnominal value.\nDefault: None\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-defaultinstancewarmup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SkipZonalShiftValidation": { "MarkdownDocumentation": "`SkipZonalShiftValidation`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-skipzonalshiftvalidation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NewInstancesProtectedFromScaleIn": { "MarkdownDocumentation": "`NewInstancesProtectedFromScaleIn`\n\nIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\nwhen scaling in. For more information about preventing instances from terminating on\nscale in, see [Use\ninstance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the\n*Amazon EC2 Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-newinstancesprotectedfromscalein", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LaunchTemplate": { "MarkdownDocumentation": "`LaunchTemplate`\n\nInformation used to specify the launch template and version to use to launch instances.\nYou can alternatively associate a launch template to the Auto Scaling group by specifying a\n`MixedInstancesPolicy`. For more information about creating launch templates, see\n[Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto\nScaling User Guide*.\nIf you omit this property, you must specify `MixedInstancesPolicy`,\n`LaunchConfigurationName`, or `InstanceId`.\n*Required*: No\n*Type*: [LaunchTemplateSpecification](./aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-launchtemplate", "UpdateType": "Conditional", "Required": false, "Type": "LaunchTemplateSpecification" }, "MixedInstancesPolicy": { "MarkdownDocumentation": "`MixedInstancesPolicy`\n\nAn embedded object that specifies a mixed instances policy.\nThe policy includes properties that not only define the distribution of On-Demand\nInstances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how\nthe Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but\nalso the properties that specify the instance configuration information\u2014the launch template\nand instance types. The policy can also include a weight for each instance type and different\nlaunch templates for individual instance types.\nFor more information, see [Auto Scaling\ngroups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2\nAuto Scaling User Guide*.\n*Required*: No\n*Type*: [MixedInstancesPolicy](./aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-mixedinstancespolicy", "UpdateType": "Conditional", "Required": false, "Type": "MixedInstancesPolicy" }, "VPCZoneIdentifier": { "MarkdownDocumentation": "`VPCZoneIdentifier`\n\nA list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling\ngroup can be created.\nIf this resource specifies public subnets and is also in a VPC that is defined in the same\nstack template, you must use the [DependsOn\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).\n###### Note\nWhen you update `VPCZoneIdentifier`, this retains the same Auto Scaling group\nand replaces old instances with new ones, according to the specified subnets. You can\noptionally specify how CloudFormation handles these updates by using an [UpdatePolicy\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).\nRequired to launch instances into a nondefault VPC. If you specify\n`VPCZoneIdentifier` with `AvailabilityZones`, the subnets that you\nspecify for this property must reside in those Availability Zones.\n*Required*: Conditional\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-vpczoneidentifier", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOne or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\ninstances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS\nvolumes, specify the tags in a launch template but use caution. If the launch template\nspecifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling\noverrides the value of that instance tag with the value specified by the Auto Scaling group. For\nmore information, see [Tag Auto Scaling groups and\ninstances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.\n*Required*: No\n*Type*: Array of [TagProperty](./aws-properties-autoscaling-autoscalinggroup-tagproperty.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagProperty", "DuplicatesAllowed": true }, "Context": { "MarkdownDocumentation": "`Context`\n\nReserved.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-context", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityRebalance": { "MarkdownDocumentation": "`CapacityRebalance`\n\nIndicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\ndisabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\nInstance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\ninterruption. After launching a new instance, it then terminates an old instance. For\nmore information, see [Use Capacity\nRebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-capacityrebalance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\nThe ID of the instance used to base the launch configuration on. For more information, see\n[Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto\nScaling User Guide*.\nIf you specify `LaunchTemplate`, `MixedInstancesPolicy`, or\n`LaunchConfigurationName`, don't specify `InstanceId`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-instanceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZones": { "MarkdownDocumentation": "`AvailabilityZones`\n\nA list of Availability Zones where instances in the Auto Scaling group can be created. Used\nfor launching into the default VPC subnet in each Availability Zone when not using the\n`VPCZoneIdentifier` property, or for attaching a network interface when\nan existing network interface ID is specified in a launch template.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-availabilityzones", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AvailabilityZoneDistribution": { "MarkdownDocumentation": "`AvailabilityZoneDistribution`\n\nThe EC2 instance capacity distribution across Availability Zones for the Auto Scaling group.\n*Required*: No\n*Type*: [AvailabilityZoneDistribution](./aws-properties-autoscaling-autoscalinggroup-availabilityzonedistribution.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-availabilityzonedistribution", "UpdateType": "Mutable", "Required": false, "Type": "AvailabilityZoneDistribution" }, "MetricsCollection": { "MarkdownDocumentation": "`MetricsCollection`\n\nEnables the monitoring of group metrics of an Auto Scaling group. By default, these\nmetrics are disabled.\n*Required*: No\n*Type*: [Array](./aws-properties-autoscaling-autoscalinggroup-metricscollection.html) of [MetricsCollection](./aws-properties-autoscaling-autoscalinggroup-metricscollection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-metricscollection", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricsCollection", "DuplicatesAllowed": true }, "InstanceMaintenancePolicy": { "MarkdownDocumentation": "`InstanceMaintenancePolicy`\n\nAn instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\n*Required*: No\n*Type*: [InstanceMaintenancePolicy](./aws-properties-autoscaling-autoscalinggroup-instancemaintenancepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-instancemaintenancepolicy", "UpdateType": "Mutable", "Required": false, "Type": "InstanceMaintenancePolicy" }, "MaxSize": { "MarkdownDocumentation": "`MaxSize`\n\nThe maximum size of the group.\n###### Note\nWith a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\ngo above `MaxSize` to meet your capacity requirements. In this event,\nAmazon EC2 Auto Scaling will never go above `MaxSize` by more than your largest instance\nweight (weights that define how many units each instance contributes to the desired\ncapacity of the group).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-maxsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MinSize": { "MarkdownDocumentation": "`MinSize`\n\nThe minimum size of the group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-minsize", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TerminationPolicies": { "MarkdownDocumentation": "`TerminationPolicies`\n\nA policy or a list of policies that are used to select the instance to terminate.\nThese policies are executed in the order that you list them. For more information, see\n[Configure\ntermination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\nValid values: `Default` | `AllocationStrategy` |\n`ClosestToNextInstanceHour` | `NewestInstance` |\n`OldestInstance` | `OldestLaunchConfiguration` |\n`OldestLaunchTemplate` |\n`arn:aws:lambda:region:account-id:function:my-function:my-alias`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-terminationpolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AutoScalingGroupName": { "MarkdownDocumentation": "`AutoScalingGroupName`\n\nThe name of the Auto Scaling group. This name must be unique per Region per account.\nThe name can contain any ASCII character 33 to 126 including most punctuation\ncharacters, digits, and upper and lowercased letters.\n###### Note\nYou cannot use a colon (:) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-autoscalinggroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TrafficSources": { "MarkdownDocumentation": "`TrafficSources`\n\nThe traffic sources associated with this Auto Scaling group.\n*Required*: No\n*Type*: Array of [TrafficSourceIdentifier](./aws-properties-autoscaling-autoscalinggroup-trafficsourceidentifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-trafficsources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TrafficSourceIdentifier", "DuplicatesAllowed": false }, "DesiredCapacityType": { "MarkdownDocumentation": "`DesiredCapacityType`\n\nThe unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\nsupports `DesiredCapacityType` for attribute-based instance type selection\nonly. For more information, see [Create a mixed instances group using attribute-based instance type\nselection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*.\nBy default, Amazon EC2 Auto Scaling specifies `units`, which translates into number of\ninstances.\nValid values: `units` | `vcpu` | `memory-mib`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-desiredcapacitytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlacementGroup": { "MarkdownDocumentation": "`PlacementGroup`\n\nThe name of the placement group into which to launch your instances. For more\ninformation, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the\n*Amazon EC2 User Guide*.\n###### Note\nA *cluster* placement group is a logical grouping of instances\nwithin a single Availability Zone. You cannot specify multiple Availability Zones\nand a cluster placement 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-placementgroup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityReservationSpecification": { "MarkdownDocumentation": "`CapacityReservationSpecification`\n\nThe capacity reservation specification for the Auto Scaling group.\n*Required*: No\n*Type*: [CapacityReservationSpecification](./aws-properties-autoscaling-autoscalinggroup-capacityreservationspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-capacityreservationspecification", "UpdateType": "Mutable", "Required": false, "Type": "CapacityReservationSpecification" }, "HealthCheckType": { "MarkdownDocumentation": "`HealthCheckType`\n\nA comma-separated value string of one or more health check types.\nThe valid values are `EC2`, `EBS`, `ELB`, and\n`VPC_LATTICE`. `EC2` is the default health check and cannot be\ndisabled. For more information, see [Health checks\nfor instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\nOnly specify `EC2` if you must clear a value that was previously\nset.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-healthchecktype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxInstanceLifetime": { "MarkdownDocumentation": "`MaxInstanceLifetime`\n\nThe maximum amount of time, in seconds, that an instance can be in service. The\ndefault is null. If specified, the value must be either 0 or a number equal to or\ngreater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the\n*Amazon EC2 Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#cfn-autoscaling-autoscalinggroup-maxinstancelifetime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "AutoScalingGroupARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutoScalingGroupARN`\n\nThe Amazon Resource Name (ARN) of the Auto Scaling group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#AutoScalingGroupARN-fn::getatt" } } }, "AWS::AutoScaling::LaunchConfiguration": { "MarkdownDocumentation": "`AWS::AutoScaling::LaunchConfiguration`\n\nThe `AWS::AutoScaling::LaunchConfiguration` resource specifies the launch\nconfiguration that can be used by an Auto Scaling group to configure Amazon EC2 instances.\nWhen you update the launch configuration for an Auto Scaling group, CloudFormation deletes\nthat resource and creates a new launch configuration with the updated properties and a new\nname. Existing instances are not affected. To update existing instances when you update the\n`AWS::AutoScaling::LaunchConfiguration` resource, you can specify an [UpdatePolicy\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) for the group. You can find sample update policies for rolling updates in\n[Configure Amazon EC2\nAuto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n###### Note\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group\nusing either a [launch\ntemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use\nlaunch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html)\nin the *Amazon EC2 Auto Scaling User Guide*.\nFor help migrating from launch configurations to launch templates, see [Migrate AWS CloudFormation stacks from launch configurations to launch\ntemplates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`mystack-mylaunchconfig-1DDYF1E3B3I`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html", "Properties": { "PlacementTenancy": { "MarkdownDocumentation": "`PlacementTenancy`\n\nThe tenancy of the instance, either `default` or `dedicated`. An\ninstance with `dedicated` tenancy runs on isolated, single-tenant hardware\nand can only be launched into a VPC. To launch dedicated instances into a shared tenancy\nVPC (a VPC with the instance placement tenancy attribute set to `default`),\nyou must set the value of this property to `dedicated`.\nIf you specify `PlacementTenancy`, you must specify at least one subnet for\n`VPCZoneIdentifier` when you create your group.\nValid values: `default` | `dedicated`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-placementtenancy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nA list that contains the security groups to assign to the instances in the Auto Scaling\ngroup. The list can contain both the IDs of existing security groups and references to [SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\nFor more information, see [Control traffic to resources using\nsecurity groups](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-securitygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LaunchConfigurationName": { "MarkdownDocumentation": "`LaunchConfigurationName`\n\nThe name of the launch configuration. This name must be unique per Region per\naccount.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-launchconfigurationname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MetadataOptions": { "MarkdownDocumentation": "`MetadataOptions`\n\nThe metadata options for the instances. For more information, see [Configure the instance metadata options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) in the\n*Amazon EC2 Auto Scaling User Guide*.\n*Required*: No\n*Type*: [MetadataOptions](./aws-properties-autoscaling-launchconfiguration-metadataoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-metadataoptions", "UpdateType": "Immutable", "Required": false, "Type": "MetadataOptions" }, "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\nThe ID of the Amazon EC2 instance to use to create the launch configuration. When you use\nan instance to create a launch configuration, all properties are derived from the instance\nwith the exception of `BlockDeviceMapping` and\n`AssociatePublicIpAddress`. You can override any properties from the instance by\nspecifying them in the launch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-instanceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UserData": { "MarkdownDocumentation": "`UserData`\n\nThe Base64-encoded user data to make available to the launched EC2 instances. For more\ninformation, see [Instance metadata and user\ndata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide for Linux Instances*.\n*Required*: No\n*Type*: String\n*Maximum*: `21847`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-userdata", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClassicLinkVPCSecurityGroups": { "MarkdownDocumentation": "`ClassicLinkVPCSecurityGroups`\n\nAvailable for backward compatibility.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-classiclinkvpcsecuritygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BlockDeviceMappings": { "MarkdownDocumentation": "`BlockDeviceMappings`\n\nThe block device mapping entries that define the block devices to attach to the\ninstances at launch. By default, the block devices specified in the block device mapping\nfor the AMI are used. For more information, see [Block device\nmappings](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: Array of [BlockDeviceMapping](./aws-properties-autoscaling-launchconfiguration-blockdevicemapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-blockdevicemappings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "BlockDeviceMapping", "DuplicatesAllowed": false }, "IamInstanceProfile": { "MarkdownDocumentation": "`IamInstanceProfile`\n\nThe name or the Amazon Resource Name (ARN) of the instance profile associated with the\nIAM role for the instance. The instance profile contains the IAM role. For more\ninformation, see [IAM role for applications that run\non Amazon EC2 instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the *Amazon EC2 Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-iaminstanceprofile", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KernelId": { "MarkdownDocumentation": "`KernelId`\n\nThe ID of the kernel associated with the AMI.\n###### Note\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\ninformation, see [User provided\nkernels](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*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-kernelid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AssociatePublicIpAddress": { "MarkdownDocumentation": "`AssociatePublicIpAddress`\n\nSpecifies whether to assign a public IPv4 address to the group's instances. If the\ninstance is launched into a default subnet, the default is to assign a public IPv4\naddress, unless you disabled the option to assign a public IPv4 address on the subnet.\nIf the instance is launched into a nondefault subnet, the default is not to assign a\npublic IPv4 address, unless you enabled the option to assign a public IPv4 address on\nthe subnet.\nIf you specify `true`, each instance in the Auto Scaling group receives a unique\npublic IPv4 address. For more information, see [Provide network connectivity for\nyour Auto Scaling instances using Amazon VPC](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\nIf you specify this property, you must specify at least one subnet for\n`VPCZoneIdentifier` when you create your group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-associatepublicipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ClassicLinkVPCId": { "MarkdownDocumentation": "`ClassicLinkVPCId`\n\nAvailable for backward compatibility.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-classiclinkvpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EbsOptimized": { "MarkdownDocumentation": "`EbsOptimized`\n\nSpecifies whether the launch configuration is optimized for EBS I/O\n(`true`) or not (`false`). The optimization provides dedicated\nthroughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\nperformance. This optimization is not available with all instance types. Additional fees\nare incurred when you enable EBS optimization for an instance type that is not\nEBS-optimized by default. For more information, see [Amazon EBS-optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html)\nin the *Amazon EC2 User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-ebsoptimized", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyName": { "MarkdownDocumentation": "`KeyName`\n\nThe name of the key pair. For more information, see [Amazon EC2 key pairs and Amazon EC2\ninstances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-keyname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SpotPrice": { "MarkdownDocumentation": "`SpotPrice`\n\nThe maximum hourly price to be paid for any Spot Instance launched to fulfill the\nrequest. Spot Instances are launched when the price you specify exceeds the current Spot\nprice. For more information, see [Request Spot\nInstances for fault-tolerant and flexible applications](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\nValid Range: Minimum value of 0.001\n###### Note\nWhen you change your maximum price by creating a new launch configuration, running\ninstances will continue to run as long as the maximum price for those running\ninstances is higher than the current Spot price.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-spotprice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nThe ID of the Amazon Machine Image (AMI) that was assigned during registration. For\nmore information, see [Find a Linux AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) in the\n*Amazon EC2 User Guide*.\nIf you specify `InstanceId`, an `ImageId` is not\nrequired.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-imageid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nSpecifies the instance type of the EC2 instance. For information about available\ninstance types, see [Available\ninstance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the *Amazon EC2 User Guide*.\nIf you specify `InstanceId`, an `InstanceType` is not\nrequired.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-instancetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RamDiskId": { "MarkdownDocumentation": "`RamDiskId`\n\nThe ID of the RAM disk to select.\n###### Note\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\ninformation, see [User provided\nkernels](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*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-ramdiskid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceMonitoring": { "MarkdownDocumentation": "`InstanceMonitoring`\n\nControls whether instances in this group are launched with detailed\n(`true`) or basic (`false`) monitoring.\nThe default value is `true` (enabled).\n###### Important\nWhen detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\nyour account is charged a fee. When you disable detailed monitoring, CloudWatch generates\nmetrics every 5 minutes. For more information, see [Configure\nmonitoring for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html) in the\n*Amazon EC2 Auto Scaling 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-launchconfiguration.html#cfn-autoscaling-launchconfiguration-instancemonitoring", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::AutoScaling::LifecycleHook": { "MarkdownDocumentation": "`AWS::AutoScaling::LifecycleHook`\n\nThe `AWS::AutoScaling::LifecycleHook` resource specifies lifecycle hooks for an\nAuto Scaling group. These hooks let you create solutions that are aware of events in the Auto\nScaling instance lifecycle, and then perform a custom action on instances when the\ncorresponding lifecycle event occurs. A lifecycle hook provides a specified amount of time\n(one hour by default) to wait for the action to complete before the instance transitions to\nthe next state.\nUse lifecycle hooks to prepare new instances for use or to delay them from being\nregistered behind a load balancer before their configuration has been applied completely. You\ncan also use lifecycle hooks to prepare running instances to be terminated by, for example,\ndownloading logs or other data.\nFor more information, see [Amazon EC2 Auto Scaling lifecycle\nhooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`mylifecyclehook`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html", "Properties": { "LifecycleHookName": { "MarkdownDocumentation": "`LifecycleHookName`\n\nThe name of the lifecycle hook.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecyclehookname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LifecycleTransition": { "MarkdownDocumentation": "`LifecycleTransition`\n\nThe lifecycle transition. For Auto Scaling groups, there are two major lifecycle\ntransitions.\n* To create a lifecycle hook for scale-out events, specify\n `autoscaling:EC2_INSTANCE_LAUNCHING`.\n* To create a lifecycle hook for scale-in events, specify\n `autoscaling:EC2_INSTANCE_TERMINATING`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecycletransition", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AutoScalingGroupName": { "MarkdownDocumentation": "`AutoScalingGroupName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-autoscalinggroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HeartbeatTimeout": { "MarkdownDocumentation": "`HeartbeatTimeout`\n\nThe maximum time, in seconds, that can elapse before the lifecycle hook times out. The\nrange is from `30` to `7200` seconds. The default value is\n`3600` seconds (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-heartbeattimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NotificationMetadata": { "MarkdownDocumentation": "`NotificationMetadata`\n\nAdditional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\nthe notification target.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1023`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-notificationmetadata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultResult": { "MarkdownDocumentation": "`DefaultResult`\n\nThe action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\nunexpected failure occurs. The default value is `ABANDON`.\nValid values: `CONTINUE` | `ABANDON`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-defaultresult", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NotificationTargetARN": { "MarkdownDocumentation": "`NotificationTargetARN`\n\nThe Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends\nnotifications to when an instance is in a wait state for the lifecycle hook. You can\nspecify an Amazon SNS topic or an Amazon SQS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-notificationtargetarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nThe ARN of the IAM role that allows the Auto Scaling group to publish to the specified\nnotification target. For information about creating this role, see [Prepare to\nadd a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the\n*Amazon EC2 Auto Scaling User Guide*.\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::AutoScaling::ScalingPolicy": { "MarkdownDocumentation": "`AWS::AutoScaling::ScalingPolicy`\n\nThe `AWS::AutoScaling::ScalingPolicy` resource specifies an Amazon EC2 Auto\nScaling scaling policy so that the Auto Scaling group can scale the number of instances\navailable for your application.\nFor more information about using scaling policies to scale your Auto Scaling group\nautomatically, see [Dynamic scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) and\n[Predictive\nscaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the policy Amazon Resource Name (ARN). For example:\n`arn:aws:autoscaling:us-east-2:123456789012:scalingPolicy:ab12c4d5-a1b2-a1b2-a1b2-ab12c4d56789:autoScalingGroupName/myStack-AutoScalingGroup-AB12C4D5E6:policyName/myStack-myScalingPolicy-AB12C4D5E6`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html", "Properties": { "MetricAggregationType": { "MarkdownDocumentation": "`MetricAggregationType`\n\nThe aggregation type for the CloudWatch metrics. The valid values are `Minimum`,\n`Maximum`, and `Average`. If the aggregation type is null, the\nvalue is treated as `Average`.\nValid only if the policy type is `StepScaling`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-metricaggregationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyType": { "MarkdownDocumentation": "`PolicyType`\n\nOne of the following policy types:\n* `TargetTrackingScaling`\n* `StepScaling`\n* `SimpleScaling` (default)\n* `PredictiveScaling`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-policytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PredictiveScalingConfiguration": { "MarkdownDocumentation": "`PredictiveScalingConfiguration`\n\nA predictive scaling policy. Provides support for predefined and custom\nmetrics.\nPredefined metrics include CPU utilization, network in/out, and the Application Load\nBalancer request count.\nRequired if the policy type is `PredictiveScaling`.\n*Required*: Conditional\n*Type*: [PredictiveScalingConfiguration](./aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-predictivescalingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PredictiveScalingConfiguration" }, "ScalingAdjustment": { "MarkdownDocumentation": "`ScalingAdjustment`\n\nThe amount by which to scale, based on the specified adjustment type. A positive value\nadds to the current capacity while a negative number removes from the current capacity.\nFor exact capacity, you must specify a non-negative value.\nRequired if the policy type is `SimpleScaling`. (Not used with any other\npolicy type.)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-scalingadjustment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Cooldown": { "MarkdownDocumentation": "`Cooldown`\n\nA cooldown period, in seconds, that applies to a specific simple scaling policy. When\na cooldown period is specified here, it overrides the default cooldown.\nValid only if the policy type is `SimpleScaling`. For more information, see\n[Scaling\ncooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*.\nDefault: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-cooldown", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StepAdjustments": { "MarkdownDocumentation": "`StepAdjustments`\n\nA set of adjustments that enable you to scale based on the size of the alarm\nbreach.\nRequired if the policy type is `StepScaling`. (Not used with any other\npolicy type.)\n*Required*: Conditional\n*Type*: Array of [StepAdjustment](./aws-properties-autoscaling-scalingpolicy-stepadjustment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-stepadjustments", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StepAdjustment", "DuplicatesAllowed": false }, "AutoScalingGroupName": { "MarkdownDocumentation": "`AutoScalingGroupName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-autoscalinggroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MinAdjustmentMagnitude": { "MarkdownDocumentation": "`MinAdjustmentMagnitude`\n\nThe minimum value to scale by when the adjustment type is\n`PercentChangeInCapacity`. For example, suppose that you create a step\nscaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n`MinAdjustmentMagnitude` of 2. If the group has 4 instances and the\nscaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n`MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the group by 2\ninstances.\nValid only if the policy type is `StepScaling` or\n`SimpleScaling`. For more information, see [Scaling adjustment types](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the *Amazon EC2 Auto Scaling User\nGuide*.\n###### Note\nSome Auto Scaling groups use instance weights. In this case, set the\n`MinAdjustmentMagnitude` to a value that is at least as large as your\nlargest instance weight.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-minadjustmentmagnitude", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetTrackingConfiguration": { "MarkdownDocumentation": "`TargetTrackingConfiguration`\n\nA target tracking scaling policy. Provides support for predefined or custom\nmetrics.\nThe following predefined metrics are available:\n* `ASGAverageCPUUtilization`\n* `ASGAverageNetworkIn`\n* `ASGAverageNetworkOut`\n* `ALBRequestCountPerTarget`\nIf you specify `ALBRequestCountPerTarget` for the metric, you must specify\nthe `ResourceLabel` property with the\n`PredefinedMetricSpecification`.\nRequired if the policy type is `TargetTrackingScaling`.\n*Required*: Conditional\n*Type*: [TargetTrackingConfiguration](./aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TargetTrackingConfiguration" }, "EstimatedInstanceWarmup": { "MarkdownDocumentation": "`EstimatedInstanceWarmup`\n\n*Not needed if the default instance warmup is defined for the\ngroup.*\nThe estimated time, in seconds, until a newly launched instance can contribute to the\nCloudWatch metrics. This warm-up period applies to instances launched due to a specific target\ntracking or step scaling policy. When a warm-up period is specified here, it overrides\nthe default instance warmup.\nValid only if the policy type is `TargetTrackingScaling` or\n`StepScaling`.\n###### Note\nThe default is to use the value for the default instance warmup defined for the\ngroup. If default instance warmup is null, then `EstimatedInstanceWarmup`\nfalls back to the value of default cooldown.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-estimatedinstancewarmup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AdjustmentType": { "MarkdownDocumentation": "`AdjustmentType`\n\nSpecifies how the scaling adjustment is interpreted (for example, an absolute number\nor a percentage). The valid values are `ChangeInCapacity`,\n`ExactCapacity`, and `PercentChangeInCapacity`.\nRequired if the policy type is `StepScaling` or `SimpleScaling`.\nFor more information, see [Scaling adjustment types](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the *Amazon EC2 Auto Scaling User 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#cfn-autoscaling-scalingpolicy-adjustmenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "PolicyName": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyName`\n\nReturns the name of a scaling policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#PolicyName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of a scaling policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scalingpolicy.html#Arn-fn::getatt" } } }, "AWS::AutoScaling::ScheduledAction": { "MarkdownDocumentation": "`AWS::AutoScaling::ScheduledAction`\n\nThe `AWS::AutoScaling::ScheduledAction` resource specifies an Amazon EC2 Auto\nScaling scheduled action so that the Auto Scaling group can change the number of instances\navailable for your application in response to predictable load changes.\nWhen you update a stack with an Auto Scaling group and scheduled action, CloudFormation\nalways sets the min size, max size, and desired capacity properties of your group to the\nvalues that are defined in the `AWS::AutoScaling::AutoScalingGroup` section of your\ntemplate. However, you might not want CloudFormation to do that when you have a scheduled\naction in effect. You can use an [UpdatePolicy\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) to prevent CloudFormation from changing the min size, max size, or desired\ncapacity property values during a stack update unless you modified the individual values in\nyour template. If you have rolling updates enabled, before you can update the Auto Scaling\ngroup, you must suspend scheduled actions by specifying an [UpdatePolicy\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) for the Auto Scaling group. You can find a sample update policy for\nrolling updates in [Configure Amazon EC2\nAuto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\nFor more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html) and [Suspending and resuming scaling processes](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) in the *Amazon EC2 Auto Scaling\nUser Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`mystack-myscheduledaction-NT5EUXTNTXXD`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html", "Properties": { "MinSize": { "MarkdownDocumentation": "`MinSize`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-minsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Recurrence": { "MarkdownDocumentation": "`Recurrence`\n\nThe recurring schedule for this action. This format consists of five fields separated\nby white spaces: [Minute] [Hour] [Day\\_of\\_Month] [Month\\_of\\_Year] [Day\\_of\\_Week]. The value\nmust be in quotes (for example, `\"30 0 1 1,6,12 *\"`). For more information\nabout this format, see [Crontab](http://crontab.org).\nWhen `StartTime` and `EndTime` are specified with\n`Recurrence`, they form the boundaries of when the recurring action\nstarts 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-recurrence", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TimeZone": { "MarkdownDocumentation": "`TimeZone`\n\nSpecifies the time zone for a cron expression. If a time zone is not provided, UTC is\nused by default.\nValid values are the canonical names of the IANA time zones, derived from the IANA\nTime Zone Database (such as `Etc/GMT+9` or `Pacific/Tahiti`). For\nmore information, see .\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-timezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndTime": { "MarkdownDocumentation": "`EndTime`\n\nThe date and time for the recurring schedule to end, in UTC. For example,\n`\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-endtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoScalingGroupName": { "MarkdownDocumentation": "`AutoScalingGroupName`\n\nThe name of the Auto Scaling group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-autoscalinggroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\nonly and in quotes (for example, `\"2021-06-01T00:00:00Z\"`).\nIf you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs\nthe action at this time, and then performs the action based on the specified\nrecurrence.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-starttime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DesiredCapacity": { "MarkdownDocumentation": "`DesiredCapacity`\n\nThe desired capacity is the initial capacity of the Auto Scaling group after the scheduled\naction runs and the capacity it attempts to maintain. It can scale beyond this capacity\nif you add more scaling conditions.\n###### Note\nYou must specify at least one of the following properties: `MaxSize`,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-desiredcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxSize": { "MarkdownDocumentation": "`MaxSize`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-maxsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "ScheduledActionName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ScheduledActionName`\n\nReturns the name of a scheduled action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#ScheduledActionName-fn::getatt" } } }, "AWS::AutoScaling::WarmPool": { "MarkdownDocumentation": "`AWS::AutoScaling::WarmPool`\n\nThe `AWS::AutoScaling::WarmPool` resource creates a pool of pre-initialized EC2\ninstances that sits alongside the Auto Scaling group. Whenever your application needs to scale\nout, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.\nWhen you create a warm pool, you can define a minimum size. When your Auto Scaling group\nscales out and the size of the warm pool shrinks, Amazon EC2 Auto Scaling launches new\ninstances into the warm pool to maintain its minimum size.\nFor more information, see [Warm pools for Amazon EC2\nAuto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) in the *Amazon EC2 Auto Scaling User Guide*.\n###### Note\nCloudFormation supports the `UpdatePolicy` attribute for Auto Scaling groups.\nDuring an update, if `UpdatePolicy` is set to\n`AutoScalingRollingUpdate`, CloudFormation replaces `InService`\ninstances only. Instances in the warm pool are not replaced. The difference in which\ninstances are replaced can potentially result in different instance configurations after the\nstack update completes. If `UpdatePolicy` is set to\n`AutoScalingReplacingUpdate`, you do not encounter this issue because\nCloudFormation replaces both the Auto Scaling group and the warm\npool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html", "Properties": { "MinSize": { "MarkdownDocumentation": "`MinSize`\n\nSpecifies the minimum number of instances to maintain in the warm pool. This helps you\nto ensure that there is always a certain number of warmed instances available to handle\ntraffic 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-minsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxGroupPreparedCapacity": { "MarkdownDocumentation": "`MaxGroupPreparedCapacity`\n\nSpecifies the maximum number of instances that are allowed to be in the warm pool or\nin any state except `Terminated` for the Auto Scaling group. This is an optional\nproperty. Specify it only if you do not want the warm pool size to be determined by the\ndifference between the group's maximum capacity and its desired capacity.\n###### Important\nIf a value for `MaxGroupPreparedCapacity` is not specified, Amazon EC2 Auto Scaling\nlaunches and maintains the difference between the group's maximum capacity and its\ndesired capacity. If you specify a value for `MaxGroupPreparedCapacity`,\nAmazon EC2 Auto Scaling uses the difference between the `MaxGroupPreparedCapacity` and\nthe desired capacity instead.\nThe size of the warm pool is dynamic. Only when\n`MaxGroupPreparedCapacity` and `MinSize` are set to the\nsame value does the warm pool have an absolute size.\nIf the desired capacity of the Auto Scaling group is higher than the\n`MaxGroupPreparedCapacity`, the capacity of the warm pool is 0, unless\nyou specify a value for `MinSize`. To remove a value that you previously set,\ninclude 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-maxgrouppreparedcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AutoScalingGroupName": { "MarkdownDocumentation": "`AutoScalingGroupName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-autoscalinggroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PoolState": { "MarkdownDocumentation": "`PoolState`\n\nSets the instance state to transition to after the lifecycle actions are complete.\nDefault is `Stopped`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Stopped | Running | Hiberna...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Stopped", "Running", "Hibernated" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-poolstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceReusePolicy": { "MarkdownDocumentation": "`InstanceReusePolicy`\n\nIndicates whether instances in the Auto Scaling group can be returned to the warm pool on\nscale in. The default is to terminate instances in the Auto Scaling group when the group scales\nin.\n*Required*: No\n*Type*: [InstanceReusePolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-instancereusepolicy", "UpdateType": "Mutable", "Required": false, "Type": "InstanceReusePolicy" } } }, "AWS::AutoScalingPlans::ScalingPlan": { "MarkdownDocumentation": "`AWS::AutoScalingPlans::ScalingPlan`\n\nThe `AWS::AutoScalingPlans::ScalingPlan` resource defines an AWS Auto Scaling scaling plan. A scaling plan is used to scale application resources to\nsize them appropriately to ensure that enough resource is available in the application at\npeak times and to reduce allocated resource during periods of low utilization. The\nfollowing resources can be added to a scaling plan:\n* Amazon EC2 Auto Scaling groups\n* Amazon EC2 Spot Fleet requests\n* Amazon ECS services\n* Amazon DynamoDB tables and global secondary indexes\n* Amazon Aurora Replicas\nFor more information, see the [Scaling Plans User Guide](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-a-scaling-plan.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::AutoScalingPlans::ScalingPlan`\nresource to the intrinsic `Ref` function, the function returns the Amazon\nResource Name (ARN) of the scaling plan. The format of the ARN is as follows:\n`arn:aws:autoscaling:region:123456789012:scalingPlan:scalingPlanName/plan-name:scalingPlanVersion/plan-version`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html", "Attributes": { "ScalingPlanName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#ScalingPlanName-fn::getatt" }, "ScalingPlanVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#ScalingPlanVersion-fn::getatt" } }, "Properties": { "ApplicationSource": { "Type": "ApplicationSource", "Required": true, "MarkdownDocumentation": "`ApplicationSource`\n\nA CloudFormation stack or a set of tags. You can create one scaling plan per application\nsource. The `ApplicationSource` property must be present to ensure\ninteroperability with the AWS Auto Scaling console.\n*Required*: Yes\n*Type*: [ApplicationSource](./aws-properties-autoscalingplans-scalingplan-applicationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-applicationsource", "UpdateType": "Mutable" }, "ScalingInstructions": { "Type": "List", "Required": true, "MarkdownDocumentation": "`ScalingInstructions`\n\nThe scaling instructions.\n*Required*: Yes\n*Type*: Array of [ScalingInstruction](./aws-properties-autoscalingplans-scalingplan-scalinginstruction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-scalinginstructions", "ItemType": "ScalingInstruction", "UpdateType": "Mutable" } } }, "AWS::B2BI::Capability": { "MarkdownDocumentation": "`AWS::B2BI::Capability`\n\nInstantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nReturns the type of the capability. Currently, only `edi` is supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `edi`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "edi" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nSpecifies a structure that contains the details for a capability.\n*Required*: Yes\n*Type*: [CapabilityConfiguration](./aws-properties-b2bi-capability-capabilityconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-configuration", "UpdateType": "Mutable", "Required": true, "Type": "CapabilityConfiguration" }, "InstructionsDocuments": { "MarkdownDocumentation": "`InstructionsDocuments`\n\nSpecifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.\n*Required*: No\n*Type*: Array of [S3Location](./aws-properties-b2bi-capability-s3location.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-instructionsdocuments", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "S3Location", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-b2bi-capability-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe display name of the capability.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `254`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#cfn-b2bi-capability-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nReturns a timestamp that identifies the most recent date and time that the capability\nwas modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#ModifiedAt-fn::getatt" }, "CapabilityId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CapabilityId`\n\nReturns a system-assigned unique identifier for the capability.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#CapabilityId-fn::getatt" }, "CapabilityArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CapabilityArn`\n\nReturns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#CapabilityArn-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nReturns a timestamp for creation date and time of the capability.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-capability.html#CreatedAt-fn::getatt" } } }, "AWS::B2BI::Partnership": { "MarkdownDocumentation": "`AWS::B2BI::Partnership`\n\nCreates a partnership between a customer and a trading partner, based on the supplied\nparameters. A partnership represents the connection between you and your trading partner. It ties\ntogether a profile and one or more trading capabilities.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html", "Properties": { "ProfileId": { "MarkdownDocumentation": "`ProfileId`\n\nReturns the unique, system-generated identifier for the profile connected to this partnership.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-profileid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Email": { "MarkdownDocumentation": "`Email`\n\nSpecifies the email address associated with this trading partner.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\.\\-]+@[\\w\\.\\-]+$`\n*Minimum*: `5`\n*Maximum*: `254`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-email", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Capabilities": { "MarkdownDocumentation": "`Capabilities`\n\nReturns one or more capabilities associated with this partnership.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-capabilities", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Phone": { "MarkdownDocumentation": "`Phone`\n\nSpecifies the phone number associated with the partnership.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\+?([0-9 \\t\\-()\\/]{7,})(?:\\s*(?:#|x\\.?|ext\\.?|extension) \\t*(\\d+))?$`\n*Minimum*: `7`\n*Maximum*: `22`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-phone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CapabilityOptions": { "MarkdownDocumentation": "`CapabilityOptions`\n\nContains the details for an Outbound EDI capability.\n*Required*: No\n*Type*: [CapabilityOptions](./aws-properties-b2bi-partnership-capabilityoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-capabilityoptions", "UpdateType": "Mutable", "Required": false, "Type": "CapabilityOptions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA key-value pair for a specific partnership. Tags are metadata that you can use to\nsearch for and group capabilities for various purposes.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-b2bi-partnership-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nReturns the name of the partnership.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `254`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#cfn-b2bi-partnership-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nReturns a timestamp that identifies the most recent date and time that the partnership\nwas modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#ModifiedAt-fn::getatt" }, "TradingPartnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TradingPartnerId`\n\nReturns the unique, system-generated identifier for a trading partner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#TradingPartnerId-fn::getatt" }, "PartnershipId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PartnershipId`\n\nReturns the unique, system-generated identifier for a partnership.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#PartnershipId-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nReturns a timestamp for creation date and time of the partnership.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#CreatedAt-fn::getatt" }, "PartnershipArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PartnershipArn`\n\nReturns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html#PartnershipArn-fn::getatt" } } }, "AWS::B2BI::Profile": { "MarkdownDocumentation": "`AWS::B2BI::Profile`\n\nCreates a customer profile. You can have up to five customer profiles, each representing\na distinct private network. A profile is the mechanism used to create the concept of\na private network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html", "Properties": { "Logging": { "MarkdownDocumentation": "`Logging`\n\nSpecifies whether or not logging is enabled for this profile.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-logging", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Email": { "MarkdownDocumentation": "`Email`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\.\\-]+@[\\w\\.\\-]+$`\n*Minimum*: `5`\n*Maximum*: `254`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-email", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BusinessName": { "MarkdownDocumentation": "`BusinessName`\n\nReturns the name for the business associated with this profile.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `254`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-businessname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Phone": { "MarkdownDocumentation": "`Phone`\n\nSpecifies the phone number associated with the profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\+?([0-9 \\t\\-()\\/]{7,})(?:\\s*(?:#|x\\.?|ext\\.?|extension) \\t*(\\d+))?$`\n*Minimum*: `7`\n*Maximum*: `22`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-phone", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA key-value pair for a specific profile. Tags are metadata that you can use to search\nfor and group capabilities for various purposes.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-b2bi-profile-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nReturns the display name for profile.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `254`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#cfn-b2bi-profile-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nReturns the timestamp that identifies the most recent date and time that the profile was\nmodified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#ModifiedAt-fn::getatt" }, "ProfileId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProfileId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#ProfileId-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nReturns the timestamp for creation date and time of the profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#CreatedAt-fn::getatt" }, "LogGroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`LogGroupName`\n\nReturns the name of the logging group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#LogGroupName-fn::getatt" }, "ProfileArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProfileArn`\n\nReturns an Amazon Resource Name (ARN) for the profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html#ProfileArn-fn::getatt" } } }, "AWS::B2BI::Transformer": { "MarkdownDocumentation": "`AWS::B2BI::Transformer`\n\nCreates a transformer. AWS B2B Data Interchange currently supports two scenarios:\n* *Inbound EDI*: the AWS customer receives an EDI\n file from their trading partner. AWS B2B Data Interchange converts this EDI file into a JSON or\n XML file with a service-defined structure. A mapping template provided by the\n customer, in JSONata or XSLT format, is optionally applied to this file to produce a\n JSON or XML file with the structure the customer requires.\n* *Outbound EDI*: the AWS customer has a JSON or\n XML file containing data that they wish to use in an EDI file. A mapping template,\n provided by the customer (in either JSONata or XSLT format) is applied to this file\n to generate a JSON or XML file in the service-defined structure. This file is then\n converted to an EDI file.\n###### Note\nThe following fields are provided for backwards compatibility only:\n`fileFormat`, `mappingTemplate`, `ediType`, and\n`sampleDocument`.\n* Use the `mapping` data type in place of `mappingTemplate`\n and `fileFormat`\n* Use the `sampleDocuments` data type in place of\n `sampleDocument`\n* Use either the `inputConversion` or `outputConversion` in\n place of `ediType`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nReturns the state of the newly created transformer. The transformer can be either\n`active` or `inactive`. For the transformer to be used in a\ncapability, its status must `active`.\n*Required*: Yes\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)", "RefReturnValue": "", "AllowedValues": [ "active", "inactive" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Mapping": { "MarkdownDocumentation": "`Mapping`\n\nReturns the structure that contains the mapping template and its language (either XSLT or JSONATA).\n*Required*: No\n*Type*: [Mapping](./aws-properties-b2bi-transformer-mapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-mapping", "UpdateType": "Mutable", "Required": false, "Type": "Mapping" }, "InputConversion": { "MarkdownDocumentation": "`InputConversion`\n\nReturns a structure that contains the format options for the transformation.\n*Required*: No\n*Type*: [InputConversion](./aws-properties-b2bi-transformer-inputconversion.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-inputconversion", "UpdateType": "Mutable", "Required": false, "Type": "InputConversion" }, "SampleDocuments": { "MarkdownDocumentation": "`SampleDocuments`\n\nReturns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.\n*Required*: No\n*Type*: [SampleDocuments](./aws-properties-b2bi-transformer-sampledocuments.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-sampledocuments", "UpdateType": "Mutable", "Required": false, "Type": "SampleDocuments" }, "OutputConversion": { "MarkdownDocumentation": "`OutputConversion`\n\nReturns the `OutputConversion` object, which contains the format options for the outbound transformation.\n*Required*: No\n*Type*: [OutputConversion](./aws-properties-b2bi-transformer-outputconversion.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-outputconversion", "UpdateType": "Mutable", "Required": false, "Type": "OutputConversion" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA key-value pair for a specific transformer. Tags are metadata that you can use to\nsearch for and group capabilities for various purposes.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-b2bi-transformer-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nReturns the descriptive name for the transformer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,512}$`\n*Minimum*: `1`\n*Maximum*: `254`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#cfn-b2bi-transformer-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nReturns a timestamp representing the date and time for the most recent change for the\ntransformer object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#ModifiedAt-fn::getatt" }, "TransformerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransformerId`\n\nThe system-assigned unique identifier for the transformer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#TransformerId-fn::getatt" }, "TransformerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransformerArn`\n\nReturns an Amazon Resource Name (ARN) for a specific transformer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#TransformerArn-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nReturns a timestamp indicating when the transformer was created. For example,\n`2023-07-20T19:58:44.624Z`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html#CreatedAt-fn::getatt" } } }, "AWS::Backup::BackupPlan": { "MarkdownDocumentation": "`AWS::Backup::BackupPlan`\n\nContains an optional backup plan display name and an array of `BackupRule`\nobjects, each of which specifies a backup rule. Each rule in a backup plan is a separate\nscheduled task and can back up a different selection of AWS\nresources.\nFor a sample CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`BackupPlanId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html", "Properties": { "BackupPlan": { "MarkdownDocumentation": "`BackupPlan`\n\nUniquely identifies the backup plan to be associated with the selection of\nresources.\n*Required*: Yes\n*Type*: [BackupPlanResourceType](./aws-properties-backup-backupplan-backupplanresourcetype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#cfn-backup-backupplan-backupplan", "UpdateType": "Mutable", "Required": true, "Type": "BackupPlanResourceType" }, "BackupPlanTags": { "MarkdownDocumentation": "`BackupPlanTags`\n\nThe tags to assign to the backup plan.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#cfn-backup-backupplan-backupplantags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "VersionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VersionId`\n\nUnique, randomly generated, Unicode, UTF-8 encoded strings\nthat are at most 1,024 bytes long. Version Ids cannot be edited.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#VersionId-fn::getatt" }, "BackupPlanId": { "PrimitiveType": "String", "MarkdownDocumentation": "`BackupPlanId`\n\nUniquely identifies a backup plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#BackupPlanId-fn::getatt" }, "BackupPlanArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`BackupPlanArn`\n\nAn Amazon Resource Name (ARN) that uniquely identifies a\nbackup plan; for example,\n`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#BackupPlanArn-fn::getatt" } } }, "AWS::Backup::BackupSelection": { "MarkdownDocumentation": "`AWS::Backup::BackupSelection`\n\nSpecifies a set of resources to assign to a backup plan.\nFor a sample CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`BackupSelectionId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html", "Properties": { "BackupSelection": { "MarkdownDocumentation": "`BackupSelection`\n\nSpecifies 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,\nan optional role to provide access to the AWS service the resource belongs\nto, and an optional array of tags used to identify a set of resources.\n*Required*: Yes\n*Type*: [BackupSelectionResourceType](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html#cfn-backup-backupselection-backupselection", "UpdateType": "Immutable", "Required": true, "Type": "BackupSelectionResourceType" }, "BackupPlanId": { "MarkdownDocumentation": "`BackupPlanId`\n\nUniquely identifies a backup 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html#cfn-backup-backupselection-backupplanid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "BackupPlanId": { "PrimitiveType": "String", "MarkdownDocumentation": "`BackupPlanId`\n\nUniquely identifies a backup plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html#BackupPlanId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nUniquely identifies the backup selection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html#Id-fn::getatt" }, "SelectionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SelectionId`\n\nUniquely identifies a request to assign a set of resources\nto a backup plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html#SelectionId-fn::getatt" } } }, "AWS::Backup::BackupVault": { "MarkdownDocumentation": "`AWS::Backup::BackupVault`\n\nCreates a logical container where backups are stored. A `CreateBackupVault`\nrequest includes a name, optionally one or more resource tags, an encryption key, and a\nrequest ID.\nDo not include sensitive data, such as passport numbers, in the name of a backup\nvault.\nFor a sample CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`BackupVaultName`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html", "Properties": { "BackupVaultTags": { "MarkdownDocumentation": "`BackupVaultTags`\n\nThe tags to assign to the backup vault.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaulttags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "BackupVaultName": { "MarkdownDocumentation": "`BackupVaultName`\n\nThe name of a logical container where backups are stored. Backup vaults are identified\nby names that are unique to the account used to create them and the AWS\nRegion where they are created.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaultname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nA server-side encryption key you can specify to encrypt your backups from services\nthat support full AWS Backup management; for example,\n`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.\nIf you specify a key, you must specify its ARN, not its alias. If you do not specify a key,\nAWS Backup creates a KMS key for you by default.\nTo learn which AWS Backup services support full AWS Backup management\nand how AWS Backup handles encryption for backups from services that do not yet support\nfull AWS Backup, see [Encryption for backups in AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-encryptionkeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LockConfiguration": { "MarkdownDocumentation": "`LockConfiguration`\n\nConfiguration for [AWS Backup Vault\nLock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html).\n*Required*: No\n*Type*: [LockConfigurationType](./aws-properties-backup-backupvault-lockconfigurationtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-lockconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LockConfigurationType" }, "Notifications": { "MarkdownDocumentation": "`Notifications`\n\nThe SNS event notifications for the specified backup vault.\n*Required*: No\n*Type*: [NotificationObjectType](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-notifications", "UpdateType": "Mutable", "Required": false, "Type": "NotificationObjectType" }, "AccessPolicy": { "MarkdownDocumentation": "`AccessPolicy`\n\nA resource-based policy that is used to manage access permissions on the target backup\nvault.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-accesspolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } }, "Attributes": { "BackupVaultName": { "PrimitiveType": "String", "MarkdownDocumentation": "`BackupVaultName`\n\nThe name of a logical container where backups are\nstored. Backup vaults are identified by names that are unique to the account used to create\nthem and the Region where they are created. They consist of lowercase and uppercase\nletters, numbers, and hyphens.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#BackupVaultName-fn::getatt" }, "BackupVaultArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`BackupVaultArn`\n\nAn Amazon Resource Name (ARN) that uniquely identifies a\nbackup vault; for example,\n`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#BackupVaultArn-fn::getatt" } } }, "AWS::Backup::Framework": { "MarkdownDocumentation": "`AWS::Backup::Framework`\n\nCreates a framework with one or more controls. A framework is a collection of controls\nthat you can use to evaluate your backup practices. By using pre-built customizable\ncontrols to define your policies, you can evaluate whether your backup practices comply\nwith your policies and which resources are not yet in compliance.\nFor a sample CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/bam-cfn-integration.html#bam-cfn-frameworks-template).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the framework ARN.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html", "Properties": { "FrameworkControls": { "MarkdownDocumentation": "`FrameworkControls`\n\nContains detailed information about all of the controls of a framework. Each framework\nmust contain at least one control.\n*Required*: Yes\n*Type*: Array of [FrameworkControl](./aws-properties-backup-framework-frameworkcontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkcontrols", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FrameworkControl", "DuplicatesAllowed": false }, "FrameworkName": { "MarkdownDocumentation": "`FrameworkName`\n\nThe unique name of a framework. This name is between 1 and 256 characters, starting with\na letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\\_).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z][_a-zA-Z0-9]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FrameworkTags": { "MarkdownDocumentation": "`FrameworkTags`\n\nThe tags to assign to your framework.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-backup-framework-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworktags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "FrameworkDescription": { "MarkdownDocumentation": "`FrameworkDescription`\n\nAn optional description of the framework with a maximum 1,024 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe UTC time when you created your framework.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#CreationTime-fn::getatt" }, "FrameworkStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`FrameworkStatus`\n\nFramework status refers to whether you have turned on resource tracking for all of your\nresources. This status is `Active` when you turn on all resources the framework\nevaluates. For other statuses and steps to correct them, see [Framework compliance\nstatus](https://docs.aws.amazon.com/aws-backup/latest/devguide/viewing-frameworks.html) in the *AWS Backup; Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#FrameworkStatus-fn::getatt" }, "DeploymentStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeploymentStatus`\n\nDepolyment status refers to whether your framework has completed deployment. This status\nis usually `Completed`, but might also be `Create in progress` or\nanother status. For a list of statuses, see [Framework compliance\nstatus](https://docs.aws.amazon.com/aws-backup/latest/devguide/viewing-frameworks.html) in the *AWS Backup; Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#DeploymentStatus-fn::getatt" }, "FrameworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FrameworkArn`\n\nThe Amazon Resource Name (ARN) of your framework.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#FrameworkArn-fn::getatt" } } }, "AWS::Backup::LogicallyAirGappedBackupVault": { "MarkdownDocumentation": "`AWS::Backup::LogicallyAirGappedBackupVault`\n\nCreates a logical container to where backups may be copied.\nThis request includes a name, the Region, the maximum number of retention days, the\nminimum number of retention days, and optionally can include tags and a creator request\nID.\n###### Note\nDo not include sensitive data, such as passport numbers, in the name of a backup\nvault.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the backup vault.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html", "Properties": { "BackupVaultTags": { "MarkdownDocumentation": "`BackupVaultTags`\n\nThe tags to assign to the vault.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaulttags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "BackupVaultName": { "MarkdownDocumentation": "`BackupVaultName`\n\nThe name of a logical container where backups are stored. Logically air-gapped\nbackup vaults are identified by names that are unique to the account used to create\nthem and the Region where they are created.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaultname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nThe server-side encryption key that is used to protect your backups; for example,\n`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.\nIf this field is left blank, AWS Backup will create an AWS owned key to be used to encrypt the content of the logically air-gapped vault. The ARN of this created key will be available as `Fn::GetAtt` output.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-encryptionkeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaxRetentionDays": { "MarkdownDocumentation": "`MaxRetentionDays`\n\nThe maximum retention period that the vault retains its recovery points.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-maxretentiondays", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "MinRetentionDays": { "MarkdownDocumentation": "`MinRetentionDays`\n\nThis setting specifies the minimum retention period\nthat the vault retains its recovery points.\nThe minimum value accepted is 7 days.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-minretentiondays", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "Notifications": { "MarkdownDocumentation": "`Notifications`\n\nReturns event notifications for the specified backup vault.\n*Required*: No\n*Type*: [NotificationObjectType](./aws-properties-backup-logicallyairgappedbackupvault-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-notifications", "UpdateType": "Mutable", "Required": false, "Type": "NotificationObjectType" }, "MpaApprovalTeamArn": { "MarkdownDocumentation": "`MpaApprovalTeamArn`\n\nThe Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault. This cannot be changed after it is set from the CloudFormation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-mpaapprovalteamarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessPolicy": { "MarkdownDocumentation": "`AccessPolicy`\n\nThe backup vault access policy document in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-accesspolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } }, "Attributes": { "VaultState": { "PrimitiveType": "String", "MarkdownDocumentation": "`VaultState`\n\nThe vault state. The possible values are `CREATING`, `AVAILABLE`,\nand `FAILED`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#VaultState-fn::getatt" }, "VaultType": { "PrimitiveType": "String", "MarkdownDocumentation": "`VaultType`\n\nThe vault type. The possible values are `BACKUP_VAULT` and `LOGICALLY_AIR_GAPPED_BACKUP_VAULT`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#VaultType-fn::getatt" }, "BackupVaultArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`BackupVaultArn`\n\nThe ARN of the backup vault.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#BackupVaultArn-fn::getatt" } } }, "AWS::Backup::ReportPlan": { "MarkdownDocumentation": "`AWS::Backup::ReportPlan`\n\nCreates a report plan. A report plan is a document that contains information about the\ncontents of the report and where AWS Backup will deliver it.\nIf you call `CreateReportPlan` with a plan that already exists, you receive\nan `AlreadyExistsException` exception.\nFor a sample CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html", "Properties": { "ReportSetting": { "MarkdownDocumentation": "`ReportSetting`\n\nIdentifies the report template for the report. Reports are built using a report\ntemplate. The report templates are:\n`RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\nCOPY_JOB_REPORT | RESTORE_JOB_REPORT`\nIf the report template is `RESOURCE_COMPLIANCE_REPORT` or\n`CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report\ncoverage by AWS Regions and frameworks.\n*Required*: Yes\n*Type*: [ReportSetting](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportsetting", "UpdateType": "Mutable", "Required": true, "Type": "ReportSetting" }, "ReportPlanDescription": { "MarkdownDocumentation": "`ReportPlanDescription`\n\nAn optional description of the report plan with a maximum 1,024 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplandescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReportPlanName": { "MarkdownDocumentation": "`ReportPlanName`\n\nThe unique name of the report plan. This name is between 1 and 256 characters starting\nwith a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores\n(\\_).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z][_a-zA-Z0-9]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplanname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ReportDeliveryChannel": { "MarkdownDocumentation": "`ReportDeliveryChannel`\n\nContains information about where and how to deliver your reports, specifically your\nAmazon S3 bucket name, S3 key prefix, and the formats of your reports.\n*Required*: Yes\n*Type*: [ReportDeliveryChannel](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportdeliverychannel", "UpdateType": "Mutable", "Required": true, "Type": "ReportDeliveryChannel" }, "ReportPlanTags": { "MarkdownDocumentation": "`ReportPlanTags`\n\nThe tags to assign to your report plan.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-backup-reportplan-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplantags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ReportPlanArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReportPlanArn`\n\nThe Amazon Resource Name (ARN) of your report plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#ReportPlanArn-fn::getatt" } } }, "AWS::Backup::RestoreTestingPlan": { "MarkdownDocumentation": "`AWS::Backup::RestoreTestingPlan`\n\nCreates a restore testing plan.\nThe first of two steps to create a restore testing\nplan. After this request is successful, finish the procedure using\nCreateRestoreTestingSelection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html", "Properties": { "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nA CRON expression in specified timezone when a restore\ntesting plan is executed. When no CRON expression is provided, AWS Backup will use the default\nexpression `cron(0 5 ? * * *)`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-scheduleexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StartWindowHours": { "MarkdownDocumentation": "`StartWindowHours`\n\nDefaults to 24 hours.\nA value in hours after a\nrestore test is scheduled before a job will be canceled if it\ndoesn't start successfully. This value is optional. If this value\nis included, this parameter has a maximum value of 168 hours\n(one week).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-startwindowhours", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RecoveryPointSelection": { "MarkdownDocumentation": "`RecoveryPointSelection`\n\nThe specified criteria to assign a set of resources, such as\nrecovery point types or backup vaults.\n*Required*: Yes\n*Type*: [RestoreTestingRecoveryPointSelection](./aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-recoverypointselection", "UpdateType": "Mutable", "Required": true, "Type": "RestoreTestingRecoveryPointSelection" }, "RestoreTestingPlanName": { "MarkdownDocumentation": "`RestoreTestingPlanName`\n\nThe RestoreTestingPlanName is a unique string that is the name\nof the restore testing plan. This cannot be changed after creation,\nand it must consist of only alphanumeric characters and underscores.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-restoretestingplanname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ScheduleExpressionTimezone": { "MarkdownDocumentation": "`ScheduleExpressionTimezone`\n\nOptional. This is the timezone in which the schedule\nexpression is set. By default, ScheduleExpressions are in UTC.\nYou can modify this to a specified timezone.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-scheduleexpressiontimezone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOptional tags to include. A tag is a key-value pair you can use to manage, filter, and\nsearch for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and\nthe following characters: `+ - = . _ : /.`\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-backup-restoretestingplan-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "RestoreTestingPlanArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RestoreTestingPlanArn`\n\nAn Amazon Resource Name (ARN) that uniquely identifies\na restore testing plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#RestoreTestingPlanArn-fn::getatt" } } }, "AWS::Backup::RestoreTestingSelection": { "MarkdownDocumentation": "`AWS::Backup::RestoreTestingSelection`\n\nThis request can be sent after CreateRestoreTestingPlan request\nreturns successfully. This is the second part of creating a resource testing\nplan, and it must be completed sequentially.\nThis consists of `RestoreTestingSelectionName`,\n`ProtectedResourceType`, and one of the following:\n* `ProtectedResourceArns`\n* `ProtectedResourceConditions`\nEach protected resource type can have one single value.\nA restore testing selection can include a wildcard value (\"\\*\") for\n`ProtectedResourceArns` along with `ProtectedResourceConditions`.\nAlternatively, you can include up to 30 specific protected resource ARNs in\n`ProtectedResourceArns`.\nCannot select by both protected resource types AND specific ARNs.\nRequest will fail if both are included.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html", "Properties": { "ProtectedResourceConditions": { "MarkdownDocumentation": "`ProtectedResourceConditions`\n\nIn a resource testing selection, this parameter filters by\nspecific conditions such as `StringEquals` or\n`StringNotEquals`.\n*Required*: No\n*Type*: [ProtectedResourceConditions](./aws-properties-backup-restoretestingselection-protectedresourceconditions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourceconditions", "UpdateType": "Mutable", "Required": false, "Type": "ProtectedResourceConditions" }, "ProtectedResourceType": { "MarkdownDocumentation": "`ProtectedResourceType`\n\nThe type of AWS resource included in a resource\ntesting selection;\nfor example, an Amazon EBS volume\nor an Amazon RDS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourcetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RestoreMetadataOverrides": { "MarkdownDocumentation": "`RestoreMetadataOverrides`\n\nYou can override certain restore metadata keys by including the parameter\n`RestoreMetadataOverrides` in the body of\n`RestoreTestingSelection`. Key values are not case sensitive.\nSee the complete list of [restore testing\ninferred metadata](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html).\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoremetadataoverrides", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "RestoreTestingSelectionName": { "MarkdownDocumentation": "`RestoreTestingSelectionName`\n\nThe unique name of the restore testing selection that\nbelongs to the related restore testing plan.\nThe name consists of only alphanumeric characters and underscores.\nMaximum length is 50.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoretestingselectionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProtectedResourceArns": { "MarkdownDocumentation": "`ProtectedResourceArns`\n\nYou can include specific ARNs, such as\n`ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"]`\nor you can include a wildcard: `ProtectedResourceArns: [\"*\"]`,\nbut not both.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourcearns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RestoreTestingPlanName": { "MarkdownDocumentation": "`RestoreTestingPlanName`\n\nUnique string that is the name of the restore testing plan.\nThe name cannot be changed after creation. The name must\nconsist of only alphanumeric characters and underscores.\nMaximum length is 50.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoretestingplanname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that\nAWS Backup uses to create the target resource; for\nexample:`arn:aws:iam::123456789012:role/S3Access`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-iamrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ValidationWindowHours": { "MarkdownDocumentation": "`ValidationWindowHours`\n\nThis is amount of hours (1 to 168) available to run a validation script on the data. The\ndata will be deleted upon the completion of the validation script or the end of the\nspecified retention period, whichever comes first.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-validationwindowhours", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::BackupGateway::Hypervisor": { "MarkdownDocumentation": "`AWS::BackupGateway::Hypervisor`\n\nRepresents the hypervisor's permissions to which the gateway will connect.\nA hypervisor is hardware, software, or firmware that creates and manages virtual machines,\nand allocates resources to them.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`HypervisorArn`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the AWS Key Management Service used to encrypt the\nhypervisor.\n*Required*: No\n*Type*: String\n*Pattern*: `^(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)$`\n*Minimum*: `50`\n*Maximum*: `500`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html#cfn-backupgateway-hypervisor-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Username": { "MarkdownDocumentation": "`Username`\n\nThe username for the hypervisor.\n*Required*: No\n*Type*: String\n*Pattern*: `^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html#cfn-backupgateway-hypervisor-username", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Host": { "MarkdownDocumentation": "`Host`\n\nThe server host of the hypervisor. This can be either an IP address or a fully-qualified\ndomain name (FQDN).\n*Required*: No\n*Type*: String\n*Pattern*: `^.+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html#cfn-backupgateway-hypervisor-host", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogGroupArn": { "MarkdownDocumentation": "`LogGroupArn`\n\nThe Amazon Resource Name (ARN) of the group of gateways within\nthe requested log.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\\-\\/\\.]+:\\*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html#cfn-backupgateway-hypervisor-loggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags of the hypervisor configuration to import.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-backupgateway-hypervisor-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html#cfn-backupgateway-hypervisor-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the hypervisor.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html#cfn-backupgateway-hypervisor-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password for the hypervisor.\n*Required*: No\n*Type*: String\n*Pattern*: `^[ -~]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html#cfn-backupgateway-hypervisor-password", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "HypervisorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`HypervisorArn`\n\nReturns `HypervisorArn`, an Amazon Resource Name (ARN) that uniquely identifies a\nHypervisor. For example:\n`arn:aws:backup-gateway:us-east-1:123456789012:hypervisor/hype-1234D67D`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backupgateway-hypervisor.html#HypervisorArn-fn::getatt" } } }, "AWS::Batch::ComputeEnvironment": { "MarkdownDocumentation": "`AWS::Batch::ComputeEnvironment`\n\nThe `AWS::Batch::ComputeEnvironment` resource defines your AWS Batch compute environment. You can define `MANAGED` or\n`UNMANAGED` compute environments. `MANAGED` compute environments\ncan use Amazon EC2 or AWS Fargate resources. `UNMANAGED`\ncompute environments can only use EC2 resources. For more information, see [Compute\nEnvironments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the *AWS Batch User Guide*.\nIn a managed compute environment, AWS Batch manages the capacity and\ninstance types of the compute resources within the environment. This is based on the\ncompute resource specification that you define or the [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) that you\nspecify when you create the compute environment. You can choose either to use EC2 On-Demand\nInstances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your\nmanaged compute environment. You can optionally set a maximum price so that Spot Instances\nonly launch when the Spot Instance price is below a specified percentage of the On-Demand\nprice.\n###### Note\nMulti-node parallel jobs are not supported on Spot Instances.\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and\nhave a lot of flexibility with how you configure your compute resources. For example, you\ncan use custom AMI. However, you need to verify that your AMI meets the Amazon ECS\ncontainer instance AMI specification. For more information, see [container instance\nAMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) in the *Amazon Elastic Container Service Developer\nGuide*. After you have created your unmanaged compute environment, you can use\nthe [DescribeComputeEnvironments](https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeComputeEnvironments.html) operation to find the Amazon ECS cluster that is\nassociated with it. Then, manually launch your container instances into that Amazon ECS\ncluster. For more information, see [Launching an Amazon\nECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) in the *Amazon Elastic Container Service\nDeveloper Guide*.\n###### Note\nTo create a compute environment that uses EKS resources, the caller must have\npermissions to call `eks:DescribeCluster`.\n###### Note\nAWS Batch doesn't upgrade the AMIs in a compute environment after it's\ncreated except under specific conditions. For example, it doesn't automatically update\nthe AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore,\nyou're responsible for the management of the guest operating system (including updates\nand security patches) and any additional application software or utilities that you\ninstall on the compute resources. There are two ways to use a new AMI for your AWS Batch jobs. The original method is to complete these steps:\n1. Create a new compute environment with the new AMI.\n2. Add the compute environment to an existing job queue.\n3. Remove the earlier compute environment from your job queue.\n4. Delete the earlier compute environment.\nIn April 2022, AWS Batch added enhanced support for updating compute\nenvironments. For example, the `UpdateComputeEnvironent` API lets you use the\n`ReplaceComputeEnvironment` property to dynamically update compute\nenvironment parameters such as the launch template or instance type without replacement.\nFor more information, see [Updating compute\nenvironments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide*.\nTo use the enhanced updating of compute environments to update AMIs, follow these\nrules:\n* Either do not set the [ServiceRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-servicerole) property or set it to the **AWSServiceRoleForBatch** service-linked role.\n* Set the [AllocationStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy) property to `BEST_FIT_PROGRESSIVE` or\n `SPOT_CAPACITY_OPTIMIZED`.\n* Set the [ReplaceComputeEnvironment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-replacecomputeenvironment) property to `false`.\n \n ###### Important\n \n Set the `ReplaceComputeEnvironment` property to `true`\n if the compute environment uses the `BEST_FIT` allocation\n strategy.\n \n \n ###### Note\n \n If the `ReplaceComputeEnvironment` property is set to\n `false`, you might receive an error message when you update the\n CFN template for a compute environment. This issue occurs if the updated\n `desiredvcpus` value is less than the current\n `desiredvcpus` value. As a workaround, delete the\n `desiredvcpus` value from the updated template or use the\n `minvcpus` property to manage the number of vCPUs. For\n information, see [Error message when you update the `DesiredvCpus`\n setting](https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update).\n* Set the [UpdateToLatestImageVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion) property to `true`. This\n property is used when you update a compute environment. The [UpdateToLatestImageVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion) property is ignored when you create a\n compute environment.\n* Either do not specify an image ID in [ImageId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid) or [ImageIdOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imageidoverride) properties, or in the launch template identified by\n the [Launch Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate) property. In that case AWS Batch will\n select the latest Amazon ECS optimized AMI supported by AWS Batch at\n the time the infrastructure update is initiated. Alternatively you can specify the\n AMI ID in the `ImageId` or `ImageIdOverride` properties, or\n the launch template identified by the `LaunchTemplate` properties.\n Changing any of these properties will trigger an infrastructure update.\nIf these rules are followed, any update that triggers an infrastructure update will\ncause the AMI ID to be re-selected. If the [Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-version) property of the [LaunchTemplateSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html) is set to `$Latest` or\n`$Default`, the latest or default version of the launch template will be\nevaluated up at the time of the infrastructure update, even if the\n`LaunchTemplateSpecification` was not updated.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the compute environment ARN, such as `arn:aws:batch:us-east-1:555555555555:compute-environment/M4OnDemand`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html", "Properties": { "Context": { "MarkdownDocumentation": "`Context`\n\nReserved.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-context", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UnmanagedvCpus": { "MarkdownDocumentation": "`UnmanagedvCpus`\n\nThe maximum number of vCPUs for an unmanaged compute environment. This parameter is only\nused for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this\nparameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.\n###### Note\nThis parameter is only supported when the `type` parameter is set to\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-unmanagedvcpus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the compute environment: `MANAGED` or `UNMANAGED`. For\nmore 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)", "RefReturnValue": "", "AllowedValues": [ "MANAGED", "UNMANAGED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ReplaceComputeEnvironment": { "MarkdownDocumentation": "`ReplaceComputeEnvironment`\n\nSpecifies whether the compute environment is replaced if an update is made that requires\nreplacing the instances in the compute environment. The default value is `true`.\nTo enable more properties to be updated, set this property to `false`. When\nchanging the value of this property to `false`, do not change any other\nproperties at the same time. If other properties are changed at the same time, and the\nchange needs to be rolled back but it can't, it's possible for the stack to go into the\n`UPDATE_ROLLBACK_FAILED` state. You can't update a stack that is in the\n`UPDATE_ROLLBACK_FAILED` state. However, if you can continue to roll it back,\nyou can return the stack to its original settings and then try to update it again. For more\ninformation, see [Continue rolling back an update](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) in the *AWS CloudFormation User Guide*.\n`ReplaceComputeEnvironment` is not applicable for Fargate compute environments. Fargate compute environments are always updated without interruption.\nThe properties that can't be changed without replacing the compute environment are in\nthe [`ComputeResources`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html) property type: [`AllocationStrategy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy), [`BidPercentage`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage), [`Ec2Configuration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration), [`Ec2KeyPair`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair), [`Ec2KeyPair`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair), [`ImageId`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid), [`InstanceRole`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole), [`InstanceTypes`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes), [`LaunchTemplate`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate), [`MaxvCpus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus), [`MinvCpus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus), [`PlacementGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup), [`SecurityGroupIds`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids), [`Subnets`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets), [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags), [`Type`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type), and [`UpdateToLatestImageVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion).\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-replacecomputeenvironment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ServiceRole": { "MarkdownDocumentation": "`ServiceRole`\n\nThe full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS\nservices 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\n*AWS Batch User Guide*.\n###### Important\nIf your account already created the AWS Batch service-linked role, that role is used by\ndefault for your compute environment unless you specify a different role here. If the\nAWS Batch service-linked role doesn't exist in your account, and no role is specified here,\nthe 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\nthe full role ARN (recommended) or prefix the role name with the path. For example, if a\nrole with the name `bar` has a path of `/foo/`, specify\n`/foo/bar` as the role name. For more information, see [Friendly\nnames and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.\n###### Note\nDepending on how you created your AWS Batch service role, its ARN might contain the\n`service-role` path prefix. When you only specify the name of the service role,\nAWS Batch assumes that your ARN doesn't use the `service-role` path prefix. Because\nof this, we recommend that you specify the full ARN of your service role when you create\ncompute 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-servicerole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UpdatePolicy": { "MarkdownDocumentation": "`UpdatePolicy`\n\nSpecifies the infrastructure update policy for the compute environment. For more information\nabout infrastructure updates, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the\n*AWS Batch User Guide*.\n*Required*: No\n*Type*: [UpdatePolicy](./aws-properties-batch-computeenvironment-updatepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-updatepolicy", "UpdateType": "Mutable", "Required": false, "Type": "UpdatePolicy" }, "EksConfiguration": { "MarkdownDocumentation": "`EksConfiguration`\n\nThe details for the Amazon EKS cluster that supports the compute environment.\n###### Note\nTo create a compute environment that uses EKS resources, the caller must have\npermissions to call `eks:DescribeCluster`.\n*Required*: No\n*Type*: [EksConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-eksconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EksConfiguration" }, "ComputeEnvironmentName": { "MarkdownDocumentation": "`ComputeEnvironmentName`\n\nThe name for your compute environment. It can be up to 128 characters long. It can contain uppercase and\nlowercase 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeenvironmentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ComputeResources": { "MarkdownDocumentation": "`ComputeResources`\n\nThe ComputeResources property type specifies details of the compute resources managed by\nthe compute environment. This parameter is required for managed compute environments. For\nmore information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in\nthe *AWS Batch User Guide*.\n*Required*: No\n*Type*: [ComputeResources](./aws-properties-batch-computeenvironment-computeresources.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeresources", "UpdateType": "Mutable", "Required": false, "Type": "ComputeResources" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the compute environment. If the state is `ENABLED`, then the\ncompute environment accepts jobs from a queue and can scale out automatically based on\nqueues.\nIf the state is `ENABLED`, then the AWS Batch scheduler can attempt to place jobs\nfrom an associated job queue on the compute resources within the environment. If the compute\nenvironment is managed, then it can scale its instances out or in automatically, based on the\njob queue demand.\nIf the state is `DISABLED`, then the AWS Batch scheduler doesn't attempt to place\njobs within the environment. Jobs in a `STARTING` or `RUNNING` state\ncontinue to progress normally. Managed compute environments in the `DISABLED` state\ndon't scale out.\n###### Note\nCompute environments in a `DISABLED` state may continue to incur billing\ncharges. To prevent additional charges, turn off and then delete the compute environment.\nFor 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.\nHowever, the instance size doesn't change. For example, consider a `c5.8xlarge`\ninstance with a `minvCpus` value of `4` and a `desiredvCpus`\nvalue of `36`. This instance doesn't scale down to a `c5.large`\ninstance.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags applied to the compute environment.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "ComputeEnvironmentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ComputeEnvironmentArn`\n\nReturns the compute environment ARN, such as `arn:aws:batch:us-east-1:111122223333:compute-environment/ComputeEnvironmentName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#ComputeEnvironmentArn-fn::getatt" } } }, "AWS::Batch::ConsumableResource": { "MarkdownDocumentation": "`AWS::Batch::ConsumableResource`\n\nThe `AWS::Batch::ConsumableResource` resource specifies the parameters for an\nAWS Batch consumable resource. For more information, see [Resource-aware scheduling](https://docs.aws.amazon.com/batch/latest/userguide/resource-aware-scheduling.html) in the *AWS Batch User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the consumable resource ARN, such as `arn:aws:batch:us-east-1:555555555555:consumable-resource/Resource`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html", "Properties": { "TotalQuantity": { "MarkdownDocumentation": "`TotalQuantity`\n\nThe total amount of the consumable resource that is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html#cfn-batch-consumableresource-totalquantity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Long" }, "ConsumableResourceName": { "MarkdownDocumentation": "`ConsumableResourceName`\n\nThe name of the consumable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html#cfn-batch-consumableresource-consumableresourcename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nIndicates whether the resource is available to be re-used after a job completes. Can be\none of:\n* `REPLENISHABLE`\n* `NON_REPLENISHABLE`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `REPLENISHABLE | NON_REPLENI...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "REPLENISHABLE", "NON_REPLENISHABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html#cfn-batch-consumableresource-resourcetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that you apply to the consumable resource to help you categorize and organize your\nresources. Each tag consists of a key and an optional value. For more information, see [Tagging your AWS Batch resources](https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html).\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html#cfn-batch-consumableresource-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "CreatedAt": { "PrimitiveType": "Long", "MarkdownDocumentation": "`CreatedAt`\n\nThe Unix timestamp (in milliseconds) for when the consumable resource was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html#CreatedAt-fn::getatt" }, "ConsumableResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConsumableResourceArn`\n\nThe Amazon Resource Name (ARN) of the consumable resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html#ConsumableResourceArn-fn::getatt" }, "InUseQuantity": { "PrimitiveType": "Long", "MarkdownDocumentation": "`InUseQuantity`\n\nThe amount of the consumable resource that is currently in use.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html#InUseQuantity-fn::getatt" }, "AvailableQuantity": { "PrimitiveType": "Long", "MarkdownDocumentation": "`AvailableQuantity`\n\nThe amount of the consumable resource that is currently available to use.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-consumableresource.html#AvailableQuantity-fn::getatt" } } }, "AWS::Batch::JobDefinition": { "MarkdownDocumentation": "`AWS::Batch::JobDefinition`\n\nThe `AWS::Batch::JobDefinition` resource specifies the parameters for an\nAWS Batch job definition. For more information, see [Job\nDefinitions](https://docs.aws.amazon.com/batch/latest/userguide/job_definitions.html) in the *AWS Batch User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the job definition ARN, such as `arn:aws:batch:us-east-1:111122223333:job-definition/test-gpu:2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nDefault parameters or parameter substitution placeholders that are set in the job\ndefinition. Parameters are specified as a key-value pair mapping. Parameters in a\n`SubmitJob` request override any corresponding parameter defaults from the job\ndefinition. For more information about specifying parameters, see [Job definition parameters](https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html) in the\n*AWS Batch User Guide*.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nThe timeout time for jobs that are submitted with this job definition. After the amount of\ntime you specify passes, AWS Batch terminates your jobs if they aren't finished.\n*Required*: No\n*Type*: [JobTimeout](./aws-properties-batch-jobdefinition-jobtimeout.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-timeout", "UpdateType": "Mutable", "Required": false, "Type": "JobTimeout" }, "JobDefinitionName": { "MarkdownDocumentation": "`JobDefinitionName`\n\nThe name of the job definition.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-jobdefinitionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PropagateTags": { "MarkdownDocumentation": "`PropagateTags`\n\nSpecifies whether to propagate the tags from the job or job definition to the corresponding\nAmazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to\nthe tasks when the tasks are created. For tags with the same name, job tags are given priority\nover job definitions tags. If the total number of combined tags from the job and job definition\nis over 50, the job is moved to the `FAILED` state.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-propagatetags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PlatformCapabilities": { "MarkdownDocumentation": "`PlatformCapabilities`\n\nThe platform capabilities required by the job definition. If no value is specified, it\ndefaults to `EC2`. Jobs run on Fargate resources specify\n`FARGATE`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-platformcapabilities", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EksProperties": { "MarkdownDocumentation": "`EksProperties`\n\nAn object with properties that are specific to Amazon EKS-based jobs. When\n`eksProperties` is used in the job definition, it can't be used in addition to\n`containerProperties`, `ecsProperties`, or\n`nodeProperties`.\n*Required*: No\n*Type*: [EksProperties](./aws-properties-batch-jobdefinition-eksproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-eksproperties", "UpdateType": "Mutable", "Required": false, "Type": "EksProperties" }, "ConsumableResourceProperties": { "MarkdownDocumentation": "`ConsumableResourceProperties`\n\nContains a list of consumable resources required by the job.\n*Required*: No\n*Type*: [ConsumableResourceProperties](./aws-properties-batch-jobdefinition-consumableresourceproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-consumableresourceproperties", "UpdateType": "Mutable", "Required": false, "Type": "ConsumableResourceProperties" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of job definition. For more information about multi-node parallel jobs, see\n[Creating a multi-node\nparallel job definition](https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) in the *AWS Batch User Guide*.\n* If the value is `container`, then one of the following is required: `containerProperties`, `ecsProperties`, or `eksProperties`.\n* If the value is `multinode`, then `nodeProperties` is required.\n###### Note\nIf the job is run on Fargate resources, then `multinode` isn't supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `container | multinode...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "container", "multinode" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NodeProperties": { "MarkdownDocumentation": "`NodeProperties`\n\nAn object with properties that are specific to multi-node parallel jobs. When\n`nodeProperties` is used in the job definition, it can't be used in addition to\n`containerProperties`, `ecsProperties`, or\n`eksProperties`.\n###### Note\nIf the job runs on Fargate resources, don't specify `nodeProperties`. Use\n`containerProperties` instead.\n*Required*: No\n*Type*: [NodeProperties](./aws-properties-batch-jobdefinition-nodeproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-nodeproperties", "UpdateType": "Mutable", "Required": false, "Type": "NodeProperties" }, "SchedulingPriority": { "MarkdownDocumentation": "`SchedulingPriority`\n\nThe scheduling priority of the job definition. This only affects jobs in job queues with a\nfair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\nscheduling priority.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-schedulingpriority", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ContainerProperties": { "MarkdownDocumentation": "`ContainerProperties`\n\nAn object with properties specific to Amazon ECS-based jobs. When\n`containerProperties` is used in the job definition, it can't be used in addition to\n`eksProperties`, `ecsProperties`, or `nodeProperties`.\n*Required*: No\n*Type*: [ContainerProperties](./aws-properties-batch-jobdefinition-containerproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-containerproperties", "UpdateType": "Mutable", "Required": false, "Type": "ContainerProperties" }, "EcsProperties": { "MarkdownDocumentation": "`EcsProperties`\n\nAn object that contains the properties for the Amazon ECS resources of a job.When\n`ecsProperties` is used in the job definition, it can't be used in addition to\n`containerProperties`, `eksProperties`, or\n`nodeProperties`.\n*Required*: No\n*Type*: [EcsProperties](./aws-properties-batch-jobdefinition-ecsproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-ecsproperties", "UpdateType": "Mutable", "Required": false, "Type": "EcsProperties" }, "ResourceRetentionPolicy": { "MarkdownDocumentation": "`ResourceRetentionPolicy`\n\nSpecifies the resource retention policy settings for the job definition.\n*Required*: No\n*Type*: [ResourceRetentionPolicy](./aws-properties-batch-jobdefinition-resourceretentionpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-resourceretentionpolicy", "UpdateType": "Mutable", "Required": false, "Type": "ResourceRetentionPolicy" }, "RetryStrategy": { "MarkdownDocumentation": "`RetryStrategy`\n\nThe retry strategy to use for failed jobs that are submitted with this job\ndefinition.\n*Required*: No\n*Type*: [RetryStrategy](./aws-properties-batch-jobdefinition-retrystrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-retrystrategy", "UpdateType": "Mutable", "Required": false, "Type": "RetryStrategy" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that are applied to the job definition.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "JobDefinitionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`JobDefinitionArn`\n\nThe job definition ARN, such as `arn:aws:batch:us-east-1:111122223333:job-definition/test-gpu:2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#JobDefinitionArn-fn::getatt" } } }, "AWS::Batch::JobQueue": { "MarkdownDocumentation": "`AWS::Batch::JobQueue`\n\nThe `AWS::Batch::JobQueue` resource specifies the parameters for an AWS Batch job queue definition. For more information, see [Job Queues](https://docs.aws.amazon.com/batch/latest/userguide/job_queues.html) in\nthe *AWS Batch User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the job queue ARN, such as `arn:aws:batch:us-east-1:111122223333:job-queue/HighPriority`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html", "Properties": { "ComputeEnvironmentOrder": { "MarkdownDocumentation": "`ComputeEnvironmentOrder`\n\nThe set of compute environments mapped to a job queue and their order relative to each\nother. The job scheduler uses this parameter to determine which compute environment runs a\nspecific job. Compute environments must be in the `VALID` state before you can\nassociate them with a job queue. You can associate up to three compute environments with a job\nqueue. All of the compute environments must be either EC2 (`EC2` or\n`SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`); EC2 and\nFargate compute environments can't be mixed.\n###### Note\nAll compute environments that are associated with a job queue must share the same\narchitecture. AWS Batch doesn't support mixing compute environment architecture types in a\nsingle job queue.\n*Required*: No\n*Type*: [Array](./aws-properties-batch-jobqueue-computeenvironmentorder.html) of [ComputeEnvironmentOrder](./aws-properties-batch-jobqueue-computeenvironmentorder.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ComputeEnvironmentOrder", "DuplicatesAllowed": true }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority of the job queue. Job queues with a higher priority (or a higher integer\nvalue for the `priority` parameter) are evaluated first when associated with the\nsame compute environment. Priority is determined in descending order. For example, a job queue\nwith a priority value of `10` is given scheduling preference over a job queue with\na priority value of `1`. All of the compute environments must be either EC2\n(`EC2` or `SPOT`) or Fargate (`FARGATE` or\n`FARGATE_SPOT`); EC2 and Fargate compute environments can't be mixed.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the job queue. If the job queue state is `ENABLED`, it is able to\naccept jobs. If the job queue state is `DISABLED`, new jobs can't be added to the\nqueue, but jobs already in the queue can finish.\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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JobQueueType": { "MarkdownDocumentation": "`JobQueueType`\n\nThe type of job queue. For service jobs that run on SageMaker AI, this value is `SAGEMAKER_TRAINING`. For regular container jobs, this value is `EKS`, `ECS`, or `ECS_FARGATE` depending on the compute environment.\n*Required*: No\n*Type*: String\n*Allowed values*: `EKS | ECS | ECS_FARGATE | S...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "EKS", "ECS", "ECS_FARGATE", "SAGEMAKER_TRAINING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServiceEnvironmentOrder": { "MarkdownDocumentation": "`ServiceEnvironmentOrder`\n\nThe order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.\n*Required*: No\n*Type*: [Array](./aws-properties-batch-jobqueue-serviceenvironmentorder.html) of [ServiceEnvironmentOrder](./aws-properties-batch-jobqueue-serviceenvironmentorder.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-serviceenvironmentorder", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServiceEnvironmentOrder", "DuplicatesAllowed": true }, "SchedulingPolicyArn": { "MarkdownDocumentation": "`SchedulingPolicyArn`\n\nThe Amazon Resource Name (ARN) of the scheduling policy. The format is\n`aws:Partition:batch:Region:Account:scheduling-policy/Name`.\nFor example,\n`aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-schedulingpolicyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JobStateTimeLimitActions": { "MarkdownDocumentation": "`JobStateTimeLimitActions`\n\nThe set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after `maxTimeSeconds` has passed.\n*Required*: No\n*Type*: Array of [JobStateTimeLimitAction](./aws-properties-batch-jobqueue-jobstatetimelimitaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobstatetimelimitactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "JobStateTimeLimitAction", "DuplicatesAllowed": true }, "JobQueueName": { "MarkdownDocumentation": "`JobQueueName`\n\nThe name of the job queue. It can be up to 128 letters long. It can contain uppercase and\nlowercase letters, numbers, hyphens (-), and underscores (\\_).\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that are applied to the job queue. For more information, see [Tagging your AWS Batch resources](https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) in\n*AWS Batch User Guide*.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "JobQueueArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`JobQueueArn`\n\nReturns the job queue ARN, such as `arn:aws:batch:us-east-1:111122223333:job-queue/JobQueueName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#JobQueueArn-fn::getatt" } } }, "AWS::Batch::SchedulingPolicy": { "MarkdownDocumentation": "`AWS::Batch::SchedulingPolicy`\n\nThe `AWS::Batch::SchedulingPolicy` resource specifies the parameters for an\nAWS Batch scheduling policy. For more information, see [Scheduling\nPolicies](https://docs.aws.amazon.com/batch/latest/userguide/scheduling_policies.html) in the *AWS Batch User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the scheduling policy ARN, such as `arn:aws:batch:us-east-1:111122223333:scheduling-policy/HighPriority`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html", "Properties": { "FairsharePolicy": { "MarkdownDocumentation": "`FairsharePolicy`\n\nThe fair-share scheduling policy details.\n*Required*: No\n*Type*: [FairsharePolicy](./aws-properties-batch-schedulingpolicy-fairsharepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html#cfn-batch-schedulingpolicy-fairsharepolicy", "UpdateType": "Mutable", "Required": false, "Type": "FairsharePolicy" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that you apply to the scheduling policy to help you categorize and organize your\nresources. Each tag consists of a key and an optional value. For more information, see [Tagging AWS\nResources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in *AWS General Reference*.\nThese tags can be updated or removed using the [TagResource](https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html) and [UntagResource](https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html) API operations.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html#cfn-batch-schedulingpolicy-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain\nuppercase 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html#cfn-batch-schedulingpolicy-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the scheduling policy ARN, such as `arn:aws:batch:us-east-1:111122223333:scheduling-policy/HighPriority`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html#Arn-fn::getatt" } } }, "AWS::Batch::ServiceEnvironment": { "MarkdownDocumentation": "`AWS::Batch::ServiceEnvironment`\n\nCreates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the compute environment ARN, such as `arn:aws:batch:us-east-1:555555555555:service-environment/ServiceEnvirnonment`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html", "Properties": { "ServiceEnvironmentName": { "MarkdownDocumentation": "`ServiceEnvironmentName`\n\nThe name of the service 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-serviceenvironmentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the service environment. Valid values are `ENABLED` and `DISABLED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceEnvironmentType": { "MarkdownDocumentation": "`ServiceEnvironmentType`\n\nThe type of service environment. For SageMaker Training jobs, this value is `SAGEMAKER_TRAINING`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SAGEMAKER_TRAINING...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SAGEMAKER_TRAINING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-serviceenvironmenttype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CapacityLimits": { "MarkdownDocumentation": "`CapacityLimits`\n\nThe capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.\n*Required*: Yes\n*Type*: Array of [CapacityLimit](./aws-properties-batch-serviceenvironment-capacitylimit.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-capacitylimits", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CapacityLimit", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see [Tagging your AWS Batch resources](https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html).\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "ServiceEnvironmentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceEnvironmentArn`\n\nThe Amazon Resource Name (ARN) of the service environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#ServiceEnvironmentArn-fn::getatt" } } }, "AWS::Bedrock::Agent": { "MarkdownDocumentation": "`AWS::Bedrock::Agent`\n\nSpecifies an agent as a resource in a top-level template. Minimally, you must specify\nthe following properties:\n* AgentName \u2013 Specify a name for the agent.\n* AgentResourceRoleArn \u2013 Specify the Amazon Resource Name (ARN) of the service\n role with permissions to invoke API operations on the agent. For more\n information, see [Create a service role\n for Agents for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-permissions.html).\n* FoundationModel \u2013 Specify the model ID of a foundation model to use when\n invoking the agent. For more information, see [Supported regions and\n models for Agents for Amazon Bedrock](https://docs.aws.amazon.com//bedrock/latest/userguide/agents-supported.html).\nFor more information about using agents in Amazon Bedrock, see [Agents for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the agent base ID.\nFor example, `{ \"Ref\": \"myAgent\" }` could return the value\n`\"AGENT12345\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html", "Properties": { "AgentCollaborators": { "MarkdownDocumentation": "`AgentCollaborators`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [AgentCollaborator](./aws-properties-bedrock-agent-agentcollaborator.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentcollaborators", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AgentCollaborator", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the agent.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SkipResourceInUseCheckOnDelete": { "MarkdownDocumentation": "`SkipResourceInUseCheckOnDelete`\n\nSpecifies whether to delete the resource even if it's in use. By default, this value\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-skipresourceinusecheckondelete", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "GuardrailConfiguration": { "MarkdownDocumentation": "`GuardrailConfiguration`\n\nDetails about the guardrail associated with the agent.\n*Required*: No\n*Type*: [GuardrailConfiguration](./aws-properties-bedrock-agent-guardrailconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-guardrailconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GuardrailConfiguration" }, "PromptOverrideConfiguration": { "MarkdownDocumentation": "`PromptOverrideConfiguration`\n\nContains configurations to override prompt templates in different parts of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).\n*Required*: No\n*Type*: [PromptOverrideConfiguration](./aws-properties-bedrock-agent-promptoverrideconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-promptoverrideconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PromptOverrideConfiguration" }, "MemoryConfiguration": { "MarkdownDocumentation": "`MemoryConfiguration`\n\nContains memory configuration for the agent.\n*Required*: No\n*Type*: [MemoryConfiguration](./aws-properties-bedrock-agent-memoryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-memoryconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MemoryConfiguration" }, "AgentCollaboration": { "MarkdownDocumentation": "`AgentCollaboration`\n\nThe agent's collaboration settings.\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLED | SUPERVISOR | SUP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "SUPERVISOR", "SUPERVISOR_ROUTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentcollaboration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Instruction": { "MarkdownDocumentation": "`Instruction`\n\nInstructions that tell the agent what it should do and how it should interact with users.\n*Required*: No\n*Type*: String\n*Minimum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-instruction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomOrchestration": { "MarkdownDocumentation": "`CustomOrchestration`\n\nContains custom orchestration configurations for the agent.\n*Required*: No\n*Type*: [CustomOrchestration](./aws-properties-bedrock-agent-customorchestration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-customorchestration", "UpdateType": "Mutable", "Required": false, "Type": "CustomOrchestration" }, "TestAliasTags": { "MarkdownDocumentation": "`TestAliasTags`\n\nMetadata that you can assign to a resource as key-value pairs. For more information,\nsee the following resources:\n* [Tag naming\n limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)\n* [Tagging\n best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-testaliastags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "AgentResourceRoleArn": { "MarkdownDocumentation": "`AgentResourceRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentresourcerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OrchestrationType": { "MarkdownDocumentation": "`OrchestrationType`\n\nSpecifies the orchestration strategy for the agent.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | CUSTOM_ORCHESTRAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "CUSTOM_ORCHESTRATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-orchestrationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdleSessionTTLInSeconds": { "MarkdownDocumentation": "`IdleSessionTTLInSeconds`\n\nThe number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.\n*Required*: No\n*Type*: Number\n*Minimum*: `60`\n*Maximum*: `5400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-idlesessionttlinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FoundationModel": { "MarkdownDocumentation": "`FoundationModel`\n\nThe foundation model used for orchestration by the agent.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-foundationmodel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomerEncryptionKeyArn": { "MarkdownDocumentation": "`CustomerEncryptionKeyArn`\n\nThe Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-customerencryptionkeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AgentName": { "MarkdownDocumentation": "`AgentName`\n\nThe name of the agent.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KnowledgeBases": { "MarkdownDocumentation": "`KnowledgeBases`\n\nThe knowledge bases associated with the agent.\n*Required*: No\n*Type*: Array of [AgentKnowledgeBase](./aws-properties-bedrock-agent-agentknowledgebase.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-knowledgebases", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AgentKnowledgeBase", "DuplicatesAllowed": true }, "ActionGroups": { "MarkdownDocumentation": "`ActionGroups`\n\nThe action groups that belong to an agent.\n*Required*: No\n*Type*: Array of [AgentActionGroup](./aws-properties-bedrock-agent-agentactiongroup.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-actiongroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AgentActionGroup", "DuplicatesAllowed": true }, "AutoPrepare": { "MarkdownDocumentation": "`AutoPrepare`\n\nSpecifies whether to automatically update the `DRAFT` version of the agent\nafter making changes to the agent. The `DRAFT` version can be continually\niterated upon during internal development. By default, this value is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-autoprepare", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that you can assign to a resource as key-value pairs. For more information,\nsee the following resources:\n* [Tag naming\n limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)\n* [Tagging\n best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "AgentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentArn`\n\nThe Amazon Resource Name (ARN) of the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#AgentArn-fn::getatt" }, "AgentStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentStatus`\n\nThe status of the agent and whether it is ready for use. The following statuses are possible:\n* CREATING \u2013 The agent is being created.\n* PREPARING \u2013 The agent is being prepared.\n* PREPARED \u2013 The agent is prepared and ready to be invoked.\n* NOT\\_PREPARED \u2013 The agent has been created but not yet prepared.\n* FAILED \u2013 The agent API operation failed.\n* UPDATING \u2013 The agent is being updated.\n* DELETING \u2013 The agent is being deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#AgentStatus-fn::getatt" }, "AgentVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentVersion`\n\nThe version of the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#AgentVersion-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the agent was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#CreatedAt-fn::getatt" }, "PreparedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`PreparedAt`\n\nThe time at which the agent was last prepared.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#PreparedAt-fn::getatt" }, "AgentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentId`\n\nThe unique identifier of the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#AgentId-fn::getatt" }, "FailureReasons": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`FailureReasons`\n\nContains reasons that the agent-related API that you invoked failed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#FailureReasons-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the agent was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#UpdatedAt-fn::getatt" }, "RecommendedActions": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`RecommendedActions`\n\nContains recommended actions to take for the agent-related API that you invoked to succeed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#RecommendedActions-fn::getatt" } } }, "AWS::Bedrock::AgentAlias": { "MarkdownDocumentation": "`AWS::Bedrock::AgentAlias`\n\nSpecifies an agent alias as a resource in a top-level template. Minimally, you must\nspecify the following properties:\n* AgentAliasName \u2013 Specify a name for the alias.\nFor more information about creating aliases for an agent in Amazon Bedrock, see\n[Deploy\nan Amazon Bedrock agent](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-deploy.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the agent ID and the agent alias ID, separated by a pipe\n(`|`).\nFor example, `{ \"Ref\": \"myAgentAlias\" }` could return the value\n`\"AGENT12345|ALIAS12345\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html", "Properties": { "AgentAliasName": { "MarkdownDocumentation": "`AgentAliasName`\n\nThe name of the alias of the agent.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#cfn-bedrock-agentalias-agentaliasname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the alias of the agent.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#cfn-bedrock-agentalias-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoutingConfiguration": { "MarkdownDocumentation": "`RoutingConfiguration`\n\nContains details about the routing configuration of the alias.\n*Required*: No\n*Type*: Array of [AgentAliasRoutingConfigurationListItem](./aws-properties-bedrock-agentalias-agentaliasroutingconfigurationlistitem.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#cfn-bedrock-agentalias-routingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AgentAliasRoutingConfigurationListItem", "DuplicatesAllowed": true }, "AgentId": { "MarkdownDocumentation": "`AgentId`\n\nThe unique identifier of the agent.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z]{10}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#cfn-bedrock-agentalias-agentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that you can assign to a resource as key-value pairs. For more information,\nsee the following resources:\n* [Tag naming\n limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)\n* [Tagging\n best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#cfn-bedrock-agentalias-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "AgentAliasStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentAliasStatus`\n\nThe status of the alias of the agent and whether it is ready for use. The following statuses are possible:\n* CREATING \u2013 The agent alias is being created.\n* PREPARED \u2013 The agent alias is finished being created or updated and is ready to be invoked.\n* FAILED \u2013 The agent alias API operation failed.\n* UPDATING \u2013 The agent alias is being updated.\n* DELETING \u2013 The agent alias is being deleted.\n* DISSOCIATED - The agent alias has no version associated with it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#AgentAliasStatus-fn::getatt" }, "AgentAliasArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentAliasArn`\n\nThe Amazon Resource Name (ARN) of the alias of the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#AgentAliasArn-fn::getatt" }, "AgentAliasHistoryEvents": { "Type": "List", "ItemType": "AgentAliasHistoryEvent", "MarkdownDocumentation": "`AgentAliasHistoryEvents`\n\nContains details about the history of the alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#AgentAliasHistoryEvents-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the alias of the agent was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#CreatedAt-fn::getatt" }, "AgentAliasId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentAliasId`\n\nThe unique identifier of the alias of the agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#AgentAliasId-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the alias was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agentalias.html#UpdatedAt-fn::getatt" } } }, "AWS::Bedrock::ApplicationInferenceProfile": { "MarkdownDocumentation": "`AWS::Bedrock::ApplicationInferenceProfile`\n\nSpecifies an inference profile as a resource in a top-level template. Use the\n`ModelSource` field to specify the inference profile to copy into the\nresource. For more information about using inference profiles in Amazon Bedrock, see\n[Improve resilience with\ncross-region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) .\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the inference profile ID.\nFor example, `{ \"Ref\": \"myInferenceProfile\" }` could return the value\n`\"IP12345678\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the inference profile.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z:.][ _-]?)+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#cfn-bedrock-applicationinferenceprofile-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InferenceProfileName": { "MarkdownDocumentation": "`InferenceProfileName`\n\nThe name of the inference profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][ _-]?)+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#cfn-bedrock-applicationinferenceprofile-inferenceprofilename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ModelSource": { "MarkdownDocumentation": "`ModelSource`\n\nContains configurations for the inference profile to copy as the resource.\n*Required*: No\n*Type*: [InferenceProfileModelSource](./aws-properties-bedrock-applicationinferenceprofile-inferenceprofilemodelsource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#cfn-bedrock-applicationinferenceprofile-modelsource", "UpdateType": "Immutable", "Required": false, "Type": "InferenceProfileModelSource" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags associated with the inference profile.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-bedrock-applicationinferenceprofile-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#cfn-bedrock-applicationinferenceprofile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the inference profile. `ACTIVE` means that the inference profile is ready to be used.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#Status-fn::getatt" }, "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nThe type of the inference profile. The following types are possible:\n* `SYSTEM_DEFINED` \u2013 The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.\n* `APPLICATION` \u2013 The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#Type-fn::getatt" }, "InferenceProfileArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`InferenceProfileArn`\n\nThe Amazon Resource Name (ARN) of the inference profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#InferenceProfileArn-fn::getatt" }, "InferenceProfileIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`InferenceProfileIdentifier`\n\nThe ID or Amazon Resource Name (ARN) of the inference profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#InferenceProfileIdentifier-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the inference profile was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#CreatedAt-fn::getatt" }, "Models": { "Type": "List", "ItemType": "InferenceProfileModel", "MarkdownDocumentation": "`Models`\n\nA list of information about each model in the inference profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#Models-fn::getatt" }, "InferenceProfileId": { "PrimitiveType": "String", "MarkdownDocumentation": "`InferenceProfileId`\n\nThe unique identifier of the inference profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#InferenceProfileId-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the inference profile was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-applicationinferenceprofile.html#UpdatedAt-fn::getatt" } } }, "AWS::Bedrock::AutomatedReasoningPolicy": { "MarkdownDocumentation": "`AWS::Bedrock::AutomatedReasoningPolicy`\n\nCreates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated\nReasoning policies use mathematical techniques to detect hallucinations, suggest\ncorrections, and highlight unstated assumptions in the responses of your GenAI\napplication.\nTo create a policy, you upload a source document that describes the rules that you're\nencoding. Automated Reasoning extracts important concepts from the source document that\nwill become variables in the policy and infers policy rules.\nTo learn more about creating Automated Reasoning policies, see [Minimize AI hallucinations and deliver up to 99% verification accuracy with\nAutomated Reasoning checks: Now available](https://aws.amazon.com/blogs/aws/minimize-ai-hallucinations-and-deliver-up-to-99-verification-accuracy-with-automated-reasoning-checks-now-available/) in the *AWS News Blog*.\n", "RefReturnValue": "\nReturns the policy ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the policy.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\s\\S]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#cfn-bedrock-automatedreasoningpolicy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#cfn-bedrock-automatedreasoningpolicy-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PolicyDefinition": { "MarkdownDocumentation": "`PolicyDefinition`\n\nThe complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.\n*Required*: No\n*Type*: [PolicyDefinition](./aws-properties-bedrock-automatedreasoningpolicy-policydefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#cfn-bedrock-automatedreasoningpolicy-policydefinition", "UpdateType": "Mutable", "Required": false, "Type": "PolicyDefinition" }, "ForceDelete": { "MarkdownDocumentation": "`ForceDelete`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#cfn-bedrock-automatedreasoningpolicy-forcedelete", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the Automated Reasoning policy.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-bedrock-automatedreasoningpolicy-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#cfn-bedrock-automatedreasoningpolicy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z-_ ]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#cfn-bedrock-automatedreasoningpolicy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DefinitionHash": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefinitionHash`\n\nA hash of the policy definition used to identify the version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#DefinitionHash-fn::getatt" }, "KmsKeyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`KmsKeyArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#KmsKeyArn-fn::getatt" }, "PolicyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyArn`\n\nThe Amazon Resource Name (ARN) of the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#PolicyArn-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version of the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#Version-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the policy was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#CreatedAt-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the policy was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#UpdatedAt-fn::getatt" }, "PolicyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyId`\n\nThe unique identifier of the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicy.html#PolicyId-fn::getatt" } } }, "AWS::Bedrock::AutomatedReasoningPolicyVersion": { "MarkdownDocumentation": "`AWS::Bedrock::AutomatedReasoningPolicyVersion`\n\nCreates a new version of an existing Automated Reasoning policy. This allows you to iterate on your policy rules while maintaining previous versions for rollback or comparison purposes.\n", "RefReturnValue": "\nReturns the policy version ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html", "Properties": { "LastUpdatedDefinitionHash": { "MarkdownDocumentation": "`LastUpdatedDefinitionHash`\n\nThe hash of the policy definition that was last updated.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-z]{128}$`\n*Minimum*: `128`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#cfn-bedrock-automatedreasoningpolicyversion-lastupdateddefinitionhash", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PolicyArn": { "MarkdownDocumentation": "`PolicyArn`\n\nThe Amazon Resource Name (ARN) of the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy\\/[a-z0-9]{12}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#cfn-bedrock-automatedreasoningpolicyversion-policyarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the Automated Reasoning policy version.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-bedrock-automatedreasoningpolicyversion-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#cfn-bedrock-automatedreasoningpolicyversion-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "DefinitionHash": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefinitionHash`\n\nA hash of the policy definition used to identify the version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#DefinitionHash-fn::getatt" }, "Description": { "PrimitiveType": "String", "MarkdownDocumentation": "`Description`\n\nThe description of the policy version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#Description-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version number of the policy version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#Version-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the policy version was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#CreatedAt-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the policy version was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#UpdatedAt-fn::getatt" }, "PolicyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyId`\n\nThe unique identifier of the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#PolicyId-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the policy version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-automatedreasoningpolicyversion.html#Name-fn::getatt" } } }, "AWS::Bedrock::DataSource": { "MarkdownDocumentation": "`AWS::Bedrock::DataSource`\n\n###### Important\nProperties with `__Update requires: Replacement__` can result in the\ncreation of a new data source and deletion of the old one. This can happen if you\nalso change the Name of the data source.\nSpecifies a data source as a resource in a top-level template. Minimally, you must\nspecify the following properties:\n* Name \u2013 Specify a name for the data source.\n* KnowledgeBaseId \u2013 Specify the ID of the knowledge base for the data source to\n belong to.\n* DataSourceConfiguration \u2013 Specify information about the Amazon S3\n bucket containing the data source. The following sub-properties are\n required:\n \n + Type \u2013 Specify the value `S3`.\nFor more information about setting up data sources in Amazon Bedrock, see [Set up a\ndata source for your knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the knowledge base ID and the data source ID, separated\nby a pipe (`|`).\nFor example, `{ \"Ref\": \"myDataSource\" }` could return the value\n`\"KB12345678|DS12345678\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html", "Properties": { "DataDeletionPolicy": { "MarkdownDocumentation": "`DataDeletionPolicy`\n\nThe data deletion policy for the data source.\n*Required*: No\n*Type*: String\n*Allowed values*: `RETAIN | DELETE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RETAIN", "DELETE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-datadeletionpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the data source.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KnowledgeBaseId": { "MarkdownDocumentation": "`KnowledgeBaseId`\n\nThe unique identifier of the knowledge base to which the data source belongs.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z]{10}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-knowledgebaseid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ServerSideEncryptionConfiguration": { "MarkdownDocumentation": "`ServerSideEncryptionConfiguration`\n\nContains details about the configuration of the server-side encryption.\n*Required*: No\n*Type*: [ServerSideEncryptionConfiguration](./aws-properties-bedrock-datasource-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-serversideencryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ServerSideEncryptionConfiguration" }, "VectorIngestionConfiguration": { "MarkdownDocumentation": "`VectorIngestionConfiguration`\n\nContains details about how to ingest the documents in the data source.\n*Required*: No\n*Type*: [VectorIngestionConfiguration](./aws-properties-bedrock-datasource-vectoringestionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-vectoringestionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "VectorIngestionConfiguration" }, "DataSourceConfiguration": { "MarkdownDocumentation": "`DataSourceConfiguration`\n\nThe connection configuration for the data source.\n*Required*: Yes\n*Type*: [DataSourceConfiguration](./aws-properties-bedrock-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-datasourceconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "DataSourceConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the data source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DataSourceConfiguration.WebConfiguration.CrawlerConfiguration.UserAgentHeader": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataSourceConfiguration.WebConfiguration.CrawlerConfiguration.UserAgentHeader`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#DataSourceConfiguration.WebConfiguration.CrawlerConfiguration.UserAgentHeader-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the data source was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#CreatedAt-fn::getatt" }, "DataSourceStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataSourceStatus`\n\nThe status of the data source. The following statuses are possible:\n* Available \u2013 The data source has been created and is ready for ingestion into the knowledge base.\n* Deleting \u2013 The data source is being deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#DataSourceStatus-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the data source was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#UpdatedAt-fn::getatt" }, "FailureReasons": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`FailureReasons`\n\nThe detailed reasons on the failure to delete a data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#FailureReasons-fn::getatt" }, "DataSourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataSourceId`\n\nThe unique identifier of the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#DataSourceId-fn::getatt" } } }, "AWS::Bedrock::Flow": { "MarkdownDocumentation": "`AWS::Bedrock::Flow`\n\nCreates a prompt flow that you can use to send an input through various steps to yield\nan output. You define a flow by configuring nodes, each of which corresponds to a step\nof the flow, and creating connections between the nodes to create paths to different\noutputs. You can define the flow in one of the following ways:\n* Define a [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html) in the `Definition` property.\n* Provide the definition in the `DefinitionString` property as a\n JSON-formatted string matching the [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html) property.\n* Provide an Amazon S3 location in the `DefinitionS3Location`\n property that matches the [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html).\nIf you use the `DefinitionString` or `DefinitionS3Location`\nproperty, you can use the `DefinitionSubstitutions` property to define\nkey-value pairs to replace at runtime.\nFor more information, see [How it works](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html) and\n[Create\na prompt flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the flow.\nFor example, `{ \"Ref\": \"myFlow\" }` could return the value\n`\"\"arn:aws:bedrock:us-east-1:123456789012:flow/FLOW123456\"\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html", "Properties": { "TestAliasTags": { "MarkdownDocumentation": "`TestAliasTags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-testaliastags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see [Create a service row for flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-executionrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the flow.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefinitionString": { "MarkdownDocumentation": "`DefinitionString`\n\nThe definition of the flow as a JSON-formatted string. The string must match the\nformat in [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html).\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-definitionstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe definition of the nodes and connections between the nodes in the flow.\n*Required*: No\n*Type*: [FlowDefinition](./aws-properties-bedrock-flow-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-definition", "UpdateType": "Mutable", "Required": false, "Type": "FlowDefinition" }, "DefinitionSubstitutions": { "MarkdownDocumentation": "`DefinitionSubstitutions`\n\nA map that specifies the mappings for placeholder variables in the prompt flow\ndefinition. This enables the customer to inject values obtained at runtime. Variables\ncan be template parameter names, resource logical IDs, resource attributes, or a\nvariable in a key-value map. Only supported with the `DefinitionString` and\n`DefinitionS3Location` fields.\nSubstitutions must follow the syntax: `${key_name}` or\n`${variable_1,variable_2,...}`.\n*Required*: No\n*Type*: Object\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-definitionsubstitutions", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "Json" }, "CustomerEncryptionKeyArn": { "MarkdownDocumentation": "`CustomerEncryptionKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-customerencryptionkeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefinitionS3Location": { "MarkdownDocumentation": "`DefinitionS3Location`\n\nThe Amazon S3 location of the flow definition.\n*Required*: No\n*Type*: [S3Location](./aws-properties-bedrock-flow-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-definitions3location", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that you can assign to a resource as key-value pairs. For more information,\nsee the following resources:\n* [Tag naming\n limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)\n* [Tagging\n best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the flow.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#cfn-bedrock-flow-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the flow. The following statuses are possible:\n* NotPrepared \u2013 The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the `DRAFT` version won't contain the latest changes for testing. Send a [PrepareFlow](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html) request to package the latest changes into the `DRAFT` version.\n* Preparing \u2013 The flow is being prepared so that the `DRAFT` version contains the latest changes for testing.\n* Prepared \u2013 The flow is prepared and the `DRAFT` version contains the latest changes for testing.\n* Failed \u2013 The last API operation that you invoked on the flow failed. Send a [GetFlow](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html) request and check the error message in the `validations` field.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#Status-fn::getatt" }, "Validations": { "Type": "List", "ItemType": "FlowValidation", "MarkdownDocumentation": "`Validations`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#Validations-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe latest version of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#Version-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the flow was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#Arn-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the flow was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html#UpdatedAt-fn::getatt" } } }, "AWS::Bedrock::FlowAlias": { "MarkdownDocumentation": "`AWS::Bedrock::FlowAlias`\n\nCreates an alias of a flow for deployment. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the flow and the\nAmazon Resource Name (ARN) of its alias, separated by a pipe (`|`).\nFor example, `{ \"Ref\": \"myFlowAlias\" }` could return the value\n`\"arn:aws:bedrock:us-east-1:123456789012:flow/FLOW12345|arn:aws:bedrock:us-east-1:123456789012:flow/FLOW12345/alias/ALIAS12345\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the alias.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#cfn-bedrock-flowalias-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConcurrencyConfiguration": { "MarkdownDocumentation": "`ConcurrencyConfiguration`\n\nThe configuration that specifies how nodes in the flow are executed concurrently.\n*Required*: No\n*Type*: [FlowAliasConcurrencyConfiguration](./aws-properties-bedrock-flowalias-flowaliasconcurrencyconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#cfn-bedrock-flowalias-concurrencyconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FlowAliasConcurrencyConfiguration" }, "RoutingConfiguration": { "MarkdownDocumentation": "`RoutingConfiguration`\n\nA list of configurations about the versions that the alias maps to. Currently, you can only specify one.\n*Required*: Yes\n*Type*: Array of [FlowAliasRoutingConfigurationListItem](./aws-properties-bedrock-flowalias-flowaliasroutingconfigurationlistitem.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#cfn-bedrock-flowalias-routingconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FlowAliasRoutingConfigurationListItem", "DuplicatesAllowed": true }, "FlowArn": { "MarkdownDocumentation": "`FlowArn`\n\nThe Amazon Resource Name (ARN) of the alias.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#cfn-bedrock-flowalias-flowarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that you can assign to a resource as key-value pairs. For more information,\nsee the following resources:\n* [Tag naming\n limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)\n* [Tagging\n best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#cfn-bedrock-flowalias-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the alias.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#cfn-bedrock-flowalias-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "FlowId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FlowId`\n\nThe unique identifier of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#FlowId-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the alias was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the alias of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#Arn-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the alias was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowalias.html#UpdatedAt-fn::getatt" } } }, "AWS::Bedrock::FlowVersion": { "MarkdownDocumentation": "`AWS::Bedrock::FlowVersion`\n\nCreates a version of the flow that you can deploy. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the flow the version\nof the flow, separated by a pipe (`|`).\nFor example, `{ \"Ref\": \"myFlowVersion\" }` could return the value\n`\"arn:aws:bedrock:us-east-1:123456789012:flow/FLOW12345|1\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the flow version.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#cfn-bedrock-flowversion-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FlowArn": { "MarkdownDocumentation": "`FlowArn`\n\nThe Amazon Resource Name (ARN) of the flow that the version belongs to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#cfn-bedrock-flowversion-flowarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "FlowId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FlowId`\n\nThe unique identifier of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#FlowId-fn::getatt" }, "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#Status-fn::getatt" }, "ExecutionRoleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see [Create a service row for flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#ExecutionRoleArn-fn::getatt" }, "Definition.Nodes": { "Type": "List", "ItemType": "FlowNode", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#Definition.Nodes-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#Version-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at the version was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#CreatedAt-fn::getatt" }, "Definition": { "Type": "FlowDefinition", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#Definition-fn::getatt" }, "CustomerEncryptionKeyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CustomerEncryptionKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key that the flow version is encrypted\nwith.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#CustomerEncryptionKeyArn-fn::getatt" }, "Definition.Connections": { "Type": "List", "ItemType": "FlowConnection", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#Definition.Connections-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flowversion.html#Name-fn::getatt" } } }, "AWS::Bedrock::Guardrail": { "MarkdownDocumentation": "`AWS::Bedrock::Guardrail`\n\nCreates a guardrail to detect and filter harmful content in your generative AI\napplication.\nAmazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful\ncontent:\n* **Content filters** - Detect and filter harmful\n text or image content in input prompts or model responses. Filtering is done based\n on detection of certain predefined harmful content categories: Hate, Insults,\n Sexual, Violence, Misconduct and Prompt Attack. You also can adjust the filter\n strength for each of these categories.\n* **Denied topics** - Define a set of topics that\n are undesirable in the context of your application. The filter will help block them if\n detected in user queries or model responses.\n* **Word filters** - Configure filters to help\n block undesirable words, phrases, and profanity (exact match). Such words can include offensive terms,\n competitor names, etc.\n* **Sensitive information filters** - Configure filters to help block or\n mask sensitive information, such as personally identifiable information (PII), or custom\n regex in user inputs and model responses. Blocking or masking is done based on probabilistic detection of\n sensitive information in standard formats in entities such as SSN number, Date of Birth, address, etc. This also allows configuring regular expression based\n detection of patterns for identifiers.\n* **Contextual grounding check** - Help detect and filter\n hallucinations in model responses based on grounding in a source and\n relevance to the user query.\nFor more information, see [How Amazon Bedrock Guardrails works](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-how.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html", "Properties": { "TopicPolicyConfig": { "MarkdownDocumentation": "`TopicPolicyConfig`\n\nThe topic policies to configure for the guardrail.\n*Required*: No\n*Type*: [TopicPolicyConfig](./aws-properties-bedrock-guardrail-topicpolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-topicpolicyconfig", "UpdateType": "Mutable", "Required": false, "Type": "TopicPolicyConfig" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the guardrail.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CrossRegionConfig": { "MarkdownDocumentation": "`CrossRegionConfig`\n\nThe system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.\nFor more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).\n*Required*: No\n*Type*: [GuardrailCrossRegionConfig](./aws-properties-bedrock-guardrail-guardrailcrossregionconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-crossregionconfig", "UpdateType": "Mutable", "Required": false, "Type": "GuardrailCrossRegionConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the guardrail.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z-_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "WordPolicyConfig": { "MarkdownDocumentation": "`WordPolicyConfig`\n\nThe word policy you configure for the guardrail.\n*Required*: No\n*Type*: [WordPolicyConfig](./aws-properties-bedrock-guardrail-wordpolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-wordpolicyconfig", "UpdateType": "Mutable", "Required": false, "Type": "WordPolicyConfig" }, "ContextualGroundingPolicyConfig": { "MarkdownDocumentation": "`ContextualGroundingPolicyConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [ContextualGroundingPolicyConfig](./aws-properties-bedrock-guardrail-contextualgroundingpolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contextualgroundingpolicyconfig", "UpdateType": "Mutable", "Required": false, "Type": "ContextualGroundingPolicyConfig" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the AWS KMS key that you use to encrypt the guardrail.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlockedInputMessaging": { "MarkdownDocumentation": "`BlockedInputMessaging`\n\nThe message to return when the guardrail blocks a prompt.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedinputmessaging", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BlockedOutputsMessaging": { "MarkdownDocumentation": "`BlockedOutputsMessaging`\n\nThe message to return when the guardrail blocks a model response.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedoutputsmessaging", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SensitiveInformationPolicyConfig": { "MarkdownDocumentation": "`SensitiveInformationPolicyConfig`\n\nThe sensitive information policy to configure for the guardrail.\n*Required*: No\n*Type*: [SensitiveInformationPolicyConfig](./aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig", "UpdateType": "Mutable", "Required": false, "Type": "SensitiveInformationPolicyConfig" }, "ContentPolicyConfig": { "MarkdownDocumentation": "`ContentPolicyConfig`\n\nThe content filter policies to configure for the guardrail.\n*Required*: No\n*Type*: [ContentPolicyConfig](./aws-properties-bedrock-guardrail-contentpolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contentpolicyconfig", "UpdateType": "Mutable", "Required": false, "Type": "ContentPolicyConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that you want to attach to the guardrail.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-bedrock-guardrail-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "AutomatedReasoningPolicyConfig": { "MarkdownDocumentation": "`AutomatedReasoningPolicyConfig`\n\nConfiguration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.\n*Required*: No\n*Type*: [AutomatedReasoningPolicyConfig](./aws-properties-bedrock-guardrail-automatedreasoningpolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-automatedreasoningpolicyconfig", "UpdateType": "Mutable", "Required": false, "Type": "AutomatedReasoningPolicyConfig" } }, "Attributes": { "FailureRecommendations": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`FailureRecommendations`\n\nAppears if the `status` of the guardrail is `FAILED`. A list of recommendations to carry out before retrying the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#FailureRecommendations-fn::getatt" }, "GuardrailId": { "PrimitiveType": "String", "MarkdownDocumentation": "`GuardrailId`\n\nThe unique identifier of the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#GuardrailId-fn::getatt" }, "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#Status-fn::getatt" }, "StatusReasons": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`StatusReasons`\n\nAppears if the `status` is `FAILED`. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#StatusReasons-fn::getatt" }, "GuardrailArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GuardrailArn`\n\nThe ARN of the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#GuardrailArn-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version of the guardrail that was created.\nThis value will always be `DRAFT`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#Version-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nTimestamp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#CreatedAt-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nTimestamp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#UpdatedAt-fn::getatt" } } }, "AWS::Bedrock::GuardrailVersion": { "MarkdownDocumentation": "`AWS::Bedrock::GuardrailVersion`\n\nCreates a version of the guardrail. Use this API to create a snapshot of the\nguardrail when you are satisfied with a configuration, or to compare the configuration with another version.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the guardrail ID and version, separated by a pipe\n(`|`) in the format (`guardrail-id|guardrail-version`).\nFor example, `{ \"Ref\": \"myGuardrailVersion\" }` would return the value\n`\"3mzzryddufkp|2\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html", "Properties": { "GuardrailIdentifier": { "MarkdownDocumentation": "`GuardrailIdentifier`\n\nThe unique identifier of the guardrail. This can be an ID or the ARN.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html#cfn-bedrock-guardrailversion-guardrailidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the guardrail version.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html#cfn-bedrock-guardrailversion-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "GuardrailId": { "PrimitiveType": "String", "MarkdownDocumentation": "`GuardrailId`\n\nThe unique identifier of the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html#GuardrailId-fn::getatt" }, "GuardrailArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GuardrailArn`\n\nThe ARN of the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html#GuardrailArn-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version of the guardrail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html#Version-fn::getatt" } } }, "AWS::Bedrock::IntelligentPromptRouter": { "MarkdownDocumentation": "`AWS::Bedrock::IntelligentPromptRouter`\n\nSpecifies an intelligent prompt router resource for Amazon Bedrock.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the intelligent prompt router information.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description of the prompt router to help identify its purpose.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z:.][ _-]?)+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#cfn-bedrock-intelligentpromptrouter-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PromptRouterName": { "MarkdownDocumentation": "`PromptRouterName`\n\nThe name of the prompt router. The name must be unique within your AWS account in the current region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][ _-]?)+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#cfn-bedrock-intelligentpromptrouter-promptroutername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FallbackModel": { "MarkdownDocumentation": "`FallbackModel`\n\nThe default model to use when the routing criteria is not met.\n*Required*: Yes\n*Type*: [PromptRouterTargetModel](./aws-properties-bedrock-intelligentpromptrouter-promptroutertargetmodel.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#cfn-bedrock-intelligentpromptrouter-fallbackmodel", "UpdateType": "Immutable", "Required": true, "Type": "PromptRouterTargetModel" }, "RoutingCriteria": { "MarkdownDocumentation": "`RoutingCriteria`\n\nRouting criteria for a prompt router.\n*Required*: Yes\n*Type*: [RoutingCriteria](./aws-properties-bedrock-intelligentpromptrouter-routingcriteria.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#cfn-bedrock-intelligentpromptrouter-routingcriteria", "UpdateType": "Immutable", "Required": true, "Type": "RoutingCriteria" }, "Models": { "MarkdownDocumentation": "`Models`\n\nA list of foundation models that the prompt router can route requests to. At least one model must be specified.\n*Required*: Yes\n*Type*: Array of [PromptRouterTargetModel](./aws-properties-bedrock-intelligentpromptrouter-promptroutertargetmodel.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#cfn-bedrock-intelligentpromptrouter-models", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "PromptRouterTargetModel", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your AWS resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-bedrock-intelligentpromptrouter-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#cfn-bedrock-intelligentpromptrouter-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe router's status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#Status-fn::getatt" }, "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nThe router's type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#Type-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nIndicates the time that the prompt router was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#CreatedAt-fn::getatt" }, "PromptRouterArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PromptRouterArn`\n\nThe Amazon Resource Name (ARN) of the prompt router.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#PromptRouterArn-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nWhen the router was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-intelligentpromptrouter.html#UpdatedAt-fn::getatt" } } }, "AWS::Bedrock::KnowledgeBase": { "MarkdownDocumentation": "`AWS::Bedrock::KnowledgeBase`\n\nSpecifies a knowledge base as a resource in a top-level template. Minimally, you must\nspecify the following properties:\n* Name \u2013 Specify a name for the knowledge base.\n* RoleArn \u2013 Specify the Amazon Resource Name (ARN) of the IAM\n role with permissions to invoke API operations on the knowledge base. For more\n information, see [Create a service role for\n Knowledge base for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-permissions.html).\n* KnowledgeBaseConfiguration \u2013 Specify the embeddings configuration of the\n knowledge base. The following sub-properties are required:\n \n + Type \u2013 Specify the value `VECTOR`.\n* StorageConfiguration \u2013 Specify information about the vector store in which the\n data source is stored. The following sub-properties are required:\n \n + Type \u2013 Specify the vector store service that you are using.\n ###### Note\n \n Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation.\nFor more information about using knowledge bases in Amazon Bedrock, see [Knowledge\nbase for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the knowledge base ID.\nFor example, `{ \"Ref\": \"myKnowledgeBase\" }` could return the value\n`\"KB12345678\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the knowledge base associated with the inline agent.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KnowledgeBaseConfiguration": { "MarkdownDocumentation": "`KnowledgeBaseConfiguration`\n\nContains details about the embeddings configuration of the knowledge base.\n*Required*: Yes\n*Type*: [KnowledgeBaseConfiguration](./aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "KnowledgeBaseConfiguration" }, "StorageConfiguration": { "MarkdownDocumentation": "`StorageConfiguration`\n\nContains details about the storage configuration of the knowledge base.\n*Required*: No\n*Type*: [StorageConfiguration](./aws-properties-bedrock-knowledgebase-storageconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-storageconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "StorageConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that you can assign to a resource as key-value pairs. For more information,\nsee the following resources:\n* [Tag naming\n limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)\n* [Tagging\n best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the knowledge base.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the knowledge base.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#Status-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time the knowledge base was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#CreatedAt-fn::getatt" }, "KnowledgeBaseArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`KnowledgeBaseArn`\n\nThe Amazon Resource Name (ARN) of the knowledge base.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#KnowledgeBaseArn-fn::getatt" }, "KnowledgeBaseId": { "PrimitiveType": "String", "MarkdownDocumentation": "`KnowledgeBaseId`\n\nThe unique identifier for a knowledge base associated with the inline agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#KnowledgeBaseId-fn::getatt" }, "FailureReasons": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`FailureReasons`\n\nA list of reasons that the API operation on the knowledge base failed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#FailureReasons-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time the knowledge base was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#UpdatedAt-fn::getatt" } } }, "AWS::Bedrock::Prompt": { "MarkdownDocumentation": "`AWS::Bedrock::Prompt`\n\nCreates a prompt in your prompt library that you can add to a flow. For more information, see [Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and [Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the prompt.\nFor example, `{ \"Ref\": \"myPrompt\" }` could return the value\n`\"arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html", "Properties": { "Variants": { "MarkdownDocumentation": "`Variants`\n\nA list of objects, each containing details about a variant of the prompt.\n*Required*: No\n*Type*: Array of [PromptVariant](./aws-properties-bedrock-prompt-promptvariant.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-variants", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PromptVariant", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the prompt.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomerEncryptionKeyArn": { "MarkdownDocumentation": "`CustomerEncryptionKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-customerencryptionkeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultVariant": { "MarkdownDocumentation": "`DefaultVariant`\n\nThe name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-defaultvariant", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that you can assign to a resource as key-value pairs. For more information,\nsee the following resources:\n* [Tag naming\n limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)\n* [Tagging\n best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the prompt.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version of the prompt that this summary applies to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#Version-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the prompt was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#Arn-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the prompt was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#UpdatedAt-fn::getatt" } } }, "AWS::Bedrock::PromptVersion": { "MarkdownDocumentation": "`AWS::Bedrock::PromptVersion`\n\nCreates a static snapshot of your prompt that can be deployed to production. For more information, see [Deploy prompts using Prompt management by creating versions](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html) in the Amazon Bedrock User Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the prompt\nversion.\nFor example, `{ \"Ref\": \"myPromptVersion\" }` could return the value\n`\"\"arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345:1\"`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the prompt version.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PromptArn": { "MarkdownDocumentation": "`PromptArn`\n\nThe Amazon Resource Name (ARN) of the version of the prompt.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-promptarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA map of tags attached to the prompt version and their values.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Variants": { "Type": "List", "ItemType": "PromptVariant", "MarkdownDocumentation": "`Variants`\n\nA list of objects, each containing details about a variant of the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#Variants-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version of the prompt that this summary applies to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#Version-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the prompt was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#CreatedAt-fn::getatt" }, "CustomerEncryptionKeyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CustomerEncryptionKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key that the prompt version is encrypted\nwith.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#CustomerEncryptionKeyArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#Arn-fn::getatt" }, "DefaultVariant": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefaultVariant`\n\nThe name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#DefaultVariant-fn::getatt" }, "PromptId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PromptId`\n\nThe unique identifier of the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#PromptId-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the prompt was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#UpdatedAt-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the prompt.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#Name-fn::getatt" } } }, "AWS::BedrockAgentCore::BrowserCustom": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::BrowserCustom`\n\nAgentCore Browser tool provides a fast, secure, cloud-based browser runtime to enable\nAI agents to interact with websites at scale.\nFor more information about using the custom browser, see [Interact with web\napplications using Amazon Bedrock AgentCore Browser](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/browser-tool.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html", "Properties": { "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the execution role.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[a-z]+)*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-executionrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe custom browser.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RecordingConfig": { "MarkdownDocumentation": "`RecordingConfig`\n\nTHe custom browser configuration.\n*Required*: No\n*Type*: [RecordingConfig](./aws-properties-bedrockagentcore-browsercustom-recordingconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-recordingconfig", "UpdateType": "Immutable", "Required": false, "Type": "RecordingConfig" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for a code interpreter. This structure defines how the code\ninterpreter connects to the network.\n*Required*: Yes\n*Type*: [BrowserNetworkConfiguration](./aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-networkconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "BrowserNetworkConfiguration" }, "BrowserSigning": { "MarkdownDocumentation": "`BrowserSigning`\n\nProperty description not available.\n*Required*: No\n*Type*: [BrowserSigning](./aws-properties-bedrockagentcore-browsercustom-browsersigning.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-browsersigning", "UpdateType": "Immutable", "Required": false, "Type": "BrowserSigning" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the custom browser.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the custom browser.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the custom browser.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#Status-fn::getatt" }, "BrowserId": { "PrimitiveType": "String", "MarkdownDocumentation": "`BrowserId`\n\nThe ID for the custom browser.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#BrowserId-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe time at which the custom browser was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#LastUpdatedAt-fn::getatt" }, "BrowserArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`BrowserArn`\n\nThe ARN for the custom browser.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#BrowserArn-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the custom browser was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#CreatedAt-fn::getatt" }, "FailureReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`FailureReason`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#FailureReason-fn::getatt" } } }, "AWS::BedrockAgentCore::CodeInterpreterCustom": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::CodeInterpreterCustom`\n\nThe AgentCore Code Interpreter tool enables agents to securely execute code in\nisolated sandbox environments. It offers advanced configuration support and seamless\nintegration with popular frameworks.\nFor more information about using the custom code interpreter, see [Execute code and\nanalyze data using Amazon Bedrock AgentCore Code Interpreter](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/code-interpreter-tool.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html", "Properties": { "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the execution role.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[a-z]+)*: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-executionrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe code interpreter description.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for a code interpreter. This structure defines how the code\ninterpreter connects to the network.\n*Required*: Yes\n*Type*: [CodeInterpreterNetworkConfiguration](./aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-networkconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "CodeInterpreterNetworkConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the code interpreter.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the code interpreter.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the custom code interpreter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#Status-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe time at which the code interpreter was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#LastUpdatedAt-fn::getatt" }, "FailureReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`FailureReason`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#FailureReason-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the code interpreter was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#CreatedAt-fn::getatt" }, "CodeInterpreterArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CodeInterpreterArn`\n\nThe code interpreter Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#CodeInterpreterArn-fn::getatt" }, "CodeInterpreterId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CodeInterpreterId`\n\nThe ID of the code interpreter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#CodeInterpreterId-fn::getatt" } } }, "AWS::BedrockAgentCore::Gateway": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Gateway`\n\nAmazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.\nFor more information about creating a gateway, see [Set up an Amazon Bedrock AgentCore gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html", "Properties": { "ProtocolConfiguration": { "MarkdownDocumentation": "`ProtocolConfiguration`\n\nThe protocol configuration for the gateway target.\n*Required*: No\n*Type*: [GatewayProtocolConfiguration](./aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocolconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "GatewayProtocolConfiguration" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the gateway.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExceptionLevel": { "MarkdownDocumentation": "`ExceptionLevel`\n\nThe exception level for the gateway.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEBUG`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "DEBUG" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-exceptionlevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe KMS key ARN for the gateway.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthorizerType": { "MarkdownDocumentation": "`AuthorizerType`\n\nThe authorizer type for the gateway.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CUSTOM_JWT | AWS_IAM | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CUSTOM_JWT", "AWS_IAM", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProtocolType": { "MarkdownDocumentation": "`ProtocolType`\n\nThe protocol type for the gateway target.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MCP`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "MCP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocoltype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InterceptorConfigurations": { "MarkdownDocumentation": "`InterceptorConfigurations`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [GatewayInterceptorConfiguration](./aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-interceptorconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GatewayInterceptorConfiguration", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the gateway.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the gateway.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AuthorizerConfiguration": { "MarkdownDocumentation": "`AuthorizerConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [AuthorizerConfiguration](./aws-properties-bedrockagentcore-gateway-authorizerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AuthorizerConfiguration" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status for the gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#Status-fn::getatt" }, "GatewayArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GatewayArn`\n\nThe ARN for the gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#GatewayArn-fn::getatt" }, "GatewayUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`GatewayUrl`\n\nThe gateway URL for the gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#GatewayUrl-fn::getatt" }, "StatusReasons": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`StatusReasons`\n\nThe status reasons for the gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#StatusReasons-fn::getatt" }, "GatewayIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`GatewayIdentifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#GatewayIdentifier-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time at which the gateway was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#CreatedAt-fn::getatt" }, "WorkloadIdentityDetails.WorkloadIdentityArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#WorkloadIdentityDetails.WorkloadIdentityArn-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#UpdatedAt-fn::getatt" }, "WorkloadIdentityDetails": { "Type": "WorkloadIdentityDetails", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#WorkloadIdentityDetails-fn::getatt" } } }, "AWS::BedrockAgentCore::GatewayTarget": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::GatewayTarget`\n\nAfter creating a gateway, you can add targets, which define the tools that your\ngateway will host.\nFor more information about adding gateway targets, see [Add\ntargets to an existing gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building-adding-targets.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the gateway target.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetConfiguration": { "MarkdownDocumentation": "`TargetConfiguration`\n\nThe target configuration for the Smithy model target.\n*Required*: Yes\n*Type*: [TargetConfiguration](./aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "TargetConfiguration" }, "GatewayIdentifier": { "MarkdownDocumentation": "`GatewayIdentifier`\n\nThe gateway ID for the gateway target.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-gatewayidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CredentialProviderConfigurations": { "MarkdownDocumentation": "`CredentialProviderConfigurations`\n\nThe OAuth credential provider configuration.\n*Required*: Yes\n*Type*: Array of [CredentialProviderConfiguration](./aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CredentialProviderConfiguration", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the gateway target.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([0-9a-zA-Z][-]?){1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GatewayArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GatewayArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#GatewayArn-fn::getatt" }, "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#Status-fn::getatt" }, "StatusReasons": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`StatusReasons`\n\nThe status reasons for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#StatusReasons-fn::getatt" }, "LastSynchronizedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastSynchronizedAt`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#LastSynchronizedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time at which the gateway target was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#CreatedAt-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe time at which the resource was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#UpdatedAt-fn::getatt" }, "TargetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TargetId`\n\nThe target ID for the gateway target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#TargetId-fn::getatt" } } }, "AWS::BedrockAgentCore::Memory": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Memory`\n\nMemory allows AI agents to maintain both immediate and long-term knowledge, enabling context-aware and personalized interactions.\nFor more information about using Memory in Amazon Bedrock AgentCore, see [Host agent or\ntools with Amazon Bedrock AgentCore Memory](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-getting-started.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nThe memory encryption key Amazon Resource Name (ARN).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-encryptionkeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MemoryExecutionRoleArn": { "MarkdownDocumentation": "`MemoryExecutionRoleArn`\n\nThe memory role ARN.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-memoryexecutionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MemoryStrategies": { "MarkdownDocumentation": "`MemoryStrategies`\n\nThe memory strategies.\n*Required*: No\n*Type*: Array of [MemoryStrategy](./aws-properties-bedrockagentcore-memory-memorystrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-memorystrategies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MemoryStrategy", "DuplicatesAllowed": true }, "EventExpiryDuration": { "MarkdownDocumentation": "`EventExpiryDuration`\n\nThe event expiry configuration.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `7`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-eventexpiryduration", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the resources.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe memory name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe memory status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#Status-fn::getatt" }, "MemoryArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MemoryArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#MemoryArn-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the memory record was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#CreatedAt-fn::getatt" }, "FailureReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`FailureReason`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#FailureReason-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#UpdatedAt-fn::getatt" }, "MemoryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`MemoryId`\n\nThe memory ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#MemoryId-fn::getatt" } } }, "AWS::BedrockAgentCore::Runtime": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::Runtime`\n\nContains information about an agent runtime. An agent runtime is the execution\nenvironment for a Amazon Bedrock Agent.\nAgentCore Runtime is a secure, serverless runtime purpose-built for deploying and\nscaling dynamic AI agents and tools using any open-source framework including LangGraph,\nCrewAI, and Strands Agents, any protocol, and any model.\nFor more information about using agent runtime in Amazon Bedrock AgentCore, see [Host agent or\ntools with Amazon Bedrock AgentCore Runtime](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/agents-tools-runtime.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html", "Properties": { "ProtocolConfiguration": { "MarkdownDocumentation": "`ProtocolConfiguration`\n\nThe protocol configuration for an agent runtime. This structure defines how the agent\nruntime communicates with clients.\n*Required*: No\n*Type*: String\n*Allowed values*: `MCP | HTTP | A2A...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MCP", "HTTP", "A2A" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-protocolconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe agent runtime description.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `1200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentVariables": { "MarkdownDocumentation": "`EnvironmentVariables`\n\nThe environment variables for the agent.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z_][a-zA-Z0-9_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-environmentvariables", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "RequestHeaderConfiguration": { "MarkdownDocumentation": "`RequestHeaderConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [RequestHeaderConfiguration](./aws-properties-bedrockagentcore-runtime-requestheaderconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-requestheaderconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RequestHeaderConfiguration" }, "LifecycleConfiguration": { "MarkdownDocumentation": "`LifecycleConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [LifecycleConfiguration](./aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-lifecycleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LifecycleConfiguration" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration.\n*Required*: Yes\n*Type*: [NetworkConfiguration](./aws-properties-bedrockagentcore-runtime-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-networkconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "NetworkConfiguration" }, "AgentRuntimeName": { "MarkdownDocumentation": "`AgentRuntimeName`\n\nThe name of the AgentCore Runtime endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z][a-zA-Z0-9_]{0,47}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-agentruntimename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AgentRuntimeArtifact": { "MarkdownDocumentation": "`AgentRuntimeArtifact`\n\nThe artifact of the agent.\n*Required*: Yes\n*Type*: [AgentRuntimeArtifact](./aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-agentruntimeartifact", "UpdateType": "Mutable", "Required": true, "Type": "AgentRuntimeArtifact" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) for for the role.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws(-[^:]+)?: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the agent.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "AuthorizerConfiguration": { "MarkdownDocumentation": "`AuthorizerConfiguration`\n\nRepresents inbound authorization configuration options used to authenticate incoming\nrequests.\n*Required*: No\n*Type*: [AuthorizerConfiguration](./aws-properties-bedrockagentcore-runtime-authorizerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-authorizerconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AuthorizerConfiguration" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status for the agent runtime.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#Status-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe time at which the runtime was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#LastUpdatedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the runtime was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#CreatedAt-fn::getatt" }, "AgentRuntimeId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentRuntimeId`\n\nThe ID for the agent runtime.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#AgentRuntimeId-fn::getatt" }, "FailureReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`FailureReason`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#FailureReason-fn::getatt" }, "WorkloadIdentityDetails.WorkloadIdentityArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#WorkloadIdentityDetails.WorkloadIdentityArn-fn::getatt" }, "AgentRuntimeVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentRuntimeVersion`\n\nThe version for the agent runtime.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#AgentRuntimeVersion-fn::getatt" }, "AgentRuntimeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentRuntimeArn`\n\nThe agent runtime ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#AgentRuntimeArn-fn::getatt" }, "WorkloadIdentityDetails": { "Type": "WorkloadIdentityDetails", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#WorkloadIdentityDetails-fn::getatt" } } }, "AWS::BedrockAgentCore::RuntimeEndpoint": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::RuntimeEndpoint`\n\nAgentCore Runtime is a secure, serverless runtime purpose-built for deploying and\nscaling dynamic AI agents and tools using any open-source framework including LangGraph,\nCrewAI, and Strands Agents, any protocol, and any model.\nFor more information about using agent runtime endpoints in Amazon Bedrock AgentCore,\nsee [AgentCore\nRuntime versioning and endpoints](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/agent-runtime-versioning.html).\nSee the **Properties** section below for descriptions of\nboth the required and optional properties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nContains information about an agent runtime endpoint. An agent runtime is the\nexecution environment for a Amazon Bedrock Agent.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AgentRuntimeId": { "MarkdownDocumentation": "`AgentRuntimeId`\n\nThe agent runtime ID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-agentruntimeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AgentRuntimeVersion": { "MarkdownDocumentation": "`AgentRuntimeVersion`\n\nThe version of the agent.\n*Required*: No\n*Type*: String\n*Pattern*: `^([1-9][0-9]{0,4})$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-agentruntimeversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the AgentCore Runtime endpoint.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9\\s._:/=+@-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the AgentCore Runtime endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,47}$`\n*Minimum*: `1`\n*Maximum*: `48`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "TargetVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`TargetVersion`\n\nThe target version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#TargetVersion-fn::getatt" }, "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the runtime endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#Status-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe time at which the endpoint was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#LastUpdatedAt-fn::getatt" }, "AgentRuntimeEndpointArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentRuntimeEndpointArn`\n\nThe endpoint Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#AgentRuntimeEndpointArn-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time at which the endpoint was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#CreatedAt-fn::getatt" }, "FailureReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`FailureReason`\n\nThe reason for failure if the memory is in a failed state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#FailureReason-fn::getatt" }, "LiveVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`LiveVersion`\n\nThe live version for the runtime endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#LiveVersion-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the runtime endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#Id-fn::getatt" }, "AgentRuntimeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentRuntimeArn`\n\nThe Amazon Resource Name (ARN) of the runtime agent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#AgentRuntimeArn-fn::getatt" } } }, "AWS::BedrockAgentCore::WorkloadIdentity": { "MarkdownDocumentation": "`AWS::BedrockAgentCore::WorkloadIdentity`\n\nCreates a workload identity for Amazon Bedrock AgentCore. A workload identity provides OAuth2-based authentication for resources associated with agent runtimes.\nFor more information about using workload identities in Amazon Bedrock AgentCore, see [Managing workload identities](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/workload-identity.html).\nSee the **Properties** section below for descriptions of both the required and optional properties.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the workload identity name.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html", "Properties": { "AllowedResourceOauth2ReturnUrls": { "MarkdownDocumentation": "`AllowedResourceOauth2ReturnUrls`\n\nThe list of allowed OAuth2 return URLs for resources associated with this workload identity.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#cfn-bedrockagentcore-workloadidentity-allowedresourceoauth2returnurls", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the workload identity.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-bedrockagentcore-workloadidentity-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#cfn-bedrockagentcore-workloadidentity-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the workload identity. The name must be unique within your account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9_.-]+`\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#cfn-bedrockagentcore-workloadidentity-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "Double", "MarkdownDocumentation": "`CreatedTime`\n\nThe timestamp when the workload identity was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#CreatedTime-fn::getatt" }, "WorkloadIdentityArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`WorkloadIdentityArn`\n\nThe Amazon Resource Name (ARN) of the workload identity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#WorkloadIdentityArn-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "Double", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe timestamp when the workload identity was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#LastUpdatedTime-fn::getatt" } } }, "AWS::Budgets::Budget": { "MarkdownDocumentation": "`AWS::Budgets::Budget`\n\nThe `AWS::Budgets::Budget` resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded. creates, replaces, or deletes budgets for Billing and Cost Management.\nFor more information, see\n[Managing Your Costs with Budgets](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html)\nin the *AWS Billing and Cost Management User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the budget that is created by the template.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html", "Properties": { "NotificationsWithSubscribers": { "Type": "List", "Required": false, "MarkdownDocumentation": "`NotificationsWithSubscribers`\n\nA 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*: Array of [NotificationWithSubscribers](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-notificationswithsubscribers", "ItemType": "NotificationWithSubscribers", "UpdateType": "Immutable" }, "ResourceTags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ResourceTags`\n\nAn optional list of tags to associate with the specified budget. Each tag consists of a\nkey and a value, and each key must be unique for the resource.\n*Required*: No\n*Type*: Array of [ResourceTag](./aws-properties-budgets-budget-resourcetag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-resourcetags", "ItemType": "ResourceTag", "UpdateType": "Mutable" }, "Budget": { "Type": "BudgetData", "Required": true, "MarkdownDocumentation": "`Budget`\n\nThe budget object that you want to create.\n*Required*: Yes\n*Type*: [BudgetData](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-budget", "UpdateType": "Mutable" } } }, "AWS::Budgets::BudgetsAction": { "MarkdownDocumentation": "`AWS::Budgets::BudgetsAction`\n\nThe `AWS::Budgets::BudgetsAction` resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded.\nFor more information, see [Managing Your Costs with Budgets](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html)\nin the *AWS Billing and Cost Management User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html", "Properties": { "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe role passed for action execution and reversion. Roles and actions must be in the same account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-cn|-us-gov|-iso|-iso-[a-z]{1})?:iam::\\d{12}:role(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$`\n*Minimum*: `32`\n*Maximum*: `618`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-executionrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionType": { "MarkdownDocumentation": "`ActionType`\n\nThe type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `APPLY_IAM_POLICY | APPLY_SC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-actiontype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nAn optional list of tags to associate with the specified budget action. Each tag\nconsists of a key and a value, and each key must be unique for the resource.\n*Required*: No\n*Type*: Array of [ResourceTag](./aws-properties-budgets-budgetsaction-resourcetag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceTag", "DuplicatesAllowed": true }, "NotificationType": { "MarkdownDocumentation": "`NotificationType`\n\nThe type of a notification.\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)", "RefReturnValue": "", "AllowedValues": [ "ACTUAL", "FORECASTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-notificationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ActionThreshold": { "MarkdownDocumentation": "`ActionThreshold`\n\nThe trigger threshold of the action.\n*Required*: Yes\n*Type*: [ActionThreshold](./aws-properties-budgets-budgetsaction-actionthreshold.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-actionthreshold", "UpdateType": "Mutable", "Required": true, "Type": "ActionThreshold" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nSpecifies all of the type-specific parameters.\n*Required*: Yes\n*Type*: [Definition](./aws-properties-budgets-budgetsaction-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-definition", "UpdateType": "Mutable", "Required": true, "Type": "Definition" }, "ApprovalModel": { "MarkdownDocumentation": "`ApprovalModel`\n\nThis specifies if the action needs manual or automatic approval.\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)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-approvalmodel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Subscribers": { "MarkdownDocumentation": "`Subscribers`\n\nA list of subscribers.\n*Required*: Yes\n*Type*: Array of [Subscriber](./aws-properties-budgets-budgetsaction-subscriber.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-subscribers", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Subscriber", "DuplicatesAllowed": true }, "BudgetName": { "MarkdownDocumentation": "`BudgetName`\n\nA string that represents the budget name. \":\" and \"\\\" characters aren't allowed.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#cfn-budgets-budgetsaction-budgetname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ActionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ActionId`\n\nA system-generated universally unique identifier (UUID) for the action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budgetsaction.html#ActionId-fn::getatt" } } }, "AWS::CE::AnomalyMonitor": { "MarkdownDocumentation": "`AWS::CE::AnomalyMonitor`\n\nThe `AWS::CE::AnomalyMonitor` resource is a Cost Explorer resource type that\ncontinuously inspects your account's cost data for anomalies, based on\n`MonitorType` and `MonitorSpecification`. The content consists of\ndetailed metadata and the current status of the monitor object.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`MonitorArn`. For example:\n`{ \"Ref\": \"myAnomalySubscriptionLogicalName\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html", "Properties": { "MonitorType": { "MarkdownDocumentation": "`MonitorType`\n\nThe type of the monitor.\nSet this to `DIMENSIONAL` for an AWS managed monitor.\nAWS managed monitors automatically track up to the top 5,000 values by\ncost within a dimension of your choosing. Each dimension value is evaluated\nindependently. If you start incurring cost in a new value of your chosen dimension, it\nwill automatically be analyzed by an AWS managed monitor.\nSet this to `CUSTOM` for a customer managed monitor. Customer managed\nmonitors let you select specific dimension values that get monitored in aggregate.\nFor more information about monitor types, see [Monitor\ntypes](https://docs.aws.amazon.com/cost-management/latest/userguide/getting-started-ad.html#monitor-type-def) in the *Billing and Cost Management User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DIMENSIONAL | CUSTOM...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DIMENSIONAL", "CUSTOM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#cfn-ce-anomalymonitor-monitortype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [ResourceTag](./aws-properties-ce-anomalymonitor-resourcetag.html)\n*Minimum*: `0`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#cfn-ce-anomalymonitor-resourcetags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ResourceTag", "DuplicatesAllowed": true }, "MonitorName": { "MarkdownDocumentation": "`MonitorName`\n\nThe name of the monitor.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\S\\s]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#cfn-ce-anomalymonitor-monitorname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MonitorSpecification": { "MarkdownDocumentation": "`MonitorSpecification`\n\nThe array of `MonitorSpecification` in JSON array format. For instance, you can\nuse `MonitorSpecification` to specify a tag, Cost Category, or linked account for\nyour 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#cfn-ce-anomalymonitor-monitorspecification", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MonitorDimension": { "MarkdownDocumentation": "`MonitorDimension`\n\nFor customer managed monitors, do not specify this field.\nFor AWS managed monitors, this field controls which cost dimension is\nautomatically analyzed by the monitor. For `TAG` and `COST_CATEGORY` dimensions, you must also specify MonitorSpecification to configure the specific\ntag or cost category key to analyze.\n*Required*: No\n*Type*: String\n*Allowed values*: `SERVICE | LINKED_ACCOUNT | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SERVICE", "LINKED_ACCOUNT", "TAG", "COST_CATEGORY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#cfn-ce-anomalymonitor-monitordimension", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "LastUpdatedDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedDate`\n\nThe date when the monitor was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#LastUpdatedDate-fn::getatt" }, "CreationDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationDate`\n\nThe date when the monitor was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#CreationDate-fn::getatt" }, "LastEvaluatedDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastEvaluatedDate`\n\nThe date when the monitor last evaluated for anomalies.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#LastEvaluatedDate-fn::getatt" }, "MonitorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MonitorArn`\n\nThe Amazon Resource Name (ARN) value for the monitor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#MonitorArn-fn::getatt" }, "DimensionalValueCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`DimensionalValueCount`\n\nThe value for evaluated dimensions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#DimensionalValueCount-fn::getatt" } } }, "AWS::CE::AnomalySubscription": { "MarkdownDocumentation": "`AWS::CE::AnomalySubscription`\n\nThe `AWS::CE::AnomalySubscription` resource (also referred to as an alert\nsubscription) is a Cost Explorer resource type that sends notifications about specific\nanomalies that meet an alerting criteria defined by you.\nYou can specify the frequency of the alerts and the subscribers to notify.\nAnomaly subscriptions can be associated with one or more [`AWS::CE::AnomalyMonitor`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html) resources, and they only send notifications\nabout anomalies detected by those associated monitors. You can also configure a threshold to\nfurther control which anomalies are included in the notifications.\nAnomalies that don\u2019t exceed the chosen threshold and therefore don\u2019t trigger notifications\nfrom an anomaly subscription will still be available on the console and from the [`GetAnomalies`](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetAnomalies.html) API.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`SubscriptionArn`. For example:\n`{ \"Ref\": \"myAnomalyMonitorLogicalName\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html", "Properties": { "MonitorArnList": { "MarkdownDocumentation": "`MonitorArnList`\n\nA list of cost anomaly monitors.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#cfn-ce-anomalysubscription-monitorarnlist", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [ResourceTag](./aws-properties-ce-anomalysubscription-resourcetag.html)\n*Minimum*: `0`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#cfn-ce-anomalysubscription-resourcetags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ResourceTag", "DuplicatesAllowed": true }, "Frequency": { "MarkdownDocumentation": "`Frequency`\n\nThe frequency that anomaly notifications are sent. Notifications are sent either over\nemail (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more\ninformation, see [Creating an Amazon SNS topic for\nanomaly 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)", "RefReturnValue": "", "AllowedValues": [ "DAILY", "IMMEDIATE", "WEEKLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#cfn-ce-anomalysubscription-frequency", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubscriptionName": { "MarkdownDocumentation": "`SubscriptionName`\n\nThe name for the subscription.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\S\\s]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#cfn-ce-anomalysubscription-subscriptionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Subscribers": { "MarkdownDocumentation": "`Subscribers`\n\nA list of subscribers to notify.\n*Required*: Yes\n*Type*: Array of [Subscriber](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#cfn-ce-anomalysubscription-subscribers", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Subscriber", "DuplicatesAllowed": true }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\n(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\nuse of Threshold will be treated as shorthand syntax for a ThresholdExpression.\nOne of Threshold or ThresholdExpression is required for\n`AWS::CE::AnomalySubscription`. You cannot specify both.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#cfn-ce-anomalysubscription-threshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "ThresholdExpression": { "MarkdownDocumentation": "`ThresholdExpression`\n\nAn [Expression](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) object\nin JSON string format used to specify the anomalies that you want to generate alerts for. This\nsupports dimensions and nested expressions. The supported dimensions are\n`ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE`,\ncorresponding 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\n`AND` and `OR`. The match option `GREATER_THAN_OR_EQUAL` is\nrequired. Values must be numbers between 0 and 10,000,000,000 in string format.\nOne of Threshold or ThresholdExpression is required for\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#cfn-ce-anomalysubscription-thresholdexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nYour unique account identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#AccountId-fn::getatt" }, "SubscriptionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SubscriptionArn`\n\nThe `AnomalySubscription` Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#SubscriptionArn-fn::getatt" } } }, "AWS::CE::CostCategory": { "MarkdownDocumentation": "`AWS::CE::CostCategory`\n\nThe `AWS::CE::CostCategory` resource creates groupings of cost that you can use\nacross products in the AWS Billing and Cost Management console, such as Cost Explorer and AWS Budgets. For more information, see [Managing Your Costs with\nCost Categories](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html) in the *AWS Billing and Cost Management User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Arn of the Cost Category that is created by the\ntemplate.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe default value for the cost category.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#cfn-ce-costcategory-defaultvalue", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SplitChargeRules": { "MarkdownDocumentation": "`SplitChargeRules`\n\nThe split charge rules that are used to allocate your charges between your cost category values.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#cfn-ce-costcategory-splitchargerules", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleVersion": { "MarkdownDocumentation": "`RuleVersion`\n\nThe rule schema version in this particular Cost Category.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CostCategoryExpression.v1...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CostCategoryExpression.v1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#cfn-ce-costcategory-ruleversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe array of CostCategoryRule in JSON array format.\n###### Note\nRules are processed in order. If there are multiple rules that match the line item, then\nthe first rule to match is used to determine that Cost Category value.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#cfn-ce-costcategory-rules", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [ResourceTag](./aws-properties-ce-costcategory-resourcetag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#cfn-ce-costcategory-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceTag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe unique name of the Cost Category.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#cfn-ce-costcategory-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "EffectiveStart": { "PrimitiveType": "String", "MarkdownDocumentation": "`EffectiveStart`\n\nThe Cost Category's effective start date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#EffectiveStart-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique identifier for your Cost Category.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#Arn-fn::getatt" } } }, "AWS::Cassandra::Keyspace": { "MarkdownDocumentation": "`AWS::Cassandra::Keyspace`\n\nYou can use the `AWS::Cassandra::Keyspace` resource to create a new keyspace\nin Amazon Keyspaces (for Apache Cassandra). For more information, see [Create a\nkeyspace](https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.keyspaces.html) in the *Amazon Keyspaces\nDeveloper Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the keyspace. For example:\n`{ \"Ref\": \"MyNewKeyspace\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-keyspace.html", "Properties": { "ClientSideTimestampsEnabled": { "MarkdownDocumentation": "`ClientSideTimestampsEnabled`\n\nIndicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace.\nTo add a Region to a single-Region keyspace with at least one table, the value must be set to true.\nAfter you've enabled client-side timestamps for a table, you can\u2019t disable it again.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-keyspace.html#cfn-cassandra-keyspace-clientsidetimestampsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyspaceName": { "MarkdownDocumentation": "`KeyspaceName`\n\nThe name of the keyspace to be created. The keyspace name is case sensitive. If you don't specify a name, AWS\nCloudFormation generates a unique ID and uses that ID for the keyspace name. For more\ninformation, see [Name\ntype](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n*Length constraints:* Minimum length of 1. Maximum length of 48.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-keyspace.html#cfn-cassandra-keyspace-keyspacename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ReplicationSpecification": { "MarkdownDocumentation": "`ReplicationSpecification`\n\nSpecifies the `ReplicationStrategy`\nof a keyspace. The options are:\n* `SINGLE_REGION` for a single Region keyspace (optional) or\n* `MULTI_REGION` for a multi-Region keyspace\nIf no `ReplicationStrategy` is provided, the default is `SINGLE_REGION`. If you choose `MULTI_REGION`,\nyou must also provide a `RegionList` with the AWS Regions that the keyspace is replicated in.\n*Required*: No\n*Type*: [ReplicationSpecification](./aws-properties-cassandra-keyspace-replicationspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-keyspace.html#cfn-cassandra-keyspace-replicationspecification", "UpdateType": "Mutable", "Required": false, "Type": "ReplicationSpecification" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-cassandra-keyspace-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-keyspace.html#cfn-cassandra-keyspace-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } } }, "AWS::Cassandra::Table": { "MarkdownDocumentation": "`AWS::Cassandra::Table`\n\nYou can use the `AWS::Cassandra::Table` resource to create a new table in\nAmazon Keyspaces (for Apache Cassandra). For more information, see [Create a table](https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.tables.html) in the *Amazon Keyspaces Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the table and the keyspace where the table exists (delimited by '|'). For example:\n`{ \"Ref\": \"myKeyspace|myTable\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html", "Properties": { "ReplicaSpecifications": { "MarkdownDocumentation": "`ReplicaSpecifications`\n\nThe AWS Region specific settings of a multi-Region table.\nFor a multi-Region table, you can configure the table's read capacity differently per AWS Region. You can do this by configuring the following parameters.\n* `region`: The Region where these settings are applied. (Required)\n* `readCapacityUnits`: The provisioned read capacity units. (Optional)\n* `readCapacityAutoScaling`: The read capacity auto scaling settings for the table. (Optional)\n*Required*: No\n*Type*: Array of [ReplicaSpecification](./aws-properties-cassandra-table-replicaspecification.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-replicaspecifications", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ReplicaSpecification", "DuplicatesAllowed": false }, "ClusteringKeyColumns": { "MarkdownDocumentation": "`ClusteringKeyColumns`\n\nOne or more columns that determine how the table data is sorted.\n*Required*: No\n*Type*: Array of [ClusteringKeyColumn](./aws-properties-cassandra-table-clusteringkeycolumn.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-clusteringkeycolumns", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ClusteringKeyColumn", "DuplicatesAllowed": false }, "WarmThroughput": { "MarkdownDocumentation": "`WarmThroughput`\n\nProperty description not available.\n*Required*: No\n*Type*: [WarmThroughput](./aws-properties-cassandra-table-warmthroughput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-warmthroughput", "UpdateType": "Mutable", "Required": false, "Type": "WarmThroughput" }, "KeyspaceName": { "MarkdownDocumentation": "`KeyspaceName`\n\nThe name of the keyspace to create the table in. The keyspace must already\nexist.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-keyspacename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EncryptionSpecification": { "MarkdownDocumentation": "`EncryptionSpecification`\n\nThe encryption at rest options for the table.\n* **AWS owned key** (default) - The key is owned by Amazon Keyspaces.\n* **Customer managed key** - The key is stored in your account and is created, owned, and\n managed by you.\n \n ###### Note\n \n If you choose encryption with a customer managed key, you must specify\n a valid customer managed KMS key with permissions granted to Amazon\n Keyspaces.\nFor more information,\nsee [Encryption at rest in Amazon Keyspaces](https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html)\nin the *Amazon Keyspaces Developer Guide*.\n*Required*: No\n*Type*: [EncryptionSpecification](./aws-properties-cassandra-table-encryptionspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-encryptionspecification", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionSpecification" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the table to be created. The table name is case sensitive. If you don't specify a name, AWS CloudFormation\ngenerates a unique ID and uses that ID for the table name. For more information, see\n[Name\ntype](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n###### Important\nIf you specify a name, you can't perform updates that require replacing this\nresource. You can perform updates that require no interruption or some interruption. If you must\nreplace the resource, specify a new name.\n*Length constraints:* Minimum length of 3. Maximum length of\n255.\n*Pattern:*\n`^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$`\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-tablename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PointInTimeRecoveryEnabled": { "MarkdownDocumentation": "`PointInTimeRecoveryEnabled`\n\nSpecifies if point-in-time recovery is enabled or disabled for the table. The options are `PointInTimeRecoveryEnabled=true` and\n`PointInTimeRecoveryEnabled=false`.\nIf not specified, the default is `PointInTimeRecoveryEnabled=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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-pointintimerecoveryenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CdcSpecification": { "MarkdownDocumentation": "`CdcSpecification`\n\nThe settings for the CDC stream of a table. For more information about CDC streams, see [Working with change data capture (CDC) streams in Amazon Keyspaces](https://docs.aws.amazon.com/keyspaces/latest/devguide/cdc.html) in the *Amazon Keyspaces Developer\nGuide*.\n*Required*: No\n*Type*: [CdcSpecification](./aws-properties-cassandra-table-cdcspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-cdcspecification", "UpdateType": "Mutable", "Required": false, "Type": "CdcSpecification" }, "AutoScalingSpecifications": { "MarkdownDocumentation": "`AutoScalingSpecifications`\n\nThe optional auto scaling capacity settings for a table in provisioned capacity mode.\n*Required*: No\n*Type*: [AutoScalingSpecification](./aws-properties-cassandra-table-autoscalingspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-autoscalingspecifications", "UpdateType": "Mutable", "Required": false, "Type": "AutoScalingSpecification" }, "ClientSideTimestampsEnabled": { "MarkdownDocumentation": "`ClientSideTimestampsEnabled`\n\nEnables client-side timestamps for the table. By default, the setting is disabled.\nYou can enable client-side timestamps with the following option:\n* `status: \"enabled\"`\nAfter client-side timestamps are enabled for a table, you can't disable this setting.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-clientsidetimestampsenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "PartitionKeyColumns": { "MarkdownDocumentation": "`PartitionKeyColumns`\n\nOne or more columns that uniquely identify every row in the table. Every table must\nhave a partition key.\n*Required*: Yes\n*Type*: Array of [Column](./aws-properties-cassandra-table-column.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-partitionkeycolumns", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "Column", "DuplicatesAllowed": false }, "BillingMode": { "MarkdownDocumentation": "`BillingMode`\n\nThe billing mode for the table, which determines how you'll be charged for reads and writes:\n* **On-demand mode** (default) - You pay based on\n the actual reads and writes your application performs.\n* **Provisioned mode** - Lets you specify the\n number of reads and writes per second that you need for your application.\nIf you don't specify a value for this property, then the table will use on-demand mode.\n*Required*: No\n*Type*: [BillingMode](./aws-properties-cassandra-table-billingmode.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-billingmode", "UpdateType": "Mutable", "Required": false, "Type": "BillingMode" }, "DefaultTimeToLive": { "MarkdownDocumentation": "`DefaultTimeToLive`\n\nThe default Time To Live (TTL) value for all rows in a table in seconds.\nThe maximum configurable value is 630,720,000 seconds, which is the equivalent of 20 years. By default, the TTL value for a table is 0, which means data does not expire.\nFor more information,\nsee [Setting the default TTL value for a table](https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl)\nin the *Amazon Keyspaces Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-defaulttimetolive", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RegularColumns": { "MarkdownDocumentation": "`RegularColumns`\n\nOne or more columns that are not part of the primary key - that is, columns that are\n*not* defined as partition key columns or clustering key\ncolumns.\nYou can add regular columns to existing tables by adding them to the template.\n*Required*: No\n*Type*: Array of [Column](./aws-properties-cassandra-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-regularcolumns", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Column", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-cassandra-table-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html#cfn-cassandra-table-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } } }, "AWS::Cassandra::Type": { "MarkdownDocumentation": "`AWS::Cassandra::Type`\n\nThe `CreateType` operation creates a new user-defined type in the specified keyspace.\nTo configure the required permissions, see [Permissions to create a UDT](https://docs.aws.amazon.com/keyspaces/latest/devguide/configure-udt-permissions.html#udt-permissions-create)\nin the *Amazon Keyspaces Developer Guide*.\nFor more information, see [User-defined types (UDTs)](https://docs.aws.amazon.com/keyspaces/latest/devguide/udts.html) in the *Amazon Keyspaces Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the type and the keyspace where the type exists (delimited by '|'). For example:\n`{ \"Ref\": \"myKeyspace|myType\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html", "Properties": { "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe name of the user-defined type. UDT names must contain 48 characters or less, must begin with\nan alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into\nlower case characters. For more information,\nsee [Create a user-defined type (UDT) in Amazon Keyspaces](https://docs.aws.amazon.com/keyspaces/latest/devguide/keyspaces-create-udt.html) in the *Amazon Keyspaces Developer\nGuide*.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#cfn-cassandra-type-typename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Fields": { "MarkdownDocumentation": "`Fields`\n\nA list of fields that define this type.\n*Required*: Yes\n*Type*: Array of [Field](./aws-properties-cassandra-type-field.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#cfn-cassandra-type-fields", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "Field", "DuplicatesAllowed": false }, "KeyspaceName": { "MarkdownDocumentation": "`KeyspaceName`\n\nThe name of the keyspace to create the type in. The keyspace must already exist.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#cfn-cassandra-type-keyspacename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DirectParentTypes": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`DirectParentTypes`\n\nA list of user-defined types that use this type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#DirectParentTypes-fn::getatt" }, "DirectReferringTables": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`DirectReferringTables`\n\nA list of tables that use this type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#DirectReferringTables-fn::getatt" }, "MaxNestingDepth": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`MaxNestingDepth`\n\nThe maximum nesting depth of this type. For more information,\nsee [Amazon Keyspaces UDT quotas and default values](https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html#quotas-udts) in the *Amazon Keyspaces Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#MaxNestingDepth-fn::getatt" }, "LastModifiedTimestamp": { "PrimitiveType": "Double", "MarkdownDocumentation": "`LastModifiedTimestamp`\n\nThe last time this type was modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#LastModifiedTimestamp-fn::getatt" }, "KeyspaceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`KeyspaceArn`\n\nThe unique identifier of the keyspace that contains this type\nin the format of Amazon Resource Name (ARN)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#KeyspaceArn-fn::getatt" } } }, "AWS::CertificateManager::Account": { "MarkdownDocumentation": "`AWS::CertificateManager::Account`\n\nThe `AWS::CertificateManager::Account` resource defines the expiry event\nconfiguration that determines the number of days prior to expiry when ACM starts\ngenerating EventBridge events.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the AWS account that owns the\ncertificate.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-account.html", "Properties": { "ExpiryEventsConfiguration": { "MarkdownDocumentation": "`ExpiryEventsConfiguration`\n\nObject containing expiration events options associated with an AWS account. For more information, see [ExpiryEventsConfiguration](https://docs.aws.amazon.com/acm/latest/APIReference/API_ExpiryEventsConfiguration.html) in the API reference.\n*Required*: Yes\n*Type*: [ExpiryEventsConfiguration](./aws-properties-certificatemanager-account-expiryeventsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-account.html#cfn-certificatemanager-account-expiryeventsconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ExpiryEventsConfiguration" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nID of the AWS account that owns the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-account.html#AccountId-fn::getatt" } } }, "AWS::CertificateManager::Certificate": { "MarkdownDocumentation": "`AWS::CertificateManager::Certificate`\n\nThe `AWS::CertificateManager::Certificate` resource requests an AWS Certificate Manager (ACM) certificate that you can use to enable\nsecure connections. For example, you can deploy an ACM certificate to an Elastic Load\nBalancer to enable HTTPS support. For more information, see [RequestCertificate](https://docs.aws.amazon.com/acm/latest/APIReference/API_RequestCertificate.html)\nin the AWS Certificate Manager API Reference.\n###### Important\nWhen you use the `AWS::CertificateManager::Certificate` resource in a\nCloudFormation stack, domain validation is handled automatically if all three of the\nfollowing are true: The certificate domain is hosted in Amazon Route 53, the domain\nresides in your AWS account, and you are using DNS\nvalidation.\nHowever, if the certificate uses email validation, or if the domain is not hosted\nin Route 53, then the stack will remain in the `CREATE_IN_PROGRESS`\nstate. Further stack operations are delayed until you validate the certificate\nrequest, either by acting upon the instructions in the validation email, or by\nadding a CNAME record to your DNS configuration. For more information, see [Option 1:\nDNS Validation](https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html) and [Option 2: Email\nValidation](https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the certificate's Amazon Resource Name (ARN).\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html", "Properties": { "CertificateAuthorityArn": { "MarkdownDocumentation": "`CertificateAuthorityArn`\n\nThe Amazon Resource Name (ARN) of the private certificate authority (CA) that will be\nused to issue the certificate. If you do not provide an ARN and you are trying to\nrequest a private certificate, ACM will attempt to issue a public certificate. For\nmore 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\nthe following form:\n`arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012`\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:acm-pca:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificateauthorityarn", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "CertificateExport": { "MarkdownDocumentation": "`CertificateExport`\n\nYou can opt out of allowing export of your certificate by specifying the\n`DISABLED` option. Allow export of your certificate by specifying the\n`ENABLED` option.\nIf you do not specify an export preference in a new CloudFormation template, it is the\nsame as explicitly denying export of your certificate.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificateexport", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CertificateTransparencyLoggingPreference": { "MarkdownDocumentation": "`CertificateTransparencyLoggingPreference`\n\nYou can opt out of certificate transparency logging by specifying the\n`DISABLED` option. Opt in by specifying `ENABLED`. This setting\ndoces not apply to private certificates.\nIf you do not specify a certificate transparency logging preference on a new\nCloudFormation template, or if you remove the logging preference from an existing\ntemplate, this is the same as explicitly enabling the preference.\nChanging the certificate transparency logging preference will update the existing\nresource by calling `UpdateCertificateOptions` on the certificate. This\naction will not create a new resource.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificatetransparencyloggingpreference", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe fully qualified domain name (FQDN), such as www.example.com, with which you want\nto secure an ACM certificate. Use an asterisk (\\*) to create a wildcard certificate that\nprotects several sites in the same domain. For example, `*.example.com`\nprotects `www.example.com`, `site.example.com`, and\n`images.example.com.`\n*Required*: Yes\n*Type*: String\n*Pattern*: `(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])`\n*Minimum*: `1`\n*Maximum*: `253`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainname", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "DomainValidationOptions": { "MarkdownDocumentation": "`DomainValidationOptions`\n\nDomain information that domain name registrars use to verify your identity.\n###### Important\nIn order for a AWS::CertificateManager::Certificate to be provisioned and\nvalidated in CloudFormation automatically, the `DomainName` property needs to be\nidentical to one of the `DomainName` property supplied in DomainValidationOptions,\nif the ValidationMethod is \\*\\*DNS\\*\\*. Failing to keep them like-for-like will result\nin failure to create the domain validation records in Route53.\n*Required*: No\n*Type*: Array of [DomainValidationOption](./aws-properties-certificatemanager-certificate-domainvalidationoption.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainvalidationoptions", "DuplicatesAllowed": false, "ItemType": "DomainValidationOption", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "KeyAlgorithm": { "MarkdownDocumentation": "`KeyAlgorithm`\n\nSpecifies the algorithm of the public and private key pair that your certificate uses\nto encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve\nDigital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to\nRSA keys but with greater computing efficiency. However, ECDSA is not supported by all\nnetwork clients. Some AWS services may require RSA keys, or only support ECDSA keys of\na particular size, while others allow the use of either RSA and ECDSA keys to ensure\nthat compatibility is not broken. Check the requirements for the AWS service where you\nplan to deploy your certificate. For more information about selecting an algorithm, see\n[Key\nalgorithms](https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate-characteristics.html#algorithms-term).\n###### Note\nAlgorithms supported for an ACM certificate request include:\n* `RSA_2048`\n* `EC_prime256v1`\n* `EC_secp384r1`\nOther listed algorithms are for imported certificates only.\n\n###### Note\nWhen you request a private PKI certificate signed by a CA from AWS Private CA, the\nspecified signing algorithm family (RSA or ECDSA) must match the algorithm family of\nthe CA's secret key.\nDefault: RSA\\_2048\n*Required*: No\n*Type*: String\n*Allowed values*: `RSA_1024 | RSA_2048 | RSA_3...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "RSA_1024", "RSA_2048", "RSA_3072", "RSA_4096", "EC_prime256v1", "EC_secp384r1", "EC_secp521r1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-keyalgorithm", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "SubjectAlternativeNames": { "MarkdownDocumentation": "`SubjectAlternativeNames`\n\nAdditional FQDNs to be included in the Subject Alternative Name extension of the ACM\ncertificate. For example, you can add www.example.net to a certificate for which the\n`DomainName` field is www.example.com if users can reach your site by\nusing either name.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-subjectalternativenames", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can identify the certificate.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-certificatemanager-certificate-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "ValidationMethod": { "MarkdownDocumentation": "`ValidationMethod`\n\nThe method you want to use to validate that you own or control the domain associated\nwith a public certificate. You can [validate with DNS](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or\n[validate with email](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html). We recommend that you use DNS validation.\nIf not specified, this property defaults to email validation.\n*Required*: No\n*Type*: String\n*Allowed values*: `EMAIL | DNS | HTTP...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "EMAIL", "DNS", "HTTP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-validationmethod", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" } } }, "AWS::Chatbot::CustomAction": { "MarkdownDocumentation": "`AWS::Chatbot::CustomAction`\n\n###### Note\nAWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)\n`Type` attribute values remain unchanged.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the configuration created.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-customaction.html", "Properties": { "ActionName": { "MarkdownDocumentation": "`ActionName`\n\nThe name of the custom action. This name is included in the Amazon Resource Name (ARN).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-customaction.html#cfn-chatbot-customaction-actionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AliasName": { "MarkdownDocumentation": "`AliasName`\n\nThe name used to invoke this action in a chat channel. For example, `@Amazon Q run my-alias`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9-_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-customaction.html#cfn-chatbot-customaction-aliasname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe definition of the command to run when invoked as an alias or as an action button.\n*Required*: Yes\n*Type*: [CustomActionDefinition](./aws-properties-chatbot-customaction-customactiondefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-customaction.html#cfn-chatbot-customaction-definition", "UpdateType": "Mutable", "Required": true, "Type": "CustomActionDefinition" }, "Attachments": { "MarkdownDocumentation": "`Attachments`\n\nDefines when this custom action button should be attached to a notification.\n*Required*: No\n*Type*: Array of [CustomActionAttachment](./aws-properties-chatbot-customaction-customactionattachment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-customaction.html#cfn-chatbot-customaction-attachments", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomActionAttachment", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to the configuration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-chatbot-customaction-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-customaction.html#cfn-chatbot-customaction-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "CustomActionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CustomActionArn`\n\nThe fully defined ARN of the custom action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-customaction.html#CustomActionArn-fn::getatt" } } }, "AWS::Chatbot::MicrosoftTeamsChannelConfiguration": { "MarkdownDocumentation": "`AWS::Chatbot::MicrosoftTeamsChannelConfiguration`\n\n###### Note\nAWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)\n`Type` attribute values remain unchanged.\nThe `AWS::Chatbot::MicrosoftTeamsChannelConfiguration` resource configures a Microsoft Teams channel to allow users to use Amazon Q Developer with CloudFormation templates.\nThis resource requires some setup to be done in the Amazon Q Developer in chat applications console. To provide the required Microsoft Teams team and tenant IDs, you must perform the initial authorization flow with\nMicrosoft Teams in the Amazon Q Developer in chat applications console, then copy and paste the IDs from the console.\nFor more details, see steps 1-3 in [Get started with Microsoft Teams](https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup) in the *Amazon Q Developer in chat applications Administrator Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the configuration created.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html", "Properties": { "UserRoleRequired": { "MarkdownDocumentation": "`UserRoleRequired`\n\nEnables 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-userrolerequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LoggingLevel": { "MarkdownDocumentation": "`LoggingLevel`\n\nSpecifies 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*Pattern*: `^(ERROR|INFO|NONE)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-logginglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TeamsChannelName": { "MarkdownDocumentation": "`TeamsChannelName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^(.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-teamschannelname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomizationResourceArns": { "MarkdownDocumentation": "`CustomizationResourceArns`\n\nLinks a list of resource ARNs (for example, custom action ARNs) to a Microsoft Teams channel configuration for Amazon Q Developer.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-customizationresourcearns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SnsTopicArns": { "MarkdownDocumentation": "`SnsTopicArns`\n\nThe ARNs of the SNS topics that deliver notifications to Amazon Q Developer.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-snstopicarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "GuardrailPolicies": { "MarkdownDocumentation": "`GuardrailPolicies`\n\nThe 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-guardrailpolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe ARN of the IAM role that defines the permissions for Amazon Q Developer.\nThis is a user-defined role that Amazon Q Developer will assume. This is not the service-linked role. For more information, see [IAM Policies for Amazon Q Developer in chat applications](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-iamrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TeamId": { "MarkdownDocumentation": "`TeamId`\n\nThe ID of the Microsoft Team authorized with Amazon Q Developer.\nTo get the team ID, you must perform the initial authorization flow with Microsoft Teams in the Amazon Q Developer in chat applications console. Then you can copy and paste the team ID from the console.\nFor more details, see steps 1-3 in [Tutorial: Get started with Microsoft Teams](https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html) in the *Amazon Q Developer in chat applications Administrator Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-teamid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ConfigurationName": { "MarkdownDocumentation": "`ConfigurationName`\n\nThe name of the configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9-_]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-configurationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TeamsTenantId": { "MarkdownDocumentation": "`TeamsTenantId`\n\nThe ID of the Microsoft Teams tenant.\nTo get the tenant ID, you must perform the initial authorization flow with Microsoft Teams in the Amazon Q Developer in chat applications console. Then you can copy and paste the tenant ID from the console.\nFor more details, see steps 1-3 in [Tutorial: Get started with Microsoft Teams](https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html) in the *Amazon Q Developer in chat applications Administrator Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-teamstenantid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to the configuration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-chatbot-microsoftteamschannelconfiguration-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "TeamsChannelId": { "MarkdownDocumentation": "`TeamsChannelId`\n\nThe ID of the Microsoft Teams channel.\nTo get the channel ID, open Microsoft Teams, right click on the channel name in the left pane, then choose **Copy**. An example of the channel ID syntax is: `19%3ab6ef35dc342d56ba5654e6fc6d25a071%40thread.tacv2`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9-_=+/.,])*%3[aA]([a-zA-Z0-9-_=+/.,])*%40([a-zA-Z0-9-_=+/.,])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-teamschannelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#Arn-fn::getatt" } } }, "AWS::Chatbot::SlackChannelConfiguration": { "MarkdownDocumentation": "`AWS::Chatbot::SlackChannelConfiguration`\n\n###### Note\nAWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)\n`Type` attribute values remain unchanged.\nThe `AWS::Chatbot::SlackChannelConfiguration` resource configures a Slack channel to allow users to use Amazon Q Developer with CloudFormation templates.\nThis resource requires some setup to be done in the Amazon Q Developer in chat applications console. To provide the required Slack workspace ID, you must perform the initial authorization flow with\nSlack in the Amazon Q Developer in chat applications console, then copy and paste the workspace ID from the console.\nFor more details, see steps 1-3 in [Tutorial: Get started with Slack](https://docs.aws.amazon.com/chatbot/latest/adminguide/slack-setup.html#slack-client-setup) in the *Amazon Q Developer in chat applications User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the configuration created.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html", "Properties": { "UserRoleRequired": { "MarkdownDocumentation": "`UserRoleRequired`\n\nEnables 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-userrolerequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LoggingLevel": { "MarkdownDocumentation": "`LoggingLevel`\n\nSpecifies 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*Pattern*: `^(ERROR|INFO|NONE)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-logginglevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomizationResourceArns": { "MarkdownDocumentation": "`CustomizationResourceArns`\n\nLinks a list of resource ARNs (for example, custom action ARNs) to a Slack channel configuration for Amazon Q Developer.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-customizationresourcearns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SnsTopicArns": { "MarkdownDocumentation": "`SnsTopicArns`\n\nThe ARNs of the SNS topics that deliver notifications to Amazon Q Developer.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-snstopicarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "GuardrailPolicies": { "MarkdownDocumentation": "`GuardrailPolicies`\n\nThe 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-guardrailpolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SlackWorkspaceId": { "MarkdownDocumentation": "`SlackWorkspaceId`\n\nThe ID of the Slack workspace authorized with Amazon Q Developer.\nTo get the workspace ID, you must perform the initial authorization flow with Slack in the Amazon Q Developer in chat applications console. Then you can copy and paste the workspace ID from the console.\nFor more details, see steps 1-3 in [Tutorial: Get started with Slack](https://docs.aws.amazon.com/chatbot/latest/adminguide/slack-setup.html#slack-client-setup) in the *Amazon Q Developer in chat applications User Guide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Z]{1,255}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackworkspaceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SlackChannelId": { "MarkdownDocumentation": "`SlackChannelId`\n\nThe 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 character string at the end of the URL. For example, `ABCBBLZZZ`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackchannelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe ARN of the IAM role that defines the permissions for Amazon Q Developer.\nThis is a user-defined role that Amazon Q Developer will assume. This is not the service-linked role. For more information, see [IAM Policies for Amazon Q Developerin chat applications](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-iamrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConfigurationName": { "MarkdownDocumentation": "`ConfigurationName`\n\nThe name of the configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9-_]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-configurationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to the configuration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-chatbot-slackchannelconfiguration-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#Arn-fn::getatt" } } }, "AWS::CleanRooms::AnalysisTemplate": { "MarkdownDocumentation": "`AWS::CleanRooms::AnalysisTemplate`\n\nCreates a new analysis template.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `AnalysisTemplateIdentifier`, such as `a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`. For example:\n`{ \"Ref\": \"myAnalysisTemplate\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html", "Properties": { "MembershipIdentifier": { "MarkdownDocumentation": "`MembershipIdentifier`\n\nThe identifier for a membership resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-membershipidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the analysis template.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Format": { "MarkdownDocumentation": "`Format`\n\nThe format of the analysis template.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SQL | PYSPARK_1_0...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SQL", "PYSPARK_1_0" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-format", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceMetadata": { "MarkdownDocumentation": "`SourceMetadata`\n\nThe source metadata for the analysis template.\n*Required*: No\n*Type*: [AnalysisSourceMetadata](./aws-properties-cleanrooms-analysistemplate-analysissourcemetadata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-sourcemetadata", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisSourceMetadata" }, "ErrorMessageConfiguration": { "MarkdownDocumentation": "`ErrorMessageConfiguration`\n\nThe configuration that specifies the level of detail in error messages returned by analyses using this template.\nWhen set to `DETAILED`, error messages include more information to help troubleshoot issues with PySpark jobs.\nDetailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.\n*Required*: No\n*Type*: [ErrorMessageConfiguration](./aws-properties-cleanrooms-analysistemplate-errormessageconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-errormessageconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "ErrorMessageConfiguration" }, "AnalysisParameters": { "MarkdownDocumentation": "`AnalysisParameters`\n\nThe parameters of the analysis template.\n*Required*: No\n*Type*: Array of [AnalysisParameter](./aws-properties-cleanrooms-analysistemplate-analysisparameter.html)\n*Minimum*: `0`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-analysisparameters", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AnalysisParameter", "DuplicatesAllowed": true }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe entire schema object.\n*Required*: No\n*Type*: [AnalysisSchema](./aws-properties-cleanrooms-analysistemplate-analysisschema.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-schema", "UpdateType": "Immutable", "Required": false, "Type": "AnalysisSchema" }, "SyntheticDataParameters": { "MarkdownDocumentation": "`SyntheticDataParameters`\n\nThe parameters used to generate synthetic data for this analysis template.\n*Required*: No\n*Type*: [SyntheticDataParameters](./aws-properties-cleanrooms-analysistemplate-syntheticdataparameters.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-syntheticdataparameters", "UpdateType": "Immutable", "Required": false, "Type": "SyntheticDataParameters" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe source of the analysis template.\n*Required*: Yes\n*Type*: [AnalysisSource](./aws-properties-cleanrooms-analysistemplate-analysissource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-source", "UpdateType": "Immutable", "Required": true, "Type": "AnalysisSource" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional label that you can assign to a resource when you create it. Each tag\nconsists of a key and an optional value, both of which you define. When you use tagging,\nyou can also use tag-based access control in IAM policies to control access\nto this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanrooms-analysistemplate-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the analysis template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CollaborationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationIdentifier`\n\nReturns the unique ID for the associated collaboration of the analysis template.\nExample: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#CollaborationIdentifier-fn::getatt" }, "MembershipArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MembershipArn`\n\nReturns the Amazon Resource Name (ARN) of the member who created the analysis template.\nExample: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#MembershipArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the analysis template.\nExample: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#Arn-fn::getatt" }, "CollaborationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationArn`\n\nReturns the unique ARN for the analysis template\u2019s associated collaboration.\nExample: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#CollaborationArn-fn::getatt" }, "AnalysisTemplateIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`AnalysisTemplateIdentifier`\n\nReturns the identifier for the analysis template.\nExample: `a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#AnalysisTemplateIdentifier-fn::getatt" } } }, "AWS::CleanRooms::Collaboration": { "MarkdownDocumentation": "`AWS::CleanRooms::Collaboration`\n\nCreates a new collaboration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `CollaborationIdentifier`, such as\n`a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. For example:\n`{ \"Ref\": \"MyCollaboration\" }`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html", "Properties": { "AnalyticsEngine": { "MarkdownDocumentation": "`AnalyticsEngine`\n\nThe analytics engine for the collaboration.\n###### Note\nAfter July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be\navailable.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLEAN_ROOMS_SQL | SPARK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLEAN_ROOMS_SQL", "SPARK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-analyticsengine", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatorDisplayName": { "MarkdownDocumentation": "`CreatorDisplayName`\n\nA display name of the collaboration creator.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatordisplayname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CreatorMemberAbilities": { "MarkdownDocumentation": "`CreatorMemberAbilities`\n\nThe abilities granted to the collaboration creator.\n*Allowed values*`CAN_QUERY` | `CAN_RECEIVE_RESULTS` | `CAN_RUN_JOB`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatormemberabilities", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the collaboration provided by the collaboration owner.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CreatorMLMemberAbilities": { "MarkdownDocumentation": "`CreatorMLMemberAbilities`\n\nThe ML member abilities for a collaboration member.\n*Required*: No\n*Type*: [MLMemberAbilities](./aws-properties-cleanrooms-collaboration-mlmemberabilities.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatormlmemberabilities", "UpdateType": "Immutable", "Required": false, "Type": "MLMemberAbilities" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA human-readable identifier provided by the collaboration owner. Display names are not\nunique.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "JobLogStatus": { "MarkdownDocumentation": "`JobLogStatus`\n\nAn indicator as to whether job logging has been enabled or disabled\nfor the collaboration.\nWhen `ENABLED`, AWS Clean Rooms logs details about jobs run within this\ncollaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n`DISABLED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-joblogstatus", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "QueryLogStatus": { "MarkdownDocumentation": "`QueryLogStatus`\n\nAn indicator as to whether query logging has been enabled or disabled for the\ncollaboration.\nWhen `ENABLED`, AWS Clean Rooms logs details about queries run within this\ncollaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n`DISABLED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-querylogstatus", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AutoApprovedChangeTypes": { "MarkdownDocumentation": "`AutoApprovedChangeTypes`\n\nThe types of change requests that are automatically approved for this collaboration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-autoapprovedchangetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "CreatorPaymentConfiguration": { "MarkdownDocumentation": "`CreatorPaymentConfiguration`\n\nAn object representing the collaboration member's payment responsibilities set by the\ncollaboration creator.\n*Required*: No\n*Type*: [PaymentConfiguration](./aws-properties-cleanrooms-collaboration-paymentconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatorpaymentconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "PaymentConfiguration" }, "DataEncryptionMetadata": { "MarkdownDocumentation": "`DataEncryptionMetadata`\n\nThe settings for client-side encryption for cryptographic computing.\n*Required*: No\n*Type*: [DataEncryptionMetadata](./aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-dataencryptionmetadata", "UpdateType": "Immutable", "Required": false, "Type": "DataEncryptionMetadata" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional label that you can assign to a resource when you create it. Each tag\nconsists of a key and an optional value, both of which you define. When you use tagging,\nyou can also use tag-based access control in IAM policies to control access\nto this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanrooms-collaboration-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Members": { "MarkdownDocumentation": "`Members`\n\nA list of initial members, not including the creator. This list is immutable.\n*Required*: No\n*Type*: Array of [MemberSpecification](./aws-properties-cleanrooms-collaboration-memberspecification.html)\n*Minimum*: `0`\n*Maximum*: `9`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-members", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "MemberSpecification", "DuplicatesAllowed": true }, "AllowedResultRegions": { "MarkdownDocumentation": "`AllowedResultRegions`\n\nThe AWS Regions where collaboration query results can be stored. Returns\nthe list of Region identifiers that were specified when the collaboration was created. This\nlist is used to enforce regional storage policies and compliance requirements.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-allowedresultregions", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } }, "Attributes": { "CollaborationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationIdentifier`\n\nReturns the unique identifier of the specified collaboration.\nExample: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#CollaborationIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the specified collaboration.\nExample:\n`arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#Arn-fn::getatt" } } }, "AWS::CleanRooms::ConfiguredTable": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTable`\n\nCreates a new configured table resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{\"Ref\": \"MyConfiguredTable\"}`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html", "Properties": { "SelectedAnalysisMethods": { "MarkdownDocumentation": "`SelectedAnalysisMethods`\n\nThe selected analysis methods for the configured table.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-selectedanalysismethods", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AnalysisMethod": { "MarkdownDocumentation": "`AnalysisMethod`\n\nThe analysis method for the configured table.\n`DIRECT_QUERY` allows SQL queries to be run directly on this table.\n`DIRECT_JOB` allows PySpark jobs to be run directly on this table.\n`MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DIRECT_QUERY | DIRECT_JOB |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-analysismethod", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableReference": { "MarkdownDocumentation": "`TableReference`\n\nThe table that this configured table represents.\n*Required*: Yes\n*Type*: [TableReference](./aws-properties-cleanrooms-configuredtable-tablereference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-tablereference", "UpdateType": "Mutable", "Required": true, "Type": "TableReference" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the configured table.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AnalysisRules": { "MarkdownDocumentation": "`AnalysisRules`\n\nThe analysis rule that was created for the configured table.\n*Required*: No\n*Type*: Array of [AnalysisRule](./aws-properties-cleanrooms-configuredtable-analysisrule.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-analysisrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AnalysisRule", "DuplicatesAllowed": true }, "AllowedColumns": { "MarkdownDocumentation": "`AllowedColumns`\n\nThe columns within the underlying AWS Glue table that can be used within\ncollaborations.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 100`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-allowedcolumns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional label that you can assign to a resource when you create it. Each tag\nconsists of a key and an optional value, both of which you define. When you use tagging,\nyou can also use tag-based access control in IAM policies to control access\nto this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanrooms-configuredtable-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the configured table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ConfiguredTableIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfiguredTableIdentifier`\n\nReturns the unique identifier of the specified configured table.\nExample: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#ConfiguredTableIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the specified configured table.\nExample: `arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#Arn-fn::getatt" } } }, "AWS::CleanRooms::ConfiguredTableAssociation": { "MarkdownDocumentation": "`AWS::CleanRooms::ConfiguredTableAssociation`\n\nCreates a configured table association. A configured table association links a\nconfigured table with a collaboration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ConfiguredTableAssociation` and the ID of the\nMembership. For example:\n`c1baf760-935e-4b2d-b36e-af8daaeb6e48|81a97460-2c40-46ce-a2fd-4ccda7398b2c`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html", "Properties": { "MembershipIdentifier": { "MarkdownDocumentation": "`MembershipIdentifier`\n\nThe unique ID for the membership this configured table association belongs to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-membershipidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the configured table association.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfiguredTableAssociationAnalysisRules": { "MarkdownDocumentation": "`ConfiguredTableAssociationAnalysisRules`\n\nAn analysis rule for a configured table association. This analysis rule specifies how\ndata from the table can be used within its associated collaboration. In the console, the\n`ConfiguredTableAssociationAnalysisRule` is referred to as the\n*collaboration analysis rule*.\n*Required*: No\n*Type*: Array of [ConfiguredTableAssociationAnalysisRule](./aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConfiguredTableAssociationAnalysisRule", "DuplicatesAllowed": true }, "ConfiguredTableIdentifier": { "MarkdownDocumentation": "`ConfiguredTableIdentifier`\n\nA unique identifier for the configured table to be associated to. Currently accepts a\nconfigured table ID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-configuredtableidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional label that you can assign to a resource when you create it. Each tag\nconsists of a key and an optional value, both of which you define. When you use tagging,\nyou can also use tag-based access control in IAM policies to control access\nto this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanrooms-configuredtableassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe service will assume this role to access catalog metadata and query the table.\n*Required*: Yes\n*Type*: String\n*Minimum*: `32`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the configured table association, in lowercase. The table is identified by\nthis name when running protected queries against the underlying data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ConfiguredTableAssociationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfiguredTableAssociationIdentifier`\n\nReturns the unique identifier of the specified configured table association.\nExample: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#ConfiguredTableAssociationIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the specified configured table\nassociation.\nExample:\n`arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#Arn-fn::getatt" } } }, "AWS::CleanRooms::IdMappingTable": { "MarkdownDocumentation": "`AWS::CleanRooms::IdMappingTable`\n\nDescribes information about the ID mapping table.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{\"Ref\": \"MyIdMappingTable\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html", "Properties": { "MembershipIdentifier": { "MarkdownDocumentation": "`MembershipIdentifier`\n\nThe unique identifier of the membership resource for the ID mapping table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-membershipidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the ID mapping table.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the AWS KMS key.\n*Required*: No\n*Type*: String\n*Minimum*: `4`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputReferenceConfig": { "MarkdownDocumentation": "`InputReferenceConfig`\n\nThe input reference configuration for the ID mapping table.\n*Required*: Yes\n*Type*: [IdMappingTableInputReferenceConfig](./aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-inputreferenceconfig", "UpdateType": "Immutable", "Required": true, "Type": "IdMappingTableInputReferenceConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional label that you can assign to a resource when you create it. Each tag\nconsists of a key and an optional value, both of which you define. When you use tagging,\nyou can also use tag-based access control in IAM policies to control access\nto this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanrooms-idmappingtable-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the ID mapping table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CollaborationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationIdentifier`\n\nThe unique identifier of the collaboration that contains this ID mapping table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#CollaborationIdentifier-fn::getatt" }, "MembershipArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MembershipArn`\n\nThe Amazon Resource Name (ARN) of the membership resource for the ID mapping table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#MembershipArn-fn::getatt" }, "IdMappingTableIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdMappingTableIdentifier`\n\nThe unique identifier of the ID mapping table identifier that you want to retrieve.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#IdMappingTableIdentifier-fn::getatt" }, "InputReferenceProperties": { "Type": "IdMappingTableInputReferenceProperties", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#InputReferenceProperties-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the ID mapping table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#Arn-fn::getatt" }, "InputReferenceProperties.IdMappingTableInputSource": { "Type": "List", "ItemType": "IdMappingTableInputSource", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#InputReferenceProperties.IdMappingTableInputSource-fn::getatt" }, "CollaborationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationArn`\n\nThe Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#CollaborationArn-fn::getatt" } } }, "AWS::CleanRooms::IdNamespaceAssociation": { "MarkdownDocumentation": "`AWS::CleanRooms::IdNamespaceAssociation`\n\nProvides information to create the ID namespace association.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{\"Ref\": \"MyIdNamespaceAssociation\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html", "Properties": { "IdMappingConfig": { "MarkdownDocumentation": "`IdMappingConfig`\n\nThe configuration settings for the ID mapping table.\n*Required*: No\n*Type*: [IdMappingConfig](./aws-properties-cleanrooms-idnamespaceassociation-idmappingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-idmappingconfig", "UpdateType": "Mutable", "Required": false, "Type": "IdMappingConfig" }, "MembershipIdentifier": { "MarkdownDocumentation": "`MembershipIdentifier`\n\nThe unique identifier of the membership that contains the ID namespace association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-membershipidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the ID namespace association.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputReferenceConfig": { "MarkdownDocumentation": "`InputReferenceConfig`\n\nThe input reference configuration for the ID namespace association.\n*Required*: Yes\n*Type*: [IdNamespaceAssociationInputReferenceConfig](./aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-inputreferenceconfig", "UpdateType": "Immutable", "Required": true, "Type": "IdNamespaceAssociationInputReferenceConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional label that you can assign to a resource when you create it. Each tag\nconsists of a key and an optional value, both of which you define. When you use tagging,\nyou can also use tag-based access control in IAM policies to control access\nto this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanrooms-idnamespaceassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of this ID namespace association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CollaborationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationIdentifier`\n\nThe unique identifier of the collaboration that contains this ID namespace association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#CollaborationIdentifier-fn::getatt" }, "MembershipArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MembershipArn`\n\nThe Amazon Resource Name (ARN) of the membership resource for this ID namespace association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#MembershipArn-fn::getatt" }, "InputReferenceProperties": { "Type": "IdNamespaceAssociationInputReferenceProperties", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#InputReferenceProperties-fn::getatt" }, "InputReferenceProperties.IdNamespaceType": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#InputReferenceProperties.IdNamespaceType-fn::getatt" }, "InputReferenceProperties.IdMappingWorkflowsSupported": { "Type": "List", "PrimitiveItemType": "Json", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#InputReferenceProperties.IdMappingWorkflowsSupported-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the ID namespace association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#Arn-fn::getatt" }, "IdNamespaceAssociationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdNamespaceAssociationIdentifier`\n\nThe unique identifier of the ID namespace association that you want to retrieve.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#IdNamespaceAssociationIdentifier-fn::getatt" }, "CollaborationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationArn`\n\nThe Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#CollaborationArn-fn::getatt" } } }, "AWS::CleanRooms::Membership": { "MarkdownDocumentation": "`AWS::CleanRooms::Membership`\n\nCreates a membership for a specific collaboration identifier and joins the\ncollaboration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `MembershipId`, such as\n`a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. For example:\n`{ \"Ref\": \"MyMembership\" }`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html", "Properties": { "CollaborationIdentifier": { "MarkdownDocumentation": "`CollaborationIdentifier`\n\nThe unique ID for the associated collaboration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-collaborationidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "JobLogStatus": { "MarkdownDocumentation": "`JobLogStatus`\n\nAn indicator as to whether job logging has been enabled or disabled\nfor the collaboration.\nWhen `ENABLED`, AWS Clean Rooms logs details about jobs run within this\ncollaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n`DISABLED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-joblogstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultResultConfiguration": { "MarkdownDocumentation": "`DefaultResultConfiguration`\n\nThe default protected query result configuration as specified by the member who can\nreceive results.\n*Required*: No\n*Type*: [MembershipProtectedQueryResultConfiguration](./aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-defaultresultconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MembershipProtectedQueryResultConfiguration" }, "QueryLogStatus": { "MarkdownDocumentation": "`QueryLogStatus`\n\nAn indicator as to whether query logging has been enabled or disabled for the\nmembership.\nWhen `ENABLED`, AWS Clean Rooms logs details about queries run within this\ncollaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n`DISABLED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-querylogstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultJobResultConfiguration": { "MarkdownDocumentation": "`DefaultJobResultConfiguration`\n\nThe default job result configuration for the membership.\n*Required*: No\n*Type*: [MembershipProtectedJobResultConfiguration](./aws-properties-cleanrooms-membership-membershipprotectedjobresultconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-defaultjobresultconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MembershipProtectedJobResultConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional label that you can assign to a resource when you create it. Each tag\nconsists of a key and an optional value, both of which you define. When you use tagging,\nyou can also use tag-based access control in IAM policies to control access\nto this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanrooms-membership-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "PaymentConfiguration": { "MarkdownDocumentation": "`PaymentConfiguration`\n\nThe payment responsibilities accepted by the collaboration member.\n*Required*: No\n*Type*: [MembershipPaymentConfiguration](./aws-properties-cleanrooms-membership-membershippaymentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-paymentconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MembershipPaymentConfiguration" } }, "Attributes": { "MembershipIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`MembershipIdentifier`\n\nReturns the unique identifier of the specified membership.\nExample: `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#MembershipIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the specified membership.\nExample:\n`arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#Arn-fn::getatt" }, "CollaborationCreatorAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationCreatorAccountId`\n\nReturns the unique identifier of the specified collaboration creator account.\nExample: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#CollaborationCreatorAccountId-fn::getatt" }, "CollaborationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationArn`\n\nReturns the Amazon Resource Name (ARN) of the specified collaboration.\nExample:\n`arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#CollaborationArn-fn::getatt" } } }, "AWS::CleanRooms::PrivacyBudgetTemplate": { "MarkdownDocumentation": "`AWS::CleanRooms::PrivacyBudgetTemplate`\n\nAn object that defines the privacy budget template.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myPrivacyBudgetTemplate\" }`\nFor the Clean Rooms privacy budget template, `Ref` returns the ARN of the privacy budget template.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html", "Properties": { "PrivacyBudgetType": { "MarkdownDocumentation": "`PrivacyBudgetType`\n\nSpecifies the type of the privacy budget template.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DIFFERENTIAL_PRIVACY | ACCE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DIFFERENTIAL_PRIVACY", "ACCESS_BUDGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-privacybudgettype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MembershipIdentifier": { "MarkdownDocumentation": "`MembershipIdentifier`\n\nThe identifier for a membership resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-membershipidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nSpecifies the epsilon and noise parameters for the privacy budget template.\n*Required*: Yes\n*Type*: [Parameters](./aws-properties-cleanrooms-privacybudgettemplate-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-parameters", "UpdateType": "Mutable", "Required": true, "Type": "Parameters" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional label that you can assign to a resource when you create it. Each tag consists\nof a key and an optional value, both of which you define. When you use tagging, you can also\nuse tag-based access control in IAM policies to control access to this\nresource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanrooms-privacybudgettemplate-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "AutoRefresh": { "MarkdownDocumentation": "`AutoRefresh`\n\nHow often the privacy budget refreshes.\n###### Important\nIf you plan to regularly bring new data into the collaboration, use `CALENDAR_MONTH` to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CALENDAR_MONTH | NONE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CALENDAR_MONTH", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-autorefresh", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CollaborationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationIdentifier`\n\nThe unique ID of the collaboration that contains this privacy budget template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#CollaborationIdentifier-fn::getatt" }, "MembershipArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MembershipArn`\n\nThe Amazon Resource Name (ARN) of the member who created the privacy budget template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#MembershipArn-fn::getatt" }, "PrivacyBudgetTemplateIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrivacyBudgetTemplateIdentifier`\n\nA unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#PrivacyBudgetTemplateIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the privacy budget template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#Arn-fn::getatt" }, "CollaborationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollaborationArn`\n\nThe ARN of the collaboration that contains this privacy budget template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#CollaborationArn-fn::getatt" } } }, "AWS::CleanRoomsML::TrainingDataset": { "MarkdownDocumentation": "`AWS::CleanRoomsML::TrainingDataset`\n\nDefines the information necessary to create a training dataset. In Clean Rooms ML, the\n`TrainingDataset` is metadata that points to a Glue table, which is read only\nduring `AudienceModel` creation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example:\n`{ \"Ref\": \"myTrainingDataset\" }`\nFor the Clean Rooms ML training dataset, `Ref` returns the ARN of the training dataset.\nExample: `arn:aws:cleanrooms-ml:ap-northeast-1:891377082322:training-dataset/fR8doOMxlv5q5HD5qB0f68`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the training dataset.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TrainingData": { "MarkdownDocumentation": "`TrainingData`\n\nAn array of information that lists the Dataset objects, which specifies the dataset type\nand details on its location and schema. You must provide a role that has read access to\nthese tables.\n*Required*: Yes\n*Type*: Array of [Dataset](./aws-properties-cleanroomsml-trainingdataset-dataset.html)\n*Minimum*: `1`\n*Maximum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-trainingdata", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "Dataset", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the `dataSource` field of each dataset.\nPassing a role across accounts is not allowed. If you pass a role that isn't in your account, you get an `AccessDeniedException` error.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.\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 keys as it is reserved. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cleanroomsml-trainingdataset-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the training dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the training dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#Status-fn::getatt" }, "TrainingDatasetArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrainingDatasetArn`\n\nThe Amazon Resource Name (ARN) of the training dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#TrainingDatasetArn-fn::getatt" } } }, "AWS::Cloud9::EnvironmentEC2": { "MarkdownDocumentation": "`AWS::Cloud9::EnvironmentEC2`\n\nThe `AWS::Cloud9::EnvironmentEC2` resource creates an Amazon EC2 development environment in AWS Cloud9. For more information, see [Creating an Environment](https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html) in the *AWS Cloud9 User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the development environment, such as `2bc3642873c342e485f7e0c561234567`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the development environment, such as `arn:aws:cloud9:us-east-2:123456789012:environment:2bc3642873c342e485f7e0c561234567`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#Name-fn::getatt" } }, "Properties": { "Repositories": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Repositories`\n\nAny AWS CodeCommit source code repositories to be cloned into the development environment.\n*Required*: No\n*Type*: Array of [Repository](./aws-properties-cloud9-environmentec2-repository.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-repositories", "ItemType": "Repository", "UpdateType": "Immutable" }, "OwnerArn": { "Required": false, "MarkdownDocumentation": "`OwnerArn`\n\nThe Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS Identity and Access Management principal. If this value is not specified, the ARN defaults to this environment's creator.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(iam|sts)::\\d+:(root|(user\\/[\\w+=/:,.@-]{1,64}|federated-user\\/[\\w+=/:,.@-]{2,32}|assumed-role\\/[\\w+=:,.@-]{1,64}\\/[\\w+=,.@-]{1,64}))$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-ownerarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ConnectionType": { "Required": false, "MarkdownDocumentation": "`ConnectionType`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "CONNECT_SSH", "CONNECT_SSM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-connectiontype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AutomaticStopTimeMinutes": { "Required": false, "MarkdownDocumentation": "`AutomaticStopTimeMinutes`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-automaticstoptimeminutes", "PrimitiveType": "Integer", "UpdateType": "Immutable" }, "ImageId": { "Required": true, "MarkdownDocumentation": "`ImageId`\n\nThe identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.\nTo choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.\nFrom December 04, 2023, you will be required to include the `ImageId` parameter\nfor the `CreateEnvironmentEC2` action. This change will be reflected across all\ndirect methods of communicating with the API, such as AWS SDK, AWS CLI and AWS CloudFormation. This change will only affect\ndirect API consumers, and not AWS Cloud9 console users.\nSince Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.\n**AMI aliases** \n* Amazon Linux 2: `amazonlinux-2-x86_64`\n* Amazon Linux 2023 (recommended): `amazonlinux-2023-x86_64`\n* Ubuntu 18.04: `ubuntu-18.04-x86_64`\n* Ubuntu 22.04: `ubuntu-22.04-x86_64`\n**SSM paths**\n* Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`\n* Amazon Linux 2023 (recommended): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64`\n* Ubuntu 18.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`\n* Ubuntu 22.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64`\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-imageid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SubnetId": { "Required": false, "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet in Amazon Virtual Private Cloud (Amazon VPC) that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance.\n*Required*: No\n*Type*: String\n*Pattern*: `^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$`\n*Minimum*: `15`\n*Maximum*: `24`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-subnetid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "InstanceType": { "Required": true, "MarkdownDocumentation": "`InstanceType`\n\nThe type of instance to connect to the environment (for example, `t2.micro`).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z]+[1-9][.][a-z0-9]+$`\n*Minimum*: `5`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-instancetype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs that will be associated with the new AWS Cloud9 development\nenvironment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloud9-environmentec2-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the environment.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CloudFormation::CustomResource": { "AdditionalProperties": true, "MarkdownDocumentation": "`AWS::CloudFormation::CustomResource`\n\nThe `AWS::CloudFormation::CustomResource` resource creates a custom\nresource. Custom resources provide a way for you to write custom provisioning logic into\nyour CloudFormation templates and have CloudFormation run it anytime\nyou create, update (if you changed the custom resource), or delete a stack.\nFor more information, see [Create\ncustom provisioning logic with custom resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) in the *CloudFormation User Guide*.\n###### Note\nIf you use AWS PrivateLink, custom resources in the VPC must have\naccess to CloudFormation-specific Amazon S3 buckets. Custom\nresources must send responses to a presigned Amazon S3 URL. If they can't\nsend responses to Amazon S3, CloudFormation won't receive a\nresponse and the stack operation fails. For more information, see [Access\nCloudFormation using an interface endpoint (AWS PrivateLink)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html) in the *CloudFormation User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html", "Properties": { "ServiceTimeout": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetimeout", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "ServiceToken": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html#cfn-customresource-servicetoken", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::CloudFormation::GuardHook": { "MarkdownDocumentation": "`AWS::CloudFormation::GuardHook`\n\nThe `AWS::CloudFormation::GuardHook` resource creates and activates a\nGuard Hook. Using the Guard domain\nspecific language (DSL), you can author Guard Hooks to evaluate\nyour resources before allowing stack operations.\nFor more information, see [Guard Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/guard-hooks.html) in the *CloudFormation Hooks\nUser Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Hook Amazon Resource Name (ARN). For example:\n`arn:aws:cloudformation:us-west-2:123456789012:type/hook/MyGuardHook`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nSpecifies the S3 location of your input parameters.\n*Required*: No\n*Type*: [Options](./aws-properties-cloudformation-guardhook-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-options", "UpdateType": "Mutable", "Required": false, "Type": "Options" }, "RuleLocation": { "MarkdownDocumentation": "`RuleLocation`\n\nSpecifies the S3 location of your Guard rules.\n*Required*: Yes\n*Type*: [S3Location](./aws-properties-cloudformation-guardhook-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-rulelocation", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" }, "HookStatus": { "MarkdownDocumentation": "`HookStatus`\n\nSpecifies if the Hook is `ENABLED` or `DISABLED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-hookstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nThe type name alias for the Hook. This alias must be unique per account and\nRegion.\nThe alias must be in the form `Name1::Name2::Name3` and must not begin with\n`AWS`. For example, `Private::Guard::MyTestHook`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!(?i)aws)[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-alias", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StackFilters": { "MarkdownDocumentation": "`StackFilters`\n\nSpecifies the stack level filters for the Hook.\nExample stack level filter in JSON:\n```\n\"StackFilters\": {\"FilteringCriteria\": \"ALL\", \"StackNames\": {\"Exclude\": [ \"stack-1\", \"stack-2\"]}}\n```\nExample stack level filter in YAML:\n```\nStackFilters:\n FilteringCriteria: ALL\n StackNames:\n Exclude:\n - stack-1\n - stack-2\n```\n*Required*: No\n*Type*: [StackFilters](./aws-properties-cloudformation-guardhook-stackfilters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-stackfilters", "UpdateType": "Mutable", "Required": false, "Type": "StackFilters" }, "TargetOperations": { "MarkdownDocumentation": "`TargetOperations`\n\nSpecifies the list of operations the Hook is run against. For more information, see\n[Hook targets](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-concepts.html#hook-terms-hook-target) in the *CloudFormation Hooks User\nGuide*.\nValid values: `STACK` | `RESOURCE` | `CHANGE_SET` |\n`CLOUD_CONTROL`\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-targetoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "TargetFilters": { "MarkdownDocumentation": "`TargetFilters`\n\nSpecifies the target filters for the Hook.\nExample target filter in JSON:\n```\n\"TargetFilters\": {\"Actions\": [ \"CREATE\", \"UPDATE\", \"DELETE\" ]}\n```\nExample target filter in YAML:\n```\nTargetFilters:\n Actions:\n - CREATE\n - UPDATE\n - DELETE\n```\n*Required*: No\n*Type*: [TargetFilters](./aws-properties-cloudformation-guardhook-targetfilters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-targetfilters", "UpdateType": "Mutable", "Required": false, "Type": "TargetFilters" }, "LogBucket": { "MarkdownDocumentation": "`LogBucket`\n\nSpecifies the name of an S3 bucket to store the Guard output\nreport. This report contains the results of your Guard rule\nvalidations.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-logbucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe IAM role that the Hook assumes to retrieve your Guard rules\nfrom S3 and optionally write a detailed Guard output report\nback.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.+:iam::[0-9]{12}:role/.+`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-executionrole", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FailureMode": { "MarkdownDocumentation": "`FailureMode`\n\nSpecifies how the Hook responds when rules fail their evaluation.\n* `FAIL`: Prevents the action from proceeding. This is helpful for\n enforcing strict compliance or security policies.\n* `WARN`: Issues warnings to users but allows actions to continue.\n This is useful for non-critical validations or informational checks.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FAIL | WARN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FAIL", "WARN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-failuremode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "HookArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`HookArn`\n\nReturns the ARN of a Guard Hook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#HookArn-fn::getatt" } } }, "AWS::CloudFormation::HookDefaultVersion": { "MarkdownDocumentation": "`AWS::CloudFormation::HookDefaultVersion`\n\nThe `AWS::CloudFormation::HookDefaultVersion` resource specifies the\ndefault version of a Hook. The default version of the Hook is used in CloudFormation operations for this AWS account and AWS Region.\nFor information about the CloudFormation registry, see [Managing\nextensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the\n*CloudFormation User Guide*.\nThis resource type is not compatible with Guard and Lambda Hooks.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the Hook version. For\nexample:\n`arn:aws:cloudformation:us-west-2:123456789012:type/hook/Sample-CloudFormation-Hook/00000001`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html", "Properties": { "VersionId": { "MarkdownDocumentation": "`VersionId`\n\nThe version ID of the type specified.\nYou must specify either `TypeVersionArn`, or `TypeName` and\n`VersionId`.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe name of the Hook.\nYou must specify either `TypeVersionArn`, or `TypeName` and\n`VersionId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeVersionArn": { "MarkdownDocumentation": "`TypeVersionArn`\n\nThe version ID of the type configuration.\nYou must specify either `TypeVersionArn`, or `TypeName` and\n`VersionId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Number (ARN) of the activated Hook in this account and\nRegion.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#Arn-fn::getatt" } } }, "AWS::CloudFormation::HookTypeConfig": { "MarkdownDocumentation": "`AWS::CloudFormation::HookTypeConfig`\n\nThe `AWS::CloudFormation::HookTypeConfig` resource specifies the\nconfiguration of an activated Hook.\nFor information about the CloudFormation registry, see [Managing\nextensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the\n*CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the resource version. For example:\n`arn:aws:cloudformation:us-west-2:123456789012:type-configuration/hook/My-Sample-Hook/default`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html", "Properties": { "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe unique name for your Hook. Specifies a three-part namespace for your Hook, with a\nrecommended pattern of `Organization::Service::Hook`.\nYou must specify either `TypeName` and `Configuration` or\n`TypeArn` and `Configuration`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nSpecifies the activated Hook type configuration, in this AWS account\nand AWS Region.\nYou must specify either `TypeName` and `Configuration` or\n`TypeArn` and `Configuration`.\n*Required*: Conditional\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TypeArn": { "MarkdownDocumentation": "`TypeArn`\n\nThe Amazon Resource Number (ARN) for the Hook to set `Configuration`\nfor.\nYou must specify either `TypeName` and `Configuration` or\n`TypeArn` and `Configuration`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfigurationAlias": { "MarkdownDocumentation": "`ConfigurationAlias`\n\nAn alias by which to refer to this configuration data.\nDefaults to `default` alias. Hook types currently support default\nconfiguration alias.\n*Required*: No\n*Type*: String\n*Allowed values*: `default`\n*Pattern*: `^[a-zA-Z0-9]{1,256}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "default" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ConfigurationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationArn`\n\nThe Amazon Resource Number (ARN) of the activated Hook type configuration in this\naccount and Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#ConfigurationArn-fn::getatt" } } }, "AWS::CloudFormation::HookVersion": { "MarkdownDocumentation": "`AWS::CloudFormation::HookVersion`\n\nThe `AWS::CloudFormation::HookVersion` resource publishes new or first\nversion of a Hook to the CloudFormation registry.\nFor information about the CloudFormation registry, see [Managing\nextensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the\n*CloudFormation User Guide*.\nThis resource type is not compatible with Guard and Lambda Hooks.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the Hook version. For example:\n`arn:aws:cloudformation:us-west-2:123456789012:type/hook/Sample-CloudFormation-Hook/00000001`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html", "Properties": { "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the task execution role that grants the Hook\npermission.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.+:iam::[0-9]{12}:role/.+`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe unique name for your Hook. Specifies a three-part namespace for your Hook, with a\nrecommended pattern of `Organization::Service::Hook`.\n###### Note\nThe following organization namespaces are reserved and can't be used in your Hook type\nnames:\n* `Alexa`\n* `AMZN`\n* `Amazon`\n* `ASK`\n* `AWS`\n* `Custom`\n* `Dev`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LoggingConfig": { "MarkdownDocumentation": "`LoggingConfig`\n\nContains logging configuration information for an extension.\n*Required*: No\n*Type*: [LoggingConfig](./aws-properties-cloudformation-hookversion-loggingconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig", "UpdateType": "Immutable", "Required": false, "Type": "LoggingConfig" }, "SchemaHandlerPackage": { "MarkdownDocumentation": "`SchemaHandlerPackage`\n\nA URL to the Amazon S3 bucket for the Hook project package that contains the\nnecessary files for the Hook you want to register.\nFor information on generating a schema handler package, see [Modeling custom\nCloudFormation Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-model.html) in the *CloudFormation Hooks\nUser Guide*.\n###### Note\nTo register the Hook, you must have `s3:GetObject` permissions to\naccess the S3 objects.\n*Required*: Yes\n*Type*: String\n*Maximum*: `4096`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "VersionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VersionId`\n\nThe ID of this version of the Hook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#VersionId-fn::getatt" }, "IsDefaultVersion": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefaultVersion`\n\nWhether the specified Hook version is set as the default version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#IsDefaultVersion-fn::getatt" }, "Visibility": { "PrimitiveType": "String", "MarkdownDocumentation": "`Visibility`\n\nThe visibility level that determines who can see and use this Hook in CloudFormation operations:\n* `PRIVATE`: The Hook is only visible and usable within the account\n where it was registered. CloudFormation automatically marks any Hooks\n you register as `PRIVATE`.\n* `PUBLIC`: The Hook is publicly visible and usable within any\n AWS account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#Visibility-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the Hook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#Arn-fn::getatt" }, "TypeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TypeArn`\n\nThe Amazon Resource Number (ARN) assigned to this version of the Hook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#TypeArn-fn::getatt" } } }, "AWS::CloudFormation::LambdaHook": { "MarkdownDocumentation": "`AWS::CloudFormation::LambdaHook`\n\nThe `AWS::CloudFormation::LambdaHook` resource creates and activates a\nLambda Hook. You can use a Lambda Hook to evaluate your\nresources before allowing stack operations. This resource forwards requests for resource\nevaluation to a Lambda function.\nFor more information, see [Lambda\nHooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/lambda-hooks.html) in the *CloudFormation Hooks User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Hook Amazon Resource Name (ARN). For example:\n`arn:aws:cloudformation:us-west-2:123456789012:type/hook/MyLambdaHook`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html", "Properties": { "HookStatus": { "MarkdownDocumentation": "`HookStatus`\n\nSpecifies if the Hook is `ENABLED` or `DISABLED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-hookstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nThe type name alias for the Hook. This alias must be unique per account and Region.\nThe alias must be in the form `Name1::Name2::Name3` and must not begin with\n`AWS`. For example, `Private::Lambda::MyTestHook`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!(?i)aws)[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-alias", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StackFilters": { "MarkdownDocumentation": "`StackFilters`\n\nSpecifies the stack level filters for the Hook.\nExample stack level filter in JSON:\n```\n\"StackFilters\": {\"FilteringCriteria\": \"ALL\", \"StackNames\": {\"Exclude\": [ \"stack-1\", \"stack-2\"]}}\n```\nExample stack level filter in YAML:\n```\nStackFilters:\n FilteringCriteria: ALL\n StackNames:\n Exclude:\n - stack-1\n - stack-2\n```\n*Required*: No\n*Type*: [StackFilters](./aws-properties-cloudformation-lambdahook-stackfilters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-stackfilters", "UpdateType": "Mutable", "Required": false, "Type": "StackFilters" }, "TargetOperations": { "MarkdownDocumentation": "`TargetOperations`\n\nSpecifies the list of operations the Hook is run against. For more information, see\n[Hook targets](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-concepts.html#hook-terms-hook-target) in the *CloudFormation Hooks User\nGuide*.\nValid values: `STACK` | `RESOURCE` | `CHANGE_SET` |\n`CLOUD_CONTROL`\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-targetoperations", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "TargetFilters": { "MarkdownDocumentation": "`TargetFilters`\n\nSpecifies the target filters for the Hook.\nExample target filter in JSON:\n```\n\"TargetFilters\": {\"Actions\": [ \"CREATE\", \"UPDATE\", \"DELETE\" ]}\n```\nExample target filter in YAML:\n```\nTargetFilters:\n Actions:\n - CREATE\n - UPDATE\n - DELETE\n```\n*Required*: No\n*Type*: [TargetFilters](./aws-properties-cloudformation-lambdahook-targetfilters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-targetfilters", "UpdateType": "Mutable", "Required": false, "Type": "TargetFilters" }, "LambdaFunction": { "MarkdownDocumentation": "`LambdaFunction`\n\nSpecifies the Lambda function for the Hook. You can use:\n* The full Amazon Resource Name (ARN) without a suffix.\n* A qualified ARN with a version or alias suffix.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?`\n*Minimum*: `1`\n*Maximum*: `170`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-lambdafunction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe IAM role that the Hook assumes to invoke your Lambda function.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.+:iam::[0-9]{12}:role/.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FailureMode": { "MarkdownDocumentation": "`FailureMode`\n\nSpecifies how the Hook responds when the Lambda function invoked by the\nHook returns a `FAILED` response.\n* `FAIL`: Prevents the action from proceeding. This is helpful for\n enforcing strict compliance or security policies.\n* `WARN`: Issues warnings to users but allows actions to continue.\n This is useful for non-critical validations or informational checks.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `FAIL | WARN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FAIL", "WARN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-failuremode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "HookArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`HookArn`\n\nReturns the ARN of a Lambda Hook.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#HookArn-fn::getatt" } } }, "AWS::CloudFormation::Macro": { "MarkdownDocumentation": "`AWS::CloudFormation::Macro`\n\nThe `AWS::CloudFormation::Macro` resource is a CloudFormation\nresource type that creates a CloudFormation macro to perform custom processing\non CloudFormation templates.\nFor more information, see [Perform custom\nprocessing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) in the\n*CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myMacro\" }`\nFor the macro `myMacro`, `Ref` returns the name of the\nmacro.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the macro.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "FunctionName": { "MarkdownDocumentation": "`FunctionName`\n\nThe Amazon Resource Name (ARN) of the underlying Lambda function that you\nwant CloudFormation to invoke when the macro is run.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe CloudWatch Logs group to which CloudFormation sends error logging\ninformation when invoking the macro's underlying Lambda function.\nThis will be an existing CloudWatch Logs LogGroup. Neither CloudFormation\nor Lambda will create 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "LogRoleARN": { "MarkdownDocumentation": "`LogRoleARN`\n\nThe ARN of the role CloudFormation should assume when sending log entries to\nCloudWatch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the macro. The name of the macro must be unique across all macros in the\naccount.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::CloudFormation::ModuleDefaultVersion": { "MarkdownDocumentation": "`AWS::CloudFormation::ModuleDefaultVersion`\n\nSpecifies the default version of a module. The default version of the module will be\nused in CloudFormation operations for this account and Region.\nFor more information, see [Create reusable resource\nconfigurations that can be included across templates with CloudFormation\nmodules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) in the *CloudFormation User Guide*.\nFor information about the CloudFormation registry, see [Managing\nextensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the\n*CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the module\nversion.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html", "Properties": { "VersionId": { "MarkdownDocumentation": "`VersionId`\n\nThe ID for the specific version of the module.\nConditional: You must specify either `Arn`, or `ModuleName` and\n`VersionId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[0-9]{8}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ModuleName": { "MarkdownDocumentation": "`ModuleName`\n\nThe name of the module.\nConditional: You must specify either `Arn`, or `ModuleName` and\n`VersionId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::MODULE`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the module version to set as the default\nversion.\nConditional: You must specify either `Arn`, or `ModuleName` and\n`VersionId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/module/.+/[0-9]{8}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::CloudFormation::ModuleVersion": { "MarkdownDocumentation": "`AWS::CloudFormation::ModuleVersion`\n\nThe `AWS::CloudFormation::ModuleVersion` resource registers the specified\nversion of the module with the CloudFormation registry. Registering a module\nmakes it available for use in CloudFormation templates in your AWS account and Region.\nFor more information, see [Create reusable resource\nconfigurations that can be included across templates with CloudFormation\nmodules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) in the *CloudFormation User\nGuide*.\nFor information about the CloudFormation registry, see [Managing\nextensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the\n*CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the module\nversion.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html", "Properties": { "ModulePackage": { "MarkdownDocumentation": "`ModulePackage`\n\nA URL to the S3 bucket for the package that contains the template fragment and schema\nfiles for the module version to register.\nFor more information, see [Module structure\nand requirements](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules-structure.html) in the *CloudFormation Command Line Interface\n(CLI) User Guide*.\n###### Note\nTo register the module version, you must have `s3:GetObject`\npermissions to access the S3 objects.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ModuleName": { "MarkdownDocumentation": "`ModuleName`\n\nThe name of the module being registered.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::MODULE`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "TimeCreated": { "PrimitiveType": "String", "MarkdownDocumentation": "`TimeCreated`\n\nWhen the specified private module version was registered or activated in your\naccount.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#TimeCreated-fn::getatt" }, "VersionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VersionId`\n\nThe ID of this version of the module.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#VersionId-fn::getatt" }, "Description": { "PrimitiveType": "String", "MarkdownDocumentation": "`Description`\n\nThe description of the module.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#Description-fn::getatt" }, "Schema": { "PrimitiveType": "String", "MarkdownDocumentation": "`Schema`\n\nThe schema that defines the module.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#Schema-fn::getatt" }, "IsDefaultVersion": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefaultVersion`\n\nWhether the specified module version is set as the default version.\nThis applies only to private extensions you have registered in your account, and\nextensions published by AWS. For public third-party extensions, whether\nthey are activated in your account, CloudFormation returns\n`null`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#IsDefaultVersion-fn::getatt" }, "Visibility": { "PrimitiveType": "String", "MarkdownDocumentation": "`Visibility`\n\nThe visibility level that determines who can see and use this module in CloudFormation operations:\n* `PRIVATE`: The module is only visible and usable within the account\n where it was registered. CloudFormation automatically marks any modules\n you register as `PRIVATE`.\n* `PUBLIC`: The module is publicly visible and usable within any\n AWS account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#Visibility-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the module.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#Arn-fn::getatt" }, "DocumentationUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`DocumentationUrl`\n\nThe URL of a page providing detailed documentation for this module.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#DocumentationUrl-fn::getatt" } } }, "AWS::CloudFormation::PublicTypeVersion": { "MarkdownDocumentation": "`AWS::CloudFormation::PublicTypeVersion`\n\nThe `AWS::CloudFormation::PublicTypeVersion` resource tests and publishes a\nregistered extension as a public, third-party extension.\nCloudFormation first tests the extension to make sure it meets all necessary\nrequirements for being published in the CloudFormation registry. If it does,\nCloudFormation then publishes it to the registry as a public third-party\nextension in this Region. Public extensions are available for use by all CloudFormation users.\n* For resource types, testing includes passing all contracts tests defined for\n the type.\n* For modules, testing includes determining if the module's model meets all\n necessary requirements.\nFor more information, see [Testing your public extension prior to publishing](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the *CloudFormation Command Line Interface (CLI) User Guide*.\nIf you don't specify a version, CloudFormation uses the default version of\nthe extension in your account and Region for testing.\nTo perform testing, CloudFormation assumes the execution role specified when\nthe type was registered.\nAn extension must have a test status of `PASSED` before it can be\npublished. For more information, see [Publishing\nextensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the *CloudFormation Command Line Interface (CLI) User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) assigned to the public\nextension upon publication. For example:\n`{ \"Ref\":\n\"arn:aws:cloudformation:us-west-2::type/resource/2a33349e7e606a8ad2e30e3c84521f93123456/My-Extension/2.1.3\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html", "Properties": { "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe name of the extension to test.\nConditional: You must specify `Arn`, or `TypeName` and\n`Type`.\n*Required*: Conditional\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogDeliveryBucket": { "MarkdownDocumentation": "`LogDeliveryBucket`\n\nThe S3 bucket to which CloudFormation delivers the contract test execution\nlogs.\nCloudFormation delivers the logs by the time contract testing has completed\nand the extension has been assigned a test type status of `PASSED` or\n`FAILED`.\nThe user initiating the stack operation must be able to access items in the specified\nS3 bucket. Specifically, the user needs the following permissions:\n* s3:GetObject\n* s3:PutObject\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]+`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the extension to test.\nConditional: You must specify `Arn`, or `TypeName` and\n`Type`.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `RESOURCE | MODULE | HOOK...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "RESOURCE", "MODULE", "HOOK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PublicVersionNumber": { "MarkdownDocumentation": "`PublicVersionNumber`\n\nThe version number to assign to this version of the extension.\nUse the following format, and adhere to semantic versioning when assigning a version\nnumber to your extension:\n`MAJOR.MINOR.PATCH`\nFor more information, see [Semantic Versioning\n2.0.0](https://semver.org/).\nIf you don't specify a version number, CloudFormation increments the version number by one\nminor version release.\nYou cannot specify a version number the first time you publish a type. CloudFormation\nautomatically sets the first version number to be `1.0.0`.\n*Required*: No\n*Type*: String\n*Minimum*: `5`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Number (ARN) of the extension.\nConditional: You must specify `Arn`, or `TypeName` and\n`Type`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "PublicTypeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublicTypeArn`\n\nThe Amazon Resource Number (ARN) assigned to the public extension upon\npublication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#PublicTypeArn-fn::getatt" }, "PublisherId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublisherId`\n\nThe publisher ID of the extension publisher.\nThis applies only to public third-party extensions. For private registered extensions, and\nextensions provided by AWS, CloudFormation returns `null`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#PublisherId-fn::getatt" }, "TypeVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TypeVersionArn`\n\nThe Amazon Resource Number (ARN) assigned to this version of the extension.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#TypeVersionArn-fn::getatt" } } }, "AWS::CloudFormation::Publisher": { "MarkdownDocumentation": "`AWS::CloudFormation::Publisher`\n\nThe `AWS::CloudFormation::Publisher` resource registers your account as a\npublisher of public extensions in the CloudFormation registry. Public\nextensions are available for use by all CloudFormation users.\nFor information on requirements for registering as a public extension publisher, see\n[Publishing\nextensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.htm) in the *CloudFormation Command Line Interface (CLI) User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the publisher ID. For example:\n`{ \"Ref\": \"2a33349e7e606a8ad2e30e3c84521f012345678\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html", "Properties": { "AcceptTermsAndConditions": { "MarkdownDocumentation": "`AcceptTermsAndConditions`\n\nWhether you accept the [Terms and Conditions](https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry. You must\naccept the terms and conditions in order to register to publish public extensions to the\nCloudFormation registry.\nThe default is `false`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "ConnectionArn": { "MarkdownDocumentation": "`ConnectionArn`\n\nIf you are using a Bitbucket or GitHub account for identity verification, the Amazon\nResource Name (ARN) for your connection to that account.\nFor more information, see [Prerequisite: Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the\n*AWS CloudFormation Command Line Interface (CLI) User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[w]+)*:.+:.+:[0-9]{12}:.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "PublisherId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublisherId`\n\nThe ID of the extension publisher.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#PublisherId-fn::getatt" }, "IdentityProvider": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdentityProvider`\n\nThe type of account used as the identity provider when registering this publisher with\nCloudFormation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#IdentityProvider-fn::getatt" }, "PublisherProfile": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublisherProfile`\n\nThe URL to the publisher's profile with the identity provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#PublisherProfile-fn::getatt" }, "PublisherStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublisherStatus`\n\nWhether the publisher is verified. Currently, all registered publishers are\nverified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#PublisherStatus-fn::getatt" } } }, "AWS::CloudFormation::ResourceDefaultVersion": { "MarkdownDocumentation": "`AWS::CloudFormation::ResourceDefaultVersion`\n\nThe `AWS::CloudFormation::ResourceDefaultVersion` resource specifies the\ndefault version of a resource. The default version of a resource will be used in CloudFormation operations.\nFor information about the CloudFormation registry, see [Managing\nextensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the\n*CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the resource type. For example:\n`arn:aws:cloudformation:us-west-2:123456789012:type/resource/Sample-CloudFormation-Resource`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html", "Properties": { "VersionId": { "MarkdownDocumentation": "`VersionId`\n\nThe ID of a specific version of the resource. The version ID is the value at the end\nof the Amazon Resource Name (ARN) assigned to the resource version when it's\nregistered.\nConditional: You must specify either `TypeVersionArn`, or\n`TypeName` and `VersionId`.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-versionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe name of the resource.\nConditional: You must specify either `TypeVersionArn`, or\n`TypeName` and `VersionId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeVersionArn": { "MarkdownDocumentation": "`TypeVersionArn`\n\nThe Amazon Resource Name (ARN) of the resource version.\nConditional: You must specify either `TypeVersionArn`, or\n`TypeName` and `VersionId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#Arn-fn::getatt" } } }, "AWS::CloudFormation::ResourceVersion": { "MarkdownDocumentation": "`AWS::CloudFormation::ResourceVersion`\n\nThe `AWS::CloudFormation::ResourceVersion` resource registers a resource\nversion with the CloudFormation registry. Registering a resource version makes\nit available for use in CloudFormation templates in your AWS account, and includes:\n* Validating the resource schema.\n* Determining which handlers, if any, have been specified for the\n resource.\n* Making the resource available for use in your account.\nFor information about the CloudFormation registry, see [Managing\nextensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the\n*CloudFormation User Guide*.\nYou can have a maximum of 50 resource versions registered at a time. This maximum is\nper account and per Region.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the resource version. For example:\n`arn:aws:cloudformation:us-west-2:123456789012:type/resource/Sample-CloudFormation-Resource/00000001`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html", "Properties": { "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource. If your resource calls AWS APIs in any of its handlers, you must create an IAM\nexecution role that includes the necessary permissions to call those AWS\nAPIs, and provision that execution role in your account. When CloudFormation\nneeds to invoke the resource type handler, CloudFormation assumes this\nexecution role to create a temporary session token, which it then passes to the resource\ntype handler, thereby supplying your resource type with the appropriate\ncredentials.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.+:iam::[0-9]{12}:role/.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe name of the resource being registered.\nWe recommend that resource names adhere to the following pattern:\n*company\\_or\\_organization*::*service*::*type*.\n###### Note\nThe following organization namespaces are reserved and can't be used in your\nresource names:\n* `Alexa`\n* `AMZN`\n* `Amazon`\n* `AWS`\n* `Custom`\n* `Dev`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LoggingConfig": { "MarkdownDocumentation": "`LoggingConfig`\n\nLogging configuration information for a resource.\n*Required*: No\n*Type*: [LoggingConfig](./aws-properties-cloudformation-resourceversion-loggingconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig", "UpdateType": "Immutable", "Required": false, "Type": "LoggingConfig" }, "SchemaHandlerPackage": { "MarkdownDocumentation": "`SchemaHandlerPackage`\n\nA URL to the S3 bucket for the resource project package that contains the necessary\nfiles for the resource you want to register.\nFor information on generating a schema handler package, see [Modeling resource\ntypes to use with CloudFormation](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html) in the *CloudFormation\nCommand Line Interface (CLI) User Guide*.\n###### Note\nTo register the resource version, you must have `s3:GetObject`\npermissions to access the S3 objects.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "VersionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VersionId`\n\nThe ID of a specific version of the resource. The version ID is the value at the end\nof the Amazon Resource Name (ARN) assigned to the resource version when it is\nregistered.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#VersionId-fn::getatt" }, "ProvisioningType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProvisioningType`\n\nFor resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the\ntypes of handlers in the schema handler package submitted.\nPossible values:\n* `FULLY_MUTABLE`: The resource type includes an update handler to\n process updates to the type during stack update operations.\n* `IMMUTABLE`: The resource type doesn't include an update handler,\n so the type can't be updated and must instead be replaced during stack update\n operations.\n* `NON_PROVISIONABLE`: The resource type doesn't include all the\n following handlers, and therefore can't actually be provisioned.\n \n + create\n + read\n + delete\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#ProvisioningType-fn::getatt" }, "IsDefaultVersion": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefaultVersion`\n\nWhether the specified resource version is set as the default version.\nThis applies only to private extensions you have registered in your account, and\nextensions published by AWS. For public third-party extensions, whether\nthey are activated in your account, CloudFormation returns\n`null`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#IsDefaultVersion-fn::getatt" }, "Visibility": { "PrimitiveType": "String", "MarkdownDocumentation": "`Visibility`\n\nThe visibility level that determines who can see and use this resource in CloudFormation operations:\n* `PRIVATE`: The resource is only visible and usable within the\n account where it was registered. CloudFormation automatically marks any\n resources you register as `PRIVATE`.\n* `PUBLIC`: The resource is publicly visible and usable within any\n AWS account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#Visibility-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#Arn-fn::getatt" }, "TypeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TypeArn`\n\nThe Amazon Resource Name (ARN) for the extension.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#TypeArn-fn::getatt" } } }, "AWS::CloudFormation::Stack": { "MarkdownDocumentation": "`AWS::CloudFormation::Stack`\n\nThe `AWS::CloudFormation::Stack` resource nests a stack as a resource in a\ntop-level template. For more information, see [Nested\nstacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) in the *CloudFormation User Guide*.\nYou can add output values from a nested stack within the containing template. You use\nthe [GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html) function with the nested stack's logical name and the name of the\noutput value in the nested stack in the format\n`Outputs.NestedStackOutputName`.\nWe strongly recommend that updates to nested stacks are run from the parent\nstack.\nWhen you apply template changes to update a top-level stack, CloudFormation\nupdates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update\nthe resources of unmodified nested stacks.\nFor stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack\npermissions, which are required if an update rolls back. For more information about\nIAM and CloudFormation, see [Controlling\naccess with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html) in the *CloudFormation User\nGuide*.\n###### Note\nA subset of `AWS::CloudFormation::Stack` resource type properties\nlisted below are available to customers using CloudFormation, AWS CDK, and AWS Cloud Control API to configure.\n* `NotificationARNs`\n* `Parameters`\n* `Tags`\n* `TemplateURL`\n* `TimeoutInMinutes`\nThese properties can be configured only when using AWS Cloud Control API. This\nis because the below properties are set by the parent stack, and thus cannot be\nconfigured using CloudFormation or AWS CDK but only AWS Cloud Control API.\n* `Capabilities`\n* `Description`\n* `DisableRollback`\n* `EnableTerminationProtection`\n* `RoleARN`\n* `StackName`\n* `StackPolicyBody`\n* `StackPolicyURL`\n* `StackStatusReason`\n* `TemplateBody`\nCustomers that configure `AWS::CloudFormation::Stack` using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.\nThese read-only properties can be accessed only when using AWS Cloud Control API.\n* `ChangeSetId`\n* `CreationTime`\n* `LastUpdateTime`\n* `Outputs`\n* `ParentId`\n* `RootId`\n* `StackId`\n* `StackStatus`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html", "Properties": { "NotificationARNs": { "MarkdownDocumentation": "`NotificationARNs`\n\nThe Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs\nusing the Amazon SNS console or your Command Line Interface (CLI).\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe set value pairs that represent the parameters passed to CloudFormation\nwhen this nested stack is created. Each parameter has a name corresponding to a\nparameter defined in the embedded template and a value representing the value that you\nwant to set for the parameter.\n###### Note\nIf you use the `Ref` function to pass a parameter value to a nested\nstack, comma-delimited list parameters must be of type `String`. In other\nwords, you can't pass values that are of type `CommaDelimitedList` to\nnested stacks.\nRequired if the nested stack requires input parameters.\nWhether an update causes interruptions depends on the resources that are being\nupdated. An update never causes a nested stack to be replaced.\n*Required*: Conditional\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs to associate with this stack. CloudFormation also propagates these tags to the\nresources created in the stack. A maximum number of 50 tags can be specified.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudformation-stack-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "TemplateURL": { "MarkdownDocumentation": "`TemplateURL`\n\nThe URL of a file that contains the template body. The URL must point to a template\n(max size: 1 MB) that's located in an Amazon S3 bucket. The location for an\nAmazon S3 bucket must start with `https://`.\nWhether an update causes interruptions depends on the resources that are being\nupdated. An update never causes a nested stack to be replaced.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "TimeoutInMinutes": { "MarkdownDocumentation": "`TimeoutInMinutes`\n\nThe length of time, in minutes, that CloudFormation waits for the nested\nstack to reach the `CREATE_COMPLETE` state. The default is no timeout. When\nCloudFormation detects that the nested stack has reached the\n`CREATE_COMPLETE` state, it marks the nested stack resource as\n`CREATE_COMPLETE` in the parent stack and resumes creating the parent\nstack. If the timeout period expires before the nested stack reaches\n`CREATE_COMPLETE`, CloudFormation marks the nested stack as\nfailed and rolls back both the nested stack and parent stack.\nUpdates aren't supported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CloudFormation::StackSet": { "MarkdownDocumentation": "`AWS::CloudFormation::StackSet`\n\nThe `AWS::CloudFormation::StackSet` resource contains information about a\nStackSet. With StackSets, you can provision stacks across AWS accounts\nand Regions from a single CloudFormation template. Each stack is based on the\nsame CloudFormation template, but you can customize individual stacks using\nparameters.\n###### Important\nRun deployments to nested StackSets from the parent stack, not directly through\nthe StackSet API.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the `StackSetId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the StackSet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe input parameters for the StackSet template.\n*Required*: No\n*Type*: Array of [Parameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Parameter", "DuplicatesAllowed": false }, "StackInstancesGroup": { "MarkdownDocumentation": "`StackInstancesGroup`\n\nA group of stack instances with parameters in some specific accounts and\nRegions.\n*Required*: No\n*Type*: Array of [StackInstances](./aws-properties-cloudformation-stackset-stackinstances.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StackInstances", "DuplicatesAllowed": false }, "TemplateBody": { "MarkdownDocumentation": "`TemplateBody`\n\nThe structure that contains the template body, with a minimum length of 1 byte and a\nmaximum length of 51,200 bytes.\nYou must include either `TemplateURL` or `TemplateBody` in a\nStackSet, but you can't use both. Dynamic references in the `TemplateBody`\nmay not work correctly in all cases. It's recommended to pass templates that contain\ndynamic references through `TemplateUrl` instead.\n*Required*: Conditional\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StackSetName": { "MarkdownDocumentation": "`StackSetName`\n\nThe name to associate with the StackSet. The name must be unique in the Region where\nyou create your StackSet.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9\\-]{0,127}$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CallAs": { "MarkdownDocumentation": "`CallAs`\n\nSpecifies whether you are acting as an account administrator in the organization's\nmanagement account or as a delegated administrator in a member account.\nBy default, `SELF` is specified. Use `SELF` for StackSets with\nself-managed permissions.\n* To create a StackSet with service-managed permissions while signed in to the\n management account, specify `SELF`.\n* To create a StackSet with service-managed permissions while signed in to a\n delegated administrator account, specify `DELEGATED_ADMIN`.\n \n Your AWS account must be registered as a delegated admin in the\n management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the *CloudFormation User Guide*.\nStackSets with service-managed permissions are created in the management account,\nincluding StackSets that are created by delegated administrators.\nValid only if the permissions model is `SERVICE_MANAGED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SELF | DELEGATED_ADMIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SELF", "DELEGATED_ADMIN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OperationPreferences": { "MarkdownDocumentation": "`OperationPreferences`\n\nThe user-specified preferences for how CloudFormation performs a StackSet\noperation.\n*Required*: No\n*Type*: [OperationPreferences](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences", "UpdateType": "Mutable", "Required": false, "Type": "OperationPreferences" }, "TemplateURL": { "MarkdownDocumentation": "`TemplateURL`\n\nThe URL of a file that contains the template body. The URL must point to a template\n(max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager\ndocument. The location for an Amazon S3 bucket must start with\n`https://`.\nConditional: You must specify only one of the following parameters:\n`TemplateBody`, `TemplateURL`.\n*Required*: Conditional\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `5120`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoDeployment": { "MarkdownDocumentation": "`AutoDeployment`\n\nDescribes whether StackSets automatically deploys to AWS Organizations accounts\nthat are added to a target organization or organizational unit (OU). For more\ninformation, see [Enable or disable automatic deployments for StackSets in AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html) in the *CloudFormation User Guide*.\nRequired if the permissions model is `SERVICE_MANAGED`. (Not used with\nself-managed permissions.)\n*Required*: Conditional\n*Type*: [AutoDeployment](./aws-properties-cloudformation-stackset-autodeployment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment", "UpdateType": "Mutable", "Required": false, "Type": "AutoDeployment" }, "Capabilities": { "MarkdownDocumentation": "`Capabilities`\n\nThe capabilities that are allowed in the StackSet. Some StackSet templates might\ninclude resources that can affect permissions in your AWS account\u2014for\nexample, by creating new IAM users. For more information, see [Acknowledging IAM resources in CloudFormation\ntemplates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities) in the *CloudFormation User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PermissionModel": { "MarkdownDocumentation": "`PermissionModel`\n\nDescribes how the IAM roles required for StackSet operations are\ncreated.\n* With `SELF_MANAGED` permissions, you must create the administrator\n and execution roles required to deploy to target accounts. For more information,\n see [Grant self-managed permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) in the *CloudFormation\n User Guide*.\n* With `SERVICE_MANAGED` permissions, StackSets automatically creates\n the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see [Activate trusted access for StackSets with AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html) in\n the *CloudFormation User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SERVICE_MANAGED | SELF_MANA...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SERVICE_MANAGED", "SELF_MANAGED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AdministrationRoleARN": { "MarkdownDocumentation": "`AdministrationRoleARN`\n\nThe Amazon Resource Number (ARN) of the IAM role to use to create this\nStackSet. Specify an IAM role only if you are using customized\nadministrator roles to control which users or groups can manage specific StackSets\nwithin the same administrator account.\nUse customized administrator roles to control which users or groups can manage\nspecific StackSets within the same administrator account. For more information, see\n[Grant\nself-managed permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) in the *CloudFormation User\nGuide*.\nValid only if the permissions model is `SELF_MANAGED`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRoleName": { "MarkdownDocumentation": "`ExecutionRoleName`\n\nThe name of the IAM execution role to use to create the StackSet. If\nyou don't specify an execution role, CloudFormation uses the\n`AWSCloudFormationStackSetExecutionRole` role for the StackSet\noperation.\nValid only if the permissions model is `SELF_MANAGED`.\n*Pattern*: `[a-zA-Z_0-9+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManagedExecution": { "MarkdownDocumentation": "`ManagedExecution`\n\nDescribes whether StackSets performs non-conflicting operations concurrently and\nqueues conflicting operations.\nWhen active, StackSets performs non-conflicting operations concurrently and queues\nconflicting operations. After conflicting operations finish, StackSets starts queued\noperations in request order.\n###### Note\nIf there are already running or queued operations, StackSets queues all incoming\noperations even if they are non-conflicting.\nYou can't modify your StackSet's execution configuration while there are running\nor queued operations for that StackSet.\nWhen inactive (default), StackSets performs one operation at a time in request\norder.\n*Required*: No\n*Type*: [ManagedExecution](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution", "UpdateType": "Mutable", "Required": false, "Type": "ManagedExecution" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs to associate with this stack. CloudFormation also propagates these tags to\nsupported resources in the stack. You can specify a maximum number of 50 tags.\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you\nspecify an empty value, CloudFormation removes all associated tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudformation-stackset-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "StackSetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`StackSetId`\n\nReturns the unique identifier of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#StackSetId-fn::getatt" } } }, "AWS::CloudFormation::TypeActivation": { "MarkdownDocumentation": "`AWS::CloudFormation::TypeActivation`\n\nThe `AWS::CloudFormation::TypeActivation` resource activates a public\nthird-party extension, making it available for use in stack templates.\nFor information about the CloudFormation registry, see [Managing\nextensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the\n*CloudFormation User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the activated\nextension, in this account and Region.\n`{ \"Ref\": \"arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Example\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html", "Properties": { "MajorVersion": { "MarkdownDocumentation": "`MajorVersion`\n\nThe major version of this extension you want to activate, if multiple major versions are\navailable. The default is the latest major version. CloudFormation uses the latest available\n*minor* version of the major version selected.\nYou can specify `MajorVersion` or `VersionBump`, but not\nboth.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe name of the IAM execution role to use to activate the extension.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.+:iam::[0-9]{12}:role/.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeName": { "MarkdownDocumentation": "`TypeName`\n\nThe name of the extension.\nConditional: You must specify `PublicTypeArn`, or `TypeName`,\n`Type`, and `PublisherId`.\n*Required*: Conditional\n*Type*: String\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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe extension type.\nConditional: You must specify `PublicTypeArn`, or `TypeName`,\n`Type`, and `PublisherId`.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `RESOURCE | MODULE | HOOK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RESOURCE", "MODULE", "HOOK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PublicTypeArn": { "MarkdownDocumentation": "`PublicTypeArn`\n\nThe Amazon Resource Number (ARN) of the public extension.\nConditional: You must specify `PublicTypeArn`, or `TypeName`,\n`Type`, and `PublisherId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoUpdate": { "MarkdownDocumentation": "`AutoUpdate`\n\nWhether to automatically update the extension in this account and Region when a new\n*minor* version is published by the extension publisher. Major versions\nreleased by the publisher must be manually updated.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LoggingConfig": { "MarkdownDocumentation": "`LoggingConfig`\n\nSpecifies logging configuration information for an extension.\n*Required*: No\n*Type*: [LoggingConfig](./aws-properties-cloudformation-typeactivation-loggingconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig", "UpdateType": "Immutable", "Required": false, "Type": "LoggingConfig" }, "PublisherId": { "MarkdownDocumentation": "`PublisherId`\n\nThe ID of the extension publisher.\nConditional: You must specify `PublicTypeArn`, or `TypeName`,\n`Type`, and `PublisherId`.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[0-9a-zA-Z-]{1,40}`\n*Minimum*: `1`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VersionBump": { "MarkdownDocumentation": "`VersionBump`\n\nManually updates a previously-activated type to a new major or minor version, if\navailable. You can also use this parameter to update the value of\n`AutoUpdate`.\n* `MAJOR`: CloudFormation updates the extension to the newest major version, if\n one is available.\n* `MINOR`: CloudFormation updates the extension to the newest minor version, if\n one is available.\n*Required*: No\n*Type*: String\n*Allowed values*: `MAJOR | MINOR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MAJOR", "MINOR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TypeNameAlias": { "MarkdownDocumentation": "`TypeNameAlias`\n\nAn alias to assign to the public extension in this account and Region. If you specify an\nalias for the extension, CloudFormation treats the alias as the extension type name within this\naccount and Region. You must use the alias to refer to the extension in your templates, API\ncalls, and CloudFormation console.\nAn extension alias must be unique within a given account and Region. You can activate the\nsame public resource multiple times in the same account and Region, using different type name\naliases.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`\n*Minimum*: `10`\n*Maximum*: `204`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the activated extension in this account and\nRegion.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#Arn-fn::getatt" } } }, "AWS::CloudFormation::WaitCondition": { "Attributes": { "Data": { "PrimitiveType": "Json", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#Data-fn::getatt" } }, "MarkdownDocumentation": "`AWS::CloudFormation::WaitCondition`\n\nThe `AWS::CloudFormation::WaitCondition` resource provides a way to\ncoordinate stack resource creation with configuration actions that are external to the\nstack creation or to track the status of a configuration process. In these situations,\nwe recommend that you associate a `CreationPolicy` attribute with the wait\ncondition instead of using a wait condition handle. For more information and an example,\nsee [CreationPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-attribute-creationpolicy.html) in the *CloudFormation User\nGuide*. If you use a `CreationPolicy` with a wait condition,\ndon't specify any of the wait condition's properties.\n###### Note\nIf you use AWS PrivateLink, resources in the VPC that respond to wait\nconditions must have access to CloudFormation, specific Amazon S3\nbuckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3, CloudFormation\nwon't receive a response and the stack operation fails. For more information, see\n[Access\nCloudFormation using an interface endpoint (AWS PrivateLink)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html) in the *CloudFormation User\nGuide*.\n###### Important\nFor Amazon EC2 and Auto Scaling resources, we recommend that you use\na `CreationPolicy` attribute instead of wait conditions. Add a\n`CreationPolicy` attribute to those resources, and use the\n`cfn-signal` helper script to signal when an instance creation\nprocess has completed successfully.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html", "Properties": { "Count": { "MarkdownDocumentation": "`Count`\n\nThe number of success signals that CloudFormation must receive before it\ncontinues the stack creation process. When the wait condition receives the requisite\nnumber of success signals, CloudFormation resumes the creation of the stack. If\nthe wait condition doesn't receive the specified number of success signals before the\nTimeout period expires, CloudFormation assumes that the wait condition has\nfailed and rolls the stack back.\nUpdates aren't supported.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "Handle": { "MarkdownDocumentation": "`Handle`\n\nA reference to the wait condition handle used to signal this wait condition. Use the\n`Ref` intrinsic function to specify an [AWS::CloudFormation::WaitConditionHandle](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cloudformation-waitconditionhandle.html) resource.\nAnytime you add a `WaitCondition` resource during a stack update, you must\nassociate the wait condition with a new WaitConditionHandle resource. Don't reuse an old\nwait condition handle that has already been defined in the template. If you reuse a wait\ncondition handle, the wait condition might evaluate old signals from a previous create\nor update stack command.\nUpdates aren't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nThe length of time (in seconds) to wait for the number of signals that the\n`Count` property specifies. `Timeout` is a minimum-bound\nproperty, meaning the timeout occurs no sooner than the time you specify, but can occur\nshortly thereafter. The maximum time that can be specified for this property is 12 hours\n(43200 seconds).\nUpdates aren't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::CloudFormation::WaitConditionHandle": { "MarkdownDocumentation": "`AWS::CloudFormation::WaitConditionHandle`\n\nThe `AWS::CloudFormation::WaitConditionHandle` type has no properties. When\nyou reference the `WaitConditionHandle` resource by using the\n`Ref` function, CloudFormation returns a presigned URL. You pass\nthis URL to applications or scripts that are running on your Amazon EC2\ninstances to send signals to that URL. An associated\n`AWS::CloudFormation::WaitCondition` resource checks the URL for the\nrequired number of success signals or for a failure signal.\nFor more information, see [Create wait\nconditions in a CloudFormation template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html) in the *CloudFormation User Guide*.\nAnytime you add a `WaitCondition` resource during a stack update or update\na resource with a wait condition, you must associate the wait condition with a new\n`WaitConditionHandle` resource. Don't reuse an old wait condition handle\nthat has already been defined in the template. If you reuse a wait condition handle, the\nwait condition might evaluate old signals from a previous create or update stack\ncommand.\nUpdates aren't supported for this resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html", "Properties": {} }, "AWS::CloudFront::AnycastIpList": { "MarkdownDocumentation": "`AWS::CloudFront::AnycastIpList`\n\nAn Anycast static IP list. For more information, see [Request Anycast static IPs to use for allowlisting](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/request-static-ips.html) in the *Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Anycast IP list. For example:\n`aip_7XdPQUqEXAMPLE283z455j`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address type for the Anycast static IP list.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | dualstack...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "dualstack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#cfn-cloudfront-anycastiplist-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpCount": { "MarkdownDocumentation": "`IpCount`\n\nThe number of IP addresses in the Anycast static IP list.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#cfn-cloudfront-anycastiplist-ipcount", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "IpamCidrConfigs": { "MarkdownDocumentation": "`IpamCidrConfigs`\n\nA list of IPAM CIDR configurations that define the IP address ranges, IPAM pools, and associated Anycast IP addresses.\n*Required*: No\n*Type*: Array of [IpamCidrConfig](./aws-properties-cloudfront-anycastiplist-ipamcidrconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#cfn-cloudfront-anycastiplist-ipamcidrconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpamCidrConfig", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA complex type that contains zero or more `Tag` elements.\n*Required*: No\n*Type*: [Tags](./aws-properties-cloudfront-anycastiplist-tags.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#cfn-cloudfront-anycastiplist-tags", "UpdateType": "Immutable", "Required": false, "Type": "Tags" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Anycast static IP list.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_]{1,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#cfn-cloudfront-anycastiplist-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AnycastIpList.Name": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.Name-fn::getatt" }, "AnycastIpList.Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.Id-fn::getatt" }, "AnycastIpList.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.Arn-fn::getatt" }, "AnycastIpList.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.Status-fn::getatt" }, "AnycastIpList.LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.LastModifiedTime-fn::getatt" }, "AnycastIpList.IpamCidrConfigResults": { "Type": "List", "ItemType": "IpamCidrConfigResult", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.IpamCidrConfigResults-fn::getatt" }, "IpamCidrConfigResults": { "Type": "List", "ItemType": "IpamCidrConfigResult", "MarkdownDocumentation": "`IpamCidrConfigResults`\n\nThe results for the IPAM CIDRs that defines a specific IP address range, IPAM pool, and associated Anycast IP address.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#IpamCidrConfigResults-fn::getatt" }, "AnycastIpList": { "Type": "AnycastIpList", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList-fn::getatt" }, "AnycastIpList.AnycastIps": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.AnycastIps-fn::getatt" }, "ETag": { "PrimitiveType": "String", "MarkdownDocumentation": "`ETag`\n\nA complex type that contains `Tag` key and `Tag` value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#ETag-fn::getatt" }, "AnycastIpList.IpCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.IpCount-fn::getatt" }, "AnycastIpList.IpAddressType": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#AnycastIpList.IpAddressType-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the Anycast static IP list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-anycastiplist.html#Id-fn::getatt" } } }, "AWS::CloudFront::CachePolicy": { "MarkdownDocumentation": "`AWS::CloudFront::CachePolicy`\n\nA cache policy.\nWhen it's attached to a cache behavior, the cache policy determines the\nfollowing:\n* The values that CloudFront includes in the cache key. These values can include HTTP\n headers, cookies, and URL query strings. CloudFront uses the cache key to find an\n object in its cache that it can return to the viewer.\n* The default, minimum, and maximum time to live (TTL) values that you want\n objects to stay in the CloudFront cache.\nThe headers, cookies, and query strings that are included in the cache key are also included\nin requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a\nvalid object in its cache that matches the request's cache key. If you want to send\nvalues to the origin but *not* include them in the cache key, use\n`OriginRequestPolicy`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the cache policy ID. For example:\n`2766f7b2-75c5-41c6-8f06-bf4303a2f2f5`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cachepolicy.html", "Properties": { "CachePolicyConfig": { "MarkdownDocumentation": "`CachePolicyConfig`\n\nThe cache policy configuration.\n*Required*: Yes\n*Type*: [CachePolicyConfig](./aws-properties-cloudfront-cachepolicy-cachepolicyconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cachepolicy.html#cfn-cloudfront-cachepolicy-cachepolicyconfig", "UpdateType": "Mutable", "Required": true, "Type": "CachePolicyConfig" } }, "Attributes": { "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe date and time when the cache policy was last modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cachepolicy.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier for the cache policy. For example:\n`2766f7b2-75c5-41c6-8f06-bf4303a2f2f5`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cachepolicy.html#Id-fn::getatt" } } }, "AWS::CloudFront::CloudFrontOriginAccessIdentity": { "MarkdownDocumentation": "`AWS::CloudFront::CloudFrontOriginAccessIdentity`\n\nThe request to create a new origin access identity (OAI). An origin access identity is\na special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all\nor just some of your Amazon S3 content. For more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in\nthe *Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the origin access identity, such as\n`E15MNIMTCFKK4C`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html", "Properties": { "CloudFrontOriginAccessIdentityConfig": { "MarkdownDocumentation": "`CloudFrontOriginAccessIdentityConfig`\n\nThe current configuration information for the identity.\n*Required*: Yes\n*Type*: [CloudFrontOriginAccessIdentityConfig](./aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig", "UpdateType": "Mutable", "Required": true, "Type": "CloudFrontOriginAccessIdentityConfig" } }, "Attributes": { "S3CanonicalUserId": { "PrimitiveType": "String", "MarkdownDocumentation": "`S3CanonicalUserId`\n\nThe Amazon S3 canonical user ID for the origin access identity, used when\ngiving the origin access identity read permission to an object in Amazon S3. For\nexample:\n`b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html#S3CanonicalUserId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID for the origin access identity, for example, `E74FTE3AJFJ256A`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html#Id-fn::getatt" } } }, "AWS::CloudFront::ConnectionFunction": { "MarkdownDocumentation": "`AWS::CloudFront::ConnectionFunction`\n\nA connection function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html", "Properties": { "ConnectionFunctionConfig": { "MarkdownDocumentation": "`ConnectionFunctionConfig`\n\nContains configuration information about a CloudFront function.\n*Required*: Yes\n*Type*: [ConnectionFunctionConfig](./aws-properties-cloudfront-connectionfunction-connectionfunctionconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#cfn-cloudfront-connectionfunction-connectionfunctionconfig", "UpdateType": "Mutable", "Required": true, "Type": "ConnectionFunctionConfig" }, "AutoPublish": { "MarkdownDocumentation": "`AutoPublish`\n\nA flag that determines whether to automatically publish the function to the\n`LIVE` stage when it\u2019s created. To automatically publish to the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#cfn-cloudfront-connectionfunction-autopublish", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ConnectionFunctionCode": { "MarkdownDocumentation": "`ConnectionFunctionCode`\n\nThe code for the connection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#cfn-cloudfront-connectionfunction-connectionfunctioncode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA complex type that contains zero or more `Tag` elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudfront-connectionfunction-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#cfn-cloudfront-connectionfunction-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe connection function name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-_]{1,64}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#cfn-cloudfront-connectionfunction-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe connection function status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#Status-fn::getatt" }, "ConnectionFunctionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectionFunctionArn`\n\nThe connection function Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#ConnectionFunctionArn-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe connection function created time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#CreatedTime-fn::getatt" }, "ETag": { "PrimitiveType": "String", "MarkdownDocumentation": "`ETag`\n\nA complex type that contains `Tag` key and `Tag` value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#ETag-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe connection function last modified time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#LastModifiedTime-fn::getatt" }, "Stage": { "PrimitiveType": "String", "MarkdownDocumentation": "`Stage`\n\nThe connection function stage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#Stage-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe connection function ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectionfunction.html#Id-fn::getatt" } } }, "AWS::CloudFront::ConnectionGroup": { "MarkdownDocumentation": "`AWS::CloudFront::ConnectionGroup`\n\nThe connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html", "Properties": { "Ipv6Enabled": { "MarkdownDocumentation": "`Ipv6Enabled`\n\nIPv6 is enabled for the connection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#cfn-cloudfront-connectiongroup-ipv6enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AnycastIpListId": { "MarkdownDocumentation": "`AnycastIpListId`\n\nThe ID of the Anycast static IP 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#cfn-cloudfront-connectiongroup-anycastiplistid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhether the connection group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#cfn-cloudfront-connectiongroup-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA complex type that contains zero or more `Tag` elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudfront-connectiongroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#cfn-cloudfront-connectiongroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the connection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#cfn-cloudfront-connectiongroup-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the connection group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#Status-fn::getatt" }, "IsDefault": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefault`\n\nWhether the connection group is the default connection group for the distribution tenants.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#IsDefault-fn::getatt" }, "RoutingEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoutingEndpoint`\n\nThe routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#RoutingEndpoint-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe date and time when the connection group was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#CreatedTime-fn::getatt" }, "ETag": { "PrimitiveType": "String", "MarkdownDocumentation": "`ETag`\n\nThe current version of the connection group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#ETag-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe date and time when the connection group was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the connection group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the connection group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-connectiongroup.html#Arn-fn::getatt" } } }, "AWS::CloudFront::ContinuousDeploymentPolicy": { "MarkdownDocumentation": "`AWS::CloudFront::ContinuousDeploymentPolicy`\n\nCreates a continuous deployment policy that routes a subset of production traffic\nfrom a primary distribution to a staging distribution.\nAfter you create and update a staging distribution, you can use a continuous\ndeployment policy to incrementally move traffic to the staging distribution. This enables\nyou to test changes to a distribution's configuration before moving all of your\nproduction traffic to the new configuration.\nFor more information, see [Using\nCloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html)\nin the *Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier for the continuous deployment\npolicy.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-continuousdeploymentpolicy.html", "Properties": { "ContinuousDeploymentPolicyConfig": { "MarkdownDocumentation": "`ContinuousDeploymentPolicyConfig`\n\nContains the configuration for a continuous deployment policy.\n*Required*: Yes\n*Type*: [ContinuousDeploymentPolicyConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-continuousdeploymentpolicy.html#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig", "UpdateType": "Mutable", "Required": true, "Type": "ContinuousDeploymentPolicyConfig" } }, "Attributes": { "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe date and time when the continuous deployment policy was last modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-continuousdeploymentpolicy.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of the cotinuous deployment policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-continuousdeploymentpolicy.html#Id-fn::getatt" } } }, "AWS::CloudFront::Distribution": { "MarkdownDocumentation": "`AWS::CloudFront::Distribution`\n\nA distribution tells CloudFront where you want content to be delivered from, and the details\nabout how to track and manage content delivery.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the CloudFront\ndistribution ID. For example: `E27LVI50CSW06W`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html", "Properties": { "DistributionConfig": { "MarkdownDocumentation": "`DistributionConfig`\n\nThe distribution's configuration.\n*Required*: Yes\n*Type*: [DistributionConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-distributionconfig", "UpdateType": "Mutable", "Required": true, "Type": "DistributionConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA complex type that contains zero or more `Tag` elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudfront-distribution-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nThe domain name of the resource, such as `d111111abcdef8.cloudfront.net`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#DomainName-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe distribution's identifier. For example: `E1U5RQF7T870K0`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#Id-fn::getatt" } } }, "AWS::CloudFront::DistributionTenant": { "MarkdownDocumentation": "`AWS::CloudFront::DistributionTenant`\n\nThe distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html", "Properties": { "Domains": { "MarkdownDocumentation": "`Domains`\n\nThe domains associated with the distribution tenant.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-domains", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nA list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.\n*Required*: No\n*Type*: Array of [Parameter](./aws-properties-cloudfront-distributiontenant-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Parameter", "DuplicatesAllowed": true }, "Customizations": { "MarkdownDocumentation": "`Customizations`\n\nCustomizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and AWS WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.\n*Required*: No\n*Type*: [Customizations](./aws-properties-cloudfront-distributiontenant-customizations.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-customizations", "UpdateType": "Mutable", "Required": false, "Type": "Customizations" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ManagedCertificateRequest": { "MarkdownDocumentation": "`ManagedCertificateRequest`\n\nAn object that represents the request for the Amazon CloudFront managed ACM certificate.\n*Required*: No\n*Type*: [ManagedCertificateRequest](./aws-properties-cloudfront-distributiontenant-managedcertificaterequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-managedcertificaterequest", "UpdateType": "Mutable", "Required": false, "Type": "ManagedCertificateRequest" }, "DistributionId": { "MarkdownDocumentation": "`DistributionId`\n\nThe ID of the multi-tenant 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-distributionid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ConnectionGroupId": { "MarkdownDocumentation": "`ConnectionGroupId`\n\nThe ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-connectiongroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA complex type that contains zero or more `Tag` elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudfront-distributiontenant-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the distribution tenant.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#Status-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe date and time when the distribution tenant was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#CreatedTime-fn::getatt" }, "ETag": { "PrimitiveType": "String", "MarkdownDocumentation": "`ETag`\n\nThe current version of the distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#ETag-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe date and time when the distribution tenant was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the distribution tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#Arn-fn::getatt" }, "DomainResults": { "Type": "List", "ItemType": "DomainResult", "MarkdownDocumentation": "`DomainResults`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#DomainResults-fn::getatt" } } }, "AWS::CloudFront::Function": { "MarkdownDocumentation": "`AWS::CloudFront::Function`\n\nCreates a CloudFront function.\nTo create a function, you provide the function code and some configuration information\nabout the function. The response contains an Amazon Resource Name (ARN) that uniquely\nidentifies the function, and the function\u2019s stage.\nBy default, when you create a function, it\u2019s in the `DEVELOPMENT` stage. In this\nstage, you can [test the function](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/test-function.html) in the CloudFront console (or with\n`TestFunction` in the CloudFront API).\nWhen you\u2019re ready to use your function with a CloudFront distribution, publish the\nfunction to the `LIVE` stage. You can do this in the CloudFront console, with\n`PublishFunction` in the CloudFront API, or by updating the\n`AWS::CloudFront::Function` resource with the `AutoPublish`\nproperty set to `true`. When the function is published to the\n`LIVE` stage, you can attach it to a distribution\u2019s cache behavior, using the\nfunction\u2019s ARN.\nTo automatically publish the function to the `LIVE` stage when it\u2019s\ncreated, set the `AutoPublish` property to `true`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html", "Properties": { "FunctionConfig": { "MarkdownDocumentation": "`FunctionConfig`\n\nContains configuration information about a CloudFront function.\n*Required*: Yes\n*Type*: [FunctionConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functionconfig", "UpdateType": "Mutable", "Required": true, "Type": "FunctionConfig" }, "FunctionMetadata": { "MarkdownDocumentation": "`FunctionMetadata`\n\nContains metadata about a CloudFront function.\n*Required*: No\n*Type*: [FunctionMetadata](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functionmetadata", "UpdateType": "Mutable", "Required": false, "Type": "FunctionMetadata" }, "AutoPublish": { "MarkdownDocumentation": "`AutoPublish`\n\nA flag that determines whether to automatically publish the function to the\n`LIVE` stage when it\u2019s created. To automatically publish to the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-autopublish", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FunctionCode": { "MarkdownDocumentation": "`FunctionCode`\n\nThe function code. For more information about writing a CloudFront function, see [Writing\nfunction code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functioncode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name to identify the function.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-_]{1,64}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "FunctionARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`FunctionARN`\n\nThe ARN of the function. For example:\n`arn:aws:cloudfront::123456789012:function/ExampleFunction`.\nTo get the function ARN, use the following syntax:\n`!GetAtt\nFunction_Logical_ID.FunctionMetadata.FunctionARN`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#FunctionARN-fn::getatt" }, "FunctionMetadata.FunctionARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`FunctionMetadata.FunctionARN`\n\nThe Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the\nfunction.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#FunctionMetadata.FunctionARN-fn::getatt" }, "Stage": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#Stage-fn::getatt" } } }, "AWS::CloudFront::KeyGroup": { "MarkdownDocumentation": "`AWS::CloudFront::KeyGroup`\n\nA key group.\nA key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the key group. For example:\n`e9fcd3cf-f3f4-4b61-bd85-9ba9e091b309`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html", "Properties": { "KeyGroupConfig": { "MarkdownDocumentation": "`KeyGroupConfig`\n\nThe key group configuration.\n*Required*: Yes\n*Type*: [KeyGroupConfig](./aws-properties-cloudfront-keygroup-keygroupconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html#cfn-cloudfront-keygroup-keygroupconfig", "UpdateType": "Mutable", "Required": true, "Type": "KeyGroupConfig" } }, "Attributes": { "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe date and time when the key group was last modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier for the key group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html#Id-fn::getatt" } } }, "AWS::CloudFront::KeyValueStore": { "MarkdownDocumentation": "`AWS::CloudFront::KeyValueStore`\n\nThe key value store. Use this to separate data from function code, allowing you to update\ndata without having to publish a new version of a function. The key value store holds\nkeys and their corresponding values.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keyvaluestore.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\nA comment for the key value 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keyvaluestore.html#cfn-cloudfront-keyvaluestore-comment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImportSource": { "MarkdownDocumentation": "`ImportSource`\n\nThe import source for the key value store.\n*Required*: No\n*Type*: [ImportSource](./aws-properties-cloudfront-keyvaluestore-importsource.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keyvaluestore.html#cfn-cloudfront-keyvaluestore-importsource", "UpdateType": "Mutable", "Required": false, "Type": "ImportSource" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the key value 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keyvaluestore.html#cfn-cloudfront-keyvaluestore-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the key value store. For more information, see [Key value store statuses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/kvs-with-functions-create.html#key-value-store-status) in the *Amazon CloudFront Developer Guide.*\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keyvaluestore.html#Status-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique Id for the key value store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keyvaluestore.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the key value store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keyvaluestore.html#Arn-fn::getatt" } } }, "AWS::CloudFront::MonitoringSubscription": { "MarkdownDocumentation": "`AWS::CloudFront::MonitoringSubscription`\n\nA monitoring subscription. This structure contains information about whether\nadditional CloudWatch metrics are enabled for a given CloudFront distribution.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier for the monitoring subscription, which\nis the same as the distribution ID of the distribution that the subscription is for.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-monitoringsubscription.html", "Properties": { "MonitoringSubscription": { "MarkdownDocumentation": "`MonitoringSubscription`\n\nA subscription configuration for additional CloudWatch metrics.\n*Required*: Yes\n*Type*: [MonitoringSubscription](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-monitoringsubscription.html#cfn-cloudfront-monitoringsubscription-monitoringsubscription", "UpdateType": "Mutable", "Required": true, "Type": "MonitoringSubscription" }, "DistributionId": { "MarkdownDocumentation": "`DistributionId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-monitoringsubscription.html#cfn-cloudfront-monitoringsubscription-distributionid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudFront::OriginAccessControl": { "MarkdownDocumentation": "`AWS::CloudFront::OriginAccessControl`\n\nCreates a new origin access control in CloudFront. After you create an origin access\ncontrol, you can add it to an origin in a CloudFront distribution so that CloudFront sends\nauthenticated (signed) requests to the origin.\nThis makes it possible to block public access to the origin, allowing viewers (users) to\naccess the origin's content only through CloudFront.\nFor more information about using a CloudFront origin access control, see [Restricting access to an AWS origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the\n*Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html", "Properties": { "OriginAccessControlConfig": { "MarkdownDocumentation": "`OriginAccessControlConfig`\n\nThe origin access control.\n*Required*: Yes\n*Type*: [OriginAccessControlConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig", "UpdateType": "Mutable", "Required": true, "Type": "OriginAccessControlConfig" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the origin access control.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html#Id-fn::getatt" } } }, "AWS::CloudFront::OriginRequestPolicy": { "MarkdownDocumentation": "`AWS::CloudFront::OriginRequestPolicy`\n\nAn origin request policy.\nWhen it's attached to a cache behavior, the origin request policy determines the\nvalues that CloudFront includes in requests that it sends to the origin. Each request that\nCloudFront sends to the origin includes the following:\n* The request body and the URL path (without the domain name) from the viewer\n request.\n* The headers that CloudFront automatically includes in every origin request,\n including `Host`, `User-Agent`, and\n `X-Amz-Cf-Id`.\n* All HTTP headers, cookies, and URL query strings that are specified in the\n cache policy or the origin request policy. These can include items from the\n viewer request and, in the case of headers, additional ones that are added by\n CloudFront.\nCloudFront sends a request when it can't find an object in its cache that matches the\nrequest. If you want to send values to the origin and also include them in the cache\nkey, use `CachePolicy`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the origin request policy ID. For example:\n`befd7079-9bbc-4ebf-8ade-498a3694176c`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html", "Properties": { "OriginRequestPolicyConfig": { "MarkdownDocumentation": "`OriginRequestPolicyConfig`\n\nThe origin request policy configuration.\n*Required*: Yes\n*Type*: [OriginRequestPolicyConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig", "UpdateType": "Mutable", "Required": true, "Type": "OriginRequestPolicyConfig" } }, "Attributes": { "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe date and time when the origin request policy was last modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier for the origin request policy. For example:\n`befd7079-9bbc-4ebf-8ade-498a3694176c`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html#Id-fn::getatt" } } }, "AWS::CloudFront::PublicKey": { "MarkdownDocumentation": "`AWS::CloudFront::PublicKey`\n\nA 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).\nCloudFront supports signed URLs and signed cookies with RSA 2048 or ECDSA 256 key signatures. Field-level encryption is only compatible with RSA 2048 key signatures.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the public key. For example:\n`K36X4X2EO997HM`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html", "Properties": { "PublicKeyConfig": { "MarkdownDocumentation": "`PublicKeyConfig`\n\nConfiguration 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html#cfn-cloudfront-publickey-publickeyconfig", "UpdateType": "Mutable", "Required": true, "Type": "PublicKeyConfig" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe date and time when the public key was uploaded.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html#CreatedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of the public key.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html#Id-fn::getatt" } } }, "AWS::CloudFront::RealtimeLogConfig": { "MarkdownDocumentation": "`AWS::CloudFront::RealtimeLogConfig`\n\nA real-time log configuration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the real-time log\nconfiguration. For example:\n`arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html", "Properties": { "Fields": { "MarkdownDocumentation": "`Fields`\n\nA list of fields that are included in each real-time log record. In an API response,\nthe fields are provided in the same order in which they are sent to the Amazon Kinesis data\nstream.\nFor more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the\n*Amazon CloudFront Developer Guide*.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-fields", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EndPoints": { "MarkdownDocumentation": "`EndPoints`\n\nContains information about the Amazon Kinesis data stream where you are sending real-time\nlog data for this real-time log configuration.\n*Required*: Yes\n*Type*: Array of [EndPoint](./aws-properties-cloudfront-realtimelogconfig-endpoint.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-endpoints", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "EndPoint", "DuplicatesAllowed": true }, "SamplingRate": { "MarkdownDocumentation": "`SamplingRate`\n\nThe sampling rate for this real-time log configuration. The sampling rate determines\nthe percentage of viewer requests that are represented in the real-time log data. The\nsampling rate is an integer between 1 and 100, inclusive.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-samplingrate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe unique name of this real-time log 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the real-time log configuration. For example:\n`arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#Arn-fn::getatt" } } }, "AWS::CloudFront::ResponseHeadersPolicy": { "MarkdownDocumentation": "`AWS::CloudFront::ResponseHeadersPolicy`\n\nA response headers policy.\nA response headers policy contains information about a set of HTTP response headers.\nAfter you create a response headers policy, you can use its ID to attach it to one or more\ncache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the\nresponse headers policy affects the HTTP headers that CloudFront includes in HTTP responses to\nrequests that match the cache behavior. CloudFront adds or removes response headers according\nto the configuration of the response headers policy.\nFor more information, see [Adding or removing HTTP headers in CloudFront responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) in the\n*Amazon CloudFront Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the response headers policy ID. For example:\n`57f99797-3b20-4e1b-a728-27972a74082a`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-responseheaderspolicy.html", "Properties": { "ResponseHeadersPolicyConfig": { "MarkdownDocumentation": "`ResponseHeadersPolicyConfig`\n\nA response headers policy configuration.\n*Required*: Yes\n*Type*: [ResponseHeadersPolicyConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-responseheaderspolicy.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig", "UpdateType": "Mutable", "Required": true, "Type": "ResponseHeadersPolicyConfig" } }, "Attributes": { "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe date and time when the response headers policy was last modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-responseheaderspolicy.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier for the response headers policy. For example:\n`57f99797-3b20-4e1b-a728-27972a74082a`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-responseheaderspolicy.html#Id-fn::getatt" } } }, "AWS::CloudFront::StreamingDistribution": { "MarkdownDocumentation": "`AWS::CloudFront::StreamingDistribution`\n\nThis resource is deprecated.\nAmazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020.\nFor more information, [read the announcement](https://forums.aws.amazon.com/ann.jspa?annID=7356) on the Amazon CloudFront discussion forum.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the streaming distribution ID, such as\n`E1E7FEN9T35R9W`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html", "Attributes": { "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nThe domain name of the resource, such as `d111111abcdef8.cloudfront.net`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html#DomainName-fn::getatt" } }, "Properties": { "StreamingDistributionConfig": { "Type": "StreamingDistributionConfig", "Required": true, "MarkdownDocumentation": "`StreamingDistributionConfig`\n\nThe current configuration information for the RTMP distribution.\n*Required*: Yes\n*Type*: [StreamingDistributionConfig](./aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Tags`\n\nA complex type that contains zero or more `Tag` elements.\n*Required*: Yes\n*Type*: Array of [Tag](./aws-properties-cloudfront-streamingdistribution-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html#cfn-cloudfront-streamingdistribution-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::CloudFront::TrustStore": { "MarkdownDocumentation": "`AWS::CloudFront::TrustStore`\n\nA trust store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html", "Properties": { "CaCertificatesBundleSource": { "MarkdownDocumentation": "`CaCertificatesBundleSource`\n\nA CA certificates bundle source.\n*Required*: No\n*Type*: [CaCertificatesBundleSource](./aws-properties-cloudfront-truststore-cacertificatesbundlesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#cfn-cloudfront-truststore-cacertificatesbundlesource", "UpdateType": "Mutable", "Required": false, "Type": "CaCertificatesBundleSource" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA complex type that contains zero or more `Tag` elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudfront-truststore-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#cfn-cloudfront-truststore-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe trust store's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#cfn-cloudfront-truststore-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe trust store's status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#Status-fn::getatt" }, "ETag": { "PrimitiveType": "String", "MarkdownDocumentation": "`ETag`\n\nThe version identifier for the current version of the trust store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#ETag-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe trust store's last modified time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe trust store's ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#Id-fn::getatt" }, "NumberOfCaCertificates": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`NumberOfCaCertificates`\n\nThe trust store's number of CA certificates.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#NumberOfCaCertificates-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe trust store's Amazon Resource Name (ARN).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-truststore.html#Arn-fn::getatt" } } }, "AWS::CloudFront::VpcOrigin": { "MarkdownDocumentation": "`AWS::CloudFront::VpcOrigin`\n\nAn Amazon CloudFront VPC origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html", "Properties": { "VpcOriginEndpointConfig": { "MarkdownDocumentation": "`VpcOriginEndpointConfig`\n\nThe VPC origin endpoint configuration.\n*Required*: Yes\n*Type*: [VpcOriginEndpointConfig](./aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig", "UpdateType": "Mutable", "Required": true, "Type": "VpcOriginEndpointConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA complex type that contains zero or more `Tag` elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudfront-vpcorigin-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe VPC origin status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#Status-fn::getatt" }, "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe account ID of the AWS account that owns the VPC origin.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#AccountId-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe VPC origin created time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#CreatedTime-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe VPC origin last modified time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#LastModifiedTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe VPC origin ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe VPC origin ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#Arn-fn::getatt" } } }, "AWS::CloudTrail::Channel": { "MarkdownDocumentation": "`AWS::CloudTrail::Channel`\n\nContains information about a returned CloudTrail channel.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function,\n`Ref` returns the resource name.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html", "Properties": { "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nOne or more event data stores to which events arriving through a channel will be logged.\n*Required*: No\n*Type*: Array of [Destination](./aws-properties-cloudtrail-channel-destination.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-destinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Destination", "DuplicatesAllowed": false }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe name of the partner or external event source. You cannot change this name after you create the\nchannel. A maximum of one channel is allowed per source.\nA source can be either `Custom` for all valid non-AWS\nevents, 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*Pattern*: `(.*)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-source", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudtrail-channel-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the channel.\n*Required*: No\n*Type*: String\n*Pattern*: `(^[a-zA-Z0-9._\\-]+$)`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ChannelArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ChannelArn`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the CloudTrail channel,\nsuch as `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#ChannelArn-fn::getatt" } } }, "AWS::CloudTrail::Dashboard": { "MarkdownDocumentation": "`AWS::CloudTrail::Dashboard`\n\nCreates a custom dashboard or the Highlights dashboard.\n* **Custom dashboards** - Custom dashboards allow you to query\n events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.\n* **Highlights dashboard** - You can create\n the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores.\n CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.\nCloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the `StartQuery` operation on your behalf. To provide permissions, run the `PutResourcePolicy` operation to attach a resource-based policy to each event data store. For more information,\nsee [Example: Allow CloudTrail to run queries to populate a dashboard](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-eds-dashboard) in the *AWS CloudTrail User Guide*.\nTo set a refresh schedule, CloudTrail must be granted permissions to run the `StartDashboardRefresh` operation to refresh the dashboard on your behalf. To provide permissions, run the `PutResourcePolicy` operation to attach a resource-based policy to the dashboard. For more information,\nsee [Resource-based policy example for a dashboard](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-dashboards) in the *AWS CloudTrail User Guide*.\nFor more information about dashboards, see [CloudTrail Lake dashboards](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-dashboard.html) in the *AWS CloudTrail User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html", "Properties": { "Widgets": { "MarkdownDocumentation": "`Widgets`\n\nAn array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.\nYou do not need to specify widgets for the Highlights dashboard.\n*Required*: No\n*Type*: Array of [Widget](./aws-properties-cloudtrail-dashboard-widget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-widgets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Widget", "DuplicatesAllowed": false }, "TerminationProtectionEnabled": { "MarkdownDocumentation": "`TerminationProtectionEnabled`\n\nSpecifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-terminationprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RefreshSchedule": { "MarkdownDocumentation": "`RefreshSchedule`\n\nThe schedule for a dashboard refresh.\n*Required*: No\n*Type*: [RefreshSchedule](./aws-properties-cloudtrail-dashboard-refreshschedule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-refreshschedule", "UpdateType": "Mutable", "Required": false, "Type": "RefreshSchedule" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudtrail-dashboard-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the dashboard. The name must be unique to your account.\nTo create the Highlights dashboard, the name must be `AWSCloudTrail-Highlights`.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#Status-fn::getatt" }, "UpdatedTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedTimestamp`\n\nThe timestamp that shows when the dashboard was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#UpdatedTimestamp-fn::getatt" }, "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nThe type of dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#Type-fn::getatt" }, "CreatedTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTimestamp`\n\nThe timestamp that shows when the dashboard was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#CreatedTimestamp-fn::getatt" }, "DashboardArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DashboardArn`\n\nThe ARN for the dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#DashboardArn-fn::getatt" } } }, "AWS::CloudTrail::EventDataStore": { "MarkdownDocumentation": "`AWS::CloudTrail::EventDataStore`\n\nCreates a new event data store.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, `Ref` returns the resource name.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html", "Properties": { "MaxEventSize": { "MarkdownDocumentation": "`MaxEventSize`\n\nThe maximum allowed size for events to be stored in the specified event data store. If you are using context key selectors, MaxEventSize must be set to Large.\n*Required*: No\n*Type*: String\n*Allowed values*: `Standard | Large...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Standard", "Large" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-maxeventsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nSpecifies the AWS KMS key ID to use to encrypt the events delivered by\nCloudTrail. The value can be an alias name prefixed by `alias/`, a\nfully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\nidentifier.\n###### Important\nDisabling or deleting the KMS key, or removing CloudTrail\npermissions on the key, prevents CloudTrail from logging events to the event data\nstore, and prevents users from querying the data in the event data store that was\nencrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\ndisable or delete a KMS key that you are using with an event data store,\ndelete or back up your event data store.\nCloudTrail also supports AWS KMS multi-Region keys. For more\ninformation about multi-Region keys, see [Using multi-Region\nkeys](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*Pattern*: `^[a-zA-Z0-9._/\\-:]+$`\n*Minimum*: `1`\n*Maximum*: `350`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdvancedEventSelectors": { "MarkdownDocumentation": "`AdvancedEventSelectors`\n\nThe advanced event selectors to use to select the events for the data store. You can\nconfigure up to five advanced event selectors for each event data store.\nFor more information about how to use advanced event selectors to log CloudTrail\nevents, 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\nitems](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-eds-cli.html#lake-cli-create-eds-config) in the CloudTrail User Guide.\nFor more information about how to use advanced event selectors to include events outside of 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/lake-integrations-cli.html#lake-cli-create-integration) in the CloudTrail User Guide.\n*Required*: No\n*Type*: Array of [AdvancedEventSelector](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-advancedeventselectors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AdvancedEventSelector", "DuplicatesAllowed": false }, "TerminationProtectionEnabled": { "MarkdownDocumentation": "`TerminationProtectionEnabled`\n\nSpecifies whether termination protection is enabled for the event data store. If\ntermination protection is enabled, you cannot delete the event data store until termination\nprotection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-terminationprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MultiRegionEnabled": { "MarkdownDocumentation": "`MultiRegionEnabled`\n\nSpecifies whether the event data store includes events from all Regions, or only from\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-multiregionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RetentionPeriod": { "MarkdownDocumentation": "`RetentionPeriod`\n\nThe retention period of the event data store, in days. If `BillingMode` is set to `EXTENDABLE_RETENTION_PRICING`, you can set a retention period of\nup to 3653 days, the equivalent of 10 years. If `BillingMode` is set to `FIXED_RETENTION_PRICING`, you can set a retention period of\nup to 2557 days, the equivalent of seven years.\nCloudTrail Lake determines whether to retain an event by checking if the `eventTime`\nof the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events\nwhen the `eventTime` is older than 90 days.\n###### Note\nIf you plan to copy trail events to this event data store, we recommend\nthat you consider both the age of the events that you\nwant to copy as well as how long you want to keep the copied events\nin your event data store. For example, if you copy trail events that are 5 years old\nand specify a retention period of 7 years, the event data store\nwill retain those events for two years.\n*Required*: No\n*Type*: Integer\n*Minimum*: `7`\n*Maximum*: `3653`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-retentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "FederationEnabled": { "MarkdownDocumentation": "`FederationEnabled`\n\nIndicates if [Lake query federation](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html) is enabled. By default, Lake query federation is disabled.\nYou cannot delete an event data store if Lake query federation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IngestionEnabled": { "MarkdownDocumentation": "`IngestionEnabled`\n\nSpecifies whether the event data store should start ingesting live events. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-ingestionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the event data store.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._\\-]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InsightSelectors": { "MarkdownDocumentation": "`InsightSelectors`\n\nA JSON string that contains the Insights types you want to log on an event data store.\n`ApiCallRateInsight` and `ApiErrorRateInsight` are valid Insight\ntypes.\nThe `ApiCallRateInsight` Insights type analyzes write-only\nmanagement API calls that are aggregated per minute against a baseline API call volume.\nThe `ApiErrorRateInsight` Insights type analyzes management\nAPI calls that result in error codes. The error is shown if the API call is\nunsuccessful.\n*Required*: No\n*Type*: Array of [InsightSelector](./aws-properties-cloudtrail-eventdatastore-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightselectors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InsightSelector", "DuplicatesAllowed": false }, "OrganizationEnabled": { "MarkdownDocumentation": "`OrganizationEnabled`\n\nSpecifies whether an event data store collects events logged for an organization in\nAWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-organizationenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FederationRoleArn": { "MarkdownDocumentation": "`FederationRoleArn`\n\nIf Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.\nThe federation role must exist in your account and provide the [required minimum permissions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html#query-federation-permissions-role).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._/\\-:@=\\+,\\.]+$`\n*Minimum*: `3`\n*Maximum*: `125`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InsightsDestination": { "MarkdownDocumentation": "`InsightsDestination`\n\nThe ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. For more information, see\n[Create an event data store for CloudTrail Insights events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-insights.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightsdestination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BillingMode": { "MarkdownDocumentation": "`BillingMode`\n\nThe billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.\nThe following are the possible values:\n* `EXTENDABLE_RETENTION_PRICING` - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years).\n The default retention period for this billing mode is 366 days.\n* `FIXED_RETENTION_PRICING` - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years).\n The default retention period for this billing mode is 2557 days.\nThe default value is `EXTENDABLE_RETENTION_PRICING`.\nFor more information about CloudTrail pricing,\nsee [AWS CloudTrail Pricing](https://aws.amazon.com/cloudtrail/pricing/) and\n[Managing CloudTrail Lake costs](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `EXTENDABLE_RETENTION_PRICIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EXTENDABLE_RETENTION_PRICING", "FIXED_RETENTION_PRICING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-billingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContextKeySelectors": { "MarkdownDocumentation": "`ContextKeySelectors`\n\nThe list of context key selectors that are configured for the event data store.\n*Required*: No\n*Type*: Array of [ContextKeySelector](./aws-properties-cloudtrail-eventdatastore-contextkeyselector.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-contextkeyselectors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ContextKeySelector", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudtrail-eventdatastore-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the status of the event data store, such as `ENABLED`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#Status-fn::getatt" }, "UpdatedTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedTimestamp`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the time stamp that updates were made to an event data store, such as `1598296624`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#UpdatedTimestamp-fn::getatt" }, "EventDataStoreArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EventDataStoreArn`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the CloudTrail event data store, such as\n`arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#EventDataStoreArn-fn::getatt" }, "CreatedTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTimestamp`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the time stamp of the creation of the event data store, such as `1248496624`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#CreatedTimestamp-fn::getatt" } } }, "AWS::CloudTrail::ResourcePolicy": { "MarkdownDocumentation": "`AWS::CloudTrail::ResourcePolicy`\n\nAttaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see\n[CloudTrail resource-based policy examples](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html)\nin the *CloudTrail User Guide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function,\n`Ref` returns the resource. The resource is a combination of the resource-based\npolicy document and the channel ARN.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.\nExample event data store ARN format:\n`arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`\nExample dashboard ARN format: `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`\nExample channel ARN format:\n`arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$`\n*Minimum*: `3`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html#cfn-cloudtrail-resourcepolicy-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nA JSON-formatted string for an AWS resource-based policy.\nFor example resource-based policies, see\n[CloudTrail resource-based policy examples](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html)\nin the *CloudTrail User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html#cfn-cloudtrail-resourcepolicy-resourcepolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::CloudTrail::Trail": { "MarkdownDocumentation": "`AWS::CloudTrail::Trail`\n\nCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html", "Properties": { "IncludeGlobalServiceEvents": { "MarkdownDocumentation": "`IncludeGlobalServiceEvents`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-includeglobalserviceevents", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EventSelectors": { "MarkdownDocumentation": "`EventSelectors`\n\nUse event selectors to further specify the management and data event settings for your\ntrail. By default, trails created without specific event selectors will be configured to\nlog all read and write management events, and no data events. When an event occurs in your\naccount, CloudTrail evaluates the event selector for all trails. For each trail, if\nthe event matches any event selector, the trail processes and logs the event. If the event\ndoesn'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*: Array of [EventSelector](./aws-properties-cloudtrail-trail-eventselector.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-eventselectors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EventSelector", "DuplicatesAllowed": false }, "KMSKeyId": { "MarkdownDocumentation": "`KMSKeyId`\n\nSpecifies the AWS KMS key ID to use to encrypt the logs and digest files delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to\nan alias, a fully specified ARN to a key, or a globally unique identifier.\nCloudTrail also supports AWS KMS multi-Region keys. For more\ninformation about multi-Region keys, see [Using multi-Region\nkeys](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AggregationConfigurations": { "MarkdownDocumentation": "`AggregationConfigurations`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [AggregationConfiguration](./aws-properties-cloudtrail-trail-aggregationconfiguration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-aggregationconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AggregationConfiguration", "DuplicatesAllowed": false }, "CloudWatchLogsRoleArn": { "MarkdownDocumentation": "`CloudWatchLogsRoleArn`\n\nSpecifies the role for the CloudWatch Logs endpoint to assume to write to a user's\nlog group. You must use a role that exists in your account.\nTo enable CloudWatch Logs delivery, you must provide values for `CloudWatchLogsLogGroupArn` and `CloudWatchLogsRoleArn`.\n###### Note\nIf you previously enabled CloudWatch Logs delivery\nand want to disable CloudWatch Logs delivery, you must set the values\nof the `CloudWatchLogsRoleArn` and `CloudWatchLogsLogGroupArn` fields 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-cloudwatchlogsrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3KeyPrefix": { "MarkdownDocumentation": "`S3KeyPrefix`\n\nSpecifies the Amazon S3 key prefix that comes after the name of the bucket you\nhave designated for log file delivery. For more information, see [Finding Your CloudTrail Log Files](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/get-and-view-cloudtrail-log-files.html#cloudtrail-find-log-files). The maximum length is 200\ncharacters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-s3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdvancedEventSelectors": { "MarkdownDocumentation": "`AdvancedEventSelectors`\n\nSpecifies the settings for advanced event selectors. You can use advanced event selectors to\nlog management events, data events for all resource types, and network activity events.\nYou can add advanced event\nselectors, and conditions for your advanced event selectors, up to a maximum of 500 values\nfor all conditions and selectors on a trail. You can use either\n`AdvancedEventSelectors` or `EventSelectors`, but not both. If you\napply `AdvancedEventSelectors` to a trail, any existing\n`EventSelectors` are overwritten. For more information about advanced event\nselectors, see [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) and\n[Logging network activity events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html)\nin the *AWS CloudTrail User Guide*.\n*Required*: No\n*Type*: Array of [AdvancedEventSelector](./aws-properties-cloudtrail-trail-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-advancedeventselectors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AdvancedEventSelector", "DuplicatesAllowed": false }, "TrailName": { "MarkdownDocumentation": "`TrailName`\n\nSpecifies 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\n (\\_), 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\n `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*Pattern*: `(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9]([a-zA-Z0-9\\._-])*[a-zA-Z0-9]$)`\n*Minimum*: `3`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-trailname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IsOrganizationTrail": { "MarkdownDocumentation": "`IsOrganizationTrail`\n\nSpecifies 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,\nand cannot be true unless the call is made on behalf of an AWS account that\nis the management account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to\n`true`, the trail will be created in all AWS accounts that\nbelong to the organization. If the trail is an organization trail and this is set to\n`false`, the trail will remain in the current AWS account but\nbe deleted from all member accounts in the organization.\n###### Note\nOnly the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to\nan organization 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-isorganizationtrail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InsightSelectors": { "MarkdownDocumentation": "`InsightSelectors`\n\nA JSON string that contains the Insights types you want to log on a trail.\n`ApiCallRateInsight` and `ApiErrorRateInsight` are valid Insight\ntypes.\nThe `ApiCallRateInsight` Insights type analyzes write-only\nmanagement API calls that are aggregated per minute against a baseline API call volume.\nThe `ApiErrorRateInsight` Insights type analyzes management\nAPI calls that result in error codes. The error is shown if the API call is\nunsuccessful.\n*Required*: No\n*Type*: Array of [InsightSelector](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-insightselectors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InsightSelector", "DuplicatesAllowed": false }, "CloudWatchLogsLogGroupArn": { "MarkdownDocumentation": "`CloudWatchLogsLogGroupArn`\n\nSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\nrepresents the log group to which CloudTrail logs are delivered. You must use a log\ngroup that exists in your account.\nTo enable CloudWatch Logs delivery, you must provide values for `CloudWatchLogsLogGroupArn` and `CloudWatchLogsRoleArn`.\n###### Note\nIf you previously enabled CloudWatch Logs delivery\nand want to disable CloudWatch Logs delivery, you must set the values\nof the `CloudWatchLogsRoleArn` and `CloudWatchLogsLogGroupArn` fields 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-cloudwatchlogsloggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnsTopicName": { "MarkdownDocumentation": "`SnsTopicName`\n\nSpecifies the name or ARN of the Amazon SNS topic defined for notification of log file\ndelivery. The maximum length is 256 characters.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-snstopicname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IsMultiRegionTrail": { "MarkdownDocumentation": "`IsMultiRegionTrail`\n\nSpecifies whether the trail applies only to the current Region or to all Regions. The\ndefault is false. If the trail exists only in the current Region and this value is set to\ntrue, shadow trails (replications of the trail) will be created in the other Regions. If\nthe trail exists in all Regions and this value is set to false, the trail will remain in\nthe Region where it was created, and its shadow trails in other Regions will be deleted. As\na 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-ismultiregiontrail", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nSpecifies the name of the Amazon S3 bucket designated for publishing log files.\nSee [Amazon S3\nBucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-s3bucketname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnableLogFileValidation": { "MarkdownDocumentation": "`EnableLogFileValidation`\n\nSpecifies whether log file validation is enabled. The default is false.\n###### Note\nWhen you disable log file integrity validation, the chain of digest files is broken\nafter one hour. CloudTrail does not create digest files for log files that were\ndelivered during a period in which log file integrity validation was disabled. For\nexample, if you enable log file integrity validation at noon on January 1, disable it at\nnoon on January 2, and re-enable it at noon on January 10, digest files will not be\ncreated for the log files delivered from noon on January 2 to noon on January 10. The\nsame 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-enablelogfilevalidation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA custom set of tags (key-value pairs) for this trail.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudtrail-trail-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "IsLogging": { "MarkdownDocumentation": "`IsLogging`\n\nWhether the CloudTrail trail is currently logging AWS API\ncalls.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-islogging", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" } }, "Attributes": { "SnsTopicArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SnsTopicArn`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail,\nsuch as `arn:aws:sns:us-east-2:123456789012:mySNSTopic`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#SnsTopicArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the CloudTrail trail, such as `arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#Arn-fn::getatt" } } }, "AWS::CloudWatch::Alarm": { "MarkdownDocumentation": "`AWS::CloudWatch::Alarm`\n\nThe `AWS::CloudWatch::Alarm` type specifies an alarm and associates it with the specified metric or metric math expression.\nWhen this operation creates an alarm, the alarm state is immediately set to\n`INSUFFICIENT_DATA`. The alarm is then evaluated and its state is set\nappropriately. Any actions associated with the new state are then executed.\nWhen you update an existing alarm, its state is left unchanged, but the\nupdate completely overwrites the previous configuration of the alarm.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the alarm name, such as `TestAlarm`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html", "Properties": { "ThresholdMetricId": { "MarkdownDocumentation": "`ThresholdMetricId`\n\nIn an alarm based on an anomaly detection model, this is the ID of the\n`ANOMALY_DETECTION_BAND` function used as the threshold for the\nalarm.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-thresholdmetricid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EvaluateLowSampleCountPercentile": { "MarkdownDocumentation": "`EvaluateLowSampleCountPercentile`\n\nUsed only for alarms based on percentiles. If `ignore`, the alarm state\ndoes not change during periods with too few data points to be statistically significant.\nIf `evaluate` or this parameter is not used, the alarm is always evaluated\nand 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-evaluatelowsamplecountpercentile", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExtendedStatistic": { "MarkdownDocumentation": "`ExtendedStatistic`\n\nThe percentile statistic for the metric associated with the alarm. Specify a value between\np0.0 and p100.\nFor an alarm based on a metric, you must specify either `Statistic`\nor `ExtendedStatistic` but not both.\nFor an alarm based on a math expression, you can't\nspecify `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-extendedstatistic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe arithmetic operation to use when comparing the specified\nstatistic and threshold. The specified statistic value is used as the first operand.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GreaterThanOrEqualToThresho...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold", "LessThanLowerOrGreaterThanUpperThreshold", "LessThanLowerThreshold", "GreaterThanUpperThreshold" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-comparisonoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TreatMissingData": { "MarkdownDocumentation": "`TreatMissingData`\n\nSets how this alarm is to handle missing data points. Valid values are `breaching`, `notBreaching`, `ignore`,\nand `missing`. For more information, see [Configuring How CloudWatchAlarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the\n*Amazon CloudWatchUser Guide*.\nIf you omit this parameter, the default behavior of `missing` is used.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-treatmissingdata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Dimensions": { "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't\nspecify `Dimensions`. Instead, you use `Metrics`.\n*Required*: No\n*Type*: Array of [Dimension](./aws-properties-cloudwatch-alarm-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-dimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Dimension", "DuplicatesAllowed": true }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe period, in seconds, over which the statistic is applied. This is required for an alarm based on a\nmetric. Valid values are 10, 20, 30, 60, and any multiple of 60.\nFor an alarm based on a math expression, you can't\nspecify `Period`, and instead you use the `Metrics` parameter.\n*Minimum:* 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-period", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EvaluationPeriods": { "MarkdownDocumentation": "`EvaluationPeriods`\n\nThe number of periods over which data is compared to the specified threshold.\nIf you are setting an alarm that requires that a number of consecutive data points be\nbreaching to trigger the alarm, this value specifies that number. If you\nare setting an \"M out of N\" alarm, this value is the N, and `DatapointsToAlarm`\nis the M.\nFor more information, see [Evaluating\nan 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-evaluationperiods", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Unit": { "MarkdownDocumentation": "`Unit`\n\nThe unit of the metric associated with the alarm. Specify this only if you are creating an alarm\nbased on a single metric. Do not specify this if you are specifying a `Metrics` array.\nYou can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes,\nMegabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count,\nBytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second,\nKilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.\n*Required*: No\n*Type*: String\n*Allowed values*: `Seconds | Microseconds | Mi...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-unit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric associated with the alarm. This is required for an alarm based on a\nmetric. For an alarm based on a math expression, you can't\nspecify `Namespace` and you use `Metrics` instead.\nFor a list of namespaces for metrics from AWS services, see\n[AWS Services That Publish CloudWatchMetrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)\n*Required*: No\n*Type*: String\n*Pattern*: `[^:].*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-namespace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OKActions": { "MarkdownDocumentation": "`OKActions`\n\nThe actions to execute when this alarm transitions to the `OK` state\nfrom any other state. Each action is specified as an Amazon Resource Name\n(ARN).\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-okactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AlarmActions": { "MarkdownDocumentation": "`AlarmActions`\n\nThe list of actions to execute when this alarm transitions into an ALARM state from any other state.\nSpecify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions\nthat you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the\n*Amazon CloudWatch API Reference*.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-alarmactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric associated with the alarm. This is required for an alarm based on a\nmetric. For an alarm based on a math expression, you use `Metrics` instead and you can't\nspecify `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-metricname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ActionsEnabled": { "MarkdownDocumentation": "`ActionsEnabled`\n\nIndicates whether actions should be executed during any changes to the alarm state. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-actionsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Metrics": { "MarkdownDocumentation": "`Metrics`\n\nAn array that enables you to create an alarm based on the result of a metric math expression. Each\nitem in the array either retrieves a metric or performs a math expression.\nIf you specify the `Metrics` parameter, you cannot specify `MetricName`, `Dimensions`,\n`Period`, `Namespace`, `Statistic`, `ExtendedStatistic`, or `Unit`.\n*Required*: No\n*Type*: Array of [MetricDataQuery](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-metrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDataQuery", "DuplicatesAllowed": false }, "AlarmDescription": { "MarkdownDocumentation": "`AlarmDescription`\n\nThe description of the alarm.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-alarmdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AlarmName": { "MarkdownDocumentation": "`AlarmName`\n\nThe name of the alarm. If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the alarm name.\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this resource. You can\nperform 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-alarmname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Statistic": { "MarkdownDocumentation": "`Statistic`\n\nThe statistic for the metric associated with the alarm, other than percentile.\nFor percentile statistics, use `ExtendedStatistic`.\nFor an alarm based on a metric, you must specify either `Statistic`\nor `ExtendedStatistic` but not both.\nFor an alarm based on a math expression, you can't\nspecify `Statistic`. Instead, you use `Metrics`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SampleCount | Average | Sum...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-statistic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InsufficientDataActions": { "MarkdownDocumentation": "`InsufficientDataActions`\n\nThe actions to execute when this alarm transitions to the\n`INSUFFICIENT_DATA` state from any other state. Each action is specified\nas an Amazon Resource Name (ARN).\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-insufficientdataactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DatapointsToAlarm": { "MarkdownDocumentation": "`DatapointsToAlarm`\n\nThe number of datapoints that must be breaching to trigger the alarm.\nThis is used only if you are setting an \"M out of N\" alarm. In that case, this value is the M,\nand the value that you set for `EvaluationPeriods` is the N value.\nFor more information, see [Evaluating\nan 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\nfor `EvaluationPeriods`, and the alarm goes to alarm state if that many consecutive\nperiods 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate\ntags with the alarm when you create the alarm, you must have the `cloudwatch:TagResource` permission.\nTags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a\nuser permission to access or change only resources with certain tag values.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudwatch-alarm-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\nThe value to compare with the specified statistic.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-threshold", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the CloudWatchalarm, such as\n`arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#Arn-fn::getatt" } } }, "AWS::CloudWatch::AnomalyDetector": { "MarkdownDocumentation": "`AWS::CloudWatch::AnomalyDetector`\n\nThe `AWS::CloudWatch::AnomalyDetector` type specifies an anomaly detection band for a certain metric and statistic. The band\nrepresents the expected \"normal\" range for the metric values. Anomaly detection bands can be used for visualization of a metric's expected values,\nand for alarms.\nFor more information see [Using CloudWatch anomaly detection.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html", "Properties": { "MetricCharacteristics": { "Type": "MetricCharacteristics", "Required": false, "MarkdownDocumentation": "`MetricCharacteristics`\n\nUse this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models.\nCurrently, it includes the `PeriodicSpikes` parameter.\n*Required*: No\n*Type*: [MetricCharacteristics](./aws-properties-cloudwatch-anomalydetector-metriccharacteristics.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metriccharacteristics", "UpdateType": "Immutable" }, "MetricName": { "Required": false, "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric associated with the anomaly detection band.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Stat": { "Required": false, "MarkdownDocumentation": "`Stat`\n\nThe statistic of the metric associated with the anomaly detection band.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-stat", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Configuration": { "Type": "Configuration", "Required": false, "MarkdownDocumentation": "`Configuration`\n\nSpecifies details about how the anomaly detection model is to be trained, including time ranges to exclude\nwhen training and updating the model. The configuration can also include the time zone to use for the metric.\n*Required*: No\n*Type*: [Configuration](./aws-properties-cloudwatch-anomalydetector-configuration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-configuration", "UpdateType": "Mutable" }, "MetricMathAnomalyDetector": { "Type": "MetricMathAnomalyDetector", "Required": false, "MarkdownDocumentation": "`MetricMathAnomalyDetector`\n\nThe CloudWatch metric math expression for this anomaly detector.\n*Required*: No\n*Type*: [MetricMathAnomalyDetector](./aws-properties-cloudwatch-anomalydetector-metricmathanomalydetector.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector", "UpdateType": "Immutable" }, "Dimensions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Dimensions`\n\nThe dimensions of the metric associated with the anomaly detection band.\n*Required*: No\n*Type*: Array of [Dimension](./aws-properties-cloudwatch-anomalydetector-dimension.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-dimensions", "ItemType": "Dimension", "UpdateType": "Immutable" }, "Namespace": { "Required": false, "MarkdownDocumentation": "`Namespace`\n\nThe namespace of the metric associated with the anomaly detection band.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-namespace", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SingleMetricAnomalyDetector": { "Type": "SingleMetricAnomalyDetector", "Required": false, "MarkdownDocumentation": "`SingleMetricAnomalyDetector`\n\nThe CloudWatch metric and statistic for this anomaly detector.\n*Required*: No\n*Type*: [SingleMetricAnomalyDetector](./aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector", "UpdateType": "Immutable" } } }, "AWS::CloudWatch::CompositeAlarm": { "MarkdownDocumentation": "`AWS::CloudWatch::CompositeAlarm`\n\nThe `AWS::CloudWatch::CompositeAlarm` type creates or updates a composite alarm. When you create\na composite alarm, you specify a rule expression for the alarm that takes into\naccount the alarm states of other alarms that you have created. The composite alarm goes into ALARM state\nonly if all conditions of the rule are met.\nThe alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.\nUsing composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set\nup alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state\nonly when more than one of the underlying metric alarms are in ALARM state.\nWhen this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT\\_DATA. The alarm is then evaluated and\nits state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial\ntime after creation is the only time that the alarm can be in INSUFFICIENT\\_DATA state.\nWhen you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the alarm name, such as `MyCompositeAlarm`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html", "Properties": { "AlarmActions": { "MarkdownDocumentation": "`AlarmActions`\n\nThe 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).\nFor more information about creating alarms and the actions\nthat you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the\n*Amazon CloudWatch API Reference*.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1024 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ActionsSuppressorWaitPeriod": { "MarkdownDocumentation": "`ActionsSuppressorWaitPeriod`\n\nThe maximum time\nin seconds\nthat the composite alarm waits\nfor the suppressor alarm\nto go\ninto the `ALARM` state.\nAfter this time,\nthe composite alarm performs its actions.\n###### Important\n`WaitPeriod`\nis required only\nwhen `ActionsSuppressor` is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorwaitperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ActionsEnabled": { "MarkdownDocumentation": "`ActionsEnabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AlarmName": { "MarkdownDocumentation": "`AlarmName`\n\nThe name for the composite alarm. This name must be unique within your AWS account.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AlarmDescription": { "MarkdownDocumentation": "`AlarmDescription`\n\nThe description for the composite alarm.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ActionsSuppressor": { "MarkdownDocumentation": "`ActionsSuppressor`\n\nActions will be suppressed\nif the suppressor alarm is\nin the `ALARM` state.\n`ActionsSuppressor` can be an AlarmName or an Amazon Resource Name (ARN)\nfrom an existing alarm.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AlarmRule": { "MarkdownDocumentation": "`AlarmRule`\n\nAn expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each\nalarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state,\nor INSUFFICIENT\\_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a\nsingle 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.\nTRUE 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\n*Amazon CloudWatch API Reference*.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InsufficientDataActions": { "MarkdownDocumentation": "`InsufficientDataActions`\n\nThe 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).\nFor more information about creating alarms and the actions\nthat you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the\n*Amazon CloudWatch API Reference*.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1024 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "OKActions": { "MarkdownDocumentation": "`OKActions`\n\nThe 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).\nFor more information about creating alarms and the actions\nthat you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the\n*Amazon CloudWatch API Reference*.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `1024 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-okactions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ActionsSuppressorExtensionPeriod": { "MarkdownDocumentation": "`ActionsSuppressorExtensionPeriod`\n\nThe maximum time\nin seconds\nthat the composite alarm waits\nafter suppressor alarm goes out\nof the `ALARM` state.\nAfter this time,\nthe composite alarm performs its actions.\n###### Important\n`ExtensionPeriod`\nis required only\nwhen `ActionsSuppressor` is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorextensionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate\ntags with the alarm when you create the alarm, you must have the `cloudwatch:TagResource` permission.\nTags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a\nuser permission to access or change only resources with certain tag values.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cloudwatch-compositealarm-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the composite alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm/CompositeAlarmName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#Arn-fn::getatt" } } }, "AWS::CloudWatch::Dashboard": { "MarkdownDocumentation": "`AWS::CloudWatch::Dashboard`\n\nThe `AWS::CloudWatch::Dashboard` resource specifies an Amazon CloudWatch dashboard. A dashboard is a\ncustomizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view.\nAll dashboards in your account are global, not region-specific.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the value of `DashboardName`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html", "Properties": { "DashboardName": { "MarkdownDocumentation": "`DashboardName`\n\nThe name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DashboardBody": { "MarkdownDocumentation": "`DashboardBody`\n\nThe detailed information about the dashboard in JSON format, including the widgets to include and their location\non the dashboard. This parameter is required.\nFor more information about the syntax,\nsee [Dashboard Body Structure and Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CloudWatch::InsightRule": { "MarkdownDocumentation": "`AWS::CloudWatch::InsightRule`\n\nCreates or updates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data\nfor the log events in that log group. For more information, see [Using Contributor Insights to Analyze High-Cardinality Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) in the *Amazon CloudWatch User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the rule.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the Contributor Insights rule, such as `arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#Arn-fn::getatt" }, "RuleName": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleName`\n\nThe name of the Contributor Insights rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#RuleName-fn::getatt" } }, "Properties": { "RuleState": { "Required": true, "MarkdownDocumentation": "`RuleState`\n\nThe current state of the rule. Valid values are `ENABLED` and `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulestate", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RuleBody": { "Required": true, "MarkdownDocumentation": "`RuleBody`\n\nThe definition of the rule, as a JSON object.\nFor details about the syntax, see [Contributor Insights Rule Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html) in the *Amazon CloudWatch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulebody", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ApplyOnTransformedLogs": { "Required": false, "MarkdownDocumentation": "`ApplyOnTransformedLogs`\n\nDetermines whether the rules is evaluated on transformed versions of logs. Valid values are `TRUE` and `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-applyontransformedlogs", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "RuleName": { "Required": true, "MarkdownDocumentation": "`RuleName`\n\nThe name of the rule.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "Tags", "Required": false, "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to associate with the Contributor Insights rule. You can\nassociate as many as 50 tags with a rule.\nTags can help you organize and categorize your resources. For more information,\nsee [Tagging Your Amazon CloudWatch Resources](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html).\nTo be able to associate tags with a rule, you must have the `cloudwatch:TagResource` permission in addition to the `cloudwatch:PutInsightRule` permission.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-tags", "UpdateType": "Mutable" } } }, "AWS::CloudWatch::MetricStream": { "MarkdownDocumentation": "`AWS::CloudWatch::MetricStream`\n\nCreates or updates a metric stream. Metrics streams can automatically stream CloudWatch metrics to\nAWS destinations including Amazon S3 and to many third-party solutions. For more information, see\n[Metric streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html).\nTo create a metric stream, you must be logged on to an account that has the `iam:PassRole` permission and\neither the **CloudWatchFullAccess** policy or the `cloudwatch:PutMetricStream` permission.\nWhen you create or update a metric stream, you choose one of the following:\n* Stream metrics from all metric namespaces in the account.\n* Stream metrics from all metric namespaces in the account, except for the namespaces that you list\n in `ExcludeFilters`.\n* Stream metrics from only the metric namespaces that you list in `IncludeFilters`.\nWhen you create a metric stream, the stream is created in the `running` state. If you update an existing metric stream,\nthe state does not change.\nIf you create a metric stream in an account that has been set up as a monitoring account in CloudWatch cross-account observability,\nyou can choose whether to include metrics from linked source accounts in the metric stream.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the metric stream.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html", "Properties": { "StatisticsConfigurations": { "MarkdownDocumentation": "`StatisticsConfigurations`\n\nBy default, a\nmetric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.\nYou can use this parameter to have the metric stream also send additional statistics in the stream. This\narray 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\nstream for those metrics. The additional statistics that you can stream depend on the stream's `OutputFormat`.\nIf the `OutputFormat` is `json`, you can stream any additional statistic that is supported by\nCloudWatch, listed in\n[CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html). If the `OutputFormat` is\nOpenTelemetry, you can stream percentile statistics.\n*Required*: No\n*Type*: Array of [MetricStreamStatisticsConfiguration](./aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-statisticsconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricStreamStatisticsConfiguration", "DuplicatesAllowed": false }, "FirehoseArn": { "MarkdownDocumentation": "`FirehoseArn`\n\nThe ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This\nAmazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-firehosearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IncludeLinkedAccountsMetrics": { "MarkdownDocumentation": "`IncludeLinkedAccountsMetrics`\n\nIf you are creating a metric stream in a monitoring account, specify `true` to include\nmetrics 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\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includelinkedaccountsmetrics", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IncludeFilters": { "MarkdownDocumentation": "`IncludeFilters`\n\nIf you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.\nYou cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.\nWhen you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream\nin any way, the metric stream is effectively restarted, so after such a change you will get\nonly the datapoints that have a timestamp after the time of the update.\n*Required*: No\n*Type*: Array of [MetricStreamFilter](./aws-properties-cloudwatch-metricstream-metricstreamfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includefilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricStreamFilter", "DuplicatesAllowed": false }, "OutputFormat": { "MarkdownDocumentation": "`OutputFormat`\n\nThe output format for the stream. Valid values are `json`, `opentelemetry1.0` and\n`opentelemetry0.7` For more information about metric stream output formats, see\n[Metric streams output formats](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html).\nThis parameter is required.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-outputformat", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ExcludeFilters": { "MarkdownDocumentation": "`ExcludeFilters`\n\nIf you specify this parameter, the stream sends metrics from all metric namespaces except\nfor the namespaces that you specify here. You cannot specify both `IncludeFilters`\nand `ExcludeFilters` in the same metric stream.\nWhen you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream\nin any way, the metric stream is effectively restarted, so after such a change you will get\nonly the datapoints that have a timestamp after the time of the update.\n*Required*: No\n*Type*: Array of [MetricStreamFilter](./aws-properties-cloudwatch-metricstream-metricstreamfilter.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-excludefilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricStreamFilter", "DuplicatesAllowed": false }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose\nresources. This IAM role must already exist and must be in the same account as the metric stream.\nThis IAM role must include the `firehose:PutRecord` and `firehose:PutRecordBatch`\npermissions.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-cloudwatch-metricstream-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nIf you are creating a new metric stream, this is the name for the new stream.\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CreationDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationDate`\n\nThe date that the metric stream was originally created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#CreationDate-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the metric stream, either `running` or `stopped`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#State-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the metric stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#Arn-fn::getatt" }, "LastUpdateDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdateDate`\n\nThe date that the metric stream was most recently updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#LastUpdateDate-fn::getatt" } } }, "AWS::CodeArtifact::Domain": { "MarkdownDocumentation": "`AWS::CodeArtifact::Domain`\n\nThe `AWS::CodeArtifact::Domain` resource creates an AWS CodeArtifact domain.\nCodeArtifact*domains* make it easier to manage multiple repositories across an\norganization. You can use a domain to apply permissions across many repositories owned by different\nAWS accounts. For more information about domains, see the\n[Domain concepts information](https://docs.aws.amazon.com/codeartifact/latest/ug/codeartifact-concepts.html#welcome-concepts-domain)\nin the *CodeArtifact User Guide*. For more information about the `CreateDomain` API, see\n[CreateDomain](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateDomain.html)\nin the *CodeArtifact API Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource arn.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html", "Properties": { "PermissionsPolicyDocument": { "MarkdownDocumentation": "`PermissionsPolicyDocument`\n\nThe document that defines the resource policy that is set on a domain.\n*Required*: No\n*Type*: Json\n*Minimum*: `2`\n*Maximum*: `5120`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-permissionspolicydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nA string that specifies the name of the requested domain.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$`\n*Minimum*: `2`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to be applied to the domain.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codeartifact-domain-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "EncryptionKey": { "MarkdownDocumentation": "`EncryptionKey`\n\nThe key used to encrypt the domain.\n*Required*: No\n*Type*: String\n*Pattern*: `\\S+`\n*Minimum*: `1`\n*Maximum*: `1011`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-encryptionkey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Owner": { "PrimitiveType": "String", "MarkdownDocumentation": "`Owner`\n\nWhen you pass the logical ID of this resource, the function returns the 12-digit account number of the AWS account that owns the domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#Owner-fn::getatt" }, "EncryptionKey": { "PrimitiveType": "String", "MarkdownDocumentation": "`EncryptionKey`\n\nWhen you pass the logical ID of this resource, the function returns the key used to encrypt the domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#EncryptionKey-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nWhen you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nWhen you pass the logical ID of this resource, the function returns the name of the domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#Name-fn::getatt" } } }, "AWS::CodeArtifact::PackageGroup": { "MarkdownDocumentation": "`AWS::CodeArtifact::PackageGroup`\n\nCreates a package group. For more information about creating package groups, including example CLI commands, see [Create a package group](https://docs.aws.amazon.com/codeartifact/latest/ug/create-package-group.html) in the *CodeArtifact User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html", "Properties": { "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nThe pattern of the package group. The pattern determines which packages are associated with the package group.\n*Required*: Yes\n*Type*: String\n*Minimum*: `2`\n*Maximum*: `520`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html#cfn-codeartifact-packagegroup-pattern", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the package group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html#cfn-codeartifact-packagegroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain that contains the package group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$`\n*Minimum*: `2`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html#cfn-codeartifact-packagegroup-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OriginConfiguration": { "MarkdownDocumentation": "`OriginConfiguration`\n\nDetails about the package origin configuration of a package group.\n*Required*: No\n*Type*: [OriginConfiguration](./aws-properties-codeartifact-packagegroup-originconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html#cfn-codeartifact-packagegroup-originconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "OriginConfiguration" }, "ContactInfo": { "MarkdownDocumentation": "`ContactInfo`\n\nThe contact information of the package group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html#cfn-codeartifact-packagegroup-contactinfo", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainOwner": { "MarkdownDocumentation": "`DomainOwner`\n\nThe 12-digit account number of the AWS account that owns the domain. It does not include\ndashes or spaces.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html#cfn-codeartifact-packagegroup-domainowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codeartifact-packagegroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html#cfn-codeartifact-packagegroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the package group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html#Arn-fn::getatt" } } }, "AWS::CodeArtifact::Repository": { "MarkdownDocumentation": "`AWS::CodeArtifact::Repository`\n\nThe `AWS::CodeArtifact::Repository` resource creates an AWS CodeArtifact repository.\nCodeArtifact*repositories* contain a set of package versions.\nFor more information about repositories, see the\n[Repository concepts information](https://docs.aws.amazon.com/codeartifact/latest/ug/codeartifact-concepts.html#welcome-concepts-repository)\nin the *CodeArtifact User Guide*. For more information about the `CreateRepository` API, see\n[CreateRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html)\nin the *CodeArtifact API Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource arn.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA text description of the repository.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PermissionsPolicyDocument": { "MarkdownDocumentation": "`PermissionsPolicyDocument`\n\nThe document that defines the resource policy that is set on a repository.\n*Required*: No\n*Type*: Json\n*Minimum*: `2`\n*Maximum*: `5120`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-permissionspolicydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe name of the domain that contains the repository.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$`\n*Minimum*: `2`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Upstreams": { "MarkdownDocumentation": "`Upstreams`\n\nA list of upstream repositories to associate with the repository. The order of the upstream repositories\nin the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more\ninformation, see [Working with upstream repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-upstreams", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RepositoryName": { "MarkdownDocumentation": "`RepositoryName`\n\nThe name of an upstream repository.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([A-Za-z0-9][A-Za-z0-9._\\-]{1,99})$`\n*Minimum*: `2`\n*Maximum*: `100`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-repositoryname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ExternalConnections": { "MarkdownDocumentation": "`ExternalConnections`\n\nAn array of external connections associated with the repository. For more information, see [Supported external connection repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/external-connection.html#supported-public-repositories) in the *CodeArtifact user guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-externalconnections", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to be applied to the repository.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codeartifact-repository-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "DomainOwner": { "MarkdownDocumentation": "`DomainOwner`\n\nThe 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include\ndashes or spaces.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainowner", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nWhen you pass the logical ID of this resource, the function returns the domain name that contains the repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#DomainName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nWhen you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#Arn-fn::getatt" }, "DomainOwner": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainOwner`\n\nWhen you pass the logical ID of this resource, the function returns the 12-digit account number of the AWS account that owns the domain that contains the repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#DomainOwner-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nWhen you pass the logical ID of this resource, the function returns the name of the repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#Name-fn::getatt" } } }, "AWS::CodeBuild::Fleet": { "MarkdownDocumentation": "`AWS::CodeBuild::Fleet`\n\nThe `AWS::CodeBuild::Fleet` resource configures a compute fleet, a set of dedicated instances for your build environment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the AWS CodeBuild compute fleet.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html", "Properties": { "FleetServiceRole": { "MarkdownDocumentation": "`FleetServiceRole`\n\nThe service role associated with the compute fleet. For more information, see [Allow a user to add a permission policy for a fleet service role](https://docs.aws.amazon.com/codebuild/latest/userguide/auth-and-access-control-iam-identity-based-access-control.html#customer-managed-policies-example-permission-policy-fleet-service-role.html) in the *AWS CodeBuild User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:arn:)[a-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-fleetservicerole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentType": { "MarkdownDocumentation": "`EnvironmentType`\n\nThe environment type of the compute fleet.\n* The environment type `ARM_CONTAINER` is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai),\n Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt),\n and South America (S\u00e3o Paulo).\n* The environment type `ARM_EC2` is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt),\n Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (S\u00e3o Paulo),\n and Asia Pacific (Mumbai).\n* The environment type `LINUX_CONTAINER` is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt),\n Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (S\u00e3o Paulo),\n and Asia Pacific (Mumbai).\n* The environment type `LINUX_EC2` is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt),\n Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (S\u00e3o Paulo),\n and Asia Pacific (Mumbai).\n* The environment type `LINUX_GPU_CONTAINER` is available only in\n regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland),\n EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).\n* The environment type `MAC_ARM` is available only in\n regions US East (Ohio), US East (N. Virginia), US West (Oregon), Europe (Frankfurt),\n and Asia Pacific (Sydney).\n* The environment type `WINDOWS_EC2` is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt),\n Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (S\u00e3o Paulo),\n and Asia Pacific (Mumbai).\n* The environment type `WINDOWS_SERVER_2019_CONTAINER` is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo),\n Asia Pacific (Mumbai) and EU (Ireland).\n* The environment type `WINDOWS_SERVER_2022_CONTAINER` is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney),\n Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (S\u00e3o Paulo) and Asia Pacific (Mumbai).\nFor more information, see [Build environment compute types](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild\nuser guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `WINDOWS_SERVER_2019_CONTAIN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS_SERVER_2019_CONTAINER", "WINDOWS_SERVER_2022_CONTAINER", "LINUX_CONTAINER", "LINUX_GPU_CONTAINER", "ARM_CONTAINER", "MAC_ARM", "LINUX_EC2", "ARM_EC2", "WINDOWS_EC2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-environmenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OverflowBehavior": { "MarkdownDocumentation": "`OverflowBehavior`\n\nThe compute fleet overflow behavior.\n* For overflow behavior `QUEUE`, your overflow builds need to wait on\n the existing fleet instance to become available.\n* For overflow behavior `ON_DEMAND`, your overflow builds run on CodeBuild on-demand.\n \n ###### Note\n \n If you choose to set your overflow behavior to on-demand while creating a VPC-connected\n fleet, make sure that you add the required VPC permissions to your project service role. For more\n information, see [Example\n policy statement to allow CodeBuild access to AWS services required to create a VPC network interface](https://docs.aws.amazon.com/codebuild/latest/userguide/auth-and-access-control-iam-identity-based-access-control.html#customer-managed-policies-example-create-vpc-network-interface).\n*Required*: No\n*Type*: String\n*Allowed values*: `QUEUE | ON_DEMAND...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "QUEUE", "ON_DEMAND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-overflowbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nThe Amazon Machine Image (AMI) of the compute fleet.\n*Required*: No\n*Type*: String\n*Pattern*: `^((aws/codebuild/([A-Za-z0-9._-]+|ami/[A-Za-z0-9._-]+):[A-Za-z0-9._-]+)|ami-[a-z0-9]{1,1020})$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-imageid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScalingConfiguration": { "MarkdownDocumentation": "`ScalingConfiguration`\n\nThe scaling configuration of the compute fleet.\n*Required*: No\n*Type*: [ScalingConfigurationInput](./aws-properties-codebuild-fleet-scalingconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-scalingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScalingConfigurationInput" }, "BaseCapacity": { "MarkdownDocumentation": "`BaseCapacity`\n\nThe initial number of machines allocated to the compute \ufb02eet, which de\ufb01nes the number of builds that can run in parallel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-basecapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "FleetProxyConfiguration": { "MarkdownDocumentation": "`FleetProxyConfiguration`\n\nInformation about the proxy configurations that apply network access control to your reserved capacity instances.\n*Required*: No\n*Type*: [ProxyConfiguration](./aws-properties-codebuild-fleet-proxyconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-fleetproxyconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProxyConfiguration" }, "ComputeConfiguration": { "MarkdownDocumentation": "`ComputeConfiguration`\n\nThe compute configuration of the compute fleet. This is only required if `computeType` is set to `ATTRIBUTE_BASED_COMPUTE` or `CUSTOM_INSTANCE_TYPE`.\n*Required*: No\n*Type*: [ComputeConfiguration](./aws-properties-codebuild-fleet-computeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-computeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ComputeConfiguration" }, "ComputeType": { "MarkdownDocumentation": "`ComputeType`\n\nInformation about the compute resources the compute fleet uses. Available values\ninclude:\n* `ATTRIBUTE_BASED_COMPUTE`: Specify the amount of vCPUs, memory, disk space, and the type of machine.\n \n ###### Note\n \n If you use `ATTRIBUTE_BASED_COMPUTE`, you must define your attributes by using `computeConfiguration`. AWS CodeBuild\n will select the cheapest instance that satisfies your specified attributes. For more information, see [Reserved capacity environment\n types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types) in the *AWS CodeBuild User Guide*.\n* `BUILD_GENERAL1_SMALL`: Use up to 4 GiB memory and 2 vCPUs for\n builds.\n* `BUILD_GENERAL1_MEDIUM`: Use up to 8 GiB memory and 4 vCPUs for\n builds.\n* `BUILD_GENERAL1_LARGE`: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.\n* `BUILD_GENERAL1_XLARGE`: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.\n* `BUILD_GENERAL1_2XLARGE`: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.\n* `BUILD_LAMBDA_1GB`: Use up to 1 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\n* `BUILD_LAMBDA_2GB`: Use up to 2 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\n* `BUILD_LAMBDA_4GB`: Use up to 4 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\n* `BUILD_LAMBDA_8GB`: Use up to 8 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\n* `BUILD_LAMBDA_10GB`: Use up to 10 GiB memory for\n builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.\nIf you use `BUILD_GENERAL1_SMALL`:\n* For environment type `LINUX_CONTAINER`, you can use up to 4 GiB\n memory and 2 vCPUs for builds.\n* For environment type `LINUX_GPU_CONTAINER`, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.\n* For environment type `ARM_CONTAINER`, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.\nIf you use `BUILD_GENERAL1_LARGE`:\n* For environment type `LINUX_CONTAINER`, you can use up to 16 GiB\n memory and 8 vCPUs for builds.\n* For environment type `LINUX_GPU_CONTAINER`, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.\n* For environment type `ARM_CONTAINER`, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.\nFor more information, see [On-demand environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types)\nin the *AWS CodeBuild User Guide.*\n*Required*: No\n*Type*: String\n*Allowed values*: `BUILD_GENERAL1_SMALL | BUIL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BUILD_GENERAL1_SMALL", "BUILD_GENERAL1_MEDIUM", "BUILD_GENERAL1_LARGE", "BUILD_GENERAL1_XLARGE", "BUILD_GENERAL1_2XLARGE", "ATTRIBUTE_BASED_COMPUTE", "CUSTOM_INSTANCE_TYPE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-computetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tag key and value pairs associated with this compute fleet.\nThese tags are available for use by AWS services that support AWS CodeBuild compute fleet tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codebuild-fleet-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the compute fleet.\n*Required*: No\n*Type*: String\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FleetVpcConfig": { "MarkdownDocumentation": "`FleetVpcConfig`\n\nInformation about the VPC configuration that AWS CodeBuild accesses.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-codebuild-fleet-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#cfn-codebuild-fleet-fleetvpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfig" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the compute fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html#Arn-fn::getatt" } } }, "AWS::CodeBuild::Project": { "MarkdownDocumentation": "`AWS::CodeBuild::Project`\n\nThe `AWS::CodeBuild::Project` resource configures how AWS CodeBuild builds your source\ncode. For example, it tells CodeBuild where to get the source code and which build environment to\nuse.\n###### Note\nTo unset or remove a project value via CFN, explicitly provide the attribute with value as empty input.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the name of the AWS CodeBuild project, such as `myProjectName`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the AWS CodeBuild project, such as `arn:aws:codebuild:us-west-2:123456789012:project/myProjectName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#Arn-fn::getatt" } }, "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA description that makes the build project easy to identify.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ResourceAccessRole": { "Required": false, "MarkdownDocumentation": "`ResourceAccessRole`\n\nThe ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for\nthe project's builds.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-resourceaccessrole", "PrimitiveType": "String", "UpdateType": "Mutable" }, "VpcConfig": { "Type": "VpcConfig", "Required": false, "MarkdownDocumentation": "`VpcConfig`\n\n`VpcConfig` specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see\n[Use AWS CodeBuild with Amazon Virtual Private Cloud](https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html) in\nthe *AWS CodeBuild User Guide*.\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-codebuild-project-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-vpcconfig", "UpdateType": "Mutable" }, "SecondarySources": { "Type": "List", "Required": false, "MarkdownDocumentation": "`SecondarySources`\n\nAn array of `ProjectSource` objects.\n*Required*: No\n*Type*: Array of [Source](./aws-properties-codebuild-project-source.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysources", "ItemType": "Source", "UpdateType": "Mutable" }, "EncryptionKey": { "Required": false, "MarkdownDocumentation": "`EncryptionKey`\n\nThe AWS Key Management Service customer master key (CMK) to be used for encrypting the build output\nartifacts.\n###### Note\nYou can use a cross-account KMS key to encrypt the build output artifacts if your\nservice role has permission to that key.\nYou can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\nthe format `alias/`). If you don't specify a\nvalue, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-encryptionkey", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecondaryArtifacts": { "Type": "List", "Required": false, "MarkdownDocumentation": "`SecondaryArtifacts`\n\nA list of `Artifacts` objects. Each artifacts object specifies output settings that the project generates during a build.\n*Required*: No\n*Type*: Array of [Artifacts](./aws-properties-codebuild-project-artifacts.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondaryartifacts", "ItemType": "Artifacts", "UpdateType": "Mutable" }, "Source": { "Type": "Source", "Required": true, "MarkdownDocumentation": "`Source`\n\nThe source code settings for the project, such as the source code's repository type and location.\n*Required*: Yes\n*Type*: [Source](./aws-properties-codebuild-project-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-source", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the build project. The name must be unique across all of the projects in your\nAWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{1,149}`\n*Minimum*: `2`\n*Maximum*: `150`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-name", "PrimitiveType": "String", "UpdateType": "Immutable" }, "LogsConfig": { "Type": "LogsConfig", "Required": false, "MarkdownDocumentation": "`LogsConfig`\n\nInformation about logs for the build project. A project can create logs in CloudWatch Logs, an\nS3 bucket, or both.\n*Required*: No\n*Type*: [LogsConfig](./aws-properties-codebuild-project-logsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-logsconfig", "UpdateType": "Mutable" }, "ServiceRole": { "Required": true, "MarkdownDocumentation": "`ServiceRole`\n\nThe ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services\non behalf of the AWS account.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-servicerole", "PrimitiveType": "String", "UpdateType": "Mutable" }, "QueuedTimeoutInMinutes": { "Required": false, "MarkdownDocumentation": "`QueuedTimeoutInMinutes`\n\nThe number of minutes a build is allowed to be queued before it times out.\n*Required*: No\n*Type*: Integer\n*Minimum*: `5`\n*Maximum*: `480`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-queuedtimeoutinminutes", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SecondarySourceVersions": { "Type": "List", "Required": false, "MarkdownDocumentation": "`SecondarySourceVersions`\n\nAn array of `ProjectSourceVersion` objects. If\n`secondarySourceVersions` is specified at the build level, then they take\nover these `secondarySourceVersions` (at the project level).\n*Required*: No\n*Type*: Array of [ProjectSourceVersion](./aws-properties-codebuild-project-projectsourceversion.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysourceversions", "ItemType": "ProjectSourceVersion", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.\nThese tags are available for use by AWS services that support AWS CodeBuild build project\ntags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codebuild-project-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "AutoRetryLimit": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-autoretrylimit", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "SourceVersion": { "Required": false, "MarkdownDocumentation": "`SourceVersion`\n\nA version of the build input to be built for this project. If not specified, the\nlatest version is used. If specified, it must be one of:\n* For CodeCommit: the commit ID, branch, or Git tag to use.\n* For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format `pr/pull-request-ID`\n (for example `pr/25`). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.\n* For GitLab: the commit ID, branch, or Git tag to use.\n* For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.\n* For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.\nIf `sourceVersion` is specified at the build level, then that version\ntakes precedence over this `sourceVersion` (at the project level).\nFor more information, see [Source Version Sample\nwith CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the *AWS CodeBuild 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-sourceversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Triggers": { "Type": "ProjectTriggers", "Required": false, "MarkdownDocumentation": "`Triggers`\n\nFor an existing AWS CodeBuild build project that has its source code stored\nin a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding\nthe source code every time a code change is pushed to the repository.\n*Required*: No\n*Type*: [ProjectTriggers](./aws-properties-codebuild-project-projecttriggers.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-triggers", "UpdateType": "Mutable" }, "Artifacts": { "Type": "Artifacts", "Required": true, "MarkdownDocumentation": "`Artifacts`\n\n`Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for\nartifacts generated by an AWS CodeBuild build.\n*Required*: Yes\n*Type*: [Artifacts](./aws-properties-codebuild-project-artifacts.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-artifacts", "UpdateType": "Mutable" }, "BadgeEnabled": { "Required": false, "MarkdownDocumentation": "`BadgeEnabled`\n\nIndicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. For more information,\nsee [Build Badges Sample](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-badges.html)\nin the *AWS CodeBuild User Guide*.\n###### Note\nIncluding build badges with your project is currently not supported if the source type is CodePipeline.\nIf you specify `CODEPIPELINE` for the `Source` property, do not specify the\n`BadgeEnabled` property.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-badgeenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "FileSystemLocations": { "Type": "List", "Required": false, "MarkdownDocumentation": "`FileSystemLocations`\n\nAn array of `ProjectFileSystemLocation` objects for a CodeBuild build project. A `ProjectFileSystemLocation` object\nspecifies the `identifier`, `location`, `mountOptions`,\n`mountPoint`, and `type` of a file system created using Amazon Elastic File System.\n*Required*: No\n*Type*: Array of [ProjectFileSystemLocation](./aws-properties-codebuild-project-projectfilesystemlocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-filesystemlocations", "ItemType": "ProjectFileSystemLocation", "UpdateType": "Mutable" }, "Environment": { "Type": "Environment", "Required": true, "MarkdownDocumentation": "`Environment`\n\nThe build environment settings for the project, such as the environment type or the\nenvironment variables to use for the build environment.\n*Required*: Yes\n*Type*: [Environment](./aws-properties-codebuild-project-environment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment", "UpdateType": "Mutable" }, "ConcurrentBuildLimit": { "Required": false, "MarkdownDocumentation": "`ConcurrentBuildLimit`\n\nThe maximum number of concurrent builds that are allowed for this project.\nNew builds are only started if the current number of builds is less than or equal to this limit.\nIf the current build count meets this limit, new builds are throttled and are not run.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-concurrentbuildlimit", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Visibility": { "Required": false, "MarkdownDocumentation": "`Visibility`\n\nSpecifies the visibility of the project's builds. Possible values are:\nPUBLIC\\_READ\nThe project builds are visible to the public.\n\nPRIVATE\nThe project builds are not visible to the public.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-visibility", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BuildBatchConfig": { "Type": "ProjectBuildBatchConfig", "Required": false, "MarkdownDocumentation": "`BuildBatchConfig`\n\nA\n`ProjectBuildBatchConfig`\nobject that defines the batch build\noptions for the project.\n*Required*: No\n*Type*: [ProjectBuildBatchConfig](./aws-properties-codebuild-project-projectbuildbatchconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-buildbatchconfig", "UpdateType": "Mutable" }, "TimeoutInMinutes": { "Required": false, "MarkdownDocumentation": "`TimeoutInMinutes`\n\nHow long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any\nrelated build that did not get marked as completed. The default is 60 minutes.\n*Required*: No\n*Type*: Integer\n*Minimum*: `5`\n*Maximum*: `2160`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-timeoutinminutes", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Cache": { "Type": "ProjectCache", "Required": false, "MarkdownDocumentation": "`Cache`\n\nSettings that AWS CodeBuild uses to store and reuse build dependencies.\n*Required*: No\n*Type*: [ProjectCache](./aws-properties-codebuild-project-projectcache.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-cache", "UpdateType": "Mutable" } } }, "AWS::CodeBuild::ReportGroup": { "MarkdownDocumentation": "`AWS::CodeBuild::ReportGroup`\n\nRepresents a report group. A report group contains a collection of reports.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref`\nreturns the ARN of the AWS CodeBuild report group, such as `arn:aws:codebuild:region:123456789012:report-group/myReportGroupName`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the AWS CodeBuild report group, such as\n`arn:aws:codebuild:region:123456789012:report-group/myReportGroupName`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#Arn-fn::getatt" } }, "Properties": { "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of the `ReportGroup`. This can be one of the following\nvalues:\nCODE\\_COVERAGE\nThe report group contains code coverage reports.\n\nTEST\nThe report group contains test reports.\n\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TEST | CODE_COVERAGE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TEST", "CODE_COVERAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-type", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ExportConfig": { "Type": "ReportExportConfig", "Required": true, "MarkdownDocumentation": "`ExportConfig`\n\nInformation about the destination where the raw data of this `ReportGroup`\nis exported.\n*Required*: Yes\n*Type*: [ReportExportConfig](./aws-properties-codebuild-reportgroup-reportexportconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-exportconfig", "UpdateType": "Mutable" }, "DeleteReports": { "Required": false, "MarkdownDocumentation": "`DeleteReports`\n\nWhen deleting a report group, specifies if reports within the report group should be\ndeleted.\ntrue\nDeletes any reports that belong to the report group before deleting the\nreport group.\n\nfalse\nYou must delete any reports in the report group. This is the default\nvalue. If you delete a report group that contains one or more reports, an\nexception is thrown.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-deletereports", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nA list of tag key and value pairs associated with this report group.\nThese tags are available for use by AWS services that support AWS CodeBuild report group\ntags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codebuild-reportgroup-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the `ReportGroup`.\n*Required*: No\n*Type*: String\n*Minimum*: `2`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::CodeBuild::SourceCredential": { "MarkdownDocumentation": "`AWS::CodeBuild::SourceCredential`\n\nInformation about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you\nuse AWS Secrets Manager to store your credentials. If you use\nSecrets Manager, you must have secrets in your secrets manager. For more\ninformation, see [Using Dynamic References to Specify Template Values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager).\n###### Important\nFor security purposes, do not use plain text in your CloudFormation template to store your credentials.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html", "Properties": { "ServerType": { "Required": true, "MarkdownDocumentation": "`ServerType`\n\nThe type of source provider. The valid options are GITHUB, GITHUB\\_ENTERPRISE, GITLAB, GITLAB\\_SELF\\_MANAGED, or\nBITBUCKET.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GITHUB | BITBUCKET | GITHUB...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "GITHUB", "BITBUCKET", "GITHUB_ENTERPRISE", "GITLAB", "GITLAB_SELF_MANAGED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-servertype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Username": { "Required": false, "MarkdownDocumentation": "`Username`\n\nThe Bitbucket username when the `authType` is BASIC\\_AUTH. This parameter\nis not valid for other types of source providers or connections.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Token": { "Required": true, "MarkdownDocumentation": "`Token`\n\nFor GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket,\nthis is either the access token or the app password. For the `authType` CODECONNECTIONS,\nthis is the `connectionArn`. For the `authType` SECRETS\\_MANAGER, this is the `secretArn`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-token", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AuthType": { "Required": true, "MarkdownDocumentation": "`AuthType`\n\nThe type of authentication used by the credentials. Valid options are OAUTH,\nBASIC\\_AUTH, PERSONAL\\_ACCESS\\_TOKEN, CODECONNECTIONS, or SECRETS\\_MANAGER.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OAUTH | BASIC_AUTH | PERSON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OAUTH", "BASIC_AUTH", "PERSONAL_ACCESS_TOKEN", "CODECONNECTIONS", "SECRETS_MANAGER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-authtype", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeCommit::Repository": { "MarkdownDocumentation": "`AWS::CodeCommit::Repository`\n\nCreates a new, empty repository.\n###### Important\nAWS CodeCommit is no longer available to new customers. Existing customers of\nAWS CodeCommit can continue to use the service as normal.\n[Learn more\"](https://aws.amazon.com/blogs/devops/how-to-migrate-your-aws-codecommit-repository-to-another-git-provider)\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function,\n`Ref` returns the repository ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html", "Attributes": { "CloneUrlHttp": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloneUrlHttp`\n\nWhen you pass the logical ID of this resource,\nthe function returns the URL to use for cloning the repository over HTTPS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#CloneUrlHttp-fn::getatt" }, "KmsKeyId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#KmsKeyId-fn::getatt" }, "CloneUrlSsh": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloneUrlSsh`\n\nWhen you pass the logical ID of this resource, the\nfunction returns the URL to use for cloning the repository over SSH.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#CloneUrlSsh-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nWhen you pass the logical ID of this resource, the\nfunction returns the Amazon Resource Name (ARN) of the repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nWhen you pass the logical ID of this resource, the\nfunction returns the repository's name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#Name-fn::getatt" } }, "Properties": { "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nThe ID of the AWS Key Management Service encryption key used to encrypt and decrypt the repository.\n###### Note\nThe input can be the full ARN, the key ID, or the key alias. For more information, see [Finding the key ID and key ARN](https://docs.aws.amazon.com/kms/latest/developerguide/find-cmk-id-arn.html).\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-kmskeyid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RepositoryName": { "Required": true, "MarkdownDocumentation": "`RepositoryName`\n\nThe name of the new repository to be created.\n###### Note\nThe repository name must be unique across the calling AWS account. Repository names\nare limited to 100 alphanumeric, dash, and underscore characters, and cannot include\ncertain characters. For more information about the limits on repository names, see\n[Quotas](https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) in the *AWS CodeCommit User Guide*. The\nsuffix .git is prohibited.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w\\.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositoryname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Triggers": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Triggers`\n\nThe JSON block of configuration information for each trigger.\n*Required*: No\n*Type*: Array of [RepositoryTrigger](./aws-properties-codecommit-repository-repositorytrigger.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-triggers", "ItemType": "RepositoryTrigger", "UpdateType": "Conditional" }, "Code": { "Type": "Code", "Required": false, "MarkdownDocumentation": "`Code`\n\nInformation about code to be committed to a repository after it is created in an\nAWS CloudFormation stack. Information about code is only used in resource\ncreation. Updates to a stack will not reflect changes made to code properties after\ninitial resource creation.\n###### Note\nYou can only use this property to add code when creating a repository with a\nCloudFormation template at creation time. This property cannot be used for\nupdating code to an existing repository.\n*Required*: No\n*Type*: [Code](./aws-properties-codecommit-repository-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-code", "UpdateType": "Mutable" }, "RepositoryDescription": { "Required": false, "MarkdownDocumentation": "`RepositoryDescription`\n\nA comment or description about the new repository.\n###### Note\nThe description field for a repository accepts all HTML characters and all valid\nUnicode characters. Applications that do not HTML-encode the description and display\nit in a webpage can expose users to potentially malicious code. Make sure that you\nHTML-encode the description field in any application that uses this API to display\nthe repository description on a webpage.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositorydescription", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOne or more tag key-value pairs to use when tagging this repository.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codecommit-repository-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::CodeConnections::Connection": { "MarkdownDocumentation": "`AWS::CodeConnections::Connection`\n\nA resource that is used to connect third-party source providers with services like CodePipeline.\nNote: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the\nconnection in the console.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection. Connection names must be unique in an AWS account.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-connectionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HostArn": { "MarkdownDocumentation": "`HostArn`\n\nThe Amazon Resource Name (ARN) of the host associated with the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-hostarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ProviderType": { "MarkdownDocumentation": "`ProviderType`\n\nThe name of the external provider where your third-party code repository is\nconfigured.\n*Required*: No\n*Type*: String\n*Allowed values*: `Bitbucket | GitHub | GitHub...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-providertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codeconnections-connection-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ConnectionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectionArn`\n\nThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\nreference when the connection is shared between AWS services.\n###### Note\nThe ARN is never reused if the connection is deleted.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#ConnectionArn-fn::getatt" }, "ConnectionStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectionStatus`\n\nThe current status of the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#ConnectionStatus-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nThe identifier of the external provider where your third-party code repository is configured.\nFor Bitbucket, this is the account ID of the owner of the Bitbucket repository.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#OwnerAccountId-fn::getatt" } } }, "AWS::CodeDeploy::Application": { "MarkdownDocumentation": "`AWS::CodeDeploy::Application`\n\nThe `AWS::CodeDeploy::Application` resource creates an AWS CodeDeploy\napplication. In CodeDeploy, an application is a name that functions as a container\nto ensure that the correct combination of revision, deployment configuration, and deployment\ngroup are referenced during a deployment. You can use the\n`AWS::CodeDeploy::DeploymentGroup` resource to associate the application with a\nCodeDeploy deployment group. For more information, see [CodeDeploy\nDeployments](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-steps.html) in the *AWS CodeDeploy User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::CodeDeploy::Application` resource to\nthe intrinsic `Ref` function, the function returns the application name, such as\n`myapplication-a123d0d1`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html", "Properties": { "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nA name for the application. If you don't specify a name, CloudFormation generates a\nunique physical ID and uses that ID for the application name. For more information, see [Name\nType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n###### Note\nUpdates to `ApplicationName` are not supported.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-applicationname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ComputePlatform": { "MarkdownDocumentation": "`ComputePlatform`\n\nThe compute platform that CodeDeploy deploys the application to.\n*Required*: No\n*Type*: String\n*Allowed values*: `Server | Lambda | ECS | Kub...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Server", "Lambda", "ECS", "Kubernetes" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-computeplatform", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to CodeDeploy applications to help you organize and\ncategorize them. Each tag consists of a key and an optional value, both of which you\ndefine.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codedeploy-application-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::CodeDeploy::DeploymentConfig": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentConfig`\n\nThe `AWS::CodeDeploy::DeploymentConfig` resource creates a set of deployment\nrules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy uses during a deployment. The deployment configuration specifies the number\nor percentage of instances that must remain available at any time during a deployment.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::CodeDeploy::DeploymentConfig` resource\nto the intrinsic `Ref` function, the function returns the deployment configuration\nname, such as `mydeploymentconfig-a123d0d1`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html", "Properties": { "ComputePlatform": { "MarkdownDocumentation": "`ComputePlatform`\n\nThe destination platform type for the deployment (`Lambda`,\n`Server`, or `ECS`).\n*Required*: No\n*Type*: String\n*Allowed values*: `Server | Lambda | ECS | Kub...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Server", "Lambda", "ECS", "Kubernetes" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-computeplatform", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ZonalConfig": { "MarkdownDocumentation": "`ZonalConfig`\n\nConfigure the `ZonalConfig` object if you want AWS CodeDeploy to\ndeploy your application to one [Availability Zone](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones) at a time, within an AWS Region.\nFor more information about the zonal configuration feature, see [zonal configuration](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User\nGuide*.\n*Required*: No\n*Type*: [ZonalConfig](./aws-properties-codedeploy-deploymentconfig-zonalconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig", "UpdateType": "Immutable", "Required": false, "Type": "ZonalConfig" }, "DeploymentConfigName": { "MarkdownDocumentation": "`DeploymentConfigName`\n\nA name for the deployment configuration. If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For\nmore information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must replace\nthe resource, specify a new name.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-deploymentconfigname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TrafficRoutingConfig": { "MarkdownDocumentation": "`TrafficRoutingConfig`\n\nThe configuration that specifies how the deployment traffic is routed.\n*Required*: No\n*Type*: [TrafficRoutingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-trafficroutingconfig", "UpdateType": "Immutable", "Required": false, "Type": "TrafficRoutingConfig" }, "MinimumHealthyHosts": { "MarkdownDocumentation": "`MinimumHealthyHosts`\n\nThe minimum number of healthy instances that should be available at any time during the\ndeployment. There are two parameters expected in the input: type and value.\nThe type parameter takes either of the following values:\n* HOST\\_COUNT: The value parameter represents the minimum number of healthy instances as\n an absolute value.\n* FLEET\\_PERCENT: The value parameter represents the minimum number of healthy instances\n as a percentage of the total number of instances in the deployment. If you specify\n FLEET\\_PERCENT, at the start of the deployment, AWS CodeDeploy converts the\n percentage to the equivalent number of instance and rounds up fractional instances.\nThe value parameter takes an integer.\nFor example, to set a minimum of 95% healthy instance, specify a type of FLEET\\_PERCENT and\na value of 95.\nFor more information about instance health, see [CodeDeploy Instance\nHealth](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) in the AWS CodeDeploy User Guide.\n*Required*: No\n*Type*: [MinimumHealthyHosts](./aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts", "UpdateType": "Immutable", "Required": false, "Type": "MinimumHealthyHosts" } } }, "AWS::CodeDeploy::DeploymentGroup": { "MarkdownDocumentation": "`AWS::CodeDeploy::DeploymentGroup`\n\nThe `AWS::CodeDeploy::DeploymentGroup` resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions\nare deployed to, along with other deployment options. For more information, see [CreateDeploymentGroup](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeploymentGroup.html) in the *CodeDeploy API\nReference*.\n###### Note\nAmazon ECS blue/green deployments through CodeDeploy do not use the\n`AWS::CodeDeploy::DeploymentGroup` resource. To perform Amazon ECS\nblue/green deployments, use the `AWS::CodeDeploy::BlueGreen` hook. See [Perform\nAmazon ECS blue/green deployments through CodeDeploy using CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html) for more information.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::CodeDeploy::DeploymentGroup` resource\nto the intrinsic `Ref` function, the function returns the deployment group name,\nsuch as `mydeploymentgroup-a123d0d1`.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html", "Properties": { "AlarmConfiguration": { "MarkdownDocumentation": "`AlarmConfiguration`\n\nInformation about the Amazon CloudWatch alarms that are associated with the\ndeployment group.\n*Required*: No\n*Type*: [AlarmConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-alarmconfiguration", "Required": false, "Type": "AlarmConfiguration", "UpdateType": "Mutable" }, "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nThe name of an existing CodeDeploy application to associate this deployment\ngroup with.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-applicationname", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "AutoRollbackConfiguration": { "MarkdownDocumentation": "`AutoRollbackConfiguration`\n\nInformation about the automatic rollback configuration that is associated with the\ndeployment group. If you specify this property, don't specify the `Deployment`\nproperty.\n*Required*: No\n*Type*: [AutoRollbackConfiguration](./aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration", "Required": false, "Type": "AutoRollbackConfiguration", "UpdateType": "Mutable" }, "AutoScalingGroups": { "MarkdownDocumentation": "`AutoScalingGroups`\n\nA list of associated Auto Scaling groups that CodeDeploy automatically\ndeploys revisions to when new instances are created. Duplicates are not allowed.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autoscalinggroups", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "BlueGreenDeploymentConfiguration": { "MarkdownDocumentation": "`BlueGreenDeploymentConfiguration`\n\nInformation about blue/green deployment options for a deployment group.\n*Required*: No\n*Type*: [BlueGreenDeploymentConfiguration](./aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration", "Required": false, "Type": "BlueGreenDeploymentConfiguration", "UpdateType": "Mutable" }, "Deployment": { "MarkdownDocumentation": "`Deployment`\n\nThe application revision to deploy to this deployment group. If you specify this\nproperty, your target application revision is deployed as soon as the provisioning process is\ncomplete. If you specify this property, don't specify the\n`AutoRollbackConfiguration` property.\n*Required*: No\n*Type*: [Deployment](./aws-properties-codedeploy-deploymentgroup-deployment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deployment", "Required": false, "Type": "Deployment", "UpdateType": "Mutable" }, "DeploymentConfigName": { "MarkdownDocumentation": "`DeploymentConfigName`\n\nA deployment configuration name or a predefined configuration name. With predefined\nconfigurations, you can deploy application revisions to one instance at a time\n(`CodeDeployDefault.OneAtATime`), half of the instances at a time\n(`CodeDeployDefault.HalfAtATime`), or all the instances at once\n(`CodeDeployDefault.AllAtOnce`). For more information and valid values, see\n[Working with Deployment Configurations](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html) in the *AWS CodeDeploy\nUser Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentconfigname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DeploymentGroupName": { "MarkdownDocumentation": "`DeploymentGroupName`\n\nA name for the deployment group. If you don't specify a name, CloudFormation\ngenerates a unique physical ID and uses that ID for the deployment group name. For more\ninformation, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must replace\nthe resource, specify a new name.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentgroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "DeploymentStyle": { "MarkdownDocumentation": "`DeploymentStyle`\n\nAttributes that determine the type of deployment to run and whether to route deployment\ntraffic behind a load balancer.\nIf you specify this property with a blue/green deployment type, don't specify the\n`AutoScalingGroups`, `LoadBalancerInfo`, or `Deployment`\nproperties.\n###### Note\nFor blue/green deployments, CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green\ndeployments using `AWS::CodeDeploy::BlueGreen` hook. See [Perform\nAmazon ECS blue/green deployments through CodeDeploy using CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html) for more information.\n*Required*: No\n*Type*: [DeploymentStyle](./aws-properties-codedeploy-deploymentgroup-deploymentstyle.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentstyle", "Required": false, "Type": "DeploymentStyle", "UpdateType": "Mutable" }, "ECSServices": { "MarkdownDocumentation": "`ECSServices`\n\nThe target Amazon ECS services in the deployment group. This applies only to\ndeployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name\npair using the format `:`.\n*Required*: No\n*Type*: Array of [ECSService](./aws-properties-codedeploy-deploymentgroup-ecsservice.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ecsservices", "DuplicatesAllowed": false, "ItemType": "ECSService", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Ec2TagFilters": { "MarkdownDocumentation": "`Ec2TagFilters`\n\nThe Amazon EC2 tags that are already applied to Amazon EC2 instances\nthat you want to include in the deployment group. CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group.\nDuplicates are not allowed.\nYou can specify `EC2TagFilters` or `Ec2TagSet`, but not both.\n*Required*: No\n*Type*: Array of [EC2TagFilter](./aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ec2tagfilters", "DuplicatesAllowed": false, "ItemType": "EC2TagFilter", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Ec2TagSet": { "MarkdownDocumentation": "`Ec2TagSet`\n\nInformation about groups of tags applied to Amazon EC2 instances. The deployment\ngroup includes only Amazon EC2 instances identified by all the tag groups. Cannot be\nused in the same call as `ec2TagFilter`.\n*Required*: No\n*Type*: [EC2TagSet](./aws-properties-codedeploy-deploymentgroup-ec2tagset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ec2tagset", "Required": false, "Type": "EC2TagSet", "UpdateType": "Mutable" }, "LoadBalancerInfo": { "MarkdownDocumentation": "`LoadBalancerInfo`\n\nInformation about the load balancer to use in a deployment. For more information, see\n [Integrating\nCodeDeploy with ELB](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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo", "Required": false, "Type": "LoadBalancerInfo", "UpdateType": "Mutable" }, "OnPremisesInstanceTagFilters": { "MarkdownDocumentation": "`OnPremisesInstanceTagFilters`\n\nThe on-premises instance tags already applied to on-premises instances that you want to\ninclude in the deployment group. CodeDeploy includes all on-premises instances\nidentified by any of the tags you specify in this deployment group. To register on-premises\ninstances with CodeDeploy, see [Working with On-Premises\nInstances for CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-on-premises.html) in the *AWS CodeDeploy User\nGuide*. Duplicates are not allowed.\nYou can specify `OnPremisesInstanceTagFilters` or\n`OnPremisesInstanceTagSet`, but not both.\n*Required*: No\n*Type*: Array of [TagFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-onpremisesinstancetagfilters", "DuplicatesAllowed": false, "ItemType": "TagFilter", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "OnPremisesTagSet": { "MarkdownDocumentation": "`OnPremisesTagSet`\n\nInformation about groups of tags applied to on-premises instances. The deployment group\nincludes only on-premises instances identified by all the tag groups.\nYou can specify `OnPremisesInstanceTagFilters` or\n`OnPremisesInstanceTagSet`, but not both.\n*Required*: No\n*Type*: [OnPremisesTagSet](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-onpremisestagset", "Required": false, "Type": "OnPremisesTagSet", "UpdateType": "Mutable" }, "OutdatedInstancesStrategy": { "MarkdownDocumentation": "`OutdatedInstancesStrategy`\n\nIndicates what happens when new Amazon EC2 instances are launched\nmid-deployment and do not receive the deployed application revision.\nIf this option is set to `UPDATE` or is unspecified, CodeDeploy initiates\none or more 'auto-update outdated instances' deployments to apply the deployed\napplication revision to the new Amazon EC2 instances.\nIf this option is set to `IGNORE`, CodeDeploy does not initiate a\ndeployment to update the new Amazon EC2 instances. This may result in instances\nhaving different revisions.\n*Required*: No\n*Type*: String\n*Allowed values*: `UPDATE | IGNORE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "UPDATE", "IGNORE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-outdatedinstancesstrategy", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ServiceRoleArn": { "MarkdownDocumentation": "`ServiceRoleArn`\n\nA service role Amazon Resource Name (ARN) that grants CodeDeploy permission to\nmake calls to AWS services on your behalf. For more information, see [Create a Service\nRole for AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html) in the *AWS CodeDeploy User\nGuide*.\n###### Note\nIn some cases, you might need to add a dependency on the service role's policy. For\nmore information, see IAM role policy in [DependsOn\nAttribute](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-servicerolearn", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to CodeDeploy deployment groups to help you organize and\ncategorize them. Each tag consists of a key and an optional value, both of which you\ndefine.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codedeploy-deploymentgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "TerminationHookEnabled": { "MarkdownDocumentation": "`TerminationHookEnabled`\n\nIndicates whether the deployment group was configured to have CodeDeploy\ninstall a termination hook into an Auto Scaling group.\nFor more information about the termination hook, see [How Amazon EC2 Auto Scaling works with CodeDeploy](https://docs.aws.amazon.com//codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors) in the\n*AWS CodeDeploy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-terminationhookenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "TriggerConfigurations": { "MarkdownDocumentation": "`TriggerConfigurations`\n\nInformation about triggers associated with the deployment group. Duplicates are not\nallowed\n*Required*: No\n*Type*: Array of [TriggerConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations", "DuplicatesAllowed": false, "ItemType": "TriggerConfig", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::CodeGuruProfiler::ProfilingGroup": { "MarkdownDocumentation": "`AWS::CodeGuruProfiler::ProfilingGroup`\n\nCreates a profiling group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the profiling group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html", "Properties": { "AnomalyDetectionNotificationConfiguration": { "MarkdownDocumentation": "`AnomalyDetectionNotificationConfiguration`\n\nAdds anomaly notifications for a profiling group.\n*Required*: No\n*Type*: Array of [Channel](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-anomalydetectionnotificationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Channel", "DuplicatesAllowed": true }, "AgentPermissions": { "MarkdownDocumentation": "`AgentPermissions`\n\nThe agent permissions attached to this profiling group. This action group grants\n`ConfigureAgent` and `PostAgentProfile` permissions to perform\nactions required by the profiling agent. The Json consists of key\n`Principals`.\n*Principals*: A list of string ARNs for the roles and users you want\nto grant access to the profiling group. Wildcards are not supported in the ARNs. You are\nallowed to provide up to 50 ARNs. An empty list is not permitted. This is a required key.\nFor more information, see [Resource-based policies\nin CodeGuru Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the *Amazon CodeGuru Profiler user\nguide*, [ConfigureAgent](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), and\n[PostAgentProfile](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html).\n*Required*: No\n*Type*: [AgentPermissions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-agentpermissions", "UpdateType": "Mutable", "Required": false, "Type": "AgentPermissions" }, "ComputePlatform": { "MarkdownDocumentation": "`ComputePlatform`\n\nThe compute platform of the profiling group. Use `AWSLambda` if your\napplication runs on AWS Lambda. Use `Default` if your application runs on a\ncompute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises\nserver, or a different platform. If not specified, `Default` is used. This\nproperty is immutable.\n*Required*: No\n*Type*: String\n*Allowed values*: `Default | AWSLambda...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Default", "AWSLambda" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-computeplatform", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ProfilingGroupName": { "MarkdownDocumentation": "`ProfilingGroupName`\n\nThe name of the profiling group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-profilinggroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to add to the created profiling group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codeguruprofiler-profilinggroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe full Amazon Resource Name (ARN) for that profiling group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#Arn-fn::getatt" } } }, "AWS::CodeGuruReviewer::RepositoryAssociation": { "MarkdownDocumentation": "`AWS::CodeGuruReviewer::RepositoryAssociation`\n\nThis resource configures how Amazon CodeGuru Reviewer retrieves the source code to be reviewed. You can use an\nAWS CloudFormation template to create an association with the following repository types:\n* AWS CodeCommit - For more information, see\n [Create an\n AWS CodeCommit repository association](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-codecommit-association.html) in the *Amazon CodeGuru Reviewer User Guide*.\n* Bitbucket - For more information, see\n [Create a\n Bitbucket repository association](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-bitbucket-association.html) in the *Amazon CodeGuru Reviewer User Guide*.\n* GitHub Enterprise Server - For more information, see\n [Create a\n GitHub Enterprise Server repository association](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) in the *Amazon CodeGuru Reviewer User Guide*.\n* S3Bucket - For more information, see\n [Create code reviews with GitHub Actions](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/working-with-cicd.html) in the *Amazon CodeGuru Reviewer User Guide*.\n###### Note\nYou cannot use a CloudFormation template to create an association with a GitHub repository.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function,\n`Ref` returns the Amazon Resource Name (ARN) of the AWS CodeGuru Reviewer\n[`RepositoryAssociation`](https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html),\nsuch as `arn:aws:codeguru-reviewer:region:123456789012:association/universally-unique-identifier`.\nFor more information about using the `Ref` function, see\n[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of repository that contains the source code to be reviewed. The valid values are:\n* `CodeCommit`\n* `Bitbucket`\n* `GitHubEnterpriseServer`\n* `S3Bucket`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CodeCommit | Bitbucket | Gi...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CodeCommit", "Bitbucket", "GitHubEnterpriseServer", "S3Bucket" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Owner": { "MarkdownDocumentation": "`Owner`\n\nThe owner of the repository. For a GitHub Enterprise Server or Bitbucket repository, this is the username\nfor the account that owns the repository.\n`Owner` must be specified for Bitbucket and GitHub Enterprise Server repositories. It has no effect if\nit is specified for an AWS CodeCommit repository.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S(.*\\S)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-owner", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the bucket. This is required for your S3Bucket repository. The name must start with the prefix `codeguru-reviewer-*`.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\S(.*\\S)?$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-bucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConnectionArn": { "MarkdownDocumentation": "`ConnectionArn`\n\nThe Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is\n`arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id`. For more information, see\n[Connection](https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) in\nthe *AWS CodeStar Connections API Reference*.\n`ConnectionArn` must be specified for Bitbucket and GitHub Enterprise Server repositories. It has no effect if\nit is specified for an AWS CodeCommit repository.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-connectionarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:\n* A *tag key* (for example, `CostCenter`,\n `Environment`, `Project`, or `Secret`). Tag\n keys are case sensitive.\n* An optional field known as a *tag value* (for example,\n `111122223333`, `Production`, or a team name).\n Omitting the tag value is the same as using an empty string. Like tag keys, tag\n values are case sensitive.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codegurureviewer-repositoryassociation-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the repository.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\S[\\w.-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AssociationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationArn`\n\nThe Amazon Resource Name (ARN) of the\n[`RepositoryAssociation`](https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) object.\nYou can retrieve this ARN by calling `ListRepositories`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#AssociationArn-fn::getatt" } } }, "AWS::CodePipeline::CustomActionType": { "MarkdownDocumentation": "`AWS::CodePipeline::CustomActionType`\n\nThe `AWS::CodePipeline::CustomActionType` resource creates a custom action\nfor activities that aren't included in the CodePipeline default actions, such as running an\ninternally developed build process or a test suite. You can use these custom actions in the\nstage of a pipeline. For more information, see [Create and Add a Custom\nAction in AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) in the *AWS CodePipeline User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the custom action name, such as\ncusto-MyCus-A1BCDEFGHIJ2.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html", "Properties": { "Category": { "MarkdownDocumentation": "`Category`\n\nThe category of the custom action, such as a build action or a test\naction.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Source | Build | Deploy | T...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InputArtifactDetails": { "MarkdownDocumentation": "`InputArtifactDetails`\n\nThe details of the input artifact for the action, such as its commit ID.\n*Required*: Yes\n*Type*: [ArtifactDetails](./aws-properties-codepipeline-customactiontype-artifactdetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails", "UpdateType": "Immutable", "Required": true, "Type": "ArtifactDetails" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe version identifier of the custom action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9A-Za-z_-]+`\n*Minimum*: `1`\n*Maximum*: `9`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OutputArtifactDetails": { "MarkdownDocumentation": "`OutputArtifactDetails`\n\nThe details of the output artifact of the action, such as its commit ID.\n*Required*: Yes\n*Type*: [ArtifactDetails](./aws-properties-codepipeline-customactiontype-artifactdetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails", "UpdateType": "Immutable", "Required": true, "Type": "ArtifactDetails" }, "ConfigurationProperties": { "MarkdownDocumentation": "`ConfigurationProperties`\n\nThe configuration properties for the custom action.\n###### Note\nYou can refer to a name in the configuration properties of the custom action\nwithin the URL templates by following the format of {Config:name}, as long as the\nconfiguration property is both required and not secret. For more information, see\n[Create a\nCustom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html).\n*Required*: No\n*Type*: [Array](./aws-properties-codepipeline-customactiontype-configurationproperties.html) of [ConfigurationProperties](./aws-properties-codepipeline-customactiontype-configurationproperties.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ConfigurationProperties", "DuplicatesAllowed": false }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nURLs that provide users information about this custom action.\n*Required*: No\n*Type*: [Settings](./aws-properties-codepipeline-customactiontype-settings.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings", "UpdateType": "Immutable", "Required": false, "Type": "Settings" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the custom action.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codepipeline-customactiontype-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Provider": { "MarkdownDocumentation": "`Provider`\n\nThe provider of the service used in the custom action, such as\nCodeDeploy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9A-Za-z_-]+`\n*Minimum*: `1`\n*Maximum*: `35`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::CodePipeline::Pipeline": { "MarkdownDocumentation": "`AWS::CodePipeline::Pipeline`\n\nThe `AWS::CodePipeline::Pipeline` resource creates a CodePipeline pipeline\nthat describes how software changes go through a release process. For more information, see\n[What Is\nCodePipeline?](https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html) in the *CodePipeline User Guide*.\nFor an example in YAML and JSON that contains the parameters in this reference, see\n[Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#aws-resource-codepipeline-pipeline--examples).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the pipeline name, such as\nmysta-MyPipeline-A1BCDEFGHIJ2.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html", "Properties": { "Variables": { "MarkdownDocumentation": "`Variables`\n\nA list that defines the pipeline variables for a pipeline resource. Variable names can\nhave alphanumeric and underscore characters, and the values must match\n`[A-Za-z0-9@\\-_]+`.\n*Required*: No\n*Type*: Array of [VariableDeclaration](./aws-properties-codepipeline-pipeline-variabledeclaration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-variables", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VariableDeclaration", "DuplicatesAllowed": false }, "ArtifactStores": { "MarkdownDocumentation": "`ArtifactStores`\n\nA mapping of `artifactStore` objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for\neach cross-region action in the pipeline.\n###### Note\nYou must include either `artifactStore` or\n`artifactStores` in your pipeline, but you cannot use both. If you\ncreate a cross-region action in your pipeline, you must use\n`artifactStores`.\n*Required*: Conditional\n*Type*: Array of [ArtifactStoreMap](./aws-properties-codepipeline-pipeline-artifactstoremap.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ArtifactStoreMap", "DuplicatesAllowed": false }, "ArtifactStore": { "MarkdownDocumentation": "`ArtifactStore`\n\nThe S3 bucket where artifacts for the pipeline are stored.\n###### Note\nYou must include either `artifactStore` or\n`artifactStores` in your pipeline, but you cannot use both. If you\ncreate a cross-region action in your pipeline, you must use\n`artifactStores`.\n*Required*: Conditional\n*Type*: [ArtifactStore](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore", "UpdateType": "Mutable", "Required": false, "Type": "ArtifactStore" }, "DisableInboundStageTransitions": { "MarkdownDocumentation": "`DisableInboundStageTransitions`\n\nRepresents the input of a `DisableStageTransition` action.\n*Required*: No\n*Type*: Array of [StageTransition](./aws-properties-codepipeline-pipeline-stagetransition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "StageTransition", "DuplicatesAllowed": false }, "Stages": { "MarkdownDocumentation": "`Stages`\n\nRepresents information about a stage and its definition.\n*Required*: Yes\n*Type*: Array of [StageDeclaration](./aws-properties-codepipeline-pipeline-stagedeclaration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "StageDeclaration", "DuplicatesAllowed": false }, "PipelineType": { "MarkdownDocumentation": "`PipelineType`\n\nCodePipeline provides the following pipeline types, which differ in\ncharacteristics and price, so that you can tailor your pipeline features and cost to the\nneeds of your applications.\n* V1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.\n* V2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.\n###### Important\nIncluding V2 parameters, such as triggers on Git tags, in the pipeline JSON when\ncreating or updating a pipeline will result in the pipeline having the V2 type of\npipeline and the associated costs.\nFor information about pricing for CodePipeline, see [Pricing](https://aws.amazon.com/codepipeline/pricing/).\nFor information about which type of pipeline to choose, see [What type of\npipeline is right for me?](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `V1 | V2`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "V1", "V2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-pipelinetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionMode": { "MarkdownDocumentation": "`ExecutionMode`\n\nThe method that the pipeline will use to handle multiple executions. The default\nmode is SUPERSEDED.\n*Required*: No\n*Type*: String\n*Allowed values*: `QUEUED | SUPERSEDED | PARAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "QUEUED", "SUPERSEDED", "PARALLEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-executionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RestartExecutionOnUpdate": { "MarkdownDocumentation": "`RestartExecutionOnUpdate`\n\nIndicates whether to rerun the CodePipeline pipeline after you update 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Triggers": { "MarkdownDocumentation": "`Triggers`\n\nThe trigger configuration specifying a type of event, such as Git tags, that starts\nthe pipeline.\n###### Note\nWhen a trigger configuration is specified, default change detection for\nrepository and branch commits is disabled.\n*Required*: No\n*Type*: Array of [PipelineTriggerDeclaration](./aws-properties-codepipeline-pipeline-pipelinetriggerdeclaration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-triggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PipelineTriggerDeclaration", "DuplicatesAllowed": false }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) for CodePipeline to use to either perform\nactions with no `actionRoleArn`, or to use to assume roles for actions with\nan `actionRoleArn`.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies the tags applied to the pipeline.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codepipeline-pipeline-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the pipeline.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version of the pipeline.\n###### Note\nA new pipeline is always assigned a version number of 1. This number increments when\na pipeline is updated.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#Version-fn::getatt" } } }, "AWS::CodePipeline::Webhook": { "MarkdownDocumentation": "`AWS::CodePipeline::Webhook`\n\nThe `AWS::CodePipeline::Webhook` resource creates and registers your\nwebhook. After the webhook is created and registered, it triggers your pipeline to start every\ntime an external event occurs. For more information, see [Migrate polling pipelines\nto use event-based change detection](https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html) in the *AWS CodePipeline User\nGuide*.\nWe strongly recommend that you use AWS Secrets Manager to store your\ncredentials. If you use Secrets Manager, you must have already configured and stored your\nsecret parameters in Secrets Manager. For more information, see [Using Dynamic References to Specify Template Values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager).\n###### Important\nWhen passing secret parameters, do not enter the value directly into the template. The\nvalue is rendered as plaintext and is therefore readable. For security reasons, do not use\nplaintext in your AWS CloudFormation template to store your credentials.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the webhook name, such as\nMyFirstPipeline-SourceAction1-Webhook-utb9LrOl24Kk.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html", "Properties": { "AuthenticationConfiguration": { "MarkdownDocumentation": "`AuthenticationConfiguration`\n\nProperties that configure the authentication applied to incoming webhook trigger\nrequests. The required properties depend on the authentication type. For GITHUB\\_HMAC,\nonly the `SecretToken` property must be set. For IP, only the\n`AllowedIPRange` property must be set to a valid CIDR range. For\nUNAUTHENTICATED, no properties can be set.\n*Required*: Yes\n*Type*: [WebhookAuthConfiguration](./aws-properties-codepipeline-webhook-webhookauthconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "WebhookAuthConfiguration" }, "Filters": { "MarkdownDocumentation": "`Filters`\n\nA list of rules applied to the body/payload sent in the POST request to a webhook\nURL. All defined rules must pass for the request to be accepted and the pipeline\nstarted.\n*Required*: Yes\n*Type*: Array of [WebhookFilterRule](./aws-properties-codepipeline-webhook-webhookfilterrule.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "WebhookFilterRule", "DuplicatesAllowed": true }, "Authentication": { "MarkdownDocumentation": "`Authentication`\n\nSupported options are GITHUB\\_HMAC, IP, and UNAUTHENTICATED.\n###### Important\nWhen creating CodePipeline webhooks, do not use your own credentials or\nreuse the same secret token across multiple webhooks. For optimal security, generate\na unique secret token for each webhook you create. The secret token is an arbitrary\nstring that you provide, which GitHub uses to compute and sign the webhook payloads\nsent to CodePipeline, for protecting the integrity and authenticity of the\nwebhook payloads. Using your own credentials or reusing the same token across\nmultiple webhooks can lead to security vulnerabilities.\n\n###### Note\nIf a secret token was provided, it will be redacted in the response.\n\n* For information about the authentication scheme implemented by GITHUB\\_HMAC,\n see [Securing your\n webhooks](https://developer.github.com/webhooks/securing/) on the GitHub Developer website.\n* IP rejects webhooks trigger requests unless they originate from an IP\n address in the IP range whitelisted in the authentication\n configuration.\n* UNAUTHENTICATED accepts all webhook trigger requests regardless of\n origin.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GITHUB_HMAC | IP | UNAUTHEN...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GITHUB_HMAC", "IP", "UNAUTHENTICATED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetPipeline": { "MarkdownDocumentation": "`TargetPipeline`\n\nThe name of the pipeline you want to connect to the webhook.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetAction": { "MarkdownDocumentation": "`TargetAction`\n\nThe name of the action in a pipeline you want to connect to the webhook. The action\nmust be from the source (first) stage of the pipeline.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the webhook.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TargetPipelineVersion": { "MarkdownDocumentation": "`TargetPipelineVersion`\n\nThe version number of the pipeline to be connected to the trigger request.\nRequired: Yes\nType: Integer\nUpdate requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n*Required*: No\n*Type*: Integer\n*Pattern*: `[A-Za-z0-9.@\\-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RegisterWithThirdParty": { "MarkdownDocumentation": "`RegisterWithThirdParty`\n\nConfigures a connection between the webhook that was created and the external tool\nwith events to be detected.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#Id-fn::getatt" }, "Url": { "PrimitiveType": "String", "MarkdownDocumentation": "`Url`\n\nThe webhook URL generated by AWS CodePipeline, such as\n`https://eu-central-1.webhooks.aws/trigger123456`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#Url-fn::getatt" } } }, "AWS::CodeStar::GitHubRepository": { "MarkdownDocumentation": "`AWS::CodeStar::GitHubRepository`\n\nThe `AWS::CodeStar::GitHubRepository` resource creates a GitHub repository\nwhere users can store source code for use with AWS workflows. You must\nprovide a location for the source code ZIP file in the CloudFormation template, so\nthe code can be uploaded to the created repository. You must have created a personal access\ntoken in GitHub to provide in the CloudFormation template. AWS uses\nthis token to connect to GitHub on your behalf.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string combination of the repository owner and the\nrepository name, such as `my-github-account/my-github-repo`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html", "Properties": { "EnableIssues": { "Required": false, "MarkdownDocumentation": "`EnableIssues`\n\nIndicates whether to enable issues for the GitHub repository. You can use GitHub\nissues to track information and bugs for your repository.\n*Required*: No\n*Type*: Boolean\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-enableissues", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ConnectionArn": { "Required": false, "MarkdownDocumentation": "`ConnectionArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-connectionarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RepositoryName": { "Required": true, "MarkdownDocumentation": "`RepositoryName`\n\nThe name of the repository you want to create in GitHub with CloudFormation\nstack creation.\n*Required*: Yes\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RepositoryAccessToken": { "Required": false, "MarkdownDocumentation": "`RepositoryAccessToken`\n\nThe GitHub user's personal access token for the GitHub repository.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryaccesstoken", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RepositoryOwner": { "Required": true, "MarkdownDocumentation": "`RepositoryOwner`\n\nThe GitHub user name for the owner of the GitHub repository to be created. If this\nrepository should be owned by a GitHub organization, provide its name.\n*Required*: Yes\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryowner", "PrimitiveType": "String", "UpdateType": "Mutable" }, "IsPrivate": { "Required": false, "MarkdownDocumentation": "`IsPrivate`\n\nIndicates whether the GitHub repository is a private repository. If so, you choose\nwho can see and commit to this repository.\n*Required*: No\n*Type*: Boolean\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-isprivate", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Code": { "Type": "Code", "Required": false, "MarkdownDocumentation": "`Code`\n\nInformation about code to be committed to a repository after it is created in an\nCloudFormation stack.\n*Required*: No\n*Type*: [Code](./aws-properties-codestar-githubrepository-code.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-code", "UpdateType": "Mutable" }, "RepositoryDescription": { "Required": false, "MarkdownDocumentation": "`RepositoryDescription`\n\nA comment or description about the new repository. This description is displayed in\nGitHub after the repository is created.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositorydescription", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::CodeStarConnections::Connection": { "MarkdownDocumentation": "`AWS::CodeStarConnections::Connection`\n\nThe AWS::CodeStarConnections::Connection resource can be used to connect external source\nproviders with services like AWS CodePipeline.\n**Note:** A connection created through CloudFormation is\nin `PENDING` status by default. You can make its status `AVAILABLE`\nby updating the connection in the console.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the connection. The ARN is\nused as the connection reference when the connection is shared between AWS\nservices. For example:\n`arn:aws:codestar-connections:us-west-2:123456789012:connection/39e4c34d-e13a-4e94-a886-ea67651bf042`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html", "Properties": { "ConnectionName": { "MarkdownDocumentation": "`ConnectionName`\n\nThe name of the connection. Connection names must be unique in an AWS account.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-connectionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HostArn": { "MarkdownDocumentation": "`HostArn`\n\nThe Amazon Resource Name (ARN) of the host associated with the connection.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-hostarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ProviderType": { "MarkdownDocumentation": "`ProviderType`\n\nThe name of the external provider where your third-party code repository is\nconfigured.\n*Required*: No\n*Type*: String\n*Allowed values*: `Bitbucket | GitHub | GitHub...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-providertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies the tags applied to the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codestarconnections-connection-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ConnectionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectionArn`\n\nThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\nreference when the connection is shared between AWS services. For example:\n`arn:aws:codestar-connections:us-west-2:123456789012:connection/39e4c34d-e13a-4e94-a886-ea67651bf042`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#ConnectionArn-fn::getatt" }, "ConnectionStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectionStatus`\n\nThe current status of the connection. For example: `PENDING`,\n`AVAILABLE`, or `ERROR`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#ConnectionStatus-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nThe AWS account ID of the owner of the connection. For Bitbucket, this\nis the account ID of the owner of the Bitbucket repository. For example:\n`123456789012`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#OwnerAccountId-fn::getatt" } } }, "AWS::CodeStarConnections::RepositoryLink": { "MarkdownDocumentation": "`AWS::CodeStarConnections::RepositoryLink`\n\nInformation about the repository link resource, such as the repository link ARN, the associated connection ARN, encryption key ARN, and owner ID.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the repository link. For\nexample:\n`arn:aws:codestar-connections:region:account-id:repository-link/repository-link-id`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html", "Properties": { "OwnerId": { "MarkdownDocumentation": "`OwnerId`\n\nThe owner ID for the repository associated with the repository link, such as the owner\nID in GitHub.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-ownerid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nThe Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn):.+:.+:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-encryptionkeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionArn": { "MarkdownDocumentation": "`ConnectionArn`\n\nThe Amazon Resource Name (ARN) of the connection associated with the repository link.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn):.+:.+:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-connectionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RepositoryName": { "MarkdownDocumentation": "`RepositoryName`\n\nThe name of the repository associated with the repository link.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-repositoryname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the repository to be associated with the repository link.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-codestarconnections-repositorylink-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "RepositoryLinkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RepositoryLinkArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#RepositoryLinkArn-fn::getatt" }, "ProviderType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProviderType`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#ProviderType-fn::getatt" }, "RepositoryLinkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RepositoryLinkId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#RepositoryLinkId-fn::getatt" } } }, "AWS::CodeStarConnections::SyncConfiguration": { "MarkdownDocumentation": "`AWS::CodeStarConnections::SyncConfiguration`\n\nInformation, such as repository, branch, provider, and resource names for a specific sync configuration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the sync configuration.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html", "Properties": { "ConfigFile": { "MarkdownDocumentation": "`ConfigFile`\n\nThe file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-configfile", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceName": { "MarkdownDocumentation": "`ResourceName`\n\nThe name of the connection resource associated with a specific sync configuration.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-resourcename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Branch": { "MarkdownDocumentation": "`Branch`\n\nThe branch associated with a specific sync configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-branch", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SyncType": { "MarkdownDocumentation": "`SyncType`\n\nThe type of sync for a specific sync configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CFN_STACK_SYNC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CFN_STACK_SYNC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-synctype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TriggerResourceUpdateOn": { "MarkdownDocumentation": "`TriggerResourceUpdateOn`\n\nWhen to trigger Git sync to begin the stack update.\n*Required*: No\n*Type*: String\n*Allowed values*: `ANY_CHANGE | FILE_CHANGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ANY_CHANGE", "FILE_CHANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-triggerresourceupdateon", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RepositoryLinkId": { "MarkdownDocumentation": "`RepositoryLinkId`\n\nThe ID of the repository link associated with a specific sync configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-repositorylinkid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:iam::\\d{12}:role/[a-zA-Z_0-9+=,.@\\-_/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PublishDeploymentStatus": { "MarkdownDocumentation": "`PublishDeploymentStatus`\n\nWhether to enable or disable publishing of deployment status to source providers.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-publishdeploymentstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe owner ID for the repository associated with a specific sync configuration, such as\nthe owner ID in GitHub.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#OwnerId-fn::getatt" }, "RepositoryName": { "PrimitiveType": "String", "MarkdownDocumentation": "`RepositoryName`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#RepositoryName-fn::getatt" }, "ProviderType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProviderType`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#ProviderType-fn::getatt" } } }, "AWS::CodeStarNotifications::NotificationRule": { "MarkdownDocumentation": "`AWS::CodeStarNotifications::NotificationRule`\n\nCreates a notification rule for a resource. The rule specifies the events you want\nnotifications about and the targets (such as Amazon Simple Notification Service topics or Amazon Q Developer in chat applications clients configured for Slack) where you want to receive\nthem.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, `Ref` returns the notification rule ARN.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html", "Properties": { "EventTypeIds": { "MarkdownDocumentation": "`EventTypeIds`\n\nA list of event types associated with this notification rule. For a complete list of event types and IDs, see\n[Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api)\nin the *Developer Tools Console User Guide*.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the notification rule. The default value is `ENABLED`. If the status is\nset to `DISABLED`, notifications aren't sent for the notification rule.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedBy": { "MarkdownDocumentation": "`CreatedBy`\n\nThe name or email alias of the person who created the notification 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-createdby", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DetailType": { "MarkdownDocumentation": "`DetailType`\n\nThe level of detail to include in the notifications for this resource. `BASIC` will include only the\ncontents of the event as it would appear in Amazon CloudWatch. `FULL` will include any supplemental information\nprovided 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)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "FULL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-detailtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Resource": { "MarkdownDocumentation": "`Resource`\n\nThe Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline,\nrepositories 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-resource", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EventTypeId": { "MarkdownDocumentation": "`EventTypeId`\n\nThe event type associated with this notification rule. For a complete list of event types and IDs, see\n[Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api) in the\n*Developer Tools Console User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetAddress": { "MarkdownDocumentation": "`TargetAddress`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic or Amazon Q Developer in chat applications client.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targetaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nA list of Amazon Resource Names (ARNs) of Amazon SNS topics and Amazon Q Developer in chat applications clients to associate with the\nnotification rule.\n*Required*: Yes\n*Type*: Array of [Target](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targets", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Target", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to apply to this notification rule. Key names cannot start with \"`aws`\".\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the notification rule. Notification rule names must be unique in your AWS account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9\\-_ ]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the notification rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#Arn-fn::getatt" } } }, "AWS::Cognito::IdentityPool": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPool`\n\nThe `AWS::Cognito::IdentityPool` resource creates an Amazon Cognito\nidentity pool.\nTo avoid deleting the resource accidentally from CloudFormation, use [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) and the [UpdateReplacePolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) to retain the resource on deletion or\nreplacement.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `IdentityPoolId`, such as\n`us-east-2:0d01f4d7-1305-4408-b437-12345EXAMPLE`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html", "Properties": { "PushSync": { "MarkdownDocumentation": "`PushSync`\n\nThe configuration options to be applied to the identity pool.\n*Required*: No\n*Type*: [PushSync](./aws-properties-cognito-identitypool-pushsync.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-pushsync", "UpdateType": "Mutable", "Required": false, "Type": "PushSync" }, "CognitoIdentityProviders": { "MarkdownDocumentation": "`CognitoIdentityProviders`\n\nThe Amazon Cognito user pools and their client IDs.\n*Required*: No\n*Type*: Array of [CognitoIdentityProvider](./aws-properties-cognito-identitypool-cognitoidentityprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoidentityproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CognitoIdentityProvider", "DuplicatesAllowed": true }, "CognitoEvents": { "MarkdownDocumentation": "`CognitoEvents`\n\nThe events to configure.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoevents", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DeveloperProviderName": { "MarkdownDocumentation": "`DeveloperProviderName`\n\nThe \"domain\" Amazon Cognito uses when referencing your users. This name acts as a\nplaceholder that allows your backend and the Amazon Cognito service to communicate about\nthe developer provider. For the `DeveloperProviderName`, you can use letters\nand periods (.), underscores (\\_), and dashes (-).\n*Minimum length*: 1\n*Maximum length*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-developerprovidername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CognitoStreams": { "MarkdownDocumentation": "`CognitoStreams`\n\nConfiguration options for configuring Amazon Cognito streams.\n*Required*: No\n*Type*: [CognitoStreams](./aws-properties-cognito-identitypool-cognitostreams.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitostreams", "UpdateType": "Mutable", "Required": false, "Type": "CognitoStreams" }, "IdentityPoolName": { "MarkdownDocumentation": "`IdentityPoolName`\n\nThe name of your Amazon Cognito identity pool.\n*Minimum length*: 1\n*Maximum length*: 128\n*Pattern*: `[\\w\\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-identitypoolname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SupportedLoginProviders": { "MarkdownDocumentation": "`SupportedLoginProviders`\n\nKey-value pairs that map provider names to provider app IDs.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-supportedloginproviders", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "AllowUnauthenticatedIdentities": { "MarkdownDocumentation": "`AllowUnauthenticatedIdentities`\n\nSpecifies whether the identity pool supports unauthenticated logins.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowunauthenticatedidentities", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "IdentityPoolTags": { "MarkdownDocumentation": "`IdentityPoolTags`\n\nTags to assign to the identity pool. A tag is a label that you can apply to identity\npools to categorize and manage them in different ways, such as by purpose, owner,\nenvironment, or other criteria.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-cognito-identitypool-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-identitypooltags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "SamlProviderARNs": { "MarkdownDocumentation": "`SamlProviderARNs`\n\nThe Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML)\nproviders.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-samlproviderarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "OpenIdConnectProviderARNs": { "MarkdownDocumentation": "`OpenIdConnectProviderARNs`\n\nThe Amazon Resource Names (ARNs) of the OpenID connect providers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-openidconnectproviderarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowClassicFlow": { "MarkdownDocumentation": "`AllowClassicFlow`\n\nEnables the Basic (Classic) authentication 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowclassicflow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#Id-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the Amazon Cognito identity pool, returned as a string.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#Name-fn::getatt" } } }, "AWS::Cognito::IdentityPoolPrincipalTag": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPoolPrincipalTag`\n\nA list of the identity pool principal tag assignments for attributes for access\ncontrol.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the principal tag primary ID, like\n`us-east-1:1cf667a2-49a6-454b-9e45-23199EXAMPLE|graph.facebook.com`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html", "Properties": { "PrincipalTags": { "MarkdownDocumentation": "`PrincipalTags`\n\nA JSON-formatted list of user claims and the principal tags that you want to associate\nwith them. When Amazon Cognito requests credentials, it sets the value of the principal\ntag to the value of the user's claim.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-principaltags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "UseDefaults": { "MarkdownDocumentation": "`UseDefaults`\n\nUse a default set of mappings between claims and tags for this provider, instead of a\ncustom map.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-usedefaults", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IdentityProviderName": { "MarkdownDocumentation": "`IdentityProviderName`\n\nThe identity pool identity provider (IdP) that you want to associate with this\nprincipal tag map.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-identityprovidername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IdentityPoolId": { "MarkdownDocumentation": "`IdentityPoolId`\n\nThe identity pool that you want to associate with this principal tag map.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-identitypoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::IdentityPoolRoleAttachment": { "MarkdownDocumentation": "`AWS::Cognito::IdentityPoolRoleAttachment`\n\nThe `AWS::Cognito::IdentityPoolRoleAttachment` resource manages the role\nconfiguration for an Amazon Cognito identity pool.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `IdentityPoolId`, such as\n`us-east-2:0d01f4d7-1305-4408-b437-12345EXAMPLE`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html", "Properties": { "RoleMappings": { "MarkdownDocumentation": "`RoleMappings`\n\nHow users for a specific identity provider are mapped to roles. This is a string to\nthe `RoleMapping` object map. The string identifies the identity provider.\nFor example: `graph.facebook.com` or\n`cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id`.\nIf the `IdentityProvider` field isn't provided in this object, the string\nis used as the identity provider name.\nFor more information, see the [RoleMapping property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html).\n*Required*: No\n*Type*: [RoleMapping](./aws-properties-cognito-identitypoolroleattachment-rolemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-rolemappings", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "RoleMapping" }, "IdentityPoolId": { "MarkdownDocumentation": "`IdentityPoolId`\n\nAn identity pool ID in the format `REGION:GUID`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-identitypoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Roles": { "MarkdownDocumentation": "`Roles`\n\nThe map of the roles associated with this pool. For a given role, the key is either\n\"authenticated\" or \"unauthenticated\". The value is the role ARN.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-roles", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe resource ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#Id-fn::getatt" } } }, "AWS::Cognito::LogDeliveryConfiguration": { "MarkdownDocumentation": "`AWS::Cognito::LogDeliveryConfiguration`\n\nSets up or modifies the logging configuration of a user pool. User pools can export\nuser notification logs and, when threat protection is active, user-activity logs. For\nmore information, see [Exporting user\npool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a resource identifier. A log delivery configuration\nattached to a user pool returns a user pool ID like\n`us-east-1_EXAMPLE`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html", "Properties": { "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool where you configured logging.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html#cfn-cognito-logdeliveryconfiguration-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LogConfigurations": { "MarkdownDocumentation": "`LogConfigurations`\n\nA logging destination of a user pool. User pools can have multiple logging\ndestinations for message-delivery and user-activity logs.\n*Required*: No\n*Type*: Array of [LogConfiguration](./aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LogConfiguration", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nA user pool ID, for example `us-east-1_EXAMPLE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html#Id-fn::getatt" } } }, "AWS::Cognito::ManagedLoginBranding": { "MarkdownDocumentation": "`AWS::Cognito::ManagedLoginBranding`\n\nCreates a new set of branding settings for a user pool style and associates it with an\napp client. This operation is the programmatic option for the creation of a new style in\nthe branding designer.\nProvides values for UI customization in a `Settings` JSON object and image\nfiles in an `Assets` array. To send the JSON object `Document`\ntype parameter in `Settings`, you might need to update to the most recent\nversion of your AWS SDK.\nThis operation has a 2-megabyte request-size limit and include the CSS settings and\nimage assets for your app client. Your branding settings might exceed 2MB in size.\nAmazon Cognito doesn't require that you pass all parameters in one request and preserves\nexisting style settings that you don't specify. If your request is larger than 2MB,\nseparate it into multiple requests, each with a size smaller than the limit.\nAs a best practice, modify the output of [DescribeManagedLoginBrandingByClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html) into the request parameters for this\noperation. To get all settings, set `ReturnMergedResources` to\n`true`. For more information, see [API and SDK operations for managed login branding](https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-brandingdesigner.html#branding-designer-api)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the style ID, for example\n`a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html", "Properties": { "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe user pool where the branding style is assigned.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UseCognitoProvidedValues": { "MarkdownDocumentation": "`UseCognitoProvidedValues`\n\nWhen true, applies the default branding style options. This option reverts to default\nstyle options that are managed by Amazon Cognito. You can modify them later in the branding\neditor.\nWhen you specify `true` for this option, you must also omit values for\n`Settings` and `Assets` in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-usecognitoprovidedvalues", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Assets": { "MarkdownDocumentation": "`Assets`\n\nAn array of image files that you want to apply to roles like backgrounds, logos, and\nicons. Each object must also indicate whether it is for dark mode, light mode, or\nbrowser-adaptive mode.\n*Required*: No\n*Type*: Array of [AssetType](./aws-properties-cognito-managedloginbranding-assettype.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-assets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AssetType", "DuplicatesAllowed": true }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe app client that you want to assign the branding style to. Each style is linked to\nan app client until you delete 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-clientid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nA JSON file, encoded as a `Document` type, with the the settings that you\nwant to apply to your style.\nThe following components are not currently implemented and reserved for future\nuse:\n* `signUp`\n* `instructions`\n* `sessionTimerDisplay`\n* `languageSelector` (for localization, see [Managed login localization)](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization)\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-settings", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "ReturnMergedResources": { "MarkdownDocumentation": "`ReturnMergedResources`\n\nWhen `true`, returns values for branding options that are unchanged from\nAmazon Cognito defaults. When `false` or when you omit this parameter, returns only\nvalues that you customized in your branding style.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-returnmergedresources", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "ManagedLoginBrandingId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ManagedLoginBrandingId`\n\nThe ID of the managed login branding style.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#ManagedLoginBrandingId-fn::getatt" } } }, "AWS::Cognito::Terms": { "MarkdownDocumentation": "`AWS::Cognito::Terms`\n\nCreates terms documents for the requested app client. When Terms and conditions and\nPrivacy policy documents are configured, the app client displays links to them in the\nsign-up page of managed login for the app client.\nYou can provide URLs for terms documents in the languages that are supported by [managed login localization](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization). Amazon Cognito directs users to the terms documents for\ntheir current language, with fallback to `default` if no document exists for\nthe language.\nEach request accepts one type of terms document and a map of language-to-link for that\ndocument type. You must provide both types of terms documents in at least one language\nbefore Amazon Cognito displays your terms documents. Supply each type in separate\nrequests.\nFor more information, see [Terms documents](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents).\n###### Note\nAmazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For\nthis operation, you must use IAM credentials to authorize requests, and you must\ngrant yourself the corresponding IAM permission in a policy.\n###### Learn more\n* [Signing AWS API Requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)\n* [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html", "Properties": { "Enforcement": { "MarkdownDocumentation": "`Enforcement`\n\nThis parameter is reserved for future use and currently accepts one value.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-enforcement", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool that contains the terms documents.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe ID of the app client that the terms documents are assigned to.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-clientid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TermsName": { "MarkdownDocumentation": "`TermsName`\n\nThe type and friendly name of the terms documents.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(terms-of-use|privacy-policy)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-termsname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Links": { "MarkdownDocumentation": "`Links`\n\nA map of URLs to languages. For each localized language that will view the requested\n`TermsName`, assign a URL. A selection of `cognito:default`\ndisplays for all languages that don't have a language-specific URL.\nFor example, `\"cognito:default\": \"https://terms.example.com\", \"cognito:spanish\":\n\"https://terms.example.com/es\"`.\n*Required*: Yes\n*Type*: Object of String\n*Pattern*: `^cognito:(default|english|french|spanish|german|bahasa-indonesia|italian|japanese|korean|portuguese-brazil|chinese-(simplified|traditional))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-links", "UpdateType": "Mutable", "Required": true, "Type": "Map", "PrimitiveItemType": "String" }, "TermsSource": { "MarkdownDocumentation": "`TermsSource`\n\nThis parameter is reserved for future use and currently accepts one value.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LINK`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "LINK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#cfn-cognito-terms-termssource", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "TermsId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TermsId`\n\nThe ID of the terms documents.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-terms.html#TermsId-fn::getatt" } } }, "AWS::Cognito::UserPool": { "MarkdownDocumentation": "`AWS::Cognito::UserPool`\n\nThe `AWS::Cognito::UserPool` resource creates an Amazon Cognito user pool.\nFor more information on working with Amazon Cognito user pools, see [Amazon Cognito\nUser Pools](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) and [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html).\n###### Note\nIf you don't specify a value for a parameter, Amazon Cognito sets it to a default\nvalue.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a generated ID, such as\n`us-east-2_zgaEXAMPLE`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html", "Properties": { "UserPoolTags": { "MarkdownDocumentation": "`UserPoolTags`\n\nThe tag keys and values to assign to the user pool. A tag is a label that you can use\nto categorize and manage user pools in different ways, such as by purpose, owner,\nenvironment, or other criteria.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Policies": { "MarkdownDocumentation": "`Policies`\n\nA list of user pool policies. Contains the policy that sets password-complexity\nrequirements.\n*Required*: No\n*Type*: [Policies](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies", "UpdateType": "Mutable", "Required": false, "Type": "Policies" }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nAn array of attributes for the new user pool. You can add custom attributes and modify\nthe properties of default attributes. The specifications in this parameter set the\nrequired attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html).\n*Required*: No\n*Type*: Array of [SchemaAttribute](./aws-properties-cognito-userpool-schemaattribute.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SchemaAttribute", "DuplicatesAllowed": true }, "AdminCreateUserConfig": { "MarkdownDocumentation": "`AdminCreateUserConfig`\n\nThe settings for administrator creation of users in a user pool. Contains settings for\nallowing user sign-up, customizing invitation messages to new users, and the amount of\ntime before temporary passwords expire.\n*Required*: No\n*Type*: [AdminCreateUserConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig", "UpdateType": "Mutable", "Required": false, "Type": "AdminCreateUserConfig" }, "UserPoolTier": { "MarkdownDocumentation": "`UserPoolTier`\n\nThe user pool [feature plan](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html), or tier. This parameter determines the\neligibility of the user pool for features like managed login, access-token\ncustomization, and threat protection. Defaults to `ESSENTIALS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `LITE | ESSENTIALS | PLUS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LITE", "ESSENTIALS", "PLUS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UsernameConfiguration": { "MarkdownDocumentation": "`UsernameConfiguration`\n\nSets the case sensitivity option for sign-in usernames. When\n`CaseSensitive` is `false` (case insensitive), users can sign\nin with any combination of capital and lowercase letters. For example,\n`username`, `USERNAME`, or `UserName`, or for\nemail, `email@example.com` or `EMaiL@eXamplE.Com`. For most use\ncases, set case sensitivity to `false` as a best practice. When usernames and\nemail addresses are case insensitive, Amazon Cognito treats any variation in case as the same\nuser, and prevents a case variation from being assigned to the same attribute for a\ndifferent user.\nWhen `CaseSensitive` is `true` (case sensitive), Amazon Cognito\ninterprets `USERNAME` and `UserName` as distinct users.\nThis configuration is immutable after you set it.\n*Required*: No\n*Type*: [UsernameConfiguration](./aws-properties-cognito-userpool-usernameconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "UsernameConfiguration" }, "UserPoolName": { "MarkdownDocumentation": "`UserPoolName`\n\nA friendly name for your user pool.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SmsVerificationMessage": { "MarkdownDocumentation": "`SmsVerificationMessage`\n\nThis parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html).\n*Required*: No\n*Type*: String\n*Minimum*: `6`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserAttributeUpdateSettings": { "MarkdownDocumentation": "`UserAttributeUpdateSettings`\n\nThe settings for updates to user attributes. These settings include the property `AttributesRequireVerificationBeforeUpdate`,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userattributeupdatesettings", "UpdateType": "Mutable", "Required": false, "Type": "UserAttributeUpdateSettings" }, "EmailConfiguration": { "MarkdownDocumentation": "`EmailConfiguration`\n\nThe email configuration of your user pool. The email configuration type sets your\npreferred sending method, AWS Region, and sender for messages from your user\npool.\n*Required*: No\n*Type*: [EmailConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EmailConfiguration" }, "SmsConfiguration": { "MarkdownDocumentation": "`SmsConfiguration`\n\nThe settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. To send SMS\nmessages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an\nAWS Identity and Access Management (IAM) role in your AWS account. For more information see\n[SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html).\n*Required*: No\n*Type*: [SmsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SmsConfiguration" }, "EmailVerificationSubject": { "MarkdownDocumentation": "`EmailVerificationSubject`\n\nThis parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html).\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WebAuthnRelyingPartyID": { "MarkdownDocumentation": "`WebAuthnRelyingPartyID`\n\nSets or displays the authentication domain, typically your user pool domain, that\npasskey providers must use as a relying party (RP) in their configuration.\nUnder the following conditions, the passkey relying party ID must be the\nfully-qualified domain name of your custom domain:\n* The user pool is configured for passkey authentication.\n* The user pool has a custom domain, whether or not it also has a prefix\n domain.\n* Your application performs authentication with managed login or the classic\n hosted UI.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnrelyingpartyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EmailAuthenticationSubject": { "MarkdownDocumentation": "`EmailAuthenticationSubject`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationsubject", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccountRecoverySetting": { "MarkdownDocumentation": "`AccountRecoverySetting`\n\nThe available verified method a user can use to recover their password when they call\n`ForgotPassword`. You can use this setting to define a preferred method\nwhen a user has more than one method available. With this setting, SMS doesn't qualify\nfor a valid password recovery mechanism if the user also has SMS multi-factor\nauthentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\nbehavior to determine the recovery method where SMS is preferred through email.\n*Required*: No\n*Type*: [AccountRecoverySetting](./aws-properties-cognito-userpool-accountrecoverysetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting", "UpdateType": "Mutable", "Required": false, "Type": "AccountRecoverySetting" }, "VerificationMessageTemplate": { "MarkdownDocumentation": "`VerificationMessageTemplate`\n\nThe template for the verification message that your user pool delivers to users who\nset an email address or phone number attribute.\nSet the email message type that corresponds to your `DefaultEmailOption`\nselection. For `CONFIRM_WITH_LINK`, specify an\n`EmailMessageByLink` and leave `EmailMessage` blank. For\n`CONFIRM_WITH_CODE`, specify an `EmailMessage` and leave\n`EmailMessageByLink` blank. When you supply both parameters with either\nchoice, Amazon Cognito returns an error.\n*Required*: No\n*Type*: [VerificationMessageTemplate](./aws-properties-cognito-userpool-verificationmessagetemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate", "UpdateType": "Mutable", "Required": false, "Type": "VerificationMessageTemplate" }, "MfaConfiguration": { "MarkdownDocumentation": "`MfaConfiguration`\n\nDisplays the state of multi-factor authentication (MFA) as on, off, or optional. When\n`ON`, all users must set up MFA before they can sign in. When\n`OPTIONAL`, your application must make a client-side determination of\nwhether a user wants to register an MFA device. For user pools with adaptive\nauthentication with threat protection, choose `OPTIONAL`.\nWhen `MfaConfiguration` is `OPTIONAL`, managed login\ndoesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in\nAPI responses and in managed login for users who have chosen and configured a preferred\nMFA factor.\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)", "RefReturnValue": "", "AllowedValues": [ "OFF", "ON", "OPTIONAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeletionProtection": { "MarkdownDocumentation": "`DeletionProtection`\n\nWhen active, `DeletionProtection` prevents accidental deletion of your user\npool. Before you can delete a user pool that you have protected against deletion, you\nmust deactivate this feature.\nWhen you try to delete a protected user pool in a `DeleteUserPool` API request,\nAmazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool,\nsend a new `DeleteUserPool` request after you deactivate deletion protection in an\n`UpdateUserPool` API request.\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)", "RefReturnValue": "", "AllowedValues": [ "ACTIVE", "INACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deletionprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SmsAuthenticationMessage": { "MarkdownDocumentation": "`SmsAuthenticationMessage`\n\nThe contents of the SMS authentication message.\n*Required*: No\n*Type*: String\n*Minimum*: `6`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WebAuthnUserVerification": { "MarkdownDocumentation": "`WebAuthnUserVerification`\n\nWhen `required`, users can only register and sign in users with passkeys\nthat are capable of [user\nverification](https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement). When `preferred`, your user pool doesn't\nrequire the use of authenticators with user verification but encourages it.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `9`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnuserverification", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserPoolAddOns": { "MarkdownDocumentation": "`UserPoolAddOns`\n\nContains settings for activation of threat protection, including the operating\nmode and additional authentication types. To log user security information but take\nno action, set to `AUDIT`. To configure automatic security responses to\npotentially unwanted traffic to your user pool, set to `ENFORCED`.\nFor more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html). To activate this setting, your user pool must be on the [Plus tier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html).\n*Required*: No\n*Type*: [UserPoolAddOns](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooladdons", "UpdateType": "Mutable", "Required": false, "Type": "UserPoolAddOns" }, "EmailAuthenticationMessage": { "MarkdownDocumentation": "`EmailAuthenticationMessage`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Minimum*: `6`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AliasAttributes": { "MarkdownDocumentation": "`AliasAttributes`\n\nAttributes supported as an alias for this user pool. For more information about alias\nattributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnabledMfas": { "MarkdownDocumentation": "`EnabledMfas`\n\nSet enabled MFA options on a specified user pool. To disable all MFAs after it has\nbeen enabled, set `MfaConfiguration` to `OFF` and remove\nEnabledMfas. MFAs can only be all disabled if `MfaConfiguration` is\n`OFF`. After you enable `SMS_MFA`, you can only disable it by\nsetting `MfaConfiguration` to `OFF`. Can be one of the following\nvalues:\n* `SMS_MFA` - Enables MFA with SMS for the user pool. To select this\n option, you must also provide values for `SmsConfiguration`.\n* `SOFTWARE_TOKEN_MFA` - Enables software token MFA for the user\n pool.\n* `EMAIL_OTP` - Enables MFA with email for the user pool. To select\n this option, you must provide values for `EmailConfiguration` and\n within those, set `EmailSendingAccount` to\n `DEVELOPER`.\nAllowed values: `SMS_MFA` | `SOFTWARE_TOKEN_MFA` |\n`EMAIL_OTP`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-enabledmfas", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LambdaConfig": { "MarkdownDocumentation": "`LambdaConfig`\n\nA collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\nstages of authentication operations. Triggers can modify the outcome of the operations\nthat invoked them.\n*Required*: No\n*Type*: [LambdaConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig", "UpdateType": "Mutable", "Required": false, "Type": "LambdaConfig" }, "UsernameAttributes": { "MarkdownDocumentation": "`UsernameAttributes`\n\nSpecifies whether a user can use an email address or phone number as a username when\nthey sign up.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AutoVerifiedAttributes": { "MarkdownDocumentation": "`AutoVerifiedAttributes`\n\nThe attributes that you want your user pool to automatically verify. For more\ninformation, see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DeviceConfiguration": { "MarkdownDocumentation": "`DeviceConfiguration`\n\nThe device-remembering configuration for a user pool. Device remembering or device\ntracking is a \"Remember me on this device\" option for user pools that perform\nauthentication with the device key of a trusted device in the back end, instead of a\nuser-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html). A null value indicates that\nyou have deactivated device remembering in your user pool.\n###### Note\nWhen you provide a value for any `DeviceConfiguration` field, you\nactivate the Amazon Cognito device-remembering feature. For more information, see [Working with devices](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html).\n*Required*: No\n*Type*: [DeviceConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DeviceConfiguration" }, "EmailVerificationMessage": { "MarkdownDocumentation": "`EmailVerificationMessage`\n\nThis parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html).\n*Required*: No\n*Type*: String\n*Minimum*: `6`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ProviderName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProviderName`\n\nA friendly name for the IdP.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#ProviderName-fn::getatt" }, "UserPoolId": { "PrimitiveType": "String", "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#UserPoolId-fn::getatt" }, "ProviderURL": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProviderURL`\n\nThe URL of the provider of the Amazon Cognito user pool, specified as a\n`String`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#ProviderURL-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the user pool, such as\n`arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#Arn-fn::getatt" } } }, "AWS::Cognito::UserPoolClient": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolClient`\n\nThe `AWS::Cognito::UserPoolClient` resource specifies an Amazon Cognito\nuser pool client.\n###### Note\nIf you don't specify a value for a parameter, Amazon Cognito sets it to a default\nvalue.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Cognito user pool client ID, such as\n`1h57kf5cpq17m0eml12EXAMPLE`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html", "Properties": { "AnalyticsConfiguration": { "MarkdownDocumentation": "`AnalyticsConfiguration`\n\nThe user pool analytics configuration for collecting metrics and sending them to your\nAmazon Pinpoint campaign.\nIn AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to\nanalytics or might be configurable with campaigns in the US East (N. Virginia) Region.\nFor more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html).\n*Required*: No\n*Type*: [AnalyticsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-analyticsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AnalyticsConfiguration" }, "GenerateSecret": { "MarkdownDocumentation": "`GenerateSecret`\n\nWhen `true`, generates a client secret for the app client. Client secrets\nare used with server-side and machine-to-machine applications. Client secrets are\nautomatically generated; you can't specify a secret value. For more information,\nsee [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-generatesecret", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "CallbackURLs": { "MarkdownDocumentation": "`CallbackURLs`\n\nA list of allowed redirect, or callback, URLs for managed login authentication. These\nURLs are the paths where you want to send your users' browsers after they complete\nauthentication with managed login or a third-party IdP. Typically, callback URLs are the\nhome of an application that uses OAuth or OIDC libraries to process authentication\noutcomes.\nA redirect URI must meet the following requirements:\n* Be an absolute URI.\n* Be registered with the authorization server. Amazon Cognito doesn't accept\n authorization requests with `redirect_uri` values that aren't in\n the list of `CallbackURLs` that you provide in this parameter.\n* Not include a fragment component.\nSee [OAuth 2.0 -\nRedirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2).\nAmazon Cognito requires HTTPS over HTTP except for callback URLs to\n`http://localhost`, `http://127.0.0.1` and\n`http://[::1]`. These callback URLs are for testing purposes only. You\ncan specify custom TCP ports for your callback URLs.\nApp callback URLs such as `myapp://example` are also supported.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-callbackurls", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnablePropagateAdditionalUserContextData": { "MarkdownDocumentation": "`EnablePropagateAdditionalUserContextData`\n\nWhen `true`, your application can include additional\n`UserContextData` in authentication requests. This data includes the IP\naddress, and contributes to analysis by threat protection features. For more information\nabout propagation of user context data, see [Adding session data to API requests](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint). If you don\u2019t include this parameter,\nyou can't send the source IP address to Amazon Cognito threat protection features. You can only\nactivate `EnablePropagateAdditionalUserContextData` in an app client that has\na 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-enablepropagateadditionalusercontextdata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IdTokenValidity": { "MarkdownDocumentation": "`IdTokenValidity`\n\nThe ID token time limit. After this limit expires, your user can't use\ntheir ID token. To specify the time unit for `IdTokenValidity` as\n`seconds`, `minutes`, `hours`, or `days`,\nset a `TokenValidityUnits` value in your API request.\nFor example, when you set `IdTokenValidity` as `10` and\n`TokenValidityUnits` as `hours`, your user can authenticate their\nsession with their ID token for 10 hours.\nThe default time unit for `IdTokenValidity` in an API request is hours.\n*Valid range* is displayed below in seconds.\nIf you don't specify otherwise in the configuration of your app client, your ID\ntokens are valid for one hour.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `86400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-idtokenvalidity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AuthSessionValidity": { "MarkdownDocumentation": "`AuthSessionValidity`\n\nAmazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration,\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-authsessionvalidity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RefreshTokenRotation": { "MarkdownDocumentation": "`RefreshTokenRotation`\n\nThe configuration of your app client for refresh token rotation. When enabled, your\napp client issues new ID, access, and refresh tokens when users renew their sessions\nwith refresh tokens. When disabled, token refresh issues only ID and access\ntokens.\n*Required*: No\n*Type*: [RefreshTokenRotation](./aws-properties-cognito-userpoolclient-refreshtokenrotation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-refreshtokenrotation", "UpdateType": "Mutable", "Required": false, "Type": "RefreshTokenRotation" }, "AllowedOAuthScopes": { "MarkdownDocumentation": "`AllowedOAuthScopes`\n\nThe OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app\nclient to authorize access with. Scopes govern access control to user pool self-service\nAPI operations, user data from the `userInfo` endpoint, and third-party APIs.\nScope values include `phone`, `email`, `openid`, and\n`profile`. The `aws.cognito.signin.user.admin` scope\nauthorizes user self-service operations. Custom scopes with resource servers authorize\naccess to external APIs.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthscopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TokenValidityUnits": { "MarkdownDocumentation": "`TokenValidityUnits`\n\nThe units that validity times are represented in. The default unit for refresh tokens\nis days, and the default for ID and access tokens are hours.\n*Required*: No\n*Type*: [TokenValidityUnits](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-tokenvalidityunits", "UpdateType": "Mutable", "Required": false, "Type": "TokenValidityUnits" }, "ReadAttributes": { "MarkdownDocumentation": "`ReadAttributes`\n\nThe list of user attributes that you want your app client to have read access to.\nAfter your user authenticates in your app, their access token authorizes them to read\ntheir own attribute value for any attribute in this list. An example of this kind of\nactivity is when your user selects a link to view their profile information.\nWhen you don't specify the `ReadAttributes` for your app client, your app\ncan read the values of `email_verified`, `phone_number_verified`,\nand the Standard attributes of your user pool. When your user pool app client has read\naccess to these default attributes, `ReadAttributes` doesn't return any\ninformation. Amazon Cognito only populates `ReadAttributes` in the API\nresponse if you have specified your own custom set of read attributes.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowedOAuthFlowsUserPoolClient": { "MarkdownDocumentation": "`AllowedOAuthFlowsUserPoolClient`\n\nSet to `true` to use OAuth 2.0 authorization server features in your app client.\nThis parameter must have a value of `true` before you can configure\nthe following features in your app client.\n* `CallBackURLs`: Callback URLs.\n* `LogoutURLs`: Sign-out redirect URLs.\n* `AllowedOAuthScopes`: OAuth 2.0 scopes.\n* `AllowedOAuthFlows`: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.\nTo use authorization server features, configure one of these features in the Amazon Cognito console or set\n`AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or\n`UpdateUserPoolClient` API request. If you don't set a value for\n`AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults\nto `false`. When `false`, only SDK-based API sign-in is permitted.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DefaultRedirectURI": { "MarkdownDocumentation": "`DefaultRedirectURI`\n\nThe default redirect URI. In app clients with one assigned IdP, replaces\n`redirect_uri` in authentication requests. Must be in the\n`CallbackURLs` list.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-defaultredirecturi", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SupportedIdentityProviders": { "MarkdownDocumentation": "`SupportedIdentityProviders`\n\nA list of provider names for the identity providers (IdPs) that are supported on this\nclient. The following are supported: `COGNITO`, `Facebook`,\n`Google`, `SignInWithApple`, and `LoginWithAmazon`.\nYou can also specify the names that you configured for the SAML and OIDC IdPs in your\nuser pool, for example `MySAMLIdP` or `MyOIDCIdP`.\nThis parameter sets the IdPs that [managed\nlogin](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) will display on the login page for your app client. The removal of\n`COGNITO` from this list doesn't prevent authentication operations\nfor local users with the user pools API in an AWS SDK. The only way to prevent\nSDK-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-supportedidentityproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ClientName": { "MarkdownDocumentation": "`ClientName`\n\nA friendly name for the app client that you want to create.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-clientname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool where you want to create an app client.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AllowedOAuthFlows": { "MarkdownDocumentation": "`AllowedOAuthFlows`\n\nThe OAuth grant types that you want your app client to generate for clients in managed\nlogin authentication. To create an app client that generates client credentials grants,\nyou must add `client_credentials` as the only allowed OAuth flow.\ncode\nUse a code grant flow, which provides an authorization code as the\nresponse. This code can be exchanged for access tokens with the\n`/oauth2/token` endpoint.\n\nimplicit\nIssue the access token, and the ID token when scopes like\n`openid` and `profile` are requested, directly to\nyour user.\n\nclient\\_credentials\nIssue the access token from the `/oauth2/token` endpoint\ndirectly to a non-person user, authorized by a combination of the client ID\nand client secret.\n\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflows", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ExplicitAuthFlows": { "MarkdownDocumentation": "`ExplicitAuthFlows`\n\nThe [authentication flows](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html) that you want your user pool client to support. For each app\nclient in your user pool, you can sign in your users with any combination of one or more flows, including with\na user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that\nyou define with Lambda functions.\n###### Note\nIf you don't specify a value for `ExplicitAuthFlows`, your app client supports\n`ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`.\nThe values for authentication flow options include the following.\n* `ALLOW_USER_AUTH`: Enable selection-based sign-in\n with `USER_AUTH`. This setting covers username-password,\n secure remote password (SRP), passwordless, and passkey authentication.\n This authentiation flow can do username-password and SRP authentication\n without other `ExplicitAuthFlows` permitting them. For example\n users can complete an SRP challenge through `USER_AUTH`\n without the flow `USER_SRP_AUTH` being active for the app\n client. This flow doesn't include `CUSTOM_AUTH`.\n \n To activate this setting, your user pool must be in the [Essentials tier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html) or higher.\n* `ALLOW_ADMIN_USER_PASSWORD_AUTH`: Enable admin based user password\n authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting replaces\n the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app\n passes a user name and password to Amazon Cognito in the request, instead of using the Secure\n Remote Password (SRP) protocol to securely transmit the password.\n* `ALLOW_CUSTOM_AUTH`: Enable Lambda trigger based\n authentication.\n* `ALLOW_USER_PASSWORD_AUTH`: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n 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\n tokens.\nIn some environments, you will see the values `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`.\nYou can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`,\nlike `ALLOW_USER_SRP_AUTH`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-explicitauthflows", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LogoutURLs": { "MarkdownDocumentation": "`LogoutURLs`\n\nA list of allowed logout URLs for managed login authentication. When you pass\n`logout_uri` and `client_id` parameters to\n`/logout`, Amazon Cognito signs out your user and redirects them to the logout\nURL. This parameter describes the URLs that you want to be the permitted targets of\n`logout_uri`. A typical use of these URLs is when a user selects \"Sign\nout\" and you redirect them to your public homepage. For more information, see [Logout\nendpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html).\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-logouturls", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AccessTokenValidity": { "MarkdownDocumentation": "`AccessTokenValidity`\n\nThe access token time limit. After this limit expires, your user can't use\ntheir access token. To specify the time unit for `AccessTokenValidity` as\n`seconds`, `minutes`, `hours`, or `days`,\nset a `TokenValidityUnits` value in your API request.\nFor example, when you set `AccessTokenValidity` to `10` and\n`TokenValidityUnits` to `hours`, your user can authorize access with\ntheir access token for 10 hours.\nThe default time unit for `AccessTokenValidity` in an API request is hours.\n*Valid range* is displayed below in seconds.\nIf you don't specify otherwise in the configuration of your app client, your access\ntokens are valid for one hour.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `86400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-accesstokenvalidity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RefreshTokenValidity": { "MarkdownDocumentation": "`RefreshTokenValidity`\n\nThe refresh token time limit. After this limit expires, your user can't use\ntheir refresh token. To specify the time unit for `RefreshTokenValidity` as\n`seconds`, `minutes`, `hours`, or `days`,\nset a `TokenValidityUnits` value in your API request.\nFor example, when you set `RefreshTokenValidity` as `10` and\n`TokenValidityUnits` as `days`, your user can refresh their session\nand retrieve new access and ID tokens for 10 days.\nThe default time unit for `RefreshTokenValidity` in an API request is days.\nYou can't set `RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the\nvalue with the default value of 30 days. *Valid range* is displayed below\nin seconds.\nIf you don't specify otherwise in the configuration of your app client, your refresh\ntokens are valid for 30 days.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-refreshtokenvalidity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "WriteAttributes": { "MarkdownDocumentation": "`WriteAttributes`\n\nThe list of user attributes that you want your app client to have write access to.\nAfter your user authenticates in your app, their access token authorizes them to set or\nmodify their own attribute value for any attribute in this list.\nWhen you don't specify the `WriteAttributes` for your app client, your app\ncan write the values of the Standard attributes of your user pool. When your user pool\nhas write access to these default attributes, `WriteAttributes` doesn't\nreturn any information. Amazon Cognito only populates `WriteAttributes` in\nthe API response if you have specified your own custom set of write attributes.\nIf your app client allows users to sign in through an IdP, this array must include all\nattributes that you have mapped to IdP attributes. Amazon Cognito updates mapped\nattributes when users sign in to your application through an IdP. If your app client\ndoes not have write access to a mapped attribute, Amazon Cognito throws an error when it\ntries 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-writeattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PreventUserExistenceErrors": { "MarkdownDocumentation": "`PreventUserExistenceErrors`\n\nErrors and responses that you want Amazon Cognito APIs to return during\nauthentication, account confirmation, and password recovery when the user doesn't exist\nin the user pool. When set to `ENABLED` and the user doesn't exist,\nauthentication returns an error indicating either the username or password was\nincorrect. Account confirmation and password recovery return a response indicating a\ncode was sent to a simulated destination. When set to `LEGACY`, those APIs\nreturn a `UserNotFoundException` exception if the user doesn't exist in the\nuser pool.\nValid values include:\n* `ENABLED` - This prevents user existence-related errors.\n* `LEGACY` - This represents the early behavior of Amazon Cognito\n where user existence related errors aren't prevented.\nDefaults to `LEGACY` when you don't provide a value.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEGACY | ENABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEGACY", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-preventuserexistenceerrors", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableTokenRevocation": { "MarkdownDocumentation": "`EnableTokenRevocation`\n\nActivates or deactivates token revocation.\nIf you don't include this parameter, token revocation is automatically activated for\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-enabletokenrevocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "ClientSecret": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#ClientSecret-fn::getatt" }, "ClientId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClientId`\n\nThe ID of the app client, for example `1example23456789`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#ClientId-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#Name-fn::getatt" } } }, "AWS::Cognito::UserPoolDomain": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolDomain`\n\nThe AWS::Cognito::UserPoolDomain resource creates a new domain for a user pool.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns physicalResourceId, which is \u201cDomain\". For\nexample:\n`{ \"Ref\": \"your-test-domain\" }`\nFor the Amazon Cognito user pool domain `your-test-domain`, Ref returns the\nname of the user pool domain.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html", "Properties": { "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool that is associated with the domain you're updating.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CustomDomainConfig": { "MarkdownDocumentation": "`CustomDomainConfig`\n\nThe configuration for a custom domain that hosts the sign-up and sign-in pages for\nyour application. Use this object to specify an SSL certificate that is managed by\nACM.\nWhen you create a custom domain, the passkey RP ID defaults to the custom domain. If\nyou had a prefix domain active, this will cause passkey integration for your prefix\ndomain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey\nintegration working, you can explicitly set RP ID to the prefix domain.\n*Required*: No\n*Type*: [CustomDomainConfigType](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomDomainConfigType" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe name of the domain that you want to update. For custom domains, this is the\nfully-qualified domain name, for example `auth.example.com`. For prefix\ndomains, this is the prefix alone, such as `myprefix`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-domain", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ManagedLoginVersion": { "MarkdownDocumentation": "`ManagedLoginVersion`\n\nA version number that indicates the state of managed login for your domain. Version\n`1` is hosted UI (classic). Version `2` is the newer managed\nlogin with the branding editor. For more information, see [Managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-managedloginversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "CloudFrontDistribution": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloudFrontDistribution`\n\nThe Amazon CloudFront endpoint that you use as the target of the alias that you set up\nwith your Domain Name Service (DNS) provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#CloudFrontDistribution-fn::getatt" } } }, "AWS::Cognito::UserPoolGroup": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolGroup`\n\nA user pool group. Contains details about the group and the way that it contributes to\nIAM role decisions with identity pools. Identity pools can make decisions about the IAM\nrole to assign based on groups: users get credentials for the role associated with their\nhighest-priority group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the user pool group. For example:\n`Admins`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nA name for the group. This name must be unique in your user pool.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-groupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the group that you're creating.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool where you want to create a user group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Precedence": { "MarkdownDocumentation": "`Precedence`\n\nA non-negative integer value that specifies the precedence of this group relative to\nthe other groups that a user can belong to in the user pool. Zero is the highest\nprecedence value. Groups with lower `Precedence` values take precedence over\ngroups with higher or null `Precedence` values. If a user belongs to two or\nmore groups, it is the group with the lowest precedence value whose role ARN is given in\nthe user's tokens for the `cognito:roles` and\n`cognito:preferred_role` claims.\nTwo groups can have the same `Precedence` value. If this happens, neither\ngroup takes precedence over the other. If two groups with the same\n`Precedence` have the same role ARN, that role is used in the\n`cognito:preferred_role` claim in tokens for users in each group. If the\ntwo groups have different role ARNs, the `cognito:preferred_role` claim isn't\nset in users' tokens.\nThe default `Precedence` value is null. The maximum `Precedence`\nvalue is `2^31-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-precedence", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) for the IAM role that you want to associate with the\ngroup. A group role primarily declares a preferred role for the credentials that you get\nfrom an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim\nthat presents the highest-precedence group that a user belongs to. Both ID and access\ntokens also contain a `cognito:groups` claim that list all the groups that a\nuser is a member of.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolIdentityProvider": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolIdentityProvider`\n\nThe `AWS::Cognito::UserPoolIdentityProvider` resource creates an identity\nprovider for a user pool.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns physicalResourceId, which is \u201cProviderName\". For\nexample:\n`{ \"Ref\": \"testProvider\" }`\nFor the Amazon Cognito identity provider `testProvider`, Ref returns the\nname of the identity provider.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html", "Properties": { "ProviderName": { "MarkdownDocumentation": "`ProviderName`\n\nThe name that you want to assign to the IdP. You can pass the identity provider name\nin the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated\nIdP.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe Id of the user pool where you want to create an IdP.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AttributeMapping": { "MarkdownDocumentation": "`AttributeMapping`\n\nA mapping of IdP attributes to standard and custom user pool attributes. Specify a\nuser pool attribute as the key of the key-value pair, and the IdP attribute claim name\nas the value.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-attributemapping", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ProviderDetails": { "MarkdownDocumentation": "`ProviderDetails`\n\nThe scopes, URLs, and identifiers for your external identity provider. The following\nexamples describe the provider detail keys for each IdP type. These values and their\nschema are subject to change. Social IdP `authorize_scopes` values must match\nthe values listed here.\nOpenID Connect (OIDC)\nAmazon Cognito accepts the following elements when it can't discover endpoint\nURLs from `oidc_issuer`: `attributes_url`,\n`authorize_url`, `jwks_uri`,\n`token_url`.\nCreate or update request: `\"ProviderDetails\": {\n\"attributes_request_method\": \"GET\", \"attributes_url\":\n\"https://auth.example.com/userInfo\", \"authorize_scopes\": \"openid profile\nemail\", \"authorize_url\": \"https://auth.example.com/authorize\",\n\"client_id\": \"1example23456789\", \"client_secret\":\n\"provider-app-client-secret\", \"jwks_uri\":\n\"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":\n\"https://auth.example.com\", \"token_url\": \"https://example.com/token\"\n}`\nDescribe response: `\"ProviderDetails\": { \"attributes_request_method\":\n\"GET\", \"attributes_url\": \"https://auth.example.com/userInfo\",\n\"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"openid\nprofile email\", \"authorize_url\": \"https://auth.example.com/authorize\",\n\"client_id\": \"1example23456789\", \"client_secret\":\n\"provider-app-client-secret\", \"jwks_uri\":\n\"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":\n\"https://auth.example.com\", \"token_url\": \"https://example.com/token\"\n}`\n\nSAML\nCreate or update request with Metadata URL: `\"ProviderDetails\": { \"IDPInit\": \"true\",\n\"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"MetadataURL\":\n\"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":\n\"rsa-sha256\" }`\nCreate or update request with Metadata file: `\"ProviderDetails\": { \"IDPInit\": \"true\",\n\"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\",\n\"MetadataFile\": \"[metadata XML]\", \"RequestSigningAlgorithm\":\n\"rsa-sha256\" }`\nThe value of `MetadataFile` must be the plaintext metadata document with all\nquote (\") characters escaped by backslashes.\nDescribe response: `\"ProviderDetails\": { \"IDPInit\": \"true\",\n\"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"ActiveEncryptionCertificate\": \"[certificate]\",\n\"MetadataURL\": \"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":\n\"rsa-sha256\", \"SLORedirectBindingURI\":\n\"https://auth.example.com/slo/saml\", \"SSORedirectBindingURI\":\n\"https://auth.example.com/sso/saml\" }`\n\nLoginWithAmazon\nCreate or update request: `\"ProviderDetails\": { \"authorize_scopes\":\n\"profile postal_code\", \"client_id\":\n\"amzn1.application-oa2-client.1example23456789\", \"client_secret\":\n\"provider-app-client-secret\"`\nDescribe response: `\"ProviderDetails\": { \"attributes_url\":\n\"https://api.amazon.com/user/profile\", \"attributes_url_add_attributes\":\n\"false\", \"authorize_scopes\": \"profile postal_code\", \"authorize_url\":\n\"https://www.amazon.com/ap/oa\", \"client_id\":\n\"amzn1.application-oa2-client.1example23456789\", \"client_secret\":\n\"provider-app-client-secret\", \"token_request_method\": \"POST\",\n\"token_url\": \"https://api.amazon.com/auth/o2/token\" }`\n\nGoogle\nCreate or update request: `\"ProviderDetails\": { \"authorize_scopes\":\n\"email profile openid\", \"client_id\":\n\"1example23456789.apps.googleusercontent.com\", \"client_secret\":\n\"provider-app-client-secret\" }`\nDescribe response: `\"ProviderDetails\": { \"attributes_url\":\n\"https://people.googleapis.com/v1/people/me?personFields=\",\n\"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"email\nprofile openid\", \"authorize_url\":\n\"https://accounts.google.com/o/oauth2/v2/auth\", \"client_id\":\n\"1example23456789.apps.googleusercontent.com\", \"client_secret\":\n\"provider-app-client-secret\", \"oidc_issuer\":\n\"https://accounts.google.com\", \"token_request_method\": \"POST\",\n\"token_url\": \"https://www.googleapis.com/oauth2/v4/token\"\n}`\n\nSignInWithApple\nCreate or update request: `\"ProviderDetails\": { \"authorize_scopes\":\n\"email name\", \"client_id\": \"com.example.cognito\", \"private_key\": \"1EXAMPLE\",\n\"key_id\": \"2EXAMPLE\", \"team_id\": \"3EXAMPLE\" }`\nDescribe response: `\"ProviderDetails\": {\n\"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"email\nname\", \"authorize_url\": \"https://appleid.apple.com/auth/authorize\",\n\"client_id\": \"com.example.cognito\", \"key_id\": \"1EXAMPLE\", \"oidc_issuer\":\n\"https://appleid.apple.com\", \"team_id\": \"2EXAMPLE\",\n\"token_request_method\": \"POST\", \"token_url\":\n\"https://appleid.apple.com/auth/token\" }`\n\nFacebook\nCreate or update request: `\"ProviderDetails\": { \"api_version\": \"v17.0\",\n\"authorize_scopes\": \"public_profile, email\", \"client_id\": \"1example23456789\",\n\"client_secret\": \"provider-app-client-secret\" }`\nDescribe response: `\"ProviderDetails\":\n{ \"api_version\": \"v17.0\", \"attributes_url\": \"https://graph.facebook.com/v17.0/me?fields=\",\n\"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"public_profile, email\",\n\"authorize_url\": \"https://www.facebook.com/v17.0/dialog/oauth\", \"client_id\":\n\"1example23456789\", \"client_secret\": \"provider-app-client-secret\", \"token_request_method\":\n\"GET\", \"token_url\": \"https://graph.facebook.com/v17.0/oauth/access_token\" }`\n\n*Required*: Yes\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providerdetails", "UpdateType": "Mutable", "Required": true, "Type": "Map", "PrimitiveItemType": "String" }, "ProviderType": { "MarkdownDocumentation": "`ProviderType`\n\nThe type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With\nAmazon, Sign In With Apple, Google, and Facebook IdPs.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SAML | Facebook | Google | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providertype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IdpIdentifiers": { "MarkdownDocumentation": "`IdpIdentifiers`\n\nAn array of IdP identifiers, for example `\"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\"\n]`. Identifiers are friendly names that you can pass in the\n`idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP.\nIdentifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html).\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-idpidentifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::Cognito::UserPoolResourceServer": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolResourceServer`\n\nThe `AWS::Cognito::UserPoolResourceServer` resource creates a new OAuth2.0\nresource server and defines custom scopes in it.\n###### Note\nIf you don't specify a value for a parameter, Amazon Cognito sets it to a default\nvalue.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns physicalResourceId, which is the resource server\nidentifier \u201cIdentifier\". For example:\n`{ \"Ref\": \"yourResourceServerIdentifier\" }`\nFor the Amazon Cognito resource server `yourResourceServerIdentifier`, Ref\nreturns the name of the resource server.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html", "Properties": { "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool where you want to create a resource server.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nA unique resource server identifier for the resource server. The identifier can be an\nAPI friendly name like `solar-system-data`. You can also set an API URL like\n`https://solar-system-data-api.example.com` as your identifier.\nAmazon Cognito represents scopes in the access token in the format\n`$resource-server-identifier/$scope`. Longer scope-identifier strings\nincrease the size of your access tokens.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\x21\\x23-\\x5B\\x5D-\\x7E]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-identifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Scopes": { "MarkdownDocumentation": "`Scopes`\n\nA list of scopes. Each scope is a map with keys `ScopeName` and\n`ScopeDescription`.\n*Required*: No\n*Type*: Array of [ResourceServerScopeType](./aws-properties-cognito-userpoolresourceserver-resourceserverscopetype.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-scopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceServerScopeType", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA friendly name for the resource server.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w\\s+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolRiskConfigurationAttachment": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolRiskConfigurationAttachment`\n\nThe `AWS::Cognito::UserPoolRiskConfigurationAttachment` resource sets the\nrisk configuration that is used for Amazon Cognito advanced security features.\nYou can specify risk configuration for a single client (with a specific\n`clientId`) or for all clients (by setting the `clientId` to\n`ALL`). If you specify `ALL`, the default configuration is\nused for every client that has had no risk configuration set previously. If you specify\nrisk configuration for a particular client, it no longer falls back to the\n`ALL` configuration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the physicalResourceId, which is\n\u201cUserPoolRiskConfigurationAttachment-UserPoolId-ClientId\". For example:\n`{ \"Ref\":\n\u201cUserPoolRiskConfigurationAttachment-us-east-1_FAKEPOOLID-2asc123fakeclientidajjulj6bh\u201d\n}`\nFor the Amazon Cognito risk configuration attachment\n`UserPoolRiskConfigurationAttachment-us-east-1_FAKEPOOLID-2asc123fakeclientidajjulj6bh`,\nRef returns the name of the risk configuration attachment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html", "Properties": { "CompromisedCredentialsRiskConfiguration": { "MarkdownDocumentation": "`CompromisedCredentialsRiskConfiguration`\n\nSettings for compromised-credentials actions and authentication types with threat\nprotection in full-function `ENFORCED` mode.\n*Required*: No\n*Type*: [CompromisedCredentialsRiskConfigurationType](./aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CompromisedCredentialsRiskConfigurationType" }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool that has the risk configuration applied.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe app client where this configuration is applied. When this parameter isn't present,\nthe risk configuration applies to all user pool app clients that don't have\nclient-level settings.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-clientid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccountTakeoverRiskConfiguration": { "MarkdownDocumentation": "`AccountTakeoverRiskConfiguration`\n\nThe settings for automated responses and notification templates for adaptive\nauthentication with threat protection.\n*Required*: No\n*Type*: [AccountTakeoverRiskConfigurationType](./aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AccountTakeoverRiskConfigurationType" }, "RiskExceptionConfiguration": { "MarkdownDocumentation": "`RiskExceptionConfiguration`\n\nExceptions to the risk evaluation configuration, including always-allow and\nalways-block IP address ranges.\n*Required*: No\n*Type*: [RiskExceptionConfigurationType](./aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RiskExceptionConfigurationType" } } }, "AWS::Cognito::UserPoolUICustomizationAttachment": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolUICustomizationAttachment`\n\nA container for the UI customization information for the hosted UI in a user\npool.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the physicalResourceId, which is\n\u201cUserPoolUICustomizationAttachment-UserPoolId-ClientId\". For example:\n`{ \"Ref\":\n\"UserPoolUICustomizationAttachment-us-east-1_FAKEPOOLID-2asc123fakeclientidajjulj6bh\"\n}`\nFor the Amazon Cognito user pool domain\n`UserPoolUICustomizationAttachment-us-east-1_FAKEPOOLID-2asc123fakeclientidajjulj6bh`,\nRef returns the name of the UI customization attachment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html", "Properties": { "CSS": { "MarkdownDocumentation": "`CSS`\n\nA plaintext CSS file that contains the custom fields that you want to apply to your\nuser pool or app client. To download a template, go to the Amazon Cognito console. Navigate to\nyour user pool *App clients* tab, select *Login\npages*, edit *Hosted UI (classic) style*, and select\nthe link to `CSS template.css`.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-css", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool where you want to apply branding to the classic hosted\nUI.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClientId": { "MarkdownDocumentation": "`ClientId`\n\nThe app client ID for your UI customization. When this value isn't present, the\ncustomization applies to all user pool app clients that don't have client-level\nsettings..\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-clientid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Cognito::UserPoolUser": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolUser`\n\nThe `AWS::Cognito::UserPoolUser` resource creates an Amazon Cognito user\npool user.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the user. For example:\n`admin`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html", "Properties": { "ValidationData": { "MarkdownDocumentation": "`ValidationData`\n\nTemporary user attributes that contribute to the outcomes of your pre sign-up Lambda\ntrigger. This set of key-value pairs are for custom validation of information that you\ncollect from your users but don't need to retain.\nYour Lambda function can analyze this additional data and act on it. Your function\ncan automatically confirm and verify select users or perform external API operations\nlike logging user attributes and validation data to Amazon CloudWatch Logs.\nFor more information about the pre sign-up Lambda trigger, see [Pre sign-up Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html).\n*Required*: No\n*Type*: Array of [AttributeType](./aws-properties-cognito-userpooluser-attributetype.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AttributeType", "DuplicatesAllowed": true }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool where you want to create a user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Username": { "MarkdownDocumentation": "`Username`\n\nThe value that you want to set as the username sign-in attribute. The following\nconditions apply to the username parameter.\n* The username can't be a duplicate of another username in the same user\n pool.\n* You can't change the value of a username after you create it.\n* You can only provide a value if usernames are a valid sign-in attribute for\n your user pool. If your user pool only supports phone numbers or email addresses\n as sign-in attributes, Amazon Cognito automatically generates a username value. For more\n information, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases).\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MessageAction": { "MarkdownDocumentation": "`MessageAction`\n\nSet to `RESEND` to resend the invitation message to a user that already\nexists, and to reset the temporary-password duration with a new temporary password. Set\nto `SUPPRESS` to suppress sending the message. You can specify only one\nvalue.\n*Required*: No\n*Type*: String\n*Allowed values*: `RESEND | SUPPRESS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "RESEND", "SUPPRESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-messageaction", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClientMetadata": { "MarkdownDocumentation": "`ClientMetadata`\n\nA map of custom key-value pairs that you can provide as input for any custom workflows\nthat this action triggers. You create custom workflows by assigning AWS Lambda functions\nto user pool triggers.\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\nfunction receives as input. This payload contains a `clientMetadata`\nattribute that provides the data that you assigned to the ClientMetadata parameter in\nyour request. In your function code, you can process the `clientMetadata`\nvalue to enhance your workflow for your specific needs.\nTo review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see [Connecting API actions to Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event) in the *Amazon Cognito Developer Guide*.\n###### Note\nWhen you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the\nfollowing:\n* Store the `ClientMetadata` value. This data is available only\n to AWS Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n `ClientMetadata` parameter serves no purpose.\n* Validate the `ClientMetadata` value.\n* Encrypt the `ClientMetadata` value. Don't send sensitive\n information in this parameter.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "DesiredDeliveryMediums": { "MarkdownDocumentation": "`DesiredDeliveryMediums`\n\nSpecify `EMAIL` if email will be used to send the welcome message. Specify\n`SMS` if the phone number will be used. The default value is\n`SMS`. You can specify more than one value.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ForceAliasCreation": { "MarkdownDocumentation": "`ForceAliasCreation`\n\nThis parameter is used only if the `phone_number_verified` or\n`email_verified` attribute is set to `True`. Otherwise, it is\nignored.\nIf this parameter is set to `True` and the phone number or email address\nspecified in the `UserAttributes` parameter already exists as an alias with a\ndifferent user, this request migrates the alias from the previous user to the\nnewly-created user. The previous user will no longer be able to log in using that\nalias.\nIf this parameter is set to `False`, the API throws an\n`AliasExistsException` error if the alias already exists. The default\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "UserAttributes": { "MarkdownDocumentation": "`UserAttributes`\n\nAn array of name-value pairs that contain user attributes and attribute values to be\nset for the user to be created. You can create a user without specifying any attributes\nother than `Username`. However, any attributes that you specify as required\n(when creating a user pool or in the **Attributes** tab of\nthe console) either you should supply (in your call to `AdminCreateUser`) or\nthe user should supply (when they sign up in response to your welcome message).\nFor custom attributes, you must prepend the `custom:` prefix to the\nattribute name.\nTo send a message inviting the user to sign up, you must specify the user's email\naddress or phone number. You can do this in your call to AdminCreateUser or in the\n**Users** tab of the Amazon Cognito console for\nmanaging your user pools.\nYou must also provide an email address or phone number when you expect the user to do\npasswordless sign-in with an email or SMS OTP. These attributes must be provided when\npasswordless options are the only available, or when you don't submit a\n`TemporaryPassword`.\nIn your call to `AdminCreateUser`, you can set the\n`email_verified` attribute to `True`, and you can set the\n`phone_number_verified` attribute to `True`.\n* **email**: The email address of the user to whom\n the message that contains the code and username will be sent. Required if the\n `email_verified` attribute is set to `True`, or if\n `\"EMAIL\"` is specified in the `DesiredDeliveryMediums`\n parameter.\n* **phone\\_number**: The phone number of the user to\n whom the message that contains the code and username will be sent. Required if\n the `phone_number_verified` attribute is set to `True`, or\n if `\"SMS\"` is specified in the `DesiredDeliveryMediums`\n parameter.\n*Required*: No\n*Type*: Array of [AttributeType](./aws-properties-cognito-userpooluser-attributetype.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AttributeType", "DuplicatesAllowed": true } } }, "AWS::Cognito::UserPoolUserToGroupAttachment": { "MarkdownDocumentation": "`AWS::Cognito::UserPoolUserToGroupAttachment`\n\nAdds a user to a group. A user who is in a group can present a preferred-role claim to\nan identity pool, and populates a `cognito:groups` claim to their access and\nidentity tokens.\n###### Note\nAmazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For\nthis operation, you must use IAM credentials to authorize requests, and you must\ngrant yourself the corresponding IAM permission in a policy.\n###### Learn more\n* [Signing AWS API Requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)\n* [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a generated ID, such as\n`UserToGroupAttachment-YejJvzrEXAMPLE`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the group that you want to add your user to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-groupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UserPoolId": { "MarkdownDocumentation": "`UserPoolId`\n\nThe ID of the user pool that contains the group that you want to add the user\nto.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+`\n*Minimum*: `1`\n*Maximum*: `55`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-userpoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Username": { "MarkdownDocumentation": "`Username`\n\nThe user's username.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-username", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Comprehend::DocumentClassifier": { "MarkdownDocumentation": "`AWS::Comprehend::DocumentClassifier`\n\nThis resource creates and trains a document classifier to categorize documents. You provide a set of training documents\nthat are labeled with the categories that you want to identify.\nAfter the classifier is trained you can use it to categorize a set of labeled\ndocuments into the categories. For more information, see\n[Document Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)\nin the Comprehend Developer Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the document classifier.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html", "Properties": { "LanguageCode": { "MarkdownDocumentation": "`LanguageCode`\n\nThe language of the input documents. You can specify any of the languages\nsupported by Amazon Comprehend. All documents must be in the same language.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `en | es | fr | it | de | pt...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "en", "es", "fr", "it", "de", "pt" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-languagecode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DataAccessRoleArn": { "MarkdownDocumentation": "`DataAccessRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that\ngrants Amazon Comprehend read access to your input data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-dataaccessrolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OutputDataConfig": { "MarkdownDocumentation": "`OutputDataConfig`\n\nProvides output results configuration parameters for custom classifier jobs.\n*Required*: No\n*Type*: [DocumentClassifierOutputDataConfig](./aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-outputdataconfig", "UpdateType": "Immutable", "Required": false, "Type": "DocumentClassifierOutputDataConfig" }, "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nConfiguration parameters for a private Virtual Private Cloud (VPC) containing the\nresources you are using for your custom classifier. For more information, see [Amazon\nVPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-comprehend-documentclassifier-vpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-vpcconfig", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfig" }, "DocumentClassifierName": { "MarkdownDocumentation": "`DocumentClassifierName`\n\nThe name of the document classifier.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-documentclassifiername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nIndicates the mode in which the classifier will be trained. The classifier can be trained\nin multi-class (single-label) mode or multi-label mode.\nMulti-class mode identifies a single class label for each document and\nmulti-label mode identifies one or more class labels for each document. Multiple\nlabels for an individual document are separated by a delimiter. The default delimiter between\nlabels is a pipe (|).\n*Required*: No\n*Type*: String\n*Allowed values*: `MULTI_CLASS | MULTI_LABEL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "MULTI_CLASS", "MULTI_LABEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-mode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VolumeKmsKeyId": { "MarkdownDocumentation": "`VolumeKmsKeyId`\n\nID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\ndata on the storage volume attached to the ML compute instance(s) that process the analysis\njob. The VolumeKmsKeyId can be either of the following formats:\n* KMS Key ID: `\"1234abcd-12ab-34cd-56ef-1234567890ab\"`\n* Amazon Resource Name (ARN) of a KMS Key:\n `\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-volumekmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ModelKmsKeyId": { "MarkdownDocumentation": "`ModelKmsKeyId`\n\nID for the AWS KMS key that Amazon Comprehend uses to encrypt\ntrained custom models. The ModelKmsKeyId can be either of the following formats:\n* KMS Key ID: `\"1234abcd-12ab-34cd-56ef-1234567890ab\"`\n* Amazon Resource Name (ARN) of a KMS Key:\n `\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelkmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VersionName": { "MarkdownDocumentation": "`VersionName`\n\nThe version name given to the newly created classifier. Version names can have a maximum\nof 256 characters. Alphanumeric characters, hyphens (-) and underscores (\\_) are allowed. The\nversion name must be unique among all models with the same classifier name in the AWS account/AWS Region.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-versionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ModelPolicy": { "MarkdownDocumentation": "`ModelPolicy`\n\nThe resource-based policy to attach to your custom document classifier model. You can use\nthis policy to allow another AWS account to import your custom model.\nProvide your policy as a JSON body that you enter as a UTF-8 encoded string without line\nbreaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the\nJSON body is also enclosed in double quotes, then you must escape the double quotes that are\ninside the policy:\n`\"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"`\nTo avoid escaping quotes, you can use single quotes to enclose the policy and double\nquotes to enclose the JSON names and values:\n`'{\"attribute\": \"value\", \"attribute\": [\"value\"]}'`\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputDataConfig": { "MarkdownDocumentation": "`InputDataConfig`\n\nSpecifies the format and location of the input data for the job.\n*Required*: Yes\n*Type*: [DocumentClassifierInputDataConfig](./aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-inputdataconfig", "UpdateType": "Immutable", "Required": true, "Type": "DocumentClassifierInputDataConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to associate with the document classifier. A tag is a key-value\npair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n\"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-comprehend-documentclassifier-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the document classifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#Arn-fn::getatt" } } }, "AWS::Comprehend::Flywheel": { "MarkdownDocumentation": "`AWS::Comprehend::Flywheel`\n\nA flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification\nor custom entity recognition. You can create a flywheel to start with an existing trained model, or\nComprehend can create and train a new model.\nWhen you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training\ndata and test data for all versions of the model.\nTo use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's\ntraining data and test data into the flywheel's data lake.\nTo use the flywheel with a new model, you need to provide a dataset for training data (and optional test data)\nwhen you create the flywheel.\nFor more information about flywheels, see [Flywheel overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the flywheel.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html", "Properties": { "DataLakeS3Uri": { "MarkdownDocumentation": "`DataLakeS3Uri`\n\nAmazon S3 URI of the data lake location.\n*Required*: Yes\n*Type*: String\n*Pattern*: `s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-datalakes3uri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DataAccessRoleArn": { "MarkdownDocumentation": "`DataAccessRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that\ngrants Amazon Comprehend permission to access the flywheel data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-dataaccessrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FlywheelName": { "MarkdownDocumentation": "`FlywheelName`\n\nName for the flywheel.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-flywheelname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ModelType": { "MarkdownDocumentation": "`ModelType`\n\nModel type of the flywheel's model.\n*Required*: No\n*Type*: String\n*Allowed values*: `DOCUMENT_CLASSIFIER | ENTIT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-modeltype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TaskConfig": { "MarkdownDocumentation": "`TaskConfig`\n\nConfiguration about the model associated with a flywheel.\n*Required*: No\n*Type*: [TaskConfig](./aws-properties-comprehend-flywheel-taskconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-taskconfig", "UpdateType": "Immutable", "Required": false, "Type": "TaskConfig" }, "ActiveModelArn": { "MarkdownDocumentation": "`ActiveModelArn`\n\nThe Amazon Resource Number (ARN) of the active model version.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-activemodelarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSecurityConfig": { "MarkdownDocumentation": "`DataSecurityConfig`\n\nData security configuration.\n*Required*: No\n*Type*: [DataSecurityConfig](./aws-properties-comprehend-flywheel-datasecurityconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-datasecurityconfig", "UpdateType": "Mutable", "Required": false, "Type": "DataSecurityConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags associated with the endpoint being created. A tag is a key-value pair that adds\nmetadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an\nendpoint to indicate its use by the sales department.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-comprehend-flywheel-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the flywheel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#Arn-fn::getatt" } } }, "AWS::Config::AggregationAuthorization": { "MarkdownDocumentation": "`AWS::Config::AggregationAuthorization`\n\nAn object that represents the authorizations granted to\naggregator accounts and regions.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the AggregationAuthorization, such as `arn:aws:config:us-east-1:123456789012:aggregation-authorization/987654321012/us-west-2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html", "Properties": { "AuthorizedAccountId": { "MarkdownDocumentation": "`AuthorizedAccountId`\n\nThe 12-digit account ID of the account authorized to aggregate\ndata.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html#cfn-config-aggregationauthorization-authorizedaccountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AuthorizedAwsRegion": { "MarkdownDocumentation": "`AuthorizedAwsRegion`\n\nThe region authorized to collect aggregated data.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html#cfn-config-aggregationauthorization-authorizedawsregion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tag object.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-config-aggregationauthorization-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html#cfn-config-aggregationauthorization-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "AggregationAuthorizationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AggregationAuthorizationArn`\n\nThe Amazon Resource Name (ARN) of the aggregation object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-aggregationauthorization.html#AggregationAuthorizationArn-fn::getatt" } } }, "AWS::Config::ConfigRule": { "MarkdownDocumentation": "`AWS::Config::ConfigRule`\n\n###### Note\nYou must first create and start the AWS Config configuration recorder in order to create AWS Config managed\nrules with AWS CloudFormation. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).\nAdds or updates an AWS Config rule to evaluate if your\nAWS resources comply with your desired configurations. For information on how many AWS Config rules you can have per account,\nsee [**Service Limits**](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *AWS Config Developer Guide*.\nThere are two types of rules: *AWS Config Managed Rules* and *AWS Config Custom Rules*.\nYou can use the `ConfigRule` resource to create both AWS Config Managed Rules and AWS Config Custom Rules.\nAWS Config Managed Rules are predefined,\ncustomizable rules created by AWS Config. For a list of managed rules, see\n[List of AWS Config\nManaged Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an AWS Config managed rule, you must specify the\nrule's identifier for the `SourceIdentifier` key.\nAWS Config Custom Rules are rules that you create from scratch. There are two ways to create AWS Config custom rules: with Lambda functions\n([AWS Lambda Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with Guard ([Guard GitHub\nRepository](https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language.\nAWS Config custom rules created with AWS Lambda\nare called *AWS Config Custom Lambda Rules* and AWS Config custom rules created with\nGuard are called *AWS Config Custom Policy Rules*.\nIf you are adding a new AWS Config Custom Lambda rule,\nyou first need to create an AWS Lambda function that the rule invokes to evaluate\nyour resources. When you use the `ConfigRule` resource to add a Custom Lambda rule to AWS Config, you must specify the Amazon Resource\nName (ARN) that AWS Lambda assigns to the function. You specify the ARN\nin the `SourceIdentifier` key. This key is part of the\n`Source` object, which is part of the\n`ConfigRule` object.\nFor any new AWS Config rule that you add, specify the\n`ConfigRuleName` in the `ConfigRule`\nobject. Do not specify the `ConfigRuleArn` or the\n`ConfigRuleId`. These values are generated by AWS Config for new rules.\nIf you are updating a rule that you added previously, you can\nspecify the rule by `ConfigRuleName`,\n`ConfigRuleId`, or `ConfigRuleArn` in the\n`ConfigRule` data type that you use in this\nrequest.\nFor more information about developing and using AWS Config\nrules, see [Evaluating Resources with AWS Config Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html)\nin the *AWS Config Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the rule name, such as `mystack-MyConfigRule-12ABCFPXHV4OV`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html", "Properties": { "EvaluationModes": { "MarkdownDocumentation": "`EvaluationModes`\n\nThe modes the AWS Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.\n*Required*: No\n*Type*: Array of [EvaluationModeConfiguration](./aws-properties-config-configrule-evaluationmodeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-evaluationmodes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EvaluationModeConfiguration", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description that you provide for the AWS Config\nrule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nDefines which resources can trigger an evaluation for the rule.\nThe scope can include one or more resource types, a combination of\none resource type and one resource ID, or a combination of a tag key\nand value. Specify a scope to constrain the resources that can\ntrigger an evaluation for the rule. If you do not specify a scope,\nevaluations are triggered when any resource in the recording group\nchanges.\n*Required*: No\n*Type*: [Scope](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-scope", "UpdateType": "Mutable", "Required": false, "Type": "Scope" }, "Compliance": { "MarkdownDocumentation": "`Compliance`\n\nIndicates whether an AWS resource or AWS Config rule is\ncompliant and provides the number of contributors that affect the\ncompliance.\n*Required*: No\n*Type*: [Compliance](./aws-properties-config-configrule-compliance.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-compliance", "UpdateType": "Mutable", "Required": false, "Type": "Compliance" }, "ConfigRuleName": { "MarkdownDocumentation": "`ConfigRuleName`\n\nA name for the AWS Config rule. If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the rule name.\nFor more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n*Required*: No\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-configrulename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaximumExecutionFrequency": { "MarkdownDocumentation": "`MaximumExecutionFrequency`\n\nThe maximum frequency with which AWS Config runs evaluations\nfor a rule. You can specify a value for\n`MaximumExecutionFrequency` when:\n* You are using an AWS managed rule that is triggered at\n a periodic frequency.\n* Your custom rule is triggered when AWS Config delivers\n the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).\n###### Note\nBy default, rules with a periodic trigger are evaluated\nevery 24 hours. To change the frequency, specify a valid value\nfor the `MaximumExecutionFrequency`\nparameter.\n*Required*: No\n*Type*: String\n*Allowed values*: `One_Hour | Three_Hours | Si...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-maximumexecutionfrequency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nProvides the rule owner (`AWS` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules), the rule identifier,\nand the notifications that cause the function to evaluate your AWS\nresources.\n*Required*: Yes\n*Type*: [Source](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-source", "UpdateType": "Mutable", "Required": true, "Type": "Source" }, "InputParameters": { "MarkdownDocumentation": "`InputParameters`\n\nA string, in JSON format, that is passed to the AWS Config rule\nLambda 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-inputparameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } }, "Attributes": { "ConfigRuleId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigRuleId`\n\nThe ID of the AWS Config rule, such as `config-rule-a1bzhi`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#ConfigRuleId-fn::getatt" }, "Compliance.Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Compliance.Type`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#Compliance.Type-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the AWS Config rule, such as `arn:aws:config:us-east-1:123456789012:config-rule/config-rule-a1bzhi`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#Arn-fn::getatt" } } }, "AWS::Config::ConfigurationAggregator": { "MarkdownDocumentation": "`AWS::Config::ConfigurationAggregator`\n\nThe details about the configuration aggregator, including\ninformation about source accounts, regions, and metadata of the\naggregator.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ConfigurationAggregatorName, such as `myConfigurationAggregator`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html", "Properties": { "AccountAggregationSources": { "MarkdownDocumentation": "`AccountAggregationSources`\n\nProvides a list of source accounts and regions to be\naggregated.\n*Required*: No\n*Type*: Array of [AccountAggregationSource](./aws-properties-config-configurationaggregator-accountaggregationsource.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#cfn-config-configurationaggregator-accountaggregationsources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AccountAggregationSource", "DuplicatesAllowed": true }, "ConfigurationAggregatorName": { "MarkdownDocumentation": "`ConfigurationAggregatorName`\n\nThe name of the aggregator.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#cfn-config-configurationaggregator-configurationaggregatorname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OrganizationAggregationSource": { "MarkdownDocumentation": "`OrganizationAggregationSource`\n\nProvides an organization and list of regions to be\naggregated.\n*Required*: No\n*Type*: [OrganizationAggregationSource](./aws-properties-config-configurationaggregator-organizationaggregationsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#cfn-config-configurationaggregator-organizationaggregationsource", "UpdateType": "Mutable", "Required": false, "Type": "OrganizationAggregationSource" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tag object.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-config-configurationaggregator-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#cfn-config-configurationaggregator-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ConfigurationAggregatorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationAggregatorArn`\n\nThe Amazon Resource Name (ARN) of the aggregator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html#ConfigurationAggregatorArn-fn::getatt" } } }, "AWS::Config::ConfigurationRecorder": { "MarkdownDocumentation": "`AWS::Config::ConfigurationRecorder`\n\nThe `AWS::Config::ConfigurationRecorder` resource type describes the AWS resource types that AWS Config records for configuration changes.\nThe configuration recorder stores the configuration changes of the specified resources in your account as configuration items.\n###### Note\nTo enable AWS Config, you must create a configuration recorder and a delivery channel.\nAWS Config uses the delivery channel to deliver the configuration changes to your Amazon S3 bucket or Amazon SNS topic.\nFor more information, see [AWS::Config::DeliveryChannel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html).\nAWS CloudFormation starts the recorder as soon as the delivery channel is available.\nTo stop the recorder and delete it, delete the configuration recorder from your stack. To stop the recorder without deleting it,\ncall the [StopConfigurationRecorder](https://docs.aws.amazon.com/config/latest/APIReference/API_StopConfigurationRecorder.html) action of the AWS Config API directly.\nFor more information, see [Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#config-recorder) in the AWS Config Developer Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the configuration recorder name, such as default.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the configuration recorder. AWS Config automatically assigns the name of \"default\" when creating the configuration recorder.\nYou cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "RecordingGroup": { "MarkdownDocumentation": "`RecordingGroup`\n\nSpecifies which resource types AWS Config\nrecords for configuration changes.\n###### Note\n **High Number of AWS Config Evaluations**\nYou may notice increased activity in your account during your initial month recording with AWS Config when compared to subsequent months. During the\ninitial bootstrapping process, AWS Config runs evaluations on all the resources in your account that you have selected\nfor AWS Config to record.\nIf you are running ephemeral workloads, you may see increased activity from AWS Config as it records configuration changes associated with creating and deleting these\ntemporary resources. An *ephemeral workload* is a temporary use of computing resources that are loaded\nand run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2)\nSpot Instances, Amazon EMR jobs, and AWS Auto Scaling. If you want\nto avoid the increased activity from running ephemeral workloads, you can run these\ntypes of workloads in a separate account with AWS Config turned off to avoid\nincreased configuration recording and rule evaluations.\n*Required*: No\n*Type*: [RecordingGroup](./aws-properties-config-configurationrecorder-recordinggroup.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-recordinggroup", "Required": false, "Type": "RecordingGroup", "UpdateType": "Mutable" }, "RecordingMode": { "MarkdownDocumentation": "`RecordingMode`\n\nSpecifies the default recording frequency for the configuration recorder.\nAWS Config supports *Continuous recording* and *Daily recording*.\n* Continuous recording allows you to record configuration changes continuously whenever a change occurs.\n* Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it\u2019s different from the previous CI recorded.\n###### Note\n**Some resource types require continuous recording**\nAWS Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager,\nit is recommended that you set the recording frequency to Continuous.\nYou can also override the recording frequency for specific resource types.\n*Required*: No\n*Type*: [RecordingMode](./aws-properties-config-configurationrecorder-recordingmode.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-recordingmode", "Required": false, "Type": "RecordingMode", "UpdateType": "Mutable" }, "RoleARN": { "MarkdownDocumentation": "`RoleARN`\n\nAmazon Resource Name (ARN) of the IAM role assumed by AWS Config and used by the configuration recorder.\nFor more information, see [Permissions for the IAM Role Assigned](https://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.html) to AWS Config in the AWS Config Developer Guide.\n###### Note\n**Pre-existing AWS Config role**\nIf you have used an AWS service that uses AWS Config, such as AWS Security Hub CSPM or\nAWS Control Tower, and an AWS Config role has already been created, make sure that the\nIAM role that you use when setting up AWS Config keeps the same minimum\npermissions as the already created AWS Config role. You must do this so that the\nother AWS service continues to run as expected.\nFor example, if AWS Control Tower has an IAM role that allows AWS Config to read\nAmazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted\nwithin the IAM role you use when setting up AWS Config. Otherwise, it may\ninterfere with how AWS Control Tower operates. For more information about IAM\nroles for AWS Config,\nsee [**Identity and Access Management for AWS Config**](https://docs.aws.amazon.com/config/latest/developerguide/security-iam.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-rolearn", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::Config::ConformancePack": { "MarkdownDocumentation": "`AWS::Config::ConformancePack`\n\nA conformance pack is a collection of AWS Config rules and remediation actions\nthat can be easily deployed in an account and a region.\nConformancePack creates a service linked role in your account.\nThe service linked role is created only when the role does not exist in your account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the conformance pack.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html", "Properties": { "ConformancePackInputParameters": { "MarkdownDocumentation": "`ConformancePackInputParameters`\n\nA list of ConformancePackInputParameter objects.\n*Required*: No\n*Type*: Array of [ConformancePackInputParameter](./aws-properties-config-conformancepack-conformancepackinputparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-conformancepackinputparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConformancePackInputParameter", "DuplicatesAllowed": true }, "TemplateSSMDocumentDetails": { "MarkdownDocumentation": "`TemplateSSMDocumentDetails`\n\nAn object that contains the name or Amazon Resource Name (ARN) of the AWS Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.\n*Required*: No\n*Type*: [TemplateSSMDocumentDetails](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-templatessmdocumentdetails", "UpdateType": "Mutable", "Required": false, "Type": "TemplateSSMDocumentDetails" }, "DeliveryS3Bucket": { "MarkdownDocumentation": "`DeliveryS3Bucket`\n\nThe name of the Amazon S3 bucket where AWS Config stores conformance pack templates.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-deliverys3bucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConformancePackName": { "MarkdownDocumentation": "`ConformancePackName`\n\nName of the conformance pack you want to create.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z][-a-zA-Z0-9]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-conformancepackname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeliveryS3KeyPrefix": { "MarkdownDocumentation": "`DeliveryS3KeyPrefix`\n\nThe prefix for the Amazon S3 bucket.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-deliverys3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TemplateBody": { "MarkdownDocumentation": "`TemplateBody`\n\nA string containing full conformance pack template body. Structure containing the template body with a\nminimum length of 1 byte and a maximum length of 51,200 bytes.\n###### Note\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*Minimum*: `1`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-templatebody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TemplateS3Uri": { "MarkdownDocumentation": "`TemplateS3Uri`\n\nLocation of file containing the template body (s3://bucketname/prefix). The uri must point to the conformance pack template (max size: 300 KB)\nthat is located in an Amazon S3 bucket.\n###### Note\nYou must have access to read Amazon S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `s3://.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html#cfn-config-conformancepack-templates3uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Config::DeliveryChannel": { "MarkdownDocumentation": "`AWS::Config::DeliveryChannel`\n\nSpecifies a delivery channel object to deliver configuration\ninformation to an Amazon S3 bucket and Amazon SNS topic.\nBefore you can create a delivery channel, you must create a\nconfiguration recorder. You can use this action to change the Amazon S3 bucket or an\nAmazon SNS topic of the existing delivery channel. To change the\nAmazon S3 bucket or an Amazon SNS topic, call this action and\nspecify the changed values for the S3 bucket and the SNS topic. If\nyou specify a different value for either the S3 bucket or the SNS\ntopic, this action will keep the existing value for the parameter\nthat is not changed.\nYou can have only one delivery channel per region per AWS account, and the delivery channel is required to use AWS Config.\n###### Note\nAWS Config does not support the delivery channel to an Amazon S3 bucket bucket where object lock is enabled.\nFor more information, see [How S3 Object Lock works](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html).\nWhen you create the delivery channel, you can specify; how often AWS Config delivers configuration snapshots to your Amazon S3 bucket (for example, 24 hours),\nthe S3 bucket to which AWS Config sends configuration snapshots and configuration history files, and the\nAmazon SNS topic to which AWS Config sends notifications about configuration changes, such as updated resources, AWS Config rule evaluations, and when AWS Config delivers the configuration snapshot to your S3 bucket.\nFor more information, see [Deliver Configuration Items](https://docs.aws.amazon.com/config/latest/developerguide/how-does-config-work.html#delivery-channel) in the AWS Config Developer Guide.\n###### Note\nTo enable AWS Config, you must create a configuration recorder and a delivery channel.\nIf you want to create the resources separately, you must create a configuration recorder before you can create a delivery channel.\nAWS Config uses the configuration recorder to capture configuration changes to your resources.\nFor more information, see [AWS::Config::ConfigurationRecorder](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html).\nFor more information, see [Managing the Delivery Channel](https://docs.aws.amazon.com/config/latest/developerguide/manage-delivery-channel.html) in the AWS Config Developer Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the delivery channel name, such as default.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html", "Properties": { "ConfigSnapshotDeliveryProperties": { "MarkdownDocumentation": "`ConfigSnapshotDeliveryProperties`\n\nThe options for how often AWS Config delivers configuration\nsnapshots to the Amazon S3 bucket.\n*Required*: No\n*Type*: [ConfigSnapshotDeliveryProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties", "Required": false, "Type": "ConfigSnapshotDeliveryProperties", "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the delivery channel. If you don't specify a name, CloudFormation generates a\nunique physical ID and uses that ID for the delivery channel name. For more information,\nsee [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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nThe name of the Amazon S3 bucket to which AWS Config delivers\nconfiguration snapshots and configuration history files.\nIf you specify a bucket that belongs to another AWS account,\nthat 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\nDeveloper 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3bucketname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "S3KeyPrefix": { "MarkdownDocumentation": "`S3KeyPrefix`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3keyprefix", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "S3KmsKeyArn": { "MarkdownDocumentation": "`S3KmsKeyArn`\n\nThe 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.\nMust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3kmskeyarn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SnsTopicARN": { "MarkdownDocumentation": "`SnsTopicARN`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which\nAWS Config sends notifications about configuration\nchanges.\nIf you choose a topic from another account, the topic must have\npolicies that grant access permissions to AWS Config. For more\ninformation, see [Permissions for the Amazon SNS Topic](https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) in the *AWS Config\nDeveloper 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-snstopicarn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Config::OrganizationConfigRule": { "MarkdownDocumentation": "`AWS::Config::OrganizationConfigRule`\n\nAdds or updates an AWS Config rule for your entire organization to evaluate if your AWS resources comply with your\ndesired configurations. For information on how many organization AWS Config rules you can have per account,\nsee [**Service Limits**](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *AWS Config Developer Guide*.\nOnly a management account and a delegated administrator can create or update an organization AWS Config rule.\nWhen calling the `OrganizationConfigRule` resource with a delegated administrator, you must ensure AWS Organizations`ListDelegatedAdministrator` permissions are added. An organization can have up to 3 delegated administrators.\nThe `OrganizationConfigRule` resource enables organization service access through the `EnableAWSServiceAccess` action and creates a service-linked\nrole `AWSServiceRoleForConfigMultiAccountSetup` in the management or delegated administrator account of your organization.\nThe service-linked role is created only when the role does not exist in the caller account.\nAWS Config verifies the existence of role with `GetRole` action.\nTo use the `OrganizationConfigRule` resource with delegated administrator, register a delegated administrator by calling AWS Organization\n`register-delegated-administrator` for `config-multiaccountsetup.amazonaws.com`.\nThere are two types of rules: *AWS Config Managed Rules* and *AWS Config Custom Rules*.\nYou can use `PutOrganizationConfigRule` to create both AWS Config Managed Rules and AWS Config Custom Rules.\nAWS Config Managed Rules are predefined,\ncustomizable rules created by AWS Config. For a list of managed rules, see\n[List of AWS Config\nManaged Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an AWS Config managed rule, you must specify the rule's identifier for the `RuleIdentifier` key.\nAWS Config Custom Rules are rules that you create from scratch. There are two ways to create AWS Config custom rules: with Lambda functions\n([AWS Lambda Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with Guard ([Guard GitHub\nRepository](https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language.\nAWS Config custom rules created with AWS Lambda\nare called *AWS Config Custom Lambda Rules* and AWS Config custom rules created with\nGuard are called *AWS Config Custom Policy Rules*.\nIf you are adding a new AWS Config Custom Lambda rule, you first need to create an AWS Lambda function in the management account or a delegated\nadministrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function.\nWhen you use `PutOrganizationConfigRule` to add a Custom Lambda rule to AWS Config, you must\nspecify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the OrganizationConfigRuleName.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html", "Properties": { "OrganizationManagedRuleMetadata": { "Type": "OrganizationManagedRuleMetadata", "Required": false, "MarkdownDocumentation": "`OrganizationManagedRuleMetadata`\n\nAn `OrganizationManagedRuleMetadata` object.\n*Required*: No\n*Type*: [OrganizationManagedRuleMetadata](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata", "UpdateType": "Mutable" }, "OrganizationConfigRuleName": { "Required": true, "MarkdownDocumentation": "`OrganizationConfigRuleName`\n\nThe name that you assign to organization AWS Config rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-Za-z0-9-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationconfigrulename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "OrganizationCustomRuleMetadata": { "Type": "OrganizationCustomRuleMetadata", "Required": false, "MarkdownDocumentation": "`OrganizationCustomRuleMetadata`\n\nAn `OrganizationCustomRuleMetadata` object.\n*Required*: No\n*Type*: [OrganizationCustomRuleMetadata](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata", "UpdateType": "Mutable" }, "ExcludedAccounts": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ExcludedAccounts`\n\nA comma-separated list of accounts excluded from organization AWS Config rule.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-excludedaccounts", "UpdateType": "Mutable" }, "OrganizationCustomPolicyRuleMetadata": { "Type": "OrganizationCustomPolicyRuleMetadata", "Required": false, "MarkdownDocumentation": "`OrganizationCustomPolicyRuleMetadata`\n\nAn\nobject that specifies metadata for your organization's AWS Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have\ndebug logging enabled, and other custom rule metadata, such as resource type, resource\nID of AWS resource, and organization trigger types that initiate AWS Config to evaluate AWS resources against a rule.\n*Required*: No\n*Type*: [OrganizationCustomPolicyRuleMetadata](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata", "UpdateType": "Mutable" } } }, "AWS::Config::OrganizationConformancePack": { "MarkdownDocumentation": "`AWS::Config::OrganizationConformancePack`\n\nOrganizationConformancePack deploys conformance packs across member accounts in an AWS Organizations.\nOrganizationConformancePack enables organization service access for `config-multiaccountsetup.amazonaws.com` through the `EnableAWSServiceAccess` action and\ncreates a service linked role in the master account of your organization.\nThe service linked role is created only when the role does not exist in the master account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of organization conformance pack.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html", "Properties": { "ConformancePackInputParameters": { "MarkdownDocumentation": "`ConformancePackInputParameters`\n\nA list of `ConformancePackInputParameter` objects.\n*Required*: No\n*Type*: Array of [ConformancePackInputParameter](./aws-properties-config-organizationconformancepack-conformancepackinputparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-conformancepackinputparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConformancePackInputParameter", "DuplicatesAllowed": true }, "DeliveryS3Bucket": { "MarkdownDocumentation": "`DeliveryS3Bucket`\n\nThe name of the Amazon S3 bucket where AWS Config stores conformance pack templates.\n###### Note\nThis field is optional.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-deliverys3bucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExcludedAccounts": { "MarkdownDocumentation": "`ExcludedAccounts`\n\nA comma-separated list of accounts excluded from organization conformance pack.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-excludedaccounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DeliveryS3KeyPrefix": { "MarkdownDocumentation": "`DeliveryS3KeyPrefix`\n\nAny folder structure you want to add to an Amazon S3 bucket.\n###### Note\nThis field is optional.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-deliverys3keyprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TemplateBody": { "MarkdownDocumentation": "`TemplateBody`\n\nA 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.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `51200`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-templatebody", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OrganizationConformancePackName": { "MarkdownDocumentation": "`OrganizationConformancePackName`\n\nThe name you assign to an organization conformance pack.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z][-a-zA-Z0-9]*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-organizationconformancepackname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TemplateS3Uri": { "MarkdownDocumentation": "`TemplateS3Uri`\n\nLocation of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).\n*Required*: No\n*Type*: String\n*Pattern*: `s3://.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-templates3uri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Config::RemediationConfiguration": { "MarkdownDocumentation": "`AWS::Config::RemediationConfiguration`\n\nAn object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the remediation action with the associated SSM document.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html", "Properties": { "TargetVersion": { "Required": false, "MarkdownDocumentation": "`TargetVersion`\n\nVersion of the target. For example, version of the SSM document.\n###### Note\nIf you make backward incompatible changes to the SSM document,\nyou must call PutRemediationConfiguration API again to ensure the remediations can run.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targetversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExecutionControls": { "Type": "ExecutionControls", "Required": false, "MarkdownDocumentation": "`ExecutionControls`\n\nAn ExecutionControls object.\n*Required*: No\n*Type*: [ExecutionControls](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-executioncontrols", "UpdateType": "Mutable" }, "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nAn object of the RemediationParameterValue. For more information, see [RemediationParameterValue](https://docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html).\n###### Note\nThe type is a map of strings to RemediationParameterValue.\n*Required*: No\n*Type*: Object of [RemediationParameterValue](./aws-properties-config-remediationconfiguration-remediationparametervalue.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "TargetType": { "Required": true, "MarkdownDocumentation": "`TargetType`\n\nThe type of the target. Target executes remediation. For example, SSM document.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SSM_DOCUMENT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SSM_DOCUMENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targettype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ConfigRuleName": { "Required": true, "MarkdownDocumentation": "`ConfigRuleName`\n\nThe name of the AWS Config rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-configrulename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ResourceType": { "Required": false, "MarkdownDocumentation": "`ResourceType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-resourcetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RetryAttemptSeconds": { "Required": false, "MarkdownDocumentation": "`RetryAttemptSeconds`\n\nTime window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.\nIf `MaximumAutomaticAttempts` remediation attempts have been made under `RetryAttemptSeconds`, a remediation exception will be added to the resource.\nIf you do not select a number, the default is 60 seconds.\nFor example, if you specify `RetryAttemptSeconds` as 50 seconds and `MaximumAutomaticAttempts` as 5,\nAWS Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-retryattemptseconds", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MaximumAutomaticAttempts": { "Required": false, "MarkdownDocumentation": "`MaximumAutomaticAttempts`\n\nThe 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,\nAWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-maximumautomaticattempts", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "TargetId": { "Required": true, "MarkdownDocumentation": "`TargetId`\n\nTarget ID is the name of the SSM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targetid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Automatic": { "Required": false, "MarkdownDocumentation": "`Automatic`\n\nThe remediation is triggered 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-automatic", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::Config::StoredQuery": { "MarkdownDocumentation": "`AWS::Config::StoredQuery`\n\nProvides the details of a stored query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-storedquery.html", "Properties": { "QueryDescription": { "MarkdownDocumentation": "`QueryDescription`\n\nA unique description for the query.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-storedquery.html#cfn-config-storedquery-querydescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "QueryExpression": { "MarkdownDocumentation": "`QueryExpression`\n\nThe expression of the query.\nFor example, `SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.`\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-storedquery.html#cfn-config-storedquery-queryexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-config-storedquery-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-storedquery.html#cfn-config-storedquery-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "QueryName": { "MarkdownDocumentation": "`QueryName`\n\nThe name of the query.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-storedquery.html#cfn-config-storedquery-queryname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "QueryArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`QueryArn`\n\nAmazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-storedquery.html#QueryArn-fn::getatt" }, "QueryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`QueryId`\n\nThe ID of the query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-storedquery.html#QueryId-fn::getatt" } } }, "AWS::ControlTower::EnabledBaseline": { "MarkdownDocumentation": "`AWS::ControlTower::EnabledBaseline`\n\nThe `AWS::ControlTower::EnabledBaseline` resource Property description not available. for ControlTower.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledbaseline.html", "Properties": { "BaselineVersion": { "MarkdownDocumentation": "`BaselineVersion`\n\nThe enabled version of the `Baseline`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\d+(?:\\.\\d+){0,2}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledbaseline.html#cfn-controltower-enabledbaseline-baselineversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nShows the parameters that are applied when enabling this `Baseline`.\n*Required*: No\n*Type*: Array of [Parameter](./aws-properties-controltower-enabledbaseline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledbaseline.html#cfn-controltower-enabledbaseline-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Parameter", "DuplicatesAllowed": true }, "BaselineIdentifier": { "MarkdownDocumentation": "`BaselineIdentifier`\n\nThe specific `Baseline` enabled as part of the `EnabledBaseline` resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[0-9a-zA-Z_\\-:\\/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledbaseline.html#cfn-controltower-enabledbaseline-baselineidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetIdentifier": { "MarkdownDocumentation": "`TargetIdentifier`\n\nThe target on which to enable the `Baseline`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[0-9a-zA-Z_\\-:\\/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledbaseline.html#cfn-controltower-enabledbaseline-targetidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-controltower-enabledbaseline-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledbaseline.html#cfn-controltower-enabledbaseline-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "EnabledBaselineIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnabledBaselineIdentifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledbaseline.html#EnabledBaselineIdentifier-fn::getatt" } } }, "AWS::ControlTower::EnabledControl": { "MarkdownDocumentation": "`AWS::ControlTower::EnabledControl`\n\nThe resource represents an enabled control. It specifies an asynchronous operation\nthat creates AWS resources on the specified organizational unit and the\naccounts it contains. The resources created will vary according to the control that you\nspecify.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the physical ID of the resource. The format is of the\nform `target | control`. For example:\n`arn:aws:organizations::123456789012:ou/o-myorg/ou-my-ouid |\narn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledcontrol.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nArray of `EnabledControlParameter` objects.\n*Required*: No\n*Type*: Array of [EnabledControlParameter](./aws-properties-controltower-enabledcontrol-enabledcontrolparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledcontrol.html#cfn-controltower-enabledcontrol-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnabledControlParameter", "DuplicatesAllowed": true }, "ControlIdentifier": { "MarkdownDocumentation": "`ControlIdentifier`\n\nThe ARN of the control. Only **Strongly recommended** and\n**Elective** controls are permitted, with the exception of the\n**Region deny** control. For information on how to find the `controlIdentifier`, see [the overview page](https://docs.aws.amazon.com//controltower/latest/APIReference/Welcome.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[0-9a-zA-Z_\\-:\\/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledcontrol.html#cfn-controltower-enabledcontrol-controlidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetIdentifier": { "MarkdownDocumentation": "`TargetIdentifier`\n\nThe ARN of the organizational unit. For information on how to find the `targetIdentifier`, see [the overview page](https://docs.aws.amazon.com//controltower/latest/APIReference/Welcome.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[0-9a-zA-Z_\\-:\\/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledcontrol.html#cfn-controltower-enabledcontrol-targetidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-controltower-enabledcontrol-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-enabledcontrol.html#cfn-controltower-enabledcontrol-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::ControlTower::LandingZone": { "MarkdownDocumentation": "`AWS::ControlTower::LandingZone`\n\nCreates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone,\nbased on the parameters specified in the manifest JSON file.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the **LandingZoneIdentifier**. For example:\n`\"LandingZoneIdentifier\": \"arn:aws:controltower:us-west-2:123456789012:landingzone/1A2B3C4D5E6F7G8H`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nThe landing zone's current deployed version.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\d+.\\d+`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#cfn-controltower-landingzone-version", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RemediationTypes": { "MarkdownDocumentation": "`RemediationTypes`\n\nThe types of remediation actions configured for the landing zone, such as automatic drift correction or compliance enforcement.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `INHERITANCE_DRIFT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INHERITANCE_DRIFT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#cfn-controltower-landingzone-remediationtypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Manifest": { "MarkdownDocumentation": "`Manifest`\n\nThe landing zone manifest JSON text file that specifies the landing zone configurations.\n*Required*: Yes\n*Type*:\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#cfn-controltower-landingzone-manifest", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to be applied to the landing zone.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-controltower-landingzone-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#cfn-controltower-landingzone-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe landing zone deployment status. One of `ACTIVE`, `PROCESSING`, `FAILED`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#Status-fn::getatt" }, "LatestAvailableVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestAvailableVersion`\n\nThe latest available version of the landing zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#LatestAvailableVersion-fn::getatt" }, "DriftStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`DriftStatus`\n\nThe drift status of the landing zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#DriftStatus-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the landing zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#Arn-fn::getatt" }, "LandingZoneIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`LandingZoneIdentifier`\n\nThe unique identifier of the landing zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-controltower-landingzone.html#LandingZoneIdentifier-fn::getatt" } } }, "AWS::DAX::Cluster": { "MarkdownDocumentation": "`AWS::DAX::Cluster`\n\nCreates a DAX cluster. All nodes in the cluster run the same DAX caching software.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the created DAX cluster. For example:\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html", "Attributes": { "ClusterDiscoveryEndpointURL": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterDiscoveryEndpointURL`\n\nReturns the endpoint URL of the DAX cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#ClusterDiscoveryEndpointURL-fn::getatt" }, "ClusterDiscoveryEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterDiscoveryEndpoint`\n\nReturns the endpoint of the DAX cluster. For example:\n```\n{ \"Fn::GetAtt\": [\"MyDAXCluster\", \"ClusterDiscoveryEndpoint\"] }\n```\nReturns a value similar to the following:\n```\nmydaxcluster.0h3d6x.clustercfg.dax.use1.cache.amazonaws.com:8111\n```\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#ClusterDiscoveryEndpoint-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the DAX cluster. For example:\n```\n{ \"Fn::GetAtt\": [\"MyDAXCluster\", \"Arn\"] }\n```\nReturns a value similar to the following:\n```\narn:aws:dax:us-east-1:111122223333:cache/MyDAXCluster\n```\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#Arn-fn::getatt" } }, "Properties": { "SSESpecification": { "Type": "SSESpecification", "Required": false, "MarkdownDocumentation": "`SSESpecification`\n\nRepresents the settings used to enable server-side encryption on the\ncluster.\n*Required*: No\n*Type*: [SSESpecification](./aws-properties-dax-cluster-ssespecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-ssespecification", "UpdateType": "Immutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReplicationFactor": { "Required": true, "MarkdownDocumentation": "`ReplicationFactor`\n\nThe number of nodes in the DAX cluster. A replication factor of 1\nwill create a single-node cluster, without any read replicas. For additional fault\ntolerance, you can create a multiple node cluster with one or more read replicas. To do\nthis, set `ReplicationFactor` to a number between 3 (one primary and two read\nreplicas) and 10 (one primary and nine read replicas). `If the\nAvailabilityZones` parameter is provided, its length must equal the\n`ReplicationFactor`.\n###### Note\nAWS recommends that you have at least two read replicas per\ncluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-replicationfactor", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ParameterGroupName": { "Required": false, "MarkdownDocumentation": "`ParameterGroupName`\n\nThe parameter group to be associated with the DAX 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-parametergroupname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AvailabilityZones": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AvailabilityZones`\n\nThe Availability Zones (AZs) in which the cluster nodes will reside after the\ncluster has been created or updated. If provided, the length of this list must equal the\n`ReplicationFactor` parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest\navailability.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-availabilityzones", "UpdateType": "Mutable" }, "IAMRoleARN": { "Required": true, "MarkdownDocumentation": "`IAMRoleARN`\n\nA valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX\nwill assume this role and use the role's permissions to access DynamoDB on your\nbehalf.\n*Required*: Yes\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-iamrolearn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SubnetGroupName": { "Required": false, "MarkdownDocumentation": "`SubnetGroupName`\n\nThe name of the subnet group to be used for the replication group.\n###### Important\nDAX clusters can only run in an Amazon VPC environment. All of the subnets\nthat you specify in a subnet group must exist in the same VPC.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-subnetgroupname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "PreferredMaintenanceWindow": { "Required": false, "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nA range of time when maintenance of DAX cluster software will be performed. For\nexample: `sun:01:00-sun:09:00`. Cluster maintenance normally takes less than\n30 minutes, and is performed automatically within the maintenance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-preferredmaintenancewindow", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ClusterEndpointEncryptionType": { "Required": false, "MarkdownDocumentation": "`ClusterEndpointEncryptionType`\n\nThe encryption type of the cluster's endpoint. Available values are:\n* `NONE` - The cluster's endpoint will be unencrypted.\n* `TLS` - The cluster's endpoint will be encrypted with Transport\n Layer Security, and will provide an x509 certificate for\n authentication.\nThe default value is `NONE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | TLS`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "NONE", "TLS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clusterendpointencryptiontype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "NotificationTopicARN": { "Required": false, "MarkdownDocumentation": "`NotificationTopicARN`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which\nnotifications will be sent.\n###### Note\nThe Amazon SNS topic owner must be same as the DAX\ncluster 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-notificationtopicarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of security group IDs to be assigned to each node in the DAX\ncluster. (Each of the security group ID is system-generated.)\nIf this parameter is not specified, DAX assigns the default VPC\nsecurity group to each node.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-securitygroupids", "UpdateType": "Mutable" }, "NetworkType": { "Required": false, "MarkdownDocumentation": "`NetworkType`\n\nThe IP address type of the cluster. Values are:\n* `ipv4` - IPv4 addresses only\n* `ipv6` - IPv6 addresses only\n* `dual_stack` - Both IPv4 and IPv6 addresses\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dual_stack...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dual_stack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-networktype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "NodeType": { "Required": true, "MarkdownDocumentation": "`NodeType`\n\nThe node type for the nodes in the cluster. (All nodes in a DAX cluster are of\nthe same 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-nodetype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ClusterName": { "Required": false, "MarkdownDocumentation": "`ClusterName`\n\nThe name of the DAX cluster.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clustername", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nA set of tags to associate with the DAX cluster.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" } } }, "AWS::DAX::ParameterGroup": { "MarkdownDocumentation": "`AWS::DAX::ParameterGroup`\n\nA named set of parameters that are applied to all of the nodes in a DAX cluster.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the created parameter group. For example:\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html", "Properties": { "ParameterNameValues": { "Required": false, "MarkdownDocumentation": "`ParameterNameValues`\n\nAn array of name-value pairs for the parameters in the group. Each element in the\narray represents a single parameter.\n###### Note\n`record-ttl-millis` and `query-ttl-millis` are the only\nsupported parameter names. For more details, see [Configuring TTL Settings](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl).\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-parameternamevalues", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA description of the parameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ParameterGroupName": { "Required": false, "MarkdownDocumentation": "`ParameterGroupName`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-parametergroupname", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::DAX::SubnetGroup": { "MarkdownDocumentation": "`AWS::DAX::SubnetGroup`\n\nCreates a new subnet group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the created subnet group. For example\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html", "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe description of the subnet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SubnetGroupName": { "Required": false, "MarkdownDocumentation": "`SubnetGroupName`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-subnetgroupname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SubnetIds": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`SubnetIds`\n\nA list of VPC subnet IDs for the subnet group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-subnetids", "UpdateType": "Mutable" } } }, "AWS::DLM::LifecyclePolicy": { "MarkdownDocumentation": "`AWS::DLM::LifecyclePolicy`\n\nSpecifies a lifecycle policy, which is used to automate operations on Amazon EBS resources.\nThe properties are required when you add a lifecycle policy and optional when you update a lifecycle policy.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the lifecycle policy.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the lifecycle policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#Arn-fn::getatt" } }, "Properties": { "ExecutionRoleArn": { "Required": false, "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role used to run the operations specified by\nthe lifecycle policy.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `arn:aws(-[a-z]{1,3}){0,2}:iam::\\d+:role/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-executionrolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DefaultPolicy": { "Required": false, "MarkdownDocumentation": "`DefaultPolicy`\n\n**[Default policies only]** Specify the type of default policy to create.\n* To create a default policy for EBS snapshots, that creates snapshots of all volumes in the\n Region that do not have recent backups, specify `VOLUME`.\n* To create a default policy for EBS-backed AMIs, that creates EBS-backed\n AMIs from all instances in the Region that do not have recent backups, specify\n `INSTANCE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `VOLUME | INSTANCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "VOLUME", "INSTANCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-defaultpolicy", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CreateInterval": { "Required": false, "MarkdownDocumentation": "`CreateInterval`\n\n**[Default policies only]** Specifies how often the policy should run and create snapshots or AMIs.\nThe creation frequency can range from 1 to 7 days. If you do not specify a value, the\ndefault is 1.\nDefault: 1\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-createinterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA description of the lifecycle policy. The characters ^[0-9A-Za-z \\_-]+$ are\nsupported.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `[0-9A-Za-z _-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExtendDeletion": { "Required": false, "MarkdownDocumentation": "`ExtendDeletion`\n\n**[Default policies only]** Defines the snapshot or AMI retention behavior for the policy if the\nsource volume or instance is deleted, or if the policy enters the error, disabled, or\ndeleted state.\nBy default (**ExtendDeletion=false**):\n* If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously\n created snapshots or AMIs, up to but not including the last one, based on the\n specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs,\n including the last one, specify `true`.\n* If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting\n snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs,\n including the last one, if the policy enters one of these states, specify\n `true`.\nIf you enable extended deletion (**ExtendDeletion=true**),\nyou override both default behaviors simultaneously.\nIf you do not specify a value, the default is `false`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-extenddeletion", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Exclusions": { "Type": "Exclusions", "Required": false, "MarkdownDocumentation": "`Exclusions`\n\n**[Default policies only]** Specifies exclusion parameters for volumes or instances for which you\ndo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs\nfor target resources that match any of the specified exclusion parameters.\n*Required*: No\n*Type*: [Exclusions](./aws-properties-dlm-lifecyclepolicy-exclusions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-exclusions", "UpdateType": "Mutable" }, "State": { "Required": false, "MarkdownDocumentation": "`State`\n\nThe activation state of the lifecycle policy.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED | ERROR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED", "ERROR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-state", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CrossRegionCopyTargets": { "Type": "CrossRegionCopyTargets", "Required": false, "MarkdownDocumentation": "`CrossRegionCopyTargets`\n\n**[Default policies only]** Specifies destination Regions for snapshot or AMI copies. You can specify\nup to 3 destination Regions. If you do not want to create cross-Region copies, omit this\nparameter.\n*Required*: No\n*Type*: Json\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-crossregioncopytargets", "UpdateType": "Mutable" }, "PolicyDetails": { "Type": "PolicyDetails", "Required": false, "MarkdownDocumentation": "`PolicyDetails`\n\nThe configuration details of the lifecycle policy.\n###### Important\nIf you create a default policy, you can specify the request parameters either in\nthe request body, or in the PolicyDetails request structure, but not both.\n*Required*: Conditional\n*Type*: [PolicyDetails](./aws-properties-dlm-lifecyclepolicy-policydetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-policydetails", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the lifecycle policy during creation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dlm-lifecyclepolicy-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "RetainInterval": { "Required": false, "MarkdownDocumentation": "`RetainInterval`\n\n**[Default policies only]** Specifies how long the policy should retain snapshots or AMIs before\ndeleting them. The retention period can range from 2 to 14 days, but it must be greater\nthan the creation frequency to ensure that the policy retains at least 1 snapshot or\nAMI at any given time. If you do not specify a value, the default is 7.\nDefault: 7\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-retaininterval", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "CopyTags": { "Required": false, "MarkdownDocumentation": "`CopyTags`\n\n**[Default policies only]** Indicates whether the policy should copy tags from the source resource\nto the snapshot or AMI. If you do not specify a value, the default is `false`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-copytags", "PrimitiveType": "Boolean", "UpdateType": "Mutable" } } }, "AWS::DMS::Certificate": { "MarkdownDocumentation": "`AWS::DMS::Certificate`\n\nThe `AWS::DMS::Certificate` resource creates an Secure Sockets Layer (SSL) certificate that\nencrypts connections between AWS DMS endpoints and the replication instance.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the certificate.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html", "Properties": { "CertificateIdentifier": { "Required": false, "MarkdownDocumentation": "`CertificateIdentifier`\n\nA customer-assigned name for the certificate. Identifiers must begin with a letter and\nmust contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or\ncontain 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificateidentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CertificatePem": { "Required": false, "MarkdownDocumentation": "`CertificatePem`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatepem", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CertificateWallet": { "Required": false, "MarkdownDocumentation": "`CertificateWallet`\n\nThe location of an imported Oracle Wallet certificate for use with SSL. An example\nis: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatewallet", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::DMS::DataMigration": { "MarkdownDocumentation": "`AWS::DMS::DataMigration`\n\nThis object provides information about a AWS DMS data migration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html", "Properties": { "DataMigrationType": { "MarkdownDocumentation": "`DataMigrationType`\n\nSpecifies whether the data migration is full-load only, change data capture (CDC) only,\nor full-load and CDC.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `full-load | cdc | full-load...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "full-load", "cdc", "full-load-and-cdc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-datamigrationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataMigrationSettings": { "MarkdownDocumentation": "`DataMigrationSettings`\n\nSpecifies CloudWatch settings and selection rules for the data migration.\n*Required*: No\n*Type*: [DataMigrationSettings](./aws-properties-dms-datamigration-datamigrationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-datamigrationsettings", "UpdateType": "Mutable", "Required": false, "Type": "DataMigrationSettings" }, "DataMigrationName": { "MarkdownDocumentation": "`DataMigrationName`\n\nThe user-friendly name for the data migration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-datamigrationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MigrationProjectIdentifier": { "MarkdownDocumentation": "`MigrationProjectIdentifier`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-migrationprojectidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceDataSettings": { "MarkdownDocumentation": "`SourceDataSettings`\n\nSpecifies information about the data migration's source data provider.\n*Required*: No\n*Type*: [Array](./aws-properties-dms-datamigration-sourcedatasettings.html) of [SourceDataSettings](./aws-properties-dms-datamigration-sourcedatasettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-sourcedatasettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SourceDataSettings", "DuplicatesAllowed": false }, "ServiceAccessRoleArn": { "MarkdownDocumentation": "`ServiceAccessRoleArn`\n\nThe IAM role that the data migration uses to access AWS resources.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-serviceaccessrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-datamigration-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "DataMigrationIdentifier": { "MarkdownDocumentation": "`DataMigrationIdentifier`\n\nProperty description not available.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#cfn-dms-datamigration-datamigrationidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "DataMigrationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataMigrationArn`\n\nThe Amazon Resource Name (ARN) that identifies this replication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#DataMigrationArn-fn::getatt" }, "DataMigrationCreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataMigrationCreateTime`\n\nThe UTC time when DMS created the data migration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-datamigration.html#DataMigrationCreateTime-fn::getatt" } } }, "AWS::DMS::DataProvider": { "MarkdownDocumentation": "`AWS::DMS::DataProvider`\n\nProvides information that defines a data provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html", "Properties": { "DataProviderName": { "MarkdownDocumentation": "`DataProviderName`\n\nThe name of the data provider.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-dataprovidername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the data provider. Descriptions can have up to 31 characters.\nA description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't\nend with a hyphen or contain two consecutive hyphens, and can only begin with a letter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExactSettings": { "MarkdownDocumentation": "`ExactSettings`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-exactsettings", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe type of database engine for the data provider. Valid values include `\"aurora\"`,\n`\"aurora-postgresql\"`, `\"mysql\"`, `\"oracle\"`, `\"postgres\"`,\n`\"sqlserver\"`, `redshift`, `mariadb`, `mongodb`, `db2`, `db2-zos`, `docdb`, and `sybase`. A value of `\"aurora\"` represents Amazon Aurora MySQL-Compatible Edition.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `aurora | aurora_postgresql ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "aurora", "aurora_postgresql", "mysql", "oracle", "postgres", "sqlserver", "redshift", "mariadb", "mongodb", "docdb", "db2", "db2_zos", "sybase" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-engine", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nThe settings in JSON format for a data provider.\n*Required*: No\n*Type*: [Settings](./aws-properties-dms-dataprovider-settings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-settings", "UpdateType": "Mutable", "Required": false, "Type": "Settings" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-dataprovider-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "DataProviderIdentifier": { "MarkdownDocumentation": "`DataProviderIdentifier`\n\nThe identifier of the data provider. Identifiers must begin with a letter\nand must contain only ASCII letters, digits, and hyphens. They can't end with\na hyphen, or contain two consecutive hyphens.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-dataprovideridentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "DataProviderArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataProviderArn`\n\nThe Amazon Resource Name (ARN) string that uniquely identifies the data provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#DataProviderArn-fn::getatt" }, "DataProviderCreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`DataProviderCreationTime`\n\nThe time the data provider was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#DataProviderCreationTime-fn::getatt" } } }, "AWS::DMS::Endpoint": { "MarkdownDocumentation": "`AWS::DMS::Endpoint`\n\nThe `AWS::DMS::Endpoint` resource specifies an AWS DMS endpoint.\nCurrently, AWS CloudFormation supports all AWS DMS endpoint types.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the endpoint.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html", "Attributes": { "ExternalId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ExternalId`\n\nA value that can be used for cross-account validation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#ExternalId-fn::getatt" } }, "Properties": { "SybaseSettings": { "Type": "SybaseSettings", "Required": false, "MarkdownDocumentation": "`SybaseSettings`\n\nSettings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [SybaseSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings", "UpdateType": "Mutable" }, "RedisSettings": { "Type": "RedisSettings", "Required": false, "MarkdownDocumentation": "`RedisSettings`\n\nSettings in JSON format for the target Redis endpoint.\nFor information about other available settings, see\n[Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [RedisSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redissettings", "UpdateType": "Mutable" }, "OracleSettings": { "Type": "OracleSettings", "Required": false, "MarkdownDocumentation": "`OracleSettings`\n\nSettings in JSON format for the source and target Oracle endpoint. For information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [OracleSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings", "UpdateType": "Mutable" }, "KafkaSettings": { "Type": "KafkaSettings", "Required": false, "MarkdownDocumentation": "`KafkaSettings`\n\nSettings in JSON format for the target Apache Kafka endpoint.\nFor more information about other available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [KafkaSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kafkasettings", "UpdateType": "Mutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MySqlSettings": { "Type": "MySqlSettings", "Required": false, "MarkdownDocumentation": "`MySqlSettings`\n\nSettings in JSON format for the source and target MySQL endpoint. For information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [MySqlSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings", "UpdateType": "Mutable" }, "S3Settings": { "Type": "S3Settings", "Required": false, "MarkdownDocumentation": "`S3Settings`\n\nSettings in JSON format for the source and target Amazon S3 endpoint. For more information about other available settings, see\n[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\n[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)\nin the*AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [S3Settings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings", "UpdateType": "Mutable" }, "ResourceIdentifier": { "Required": false, "MarkdownDocumentation": "`ResourceIdentifier`\n\nA display name for the resource identifier at the end of the `EndpointArn`\nresponse parameter that is returned in the created `Endpoint` object. The\nvalue for this parameter can have up to 31 characters. It can contain only ASCII\nletters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two\nconsecutive hyphens, and can only begin with a letter, such as\n`Example-App-ARN1`.\nFor example, this value might result in the `EndpointArn` value\n`arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you don't\nspecify a `ResourceIdentifier` value, AWS DMS generates a default\nidentifier 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-resourceidentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "KinesisSettings": { "Type": "KinesisSettings", "Required": false, "MarkdownDocumentation": "`KinesisSettings`\n\nSettings in JSON format for the target endpoint for Amazon Kinesis Data Streams.\nFor more information about other available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [KinesisSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings", "UpdateType": "Mutable" }, "SslMode": { "Required": false, "MarkdownDocumentation": "`SslMode`\n\nThe Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is `none`.\n###### Note\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 ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "require", "verify-ca", "verify-full" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sslmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RedshiftSettings": { "Type": "RedshiftSettings", "Required": false, "MarkdownDocumentation": "`RedshiftSettings`\n\nSettings in JSON format for the Amazon Redshift endpoint.\nFor more information about other available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [RedshiftSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings", "UpdateType": "Mutable" }, "EndpointType": { "Required": true, "MarkdownDocumentation": "`EndpointType`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "source", "target" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOne or more tags to be assigned to the endpoint.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-endpoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Password": { "Required": false, "MarkdownDocumentation": "`Password`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-password", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MongoDbSettings": { "Type": "MongoDbSettings", "Required": false, "MarkdownDocumentation": "`MongoDbSettings`\n\nSettings in JSON format for the source MongoDB endpoint.\nFor more information about the available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [MongoDbSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings", "UpdateType": "Mutable" }, "IbmDb2Settings": { "Type": "IbmDb2Settings", "Required": false, "MarkdownDocumentation": "`IbmDb2Settings`\n\nSettings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [IbmDb2Settings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings", "UpdateType": "Mutable" }, "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nAn 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.\nYour 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kmskeyid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DatabaseName": { "Required": false, "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the endpoint database. For a MySQL source or target endpoint, don't specify `DatabaseName`.\nTo 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-databasename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NeptuneSettings": { "Type": "NeptuneSettings", "Required": false, "MarkdownDocumentation": "`NeptuneSettings`\n\nSettings in JSON format for the target Amazon Neptune endpoint.\nFor more information about the available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [NeptuneSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings", "UpdateType": "Mutable" }, "ElasticsearchSettings": { "Type": "ElasticsearchSettings", "Required": false, "MarkdownDocumentation": "`ElasticsearchSettings`\n\nSettings in JSON format for the target OpenSearch endpoint. For more information\nabout the available settings, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [ElasticsearchSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings", "UpdateType": "Mutable" }, "EngineName": { "Required": true, "MarkdownDocumentation": "`EngineName`\n\nThe type of engine for the endpoint, depending on the `EndpointType` value.\n*Valid values*: `mysql` | `oracle` |\n`postgres` | `mariadb` | `aurora` |\n`aurora-postgresql` | `opensearch` | `redshift` | `redshift-serverless` |`s3` |\n`db2` | `azuredb` | `sybase` | `dynamodb` | `mongodb` |\n`kinesis` | `kafka` | `elasticsearch` | `docdb` |\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-enginename", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DocDbSettings": { "Type": "DocDbSettings", "Required": false, "MarkdownDocumentation": "`DocDbSettings`\n\nSettings in JSON format for the source and target DocumentDB endpoint.\nFor more information about other available settings, see\n[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\n[Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [DocDbSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings", "UpdateType": "Mutable" }, "DynamoDbSettings": { "Type": "DynamoDbSettings", "Required": false, "MarkdownDocumentation": "`DynamoDbSettings`\n\nSettings in JSON format for the target Amazon DynamoDB endpoint.\nFor information about other available settings, see\n[Using object mapping to migrate data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [DynamoDbSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings", "UpdateType": "Mutable" }, "Username": { "Required": false, "MarkdownDocumentation": "`Username`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-username", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MicrosoftSqlServerSettings": { "Type": "MicrosoftSqlServerSettings", "Required": false, "MarkdownDocumentation": "`MicrosoftSqlServerSettings`\n\nSettings in JSON format for the source and target Microsoft SQL Server endpoint.\nFor information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [MicrosoftSqlServerSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings", "UpdateType": "Mutable" }, "GcpMySQLSettings": { "Type": "GcpMySQLSettings", "Required": false, "MarkdownDocumentation": "`GcpMySQLSettings`\n\nSettings in JSON format for the source GCP MySQL endpoint. These settings are much the same as\nthe settings for any MySQL-compatible endpoint. For more information, see\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [GcpMySQLSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-gcpmysqlsettings", "UpdateType": "Mutable" }, "ServerName": { "Required": false, "MarkdownDocumentation": "`ServerName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-servername", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExtraConnectionAttributes": { "Required": false, "MarkdownDocumentation": "`ExtraConnectionAttributes`\n\nAdditional attributes associated with the connection. Each attribute is specified as a\nname-value pair associated by an equal sign (=). Multiple attributes are separated by a\nsemicolon (;) with no additional white space. For information on the attributes available\nfor connecting your source or target endpoint, see\n[Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-extraconnectionattributes", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EndpointIdentifier": { "Required": false, "MarkdownDocumentation": "`EndpointIdentifier`\n\nThe database endpoint identifier. Identifiers must begin with a letter and must contain\nonly ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two\nconsecutive 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CertificateArn": { "Required": false, "MarkdownDocumentation": "`CertificateArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-certificatearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PostgreSqlSettings": { "Type": "PostgreSqlSettings", "Required": false, "MarkdownDocumentation": "`PostgreSqlSettings`\n\nSettings in JSON format for the source and target PostgreSQL endpoint.\nFor information about other available settings, see\n[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\n[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)\nin the *AWS Database Migration Service User Guide*.\n*Required*: No\n*Type*: [PostgreSqlSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings", "UpdateType": "Mutable" } } }, "AWS::DMS::EventSubscription": { "MarkdownDocumentation": "`AWS::DMS::EventSubscription`\n\nUse the `AWS::DMS::EventSubscription` resource to get notifications for AWS Database Migration Service\nevents through the Amazon Simple Notification Service. For more information, see\n[Working with events and notifications in\nAWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name, for example:\n`{ \"Ref\": \"myEventSubscription\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html", "Properties": { "SourceType": { "Required": false, "MarkdownDocumentation": "`SourceType`\n\nThe type of AWS DMS resource that generates the events. For example, if you want to be\nnotified of events generated by a replication instance, you set this parameter to\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourcetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EventCategories": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`EventCategories`\n\nA list of event categories for a source type that you want to subscribe to. If you\ndon't specify this property, you are notified about all event categories. For more information, see\n[Working with Events and Notifications](https://docs.aws.amazon.com//dms/latest/userguide/CHAP_Events.html)\nin the *AWS DMS User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-eventcategories", "UpdateType": "Mutable" }, "Enabled": { "Required": false, "MarkdownDocumentation": "`Enabled`\n\nIndicates whether to activate the subscription. If you don't specify this property,\nCloudFormation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "SubscriptionName": { "Required": false, "MarkdownDocumentation": "`SubscriptionName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-subscriptionname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SnsTopicArn": { "Required": true, "MarkdownDocumentation": "`SnsTopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-snstopicarn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SourceIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SourceIds`\n\nA 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\nspecify a database instance ID, then all of the other values must be database instance\nIDs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourceids", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOne or more tags to be assigned to the event subscription.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-eventsubscription-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::DMS::InstanceProfile": { "MarkdownDocumentation": "`AWS::DMS::InstanceProfile`\n\nProvides information that defines an instance profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html", "Properties": { "SubnetGroupIdentifier": { "MarkdownDocumentation": "`SubnetGroupIdentifier`\n\nThe identifier of the subnet group that is associated with the instance profile.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-subnetgroupidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the instance profile. Descriptions can have up to 31 characters.\nA description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't\nend with a hyphen or contain two consecutive hyphens, and can only begin with a letter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceProfileName": { "MarkdownDocumentation": "`InstanceProfileName`\n\nThe user-friendly name for the instance profile.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-instanceprofilename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt\nthe connection parameters for the instance profile.\nIf you don't specify a value for the `KmsKeyArn` parameter, then\nAWS DMS uses an AWS owned encryption key to encrypt your resources.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nSpecifies the network type for the instance profile. A value of `IPV4`\nrepresents an instance profile with IPv4 network type and only supports IPv4 addressing.\nA value of `IPV6` represents an instance profile with IPv6 network type\nand only supports IPv6 addressing. A value of `DUAL` represents an instance\nprofile with dual network type that supports IPv4 and IPv6 addressing.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | DUAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "DUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-networktype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone where the instance profile runs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nSpecifies the accessibility options for the instance profile. A value of\n`true` represents an instance profile with a public IP address. A value of\n`false` represents an instance profile with a private IP address. The default value\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-publiclyaccessible", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VpcSecurityGroups": { "MarkdownDocumentation": "`VpcSecurityGroups`\n\nThe VPC security groups that are used with the instance profile.\nThe VPC security group must work with the VPC containing the instance profile.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-vpcsecuritygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-instanceprofile-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "InstanceProfileIdentifier": { "MarkdownDocumentation": "`InstanceProfileIdentifier`\n\nThe identifier of the instance profile. Identifiers must begin with a letter\nand must contain only ASCII letters, digits, and hyphens. They can't end with\na hyphen, or contain two consecutive hyphens.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-instanceprofileidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "InstanceProfileCreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`InstanceProfileCreationTime`\n\nThe time the instance profile was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#InstanceProfileCreationTime-fn::getatt" }, "InstanceProfileArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`InstanceProfileArn`\n\nThe Amazon Resource Name (ARN) string that uniquely identifies the instance profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#InstanceProfileArn-fn::getatt" } } }, "AWS::DMS::MigrationProject": { "MarkdownDocumentation": "`AWS::DMS::MigrationProject`\n\nProvides information that defines a migration project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html", "Properties": { "TargetDataProviderDescriptors": { "MarkdownDocumentation": "`TargetDataProviderDescriptors`\n\nInformation about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.\n*Required*: No\n*Type*: Array of [DataProviderDescriptor](./aws-properties-dms-migrationproject-dataproviderdescriptor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-targetdataproviderdescriptors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataProviderDescriptor", "DuplicatesAllowed": false }, "MigrationProjectName": { "MarkdownDocumentation": "`MigrationProjectName`\n\nThe name of the migration project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-migrationprojectname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceProfileName": { "MarkdownDocumentation": "`InstanceProfileName`\n\nThe name of the associated instance profile.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofilename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA user-friendly description of the migration project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MigrationProjectIdentifier": { "MarkdownDocumentation": "`MigrationProjectIdentifier`\n\nThe identifier of the migration project. Identifiers must begin with a letter\nand must contain only ASCII letters, digits, and hyphens. They can't end with\na hyphen, or contain two consecutive hyphens.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-migrationprojectidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceDataProviderDescriptors": { "MarkdownDocumentation": "`SourceDataProviderDescriptors`\n\nInformation about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.\n*Required*: No\n*Type*: Array of [DataProviderDescriptor](./aws-properties-dms-migrationproject-dataproviderdescriptor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-sourcedataproviderdescriptors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataProviderDescriptor", "DuplicatesAllowed": false }, "TransformationRules": { "MarkdownDocumentation": "`TransformationRules`\n\nThe settings in JSON format for migration rules. Migration rules make it possible for you to change\nthe object names according to the rules that you specify. For example, you can change an object name\nto lowercase or uppercase, add or remove a prefix or suffix, or rename objects.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-transformationrules", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SchemaConversionApplicationAttributes": { "MarkdownDocumentation": "`SchemaConversionApplicationAttributes`\n\nThe schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.\n*Required*: No\n*Type*: [SchemaConversionApplicationAttributes](./aws-properties-dms-migrationproject-schemaconversionapplicationattributes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-schemaconversionapplicationattributes", "UpdateType": "Mutable", "Required": false, "Type": "SchemaConversionApplicationAttributes" }, "InstanceProfileArn": { "MarkdownDocumentation": "`InstanceProfileArn`\n\nThe Amazon Resource Name (ARN) of the instance profile for your migration project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofilearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-migrationproject-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "InstanceProfileIdentifier": { "MarkdownDocumentation": "`InstanceProfileIdentifier`\n\nThe identifier of the instance profile for your migration project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofileidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "MigrationProjectArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MigrationProjectArn`\n\nThe ARN string that uniquely identifies the migration project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#MigrationProjectArn-fn::getatt" } } }, "AWS::DMS::ReplicationConfig": { "MarkdownDocumentation": "`AWS::DMS::ReplicationConfig`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html", "Properties": { "ReplicationSettings": { "MarkdownDocumentation": "`ReplicationSettings`\n\nOptional JSON settings for AWS DMS Serverless replications that are provisioned using this\nreplication configuration. For example, see [Change processing tuning settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.ChangeProcessingTuning.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationsettings", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "ResourceIdentifier": { "MarkdownDocumentation": "`ResourceIdentifier`\n\nOptional unique value or name that you set for a given resource that can be used to\nconstruct an Amazon Resource Name (ARN) for that resource. For more information, see [Fine-grained access control using resource names and\ntags](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.FineGrainedAccess).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-resourceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ReplicationConfigIdentifier": { "MarkdownDocumentation": "`ReplicationConfigIdentifier`\n\nA unique identifier that you want to use to create a `ReplicationConfigArn`\nthat is returned as part of the output from this action. You can then pass this output\n`ReplicationConfigArn` as the value of the `ReplicationConfigArn`\noption for other actions to identify both AWS DMS Serverless replications and replication\nconfigurations that you want those actions to operate on. For some actions, you can also\nuse either this unique identifier or a corresponding ARN in action filters to identify the\nspecific replication and replication configuration to operate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationconfigidentifier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ComputeConfig": { "MarkdownDocumentation": "`ComputeConfig`\n\nConfiguration parameters for provisioning an AWS DMS Serverless replication.\n*Required*: Yes\n*Type*: [ComputeConfig](./aws-properties-dms-replicationconfig-computeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-computeconfig", "UpdateType": "Mutable", "Required": true, "Type": "ComputeConfig" }, "ReplicationType": { "MarkdownDocumentation": "`ReplicationType`\n\nThe type of AWS DMS Serverless replication to provision using this replication\nconfiguration.\nPossible values:\n* `\"full-load\"`\n* `\"cdc\"`\n* `\"full-load-and-cdc\"`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `full-load | full-load-and-c...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "full-load", "full-load-and-cdc", "cdc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableMappings": { "MarkdownDocumentation": "`TableMappings`\n\nJSON table mappings for AWS DMS Serverless replications that are provisioned using this\nreplication configuration. For more information, see [Specifying table selection and transformations rules using\nJSON](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.SelectionTransformation.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-tablemappings", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "SourceEndpointArn": { "MarkdownDocumentation": "`SourceEndpointArn`\n\nThe Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless\nreplication 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-sourceendpointarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SupplementalSettings": { "MarkdownDocumentation": "`SupplementalSettings`\n\nOptional JSON settings for specifying supplemental data. For more information, see\n[Specifying supplemental data for task settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-supplementalsettings", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TargetEndpointArn": { "MarkdownDocumentation": "`TargetEndpointArn`\n\nThe Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless\nreplication 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-targetendpointarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOne or more optional tags associated with resources used by the AWS DMS Serverless\nreplication. For more information, see [Tagging resources in AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-replicationconfig-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ReplicationConfigArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReplicationConfigArn`\n\nThe Amazon Resource Name (ARN) of this AWS DMS Serverless replication\nconfiguration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#ReplicationConfigArn-fn::getatt" } } }, "AWS::DMS::ReplicationInstance": { "MarkdownDocumentation": "`AWS::DMS::ReplicationInstance`\n\nThe `AWS::DMS::ReplicationInstance` resource creates an AWS DMS replication instance.\nTo create a ReplicationInstance, you need permissions to create instances. You'll need similar permissions to terminate\ninstances when you delete stacks with instances.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the replication instance ARN.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html", "Attributes": { "ReplicationInstancePublicIpAddresses": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReplicationInstancePublicIpAddresses`\n\nOne or more public IP addresses for the replication instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#ReplicationInstancePublicIpAddresses-fn::getatt" }, "ReplicationInstancePrivateIpAddresses": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReplicationInstancePrivateIpAddresses`\n\nOne or more private IP addresses for the replication instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#ReplicationInstancePrivateIpAddresses-fn::getatt" } }, "Properties": { "DnsNameServers": { "Required": false, "MarkdownDocumentation": "`DnsNameServers`\n\nA list of custom DNS name servers supported for the replication instance to access your\non-premise source or target database. This list overrides the default name servers\nsupported by the replication instance. You can specify a comma-separated list of internet\naddresses for up to four on-premise DNS name servers. For example:\n`\"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-dnsnameservers", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ReplicationInstanceIdentifier": { "Required": false, "MarkdownDocumentation": "`ReplicationInstanceIdentifier`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EngineVersion": { "Required": false, "MarkdownDocumentation": "`EngineVersion`\n\nThe engine version number of the replication instance.\nIf an engine version number is not specified when a replication\ninstance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-engineversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nAn 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\nhas 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-kmskeyid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AvailabilityZone": { "Required": false, "MarkdownDocumentation": "`AvailabilityZone`\n\nThe 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,\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-availabilityzone", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PreferredMaintenanceWindow": { "Required": false, "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe 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,\noccurring on a random day of the week.\n*Valid days* (`ddd`): `Mon` | `Tue` |\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-preferredmaintenancewindow", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AutoMinorVersionUpgrade": { "Required": false, "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nA value that indicates whether minor engine upgrades are applied automatically to the\nreplication 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-autominorversionupgrade", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ReplicationSubnetGroupIdentifier": { "Required": false, "MarkdownDocumentation": "`ReplicationSubnetGroupIdentifier`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationsubnetgroupidentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AllocatedStorage": { "Required": false, "MarkdownDocumentation": "`AllocatedStorage`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allocatedstorage", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ResourceIdentifier": { "Required": false, "MarkdownDocumentation": "`ResourceIdentifier`\n\nA display name for the resource identifier at the end of the `EndpointArn`\nresponse parameter that is returned in the created `Endpoint` object. The value\nfor this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\nand hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\nand can only begin with a letter, such as `Example-App-ARN1`. For example, this\nvalue might result in the `EndpointArn` value\n`arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you don't\nspecify a `ResourceIdentifier` value, AWS DMS generates a default identifier\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-resourceidentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "VpcSecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nSpecifies the virtual private cloud (VPC) security group to be used with the replication instance. The VPC\nsecurity group must work with the VPC containing the replication instance.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-vpcsecuritygroupids", "UpdateType": "Mutable" }, "NetworkType": { "Required": false, "MarkdownDocumentation": "`NetworkType`\n\nThe type of IP address protocol used by a replication instance, such as IPv4 only or\nDual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet\nsupported.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-networktype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AllowMajorVersionUpgrade": { "Required": false, "MarkdownDocumentation": "`AllowMajorVersionUpgrade`\n\nIndicates that major version upgrades are allowed. Changing this parameter does not\nresult 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\n`EngineVersion` parameter that is a different major version than the\nreplication 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allowmajorversionupgrade", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ReplicationInstanceClass": { "Required": true, "MarkdownDocumentation": "`ReplicationInstanceClass`\n\nThe compute and memory capacity of the replication instance as defined for the specified\nreplication 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\n[Selecting the right AWS DMS replication instance for your migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth)\nin the *AWS Database Migration Service User Guide*.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceclass", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PubliclyAccessible": { "Required": false, "MarkdownDocumentation": "`PubliclyAccessible`\n\nSpecifies the accessibility options for the replication instance. A value of\n`true` represents an instance with a public IP address. A value of\n`false` represents an instance with a private IP address.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-publiclyaccessible", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "MultiAZ": { "Required": false, "MarkdownDocumentation": "`MultiAZ`\n\nSpecifies whether the replication instance is a Multi-AZ deployment. You can't set the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-multiaz", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOne or more tags to be assigned to the replication instance.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-replicationinstance-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::DMS::ReplicationSubnetGroup": { "MarkdownDocumentation": "`AWS::DMS::ReplicationSubnetGroup`\n\nThe `AWS::DMS::ReplicationSubnetGroup` resource creates an AWS DMS\nreplication subnet group. Subnet groups must contain at least two subnets in two\ndifferent Availability Zones in the same AWS Region.\n###### Note\nResource creation fails if the `dms-vpc-role`AWS Identity and Access Management (IAM)\nrole doesn't already exist. For more information, see\n[Creating the IAM Roles to Use With the AWS CLI and AWS DMS API](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.APIRole.html)\nin the *AWS Database Migration Service User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the replication subnet group,\nsuch as `mystack-myrepsubnetgroup-0a12bc456789de0fg`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html", "Properties": { "ReplicationSubnetGroupDescription": { "Required": true, "MarkdownDocumentation": "`ReplicationSubnetGroupDescription`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-replicationsubnetgroupdescription", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReplicationSubnetGroupIdentifier": { "Required": false, "MarkdownDocumentation": "`ReplicationSubnetGroupIdentifier`\n\nThe identifier for the replication subnet group. If you don't specify a name, CloudFormation\ngenerates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-replicationsubnetgroupidentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SubnetIds": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`SubnetIds`\n\nOne or more subnet IDs to be assigned to the subnet group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-subnetids", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOne or more tags to be assigned to the subnet group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-replicationsubnetgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::DMS::ReplicationTask": { "MarkdownDocumentation": "`AWS::DMS::ReplicationTask`\n\nThe `AWS::DMS::ReplicationTask` resource creates an AWS DMS replication task.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the replication task ARN.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html", "Properties": { "ReplicationTaskSettings": { "Required": false, "MarkdownDocumentation": "`ReplicationTaskSettings`\n\nOverall settings for the task, in JSON format. For more information, see\n[Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CdcStartPosition": { "Required": false, "MarkdownDocumentation": "`CdcStartPosition`\n\nIndicates when you want a change data capture (CDC) operation to start. Use either\n`CdcStartPosition` or `CdcStartTime` to specify when you want a CDC operation to start.\nSpecifying both values results in an error.\nThe value can be in date, checkpoint, log sequence number (LSN), or system change\nnumber (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`\n###### Note\nWhen you use this task setting with a source PostgreSQL database, a logical\nreplication slot should already be created and associated with the source endpoint.\nYou can verify this by setting the `slotName` extra connection attribute to the\nname of this logical replication slot. For more information, see\n[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)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CdcStopPosition": { "Required": false, "MarkdownDocumentation": "`CdcStopPosition`\n\nIndicates when you want a change data capture (CDC) operation to stop. The value can be\neither server time or commit time.\nHere is a server time example: `--cdc-stop-position\n\"server_time:2018-02-09T12:12:12\"`\nHere is a commit time example: `--cdc-stop-position \"commit_time:\n2018-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MigrationType": { "Required": true, "MarkdownDocumentation": "`MigrationType`\n\nThe migration type. Valid values: `full-load` | `cdc` | `full-load-and-cdc`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `full-load | cdc | full-load...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "full-load", "cdc", "full-load-and-cdc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TargetEndpointArn": { "Required": true, "MarkdownDocumentation": "`TargetEndpointArn`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ReplicationInstanceArn": { "Required": true, "MarkdownDocumentation": "`ReplicationInstanceArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "TaskData": { "Required": false, "MarkdownDocumentation": "`TaskData`\n\nSupplemental information that the task requires to migrate the data for certain source and target endpoints.\nFor more information, see [Specifying Supplemental Data for Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CdcStartTime": { "Required": false, "MarkdownDocumentation": "`CdcStartTime`\n\nIndicates the start time for a change data capture (CDC) operation.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime", "PrimitiveType": "Double", "UpdateType": "Mutable" }, "ResourceIdentifier": { "Required": false, "MarkdownDocumentation": "`ResourceIdentifier`\n\nA display name for the resource identifier at the end of the `EndpointArn`\nresponse parameter that is returned in the created `Endpoint` object. The\nvalue for this parameter can have up to 31 characters. It can contain only ASCII\nletters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two\nconsecutive hyphens, and can only begin with a letter, such as\n`Example-App-ARN1`.\nFor example, this value might result in the `EndpointArn` value\n`arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you don't\nspecify a `ResourceIdentifier` value, AWS DMS generates a default\nidentifier 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-resourceidentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "TableMappings": { "Required": true, "MarkdownDocumentation": "`TableMappings`\n\nThe table mappings for the task, in JSON format. For more information, see\n[Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ReplicationTaskIdentifier": { "Required": false, "MarkdownDocumentation": "`ReplicationTaskIdentifier`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SourceEndpointArn": { "Required": true, "MarkdownDocumentation": "`SourceEndpointArn`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOne or more tags to be assigned to the replication task.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dms-replicationtask-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::DSQL::Cluster": { "MarkdownDocumentation": "`AWS::DSQL::Cluster`\n\nThe `AWS::DSQL::Cluster` resource specifies an cluster.\nYou can use this resource to create, modify, and manage clusters.\nThis resource supports both single-Region clusters and multi-Region clusters through\nthe `MultiRegionProperties` parameter.\n###### Note\nCreating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters.\n###### Important\n* The witness Region specified in `multiRegionProperties.witnessRegion` cannot be the same as the cluster's Region.\n**Required permissions**\ndsql:CreateCluster\nRequired to create a cluster.\nResources: `arn:aws:dsql:region:account-id:cluster/*`\n\ndsql:TagResource\nPermission to add tags to a resource.\nResources: `arn:aws:dsql:region:account-id:cluster/*`\n\ndsql:PutMultiRegionProperties\nPermission to configure multi-Region properties for a cluster.\nResources: `arn:aws:dsql:region:account-id:cluster/*`\n\ndsql:AddPeerCluster\nWhen specifying `multiRegionProperties.clusters`, permission to add peer clusters.\nResources:\n* Local cluster: `arn:aws:dsql:region:account-id:cluster/*`\n* Each peer cluster: exact ARN of each specified peer cluster\n\ndsql:PutWitnessRegion\nWhen specifying `multiRegionProperties.witnessRegion`, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.\nResources: `arn:aws:dsql:region:account-id:cluster/*`\nCondition Keys: `dsql:WitnessRegion` (matching the specified witness region)\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the cluster identifier.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html", "Properties": { "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA resource-based policy document in JSON format. Length constraints: Minimum length of 1. Maximum length of 20480 characters (approximately 20KB).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsEncryptionKey": { "MarkdownDocumentation": "`KmsEncryptionKey`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-kmsencryptionkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeletionProtectionEnabled": { "MarkdownDocumentation": "`DeletionProtectionEnabled`\n\nWhether deletion protection is enabled on this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-deletionprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA map of key and value pairs this cluster is tagged with.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-dsql-cluster-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "MultiRegionProperties": { "MarkdownDocumentation": "`MultiRegionProperties`\n\nDefines the structure for multi-Region cluster configurations, containing the witness\nRegion and peered cluster settings.\n*Required*: No\n*Type*: [MultiRegionProperties](./aws-properties-dsql-cluster-multiregionproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-multiregionproperties", "UpdateType": "Mutable", "Required": false, "Type": "MultiRegionProperties" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the cluster. Possible values include: CREATING, ACTIVE, DELETING, FAILED.\nThe cluster can have two additional status values when working with multi-Region\nclusters:\n`PENDING_SETUP`\u2014Indicates the cluster is being configured\n`PENDING_DELETE`\u2014Indicates the cluster is being deleted\n**Note:** These status values only appear for multi-Region cluster operations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#Status-fn::getatt" }, "PolicyVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyVersion`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#PolicyVersion-fn::getatt" }, "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the cluster. Used for IAM permissions and resource identification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#ResourceArn-fn::getatt" }, "EncryptionDetails.EncryptionType": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#EncryptionDetails.EncryptionType-fn::getatt" }, "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nThe unique identifier assigned to the cluster upon creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#Identifier-fn::getatt" }, "VpcEndpointServiceName": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEndpointServiceName`\n\nThe VPC Endpoint Service name for the cluster. This can be used to create a VPC endpoint to connect to the cluster from within a VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#VpcEndpointServiceName-fn::getatt" }, "VpcEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEndpoint`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#VpcEndpoint-fn::getatt" }, "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe connection endpoint for the created cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#Endpoint-fn::getatt" }, "EncryptionDetails": { "Type": "EncryptionDetails", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#EncryptionDetails-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe timestamp when the cluster was created, in ISO 8601 format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#CreationTime-fn::getatt" }, "EncryptionDetails.KmsKeyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#EncryptionDetails.KmsKeyArn-fn::getatt" }, "EncryptionDetails.EncryptionStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#EncryptionDetails.EncryptionStatus-fn::getatt" } } }, "AWS::DataBrew::Dataset": { "MarkdownDocumentation": "`AWS::DataBrew::Dataset`\n\nSpecifies a new DataBrew dataset.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myDataset\" }`\nFor an AWS Glue DataBrew dataset named `myDataset`,\n`Ref` returns the name of the dataset.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html", "Properties": { "Input": { "MarkdownDocumentation": "`Input`\n\nInformation on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3.\n*Required*: Yes\n*Type*: [Input](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-input", "UpdateType": "Mutable", "Required": true, "Type": "Input" }, "Format": { "MarkdownDocumentation": "`Format`\n\nThe 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 | JSON | PARQUET | EXCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CSV", "JSON", "PARQUET", "EXCEL", "ORC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-format", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FormatOptions": { "MarkdownDocumentation": "`FormatOptions`\n\nA set of options that define how DataBrew interprets the data in the\ndataset.\n*Required*: No\n*Type*: [FormatOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-formatoptions", "UpdateType": "Mutable", "Required": false, "Type": "FormatOptions" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog.\n*Required*: No\n*Type*: String\n*Allowed values*: `S3 | DATA-CATALOG | DATABAS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "S3", "DATA-CATALOG", "DATABASE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-source", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PathOptions": { "MarkdownDocumentation": "`PathOptions`\n\nA set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.\n*Required*: No\n*Type*: [PathOptions](./aws-properties-databrew-dataset-pathoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-pathoptions", "UpdateType": "Mutable", "Required": false, "Type": "PathOptions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata tags that have been applied to the dataset.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-databrew-dataset-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Job": { "MarkdownDocumentation": "`AWS::DataBrew::Job`\n\nSpecifies a new DataBrew job.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myJob\" }`\nFor an AWS Glue DataBrew job named `myJob`, `Ref`\nreturns the name of the job.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html", "Properties": { "MaxRetries": { "MarkdownDocumentation": "`MaxRetries`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxretries", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ProjectName": { "MarkdownDocumentation": "`ProjectName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-projectname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Recipe": { "MarkdownDocumentation": "`Recipe`\n\nA series of data transformation steps that the job runs.\n*Required*: No\n*Type*: [Recipe](./aws-properties-databrew-job-recipe.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-recipe", "UpdateType": "Mutable", "Required": false, "Type": "Recipe" }, "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nThe Amazon Resource Name (ARN) of an encryption key that is used to protect the job\noutput. For more information, see [Encrypting data\nwritten by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionkeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogSubscription": { "MarkdownDocumentation": "`LogSubscription`\n\nThe current status of Amazon CloudWatch logging for the job.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLE | DISABLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLE", "DISABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-logsubscription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nThe job's timeout in minutes. A job that attempts to run longer than this timeout\nperiod ends with a status of `TIMEOUT`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-timeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DatabaseOutputs": { "MarkdownDocumentation": "`DatabaseOutputs`\n\nRepresents a list of JDBC database output objects which defines the output\ndestination for a DataBrew recipe job to write into.\n*Required*: No\n*Type*: Array of [DatabaseOutput](./aws-properties-databrew-job-databaseoutput.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-databaseoutputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DatabaseOutput", "DuplicatesAllowed": true }, "OutputLocation": { "MarkdownDocumentation": "`OutputLocation`\n\nThe location in Amazon S3 where the job writes its output.\n*Required*: No\n*Type*: [OutputLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputlocation", "UpdateType": "Mutable", "Required": false, "Type": "OutputLocation" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the role to be assumed for this job.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe unique name of the job.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe job type of the job, which must be one of the following:\n* `PROFILE` - A job to analyze a dataset, to determine its size, data\n types, data distribution, and more.\n* `RECIPE` - A job to apply one or more transformations to a\n dataset.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PROFILE | RECIPE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PROFILE", "RECIPE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DatasetName": { "MarkdownDocumentation": "`DatasetName`\n\nA dataset that the job is to process.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datasetname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProfileConfiguration": { "MarkdownDocumentation": "`ProfileConfiguration`\n\nConfiguration for profile jobs. Configuration can be used to select columns, do evaluations, and override default\nparameters of evaluations. When configuration is undefined, the profile job will apply default settings to all\nsupported columns.\n*Required*: No\n*Type*: [ProfileConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-profileconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ProfileConfiguration" }, "Outputs": { "MarkdownDocumentation": "`Outputs`\n\nOne or more artifacts that represent output from running the job.\n*Required*: No\n*Type*: Array of [Output](./aws-properties-databrew-job-output.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Output", "DuplicatesAllowed": true }, "ValidationConfigurations": { "MarkdownDocumentation": "`ValidationConfigurations`\n\nList of validation configurations that are applied to the profile job.\n*Required*: No\n*Type*: Array of [ValidationConfiguration](./aws-properties-databrew-job-validationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-validationconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ValidationConfiguration", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata tags that have been applied to the job.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-databrew-job-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "JobSample": { "MarkdownDocumentation": "`JobSample`\n\nA sample configuration for profile jobs only, which determines the number of rows on which the\nprofile job is run. If a `JobSample` value isn't provided, the default value\nis used. The default value is CUSTOM\\_ROWS for the mode parameter and 20,000 for the\nsize parameter.\n*Required*: No\n*Type*: [JobSample](./aws-properties-databrew-job-jobsample.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-jobsample", "UpdateType": "Mutable", "Required": false, "Type": "JobSample" }, "EncryptionMode": { "MarkdownDocumentation": "`EncryptionMode`\n\nThe encryption mode for the job, which can be one of the following:\n* `SSE-KMS` - Server-side encryption with keys managed by AWS KMS.\n* `SSE-S3` - Server-side encryption with keys managed by Amazon S3.\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)", "RefReturnValue": "", "AllowedValues": [ "SSE-KMS", "SSE-S3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DataCatalogOutputs": { "MarkdownDocumentation": "`DataCatalogOutputs`\n\nOne or more artifacts that represent the AWS Glue Data Catalog output\nfrom running the job.\n*Required*: No\n*Type*: Array of [DataCatalogOutput](./aws-properties-databrew-job-datacatalogoutput.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datacatalogoutputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataCatalogOutput", "DuplicatesAllowed": true } } }, "AWS::DataBrew::Project": { "MarkdownDocumentation": "`AWS::DataBrew::Project`\n\nSpecifies a new AWS Glue DataBrew project.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myProject\" }`\nFor an AWS Glue DataBrew project named `myProject`,\n`Ref` returns the name of the project.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html", "Properties": { "RecipeName": { "MarkdownDocumentation": "`RecipeName`\n\nThe name of a recipe that will be developed during a project session.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-recipename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatasetName": { "MarkdownDocumentation": "`DatasetName`\n\nThe dataset that the project is to act upon.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-datasetname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Sample": { "MarkdownDocumentation": "`Sample`\n\nThe sample size and sampling type to apply to the data. If this parameter isn't\nspecified, then the sample consists of the first 500 rows from the dataset.\n*Required*: No\n*Type*: [Sample](./aws-properties-databrew-project-sample.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-sample", "UpdateType": "Mutable", "Required": false, "Type": "Sample" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the role that will be assumed for this\nproject.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata tags that have been applied to the project.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-databrew-project-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe unique name of a project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Recipe": { "MarkdownDocumentation": "`AWS::DataBrew::Recipe`\n\nSpecifies a new AWS Glue DataBrew transformation recipe.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myRecipe\" }`\nFor an AWS Glue DataBrew recipe named `myRecipe`, `Ref`\nreturns the name of the recipe.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-recipe.html", "Properties": { "Steps": { "MarkdownDocumentation": "`Steps`\n\nA list of steps that are defined by the recipe.\n*Required*: Yes\n*Type*: Array of [RecipeStep](./aws-properties-databrew-recipe-recipestep.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-recipe.html#cfn-databrew-recipe-steps", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RecipeStep", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the recipe.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-recipe.html#cfn-databrew-recipe-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata tags that have been applied to the recipe.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-databrew-recipe-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-recipe.html#cfn-databrew-recipe-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe unique name for the recipe.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-recipe.html#cfn-databrew-recipe-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Ruleset": { "MarkdownDocumentation": "`AWS::DataBrew::Ruleset`\n\nSpecifies a new ruleset that can be used in a profile job to validate the data quality\nof a dataset.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, Ref returns the resource name. For example, `{ \"Ref\": \"myRuleset\"\n}`.\nFor an AWS Glue DataBrew ruleset named `myRuleset`, `Ref`\nreturns the name of the ruleset.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the ruleset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated\nwith.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-targetarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nContains metadata about the ruleset.\n*Required*: Yes\n*Type*: Array of [Rule](./aws-properties-databrew-ruleset-rule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to this resource.\nFor more information, see\n[Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-databrew-ruleset-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the ruleset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataBrew::Schedule": { "MarkdownDocumentation": "`AWS::DataBrew::Schedule`\n\nSpecifies a new schedule for one or more AWS Glue DataBrew jobs. Jobs can be\nrun at a specific date and time, or at regular intervals.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"mySchedule\" }`\nFor an AWS Glue DataBrew schedule named `mySchedule`,\n`Ref` returns the name of the schedule.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-schedule.html", "Properties": { "JobNames": { "MarkdownDocumentation": "`JobNames`\n\nA list of jobs to be run, according to the schedule.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-schedule.html#cfn-databrew-schedule-jobnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "CronExpression": { "MarkdownDocumentation": "`CronExpression`\n\nThe dates and times when the job is to run. For more information, see [Working with cron\nexpressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the *AWS Glue DataBrew Developer\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-schedule.html#cfn-databrew-schedule-cronexpression", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata tags that have been applied to the schedule.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-databrew-schedule-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-schedule.html#cfn-databrew-schedule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-schedule.html#cfn-databrew-schedule-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::DataPipeline::Pipeline": { "MarkdownDocumentation": "`AWS::DataPipeline::Pipeline`\n\nThe AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to\nautomate the movement and transformation of data.\n###### Important\nAWS Data Pipeline is no longer available to new customers. Existing customers of AWS Data Pipeline can continue to use the service as normal. [Learn more](https://aws.amazon.com/blogs/big-data/migrate-workloads-from-aws-data-pipeline/)\nIn each pipeline, you define pipeline\nobjects, such as activities, schedules, data nodes, and resources.\nThe `AWS::DataPipeline::Pipeline` resource adds tasks, schedules, and\npreconditions to the specified pipeline. You can use `PutPipelineDefinition` to\npopulate a new pipeline.\n`PutPipelineDefinition` also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one\nof the following validation errors exist in the pipeline.\n* An object is missing a name or identifier field.\n* A string or reference field is empty.\n* The number of objects in the pipeline exceeds the allowed maximum number of objects.\n* The pipeline is in a FINISHED state.\nPipeline object definitions are passed to the [PutPipelineDefinition](https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html) action and returned by the [GetPipelineDefinition](https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_GetPipelineDefinition.html) action.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the pipeline ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html", "Properties": { "Activate": { "MarkdownDocumentation": "`Activate`\n\nIndicates whether to validate and start the pipeline or stop an active pipeline. By\ndefault, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-activate", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the pipeline.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the pipeline.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "ParameterObjects": { "MarkdownDocumentation": "`ParameterObjects`\n\nThe parameter objects used with the pipeline.\n*Required*: No\n*Type*: Array of [ParameterObject](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-parameterobjects", "DuplicatesAllowed": true, "ItemType": "ParameterObject", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "ParameterValues": { "MarkdownDocumentation": "`ParameterValues`\n\nThe parameter values used with the pipeline.\n*Required*: No\n*Type*: Array of [ParameterValue](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-parametervalues", "DuplicatesAllowed": true, "ItemType": "ParameterValue", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "PipelineObjects": { "MarkdownDocumentation": "`PipelineObjects`\n\nThe objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values\ncan be updated. For information about restrictions, see\n[Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html)\nin the *AWS Data Pipeline Developer Guide*.\n*Required*: No\n*Type*: Array of [PipelineObject](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-pipelineobjects", "DuplicatesAllowed": true, "ItemType": "PipelineObject", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "PipelineTags": { "MarkdownDocumentation": "`PipelineTags`\n\nA list of arbitrary tags (key-value pairs) to associate with the pipeline, which you\ncan use to control permissions. For more information, see [Controlling Access to\nPipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the\n*AWS Data Pipeline Developer Guide*.\n*Required*: No\n*Type*: Array of [PipelineTag](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-pipelinetags", "DuplicatesAllowed": true, "ItemType": "PipelineTag", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::DataSync::Agent": { "MarkdownDocumentation": "`AWS::DataSync::Agent`\n\nThe `AWS::DataSync::Agent` resource activates an AWS DataSync\nagent that you've deployed for storage discovery or data transfers. The activation\nprocess associates the agent with your AWS account.\nFor more information, see the following topics in the *AWS DataSync User Guide*:\n* [DataSync\n agent requirements](https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html)\n* [DataSync\n network requirements](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html)\n* [Create a DataSync agent](https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the agent Amazon Resource Name (ARN). For\nexample:\n`arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html", "Properties": { "SubnetArns": { "MarkdownDocumentation": "`SubnetArns`\n\nSpecifies the ARN of the subnet where your VPC service endpoint is located. You can only\nspecify one ARN.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-subnetarns", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AgentName": { "MarkdownDocumentation": "`AgentName`\n\nSpecifies a name for your agent. We recommend specifying a name that you can\nremember.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\s+=._:@/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-agentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe ID of the virtual private cloud (VPC) endpoint that the agent has access to. This\nis the client-side VPC endpoint, powered by AWS PrivateLink. If you don't\nhave 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\nGuide*.\nFor more information about activating your agent in a private network based on a VPC,\nsee [Using AWS DataSync in a Virtual Private Cloud](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-in-vpc.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-vpcendpointid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ActivationKey": { "MarkdownDocumentation": "`ActivationKey`\n\nSpecifies your DataSync agent's activation key. If you don't have an\nactivation key, see [Activating your agent](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}`\n*Maximum*: `29`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-activationkey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupArns": { "MarkdownDocumentation": "`SecurityGroupArns`\n\nThe Amazon Resource Names (ARNs) of the security groups used to protect your data\ntransfer task subnets. See [SecurityGroupArns](https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns).\n*Pattern*:\n`^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*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-securitygrouparns", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least one tag for your agent.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-agent-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "AgentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgentArn`\n\nThe Amazon Resource Name (ARN) of the agent. Use the `ListAgents` operation\nto return a list of agents for your account and AWS Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#AgentArn-fn::getatt" }, "EndpointType": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointType`\n\nThe type of endpoint that your agent is connected to. If the endpoint is a VPC\nendpoint, the agent is not accessible over the public internet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#EndpointType-fn::getatt" } } }, "AWS::DataSync::LocationAzureBlob": { "MarkdownDocumentation": "`AWS::DataSync::LocationAzureBlob`\n\nCreates a transfer *location* for a Microsoft Azure Blob Storage\ncontainer. AWS DataSync can use this location as a transfer source or destination.\nYou can make transfers with or without a [DataSync agent](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent) that connects to your\ncontainer.\nBefore you begin, make sure you know [how DataSync accesses Azure Blob Storage](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access) and works with [access tiers](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers) and [blob types](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html", "Properties": { "CmkSecretConfig": { "MarkdownDocumentation": "`CmkSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, such as an\nauthentication token, secret key, password, or Kerberos keytab that DataSync uses\nto access a specific storage location, with a customer-managed AWS KMS key.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n*Required*: No\n*Type*: [CmkSecretConfig](./aws-properties-datasync-locationazureblob-cmksecretconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-cmksecretconfig", "UpdateType": "Mutable", "Required": false, "Type": "CmkSecretConfig" }, "AzureAccessTier": { "MarkdownDocumentation": "`AzureAccessTier`\n\nSpecifies the access tier that you want your objects or files transferred into. This only\napplies when using the location as a transfer destination. For more information, see [Access tiers](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers).\n*Required*: No\n*Type*: String\n*Allowed values*: `HOT | COOL | ARCHIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HOT", "COOL", "ARCHIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureaccesstier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies path segments if you want to limit your transfer to a virtual directory in your\ncontainer (for example, `/my/images`).\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AzureBlobSasConfiguration": { "MarkdownDocumentation": "`AzureBlobSasConfiguration`\n\nSpecifies the SAS configuration that allows DataSync to access your Azure Blob\nStorage.\n###### Note\nIf you provide an authentication token using `SasConfiguration`, but do not\nprovide secret configuration details using `CmkSecretConfig` or\n`CustomSecretConfig`, then DataSync stores the token using your\nAWS account's secrets manager secret.\n*Required*: No\n*Type*: [AzureBlobSasConfiguration](./aws-properties-datasync-locationazureblob-azureblobsasconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobsasconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AzureBlobSasConfiguration" }, "AzureBlobType": { "MarkdownDocumentation": "`AzureBlobType`\n\nSpecifies the type of blob that you want your objects or files to be when transferring\nthem into Azure Blob Storage. Currently, DataSync only supports moving data into\nAzure Blob Storage as block blobs. For more information on blob types, see the [Azure Blob Storage documentation](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs).\n*Required*: No\n*Type*: String\n*Allowed values*: `BLOCK`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "BLOCK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AzureBlobContainerUrl": { "MarkdownDocumentation": "`AzureBlobContainerUrl`\n\nSpecifies the URL of the Azure Blob Storage container involved in your transfer.\n*Required*: No\n*Type*: String\n*Pattern*: `^https://[A-Za-z0-9]((.|-+)?[A-Za-z0-9]){0,252}/[a-z0-9](-?[a-z0-9]){2,62}$`\n*Maximum*: `325`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobcontainerurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CustomSecretConfig": { "MarkdownDocumentation": "`CustomSecretConfig`\n\nSpecifies configuration information for a customer-managed Secrets Manager secret where\na storage location credentials is stored in Secrets Manager as plain text (for authentication\ntoken, secret key, or password) or as binary (for Kerberos keytab). This configuration includes\nthe secret ARN, and the ARN for an IAM role that provides access to the secret.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n*Required*: No\n*Type*: [CustomSecretConfig](./aws-properties-datasync-locationazureblob-customsecretconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-customsecretconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomSecretConfig" }, "AgentArns": { "MarkdownDocumentation": "`AgentArns`\n\n(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that\ncan connect with your Azure Blob Storage container. If you are setting up an agentless\ncross-cloud transfer, you do not need to specify a value for this parameter.\nYou can specify more than one agent. For more information, see [Using multiple\nagents for your transfer](https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html).\n###### Note\nMake sure you configure this parameter correctly when you first create your storage\nlocation. You cannot add or remove agents from a storage location after you create\nit.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 4`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-agentarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies labels that help you categorize, filter, and search for your AWS\nresources. We recommend creating at least a name tag for your transfer location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationazureblob-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AzureBlobAuthenticationType": { "MarkdownDocumentation": "`AzureBlobAuthenticationType`\n\nSpecifies the authentication method DataSync uses to access your Azure Blob\nStorage. DataSync can access blob storage using a shared access signature\n(SAS).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SAS | NONE`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "SAS", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobauthenticationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ManagedSecretConfig": { "Type": "ManagedSecretConfig", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#ManagedSecretConfig-fn::getatt" }, "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the Azure Blob Storage transfer location that you created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#LocationUri-fn::getatt" }, "ManagedSecretConfig.SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#ManagedSecretConfig.SecretArn-fn::getatt" }, "CmkSecretConfig.SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CmkSecretConfig.SecretArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#CmkSecretConfig.SecretArn-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe ARN of the Azure Blob Storage transfer location that you created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationEFS": { "MarkdownDocumentation": "`AWS::DataSync::LocationEFS`\n\nThe `AWS::DataSync::LocationEFS` resource creates an endpoint for an\nAmazon EFS file system. AWS DataSync can access this endpoint as a\nsource or destination location.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html", "Properties": { "EfsFilesystemArn": { "MarkdownDocumentation": "`EfsFilesystemArn`\n\nSpecifies the ARN for your Amazon EFS file system.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-efsfilesystemarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Ec2Config": { "MarkdownDocumentation": "`Ec2Config`\n\nSpecifies the subnet and security groups DataSync uses to connect to one of\nyour Amazon EFS file system's [mount targets](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html).\n*Required*: Yes\n*Type*: [Ec2Config](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-ec2config", "UpdateType": "Immutable", "Required": true, "Type": "Ec2Config" }, "AccessPointArn": { "MarkdownDocumentation": "`AccessPointArn`\n\nSpecifies the Amazon Resource Name (ARN) of the access point that DataSync uses\nto mount your Amazon EFS file system.\nFor more information, see [Accessing\nrestricted file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-accesspointarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or\ndestination location).\nBy default, DataSync uses the root directory (or [access point](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) if you provide one by using\n`AccessPointArn`). You can also include subdirectories using forward slashes (for\nexample, `/path/to/folder`).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InTransitEncryption": { "MarkdownDocumentation": "`InTransitEncryption`\n\nSpecifies whether you want DataSync to use Transport Layer Security (TLS) 1.2\nencryption when it transfers data to or from your Amazon EFS file system.\nIf you specify an access point using `AccessPointArn` or an IAM\nrole using `FileSystemAccessRoleArn`, you must set this parameter to\n`TLS1_2`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | TLS1_2...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "TLS1_2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-intransitencryption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileSystemAccessRoleArn": { "MarkdownDocumentation": "`FileSystemAccessRoleArn`\n\nSpecifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.\nFor information on creating this role, see [Creating a DataSync\nIAM role for file system access](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-filesystemaccessrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies the key-value pair that represents a tag that you want to add to the\nresource. The value can be an empty string. This value helps you manage, filter, and search\nfor your resources. We recommend that you create a name tag for your location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationefs-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the Amazon EFS file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#LocationUri-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe Amazon Resource Name (ARN) of the Amazon EFS file system.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationFSxLustre": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxLustre`\n\nThe `AWS::DataSync::LocationFSxLustre` resource specifies an endpoint for\nan Amazon FSx for Lustre file system.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html", "Properties": { "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies a mount path for your FSx for Lustre file system. The path can include\nsubdirectories.\nWhen the location is used as a source, DataSync reads data from the mount path.\nWhen the location is used as a destination, DataSync writes data to the mount path.\nIf you don't include this parameter, DataSync uses the file system's root directory\n(`/`).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FsxFilesystemArn": { "MarkdownDocumentation": "`FsxFilesystemArn`\n\nSpecifies the Amazon Resource Name (ARN) of the FSx for Lustre file\nsystem.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-fsxfilesystemarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupArns": { "MarkdownDocumentation": "`SecurityGroupArns`\n\nThe ARNs of the security groups that are used to configure the FSx for Lustre file\nsystem.\n*Pattern*:\n`^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*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-securitygrouparns", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies labels that help you categorize, filter, and search for your AWS\nresources. We recommend creating at least a name tag for your location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationfsxlustre-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the specified FSx for Lustre file system location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#LocationUri-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe ARN of the specified FSx for Lustre file system location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationFSxONTAP": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxONTAP`\n\nThe `AWS::DataSync::LocationFSxONTAP` resource creates an endpoint for an\nAmazon FSx for NetApp ONTAP file system. AWS DataSync can access this\nendpoint as a source or destination location.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html", "Properties": { "StorageVirtualMachineArn": { "MarkdownDocumentation": "`StorageVirtualMachineArn`\n\nSpecifies the ARN of the storage virtual machine (SVM) in your file system where you want\nto copy data to or from.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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*Maximum*: `162`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-storagevirtualmachinearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies a path to the file share in the SVM where you want to transfer data to or\nfrom.\nYou can specify a junction path (also known as a mount point), qtree path (for NFS file\nshares), or share name (for SMB file shares). For example, your mount path might be\n`/vol1`, `/vol1/tree1`, or `/share1`.\n###### Note\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*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nSpecifies the data transfer protocol that DataSync uses to access your\nAmazon FSx file system.\n*Required*: No\n*Type*: [Protocol](./aws-properties-datasync-locationfsxontap-protocol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-protocol", "UpdateType": "Mutable", "Required": false, "Type": "Protocol" }, "SecurityGroupArns": { "MarkdownDocumentation": "`SecurityGroupArns`\n\nSpecifies 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\nsecurity groups to allow outbound traffic on the following ports (depending on the\nprotocol that you're using):\n* **Network File System (NFS)**: TCP ports 111,\n 635, and 2049\n* **Server Message Block (SMB)**: TCP port\n 445\nYour file system's security groups must also allow inbound traffic on the same\nport.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-securitygrouparns", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies labels that help you categorize, filter, and search for your AWS\nresources. We recommend creating at least a name tag for your location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationfsxontap-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the specified location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#LocationUri-fn::getatt" }, "FsxFilesystemArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FsxFilesystemArn`\n\nThe ARN of the FSx for ONTAP file system in the specified location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#FsxFilesystemArn-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe ARN of the specified location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationFSxOpenZFS": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxOpenZFS`\n\nThe `AWS::DataSync::LocationFSxOpenZFS` resource specifies an endpoint for\nan Amazon FSx for OpenZFS file system.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html", "Properties": { "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nA 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\nsystem is a source or destination location).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html#cfn-datasync-locationfsxopenzfs-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FsxFilesystemArn": { "MarkdownDocumentation": "`FsxFilesystemArn`\n\nThe Amazon Resource Name (ARN) of the FSx for OpenZFS file system.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html#cfn-datasync-locationfsxopenzfs-fsxfilesystemarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe type of protocol that AWS DataSync uses to access your file system.\n*Required*: Yes\n*Type*: [Protocol](./aws-properties-datasync-locationfsxopenzfs-protocol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html#cfn-datasync-locationfsxopenzfs-protocol", "UpdateType": "Mutable", "Required": true, "Type": "Protocol" }, "SecurityGroupArns": { "MarkdownDocumentation": "`SecurityGroupArns`\n\nThe ARNs of the security groups that are used to configure the FSx for OpenZFS file\nsystem.\n*Pattern*:\n`^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*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html#cfn-datasync-locationfsxopenzfs-securitygrouparns", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe key-value pair that represents a tag that you want to add to the resource. The value\ncan be an empty string. This value helps you manage, filter, and search for your resources. We\nrecommend that you create a name tag for your location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationfsxopenzfs-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html#cfn-datasync-locationfsxopenzfs-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the specified FSx for OpenZFS file system location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html#LocationUri-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe ARN of the specified FSx for OpenZFS file system location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationFSxWindows": { "MarkdownDocumentation": "`AWS::DataSync::LocationFSxWindows`\n\nThe `AWS::DataSync::LocationFSxWindows` resource specifies an endpoint for\nan Amazon FSx for Windows Server file system.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html", "Properties": { "User": { "MarkdownDocumentation": "`User`\n\nThe user who has the permissions to access files and folders in the FSx for Windows\nFile Server file system.\nFor information about choosing a user name that ensures sufficient permissions to\nfiles, 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*Pattern*: `^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$`\n*Maximum*: `104`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-user", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies 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\nlocation).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FsxFilesystemArn": { "MarkdownDocumentation": "`FsxFilesystemArn`\n\nSpecifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file\nsystem.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-fsxfilesystemarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nSpecifies the name of the Windows domain that the FSx for Windows File Server file system\nbelongs to.\nIf you have multiple Active Directory domains in your environment, configuring this\nparameter makes sure that DataSync connects to the right file system.\n*Required*: No\n*Type*: String\n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-domain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupArns": { "MarkdownDocumentation": "`SecurityGroupArns`\n\nThe Amazon Resource Names (ARNs) of the security groups that are used to configure the\nFSx for Windows File Server file system.\n*Pattern*:\n`^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*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-securitygrouparns", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies labels that help you categorize, filter, and search for your AWS\nresources. We recommend creating at least a name tag for your location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationfsxwindows-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Password": { "MarkdownDocumentation": "`Password`\n\nSpecifies the password of the user with the permissions to mount and access the files,\nfolders, and file metadata in your FSx for Windows File Server file system.\n*Required*: No\n*Type*: String\n*Pattern*: `^.{0,104}$`\n*Maximum*: `104`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-password", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the specified FSx for Windows Server file system location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#LocationUri-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe ARN of the specified FSx for Windows Server file system location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationHDFS": { "MarkdownDocumentation": "`AWS::DataSync::LocationHDFS`\n\nThe `AWS::DataSync::LocationHDFS` resource specifies an endpoint for a\nHadoop Distributed File System (HDFS).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html", "Properties": { "KmsKeyProviderUri": { "MarkdownDocumentation": "`KmsKeyProviderUri`\n\nThe URI of the HDFS cluster's Key Management Server (KMS).\n*Required*: No\n*Type*: String\n*Pattern*: `^kms:\\/\\/http[s]?@(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9]))*:[0-9]{1,5}\\/kms$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-kmskeyprovideruri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "QopConfiguration": { "MarkdownDocumentation": "`QopConfiguration`\n\nThe Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)\nand data transfer protection settings configured on the Hadoop Distributed File System (HDFS)\ncluster. If `QopConfiguration` isn't specified, `RpcProtection` and\n`DataTransferProtection` default to `PRIVACY`. If you set\n`RpcProtection` or `DataTransferProtection`, the other parameter\nassumes the same value.\n*Required*: No\n*Type*: [QopConfiguration](./aws-properties-datasync-locationhdfs-qopconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-qopconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "QopConfiguration" }, "KerberosPrincipal": { "MarkdownDocumentation": "`KerberosPrincipal`\n\nThe Kerberos principal with access to the files and folders on the HDFS cluster.\n###### Note\nIf `KERBEROS` is specified for `AuthenticationType`, this\nparameter is required.\n*Required*: No\n*Type*: String\n*Pattern*: `^.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-kerberosprincipal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SimpleUser": { "MarkdownDocumentation": "`SimpleUser`\n\nThe user name used to identify the client on the host operating system.\n###### Note\nIf `SIMPLE` is specified for `AuthenticationType`, this parameter\nis required.\n*Required*: No\n*Type*: String\n*Pattern*: `^[_.A-Za-z0-9][-_.A-Za-z0-9]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-simpleuser", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReplicationFactor": { "MarkdownDocumentation": "`ReplicationFactor`\n\nThe number of DataNodes to replicate the data to when writing to the HDFS cluster. By\ndefault, data is replicated to three DataNodes.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-replicationfactor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "KerberosKeytab": { "MarkdownDocumentation": "`KerberosKeytab`\n\nThe Kerberos key table (keytab) that contains mappings between the defined Kerberos\nprincipal and the encrypted keys. Provide the base64-encoded file text. If\n`KERBEROS` is specified for `AuthType`, this value is\nrequired.\n*Required*: No\n*Type*: String\n*Maximum*: `87384`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-kerberoskeytab", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NameNodes": { "MarkdownDocumentation": "`NameNodes`\n\nThe NameNode that manages the HDFS namespace. The NameNode performs operations such as\nopening, closing, and renaming files and directories. The NameNode contains the information to\nmap blocks of data to the DataNodes. You can use only one NameNode.\n*Required*: Yes\n*Type*: Array of [NameNode](./aws-properties-datasync-locationhdfs-namenode.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-namenodes", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "NameNode", "DuplicatesAllowed": true }, "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nA subdirectory in the HDFS cluster. This subdirectory is used to read data from or write\ndata to the HDFS cluster. If the subdirectory isn't specified, it will default to\n`/`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KerberosKrb5Conf": { "MarkdownDocumentation": "`KerberosKrb5Conf`\n\nThe `krb5.conf` file that contains the Kerberos configuration information.\nYou can load the `krb5.conf` by providing a string of the file's contents or\nan Amazon S3 presigned URL of the file. If`KERBEROS` is specified for\n`AuthType`, this value is required.\n*Required*: No\n*Type*: String\n*Maximum*: `174764`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-kerberoskrb5conf", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BlockSize": { "MarkdownDocumentation": "`BlockSize`\n\nThe size of data blocks to write into the HDFS cluster. The block size must be a multiple\nof 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-blocksize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe key-value pair that represents the tag that you want to add to the location. The value\ncan be an empty string. We recommend using tags to name your resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationhdfs-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AgentArns": { "MarkdownDocumentation": "`AgentArns`\n\nThe Amazon Resource Names (ARNs) of the DataSync agents that can connect to your\nHDFS cluster.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 4`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-agentarns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AuthenticationType": { "MarkdownDocumentation": "`AuthenticationType`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SIMPLE | KERBEROS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SIMPLE", "KERBEROS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#cfn-datasync-locationhdfs-authenticationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the HDFS cluster location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#LocationUri-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe Amazon Resource Name (ARN) of the HDFS cluster location to describe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationhdfs.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationNFS": { "MarkdownDocumentation": "`AWS::DataSync::LocationNFS`\n\nThe `AWS::DataSync::LocationNFS` resource specifies a Network File System\n(NFS) file server that AWS DataSync can use as a transfer source or\ndestination.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html", "Properties": { "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies the export path in your NFS file server that you want DataSync to\nmount.\nThis path (or a subdirectory of the path) is where DataSync transfers data to\nor from. For information on configuring an export for DataSync, see [Accessing NFS file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerHostname": { "MarkdownDocumentation": "`ServerHostname`\n\nSpecifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-serverhostname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MountOptions": { "MarkdownDocumentation": "`MountOptions`\n\nSpecifies the options that DataSync can use to mount your NFS file\nserver.\n*Required*: No\n*Type*: [MountOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-mountoptions", "UpdateType": "Mutable", "Required": false, "Type": "MountOptions" }, "OnPremConfig": { "MarkdownDocumentation": "`OnPremConfig`\n\nSpecifies the Amazon Resource Name (ARN) of the DataSync agent that can\nconnect to your NFS file server.\nYou can specify more than one agent. For more information, see [Using multiple DataSync agents](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents).\n*Required*: Yes\n*Type*: [OnPremConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-onpremconfig", "UpdateType": "Mutable", "Required": true, "Type": "OnPremConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies 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*: Array of [Tag](./aws-properties-datasync-locationnfs-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#cfn-datasync-locationnfs-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the NFS location that you created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#LocationUri-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe Amazon Resource Name (ARN) of the NFS location that you created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationnfs.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationObjectStorage": { "MarkdownDocumentation": "`AWS::DataSync::LocationObjectStorage`\n\nThe `AWS::DataSync::LocationObjectStorage` resource specifies an endpoint\nfor a self-managed object storage bucket. For more information about self-managed object\nstorage locations, see [Creating a Location for\nObject Storage](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the location resource Amazon Resource Name (ARN). For\nexample:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html", "Properties": { "ServerCertificate": { "MarkdownDocumentation": "`ServerCertificate`\n\nSpecifies a certificate chain for DataSync to authenticate with your object\nstorage system if the system uses a private or self-signed certificate authority (CA). You\nmust specify a single `.pem` file with a full certificate chain (for example,\n`file:///home/user/.ssh/object_storage_certificates.pem`).\nThe certificate chain might include:\n* The object storage system's certificate\n* All intermediate certificates (if there are any)\n* The root certificate of the signing CA\nYou can concatenate your certificates into a `.pem` file (which can be up to\n32768 bytes before base64 encoding). The following example `cat` command creates an\n`object_storage_certificates.pem` file that includes three certificates:\n`cat object_server_certificate.pem intermediate_certificate.pem\nca_root_certificate.pem > object_storage_certificates.pem`\nTo use this parameter, configure `ServerProtocol` to `HTTPS`.\n*Required*: No\n*Type*: String\n*Maximum*: `32768`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-servercertificate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecretKey": { "MarkdownDocumentation": "`SecretKey`\n\nSpecifies the secret key (for example, a password) if credentials are required to\nauthenticate with the object storage server.\n###### Note\nIf you provide a secret using `SecretKey`, but do not provide secret\nconfiguration details using `CmkSecretConfig` or `CustomSecretConfig`,\nthen DataSync stores the token using your AWS account's Secrets Manager secret.\n*Required*: No\n*Type*: String\n*Pattern*: `^.+$`\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-secretkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nSpecifies the name of the object storage bucket involved in the transfer.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-bucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CmkSecretConfig": { "MarkdownDocumentation": "`CmkSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, which\nincludes the `SecretKey` that DataSync uses to access a specific object\nstorage location, with a customer-managed AWS KMS key.\nWhen you include this parameter as part of a `CreateLocationObjectStorage`\nrequest, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the `SecretKey` parameter\nto create a DataSync-managed secret to store the location access credentials.\nMake sure that DataSync has permission to access the KMS key that\nyou specify.\n###### Note\nYou can use either `CmkSecretConfig` (with `SecretKey`) or\n`CustomSecretConfig` (without `SecretKey`) to provide credentials\nfor a `CreateLocationObjectStorage` request. Do not provide both parameters for\nthe same request.\n*Required*: No\n*Type*: [CmkSecretConfig](./aws-properties-datasync-locationobjectstorage-cmksecretconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-cmksecretconfig", "UpdateType": "Mutable", "Required": false, "Type": "CmkSecretConfig" }, "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies the object prefix for your object storage server. If this is a source location,\nDataSync only copies objects with this prefix. If this is a destination location,\nDataSync writes all objects with this prefix.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerHostname": { "MarkdownDocumentation": "`ServerHostname`\n\nSpecifies the domain name or IP address (IPv4 or IPv6) of the object storage server that\nyour DataSync agent connects to.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-serverhostname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessKey": { "MarkdownDocumentation": "`AccessKey`\n\nSpecifies the access key (for example, a user name) if credentials are required to\nauthenticate with the object storage server.\n*Required*: No\n*Type*: String\n*Pattern*: `^.+$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-accesskey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomSecretConfig": { "MarkdownDocumentation": "`CustomSecretConfig`\n\nSpecifies configuration information for a customer-managed Secrets Manager secret where\nthe secret key for a specific object storage location is stored in plain text, in Secrets Manager.\nThis configuration includes the secret ARN, and the ARN for an IAM role that\nprovides access to the secret.\n###### Note\nYou can use either `CmkSecretConfig` (with `SecretKey`) or\n`CustomSecretConfig` (without `SecretKey`) to provide credentials\nfor a `CreateLocationObjectStorage` request. Do not provide both parameters for\nthe same request.\n*Required*: No\n*Type*: [CustomSecretConfig](./aws-properties-datasync-locationobjectstorage-customsecretconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-customsecretconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomSecretConfig" }, "ServerProtocol": { "MarkdownDocumentation": "`ServerProtocol`\n\nSpecifies the protocol that your object storage server uses to communicate. If not specified, the default\nvalue is `HTTPS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTPS | HTTP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HTTPS", "HTTP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-serverprotocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AgentArns": { "MarkdownDocumentation": "`AgentArns`\n\n(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents\nthat can connect with your object storage system. If you are setting up an agentless\ncross-cloud transfer, you do not need to specify a value for this parameter.\n###### Note\nMake sure you configure this parameter correctly when you first create your storage\nlocation. You cannot add or remove agents from a storage location after you create\nit.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 4`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-agentarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ServerPort": { "MarkdownDocumentation": "`ServerPort`\n\nSpecifies the port that your object storage server accepts inbound network traffic on (for\nexample, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-serverport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies the key-value pair that represents a tag that you want to add to the resource.\nTags can help you manage, filter, and search for your resources. We recommend creating a name\ntag for your location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationobjectstorage-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ManagedSecretConfig": { "Type": "ManagedSecretConfig", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#ManagedSecretConfig-fn::getatt" }, "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the specified object storage location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#LocationUri-fn::getatt" }, "ManagedSecretConfig.SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#ManagedSecretConfig.SecretArn-fn::getatt" }, "CmkSecretConfig.SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CmkSecretConfig.SecretArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#CmkSecretConfig.SecretArn-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe Amazon Resource Name (ARN) of the specified object storage location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationS3": { "MarkdownDocumentation": "`AWS::DataSync::LocationS3`\n\nThe `AWS::DataSync::LocationS3` resource specifies an endpoint for an\nAmazon S3 bucket.\nFor more information, see the [*AWS DataSync User Guide*](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the location resource Amazon Resource Name (ARN). For\nexample:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html", "Properties": { "S3StorageClass": { "MarkdownDocumentation": "`S3StorageClass`\n\nThe Amazon S3 storage class that you want to store your files in when this location is\nused as a task destination. For buckets in AWS Regions, the storage\nclass defaults to S3 Standard.\nFor more information about S3 storage classes, see [Amazon S3 Storage Classes](https://aws.amazon.com/s3/storage-classes/). Some storage classes\nhave behaviors that can affect your S3 storage costs. For detailed information, see\n[Considerations When Working with Amazon S3 Storage Classes in\nDataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | STANDARD_IA | ON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "GLACIER_INSTANT_RETRIEVAL", "DEEP_ARCHIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3storageclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3Config": { "MarkdownDocumentation": "`S3Config`\n\nThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used\nto 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\nUser Guide*.\n*Required*: Yes\n*Type*: [S3Config](./aws-properties-datasync-locations3-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3config", "UpdateType": "Mutable", "Required": true, "Type": "S3Config" }, "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies a prefix in the S3 bucket that DataSync reads from or writes to\n(depending on whether the bucket is a source or destination location).\n###### Note\nDataSync can't transfer objects with a prefix that begins with a slash (`/`)\nor includes `//`, `/./`, or `/../` patterns. For\nexample:\n* `/photos`\n* `photos//2006/January`\n* `photos/./2006/February`\n* `photos/../2006/March`\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3BucketArn": { "MarkdownDocumentation": "`S3BucketArn`\n\nThe ARN of the Amazon S3 bucket.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:[a-z\\-0-9]*:[0-9]*:.*$`\n*Maximum*: `156`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3bucketarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your transfer location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locations3-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the specified Amazon S3 location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#LocationUri-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe Amazon Resource Name (ARN) of the specified Amazon S3 location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::LocationSMB": { "MarkdownDocumentation": "`AWS::DataSync::LocationSMB`\n\nThe `AWS::DataSync::LocationSMB` resource specifies a Server Message Block\n(SMB) location that AWS DataSync can use as a transfer source or\ndestination.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the location resource Amazon Resource Name (ARN). For\nexample:\n`arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html", "Properties": { "KerberosPrincipal": { "MarkdownDocumentation": "`KerberosPrincipal`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberosprincipal", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "User": { "MarkdownDocumentation": "`User`\n\nSpecifies the user that can mount and access the files, folders, and file metadata in your\nSMB file server. This parameter applies only if `AuthenticationType` is set to\n`NTLM`.\nFor information about choosing a user with the right level of access for your transfer,\nsee [Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$`\n*Maximum*: `104`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-user", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KerberosKeytab": { "MarkdownDocumentation": "`KerberosKeytab`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Maximum*: `87384`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberoskeytab", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CmkSecretConfig": { "MarkdownDocumentation": "`CmkSecretConfig`\n\nSpecifies configuration information for a DataSync-managed secret, such as an\nauthentication token, secret key, password, or Kerberos keytab that DataSync uses\nto access a specific storage location, with a customer-managed AWS KMS key.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n*Required*: No\n*Type*: [CmkSecretConfig](./aws-properties-datasync-locationsmb-cmksecretconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-cmksecretconfig", "UpdateType": "Mutable", "Required": false, "Type": "CmkSecretConfig" }, "Subdirectory": { "MarkdownDocumentation": "`Subdirectory`\n\nSpecifies the name of the share exported by your SMB file server where DataSync\nwill read or write data. You can include a subdirectory in the share path (for example,\n`/path/to/subdirectory`). Make sure that other SMB clients in your network can\nalso mount this path.\nTo copy all data in the subdirectory, DataSync must be able to mount the SMB\nshare and access all of its data. For more information, see [Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions).\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-subdirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerHostname": { "MarkdownDocumentation": "`ServerHostname`\n\nSpecifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.\n###### Note\nIf you're using Kerberos authentication, you must specify a domain name.\n*Required*: No\n*Type*: String\n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-serverhostname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KerberosKrb5Conf": { "MarkdownDocumentation": "`KerberosKrb5Conf`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Maximum*: `174764`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberoskrb5conf", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomSecretConfig": { "MarkdownDocumentation": "`CustomSecretConfig`\n\nSpecifies configuration information for a customer-managed Secrets Manager secret where\na storage location credentials is stored in Secrets Manager as plain text (for authentication\ntoken, secret key, or password) or as binary (for Kerberos keytab). This configuration includes\nthe secret ARN, and the ARN for an IAM role that provides access to the secret.\n###### Note\nYou can use either `CmkSecretConfig` or `CustomSecretConfig` to\nprovide credentials for a `CreateLocation` request. Do not provide both\nparameters for the same request.\n*Required*: No\n*Type*: [CustomSecretConfig](./aws-properties-datasync-locationsmb-customsecretconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-customsecretconfig", "UpdateType": "Mutable", "Required": false, "Type": "CustomSecretConfig" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nSpecifies the Windows domain name that your SMB file server belongs to. This parameter\napplies only if `AuthenticationType` is set to `NTLM`.\nIf you have multiple domains in your environment, configuring this parameter makes sure\nthat DataSync connects to the right file server.\n*Required*: No\n*Type*: String\n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-domain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DnsIpAddresses": { "MarkdownDocumentation": "`DnsIpAddresses`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `7`\n*Maximum*: `15 | 2`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-dnsipaddresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MountOptions": { "MarkdownDocumentation": "`MountOptions`\n\nSpecifies the version of the SMB protocol that DataSync uses to access your SMB\nfile server.\n*Required*: No\n*Type*: [MountOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-mountoptions", "UpdateType": "Mutable", "Required": false, "Type": "MountOptions" }, "AgentArns": { "MarkdownDocumentation": "`AgentArns`\n\nSpecifies the DataSync agent (or agents) that can connect to your SMB file\nserver. You specify an agent by using its Amazon Resource Name (ARN).\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `128 | 8`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-agentarns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies labels that help you categorize, filter, and search for your AWS\nresources. We recommend creating at least a name tag for your location.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-locationsmb-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Password": { "MarkdownDocumentation": "`Password`\n\nSpecifies the password of the user who can mount your SMB file server and has permission\nto access the files and folders involved in your transfer. This parameter applies only if\n`AuthenticationType` is set to `NTLM`.\n*Required*: No\n*Type*: String\n*Pattern*: `^.{0,104}$`\n*Maximum*: `104`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-password", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthenticationType": { "MarkdownDocumentation": "`AuthenticationType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `NTLM | KERBEROS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NTLM", "KERBEROS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-authenticationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ManagedSecretConfig": { "Type": "ManagedSecretConfig", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#ManagedSecretConfig-fn::getatt" }, "LocationUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationUri`\n\nThe URI of the specified SMB location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#LocationUri-fn::getatt" }, "ManagedSecretConfig.SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#ManagedSecretConfig.SecretArn-fn::getatt" }, "CmkSecretConfig.SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CmkSecretConfig.SecretArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#CmkSecretConfig.SecretArn-fn::getatt" }, "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nThe Amazon Resource Name (ARN) of the specified SMB location.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#LocationArn-fn::getatt" } } }, "AWS::DataSync::Task": { "MarkdownDocumentation": "`AWS::DataSync::Task`\n\nThe `AWS::DataSync::Task` resource specifies a task. A task is a set of two\nlocations (source and destination) and a set of `Options` that you use to\ncontrol the behavior of a task. If you don't specify `Options` when you\ncreate a task, AWS DataSync populates them with service defaults.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the location resource ARN. For example:\n`arn:aws:datasync:us-east-2:111222333444:task/task-07db7abfc326c50s3`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html", "Properties": { "Includes": { "MarkdownDocumentation": "`Includes`\n\nSpecifies include filters that define the files, objects, and folders in your source\nlocation that you want DataSync to transfer. For more information and examples, see\n[Specifying what\nDataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).\n*Required*: No\n*Type*: Array of [FilterRule](./aws-properties-datasync-task-filterrule.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-includes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterRule", "DuplicatesAllowed": true }, "DestinationLocationArn": { "MarkdownDocumentation": "`DestinationLocationArn`\n\nThe Amazon Resource Name (ARN) of an AWS storage resource's\nlocation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-destinationlocationarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Options": { "MarkdownDocumentation": "`Options`\n\nSpecifies your task's settings, such as preserving file metadata, verifying data\nintegrity, among other options.\n*Required*: No\n*Type*: [Options](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-options", "UpdateType": "Mutable", "Required": false, "Type": "Options" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nSpecifies a schedule for when you want your task to run. For more information, see [Scheduling your\ntask](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).\n*Required*: No\n*Type*: [TaskSchedule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule", "UpdateType": "Mutable", "Required": false, "Type": "TaskSchedule" }, "CloudWatchLogGroupArn": { "MarkdownDocumentation": "`CloudWatchLogGroupArn`\n\nSpecifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\nmonitoring your task.\nFor Enhanced mode tasks, you don't need to specify anything. DataSync\nautomatically sends logs to a CloudWatch log group named\n`/aws/datasync`.\nFor more information, see [Monitoring data transfers with\nCloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([^:\\*]*)(:\\*)?$`\n*Maximum*: `562`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-cloudwatchloggrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceLocationArn": { "MarkdownDocumentation": "`SourceLocationArn`\n\nSpecifies the ARN of your transfer's source location.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-sourcelocationarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TaskReportConfig": { "MarkdownDocumentation": "`TaskReportConfig`\n\nThe configuration of your task report, which provides detailed information about your\nDataSync transfer. For more information, see [Monitoring your DataSync\ntransfers with task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).\n*Required*: No\n*Type*: [TaskReportConfig](./aws-properties-datasync-task-taskreportconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskreportconfig", "UpdateType": "Mutable", "Required": false, "Type": "TaskReportConfig" }, "Excludes": { "MarkdownDocumentation": "`Excludes`\n\nSpecifies exclude filters that define the files, objects, and folders in your source\nlocation that you don't want DataSync to transfer. For more information and\nexamples, see [Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html).\n*Required*: No\n*Type*: Array of [FilterRule](./aws-properties-datasync-task-filterrule.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-excludes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FilterRule", "DuplicatesAllowed": true }, "TaskMode": { "MarkdownDocumentation": "`TaskMode`\n\nThe task mode that you're using. For more information, see [Choosing a task mode for your data\ntransfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC | ENHANCED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "ENHANCED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies the tags that you want to apply to your task.\n*Tags* are key-value pairs that help you manage, filter, and search\nfor your DataSync resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datasync-task-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nSpecifies the name of your task.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\s+=._:@/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManifestConfig": { "MarkdownDocumentation": "`ManifestConfig`\n\nThe configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).\n*Required*: No\n*Type*: [ManifestConfig](./aws-properties-datasync-task-manifestconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-manifestconfig", "UpdateType": "Mutable", "Required": false, "Type": "ManifestConfig" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the task that was described.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#Status-fn::getatt" }, "SourceNetworkInterfaceArns": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`SourceNetworkInterfaceArns`\n\nThe ARNs of the source ENIs that were created for your subnet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#SourceNetworkInterfaceArns-fn::getatt" }, "DestinationNetworkInterfaceArns": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`DestinationNetworkInterfaceArns`\n\nThe ARNs of the destination elastic network interfaces (ENIs) that were created for\nyour subnet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#DestinationNetworkInterfaceArns-fn::getatt" }, "TaskArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TaskArn`\n\nThe ARN of the task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#TaskArn-fn::getatt" } } }, "AWS::DataZone::Connection": { "MarkdownDocumentation": "`AWS::DataZone::Connection`\n\nIn Amazon DataZone, a connection enables you to connect your resources (domains,\nprojects, and environments) to external resources and services.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand `ConnectionId`, which uniquely identifies a connection. For example:\n`{ \"Ref\": \"MyConnection\" }` for the resource with the logical ID\n`MyConnection`, `Ref` returns\n`DomainId|ConnectionId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html", "Properties": { "ProjectIdentifier": { "MarkdownDocumentation": "`ProjectIdentifier`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-projectidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nConnection description.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S\\s]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentIdentifier": { "MarkdownDocumentation": "`EnvironmentIdentifier`\n\nThe ID of the environment where the connection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-environmentidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe scope of the connection.\n*Required*: No\n*Type*: String\n*Allowed values*: `DOMAIN | PROJECT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DOMAIN", "PROJECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-scope", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Props": { "MarkdownDocumentation": "`Props`\n\nConnection props.\n*Required*: No\n*Type*: [ConnectionPropertiesInput](./aws-properties-datazone-connection-connectionpropertiesinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-props", "UpdateType": "Mutable", "Required": false, "Type": "ConnectionPropertiesInput" }, "AwsLocation": { "MarkdownDocumentation": "`AwsLocation`\n\nThe location where the connection is created.\n*Required*: No\n*Type*: [AwsLocation](./aws-properties-datazone-connection-awslocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-awslocation", "UpdateType": "Mutable", "Required": false, "Type": "AwsLocation" }, "EnableTrustedIdentityPropagation": { "MarkdownDocumentation": "`EnableTrustedIdentityPropagation`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-enabletrustedidentitypropagation", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the connection.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w][\\w\\.\\-\\_]*$`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe ID of the domain where the connection is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[_-][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DomainUnitId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainUnitId`\n\nThe domain unit ID of the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#DomainUnitId-fn::getatt" }, "ConnectionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectionId`\n\nThe ID of the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#ConnectionId-fn::getatt" }, "EnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentId`\n\nThe ID of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#EnvironmentId-fn::getatt" }, "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nThe type of the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#Type-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe domain ID of the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#DomainId-fn::getatt" }, "ProjectId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProjectId`\n\nThe ID of the project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#ProjectId-fn::getatt" }, "EnvironmentUserRole": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentUserRole`\n\nThe environment user role.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#EnvironmentUserRole-fn::getatt" } } }, "AWS::DataZone::DataSource": { "MarkdownDocumentation": "`AWS::DataZone::DataSource`\n\nThe `AWS::DataZone::DataSource`resource specifies an Amazon DataZone data\nsource that is used to import technical metadata of assets (data) from the source\ndatabases or data warehouses into Amazon DataZone.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand the `DataSourceId`, which uniquely identifies the data source. For\nexample: `{ \"Ref\": \"MyDataSource\" }` for the resource with the logical ID\n`MyDataSource`, `Ref` returns\n`DomainId|DataSourceId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html", "Properties": { "ProjectIdentifier": { "MarkdownDocumentation": "`ProjectIdentifier`\n\nThe identifier of the Amazon DataZone project in which you want to add this data\nsource.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-projectidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PublishOnImport": { "MarkdownDocumentation": "`PublishOnImport`\n\nSpecifies whether the assets that this data source creates in the inventory are to be\nalso automatically published to the catalog.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-publishonimport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the data source.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentIdentifier": { "MarkdownDocumentation": "`EnvironmentIdentifier`\n\nThe unique identifier of the Amazon DataZone environment to which the data source publishes\nassets.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-environmentidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration of the data source.\n*Required*: No\n*Type*: [DataSourceConfigurationInput](./aws-properties-datazone-datasource-datasourceconfigurationinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-configuration", "UpdateType": "Mutable", "Required": false, "Type": "DataSourceConfigurationInput" }, "AssetFormsInput": { "MarkdownDocumentation": "`AssetFormsInput`\n\nThe metadata forms attached to the assets that the data source works with.\n*Required*: No\n*Type*: Array of [FormInput](./aws-properties-datazone-datasource-forminput.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-assetformsinput", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FormInput", "DuplicatesAllowed": true }, "Recommendation": { "MarkdownDocumentation": "`Recommendation`\n\nSpecifies whether the business name generation is to be enabled for this data\nsource.\n*Required*: No\n*Type*: [RecommendationConfiguration](./aws-properties-datazone-datasource-recommendationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-recommendation", "UpdateType": "Mutable", "Required": false, "Type": "RecommendationConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the data source. In Amazon DataZone, you can use data sources to import\ntechnical metadata of assets (data) from the source databases or data warehouses into\nAmazon DataZone. In the current release of Amazon DataZone, you can create and run data\nsources for AWS Glue and Amazon Redshift.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EnableSetting": { "MarkdownDocumentation": "`EnableSetting`\n\nSpecifies whether the data source is enabled.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-enablesetting", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionIdentifier": { "MarkdownDocumentation": "`ConnectionIdentifier`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-connectionidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe schedule of the data source runs.\n*Required*: No\n*Type*: [ScheduleConfiguration](./aws-properties-datazone-datasource-scheduleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-schedule", "UpdateType": "Mutable", "Required": false, "Type": "ScheduleConfiguration" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe ID of the Amazon DataZone domain where the data source is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#Status-fn::getatt" }, "ConnectionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectionId`\n\nThe connection ID that's part of the data source summary.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#ConnectionId-fn::getatt" }, "EnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentId`\n\nThe ID of the environment in which the data source exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#EnvironmentId-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe ID of the Amazon DataZone domain in which the data source exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#DomainId-fn::getatt" }, "LastRunAssetCount": { "PrimitiveType": "Double", "MarkdownDocumentation": "`LastRunAssetCount`\n\nThe count of the assets created during the last data source run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#LastRunAssetCount-fn::getatt" }, "LastRunAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastRunAt`\n\nThe timestamp of when the data source run was last performed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#LastRunAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when the data source was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#CreatedAt-fn::getatt" }, "ProjectId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProjectId`\n\nThe project ID included in the data source run activity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#ProjectId-fn::getatt" }, "LastRunStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastRunStatus`\n\nThe status of the last data source run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#LastRunStatus-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of the data source run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#Id-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp of when the data source was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#UpdatedAt-fn::getatt" } } }, "AWS::DataZone::Domain": { "MarkdownDocumentation": "`AWS::DataZone::Domain`\n\nThe `AWS::DataZone::Domain`resource specifies an Amazon DataZone domain.\nYou can use domains to organize your assets, users, and their projects.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Amazon DataZone domain.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html", "Properties": { "DomainExecutionRole": { "MarkdownDocumentation": "`DomainExecutionRole`\n\nThe domain execution role that is created when an Amazon DataZone domain is created. The\ndomain execution role is created in the AWS account that houses the\nAmazon DataZone domain.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-domainexecutionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyIdentifier": { "MarkdownDocumentation": "`KmsKeyIdentifier`\n\nThe identifier of the AWS Key Management Service (KMS) key that is used\nto encrypt the Amazon DataZone domain, metadata, and reporting data.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-kmskeyidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the Amazon DataZone 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceRole": { "MarkdownDocumentation": "`ServiceRole`\n\nThe service role of the domain.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-servicerole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainVersion": { "MarkdownDocumentation": "`DomainVersion`\n\nThe domain version.\n*Required*: No\n*Type*: String\n*Allowed values*: `V1 | V2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "V1", "V2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-domainversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags specified for the Amazon DataZone domain.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-datazone-domain-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Amazon DataZone 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SingleSignOn": { "MarkdownDocumentation": "`SingleSignOn`\n\nThe single sign-on details in Amazon DataZone.\n*Required*: No\n*Type*: [SingleSignOn](./aws-properties-datazone-domain-singlesignon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-singlesignon", "UpdateType": "Mutable", "Required": false, "Type": "SingleSignOn" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the Amazon DataZone domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#Status-fn::getatt" }, "RootDomainUnitId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RootDomainUnitId`\n\nThe ID of the root domain unit.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#RootDomainUnitId-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nA timestamp of when a Amazon DataZone domain was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#LastUpdatedAt-fn::getatt" }, "PortalUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`PortalUrl`\n\nThe data portal URL for the Amazon DataZone domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#PortalUrl-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nA timestamp of when a Amazon DataZone domain was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the Amazon DataZone domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#Id-fn::getatt" }, "ManagedAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ManagedAccountId`\n\nThe identifier of the AWS account that manages the domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#ManagedAccountId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the Amazon DataZone domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#Arn-fn::getatt" } } }, "AWS::DataZone::DomainUnit": { "MarkdownDocumentation": "`AWS::DataZone::DomainUnit`\n\nThe summary of the domain unit.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand `DomainUnitId`, which uniquely identifies a domain unit. For example: {\n`\"Ref\": \"MyDomainUnit\"` } for the resource with the logical ID\nMyDomainUnit, Ref returns `DomainId|DomainUnitId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the domain unit.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#cfn-datazone-domainunit-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParentDomainUnitIdentifier": { "MarkdownDocumentation": "`ParentDomainUnitIdentifier`\n\nThe ID of the parent domain unit.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#cfn-datazone-domainunit-parentdomainunitidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe ID of the domain where you want to crate a domain unit.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#cfn-datazone-domainunit-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the domain unit.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w -]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#cfn-datazone-domainunit-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe ID of the domain in which the domain unit lives.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#DomainId-fn::getatt" }, "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nThe identifier of the domain unit that you want to get.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#Identifier-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe timestamp at which the domain unit was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#LastUpdatedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time stamp at which the domain unit was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the domain unit.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#Id-fn::getatt" }, "ParentDomainUnitId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ParentDomainUnitId`\n\nThe ID of the parent domain unit.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#ParentDomainUnitId-fn::getatt" } } }, "AWS::DataZone::Environment": { "MarkdownDocumentation": "`AWS::DataZone::Environment`\n\nThe `AWS::DataZone::Environment`resource specifies an Amazon DataZone\nenvironment, which is a collection of zero or more configured resources with a given set\nof IAM principals who can operate on those resources.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand `EnvironmentId`, which uniquely identifies the environment. For example:\n`{ \"Ref\": \"MyEnvironment\" }` for the resource with the logical ID\n`MyEnvironment`, `Ref` returns\n`DomainId|EnvironmentId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html", "Properties": { "ProjectIdentifier": { "MarkdownDocumentation": "`ProjectIdentifier`\n\nThe identifier of the Amazon DataZone project in which this environment is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-projectidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EnvironmentAccountRegion": { "MarkdownDocumentation": "`EnvironmentAccountRegion`\n\nThe AWS Region in which an environment exists.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z]{2}-[a-z]{4,10}-\\d$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentaccountregion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UserParameters": { "MarkdownDocumentation": "`UserParameters`\n\nThe user parameters of this Amazon DataZone environment.\n*Required*: No\n*Type*: Array of [EnvironmentParameter](./aws-properties-datazone-environment-environmentparameter.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-userparameters", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "EnvironmentParameter", "DuplicatesAllowed": true }, "EnvironmentRoleArn": { "MarkdownDocumentation": "`EnvironmentRoleArn`\n\nThe ARN of the environment 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentProfileIdentifier": { "MarkdownDocumentation": "`EnvironmentProfileIdentifier`\n\nThe identifier of the environment profile that is used to create this Amazon DataZone\nenvironment.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{0,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentprofileidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GlossaryTerms": { "MarkdownDocumentation": "`GlossaryTerms`\n\nThe glossary terms that can be used in this Amazon DataZone environment.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-glossaryterms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnvironmentAccountIdentifier": { "MarkdownDocumentation": "`EnvironmentAccountIdentifier`\n\nThe identifier of the AWS account in which an environment exists.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentaccountidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Amazon DataZone environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w -]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe identifier of the Amazon DataZone domain in which the environment is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#Status-fn::getatt" }, "CreatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy`\n\nThe Amazon DataZone user who created the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#CreatedBy-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe identifier of the Amazon DataZone domain in which the environment exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#DomainId-fn::getatt" }, "EnvironmentProfileId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentProfileId`\n\nThe identifier of the environment profile with which the environment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#EnvironmentProfileId-fn::getatt" }, "AwsAccountRegion": { "PrimitiveType": "String", "MarkdownDocumentation": "`AwsAccountRegion`\n\nThe AWS Region in which an environment exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#AwsAccountRegion-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when the environment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#CreatedAt-fn::getatt" }, "ProjectId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProjectId`\n\nThe identifier of the project in which the environment exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#ProjectId-fn::getatt" }, "AwsAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AwsAccountId`\n\nThe identifier of the AWS account in which an environment exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#AwsAccountId-fn::getatt" }, "EnvironmentBlueprintId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentBlueprintId`\n\nThe identifier of a blueprint with which an environment profile is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#EnvironmentBlueprintId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#Id-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp of when the environment was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#UpdatedAt-fn::getatt" }, "Provider": { "PrimitiveType": "String", "MarkdownDocumentation": "`Provider`\n\nThe provider of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#Provider-fn::getatt" } } }, "AWS::DataZone::EnvironmentActions": { "MarkdownDocumentation": "`AWS::DataZone::EnvironmentActions`\n\nThe details about the specified action configured for an environment. For example, the\ndetails of the specified console links for an analytics tool that is available in this\nenvironment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand `EnvironmentActionId`, which uniquely identifies the environment action.\nFor example: `{ \"Ref\": \"MyEnvironmentAction\" }` for the resource with the\nlogical ID `MyEnvironmentAction`, `Ref` returns\n`DomainId|EnvironmentActionId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe environment action description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentIdentifier": { "MarkdownDocumentation": "`EnvironmentIdentifier`\n\nThe environment ID of the environment action.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_-]{1,36}$`\n*Minimum*: `1`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-environmentidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Identifier": { "MarkdownDocumentation": "`Identifier`\n\nThe ID of the environment action.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-identifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters of the environment action.\n*Required*: No\n*Type*: [AwsConsoleLinkParameters](./aws-properties-datazone-environmentactions-awsconsolelinkparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-parameters", "UpdateType": "Mutable", "Required": false, "Type": "AwsConsoleLinkParameters" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe Amazon DataZone domain ID of the environment action.\n*Required*: No\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-domainidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the environment action.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w -]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "EnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentId`\n\nThe environment ID of the environment action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#EnvironmentId-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe Amazon DataZone domain ID of the environment action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#DomainId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the environment action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#Id-fn::getatt" } } }, "AWS::DataZone::EnvironmentBlueprintConfiguration": { "MarkdownDocumentation": "`AWS::DataZone::EnvironmentBlueprintConfiguration`\n\nThe configuration details of an environment blueprint.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand the `EnvironmentBlueprintId`, which uniquely identifies the environment\nblueprint configuration. For example: `{ \"Ref\": \"MyBlueprintConfiguration\" }`\nfor the resource with the logical ID `MyBlueprintConfiguration`,\n`Ref` returns `DomainId|BlueprintConfigurationId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html", "Properties": { "RegionalParameters": { "MarkdownDocumentation": "`RegionalParameters`\n\nThe regional parameters of the environment blueprint.\n*Required*: No\n*Type*: Array of [RegionalParameter](./aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-regionalparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RegionalParameter", "DuplicatesAllowed": false }, "ProvisioningRoleArn": { "MarkdownDocumentation": "`ProvisioningRoleArn`\n\nThe ARN of the provisioning role.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-provisioningrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProvisioningConfigurations": { "MarkdownDocumentation": "`ProvisioningConfigurations`\n\nThe provisioning configuration of a blueprint.\n*Required*: No\n*Type*: Array of [ProvisioningConfiguration](./aws-properties-datazone-environmentblueprintconfiguration-provisioningconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-provisioningconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ProvisioningConfiguration", "DuplicatesAllowed": true }, "EnabledRegions": { "MarkdownDocumentation": "`EnabledRegions`\n\nThe enabled AWS Regions specified in a blueprint configuration.\n*Required*: Yes\n*Type*: Array of String\n*Maximum*: `16`\n*Minimum*: `4 | 0`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-enabledregions", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "EnvironmentBlueprintIdentifier": { "MarkdownDocumentation": "`EnvironmentBlueprintIdentifier`\n\nThe identifier of the environment blueprint.\nIn the current release, only the following values are supported:\n`DefaultDataLake` and `DefaultDataWarehouse`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-environmentblueprintidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe identifier of the Amazon DataZone domain in which an environment blueprint exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EnvironmentRolePermissionBoundary": { "MarkdownDocumentation": "`EnvironmentRolePermissionBoundary`\n\nThe environment role permission boundary.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::(aws|\\d{12}):policy/[\\w+=,.@-]*$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-environmentrolepermissionboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManageAccessRoleArn": { "MarkdownDocumentation": "`ManageAccessRoleArn`\n\nThe ARN of the manage access role.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:iam::\\d{12}:role(/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-manageaccessrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe identifier of the Amazon DataZone domain in which an environment blueprint exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#DomainId-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when an environment blueprint was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#CreatedAt-fn::getatt" }, "EnvironmentBlueprintId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentBlueprintId`\n\nThe identifier of the environment blueprint. This identifier should be used when\ncreating environment profiles.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#EnvironmentBlueprintId-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp of when the environment blueprint was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#UpdatedAt-fn::getatt" } } }, "AWS::DataZone::EnvironmentProfile": { "MarkdownDocumentation": "`AWS::DataZone::EnvironmentProfile`\n\nThe details of an environment profile.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand the `EnvironmentProfileId`, which uniquely identifies the environment\nprofile. For example: `{ \"Ref\": \"MyEnvironmentProfile\" }` for the resource\nwith the logical `ID MyEnvironmentProfile`, `Ref` returns\n`DomainId|EnvironmentProfileId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html", "Properties": { "ProjectIdentifier": { "MarkdownDocumentation": "`ProjectIdentifier`\n\nThe identifier of a project in which an environment profile exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-projectidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UserParameters": { "MarkdownDocumentation": "`UserParameters`\n\nThe user parameters of this Amazon DataZone environment profile.\n*Required*: No\n*Type*: Array of [EnvironmentParameter](./aws-properties-datazone-environmentprofile-environmentparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-userparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentParameter", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the environment profile.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AwsAccountRegion": { "MarkdownDocumentation": "`AwsAccountRegion`\n\nThe AWS Region in which an environment profile exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z]{2}-[a-z]{4,10}-\\d$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-awsaccountregion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe identifier of an AWS account in which an environment profile exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-awsaccountid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnvironmentBlueprintIdentifier": { "MarkdownDocumentation": "`EnvironmentBlueprintIdentifier`\n\nThe identifier of a blueprint with which an environment profile is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-environmentblueprintidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the environment profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w -]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe identifier of the Amazon DataZone domain in which the environment profile exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy`\n\nThe Amazon DataZone user who created the environment profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#CreatedBy-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe identifier of the Amazon DataZone domain in which the environment profile exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#DomainId-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when an environment profile was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#CreatedAt-fn::getatt" }, "ProjectId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProjectId`\n\nThe identifier of a project in which an environment profile exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#ProjectId-fn::getatt" }, "EnvironmentBlueprintId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentBlueprintId`\n\nThe identifier of a blueprint with which an environment profile is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#EnvironmentBlueprintId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of the environment profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#Id-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp of when the environment profile was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#UpdatedAt-fn::getatt" } } }, "AWS::DataZone::FormType": { "MarkdownDocumentation": "`AWS::DataZone::FormType`\n\nThe details of the metadata form type.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated\n`DomainIdentifier` and `FormTypeIdentifier`, which uniquely\nidentifies a form type. For example: `{\"Ref\": \"MyFormType\" }` for the\nresource with the logical ID `MyFormType`, `Ref` returns\n`DomainIdentifier|FormTypeIdentifier`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the form type.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-status", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the metadata form type.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `2048`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-description", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Model": { "MarkdownDocumentation": "`Model`\n\nThe model of the form type.\n*Required*: Yes\n*Type*: [Model](./aws-properties-datazone-formtype-model.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-model", "UpdateType": "Conditional", "Required": true, "Type": "Model" }, "OwningProjectIdentifier": { "MarkdownDocumentation": "`OwningProjectIdentifier`\n\nThe identifier of the project that owns the form type.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-owningprojectidentifier", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe identifier of the Amazon DataZone domain in which the form type exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the form type.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe identifier of the Amazon DataZone domain in which the form type exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#DomainId-fn::getatt" }, "CreatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy`\n\nThe Amazon DataZone user who created teh metadata form type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#CreatedBy-fn::getatt" }, "Revision": { "PrimitiveType": "String", "MarkdownDocumentation": "`Revision`\n\nThe revision of the form type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#Revision-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when the metadata form type was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#CreatedAt-fn::getatt" }, "FormTypeIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`FormTypeIdentifier`\n\nThe ID of the metadata form type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#FormTypeIdentifier-fn::getatt" }, "OwningProjectId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwningProjectId`\n\nThe identifier of the project that owns the form type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#OwningProjectId-fn::getatt" } } }, "AWS::DataZone::GroupProfile": { "MarkdownDocumentation": "`AWS::DataZone::GroupProfile`\n\nThe details of a group profile in Amazon DataZone.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand `GroupProfileId` that uniquely identify the group profile. For example:\n`{ \"Ref\": \"MyGroupProfile\" }` for the resource with the logical ID\n`MyGroupProfile`, `Ref` returns\n`DomainId|GroupProfileId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of a group profile.\n*Required*: No\n*Type*: String\n*Allowed values*: `ASSIGNED | NOT_ASSIGNED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ASSIGNED", "NOT_ASSIGNED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#cfn-datazone-groupprofile-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe identifier of the Amazon DataZone domain in which a group profile exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#cfn-datazone-groupprofile-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GroupIdentifier": { "MarkdownDocumentation": "`GroupIdentifier`\n\nThe ID of the group of a project member.\n*Required*: Yes\n*Type*: String\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}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#cfn-datazone-groupprofile-groupidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupName`\n\nThe name of a group profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#GroupName-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe identifier of the Amazon DataZone domain in which a group profile exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#DomainId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of a group profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#Id-fn::getatt" } } }, "AWS::DataZone::Owner": { "MarkdownDocumentation": "`AWS::DataZone::Owner`\n\nThe owner that you want to add to the entity.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`,\n`EntityType`, `EntityId`, `OwnerType`, and\n`OwnerId`, which uniquely identifies an owner. For example: `{\n\"Ref\": \"MyOwner\" }` for the resource with the logical ID MyOwner, Ref returns\n`DomainId|EntityType|EntityId|OwnerType|OwnerId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html", "Properties": { "EntityType": { "MarkdownDocumentation": "`EntityType`\n\nThe type of an entity.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DOMAIN_UNIT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DOMAIN_UNIT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#cfn-datazone-owner-entitytype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Owner": { "MarkdownDocumentation": "`Owner`\n\nThe owner that you want to add to the entity.\n*Required*: Yes\n*Type*: [OwnerProperties](./aws-properties-datazone-owner-ownerproperties.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#cfn-datazone-owner-owner", "UpdateType": "Immutable", "Required": true, "Type": "OwnerProperties" }, "EntityIdentifier": { "MarkdownDocumentation": "`EntityIdentifier`\n\nThe ID of the entity to which you want to add an owner.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#cfn-datazone-owner-entityidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe ID of the domain in which you want to add the entity owner.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#cfn-datazone-owner-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "OwnerType": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerType`\n\nThe owner that you want to add to the entity.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#OwnerType-fn::getatt" }, "OwnerIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerIdentifier`\n\nThe ID of the entity to which you want to add an owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#OwnerIdentifier-fn::getatt" } } }, "AWS::DataZone::PolicyGrant": { "MarkdownDocumentation": "`AWS::DataZone::PolicyGrant`\n\nAdds a policy grant (an authorization policy) to a specified entity, including domain\nunits, environment blueprint configurations, or environment profiles.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the policy grant ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html", "Properties": { "EntityType": { "MarkdownDocumentation": "`EntityType`\n\nThe type of entity (resource) to which the grant is added.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DOMAIN_UNIT | ENVIRONMENT_B...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DOMAIN_UNIT", "ENVIRONMENT_BLUEPRINT_CONFIGURATION", "ENVIRONMENT_PROFILE", "ASSET_TYPE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-entitytype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyType": { "MarkdownDocumentation": "`PolicyType`\n\nThe type of policy that you want to grant.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CREATE_DOMAIN_UNIT | OVERRI...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CREATE_DOMAIN_UNIT", "OVERRIDE_DOMAIN_UNIT_OWNERS", "ADD_TO_PROJECT_MEMBER_POOL", "OVERRIDE_PROJECT_OWNERS", "CREATE_GLOSSARY", "CREATE_FORM_TYPE", "CREATE_ASSET_TYPE", "CREATE_PROJECT", "CREATE_ENVIRONMENT_PROFILE", "DELEGATE_CREATE_ENVIRONMENT_PROFILE", "CREATE_ENVIRONMENT", "CREATE_ENVIRONMENT_FROM_BLUEPRINT", "CREATE_PROJECT_FROM_PROJECT_PROFILE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-policytype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EntityIdentifier": { "MarkdownDocumentation": "`EntityIdentifier`\n\nThe ID of the entity (resource) to which you want to add a policy grant.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-entityidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Detail": { "MarkdownDocumentation": "`Detail`\n\nThe details of the policy grant member.\n*Required*: No\n*Type*: [PolicyGrantDetail](./aws-properties-datazone-policygrant-policygrantdetail.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-detail", "UpdateType": "Immutable", "Required": false, "Type": "PolicyGrantDetail" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe principal of the policy grant member.\n*Required*: No\n*Type*: [PolicyGrantPrincipal](./aws-properties-datazone-policygrant-policygrantprincipal.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-principal", "UpdateType": "Immutable", "Required": false, "Type": "PolicyGrantPrincipal" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe ID of the domain where you want to add a policy grant.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy`\n\nSpecifies the user who created the policy grant member.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#CreatedBy-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nSpecifies the timestamp at which policy grant member was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#CreatedAt-fn::getatt" }, "GrantId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#GrantId-fn::getatt" } } }, "AWS::DataZone::Project": { "MarkdownDocumentation": "`AWS::DataZone::Project`\n\nThe `AWS::DataZone::Project`resource specifies an Amazon DataZone project.\nProjects enable a group of users to collaborate on various business use cases that\ninvolve publishing, discovering, subscribing to, and consuming data in the Amazon\nDataZone catalog. Project members consume assets from the Amazon DataZone catalog and\nproduce new assets using one or more analytical workflows.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand the `ProjectId` that uniquely identify the project. For example: `{\n\"Ref\": \"MyProject\" }` for the resource with the logical ID\n`MyProject`, `Ref` returns `DomainId|ProjectId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html", "Properties": { "DomainUnitId": { "MarkdownDocumentation": "`DomainUnitId`\n\nThe ID of the domain unit. This parameter is not required and if it is not specified,\nthen the project is created at the root domain unit level.\n*Required*: No\n*Type*: String\n*Pattern*: `^[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-domainunitid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProjectProfileId": { "MarkdownDocumentation": "`ProjectProfileId`\n\nThe ID of the project profile.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-projectprofileid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UserParameters": { "MarkdownDocumentation": "`UserParameters`\n\nThe user parameters of the project.\n*Required*: No\n*Type*: Array of [EnvironmentConfigurationUserParameter](./aws-properties-datazone-project-environmentconfigurationuserparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-userparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentConfigurationUserParameter", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of a project.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GlossaryTerms": { "MarkdownDocumentation": "`GlossaryTerms`\n\nThe glossary terms that can be used in this Amazon DataZone project.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-glossaryterms", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ProjectProfileVersion": { "MarkdownDocumentation": "`ProjectProfileVersion`\n\nThe project profile version to which the project should be updated. You can only specify\nthe following string for this parameter: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-projectprofileversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a project.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w -]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe identifier of a Amazon DataZone domain where the project exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ProjectStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProjectStatus`\n\nThe status of the project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#ProjectStatus-fn::getatt" }, "CreatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy`\n\nThe Amazon DataZone user who created the project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#CreatedBy-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe identifier of a Amazon DataZone domain where the project exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#DomainId-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe timestamp of when the project was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#LastUpdatedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when a project was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of a project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#Id-fn::getatt" } } }, "AWS::DataZone::ProjectMembership": { "MarkdownDocumentation": "`AWS::DataZone::ProjectMembership`\n\nThe `AWS::DataZone::ProjectMembership` resource adds a member to an Amazon\nDataZone project. Project members consume assets from the Amazon DataZone catalog and\nproduce new assets using one or more analytical workflows.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`,\n`MemberId`, `MemberType`, and `ProjectId` that\nuniquely identify the project membership. For example: `{ \"Ref\":\n\"MyProjectMembership\" }` for the resource with the logical ID\n`MyProjectMembership`, `Ref` returns\n`DomainId|MemberId|MemberType|ProjectId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html", "Properties": { "ProjectIdentifier": { "MarkdownDocumentation": "`ProjectIdentifier`\n\nThe ID of the project for which this project membership was created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#cfn-datazone-projectmembership-projectidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Designation": { "MarkdownDocumentation": "`Designation`\n\nThe designated role of a project member.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PROJECT_OWNER | PROJECT_CON...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROJECT_OWNER", "PROJECT_CONTRIBUTOR", "PROJECT_CATALOG_VIEWER", "PROJECT_CATALOG_CONSUMER", "PROJECT_CATALOG_STEWARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#cfn-datazone-projectmembership-designation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Member": { "MarkdownDocumentation": "`Member`\n\nThe details about a project member.\n*Required*: Yes\n*Type*: [Member](./aws-properties-datazone-projectmembership-member.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#cfn-datazone-projectmembership-member", "UpdateType": "Immutable", "Required": true, "Type": "Member" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe ID of the Amazon DataZone domain in which project membership is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#cfn-datazone-projectmembership-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "MemberIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`MemberIdentifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#MemberIdentifier-fn::getatt" }, "MemberIdentifierType": { "PrimitiveType": "String", "MarkdownDocumentation": "`MemberIdentifierType`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#MemberIdentifierType-fn::getatt" } } }, "AWS::DataZone::ProjectProfile": { "MarkdownDocumentation": "`AWS::DataZone::ProjectProfile`\n\nThe summary of a project profile.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand `DomainUnitId`, which uniquely identifies a domain unit. For example: {\n`\"Ref\": \"MyDomainUnit\"` } for the resource with the logical ID\nMyDomainUnit, Ref returns `DomainId|DomainUnitId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of a project profile.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentConfigurations": { "MarkdownDocumentation": "`EnvironmentConfigurations`\n\nEnvironment configurations of a project profile.\n*Required*: No\n*Type*: Array of [EnvironmentConfiguration](./aws-properties-datazone-projectprofile-environmentconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-environmentconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EnvironmentConfiguration", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the project profile.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainUnitIdentifier": { "MarkdownDocumentation": "`DomainUnitIdentifier`\n\nA domain unit ID of the project profile.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9_\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-domainunitidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a project profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w -]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nA domain ID of the project profile.\n*Required*: No\n*Type*: String\n*Pattern*: `^dzd[_-][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-domainidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "DomainUnitId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainUnitId`\n\nThe domain unit ID of the project profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#DomainUnitId-fn::getatt" }, "CreatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy`\n\nThe user who created the project profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#CreatedBy-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe domain ID of the project profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#DomainId-fn::getatt" }, "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nProject profile ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#Identifier-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe timestamp at which a project profile was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#LastUpdatedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when the project profile was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the project profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#Id-fn::getatt" } } }, "AWS::DataZone::SubscriptionTarget": { "MarkdownDocumentation": "`AWS::DataZone::SubscriptionTarget`\n\nThe `AWS::DataZone::SubscriptionTarget`resource specifies an Amazon\nDataZone subscription target. Subscription targets enable you to access the data to\nwhich you have subscribed in your projects. A subscription target specifies the location\n(for example, a database or a schema) and the required permissions (for example, an IAM\nrole) that Amazon DataZone can use to establish a connection with the source data and to\ncreate the necessary grants so that members of the Amazon DataZone project can start\nquerying the data to which they have subscribed.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`,\n`EnvironmentId` and the `SubscriptionTargetId` that uniquely\nidentify the subscription target. For example: `{ \"Ref\": \"MySubscriptionTarget\"\n}` for the resource with the logical ID `MySubscriptionTarget`,\n`Ref` returns `DomainId|EnvironmentId|SubscriptionTargetId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the subscription target.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EnvironmentIdentifier": { "MarkdownDocumentation": "`EnvironmentIdentifier`\n\nThe ID of the environment in which subscription target is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-environmentidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ManageAccessRole": { "MarkdownDocumentation": "`ManageAccessRole`\n\nThe manage access role that is used to create the subscription 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-manageaccessrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubscriptionTargetConfig": { "MarkdownDocumentation": "`SubscriptionTargetConfig`\n\nThe configuration of the subscription target.\n*Required*: Yes\n*Type*: Array of [SubscriptionTargetForm](./aws-properties-datazone-subscriptiontarget-subscriptiontargetform.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-subscriptiontargetconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SubscriptionTargetForm", "DuplicatesAllowed": true }, "ApplicableAssetTypes": { "MarkdownDocumentation": "`ApplicableAssetTypes`\n\nThe asset types included in the subscription target.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-applicableassettypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AuthorizedPrincipals": { "MarkdownDocumentation": "`AuthorizedPrincipals`\n\nThe authorized principals included in the subscription target.\n*Required*: Yes\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-authorizedprincipals", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the subscription target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Provider": { "MarkdownDocumentation": "`Provider`\n\nThe provider of the subscription 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-provider", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe ID of the Amazon DataZone domain in which subscription target is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "UpdatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedBy`\n\nThe Amazon DataZone user who updated the subscription target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#UpdatedBy-fn::getatt" }, "EnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentId`\n\nThe identifier of the environment of the subscription target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#EnvironmentId-fn::getatt" }, "CreatedBy": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy`\n\nThe Amazon DataZone user who created the subscription target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#CreatedBy-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe identifier of the Amazon DataZone domain in which the subscription target exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#DomainId-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when the subscription target was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#CreatedAt-fn::getatt" }, "ProjectId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProjectId`\n\nThe identifier of the project specified in the subscription target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#ProjectId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of the subscription target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#Id-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp of when the subscription target was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#UpdatedAt-fn::getatt" } } }, "AWS::DataZone::UserProfile": { "MarkdownDocumentation": "`AWS::DataZone::UserProfile`\n\nThe user type of the user for which the user profile is created.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`\nand `UserProfileId` that uniquely identify the user profile. For example:\n`{ \"Ref\": \"MyUserProfile\" }` for the resource with the logical ID\n`MyUserProfile`, `Ref` returns\n`DomainId|UserProfileId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the user profile.\n*Required*: No\n*Type*: String\n*Allowed values*: `ASSIGNED | NOT_ASSIGNED | A...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ASSIGNED", "NOT_ASSIGNED", "ACTIVATED", "DEACTIVATED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#cfn-datazone-userprofile-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserIdentifier": { "MarkdownDocumentation": "`UserIdentifier`\n\nThe identifier of the user for which the user profile is created.\n*Required*: Yes\n*Type*: String\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}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#cfn-datazone-userprofile-useridentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UserType": { "MarkdownDocumentation": "`UserType`\n\nThe user type of the user for which the user profile is created.\n*Required*: No\n*Type*: String\n*Allowed values*: `IAM_USER | IAM_ROLE | SSO_U...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IAM_USER", "IAM_ROLE", "SSO_USER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#cfn-datazone-userprofile-usertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DomainIdentifier": { "MarkdownDocumentation": "`DomainIdentifier`\n\nThe identifier of a Amazon DataZone domain in which a user profile exists.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#cfn-datazone-userprofile-domainidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nThe type of the user profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Type-fn::getatt" }, "Details.Sso": { "Type": "SsoUserProfileDetails", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Details.Sso-fn::getatt" }, "Details": { "Type": "UserProfileDetails", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Details-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe identifier of a Amazon DataZone domain in which a user profile exists.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#DomainId-fn::getatt" }, "Details.Sso.FirstName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Details.Sso.FirstName-fn::getatt" }, "Details.Iam": { "Type": "IamUserProfileDetails", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Details.Iam-fn::getatt" }, "Details.Sso.Username": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Details.Sso.Username-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the user profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Id-fn::getatt" }, "Details.Sso.LastName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Details.Sso.LastName-fn::getatt" }, "Details.Iam.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#Details.Iam.Arn-fn::getatt" } } }, "AWS::Deadline::Farm": { "MarkdownDocumentation": "`AWS::Deadline::Farm`\n\nCreates a farm to allow space for queues and fleets. Farms are the space where the\ncomponents of your renders gather and are pieced together in the cloud. Farms contain\nbudgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for\nlarge projects.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the farm.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the farm that helps identify what the farm is used for.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it\non a webpage or any other system that might interpret the content of this field.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN for the KMS key.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[-a-z]*:kms:.*:key/.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the farm.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-deadline-farm-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) assigned to the farm.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#Arn-fn::getatt" }, "FarmId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FarmId`\n\nThe farm ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#FarmId-fn::getatt" } } }, "AWS::Deadline::Fleet": { "MarkdownDocumentation": "`AWS::Deadline::Fleet`\n\nCreates a fleet. Fleets gather information relating to compute, or capacity, for renders\nwithin your farms. You can choose to manage your own capacity or opt to have fleets fully\nmanaged by Deadline Cloud.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the fleet.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description that helps identify what the fleet is used for.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it\non a webpage or any other system that might interpret the content of this field.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration details for the fleet.\n*Required*: Yes\n*Type*: [FleetConfiguration](./aws-properties-deadline-fleet-fleetconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-configuration", "UpdateType": "Mutable", "Required": true, "Type": "FleetConfiguration" }, "HostConfiguration": { "MarkdownDocumentation": "`HostConfiguration`\n\nProvides a script that runs as a worker is starting up that you can use to provide\nadditional configuration for workers in your fleet.\nTo remove a script from a fleet, use the [UpdateFleet](https://docs.aws.amazon.com/deadline-cloud/latest/APIReference/API_UpdateFleet.html)\noperation with the `hostConfiguration``scriptBody` parameter set to an empty string (\"\").\n*Required*: No\n*Type*: [HostConfiguration](./aws-properties-deadline-fleet-hostconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-hostconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HostConfiguration" }, "MaxWorkerCount": { "MarkdownDocumentation": "`MaxWorkerCount`\n\nThe maximum number of workers specified in the fleet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-maxworkercount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the fleet summary to update.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MinWorkerCount": { "MarkdownDocumentation": "`MinWorkerCount`\n\nThe minimum number of workers in the fleet.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-minworkercount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "FarmId": { "MarkdownDocumentation": "`FarmId`\n\nThe farm ID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^farm-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-farmid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role that workers in the fleet use when processing jobs.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to your fleet. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-deadline-fleet-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#Status-fn::getatt" }, "Capabilities.Amounts": { "Type": "List", "ItemType": "FleetAmountCapability", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#Capabilities.Amounts-fn::getatt" }, "Capabilities.Attributes": { "Type": "List", "ItemType": "FleetAttributeCapability", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#Capabilities.Attributes-fn::getatt" }, "Capabilities": { "Type": "FleetCapabilities", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#Capabilities-fn::getatt" }, "FleetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FleetId`\n\nThe fleet ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#FleetId-fn::getatt" }, "WorkerCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`WorkerCount`\n\nThe number of workers in the fleet summary.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#WorkerCount-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) assigned to the fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#Arn-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nA message that communicates a suspended status of the fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#StatusMessage-fn::getatt" } } }, "AWS::Deadline::LicenseEndpoint": { "MarkdownDocumentation": "`AWS::Deadline::LicenseEndpoint`\n\nCreates a license endpoint to integrate your various licensed software used for\nrendering on Deadline Cloud.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the license endpoint.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe VPC (virtual private cloud) ID associated with the license endpoint.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#cfn-deadline-licenseendpoint-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe identifier of the Amazon EC2 security group that controls access to the\nlicense endpoint.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#cfn-deadline-licenseendpoint-securitygroupids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nIdentifies the VPC subnets that can connect to a license endpoint.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `32 | 10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#cfn-deadline-licenseendpoint-subnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to your license endpoint. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-deadline-licenseendpoint-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#cfn-deadline-licenseendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the license endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#Status-fn::getatt" }, "DnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DnsName`\n\nThe DNS name of the license server endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#DnsName-fn::getatt" }, "LicenseEndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LicenseEndpointId`\n\nThe license endpoint ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#LicenseEndpointId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the license endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#Arn-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nThe status message of the license endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#StatusMessage-fn::getatt" } } }, "AWS::Deadline::Limit": { "MarkdownDocumentation": "`AWS::Deadline::Limit`\n\nCreates a limit that manages the distribution of shared resources, such as floating\nlicenses. A limit can throttle work assignments, help manage workloads, and track current\nusage. Before you use a limit, you must associate the limit with one or more queues.\nYou must add the `amountRequirementName` to a step in a job template to\ndeclare the limit requirement.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier of the limit.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the limit. A clear description helps you identify the purpose of the\nlimit.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it\non a webpage or any other system that might interpret the content of this field.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#cfn-deadline-limit-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AmountRequirementName": { "MarkdownDocumentation": "`AmountRequirementName`\n\nThe value that you specify as the `name` in the `amounts` field of\nthe `hostRequirements` in a step of a job template to declare the limit\nrequirement.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#cfn-deadline-limit-amountrequirementname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe name of the limit used in lists to identify the limit.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#cfn-deadline-limit-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MaxCount": { "MarkdownDocumentation": "`MaxCount`\n\nThe maximum number of resources constrained by this limit. When all of the resources are\nin use, steps that require the limit won't be scheduled until the resource is\navailable.\nThe `maxValue` must not be 0. If the value is -1, there is no restriction on\nthe number of resources that can be acquired for this limit.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#cfn-deadline-limit-maxcount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "FarmId": { "MarkdownDocumentation": "`FarmId`\n\nThe unique identifier of the farm that contains the limit.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^farm-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#cfn-deadline-limit-farmid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "LimitId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LimitId`\n\nThe unique identifier of the limit.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#LimitId-fn::getatt" }, "CurrentCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`CurrentCount`\n\nThe number of resources from the limit that are being used by jobs. The result is\ndelayed and may not be the count at the time that you called the operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-limit.html#CurrentCount-fn::getatt" } } }, "AWS::Deadline::MeteredProduct": { "MarkdownDocumentation": "`AWS::Deadline::MeteredProduct`\n\nAdds a metered product.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the metered product.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html", "Properties": { "LicenseEndpointId": { "MarkdownDocumentation": "`LicenseEndpointId`\n\nThe Amazon EC2 identifier of the license endpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `^le-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#cfn-deadline-meteredproduct-licenseendpointid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ProductId": { "MarkdownDocumentation": "`ProductId`\n\nThe product ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-z]{1,32}-[.0-9a-z]{1,32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#cfn-deadline-meteredproduct-productid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Port": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Port`\n\nThe port on which the metered product should run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#Port-fn::getatt" }, "Family": { "PrimitiveType": "String", "MarkdownDocumentation": "`Family`\n\nThe family to which the metered product belongs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#Family-fn::getatt" }, "Vendor": { "PrimitiveType": "String", "MarkdownDocumentation": "`Vendor`\n\nThe vendor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#Vendor-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the metered product.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#Arn-fn::getatt" } } }, "AWS::Deadline::Monitor": { "MarkdownDocumentation": "`AWS::Deadline::Monitor`\n\nCreates an AWS Deadline Cloud monitor that you can use to view your farms, queues, and\nfleets. After you submit a job, you can track the progress of the tasks and steps that make\nup the job, and then download the job's results.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html", "Properties": { "IdentityCenterInstanceArn": { "MarkdownDocumentation": "`IdentityCenterInstanceArn`\n\nThe Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-identitycenterinstancearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Subdomain": { "MarkdownDocumentation": "`Subdomain`\n\nThe subdomain used for the monitor URL. The full URL of the monitor is\nsubdomain.Region.deadlinecloud.amazonaws.com.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9-]{1,100}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-subdomain", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe name of the monitor that displays on the Deadline Cloud console.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to\naccess Deadline Cloud resources.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-deadline-monitor-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "IdentityCenterApplicationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdentityCenterApplicationArn`\n\nThe Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#IdentityCenterApplicationArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the monitor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#Arn-fn::getatt" }, "MonitorId": { "PrimitiveType": "String", "MarkdownDocumentation": "`MonitorId`\n\nThe unique identifier for the monitor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#MonitorId-fn::getatt" }, "Url": { "PrimitiveType": "String", "MarkdownDocumentation": "`Url`\n\nThe complete URL of the monitor. The full URL of the monitor is\nsubdomain.Region.deadlinecloud.amazonaws.com.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#Url-fn::getatt" } } }, "AWS::Deadline::Queue": { "MarkdownDocumentation": "`AWS::Deadline::Queue`\n\nCreates a queue to coordinate the order in which jobs run on a farm. A queue can also\nspecify where to pull resources and indicate where to output completed jobs.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the specified queue.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html", "Properties": { "JobRunAsUser": { "MarkdownDocumentation": "`JobRunAsUser`\n\nIdentifies the user for a job.\n*Required*: No\n*Type*: [JobRunAsUser](./aws-properties-deadline-queue-jobrunasuser.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-jobrunasuser", "UpdateType": "Mutable", "Required": false, "Type": "JobRunAsUser" }, "AllowedStorageProfileIds": { "MarkdownDocumentation": "`AllowedStorageProfileIds`\n\nThe identifiers of the storage profiles that this queue can use to share assets between\nworkers using different operating systems.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-allowedstorageprofileids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the queue that helps identify what the queue is used for.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it\non a webpage or any other system that might interpret the content of this field.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JobAttachmentSettings": { "MarkdownDocumentation": "`JobAttachmentSettings`\n\nThe job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.\n*Required*: No\n*Type*: [JobAttachmentSettings](./aws-properties-deadline-queue-jobattachmentsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-jobattachmentsettings", "UpdateType": "Mutable", "Required": false, "Type": "JobAttachmentSettings" }, "DefaultBudgetAction": { "MarkdownDocumentation": "`DefaultBudgetAction`\n\nThe default action taken on a queue summary if a budget wasn't configured.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | STOP_SCHEDULING_AND_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "STOP_SCHEDULING_AND_COMPLETE_TASKS", "STOP_SCHEDULING_AND_CANCEL_TASKS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-defaultbudgetaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the queue summary to update.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RequiredFileSystemLocationNames": { "MarkdownDocumentation": "`RequiredFileSystemLocationNames`\n\nThe file system location that the queue uses.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `64 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-requiredfilesystemlocationnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "FarmId": { "MarkdownDocumentation": "`FarmId`\n\nThe farm ID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^farm-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-farmid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that workers use when\nrunning jobs in this queue.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to your queue. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-deadline-queue-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "QueueId": { "PrimitiveType": "String", "MarkdownDocumentation": "`QueueId`\n\nThe queue ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#QueueId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#Arn-fn::getatt" } } }, "AWS::Deadline::QueueEnvironment": { "MarkdownDocumentation": "`AWS::Deadline::QueueEnvironment`\n\nCreates an environment for a queue that defines how jobs in the queue run.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a reference to a queue environment object.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html", "Properties": { "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe queue environment's priority.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "QueueId": { "MarkdownDocumentation": "`QueueId`\n\nThe unique identifier of the queue that contains the environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^queue-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-queueid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TemplateType": { "MarkdownDocumentation": "`TemplateType`\n\nSpecifies whether the template for the queue environment is JSON or YAML.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `JSON | YAML...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "JSON", "YAML" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-templatetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FarmId": { "MarkdownDocumentation": "`FarmId`\n\nThe identifier assigned to the farm that contains the queue.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^farm-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-farmid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Template": { "MarkdownDocumentation": "`Template`\n\nA JSON or YAML template that describes the processing environment for the queue.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `15000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-template", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "QueueEnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`QueueEnvironmentId`\n\nThe queue environment ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#QueueEnvironmentId-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the queue environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#Name-fn::getatt" } } }, "AWS::Deadline::QueueFleetAssociation": { "MarkdownDocumentation": "`AWS::Deadline::QueueFleetAssociation`\n\nCreates an association between a queue and a fleet.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the queue fleet\nassociations.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuefleetassociation.html", "Properties": { "FleetId": { "MarkdownDocumentation": "`FleetId`\n\nThe fleet ID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^fleet-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuefleetassociation.html#cfn-deadline-queuefleetassociation-fleetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "QueueId": { "MarkdownDocumentation": "`QueueId`\n\nThe queue ID.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^queue-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuefleetassociation.html#cfn-deadline-queuefleetassociation-queueid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FarmId": { "MarkdownDocumentation": "`FarmId`\n\nThe identifier of the farm that contains the queue and the fleet.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^farm-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuefleetassociation.html#cfn-deadline-queuefleetassociation-farmid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::QueueLimitAssociation": { "MarkdownDocumentation": "`AWS::Deadline::QueueLimitAssociation`\n\nAssociates a limit with a particular queue. After the limit is associated, all workers\nfor jobs that specify the limit associated with the queue are subject to the limit. You\ncan't associate two limits with the same `amountRequirementName` to the same\nqueue.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier for the queue-limit association.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuelimitassociation.html", "Properties": { "LimitId": { "MarkdownDocumentation": "`LimitId`\n\nThe unique identifier of the limit in the association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^limit-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuelimitassociation.html#cfn-deadline-queuelimitassociation-limitid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "QueueId": { "MarkdownDocumentation": "`QueueId`\n\nThe unique identifier of the queue in the association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^queue-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuelimitassociation.html#cfn-deadline-queuelimitassociation-queueid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FarmId": { "MarkdownDocumentation": "`FarmId`\n\nThe unique identifier of the farm that contains the queue-limit association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^farm-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuelimitassociation.html#cfn-deadline-queuelimitassociation-farmid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Deadline::StorageProfile": { "MarkdownDocumentation": "`AWS::Deadline::StorageProfile`\n\nCreates a storage profile that specifies the operating system, file type, and file\nlocation of resources used on a farm.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the storage profile.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html", "Properties": { "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the storage profile summary to update.\n###### Important\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#cfn-deadline-storageprofile-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FileSystemLocations": { "MarkdownDocumentation": "`FileSystemLocations`\n\nOperating system specific file system path to the storage location.\n*Required*: No\n*Type*: Array of [FileSystemLocation](./aws-properties-deadline-storageprofile-filesystemlocation.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#cfn-deadline-storageprofile-filesystemlocations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FileSystemLocation", "DuplicatesAllowed": true }, "FarmId": { "MarkdownDocumentation": "`FarmId`\n\nThe unique identifier of the farm that contains the storage profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^farm-[0-9a-f]{32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#cfn-deadline-storageprofile-farmid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OsFamily": { "MarkdownDocumentation": "`OsFamily`\n\nThe operating system (OS) family.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `WINDOWS | LINUX | MACOS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS", "LINUX", "MACOS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#cfn-deadline-storageprofile-osfamily", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "StorageProfileId": { "PrimitiveType": "String", "MarkdownDocumentation": "`StorageProfileId`\n\nThe storage profile ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#StorageProfileId-fn::getatt" } } }, "AWS::Detective::Graph": { "MarkdownDocumentation": "`AWS::Detective::Graph`\n\nThe `AWS::Detective::Graph` resource is an Amazon Detective resource type\nthat creates a Detective behavior graph. The requesting account becomes the\nadministrator account for the behavior graph.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the new behavior graph.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-graph.html", "Properties": { "AutoEnableMembers": { "MarkdownDocumentation": "`AutoEnableMembers`\n\nIndicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.\nBy default, this property is set to `false`. If you want to change the value of this property, you must be the\nDetective administrator for the organization. For more information on setting a Detective administrator account,\nsee [AWS::Detective::OrganizationAdmin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-organizationadmin.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-graph.html#cfn-detective-graph-autoenablemembers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tag values to assign to the new behavior graph.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-detective-graph-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-graph.html#cfn-detective-graph-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the new behavior graph.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-graph.html#Arn-fn::getatt" } } }, "AWS::Detective::MemberInvitation": { "MarkdownDocumentation": "`AWS::Detective::MemberInvitation`\n\nThe `AWS::Detective::MemberInvitation` resource is an Amazon Detective\nresource type that creates an invitation to join a Detective behavior graph. The\nadministrator account can choose whether to send an email notification of the invitation\nto the root user email address of the AWS account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the behavior graph and the member account\nidentifier, separated by a pipe character ('|').\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html", "Properties": { "MemberId": { "MarkdownDocumentation": "`MemberId`\n\nThe AWS account identifier of the invited account\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-memberid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nCustomized text to include in the invitation email message.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GraphArn": { "MarkdownDocumentation": "`GraphArn`\n\nThe ARN of the behavior graph to invite the account to contribute data to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws(-[\\w]+)*:detective:(([a-z]+-)+[0-9]+):[0-9]{12}:graph:[0-9a-f]{32}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-grapharn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DisableEmailNotification": { "MarkdownDocumentation": "`DisableEmailNotification`\n\nWhether to send an invitation email to the member account. If set to true, the member account does not receive an invitation email.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-disableemailnotification", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MemberEmailAddress": { "MarkdownDocumentation": "`MemberEmailAddress`\n\nThe root user email address of the invited account. If the email address provided is\nnot the root user email address for the provided account, the invitation creation\nfails.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-memberemailaddress", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Detective::OrganizationAdmin": { "MarkdownDocumentation": "`AWS::Detective::OrganizationAdmin`\n\nThe `AWS::Detective::OrganizationAdmin` resource is an Amazon Detective resource type that\ndesignates the Detective administrator account for the organization in the current region.\nIf the account does not have Detective enabled, then this resource enables Detective\nfor that account and creates a new behavior graph.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the behavior graph and the member account\nidentifier, separated by a pipe character ('|').\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-organizationadmin.html", "Properties": { "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThe AWS account identifier of the account to designate as the Detective administrator account for the organization.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-organizationadmin.html#cfn-detective-organizationadmin-accountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GraphArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GraphArn`\n\nThe ARN of the behavior graph to invite the account to contribute data to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-organizationadmin.html#GraphArn-fn::getatt" } } }, "AWS::DevOpsGuru::LogAnomalyDetectionIntegration": { "MarkdownDocumentation": "`AWS::DevOpsGuru::LogAnomalyDetectionIntegration`\n\nInformation about the integration of DevOps Guru with CloudWatch log groups for log anomaly detection.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function,\n`Ref` returns the user account ID.\nFor more information about using the `Ref` function, see\n[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-loganomalydetectionintegration.html", "Properties": {}, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe account ID associated with the integration of DevOps Guru with CloudWatch log groups for log anomaly detection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-loganomalydetectionintegration.html#AccountId-fn::getatt" } } }, "AWS::DevOpsGuru::NotificationChannel": { "MarkdownDocumentation": "`AWS::DevOpsGuru::NotificationChannel`\n\nAdds a notification channel to DevOps Guru. A notification channel is used to notify you\nabout important DevOps Guru events, such as when an insight is generated.\nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission\nto send 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.\nFor more information, see [Permissions\nfor Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html).\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\nto the CMK. For more information, see [Permissions for\nAWS KMS\u2013encrypted Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function,\n`Ref` returns Amazon Resource Name (ARN) of the `NotificationChannel`.\nFor more information about using the `Ref` function, see\n[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-notificationchannel.html", "Properties": { "Config": { "MarkdownDocumentation": "`Config`\n\nA `NotificationChannelConfig` object that contains information about\nconfigured notification channels.\n*Required*: Yes\n*Type*: [NotificationChannelConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-notificationchannel.html#cfn-devopsguru-notificationchannel-config", "UpdateType": "Immutable", "Required": true, "Type": "NotificationChannelConfig" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the notification channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-notificationchannel.html#Id-fn::getatt" } } }, "AWS::DevOpsGuru::ResourceCollection": { "MarkdownDocumentation": "`AWS::DevOpsGuru::ResourceCollection`\n\nA collection of AWS resources supported by DevOps Guru. The one type of AWS resource\ncollection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze\nonly the AWS resources that are defined in the stacks.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function,\n`Ref` returns Amazon Resource Name (ARN) of the `ResourceCollection`.\nFor more information about using the `Ref` function, see\n[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-resourcecollection.html", "Properties": { "ResourceCollectionFilter": { "MarkdownDocumentation": "`ResourceCollectionFilter`\n\nInformation about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.\n*Required*: Yes\n*Type*: [ResourceCollectionFilter](./aws-properties-devopsguru-resourcecollection-resourcecollectionfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-resourcecollection.html#cfn-devopsguru-resourcecollection-resourcecollectionfilter", "UpdateType": "Mutable", "Required": true, "Type": "ResourceCollectionFilter" } }, "Attributes": { "ResourceCollectionType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceCollectionType`\n\nThe type of AWS resource collections to return. The one valid value is `CLOUD_FORMATION` for AWS CloudFormation stacks.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-resourcecollection.html#ResourceCollectionType-fn::getatt" } } }, "AWS::DirectoryService::MicrosoftAD": { "Attributes": { "Alias": { "PrimitiveType": "String", "MarkdownDocumentation": "`Alias`\n\nThe alias for a directory. For example: `alias4-mydirectory-12345abcgmzsk` (if\nyou have the `CreateAlias` property set to true).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#Alias-fn::getatt" }, "DnsIpAddresses": { "PrimitiveItemType": "String", "Type": "List", "MarkdownDocumentation": "`DnsIpAddresses`\n\nThe IP addresses of the DNS servers for the directory, such as `[ \"192.0.2.1\",\n\"192.0.2.2\" ]`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#DnsIpAddresses-fn::getatt" } }, "MarkdownDocumentation": "`AWS::DirectoryService::MicrosoftAD`\n\nThe `AWS::DirectoryService::MicrosoftAD` resource specifies a Microsoft Active\nDirectory in AWS so that your directory users and groups can access the\nAWS Management Console and AWS applications using their existing\ncredentials. For more information, see [AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) in the *Directory Service Admin Guide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic\nfunction, `Ref` returns the resource ID.\nIn the following sample, the `Ref` function returns the ID of the\n`myDirectory` directory, such as `d-12345ab592`.\n`{ \"Ref\": \"myDirectory\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html", "Properties": { "CreateAlias": { "MarkdownDocumentation": "`CreateAlias`\n\nSpecifies an alias for a directory and assigns the alias to the directory. The alias is\nused to construct the access URL for the directory, such as\n`http://.awsapps.com`. By default, CloudFormation does not\ncreate an alias.\n###### Important\nAfter an alias has been created, it cannot be deleted or reused, so this operation\nshould only be used when absolutely necessary.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-createalias", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" }, "Edition": { "MarkdownDocumentation": "`Edition`\n\nAWS Managed Microsoft AD is available in two editions: `Standard` and\n`Enterprise`. `Enterprise` is the default.\n*Required*: No\n*Type*: String\n*Allowed values*: `Enterprise | Standard | Hyb...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Enterprise", "Standard", "Hybrid" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-edition", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EnableSso": { "MarkdownDocumentation": "`EnableSso`\n\nWhether to enable single sign-on for a Microsoft Active Directory in AWS.\nSingle sign-on allows users in your directory to access certain AWS services\nfrom a computer joined to the directory without having to enter their credentials separately.\nIf you don't specify a value, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-enablesso", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe fully qualified domain name for the AWS Managed Microsoft AD directory, such as\n`corp.example.com`. This name will resolve inside your VPC only. It does not need\nto be publicly resolvable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password for the default administrative user named `Admin`.\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 *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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-password", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "ShortName": { "MarkdownDocumentation": "`ShortName`\n\nThe NetBIOS name for your domain, such as `CORP`. If you don't specify a\nNetBIOS name, it will default to the first part of your directory DNS. For example,\n`CORP` for the directory DNS `corp.example.com`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-shortname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "VpcSettings": { "MarkdownDocumentation": "`VpcSettings`\n\nSpecifies the VPC settings of the Microsoft AD directory server in AWS.\n*Required*: Yes\n*Type*: [VpcSettings](./aws-properties-directoryservice-microsoftad-vpcsettings.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-vpcsettings", "Required": true, "Type": "VpcSettings", "UpdateType": "Immutable" } } }, "AWS::DirectoryService::SimpleAD": { "Attributes": { "Alias": { "PrimitiveType": "String", "MarkdownDocumentation": "`Alias`\n\nThe alias for a directory. For example: `alias4-mydirectory-12345abcgmzsk` (if\nyou have the `CreateAlias` property set to true).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#Alias-fn::getatt" }, "DnsIpAddresses": { "PrimitiveItemType": "String", "Type": "List", "MarkdownDocumentation": "`DnsIpAddresses`\n\nThe IP addresses of the DNS servers for the directory, such as `[ \"172.31.3.154\",\n\"172.31.63.203\" ]`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#DnsIpAddresses-fn::getatt" } }, "MarkdownDocumentation": "`AWS::DirectoryService::SimpleAD`\n\nThe `AWS::DirectoryService::SimpleAD` resource specifies an Directory Service Simple Active Directory (Simple AD) in AWS so that your\ndirectory users and groups can access the AWS Management Console and AWS\napplications using their existing credentials. Simple AD is a Microsoft\nActive Directory\u2013compatible directory. For more information, see [Simple Active\nDirectory](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the *Directory Service Admin Guide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic\nfunction, `Ref` returns the resource ID.\nIn the following sample, the `Ref` function returns the ID of the\n`myDirectory` directory, such as `d-1a2b3c4d5e`.\n`{ \"Ref\": \"myDirectory\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html", "Properties": { "CreateAlias": { "MarkdownDocumentation": "`CreateAlias`\n\nIf set to `true`, specifies an alias for a directory and assigns the alias to\nthe directory. The alias is used to construct the access URL for the directory, such as\n`http://.awsapps.com`. By default, this property is set to\n`false`.\n###### Important\nAfter an alias has been created, it cannot be deleted or reused, so this operation\nshould only be used when absolutely necessary.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-createalias", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the directory.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EnableSso": { "MarkdownDocumentation": "`EnableSso`\n\nWhether to enable single sign-on for a directory. If you don't specify a value, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-enablesso", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password for the directory administrator. The directory creation process creates a\ndirectory administrator account with the user name `Administrator` and this\npassword.\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 *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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-password", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "ShortName": { "MarkdownDocumentation": "`ShortName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-shortname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size of the directory. For valid values, see [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in\nthe *Directory Service API Reference*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Small | Large...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Small", "Large" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-size", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "VpcSettings": { "MarkdownDocumentation": "`VpcSettings`\n\nA [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the\noperation.\n*Required*: Yes\n*Type*: [VpcSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-vpcsettings", "Required": true, "Type": "VpcSettings", "UpdateType": "Immutable" } } }, "AWS::DocDB::DBCluster": { "MarkdownDocumentation": "`AWS::DocDB::DBCluster`\n\nThe `AWS::DocDB::DBCluster`Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster.\nAmazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see\n[DBCluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBCluster.html) in the *Amazon DocumentDB Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DBClusterIdentifier, such as `mycluster`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html", "Attributes": { "ClusterResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterResourceId`\n\nThe resource id for the cluster; for example: `cluster-ABCD1234EFGH5678IJKL90MNOP`.\nThe cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#ClusterResourceId-fn::getatt" }, "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe connection endpoint for the cluster, such as\n`sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#Endpoint-fn::getatt" }, "Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`Port`\n\nThe port number on which the cluster accepts connections. For example: `27017`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#Port-fn::getatt" }, "ReadEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReadEndpoint`\n\nThe reader endpoint for the cluster. For example: `sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#ReadEndpoint-fn::getatt" } }, "Properties": { "StorageEncrypted": { "Required": false, "MarkdownDocumentation": "`StorageEncrypted`\n\nSpecifies whether the cluster is encrypted.\nIf you specify `SourceDBClusterIdentifier` or `SnapshotIdentifier` and don\u2019t specify `StorageEncrypted`, the encryption property is inherited from the source cluster or snapshot (unless `KMSKeyId` is specified, in which case the restored cluster will be encrypted with that KMS key).\nIf the source is encrypted and `StorageEncrypted` is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the `KMSKeyId` property as well).\nIf the source is unencrypted and `StorageEncrypted` is specified to be true, then the `KMSKeyId` property must be specified.\nIf the source is encrypted, don\u2019t specify `StorageEncrypted` to be false as opting out of encryption is not allowed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "RestoreToTime": { "Required": false, "MarkdownDocumentation": "`RestoreToTime`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretotime", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SnapshotIdentifier": { "Required": false, "MarkdownDocumentation": "`SnapshotIdentifier`\n\nThe 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\nsnapshot. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-snapshotidentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Port": { "Required": false, "MarkdownDocumentation": "`Port`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-port", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DBClusterIdentifier": { "Required": false, "MarkdownDocumentation": "`DBClusterIdentifier`\n\nThe cluster identifier. This parameter is stored as a lowercase\nstring.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusteridentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "PreferredBackupWindow": { "Required": false, "MarkdownDocumentation": "`PreferredBackupWindow`\n\nThe daily time range during which automated backups are created if\nautomated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredbackupwindow", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RotateMasterUserPassword": { "Required": false, "MarkdownDocumentation": "`RotateMasterUserPassword`\n\nSpecifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.\nThis setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster.\nThe secret value contains the updated password.\nConstraint: You must apply the change immediately when rotating the master user 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-rotatemasteruserpassword", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "VpcSecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nA list of EC2 VPC security groups to associate with this cluster.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-vpcsecuritygroupids", "UpdateType": "Mutable" }, "NetworkType": { "Required": false, "MarkdownDocumentation": "`NetworkType`\n\nThe network type of the cluster.\nThe network type is determined by the `DBSubnetGroup` specified for the cluster.\nA `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).\nFor more information, see [DocumentDB clusters in a VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) in the Amazon DocumentDB Developer Guide.\nValid Values: `IPV4` | `DUAL`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-networktype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CopyTagsToSnapshot": { "Required": false, "MarkdownDocumentation": "`CopyTagsToSnapshot`\n\nSet to `true` to copy all tags from the source cluster\nsnapshot to the target cluster snapshot, and otherwise\n`false`. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-copytagstosnapshot", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "GlobalClusterIdentifier": { "Required": false, "MarkdownDocumentation": "`GlobalClusterIdentifier`\n\nThe cluster identifier of the new global cluster.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Za-z][0-9A-Za-z-:._]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-globalclusteridentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RestoreType": { "Required": false, "MarkdownDocumentation": "`RestoreType`\n\nThe 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\n source DB cluster.\n* `copy-on-write` - The new DB cluster is restored as a clone of the\n 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\nrestored 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to be assigned to the cluster.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-docdb-dbcluster-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "EngineVersion": { "Required": false, "MarkdownDocumentation": "`EngineVersion`\n\nThe version number of the database engine to use. The `--engine-version` will default to the latest major engine version.\nFor production workloads, we recommend explicitly declaring this parameter with the intended major engine version.\nIf you intend to trigger an in-place upgrade, please refer to [Amazon DocumentDB in-place major version upgrade](https://docs.aws.amazon.com/documentdb/latest/developerguide/docdb-mvu.html).\nNote that for an in-place engine version upgrade, you need to remove other cluster properties changes (e.g. SecurityGroupId) from the CFN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-engineversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "StorageType": { "Required": false, "MarkdownDocumentation": "`StorageType`\n\nThe storage type to associate with the DB cluster.\nFor information on storage types for Amazon DocumentDB clusters, see\nCluster storage configurations in the *Amazon DocumentDB Developer Guide*.\nValid values for storage type - `standard | iopt1`\nDefault value is `standard` \n###### Note\nWhen you create an Amazon DocumentDB cluster with the storage type set to `iopt1`, the storage type is returned\nin the response. The storage type isn't returned when you set it to `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storagetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS KMS key identifier for an encrypted cluster.\nThe AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.\nIf an encryption key is not specified in `KmsKeyId`:\n* If the `StorageEncrypted` parameter is\n `true`, Amazon DocumentDB 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 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-kmskeyid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AvailabilityZones": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AvailabilityZones`\n\nA list of Amazon EC2 Availability Zones that instances in the\ncluster can be created in.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-availabilityzones", "UpdateType": "Immutable" }, "ServerlessV2ScalingConfiguration": { "Type": "ServerlessV2ScalingConfiguration", "Required": false, "MarkdownDocumentation": "`ServerlessV2ScalingConfiguration`\n\nContains the scaling configuration of an Amazon DocumentDB Serverless cluster.\n*Required*: No\n*Type*: [ServerlessV2ScalingConfiguration](./aws-properties-docdb-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration", "UpdateType": "Mutable" }, "PreferredMaintenanceWindow": { "Required": false, "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe weekly time range during which system maintenance can occur,\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredmaintenancewindow", "PrimitiveType": "String", "UpdateType": "Mutable" }, "MasterUserSecretKmsKeyId": { "Required": false, "MarkdownDocumentation": "`MasterUserSecretKmsKeyId`\n\nThe Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.\nThis setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\nTo use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.\nIf you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret.\nIf the secret is in a different Amazon Web Services account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.\nThere is a default KMS key for your Amazon Web Services account.\nYour Amazon Web Services account has a different default KMS key for each Amazon Web Services 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusersecretkmskeyid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DBSubnetGroupName": { "Required": false, "MarkdownDocumentation": "`DBSubnetGroupName`\n\nA subnet group to associate with this cluster.\nConstraints: Must match the name of an existing\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbsubnetgroupname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DeletionProtection": { "Required": false, "MarkdownDocumentation": "`DeletionProtection`\n\nProtects clusters from being accidentally deleted. If enabled, the\ncluster cannot be deleted unless it is modified and\n`DeletionProtection` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-deletionprotection", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "UseLatestRestorableTime": { "Required": false, "MarkdownDocumentation": "`UseLatestRestorableTime`\n\nA value that is set to `true` to restore the cluster to the latest\nrestorable backup time, and `false` otherwise.\nDefault: `false`\nConstraints: Cannot be specified if the `RestoreToTime` parameter is\nprovided.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-uselatestrestorabletime", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ManageMasterUserPassword": { "Required": false, "MarkdownDocumentation": "`ManageMasterUserPassword`\n\nSpecifies whether to manage the master user password with Amazon Web Services Secrets Manager.\nConstraint: You can't manage the master user password with Amazon Web Services 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-managemasteruserpassword", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "MasterUserPassword": { "Required": false, "MarkdownDocumentation": "`MasterUserPassword`\n\nThe password for the master database user. This password can\ncontain any printable ASCII character except forward slash (/),\ndouble quote (\"), or the \"at\" symbol (@).\nConstraints: Must contain from 8 to 100 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masteruserpassword", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SourceDBClusterIdentifier": { "Required": false, "MarkdownDocumentation": "`SourceDBClusterIdentifier`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-sourcedbclusteridentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MasterUsername": { "Required": false, "MarkdownDocumentation": "`MasterUsername`\n\nThe name of the master user for the cluster.\nConstraints:\n* Must be from 1 to 63 letters or numbers.\n* The first character must be a letter.\n* Cannot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusername", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DBClusterParameterGroupName": { "Required": false, "MarkdownDocumentation": "`DBClusterParameterGroupName`\n\nThe name of the cluster parameter group to associate with this\ncluster.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusterparametergroupname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "BackupRetentionPeriod": { "Required": false, "MarkdownDocumentation": "`BackupRetentionPeriod`\n\nThe number of days for which automated backups are retained. You\nmust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-backupretentionperiod", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "EnableCloudwatchLogsExports": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`EnableCloudwatchLogsExports`\n\nThe list of log types that need to be enabled for exporting to Amazon CloudWatch\nLogs. You can enable audit logs or profiler logs. For more information, see\n[Auditing Amazon DocumentDB Events](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)\nand [Profiling Amazon DocumentDB Operations](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-enablecloudwatchlogsexports", "UpdateType": "Mutable" } } }, "AWS::DocDB::DBClusterParameterGroup": { "MarkdownDocumentation": "`AWS::DocDB::DBClusterParameterGroup`\n\nThe `AWS::DocDB::DBClusterParameterGroup`Amazon DocumentDB (with MongoDB compatibility) resource describes a DBClusterParameterGroup.\nFor more information, see [DBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html)\nin the *Amazon DocumentDB Developer Guide*.\nParameters in a cluster parameter group apply to all of the instances in a cluster.\nA cluster parameter group is initially created with the default parameters for the\ndatabase engine used by instances in the cluster. To provide custom values for any of\nthe parameters, you must modify the group after you create it. After you create a DB\ncluster parameter group, you must associate it with your cluster. For the new cluster\nparameter group and associated settings to take effect, you must then reboot the DB\ninstances in the cluster without failover.\n###### Important\nAfter you create a cluster parameter group, you should wait at least 5 minutes\nbefore creating your first cluster that uses that cluster parameter group as the\ndefault parameter group. This allows Amazon DocumentDB to fully complete the create action\nbefore the cluster parameter group is used as the default for a new cluster. This\nstep is especially important for parameters that are critical when creating the default\ndatabase for a cluster, such as the character set for the default database defined by\nthe `character_set_database` parameter.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DBClusterParameterGroup's name, such as `sample-db-cluster-param-group`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html", "Properties": { "Description": { "Required": true, "MarkdownDocumentation": "`Description`\n\nThe description for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-description", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Parameters": { "Required": true, "MarkdownDocumentation": "`Parameters`\n\nProvides a list of parameters for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Family": { "Required": true, "MarkdownDocumentation": "`Family`\n\nThe cluster parameter group family 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-family", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to be assigned to the cluster parameter group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-docdb-dbclusterparametergroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the DB cluster parameter group.\nConstraints:\n* Must not match the name of an existing\n `DBClusterParameterGroup`.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::DocDB::DBInstance": { "MarkdownDocumentation": "`AWS::DocDB::DBInstance`\n\nThe `AWS::DocDB::DBInstance`Amazon DocumentDB (with MongoDB compatibility) resource describes a DBInstance.\nFor more information, see [DBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html) in the *Amazon DocumentDB Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DBInstance's name, such as `sample-cluster-instance`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html", "Attributes": { "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe connection endpoint for the instance.\nFor example: `sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#Endpoint-fn::getatt" }, "Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`Port`\n\nThe port number on which the database accepts connections, such as `27017`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#Port-fn::getatt" } }, "Properties": { "CACertificateIdentifier": { "Required": false, "MarkdownDocumentation": "`CACertificateIdentifier`\n\nThe identifier of the CA certificate for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-cacertificateidentifier", "PrimitiveType": "String", "UpdateType": "Mutable" }, "CertificateRotationRestart": { "Required": false, "MarkdownDocumentation": "`CertificateRotationRestart`\n\nSpecifies whether the DB instance is restarted when you rotate your\nSSL/TLS certificate.\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate\nis not updated until the DB instance is restarted.\n###### Important\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, see [Updating Your Amazon DocumentDB TLS\nCertificates](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) and\n[Encrypting Data in Transit](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) in the *Amazon DocumentDB Developer\nGuide*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-certificaterotationrestart", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DBInstanceClass": { "Required": true, "MarkdownDocumentation": "`DBInstanceClass`\n\nThe compute and memory capacity of the instance; for example,\n`db.m4.large`. If you change the class of an instance there\ncan 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceclass", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DBClusterIdentifier": { "Required": true, "MarkdownDocumentation": "`DBClusterIdentifier`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbclusteridentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AvailabilityZone": { "Required": false, "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Amazon EC2 Availability Zone that the instance is created in.\nDefault: A random, system-chosen Availability Zone in the endpoint's AWS Region.\nExample: `us-east-1d`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-availabilityzone", "PrimitiveType": "String", "UpdateType": "Immutable" }, "PreferredMaintenanceWindow": { "Required": false, "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe time range each week during which system maintenance can occur, in Universal\nCoordinated 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\neach 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-preferredmaintenancewindow", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EnablePerformanceInsights": { "Required": false, "MarkdownDocumentation": "`EnablePerformanceInsights`\n\nA value that indicates whether to enable Performance Insights for the DB Instance. For\nmore information, see [Using Amazon\nPerformance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-enableperformanceinsights", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "AutoMinorVersionUpgrade": { "Required": false, "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nThis parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "DBInstanceIdentifier": { "Required": false, "MarkdownDocumentation": "`DBInstanceIdentifier`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceidentifier", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to be assigned to the instance. You can assign up to\n10 tags to an instance.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-docdb-dbinstance-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::DocDB::DBSubnetGroup": { "MarkdownDocumentation": "`AWS::DocDB::DBSubnetGroup`\n\nThe `AWS::DocDB::DBSubnetGroup`Amazon DocumentDB (with MongoDB compatibility) resource describes a DBSubnetGroup.\nsubnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.\nFor more information, see [DBSubnetGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html) in the *Amazon DocumentDB Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DBSubnetGroup's name, such as `default`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html", "Properties": { "DBSubnetGroupName": { "Required": false, "MarkdownDocumentation": "`DBSubnetGroupName`\n\nThe name for the subnet group. This value is stored as a lowercase string.\nConstraints: Must contain no more than 255 letters, numbers, periods, underscores,\nspaces, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DBSubnetGroupDescription": { "Required": true, "MarkdownDocumentation": "`DBSubnetGroupDescription`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SubnetIds": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`SubnetIds`\n\nThe Amazon EC2 subnet IDs for the subnet group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-subnetids", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to be assigned to the subnet group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-docdb-dbsubnetgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::DocDB::EventSubscription": { "MarkdownDocumentation": "`AWS::DocDB::EventSubscription`\n\nCreates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.\nYou can specify the type of source (`SourceType`) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (`SourceIds`) that trigger the events, and you can provide a list of event categories (`EventCategories`) for events that you want to be notified of. For example, you can specify `SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` and `EventCategories = Availability, Backup`.\nIf you specify both the `SourceType` and `SourceIds` (such as `SourceType = db-instance` and `SourceIdentifier = myDBInstance1`), you are notified of all the `db-instance` events for the specified source. If you specify a `SourceType` but do not specify a `SourceIdentifier`, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the `SourceType` or the `SourceIdentifier`, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html", "Properties": { "SourceType": { "Required": false, "MarkdownDocumentation": "`SourceType`\n\nThe type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to `db-instance`. If this value is not specified, all events are returned.\nValid values: `db-instance`, `db-cluster`,\n`db-parameter-group`, `db-security-group`,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-sourcetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Enabled": { "Required": false, "MarkdownDocumentation": "`Enabled`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-enabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "EventCategories": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`EventCategories`\n\nA list of event categories for a `SourceType` that you want to subscribe to.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-eventcategories", "UpdateType": "Mutable" }, "SubscriptionName": { "Required": false, "MarkdownDocumentation": "`SubscriptionName`\n\nThe name of the subscription.\nConstraints: The name must be fewer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-subscriptionname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SnsTopicArn": { "Required": true, "MarkdownDocumentation": "`SnsTopicArn`\n\nThe Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-snstopicarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SourceIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SourceIds`\n\nThe 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\nhyphen or contain two consecutive hyphens.\nConstraints:\n* If `SourceIds` are provided, `SourceType` must also be\n provided.\n* If the source type is an instance, a `DBInstanceIdentifier` must\n be provided.\n* If the source type is a security group, a `DBSecurityGroupName`\n must be provided.\n* If the source type is a parameter group, a\n `DBParameterGroupName` must be provided.\n* If the source type is a snapshot, a `DBSnapshotIdentifier` must\n be provided.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-sourceids", "UpdateType": "Mutable" } } }, "AWS::DocDBElastic::Cluster": { "MarkdownDocumentation": "`AWS::DocDBElastic::Cluster`\n\nCreates a new Amazon DocumentDB elastic cluster and returns its cluster structure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html", "Properties": { "AdminUserName": { "MarkdownDocumentation": "`AdminUserName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminusername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe KMS key identifier to use to encrypt the new elastic cluster.\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS\nencryption key. If you are creating a cluster using the same Amazon account\nthat owns this KMS encryption key, you can use the KMS key alias instead\nof the ARN as the KMS encryption key.\nIf an encryption key is not specified, Amazon DocumentDB uses the\ndefault encryption key that KMS creates for your account. Your account\nhas 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AdminUserPassword": { "MarkdownDocumentation": "`AdminUserPassword`\n\nThe password for the Elastic DocumentDB cluster administrator and can\ncontain 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminuserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe weekly time range during which system maintenance can occur,\nin 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredmaintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ShardInstanceCount": { "MarkdownDocumentation": "`ShardInstanceCount`\n\nThe number of replica instances applying to all shards in the cluster.\nA `shardInstanceCount` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardinstancecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe Amazon EC2 subnet IDs for the new elastic cluster.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PreferredBackupWindow": { "MarkdownDocumentation": "`PreferredBackupWindow`\n\nThe daily time range during which automated backups are created if automated backups are enabled, as determined by `backupRetentionPeriod`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredbackupwindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ShardCount": { "MarkdownDocumentation": "`ShardCount`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ShardCapacity": { "MarkdownDocumentation": "`ShardCapacity`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcapacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nA list of EC2 VPC security groups to associate with the new\nelastic cluster.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the new elastic cluster. This parameter is stored as\na 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*Pattern*: `[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BackupRetentionPeriod": { "MarkdownDocumentation": "`BackupRetentionPeriod`\n\nThe number of days for which automatic snapshots are retained.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-backupretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nThe authentication type used to determine where to fetch the password used for accessing the elastic cluster.\nValid types are `PLAIN_TEXT` or `SECRET_ARN`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PLAIN_TEXT | SECRET_ARN...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PLAIN_TEXT", "SECRET_ARN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-authtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to be assigned to the new elastic cluster.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-docdbelastic-cluster-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ClusterArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#ClusterArn-fn::getatt" }, "ClusterEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterEndpoint`\n\nThe URL used to connect to the elastic cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#ClusterEndpoint-fn::getatt" } } }, "AWS::DynamoDB::GlobalTable": { "MarkdownDocumentation": "`AWS::DynamoDB::GlobalTable`\n\nThe `AWS::DynamoDB::GlobalTable` resource enables you to create and manage a\nVersion 2019.11.21 global table. This resource cannot be used to create or manage a Version\n2017.11.29 global table. For more information, see [Global\ntables](https://docs.aws.amazon.com//amazondynamodb/latest/developerguide/GlobalTables.html).\n###### Important\nYou cannot convert a resource of type `AWS::DynamoDB::Table` into a\nresource of type `AWS::DynamoDB::GlobalTable` by changing its type in your\ntemplate. **Doing so might result in the deletion of your DynamoDB\ntable.**\nYou can instead use the GlobalTable resource to create a new table in a single\nRegion. This will be billed the same as a single Region table. If you later update the\nstack to add other Regions then Global Tables pricing will apply.\nYou should be aware of the following behaviors when working with DynamoDB global\ntables.\n* The IAM Principal executing the stack operation must have the permissions listed\n below in all regions where you plan to have a global table replica. The IAM\n Principal's permissions should not have restrictions based on IP source address. Some\n global tables operations (for example, adding a replica) are asynchronous, and\n require that the IAM Principal is valid until they complete. You should not delete\n the Principal (user or IAM role) until CloudFormation has finished updating your\n stack.\n \n + `application-autoscaling:DeleteScalingPolicy`\n + `application-autoscaling:DeleteScheduledAction`\n + `application-autoscaling:DeregisterScalableTarget`\n + `application-autoscaling:DescribeScalableTargets`\n + `application-autoscaling:DescribeScalingPolicies`\n + `application-autoscaling:PutScalingPolicy`\n + `application-autoscaling:PutScheduledAction`\n + `application-autoscaling:RegisterScalableTarget`\n + `dynamodb:BatchWriteItem`\n + `dynamodb:CreateGlobalTableWitness`\n + `dynamodb:CreateTable`\n + `dynamodb:CreateTableReplica`\n + `dynamodb:DeleteGlobalTableWitness`\n + `dynamodb:DeleteItem`\n + `dynamodb:DeleteTable`\n + `dynamodb:DeleteTableReplica`\n + `dynamodb:DescribeContinuousBackups`\n + `dynamodb:DescribeContributorInsights`\n + `dynamodb:DescribeTable`\n + `dynamodb:DescribeTableReplicaAutoScaling`\n + `dynamodb:DescribeTimeToLive`\n + `dynamodb:DisableKinesisStreamingDestination`\n + `dynamodb:EnableKinesisStreamingDestination`\n + `dynamodb:GetItem`\n + `dynamodb:ListTables`\n + `dynamodb:ListTagsOfResource`\n + `dynamodb:PutItem`\n + `dynamodb:Query`\n + `dynamodb:Scan`\n + `dynamodb:TagResource`\n + `dynamodb:UntagResource`\n + `dynamodb:UpdateContinuousBackups`\n + `dynamodb:UpdateContributorInsights`\n + `dynamodb:UpdateItem`\n + `dynamodb:UpdateTable`\n + `dynamodb:UpdateTableReplicaAutoScaling`\n + `dynamodb:UpdateTimeToLive`\n + `iam:CreateServiceLinkedRole`\n + `kms:CreateGrant`\n + `kms:DescribeKey`\n* When using provisioned billing mode, CloudFormation will create an auto scaling\n policy on each of your replicas to control their write capacities. You must configure\n this policy using the `WriteProvisionedThroughputSettings` property.\n CloudFormation will ensure that all replicas have the same write capacity auto\n scaling property. You cannot directly specify a value for write capacity for a global\n table.\n* If your table uses provisioned capacity, you must configure auto scaling directly\n in the `AWS::DynamoDB::GlobalTable` resource. You should not configure\n additional auto scaling policies on any of the table replicas or global secondary\n indexes, either via API or via\n `AWS::ApplicationAutoScaling::ScalableTarget` or\n `AWS::ApplicationAutoScaling::ScalingPolicy`. Doing so might result in\n unexpected behavior and is unsupported.\n* In AWS CloudFormation, each global table is controlled by a single stack, in\n a single region, regardless of the number of replicas. When you deploy your template,\n CloudFormation will create/update all replicas as part of a single stack operation.\n You should not deploy the same `AWS::DynamoDB::GlobalTable` resource in\n multiple regions. Doing so will result in errors, and is unsupported. If you deploy\n your application template in multiple regions, you can use conditions to only create\n the resource in a single region. Alternatively, you can choose to define your\n `AWS::DynamoDB::GlobalTable` resources in a stack separate from your\n application stack, and make sure it is only deployed to a single region.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the table name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html", "Properties": { "MultiRegionConsistency": { "MarkdownDocumentation": "`MultiRegionConsistency`\n\nSpecifies the consistency mode for a new global table.\nYou can specify one of the following consistency modes:\n* `EVENTUAL`: Configures a new global table for multi-Region eventual\n consistency (MREC).\n* `STRONG`: Configures a new global table for multi-Region strong\n consistency (MRSC).\nIf you don't specify this field, the global table consistency mode defaults to\n`EVENTUAL`. For more information about global tables consistency modes, see\n[Consistency modes](https://docs.aws.amazon.com/V2globaltables_HowItWorks.html#V2globaltables_HowItWorks.consistency-modes) in DynamoDB developer guide.\n*Required*: No\n*Type*: String\n*Allowed values*: `EVENTUAL | STRONG...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EVENTUAL", "STRONG" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-multiregionconsistency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SSESpecification": { "MarkdownDocumentation": "`SSESpecification`\n\nSpecifies the settings to enable server-side encryption. These settings will be applied\nto all replicas. If you plan to use customer-managed KMS keys, you must provide a key for\neach replica using the `ReplicaSpecification.ReplicaSSESpecification`\nproperty.\n*Required*: No\n*Type*: [SSESpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-ssespecification", "UpdateType": "Mutable", "Required": false, "Type": "SSESpecification" }, "StreamSpecification": { "MarkdownDocumentation": "`StreamSpecification`\n\nSpecifies the streams settings on your global table. You must provide a value for this\nproperty if your global table contains more than one replica. You can only change the\nstreams settings if your global table has only one replica. For Multi-Region Strong\nConsistency (MRSC), you do not need to provide a value for this property and can change the\nsettings at any time.\n*Required*: No\n*Type*: [StreamSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-streamspecification", "UpdateType": "Mutable", "Required": false, "Type": "StreamSpecification" }, "WarmThroughput": { "MarkdownDocumentation": "`WarmThroughput`\n\nProvides visibility into the number of read and write operations your table or\nsecondary index can instantaneously support. The settings can be modified using the\n`UpdateTable` operation to meet the throughput requirements of an\nupcoming peak event.\n*Required*: No\n*Type*: [WarmThroughput](./aws-properties-dynamodb-globaltable-warmthroughput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-warmthroughput", "UpdateType": "Mutable", "Required": false, "Type": "WarmThroughput" }, "Replicas": { "MarkdownDocumentation": "`Replicas`\n\nSpecifies the list of replicas for your global table. The list must contain at least one\nelement, the region where the stack defining the global table is deployed. For example, if\nyou define your table in a stack deployed to us-east-1, you must have an entry in\n`Replicas` with the region us-east-1. You cannot remove the replica in the\nstack region.\n###### Important\nAdding a replica might take a few minutes for an empty table, or up to several hours\nfor large tables. If you want to add or remove a replica, we recommend submitting an\n`UpdateStack` operation containing only that change.\nIf you add or delete a replica during an update, we recommend that you don't update\nany other resources. If your stack fails to update and is rolled back while adding a new\nreplica, 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\nreplicas after table creation, but you can only add or remove a single replica in each\nupdate. For Multi-Region Strong Consistency (MRSC), you can add or remove up to 3 replicas,\nor 2 replicas plus a witness Region.\n*Required*: Yes\n*Type*: Array of [ReplicaSpecification](./aws-properties-dynamodb-globaltable-replicaspecification.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ReplicaSpecification", "DuplicatesAllowed": false }, "WriteProvisionedThroughputSettings": { "MarkdownDocumentation": "`WriteProvisionedThroughputSettings`\n\nSpecifies an auto scaling policy for write capacity. This policy will be applied to all\nreplicas. This setting must be specified if `BillingMode` is set to\n`PROVISIONED`.\n*Required*: No\n*Type*: [WriteProvisionedThroughputSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings", "UpdateType": "Mutable", "Required": false, "Type": "WriteProvisionedThroughputSettings" }, "WriteOnDemandThroughputSettings": { "MarkdownDocumentation": "`WriteOnDemandThroughputSettings`\n\nSets the write request settings for a global table or a global secondary index. You can\nonly specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.\n*Required*: No\n*Type*: [WriteOnDemandThroughputSettings](./aws-properties-dynamodb-globaltable-writeondemandthroughputsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-writeondemandthroughputsettings", "UpdateType": "Mutable", "Required": false, "Type": "WriteOnDemandThroughputSettings" }, "GlobalTableWitnesses": { "MarkdownDocumentation": "`GlobalTableWitnesses`\n\nThe list of witnesses of the MRSC global table. Only one witness Region can be\nconfigured per MRSC global table.\n*Required*: No\n*Type*: Array of [GlobalTableWitness](./aws-properties-dynamodb-globaltable-globaltablewitness.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-globaltablewitnesses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GlobalTableWitness", "DuplicatesAllowed": false }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nA name for the global table. If you don't specify a name, AWS CloudFormation\ngenerates 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).\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must\nreplace the resource, specify a new name.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-tablename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AttributeDefinitions": { "MarkdownDocumentation": "`AttributeDefinitions`\n\nA list of attributes that describe the key schema for the global table and\nindexes.\n*Required*: Yes\n*Type*: Array of [AttributeDefinition](./aws-properties-dynamodb-globaltable-attributedefinition.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-attributedefinitions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "AttributeDefinition", "DuplicatesAllowed": false }, "BillingMode": { "MarkdownDocumentation": "`BillingMode`\n\nSpecifies how you are charged for read and write throughput and how you manage capacity.\nValid values are:\n* `PAY_PER_REQUEST`\n* `PROVISIONED`\nAll replicas in your global table will have the same billing mode. If you use\n`PROVISIONED` billing mode, you must provide an auto scaling configuration\nvia the `WriteProvisionedThroughputSettings` property. The default value of this\nproperty is `PROVISIONED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROVISIONED | PAY_PER_REQUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROVISIONED", "PAY_PER_REQUEST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-billingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GlobalSecondaryIndexes": { "MarkdownDocumentation": "`GlobalSecondaryIndexes`\n\nGlobal secondary indexes to be created on the global table. You can create up to 20\nglobal secondary indexes. Each replica in your global table will have the same global\nsecondary index settings. You can only create or delete one global secondary index in a\nsingle stack operation.\nSince the backfilling of an index could take a long time, CloudFormation does not wait\nfor the index to become active. If a stack operation rolls back, CloudFormation might not\ndelete an index that has been added. In that case, you will need to delete the index\nmanually.\n*Required*: No\n*Type*: Array of [GlobalSecondaryIndex](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-globalsecondaryindexes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GlobalSecondaryIndex", "DuplicatesAllowed": false }, "KeySchema": { "MarkdownDocumentation": "`KeySchema`\n\nSpecifies the attributes that make up the primary key for the table. The attributes in\nthe `KeySchema` property must also be defined in the\n`AttributeDefinitions` property.\n*Required*: Yes\n*Type*: [Array](./aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](./aws-properties-dynamodb-globaltable-keyschema.html)\n*Minimum*: `1`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-keyschema", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "KeySchema", "DuplicatesAllowed": false }, "LocalSecondaryIndexes": { "MarkdownDocumentation": "`LocalSecondaryIndexes`\n\nLocal secondary indexes to be created on the table. You can create up to five local\nsecondary indexes. Each index is scoped to a given hash key value. The size of each hash\nkey can be up to 10 gigabytes. Each replica in your global table will have the same local\nsecondary index settings.\n*Required*: No\n*Type*: Array of [LocalSecondaryIndex](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-localsecondaryindexes", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "LocalSecondaryIndex", "DuplicatesAllowed": false }, "TimeToLiveSpecification": { "MarkdownDocumentation": "`TimeToLiveSpecification`\n\nSpecifies the time to live (TTL) settings for the table. This setting will be applied to\nall replicas.\n*Required*: No\n*Type*: [TimeToLiveSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-timetolivespecification", "UpdateType": "Mutable", "Required": false, "Type": "TimeToLiveSpecification" } }, "Attributes": { "TableId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TableId`\n\nUnique identifier for the table, such as\n`a123b456-01ab-23cd-123a-111222aaabbb`. The `TableId` returned is\nthat of the replica in the region the stack is deployed to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#TableId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the DynamoDB table, such as\n`arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable`. The ARN\nreturned is that of the replica in the region the stack is deployed to.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#Arn-fn::getatt" }, "StreamArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`StreamArn`\n\nThe ARN of the DynamoDB stream, such as\n`arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000`.\nThe `StreamArn` returned is that of the replica in the region the stack is\ndeployed to.\n###### Note\nYou must specify the `StreamSpecification` property to use this\nattribute.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#StreamArn-fn::getatt" } } }, "AWS::DynamoDB::Table": { "MarkdownDocumentation": "`AWS::DynamoDB::Table`\n\nThe `AWS::DynamoDB::Table` resource creates a DynamoDB table. For\nmore information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *Amazon DynamoDB API Reference*.\nYou should be aware of the following behaviors when working with DynamoDB\ntables:\n* AWS CloudFormation typically creates DynamoDB tables in parallel.\n However, if your template includes multiple DynamoDB tables with indexes,\n you must declare dependencies so that the tables are created sequentially. Amazon DynamoDB limits the number of tables with secondary indexes that are in\n the creating state. If you create multiple tables with indexes at the same time,\n DynamoDB returns an error and the stack operation fails. For an\n example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).\n###### Important\nOur guidance is to use the latest schema documented for your AWS CloudFormation templates. This schema supports the provisioning of all table settings below. When\nusing this schema in your AWS CloudFormation templates, please ensure that your\nIdentity and Access Management (IAM) policies are updated with\nappropriate permissions to allow for the authorization of these setting changes.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myDynamoDBTable\" }`\nFor the resource with the logical ID `myDynamoDBTable`, `Ref` will\nreturn the DynamoDB table name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html", "Properties": { "OnDemandThroughput": { "MarkdownDocumentation": "`OnDemandThroughput`\n\nSets the maximum number of read and write units for the specified on-demand table. If\nyou use this property, you must specify `MaxReadRequestUnits`,\n`MaxWriteRequestUnits`, or both.\n*Required*: No\n*Type*: [OnDemandThroughput](./aws-properties-dynamodb-table-ondemandthroughput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ondemandthroughput", "UpdateType": "Mutable", "Required": false, "Type": "OnDemandThroughput" }, "SSESpecification": { "MarkdownDocumentation": "`SSESpecification`\n\nSpecifies the settings to enable server-side encryption.\n*Required*: No\n*Type*: [SSESpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ssespecification", "UpdateType": "Mutable", "Required": false, "Type": "SSESpecification" }, "KinesisStreamSpecification": { "MarkdownDocumentation": "`KinesisStreamSpecification`\n\nThe Kinesis Data Streams configuration for the specified table.\n*Required*: No\n*Type*: [KinesisStreamSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-kinesisstreamspecification", "UpdateType": "Mutable", "Required": false, "Type": "KinesisStreamSpecification" }, "StreamSpecification": { "MarkdownDocumentation": "`StreamSpecification`\n\nThe settings for the DynamoDB table stream, which captures changes to items stored\nin the table. Including this property in your AWS CloudFormation template automatically enables streaming.\n*Required*: No\n*Type*: [StreamSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification", "UpdateType": "Mutable", "Required": false, "Type": "StreamSpecification" }, "ContributorInsightsSpecification": { "MarkdownDocumentation": "`ContributorInsightsSpecification`\n\nThe settings used to specify whether to enable CloudWatch Contributor Insights for the\ntable and define which events to monitor.\n*Required*: No\n*Type*: [ContributorInsightsSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-contributorinsightsspecification", "UpdateType": "Mutable", "Required": false, "Type": "ContributorInsightsSpecification" }, "ImportSourceSpecification": { "MarkdownDocumentation": "`ImportSourceSpecification`\n\nSpecifies the properties of data being imported from the S3 bucket source to the\"\ntable.\n###### Important\nIf you specify the `ImportSourceSpecification` property, and also specify\neither the `StreamSpecification`, the `TableClass` property, the\n`DeletionProtectionEnabled` property, or the `WarmThroughput`\nproperty, the IAM entity creating/updating stack must have `UpdateTable`\npermission.\n*Required*: No\n*Type*: [ImportSourceSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-importsourcespecification", "UpdateType": "Immutable", "Required": false, "Type": "ImportSourceSpecification" }, "PointInTimeRecoverySpecification": { "MarkdownDocumentation": "`PointInTimeRecoverySpecification`\n\nThe settings used to enable point in time recovery.\n*Required*: No\n*Type*: [PointInTimeRecoverySpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-pointintimerecoveryspecification", "UpdateType": "Mutable", "Required": false, "Type": "PointInTimeRecoverySpecification" }, "ProvisionedThroughput": { "MarkdownDocumentation": "`ProvisionedThroughput`\n\nThroughput for the specified table, which consists of values for\n`ReadCapacityUnits` and `WriteCapacityUnits`. For more information\nabout the contents of a provisioned throughput structure, see [Amazon DynamoDB\nTable ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).\nIf you set `BillingMode` as `PROVISIONED`, you must specify this\nproperty. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot\nspecify this property.\n*Required*: Conditional\n*Type*: [ProvisionedThroughput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-provisionedthroughput", "UpdateType": "Mutable", "Required": false, "Type": "ProvisionedThroughput" }, "WarmThroughput": { "MarkdownDocumentation": "`WarmThroughput`\n\nRepresents the warm throughput (in read units per second and write units per second)\nfor creating a table.\n*Required*: No\n*Type*: [WarmThroughput](./aws-properties-dynamodb-table-warmthroughput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-warmthroughput", "UpdateType": "Mutable", "Required": false, "Type": "WarmThroughput" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nA name for the table. If you don't specify a name, AWS CloudFormation generates a\nunique 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).\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must\nreplace the resource, specify a new name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AttributeDefinitions": { "MarkdownDocumentation": "`AttributeDefinitions`\n\nA 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\nAttributeDefinition.\n*Required*: Conditional\n*Type*: Array of [AttributeDefinition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedefinitions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AttributeDefinition", "DuplicatesAllowed": false }, "GlobalSecondaryIndexes": { "MarkdownDocumentation": "`GlobalSecondaryIndexes`\n\nGlobal secondary indexes to be created on the table. You can create up to 20 global\nsecondary indexes.\n###### Important\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\nbackfilling phase can take a long time, depending on the size of the table. You can't\nuse the index or update the table until the index's status is `ACTIVE`. You\ncan track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html)\ncommand.\nIf you add or delete an index during an update, we recommend that you don't update\nany other resources. If your stack fails to update and is rolled back while adding a new\nindex, 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\n throughput values of global secondary indexes, you can update the table without\n interruption.\n* You can delete or add one global secondary index without interruption. If you\n do both in the same update (for example, by changing the index's logical ID), the\n update fails.\n*Required*: No\n*Type*: Array of [GlobalSecondaryIndex](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-globalsecondaryindexes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GlobalSecondaryIndex", "DuplicatesAllowed": true }, "BillingMode": { "MarkdownDocumentation": "`BillingMode`\n\nSpecify how you are charged for read and write throughput and how you manage\ncapacity.\nValid values include:\n* `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for\n most DynamoDB workloads. `PAY_PER_REQUEST` sets the billing mode to [On-demand\n capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html).\n* `PROVISIONED` - We recommend using `PROVISIONED` for steady\n workloads with predictable growth where capacity requirements can be reliably\n forecasted. `PROVISIONED` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html).\nIf not specified, the default is `PROVISIONED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `PROVISIONED | PAY_PER_REQUE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PROVISIONED", "PAY_PER_REQUEST" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-billingmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nAn AWS resource-based policy document in JSON format that will be\nattached to the table.\nWhen you attach a resource-based policy while creating a table, the policy application\nis *strongly consistent*.\nThe maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this\nlimit. For a full list of all considerations that apply for resource-based policies, see\n[Resource-based\npolicy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).\n###### Note\nYou need to specify the `CreateTable` and\n`PutResourcePolicy`\nIAM actions for authorizing a user to create a table with a\nresource-based policy.\n*Required*: No\n*Type*: [ResourcePolicy](./aws-properties-dynamodb-table-resourcepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-resourcepolicy", "UpdateType": "Mutable", "Required": false, "Type": "ResourcePolicy" }, "LocalSecondaryIndexes": { "MarkdownDocumentation": "`LocalSecondaryIndexes`\n\nLocal secondary indexes to be created on the table. You can create up to 5 local\nsecondary indexes. Each index is scoped to a given hash key value. The size of each hash\nkey can be up to 10 gigabytes.\n*Required*: No\n*Type*: Array of [LocalSecondaryIndex](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-localsecondaryindexes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LocalSecondaryIndex", "DuplicatesAllowed": true }, "KeySchema": { "MarkdownDocumentation": "`KeySchema`\n\nSpecifies the attributes that make up the primary key for the table. The attributes in\nthe `KeySchema` property must also be defined in the\n`AttributeDefinitions` property.\n*Required*: Yes\n*Type*: [Array](./aws-properties-dynamodb-table-keyschema.html) of [KeySchema](./aws-properties-dynamodb-table-keyschema.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-keyschema", "UpdateType": "Immutable", "Required": true, "DuplicatesAllowed": false, "ItemType": "KeySchema", "Type": "List" }, "DeletionProtectionEnabled": { "MarkdownDocumentation": "`DeletionProtectionEnabled`\n\nDetermines if a table is protected from deletion. When enabled, the table cannot be\ndeleted by any user or process. This setting is disabled by default. For more information,\nsee [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Amazon DynamoDBDeveloper 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-deletionprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TableClass": { "MarkdownDocumentation": "`TableClass`\n\nThe table class of the new table. Valid values are `STANDARD` and\n`STANDARD_INFREQUENT_ACCESS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | STANDARD_INFREQU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "STANDARD_INFREQUENT_ACCESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tableclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-dynamodb-table-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "TimeToLiveSpecification": { "MarkdownDocumentation": "`TimeToLiveSpecification`\n\nSpecifies the Time to Live (TTL) settings for the table.\n###### Note\nFor detailed information about the limits in DynamoDB, see [Limits in\nAmazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.\n*Required*: No\n*Type*: [TimeToLiveSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-timetolivespecification", "UpdateType": "Mutable", "Required": false, "Type": "TimeToLiveSpecification" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the DynamoDB table, such as\n`arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#Arn-fn::getatt" }, "StreamArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`StreamArn`\n\nThe ARN of the DynamoDB stream, such as\n`arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000`.\n###### Note\nYou must specify the `StreamSpecification` property to use this\nattribute.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#StreamArn-fn::getatt" } } }, "AWS::EC2::CapacityManagerDataExport": { "MarkdownDocumentation": "`AWS::EC2::CapacityManagerDataExport`\n\nCreates a new data export configuration for EC2 Capacity Manager. This allows you to automatically export capacity usage data to an S3 bucket on a scheduled basis.\nThe exported data includes metrics for On-Demand, Spot, and Capacity Reservations usage across your organization.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the export ID, such as `cmde-0f3f217ee9a5baead`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacitymanagerdataexport.html", "Properties": { "S3BucketPrefix": { "MarkdownDocumentation": "`S3BucketPrefix`\n\nThe S3 key prefix used for organizing export files within the bucket.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacitymanagerdataexport.html#cfn-ec2-capacitymanagerdataexport-s3bucketprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe frequency at which data exports are generated.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `hourly`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "hourly" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacitymanagerdataexport.html#cfn-ec2-capacitymanagerdataexport-schedule", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OutputFormat": { "MarkdownDocumentation": "`OutputFormat`\n\nThe file format of the exported data.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `csv | parquet...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "csv", "parquet" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacitymanagerdataexport.html#cfn-ec2-capacitymanagerdataexport-outputformat", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3BucketName": { "MarkdownDocumentation": "`S3BucketName`\n\nThe name of the S3 bucket where export files are delivered.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacitymanagerdataexport.html#cfn-ec2-capacitymanagerdataexport-s3bucketname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the data export configuration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-capacitymanagerdataexport-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacitymanagerdataexport.html#cfn-ec2-capacitymanagerdataexport-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "CapacityManagerDataExportId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CapacityManagerDataExportId`\n\nThe unique identifier for the data export configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacitymanagerdataexport.html#CapacityManagerDataExportId-fn::getatt" } } }, "AWS::EC2::CapacityReservation": { "MarkdownDocumentation": "`AWS::EC2::CapacityReservation`\n\nCreates a new Capacity Reservation with the specified attributes. For more information,\nsee [Capacity\nReservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ID, such as\n`cr-1234ab5cd6789e0f1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html", "Properties": { "Tenancy": { "MarkdownDocumentation": "`Tenancy`\n\nIndicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one\nof the following tenancy settings:\n* `default` - The Capacity Reservation is created on hardware that is\n shared with other AWS accounts.\n* `dedicated` - The Capacity Reservation is created on single-tenant\n hardware that is dedicated to a single AWS account.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | dedicated...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "default", "dedicated" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tenancy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EndDateType": { "MarkdownDocumentation": "`EndDateType`\n\nIndicates the way in which the Capacity Reservation ends. A Capacity Reservation can\nhave one of the following end types:\n* `unlimited` - The Capacity Reservation remains active until you\n explicitly cancel it. Do not provide an `EndDate` if the\n `EndDateType` is `unlimited`.\n* `limited` - The Capacity Reservation expires automatically at a\n specified date and time. You must provide an `EndDate` value if the\n `EndDateType` value is `limited`.\n*Required*: No\n*Type*: String\n*Allowed values*: `unlimited | limited...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "unlimited", "limited" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddatetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagSpecifications": { "MarkdownDocumentation": "`TagSpecifications`\n\nThe tags to apply to the Capacity Reservation during launch.\n*Required*: No\n*Type*: Array of [TagSpecification](./aws-properties-ec2-capacityreservation-tagspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tagspecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "TagSpecification", "DuplicatesAllowed": true }, "UnusedReservationBillingOwnerId": { "MarkdownDocumentation": "`UnusedReservationBillingOwnerId`\n\nThe ID of the AWS account to which to assign billing of the unused capacity of the Capacity\nReservation. A request will be sent to the specified account. That account must accept the request for the billing\nto be assigned to their account. For more information, see [Billing assignment for shared Amazon EC2 Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html).\nYou can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it\nto a resource share. For more information, see [AWS::RAM::ResourceShare](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9]{12}`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-unusedreservationbillingownerid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneId": { "MarkdownDocumentation": "`AvailabilityZoneId`\n\nThe ID of the Availability Zone in which the capacity is reserved.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-availabilityzoneid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone in which to create the Capacity Reservation.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EndDate": { "MarkdownDocumentation": "`EndDate`\n\nThe date and time at which the Capacity Reservation expires. When a Capacity\nReservation expires, the reserved capacity is released and you can no longer launch\ninstances into it. The Capacity Reservation's state changes to `expired` when\nit reaches its end date and time.\nYou must provide an `EndDate` value if `EndDateType` is\n`limited`. Omit `EndDate` if `EndDateType` is\n`unlimited`.\nIf the `EndDateType` is `limited`, the Capacity Reservation is\ncancelled within an hour from the specified time. For example, if you specify 5/31/2019,\n13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on\n5/31/2019.\nIf you are requesting a future-dated Capacity Reservation, you can't specify an end\ndate and time that is within the commitment duration.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EbsOptimized": { "MarkdownDocumentation": "`EbsOptimized`\n\nIndicates whether the Capacity Reservation supports EBS-optimized instances. This\noptimization provides dedicated throughput to Amazon EBS and an optimized configuration\nstack to provide optimal I/O performance. This optimization isn't available with all\ninstance types. Additional usage charges apply when using an EBS- optimized\ninstance.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ebsoptimized", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "OutPostArn": { "MarkdownDocumentation": "`OutPostArn`\n\n###### Note\nNot supported for future-dated Capacity Reservations.\nThe Amazon Resource Name (ARN) of the Outpost on which to create the Capacity\nReservation.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-outpostarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceCount": { "MarkdownDocumentation": "`InstanceCount`\n\nThe number of instances for which to reserve capacity.\n###### Note\nYou can request future-dated Capacity Reservations for an instance count with a\nminimum of 32 vCPUs. For example, if you request a future-dated Capacity\nReservation for `m5.xlarge` instances, you must request at least 8\ninstances (*8 \\* m5.xlarge = 32 vCPUs*).\nValid range: 1 - 1000\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancecount", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "PlacementGroupArn": { "MarkdownDocumentation": "`PlacementGroupArn`\n\n###### Note\nNot supported for future-dated Capacity Reservations.\nThe Amazon Resource Name (ARN) of the cluster placement group in which to create the\nCapacity Reservation. For more information, see [Capacity Reservations for cluster\nplacement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws([a-z-]+)?:ec2:[a-z\\d-]+:\\d{12}:placement-group/^.{1,255}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-placementgrouparn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstancePlatform": { "MarkdownDocumentation": "`InstancePlatform`\n\nThe type of operating system for which to reserve capacity.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Linux/UNIX | Red Hat Enterp...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Linux/UNIX", "Red Hat Enterprise Linux", "SUSE Linux", "Windows", "Windows with SQL Server", "Windows with SQL Server Enterprise", "Windows with SQL Server Standard", "Windows with SQL Server Web", "Linux with SQL Server Standard", "Linux with SQL Server Web", "Linux with SQL Server Enterprise", "RHEL with SQL Server Standard", "RHEL with SQL Server Enterprise", "RHEL with SQL Server Web", "RHEL with HA", "RHEL with HA and SQL Server Standard", "RHEL with HA and SQL Server Enterprise", "Ubuntu Pro" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instanceplatform", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type for which to reserve capacity.\n###### Note\nYou can request future-dated Capacity Reservations for instance types in the C, M,\nR, I, T, and G instance families only.\nFor more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EphemeralStorage": { "MarkdownDocumentation": "`EphemeralStorage`\n\n*Deprecated.*\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ephemeralstorage", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "InstanceMatchCriteria": { "MarkdownDocumentation": "`InstanceMatchCriteria`\n\nIndicates the type of instance launches that the Capacity Reservation accepts. The\noptions include:\n* `open` - The Capacity Reservation automatically matches all instances\n that have matching attributes (instance type, platform, and Availability Zone).\n Instances that have matching attributes run in the Capacity Reservation\n automatically without specifying any additional parameters.\n* `targeted` - The Capacity Reservation only accepts instances that\n have matching attributes (instance type, platform, and Availability Zone), and\n explicitly target the Capacity Reservation. This ensures that only permitted\n instances can use the reserved capacity.\n###### Note\nIf you are requesting a future-dated Capacity Reservation, you must specify\n`targeted`.\nDefault: `open`\n*Required*: No\n*Type*: String\n*Allowed values*: `open | targeted...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "open", "targeted" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancematchcriteria", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Tenancy": { "PrimitiveType": "String", "MarkdownDocumentation": "`Tenancy`\n\nReturns the tenancy of the Capacity Reservation. For example:\n`dedicated`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#Tenancy-fn::getatt" }, "CommitmentInfo.CommittedInstanceCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#CommitmentInfo.CommittedInstanceCount-fn::getatt" }, "CapacityReservationFleetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CapacityReservationFleetId`\n\nThe ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs.\nOnly valid for Capacity Reservations that were created by a Capacity Reservation\nFleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#CapacityReservationFleetId-fn::getatt" }, "AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "`AvailabilityZone`\n\nReturns the Availability Zone in which the capacity is reserved. For example:\n`us-east-1a`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#AvailabilityZone-fn::getatt" }, "TotalInstanceCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`TotalInstanceCount`\n\nReturns the total number of instances for which the Capacity Reservation reserves\ncapacity. For example: `15`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#TotalInstanceCount-fn::getatt" }, "CreateDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateDate`\n\nThe date and time the Capacity Reservation was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#CreateDate-fn::getatt" }, "StartDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`StartDate`\n\nThe date and time the Capacity Reservation was started.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#StartDate-fn::getatt" }, "CapacityReservationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CapacityReservationArn`\n\nThe Amazon Resource Name (ARN) of the Capacity Reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#CapacityReservationArn-fn::getatt" }, "DeliveryPreference": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeliveryPreference`\n\nThe delivery method for a future-dated Capacity Reservation. `incremental`\nindicates that the requested capacity is delivered in addition to any running instances\nand reserved capacity that you have in your account at the requested date and\ntime.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#DeliveryPreference-fn::getatt" }, "CommitmentInfo": { "Type": "CommitmentInfo", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#CommitmentInfo-fn::getatt" }, "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe ID of the AWS account that owns the Capacity Reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#OwnerId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the Capacity Reservation. A Capacity Reservation can be in one of\nthe following states:\n* `active` - The capacity is available for use.\n* `expired` - The Capacity Reservation expired automatically at the date and time\n specified in your reservation request. The reserved capacity is no longer available for your use.\n* `cancelled` - The Capacity Reservation was canceled. The reserved capacity is no\n longer available for your use.\n* `pending` - The Capacity Reservation request was successful but the capacity\n provisioning is still pending.\n* `failed` - The Capacity Reservation request has failed. A request can fail due to\n request parameters that are not valid, capacity constraints, or instance limit constraints. You\n can view a failed request for 60 minutes.\n* `scheduled` - (*Future-dated Capacity Reservations*) The\n future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled\n for delivery on the requested start date.\n* `payment-pending` - (*Capacity Blocks*) The upfront\n payment has not been processed yet.\n* `payment-failed` - (*Capacity Blocks*) The upfront\n payment was not processed in the 12-hour time frame. Your Capacity Block was released.\n* `assessing` - (*Future-dated Capacity Reservations*)\n Amazon EC2 is assessing your request for a future-dated Capacity Reservation.\n* `delayed` - (*Future-dated Capacity Reservations*) Amazon EC2\n encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is\n unable to deliver the requested capacity by the requested start date and time.\n* `unsupported` - (*Future-dated Capacity Reservations*) Amazon EC2\n can't support the future-dated Capacity Reservation request due to capacity constraints. You can view\n unsupported requests for 30 days. The Capacity Reservation will not be delivered.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#State-fn::getatt" }, "AvailableInstanceCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AvailableInstanceCount`\n\nReturns the remaining capacity, which indicates the number of instances that can be\nlaunched in the Capacity Reservation. For example: `9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#AvailableInstanceCount-fn::getatt" }, "ReservationType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReservationType`\n\nThe type of Capacity Reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#ReservationType-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the Capacity Reservation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#Id-fn::getatt" }, "CapacityAllocationSet": { "Type": "List", "ItemType": "CapacityAllocation", "MarkdownDocumentation": "`CapacityAllocationSet`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#CapacityAllocationSet-fn::getatt" }, "InstanceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`InstanceType`\n\nReturns the type of instance for which the capacity is reserved. For example:\n`m4.large`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#InstanceType-fn::getatt" }, "CommitmentInfo.CommitmentEndDate": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#CommitmentInfo.CommitmentEndDate-fn::getatt" } } }, "AWS::EC2::CapacityReservationFleet": { "MarkdownDocumentation": "`AWS::EC2::CapacityReservationFleet`\n\nCreates a new Capacity Reservation Fleet with the specified attributes. For more\ninformation, see [Capacity Reservation Fleets](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html) in the *Amazon EC2 User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ID, such as\n`crf-abcdef01234567890`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html", "Properties": { "Tenancy": { "MarkdownDocumentation": "`Tenancy`\n\nIndicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in\nthe Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the\nfollowing tenancy settings:\n* `default` - The Capacity Reservation Fleet is created on hardware\n that is shared with other AWS accounts.\n* `dedicated` - The Capacity Reservations are created on single-tenant\n hardware that is dedicated to a single AWS account.\n*Required*: No\n*Type*: String\n*Allowed values*: `default`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "default" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tenancy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TotalTargetCapacity": { "MarkdownDocumentation": "`TotalTargetCapacity`\n\nThe total number of capacity units to be reserved by the Capacity Reservation Fleet.\nThis value, together with the instance type weights that you assign to each instance\ntype used by the Fleet determine the number of instances for which the Fleet reserves\ncapacity. Both values are based on units that make sense for your workload. For more\ninformation, see [Total target\ncapacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `25000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-totaltargetcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AllocationStrategy": { "MarkdownDocumentation": "`AllocationStrategy`\n\nThe strategy used by the Capacity Reservation Fleet to determine which of the\nspecified instance types to use. Currently, only the `prioritized` allocation\nstrategy is supported. For more information, see [Allocation\nstrategy](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) in the *Amazon EC2 User Guide*.\nValid values: `prioritized`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-allocationstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TagSpecifications": { "MarkdownDocumentation": "`TagSpecifications`\n\nThe tags to assign to the Capacity Reservation Fleet. The tags are automatically\nassigned to the Capacity Reservations in the Fleet.\n*Required*: No\n*Type*: Array of [TagSpecification](./aws-properties-ec2-capacityreservationfleet-tagspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tagspecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "TagSpecification", "DuplicatesAllowed": true }, "NoRemoveEndDate": { "MarkdownDocumentation": "`NoRemoveEndDate`\n\nUsed to add an end date to a Capacity Reservation Fleet that has no end date and\ntime. To add an end date to a Capacity Reservation Fleet, specify `true`\nfor this paramater and specify the end date and time (in UTC time format) for the\n**EndDate** 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-noremoveenddate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InstanceTypeSpecifications": { "MarkdownDocumentation": "`InstanceTypeSpecifications`\n\nInformation about the instance types for which to reserve the capacity.\n*Required*: No\n*Type*: Array of [InstanceTypeSpecification](./aws-properties-ec2-capacityreservationfleet-instancetypespecification.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancetypespecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "InstanceTypeSpecification", "DuplicatesAllowed": false }, "RemoveEndDate": { "MarkdownDocumentation": "`RemoveEndDate`\n\nUsed to remove an end date from a Capacity Reservation Fleet that is configured\nto end automatically at a specific date and time. To remove the end date from a\nCapacity Reservation Fleet, specify `true` for this paramater and omit\nthe **EndDate** 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-removeenddate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InstanceMatchCriteria": { "MarkdownDocumentation": "`InstanceMatchCriteria`\n\nIndicates the type of instance launches that the Capacity Reservation Fleet accepts.\nAll Capacity Reservations in the Fleet inherit this instance matching criteria.\nCurrently, Capacity Reservation Fleets support `open` instance matching\ncriteria only. This means that instances that have matching attributes (instance type,\nplatform, and Availability Zone) run in the Capacity Reservations automatically.\nInstances do not need to explicitly target a Capacity Reservation Fleet to use its\nreserved capacity.\n*Required*: No\n*Type*: String\n*Allowed values*: `open`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "open" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancematchcriteria", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EndDate": { "MarkdownDocumentation": "`EndDate`\n\nThe date and time at which the Capacity Reservation Fleet expires. When the Capacity\nReservation Fleet expires, its state changes to `expired` and all of the\nCapacity Reservations in the Fleet expire.\nThe Capacity Reservation Fleet expires within an hour after the specified time. For\nexample, if you specify `5/31/2019`, `13:30:55`, the Capacity\nReservation Fleet is guaranteed to expire between `13:30:55` and\n`14:30:55` on `5/31/2019`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-enddate", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CapacityReservationFleetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CapacityReservationFleetId`\n\nThe ID of the Capacity Reservation Fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#CapacityReservationFleetId-fn::getatt" } } }, "AWS::EC2::CarrierGateway": { "MarkdownDocumentation": "`AWS::EC2::CarrierGateway`\n\nCreates a carrier gateway. For more information about carrier gateways, see [Carrier gateways](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway) in the *AWS Wavelength Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the carrier gateway ID. For example:\n`cagw-05a8da9a199afb1c7`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC associated with the carrier 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#cfn-ec2-carriergateway-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the carrier gateway.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-carriergateway-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#cfn-ec2-carriergateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe AWS account ID of the owner of the carrier gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#OwnerId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the carrier gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#State-fn::getatt" }, "CarrierGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CarrierGatewayId`\n\nThe ID of the carrier gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#CarrierGatewayId-fn::getatt" } } }, "AWS::EC2::ClientVpnAuthorizationRule": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnAuthorizationRule`\n\nSpecifies an ingress authorization rule to add to a Client VPN endpoint. Ingress\nauthorization rules act as firewall rules that grant access to networks. You must configure\ningress authorization rules to enable clients to access resources in AWS\nor on-premises networks.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html", "Properties": { "ClientVpnEndpointId": { "Required": true, "MarkdownDocumentation": "`ClientVpnEndpointId`\n\nThe ID of the Client VPN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-clientvpnendpointid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA brief description of the authorization 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-description", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AccessGroupId": { "Required": false, "MarkdownDocumentation": "`AccessGroupId`\n\nThe ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if `AuthorizeAllGroups` is `false` or not 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-accessgroupid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "TargetNetworkCidr": { "Required": true, "MarkdownDocumentation": "`TargetNetworkCidr`\n\nThe IPv4 address range, in CIDR notation, of the network for which access is being authorized.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-targetnetworkcidr", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AuthorizeAllGroups": { "Required": false, "MarkdownDocumentation": "`AuthorizeAllGroups`\n\nIndicates whether to grant access to all clients. Specify `true` to grant all\nclients who successfully establish a VPN connection access to the network. Must be set\nto `true` if `AccessGroupId` is not specified.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-authorizeallgroups", "PrimitiveType": "Boolean", "UpdateType": "Immutable" } } }, "AWS::EC2::ClientVpnEndpoint": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnEndpoint`\n\nSpecifies a Client VPN endpoint. A Client VPN endpoint is the resource you create and\nconfigure to enable and manage client VPN sessions. It is the destination endpoint at which\nall client VPN sessions are terminated.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Client VPN endpoint ID. For example:\n`cvpn-endpoint-1234567890abcdef0`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html", "Properties": { "ClientCidrBlock": { "Required": false, "MarkdownDocumentation": "`ClientCidrBlock`\n\nThe IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ClientConnectOptions": { "Type": "ClientConnectOptions", "Required": false, "MarkdownDocumentation": "`ClientConnectOptions`\n\nThe options for managing connection authorization for new client connections.\n*Required*: No\n*Type*: [ClientConnectOptions](./aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientconnectoptions", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA brief description of the Client VPN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ClientRouteEnforcementOptions": { "Type": "ClientRouteEnforcementOptions", "Required": false, "MarkdownDocumentation": "`ClientRouteEnforcementOptions`\n\nClient route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T\nhis feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.\nClient route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table,\nreverting it back to the expected route configurations.\n*Required*: No\n*Type*: [ClientRouteEnforcementOptions](./aws-properties-ec2-clientvpnendpoint-clientrouteenforcementoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientrouteenforcementoptions", "UpdateType": "Mutable" }, "TagSpecifications": { "Type": "List", "Required": false, "MarkdownDocumentation": "`TagSpecifications`\n\nThe tags to apply to the Client VPN endpoint during creation.\n*Required*: No\n*Type*: Array of [TagSpecification](./aws-properties-ec2-clientvpnendpoint-tagspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications", "ItemType": "TagSpecification", "UpdateType": "Immutable" }, "AuthenticationOptions": { "Type": "List", "Required": true, "MarkdownDocumentation": "`AuthenticationOptions`\n\nInformation about the authentication method to be used to authenticate clients.\n*Required*: Yes\n*Type*: Array of [ClientAuthenticationRequest](./aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions", "ItemType": "ClientAuthenticationRequest", "UpdateType": "Immutable" }, "ServerCertificateArn": { "Required": true, "MarkdownDocumentation": "`ServerCertificateArn`\n\nThe ARN of the server certificate. For more information, see\nthe [AWS Certificate Manager User Guide](https://docs.aws.amazon.com/acm/latest/userguide/).\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SessionTimeoutHours": { "Required": false, "MarkdownDocumentation": "`SessionTimeoutHours`\n\nThe maximum VPN session duration time in hours.\nValid values: `8 | 10 | 12 | 24`\nDefault value: `24`\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-sessiontimeouthours", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "DnsServers": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`DnsServers`\n\nInformation about the DNS servers to be used for DNS resolution. A Client VPN endpoint can\nhave up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers", "UpdateType": "Mutable" }, "SecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-securitygroupids", "UpdateType": "Mutable" }, "DisconnectOnSessionTimeout": { "Required": false, "MarkdownDocumentation": "`DisconnectOnSessionTimeout`\n\nIndicates whether the client VPN session is disconnected after the maximum `sessionTimeoutHours` is reached. If `true`, users are prompted to reconnect client VPN. If `false`, client VPN attempts to reconnect automatically. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-disconnectonsessiontimeout", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ConnectionLogOptions": { "Type": "ConnectionLogOptions", "Required": true, "MarkdownDocumentation": "`ConnectionLogOptions`\n\nInformation about the client connection logging options.\nIf you enable client connection logging, data about client connections is sent to a\nCloudwatch Logs log stream. The following information is logged:\n* Client connection requests\n* Client connection results (successful and unsuccessful)\n* Reasons for unsuccessful client connection requests\n* Client connection termination time\n*Required*: Yes\n*Type*: [ConnectionLogOptions](./aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions", "UpdateType": "Mutable" }, "SplitTunnel": { "Required": false, "MarkdownDocumentation": "`SplitTunnel`\n\nIndicates whether split-tunnel is enabled on the AWS Client VPN endpoint.\nBy default, split-tunnel on a VPN endpoint is disabled.\nFor information about split-tunnel VPN endpoints, see [Split-tunnel AWS Client VPN endpoint](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the\n*AWS Client VPN Administrator 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "TrafficIpAddressType": { "Required": false, "MarkdownDocumentation": "`TrafficIpAddressType`\n\nThe IP address type of the Client VPN endpoint. Possible values are either `ipv4` for IPv4 addressing only, `ipv6` for IPv6 addressing only, or `dual-stack` for both IPv4 and IPv6 addressing.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dual-stack...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dual-stack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-trafficipaddresstype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ClientLoginBannerOptions": { "Type": "ClientLoginBannerOptions", "Required": false, "MarkdownDocumentation": "`ClientLoginBannerOptions`\n\nOptions for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is\nestablished.\n*Required*: No\n*Type*: [ClientLoginBannerOptions](./aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions", "UpdateType": "Mutable" }, "VpcId": { "Required": false, "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpcid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SelfServicePortal": { "Required": false, "MarkdownDocumentation": "`SelfServicePortal`\n\nSpecify whether to enable the self-service portal for the Client VPN endpoint.\nDefault Value: `enabled`\n*Required*: No\n*Type*: String\n*Allowed values*: `enabled | disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enabled", "disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-selfserviceportal", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TransportProtocol": { "Required": false, "MarkdownDocumentation": "`TransportProtocol`\n\nThe transport protocol to be used by the VPN session.\nDefault value: `udp`\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)\n", "RefReturnValue": "", "AllowedValues": [ "tcp", "udp" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol", "PrimitiveType": "String", "UpdateType": "Immutable" }, "EndpointIpAddressType": { "Required": false, "MarkdownDocumentation": "`EndpointIpAddressType`\n\nThe IP address type of the Client VPN endpoint. Possible values are `ipv4` for IPv4 addressing only, `ipv6` for IPv6 addressing only, or `dual-stack` for both IPv4 and IPv6 addressing.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dual-stack...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dual-stack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-endpointipaddresstype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "VpnPort": { "Required": false, "MarkdownDocumentation": "`VpnPort`\n\nThe port number to assign to the Client VPN endpoint for TCP and UDP traffic.\nValid Values: `443` | `1194`\nDefault Value: `443`\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::EC2::ClientVpnRoute": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnRoute`\n\nSpecifies a network route to add to a Client VPN endpoint. Each Client VPN endpoint has\na route table that describes the available destination network routes. Each route in the\nroute table specifies the path for traffic to specific resources or networks.\nA target network association must be created before you can specify a route. If you're\nsetting up all the components of a Client VPN endpoint at the same time, you must use the\n[DependsOn\nAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the\n`AWS::EC2::ClientVpnTargetNetworkAssociation` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html", "Properties": { "ClientVpnEndpointId": { "Required": true, "MarkdownDocumentation": "`ClientVpnEndpointId`\n\nThe ID of the Client VPN endpoint to which to add the route.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-clientvpnendpointid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "TargetVpcSubnetId": { "Required": true, "MarkdownDocumentation": "`TargetVpcSubnetId`\n\nThe ID of the subnet through which you want to route traffic. The specified subnet must be\nan existing target network of the Client VPN endpoint.\nAlternatively, if you're adding a route for the local network, specify `local`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-targetvpcsubnetid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA brief description 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-description", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DestinationCidrBlock": { "Required": true, "MarkdownDocumentation": "`DestinationCidrBlock`\n\nThe IPv4 address range, in CIDR notation, of the route destination. For example:\n* To add a route for Internet access, enter `0.0.0.0/0`\n* To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range\n* To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range\n* To add a route for the local network, enter the client CIDR range\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-destinationcidrblock", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::EC2::ClientVpnTargetNetworkAssociation": { "MarkdownDocumentation": "`AWS::EC2::ClientVpnTargetNetworkAssociation`\n\nSpecifies a target network to associate with a Client VPN endpoint. A target network is\na subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN\nendpoint. You can associate only one subnet in each Availability Zone. We recommend that\nyou associate at least two subnets to provide Availability Zone redundancy.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the association ID. For example:\n`cvpn-assoc-1234567890abcdef0`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html", "Properties": { "ClientVpnEndpointId": { "Required": true, "MarkdownDocumentation": "`ClientVpnEndpointId`\n\nThe ID of the Client VPN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-clientvpnendpointid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SubnetId": { "Required": true, "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet to associate with the Client VPN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-subnetid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::EC2::CustomerGateway": { "MarkdownDocumentation": "`AWS::EC2::CustomerGateway`\n\nSpecifies a customer gateway.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the customer gateway.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of VPN connection that this customer gateway supports\n(`ipsec.1`).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ipsec.1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ipsec.1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IpAddress": { "MarkdownDocumentation": "`IpAddress`\n\nThe IP address for the customer gateway device's outside interface. The address must be\nstatic. If `OutsideIpAddressType` in your VPN connection options is set to\n`PrivateIpv4`, you can use an RFC6598 or RFC1918 private IPv4 address. If\n`OutsideIpAddressType` is set to `Ipv6`, you can use an IPv6 address.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-ipaddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BgpAsnExtended": { "MarkdownDocumentation": "`BgpAsnExtended`\n\nFor customer gateway devices that support BGP, specify the device's ASN. You must specify either `BgpAsn` or `BgpAsnExtended` when creating the customer gateway. If the ASN is larger than `2,147,483,647`, you must use `BgpAsnExtended`.\nValid values: `2,147,483,648` to `4,294,967,295`\n*Required*: No\n*Type*: Number\n*Minimum*: `2147483648`\n*Maximum*: `4294967294`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasnextended", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "BgpAsn": { "MarkdownDocumentation": "`BgpAsn`\n\nFor customer gateway devices that support BGP, specify the device's ASN. You must specify either `BgpAsn` or `BgpAsnExtended` when creating the customer gateway. If the ASN is larger than `2,147,483,647`, you must use `BgpAsnExtended`.\nDefault: 65000\nValid values: `1` to `2,147,483,647`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOne or more tags for the customer gateway.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-customergateway-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) for the customer gateway certificate.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso([a-z]{1})?))?-[a-z]+-\\d{1}:\\d{12}:certificate\\/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-certificatearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe name of customer gateway device.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-devicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CustomerGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CustomerGatewayId`\n\nThe ID of the customer gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#CustomerGatewayId-fn::getatt" } } }, "AWS::EC2::DHCPOptions": { "MarkdownDocumentation": "`AWS::EC2::DHCPOptions`\n\nSpecifies a set of DHCP options for your VPC.\nYou must specify at least one of the following properties:\n`DomainNameServers`, `NetbiosNameServers`,\n`NtpServers`. If you specify `NetbiosNameServers`, you must specify\n`NetbiosNodeType`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html", "Properties": { "NetbiosNameServers": { "MarkdownDocumentation": "`NetbiosNameServers`\n\nThe IPv4 addresses of up to four NetBIOS name servers.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnameservers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NtpServers": { "MarkdownDocumentation": "`NtpServers`\n\nThe IPv4 addresses of up to four Network Time Protocol (NTP) servers.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-ntpservers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThis value is used to complete unqualified DNS hostnames. If you're using\nAmazonProvidedDNS in `us-east-1`, specify `ec2.internal`. If you're\nusing AmazonProvidedDNS in another Region, specify\n*region*.`compute.internal` (for example,\n`ap-northeast-1.compute.internal`). Otherwise, specify a domain name (for\nexample, *MyCompany.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Ipv6AddressPreferredLeaseTime": { "MarkdownDocumentation": "`Ipv6AddressPreferredLeaseTime`\n\nA value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-ipv6addresspreferredleasetime", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "NetbiosNodeType": { "MarkdownDocumentation": "`NetbiosNodeType`\n\nThe NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and\nmulticast are not currently supported).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnodetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DomainNameServers": { "MarkdownDocumentation": "`DomainNameServers`\n\nThe IPv4 addresses of up to four domain name servers, or `AmazonProvidedDNS`.\nThe default is `AmazonProvidedDNS`. To have your instance receive a custom\nDNS hostname as specified in `DomainName`, you must set this property to a\ncustom DNS server.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainnameservers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the DHCP options set.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-dhcpoptions-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "DhcpOptionsId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DhcpOptionsId`\n\nThe ID of the DHCP options set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#DhcpOptionsId-fn::getatt" } } }, "AWS::EC2::EC2Fleet": { "MarkdownDocumentation": "`AWS::EC2::EC2Fleet`\n\nSpecifies the configuration information to launch a fleet--or group--of instances. An\nEC2 Fleet can launch multiple instance types across multiple Availability Zones, using the\nOn-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using\nEC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the\ninstance types that work best for your applications, and specify how Amazon EC2 should\ndistribute your fleet capacity within each purchasing model. For more information, see\n[Launching an\nEC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the fleet ID, such as\n`fleet-1fe24079-d272-4023-8e7c-70e10784cb0e`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html", "Properties": { "Context": { "MarkdownDocumentation": "`Context`\n\nReserved.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-context", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetCapacitySpecification": { "MarkdownDocumentation": "`TargetCapacitySpecification`\n\nThe number of units to request.\n*Required*: Yes\n*Type*: [TargetCapacitySpecificationRequest](./aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-targetcapacityspecification", "UpdateType": "Mutable", "Required": true, "Type": "TargetCapacitySpecificationRequest" }, "OnDemandOptions": { "MarkdownDocumentation": "`OnDemandOptions`\n\nDescribes the configuration of On-Demand Instances in an EC2 Fleet.\n*Required*: No\n*Type*: [OnDemandOptionsRequest](./aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-ondemandoptions", "UpdateType": "Immutable", "Required": false, "Type": "OnDemandOptionsRequest" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe fleet type. The default value is `maintain`.\n* `maintain` - The EC2 Fleet places an asynchronous request for your desired\n capacity, and continues to maintain your desired Spot capacity by replenishing\n interrupted Spot Instances.\n* `request` - The EC2 Fleet places an asynchronous one-time request for your\n desired capacity, but does submit Spot requests in alternative capacity pools if Spot\n capacity is unavailable, and does not maintain Spot capacity if Spot Instances are\n interrupted.\n* `instant` - The EC2 Fleet places a synchronous one-time request for your\n desired capacity, and returns errors for any instances that could not be\n launched.\nFor more information, see [EC2 Fleet\nrequest types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) in the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `maintain | request | instan...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "maintain", "request", "instant" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExcessCapacityTerminationPolicy": { "MarkdownDocumentation": "`ExcessCapacityTerminationPolicy`\n\nIndicates whether running instances should be terminated if the total target capacity of\nthe EC2 Fleet is decreased below the current size of the EC2 Fleet.\nSupported only for fleets of type `maintain`.\n*Required*: No\n*Type*: String\n*Allowed values*: `termination | no-terminatio...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "termination", "no-termination" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-excesscapacityterminationpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagSpecifications": { "MarkdownDocumentation": "`TagSpecifications`\n\nThe key-value pair for tagging the EC2 Fleet request on creation. For more information, see\n[Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources).\nIf the fleet type is `instant`, specify a resource type of `fleet`\nto tag the fleet or `instance` to tag the instances at launch.\nIf the fleet type is `maintain` or `request`, specify a resource\ntype of `fleet` to tag the fleet. You cannot specify a resource type of\n`instance`. To tag instances at launch, specify the tags in a [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template).\n*Required*: No\n*Type*: Array of [TagSpecification](./aws-properties-ec2-ec2fleet-tagspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-tagspecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "TagSpecification", "DuplicatesAllowed": true }, "SpotOptions": { "MarkdownDocumentation": "`SpotOptions`\n\nDescribes the configuration of Spot Instances in an EC2 Fleet.\n*Required*: No\n*Type*: [SpotOptionsRequest](./aws-properties-ec2-ec2fleet-spotoptionsrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-spotoptions", "UpdateType": "Immutable", "Required": false, "Type": "SpotOptionsRequest" }, "ValidFrom": { "MarkdownDocumentation": "`ValidFrom`\n\nThe start date and time of the request, in UTC format (for example,\n*YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).\nThe default is to start fulfilling the request immediately.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validfrom", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ReplaceUnhealthyInstances": { "MarkdownDocumentation": "`ReplaceUnhealthyInstances`\n\nIndicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for\nfleets of type `maintain`. For more information, see [EC2 Fleet\nhealth checks](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) in the *Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-replaceunhealthyinstances", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "LaunchTemplateConfigs": { "MarkdownDocumentation": "`LaunchTemplateConfigs`\n\nThe configuration for the EC2 Fleet.\n*Required*: Yes\n*Type*: Array of [FleetLaunchTemplateConfigRequest](./aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-launchtemplateconfigs", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "FleetLaunchTemplateConfigRequest", "DuplicatesAllowed": true }, "TerminateInstancesWithExpiration": { "MarkdownDocumentation": "`TerminateInstancesWithExpiration`\n\nIndicates whether running instances should be terminated when the EC2 Fleet expires.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-terminateinstanceswithexpiration", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ValidUntil": { "MarkdownDocumentation": "`ValidUntil`\n\nThe end date and time of the request, in UTC format (for example,\n*YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).\nAt this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validuntil", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "FleetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FleetId`\n\nThe ID of the EC2 Fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#FleetId-fn::getatt" } } }, "AWS::EC2::EIP": { "MarkdownDocumentation": "`AWS::EC2::EIP`\n\nSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon\nEC2 instance.\nYou can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought\nto AWS for use with your AWS resources using bring your\nown IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html)\nin the *Amazon EC2 User Guide*.\nFor more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)\nin the *Amazon EC2 User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Elastic IP address.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html", "Properties": { "Address": { "MarkdownDocumentation": "`Address`\n\nAn Elastic IP address or a carrier IP address in a Wavelength 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-address", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\nThe ID of the instance.\n###### Important\nUpdates to the `InstanceId` property may require *some\ninterruptions*. Updates on an EIP reassociates the address on its\nassociated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-instanceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpamPoolId": { "MarkdownDocumentation": "`IpamPoolId`\n\nThe ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see [Allocate sequential Elastic IP addresses from an IPAM pool](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-eip-pool.html) in the *Amazon VPC IPAM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-ipampoolid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PublicIpv4Pool": { "MarkdownDocumentation": "`PublicIpv4Pool`\n\nThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an\naddress from the address pool.\n###### Important\nUpdates to the `PublicIpv4Pool` property may require *some\ninterruptions*. Updates on an EIP reassociates the address on its\nassociated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-publicipv4pool", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransferAddress": { "MarkdownDocumentation": "`TransferAddress`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-transferaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe network (`vpc`).\nIf you define an Elastic IP address and associate it with a VPC that is defined in the\nsame template, you must declare a dependency on the VPC-gateway attachment by using the\n [DependsOn\nAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.\n*Required*: No\n*Type*: String\n*Allowed values*: `vpc | standard...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "vpc", "standard" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-domain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the Elastic IP address.\n###### Important\nUpdates to the `Tags` property may require *some\ninterruptions*. Updates on an EIP reassociates the address on its\nassociated resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-eip-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "NetworkBorderGroup": { "MarkdownDocumentation": "`NetworkBorderGroup`\n\nA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS\nadvertises IP addresses. Use this parameter to limit the IP address to this location. IP\naddresses 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.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-networkbordergroup", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "PublicIp": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublicIp`\n\nThe Elastic IP address.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#PublicIp-fn::getatt" }, "AllocationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AllocationId`\n\nThe ID that AWS assigns to represent the allocation of the address for\nuse with Amazon VPC. This is returned only for VPC elastic IP addresses. For example,\n`eipalloc-5723d13e`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#AllocationId-fn::getatt" } } }, "AWS::EC2::EIPAssociation": { "MarkdownDocumentation": "`AWS::EC2::EIPAssociation`\n\nAssociates an Elastic IP address with an instance or a network interface. Before you can\nuse an Elastic IP address, you must allocate it to your account. For more information about\nworking with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview).\nYou must specify `AllocationId` and either `InstanceId`,\n`NetworkInterfaceId`, or `PrivateIpAddress`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the association.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html", "Properties": { "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-privateipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\nThe ID of the instance. The instance must have exactly one attached network interface.\nYou can specify either the instance ID or the network interface ID, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-instanceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AllocationId": { "MarkdownDocumentation": "`AllocationId`\n\nThe allocation ID. This 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-allocationid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.\nYou can specify either the instance ID or the network interface ID, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-networkinterfaceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#Id-fn::getatt" } } }, "AWS::EC2::EgressOnlyInternetGateway": { "MarkdownDocumentation": "`AWS::EC2::EgressOnlyInternetGateway`\n\n[IPv6 only] Specifies an egress-only internet gateway for your VPC. An egress-only\ninternet gateway is used to enable outbound communication over IPv6 from instances in your\nVPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6\nconnection with your instance.\nFor more information, see [Egress-only internet gateway](https://docs.aws.amazon.com/vpc/latest/userguide/egress-only-internet-gateway.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the egress-only internet gateway (the physical\nresource ID).\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html#cfn-ec2-egressonlyinternetgateway-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the egress-only internet gateway.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-egressonlyinternetgateway-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html#cfn-ec2-egressonlyinternetgateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the egress-only internet gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html#Id-fn::getatt" } } }, "AWS::EC2::EnclaveCertificateIamRoleAssociation": { "MarkdownDocumentation": "`AWS::EC2::EnclaveCertificateIamRoleAssociation`\n\nAssociates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate.\nThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more\ninformation, see [AWS Certificate Manager for Nitro Enclaves](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html) in the *AWS Nitro Enclaves\nUser Guide*.\nWhen the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted\nprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate\nis encrypted with an AWS managed key that has an attached attestation-based key policy.\nTo enable the IAM role to access the Amazon S3 object, you must grant it permission to call `s3:GetObject`\non the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\nyou must grant it permission to call `kms:Decrypt` on the KMS key returned by the command.\nFor more information, see [Grant the role permission to access the certificate and encryption key](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy) in the\n*AWS Nitro Enclaves User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IAM role and ACM certificate association.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html", "Properties": { "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM\ncertificate.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[A-Za-z0-9-]{0,64}:iam:.*:([0-9]{12})?:role/.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#cfn-ec2-enclavecertificateiamroleassociation-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe ARN of the ACM certificate with which to associate the IAM role.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[A-Za-z0-9-]{0,64}:acm:[A-Za-z0-9-]{1,64}:([0-9]{12})?:certificate/.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#cfn-ec2-enclavecertificateiamroleassociation-certificatearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "EncryptionKmsKeyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EncryptionKmsKeyId`\n\nThe ID of the AWS KMS key used to encrypt the private key of the\ncertificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#EncryptionKmsKeyId-fn::getatt" }, "CertificateS3BucketName": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateS3BucketName`\n\nThe name of the Amazon S3 bucket to which the certificate was uploaded.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#CertificateS3BucketName-fn::getatt" }, "CertificateS3ObjectKey": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateS3ObjectKey`\n\nThe Amazon S3 object key where the certificate, certificate chain, and encrypted private\nkey bundle are stored. The object key is formatted as follows:\n`role_arn`/`certificate_arn`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#CertificateS3ObjectKey-fn::getatt" } } }, "AWS::EC2::FlowLog": { "MarkdownDocumentation": "`AWS::EC2::FlowLog`\n\nSpecifies a VPC flow log that captures IP traffic for a specified network interface,\nsubnet, or VPC. To view the log data, use Amazon CloudWatch Logs (CloudWatch Logs) to help\ntroubleshoot connection issues. For example, you can use a flow log to investigate why\ncertain traffic isn't reaching an instance, which can help you diagnose overly restrictive\nsecurity group rules. For more information, see [VPC Flow Logs](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) in the\n*Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the flow log ID, such as\n`fl-123456abc123abc1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html", "Properties": { "LogFormat": { "MarkdownDocumentation": "`LogFormat`\n\nThe fields to include in the flow log record, in the order in which they should appear.\nIf you omit this parameter, the flow log is created using the default format. If you specify\nthis parameter, you must include at least one field. For more information about the available fields,\nsee [Flow log\nrecords](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) in the *Amazon VPC User Guide* or [Transit Gateway\nFlow Log records](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) in the *AWS Transit Gateway Guide*.\nSpecify the fields using the `${field-id}` format, separated by\nspaces.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the resource to monitor. For example, if the resource type is\n`VPC`, specify the ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MaxAggregationInterval": { "MarkdownDocumentation": "`MaxAggregationInterval`\n\nThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.\nThe possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\nThis parameter must be 60 seconds for transit gateway resource types.\nWhen a network interface is attached to a [Nitro-based\ninstance](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html), the aggregation interval is always 60 seconds or less, regardless\nof the value that you specify.\nDefault: 600\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-maxaggregationinterval", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DestinationOptions": { "MarkdownDocumentation": "`DestinationOptions`\n\nThe destination options.\n*Required*: No\n*Type*: [DestinationOptions](./aws-properties-ec2-flowlog-destinationoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-destinationoptions", "UpdateType": "Immutable", "Required": false, "Type": "DestinationOptions" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource to monitor.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NetworkInterface | Subnet |...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "NetworkInterface", "Subnet", "VPC", "TransitGateway", "TransitGatewayAttachment", "RegionalNatGateway" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourcetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeliverCrossAccountRole": { "MarkdownDocumentation": "`DeliverCrossAccountRole`\n\nThe ARN of the IAM role that allows the service to publish flow logs across accounts.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-delivercrossaccountrole", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogDestination": { "MarkdownDocumentation": "`LogDestination`\n\nThe destination for the flow log data. The meaning of this parameter depends on the destination type.\n* If the destination type is `cloud-watch-logs`, specify the ARN of a CloudWatch Logs log group. For example:\n \n arn:aws:logs:*region*:*account\\_id*:log-group:*my\\_group*\n \n Alternatively, use the `LogGroupName` parameter.\n* If the destination type is `s3`, specify the ARN of an S3 bucket. For example:\n \n arn:aws:s3:::*my\\_bucket*/*my\\_subfolder*/\n \n The subfolder is optional. Note that you can't use `AWSLogs` as a subfolder name.\n* If the destination type is `kinesis-data-firehose`, specify the ARN of a Kinesis Data Firehose delivery stream. For example:\n \n arn:aws:firehose:*region*:*account\\_id*:deliverystream:*my\\_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.\nThis parameter is valid only if the destination type is `cloud-watch-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeliverLogsPermissionArn": { "MarkdownDocumentation": "`DeliverLogsPermissionArn`\n\nThe ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.\nThis parameter is required if the destination type is `cloud-watch-logs`,\nor if the destination type is `kinesis-data-firehose` and the delivery stream\nand the resources to monitor are in different accounts.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogDestinationType": { "MarkdownDocumentation": "`LogDestinationType`\n\nThe type of destination for the flow log data.\nDefault: `cloud-watch-logs`\n*Required*: No\n*Type*: String\n*Allowed values*: `cloud-watch-logs | s3 | kin...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "cloud-watch-logs", "s3", "kinesis-data-firehose" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestinationtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the flow logs.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-flowlog-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "TrafficType": { "MarkdownDocumentation": "`TrafficType`\n\nThe type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).\nThis parameter is not supported for transit gateway resource types. It is required for\nthe other resource types.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCEPT | ALL | REJECT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ACCEPT", "ALL", "REJECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-traffictype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the flow log. For example, `fl-123456abc123abc1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#Id-fn::getatt" } } }, "AWS::EC2::GatewayRouteTableAssociation": { "MarkdownDocumentation": "`AWS::EC2::GatewayRouteTableAssociation`\n\nAssociates a virtual private gateway or internet gateway with a route table. The gateway\nand route table must be in the same VPC. This association causes the incoming traffic to\nthe gateway to be routed according to the routes in the route table.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the association.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html", "Properties": { "RouteTableId": { "MarkdownDocumentation": "`RouteTableId`\n\nThe ID of the route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-routetableid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GatewayId": { "MarkdownDocumentation": "`GatewayId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-gatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationId`\n\nThe ID of the route table association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#AssociationId-fn::getatt" } } }, "AWS::EC2::Host": { "MarkdownDocumentation": "`AWS::EC2::Host`\n\nAllocates a fully dedicated physical server for launching EC2 instances. Because the\nhost is fully dedicated for your use, it can help you address compliance requirements and\nreduce costs by allowing you to use your existing server-bound software licenses. For more\ninformation, see [Dedicated Hosts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) in\nthe *Amazon EC2 User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the host ID, such as\n`h-0ab123c45d67ef89`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html", "Properties": { "HostRecovery": { "MarkdownDocumentation": "`HostRecovery`\n\nIndicates whether to enable or disable host recovery for the Dedicated Host. Host\nrecovery is disabled by default. For more information, see [Host recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html)\nin the *Amazon EC2 User Guide*.\nDefault: `off`\n*Required*: No\n*Type*: String\n*Allowed values*: `on | off`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "on", "off" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostrecovery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceFamily": { "MarkdownDocumentation": "`InstanceFamily`\n\nThe instance family supported by the Dedicated Host. For example,\n`m5`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancefamily", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AutoPlacement": { "MarkdownDocumentation": "`AutoPlacement`\n\nIndicates whether the host accepts any untargeted instance launches that match its\ninstance type configuration, or if it only accepts Host tenancy instance launches that\nspecify its unique host ID. For more information, see [Understanding auto-placement and affinity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) in the\n*Amazon EC2 User Guide*.\nDefault: `off`\n*Required*: No\n*Type*: String\n*Allowed values*: `on | off`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "on", "off" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-autoplacement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutpostArn": { "MarkdownDocumentation": "`OutpostArn`\n\nThe Amazon Resource Name (ARN) of the AWS Outpost on which the\nDedicated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-outpostarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HostMaintenance": { "MarkdownDocumentation": "`HostMaintenance`\n\nIndicates whether host maintenance is enabled or disabled for the Dedicated\nHost.\n*Required*: No\n*Type*: String\n*Allowed values*: `on | off`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "on", "off" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostmaintenance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone in which to allocate the Dedicated Host.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-availabilityzone", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nSpecifies the instance type to be supported by the Dedicated Hosts. If you specify an\ninstance type, the Dedicated Hosts support instances of the specified instance type\nonly.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AssetId": { "MarkdownDocumentation": "`AssetId`\n\nThe ID of the Outpost hardware asset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-assetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the Dedicated Host.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-host-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "HostId": { "PrimitiveType": "String", "MarkdownDocumentation": "`HostId`\n\nThe ID of the host.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#HostId-fn::getatt" } } }, "AWS::EC2::IPAM": { "MarkdownDocumentation": "`AWS::EC2::IPAM`\n\nIPAM is a VPC feature that you can use to automate your IP address management\nworkflows including assigning, tracking, troubleshooting, and auditing IP addresses\nacross AWS Regions and accounts throughout your AWS\nOrganization. For more information, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the\n*Amazon VPC IPAM User Guide*.\nThere are AWS Identity and Access Management (IAM) permissions required\nto fully manage an IPAM in CloudFormation. For more information, see [Example\npolicy](https://docs.aws.amazon.com/vpc/latest/ipam/iam-ipam-policy-examples.html) in the *Amazon VPC IPAM User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IPAM ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html", "Properties": { "DefaultResourceDiscoveryOrganizationalUnitExclusions": { "MarkdownDocumentation": "`DefaultResourceDiscoveryOrganizationalUnitExclusions`\n\nIf your IPAM is integrated with AWS Organizations,\nyou can exclude an [organizational unit (OU)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#organizationalunit) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see [Exclude organizational units from IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html) in the *Amazon Virtual Private Cloud IP Address Manager User Guide*.\n*Required*: No\n*Type*: Array of [IpamOrganizationalUnitExclusion](./aws-properties-ec2-ipam-ipamorganizationalunitexclusion.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-defaultresourcediscoveryorganizationalunitexclusions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpamOrganizationalUnitExclusion", "DuplicatesAllowed": false }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MeteredAccount": { "MarkdownDocumentation": "`MeteredAccount`\n\nA metered account is an AWS account that is charged for active IP addresses managed in IPAM. For more information, see [Enable cost distribution](https://docs.aws.amazon.com/vpc/latest/ipam/ipam-enable-cost-distro.html) in the *Amazon VPC IPAM User Guide*.\nPossible values:\n* `ipam-owner` (default): The AWS account which owns the IPAM is charged for all active IP addresses managed in IPAM.\n* `resource-owner`: The AWS account that owns the IP address is charged for the active IP address.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipam-owner | resource-owner...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ipam-owner", "resource-owner" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-meteredaccount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tier": { "MarkdownDocumentation": "`Tier`\n\nIPAM is offered in a Free Tier and an Advanced Tier. For more information about the\nfeatures available in each tier and the costs associated with the tiers, see the [VPC IPAM product pricing page](https://aws.amazon.com/vpc/pricing/).\n*Required*: No\n*Type*: String\n*Allowed values*: `free | advanced...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "free", "advanced" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnablePrivateGua": { "MarkdownDocumentation": "`EnablePrivateGua`\n\nEnable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-enableprivategua", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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.\nFor 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*: Array of [Tag](./aws-properties-ec2-ipam-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "OperatingRegions": { "MarkdownDocumentation": "`OperatingRegions`\n\nThe 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*: Array of [IpamOperatingRegion](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpamOperatingRegion", "DuplicatesAllowed": false } }, "Attributes": { "DefaultResourceDiscoveryAssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefaultResourceDiscoveryAssociationId`\n\nThe ID of the default resource discovery association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#DefaultResourceDiscoveryAssociationId-fn::getatt" }, "DefaultResourceDiscoveryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefaultResourceDiscoveryId`\n\nThe ID of the default resource discovery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#DefaultResourceDiscoveryId-fn::getatt" }, "IpamId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamId`\n\nThe ID of the IPAM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#IpamId-fn::getatt" }, "ResourceDiscoveryAssociationCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ResourceDiscoveryAssociationCount`\n\nThe number of resource discovery associations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#ResourceDiscoveryAssociationCount-fn::getatt" }, "ScopeCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ScopeCount`\n\nThe number of scopes.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#ScopeCount-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the IPAM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#Arn-fn::getatt" }, "PrivateDefaultScopeId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrivateDefaultScopeId`\n\nThe ID of the default private scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#PrivateDefaultScopeId-fn::getatt" }, "PublicDefaultScopeId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublicDefaultScopeId`\n\nThe ID of the default public scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#PublicDefaultScopeId-fn::getatt" } } }, "AWS::EC2::IPAMAllocation": { "MarkdownDocumentation": "`AWS::EC2::IPAMAllocation`\n\nIn IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the pool ID, allocation ID, and CIDR joined with \"|\" as a separator.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the allocation.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR you would like to allocate from the IPAM pool. Note the following:\n* If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.\n* If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.\nPossible values: Any available IPv4 or IPv6 CIDR.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-cidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetmaskLength": { "MarkdownDocumentation": "`NetmaskLength`\n\nThe netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:\n* If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.\n* If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.\nPossible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-netmasklength", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "IpamPoolId": { "MarkdownDocumentation": "`IpamPoolId`\n\nThe ID of the IPAM pool from which you would like to allocate a CIDR.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-ipampoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "IpamPoolAllocationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamPoolAllocationId`\n\nThe ID of an allocation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#IpamPoolAllocationId-fn::getatt" } } }, "AWS::EC2::IPAMPool": { "MarkdownDocumentation": "`AWS::EC2::IPAMPool`\n\nIn IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IPAM pool ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html", "Properties": { "AwsService": { "MarkdownDocumentation": "`AwsService`\n\nLimits which service in AWS that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.\n*Required*: No\n*Type*: String\n*Allowed values*: `ec2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ec2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Locale": { "MarkdownDocumentation": "`Locale`\n\nThe locale of the IPAM pool.\nThe locale for the pool should be one of the following:\n* An AWS Region where you want this IPAM pool to be available for allocations.\n* The network border group for an AWS Local Zone where you want this IPAM pool to be available for allocations ([supported Local Zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail)). This option is only available for IPAM IPv4 pools in the public scope.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PublicIpSource": { "MarkdownDocumentation": "`PublicIpSource`\n\nThe 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*.\nBy 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*: `byoip | amazon...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "byoip", "amazon" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publicipsource", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the IPAM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceResource": { "MarkdownDocumentation": "`SourceResource`\n\nThe resource used to provision CIDRs to a resource planning pool.\n*Required*: No\n*Type*: [SourceResource](./aws-properties-ec2-ipampool-sourceresource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceresource", "UpdateType": "Immutable", "Required": false, "Type": "SourceResource" }, "SourceIpamPoolId": { "MarkdownDocumentation": "`SourceIpamPoolId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceipampoolid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AllocationMinNetmaskLength": { "MarkdownDocumentation": "`AllocationMinNetmaskLength`\n\nThe minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationminnetmasklength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IpamScopeId": { "MarkdownDocumentation": "`IpamScopeId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-ipamscopeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProvisionedCidrs": { "MarkdownDocumentation": "`ProvisionedCidrs`\n\nInformation about the CIDRs provisioned to an IPAM pool.\n*Required*: No\n*Type*: Array of [ProvisionedCidr](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-provisionedcidrs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ProvisionedCidr", "DuplicatesAllowed": false }, "AllocationMaxNetmaskLength": { "MarkdownDocumentation": "`AllocationMaxNetmaskLength`\n\nThe maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationmaxnetmasklength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AllocationDefaultNetmaskLength": { "MarkdownDocumentation": "`AllocationDefaultNetmaskLength`\n\nThe default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and\nyou enter 16 here, new allocations will default to 10.0.0.0/16.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationdefaultnetmasklength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AutoImport": { "MarkdownDocumentation": "`AutoImport`\n\nIf selected, IPAM will continuously look for resources within the CIDR range of this pool\nand automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\nthese resources must not already be allocated to other resources in order for the import to succeed. IPAM will import\na CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently\nmarked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM\ndiscovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\nA locale must be set on the pool for this feature to work.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-autoimport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AddressFamily": { "MarkdownDocumentation": "`AddressFamily`\n\nThe address family of the pool.\n*Required*: Yes\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)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-addressfamily", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AllocationResourceTags": { "MarkdownDocumentation": "`AllocationResourceTags`\n\nTags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-ipampool-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationresourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "PubliclyAdvertisable": { "MarkdownDocumentation": "`PubliclyAdvertisable`\n\nDetermines 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publiclyadvertisable", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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.\nFor 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*: Array of [Tag](./aws-properties-ec2-ipampool-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "IpamPoolId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamPoolId`\n\nThe ID of the IPAM pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#IpamPoolId-fn::getatt" }, "IpamArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamArn`\n\nThe ARN of the IPAM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#IpamArn-fn::getatt" }, "PoolDepth": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`PoolDepth`\n\nThe depth of pools in your IPAM pool. The pool depth quota is 10.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#PoolDepth-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the IPAM pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#State-fn::getatt" }, "IpamScopeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamScopeArn`\n\nThe ARN of the scope of the IPAM pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#IpamScopeArn-fn::getatt" }, "IpamScopeType": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamScopeType`\n\nThe scope of the IPAM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#IpamScopeType-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the IPAM pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#Arn-fn::getatt" }, "StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StateMessage`\n\nA message related to the failed creation of an IPAM pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#StateMessage-fn::getatt" } } }, "AWS::EC2::IPAMPoolCidr": { "MarkdownDocumentation": "`AWS::EC2::IPAMPoolCidr`\n\nA CIDR provisioned to an IPAM pool.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IPAM pool ID and IPAM pool CIDR ID in the following format: `ipam-pool-01123456|ipam-pool-cidr-0123456`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html", "Properties": { "Cidr": { "MarkdownDocumentation": "`Cidr`\n\nThe CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask)\nand 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-cidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetmaskLength": { "MarkdownDocumentation": "`NetmaskLength`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-netmasklength", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "IpamPoolId": { "MarkdownDocumentation": "`IpamPoolId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-ipampoolid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "IpamPoolCidrId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamPoolCidrId`\n\nThe IPAM pool CIDR ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#IpamPoolCidrId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the CIDR.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#State-fn::getatt" } } }, "AWS::EC2::IPAMResourceDiscovery": { "MarkdownDocumentation": "`AWS::EC2::IPAMResourceDiscovery`\n\nA resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource discovery ID. For example: `ipam-res-disco-111122223333`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html", "Properties": { "OrganizationalUnitExclusions": { "MarkdownDocumentation": "`OrganizationalUnitExclusions`\n\nIf your IPAM is integrated with AWS Organizations,\nyou can exclude an [organizational unit (OU)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#organizationalunit) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see [Exclude organizational units from IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html) in the *Amazon Virtual Private Cloud IP Address Manager User Guide*.\n*Required*: No\n*Type*: Array of [IpamResourceDiscoveryOrganizationalUnitExclusion](./aws-properties-ec2-ipamresourcediscovery-ipamresourcediscoveryorganizationalunitexclusion.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-organizationalunitexclusions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpamResourceDiscoveryOrganizationalUnitExclusion", "DuplicatesAllowed": false }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA 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*: Array of [Tag](./aws-properties-ec2-ipamresourcediscovery-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "OperatingRegions": { "MarkdownDocumentation": "`OperatingRegions`\n\nThe 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*: Array of [IpamOperatingRegion](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-operatingregions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpamOperatingRegion", "DuplicatesAllowed": false } }, "Attributes": { "IsDefault": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefault`\n\nDefines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#IsDefault-fn::getatt" }, "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe owner ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#OwnerId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe resource discovery's state.\n* `create-in-progress` - Resource discovery is being created.\n* `create-complete` - Resource discovery creation is complete.\n* `create-failed` - Resource discovery creation has failed.\n* `modify-in-progress` - Resource discovery is being modified.\n* `modify-complete` - Resource discovery modification is complete.\n* `modify-failed` - Resource discovery modification has failed.\n* `delete-in-progress` - Resource discovery is being deleted.\n* `delete-complete` - Resource discovery deletion is complete.\n* `delete-failed` - Resource discovery deletion has failed.\n* `isolate-in-progress` - AWS account that created the resource discovery has been removed and the resource discovery is being isolated.\n* `isolate-complete` - Resource discovery isolation is complete.\n* `restore-in-progress` - AWS account that created the resource discovery and was isolated has been restored.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#State-fn::getatt" }, "IpamResourceDiscoveryRegion": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamResourceDiscoveryRegion`\n\nThe resource discovery Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#IpamResourceDiscoveryRegion-fn::getatt" }, "IpamResourceDiscoveryArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamResourceDiscoveryArn`\n\nThe resource discovery ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#IpamResourceDiscoveryArn-fn::getatt" }, "IpamResourceDiscoveryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamResourceDiscoveryId`\n\nThe resource discovery ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#IpamResourceDiscoveryId-fn::getatt" } } }, "AWS::EC2::IPAMResourceDiscoveryAssociation": { "MarkdownDocumentation": "`AWS::EC2::IPAMResourceDiscoveryAssociation`\n\nAn IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource discovery ID. For example: `ipam-res-disco-111122223333`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html", "Properties": { "IpamId": { "MarkdownDocumentation": "`IpamId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-ipamid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA 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*: Array of [Tag](./aws-properties-ec2-ipamresourcediscoveryassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "IpamResourceDiscoveryId": { "MarkdownDocumentation": "`IpamResourceDiscoveryId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-ipamresourcediscoveryid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "IsDefault": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefault`\n\nDefines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#IsDefault-fn::getatt" }, "ResourceDiscoveryStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceDiscoveryStatus`\n\nThe resource discovery status.\n* `active` - Connection or permissions required to read the\n results of the resource discovery are intact.\n* `not-found` - Connection or permissions required to read the\n results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the AWS RAM resource share is still intact.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#ResourceDiscoveryStatus-fn::getatt" }, "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe owner ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#OwnerId-fn::getatt" }, "IpamArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamArn`\n\nThe IPAM ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#IpamArn-fn::getatt" }, "IpamResourceDiscoveryAssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamResourceDiscoveryAssociationId`\n\nThe resource discovery association ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#IpamResourceDiscoveryAssociationId-fn::getatt" }, "IpamResourceDiscoveryAssociationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamResourceDiscoveryAssociationArn`\n\nThe resource discovery association ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#IpamResourceDiscoveryAssociationArn-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe lifecycle state of the association when you associate or disassociate a resource discovery.\n* `associate-in-progress` - Resource discovery is being associated.\n* `associate-complete` - Resource discovery association is complete.\n* `associate-failed` - Resource discovery association has failed.\n* `disassociate-in-progress` - Resource discovery is being disassociated.\n* `disassociate-complete` - Resource discovery disassociation is complete.\n* `disassociate-failed` - Resource discovery disassociation has failed.\n* `isolate-in-progress` - AWS account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.\n* `isolate-complete` - Resource discovery isolation is complete..\n* `restore-in-progress` - Resource discovery is being restored.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#State-fn::getatt" }, "IpamRegion": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamRegion`\n\nThe IPAM home Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#IpamRegion-fn::getatt" } } }, "AWS::EC2::IPAMScope": { "MarkdownDocumentation": "`AWS::EC2::IPAMScope`\n\nIn IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.\nFor more information, see [How IPAM works](https://docs.aws.amazon.com//vpc/latest/ipam/how-it-works-ipam.html) in the *Amazon VPC IPAM User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IPAM scope ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpamId": { "MarkdownDocumentation": "`IpamId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-ipamid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ExternalAuthorityConfiguration": { "MarkdownDocumentation": "`ExternalAuthorityConfiguration`\n\nThe configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.\nFor more information, see [Integrate VPC IPAM with Infoblox infrastructure](https://docs.aws.amazon.com/vpc/latest/ipam/integrate-infoblox-ipam.html) in the *Amazon VPC IPAM User Guide*.\n*Required*: No\n*Type*: [IpamScopeExternalAuthorityConfiguration](./aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-externalauthorityconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IpamScopeExternalAuthorityConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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.\nFor 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*: Array of [Tag](./aws-properties-ec2-ipamscope-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "IpamScopeId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamScopeId`\n\nThe ID of an IPAM scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#IpamScopeId-fn::getatt" }, "IsDefault": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefault`\n\nDefines if the scope is the default scope or not.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#IsDefault-fn::getatt" }, "IpamArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamArn`\n\nThe ARN of an IPAM.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#IpamArn-fn::getatt" }, "IpamScopeType": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpamScopeType`\n\nThe type of the scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#IpamScopeType-fn::getatt" }, "PoolCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`PoolCount`\n\nThe number of pools in a scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#PoolCount-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#Arn-fn::getatt" } } }, "AWS::EC2::Instance": { "MarkdownDocumentation": "`AWS::EC2::Instance`\n\nSpecifies an EC2 instance.\nIf an Elastic IP address is attached to your instance, AWS CloudFormation\nreattaches the Elastic IP address after it updates the instance. For more information about\nupdating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the instance ID. For example:\n`i-1234567890abcdef0`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html", "Properties": { "Tenancy": { "MarkdownDocumentation": "`Tenancy`\n\nThe tenancy of the instance. An instance with a tenancy of `dedicated`\nruns on single-tenant hardware.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | dedicated | host...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "dedicated", "host" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-tenancy", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\n[Default VPC] The names of the security groups. For a nondefault VPC, you\nmust use security group IDs instead.\nYou cannot specify this option and the network interfaces option in the same request.\nThe list can contain both the name of existing Amazon EC2 security groups or references to\nAWS::EC2::SecurityGroup resources created in the template.\nDefault: Amazon EC2 uses the default security group.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-securitygroups", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe primary IPv4 address. You must specify a value from the IPv4 address range\nof the subnet.\nOnly one private IP address can be designated as primary. You can't specify this option\nif you've specified the option to designate a private IP address as the primary IP address\nin a network interface specification. You cannot specify this option if you're launching\nmore than one instance in the request.\nYou cannot specify this option and the network interfaces option in the same\nrequest.\nIf you make an update to an instance that requires replacement, you must assign a new\nprivate IP address. During a replacement, AWS CloudFormation creates a new instance\nbut doesn't delete the old instance until the stack has successfully updated. If the stack\nupdate fails, AWS CloudFormation uses the old instance to roll back the stack to the\nprevious working state. The old and new instances cannot have the same private IP\naddress.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-privateipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UserData": { "MarkdownDocumentation": "`UserData`\n\nThe parameters or scripts to store as user data. Any scripts in user data are run when you launch the instance.\nUser data is limited to 16 KB. You must provide base64-encoded text. For more information, see\n[Fn::Base64](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-base64.html).\nIf the root volume is an EBS volume and you update user data, CloudFormation restarts the instance.\nIf the root volume is an instance store volume and you update user data, the instance is replaced.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-userdata", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "BlockDeviceMappings": { "MarkdownDocumentation": "`BlockDeviceMappings`\n\nThe block device mapping entries that defines the block devices to attach to the\ninstance at launch.\nBy default, the block devices specified in the block device mapping for the AMI are\nused. You can override the AMI block device mapping using the instance block device\nmapping. For the root volume, you can override only the volume size, volume type, volume\nencryption settings, and the `DeleteOnTermination` setting.\n###### Important\nAfter the instance is running, you can modify only the\n`DeleteOnTermination` parameter for the attached volumes without\ninterrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\n*Required*: No\n*Type*: Array of [BlockDeviceMapping](./aws-properties-ec2-instance-blockdevicemapping.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-blockdevicemappings", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "BlockDeviceMapping", "DuplicatesAllowed": true }, "IamInstanceProfile": { "MarkdownDocumentation": "`IamInstanceProfile`\n\nThe name of an IAM instance profile. To create a new IAM instance profile, use the\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-iaminstanceprofile", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ipv6Addresses": { "MarkdownDocumentation": "`Ipv6Addresses`\n\nThe IPv6 addresses from the range of the subnet to associate with the\nprimary network interface. You cannot specify this option and the option to assign a\nnumber of IPv6 addresses in the same request. You cannot specify this option if you've\nspecified a minimum number of instances to launch.\nYou cannot specify this option and the network interfaces option in the same\nrequest.\n*Required*: No\n*Type*: Array of [InstanceIpv6Address](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ipv6addresses", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "InstanceIpv6Address", "DuplicatesAllowed": true }, "KernelId": { "MarkdownDocumentation": "`KernelId`\n\nThe ID of the kernel.\n###### Important\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\ninformation, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-kernelid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet to launch the instance into.\nIf you specify a network interface, you must specify any subnets as part of the\nnetwork interface instead of using 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-subnetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EbsOptimized": { "MarkdownDocumentation": "`EbsOptimized`\n\nIndicates whether the instance is optimized for Amazon EBS I/O. This optimization\nprovides dedicated throughput to Amazon EBS and an optimized configuration stack to\nprovide optimal Amazon EBS I/O performance. This optimization isn't available with all\ninstance types. Additional usage charges apply when using an EBS-optimized\ninstance.\nDefault: `false`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ebsoptimized", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "PropagateTagsToVolumeOnCreation": { "MarkdownDocumentation": "`PropagateTagsToVolumeOnCreation`\n\nIndicates whether to assign the tags specified in the `Tags` property to\nthe volumes specified in the `BlockDeviceMappings` property.\nNote that using this feature does not assign the tags to volumes that are created\nseparately and then attached using `AWS::EC2::VolumeAttachment`.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ElasticGpuSpecifications": { "MarkdownDocumentation": "`ElasticGpuSpecifications`\n\nAn elastic GPU to associate with the instance.\n###### Note\nAmazon Elastic Graphics reached end of life on January 8, 2024.\n*Required*: No\n*Type*: Array of [ElasticGpuSpecification](./aws-properties-ec2-instance-elasticgpuspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-elasticgpuspecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ElasticGpuSpecification", "DuplicatesAllowed": true }, "ElasticInferenceAccelerators": { "MarkdownDocumentation": "`ElasticInferenceAccelerators`\n\nAn elastic inference accelerator to associate with the instance.\n###### Note\nAmazon Elastic Inference is no longer available.\n*Required*: No\n*Type*: Array of [ElasticInferenceAccelerator](./aws-properties-ec2-instance-elasticinferenceaccelerator.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-elasticinferenceaccelerators", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ElasticInferenceAccelerator", "DuplicatesAllowed": true }, "Volumes": { "MarkdownDocumentation": "`Volumes`\n\nThe volumes to attach to the instance.\n*Required*: No\n*Type*: Array of [Volume](./aws-properties-ec2-instance-volume.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-volumes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Volume", "DuplicatesAllowed": true }, "Ipv6AddressCount": { "MarkdownDocumentation": "`Ipv6AddressCount`\n\nThe number of IPv6 addresses to associate with the primary network\ninterface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\ncannot specify this option and the option to assign specific IPv6 addresses in the same\nrequest. You can specify this option if you've specified a minimum number of instances\nto launch.\nYou cannot specify this option and the network interfaces option in the same\nrequest.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ipv6addresscount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "LaunchTemplate": { "MarkdownDocumentation": "`LaunchTemplate`\n\nThe launch template. Any additional parameters that you specify for the new instance\noverwrite the corresponding parameters included in the launch template.\n*Required*: No\n*Type*: [LaunchTemplateSpecification](./aws-properties-ec2-instance-launchtemplatespecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-launchtemplate", "UpdateType": "Immutable", "Required": false, "Type": "LaunchTemplateSpecification" }, "EnclaveOptions": { "MarkdownDocumentation": "`EnclaveOptions`\n\nIndicates whether the instance is enabled for AWS Nitro\nEnclaves.\n*Required*: No\n*Type*: [EnclaveOptions](./aws-properties-ec2-instance-enclaveoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-enclaveoptions", "UpdateType": "Immutable", "Required": false, "Type": "EnclaveOptions" }, "NetworkInterfaces": { "MarkdownDocumentation": "`NetworkInterfaces`\n\nThe network interfaces to associate with the instance.\n###### Note\nIf you use this property to point to a network interface, you must terminate the\noriginal interface before attaching a new one to allow the update of the instance to\nsucceed.\nIf this resource has a public IP address and is also in a VPC that is defined in the\nsame template, you must use the [DependsOn\nAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the VPC-gateway attachment.\n*Required*: No\n*Type*: Array of [NetworkInterface](./aws-properties-ec2-instance-networkinterface.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-networkinterfaces", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "NetworkInterface", "DuplicatesAllowed": true }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nThe ID of the AMI. An AMI ID is required to launch an instance and must be specified\nhere 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-imageid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)\nin the *Amazon EC2 User Guide*.\nWhen you change your EBS-backed instance type, instance restart or replacement behavior depends on the\ninstance type compatibility between the old and new types. An instance with an instance store volume as the\nroot volume is always replaced. For more information, see [Change the instance type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html)\nin the *Amazon EC2 User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `a1.medium | a1.large | a1.x...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge", "c7i-flex.large", "c7i-flex.xlarge", "c7i-flex.2xlarge", "c7i-flex.4xlarge", "c7i-flex.8xlarge", "u7i-12tb.224xlarge", "u7in-16tb.224xlarge", "u7in-24tb.224xlarge", "u7in-32tb.224xlarge", "u7ib-12tb.224xlarge", "c7gn.metal", "r8g.medium", "r8g.large", "r8g.xlarge", "r8g.2xlarge", "r8g.4xlarge", "r8g.8xlarge", "r8g.12xlarge", "r8g.16xlarge", "r8g.24xlarge", "r8g.48xlarge", "r8g.metal-24xl", "r8g.metal-48xl", "mac2-m1ultra.metal", "g6e.xlarge", "g6e.2xlarge", "g6e.4xlarge", "g6e.8xlarge", "g6e.12xlarge", "g6e.16xlarge", "g6e.24xlarge", "g6e.48xlarge", "c8g.medium", "c8g.large", "c8g.xlarge", "c8g.2xlarge", "c8g.4xlarge", "c8g.8xlarge", "c8g.12xlarge", "c8g.16xlarge", "c8g.24xlarge", "c8g.48xlarge", "c8g.metal-24xl", "c8g.metal-48xl", "m8g.medium", "m8g.large", "m8g.xlarge", "m8g.2xlarge", "m8g.4xlarge", "m8g.8xlarge", "m8g.12xlarge", "m8g.16xlarge", "m8g.24xlarge", "m8g.48xlarge", "m8g.metal-24xl", "m8g.metal-48xl", "x8g.medium", "x8g.large", "x8g.xlarge", "x8g.2xlarge", "x8g.4xlarge", "x8g.8xlarge", "x8g.12xlarge", "x8g.16xlarge", "x8g.24xlarge", "x8g.48xlarge", "x8g.metal-24xl", "x8g.metal-48xl", "i7ie.large", "i7ie.xlarge", "i7ie.2xlarge", "i7ie.3xlarge", "i7ie.6xlarge", "i7ie.12xlarge", "i7ie.18xlarge", "i7ie.24xlarge", "i7ie.48xlarge", "i8g.large", "i8g.xlarge", "i8g.2xlarge", "i8g.4xlarge", "i8g.8xlarge", "i8g.12xlarge", "i8g.16xlarge", "i8g.24xlarge", "i8g.metal-24xl", "u7i-6tb.112xlarge", "u7i-8tb.112xlarge", "u7inh-32tb.480xlarge", "p5e.48xlarge", "p5en.48xlarge", "f2.12xlarge", "f2.48xlarge", "trn2.48xlarge", "c7i-flex.12xlarge", "c7i-flex.16xlarge", "m7i-flex.12xlarge", "m7i-flex.16xlarge", "i7ie.metal-24xl", "i7ie.metal-48xl", "i8g.48xlarge", "c8gd.medium", "c8gd.large", "c8gd.xlarge", "c8gd.2xlarge", "c8gd.4xlarge", "c8gd.8xlarge", "c8gd.12xlarge", "c8gd.16xlarge", "c8gd.24xlarge", "c8gd.48xlarge", "c8gd.metal-24xl", "c8gd.metal-48xl", "i7i.large", "i7i.xlarge", "i7i.2xlarge", "i7i.4xlarge", "i7i.8xlarge", "i7i.12xlarge", "i7i.16xlarge", "i7i.24xlarge", "i7i.48xlarge", "i7i.metal-24xl", "i7i.metal-48xl", "p6-b200.48xlarge", "m8gd.medium", "m8gd.large", "m8gd.xlarge", "m8gd.2xlarge", "m8gd.4xlarge", "m8gd.8xlarge", "m8gd.12xlarge", "m8gd.16xlarge", "m8gd.24xlarge", "m8gd.48xlarge", "m8gd.metal-24xl", "m8gd.metal-48xl", "r8gd.medium", "r8gd.large", "r8gd.xlarge", "r8gd.2xlarge", "r8gd.4xlarge", "r8gd.8xlarge", "r8gd.12xlarge", "r8gd.16xlarge", "r8gd.24xlarge", "r8gd.48xlarge", "r8gd.metal-24xl", "r8gd.metal-48xl", "c8gn.medium", "c8gn.large", "c8gn.xlarge", "c8gn.2xlarge", "c8gn.4xlarge", "c8gn.8xlarge", "c8gn.12xlarge", "c8gn.16xlarge", "c8gn.24xlarge", "c8gn.48xlarge", "c8gn.metal-24xl", "c8gn.metal-48xl", "f2.6xlarge", "p6e-gb200.36xlarge", "g6f.large", "g6f.xlarge", "g6f.2xlarge", "g6f.4xlarge", "gr6f.4xlarge", "p5.4xlarge", "r8i.large", "r8i.xlarge", "r8i.2xlarge", "r8i.4xlarge", "r8i.8xlarge", "r8i.12xlarge", "r8i.16xlarge", "r8i.24xlarge", "r8i.32xlarge", "r8i.48xlarge", "r8i.96xlarge", "r8i.metal-48xl", "r8i.metal-96xl", "r8i-flex.large", "r8i-flex.xlarge", "r8i-flex.2xlarge", "r8i-flex.4xlarge", "r8i-flex.8xlarge", "r8i-flex.12xlarge", "r8i-flex.16xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-instancetype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to the instance. These tags are not applied to the EBS volumes, such as\nthe root volume, unless [PropagateTagsToVolumeOnCreation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation)\nis `true`.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-instance-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Monitoring": { "MarkdownDocumentation": "`Monitoring`\n\nSpecifies whether detailed monitoring is enabled for the instance. Specify `true` to\nenable detailed monitoring. Otherwise, basic monitoring is enabled. For more information\nabout detailed monitoring, see [Enable or turn off detailed\nmonitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-monitoring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AdditionalInfo": { "MarkdownDocumentation": "`AdditionalInfo`\n\nThis property is reserved for internal use. If you use it, the stack fails with this\nerror: `Bad property set: [Testing this property] (Service: AmazonEC2; Status Code:\n400; Error Code: InvalidParameterCombination; Request ID:\n0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX)`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-additionalinfo", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "HibernationOptions": { "MarkdownDocumentation": "`HibernationOptions`\n\nIndicates whether an instance is enabled for hibernation. This parameter is valid only\nif the instance meets the [hibernation\nprerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your Amazon EC2\ninstance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*.\nYou can't enable hibernation and AWS Nitro Enclaves on the same\ninstance.\n*Required*: No\n*Type*: [HibernationOptions](./aws-properties-ec2-instance-hibernationoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hibernationoptions", "UpdateType": "Immutable", "Required": false, "Type": "HibernationOptions" }, "LicenseSpecifications": { "MarkdownDocumentation": "`LicenseSpecifications`\n\nThe license configurations.\n*Required*: No\n*Type*: Array of [LicenseSpecification](./aws-properties-ec2-instance-licensespecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-licensespecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "LicenseSpecification", "DuplicatesAllowed": true }, "MetadataOptions": { "MarkdownDocumentation": "`MetadataOptions`\n\nThe metadata options for the instance.\n*Required*: No\n*Type*: [MetadataOptions](./aws-properties-ec2-instance-metadataoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-metadataoptions", "UpdateType": "Mutable", "Required": false, "Type": "MetadataOptions" }, "InstanceInitiatedShutdownBehavior": { "MarkdownDocumentation": "`InstanceInitiatedShutdownBehavior`\n\nIndicates whether an instance stops or terminates when you initiate shutdown from the\ninstance (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)", "RefReturnValue": "", "AllowedValues": [ "stop", "terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-instanceinitiatedshutdownbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CpuOptions": { "MarkdownDocumentation": "`CpuOptions`\n\nThe CPU options for the instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in\nthe *Amazon Elastic Compute Cloud User Guide*.\n*Required*: No\n*Type*: [CpuOptions](./aws-properties-ec2-instance-cpuoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-cpuoptions", "UpdateType": "Immutable", "Required": false, "Type": "CpuOptions" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone of the instance.\nIf not specified, an Availability Zone will be automatically chosen for you based on the\nload balancing criteria for the Region.\nThis parameter is not supported by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PrivateDnsNameOptions": { "MarkdownDocumentation": "`PrivateDnsNameOptions`\n\nThe options for the instance hostname.\n*Required*: No\n*Type*: [PrivateDnsNameOptions](./aws-properties-ec2-instance-privatednsnameoptions.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-privatednsnameoptions", "UpdateType": "Conditional", "Required": false, "Type": "PrivateDnsNameOptions" }, "HostId": { "MarkdownDocumentation": "`HostId`\n\nIf you specify host for the `Affinity` property, the ID of a dedicated host\nthat the instance is associated with. If you don't specify an ID, Amazon EC2 launches the\ninstance onto any available, compatible dedicated host in your account. This type of launch\nis called an untargeted launch. Note that for untargeted launches, you must have a\ncompatible, dedicated host available to successfully launch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hostid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "HostResourceGroupArn": { "MarkdownDocumentation": "`HostResourceGroupArn`\n\nThe ARN of the host resource group in which to launch the instances. If you specify a\nhost resource group ARN, omit the **Tenancy** parameter or set\nit to `host`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hostresourcegrouparn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the security groups. You can specify the IDs of existing security groups and\nreferences to resources created by the stack template.\nIf you specify a network interface, you must specify any security groups as part of\nthe network interface.\n*Required*: Conditional\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-securitygroupids", "UpdateType": "Conditional", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DisableApiTermination": { "MarkdownDocumentation": "`DisableApiTermination`\n\nIndicates whether termination protection is enabled for the instance. The default\nis `false`, which means that you can terminate the instance using\nthe Amazon EC2 console, command line tools, or API. You can enable termination protection\nwhen you launch an instance, while the instance is running, or while the instance\nis stopped.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-disableapitermination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyName": { "MarkdownDocumentation": "`KeyName`\n\nThe name of the key pair. For more information, see [Create a key pair for your EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html).\n###### Important\nIf you do not specify a key pair, you can't connect to the instance unless you\nchoose an AMI that is configured to allow users another way to log 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-keyname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RamdiskId": { "MarkdownDocumentation": "`RamdiskId`\n\nThe ID of the RAM disk to select. Some kernels require additional drivers at launch.\nCheck the kernel requirements for information about whether you need to specify a RAM\ndisk. To find kernel requirements, go to the AWS Resource Center and\nsearch for the kernel ID.\n###### Important\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\ninformation, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ramdiskid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SourceDestCheck": { "MarkdownDocumentation": "`SourceDestCheck`\n\nEnable or disable source/destination checks, which ensure that the instance is either\nthe source or the destination of any traffic that it receives. If the value is\n`true`, source/destination checks are enabled; otherwise, they are\ndisabled. The default value is `true`. You must disable source/destination\nchecks if the instance runs services such as network address translation, routing, or\nfirewalls.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-sourcedestcheck", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PlacementGroupName": { "MarkdownDocumentation": "`PlacementGroupName`\n\nThe name of an existing placement group that you want to launch the instance into\n(cluster | partition | spread).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-placementgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SsmAssociations": { "MarkdownDocumentation": "`SsmAssociations`\n\nThe SSM [document](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html) and parameter values in AWS Systems Manager to associate with this\ninstance. To use this property, you must specify an IAM instance profile role for the\ninstance. For more information, see [Create an\nIAM instance profile for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html) in the *AWS Systems Manager\nUser Guide*.\n###### Note\nYou can associate only one document with an instance.\n*Required*: No\n*Type*: Array of [SsmAssociation](./aws-properties-ec2-instance-ssmassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ssmassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SsmAssociation", "DuplicatesAllowed": true }, "Affinity": { "MarkdownDocumentation": "`Affinity`\n\nIndicates whether the instance is associated with a dedicated host. If you want the\ninstance to always restart on the same host on which it was launched, specify\n`host`. If you want the instance to restart on any available host, but try to\nlaunch onto the last host it ran on (on a best-effort basis), specify\n`default`.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | host...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "host" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-affinity", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "CreditSpecification": { "MarkdownDocumentation": "`CreditSpecification`\n\nThe credit option for CPU usage of the burstable performance instance. Valid values\nare `standard` and `unlimited`. To change this attribute after\nlaunch, use [ModifyInstanceCreditSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html). For more information, see [Burstable\nperformance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*.\nDefault: `standard` (T2 instances) or `unlimited` (T3/T3a/T4g\ninstances)\nFor T3 instances with `host` tenancy, only `standard` is\nsupported.\n*Required*: No\n*Type*: [CreditSpecification](./aws-properties-ec2-instance-creditspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-creditspecification", "UpdateType": "Mutable", "Required": false, "Type": "CreditSpecification" } }, "Attributes": { "State.Code": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#State.Code-fn::getatt" }, "PrivateDnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrivateDnsName`\n\nThe private DNS name of the specified instance. For example:\n`ip-10-24-34-0.ec2.internal`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#PrivateDnsName-fn::getatt" }, "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC in which the instance is running.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#VpcId-fn::getatt" }, "PrivateIp": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrivateIp`\n\nThe private IP address of the specified instance. For example:\n`10.24.34.0`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#PrivateIp-fn::getatt" }, "InstanceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`InstanceId`\n\nThe ID of the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#InstanceId-fn::getatt" }, "PublicIp": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublicIp`\n\nThe public IP address of the specified instance. For example:\n`192.0.2.0`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#PublicIp-fn::getatt" }, "State.Name": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#State.Name-fn::getatt" }, "State": { "Type": "State", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#State-fn::getatt" }, "AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#AvailabilityZone-fn::getatt" }, "PublicDnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublicDnsName`\n\nThe public DNS name of the specified instance. For example:\n`ec2-107-20-50-45.compute-1.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#PublicDnsName-fn::getatt" } } }, "AWS::EC2::InstanceConnectEndpoint": { "MarkdownDocumentation": "`AWS::EC2::InstanceConnectEndpoint`\n\nCreates an EC2 Instance Connect Endpoint.\nAn EC2 Instance Connect Endpoint allows you to connect to an instance, without\nrequiring the instance to have a public IPv4 address. For more information, see [Connect to your instances using\nEC2 Instance Connect Endpoint](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect-Endpoint.html) in the *Amazon EC2 User Guide*.\nWith the replacement update behavior, CloudFormation usually creates the new\nresource first, changes references to point to the new resource, and then deletes the old\nresource. However, you can create only one EC2 Instance Connect Endpoint per VPC, so the\nreplacement process fails. If you need to modify an EC2 Instance Connect Endpoint, you\nmust replace the resource manually.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the EC2 Instance Connect Endpoint.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html", "Properties": { "PreserveClientIp": { "MarkdownDocumentation": "`PreserveClientIp`\n\nIndicates whether the client IP address is preserved as the source. The following are the possible values.\n* `true` - Use the client IP address as the source.\n* `false` - Use the network interface IP address as the source.\n###### Note\n`PreserveClientIp` is only supported on IPv4 EC2 Instance Connect\nEndpoints. To use `PreserveClientIp`, the value for\n`IpAddressType` must be `ipv4`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-preserveclientip", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet in which to create the EC2 Instance Connect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClientToken": { "MarkdownDocumentation": "`ClientToken`\n\nUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-clienttoken", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nOne or more security groups to associate with the endpoint. If you don't specify a security group,\nthe default security group for your VPC will be associated with the endpoint.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-securitygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the EC2 Instance Connect Endpoint during creation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-instanceconnectendpoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the EC2 Instance Connect Endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#Id-fn::getatt" } } }, "AWS::EC2::InternetGateway": { "MarkdownDocumentation": "`AWS::EC2::InternetGateway`\n\nAllocates an internet gateway for use with a VPC. After creating the Internet gateway,\nyou then attach it to a VPC.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the internet gateway.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags to assign to the internet gateway.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-internetgateway-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html#cfn-ec2-internetgateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "InternetGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`InternetGatewayId`\n\nThe ID of the internet gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html#InternetGatewayId-fn::getatt" } } }, "AWS::EC2::IpPoolRouteTableAssociation": { "MarkdownDocumentation": "`AWS::EC2::IpPoolRouteTableAssociation`\n\nA route server association is the connection established between a route server and a VPC.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the route table association ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ippoolroutetableassociation.html", "Properties": { "RouteTableId": { "MarkdownDocumentation": "`RouteTableId`\n\nThe ID of a route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ippoolroutetableassociation.html#cfn-ec2-ippoolroutetableassociation-routetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PublicIpv4Pool": { "MarkdownDocumentation": "`PublicIpv4Pool`\n\nThe ID of a public IPv4 address 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ippoolroutetableassociation.html#cfn-ec2-ippoolroutetableassociation-publicipv4pool", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationId`\n\nThe ID of a route table association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ippoolroutetableassociation.html#AssociationId-fn::getatt" } } }, "AWS::EC2::KeyPair": { "MarkdownDocumentation": "`AWS::EC2::KeyPair`\n\nSpecifies a key pair for use with an Amazon Elastic Compute Cloud instance as follows:\n* To import an existing key pair, include the `PublicKeyMaterial` property.\n* To create a new key pair, omit the `PublicKeyMaterial` property.\nWhen you import an existing key pair, you specify the public key material for the key. We\nassume that you have the private key material for the key. AWS CloudFormation does not\ncreate or return the private key material when you import a key pair.\nWhen you create a new key pair, the private key is saved to AWS Systems Manager\nParameter Store, using a parameter with the following name: `/ec2/keypair/{key_pair_id}`.\nFor more information about retrieving private key, and the required permissions, see [Create a key pair using CloudFormation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *Amazon EC2 User Guide*.\nWhen CloudFormation deletes a key pair that was created or imported by a stack,\nit also deletes the parameter that was used to store the private key material in\nParameter Store.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the key pair.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html", "Properties": { "KeyName": { "MarkdownDocumentation": "`KeyName`\n\nA unique name for the key pair.\nConstraints: Up to 255 ASCII 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KeyType": { "MarkdownDocumentation": "`KeyType`\n\nThe type of key pair. Note that ED25519 keys are not supported for Windows instances.\nIf the `PublicKeyMaterial` property is specified, the `KeyType` property is ignored, and the key type\nis inferred from the `PublicKeyMaterial` value.\nDefault: `rsa`\n*Required*: No\n*Type*: String\n*Allowed values*: `rsa | ed25519...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "rsa", "ed25519" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keytype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KeyFormat": { "MarkdownDocumentation": "`KeyFormat`\n\nThe format of the key pair.\nDefault: `pem`\n*Required*: No\n*Type*: String\n*Allowed values*: `pem | ppk`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "pem", "ppk" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PublicKeyMaterial": { "MarkdownDocumentation": "`PublicKeyMaterial`\n\nThe public key material. The `PublicKeyMaterial` property is used to import a key pair. If this property is not specified,\nthen a new key pair will be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-publickeymaterial", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the key pair.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-keypair-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "KeyPairId": { "PrimitiveType": "String", "MarkdownDocumentation": "`KeyPairId`\n\nThe ID of the key pair.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#KeyPairId-fn::getatt" }, "KeyFingerprint": { "PrimitiveType": "String", "MarkdownDocumentation": "`KeyFingerprint`\n\nIf you created the key pair using Amazon EC2:\n* For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.\n* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with [OpenSSH 6.8](http://www.openssh.com/txt/release-6.8).\nIf you imported the key pair to Amazon EC2:\n* For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.\n* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256\n digest, which is the default for OpenSSH, starting with [OpenSSH 6.8](http://www.openssh.com/txt/release-6.8).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#KeyFingerprint-fn::getatt" } } }, "AWS::EC2::LaunchTemplate": { "MarkdownDocumentation": "`AWS::EC2::LaunchTemplate`\n\nSpecifies the properties for creating a launch template.\nThe minimum required properties for specifying a launch template are as follows:\n* You must specify at least one property for the launch template data.\n* You can optionally specify a name for the launch template. If you do not specify a\n name, CloudFormation creates a name for you.\nA launch template can contain some or all of the configuration information to launch an\ninstance. When you launch an instance using a launch template, instance properties that are\nnot specified in the launch template use default values, except the `ImageId`\nproperty, which has no default value. If you do not specify an AMI ID for the launch\ntemplate `ImageId` property, you must specify an AMI ID for the instance\n`ImageId` property.\nFor more information, see [Launch an instance from a\nlaunch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the launch template, for example,\n`lt-01238c059e3466abc`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html", "Properties": { "LaunchTemplateName": { "MarkdownDocumentation": "`LaunchTemplateName`\n\nA name for the launch template.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\(\\)\\.\\-/_]+`\n*Minimum*: `3`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LaunchTemplateData": { "MarkdownDocumentation": "`LaunchTemplateData`\n\nThe information for the launch template.\n*Required*: Yes\n*Type*: [LaunchTemplateData](./aws-properties-ec2-launchtemplate-launchtemplatedata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatedata", "UpdateType": "Mutable", "Required": true, "Type": "LaunchTemplateData" }, "VersionDescription": { "MarkdownDocumentation": "`VersionDescription`\n\nA description for the first version of the launch template.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TagSpecifications": { "MarkdownDocumentation": "`TagSpecifications`\n\nThe tags to apply to the launch template on creation. To tag the launch template, the\nresource type must be `launch-template`.\nTo specify the tags for resources that are created during instance launch, use\n[TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications).\n*Required*: No\n*Type*: Array of [LaunchTemplateTagSpecification](./aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LaunchTemplateTagSpecification", "DuplicatesAllowed": true } }, "Attributes": { "LatestVersionNumber": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionNumber`\n\nThe latest version of the launch template, such as `5`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#LatestVersionNumber-fn::getatt" }, "LaunchTemplateId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LaunchTemplateId`\n\nThe ID of the launch template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#LaunchTemplateId-fn::getatt" }, "DefaultVersionNumber": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefaultVersionNumber`\n\nThe default version of the launch template, such as 2.\nThe default version of a launch template cannot be specified in AWS CloudFormation. The default version can be set in the Amazon EC2 console or by using the\n`modify-launch-template`AWS CLI command.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#DefaultVersionNumber-fn::getatt" } } }, "AWS::EC2::LocalGatewayRoute": { "MarkdownDocumentation": "`AWS::EC2::LocalGatewayRoute`\n\nCreates a static route for the specified local gateway route table. You must specify one of the\nfollowing targets:\n* `LocalGatewayVirtualInterfaceGroupId`\n* `NetworkInterfaceId`\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the local gateway route table and its destination address range. For example:\n`{ \"Ref\": \"lgw-rtb-12346789abcdef|10.0.0.0/24\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html", "Properties": { "LocalGatewayRouteTableId": { "MarkdownDocumentation": "`LocalGatewayRouteTableId`\n\nThe ID of the local gateway route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayroutetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DestinationCidrBlock": { "MarkdownDocumentation": "`DestinationCidrBlock`\n\nThe CIDR block used for destination matches.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-destinationcidrblock", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-networkinterfaceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LocalGatewayVirtualInterfaceGroupId": { "MarkdownDocumentation": "`LocalGatewayVirtualInterfaceGroupId`\n\nThe ID of the virtual interface 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayvirtualinterfacegroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nThe type of local gateway route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#Type-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the local gateway route table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#State-fn::getatt" } } }, "AWS::EC2::LocalGatewayRouteTable": { "MarkdownDocumentation": "`AWS::EC2::LocalGatewayRouteTable`\n\nDescribes a local gateway route table.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the local gateway route table. For example:\n`{ \"Ref\": \"lgw-rtb-059615ef7deEXAMPLE\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html", "Properties": { "LocalGatewayId": { "MarkdownDocumentation": "`LocalGatewayId`\n\nThe ID of the local 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-localgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe mode of the local gateway route table.\n*Required*: No\n*Type*: String\n*Allowed values*: `direct-vpc-routing | coip...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "direct-vpc-routing", "coip" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-mode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the local gateway route table.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-localgatewayroutetable-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe ID of the AWS account that owns the local gateway route table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#OwnerId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the local gateway route table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#State-fn::getatt" }, "OutpostArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`OutpostArn`\n\nThe Amazon Resource Name (ARN) of the Outpost.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#OutpostArn-fn::getatt" }, "LocalGatewayRouteTableId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayRouteTableId`\n\nThe ID of the local gateway route table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#LocalGatewayRouteTableId-fn::getatt" }, "LocalGatewayRouteTableArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayRouteTableArn`\n\nThe Amazon Resource Name (ARN) of the local gateway route table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#LocalGatewayRouteTableArn-fn::getatt" } } }, "AWS::EC2::LocalGatewayRouteTableVPCAssociation": { "MarkdownDocumentation": "`AWS::EC2::LocalGatewayRouteTableVPCAssociation`\n\nAssociates the specified VPC with the specified local gateway route table.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the local gateway route table VPC association. For example:\n`{ \"Ref\": \"lgw-vpc-assoc-0ee765bcc8EXAMPLE\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LocalGatewayRouteTableId": { "MarkdownDocumentation": "`LocalGatewayRouteTableId`\n\nThe ID of the local gateway route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-localgatewayroutetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the association.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-localgatewayroutetablevpcassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LocalGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayId`\n\nThe ID of the local gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#LocalGatewayId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#State-fn::getatt" }, "LocalGatewayRouteTableVpcAssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayRouteTableVpcAssociationId`\n\nThe ID of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#LocalGatewayRouteTableVpcAssociationId-fn::getatt" } } }, "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { "MarkdownDocumentation": "`AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation`\n\nDescribes an association between a local gateway route table and a virtual interface group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the local gateway route table virtual interface group association. For example:\n`{ \"Ref\": \"lgw-vif-grp-assoc-07145b276bEXAMPLE\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html", "Properties": { "LocalGatewayRouteTableId": { "MarkdownDocumentation": "`LocalGatewayRouteTableId`\n\nThe ID of the local gateway route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-localgatewayroutetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the association.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-localgatewayroutetablevirtualinterfacegroupassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "LocalGatewayVirtualInterfaceGroupId": { "MarkdownDocumentation": "`LocalGatewayVirtualInterfaceGroupId`\n\nThe ID of the virtual interface 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-localgatewayvirtualinterfacegroupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe ID of the AWS account that owns the local gateway virtual interface group association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#OwnerId-fn::getatt" }, "LocalGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayId`\n\nThe ID of the local gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#LocalGatewayId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#State-fn::getatt" }, "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayRouteTableVirtualInterfaceGroupAssociationId`\n\nThe ID of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId-fn::getatt" }, "LocalGatewayRouteTableArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayRouteTableArn`\n\nThe Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#LocalGatewayRouteTableArn-fn::getatt" } } }, "AWS::EC2::LocalGatewayVirtualInterface": { "MarkdownDocumentation": "`AWS::EC2::LocalGatewayVirtualInterface`\n\nDescribes a local gateway virtual interface.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the local gateway virtual interface. For example:\n`{ \"Ref\": \"lgw-vif-07145b276bEXAMPLE\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html", "Properties": { "OutpostLagId": { "MarkdownDocumentation": "`OutpostLagId`\n\nThe Outpost LAG 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#cfn-ec2-localgatewayvirtualinterface-outpostlagid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LocalAddress": { "MarkdownDocumentation": "`LocalAddress`\n\nThe local address.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#cfn-ec2-localgatewayvirtualinterface-localaddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PeerAddress": { "MarkdownDocumentation": "`PeerAddress`\n\nThe peer address.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#cfn-ec2-localgatewayvirtualinterface-peeraddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Vlan": { "MarkdownDocumentation": "`Vlan`\n\nThe ID of the VLAN.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#cfn-ec2-localgatewayvirtualinterface-vlan", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "PeerBgpAsn": { "MarkdownDocumentation": "`PeerBgpAsn`\n\nThe peer BGP ASN.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#cfn-ec2-localgatewayvirtualinterface-peerbgpasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the virtual interface.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-localgatewayvirtualinterface-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#cfn-ec2-localgatewayvirtualinterface-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "LocalGatewayVirtualInterfaceGroupId": { "MarkdownDocumentation": "`LocalGatewayVirtualInterfaceGroupId`\n\nThe ID of the local gateway virtual interface 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#cfn-ec2-localgatewayvirtualinterface-localgatewayvirtualinterfacegroupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PeerBgpAsnExtended": { "MarkdownDocumentation": "`PeerBgpAsnExtended`\n\nThe extended 32-bit ASN of the BGP peer for use with larger ASN values.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#cfn-ec2-localgatewayvirtualinterface-peerbgpasnextended", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Long" } }, "Attributes": { "ConfigurationState": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationState`\n\nThe current state of the local gateway virtual interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#ConfigurationState-fn::getatt" }, "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe ID of the AWS account that owns the local gateway virtual interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#OwnerId-fn::getatt" }, "LocalGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayId`\n\nThe ID of the local gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#LocalGatewayId-fn::getatt" }, "LocalBgpAsn": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`LocalBgpAsn`\n\nThe Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#LocalBgpAsn-fn::getatt" }, "LocalGatewayVirtualInterfaceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayVirtualInterfaceId`\n\nThe ID of the virtual interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterface.html#LocalGatewayVirtualInterfaceId-fn::getatt" } } }, "AWS::EC2::LocalGatewayVirtualInterfaceGroup": { "MarkdownDocumentation": "`AWS::EC2::LocalGatewayVirtualInterfaceGroup`\n\nDescribes a local gateway virtual interface group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the local gateway virtual interface group. For example:\n`{ \"Ref\": \"lgw-vif-grp-07145b276bEXAMPLE\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html", "Properties": { "LocalGatewayId": { "MarkdownDocumentation": "`LocalGatewayId`\n\nThe ID of the local 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#cfn-ec2-localgatewayvirtualinterfacegroup-localgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LocalBgpAsnExtended": { "MarkdownDocumentation": "`LocalBgpAsnExtended`\n\nThe extended 32-bit ASN for the local BGP configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#cfn-ec2-localgatewayvirtualinterfacegroup-localbgpasnextended", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Long" }, "LocalBgpAsn": { "MarkdownDocumentation": "`LocalBgpAsn`\n\nThe Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#cfn-ec2-localgatewayvirtualinterfacegroup-localbgpasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the virtual interface group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-localgatewayvirtualinterfacegroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#cfn-ec2-localgatewayvirtualinterfacegroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LocalGatewayVirtualInterfaceIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LocalGatewayVirtualInterfaceIds`\n\nThe IDs of the virtual interfaces.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#LocalGatewayVirtualInterfaceIds-fn::getatt" }, "ConfigurationState": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationState`\n\nThe current state of the local gateway virtual interface group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#ConfigurationState-fn::getatt" }, "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe ID of the AWS account that owns the local gateway virtual interface group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#OwnerId-fn::getatt" }, "LocalGatewayVirtualInterfaceGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayVirtualInterfaceGroupArn`\n\nThe Amazon Resource Number (ARN) of the local gateway virtual interface group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#LocalGatewayVirtualInterfaceGroupArn-fn::getatt" }, "LocalGatewayVirtualInterfaceGroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocalGatewayVirtualInterfaceGroupId`\n\nThe ID of the virtual interface group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayvirtualinterfacegroup.html#LocalGatewayVirtualInterfaceGroupId-fn::getatt" } } }, "AWS::EC2::NatGateway": { "MarkdownDocumentation": "`AWS::EC2::NatGateway`\n\nSpecifies a network address translation (NAT) gateway in the specified subnet. You can\ncreate either a public NAT gateway or a private NAT gateway. The default is a public NAT\ngateway. If you create a public NAT gateway, you must specify an elastic IP address.\nWith a NAT gateway, instances in a private subnet can connect to the internet, other\nAWS services, or an on-premises network using the IP address of the NAT\ngateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.\nIf you add a default route (`AWS::EC2::Route` resource) that points to a NAT\ngateway, specify the NAT gateway ID for the route's `NatGatewayId`\nproperty.\n###### Important\nWhen you associate an Elastic IP address or secondary Elastic IP address with a\npublic NAT gateway, the network border group of the Elastic IP address must match the network\nborder group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the\nNAT gateway fails to launch. You can see the network border group for the AZ by viewing the\ndetails of the subnet. Similarly, you can view the network border group for the Elastic IP\naddress by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip)\nin the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the NAT gateway. For example,\n`nat-0a12bc456789de0fg`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html", "Properties": { "SecondaryAllocationIds": { "MarkdownDocumentation": "`SecondaryAllocationIds`\n\nSecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html)\nin the *Amazon VPC User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryallocationids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-privateipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecondaryPrivateIpAddressCount": { "MarkdownDocumentation": "`SecondaryPrivateIpAddressCount`\n\n[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*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresscount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ConnectivityType": { "MarkdownDocumentation": "`ConnectivityType`\n\nIndicates whether the NAT gateway supports public or private connectivity.\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "private", "public" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-connectivitytype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecondaryPrivateIpAddresses": { "MarkdownDocumentation": "`SecondaryPrivateIpAddresses`\n\nSecondary 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC in which the NAT gateway is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneAddresses": { "MarkdownDocumentation": "`AvailabilityZoneAddresses`\n\nFor regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ. The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage.\nA regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.\nFor more information, see [Regional NAT gateways for automatic multi-AZ expansion](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html) in the *Amazon VPC User Guide*.\n*Required*: No\n*Type*: Array of [AvailabilityZoneAddress](./aws-properties-ec2-natgateway-availabilityzoneaddress.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-availabilityzoneaddresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AvailabilityZoneAddress", "DuplicatesAllowed": false }, "AvailabilityMode": { "MarkdownDocumentation": "`AvailabilityMode`\n\nIndicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.\nA zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.\nFor more information, see [Regional NAT gateways for automatic multi-AZ expansion](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html) in the *Amazon VPC User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `zonal | regional...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "zonal", "regional" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-availabilitymode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AllocationId": { "MarkdownDocumentation": "`AllocationId`\n\n[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet in which the NAT gateway is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the NAT gateway.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-natgateway-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "MaxDrainDurationSeconds": { "MarkdownDocumentation": "`MaxDrainDurationSeconds`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-maxdraindurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "RouteTableId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RouteTableId`\n\nFor regional NAT gateways only, this is the ID of the NAT gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#RouteTableId-fn::getatt" }, "EniId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EniId`\n\nThe ID of the network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#EniId-fn::getatt" }, "AutoProvisionZones": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutoProvisionZones`\n\nFor regional NAT gateways only: Indicates whether AWS automatically manages AZ coverage. When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.\nA regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.\nFor more information, see [Regional NAT gateways for automatic multi-AZ expansion](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#AutoProvisionZones-fn::getatt" }, "AutoScalingIps": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutoScalingIps`\n\nFor regional NAT gateways only: Indicates whether AWS automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.\nFor more information, see [Regional NAT gateways for automatic multi-AZ expansion](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#AutoScalingIps-fn::getatt" }, "NatGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`NatGatewayId`\n\nThe ID of the NAT gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#NatGatewayId-fn::getatt" } } }, "AWS::EC2::NetworkAcl": { "MarkdownDocumentation": "`AWS::EC2::NetworkAcl`\n\nSpecifies a network ACL for your VPC.\nTo add a network ACL entry, see [AWS::EC2::NetworkAclEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the network ACL.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC for the network ACL.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#cfn-ec2-networkacl-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the network ACL.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-networkacl-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#cfn-ec2-networkacl-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the network ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#Id-fn::getatt" } } }, "AWS::EC2::NetworkAclEntry": { "MarkdownDocumentation": "`AWS::EC2::NetworkAclEntry`\n\nSpecifies an entry, known as a rule, in a network ACL with a rule number you specify.\nEach network ACL has a set of numbered ingress rules and a separate set of numbered egress\nrules.\nTo create the network ACL, see [AWS::EC2::NetworkAcl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html).\nFor information about the protocol value, see [Protocol\nNumbers](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the network ACL entry.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html", "Properties": { "PortRange": { "MarkdownDocumentation": "`PortRange`\n\nThe range of port numbers for the UDP/TCP protocol. Required if specifying 6\n(TCP) or 17 (UDP) for the protocol parameter.\n*Required*: Conditional\n*Type*: [PortRange](./aws-properties-ec2-networkaclentry-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-portrange", "UpdateType": "Mutable", "Required": false, "Type": "PortRange" }, "NetworkAclId": { "MarkdownDocumentation": "`NetworkAclId`\n\nThe ID of the ACL for the entry.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-networkaclid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RuleAction": { "MarkdownDocumentation": "`RuleAction`\n\nWhether to allow or deny traffic that matches the rule; valid values are \"allow\" or\n\"deny\".\n*Required*: Yes\n*Type*: String\n*Allowed values*: `allow | deny...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "allow", "deny" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-ruleaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CidrBlock": { "MarkdownDocumentation": "`CidrBlock`\n\nThe IPv4 CIDR range to allow or deny, in CIDR notation (for example, 172.16.0.0/24).\nYou must specify an IPv4 CIDR block or an IPv6 CIDR block.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-cidrblock", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Egress": { "MarkdownDocumentation": "`Egress`\n\nWhether this rule applies to egress traffic from the subnet (`true`) or\ningress traffic to the subnet (`false`). By default, AWS CloudFormation\nspecifies `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-egress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "RuleNumber": { "MarkdownDocumentation": "`RuleNumber`\n\nRule number to assign to the entry, such as 100. ACL entries are processed in ascending\norder by rule number. Entries can't use the same rule number unless one is an egress rule\nand the other is an ingress rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-rulenumber", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "Ipv6CidrBlock": { "MarkdownDocumentation": "`Ipv6CidrBlock`\n\nThe IPv6 network range to allow or deny, in CIDR notation.\nYou must specify an IPv4 CIDR block or an IPv6 CIDR block.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-ipv6cidrblock", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe IP protocol that the rule applies to. You must specify -1 or a protocol number. You\ncan specify -1 for all protocols.\n###### Note\nIf you specify -1, all ports are opened and the `PortRange` property is\nignored.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-protocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Icmp": { "MarkdownDocumentation": "`Icmp`\n\nThe Internet Control Message Protocol (ICMP) code and type.\nRequired if specifying 1 (ICMP) for the protocol parameter.\n*Required*: Conditional\n*Type*: [Icmp](./aws-properties-ec2-networkaclentry-icmp.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-icmp", "UpdateType": "Mutable", "Required": false, "Type": "Icmp" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the network ACL entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#Id-fn::getatt" } } }, "AWS::EC2::NetworkInsightsAccessScope": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAccessScope`\n\nDescribes a Network Access Scope. A Network Access Scope defines outbound (egress) and inbound (ingress)\ntraffic patterns, including sources, destinations, paths, and traffic types.\nNetwork Access Analyzer identifies unintended network access to your resources on\nAWS. When you start an analysis on a Network Access Scope, Network\nAccess Analyzer produces findings. For more information, see the [Network Access Analyzer\nUser Guide](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the network insights scope.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html", "Properties": { "ExcludePaths": { "MarkdownDocumentation": "`ExcludePaths`\n\nThe paths to exclude.\n*Required*: No\n*Type*: Array of [AccessScopePathRequest](./aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-excludepaths", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AccessScopePathRequest", "DuplicatesAllowed": true }, "MatchPaths": { "MarkdownDocumentation": "`MatchPaths`\n\nThe paths to match.\n*Required*: No\n*Type*: Array of [AccessScopePathRequest](./aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-matchpaths", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "AccessScopePathRequest", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-networkinsightsaccessscope-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "UpdatedDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedDate`\n\nThe last updated date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#UpdatedDate-fn::getatt" }, "CreatedDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedDate`\n\nThe creation date.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#CreatedDate-fn::getatt" }, "NetworkInsightsAccessScopeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInsightsAccessScopeArn`\n\nThe ARN of the Network Access Scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#NetworkInsightsAccessScopeArn-fn::getatt" }, "NetworkInsightsAccessScopeId": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInsightsAccessScopeId`\n\nThe ID of the Network Access Scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#NetworkInsightsAccessScopeId-fn::getatt" } } }, "AWS::EC2::NetworkInsightsAccessScopeAnalysis": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAccessScopeAnalysis`\n\nDescribes a Network Access Scope analysis.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the network insights analysis.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html", "Properties": { "NetworkInsightsAccessScopeId": { "MarkdownDocumentation": "`NetworkInsightsAccessScopeId`\n\nThe ID of the Network Access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#cfn-ec2-networkinsightsaccessscopeanalysis-networkinsightsaccessscopeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-networkinsightsaccessscopeanalysis-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#cfn-ec2-networkinsightsaccessscopeanalysis-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the analysis (running | succeeded | failed).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#Status-fn::getatt" }, "StartDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`StartDate`\n\nThe start date of the analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#StartDate-fn::getatt" }, "NetworkInsightsAccessScopeAnalysisId": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInsightsAccessScopeAnalysisId`\n\nThe ID of the Network Access Scope analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#NetworkInsightsAccessScopeAnalysisId-fn::getatt" }, "NetworkInsightsAccessScopeAnalysisArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInsightsAccessScopeAnalysisArn`\n\nThe ARN of the Network Access Scope analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#NetworkInsightsAccessScopeAnalysisArn-fn::getatt" }, "EndDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndDate`\n\nThe end date of the analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#EndDate-fn::getatt" }, "AnalyzedEniCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AnalyzedEniCount`\n\nThe number of network interfaces analyzed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#AnalyzedEniCount-fn::getatt" }, "FindingsFound": { "PrimitiveType": "String", "MarkdownDocumentation": "`FindingsFound`\n\nIndicates whether there are findings (true | false | unknown).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#FindingsFound-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nThe status message.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#StatusMessage-fn::getatt" } } }, "AWS::EC2::NetworkInsightsAnalysis": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsAnalysis`\n\nSpecifies a network insights analysis.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the network insights analysis.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html", "Properties": { "FilterOutArns": { "MarkdownDocumentation": "`FilterOutArns`\n\nThe Amazon Resource Names (ARN) of the resources that the path must ignore.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-filteroutarns", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkInsightsPathId": { "MarkdownDocumentation": "`NetworkInsightsPathId`\n\nThe ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-networkinsightspathid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FilterInArns": { "MarkdownDocumentation": "`FilterInArns`\n\nThe Amazon Resource Names (ARN) of the resources that the path must traverse.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-filterinarns", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AdditionalAccounts": { "MarkdownDocumentation": "`AdditionalAccounts`\n\nThe member accounts that contain resources that the path can traverse.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-additionalaccounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-networkinsightsanalysis-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the network insights analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#Status-fn::getatt" }, "ReturnPathComponents": { "Type": "List", "ItemType": "PathComponent", "MarkdownDocumentation": "`ReturnPathComponents`\n\nThe components in the path from destination to source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#ReturnPathComponents-fn::getatt" }, "StartDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`StartDate`\n\nThe time the analysis started.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#StartDate-fn::getatt" }, "NetworkInsightsAnalysisId": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInsightsAnalysisId`\n\nThe ID of the network insights analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#NetworkInsightsAnalysisId-fn::getatt" }, "AlternatePathHints": { "Type": "List", "ItemType": "AlternatePathHint", "MarkdownDocumentation": "`AlternatePathHints`\n\nPotential intermediate components.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#AlternatePathHints-fn::getatt" }, "Explanations": { "Type": "List", "ItemType": "Explanation", "MarkdownDocumentation": "`Explanations`\n\nThe explanations. For more information, see [Reachability Analyzer explanation\ncodes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#Explanations-fn::getatt" }, "NetworkPathFound": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`NetworkPathFound`\n\nIndicates whether the destination is reachable from the source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#NetworkPathFound-fn::getatt" }, "SuggestedAccounts": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`SuggestedAccounts`\n\nThe IDs of potential intermediate accounts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#SuggestedAccounts-fn::getatt" }, "ForwardPathComponents": { "Type": "List", "ItemType": "PathComponent", "MarkdownDocumentation": "`ForwardPathComponents`\n\nThe components in the path from source to destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#ForwardPathComponents-fn::getatt" }, "NetworkInsightsAnalysisArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInsightsAnalysisArn`\n\nThe Amazon Resource Name (ARN) of the network insights analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#NetworkInsightsAnalysisArn-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nThe status message, if the status is `failed`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#StatusMessage-fn::getatt" } } }, "AWS::EC2::NetworkInsightsPath": { "MarkdownDocumentation": "`AWS::EC2::NetworkInsightsPath`\n\nSpecifies a path to analyze for reachability.\nVPC Reachability Analyzer enables you to analyze and debug network reachability between\ntwo resources in your virtual private cloud (VPC). For more information, see the [Reachability Analyzer User Guide](https://docs.aws.amazon.com/vpc/latest/reachability/what-is-reachability-analyzer.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the path.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe ID or ARN of the destination. If the resource is in another account, you must specify an ARN.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destination", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DestinationIp": { "MarkdownDocumentation": "`DestinationIp`\n\nThe IP address of the destination.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`\n*Minimum*: `0`\n*Maximum*: `15`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destinationip", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceIp": { "MarkdownDocumentation": "`SourceIp`\n\nThe IP address of the source.\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`\n*Minimum*: `0`\n*Maximum*: `15`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-sourceip", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FilterAtDestination": { "MarkdownDocumentation": "`FilterAtDestination`\n\nScopes the analysis to network paths that match specific filters at the destination. If you specify\nthis parameter, you can't specify the parameter for the destination IP address.\n*Required*: No\n*Type*: [PathFilter](./aws-properties-ec2-networkinsightspath-pathfilter.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-filteratdestination", "UpdateType": "Immutable", "Required": false, "Type": "PathFilter" }, "FilterAtSource": { "MarkdownDocumentation": "`FilterAtSource`\n\nScopes the analysis to network paths that match specific filters at the source. If you specify\nthis parameter, you can't specify the parameters for the source IP address or the destination port.\n*Required*: No\n*Type*: [PathFilter](./aws-properties-ec2-networkinsightspath-pathfilter.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-filteratsource", "UpdateType": "Immutable", "Required": false, "Type": "PathFilter" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe 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)\n", "RefReturnValue": "", "AllowedValues": [ "tcp", "udp" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-protocol", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DestinationPort": { "MarkdownDocumentation": "`DestinationPort`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destinationport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe ID or ARN of the source. If the resource is in another account, you must specify an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-source", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to the path.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-networkinsightspath-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "SourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceArn`\n\nThe Amazon Resource Name (ARN) of the source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#SourceArn-fn::getatt" }, "NetworkInsightsPathId": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInsightsPathId`\n\nThe ID of the path.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#NetworkInsightsPathId-fn::getatt" }, "CreatedDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedDate`\n\nThe time stamp when the path was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#CreatedDate-fn::getatt" }, "NetworkInsightsPathArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInsightsPathArn`\n\nThe Amazon Resource Name (ARN) of the path.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#NetworkInsightsPathArn-fn::getatt" }, "DestinationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DestinationArn`\n\nThe Amazon Resource Name (ARN) of the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#DestinationArn-fn::getatt" } } }, "AWS::EC2::NetworkInterface": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterface`\n\nDescribes a network interface in an Amazon EC2 instance for AWS CloudFormation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the network interface.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateIpAddress": { "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe private IPv4 address to assign to the network interface as the primary private IP address.\nIf you want to specify multiple private IP addresses, use the `PrivateIpAddresses` property.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PrivateIpAddresses": { "MarkdownDocumentation": "`PrivateIpAddresses`\n\nThe private IPv4 addresses to assign to the network interface. You can specify a primary private\nIP address by setting the value of the `Primary` property to `true`\nin the `PrivateIpAddressSpecification` property. If you want EC2 to\nautomatically assign private IP addresses, use the\n`SecondaryPrivateIpAddressCount` property and do not specify this\nproperty.\nWhen creating a network interface, you can't specify private IPv4 addresses if you've specified one of the following:\na count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.\n*Required*: No\n*Type*: Array of [PrivateIpAddressSpecification](./aws-properties-ec2-networkinterface-privateipaddressspecification.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddresses", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "PrivateIpAddressSpecification", "DuplicatesAllowed": true }, "SecondaryPrivateIpAddressCount": { "MarkdownDocumentation": "`SecondaryPrivateIpAddressCount`\n\nThe number of secondary private IPv4 addresses to assign to a network interface. When\nyou specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\nwithin the subnet's IPv4 CIDR range. You can't specify this option and specify more than\none private IP address using `privateIpAddresses`.\nWhen creating a Network Interface, you can't specify a count of private IPv4 addresses if you've specified one of the following: specific private\nIPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-secondaryprivateipaddresscount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PublicIpDnsHostnameTypeSpecification": { "MarkdownDocumentation": "`PublicIpDnsHostnameTypeSpecification`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `public-dual-stack-dns-name ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "public-dual-stack-dns-name", "public-ipv4-dns-name", "public-ipv6-dns-name" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-publicipdnshostnametypespecification", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ipv6PrefixCount": { "MarkdownDocumentation": "`Ipv6PrefixCount`\n\nThe number of IPv6 prefixes to be automatically assigned to the network interface.\nWhen creating a network interface, you can't specify a count of IPv6 prefixes if you've specified one of the following:\nspecific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6prefixcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv4Prefixes": { "MarkdownDocumentation": "`Ipv4Prefixes`\n\nThe IPv4 delegated prefixes that are assigned to the network interface.\nWhen creating a network interface, you can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.\n*Required*: No\n*Type*: Array of [Ipv4PrefixSpecification](./aws-properties-ec2-networkinterface-ipv4prefixspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv4prefixes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ipv4PrefixSpecification", "DuplicatesAllowed": true }, "Ipv4PrefixCount": { "MarkdownDocumentation": "`Ipv4PrefixCount`\n\nThe number of IPv4 prefixes to be automatically assigned to the network interface.\nWhen creating a network interface, you can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv4prefixcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "GroupSet": { "MarkdownDocumentation": "`GroupSet`\n\nThe IDs of the security groups associated with this network interface.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-groupset", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Ipv6Addresses": { "MarkdownDocumentation": "`Ipv6Addresses`\n\nThe IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface.\nIf you're specifying a number of IPv6 addresses, use the `Ipv6AddressCount` property and don't\nspecify this property.\nWhen creating a network interface, you can't specify IPv6 addresses if you've specified one of the following:\na count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.\n*Required*: No\n*Type*: Array of [InstanceIpv6Address](./aws-properties-ec2-networkinterface-instanceipv6address.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InstanceIpv6Address", "DuplicatesAllowed": false }, "Ipv6Prefixes": { "MarkdownDocumentation": "`Ipv6Prefixes`\n\nThe IPv6 delegated prefixes that are assigned to the network interface.\nWhen creating a network interface, you can't specify IPv6 prefixes if you've specified one of the following:\na count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.\n*Required*: No\n*Type*: Array of [Ipv6PrefixSpecification](./aws-properties-ec2-networkinterface-ipv6prefixspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6prefixes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ipv6PrefixSpecification", "DuplicatesAllowed": true }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet to associate with the network interface.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceDestCheck": { "MarkdownDocumentation": "`SourceDestCheck`\n\nEnable or disable source/destination checks, which ensure that the instance is either\nthe source or the destination of any traffic that it receives. If the value is\n`true`, source/destination checks are enabled; otherwise, they are\ndisabled. The default value is `true`. You must disable source/destination\nchecks if the instance runs services such as network address translation, routing, or\nfirewalls.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-sourcedestcheck", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "InterfaceType": { "MarkdownDocumentation": "`InterfaceType`\n\nThe type of network interface. The default is `interface`. The supported values\nare `efa` and `trunk`.\n*Required*: No\n*Type*: String\n*Allowed values*: `efa | efa-only | branch | t...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "efa", "efa-only", "branch", "trunk" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-interfacetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Ipv6AddressCount": { "MarkdownDocumentation": "`Ipv6AddressCount`\n\nThe number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically\nselects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use\nthe `Ipv6Addresses` property and don't specify this property.\nWhen creating a network interface, you can't specify a count of IPv6 addresses if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresscount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the network interface.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-networkinterface-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ConnectionTrackingSpecification": { "MarkdownDocumentation": "`ConnectionTrackingSpecification`\n\nA connection tracking specification for the network interface.\n*Required*: No\n*Type*: [ConnectionTrackingSpecification](./aws-properties-ec2-networkinterface-connectiontrackingspecification.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-connectiontrackingspecification", "UpdateType": "Conditional", "Required": false, "Type": "ConnectionTrackingSpecification" } }, "Attributes": { "PublicIpDnsNameOptions.PublicIpv6DnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#PublicIpDnsNameOptions.PublicIpv6DnsName-fn::getatt" }, "PrimaryIpv6Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrimaryIpv6Address`\n\nThe primary IPv6 address of the network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#PrimaryIpv6Address-fn::getatt" }, "SecondaryPrivateIpAddresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`SecondaryPrivateIpAddresses`\n\nThe secondary private IP addresses of the network interface. For example,\n`[\"10.0.0.161\", \"10.0.0.162\", \"10.0.0.163\"]`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#SecondaryPrivateIpAddresses-fn::getatt" }, "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#VpcId-fn::getatt" }, "PrimaryPrivateIpAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrimaryPrivateIpAddress`\n\nThe primary private IP address of the network interface. For example,\n`10.0.0.192`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#PrimaryPrivateIpAddress-fn::getatt" }, "PublicIpDnsNameOptions.DnsHostnameType": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#PublicIpDnsNameOptions.DnsHostnameType-fn::getatt" }, "PublicIpDnsNameOptions.PublicDualStackDnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#PublicIpDnsNameOptions.PublicDualStackDnsName-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#Id-fn::getatt" }, "PublicIpDnsNameOptions": { "Type": "PublicIpDnsNameOptions", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#PublicIpDnsNameOptions-fn::getatt" }, "PublicIpDnsNameOptions.PublicIpv4DnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#PublicIpDnsNameOptions.PublicIpv4DnsName-fn::getatt" } } }, "AWS::EC2::NetworkInterfaceAttachment": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterfaceAttachment`\n\nAttaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this\nresource type to attach additional network interfaces to an instance without\ninterruption.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html", "Properties": { "EnaSrdSpecification": { "MarkdownDocumentation": "`EnaSrdSpecification`\n\nConfigures ENA Express for the network interface that this action attaches to the\ninstance.\n*Required*: No\n*Type*: [EnaSrdSpecification](./aws-properties-ec2-networkinterfaceattachment-enasrdspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-enasrdspecification", "UpdateType": "Mutable", "Required": false, "Type": "EnaSrdSpecification" }, "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\nThe ID of the instance to which you will attach the ENI.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-instanceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeviceIndex": { "MarkdownDocumentation": "`DeviceIndex`\n\nThe network interface's position in the attachment order. For example, the first\nattached network interface has a `DeviceIndex` of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-deviceindex", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EnaQueueCount": { "MarkdownDocumentation": "`EnaQueueCount`\n\nThe number of ENA queues created with the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-enaqueuecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of the ENI that you want to attach.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-networkinterfaceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeleteOnTermination": { "MarkdownDocumentation": "`DeleteOnTermination`\n\nWhether to delete the network interface when the instance terminates. By default, this\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-deleteontermination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "AttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentId`\n\nThe ID of the network interface attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#AttachmentId-fn::getatt" } } }, "AWS::EC2::NetworkInterfacePermission": { "MarkdownDocumentation": "`AWS::EC2::NetworkInterfacePermission`\n\nSpecifies a permission for the network interface, For example, you can grant an\nAWS-authorized account permission to attach the network interface\nto an instance in their account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`eni-perm-055663b682ea24b48`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html", "Properties": { "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-awsaccountid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of the network interface.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-networkinterfaceid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Permission": { "MarkdownDocumentation": "`Permission`\n\nThe type of permission to grant: `INSTANCE-ATTACH` or\n`EIP-ASSOCIATE`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INSTANCE-ATTACH | EIP-ASSOC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "INSTANCE-ATTACH", "EIP-ASSOCIATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-permission", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::EC2::NetworkPerformanceMetricSubscription": { "MarkdownDocumentation": "`AWS::EC2::NetworkPerformanceMetricSubscription`\n\nDescribes Infrastructure Performance subscriptions.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `primaryIdentifier` property, which consists of\nthe following properties: `source`, `destination`, `metric`,\nand `statistic`, with each value separated by a pipe (|). For example,\n`{ \"Ref\": \"us-east-1|us-east-2|aggregate-latency|p50\" }`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe Region or Availability Zone that's the target for the subscription. For example, `eu-west-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-destination", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Statistic": { "MarkdownDocumentation": "`Statistic`\n\nThe statistic used for the subscription.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `p50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "p50" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-statistic", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Metric": { "MarkdownDocumentation": "`Metric`\n\nThe metric used for the subscription.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `aggregate-latency...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "aggregate-latency" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-metric", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe Region or Availability Zone that's the source for the subscription. For example, `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-source", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::PlacementGroup": { "MarkdownDocumentation": "`AWS::EC2::PlacementGroup`\n\nSpecifies a placement group in which to launch instances. The strategy of the placement\ngroup determines how the instances are organized within the group.\nA `cluster` placement group is a logical grouping of instances within a\nsingle Availability Zone that benefit from low network latency, high network throughput. A\n`spread` placement group places instances on distinct hardware. A\n`partition` placement group places groups of instances in different\npartitions, where instances in one partition do not share the same hardware with instances\nin another partition.\nFor more information, see [Placement Groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the\n*Amazon EC2 User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the placement group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html", "Properties": { "SpreadLevel": { "MarkdownDocumentation": "`SpreadLevel`\n\nDetermines how placement groups spread instances.\n* Host \u2013 You can use `host` only with Outpost placement\n groups.\n* Rack \u2013 No usage restrictions.\n*Required*: No\n*Type*: String\n*Allowed values*: `host | rack...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "host", "rack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-spreadlevel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Strategy": { "MarkdownDocumentation": "`Strategy`\n\nThe placement strategy.\n*Required*: No\n*Type*: String\n*Allowed values*: `cluster | spread | partitio...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "cluster", "spread", "partition" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-strategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PartitionCount": { "MarkdownDocumentation": "`PartitionCount`\n\nThe number of partitions. Valid only when **Strategy** is\nset to `partition`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-partitioncount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the new placement group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-placementgroup-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "GroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupName`\n\nThe name of the placement group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#GroupName-fn::getatt" } } }, "AWS::EC2::PrefixList": { "MarkdownDocumentation": "`AWS::EC2::PrefixList`\n\nSpecifies a managed prefix list. You can add one or more entries to the prefix list.\nEach entry consists of a CIDR block and an optional description.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the prefix list.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html", "Properties": { "MaxEntries": { "MarkdownDocumentation": "`MaxEntries`\n\nThe maximum number of entries for the prefix list. You can't modify the entries and the size\nof a prefix list at the same time.\nThis property is required when you create a prefix list.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-maxentries", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PrefixListName": { "MarkdownDocumentation": "`PrefixListName`\n\nA name for the prefix list.\nConstraints: Up to 255 characters in length. The name cannot start with `com.amazonaws`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-prefixlistname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Entries": { "MarkdownDocumentation": "`Entries`\n\nThe entries for the prefix list.\n*Required*: No\n*Type*: Array of [Entry](./aws-properties-ec2-prefixlist-entry.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-entries", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Entry", "DuplicatesAllowed": true }, "AddressFamily": { "MarkdownDocumentation": "`AddressFamily`\n\nThe IP address type.\nValid Values: `IPv4` | `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)", "RefReturnValue": "", "AllowedValues": [ "IPv4", "IPv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-addressfamily", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the prefix list.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-prefixlist-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe ID of the owner of the prefix list. For example, `123456789012`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#OwnerId-fn::getatt" }, "PrefixListId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrefixListId`\n\nThe ID of the prefix list. For example, `pl-0123123123123abcd`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#PrefixListId-fn::getatt" }, "Version": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Version`\n\nThe version of the prefix list. For example, `1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#Version-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the prefix list. For example,\n`arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123abcd`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#Arn-fn::getatt" } } }, "AWS::EC2::Route": { "MarkdownDocumentation": "`AWS::EC2::Route`\n\nSpecifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes)\nin the *Amazon VPC User Guide*.\nYou must specify either a destination CIDR block or prefix list ID. You must also\nspecify exactly one of the resources as the target.\nIf you create a route that references a transit gateway in the same template where you\ncreate the transit gateway, you must declare a dependency on the transit gateway\nattachment. The route table cannot use the transit gateway until it has successfully\nattached to the VPC. Add a [DependsOn\nAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the `AWS::EC2::Route` resource to explicitly declare a\ndependency on the `AWS::EC2::TransitGatewayAttachment` resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the route.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html", "Properties": { "DestinationIpv6CidrBlock": { "MarkdownDocumentation": "`DestinationIpv6CidrBlock`\n\nThe IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RouteTableId": { "MarkdownDocumentation": "`RouteTableId`\n\nThe ID of the route table for the route.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\nThe ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LocalGatewayId": { "MarkdownDocumentation": "`LocalGatewayId`\n\nThe ID of the local 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-localgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CarrierGatewayId": { "MarkdownDocumentation": "`CarrierGatewayId`\n\nThe ID of the carrier gateway.\nYou can only use this option when the VPC contains a subnet which is associated with a Wavelength 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-carriergatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationCidrBlock": { "MarkdownDocumentation": "`DestinationCidrBlock`\n\nThe IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18`, we modify it to `100.68.0.0/18`.\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GatewayId": { "MarkdownDocumentation": "`GatewayId`\n\nThe ID of an internet gateway or virtual private gateway attached to your\nVPC.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcEndpointId": { "MarkdownDocumentation": "`VpcEndpointId`\n\nThe ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcendpointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CoreNetworkArn": { "MarkdownDocumentation": "`CoreNetworkArn`\n\nThe Amazon Resource Name (ARN) of the core network.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-corenetworkarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of a transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-transitgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcPeeringConnectionId": { "MarkdownDocumentation": "`VpcPeeringConnectionId`\n\nThe ID of a VPC peering 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EgressOnlyInternetGatewayId": { "MarkdownDocumentation": "`EgressOnlyInternetGatewayId`\n\n[IPv6 traffic only] The ID of an egress-only internet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationPrefixListId": { "MarkdownDocumentation": "`DestinationPrefixListId`\n\nThe ID of a prefix list used for the destination match.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationprefixlistid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NatGatewayId": { "MarkdownDocumentation": "`NatGatewayId`\n\n[IPv4 traffic only] The ID of a NAT 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CidrBlock": { "PrimitiveType": "String", "MarkdownDocumentation": "`CidrBlock`\n\nThe IPv4 CIDR block.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#CidrBlock-fn::getatt" } } }, "AWS::EC2::RouteServer": { "MarkdownDocumentation": "`AWS::EC2::RouteServer`\n\nSpecifies a route server to manage dynamic routing in a VPC.\nAmazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.\nFor more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the route server ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html", "Properties": { "PersistRoutes": { "MarkdownDocumentation": "`PersistRoutes`\n\nIndicates whether routes should be persisted after all BGP sessions are terminated.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-persistroutes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnsNotificationsEnabled": { "MarkdownDocumentation": "`SnsNotificationsEnabled`\n\nIndicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-snsnotificationsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PersistRoutesDuration": { "MarkdownDocumentation": "`PersistRoutesDuration`\n\nThe number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if `persistRoutesState` is 'enabled'.\nIf you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-persistroutesduration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Long" }, "AmazonSideAsn": { "MarkdownDocumentation": "`AmazonSideAsn`\n\nThe Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512\u201365534 (16-bit ASN) or 4200000000\u20134294967294 (32-bit ASN) range.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `4294967294`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-amazonsideasn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Long" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the route server.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-routeserver-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the route server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the route server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#Arn-fn::getatt" } } }, "AWS::EC2::RouteServerAssociation": { "MarkdownDocumentation": "`AWS::EC2::RouteServerAssociation`\n\nSpecifies the association between a route server and a VPC.\nA route server association is the connection established between a route server and a VPC.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the route server ID and VPC ID separated by the pipe symbol (|).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverassociation.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the associated VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverassociation.html#cfn-ec2-routeserverassociation-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RouteServerId": { "MarkdownDocumentation": "`RouteServerId`\n\nThe ID of the associated route server.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverassociation.html#cfn-ec2-routeserverassociation-routeserverid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::RouteServerEndpoint": { "MarkdownDocumentation": "`AWS::EC2::RouteServerEndpoint`\n\nCreates a new endpoint for a route server in a specified subnet.\nA route server endpoint is an AWS-managed component inside a subnet that facilitates [BGP (Border Gateway Protocol)](https://en.wikipedia.org/wiki/Border_Gateway_Protocol) connections between your route server and your BGP peers.\nFor more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the endpoint ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html", "Properties": { "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet to place the route server endpoint into.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html#cfn-ec2-routeserverendpoint-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RouteServerId": { "MarkdownDocumentation": "`RouteServerId`\n\nThe ID of the route server associated with this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html#cfn-ec2-routeserverendpoint-routeserverid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the route server endpoint.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-routeserverendpoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html#cfn-ec2-routeserverendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC containing the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html#VpcId-fn::getatt" }, "EniId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EniId`\n\nThe ID of the Elastic network interface for the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html#EniId-fn::getatt" }, "EniAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`EniAddress`\n\nThe IP address of the Elastic network interface for the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html#EniAddress-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the route server endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN for the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverendpoint.html#Arn-fn::getatt" } } }, "AWS::EC2::RouteServerPeer": { "MarkdownDocumentation": "`AWS::EC2::RouteServerPeer`\n\nSpecifies a BGP peer configuration for a route server endpoint.\nA route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the peer ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html", "Properties": { "PeerAddress": { "MarkdownDocumentation": "`PeerAddress`\n\nThe IPv4 address of the peer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#cfn-ec2-routeserverpeer-peeraddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BgpOptions": { "MarkdownDocumentation": "`BgpOptions`\n\nThe BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.\n*Required*: Yes\n*Type*: [BgpOptions](./aws-properties-ec2-routeserverpeer-bgpoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#cfn-ec2-routeserverpeer-bgpoptions", "UpdateType": "Immutable", "Required": true, "Type": "BgpOptions" }, "RouteServerEndpointId": { "MarkdownDocumentation": "`RouteServerEndpointId`\n\nThe ID of the route server endpoint associated with this peer.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#cfn-ec2-routeserverpeer-routeserverendpointid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the route server peer.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-routeserverpeer-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#cfn-ec2-routeserverpeer-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "EndpointEniId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointEniId`\n\nThe ID of the Elastic network interface for the route server endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#EndpointEniId-fn::getatt" }, "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC containing the route server peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#VpcId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the route server peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#Id-fn::getatt" }, "SubnetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet containing the route server peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#SubnetId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the route server peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#Arn-fn::getatt" }, "EndpointEniAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointEniAddress`\n\nThe IP address of the Elastic network interface for the route server endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#EndpointEniAddress-fn::getatt" }, "RouteServerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RouteServerId`\n\nThe ID of the route server associated with this peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html#RouteServerId-fn::getatt" } } }, "AWS::EC2::RouteServerPropagation": { "MarkdownDocumentation": "`AWS::EC2::RouteServerPropagation`\n\nSpecifies route propagation from a route server to a route table.\nFor more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the route server ID and route table ID separated by the pipe symbol (|).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpropagation.html", "Properties": { "RouteTableId": { "MarkdownDocumentation": "`RouteTableId`\n\nThe ID of the route table configured for route server propagation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpropagation.html#cfn-ec2-routeserverpropagation-routetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RouteServerId": { "MarkdownDocumentation": "`RouteServerId`\n\nThe ID of the route server configured for route propagation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpropagation.html#cfn-ec2-routeserverpropagation-routeserverid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::RouteTable": { "MarkdownDocumentation": "`AWS::EC2::RouteTable`\n\nSpecifies a route table for the specified VPC. After you create a route table, you can add\nroutes and associate the table with a subnet.\nFor more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html)\nin the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the route table.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#cfn-ec2-routetable-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the route table.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-routetable-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#cfn-ec2-routetable-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "RouteTableId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RouteTableId`\n\nThe ID of the route table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#RouteTableId-fn::getatt" } } }, "AWS::EC2::SecurityGroup": { "MarkdownDocumentation": "`AWS::EC2::SecurityGroup`\n\nSpecifies a security group.\nYou must specify ingress rules to allow inbound traffic. By default, no inbound\ntraffic is allowed.\nWhen you create a security group, if you do not add egress rules, we add egress\nrules that allow all outbound IPv4 and IPv6 traffic. Otherwise, we do not add them.\nAfter the security group is created, if you remove all egress rules that you added,\nwe do not add egress rules, so no outbound traffic is allowed.\nIf you modify a rule, CloudFormation removes the existing rule and then adds a new rule.\nThere is a brief period when neither the original rule or the new rule exists, so the\ncorresponding traffic is dropped.\nThis type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n###### Important\nTo cross-reference two security groups in the ingress and egress rules of those\nsecurity groups, use the [AWS::EC2::SecurityGroupEgress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html) and [AWS::EC2::SecurityGroupIngress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-ingress.html) resources to define your rules. Do not use\nthe embedded ingress and egress rules in the `AWS::EC2::SecurityGroup`. Doing\nso creates a circular dependency, which CloudFormation doesn't allow.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the security group if you specified the `VpcId` property.\nOtherwise, it returns the name of the security group. If you omit the `VpcId` property\nand need the ID of the security group, use `Fn::GetAtt` instead.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html", "Properties": { "GroupDescription": { "MarkdownDocumentation": "`GroupDescription`\n\nA description for the security group.\nConstraints: Up to 255 characters in length\nValid characters: a-z, A-Z, 0-9, spaces, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-groupdescription", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the security group. Names are case-insensitive and must be unique within the VPC.\nConstraints: Up to 255 characters in length. Can't start with `sg-`.\nValid characters: a-z, A-Z, 0-9, spaces, and .\\_-:/()#,@[]+=&;{}!$\\*\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-groupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC for the security group. If you do not specify a VPC, the default is\nto use the default VPC for the Region. If there's no specified VPC and no default VPC,\nsecurity group creation fails.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIngress": { "MarkdownDocumentation": "`SecurityGroupIngress`\n\nThe inbound rules associated with the security group.\n*Required*: No\n*Type*: Array of [Ingress](./aws-properties-ec2-securitygroup-ingress.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-securitygroupingress", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Ingress", "DuplicatesAllowed": true }, "SecurityGroupEgress": { "MarkdownDocumentation": "`SecurityGroupEgress`\n\nThe outbound rules associated with the security group.\n*Required*: No\n*Type*: Array of [Egress](./aws-properties-ec2-securitygroup-egress.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-securitygroupegress", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Egress", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the security group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-securitygroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC, such as `vpc-0669f8f9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#VpcId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#Id-fn::getatt" }, "GroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupId`\n\nThe ID of the security group, such as `sg-94b3a1f6`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#GroupId-fn::getatt" } } }, "AWS::EC2::SecurityGroupEgress": { "MarkdownDocumentation": "`AWS::EC2::SecurityGroupEgress`\n\nAdds the specified outbound (egress) rule to a security group.\nAn outbound rule permits instances to send traffic to the specified IPv4 or IPv6\naddress range, the IP addresses that are specified by a prefix list, or the instances\nthat are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).\nYou must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range,\na prefix list, or a security group.\nYou must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP,\nyou must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also\nspecify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.\nRule changes are propagated to instances associated with the security group as quickly\nas possible. However, a small delay might occur.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the security egress rule.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html", "Properties": { "CidrIp": { "MarkdownDocumentation": "`CidrIp`\n\nThe IPv4 address range, in CIDR format.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `DestinationPrefixListId`, or `DestinationSecurityGroupId`.\nFor examples of rules that you can add to\nsecurity groups for specific access scenarios, see [Security group rules\nfor different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-cidrip", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CidrIpv6": { "MarkdownDocumentation": "`CidrIpv6`\n\nThe IPv6 address range, in CIDR format.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `DestinationPrefixListId`, or `DestinationSecurityGroupId`.\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\n*Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-cidripv6", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of an egress (outbound) security group rule.\nConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\nspaces, and .\\_-:/()#,@[]+=;{}!$\\*\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nIf the protocol is TCP or UDP, this is the start of the port range.\nIf the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-fromport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nIf the protocol is TCP or UDP, this is the end of the port range.\nIf the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes).\nIf the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-toport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "IpProtocol": { "MarkdownDocumentation": "`IpProtocol`\n\nThe IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`)\nor number (see [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).\nUse `-1` to specify all protocols. When authorizing\nsecurity group rules, specifying `-1` or a protocol number other than\n`tcp`, `udp`, `icmp`, or `icmpv6` allows\ntraffic on all ports, regardless of any port range you specify. For `tcp`,\n`udp`, and `icmp`, you must specify a port range. For `icmpv6`,\nthe port range is optional; if you omit the port range, traffic for all types and codes is allowed.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-ipprotocol", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DestinationSecurityGroupId": { "MarkdownDocumentation": "`DestinationSecurityGroupId`\n\nThe ID of the security group.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `DestinationPrefixListId`, or `DestinationSecurityGroupId`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DestinationPrefixListId": { "MarkdownDocumentation": "`DestinationPrefixListId`\n\nThe prefix list IDs for an AWS service. This is the AWS service to access through a\nVPC endpoint from instances associated with the security group.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `DestinationPrefixListId`, or `DestinationSecurityGroupId`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-destinationprefixlistid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GroupId": { "MarkdownDocumentation": "`GroupId`\n\nThe ID of the security group. You must specify either the security group ID or the\nsecurity group name in the request. For security groups in a nondefault VPC, you must\nspecify the security group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-groupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#Id-fn::getatt" } } }, "AWS::EC2::SecurityGroupIngress": { "MarkdownDocumentation": "`AWS::EC2::SecurityGroupIngress`\n\nAdds an inbound (ingress) rule to a security group.\nAn inbound rule permits instances to receive traffic from the specified IPv4 or IPv6\naddress range, the IP addresses that are specified by a prefix list, or the instances\nthat are associated with a source security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).\nYou must specify exactly one of the following sources: an IPv4 address range, an IPv6 address range,\na prefix list, or a security group.\nYou must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP,\nyou must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also\nspecify the ICMP/ICMPv6 type and code.\nRule changes are propagated to instances associated with the security group as quickly\nas possible. However, a small delay might occur.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\n[Default VPC] The name of the security group. For security groups for a default VPC\nyou can specify either the ID or the name of the security group. For security groups for\na nondefault VPC, you must specify the ID of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-groupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CidrIp": { "MarkdownDocumentation": "`CidrIp`\n\nThe IPv4 address range, in CIDR format.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `SourcePrefixListId`, or `SourceSecurityGroupId`.\nFor examples of rules that you can add to security groups for specific access scenarios,\nsee [Security group rules\nfor different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-cidrip", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CidrIpv6": { "MarkdownDocumentation": "`CidrIpv6`\n\nThe IPv6 address range, in CIDR format.\nYou must specify exactly one of the following:\n`CidrIp`, `CidrIpv6`, `SourcePrefixListId`, or `SourceSecurityGroupId`.\nFor examples of rules that you can add to security groups for specific access scenarios,\nsee [Security group rules\nfor different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-cidripv6", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nUpdates the description of an ingress (inbound) security group rule. You can replace an\nexisting description, or add a description to a rule that did not have one\npreviously.\nConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\nspaces, and .\\_-:/()#,@[]+=;{}!$\\*\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FromPort": { "MarkdownDocumentation": "`FromPort`\n\nThe start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A\nvalue of `-1` indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6\ntypes, you must specify all codes.\nUse this for ICMP and any protocol that uses ports.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-fromport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "SourceSecurityGroupName": { "MarkdownDocumentation": "`SourceSecurityGroupName`\n\n[Default VPC] The name of the source security group. You must specify either the security group ID\nor the security group name. You can't specify the group name in combination with an IP address range.\nCreates rules that grant full ICMP, UDP, and TCP access.\nFor security groups in a nondefault VPC, you must specify the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ToPort": { "MarkdownDocumentation": "`ToPort`\n\nThe end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of\n`-1` indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you\nspecify all ICMP/ICMPv6 types, you must specify all codes.\nUse this for ICMP and any protocol that uses ports.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-toport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "SourceSecurityGroupOwnerId": { "MarkdownDocumentation": "`SourceSecurityGroupOwnerId`\n\n[nondefault VPC] The AWS account ID for the source security group, if\nthe source security group is in a different account. You can't specify this property with\nan IP address range. Creates rules that grant full ICMP, UDP, and TCP access.\nIf you specify `SourceSecurityGroupName` or\n`SourceSecurityGroupId` and that security group is owned by a different\naccount than the account creating the stack, you must specify\n`SourceSecurityGroupOwnerId`; otherwise, this property is optional.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupownerid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IpProtocol": { "MarkdownDocumentation": "`IpProtocol`\n\nThe IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`)\nor number (see [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).\nUse `-1` to specify all protocols. When authorizing\nsecurity group rules, specifying `-1` or a protocol number other than\n`tcp`, `udp`, `icmp`, or `icmpv6` allows\ntraffic on all ports, regardless of any port range you specify. For `tcp`,\n`udp`, and `icmp`, you must specify a port range. For `icmpv6`,\nthe port range is optional; if you omit the port range, traffic for all types and codes is allowed.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-ipprotocol", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceSecurityGroupId": { "MarkdownDocumentation": "`SourceSecurityGroupId`\n\nThe ID of the security group. You must specify either the security group ID or the\nsecurity group name. For security groups in a nondefault VPC, you must specify the security\ngroup 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourcePrefixListId": { "MarkdownDocumentation": "`SourcePrefixListId`\n\nThe ID of a prefix 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourceprefixlistid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GroupId": { "MarkdownDocumentation": "`GroupId`\n\nThe ID of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-groupid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#Id-fn::getatt" } } }, "AWS::EC2::SecurityGroupVpcAssociation": { "MarkdownDocumentation": "`AWS::EC2::SecurityGroupVpcAssociation`\n\nA security group association with a VPC.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a concatenation of the security group ID and VPC ID in the format `sg-id|vpc-id`. Example:`sg-a1b2c3d4e5a6b7d8e|vpc-a1b2c3d4e5a6b7d8e`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupvpcassociation.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe association's VPC 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupvpcassociation.html#cfn-ec2-securitygroupvpcassociation-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GroupId": { "MarkdownDocumentation": "`GroupId`\n\nThe association's security group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupvpcassociation.html#cfn-ec2-securitygroupvpcassociation-groupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe association's state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupvpcassociation.html#State-fn::getatt" }, "StateReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`StateReason`\n\nThe association's state reason.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupvpcassociation.html#StateReason-fn::getatt" }, "VpcOwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcOwnerId`\n\nThe AWS account ID of the owner of the VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupvpcassociation.html#VpcOwnerId-fn::getatt" } } }, "AWS::EC2::SnapshotBlockPublicAccess": { "MarkdownDocumentation": "`AWS::EC2::SnapshotBlockPublicAccess`\n\nSpecifies the state of the *block public access for snapshots*\nsetting for the Region. For more information, see [Block public access for snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the AWS account.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-snapshotblockpublicaccess.html", "Properties": { "State": { "MarkdownDocumentation": "`State`\n\nThe mode in which to enable block public access for snapshots for the Region.\nSpecify one of the following values:\n* `block-all-sharing` - Prevents all public sharing of snapshots in\n the Region. Users in the account will no longer be able to request new public\n sharing. Additionally, snapshots that are already publicly shared are treated as\n private and they are no longer publicly available.\n \n ###### Note\n \n If you enable block public access for snapshots in `block-all-sharing`\n mode, it does not change the permissions for snapshots that are already publicly shared.\n Instead, it prevents these snapshots from be publicly visible and publicly accessible.\n Therefore, the attributes for these snapshots still indicate that they are publicly\n shared, even though they are not publicly available.\n* `block-new-sharing` - Prevents only new public sharing of snapshots\n in the Region. Users in the account will no longer be able to request new public\n sharing. However, snapshots that are already publicly shared, remain publicly\n available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `block-all-sharing | block-n...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "block-all-sharing", "block-new-sharing" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-snapshotblockpublicaccess.html#cfn-ec2-snapshotblockpublicaccess-state", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the AWS account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-snapshotblockpublicaccess.html#AccountId-fn::getatt" } } }, "AWS::EC2::SpotFleet": { "MarkdownDocumentation": "`AWS::EC2::SpotFleet`\n\nSpecifies a Spot Fleet request.\nThe Spot Fleet request specifies the total target capacity and the On-Demand target\ncapacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\ncapacity, and launches the difference as Spot capacity.\nYou can submit a single request that includes multiple launch specifications that vary\nby instance type, AMI, Availability Zone, or subnet.\nBy default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\nprice per unit is the lowest. Each launch specification can include its own instance\nweighting that reflects the value of the instance type to your application\nworkload.\nAlternatively, you can specify that the Spot Fleet distribute the target capacity\nacross the Spot pools included in its launch specifications. By ensuring that the Spot\nInstances in your Spot Fleet are in different Spot pools, you can improve the\navailability of your fleet.\nYou can specify tags for the Spot Fleet request and instances launched by the fleet.\nYou cannot tag other resource types in a Spot Fleet request because only the\n`spot-fleet-request` and `instance` resource types are\nsupported.\nFor more information, see [Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html)\nin the *Amazon EC2 User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Spot Fleet.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html", "Properties": { "SpotFleetRequestConfigData": { "MarkdownDocumentation": "`SpotFleetRequestConfigData`\n\nDescribes the configuration of a Spot Fleet request.\n*Required*: Yes\n*Type*: [SpotFleetRequestConfigData](./aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata", "UpdateType": "Mutable", "Required": true, "Type": "SpotFleetRequestConfigData" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for a Spot Fleet resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-spotfleet-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#cfn-ec2-spotfleet-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the Spot Fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#Id-fn::getatt" } } }, "AWS::EC2::Subnet": { "MarkdownDocumentation": "`AWS::EC2::Subnet`\n\nSpecifies a subnet for the specified VPC.\nFor an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block,\nyou can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet,\nspecify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and\nan IPv6 CIDR block.\nFor more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the subnet.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html", "Properties": { "MapPublicIpOnLaunch": { "MarkdownDocumentation": "`MapPublicIpOnLaunch`\n\nIndicates whether instances launched in this subnet receive a public IPv4 address. The\ndefault value is `false`.\nAWS charges for all public IPv4 addresses, including public IPv4 addresses\nassociated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab\non the [VPC pricing page](https://aws.amazon.com/vpc/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableDns64": { "MarkdownDocumentation": "`EnableDns64`\n\nIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet\nshould return synthetic IPv6 addresses for IPv4-only destinations.\n###### Note\nYou must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a `0.0.0.0/0` route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *Amazon Virtual Private Cloud 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-enabledns64", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AvailabilityZoneId": { "MarkdownDocumentation": "`AvailabilityZoneId`\n\nThe AZ ID of the subnet.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzoneid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OutpostArn": { "MarkdownDocumentation": "`OutpostArn`\n\nThe Amazon Resource Name (ARN) of the Outpost.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-outpostarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone of the subnet.\nIf you update this property, you must also update the `CidrBlock`\nproperty.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CidrBlock": { "MarkdownDocumentation": "`CidrBlock`\n\nThe IPv4 CIDR block assigned to the subnet.\nIf you update this property, we create a new subnet, and then delete the existing\none.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnableLniAtDeviceIndex": { "MarkdownDocumentation": "`EnableLniAtDeviceIndex`\n\nIndicates the device position for local network interfaces in this subnet. For example,\n`1` indicates local network interfaces in this subnet are the secondary\nnetwork interface (eth1).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-enablelniatdeviceindex", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv6NetmaskLength": { "MarkdownDocumentation": "`Ipv6NetmaskLength`\n\nAn IPv6 netmask length for the subnet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6netmasklength", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv6IpamPoolId": { "MarkdownDocumentation": "`Ipv6IpamPoolId`\n\nAn IPv6 IPAM pool ID for the subnet.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6ipampoolid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AssignIpv6AddressOnCreation": { "MarkdownDocumentation": "`AssignIpv6AddressOnCreation`\n\nIndicates whether a network interface created in this subnet receives an IPv6 address.\nThe default value is `false`.\nIf you specify `AssignIpv6AddressOnCreation`, you must also specify\nan IPv6 CIDR block.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC the subnet is in.\nIf you update this property, you must also update the `CidrBlock`\nproperty.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Ipv4NetmaskLength": { "MarkdownDocumentation": "`Ipv4NetmaskLength`\n\nAn IPv4 netmask length for the subnet.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv4netmasklength", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "PrivateDnsNameOptionsOnLaunch": { "MarkdownDocumentation": "`PrivateDnsNameOptionsOnLaunch`\n\nThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide*.\nAvailable options:\n* EnableResourceNameDnsAAAARecord (true | false)\n* EnableResourceNameDnsARecord (true | false)\n* HostnameType (ip-name | resource-name)\n*Required*: No\n*Type*: [PrivateDnsNameOptionsOnLaunch](./aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch", "UpdateType": "Mutable", "Required": false, "Type": "PrivateDnsNameOptionsOnLaunch" }, "Ipv4IpamPoolId": { "MarkdownDocumentation": "`Ipv4IpamPoolId`\n\nAn IPv4 IPAM pool ID for the subnet.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv4ipampoolid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Ipv6Native": { "MarkdownDocumentation": "`Ipv6Native`\n\nIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *Amazon Virtual Private Cloud 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6native", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Ipv6CidrBlock": { "MarkdownDocumentation": "`Ipv6CidrBlock`\n\nThe IPv6 CIDR block.\nIf you specify `AssignIpv6AddressOnCreation`, you must also specify\nan IPv6 CIDR block.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the subnet.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-subnet-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "BlockPublicAccessStates.InternetGatewayBlockMode": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#BlockPublicAccessStates.InternetGatewayBlockMode-fn::getatt" }, "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe ID of the subnet's VPC, such as `vpc-11ad4878`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#VpcId-fn::getatt" }, "NetworkAclAssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkAclAssociationId`\n\nThe ID of the network ACL that is associated with the subnet's VPC, such as\n`acl-5fb85d36`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#NetworkAclAssociationId-fn::getatt" }, "AvailabilityZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AvailabilityZoneId`\n\nThe Availability Zone ID of this subnet. For example, `use1-az1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#AvailabilityZoneId-fn::getatt" }, "OutpostArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`OutpostArn`\n\nThe Amazon Resource Name (ARN) of the Outpost.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#OutpostArn-fn::getatt" }, "AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone of this subnet. For example, `us-east-1a`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#AvailabilityZone-fn::getatt" }, "CidrBlock": { "PrimitiveType": "String", "MarkdownDocumentation": "`CidrBlock`\n\nThe IPv4 CIDR blocks that are associated with the subnet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#CidrBlock-fn::getatt" }, "SubnetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#SubnetId-fn::getatt" }, "BlockPublicAccessStates": { "Type": "BlockPublicAccessStates", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#BlockPublicAccessStates-fn::getatt" }, "Ipv6CidrBlocks": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Ipv6CidrBlocks`\n\nThe IPv6 CIDR blocks that are associated with the subnet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#Ipv6CidrBlocks-fn::getatt" } } }, "AWS::EC2::SubnetCidrBlock": { "MarkdownDocumentation": "`AWS::EC2::SubnetCidrBlock`\n\nAssociates a CIDR block with your subnet. You can associate a single IPv6 CIDR block\nwith your subnet.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the association ID for the subnet\u2019s IPv6 CIDR block.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html", "Properties": { "Ipv6NetmaskLength": { "MarkdownDocumentation": "`Ipv6NetmaskLength`\n\nAn IPv6 netmask length for the subnet.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6netmasklength", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv6IpamPoolId": { "MarkdownDocumentation": "`Ipv6IpamPoolId`\n\nAn IPv6 IPAM pool ID for the subnet.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6ipampoolid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Ipv6CidrBlock": { "MarkdownDocumentation": "`Ipv6CidrBlock`\n\nThe IPv6 network range for the subnet, in CIDR notation.\n*Required*: Conditional\n*Type*: String\n*Maximum*: `42`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6cidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Ipv6AddressAttribute": { "PrimitiveType": "String", "MarkdownDocumentation": "`Ipv6AddressAttribute`\n\nPublic IPv6 addresses are those advertised on the internet from AWS. Private IP addresses are not and cannot be advertised on the internet from AWS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#Ipv6AddressAttribute-fn::getatt" }, "IpSource": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpSource`\n\nThe source that allocated the IP address space. `byoip` or `amazon` indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). `none` indicates private space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#IpSource-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#Id-fn::getatt" } } }, "AWS::EC2::SubnetNetworkAclAssociation": { "MarkdownDocumentation": "`AWS::EC2::SubnetNetworkAclAssociation`\n\nAssociates a subnet with a network ACL. For more information, see [ReplaceNetworkAclAssociation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-ReplaceNetworkAclAssociation.html) in the *Amazon EC2 API\nReference*.\nWhen `AWS::EC2::SubnetNetworkAclAssociation` resources are created during\ncreate or update operations, AWS CloudFormation adopts existing resources that share\nthe same key properties (the properties that contribute to uniquely identify the resource).\nHowever, if the operation fails and rolls back, AWS CloudFormation deletes the\npreviously out-of-band resources. You can protect against this behavior by using\n`Retain` deletion policies. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the subnet network ACL association.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html", "Properties": { "NetworkAclId": { "MarkdownDocumentation": "`NetworkAclId`\n\nThe ID of the network ACL.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#cfn-ec2-subnetnetworkaclassociation-networkaclid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#cfn-ec2-subnetnetworkaclassociation-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationId`\n\nReturns the value of this object's AssociationId property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#AssociationId-fn::getatt" } } }, "AWS::EC2::SubnetRouteTableAssociation": { "MarkdownDocumentation": "`AWS::EC2::SubnetRouteTableAssociation`\n\nAssociates a subnet with a route table. The subnet and route table must be in the same\nVPC. This association causes traffic originating from the subnet to be routed according to\nthe routes in the route table. A route table can be associated with multiple subnets. To\ncreate a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the subnet route table association.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html", "Properties": { "RouteTableId": { "MarkdownDocumentation": "`RouteTableId`\n\nThe ID of the route table.\nThe physical ID changes when the route table ID is changed.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-routetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the subnet route table association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#Id-fn::getatt" } } }, "AWS::EC2::TrafficMirrorFilter": { "MarkdownDocumentation": "`AWS::EC2::TrafficMirrorFilter`\n\nSpecifies a Traffic Mirror filter.\nA Traffic Mirror filter is a set of rules that defines the traffic to mirror.\nBy default, no traffic is mirrored. To mirror traffic, use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to add Traffic Mirror rules to the filter.\nThe rules you add define what traffic gets mirrored.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Traffic Mirror filter.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the Traffic Mirror filter.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkServices": { "MarkdownDocumentation": "`NetworkServices`\n\nThe network service traffic that is associated with the Traffic Mirror filter.\nValid values are `amazon-dns`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-networkservices", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to a Traffic Mirror filter.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-trafficmirrorfilter-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#Id-fn::getatt" } } }, "AWS::EC2::TrafficMirrorFilterRule": { "MarkdownDocumentation": "`AWS::EC2::TrafficMirrorFilterRule`\n\nCreates a Traffic Mirror filter rule.\nA Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.\nYou need the Traffic Mirror filter ID when you create the rule.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Traffic Mirror filter rule.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html", "Properties": { "DestinationPortRange": { "MarkdownDocumentation": "`DestinationPortRange`\n\nThe destination port range.\n*Required*: No\n*Type*: [TrafficMirrorPortRange](./aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationportrange", "UpdateType": "Mutable", "Required": false, "Type": "TrafficMirrorPortRange" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the Traffic Mirror rule.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourcePortRange": { "MarkdownDocumentation": "`SourcePortRange`\n\nThe source port range.\n*Required*: No\n*Type*: [TrafficMirrorPortRange](./aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourceportrange", "UpdateType": "Mutable", "Required": false, "Type": "TrafficMirrorPortRange" }, "RuleAction": { "MarkdownDocumentation": "`RuleAction`\n\nThe action to take on the filtered traffic.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `accept | reject...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "accept", "reject" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-ruleaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SourceCidrBlock": { "MarkdownDocumentation": "`SourceCidrBlock`\n\nThe source CIDR block to assign to the Traffic Mirror 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourcecidrblock", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RuleNumber": { "MarkdownDocumentation": "`RuleNumber`\n\nThe number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\ndirection. The rules are processed in ascending order by rule number.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-rulenumber", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DestinationCidrBlock": { "MarkdownDocumentation": "`DestinationCidrBlock`\n\nThe destination CIDR block to assign to the Traffic Mirror 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationcidrblock", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TrafficMirrorFilterId": { "MarkdownDocumentation": "`TrafficMirrorFilterId`\n\nThe ID of the filter that this rule 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorfilterid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TrafficDirection": { "MarkdownDocumentation": "`TrafficDirection`\n\nThe type of traffic.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ingress | egress...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ingress", "egress" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficdirection", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol, for example UDP, to assign to the Traffic Mirror rule.\nFor information about the protocol value, see [Protocol Numbers](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags on Traffic Mirroring filter rules.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-trafficmirrorfilterrule-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "TrafficMirrorFilterRuleId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrafficMirrorFilterRuleId`\n\nThe ID of the Traffic Mirror rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#TrafficMirrorFilterRuleId-fn::getatt" } } }, "AWS::EC2::TrafficMirrorSession": { "MarkdownDocumentation": "`AWS::EC2::TrafficMirrorSession`\n\nCreates a Traffic Mirror session.\nA Traffic Mirror session actively copies packets from a Traffic Mirror source to a\nTraffic Mirror target. Create a filter, and then assign it to the session to define a\nsubset of the traffic to mirror, for example all TCP traffic.\nThe Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be\nin the same VPC, or in a different VPC connected via VPC peering or a transit gateway.\nBy default, no traffic is mirrored. Use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to specify filter rules that specify the\ntraffic to mirror.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Traffic Mirror Session.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html", "Properties": { "TrafficMirrorTargetId": { "MarkdownDocumentation": "`TrafficMirrorTargetId`\n\nThe ID of the Traffic Mirror 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrortargetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the Traffic Mirror 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OwnerId": { "MarkdownDocumentation": "`OwnerId`\n\nThe ID of the account that owns the Traffic Mirror 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-ownerid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SessionNumber": { "MarkdownDocumentation": "`SessionNumber`\n\nThe session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.\nValid values are 1-32766.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-sessionnumber", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "VirtualNetworkId": { "MarkdownDocumentation": "`VirtualNetworkId`\n\nThe VXLAN ID for the Traffic Mirror session. For more information about the VXLAN\nprotocol, see [RFC 7348](https://datatracker.ietf.org/doc/html/rfc7348). If you do\nnot specify a `VirtualNetworkId`, an account-wide unique ID is chosen at\nrandom.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-virtualnetworkid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PacketLength": { "MarkdownDocumentation": "`PacketLength`\n\nThe number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\nnot specify this parameter when you want to mirror the entire packet. To mirror a subset of\nthe packet, set this to the length (in bytes) that you want to mirror. For example, if you\nset this value to 100, then the first 100 bytes that meet the filter criteria are copied to\nthe target.\nIf you do not want to mirror the entire packet, use the `PacketLength` parameter to specify the number of bytes in each packet to mirror.\nFor sessions with Network Load Balancer (NLB) Traffic Mirror targets the default `PacketLength` will be set to 8500. Valid values are 1-8500. Setting a `PacketLength` greater than 8500 will result in an error response.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-packetlength", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe ID of the source network interface.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-networkinterfaceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TrafficMirrorFilterId": { "MarkdownDocumentation": "`TrafficMirrorFilterId`\n\nThe ID of the Traffic Mirror 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrorfilterid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to a Traffic Mirror session.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-trafficmirrorsession-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#Id-fn::getatt" } } }, "AWS::EC2::TrafficMirrorTarget": { "MarkdownDocumentation": "`AWS::EC2::TrafficMirrorTarget`\n\nSpecifies a target for your Traffic Mirror session.\nA Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror\nsource and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in\ndifferent VPCs connected via VPC peering or a transit gateway.\nA Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.\nTo use the target in a Traffic Mirror session, use [AWS::EC2::TrafficMirrorSession](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Traffic Mirror target.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html", "Properties": { "NetworkLoadBalancerArn": { "MarkdownDocumentation": "`NetworkLoadBalancerArn`\n\nThe Amazon Resource Name (ARN) of the Network Load Balancer that is associated with 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkloadbalancerarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the Traffic Mirror 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe network interface ID that is associated with 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkinterfaceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GatewayLoadBalancerEndpointId": { "MarkdownDocumentation": "`GatewayLoadBalancerEndpointId`\n\nThe ID of the Gateway Load Balancer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-gatewayloadbalancerendpointid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the Traffic Mirror target.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-trafficmirrortarget-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#Id-fn::getatt" } } }, "AWS::EC2::TransitGateway": { "MarkdownDocumentation": "`AWS::EC2::TransitGateway`\n\nSpecifies a transit gateway.\nYou can use a transit gateway to interconnect your virtual private clouds (VPC) and\non-premises networks. After the transit gateway enters the `available` state,\nyou can attach your VPCs and VPN connections to the transit gateway.\nTo attach your VPCs, use [AWS::EC2::TransitGatewayAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html).\nTo attach a VPN connection, use [AWS::EC2::CustomerGateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html) to create a customer gateway and specify the ID of\nthe customer gateway and the ID of the transit gateway in a call to [AWS::EC2::VPNConnection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html).\nWhen you create a transit gateway, we create a default transit gateway route table and\nuse it as the default association route table and the default propagation route table. You\ncan use [AWS::EC2::TransitGatewayRouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html) to create additional transit gateway route\ntables. If you disable automatic route propagation, we do not create a default transit\ngateway route table. You can use [AWS::EC2::TransitGatewayRouteTablePropagation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html) to propagate routes from a\nresource attachment to a transit gateway route table. If you disable automatic\nassociations, you can use [AWS::EC2::TransitGatewayRouteTableAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html) to associate a resource\nattachment with a transit gateway route table.\nTo create a transit gateway with `EncryptionSupport` enabled through CloudFormation, you will need the `ec2:ModifyTransitGateway` Identity and Access Management (IAM) permission. For more information, see\n`ModifyTransitGateway` in [Actions, resources, and condition keys for Amazon EC2](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonec2.html#amazonec2-actions-as-) of the\n*Identify and Access Management Service Authorization Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the transit gateway.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssociationDefaultRouteTableId": { "MarkdownDocumentation": "`AssociationDefaultRouteTableId`\n\nThe ID of the default association route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-associationdefaultroutetableid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutoAcceptSharedAttachments": { "MarkdownDocumentation": "`AutoAcceptSharedAttachments`\n\nEnable or disable automatic acceptance of attachment requests. Disabled by default.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-autoacceptsharedattachments", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultRouteTablePropagation": { "MarkdownDocumentation": "`DefaultRouteTablePropagation`\n\nEnable or disable automatic propagation of routes to the default propagation route table. Enabled by default. If `DefaultRouteTablePropagation` is set to enable, AWS Transit Gateway will create the default transit gateway route table.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetablepropagation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TransitGatewayCidrBlocks": { "MarkdownDocumentation": "`TransitGatewayCidrBlocks`\n\nThe transit gateway CIDR blocks.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-transitgatewaycidrblocks", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PropagationDefaultRouteTableId": { "MarkdownDocumentation": "`PropagationDefaultRouteTableId`\n\nThe ID of the default propagation route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-propagationdefaultroutetableid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultRouteTableAssociation": { "MarkdownDocumentation": "`DefaultRouteTableAssociation`\n\nEnable or disable automatic association with the default association route table. Enabled by default. If `DefaultRouteTableAssociation` is set to enable, AWS Transit Gateway will create the default transit gateway route table.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetableassociation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpnEcmpSupport": { "MarkdownDocumentation": "`VpnEcmpSupport`\n\nEnable or disable Equal Cost Multipath Protocol support. Enabled by default.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-vpnecmpsupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupReferencingSupport": { "MarkdownDocumentation": "`SecurityGroupReferencingSupport`\n\nEnables you to reference a security group across VPCs attached to a transit gateway (TGW). Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.\nFor important information about this feature, see [Create a transit gateway](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html#create-tgw) in the *AWS Transit Gateway Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-securitygroupreferencingsupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DnsSupport": { "MarkdownDocumentation": "`DnsSupport`\n\nEnable or disable DNS support. Enabled by default.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-dnssupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MulticastSupport": { "MarkdownDocumentation": "`MulticastSupport`\n\nIndicates whether multicast is enabled on the transit gateway\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-multicastsupport", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AmazonSideAsn": { "MarkdownDocumentation": "`AmazonSideAsn`\n\nA private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range\nis 64512 to 65534 for 16-bit ASNs. The default is 64512.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-amazonsideasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Long" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the transit gateway.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgateway-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "EncryptionSupport": { "MarkdownDocumentation": "`EncryptionSupport`\n\nEnable or disable encryption support. Disabled by default.\n*Required*: No\n*Type*: String\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)", "RefReturnValue": "", "AllowedValues": [ "disable", "enable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-encryptionsupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "EncryptionSupportState": { "PrimitiveType": "String", "MarkdownDocumentation": "`EncryptionSupportState`\n\nThe encryption support state of the transit gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#EncryptionSupportState-fn::getatt" }, "TransitGatewayArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#TransitGatewayArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the transit gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#Id-fn::getatt" } } }, "AWS::EC2::TransitGatewayAttachment": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayAttachment`\n\nAttaches a VPC to a transit gateway.\nIf you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is\nalready attached, the new VPC CIDR range is not propagated to the default propagation route\ntable.\nTo send VPC traffic to an attached transit gateway, add a route to the VPC route table\nusing [AWS::EC2::Route](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html).\nTo update tags for a VPC attachment after creation without replacing the attachment, use\n[AWS::EC2::TransitGatewayVpcAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html) instead.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the attachment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nThe VPC attachment options.\n*Required*: No\n*Type*: [Options](./aws-properties-ec2-transitgatewayattachment-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-options", "UpdateType": "Mutable", "Required": false, "Type": "Options" }, "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-transitgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of one or more subnets. You can specify only one subnet per Availability Zone.\nYou must specify at least one subnet, but we recommend that you specify two subnets for better availability.\nThe transit gateway uses one IP address from each specified subnet.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the attachment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgatewayattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#Id-fn::getatt" } } }, "AWS::EC2::TransitGatewayConnect": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayConnect`\n\nCreates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.\nA Connect attachment uses an existing VPC or AWS Direct Connect attachment as the underlying transport mechanism.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the transit gateway attachment.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nThe Connect attachment options.\n* protocol (gre)\n*Required*: Yes\n*Type*: [TransitGatewayConnectOptions](./aws-properties-ec2-transitgatewayconnect-transitgatewayconnectoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-options", "UpdateType": "Immutable", "Required": true, "Type": "TransitGatewayConnectOptions" }, "TransportTransitGatewayAttachmentId": { "MarkdownDocumentation": "`TransportTransitGatewayAttachmentId`\n\nThe ID of the attachment from which the Connect attachment was 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-transporttransitgatewayattachmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the attachment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgatewayconnect-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "TransitGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#TransitGatewayId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#State-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe creation time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#CreationTime-fn::getatt" }, "TransitGatewayAttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the transit gateway attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#TransitGatewayAttachmentId-fn::getatt" } } }, "AWS::EC2::TransitGatewayConnectPeer": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayConnectPeer`\n\nDescribes a transit gateway Connect peer.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Connect peer.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html", "Properties": { "ConnectPeerConfiguration": { "MarkdownDocumentation": "`ConnectPeerConfiguration`\n\nThe Connect peer details.\n*Required*: Yes\n*Type*: [TransitGatewayConnectPeerConfiguration](./aws-properties-ec2-transitgatewayconnectpeer-transitgatewayconnectpeerconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html#cfn-ec2-transitgatewayconnectpeer-connectpeerconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "TransitGatewayConnectPeerConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the Connect peer.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgatewayconnectpeer-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html#cfn-ec2-transitgatewayconnectpeer-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "TransitGatewayAttachmentId": { "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the Connect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html#cfn-ec2-transitgatewayconnectpeer-transitgatewayattachmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the Connect peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html#State-fn::getatt" }, "TransitGatewayConnectPeerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayConnectPeerId`\n\nThe ID of the Connect peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html#TransitGatewayConnectPeerId-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe creation time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html#CreationTime-fn::getatt" }, "ConnectPeerConfiguration.Protocol": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectPeerConfiguration.Protocol`\n\nThe tunnel protocol.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html#ConnectPeerConfiguration.Protocol-fn::getatt" }, "ConnectPeerConfiguration.BgpConfigurations": { "Type": "List", "ItemType": "TransitGatewayAttachmentBgpConfiguration", "MarkdownDocumentation": "`ConnectPeerConfiguration.BgpConfigurations`\n\nThe BGP configuration details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnectpeer.html#ConnectPeerConfiguration.BgpConfigurations-fn::getatt" } } }, "AWS::EC2::TransitGatewayMeteringPolicy": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayMeteringPolicy`\n\nDescribes a transit gateway metering policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicy.html", "Properties": { "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit gateway associated with the metering policy.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicy.html#cfn-ec2-transitgatewaymeteringpolicy-transitgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MiddleboxAttachmentIds": { "MarkdownDocumentation": "`MiddleboxAttachmentIds`\n\nThe IDs of the middlebox attachments associated with the metering policy.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicy.html#cfn-ec2-transitgatewaymeteringpolicy-middleboxattachmentids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the transit gateway metering policy.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgatewaymeteringpolicy-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicy.html#cfn-ec2-transitgatewaymeteringpolicy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the transit gateway metering policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicy.html#State-fn::getatt" }, "UpdateEffectiveAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateEffectiveAt`\n\nThe date and time when the metering policy update becomes effective.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicy.html#UpdateEffectiveAt-fn::getatt" }, "TransitGatewayMeteringPolicyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayMeteringPolicyId`\n\nThe ID of the transit gateway metering policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicy.html#TransitGatewayMeteringPolicyId-fn::getatt" } } }, "AWS::EC2::TransitGatewayMeteringPolicyEntry": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayMeteringPolicyEntry`\n\nCreates an entry in a transit gateway metering policy to define traffic measurement rules.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html", "Properties": { "DestinationPortRange": { "MarkdownDocumentation": "`DestinationPortRange`\n\nDescribes a range of ports.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-destinationportrange", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DestinationTransitGatewayAttachmentId": { "MarkdownDocumentation": "`DestinationTransitGatewayAttachmentId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-destinationtransitgatewayattachmentid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MeteredAccount": { "MarkdownDocumentation": "`MeteredAccount`\n\nThe AWS account ID to which the metered traffic is attributed.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `source-attachment-owner | d...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "source-attachment-owner", "destination-attachment-owner", "transit-gateway-owner" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-meteredaccount", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourcePortRange": { "MarkdownDocumentation": "`SourcePortRange`\n\nDescribes a range of ports.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-sourceportrange", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PolicyRuleNumber": { "MarkdownDocumentation": "`PolicyRuleNumber`\n\nThe rule number of the metering policy entry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-policyrulenumber", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "DestinationTransitGatewayAttachmentType": { "MarkdownDocumentation": "`DestinationTransitGatewayAttachmentType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `vpc | vpn | direct-connect-...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "vpc", "vpn", "direct-connect-gateway", "peering", "network-function", "vpn-concentrator" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-destinationtransitgatewayattachmenttype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceCidrBlock": { "MarkdownDocumentation": "`SourceCidrBlock`\n\nDescribes an IPv4 CIDR block.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-sourcecidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DestinationCidrBlock": { "MarkdownDocumentation": "`DestinationCidrBlock`\n\nDescribes an IPv4 CIDR block.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-destinationcidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TransitGatewayMeteringPolicyId": { "MarkdownDocumentation": "`TransitGatewayMeteringPolicyId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-transitgatewaymeteringpolicyid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceTransitGatewayAttachmentId": { "MarkdownDocumentation": "`SourceTransitGatewayAttachmentId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-sourcetransitgatewayattachmentid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceTransitGatewayAttachmentType": { "MarkdownDocumentation": "`SourceTransitGatewayAttachmentType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `vpc | vpn | direct-connect-...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "vpc", "vpn", "direct-connect-gateway", "peering", "network-function", "vpn-concentrator" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#cfn-ec2-transitgatewaymeteringpolicyentry-sourcetransitgatewayattachmenttype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "UpdateEffectiveAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateEffectiveAt`\n\nThe date and time when the metering policy entry update becomes effective.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#UpdateEffectiveAt-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the metering policy entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymeteringpolicyentry.html#State-fn::getatt" } } }, "AWS::EC2::TransitGatewayMulticastDomain": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayMulticastDomain`\n\nCreates a multicast domain using the specified transit gateway.\nThe transit gateway must be in the available state before you create a domain.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the transit gateway multicast domain ID. For example:\n`tgw-mcast-domain-000fb24d04EXAMPLE`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nThe options for the transit gateway multicast domain.\n* AutoAcceptSharedAssociations (enable | disable)\n* Igmpv2Support (enable | disable)\n* StaticSourcesSupport (enable | disable)\n*Required*: No\n*Type*: [Options](./aws-properties-ec2-transitgatewaymulticastdomain-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-options", "UpdateType": "Mutable", "Required": false, "Type": "Options" }, "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-transitgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the transit gateway multicast domain.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgatewaymulticastdomain-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "TransitGatewayMulticastDomainArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayMulticastDomainArn`\n\nThe Amazon Resource Name (ARN) of the multicast domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#TransitGatewayMulticastDomainArn-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the multicast domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#State-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time the multicast domain was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#CreationTime-fn::getatt" }, "TransitGatewayMulticastDomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayMulticastDomainId`\n\nThe ID of the multicast domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#TransitGatewayMulticastDomainId-fn::getatt" } } }, "AWS::EC2::TransitGatewayMulticastDomainAssociation": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayMulticastDomainAssociation`\n\nAssociates the specified subnets and transit gateway attachments with the specified\ntransit gateway multicast domain.\nThe transit gateway attachment must be in the available state before you can add a\nresource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the transit gateway multicast domain ID. For example:\n`tgw-mcast-domain-000fb24d04EXAMPLE`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html", "Properties": { "TransitGatewayMulticastDomainId": { "MarkdownDocumentation": "`TransitGatewayMulticastDomainId`\n\nThe ID of the transit gateway multicast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-transitgatewaymulticastdomainid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe IDs of the subnets to associate with the transit gateway multicast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TransitGatewayAttachmentId": { "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the transit gateway 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-transitgatewayattachmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#ResourceId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#State-fn::getatt" }, "ResourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource, for example a VPC attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#ResourceType-fn::getatt" } } }, "AWS::EC2::TransitGatewayMulticastGroupMember": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayMulticastGroupMember`\n\nRegisters members (network interfaces) with the transit gateway multicast group. A\nmember is a network interface associated with a supported EC2 instance that receives\nmulticast traffic. For information about supported instances, see [Multicast Consideration](https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) in *Amazon VPC Transit\nGateways*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the transit gateway multicast domain group member ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html", "Properties": { "TransitGatewayMulticastDomainId": { "MarkdownDocumentation": "`TransitGatewayMulticastDomainId`\n\nThe ID of the transit gateway multicast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-transitgatewaymulticastdomainid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe group members' network interface IDs to register with the transit gateway multicast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-networkinterfaceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GroupIpAddress": { "MarkdownDocumentation": "`GroupIpAddress`\n\nThe IP address assigned to the transit gateway multicast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-groupipaddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GroupMember": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`GroupMember`\n\nInformation about the registered transit gateway multicast domain group members.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#GroupMember-fn::getatt" }, "ResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#ResourceId-fn::getatt" }, "MemberType": { "PrimitiveType": "String", "MarkdownDocumentation": "`MemberType`\n\nThe type of group member, for example static.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#MemberType-fn::getatt" }, "ResourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource, for example a VPC attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#ResourceType-fn::getatt" }, "SubnetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#SubnetId-fn::getatt" }, "GroupSource": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`GroupSource`\n\nIndicates that the resource is a transit gateway multicast domain group member.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#GroupSource-fn::getatt" }, "TransitGatewayAttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the transit gateway attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#TransitGatewayAttachmentId-fn::getatt" } } }, "AWS::EC2::TransitGatewayMulticastGroupSource": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayMulticastGroupSource`\n\nRegisters sources (network interfaces) with the specified transit gateway multicast\ndomain.\nA multicast source is a network interface attached to a supported instance that sends\nmulticast traffic. For information about supported instances, see [Multicast Considerations](https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) in *Amazon VPC Transit\nGateways*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the transit gateway multicast domain group source.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html", "Properties": { "TransitGatewayMulticastDomainId": { "MarkdownDocumentation": "`TransitGatewayMulticastDomainId`\n\nThe ID of the transit gateway multicast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-transitgatewaymulticastdomainid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NetworkInterfaceId": { "MarkdownDocumentation": "`NetworkInterfaceId`\n\nThe group sources' network interface IDs to register with the transit gateway multicast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-networkinterfaceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GroupIpAddress": { "MarkdownDocumentation": "`GroupIpAddress`\n\nThe IP address assigned to the transit gateway multicast 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-groupipaddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GroupMember": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`GroupMember`\n\nInformation about the registered transit gateway multicast domain group members.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#GroupMember-fn::getatt" }, "ResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#ResourceId-fn::getatt" }, "SourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceType`\n\nThe type of source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#SourceType-fn::getatt" }, "ResourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource, for example a VPC attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#ResourceType-fn::getatt" }, "SubnetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#SubnetId-fn::getatt" }, "GroupSource": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`GroupSource`\n\nIndicates that the resource is a transit gateway group member.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#GroupSource-fn::getatt" }, "TransitGatewayAttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the transit gateway attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#TransitGatewayAttachmentId-fn::getatt" } } }, "AWS::EC2::TransitGatewayPeeringAttachment": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayPeeringAttachment`\n\nRequests a transit gateway peering attachment between the specified transit gateway\n(requester) and a peer transit gateway (accepter). The peer transit gateway can be in your\naccount or a different AWS account.\nAfter you create the peering attachment, the owner of the accepter transit gateway must\naccept the attachment request.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the transit gateway peering attachment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html", "Properties": { "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit gateway peering 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-transitgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PeerTransitGatewayId": { "MarkdownDocumentation": "`PeerTransitGatewayId`\n\nThe ID of the transit gateway in the PeerRegion.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peertransitgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PeerAccountId": { "MarkdownDocumentation": "`PeerAccountId`\n\nThe ID of the AWS account that owns the transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peeraccountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PeerRegion": { "MarkdownDocumentation": "`PeerRegion`\n\nThe Region where the transit gateway that you want to create the peer for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peerregion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the transit gateway peering attachment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgatewaypeeringattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "Type": "PeeringAttachmentStatus", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#Status-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the transit gateway peering attachment. Note that the\n`initiating` state has been deprecated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#State-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time the transit gateway peering attachment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#CreationTime-fn::getatt" }, "Status.Message": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#Status.Message-fn::getatt" }, "Status.Code": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#Status.Code-fn::getatt" }, "TransitGatewayAttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the transit gateway peering attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#TransitGatewayAttachmentId-fn::getatt" } } }, "AWS::EC2::TransitGatewayRoute": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayRoute`\n\nSpecifies a static route for a transit gateway route table.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the transit gateway route.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html", "Properties": { "TransitGatewayRouteTableId": { "MarkdownDocumentation": "`TransitGatewayRouteTableId`\n\nThe ID of the transit gateway route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayroutetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DestinationCidrBlock": { "MarkdownDocumentation": "`DestinationCidrBlock`\n\nThe CIDR block used for destination matches.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-destinationcidrblock", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Blackhole": { "MarkdownDocumentation": "`Blackhole`\n\nIndicates whether to drop traffic that matches this route.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-blackhole", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "TransitGatewayAttachmentId": { "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the attachment.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayattachmentid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EC2::TransitGatewayRouteTable": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayRouteTable`\n\nSpecifies a route table for a transit gateway.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the transit gateway route table.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html", "Properties": { "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-transitgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the route table.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgatewayroutetable-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "TransitGatewayRouteTableId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayRouteTableId`\n\nThe ID of the transit gateway route table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#TransitGatewayRouteTableId-fn::getatt" } } }, "AWS::EC2::TransitGatewayRouteTableAssociation": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayRouteTableAssociation`\n\nAssociates the specified attachment with the specified transit gateway route table. You\ncan associate one route table with an attachment.\nBefore you can update the route table associated with an attachment, you must\ndisassociate the transit gateway route table that is currently associated with the\nattachment. First update the stack to remove the associated transit gateway route table,\nand then update the stack with the ID of the new transit gateway route table to\nassociate. In addition, the attachment must be in an `available` state; otherwise, the request will return an error.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the transit gateway route table\nassociation.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html", "Properties": { "TransitGatewayRouteTableId": { "MarkdownDocumentation": "`TransitGatewayRouteTableId`\n\nThe ID of the route table for the transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayroutetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TransitGatewayAttachmentId": { "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayattachmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::TransitGatewayRouteTablePropagation": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayRouteTablePropagation`\n\nEnables the specified attachment to propagate routes to the specified propagation route\ntable.\nFor more information about enabling transit gateway route propagation, see [EnableTransitGatewayRouteTablePropagation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableTransitGatewayRouteTablePropagation.html) in the *Amazon EC2 API\nReference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the transit gateway route table that is\npropagated.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html", "Properties": { "TransitGatewayRouteTableId": { "MarkdownDocumentation": "`TransitGatewayRouteTableId`\n\nThe ID of the propagation route 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayroutetableid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TransitGatewayAttachmentId": { "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayattachmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::TransitGatewayVpcAttachment": { "MarkdownDocumentation": "`AWS::EC2::TransitGatewayVpcAttachment`\n\nSpecifies a VPC attachment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the attachment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html", "Properties": { "Options": { "MarkdownDocumentation": "`Options`\n\nThe VPC attachment options.\n*Required*: No\n*Type*: [Options](./aws-properties-ec2-transitgatewayvpcattachment-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-options", "UpdateType": "Mutable", "Required": false, "Type": "Options" }, "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-transitgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RemoveSubnetIds": { "MarkdownDocumentation": "`RemoveSubnetIds`\n\nThe IDs of one or more subnets to remove.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-removesubnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of the subnets.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-subnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AddSubnetIds": { "MarkdownDocumentation": "`AddSubnetIds`\n\nThe IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-addsubnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the VPC attachment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-transitgatewayvpcattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#Id-fn::getatt" } } }, "AWS::EC2::VPC": { "MarkdownDocumentation": "`AWS::EC2::VPC`\n\nSpecifies a virtual private cloud (VPC).\nA VPC must have an associated IPv4 CIDR block. You can specify an IPv4 CIDR block\nor an IPAM-allocated IPv4 CIDR block. To associate an IPv6 CIDR block with the VPC,\nsee [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html).\nFor more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html)\nin the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPC.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html", "Properties": { "InstanceTenancy": { "MarkdownDocumentation": "`InstanceTenancy`\n\nThe allowed tenancy of instances launched into the VPC.\n* `default`: An instance launched into the VPC runs on shared hardware\n by default, unless you explicitly specify a different tenancy during instance\n launch.\n* `dedicated`: An instance launched into the VPC runs on dedicated\n hardware by default, unless you explicitly specify a tenancy of `host`\n during instance launch. You cannot specify a tenancy of `default` during\n instance launch.\nUpdating `InstanceTenancy` requires no replacement only if you are updating\nits value from `dedicated` to `default`. Updating\n`InstanceTenancy` from `default` to `dedicated`\nrequires replacement.\n*Required*: No\n*Type*: String\n*Allowed values*: `default | dedicated | host...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "default", "dedicated", "host" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-instancetenancy", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Ipv4NetmaskLength": { "MarkdownDocumentation": "`Ipv4NetmaskLength`\n\nThe netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4netmasklength", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "CidrBlock": { "MarkdownDocumentation": "`CidrBlock`\n\nThe IPv4 network range for the VPC, in CIDR notation. For example,\n`10.0.0.0/16`. We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18`, we modify it to `100.68.0.0/18`.\nYou must specify either`CidrBlock` or `Ipv4IpamPoolId`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-cidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Ipv4IpamPoolId": { "MarkdownDocumentation": "`Ipv4IpamPoolId`\n\nThe ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see\n[What is IPAM?](/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\nYou must specify either`CidrBlock` or `Ipv4IpamPoolId`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4ipampoolid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnableDnsSupport": { "MarkdownDocumentation": "`EnableDnsSupport`\n\nIndicates whether the DNS resolution is supported for the VPC. If enabled, queries to\nthe Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP\naddress at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon\nprovided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not\nenabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednssupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableDnsHostnames": { "MarkdownDocumentation": "`EnableDnsHostnames`\n\nIndicates whether the instances launched in the VPC get DNS hostnames. If enabled,\ninstances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for\nnondefault VPCs. For more information, see [DNS attributes in your\nVPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).\nYou can only enable DNS hostnames if you've enabled DNS support.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednshostnames", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the VPC.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpc-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#VpcId-fn::getatt" }, "CidrBlockAssociations": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`CidrBlockAssociations`\n\nThe association IDs of the IPv4 CIDR blocks for the VPC. For example,\n[ vpc-cidr-assoc-0280ab6b ].\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#CidrBlockAssociations-fn::getatt" }, "CidrBlock": { "PrimitiveType": "String", "MarkdownDocumentation": "`CidrBlock`\n\nThe primary IPv4 CIDR block for the VPC. For example, 10.0.0.0/16.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#CidrBlock-fn::getatt" }, "DefaultNetworkAcl": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefaultNetworkAcl`\n\nThe ID of the default network ACL for the VPC. For example, acl-814dafe3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#DefaultNetworkAcl-fn::getatt" }, "Ipv6CidrBlocks": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Ipv6CidrBlocks`\n\nThe IPv6 CIDR blocks for the VPC. For example, [ 2001:db8:1234:1a00::/56 ].\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#Ipv6CidrBlocks-fn::getatt" }, "DefaultSecurityGroup": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefaultSecurityGroup`\n\nThe ID of the default security group for the VPC. For example, sg-b178e0d3.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#DefaultSecurityGroup-fn::getatt" } } }, "AWS::EC2::VPCBlockPublicAccessExclusion": { "MarkdownDocumentation": "`AWS::EC2::VPCBlockPublicAccessExclusion`\n\nCreate a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account\u2019s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see [Block public access to VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the exclusion.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessexclusion.html", "Properties": { "InternetGatewayExclusionMode": { "MarkdownDocumentation": "`InternetGatewayExclusionMode`\n\nThe desired VPC Block Public Access mode for a specific VPC or subnet exclusion.\n* `allow-bidirectional`: Allow all internet traffic to and from the excluded VPCs and subnets.\n* `allow-egress`: Allow outbound internet traffic from the excluded VPCs and subnets. Block inbound internet traffic to the excluded VPCs and subnets. Only applies when VPC Block Public Access is set to `block-bidirectional`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `allow-bidirectional | allow...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "allow-bidirectional", "allow-egress" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessexclusion.html#cfn-ec2-vpcblockpublicaccessexclusion-internetgatewayexclusionmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC you want to exclude. Required only if you don't specify SubnetId.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessexclusion.html#cfn-ec2-vpcblockpublicaccessexclusion-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet you want to exclude. Required only if you don't specify VpcId.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessexclusion.html#cfn-ec2-vpcblockpublicaccessexclusion-subnetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpcblockpublicaccessexclusion-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessexclusion.html#cfn-ec2-vpcblockpublicaccessexclusion-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ExclusionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ExclusionId`\n\nThe ID of the exclusion.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessexclusion.html#ExclusionId-fn::getatt" } } }, "AWS::EC2::VPCBlockPublicAccessOptions": { "MarkdownDocumentation": "`AWS::EC2::VPCBlockPublicAccessOptions`\n\nVPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see [Block public access to VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns your account ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessoptions.html", "Properties": { "InternetGatewayBlockMode": { "MarkdownDocumentation": "`InternetGatewayBlockMode`\n\nThe desired VPC Block Public Access mode for internet gateways in your account. We do not allow you to create this resource type in an \"off\" mode since off is the default value.\n* `block-bidirectional`: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).\n* `block-ingress`: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `block-bidirectional | block...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "block-bidirectional", "block-ingress" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessoptions.html#cfn-ec2-vpcblockpublicaccessoptions-internetgatewayblockmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe ID of the AWS account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessoptions.html#AccountId-fn::getatt" }, "ExclusionsAllowed": { "PrimitiveType": "String", "MarkdownDocumentation": "`ExclusionsAllowed`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcblockpublicaccessoptions.html#ExclusionsAllowed-fn::getatt" } } }, "AWS::EC2::VPCCidrBlock": { "MarkdownDocumentation": "`AWS::EC2::VPCCidrBlock`\n\nAssociates a CIDR block with your VPC.\nA VPC must have an associated IPv4 CIDR block. You can optionally associate additional IPv4 CIDR blocks with a VPC.\nYou can optionally associate an IPv6 CIDR block with a VPC. You can request an Amazon-provided\nIPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address\npool that you provisioned through bring your own IP addresses (BYOIP).\nFor more information, see [VPC CIDR blocks](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-cidr-blocks.html)\nin the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the association ID for the VPC CIDR block.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html", "Properties": { "Ipv6NetmaskLength": { "MarkdownDocumentation": "`Ipv6NetmaskLength`\n\nThe netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6netmasklength", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv6IpamPoolId": { "MarkdownDocumentation": "`Ipv6IpamPoolId`\n\nAssociates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6ipampoolid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Ipv4NetmaskLength": { "MarkdownDocumentation": "`Ipv4NetmaskLength`\n\nThe netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv4netmasklength", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Ipv6CidrBlockNetworkBorderGroup": { "MarkdownDocumentation": "`Ipv6CidrBlockNetworkBorderGroup`\n\nThe name of the location from which we advertise the IPV6 CIDR block. Use this parameter\nto limit the CIDR block to this location.\nYou must set `AmazonProvidedIpv6CidrBlock` to `true` to use this parameter.\nYou can have one IPv6 CIDR block association per network border 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6cidrblocknetworkbordergroup", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CidrBlock": { "MarkdownDocumentation": "`CidrBlock`\n\nAn IPv4 CIDR block to associate with the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-cidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Ipv6Pool": { "MarkdownDocumentation": "`Ipv6Pool`\n\nThe ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6pool", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Ipv4IpamPoolId": { "MarkdownDocumentation": "`Ipv4IpamPoolId`\n\nAssociate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv4ipampoolid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Ipv6CidrBlock": { "MarkdownDocumentation": "`Ipv6CidrBlock`\n\nAn IPv6 CIDR block from the IPv6 address pool. You must also specify `Ipv6Pool` in the request.\nTo let Amazon choose the IPv6 CIDR block for you, omit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6cidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AmazonProvidedIpv6CidrBlock": { "MarkdownDocumentation": "`AmazonProvidedIpv6CidrBlock`\n\nRequests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You\ncannot specify the range of IPv6 addresses or the size of the CIDR block.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-amazonprovidedipv6cidrblock", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "Ipv6AddressAttribute": { "PrimitiveType": "String", "MarkdownDocumentation": "`Ipv6AddressAttribute`\n\nPublic IPv6 addresses are those advertised on the internet from AWS. Private IP addresses are not and cannot be advertised on the internet from AWS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#Ipv6AddressAttribute-fn::getatt" }, "IpSource": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpSource`\n\nThe source that allocated the IP address space. `byoip` or `amazon` indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). `none` indicates private space.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#IpSource-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#Id-fn::getatt" } } }, "AWS::EC2::VPCDHCPOptionsAssociation": { "MarkdownDocumentation": "`AWS::EC2::VPCDHCPOptionsAssociation`\n\nAssociates a set of DHCP options with a VPC, or associates no DHCP options with the\nVPC.\nAfter you associate the options with the VPC, any existing instances and all new\ninstances that you launch in that VPC use the options. You don't need to restart or\nrelaunch the instances. They automatically pick up the changes within a few hours,\ndepending on how frequently the instance renews its DHCP lease. You can explicitly renew\nthe lease using the operating system on the instance.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the DHCP options association.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html#cfn-ec2-vpcdhcpoptionsassociation-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DhcpOptionsId": { "MarkdownDocumentation": "`DhcpOptionsId`\n\nThe ID of the DHCP options set, or `default` to associate\nno DHCP options with the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html#cfn-ec2-vpcdhcpoptionsassociation-dhcpoptionsid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::VPCEncryptionControl": { "MarkdownDocumentation": "`AWS::EC2::VPCEncryptionControl`\n\nDescribes the configuration and state of VPC encryption controls.\nFor more information, see [Enforce VPC encryption in transit](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-encryption-controls.html) in the *Amazon VPC User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the VPC Encryption Control ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html", "Properties": { "VpcPeeringExclusionInput": { "MarkdownDocumentation": "`VpcPeeringExclusionInput`\n\nSpecifies whether to exclude VPC peering connection traffic from encryption enforcement.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-vpcpeeringexclusioninput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ElasticFileSystemExclusionInput": { "MarkdownDocumentation": "`ElasticFileSystemExclusionInput`\n\nSpecifies whether to exclude Elastic File System traffic from encryption enforcement.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-elasticfilesystemexclusioninput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcLatticeExclusionInput": { "MarkdownDocumentation": "`VpcLatticeExclusionInput`\n\nSpecifies whether to exclude VPC Lattice traffic from encryption enforcement.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-vpclatticeexclusioninput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC for which to create the encryption control 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NatGatewayExclusionInput": { "MarkdownDocumentation": "`NatGatewayExclusionInput`\n\nSpecifies whether to exclude NAT gateway traffic from encryption enforcement.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-natgatewayexclusioninput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EgressOnlyInternetGatewayExclusionInput": { "MarkdownDocumentation": "`EgressOnlyInternetGatewayExclusionInput`\n\nSpecifies whether to exclude egress-only internet gateway traffic from encryption enforcement.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-egressonlyinternetgatewayexclusioninput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VirtualPrivateGatewayExclusionInput": { "MarkdownDocumentation": "`VirtualPrivateGatewayExclusionInput`\n\nSpecifies whether to exclude virtual private gateway traffic from encryption enforcement.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-virtualprivategatewayexclusioninput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nThe encryption mode for the VPC Encryption Control configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `monitor | enforce...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "monitor", "enforce" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InternetGatewayExclusionInput": { "MarkdownDocumentation": "`InternetGatewayExclusionInput`\n\nSpecifies whether to exclude internet gateway traffic from encryption enforcement.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-internetgatewayexclusioninput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LambdaExclusionInput": { "MarkdownDocumentation": "`LambdaExclusionInput`\n\nSpecifies whether to exclude Lambda function traffic from encryption enforcement.\n*Required*: No\n*Type*: String\n*Allowed values*: `enable | disable...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enable", "disable" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-lambdaexclusioninput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the VPC Encryption Control configuration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpcencryptioncontrol-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#cfn-ec2-vpcencryptioncontrol-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ResourceExclusions.ElasticFileSystem.State": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.ElasticFileSystem.State`\n\nThe current state of the exclusion configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.ElasticFileSystem.State-fn::getatt" }, "ResourceExclusions.VpcLattice.State": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.VpcLattice.State`\n\nThe current state of the exclusion configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VpcLattice.State-fn::getatt" }, "ResourceExclusions.VirtualPrivateGateway.StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.VirtualPrivateGateway.StateMessage`\n\nA message providing additional information about the exclusion state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VirtualPrivateGateway.StateMessage-fn::getatt" }, "VpcEncryptionControlId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEncryptionControlId`\n\nThe ID of the VPC Encryption Control configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#VpcEncryptionControlId-fn::getatt" }, "ResourceExclusions.VpcLattice": { "Type": "VpcEncryptionControlExclusion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VpcLattice-fn::getatt" }, "ResourceExclusions.Lambda": { "Type": "VpcEncryptionControlExclusion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.Lambda-fn::getatt" }, "ResourceExclusions.NatGateway.State": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.NatGateway.State`\n\nThe current state of the exclusion configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.NatGateway.State-fn::getatt" }, "ResourceExclusions.InternetGateway": { "Type": "VpcEncryptionControlExclusion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.InternetGateway-fn::getatt" }, "ResourceExclusions.VirtualPrivateGateway": { "Type": "VpcEncryptionControlExclusion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VirtualPrivateGateway-fn::getatt" }, "StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StateMessage`\n\nA message providing additional information about the encryption control state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#StateMessage-fn::getatt" }, "ResourceExclusions.EgressOnlyInternetGateway.StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.EgressOnlyInternetGateway.StateMessage`\n\nA message providing additional information about the exclusion state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.EgressOnlyInternetGateway.StateMessage-fn::getatt" }, "ResourceExclusions.NatGateway": { "Type": "VpcEncryptionControlExclusion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.NatGateway-fn::getatt" }, "ResourceExclusions.VpcPeering": { "Type": "VpcEncryptionControlExclusion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VpcPeering-fn::getatt" }, "ResourceExclusions.EgressOnlyInternetGateway": { "Type": "VpcEncryptionControlExclusion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.EgressOnlyInternetGateway-fn::getatt" }, "ResourceExclusions.InternetGateway.State": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.InternetGateway.State`\n\nThe current state of the exclusion configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.InternetGateway.State-fn::getatt" }, "ResourceExclusions.ElasticFileSystem.StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.ElasticFileSystem.StateMessage`\n\nA message providing additional information about the exclusion state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.ElasticFileSystem.StateMessage-fn::getatt" }, "ResourceExclusions.ElasticFileSystem": { "Type": "VpcEncryptionControlExclusion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.ElasticFileSystem-fn::getatt" }, "ResourceExclusions.EgressOnlyInternetGateway.State": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.EgressOnlyInternetGateway.State`\n\nThe current state of the exclusion configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.EgressOnlyInternetGateway.State-fn::getatt" }, "ResourceExclusions.NatGateway.StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.NatGateway.StateMessage`\n\nA message providing additional information about the exclusion state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.NatGateway.StateMessage-fn::getatt" }, "ResourceExclusions.Lambda.State": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.Lambda.State`\n\nThe current state of the exclusion configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.Lambda.State-fn::getatt" }, "ResourceExclusions.InternetGateway.StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.InternetGateway.StateMessage`\n\nA message providing additional information about the exclusion state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.InternetGateway.StateMessage-fn::getatt" }, "ResourceExclusions.Lambda.StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.Lambda.StateMessage`\n\nA message providing additional information about the exclusion state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.Lambda.StateMessage-fn::getatt" }, "ResourceExclusions.VpcPeering.State": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.VpcPeering.State`\n\nThe current state of the exclusion configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VpcPeering.State-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the VPC Encryption Control configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#State-fn::getatt" }, "ResourceExclusions.VpcPeering.StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.VpcPeering.StateMessage`\n\nA message providing additional information about the exclusion state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VpcPeering.StateMessage-fn::getatt" }, "ResourceExclusions.VpcLattice.StateMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.VpcLattice.StateMessage`\n\nA message providing additional information about the exclusion state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VpcLattice.StateMessage-fn::getatt" }, "ResourceExclusions": { "Type": "ResourceExclusions", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions-fn::getatt" }, "ResourceExclusions.VirtualPrivateGateway.State": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceExclusions.VirtualPrivateGateway.State`\n\nThe current state of the exclusion configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html#ResourceExclusions.VirtualPrivateGateway.State-fn::getatt" } } }, "AWS::EC2::VPCEndpoint": { "MarkdownDocumentation": "`AWS::EC2::VPCEndpoint`\n\nSpecifies a VPC endpoint. A VPC endpoint provides a private connection between\nyour VPC and an endpoint service. You can use an endpoint service provided by\nAWS, an AWS Marketplace Partner, or another AWS\naccounts in your organization. For more information, see the [AWS PrivateLink User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).\nAn endpoint of type `Interface` establishes connections between\nthe subnets in your VPC and an AWS service, your own service,\nor a service hosted by another AWS account. With an interface\nVPC endpoint, you specify the subnets in which to create the endpoint and the\nsecurity groups to associate with the endpoint network interfaces.\nAn endpoint of type `gateway` serves as a target for a route in your\nroute table for traffic destined for Amazon S3 or DynamoDB.\nYou can specify an endpoint policy for the endpoint, which controls access to the\nservice from your VPC. You can also specify the VPC route tables that use the endpoint.\nFor more information about connectivity to Amazon S3, see [Why can't I connect\nto an S3 bucket using a gateway VPC endpoint?](https://aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint)\nAn endpoint of type `GatewayLoadBalancer` provides private connectivity\nbetween your VPC and virtual appliances from a service provider.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPC endpoint.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html", "Properties": { "PrivateDnsEnabled": { "MarkdownDocumentation": "`PrivateDnsEnabled`\n\nIndicate whether to associate a private hosted zone with the specified VPC. The private hosted zone\ncontains a record set for the default public DNS name for the service for the Region (for example,\n`kinesis.us-east-1.amazonaws.com`), which resolves to the private IP addresses\nof the endpoint network interfaces in the VPC. This enables you to make requests to the\ndefault public DNS name for the service instead of the public DNS names that are\nautomatically generated by the VPC endpoint service.\nTo use a private hosted zone, you must set the following VPC attributes to\n`true`: `enableDnsHostnames` and\n`enableDnsSupport`.\nThis property is supported only for interface endpoints.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe supported IP address types.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dualstack | n...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dualstack", "not-specified" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceRegion": { "MarkdownDocumentation": "`ServiceRegion`\n\nDescribes a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-serviceregion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DnsOptions": { "MarkdownDocumentation": "`DnsOptions`\n\nDescribes the DNS options for an endpoint.\n*Required*: No\n*Type*: [DnsOptionsSpecification](./aws-properties-ec2-vpcendpoint-dnsoptionsspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-dnsoptions", "UpdateType": "Mutable", "Required": false, "Type": "DnsOptionsSpecification" }, "ResourceConfigurationArn": { "MarkdownDocumentation": "`ResourceConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the resource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-resourceconfigurationarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the security groups to associate with the endpoint network interfaces.\nIf this parameter is not specified, we use the default security group for the VPC.\nSecurity groups are supported only for interface endpoints.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of the subnets in which to create endpoint network interfaces.\nYou must specify this property for an interface endpoint or a Gateway Load Balancer endpoint.\nYou can't specify this property for a gateway endpoint.\nFor a Gateway Load Balancer endpoint, you can specify only one subnet.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ServiceNetworkArn": { "MarkdownDocumentation": "`ServiceNetworkArn`\n\nThe Amazon Resource Name (ARN) of the service 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicenetworkarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RouteTableIds": { "MarkdownDocumentation": "`RouteTableIds`\n\nThe IDs of the route tables. Routing is supported only for gateway endpoints.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe name of the endpoint service.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nAn endpoint policy, which controls access to the service from the VPC.\nThe default endpoint policy allows full access to the service.\nEndpoint policies are supported only for gateway and interface endpoints.\nFor CloudFormation templates in YAML, you can provide the policy in JSON or YAML format.\nFor example, if you have a JSON policy, you can convert it to YAML before including it\nin the YAML template, and AWS CloudFormation converts the policy to JSON format\nbefore calling the API actions for AWS PrivateLink. Alternatively, you can\ninclude the JSON directly in the YAML, as shown in the following `Properties`\nsection:\n```\nProperties:\n VpcEndpointType: 'Interface'\n ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs'\n PolicyDocument: '{\n \"Version\":\"2012-10-17\",\t\t \t \t \n \"Statement\": [{\n \"Effect\":\"Allow\",\n \"Principal\":\"*\",\n \"Action\":[\"logs:Describe*\",\"logs:Get*\",\"logs:List*\",\"logs:FilterLogEvents\"],\n \"Resource\":\"*\"\n }]\n }'\n```\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "VpcEndpointType": { "MarkdownDocumentation": "`VpcEndpointType`\n\nThe type of endpoint.\nDefault: Gateway\n*Required*: No\n*Type*: String\n*Allowed values*: `Interface | Gateway | Gatew...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Interface", "Gateway", "GatewayLoadBalancer", "ServiceNetwork", "Resource" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to associate with the endpoint.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpcendpoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "CreationTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTimestamp`\n\nThe date and time the VPC endpoint was created. For example: `Fri Sep 28 23:34:36\nUTC 2018.`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#CreationTimestamp-fn::getatt" }, "NetworkInterfaceIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`NetworkInterfaceIds`\n\n(Interface endpoints) The network interface IDs. If you update the\n`PrivateDnsEnabled` or `SubnetIds` properties, the items in this\nlist might change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#NetworkInterfaceIds-fn::getatt" }, "DnsEntries": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`DnsEntries`\n\n(Interface endpoints) The DNS entries for the endpoint. Each entry is a combination of\nthe hosted zone ID and the DNS name. The entries are ordered as follows: regional public\nDNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for\nAWS Marketplace services.\nThe following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and\nthe DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.\n[\"Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com\",\n\"Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com\",\n\"Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com\"]\nIf you update the `PrivateDnsEnabled` or `SubnetIds` properties,\nthe DNS entries in the list will change.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#DnsEntries-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the VPC endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#Id-fn::getatt" } } }, "AWS::EC2::VPCEndpointConnectionNotification": { "MarkdownDocumentation": "`AWS::EC2::VPCEndpointConnectionNotification`\n\nSpecifies a connection notification for a VPC endpoint or VPC endpoint service. A\nconnection notification notifies you of specific endpoint events. You must create an SNS\ntopic to receive notifications. For more information, see [Create a Topic](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) in the *Amazon\nSimple Notification Service Developer Guide*.\nYou can create a connection notification for interface endpoints only.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the notification.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html", "Properties": { "ConnectionEvents": { "MarkdownDocumentation": "`ConnectionEvents`\n\nThe endpoint events for which to receive notifications. Valid values are\n`Accept`, `Connect`, `Delete`, and\n`Reject`.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionevents", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VPCEndpointId": { "MarkdownDocumentation": "`VPCEndpointId`\n\nThe ID of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-vpcendpointid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConnectionNotificationArn": { "MarkdownDocumentation": "`ConnectionNotificationArn`\n\nThe ARN of the SNS topic for the notifications.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionnotificationarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ServiceId": { "MarkdownDocumentation": "`ServiceId`\n\nThe ID of the endpoint service.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-serviceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "VPCEndpointConnectionNotificationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VPCEndpointConnectionNotificationId`\n\nThe ID of the notification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#VPCEndpointConnectionNotificationId-fn::getatt" } } }, "AWS::EC2::VPCEndpointService": { "MarkdownDocumentation": "`AWS::EC2::VPCEndpointService`\n\nCreates a VPC endpoint service configuration to which service consumers (AWS accounts,\nusers, and IAM roles) can connect.\nTo create an endpoint service configuration, you must first create one of the following\nfor your service:\n* A [Network Load\n Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html). Service consumers connect to your service using an interface\n endpoint.\n* A [Gateway Load\n Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/introduction.html). Service consumers connect to your service using a Gateway Load\n Balancer endpoint.\nFor more information, see the [AWS PrivateLink User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPC endpoint service configuration.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html", "Properties": { "NetworkLoadBalancerArns": { "MarkdownDocumentation": "`NetworkLoadBalancerArns`\n\nThe Amazon Resource Names (ARNs) of the Network Load Balancers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-networkloadbalancerarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PayerResponsibility": { "MarkdownDocumentation": "`PayerResponsibility`\n\nThe entity that is responsible for the endpoint costs. The default is the endpoint owner.\nIf you set the payer responsibility to the service owner, you cannot set it back to the\nendpoint owner.\n*Required*: No\n*Type*: String\n*Allowed values*: `ServiceOwner...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ServiceOwner" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-payerresponsibility", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AcceptanceRequired": { "MarkdownDocumentation": "`AcceptanceRequired`\n\nIndicates whether requests from service consumers to create an endpoint to your service\nmust be accepted.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-acceptancerequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ContributorInsightsEnabled": { "MarkdownDocumentation": "`ContributorInsightsEnabled`\n\nIndicates whether to enable the built-in Contributor Insights rules provided by\nAWS PrivateLink.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-contributorinsightsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SupportedIpAddressTypes": { "MarkdownDocumentation": "`SupportedIpAddressTypes`\n\nThe supported IP address types. The possible values are `ipv4` and `ipv6`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-supportedipaddresstypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "GatewayLoadBalancerArns": { "MarkdownDocumentation": "`GatewayLoadBalancerArns`\n\nThe Amazon Resource Names (ARNs) of the Gateway Load Balancers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-gatewayloadbalancerarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SupportedRegions": { "MarkdownDocumentation": "`SupportedRegions`\n\nThe Regions from which service consumers can access the service.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-supportedregions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to associate with the service.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpcendpointservice-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ServiceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceId`\n\nThe ID of the endpoint service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#ServiceId-fn::getatt" } } }, "AWS::EC2::VPCEndpointServicePermissions": { "MarkdownDocumentation": "`AWS::EC2::VPCEndpointServicePermissions`\n\nGrant or revoke permissions for service consumers (users, IAM roles, and AWS accounts) to connect to a VPC endpoint service.\nIf you grant permissions to all principals, the service is public. Any users who know\nthe name of a public service can send a request to attach an endpoint. If the service does\nnot require manual approval, attachments are automatically approved.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPC endpoint service permissions.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html", "Properties": { "AllowedPrincipals": { "MarkdownDocumentation": "`AllowedPrincipals`\n\nThe Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and\nAWS accounts). Permissions are granted to the principals in this list.\nTo grant permissions to all principals, specify an asterisk (\\*). Permissions are revoked\nfor principals not in this list. If the list is empty, then all permissions are revoked.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-allowedprincipals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ServiceId": { "MarkdownDocumentation": "`ServiceId`\n\nThe ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-serviceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::VPCGatewayAttachment": { "MarkdownDocumentation": "`AWS::EC2::VPCGatewayAttachment`\n\nAttaches an internet gateway, or a virtual private gateway to a VPC, enabling\nconnectivity between the internet and the VPC.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPC gateway attachment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcgatewayattachment.html", "Properties": { "InternetGatewayId": { "MarkdownDocumentation": "`InternetGatewayId`\n\nThe ID of the internet gateway.\nYou must specify either `InternetGatewayId` or `VpnGatewayId`, but\nnot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcgatewayattachment.html#cfn-ec2-vpcgatewayattachment-internetgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcgatewayattachment.html#cfn-ec2-vpcgatewayattachment-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpnGatewayId": { "MarkdownDocumentation": "`VpnGatewayId`\n\nThe ID of the virtual private gateway.\nYou must specify either `InternetGatewayId` or `VpnGatewayId`, but\nnot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcgatewayattachment.html#cfn-ec2-vpcgatewayattachment-vpngatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "AttachmentType": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcgatewayattachment.html#AttachmentType-fn::getatt" } } }, "AWS::EC2::VPCPeeringConnection": { "MarkdownDocumentation": "`AWS::EC2::VPCPeeringConnection`\n\nRequests a VPC peering connection between two VPCs: a requester VPC that you own and an\naccepter VPC with which to create the connection. The accepter VPC can belong to a different\nAWS account and can be in a different Region than the requester VPC.\nThe requester VPC and accepter VPC cannot have overlapping CIDR blocks. If you create a\nVPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering\nconnection has a status of `failed`.\nIf the VPCs belong to different accounts, the acceptor account must have a role that\nallows the requester account to accept the VPC peering connection. For an example,\nsee [Walkthrough: Peer with a VPC in another AWS account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/peer-with-vpc-in-another-account.html).\nIf the requester and acceptor VPCs are in the same account, the peering request is\naccepted without a peering role.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPC peering connection.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html", "Properties": { "PeerRoleArn": { "MarkdownDocumentation": "`PeerRoleArn`\n\nThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in\nanother AWS account.\nThis is required when you are peering a VPC in a different AWS\naccount.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PeerVpcId": { "MarkdownDocumentation": "`PeerVpcId`\n\nThe ID of the VPC with which you are creating the VPC peering connection. You must\nspecify this parameter in the request.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peervpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PeerRegion": { "MarkdownDocumentation": "`PeerRegion`\n\nThe Region code for the accepter VPC, if the accepter VPC is located in a Region\nother than the Region in which you make the request.\nDefault: The Region in which you make the request.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerregion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PeerOwnerId": { "MarkdownDocumentation": "`PeerOwnerId`\n\nThe AWS account ID of the owner of the accepter VPC.\nDefault: Your AWS account 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerownerid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpcpeeringconnection-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the peering connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#Id-fn::getatt" } } }, "AWS::EC2::VPNConcentrator": { "MarkdownDocumentation": "`AWS::EC2::VPNConcentrator`\n\nDescribes a VPN concentrator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconcentrator.html", "Properties": { "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit gateway associated with the VPN concentrator.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconcentrator.html#cfn-ec2-vpnconcentrator-transitgatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of VPN concentrator.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ipsec.1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ipsec.1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconcentrator.html#cfn-ec2-vpnconcentrator-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the VPN concentrator.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpnconcentrator-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconcentrator.html#cfn-ec2-vpnconcentrator-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "VpnConcentratorId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpnConcentratorId`\n\nThe ID of the VPN concentrator to associate with the VPN connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconcentrator.html#VpnConcentratorId-fn::getatt" }, "TransitGatewayAttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe ID of the transit gateway attachment for the VPN concentrator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconcentrator.html#TransitGatewayAttachmentId-fn::getatt" } } }, "AWS::EC2::VPNConnection": { "MarkdownDocumentation": "`AWS::EC2::VPNConnection`\n\nSpecifies a VPN connection between a virtual private gateway and a VPN customer gateway\nor a transit gateway and a VPN customer gateway.\nTo specify a VPN connection between a transit gateway and customer gateway, use the\n`TransitGatewayId` and `CustomerGatewayId` properties.\nTo specify a VPN connection between a virtual private gateway and customer gateway, use\nthe `VpnGatewayId` and `CustomerGatewayId` properties.\nFor more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the\n*AWS Site-to-Site VPN User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPN connection.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html", "Properties": { "RemoteIpv6NetworkCidr": { "MarkdownDocumentation": "`RemoteIpv6NetworkCidr`\n\nThe IPv6 CIDR on the AWS side of the VPN connection.\nDefault: `::/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-remoteipv6networkcidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RemoteIpv4NetworkCidr": { "MarkdownDocumentation": "`RemoteIpv4NetworkCidr`\n\nThe IPv4 CIDR on the AWS side of the VPN connection.\nDefault: `0.0.0.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-remoteipv4networkcidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpnTunnelOptionsSpecifications": { "MarkdownDocumentation": "`VpnTunnelOptionsSpecifications`\n\nThe tunnel options for the VPN connection.\n*Required*: No\n*Type*: Array of [VpnTunnelOptionsSpecification](./aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "VpnTunnelOptionsSpecification", "DuplicatesAllowed": true }, "CustomerGatewayId": { "MarkdownDocumentation": "`CustomerGatewayId`\n\nThe ID of the customer gateway at your end of the VPN connection.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-customergatewayid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OutsideIpAddressType": { "MarkdownDocumentation": "`OutsideIpAddressType`\n\nThe type of IP address assigned to the outside interface of the customer gateway device.\nValid values: `PrivateIpv4` | `PublicIpv4` | `Ipv6`\nDefault: `PublicIpv4`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-outsideipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StaticRoutesOnly": { "MarkdownDocumentation": "`StaticRoutesOnly`\n\nIndicates whether the VPN connection uses static routes only. Static routes must be used\nfor devices that don't support BGP.\nIf you are creating a VPN connection for a device that does not support Border Gateway\nProtocol (BGP), you must specify `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-staticroutesonly", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableAcceleration": { "MarkdownDocumentation": "`EnableAcceleration`\n\nIndicate whether to enable acceleration for the VPN connection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-enableacceleration", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the transit gateway associated with the VPN connection.\nYou must specify either `TransitGatewayId` or `VpnGatewayId`, but\nnot both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transitgatewayid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of VPN connection.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ipsec.1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ipsec.1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TunnelBandwidth": { "MarkdownDocumentation": "`TunnelBandwidth`\n\nThe desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput\ncapacity. `standard` supports up to 1.25 Gbps per tunnel, while `large` supports up to 5 Gbps per tunnel. The default value is `standard`. Existing\nVPN connections without a bandwidth setting will automatically default to `standard`.\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | large...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "standard", "large" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tunnelbandwidth", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LocalIpv4NetworkCidr": { "MarkdownDocumentation": "`LocalIpv4NetworkCidr`\n\nThe IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.\nDefault: `0.0.0.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-localipv4networkcidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpnGatewayId": { "MarkdownDocumentation": "`VpnGatewayId`\n\nThe ID of the virtual private gateway at the AWS side of the VPN\nconnection.\nYou must specify either `TransitGatewayId` or `VpnGatewayId`, but\nnot both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpngatewayid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpnConcentratorId": { "MarkdownDocumentation": "`VpnConcentratorId`\n\nThe ID of the VPN concentrator to associate with the VPN 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpnconcentratorid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PreSharedKeyStorage": { "MarkdownDocumentation": "`PreSharedKeyStorage`\n\nDescribes the storage location for an instance store-backed AMI.\n*Required*: No\n*Type*: String\n*Allowed values*: `Standard | SecretsManager...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Standard", "SecretsManager" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-presharedkeystorage", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TransportTransitGatewayAttachmentId": { "MarkdownDocumentation": "`TransportTransitGatewayAttachmentId`\n\nThe transit gateway attachment ID to use for the VPN tunnel.\nRequired if `OutsideIpAddressType` is set to `PrivateIpv4`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transporttransitgatewayattachmentid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LocalIpv6NetworkCidr": { "MarkdownDocumentation": "`LocalIpv6NetworkCidr`\n\nThe IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.\nDefault: `::/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-localipv6networkcidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TunnelInsideIpVersion": { "MarkdownDocumentation": "`TunnelInsideIpVersion`\n\nIndicate whether the VPN tunnels process IPv4 or IPv6 traffic.\nDefault: `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)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tunnelinsideipversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the VPN connection.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpnconnection-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "VpnConnectionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpnConnectionId`\n\nThe ID of the VPN connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#VpnConnectionId-fn::getatt" } } }, "AWS::EC2::VPNConnectionRoute": { "MarkdownDocumentation": "`AWS::EC2::VPNConnectionRoute`\n\nSpecifies a static route for a VPN connection between an existing virtual private\ngateway and a VPN customer gateway. The static route allows traffic to be routed from the\nvirtual private gateway to the VPN customer gateway.\nFor more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the\n*AWS Site-to-Site VPN User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPN connection route.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html", "Properties": { "DestinationCidrBlock": { "MarkdownDocumentation": "`DestinationCidrBlock`\n\nThe CIDR block associated with the local subnet of the customer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html#cfn-ec2-vpnconnectionroute-destinationcidrblock", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpnConnectionId": { "MarkdownDocumentation": "`VpnConnectionId`\n\nThe ID of the VPN connection.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html#cfn-ec2-vpnconnectionroute-vpnconnectionid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EC2::VPNGateway": { "MarkdownDocumentation": "`AWS::EC2::VPNGateway`\n\nSpecifies a virtual private gateway. A virtual private gateway is the endpoint on the\nVPC side of your VPN connection. You can create a virtual private gateway before creating\nthe VPC itself.\nFor more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the\n*AWS Site-to-Site VPN User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPN gateway.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of VPN connection the virtual private gateway supports.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ipsec.1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ipsec.1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AmazonSideAsn": { "MarkdownDocumentation": "`AmazonSideAsn`\n\nThe private Autonomous System Number (ASN) for the Amazon side of a BGP\nsession.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-amazonsideasn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Long" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAny tags assigned to the virtual private gateway.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-vpngateway-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "VPNGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VPNGatewayId`\n\nThe ID of the VPN gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#VPNGatewayId-fn::getatt" } } }, "AWS::EC2::VPNGatewayRoutePropagation": { "MarkdownDocumentation": "`AWS::EC2::VPNGatewayRoutePropagation`\n\nEnables a virtual private gateway (VGW) to propagate routes to the specified route table\nof a VPC.\nIf you reference a VPN gateway that is in the same template as your VPN gateway route\npropagation, you must explicitly declare a dependency on the VPN gateway attachment. The\n`AWS::EC2::VPNGatewayRoutePropagation` resource cannot use the VPN gateway\nuntil it has successfully attached to the VPC. Add a [DependsOn\nAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the `AWS::EC2::VPNGatewayRoutePropagation` resource to\nexplicitly declare a dependency on the VPN gateway attachment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPN gateway.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html", "Properties": { "RouteTableIds": { "MarkdownDocumentation": "`RouteTableIds`\n\nThe ID of the route table. The routing table must be associated with the same VPC that\nthe virtual private gateway is attached to.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#cfn-ec2-vpngatewayroutepropagation-routetableids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VpnGatewayId": { "MarkdownDocumentation": "`VpnGatewayId`\n\nThe ID of the virtual private gateway that is attached to a VPC. The virtual private\ngateway must be attached to the same VPC that the routing tables are associated with.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#cfn-ec2-vpngatewayroutepropagation-vpngatewayid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the VPN gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#Id-fn::getatt" } } }, "AWS::EC2::VerifiedAccessEndpoint": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessEndpoint`\n\nAn AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to. It must be\nattached to an AWS Verified Access group. An AWS Verified Access endpoint must also have an attached access policy\nbefore you attached it to a group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Verified Access endpoint.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html", "Properties": { "AttachmentType": { "MarkdownDocumentation": "`AttachmentType`\n\nThe type of attachment used to provide connectivity between the AWS Verified Access endpoint and the\napplication.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `vpc`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "vpc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-attachmenttype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the AWS Verified Access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainCertificateArn": { "MarkdownDocumentation": "`DomainCertificateArn`\n\nThe ARN of a public TLS/SSL certificate imported into or created with ACM.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-domaincertificatearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VerifiedAccessGroupId": { "MarkdownDocumentation": "`VerifiedAccessGroupId`\n\nThe ID of the AWS Verified Access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-verifiedaccessgroupid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the security groups for the endpoint.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-securitygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "LoadBalancerOptions": { "MarkdownDocumentation": "`LoadBalancerOptions`\n\nThe load balancer details if creating the AWS Verified Access endpoint as\n`load-balancer`type.\n*Required*: No\n*Type*: [LoadBalancerOptions](./aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions", "UpdateType": "Mutable", "Required": false, "Type": "LoadBalancerOptions" }, "ApplicationDomain": { "MarkdownDocumentation": "`ApplicationDomain`\n\nThe DNS name for users to reach your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-applicationdomain", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PolicyEnabled": { "MarkdownDocumentation": "`PolicyEnabled`\n\nThe status of the Verified Access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-policyenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CidrOptions": { "MarkdownDocumentation": "`CidrOptions`\n\nThe options for a CIDR endpoint.\n*Required*: No\n*Type*: [CidrOptions](./aws-properties-ec2-verifiedaccessendpoint-cidroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-cidroptions", "UpdateType": "Mutable", "Required": false, "Type": "CidrOptions" }, "EndpointDomainPrefix": { "MarkdownDocumentation": "`EndpointDomainPrefix`\n\nA custom identifier that is prepended to the DNS name that is generated for the\nendpoint.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-endpointdomainprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EndpointType": { "MarkdownDocumentation": "`EndpointType`\n\nThe type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP\naddress, load balancer or a network interface depending on the endpoint type\nspecified.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `load-balancer | network-int...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "load-balancer", "network-interface", "rds", "cidr" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-endpointtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe Verified Access policy document.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RdsOptions": { "MarkdownDocumentation": "`RdsOptions`\n\nThe options for an RDS endpoint.\n*Required*: No\n*Type*: [RdsOptions](./aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-rdsoptions", "UpdateType": "Mutable", "Required": false, "Type": "RdsOptions" }, "SseSpecification": { "MarkdownDocumentation": "`SseSpecification`\n\nThe options for additional server side encryption.\n*Required*: No\n*Type*: [SseSpecification](./aws-properties-ec2-verifiedaccessendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-ssespecification", "UpdateType": "Mutable", "Required": false, "Type": "SseSpecification" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-verifiedaccessendpoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "NetworkInterfaceOptions": { "MarkdownDocumentation": "`NetworkInterfaceOptions`\n\nThe options for network-interface type endpoint.\n*Required*: No\n*Type*: [NetworkInterfaceOptions](./aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions", "UpdateType": "Mutable", "Required": false, "Type": "NetworkInterfaceOptions" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe endpoint status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#Status-fn::getatt" }, "EndpointDomain": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointDomain`\n\nThe DNS name generated for the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#EndpointDomain-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe creation time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#CreationTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe last updated time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#LastUpdatedTime-fn::getatt" }, "DeviceValidationDomain": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeviceValidationDomain`\n\nUse this to construct the redirect URI to add to your OIDC provider's allow list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#DeviceValidationDomain-fn::getatt" }, "VerifiedAccessInstanceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VerifiedAccessInstanceId`\n\nThe instance identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#VerifiedAccessInstanceId-fn::getatt" }, "VerifiedAccessEndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VerifiedAccessEndpointId`\n\nThe ID of the Verified Access endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#VerifiedAccessEndpointId-fn::getatt" } } }, "AWS::EC2::VerifiedAccessGroup": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessGroup`\n\nAn AWS Verified Access group is a collection of AWS Verified Access endpoints who's associated applications have\nsimilar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For\nexample, you can group all Verified Access instances associated with \"sales\" applications together and\nuse one common Verified Access policy.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Verified Access group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the AWS Verified Access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe Verified Access policy document.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SseSpecification": { "MarkdownDocumentation": "`SseSpecification`\n\nThe options for additional server side encryption.\n*Required*: No\n*Type*: [SseSpecification](./aws-properties-ec2-verifiedaccessgroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-ssespecification", "UpdateType": "Mutable", "Required": false, "Type": "SseSpecification" }, "VerifiedAccessInstanceId": { "MarkdownDocumentation": "`VerifiedAccessInstanceId`\n\nThe ID of the AWS Verified Access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-verifiedaccessinstanceid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-verifiedaccessgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "PolicyEnabled": { "MarkdownDocumentation": "`PolicyEnabled`\n\nThe status of the Verified Access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-policyenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "Owner": { "PrimitiveType": "String", "MarkdownDocumentation": "`Owner`\n\nThe ID of the AWS account that owns the group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#Owner-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe creation time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#CreationTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe last updated time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#LastUpdatedTime-fn::getatt" }, "VerifiedAccessGroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VerifiedAccessGroupId`\n\nThe ID of the Verified Access group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#VerifiedAccessGroupId-fn::getatt" }, "VerifiedAccessGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`VerifiedAccessGroupArn`\n\nThe ARN of the Verified Access group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#VerifiedAccessGroupArn-fn::getatt" } } }, "AWS::EC2::VerifiedAccessInstance": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessInstance`\n\nAn AWS Verified Access instance is a regional entity that evaluates application requests and grants\naccess only when your security requirements are met.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Verified Access instance.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html", "Properties": { "VerifiedAccessTrustProviders": { "MarkdownDocumentation": "`VerifiedAccessTrustProviders`\n\nThe IDs of the AWS Verified Access trust providers.\n*Required*: No\n*Type*: Array of [VerifiedAccessTrustProvider](./aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VerifiedAccessTrustProvider", "DuplicatesAllowed": false }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the AWS Verified Access 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FipsEnabled": { "MarkdownDocumentation": "`FipsEnabled`\n\nIndicates whether support for Federal Information Processing Standards (FIPS) is enabled on the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-fipsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LoggingConfigurations": { "MarkdownDocumentation": "`LoggingConfigurations`\n\nThe logging configuration for the Verified Access instances.\n*Required*: No\n*Type*: [VerifiedAccessLogs](./aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-loggingconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "VerifiedAccessLogs" }, "CidrEndpointsCustomSubDomain": { "MarkdownDocumentation": "`CidrEndpointsCustomSubDomain`\n\nThe custom subdomain.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-cidrendpointscustomsubdomain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VerifiedAccessTrustProviderIds": { "MarkdownDocumentation": "`VerifiedAccessTrustProviderIds`\n\nThe IDs of the AWS Verified Access trust providers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustproviderids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-verifiedaccessinstance-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CidrEndpointsCustomSubDomainNameServers": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`CidrEndpointsCustomSubDomainNameServers`\n\nThe name servers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#CidrEndpointsCustomSubDomainNameServers-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe creation time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#CreationTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe last updated time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#LastUpdatedTime-fn::getatt" }, "VerifiedAccessInstanceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VerifiedAccessInstanceId`\n\nThe ID of the Verified Access instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#VerifiedAccessInstanceId-fn::getatt" } } }, "AWS::EC2::VerifiedAccessTrustProvider": { "MarkdownDocumentation": "`AWS::EC2::VerifiedAccessTrustProvider`\n\nA trust provider is a third-party entity that creates, maintains, and manages identity\ninformation for users and devices. When an application request is made, the identity\ninformation sent by the trust provider is evaluated by Verified Access before allowing or\ndenying the application request.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Verified Access trust provider.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html", "Properties": { "PolicyReferenceName": { "MarkdownDocumentation": "`PolicyReferenceName`\n\nThe identifier to be used when working with policy rules.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-policyreferencename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeviceOptions": { "MarkdownDocumentation": "`DeviceOptions`\n\nThe options for device-identity trust provider.\n*Required*: No\n*Type*: [DeviceOptions](./aws-properties-ec2-verifiedaccesstrustprovider-deviceoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions", "UpdateType": "Immutable", "Required": false, "Type": "DeviceOptions" }, "NativeApplicationOidcOptions": { "MarkdownDocumentation": "`NativeApplicationOidcOptions`\n\nThe OpenID Connect (OIDC) options.\n*Required*: No\n*Type*: [NativeApplicationOidcOptions](./aws-properties-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-nativeapplicationoidcoptions", "UpdateType": "Mutable", "Required": false, "Type": "NativeApplicationOidcOptions" }, "DeviceTrustProviderType": { "MarkdownDocumentation": "`DeviceTrustProviderType`\n\nThe type of device-based trust provider.\n*Required*: No\n*Type*: String\n*Allowed values*: `jamf | crowdstrike | jumpcl...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "jamf", "crowdstrike", "jumpcloud" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-devicetrustprovidertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the AWS Verified Access trust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OidcOptions": { "MarkdownDocumentation": "`OidcOptions`\n\nThe options for an OpenID Connect-compatible user-identity trust provider.\n*Required*: No\n*Type*: [OidcOptions](./aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions", "UpdateType": "Mutable", "Required": false, "Type": "OidcOptions" }, "TrustProviderType": { "MarkdownDocumentation": "`TrustProviderType`\n\nThe type of Verified Access trust provider.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `user | device...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "user", "device" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-trustprovidertype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SseSpecification": { "MarkdownDocumentation": "`SseSpecification`\n\nThe options for additional server side encryption.\n*Required*: No\n*Type*: [SseSpecification](./aws-properties-ec2-verifiedaccesstrustprovider-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-ssespecification", "UpdateType": "Mutable", "Required": false, "Type": "SseSpecification" }, "UserTrustProviderType": { "MarkdownDocumentation": "`UserTrustProviderType`\n\nThe type of user-based trust provider.\n*Required*: No\n*Type*: String\n*Allowed values*: `iam-identity-center | oidc...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "iam-identity-center", "oidc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-usertrustprovidertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-verifiedaccesstrustprovider-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "VerifiedAccessTrustProviderId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VerifiedAccessTrustProviderId`\n\nThe ID of the Verified Access trust provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#VerifiedAccessTrustProviderId-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe creation time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#CreationTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe last updated time.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#LastUpdatedTime-fn::getatt" } } }, "AWS::EC2::Volume": { "MarkdownDocumentation": "`AWS::EC2::Volume`\n\nSpecifies an Amazon Elastic Block Store (Amazon EBS) volume. You can create an empty volume, a\nvolume from a snapshot, or a volume copy from an existing source volume.\n###### Important\n* When you use AWS CloudFormation to update an Amazon EBS volume that modifies\n `Iops`, `Size`, or `VolumeType`, there is a cooldown\n period before another operation can occur. This can cause your stack to report being in\n `UPDATE_IN_PROGRESS` or `UPDATE_ROLLBACK_IN_PROGRESS` for long\n periods of time. Some common scenarios when you might encounter a cooldown period for Amazon EBS\n include:\n \n + You successfully update an Amazon EBS volume and the update succeeds. When you\n attempt another update within the cooldown window, that update will be subject to a\n cooldown period.\n + You successfully update an Amazon EBS volume and the update succeeds but another\n change in your `update-stack` call fails. The rollback will be subject to\n a cooldown period.\n \n For more information, see [Requirements for EBS volume modifications](https://docs.aws.amazon.com/ebs/latest/userguide/modify-volume-requirements.html).\n* Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation\n does not attempt to modify an Amazon EBS volume to a smaller size on rollback.\n**DeletionPolicy attribute**\nTo control how AWS CloudFormation handles the volume when the stack is deleted,\nset a deletion policy for your volume. You can choose to retain the volume, to delete the\nvolume, or to create a snapshot of the volume. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n###### Note\nIf you set a deletion policy that creates a snapshot, all tags on the volume are\nincluded in the snapshot.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`vol-5cb85026`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html", "Properties": { "MultiAttachEnabled": { "MarkdownDocumentation": "`MultiAttachEnabled`\n\nIndicates whether Amazon EBS Multi-Attach is enabled.\nAWS CloudFormation does not currently support updating a single-attach volume to\nbe multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or\nupdating the size or number of I/O operations per second (IOPS) of a multi-attach enabled\nvolume.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe identifier of the AWS KMS key to use for Amazon EBS encryption. If `KmsKeyId`\nis specified, the encrypted state must be `true`.\nIf you omit this property and your account is enabled for encryption by default, or **Encrypted**\nis set to `true`, then the volume is encrypted using the default key specified for your account. If your account\ndoes not have a default key, then the volume is encrypted using the AWS managed key.\nAlternatively, if you want to specify a different key, you can specify one of the following:\n* Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.\n* Key alias. Specify the alias for the key, prefixed with `alias/`. For example, for a key with the alias\n `my_cmk`, use `alias/my_cmk`. Or to specify the AWS managed key, use\n `alias/aws/ebs`.\n* Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.\n* Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.\nIf you are creating a volume copy, omit this parameter. The volume is automatically encrypted with the same KMS key as the\nsource volume. You can't copy unencrypted volumes.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nIndicates whether the volume should be encrypted. The effect of setting the encryption state to `true`\ndepends on the volume origin (new, from a snapshot, or from an existing volume), starting encryption state, ownership,\nand whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the\n*Amazon EBS User Guide*.\nIf you are creating a volume copy, omit this parameter. The volume is automatically encrypted with the same KMS key\nas the source volume. You can't copy unencrypted volumes.\n*Required*: No\n*Type*: Boolean\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size of the volume, in GiBs.\n* Required for new empty volumes.\n* Optional for volumes created from snapshots and volume copies. In this case, the size defaults to the size of the\n snapshot or source volume. You can optionally specify a size that is equal to or larger than the size of the source\n snapshot or volume.\nSupported volume sizes:\n* gp2: `1 - 16,384` GiB\n* gp3: `1 - 65,536` GiB\n* io1: `4 - 16,384` GiB\n* io2: `4 - 65,536` GiB\n* st1 and sc1: `125 - 16,384` GiB\n* standard: `1 - 1024` GiB\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AutoEnableIO": { "MarkdownDocumentation": "`AutoEnableIO`\n\nIndicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS\ndisables I/O to the volume from attached EC2 instances when it determines that a volume's data is\npotentially inconsistent. If the consistency of the volume is not a concern, and you prefer that\nthe volume be made available immediately if it's impaired, you can configure the volume to\nautomatically enable I/O.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "OutpostArn": { "MarkdownDocumentation": "`OutpostArn`\n\nThe Amazon Resource Name (ARN) of the Outpost on which to create the volume.\nIf you intend to use a volume with an instance running on an outpost, then you must\ncreate the volume on the same outpost as the instance. You can't use a volume created\nin an AWS Region with an instance on an AWS outpost, or the other way around.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneId": { "MarkdownDocumentation": "`AvailabilityZoneId`\n\nThe ID of the Availability Zone in which to create the volume. For example, `use1-az1`.\nEither `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both.\nIf you are creating a volume copy, omit this parameter. The volume copy is created in the same Availability Zone\nas the source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzoneid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe ID of the Availability Zone in which to create the volume. For example, `us-east-1a`.\nEither `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both.\nIf you are creating a volume copy, omit this parameter. The volume copy is created in the same Availability Zone\nas the source volume.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Throughput": { "MarkdownDocumentation": "`Throughput`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS) to provision for the volume.\nRequired for `io1` and `io2` volumes. Optional for `gp3`\nvolumes. Omit for all other volume types.\nValid ranges:\n* gp3: `3,000` (*default*) `- 80,000` IOPS\n* io1: `100 - 64,000` IOPS\n* io2: `100 - 256,000` IOPS\n###### Note\n[Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) can support up to 256,000 IOPS. Other instances can support up to 32,000\nIOPS.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VolumeInitializationRate": { "MarkdownDocumentation": "`VolumeInitializationRate`\n\nSpecifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download\nthe snapshot blocks from Amazon S3 to the volume. This is also known as *volume\ninitialization*. Specifying a volume initialization rate ensures that the volume is\ninitialized at a predictable and consistent rate after creation.\nThis parameter is supported only for volumes created from snapshots. Omit this parameter\nif:\n* You want to create the volume using fast snapshot restore. You must specify a snapshot\n that is enabled for fast snapshot restore. In this case, the volume is fully initialized at\n creation.\n \n ###### Note\n \n If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate,\n the volume will be initialized at the specified rate instead of fast snapshot restore.\n* You want to create a volume that is initialized at the default rate.\nFor more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*.\nValid range: 100 - 300 MiB/s\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumeinitializationrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SnapshotId": { "MarkdownDocumentation": "`SnapshotId`\n\nThe snapshot from which to create the volume. Only specify to create a volume from a snapshot.\nTo create a new empty volume, omit this parameter and specify a value for `Size` instead. To create\na volume copy, omit this parameter and specify `SourceVolumeId` instead.\n*Required*: Conditional\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VolumeType": { "MarkdownDocumentation": "`VolumeType`\n\nThe 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`\n###### Important\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/ebs/latest/userguide/ebs-volume-types.html) in the\n*Amazon EBS User Guide*.\nDefault: `gp2`\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | io1 | io2 | gp2 ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceVolumeId": { "MarkdownDocumentation": "`SourceVolumeId`\n\nThe ID of the source EBS volume to copy. When specified, the volume\nis created as an exact copy of the specified volume. Only specify to\ncreate a volume copy. To create a new empty volume or to create a volume\nfrom a snapshot, omit this parameter,\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-sourcevolumeid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the volume during creation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ec2-volume-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "VolumeId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VolumeId`\n\nThe ID of the volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#VolumeId-fn::getatt" } } }, "AWS::EC2::VolumeAttachment": { "MarkdownDocumentation": "`AWS::EC2::VolumeAttachment`\n\nAttaches an Amazon EBS volume to a running instance and exposes it to the instance with\nthe specified device name.\nBefore this resource can be deleted (and therefore the volume detached), you must first\nunmount the volume in the instance. Failure to do so results in the volume being stuck in\nthe busy state while it is trying to detach, which could possibly damage the file system or\nthe data it contains.\nIf an Amazon EBS volume is the root device of an instance, it cannot be detached while\nthe instance is in the \"running\" state. To detach the root volume, stop the instance\nfirst.\nIf the root volume is detached from an instance with an AWS Marketplace product\ncode, then the product codes from that volume are no longer associated with the\ninstance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html", "Properties": { "VolumeId": { "MarkdownDocumentation": "`VolumeId`\n\nThe ID of the Amazon EBS volume. The volume and instance must be within the same\nAvailability Zone. This value can be a reference to an [`AWS::EC2::Volume`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an\nexisting 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-volumeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\nThe ID of the instance to which the volume attaches. This value can be a reference to an\n[`AWS::EC2::Instance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an\nexisting EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-instanceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Device": { "MarkdownDocumentation": "`Device`\n\nThe device name (for example, `/dev/sdh` or `xvdh`).\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-device", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECR::PullThroughCacheRule": { "MarkdownDocumentation": "`AWS::ECR::PullThroughCacheRule`\n\nThe `AWS::ECR::PullThroughCacheRule` resource creates or updates a pull\nthrough cache rule. A pull through cache rule provides a way to cache images from an\nupstream registry in your Amazon ECR private registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html", "Properties": { "UpstreamRegistryUrl": { "MarkdownDocumentation": "`UpstreamRegistryUrl`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html#cfn-ecr-pullthroughcacherule-upstreamregistryurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CustomRoleArn": { "MarkdownDocumentation": "`CustomRoleArn`\n\nThe ARN of the IAM role associated with the pull through cache rule.\n*Required*: No\n*Type*: String\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html#cfn-ecr-pullthroughcacherule-customrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UpstreamRepositoryPrefix": { "MarkdownDocumentation": "`UpstreamRepositoryPrefix`\n\nThe upstream repository prefix associated with the pull through cache rule.\n*Required*: No\n*Type*: String\n*Pattern*: `^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$`\n*Minimum*: `2`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html#cfn-ecr-pullthroughcacherule-upstreamrepositoryprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UpstreamRegistry": { "MarkdownDocumentation": "`UpstreamRegistry`\n\nThe name of the upstream source registry associated with the pull through cache\nrule.\n*Required*: No\n*Type*: String\n*Allowed values*: `ecr | ecr-public | quay | k...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ecr", "ecr-public", "quay", "k8s", "docker-hub", "github-container-registry", "azure-container-registry", "gitlab-container-registry" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html#cfn-ecr-pullthroughcacherule-upstreamregistry", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CredentialArn": { "MarkdownDocumentation": "`CredentialArn`\n\nThe ARN of the Secrets Manager secret associated with the pull through cache rule.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\\-pullthroughcache\\/[a-zA-Z0-9\\/_+=.@-]+$`\n*Minimum*: `50`\n*Maximum*: `612`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html#cfn-ecr-pullthroughcacherule-credentialarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EcrRepositoryPrefix": { "MarkdownDocumentation": "`EcrRepositoryPrefix`\n\nThe Amazon ECR repository prefix associated with the pull through cache rule.\n*Required*: No\n*Type*: String\n*Pattern*: `^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$`\n*Minimum*: `2`\n*Maximum*: `30`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html#cfn-ecr-pullthroughcacherule-ecrrepositoryprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::ECR::PullTimeUpdateExclusion": { "MarkdownDocumentation": "`AWS::ECR::PullTimeUpdateExclusion`\n\nThe `AWS::ECR::PullTimeUpdateExclusion` resource Property description not available. for ECR.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pulltimeupdateexclusion.html", "Properties": { "PrincipalArn": { "MarkdownDocumentation": "`PrincipalArn`\n\nThe ARN of the IAM principal to remove from the pull time update exclusion list.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[a-z]+)*:iam::[0-9]{12}:(role|user)/[\\w+=,.@-]+(/[\\w+=,.@-]+)*$`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pulltimeupdateexclusion.html#cfn-ecr-pulltimeupdateexclusion-principalarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECR::RegistryPolicy": { "MarkdownDocumentation": "`AWS::ECR::RegistryPolicy`\n\nThe `AWS::ECR::RegistryPolicy` resource creates or updates the permissions\npolicy for a private registry.\nA private registry policy is used to specify permissions for another AWS account and is used when configuring cross-account replication. For\nmore information, see [Registry\npermissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html", "Properties": { "PolicyText": { "MarkdownDocumentation": "`PolicyText`\n\nThe JSON policy text for your registry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } }, "Attributes": { "RegistryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegistryId`\n\nThe account ID of the private registry the policy is associated with.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#RegistryId-fn::getatt" } } }, "AWS::ECR::RegistryScanningConfiguration": { "MarkdownDocumentation": "`AWS::ECR::RegistryScanningConfiguration`\n\nThe scanning configuration for a private registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registryscanningconfiguration.html", "Properties": { "ScanType": { "MarkdownDocumentation": "`ScanType`\n\nThe type of scanning configured for the registry.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BASIC | ENHANCED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "ENHANCED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registryscanningconfiguration.html#cfn-ecr-registryscanningconfiguration-scantype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe scanning rules associated with the registry.\n*Required*: Yes\n*Type*: Array of [ScanningRule](./aws-properties-ecr-registryscanningconfiguration-scanningrule.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registryscanningconfiguration.html#cfn-ecr-registryscanningconfiguration-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ScanningRule", "DuplicatesAllowed": true } }, "Attributes": { "RegistryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegistryId`\n\nThe account ID of the destination registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registryscanningconfiguration.html#RegistryId-fn::getatt" } } }, "AWS::ECR::ReplicationConfiguration": { "MarkdownDocumentation": "`AWS::ECR::ReplicationConfiguration`\n\nThe `AWS::ECR::ReplicationConfiguration` resource creates or updates the\nreplication configuration for a private registry. The first time a replication\nconfiguration is applied to a private registry, a service-linked IAM role\nis created in your account for the replication process. For more information, see [Using\nService-Linked Roles for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) in the *Amazon Elastic\nContainer Registry User Guide*.\n###### Note\nWhen configuring cross-account replication, the destination account must grant the\nsource account permission to replicate. This permission is controlled using a\nprivate registry permissions policy. For more information, see\n`AWS::ECR::RegistryPolicy`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html", "Properties": { "ReplicationConfiguration": { "MarkdownDocumentation": "`ReplicationConfiguration`\n\nThe replication configuration for a registry.\n*Required*: Yes\n*Type*: [ReplicationConfiguration](./aws-properties-ecr-replicationconfiguration-replicationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ReplicationConfiguration" } }, "Attributes": { "RegistryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegistryId`\n\nThe account ID of the destination registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#RegistryId-fn::getatt" } } }, "AWS::ECR::Repository": { "MarkdownDocumentation": "`AWS::ECR::Repository`\n\nThe `AWS::ECR::Repository` resource specifies an Amazon Elastic Container\nRegistry (Amazon ECR) repository, where users can push and pull Docker images, Open\nContainer Initiative (OCI) images, and OCI compatible artifacts. For more information,\nsee [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name, such as\n`test-repository`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html", "Properties": { "EmptyOnDelete": { "MarkdownDocumentation": "`EmptyOnDelete`\n\nIf true, deleting the repository force deletes the contents of the repository. If\nfalse, the repository must be empty before attempting to delete 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-emptyondelete", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ImageScanningConfiguration": { "MarkdownDocumentation": "`ImageScanningConfiguration`\n\n###### Important\nThe `imageScanningConfiguration` parameter is being deprecated, in\nfavor of specifying the image scanning configuration at the registry level. For more\ninformation, see `PutRegistryScanningConfiguration`.\nThe image scanning configuration for the repository. This determines whether images\nare scanned for known vulnerabilities after being pushed to the repository.\n*Required*: No\n*Type*: [ImageScanningConfiguration](./aws-properties-ecr-repository-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ImageScanningConfiguration" }, "ImageTagMutabilityExclusionFilters": { "MarkdownDocumentation": "`ImageTagMutabilityExclusionFilters`\n\nA list of filters that specify which image tags are excluded from the repository's\nimage tag mutability setting.\n*Required*: No\n*Type*: Array of [ImageTagMutabilityExclusionFilter](./aws-properties-ecr-repository-imagetagmutabilityexclusionfilter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutabilityexclusionfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ImageTagMutabilityExclusionFilter", "DuplicatesAllowed": true }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption configuration for the repository. This determines how the contents of\nyour repository are encrypted at rest.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-ecr-repository-encryptionconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EncryptionConfiguration" }, "RepositoryPolicyText": { "MarkdownDocumentation": "`RepositoryPolicyText`\n\nThe JSON repository policy text to apply to the repository. For more information, see\n[Amazon ECR repository\npolicies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.\n*Required*: No\n*Type*: Json\n*Minimum*: `0`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LifecyclePolicy": { "MarkdownDocumentation": "`LifecyclePolicy`\n\nCreates or updates a lifecycle policy. For information about lifecycle policy syntax,\nsee [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).\n*Required*: No\n*Type*: [LifecyclePolicy](./aws-properties-ecr-repository-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy", "UpdateType": "Mutable", "Required": false, "Type": "LifecyclePolicy" }, "RepositoryName": { "MarkdownDocumentation": "`RepositoryName`\n\nThe name to use for the repository. The repository name may be specified on its own\n(such as `nginx-web-app`) or it can be prepended with a namespace to group\nthe repository into a category (such as `project-a/nginx-web-app`). If you\ndon't specify a name, AWS CloudFormation generates a unique physical ID and uses\nthat ID for the repository name. For more information, see [Name\ntype](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\nThe repository name must start with a letter and can only contain lowercase letters,\nnumbers, hyphens, underscores, and forward slashes.\n###### Note\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must\nreplace the resource, specify a new name.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$`\n*Minimum*: `2`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecr-repository-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "ImageTagMutability": { "MarkdownDocumentation": "`ImageTagMutability`\n\nThe tag mutability setting for the repository. If this parameter is omitted, the\ndefault setting of `MUTABLE` will be used which will allow image tags to be\noverwritten. If `IMMUTABLE` is specified, all image tags within the\nrepository will be immutable which will prevent them from being overwritten.\n*Required*: No\n*Type*: String\n*Allowed values*: `MUTABLE | IMMUTABLE | MUTAB...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MUTABLE", "IMMUTABLE", "MUTABLE_WITH_EXCLUSION", "IMMUTABLE_WITH_EXCLUSION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "RepositoryUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`RepositoryUri`\n\nReturns the URI for the specified `AWS::ECR::Repository` resource. For\nexample,\n`123456789012.dkr.ecr.us-west-2.amazonaws.com/repository`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#RepositoryUri-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) for the specified\n`AWS::ECR::Repository` resource. For example,\n`arn:aws:ecr:eu-west-1:123456789012:repository/test-repository`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#Arn-fn::getatt" } } }, "AWS::ECR::RepositoryCreationTemplate": { "MarkdownDocumentation": "`AWS::ECR::RepositoryCreationTemplate`\n\nThe details of the repository creation template associated with the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html", "Properties": { "ImageTagMutabilityExclusionFilters": { "MarkdownDocumentation": "`ImageTagMutabilityExclusionFilters`\n\nA list of filters that specify which image tags are excluded from the repository\ncreation template's image tag mutability setting.\n*Required*: No\n*Type*: Array of [ImageTagMutabilityExclusionFilter](./aws-properties-ecr-repositorycreationtemplate-imagetagmutabilityexclusionfilter.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-imagetagmutabilityexclusionfilters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ImageTagMutabilityExclusionFilter", "DuplicatesAllowed": true }, "CustomRoleArn": { "MarkdownDocumentation": "`CustomRoleArn`\n\nThe ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role\nwhen the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the\nservice-linked role for the repository creation template.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[A-Za-z0-9+=,-.@_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-customrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description associated with the repository creation template.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption configuration associated with the repository creation template.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-ecr-repositorycreationtemplate-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfiguration" }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nThe metadata to apply to the repository to help you categorize and organize. Each tag\nconsists 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\na maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecr-repositorycreationtemplate-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "RepositoryPolicy": { "MarkdownDocumentation": "`RepositoryPolicy`\n\nThe repository policy to apply to repositories created using the template. A\nrepository policy is a permissions policy associated with a repository to control access\npermissions.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-repositorypolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LifecyclePolicy": { "MarkdownDocumentation": "`LifecyclePolicy`\n\nThe lifecycle policy to use for repositories created using the template.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-lifecyclepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AppliedFor": { "MarkdownDocumentation": "`AppliedFor`\n\nA list of enumerable Strings representing the repository creation scenarios that this\ntemplate will apply towards. The supported scenarios are PULL\\_THROUGH\\_CACHE, REPLICATION, and\nCREATE\\_ON\\_PUSH\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-appliedfor", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Prefix": { "MarkdownDocumentation": "`Prefix`\n\nThe repository namespace prefix associated with the repository creation\ntemplate.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-prefix", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ImageTagMutability": { "MarkdownDocumentation": "`ImageTagMutability`\n\nThe tag mutability setting for the repository. If this parameter is omitted, the\ndefault setting of `MUTABLE` will be used which will allow image tags to be\noverwritten. If `IMMUTABLE` is specified, all image tags within the\nrepository will be immutable which will prevent them from being overwritten.\n*Required*: No\n*Type*: String\n*Allowed values*: `MUTABLE | IMMUTABLE | IMMUT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MUTABLE", "IMMUTABLE", "IMMUTABLE_WITH_EXCLUSION", "MUTABLE_WITH_EXCLUSION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-imagetagmutability", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time, in JavaScript date format, when the repository creation template\nwas created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#CreatedAt-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe date and time, in JavaScript date format, when the repository creation template\nwas last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#UpdatedAt-fn::getatt" } } }, "AWS::ECR::SigningConfiguration": { "MarkdownDocumentation": "`AWS::ECR::SigningConfiguration`\n\nThe signing configuration for a registry, which specifies rules\nfor automatically signing images when pushed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-signingconfiguration.html", "Properties": { "Rules": { "MarkdownDocumentation": "`Rules`\n\nA list of signing rules. Each rule defines a signing profile and optional repository\nfilters that determine which images are automatically signed.\n*Required*: Yes\n*Type*: Array of [Rule](./aws-properties-ecr-signingconfiguration-rule.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-signingconfiguration.html#cfn-ecr-signingconfiguration-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true } }, "Attributes": { "RegistryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegistryId`\n\nThe account ID of the destination registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-signingconfiguration.html#RegistryId-fn::getatt" } } }, "AWS::ECS::CapacityProvider": { "MarkdownDocumentation": "`AWS::ECS::CapacityProvider`\n\nCreates a capacity provider. Capacity providers are associated with a cluster and are\nused in capacity provider strategies to facilitate cluster auto scaling. You can create\ncapacity providers for Amazon ECS Managed Instances and EC2 instances. AWS Fargate has the\npredefined `FARGATE` and `FARGATE_SPOT` capacity providers.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nIn the following example, the `Ref` function returns the name of the capacity\nprovider, such as `MyStack-MyCapacityProvider-JrwYBzxovGfr`.\n`{ \"Ref\": \"MyCapacityProvider\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html", "Properties": { "AutoScalingGroupProvider": { "MarkdownDocumentation": "`AutoScalingGroupProvider`\n\nThe Auto Scaling group settings for the capacity provider.\n*Required*: No\n*Type*: [AutoScalingGroupProvider](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider", "UpdateType": "Mutable", "Required": false, "Type": "AutoScalingGroupProvider" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe cluster that this capacity provider is associated with. Managed instances capacity\nproviders are cluster-scoped, meaning they can only be used within their associated\ncluster.\nThis is required for Managed 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-clustername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to the capacity provider to help you categorize and\norganize 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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n 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\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with\n this prefix. Tags with this prefix do not count against your tags per resource\n limit.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecs-capacityprovider-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the capacity provider. If a name is specified, it cannot start with\n`aws`, `ecs`, or `fargate`. If no name is specified, a\ndefault name in the `CFNStackName-CFNResourceName-RandomString` format is\nused.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ManagedInstancesProvider": { "MarkdownDocumentation": "`ManagedInstancesProvider`\n\nThe configuration for the Amazon ECS Managed Instances provider. This includes the\ninfrastructure role, the launch template configuration, and tag propagation\nsettings.\n*Required*: No\n*Type*: [ManagedInstancesProvider](./aws-properties-ecs-capacityprovider-managedinstancesprovider.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-managedinstancesprovider", "UpdateType": "Mutable", "Required": false, "Type": "ManagedInstancesProvider" } } }, "AWS::ECS::Cluster": { "MarkdownDocumentation": "`AWS::ECS::Cluster`\n\nThe `AWS::ECS::Cluster` resource creates an Amazon Elastic Container Service\n(Amazon ECS) cluster.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nIn the following example, the `Ref` function returns the name of the\n`MyECSCluster` cluster, such as\n`MyStack-MyECSCluster-NT5EUXTNTXXD`.\n`{ \"Ref\": \"MyECSCluster\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html", "Properties": { "ClusterSettings": { "MarkdownDocumentation": "`ClusterSettings`\n\nThe settings to use when creating a cluster. This parameter is used to turn on\nCloudWatch Container Insights with enhanced observability or CloudWatch Container\nInsights for a cluster.\nContainer Insights with enhanced observability provides all the Container Insights\nmetrics, plus additional task and container metrics. This version supports enhanced\nobservability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types.\nAfter you configure Container Insights with enhanced observability on Amazon ECS,\nContainer Insights auto-collects detailed infrastructure telemetry from the cluster\nlevel down to the container level in your environment and displays these critical\nperformance data in curated dashboards removing the heavy lifting in observability\nset-up.\nFor more information, see [Monitor\nAmazon ECS containers using Container Insights with enhanced observability](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\n*Type*: [Array](./aws-properties-ecs-cluster-clustersettings.html) of [ClusterSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustersettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ClusterSettings", "DuplicatesAllowed": true }, "DefaultCapacityProviderStrategy": { "MarkdownDocumentation": "`DefaultCapacityProviderStrategy`\n\nThe default capacity provider strategy for the cluster. When services or tasks are run\nin the cluster with no launch type or capacity provider strategy specified, the default\ncapacity provider strategy is used.\n*Required*: No\n*Type*: Array of [CapacityProviderStrategyItem](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-defaultcapacityproviderstrategy", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CapacityProviderStrategyItem", "DuplicatesAllowed": true }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe execute command and managed storage configuration for the cluster.\n*Required*: No\n*Type*: [ClusterConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-configuration", "UpdateType": "Mutable", "Required": false, "Type": "ClusterConfiguration" }, "ServiceConnectDefaults": { "MarkdownDocumentation": "`ServiceConnectDefaults`\n\nUse this parameter to set a default Service Connect namespace. After you set a default\nService Connect namespace, any new services with Service Connect turned on that are\ncreated in the cluster are added as client services in the namespace. This setting only\napplies to new services that set the `enabled` parameter to `true`\nin the `ServiceConnectConfiguration`. You can set the namespace of each\nservice individually in the `ServiceConnectConfiguration` to override this\ndefault parameter.\nTasks that run in a namespace can use short names to connect to services in the\nnamespace. Tasks can connect to services across all of the clusters in the namespace.\nTasks connect through a managed proxy container that collects logs and metrics for\nincreased visibility. Only the tasks that Amazon ECS services create are supported with\nService Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\n*Type*: [ServiceConnectDefaults](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-serviceconnectdefaults", "UpdateType": "Mutable", "Required": false, "Type": "ServiceConnectDefaults" }, "CapacityProviders": { "MarkdownDocumentation": "`CapacityProviders`\n\nThe short name of one or more capacity providers to associate with the cluster. A\ncapacity provider must be associated with a cluster before it can be included as part of\nthe default capacity provider strategy of the cluster or used in a capacity provider\nstrategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or\n[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\nprovider must be created but not associated with another cluster. New Auto Scaling group\ncapacity 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\n`FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers\nare available to all accounts and only need to be associated with a cluster to be\nused.\nThe [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available\ncapacity providers for a cluster after the cluster is created.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-capacityproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nA user-generated string that you use to identify your cluster. If you don't specify a\nname, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to the cluster to help you categorize and organize them.\nEach 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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n 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\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with\n this prefix. Tags with this prefix do not count against your tags per resource\n limit.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecs-cluster-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the Amazon ECS cluster, such as\n`arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#Arn-fn::getatt" } } }, "AWS::ECS::ClusterCapacityProviderAssociations": { "MarkdownDocumentation": "`AWS::ECS::ClusterCapacityProviderAssociations`\n\nThe `AWS::ECS::ClusterCapacityProviderAssociations` resource associates one\nor more capacity providers and a default capacity provider strategy with a cluster.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the cluster name.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html", "Properties": { "DefaultCapacityProviderStrategy": { "MarkdownDocumentation": "`DefaultCapacityProviderStrategy`\n\nThe default capacity provider strategy to associate with the cluster.\n*Required*: Yes\n*Type*: Array of [CapacityProviderStrategy](./aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-defaultcapacityproviderstrategy", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "CapacityProviderStrategy", "DuplicatesAllowed": true }, "CapacityProviders": { "MarkdownDocumentation": "`CapacityProviders`\n\nThe capacity providers to associate with the cluster.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-capacityproviders", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Cluster": { "MarkdownDocumentation": "`Cluster`\n\nThe cluster the capacity provider association is the target of.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#cfn-ecs-clustercapacityproviderassociations-cluster", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::ExpressGatewayService": { "MarkdownDocumentation": "`AWS::ECS::ExpressGatewayService`\n\nCreates an Express service that simplifies deploying containerized web applications on\nAmazon ECS with managed AWS infrastructure. This operation provisions and configures\nApplication Load Balancers, target groups, security groups, and auto-scaling policies\nautomatically.\nSpecify a primary container configuration with your application image and basic\nsettings. Amazon ECS creates the necessary AWS resources for traffic distribution, health\nmonitoring, network access control, and capacity management.\nProvide an execution role for task operations and an infrastructure role for managing\nAWS resources on your behalf.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html", "Properties": { "TaskRoleArn": { "MarkdownDocumentation": "`TaskRoleArn`\n\nThe ARN of the task role for the service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-taskrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe ARN of the task execution role for the service revision.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-executionrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InfrastructureRoleArn": { "MarkdownDocumentation": "`InfrastructureRoleArn`\n\nThe ARN of the infrastructure role that manages AWS resources for the Express\nservice.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-infrastructurerolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ScalingTarget": { "MarkdownDocumentation": "`ScalingTarget`\n\nThe auto-scaling configuration for this service revision.\n*Required*: No\n*Type*: [ExpressGatewayScalingTarget](./aws-properties-ecs-expressgatewayservice-expressgatewayscalingtarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-scalingtarget", "UpdateType": "Mutable", "Required": false, "Type": "ExpressGatewayScalingTarget" }, "PrimaryContainer": { "MarkdownDocumentation": "`PrimaryContainer`\n\nThe primary container configuration for this service revision.\n*Required*: Yes\n*Type*: [ExpressGatewayContainer](./aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-primarycontainer", "UpdateType": "Mutable", "Required": true, "Type": "ExpressGatewayContainer" }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe name of the Express service.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-servicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe memory allocation for tasks in this service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-memory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HealthCheckPath": { "MarkdownDocumentation": "`HealthCheckPath`\n\nThe health check path for this service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-healthcheckpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Cluster": { "MarkdownDocumentation": "`Cluster`\n\nThe short name or full ARN of the cluster that hosts the Express service.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-cluster", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe CPU allocation for tasks in this service revision.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-cpu", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for tasks in this service revision.\n*Required*: No\n*Type*: [ExpressGatewayServiceNetworkConfiguration](./aws-properties-ecs-expressgatewayservice-expressgatewayservicenetworkconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExpressGatewayServiceNetworkConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata applied to the Express service.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecs-expressgatewayservice-tag.html)\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#cfn-ecs-expressgatewayservice-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "Type": "ExpressGatewayServiceStatus", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#Status-fn::getatt" }, "ECSManagedResourceArns.IngressPath.LoadBalancerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.IngressPath.LoadBalancerArn`\n\nThe ARN of the Load Balancer associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.IngressPath.LoadBalancerArn-fn::getatt" }, "ECSManagedResourceArns.AutoScaling.ScalableTarget": { "PrimitiveType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.AutoScaling.ScalableTarget`\n\nThe Auto Scaling Scalable Target ARN associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.AutoScaling.ScalableTarget-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe Unix timestamp for when the Express service was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#CreatedAt-fn::getatt" }, "ECSManagedResourceArns.LogGroups": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.LogGroups`\n\nThe list of Log Group ARNs associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.LogGroups-fn::getatt" }, "ECSManagedResourceArns.AutoScaling": { "Type": "AutoScalingArns", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.AutoScaling-fn::getatt" }, "ServiceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceArn`\n\nThe ARN that identifies the Express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ServiceArn-fn::getatt" }, "ECSManagedResourceArns": { "Type": "ECSManagedResourceArns", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns-fn::getatt" }, "ECSManagedResourceArns.IngressPath.TargetGroupArns": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.IngressPath.TargetGroupArns`\n\nThe list of Target Group ARNs associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.IngressPath.TargetGroupArns-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe Unix timestamp for when the Express service was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#UpdatedAt-fn::getatt" }, "ECSManagedResourceArns.MetricAlarms": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.MetricAlarms`\n\nThe list of Metric Alarm ARNs associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.MetricAlarms-fn::getatt" }, "ActiveConfigurations": { "Type": "List", "ItemType": "ExpressGatewayServiceConfiguration", "MarkdownDocumentation": "`ActiveConfigurations`\n\nThe list of active service configurations for the Express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ActiveConfigurations-fn::getatt" }, "Status.StatusCode": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#Status.StatusCode-fn::getatt" }, "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe Endpoint of the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#Endpoint-fn::getatt" }, "ECSManagedResourceArns.IngressPath": { "Type": "IngressPathArns", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.IngressPath-fn::getatt" }, "ECSManagedResourceArns.IngressPath.CertificateArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.IngressPath.CertificateArn`\n\nThe Certificate ARN associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.IngressPath.CertificateArn-fn::getatt" }, "ECSManagedResourceArns.AutoScaling.ApplicationAutoScalingPolicies": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.AutoScaling.ApplicationAutoScalingPolicies`\n\nThe list of Auto Scaling policy ARNs associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.AutoScaling.ApplicationAutoScalingPolicies-fn::getatt" }, "ECSManagedResourceArns.ServiceSecurityGroups": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.ServiceSecurityGroups`\n\nThe list of Security Group ARNs associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.ServiceSecurityGroups-fn::getatt" }, "ECSManagedResourceArns.IngressPath.ListenerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.IngressPath.ListenerArn`\n\nThe ARN of the Load Balancer listener associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.IngressPath.ListenerArn-fn::getatt" }, "ECSManagedResourceArns.IngressPath.ListenerRuleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.IngressPath.ListenerRuleArn`\n\nThe ARN of the Load Balancer listener rule associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.IngressPath.ListenerRuleArn-fn::getatt" }, "ECSManagedResourceArns.IngressPath.LoadBalancerSecurityGroups": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ECSManagedResourceArns.IngressPath.LoadBalancerSecurityGroups`\n\nThe list of Load Balancer Security Group ARNs associated with the express service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-expressgatewayservice.html#ECSManagedResourceArns.IngressPath.LoadBalancerSecurityGroups-fn::getatt" } } }, "AWS::ECS::PrimaryTaskSet": { "MarkdownDocumentation": "`AWS::ECS::PrimaryTaskSet`\n\nModifies which task set in a service is the primary task set. Any parameters that are\nupdated on the primary task set in a service will transition to the service. This is\nused when a service uses the `EXTERNAL` deployment controller type. For more\ninformation, see [Amazon ECS Deployment\nTypes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html", "Properties": { "TaskSetId": { "MarkdownDocumentation": "`TaskSetId`\n\nThe short name or full Amazon Resource Name (ARN) of the task set to set as the\nprimary task set in the deployment.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-tasksetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Cluster": { "MarkdownDocumentation": "`Cluster`\n\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the\nservice that the task set exists 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-cluster", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Service": { "MarkdownDocumentation": "`Service`\n\nThe short name or full Amazon Resource Name (ARN) of the service that the task set\nexists 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-primarytaskset.html#cfn-ecs-primarytaskset-service", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::ECS::Service": { "MarkdownDocumentation": "`AWS::ECS::Service`\n\nThe `AWS::ECS::Service` resource creates an Amazon Elastic Container Service\n(Amazon ECS) service that runs and maintains the requested number of tasks and associated\nload balancers.\n###### Important\nThe stack update fails if you change any properties that require replacement and at\nleast one Amazon ECS Service Connect `ServiceConnectConfiguration`\nproperty is configured. This is because AWS CloudFormation creates\nthe replacement service first, but each `ServiceConnectService` must have a\nname that is unique in the namespace.\n###### Note\nStarting April 15, 2023, AWS; will not onboard new customers to Amazon\nElastic Inference (EI), and will help current customers migrate their workloads to\noptions that offer better price and performance. After April 15, 2023, new customers\nwill not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\nAmazon ECS, or Amazon EC2. However, customers who have used Amazon EI\nat least once during the past 30-day period are considered current customers and will be\nable to continue using the service.\n###### Important\nOn June 12, 2025, Amazon ECS launched support for updating capacity provider\nconfiguration for Amazon ECS services. With this launch, Amazon ECS\nalso aligned the CloudFormation update behavior for\n`CapacityProviderStrategy` parameter with the standard practice. For\nmore information, see [Amazon ECS adds support for updating capacity provider\nconfiguration for ECS services](https://aws.amazon.com/about-aws/whats-new/2025/05/amazon-ecs-capacity-provider-configuration-ecs/). Previously Amazon ECS ignored the\n`CapacityProviderStrategy` property if it was set to an empty list\nfor example, `[]` in CloudFormation, because updating capacity\nprovider configuration was not supported. Now, with support for capacity provider\nupdates, customers can remove capacity providers from a service by passing an empty\nlist. When you specify an empty list (`[]`) for the\n`CapacityProviderStrategy` property in your CloudFormation\ntemplate, Amazon ECS will remove any capacity providers associated with the\nservice, as follows:\n* For services created with a capacity provider strategy after the launch:\n \n + If there's a cluster default strategy set, the service will revert\n to using that default strategy.\n + If no cluster default strategy exists, you will receive the\n following error:\n \n No launch type to fall back to for empty capacity provider\n strategy. Your service was not created with a launch type.\n* For services created with a capacity provider strategy prior to the launch:\n \n + If `CapacityProviderStrategy` had\n `FARGATE_SPOT` or `FARGATE` capacity\n providers, the launch type will be updated to `FARGATE`\n and the capacity provider will be removed.\n + If the strategy included Auto Scaling group capacity providers,\n the service will revert to EC2 launch type, and the Auto Scaling\n group capacity providers will not be used.\nRecommended Actions\nIf you are currently using `CapacityProviderStrategy: []` in your CloudFormation templates, you should take one of the following actions:\n* If you do not intend to update the Capacity Provider Strategy:\n \n + Remove the `CapacityProviderStrategy` property entirely from your CloudFormation template\n + Alternatively, use `!Ref AWS::NoValue` for the `CapacityProviderStrategy` property in your template\n* If you intend to maintain or update the Capacity Provider Strategy,\n specify the actual Capacity Provider Strategy for the service in your\n CloudFormation template.\nIf your CloudFormation template had an empty list ([]) for\n`CapacityProviderStrategy` prior to the aforementioned launch on June\n12, and you are using the same template with `CapacityProviderStrategy:\n[]`, you might encounter the following error:\nInvalid request provided: When switching from launch type to capacity\nprovider strategy on an existing service, or making a change to a capacity\nprovider strategy on a service that is already using one, you must force a new\ndeployment. (Service: Ecs, Status Code: 400, Request ID: xxx) (SDK Attempt\nCount: 1)\" (RequestToken: xxx HandlerErrorCode: InvalidRequest)\nNote that CloudFormation automatically initiates a new deployment when it detects a parameter change, but customers cannot choose to force a deployment through CloudFormation. This is an invalid input scenario that requires one of the remediation actions listed above.\nIf you are experiencing active production issues related to this change, contact AWS Support or your Technical Account Manager.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN).\nIn the following example, the `Ref` function returns the ARN of the\n`MyECSService` service, such as\n`arn:aws:ecs:us-west-2:123456789012:service/sample-webapp`.\n`{ \"Ref\": \"MyECSService\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html", "Properties": { "PlatformVersion": { "MarkdownDocumentation": "`PlatformVersion`\n\nThe platform version that your tasks in the service are running on. A platform version\nis specified only for tasks using the Fargate launch type. If one isn't specified, the\n`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\nContainer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-platformversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PropagateTags": { "MarkdownDocumentation": "`PropagateTags`\n\nSpecifies whether to propagate the tags from the task definition to the task. If no\nvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\nduring task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.\nYou must set this to a value other than `NONE` when you use Cost Explorer.\nFor more information, see [Amazon ECS usage\nreports](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) in the *Amazon Elastic Container Service Developer\nGuide*.\nThe default is `NONE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `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)", "RefReturnValue": "", "AllowedValues": [ "SERVICE", "TASK_DEFINITION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-propagatetags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PlacementStrategies": { "MarkdownDocumentation": "`PlacementStrategies`\n\nThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5\nstrategy rules for each service.\n###### Important\nTo remove this property from your service resource, specify an empty `PlacementStrategy` array.\n*Required*: No\n*Type*: Array of [PlacementStrategy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementstrategies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlacementStrategy", "DuplicatesAllowed": true }, "ServiceRegistries": { "MarkdownDocumentation": "`ServiceRegistries`\n\nThe details of the service discovery registry to associate with this service. For more\ninformation, see [Service\ndiscovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).\n###### Note\nEach service may be associated with one service registry. Multiple service\nregistries for each service isn't supported.\n\n###### Important\nTo remove this property from your service resource, specify an empty `ServiceRegistry` array.\n*Required*: No\n*Type*: Array of [ServiceRegistry](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceregistries", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServiceRegistry", "DuplicatesAllowed": true }, "VolumeConfigurations": { "MarkdownDocumentation": "`VolumeConfigurations`\n\nThe configuration for a volume specified in the task definition as a volume that is configured at\nlaunch time. Currently, the only supported volume type is an Amazon EBS volume.\n###### Important\nTo remove this property from your service resource, specify an empty `ServiceVolumeConfiguration` array.\n*Required*: No\n*Type*: Array of [ServiceVolumeConfiguration](./aws-properties-ecs-service-servicevolumeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-volumeconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ServiceVolumeConfiguration", "DuplicatesAllowed": true }, "CapacityProviderStrategy": { "MarkdownDocumentation": "`CapacityProviderStrategy`\n\nThe capacity provider strategy to use for the service.\nIf a `capacityProviderStrategy` is specified, the `launchType`\nparameter must be omitted. If no `capacityProviderStrategy` or\n`launchType` is specified, the\n`defaultCapacityProviderStrategy` for the cluster is used.\nA capacity provider strategy can contain a maximum of 20 capacity providers.\n###### Important\nTo remove this property from your service resource, specify an empty `CapacityProviderStrategyItem` array.\n*Required*: No\n*Type*: Array of [CapacityProviderStrategyItem](./aws-properties-ecs-service-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CapacityProviderStrategyItem", "DuplicatesAllowed": true }, "LaunchType": { "MarkdownDocumentation": "`LaunchType`\n\nThe launch type on which to run your service. For more information, see [Amazon ECS\nLaunch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n###### Note\nIf you want to use Managed Instances, you must use the `capacityProviderStrategy` request parameter\n*Required*: No\n*Type*: String\n*Allowed values*: `EC2 | FARGATE | EXTERNAL...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EC2", "FARGATE", "EXTERNAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-launchtype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneRebalancing": { "MarkdownDocumentation": "`AvailabilityZoneRebalancing`\n\nIndicates whether to use Availability Zone rebalancing for the service.\nFor more information, see [Balancing an Amazon\nECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the **Amazon\nElastic Container Service Developer Guide**.\nThe default behavior of `AvailabilityZoneRebalancing` differs between\ncreate and update requests:\n* For create service requests, when no value is specified for\n `AvailabilityZoneRebalancing`, Amazon ECS defaults the value to\n `ENABLED`.\n* For update service requests, when no value is specified for\n `AvailabilityZoneRebalancing`, Amazon ECS defaults to the\n existing service\u2019s `AvailabilityZoneRebalancing` value. If the\n service never had an `AvailabilityZoneRebalancing` value set, Amazon\n ECS treats this as `DISABLED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-availabilityzonerebalancing", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SchedulingStrategy": { "MarkdownDocumentation": "`SchedulingStrategy`\n\nThe 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\n desired number of tasks across your cluster. By default, the service scheduler\n spreads tasks across Availability Zones. You can use task placement strategies\n and constraints to customize task placement decisions. This scheduler strategy\n is required if the service uses the `CODE_DEPLOY` or\n `EXTERNAL` deployment controller types.\n* `DAEMON`-The daemon scheduling strategy deploys exactly one task on\n each active container instance that meets all of the task placement constraints\n that you specify in your cluster. The service scheduler also evaluates the task\n placement constraints for running tasks and will stop tasks that don't meet the\n placement constraints. When you're using this strategy, you don't need to\n specify a desired number of tasks, a task placement strategy, or use Service\n Auto Scaling policies.\n \n ###### Note\n \n Tasks using the Fargate launch type or the `CODE_DEPLOY` or\n `EXTERNAL` deployment controller types don't support the\n `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)", "RefReturnValue": "", "AllowedValues": [ "DAEMON", "REPLICA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-schedulingstrategy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for the service. This parameter is required for task\ndefinitions that use the `awsvpc` network mode to receive their own elastic\nnetwork interface, and it is not supported for other network modes. For more information,\nsee [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: Conditional\n*Type*: [NetworkConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NetworkConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to the service to help you categorize and organize them.\nEach tag consists of a key and an optional value, both of which you define. When a\nservice 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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n 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\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with\n this prefix. Tags with this prefix do not count against your tags per resource\n limit.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecs-service-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ForceNewDeployment": { "MarkdownDocumentation": "`ForceNewDeployment`\n\nDetermines whether to force a new deployment of the service. By default, deployments\naren't forced. You can use this option to start a new deployment with no service\ndefinition changes. For example, you can update a service's tasks to use a newer Docker\nimage with the same image/tag combination (`my_image:latest`) or to roll\nFargate tasks onto a newer platform version.\n*Required*: No\n*Type*: [ForceNewDeployment](./aws-properties-ecs-service-forcenewdeployment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-forcenewdeployment", "UpdateType": "Mutable", "Required": false, "Type": "ForceNewDeployment" }, "HealthCheckGracePeriodSeconds": { "MarkdownDocumentation": "`HealthCheckGracePeriodSeconds`\n\nThe period of time, in seconds, that the Amazon ECS service scheduler ignores\nunhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task\nhas first started. If you do not specify a health check grace period value, the default\nvalue of 0 is used. If you do not use any of the health checks, then\n`healthCheckGracePeriodSeconds` is unused.\nIf your service has more running tasks than desired, unhealthy tasks in the grace\nperiod might be stopped to reach the desired 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-healthcheckgraceperiodseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnableECSManagedTags": { "MarkdownDocumentation": "`EnableECSManagedTags`\n\nSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service.\nFor more information, see [Tagging your Amazon ECS\nresources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer\nGuide*.\nWhen you use Amazon ECS managed tags, you must set the `propagateTags`\nrequest 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableecsmanagedtags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableExecuteCommand": { "MarkdownDocumentation": "`EnableExecuteCommand`\n\nDetermines whether the execute command functionality is turned on for the service. If\n`true`, the execute command functionality is turned on for all containers\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableexecutecommand", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PlacementConstraints": { "MarkdownDocumentation": "`PlacementConstraints`\n\nAn array of placement constraint objects to use for tasks in your service. You can specify a maximum\nof 10 constraints for each task. This limit includes constraints in the task definition and those\nspecified at runtime.\n###### Important\nTo remove this property from your service resource, specify an empty `PlacementConstraint` array.\n*Required*: No\n*Type*: Array of [PlacementConstraint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementconstraints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlacementConstraint", "DuplicatesAllowed": true }, "Cluster": { "MarkdownDocumentation": "`Cluster`\n\nThe short name or full Amazon Resource Name (ARN) of the cluster that you run your\nservice on. If you do not specify a cluster, the default cluster is assumed.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-cluster", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancers": { "MarkdownDocumentation": "`LoadBalancers`\n\nA list of load balancer objects to associate with the service. If you specify the\n`Role` property, `LoadBalancers` must be specified as well. For\ninformation 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\nDeveloper Guide*.\n###### Important\nTo remove this property from your service resource, specify an empty `LoadBalancer` array.\n*Required*: No\n*Type*: Array of [LoadBalancer](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-loadbalancers", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LoadBalancer", "DuplicatesAllowed": true }, "ServiceConnectConfiguration": { "MarkdownDocumentation": "`ServiceConnectConfiguration`\n\nThe configuration for this service to discover and connect to services, and be\ndiscovered 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\nnamespace. Tasks can connect to services across all of the clusters in the namespace.\nTasks connect through a managed proxy container that collects logs and metrics for\nincreased visibility. Only the tasks that Amazon ECS services create are supported with\nService Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n*Required*: No\n*Type*: [ServiceConnectConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceconnectconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ServiceConnectConfiguration" }, "DesiredCount": { "MarkdownDocumentation": "`DesiredCount`\n\nThe number of instantiations of the specified task definition to place and keep running\nin your service.\nFor new services, if a desired count is not specified, a default value of `1`\nis used. When using the `DAEMON` scheduling strategy, the desired count is not\nrequired.\nFor existing services, if a desired count is not specified, it is omitted from the\noperation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-desiredcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VpcLatticeConfigurations": { "MarkdownDocumentation": "`VpcLatticeConfigurations`\n\nThe VPC Lattice configuration for the service being created.\n*Required*: No\n*Type*: Array of [VpcLatticeConfiguration](./aws-properties-ecs-service-vpclatticeconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-vpclatticeconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VpcLatticeConfiguration", "DuplicatesAllowed": true }, "DeploymentController": { "MarkdownDocumentation": "`DeploymentController`\n\nThe deployment controller to use for the service.\n*Required*: No\n*Type*: [DeploymentController](./aws-properties-ecs-service-deploymentcontroller.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentcontroller", "UpdateType": "Mutable", "Required": false, "Type": "DeploymentController" }, "Role": { "MarkdownDocumentation": "`Role`\n\nThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to\nmake calls to your load balancer on your behalf. This parameter is only permitted if you\nare using a load balancer with your service and your task definition doesn't use the\n`awsvpc` network mode. If you specify the `role` parameter,\nyou must also specify a load balancer object with the `loadBalancers`\nparameter.\n###### Important\nIf your account has already created the Amazon ECS service-linked role, that role\nis used for your service unless you specify a role here. The service-linked role is\nrequired if your task definition uses the `awsvpc` network mode or if the\nservice is configured to use service discovery, an external deployment controller,\nmultiple target groups, or Elastic Inference accelerators in which case you don't\nspecify a role here. For more information, see [Using\nservice-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic\nContainer Service Developer Guide*.\nIf your specified role has a path other than `/`, then you must either\nspecify the full role ARN (this is recommended) or prefix the role name with the path.\nFor example, if a role with the name `bar` has a path of `/foo/`\nthen you would specify `/foo/bar` as the role name. For more information, see\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-role", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TaskDefinition": { "MarkdownDocumentation": "`TaskDefinition`\n\nThe `family` and `revision` (`family:revision`) or\nfull ARN of the task definition to run in your service. If a `revision` isn't\nspecified, the latest `ACTIVE` revision is used.\nA task definition must be specified if the service uses either the `ECS` or\n`CODE_DEPLOY` deployment controllers.\nFor more information about deployment types, see [Amazon ECS deployment\ntypes](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-taskdefinition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe name of your service. Up to 255 letters (uppercase and lowercase), numbers,\nunderscores, and hyphens are allowed. Service names must be unique within a cluster, but\nyou can have similarly named services in multiple clusters within a Region or across\nmultiple Regions.\n###### Important\nThe stack update fails if you change any properties that require replacement and the\n`ServiceName` is configured. This is because AWS\nCloudFormation creates the replacement service first, but each `ServiceName`\nmust be unique in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-servicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeploymentConfiguration": { "MarkdownDocumentation": "`DeploymentConfiguration`\n\nOptional deployment parameters that control how many tasks run during the deployment\nand the ordering of stopping and starting tasks.\n*Required*: No\n*Type*: [DeploymentConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DeploymentConfiguration" } }, "Attributes": { "ServiceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceArn`\n\nThe ARN that identifies the service. For more information about the ARN format, see\n[Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) in the *Amazon ECS Developer\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#ServiceArn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the Amazon ECS service, such as `sample-webapp`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#Name-fn::getatt" } } }, "AWS::ECS::TaskDefinition": { "MarkdownDocumentation": "`AWS::ECS::TaskDefinition`\n\nRegisters a new task definition from the supplied `family` and\n`containerDefinitions`. Optionally, you can add data volumes to your\ncontainers with the `volumes` parameter. For more information about task\ndefinition parameters and defaults, see [Amazon ECS Task\nDefinitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer\nGuide*.\nYou can specify a role for your task with the `taskRoleArn` parameter. When\nyou specify a role for a task, its containers can then use the latest versions of the\nAWS CLI or SDKs\nto make API requests to the AWS services that are specified in the policy\nthat's associated with the role. For more information, see [IAM Roles for\nTasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer\nGuide*.\nYou can specify a Docker networking mode for the containers in your task definition\nwith the `networkMode` parameter. If you specify the `awsvpc`\nnetwork mode, the task is allocated an elastic network interface, and you must specify a\n[NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) when you create a service or run a task with the task\ndefinition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)\nin the *Amazon Elastic Container Service Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN).\nIn the following example, the `Ref` function returns the ARN of the\n`MyTaskDefinition` task definition, such as\n`arn:aws:ecs:us-west-2:123456789012:task-definition/TaskDefinitionFamily:1`.\n`{ \"Ref\": \"MyTaskDefinition\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html", "Properties": { "TaskRoleArn": { "MarkdownDocumentation": "`TaskRoleArn`\n\nThe short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the\ntask permission to call AWS APIs on your behalf. For more information, see [Amazon ECS\nTask 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`\noption is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\nconfiguration code to use the feature. For more information, see [Windows IAM roles\nfor tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n###### Note\nString validation is done on the ECS side. If an invalid string value is given for `TaskRoleArn`, it\nmay cause the Cloudformation job to hang.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-taskrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IpcMode": { "MarkdownDocumentation": "`IpcMode`\n\nThe IPC resource namespace to use for the containers in the task. The valid values are\n`host`, `task`, or `none`. If `host` is\nspecified, then all containers within the tasks that specified the `host` IPC\nmode on the same container instance share the same IPC resources with the host Amazon\nEC2 instance. If `task` is specified, all containers within the specified\ntask share the same IPC resources. If `none` is specified, then IPC resources\nwithin the containers of a task are private and not shared with other containers in a\ntask or on the container instance. If no value is specified, then the IPC resource\nnamespace sharing depends on the Docker daemon setting on the container instance.\nIf the `host` IPC mode is used, be aware that there is a heightened risk of\nundesired IPC namespace expose.\nIf you are setting namespaced kernel parameters using `systemControls` for\nthe containers in the task, the following will apply to your IPC resource namespace. For\nmore information, see [System\nControls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n* For tasks that use the `host` IPC mode, IPC namespace related\n `systemControls` are not supported.\n* For tasks that use the `task` IPC mode, IPC namespace related\n `systemControls` will apply to all containers within a\n task.\n###### Note\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 | none...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "host", "task", "none" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-ipcmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Memory": { "MarkdownDocumentation": "`Memory`\n\nThe amount (in MiB) of memory used by the task.\nIf your tasks runs on Amazon EC2 instances, you must specify either a task-level\nmemory value or a container-level memory value. This field is optional and any value can\nbe used. If a task-level memory value is specified, the container-level memory value is\noptional. For more information regarding container-level memory and memory reservation,\nsee [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\nfollowing values. The value you choose determines your range of valid values for the\n`cpu` parameter.\n* 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values:\n 256 (.25 vCPU)\n* 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available\n `cpu` values: 512 (.5 vCPU)\n* 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB),\n 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\n `cpu` values: 2048 (2 vCPU)\n* Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available\n `cpu` values: 4096 (4 vCPU)\n* Between 16 GB and 60 GB in 4 GB increments - Available `cpu`\n values: 8192 (8 vCPU)\n \n This option requires Linux platform `1.4.0` or later.\n* Between 32GB and 120 GB in 8 GB increments - Available `cpu`\n values: 16384 (16 vCPU)\n \n This option requires Linux platform `1.4.0` or later.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-memory", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PlacementConstraints": { "MarkdownDocumentation": "`PlacementConstraints`\n\nAn array of placement constraint objects to use for tasks.\n###### Note\nThis parameter isn't supported for tasks run on AWS Fargate.\n*Required*: No\n*Type*: Array of [TaskDefinitionPlacementConstraint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-placementconstraints", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "TaskDefinitionPlacementConstraint", "DuplicatesAllowed": false }, "Cpu": { "MarkdownDocumentation": "`Cpu`\n\nThe number of `cpu` units used by the task. If you use the EC2 launch type,\nthis field is optional. Any value can be used. If you use the Fargate launch type, this\nfield is required. You must use one of the following values. The value that you choose\ndetermines your range of valid values for the `memory` parameter.\nIf you're using the EC2 launch type or the external launch type, this field is\noptional. Supported values are between `128` CPU units (`0.125`\nvCPUs) and `196608` CPU units (`192` vCPUs).\nThis field is required for Fargate. For information about the valid values, see [Task\nsize](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-cpu", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RequiresCompatibilities": { "MarkdownDocumentation": "`RequiresCompatibilities`\n\nThe task launch types the task definition was validated against. The valid values are\n`MANAGED_INSTANCES`, `EC2`, `FARGATE`, and\n`EXTERNAL`. For more information, see [Amazon ECS launch\ntypes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-requirescompatibilities", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "NetworkMode": { "MarkdownDocumentation": "`NetworkMode`\n\nThe Docker networking mode to use for the containers in the task. The valid values are\n`none`, `bridge`, `awsvpc`, and `host`.\nIf no network mode is specified, the default is `bridge`.\nFor Amazon ECS tasks on Fargate, the `awsvpc` network mode is required. For\nAmazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon\nECS tasks on Amazon EC2 Windows instances, `` or\n`awsvpc` can be used. If the network mode is set to `none`,\nyou cannot specify port mappings in your container definitions, and the tasks containers\ndo not have external connectivity. The `host` and `awsvpc` network\nmodes offer the highest networking performance for containers because they use the EC2\nnetwork stack instead of the virtualized network stack provided by the\n`bridge` mode.\nWith the `host` and `awsvpc` network modes, exposed container\nports are mapped directly to the corresponding host port (for the `host`\nnetwork mode) or the attached elastic network interface port (for the\n`awsvpc` network mode), so you cannot take advantage of dynamic host port\nmappings.\n###### Important\nWhen using the `host` network mode, you should not run containers using\nthe 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\ninterface, 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\ntask definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)\nin the *Amazon Elastic Container Service Developer Guide*.\nIf the network mode is `host`, you cannot run multiple instantiations of\nthe same task on a single container instance when port mappings are used.\n*Required*: No\n*Type*: String\n*Allowed values*: `bridge | host | awsvpc | no...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "bridge", "host", "awsvpc", "none" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-networkmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PidMode": { "MarkdownDocumentation": "`PidMode`\n\nThe process namespace to use for the containers in the task. The valid values are\n`host` or `task`. On Fargate for Linux containers, the only\nvalid value is `task`. For example, monitoring sidecars might need\n`pidMode` to access information about other containers running in the\nsame task.\nIf `host` is specified, all containers within the tasks that specified the\n`host` PID mode on the same container instance share the same process\nnamespace with the host Amazon EC2 instance.\nIf `task` is specified, all containers within the specified task share the\nsame process namespace.\nIf no value is specified, the The default is a private namespace for each\ncontainer.\nIf the `host` PID mode is used, there's a heightened risk of undesired\nprocess namespace exposure.\n###### Note\nThis parameter is not supported for Windows containers.\n\n###### Note\nThis parameter is only supported for tasks that are hosted on AWS Fargate if\nthe tasks are using platform version `1.4.0` or later (Linux). This isn't\nsupported for Windows containers on 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)", "RefReturnValue": "", "AllowedValues": [ "host", "task" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-pidmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnableFaultInjection": { "MarkdownDocumentation": "`EnableFaultInjection`\n\nEnables fault injection and allows for fault injection requests to be accepted from\nthe task's containers. The 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-enablefaultinjection", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS\ncontainer agent permission to make AWS API calls on your behalf. For\ninformationabout the required IAM roles for Amazon ECS, see [IAM roles\nfor Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-executionrolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RuntimePlatform": { "MarkdownDocumentation": "`RuntimePlatform`\n\nThe operating system that your tasks definitions run on.\n*Required*: No\n*Type*: [RuntimePlatform](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-runtimeplatform", "UpdateType": "Immutable", "Required": false, "Type": "RuntimePlatform" }, "ProxyConfiguration": { "MarkdownDocumentation": "`ProxyConfiguration`\n\nThe configuration details for the App Mesh proxy.\nYour Amazon ECS container instances require at least version 1.26.0 of the container\nagent and at least version 1.26.0-1 of the `ecs-init` package to use a proxy\nconfiguration. If your container instances are launched from the Amazon ECS optimized\nAMI version `20190301` or later, they contain the required versions of the\ncontainer 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\nService Developer Guide*.\n*Required*: No\n*Type*: [ProxyConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-proxyconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "ProxyConfiguration" }, "Volumes": { "MarkdownDocumentation": "`Volumes`\n\nThe 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\nService Developer Guide*.\n###### Note\nThe `host` and `sourcePath` parameters aren't supported for\ntasks run on AWS Fargate.\n*Required*: No\n*Type*: Array of [Volume](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-volumes", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Volume", "DuplicatesAllowed": false }, "ContainerDefinitions": { "MarkdownDocumentation": "`ContainerDefinitions`\n\nA list of container definitions in JSON format that describe the different containers\nthat make up your task. For more information about container definition parameters and\ndefaults, see [Amazon ECS Task\nDefinitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n*Required*: No\n*Type*: Array of [ContainerDefinition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-containerdefinitions", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ContainerDefinition", "DuplicatesAllowed": false }, "Family": { "MarkdownDocumentation": "`Family`\n\nThe name of a family that this task definition is registered to. Up to 255 letters\n(uppercase and lowercase), numbers, hyphens, and underscores are allowed.\nA family groups multiple versions of a task definition. Amazon ECS gives the first task\ndefinition that you registered to a family a revision number of 1. Amazon ECS gives\nsequential revision numbers to each task definition that you add.\n###### Note\nTo use revision numbers when you update a task definition, specify this property. If\nyou don't specify a value, AWS CloudFormation generates a new task definition each\ntime 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-family", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EphemeralStorage": { "MarkdownDocumentation": "`EphemeralStorage`\n\nThe ephemeral storage settings to use for tasks run with the task definition.\n*Required*: No\n*Type*: [EphemeralStorage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-ephemeralstorage", "UpdateType": "Immutable", "Required": false, "Type": "EphemeralStorage" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to the task definition to help you categorize and organize\nthem. 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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n 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\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with\n this prefix. Tags with this prefix do not count against your tags per resource\n limit.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecs-taskdefinition-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "TaskDefinitionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TaskDefinitionArn`\n\nThe ARN of the task definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#TaskDefinitionArn-fn::getatt" } } }, "AWS::ECS::TaskSet": { "MarkdownDocumentation": "`AWS::ECS::TaskSet`\n\nCreate a task set in the specified cluster and service. This is used when a service\nuses the `EXTERNAL` deployment controller type. For more information, see\n[Amazon ECS deployment\ntypes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer\nGuide*.\n###### Note\nOn March 21, 2024, a change was made to resolve the task definition revision\nbefore authorization. When a task definition revision is not specified,\nauthorization will occur using the latest revision of a task definition.\nFor information about the maximum number of task sets and other quotas, see [Amazon ECS service quotas](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html) in the *Amazon Elastic Container Service\nDeveloper Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html", "Properties": { "PlatformVersion": { "MarkdownDocumentation": "`PlatformVersion`\n\nThe platform version that the tasks in the task set uses. A platform version is\nspecified only for tasks using the Fargate launch type. If one isn't specified, the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-platformversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TaskDefinition": { "MarkdownDocumentation": "`TaskDefinition`\n\nThe task definition for the tasks in the task set to use. If a revision isn't\nspecified, the latest `ACTIVE` revision is used.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-taskdefinition", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ExternalId": { "MarkdownDocumentation": "`ExternalId`\n\nAn optional non-unique tag that identifies this task set in external systems. If the\ntask set is associated with a service discovery registry, the tasks in this task set\nwill have the `ECS_TASK_SET_EXTERNAL_ID`AWS Cloud Map\nattribute 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-externalid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Cluster": { "MarkdownDocumentation": "`Cluster`\n\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the\nservice 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-cluster", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LoadBalancers": { "MarkdownDocumentation": "`LoadBalancers`\n\nA load balancer object representing the load balancer to use with the task set. The\nsupported load balancer types are either an Application Load Balancer or a Network Load\nBalancer.\n*Required*: No\n*Type*: Array of [LoadBalancer](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-loadbalancers", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "LoadBalancer", "DuplicatesAllowed": true }, "Service": { "MarkdownDocumentation": "`Service`\n\nThe short name or full Amazon Resource Name (ARN) of the service to create the task\nset 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-service", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Scale": { "MarkdownDocumentation": "`Scale`\n\nA floating-point percentage of your desired number of tasks to place and keep running\nin the task set.\n*Required*: No\n*Type*: [Scale](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-scale", "UpdateType": "Mutable", "Required": false, "Type": "Scale" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for the task set.\n*Required*: No\n*Type*: [NetworkConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-networkconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "NetworkConfiguration" }, "ServiceRegistries": { "MarkdownDocumentation": "`ServiceRegistries`\n\nThe details of the service discovery registries to assign to this task set. For more\ninformation, see [Service\ndiscovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).\n*Required*: No\n*Type*: Array of [ServiceRegistry](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-serviceregistries", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ServiceRegistry", "DuplicatesAllowed": true }, "CapacityProviderStrategy": { "MarkdownDocumentation": "`CapacityProviderStrategy`\n\nThe capacity provider strategy that are associated with the task set.\n*Required*: No\n*Type*: Array of [CapacityProviderStrategyItem](./aws-properties-ecs-taskset-capacityproviderstrategyitem.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-capacityproviderstrategy", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "CapacityProviderStrategyItem", "DuplicatesAllowed": true }, "LaunchType": { "MarkdownDocumentation": "`LaunchType`\n\nThe launch type that new tasks in the task set uses. For more information, see [Amazon\nECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer\nGuide*.\nIf a `launchType` is specified, the `capacityProviderStrategy`\nparameter must be omitted.\n*Required*: No\n*Type*: String\n*Allowed values*: `EC2 | FARGATE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "EC2", "FARGATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-launchtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to the task set to help you categorize and organize them.\nEach 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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n 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\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with\n this prefix. Tags with this prefix do not count against your tags per resource\n limit.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ecs-taskset-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the task set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#Id-fn::getatt" } } }, "AWS::EFS::AccessPoint": { "MarkdownDocumentation": "`AWS::EFS::AccessPoint`\n\nThe `AWS::EFS::AccessPoint` resource creates an EFS access point.\nAn access point is an application-specific view into an EFS file system that applies an operating system user and\ngroup, and a file system path, to any file system request made through the access point. The operating system\nuser and group override any identity information provided by the NFS client. The file system path is exposed as\nthe access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see\n[Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).\nThis operation requires permissions for the `elasticfilesystem:CreateAccessPoint` action.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the AccessPoint ID. For example:\n`{\"Ref\":\"access_point-logical_id\"}` returns\n`fsap-0123456789abcdef0`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html", "Properties": { "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example `fs-0123456789abcedf2`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-filesystemid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RootDirectory": { "MarkdownDocumentation": "`RootDirectory`\n\nThe directory on the EFS file system that the access point exposes as the root\ndirectory to NFS clients using the access point.\n*Required*: No\n*Type*: [RootDirectory](./aws-properties-efs-accesspoint-rootdirectory.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-rootdirectory", "UpdateType": "Immutable", "Required": false, "Type": "RootDirectory" }, "ClientToken": { "MarkdownDocumentation": "`ClientToken`\n\nThe opaque string specified in the request to ensure idempotent creation.\n*Required*: No\n*Type*: String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-clienttoken", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AccessPointTags": { "MarkdownDocumentation": "`AccessPointTags`\n\nAn 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*: Array of [AccessPointTag](./aws-properties-efs-accesspoint-accesspointtag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-accesspointtags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AccessPointTag", "DuplicatesAllowed": false }, "PosixUser": { "MarkdownDocumentation": "`PosixUser`\n\nThe full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by\nNFS clients using the access point.\n*Required*: No\n*Type*: [PosixUser](./aws-properties-efs-accesspoint-posixuser.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-posixuser", "UpdateType": "Immutable", "Required": false, "Type": "PosixUser" } }, "Attributes": { "AccessPointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccessPointId`\n\nThe ID of the EFS access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#AccessPointId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#Arn-fn::getatt" } } }, "AWS::EFS::FileSystem": { "MarkdownDocumentation": "`AWS::EFS::FileSystem`\n\nThe `AWS::EFS::FileSystem` resource creates a new, empty file system in\nAmazon Elastic File System (Amazon EFS). You must create a mount target\n([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an\nAmazon EC2 or other AWS cloud compute resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the FileSystem ID. For example:\n`{\"Ref\":\"logical_file_system_id\"}`\nreturns `fs-0123456789abcdef2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe ID of the AWS KMS key to be used to protect the encrypted file system. This\nparameter is only required if you want to use a nondefault KMS key. If this parameter is not\nspecified, the default KMS key for Amazon EFS is used. This ID can be in one of the following\nformats:\n* Key ID - A unique identifier of the key, for example\n `1234abcd-12ab-34cd-56ef-1234567890ab`.\n* ARN - An Amazon Resource Name (ARN) for the key, for example\n `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\n `alias/projectKey1`.\n* Key alias ARN - An ARN for a key alias, for example\n `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*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*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PerformanceMode": { "MarkdownDocumentation": "`PerformanceMode`\n\nThe performance mode of the file system. We recommend `generalPurpose`\nperformance mode for all file systems. File systems using the `maxIO` performance\nmode can scale to higher levels of aggregate throughput and operations per second with a\ntradeoff of slightly higher latencies for most file operations. The performance mode\ncan't be changed after the file system has been created. The `maxIO` mode is\nnot supported on One Zone file systems.\n###### Important\nDue to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.\nDefault is `generalPurpose`.\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)", "RefReturnValue": "", "AllowedValues": [ "generalPurpose", "maxIO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-performancemode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nA Boolean value that, if true, creates an encrypted file system. When creating an\nencrypted 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\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-encrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "BypassPolicyLockoutSafetyCheck": { "MarkdownDocumentation": "`BypassPolicyLockoutSafetyCheck`\n\n(Optional) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check. The lockout safety check\ndetermines 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.\nSet `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to prevent\nthe IAM principal that is making the request from making subsequent `PutFileSystemPolicy` requests on this file system.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-bypasspolicylockoutsafetycheck", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FileSystemProtection": { "MarkdownDocumentation": "`FileSystemProtection`\n\nDescribes the protection on the file system.\n*Required*: No\n*Type*: [FileSystemProtection](./aws-properties-efs-filesystem-filesystemprotection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemprotection", "UpdateType": "Mutable", "Required": false, "Type": "FileSystemProtection" }, "LifecyclePolicies": { "MarkdownDocumentation": "`LifecyclePolicies`\n\nAn array of `LifecyclePolicy` objects that define the file system's\n`LifecycleConfiguration` object. A `LifecycleConfiguration` object\ninforms Lifecycle management of the following:\n* When to move files in the file system from primary storage to IA storage.\n* When to move files in the file system from primary storage or IA storage\n to Archive storage.\n* When to move files that are in IA or Archive storage to primary storage.\n###### Note\nAmazon EFS requires that each `LifecyclePolicy` object have only a single transition.\nThis means that in a request body, `LifecyclePolicies` needs to be structured as an array of\n`LifecyclePolicy` objects, one object for each transition, `TransitionToIA`, `TransitionToArchive``TransitionToPrimaryStorageClass`.\nSee the example requests in the following section for more information.\n*Required*: No\n*Type*: Array of [LifecyclePolicy](./aws-properties-efs-filesystem-lifecyclepolicy.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-lifecyclepolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LifecyclePolicy", "DuplicatesAllowed": false }, "ThroughputMode": { "MarkdownDocumentation": "`ThroughputMode`\n\nSpecifies the throughput mode for the file system. The mode can be `bursting`,\n`provisioned`, or `elastic`. If you set `ThroughputMode` to\n`provisioned`, you must also set a value for\n`ProvisionedThroughputInMibps`. After you create the file system, you can\ndecrease your file system's Provisioned throughput or change between the\nthroughput modes, with certain time restrictions. For more information, see [Specifying\nthroughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User\nGuide*.\nDefault is `bursting`.\n*Required*: No\n*Type*: String\n*Allowed values*: `bursting | provisioned | el...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "bursting", "provisioned", "elastic" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-throughputmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FileSystemTags": { "MarkdownDocumentation": "`FileSystemTags`\n\nUse to create one or more tags associated with the file system. Each\ntag is a user-defined key-value pair. Name your file system on creation by including a\n`\"Key\":\"Name\",\"Value\":\"{value}\"` key-value pair. Each key must be unique. For more\ninformation, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\nin the *AWS General Reference Guide*.\n*Required*: No\n*Type*: Array of [ElasticFileSystemTag](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemtags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ElasticFileSystemTag", "DuplicatesAllowed": false }, "ProvisionedThroughputInMibps": { "MarkdownDocumentation": "`ProvisionedThroughputInMibps`\n\nThe throughput, measured in mebibytes per second (MiBps), that you want to provision for a\nfile system that you're creating. Required if `ThroughputMode` is set to\n`provisioned`. Valid values are 1-3414 MiBps, with the upper limit depending on\nRegion. To increase this limit, contact Support. For more information, see [Amazon EFS quotas\nthat you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User\nGuide*.\n*Required*: Conditional\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-provisionedthroughputinmibps", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FileSystemPolicy": { "MarkdownDocumentation": "`FileSystemPolicy`\n\nThe `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.\nFor 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)\nin the *Amazon EFS User Guide*.\n*Required*: No\n*Type*: Json\n*Pattern*: `[\\s\\S]+`\n*Minimum*: `1`\n*Maximum*: `20000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystempolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "AvailabilityZoneName": { "MarkdownDocumentation": "`AvailabilityZoneName`\n\nFor One Zone file systems, specify the AWS\nAvailability Zone in which to create the file system. Use the format `us-east-1a` to\nspecify the Availability Zone. For more information about One Zone file systems, see\n[EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.\n###### Note\nOne Zone file systems are not available in all Availability Zones in AWS Regions where Amazon EFS is available.\n*Required*: No\n*Type*: String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-availabilityzonename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ReplicationConfiguration": { "MarkdownDocumentation": "`ReplicationConfiguration`\n\nDescribes the replication configuration for a specific file system.\n*Required*: No\n*Type*: [ReplicationConfiguration](./aws-properties-efs-filesystem-replicationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-replicationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReplicationConfiguration" }, "BackupPolicy": { "MarkdownDocumentation": "`BackupPolicy`\n\nUse the `BackupPolicy` to turn automatic backups on or off for the file system.\n*Required*: No\n*Type*: [BackupPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-backuppolicy", "UpdateType": "Mutable", "Required": false, "Type": "BackupPolicy" } }, "Attributes": { "FileSystemId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FileSystemId`\n\nThe ID of the EFS file system. For example: `fs-abcdef0123456789a`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#FileSystemId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the EFS file system.\nExample: `arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#Arn-fn::getatt" } } }, "AWS::EFS::MountTarget": { "MarkdownDocumentation": "`AWS::EFS::MountTarget`\n\nThe `AWS::EFS::MountTarget` resource is an Amazon EFS resource that creates a mount target for an EFS\nfile system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the MountTarget ID. For example:\n`{\"Ref\":\"logical_mount_target_id\"}` returns\n`fsmt-0123456789abcdef8`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address type for the mount target. The possible values are `IPV4_ONLY`\n(only IPv4 addresses), `IPV6_ONLY` (only IPv6 addresses), and\n`DUAL_STACK` (dual-stack, both IPv4 and IPv6 addresses). If you don\u2019t specify an\n`IpAddressType`, then `IPV4_ONLY` is used.\n###### Note\nThe `IPAddressType` must match the IP type of the subnet. Additionally, the\n`IPAddressType` parameter overrides the value set as the default IP address for\nthe subnet in the VPC. For example, if the `IPAddressType` is\n`IPV4_ONLY` and `AssignIpv6AddressOnCreation` is `true`,\nthen IPv4 is used for the mount target. For more information, see [Modify the IP\naddressing attributes of your subnet](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-public-ip.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4_ONLY | IPV6_ONLY | DUA...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IPV4_ONLY", "IPV6_ONLY", "DUAL_STACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nVPC security group IDs, of the form `sg-xxxxxxxx`. These must be for the same\nVPC as the subnet specified. The maximum number of security groups depends on account quota.\nFor more information, see [Amazon VPC Quotas](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) in the\n*Amazon VPC User Guide* (see the **Security\nGroups** table). If you don't specify a security group, then Amazon EFS\nuses the default security group for the subnet's VPC.\n*Required*: Yes\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-securitygroups", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe ID of the file system for which to create the mount target.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-filesystemid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IpAddress": { "MarkdownDocumentation": "`IpAddress`\n\nIf the `IpAddressType` for the mount target is IPv4 ( `IPV4_ONLY` or\n`DUAL_STACK`), then specify the IPv4 address to use. If you do not specify an\n`IpAddress`, then Amazon EFS selects an unused IP address from the subnet\nspecified for `SubnetId`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$`\n*Minimum*: `7`\n*Maximum*: `15`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet to add the mount target in. For One Zone file systems, use the subnet\nthat is associated with the file system's Availability Zone. The subnet type must be the same type\nas the `IpAddressType`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^subnet-[0-9a-f]{8,40}$`\n*Minimum*: `15`\n*Maximum*: `47`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Ipv6Address": { "MarkdownDocumentation": "`Ipv6Address`\n\nIf the `IPAddressType` for the mount target is IPv6 (`IPV6_ONLY` or\n`DUAL_STACK`), then specify the IPv6 address to use. If you do not specify an\n`Ipv6Address`, then Amazon EFS selects an unused IP address from the\nsubnet specified for `SubnetId`.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `39`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipv6address", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "IpAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpAddress`\n\nThe IPv4 address of the mount target.\nExample: 192.0.2.0\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#IpAddress-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the Amazon EFS file system that the mount target provides access to.\nExample: `fs-0123456789111222a`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#Id-fn::getatt" } } }, "AWS::EKS::AccessEntry": { "MarkdownDocumentation": "`AWS::EKS::AccessEntry`\n\nCreates an access entry.\nAn access entry allows an IAM principal to access your cluster. Access\nentries can replace the need to maintain entries in the `aws-auth``ConfigMap` for authentication. You have the following options for\nauthorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes\nrole-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you\nto create and manage Kubernetes `Role`, `ClusterRole`,\n`RoleBinding`, and `ClusterRoleBinding` objects, in addition\nto managing access entries. If you use Amazon EKS authorization exclusively, you don't need\nto create and manage Kubernetes `Role`, `ClusterRole`,\n`RoleBinding`, and `ClusterRoleBinding` objects.\nFor more information about access entries, see [Access entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) in the\n*Amazon EKS User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"arn:aws:iam::012345678910:role/my-role\" }`\nFor the access entry `arn:aws:iam::012345678910:role/my-role`,\n`Ref` returns the ARN of the access entry.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the new access entry. Valid values are `STANDARD`,\n`FARGATE_LINUX`, `EC2_LINUX`, `EC2_WINDOWS`,\n`EC2` (for EKS Auto Mode), `HYBRID_LINUX`, and\n`HYPERPOD_LINUX`.\nIf the `principalArn` is for an IAM role that's used for self-managed\nAmazon EC2 nodes, specify `EC2_LINUX` or `EC2_WINDOWS`. Amazon EKS grants\nthe necessary permissions to the node for you. If the `principalArn` is for\nany other purpose, specify `STANDARD`. If you don't specify a value, Amazon EKS\nsets the value to `STANDARD`. If you have the access mode of the cluster set\nto `API_AND_CONFIG_MAP`, it's unnecessary to create access entries for IAM\nroles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries\nin the `aws-auth``ConfigMap` for the roles. You can't change this value once you've created\nthe access entry.\nIf you set the value to `EC2_LINUX` or `EC2_WINDOWS`, you can't\nspecify values for `kubernetesGroups`, or associate an\n`AccessPolicy` to the access entry.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PrincipalArn": { "MarkdownDocumentation": "`PrincipalArn`\n\nThe ARN of the IAM principal for the `AccessEntry`. You can specify one ARN for each access entry. You can't specify the\nsame ARN in more than one access entry. This value can't be changed after access entry\ncreation.\nThe valid principals differ depending on the type of the access entry in the\n`type` field. For `STANDARD` access entries, you can use every\nIAM principal type. For nodes (`EC2` (for EKS Auto Mode),\n`EC2_LINUX`, `EC2_WINDOWS`, `FARGATE_LINUX`, and\n`HYBRID_LINUX`), the only valid ARN is IAM roles.\nYou can't use the STS session principal type with access entries because this is a\ntemporary principal for each session and not a permanent identity that can be assigned\npermissions.\n[IAM best\npractices](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp) recommend using IAM roles with temporary credentials, rather\nthan IAM users with long-term credentials.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-principalarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KubernetesGroups": { "MarkdownDocumentation": "`KubernetesGroups`\n\nThe value for `name` that you've specified for `kind: Group` as\na `subject` in a Kubernetes `RoleBinding` or\n`ClusterRoleBinding` object. Amazon EKS doesn't confirm that the value for\n`name` exists in any bindings on your cluster. You can specify one or\nmore names.\nKubernetes authorizes the `principalArn` of the access entry to access any\ncluster objects that you've specified in a Kubernetes `Role` or\n`ClusterRole` object that is also specified in a binding's\n`roleRef`. For more information about creating Kubernetes\n`RoleBinding`, `ClusterRoleBinding`, `Role`, or\n`ClusterRole` objects, see [Using RBAC\nAuthorization in the Kubernetes documentation](https://kubernetes.io/docs/reference/access-authn-authz/rbac/).\nIf you want Amazon EKS to authorize the `principalArn` (instead of, or in\naddition to Kubernetes authorizing the `principalArn`), you can associate one or\nmore access policies to the access entry using `AssociateAccessPolicy`. If\nyou associate any access policies, the `principalARN` has all permissions\nassigned in the associated access policies and all permissions in any Kubernetes\n`Role` or `ClusterRole` objects that the group names are bound\nto.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-kubernetesgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Username": { "MarkdownDocumentation": "`Username`\n\nThe username to authenticate to Kubernetes with. We recommend not specifying a username and\nletting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies\nfor you, or constraints before specifying your own username, see [Creating\naccess entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries) in the *Amazon EKS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-username", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of your cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccessPolicies": { "MarkdownDocumentation": "`AccessPolicies`\n\nThe access policies to associate to the access entry.\n*Required*: No\n*Type*: Array of [AccessPolicy](./aws-properties-eks-accessentry-accesspolicy.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-accesspolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AccessPolicy", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that assists with categorization and organization.\nEach tag consists of a key and an optional value. You define both. Tags don't\npropagate to any other cluster or AWS resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-eks-accessentry-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "AccessEntryArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccessEntryArn`\n\nThe ARN of the access entry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#AccessEntryArn-fn::getatt" } } }, "AWS::EKS::Addon": { "MarkdownDocumentation": "`AWS::EKS::Addon`\n\nCreates an Amazon EKS add-on.\nAmazon EKS add-ons help to automate the provisioning and lifecycle management of common\noperational software for Amazon EKS clusters. For more information, see [Amazon EKS\nadd-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the *Amazon EKS User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"vpc-cni\" }`\nFor the add-on `vpc-cni`, `Ref` returns the name of the add-on.\nFor example, `cluster-name|vpc-cni`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html", "Properties": { "NamespaceConfig": { "MarkdownDocumentation": "`NamespaceConfig`\n\nThe namespace configuration for the addon. This specifies the Kubernetes namespace where the addon is installed.\n*Required*: No\n*Type*: [NamespaceConfig](./aws-properties-eks-addon-namespaceconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-namespaceconfig", "UpdateType": "Immutable", "Required": false, "Type": "NamespaceConfig" }, "PreserveOnDelete": { "MarkdownDocumentation": "`PreserveOnDelete`\n\nSpecifying this option preserves the add-on software on your cluster but Amazon EKS stops\nmanaging any settings for the add-on. If an IAM account is associated with the add-on,\nit 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-preserveondelete", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AddonVersion": { "MarkdownDocumentation": "`AddonVersion`\n\nThe version of the add-on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-addonversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceAccountRoleArn": { "MarkdownDocumentation": "`ServiceAccountRoleArn`\n\nThe 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\npermissions 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*.\n###### Note\nTo specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\nyour cluster. For more information, see [Enabling\nIAM roles for service accounts on your cluster](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) in the\n*Amazon EKS User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-serviceaccountrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of your cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AddonName": { "MarkdownDocumentation": "`AddonName`\n\nThe name of the add-on.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-addonname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PodIdentityAssociations": { "MarkdownDocumentation": "`PodIdentityAssociations`\n\nAn array of EKS Pod Identity associations owned by the add-on. Each association maps a role to a service\naccount in a namespace in the cluster.\nFor more information, see [Attach an IAM Role to an Amazon EKS add-on\nusing EKS Pod Identity](https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html) in the *Amazon EKS User Guide*.\n*Required*: No\n*Type*: Array of [PodIdentityAssociation](./aws-properties-eks-addon-podidentityassociation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-podidentityassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PodIdentityAssociation", "DuplicatesAllowed": false }, "ResolveConflicts": { "MarkdownDocumentation": "`ResolveConflicts`\n\nHow to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based\non the value you choose:\n* **None** \u2013 If the self-managed version of\n the add-on is installed on your cluster, Amazon EKS doesn't change the value.\n Creation of the add-on might fail.\n* **Overwrite** \u2013 If the self-managed\n version of the add-on is installed on your cluster and the Amazon EKS default value\n is different than the existing value, Amazon EKS changes the value to the Amazon EKS\n default value.\n* **Preserve** \u2013 This is similar to the NONE\n option. If the self-managed version of the add-on is installed on your cluster\n Amazon EKS doesn't change the add-on resource properties. Creation of the add-on\n might fail if conflicts are detected. This option works differently during the\n update operation. 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\ncluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values,\nregardless of the option that you specify.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | OVERWRITE | PRESERVE...`\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)", "RefReturnValue": "", "AllowedValues": [ "NONE", "OVERWRITE", "PRESERVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-resolveconflicts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to the add-on to assist with categorization and\norganization. Each tag consists of a key and an optional value, both of which you\ndefine. Add-on tags do not propagate to any other resources associated with the\ncluster.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-eks-addon-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "ConfigurationValues": { "MarkdownDocumentation": "`ConfigurationValues`\n\nThe configuration values that you provided.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-configurationvalues", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the add-on, such as\n`arn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#Arn-fn::getatt" } } }, "AWS::EKS::Capability": { "MarkdownDocumentation": "`AWS::EKS::Capability`\n\nAn object representing a managed capability in an Amazon EKS cluster. This includes all configuration, status, and health information for the capability.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of capability. Valid values are `ACK`, `ARGOCD`, or `KRO`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ARGOCD | ACK | KRO...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ARGOCD", "ACK", "KRO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration settings for the capability. The structure varies depending on the capability type.\n*Required*: No\n*Type*: [CapabilityConfiguration](./aws-properties-eks-capability-capabilityconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-configuration", "UpdateType": "Mutable", "Required": false, "Type": "CapabilityConfiguration" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the Amazon EKS cluster that contains this capability.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeletePropagationPolicy": { "MarkdownDocumentation": "`DeletePropagationPolicy`\n\nThe delete propagation policy for the capability. Currently, the only supported value is `RETAIN`, which keeps all resources managed by the capability when the capability is deleted.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RETAIN`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "RETAIN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-deletepropagationpolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CapabilityName": { "MarkdownDocumentation": "`CapabilityName`\n\nThe unique name of the capability within the cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-capabilityname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z-]*:iam::[0-9]+:role/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-eks-capability-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the capability. Valid values include:\n* `CREATING` \u2013 The capability is being created.\n* `ACTIVE` \u2013 The capability is running and available.\n* `UPDATING` \u2013 The capability is being updated.\n* `DELETING` \u2013 The capability is being deleted.\n* `CREATE_FAILED` \u2013 The capability creation failed.\n* `UPDATE_FAILED` \u2013 The capability update failed.\n* `DELETE_FAILED` \u2013 The capability deletion failed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#Status-fn::getatt" }, "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe Unix epoch timestamp in seconds for when the capability was last modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#ModifiedAt-fn::getatt" }, "Configuration.ArgoCd.ServerUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`Configuration.ArgoCd.ServerUrl`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#Configuration.ArgoCd.ServerUrl-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version of the capability software that is currently running.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#Version-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe Unix epoch timestamp in seconds for when the capability was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#CreatedAt-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the capability.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#Arn-fn::getatt" }, "Configuration.ArgoCd.AwsIdc.IdcManagedApplicationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Configuration.ArgoCd.AwsIdc.IdcManagedApplicationArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#Configuration.ArgoCd.AwsIdc.IdcManagedApplicationArn-fn::getatt" } } }, "AWS::EKS::Cluster": { "MarkdownDocumentation": "`AWS::EKS::Cluster`\n\nCreates an Amazon EKS control plane.\nThe Amazon EKS control plane consists of control plane instances that run the Kubernetes\nsoftware, such as `etcd` and the API server. The control plane runs in an\naccount managed by AWS, and the Kubernetes API is exposed by the Amazon EKS API server endpoint.\nEach Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of\nAmazon EC2 instances.\nThe cluster control plane is provisioned across multiple Availability Zones and fronted by an ELB\nNetwork Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide\nconnectivity from the control plane instances to the nodes (for example, to support\n`kubectl exec`, `logs`, and `proxy` data\nflows).\nAmazon EKS nodes run in your AWS account and connect to your cluster's control plane over\nthe Kubernetes API server endpoint and a certificate file that is created for your\ncluster.\nYou can use the `endpointPublicAccess` and\n`endpointPrivateAccess` parameters to enable or disable public and\nprivate access to your cluster's Kubernetes API server endpoint. By default, public access is\nenabled, and private access is disabled. The\nendpoint domain name and IP address family depends on the value of the\n`ipFamily` for the cluster. For more information, see [Amazon EKS Cluster\nEndpoint Access Control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the **Amazon EKS User Guide**.\nYou can use the `logging` parameter to enable or disable exporting the\nKubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane\nlogs aren't exported to CloudWatch Logs. For more information, see [Amazon EKS\nCluster Control Plane Logs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the\n**Amazon EKS User Guide**.\n###### Note\nCloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\ncontrol plane logs. For more information, see [CloudWatch Pricing](https://aws.amazon.com/cloudwatch/pricing/).\nIn most cases, it takes several minutes to create a cluster. After you create an Amazon EKS\ncluster, you must configure your Kubernetes tooling to communicate with the API server and\nlaunch nodes into your cluster. For more information, see [Allowing users to\naccess your cluster](https://docs.aws.amazon.com/eks/latest/userguide/cluster-auth.html) and [Launching Amazon EKS\nnodes](https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the *Amazon EKS User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myCluster\" }`\nFor the Amazon EKS cluster `myCluster`, `Ref` returns\nthe name of the cluster.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html", "Properties": { "Logging": { "MarkdownDocumentation": "`Logging`\n\nThe logging configuration for your cluster.\n*Required*: No\n*Type*: [Logging](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-logging", "UpdateType": "Mutable", "Required": false, "Type": "Logging" }, "ComputeConfig": { "MarkdownDocumentation": "`ComputeConfig`\n\nIndicates the current configuration of the compute capability on your EKS Auto Mode\ncluster. For example, if the capability is enabled or disabled. If the compute\ncapability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in\nyour AWS account. For more information, see EKS Auto Mode compute capability in the\n*Amazon EKS User Guide*.\n*Required*: No\n*Type*: [ComputeConfig](./aws-properties-eks-cluster-computeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-computeconfig", "UpdateType": "Mutable", "Required": false, "Type": "ComputeConfig" }, "Force": { "MarkdownDocumentation": "`Force`\n\nSet this value to `true` to override upgrade-blocking readiness checks when\nupdating a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-force", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "StorageConfig": { "MarkdownDocumentation": "`StorageConfig`\n\nIndicates the current configuration of the block storage capability on your EKS Auto\nMode cluster. For example, if the capability is enabled or disabled. If the block\nstorage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your\nAWS account. For more information, see EKS Auto Mode block storage capability in the\n*Amazon EKS User Guide*.\n*Required*: No\n*Type*: [StorageConfig](./aws-properties-eks-cluster-storageconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-storageconfig", "UpdateType": "Mutable", "Required": false, "Type": "StorageConfig" }, "BootstrapSelfManagedAddons": { "MarkdownDocumentation": "`BootstrapSelfManagedAddons`\n\nIf you set this value to `False` when creating a cluster, the default\nnetworking add-ons will not be installed.\nThe default networking add-ons include `vpc-cni`, `coredns`, and\n`kube-proxy`.\nUse this option when you plan to install third-party alternative add-ons or\nself-manage the default networking add-ons.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-bootstrapselfmanagedaddons", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DeletionProtection": { "MarkdownDocumentation": "`DeletionProtection`\n\nThe current deletion protection setting for the cluster. When `true`,\ndeletion protection is enabled and the cluster cannot be deleted until protection is\ndisabled. When `false`, the cluster can be deleted normally. This setting\nonly applies to clusters in an active state.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-deletionprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ZonalShiftConfig": { "MarkdownDocumentation": "`ZonalShiftConfig`\n\nThe configuration for zonal shift for the cluster.\n*Required*: No\n*Type*: [ZonalShiftConfig](./aws-properties-eks-cluster-zonalshiftconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-zonalshiftconfig", "UpdateType": "Mutable", "Required": false, "Type": "ZonalShiftConfig" }, "AccessConfig": { "MarkdownDocumentation": "`AccessConfig`\n\nThe access configuration for the cluster.\n*Required*: No\n*Type*: [AccessConfig](./aws-properties-eks-cluster-accessconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-accessconfig", "UpdateType": "Mutable", "Required": false, "Type": "AccessConfig" }, "EncryptionConfig": { "MarkdownDocumentation": "`EncryptionConfig`\n\nThe encryption configuration for the cluster.\n*Required*: No\n*Type*: [Array](./aws-properties-eks-cluster-encryptionconfig.html) of [EncryptionConfig](./aws-properties-eks-cluster-encryptionconfig.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-encryptionconfig", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "EncryptionConfig", "DuplicatesAllowed": true }, "KubernetesNetworkConfig": { "MarkdownDocumentation": "`KubernetesNetworkConfig`\n\nThe Kubernetes network configuration for the cluster.\n*Required*: No\n*Type*: [KubernetesNetworkConfig](./aws-properties-eks-cluster-kubernetesnetworkconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-kubernetesnetworkconfig", "UpdateType": "Mutable", "Required": false, "Type": "KubernetesNetworkConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane\nto make calls to AWS API operations on your behalf. For more information, see [Amazon EKS Service\nIAM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive) and\nhyphens. It must start with an alphanumeric character and can't be longer than 100 characters.\nThe name must be unique within the AWS Region and AWS account that you're creating the cluster in. Note that underscores can't be used in CloudFormation.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z][A-Za-z0-9\\-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UpgradePolicy": { "MarkdownDocumentation": "`UpgradePolicy`\n\nThis value indicates if extended support is enabled or disabled for the\ncluster.\n[Learn more about EKS Extended Support in the *Amazon EKS User Guide*.](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html)\n*Required*: No\n*Type*: [UpgradePolicy](./aws-properties-eks-cluster-upgradepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-upgradepolicy", "UpdateType": "Mutable", "Required": false, "Type": "UpgradePolicy" }, "RemoteNetworkConfig": { "MarkdownDocumentation": "`RemoteNetworkConfig`\n\nThe configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this\nconfiguration after the cluster is created.\n*Required*: No\n*Type*: [RemoteNetworkConfig](./aws-properties-eks-cluster-remotenetworkconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-remotenetworkconfig", "UpdateType": "Mutable", "Required": false, "Type": "RemoteNetworkConfig" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe desired Kubernetes version for your cluster. If you don't specify a value here, the\ndefault version available in Amazon EKS is used.\n###### Note\nThe default version might not be the latest version available.\n*Required*: No\n*Type*: String\n*Pattern*: `1\\.\\d\\d`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ControlPlaneScalingConfig": { "MarkdownDocumentation": "`ControlPlaneScalingConfig`\n\nThe control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.\n*Required*: No\n*Type*: [ControlPlaneScalingConfig](./aws-properties-eks-cluster-controlplanescalingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-controlplanescalingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ControlPlaneScalingConfig" }, "OutpostConfig": { "MarkdownDocumentation": "`OutpostConfig`\n\nAn object representing the configuration of your local Amazon EKS cluster on an AWS\nOutpost. This object isn't available for clusters on the AWS cloud.\n*Required*: No\n*Type*: [OutpostConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-outpostconfig", "UpdateType": "Immutable", "Required": false, "Type": "OutpostConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata that you apply to the cluster to assist with categorization and\norganization. Each tag consists of a key and an optional value, both of which you\ndefine. Cluster tags don't propagate to any other resources associated with the\ncluster.\n###### Note\nYou must have the `eks:TagResource` and `eks:UntagResource`\npermissions for your [IAM\nprincipal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CloudFormation stack. If you don't have\nthese permissions, there might be unexpected behavior with stack-level tags\npropagating to the resource during resource creation and update.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-eks-cluster-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "ResourcesVpcConfig": { "MarkdownDocumentation": "`ResourcesVpcConfig`\n\nThe VPC configuration that's used by the cluster control plane. Amazon EKS VPC\nresources have specific requirements to work properly with Kubernetes. For more\ninformation, see [Cluster VPC Considerations](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and\n[Cluster\nSecurity Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the *Amazon EKS User\nGuide*. You must specify at least two subnets. You can specify up to five\nsecurity groups, but we recommend that you use a dedicated security group for your\ncluster control plane.\n*Required*: Yes\n*Type*: [ResourcesVpcConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-resourcesvpcconfig", "UpdateType": "Mutable", "Required": true, "Type": "ResourcesVpcConfig" } }, "Attributes": { "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint for your Kubernetes API server, such as\n`https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#Endpoint-fn::getatt" }, "ClusterSecurityGroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterSecurityGroupId`\n\nThe cluster security group that was created by Amazon EKS for the cluster.\nManaged node groups use this security group for control plane to data plane\ncommunication.\nThis parameter is only returned by Amazon EKS clusters that support managed\nnode groups. For more information, see [Managed node groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) in\nthe *Amazon EKS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#ClusterSecurityGroupId-fn::getatt" }, "EncryptionConfigKeyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EncryptionConfigKeyArn`\n\nAmazon Resource Name (ARN) or alias of the customer master key (CMK).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#EncryptionConfigKeyArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of your local Amazon EKS cluster on an AWS Outpost. This property isn't available\nfor an Amazon EKS cluster on the AWS cloud.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#Id-fn::getatt" }, "CertificateAuthorityData": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateAuthorityData`\n\nThe `certificate-authority-data` for your cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#CertificateAuthorityData-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the cluster, such as\n`arn:aws:eks:us-west-2:666666666666:cluster/prod`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#Arn-fn::getatt" }, "KubernetesNetworkConfig.ServiceIpv6Cidr": { "PrimitiveType": "String", "MarkdownDocumentation": "`KubernetesNetworkConfig.ServiceIpv6Cidr`\n\nThe CIDR block that Kubernetes Service IP addresses are assigned from if you created a\n`1.21` or later cluster with version `>1.10.1` or later of the Amazon VPC CNI add-on and\nspecified `ipv6` for **ipFamily** when you\ncreated the cluster. Kubernetes assigns Service addresses from the unique local address\nrange (`fc00::/7`) because you can't specify a custom `IPv6` CIDR block when\nyou create the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#KubernetesNetworkConfig.ServiceIpv6Cidr-fn::getatt" }, "OpenIdConnectIssuerUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`OpenIdConnectIssuerUrl`\n\nThe issuer URL for the OIDC identity provider of the cluster, such as\n`https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E`.\nIf you need to remove `https://` from this output value, you can include the\nfollowing code in your template.\n`!Select [1, !Split [\"//\", !GetAtt\nEKSCluster.OpenIdConnectIssuerUrl]]`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#OpenIdConnectIssuerUrl-fn::getatt" } } }, "AWS::EKS::FargateProfile": { "MarkdownDocumentation": "`AWS::EKS::FargateProfile`\n\nCreates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one\nFargate profile in a cluster to be able to run pods on Fargate.\nThe Fargate profile allows an administrator to declare which pods run on Fargate\nand specify which pods run on which Fargate profile. This declaration is done through\nthe profile's selectors. Each profile can have up to five selectors that contain a\nnamespace and labels. A namespace is required for every selector. The label field\nconsists of multiple optional key-value pairs. Pods that match the selectors are\nscheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the\nFargate profile, then that pod is run on Fargate.\nWhen you create a Fargate profile, you must specify a pod execution role to use with\nthe pods that are scheduled with the profile. This role is added to the cluster's Kubernetes\n[Role\nBased Access Control](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC) for authorization so that the\n`kubelet` that is running on the Fargate infrastructure can register\nwith your Amazon EKS cluster so that it can appear in your cluster as a node. The pod\nexecution role also provides IAM permissions to the Fargate infrastructure to allow\nread access to Amazon ECR image repositories. For more information, see [Pod\nExecution Role](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in the *Amazon EKS User Guide*.\nFargate profiles are immutable. However, you can create a new updated profile to\nreplace an existing profile and then delete the original after the updated profile has\nfinished creating.\nIf any Fargate profiles in a cluster are in the `DELETING` status, you\nmust wait for that Fargate profile to finish deleting before you can create any other\nprofiles in that cluster.\nFor more information, see [AWS Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html) in the *Amazon EKS User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myFargateProfile\" }`\nFor the Fargate profile`myFargateProfile`, Ref returns the\nphysical resource ID of the Fargate profile. For example,\n`/`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html", "Properties": { "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe IDs of subnets to launch a `Pod` into. A `Pod` running on\nFargate isn't assigned a public IP address, so only private subnets (with no direct\nroute to an Internet Gateway) are accepted for this parameter.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html#cfn-eks-fargateprofile-subnets", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "FargateProfileName": { "MarkdownDocumentation": "`FargateProfileName`\n\nThe name of the Fargate profile.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html#cfn-eks-fargateprofile-fargateprofilename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of your cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html#cfn-eks-fargateprofile-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PodExecutionRoleArn": { "MarkdownDocumentation": "`PodExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the `Pod` execution role to use for a `Pod`\nthat matches the selectors in the Fargate profile. The `Pod` execution role\nallows Fargate infrastructure to register with your cluster as a node, and it provides\nread access to Amazon ECR image repositories. For more information, see [`Pod` execution role](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in the *Amazon EKS User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html#cfn-eks-fargateprofile-podexecutionrolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Selectors": { "MarkdownDocumentation": "`Selectors`\n\nThe selectors to match for a `Pod` to use this Fargate profile. Each\nselector must have an associated Kubernetes `namespace`. Optionally, you can also\nspecify `labels` for a `namespace`. You may specify up to five\nselectors in a Fargate profile.\n*Required*: Yes\n*Type*: Array of [Selector](./aws-properties-eks-fargateprofile-selector.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html#cfn-eks-fargateprofile-selectors", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "Selector", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that assists with categorization and organization.\nEach tag consists of a key and an optional value. You define both. Tags don't\npropagate to any other cluster or AWS resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-eks-fargateprofile-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html#cfn-eks-fargateprofile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the cluster, such as\n`arn:aws:eks:us-west-2:666666666666:fargateprofile/myCluster/myFargateProfile/1cb1a11a-1dc1-1d11-cf11-1111f11fa111`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html#Arn-fn::getatt" } } }, "AWS::EKS::IdentityProviderConfig": { "MarkdownDocumentation": "`AWS::EKS::IdentityProviderConfig`\n\nAssociates an identity provider configuration to a cluster.\nIf you want to authenticate identities using an identity provider, you can create an\nidentity provider configuration and associate it to your cluster. After configuring\nauthentication to your cluster you can create Kubernetes `Role` and\n`ClusterRole` objects, assign permissions to them, and then bind them to\nthe identities using Kubernetes `RoleBinding` and `ClusterRoleBinding`\nobjects. For more information see [Using RBAC\nAuthorization](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) in the Kubernetes documentation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myIdentityProviderConfig\" }`\nFor the IdentityProviderConfig, Ref returns the physical resource ID of the config.\nFor example, `cluster-name/oidc/identity-provider-config-name`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the identity provider configuration. The only type available is\n`oidc`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `oidc`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "oidc" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IdentityProviderConfigName": { "MarkdownDocumentation": "`IdentityProviderConfigName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-identityproviderconfigname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Oidc": { "MarkdownDocumentation": "`Oidc`\n\nAn object representing an OpenID Connect (OIDC) identity provider configuration.\n*Required*: No\n*Type*: [OidcIdentityProviderConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-oidc", "UpdateType": "Immutable", "Required": false, "Type": "OidcIdentityProviderConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that assists with categorization and organization.\nEach tag consists of a key and an optional value. You define both. Tags don't\npropagate to any other cluster or AWS resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-eks-identityproviderconfig-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "IdentityProviderConfigArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdentityProviderConfigArn`\n\nThe Amazon Resource Name (ARN) associated with the identity provider config.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#IdentityProviderConfigArn-fn::getatt" } } }, "AWS::EKS::Nodegroup": { "MarkdownDocumentation": "`AWS::EKS::Nodegroup`\n\nCreates a managed node group for an Amazon EKS cluster.\nYou can only create a node group for your cluster that is equal to the current Kubernetes\nversion for the cluster. All node groups are created with the latest AMI release version\nfor the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI\nusing a launch template.\nFor later updates, you will only be able to update a node group using a launch\ntemplate only if it was originally deployed with a launch template. Additionally, the\nlaunch template ID or name must match what was used when the node group was created. You\ncan update the launch template version with necessary changes. For more information\nabout using launch templates, see [Customizing managed nodes with\nlaunch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html).\nAn Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that\nare managed by AWS for an Amazon EKS cluster. For more information, see [Managed\nnode groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) in the *Amazon EKS User Guide*.\n###### Note\nWindows AMI types are only supported for commercial AWS Regions that support\nWindows on Amazon EKS.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myNodegroup\" }`\nFor the Amazon EKS node group `myNodegroup`, Ref returns the\nphysical resource ID of the node group. For example,\n`cluster-name/nodegroup_name`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html", "Properties": { "UpdateConfig": { "MarkdownDocumentation": "`UpdateConfig`\n\nThe node group update configuration.\n*Required*: No\n*Type*: [UpdateConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-updateconfig", "UpdateType": "Mutable", "Required": false, "Type": "UpdateConfig" }, "ScalingConfig": { "MarkdownDocumentation": "`ScalingConfig`\n\nThe scaling configuration details for the Auto Scaling group that is created for your\nnode group.\n*Required*: No\n*Type*: [ScalingConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-scalingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ScalingConfig" }, "Labels": { "MarkdownDocumentation": "`Labels`\n\nThe Kubernetes `labels` applied to the nodes in the node group.\n###### Note\nOnly `labels` that are applied with the Amazon EKS API are shown here. There\nmay be other Kubernetes `labels` applied to the nodes in this group.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-labels", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Taints": { "MarkdownDocumentation": "`Taints`\n\nThe Kubernetes taints to be applied to the nodes in the node group when they are created.\nEffect is one of `No_Schedule`, `Prefer_No_Schedule`, or\n`No_Execute`. Kubernetes taints can be used together with tolerations to\ncontrol 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*: Array of [Taint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-taints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Taint", "DuplicatesAllowed": true }, "CapacityType": { "MarkdownDocumentation": "`CapacityType`\n\nThe capacity type of your managed node group.\n*Required*: No\n*Type*: String\n*Allowed values*: `ON_DEMAND | SPOT | CAPACITY...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ON_DEMAND", "SPOT", "CAPACITY_BLOCK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-capacitytype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ReleaseVersion": { "MarkdownDocumentation": "`ReleaseVersion`\n\nThe AMI version of the Amazon EKS optimized AMI to use with your node group\n(for example, `1.14.7-YYYYMMDD`). By default, the latest\navailable AMI version for the node group's current Kubernetes version is used. For more\ninformation, see [Amazon EKS optimized\nLinux AMI Versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) in the *Amazon EKS User\nGuide*.\n###### Note\nChanging this value triggers an update of the node group if one is available. You\ncan't update other properties at the same time as updating `Release\nVersion`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-releaseversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NodeRepairConfig": { "MarkdownDocumentation": "`NodeRepairConfig`\n\nThe node auto repair configuration for the node group.\n*Required*: No\n*Type*: [NodeRepairConfig](./aws-properties-eks-nodegroup-noderepairconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-noderepairconfig", "UpdateType": "Mutable", "Required": false, "Type": "NodeRepairConfig" }, "NodegroupName": { "MarkdownDocumentation": "`NodegroupName`\n\nThe unique name to give your node group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-nodegroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NodeRole": { "MarkdownDocumentation": "`NodeRole`\n\nThe Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker\nnode `kubelet` daemon makes calls to AWS APIs on your behalf. Nodes receive\npermissions for these API calls through an IAM instance profile and associated\npolicies. Before you can launch nodes and register them into a cluster, you must create\nan IAM role for those nodes to use when they are launched. For more information, see\n[Amazon EKS\nnode IAM role](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the **Amazon EKS User Guide**.\nIf you specify `launchTemplate`, then don't specify `[IamInstanceProfile](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html)` in your launch template, or the node group\ndeployment will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-noderole", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe subnets to use for the Auto Scaling group that is created for your node group.\nIf you specify `launchTemplate`, then don't specify `[SubnetId](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html)` in your launch template, or the node group deployment\nwill fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-subnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AmiType": { "MarkdownDocumentation": "`AmiType`\n\nThe AMI type for your node group. If you specify `launchTemplate`, and your launch template uses a custom AMI,\nthen don't specify `amiType`, or the node group deployment\nwill fail. If your launch template uses a Windows custom AMI, then add\n`eks:kube-proxy-windows` to your Windows nodes `rolearn` in\nthe `aws-auth``ConfigMap`. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](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_x86_64 | AL2_x86_64_GPU...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AL2_x86_64", "AL2_x86_64_GPU", "AL2_ARM_64", "CUSTOM", "BOTTLEROCKET_ARM_64", "BOTTLEROCKET_x86_64", "BOTTLEROCKET_ARM_64_FIPS", "BOTTLEROCKET_x86_64_FIPS", "BOTTLEROCKET_ARM_64_NVIDIA", "BOTTLEROCKET_x86_64_NVIDIA", "WINDOWS_CORE_2019_x86_64", "WINDOWS_FULL_2019_x86_64", "WINDOWS_CORE_2022_x86_64", "WINDOWS_FULL_2022_x86_64", "AL2023_x86_64_STANDARD", "AL2023_ARM_64_STANDARD", "AL2023_x86_64_NEURON", "AL2023_x86_64_NVIDIA", "AL2023_ARM_64_NVIDIA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-amitype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ForceUpdateEnabled": { "MarkdownDocumentation": "`ForceUpdateEnabled`\n\nForce the update if any `Pod` on the existing node group can't be drained\ndue to a `Pod` disruption budget issue. If an update fails because all Pods\ncan't be drained, you can force the update after it fails to terminate the old node\nwhether or not any `Pod` is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-forceupdateenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe Kubernetes version to use for your managed nodes. By default, the Kubernetes\nversion of the cluster is used, and this is the only accepted specified value. If you\nspecify `launchTemplate`, and your launch template uses a custom AMI, then\ndon't specify `version`, or the node group deployment will fail. For more\ninformation about using launch templates with Amazon EKS, see [Launch\ntemplate support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*.\n###### Note\nYou can't update other properties at the same time as updating\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LaunchTemplate": { "MarkdownDocumentation": "`LaunchTemplate`\n\nAn object representing a node group's launch template specification. When using this\nobject, don't directly specify `instanceTypes`, `diskSize`, or\n`remoteAccess`. You cannot later specify a different launch template ID\nor name than what was used to create the node group.\nMake sure that the launch template meets the requirements in\n`launchTemplateSpecification`. Also refer to [Customizing managed nodes with\nlaunch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*.\n*Required*: No\n*Type*: [LaunchTemplateSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-launchtemplate", "UpdateType": "Mutable", "Required": false, "Type": "LaunchTemplateSpecification" }, "RemoteAccess": { "MarkdownDocumentation": "`RemoteAccess`\n\nThe remote access configuration to use with your node group. For Linux, the protocol\nis SSH. For Windows, the protocol is RDP. If you specify `launchTemplate`, then don't specify\n`remoteAccess`, or the node group deployment will fail.\nFor more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*.\n*Required*: No\n*Type*: [RemoteAccess](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-remoteaccess", "UpdateType": "Immutable", "Required": false, "Type": "RemoteAccess" }, "DiskSize": { "MarkdownDocumentation": "`DiskSize`\n\nThe root device disk size (in GiB) for your node group instances. The default disk\nsize is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows.\nIf you specify `launchTemplate`, then don't specify `diskSize`, or the node group\ndeployment will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-disksize", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of your cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceTypes": { "MarkdownDocumentation": "`InstanceTypes`\n\nSpecify the instance types for a node group. If you specify a GPU instance type, make\nsure to also specify an applicable GPU AMI type with the `amiType` parameter.\nIf you specify `launchTemplate`, then you can specify zero or one instance\ntype in your launch template *or* you can specify 0-20 instance types\nfor `instanceTypes`. If however, you specify an instance type in your launch\ntemplate *and* specify any `instanceTypes`, the node group\ndeployment will fail. If you don't specify an instance type in a launch template or for\n`instanceTypes`, then `t3.medium` is used, by default. If you\nspecify `Spot` for `capacityType`, then we recommend specifying\nmultiple 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 [Customizing managed nodes with\nlaunch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that assists with categorization and organization.\nEach tag consists of a key and an optional value. You define both. Tags don't\npropagate to any other cluster or AWS resources.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "NodegroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`NodegroupName`\n\nThe name associated with an Amazon EKS managed node group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#NodegroupName-fn::getatt" }, "ClusterName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterName`\n\nThe name of your cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#ClusterName-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) associated with the managed node group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#Arn-fn::getatt" } } }, "AWS::EKS::PodIdentityAssociation": { "MarkdownDocumentation": "`AWS::EKS::PodIdentityAssociation`\n\nAmazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myAssociation\" }`\nFor the Amazon EKS Pod Identity association `myAssociation`, Ref returns the\nphysical resource ID of the association. For example,\n`a-abcdefghijklmnop1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html", "Properties": { "ServiceAccount": { "MarkdownDocumentation": "`ServiceAccount`\n\nThe name of the Kubernetes service account inside the cluster to associate the IAM\ncredentials 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-serviceaccount", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetRoleArn": { "MarkdownDocumentation": "`TargetRoleArn`\n\nThe Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This\nrole is assumed by using the EKS Pod Identity association role, then the credentials for this\nrole are injected into the Pod.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-targetrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the cluster that the association is in.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DisableSessionTags": { "MarkdownDocumentation": "`DisableSessionTags`\n\nThe state of the automatic sessions tags. The value of *true*\ndisables these tags.\nEKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You\ncan use these tags to author a single role that can work across resources by allowing\naccess to AWS resources based on matching tags. By default, EKS Pod Identity attaches\nsix tags, including tags for cluster name, namespace, and service account name. For the\nlist of tags added by EKS Pod Identity, see [List of session tags\nadded by EKS Pod Identity](https://docs.aws.amazon.com/eks/latest/userguide/pod-id-abac.html#pod-id-abac-tags) in the *Amazon EKS User Guide*.\n*Required*: No\n*Type*: Boolean\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-disablesessiontags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity\nagent manages credentials to assume this role for applications in the containers in the\nPods that use this service 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe name of the Kubernetes namespace inside the cluster to create the association in. The\nservice account and the Pods that use the service account must be in this\nnamespace.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-namespace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that assists with categorization and organization.\nEach tag consists of a key and an optional value. You define both. Tags don't\npropagate to any other cluster or AWS resources.\nThe following basic restrictions apply to tags:\n* Maximum number of tags per resource \u2013 50\n* For each resource, each tag key must be unique, and each tag key can have only\n one value.\n* Maximum key length \u2013 128 Unicode characters in UTF-8\n* Maximum value length \u2013 256 Unicode characters in UTF-8\n* If your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n 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\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-eks-podidentityassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "AssociationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationArn`\n\nThe Amazon Resource Name (ARN) of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#AssociationArn-fn::getatt" }, "ExternalId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ExternalId`\n\nThe unique identifier for this EKS Pod Identity association for a target IAM role. You put this value\nin the trust policy of the target role, in a `Condition` to match the\n`sts.ExternalId`. This ensures that the target role can only be assumed\nby this association. This prevents the *confused deputy problem*. For\nmore information about the confused deputy problem, see [The confused deputy\nproblem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) in the *IAM User Guide*.\nIf you want to use the same target role with multiple associations or\nother roles, use independent statements in the trust policy to allow\n`sts:AssumeRole` access from each role.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#ExternalId-fn::getatt" }, "AssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationId`\n\nThe ID of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#AssociationId-fn::getatt" } } }, "AWS::EMR::Cluster": { "Attributes": { "MasterPublicDNS": { "PrimitiveType": "String", "MarkdownDocumentation": "`MasterPublicDNS`\n\nThe public DNS name of the master node (instance), such as `ec2-12-123-123-123.us-west-2.compute.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#MasterPublicDNS-fn::getatt" } }, "MarkdownDocumentation": "`AWS::EMR::Cluster`\n\nThe `AWS::EMR::Cluster` resource specifies an Amazon EMR cluster. This cluster is a collection of Amazon EC2 instances that run open source big data frameworks and applications to process and analyze vast amounts of data. For more information, see the [Amazon EMR Management Guide](https://docs.aws.amazon.com//emr/latest/ManagementGuide/).\nAmazon EMR now supports launching task instance groups and task instance\nfleets as part of the `AWS::EMR::Cluster` resource. This can be done by using\nthe `JobFlowInstancesConfig` property type's `TaskInstanceGroups` and\n`TaskInstanceFleets` subproperties. Using these subproperties reduces delays\nin provisioning task nodes compared to specifying task nodes with the\n`AWS::EMR::InstanceGroupConfig` and\n`AWS::EMR::InstanceFleetConfig` resources. Please refer to the examples at\nthe bottom of this page to learn how to use these subproperties.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html", "Properties": { "AdditionalInfo": { "MarkdownDocumentation": "`AdditionalInfo`\n\nA JSON string for selecting additional features.\n*Required*: No\n*Type*: Json\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-additionalinfo", "PrimitiveType": "Json", "Required": false, "UpdateType": "Immutable" }, "Applications": { "MarkdownDocumentation": "`Applications`\n\nThe applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.\n*Required*: No\n*Type*: Array of [Application](./aws-properties-emr-cluster-application.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-applications", "DuplicatesAllowed": false, "ItemType": "Application", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "AutoScalingRole": { "MarkdownDocumentation": "`AutoScalingRole`\n\nAn IAM role for automatic scaling policies. The default role is\n`EMR_AutoScaling_DefaultRole`. The IAM role provides\npermissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-autoscalingrole", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "AutoTerminationPolicy": { "MarkdownDocumentation": "`AutoTerminationPolicy`\n\nAn auto-termination policy for an Amazon EMR cluster. An auto-termination policy\ndefines the amount of idle time in seconds after which a cluster automatically terminates.\nFor alternative cluster termination options, see [Control cluster\ntermination](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html).\n*Required*: No\n*Type*: [AutoTerminationPolicy](./aws-properties-emr-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-autoterminationpolicy", "Required": false, "Type": "AutoTerminationPolicy", "UpdateType": "Mutable" }, "BootstrapActions": { "MarkdownDocumentation": "`BootstrapActions`\n\nA list of bootstrap actions to run before Hadoop starts on the cluster nodes.\n*Required*: No\n*Type*: Array of [BootstrapActionConfig](./aws-properties-emr-cluster-bootstrapactionconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-bootstrapactions", "DuplicatesAllowed": false, "ItemType": "BootstrapActionConfig", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "Configurations": { "MarkdownDocumentation": "`Configurations`\n\nApplies only to Amazon EMR releases 4.x and later. The list of configurations\nthat are supplied to the Amazon EMR cluster.\n*Required*: No\n*Type*: Array of [Configuration](./aws-properties-emr-cluster-configuration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-configurations", "DuplicatesAllowed": false, "ItemType": "Configuration", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "CustomAmiId": { "MarkdownDocumentation": "`CustomAmiId`\n\nAvailable only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon\nEBS-backed Linux AMI if the cluster uses a custom AMI.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-customamiid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EbsRootVolumeIops": { "MarkdownDocumentation": "`EbsRootVolumeIops`\n\nThe IOPS, of the Amazon EBS root device volume of the Linux AMI that is\nused for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and\nlater.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-ebsrootvolumeiops", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "EbsRootVolumeSize": { "MarkdownDocumentation": "`EbsRootVolumeSize`\n\nThe size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\nused for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and\nlater.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-ebsrootvolumesize", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "EbsRootVolumeThroughput": { "MarkdownDocumentation": "`EbsRootVolumeThroughput`\n\nThe throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is\nused for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and\nlater.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-ebsrootvolumethroughput", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "Instances": { "MarkdownDocumentation": "`Instances`\n\nA specification of the number and type of Amazon EC2 instances.\n*Required*: Yes\n*Type*: [JobFlowInstancesConfig](./aws-properties-emr-cluster-jobflowinstancesconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-instances", "Required": true, "Type": "JobFlowInstancesConfig", "UpdateType": "Conditional" }, "JobFlowRole": { "MarkdownDocumentation": "`JobFlowRole`\n\nAlso called instance profile and Amazon EC2 role. An IAM role for\nan Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this\nrole. The default role is `EMR_EC2_DefaultRole`. In order to use the default\nrole, you must have already created it using the AWS CLI or console.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-jobflowrole", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "KerberosAttributes": { "MarkdownDocumentation": "`KerberosAttributes`\n\nAttributes for Kerberos configuration when Kerberos authentication is enabled using a\nsecurity configuration. For more information see [Use Kerberos Authentication](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html)\nin the *Amazon EMR Management Guide*.\n*Required*: No\n*Type*: [KerberosAttributes](./aws-properties-emr-cluster-kerberosattributes.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-kerberosattributes", "Required": false, "Type": "KerberosAttributes", "UpdateType": "Immutable" }, "LogEncryptionKmsKeyId": { "MarkdownDocumentation": "`LogEncryptionKmsKeyId`\n\nThe AWS KMS key used for encrypting log files. This attribute is only\navailable with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-logencryptionkmskeyid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "LogUri": { "MarkdownDocumentation": "`LogUri`\n\nThe path to the Amazon S3 location where logs for this cluster are\nstored.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-loguri", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ManagedScalingPolicy": { "MarkdownDocumentation": "`ManagedScalingPolicy`\n\nCreates or updates a managed scaling policy for an Amazon EMR cluster. The\nmanaged scaling policy defines the limits for resources, such as Amazon EC2\ninstances that can be added or terminated from a cluster. The policy only applies to the\ncore and task nodes. The master node cannot be scaled after initial configuration.\n*Required*: No\n*Type*: [ManagedScalingPolicy](./aws-properties-emr-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-managedscalingpolicy", "Required": false, "Type": "ManagedScalingPolicy", "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the cluster. This parameter can't contain the characters <, >, $, |, or ` (backtick).\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "OSReleaseLabel": { "MarkdownDocumentation": "`OSReleaseLabel`\n\nThe Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon\nLinux release was specified, the default Amazon Linux release is shown in the\nresponse.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-osreleaselabel", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "PlacementGroupConfigs": { "MarkdownDocumentation": "`PlacementGroupConfigs`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [PlacementGroupConfig](./aws-properties-emr-cluster-placementgroupconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-placementgroupconfigs", "DuplicatesAllowed": false, "ItemType": "PlacementGroupConfig", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "ReleaseLabel": { "MarkdownDocumentation": "`ReleaseLabel`\n\nThe Amazon EMR release label, which determines the version of open-source\napplication packages installed on the cluster. Release labels are in the form\n`emr-x.x.x`, where x.x.x is an Amazon EMR release version such as\n`emr-5.14.0`. For more information about Amazon EMR release versions\nand included application versions and features, see . The release label applies only to Amazon EMR\nreleases 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-releaselabel", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ScaleDownBehavior": { "MarkdownDocumentation": "`ScaleDownBehavior`\n\nThe way that individual Amazon EC2 instances terminate when an automatic\nscale-in activity occurs or an instance group is resized.\n`TERMINATE_AT_INSTANCE_HOUR` indicates that Amazon EMR terminates\nnodes at the instance-hour boundary, regardless of when the request to terminate the\ninstance was submitted. This option is only available with Amazon EMR 5.1.0 and\nlater and is the default for clusters created using that version.\n`TERMINATE_AT_TASK_COMPLETION` indicates that Amazon EMR adds nodes\nto a deny list and drains tasks from nodes before terminating the Amazon EC2\ninstances, 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\nHDFS corruption. `TERMINATE_AT_TASK_COMPLETION` is available only in Amazon EMR releases 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 ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TERMINATE_AT_INSTANCE_HOUR", "TERMINATE_AT_TASK_COMPLETION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-scaledownbehavior", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "SecurityConfiguration": { "MarkdownDocumentation": "`SecurityConfiguration`\n\nThe name of the security configuration applied to the cluster.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-securityconfiguration", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ServiceRole": { "MarkdownDocumentation": "`ServiceRole`\n\nThe IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-servicerole", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "StepConcurrencyLevel": { "MarkdownDocumentation": "`StepConcurrencyLevel`\n\nSpecifies the number of steps that can be executed concurrently. The default value is\n`1`. The maximum value is `256`.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-stepconcurrencylevel", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "Steps": { "MarkdownDocumentation": "`Steps`\n\nA list of steps to run.\n*Required*: No\n*Type*: Array of [StepConfig](./aws-properties-emr-cluster-stepconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-steps", "DuplicatesAllowed": false, "ItemType": "StepConfig", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags associated with a cluster.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-emr-cluster-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "VisibleToAllUsers": { "MarkdownDocumentation": "`VisibleToAllUsers`\n\nIndicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to `true`, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set.\nIf this value is `false`, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.\n###### Note\nWhen you create clusters directly through the EMR console or API, this value is set to `true` by default. However, for `AWS::EMR::Cluster` resources in CloudFormation, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-visibletoallusers", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceFleetConfig": { "MarkdownDocumentation": "`AWS::EMR::InstanceFleetConfig`\n\nUse `InstanceFleetConfig` to define instance fleets for an EMR cluster. A cluster can not use both instance fleets and instance groups. For more information, see [Configure Instance Fleets](https://docs.aws.amazon.com//emr/latest/ManagementGuide/emr-instance-group-configuration.html) in the *Amazon EMR Management Guide*.\n###### Note\nThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.\n###### Important\nYou can currently only add a task instance fleet to a cluster with this resource. If you use\nthis resource, CloudFormation waits for the cluster launch to complete before adding the\ntask instance fleet to the cluster. In order to add a task instance fleet to the cluster\nas part of the cluster launch and minimize delays in provisioning task nodes, use the\n`TaskInstanceFleets` subproperty for the [AWS::EMR::Cluster JobFlowInstancesConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html) property instead. To use this\nsubproperty, see [AWS::EMR::Cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html) for examples.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html", "Properties": { "ClusterId": { "MarkdownDocumentation": "`ClusterId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-clusterid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "InstanceFleetType": { "MarkdownDocumentation": "`InstanceFleetType`\n\nThe node type that the instance fleet hosts.\n*Allowed Values*: TASK\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancefleettype", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "InstanceTypeConfigs": { "MarkdownDocumentation": "`InstanceTypeConfigs`\n\n`InstanceTypeConfigs` determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.\n###### Note\nThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.\n*Required*: No\n*Type*: Array of [InstanceTypeConfig](./aws-properties-emr-instancefleetconfig-instancetypeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfigs", "DuplicatesAllowed": false, "ItemType": "InstanceTypeConfig", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "LaunchSpecifications": { "MarkdownDocumentation": "`LaunchSpecifications`\n\nThe launch specification for the instance fleet.\n*Required*: No\n*Type*: [InstanceFleetProvisioningSpecifications](./aws-properties-emr-instancefleetconfig-instancefleetprovisioningspecifications.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-launchspecifications", "Required": false, "Type": "InstanceFleetProvisioningSpecifications", "UpdateType": "Immutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe friendly name of the instance fleet.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ResizeSpecifications": { "MarkdownDocumentation": "`ResizeSpecifications`\n\nThe resize specification for the instance fleet.\n*Required*: No\n*Type*: [InstanceFleetResizingSpecifications](./aws-properties-emr-instancefleetconfig-instancefleetresizingspecifications.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-resizespecifications", "Required": false, "Type": "InstanceFleetResizingSpecifications", "UpdateType": "Mutable" }, "TargetOnDemandCapacity": { "MarkdownDocumentation": "`TargetOnDemandCapacity`\n\nThe target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by `InstanceTypeConfig`. Each instance configuration has a specified `WeightedCapacity`. When an On-Demand instance is provisioned, the `WeightedCapacity` units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a `WeightedCapacity` of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.\n###### Note\nIf not specified or set to 0, only Spot instances are provisioned for the instance fleet using `TargetSpotCapacity`. At least one of `TargetSpotCapacity` and `TargetOnDemandCapacity` should be greater than 0. For a master instance fleet, only one of `TargetSpotCapacity` and `TargetOnDemandCapacity` can be specified, and its value must be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-targetondemandcapacity", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "TargetSpotCapacity": { "MarkdownDocumentation": "`TargetSpotCapacity`\n\nThe target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by `InstanceTypeConfig`. Each instance configuration has a specified `WeightedCapacity`. When a Spot instance is provisioned, the `WeightedCapacity` units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a `WeightedCapacity` of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.\n###### Note\nIf not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of `TargetSpotCapacity` and `TargetOnDemandCapacity` should be greater than 0. For a master instance fleet, only one of `TargetSpotCapacity` and `TargetOnDemandCapacity` can be specified, and its value must be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-targetspotcapacity", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::EMR::InstanceGroupConfig": { "MarkdownDocumentation": "`AWS::EMR::InstanceGroupConfig`\n\nUse `InstanceGroupConfig` to define instance groups for an EMR cluster. A cluster can not use both instance groups and instance fleets. For more information, see [Create a Cluster with Instance Fleets or Uniform Instance Groups](https://docs.aws.amazon.com//emr/latest/ManagementGuide/emr-instance-group-configuration.html) in the *Amazon EMR Management Guide*.\n###### Important\nYou can currently only add task instance groups to a cluster with this resource. If you use\nthis resource, CloudFormation waits for the cluster launch to complete before adding the\ntask instance group to the cluster. In order to add task instance groups to the cluster\nas part of the cluster launch and minimize delays in provisioning task nodes, use the\n`TaskInstanceGroups` subproperty for the [AWS::EMR::Cluster JobFlowInstancesConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html) property instead. To use this\nsubproperty, see [AWS::EMR::Cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html) for examples.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns returns the ID of the instance group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html", "Properties": { "AutoScalingPolicy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy", "Required": false, "Type": "AutoScalingPolicy", "UpdateType": "Mutable" }, "BidPrice": { "MarkdownDocumentation": "`BidPrice`\n\nIf specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify `OnDemandPrice` to set the amount equal to the On-Demand price, or specify an amount in USD.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-bidprice", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Configurations": { "MarkdownDocumentation": "`Configurations`\n\n###### Note\nAmazon EMR releases 4.x or later.\nThe list of configurations supplied for an Amazon EMR cluster instance group.\nYou can specify a separate configuration for each instance group (master, core, and\ntask).\n*Required*: No\n*Type*: Array of [Configuration](./aws-properties-emr-instancegroupconfig-configuration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-configurations", "DuplicatesAllowed": false, "ItemType": "Configuration", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "CustomAmiId": { "MarkdownDocumentation": "`CustomAmiId`\n\nThe custom AMI ID to use for the provisioned instance group.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-customamiid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EbsConfiguration": { "MarkdownDocumentation": "`EbsConfiguration`\n\n`EbsConfiguration` determines the EBS volumes to attach to EMR cluster instances.\n*Required*: No\n*Type*: [EbsConfiguration](./aws-properties-emr-instancegroupconfig-ebsconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-ebsconfiguration", "Required": false, "Type": "EbsConfiguration", "UpdateType": "Immutable" }, "InstanceCount": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfiginstancecount-", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Mutable" }, "InstanceRole": { "MarkdownDocumentation": "`InstanceRole`\n\nThe role of the instance group in the cluster.\n*Allowed Values*: TASK\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-instancerole", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe Amazon EC2 instance type for all instances in the instance group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-instancetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "JobFlowId": { "MarkdownDocumentation": "`JobFlowId`\n\nThe ID of an Amazon EMR cluster that you want to associate this instance group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-jobflowid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Market": { "MarkdownDocumentation": "`Market`\n\nMarket type of the Amazon EC2 instances used to create a cluster node.\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)", "RefReturnValue": "", "AllowedValues": [ "ON_DEMAND", "SPOT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-market", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nFriendly name given to the instance group.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" } } }, "AWS::EMR::SecurityConfiguration": { "MarkdownDocumentation": "`AWS::EMR::SecurityConfiguration`\n\nUse a `SecurityConfiguration` resource to configure data encryption, Kerberos authentication (available in Amazon EMR release version 5.10.0 and later), and Amazon S3 authorization for EMRFS (available in EMR 5.10.0 and later). You can re-use a security configuration for any number of clusters in your account. For more information and example security configuration JSON objects, see [Create a Security Configuration](https://docs.aws.amazon.com//emr/latest/ManagementGuide/emr-create-security-configuration.html) in the *Amazon EMR Management Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns returns the security configuration name, such as `mySecurityConfiguration`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html", "Properties": { "SecurityConfiguration": { "MarkdownDocumentation": "`SecurityConfiguration`\n\nThe security configuration details in JSON format. For JSON parameters and examples, see\n[Use Security\nConfigurations to Set Up Cluster Security](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-security-configurations.html) in the *Amazon EMR\nManagement Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html#cfn-emr-securityconfiguration-securityconfiguration", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Json" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the security configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\n*Minimum*: `0`\n*Maximum*: `10280`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html#cfn-emr-securityconfiguration-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::EMR::Step": { "MarkdownDocumentation": "`AWS::EMR::Step`\n\nUse `Step` to specify a cluster (job flow) step, which runs only on the master node. Steps are used to submit data processing jobs to a cluster.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns returns the ID of the step.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html", "Properties": { "JobFlowId": { "MarkdownDocumentation": "`JobFlowId`\n\nA string that uniquely identifies the cluster (job flow).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-emr-step-jobflowid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LogUri": { "MarkdownDocumentation": "`LogUri`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-emr-step-loguri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ActionOnFailure": { "MarkdownDocumentation": "`ActionOnFailure`\n\nThis specifies what action to take when the cluster step fails. Possible values are `CANCEL_AND_WAIT` and `CONTINUE`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-emr-step-actiononfailure", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-emr-step-encryptionkeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HadoopJarStep": { "MarkdownDocumentation": "`HadoopJarStep`\n\nThe `HadoopJarStepConfig` property type specifies a job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps.\n*Required*: Yes\n*Type*: [HadoopJarStepConfig](./aws-properties-emr-step-hadoopjarstepconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-emr-step-hadoopjarstep", "UpdateType": "Immutable", "Required": true, "Type": "HadoopJarStepConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the cluster step.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-emr-step-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of the cluster step.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#Id-fn::getatt" } } }, "AWS::EMR::Studio": { "MarkdownDocumentation": "`AWS::EMR::Studio`\n\nThe `AWS::EMR::Studio` resource specifies an Amazon EMR Studio. An EMR Studio is a web-based, integrated development environment for fully managed Jupyter notebooks that run on Amazon EMR clusters. For more information, see the [*Amazon EMR Management Guide*](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ID. For example:\n`{ \"Ref\": \"es-EXAMPLE12345678XXXXXXXXXXX\" }`\nRef returns the ID of the Amazon EMR Studio.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html", "Properties": { "WorkspaceSecurityGroupId": { "MarkdownDocumentation": "`WorkspaceSecurityGroupId`\n\nThe ID of the Workspace security group associated with the Amazon EMR Studio.\nThe Workspace security group allows outbound network traffic to resources in the Engine\nsecurity group and to the internet.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^sg-[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-workspacesecuritygroupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA detailed description of the Amazon EMR Studio.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionKeyArn": { "MarkdownDocumentation": "`EncryptionKeyArn`\n\nThe AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov|iso-f|iso-e))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-encryptionkeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DefaultS3Location": { "MarkdownDocumentation": "`DefaultS3Location`\n\nThe Amazon S3 location to back up EMR Studio Workspaces and notebook files.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^s3://.*`\n*Minimum*: `6`\n*Maximum*: `10280`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-defaults3location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have\na maximum of 5 subnets. The subnets must belong to the VPC specified by `VpcId`.\nStudio users can create a Workspace in any of the specified subnets.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IdpAuthUrl": { "MarkdownDocumentation": "`IdpAuthUrl`\n\nYour identity provider's authentication endpoint. Amazon EMR Studio redirects\nfederated users to this endpoint for authentication when logging in to a Studio with the\nStudio URL.\n*Required*: No\n*Type*: String\n*Pattern*: `^https://[0-9a-zA-Z]([-.\\w]*[0-9a-zA-Z])(:[0-9]*)*([?/#].*)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idpauthurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrustedIdentityPropagationEnabled": { "MarkdownDocumentation": "`TrustedIdentityPropagationEnabled`\n\nIndicates whether the Studio has Trusted identity propagation enabled. The 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-trustedidentitypropagationenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA descriptive name for the Amazon EMR Studio.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IdcUserAssignment": { "MarkdownDocumentation": "`IdcUserAssignment`\n\nIndicates whether the Studio has `REQUIRED` or `OPTIONAL` IAM Identity Center user assignment. If the value is set to `REQUIRED`, users must be explicitly assigned to the Studio application to access the Studio.\n*Required*: No\n*Type*: String\n*Allowed values*: `REQUIRED | OPTIONAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "REQUIRED", "OPTIONAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idcuserassignment", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServiceRole": { "MarkdownDocumentation": "`ServiceRole`\n\nThe Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio. The service role provides a\nway for Amazon EMR Studio to interoperate with other AWS services.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov|iso-f|iso-e))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-servicerole", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the\nStudio.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EngineSecurityGroupId": { "MarkdownDocumentation": "`EngineSecurityGroupId`\n\nThe ID of the Amazon EMR Studio Engine security group. The Engine security group\nallows inbound network traffic from the Workspace security group, and it must be in the\nsame VPC specified by `VpcId`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^sg-[a-zA-Z0-9\\-._]+$`\n*Minimum*: `4`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-enginesecuritygroupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UserRole": { "MarkdownDocumentation": "`UserRole`\n\nThe Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio. The\npermissions attached to this IAM role can be scoped down for each user or group using\nsession policies. You only need to specify `UserRole` when you set `AuthMode` to `SSO`.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-(cn|us-gov|iso-f|iso-e))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-userrole", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IdpRelayStateParameterName": { "MarkdownDocumentation": "`IdpRelayStateParameterName`\n\nThe name of your identity provider's `RelayState` parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idprelaystateparametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthMode": { "MarkdownDocumentation": "`AuthMode`\n\nSpecifies whether the Studio authenticates users using IAM Identity Center or IAM.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SSO | IAM`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "SSO", "IAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-authmode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-emr-studio-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "IdcInstanceArn": { "MarkdownDocumentation": "`IdcInstanceArn`\n\nThe ARN of the IAM Identity Center instance the Studio application belongs to.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idcinstancearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the Amazon EMR Studio. For example: `arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#Arn-fn::getatt" }, "StudioId": { "PrimitiveType": "String", "MarkdownDocumentation": "`StudioId`\n\nThe ID of the Amazon EMR Studio. For example: `es-EXAMPLE12345678XXXXXXXXXXX`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#StudioId-fn::getatt" }, "Url": { "PrimitiveType": "String", "MarkdownDocumentation": "`Url`\n\nThe unique access URL of the Amazon EMR Studio. For example: `https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#Url-fn::getatt" } } }, "AWS::EMR::StudioSessionMapping": { "MarkdownDocumentation": "`AWS::EMR::StudioSessionMapping`\n\nThe `AWS::EMR::StudioSessionMapping` resource is an Amazon EMR resource type that maps a user or group to the Amazon EMR Studio specified by `StudioId`, and\napplies a session policy that defines Studio permissions for that user or group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studiosessionmapping.html", "Properties": { "IdentityType": { "MarkdownDocumentation": "`IdentityType`\n\nSpecifies whether the identity to map to the Amazon EMR Studio is a user or a\ngroup.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `USER | GROUP...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "USER", "GROUP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studiosessionmapping.html#cfn-emr-studiosessionmapping-identitytype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SessionPolicyArn": { "MarkdownDocumentation": "`SessionPolicyArn`\n\nThe Amazon Resource Name (ARN) for the session policy that will be applied to the user\nor group. Session policies refine Studio user permissions without the need to use multiple\nIAM 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*Pattern*: `^arn:aws(-(cn|us-gov|iso-f|iso-e))?:iam::([0-9]{12})?:policy\\/[^.]+$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studiosessionmapping.html#cfn-emr-studiosessionmapping-sessionpolicyarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StudioId": { "MarkdownDocumentation": "`StudioId`\n\nThe ID of the Amazon EMR Studio to which the user or group will be\nmapped.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^es-[0-9A-Z]+`\n*Minimum*: `4`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studiosessionmapping.html#cfn-emr-studiosessionmapping-studioid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IdentityName": { "MarkdownDocumentation": "`IdentityName`\n\nThe 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*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studiosessionmapping.html#cfn-emr-studiosessionmapping-identityname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::EMR::WALWorkspace": { "MarkdownDocumentation": "`AWS::EMR::WALWorkspace`\n\nThe `AWS::EMR::WALWorkspace` resource Property description not available. for EMR.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-walworkspace.html", "Properties": { "WALWorkspaceName": { "MarkdownDocumentation": "`WALWorkspaceName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-walworkspace.html#cfn-emr-walworkspace-walworkspacename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-emr-walworkspace-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-walworkspace.html#cfn-emr-walworkspace-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } } }, "AWS::EMRContainers::VirtualCluster": { "MarkdownDocumentation": "`AWS::EMRContainers::VirtualCluster`\n\nThe `AWS::EMRContainers::VirtualCluster` resource specifies a virtual cluster. A virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list, and delete virtual clusters. They do not consume any additional resources in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the virtual cluster.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-virtualcluster.html", "Properties": { "SecurityConfigurationId": { "MarkdownDocumentation": "`SecurityConfigurationId`\n\nThe ID of the security configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9a-z]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-virtualcluster.html#cfn-emrcontainers-virtualcluster-securityconfigurationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContainerProvider": { "MarkdownDocumentation": "`ContainerProvider`\n\nThe container provider of the virtual cluster.\n*Required*: Yes\n*Type*: [ContainerProvider](./aws-properties-emrcontainers-virtualcluster-containerprovider.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-virtualcluster.html#cfn-emrcontainers-virtualcluster-containerprovider", "UpdateType": "Immutable", "Required": true, "Type": "ContainerProvider" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-emrcontainers-virtualcluster-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-virtualcluster.html#cfn-emrcontainers-virtualcluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the virtual cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-virtualcluster.html#cfn-emrcontainers-virtualcluster-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the virtual cluster, such as `ab4rp1abcs8xz47n3x0example`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-virtualcluster.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the project, such as `arn:aws:emr-containers:us-east-1:123456789012:/virtualclusters/ab4rp1abcs8xz47n3x0example`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-virtualcluster.html#Arn-fn::getatt" } } }, "AWS::EMRServerless::Application": { "MarkdownDocumentation": "`AWS::EMRServerless::Application`\n\nThe `AWS::EMRServerless::Application` resource specifies an EMR Serverless\napplication. An application uses open source analytics frameworks to run jobs that\nprocess data. To create an application, you must specify the release version for the\nopen source framework version you want to use and the type of application you want, such\nas Apache Spark or Apache Hive. After you create an application, you can submit data\nprocessing jobs or interactive requests to it.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the application.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html", "Properties": { "AutoStartConfiguration": { "MarkdownDocumentation": "`AutoStartConfiguration`\n\nThe configuration for an application to automatically start on job submission.\n*Required*: No\n*Type*: [AutoStartConfiguration](./aws-properties-emrserverless-application-autostartconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-autostartconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "AutoStartConfiguration" }, "Architecture": { "MarkdownDocumentation": "`Architecture`\n\nThe CPU architecture of an application.\n*Required*: No\n*Type*: String\n*Allowed values*: `ARM64 | X86_64...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ARM64", "X86_64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-architecture", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "WorkerTypeSpecifications": { "MarkdownDocumentation": "`WorkerTypeSpecifications`\n\nThe specification applied to each worker type.\n*Required*: No\n*Type*: Object of [WorkerTypeSpecificationInput](./aws-properties-emrserverless-application-workertypespecificationinput.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-workertypespecifications", "UpdateType": "Conditional", "Required": false, "Type": "Map", "ItemType": "WorkerTypeSpecificationInput" }, "MonitoringConfiguration": { "MarkdownDocumentation": "`MonitoringConfiguration`\n\nA configuration specification to be used when provisioning an application. A\nconfiguration consists of a classification, properties, and optional nested configurations.\nA classification refers to an application-specific configuration file. Properties are the\nsettings you want to change in that file.\n*Required*: No\n*Type*: [MonitoringConfiguration](./aws-properties-emrserverless-application-monitoringconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-monitoringconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "MonitoringConfiguration" }, "MaximumCapacity": { "MarkdownDocumentation": "`MaximumCapacity`\n\nThe maximum capacity of the application. This is cumulative across all workers at any\ngiven point in time during the lifespan of the application is created. No new resources\nwill be created once any one of the defined limits is hit.\n*Required*: No\n*Type*: [MaximumAllowedResources](./aws-properties-emrserverless-application-maximumallowedresources.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-maximumcapacity", "UpdateType": "Conditional", "Required": false, "Type": "MaximumAllowedResources" }, "AutoStopConfiguration": { "MarkdownDocumentation": "`AutoStopConfiguration`\n\nThe configuration for an application to automatically stop after a certain amount of\ntime being idle.\n*Required*: No\n*Type*: [AutoStopConfiguration](./aws-properties-emrserverless-application-autostopconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-autostopconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "AutoStopConfiguration" }, "RuntimeConfiguration": { "MarkdownDocumentation": "`RuntimeConfiguration`\n\nThe [Configuration](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html)\nspecifications of an application. Each configuration consists of a classification and properties. You use this\nparameter when creating or updating an application. To see the runtimeConfiguration object of an application,\nrun the [GetApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_GetApplication.html) API operation.\n*Required*: No\n*Type*: Array of [ConfigurationObject](./aws-properties-emrserverless-application-configurationobject.html)\n*Minimum*: `0`\n*Maximum*: `100`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-runtimeconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "ConfigurationObject", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the application.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9._\\/#-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of application, such as Spark or Hive.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SchedulerConfiguration": { "MarkdownDocumentation": "`SchedulerConfiguration`\n\nThe scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.\n*Required*: No\n*Type*: [SchedulerConfiguration](./aws-properties-emrserverless-application-schedulerconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-schedulerconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "SchedulerConfiguration" }, "InitialCapacity": { "MarkdownDocumentation": "`InitialCapacity`\n\nThe initial capacity of the application.\n*Required*: No\n*Type*: Array of [InitialCapacityConfigKeyValuePair](./aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-initialcapacity", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "InitialCapacityConfigKeyValuePair", "DuplicatesAllowed": false }, "InteractiveConfiguration": { "MarkdownDocumentation": "`InteractiveConfiguration`\n\nThe interactive configuration object that enables the interactive use cases for an application.\n*Required*: No\n*Type*: [InteractiveConfiguration](./aws-properties-emrserverless-application-interactiveconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-interactiveconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "InteractiveConfiguration" }, "ImageConfiguration": { "MarkdownDocumentation": "`ImageConfiguration`\n\nThe image configuration applied to all worker types.\n*Required*: No\n*Type*: [ImageConfigurationInput](./aws-properties-emrserverless-application-imageconfigurationinput.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-imageconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "ImageConfigurationInput" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network configuration for customer VPC connectivity for the application.\n*Required*: No\n*Type*: [NetworkConfiguration](./aws-properties-emrserverless-application-networkconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-networkconfiguration", "UpdateType": "Conditional", "Required": false, "Type": "NetworkConfiguration" }, "ReleaseLabel": { "MarkdownDocumentation": "`ReleaseLabel`\n\nThe EMR release associated with the application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9._/-]+$`\n*Minimum*: `1`\n*Maximum*: `64`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-releaselabel", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "IdentityCenterConfiguration": { "MarkdownDocumentation": "`IdentityCenterConfiguration`\n\nThe IAM Identity Center configuration applied to enable trusted identity propagation.\n*Required*: No\n*Type*: [IdentityCenterConfiguration](./aws-properties-emrserverless-application-identitycenterconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-identitycenterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IdentityCenterConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the application.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-emrserverless-application-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the EMR Serverless Application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#Arn-fn::getatt" }, "ApplicationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApplicationId`\n\nThe ID of the application, such as `ab4rp1abcs8xz47n3x0example`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#ApplicationId-fn::getatt" } } }, "AWS::EVS::Environment": { "MarkdownDocumentation": "`AWS::EVS::Environment`\n\nCreates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.\nDuring environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.\nIt can take several hours to create an environment.\nAfter the deployment completes, you can configure VCF in the vSphere user interface according to your needs.\n###### Note\nYou cannot use the `dedicatedHostId` and `placementGroupId` parameters together in the same `CreateEnvironment` action.\nThis results in a `ValidationException` response.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon EVS `EnvironmentId`. For example: `{ \"Ref\": \"env-1234567890\" }`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html", "Properties": { "LicenseInfo": { "MarkdownDocumentation": "`LicenseInfo`\n\nThe license information that Amazon EVS requires to create an environment.\nAmazon EVS requires two license keys: a VCF solution key and a vSAN license key.\nThe VCF solution key must cover a minimum of 256 cores.\nThe vSAN license key must provide at least 110 TiB of vSAN capacity.\n*Required*: Yes\n*Type*: [LicenseInfo](./aws-properties-evs-environment-licenseinfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-licenseinfo", "UpdateType": "Immutable", "Required": true, "Type": "LicenseInfo" }, "Hosts": { "MarkdownDocumentation": "`Hosts`\n\nRequired for environment resource creation.\n*Required*: Conditional\n*Type*: Array of [HostInfoForCreate](./aws-properties-evs-environment-hostinfoforcreate.html)\n*Minimum*: `4`\n*Maximum*: `4`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-hosts", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HostInfoForCreate", "DuplicatesAllowed": true }, "SiteId": { "MarkdownDocumentation": "`SiteId`\n\nThe Broadcom Site ID that is associated with your Amazon EVS environment.\nAmazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.\n*Required*: Yes\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-siteid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS KMS key ID that AWS Secrets Manager uses to encrypt secrets\nthat are associated with the environment.\nThese secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.\nBy default, Amazon EVS use the AWS Secrets Manager managed key `aws/secretsmanager`.\nYou can also specify a customer managed key.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentName": { "MarkdownDocumentation": "`EnvironmentName`\n\nThe name of the environment.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{1,100}$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-environmentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConnectivityInfo": { "MarkdownDocumentation": "`ConnectivityInfo`\n\nThe connectivity configuration for the environment.\nAmazon EVS requires that you specify two route server peer IDs.\nDuring environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.\n*Required*: Yes\n*Type*: [ConnectivityInfo](./aws-properties-evs-environment-connectivityinfo.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-connectivityinfo", "UpdateType": "Immutable", "Required": true, "Type": "ConnectivityInfo" }, "InitialVlans": { "MarkdownDocumentation": "`InitialVlans`\n\n###### Note\nAmazon EVS is in public preview release and is subject to change.\nThe initial VLAN subnets for the environment.\nAmazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.\nAmazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.\nRequired for environment resource creation.\n*Required*: Conditional\n*Type*: [InitialVlans](./aws-properties-evs-environment-initialvlans.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-initialvlans", "UpdateType": "Mutable", "Required": false, "Type": "InitialVlans" }, "ServiceAccessSecurityGroups": { "MarkdownDocumentation": "`ServiceAccessSecurityGroups`\n\nThe security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.\nIf a security group is not specified, Amazon EVS uses the default security group in your account for service access.\n*Required*: No\n*Type*: [ServiceAccessSecurityGroups](./aws-properties-evs-environment-serviceaccesssecuritygroups.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-serviceaccesssecuritygroups", "UpdateType": "Immutable", "Required": false, "Type": "ServiceAccessSecurityGroups" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe VPC associated with the environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^vpc-[a-f0-9]{8}([a-f0-9]{9})?$`\n*Minimum*: `12`\n*Maximum*: `21`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TermsAccepted": { "MarkdownDocumentation": "`TermsAccepted`\n\nCustomer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment.\nInformation about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance.\nAmazon EVS does not validate license keys.\nTo validate license keys, visit the Broadcom support portal.\n*Required*: Yes\n*Type*: Boolean\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-termsaccepted", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Boolean" }, "VcfVersion": { "MarkdownDocumentation": "`VcfVersion`\n\nThe VCF version of the environment.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `VCF-5.2.1`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "AllowedValues": [ "VCF-5.2.1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vcfversion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VcfHostnames": { "MarkdownDocumentation": "`VcfHostnames`\n\nThe DNS hostnames to be used by the VCF management appliances in your environment.\nFor environment creation to be successful, each hostname entry must resolve to a domain name\nthat you've registered in your DNS service of choice and configured in the DHCP option set of your VPC.\nDNS hostnames cannot be changed after environment creation has started.\n*Required*: Yes\n*Type*: [VcfHostnames](./aws-properties-evs-environment-vcfhostnames.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vcfhostnames", "UpdateType": "Immutable", "Required": true, "Type": "VcfHostnames" }, "ServiceAccessSubnetId": { "MarkdownDocumentation": "`ServiceAccessSubnetId`\n\nThe subnet that is used to establish connectivity between the Amazon EVS control plane and VPC.\nAmazon EVS uses this subnet to perform validations and create the environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^subnet-[a-f0-9]{8}([a-f0-9]{9})?$`\n*Minimum*: `15`\n*Maximum*: `24`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-serviceaccesssubnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata that assists with categorization and organization.\nEach tag consists of a key and an optional value.\nYou define both.\nTags don't propagate to any other cluster or AWS resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-evs-environment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe date and time that the environment was modified. For example:`1749081600.000`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#ModifiedAt-fn::getatt" }, "EnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentId`\n\nThe unique ID for the environment. For example: `env-1234567890`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#EnvironmentId-fn::getatt" }, "EnvironmentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentArn`\n\nThe Amazon Resource Name (ARN) that is associated with the environment. For example: `arn:aws:evs:us-east-1:000000000000:environment/env-1234567890`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#EnvironmentArn-fn::getatt" }, "Checks": { "Type": "List", "ItemType": "Check", "MarkdownDocumentation": "`Checks`\n\nA check on the environment to identify instance health and VMware VCF licensing issues. For example:\n```\n {\n \"checks\": [\n {\n \"type\": \"KEY_REUSE\",\n \"result\": \"PASSED\"\n },\n {\n \"type\": \"KEY_COVERAGE\",\n \"result\": \"PASSED\"\n },\n {\n \"type\": \"REACHABILITY\",\n \"result\": \"PASSED\"\n },\n {\n \"type\": \"HOST_COUNT\",\n \"result\": \"PASSED\"\n }\n ]\n }\n \n```\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#Checks-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the environment was created. For example:`1749081600.000`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#CreatedAt-fn::getatt" }, "EnvironmentState": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentState`\n\nThe state of an environment. For example: `CREATED`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#EnvironmentState-fn::getatt" }, "StateDetails": { "PrimitiveType": "String", "MarkdownDocumentation": "`StateDetails`\n\nA detailed description of the `environmentState` of an environment. For example: `Environment successfully created`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#StateDetails-fn::getatt" }, "Credentials": { "Type": "List", "ItemType": "Secret", "MarkdownDocumentation": "`Credentials`\n\nThe VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager.\nAmazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:\n```\n {\n [\n {\n \"secretArn\": \"arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi\"\n },\n {\n \"secretArn\": \"arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF\"\n },\n {\n \"secretArn\": \"arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43\"\n },\n {\n \"secretArn\": \"arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD\"\n },\n {\n \"secretArn\": \"arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46\"\n },\n {\n \"secretArn\": \"arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq\"\n },\n {\n \"secretArn\": \"arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES\"\n },\n {\n \"secretArn\": \"arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb\"\n }\n ]\n }\n \n```\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#Credentials-fn::getatt" } } }, "AWS::ElastiCache::CacheCluster": { "Attributes": { "ConfigurationEndpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationEndpoint.Address`\n\nThe DNS hostname of the cache node.\n###### Note\nValkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt`\nreturns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt`\nfails.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#ConfigurationEndpoint.Address-fn::getatt" }, "ConfigurationEndpoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationEndpoint.Port`\n\nThe port number of the configuration endpoint for the Memcached cache cluster.\n###### Note\nValkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt`\nreturns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt`\nfails.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#ConfigurationEndpoint.Port-fn::getatt" }, "RedisEndpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`RedisEndpoint.Address`\n\nThe DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#RedisEndpoint.Address-fn::getatt" }, "RedisEndpoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`RedisEndpoint.Port`\n\nThe port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#RedisEndpoint.Port-fn::getatt" } }, "MarkdownDocumentation": "`AWS::ElastiCache::CacheCluster`\n\nThe `AWS::ElastiCache::CacheCluster` type creates an Amazon ElastiCache cache cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html", "Properties": { "AZMode": { "MarkdownDocumentation": "`AZMode`\n\nSpecifies whether the nodes in this Memcached cluster are created in a single\nAvailability Zone or created across multiple Availability Zones in the cluster's\nregion.\nThis parameter is only supported for Memcached clusters.\nIf the `AZMode` and `PreferredAvailabilityZones` are not\nspecified, ElastiCache assumes `single-az` mode.\n*Required*: No\n*Type*: String\n*Allowed values*: `single-az | cross-az...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "single-az", "cross-az" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-azmode", "PrimitiveType": "String", "Required": false, "UpdateType": "Conditional" }, "AutoMinorVersionUpgrade": { "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nIf you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the\nnext 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-autominorversionupgrade", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "CacheNodeType": { "MarkdownDocumentation": "`CacheNodeType`\n\nThe 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\nmore memory and computational power at lower cost when compared to their equivalent previous generation counterparts.\nChanging the CacheNodeType of a Memcached instance is currently not supported. If you need to scale using Memcached,\nwe recommend forcing a replacement update by changing the `LogicalResourceId` of the resource.\n* General purpose:\n \n + Current generation:\n \n **M6g node types:**`cache.m6g.large`,\n `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`,\n `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge`,\n `cache.m6g.24xlarge`\n \n **M5 node types:**`cache.m5.large`, `cache.m5.xlarge`,\n `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`,\n `cache.m5.24xlarge`\n \n **M4 node types:**`cache.m4.large`, `cache.m4.xlarge`,\n `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge`\n \n **T4g node types:**`cache.t4g.micro`, `cache.t4g.small`,\n `cache.t4g.medium`\n \n **T3 node types:**`cache.t3.micro`, `cache.t3.small`,\n `cache.t3.medium`\n \n **T2 node types:**`cache.t2.micro`, `cache.t2.small`,\n `cache.t2.medium`\n + Previous generation: (not recommended)\n \n **T1 node types:**\n `cache.t1.micro`\n \n **M1 node types:**`cache.m1.small`, `cache.m1.medium`,\n `cache.m1.large`, `cache.m1.xlarge`\n \n **M3 node types:**`cache.m3.medium`, `cache.m3.large`,\n `cache.m3.xlarge`, `cache.m3.2xlarge`\n* Compute optimized:\n \n + Previous generation: (not recommended)\n \n **C1 node types:**\n `cache.c1.xlarge`\n* Memory optimized:\n \n + Current generation:\n \n **R6gd node types:**`cache.r6gd.xlarge`,\n `cache.r6gd.2xlarge`, `cache.r6gd.4xlarge`, `cache.r6gd.8xlarge`,\n `cache.r6gd.12xlarge`, `cache.r6gd.16xlarge`\n \n ###### Note\n \n The `r6gd` family is available in the following regions: `us-east-2`,\n `us-east-1`, `us-west-2`, `us-west-1`, `eu-west-1`,\n `eu-central-1`, `ap-northeast-1`, `ap-southeast-1`,\n `ap-southeast-2`.\n \n **R6g node types:**`cache.r6g.large`,\n `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`,\n `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge`,\n `cache.r6g.24xlarge`\n \n **R5 node types:**`cache.r5.large`, `cache.r5.xlarge`,\n `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`,\n `cache.r5.24xlarge`\n \n **R4 node types:**`cache.r4.large`, `cache.r4.xlarge`,\n `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`,\n `cache.r4.16xlarge`\n + Previous generation: (not recommended)\n \n **M2 node types:**`cache.m2.xlarge`, `cache.m2.2xlarge`,\n `cache.m2.4xlarge`\n \n **R3 node types:**`cache.r3.large`, `cache.r3.xlarge`,\n `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`\nFor region availability, see [Supported Node\nTypes by Region](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)\n**Additional node type info**\n* All current generation instance types are created in Amazon VPC by default.\n* Valkey and Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.\n* Valkey and Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.\n* Redis OSS configuration variables `appendonly` and `appendfsync` are not supported on Redis OSS\n version 2.8.22 and later.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachenodetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "CacheParameterGroupName": { "MarkdownDocumentation": "`CacheParameterGroupName`\n\nThe name of the parameter group to associate with this cluster. If this argument is omitted, the default\nparameter group for the specified engine is used. You cannot use any parameter group which has\n`cluster-enabled='yes'` when creating a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cacheparametergroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CacheSecurityGroupNames": { "MarkdownDocumentation": "`CacheSecurityGroupNames`\n\nA list of security group names to associate with this cluster.\nUse this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon\nVPC).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachesecuritygroupnames", "DuplicatesAllowed": true, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "CacheSubnetGroupName": { "MarkdownDocumentation": "`CacheSubnetGroupName`\n\nThe name of the subnet group to be used for the cluster.\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).\n###### Important\nIf you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start\ncreating 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachesubnetgroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nA name for the cache cluster. If you don't specify a name, CloudFormation generates a unique physical ID and\nuses 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\nend 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-clustername", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe name of the cache engine to be used for this cluster.\nValid values for this parameter are: `memcached` | valkey |\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-engine", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe version number of the cache engine to be used for this cluster. To view the supported cache engine versions,\nuse the DescribeCacheEngineVersions operation.\n**Important:** You can upgrade to a newer engine version (see [Selecting a Cache\nEngine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement)), but you cannot downgrade to an earlier engine version. If you want to use an earlier\nengine version, you must delete the existing cluster or replication group and create it anew with the earlier engine\nversion.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-engineversion", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "IpDiscovery": { "MarkdownDocumentation": "`IpDiscovery`\n\nThe network type you choose when modifying a cluster, either `ipv4` |\n`ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\nto 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](https://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)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-ipdiscovery", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "LogDeliveryConfigurations": { "MarkdownDocumentation": "`LogDeliveryConfigurations`\n\nSpecifies the destination, format and type of the logs.\n*Required*: No\n*Type*: Array of [LogDeliveryConfigurationRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-logdeliveryconfigurations", "DuplicatesAllowed": false, "ItemType": "LogDeliveryConfigurationRequest", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nMust be either `ipv4` | `ipv6` | `dual_stack`. IPv6\nis supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1\nand Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](https://aws.amazon.com/ec2/nitro/).\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dual_stack...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dual_stack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-networktype", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "NotificationTopicArn": { "MarkdownDocumentation": "`NotificationTopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\nto which notifications are sent.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-notificationtopicarn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "NumCacheNodes": { "MarkdownDocumentation": "`NumCacheNodes`\n\nThe number of cache nodes that the cache cluster should have.\n###### Note\nHowever, if the `PreferredAvailabilityZone` and `PreferredAvailabilityZones` properties\nwere 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-numcachenodes", "PrimitiveType": "Integer", "Required": true, "UpdateType": "Conditional" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-port", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "PreferredAvailabilityZone": { "MarkdownDocumentation": "`PreferredAvailabilityZone`\n\nThe EC2 Availability Zone in which the cluster is created.\nAll nodes belonging to this cluster are placed in the preferred Availability Zone. If\nyou want to create your nodes across multiple Availability Zones, use\n`PreferredAvailabilityZones`.\nDefault: System chosen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredavailabilityzone", "PrimitiveType": "String", "Required": false, "UpdateType": "Conditional" }, "PreferredAvailabilityZones": { "MarkdownDocumentation": "`PreferredAvailabilityZones`\n\nA list of the Availability Zones in which cache nodes are created. The order of the\nzones in the list is not important.\nThis option is only supported on Memcached.\n###### Note\nIf you are creating your cluster in an Amazon VPC (recommended) you can only\nlocate nodes in Availability Zones that are associated with the subnets in the\nselected subnet group.\nThe number of Availability Zones listed must equal the value of\n`NumCacheNodes`.\nIf you want all the nodes in the same Availability Zone, use\n`PreferredAvailabilityZone` instead, or repeat the Availability Zone\nmultiple times in the list.\nDefault: System chosen Availability Zones.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredavailabilityzones", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Conditional" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range\nin the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.\nValid values for `ddd` are:\n* `sun`\n* `mon`\n* `tue`\n* `wed`\n* `thu`\n* `fri`\n* `sat`\nExample: `sun:23:00-mon:01:30`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredmaintenancewindow", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SnapshotArns": { "MarkdownDocumentation": "`SnapshotArns`\n\nA single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB\nsnapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object\nname in the ARN cannot contain any commas.\n###### Note\nThis parameter is only valid if the `Engine` parameter is `redis`.\nExample of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotarns", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "SnapshotName": { "MarkdownDocumentation": "`SnapshotName`\n\nThe name of a Valkey or Redis OSS snapshot from which to restore data into the new node group\n(shard). The snapshot status changes to `restoring` while the new node group\n(shard) is being created.\n###### Note\nThis parameter is only valid if the `Engine` parameter is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "SnapshotRetentionLimit": { "MarkdownDocumentation": "`SnapshotRetentionLimit`\n\nThe number of days for which ElastiCache retains automatic snapshots before deleting\nthem. For example, if you set `SnapshotRetentionLimit` to 5, a snapshot taken\ntoday is retained for 5 days before being deleted.\n###### Note\nThis parameter is only valid if the `Engine` parameter is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotretentionlimit", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "SnapshotWindow": { "MarkdownDocumentation": "`SnapshotWindow`\n\nThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\nof your node group (shard).\nExample: `05:00-09:00`\nIf you do not specify this parameter, ElastiCache automatically chooses an appropriate\ntime range.\n###### Note\nThis parameter is only valid if the `Engine` parameter is\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotwindow", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to be added to this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticache-cachecluster-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "TransitEncryptionEnabled": { "MarkdownDocumentation": "`TransitEncryptionEnabled`\n\nA flag that enables in-transit encryption when 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-transitencryptionenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nOne 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-vpcsecuritygroupids", "DuplicatesAllowed": true, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::ElastiCache::GlobalReplicationGroup": { "MarkdownDocumentation": "`AWS::ElastiCache::GlobalReplicationGroup`\n\nConsists of a primary cluster that accepts writes and an associated secondary cluster\nthat resides in a different Amazon region. The secondary cluster accepts only reads. The\nprimary cluster automatically replicates updates to the secondary cluster.\n* The **GlobalReplicationGroupIdSuffix** represents\n the name of the Global datastore, which is what you use to associate a secondary\n cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html", "Properties": { "GlobalReplicationGroupIdSuffix": { "MarkdownDocumentation": "`GlobalReplicationGroupIdSuffix`\n\nThe suffix name of a Global Datastore. The suffix guarantees uniqueness of the Global Datastore name across\nmultiple 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupidsuffix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CacheNodeType": { "MarkdownDocumentation": "`CacheNodeType`\n\nThe cache node type 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cachenodetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe Elasticache Valkey or Redis OSS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GlobalReplicationGroupDescription": { "MarkdownDocumentation": "`GlobalReplicationGroupDescription`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RegionalConfigurations": { "MarkdownDocumentation": "`RegionalConfigurations`\n\nThe Regions that comprise the Global Datastore.\n*Required*: No\n*Type*: Array of [RegionalConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-regionalconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RegionalConfiguration", "DuplicatesAllowed": false }, "CacheParameterGroupName": { "MarkdownDocumentation": "`CacheParameterGroupName`\n\nThe name of the cache parameter group to use with the Global datastore. It must be compatible with the major\nengine version used by 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cacheparametergroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe ElastiCache engine. For Valkey or Redis OSS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engine", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Members": { "MarkdownDocumentation": "`Members`\n\nThe replication groups that comprise the Global datastore.\n*Required*: Yes\n*Type*: Array of [GlobalReplicationGroupMember](./aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-members", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "GlobalReplicationGroupMember", "DuplicatesAllowed": false }, "AutomaticFailoverEnabled": { "MarkdownDocumentation": "`AutomaticFailoverEnabled`\n\nSpecifies whether a read-only replica is automatically promoted to read/write primary if the existing primary\nfails.\n`AutomaticFailoverEnabled` must be enabled for Valkey or Redis OSS (cluster mode enabled) replication\ngroups.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-automaticfailoverenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "GlobalNodeGroupCount": { "MarkdownDocumentation": "`GlobalNodeGroupCount`\n\nThe number of node groups that comprise the Global Datastore.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalnodegroupcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the Global Datastore. Can be `Creating`, `Modifying`,\n`Available`, `Deleting` or `Primary-Only`. Primary-only status indicates the global\ndatastore contains only a primary cluster. Either all secondary clusters are deleted or not successfully\ncreated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#Status-fn::getatt" }, "GlobalReplicationGroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`GlobalReplicationGroupId`\n\nThe ID used to associate a secondary cluster to the Global Replication Group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#GlobalReplicationGroupId-fn::getatt" } } }, "AWS::ElastiCache::ParameterGroup": { "MarkdownDocumentation": "`AWS::ElastiCache::ParameterGroup`\n\nThe `AWS::ElastiCache::ParameterGroup` type creates a new cache parameter group. Cache parameter\ngroups control the parameters for a cache cluster.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref`\nreturns the resource name.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Properties": { "MarkdownDocumentation": "`Properties`\n\nA comma-delimited list of parameter name/value pairs.\nFor example:\n```\n\"Properties\" : {\n \"cas_disabled\" : \"1\",\n \"chunk_size_growth_factor\" : \"1.02\"\n}\n```\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-properties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA tag that can be added to an ElastiCache parameter group. Tags are composed of a Key/Value pair. You can use\ntags to categorize and track all your parameter groups. A tag with a null Value is permitted.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticache-parametergroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "CacheParameterGroupFamily": { "MarkdownDocumentation": "`CacheParameterGroupFamily`\n\nThe name of the cache parameter group family that this cache parameter group is compatible with.\nValid values are: `valkey8` | `valkey7` | `memcached1.4` | `memcached1.5` | `memcached1.6` |\n`redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0`\n| `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-cacheparametergroupfamily", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CacheParameterGroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`CacheParameterGroupName`\n\nA user-specified name for the cache parameter group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#CacheParameterGroupName-fn::getatt" } } }, "AWS::ElastiCache::ReplicationGroup": { "Attributes": { "ConfigurationEndPoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationEndPoint.Address`\n\nThe DNS hostname of the cache node.\n###### Note\nValkey or Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt`\nreturns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt`\nfails. For Valkey or Redis OSS (cluster mode disabled) replication groups, use the `PrimaryEndpoint` or\n`ReadEndpoint` attributes.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#ConfigurationEndPoint.Address-fn::getatt" }, "ConfigurationEndPoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConfigurationEndPoint.Port`\n\nThe port number that the cache engine is listening on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#ConfigurationEndPoint.Port-fn::getatt" }, "PrimaryEndPoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrimaryEndPoint.Address`\n\nThe DNS address of the primary read-write cache node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#PrimaryEndPoint.Address-fn::getatt" }, "PrimaryEndPoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrimaryEndPoint.Port`\n\nThe number of the port that the primary read-write cache engine is listening on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#PrimaryEndPoint.Port-fn::getatt" }, "ReadEndPoint.Addresses": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReadEndPoint.Addresses`\n\nA string with a list of endpoints for the primary and read-only replicas. The order of the addresses maps to the\norder of the ports from the `ReadEndPoint.Ports` attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#ReadEndPoint.Addresses-fn::getatt" }, "ReadEndPoint.Addresses.List": { "PrimitiveItemType": "String", "Type": "List", "MarkdownDocumentation": "`ReadEndPoint.Addresses.List`\n\nA string with a list of endpoints for the read-only replicas. The order of the addresses maps to the order of\nthe ports from the `ReadEndPoint.Ports` attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#ReadEndPoint.Addresses.List-fn::getatt" }, "ReadEndPoint.Ports": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReadEndPoint.Ports`\n\nA string with a list of ports for the read-only replicas. The order of the ports maps to the order of the\naddresses from the `ReadEndPoint.Addresses` attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#ReadEndPoint.Ports-fn::getatt" }, "ReadEndPoint.Ports.List": { "PrimitiveItemType": "String", "Type": "List", "MarkdownDocumentation": "`ReadEndPoint.Ports.List`\n\nA string with a list of ports for the read-only replicas. The order of the ports maps to the order of the\naddresses from the ReadEndPoint.Addresses attribute.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#ReadEndPoint.Ports.List-fn::getatt" }, "ReaderEndPoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReaderEndPoint.Address`\n\nThe address of the reader endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#ReaderEndPoint.Address-fn::getatt" }, "ReaderEndPoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReaderEndPoint.Port`\n\nThe port used by the reader endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#ReaderEndPoint.Port-fn::getatt" } }, "MarkdownDocumentation": "`AWS::ElastiCache::ReplicationGroup`\n\nThe `AWS::ElastiCache::ReplicationGroup` resource creates an Amazon ElastiCache (Valkey or Redis OSS) replication\ngroup. A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of cache clusters, where one of the clusters\nis a primary read-write cluster and the others are read-only replicas.\nA Valkey or Redis OSS (cluster mode enabled) cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard\nhas a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to\n15 shards and 5 replicas, which is the maximum number or replicas allowed.\nThe node or shard limit can be increased to a maximum of 500 per cluster if the engine version is Valkey 7.2 or higher, or Redis OSS 5.0.6 or\nhigher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5\nreplicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP\naddresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR\nrange or the subnets are shared and heavily used by other clusters. For more information, see [Creating a Subnet\nGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.Creating.html). For versions below 5.0.6, the limit is 250 per cluster.\nTo request a limit increase, see [Amazon Service Limits](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) and choose the limit type **Nodes per cluster per instance\ntype**.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource\nname.\nFor more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html", "Properties": { "AtRestEncryptionEnabled": { "MarkdownDocumentation": "`AtRestEncryptionEnabled`\n\nA flag that enables encryption at rest when set to `true`.\n**Required:** Only available when creating a replication group in an Amazon VPC\nusing Redis OSS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-atrestencryptionenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" }, "AuthToken": { "MarkdownDocumentation": "`AuthToken`\n\n**Reserved parameter.** The password used to access a password protected\nserver.\n`AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled`\nis `true`. For more information, see [Authenticating Valkey or Redis OSS users with the AUTH Command](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth.html).\n###### Important\nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an\n`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\nhttp://redis.io/commands/AUTH.\n###### Note\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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-authtoken", "PrimitiveType": "String", "Required": false, "UpdateType": "Conditional" }, "AutoMinorVersionUpgrade": { "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nIf you are running Valkey 7.2 or later, or Redis OSS 6.0 or later, set this parameter to yes if you want to opt-in to the\nnext 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-autominorversionupgrade", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "AutomaticFailoverEnabled": { "MarkdownDocumentation": "`AutomaticFailoverEnabled`\n\nSpecifies whether a read-only replica is automatically promoted to read/write primary if the existing primary\nfails.\n`AutomaticFailoverEnabled` must be enabled for Valkey or Redis OSS (cluster mode enabled) replication\ngroups.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-automaticfailoverenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "CacheNodeType": { "MarkdownDocumentation": "`CacheNodeType`\n\nThe 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\nmore memory and computational power at lower cost when compared to their equivalent previous generation\ncounterparts.\n* General purpose:\n \n + Current generation:\n \n **M6g node types:**`cache.m6g.large`,\n `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`,\n `cache.m6g.12xlarge`, `cache.m6g.24xlarge`\n \n **M5 node types:**`cache.m5.large`, `cache.m5.xlarge`,\n `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`,\n `cache.m5.24xlarge`\n \n **M4 node types:**`cache.m4.large`, `cache.m4.xlarge`,\n `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge`\n \n **T4g node types:**`cache.t4g.micro`, `cache.t4g.small`,\n `cache.t4g.medium`\n \n **T3 node types:**`cache.t3.micro`, `cache.t3.small`,\n `cache.t3.medium`\n \n **T2 node types:**`cache.t2.micro`, `cache.t2.small`,\n `cache.t2.medium`\n + Previous generation: (not recommended)\n \n **T1 node types:**\n `cache.t1.micro`\n \n **M1 node types:**`cache.m1.small`, `cache.m1.medium`,\n `cache.m1.large`, `cache.m1.xlarge`\n \n **M3 node types:**`cache.m3.medium`, `cache.m3.large`,\n `cache.m3.xlarge`, `cache.m3.2xlarge`\n* Compute optimized:\n \n + Previous generation: (not recommended)\n \n **C1 node types:**\n `cache.c1.xlarge`\n* Memory optimized:\n \n + Current generation:\n \n **R6gd node types:**`cache.r6gd.xlarge`,\n `cache.r6gd.2xlarge`, `cache.r6gd.4xlarge`, `cache.r6gd.8xlarge`,\n `cache.r6gd.12xlarge`, `cache.r6gd.16xlarge`\n \n ###### Note\n \n The `r6gd` family is available in the following regions: `us-east-2`,\n `us-east-1`, `us-west-2`, `us-west-1`, `eu-west-1`,\n `eu-central-1`, `ap-northeast-1`, `ap-southeast-1`,\n `ap-southeast-2`.\n \n **R6g node types:**`cache.r6g.large`,\n `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`,\n `cache.r6g.12xlarge`, `cache.r6g.24xlarge`\n \n **R5 node types:**`cache.r5.large`, `cache.r5.xlarge`,\n `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`,\n `cache.r5.24xlarge`\n \n **R4 node types:**`cache.r4.large`, `cache.r4.xlarge`,\n `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`,\n `cache.r4.16xlarge`\n + Previous generation: (not recommended)\n \n **M2 node types:**`cache.m2.xlarge`, `cache.m2.2xlarge`,\n `cache.m2.4xlarge`\n \n **R3 node types:**`cache.r3.large`, `cache.r3.xlarge`,\n `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`\nFor region availability, see [Supported Node\nTypes by Amazon Region](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachenodetype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CacheParameterGroupName": { "MarkdownDocumentation": "`CacheParameterGroupName`\n\nThe name of the parameter group to associate with this replication group. If this\nargument is omitted, the default cache parameter group for the specified engine is\nused.\nIf you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want\nto use a default parameter group, we recommend that you specify the parameter group by\nname.\n* To create a Valkey or Redis OSS (cluster mode disabled) replication group, use\n `CacheParameterGroupName=default.redis3.2`.\n* To create a Valkey or Redis OSS (cluster mode enabled) replication group, use\n `CacheParameterGroupName=default.redis3.2.cluster.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cacheparametergroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CacheSecurityGroupNames": { "MarkdownDocumentation": "`CacheSecurityGroupNames`\n\nA list of cache security group names to associate with this replication group.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesecuritygroupnames", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "CacheSubnetGroupName": { "MarkdownDocumentation": "`CacheSubnetGroupName`\n\nThe name of the cache subnet group to be used for the replication group.\n###### Important\nIf you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start\ncreating 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesubnetgroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ClusterMode": { "MarkdownDocumentation": "`ClusterMode`\n\nThe mode can be enabled or disabled. To change the cluster mode from disabled to enabled, you must first set the cluster mode to\ncompatible. The compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode\ndisabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode\nconfiguration and set the cluster mode to enabled. For more information, see [Modify cluster mode](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/modify-cluster-mode.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-clustermode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DataTieringEnabled": { "MarkdownDocumentation": "`DataTieringEnabled`\n\nEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This\nparameter must be set to true when using r6gd nodes. For more information, see [Data tiering](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-datatieringenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe name of the cache engine to be used for the clusters in this replication group.\nThe value must be set to `valkey` or `redis`.\n###### Note\nUpgrading an existing engine from redis to valkey is done through in-place migration, and requires a parameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engine", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe version number of the cache engine to be used for the clusters in this replication\ngroup. To view the supported cache engine versions, use the\n`DescribeCacheEngineVersions` operation.\n**Important:** You can upgrade to a newer engine version\n(see [Selecting\na Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement)) in the *ElastiCache User\nGuide*, but you cannot downgrade to an earlier engine version. If you want\nto use an earlier engine version, you must delete the existing cluster or replication\ngroup 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engineversion", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "GlobalReplicationGroupId": { "MarkdownDocumentation": "`GlobalReplicationGroupId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-globalreplicationgroupid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "IpDiscovery": { "MarkdownDocumentation": "`IpDiscovery`\n\nThe network type you choose when creating a replication group, either\n`ipv4` | `ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\nto 7.1 or Memcached engine version 1.6.6 and above on all instances built on\nthe [Nitro system](https://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)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-ipdiscovery", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-kmskeyid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "LogDeliveryConfigurations": { "MarkdownDocumentation": "`LogDeliveryConfigurations`\n\nSpecifies the destination, format and type of the logs.\n*Required*: No\n*Type*: Array of [LogDeliveryConfigurationRequest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-logdeliveryconfigurations", "DuplicatesAllowed": false, "ItemType": "LogDeliveryConfigurationRequest", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "MultiAZEnabled": { "MarkdownDocumentation": "`MultiAZEnabled`\n\nA flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see [Minimizing Downtime:\nMulti-AZ](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-multiazenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nMust be either `ipv4` | `ipv6` | `dual_stack`. IPv6\nis supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\nto 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](https://aws.amazon.com/ec2/nitro/).\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dual_stack...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dual_stack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-networktype", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "NodeGroupConfiguration": { "MarkdownDocumentation": "`NodeGroupConfiguration`\n\n`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup`\nresource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS 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\ninterruption. When `UseOnlineResharding` is set to `false`, or is not specified, updating\n`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*: [Array](./aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html) of [NodeGroupConfiguration](./aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-nodegroupconfiguration", "DuplicatesAllowed": false, "ItemType": "NodeGroupConfiguration", "Required": false, "Type": "List", "UpdateType": "Conditional" }, "NotificationTopicArn": { "MarkdownDocumentation": "`NotificationTopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\nto which notifications are sent.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-notificationtopicarn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "NumCacheClusters": { "MarkdownDocumentation": "`NumCacheClusters`\n\nThe number of clusters this replication group initially has.\nThis parameter is not used if there is more than one node group (shard). You should\nuse `ReplicasPerNodeGroup` instead.\nIf `AutomaticFailoverEnabled` is `true`, the value of this\nparameter must be at least 2. If `AutomaticFailoverEnabled` is\n`false` you can omit this parameter (it will default to 1), or you can\nexplicitly set it to a value between 2 and 6.\nThe maximum permitted value for `NumCacheClusters` is 6 (1 primary plus 5\nreplicas).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numcacheclusters", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "NumNodeGroups": { "MarkdownDocumentation": "`NumNodeGroups`\n\nAn optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled)\nreplication group. For Valkey or Redis OSS (cluster mode disabled) either omit this parameter or set it to 1.\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 `NumNodeGroups` without interruption.\nWhen `UseOnlineResharding` is set to `false`, or is not specified, updating\n`NumNodeGroups` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement).\nDefault: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numnodegroups", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Conditional" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port number on which each member of the replication group accepts\nconnections.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-port", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "PreferredCacheClusterAZs": { "MarkdownDocumentation": "`PreferredCacheClusterAZs`\n\nA list of EC2 Availability Zones in which the replication group's clusters are\ncreated. The order of the Availability Zones in the list is the order in which clusters\nare allocated. The primary cluster is created in the first AZ in the list.\nThis parameter is not used if there is more than one node group (shard). You should\nuse `NodeGroupConfiguration` instead.\n###### Note\nIf you are creating your replication group in an Amazon VPC (recommended), you can\nonly locate clusters in Availability Zones associated with the subnets in the\nselected subnet group.\nThe number of Availability Zones listed must equal the value of\n`NumCacheClusters`.\nDefault: system chosen Availability Zones.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredcacheclusterazs", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range\nin the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.\nValid values for `ddd` are:\n* `sun`\n* `mon`\n* `tue`\n* `wed`\n* `thu`\n* `fri`\n* `sat`\nExample: `sun:23:00-mon:01:30`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredmaintenancewindow", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "PrimaryClusterId": { "MarkdownDocumentation": "`PrimaryClusterId`\n\nThe identifier of the cluster that serves as the primary for this replication group.\nThis cluster must already exist and have a status of `available`.\nThis parameter is not required if `NumCacheClusters`,\n`NumNodeGroups`, or `ReplicasPerNodeGroup` is\nspecified.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-primaryclusterid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ReplicasPerNodeGroup": { "MarkdownDocumentation": "`ReplicasPerNodeGroup`\n\nAn optional parameter that specifies the number of replica nodes in each node group\n(shard). Valid values are 0 to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicaspernodegroup", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "ReplicationGroupDescription": { "MarkdownDocumentation": "`ReplicationGroupDescription`\n\nA user-created description for the replication 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupdescription", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "ReplicationGroupId": { "MarkdownDocumentation": "`ReplicationGroupId`\n\nThe replication group identifier. This parameter is stored as a lowercase\nstring.\nConstraints:\n* A name must contain from 1 to 40 alphanumeric characters or hyphens.\n* The first character must be a letter.\n* A name 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nOne or more Amazon VPC security groups associated with this replication group.\nUse this parameter only when you are creating a replication group in an Amazon Virtual\nPrivate Cloud (Amazon VPC).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-securitygroupids", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "SnapshotArns": { "MarkdownDocumentation": "`SnapshotArns`\n\nA list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot\nfiles stored in Amazon S3. The snapshot files are used to populate the new replication\ngroup. The Amazon S3 object name in the ARN cannot contain any commas. The new\nreplication group will have the number of node groups (console: shards) specified by the\nparameter *NumNodeGroups* or the number of node groups configured by\n*NodeGroupConfiguration* regardless of the number of ARNs\nspecified here.\nExample of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotarns", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "SnapshotName": { "MarkdownDocumentation": "`SnapshotName`\n\nThe name of a snapshot from which to restore data into the new replication group. The\nsnapshot status changes to `restoring` while the new replication group is\nbeing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "SnapshotRetentionLimit": { "MarkdownDocumentation": "`SnapshotRetentionLimit`\n\nThe number of days for which ElastiCache retains automatic snapshots before deleting\nthem. For example, if you set `SnapshotRetentionLimit` to 5, a snapshot that\nwas taken today is retained for 5 days before being deleted.\nDefault: 0 (i.e., automatic backups are disabled for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotretentionlimit", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" }, "SnapshotWindow": { "MarkdownDocumentation": "`SnapshotWindow`\n\nThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\nof your node group (shard).\nExample: `05:00-09:00`\nIf you do not specify this parameter, ElastiCache automatically chooses an appropriate\ntime 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotwindow", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SnapshottingClusterId": { "MarkdownDocumentation": "`SnapshottingClusterId`\n\nThe cluster ID that is used as the daily snapshot source for the replication group.\nThis parameter cannot be set for Valkey or Redis OSS (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshottingclusterid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to be added to this resource. Tags are comma-separated key,value pairs\n(e.g. Key=`myKey`, Value=`myKeyValue`. You can include multiple\ntags as shown following: Key=`myKey`, Value=`myKeyValue`\nKey=`mySecondKey`, Value=`mySecondKeyValue`. Tags on\nreplication groups will be replicated to all nodes.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticache-replicationgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "TransitEncryptionEnabled": { "MarkdownDocumentation": "`TransitEncryptionEnabled`\n\nA flag that enables in-transit encryption when set to `true`.\nThis parameter is only available when creating a replication group in an Amazon VPC\nusing Valkey version `7.2` and above, Redis OSS version `3.2.6`, or Redis OSS version `4.x` and above, 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###### Note\nTransitEncryptionEnabled is required when creating a new valkey replication group.\nDefault: `false`\n###### Important\nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "TransitEncryptionMode": { "MarkdownDocumentation": "`TransitEncryptionMode`\n\nA setting that allows you to migrate your clients to use in-transit encryption, with\nno downtime.\nWhen setting `TransitEncryptionEnabled` to `true`, you can set\nyour `TransitEncryptionMode` to `preferred` in the same request,\nto allow both encrypted and unencrypted connections at the same time. Once you migrate\nall your Valkey or Redis OSS clients to use encrypted connections you can modify the value to\n`required` to allow encrypted connections only.\nSetting `TransitEncryptionMode` to `required` is a two-step\nprocess that requires you to first set the `TransitEncryptionMode` to\n`preferred`, after that you can set `TransitEncryptionMode` to\n`required`.\nThis process will not trigger the replacement of the replication group.\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)", "RefReturnValue": "", "AllowedValues": [ "preferred", "required" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionmode", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "UserGroupIds": { "MarkdownDocumentation": "`UserGroupIds`\n\nThe ID of user group to associate with the replication group.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-usergroupids", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::ElastiCache::SecurityGroup": { "MarkdownDocumentation": "`AWS::ElastiCache::SecurityGroup`\n\nThe `AWS::ElastiCache::SecurityGroup` resource creates a cache security group. For more information\nabout cache security groups, go to [CacheSecurityGroups](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/VPCs.html) in the *Amazon ElastiCache User Guide* or go to [CreateCacheSecurityGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSecurityGroup.html) in the *Amazon ElastiCache API Reference Guide*.\nFor more information, see [CreateCacheSubnetGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the cache security 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group.html#cfn-elasticache-securitygroup-description", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA tag that can be added to an ElastiCache security group. Tags are composed of a Key/Value pair. You can use\ntags to categorize and track all your security groups. A tag with a null Value is permitted.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticache-securitygroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group.html#cfn-elasticache-securitygroup-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::ElastiCache::SecurityGroupIngress": { "MarkdownDocumentation": "`AWS::ElastiCache::SecurityGroupIngress`\n\nThe AWS::ElastiCache::SecurityGroupIngress type authorizes ingress to a cache security group from hosts in\nspecified Amazon EC2 security groups. For more information about ElastiCache security group ingress, go to [AuthorizeCacheSecurityGroupIngress](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_AuthorizeCacheSecurityGroupIngress.html) in the *Amazon ElastiCache API Reference Guide*.\n###### Note\nUpdates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html", "Properties": { "CacheSecurityGroupName": { "MarkdownDocumentation": "`CacheSecurityGroupName`\n\nThe name of the Cache Security Group to authorize.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-cachesecuritygroupname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "EC2SecurityGroupName": { "MarkdownDocumentation": "`EC2SecurityGroupName`\n\nName of the EC2 Security Group to include in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-ec2securitygroupname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "EC2SecurityGroupOwnerId": { "MarkdownDocumentation": "`EC2SecurityGroupOwnerId`\n\nSpecifies the Amazon Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName\nproperty. The Amazon access key ID is not an acceptable 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-ec2securitygroupownerid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::ElastiCache::ServerlessCache": { "MarkdownDocumentation": "`AWS::ElastiCache::ServerlessCache`\n\nThe resource representing a serverless cache.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the serverless cache.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FinalSnapshotName": { "MarkdownDocumentation": "`FinalSnapshotName`\n\nThe name of the final snapshot taken of a cache before the cache is deleted.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-finalsnapshotname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserGroupId": { "MarkdownDocumentation": "`UserGroupId`\n\nThe identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-usergroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CacheUsageLimits": { "MarkdownDocumentation": "`CacheUsageLimits`\n\nThe cache usage limit for the serverless cache.\n*Required*: No\n*Type*: [CacheUsageLimits](./aws-properties-elasticache-serverlesscache-cacheusagelimits.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-cacheusagelimits", "UpdateType": "Mutable", "Required": false, "Type": "CacheUsageLimits" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the EC2 security groups associated with the serverless\ncache.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SnapshotArnsToRestore": { "MarkdownDocumentation": "`SnapshotArnsToRestore`\n\nThe ARN of the snapshot from which to restore data into the new cache.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-snapshotarnstorestore", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nIf no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.\nFor all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-subnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "DailySnapshotTime": { "MarkdownDocumentation": "`DailySnapshotTime`\n\nThe daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a\nspecific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-dailysnapshottime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReaderEndpoint": { "MarkdownDocumentation": "`ReaderEndpoint`\n\nRepresents the information required for client programs to connect to a cache\nnode. This value is read-only.\n*Required*: No\n*Type*: [Endpoint](./aws-properties-elasticache-serverlesscache-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-readerendpoint", "UpdateType": "Mutable", "Required": false, "Type": "Endpoint" }, "SnapshotRetentionLimit": { "MarkdownDocumentation": "`SnapshotRetentionLimit`\n\nThe current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS and Serverless Memcached 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-snapshotretentionlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nRepresents the information required for client programs to connect to a cache\nnode. This value is read-only.\n*Required*: No\n*Type*: [Endpoint](./aws-properties-elasticache-serverlesscache-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-endpoint", "UpdateType": "Mutable", "Required": false, "Type": "Endpoint" }, "ServerlessCacheName": { "MarkdownDocumentation": "`ServerlessCacheName`\n\nThe unique identifier of the serverless cache.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-serverlesscachename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MajorEngineVersion": { "MarkdownDocumentation": "`MajorEngineVersion`\n\nThe version number of the engine the serverless cache is compatible 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-majorengineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe engine the serverless cache is compatible with.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-engine", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to be added to this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticache-serverlesscache-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#Status-fn::getatt" }, "Endpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.Address`\n\nThe DNS hostname of the cache node.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#Endpoint.Address-fn::getatt" }, "FullEngineVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`FullEngineVersion`\n\nThe name and version number of the engine the serverless cache is compatible with.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#FullEngineVersion-fn::getatt" }, "ReaderEndpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReaderEndpoint.Address`\n\nThe port used by the reader endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#ReaderEndpoint.Address-fn::getatt" }, "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nWhen the serverless cache was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#CreateTime-fn::getatt" }, "ReaderEndpoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReaderEndpoint.Port`\n\nThe port used by the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#ReaderEndpoint.Port-fn::getatt" }, "Endpoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.Port`\n\nThe port number that the cache engine is listening on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#Endpoint.Port-fn::getatt" }, "ARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ARN`\n\nThe Amazon Resource Name (ARN) of the serverless cache.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#ARN-fn::getatt" } } }, "AWS::ElastiCache::SubnetGroup": { "MarkdownDocumentation": "`AWS::ElastiCache::SubnetGroup`\n\nCreates a cache subnet group. For more information about cache subnet groups, go to Cache Subnet Groups in the\n*Amazon ElastiCache User Guide* or go to [CreateCacheSubnetGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html) in the\n*Amazon ElastiCache API Reference Guide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource\nname.\nFor more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the cache 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CacheSubnetGroupName": { "MarkdownDocumentation": "`CacheSubnetGroupName`\n\nThe name for the cache subnet group. This value is stored as a lowercase\nstring.\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-cachesubnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe EC2 subnet IDs for the cache subnet group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags\nto categorize and track all your subnet groups. A tag with a null Value is permitted.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticache-subnetgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::ElastiCache::User": { "MarkdownDocumentation": "`AWS::ElastiCache::User`\n\nFor Valkey 7.2 and onwards, or Redis OSS engine version 6.0 and onwards: Creates user. For more information, see [Using Role Based Access Control\n(RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html).\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref`\nreturns the resource name.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html", "Properties": { "AuthenticationMode": { "MarkdownDocumentation": "`AuthenticationMode`\n\nSpecifies the authentication mode to use. Below is an example of the possible JSON values:\n```\n{\n Passwords: [\"*****\", \"******\"] // If Type is password.\n}\n```\n*Required*: No\n*Type*: [AuthenticationMode](./aws-properties-elasticache-user-authenticationmode.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-authenticationmode", "UpdateType": "Mutable", "Required": false, "Type": "AuthenticationMode" }, "UserName": { "MarkdownDocumentation": "`UserName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-username", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NoPasswordRequired": { "MarkdownDocumentation": "`NoPasswordRequired`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-nopasswordrequired", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AccessString": { "MarkdownDocumentation": "`AccessString`\n\nAccess 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-accessstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserId": { "MarkdownDocumentation": "`UserId`\n\nThe ID of the user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\\\-]*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-userid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Passwords": { "MarkdownDocumentation": "`Passwords`\n\nPasswords used for this user. You can create up to two passwords for each user.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-passwords", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe current supported values are valkey and redis.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `redis | valkey...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "redis", "valkey" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-engine", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticache-user-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nIndicates the user status. Can be \"active\", \"modifying\" or \"deleting\".\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#Status-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the user.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#Arn-fn::getatt" } } }, "AWS::ElastiCache::UserGroup": { "MarkdownDocumentation": "`AWS::ElastiCache::UserGroup`\n\nFor Valkey 7.2 and onwards, or Redis OSS 6.0 and onwards: Creates a user group. For more information, see [Using Role Based Access Control\n(RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html)\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref`\nreturns the resource name.\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html", "Properties": { "UserGroupId": { "MarkdownDocumentation": "`UserGroupId`\n\nThe ID of the user group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\\\-]*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-usergroupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe current supported values are valkey and redis.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `redis | valkey...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "redis", "valkey" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-engine", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UserIds": { "MarkdownDocumentation": "`UserIds`\n\nThe list of user IDs that belong to the user group. A user named `default` must be included.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-userids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticache-usergroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nIndicates user group status. Can be \"creating\", \"active\", \"modifying\",\n\"deleting\".\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#Status-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the user group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#Arn-fn::getatt" } } }, "AWS::ElasticBeanstalk::Application": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::Application`\n\nThe AWS::ElasticBeanstalk::Application resource is an AWS Elastic Beanstalk Beanstalk resource\ntype that specifies an Elastic Beanstalk application.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html", "Properties": { "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nA name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. For\nmore information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must replace\nthe resource, specify a new name.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-applicationname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nYour description of the application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceLifecycleConfig": { "MarkdownDocumentation": "`ResourceLifecycleConfig`\n\nSpecifies an application resource lifecycle configuration to prevent your application from\naccumulating too many versions.\n*Required*: No\n*Type*: [ApplicationResourceLifecycleConfig](./aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-resourcelifecycleconfig", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationResourceLifecycleConfig" } } }, "AWS::ElasticBeanstalk::ApplicationVersion": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::ApplicationVersion`\n\nThe AWS::ElasticBeanstalk::ApplicationVersion resource is an AWS Elastic Beanstalk\nresource type that specifies an application version, an iteration of deployable code, for an\nElastic Beanstalk application.\n###### Note\nAfter you create an application version with a specified Amazon S3 bucket and key\nlocation, you can't change that Amazon S3 location. If you change the Amazon S3 location, an\nattempt to launch an environment from the application version will fail.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html", "Properties": { "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nThe name of the Elastic Beanstalk application that is associated with this application\nversion.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html#cfn-elasticbeanstalk-applicationversion-applicationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html#cfn-elasticbeanstalk-applicationversion-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceBundle": { "MarkdownDocumentation": "`SourceBundle`\n\nThe Amazon S3 bucket and key that identify the location of the source bundle for this\nversion.\n###### Note\nThe Amazon S3 bucket must be in the same region as the\nenvironment.\n*Required*: Yes\n*Type*: [SourceBundle](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html#cfn-elasticbeanstalk-applicationversion-sourcebundle", "UpdateType": "Immutable", "Required": true, "Type": "SourceBundle" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html#Id-fn::getatt" } } }, "AWS::ElasticBeanstalk::ConfigurationTemplate": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::ConfigurationTemplate`\n\nThe AWS::ElasticBeanstalk::ConfigurationTemplate resource is an AWS Elastic Beanstalk\nresource type that specifies an Elastic Beanstalk configuration template, associated with a\nspecific Elastic Beanstalk application. You define application configuration settings in a\nconfiguration template. You can then use the configuration template to deploy different\nversions of the application with the same configuration settings.\n###### Note\nThe Elastic Beanstalk console and documentation often refer to configuration templates\nas *saved configurations*. When you set configuration options in a saved\nconfiguration (configuration template), Elastic Beanstalk applies them with a particular\nprecedence as part of applying options from multiple sources. For more information, see\n[Configuration Options](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the *AWS Elastic Beanstalk Developer\nGuide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html", "Properties": { "EnvironmentId": { "MarkdownDocumentation": "`EnvironmentId`\n\nThe ID of an environment whose settings you want to use to create the configuration\ntemplate. You must specify `EnvironmentId` if you don't specify\n`PlatformArn`, `SolutionStackName`, or\n`SourceConfiguration`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-environmentid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PlatformArn": { "MarkdownDocumentation": "`PlatformArn`\n\nThe Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the *AWS Elastic Beanstalk Developer Guide*.\n###### Note\nIf you specify `PlatformArn`, then don't specify `SolutionStackName`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-platformarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nThe name of the Elastic Beanstalk application to associate with this configuration\ntemplate.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-applicationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description for this configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OptionSettings": { "MarkdownDocumentation": "`OptionSettings`\n\nOption values for the Elastic Beanstalk configuration, such as the instance type. If specified, these\nvalues override the values obtained from the solution stack or the source configuration\ntemplate. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the\n*AWS Elastic Beanstalk Developer Guide*.\n*Required*: No\n*Type*: Array of [ConfigurationOptionSetting](./aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-optionsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConfigurationOptionSetting", "DuplicatesAllowed": true }, "SourceConfiguration": { "MarkdownDocumentation": "`SourceConfiguration`\n\nAn Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified\nconfiguration template to create a new configuration.\nValues specified in `OptionSettings` override any values obtained from the\n`SourceConfiguration`.\nYou must specify `SourceConfiguration` if you don't specify\n`PlatformArn`, `EnvironmentId`, or\n`SolutionStackName`.\nConstraint: If both solution stack name and source configuration are specified, the\nsolution stack of the source configuration template must match the specified solution stack\nname.\n*Required*: Conditional\n*Type*: [SourceConfiguration](./aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "SourceConfiguration" }, "SolutionStackName": { "MarkdownDocumentation": "`SolutionStackName`\n\nThe name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For\nexample, `64bit Amazon Linux 2013.09 running Tomcat 7 Java 7`. A solution stack\nspecifies the operating system, runtime, and application server for a configuration template.\nIt also determines the set of configuration options as well as the possible and default\nvalues. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the\n*AWS Elastic Beanstalk Developer Guide*.\nYou must specify `SolutionStackName` if you don't specify\n`PlatformArn`, `EnvironmentId`, or\n`SourceConfiguration`.\nUse the [`ListAvailableSolutionStacks`](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html) API to obtain a list of available\nsolution stacks.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-solutionstackname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "TemplateName": { "PrimitiveType": "String", "MarkdownDocumentation": "`TemplateName`\n\nThe name of the configuration template.\nConstraint: This name must be unique per application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#TemplateName-fn::getatt" } } }, "AWS::ElasticBeanstalk::Environment": { "MarkdownDocumentation": "`AWS::ElasticBeanstalk::Environment`\n\nThe AWS::ElasticBeanstalk::Environment resource is an AWS Elastic Beanstalk resource\ntype that specifies an Elastic Beanstalk environment.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html", "Properties": { "PlatformArn": { "MarkdownDocumentation": "`PlatformArn`\n\nThe Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the *AWS Elastic Beanstalk Developer Guide*.\n###### Note\nIf you specify `PlatformArn`, don't specify `SolutionStackName`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-platformarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nThe name of the application that is associated with this environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-applicationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nYour description for this environment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentName": { "MarkdownDocumentation": "`EnvironmentName`\n\nA unique name for the environment.\nConstraint: Must be from 4 to 40 characters in length. The name can contain only\nletters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique\nwithin a region in your account.\nIf you don't specify the `CNAMEPrefix` parameter, the environment name becomes part of\nthe CNAME, and therefore part of the visible URL for your application.\nIf you don't specify an environment name, AWS CloudFormation generates a unique physical\nID and uses that ID for the environment name. For more information, see [Name\nType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must replace\nthe resource, specify a new name.\n*Required*: No\n*Type*: String\n*Minimum*: `4`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-environmentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OperationsRole": { "MarkdownDocumentation": "`OperationsRole`\n\n###### Important\nThe operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.\nThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role\nfor permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must\nhave the `iam:PassRole` permission for the role.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-operationsrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tier": { "MarkdownDocumentation": "`Tier`\n\nSpecifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support\na web application that handles HTTP(S) requests or a web application that handles background-processing tasks.\n*Required*: No\n*Type*: [Tier](./aws-properties-elasticbeanstalk-environment-tier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-tier", "UpdateType": "Mutable", "Required": false, "Type": "Tier" }, "OptionSettings": { "MarkdownDocumentation": "`OptionSettings`\n\nKey-value pairs defining configuration options for this environment, such as the instance\ntype. These options override the values that are defined in the solution stack or the [configuration template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html).\nIf you remove any options during a stack update, the removed options retain their current values.\n*Required*: No\n*Type*: Array of [OptionSetting](./aws-properties-elasticbeanstalk-environment-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-optionsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OptionSetting", "DuplicatesAllowed": true }, "VersionLabel": { "MarkdownDocumentation": "`VersionLabel`\n\nThe name of the application version to deploy.\nDefault: If not specified, Elastic Beanstalk attempts to deploy the sample application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-versionlabel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TemplateName": { "MarkdownDocumentation": "`TemplateName`\n\nThe name of the Elastic Beanstalk configuration template to use with the environment.\n###### Note\nIf you specify `TemplateName`, then don't specify `SolutionStackName`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-templatename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SolutionStackName": { "MarkdownDocumentation": "`SolutionStackName`\n\nThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default\nvalues associated with the specified solution stack. For a list of current solution stacks, see [Elastic Beanstalk Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) in the *AWS Elastic Beanstalk\nPlatforms* guide.\n###### Note\nIf you specify `SolutionStackName`, don't specify `PlatformArn` or `TemplateName`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-solutionstackname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CNAMEPrefix": { "MarkdownDocumentation": "`CNAMEPrefix`\n\nIf specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is\ngenerated automatically by appending a random alphanumeric string to the environment name.\n*Required*: No\n*Type*: String\n*Minimum*: `4`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-cnameprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies the tags applied to resources in the environment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticbeanstalk-environment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "EndpointURL": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointURL`\n\nFor load-balanced, autoscaling environments, the URL to the load balancer.\nFor single-instance environments, the IP address of the instance.\nExample load balancer URL:\n`awseb-myst-myen-132MQC4KRLAMD-1371280482.us-east-2.elb.amazonaws.com`\nExample instance IP address:\n`192.0.2.0`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#EndpointURL-fn::getatt" } } }, "AWS::ElasticLoadBalancing::LoadBalancer": { "Attributes": { "CanonicalHostedZoneName": { "PrimitiveType": "String", "MarkdownDocumentation": "`CanonicalHostedZoneName`\n\nThe name of the Route 53 hosted zone that is associated with the load balancer. Internal-facing load balancers don't use this value,\nuse `DNSName` instead.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#CanonicalHostedZoneName-fn::getatt" }, "CanonicalHostedZoneNameID": { "PrimitiveType": "String", "MarkdownDocumentation": "`CanonicalHostedZoneNameID`\n\nThe ID of the Route 53 hosted zone name that is associated with the load balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#CanonicalHostedZoneNameID-fn::getatt" }, "DNSName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DNSName`\n\nThe DNS name for the load balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#DNSName-fn::getatt" }, "SourceSecurityGroup.GroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceSecurityGroup.GroupName`\n\nThe name of the security group that you can use as part of your inbound rules for your load balancer's back-end instances.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#SourceSecurityGroup.GroupName-fn::getatt" }, "SourceSecurityGroup.OwnerAlias": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceSecurityGroup.OwnerAlias`\n\nThe owner of the source security group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#SourceSecurityGroup.OwnerAlias-fn::getatt" } }, "MarkdownDocumentation": "`AWS::ElasticLoadBalancing::LoadBalancer`\n\nSpecifies a Classic Load Balancer.\nIf this resource has a public IP address and is also in a VPC that is defined in the same template, you must use\nthe [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)\nto declare a dependency on the VPC-gateway attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html", "Properties": { "AccessLoggingPolicy": { "MarkdownDocumentation": "`AccessLoggingPolicy`\n\nInformation about where and how access logs are stored for the load balancer.\n*Required*: No\n*Type*: [AccessLoggingPolicy](./aws-properties-elasticloadbalancing-loadbalancer-accessloggingpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-accessloggingpolicy", "Required": false, "Type": "AccessLoggingPolicy", "UpdateType": "Mutable" }, "AppCookieStickinessPolicy": { "MarkdownDocumentation": "`AppCookieStickinessPolicy`\n\nInformation about a policy for application-controlled session stickiness.\n*Required*: No\n*Type*: [Array](./aws-properties-elasticloadbalancing-loadbalancer-appcookiestickinesspolicy.html) of [AppCookieStickinessPolicy](./aws-properties-elasticloadbalancing-loadbalancer-appcookiestickinesspolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-appcookiestickinesspolicy", "DuplicatesAllowed": false, "ItemType": "AppCookieStickinessPolicy", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "AvailabilityZones": { "MarkdownDocumentation": "`AvailabilityZones`\n\nThe Availability Zones for a load balancer in a default VPC. For a load balancer in a nondefault VPC, specify `Subnets` instead.\nUpdate requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones.\nOtherwise, update requires no interruption.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-availabilityzones", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Conditional" }, "ConnectionDrainingPolicy": { "MarkdownDocumentation": "`ConnectionDrainingPolicy`\n\nIf enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.\nFor more information, see [Configure connection draining](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html)\nin the *User Guide for Classic Load Balancers*.\n*Required*: No\n*Type*: [ConnectionDrainingPolicy](./aws-properties-elasticloadbalancing-loadbalancer-connectiondrainingpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-connectiondrainingpolicy", "Required": false, "Type": "ConnectionDrainingPolicy", "UpdateType": "Mutable" }, "ConnectionSettings": { "MarkdownDocumentation": "`ConnectionSettings`\n\nIf enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.\nBy default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer.\nFor more information, see [Configure idle connection timeout](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html)\nin the *User Guide for Classic Load Balancers*.\n*Required*: No\n*Type*: [ConnectionSettings](./aws-properties-elasticloadbalancing-loadbalancer-connectionsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-connectionsettings", "Required": false, "Type": "ConnectionSettings", "UpdateType": "Mutable" }, "CrossZone": { "MarkdownDocumentation": "`CrossZone`\n\nIf enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.\nFor more information, see [Configure cross-zone load balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html)\nin the *User Guide for Classic Load Balancers*.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-crosszone", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "HealthCheck": { "MarkdownDocumentation": "`HealthCheck`\n\nThe health check settings to use when evaluating the health of your EC2 instances.\nUpdate requires replacement if you did not previously specify health check settings or if you are removing the health check settings.\nOtherwise, update requires no interruption.\n*Required*: No\n*Type*: [HealthCheck](./aws-properties-elasticloadbalancing-loadbalancer-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-healthcheck", "Required": false, "Type": "HealthCheck", "UpdateType": "Conditional" }, "Instances": { "MarkdownDocumentation": "`Instances`\n\nThe IDs of the instances for the load balancer.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-instances", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "LBCookieStickinessPolicy": { "MarkdownDocumentation": "`LBCookieStickinessPolicy`\n\nInformation about a policy for duration-based session stickiness.\n*Required*: No\n*Type*: [Array](./aws-properties-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy.html) of [LBCookieStickinessPolicy](./aws-properties-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-lbcookiestickinesspolicy", "DuplicatesAllowed": false, "ItemType": "LBCookieStickinessPolicy", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Listeners": { "MarkdownDocumentation": "`Listeners`\n\nThe listeners for the load balancer. You can specify at most one listener per port.\nIf you update the properties for a listener, AWS CloudFormation deletes the existing listener and\ncreates a new one with the specified properties. While the new listener is being created, clients\ncannot connect to the load balancer.\n*Required*: Yes\n*Type*: [Array](./aws-properties-elasticloadbalancing-loadbalancer-listeners.html) of [Listeners](./aws-properties-elasticloadbalancing-loadbalancer-listeners.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-listeners", "DuplicatesAllowed": false, "ItemType": "Listeners", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "LoadBalancerName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-elbname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Policies": { "MarkdownDocumentation": "`Policies`\n\nThe policies defined for your Classic Load Balancer. Specify only back-end server policies.\n*Required*: No\n*Type*: [Array](./aws-properties-elasticloadbalancing-loadbalancer-policies.html) of [Policies](./aws-properties-elasticloadbalancing-loadbalancer-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-policies", "DuplicatesAllowed": false, "ItemType": "Policies", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Scheme": { "MarkdownDocumentation": "`Scheme`\n\nThe type of load balancer. Valid only for load balancers in a VPC.\nIf `Scheme` is `internet-facing`, the load balancer\nhas a public DNS name that resolves to a public IP address.\nIf `Scheme` is `internal`, the load balancer has a public\nDNS name that resolves to a private IP address.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-scheme", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security groups for the load balancer. Valid only for load balancers in a VPC.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-securitygroups", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.\nUpdate requires replacement if you did not previously specify a subnet or if you are removing all subnets.\nOtherwise, update requires no interruption. To update to a different subnet in the current Availability Zone,\nyou must first update to a subnet in a different Availability Zone, then update to the new subnet in the original\nAvailability Zone.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-subnets", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Conditional" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with a load balancer.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticloadbalancing-loadbalancer-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-elasticloadbalancing-loadbalancer-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::ElasticLoadBalancingV2::Listener": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::Listener`\n\nSpecifies a listener for an Application Load Balancer, Network Load Balancer, or\nGateway Load Balancer.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the listener.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html", "Properties": { "MutualAuthentication": { "MarkdownDocumentation": "`MutualAuthentication`\n\nThe mutual authentication configuration information.\n*Required*: No\n*Type*: [MutualAuthentication](./aws-properties-elasticloadbalancingv2-listener-mutualauthentication.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-mutualauthentication", "UpdateType": "Mutable", "Required": false, "Type": "MutualAuthentication" }, "ListenerAttributes": { "MarkdownDocumentation": "`ListenerAttributes`\n\nThe listener attributes. Attributes that you do not modify retain their current values.\n*Required*: No\n*Type*: Array of [ListenerAttribute](./aws-properties-elasticloadbalancingv2-listener-listenerattribute.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-listenerattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ListenerAttribute", "DuplicatesAllowed": false }, "AlpnPolicy": { "MarkdownDocumentation": "`AlpnPolicy`\n\n[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN)\npolicy.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-alpnpolicy", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SslPolicy": { "MarkdownDocumentation": "`SslPolicy`\n\n[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.\nFor more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/describe-ssl-policies.html)\nin the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/describe-ssl-policies.html)\nin the *Network Load Balancers Guide*.\n[HTTPS listeners] Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.\nTo decrease the possibility of an interruption if your load balancer is handling a high volume of traffic,\ncreate an additional load balancer or request an LCU reservation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancerArn": { "MarkdownDocumentation": "`LoadBalancerArn`\n\nThe Amazon Resource Name (ARN) of the load balancer.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-loadbalancerarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DefaultActions": { "MarkdownDocumentation": "`DefaultActions`\n\nThe actions for the default rule. You cannot define a condition for a default\nrule.\nTo create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).\n*Required*: Yes\n*Type*: Array of [Action](./aws-properties-elasticloadbalancingv2-listener-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Action", "DuplicatesAllowed": false }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port on which the load balancer is listening. You can't specify a port for a Gateway\nLoad Balancer.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Certificates": { "MarkdownDocumentation": "`Certificates`\n\nThe default SSL server certificate for a secure listener. You must provide exactly one\ncertificate if the listener protocol is HTTPS or TLS.\nFor an HTTPS listener, update requires some interruptions. For a TLS listener, update requires no interruption.\nTo create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).\n*Required*: Conditional\n*Type*: Array of [Certificate](./aws-properties-elasticloadbalancingv2-listener-certificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Certificate", "DuplicatesAllowed": false }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol for connections from clients to the load balancer. For Application Load\nBalancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the\nsupported protocols are TCP, TLS, UDP, TCP\\_UDP, QUIC, and TCP\\_QUIC. You can\u2019t specify the UDP, TCP\\_UDP, QUIC, or TCP\\_QUIC\nprotocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load\nBalancer.\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTP | HTTPS | TCP | TLS | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ListenerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ListenerArn`\n\nThe Amazon Resource Name (ARN) of the listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#ListenerArn-fn::getatt" } } }, "AWS::ElasticLoadBalancingV2::ListenerCertificate": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerCertificate`\n\nSpecifies an SSL server certificate to add to the certificate list for an HTTPS or TLS\nlistener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html", "Properties": { "Certificates": { "MarkdownDocumentation": "`Certificates`\n\nThe certificate. You can specify one certificate per resource.\n*Required*: Yes\n*Type*: Array of [Certificate](./aws-properties-elasticloadbalancingv2-listenercertificate-certificate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-certificates", "DuplicatesAllowed": false, "ItemType": "Certificate", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "ListenerArn": { "MarkdownDocumentation": "`ListenerArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-listenerarn", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::ElasticLoadBalancingV2::ListenerRule": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::ListenerRule`\n\nSpecifies a listener rule. The listener must be associated with an Application Load\nBalancer. Each rule consists of a priority, one or more actions, and one or more\nconditions.\nFor more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the\n*User Guide for Application Load Balancers*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the listener rule.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html", "Properties": { "ListenerArn": { "MarkdownDocumentation": "`ListenerArn`\n\nThe Amazon Resource Name (ARN) of the listener.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-listenerarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions.\nThe rule must include exactly one of the following types of actions:\n`forward`, `fixed-response`, or `redirect`, and it must\nbe the last action to be performed. If the rule is for an HTTPS listener, it can also\noptionally include an authentication action.\n*Required*: Yes\n*Type*: Array of [Action](./aws-properties-elasticloadbalancingv2-listenerrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Action", "DuplicatesAllowed": false }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe rule priority. A listener can't have multiple rules with the same priority.\nIf you try to reorder rules by updating their priorities, do not specify a new priority\nif an existing rule already uses this priority, as this can cause an error. If you need to\nreuse a priority with a different rule, you must remove it as a priority first, and then\nspecify it in a subsequent update.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Transforms": { "MarkdownDocumentation": "`Transforms`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Transform](./aws-properties-elasticloadbalancingv2-listenerrule-transform.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-transforms", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Transform", "DuplicatesAllowed": false }, "Conditions": { "MarkdownDocumentation": "`Conditions`\n\nThe conditions.\nThe rule can optionally include up to one of each of the following conditions:\n`http-request-method`, `host-header`, `path-pattern`,\nand `source-ip`. A rule can also optionally include one or more of each of the\nfollowing conditions: `http-header` and `query-string`.\n*Required*: Yes\n*Type*: Array of [RuleCondition](./aws-properties-elasticloadbalancingv2-listenerrule-rulecondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-conditions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RuleCondition", "DuplicatesAllowed": false } }, "Attributes": { "IsDefault": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefault`\n\nIndicates whether this is the default rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#IsDefault-fn::getatt" }, "RuleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleArn`\n\nThe Amazon Resource Name (ARN) of the rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#RuleArn-fn::getatt" } } }, "AWS::ElasticLoadBalancingV2::LoadBalancer": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::LoadBalancer`\n\nSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load\nBalancer.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the load balancer.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address type. Internal load balancers must use `ipv4`.\n[Application Load Balancers] The possible values are `ipv4` (IPv4 addresses),\n`dualstack` (IPv4 and IPv6 addresses), and `dualstack-without-public-ipv4`\n(public IPv6 addresses and private IPv4 and IPv6 addresses).\nApplication Load Balancer authentication supports IPv4 addresses only when\nconnecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public\nIPv4 address the load balancer can't complete the authentication process, resulting\nin HTTP 500 errors.\n[Network Load Balancers and Gateway Load Balancers] The possible values are `ipv4`\n(IPv4 addresses) and `dualstack` (IPv4 and IPv6 addresses).\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | dualstack | dualstac...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "dualstack", "dualstack-without-public-ipv4" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\n[Application Load Balancers and Network Load Balancers] The IDs of the security groups for\nthe load balancer.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-securitygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "LoadBalancerAttributes": { "MarkdownDocumentation": "`LoadBalancerAttributes`\n\nThe load balancer attributes. Attributes that you do not modify retain their current values.\n*Required*: No\n*Type*: Array of [LoadBalancerAttribute](./aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattribute.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LoadBalancerAttribute", "DuplicatesAllowed": false }, "Scheme": { "MarkdownDocumentation": "`Scheme`\n\nThe nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an\nInternet-facing load balancer is publicly resolvable to the public IP addresses of the nodes.\nTherefore, Internet-facing load balancers can route requests from clients over the\ninternet.\nThe nodes of an internal load balancer have only private IP addresses. The DNS name of an\ninternal load balancer is publicly resolvable to the private IP addresses of the nodes.\nTherefore, internal load balancers can route requests only from clients with access to the VPC\nfor the load balancer.\nThe default is an Internet-facing load balancer.\nYou can't specify a scheme for a Gateway Load Balancer.\n*Required*: No\n*Type*: String\n*Allowed values*: `internet-facing | internal...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "internet-facing", "internal" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-scheme", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the load balancer. This name must be unique per region per account, can have\na maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not\nbegin or end with a hyphen, and must not begin with \"internal-\".\nIf you don't specify a name, AWS CloudFormation generates a unique\nphysical ID for the load balancer. If you specify a name, you cannot perform updates that\nrequire replacement of this resource, but you can perform other updates. To replace the\nresource, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnableCapacityReservationProvisionStabilize": { "MarkdownDocumentation": "`EnableCapacityReservationProvisionStabilize`\n\nIndicates whether to enable stabilization when creating or updating an LCU reservation.\nThis ensures that the final stack status reflects the status of the LCU reservation.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-enablecapacityreservationprovisionstabilize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Subnets": { "MarkdownDocumentation": "`Subnets`\n\nThe IDs of the subnets. You can specify only one subnet per Availability Zone. You\nmust specify either subnets or subnet mappings, but not both. To specify an Elastic IP\naddress, specify subnet mappings instead of subnets.\n[Application Load Balancers] You must specify subnets from at least two Availability\nZones.\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\nZones.\n[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more\nAvailability Zones.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnets", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of load balancer. The default is `application`.\n*Required*: No\n*Type*: String\n*Allowed values*: `application | network | gat...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "application", "network", "gateway" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MinimumLoadBalancerCapacity": { "MarkdownDocumentation": "`MinimumLoadBalancerCapacity`\n\nThe minimum capacity for a load balancer.\n*Required*: No\n*Type*: [MinimumLoadBalancerCapacity](./aws-properties-elasticloadbalancingv2-loadbalancer-minimumloadbalancercapacity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-minimumloadbalancercapacity", "UpdateType": "Mutable", "Required": false, "Type": "MinimumLoadBalancerCapacity" }, "EnablePrefixForIpv6SourceNat": { "MarkdownDocumentation": "`EnablePrefixForIpv6SourceNat`\n\n[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix\nfrom each subnet for source NAT. The IP address type must be `dualstack`.\nThe default value is `off`.\n*Required*: No\n*Type*: String\n*Allowed values*: `on | off`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "on", "off" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-enableprefixforipv6sourcenat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Ipv4IpamPoolId": { "MarkdownDocumentation": "`Ipv4IpamPoolId`\n\nThe ID of the IPv4 IPAM pool.\n*Required*: No\n*Type*: String\n*Pattern*: `^(ipam-pool-)[a-zA-Z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-ipv4ipampoolid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { "MarkdownDocumentation": "`EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic`\n\nIndicates whether to evaluate inbound security group rules for traffic sent to a\nNetwork Load Balancer through AWS PrivateLink. The default is `on`.\nYou can't configure this property on a Network Load Balancer unless you associated a\nsecurity group with the load balancer when you created it.\n*Required*: No\n*Type*: String\n*Allowed values*: `on | off`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "on", "off" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-enforcesecuritygroupinboundrulesonprivatelinktraffic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the load balancer.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticloadbalancingv2-loadbalancer-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "SubnetMappings": { "MarkdownDocumentation": "`SubnetMappings`\n\nThe IDs of the subnets. You can specify only one subnet per Availability Zone. You\nmust specify either subnets or subnet mappings, but not both.\n[Application Load Balancers] You must specify subnets from at least two Availability\nZones. You can't specify Elastic IP addresses for your subnets.\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\nZones.\n[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\ncan specify one Elastic IP address per subnet if you need static IP addresses for your\ninternet-facing load balancer. For internal load balancers, you can specify one private IP\naddress per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\ncan specify one IPv6 address per subnet.\n[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You\ncan't specify Elastic IP addresses for your subnets.\n*Required*: Conditional\n*Type*: Array of [SubnetMapping](./aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SubnetMapping", "DuplicatesAllowed": false } }, "Attributes": { "SecurityGroups": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`SecurityGroups`\n\nThe IDs of the security groups for the load balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#SecurityGroups-fn::getatt" }, "LoadBalancerName": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoadBalancerName`\n\nThe name of the load balancer. For example, `my-load-balancer`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#LoadBalancerName-fn::getatt" }, "CanonicalHostedZoneID": { "PrimitiveType": "String", "MarkdownDocumentation": "`CanonicalHostedZoneID`\n\nThe ID of the Amazon Route 53 hosted zone associated with the load balancer. For\nexample, `Z2P70J7EXAMPLE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#CanonicalHostedZoneID-fn::getatt" }, "LoadBalancerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoadBalancerArn`\n\nThe Amazon Resource Name (ARN) of the load balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#LoadBalancerArn-fn::getatt" }, "DNSName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DNSName`\n\nThe DNS name for the load balancer. For example,\n`my-load-balancer-424835706.us-west-2.elb.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#DNSName-fn::getatt" }, "LoadBalancerFullName": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoadBalancerFullName`\n\nThe full name of the load balancer. For example,\n`app/my-load-balancer/50dc6c495c0c9188`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#LoadBalancerFullName-fn::getatt" } } }, "AWS::ElasticLoadBalancingV2::TargetGroup": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::TargetGroup`\n\nSpecifies a target group for an Application Load Balancer, a Network Load Balancer, or a\nGateway Load Balancer.\nBefore you register a Lambda function as a target, you must create a\n`AWS::Lambda::Permission` resource that grants the Elastic Load Balancing\nservice principal permission to invoke the Lambda function.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the target group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address type. The default value is `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)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-ipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HealthCheckIntervalSeconds": { "MarkdownDocumentation": "`HealthCheckIntervalSeconds`\n\nThe approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300.\nIf the target group protocol is TCP, TLS, UDP, TCP\\_UDP, QUIC, TCP\\_QUIC, HTTP or HTTPS, the default is 30 seconds.\nIf the target group protocol is GENEVE, the default is 10 seconds.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetControlPort": { "MarkdownDocumentation": "`TargetControlPort`\n\nThe port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetcontrolport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Matcher": { "MarkdownDocumentation": "`Matcher`\n\n[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful\nresponse from a target. For target groups with a protocol of TCP, TCP\\_UDP, UDP, QUIC, TCP\\_QUIC, or TLS the range\nis 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target\ngroups with a protocol of GENEVE, the range is 200-399.\n*Required*: No\n*Type*: [Matcher](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher", "UpdateType": "Mutable", "Required": false, "Type": "Matcher" }, "HealthCheckPath": { "MarkdownDocumentation": "`HealthCheckPath`\n\n[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\n/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port on which the targets receive traffic. This port is used unless you specify a port\noverride when registering the target. If the target is a Lambda function, this parameter does\nnot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-port", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe targets.\n*Required*: No\n*Type*: Array of [TargetDescription](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetDescription", "DuplicatesAllowed": false }, "HealthCheckEnabled": { "MarkdownDocumentation": "`HealthCheckEnabled`\n\nIndicates whether health checks are enabled. If the target type is `lambda`,\nhealth checks are disabled by default but can be enabled. If the target type is\n`instance`, `ip`, or `alb`, health checks are always\nenabled and can't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ProtocolVersion": { "MarkdownDocumentation": "`ProtocolVersion`\n\n[HTTP/HTTPS protocol] The protocol version. The possible values are `GRPC`,\n`HTTP1`, and `HTTP2`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocolversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UnhealthyThresholdCount": { "MarkdownDocumentation": "`UnhealthyThresholdCount`\n\nThe number of consecutive health check failures required before considering a target unhealthy. The range is\n2-10. If the target group protocol is TCP, TCP\\_UDP, UDP, TLS, QUIC, TCP\\_QUIC, HTTP or HTTPS, the default is 2. For target groups\nwith a protocol of GENEVE, the default is 2. If the target type\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-unhealthythresholdcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HealthCheckTimeoutSeconds": { "MarkdownDocumentation": "`HealthCheckTimeoutSeconds`\n\nThe amount of time, in seconds, during which no response from a target means a failed\nhealth check. The range is 2\u2013120 seconds. For target groups with a protocol of HTTP, the\ndefault is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default\nis 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthchecktimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the target group.\nThis name must be unique per region per account, can have a maximum of 32 characters, must\ncontain only alphanumeric characters or hyphens, and must not begin or end with a\nhyphen.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe identifier of the virtual private cloud (VPC). If the target is a Lambda function,\nthis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HealthyThresholdCount": { "MarkdownDocumentation": "`HealthyThresholdCount`\n\nThe number of consecutive health check successes required before considering a target healthy. The range is\n2-10. If the target group protocol is TCP, TCP\\_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups\nwith a protocol of GENEVE, the default is 5. If the target type\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthythresholdcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HealthCheckProtocol": { "MarkdownDocumentation": "`HealthCheckProtocol`\n\nThe protocol the load balancer uses when performing health checks on targets. For\nApplication Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load\nBalancers, the default is TCP. The TCP protocol is not supported for health checks if the\nprotocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, TCP\\_UDP, QUIC, and TCP\\_QUIC protocols are\nnot supported for health checks.\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTP | HTTPS | TCP | TLS | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetGroupAttributes": { "MarkdownDocumentation": "`TargetGroupAttributes`\n\nThe target group attributes. Attributes that you do not modify retain their current values.\n*Required*: No\n*Type*: Array of [TargetGroupAttribute](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetGroupAttribute", "DuplicatesAllowed": false }, "TargetType": { "MarkdownDocumentation": "`TargetType`\n\nThe type of target that you must specify when registering targets with this target group.\nYou 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\n value.\n* `ip` - Register targets by IP address. You can specify IP addresses from\n the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range\n (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).\n 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*: `instance | ip | lambda | al...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "instance", "ip", "lambda", "alb" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targettype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HealthCheckPort": { "MarkdownDocumentation": "`HealthCheckPort`\n\nThe port the load balancer uses when performing health checks on targets. If the protocol\nis HTTP, HTTPS, TCP, TLS, UDP, TCP\\_UDP, QUIC, or TCP\\_QUIC the default is `traffic-port`, which is\nthe port on which each target receives traffic from the load balancer. If the protocol is\nGENEVE, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol to use for routing traffic to the targets. For Application Load Balancers,\nthe supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported\nprotocols are TCP, TLS, UDP, TCP\\_UDP, QUIC, or TCP\\_QUIC. For Gateway Load Balancers, the supported protocol is\nGENEVE. A TCP\\_UDP listener must be associated with a TCP\\_UDP target group. A TCP\\_QUIC listener must be associated with a TCP\\_QUIC target group. If the target is a\nLambda function, this parameter does not apply.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `HTTP | HTTPS | TCP | TLS | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "HTTP", "HTTPS", "TCP", "TLS", "UDP", "TCP_UDP", "GENEVE", "QUIC", "TCP_QUIC" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticloadbalancingv2-targetgroup-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "TargetGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TargetGroupArn`\n\nThe Amazon Resource Name (ARN) of the target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#TargetGroupArn-fn::getatt" }, "LoadBalancerArns": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LoadBalancerArns`\n\nThe Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#LoadBalancerArns-fn::getatt" }, "TargetGroupFullName": { "PrimitiveType": "String", "MarkdownDocumentation": "`TargetGroupFullName`\n\nThe full name of the target group. For example, `targetgroup/my-target-group/cbf133c568e0d028`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#TargetGroupFullName-fn::getatt" }, "TargetGroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`TargetGroupName`\n\nThe name of the target group. For example, `my-target-group`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#TargetGroupName-fn::getatt" } } }, "AWS::ElasticLoadBalancingV2::TrustStore": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::TrustStore`\n\nCreates a trust store. You must specify `CaCertificatesBundleS3Bucket` and\n`CaCertificatesBundleS3Key`. When you create a trust store, you must specify\n`Name`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the trust store.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html", "Properties": { "CaCertificatesBundleS3Bucket": { "MarkdownDocumentation": "`CaCertificatesBundleS3Bucket`\n\nThe Amazon S3 bucket for the ca certificates bundle.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html#cfn-elasticloadbalancingv2-truststore-cacertificatesbundles3bucket", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CaCertificatesBundleS3ObjectVersion": { "MarkdownDocumentation": "`CaCertificatesBundleS3ObjectVersion`\n\nThe Amazon S3 object version for the ca certificates bundle. If undefined the current 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html#cfn-elasticloadbalancingv2-truststore-cacertificatesbundles3objectversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the trust store.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticloadbalancingv2-truststore-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html#cfn-elasticloadbalancingv2-truststore-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the trust store.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9]+-)*[a-zA-Z0-9]+$`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html#cfn-elasticloadbalancingv2-truststore-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CaCertificatesBundleS3Key": { "MarkdownDocumentation": "`CaCertificatesBundleS3Key`\n\nThe Amazon S3 path for the ca certificates bundle.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html#cfn-elasticloadbalancingv2-truststore-cacertificatesbundles3key", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the trust store. The possible values are `CREATING` and `ACTIVE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html#Status-fn::getatt" }, "TrustStoreArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrustStoreArn`\n\nThe Amazon Resource Name (ARN) of the trust store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html#TrustStoreArn-fn::getatt" }, "NumberOfCaCertificates": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`NumberOfCaCertificates`\n\nThe number of ca certificates in the trust store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html#NumberOfCaCertificates-fn::getatt" } } }, "AWS::ElasticLoadBalancingV2::TrustStoreRevocation": { "MarkdownDocumentation": "`AWS::ElasticLoadBalancingV2::TrustStoreRevocation`\n\nAdds the specified revocation contents to the specified trust store. You must specify `TrustStoreArn`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the trust store.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststorerevocation.html", "Properties": { "RevocationContents": { "MarkdownDocumentation": "`RevocationContents`\n\nThe revocation file to add.\n*Required*: No\n*Type*: Array of [RevocationContent](./aws-properties-elasticloadbalancingv2-truststorerevocation-revocationcontent.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststorerevocation.html#cfn-elasticloadbalancingv2-truststorerevocation-revocationcontents", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "RevocationContent", "DuplicatesAllowed": false }, "TrustStoreArn": { "MarkdownDocumentation": "`TrustStoreArn`\n\nThe Amazon Resource Name (ARN) of the trust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststorerevocation.html#cfn-elasticloadbalancingv2-truststorerevocation-truststorearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "TrustStoreRevocations": { "Type": "List", "ItemType": "TrustStoreRevocation", "MarkdownDocumentation": "`TrustStoreRevocations`\n\nInformation about the revocation file in the trust store. For more information, see [TrustStoreRevocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-elasticloadbalancingv2-truststorerevocation-truststorerevocation.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststorerevocation.html#TrustStoreRevocations-fn::getatt" }, "RevocationId": { "PrimitiveType": "Long", "MarkdownDocumentation": "`RevocationId`\n\nThe revocation ID of the revocation file.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststorerevocation.html#RevocationId-fn::getatt" } } }, "AWS::Elasticsearch::Domain": { "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the domain, such as\n`arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij`. This\nreturned value is the same as the one returned by\n`AWS::Elasticsearch::Domain.DomainArn`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#Arn-fn::getatt" }, "DomainArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainArn`\n\nThe Amazon Resource Name (ARN) of the domain, such as\n`arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij`. This\nreturned value is the same as the one returned by\n`AWS::Elasticsearch::Domain.Arn`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#DomainArn-fn::getatt" }, "DomainEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainEndpoint`\n\nThe domain-specific endpoint that's used for requests to the OpenSearch APIs, such as\n`search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#DomainEndpoint-fn::getatt" } }, "MarkdownDocumentation": "`AWS::Elasticsearch::Domain`\n\nThe AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service\ndomain.\n###### Important\nThe `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource\nand options are still supported, we recommend modifying your existing Cloudformation\ntemplates to use the new OpenSearch Service resource, which supports both OpenSearch and\nlegacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from\nElasticsearch to OpenSearch, see [Remarks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks).\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the resource name, such as `mystack-elasticsea-abc1d2efg3h4.` For more\ninformation about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html", "Properties": { "AccessPolicies": { "MarkdownDocumentation": "`AccessPolicies`\n\nAn AWS Identity and Access Management (IAM) policy document that specifies who can\naccess 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\nGuid*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies", "PrimitiveType": "Json", "Required": false, "UpdateType": "Mutable" }, "AdvancedOptions": { "MarkdownDocumentation": "`AdvancedOptions`\n\nAdditional 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\nDeveloper Guide*.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "AdvancedSecurityOptions": { "MarkdownDocumentation": "`AdvancedSecurityOptions`\n\nSpecifies options for fine-grained access control.\n*Required*: No\n*Type*: [AdvancedSecurityOptionsInput](./aws-properties-elasticsearch-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedsecurityoptions", "Required": false, "Type": "AdvancedSecurityOptionsInput", "UpdateType": "Conditional" }, "CognitoOptions": { "MarkdownDocumentation": "`CognitoOptions`\n\nConfigures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.\n*Required*: No\n*Type*: [CognitoOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-cognitooptions", "Required": false, "Type": "CognitoOptions", "UpdateType": "Mutable" }, "DomainEndpointOptions": { "MarkdownDocumentation": "`DomainEndpointOptions`\n\nSpecifies 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainendpointoptions", "Required": false, "Type": "DomainEndpointOptions", "UpdateType": "Mutable" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nA 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\nGuide*. If you don't specify a name, CloudFormation generates a unique\nphysical ID and uses that ID for the domain name. For more information, see [Name\nType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must replace\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EBSOptions": { "MarkdownDocumentation": "`EBSOptions`\n\nThe configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to\ndata 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\nGuide*.\n*Required*: No\n*Type*: [EBSOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions", "Required": false, "Type": "EBSOptions", "UpdateType": "Mutable" }, "ElasticsearchClusterConfig": { "MarkdownDocumentation": "`ElasticsearchClusterConfig`\n\nElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that\nconfigures the cluster of an Amazon OpenSearch Service domain.\n*Required*: No\n*Type*: [ElasticsearchClusterConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig", "Required": false, "Type": "ElasticsearchClusterConfig", "UpdateType": "Mutable" }, "ElasticsearchVersion": { "MarkdownDocumentation": "`ElasticsearchVersion`\n\nThe version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the\ndefault. For information about the versions that OpenSearch Service supports, see [Supported\nversions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service\nDeveloper 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\n`ElasticsearchVersion` without interruption. When\n`EnableVersionUpgrade` is set to `false`, or is not specified,\nupdating `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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion", "PrimitiveType": "String", "Required": false, "UpdateType": "Conditional" }, "EncryptionAtRestOptions": { "MarkdownDocumentation": "`EncryptionAtRestOptions`\n\nWhether the domain should encrypt data at rest, and if so, the AWS Key Management Service\nkey to use. See [Encryption of data at\nrest for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html).\n*Required*: No\n*Type*: [EncryptionAtRestOptions](./aws-properties-elasticsearch-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions", "Required": false, "Type": "EncryptionAtRestOptions", "UpdateType": "Conditional" }, "LogPublishingOptions": { "MarkdownDocumentation": "`LogPublishingOptions`\n\nAn object with one or more of the following keys: `SEARCH_SLOW_LOGS`,\n`ES_APPLICATION_LOGS`, `INDEX_SLOW_LOGS`, `AUDIT_LOGS`,\ndepending on the types of logs you want to publish. Each key needs a valid\n`LogPublishingOption` value.\n*Required*: No\n*Type*: Object of [LogPublishingOption](./aws-properties-elasticsearch-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-logpublishingoptions", "DuplicatesAllowed": false, "ItemType": "LogPublishingOption", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "NodeToNodeEncryptionOptions": { "MarkdownDocumentation": "`NodeToNodeEncryptionOptions`\n\nSpecifies whether node-to-node encryption is enabled. See [Node-to-node encryption for Amazon\nOpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html).\n*Required*: No\n*Type*: [NodeToNodeEncryptionOptions](./aws-properties-elasticsearch-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions", "Required": false, "Type": "NodeToNodeEncryptionOptions", "UpdateType": "Conditional" }, "SnapshotOptions": { "MarkdownDocumentation": "`SnapshotOptions`\n\n**DEPRECATED**. The automated snapshot configuration for the\nOpenSearch Service domain indices.\n*Required*: No\n*Type*: [SnapshotOptions](./aws-properties-elasticsearch-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions", "Required": false, "Type": "SnapshotOptions", "UpdateType": "Mutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key\u2013value pairs) to associate with the OpenSearch Service domain.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-elasticsearch-domain-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "VPCOptions": { "MarkdownDocumentation": "`VPCOptions`\n\nThe virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more\ninformation, see [Launching your Amazon OpenSearch\nService domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer\nGuide*.\n*Required*: No\n*Type*: [VPCOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions", "Required": false, "Type": "VPCOptions", "UpdateType": "Mutable" } } }, "AWS::EntityResolution::IdMappingWorkflow": { "MarkdownDocumentation": "`AWS::EntityResolution::IdMappingWorkflow`\n\nCreates an `IdMappingWorkflow` object which stores the configuration of the\ndata processing job to be run. Each `IdMappingWorkflow` must have a unique\nworkflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow\nAPI.\n###### Important\nIncremental processing is not supported for ID mapping workflows.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the workflow.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputSourceConfig": { "MarkdownDocumentation": "`InputSourceConfig`\n\nA list of `InputSource` objects, which have the fields\n`InputSourceARN` and `SchemaName`.\n*Required*: Yes\n*Type*: Array of [IdMappingWorkflowInputSource](./aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-inputsourceconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "IdMappingWorkflowInputSource", "DuplicatesAllowed": true }, "IdMappingTechniques": { "MarkdownDocumentation": "`IdMappingTechniques`\n\nAn object which defines the ID mapping technique and any additional\nconfigurations.\n*Required*: Yes\n*Type*: [IdMappingTechniques](./aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques", "UpdateType": "Mutable", "Required": true, "Type": "IdMappingTechniques" }, "WorkflowName": { "MarkdownDocumentation": "`WorkflowName`\n\nThe name of the workflow. There can't be multiple `IdMappingWorkflows` with\nthe same name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9-]*$`\n*Minimum*: `0`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-workflowname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OutputSourceConfig": { "MarkdownDocumentation": "`OutputSourceConfig`\n\nA list of `IdMappingWorkflowOutputSource` objects, each of which contains\nfields `outputS3Path` and `KMSArn`.\n*Required*: No\n*Type*: Array of [IdMappingWorkflowOutputSource](./aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-outputsourceconfig", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IdMappingWorkflowOutputSource", "DuplicatesAllowed": true }, "IdMappingIncrementalRunConfig": { "MarkdownDocumentation": "`IdMappingIncrementalRunConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [IdMappingIncrementalRunConfig](./aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig", "UpdateType": "Mutable", "Required": false, "Type": "IdMappingIncrementalRunConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes\nthis role to create resources on your behalf as part of workflow execution.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-entityresolution-idmappingworkflow-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#CreatedAt-fn::getatt" }, "WorkflowArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#WorkflowArn-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#UpdatedAt-fn::getatt" } } }, "AWS::EntityResolution::IdNamespace": { "MarkdownDocumentation": "`AWS::EntityResolution::IdNamespace`\n\nCreates an ID namespace object which will help customers provide metadata explaining\ntheir dataset and how to use it. Each ID namespace must have a unique name. To modify an\nexisting ID namespace, use the UpdateIdNamespace API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html", "Properties": { "IdNamespaceName": { "MarkdownDocumentation": "`IdNamespaceName`\n\nThe name of the ID namespace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-idnamespacename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of ID namespace. There are two types: `SOURCE` and\n`TARGET`.\nThe `SOURCE` contains configurations for `sourceId` data that will\nbe processed in an ID mapping workflow.\nThe `TARGET` contains a configuration of `targetId` which all\n`sourceIds` will resolve to.\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)", "RefReturnValue": "", "AllowedValues": [ "SOURCE", "TARGET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the ID namespace.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputSourceConfig": { "MarkdownDocumentation": "`InputSourceConfig`\n\nA list of `InputSource` objects, which have the fields\n`InputSourceARN` and `SchemaName`.\n*Required*: No\n*Type*: Array of [IdNamespaceInputSource](./aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-inputsourceconfig", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IdNamespaceInputSource", "DuplicatesAllowed": true }, "IdMappingWorkflowProperties": { "MarkdownDocumentation": "`IdMappingWorkflowProperties`\n\nDetermines the properties of `IdMappingWorflow` where this\n`IdNamespace` can be used as a `Source` or a\n`Target`.\n*Required*: No\n*Type*: Array of [IdNamespaceIdMappingWorkflowProperties](./aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-idmappingworkflowproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IdNamespaceIdMappingWorkflowProperties", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes\nthis role to access the resources defined in this `IdNamespace` on your behalf\nas part of the workflow run.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\n*Minimum*: `32`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-entityresolution-idnamespace-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#CreatedAt-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#UpdatedAt-fn::getatt" }, "IdNamespaceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#IdNamespaceArn-fn::getatt" } } }, "AWS::EntityResolution::MatchingWorkflow": { "MarkdownDocumentation": "`AWS::EntityResolution::MatchingWorkflow`\n\nCreates a matching workflow that defines the configuration for a data processing job.\nThe workflow name must be unique. To modify an existing workflow, use\n`UpdateMatchingWorkflow`.\n###### Important\nFor workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER`, incremental\nprocessing is not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html", "Properties": { "ResolutionTechniques": { "MarkdownDocumentation": "`ResolutionTechniques`\n\nAn object which defines the `resolutionType` and the\n`ruleBasedProperties`.\n*Required*: Yes\n*Type*: [ResolutionTechniques](./aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-resolutiontechniques", "UpdateType": "Mutable", "Required": true, "Type": "ResolutionTechniques" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the workflow.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputSourceConfig": { "MarkdownDocumentation": "`InputSourceConfig`\n\nA list of `InputSource` objects, which have the fields\n`InputSourceARN` and `SchemaName`.\n*Required*: Yes\n*Type*: Array of [InputSource](./aws-properties-entityresolution-matchingworkflow-inputsource.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-inputsourceconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "InputSource", "DuplicatesAllowed": true }, "WorkflowName": { "MarkdownDocumentation": "`WorkflowName`\n\nThe name of the workflow. There can't be multiple `MatchingWorkflows` with\nthe same name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9-]*$`\n*Minimum*: `0`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-workflowname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IncrementalRunConfig": { "MarkdownDocumentation": "`IncrementalRunConfig`\n\nOptional. An object that defines the incremental run type. This object contains only the\n`incrementalRunType` field, which appears as \"Automatic\" in the console.\n###### Important\nFor workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER`,\nincremental processing is not supported.\n*Required*: No\n*Type*: [IncrementalRunConfig](./aws-properties-entityresolution-matchingworkflow-incrementalrunconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-incrementalrunconfig", "UpdateType": "Mutable", "Required": false, "Type": "IncrementalRunConfig" }, "OutputSourceConfig": { "MarkdownDocumentation": "`OutputSourceConfig`\n\nA list of `OutputSource` objects, each of which contains fields\n`outputS3Path`, `applyNormalization`, `KMSArn`, and\n`output`.\n*Required*: Yes\n*Type*: Array of [OutputSource](./aws-properties-entityresolution-matchingworkflow-outputsource.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-outputsourceconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "OutputSource", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes\nthis role to create resources on your behalf as part of workflow execution.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-entityresolution-matchingworkflow-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#CreatedAt-fn::getatt" }, "WorkflowArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#WorkflowArn-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#UpdatedAt-fn::getatt" } } }, "AWS::EntityResolution::PolicyStatement": { "MarkdownDocumentation": "`AWS::EntityResolution::PolicyStatement`\n\nAdds a policy statement object. To retrieve a list of existing policy statements, use\nthe `GetPolicy` API.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html", "Properties": { "Condition": { "MarkdownDocumentation": "`Condition`\n\nA set of condition keys that you can use in key policies.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `40960`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-condition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that the principal can use on the resource.\nFor example, `entityresolution:GetIdMappingJob`,\n`entityresolution:GetMatchingJob`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-action", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "StatementId": { "MarkdownDocumentation": "`StatementId`\n\nA statement identifier that differentiates the statement from others in the same\npolicy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-statementid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Effect": { "MarkdownDocumentation": "`Effect`\n\nDetermines whether the permissions specified in the policy are to be allowed\n(`Allow`) or denied (`Deny`).\n###### Important\nIf you set the value of the `effect` parameter to `Deny` for\nthe `AddPolicyStatement` operation, you must also set the value of the\n`effect` parameter in the `policy` to `Deny` for the\n`PutPolicy` operation.\n*Required*: No\n*Type*: String\n*Allowed values*: `Allow | Deny...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Allow", "Deny" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-effect", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the resource that will be accessed by the\nprincipal.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:((schemamapping|matchingworkflow|idmappingworkflow|idnamespace)/[a-zA-Z_0-9-]{1,255})$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-arn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe AWS service or AWS account that can access the\nresource defined as ARN.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-principal", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::EntityResolution::SchemaMapping": { "MarkdownDocumentation": "`AWS::EntityResolution::SchemaMapping`\n\nCreates a schema mapping, which defines the schema of the input customer records table.\nThe `SchemaMapping` also provides AWS Entity Resolution with some metadata about the\ntable, such as the attribute types of the columns and which columns to match on.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the schema.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#cfn-entityresolution-schemamapping-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MappedInputFields": { "MarkdownDocumentation": "`MappedInputFields`\n\nA list of `MappedInputFields`. Each `MappedInputField` corresponds\nto a column the source data table, and contains column name plus additional information\nthat AWS Entity Resolution uses for matching.\n*Required*: Yes\n*Type*: Array of [SchemaInputAttribute](./aws-properties-entityresolution-schemamapping-schemainputattribute.html)\n*Minimum*: `2`\n*Maximum*: `35`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#cfn-entityresolution-schemamapping-mappedinputfields", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "SchemaInputAttribute", "DuplicatesAllowed": true }, "SchemaName": { "MarkdownDocumentation": "`SchemaName`\n\nThe name of the schema. There can't be multiple `SchemaMappings` with the\nsame name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z_0-9-]*$`\n*Minimum*: `0`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#cfn-entityresolution-schemamapping-schemaname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-entityresolution-schemamapping-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#cfn-entityresolution-schemamapping-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#CreatedAt-fn::getatt" }, "HasWorkflows": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#HasWorkflows-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#UpdatedAt-fn::getatt" }, "SchemaArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#SchemaArn-fn::getatt" } } }, "AWS::EventSchemas::Discoverer": { "MarkdownDocumentation": "`AWS::EventSchemas::Discoverer`\n\nUse the `AWS::EventSchemas::Discoverer` resource to specify a\n*discoverer* that is associated with an event bus. A discoverer\nallows the Amazon EventBridge Schema Registry to automatically generate schemas based on\nevents on an event bus.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic\nfunction, `Ref` returns the ARN of the discoverer.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html", "Properties": { "CrossAccount": { "MarkdownDocumentation": "`CrossAccount`\n\nAllows for the discovery of the event schemas that are sent to the event bus from another 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-crossaccount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the discoverer.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe ARN of the event bus.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-sourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags associated with the resource.\n*Required*: No\n*Type*: Array of [TagsEntry](./aws-properties-eventschemas-discoverer-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagsEntry", "DuplicatesAllowed": true } }, "Attributes": { "DiscovererArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DiscovererArn`\n\nThe ARN of the discoverer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#DiscovererArn-fn::getatt" }, "DiscovererId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DiscovererId`\n\nThe ID of the discoverer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#DiscovererId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the discoverer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#State-fn::getatt" } } }, "AWS::EventSchemas::Registry": { "MarkdownDocumentation": "`AWS::EventSchemas::Registry`\n\nUse the `AWS::EventSchemas::Registry` to specify a schema registry. Schema\nregistries are containers for Schemas. Registries collect and organize schemas so that\nyour schemas are in logical groups.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic\nfunction, `Ref` returns the ARN of the schema. For example:\n`{ \"Ref\": \"MyRegistry\" }`\nReturns a value similar to the following:\n`arn:aws:schemas:us-east-1:012345678901:registry/MyRegistry`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the registry to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RegistryName": { "MarkdownDocumentation": "`RegistryName`\n\nThe name of the schema registry.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-registryname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to associate with the registry.\n*Required*: No\n*Type*: Array of [TagsEntry](./aws-properties-eventschemas-registry-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagsEntry", "DuplicatesAllowed": true } }, "Attributes": { "RegistryName": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegistryName`\n\nThe name of the registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#RegistryName-fn::getatt" }, "RegistryArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegistryArn`\n\nThe ARN of the registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#RegistryArn-fn::getatt" } } }, "AWS::EventSchemas::RegistryPolicy": { "MarkdownDocumentation": "`AWS::EventSchemas::RegistryPolicy`\n\nUse the `AWS::EventSchemas::RegistryPolicy` resource to specify\nresource-based policies for an EventBridge Schema Registry.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic\nfunction, `Ref` the name of the registry.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registrypolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nA resource-based 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registrypolicy.html#cfn-eventschemas-registrypolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "RegistryName": { "MarkdownDocumentation": "`RegistryName`\n\nThe name of the registry.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registrypolicy.html#cfn-eventschemas-registrypolicy-registryname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RevisionId": { "MarkdownDocumentation": "`RevisionId`\n\nThe revision ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registrypolicy.html#cfn-eventschemas-registrypolicy-revisionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registrypolicy.html#Id-fn::getatt" } } }, "AWS::EventSchemas::Schema": { "MarkdownDocumentation": "`AWS::EventSchemas::Schema`\n\nUse the `AWS::EventSchemas::Schema` resource to specify an event\nschema.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic\nfunction, `Ref` returns the ARN of the schema. For example:\n`{ \"Ref\": \"MySchema\" }`\nReturns a value similar to the following:\n`arn:aws:schemas:us-east-1:012345678901:schema/MyRegistry/MySchema`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of schema.\nValid types include `OpenApi3` and `JSONSchemaDraft4`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe source of the schema 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-content", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RegistryName": { "MarkdownDocumentation": "`RegistryName`\n\nThe name of the schema registry.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-registryname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SchemaName": { "MarkdownDocumentation": "`SchemaName`\n\nThe name of the schema.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-schemaname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags associated with the schema.\n*Required*: No\n*Type*: Array of [TagsEntry](./aws-properties-eventschemas-schema-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagsEntry", "DuplicatesAllowed": true } }, "Attributes": { "LastModified": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModified`\n\nThe date and time that schema was modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#LastModified-fn::getatt" }, "SchemaVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`SchemaVersion`\n\nThe version number of the schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#SchemaVersion-fn::getatt" }, "VersionCreatedDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`VersionCreatedDate`\n\nThe date the schema version was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#VersionCreatedDate-fn::getatt" }, "SchemaArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SchemaArn`\n\nThe ARN of the schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#SchemaArn-fn::getatt" }, "SchemaName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SchemaName`\n\nThe name of the schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#SchemaName-fn::getatt" } } }, "AWS::Events::ApiDestination": { "MarkdownDocumentation": "`AWS::Events::ApiDestination`\n\nCreates an API destination, which is an HTTP invocation endpoint configured as a target\nfor events.\nWhen using ApiDesinations with OAuth authentication we recommend these best practices:\n* Create a secret in Secrets Manager with your OAuth credentials.\n* Reference that secret in your CloudFormation template for `AWS::Events::Connection` using\n CloudFormation dynamic reference syntax. For more information, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager).\nWhen the Connection resource is created the secret will be passed to EventBridge and stored in the customer account using \u201cService Linked Secrets,\u201d\neffectively creating two secrets. This will minimize the cost because the original secret is only accessed when a CloudFormation template is created or updated,\nnot every time an event is sent to the ApiDestination. The secret stored in the customer account by EventBridge is the one used for each event sent to the\nApiDestination and AWS is responsible for the fees.\n###### Note\nThe secret stored in the customer account by EventBridge can\u2019t be updated directly, only when a CloudFormation template is updated.\nFor examples of CloudFormation templates that use secrets, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#aws-resource-events-connection--examples).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the API destination that was created by the\nrequest.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the API destination to create.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConnectionArn": { "MarkdownDocumentation": "`ConnectionArn`\n\nThe ARN of the connection to use for the API destination. The destination endpoint must\nsupport the authorization type specified for the connection.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:connection/[\\.\\-_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InvocationEndpoint": { "MarkdownDocumentation": "`InvocationEndpoint`\n\nThe URL to the HTTP invocation endpoint for the API destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\\x26=+$,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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HttpMethod": { "MarkdownDocumentation": "`HttpMethod`\n\nThe method to use for the request to the HTTP invocation endpoint.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GET | HEAD | POST | OPTIONS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GET", "HEAD", "POST", "OPTIONS", "PUT", "DELETE", "PATCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the API destination to create.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\.\\-_A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InvocationRateLimitPerSecond": { "MarkdownDocumentation": "`InvocationRateLimitPerSecond`\n\nThe maximum number of requests per second to send to the HTTP invocation endpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the API destination that was created by the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#Arn-fn::getatt" }, "ArnForPolicy": { "PrimitiveType": "String", "MarkdownDocumentation": "`ArnForPolicy`\n\nReturns the Amazon Resource Name (ARN) of an API destination in resource format, so it can be used in the `Resource` element of IAM permission policy statements.\nFor more information, see [Resource types defined by Amazon EventBridge](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazoneventbridge.html#amazoneventbridge-resources-for-iam-policies) in the *Service Authorization Reference*.\nFor example, the following resource defines an IAM policy that grants permission to update a specific API destination.\n```\nResources:\n ExamplePolicy:\n Type: AWS::IAM::Policy\n Properties:\n PolicyName: ExamplePolicy\n PolicyDocument:\n Version: '2012-10-17\t\t \t \t '\n Statement:\n - Effect: Allow\n Action:\n - events:UpdateApiDestination\n Resource:\n - !GetAtt myApiDestination.ArnForPolicy\n```\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#ArnForPolicy-fn::getatt" } } }, "AWS::Events::Archive": { "MarkdownDocumentation": "`AWS::Events::Archive`\n\nCreates an archive of events with the specified settings. When you create an archive,\nincoming events might not immediately start being sent to the archive. Allow a short period of\ntime for changes to take effect. If you do not specify a pattern to filter events sent to the\narchive, all events are sent to the archive except replayed events. Replayed events are not\nsent to an archive.\n###### Important\nIf you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a\ncustomer managed key for any archives for the event bus as well.\nFor more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the archive name.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html", "Properties": { "EventPattern": { "MarkdownDocumentation": "`EventPattern`\n\nAn event pattern to use to filter events sent to the archive.\n*Required*: No\n*Type*: Json\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "KmsKeyIdentifier": { "MarkdownDocumentation": "`KmsKeyIdentifier`\n\nThe identifier of the AWS KMS\ncustomer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key\nAmazon Resource Name (ARN), KeyId, key alias, or key alias ARN.\nIf you do not specify a customer managed key identifier, EventBridge uses an\nAWS owned key to encrypt the archive.\nFor more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the *AWS Key Management Service\nDeveloper Guide*.\n###### Important\nIf you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a\ncustomer managed key for any archives for the event bus as well.\nFor more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-kmskeyidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the archive.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe ARN of the event bus that sends events to the archive.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:.+\\/.+$`\n*Minimum*: `1`\n*Maximum*: `1600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ArchiveName": { "MarkdownDocumentation": "`ArchiveName`\n\nThe name for the archive to create.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\.\\-_A-Za-z0-9]+`\n*Minimum*: `1`\n*Maximum*: `48`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RetentionDays": { "MarkdownDocumentation": "`RetentionDays`\n\nThe number of days to retain events for. Default value is 0. If set to 0, events are\nretained indefinitely\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the archive created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#Arn-fn::getatt" } } }, "AWS::Events::Connection": { "MarkdownDocumentation": "`AWS::Events::Connection`\n\nCreates a connection. A connection defines the authorization type and credentials to use\nfor authorization with an API destination HTTP endpoint.\nFor more information, see [Connections for endpoint targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection.html) in the *Amazon EventBridge User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the connection that was created by the\nrequest.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html", "Properties": { "AuthParameters": { "MarkdownDocumentation": "`AuthParameters`\n\nThe\nauthorization parameters to use to authorize with the endpoint.\nYou must include only authorization parameters for the `AuthorizationType` you specify.\n*Required*: No\n*Type*: [AuthParameters](./aws-properties-events-connection-authparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters", "UpdateType": "Mutable", "Required": false, "Type": "AuthParameters" }, "KmsKeyIdentifier": { "MarkdownDocumentation": "`KmsKeyIdentifier`\n\nThe identifier of the AWS KMS\ncustomer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key\nAmazon Resource Name (ARN), KeyId, key alias, or key alias ARN.\nIf you do not specify a customer managed key identifier, EventBridge uses an\nAWS owned key to encrypt the connection.\nFor more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the *AWS Key Management Service\nDeveloper Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-/:]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-kmskeyidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the connection to create.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InvocationConnectivityParameters": { "MarkdownDocumentation": "`InvocationConnectivityParameters`\n\nFor connections to private APIs, the parameters to use for invoking the API.\nFor more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the **Amazon EventBridge User Guide**.\n*Required*: No\n*Type*: [InvocationConnectivityParameters](./aws-properties-events-connection-invocationconnectivityparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-invocationconnectivityparameters", "UpdateType": "Mutable", "Required": false, "Type": "InvocationConnectivityParameters" }, "AuthorizationType": { "MarkdownDocumentation": "`AuthorizationType`\n\nThe type of authorization to use for the connection.\n###### Note\nOAUTH tokens are refreshed when a 401 or 407 response is returned.\n*Required*: No\n*Type*: String\n*Allowed values*: `API_KEY | BASIC | OAUTH_CLI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "API_KEY", "BASIC", "OAUTH_CLIENT_CREDENTIALS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the connection to create.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\.\\-_A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SecretArn`\n\nThe ARN for the secret created for the connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#SecretArn-fn::getatt" }, "AuthParameters.ConnectivityParameters.ResourceParameters.ResourceAssociationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AuthParameters.ConnectivityParameters.ResourceParameters.ResourceAssociationArn`\n\nFor connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.\nFor more information, see [Managing service network resource associations for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html#connection-private-snra) in the **Amazon EventBridge User Guide**.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#AuthParameters.ConnectivityParameters.ResourceParameters.ResourceAssociationArn-fn::getatt" }, "InvocationConnectivityParameters.ResourceParameters.ResourceAssociationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`InvocationConnectivityParameters.ResourceParameters.ResourceAssociationArn`\n\nFor connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.\nFor more information, see [Managing service network resource associations for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html#connection-private-snra) in the **Amazon EventBridge User Guide**.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#InvocationConnectivityParameters.ResourceParameters.ResourceAssociationArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the connection that was created by the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#Arn-fn::getatt" }, "ArnForPolicy": { "PrimitiveType": "String", "MarkdownDocumentation": "`ArnForPolicy`\n\nReturns the Amazon Resource Name (ARN) of a connection in resource format, so it can be used in the `Resource` element of IAM permission policy statements.\nFor more information, see [Resource types defined by Amazon EventBridge](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazoneventbridge.html#amazoneventbridge-resources-for-iam-policies) in the *Service Authorization Reference*.\nFor example, the following resource defines an IAM policy that grants permission to update a specific connection.\n```\nResources:\n ExamplePolicy:\n Type: AWS::IAM::Policy\n Properties:\n PolicyName: ExamplePolicy\n PolicyDocument:\n Version: '2012-10-17\t\t \t \t '\n Statement:\n - Effect: Allow\n Action:\n - events:UpdateConnection\n Resource:\n - !GetAtt myConnection.ArnForPolicy\n```\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#ArnForPolicy-fn::getatt" } } }, "AWS::Events::Endpoint": { "MarkdownDocumentation": "`AWS::Events::Endpoint`\n\nA global endpoint used to improve your application's availability by making it\nregional-fault tolerant. For more information about global endpoints, see [Making\napplications Regional-fault tolerant with global endpoints and event replication](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in\nthe **Amazon EventBridge User Guide**.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns Endpoint ID, such as\n`mystack-Endpoint-ABCDEFGHIJK`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html", "Properties": { "EventBuses": { "MarkdownDocumentation": "`EventBuses`\n\nThe event buses being used by the endpoint.\n*Exactly*: `2`\n*Required*: Yes\n*Type*: Array of [EndpointEventBus](./aws-properties-events-endpoint-endpointeventbus.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "EndpointEventBus", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the endpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReplicationConfig": { "MarkdownDocumentation": "`ReplicationConfig`\n\nWhether event replication was enabled or disabled for this endpoint. The default state is\n`ENABLED` which means you must supply a `RoleArn`. If you don't have a\n`RoleArn` or you don't want event replication enabled, set the state to\n`DISABLED`.\n*Required*: No\n*Type*: [ReplicationConfig](./aws-properties-events-endpoint-replicationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig", "UpdateType": "Mutable", "Required": false, "Type": "ReplicationConfig" }, "RoutingConfig": { "MarkdownDocumentation": "`RoutingConfig`\n\nThe routing configuration of the endpoint.\n*Required*: Yes\n*Type*: [RoutingConfig](./aws-properties-events-endpoint-routingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig", "UpdateType": "Mutable", "Required": true, "Type": "RoutingConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role used by event replication for the endpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z-]*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the endpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\.\\-_A-Za-z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe main Region of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#State-fn::getatt" }, "StateReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`StateReason`\n\nThe reason the endpoint is in its current state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#StateReason-fn::getatt" }, "EndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointId`\n\nThe ID of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#EndpointId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#Arn-fn::getatt" }, "EndpointUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointUrl`\n\nThe URL of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#EndpointUrl-fn::getatt" } } }, "AWS::Events::EventBus": { "MarkdownDocumentation": "`AWS::Events::EventBus`\n\nSpecifies an event bus within your account. This can be a custom event bus which you can\nuse to receive events from your custom applications and services, or it can be a partner event\nbus which can be matched to a partner event source.\n###### Note\nAs an aid to help you jumpstart developing CloudFormation templates, the EventBridge console\nenables you to create templates from the existing event buses in your account. For more information, see\n[Generating CloudFormation templates from an EventBridge event bus](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html)\nin the *Amazon EventBridge User\nGuide*.\n", "RefReturnValue": "\nThe name of the new event bus.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe permissions policy of the event bus, describing which other AWS\naccounts can write events to this event bus.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-policy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "KmsKeyIdentifier": { "MarkdownDocumentation": "`KmsKeyIdentifier`\n\nThe identifier of the AWS KMS\ncustomer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key\nAmazon Resource Name (ARN), KeyId, key alias, or key alias ARN.\nIf you do not specify a customer managed key identifier, EventBridge uses an\nAWS owned key to encrypt events on the event bus.\nFor more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the *AWS Key Management Service\nDeveloper Guide*.\n###### Note\nSchema discovery is not supported for event buses encrypted using a\ncustomer managed key. EventBridge returns an error if:\n* You call `[CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer)` on an event bus set to use a customer managed key for encryption.\n* You call `[UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html)` to set a customer managed key on an event bus with schema discovery enabled.\nTo enable schema discovery on an event bus, choose to\nuse an AWS owned key. For more information, see [Encrypting events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption-event-bus-cmkey.html) in the *Amazon EventBridge User Guide*.\n\n###### Important\nIf you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a\ncustomer managed key for any archives for the event bus as well.\nFor more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-/:]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-kmskeyidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe event bus description.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventSourceName": { "MarkdownDocumentation": "`EventSourceName`\n\nIf you are creating a partner event bus, this specifies the partner event source that the\nnew event bus will be matched with.\n*Required*: No\n*Type*: String\n*Pattern*: `aws\\.partner(/[\\.\\-_A-Za-z0-9]+){2,}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeadLetterConfig": { "MarkdownDocumentation": "`DeadLetterConfig`\n\nConfiguration details of the Amazon SQS queue for EventBridge to use as a\ndead-letter queue (DLQ).\nFor more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User\nGuide*.\n*Required*: No\n*Type*: [DeadLetterConfig](./aws-properties-events-eventbus-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-deadletterconfig", "UpdateType": "Mutable", "Required": false, "Type": "DeadLetterConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to associate with the event bus.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-events-eventbus-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the new event bus.\nCustom event bus names can't contain the `/` character, but you can use the\n`/` character in partner event bus names. In addition, for partner event buses,\nthe name must exactly match the name of the partner event source that this event bus is\nmatched to.\nYou can't use the name `default` for a custom event bus, as this name is\nalready used for your account's default event bus.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[/\\.\\-_A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LogConfig": { "MarkdownDocumentation": "`LogConfig`\n\nThe logging configuration settings for the event bus.\nFor more information, see [Configuring logs for event buses](https://docs.aws.amazon.com/eb-event-bus-logs.html) in the *EventBridge User Guide*.\n*Required*: No\n*Type*: [LogConfig](./aws-properties-events-eventbus-logconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-logconfig", "UpdateType": "Mutable", "Required": false, "Type": "LogConfig" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the event bus, such as\n`arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the event bus, such as `PartnerName/acct1/repo1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Name-fn::getatt" } } }, "AWS::Events::EventBusPolicy": { "MarkdownDocumentation": "`AWS::Events::EventBusPolicy`\n\nRunning `PutPermission` permits the specified AWS account or AWS organization\nto put events to the specified *event bus*. Amazon EventBridge rules in your account are triggered by these events arriving to an event bus in your\naccount.\nFor another account to send events to your account, that external account must have an\nEventBridge rule with your account's event bus as a target.\nTo enable multiple AWS accounts to put events to your event bus, run\n`PutPermission` once for each of these accounts. Or, if all the accounts are\nmembers of the same AWS organization, you can run `PutPermission`\nonce specifying `Principal` as \"\\*\" and specifying the AWS\norganization ID in `Condition`, to grant permissions to all accounts in that\norganization.\nIf you grant permissions using an organization, then accounts in that organization must\nspecify a `RoleArn` with proper permissions when they use `PutTarget` to\nadd your account's event bus as a target. For more information, see [Sending and\nReceiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*.\nThe permission policy on the event bus cannot exceed 10 KB in size.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the event bus policy ID, such as\n`EventBusPolicy-1aBCdeFGh2J3`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html", "Properties": { "EventBusName": { "MarkdownDocumentation": "`EventBusName`\n\nThe name of the event bus associated with the rule. If you omit this, the default event\nbus is used.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\.\\-_A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StatementId": { "MarkdownDocumentation": "`StatementId`\n\nAn identifier string for the external account that you are granting permissions to. If you\nlater want to revoke the permission for this external account, specify this\n`StatementId` when you run [RemovePermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html).\n###### Note\nEach `StatementId` must be unique.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-_]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Statement": { "MarkdownDocumentation": "`Statement`\n\nA JSON string that describes the permission policy statement. You can include a\n`Policy` parameter in the request instead of using the `StatementId`,\n`Action`, `Principal`, or `Condition` parameters.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::Events::Rule": { "MarkdownDocumentation": "`AWS::Events::Rule`\n\nCreates or updates the specified rule. Rules are enabled by default, or based on value of\nthe state. You can disable a rule using [DisableRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html).\nA single rule watches for events from a single event bus. Events generated by AWS services\ngo to your account's default event bus. Events generated by SaaS partner services or\napplications go to the matching partner event bus. If you have custom applications or\nservices, you can specify whether their events go to your default event bus or a custom event\nbus that you have created. For more information, see [CreateEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html).\nIf you are updating an existing rule, the rule is replaced with what you specify in this\n`PutRule` command. If you omit arguments in `PutRule`, the old values\nfor those arguments are not kept. Instead, they are replaced with null values.\nWhen you create or update a rule, incoming events might not immediately start matching to\nnew or updated rules. Allow a short period of time for changes to take effect.\nA rule must contain at least an EventPattern or ScheduleExpression. Rules with\nEventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\nself-trigger based on the given schedule. A rule can have both an EventPattern and a\nScheduleExpression, in which case the rule triggers on matching events as well as on a\nschedule.\nMost services in AWS treat : or / as the same character in Amazon Resource Names (ARNs).\nHowever, EventBridge uses an exact match in event patterns and rules. Be sure to use the\ncorrect ARN characters when creating event patterns so that they match the ARN syntax in the\nevent you want to match.\nIn EventBridge, it is possible to create rules that lead to infinite loops, where a rule\nis fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\nand trigger software to change them to the desired state. If the rule is not written\ncarefully, the subsequent change to the ACLs fires the rule again, creating an infinite\nloop.\nTo prevent this, write the rules so that the triggered actions do not re-fire the same\nrule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\nof after any change.\nAn infinite loop can quickly cause higher than expected charges. We recommend that you use\nbudgeting, which alerts you when charges exceed your specified limit. For more information,\nsee [Managing Your Costs with\nBudgets](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html).\n###### Note\nAs an aid to help you jumpstart developing CloudFormation templates, the EventBridge console\nenables you to create templates from the existing rules in your account. For more information, see\n[Generating\nCloudFormation templates from an EventBridge rule](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-generate-template.html)\nin the *Amazon EventBridge User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns event rule ID, such as\n`mystack-ScheduledRule-ABCDEFGHIJK`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html", "Properties": { "EventBusName": { "MarkdownDocumentation": "`EventBusName`\n\nThe name or ARN of the event bus associated with the rule. If you omit this, the default\nevent bus is used.\n*Required*: No\n*Type*: String\n*Pattern*: `[/\\.\\-_A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "EventPattern": { "MarkdownDocumentation": "`EventPattern`\n\nThe event pattern of the rule. For more information, see [Events and Event\nPatterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the **Amazon EventBridge User Guide**.\n*Required*: Conditional\n*Type*: Json\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nThe scheduling expression. For example, \"cron(0 20 \\* \\* ? \\*)\", \"rate(5 minutes)\". For more\ninformation, see [Creating an Amazon EventBridge rule\nthat 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the rule.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the rule.\nValid values include:\n* `DISABLED`: The rule is disabled. EventBridge does not match any events against the rule.\n* `ENABLED`: The rule is enabled.\n EventBridge matches events against the rule, *except* for AWS management events delivered through CloudTrail.\n* `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`: The rule is enabled for all\n events, including AWS management events delivered through CloudTrail.\n \n Management events provide visibility into management operations that are performed on\n resources in your AWS account. These are also known as control plane\n operations. For more information, see [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events) in the *CloudTrail User\n Guide*, and [Filtering management events from AWS services](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail) in the\n **Amazon EventBridge User Guide**.\n \n This value is only valid for rules on the [default](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses) event bus\n or [custom event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html).\n It does not apply to [partner event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `DISABLED | ENABLED | ENABLE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED", "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nAdds the specified targets to the specified rule, or updates the targets if they are\nalready 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.\n###### Note\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)\nin the **Amazon EventBridge User Guide**.\nCreating rules with built-in targets is supported only in the AWS Management Console. The\nbuilt-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\ntarget is a Kinesis data stream, you can optionally specify which shard the event\ngoes to by using the `KinesisParameters` argument. To invoke a command on multiple\nEC2 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\nneeds the appropriate permissions:\n* For AWS Lambda and Amazon SNS resources, EventBridge relies\n on resource-based policies.\n* For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and\n API Gateway APIs, EventBridge relies on IAM roles that you specify in the\n `RoleARN` argument in `PutTargets`.\nFor more information, see [Authentication\nand 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\n(using `PutPermission`), you can send events to that account. Set that account's\nevent bus as a target of the rules in your account. To send the matched events to the other\naccount, specify that account's event bus as the `Arn` value when you run\n`PutTargets`. If your account sends events to another account, your account is\ncharged for each sent event. Each event sent to another account is charged as a custom event.\nThe account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing](https://aws.amazon.com/eventbridge/pricing/).\n###### Note\n`Input`, `InputPath`, and `InputTransformer` are not\navailable 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\ngranted permission to your account through an organization instead of directly by the account\nID, then you must specify a `RoleArn` with proper permissions in the\n`Target` structure. For more information, see [Sending and\nReceiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*.\n###### Note\nIf you have an IAM role on a cross-account event bus target, a `PutTargets`\ncall without a role on the same target (same `Id` and `Arn`) will not\nremove the role.\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\n**InputTransformer** are mutually exclusive and optional\nparameters 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\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n 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\n the matched event is overridden with this constant.\n* If **InputPath** is specified in the form of JSONPath\n (for example, `$.detail`), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).\n* If **InputTransformer** is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.\nWhen you specify `InputPath` or `InputTransformer`, you must use\nJSON dot notation, not bracket notation.\nWhen you add targets to a rule and the associated rule triggers soon after, new or updated\ntargets might not be immediately invoked. Allow a short period of time for changes to take\neffect.\nThis action can partially fail if too many requests are made at the same time. If that\nhappens, `FailedEntryCount` is non-zero in the response and each entry in\n`FailedEntries` provides the ID of the failed target and the error code.\n*Required*: No\n*Type*: Array of [Target](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Target", "DuplicatesAllowed": false }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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\npermission to your account through an organization instead of directly by the account ID, you\nmust specify a `RoleArn` with proper permissions in the `Target`\nstructure, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-events-rule-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\.\\-_A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the rule, such as\n`arn:aws:events:us-east-2:123456789012:rule/example`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#Arn-fn::getatt" } } }, "AWS::Evidently::Experiment": { "MarkdownDocumentation": "`AWS::Evidently::Experiment`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html", "Properties": { "Project": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-project", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RunningStatus": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-runningstatus", "UpdateType": "Mutable", "Required": false, "Type": "RunningStatusObject" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricGoals": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-metricgoals", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MetricGoalObject", "DuplicatesAllowed": false }, "OnlineAbConfig": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-onlineabconfig", "UpdateType": "Mutable", "Required": true, "Type": "OnlineAbConfigObject" }, "RemoveSegment": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-removesegment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RandomizationSalt": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-randomizationsalt", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Treatments": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-treatments", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "TreatmentObject", "DuplicatesAllowed": false }, "SamplingRate": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-samplingrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Segment": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-segment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#Arn-fn::getatt" } } }, "AWS::Evidently::Feature": { "MarkdownDocumentation": "`AWS::Evidently::Feature`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html", "Properties": { "Project": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-project", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EvaluationStrategy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-evaluationstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultVariation": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-defaultvariation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EntityOverrides": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-entityoverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EntityOverride", "DuplicatesAllowed": false }, "Variations": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-variations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "VariationObject", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#Arn-fn::getatt" } } }, "AWS::Evidently::Launch": { "MarkdownDocumentation": "`AWS::Evidently::Launch`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html", "Properties": { "Project": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-project", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionStatus": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-executionstatus", "UpdateType": "Mutable", "Required": false, "Type": "ExecutionStatusObject" }, "Groups": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-groups", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "LaunchGroupObject", "DuplicatesAllowed": false }, "RandomizationSalt": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-randomizationsalt", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricMonitors": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-metricmonitors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricDefinitionObject", "DuplicatesAllowed": false }, "ScheduledSplitsConfig": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-scheduledsplitsconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "StepConfig", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#Arn-fn::getatt" } } }, "AWS::Evidently::Project": { "MarkdownDocumentation": "`AWS::Evidently::Project`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html", "Properties": { "DataDelivery": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-datadelivery", "UpdateType": "Mutable", "Required": false, "Type": "DataDeliveryObject" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AppConfigResource": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-appconfigresource", "UpdateType": "Mutable", "Required": false, "Type": "AppConfigResourceObject" }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#Arn-fn::getatt" } } }, "AWS::Evidently::Segment": { "MarkdownDocumentation": "`AWS::Evidently::Segment`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html", "Properties": { "Pattern": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-pattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#Arn-fn::getatt" } } }, "AWS::FIS::ExperimentTemplate": { "MarkdownDocumentation": "`AWS::FIS::ExperimentTemplate`\n\nSpecifies an experiment template.\nAn experiment template includes the following components:\n* **Targets**: A target can be a specific resource\n in your AWS environment, or one or more resources that match criteria that you\n specify, for example, resources that have specific tags.\n* **Actions**: The actions to carry out on the\n target. You can specify multiple actions, the duration of each action, and when\n to start each action during an experiment.\n* **Stop conditions**: If a stop condition is\n triggered while an experiment is running, the experiment is automatically\n stopped. You can define a stop condition as a CloudWatch alarm.\nFor more information, see [Experiment templates](https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html)\nin the *AWS Fault Injection Service User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the experiment template ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html", "Properties": { "ExperimentReportConfiguration": { "MarkdownDocumentation": "`ExperimentReportConfiguration`\n\nDescribes the report configuration for the experiment template.\n*Required*: No\n*Type*: [ExperimentTemplateExperimentReportConfiguration](./aws-properties-fis-experimenttemplate-experimenttemplateexperimentreportconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-experimentreportconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExperimentTemplateExperimentReportConfiguration" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the experiment template.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions for the experiment.\n*Required*: No\n*Type*: Object of [ExperimentTemplateAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-actions", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "ExperimentTemplateAction" }, "ExperimentOptions": { "MarkdownDocumentation": "`ExperimentOptions`\n\nThe experiment options for an experiment template.\n*Required*: No\n*Type*: [ExperimentTemplateExperimentOptions](./aws-properties-fis-experimenttemplate-experimenttemplateexperimentoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-experimentoptions", "UpdateType": "Mutable", "Required": false, "Type": "ExperimentTemplateExperimentOptions" }, "StopConditions": { "MarkdownDocumentation": "`StopConditions`\n\nThe stop conditions for the experiment.\n*Required*: Yes\n*Type*: Array of [ExperimentTemplateStopCondition](./aws-properties-fis-experimenttemplate-experimenttemplatestopcondition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-stopconditions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ExperimentTemplateStopCondition", "DuplicatesAllowed": true }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe targets for the experiment.\n*Required*: Yes\n*Type*: Object of [ExperimentTemplateTarget](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-targets", "UpdateType": "Mutable", "Required": true, "Type": "Map", "ItemType": "ExperimentTemplateTarget" }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe configuration for experiment logging.\n*Required*: No\n*Type*: [ExperimentTemplateLogConfiguration](./aws-properties-fis-experimenttemplate-experimenttemplatelogconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExperimentTemplateLogConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role.\n*Required*: Yes\n*Type*: String\n*Maximum*: `1224`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the experiment template.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,128}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#cfn-fis-experimenttemplate-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the experiment template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html#Id-fn::getatt" } } }, "AWS::FIS::TargetAccountConfiguration": { "MarkdownDocumentation": "`AWS::FIS::TargetAccountConfiguration`\n\nCreates a target account configuration for the experiment template. A target account configuration\nis required when `accountTargeting` of `experimentOptions` is set to `multi-account`.\nFor more information, see [experiment options](https://docs.aws.amazon.com/fis/latest/userguide/experiment-options.html)\nin the *AWS Fault Injection Service User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-targetaccountconfiguration.html", "Properties": { "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThe AWS account ID of the target account.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-targetaccountconfiguration.html#cfn-fis-targetaccountconfiguration-accountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the target account.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-targetaccountconfiguration.html#cfn-fis-targetaccountconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExperimentTemplateId": { "MarkdownDocumentation": "`ExperimentTemplateId`\n\nThe ID of the experiment template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\S]+`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-targetaccountconfiguration.html#cfn-fis-targetaccountconfiguration-experimenttemplateid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role for the target account.\n*Required*: Yes\n*Type*: String\n*Maximum*: `1224`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-targetaccountconfiguration.html#cfn-fis-targetaccountconfiguration-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FMS::NotificationChannel": { "MarkdownDocumentation": "`AWS::FMS::NotificationChannel`\n\nDesignates the IAM role and Amazon Simple Notification Service (SNS) topic to use to record SNS logs.\nTo perform this action outside of the console, you must configure the SNS topic to allow the\nrole `AWSServiceRoleForFMS` to publish SNS logs. For more information, see\n[Firewall Manager required permissions for API actions](https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html) in the *AWS Firewall Manager Developer Guide*.\n", "RefReturnValue": "\nThe `Ref` for this resource returns the `SnsTopicArn`. This is\nthe Amazon Resource Name (ARN) that uniquely identifies the Amazon Simple Notification Service (Amazon SNS) topic. For\nexample, `arn:aws:sns:us-west-2:111122223333:MyTopic`. For more information about SNS, see [Amazon Simple Notification Service Resource Type Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_SNS.html).\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-notificationchannel.html", "Properties": { "SnsTopicArn": { "MarkdownDocumentation": "`SnsTopicArn`\n\nThe Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([^\\s]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-notificationchannel.html#cfn-fms-notificationchannel-snstopicarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SnsRoleName": { "MarkdownDocumentation": "`SnsRoleName`\n\nThe 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*Pattern*: `^([^\\s]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-notificationchannel.html#cfn-fms-notificationchannel-snsrolename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::FMS::Policy": { "MarkdownDocumentation": "`AWS::FMS::Policy`\n\nAn AWS Firewall Manager policy.\nA Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple\npolicy types across accounts, you can create multiple policies. You can create more than one\npolicy for each type.\nIf you add a new account to an organization that you created with AWS Organizations, Firewall Manager\nautomatically applies the policy to the resources in that account that are within scope of\nthe policy.\nPolicies require some setup to use. For more information, see the sections on prerequisites and getting started\nunder [Firewall Manager prerequisites](https://docs.aws.amazon.com/waf/latest/developerguide/fms-prereq.html).\nFirewall Manager provides the following types of policies:\n* **AWS WAF policy** - This policy applies AWS WAF web ACL\n protections to specified accounts and resources.\n* **Shield Advanced policy** - This policy applies Shield Advanced\n protection to specified accounts and resources.\n* **Security Groups policy** - This type of policy gives you\n control over security groups that are in use throughout your organization in\n AWS Organizations and lets you enforce a baseline set of rules across your organization.\n* **Network ACL policy** - This type of policy gives you\n control over the network ACLs that are in use throughout your organization in\n AWS Organizations and lets you enforce a baseline set of first and last network ACL rules across your organization.\n* **Network Firewall policy** - This policy applies\n Network Firewall protection to your organization's VPCs.\n* **DNS Firewall policy** - This policy applies\n Amazon Route\u00a053 Resolver DNS Firewall protections to your organization's VPCs.\n* **Third-party firewall policy** - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the AWS Marketplace console at [AWS Marketplace](https://aws.amazon.com/marketplace).\n \n + **Palo Alto Networks Cloud NGFW policy** - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.\n + **Fortigate CNF policy** - This policy applies\n Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.\n", "RefReturnValue": "\nThe `Ref` for this resource returns the `PolicyId`.\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html", "Properties": { "ResourceTagLogicalOperator": { "MarkdownDocumentation": "`ResourceTagLogicalOperator`\n\nSpecifies whether to combine multiple resource tags with AND,\nso that a resource must have all tags to be included or excluded, or OR,\nso that a resource must have at least one tag.\nDefault: `AND`\n*Required*: No\n*Type*: String\n*Allowed values*: `AND | OR`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "AND", "OR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcetaglogicaloperator", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourcesCleanUp": { "MarkdownDocumentation": "`ResourcesCleanUp`\n\nIndicates whether AWS Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\nthat Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\nfrom 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcescleanup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nAn array of `ResourceTag` objects, used to explicitly include resources in the\npolicy scope or explicitly exclude them. If this isn't set, then tags aren't used to modify policy scope. See\nalso `ExcludeResourceTags`.\n*Required*: No\n*Type*: Array of [ResourceTag](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceTag", "DuplicatesAllowed": true }, "ExcludeResourceTags": { "MarkdownDocumentation": "`ExcludeResourceTags`\n\nUsed only when tags are specified in the `ResourceTags` property. If this property\nis `True`, resources with the specified tags are not in scope of the policy. If it's `False`,\nonly 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-excluderesourcetags", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource protected by or in scope of the policy. This is in the format shown\nin the [AWS Resource Types Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).\nTo apply this policy to multiple resource types, specify a resource type of `ResourceTypeList` and then specify the resource types in a `ResourceTypeList`.\nThe following are valid resource types for each Firewall Manager policy type:\n* AWS WAF Classic - `AWS::ApiGateway::Stage`, `AWS::CloudFront::Distribution`, and `AWS::ElasticLoadBalancingV2::LoadBalancer`.\n* AWS WAF - `AWS::ApiGateway::Stage`, `AWS::ElasticLoadBalancingV2::LoadBalancer`, and `AWS::CloudFront::Distribution`.\n* Shield Advanced - `AWS::ElasticLoadBalancingV2::LoadBalancer`, `AWS::ElasticLoadBalancing::LoadBalancer`, `AWS::EC2::EIP`, and `AWS::CloudFront::Distribution`.\n* Network ACL - `AWS::EC2::Subnet`.\n* Security group usage audit - `AWS::EC2::SecurityGroup`.\n* Security group content audit - `AWS::EC2::SecurityGroup`, `AWS::EC2::NetworkInterface`, and `AWS::EC2::Instance`.\n* DNS Firewall, AWS Network Firewall, and third-party firewall - `AWS::EC2::VPC`.\n*Required*: No\n*Type*: String\n*Pattern*: `^([^\\s]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceSetIds": { "MarkdownDocumentation": "`ResourceSetIds`\n\nThe unique identifiers of the resource sets used by the policy.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcesetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SecurityServicePolicyData": { "MarkdownDocumentation": "`SecurityServicePolicyData`\n\nDetails 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.\n For security group policies, Firewall Manager supports one security group for\n each common policy and for each content audit policy. This is an adjustable limit that you\n can increase by contacting AWS Support.\n \n Valid values: `DNS_FIREWALL` | `NETWORK_FIREWALL` | `SECURITY_GROUPS_COMMON` | `SECURITY_GROUPS_CONTENT_AUDIT` | `SECURITY_GROUPS_USAGE_AUDIT` | `SHIELD_ADVANCED` | `THIRD_PARTY_FIREWALL` | `WAFV2` | `WAF`\n* ManagedServiceData - Details about the service that are specific to the service type, in JSON format.\n \n + Example: `DNS_FIREWALL`\n \n `\"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"`\n \n ###### Note\n \n Valid values for `preProcessRuleGroups` are between 1 and 99. Valid\n values for `postProcessRuleGroups` are between 9901 and 10000.\n + Example: `NETWORK_FIREWALL` - Centralized deployment\n model\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}},\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n + Example: `NETWORK_FIREWALL` - Distributed deployment model with\n automatic Availability Zone configuration\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"OFF\\\"},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"`\n \n With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n + Example: `NETWORK_FIREWALL` - Distributed deployment model with\n automatic Availability Zone configuration and route management\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"]},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\": \\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n + Example: `NETWORK_FIREWALL` - Distributed deployment model with\n custom Availability Zone configuration\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\", \\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{ \\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"]}]} },\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"OFF\\\",\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"`\n \n With custom Availability Zone configuration,\n you define which specific Availability Zones to create endpoints in by configuring\n `firewallCreationConfig`. To configure the Availability Zones in `firewallCreationConfig`, specify either the `availabilityZoneName` or `availabilityZoneId` parameter, not both parameters.\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n + Example: `NETWORK_FIREWALL` - Distributed deployment model with\n custom Availability Zone configuration and route management\n \n `\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"],\\\"routeManagementConfig\\\":{\\\"allowCrossAZTrafficIfNoEndpoint\\\":true}},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to\n `DISTRIBUTED`.\n + Example: `THIRD_PARTY_FIREWALL` - Palo Alto Networks Cloud Next-Generation Firewall centralized deployment model\n \n `\"{ \\\"type\\\":\\\"THIRD_PARTY_FIREWALL\\\", \\\"thirdPartyFirewall\\\":\\\"PALO_ALTO_NETWORKS_CLOUD_NGFW\\\", \\\"thirdPartyFirewallConfig\\\":{ \\\"thirdPartyFirewallPolicyList\\\":[\\\"global-1\\\"] },\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) to\n `CENTRALIZED`.\n + Example: `THIRD_PARTY_FIREWALL` - Palo Alto Networks Cloud Next-Generation Firewall distributed deployment model\n \n `\"{\\\"type\\\":\\\"THIRD_PARTY_FIREWALL\\\",\\\"thirdPartyFirewall\\\":\\\"PALO_ALTO_NETWORKS_CLOUD_NGFW\\\",\\\"thirdPartyFirewallConfig\\\":{\\\"thirdPartyFirewallPolicyList\\\":[\\\"global-1\\\"] },\\\"firewallDeploymentModel\\\":{ \\\"distributedFirewallDeploymentModel\\\":{ \\\"distributedFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ {\\\"availabilityZoneName\\\":\\\"${AvailabilityZone}\\\" } ] } }, \\\"allowedIPV4CidrList\\\":[ ] } } } }\"`\n \n To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) to\n `DISTRIBUTED`.\n + Specification for `SHIELD_ADVANCED` for Amazon CloudFront distributions\n \n `\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\",\n \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"},\n \\\"overrideCustomerWebaclClassic\\\":true|false}\"`\n \n For example:\n `\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"`\n \n The default value for `automaticResponseStatus` is\n `IGNORED`. The value for `automaticResponseAction` is only\n required when `automaticResponseStatus` is set to `ENABLED`.\n The default value for `overrideCustomerWebaclClassic` is\n `false`.\n \n For other resource types that you can protect with a Shield Advanced policy, this\n `ManagedServiceData` configuration is an empty string.\n + Example: `WAFV2`\n \n `\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"`\n \n In the `loggingConfiguration`, you can specify one\n `logDestinationConfigs`, you can optionally provide up to 20\n `redactedFields`, and the `RedactedFieldType` must be one of\n `URI`, `QUERY_STRING`, `HEADER`, or\n `METHOD`.\n + Example: `AWS WAF Classic`\n \n `\"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\":\n [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\":\n \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"`\n + Example: `WAFV2` - AWS Firewall Manager support for AWS WAF managed rule group versioning\n \n `\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":true,\\\"version\\\":\\\"Version_2.0\\\",\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesCommonRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"`\n \n To use a specific version of a AWS WAF managed rule group in your Firewall Manager policy, you must set `versionEnabled` to `true`, and set `version` to the version you'd like to use. If you don't set `versionEnabled` to `true`, or if you omit `versionEnabled`, then Firewall Manager uses the default version of the AWS WAF managed rule group.\n + Example: `SECURITY_GROUPS_COMMON`\n \n `\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"`\n + Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as\n well as to those in VPCs that the account owns\n \n `\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"`\n + Example: `SECURITY_GROUPS_CONTENT_AUDIT`\n \n `\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"`\n \n The security group action for content audit can be `ALLOW` or\n `DENY`. For `ALLOW`, all in-scope security group rules must\n be within the allowed range of the policy's security group rules. For\n `DENY`, all in-scope security group rules must not contain a value or a\n range that matches a rule value or range in the policy security group.\n + Example: `SECURITY_GROUPS_USAGE_AUDIT`\n \n `\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"`\n*Required*: Yes\n*Type*: [SecurityServicePolicyData](./aws-properties-fms-policy-securityservicepolicydata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-securityservicepolicydata", "UpdateType": "Mutable", "Required": true, "Type": "SecurityServicePolicyData" }, "RemediationEnabled": { "MarkdownDocumentation": "`RemediationEnabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-remediationenabled", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "DeleteAllPolicyResources": { "MarkdownDocumentation": "`DeleteAllPolicyResources`\n\nUsed when deleting a policy. If `true`, Firewall Manager performs cleanup according to the policy type.\nFor AWS WAF and Shield Advanced policies, Firewall Manager does the following:\n* Deletes rule groups created by Firewall Manager\n* Removes web ACLs from in-scope resources\n* Deletes web ACLs that contain no rules or rule groups\nFor security group policies, Firewall Manager does the following for each security group in the policy:\n* Disassociates the security group from in-scope resources\n* Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy\nAfter the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-deleteallpolicyresources", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExcludeMap": { "MarkdownDocumentation": "`ExcludeMap`\n\nSpecifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy.\nSpecifying 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\napplies the policy to all accounts specified by the `IncludeMap`, and\ndoes not evaluate any `ExcludeMap` specifications. If you do not specify an `IncludeMap`, then Firewall Manager\napplies 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:\n `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d]}`.\n* Specify OUs by setting the key to `ORGUNIT`. For example, the following is a valid map:\n `{\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:\n `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d], \u201cORGUNIT\u201d : [\u201couid111\u201d, \u201couid112\u201d]}`.\n*Required*: No\n*Type*: [IEMap](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-excludemap", "UpdateType": "Mutable", "Required": false, "Type": "IEMap" }, "IncludeMap": { "MarkdownDocumentation": "`IncludeMap`\n\nSpecifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy.\nSpecifying 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\napplies the policy to all accounts specified by the `IncludeMap`, and\ndoes not evaluate any `ExcludeMap` specifications. If you do not specify an `IncludeMap`, then Firewall Manager\napplies 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:\n `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d]}`.\n* Specify OUs by setting the key to `ORGUNIT`. For example, the following is a valid map:\n `{\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:\n `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d], \u201cORGUNIT\u201d : [\u201couid111\u201d, \u201couid112\u201d]}`.\n*Required*: No\n*Type*: [IEMap](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-includemap", "UpdateType": "Mutable", "Required": false, "Type": "IEMap" }, "PolicyDescription": { "MarkdownDocumentation": "`PolicyDescription`\n\nYour description of the AWS Firewall Manager policy.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_.:/=+\\-@\\s]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-policydescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the AWS Firewall Manager policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_.:/=+\\-@\\s]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-policyname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceTypeList": { "MarkdownDocumentation": "`ResourceTypeList`\n\nAn 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-resourcetypelist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA collection of 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.\n*Required*: No\n*Type*: Array of [PolicyTag](./aws-properties-fms-policy-policytag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#cfn-fms-policy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PolicyTag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html#Arn-fn::getatt" } } }, "AWS::FMS::ResourceSet": { "MarkdownDocumentation": "`AWS::FMS::ResourceSet`\n\nA set of resources to include in a policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-resourceset.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the resource set.\n*Required*: No\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_.:/=+\\-@\\s]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-resourceset.html#cfn-fms-resourceset-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceTypeList": { "MarkdownDocumentation": "`ResourceTypeList`\n\nDetermines the resources that can be associated to the resource set. Depending on\nyour setting for max results and the number of resource sets, a single call might not\nreturn the full list.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-resourceset.html#cfn-fms-resourceset-resourcetypelist", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Resources": { "MarkdownDocumentation": "`Resources`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-resourceset.html#cfn-fms-resourceset-resources", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-fms-resourceset-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-resourceset.html#cfn-fms-resourceset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe descriptive name of the resource set. You can't change the name of a resource set after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([a-zA-Z0-9_.:/=+\\-@\\s]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-resourceset.html#cfn-fms-resourceset-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nA unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-resourceset.html#Id-fn::getatt" } } }, "AWS::FSx::DataRepositoryAssociation": { "MarkdownDocumentation": "`AWS::FSx::DataRepositoryAssociation`\n\nCreates an Amazon FSx for Lustre data repository association (DRA). A data\nrepository association is a link between a directory on the file system and\nan Amazon S3 bucket or prefix. You can have a maximum of 8 data repository\nassociations on a file system. Data repository associations are supported on\nall FSx for Lustre 2.12 and newer file systems, excluding `scratch_1` deployment type.\nEach data repository association must have a unique Amazon FSx file\nsystem directory and a unique S3 bucket or prefix associated with it. You\ncan configure a data repository association for automatic import only,\nfor automatic export only, or for both. To learn more about linking a\ndata repository to your file system, see\n[Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the data repository association resource ID. For example:\n`{\"Ref\":\"data_repository_association_logical_id\"}`\nReturns `dra-0123456789abcdef6`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html", "Properties": { "FileSystemPath": { "MarkdownDocumentation": "`FileSystemPath`\n\nA path on the Amazon FSx for Lustre file system that points to a high-level directory (such\nas `/ns1/`) or subdirectory (such as `/ns1/subdir/`)\nthat will be mapped 1-1 with `DataRepositoryPath`.\nThe leading forward slash in the name is required. Two data repository\nassociations cannot have overlapping file system paths. For example, if\na data repository is associated with file system path `/ns1/`,\nthen you cannot link another data repository with file system\npath `/ns1/ns2`.\nThis path specifies where in your file system files will be exported\nfrom or imported to. This file system directory can be linked to only one\nAmazon S3 bucket, and no other S3 bucket can be linked to the directory.\n###### Note\nIf you specify only a forward slash (`/`) as the file system\npath, you can link only one data repository to the file system. You can only specify\n\"/\" as the file system path for the first data repository associated with a file system.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-filesystempath", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DataRepositoryPath": { "MarkdownDocumentation": "`DataRepositoryPath`\n\nThe path to the Amazon S3 data repository that will be linked to the file\nsystem. The path can be an S3 bucket or prefix in the format\n`s3://myBucket/myPrefix/`. This path specifies where in the S3\ndata repository files will be imported from or exported to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$`\n*Minimum*: `3`\n*Maximum*: `4357`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-datarepositorypath", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BatchImportMetaDataOnCreate": { "MarkdownDocumentation": "`BatchImportMetaDataOnCreate`\n\nA boolean flag indicating whether an import data repository task to import\nmetadata should run after the data repository association is created. The\ntask 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-batchimportmetadataoncreate", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "S3": { "MarkdownDocumentation": "`S3`\n\nThe configuration for an Amazon S3 data repository linked to an\nAmazon FSx Lustre file system with a data repository association.\nThe configuration defines which file events (new, changed, or\ndeleted files or directories) are automatically imported from\nthe linked data repository to the file system or automatically\nexported from the file system to the data repository.\n*Required*: No\n*Type*: [S3](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-s3", "UpdateType": "Mutable", "Required": false, "Type": "S3" }, "FileSystemId": { "MarkdownDocumentation": "`FileSystemId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-filesystemid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ImportedFileChunkSize": { "MarkdownDocumentation": "`ImportedFileChunkSize`\n\nFor files imported from a data repository, this value determines the stripe count and\nmaximum amount of data per file (in MiB) stored on a single physical disk. The maximum\nnumber of disks that a single file can be striped across is limited by the total number\nof 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\nGiB). 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-importedfilechunksize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of `Tag` values, with a maximum of 50 elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-fsx-datarepositoryassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ResourceARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceARN`\n\nReturns the data repository association's Amazon Resource Name (ARN).\nExample: `arn:aws:fsx:us-east-1:111122223333:association/fs-abc012345def6789a/dra-abcdef0123456789b`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#ResourceARN-fn::getatt" }, "AssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationId`\n\nReturns the data repository association's system generated Association ID.\nExample: `dra-abcdef0123456789d`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#AssociationId-fn::getatt" } } }, "AWS::FSx::FileSystem": { "MarkdownDocumentation": "`AWS::FSx::FileSystem`\n\nThe `AWS::FSx::FileSystem` resource is an Amazon FSx resource type\nthat specifies an Amazon FSx file system. You can create any of the following\nsupported file system types:\n* Amazon FSx for Lustre\n* Amazon FSx for NetApp ONTAP\n* FSx for OpenZFS\n* Amazon FSx for Windows File Server\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the file system resource ID. For example:\n`{\"Ref\":\"file_system_logical_id\"}`\nReturns `fs-0123456789abcdef6`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html", "Attributes": { "ResourceARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceARN`\n\nReturns the Amazon Resource Name (ARN) for the Amazon FSx file system.\nExample: `arn:aws:fsx:us-east-2:111122223333:file-system/fs-0123abcd56789ef0a`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#ResourceARN-fn::getatt" }, "RootVolumeId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RootVolumeId`\n\nReturns the root volume ID of the FSx for OpenZFS file system.\nExample: `fsvol-0123456789abcdefa`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#RootVolumeId-fn::getatt" }, "DNSName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DNSName`\n\nReturns the FSx for Windows file system's DNSName.\nExample: `amznfsxp1honlek.corp.example.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#DNSName-fn::getatt" }, "LustreMountName": { "PrimitiveType": "String", "MarkdownDocumentation": "`LustreMountName`\n\nReturns the Lustre file system's `LustreMountName`.\nExample for `SCRATCH_1` deployment types: This value is always `fsx`.\nExample for `SCRATCH_2` and `PERSISTENT` deployment types: `2p3fhbmv`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#LustreMountName-fn::getatt" } }, "Properties": { "StorageType": { "Required": false, "MarkdownDocumentation": "`StorageType`\n\nSets the storage class for the file system that you're creating. Valid values are\n`SSD`, `HDD`, and `INTELLIGENT_TIERING`.\n* Set to `SSD` to use solid state drive storage. SSD is supported on all Windows,\n Lustre, ONTAP, and OpenZFS deployment types.\n* Set to `HDD` to use hard disk drive storage, which is supported on\n `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types,\n and on `PERSISTENT_1` Lustre file system deployment types.\n* Set to `INTELLIGENT_TIERING` to use fully elastic, intelligently-tiered storage.\n Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type\n and for Lustre file systems with the Persistent\\_2 deployment type.\nDefault value is `SSD`. For more information, see [Storage\ntype options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User\nGuide*, [FSx for Lustre storage classes](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-storage-classes)\nin the *FSx for Lustre User Guide*, and [Working with Intelligent-Tiering](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance-intelligent-tiering)\nin the *Amazon FSx for OpenZFS User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `SSD | HDD | INTELLIGENT_TIE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SSD", "HDD", "INTELLIGENT_TIERING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagetype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nThe ID of the AWS Key Management Service (AWS KMS) key used to encrypt Amazon FSx file\nsystem data. Used as follows with Amazon FSx file system types:\n* Amazon FSx for Lustre `PERSISTENT_1`\n and `PERSISTENT_2` deployment types only.\n \n `SCRATCH_1` and `SCRATCH_2` types are encrypted using\n the Amazon FSx service AWS KMS key for your account.\n* Amazon FSx for NetApp ONTAP\n* Amazon FSx for OpenZFS\n* Amazon FSx for Windows File Server\nIf this ID isn't specified, the Amazon FSx-managed key for your account is used. For more information,\nsee [Encrypt](https://docs.aws.amazon.com//kms/latest/APIReference/API_Encrypt.html) in the\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-kmskeyid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "StorageCapacity": { "Required": false, "MarkdownDocumentation": "`StorageCapacity`\n\nSets the storage capacity of the file system that you're creating.\n`StorageCapacity` is required if you are creating a new file system. It is not required if you are creating a\nfile system by restoring a backup.\n**FSx for Lustre file systems** - The amount of\nstorage capacity that you can configure depends on the value that you set for\n`StorageType` and the Lustre `DeploymentType`, as\nfollows:\n* For `SCRATCH_2`, `PERSISTENT_2` and\n `PERSISTENT_1` deployment types using SSD storage type, the valid\n values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.\n* For `PERSISTENT_1` HDD file systems, valid values are increments of\n 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB\n file systems.\n* For `SCRATCH_1` deployment type, valid values are 1200 GiB, 2400\n GiB, and increments of 3600 GiB.\n**FSx for ONTAP file systems** - The amount of SSD storage capacity that you\ncan configure depends on the value of the `HAPairs` property. The minimum value is calculated as 1,024 GiB \\* HAPairs and\nthe maximum is calculated as 524,288 GiB \\* HAPairs, up to a maximum amount of SSD storage capacity of 1,048,576 GiB\n(1 pebibyte).\n**FSx for OpenZFS file systems** - The amount of storage\ncapacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). If you are creating a\nfile system from a backup, you can specify a storage capacity equal to or greater than the original\nfile system's storage capacity.\n**FSx for Windows File Server file systems** - The amount\nof storage capacity that you can configure depends on the value that you set for\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagecapacity", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "LustreConfiguration": { "Type": "LustreConfiguration", "Required": false, "MarkdownDocumentation": "`LustreConfiguration`\n\nThe Lustre configuration for the file system being created. This configuration is required if the `FileSystemType` is\nset to `LUSTRE`.\n###### Note\nThe following parameters are not supported when creating Lustre file systems with a data repository association.\n* `AutoImportPolicy`\n* `ExportPath`\n* `ImportedChunkSize`\n* `ImportPath`\n*Required*: Conditional\n*Type*: [LustreConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-lustreconfiguration", "UpdateType": "Mutable" }, "BackupId": { "Required": false, "MarkdownDocumentation": "`BackupId`\n\nThe ID of the file system backup that you are using to create a file system. For more information,\nsee [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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-backupid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "OntapConfiguration": { "Type": "OntapConfiguration", "Required": false, "MarkdownDocumentation": "`OntapConfiguration`\n\nThe ONTAP configuration properties of the FSx for ONTAP file system that you\nare creating. This configuration is required if the `FileSystemType` is set to\n`ONTAP`.\n*Required*: Conditional\n*Type*: [OntapConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-ontapconfiguration", "UpdateType": "Mutable" }, "SubnetIds": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`SubnetIds`\n\nSpecifies the IDs of the subnets that the file system will be accessible from. For\nWindows and ONTAP `MULTI_AZ_1` deployment types,provide exactly two subnet\nIDs, one for the preferred file server and one for the standby file server. You specify\none of these subnets as the preferred subnet using the `WindowsConfiguration >\nPreferredSubnetID` or `OntapConfiguration > PreferredSubnetID`\nproperties. 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\n*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\nGuide*.\nFor Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` and all Lustre\ndeployment types, provide exactly one subnet ID.\nThe file server is launched in that subnet's Availability Zone.\n*Required*: Yes\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-subnetids", "UpdateType": "Immutable" }, "SecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of IDs specifying the security groups to apply to all network interfaces\ncreated for file system access. This list isn't returned in later requests to\ndescribe the file system.\n###### Important\nYou must specify a security group if you are creating a Multi-AZ\nFSx for ONTAP file system in a VPC subnet that has been shared with you.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-securitygroupids", "UpdateType": "Immutable" }, "WindowsConfiguration": { "Type": "WindowsConfiguration", "Required": false, "MarkdownDocumentation": "`WindowsConfiguration`\n\nThe configuration object for the Microsoft Windows file system you are creating. This configuration is required if `FileSystemType`\nis set to `WINDOWS`.\n*Required*: Conditional\n*Type*: [WindowsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-windowsconfiguration", "UpdateType": "Mutable" }, "FileSystemTypeVersion": { "Required": false, "MarkdownDocumentation": "`FileSystemTypeVersion`\n\nFor FSx for Lustre file systems, sets the Lustre version for the file system\nthat you're creating. Valid values are `2.10`, `2.12`, and\n`2.15`:\n* `2.10` is supported by the Scratch and Persistent\\_1 Lustre\n deployment types.\n* `2.12` is supported by all Lustre deployment types, except\n for `PERSISTENT_2` with a metadata configuration mode.\n* `2.15` is supported by all Lustre deployment types and is\n recommended for all new file systems.\nDefault value is `2.10`, except for the following deployments:\n* Default value is `2.12` when `DeploymentType` is set to\n `PERSISTENT_2` without a metadata configuration mode.\n* Default value is `2.15` when `DeploymentType` is set to\n `PERSISTENT_2` with a metadata configuration mode.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9](.[0-9]*)*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtypeversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "OpenZFSConfiguration": { "Type": "OpenZFSConfiguration", "Required": false, "MarkdownDocumentation": "`OpenZFSConfiguration`\n\nThe Amazon FSx for OpenZFS configuration properties for the file system that you are creating.\nThis configuration is required if the `FileSystemType` is set to `OPENZFS`.\n*Required*: Conditional\n*Type*: [OpenZFSConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-openzfsconfiguration", "UpdateType": "Mutable" }, "NetworkType": { "Required": false, "MarkdownDocumentation": "`NetworkType`\n\nThe network type of the file system.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | DUAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "DUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-networktype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "FileSystemType": { "Required": true, "MarkdownDocumentation": "`FileSystemType`\n\nThe type of Amazon FSx file system, which can be `LUSTRE`,\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to associate with the file system. For more information, see [Tagging your\nAmazon FSx resources](https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html) in the *Amazon FSx for Lustre User\nGuide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-fsx-filesystem-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::FSx::S3AccessPointAttachment": { "MarkdownDocumentation": "`AWS::FSx::S3AccessPointAttachment`\n\nAn S3 access point attached to an Amazon FSx volume.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html", "Properties": { "OpenZFSConfiguration": { "MarkdownDocumentation": "`OpenZFSConfiguration`\n\nThe OpenZFSConfiguration of the S3 access point attachment.\n*Required*: No\n*Type*: [S3AccessPointOpenZFSConfiguration](./aws-properties-fsx-s3accesspointattachment-s3accesspointopenzfsconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html#cfn-fsx-s3accesspointattachment-openzfsconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "S3AccessPointOpenZFSConfiguration" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of Amazon FSx volume that the S3 access point is attached to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OPENZFS | ONTAP...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "OPENZFS", "ONTAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html#cfn-fsx-s3accesspointattachment-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "S3AccessPoint": { "MarkdownDocumentation": "`S3AccessPoint`\n\nThe S3 access point configuration of the S3 access point attachment.\n*Required*: No\n*Type*: [S3AccessPoint](./aws-properties-fsx-s3accesspointattachment-s3accesspoint.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html#cfn-fsx-s3accesspointattachment-s3accesspoint", "UpdateType": "Immutable", "Required": false, "Type": "S3AccessPoint" }, "OntapConfiguration": { "MarkdownDocumentation": "`OntapConfiguration`\n\nThe ONTAP configuration of the S3 access point attachment.\n*Required*: No\n*Type*: [S3AccessPointOntapConfiguration](./aws-properties-fsx-s3accesspointattachment-s3accesspointontapconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html#cfn-fsx-s3accesspointattachment-ontapconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "S3AccessPointOntapConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the S3 access point attachment; also used for the name of the S3 access point.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=[a-z0-9])[a-z0-9-]{1,48}[a-z0-9]$`\n*Minimum*: `3`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html#cfn-fsx-s3accesspointattachment-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "S3AccessPoint.Alias": { "PrimitiveType": "String", "MarkdownDocumentation": "`S3AccessPoint.Alias`\n\nA DNS alias that is associated with the file system. You can use a DNS alias to access a file system using\nuser-defined DNS names, in addition to the default DNS name\nthat Amazon FSx assigns to the file system. For more information, see\n[DNS aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html)\nin the *FSx for Windows File Server User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html#S3AccessPoint.Alias-fn::getatt" }, "S3AccessPoint.ResourceARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`S3AccessPoint.ResourceARN`\n\nThe Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS\nresources. We require an ARN when you need to specify a resource unambiguously across\nall of AWS. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) in\nthe *AWS General Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-s3accesspointattachment.html#S3AccessPoint.ResourceARN-fn::getatt" } } }, "AWS::FSx::Snapshot": { "MarkdownDocumentation": "`AWS::FSx::Snapshot`\n\nA snapshot of an Amazon FSx for OpenZFS volume.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the snapshot. For example:\n`{\"Ref\":\"logical_snapshot_id\"}`\nReturns `fsvolsnap-0123456789abcedf5`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-snapshot.html", "Attributes": { "ResourceARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceARN`\n\nReturns the snapshot's Amazon Resource Name (ARN).\nExample: `arn:aws:fsx:us-east-2:111133334444:snapshot/fsvol-01234567890123456/fsvolsnap-0123456789abcedf5`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-snapshot.html#ResourceARN-fn::getatt" } }, "Properties": { "VolumeId": { "Required": true, "MarkdownDocumentation": "`VolumeId`\n\nThe ID of the volume that the snapshot is of.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(fsvol-[0-9a-f]{17,})$`\n*Minimum*: `23`\n*Maximum*: `23`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-snapshot.html#cfn-fsx-snapshot-volumeid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nA list of `Tag` values, with a maximum of 50 elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-fsx-snapshot-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-snapshot.html#cfn-fsx-snapshot-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the snapshot.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_:.-]{1,203}$`\n*Minimum*: `1`\n*Maximum*: `203`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-snapshot.html#cfn-fsx-snapshot-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::FSx::StorageVirtualMachine": { "MarkdownDocumentation": "`AWS::FSx::StorageVirtualMachine`\n\nCreates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ID, such as `svm-01234567890123456`.\nFor example:\n`{\"Ref\": \"svm_logical_id\"}` returns\n`svm-01234567890123456`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html", "Attributes": { "ResourceARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceARN`\n\nReturns the storage virtual machine's Amazon Resource Name (ARN).\nExample: `arn:aws:fsx:us-east-2:111111111111:storage-virtual-machine/fs-0123456789abcdef1/svm-01234567890123456`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#ResourceARN-fn::getatt" }, "StorageVirtualMachineId": { "PrimitiveType": "String", "MarkdownDocumentation": "`StorageVirtualMachineId`\n\nReturns the storgage virtual machine's system generated ID.\nExample: `svm-0123456789abcedf1`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#StorageVirtualMachineId-fn::getatt" }, "UUID": { "PrimitiveType": "String", "MarkdownDocumentation": "`UUID`\n\nReturns the storage virtual machine's system generated unique identifier (UUID).\nExample: `abcd0123-cd45-ef67-11aa-1111aaaa23bc`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#UUID-fn::getatt" } }, "Properties": { "SvmAdminPassword": { "Required": false, "MarkdownDocumentation": "`SvmAdminPassword`\n\nSpecifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.\nDoing 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\nuse the file system's `fsxadmin` user to manage the SVM. For more information, see\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-svmadminpassword", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ActiveDirectoryConfiguration": { "Type": "ActiveDirectoryConfiguration", "Required": false, "MarkdownDocumentation": "`ActiveDirectoryConfiguration`\n\nDescribes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.\n*Required*: No\n*Type*: [ActiveDirectoryConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration", "UpdateType": "Mutable" }, "RootVolumeSecurityStyle": { "Required": false, "MarkdownDocumentation": "`RootVolumeSecurityStyle`\n\nThe 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\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n* `NTFS` if the file system is managed by a Microsoft Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Microsoft Windows user as the service account.\n* `MIXED` This is an advanced setting. For more information, see\n [Volume security style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html)\n in the Amazon FSx for NetApp ONTAP User Guide.\n*Required*: No\n*Type*: String\n*Allowed values*: `UNIX | NTFS | MIXED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "UNIX", "NTFS", "MIXED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-rootvolumesecuritystyle", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FileSystemId": { "Required": true, "MarkdownDocumentation": "`FileSystemId`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-filesystemid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nA list of `Tag` values, with a maximum of 50 elements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-fsx-storagevirtualmachine-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the SVM.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,47}$`\n*Minimum*: `1`\n*Maximum*: `47`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::FSx::Volume": { "MarkdownDocumentation": "`AWS::FSx::Volume`\n\nCreates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID for the volume. For example:\n`{\"Ref\":\"vol_logical_id\"}`\nReturns `fsvol-0123456789abcdef6`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html", "Attributes": { "ResourceARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceARN`\n\nReturns the volume's Amazon Resource Name (ARN).\nExample: `arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#ResourceARN-fn::getatt" }, "VolumeId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VolumeId`\n\nReturns the volume's ID.\nExample: `fsvol-0123456789abcdefa`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#VolumeId-fn::getatt" }, "UUID": { "PrimitiveType": "String", "MarkdownDocumentation": "`UUID`\n\nReturns the volume's universally unique identifier (UUID).\nExample: `abcd0123-cd45-ef67-11aa-1111aaaa23bc`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#UUID-fn::getatt" } }, "Properties": { "OpenZFSConfiguration": { "Type": "OpenZFSConfiguration", "Required": false, "MarkdownDocumentation": "`OpenZFSConfiguration`\n\nThe configuration of an Amazon FSx for OpenZFS volume.\n*Required*: No\n*Type*: [OpenZFSConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#cfn-fsx-volume-openzfsconfiguration", "UpdateType": "Mutable" }, "VolumeType": { "Required": false, "MarkdownDocumentation": "`VolumeType`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "ONTAP", "OPENZFS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#cfn-fsx-volume-volumetype", "PrimitiveType": "String", "UpdateType": "Immutable" }, "BackupId": { "Required": false, "MarkdownDocumentation": "`BackupId`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#cfn-fsx-volume-backupid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "OntapConfiguration": { "Type": "OntapConfiguration", "Required": false, "MarkdownDocumentation": "`OntapConfiguration`\n\nThe configuration of an Amazon FSx for NetApp ONTAP volume.\n*Required*: No\n*Type*: [OntapConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#cfn-fsx-volume-ontapconfiguration", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-fsx-volume-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#cfn-fsx-volume-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the volume.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,203}$`\n*Minimum*: `1`\n*Maximum*: `203`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html#cfn-fsx-volume-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::FinSpace::Environment": { "MarkdownDocumentation": "`AWS::FinSpace::Environment`\n\nThe `AWS::FinSpace::Environment` resource represents an Amazon FinSpace\nenvironment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myEnvironment\" }`\nFor the Amazon FinSpace environment group `myEnvironment`, `Ref` returns the name of the environment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the FinSpace environment.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9. ]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe KMS key id used to encrypt in the FinSpace environment.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z-0-9-:\\/]*{1,1000}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FederationParameters": { "MarkdownDocumentation": "`FederationParameters`\n\nConfiguration information when authentication mode is FEDERATED.\n*Required*: No\n*Type*: [FederationParameters](./aws-properties-finspace-environment-federationparameters.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-federationparameters", "UpdateType": "Immutable", "Required": false, "Type": "FederationParameters" }, "FederationMode": { "MarkdownDocumentation": "`FederationMode`\n\nThe authentication mode for the environment.\n*Required*: No\n*Type*: String\n*Allowed values*: `LOCAL | FEDERATED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOCAL", "FEDERATED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-federationmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SuperuserParameters": { "MarkdownDocumentation": "`SuperuserParameters`\n\nConfiguration information for the superuser.\n*Required*: No\n*Type*: [SuperuserParameters](./aws-properties-finspace-environment-superuserparameters.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-superuserparameters", "UpdateType": "Immutable", "Required": false, "Type": "SuperuserParameters" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-finspace-environment-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the FinSpace environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+[a-zA-Z0-9-]*[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of creation of the FinSpace environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#Status-fn::getatt" }, "EnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentId`\n\nThe identifier of the FinSpace environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#EnvironmentId-fn::getatt" }, "EnvironmentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentArn`\n\nThe Amazon Resource Name (ARN) of your FinSpace environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#EnvironmentArn-fn::getatt" }, "SageMakerStudioDomainUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`SageMakerStudioDomainUrl`\n\nThe url of the integrated FinSpace notebook environment in your web application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#SageMakerStudioDomainUrl-fn::getatt" }, "EnvironmentUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentUrl`\n\nThe sign-in url for the web application of your FinSpace environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#EnvironmentUrl-fn::getatt" }, "AwsAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AwsAccountId`\n\nThe ID of the AWS account in which the FinSpace environment is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#AwsAccountId-fn::getatt" }, "DedicatedServiceAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DedicatedServiceAccountId`\n\nThe AWS account ID of the dedicated service account associated with your FinSpace\nenvironment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#DedicatedServiceAccountId-fn::getatt" } } }, "AWS::Forecast::Dataset": { "MarkdownDocumentation": "`AWS::Forecast::Dataset`\n\nCreates an Amazon Forecast dataset.\n###### Important\nAmazon Forecast is no longer available to new customers. Existing customers of\nAmazon Forecast can continue to use the service as normal.\n[Learn more\"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)\nThe information about the dataset that you provide helps\nForecast understand how to consume the data for model training. This includes the\nfollowing:\n* *`DataFrequency`* - How frequently your historical\n time-series data is collected.\n* *`Domain`* and\n *`DatasetType`* - Each dataset has an associated dataset\n domain and a type within the domain. Amazon Forecast provides a list of predefined domains and\n types within each domain. For each unique dataset domain and type within the domain,\n Amazon Forecast requires your data to include a minimum set of predefined fields.\n* *`Schema`* - A schema specifies the fields in the dataset,\n including the field name and data type.\nAfter creating a dataset, you import your training data into it and add the dataset to a\ndataset group. You use the dataset group to create a predictor. For more information, see\n[Importing datasets](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).\nTo get a list of all your datasets, use the [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) operation.\nFor example Forecast datasets, see the [Amazon Forecast Sample GitHub\nrepository](https://github.com/aws-samples/amazon-forecast-samples).\n###### Note\nThe `Status` of a dataset must be `ACTIVE` before you can import\ntraining data. Use the [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation to get\nthe status.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html", "Properties": { "DataFrequency": { "MarkdownDocumentation": "`DataFrequency`\n\nThe frequency of data collection. This parameter is required for RELATED\\_TIME\\_SERIES\ndatasets.\nValid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,\n\"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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datafrequency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatasetName": { "MarkdownDocumentation": "`DatasetName`\n\nThe name of the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datasetname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe schema for the dataset. The schema attributes and their order must match the fields in\nyour data. The dataset `Domain` and `DatasetType` that you choose\ndetermine the minimum required fields in your training data. For information about the\nrequired fields for a specific dataset domain and type, see [Dataset Domains and Dataset\nTypes](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html).\n*Required*: Yes\n*Type*: [Schema](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-schema", "UpdateType": "Mutable", "Required": true, "Type": "Schema" }, "DatasetType": { "MarkdownDocumentation": "`DatasetType`\n\nThe dataset type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TARGET_TIME_SERIES | RELATE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TARGET_TIME_SERIES", "RELATED_TIME_SERIES", "ITEM_METADATA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-datasettype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe domain associated with the dataset.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RETAIL | CUSTOM | INVENTORY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-domain", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EncryptionConfig": { "MarkdownDocumentation": "`EncryptionConfig`\n\nA Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access\nthe key.\n*Required*: No\n*Type*: [EncryptionConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-encryptionconfig", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [TagsItems](./aws-properties-forecast-dataset-tagsitems.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#cfn-forecast-dataset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagsItems", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-dataset.html#Arn-fn::getatt" } } }, "AWS::Forecast::DatasetGroup": { "MarkdownDocumentation": "`AWS::Forecast::DatasetGroup`\n\nCreates a dataset group, which holds a collection of related datasets. You can add\ndatasets to the dataset group when you create the dataset group, or later by using the [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation.\n###### Important\nAmazon Forecast is no longer available to new customers. Existing customers of\nAmazon Forecast can continue to use the service as normal.\n[Learn more\"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)\nAfter creating a dataset group and adding datasets, you use the dataset group when you\ncreate a predictor. For more information, see [Dataset groups](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).\nTo get a list of all your datasets groups, use the [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html)\noperation.\n###### Note\nThe `Status` of a dataset group must be `ACTIVE` before you can\nuse the dataset group to create a predictor. To get the status, use the [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html", "Properties": { "DatasetArns": { "MarkdownDocumentation": "`DatasetArns`\n\nAn array of Amazon Resource Names (ARNs) of the datasets that you want to include in the\ndataset group.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-datasetarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DatasetGroupName": { "MarkdownDocumentation": "`DatasetGroupName`\n\nThe name of the dataset group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-datasetgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe domain associated with the dataset group. When you add a dataset to a dataset group,\nthis value and the value specified for the `Domain` parameter of the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)\noperation must match.\nThe `Domain` and `DatasetType` that you choose determine the fields\nthat must be present in training data that you import to a dataset. For example, if you choose\nthe `RETAIL` domain and `TARGET_TIME_SERIES` as the\n`DatasetType`, Amazon Forecast requires that `item_id`,\n`timestamp`, and `demand` fields are present in your data. For more\ninformation, see [Dataset groups](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RETAIL | CUSTOM | INVENTORY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-domain", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-forecast-datasetgroup-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#cfn-forecast-datasetgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "DatasetGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatasetGroupArn`\n\nThe Amazon Resource Name (ARN) of the dataset group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-forecast-datasetgroup.html#DatasetGroupArn-fn::getatt" } } }, "AWS::FraudDetector::Detector": { "MarkdownDocumentation": "`AWS::FraudDetector::Detector`\n\nManages a detector and associated detector versions.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the primary identifier for the resource, which is the ARN.\nExample: `{\"Ref\": \"arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe detector description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DetectorVersionStatus": { "MarkdownDocumentation": "`DetectorVersionStatus`\n\nThe status of the detector version. If a value is not provided for this property, AWS CloudFormation assumes `DRAFT` status.\nValid values: `ACTIVE | DRAFT`\n*Required*: No\n*Type*: String\n*Allowed values*: `DRAFT | ACTIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "DRAFT", "ACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-detectorversionstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventType": { "MarkdownDocumentation": "`EventType`\n\nThe event type associated with this detector.\n*Required*: Yes\n*Type*: [EventType](./aws-properties-frauddetector-detector-eventtype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-eventtype", "UpdateType": "Mutable", "Required": true, "Type": "EventType" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe name of the detector.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-detectorid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AssociatedModels": { "MarkdownDocumentation": "`AssociatedModels`\n\nThe models to associate with this detector. You must provide the ARNs of all the models you want to associate.\n*Required*: No\n*Type*: Array of [Model](./aws-properties-frauddetector-detector-model.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-associatedmodels", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Model", "DuplicatesAllowed": true }, "RuleExecutionMode": { "MarkdownDocumentation": "`RuleExecutionMode`\n\nThe rule execution mode for the rules included in the detector version.\nValid values: `FIRST_MATCHED | ALL_MATCHED` Default value: `FIRST_MATCHED`\nYou can define and edit the rule mode at the detector version level, when it is in draft status.\nIf you specify `FIRST_MATCHED`, Amazon Fraud Detector\nevaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.\nIf you specifiy `ALL_MATCHED`, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIRST_MATCHED | ALL_MATCHED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIRST_MATCHED", "ALL_MATCHED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-ruleexecutionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe rules to include in the detector version.\n*Required*: Yes\n*Type*: Array of [Rule](./aws-properties-frauddetector-detector-rule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-detector-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when detector was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#CreatedTime-fn::getatt" }, "EventType.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EventType.Arn`\n\nThe detector ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#EventType.Arn-fn::getatt" }, "EventType.LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`EventType.LastUpdatedTime`\n\nTimestamp of when the detector was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#EventType.LastUpdatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when detector was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#LastUpdatedTime-fn::getatt" }, "EventType.CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`EventType.CreatedTime`\n\nTimestamp of when the detector was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#EventType.CreatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe detector ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#Arn-fn::getatt" }, "DetectorVersionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DetectorVersionId`\n\nThe name of the detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#DetectorVersionId-fn::getatt" } } }, "AWS::FraudDetector::EntityType": { "MarkdownDocumentation": "`AWS::FraudDetector::EntityType`\n\nManages an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the primary identifier for the resource, which is the ARN.\nExample: `{ \"Ref\": \"arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-entitytype.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe entity type description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-entitytype.html#cfn-frauddetector-entitytype-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA key and value pair.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-frauddetector-entitytype-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-entitytype.html#cfn-frauddetector-entitytype-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe entity type name.\nPattern: `^[0-9a-z_-]+$`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-entitytype.html#cfn-frauddetector-entitytype-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when entity type was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-entitytype.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when entity type was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-entitytype.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe entity type ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-entitytype.html#Arn-fn::getatt" } } }, "AWS::FraudDetector::EventType": { "MarkdownDocumentation": "`AWS::FraudDetector::EventType`\n\nManages an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events.\nAn event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event\n(such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the primary identifier for the resource, which is the Arn.\nExample: `{\"Ref\": \"arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html", "Properties": { "EntityTypes": { "MarkdownDocumentation": "`EntityTypes`\n\nThe event type entity types.\n*Required*: Yes\n*Type*: Array of [EntityType](./aws-properties-frauddetector-eventtype-entitytype.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#cfn-frauddetector-eventtype-entitytypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "EntityType", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe event type description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#cfn-frauddetector-eventtype-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Labels": { "MarkdownDocumentation": "`Labels`\n\nThe event type labels.\n*Required*: Yes\n*Type*: Array of [Label](./aws-properties-frauddetector-eventtype-label.html)\n*Minimum*: `2`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#cfn-frauddetector-eventtype-labels", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Label", "DuplicatesAllowed": true }, "EventVariables": { "MarkdownDocumentation": "`EventVariables`\n\nThe event type event variables.\n*Required*: Yes\n*Type*: Array of [EventVariable](./aws-properties-frauddetector-eventtype-eventvariable.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#cfn-frauddetector-eventtype-eventvariables", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "EventVariable", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-eventtype-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#cfn-frauddetector-eventtype-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe event type name.\nPattern : `^[0-9a-z_-]+$`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#cfn-frauddetector-eventtype-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when event type was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when event type was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe event type ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-eventtype.html#Arn-fn::getatt" } } }, "AWS::FraudDetector::Label": { "MarkdownDocumentation": "`AWS::FraudDetector::Label`\n\nCreates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the primary identifier for the resource, which is the ARN.\nExample: `{\"Ref\": \"arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-label.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe label description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-label.html#cfn-frauddetector-label-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-label-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-label.html#cfn-frauddetector-label-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe label name.\nPattern: `^[0-9a-z_-]+$`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-label.html#cfn-frauddetector-label-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when label was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-label.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when label was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-label.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the label.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-label.html#Arn-fn::getatt" } } }, "AWS::FraudDetector::List": { "MarkdownDocumentation": "`AWS::FraudDetector::List`\n\nCreates a list.\nList is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector.\nFor more information, see [Lists](https://docs.aws.amazon.com//frauddetector/latest/ug/lists.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the primary identifier for the resource, which is the Arn.\nExample: `{\"Ref\": \"arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the list.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html#cfn-frauddetector-list-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VariableType": { "MarkdownDocumentation": "`VariableType`\n\nThe variable type of the list. For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/variables.html#variable-types)\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Z_]{1,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html#cfn-frauddetector-list-variabletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Elements": { "MarkdownDocumentation": "`Elements`\n\nThe elements in the list.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html#cfn-frauddetector-list-elements", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-list-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html#cfn-frauddetector-list-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the list.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html#cfn-frauddetector-list-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when the list was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when list was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe event type ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-list.html#Arn-fn::getatt" } } }, "AWS::FraudDetector::Outcome": { "MarkdownDocumentation": "`AWS::FraudDetector::Outcome`\n\nCreates or updates an outcome.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the primary identifier for the resource, which is the ARN.\nExample: `{\"Ref\": \"arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-outcome.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe outcome description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-outcome.html#cfn-frauddetector-outcome-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-outcome-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-outcome.html#cfn-frauddetector-outcome-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe outcome name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-outcome.html#cfn-frauddetector-outcome-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when outcome was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-outcome.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when outcome was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-outcome.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the outcome.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-outcome.html#Arn-fn::getatt" } } }, "AWS::FraudDetector::Variable": { "MarkdownDocumentation": "`AWS::FraudDetector::Variable`\n\nManages a variable.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the primary identifier for the resource, which is the ARN.\nExample: `{ \"Ref\": \"arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html", "Properties": { "DefaultValue": { "MarkdownDocumentation": "`DefaultValue`\n\nThe default value of the variable.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-defaultvalue", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the variable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VariableType": { "MarkdownDocumentation": "`VariableType`\n\nThe type of the variable. For more information see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types).\nValid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT` \n*Required*: No\n*Type*: String\n*Allowed values*: `AUTH_CODE | AVS | BILLING_A...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTH_CODE", "AVS", "BILLING_ADDRESS_L1", "BILLING_ADDRESS_L2", "BILLING_CITY", "BILLING_COUNTRY", "BILLING_NAME", "BILLING_PHONE", "BILLING_STATE", "BILLING_ZIP", "CARD_BIN", "CATEGORICAL", "CURRENCY_CODE", "EMAIL_ADDRESS", "FINGERPRINT", "FRAUD_LABEL", "FREE_FORM_TEXT", "IP_ADDRESS", "NUMERIC", "ORDER_ID", "PAYMENT_TYPE", "PHONE_NUMBER", "PRICE", "PRODUCT_CATEGORY", "SHIPPING_ADDRESS_L1", "SHIPPING_ADDRESS_L2", "SHIPPING_CITY", "SHIPPING_COUNTRY", "SHIPPING_NAME", "SHIPPING_PHONE", "SHIPPING_STATE", "SHIPPING_ZIP", "USERAGENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-variabletype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe data type of the variable.\nValid data types: `STRING | INTEGER | BOOLEAN | FLOAT`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STRING | INTEGER | FLOAT | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STRING", "INTEGER", "FLOAT", "BOOLEAN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-datatype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-frauddetector-variable-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the variable.\nPattern: `^[0-9a-z_-]+$`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z_][a-z0-9_]{0,99}?$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nThe data source of the variable.\nValid values: `EVENT | EXTERNAL_MODEL_SCORE`\nWhen defining a variable within a detector, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true.\nIf the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EVENT | EXTERNAL_MODEL_SCOR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "EVENT", "EXTERNAL_MODEL_SCORE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-datasource", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nTimestamp of when variable was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nTimestamp of when variable was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the variable.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#Arn-fn::getatt" } } }, "AWS::GameLift::Alias": { "MarkdownDocumentation": "`AWS::GameLift::Alias`\n\nThe `AWS::GameLift::Alias` resource creates an alias for an Amazon GameLift\n(GameLift) fleet destination. There are two types of routing strategies for aliases: simple\nand terminal. A simple alias points to an active fleet. A terminal alias displays a message\ninstead of routing players to an active fleet. For example, a terminal alias might display a\nURL link that directs players to an upgrade site. You can use aliases to define destinations\nin a game session queue or when requesting new game sessions.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the alias ID, such as\n`alias-1111aaaa-22bb-33cc-44dd-5555eeee66ff`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA human-readable description of the alias.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoutingStrategy": { "MarkdownDocumentation": "`RoutingStrategy`\n\nThe routing configuration, including routing type and fleet target, for the alias.\n*Required*: Yes\n*Type*: [RoutingStrategy](./aws-properties-gamelift-alias-routingstrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-routingstrategy", "UpdateType": "Mutable", "Required": true, "Type": "RoutingStrategy" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-alias-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA descriptive label that is associated with an alias. Alias names do not need to be unique.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AliasArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AliasArn`\n\nThe Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a Amazon GameLift Servers alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`. In a GameLift alias ARN, the resource ID matches the alias ID value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#AliasArn-fn::getatt" }, "AliasId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AliasId`\n\nA unique identifier for the alias. For example, `arn:aws:gamelift:us-west-1::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`\nAlias IDs are unique within a Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#AliasId-fn::getatt" } } }, "AWS::GameLift::Build": { "MarkdownDocumentation": "`AWS::GameLift::Build`\n\nThe `AWS::GameLift::Build` resource creates a game server build that is\ninstalled and run on instances in an Amazon GameLift fleet. This resource points to an Amazon\nS3 location that contains a zip file with all of the components of the game server\nbuild.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the build ID, such as\n`build-1111aaaa-22bb-33cc-44dd-5555eeee66ff`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html", "Properties": { "OperatingSystem": { "MarkdownDocumentation": "`OperatingSystem`\n\nThe operating system that your game server binaries run on. This value determines the\ntype of fleet resources that you use for this build. If your game build contains\nmultiple executables, they all must run on the same operating system. You must specify a\nvalid operating system in this request. There is no default value. You can't change a\nbuild's operating system later.\n###### Note\nAmazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in\nthe [Amazon Linux 2 FAQs](https://aws.amazon.com/amazon-linux-2/faqs/).\nFor game servers\nthat are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the\ngame server build to server SDK 5.x, and then deploy to AL2023 instances. See\n[Migrate to server SDK version 5.](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html)\n*Required*: No\n*Type*: String\n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AMAZON_LINUX", "AMAZON_LINUX_2", "AMAZON_LINUX_2023", "WINDOWS_2012", "WINDOWS_2016", "WINDOWS_2022" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-operatingsystem", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nVersion 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerSdkVersion": { "MarkdownDocumentation": "`ServerSdkVersion`\n\nA server SDK version you used when integrating your game server build with Amazon GameLift Servers. For more information see [Integrate games\nwith custom game servers](https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html). By default Amazon GameLift Servers sets this value to\n`4.0.2`.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d+\\.\\d+\\.\\d+$`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-serversdkversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StorageLocation": { "MarkdownDocumentation": "`StorageLocation`\n\nInformation indicating where your game build files are stored. Use this parameter only\nwhen creating a build with files stored in an Amazon S3 bucket that you own. The storage\nlocation must specify an Amazon S3 bucket name and key. The location must also specify a role\nARN that you set up to allow Amazon GameLift Servers to access your Amazon S3 bucket. The S3 bucket and your\nnew build must be in the same Region.\nIf a `StorageLocation` is specified, the size of your file can be found in\nyour Amazon S3 bucket. Amazon GameLift Servers will report a `SizeOnDisk` of 0.\n*Required*: No\n*Type*: [StorageLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation", "UpdateType": "Immutable", "Required": false, "Type": "StorageLocation" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-build-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA descriptive label that is associated with a build. Build names do not need to be\nunique.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "BuildId": { "PrimitiveType": "String", "MarkdownDocumentation": "`BuildId`\n\nA unique identifier for the build.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#BuildId-fn::getatt" }, "BuildArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`BuildArn`\n\nThe Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a Amazon GameLift Servers build resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`. In a GameLift build ARN, the resource ID matches the\n*BuildId* value.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#BuildArn-fn::getatt" } } }, "AWS::GameLift::Fleet": { "MarkdownDocumentation": "`AWS::GameLift::Fleet`\n\nThe `AWS::GameLift::Fleet` resource creates an Amazon GameLift (GameLift) fleet to host\ncustom game server or Realtime Servers. A fleet is a set of EC2 instances, configured with instructions to\nrun game servers on each instance.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the fleet ID, such as\n`fleet-1111aaaa-22bb-33cc-44dd-5555eeee66ff`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html", "Properties": { "ScalingPolicies": { "MarkdownDocumentation": "`ScalingPolicies`\n\nRule that controls how a fleet is scaled. Scaling policies are uniquely identified by\nthe combination of name and fleet ID.\n*Required*: No\n*Type*: Array of [ScalingPolicy](./aws-properties-gamelift-fleet-scalingpolicy.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scalingpolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ScalingPolicy", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PeerVpcId": { "MarkdownDocumentation": "`PeerVpcId`\n\nA unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The\nVPC must be in the same Region as your fleet. To look up a VPC ID, use the\n[VPC Dashboard](https://console.aws.amazon.com/vpc/) in the AWS Management Console.\nLearn more about VPC peering in [VPC Peering with Amazon GameLift Servers Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^vpc-\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ApplyCapacity": { "MarkdownDocumentation": "`ApplyCapacity`\n\nCurrent resource capacity settings for managed EC2 fleets and managed container fleets. For\nmulti-location fleets, location values might refer to a fleet's remote location or its\nhome Region.\n**Returned by:**[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*: String\n*Allowed values*: `ON_UPDATE | ON_CREATE_AND_U...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ON_UPDATE", "ON_CREATE_AND_UPDATE", "ON_CREATE_AND_UPDATE_WITH_AUTOSCALING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-applycapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FleetType": { "MarkdownDocumentation": "`FleetType`\n\nIndicates whether to use On-Demand or Spot instances for this fleet. By default, this\nproperty 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 fleet property can't 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)", "RefReturnValue": "", "AllowedValues": [ "ON_DEMAND", "SPOT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-fleettype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EC2InboundPermissions": { "MarkdownDocumentation": "`EC2InboundPermissions`\n\nThe IP address ranges and port settings that allow inbound traffic to access game\nserver processes and other processes on this fleet. Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call\n to set it before players can connect to game sessions.\nAs a best practice, we recommend\nopening ports for remote access only when you need them and closing them when you're finished.\nFor Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges.\n*Required*: No\n*Type*: Array of [IpPermission](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IpPermission", "DuplicatesAllowed": true }, "Locations": { "MarkdownDocumentation": "`Locations`\n\nA set of remote locations to deploy additional instances to and manage as a\nmulti-location fleet. Use this parameter when creating a fleet in AWS Regions that\nsupport multiple locations. You can add any AWS Region or Local Zone that's supported\nby Amazon GameLift Servers. Provide a list of one or more AWS Region codes, such as\n`us-west-2`, or Local Zone names. When using this parameter, Amazon GameLift Servers\nrequires you to include your home location in the request. For a list of supported\nRegions and Local Zones, see\n[Amazon GameLift Servers service locations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting.\n*Required*: No\n*Type*: Array of [LocationConfiguration](./aws-properties-gamelift-fleet-locationconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-locations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LocationConfiguration", "DuplicatesAllowed": true }, "NewGameSessionProtectionPolicy": { "MarkdownDocumentation": "`NewGameSessionProtectionPolicy`\n\nThe status of termination protection for active game sessions on the fleet. By\ndefault, this property is set to `NoProtection`.\n* **NoProtection** - Game sessions can be terminated\n during active gameplay as a result of a scale-down event.\n* **FullProtection** - Game sessions in\n `ACTIVE` status cannot be terminated during a scale-down\n event.\n*Required*: No\n*Type*: String\n*Allowed values*: `FullProtection | NoProtecti...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FullProtection", "NoProtection" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-newgamesessionprotectionpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScriptId": { "MarkdownDocumentation": "`ScriptId`\n\nThe unique identifier for a Realtime configuration script to be deployed on fleet\ninstances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift Servers\nprior to creating the fleet. This fleet property cannot be changed later.\n###### Note\nYou can't use the `!Ref` command to reference a\nscript created with a CloudFormation template for the fleet property `ScriptId`.\nInstead, use `Fn::GetAtt Script.Arn` or `Fn::GetAtt Script.Id` to\nretrieve either of these properties as input for `ScriptId`. Alternatively, enter a\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scriptid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ComputeType": { "MarkdownDocumentation": "`ComputeType`\n\nThe type of compute resource used to host your game servers.\n* `EC2` \u2013 The game server build is deployed to Amazon EC2 instances for\n cloud hosting. This is the default setting.\n* `ANYWHERE` \u2013 Game servers\n and supporting software are deployed to compute resources that you provide and\n manage. With this compute type, you can also set the\n `AnywhereConfiguration` parameter.\n*Required*: No\n*Type*: String\n*Allowed values*: `EC2 | ANYWHERE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "EC2", "ANYWHERE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-computetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RuntimeConfiguration": { "MarkdownDocumentation": "`RuntimeConfiguration`\n\nInstructions for how to launch and maintain server processes on instances in the\nfleet. The runtime configuration defines one or more server process configurations, each\nidentifying a build executable or Realtime script file and the number of processes of\nthat type to run concurrently.\n###### Note\nThe `RuntimeConfiguration` parameter is required unless the fleet is\nbeing configured using the older parameters `ServerLaunchPath` and\n`ServerLaunchParameters`, which are still supported for backward\ncompatibility.\n*Required*: Conditional\n*Type*: [RuntimeConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-runtimeconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RuntimeConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PeerVpcAwsAccountId": { "MarkdownDocumentation": "`PeerVpcAwsAccountId`\n\nUsed when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS\naccount that owns the VPC. You can find your account ID in the AWS Management Console under account\nsettings.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcawsaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AnywhereConfiguration": { "MarkdownDocumentation": "`AnywhereConfiguration`\n\nAmazon GameLift Servers Anywhere configuration options.\n*Required*: No\n*Type*: [AnywhereConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-anywhereconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AnywhereConfiguration" }, "InstanceRoleARN": { "MarkdownDocumentation": "`InstanceRoleARN`\n\nA unique identifier for an IAM role that manages access to your AWS services.\nWith an instance role ARN set, any application that runs on an instance in this fleet can assume the role,\nincluding install scripts, server processes, and daemons (background processes). Create a role or look up a role's\nARN by using the [IAM dashboard](https://console.aws.amazon.com/iam/) in the AWS Management Console.\nLearn more about using on-box credentials for your game servers at\n[Access external resources from a game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html). This attribute is used with fleets where `ComputeType` is\n`EC2`.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MetricGroups": { "MarkdownDocumentation": "`MetricGroups`\n\nThe name of an AWS CloudWatch metric group to add this fleet to. A metric group is\nused to aggregate the metrics for multiple fleets. You can specify an existing metric\ngroup name or set a new name to create a new metric group. A fleet can be included in\nonly one metric group at a time.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-metricgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "BuildId": { "MarkdownDocumentation": "`BuildId`\n\nA unique identifier for a build to be deployed on the new fleet. If you are\ndeploying the fleet with a custom game build, you must specify this property. The build must\nhave been successfully uploaded to Amazon GameLift and be in a `READY` status. This\nfleet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-buildid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceCreationLimitPolicy": { "MarkdownDocumentation": "`ResourceCreationLimitPolicy`\n\nA policy that limits the number of game sessions that an individual player can create\non instances in this fleet within a specified span of time.\n*Required*: No\n*Type*: [ResourceCreationLimitPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-resourcecreationlimitpolicy", "UpdateType": "Mutable", "Required": false, "Type": "ResourceCreationLimitPolicy" }, "EC2InstanceType": { "MarkdownDocumentation": "`EC2InstanceType`\n\nThe Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets.\nInstance type determines the computing resources that will be used to host your game\nservers, including CPU, memory, storage, and networking capacity. See [Amazon Elastic Compute Cloud Instance Types](https://aws.amazon.com/ec2/instance-types/) for\ndetailed descriptions of Amazon EC2 instance types.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2instancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CertificateConfiguration": { "MarkdownDocumentation": "`CertificateConfiguration`\n\nPrompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. Amazon GameLift Servers uses the\ncertificates to encrypt traffic between game clients and the game servers running on\nAmazon GameLift Servers. By default, the `CertificateConfiguration` is `DISABLED`.\nYou can't change this property after you create the fleet.\nAWS Certificate Manager (ACM) certificates expire after 13 months.\nCertificate expiration can cause fleets to fail, preventing players from connecting to\ninstances in the fleet. We recommend you replace fleets before 13 months, consider using\nfleet aliases for a smooth transition.\n###### Note\nACM isn't available in all AWS regions. A fleet creation request\nwith certificate generation enabled in an unsupported Region, fails with a 4xx\nerror. For more information about the supported Regions, see [Supported\nRegions](https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) in the *AWS Certificate Manager User\nGuide*.\n*Required*: No\n*Type*: [CertificateConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-certificateconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "CertificateConfiguration" }, "InstanceRoleCredentialsProvider": { "MarkdownDocumentation": "`InstanceRoleCredentialsProvider`\n\nIndicates that fleet instances maintain a shared credentials file for the IAM role defined in `InstanceRoleArn`. Shared credentials allow\napplications that are deployed with the game server executable to communicate with other\nAWS resources. This property is used only when the game server is integrated with the\nserver SDK version 5.x. For more information about using shared credentials, see [Communicate\nwith other AWS resources from your fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html). This attribute is used with\nfleets where `ComputeType` is `EC2`.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHARED_CREDENTIAL_FILE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SHARED_CREDENTIAL_FILE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolecredentialsprovider", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-fleet-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "FleetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FleetId`\n\nA unique identifier for the fleet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#FleetId-fn::getatt" }, "FleetArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FleetArn`\n\nThe Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`. In a GameLift fleet ARN, the resource ID matches the `FleetId`\nvalue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#FleetArn-fn::getatt" } } }, "AWS::GameLift::GameServerGroup": { "MarkdownDocumentation": "`AWS::GameLift::GameServerGroup`\n\n**This operation is used with the Amazon GameLift FleetIQ solution and game server groups.**\nCreates a GameLift FleetIQ game server group for managing game hosting on a collection of\nAmazon EC2 instances for game hosting. This operation creates the game server group,\ncreates an Auto Scaling group in your AWS account, and establishes a link between the\ntwo groups. You can view the status of your game server groups in the GameLift console.\nGame server group metrics and events are emitted to Amazon CloudWatch.\nBefore creating a new game server group, you must have the following:\n* An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances\n with your game server build. For more information, see [Launching an Instance from a Launch Template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the\n *Amazon EC2 User Guide*.\n* An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and\n interact with the Auto Scaling group. For more information, see [Create IAM roles for cross-service interaction](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html) in the *GameLift FleetIQ Developer\n Guide*.\nTo create a new game server group, specify a unique group name, IAM role and Amazon EC2\nlaunch template, and provide a list of instance types that can be used in the group. You\nmust also set initial maximum and minimum limits on the group's instance count. You can\noptionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ\nmetric.\nOnce the game server group and corresponding Auto Scaling group are created, you have\nfull access to change the Auto Scaling group's configuration as needed. Several\nproperties that are set when creating a game server group, including maximum/minimum\nsize and auto-scaling policy settings, must be updated directly in the Auto Scaling\ngroup. Keep in mind that some Auto Scaling group properties are periodically updated by\nGameLift FleetIQ as part of its balancing activities to optimize for availability and\ncost.\n**Learn more**\n[GameLift FleetIQ Guide](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html", "Properties": { "AutoScalingPolicy": { "MarkdownDocumentation": "`AutoScalingPolicy`\n\nConfiguration settings to define a scaling policy for the Auto Scaling group that is\noptimized for game hosting. The scaling policy uses the metric\n`\"PercentUtilizedGameServers\"` to maintain a buffer of idle game servers\nthat can immediately accommodate new games and players. After the Auto Scaling group is\ncreated, update this value directly in the Auto Scaling group using the AWS console or\nAPIs.\n*Required*: No\n*Type*: [AutoScalingPolicy](./aws-properties-gamelift-gameservergroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-autoscalingpolicy", "UpdateType": "Mutable", "Required": false, "Type": "AutoScalingPolicy" }, "MinSize": { "MarkdownDocumentation": "`MinSize`\n\nThe minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During\nautomatic scaling events, Amazon GameLift Servers FleetIQ and Amazon EC2 do not scale down the group below this\nminimum. In production, this value should be set to at least 1. After the Auto Scaling\ngroup is created, update this value directly in the Auto Scaling group using the AWS\nconsole or APIs.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-minsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "DeleteOption": { "MarkdownDocumentation": "`DeleteOption`\n\nThe type of delete to perform. To delete a game server group, specify the\n`DeleteOption`. Options include the following:\n* `SAFE_DELETE` \u2013 (default) Terminates the game server group and\n Amazon EC2 Auto Scaling group only when it has no game servers that are in\n `UTILIZED` status.\n* `FORCE_DELETE` \u2013 Terminates the game server group, including all\n active game servers regardless of their utilization status, and the Amazon EC2 Auto\n Scaling group.\n* `RETAIN` \u2013 Does a safe delete of the game server group but retains\n the Amazon EC2 Auto Scaling group as is.\n*Required*: No\n*Type*: String\n*Allowed values*: `SAFE_DELETE | FORCE_DELETE ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SAFE_DELETE", "FORCE_DELETE", "RETAIN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-deleteoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BalancingStrategy": { "MarkdownDocumentation": "`BalancingStrategy`\n\nIndicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the\ngame server group. Method options include the following:\n* `SPOT_ONLY` - Only Spot Instances are used in the game server group. If Spot\n Instances are unavailable or not viable for game hosting, the game server group\n provides no hosting capacity until Spot Instances can again be used. Until then,\n no new instances are started, and the existing nonviable Spot Instances are\n terminated (after current gameplay ends) and are not replaced.\n* `SPOT_PREFERRED` - (default value) Spot Instances are used whenever available in\n the game server group. If Spot Instances are unavailable, the game server group\n continues to provide hosting capacity by falling back to On-Demand Instances.\n Existing nonviable Spot Instances are terminated (after current gameplay ends)\n and are replaced with new On-Demand Instances.\n* `ON_DEMAND_ONLY` - Only On-Demand Instances are used in the game\n server group. No Spot Instances are used, even when available, while this\n balancing strategy is in force.\n*Required*: No\n*Type*: String\n*Allowed values*: `SPOT_ONLY | SPOT_PREFERRED ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-balancingstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GameServerGroupName": { "MarkdownDocumentation": "`GameServerGroupName`\n\nA developer-defined identifier for the game server group. The name is unique for each\nRegion in each AWS account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-\\.]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameservergroupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LaunchTemplate": { "MarkdownDocumentation": "`LaunchTemplate`\n\nThe Amazon EC2 launch template that contains configuration settings and game server code to\nbe deployed to all instances in the game server group. You can specify the template\nusing either the template name or ID. For help with creating a launch template, see\n[Creating a Launch\nTemplate 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\nUser Guide*. After the Auto Scaling group is created, update this value\ndirectly in the Auto Scaling group using the AWS console or APIs.\n###### Note\nIf you specify network interfaces in your launch template, you must explicitly set\nthe property `AssociatePublicIpAddress` to \"true\". If no network\ninterface is specified in the launch template, Amazon GameLift Servers FleetIQ uses your account's default\nVPC.\n*Required*: No\n*Type*: [LaunchTemplate](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-launchtemplate", "UpdateType": "Mutable", "Required": false, "Type": "LaunchTemplate" }, "GameServerProtectionPolicy": { "MarkdownDocumentation": "`GameServerProtectionPolicy`\n\nA flag that indicates whether instances in the game server group are protected\nfrom early termination. Unprotected instances that have active game servers running might\nbe terminated during a scale-down event, causing players to be dropped from the game.\nProtected instances cannot be terminated while there are active game servers running except\nin the event of a forced game server group deletion (see ). An exception to this is with Spot\nInstances, which can be terminated by AWS regardless of protection status.\n*Required*: No\n*Type*: String\n*Allowed values*: `NO_PROTECTION | FULL_PROTEC...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NO_PROTECTION", "FULL_PROTECTION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameserverprotectionpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSubnets": { "MarkdownDocumentation": "`VpcSubnets`\n\nA list of virtual private cloud (VPC) subnets to use with instances in the game server\ngroup. By default, all Amazon GameLift Servers FleetIQ-supported Availability Zones are used. You can use this\nparameter to specify VPCs that you've set up. This property cannot be updated after the\ngame server group is created, and the corresponding Auto Scaling group will always use\nthe property value that is set with this request, even if the Auto Scaling group is\nupdated directly.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `15 | 1`\n*Maximum*: `24 | 20`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-vpcsubnets", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxSize": { "MarkdownDocumentation": "`MaxSize`\n\nThe maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During\nautomatic scaling events, Amazon GameLift Servers FleetIQ and EC2 do not scale up the group above this maximum.\nAfter the Auto Scaling group is created, update this value directly in the Auto Scaling\ngroup using the AWS console or APIs.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-maxsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "InstanceDefinitions": { "MarkdownDocumentation": "`InstanceDefinitions`\n\nThe set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically\nscaling instances in the corresponding Auto Scaling group.\n*Required*: Yes\n*Type*: Array of [InstanceDefinition](./aws-properties-gamelift-gameservergroup-instancedefinition.html)\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-instancedefinitions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "InstanceDefinition", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM role that\nallows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*:role\\/[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of labels to assign to the new game server group resource. Tags are\ndeveloper-defined key-value pairs. Tagging AWS resources is useful for resource\nmanagement, access management, and cost allocation. For more information, see [Tagging AWS\nResources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference*. Once the\nresource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove,\nand view tags, respectively. The maximum tag limit may be lower than stated. See the\nAWS General Reference for actual tagging limits.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-gameservergroup-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "AutoScalingGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutoScalingGroupArn`\n\nA unique identifier for the auto scaling group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#AutoScalingGroupArn-fn::getatt" }, "GameServerGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GameServerGroupArn`\n\nA unique identifier for the game server group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#GameServerGroupArn-fn::getatt" } } }, "AWS::GameLift::GameSessionQueue": { "MarkdownDocumentation": "`AWS::GameLift::GameSessionQueue`\n\nThe `AWS::GameLift::GameSessionQueue` resource creates a placement queue\nthat processes requests for new game sessions. A queue uses FleetIQ algorithms to determine\nthe best placement locations and find an available game server, then prompts the game server\nto start a new game session. Queues can have destinations (GameLift fleets or aliases), which\ndetermine where the queue can place new game sessions. A queue can have destinations with\nvaried fleet type (Spot and On-Demand), instance type, and AWS Region.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the game session queue, which is unique within each\nRegion.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html", "Properties": { "TimeoutInSeconds": { "MarkdownDocumentation": "`TimeoutInSeconds`\n\nThe 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. If you don't specify a request timeout, the queue uses a default value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-timeoutinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PlayerLatencyPolicies": { "MarkdownDocumentation": "`PlayerLatencyPolicies`\n\nA set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.\nUse multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement.\nPolicies are evaluated in order starting with the lowest maximum latency value.\n*Required*: No\n*Type*: Array of [PlayerLatencyPolicy](./aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-playerlatencypolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PlayerLatencyPolicy", "DuplicatesAllowed": true }, "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nA list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.\nDestinations 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*: Array of [GameSessionQueueDestination](./aws-properties-gamelift-gamesessionqueue-gamesessionqueuedestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-destinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GameSessionQueueDestination", "DuplicatesAllowed": true }, "NotificationTarget": { "MarkdownDocumentation": "`NotificationTarget`\n\nAn SNS topic ARN that is set up to receive game session placement notifications. See\n [Setting up\nnotifications for game session placement](https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:_-]*(\\.fifo)?`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-notificationtarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FilterConfiguration": { "MarkdownDocumentation": "`FilterConfiguration`\n\nA list of locations where a queue is allowed to place new game sessions. Locations\nare specified in the form of AWS Region codes, such as `us-west-2`. If this parameter is\nnot set, game sessions can be placed in any queue location.\n*Required*: No\n*Type*: [FilterConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-filterconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "FilterConfiguration" }, "CustomEventData": { "MarkdownDocumentation": "`CustomEventData`\n\nInformation to be added to all events that are related to this game session\nqueue.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-customeventdata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of labels to assign to the new game session queue resource. Tags are developer-defined\nkey-value pairs. Tagging\nAWS resources are useful for resource management, access management and cost allocation.\nFor more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the\n*AWS General Reference*. Once the resource is created, you can\nuse TagResource, UntagResource, and\nListTagsForResource to add, remove, and view tags. The\nmaximum tag limit may be lower than stated. See the AWS General Reference for actual\ntagging limits.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-gamesessionqueue-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA descriptive label that is associated with game session queue. Queue names must be unique within each Region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PriorityConfiguration": { "MarkdownDocumentation": "`PriorityConfiguration`\n\nCustom settings to use when prioritizing destinations and locations for game session placements. This\nconfiguration replaces the FleetIQ default prioritization process. Priority types that are not explicitly\nnamed will be automatically applied at the end of the prioritization process.\n*Required*: No\n*Type*: [PriorityConfiguration](./aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-priorityconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PriorityConfiguration" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique Amazon Resource Name (ARN) for the `GameSessionQueue`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nA descriptive label that is associated with a game session queue. Names are unique within\neach Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#Name-fn::getatt" } } }, "AWS::GameLift::Location": { "MarkdownDocumentation": "`AWS::GameLift::Location`\n\nThe AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the custom location ID, such as\n`arn:aws:gamelift:[region]::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of labels to assign to the new resource. Tags are developer-defined key-value\npairs. Tagging AWS resources are useful for resource management, access management,\nand cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the\n*AWS General Rareference*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-location-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#cfn-gamelift-location-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "LocationName": { "MarkdownDocumentation": "`LocationName`\n\nA descriptive name for the custom location.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^custom-[A-Za-z0-9\\-]+`\n*Minimum*: `8`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#cfn-gamelift-location-locationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "LocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LocationArn`\n\nA unique identifier for the custom location. For example,\n`arn:aws:gamelift:[region]::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#LocationArn-fn::getatt" } } }, "AWS::GameLift::MatchmakingConfiguration": { "MarkdownDocumentation": "`AWS::GameLift::MatchmakingConfiguration`\n\nThe `AWS::GameLift::MatchmakingConfiguration` resource defines a new\nmatchmaking configuration for use with FlexMatch. Whether you're using FlexMatch with GameLift hosting or as a\nstandalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams.\nIf you're using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system\ncan use multiple configurations to handle different game scenarios. All matchmaking requests identify the\nmatchmaking configuration to use and provide player attributes that are consistent with that configuration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `MatchmakingConfiguration` name, which is unique.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html", "Properties": { "GameProperties": { "MarkdownDocumentation": "`GameProperties`\n\nA set of custom properties for a game session, formatted as key-value pairs. These\nproperties are passed to a game server process with a request to start a new game session. See\n [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession).\nThis parameter is not used if `FlexMatchMode` is set to `STANDALONE`.\n*Required*: No\n*Type*: Array of [GameProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gameproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "GameProperty", "DuplicatesAllowed": false }, "GameSessionData": { "MarkdownDocumentation": "`GameSessionData`\n\nA set of custom game session properties, formatted as a single string value. This\ndata is passed to a game server process with a request to start a new game session.\nSee [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession).\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessiondata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AcceptanceTimeoutSeconds": { "MarkdownDocumentation": "`AcceptanceTimeoutSeconds`\n\nThe length of time (in seconds) to wait for players to accept a proposed match, if\nacceptance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancetimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NotificationTarget": { "MarkdownDocumentation": "`NotificationTarget`\n\nAn SNS topic ARN that is set up to receive matchmaking notifications. See [Setting up notifications for matchmaking](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) for more information.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:_/-]*(.fifo)?`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-notificationtarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomEventData": { "MarkdownDocumentation": "`CustomEventData`\n\nInformation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-customeventdata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking\nrequest or ticket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-\\.]*`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AdditionalPlayerCount": { "MarkdownDocumentation": "`AdditionalPlayerCount`\n\nThe number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies\na 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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-additionalplayercount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "BackfillMode": { "MarkdownDocumentation": "`BackfillMode`\n\nThe method used to backfill game sessions that are created with this matchmaking\nconfiguration. Specify `MANUAL` when your game manages backfill requests manually\nor does not use the match backfill feature. Specify `AUTOMATIC` to have GameLift\ncreate a `StartMatchBackfill` request whenever a game session has one or more open\nslots. Learn more about manual and automatic backfill in [Backfill Existing Games with\nFlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html). Automatic backfill is not\navailable 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)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-backfillmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequestTimeoutSeconds": { "MarkdownDocumentation": "`RequestTimeoutSeconds`\n\nThe maximum duration, in seconds, that a matchmaking ticket can remain in process\nbefore timing out. Requests that fail due to timing out can be resubmitted as\nneeded.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-requesttimeoutseconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "AcceptanceRequired": { "MarkdownDocumentation": "`AcceptanceRequired`\n\nA flag that determines whether a match that was created with this configuration must\nbe accepted by the matched players. To require acceptance, set to `TRUE`.\nWith this option enabled, matchmaking tickets use the status\n`REQUIRES_ACCEPTANCE` to indicate when a completed potential match is\nwaiting 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancerequired", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "CreationTime": { "MarkdownDocumentation": "`CreationTime`\n\nA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example `\"1469498468.057\"`).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-creationtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FlexMatchMode": { "MarkdownDocumentation": "`FlexMatchMode`\n\nIndicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or\nas a standalone matchmaking solution.\n* **STANDALONE** - FlexMatch forms matches and\n 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\n the specified Amazon GameLift Servers 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)", "RefReturnValue": "", "AllowedValues": [ "STANDALONE", "WITH_QUEUE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-flexmatchmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RuleSetName": { "MarkdownDocumentation": "`RuleSetName`\n\nA unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN\nvalue. A matchmaking configuration can only use rule sets that are defined in the same\nRegion.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-\\.]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-rulesetname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GameSessionQueueArns": { "MarkdownDocumentation": "`GameSessionQueueArns`\n\nThe Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::gamesessionqueue/`. Queues can be located in any Region. Queues are used to start new\nAmazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking\nconfiguration. If `FlexMatchMode` is set to `STANDALONE`, do not\nset this parameter.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessionqueuearns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined\nkey-value pairs. Tagging\nAWS resources are useful for resource management, access management and cost allocation.\nFor more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the\n*AWS General Reference*. Once the resource is created, you can\nuse TagResource, UntagResource, and\nListTagsForResource to add, remove, and view tags. The\nmaximum tag limit may be lower than stated. See the AWS General Reference for actual\ntagging limits.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-matchmakingconfiguration-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "RuleSetArn": { "MarkdownDocumentation": "`RuleSetArn`\n\nThe Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated with the GameLift matchmaking rule set resource that this\nconfiguration uses.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:.*:matchmakingruleset\\/[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-rulesetarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique Amazon Resource Name (ARN) for the\n`MatchmakingConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe `MatchmakingConfiguration` name, which is unique.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#Name-fn::getatt" } } }, "AWS::GameLift::MatchmakingRuleSet": { "MarkdownDocumentation": "`AWS::GameLift::MatchmakingRuleSet`\n\nCreates a new rule set for FlexMatch matchmaking. A rule set describes the type of match\nto create, such as the number and size of teams. It also sets the parameters for\nacceptable player matches, such as minimum skill level or character type.\nTo create a matchmaking rule set, provide unique rule set name and the rule set body\nin JSON format. Rule sets must be defined in the same Region as the matchmaking\nconfiguration they are used with.\nSince matchmaking rule sets cannot be edited, it is a good idea to check the rule\nset syntax.\n**Learn more**\n* [Build a rule\n set](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html)\n* [Design a\n matchmaker](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html)\n* [Matchmaking with\n FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the rule set name, which is unique within each Region.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html", "Properties": { "RuleSetBody": { "MarkdownDocumentation": "`RuleSetBody`\n\nA collection of matchmaking rules, formatted as a JSON string. Comments are not\nallowed in JSON, but most elements support a description field.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-rulesetbody", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined\nkey-value pairs. Tagging\nAWS resources are useful for resource management, access management and cost allocation.\nFor more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the\n*AWS General Reference*. Once the resource is created, you can\nuse TagResource, UntagResource, and\nListTagsForResource to add, remove, and view tags. The\nmaximum tag limit may be lower than stated. See the AWS General Reference for actual\ntagging limits.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-matchmakingruleset-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name\nvalue. Note that the rule set name is different from the optional `name`\nfield in the rule set body.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9-\\.]*`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example `\"1469498468.057\"`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#CreationTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique Amazon Resource Name (ARN) assigned to the rule set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe unique name of the rule set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#Name-fn::getatt" } } }, "AWS::GameLift::Script": { "MarkdownDocumentation": "`AWS::GameLift::Script`\n\nThe `AWS::GameLift::Script` resource creates a new script record for your\nRealtime Servers script. Realtime scripts are JavaScript that provide configuration settings\nand optional custom game logic for your game. The script is deployed when you create a\nRealtime Servers fleet to host your game sessions. Script logic is executed during an active\ngame session.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ScriptId`, such as\n`script-1111aaaa-22bb-33cc-44dd-5555eeee66ff`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html", "Properties": { "Version": { "MarkdownDocumentation": "`Version`\n\nThe version that is associated with a build or script. Version strings do not need to\nbe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-version", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StorageLocation": { "MarkdownDocumentation": "`StorageLocation`\n\nThe location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\nstored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n\"key\"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3\nbucket must be in the same Region where you want to create a new script. By default,\nAmazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning\nturned on, you can use the `ObjectVersion` parameter to specify an earlier\nversion.\n*Required*: Yes\n*Type*: [S3Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-storagelocation", "UpdateType": "Mutable", "Required": true, "Type": "S3Location" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of labels to assign to the new script resource. Tags are developer-defined\nkey-value pairs. Tagging\nAWS resources are useful for resource management, access management and cost allocation.\nFor more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the\n*AWS General Reference*. Once the resource is created, you can\nuse TagResource, UntagResource, and\nListTagsForResource to add, remove, and view tags. The\nmaximum tag limit may be lower than stated. See the AWS General Reference for actual\ntagging limits.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-gamelift-script-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA descriptive label that is associated with a script. Script names do not need to be\nunique.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example `\"1469498468.057\"`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#CreationTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nA unique identifier for a Realtime script.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique Amazon Resource Name (ARN) for the script.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#Arn-fn::getatt" }, "SizeOnDisk": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`SizeOnDisk`\n\nThe file size of the uploaded Realtime script, expressed in bytes. When files are\nuploaded from an S3 location, this value remains at \"0\".\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#SizeOnDisk-fn::getatt" } } }, "AWS::GameLiftStreams::Application": { "MarkdownDocumentation": "`AWS::GameLiftStreams::Application`\n\nThe `AWS::GameLiftStreams::Application` resource defines an Amazon GameLift Streams application. An application specifies\nthe content that you want to stream, such as a game or other software, and its runtime environment (Microsoft Windows, Ubuntu, or\nProton).\nBefore you create an Amazon GameLift Streams application, upload your *uncompressed* game files (do not upload a\n.zip file) to an Amazon Simple Storage Service (Amazon S3) standard bucket.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns an [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)\nthat uniquely identifies the application resource across all AWS Regions. For example:\n`arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html", "Properties": { "ApplicationLogPaths": { "MarkdownDocumentation": "`ApplicationLogPaths`\n\nLocations of log files that your content generates during a stream session. Enter path\nvalues that are relative to the `ApplicationSourceUri` location.\nYou can specify up to 10 log paths.\nAmazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in `ApplicationLogOutputUri`\nat the end of a stream session. To retrieve stored log files, call [GetStreamSession](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html)\nand get the `LogFileLocationUri`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 0`\n*Maximum*: `1024 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-applicationlogpaths", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ApplicationLogOutputUri": { "MarkdownDocumentation": "`ApplicationLogOutputUri`\n\nAn Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more `ApplicationLogPaths`.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|^s3://([a-zA-Z0-9][a-zA-Z0-9._-]{1,61}[a-zA-Z0-9])(/[a-zA-Z0-9._-]+)*/?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-applicationlogoutputuri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationSourceUri": { "MarkdownDocumentation": "`ApplicationSourceUri`\n\nThe location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The\nlocation can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything\nunder the specified location.\nThis value is immutable. To designate a different content location, create a new application.\n###### Note\nThe Amazon S3 bucket and the Amazon GameLift Streams application must be in the same AWS Region.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-applicationsourceuri", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA human-readable label for the application. You can update this value later.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*$`\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RuntimeEnvironment": { "MarkdownDocumentation": "`RuntimeEnvironment`\n\nA set of configuration settings to run the application on a stream group. This configures the operating system, and can include\ncompatibility layers and other drivers.\n*Required*: Yes\n*Type*: [RuntimeEnvironment](./aws-properties-gameliftstreams-application-runtimeenvironment.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-runtimeenvironment", "UpdateType": "Immutable", "Required": true, "Type": "RuntimeEnvironment" }, "ExecutablePath": { "MarkdownDocumentation": "`ExecutablePath`\n\nThe relative path and file name of the executable file that Amazon GameLift Streams will stream. Specify a path relative to the location set in\n`ApplicationSourceUri`. The file must be contained within the application's root folder. For Windows applications, the file\nmust be a valid Windows executable or batch file with a filename ending in .exe, .cmd, or .bat. For Linux applications, the file must be a\nvalid Linux binary executable or a script that contains an initial interpreter line starting with a shebang ('`#!`').\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-executablepath", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging AWS resources is\nuseful for resource management, access management and cost allocation. See [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference*.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nAn ID that uniquely identifies the application resource. For example: `a-9ZY8X7Wv6`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nAn [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)\nthat uniquely identifies the application resource across all AWS Regions. For example:\n`arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#Arn-fn::getatt" } } }, "AWS::GameLiftStreams::StreamGroup": { "MarkdownDocumentation": "`AWS::GameLiftStreams::StreamGroup`\n\nThe `AWS::GameLiftStreams::StreamGroup` resource defines a group of compute resources that will be running and streaming your\ngame. When you create a stream group, you specify the hardware configuration (CPU, GPU, RAM) that will run your game (known as the\n*stream class*), the geographical locations where your game can run, and the number of streams that can run\nsimultaneously in each location (known as *stream capacity*). Stream groups manage how Amazon GameLift Streams allocates\nresources and handles concurrent streams, allowing you to effectively manage capacity and costs.\nThere are two types of stream capacity: always-on and on-demand.\n* **Always-on**: The streaming capacity that is allocated and ready to handle stream requests without delay.\n You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1\n (2 for high stream classes) when creating a stream group or adding a location.\n* **On-demand**: The streaming capacity that Amazon GameLift Streams can allocate in response to stream\n requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup\n time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.\nValues for capacity must be whole number multiples of the tenancy value of the stream group's stream class.\n###### Note\nApplication association is not currently supported in CloudFormation. To link additional applications to a stream group, use the\nAmazon GameLift Streams console or the AWS CLI.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns an [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)\nthat uniquely identifies the stream group resource across all AWS Regions. For example:\n`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA descriptive label for the stream group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*$`\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html#cfn-gameliftstreams-streamgroup-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StreamClass": { "MarkdownDocumentation": "`StreamClass`\n\nThe target stream quality for sessions that are hosted in this stream group. Set a stream class that is appropriate to the type of\ncontent that you're streaming. Stream class determines the type of computing resources Amazon GameLift Streams uses and impacts the cost of streaming. The\nfollowing options are available:\nA stream class can be one of the following:\n* **`gen6n_pro_win2022` (NVIDIA, pro)** Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM\n + Tenancy: Supports 1 concurrent stream session\n* **`gen6n_pro` (NVIDIA, pro)** Supports applications with extremely high 3D scene complexity which require maximum resources.\n Uses dedicated NVIDIA L4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM\n + Tenancy: Supports 1 concurrent stream session\n* **`gen6n_ultra_win2022` (NVIDIA, ultra)** Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM\n + Tenancy: Supports 1 concurrent stream session\n* **`gen6n_ultra` (NVIDIA, ultra)** Supports applications with high 3D scene complexity.\n Uses dedicated NVIDIA L4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM\n + Tenancy: Supports 1 concurrent stream session\n* **`gen6n_high` (NVIDIA, high)** Supports applications with moderate to high 3D scene complexity.\n Uses NVIDIA L4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM\n + Tenancy: Supports up to 2 concurrent stream sessions\n* **`gen6n_medium` (NVIDIA, medium)** Supports applications with moderate 3D scene complexity.\n Uses NVIDIA L4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM\n + Tenancy: Supports up to 4 concurrent stream sessions\n* **`gen6n_small` (NVIDIA, small)** Supports applications with lightweight 3D scene complexity and low CPU usage.\n Uses NVIDIA L4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM\n + Tenancy: Supports up to 12 concurrent stream sessions\n* **`gen5n_win2022` (NVIDIA, ultra)** Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM\n + Tenancy: Supports 1 concurrent stream session\n* **`gen5n_high` (NVIDIA, high)** Supports applications with moderate to high 3D scene complexity.\n Uses NVIDIA A10G Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM\n + Tenancy: Supports up to 2 concurrent stream sessions\n* **`gen5n_ultra` (NVIDIA, ultra)** Supports applications with extremely high 3D scene complexity.\n Uses dedicated NVIDIA A10G Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM\n + Tenancy: Supports 1 concurrent stream session\n* **`gen4n_win2022` (NVIDIA, ultra)** Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM\n + Tenancy: Supports 1 concurrent stream session\n* **`gen4n_high` (NVIDIA, high)** Supports applications with moderate to high 3D scene complexity.\n Uses NVIDIA T4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM\n + Tenancy: Supports up to 2 concurrent stream sessions\n* **`gen4n_ultra` (NVIDIA, ultra)** Supports applications with high 3D scene complexity.\n Uses dedicated NVIDIA T4 Tensor Core GPU.\n \n + Reference resolution: 1080p\n + Reference frame rate: 60 fps\n + Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM\n + Tenancy: Supports 1 concurrent stream session\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html#cfn-gameliftstreams-streamgroup-streamclass", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LocationConfigurations": { "MarkdownDocumentation": "`LocationConfigurations`\n\nA set of one or more locations and the streaming capacity for each location. One of the locations MUST be your primary location, which is\nthe AWS Region where you are specifying this resource.\n*Required*: Yes\n*Type*: Array of [LocationConfiguration](./aws-properties-gameliftstreams-streamgroup-locationconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html#cfn-gameliftstreams-streamgroup-locationconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "LocationConfiguration", "DuplicatesAllowed": false }, "DefaultApplication": { "MarkdownDocumentation": "`DefaultApplication`\n\nObject that identifies the Amazon GameLift Streams application to stream with this stream group.\n*Required*: No\n*Type*: [DefaultApplication](./aws-properties-gameliftstreams-streamgroup-defaultapplication.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html#cfn-gameliftstreams-streamgroup-defaultapplication", "UpdateType": "Mutable", "Required": false, "Type": "DefaultApplication" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is\nuseful for resource management, access management and cost allocation. See [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference*.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html#cfn-gameliftstreams-streamgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nAn ID that uniquely identifies the stream group resource. For example: `sg-1AB2C3De4`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nAn [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely\nidentifies the stream group resource. For example: `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html#Arn-fn::getatt" } } }, "AWS::GlobalAccelerator::Accelerator": { "MarkdownDocumentation": "`AWS::GlobalAccelerator::Accelerator`\n\nThe `AWS::GlobalAccelerator::Accelerator` resource is a Global Accelerator resource type that contains information about\nhow you create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic\nto one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers,\nand Amazon EC2 instances.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the accelerator, such as\n`arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe 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*: `IPV4 | DUAL_STACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "DUAL_STACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IpAddresses": { "MarkdownDocumentation": "`IpAddresses`\n\nOptionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses\nfrom your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can\nspecify 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\none IP address from your IP address range, Global Accelerator assigns a second static IP address for the\naccelerator from the AWS IP address pool.\nNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new\naccelerator with the new addresses.\nFor more information, see [Bring Your Own\nIP 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-ipaddresses", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nCreate 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*: Array of [Tag](./aws-properties-globalaccelerator-accelerator-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the accelerator. The name must contain only alphanumeric characters or\nhyphens (-), and must not begin or end with a hyphen.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{0,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Ipv4Addresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Ipv4Addresses`\n\nThe array of IPv4 addresses in the IP address set. An IP address set can have a maximum of two IP addresses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#Ipv4Addresses-fn::getatt" }, "DnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DnsName`\n\nThe Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#DnsName-fn::getatt" }, "DualStackDnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DualStackDnsName`\n\nThe DNS name that Global Accelerator creates that points to a dual-stack accelerator's four\nstatic IP addresses: two IPv4 addresses and two IPv6 addresses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#DualStackDnsName-fn::getatt" }, "AcceleratorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AcceleratorArn`\n\nThe ARN of the accelerator, such as\n`arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#AcceleratorArn-fn::getatt" }, "Ipv6Addresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Ipv6Addresses`\n\nThe array of IPv6 addresses in the IP address set. An IP address set can have a maximum of two IP addresses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#Ipv6Addresses-fn::getatt" } } }, "AWS::GlobalAccelerator::CrossAccountAttachment": { "MarkdownDocumentation": "`AWS::GlobalAccelerator::CrossAccountAttachment`\n\nCreate a cross-account attachment in AWS Global Accelerator. You create a cross-account attachment to\nspecify the *principals* who have permission to work with *resources*\nin accelerators in their own account. You specify, in the same attachment, the resources that are shared.\nA principal can be an AWS account number or the Amazon Resource Name (ARN) for an\naccelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment,\nyou must sign in to an account specified as a principal. Then, you can work with resources that are listed,\nwith any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal,\nanyone with permission to make updates to the accelerator can work with resources that are listed in the\nattachment.\nSpecify each principal and resource separately. To specify two CIDR address pools, list\nthem individually under `Resources`, and so on. For a command line operation, for example,\nyou might use a statement like the following:\n `\"Resources\": [{\"Cidr\": \"169.254.60.0/24\"},{\"Cidr\": \"169.254.59.0/24\"}]`\nFor more information, see [Working with cross-account attachments and resources in AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html) in the *AWS Global Accelerator Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the cross-account attachment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-crossaccountattachment.html", "Properties": { "Principals": { "MarkdownDocumentation": "`Principals`\n\nThe principals included in the cross-account attachment.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-crossaccountattachment.html#cfn-globalaccelerator-crossaccountattachment-principals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Resources": { "MarkdownDocumentation": "`Resources`\n\nThe resources included in the cross-account attachment.\n*Required*: No\n*Type*: Array of [Resource](./aws-properties-globalaccelerator-crossaccountattachment-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-crossaccountattachment.html#cfn-globalaccelerator-crossaccountattachment-resources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Resource", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAdd tags for a cross-account attachment.\nFor more information, see [Tagging\nin AWS Global Accelerator](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*: Array of [Tag](./aws-properties-globalaccelerator-crossaccountattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-crossaccountattachment.html#cfn-globalaccelerator-crossaccountattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the cross-account attachment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]{0,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-crossaccountattachment.html#cfn-globalaccelerator-crossaccountattachment-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AttachmentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentArn`\n\nThe Amazon Resource Name (ARN) of the cross-account attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-crossaccountattachment.html#AttachmentArn-fn::getatt" } } }, "AWS::GlobalAccelerator::EndpointGroup": { "MarkdownDocumentation": "`AWS::GlobalAccelerator::EndpointGroup`\n\nThe `AWS::GlobalAccelerator::EndpointGroup` resource is a Global Accelerator resource type that contains information about\nhow you create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the endpoint group, such as\n`arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html", "Properties": { "ListenerArn": { "MarkdownDocumentation": "`ListenerArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-listenerarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PortOverrides": { "MarkdownDocumentation": "`PortOverrides`\n\nAllows you to override the destination ports used to route traffic to an endpoint.\nUsing a port override lets you map a list of external destination ports (that your\nusers send traffic to) to a list of internal destination ports that you want an application\nendpoint to receive traffic on.\n*Required*: No\n*Type*: Array of [PortOverride](./aws-properties-globalaccelerator-endpointgroup-portoverride.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-portoverrides", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PortOverride", "DuplicatesAllowed": true }, "HealthCheckIntervalSeconds": { "MarkdownDocumentation": "`HealthCheckIntervalSeconds`\n\nThe time\u201410 seconds or 30 seconds\u2014between health checks for each endpoint. The default value is 30.\n*Required*: No\n*Type*: Integer\n*Minimum*: `10`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckintervalseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EndpointGroupRegion": { "MarkdownDocumentation": "`EndpointGroupRegion`\n\nThe AWS Regions where the endpoint group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointgroupregion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HealthCheckPath": { "MarkdownDocumentation": "`HealthCheckPath`\n\nIf the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the\nendpoints for health checks. The default is slash (/).\n*Required*: No\n*Type*: String\n*Pattern*: `^/[-a-zA-Z0-9@:%_\\\\+.~#?&/=]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrafficDialPercentage": { "MarkdownDocumentation": "`TrafficDialPercentage`\n\nThe percentage of traffic to send to an AWS Regions. Additional traffic is distributed to other endpoint groups for\nthis listener.\nUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\napplied 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*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-trafficdialpercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "HealthCheckProtocol": { "MarkdownDocumentation": "`HealthCheckProtocol`\n\nThe protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default\nvalue is TCP.\n*Required*: No\n*Type*: String\n*Allowed values*: `TCP | 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)", "RefReturnValue": "", "AllowedValues": [ "TCP", "HTTP", "HTTPS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckprotocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ThresholdCount": { "MarkdownDocumentation": "`ThresholdCount`\n\nThe number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\nunhealthy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-thresholdcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "HealthCheckPort": { "MarkdownDocumentation": "`HealthCheckPort`\n\nThe 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\nlist, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EndpointConfigurations": { "MarkdownDocumentation": "`EndpointConfigurations`\n\nThe list of endpoint objects.\n*Required*: No\n*Type*: Array of [EndpointConfiguration](./aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EndpointConfiguration", "DuplicatesAllowed": true } }, "Attributes": { "EndpointGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointGroupArn`\n\nThe ARN of the endpoint group, such as\n`arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#EndpointGroupArn-fn::getatt" } } }, "AWS::GlobalAccelerator::Listener": { "MarkdownDocumentation": "`AWS::GlobalAccelerator::Listener`\n\nThe `AWS::GlobalAccelerator::Listener` resource is a Global Accelerator resource type that contains information about\nhow you create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static\nIP addresses on a port, port range, or list of port ranges that you specify.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the listener, such as\n`arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html", "Properties": { "PortRanges": { "MarkdownDocumentation": "`PortRanges`\n\nThe list of port ranges for the connections from clients to the accelerator.\n*Required*: Yes\n*Type*: Array of [PortRange](./aws-properties-globalaccelerator-listener-portrange.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-portranges", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PortRange", "DuplicatesAllowed": true }, "AcceleratorArn": { "MarkdownDocumentation": "`AcceleratorArn`\n\nThe Amazon Resource Name (ARN) of your accelerator.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-acceleratorarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol for the connections from clients to the accelerator.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TCP | UDP`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "TCP", "UDP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-protocol", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ClientAffinity": { "MarkdownDocumentation": "`ClientAffinity`\n\nClient affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\nregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\nroute each client to the same specific endpoint.\nAWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\naffinity is `NONE`, Global Accelerator uses the \"five-tuple\" (5-tuple) properties\u2014source IP address, source port,\ndestination IP address, destination port, and protocol\u2014to select the hash value, and then chooses the best\nendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\nbe always routed to the same endpoint because the hash value changes.\nIf you want a given client to always be routed to the same endpoint, set client affinity to `SOURCE_IP`\ninstead. When you use the `SOURCE_IP` setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties\u2014\nsource (client) IP address and destination IP address\u2014to select the hash value.\nThe default value is `NONE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | SOURCE_IP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SOURCE_IP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#cfn-globalaccelerator-listener-clientaffinity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ListenerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ListenerArn`\n\nThe ARN of the listener, such as\n`arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-listener.html#ListenerArn-fn::getatt" } } }, "AWS::Glue::Classifier": { "MarkdownDocumentation": "`AWS::Glue::Classifier`\n\nThe `AWS::Glue::Classifier` resource creates an AWS Glue classifier that\ncategorizes data sources and specifies schemas. For more information, see [Adding Classifiers to\na Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-classifier.html) and [Classifier Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-classifiers.html#aws-glue-api-crawler-classifiers-Classifier) in the *AWS Glue Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the classifier name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html", "Properties": { "XMLClassifier": { "Type": "XMLClassifier", "Required": false, "MarkdownDocumentation": "`XMLClassifier`\n\nA classifier for XML content.\n*Required*: Conditional\n*Type*: [XMLClassifier](./aws-properties-glue-classifier-xmlclassifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-xmlclassifier", "UpdateType": "Mutable" }, "JsonClassifier": { "Type": "JsonClassifier", "Required": false, "MarkdownDocumentation": "`JsonClassifier`\n\nA classifier for JSON content.\n*Required*: Conditional\n*Type*: [JsonClassifier](./aws-properties-glue-classifier-jsonclassifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-jsonclassifier", "UpdateType": "Mutable" }, "CsvClassifier": { "Type": "CsvClassifier", "Required": false, "MarkdownDocumentation": "`CsvClassifier`\n\nA classifier for comma-separated values (CSV).\n*Required*: Conditional\n*Type*: [CsvClassifier](./aws-properties-glue-classifier-csvclassifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-csvclassifier", "UpdateType": "Mutable" }, "GrokClassifier": { "Type": "GrokClassifier", "Required": false, "MarkdownDocumentation": "`GrokClassifier`\n\nA classifier that uses `grok`.\n*Required*: Conditional\n*Type*: [GrokClassifier](./aws-properties-glue-classifier-grokclassifier.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-grokclassifier", "UpdateType": "Mutable" } } }, "AWS::Glue::Connection": { "MarkdownDocumentation": "`AWS::Glue::Connection`\n\nThe `AWS::Glue::Connection` resource specifies an AWS Glue connection to a\ndata source. For more information, see [Adding a Connection to Your Data Store](https://docs.aws.amazon.com/glue/latest/dg/populate-add-connection.html)\nand [Connection Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-connections.html#aws-glue-api-catalog-connections-Connection) in the *AWS Glue Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the connection name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html", "Properties": { "ConnectionInput": { "Type": "ConnectionInput", "Required": true, "MarkdownDocumentation": "`ConnectionInput`\n\nThe connection that you want to create.\n*Required*: Yes\n*Type*: [ConnectionInput](./aws-properties-glue-connection-connectioninput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html#cfn-glue-connection-connectioninput", "UpdateType": "Mutable" }, "CatalogId": { "Required": true, "MarkdownDocumentation": "`CatalogId`\n\nThe ID of the data catalog to create the catalog object in. Currently, this should be\nthe AWS account ID.\n###### Note\nTo specify the account ID, you can use the `Ref` intrinsic function\nwith the `AWS::AccountId` pseudo parameter. For example: `!Ref\nAWS::AccountId`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html#cfn-glue-connection-catalogid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::Crawler": { "MarkdownDocumentation": "`AWS::Glue::Crawler`\n\nThe `AWS::Glue::Crawler` resource specifies an AWS Glue crawler. For more\ninformation, see [Cataloging Tables with a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) and [Crawler Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-crawling.html#aws-glue-api-crawler-crawling-Crawler) in the *AWS Glue Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the crawler name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html", "Properties": { "Classifiers": { "MarkdownDocumentation": "`Classifiers`\n\nA list of UTF-8 strings that specify the names of custom classifiers that are associated\nwith the crawler.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-classifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the crawler.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SchemaChangePolicy": { "MarkdownDocumentation": "`SchemaChangePolicy`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schemachangepolicy", "UpdateType": "Mutable", "Required": false, "Type": "SchemaChangePolicy" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nCrawler configuration information. This versioned JSON string allows users to specify\naspects of a crawler's behavior. For more information, see [Configuring a\nCrawler](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-configuration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RecrawlPolicy": { "MarkdownDocumentation": "`RecrawlPolicy`\n\nA 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-recrawlpolicy", "UpdateType": "Mutable", "Required": false, "Type": "RecrawlPolicy" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-databasename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nA collection of targets to crawl.\n*Required*: Yes\n*Type*: [Targets](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-targets", "UpdateType": "Mutable", "Required": true, "Type": "Targets" }, "CrawlerSecurityConfiguration": { "MarkdownDocumentation": "`CrawlerSecurityConfiguration`\n\nThe name of the `SecurityConfiguration` structure to be used by this\ncrawler.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-crawlersecurityconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the crawler.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Role": { "MarkdownDocumentation": "`Role`\n\nThe Amazon Resource Name (ARN) of an IAM role that's used to access customer resources,\nsuch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LakeFormationConfiguration": { "MarkdownDocumentation": "`LakeFormationConfiguration`\n\nSpecifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.\n*Required*: No\n*Type*: [LakeFormationConfiguration](./aws-properties-glue-crawler-lakeformationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-lakeformationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LakeFormationConfiguration" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nFor scheduled crawlers, the schedule when the crawler runs.\n*Required*: No\n*Type*: [Schedule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schedule", "UpdateType": "Mutable", "Required": false, "Type": "Schedule" }, "TablePrefix": { "MarkdownDocumentation": "`TablePrefix`\n\nThe prefix added to the names of tables that are created.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tableprefix", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to use with this crawler.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::Glue::CustomEntityType": { "MarkdownDocumentation": "`AWS::Glue::CustomEntityType`\n\nCreates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.\nEach custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html", "Properties": { "ContextWords": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`ContextWords`\n\nA list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.\nIf no context words are passed only a regular expression is checked.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html#cfn-glue-customentitytype-contextwords", "UpdateType": "Mutable" }, "RegexString": { "Required": false, "MarkdownDocumentation": "`RegexString`\n\nA regular expression string that is used for detecting sensitive data in a custom pattern.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html#cfn-glue-customentitytype-regexstring", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nAWS tags that contain a key value pair and may be searched by console, command line, or API.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html#cfn-glue-customentitytype-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nA name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html#cfn-glue-customentitytype-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::DataCatalogEncryptionSettings": { "MarkdownDocumentation": "`AWS::Glue::DataCatalogEncryptionSettings`\n\nSets the security configuration for a specified catalog. After the configuration has been\nset, the specified encryption is applied to every catalog write thereafter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html", "Properties": { "DataCatalogEncryptionSettings": { "Type": "DataCatalogEncryptionSettings", "Required": true, "MarkdownDocumentation": "`DataCatalogEncryptionSettings`\n\nContains configuration information for maintaining Data Catalog security.\n*Required*: Yes\n*Type*: [DataCatalogEncryptionSettings](./aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings", "UpdateType": "Mutable" }, "CatalogId": { "Required": true, "MarkdownDocumentation": "`CatalogId`\n\nThe ID of the Data Catalog in which the settings are 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-catalogid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::DataQualityRuleset": { "MarkdownDocumentation": "`AWS::Glue::DataQualityRuleset`\n\nThe `AWS::Glue::DataQualityRuleset` resource specifies a data quality ruleset with DQDL rules applied to a specified AWS Glue table. For more information, see AWS Glue Data Quality in the AWS Glue Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html", "Properties": { "Ruleset": { "Required": false, "MarkdownDocumentation": "`Ruleset`\n\nA Data Quality Definition Language (DQDL) ruleset. For more information see the AWS Glue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-ruleset", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA description of the data quality ruleset.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TargetTable": { "Type": "DataQualityTargetTable", "Required": false, "MarkdownDocumentation": "`TargetTable`\n\nAn object representing an AWS Glue table.\n*Required*: No\n*Type*: [DataQualityTargetTable](./aws-properties-glue-dataqualityruleset-dataqualitytargettable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-targettable", "UpdateType": "Mutable" }, "ClientToken": { "Required": false, "MarkdownDocumentation": "`ClientToken`\n\nUsed for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-clienttoken", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nA list of tags applied to the data quality ruleset.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the data quality ruleset.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Glue::Database": { "MarkdownDocumentation": "`AWS::Glue::Database`\n\nThe `AWS::Glue::Database` resource specifies a logical grouping of tables\nin AWS Glue. For more information, see [Defining a Database in Your Data\nCatalog](https://docs.aws.amazon.com/glue/latest/dg/define-database.html) and [Database Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-databases.html#aws-glue-api-catalog-databases-Database) in the *AWS Glue Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the database name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html", "Properties": { "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the catalog database.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-databasename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DatabaseInput": { "MarkdownDocumentation": "`DatabaseInput`\n\nThe metadata for the database.\n*Required*: Yes\n*Type*: [DatabaseInput](./aws-properties-glue-database-databaseinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-databaseinput", "UpdateType": "Mutable", "Required": true, "Type": "DatabaseInput" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nThe AWS account ID for the account in which to create the catalog object.\n###### Note\nTo specify the account ID, you can use the `Ref` intrinsic function\nwith the `AWS::AccountId` pseudo parameter. For example: `!Ref\nAWS::AccountId`\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-catalogid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Glue::DevEndpoint": { "MarkdownDocumentation": "`AWS::Glue::DevEndpoint`\n\nThe `AWS::Glue::DevEndpoint` resource specifies a development endpoint\nwhere a developer can remotely debug ETL scripts for AWS Glue. For more information, see\n[DevEndpoint Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint) in the AWS Glue Developer Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the endpoint name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html", "Properties": { "ExtraJarsS3Path": { "Required": false, "MarkdownDocumentation": "`ExtraJarsS3Path`\n\nThe path to one or more Java `.jar` files in an S3 bucket that should be\nloaded in your `DevEndpoint`.\n###### Note\nYou can only use pure Java/Scala libraries with a `DevEndpoint`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrajarss3path", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PublicKey": { "Required": false, "MarkdownDocumentation": "`PublicKey`\n\nThe public key to be used by this `DevEndpoint` for authentication. This\nattribute is provided for backward compatibility because the recommended attribute to\nuse is public keys.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-publickey", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NumberOfNodes": { "Required": false, "MarkdownDocumentation": "`NumberOfNodes`\n\nThe number of AWS Glue Data Processing Units (DPUs) allocated to this\n`DevEndpoint`.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofnodes", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Arguments": { "Required": false, "MarkdownDocumentation": "`Arguments`\n\nA map of arguments used to configure the `DevEndpoint`.\nValid arguments are:\n* `\"--enable-glue-datacatalog\": \"\"`\n* `\"GLUE_PYTHON_VERSION\": \"3\"`\n* `\"GLUE_PYTHON_VERSION\": \"2\"`\nYou can specify a version of Python support for development endpoints by using the `Arguments` parameter in the `CreateDevEndpoint` or `UpdateDevEndpoint` APIs. If no arguments are provided, the version defaults to Python 2.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-arguments", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "SubnetId": { "Required": false, "MarkdownDocumentation": "`SubnetId`\n\nThe subnet ID for this `DevEndpoint`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-subnetid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PublicKeys": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`PublicKeys`\n\nA list of public keys to be used by the `DevEndpoints` for authentication.\nUsing this attribute is preferred over a single public key because the public keys allow you\nto have a different private key per client.\n###### Note\nIf you previously created an endpoint with a public key, you must remove that key to be\nable to set a list of public keys. Call the `UpdateDevEndpoint` API operation\nwith the public key content in the `deletePublicKeys` attribute, and the list of\nnew keys in the `addPublicKeys` attribute.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-publickeys", "UpdateType": "Mutable" }, "SecurityGroupIds": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of security group identifiers used in this `DevEndpoint`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securitygroupids", "UpdateType": "Mutable" }, "RoleArn": { "Required": true, "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role used in this\n`DevEndpoint`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws:iam::\\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "WorkerType": { "Required": false, "MarkdownDocumentation": "`WorkerType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-workertype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EndpointName": { "Required": false, "MarkdownDocumentation": "`EndpointName`\n\nThe name of the `DevEndpoint`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-endpointname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GlueVersion": { "Required": false, "MarkdownDocumentation": "`GlueVersion`\n\nThe AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.\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.\nDevelopment endpoints that are created without specifying a Glue version default to Glue 0.9.\nYou can specify a version of Python support for development endpoints by using the `Arguments` parameter in the `CreateDevEndpoint` or `UpdateDevEndpoint` APIs. If no arguments are provided, the version defaults to Python 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-glueversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ExtraPythonLibsS3Path": { "Required": false, "MarkdownDocumentation": "`ExtraPythonLibsS3Path`\n\nThe paths to one or more Python libraries in an Amazon S3 bucket that should be loaded\nin your `DevEndpoint`. Multiple values must be complete paths separated by a\ncomma.\n###### Note\nYou can only use pure Python libraries with a `DevEndpoint`. Libraries\nthat rely on C extensions, such as the [pandas](http://pandas.pydata.org/) Python data analysis library, are not currently\nsupported.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrapythonlibss3path", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SecurityConfiguration": { "Required": false, "MarkdownDocumentation": "`SecurityConfiguration`\n\nThe name of the `SecurityConfiguration` structure to be used with this\n`DevEndpoint`.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securityconfiguration", "PrimitiveType": "String", "UpdateType": "Mutable" }, "NumberOfWorkers": { "Required": false, "MarkdownDocumentation": "`NumberOfWorkers`\n\nThe number of workers of a defined `workerType` that are allocated to the development endpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofworkers", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to use with this DevEndpoint.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" } } }, "AWS::Glue::IdentityCenterConfiguration": { "MarkdownDocumentation": "`AWS::Glue::IdentityCenterConfiguration`\n\nCreates a new AWS Glue Identity Center configuration to enable integration between AWS Glue and AWS IAM\nIdentity Center for authentication and authorization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-identitycenterconfiguration.html", "Properties": { "UserBackgroundSessionsEnabled": { "MarkdownDocumentation": "`UserBackgroundSessionsEnabled`\n\nIndicates whether users can run background sessions when using Identity Center authentication with AWS Glue services.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-identitycenterconfiguration.html#cfn-glue-identitycenterconfiguration-userbackgroundsessionsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Scopes": { "MarkdownDocumentation": "`Scopes`\n\nA list of Identity Center scopes that define the permissions and access levels for the AWS Glue configuration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-identitycenterconfiguration.html#cfn-glue-identitycenterconfiguration-scopes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "InstanceArn": { "MarkdownDocumentation": "`InstanceArn`\n\nThe Amazon Resource Name (ARN) of the Identity Center instance associated with the AWS Glue configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-identitycenterconfiguration.html#cfn-glue-identitycenterconfiguration-instancearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ApplicationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApplicationArn`\n\nThe Amazon Resource Name (ARN) of the Identity Center application associated with the AWS Glue configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-identitycenterconfiguration.html#ApplicationArn-fn::getatt" }, "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-identitycenterconfiguration.html#AccountId-fn::getatt" } } }, "AWS::Glue::Integration": { "MarkdownDocumentation": "`AWS::Glue::Integration`\n\nThe `AWS::Glue::Integration` resource specifies an AWS Glue zero-ETL integration from a data source to a target. For more information, see [zero-ETL integration supported by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/zero-etl-using.html) and [integration structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-integrations.html) in the AWS Glue developer guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html", "Properties": { "DataFilter": { "MarkdownDocumentation": "`DataFilter`\n\nSelects source tables for the integration using Maxwell filter syntax.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-datafilter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegrationName": { "MarkdownDocumentation": "`IntegrationName`\n\nA unique name for the integration.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-integrationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the integration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe ARN for the source of the integration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws:.*:.*:[0-9]+:.*`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-sourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IntegrationConfig": { "MarkdownDocumentation": "`IntegrationConfig`\n\nThe structure used to define properties associated with the zero-ETL integration. For more information, see [IntegrationConfig structure.](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-integrations.html#aws-glue-api-integrations-IntegrationConfig)\n*Required*: No\n*Type*: [IntegrationConfig](./aws-properties-glue-integration-integrationconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-integrationconfig", "UpdateType": "Immutable", "Required": false, "Type": "IntegrationConfig" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe ARN of a KMS key used for encrypting the channel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe ARN for the target of the integration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws:.*:.*:[0-9]+:.*`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-targetarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AdditionalEncryptionContext": { "MarkdownDocumentation": "`AdditionalEncryptionContext`\n\nAn optional set of non-secret key\u2013value pairs that contains additional contextual information for encryption. This can only be provided if `KMSKeyId` is provided.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\s\\S]*$`\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-additionalencryptioncontext", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata assigned to the resource consisting of a list of key-value pairs.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-glue-integration-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the integration being created.\nThe possible statuses are:\n* CREATING: The integration is being created.\n* ACTIVE: The integration creation succeeds.\n* MODIFYING: The integration is being modified.\n* FAILED: The integration creation fails.\n* DELETING: The integration is deleted.\n* SYNCING: The integration is synchronizing.\n* NEEDS\\_ATTENTION: The integration needs attention, such as synchronization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#Status-fn::getatt" }, "IntegrationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IntegrationArn`\n\nThe Amazon Resource Name (ARN) for the created integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#IntegrationArn-fn::getatt" }, "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe time when the integration was created, in UTC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#CreateTime-fn::getatt" } } }, "AWS::Glue::IntegrationResourceProperty": { "MarkdownDocumentation": "`AWS::Glue::IntegrationResourceProperty`\n\nThe `AWS::Glue::IntegrationResourceProperty` resource type can be used to setup `ResourceProperty` of the AWS Glue connection (for the SaaS source), DynamoDB Database (for DynamoDB source), or AWS Glue database ARN (for the target). ResourceProperty is used to define the properties requires to setup the integration, including the role to access the connection or database, KMS keys, event bus for event notifications and VPC connection. To set both source and target properties the same API needs to be invoked twice, once with the AWS Glue connection ARN as ResourceArn with SourceProcessingProperties and next, with the AWS Glue database ARN as ResourceArn with TargetProcessingProperties respectively.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns The resource property arn.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integrationresourceproperty.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe connection ARN of the source, or the database ARN of the target.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws:.*:.*:[0-9]+:.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integrationresourceproperty.html#cfn-glue-integrationresourceproperty-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetProcessingProperties": { "MarkdownDocumentation": "`TargetProcessingProperties`\n\nThe structure used to define the resource properties associated with the integration target.\n*Required*: No\n*Type*: [TargetProcessingProperties](./aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integrationresourceproperty.html#cfn-glue-integrationresourceproperty-targetprocessingproperties", "UpdateType": "Mutable", "Required": false, "Type": "TargetProcessingProperties" }, "SourceProcessingProperties": { "MarkdownDocumentation": "`SourceProcessingProperties`\n\nThe resource properties associated with the integration source.\n*Required*: No\n*Type*: [SourceProcessingProperties](./aws-properties-glue-integrationresourceproperty-sourceprocessingproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integrationresourceproperty.html#cfn-glue-integrationresourceproperty-sourceprocessingproperties", "UpdateType": "Mutable", "Required": false, "Type": "SourceProcessingProperties" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-glue-integrationresourceproperty-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integrationresourceproperty.html#cfn-glue-integrationresourceproperty-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ResourcePropertyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourcePropertyArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integrationresourceproperty.html#ResourcePropertyArn-fn::getatt" } } }, "AWS::Glue::Job": { "MarkdownDocumentation": "`AWS::Glue::Job`\n\nThe `AWS::Glue::Job` resource specifies an AWS Glue job in the data\ncatalog. For more information, see [Adding Jobs in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) and [Job\nStructure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job) in the *AWS Glue Developer Guide.*\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the job name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html", "Properties": { "Connections": { "MarkdownDocumentation": "`Connections`\n\nThe connections used for this job.\n*Required*: No\n*Type*: [ConnectionsList](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-connections", "UpdateType": "Mutable", "Required": false, "Type": "ConnectionsList" }, "MaxRetries": { "MarkdownDocumentation": "`MaxRetries`\n\nThe maximum number of times to retry this job after a JobRun fails.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxretries", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "JobMode": { "MarkdownDocumentation": "`JobMode`\n\nA mode that describes how a job was created. Valid values are:\n* `SCRIPT` - The job was created using the AWS Glue Studio script editor.\n* `VISUAL` - The job was created using the AWS Glue Studio visual editor.\n* `NOTEBOOK` - The job was created using an interactive sessions notebook.\nWhen the `JobMode` field is missing or null, `SCRIPT` is assigned as the default value.\n*Required*: No\n*Type*: String\n*Allowed values*: `SCRIPT | VISUAL | NOTEBOOK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SCRIPT", "VISUAL", "NOTEBOOK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-jobmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the job.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nThe job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-timeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AllocatedCapacity": { "MarkdownDocumentation": "`AllocatedCapacity`\n\nThis parameter is no longer supported. Use `MaxCapacity` instead.\nThe number of capacity units that are allocated to this job.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-allocatedcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "JobRunQueuingEnabled": { "MarkdownDocumentation": "`JobRunQueuingEnabled`\n\nSpecifies whether job run queuing is enabled for the job runs for this job.\nA value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.\nIf this field does not match the value set in the job run, then the value from the job run field will be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-jobrunqueuingenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name you assign to this job definition.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Role": { "MarkdownDocumentation": "`Role`\n\nThe name or Amazon Resource Name (ARN) of the IAM role associated with this\njob.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DefaultArguments": { "MarkdownDocumentation": "`DefaultArguments`\n\nThe default arguments for this job, specified as name-value pairs.\nYou can specify arguments here that your own job-execution script consumes, in\naddition 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\nGuide*.\nFor information about the key-value pairs that AWS Glue consumes to set up your job,\nsee [Special Parameters\nUsed by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) in the *AWS Glue Developer\nGuide*.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-defaultarguments", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "NotificationProperty": { "MarkdownDocumentation": "`NotificationProperty`\n\nSpecifies configuration properties of a notification.\n*Required*: No\n*Type*: [NotificationProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-notificationproperty", "UpdateType": "Mutable", "Required": false, "Type": "NotificationProperty" }, "WorkerType": { "MarkdownDocumentation": "`WorkerType`\n\nThe type of predefined worker that is allocated when a job runs.\nAWS Glue provides multiple worker types to accommodate different workload requirements:\nG Worker Types (General-purpose compute workers):\n* G.1X: 1 DPU (4 vCPUs, 16 GB memory, 94GB disk)\n* G.2X: 2 DPU (8 vCPUs, 32 GB memory, 138GB disk)\n* G.4X: 4 DPU (16 vCPUs, 64 GB memory, 256GB disk)\n* G.8X: 8 DPU (32 vCPUs, 128 GB memory, 512GB disk)\n* G.12X: 12 DPU (48 vCPUs, 192 GB memory, 768GB disk)\n* G.16X: 16 DPU (64 vCPUs, 256 GB memory, 1024GB disk)\nR Worker Types (Memory-optimized workers):\n* R.1X: 1 M-DPU (4 vCPUs, 32 GB memory)\n* R.2X: 2 M-DPU (8 vCPUs, 64 GB memory)\n* R.4X: 4 M-DPU (16 vCPUs, 128 GB memory)\n* R.8X: 8 M-DPU (32 vCPUs, 256 GB memory)\n*Required*: No\n*Type*: String\n*Allowed values*: `Standard | G.1X | G.2X | G....`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Standard", "G.1X", "G.2X", "G.025X", "G.4X", "G.8X", "Z.2X", "G.12X", "G.16X", "R.1X", "R.2X", "R.4X", "R.8X" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-workertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionClass": { "MarkdownDocumentation": "`ExecutionClass`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogUri": { "MarkdownDocumentation": "`LogUri`\n\nThis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-loguri", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Command": { "MarkdownDocumentation": "`Command`\n\nThe code that executes a job.\n*Required*: Yes\n*Type*: [JobCommand](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-command", "UpdateType": "Mutable", "Required": true, "Type": "JobCommand" }, "GlueVersion": { "MarkdownDocumentation": "`GlueVersion`\n\nGlue 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 the latest Glue version available.\n*Required*: No\n*Type*: String\n*Pattern*: `^(\\w+\\.)+\\w+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-glueversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionProperty": { "MarkdownDocumentation": "`ExecutionProperty`\n\nThe maximum number of concurrent runs that are allowed for this job.\n*Required*: No\n*Type*: [ExecutionProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionproperty", "UpdateType": "Mutable", "Required": false, "Type": "ExecutionProperty" }, "SecurityConfiguration": { "MarkdownDocumentation": "`SecurityConfiguration`\n\nThe name of the `SecurityConfiguration` structure to be used with this\njob.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-securityconfiguration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaintenanceWindow": { "MarkdownDocumentation": "`MaintenanceWindow`\n\nThis field specifies a day of the week and hour for a maintenance window for streaming jobs. AWS Glue periodically performs maintenance activities. During these maintenance windows, AWS Glue will need to restart your streaming jobs.\nAWS Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.\n*Required*: No\n*Type*: String\n*Pattern*: `^(Sun|Mon|Tue|Wed|Thu|Fri|Sat):([01]?[0-9]|2[0-3])$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NumberOfWorkers": { "MarkdownDocumentation": "`NumberOfWorkers`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-numberofworkers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to use with this job.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-tags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\nof 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\nrunning a Python shell job or an Apache Spark ETL job:\n* When you specify a Python shell job (`JobCommand.Name`=\"pythonshell\"), you can\n 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*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "NonOverridableArguments": { "MarkdownDocumentation": "`NonOverridableArguments`\n\nNon-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-nonoverridablearguments", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::Glue::MLTransform": { "MarkdownDocumentation": "`AWS::Glue::MLTransform`\n\nThe AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the transform ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html", "Properties": { "MaxRetries": { "Required": false, "MarkdownDocumentation": "`MaxRetries`\n\nThe maximum number of times to retry after an `MLTaskRun` of the machine\nlearning transform 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-maxretries", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA user-defined, long-form description text for the machine learning transform.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TransformEncryption": { "Type": "TransformEncryption", "Required": false, "MarkdownDocumentation": "`TransformEncryption`\n\nThe encryption-at-rest settings of the transform that apply to accessing user data. Machine learning\ntransforms can access user data encrypted in Amazon S3 using KMS.\nAdditionally, imported labels and trained transforms can now be encrypted using a customer provided\nKMS key.\n*Required*: No\n*Type*: [TransformEncryption](./aws-properties-glue-mltransform-transformencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-transformencryption", "UpdateType": "Mutable" }, "Timeout": { "Required": false, "MarkdownDocumentation": "`Timeout`\n\nThe timeout in minutes of the machine learning transform.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-timeout", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nA user-defined name for the machine learning transform. Names are required to be unique. `Name` is optional:\n* If you supply `Name`, the stack cannot be repeatedly created.\n* If `Name` is not provided, a randomly generated name will be used instead.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Role": { "Required": true, "MarkdownDocumentation": "`Role`\n\nThe name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.\n* This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See [Attach a Policy to IAM Users That Access AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html).\n* This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-role", "PrimitiveType": "String", "UpdateType": "Mutable" }, "WorkerType": { "Required": false, "MarkdownDocumentation": "`WorkerType`\n\nThe type of predefined worker that is allocated when a task of this transform runs. 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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.\n* For the `G.2X` worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.\n`MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and `WorkerType`.\n* If either `NumberOfWorkers` or `WorkerType` is set, then `MaxCapacity` cannot be set.\n* If `MaxCapacity` is set then neither `NumberOfWorkers` or `WorkerType` can be set.\n* If `WorkerType` is set, then `NumberOfWorkers` is required (and vice versa).\n* `MaxCapacity` and `NumberOfWorkers` must both be at least 1.\n*Required*: No\n*Type*: String\n*Allowed values*: `Standard | G.1X | G.2X | G....`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Standard", "G.1X", "G.2X", "G.025X", "G.4X", "G.8X", "Z.2X" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-workertype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "GlueVersion": { "Required": false, "MarkdownDocumentation": "`GlueVersion`\n\nThis value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see [AWS Glue Versions](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-glueversion", "PrimitiveType": "String", "UpdateType": "Mutable" }, "TransformParameters": { "Type": "TransformParameters", "Required": true, "MarkdownDocumentation": "`TransformParameters`\n\nThe algorithm-specific parameters that are associated with the machine learning transform.\n*Required*: Yes\n*Type*: [TransformParameters](./aws-properties-glue-mltransform-transformparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-transformparameters", "UpdateType": "Mutable" }, "InputRecordTables": { "Type": "InputRecordTables", "Required": true, "MarkdownDocumentation": "`InputRecordTables`\n\nA list of AWS Glue table definitions used by the transform.\n*Required*: Yes\n*Type*: [InputRecordTables](./aws-properties-glue-mltransform-inputrecordtables.html)\n*Minimum*: `0`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-inputrecordtables", "UpdateType": "Immutable" }, "NumberOfWorkers": { "Required": false, "MarkdownDocumentation": "`NumberOfWorkers`\n\nThe number of workers of a defined `workerType` that are allocated when a task of the transform runs.\nIf `WorkerType` is set, then `NumberOfWorkers` is required (and vice versa).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-numberofworkers", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see [AWS Tags in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the developer guide.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "MaxCapacity": { "Required": false, "MarkdownDocumentation": "`MaxCapacity`\n\nThe number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\nprocessing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\ninformation, see the [AWS Glue pricing\npage](https://aws.amazon.com/glue/pricing/).\n`MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and `WorkerType`.\n* If either `NumberOfWorkers` or `WorkerType` is set, then `MaxCapacity` cannot be set.\n* If `MaxCapacity` is set then neither `NumberOfWorkers` or `WorkerType` can be set.\n* If `WorkerType` is set, then `NumberOfWorkers` is required (and vice versa).\n* `MaxCapacity` and `NumberOfWorkers` must both be at least 1.\nWhen the `WorkerType` field is set to a value other than `Standard`, the `MaxCapacity` field is set automatically and becomes read-only.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-maxcapacity", "PrimitiveType": "Double", "UpdateType": "Mutable" } } }, "AWS::Glue::Partition": { "MarkdownDocumentation": "`AWS::Glue::Partition`\n\nThe `AWS::Glue::Partition` resource creates an AWS Glue partition, which\nrepresents a slice of table data. For more information, see [CreatePartition Action](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-CreatePartition) and [Partition Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-Partition) in the *AWS Glue Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the partition name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html", "Properties": { "TableName": { "Required": true, "MarkdownDocumentation": "`TableName`\n\nThe name of the metadata table in which the partition is to be created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-tablename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DatabaseName": { "Required": true, "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the catalog database in which to create the partition.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-databasename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CatalogId": { "Required": true, "MarkdownDocumentation": "`CatalogId`\n\nThe AWS account ID of the catalog in which the partion is to be created.\n###### Note\nTo specify the account ID, you can use the `Ref` intrinsic function\nwith the `AWS::AccountId` pseudo parameter. For example: `!Ref\nAWS::AccountId`\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-catalogid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "PartitionInput": { "Type": "PartitionInput", "Required": true, "MarkdownDocumentation": "`PartitionInput`\n\nThe structure used to create and update a partition.\n*Required*: Yes\n*Type*: [PartitionInput](./aws-properties-glue-partition-partitioninput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-partitioninput", "UpdateType": "Mutable" } } }, "AWS::Glue::Registry": { "MarkdownDocumentation": "`AWS::Glue::Registry`\n\nThe AWS::Glue::Registry is an AWS Glue resource type that manages registries of schemas in the AWS Glue Schema Registry.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a combination of \"VersionId|Key|Value\" as a string.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the registry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html#cfn-glue-registry-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAWS tags that contain a key value pair and may be searched by console, command line, or API.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-glue-registry-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html#cfn-glue-registry-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the registry.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html#cfn-glue-registry-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html#Arn-fn::getatt" } } }, "AWS::Glue::Schema": { "MarkdownDocumentation": "`AWS::Glue::Schema`\n\nThe `AWS::Glue::Schema` is an AWS Glue resource type that manages schemas in the AWS Glue Schema Registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html", "Properties": { "SchemaDefinition": { "MarkdownDocumentation": "`SchemaDefinition`\n\nThe schema definition using the `DataFormat` setting for `SchemaName`.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `170000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-schemadefinition", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the schema if specified when created.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataFormat": { "MarkdownDocumentation": "`DataFormat`\n\nThe data format of the schema definition. Currently only `AVRO` is supported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AVRO | JSON | PROTOBUF...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AVRO", "JSON", "PROTOBUF" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-dataformat", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Registry": { "MarkdownDocumentation": "`Registry`\n\nThe registry where a schema is stored.\n*Required*: No\n*Type*: [Registry](./aws-properties-glue-schema-registry.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-registry", "UpdateType": "Immutable", "Required": false, "Type": "Registry" }, "Compatibility": { "MarkdownDocumentation": "`Compatibility`\n\nThe compatibility mode of the schema.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | DISABLED | BACKWARD ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "DISABLED", "BACKWARD", "BACKWARD_ALL", "FORWARD", "FORWARD_ALL", "FULL", "FULL_ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-compatibility", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAWS tags that contain a key value pair and may be searched by console, command line, or API.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-glue-schema-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CheckpointVersion": { "MarkdownDocumentation": "`CheckpointVersion`\n\nSpecify the `VersionNumber` or the `IsLatest` for setting the checkpoint for the schema. This is only required for updating a checkpoint.\n*Required*: No\n*Type*: [SchemaVersion](./aws-properties-glue-schema-schemaversion.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-checkpointversion", "UpdateType": "Mutable", "Required": false, "Type": "SchemaVersion" } }, "Attributes": { "InitialSchemaVersionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`InitialSchemaVersionId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#InitialSchemaVersionId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#Arn-fn::getatt" } } }, "AWS::Glue::SchemaVersion": { "MarkdownDocumentation": "`AWS::Glue::SchemaVersion`\n\nThe `AWS::Glue::SchemaVersion` is an AWS Glue resource type that manages schema versions of schemas in the AWS Glue Schema Registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversion.html", "Properties": { "SchemaDefinition": { "MarkdownDocumentation": "`SchemaDefinition`\n\nThe schema definition for the schema version.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `170000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversion.html#cfn-glue-schemaversion-schemadefinition", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe schema that includes the schema version.\n*Required*: Yes\n*Type*: [Schema](./aws-properties-glue-schemaversion-schema.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversion.html#cfn-glue-schemaversion-schema", "UpdateType": "Immutable", "Required": true, "Type": "Schema" } }, "Attributes": { "VersionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VersionId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversion.html#VersionId-fn::getatt" } } }, "AWS::Glue::SchemaVersionMetadata": { "MarkdownDocumentation": "`AWS::Glue::SchemaVersionMetadata`\n\nThe `AWS::Glue::SchemaVersionMetadata` is an AWS Glue resource type that defines the metadata key-value pairs for a schema version in AWS Glue Schema Registry.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversionmetadata.html", "Properties": { "SchemaVersionId": { "MarkdownDocumentation": "`SchemaVersionId`\n\nThe version number of the schema.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversionmetadata.html#cfn-glue-schemaversionmetadata-schemaversionid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nA metadata key's corresponding value.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversionmetadata.html#cfn-glue-schemaversionmetadata-value", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Key": { "MarkdownDocumentation": "`Key`\n\nA metadata key in a key-value pair for metadata.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversionmetadata.html#cfn-glue-schemaversionmetadata-key", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Glue::SecurityConfiguration": { "MarkdownDocumentation": "`AWS::Glue::SecurityConfiguration`\n\nCreates a new security configuration. A security configuration is a set of security properties that can be used by AWS Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue, see [Encrypting Data Written by Crawlers, Jobs, and Development Endpoints](https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html", "Properties": { "EncryptionConfiguration": { "Type": "EncryptionConfiguration", "Required": true, "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption configuration associated with this security configuration.\n*Required*: Yes\n*Type*: [EncryptionConfiguration](./aws-properties-glue-securityconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the security configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html#cfn-glue-securityconfiguration-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::Table": { "MarkdownDocumentation": "`AWS::Glue::Table`\n\nThe `AWS::Glue::Table` resource specifies tabular data in the AWS Glue data\ncatalog. For more information, see [Defining Tables in the AWS Glue Data\nCatalog](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html) and [Table Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-tables.html#aws-glue-api-catalog-tables-Table) in the *AWS Glue Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the table name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html", "Properties": { "TableInput": { "Type": "TableInput", "Required": true, "MarkdownDocumentation": "`TableInput`\n\nA structure used to define a table.\n*Required*: Yes\n*Type*: [TableInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-tableinput", "UpdateType": "Mutable" }, "OpenTableFormatInput": { "Type": "OpenTableFormatInput", "Required": false, "MarkdownDocumentation": "`OpenTableFormatInput`\n\nSpecifies an `OpenTableFormatInput` structure when creating an open format table.\n*Required*: No\n*Type*: [OpenTableFormatInput](./aws-properties-glue-table-opentableformatinput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-opentableformatinput", "UpdateType": "Mutable" }, "DatabaseName": { "Required": true, "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the database where the table metadata resides.\nFor Hive compatibility, this must be all lowercase.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-databasename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CatalogId": { "Required": true, "MarkdownDocumentation": "`CatalogId`\n\nThe ID of the Data Catalog in which to create the `Table`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-catalogid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::TableOptimizer": { "MarkdownDocumentation": "`AWS::Glue::TableOptimizer`\n\nAn AWS Glue resource for enabling table optimizers to improve read performance for open table formats.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html", "Properties": { "TableName": { "Required": true, "MarkdownDocumentation": "`TableName`\n\nThe table name. For Hive compatibility, this must be entirely\nlowercase.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-tablename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Type": { "Required": true, "MarkdownDocumentation": "`Type`\n\nThe type of table optimizer. The valid values are:\n* compaction - for managing compaction with a table optimizer.\n* retention - for managing the retention of snapshot with a table optimizer.\n* orphan\\_file\\_deletion - for managing the deletion of orphan files with a table optimizer.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-type", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DatabaseName": { "Required": true, "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the database. For Hive compatibility, this is folded to lowercase when it is\nstored.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-databasename", "PrimitiveType": "String", "UpdateType": "Immutable" }, "TableOptimizerConfiguration": { "Type": "TableOptimizerConfiguration", "Required": true, "MarkdownDocumentation": "`TableOptimizerConfiguration`\n\nSpecifies configuration details of a table optimizer.\n*Required*: Yes\n*Type*: [TableOptimizerConfiguration](./aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration", "UpdateType": "Mutable" }, "CatalogId": { "Required": true, "MarkdownDocumentation": "`CatalogId`\n\nThe catalog ID 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-catalogid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Glue::Trigger": { "MarkdownDocumentation": "`AWS::Glue::Trigger`\n\nThe `AWS::Glue::Trigger` resource specifies triggers that run AWS Glue\njobs. For more information, see [Triggering Jobs in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html) and [Trigger Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Trigger) in the *AWS Glue Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the trigger name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of trigger that this is.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SCHEDULED | CONDITIONAL | O...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SCHEDULED", "CONDITIONAL", "ON_DEMAND", "EVENT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StartOnCreation": { "MarkdownDocumentation": "`StartOnCreation`\n\nSet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-startoncreation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of this trigger.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions initiated by this trigger.\n*Required*: Yes\n*Type*: Array of [Action](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-actions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Action", "DuplicatesAllowed": true }, "EventBatchingCondition": { "MarkdownDocumentation": "`EventBatchingCondition`\n\nBatch 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-eventbatchingcondition", "UpdateType": "Mutable", "Required": false, "Type": "EventBatchingCondition" }, "WorkflowName": { "MarkdownDocumentation": "`WorkflowName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-workflowname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nA `cron` expression used to specify the schedule. For more information, see\n[Time-Based Schedules for\nJobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) in the *AWS Glue Developer Guide*. For\nexample, to run something every day at 12:15 UTC, specify `cron(15 12 * * ?\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-schedule", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to use with this trigger.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-tags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the trigger.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Predicate": { "MarkdownDocumentation": "`Predicate`\n\nThe predicate of this trigger, which defines when it will fire.\n*Required*: No\n*Type*: [Predicate](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-predicate", "UpdateType": "Mutable", "Required": false, "Type": "Predicate" } } }, "AWS::Glue::UsageProfile": { "MarkdownDocumentation": "`AWS::Glue::UsageProfile`\n\nCreates an AWS Glue usage profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the usage profile.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\-\\:\\_]{1,64}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#cfn-glue-usageprofile-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nProperty description not available.\n*Required*: No\n*Type*: [ProfileConfiguration](./aws-properties-glue-usageprofile-profileconfiguration.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#cfn-glue-usageprofile-configuration", "UpdateType": "Mutable", "Required": false, "Type": "ProfileConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-glue-usageprofile-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#cfn-glue-usageprofile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the usage profile.\n*Required*: Yes\n*Type*: String\n*Minimum*: `5`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#cfn-glue-usageprofile-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedOn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedOn`\n\nThe date and time when the usage profile was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#CreatedOn-fn::getatt" } } }, "AWS::Glue::Workflow": { "MarkdownDocumentation": "`AWS::Glue::Workflow`\n\nThe `AWS::Glue::Workflow` is an AWS Glue resource type that manages AWS Glue workflows. A workflow is a container for a set of related jobs, crawlers, and triggers in AWS Glue. Using a workflow, you can design a complex multi-job extract, transform, and load (ETL) activity that AWS Glue can execute and track as single entity.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the workflow name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html", "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DefaultRunProperties": { "Required": false, "MarkdownDocumentation": "`DefaultRunProperties`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-defaultrunproperties", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags to use with this workflow.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-name", "PrimitiveType": "String", "UpdateType": "Immutable" }, "MaxConcurrentRuns": { "Required": false, "MarkdownDocumentation": "`MaxConcurrentRuns`\n\nYou 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-maxconcurrentruns", "PrimitiveType": "Integer", "UpdateType": "Mutable" } } }, "AWS::Grafana::Workspace": { "MarkdownDocumentation": "`AWS::Grafana::Workspace`\n\nSpecifies a *workspace*. In a workspace, you can create Grafana\ndashboards and visualizations to analyze your metrics, logs, and traces. You don't have to\nbuild, package, or deploy any hardware to run the Grafana server.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"Id\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html", "Properties": { "NotificationDestinations": { "MarkdownDocumentation": "`NotificationDestinations`\n\nThe AWS notification channels that Amazon Managed Grafana can automatically\ncreate IAM roles and permissions for, to allow Amazon Managed Grafana to use\nthese channels.\n*AllowedValues*: `SNS`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-notificationdestinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PluginAdminEnabled": { "MarkdownDocumentation": "`PluginAdminEnabled`\n\nWhether plugin administration is enabled in the workspace. Setting to `true`\nallows workspace admins to install, uninstall, and update plugins from within the Grafana\nworkspace.\n###### Note\nThis option is only valid for workspaces that support Grafana version 9 or\nnewer.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-pluginadminenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PermissionType": { "MarkdownDocumentation": "`PermissionType`\n\nIf this is `SERVICE_MANAGED`, and the workplace was created through the\nAmazon Managed Grafana console, then Amazon Managed Grafana automatically creates the\nIAM roles and provisions the permissions that the workspace needs to\nuse AWS data sources and notification channels.\nIf this is `CUSTOMER_MANAGED`, you must manage those roles and permissions\nyourself.\nIf you are working with a workspace in a member account of an organization and\nthat account is not a delegated administrator account, and you want the workspace to\naccess data sources in other AWS accounts in the organization, this\nparameter must be set to `CUSTOMER_MANAGED`.\nFor more information about converting between customer and service managed, see\n[Managing permissions for data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html). For more\ninformation about the roles and permissions that must be managed for customer managed\nworkspaces, see [Amazon Managed Grafana\npermissions and policies for AWS data sources and notification\nchannels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html)\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CUSTOMER_MANAGED | SERVICE_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER_MANAGED", "SERVICE_MANAGED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-permissiontype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AccountAccessType": { "MarkdownDocumentation": "`AccountAccessType`\n\nSpecifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in\nother accounts in the same organization. If this is `ORGANIZATION`, the\n`OrganizationalUnits` parameter specifies which organizational units\nthe workspace can access.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CURRENT_ACCOUNT | ORGANIZAT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CURRENT_ACCOUNT", "ORGANIZATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-accountaccesstype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StackSetName": { "MarkdownDocumentation": "`StackSetName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-stacksetname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SamlConfiguration": { "MarkdownDocumentation": "`SamlConfiguration`\n\nIf the workspace uses SAML, use this structure to map SAML assertion attributes to\nworkspace user information and define which groups in the assertion attribute are to\nhave the `Admin` and `Editor` roles in the workspace.\n*Required*: No\n*Type*: [SamlConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-samlconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SamlConfiguration" }, "OrganizationalUnits": { "MarkdownDocumentation": "`OrganizationalUnits`\n\nSpecifies the organizational units that this workspace is allowed to use data sources\nfrom, if this workspace is in an account that is part of an organization.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-organizationalunits", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role that grants permissions to the AWS\nresources 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GrafanaVersion": { "MarkdownDocumentation": "`GrafanaVersion`\n\nSpecifies the version of Grafana to support in the workspace. Defaults to\nthe latest version on create (for example, 9.4), or the current version of the\nworkspace on update.\nCan only be used to upgrade (for example, from 8.4 to 9.4), not\ndowngrade (for example, from 9.4 to 8.4).\nTo know what versions are available to upgrade to for a specific workspace, see\nthe [ListVersions](https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html) operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-grafanaversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSources": { "MarkdownDocumentation": "`DataSources`\n\nSpecifies the AWS data sources that have been configured to have\nIAM roles and permissions created to allow Amazon Managed Grafana to read\ndata from these sources.\nThis list is only used when the workspace was created through the AWS\nconsole, and the `permissionType` is `SERVICE_MANAGED`.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-datasources", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AuthenticationProviders": { "MarkdownDocumentation": "`AuthenticationProviders`\n\nSpecifies whether this workspace uses SAML 2.0, AWS IAM Identity Center, or both to\nauthenticate users for using the Grafana console within a workspace. For more\ninformation, see [User authentication in\nAmazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html).\n*Allowed Values*: `AWS_SSO | SAML`\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-authenticationproviders", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "OrganizationRoleName": { "MarkdownDocumentation": "`OrganizationRoleName`\n\nThe name of the IAM role that is used to access resources through\nOrganizations.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-organizationrolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nThe configuration settings for an Amazon VPC that contains data sources for\nyour Grafana workspace to connect to.\n###### Note\nConnecting to a private VPC is not yet available in the Asia Pacific (Seoul)\nRegion (ap-northeast-2).\n*Required*: No\n*Type*: [VpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-vpcconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfiguration" }, "NetworkAccessControl": { "MarkdownDocumentation": "`NetworkAccessControl`\n\nThe configuration settings for network access to your workspace.\n*Required*: No\n*Type*: [NetworkAccessControl](./aws-properties-grafana-workspace-networkaccesscontrol.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-networkaccesscontrol", "UpdateType": "Mutable", "Required": false, "Type": "NetworkAccessControl" }, "ClientToken": { "MarkdownDocumentation": "`ClientToken`\n\nA unique, case-sensitive, user-provided identifier to ensure the idempotency of the\nrequest.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-clienttoken", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the workspace.\nValid values: `ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING |\nDELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED |\nLICENSE_REMOVAL_FAILED`\nType: String\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#Status-fn::getatt" }, "GrafanaVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`GrafanaVersion`\n\nSpecifies the version of Grafana supported by this workspace.\nType: String\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#GrafanaVersion-fn::getatt" }, "CreationTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTimestamp`\n\nThe date that the workspace was created.\nType: Timestamp\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#CreationTimestamp-fn::getatt" }, "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe URL that users can use to access the Grafana console in the workspace.\nType: String\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#Endpoint-fn::getatt" }, "SsoClientId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SsoClientId`\n\nThe ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.\nType: String\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#SsoClientId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique ID of this workspace.\nType: String\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#Id-fn::getatt" }, "SamlConfigurationStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`SamlConfigurationStatus`\n\nSpecifies whether the workspace's SAML configuration is complete.\nValid values: `CONFIGURED | NOT_CONFIGURED`\nType: String\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#SamlConfigurationStatus-fn::getatt" }, "ModificationTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModificationTimestamp`\n\nThe most recent date that the workspace was modified.\nType: Timestamp\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#ModificationTimestamp-fn::getatt" } } }, "AWS::Greengrass::ConnectorDefinition": { "MarkdownDocumentation": "`AWS::Greengrass::ConnectorDefinition`\n\nThe `AWS::Greengrass::ConnectorDefinition` resource represents a connector\ndefinition for AWS IoT Greengrass. Connector definitions are used to organize your\nconnector definition versions.\nConnector definitions can reference multiple connector definition versions. All\nconnector definition versions must be associated with a connector definition. Each\nconnector definition version can contain one or more connectors.\n###### Note\nWhen you create a connector definition, you can optionally include an initial\nconnector definition version. To associate a connector definition version later, create\nan [`AWS::Greengrass::ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource and\nspecify the ID of this connector definition.\nAfter you create the connector definition version that contains the connectors you\nwant to deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the connector definition, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html", "Attributes": { "LatestVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionArn`\n\nThe ARN of the last `ConnectorDefinitionVersion` that was added to the\n`ConnectorDefinition`, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#LatestVersionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the `ConnectorDefinition`, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `ConnectorDefinition`, such as\n`arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the `ConnectorDefinition`, such as\n`MyConnectorDefinition`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#Name-fn::getatt" } }, "Properties": { "InitialVersion": { "Type": "ConnectorDefinitionVersion", "Required": false, "MarkdownDocumentation": "`InitialVersion`\n\nThe connector definition version to include when the connector definition is created. A\nconnector definition version contains a list of [`connector`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html) property types.\n###### Note\nTo associate a connector definition version after the connector definition is\ncreated, create an [`AWS::Greengrass::ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource and\nspecify the ID of this connector definition.\n*Required*: No\n*Type*: [ConnectorDefinitionVersion](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-initialversion", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the connector definition. You can use tags in\nIAM policies to control access to AWS IoT Greengrass resources. You\ncan also use tags to categorize your resources. For more information, see [Tagging Your\nAWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses\nthe following format, which is different from most `Tags` implementations in\nCloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Greengrass::ConnectorDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::ConnectorDefinitionVersion`\n\nThe `AWS::Greengrass::ConnectorDefinitionVersion` resource represents a\nconnector definition version for AWS IoT Greengrass. A connector definition version\ncontains a list of connectors.\n###### Note\nTo create a connector definition version, you must specify the ID of the connector\ndefinition that you want to associate with the version. For information about creating a\nconnector definition, see [`AWS::Greengrass::ConnectorDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html).\nAfter you create a connector definition version that contains the connectors you want\nto deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the connector definition\nversion, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html", "Properties": { "Connectors": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Connectors`\n\nThe connectors in this version. Only one instance of a given connector can be added to\nthe connector definition version at a time.\n*Required*: Yes\n*Type*: Array of [Connector](./aws-properties-greengrass-connectordefinitionversion-connector.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html#cfn-greengrass-connectordefinitionversion-connectors", "ItemType": "Connector", "UpdateType": "Immutable" }, "ConnectorDefinitionId": { "Required": true, "MarkdownDocumentation": "`ConnectorDefinitionId`\n\nThe ID of the connector definition associated with this version. This value is a\nGUID.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html#cfn-greengrass-connectordefinitionversion-connectordefinitionid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::CoreDefinition": { "MarkdownDocumentation": "`AWS::Greengrass::CoreDefinition`\n\nThe `AWS::Greengrass::CoreDefinition` resource represents a core definition\nfor AWS IoT Greengrass. Core definitions are used to organize your core definition\nversions.\nCore definitions can reference multiple core definition versions. All core definition\nversions must be associated with a core definition. Each core definition version can\ncontain one Greengrass core.\n###### Note\nWhen you create a core definition, you can optionally include an initial core\ndefinition version. To associate a core definition version later, create an [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html) resource and specify\nthe ID of this core definition.\nAfter you create the core definition version that contains the core you want to\ndeploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the core definition, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html", "Attributes": { "LatestVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionArn`\n\nThe ARN of the last `CoreDefinitionVersion` that was added to the\n`CoreDefinition`, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#LatestVersionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the `CoreDefinition`, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `CoreDefinition`, such as\n`arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the `CoreDefinition`, such as `MyCoreDefinition`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#Name-fn::getatt" } }, "Properties": { "InitialVersion": { "Type": "CoreDefinitionVersion", "Required": false, "MarkdownDocumentation": "`InitialVersion`\n\nThe core definition version to include when the core definition is created. Currently, a\ncore definition version can contain only one [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html).\n###### Note\nTo associate a core definition version after the core definition is created, create\nan [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html) resource and specify\nthe ID of this core definition.\n*Required*: No\n*Type*: [CoreDefinitionVersion](./aws-properties-greengrass-coredefinition-coredefinitionversion.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-initialversion", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the core definition. You can use tags in\nIAM policies to control access to AWS IoT Greengrass resources. You\ncan also use tags to categorize your resources. For more information, see [Tagging Your\nAWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses\nthe following format, which is different from most `Tags` implementations in\nCloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the core 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Greengrass::CoreDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::CoreDefinitionVersion`\n\nThe `AWS::Greengrass::CoreDefinitionVersion` resource represents a core\ndefinition version for AWS IoT Greengrass. A core definition version contains a Greengrass\ncore.\n###### Note\nTo create a core definition version, you must specify the ID of the core definition\nthat you want to associate with the version. For information about creating a core\ndefinition, see [`AWS::Greengrass::CoreDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html).\nAfter you create a core definition version that contains the core you want to deploy,\nyou must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the core definition version,\nsuch as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html", "Properties": { "Cores": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Cores`\n\nThe Greengrass core in this version. Currently, the `Cores` property for a\ncore definition version can contain only one core.\n*Required*: Yes\n*Type*: Array of [Core](./aws-properties-greengrass-coredefinitionversion-core.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html#cfn-greengrass-coredefinitionversion-cores", "ItemType": "Core", "UpdateType": "Immutable" }, "CoreDefinitionId": { "Required": true, "MarkdownDocumentation": "`CoreDefinitionId`\n\nThe ID of the core definition associated with this version. This value is a GUID.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html#cfn-greengrass-coredefinitionversion-coredefinitionid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::DeviceDefinition": { "MarkdownDocumentation": "`AWS::Greengrass::DeviceDefinition`\n\nThe `AWS::Greengrass::DeviceDefinition` resource represents a device\ndefinition for AWS IoT Greengrass. Device definitions are used to organize your device\ndefinition versions.\nDevice definitions can reference multiple device definition versions. All device\ndefinition versions must be associated with a device definition. Each device definition\nversion can contain one or more devices.\n###### Note\nWhen you create a device definition, you can optionally include an initial device\ndefinition version. To associate a device definition version later, create an [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html) resource and\nspecify the ID of this device definition.\nAfter you create the device definition version that contains the devices you want to\ndeploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the device definition, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html", "Attributes": { "LatestVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionArn`\n\nThe ARN of the last `DeviceDefinitionVersion` that was added to the\n`DeviceDefinition`, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#LatestVersionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the `DeviceDefinition`, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `DeviceDefinition`, such as\n`arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the device definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#Name-fn::getatt" } }, "Properties": { "InitialVersion": { "Type": "DeviceDefinitionVersion", "Required": false, "MarkdownDocumentation": "`InitialVersion`\n\nThe device definition version to include when the device definition is created. A device\ndefinition version contains a list of [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html) property types.\n###### Note\nTo associate a device definition version after the device definition is created,\ncreate an [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html) resource and\nspecify the ID of this device definition.\n*Required*: No\n*Type*: [DeviceDefinitionVersion](./aws-properties-greengrass-devicedefinition-devicedefinitionversion.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-initialversion", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the device definition. You can use tags in\nIAM policies to control access to AWS IoT Greengrass resources. You\ncan also use tags to categorize your resources. For more information, see [Tagging Your\nAWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses\nthe following format, which is different from most `Tags` implementations in\nCloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the device 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Greengrass::DeviceDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::DeviceDefinitionVersion`\n\nThe `AWS::Greengrass::DeviceDefinitionVersion` resource represents a device\ndefinition version for AWS IoT Greengrass. A device definition version contains a list of\ndevices.\n###### Note\nTo create a device definition version, you must specify the ID of the device\ndefinition that you want to associate with the version. For information about creating a\ndevice definition, see [`AWS::Greengrass::DeviceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html).\nAfter you create a device definition version that contains the devices you want to\ndeploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the device definition\nversion, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html", "Properties": { "DeviceDefinitionId": { "Required": true, "MarkdownDocumentation": "`DeviceDefinitionId`\n\nThe ID of the device definition associated with this version. This value is a\nGUID.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html#cfn-greengrass-devicedefinitionversion-devicedefinitionid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Devices": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Devices`\n\nThe devices in this version.\n*Required*: Yes\n*Type*: Array of [Device](./aws-properties-greengrass-devicedefinitionversion-device.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html#cfn-greengrass-devicedefinitionversion-devices", "ItemType": "Device", "UpdateType": "Immutable" } } }, "AWS::Greengrass::FunctionDefinition": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinition`\n\nThe `AWS::Greengrass::FunctionDefinition` resource represents a function\ndefinition for AWS IoT Greengrass. Function definitions are used to organize your function\ndefinition versions.\nFunction definitions can reference multiple function definition versions. All function\ndefinition versions must be associated with a function definition. Each function definition\nversion can contain one or more functions.\n###### Note\nWhen you create a function definition, you can optionally include an initial function\ndefinition version. To associate a function definition version later, create an [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource and\nspecify the ID of this function definition.\nAfter you create the function definition version that contains the functions you want\nto deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the function definition, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html", "Attributes": { "LatestVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionArn`\n\nThe ARN of the last `FunctionDefinitionVersion` that was added to the\n`FunctionDefinition`, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#LatestVersionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the `FunctionDefinition`, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `FunctionDefinition`, such as\n`arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the `FunctionDefinition`, such as\n`MyFunctionDefinition`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#Name-fn::getatt" } }, "Properties": { "InitialVersion": { "Type": "FunctionDefinitionVersion", "Required": false, "MarkdownDocumentation": "`InitialVersion`\n\nThe function definition version to include when the function definition is created. A\nfunction definition version contains a list of [`function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html) property types.\n###### Note\nTo associate a function definition version after the function definition is created,\ncreate an [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource and\nspecify the ID of this function definition.\n*Required*: No\n*Type*: [FunctionDefinitionVersion](./aws-properties-greengrass-functiondefinition-functiondefinitionversion.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-initialversion", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the function definition. You can use tags in\nIAM policies to control access to AWS IoT Greengrass resources. You\ncan also use tags to categorize your resources. For more information, see [Tagging Your\nAWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses\nthe following format, which is different from most `Tags` implementations in\nCloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the function 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Greengrass::FunctionDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::FunctionDefinitionVersion`\n\nThe `AWS::Greengrass::FunctionDefinitionVersion` resource represents a\nfunction definition version for AWS IoT Greengrass. A function definition version contains\ncontain a list of functions.\n###### Note\nTo create a function definition version, you must specify the ID of the function\ndefinition that you want to associate with the version. For information about creating a\nfunction definition, see [`AWS::Greengrass::FunctionDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html).\nAfter you create a function definition version that contains the functions you want\nto deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the function definition\nversion, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html", "Properties": { "DefaultConfig": { "Type": "DefaultConfig", "Required": false, "MarkdownDocumentation": "`DefaultConfig`\n\nThe default configuration that applies to all Lambda functions in the\ngroup. Individual Lambda functions can override these settings.\n*Required*: No\n*Type*: [DefaultConfig](./aws-properties-greengrass-functiondefinitionversion-defaultconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-defaultconfig", "UpdateType": "Immutable" }, "Functions": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Functions`\n\nThe functions in this version.\n*Required*: Yes\n*Type*: Array of [Function](./aws-properties-greengrass-functiondefinitionversion-function.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-functions", "ItemType": "Function", "UpdateType": "Immutable" }, "FunctionDefinitionId": { "Required": true, "MarkdownDocumentation": "`FunctionDefinitionId`\n\nThe ID of the function definition associated with this version. This value is a\nGUID.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-functiondefinitionid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::Group": { "MarkdownDocumentation": "`AWS::Greengrass::Group`\n\nAWS IoT Greengrass seamlessly extends AWS to edge devices so they can\nact locally on the data they generate, while still using the cloud for management,\nanalytics, and durable storage. With AWS IoT Greengrass, connected devices can run AWS Lambda functions, execute predictions based on machine learning models, keep\ndevice data in sync, and communicate with other devices securely \u2013 even when not connected\nto the internet. For more information, see the [AWS IoT Greengrass Version 1 Developer Guide](https://docs.aws.amazon.com/greengrass/v1/developerguide/what-is-gg.html).\n###### Note\nFor AWS Region support, see [CloudFormation Support for AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThe `AWS::Greengrass::Group` resource represents a group in AWS IoT Greengrass. In the AWS IoT Greengrass API, groups are used to organize your group versions.\nGroups can reference multiple group versions. All group versions must be associated with\na group. A group version references a device definition version, subscription definition\nversion, and other version types that contain the components you want to deploy to a\nGreengrass core device.\nTo deploy a group version, the group version must reference a core definition version\nthat contains one core. Other version types are optionally included, depending on your\nbusiness need.\n###### Note\nWhen you create a group, you can optionally include an initial group version. To\nassociate a group version later, create a [`AWS::Greengrass::GroupVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html) resource and specify the ID of\nthis group.\nTo change group components (such as devices, subscriptions, or functions), you must\ncreate new versions. This is because versions are immutable. For example, to add a\nfunction, you create a function definition version that contains the new function (and\nall other functions that you want to deploy). Then you create a group version that\nreferences the new function definition version (and all other version types that you\nwant to deploy).\n**Deploying a Group Version**\nAfter you create the group version in your CloudFormation template, you can deploy\nit using the [**aws greengrass\ncreate-deployment**](https://docs.aws.amazon.com/greengrass/v1/apireference/createdeployment-post.html) command in the AWS CLI or from the\n**Greengrass** node in the AWS IoT console. To deploy a\ngroup version, you must have a Greengrass service role associated with your AWS account. For more information, see [CloudFormation\nSupport for AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the group, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html", "Attributes": { "RoleAttachedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoleAttachedAt`\n\nThe time (in milliseconds since the epoch) when the group role was attached to the\n`Group`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#RoleAttachedAt-fn::getatt" }, "LatestVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionArn`\n\nThe ARN of the last `GroupVersion` that was added to the `Group`,\nsuch as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#LatestVersionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the `Group`, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the `Group`, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#Arn-fn::getatt" }, "RoleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that's attached to the `Group`, such\nas `arn:aws:iam::123456789012:role/role-name`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#RoleArn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the `Group`, such as `MyGroup`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#Name-fn::getatt" } }, "Properties": { "InitialVersion": { "Type": "GroupVersion", "Required": false, "MarkdownDocumentation": "`InitialVersion`\n\nThe group version to include when the group is created. A group version references the\nAmazon Resource Name (ARN) of a core definition version, device definition version,\nsubscription definition version, and other version types. The group version must reference\na core definition version that contains one core. Other version types are optionally\nincluded, depending on your business need.\n###### Note\nTo associate a group version after the group is created, create an [`AWS::Greengrass::GroupVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html) resource and specify the ID of\nthis group.\n*Required*: No\n*Type*: [GroupVersion](./aws-properties-greengrass-group-groupversion.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-initialversion", "UpdateType": "Immutable" }, "RoleArn": { "Required": false, "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role attached to the group.\nThis role contains the permissions that Lambda functions and connectors use\nto interact with other AWS services.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the group. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also\nuse tags to categorize your resources. For more information, see [Tagging Your\nAWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses\nthe following format, which is different from most `Tags` implementations in\nCloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Greengrass::GroupVersion": { "MarkdownDocumentation": "`AWS::Greengrass::GroupVersion`\n\nThe `AWS::Greengrass::GroupVersion` resource represents a group version in\nAWS IoT Greengrass. A group version references a core definition version, device\ndefinition version, subscription definition version, and other version types that contain\nthe components you want to deploy to a Greengrass core device. The group version must\nreference a core definition version that contains one core. Other version types are\noptionally included, depending on your business need.\n###### Note\nTo create a group version, you must specify the ID of the group that you want to\nassociate with the version. For information about creating a group, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the group version, such as\n`arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html", "Properties": { "LoggerDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`LoggerDefinitionVersionArn`\n\nThe ARN of the logger definition version that contains the loggers you want to deploy\nwith the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-loggerdefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DeviceDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`DeviceDefinitionVersionArn`\n\nThe ARN of the device definition version that contains the devices you want to deploy\nwith the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-devicedefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "FunctionDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`FunctionDefinitionVersionArn`\n\nThe ARN of the function definition version that contains the functions you want to\ndeploy with the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-functiondefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CoreDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`CoreDefinitionVersionArn`\n\nThe ARN of the core definition version that contains the core you want to deploy with\nthe group version. Currently, the core definition version can contain only one 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-coredefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ResourceDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`ResourceDefinitionVersionArn`\n\nThe ARN of the resource definition version that contains the resources you want to\ndeploy with the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-resourcedefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ConnectorDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`ConnectorDefinitionVersionArn`\n\nThe Amazon Resource Name (ARN) of the connector definition version that contains the\nconnectors you want to deploy with the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-connectordefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SubscriptionDefinitionVersionArn": { "Required": false, "MarkdownDocumentation": "`SubscriptionDefinitionVersionArn`\n\nThe ARN of the subscription definition version that contains the subscriptions you want\nto deploy with the group 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-subscriptiondefinitionversionarn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GroupId": { "Required": true, "MarkdownDocumentation": "`GroupId`\n\nThe ID of the group associated with this version. This value is a GUID.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html#cfn-greengrass-groupversion-groupid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::LoggerDefinition": { "MarkdownDocumentation": "`AWS::Greengrass::LoggerDefinition`\n\nThe `AWS::Greengrass::LoggerDefinition` resource represents a logger\ndefinition for AWS IoT Greengrass. Logger definitions are used to organize your logger\ndefinition versions.\nLogger definitions can reference multiple logger definition versions. All logger\ndefinition versions must be associated with a logger definition. Each logger definition\nversion can contain one or more loggers.\n###### Note\nWhen you create a logger definition, you can optionally include an initial logger\ndefinition version. To associate a logger definition version later, create an [`AWS::Greengrass::LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html) resource and\nspecify the ID of this logger definition.\nAfter you create the logger definition version that contains the loggers you want to\ndeploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the logger definition, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html", "Attributes": { "LatestVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionArn`\n\nThe ARN of the last `LoggerDefinitionVersion` that was added to the\n`LoggerDefinition`, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/loggers/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#LatestVersionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the `LoggerDefinition`, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `LoggerDefinition`, such as\n`arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/loggers/1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the `LoggerDefinition`, such as `MyLoggerDefinition`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#Name-fn::getatt" } }, "Properties": { "InitialVersion": { "Type": "LoggerDefinitionVersion", "Required": false, "MarkdownDocumentation": "`InitialVersion`\n\nThe logger definition version to include when the logger definition is created. A logger\ndefinition version contains a list of [`logger`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html) property types.\n###### Note\nTo associate a logger definition version after the logger definition is created,\ncreate an [`AWS::Greengrass::LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html) resource and specify the ID of this logger definition.\n*Required*: No\n*Type*: [LoggerDefinitionVersion](./aws-properties-greengrass-loggerdefinition-loggerdefinitionversion.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-initialversion", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the logger definition. You can use tags in\nIAM policies to control access to AWS IoT Greengrass resources. You\ncan also use tags to categorize your resources. For more information, see [Tagging Your\nAWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses\nthe following format, which is different from most `Tags` implementations in\nCloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the logger 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html#cfn-greengrass-loggerdefinition-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Greengrass::LoggerDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::LoggerDefinitionVersion`\n\nThe `AWS::Greengrass::LoggerDefinitionVersion` resource represents a logger\ndefinition version for AWS IoT Greengrass. A logger definition version contains a list of\nloggers.\n###### Note\nTo create a logger definition version, you must specify the ID of the logger\ndefinition that you want to associate with the version. For information about creating a\nlogger definition, see [`AWS::Greengrass::LoggerDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinition.html).\nAfter you create a logger definition version that contains the loggers you want to\ndeploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the logger definition\nversion, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/loggers/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html", "Properties": { "LoggerDefinitionId": { "Required": true, "MarkdownDocumentation": "`LoggerDefinitionId`\n\nThe ID of the logger definition associated with this version. This value is a\nGUID.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html#cfn-greengrass-loggerdefinitionversion-loggerdefinitionid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Loggers": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Loggers`\n\nThe loggers in this version.\n*Required*: Yes\n*Type*: Array of [Logger](./aws-properties-greengrass-loggerdefinitionversion-logger.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html#cfn-greengrass-loggerdefinitionversion-loggers", "ItemType": "Logger", "UpdateType": "Immutable" } } }, "AWS::Greengrass::ResourceDefinition": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinition`\n\nThe `AWS::Greengrass::ResourceDefinition` resource represents a resource\ndefinition for AWS IoT Greengrass. Resource definitions are used to organize your resource\ndefinition versions.\nResource definitions can reference multiple resource definition versions. All resource\ndefinition versions must be associated with a resource definition. Each resource definition\nversion can contain one or more resources. (In CloudFormation, resources are named\n*resource instances*.)\n###### Note\nWhen you create a resource definition, you can optionally include an initial resource\ndefinition version. To associate a resource definition version later, create an [`AWS::Greengrass::ResourceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html) resource and\nspecify the ID of this resource definition.\nAfter you create the resource definition version that contains the resources you want\nto deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the resource definition, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html", "Attributes": { "LatestVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionArn`\n\nThe ARN of the last `ResourceDefinitionVersion` that was added to the\n`ResourceDefinition`, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#LatestVersionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the `ResourceDefinition`, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `ResourceDefinition`, such as\n`arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the `ResourceDefinition`, such as\n`MyResourceDefinition`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#Name-fn::getatt" } }, "Properties": { "InitialVersion": { "Type": "ResourceDefinitionVersion", "Required": false, "MarkdownDocumentation": "`InitialVersion`\n\nThe resource definition version to include when the resource definition is created. A\nresource definition version contains a list of [`resource instance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html) property types.\n###### Note\nTo associate a resource definition version after the resource definition is created,\ncreate an [`AWS::Greengrass::ResourceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html) resource and\nspecify the ID of this resource definition.\n*Required*: No\n*Type*: [ResourceDefinitionVersion](./aws-properties-greengrass-resourcedefinition-resourcedefinitionversion.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-initialversion", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the resource definition. You can use tags in\nIAM policies to control access to AWS IoT Greengrass resources. You\ncan also use tags to categorize your resources. For more information, see [Tagging Your\nAWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses\nthe following format, which is different from most `Tags` implementations in\nCloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the resource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Greengrass::ResourceDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::ResourceDefinitionVersion`\n\nThe `AWS::Greengrass::ResourceDefinitionVersion` resource represents a\nresource definition version for AWS IoT Greengrass. A resource definition version contains\na list of resources. (In CloudFormation, resources are named *resource\ninstances*.)\n###### Note\nTo create a resource definition version, you must specify the ID of the resource\ndefinition that you want to associate with the version. For information about creating a\nresource definition, see [`AWS::Greengrass::ResourceDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html).\nAfter you create a resource definition version that contains the resources you want\nto deploy, you must add it to your group version. For more information, see [`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the resource definition\nversion, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html", "Properties": { "Resources": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Resources`\n\nThe resources in this version.\n*Required*: Yes\n*Type*: Array of [ResourceInstance](./aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html#cfn-greengrass-resourcedefinitionversion-resources", "ItemType": "ResourceInstance", "UpdateType": "Immutable" }, "ResourceDefinitionId": { "Required": true, "MarkdownDocumentation": "`ResourceDefinitionId`\n\nThe ID of the resource definition associated with this version. This value is a\nGUID.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html#cfn-greengrass-resourcedefinitionversion-resourcedefinitionid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Greengrass::SubscriptionDefinition": { "MarkdownDocumentation": "`AWS::Greengrass::SubscriptionDefinition`\n\nThe `AWS::Greengrass::SubscriptionDefinition` resource represents a\nsubscription definition for AWS IoT Greengrass. Subscription definitions are used to\norganize your subscription definition versions.\nSubscription definitions can reference multiple subscription definition versions. All\nsubscription definition versions must be associated with a subscription definition. Each\nsubscription definition version can contain one or more subscriptions.\n###### Note\nWhen you create a subscription definition, you can optionally include an initial\nsubscription definition version. To associate a subscription definition version later,\ncreate an [`AWS::Greengrass::SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html) resource and\nspecify the ID of this subscription definition.\nAfter you create the subscription definition version that contains the subscriptions\nyou want to deploy, you must add it to your group version. For more information, see\n[`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the subscription definition, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html", "Attributes": { "LatestVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersionArn`\n\nThe ARN of the last `SubscriptionDefinitionVersion` that was added to the\n`SubscriptionDefinition`, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#LatestVersionArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the `SubscriptionDefinition`, such as\n`1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `SubscriptionDefinition`, such as\n`arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the `SubscriptionDefinition`, such as\n`MySubscriptionDefinition`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#Name-fn::getatt" } }, "Properties": { "InitialVersion": { "Type": "SubscriptionDefinitionVersion", "Required": false, "MarkdownDocumentation": "`InitialVersion`\n\nThe subscription definition version to include when the subscription definition is\ncreated. A subscription definition version contains a list of [`subscription`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html) property types.\n###### Note\nTo associate a subscription definition version after the subscription definition is\ncreated, create an [`AWS::Greengrass::SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html) resource and specify the ID of this subscription definition.\n*Required*: No\n*Type*: [SubscriptionDefinitionVersion](./aws-properties-greengrass-subscriptiondefinition-subscriptiondefinitionversion.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-initialversion", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the subscription definition. You can use tags\nin IAM policies to control access to AWS IoT Greengrass resources. You\ncan also use tags to categorize your resources. For more information, see [Tagging Your\nAWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *AWS IoT Greengrass Version 1 Developer Guide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses\nthe following format, which is different from most `Tags` implementations in\nCloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the subscription 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-name", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::Greengrass::SubscriptionDefinitionVersion": { "MarkdownDocumentation": "`AWS::Greengrass::SubscriptionDefinitionVersion`\n\nThe `AWS::Greengrass::SubscriptionDefinitionVersion` resource represents a\nsubscription definition version for AWS IoT Greengrass. A subscription definition version\ncontains a list of subscriptions.\n###### Note\nTo create a subscription definition version, you must specify the ID of the\nsubscription definition that you want to associate with the version. For information\nabout creating a subscription definition, see [`AWS::Greengrass::SubscriptionDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html).\nAfter you create a subscription definition version that contains the subscriptions\nyou want to deploy, you must add it to your group version. For more information, see\n[`AWS::Greengrass::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the subscription definition\nversion, such as `arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html", "Properties": { "SubscriptionDefinitionId": { "Required": true, "MarkdownDocumentation": "`SubscriptionDefinitionId`\n\nThe ID of the subscription definition associated with this version. This value is a\nGUID.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinitionversion-subscriptiondefinitionid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Subscriptions": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Subscriptions`\n\nThe subscriptions in this version.\n*Required*: Yes\n*Type*: Array of [Subscription](./aws-properties-greengrass-subscriptiondefinitionversion-subscription.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html#cfn-greengrass-subscriptiondefinitionversion-subscriptions", "ItemType": "Subscription", "UpdateType": "Immutable" } } }, "AWS::GreengrassV2::ComponentVersion": { "MarkdownDocumentation": "`AWS::GreengrassV2::ComponentVersion`\n\nCreates a component. Components are software that run on AWS IoT Greengrass core devices.\nAfter you develop and test a component on your core device, you can use this operation to\nupload your component to AWS IoT Greengrass. Then, you can deploy the component to other\ncore devices.\nYou can use this operation to do the following:\n* **Create components from recipes**\n \n Create a component from a recipe, which is a file that defines the component's\n metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For\n more information, see [AWS IoT Greengrass component recipe reference](https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) in the *AWS IoT Greengrass V2 Developer\n Guide*.\n \n To create a component from a recipe, specify `inlineRecipe` when you call\n this operation.\n* **Create components from Lambda\n functions**\n \n Create a component from an AWS Lambda function that runs on AWS IoT Greengrass. This creates a recipe and artifacts from the Lambda\n function's deployment package. You can use this operation to migrate Lambda\n functions from AWS IoT Greengrass V1 to AWS IoT Greengrass V2.\n \n This function accepts Lambda functions in all supported versions of\n Python, Node.js, and Java runtimes. AWS IoT Greengrass doesn't apply any additional\n restrictions on deprecated Lambda runtime versions.\n \n To create a component from a Lambda function, specify\n `lambdaFunction` when you call this operation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Arn`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html", "Properties": { "LambdaFunction": { "MarkdownDocumentation": "`LambdaFunction`\n\nThe parameters to create a component from a Lambda function.\nYou must specify either `InlineRecipe` or `LambdaFunction`.\n*Required*: No\n*Type*: [LambdaFunctionRecipeSource](./aws-properties-greengrassv2-componentversion-lambdafunctionrecipesource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#cfn-greengrassv2-componentversion-lambdafunction", "UpdateType": "Immutable", "Required": false, "Type": "LambdaFunctionRecipeSource" }, "InlineRecipe": { "MarkdownDocumentation": "`InlineRecipe`\n\nThe recipe to use to create the component. The recipe defines the component's metadata,\nparameters, dependencies, lifecycle, artifacts, and platform compatibility.\nYou must specify either `InlineRecipe` or `LambdaFunction`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#cfn-greengrassv2-componentversion-inlinerecipe", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nApplication-specific metadata to attach to the component version. You can use tags in\nIAM policies to control access to AWS IoT Greengrass resources. You can\nalso 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\nGuide*.\nThis `Json` property type is processed as a map of key-value pairs. It uses the\nfollowing format, which is different from most `Tags` implementations in CloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#cfn-greengrassv2-componentversion-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "ComponentName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ComponentName`\n\nThe name of the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#ComponentName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the component version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#Arn-fn::getatt" }, "ComponentVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`ComponentVersion`\n\nThe version of the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-componentversion.html#ComponentVersion-fn::getatt" } } }, "AWS::GreengrassV2::Deployment": { "MarkdownDocumentation": "`AWS::GreengrassV2::Deployment`\n\nCreates a continuous deployment for a target, which is a AWS IoT Greengrass core device\nor group of core devices. When you add a new core device to a group of core devices that has a\ndeployment, AWS IoT Greengrass deploys that group's deployment to the new device.\nYou can define one deployment for each target. When you create a new deployment for a\ntarget that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices.\nYou can only add, update, or delete up to 10 deployments at a time to a single\ntarget.\nEvery deployment has a revision number that indicates how many deployment revisions you\ndefine for a target. Use this operation to create a new revision of an existing deployment.\nThis operation returns the revision number of the new deployment when you create it.\nFor more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the\n*AWS IoT Greengrass V2 Developer Guide*.\n###### Important\nDeployment resources are deleted when you delete stacks. To keep the deployments in a\nstack, you must specify `\"DeletionPolicy\": \"Retain\"` on each deployment resource\nin the stack template that you want to keep. For more information, see [DeletionPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\nYou can only delete up to 10 deployment resources at a time. If you delete more than 10\nresources, you receive an error.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `DeploymentId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html", "Properties": { "Components": { "MarkdownDocumentation": "`Components`\n\nThe components to deploy. This is a dictionary, where each key is the name of a component,\nand each key's value is the version and configuration to deploy for that component.\n*Required*: No\n*Type*: Object of [ComponentDeploymentSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-components", "UpdateType": "Immutable", "Required": false, "Type": "Map", "ItemType": "ComponentDeploymentSpecification" }, "DeploymentName": { "MarkdownDocumentation": "`DeploymentName`\n\nThe name of the deployment.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IotJobConfiguration": { "MarkdownDocumentation": "`IotJobConfiguration`\n\nThe job configuration for the deployment configuration. The job configuration specifies\nthe rollout, timeout, and stop configurations for the deployment configuration.\n*Required*: No\n*Type*: [DeploymentIoTJobConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-iotjobconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "DeploymentIoTJobConfiguration" }, "DeploymentPolicies": { "MarkdownDocumentation": "`DeploymentPolicies`\n\nThe deployment policies for the deployment. These policies define how the deployment\nupdates components and handles failure.\n*Required*: No\n*Type*: [DeploymentPolicies](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentpolicies", "UpdateType": "Immutable", "Required": false, "Type": "DeploymentPolicies" }, "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe ARN of the target AWS IoT thing or thing group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-targetarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ParentTargetArn": { "MarkdownDocumentation": "`ParentTargetArn`\n\nThe parent deployment's [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for a subdeployment.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[^:]*:iot:[^:]*:[0-9]+:thinggroup/.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-parenttargetarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nApplication-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\ntags to categorize your resources. For more information, see [Tag your AWS IoT Greengrass Version 2\nresources](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\nfollowing format, which is different from most `Tags` implementations in CloudFormation templates.\n```\n\"Tags\": {\n \"KeyName0\": \"value\",\n \"KeyName1\": \"value\",\n \"KeyName2\": \"value\"\n}\n```\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "DeploymentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeploymentId`\n\nThe ID of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#DeploymentId-fn::getatt" } } }, "AWS::GroundStation::Config": { "MarkdownDocumentation": "`AWS::GroundStation::Config`\n\nCreates a `Config` with the specified parameters.\nConfig objects provide Ground Station with the details necessary in order to schedule and execute satellite contacts.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the config. For example:\n`{ \"Ref\": \"Config\" }`\nFor the Ground Station config, `Ref` returns the ARN of the config.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html", "Properties": { "ConfigData": { "MarkdownDocumentation": "`ConfigData`\n\nObject containing the parameters of a config.\nOnly one subtype may be specified per config.\nSee the subtype definitions for a description of each config subtype.\n*Required*: Yes\n*Type*: [ConfigData](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-configdata", "UpdateType": "Mutable", "Required": true, "Type": "ConfigData" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags assigned to a resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-groundstation-config-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the config object.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ a-zA-Z0-9_:-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nThe type of the config, such as\n`tracking`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#Type-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the config, such as\n`9940bf3b-d2ba-427e-9906-842b5e5d2296`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the config, such as\n`arn:aws:groundstation:us-east-2:1234567890:config/tracking/9940bf3b-d2ba-427e-9906-842b5e5d2296`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#Arn-fn::getatt" } } }, "AWS::GroundStation::DataflowEndpointGroup": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroup`\n\nCreates a Dataflow Endpoint Group request.\nDataflow endpoint groups contain a list of endpoints.\nWhen the name of a dataflow endpoint group is specified in a mission profile, the Ground Station service will connect to the endpoints and flow data during a contact.\nFor more information about dataflow endpoint groups, see [Dataflow Endpoint Groups](https://docs.aws.amazon.com/ground-station/latest/ug/dataflowendpointgroups.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the dataflow endpoint group. For example:\n`{ \"Ref\": \"DataflowEndpointGroup\" }`\nFor the Ground Station dataflow endpoint group, `Ref` returns the ARN of the dataflow endpoint group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html", "Properties": { "ContactPostPassDurationSeconds": { "MarkdownDocumentation": "`ContactPostPassDurationSeconds`\n\nAmount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a `POSTPASS` state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the `POSTPASS` state.\n*Required*: No\n*Type*: Integer\n*Minimum*: `30`\n*Maximum*: `480`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-contactpostpassdurationseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "EndpointDetails": { "MarkdownDocumentation": "`EndpointDetails`\n\nList of Endpoint Details, containing address and port for each endpoint.\nAll dataflow endpoints within a single dataflow endpoint group must be of the same type.\nYou cannot mix AWS Ground Station Agent endpoints with Dataflow endpoints in the same group.\nIf your use case requires both types of endpoints, you must create separate dataflow endpoint\ngroups for each type.\n*Required*: Yes\n*Type*: [Array](./aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html) of [EndpointDetails](./aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-endpointdetails", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "EndpointDetails", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags assigned to a resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-groundstation-dataflowendpointgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ContactPrePassDurationSeconds": { "MarkdownDocumentation": "`ContactPrePassDurationSeconds`\n\nAmount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a `PREPASS` state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the `PREPASS` state.\n*Required*: No\n*Type*: Integer\n*Minimum*: `30`\n*Maximum*: `480`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-contactprepassdurationseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nUUID of a dataflow endpoint group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the dataflow endpoint group, such as\n`arn:aws:groundstation:us-east-2:1234567890:dataflow-endpoint-group/9940bf3b-d2ba-427e-9906-842b5e5d2296`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#Arn-fn::getatt" } } }, "AWS::GroundStation::DataflowEndpointGroupV2": { "MarkdownDocumentation": "`AWS::GroundStation::DataflowEndpointGroupV2`\n\nCreates a `DataflowEndpoint` group containing the specified list of Ground Station Agent based endpoints.\nThe `name` field in each endpoint is used in your mission profile `DataflowEndpointConfig`\nto specify which endpoints to use during a contact.\nWhen a contact uses multiple `DataflowEndpointConfig` objects, each `Config`\nmust match a `DataflowEndpoint` in the same group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroupv2.html", "Properties": { "Endpoints": { "MarkdownDocumentation": "`Endpoints`\n\nList of endpoints for the dataflow endpoint group.\n*Required*: No\n*Type*: Array of [CreateEndpointDetails](./aws-properties-groundstation-dataflowendpointgroupv2-createendpointdetails.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroupv2.html#cfn-groundstation-dataflowendpointgroupv2-endpoints", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "CreateEndpointDetails", "DuplicatesAllowed": true }, "ContactPostPassDurationSeconds": { "MarkdownDocumentation": "`ContactPostPassDurationSeconds`\n\nAmount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state.\n*Required*: No\n*Type*: Integer\n*Minimum*: `30`\n*Maximum*: `480`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroupv2.html#cfn-groundstation-dataflowendpointgroupv2-contactpostpassdurationseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags assigned to a resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-groundstation-dataflowendpointgroupv2-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroupv2.html#cfn-groundstation-dataflowendpointgroupv2-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ContactPrePassDurationSeconds": { "MarkdownDocumentation": "`ContactPrePassDurationSeconds`\n\nAmount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state.\n*Required*: No\n*Type*: Integer\n*Minimum*: `30`\n*Maximum*: `480`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroupv2.html#cfn-groundstation-dataflowendpointgroupv2-contactprepassdurationseconds", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroupv2.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroupv2.html#Arn-fn::getatt" }, "EndpointDetails": { "Type": "List", "ItemType": "EndpointDetails", "MarkdownDocumentation": "`EndpointDetails`\n\nInformation about the endpoint details.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroupv2.html#EndpointDetails-fn::getatt" } } }, "AWS::GroundStation::MissionProfile": { "MarkdownDocumentation": "`AWS::GroundStation::MissionProfile`\n\nMission profiles specify parameters and provide references to config objects to define how Ground Station lists and executes contacts.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the mission profile. For example:\n`{ \"Ref\": \"MissionProfile\" }`\n`Ref` returns the ARN of the mission profile.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html", "Properties": { "StreamsKmsKey": { "MarkdownDocumentation": "`StreamsKmsKey`\n\nKMS key to use for encrypting streams.\n*Required*: No\n*Type*: [StreamsKmsKey](./aws-properties-groundstation-missionprofile-streamskmskey.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-streamskmskey", "UpdateType": "Mutable", "Required": false, "Type": "StreamsKmsKey" }, "ContactPostPassDurationSeconds": { "MarkdownDocumentation": "`ContactPostPassDurationSeconds`\n\nAmount of time in seconds after a contact ends that you\u2019d like to receive a Ground Station Contact State Change indicating the pass has finished.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `21600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-contactpostpassdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinimumViableContactDurationSeconds": { "MarkdownDocumentation": "`MinimumViableContactDurationSeconds`\n\nMinimum length of a contact in seconds that Ground Station will return when listing contacts.\nGround Station will not return contacts shorter than this duration.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `21600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-minimumviablecontactdurationseconds", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "DataflowEdges": { "MarkdownDocumentation": "`DataflowEdges`\n\nA list containing lists of config ARNs. Each list of config ARNs is an edge, with a \"from\" config and a \"to\" config.\n*Required*: Yes\n*Type*: Array of [DataflowEdge](./aws-properties-groundstation-missionprofile-dataflowedge.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-dataflowedges", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "DataflowEdge", "DuplicatesAllowed": true }, "StreamsKmsRole": { "MarkdownDocumentation": "`StreamsKmsRole`\n\nRole to use for encrypting streams with KMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-streamskmsrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrackingConfigArn": { "MarkdownDocumentation": "`TrackingConfigArn`\n\nThe ARN of a tracking config objects that defines how to track the satellite through the sky during a contact.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-trackingconfigarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags assigned to the mission profile.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-groundstation-missionprofile-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the mission profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[ a-zA-Z0-9_:-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContactPrePassDurationSeconds": { "MarkdownDocumentation": "`ContactPrePassDurationSeconds`\n\nAmount of time in seconds prior to contact start that you'd like to receive a Ground Station Contact State Change Event indicating an upcoming pass.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `21600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-contactprepassdurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Region": { "PrimitiveType": "String", "MarkdownDocumentation": "`Region`\n\nThe region of the mission profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#Region-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the mission profile, such as\n`9940bf3b-d2ba-427e-9906-842b5e5d2296`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the mission profile, such as\n`arn:aws:groundstation:us-east-2:1234567890:mission-profile/9940bf3b-d2ba-427e-9906-842b5e5d2296`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#Arn-fn::getatt" } } }, "AWS::GuardDuty::Detector": { "MarkdownDocumentation": "`AWS::GuardDuty::Detector`\n\nThe `AWS::GuardDuty::Detector` resource specifies a new GuardDuty\ndetector. A detector is an object that represents the GuardDuty service. A\ndetector is required for GuardDuty to become operational.\nMake sure you use either `DataSources` or `Features` in a one\nrequest, and not both.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique ID of the detector.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html", "Properties": { "FindingPublishingFrequency": { "MarkdownDocumentation": "`FindingPublishingFrequency`\n\nSpecifies how frequently updated findings are exported.\n*Required*: No\n*Type*: String\n*Allowed values*: `FIFTEEN_MINUTES | ONE_HOUR ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIFTEEN_MINUTES", "ONE_HOUR", "SIX_HOURS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-findingpublishingfrequency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSources": { "MarkdownDocumentation": "`DataSources`\n\nDescribes which data sources will be enabled for the detector.\n*Required*: No\n*Type*: [CFNDataSourceConfigurations](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-datasources", "UpdateType": "Mutable", "Required": false, "Type": "CFNDataSourceConfigurations" }, "Enable": { "MarkdownDocumentation": "`Enable`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-enable", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "Features": { "MarkdownDocumentation": "`Features`\n\nA list of features that will be configured for the detector.\n*Required*: No\n*Type*: Array of [CFNFeatureConfiguration](./aws-properties-guardduty-detector-cfnfeatureconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-features", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CFNFeatureConfiguration", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies tags added to a new detector resource. Each tag consists of a key and an\noptional value, both of which you define.\nCurrently, support is available only for creating and deleting a tag. No support exists\nfor updating the tags.\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [TagItem](./aws-properties-guardduty-detector-tagitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagItem", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique ID of the detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#Id-fn::getatt" } } }, "AWS::GuardDuty::Filter": { "MarkdownDocumentation": "`AWS::GuardDuty::Filter`\n\nThe `AWS::GuardDuty::Filter` resource specifies a new filter defined by the\nprovided `findingCriteria`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the filter, such as\n`SampleFilter`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nSpecifies the action that is to be applied to the findings that match the filter.\n*Required*: No\n*Type*: String\n*Allowed values*: `NOOP | ARCHIVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NOOP", "ARCHIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the filter. Valid characters include alphanumeric characters, and\nspecial characters such as hyphen, period, colon, underscore, parentheses (`{ }`,\n`[ ]`, and `( )`), forward slash, horizontal tab, vertical tab,\nnewline, form feed, return, and whitespace.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe detector ID associated with the GuardDuty account for which you want to create a filter.\nTo find the `detectorId` in the current Region, see the\nSettings page in the GuardDuty console, or run the [ListDetectors](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-detectorid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FindingCriteria": { "MarkdownDocumentation": "`FindingCriteria`\n\nRepresents the criteria to be used in the filter for querying findings.\n*Required*: Yes\n*Type*: [FindingCriteria](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-findingcriteria", "UpdateType": "Mutable", "Required": true, "Type": "FindingCriteria" }, "Rank": { "MarkdownDocumentation": "`Rank`\n\nSpecifies the position of the filter in the list of current filters. Also specifies the\norder in which this filter is applied to the findings. The minimum value for this property\nis 1 and the maximum is 100.\nBy default, filters may not be created in the same order as they are ranked. To ensure\nthat the filters are created in the expected order, you can use an optional attribute,\n[DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html),\nwith the following syntax: `\"DependsOn\":[ \"ObjectName\" ]`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-rank", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to be added to a new filter resource. Each tag consists of a key and an\noptional 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*: Array of [TagItem](./aws-properties-guardduty-filter-tagitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagItem", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the filter. Valid characters include period (.), underscore (\\_), dash (-), and\nalphanumeric characters. A whitespace is considered to be an invalid character.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::GuardDuty::IPSet": { "MarkdownDocumentation": "`AWS::GuardDuty::IPSet`\n\nThe `AWS::GuardDuty::IPSet` resource helps you create a list of trusted IP\naddresses that you can use for secure communication with AWS\ninfrastructure and applications. Once you activate this list, GuardDuty will not\ngenerate findings when there is an activity associated with these safe IP addresses.\nOnly the users of the GuardDuty administrator account can manage this list.\nThese settings are also applied to the member accounts.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique ID of the `IPSet`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe format of the file that contains the IPSet. For information about supported formats,\nsee [List formats](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#prepare_list) in the *Amazon GuardDuty User Guide*.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TXT | STIX | OTX_CSV | ALIE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TXT", "STIX", "OTX_CSV", "ALIEN_VAULT", "PROOF_POINT", "FIRE_EYE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-format", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Activate": { "MarkdownDocumentation": "`Activate`\n\nA boolean value that determines if GuardDuty can start using this list for\ncustom threat detection. For GuardDuty to prevent generating findings based on an\nactivity associated with these entries, this list must be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-activate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe unique ID of the detector of the GuardDuty account for which you want to create an IPSet.\nTo find the `detectorId` in the current Region, see the\nSettings page in the GuardDuty console, or run the [ListDetectors](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-detectorid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExpectedBucketOwner": { "MarkdownDocumentation": "`ExpectedBucketOwner`\n\nThe AWS account ID that owns the Amazon S3 bucket specified in\nthe *Location* field.\nWhen you provide this account ID, GuardDuty will validate that the S3 bucket\nbelongs to this account. If you don't specify an account ID owner, GuardDuty\ndoesn't perform any validation.\n*Required*: No\n*Type*: String\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-expectedbucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to be added to a new threat entity set resource. Each tag consists of a key and\nan 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*: Array of [TagItem](./aws-properties-guardduty-ipset-tagitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagItem", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe user-friendly name to identify the IPSet.\nThe name of your list must be unique within an AWS account and\nRegion. Valid 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#Id-fn::getatt" } } }, "AWS::GuardDuty::MalwareProtectionPlan": { "MarkdownDocumentation": "`AWS::GuardDuty::MalwareProtectionPlan`\n\nCreates a new Malware Protection plan for the protected resource.\nWhen you create a Malware Protection plan, the [AWS service terms for GuardDuty Malware Protection](https://aws.amazon.com/service-terms/#87._Amazon_GuardDuty) will\napply.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html", "Properties": { "Role": { "MarkdownDocumentation": "`Role`\n\nAmazon Resource Name (ARN) of the IAM role that includes the permissions\nrequired to scan and (optionally) add tags to the associated protected resource.\nTo find the ARN of your IAM role, go to the IAM console,\nand select the role name for details.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#cfn-guardduty-malwareprotectionplan-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProtectedResource": { "MarkdownDocumentation": "`ProtectedResource`\n\nInformation about the protected resource. Presently, `S3Bucket` is the only\nsupported protected resource.\n*Required*: Yes\n*Type*: [CFNProtectedResource](./aws-properties-guardduty-malwareprotectionplan-cfnprotectedresource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#cfn-guardduty-malwareprotectionplan-protectedresource", "UpdateType": "Mutable", "Required": true, "Type": "CFNProtectedResource" }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nSpecifies the action that is to be applied to the Malware Protection plan\nresource.\n*Required*: No\n*Type*: [CFNActions](./aws-properties-guardduty-malwareprotectionplan-cfnactions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#cfn-guardduty-malwareprotectionplan-actions", "UpdateType": "Mutable", "Required": false, "Type": "CFNActions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to be added to the created Malware Protection plan resource. Each tag consists\nof a key and an optional value, both of which you need to specify.\n*Required*: No\n*Type*: Array of [TagItem](./aws-properties-guardduty-malwareprotectionplan-tagitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#cfn-guardduty-malwareprotectionplan-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagItem", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nStatus of the Malware Protection plan resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#Status-fn::getatt" }, "StatusReasons": { "Type": "List", "ItemType": "CFNStatusReasons", "MarkdownDocumentation": "`StatusReasons`\n\nStatus details associated with the Malware Protection plan resource status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#StatusReasons-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the Malware Protection plan resource was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#CreatedAt-fn::getatt" }, "MalwareProtectionPlanId": { "PrimitiveType": "String", "MarkdownDocumentation": "`MalwareProtectionPlanId`\n\nA unique identifier associated with Malware Protection plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#MalwareProtectionPlanId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nAmazon Resource Name (ARN) associated with this Malware Protection plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html#Arn-fn::getatt" } } }, "AWS::GuardDuty::Master": { "MarkdownDocumentation": "`AWS::GuardDuty::Master`\n\nYou can use the `AWS::GuardDuty::Master` resource in a GuardDuty\nmember account to accept an invitation from a GuardDuty administrator account. The\ninvitation to the member account must be sent prior to using the\n`AWS::GuardDuty::Master` resource to accept the administrator account's\ninvitation. You can invite a member account by using the `InviteMembers`\noperation of the GuardDuty API, or by creating an\n`AWS::GuardDuty::Member` resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique ID of the GuardDuty administrator account,\nsuch as `111122223333`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html", "Properties": { "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe unique ID of the detector of the GuardDuty member account.\nTo find the `detectorId` in the current Region, see the\nSettings page in the GuardDuty console, or run the [ListDetectors](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-detectorid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MasterId": { "MarkdownDocumentation": "`MasterId`\n\nThe AWS account ID of the account designated as the GuardDuty\nadministrator 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-masterid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InvitationId": { "MarkdownDocumentation": "`InvitationId`\n\nThe ID of the invitation that is sent to the account designated as a member account. You\ncan find the invitation ID by running the [ListInvitations](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListInvitations.html) in\nthe *GuardDuty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-invitationid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GuardDuty::Member": { "MarkdownDocumentation": "`AWS::GuardDuty::Member`\n\nYou can use the `AWS::GuardDuty::Member` resource to add an AWS account as a GuardDuty member account to the current GuardDuty administrator account. If the value of the `Status` property is\nnot provided or is set to `Created`, a member account is created but not\ninvited. If the value of the `Status` property is set to `Invited`, a\nmember account is created and invited. An `AWS::GuardDuty::Member` resource must\nbe created with the `Status` property set to `Invited` before the\n`AWS::GuardDuty::Master` resource can be created in a GuardDuty\nmember account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique ID of the GuardDuty member account, such\nas `111122223333`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nYou can use the `Status` property to update the status of the relationship\nbetween the member account and its administrator account. Valid values are\n`Created` and `Invited` when using an\n`AWS::GuardDuty::Member` resource. If the value for this property is not\nprovided or set to `Created`, a member account is created but not invited. If\nthe value of this property is set to `Invited`, a member account is created and\ninvited.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MemberId": { "MarkdownDocumentation": "`MemberId`\n\nThe AWS account ID of the account to designate as a member.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-memberid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Email": { "MarkdownDocumentation": "`Email`\n\nThe email address associated with the member 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-email", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Message": { "MarkdownDocumentation": "`Message`\n\nThe invitation message that you want to send to the accounts that you're inviting to\nGuardDuty as members.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-message", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisableEmailNotification": { "MarkdownDocumentation": "`DisableEmailNotification`\n\nSpecifies whether or not to disable email notification for the member account that you\ninvite.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-disableemailnotification", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe ID of the detector associated with the GuardDuty service to add the member\nto.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-detectorid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::GuardDuty::PublishingDestination": { "MarkdownDocumentation": "`AWS::GuardDuty::PublishingDestination`\n\nCreates a publishing destination where you can export your GuardDuty findings. Before\nyou start exporting the findings, the destination resource must exist.\nFor more information about considerations and permissions, see [Exporting\nGuardDuty findings to Amazon S3 buckets](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_exportfindings.html) in the *Amazon GuardDuty User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource publishing destination ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html", "Properties": { "DestinationProperties": { "MarkdownDocumentation": "`DestinationProperties`\n\nContains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3\nbucket, and the ARN of the KMS key to use to encrypt published findings.\n*Required*: Yes\n*Type*: [CFNDestinationProperties](./aws-properties-guardduty-publishingdestination-cfndestinationproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html#cfn-guardduty-publishingdestination-destinationproperties", "UpdateType": "Mutable", "Required": true, "Type": "CFNDestinationProperties" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe ID of the GuardDuty detector where the publishing destination exists.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html#cfn-guardduty-publishingdestination-detectorid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DestinationType": { "MarkdownDocumentation": "`DestinationType`\n\nThe type of publishing destination. GuardDuty supports Amazon S3\nbuckets as a publishing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html#cfn-guardduty-publishingdestination-destinationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nDescribes a tag.\n*Required*: No\n*Type*: Array of [TagItem](./aws-properties-guardduty-publishingdestination-tagitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html#cfn-guardduty-publishingdestination-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagItem", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the publishing destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html#Status-fn::getatt" }, "PublishingFailureStartTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublishingFailureStartTimestamp`\n\nThe time, in epoch millisecond format, at which GuardDuty was first unable to publish\nfindings to the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html#PublishingFailureStartTimestamp-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the publishing destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-publishingdestination.html#Id-fn::getatt" } } }, "AWS::GuardDuty::ThreatEntitySet": { "MarkdownDocumentation": "`AWS::GuardDuty::ThreatEntitySet`\n\nThe `AWS::GuardDuty::ThreatEntitySet` resource helps you create a list of\nknown malicious IP addresses and domain names in your AWS environment. Once\nyou activate this list, GuardDuty will use the entries in this list as an\nadditional source of threat detection and generate findings when there is an activity\nassociated with these known malicious IP addresses and domain names. GuardDuty\ncontinues to monitor independently of this custom threat entity set.\nOnly the users of the GuardDuty administrator account can manage this list.\nThese settings automatically apply to the member accounts.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique ID associated with the newly created threat entity\nset.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe format of the file that contains the threat entity set. For information about\nsupported formats, see [List formats](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#prepare_list)\nin the *Amazon GuardDuty User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-format", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Activate": { "MarkdownDocumentation": "`Activate`\n\nA boolean value that determines if GuardDuty can start using this list for\ncustom threat detection. For GuardDuty to consider the entries in this list and\ngenerate findings based on associated activity, this list must be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-activate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe unique regional detector ID of the GuardDuty account for which you want to\ncreate a threat entity set.\nTo find the `detectorId` in the current Region, see the Settings page in the\nGuardDuty console, or run the [ListDetectors](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html)\nAPI.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-detectorid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExpectedBucketOwner": { "MarkdownDocumentation": "`ExpectedBucketOwner`\n\nThe AWS account ID that owns the Amazon S3 bucket specified in the\n*Location* field.\nWhether or not you provide the account ID for this optional field, GuardDuty\nvalidates that the account ID associated with the `DetectorId` owns the S3 bucket in the `Location`\nfield. If GuardDuty finds that this S3 bucket doesn't belong to the specified account ID, you will\nget an error at the time of activating this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-expectedbucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to be added to a new threat entity set resource. Each tag consists of a key and\nan 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*: Array of [TagItem](./aws-properties-guardduty-threatentityset-tagitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagItem", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe user-friendly name to identify the threat entity set. Valid characters are\nalphanumeric, whitespace, dash (-), and underscores (\\_).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe URI of the file that contains the threat entity set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of your `ThreatEntitySet`. For information about valid status\nvalues, see [Understanding list statuses](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#guardduty-entity-list-statuses) in the *Amazon GuardDuty User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#Status-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the threat entity set was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nReturns the unique ID associated with the newly created threat entity set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#Id-fn::getatt" }, "ErrorDetails": { "PrimitiveType": "String", "MarkdownDocumentation": "`ErrorDetails`\n\nThe details associated with the **Error** status of your\nthreat entity list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#ErrorDetails-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the threat entity set was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#UpdatedAt-fn::getatt" } } }, "AWS::GuardDuty::ThreatIntelSet": { "MarkdownDocumentation": "`AWS::GuardDuty::ThreatIntelSet`\n\nThe `AWS::GuardDuty::ThreatIntelSet` resource helps you create a list of\nknown malicious IP addresses in your AWS environment. Once you activate this\nlist, GuardDuty will use list the entries in this list as an additional source for\nthreat detection and generate findings when there is an activity associated with these\nknown malicious IP addresses. GuardDuty continues to monitor independently of this\ncustom threat intelligence set.\nOnly the users of the GuardDuty administrator account can manage this list.\nThese settings automatically apply to the member accounts.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique ID of the `ThreatIntelSet`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe format of the file that contains the `ThreatIntelSet`. For information about supported formats,\nsee [List formats](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#prepare_list) in the *Amazon GuardDuty User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-format", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Activate": { "MarkdownDocumentation": "`Activate`\n\nA boolean value that determines if GuardDuty can start using this list for\ncustom threat detection. For GuardDuty to be able to generate findings based on an\nactivity associated with these entries, this list must be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-activate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe unique ID of the detector of the GuardDuty account for which you want to create a\n`threatIntelSet`.\nTo find the `detectorId` in the current Region, see the\nSettings page in the GuardDuty console, or run the [ListDetectors](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-detectorid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExpectedBucketOwner": { "MarkdownDocumentation": "`ExpectedBucketOwner`\n\nThe AWS account ID that owns the Amazon S3 bucket specified in\nthe *Location* field.\nWhen you provide this account ID, GuardDuty will validate that the S3 bucket\nbelongs to this account. If you don't specify an account ID owner, GuardDuty\ndoesn't perform any 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-expectedbucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to be added to a new threat entity set resource. Each tag consists of a key and\nan 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*: Array of [TagItem](./aws-properties-guardduty-threatintelset-tagitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagItem", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe user-friendly name to identify the ThreatIntelSet.\nThe name of your list must be unique within an AWS account and\nRegion. Valid 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique ID of the `threatIntelSet`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#Id-fn::getatt" } } }, "AWS::GuardDuty::TrustedEntitySet": { "MarkdownDocumentation": "`AWS::GuardDuty::TrustedEntitySet`\n\nCreates a new trusted entity set. In the trusted entity set, you can provide IP addresses\nand domains that you believe are secure for communication in your AWS environment. GuardDuty\nwill not generate findings for the entries that are specified in a trusted entity set. At any\ngiven time, you can have only one trusted entity set.\nOnly users of the administrator account can manage the entity sets, which automatically\napply to member accounts.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique ID of the `TrustedEntitySet`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html", "Properties": { "Format": { "MarkdownDocumentation": "`Format`\n\nThe format of the file that contains the trusted entity set. For information about\nsupported formats, see [List formats](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#prepare_list)\nin the *Amazon GuardDuty User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#cfn-guardduty-trustedentityset-format", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Activate": { "MarkdownDocumentation": "`Activate`\n\nA boolean value that determines if GuardDuty can start using this list for\ncustom threat detection. For GuardDuty to prevent generating findings based on an\nactivity associated with these entries, this list must be 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#cfn-guardduty-trustedentityset-activate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DetectorId": { "MarkdownDocumentation": "`DetectorId`\n\nThe unique regional detector ID of the GuardDuty account for which you want to\ncreate a trusted entity set.\nTo find the `detectorId` in the current Region, see the Settings page in the\nGuardDuty console, or run the [ListDetectors](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html)\nAPI.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#cfn-guardduty-trustedentityset-detectorid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ExpectedBucketOwner": { "MarkdownDocumentation": "`ExpectedBucketOwner`\n\nThe AWS account ID that owns the Amazon S3 bucket specified in the *Location* field.\nWhether or not you provide the account ID for this optional field, GuardDuty\nvalidates that the account ID associated with the `DetectorId` value owns the S3 bucket in the `Location`\nfield. If GuardDuty finds that this S3 bucket doesn't belong to the specified account ID, you will\nget an error at the time of activating this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#cfn-guardduty-trustedentityset-expectedbucketowner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to be added to a new trusted entity set resource. Each tag consists of a key\nand 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*: Array of [TagItem](./aws-properties-guardduty-trustedentityset-tagitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#cfn-guardduty-trustedentityset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagItem", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA user-friendly name to identify the trusted entity set. Valid characters include\nlowercase letters, uppercase letters, numbers, dash(-), and underscore (\\_).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#cfn-guardduty-trustedentityset-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe URI of the file that contains the trusted entity set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#cfn-guardduty-trustedentityset-location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of your `TrustedEntitySet`. For information about valid status\nvalues, see [Understanding list statuses](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#guardduty-entity-list-statuses) in the *Amazon GuardDuty User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#Status-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the trusted entity set was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#Id-fn::getatt" }, "ErrorDetails": { "PrimitiveType": "String", "MarkdownDocumentation": "`ErrorDetails`\n\nSpecifies the error details when the status of the trusted entity set shows as **Error**.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#ErrorDetails-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the trusted entity set was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#UpdatedAt-fn::getatt" } } }, "AWS::HealthLake::FHIRDatastore": { "MarkdownDocumentation": "`AWS::HealthLake::FHIRDatastore`\n\nCreates a Data Store that can ingest and export FHIR formatted data.\n###### Important\nPlease note that when a user tries to do an Update operation via CloudFormation, changes to the Data Store\nname, Type Version, PreloadDataConfig, or SSEConfiguration will delete their existing Data Store for the stack\nand create a new one. This will lead to potential loss of data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html", "Properties": { "DatastoreTypeVersion": { "MarkdownDocumentation": "`DatastoreTypeVersion`\n\nThe FHIR release version supported by the data store. Current support is for version\n`R4`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `R4`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "R4" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-datastoretypeversion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DatastoreName": { "MarkdownDocumentation": "`DatastoreName`\n\nThe data store name (user-generated).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-datastorename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IdentityProviderConfiguration": { "MarkdownDocumentation": "`IdentityProviderConfiguration`\n\nThe identity provider configuration selected when the data store was created.\n*Required*: No\n*Type*: [IdentityProviderConfiguration](./aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "IdentityProviderConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-healthlake-fhirdatastore-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "PreloadDataConfig": { "MarkdownDocumentation": "`PreloadDataConfig`\n\nThe preloaded Synthea data configuration for the data store.\n*Required*: No\n*Type*: [PreloadDataConfig](./aws-properties-healthlake-fhirdatastore-preloaddataconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-preloaddataconfig", "UpdateType": "Immutable", "Required": false, "Type": "PreloadDataConfig" }, "SseConfiguration": { "MarkdownDocumentation": "`SseConfiguration`\n\nThe server-side encryption key configuration for a customer-provided encryption key\nspecified for creating a data store.\n*Required*: No\n*Type*: [SseConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-sseconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "SseConfiguration" } }, "Attributes": { "DatastoreArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatastoreArn`\n\nThe Data Store ARN is generated during the creation of the Data Store and can be found in the output from the\ninitial Data Store creation request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#DatastoreArn-fn::getatt" }, "CreatedAt.Nanos": { "PrimitiveType": "Integer", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#CreatedAt.Nanos-fn::getatt" }, "DatastoreId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatastoreId`\n\nThe Amazon generated Data Store id. This id is in the output from the initial Data Store creation call.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#DatastoreId-fn::getatt" }, "CreatedAt": { "Type": "CreatedAt", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#CreatedAt-fn::getatt" }, "DatastoreStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatastoreStatus`\n\nThe status of the FHIR Data Store. Possible statuses are \u2018CREATING\u2019, \u2018ACTIVE\u2019, \u2018DELETING\u2019, \u2018DELETED\u2019.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#DatastoreStatus-fn::getatt" }, "DatastoreEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatastoreEndpoint`\n\nThe endpoint for the created Data Store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#DatastoreEndpoint-fn::getatt" }, "CreatedAt.Seconds": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#CreatedAt.Seconds-fn::getatt" } } }, "AWS::IAM::AccessKey": { "Attributes": { "SecretAccessKey": { "PrimitiveType": "String", "MarkdownDocumentation": "`SecretAccessKey`\n\nReturns the secret access key for the specified AWS::IAM::AccessKey resource. For\nexample: wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#SecretAccessKey-fn::getatt" } }, "MarkdownDocumentation": "`AWS::IAM::AccessKey`\n\nCreates a new AWS secret access key and corresponding AWS\naccess key ID for the specified user. The default status for new keys is\n`Active`.\nFor information about quotas on the number of keys you can create, see [IAM and\nAWS STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.\n###### Important\nTo ensure the security of your AWS account, the secret access key is\naccessible only during key and user creation. You must save the key (for example, in a\ntext file) if you want to be able to access it again. If a secret key is lost, you can\nrotate access keys by increasing the value of the `serial` property.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html", "Properties": { "Serial": { "MarkdownDocumentation": "`Serial`\n\nThis value is specific to CloudFormation and can only be\n*incremented*. Incrementing this value notifies CloudFormation that you want to rotate your access key. When you update your stack,\nCloudFormation will replace the existing access key with a new key.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-serial", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Immutable" }, "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of the access key. `Active` means that the key is valid for API\ncalls, while `Inactive` means it is not.\n*Required*: No\n*Type*: String\n*Allowed values*: `Active | Inactive | Expired...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Active", "Inactive", "Expired" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-status", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "UserName": { "MarkdownDocumentation": "`UserName`\n\nThe name of the IAM user that the new key will belong to.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-username", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::IAM::Group": { "MarkdownDocumentation": "`AWS::IAM::Group`\n\nCreates a new group.\nFor information about the number of groups you can create, see [Limitations\non IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `GroupName`. For example:\n`mystack-mygroup-1DZETITOWEKVO`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the group to create. Do not include the path in this value.\nThe group name must be unique within the account. Group names are not distinguished by\ncase. For example, you cannot create groups named both \"ADMINS\" and \"admins\". If you don't\nspecify a name, CloudFormation generates a unique physical ID and uses that ID for\nthe group name.\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must\nreplace the resource, specify a new name.\nIf you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to\nacknowledge your template's capabilities. For more information, see [Acknowledging IAM Resources in CloudFormation\nTemplates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n###### Important\nNaming an IAM resource can cause an unrecoverable error if you reuse\nthe same template in multiple Regions. To prevent this, we recommend using\n`Fn::Join` and `AWS::Region` to create a Region-specific name,\nas in the following example: `{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\":\n\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html#cfn-iam-group-groupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Path": { "MarkdownDocumentation": "`Path`\n\nThe path to the group. For more information about paths, see [IAM\nidentifiers](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\nof either a forward slash (/) by itself or a string that must begin and end with forward slashes.\nIn addition, it can contain any ASCII character from the ! (`\\u0021`) through the DEL character (`\\u007F`), including\nmost punctuation characters, digits, and upper and lowercased letters.\n*Required*: No\n*Type*: String\n*Pattern*: `(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html#cfn-iam-group-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManagedPolicyArns": { "MarkdownDocumentation": "`ManagedPolicyArns`\n\nThe Amazon Resource Name (ARN) of the IAM policy you want to attach.\nFor 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*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html#cfn-iam-group-managedpolicyarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Policies": { "MarkdownDocumentation": "`Policies`\n\nAdds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring\nan IAM Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).\n###### Important\nThe name of each inline policy for a role, user, or group must be unique. If you\ndon'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\ngroup, see [Limitations on IAM\nEntities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*.\n*Required*: No\n*Type*: Array of [Policy](./aws-properties-iam-group-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html#cfn-iam-group-policies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Policy", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) for the specified `AWS::IAM::Group`\nresource. For example:\n`arn:aws:iam::123456789012:group/mystack-mygroup-1DZETITOWEKVO`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html#Arn-fn::getatt" } } }, "AWS::IAM::GroupPolicy": { "MarkdownDocumentation": "`AWS::IAM::GroupPolicy`\n\nAdds or updates an inline policy document that is embedded in the specified IAM group.\nA group can also have managed policies attached to it. To attach a managed policy to a\ngroup, use [`AWS::IAM::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [`AWS::IAM::ManagedPolicy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline\npolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\nFor information about the maximum number of inline policies that you can embed in a\ngroup, see [IAM and AWS STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User\nGuide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-grouppolicy.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the group to associate the policy with.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-grouppolicy.html#cfn-iam-grouppolicy-groupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the policy document.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-grouppolicy.html#cfn-iam-grouppolicy-policyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe policy document.\nYou must provide policies in JSON format in IAM. However, for CloudFormation templates\nformatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always\nconverts a YAML policy to JSON format before submitting it to IAM.\nThe [regex pattern](http://wikipedia.org/wiki/regex)\nused to validate this parameter is a string of characters consisting of the following:\n* Any printable ASCII\n character ranging from the space character (`\\u0020`) through the end of the ASCII character range\n* The printable characters in the Basic Latin and Latin-1 Supplement character set\n (through `\\u00FF`)\n* The special characters tab (`\\u0009`), line feed (`\\u000A`), and\n carriage return (`\\u000D`)\n*Required*: No\n*Type*: Json\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-grouppolicy.html#cfn-iam-grouppolicy-policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::IAM::InstanceProfile": { "MarkdownDocumentation": "`AWS::IAM::InstanceProfile`\n\nCreates a new instance profile. For information about instance profiles, see [Using\ninstance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).\nFor information about the number of instance profiles you can create, see [IAM object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"MyProfile\" }`\nFor the `AWS::IAM::InstanceProfile` resource with the logical ID\n`MyProfile`, Ref returns the name of the instance profile.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe path to the instance profile. For more information about paths, see [IAM\nIdentifiers](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\nof either a forward slash (/) by itself or a string that must begin and end with forward slashes.\nIn addition, it can contain any ASCII character from the ! (`\\u0021`) through the DEL character (`\\u007F`), including\nmost punctuation characters, digits, and upper and lowercased letters.\n*Required*: No\n*Type*: String\n*Pattern*: `(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F)`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-path", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceProfileName": { "MarkdownDocumentation": "`InstanceProfileName`\n\nThe name of the instance profile to create.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-instanceprofilename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Roles": { "MarkdownDocumentation": "`Roles`\n\nThe name of the role to associate with the instance profile. Only one role can be\nassigned to an EC2 instance at a time, and all applications on the instance share the same\nrole and permissions.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-roles", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) for the instance profile. For example:\n`{\"Fn::GetAtt\" : [\"MyProfile\", \"Arn\"] }`\nThis returns a value such as\n`arn:aws:iam::1234567890:instance-profile/MyProfile-ASDNSDLKJ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#Arn-fn::getatt" } } }, "AWS::IAM::ManagedPolicy": { "MarkdownDocumentation": "`AWS::IAM::ManagedPolicy`\n\nCreates a new managed policy for your AWS account.\nThis operation creates a policy version with a version identifier of `v1`\nand sets v1 as the policy's default version. For more information about policy versions,\nsee [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the\n*IAM User Guide*.\nAs a best practice, you can validate your IAM policies.\nTo learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html)\nin the *IAM User Guide*.\nFor more information about managed policies in general, see [Managed\npolicies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the\n*IAM User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN.\nIn the following sample, the `Ref` function returns the ARN of the\n`CreateTestDBPolicy` managed policy, such as\n`arn:aws:iam::123456789012:policy/teststack-CreateTestDBPolicy-16M23YE3CS700`.\n`{ \"Ref\": \"CreateTestDBPolicy\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html", "Properties": { "ManagedPolicyName": { "MarkdownDocumentation": "`ManagedPolicyName`\n\nThe friendly name of the policy.\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must\nreplace the resource, specify a new name.\nIf you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to\nacknowledge your template's capabilities. For more information, see [Acknowledging IAM Resources in CloudFormation\nTemplates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n###### Important\nNaming an IAM resource can cause an unrecoverable error if you reuse\nthe same template in multiple Regions. To prevent this, we recommend using\n`Fn::Join` and `AWS::Region` to create a Region-specific name,\nas in the following example: `{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\":\n\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-managedpolicyname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Path": { "MarkdownDocumentation": "`Path`\n\nThe path for the policy.\nFor more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the\n*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\nof either a forward slash (/) by itself or a string that must begin and end with forward slashes.\nIn addition, it can contain any ASCII character from the ! (`\\u0021`) through the DEL character (`\\u007F`), including\nmost punctuation characters, digits, and upper and lowercased letters.\n###### Note\nYou cannot use an asterisk (\\*) in the path name.\n*Required*: No\n*Type*: String\n*Pattern*: `((/[A-Za-z0-9\\.,\\+@=_-]+)*)/`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-path", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA friendly description of the policy.\nTypically used to store information about the permissions defined in the policy. For\nexample, \"Grants access to production DynamoDB tables.\"\nThe policy description is immutable. After a value is assigned, it cannot be\nchanged.\n*Required*: No\n*Type*: String\n*Maximum*: `1000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe name (friendly name, not ARN) of the group to attach the policy to.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: No\n*Type*: Array of String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe JSON policy document that you want to use as the content for the new\npolicy.\nYou must provide policies in JSON format in IAM. However, for CloudFormation\ntemplates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\nIAM.\nThe maximum length of the policy document that you can pass in this operation,\nincluding whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and AWS STS character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).\nTo learn more about JSON policy grammar, see [Grammar of the IAM JSON\npolicy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*.\nThe [regex pattern](http://wikipedia.org/wiki/regex)\nused to validate this parameter is a string of characters consisting of the following:\n* Any printable ASCII\n character ranging from the space character (`\\u0020`) through the end of the ASCII character range\n* The printable characters in the Basic Latin and Latin-1 Supplement character set\n (through `\\u00FF`)\n* The special characters tab (`\\u0009`), line feed (`\\u000A`), and\n carriage return (`\\u000D`)\n*Required*: Yes\n*Type*: Json\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Roles": { "MarkdownDocumentation": "`Roles`\n\nThe name (friendly name, not ARN) of the role to attach the policy to.\nThis parameter allows (per its [regex\npattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters:\n\\_+=,.@-\n###### Note\nIf an external policy (such as `AWS::IAM::Policy` or\n`AWS::IAM::ManagedPolicy`) has a `Ref` to a role and if a\nresource (such as `AWS::ECS::Service`) also has a `Ref` to the\nsame role, add a `DependsOn` attribute to the resource to make the resource\ndepend on the external policy. This dependency ensures that the role's policy is\navailable throughout the resource's lifecycle. For example, when you delete a stack with\nan `AWS::ECS::Service` resource, the `DependsOn` attribute ensures\nthat CloudFormation deletes the `AWS::ECS::Service` resource before\ndeleting its role's policy.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-roles", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Users": { "MarkdownDocumentation": "`Users`\n\nThe name (friendly name, not ARN) of the IAM user to attach the policy to.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: No\n*Type*: Array of String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-users", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } }, "Attributes": { "IsAttachable": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsAttachable`\n\nSpecifies whether the policy can be attached to an IAM user, group, or role.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#IsAttachable-fn::getatt" }, "UpdateDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateDate`\n\nThe date and time, in [ISO 8601 date-time\nformat](http://www.iso.org/iso/iso8601), when the policy was last updated.\nWhen a policy has only one version, this field contains the date and time when the\npolicy was created. When a policy has more than one version, this field contains the date\nand time when the most recent policy version was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#UpdateDate-fn::getatt" }, "PermissionsBoundaryUsageCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`PermissionsBoundaryUsageCount`\n\nThe number of entities (users and roles) for which the policy is used as the permissions\nboundary.\nFor more information about permissions boundaries, see [Permissions boundaries for IAM\nidentities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#PermissionsBoundaryUsageCount-fn::getatt" }, "AttachmentCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AttachmentCount`\n\nThe number of principal entities (users, groups, and roles) that the policy is attached\nto.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#AttachmentCount-fn::getatt" }, "PolicyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyArn`\n\nThe Amazon Resource Name (ARN) of the managed policy that you want information\nabout.\nFor 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*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#PolicyArn-fn::getatt" }, "DefaultVersionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DefaultVersionId`\n\nThe identifier for the version of the policy that is set as the default (operative)\nversion.\nFor more information about policy versions, see [Versioning for managed\npolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#DefaultVersionId-fn::getatt" }, "CreateDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateDate`\n\nThe date and time, in [ISO 8601 date-time\nformat](http://www.iso.org/iso/iso8601), when the policy was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#CreateDate-fn::getatt" }, "PolicyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyId`\n\nThe stable and unique string identifying the policy.\nFor more information about IDs, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the\n*IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#PolicyId-fn::getatt" } } }, "AWS::IAM::OIDCProvider": { "MarkdownDocumentation": "`AWS::IAM::OIDCProvider`\n\nCreates or updates an IAM entity to describe an identity provider (IdP)\nthat supports [OpenID Connect (OIDC)](http://openid.net/connect/).\nThe OIDC provider that you create with this operation can be used as a principal in a\nrole's trust policy. Such a policy establishes a trust relationship between AWS and the OIDC provider.\nWhen you create the IAM OIDC provider, you specify the following:\n* The URL of the OIDC identity provider (IdP) to trust\n* A list of client IDs (also known as audiences) that identify the application or\n applications that are allowed to authenticate using the OIDC provider\n* A list of tags that are attached to the specified IAM OIDC provider\n* A list of thumbprints of one or more server certificates that the IdP uses\nYou get all of this information from the OIDC IdP that you want to use to access AWS.\nWhen you update the IAM OIDC provider, you specify the following:\n* The URL of the OIDC identity provider (IdP) to trust\n* A list of client IDs (also known as audiences) that replaces the existing list of\n client IDs associated with the OIDC IdP\n* A list of tags that replaces the existing list of tags attached to the specified\n IAM OIDC provider\n* A list of thumbprints that replaces the existing list of server certificates\n thumbprints that the IdP uses\n###### Note\nThe trust for the OIDC provider is derived from the IAM provider that\nthis operation creates. Therefore, it is best to limit access to the [CreateOpenIDConnectProvider](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateOpenIDConnectProvider.html) operation to highly privileged users.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html", "Properties": { "ClientIdList": { "MarkdownDocumentation": "`ClientIdList`\n\nA list of client IDs (also known as audiences) that are associated with the specified\nIAM OIDC provider resource object. For more information, see [CreateOpenIDConnectProvider](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateOpenIDConnectProvider.html).\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#cfn-iam-oidcprovider-clientidlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ThumbprintList": { "MarkdownDocumentation": "`ThumbprintList`\n\nA list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see [CreateOpenIDConnectProvider](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateOpenIDConnectProvider.html).\nThis property is optional. If it is not included, IAM will retrieve and\nuse the top intermediate certificate authority (CA) thumbprint of the OpenID Connect\nidentity provider server certificate.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `40`\n*Maximum*: `40 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#cfn-iam-oidcprovider-thumbprintlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL that the IAM OIDC provider resource object is associated with.\nFor more information, see [CreateOpenIDConnectProvider](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateOpenIDConnectProvider.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#cfn-iam-oidcprovider-url", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that are attached to the specified IAM OIDC provider. The\nreturned list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM\nresources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-iam-oidcprovider-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#cfn-iam-oidcprovider-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) for the specified\n`AWS::IAM::OIDCProvider` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#Arn-fn::getatt" } } }, "AWS::IAM::Policy": { "MarkdownDocumentation": "`AWS::IAM::Policy`\n\nAdds or updates an inline policy document that is embedded in the specified IAM group, user or role.\nAn IAM user can also have a managed policy attached to it. For\ninformation about policies, see [Managed Policies and Inline\nPolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\nThe Groups, Roles, and Users properties are optional. However, you must specify at least\none of these properties.\nFor information about policy documents, see [Creating IAM\npolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the *IAM User Guide*.\nFor information about limits on the number of inline policies that you can embed in an\nidentity, see [Limitations on IAM\nEntities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*.\n###### Important\nThis resource does not support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). The following inline policy resource types support drift detection:\n* [`AWS::IAM::GroupPolicy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-grouppolicy.html)\n* [`AWS::IAM::RolePolicy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-rolepolicy.html)\n* [`AWS::IAM::UserPolicy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html)\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html", "Properties": { "Groups": { "MarkdownDocumentation": "`Groups`\n\nThe name of the group to associate the policy with.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-.\n*Required*: No\n*Type*: Array of String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the policy document.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policyname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe policy document.\nYou must provide policies in JSON format in IAM. However, for CloudFormation\ntemplates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\nIAM.\nThe [regex pattern](http://wikipedia.org/wiki/regex)\nused to validate this parameter is a string of characters consisting of the following:\n* Any printable ASCII\n character ranging from the space character (`\\u0020`) through the end of the ASCII character range\n* The printable characters in the Basic Latin and Latin-1 Supplement character set\n (through `\\u00FF`)\n* The special characters tab (`\\u0009`), line feed (`\\u000A`), and\n carriage return (`\\u000D`)\n*Required*: Yes\n*Type*: Json\n*Minimum*: `1`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Roles": { "MarkdownDocumentation": "`Roles`\n\nThe name of the role to associate the policy with.\nThis parameter allows (per its [regex\npattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters:\n\\_+=,.@-\n###### Note\nIf an external policy (such as `AWS::IAM::Policy` or\n`AWS::IAM::ManagedPolicy`) has a `Ref` to a role and if a\nresource (such as `AWS::ECS::Service`) also has a `Ref` to the\nsame role, add a `DependsOn` attribute to the resource to make the resource\ndepend on the external policy. This dependency ensures that the role's policy is\navailable throughout the resource's lifecycle. For example, when you delete a stack with\nan `AWS::ECS::Service` resource, the `DependsOn` attribute ensures\nthat CloudFormation deletes the `AWS::ECS::Service` resource before\ndeleting its role's policy.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-roles", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Users": { "MarkdownDocumentation": "`Users`\n\nThe name of the user to associate the policy with.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: No\n*Type*: Array of String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-users", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe stable and unique string identifying the policy.\nFor more information about IDs, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the\n*IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#Id-fn::getatt" } } }, "AWS::IAM::Role": { "MarkdownDocumentation": "`AWS::IAM::Role`\n\nCreates a new role for your AWS account.\nFor more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the\n*IAM User Guide*. For information about quotas for role names\nand the number of roles you can create, see [IAM and AWS STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the\n*IAM User Guide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor example:\n`{ \"Ref\": \"RootRole\" }`\nFor the `AWS::IAM::Role` resource with the logical ID `RootRole`,\n`Ref` will return the role name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe path to the role. For more information about paths, see [IAM\nIdentifiers](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\nof either a forward slash (/) by itself or a string that must begin and end with forward slashes.\nIn addition, it can contain any ASCII character from the ! (`\\u0021`) through the DEL character (`\\u007F`), including\nmost punctuation characters, digits, and upper and lowercased letters.\n*Required*: No\n*Type*: String\n*Pattern*: `(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F)`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ManagedPolicyArns": { "MarkdownDocumentation": "`ManagedPolicyArns`\n\nA list of Amazon Resource Names (ARNs) of the IAM managed policies that\nyou want to attach to the role.\nFor more information about ARNs, see [Amazon Resource Names (ARNs) and\nAWS 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-managedpolicyarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MaxSessionDuration": { "MarkdownDocumentation": "`MaxSessionDuration`\n\nThe maximum session duration (in seconds) that you want to set for the specified role.\nIf you do not specify a value for this setting, the default value of one hour is\napplied. 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\n`DurationSeconds` API parameter or the `duration-seconds`AWS CLI parameter to request a longer session. The `MaxSessionDuration` setting\ndetermines the maximum duration that can be requested using the\n`DurationSeconds` parameter. If users don't specify a value for the\n`DurationSeconds` parameter, their security credentials are valid for one\nhour by default. This applies when you use the `AssumeRole*` API operations\nor the `assume-role*`AWS CLI operations but does not apply when you use those\noperations to create a console URL. For more information, see [Using IAM\nroles](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-maxsessionduration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RoleName": { "MarkdownDocumentation": "`RoleName`\n\nA name for the IAM role, up to 64 characters in length. For valid values,\nsee the `RoleName` parameter for the [`CreateRole`](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *IAM User Guide*.\nThis parameter allows (per its [regex\npattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-.\nThe role name must be unique within the account. Role names are not distinguished by case.\nFor example, you cannot create roles named both \"Role1\" and \"role1\".\nIf you don't specify a name, CloudFormation generates a unique physical ID and\nuses that ID for the role name.\nIf you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to\nacknowledge your template's capabilities. For more information, see [Acknowledging IAM Resources in CloudFormation\nTemplates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n###### Important\nNaming an IAM resource can cause an unrecoverable error if you reuse\nthe same template in multiple Regions. To prevent this, we recommend using\n`Fn::Join` and `AWS::Region` to create a Region-specific name,\nas in the following example: `{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\":\n\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-rolename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the role that you provide.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Policies": { "MarkdownDocumentation": "`Policies`\n\nAdds 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\nrole's access (permissions) policy. The role's trust policy is created at the same time as\nthe role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and\nFederate 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\n[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\nrole, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*.\n###### Note\nIf an external policy (such as `AWS::IAM::Policy` or\n`AWS::IAM::ManagedPolicy`) has a `Ref` to a role and if a\nresource (such as `AWS::ECS::Service`) also has a `Ref` to the\nsame role, add a `DependsOn` attribute to the resource to make the resource\ndepend on the external policy. This dependency ensures that the role's policy is\navailable throughout the resource's lifecycle. For example, when you delete a stack with\nan `AWS::ECS::Service` resource, the `DependsOn` attribute ensures\nthat CloudFormation deletes the `AWS::ECS::Service` resource before\ndeleting its role's policy.\n*Required*: No\n*Type*: Array of [Policy](./aws-properties-iam-role-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Policy", "DuplicatesAllowed": true }, "AssumeRolePolicyDocument": { "MarkdownDocumentation": "`AssumeRolePolicyDocument`\n\nThe trust policy that is associated with this role. Trust policies define which entities\ncan assume the role. You can associate only one trust policy with a role. For an example of\na 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\nan 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA 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\n*IAM User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-iam-role-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "PermissionsBoundary": { "MarkdownDocumentation": "`PermissionsBoundary`\n\nThe ARN of the policy used to set the permissions boundary for the role.\nFor more information about permissions boundaries, see [Permissions boundaries for IAM\nidentities](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) for the role. For example:\n`{\"Fn::GetAtt\" : [\"MyRole\", \"Arn\"] }`\nThis will return a value such as\n`arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#Arn-fn::getatt" }, "RoleId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoleId`\n\nReturns the stable and unique string identifying the role. For example,\n`AIDAJQABLZS4A3QDU576Q`.\nFor more information about IDs, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#RoleId-fn::getatt" } } }, "AWS::IAM::RolePolicy": { "MarkdownDocumentation": "`AWS::IAM::RolePolicy`\n\nAdds 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\nrole's access (permissions) policy. The role's trust policy is created at the same time as\nthe role, using [`CreateRole`](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [`UpdateAssumeRolePolicy`](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*.\nA role can also have a managed policy attached to it. To attach a managed policy to a\nrole, use [`AWS::IAM::Role`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [`AWS::IAM::ManagedPolicy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline\npolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\nFor information about the maximum number of inline policies that you can embed with a\nrole, see [IAM and AWS STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User\nGuide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-rolepolicy.html", "Properties": { "RoleName": { "MarkdownDocumentation": "`RoleName`\n\nThe name of the role to associate the policy with.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-rolepolicy.html#cfn-iam-rolepolicy-rolename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the policy document.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-rolepolicy.html#cfn-iam-rolepolicy-policyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe policy document.\nYou must provide policies in JSON format in IAM. However, for CloudFormation\ntemplates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\nIAM.\nThe [regex pattern](http://wikipedia.org/wiki/regex)\nused to validate this parameter is a string of characters consisting of the following:\n* Any printable ASCII\n character ranging from the space character (`\\u0020`) through the end of the ASCII character range\n* The printable characters in the Basic Latin and Latin-1 Supplement character set\n (through `\\u00FF`)\n* The special characters tab (`\\u0009`), line feed (`\\u000A`), and\n carriage return (`\\u000D`)\n*Required*: No\n*Type*: Json\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-rolepolicy.html#cfn-iam-rolepolicy-policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::IAM::SAMLProvider": { "MarkdownDocumentation": "`AWS::IAM::SAMLProvider`\n\nCreates an IAM resource that describes an identity provider (IdP) that supports SAML\n2.0.\nThe SAML provider resource that you create with this operation can be used as a\nprincipal in an IAM role's trust policy. Such a policy can enable federated users who\nsign in using the SAML IdP to assume the role. You can create an IAM role that\nsupports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access\nto AWS.\nWhen you create the SAML provider resource, you upload a SAML metadata document that\nyou get from your IdP. That document includes the issuer's name, expiration information,\nand keys that can be used to validate the SAML authentication response (assertions) that\nthe IdP sends. You must generate the metadata document using the identity management\nsoftware that is used as your organization's IdP.\n###### Note\nThis operation requires [Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\nFor more information, see [Enabling SAML 2.0\nfederated users to access the AWS Management Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html) and [About SAML 2.0-based\nfederation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) in the *IAM User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html", "Properties": { "AddPrivateKey": { "MarkdownDocumentation": "`AddPrivateKey`\n\nSpecifies the new private key from your external identity provider. The private key\nmust be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML\nassertions.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `16384`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-addprivatekey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RemovePrivateKey": { "MarkdownDocumentation": "`RemovePrivateKey`\n\nThe Key ID of the private key to remove.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Z0-9]+`\n*Minimum*: `22`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-removeprivatekey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AssertionEncryptionMode": { "MarkdownDocumentation": "`AssertionEncryptionMode`\n\nSpecifies the encryption setting for the SAML provider.\n*Required*: No\n*Type*: String\n*Allowed values*: `Allowed | Required...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Allowed", "Required" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-assertionencryptionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SamlMetadataDocument": { "MarkdownDocumentation": "`SamlMetadataDocument`\n\nAn XML document generated by an identity provider (IdP) that supports SAML 2.0. The\ndocument includes the issuer's name, expiration information, and keys that can be used\nto validate the SAML authentication response (assertions) that are received from the\nIdP. You must generate the metadata document using the identity management software that\nis used as your organization's IdP.\nFor more information, see [About SAML 2.0-based\nfederation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) in the *IAM User Guide*\n*Required*: No\n*Type*: String\n*Minimum*: `1000`\n*Maximum*: `10000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-samlmetadatadocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateKeyList": { "MarkdownDocumentation": "`PrivateKeyList`\n\nThe private key metadata for the SAML provider.\n*Required*: No\n*Type*: Array of [SAMLPrivateKey](./aws-properties-iam-samlprovider-samlprivatekey.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-privatekeylist", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SAMLPrivateKey", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that you want to attach to the new IAM SAML provider.\nEach 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\n*IAM User Guide*.\n###### Note\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request\nfails and the resource is not created.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-iam-samlprovider-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the provider to create.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w._-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) for the specified\n`AWS::IAM::SAMLProvider` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#Arn-fn::getatt" }, "SamlProviderUUID": { "PrimitiveType": "String", "MarkdownDocumentation": "`SamlProviderUUID`\n\nThe unique identifier assigned to the SAML provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#SamlProviderUUID-fn::getatt" } } }, "AWS::IAM::ServerCertificate": { "MarkdownDocumentation": "`AWS::IAM::ServerCertificate`\n\nUploads a server certificate entity for the AWS account. The server certificate\nentity includes a public key certificate, a private key, and an optional certificate\nchain, which should all be PEM-encoded.\nWe recommend that you use [AWS Certificate Manager](https://docs.aws.amazon.com/acm/) to\nprovision, manage, and deploy your server certificates. With ACM you can request a\ncertificate, deploy it to AWS resources, and let ACM handle certificate renewals for\nyou. Certificates provided by ACM are free. For more information about using ACM,\nsee the [AWS Certificate Manager User\nGuide](https://docs.aws.amazon.com/acm/latest/userguide/).\nFor more information about working with server certificates, see [Working\nwith server certificates](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) in the *IAM User Guide*. This\ntopic includes a list of AWS services that can use the server certificates that you\nmanage with IAM.\nFor information about the number of server certificates you can upload, see [IAM and AWS STS\nquotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.\n###### Note\nBecause the body of the public key certificate, private key, and the certificate\nchain can be large, you should use POST rather than GET when calling\n`UploadServerCertificate`. For information about setting up\nsignatures and authorization through the API, see [Signing AWS API\nrequests](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) in the *AWS General Reference*. For general\ninformation about using the Query API with IAM, see [Calling the API by making HTTP query\nrequests](https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html) in the *IAM User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ServerCertificateName`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html", "Properties": { "CertificateBody": { "MarkdownDocumentation": "`CertificateBody`\n\nThe contents of the public key certificate.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `16384`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-certificatebody", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Path": { "MarkdownDocumentation": "`Path`\n\nThe path for the server certificate. For more information about paths, see [IAM\nidentifiers](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\nof either a forward slash (/) by itself or a string that must begin and end with forward slashes.\nIn addition, it can contain any ASCII character from the ! (`\\u0021`) through the DEL character (`\\u007F`), including\nmost punctuation characters, digits, and upper and lowercased letters.\n###### Note\nIf you are uploading a server certificate specifically for use with Amazon\nCloudFront distributions, you must specify a path using the `path`\nparameter. The path must begin with `/cloudfront` and must include a\ntrailing slash (for example, `/cloudfront/test/`).\n*Required*: No\n*Type*: String\n*Pattern*: `(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PrivateKey": { "MarkdownDocumentation": "`PrivateKey`\n\nThe contents of the private key in PEM-encoded format.\nThe [regex pattern](http://wikipedia.org/wiki/regex)\nused to validate this parameter is a string of characters consisting of the following:\n* Any printable ASCII\n character ranging from the space character (`\\u0020`) through the end of the ASCII character range\n* The printable characters in the Basic Latin and Latin-1 Supplement character set\n (through `\\u00FF`)\n* The special characters tab (`\\u0009`), line feed (`\\u000A`), and\n carriage return (`\\u000D`)\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `16384`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-privatekey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CertificateChain": { "MarkdownDocumentation": "`CertificateChain`\n\nThe contents of the public key certificate chain.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `2097152`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-certificatechain", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServerCertificateName": { "MarkdownDocumentation": "`ServerCertificateName`\n\nThe name for the server certificate. Do not include the path in this value. The name\nof the certificate cannot contain any spaces.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-servercertificatename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that are attached to the server certificate. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the\n*IAM User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-iam-servercertificate-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) for the specified\n`AWS::IAM::ServerCertificate` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#Arn-fn::getatt" } } }, "AWS::IAM::ServiceLinkedRole": { "MarkdownDocumentation": "`AWS::IAM::ServiceLinkedRole`\n\nCreates an IAM role that is linked to a specific AWS service. The service controls\nthe attached policies and when the role can be deleted. This helps ensure that the\nservice is not broken by an unexpectedly changed or deleted role, which could put your\nAWS resources into an unknown state. Allowing the service to control the role helps\nimprove service stability and proper cleanup when a service and its role are no longer\nneeded. For more information, see [Using service-linked\nroles](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) in the *IAM User Guide*.\nTo attach a policy to this service-linked role, you must make the request using the\nAWS service that depends on this role.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `RoleName` created for the service-linked role.\nThe `CustomSuffix` is appended to the service-provided prefix with an underscore\nfollowed by the `CustomSuffix` to form the complete role name. For example,\n`AWSServiceRoleForAutoScaling` or\n`AWSServiceRoleForAutoScaling_TestSuffix` if a `CustomSuffix` is\nspecified.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html", "Properties": { "CustomSuffix": { "MarkdownDocumentation": "`CustomSuffix`\n\nA string that you provide, which is combined with the service-provided prefix to form\nthe complete role name. If you make multiple requests for the same service, then you\nmust supply a different `CustomSuffix` for each request. Otherwise the\nrequest fails with a duplicate role name error. For example, you could add\n`-1` or `-debug` to the suffix.\nSome services do not support the `CustomSuffix` parameter. If you provide\nan optional suffix and the operation fails, try the operation again without the\nsuffix.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-customsuffix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the role.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AWSServiceName": { "MarkdownDocumentation": "`AWSServiceName`\n\nThe service principal for the AWS service to which this role is attached. You use a\nstring similar to a URL but without the http:// in front. For example:\n`elasticbeanstalk.amazonaws.com`.\nService principals are unique and case-sensitive. To find the exact service principal\nfor your service-linked role, see [AWS services\nthat 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\nthe services that have **Yes** in the **Service-Linked Role** column. Choose the **Yes** link to view the service-linked role documentation for that\nservice.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-awsservicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "RoleName": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoleName`\n\nReturns the friendly name that identifies the role. For example,\n`AWSServiceRoleForAutoScaling` or\n`AWSServiceRoleForAutoScaling_TestSuffix` if a `CustomSuffix` is\nspecified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#RoleName-fn::getatt" } } }, "AWS::IAM::User": { "MarkdownDocumentation": "`AWS::IAM::User`\n\nCreates a new IAM user for your AWS account.\nFor information about quotas for the number of IAM users you can create, see [IAM and AWS STS\nquotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `UserName`. For example:\n`mystack-myuser-1CCXAFG2H2U4D`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe path for the user name. For more information about paths, see [IAM\nidentifiers](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\nof either a forward slash (/) by itself or a string that must begin and end with forward slashes.\nIn addition, it can contain any ASCII character from the ! (`\\u0021`) through the DEL character (`\\u007F`), including\nmost punctuation characters, digits, and upper and lowercased letters.\n*Required*: No\n*Type*: String\n*Pattern*: `(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManagedPolicyArns": { "MarkdownDocumentation": "`ManagedPolicyArns`\n\nA list of Amazon Resource Names (ARNs) of the IAM managed policies that\nyou want to attach to the user.\nFor more information about ARNs, see [Amazon Resource Names (ARNs) and\nAWS 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-managedpolicyarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Policies": { "MarkdownDocumentation": "`Policies`\n\nAdds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring\nan IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).\n###### Important\nThe name of each policy for a role, user, or group must be unique. If you don't\nchoose 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\nuser, 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*: Array of [Policy](./aws-properties-iam-user-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-policies", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Policy", "DuplicatesAllowed": true }, "UserName": { "MarkdownDocumentation": "`UserName`\n\nThe name of the user to create. Do not include the path in this value.\nThis parameter allows (per its [regex\npattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-.\nThe user name must be unique within the account. User names are not distinguished by case.\nFor example, you cannot create users named both \"John\" and \"john\".\nIf you don't specify a name, CloudFormation generates a unique physical ID and\nuses that ID for the user name.\nIf you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to\nacknowledge your template's capabilities. For more information, see [Acknowledging IAM Resources in CloudFormation\nTemplates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n###### Important\nNaming an IAM resource can cause an unrecoverable error if you reuse\nthe same template in multiple Regions. To prevent this, we recommend using\n`Fn::Join` and `AWS::Region` to create a Region-specific name,\nas in the following example: `{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\":\n\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-username", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Groups": { "MarkdownDocumentation": "`Groups`\n\nA list of group names to which you want to add the user.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-groups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LoginProfile": { "MarkdownDocumentation": "`LoginProfile`\n\nCreates a password for the specified IAM user. A password allows an\nIAM 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\nfor any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update\nyour own existing password in the **My Security Credentials**\npage 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-loginprofile", "UpdateType": "Mutable", "Required": false, "Type": "LoginProfile" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value.\nFor more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the\n*IAM User Guide*.\n###### Note\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request\nfails and the resource is not created.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-iam-user-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "PermissionsBoundary": { "MarkdownDocumentation": "`PermissionsBoundary`\n\nThe ARN of the managed policy that is used to set the permissions boundary for the\nuser.\nA permissions boundary policy defines the maximum permissions that identity-based\npolicies can grant to an entity, but does not grant permissions. Permissions boundaries\ndo not define the maximum permissions that a resource-based policy can grant to an\nentity. To learn more, see [Permissions boundaries\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-permissionsboundary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) for the specified `AWS::IAM::User`\nresource. For example:\n`arn:aws:iam::123456789012:user/mystack-myuser-1CCXAFG2H2U4D`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#Arn-fn::getatt" } } }, "AWS::IAM::UserPolicy": { "MarkdownDocumentation": "`AWS::IAM::UserPolicy`\n\nAdds or updates an inline policy document that is embedded in the specified IAM user.\nAn IAM user can also have a managed policy attached to it. To attach a managed policy to\na user, use [`AWS::IAM::User`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [`AWS::IAM::ManagedPolicy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline\npolicies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\nFor information about the maximum number of inline policies that you can embed in a\nuser, see [IAM and AWS STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User\nGuide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html", "Properties": { "UserName": { "MarkdownDocumentation": "`UserName`\n\nThe name of the user to associate the policy with.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html#cfn-iam-userpolicy-username", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the policy document.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html#cfn-iam-userpolicy-policyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe policy document.\nYou must provide policies in JSON format in IAM. However, for CloudFormation\ntemplates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\nIAM.\nThe [regex pattern](http://wikipedia.org/wiki/regex)\nused to validate this parameter is a string of characters consisting of the following:\n* Any printable ASCII\n character ranging from the space character (`\\u0020`) through the end of the ASCII character range\n* The printable characters in the Basic Latin and Latin-1 Supplement character set\n (through `\\u00FF`)\n* The special characters tab (`\\u0009`), line feed (`\\u000A`), and\n carriage return (`\\u000D`)\n*Required*: No\n*Type*: Json\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `131072`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html#cfn-iam-userpolicy-policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } } }, "AWS::IAM::UserToGroupAddition": { "MarkdownDocumentation": "`AWS::IAM::UserToGroupAddition`\n\nAdds the specified user to the specified group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe name of the group to update.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html#cfn-iam-addusertogroup-groupname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Users": { "MarkdownDocumentation": "`Users`\n\nA list of the names of the users that you want to add to the group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html#cfn-iam-addusertogroup-users", "DuplicatesAllowed": true, "PrimitiveItemType": "String", "Required": true, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::IAM::VirtualMFADevice": { "MarkdownDocumentation": "`AWS::IAM::VirtualMFADevice`\n\nCreates a new virtual MFA device for the AWS account. After creating\nthe virtual MFA, use [EnableMFADevice](https://docs.aws.amazon.com/IAM/latest/APIReference/API_EnableMFADevice.html) to attach\nthe MFA device to an IAM user. For more information about creating and\nworking with virtual MFA devices, see [Using a virtual MFA device](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html) in\nthe *IAM User Guide*.\nFor information about the maximum number of MFA devices you can create, see [IAM and AWS STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.\n###### Important\nThe seed information contained in the QR code and the Base32 string should be treated\nlike any other secret access information. In other words, protect the seed information\nas you would your AWS access keys or your passwords. After you\nprovision your virtual device, you should ensure that the information is destroyed\nfollowing secure procedures.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `SerialNumber`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html", "Properties": { "Path": { "MarkdownDocumentation": "`Path`\n\nThe path for the virtual MFA device. For more information about paths, see [IAM\nidentifiers](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\nof either a forward slash (/) by itself or a string that must begin and end with forward slashes.\nIn addition, it can contain any ASCII character from the ! (`\\u0021`) through the DEL character (`\\u007F`), including\nmost punctuation characters, digits, and upper and lowercased letters.\n*Required*: No\n*Type*: String\n*Pattern*: `(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#cfn-iam-virtualmfadevice-path", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VirtualMfaDeviceName": { "MarkdownDocumentation": "`VirtualMfaDeviceName`\n\nThe name of the virtual MFA device, which must be unique. Use with path to uniquely\nidentify a virtual MFA device.\nThis parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric\ncharacters with no spaces. You can also include any of the following characters: \\_+=,.@-\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `226`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#cfn-iam-virtualmfadevice-virtualmfadevicename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Users": { "MarkdownDocumentation": "`Users`\n\nThe IAM user associated with this virtual MFA device.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#cfn-iam-virtualmfadevice-users", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that you want to attach to the new IAM virtual MFA device.\nEach 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\n*IAM User Guide*.\n###### Note\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request\nfails and the resource is not created.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-iam-virtualmfadevice-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#cfn-iam-virtualmfadevice-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "SerialNumber": { "PrimitiveType": "String", "MarkdownDocumentation": "`SerialNumber`\n\nReturns the serial number for the specified `AWS::IAM::VirtualMFADevice`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#SerialNumber-fn::getatt" } } }, "AWS::IdentityStore::Group": { "MarkdownDocumentation": "`AWS::IdentityStore::Group`\n\nA group object, which contains a specified group\u2019s metadata and attributes.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the `Physical ID` of the resource created\nwhich is the format `GroupID|IdentityStoreId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA string containing the description of the group.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r \u3000]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html#cfn-identitystore-group-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name value for the group. The length limit is 1,024 characters. This value\ncan consist of letters, accented characters, symbols, numbers, punctuation, tab, new line,\ncarriage return, space, and nonbreaking space in this attribute. This value is specified at\nthe time the group is created and stored as an attribute of the group object in the\nidentity store.\nPrefix search supports a maximum of 1,000 characters for the string.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html#cfn-identitystore-group-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IdentityStoreId": { "MarkdownDocumentation": "`IdentityStoreId`\n\nThe globally unique identifier for the identity store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `1`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html#cfn-identitystore-group-identitystoreid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupId`\n\nThe identifier of the newly created group in the identity store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-group.html#GroupId-fn::getatt" } } }, "AWS::IdentityStore::GroupMembership": { "MarkdownDocumentation": "`AWS::IdentityStore::GroupMembership`\n\nCreates a relationship between a member and a group. The following identifiers must be\nspecified: `GroupId`, `IdentityStoreId`, and\n`MemberId`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the `Physical ID` of the resource created\nwhich is the format `GroupMembershipID|IdentityStoreId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.html", "Properties": { "MemberId": { "MarkdownDocumentation": "`MemberId`\n\nAn object containing the identifier of a group member. Setting the `MemberId`'s\n`UserId` field to a specific User's ID indicates that user is a member of the group.\n*Required*: Yes\n*Type*: [MemberId](./aws-properties-identitystore-groupmembership-memberid.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.html#cfn-identitystore-groupmembership-memberid", "UpdateType": "Immutable", "Required": true, "Type": "MemberId" }, "IdentityStoreId": { "MarkdownDocumentation": "`IdentityStoreId`\n\nThe globally unique identifier for the identity store.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n*Minimum*: `1`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.html#cfn-identitystore-groupmembership-identitystoreid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GroupId": { "MarkdownDocumentation": "`GroupId`\n\nThe identifier for a group in the identity store.\n*Required*: Yes\n*Type*: String\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*Minimum*: `1`\n*Maximum*: `47`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.html#cfn-identitystore-groupmembership-groupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "MembershipId": { "PrimitiveType": "String", "MarkdownDocumentation": "`MembershipId`\n\nThe identifier for a `GroupMembership` in the identity store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.html#MembershipId-fn::getatt" } } }, "AWS::ImageBuilder::Component": { "MarkdownDocumentation": "`AWS::ImageBuilder::Component`\n\nCreates a new component that can be used to build, validate, test, and assess your\nimage. The component is based on a YAML document that you specify using exactly one of\nthe following methods:\n* Inline, using the `data` property in the request body.\n* A URL that points to a YAML document file stored in Amazon S3, using the\n `uri` property in the request body.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN, such as\n`arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nDescribes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SupportedOsVersions": { "MarkdownDocumentation": "`SupportedOsVersions`\n\nThe operating system (OS) version supported by the component. If the OS information is\navailable, a prefix match is performed against the base image OS version during image\nrecipe creation.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `25`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-supportedosversions", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Platform": { "MarkdownDocumentation": "`Platform`\n\nThe operating system platform of the component.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Windows | Linux | macOS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Windows", "Linux", "macOS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-platform", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)\nin the *AWS Key Management Service Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe semantic version of the component. This version follows the semantic version\nsyntax.\n###### Note\nThe semantic version has four nodes: ../.\nYou 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\nzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the\nbuild number to the fourth node.\n**Patterns:** You can use any numeric pattern that adheres to the assignment requirements for\nthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or\na date, such as 2021.01.01.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ChangeDescription": { "MarkdownDocumentation": "`ChangeDescription`\n\nThe change description of the component. Describes what change has been made in this\nversion, or what makes this version different from other versions of the\ncomponent.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-changedescription", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Data": { "MarkdownDocumentation": "`Data`\n\nComponent `data` contains inline YAML document content for the component.\nAlternatively, you can specify the `uri` of a YAML document file stored in\nAmazon S3. However, you cannot specify both properties.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `16000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-data", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Uri": { "MarkdownDocumentation": "`Uri`\n\nThe `uri` of a YAML component document file. This must be an S3 URL\n(`s3://bucket/key`), and the requester must have permission to access the\nS3 bucket it points to. If you use Amazon S3, you can specify component content up to your\nservice quota.\nAlternatively, you can specify the YAML document inline, using the component\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-uri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that apply to the component.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nImage Builder determines the component type based on the phases that are\ndefined in the component document. If there is only one phase, and its name is\n\"test\", then the type is `TEST`. For all other components, the type\nis `BUILD`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#Type-fn::getatt" }, "LatestVersion": { "Type": "LatestVersion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#LatestVersion-fn::getatt" }, "LatestVersion.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#LatestVersion.Arn-fn::getatt" }, "Encrypted": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`Encrypted`\n\nReturns the encryption status of the component. For example `true` or\n`false`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#Encrypted-fn::getatt" }, "LatestVersion.Major": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#LatestVersion.Major-fn::getatt" }, "LatestVersion.Minor": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#LatestVersion.Minor-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the component. The following pattern is\napplied:\n`^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\\d+)\\.(?:x|\\d+)\\.(?:x|\\d+))(?:/\\d+)?)?$`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#Arn-fn::getatt" }, "LatestVersion.Patch": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#LatestVersion.Patch-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nReturns the name of the component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#Name-fn::getatt" } } }, "AWS::ImageBuilder::ContainerRecipe": { "MarkdownDocumentation": "`AWS::ImageBuilder::ContainerRecipe`\n\nCreates a new container recipe. Container recipes define how images are configured,\ntested, and assessed.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN, such as\n`arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/mybasicrecipe/2020.12.17`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html", "Properties": { "WorkingDirectory": { "MarkdownDocumentation": "`WorkingDirectory`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-workingdirectory", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ParentImage": { "MarkdownDocumentation": "`ParentImage`\n\nThe base image for customizations specified in the container recipe. This can\ncontain an Image Builder image resource ARN or a container image URI, for example\n`amazonlinux:latest`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-parentimage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image\nfor distribution to the target Region. This can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)\nin the *AWS Key Management Service Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceConfiguration": { "MarkdownDocumentation": "`InstanceConfiguration`\n\nA group of options that can be used to configure an instance for building and testing\ncontainer images.\n*Required*: No\n*Type*: [InstanceConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-instanceconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "InstanceConfiguration" }, "ContainerType": { "MarkdownDocumentation": "`ContainerType`\n\nSpecifies the type of container, such as Docker.\n*Required*: No\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)\n", "RefReturnValue": "", "AllowedValues": [ "DOCKER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-containertype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the container recipe.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DockerfileTemplateData": { "MarkdownDocumentation": "`DockerfileTemplateData`\n\nDockerfiles are text documents that are used to build Docker containers, and ensure\nthat they contain all of the elements required by the application running inside. The\ntemplate data consists of contextual variables where Image Builder places build information or\nscripts, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-dockerfiletemplatedata", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Components": { "MarkdownDocumentation": "`Components`\n\nBuild and test components that are included in the container recipe.\nRecipes require a minimum of one build component, and can\nhave a maximum of 20 build and test components in any combination.\n*Required*: No\n*Type*: Array of [ComponentConfiguration](./aws-properties-imagebuilder-containerrecipe-componentconfiguration.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-components", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ComponentConfiguration", "DuplicatesAllowed": true }, "TargetRepository": { "MarkdownDocumentation": "`TargetRepository`\n\nThe destination repository for the container image.\n*Required*: No\n*Type*: [TargetContainerRepository](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-targetrepository", "UpdateType": "Immutable", "Required": true, "Type": "TargetContainerRepository" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe semantic version of the container recipe. This version follows the semantic\nversion syntax.\n###### Note\nThe semantic version has four nodes: ../.\nYou 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\nzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the\nbuild number to the fourth node.\n**Patterns:** You can use any numeric pattern that adheres to the assignment requirements for\nthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or\na date, such as 2021.01.01.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:[0-9]+|x)\\.(?:[0-9]+|x)\\.(?:[0-9]+|x)$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PlatformOverride": { "MarkdownDocumentation": "`PlatformOverride`\n\nSpecifies the operating system platform when you use a custom base image.\n*Required*: No\n*Type*: String\n*Allowed values*: `Windows | Linux...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Windows", "Linux" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-platformoverride", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ImageOsVersionOverride": { "MarkdownDocumentation": "`ImageOsVersionOverride`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-imageosversionoverride", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags that are attached to the container recipe.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "DockerfileTemplateUri": { "MarkdownDocumentation": "`DockerfileTemplateUri`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-dockerfiletemplateuri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "LatestVersion": { "Type": "LatestVersion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#LatestVersion-fn::getatt" }, "LatestVersion.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#LatestVersion.Arn-fn::getatt" }, "LatestVersion.Major": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#LatestVersion.Major-fn::getatt" }, "LatestVersion.Minor": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#LatestVersion.Minor-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the container recipe. For example,\n`arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/mybasicrecipe/2020.12.17`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#Arn-fn::getatt" }, "LatestVersion.Patch": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#LatestVersion.Patch-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nReturns the name of the container recipe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#Name-fn::getatt" } } }, "AWS::ImageBuilder::DistributionConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::DistributionConfiguration`\n\nA distribution configuration allows you to specify the name and description of your\noutput AMI, authorize other AWS accounts to launch the AMI, and replicate the AMI to other\nAWS Regions. It also allows you to export the AMI to Amazon S3.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the resource, such as\n`arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-distributionconfiguration.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-distributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags of this distribution configuration.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-distributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-distributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Distributions": { "MarkdownDocumentation": "`Distributions`\n\nThe distributions of this distribution configuration formatted as an array of\nDistribution objects.\n*Required*: Yes\n*Type*: Array of [Distribution](./aws-properties-imagebuilder-distributionconfiguration-distribution.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-distributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-distributions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Distribution", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of this distribution configuration. The following\npattern is applied:\n`^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\\d+)\\.(?:x|\\d+)\\.(?:x|\\d+))(?:/\\d+)?)?$`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-distributionconfiguration.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nReturns the name of the distribution configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-distributionconfiguration.html#Name-fn::getatt" } } }, "AWS::ImageBuilder::Image": { "MarkdownDocumentation": "`AWS::ImageBuilder::Image`\n\nCreates a new image. This request will create a new image along with all of the\nconfigured output resources defined in the distribution configuration. You must specify\nexactly one recipe for your image, using either a ContainerRecipeArn or an\nImageRecipeArn.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN, such as\n`arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html", "Properties": { "ImageScanningConfiguration": { "MarkdownDocumentation": "`ImageScanningConfiguration`\n\nContains settings for vulnerability scans.\n*Required*: No\n*Type*: [ImageScanningConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagescanningconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "ImageScanningConfiguration" }, "ContainerRecipeArn": { "MarkdownDocumentation": "`ContainerRecipeArn`\n\nThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-containerrecipearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Workflows": { "MarkdownDocumentation": "`Workflows`\n\nContains an array of workflow configuration objects.\n*Required*: No\n*Type*: Array of [WorkflowConfiguration](./aws-properties-imagebuilder-image-workflowconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-workflows", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "WorkflowConfiguration", "DuplicatesAllowed": true }, "ImagePipelineExecutionSettings": { "MarkdownDocumentation": "`ImagePipelineExecutionSettings`\n\nThe image pipeline execution settings of the image.\n*Required*: No\n*Type*: [ImagePipelineExecutionSettings](./aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagepipelineexecutionsettings", "UpdateType": "Conditional", "Required": false, "Type": "ImagePipelineExecutionSettings" }, "DeletionSettings": { "MarkdownDocumentation": "`DeletionSettings`\n\nEnables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.\n*Required*: No\n*Type*: [DeletionSettings](./aws-properties-imagebuilder-image-deletionsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-deletionsettings", "UpdateType": "Mutable", "Required": false, "Type": "DeletionSettings" }, "InfrastructureConfigurationArn": { "MarkdownDocumentation": "`InfrastructureConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-infrastructureconfigurationarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ImageRecipeArn": { "MarkdownDocumentation": "`ImageRecipeArn`\n\nThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagerecipearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DistributionConfigurationArn": { "MarkdownDocumentation": "`DistributionConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-distributionconfigurationarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LoggingConfiguration": { "MarkdownDocumentation": "`LoggingConfiguration`\n\nThe logging configuration that's defined for the image. Image Builder uses the defined settings\nto direct execution log output during image creation.\n*Required*: No\n*Type*: [ImageLoggingConfiguration](./aws-properties-imagebuilder-image-imageloggingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-loggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ImageLoggingConfiguration" }, "ImageTestsConfiguration": { "MarkdownDocumentation": "`ImageTestsConfiguration`\n\nThe image tests configuration of the image.\n*Required*: No\n*Type*: [ImageTestsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagetestsconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "ImageTestsConfiguration" }, "EnhancedImageMetadataEnabled": { "MarkdownDocumentation": "`EnhancedImageMetadataEnabled`\n\nCollects 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-enhancedimagemetadataenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe name or Amazon Resource Name (ARN) for the IAM role you create that grants\nImage Builder access to perform workflow actions.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-executionrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags of the image.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "LatestVersion": { "Type": "LatestVersion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#LatestVersion-fn::getatt" }, "LatestVersion.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#LatestVersion.Arn-fn::getatt" }, "LatestVersion.Major": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#LatestVersion.Major-fn::getatt" }, "LatestVersion.Minor": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#LatestVersion.Minor-fn::getatt" }, "ImageId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ImageId`\n\nReturns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image\nBuilder. Values are returned only for AMIs, and not for container images.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#ImageId-fn::getatt" }, "ImageUri": { "PrimitiveType": "String", "MarkdownDocumentation": "`ImageUri`\n\nReturns the URI for a container image created in the context Region. Values are returned only for\ncontainer images, and not for AMIs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#ImageUri-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the image. For example,\n`arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#Arn-fn::getatt" }, "LatestVersion.Patch": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#LatestVersion.Patch-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nReturns the name of the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#Name-fn::getatt" } } }, "AWS::ImageBuilder::ImagePipeline": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImagePipeline`\n\nAn image pipeline is the automation configuration for building secure OS images on AWS.\nThe Image Builder image pipeline is associated with an image recipe that defines the build,\nvalidation, and test phases for an image build lifecycle. An image pipeline can be\nassociated with an infrastructure configuration that defines where your image is built. You\ncan define attributes, such as instance types, a subnet for your VPC, security groups, logging, and\nother infrastructure-related configurations. You can also associate your image pipeline with a\ndistribution configuration to define how you would like to deploy your image.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN, such as\n`arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImageScanningConfiguration": { "MarkdownDocumentation": "`ImageScanningConfiguration`\n\nContains settings for vulnerability scans.\n*Required*: No\n*Type*: [ImageScanningConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagescanningconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ImageScanningConfiguration" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of this image pipeline.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContainerRecipeArn": { "MarkdownDocumentation": "`ContainerRecipeArn`\n\nThe Amazon Resource Name (ARN) of the container recipe that is used for this\npipeline.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-containerrecipearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Workflows": { "MarkdownDocumentation": "`Workflows`\n\nContains the workflows that run for the image pipeline.\n*Required*: No\n*Type*: Array of [WorkflowConfiguration](./aws-properties-imagebuilder-imagepipeline-workflowconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-workflows", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "WorkflowConfiguration", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the image pipeline.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InfrastructureConfigurationArn": { "MarkdownDocumentation": "`InfrastructureConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the infrastructure configuration associated with\nthis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-infrastructureconfigurationarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImageRecipeArn": { "MarkdownDocumentation": "`ImageRecipeArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagerecipearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DistributionConfigurationArn": { "MarkdownDocumentation": "`DistributionConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the distribution configuration associated with this\nimage 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-distributionconfigurationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe schedule of the image pipeline. A schedule configures how often and when a pipeline\nautomatically creates a new image.\n*Required*: No\n*Type*: [Schedule](./aws-properties-imagebuilder-imagepipeline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-schedule", "UpdateType": "Mutable", "Required": false, "Type": "Schedule" }, "LoggingConfiguration": { "MarkdownDocumentation": "`LoggingConfiguration`\n\nDefines logging configuration for the output image.\n*Required*: No\n*Type*: [PipelineLoggingConfiguration](./aws-properties-imagebuilder-imagepipeline-pipelineloggingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-loggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PipelineLoggingConfiguration" }, "ImageTestsConfiguration": { "MarkdownDocumentation": "`ImageTestsConfiguration`\n\nThe configuration of the image tests that run after image creation to ensure the\nquality of the image that was created.\n*Required*: No\n*Type*: [ImageTestsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagetestsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ImageTestsConfiguration" }, "EnhancedImageMetadataEnabled": { "MarkdownDocumentation": "`EnhancedImageMetadataEnabled`\n\nCollects additional information about the image being created, including the operating\nsystem (OS) version and package list. This information is used to enhance the overall\nexperience 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-enhancedimagemetadataenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe name or Amazon Resource Name (ARN) for the IAM role you create that grants\nImage Builder access to perform workflow actions.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-executionrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags of this image pipeline.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "DeploymentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeploymentId`\n\nReturns the deployment ID of the pipeline, used for resource create/update triggers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#DeploymentId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the image pipeline. For example,\n`arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nReturns the name of the image pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#Name-fn::getatt" } } }, "AWS::ImageBuilder::ImageRecipe": { "MarkdownDocumentation": "`AWS::ImageBuilder::ImageRecipe`\n\nCreates a new image recipe. Image recipes define how images are configured, tested,\nand assessed.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN, such as\n`arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html", "Properties": { "Components": { "MarkdownDocumentation": "`Components`\n\nThe components that are included in the image recipe. Recipes require a minimum of one build component, and can\nhave a maximum of 20 build and test components in any combination.\n*Required*: No\n*Type*: Array of [ComponentConfiguration](./aws-properties-imagebuilder-imagerecipe-componentconfiguration.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-components", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ComponentConfiguration", "DuplicatesAllowed": true }, "WorkingDirectory": { "MarkdownDocumentation": "`WorkingDirectory`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-workingdirectory", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ParentImage": { "MarkdownDocumentation": "`ParentImage`\n\nThe base image for customizations specified in the image recipe. You can specify the\nparent image using one of the following options:\n* AMI ID\n* Image Builder image Amazon Resource Name (ARN)\n* AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by `ssm:`,\n followed by the parameter name or ARN.\n* AWS Marketplace product 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-parentimage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AmiTags": { "MarkdownDocumentation": "`AmiTags`\n\nTags that are applied to the AMI that Image Builder creates during the Build phase\nprior to image distribution.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-amitags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe semantic version of the image recipe. This version follows the semantic version\nsyntax.\n###### Note\nThe semantic version has four nodes: ../.\nYou 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\nzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the\nbuild number to the fourth node.\n**Patterns:** You can use any numeric pattern that adheres to the assignment requirements for\nthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or\na date, such as 2021.01.01.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?:[0-9]+|x)\\.(?:[0-9]+|x)\\.(?:[0-9]+|x)$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BlockDeviceMappings": { "MarkdownDocumentation": "`BlockDeviceMappings`\n\nThe block device mappings to apply when creating images from this recipe.\n*Required*: No\n*Type*: Array of [InstanceBlockDeviceMapping](./aws-properties-imagebuilder-imagerecipe-instanceblockdevicemapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-blockdevicemappings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "InstanceBlockDeviceMapping", "DuplicatesAllowed": true }, "AdditionalInstanceConfiguration": { "MarkdownDocumentation": "`AdditionalInstanceConfiguration`\n\nBefore you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test\nyour image configuration. Instance configuration adds a layer of control over those\ninstances. You can define settings and add scripts to run when an instance is launched\nfrom your AMI.\n*Required*: No\n*Type*: [AdditionalInstanceConfiguration](./aws-properties-imagebuilder-imagerecipe-additionalinstanceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-additionalinstanceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AdditionalInstanceConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags of the image recipe.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#cfn-imagebuilder-imagerecipe-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "LatestVersion": { "Type": "LatestVersion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#LatestVersion-fn::getatt" }, "LatestVersion.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#LatestVersion.Arn-fn::getatt" }, "LatestVersion.Major": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#LatestVersion.Major-fn::getatt" }, "LatestVersion.Minor": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#LatestVersion.Minor-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the image recipe. For example,\n`arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#Arn-fn::getatt" }, "LatestVersion.Patch": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#LatestVersion.Patch-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the image recipe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagerecipe.html#Name-fn::getatt" } } }, "AWS::ImageBuilder::InfrastructureConfiguration": { "MarkdownDocumentation": "`AWS::ImageBuilder::InfrastructureConfiguration`\n\nCreates a new infrastructure configuration. An infrastructure configuration defines\nthe environment in which your image will be built and tested.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN, such as\n`arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/my-example-infrastructure`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html", "Properties": { "Logging": { "MarkdownDocumentation": "`Logging`\n\nThe logging configuration of the infrastructure configuration.\n*Required*: No\n*Type*: [Logging](./aws-properties-imagebuilder-infrastructureconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-logging", "UpdateType": "Mutable", "Required": false, "Type": "Logging" }, "KeyPair": { "MarkdownDocumentation": "`KeyPair`\n\nThe key pair of the infrastructure configuration. You can use this to log on to and\ndebug the instance used to create your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-keypair", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the infrastructure 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceProfileName": { "MarkdownDocumentation": "`InstanceProfileName`\n\nThe instance profile to associate with the instance used to customize your Amazon EC2\nAMI.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w+=,.@-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instanceprofilename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nThe metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.\nTags are formatted as key value pairs.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "TerminateInstanceOnFailure": { "MarkdownDocumentation": "`TerminateInstanceOnFailure`\n\nThe terminate instance on failure setting of the infrastructure configuration. Set to\nfalse if you want Image Builder to retain the instance used to configure your AMI if the build or\ntest phase of your workflow fails.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-terminateinstanceonfailure", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe subnet ID in which to place the instance used to customize your Amazon EC2 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-subnetid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe security group IDs to associate with the instance used to customize your Amazon EC2\nAMI.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the infrastructure 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Placement": { "MarkdownDocumentation": "`Placement`\n\nThe instance placement settings that define where the instances that are launched\nfrom your image will run.\n*Required*: No\n*Type*: [Placement](./aws-properties-imagebuilder-infrastructureconfiguration-placement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-placement", "UpdateType": "Mutable", "Required": false, "Type": "Placement" }, "InstanceMetadataOptions": { "MarkdownDocumentation": "`InstanceMetadataOptions`\n\nThe instance metadata options that you can set for the HTTP requests that pipeline\nbuilds use to launch EC2 build and test instances.\n*Required*: No\n*Type*: [InstanceMetadataOptions](./aws-properties-imagebuilder-infrastructureconfiguration-instancemetadataoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instancemetadataoptions", "UpdateType": "Mutable", "Required": false, "Type": "InstanceMetadataOptions" }, "InstanceTypes": { "MarkdownDocumentation": "`InstanceTypes`\n\nThe instance types of the infrastructure configuration. You can specify one or more\ninstance types to use for this build. The service will pick one of these instance types\nbased on availability.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instancetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SnsTopicArn": { "MarkdownDocumentation": "`SnsTopicArn`\n\nThe Amazon Resource Name (ARN) for the SNS topic to which we send image build event\nnotifications.\n###### Note\nEC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys\nfrom other accounts. The key that is used to encrypt the SNS topic must reside in the\naccount that the Image Builder service runs under.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-snstopicarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe metadata tags to assign to the infrastructure configuration resource that Image Builder\ncreates as output. Tags are formatted as key value pairs.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the infrastructure configuration. The\nfollowing pattern is applied:\n`^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\\d+)\\.(?:x|\\d+)\\.(?:x|\\d+))(?:/\\d+)?)?$`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the infrastructure configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#Name-fn::getatt" } } }, "AWS::ImageBuilder::LifecyclePolicy": { "MarkdownDocumentation": "`AWS::ImageBuilder::LifecyclePolicy`\n\nCreate a lifecycle policy resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nIndicates whether the lifecycle policy resource is enabled.\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)", "RefReturnValue": "", "AllowedValues": [ "DISABLED", "ENABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#cfn-imagebuilder-lifecyclepolicy-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nOptional description for the lifecycle policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#cfn-imagebuilder-lifecyclepolicy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of Image Builder resource that the lifecycle policy applies to.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AMI_IMAGE | CONTAINER_IMAGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AMI_IMAGE", "CONTAINER_IMAGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#cfn-imagebuilder-lifecyclepolicy-resourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyDetails": { "MarkdownDocumentation": "`PolicyDetails`\n\nConfiguration details for the lifecycle policy rules.\n*Required*: Yes\n*Type*: Array of [PolicyDetail](./aws-properties-imagebuilder-lifecyclepolicy-policydetail.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#cfn-imagebuilder-lifecyclepolicy-policydetails", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PolicyDetail", "DuplicatesAllowed": true }, "ExecutionRole": { "MarkdownDocumentation": "`ExecutionRole`\n\nThe name or Amazon Resource Name (ARN) for the IAM role you create that grants\nImage Builder access to run lifecycle actions.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#cfn-imagebuilder-lifecyclepolicy-executionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceSelection": { "MarkdownDocumentation": "`ResourceSelection`\n\nSelection criteria for the resources that the lifecycle policy applies to.\n*Required*: Yes\n*Type*: [ResourceSelection](./aws-properties-imagebuilder-lifecyclepolicy-resourceselection.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#cfn-imagebuilder-lifecyclepolicy-resourceselection", "UpdateType": "Mutable", "Required": true, "Type": "ResourceSelection" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to apply to the lifecycle policy resource.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#cfn-imagebuilder-lifecyclepolicy-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the lifecycle policy to create.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#cfn-imagebuilder-lifecyclepolicy-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the lifecycle policy resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-lifecyclepolicy.html#Arn-fn::getatt" } } }, "AWS::ImageBuilder::Workflow": { "MarkdownDocumentation": "`AWS::ImageBuilder::Workflow`\n\nCreate a new workflow or a new version of an existing workflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe phase in the image build process for which the workflow resource\nis responsible.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `BUILD | TEST | DISTRIBUTION...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "BUILD", "TEST", "DISTRIBUTION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nDescribes the workflow.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource.\nThis can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)\nin the *AWS Key Management Service Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Version": { "MarkdownDocumentation": "`Version`\n\nThe semantic version of this workflow resource. The semantic version syntax\nadheres to the following rules.\n###### Note\nThe semantic version has four nodes: ../.\nYou 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\nzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the\nbuild number to the fourth node.\n**Patterns:** You can use any numeric pattern that adheres to the assignment requirements for\nthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or\na date, such as 2021.01.01.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-version", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ChangeDescription": { "MarkdownDocumentation": "`ChangeDescription`\n\nDescribes what change has been made in this version of the workflow, or\nwhat makes this version different from other versions of the workflow.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-changedescription", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Data": { "MarkdownDocumentation": "`Data`\n\nContains the UTF-8 encoded YAML document content for the workflow.\nAlternatively, you can specify the `uri` of a YAML document file stored in\nAmazon S3. However, you cannot specify both properties.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `16000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-data", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Uri": { "MarkdownDocumentation": "`Uri`\n\nThe `uri` of a YAML component document file. This must be an S3 URL\n(`s3://bucket/key`), and the requester must have permission to access the\nS3 bucket it points to. If you use Amazon S3, you can specify component content up to your\nservice quota.\nAlternatively, you can specify the YAML document inline, using the component\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-uri", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags that apply to the workflow resource.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the workflow to create.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "LatestVersion": { "Type": "LatestVersion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#LatestVersion-fn::getatt" }, "LatestVersion.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Arn`\n\nThe latest version Amazon Resource Name (ARN) of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#LatestVersion.Arn-fn::getatt" }, "LatestVersion.Major": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Major`\n\nThe latest version Amazon Resource Name (ARN) with the same `major` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#LatestVersion.Major-fn::getatt" }, "LatestVersion.Minor": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Minor`\n\nThe latest version Amazon Resource Name (ARN) with the same `minor` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#LatestVersion.Minor-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the workflow resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#Arn-fn::getatt" }, "LatestVersion.Patch": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestVersion.Patch`\n\nThe latest version Amazon Resource Name (ARN) with the same `patch` version of the Image Builder resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#LatestVersion.Patch-fn::getatt" } } }, "AWS::Inspector::AssessmentTarget": { "MarkdownDocumentation": "`AWS::Inspector::AssessmentTarget`\n\nThe `AWS::Inspector::AssessmentTarget` resource is used to create Amazon\nInspector assessment targets, which specify the Amazon EC2 instances that will be analyzed\nduring an assessment run.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ResourceGroupArn` of the new assessment target.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html", "Properties": { "AssessmentTargetName": { "MarkdownDocumentation": "`AssessmentTargetName`\n\nThe name of the Amazon Inspector assessment target. The name must be unique within\nthe AWS account.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html#cfn-inspector-assessmenttarget-assessmenttargetname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceGroupArn": { "MarkdownDocumentation": "`ResourceGroupArn`\n\nThe ARN that specifies the resource group that is used to create the assessment\ntarget. If `resourceGroupArn` is not specified, all EC2 instances in the current AWS account\nand Region are included in the assessment target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html#cfn-inspector-assessmenttarget-resourcegrouparn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) that specifies the assessment target that is\ncreated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html#Arn-fn::getatt" } } }, "AWS::Inspector::AssessmentTemplate": { "MarkdownDocumentation": "`AWS::Inspector::AssessmentTemplate`\n\nThe `AWS::Inspector::AssessmentTemplate` resource creates an Amazon\nInspector assessment template, which specifies the Inspector assessment targets that will\nbe evaluated by an assessment run and its related configurations.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `AssessmentTargetArn` of the new assessment template.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html", "Properties": { "AssessmentTargetArn": { "MarkdownDocumentation": "`AssessmentTargetArn`\n\nThe ARN of the assessment target to be included in the assessment template.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-assessmenttargetarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DurationInSeconds": { "MarkdownDocumentation": "`DurationInSeconds`\n\nThe duration of the assessment run in seconds.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `180`\n*Maximum*: `86400`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-durationinseconds", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "AssessmentTemplateName": { "MarkdownDocumentation": "`AssessmentTemplateName`\n\nThe user-defined name that identifies the assessment template that you want to\ncreate. You can create several assessment templates for the same assessment target. The\nnames of the assessment templates that correspond to a particular assessment target must be\nunique.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-assessmenttemplatename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RulesPackageArns": { "MarkdownDocumentation": "`RulesPackageArns`\n\nThe ARNs of the rules packages that you want to use in the assessment\ntemplate.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-rulespackagearns", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UserAttributesForFindings": { "MarkdownDocumentation": "`UserAttributesForFindings`\n\nThe user-defined attributes that are assigned to every finding that is generated by\nthe assessment run that uses this assessment template. Within an assessment template, each\nkey must be unique.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-inspector-assessmenttemplate-tag.html)\n*Minimum*: `0`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-userattributesforfindings", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) that specifies the assessment template that is\ncreated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#Arn-fn::getatt" } } }, "AWS::Inspector::ResourceGroup": { "MarkdownDocumentation": "`AWS::Inspector::ResourceGroup`\n\nThe `AWS::Inspector::ResourceGroup` resource is used to create Amazon\nInspector resource groups. A resource group defines a set of tags that, when queried,\nidentify the AWS resources that make up the assessment target.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the new resource group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-resourcegroup.html", "Properties": { "ResourceGroupTags": { "MarkdownDocumentation": "`ResourceGroupTags`\n\nThe tags (key and value pairs) that will be associated with the resource\ngroup.\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: Yes\n*Type*: Array of [Tag](./aws-properties-inspector-resourcegroup-tag.html)\n*Minimum*: `1`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-resourcegroup.html#cfn-inspector-resourcegroup-resourcegrouptags", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) that specifies the resource group that is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-resourcegroup.html#Arn-fn::getatt" } } }, "AWS::InspectorV2::CisScanConfiguration": { "MarkdownDocumentation": "`AWS::InspectorV2::CisScanConfiguration`\n\nThe CIS scan configuration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the CIS scan configuration. For\nexample:\n`arn:aws:inspector2:us-east-1:012345678901:owner/012345678901/cis-configuration/c1c0fe5d28e39baa`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-cisscanconfiguration.html", "Properties": { "SecurityLevel": { "MarkdownDocumentation": "`SecurityLevel`\n\nThe CIS scan configuration's CIS Benchmark level.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LEVEL_1 | LEVEL_2...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEVEL_1", "LEVEL_2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-cisscanconfiguration.html#cfn-inspectorv2-cisscanconfiguration-securitylevel", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe CIS scan configuration's schedule.\n*Required*: Yes\n*Type*: [Schedule](./aws-properties-inspectorv2-cisscanconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-cisscanconfiguration.html#cfn-inspectorv2-cisscanconfiguration-schedule", "UpdateType": "Mutable", "Required": true, "Type": "Schedule" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe CIS scan configuration's targets.\n*Required*: Yes\n*Type*: [CisTargets](./aws-properties-inspectorv2-cisscanconfiguration-cistargets.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-cisscanconfiguration.html#cfn-inspectorv2-cisscanconfiguration-targets", "UpdateType": "Mutable", "Required": true, "Type": "CisTargets" }, "ScanName": { "MarkdownDocumentation": "`ScanName`\n\nThe name of the CIS scan configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-cisscanconfiguration.html#cfn-inspectorv2-cisscanconfiguration-scanname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe CIS scan configuration's tags.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^.{2,127}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-cisscanconfiguration.html#cfn-inspectorv2-cisscanconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe CIS scan configuration's scan configuration ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-cisscanconfiguration.html#Arn-fn::getatt" } } }, "AWS::InspectorV2::CodeSecurityIntegration": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityIntegration`\n\nCreates a code security integration with a source code repository provider.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the code security integration.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of repository provider for the integration.\n*Required*: No\n*Type*: String\n*Allowed values*: `GITLAB_SELF_MANAGED | GITHU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GITLAB_SELF_MANAGED", "GITHUB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#cfn-inspectorv2-codesecurityintegration-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreateIntegrationDetails": { "MarkdownDocumentation": "`CreateIntegrationDetails`\n\nContains details required to create a code security integration with a specific\nrepository provider.\n*Required*: No\n*Type*: [CreateDetails](./aws-properties-inspectorv2-codesecurityintegration-createdetails.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#cfn-inspectorv2-codesecurityintegration-createintegrationdetails", "UpdateType": "Immutable", "Required": false, "Type": "CreateDetails" }, "UpdateIntegrationDetails": { "MarkdownDocumentation": "`UpdateIntegrationDetails`\n\nThe updated integration details specific to the repository provider type.\n*Required*: No\n*Type*: [UpdateDetails](./aws-properties-inspectorv2-codesecurityintegration-updatedetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#cfn-inspectorv2-codesecurityintegration-updateintegrationdetails", "UpdateType": "Mutable", "Required": false, "Type": "UpdateDetails" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the code security integration.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^.{2,127}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#cfn-inspectorv2-codesecurityintegration-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the code security integration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_$:.]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#cfn-inspectorv2-codesecurityintegration-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#Status-fn::getatt" }, "AuthorizationUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`AuthorizationUrl`\n\nThe URL used to authorize the integration with the repository provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#AuthorizationUrl-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe timestamp when the code security integration was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#LastUpdatedAt-fn::getatt" }, "StatusReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusReason`\n\nThe reason for the current status of the code security integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#StatusReason-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the code security integration was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#CreatedAt-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the code security integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityintegration.html#Arn-fn::getatt" } } }, "AWS::InspectorV2::CodeSecurityScanConfiguration": { "MarkdownDocumentation": "`AWS::InspectorV2::CodeSecurityScanConfiguration`\n\nCreates a scan configuration for code security scanning.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the scan configuration.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityscanconfiguration.html", "Properties": { "ScopeSettings": { "MarkdownDocumentation": "`ScopeSettings`\n\nThe scope settings that define which repositories will be scanned.\n*Required*: No\n*Type*: [ScopeSettings](./aws-properties-inspectorv2-codesecurityscanconfiguration-scopesettings.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-scopesettings", "UpdateType": "Immutable", "Required": false, "Type": "ScopeSettings" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration settings for the code security scan.\n*Required*: No\n*Type*: [CodeSecurityScanConfiguration](./aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-configuration", "UpdateType": "Mutable", "Required": false, "Type": "CodeSecurityScanConfiguration" }, "Level": { "MarkdownDocumentation": "`Level`\n\nThe security level for the scan configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `ORGANIZATION | ACCOUNT...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ORGANIZATION", "ACCOUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-level", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to apply to the scan configuration.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^.{2,127}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the scan configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_$:.]*$`\n*Minimum*: `1`\n*Maximum*: `60`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the scan configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityscanconfiguration.html#Arn-fn::getatt" } } }, "AWS::InspectorV2::Filter": { "MarkdownDocumentation": "`AWS::InspectorV2::Filter`\n\nDetails about a filter.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the filter. For example:\n`arn:aws:inspector2:us-east-1:012345678901:owner/012345678901/filter/c1c0fe5d28e39baa`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-filter.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-filter.html#cfn-inspectorv2-filter-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FilterCriteria": { "MarkdownDocumentation": "`FilterCriteria`\n\nDetails on the filter criteria associated with this filter.\n*Required*: Yes\n*Type*: [FilterCriteria](./aws-properties-inspectorv2-filter-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-filter.html#cfn-inspectorv2-filter-filtercriteria", "UpdateType": "Mutable", "Required": true, "Type": "FilterCriteria" }, "FilterAction": { "MarkdownDocumentation": "`FilterAction`\n\nThe action that is to be applied to the findings that match the filter.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `NONE | SUPPRESS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "SUPPRESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-filter.html#cfn-inspectorv2-filter-filteraction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags attached to the filter.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^.{2,127}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-filter.html#cfn-inspectorv2-filter-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the filter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-filter.html#cfn-inspectorv2-filter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Number (ARN) associated with this filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-filter.html#Arn-fn::getatt" } } }, "AWS::InternetMonitor::Monitor": { "MarkdownDocumentation": "`AWS::InternetMonitor::Monitor`\n\nThe `AWS::InternetMonitor::Monitor` resource is an Internet Monitor resource type that contains information about how\nyou create a monitor in Amazon CloudWatch Internet Monitor. A monitor in Internet Monitor provides visibility into performance and\navailability between your applications hosted on AWS and your end users, using a traffic profile that it creates\nbased on the application resources that you add: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces directories.\nInternet Monitor also alerts you to internet issues that impact your application in the city-networks (geographies and networks)\nwhere your end users use it. With Internet Monitor, you can quickly pinpoint the locations and providers that are affected, so\nthat you can address the issue.\nFor more information, see [Using Amazon CloudWatch Internet Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) in the *Amazon CloudWatch User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the monitor, such as\n`arn:aws:internetmonitor:us-east-1:111122223333:monitor/TestMonitor`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of a monitor. The accepted values that you can specify for `Status` are `ACTIVE` and `INACTIVE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `PENDING | 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)", "RefReturnValue": "", "AllowedValues": [ "PENDING", "ACTIVE", "INACTIVE", "ERROR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LinkedAccountId": { "MarkdownDocumentation": "`LinkedAccountId`\n\nThe account ID for an account that you've set up cross-account sharing for in Internet Monitor. You configure cross-account\nsharing by using Amazon CloudWatch Observability Access Manager. For more information, see\n[Internet Monitor cross-account\nobservability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html) in the Amazon CloudWatch User Guide.\n*Required*: No\n*Type*: String\n*Pattern*: `^(\\d{12})$`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-linkedaccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrafficPercentageToMonitor": { "MarkdownDocumentation": "`TrafficPercentageToMonitor`\n\nThe percentage of the internet-facing traffic for your application that you want to monitor. You can also, optionally, set\na limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for.\nThe city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of\nthe percentage of traffic that you choose to monitor.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-trafficpercentagetomonitor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "IncludeLinkedAccounts": { "MarkdownDocumentation": "`IncludeLinkedAccounts`\n\nA boolean option that you can set to `TRUE` to include monitors for linked accounts in a list of\nmonitors, when you've set up cross-account sharing in Internet Monitor. You configure cross-account\nsharing by using Amazon CloudWatch Observability Access Manager. For more information, see\n[Internet Monitor cross-account\nobservability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html) in the Amazon CloudWatch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-includelinkedaccounts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "HealthEventsConfig": { "MarkdownDocumentation": "`HealthEventsConfig`\n\nA complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event\nfor an overall performance or availability issue, across an application's geographies.\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds\nfor when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores,\nor both.\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks,\nin addition to creating an event when an overall score crosses a threshold.\nIf you don't set a health event threshold, the default value is 95%.\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event.\nIn addition, you can disable local thresholds, for performance scores, availability scores, or both.\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide*.\n*Required*: No\n*Type*: [HealthEventsConfig](./aws-properties-internetmonitor-monitor-healtheventsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-healtheventsconfig", "UpdateType": "Mutable", "Required": false, "Type": "HealthEventsConfig" }, "ResourcesToAdd": { "MarkdownDocumentation": "`ResourcesToAdd`\n\nThe resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be Amazon\nVirtual Private Cloud VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, or Amazon WorkSpaces directories.\nYou can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't\nadd NLBs or WorkSpaces directories together with any other resources.\nIf you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.\n###### Note\nYou can specify this field for a monitor update only if the `Resources` field is empty.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resourcestoadd", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "InternetMeasurementsLogDelivery": { "MarkdownDocumentation": "`InternetMeasurementsLogDelivery`\n\nPublish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket.\nMeasurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically\ninternet service providers or ISPs).\n*Required*: No\n*Type*: [InternetMeasurementsLogDelivery](./aws-properties-internetmonitor-monitor-internetmeasurementslogdelivery.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-internetmeasurementslogdelivery", "UpdateType": "Mutable", "Required": false, "Type": "InternetMeasurementsLogDelivery" }, "MonitorName": { "MarkdownDocumentation": "`MonitorName`\n\nThe name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.),\nand underscores (\\_).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-monitorname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourcesToRemove": { "MarkdownDocumentation": "`ResourcesToRemove`\n\nThe resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)\n###### Note\nYou can specify this field for a monitor update only if the `Resources` field is empty.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resourcestoremove", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Resources": { "MarkdownDocumentation": "`Resources`\n\nThe resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). Use this option to add or\nremove resources when making an update.\n###### Note\nBe aware that if you include content in the `Resources` field when you update a monitor, the `ResourcesToAdd`\nand `ResourcesToRemove` fields must be empty.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resources", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "MaxCityNetworksToMonitor": { "MarkdownDocumentation": "`MaxCityNetworksToMonitor`\n\nThe maximum number of city-networks to monitor for your resources. A city-network is the location (city) where\nclients access your application resources from and the network, such as an internet service provider, that clients\naccess the resources through.\nFor more information, see [Choosing a city-network maximum value](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) in *Using Amazon CloudWatch Internet Monitor*.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `500000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-maxcitynetworkstomonitor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for a monitor, listed as a set of *key:value* pairs.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-internetmonitor-monitor-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe last time that the monitor was modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#ModifiedAt-fn::getatt" }, "MonitorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MonitorArn`\n\nThe Amazon Resource Name (ARN) of the monitor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#MonitorArn-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time when the monitor was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#CreatedAt-fn::getatt" }, "ProcessingStatusInfo": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProcessingStatusInfo`\n\nAdditional information about the health of the data processing for the monitor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#ProcessingStatusInfo-fn::getatt" }, "ProcessingStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProcessingStatus`\n\nThe health of data processing for the monitor. For more information, see `ProcessingStatus` under\n[MonitorListMember](https://docs.aws.amazon.com/internet-monitor/latest/api/API_MonitorListMember.html) in the *Amazon CloudWatch Internet Monitor API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#ProcessingStatus-fn::getatt" } } }, "AWS::Invoicing::InvoiceUnit": { "MarkdownDocumentation": "`AWS::Invoicing::InvoiceUnit`\n\nAn invoice unit is a set of mutually exclusive account that correspond to your business entity. Invoice units allow you separate AWS account costs and configures your invoice for each business entity going forward.\n", "RefReturnValue": "\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe assigned description for an invoice unit. This information can't be modified or deleted.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\S\\s]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TaxInheritanceDisabled": { "MarkdownDocumentation": "`TaxInheritanceDisabled`\n\nWhether the invoice unit based tax inheritance is/ should be enabled or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-taxinheritancedisabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\nThe tag structure that contains a tag key and value.\n*Required*: No\n*Type*: Array of [ResourceTag](./aws-properties-invoicing-invoiceunit-resourcetag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceTag", "DuplicatesAllowed": true }, "Rule": { "MarkdownDocumentation": "`Rule`\n\nAn `InvoiceUnitRule` object used the categorize invoice units.\n*Required*: Yes\n*Type*: [Rule](./aws-properties-invoicing-invoiceunit-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-rule", "UpdateType": "Mutable", "Required": true, "Type": "Rule" }, "InvoiceReceiver": { "MarkdownDocumentation": "`InvoiceReceiver`\n\nThe account that receives invoices related to the invoice unit.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-invoicereceiver", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA unique name that is distinctive within your AWS.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?|\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html", "Properties": { "CustomDocumentEnrichmentConfiguration": { "MarkdownDocumentation": "`CustomDocumentEnrichmentConfiguration`\n\nConfiguration information for altering document metadata and content during the\ndocument ingestion process.\n*Required*: No\n*Type*: [CustomDocumentEnrichmentConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CustomDocumentEnrichmentConfiguration" }, "IndexId": { "MarkdownDocumentation": "`IndexId`\n\nThe identifier of the index you want to use with the data source connector.\n*Required*: Yes\n*Type*: String\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-indexid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LanguageCode": { "MarkdownDocumentation": "`LanguageCode`\n\nThe code for a language. This shows a supported language for all documents\nin the data source. English is supported by default.\nFor more information on supported languages, including their codes,\nsee [Adding\ndocuments in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-languagecode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the data source.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `S3 | SHAREPOINT | SALESFORC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "S3", "SHAREPOINT", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "DATABASE", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "TEMPLATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the data source connector.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nSets the frequency that Amazon Kendra checks the documents in your data source and\nupdates the index. If you don't set a schedule, Amazon Kendra doesn't periodically\nupdate the index.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-schedule", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSourceConfiguration": { "MarkdownDocumentation": "`DataSourceConfiguration`\n\nConfiguration information for an Amazon Kendra data source. The contents of the\nconfiguration depend on the type of data source. You can only specify one type of data\nsource in the configuration.\nYou can't specify the `Configuration` parameter when the `Type`\nparameter is set to `CUSTOM`.\nThe `Configuration` parameter is required for all other data\nsources.\n*Required*: No\n*Type*: [DataSourceConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-datasourceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DataSourceConfiguration" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of a role with permission to access the data\nsource.\nYou can't specify the `RoleArn` parameter when the `Type`\nparameter is set to `CUSTOM`.\nThe `RoleArn` parameter is required for all other data sources.\n*Required*: No\n*Type*: String\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*Minimum*: `1`\n*Maximum*: `1284`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-kendra-datasource-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the data source.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier for the data source. For example:\n`b8cae438-6787-4091-8897-684a652bbb0a`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the data source. For example:\n`arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/data-source/b8cae438-6787-4091-8897-684a652bbb0a`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#Arn-fn::getatt" } } }, "AWS::Kendra::Faq": { "MarkdownDocumentation": "`AWS::Kendra::Faq`\n\nCreates an new set of frequently asked question (FAQ) questions and answers.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the FAQ identifier. For example:\n`{ \"Ref\": \"|\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html", "Properties": { "IndexId": { "MarkdownDocumentation": "`IndexId`\n\nThe identifier of the index that contains the FAQ.\n*Required*: Yes\n*Type*: String\n*Minimum*: `36`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-indexid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LanguageCode": { "MarkdownDocumentation": "`LanguageCode`\n\nThe code for a language. This shows a supported language for the FAQ document\nas part of the summary information for FAQs. English is supported by default.\nFor more information on supported languages, including their codes,\nsee [Adding\ndocuments in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-languagecode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the FAQ.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "S3Path": { "MarkdownDocumentation": "`S3Path`\n\nThe Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.\n*Required*: Yes\n*Type*: [S3Path](./aws-properties-kendra-faq-s3path.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-s3path", "UpdateType": "Immutable", "Required": true, "Type": "S3Path" }, "FileFormat": { "MarkdownDocumentation": "`FileFormat`\n\nThe format of the input file. You can choose between a basic CSV format, a CSV format\nthat includes customs attributes in a header, and a JSON format that includes custom\nattributes.\nThe format must match the format of the file stored in the S3 bucket identified in\nthe S3Path parameter.\nValid values are:\n* `CSV`\n* `CSV_WITH_HEADER`\n* `JSON`\n*Required*: No\n*Type*: String\n*Allowed values*: `CSV | CSV_WITH_HEADER | JSO...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CSV", "CSV_WITH_HEADER", "JSON" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-fileformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that\ncontains the FAQ.\n*Required*: Yes\n*Type*: String\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*Minimum*: `1`\n*Maximum*: `1284`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-kendra-faq-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier for the FAQ. For example:\n`f61995a6-cd5c-4e99-9cfc-58816d8bfaa7`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\n`arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#Arn-fn::getatt" } } }, "AWS::Kendra::Index": { "MarkdownDocumentation": "`AWS::Kendra::Index`\n\nCreates an Amazon Kendra index\nOnce the index is active you can add documents to your index using the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/BatchPutDocument.html) operation or using one of the supported data sources.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the index ID. For example:\n`{\"Ref\": \"index-id\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the index.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "UserContextPolicy": { "MarkdownDocumentation": "`UserContextPolicy`\n\nThe user context policy.\nATTRIBUTE\\_FILTER\n* All indexed content is searchable and displayable for all users. If you want\n to filter search results on user context, you can use the attribute filters of\n `_user_id` and `_group_ids` or you can provide user\n and group information in `UserContext`.\nUSER\\_TOKEN\n* Enables token-based user access control to filter search results on user\n context. All documents with no access control and all documents accessible to\n the user will be searchable and displayable.\n*Required*: No\n*Type*: String\n*Allowed values*: `ATTRIBUTE_FILTER | USER_TOK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ATTRIBUTE_FILTER", "USER_TOKEN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-usercontextpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityUnits": { "MarkdownDocumentation": "`CapacityUnits`\n\nSpecifies additional capacity units configured for your Enterprise Edition index. You\ncan add and remove capacity units to fit your usage requirements.\n*Required*: No\n*Type*: [CapacityUnitsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-capacityunits", "UpdateType": "Mutable", "Required": false, "Type": "CapacityUnitsConfiguration" }, "ServerSideEncryptionConfiguration": { "MarkdownDocumentation": "`ServerSideEncryptionConfiguration`\n\nThe identifier of the AWS KMS customer managed key (CMK) to use to\nencrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric\nCMKs.\n*Required*: No\n*Type*: [ServerSideEncryptionConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-serversideencryptionconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "ServerSideEncryptionConfiguration" }, "DocumentMetadataConfigurations": { "MarkdownDocumentation": "`DocumentMetadataConfigurations`\n\nSpecifies the properties of an index field. You can add either a custom or a built-in\nfield. You can add and remove built-in fields at any time. When a built-in field is\nremoved it's configuration reverts to the default for the field. Custom fields can't be\nremoved from an index after they are added.\n*Required*: No\n*Type*: Array of [DocumentMetadataConfiguration](./aws-properties-kendra-index-documentmetadataconfiguration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-documentmetadataconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DocumentMetadataConfiguration", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-kendra-index-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nAn IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs\nand metrics. This is also the role used when you use the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/BatchPutDocument.html) operation to\nindex documents from an Amazon S3 bucket.\n*Required*: Yes\n*Type*: String\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*Minimum*: `1`\n*Maximum*: `1284`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Edition": { "MarkdownDocumentation": "`Edition`\n\nIndicates whether the index is a Enterprise Edition index, a Developer Edition index,\nor a GenAI Enterprise Edition index.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEVELOPER_EDITION | ENTERPR...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DEVELOPER_EDITION", "ENTERPRISE_EDITION", "GEN_AI_ENTERPRISE_EDITION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-edition", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the index.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UserTokenConfigurations": { "MarkdownDocumentation": "`UserTokenConfigurations`\n\nDefines the type of user token used for the index.\n*Required*: No\n*Type*: Array of [UserTokenConfiguration](./aws-properties-kendra-index-usertokenconfiguration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-usertokenconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "UserTokenConfiguration", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier for the index. For example:\n`f4aeaa10-8056-4b2c-a343-522ca0f41234`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the index. For example:\n`arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#Arn-fn::getatt" } } }, "AWS::KendraRanking::ExecutionPlan": { "MarkdownDocumentation": "`AWS::KendraRanking::ExecutionPlan`\n\nCreates a rescore execution plan. A rescore execution\nplan is an Amazon Kendra Intelligent Ranking resource\nused for provisioning the `Rescore` API. You set\nthe number of capacity units that you require for\nAmazon Kendra Intelligent Ranking to rescore or re-rank\na search service's results.\nFor an example of using the\n`CreateRescoreExecutionPlan` API, including using\nthe Python and Java SDKs, see [Semantically\nranking a search service's results](https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the rescore execution plan ID. For example:\n`{\"Ref\": \"rescore-execution-plan-id\"}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendraranking-executionplan.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the rescore execution plan.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendraranking-executionplan.html#cfn-kendraranking-executionplan-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CapacityUnits": { "MarkdownDocumentation": "`CapacityUnits`\n\nYou can set additional capacity units to meet the\nneeds of your rescore execution plan. You are given a single\ncapacity unit by default. If you want to use the default\ncapacity, you don't set additional capacity units. For more\ninformation on the default capacity and additional capacity\nunits, see [Adjusting\ncapacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).\n*Required*: No\n*Type*: [CapacityUnitsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendraranking-executionplan.html#cfn-kendraranking-executionplan-capacityunits", "UpdateType": "Mutable", "Required": false, "Type": "CapacityUnitsConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs that identify or categorize your\nrescore execution plan. You can also use tags to help control\naccess to the rescore execution plan. Tag keys and values can\nconsist of Unicode letters, digits, white space. They can also\nconsist of underscore, period, colon, equal, plus, and asperand.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-kendraranking-executionplan-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendraranking-executionplan.html#cfn-kendraranking-executionplan-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the rescore execution plan.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendraranking-executionplan.html#cfn-kendraranking-executionplan-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier of the rescore execution plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendraranking-executionplan.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the rescore\nexecution plan.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendraranking-executionplan.html#Arn-fn::getatt" } } }, "AWS::Kinesis::ResourcePolicy": { "MarkdownDocumentation": "`AWS::Kinesis::ResourcePolicy`\n\nAttaches a resource-based policy to a data stream or registered consumer. If you are using an identity other than the root user of\nthe AWS account that owns the resource, the calling identity must have the `PutResourcePolicy` permissions on the\nspecified Kinesis Data Streams resource and belong to the owner's account in order to use this operation.\nIf you don't have `PutResourcePolicy` permissions, Amazon Kinesis Data Streams returns a `403 Access Denied error`.\nIf you receive a `ResourceNotFoundException`, check to see if you passed a valid stream or consumer resource.\nRequest patterns can be one of the following:\n* Data stream pattern: `arn:aws.*:kinesis:.*:\\d{12}:.*stream/\\S+`\n* Consumer pattern: `^(arn):aws.*:kinesis:.*:\\d{12}:.*stream\\/[a-zA-Z0-9_.-]+\\/consumer\\/[a-zA-Z0-9_.-]+:[0-9]+`\nFor more information, see [Controlling Access to Amazon Kinesis Data Streams Resources Using IAM](https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-resourcepolicy.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nReturns the Amazon Resource Name (ARN) of the resource-based policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws.*:kinesis:.*:\\d{12}:stream/\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-resourcepolicy.html#cfn-kinesis-resourcepolicy-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nThis is the description for the resource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-resourcepolicy.html#cfn-kinesis-resourcepolicy-resourcepolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::Kinesis::Stream": { "MarkdownDocumentation": "`AWS::Kinesis::Stream`\n\nCreates a Kinesis stream that captures and transports data records that are emitted\nfrom data sources. For information about creating streams, see [CreateStream](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html) in the Amazon Kinesis API Reference.\n", "RefReturnValue": "\nWhen you specify an AWS::Kinesis::Stream resource as an argument to the\n`Ref` function, AWS CloudFormation returns the stream\nname (physical ID).\nFor more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html", "Properties": { "StreamModeDetails": { "MarkdownDocumentation": "`StreamModeDetails`\n\nSpecifies the capacity mode to which you want to set your data stream. Currently, in\nKinesis Data Streams, you can choose between an **on-demand** capacity mode and a **provisioned** capacity mode for your data streams.\n*Required*: No\n*Type*: [StreamModeDetails](./aws-properties-kinesis-stream-streammodedetails.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-streammodedetails", "UpdateType": "Mutable", "Required": false, "Type": "StreamModeDetails" }, "StreamEncryption": { "MarkdownDocumentation": "`StreamEncryption`\n\nWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack\ntemplate and updating your stack disables encryption.\n*Required*: No\n*Type*: [StreamEncryption](./aws-properties-kinesis-stream-streamencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-streamencryption", "UpdateType": "Mutable", "Required": false, "Type": "StreamEncryption" }, "WarmThroughputMiBps": { "MarkdownDocumentation": "`WarmThroughputMiBps`\n\nThe target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-warmthroughputmibps", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxRecordSizeInKiB": { "MarkdownDocumentation": "`MaxRecordSizeInKiB`\n\nThe maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1024`\n*Maximum*: `10240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-maxrecordsizeinkib", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RetentionPeriodHours": { "MarkdownDocumentation": "`RetentionPeriodHours`\n\nThe number of hours for the data records that are stored in shards to remain\naccessible. The default value is 24. For more information about the stream retention\nperiod, see [Changing the Data Retention\nPeriod](https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html) in the Amazon Kinesis Developer Guide.\n*Required*: No\n*Type*: Integer\n*Minimum*: `24`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-retentionperiodhours", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DesiredShardLevelMetrics": { "MarkdownDocumentation": "`DesiredShardLevelMetrics`\n\nA list of shard-level metrics in properties to enable enhanced monitoring mode.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-desiredshardlevelmetrics", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key\u2013value pairs) to associate with the Kinesis stream.\nFor information about constraints for this property, see [Tag Restrictions](https://docs.aws.amazon.com/streams/latest/dev/tagging.html#tagging-restrictions)\nin the *Amazon Kinesis Developer Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-kinesis-stream-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Kinesis stream. If you don't specify a name, AWS\nCloudFormation generates a unique physical ID and uses that ID for the stream name. For\nmore 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\nresource. You can perform updates that require no or some interruption. If you must\nreplace the resource, specify a new name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ShardCount": { "MarkdownDocumentation": "`ShardCount`\n\nThe number of shards that the stream uses. For greater provisioned throughput,\nincrease the number of shards.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-shardcount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "WarmThroughputObject.CurrentMiBps": { "PrimitiveType": "Integer", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#WarmThroughputObject.CurrentMiBps-fn::getatt" }, "WarmThroughputObject.TargetMiBps": { "PrimitiveType": "Integer", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#WarmThroughputObject.TargetMiBps-fn::getatt" }, "WarmThroughputObject": { "Type": "WarmThroughputObject", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#WarmThroughputObject-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon resource name (ARN) of the Kinesis stream, such as\n`arn:aws:kinesis:us-east-2:123456789012:stream/mystream`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#Arn-fn::getatt" } } }, "AWS::Kinesis::StreamConsumer": { "MarkdownDocumentation": "`AWS::Kinesis::StreamConsumer`\n\nUse the AWS CloudFormation\n`AWS::Kinesis::StreamConsumer` resource to register a consumer with a\nKinesis data stream. The consumer you register can then call [SubscribeToShard](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_SubscribeToShard.html)\nto receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per\nsecond for every shard you subscribe to. This rate is unaffected by the total number of\nconsumers that read from the same stream.\nYou can register up to 20 consumers per stream. However, you can request a limit\nincrease using the [Kinesis Data Streams limits\nform](https://console.aws.amazon.com/support/v1?#/). A given consumer can only be registered with one stream at a time.\nFor more information, see [Using Consumers\nwith Enhanced Fan-Out](https://docs.aws.amazon.com/streams/latest/dev/introduction-to-enhanced-consumers.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::Kinesis::StreamConsumer`\nresource to the intrinsic Ref function, the function returns the consumer ARN. For\nexample ARN formats, see [Example\nARNs](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax).\nFor more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html", "Properties": { "ConsumerName": { "MarkdownDocumentation": "`ConsumerName`\n\nThe name of the consumer is something you choose when you register the\nconsumer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#cfn-kinesis-streamconsumer-consumername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StreamARN": { "MarkdownDocumentation": "`StreamARN`\n\nThe ARN of the stream with which you registered the consumer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws.*:kinesis:.*:\\d{12}:stream/\\S+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#cfn-kinesis-streamconsumer-streamarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tags to be added to a specified Kinesis resource. A tag consists of a required key and an optional value. You can specify up to 50 tag key-value pairs.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-kinesis-streamconsumer-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#cfn-kinesis-streamconsumer-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ConsumerCreationTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConsumerCreationTimestamp`\n\nThe time at which the consumer was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#ConsumerCreationTimestamp-fn::getatt" }, "ConsumerName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConsumerName`\n\nThe name you gave the consumer when you registered it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#ConsumerName-fn::getatt" }, "ConsumerARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConsumerARN`\n\nWhen you register a consumer, Kinesis Data Streams generates an ARN for it. You\nneed this ARN to be able to call [SubscribeToShard](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_SubscribeToShard.html).\nIf you delete a consumer and then create a new one with the same name, it won't\nhave the same ARN. That's because consumer ARNs contain the creation timestamp. This is\nimportant to keep in mind if you have IAM policies that reference consumer ARNs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#ConsumerARN-fn::getatt" }, "ConsumerStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConsumerStatus`\n\nA consumer can't read data while in the `CREATING` or\n`DELETING` states.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#ConsumerStatus-fn::getatt" }, "StreamARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`StreamARN`\n\nThe ARN of the data stream with which the consumer is registered.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html#StreamARN-fn::getatt" } } }, "AWS::KinesisAnalytics::Application": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::Application`\n\nThe `AWS::KinesisAnalytics::Application` resource creates an Amazon Kinesis Data Analytics application. For more information, see the [Amazon Kinesis Data Analytics Developer Guide](/kinesisanalytics/latest/dev/what-is.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html", "Properties": { "ApplicationName": { "Required": false, "MarkdownDocumentation": "`ApplicationName`\n\nName of your Amazon Kinesis Analytics application (for example,\n`sample-app`).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Inputs": { "Type": "List", "Required": true, "MarkdownDocumentation": "`Inputs`\n\nUse this parameter to configure the application input.\nYou can configure your application to receive input from a single streaming source. In\nthis configuration, you map this streaming source to an in-application stream that is\ncreated. Your application code can then query the in-application stream like a table\n(you can think of it as a constantly updating table).\nFor the streaming source, you provide its Amazon Resource Name (ARN) and format of\ndata on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role\nthat Amazon Kinesis Analytics can assume to read this stream on your behalf.\nTo create the in-application stream, you need to specify a schema to transform your\ndata into a schematized version used in SQL. In the schema, you provide the necessary\nmapping of the data elements in the streaming source to record columns in the in-app\nstream.\n*Required*: Yes\n*Type*: Array of [Input](./aws-properties-kinesisanalytics-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-inputs", "ItemType": "Input", "UpdateType": "Mutable" }, "ApplicationDescription": { "Required": false, "MarkdownDocumentation": "`ApplicationDescription`\n\nSummary 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationdescription", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ApplicationCode": { "Required": false, "MarkdownDocumentation": "`ApplicationCode`\n\nOne or more SQL statements that read input data, transform it, and generate output.\nFor example, you can write a SQL statement that reads data from one in-application\nstream, generates a running average of the number of advertisement clicks by vendor, and\ninsert resulting rows in another in-application stream using pumps. For more information\nabout the typical pattern, see [Application\nCode](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\nused as the input for the next statement. You store intermediate results by creating\nin-application streams and pumps.\nNote that the application code must create the streams with names specified in the\n`Outputs`. For example, if your `Outputs` defines output\nstreams named `ExampleOutputStream1` and `ExampleOutputStream2`,\nthen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationcode", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationOutput": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationOutput`\n\nAdds an external destination to your Amazon Kinesis Analytics application.\nIf you want Amazon Kinesis Analytics to deliver data from an in-application stream\nwithin your application to an external destination (such as an Amazon Kinesis stream, an\nAmazon Kinesis Firehose delivery stream, or an Amazon Lambda function), you add the\nrelevant configuration to your application using this operation. You can configure one\nor more outputs for your application. Each output configuration maps an in-application\nstream and an external destination.\nYou can use one of the output configurations to deliver data from your\nin-application error stream to an external destination so that you can analyze the\nerrors. For more information, see [Understanding Application\nOutput (Destination)](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).\nAny configuration update, including adding a streaming source using this\noperation, results in a new version of the application. You can use the `DescribeApplication` operation to find the current application\nversion.\nFor the limits on the number of application inputs and outputs\nyou can configure, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).\nThis operation requires permissions to perform the `kinesisanalytics:AddApplicationOutput` action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html", "Properties": { "ApplicationName": { "Required": true, "MarkdownDocumentation": "`ApplicationName`\n\nName of the application to which you want to add the output configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html#cfn-kinesisanalytics-applicationoutput-applicationname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Output": { "Type": "Output", "Required": true, "MarkdownDocumentation": "`Output`\n\nAn array of objects, each describing one output configuration. In the output\nconfiguration, you specify the name of an in-application stream, a destination (that is,\nan Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the\ndestination.\n*Required*: Yes\n*Type*: [Output](./aws-properties-kinesisanalytics-applicationoutput-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html#cfn-kinesisanalytics-applicationoutput-output", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalytics::ApplicationReferenceDataSource": { "MarkdownDocumentation": "`AWS::KinesisAnalytics::ApplicationReferenceDataSource`\n\nAdds a reference data source to an existing application.\nAmazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.\nFor conceptual information,\nsee [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).\nFor the limits on data sources you can add to your application, see\n[Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).\nThis operation requires permissions to perform the `kinesisanalytics:AddApplicationOutput` action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html", "Properties": { "ApplicationName": { "Required": true, "MarkdownDocumentation": "`ApplicationName`\n\nName of an existing application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-applicationname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ReferenceDataSource": { "Type": "ReferenceDataSource", "Required": true, "MarkdownDocumentation": "`ReferenceDataSource`\n\nThe reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis\nAnalytics reads the object and copies the data into the in-application table that is\ncreated. You provide an S3 bucket, object key name, and the resulting in-application\ntable that is created. You must also provide an IAM role with the necessary permissions\nthat Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your\nbehalf.\n*Required*: Yes\n*Type*: [ReferenceDataSource](./aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::Application": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::Application`\n\nCreates an Amazon Kinesis Data Analytics application. For information about creating a\nKinesis Data Analytics application, see [Creating an\nApplication](https://docs.aws.amazon.com/managed-flink/latest/java/getting-started.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html", "Properties": { "ApplicationName": { "MarkdownDocumentation": "`ApplicationName`\n\nThe name of the application.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RuntimeEnvironment": { "MarkdownDocumentation": "`RuntimeEnvironment`\n\nThe runtime environment for the application.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SQL-1_0 | FLINK-1_6 | FLINK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-runtimeenvironment", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RunConfiguration": { "MarkdownDocumentation": "`RunConfiguration`\n\nDescribes the starting parameters for an Managed Service for Apache Flink application.\n*Required*: No\n*Type*: [RunConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-runconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RunConfiguration" }, "ApplicationMode": { "MarkdownDocumentation": "`ApplicationMode`\n\nTo create a Kinesis Data Analytics Studio notebook, you must set the mode to\n`INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink\napplication, 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)", "RefReturnValue": "", "AllowedValues": [ "INTERACTIVE", "STREAMING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationmode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ApplicationMaintenanceConfiguration": { "MarkdownDocumentation": "`ApplicationMaintenanceConfiguration`\n\nSpecifies the maintenance window parameters for a Kinesis Data Analytics\napplication.\n*Required*: No\n*Type*: [ApplicationMaintenanceConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationmaintenanceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationMaintenanceConfiguration" }, "ApplicationConfiguration": { "MarkdownDocumentation": "`ApplicationConfiguration`\n\nUse this parameter to configure the application.\n*Required*: No\n*Type*: [ApplicationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationConfiguration" }, "ApplicationDescription": { "MarkdownDocumentation": "`ApplicationDescription`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationdescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of one or more tags to assign to the application. A tag is a key-value pair\nthat identifies an application. Note that the maximum number of application tags\nincludes system tags. The maximum number of user-defined application tags is 50.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-kinesisanalyticsv2-application-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ServiceExecutionRole": { "MarkdownDocumentation": "`ServiceExecutionRole`\n\nSpecifies the IAM role that the application uses to access external resources.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-serviceexecutionrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption`\n\nAdds an Amazon CloudWatch log stream to monitor application configuration\nerrors.\n###### Note\nOnly one *ApplicationCloudWatchLoggingOption* resource can be\nattached per application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationcloudwatchloggingoption.html", "Properties": { "ApplicationName": { "Required": true, "MarkdownDocumentation": "`ApplicationName`\n\nThe name 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationcloudwatchloggingoption.html#cfn-kinesisanalyticsv2-applicationcloudwatchloggingoption-applicationname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "CloudWatchLoggingOption": { "Type": "CloudWatchLoggingOption", "Required": true, "MarkdownDocumentation": "`CloudWatchLoggingOption`\n\nProvides a description of Amazon CloudWatch logging options, including the log stream\nAmazon Resource Name (ARN).\n*Required*: Yes\n*Type*: [CloudWatchLoggingOption](./aws-properties-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationcloudwatchloggingoption.html#cfn-kinesisanalyticsv2-applicationcloudwatchloggingoption-cloudwatchloggingoption", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationOutput": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationOutput`\n\nAdds an external destination to your SQL-based Amazon Kinesis Data Analytics\napplication.\nIf you want Kinesis Data Analytics to deliver data from an in-application stream\nwithin your application to an external destination (such as an Kinesis data stream, a\nKinesis Data Firehose delivery stream, or an Amazon Lambda function), you add the\nrelevant configuration to your application using this operation. You can configure one\nor more outputs for your application. Each output configuration maps an in-application\nstream and an external destination.\nYou can use one of the output configurations to deliver data from your in-application\nerror stream to an external destination so that you can analyze the errors.\nAny configuration update, including adding a streaming source using this operation,\nresults in a new version of the application. You can use the [DescribeApplication](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_DescribeApplication.html) operation to find the current application\nversion.\n###### Note\nCreation of multiple outputs should be sequential (use of DependsOn) to avoid a\nproblem with a stale application version\n(*ConcurrentModificationException*).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationoutput.html", "Properties": { "ApplicationName": { "Required": true, "MarkdownDocumentation": "`ApplicationName`\n\nThe name 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationoutput.html#cfn-kinesisanalyticsv2-applicationoutput-applicationname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Output": { "Type": "Output", "Required": true, "MarkdownDocumentation": "`Output`\n\nDescribes a SQL-based Kinesis Data Analytics application's output configuration,\nin which you identify an in-application stream and a destination where you want the\nin-application stream data to be written. The destination can be a Kinesis data stream or a\nKinesis Data Firehose delivery stream.\n*Required*: Yes\n*Type*: [Output](./aws-properties-kinesisanalyticsv2-applicationoutput-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationoutput.html#cfn-kinesisanalyticsv2-applicationoutput-output", "UpdateType": "Mutable" } } }, "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource": { "MarkdownDocumentation": "`AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource`\n\nAdds a reference data source to an existing SQL-based Kinesis Data Analytics application.\nKinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an\nin-application table within your application. In the request, you provide the source (S3\nbucket name and object key name), name of the in-application table to create, and the\nnecessary mapping information that describes how data in an Amazon S3 object maps to columns\nin the resulting in-application table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html", "Properties": { "ApplicationName": { "Required": true, "MarkdownDocumentation": "`ApplicationName`\n\nThe name 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-applicationname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ReferenceDataSource": { "Type": "ReferenceDataSource", "Required": true, "MarkdownDocumentation": "`ReferenceDataSource`\n\nFor a SQL-based Kinesis Data Analytics application, describes the reference data\nsource by providing the source information (Amazon S3 bucket name and object key name), the\nresulting in-application table name that is created, and the necessary schema to map the data\nelements in the Amazon S3 object to the in-application table.\n*Required*: Yes\n*Type*: [ReferenceDataSource](./aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource", "UpdateType": "Mutable" } } }, "AWS::KinesisFirehose::DeliveryStream": { "MarkdownDocumentation": "`AWS::KinesisFirehose::DeliveryStream`\n\nThe `AWS::KinesisFirehose::DeliveryStream` resource specifies an Amazon\nKinesis Data Firehose (Kinesis Data Firehose) delivery stream that delivers real-time\nstreaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon\nElasticsearch Service (Amazon ES) destination. For more information, see [Creating an Amazon\nKinesis Data Firehose Delivery Stream](https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html) in the *Amazon Kinesis Data\nFirehose Developer Guide*.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the delivery stream name, such as\n`mystack-deliverystream-1ABCD2EF3GHIJ`.\nFor more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html", "Properties": { "DeliveryStreamEncryptionConfigurationInput": { "MarkdownDocumentation": "`DeliveryStreamEncryptionConfigurationInput`\n\nSpecifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side\nEncryption (SSE).\n*Required*: No\n*Type*: [DeliveryStreamEncryptionConfigurationInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput", "UpdateType": "Mutable", "Required": false, "Type": "DeliveryStreamEncryptionConfigurationInput" }, "HttpEndpointDestinationConfiguration": { "MarkdownDocumentation": "`HttpEndpointDestinationConfiguration`\n\nEnables configuring Kinesis Firehose to deliver data to any HTTP endpoint\ndestination. You can specify only one destination.\n*Required*: No\n*Type*: [HttpEndpointDestinationConfiguration](./aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HttpEndpointDestinationConfiguration" }, "KinesisStreamSourceConfiguration": { "MarkdownDocumentation": "`KinesisStreamSourceConfiguration`\n\nWhen a Kinesis stream is used as the source for the delivery stream, a [KinesisStreamSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html) containing the Kinesis stream ARN and the role\nARN for the source stream.\n*Required*: No\n*Type*: [KinesisStreamSourceConfiguration](./aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "KinesisStreamSourceConfiguration" }, "DeliveryStreamType": { "MarkdownDocumentation": "`DeliveryStreamType`\n\nThe Firehose stream type. This can be one of the following values:\n* `DirectPut`: Provider applications access the Firehose stream\n directly.\n* `KinesisStreamAsSource`: The Firehose stream uses a Kinesis data\n stream as a source.\n*Required*: No\n*Type*: String\n*Allowed values*: `DatabaseAsSource | DirectPu...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DatabaseAsSource", "DirectPut", "KinesisStreamAsSource", "MSKAsSource" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IcebergDestinationConfiguration": { "MarkdownDocumentation": "`IcebergDestinationConfiguration`\n\nSpecifies the destination configure settings for Apache Iceberg Table.\n*Required*: No\n*Type*: [IcebergDestinationConfiguration](./aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IcebergDestinationConfiguration" }, "RedshiftDestinationConfiguration": { "MarkdownDocumentation": "`RedshiftDestinationConfiguration`\n\nAn Amazon Redshift destination for the delivery stream.\nConditional. You must specify only one destination configuration.\nIf you change the delivery stream destination from an Amazon Redshift destination to\nan Amazon ES destination, update requires [some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt).\n*Required*: Conditional\n*Type*: [RedshiftDestinationConfiguration](./aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "RedshiftDestinationConfiguration" }, "AmazonopensearchserviceDestinationConfiguration": { "MarkdownDocumentation": "`AmazonopensearchserviceDestinationConfiguration`\n\nThe destination in Amazon OpenSearch Service. You can specify only one\ndestination.\n*Required*: Conditional\n*Type*: [AmazonopensearchserviceDestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AmazonopensearchserviceDestinationConfiguration" }, "MSKSourceConfiguration": { "MarkdownDocumentation": "`MSKSourceConfiguration`\n\nThe configuration for the Amazon MSK cluster to be used as the source for a delivery\nstream.\n*Required*: No\n*Type*: [MSKSourceConfiguration](./aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "MSKSourceConfiguration" }, "DirectPutSourceConfiguration": { "MarkdownDocumentation": "`DirectPutSourceConfiguration`\n\nThe structure that configures parameters such as `ThroughputHintInMBs` for a stream configured with\nDirect PUT as a source.\n*Required*: No\n*Type*: [DirectPutSourceConfiguration](./aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-directputsourceconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "DirectPutSourceConfiguration" }, "SplunkDestinationConfiguration": { "MarkdownDocumentation": "`SplunkDestinationConfiguration`\n\nThe configuration of a destination in Splunk for the delivery stream.\n*Required*: No\n*Type*: [SplunkDestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SplunkDestinationConfiguration" }, "ExtendedS3DestinationConfiguration": { "MarkdownDocumentation": "`ExtendedS3DestinationConfiguration`\n\nAn Amazon S3 destination for the delivery stream.\nConditional. You must specify only one destination configuration.\nIf you change the delivery stream destination from an Amazon Extended S3 destination\nto an Amazon ES destination, update requires [some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt).\n*Required*: Conditional\n*Type*: [ExtendedS3DestinationConfiguration](./aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ExtendedS3DestinationConfiguration" }, "AmazonOpenSearchServerlessDestinationConfiguration": { "MarkdownDocumentation": "`AmazonOpenSearchServerlessDestinationConfiguration`\n\nDescribes the configuration of a destination in the Serverless offering for Amazon\nOpenSearch Service.\n*Required*: No\n*Type*: [AmazonOpenSearchServerlessDestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AmazonOpenSearchServerlessDestinationConfiguration" }, "ElasticsearchDestinationConfiguration": { "MarkdownDocumentation": "`ElasticsearchDestinationConfiguration`\n\nAn Amazon ES destination for the delivery stream.\nConditional. You must specify only one destination configuration.\nIf you change the delivery stream destination from an Amazon ES destination to an\nAmazon S3 or Amazon Redshift destination, update requires [some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt).\n*Required*: Conditional\n*Type*: [ElasticsearchDestinationConfiguration](./aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ElasticsearchDestinationConfiguration" }, "SnowflakeDestinationConfiguration": { "MarkdownDocumentation": "`SnowflakeDestinationConfiguration`\n\nConfigure Snowflake destination\n*Required*: No\n*Type*: [SnowflakeDestinationConfiguration](./aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SnowflakeDestinationConfiguration" }, "DatabaseSourceConfiguration": { "MarkdownDocumentation": "`DatabaseSourceConfiguration`\n\nThe top level object for configuring streams with database as a source.\nAmazon Data Firehose is in preview release and is subject to change.\n*Required*: No\n*Type*: [DatabaseSourceConfiguration](./aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "DatabaseSourceConfiguration" }, "S3DestinationConfiguration": { "MarkdownDocumentation": "`S3DestinationConfiguration`\n\nThe `S3DestinationConfiguration` property type specifies an Amazon Simple\nStorage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data\nFirehose) delivers data.\nConditional. You must specify only one destination configuration.\nIf you change the delivery stream destination from an Amazon S3 destination to an\nAmazon ES destination, update requires [some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt).\n*Required*: Conditional\n*Type*: [S3DestinationConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "S3DestinationConfiguration" }, "DeliveryStreamName": { "MarkdownDocumentation": "`DeliveryStreamName`\n\nThe name of the Firehose stream.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9._-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA set of tags to assign to the Firehose stream. A tag is a key-value pair that you can\ndefine and assign to AWS resources. Tags are metadata. For example, you can\nadd friendly names and descriptions or other types of information that can help you\ndistinguish the Firehose stream. For more information about tags, see [Using\nCost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User\nGuide.\nYou can specify up to 50 tags when creating a Firehose stream.\nIf you specify tags in the `CreateDeliveryStream` action, Amazon Data\nFirehose performs an additional authorization on the\n`firehose:TagDeliveryStream` action to verify if users have permissions to\ncreate tags. If you do not provide this permission, requests to create new Firehose streams\nwith IAM resource tags will fail with an `AccessDeniedException` such as\nfollowing.\n**AccessDeniedException**\nUser: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.\nFor an example IAM policy, see [Tag example.](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples)\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-kinesisfirehose-deliverystream-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the delivery stream, such as\n`arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#Arn-fn::getatt" } } }, "AWS::KinesisVideo::SignalingChannel": { "MarkdownDocumentation": "`AWS::KinesisVideo::SignalingChannel`\n\nSpecifies a signaling channel.\n`CreateSignalingChannel` is an asynchronous operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nA type of the signaling channel that you are creating. Currently,\n`SINGLE_MASTER` is the only supported channel type.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_MASTER...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_MASTER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MessageTtlSeconds": { "MarkdownDocumentation": "`MessageTtlSeconds`\n\nThe period of time (in seconds) a signaling channel retains undelivered messages\nbefore they are discarded. Use API\\_UpdateSignalingChannel to update\nthis value.\n*Required*: No\n*Type*: Integer\n*Minimum*: `5`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-messagettlseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-kinesisvideo-signalingchannel-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the signaling channel that you are creating. It must be unique for each AWS account and AWS Region.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the signaling channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#Arn-fn::getatt" } } }, "AWS::KinesisVideo::Stream": { "MarkdownDocumentation": "`AWS::KinesisVideo::Stream`\n\nSpecifies a new Kinesis video stream.\nWhen you create a new stream, Kinesis Video Streams assigns it a version number. When you\nchange the stream's metadata, Kinesis Video Streams updates the version.\n`CreateStream` is an asynchronous operation.\nFor information about how the service works, see [How it Works](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html).\nYou must have permissions for the `KinesisVideo:CreateStream` action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html", "Properties": { "StreamStorageConfiguration": { "MarkdownDocumentation": "`StreamStorageConfiguration`\n\nThe configuration for stream storage, including the default storage tier for stream data. This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization.\n*Required*: No\n*Type*: [StreamStorageConfiguration](./aws-properties-kinesisvideo-stream-streamstorageconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-streamstorageconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StreamStorageConfiguration" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams\nuses to encrypt data on the stream.\n*Required*: No\n*Type*: String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MediaType": { "MarkdownDocumentation": "`MediaType`\n\nThe `MediaType` of the stream.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+(,[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-mediatype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataRetentionInHours": { "MarkdownDocumentation": "`DataRetentionInHours`\n\nHow long the stream retains data, in hours.\n*Required*: No\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-dataretentioninhours", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-kinesisvideo-stream-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the stream.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeviceName": { "MarkdownDocumentation": "`DeviceName`\n\nThe name of the device that is associated with the stream.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-devicename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the stream.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#Arn-fn::getatt" } } }, "AWS::LakeFormation::DataCellsFilter": { "MarkdownDocumentation": "`AWS::LakeFormation::DataCellsFilter`\n\nA structure that represents a data cell filter with column-level, row-level, and/or cell-level security. Data cell filters belong to a specific table in a Data Catalog. During a stack operation,\nAWS CloudFormation calls the AWS Lake Formation`CreateDataCellsFilter` API operation to create\na `DataCellsFilter` resource, and calls the `DeleteDataCellsFilter` API operation to delete it.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource properties such as TableCatalogId, DatabaseName, TableName, and FilterName.\nFor example: 123456789012|ExampleDbName|ExampleTableName|ExampleFilterName\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nUTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html).\nA table in the database.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-tablename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ColumnNames": { "MarkdownDocumentation": "`ColumnNames`\n\nAn array of UTF-8 strings. A list of column names.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-columnnames", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RowFilter": { "MarkdownDocumentation": "`RowFilter`\n\nA PartiQL predicate.\n*Required*: No\n*Type*: [RowFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-rowfilter", "UpdateType": "Immutable", "Required": false, "Type": "RowFilter" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nUTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html).\nA database in the Data Catalog.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TableCatalogId": { "MarkdownDocumentation": "`TableCatalogId`\n\nCatalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html).\nThe ID of the catalog to which the table belongs.\n*Required*: Yes\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-tablecatalogid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nUTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html).\nThe name given by the user to the data filter cell.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ColumnWildcard": { "MarkdownDocumentation": "`ColumnWildcard`\n\nA wildcard with exclusions. You must specify either a `ColumnNames` list or the `ColumnWildCard`.\n*Required*: No\n*Type*: [ColumnWildcard](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-columnwildcard", "UpdateType": "Immutable", "Required": false, "Type": "ColumnWildcard" } } }, "AWS::LakeFormation::DataLakeSettings": { "MarkdownDocumentation": "`AWS::LakeFormation::DataLakeSettings`\n\nThe `AWS::LakeFormation::DataLakeSettings` resource is an AWS Lake Formation resource type that manages the data lake settings for your account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html", "Properties": { "AllowExternalDataFiltering": { "Required": false, "MarkdownDocumentation": "`AllowExternalDataFiltering`\n\nWhether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation.\nIf set to true, you allow Amazon EMR clusters or other third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.\nIf false or null, no third-party query engines will be able to access data in Amazon S3 locations that are registered with Lake Formation.\nFor more information, see [External data filtering setting](https://docs.aws.amazon.com/lake-formation/latest/dg/initial-LF-setup.html#external-data-filter).\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-allowexternaldatafiltering", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "ExternalDataFilteringAllowList": { "Type": "ExternalDataFilteringAllowList", "Required": false, "MarkdownDocumentation": "`ExternalDataFilteringAllowList`\n\nA list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.\n*Required*: No\n*Type*: Array of [DataLakePrincipal](./aws-properties-lakeformation-datalakesettings-datalakeprincipal.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-externaldatafilteringallowlist", "UpdateType": "Mutable" }, "CreateTableDefaultPermissions": { "Type": "CreateTableDefaultPermissions", "Required": false, "MarkdownDocumentation": "`CreateTableDefaultPermissions`\n\nSpecifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.\nA null value indicates that the access is controlled by Lake Formation permissions.\n`ALL` permissions assigned to `IAM_ALLOWED_PRINCIPALS` group\nindicate that the user's IAM permissions determine the access to the\ntable. This is referred to as the setting \"Use only IAM access control,\" and is to support\nthe backward compatibility with the AWS Glue permission model implemented by IAM\npermissions.\nThe only permitted values are an empty array or an array that contains a single JSON object that grants `ALL` permissions to `IAM_ALLOWED_PRINCIPALS`.\nFor more information, see [Changing the default security settings for your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html).\n*Required*: No\n*Type*: Array of [PrincipalPermissions](./aws-properties-lakeformation-datalakesettings-principalpermissions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-createtabledefaultpermissions", "UpdateType": "Mutable" }, "MutationType": { "Required": false, "MarkdownDocumentation": "`MutationType`\n\nSpecifies whether the data lake settings are updated by adding new values to the current\nsettings (`APPEND`) or by replacing the current settings with new settings (`REPLACE`).\n###### Note\nIf you choose `REPLACE`, your current data lake settings will be replaced with the new values in your 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-mutationtype", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Parameters": { "Required": false, "MarkdownDocumentation": "`Parameters`\n\nA key-value map that provides an additional configuration on your data lake. `CrossAccountVersion` is the key you can configure in the `Parameters` field. Accepted values for the `CrossAccountVersion` key are 1, 2, 3, and 4.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-parameters", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "ReadOnlyAdmins": { "Type": "ReadOnlyAdmins", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-readonlyadmins", "UpdateType": "Mutable" }, "AllowFullTableExternalDataAccess": { "Required": false, "MarkdownDocumentation": "`AllowFullTableExternalDataAccess`\n\nSpecifies whether query engines and applications can get credentials without IAM session tags if the user has full table access. It provides query engines and applications performance benefits as well as simplifies data access. Amazon EMR on Amazon EC2 is able to leverage this setting.\nFor more information, see \n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-allowfulltableexternaldataaccess", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Admins": { "Type": "Admins", "Required": false, "MarkdownDocumentation": "`Admins`\n\nA list of AWS Lake Formation principals.\n*Required*: No\n*Type*: Array of [DataLakePrincipal](./aws-properties-lakeformation-datalakesettings-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-admins", "UpdateType": "Mutable" }, "CreateDatabaseDefaultPermissions": { "Type": "CreateDatabaseDefaultPermissions", "Required": false, "MarkdownDocumentation": "`CreateDatabaseDefaultPermissions`\n\nSpecifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.\nA null value indicates that the access is controlled by Lake Formation permissions.\n`ALL` permissions assigned to `IAM_ALLOWED_PRINCIPALS` group\nindicates that the user's IAM permissions determine the access to the\ndatabase. This is referred to as the setting \"Use only IAM access control,\" and is to\nsupport backward compatibility with the AWS Glue permission model implemented by\nIAM permissions.\nThe only permitted values are an empty array or an array that contains a single JSON object that grants `ALL` to `IAM_ALLOWED_PRINCIPALS`.\nFor more information, see [Changing the default security settings for your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html).\n*Required*: No\n*Type*: Array of [PrincipalPermissions](./aws-properties-lakeformation-datalakesettings-principalpermissions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-createdatabasedefaultpermissions", "UpdateType": "Mutable" }, "AuthorizedSessionTagValueList": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`AuthorizedSessionTagValueList`\n\nLake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = \"LakeFormationTrustedCaller\" and value = \"TRUE\" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation's administrative API operations.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-authorizedsessiontagvaluelist", "UpdateType": "Mutable" }, "TrustedResourceOwners": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`TrustedResourceOwners`\n\nAn 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.\nYou 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-trustedresourceowners", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::Permissions": { "MarkdownDocumentation": "`AWS::LakeFormation::Permissions`\n\nThe `AWS::LakeFormation::Permissions` resource represents the permissions that a principal has on an AWS Glue Data Catalog resource (such as AWS Glue database or AWS Glue tables). When you upload a permissions stack, the permissions are granted to the principal and when you remove the stack, the permissions are revoked from the principal. If you remove a stack, and the principal does not have the permissions referenced in the stack then AWS Lake Formation will throw an error because you can\u2019t call revoke on non-existing permissions. To successfully remove the stack, you\u2019ll need to regrant those permissions and then remove the stack.\n###### Note\nNew versions of AWS Lake Formation permission resources are now available. For more information, see: [AWS:LakeFormation::PrincipalPermissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html", "Properties": { "DataLakePrincipal": { "Type": "DataLakePrincipal", "Required": true, "MarkdownDocumentation": "`DataLakePrincipal`\n\nThe AWS Lake Formation principal.\n*Required*: Yes\n*Type*: [DataLakePrincipal](./aws-properties-lakeformation-permissions-datalakeprincipal.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-datalakeprincipal", "UpdateType": "Immutable" }, "Resource": { "Type": "Resource", "Required": true, "MarkdownDocumentation": "`Resource`\n\nA structure for the resource.\n*Required*: Yes\n*Type*: [Resource](./aws-properties-lakeformation-permissions-resource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-resource", "UpdateType": "Immutable" }, "Permissions": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`Permissions`\n\nThe permissions granted or revoked.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-permissions", "UpdateType": "Mutable" }, "PermissionsWithGrantOption": { "PrimitiveItemType": "String", "Type": "List", "Required": false, "MarkdownDocumentation": "`PermissionsWithGrantOption`\n\nIndicates the ability to grant permissions (as a subset of permissions granted).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-permissionswithgrantoption", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::PrincipalPermissions": { "MarkdownDocumentation": "`AWS::LakeFormation::PrincipalPermissions`\n\nThe `AWS::LakeFormation::PrincipalPermissions` resource represents the permissions that a principal has on a Data Catalog resource (such as AWS Glue databases or AWS Glue tables).\nWhen you create a `PrincipalPermissions` resource, the permissions are granted via the AWS Lake Formation`GrantPermissions` API operation. When you delete a `PrincipalPermissions` resource, the permissions on principal-resource pair are revoked via the AWS Lake Formation`RevokePermissions` API operation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the primary identifier of the resource. The primary identifier of the resource is a combination of `ResourceIdentifier` and `PrincipalIdentifier`\nseparated by a pipe.\nFor example:\n`{\"DataLakePrincipalIdentifier\":\"arn:aws:iam::123456789012:role/ExampleRole\"}|{\"Catalog\":null,\"Database\":null,\"Table\":null,\"TableWithColumns\":null,\"DataLocation\":null,\"DataCellsFilter\":{\"TableCatalogId\":\"123456789012\",\"DatabaseName\":\"ExampleDatabase\",\"TableName\":\"ExampleTable\",\"Name\":\"ExampleFilter\"},\"LFTag\":null,\"LFTagPolicy\":null}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html", "Properties": { "Resource": { "MarkdownDocumentation": "`Resource`\n\nThe resource to be granted or revoked permissions.\n*Required*: Yes\n*Type*: [Resource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-resource", "UpdateType": "Immutable", "Required": true, "Type": "Resource" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nThe permissions granted or revoked.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-permissions", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Catalog": { "MarkdownDocumentation": "`Catalog`\n\nThe identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store.\nIt contains database definitions, table definitions, and other control information to manage your Lake Formation environment.\n*Required*: No\n*Type*: String\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-catalog", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe principal to be granted a permission.\n*Required*: Yes\n*Type*: [DataLakePrincipal](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-principal", "UpdateType": "Immutable", "Required": true, "Type": "DataLakePrincipal" }, "PermissionsWithGrantOption": { "MarkdownDocumentation": "`PermissionsWithGrantOption`\n\nIndicates the ability to grant permissions (as a subset of permissions granted).\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-permissionswithgrantoption", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "ResourceIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceIdentifier`\n\nJson encoding of the input resource. For example: `{\"Catalog\":null,\"Database\":null,\"Table\":null,\"TableWithColumns\":null,\"DataLocation\":null,\"DataCellsFilter\":{\"TableCatalogId\":\"123456789012\",\"DatabaseName\":\"ExampleDatabase\",\"TableName\":\"ExampleTable\",\"Name\":\"ExampleFilter\"},\"LFTag\":null,\"LFTagPolicy\":null}`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#ResourceIdentifier-fn::getatt" }, "PrincipalIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrincipalIdentifier`\n\nJson encoding of the input principal. For example: `{\"DataLakePrincipalIdentifier\":\"arn:aws:iam::123456789012:role/ExampleRole\"}`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#PrincipalIdentifier-fn::getatt" } } }, "AWS::LakeFormation::Resource": { "MarkdownDocumentation": "`AWS::LakeFormation::Resource`\n\nThe `AWS::LakeFormation::Resource` represents the data ( buckets and folders) that is being registered with AWS Lake Formation.\nDuring a stack operation, AWS CloudFormation calls the AWS Lake Formation[`RegisterResource`](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-credential-vending.html#aws-lake-formation-api-credential-vending-RegisterResource) API operation to register the resource.\nTo remove a `Resource` type, AWS CloudFormation calls the AWS Lake Formation[`DeregisterResource`](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-credential-vending.html#aws-lake-formation-api-credential-vending-DeregisterResource) API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html", "Properties": { "ResourceArn": { "Required": true, "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-resourcearn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "WithFederation": { "Required": false, "MarkdownDocumentation": "`WithFederation`\n\nAllows Lake Formation to assume a role to access tables in a federated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-withfederation", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "UseServiceLinkedRole": { "Required": true, "MarkdownDocumentation": "`UseServiceLinkedRole`\n\nDesignates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-useservicelinkedrole", "PrimitiveType": "Boolean", "UpdateType": "Conditional" }, "HybridAccessEnabled": { "Required": false, "MarkdownDocumentation": "`HybridAccessEnabled`\n\nIndicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-hybridaccessenabled", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "RoleArn": { "Required": false, "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role that registered a resource.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws: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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::LakeFormation::Tag": { "MarkdownDocumentation": "`AWS::LakeFormation::Tag`\n\nThe `AWS::LakeFormation::Tag` resource represents an LF-tag, which consists of a key and one or more possible values for the key.\nDuring a stack operation, AWS CloudFormation calls the AWS Lake Formation`CreateLFTag` API to create a tag, and `UpdateLFTag` API to update a tag resource, and a `DeleteLFTag` to delete it.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Tag\u2019s `TagKey` property value.\nFor example: `tagKeyName`\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html", "Properties": { "TagKey": { "MarkdownDocumentation": "`TagKey`\n\nUTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html).\nThe key-name for the LF-tag.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([{a-zA-Z}{\\s}{0-9}_.:\\/=+\\-@%]*)$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html#cfn-lakeformation-tag-tagkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CatalogId": { "MarkdownDocumentation": "`CatalogId`\n\nCatalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html).\nThe identifier for the Data Catalog. By default, the account ID.\nThe 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*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html#cfn-lakeformation-tag-catalogid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TagValues": { "MarkdownDocumentation": "`TagValues`\n\nAn array of UTF-8 strings, not less than 1 or more than 50 strings.\nA list of possible values of the corresponding `TagKey` of an LF-tag key-value pair.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html#cfn-lakeformation-tag-tagvalues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::LakeFormation::TagAssociation": { "MarkdownDocumentation": "`AWS::LakeFormation::TagAssociation`\n\nThe `AWS::LakeFormation::TagAssociation` resource represents an assignment of an LF-tag to a Data Catalog resource (database, table, or column).\nDuring a stack operation, CloudFormation calls AWS Lake Formation`AddLFTagsToResource` API to create a `TagAssociation` resource and calls the `RemoveLFTagsToResource` API to delete it.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a combination of the `ResourceIdentifier` and `TagsIdentifier` seperated with a pipe.\nFor example: `{\"Catalog\":null,\"Database\":{\"CatalogId\":null,\"Name\":\"ExampleDbName\"},\"Table\":null,\"TableWithColumns\":null}|[{\"CatalogId\":null,\"TagKey\":\"tagKey1\",\"TagValues\":null}]`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html", "Properties": { "LFTags": { "MarkdownDocumentation": "`LFTags`\n\nA structure containing an LF-tag key-value pair.\n*Required*: Yes\n*Type*: Array of [LFTagPair](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html#cfn-lakeformation-tagassociation-lftags", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "LFTagPair", "DuplicatesAllowed": true }, "Resource": { "MarkdownDocumentation": "`Resource`\n\nUTF-8 string (valid values: `DATABASE | TABLE`).\nThe resource for which the LF-tag policy applies.\n*Required*: Yes\n*Type*: [Resource](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html#cfn-lakeformation-tagassociation-resource", "UpdateType": "Immutable", "Required": true, "Type": "Resource" } }, "Attributes": { "ResourceIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceIdentifier`\n\nJson encoding of the input resource.\n###### Examples\n* Database:`{\"Catalog\":null,\"Database\":{\"CatalogId\":\"123456789012\",\"Name\":\"ExampleDbName\"},\"Table\":null,\"TableWithColumns\":null}`\n* Table: `{\"Catalog\":null,\"Database\":null,\"Table\":{\"CatalogId\":\"123456789012\",\"DatabaseName\":\"ExampleDbName\",\"Name\":\"ExampleTableName\",\"TableWildcard\":null},\"TableWithColumns\":null}`\n* Columns: `{\"Catalog\":null,\"Database\":null,\"Table\":null,\"TableWithColumns\":{\"CatalogId\":\"123456789012\",\"DatabaseName\":\"ExampleDbName\",\"Name\":\"ExampleTableName\",\"ColumnNames\":[\"ExampleColName1\",\"ExampleColName2\"]}}`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html#ResourceIdentifier-fn::getatt" }, "TagsIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`TagsIdentifier`\n\nJson encoding of the input LFTags list.\nFor example: `[{\"CatalogId\":null,\"TagKey\":\"tagKey1\",\"TagValues\":null},{\"CatalogId\":null,\"TagKey\":\"tagKey2\",\"TagValues\":null}]`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html#TagsIdentifier-fn::getatt" } } }, "AWS::Lambda::Alias": { "MarkdownDocumentation": "`AWS::Lambda::Alias`\n\nThe `AWS::Lambda::Alias` resource creates an [alias](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) for a Lambda function version. Use aliases to\nprovide clients with a function identifier that you can update to invoke a different version.\nYou can also map an alias to split invocation requests between two versions. Use the\n`RoutingConfig` parameter to specify a second version and the percentage of invocation requests that\nit receives.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html", "Properties": { "FunctionName": { "MarkdownDocumentation": "`FunctionName`\n\nThe name or ARN of the Lambda function.\n###### Name formats\n* **Function name** - `MyFunction`.\n* **Function ARN** - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction`.\n* **Partial ARN** - `123456789012:function:MyFunction`.\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\ncharacters in length.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProvisionedConcurrencyConfig": { "MarkdownDocumentation": "`ProvisionedConcurrencyConfig`\n\nSpecifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.\n*Required*: No\n*Type*: [ProvisionedConcurrencyConfiguration](./aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig", "UpdateType": "Mutable", "Required": false, "Type": "ProvisionedConcurrencyConfiguration" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FunctionVersion": { "MarkdownDocumentation": "`FunctionVersion`\n\nThe function version that the alias invokes.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(\\$LATEST|[0-9]+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoutingConfig": { "MarkdownDocumentation": "`RoutingConfig`\n\nThe [routing\nconfiguration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.\n*Required*: No\n*Type*: [AliasRoutingConfiguration](./aws-properties-lambda-alias-aliasroutingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig", "UpdateType": "Mutable", "Required": false, "Type": "AliasRoutingConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the alias.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AliasArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AliasArn`\n\nThe Amazon Resource Name (ARN) of the alias.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#AliasArn-fn::getatt" } } }, "AWS::Lambda::CapacityProvider": { "MarkdownDocumentation": "`AWS::Lambda::CapacityProvider`\n\nCreates a capacity provider that manages compute resources for Lambda functions\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html", "Properties": { "CapacityProviderScalingConfig": { "MarkdownDocumentation": "`CapacityProviderScalingConfig`\n\nThe scaling configuration for the capacity provider.\n*Required*: No\n*Type*: [CapacityProviderScalingConfig](./aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig", "UpdateType": "Mutable", "Required": false, "Type": "CapacityProviderScalingConfig" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the KMS key used to encrypt the capacity provider's resources.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$`\n*Minimum*: `0`\n*Maximum*: `10000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nThe VPC configuration for the capacity provider.\n*Required*: Yes\n*Type*: [CapacityProviderVpcConfig](./aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig", "UpdateType": "Immutable", "Required": true, "Type": "CapacityProviderVpcConfig" }, "CapacityProviderName": { "MarkdownDocumentation": "`CapacityProviderName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:capacity-provider:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+$`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityprovidername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InstanceRequirements": { "MarkdownDocumentation": "`InstanceRequirements`\n\nThe instance requirements for compute resources managed by the capacity provider.\n*Required*: No\n*Type*: [InstanceRequirements](./aws-properties-lambda-capacityprovider-instancerequirements.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements", "UpdateType": "Immutable", "Required": false, "Type": "InstanceRequirements" }, "PermissionsConfig": { "MarkdownDocumentation": "`PermissionsConfig`\n\nThe permissions configuration for the capacity provider.\n*Required*: Yes\n*Type*: [CapacityProviderPermissionsConfig](./aws-properties-lambda-capacityprovider-capacityproviderpermissionsconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-permissionsconfig", "UpdateType": "Immutable", "Required": true, "Type": "CapacityProviderPermissionsConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA key-value pair that provides metadata for the capacity provider.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lambda-capacityprovider-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the capacity provider.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#State-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#Arn-fn::getatt" } } }, "AWS::Lambda::CodeSigningConfig": { "MarkdownDocumentation": "`AWS::Lambda::CodeSigningConfig`\n\nDetails about a [Code signing configuration](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nCode signing configuration description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllowedPublishers": { "MarkdownDocumentation": "`AllowedPublishers`\n\nList of allowed publishers.\n*Required*: Yes\n*Type*: [AllowedPublishers](./aws-properties-lambda-codesigningconfig-allowedpublishers.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-allowedpublishers", "UpdateType": "Mutable", "Required": true, "Type": "AllowedPublishers" }, "CodeSigningPolicies": { "MarkdownDocumentation": "`CodeSigningPolicies`\n\nThe code signing policy controls the validation failure action for signature mismatch or expiry.\n*Required*: No\n*Type*: [CodeSigningPolicies](./aws-properties-lambda-codesigningconfig-codesigningpolicies.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-codesigningpolicies", "UpdateType": "Mutable", "Required": false, "Type": "CodeSigningPolicies" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to add to the code signing configuration.\n###### Note\nYou must have the `lambda:TagResource`, `lambda:UntagResource`,\nand `lambda:ListTags` permissions for your [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CloudFormation stack. If you\ndon't have these permissions, there might be unexpected behavior with stack-level tags\npropagating to the resource during resource creation and update.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lambda-codesigningconfig-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CodeSigningConfigId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CodeSigningConfigId`\n\nThe code signing configuration ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#CodeSigningConfigId-fn::getatt" }, "CodeSigningConfigArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CodeSigningConfigArn`\n\nThe Amazon Resource Name (ARN) of the code signing configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#CodeSigningConfigArn-fn::getatt" } } }, "AWS::Lambda::EventInvokeConfig": { "MarkdownDocumentation": "`AWS::Lambda::EventInvokeConfig`\n\nThe `AWS::Lambda::EventInvokeConfig` resource configures options for [asynchronous invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) on a version or an alias.\nBy default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains\nevents in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous\ninvocation queue for too long, Lambda discards it.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html", "Properties": { "FunctionName": { "MarkdownDocumentation": "`FunctionName`\n\nThe name of the Lambda function.\n*Minimum*: `1`\n*Maximum*: `64`\n*Pattern*: `([a-zA-Z0-9-_]+)`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]+(-[a-z]+)+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST(\\.PUBLISHED)?|[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MaximumRetryAttempts": { "MarkdownDocumentation": "`MaximumRetryAttempts`\n\nThe maximum number of times to retry when the function returns an error.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DestinationConfig": { "MarkdownDocumentation": "`DestinationConfig`\n\nA destination for events after they have been sent to a function for processing.\n###### Destinations\n* **Function** - The Amazon Resource Name (ARN) of a Lambda function.\n* **Queue** - The ARN of a standard SQS queue.\n* **Bucket** - The ARN of an Amazon S3 bucket.\n* **Topic** - The ARN of a standard SNS topic.\n* **Event Bus** - The ARN of an Amazon EventBridge event bus.\n###### Note\nS3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.\n*Required*: No\n*Type*: [DestinationConfig](./aws-properties-lambda-eventinvokeconfig-destinationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig", "UpdateType": "Mutable", "Required": false, "Type": "DestinationConfig" }, "Qualifier": { "MarkdownDocumentation": "`Qualifier`\n\nThe identifier of a version or alias.\n* **Version** - A version number.\n* **Alias** - An alias name.\n* **Latest** - To specify the unpublished version, use\n `$LATEST`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\$(LATEST(\\.PUBLISHED)?)|[a-zA-Z0-9$_-]{1,129}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MaximumEventAgeInSeconds": { "MarkdownDocumentation": "`MaximumEventAgeInSeconds`\n\nThe maximum age of a request that Lambda sends to a function for processing.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `21600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } } }, "AWS::Lambda::EventSourceMapping": { "MarkdownDocumentation": "`AWS::Lambda::EventSourceMapping`\n\nThe `AWS::Lambda::EventSourceMapping` resource creates a mapping between an event source and\nan AWS Lambda function. Lambda reads items from the event source and triggers the function.\nFor details about each event source type, see the following topics. In particular, each of the topics\ndescribes the required and optional parameters for the specific event source.\n* [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)\n* [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)\n* [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)\n* [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)\n* [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)\n* [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)\n* [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the mapping's ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html", "Properties": { "StartingPosition": { "MarkdownDocumentation": "`StartingPosition`\n\nThe position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.\n* **LATEST** - Read only new records.\n* **TRIM\\_HORIZON** - Process all available records.\n* **AT\\_TIMESTAMP** - Specify a time from which to start reading records.\n*Required*: No\n*Type*: String\n*Pattern*: `(LATEST|TRIM_HORIZON|AT_TIMESTAMP)+`\n*Minimum*: `6`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SelfManagedEventSource": { "MarkdownDocumentation": "`SelfManagedEventSource`\n\nThe self-managed Apache Kafka cluster for your event source.\n*Required*: No\n*Type*: [SelfManagedEventSource](./aws-properties-lambda-eventsourcemapping-selfmanagedeventsource.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource", "UpdateType": "Immutable", "Required": false, "Type": "SelfManagedEventSource" }, "ParallelizationFactor": { "MarkdownDocumentation": "`ParallelizationFactor`\n\n(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "FilterCriteria": { "MarkdownDocumentation": "`FilterCriteria`\n\nAn object that defines the filter criteria that\ndetermine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).\n*Required*: No\n*Type*: [FilterCriteria](./aws-properties-lambda-eventsourcemapping-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria", "UpdateType": "Mutable", "Required": false, "Type": "FilterCriteria" }, "ProvisionedPollerConfig": { "MarkdownDocumentation": "`ProvisionedPollerConfig`\n\n(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source.\nFor more information, see [provisioned mode](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode).\n*Required*: No\n*Type*: [ProvisionedPollerConfig](./aws-properties-lambda-eventsourcemapping-provisionedpollerconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig", "UpdateType": "Mutable", "Required": false, "Type": "ProvisionedPollerConfig" }, "MetricsConfig": { "MarkdownDocumentation": "`MetricsConfig`\n\nThe metrics configuration for your event source. For more information, see [Event source mapping metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics).\n*Required*: No\n*Type*: [MetricsConfig](./aws-properties-lambda-eventsourcemapping-metricsconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig", "UpdateType": "Mutable", "Required": false, "Type": "MetricsConfig" }, "FunctionName": { "MarkdownDocumentation": "`FunctionName`\n\nThe name or ARN of the Lambda function.\n###### Name formats\n* **Function name** \u2013 `MyFunction`.\n* **Function ARN** \u2013 `arn:aws:lambda:us-west-2:123456789012:function:MyFunction`.\n* **Version or Alias ARN** \u2013 `arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD`.\n* **Partial ARN** \u2013 `123456789012:function:MyFunction`.\nThe length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\ncharacters in length.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST(\\.PUBLISHED)?|[a-zA-Z0-9-_]+))?`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DestinationConfig": { "MarkdownDocumentation": "`DestinationConfig`\n\n(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.\n*Required*: No\n*Type*: [DestinationConfig](./aws-properties-lambda-eventsourcemapping-destinationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig", "UpdateType": "Mutable", "Required": false, "Type": "DestinationConfig" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the AWS Key Management Service (AWS KMS) customer managed key that Lambda\nuses to encrypt your function's [filter criteria](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics).\n*Required*: No\n*Type*: String\n*Pattern*: `(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()`\n*Minimum*: `12`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AmazonManagedKafkaEventSourceConfig": { "MarkdownDocumentation": "`AmazonManagedKafkaEventSourceConfig`\n\nSpecific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.\n*Required*: No\n*Type*: [AmazonManagedKafkaEventSourceConfig](./aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig", "UpdateType": "Mutable", "Required": false, "Type": "AmazonManagedKafkaEventSourceConfig" }, "SourceAccessConfigurations": { "MarkdownDocumentation": "`SourceAccessConfigurations`\n\nAn array of the authentication protocol, VPC components, or virtual host to secure and define your event source.\n*Required*: No\n*Type*: Array of [SourceAccessConfiguration](./aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)\n*Minimum*: `1`\n*Maximum*: `22`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SourceAccessConfiguration", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to add to the event source mapping.\n###### Note\nYou must have the `lambda:TagResource`, `lambda:UntagResource`,\nand `lambda:ListTags` permissions for your [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CloudFormation stack. If you\ndon't have these permissions, there might be unexpected behavior with stack-level tags\npropagating to the resource during resource creation and update.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lambda-eventsourcemapping-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "MaximumBatchingWindowInSeconds": { "MarkdownDocumentation": "`MaximumBatchingWindowInSeconds`\n\nThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n**Default (Kinesis, DynamoDB, Amazon SQS event sources)**: 0\n**Default (Amazon MSK, Kafka, Amazon MQ, Amazon DocumentDB event sources)**: 500 ms\n**Related setting:** For Amazon SQS event sources, when you set `BatchSize`\nto a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "BatchSize": { "MarkdownDocumentation": "`BatchSize`\n\nThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n(6 MB).\n* **Amazon Kinesis** \u2013 Default 100. Max 10,000.\n* **Amazon DynamoDB Streams** \u2013 Default 100. Max 10,000.\n* **Amazon Simple Queue Service** \u2013 Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.\n* **Amazon Managed Streaming for Apache Kafka** \u2013 Default 100. Max 10,000.\n* **Self-managed Apache Kafka** \u2013 Default 100. Max 10,000.\n* **Amazon MQ (ActiveMQ and RabbitMQ)** \u2013 Default 100. Max 10,000.\n* **DocumentDB** \u2013 Default 100. Max 10,000.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaximumRetryAttempts": { "MarkdownDocumentation": "`MaximumRetryAttempts`\n\n(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is -1,\nwhich sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Topics": { "MarkdownDocumentation": "`Topics`\n\nThe name of the Kafka topic.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `249 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ScalingConfig": { "MarkdownDocumentation": "`ScalingConfig`\n\nThis property is for Amazon SQS event sources only. You cannot use `ProvisionedPollerConfig` while using `ScalingConfig`.\nThese options are mutually exclusive. To remove the scaling configuration, pass an empty value.\n*Required*: No\n*Type*: [ScalingConfig](./aws-properties-lambda-eventsourcemapping-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-scalingconfig", "UpdateType": "Mutable", "Required": false, "Type": "ScalingConfig" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nWhen true, the event source mapping is active. When false, Lambda pauses polling and invocation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EventSourceArn": { "MarkdownDocumentation": "`EventSourceArn`\n\nThe Amazon Resource Name (ARN) of the event source.\n* **Amazon Kinesis** \u2013 The ARN of the data stream or a stream consumer.\n* **Amazon DynamoDB Streams** \u2013 The ARN of the stream.\n* **Amazon Simple Queue Service** \u2013 The ARN of the queue.\n* **Amazon Managed Streaming for Apache Kafka** \u2013 The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).\n* **Amazon MQ** \u2013 The ARN of the broker.\n* **Amazon DocumentDB** \u2013 The ARN of the DocumentDB change stream.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)`\n*Minimum*: `12`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SelfManagedKafkaEventSourceConfig": { "MarkdownDocumentation": "`SelfManagedKafkaEventSourceConfig`\n\nSpecific configuration settings for a self-managed Apache Kafka event source.\n*Required*: No\n*Type*: [SelfManagedKafkaEventSourceConfig](./aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig", "UpdateType": "Mutable", "Required": false, "Type": "SelfManagedKafkaEventSourceConfig" }, "DocumentDBEventSourceConfig": { "MarkdownDocumentation": "`DocumentDBEventSourceConfig`\n\nSpecific configuration settings for a DocumentDB event source.\n*Required*: No\n*Type*: [DocumentDBEventSourceConfig](./aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig", "UpdateType": "Mutable", "Required": false, "Type": "DocumentDBEventSourceConfig" }, "TumblingWindowInSeconds": { "MarkdownDocumentation": "`TumblingWindowInSeconds`\n\n(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.\n*Required*: No\n*Type*: Integer\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "BisectBatchOnFunctionError": { "MarkdownDocumentation": "`BisectBatchOnFunctionError`\n\n(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.\n###### Note\nWhen using `BisectBatchOnFunctionError`, check the `BatchSize` parameter in the `OnFailure` destination message's metadata. The `BatchSize`\ncould be greater than 1 since Lambda consolidates failed messages metadata when writing to the `OnFailure` destination.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MaximumRecordAgeInSeconds": { "MarkdownDocumentation": "`MaximumRecordAgeInSeconds`\n\n(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is -1,\nwhich sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.\n###### Note\nThe minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed\n*Required*: No\n*Type*: Integer\n*Minimum*: `-1`\n*Maximum*: `604800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StartingPositionTimestamp": { "MarkdownDocumentation": "`StartingPositionTimestamp`\n\nWith `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start\nreading, in Unix time seconds. `StartingPositionTimestamp` cannot be in the future.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "LoggingConfig": { "MarkdownDocumentation": "`LoggingConfig`\n\nThe function's Amazon CloudWatch Logs configuration settings.\n*Required*: No\n*Type*: [LoggingConfig](./aws-properties-lambda-eventsourcemapping-loggingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-loggingconfig", "UpdateType": "Mutable", "Required": false, "Type": "LoggingConfig" }, "Queues": { "MarkdownDocumentation": "`Queues`\n\n(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `1000 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "FunctionResponseTypes": { "MarkdownDocumentation": "`FunctionResponseTypes`\n\n(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.\nValid Values: `ReportBatchItemFailures`\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `ReportBatchItemFailures...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ReportBatchItemFailures" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } }, "Attributes": { "EventSourceMappingArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EventSourceMappingArn`\n\nThe Amazon Resource Name (ARN) of the event source mapping.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#EventSourceMappingArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe event source mapping's ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#Id-fn::getatt" } } }, "AWS::Lambda::Function": { "MarkdownDocumentation": "`AWS::Lambda::Function`\n\nThe `AWS::Lambda::Function` resource creates a Lambda function. To create a function, you need a\n[deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an\n[execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html).\nThe deployment package is a .zip file archive or container image that contains your function code.\nThe execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs\nfor log streaming and AWS X-Ray for request tracing.\nYou set the package type to `Image` if the deployment package is a\n[container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For these functions,\ninclude the URI of the container image in the Amazon ECR registry in the [`ImageUri` property of the `Code` property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri). You do not need to specify the handler and\nruntime properties.\nYou set the package type to `Zip` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip).\nFor these functions, specify the Amazon S3 location of your .zip file in the `Code` property.\nAlternatively, for Node.js and Python functions, you can define your function inline in the [`ZipFile` property of the `Code` property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile). In both cases, you must also specify the\nhandler and runtime properties.\nYou can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html)\nif your deployment package is a .zip file archive. To enable code signing for this function,\nspecify the ARN of a code-signing configuration. When a user\nattempts to deploy a code package with `UpdateFunctionCode`, Lambda checks that the code\npackage has a valid signature from a trusted publisher. The code-signing configuration\nincludes a set of signing profiles, which define the trusted publishers for this function.\nWhen you update a `AWS::Lambda::Function` resource, CloudFormation calls the\n[UpdateFunctionConfiguration](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionConfiguration.html)\nand [UpdateFunctionCode](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionCode.html)Lambda APIs under the hood. Because these calls happen sequentially, and invocations can happen\nbetween these calls, your function may encounter errors in the time between the calls. For example, if you remove an\nenvironment variable, and the code that references that environment variable in the same CloudFormation\nupdate, you may see invocation errors related to a missing environment variable. To work around this, you can invoke\nyour function against a version or alias by default, rather than the `$LATEST` version.\nNote that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a `AWS::Lambda::Version` or a `AWS::Lambda::Alias`.\nFor a complete introduction to Lambda functions, see\n[What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html)\nin the *Lambda developer guide.*\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html", "Properties": { "FunctionScalingConfig": { "MarkdownDocumentation": "`FunctionScalingConfig`\n\nConfiguration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.\n*Required*: No\n*Type*: [FunctionScalingConfig](./aws-properties-lambda-function-functionscalingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig", "UpdateType": "Mutable", "Required": false, "Type": "FunctionScalingConfig" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the function.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TracingConfig": { "MarkdownDocumentation": "`TracingConfig`\n\nSet `Mode` to `Active` to sample and trace a subset of incoming requests with\n[X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).\n*Required*: No\n*Type*: [TracingConfig](./aws-properties-lambda-function-tracingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig", "UpdateType": "Mutable", "Required": false, "Type": "TracingConfig" }, "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.\nWhen you connect a function to a VPC, it can access resources and the internet only through that VPC. For more\ninformation, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-lambda-function-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "VpcConfig" }, "RuntimeManagementConfig": { "MarkdownDocumentation": "`RuntimeManagementConfig`\n\nSets the runtime management configuration for a function's version. For more information,\nsee [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).\n*Required*: No\n*Type*: [RuntimeManagementConfig](./aws-properties-lambda-function-runtimemanagementconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtimemanagementconfig", "UpdateType": "Mutable", "Required": false, "Type": "RuntimeManagementConfig" }, "DurableConfig": { "MarkdownDocumentation": "`DurableConfig`\n\nConfiguration settings for [durable functions](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html), including execution timeout and retention period for execution history.\n*Required*: No\n*Type*: [DurableConfig](./aws-properties-lambda-function-durableconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-durableconfig", "UpdateType": "Conditional", "Required": false, "Type": "DurableConfig" }, "ReservedConcurrentExecutions": { "MarkdownDocumentation": "`ReservedConcurrentExecutions`\n\nThe number of simultaneous executions to reserve for the function.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SnapStart": { "MarkdownDocumentation": "`SnapStart`\n\nThe function's [AWS Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.\n*Required*: No\n*Type*: [SnapStart](./aws-properties-lambda-function-snapstart.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-snapstart", "UpdateType": "Mutable", "Required": false, "Type": "SnapStart" }, "FileSystemConfigs": { "MarkdownDocumentation": "`FileSystemConfigs`\n\nConnection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available\nin every Availability Zone that your function connects to. If your template contains an\n[AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource,\nyou must also specify a `DependsOn` attribute to ensure that the mount target is created or updated before the function.\nFor more information about using the `DependsOn` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).\n*Required*: No\n*Type*: Array of [FileSystemConfig](./aws-properties-lambda-function-filesystemconfig.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FileSystemConfig", "DuplicatesAllowed": true }, "FunctionName": { "MarkdownDocumentation": "`FunctionName`\n\nThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CloudFormation\ngenerates one.\nIf you specify a name, you cannot perform updates that require replacement of this resource. You can perform\nupdates 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*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Runtime": { "MarkdownDocumentation": "`Runtime`\n\nThe identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in\nan error if you're deploying a function using a container image.\nThe following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing\nfunctions shortly after each runtime is deprecated. For more information, see\n[Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels).\nFor a list of all currently supported runtimes, see\n[Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported).\n*Required*: No\n*Type*: String\n*Allowed values*: `nodejs | nodejs4.3 | nodejs...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.9", "nodejs8.10", "nodejs8.x", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.4", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "python2.7-greengrass", "byol", "go1.9", "go1.x", "ruby2.5", "ruby2.6", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "provided", "provided.al2", "provided.al2023", "nasa", "nodejs26.x", "ruby3.5", "python3.15" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt the following resources:\n* The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption).\n* The function's [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) snapshots.\n* When used with `SourceKMSKeyArn`, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see [Specifying a customer managed key for Lambda](https://docs.aws.amazon.com/lambda/latest/dg/encrypt-zip-package.html#enable-zip-custom-encryption).\n* The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see [Function lifecycle](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-lifecycle).\nIf you don't provide a customer managed key, Lambda uses an [AWS owned key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) or an [AWS managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PublishToLatestPublished": { "MarkdownDocumentation": "`PublishToLatestPublished`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-publishtolatestpublished", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PackageType": { "MarkdownDocumentation": "`PackageType`\n\nThe type of deployment package. Set to `Image` for container image and set `Zip` for .zip file archive.\n*Required*: No\n*Type*: String\n*Allowed values*: `Image | Zip...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Image", "Zip" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CodeSigningConfigArn": { "MarkdownDocumentation": "`CodeSigningConfigArn`\n\nTo enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration\nincludes a set of signing profiles, which define the trusted publishers for this function.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Layers": { "MarkdownDocumentation": "`Layers`\n\nA list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\nto add to the function's execution environment. Specify each layer by its ARN, including the version.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TenancyConfig": { "MarkdownDocumentation": "`TenancyConfig`\n\nThe function's tenant isolation configuration settings. Determines whether the Lambda function\nruns on a shared or dedicated infrastructure per unique tenant.\n*Required*: No\n*Type*: [TenancyConfig](./aws-properties-lambda-function-tenancyconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tenancyconfig", "UpdateType": "Immutable", "Required": false, "Type": "TenancyConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the\nfunction.\n###### Note\nYou must have the `lambda:TagResource`, `lambda:UntagResource`,\nand `lambda:ListTags` permissions for your [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CloudFormation stack. If you\ndon't have these permissions, there might be unexpected behavior with stack-level tags\npropagating to the resource during resource creation and update.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lambda-function-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "ImageConfig": { "MarkdownDocumentation": "`ImageConfig`\n\nConfiguration values that override the container image Dockerfile settings. For more information, see [Container image\nsettings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).\n*Required*: No\n*Type*: [ImageConfig](./aws-properties-lambda-function-imageconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig", "UpdateType": "Mutable", "Required": false, "Type": "ImageConfig" }, "MemorySize": { "MarkdownDocumentation": "`MemorySize`\n\nThe amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime.\nIncreasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note\nthat new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your\nusage. You can also request a quota increase.\n*Required*: No\n*Type*: Integer\n*Minimum*: `128`\n*Maximum*: `32768`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DeadLetterConfig": { "MarkdownDocumentation": "`DeadLetterConfig`\n\nA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events\nwhen they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).\n*Required*: No\n*Type*: [DeadLetterConfig](./aws-properties-lambda-function-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig", "UpdateType": "Mutable", "Required": false, "Type": "DeadLetterConfig" }, "Timeout": { "MarkdownDocumentation": "`Timeout`\n\nThe amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The\nmaximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CapacityProviderConfig": { "MarkdownDocumentation": "`CapacityProviderConfig`\n\nConfiguration for the capacity provider that manages compute resources for Lambda functions.\n*Required*: No\n*Type*: [CapacityProviderConfig](./aws-properties-lambda-function-capacityproviderconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-capacityproviderconfig", "UpdateType": "Mutable", "Required": false, "Type": "CapacityProviderConfig" }, "Handler": { "MarkdownDocumentation": "`Handler`\n\nThe name of the method within your code that Lambda calls to run your function.\nHandler is required if the deployment package is a .zip file archive. The format includes the\nfile name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\nsee [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^[^\\s]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Code": { "MarkdownDocumentation": "`Code`\n\nThe code for the function. You can define your function code in multiple ways:\n* For .zip deployment packages, you can specify the Amazon S3 location of the .zip file\n in the `S3Bucket`, `S3Key`, and `S3ObjectVersion` properties.\n* For .zip deployment packages, you can alternatively define the function code inline in the\n `ZipFile` property. This method works only for Node.js and Python functions.\n* For container images, specify the URI of your container image in the Amazon ECR registry\n in the `ImageUri` property.\n*Required*: Yes\n*Type*: [Code](./aws-properties-lambda-function-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code", "UpdateType": "Mutable", "Required": true, "Type": "Code" }, "Role": { "MarkdownDocumentation": "`Role`\n\nThe Amazon Resource Name (ARN) of the function's execution role.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LoggingConfig": { "MarkdownDocumentation": "`LoggingConfig`\n\nThe function's Amazon CloudWatch Logs configuration settings.\n*Required*: No\n*Type*: [LoggingConfig](./aws-properties-lambda-function-loggingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig", "UpdateType": "Mutable", "Required": false, "Type": "LoggingConfig" }, "RecursiveLoop": { "MarkdownDocumentation": "`RecursiveLoop`\n\nThe status of your function's recursive loop detection configuration.\nWhen this value is set to `Allow`and Lambda detects your function being invoked as part of a recursive\nloop, it doesn't take any action.\nWhen this value is set to `Terminate` and Lambda detects your function being invoked as part of a recursive\nloop, it stops your function being invoked and notifies you.\n*Required*: No\n*Type*: String\n*Allowed values*: `Allow | Terminate...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Allow", "Terminate" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Environment": { "MarkdownDocumentation": "`Environment`\n\nEnvironment variables that are accessible from function code during execution.\n*Required*: No\n*Type*: [Environment](./aws-properties-lambda-function-environment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment", "UpdateType": "Mutable", "Required": false, "Type": "Environment" }, "EphemeralStorage": { "MarkdownDocumentation": "`EphemeralStorage`\n\nThe size of the function's `/tmp` directory in MB. The default value is 512,\nbut it can be any whole number between 512 and 10,240 MB.\n*Required*: No\n*Type*: [EphemeralStorage](./aws-properties-lambda-function-ephemeralstorage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage", "UpdateType": "Mutable", "Required": false, "Type": "EphemeralStorage" }, "Architectures": { "MarkdownDocumentation": "`Architectures`\n\nThe instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86\\_64).\nThe default value is `x86_64`.\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `x86_64 | arm64...`\n*Minimum*: `1`\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)", "RefReturnValue": "", "AllowedValues": [ "x86_64", "arm64" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } }, "Attributes": { "SnapStartResponse.OptimizationStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`SnapStartResponse.OptimizationStatus`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#SnapStartResponse.OptimizationStatus-fn::getatt" }, "SnapStartResponse.ApplyOn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SnapStartResponse.ApplyOn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#SnapStartResponse.ApplyOn-fn::getatt" }, "SnapStartResponse": { "Type": "SnapStartResponse", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#SnapStartResponse-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#Arn-fn::getatt" } } }, "AWS::Lambda::LayerVersion": { "MarkdownDocumentation": "`AWS::Lambda::LayerVersion`\n\nThe `AWS::Lambda::LayerVersion` resource creates a [Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) from a ZIP archive.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the layer version, such as\n`arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html", "Properties": { "CompatibleRuntimes": { "MarkdownDocumentation": "`CompatibleRuntimes`\n\nA list of compatible [function\nruntimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Used for filtering with [ListLayers](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayers.html) and [ListLayerVersions](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayerVersions.html).\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `15`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LicenseInfo": { "MarkdownDocumentation": "`LicenseInfo`\n\nThe layer's software license. It can be any of the following:\n* An [SPDX license identifier](https://spdx.org/licenses/). For example,\n `MIT`.\n* The URL of a license hosted on the internet. For example,\n `https://opensource.org/licenses/MIT`.\n* The full text of the license.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the version.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LayerName": { "MarkdownDocumentation": "`LayerName`\n\nThe name or Amazon Resource Name (ARN) of the layer.\n*Required*: No\n*Type*: String\n*Pattern*: `(arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe function layer archive.\n*Required*: Yes\n*Type*: [Content](./aws-properties-lambda-layerversion-content.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content", "UpdateType": "Immutable", "Required": true, "Type": "Content" }, "CompatibleArchitectures": { "MarkdownDocumentation": "`CompatibleArchitectures`\n\nA list of compatible\n[instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html).\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatiblearchitectures", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "LayerVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LayerVersionArn`\n\nThe ARN of the layer version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#LayerVersionArn-fn::getatt" } } }, "AWS::Lambda::LayerVersionPermission": { "MarkdownDocumentation": "`AWS::Lambda::LayerVersionPermission`\n\nThe `AWS::Lambda::LayerVersionPermission` resource adds permissions to the resource-based policy of\na version of an [Lambda\nlayer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). Use this action to grant layer usage permission to other accounts. You can grant permission to a\nsingle account, all AWS accounts, or all accounts in an organization.\n###### Important\nSince the release of the [UpdateReplacePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) both `UpdateReplacePolicy` and `DeletionPolicy` are required to protect your Resources/LayerPermissions from deletion.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the layer version ARN and statement ID, such as\n`arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1#engineering-org`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe API action that grants access to the layer. For example, `lambda:GetLayerVersion`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `lambda:GetLayerVersion`\n*Minimum*: `0`\n*Maximum*: `22`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-action", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LayerVersionArn": { "MarkdownDocumentation": "`LayerVersionArn`\n\nThe name or Amazon Resource Name (ARN) of the layer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-layerversionarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OrganizationId": { "MarkdownDocumentation": "`OrganizationId`\n\nWith the principal set to `*`, grant permission to all accounts in the specified\norganization.\n*Required*: No\n*Type*: String\n*Pattern*: `o-[a-z0-9]{10,32}`\n*Minimum*: `0`\n*Maximum*: `34`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-organizationid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nAn account ID, or `*` to grant layer usage permission to all\naccounts in an organization, or all AWS accounts (if `organizationId` is not specified).\nFor the last case, make sure that you really do want all AWS accounts to have usage permission to this layer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\d{12}|\\*|arn:(aws[a-zA-Z-]*):iam::\\d{12}:root`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-principal", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#Id-fn::getatt" } } }, "AWS::Lambda::Permission": { "MarkdownDocumentation": "`AWS::Lambda::Permission`\n\nThe `AWS::Lambda::Permission` resource grants an AWS service or another account permission to use a\nfunction. You can apply the policy at the function level, or specify a qualifier to restrict access to a single\nversion or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version\nor alias to invoke the function.\nTo grant permission to another account, specify the account ID as the `Principal`. To grant permission to an organization\ndefined in AWS Organizations, specify the organization ID as the `PrincipalOrgID`. For AWS\nservices, the principal is a domain-style identifier defined by the service, like `s3.amazonaws.com` or\n`sns.amazonaws.com`. For AWS services, you can also specify the ARN of the associated resource as the\n`SourceArn`. If you grant permission to a service principal without specifying the source, other\naccounts could potentially configure resources in their account to invoke your Lambda function.\nIf your function has a function URL, you can specify the `FunctionUrlAuthType` parameter. This adds a condition to your\npermission that only applies when your function URL's `AuthType` matches the specified `FunctionUrlAuthType`. For more information about the `AuthType` parameter, see [Control access to Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).\nThis resource adds a statement to a resource-based permission policy for the function. For more information\nabout function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html", "Properties": { "FunctionName": { "MarkdownDocumentation": "`FunctionName`\n\nThe name or ARN of the Lambda function, version, or alias.\n###### Name formats\n* **Function name** \u2013 `my-function` (name-only), `my-function:v1` (with alias).\n* **Function ARN** \u2013 `arn:aws:lambda:us-west-2:123456789012:function:my-function`.\n* **Partial ARN** \u2013 `123456789012:function:my-function`.\nYou can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\nIf you specify only the function name, it is limited to 64 characters in length.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Action": { "MarkdownDocumentation": "`Action`\n\nThe action that the principal can use on the function. For example, `lambda:InvokeFunction` or\n`lambda:GetFunction`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(lambda:[*]|lambda:[a-zA-Z]+|[*])$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InvokedViaFunctionUrl": { "MarkdownDocumentation": "`InvokedViaFunctionUrl`\n\nIndicates whether the permission applies when the function is invoked through a function URL.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-invokedviafunctionurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EventSourceToken": { "MarkdownDocumentation": "`EventSourceToken`\n\nFor Alexa Smart Home functions, a token that the invoker must supply.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9._\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FunctionUrlAuthType": { "MarkdownDocumentation": "`FunctionUrlAuthType`\n\nThe type of authentication that your function URL uses. Set to `AWS_IAM` if you want to restrict access to authenticated\nusers only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information,\nsee [Control access to Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `AWS_IAM | NONE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AWS_IAM", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionurlauthtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nFor AWS services, the ARN of the AWS resource that invokes the function. For\nexample, an Amazon S3 bucket or Amazon SNS topic.\nNote that Lambda configures the comparison using the `StringLike` operator.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$`\n*Minimum*: `12`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceAccount": { "MarkdownDocumentation": "`SourceAccount`\n\nFor AWS service, the ID of the AWS account that owns the resource. Use this\ntogether with `SourceArn` to ensure that the specified account owns the resource. It is possible for an\nAmazon S3 bucket to be deleted by its owner and recreated by another account.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PrincipalOrgID": { "MarkdownDocumentation": "`PrincipalOrgID`\n\nThe identifier for your organization in AWS Organizations. Use this to grant permissions to all the\nAWS accounts under this organization.\n*Required*: No\n*Type*: String\n*Pattern*: `^o-[a-z0-9]{10,32}$`\n*Minimum*: `12`\n*Maximum*: `34`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principalorgid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe AWS service, AWS account, IAM user, or IAM role that invokes the function. If you specify a\nservice, use `SourceArn` or `SourceAccount` to limit who can invoke the function through\nthat service.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#Id-fn::getatt" } } }, "AWS::Lambda::Url": { "MarkdownDocumentation": "`AWS::Lambda::Url`\n\nThe `AWS::Lambda::Url` resource creates a function URL with the specified configuration parameters. A [function URL](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) is a dedicated HTTP(S) endpoint that\nyou can use to invoke your function.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html", "Properties": { "Qualifier": { "MarkdownDocumentation": "`Qualifier`\n\nThe alias name.\n*Required*: No\n*Type*: String\n*Pattern*: `((?!^[0-9]+$)([a-zA-Z0-9-_]+))`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-qualifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "InvokeMode": { "MarkdownDocumentation": "`InvokeMode`\n\nUse one of the following options:\n* `BUFFERED` \u2013 This is the default option. Lambda invokes your function using the `Invoke` API operation. Invocation results\n are available when the payload is complete. The maximum payload size is 6 MB.\n* `RESPONSE_STREAM` \u2013 Your function streams payload results as they become available. Lambda invokes your function using\n the `InvokeWithResponseStream` API operation. The maximum response payload size is 200 MB.\n*Required*: No\n*Type*: String\n*Allowed values*: `BUFFERED | RESPONSE_STREAM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BUFFERED", "RESPONSE_STREAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nThe type of authentication that your function URL uses. Set to `AWS_IAM` if you want to restrict access to authenticated\nusers only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information,\nsee [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWS_IAM | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AWS_IAM", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TargetFunctionArn": { "MarkdownDocumentation": "`TargetFunctionArn`\n\nThe name of the Lambda function.\n###### Name formats\n* **Function name** - `my-function`.\n* **Function ARN** - `arn:aws:lambda:us-east-2:123456789012:function:my-function`.\n* **Partial ARN** - `123456789012:function:my-function`.\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\ncharacters in length.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\\d+)[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-targetfunctionarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Cors": { "MarkdownDocumentation": "`Cors`\n\nThe [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings\nfor your function URL.\n*Required*: No\n*Type*: [Cors](./aws-properties-lambda-url-cors.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-cors", "UpdateType": "Mutable", "Required": false, "Type": "Cors" } }, "Attributes": { "FunctionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FunctionArn`\n\nThe Amazon Resource Name (ARN) of the function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#FunctionArn-fn::getatt" }, "FunctionUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`FunctionUrl`\n\nThe HTTP URL endpoint for your function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#FunctionUrl-fn::getatt" } } }, "AWS::Lambda::Version": { "MarkdownDocumentation": "`AWS::Lambda::Version`\n\nThe `AWS::Lambda::Version` resource creates a [version](https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) from the current code and configuration of a\nfunction. Use versions to create a snapshot of your function code and configuration that doesn't change.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the version, such as\n`arn:aws:lambda:us-east-2:123456789012:function:helloworld:1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html", "Properties": { "FunctionScalingConfig": { "MarkdownDocumentation": "`FunctionScalingConfig`\n\nConfiguration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.\n*Required*: No\n*Type*: [FunctionScalingConfig](./aws-properties-lambda-version-functionscalingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionscalingconfig", "UpdateType": "Mutable", "Required": false, "Type": "FunctionScalingConfig" }, "FunctionName": { "MarkdownDocumentation": "`FunctionName`\n\nThe name or ARN of the Lambda function.\n###### Name formats\n* **Function name** - `MyFunction`.\n* **Function ARN** - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction`.\n* **Partial ARN** - `123456789012:function:MyFunction`.\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\ncharacters in length.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$`\n*Minimum*: `1`\n*Maximum*: `140`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProvisionedConcurrencyConfig": { "MarkdownDocumentation": "`ProvisionedConcurrencyConfig`\n\nSpecifies a provisioned concurrency configuration for a function's version. Updates are not supported for this\nproperty.\n*Required*: No\n*Type*: [ProvisionedConcurrencyConfiguration](./aws-properties-lambda-version-provisionedconcurrencyconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-provisionedconcurrencyconfig", "UpdateType": "Immutable", "Required": false, "Type": "ProvisionedConcurrencyConfiguration" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the version to override the description in the function configuration. Updates are not\nsupported for this property.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RuntimePolicy": { "MarkdownDocumentation": "`RuntimePolicy`\n\nProperty description not available.\n*Required*: No\n*Type*: [RuntimePolicy](./aws-properties-lambda-version-runtimepolicy.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-runtimepolicy", "UpdateType": "Immutable", "Required": false, "Type": "RuntimePolicy" }, "CodeSha256": { "MarkdownDocumentation": "`CodeSha256`\n\nOnly publish a version if the hash value matches the value that's specified. Use this option to avoid\npublishing a version if the function code has changed since you last updated it. Updates are not supported for\nthis property.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "FunctionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FunctionArn`\n\nThe ARN of the function.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#FunctionArn-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version number.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#Version-fn::getatt" } } }, "AWS::LaunchWizard::Deployment": { "MarkdownDocumentation": "`AWS::LaunchWizard::Deployment`\n\nCreates a deployment for the given workload. Deployments created by this operation are\nnot available in the Launch Wizard console to use the `Clone deployment` action\non.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the deployment. For\nexample:\n`{ \"Ref\": \"myLaunchWizardDeployment\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html", "Properties": { "Specifications": { "MarkdownDocumentation": "`Specifications`\n\nThe settings specified for the deployment. These settings define how to deploy and configure your\nresources created by the deployment. For more information about the specifications\nrequired for creating a deployment for a SAP workload, see [SAP deployment\nspecifications](https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications-sap.html). To retrieve the specifications required to create a deployment for other workloads,\nuse the [`GetWorkloadDeploymentPattern`](https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_GetWorkloadDeploymentPattern.html) operation.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[a-zA-Z0-9-:]{3,256}$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-specifications", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "WorkloadName": { "MarkdownDocumentation": "`WorkloadName`\n\nThe name of the workload.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z][a-zA-Z0-9-_]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-workloadname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nInformation about the tags attached to a deployment.\n*Required*: No\n*Type*: [Array](./aws-properties-launchwizard-deployment-tags.html) of [Tags](./aws-properties-launchwizard-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tags", "DuplicatesAllowed": true }, "DeploymentPatternName": { "MarkdownDocumentation": "`DeploymentPatternName`\n\nThe name of the deployment pattern.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9][a-zA-Z0-9-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-deploymentpatternname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the deployment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_\\s\\.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#cfn-launchwizard-deployment-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#Status-fn::getatt" }, "DeploymentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeploymentId`\n\nThe ID of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#DeploymentId-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time the deployment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#CreatedAt-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#Arn-fn::getatt" }, "DeletedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeletedAt`\n\nThe time the deployment was deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#DeletedAt-fn::getatt" }, "ResourceGroup": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceGroup`\n\nThe resource group of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-launchwizard-deployment.html#ResourceGroup-fn::getatt" } } }, "AWS::LicenseManager::Grant": { "MarkdownDocumentation": "`AWS::LicenseManager::Grant`\n\nSpecifies a grant.\nA grant shares the use of license entitlements with specific AWS accounts. For more information,\nsee [Granted\nlicenses](https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) in the *AWS License Manager User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the grant.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nGranted license status.\n*Required*: No\n*Type*: String\n*Allowed values*: `AVAILABLE | PENDING_AVAILAB...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Principals": { "MarkdownDocumentation": "`Principals`\n\nThe grant principals. You can specify one of the following as an Amazon Resource Name\n(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*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-principals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HomeRegion": { "MarkdownDocumentation": "`HomeRegion`\n\nHome 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-homeregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllowedOperations": { "MarkdownDocumentation": "`AllowedOperations`\n\nAllowed operations for the grant.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-allowedoperations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "LicenseArn": { "MarkdownDocumentation": "`LicenseArn`\n\nLicense ARN.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-licensearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GrantName": { "MarkdownDocumentation": "`GrantName`\n\nGrant 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-grantname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "GrantArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GrantArn`\n\nThe Amazon Resource Name (ARN) of the grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#GrantArn-fn::getatt" }, "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe grant version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#Version-fn::getatt" } } }, "AWS::LicenseManager::License": { "MarkdownDocumentation": "`AWS::LicenseManager::License`\n\nSpecifies a granted license.\nGranted licenses are licenses for products that your organization purchased from AWS Marketplace\nor directly from a seller who integrated their software with managed entitlements. For more information,\nsee [Granted\nlicenses](https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) in the *AWS License Manager User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the license.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html", "Properties": { "ProductSKU": { "MarkdownDocumentation": "`ProductSKU`\n\nProduct SKU.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-productsku", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Status": { "MarkdownDocumentation": "`Status`\n\nLicense status.\n*Required*: No\n*Type*: String\n*Allowed values*: `AVAILABLE | PENDING_AVAILAB...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConsumptionConfiguration": { "MarkdownDocumentation": "`ConsumptionConfiguration`\n\nConfiguration for consumption of the license.\n*Required*: Yes\n*Type*: [ConsumptionConfiguration](./aws-properties-licensemanager-license-consumptionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-consumptionconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ConsumptionConfiguration" }, "Validity": { "MarkdownDocumentation": "`Validity`\n\nDate and time range during which the license is valid, in ISO8601-UTC format.\n*Required*: Yes\n*Type*: [ValidityDateFormat](./aws-properties-licensemanager-license-validitydateformat.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-validity", "UpdateType": "Mutable", "Required": true, "Type": "ValidityDateFormat" }, "ProductName": { "MarkdownDocumentation": "`ProductName`\n\nProduct 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-productname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Issuer": { "MarkdownDocumentation": "`Issuer`\n\nLicense issuer.\n*Required*: Yes\n*Type*: [IssuerData](./aws-properties-licensemanager-license-issuerdata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-issuer", "UpdateType": "Mutable", "Required": true, "Type": "IssuerData" }, "HomeRegion": { "MarkdownDocumentation": "`HomeRegion`\n\nHome Region of the license.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-homeregion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Entitlements": { "MarkdownDocumentation": "`Entitlements`\n\nLicense entitlements.\n*Required*: Yes\n*Type*: Array of [Entitlement](./aws-properties-licensemanager-license-entitlement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-entitlements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Entitlement", "DuplicatesAllowed": false }, "LicenseMetadata": { "MarkdownDocumentation": "`LicenseMetadata`\n\nLicense metadata.\n*Required*: No\n*Type*: Array of [Metadata](./aws-properties-licensemanager-license-metadata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-licensemetadata", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Metadata", "DuplicatesAllowed": false }, "LicenseName": { "MarkdownDocumentation": "`LicenseName`\n\nLicense 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-licensename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Beneficiary": { "MarkdownDocumentation": "`Beneficiary`\n\nLicense beneficiary.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-beneficiary", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe license version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#Version-fn::getatt" }, "LicenseArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LicenseArn`\n\nThe Amazon Resource Name (ARN) of the license.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#LicenseArn-fn::getatt" } } }, "AWS::Lightsail::Alarm": { "MarkdownDocumentation": "`AWS::Lightsail::Alarm`\n\nThe `AWS::Lightsail::Alarm` resource specifies an alarm that can be used to\nmonitor a single metric for one of your Lightsail resources.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric associated with the alarm.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CPUUtilization | NetworkIn ...`\n*Update requires*: Updates are not supported.", "RefReturnValue": "", "AllowedValues": [ "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System", "ClientTLSNegotiationErrorCount", "HealthyHostCount", "UnhealthyHostCount", "HTTPCode_LB_4XX_Count", "HTTPCode_LB_5XX_Count", "HTTPCode_Instance_2XX_Count", "HTTPCode_Instance_3XX_Count", "HTTPCode_Instance_4XX_Count", "HTTPCode_Instance_5XX_Count", "InstanceResponseTime", "RejectedConnectionCount", "RequestCount", "DatabaseConnections", "DiskQueueDepth", "FreeStorageSpace", "NetworkReceiveThroughput", "NetworkTransmitThroughput", "BurstCapacityTime", "BurstCapacityPercentage" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-metricname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe arithmetic operation to use when comparing the specified statistic and\nthreshold.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GreaterThanOrEqualToThresho...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-comparisonoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TreatMissingData": { "MarkdownDocumentation": "`TreatMissingData`\n\nSpecifies how the alarm handles missing data points.\nAn alarm can treat missing data in the following ways:\n* `breaching` - Assumes the missing data is not within the threshold. Missing\n data counts towards the number of times that the metric is not within the\n threshold.\n* `notBreaching` - Assumes the missing data is within the threshold. Missing\n data does not count towards the number of times that the metric is not within the\n threshold.\n* `ignore` - Ignores the missing data. Maintains the current alarm\n state.\n* `missing` - Missing data is treated as missing.\n*Required*: No\n*Type*: String\n*Allowed values*: `breaching | notBreaching | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "breaching", "notBreaching", "ignore", "missing" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-treatmissingdata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AlarmName": { "MarkdownDocumentation": "`AlarmName`\n\nThe name of the alarm.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-alarmname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ContactProtocols": { "MarkdownDocumentation": "`ContactProtocols`\n\nThe contact protocols for the alarm, such as `Email`, `SMS` (text\nmessaging), or both.\n*Allowed Values*: `Email` | `SMS`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-contactprotocols", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MonitoredResourceName": { "MarkdownDocumentation": "`MonitoredResourceName`\n\nThe name of the Lightsail resource that the alarm monitors.\n*Required*: Yes\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-monitoredresourcename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EvaluationPeriods": { "MarkdownDocumentation": "`EvaluationPeriods`\n\nThe number of periods over which data is compared to the specified threshold.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-evaluationperiods", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "NotificationEnabled": { "MarkdownDocumentation": "`NotificationEnabled`\n\nA Boolean value indicating whether the alarm 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-notificationenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DatapointsToAlarm": { "MarkdownDocumentation": "`DatapointsToAlarm`\n\nThe number of data points within the evaluation periods that must be breaching to cause\nthe alarm to go to the `ALARM` state.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-datapointstoalarm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NotificationTriggers": { "MarkdownDocumentation": "`NotificationTriggers`\n\nThe alarm states that trigger a notification.\n###### Note\nTo specify the `OK` and `INSUFFICIENT_DATA` values, you must also\nspecify `ContactProtocols` values. Otherwise, the `OK`\nand `INSUFFICIENT_DATA` values will not take effect and the stack will\ndrift.\n*Allowed Values*: `OK` | `ALARM` |\n`INSUFFICIENT_DATA`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-notificationtriggers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\nThe value against which the specified statistic is compared.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-threshold", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } }, "Attributes": { "AlarmArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AlarmArn`\n\nThe Amazon Resource Name (ARN) of the alarm.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#AlarmArn-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the alarm.\nAn alarm has the following possible states:\n* `ALARM` - The metric is outside of the defined threshold.\n* `INSUFFICIENT_DATA` - The alarm has recently started, the metric is not\n available, or not enough data is available for the metric to determine the alarm\n state.\n* `OK` - The metric is within the defined threshold.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#State-fn::getatt" } } }, "AWS::Lightsail::Bucket": { "MarkdownDocumentation": "`AWS::Lightsail::Bucket`\n\nThe `AWS::Lightsail::Bucket` resource specifies a bucket.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html", "Properties": { "ObjectVersioning": { "MarkdownDocumentation": "`ObjectVersioning`\n\nIndicates whether object versioning is enabled for the bucket.\nThe following options can be configured:\n* `Enabled` - Object versioning is enabled.\n* `Suspended` - Object versioning was previously enabled but is currently\n suspended. Existing object versions are retained.\n* `NeverEnabled` - Object versioning has never been enabled.\n*Required*: No\n*Type*: Boolean\n*Pattern*: `.*\\S.*`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-objectversioning", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ReadOnlyAccessAccounts": { "MarkdownDocumentation": "`ReadOnlyAccessAccounts`\n\nAn array of AWS account IDs that have read-only access to the\nbucket.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-readonlyaccessaccounts", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "BundleId": { "MarkdownDocumentation": "`BundleId`\n\nThe bundle ID for the bucket (for example, `small_1_0`).\nA bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\nbucket.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bundleid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$`\n*Minimum*: `3`\n*Maximum*: `54`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bucketname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccessRules": { "MarkdownDocumentation": "`AccessRules`\n\nAn object that describes the access rules for the bucket.\n*Required*: No\n*Type*: [AccessRules](./aws-properties-lightsail-bucket-accessrules.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-accessrules", "UpdateType": "Mutable", "Required": false, "Type": "AccessRules" }, "ResourcesReceivingAccess": { "MarkdownDocumentation": "`ResourcesReceivingAccess`\n\nAn array of Lightsail instances that have access to the bucket.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-resourcesreceivingaccess", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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)\nin the *AWS CloudFormation User Guide*.\n###### Note\nThe `Value` of `Tags` is optional for Lightsail resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-bucket-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "BucketArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`BucketArn`\n\nThe Amazon Resource Name (ARN) of the bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#BucketArn-fn::getatt" }, "AbleToUpdateBundle": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`AbleToUpdateBundle`\n\nA Boolean value indicating whether the bundle that is currently applied to your\ndistribution can be changed to another bundle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#AbleToUpdateBundle-fn::getatt" }, "Url": { "PrimitiveType": "String", "MarkdownDocumentation": "`Url`\n\nThe URL of the bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#Url-fn::getatt" } } }, "AWS::Lightsail::Certificate": { "MarkdownDocumentation": "`AWS::Lightsail::Certificate`\n\nThe `AWS::Lightsail::Certificate` resource specifies an SSL/TLS certificate\nthat you can use with a content delivery network (CDN) distribution and a container\nservice.\n###### Note\nFor information about certificates that you can use with a load balancer, see [AWS::Lightsail::LoadBalancerTlsCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html", "Properties": { "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name of the certificate.\n*Required*: Yes\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#cfn-lightsail-certificate-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SubjectAlternativeNames": { "MarkdownDocumentation": "`SubjectAlternativeNames`\n\nAn array of strings that specify the alternate domains (such as `example.org`)\nand subdomains (such as `blog.example.com`) of the certificate.\n*Required*: No\n*Type*: Array of String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#cfn-lightsail-certificate-subjectalternativenames", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "CertificateName": { "MarkdownDocumentation": "`CertificateName`\n\nThe name of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#cfn-lightsail-certificate-certificatename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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)\nin the *AWS CloudFormation User Guide*.\n###### Note\nThe `Value` of `Tags` is optional for Lightsail resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-certificate-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#cfn-lightsail-certificate-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe validation status of the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#Status-fn::getatt" }, "CertificateArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) of the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#CertificateArn-fn::getatt" } } }, "AWS::Lightsail::Container": { "MarkdownDocumentation": "`AWS::Lightsail::Container`\n\nThe `AWS::Lightsail::Container` resource specifies a container\nservice.\nA Lightsail container service is a compute resource to which you can\ndeploy containers.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html", "Properties": { "PublicDomainNames": { "MarkdownDocumentation": "`PublicDomainNames`\n\nThe public domain name of the container service, such as `example.com` and\n`www.example.com`.\nYou can specify up to four public domain names for a container service. The domain names\nthat you specify are used when you create a deployment with a container that is configured as the\npublic endpoint of your container service.\nIf you don't specify public domain names, then you can use the default domain of the\ncontainer service.\n###### Important\nYou must create and validate an SSL/TLS certificate before you can use public domain\nnames with your container service. Use the [AWS::Lightsail::Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html) resource to create a certificate for the public\ndomain names that you want to use with your container service.\n*Required*: No\n*Type*: Array of [PublicDomainName](./aws-properties-lightsail-container-publicdomainname.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-publicdomainnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PublicDomainName", "DuplicatesAllowed": false }, "ServiceName": { "MarkdownDocumentation": "`ServiceName`\n\nThe name of the container service.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-servicename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PrivateRegistryAccess": { "MarkdownDocumentation": "`PrivateRegistryAccess`\n\nAn object that describes the configuration for the container service to access private\ncontainer image repositories, such as Amazon Elastic Container Registry (Amazon ECR)\nprivate repositories.\nFor more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail\ncontainer service](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access) in the *Amazon Lightsail Developer\nGuide*.\n*Required*: No\n*Type*: [PrivateRegistryAccess](./aws-properties-lightsail-container-privateregistryaccess.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-privateregistryaccess", "UpdateType": "Mutable", "Required": false, "Type": "PrivateRegistryAccess" }, "ContainerServiceDeployment": { "MarkdownDocumentation": "`ContainerServiceDeployment`\n\nAn object that describes the current container deployment of the container\nservice.\n*Required*: No\n*Type*: [ContainerServiceDeployment](./aws-properties-lightsail-container-containerservicedeployment.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-containerservicedeployment", "UpdateType": "Mutable", "Required": false, "Type": "ContainerServiceDeployment" }, "IsDisabled": { "MarkdownDocumentation": "`IsDisabled`\n\nA Boolean value indicating whether the container service 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-isdisabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Scale": { "MarkdownDocumentation": "`Scale`\n\nThe scale specification of the container service.\nThe scale specifies the allocated compute nodes of the container service.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-scale", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Power": { "MarkdownDocumentation": "`Power`\n\nThe power specification of the container service.\nThe power specifies the amount of RAM, the number of vCPUs, and the base price of the\ncontainer service.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `nano | micro | small | medi...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "nano", "micro", "small", "medium", "large", "xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-power", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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)\nin the *AWS CloudFormation User Guide*.\n###### Note\nThe `Value` of `Tags` is optional for Lightsail resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-container-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "PrincipalArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrincipalArn`\n\nThe principle Amazon Resource Name (ARN) of the role.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#PrincipalArn-fn::getatt" }, "PrivateRegistryAccess.EcrImagePullerRole.PrincipalArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrivateRegistryAccess.EcrImagePullerRole.PrincipalArn`\n\nThe principle Amazon Resource Name (ARN) of the role.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#PrivateRegistryAccess.EcrImagePullerRole.PrincipalArn-fn::getatt" }, "ContainerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ContainerArn`\n\nThe Amazon Resource Name (ARN) of the container.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#ContainerArn-fn::getatt" }, "Url": { "PrimitiveType": "String", "MarkdownDocumentation": "`Url`\n\nThe publicly accessible URL of the container service.\nIf no public endpoint is specified in the current deployment, this URL returns a 404\nresponse.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#Url-fn::getatt" } } }, "AWS::Lightsail::Database": { "MarkdownDocumentation": "`AWS::Lightsail::Database`\n\nThe `AWS::Lightsail::Database` resource specifies an Amazon Lightsail database.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html", "Properties": { "RelationalDatabaseName": { "MarkdownDocumentation": "`RelationalDatabaseName`\n\nThe name of the instance.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\w[\\w\\-]*\\w`\n*Minimum*: `2`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CaCertificateIdentifier": { "MarkdownDocumentation": "`CaCertificateIdentifier`\n\nThe certificate associated with 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-cacertificateidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone for the database.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe weekly time range during which system maintenance can occur for the database,\nformatted as follows: `ddd:hh24:mi-ddd:hh24:mi`. For example,\n`Tue:17:00-Tue:17:30`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-preferredmaintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RelationalDatabaseBlueprintId": { "MarkdownDocumentation": "`RelationalDatabaseBlueprintId`\n\nThe blueprint ID for the database (for example, `mysql_8_0`).\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseblueprintid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PreferredBackupWindow": { "MarkdownDocumentation": "`PreferredBackupWindow`\n\nThe daily time range during which automated backups are created for the database (for\nexample, `16:00-16:30`).\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-preferredbackupwindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterDatabaseName": { "MarkdownDocumentation": "`MasterDatabaseName`\n\nThe meaning of this parameter differs according to the database engine you use.\n**MySQL**\nThe name of the database to create when the Lightsail database resource\nis created. If this parameter isn't specified, no database is created in the database\nresource.\nConstraints:\n* Must contain 1-64 letters or numbers.\n* Must begin with a letter. Subsequent characters can be letters, underscores, or\n numbers (0-9).\n* Can't be a word reserved by the specified database engine.\n \n For more information about reserved words in MySQL, see the Keywords and Reserved\n Words articles for [MySQL 5.6](https://dev.mysql.com/doc/refman/5.6/en/keywords.html), [MySQL 5.7](https://dev.mysql.com/doc/refman/5.7/en/keywords.html), and\n [MySQL\n 8.0](https://dev.mysql.com/doc/refman/8.0/en/keywords.html).\n**PostgreSQL**\nThe name of the database to create when the Lightsail database resource\nis created. If this parameter isn't specified, a database named `postgres` is\ncreated in the database resource.\nConstraints:\n* Must contain 1-63 letters or numbers.\n* Must begin with a letter. Subsequent characters can be letters, underscores, or\n numbers (0-9).\n* Can't be a word reserved by the specified database engine.\n \n For more information about reserved words in PostgreSQL, see the SQL Key Words\n articles for [PostgreSQL\n 9.6](https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html), [PostgreSQL\n 10](https://www.postgresql.org/docs/10/sql-keywords-appendix.html), [PostgreSQL\n 11](https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and [PostgreSQL\n 12](https://www.postgresql.org/docs/12/sql-keywords-appendix.html).\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masterdatabasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MasterUserPassword": { "MarkdownDocumentation": "`MasterUserPassword`\n\nThe password for the primary user of the database. The password can include any\nprintable ASCII character except the following: /, \", or @. It cannot contain\nspaces.\n###### Note\nThe `MasterUserPassword` and `RotateMasterUserPassword`\nparameters cannot be used together in the same template.\n**MySQL**\nConstraints: Must contain 8-41 characters.\n**PostgreSQL**\nConstraints: Must contain 8-128 characters.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masteruserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RelationalDatabaseParameters": { "MarkdownDocumentation": "`RelationalDatabaseParameters`\n\nAn array of parameters for the database.\n*Required*: No\n*Type*: Array of [RelationalDatabaseParameter](./aws-properties-lightsail-database-relationaldatabaseparameter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RelationalDatabaseParameter", "DuplicatesAllowed": false }, "RotateMasterUserPassword": { "MarkdownDocumentation": "`RotateMasterUserPassword`\n\nA Boolean value indicating whether to change the primary user password to a new, strong\npassword generated by Lightsail.\n###### Note\nThe `RotateMasterUserPassword` and `MasterUserPassword`\nparameters cannot be used together in the same template.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-rotatemasteruserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MasterUsername": { "MarkdownDocumentation": "`MasterUsername`\n\nThe name for the primary user.\n**MySQL**\nConstraints:\n* Required for MySQL.\n* Must be 1-16 letters or numbers. Can contain underscores.\n* First character must be a letter.\n* Can't be a reserved word for the chosen database engine.\n \n For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords\n and Reserved Words articles for [MySQL 5.6](https://dev.mysql.com/doc/refman/5.6/en/keywords.html),\n [MySQL\n 5.7](https://dev.mysql.com/doc/refman/5.7/en/keywords.html), or [MySQL 8.0](https://dev.mysql.com/doc/refman/8.0/en/keywords.html).\n**PostgreSQL**\nConstraints:\n* Required for PostgreSQL.\n* Must be 1-63 letters or numbers. Can contain underscores.\n* First character must be a letter.\n* Can't be a reserved word for the chosen database engine.\n \n For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords\n and Reserved Words articles for [PostgreSQL\n 9.6](https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html), [PostgreSQL\n 10](https://www.postgresql.org/docs/10/sql-keywords-appendix.html), [PostgreSQL\n 11](https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and [PostgreSQL\n 12](https://www.postgresql.org/docs/12/sql-keywords-appendix.html).\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masterusername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nA Boolean value indicating whether the database is accessible to anyone on the\ninternet.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-publiclyaccessible", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RelationalDatabaseBundleId": { "MarkdownDocumentation": "`RelationalDatabaseBundleId`\n\nThe bundle ID for the database (for example, `medium_1_0`).\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabasebundleid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BackupRetention": { "MarkdownDocumentation": "`BackupRetention`\n\nA Boolean value indicating whether automated backup retention is enabled for the\ndatabase. Data Import Mode is enabled when `BackupRetention` is set to `false`, and is disabled when `BackupRetention` is set to `true`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-backupretention", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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)\nin the *AWS CloudFormation User Guide*.\n###### Note\nThe `Value` of `Tags` is optional for Lightsail resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-database-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "DatabaseArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatabaseArn`\n\nThe Amazon Resource Name (ARN) of the database (for example,\n`arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#DatabaseArn-fn::getatt" } } }, "AWS::Lightsail::Disk": { "MarkdownDocumentation": "`AWS::Lightsail::Disk`\n\nThe `AWS::Lightsail::Disk` resource specifies a disk that can be attached to\nan Amazon Lightsail instance that is in the same AWS Region\nand Availability Zone.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html", "Properties": { "SizeInGb": { "MarkdownDocumentation": "`SizeInGb`\n\nThe size of the disk in GB.\n*Required*: Yes\n*Type*: Integer\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-sizeingb", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe AWS Region and Availability Zone location for the disk (for\nexample, `us-east-1a`).\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AddOns": { "MarkdownDocumentation": "`AddOns`\n\nAn array of add-ons for the disk.\n###### Note\nIf the disk has an add-on enabled when performing a delete disk request, the add-on\nis automatically disabled before the disk is deleted.\n*Required*: No\n*Type*: Array of [AddOn](./aws-properties-lightsail-disk-addon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-addons", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AddOn", "DuplicatesAllowed": true }, "DiskName": { "MarkdownDocumentation": "`DiskName`\n\nThe name of the disk.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$`\n*Minimum*: `1`\n*Maximum*: `254`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-diskname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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)\nin the *AWS CloudFormation User Guide*.\n###### Note\nThe `Value` of `Tags` is optional for Lightsail resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-disk-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe AWS Region and Availability Zone where the disk is located.\n*Required*: No\n*Type*: [Location](./aws-properties-lightsail-disk-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-location", "UpdateType": "Mutable", "Required": false, "Type": "Location" } }, "Attributes": { "Path": { "PrimitiveType": "String", "MarkdownDocumentation": "`Path`\n\nThe disk path.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#Path-fn::getatt" }, "AttachmentState": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentState`\n\n(Deprecated) The attachment state of the disk.\n###### Note\nIn releases prior to November 14, 2017, this parameter returned `attached`\nfor system disks in the API response. It is now deprecated, but still included in the\nresponse. Use `isAttached` instead.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#AttachmentState-fn::getatt" }, "Location.AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "`Location.AvailabilityZone`\n\nThe Availability Zone where the disk is located.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#Location.AvailabilityZone-fn::getatt" }, "SupportCode": { "PrimitiveType": "String", "MarkdownDocumentation": "`SupportCode`\n\nThe support code of the disk.\nInclude this code in your email to support when you have questions about a disk or\nanother resource in Lightsail. This code helps our support team to look up\nyour Lightsail information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#SupportCode-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the disk (for example, `in-use`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#State-fn::getatt" }, "IsAttached": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsAttached`\n\nA Boolean value indicating whether the disk is attached.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#IsAttached-fn::getatt" }, "ResourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceType`\n\nThe resource type of the disk (for example, `Disk`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#ResourceType-fn::getatt" }, "DiskArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DiskArn`\n\nThe Amazon Resource Name (ARN) of the disk.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#DiskArn-fn::getatt" }, "AttachedTo": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachedTo`\n\nThe resources to which the disk is attached.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#AttachedTo-fn::getatt" }, "Iops": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Iops`\n\nThe input/output operations per second (IOPS) of the disk.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#Iops-fn::getatt" }, "Location.RegionName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Location.RegionName`\n\nThe AWS Region where the disk is located.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#Location.RegionName-fn::getatt" } } }, "AWS::Lightsail::DiskSnapshot": { "MarkdownDocumentation": "`AWS::Lightsail::DiskSnapshot`\n\nDescribes a block storage disk snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html", "Properties": { "DiskSnapshotName": { "MarkdownDocumentation": "`DiskSnapshotName`\n\nThe name of the disk snapshot (`my-disk-snapshot`).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\w[\\w\\-]*\\w$`\n*Minimum*: `2`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#cfn-lightsail-disksnapshot-disksnapshotname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DiskName": { "MarkdownDocumentation": "`DiskName`\n\nThe unique name of the disk.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\w[\\w\\-]*\\w$`\n*Minimum*: `2`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#cfn-lightsail-disksnapshot-diskname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tag keys and optional values for the resource. For more information about tags in\nLightsail, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-disksnapshot-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#cfn-lightsail-disksnapshot-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "SizeInGb": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`SizeInGb`\n\nThe size of the disk in GB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#SizeInGb-fn::getatt" }, "Progress": { "PrimitiveType": "String", "MarkdownDocumentation": "`Progress`\n\nThe progress of the snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#Progress-fn::getatt" }, "Location.AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#Location.AvailabilityZone-fn::getatt" }, "DiskSnapshotArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DiskSnapshotArn`\n\nThe Amazon Resource Name (ARN) of the disk snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#DiskSnapshotArn-fn::getatt" }, "SupportCode": { "PrimitiveType": "String", "MarkdownDocumentation": "`SupportCode`\n\nThe support code. Include this code in your email to support when you have questions about\nan instance or another resource in Lightsail. This code enables our support team to look up\nyour Lightsail information more easily.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#SupportCode-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe status of the disk snapshot operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#State-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date when the disk snapshot was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#CreatedAt-fn::getatt" }, "FromDiskName": { "PrimitiveType": "String", "MarkdownDocumentation": "`FromDiskName`\n\nThe unique name of the source disk from which the disk snapshot was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#FromDiskName-fn::getatt" }, "ResourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceType`\n\nThe Lightsail resource type (`DiskSnapshot`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#ResourceType-fn::getatt" }, "IsFromAutoSnapshot": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsFromAutoSnapshot`\n\nA Boolean value indicating whether the snapshot was created from an automatic\nsnapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#IsFromAutoSnapshot-fn::getatt" }, "Location": { "Type": "Location", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#Location-fn::getatt" }, "Location.RegionName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disksnapshot.html#Location.RegionName-fn::getatt" } } }, "AWS::Lightsail::Instance": { "MarkdownDocumentation": "`AWS::Lightsail::Instance`\n\nThe `AWS::Lightsail::Instance` resource specifies an Amazon Lightsail instance.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html", "Properties": { "InstanceName": { "MarkdownDocumentation": "`InstanceName`\n\nThe name of the instance.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$`\n*Minimum*: `1`\n*Maximum*: `254`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-instancename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KeyPairName": { "MarkdownDocumentation": "`KeyPairName`\n\nThe name of the key pair to use for the instance.\nIf no key pair name is specified, the Regional Lightsail default key\npair 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-keypairname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BundleId": { "MarkdownDocumentation": "`BundleId`\n\nThe bundle ID for the instance (for example, `micro_1_0`).\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-bundleid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BlueprintId": { "MarkdownDocumentation": "`BlueprintId`\n\nThe blueprint ID for the instance (for example, `os_amlinux_2016_03`).\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-blueprintid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Networking": { "MarkdownDocumentation": "`Networking`\n\nThe public ports and the monthly amount of data transfer allocated for the\ninstance.\n*Required*: No\n*Type*: [Networking](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-networking", "UpdateType": "Mutable", "Required": false, "Type": "Networking" }, "UserData": { "MarkdownDocumentation": "`UserData`\n\nThe optional launch script for the instance.\nSpecify a launch script to configure an instance with additional user data. For example,\nyou might want to specify `apt-get -y update` as a launch script.\n###### Note\nDepending on the blueprint of your instance, the command to get software on your\ninstance varies. Amazon Linux and CentOS use `yum`, Debian and Ubuntu use\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-userdata", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nThe status code and the state (for example, `running`) of the\ninstance.\n###### Note\nThe `State` property is read-only and should not be specified in a create\ninstance or update instance request.\n*Required*: No\n*Type*: [State](./aws-properties-lightsail-instance-state.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-state", "UpdateType": "Mutable", "Required": false, "Type": "State" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone for the instance.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `255`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AddOns": { "MarkdownDocumentation": "`AddOns`\n\nAn array of add-ons for the instance.\n###### Note\nIf the instance has an add-on enabled when performing a delete instance request, the\nadd-on is automatically disabled before the instance is deleted.\n*Required*: No\n*Type*: Array of [AddOn](./aws-properties-lightsail-instance-addon.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-addons", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AddOn", "DuplicatesAllowed": true }, "Hardware": { "MarkdownDocumentation": "`Hardware`\n\nThe hardware properties for the instance, such as the vCPU count, attached disks, and\namount of RAM.\n###### Important\nThe instance restarts when performing an attach disk or detach disk request. This\nresets the public IP address of your instance if a static IP isn't attached to\nit.\n*Required*: No\n*Type*: [Hardware](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-hardware", "UpdateType": "Mutable", "Required": false, "Type": "Hardware" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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)\nin the *AWS CloudFormation User Guide*.\n###### Note\nThe `Value` of `Tags` is optional for Lightsail resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-instance-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe location for the instance, such as the AWS Region and Availability\nZone.\n###### Note\nThe `Location` property is read-only and should not be specified in a\ncreate instance or update instance request.\n*Required*: No\n*Type*: [Location](./aws-properties-lightsail-instance-location.html)\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-location", "UpdateType": "Mutable", "Required": false, "Type": "Location" } }, "Attributes": { "SshKeyName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SshKeyName`\n\nThe name of the SSH key pair used by the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#SshKeyName-fn::getatt" }, "Networking.MonthlyTransfer.GbPerMonthAllocated": { "PrimitiveType": "String", "MarkdownDocumentation": "`Networking.MonthlyTransfer.GbPerMonthAllocated`\n\nThe amount of allocated monthly data transfer (in GB) for an instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#Networking.MonthlyTransfer.GbPerMonthAllocated-fn::getatt" }, "Hardware.CpuCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Hardware.CpuCount`\n\nThe number of vCPUs the instance has.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#Hardware.CpuCount-fn::getatt" }, "IsStaticIp": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsStaticIp`\n\nA Boolean value indicating whether the instance has a static IP assigned to it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#IsStaticIp-fn::getatt" }, "PrivateIpAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrivateIpAddress`\n\nThe private IP address of the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#PrivateIpAddress-fn::getatt" }, "UserName": { "PrimitiveType": "String", "MarkdownDocumentation": "`UserName`\n\nThe user name for connecting to the instance (for example,\n`ec2-user`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#UserName-fn::getatt" }, "ResourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceType`\n\nThe resource type of the instance (for example, `Instance`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#ResourceType-fn::getatt" }, "Ipv6Addresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Ipv6Addresses`\n\nThe IPv6 addresses of the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#Ipv6Addresses-fn::getatt" }, "Location.RegionName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Location.RegionName`\n\nThe AWS Region of the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#Location.RegionName-fn::getatt" }, "PublicIpAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`PublicIpAddress`\n\nThe public IP address of the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#PublicIpAddress-fn::getatt" }, "Location.AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "`Location.AvailabilityZone`\n\nThe AWS Region and Availability Zone where the instance is\nlocated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#Location.AvailabilityZone-fn::getatt" }, "State.Code": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`State.Code`\n\nThe status code of the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#State.Code-fn::getatt" }, "SupportCode": { "PrimitiveType": "String", "MarkdownDocumentation": "`SupportCode`\n\nThe support code of the instance.\nInclude this code in your email to support when you have questions about an instance or\nanother resource in Lightsail. This code helps our support team to look up\nyour Lightsail information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#SupportCode-fn::getatt" }, "State.Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`State.Name`\n\nThe state of the instance (for example, `running` or\n`pending`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#State.Name-fn::getatt" }, "InstanceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`InstanceArn`\n\nThe Amazon Resource Name (ARN) of the instance (for example,\n`arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#InstanceArn-fn::getatt" }, "Hardware.RamSizeInGb": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Hardware.RamSizeInGb`\n\nThe amount of RAM in GB on the instance (for example, `1.0`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#Hardware.RamSizeInGb-fn::getatt" } } }, "AWS::Lightsail::InstanceSnapshot": { "MarkdownDocumentation": "`AWS::Lightsail::InstanceSnapshot`\n\nDescribes an instance snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html", "Properties": { "InstanceName": { "MarkdownDocumentation": "`InstanceName`\n\nThe name the user gave the instance (`Amazon_Linux_2023-1`).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#cfn-lightsail-instancesnapshot-instancename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceSnapshotName": { "MarkdownDocumentation": "`InstanceSnapshotName`\n\nThe name of the snapshot.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#cfn-lightsail-instancesnapshot-instancesnapshotname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tag keys and optional values for the resource. For more information about tags in\nLightsail, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-instancesnapshot-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#cfn-lightsail-instancesnapshot-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "SizeInGb": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`SizeInGb`\n\nThe size in GB of the SSD.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#SizeInGb-fn::getatt" }, "Location.AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#Location.AvailabilityZone-fn::getatt" }, "SupportCode": { "PrimitiveType": "String", "MarkdownDocumentation": "`SupportCode`\n\nThe support code. Include this code in your email to support when you have questions about\nan instance or another resource in Lightsail. This code enables our support team to look up\nyour Lightsail information more easily.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#SupportCode-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state the snapshot is in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#State-fn::getatt" }, "FromInstanceName": { "PrimitiveType": "String", "MarkdownDocumentation": "`FromInstanceName`\n\nThe instance from which the snapshot was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#FromInstanceName-fn::getatt" }, "ResourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceType`\n\nThe type of resource (usually `InstanceSnapshot`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#ResourceType-fn::getatt" }, "IsFromAutoSnapshot": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsFromAutoSnapshot`\n\nA Boolean value indicating whether the snapshot was created from an automatic\nsnapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#IsFromAutoSnapshot-fn::getatt" }, "FromInstanceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FromInstanceArn`\n\nThe Amazon Resource Name (ARN) of the instance from which the snapshot was created\n(`arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#FromInstanceArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the snapshot\n(`arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#Arn-fn::getatt" }, "Location": { "Type": "Location", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#Location-fn::getatt" }, "Location.RegionName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html#Location.RegionName-fn::getatt" } } }, "AWS::Lightsail::LoadBalancer": { "MarkdownDocumentation": "`AWS::Lightsail::LoadBalancer`\n\nThe `AWS::Lightsail::LoadBalancer` resource specifies a load balancer that\ncan be used with Lightsail instances.\n###### Note\nYou cannot attach a TLS certificate to a load balancer using the\n`AWS::Lightsail::LoadBalancer` resource type. Instead, use the\n`AWS::Lightsail::LoadBalancerTlsCertificate` resource type to create a certificate\nand attach it to a load balancer.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe IP address type of the load balancer.\nThe possible values are `ipv4` for IPv4 only, and `dualstack` for\nboth IPv4 and IPv6.\n*Required*: No\n*Type*: String\n*Allowed values*: `dualstack | ipv4 | ipv6...`\n*Update requires*: Updates are not supported.", "RefReturnValue": "", "AllowedValues": [ "dualstack", "ipv4", "ipv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-ipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SessionStickinessLBCookieDurationSeconds": { "MarkdownDocumentation": "`SessionStickinessLBCookieDurationSeconds`\n\nThe time period, in seconds, after which the load balancer session stickiness cookie\nshould be considered stale. If you do not specify this parameter, the default value is 0,\nwhich indicates that the sticky session should last for the duration of the browser\nsession.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-sessionstickinesslbcookiedurationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoadBalancerName": { "MarkdownDocumentation": "`LoadBalancerName`\n\nThe name of the load balancer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\w[\\w\\-]*\\w`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-loadbalancername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AttachedInstances": { "MarkdownDocumentation": "`AttachedInstances`\n\nThe Lightsail instances to attach to the load balancer.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-attachedinstances", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "InstancePort": { "MarkdownDocumentation": "`InstancePort`\n\nThe port that the load balancer uses to direct traffic to your Lightsail\ninstances. For HTTP traffic, specify port `80`. For HTTPS traffic, specify port\n`443`.\n*Required*: Yes\n*Type*: Integer\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-instanceport", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "HealthCheckPath": { "MarkdownDocumentation": "`HealthCheckPath`\n\nThe path on the attached instance where the health check will be performed. If no path\nis specified, the load balancer tries to make a request to the default (root) page\n(`/index.html`).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-healthcheckpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SessionStickinessEnabled": { "MarkdownDocumentation": "`SessionStickinessEnabled`\n\nA Boolean value indicating whether session stickiness is enabled.\nEnable session stickiness (also known as *session affinity*) to bind\na user's session to a specific instance. This ensures that all requests from the user\nduring 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-sessionstickinessenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TlsPolicyName": { "MarkdownDocumentation": "`TlsPolicyName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-tlspolicyname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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)\nin the *AWS CloudFormation User Guide*.\n###### Note\nThe `Value` of `Tags` is optional for Lightsail resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-lightsail-loadbalancer-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "LoadBalancerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoadBalancerArn`\n\nThe Amazon Resource Name (ARN) of the load balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#LoadBalancerArn-fn::getatt" } } }, "AWS::Lightsail::LoadBalancerTlsCertificate": { "MarkdownDocumentation": "`AWS::Lightsail::LoadBalancerTlsCertificate`\n\nThe `AWS::Lightsail::LoadBalancerTlsCertificate` resource specifies a TLS\ncertificate that can be used with a Lightsail load balancer.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html", "Properties": { "LoadBalancerName": { "MarkdownDocumentation": "`LoadBalancerName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-loadbalancername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CertificateDomainName": { "MarkdownDocumentation": "`CertificateDomainName`\n\nThe 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.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-certificatedomainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IsAttached": { "MarkdownDocumentation": "`IsAttached`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-isattached", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CertificateAlternativeNames": { "MarkdownDocumentation": "`CertificateAlternativeNames`\n\nAn array of alternative domain names and subdomain names for your SSL/TLS\ncertificate.\nIn addition to the primary domain name, you can have up to nine alternative domain names.\nWildcards (such as `*.example.com`) are not supported.\n*Required*: No\n*Type*: Array of String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-certificatealternativenames", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "HttpsRedirectionEnabled": { "MarkdownDocumentation": "`HttpsRedirectionEnabled`\n\nA Boolean value indicating whether HTTPS redirection is enabled for the load\nbalancer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-httpsredirectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CertificateName": { "MarkdownDocumentation": "`CertificateName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-certificatename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe validation status of the SSL/TLS certificate.\nValid Values: `PENDING_VALIDATION` | `ISSUED` |\n`INACTIVE` | `EXPIRED` | `VALIDATION_TIMED_OUT` |\n`REVOKED` | `FAILED` | `UNKNOWN`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#Status-fn::getatt" }, "LoadBalancerTlsCertificateArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoadBalancerTlsCertificateArn`\n\nThe Amazon Resource Name (ARN) of the SSL/TLS certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#LoadBalancerTlsCertificateArn-fn::getatt" } } }, "AWS::Lightsail::StaticIp": { "MarkdownDocumentation": "`AWS::Lightsail::StaticIp`\n\nThe `AWS::Lightsail::StaticIp` resource specifies a static IP that can be\nattached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html", "Properties": { "StaticIpName": { "MarkdownDocumentation": "`StaticIpName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html#cfn-lightsail-staticip-staticipname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AttachedTo": { "MarkdownDocumentation": "`AttachedTo`\n\nThe instance that the static IP is attached 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html#cfn-lightsail-staticip-attachedto", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "StaticIpArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`StaticIpArn`\n\nThe Amazon Resource Name (ARN) of the static IP (for example,\n`arn:aws:lightsail:us-east-2:123456789101:StaticIp/244ad76f-8aad-4741-809f-12345EXAMPLE`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html#StaticIpArn-fn::getatt" }, "IsAttached": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsAttached`\n\nA Boolean value indicating whether the static IP is attached to an instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html#IsAttached-fn::getatt" }, "IpAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpAddress`\n\nThe IP address of the static IP.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html#IpAddress-fn::getatt" } } }, "AWS::Location::APIKey": { "MarkdownDocumentation": "`AWS::Location::APIKey`\n\nThe API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the `APIKey`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html", "Properties": { "KeyName": { "MarkdownDocumentation": "`KeyName`\n\nA custom name for the API key resource.\nRequirements:\n* Contain only alphanumeric characters (A\u2013Z, a\u2013z, 0\u20139), hyphens (-), periods\n (.), and underscores (\\_).\n* Must be a unique API key name.\n* No spaces allowed. For example, `ExampleAPIKey`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[-._\\w]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-keyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nUpdates the description for the API key resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NoExpiry": { "MarkdownDocumentation": "`NoExpiry`\n\nWhether the API key should expire. Set to `true` to set the API key to have no expiration time.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-noexpiry", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ForceDelete": { "MarkdownDocumentation": "`ForceDelete`\n\nForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter `true` to delete the key or to `false` to not preemptively delete the API key.\nValid values: `true`, or `false`.\n###### Note\nThis action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-forcedelete", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ExpireTime": { "MarkdownDocumentation": "`ExpireTime`\n\nThe optional timestamp for when the API key resource will expire in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-expiretime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ForceUpdate": { "MarkdownDocumentation": "`ForceUpdate`\n\nThe boolean flag to be included for updating `ExpireTime` or Restrictions details.\nMust be set to `true` to update an API key resource that has been used in the past 7 days.\n`False` if force update is not preferred.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-forceupdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Restrictions": { "MarkdownDocumentation": "`Restrictions`\n\nThe API key restrictions for the API key resource.\n*Required*: Yes\n*Type*: [ApiKeyRestrictions](./aws-properties-location-apikey-apikeyrestrictions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-restrictions", "UpdateType": "Mutable", "Required": true, "Type": "ApiKeyRestrictions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nApplies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-location-apikey-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#CreateTime-fn::getatt" }, "UpdateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateTime`\n\nThe timestamp for when the API key resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#UpdateTime-fn::getatt" }, "KeyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`KeyArn`\n\nThe Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#KeyArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#Arn-fn::getatt" } } }, "AWS::Location::GeofenceCollection": { "MarkdownDocumentation": "`AWS::Location::GeofenceCollection`\n\nThe `AWS::Location::GeofenceCollection` resource specifies the ability to\ndetect and act when a tracked device enters or exits a defined geographical boundary\nknown as a geofence.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `GeofenceCollection` name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description for the geofence collection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#cfn-location-geofencecollection-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nA key identifier for an [AWS KMS customer\nmanaged 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#cfn-location-geofencecollection-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CollectionName": { "MarkdownDocumentation": "`CollectionName`\n\nA custom name for the geofence collection.\nRequirements:\n* Contain only alphanumeric characters (A\u2013Z, a\u2013z, 0\u20139), hyphens (-), periods\n (.), and underscores (\\_).\n* Must be a unique geofence collection name.\n* No spaces allowed. For example, `ExampleGeofenceCollection`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[-._\\w]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#cfn-location-geofencecollection-collectionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nApplies one or more tags to the geofence collection. A tag is a key-value pair helps\nmanage, identify, search, and filter your resources by labelling them.\nFormat: `\"key\" : \"value\"`\nRestrictions:\n* Maximum 50 tags per resource\n* Each resource tag must be unique with a maximum of one value.\n* Maximum key length: 128 Unicode characters in UTF-8\n* Maximum value length: 256 Unicode characters in UTF-8\n* Can use alphanumeric characters (A\u2013Z, a\u2013z, 0\u20139), and the following characters:\n + - = . \\_ : / @.\n* Cannot use \"aws:\" as a prefix for a key.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-location-geofencecollection-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#cfn-location-geofencecollection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CollectionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollectionArn`\n\nSynonym for `Arn`. The Amazon Resource Name (ARN) for the geofence collection resource. Used when you\nneed to specify a resource across all AWS.\n* Format example:\n `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#CollectionArn-fn::getatt" }, "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe timestamp for when the geofence collection resource was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format:\n`YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#CreateTime-fn::getatt" }, "UpdateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateTime`\n\nThe timestamp for when the geofence collection resource was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format:\n`YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#UpdateTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the geofence collection resource. Used when you\nneed to specify a resource across all AWS.\n* Format example:\n `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#Arn-fn::getatt" } } }, "AWS::Location::Map": { "MarkdownDocumentation": "`AWS::Location::Map`\n\nThe `AWS::Location::Map` resource specifies a map resource in your\nAWS account, which provides map tiles of different styles sourced\nfrom global location data providers.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Map` name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html", "Properties": { "MapName": { "MarkdownDocumentation": "`MapName`\n\nThe name for the map resource.\nRequirements:\n* Must contain only alphanumeric characters (A\u2013Z, a\u2013z, 0\u20139), hyphens (-),\n 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*Pattern*: `^[-._\\w]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-mapname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description for the map resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nSpecifies the `MapConfiguration`, including the map style, for the map\nresource that you create. The map style defines the look of maps and the data provider\nfor your map resource.\n*Required*: Yes\n*Type*: [MapConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-configuration", "UpdateType": "Immutable", "Required": true, "Type": "MapConfiguration" }, "PricingPlan": { "MarkdownDocumentation": "`PricingPlan`\n\nNo longer used. If included, the only allowed value is\n`RequestBasedUsage`.\n*Allowed Values*: `RequestBasedUsage`\n*Required*: No\n*Type*: String\n*Allowed values*: `RequestBasedUsage...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RequestBasedUsage" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-pricingplan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nApplies one or more tags to the map resource. A tag is a key-value pair helps manage,\nidentify, search, and filter your resources by labelling them.\nFormat: `\"key\" : \"value\"`\nRestrictions:\n* Maximum 50 tags per resource\n* Each resource tag must be unique with a maximum of one value.\n* Maximum key length: 128 Unicode characters in UTF-8\n* Maximum value length: 256 Unicode characters in UTF-8\n* Can use alphanumeric characters (A\u2013Z, a\u2013z, 0\u20139), and the following characters:\n + - = . \\_ : / @.\n* Cannot use \"aws:\" as a prefix for a key.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-location-map-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe timestamp for when the map resource was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format:\n`YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#CreateTime-fn::getatt" }, "UpdateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateTime`\n\nThe timestamp for when the map resource was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format:\n`YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#UpdateTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the map resource. Used to specify a resource across\nall AWS.\n* Format example:\n `arn:aws:geo:region:account-id:maps/ExampleMap`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#Arn-fn::getatt" }, "MapArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MapArn`\n\nSynonym for `Arn`. The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across\nall AWS.\n* Format example:\n `arn:aws:geo:region:account-id:maps/ExampleMap`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#MapArn-fn::getatt" } } }, "AWS::Location::PlaceIndex": { "MarkdownDocumentation": "`AWS::Location::PlaceIndex`\n\nSpecifies a place index resource in your AWS account. Use a place index\nresource to geocode addresses and other text queries by using the\n`SearchPlaceIndexForText` operation, and reverse geocode coordinates by\nusing the `SearchPlaceIndexForPosition` operation, and enable autosuggestions\nby using the `SearchPlaceIndexForSuggestions` operation.\n###### Note\nIf your application is tracking or routing assets you use in your business, such\nas delivery vehicles or employees, you must not use Esri as your geolocation\nprovider. See section 82 of the [AWS service terms](https://aws.amazon.com/service-terms) for more details.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `PlaceIndex` name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the place index resource.\nRequirements:\n* Contain only alphanumeric characters (A\u2013Z, a\u2013z, 0\u20139), hyphens (-), periods\n (.), 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*Pattern*: `^[-._\\w]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-indexname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe optional description for the place index resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PricingPlan": { "MarkdownDocumentation": "`PricingPlan`\n\nNo longer used. If included, the only allowed value is\n`RequestBasedUsage`.\n*Allowed Values*: `RequestBasedUsage`\n*Required*: No\n*Type*: String\n*Allowed values*: `RequestBasedUsage...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RequestBasedUsage" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-pricingplan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSourceConfiguration": { "MarkdownDocumentation": "`DataSourceConfiguration`\n\nSpecifies the data storage option requesting Places.\n*Required*: No\n*Type*: [DataSourceConfiguration](./aws-properties-location-placeindex-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-datasourceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DataSourceConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-location-placeindex-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nSpecifies the geospatial data provider for the new place index.\n###### Note\nThis field is case-sensitive. Enter the valid values as shown. For example,\nentering `HERE` returns an error.\nValid values include:\n* `Esri` \u2013 For additional information about [Esri](https://docs.aws.amazon.com/location/previous/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\n Asia. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/previous/developerguide/grab.html)' coverage,\n see [GrabMaps\n countries and areas covered](https://docs.aws.amazon.com/location/previous/developerguide/grab.html#grab-coverage-area).\n* `Here` \u2013 For additional information about [HERE\n Technologies](https://docs.aws.amazon.com/location/previous/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 \n ###### Important\n \n If you specify HERE Technologies (`Here`) as the data provider,\n 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\n the [AWS service\n terms](https://aws.amazon.com/service-terms/) for Amazon Location Service.\nFor additional information , see [Data\nproviders](https://docs.aws.amazon.com/location/previous/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-datasource", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "IndexArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IndexArn`\n\nSynonym for `Arn`. The Amazon Resource Name (ARN) for the place index\nresource. Used to specify a resource across AWS.\n* Format example:\n `arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#IndexArn-fn::getatt" }, "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe timestamp for when the place index resource was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)\nformat: `YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#CreateTime-fn::getatt" }, "UpdateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateTime`\n\nThe timestamp for when the place index resource was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)\nformat: `YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#UpdateTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the place index resource. Used to specify a\nresource across AWS.\n* Format example:\n `arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#Arn-fn::getatt" } } }, "AWS::Location::RouteCalculator": { "MarkdownDocumentation": "`AWS::Location::RouteCalculator`\n\nSpecifies a route calculator resource in your AWS account.\nYou can send requests to a route calculator resource to estimate travel time,\ndistance, and get directions. A route calculator sources traffic and road network data\nfrom your chosen data provider.\n###### Note\nIf your application is tracking or routing assets you use in your business, such\nas delivery vehicles or employees, you must not use Esri as your geolocation\nprovider. See section 82 of the [AWS\nservice terms](https://aws.amazon.com/service-terms) for more details.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `RouteCalculator` name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html", "Properties": { "CalculatorName": { "MarkdownDocumentation": "`CalculatorName`\n\nThe name of the route calculator resource.\nRequirements:\n* Can use alphanumeric characters (A\u2013Z, a\u2013z, 0\u20139) , hyphens (-), periods (.),\n 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*Pattern*: `^[-._\\w]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-calculatorname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe optional description for the route calculator resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PricingPlan": { "MarkdownDocumentation": "`PricingPlan`\n\nNo longer used. If included, the only allowed value is\n`RequestBasedUsage`.\n*Allowed Values*: `RequestBasedUsage`\n*Required*: No\n*Type*: String\n*Allowed values*: `RequestBasedUsage...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RequestBasedUsage" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-pricingplan", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-location-routecalculator-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "DataSource": { "MarkdownDocumentation": "`DataSource`\n\nSpecifies the data provider of traffic and road network data.\n###### Note\nThis field is case-sensitive. Enter the valid values as shown. For example,\nentering `HERE` returns an error.\nValid values include:\n* `Esri` \u2013 For additional information about [Esri](https://docs.aws.amazon.com/location/previous/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).\n \n Route calculators that use Esri as a data source only calculate routes that\n are shorter than 400 km.\n* `Grab` \u2013 Grab provides routing functionality for Southeast Asia.\n For additional information about [GrabMaps](https://docs.aws.amazon.com/location/previous/developerguide/grab.html)' coverage,\n see [GrabMaps\n countries and areas covered](https://docs.aws.amazon.com/location/previous/developerguide/grab.html#grab-coverage-area).\n* `Here` \u2013 For additional information about [HERE\n Technologies](https://docs.aws.amazon.com/location/previous/developerguide/HERE.html)' coverage in your region of interest, see [HERE car routing coverage](https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html) and [HERE truck routing coverage](https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html).\nFor additional information , see [Data\nproviders](https://docs.aws.amazon.com/location/previous/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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-datasource", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe timestamp for when the route calculator resource was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format:\n`YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#CreateTime-fn::getatt" }, "UpdateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateTime`\n\nThe timestamp for when the route calculator resource was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format:\n`YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#UpdateTime-fn::getatt" }, "CalculatorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CalculatorArn`\n\nSynonym for `Arn`. The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you\nspecify a resource across all AWS.\n* Format example:\n `arn:aws:geo:region:account-id:route-calculator/ExampleCalculator`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#CalculatorArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you\nspecify a resource across all AWS.\n* Format example:\n `arn:aws:geo:region:account-id:route-calculator/ExampleCalculator`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#Arn-fn::getatt" } } }, "AWS::Location::Tracker": { "MarkdownDocumentation": "`AWS::Location::Tracker`\n\nSpecifies a tracker resource in your AWS account, which lets you\nreceive current and historical location of devices.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Tracker` name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html", "Properties": { "TrackerName": { "MarkdownDocumentation": "`TrackerName`\n\nThe 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*Pattern*: `^[-._\\w]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#cfn-location-tracker-trackername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description for the tracker resource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#cfn-location-tracker-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventBridgeEnabled": { "MarkdownDocumentation": "`EventBridgeEnabled`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#cfn-location-tracker-eventbridgeenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nA key identifier for an\n[AWS\nKMS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#cfn-location-tracker-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyEnableGeospatialQueries": { "MarkdownDocumentation": "`KmsKeyEnableGeospatialQueries`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#cfn-location-tracker-kmskeyenablegeospatialqueries", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PositionFiltering": { "MarkdownDocumentation": "`PositionFiltering`\n\nSpecifies the position filtering for the tracker resource.\nValid values:\n* `TimeBased` - Location updates are evaluated against linked geofence collections,\n but not every location update is stored. If your update frequency is more often than 30 seconds,\n 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\n ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored.\n This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.\n 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,\n location updates are ignored. For example, if two consecutive updates from a device\n have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device\n has moved less than 15 m. Ignored location updates are neither evaluated against\n linked geofence collections, nor stored. This can reduce the effects of GPS noise\n when displaying device trajectories on a map, and can help control your costs by reducing the\n 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*: `TimeBased | DistanceBased |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TimeBased", "DistanceBased", "AccuracyBased" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#cfn-location-tracker-positionfiltering", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-location-tracker-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#cfn-location-tracker-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe timestamp for when the tracker resource was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format:\n`YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#CreateTime-fn::getatt" }, "UpdateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdateTime`\n\nThe timestamp for when the tracker resource was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format:\n`YYYY-MM-DDThh:mm:ss.sssZ`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#UpdateTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify\na resource across all AWS.\n* Format example:\n `arn:aws:geo:region:account-id:tracker/ExampleTracker`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#Arn-fn::getatt" }, "TrackerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrackerArn`\n\nSynonym for `Arn`. The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify\na resource across all AWS.\n* Format example:\n `arn:aws:geo:region:account-id:tracker/ExampleTracker`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-tracker.html#TrackerArn-fn::getatt" } } }, "AWS::Location::TrackerConsumer": { "MarkdownDocumentation": "`AWS::Location::TrackerConsumer`\n\nThe `AWS::Location::TrackerConsumer` resource specifies an association\nbetween a geofence collection and a tracker resource. The geofence collection is\nreferred to as the *consumer* of the tracker. This allows the tracker resource\nto communicate location data to the linked geofence collection.\n###### Note\nCurrently not supported \u2014 Cross-account configurations, such as creating\nassociations between a tracker resource in one account and a geofence collection in\nanother account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `TrackerConsumer` name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-trackerconsumer.html", "Properties": { "TrackerName": { "MarkdownDocumentation": "`TrackerName`\n\nThe 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*Pattern*: `^[-._\\w]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-trackerconsumer.html#cfn-location-trackerconsumer-trackername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ConsumerArn": { "MarkdownDocumentation": "`ConsumerArn`\n\nThe Amazon Resource Name (ARN) for the geofence collection to be associated to tracker\nresource. Used when you need to specify a resource across all AWS.\n* Format example:\n `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$`\n*Maximum*: `1600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-trackerconsumer.html#cfn-location-trackerconsumer-consumerarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Logs::AccountPolicy": { "MarkdownDocumentation": "`AWS::Logs::AccountPolicy`\n\nCreates or updates an account-level data protection policy or subscription filter\npolicy that applies to all log groups or a subset of log groups in the account.\n**Data protection policy**\nA data protection policy can help safeguard sensitive data that's ingested by your log\ngroups by auditing and masking the sensitive log data. Each account can have only one\naccount-level data protection policy.\n###### Important\nSensitive data is detected and masked when it is ingested into a log group. When\nyou set a data protection policy, log events ingested into the log groups before\nthat time are not masked.\nIf you create a data protection policy for your whole account, it applies to both\nexisting log groups and all log groups that are created later in this account. The\naccount policy is applied to existing log groups with eventual consistency. It might\ntake up to 5 minutes before sensitive data in existing log groups begins to be\nmasked.\nBy default, when a user views a log event that includes masked data, the sensitive\ndata is replaced by asterisks. A user who has the `logs:Unmask` permission\ncan use a [GetLogEvents](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html) or [FilterLogEvents](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html) operation with the `unmask` parameter set to\n`true` to view the unmasked log events. Users with the\n`logs:Unmask` can also view unmasked data in the CloudWatch Logs\nconsole by running a CloudWatch Logs Insights query with the `unmask`\nquery command.\nFor more information, including a list of types of data that can be audited and\nmasked, see [Protect sensitive\nlog data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).\nTo create an account-level policy, you must be signed on with the\n`logs:PutDataProtectionPolicy` and `logs:PutAccountPolicy`\npermissions.\nAn account-level policy applies to all log groups in the account. You can also create\na data protection policy that applies to just one log group. If a log group has its own\ndata protection policy and the account also has an account-level data protection policy,\nthen the two policies are cumulative. Any sensitive term specified in either policy is\nmasked.\n**Subscription filter policy**\nA subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other AWS services. Account-level subscription filter\npolicies apply to both existing log groups and log groups that are created later in this\naccount. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64\nencoded and compressed with the GZIP format.\nThe following destinations are supported for subscription filters:\n* An Kinesis Data Streams data stream in the same account as the subscription\n policy, for same-account delivery.\n* An Firehose data stream in the same account as the subscription\n policy, for same-account delivery.\n* A Lambda function in the same account as the subscription policy,\n for same-account delivery.\n* A logical destination in a different account created with [PutDestination](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html), for cross-account delivery. Kinesis Data Streams and\n Firehose are supported as logical destinations.\nEach account can have one account-level subscription filter policy. If you are\nupdating an existing filter, you must specify the correct name in\n`PolicyName`. To perform a `PutAccountPolicy` subscription\nfilter operation for any destination except a Lambda function, you must also\nhave the `iam:PassRole` permission.\n**Field index policy**\nYou can use field index policies to create indexes on fields found in log events in\nthe log group. Creating field indexes lowers the scan volume for CloudWatch Logs\nInsights queries that reference those fields, because these queries attempt to skip the\nprocessing of log events that are known to not match the indexed field. Good fields to\nindex are fields that you often need to query for. Common examples of indexes include\nrequest ID, session ID, user IDs, or instance IDs. For more information, see [Create field\nindexes to improve query performance and reduce costs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html)\nFor example, suppose you have created a field index for `requestId`. Then,\nany CloudWatch Logs Insights query on that log group that includes `requestId =\nvalue` or `requestId IN\n[value, value, ...]` will\nattempt to process only the log events where the indexed field matches the specified\nvalue.\nMatches of log events to the names of indexed fields are case-sensitive. For example,\nan indexed field of `RequestId` won't match a log event containing\n`requestId`.\nYou can have one account-level field index policy that applies to all log groups in\nthe account. Or you can create as many as 20 account-level field index policies that are\neach scoped to a subset of log groups with the `SelectionCriteria` parameter.\nIf you have multiple account-level index policies with selection criteria, no two of\nthem can use the same or overlapping log group name prefixes. For example, if you have\none policy filtered to log groups that start with `my-log`, you can't have\nanother field index policy filtered to `my-logpprod` or\n`my-logging`.\n**Transformer policy**\nA *log transformer policy* transforms ingested log events into a\ndifferent format, making them easier for you to process and analyze. You can also\ntransform logs from different sources into standardized formats that contain relevant,\nsource-specific information. After you have created a transformer, CloudWatch Logs\nperforms this transformation at the time of log ingestion. You can then refer to the\ntransformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.\nYou can also use a transformer to copy metadata from metadata keys into the log events\nthemselves. This metadata can include log group name, log stream name, account ID and\nRegion.\nA transformer for a log group is a series of processors, where each processor applies\none type of transformation to the log events ingested into this log group. For more\ninformation about the available processors to use in a transformer, see [Processors that you can use](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors).\nHaving log events in standardized format enables visibility across your applications\nfor your log analysis, reporting, and alarming needs. CloudWatch Logs provides\ntransformation for common log types with out-of-the-box transformation templates for\nmajor AWS log sources such as VPC flow logs, Lambda, and\nAmazon RDS. You can use pre-built transformation templates or create custom\ntransformation policies.\nYou can create transformers only for the log groups in the Standard log class.\nYou can have one account-level transformer policy that applies to all log groups in\nthe account. Or you can create as many as 20 account-level transformer policies that are\neach scoped to a subset of log groups with the `selectionCriteria` parameter.\nIf you have multiple account-level transformer policies with selection criteria, no two\nof them can use the same or overlapping log group name prefixes. For example, if you\nhave one policy filtered to log groups that start with `my-log`, you can't\nhave another field index policy filtered to `my-logpprod` or\n`my-logging`.\nYou can also set up a transformer at the log-group level. For more information, see\n[AWS::Logs::Transformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-transformer.html). If there is both a log-group level transformer\ncreated with `PutTransformer` and an account-level transformer that could\napply to the same log group, the log group uses only the log-group level transformer. It\nignores the account-level transformer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html", "Properties": { "PolicyType": { "MarkdownDocumentation": "`PolicyType`\n\nThe type of policy that you're creating or updating.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DATA_PROTECTION_POLICY | SU...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DATA_PROTECTION_POLICY", "SUBSCRIPTION_FILTER_POLICY", "FIELD_INDEX_POLICY", "TRANSFORMER_POLICY", "METRIC_EXTRACTION_POLICY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-policytype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nCurrently the only valid value for this parameter is `ALL`, which specifies\nthat the policy applies to all log groups in the account. If you omit this parameter,\nthe default of `ALL` is used. To scope down a subscription filter policy to a\nsubset of log groups, use the `SelectionCriteria` parameter.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "ALL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-scope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nA name for the policy. This must be unique within the account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^:*]{1,256}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-policyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SelectionCriteria": { "MarkdownDocumentation": "`SelectionCriteria`\n\nUse this parameter to apply the new policy to a subset of log groups in the\naccount.\nYou need to specify `SelectionCriteria` only when you specify\n`SUBSCRIPTION_FILTER_POLICY`, `FIELD_INDEX_POLICY` or\n`TRANSFORMER_POLICY`for `PolicyType`.\nIf `PolicyType` is `SUBSCRIPTION_FILTER_POLICY`, the only\nsupported `SelectionCriteria` filter is `LogGroupName NOT IN\n[]`\nIf `PolicyType` is `FIELD_INDEX_POLICY` or\n`TRANSFORMER_POLICY`, the only supported `SelectionCriteria`\nfilter is `LogGroupNamePrefix`\nThe `SelectionCriteria` string can be up to 25KB in length. The length is\ndetermined by using its UTF-8 bytes.\nUsing the `SelectionCriteria` parameter with\n`SUBSCRIPTION_FILTER_POLICY` is useful to help prevent infinite loops.\nFor more information, see [Log\nrecursion prevention](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions-recursion-prevention.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-selectioncriteria", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nSpecify the policy, in JSON.\n**Data protection policy**\nA data protection policy must include two JSON blocks:\n* The first block must include both a `DataIdentifer` array and an\n `Operation` property with an `Audit` action. The\n `DataIdentifer` array lists the types of sensitive data that you\n want to mask. For more information about the available options, see [Types\n of data that you can mask](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html).\n \n The `Operation` property with an `Audit` action is\n required to find the sensitive data terms. This `Audit` action must\n contain a `FindingsDestination` object. You can optionally use that\n `FindingsDestination` object to list one or more destinations to\n send audit findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they must already exist.\n* The second block must include both a `DataIdentifer` array and an\n `Operation` property with an `Deidentify` action. The\n `DataIdentifer` array must exactly match the\n `DataIdentifer` array in the first block of the policy.\n \n The `Operation` property with the `Deidentify` action is\n what actually masks the data, and it must contain the `\"MaskConfig\":\n {}` object. The `\"MaskConfig\": {}` object must be\n empty.\n###### Important\nThe contents of the two `DataIdentifer` arrays must match\nexactly.\nIn addition to the two JSON blocks, the `policyDocument` can also include\n`Name`, `Description`, and `Version` fields. The\n`Name` is different than the operation's `policyName`\nparameter, and is used as a dimension when CloudWatch Logs reports audit findings\nmetrics to CloudWatch.\nThe JSON specified in `policyDocument` can be up to 30,720 characters\nlong.\n**Subscription filter policy**\nA subscription filter policy can include the following attributes in a JSON\nblock:\n* **DestinationArn** The ARN of the destination to\n deliver log events to. Supported destinations are:\n \n + An Kinesis Data Streams data stream in the same account as the\n subscription policy, for same-account delivery.\n + An Firehose data stream in the same account as the\n subscription policy, for same-account delivery.\n + A Lambda function in the same account as the subscription\n policy, for same-account delivery.\n + A logical destination in a different account created with [PutDestination](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html), for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical\n destinations.\n* **RoleArn** The ARN of an IAM role that grants\n CloudWatch Logs permissions to deliver ingested log events to the destination\n stream. You don't need to provide the ARN when you are working with a logical\n destination for cross-account delivery.\n* **FilterPattern** A filter pattern for\n subscribing to a filtered stream of log events.\n* **Distribution**The method used to distribute log\n data to the destination. By default, log data is grouped by log stream, but the\n grouping can be set to `Random` for a more even distribution. This\n property is only applicable when the destination is an Kinesis Data Streams data\n stream.\n**Field index policy**\nA field index filter policy can include the following attribute in a JSON\nblock:\n* **Fields** The array of field indexes to\n create.\nThe following is an example of an index policy document that creates two indexes,\n`RequestId` and `TransactionId`.\n`\"policyDocument\": \"{ \\\"Fields\\\": [ \\\"RequestId\\\", \\\"TransactionId\\\" ] }\"`\n**Transformer policy**\nA transformer policy must include one JSON block with the array of processors and\ntheir configurations. For more information about available processors, see [Processors that you can use](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors).\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe account ID of the account where this policy was created. For example,\n`123456789012`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#AccountId-fn::getatt" } } }, "AWS::Logs::Delivery": { "MarkdownDocumentation": "`AWS::Logs::Delivery`\n\nThis structure contains information about one *delivery* in your\naccount.\nA delivery is a connection between a logical *delivery source* and a\nlogical *delivery destination*.\nFor more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).\nTo update an existing delivery configuration, use [UpdateDeliveryConfiguration](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html", "Properties": { "S3EnableHiveCompatiblePath": { "MarkdownDocumentation": "`S3EnableHiveCompatiblePath`\n\nUse this parameter to cause the S3 objects that contain delivered logs to use a prefix\nstructure that allows for integration with Apache Hive.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-s3enablehivecompatiblepath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FieldDelimiter": { "MarkdownDocumentation": "`FieldDelimiter`\n\nThe field delimiter that is used between record fields when the final output format of\na delivery is in `Plain`, `W3C`, or `Raw`\nformat.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-fielddelimiter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeliveryDestinationArn": { "MarkdownDocumentation": "`DeliveryDestinationArn`\n\nThe ARN of the delivery destination that is associated with this delivery.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w#+=/:,.@-]*\\*?`\n*Minimum*: `16`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-deliverydestinationarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeliverySourceName": { "MarkdownDocumentation": "`DeliverySourceName`\n\nThe name of the delivery source that is associated with this delivery.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]*$`\n*Minimum*: `1`\n*Maximum*: `60`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-deliverysourcename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RecordFields": { "MarkdownDocumentation": "`RecordFields`\n\nThe list of record fields to be delivered to the destination, in order. If the\ndelivery's log source has mandatory fields, they must be included in this list.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-recordfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "S3SuffixPath": { "MarkdownDocumentation": "`S3SuffixPath`\n\nUse this to reconfigure the S3 object prefix to contain either static or variable\nsections. The valid variables to use in the suffix path will vary by each log source. To\nfind the values supported for the suffix path for each log source, use the [DescribeConfigurationTemplates](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeConfigurationTemplates.html) operation and check the\n`allowedSuffixPathFields` field in the response.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-s3suffixpath", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the delivery.\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-logs-delivery-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "DeliveryId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeliveryId`\n\nThe unique ID that identifies this delivery in your account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#DeliveryId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) that uniquely identifies this delivery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#Arn-fn::getatt" }, "DeliveryDestinationType": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeliveryDestinationType`\n\nDisplays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Firehose.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#DeliveryDestinationType-fn::getatt" } } }, "AWS::Logs::DeliveryDestination": { "MarkdownDocumentation": "`AWS::Logs::DeliveryDestination`\n\nThis structure contains information about one *delivery destination* in\nyour account. A delivery destination is an AWS resource that represents an\nAWS service that logs can be sent to. CloudWatch Logs, Amazon S3,\nFirehose, and X-Ray are supported as delivery destinations.\nTo configure logs delivery between a supported AWS service and a\ndestination, you must do the following:\n* Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see [PutDeliverySource](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html).\n* Create a *delivery destination*, which is a logical object that\n represents the actual delivery destination.\n* If you are delivering logs cross-account, you must use [PutDeliveryDestinationPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html) in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n* Create a *delivery* by pairing exactly one delivery source and one\n delivery destination. For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).\nYou can configure a single delivery source to send logs to multiple destinations by\ncreating multiple deliveries. You can also create multiple deliveries to configure multiple\ndelivery sources to send logs to the same delivery destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html", "Properties": { "DestinationResourceArn": { "MarkdownDocumentation": "`DestinationResourceArn`\n\nThe ARN of the AWS destination that this delivery destination\nrepresents. That AWS destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a Firehose stream.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w#+=/:,.@-]*\\*?`\n*Minimum*: `16`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html#cfn-logs-deliverydestination-destinationresourcearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OutputFormat": { "MarkdownDocumentation": "`OutputFormat`\n\nThe format of the logs that are sent to this delivery destination.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z]+$`\n*Minimum*: `1`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html#cfn-logs-deliverydestination-outputformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeliveryDestinationPolicy": { "MarkdownDocumentation": "`DeliveryDestinationPolicy`\n\nAn IAM policy that grants permissions to CloudWatch Logs to deliver\nlogs cross-account to a specified destination in this account. For examples of this\npolicy, see [Examples](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html#API_PutDeliveryDestinationPolicy_Examples) in the CloudWatch Logs API Reference.\n*Required*: No\n*Type*: [DestinationPolicy](./aws-properties-logs-deliverydestination-destinationpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html#cfn-logs-deliverydestination-deliverydestinationpolicy", "UpdateType": "Mutable", "Required": false, "Type": "DestinationPolicy" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the delivery destination.\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-logs-deliverydestination-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html#cfn-logs-deliverydestination-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "DeliveryDestinationType": { "MarkdownDocumentation": "`DeliveryDestinationType`\n\nDisplays whether this delivery destination is CloudWatch Logs, Amazon S3,\nFirehose, or X-Ray.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z]+$`\n*Minimum*: `1`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html#cfn-logs-deliverydestination-deliverydestinationtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of this delivery destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]*$`\n*Minimum*: `1`\n*Maximum*: `60`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html#cfn-logs-deliverydestination-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) that uniquely identifies this delivery\ndestination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html#Arn-fn::getatt" } } }, "AWS::Logs::DeliverySource": { "MarkdownDocumentation": "`AWS::Logs::DeliverySource`\n\nCreates or updates one *delivery source* in your account. A\ndelivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.\nOnly some AWS services support being configured as a delivery source.\nThese services are listed as **Supported [V2 Permissions]**\nin the table at [Enabling\nlogging from AWS services.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)\nTo configure logs delivery between a supported AWS service and a\ndestination, you must do the following:\n* Create a delivery source, which is a logical object that represents the\n resource that is actually sending the logs.\n* Create a *delivery destination*, which is a logical object\n that represents the actual delivery destination. For more information, see\n [AWS::Logs::DeliveryDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverydestination.html) or [PutDeliveryDestination](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html).\n* Create a *delivery* by pairing exactly one delivery source\n and one delivery destination. For more information, see [AWS::Logs::Delivery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html) or [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).\nYou can configure a single delivery source to send logs to multiple destinations by\ncreating multiple deliveries. You can also create multiple deliveries to configure\nmultiple delivery sources to send logs to the same delivery destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverysource.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe ARN of the AWS resource that is generating and sending logs. For\nexample,\n`arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234`\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w#+=/:,.@-]*\\*?`\n*Minimum*: `16`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverysource.html#cfn-logs-deliverysource-resourcearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogType": { "MarkdownDocumentation": "`LogType`\n\nThe type of log that the source is sending. For valid values for this parameter, see the\ndocumentation for the source service.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverysource.html#cfn-logs-deliverysource-logtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the delivery source.\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-logs-deliverysource-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverysource.html#cfn-logs-deliverysource-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe unique name of the delivery source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w-]*$`\n*Minimum*: `1`\n*Maximum*: `60`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverysource.html#cfn-logs-deliverysource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Service": { "PrimitiveType": "String", "MarkdownDocumentation": "`Service`\n\nThe AWS service that is sending logs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverysource.html#Service-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) that uniquely identifies this delivery source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverysource.html#Arn-fn::getatt" }, "ResourceArns": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ResourceArns`\n\nThis array contains the ARN of the AWS resource that sends logs and is\nrepresented by this delivery source. Currently, only one ARN can be in the array.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-deliverysource.html#ResourceArns-fn::getatt" } } }, "AWS::Logs::Destination": { "MarkdownDocumentation": "`AWS::Logs::Destination`\n\nThe AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A\ndestination encapsulates a physical resource (such as an Amazon Kinesis data stream) and\nenables you to subscribe that resource to a stream of log events.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name, such as\n`TestDestination`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html", "Properties": { "DestinationPolicy": { "MarkdownDocumentation": "`DestinationPolicy`\n\nAn IAM policy document that governs which AWS accounts can create\nsubscription 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationName": { "MarkdownDocumentation": "`DestinationName`\n\nThe name of the destination.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^:*]{1,512}$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe Amazon Resource Name (ARN) of the physical target where the log events are\ndelivered (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that have been assigned to this delivery destination.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-logs-destination-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of an IAM role that permits CloudWatch Logs to send data to the\nspecified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the CloudWatch Logs destination, such as\n`arn:aws:logs:us-west-1:123456789012:destination:MyDestination`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#Arn-fn::getatt" } } }, "AWS::Logs::Integration": { "MarkdownDocumentation": "`AWS::Logs::Integration`\n\nCreates an integration between CloudWatch Logs and another service in this account.\nCurrently, only integrations with OpenSearch Service are supported, and currently you can have\nonly one integration in your account.\nIntegrating with OpenSearch Service makes it possible for you to create curated vended\nlogs dashboards, powered by OpenSearch Service analytics. For more information, see [Vended log\ndashboards powered by Amazon OpenSearch Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-OpenSearch-Dashboards.html).\nYou can use this operation only to create a new integration. You can't modify an existing\nintegration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html", "Properties": { "IntegrationName": { "MarkdownDocumentation": "`IntegrationName`\n\nThe name of this integration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#cfn-logs-integration-integrationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceConfig": { "MarkdownDocumentation": "`ResourceConfig`\n\nThis structure contains configuration details about an integration between CloudWatch\nLogs and another entity.\n*Required*: Yes\n*Type*: [ResourceConfig](./aws-properties-logs-integration-resourceconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#cfn-logs-integration-resourceconfig", "UpdateType": "Immutable", "Required": true, "Type": "ResourceConfig" }, "IntegrationType": { "MarkdownDocumentation": "`IntegrationType`\n\nThe type of integration. Integrations with OpenSearch Service have the type\n`OPENSEARCH`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OPENSEARCH`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "OPENSEARCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#cfn-logs-integration-integrationtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "IntegrationStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`IntegrationStatus`\n\nThe current status of this integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#IntegrationStatus-fn::getatt" } } }, "AWS::Logs::LogAnomalyDetector": { "MarkdownDocumentation": "`AWS::Logs::LogAnomalyDetector`\n\nCreates or updates an *anomaly detector* that regularly scans one\nor more log groups and look for patterns and anomalies in the logs.\nAn anomaly detector can help surface issues by automatically discovering anomalies in\nyour log event traffic. An anomaly detector uses machine learning algorithms to scan log\nevents and find *patterns*. A pattern is a shared text structure that\nrecurs among your log fields. Patterns provide a useful tool for analyzing large sets of\nlogs because a large number of log events can often be compressed into a few\npatterns.\nThe anomaly detector uses pattern recognition to find `anomalies`, which\nare unusual log events. It compares current log events and patterns with trained\nbaselines.\nFields within a pattern are called *tokens*. Fields that vary\nwithin a pattern, such as a request ID or timestamp, are referred to as\n*dynamic tokens* and represented by `<*>`.\nFor more information see [Log anomaly\ndetection](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html", "Properties": { "AnomalyVisibilityTime": { "MarkdownDocumentation": "`AnomalyVisibilityTime`\n\nThe number of days to have visibility on an anomaly. After this time period has\nelapsed for an anomaly, it will be automatically baselined and the anomaly detector will\ntreat new occurrences of a similar anomaly as normal. Therefore, if you do not correct\nthe cause of an anomaly during the time period specified in\n`AnomalyVisibilityTime`, it will be considered normal going forward and\nwill not be detected as an anomaly.\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-anomalyvisibilitytime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "FilterPattern": { "MarkdownDocumentation": "`FilterPattern`\n\nYou can use this parameter to limit the anomaly detection model to examine only log\nevents that match the pattern you specify here. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-filterpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccountId": { "MarkdownDocumentation": "`AccountId`\n\nThe ID of the account to create the anomaly detector 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-accountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nOptionally assigns a AWS KMS key to secure this anomaly detector and its\nfindings. If a key is assigned, the anomalies found and the model used by this detector\nare encrypted at rest with the key. If a key is assigned to an anomaly detector, a user\nmust have permissions for both this key and for the anomaly detector to retrieve\ninformation about the anomalies that it finds.\nFor more information about using a AWS KMS key and to see the required\nIAM policy, see [Use a AWS KMS key with an anomaly detector](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogGroupArnList": { "MarkdownDocumentation": "`LogGroupArnList`\n\nThe ARN of the log group that is associated with this anomaly detector. You can\nspecify only one log group ARN.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-loggrouparnlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "EvaluationFrequency": { "MarkdownDocumentation": "`EvaluationFrequency`\n\nSpecifies how often the anomaly detector is to run and look for anomalies. Set this\nvalue according to the frequency that the log group receives new logs. For example, if\nthe log group receives new log events every 10 minutes, then 15 minutes might be a good\nsetting for `EvaluationFrequency` .\n*Required*: No\n*Type*: String\n*Allowed values*: `FIVE_MIN | TEN_MIN | FIFTEE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIVE_MIN", "TEN_MIN", "FIFTEEN_MIN", "THIRTY_MIN", "ONE_HOUR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-evaluationfrequency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DetectorName": { "MarkdownDocumentation": "`DetectorName`\n\nA name for this anomaly detector.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-detectorname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CreationTimeStamp": { "PrimitiveType": "Double", "MarkdownDocumentation": "`CreationTimeStamp`\n\nThe time that the anomaly detector was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#CreationTimeStamp-fn::getatt" }, "AnomalyDetectorStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`AnomalyDetectorStatus`\n\nSpecifies whether the anomaly detector is currently active.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#AnomalyDetectorStatus-fn::getatt" }, "AnomalyDetectorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AnomalyDetectorArn`\n\nThe ARN of the anomaly detector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#AnomalyDetectorArn-fn::getatt" }, "LastModifiedTimeStamp": { "PrimitiveType": "Double", "MarkdownDocumentation": "`LastModifiedTimeStamp`\n\nThe time that the anomaly detector was most recently modified.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#LastModifiedTimeStamp-fn::getatt" } } }, "AWS::Logs::LogGroup": { "MarkdownDocumentation": "`AWS::Logs::LogGroup`\n\nThe `AWS::Logs::LogGroup` resource specifies a log group. A log group\ndefines common properties for log streams, such as their retention and access control\nrules. Each log stream must belong to one log group.\nYou can create up to 1,000,000 log groups per Region per account. You must use the\nfollowing guidelines when naming a log group:\n* Log group names must be unique within a Region for an AWS\n account.\n* Log group names can be between 1 and 512 characters long.\n* Log group names consist of the following characters: a-z, A-Z, 0-9, '\\_'\n (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html", "Properties": { "FieldIndexPolicies": { "MarkdownDocumentation": "`FieldIndexPolicies`\n\nCreates or updates a *field index policy* for the specified log\ngroup. Only log groups in the Standard log class support field index policies. For more\ninformation about log classes, see [Log\nclasses](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html).\nYou can use field index policies to create *field indexes* on\nfields found in log events in the log group. Creating field indexes lowers the costs for\nCloudWatch Logs Insights queries that reference those field indexes, because\nthese queries attempt to skip the processing of log events that are known to not match\nthe indexed field. Good fields to index are fields that you often need to query for and\nfields that have high cardinality of values Common examples of indexes include request\nID, session ID, userID, and instance IDs. For more information, see [Create field\nindexes to improve query performance and reduce costs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html).\nCurrently, this array supports only one field index policy object.\n*Required*: No\n*Type*: Array of Object\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-fieldindexpolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "Json", "DuplicatesAllowed": false }, "RetentionInDays": { "MarkdownDocumentation": "`RetentionInDays`\n\nThe number of days to retain the log events in the specified log group. Possible\nvalues are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827,\n2192, 2557, 2922, 3288, and 3653.\nTo set a log group so that its log events do not expire, do not specify this\nproperty.\n*Required*: No\n*Type*: Integer\n*Allowed values*: `1 | 3 | 5 | 7 | 14 | 30 | 6...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "1", "3", "5", "7", "14", "30", "60", "90", "120", "150", "180", "365", "400", "545", "731", "1096", "1827", "2192", "2557", "2922", "3288", "3653" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-retentionindays", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting\nlog data.\nTo associate an AWS KMS key with the log group, specify the ARN of that KMS\nkey here. If you do so, ingested data is encrypted using this key. This association is\nstored 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\nrequested.\nIf you attempt to associate a KMS key with the log group but the KMS key doesn't\nexist or is deactivated, you will receive an `InvalidParameterException`\nerror.\nLog group data is always encrypted in CloudWatch Logs. If you omit this key, the\nencryption 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*Pattern*: `^arn:[a-z0-9-]+:kms:[a-z0-9-]+:\\d{12}:(key|alias)/.+\\Z`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogGroupClass": { "MarkdownDocumentation": "`LogGroupClass`\n\nSpecifies the log group class for this log group. There are two classes:\n* The `Standard` log class supports all CloudWatch Logs\n features.\n* The `Infrequent Access` log class supports a subset of CloudWatch Logs features and incurs lower costs.\nFor details about the features supported by each class, see [Log\nclasses](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | INFREQUENT_ACCES...`\n*Update requires*: Updates are not supported.", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "INFREQUENT_ACCESS", "DELIVERY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourcePolicyDocument": { "MarkdownDocumentation": "`ResourcePolicyDocument`\n\nCreates or updates a resource policy for the specified log group that allows other\nservices to put log events to this account. A LogGroup can have 1 resource\npolicy.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-resourcepolicydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe name of the log group. If you don't specify a name, AWS CloudFormation\ngenerates a unique ID for the log group.\n*Required*: No\n*Type*: String\n*Pattern*: `^[.\\-_/#A-Za-z0-9]{1,512}\\Z`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-logs-loggroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "DataProtectionPolicy": { "MarkdownDocumentation": "`DataProtectionPolicy`\n\nCreates a data protection policy and assigns it to the log group. A data protection\npolicy can help safeguard sensitive data that's ingested by the log group by auditing\nand masking the sensitive log data. When a user who does not have permission to view\nmasked data views a log event that includes masked data, the sensitive data is replaced\nby asterisks.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the log group, such as\n`arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#Arn-fn::getatt" } } }, "AWS::Logs::LogStream": { "MarkdownDocumentation": "`AWS::Logs::LogStream`\n\nThe `AWS::Logs::LogStream` resource specifies an Amazon CloudWatch Logs log stream in a specific log group. A log stream represents the sequence of events\ncoming from an application instance or resource that you are monitoring.\nThere is no limit on the number of log streams that you can create for a log\ngroup.\nYou must use the following guidelines when naming a log stream:\n* Log stream names must be unique within the log group.\n* Log stream names can be between 1 and 512 characters long.\n* The ':' (colon) and '\\*' (asterisk) characters are not allowed.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name, such as `MyAppLogStream`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html", "Properties": { "LogStreamName": { "MarkdownDocumentation": "`LogStreamName`\n\nThe name of the log stream. The name must be unique within the log group.\n*Required*: No\n*Type*: String\n*Pattern*: `[^:*]*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe name of the log group where the log stream is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Logs::MetricFilter": { "MarkdownDocumentation": "`AWS::Logs::MetricFilter`\n\nThe `AWS::Logs::MetricFilter` resource specifies a metric filter that\ndescribes how CloudWatch Logs extracts information from logs and transforms it into\nAmazon CloudWatch metrics. If you have multiple metric filters that are associated with\na log group, all the filters are applied to the log streams in that group.\nThe maximum number of metric filters that can be associated with a log group is\n100.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html", "Properties": { "FieldSelectionCriteria": { "MarkdownDocumentation": "`FieldSelectionCriteria`\n\nThe filter expression that specifies which log events are processed by this metric filter\nbased on system fields. Returns the `fieldSelectionCriteria` value if it was\nspecified when the metric filter was created.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-fieldselectioncriteria", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetricTransformations": { "MarkdownDocumentation": "`MetricTransformations`\n\nThe metric transformations.\n*Required*: Yes\n*Type*: Array of [MetricTransformation](./aws-properties-logs-metricfilter-metrictransformation.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-metrictransformations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "MetricTransformation", "DuplicatesAllowed": true }, "FilterPattern": { "MarkdownDocumentation": "`FilterPattern`\n\nA filter pattern for extracting metric data out of ingested log events. For more\ninformation, see [Filter and Pattern\nSyntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filterpattern", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EmitSystemFieldDimensions": { "MarkdownDocumentation": "`EmitSystemFieldDimensions`\n\nThe list of system fields that are emitted as additional dimensions in the generated\nmetrics. Returns the `emitSystemFieldDimensions` value if it was specified when the\nmetric filter was created.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-emitsystemfielddimensions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe name of an existing log group that you want to associate with this metric\nfilter.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[.\\-_/#A-Za-z0-9]{1,512}`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-loggroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplyOnTransformedLogs": { "MarkdownDocumentation": "`ApplyOnTransformedLogs`\n\nThis parameter is valid only for log groups that have an active log transformer. For\nmore information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html).\nIf this value is `true`, the metric filter is applied on the transformed\nversion of the log events instead of the original ingested log events.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-applyontransformedlogs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FilterName": { "MarkdownDocumentation": "`FilterName`\n\nThe name of the metric filter.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^:*]{1,512}`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filtername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Logs::QueryDefinition": { "MarkdownDocumentation": "`AWS::Logs::QueryDefinition`\n\nCreates a query definition for CloudWatch Logs Insights. For more information,\nsee [Analyzing Log Data with CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the query definition ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html", "Properties": { "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nThe query string to use for this query definition. For more information, see [CloudWatch Logs Insights Query Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querystring", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LogGroupNames": { "MarkdownDocumentation": "`LogGroupNames`\n\nUse this parameter if you want the query to query only certain log groups.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-loggroupnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "QueryLanguage": { "MarkdownDocumentation": "`QueryLanguage`\n\nThe query language used for this query. For more information about the query languages\nthat CloudWatch Logs supports, see [Supported query\nlanguages](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `CWLI | SQL | PPL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CWLI", "SQL", "PPL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querylanguage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the query definition.\n###### Note\nYou can use the name to create a folder structure for your queries. To create a\nfolder, use a forward slash (/) to prefix your desired query name with your desired\nfolder name. For example,\n`folder-name/query-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "QueryDefinitionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`QueryDefinitionId`\n\nThe ID of the query definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#QueryDefinitionId-fn::getatt" } } }, "AWS::Logs::ResourcePolicy": { "MarkdownDocumentation": "`AWS::Logs::ResourcePolicy`\n\nCreates or updates a resource policy that allows other AWS\nservices to put log events to this account. An account can have up to 10 resource\npolicies per AWS Region.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `PolicyName` of the resource\npolicy.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html", "Properties": { "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the resource policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([^:*\\/]+\\/?)*[^:*\\/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe details of the policy. It must be formatted in JSON, and you must use\nbackslashes to escape characters that need to be escaped in JSON strings, such as double\nquote marks.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `5120`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Logs::SubscriptionFilter": { "MarkdownDocumentation": "`AWS::Logs::SubscriptionFilter`\n\nThe `AWS::Logs::SubscriptionFilter` resource specifies a subscription\nfilter and associates it with the specified log group. Subscription filters allow you to\nsubscribe to a real-time stream of log events and have them delivered to a specific\ndestination. Currently, the supported destinations are:\n* An Amazon Kinesis data stream belonging to the same account as the\n subscription filter, for same-account delivery.\n* A logical destination that belongs to a different account, for\n cross-account delivery.\n* An Amazon Kinesis Firehose delivery stream that belongs to the same account\n as the subscription filter, for same-account delivery.\n* An AWS Lambda function that belongs to the same account as\n the subscription filter, for same-account delivery.\nThere can be as many as two subscription filters associated with a log\ngroup.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html", "Properties": { "FieldSelectionCriteria": { "MarkdownDocumentation": "`FieldSelectionCriteria`\n\nThe filter expression that specifies which log events are processed by this subscription\nfilter based on system fields. Returns the `fieldSelectionCriteria` value if it was\nspecified when the subscription filter was created.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-fieldselectioncriteria", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FilterPattern": { "MarkdownDocumentation": "`FilterPattern`\n\nThe filtering expressions that restrict what gets delivered to the destination\nAWS resource. For more information about the filter pattern syntax,\nsee [Filter and Pattern\nSyntax](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EmitSystemFields": { "MarkdownDocumentation": "`EmitSystemFields`\n\nThe list of system fields that are included in the log events sent to the subscription\ndestination. Returns the `emitSystemFields` value if it was specified when the\nsubscription filter was created.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-emitsystemfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Distribution": { "MarkdownDocumentation": "`Distribution`\n\nThe method used to distribute log data to the destination, which can be either random\nor grouped by log stream.\n*Required*: No\n*Type*: String\n*Allowed values*: `Random | ByLogStream...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Random", "ByLogStream" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogGroupName": { "MarkdownDocumentation": "`LogGroupName`\n\nThe log group to associate with the subscription filter. All log events that are\nuploaded 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*Pattern*: `[\\.\\-_/#A-Za-z0-9]+`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplyOnTransformedLogs": { "MarkdownDocumentation": "`ApplyOnTransformedLogs`\n\nThis parameter is valid only for log groups that have an active log transformer. For\nmore information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html).\nIf this value is `true`, the subscription filter is applied on the\ntransformed version of the log events instead of the original ingested log\nevents.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-applyontransformedlogs", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FilterName": { "MarkdownDocumentation": "`FilterName`\n\nThe name of the subscription filter.\n*Required*: No\n*Type*: String\n*Pattern*: `[^:*]*`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nThe Amazon Resource Name (ARN) of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of an IAM role that grants CloudWatch Logs permissions to deliver\ningested log events to the destination stream. You don't need to provide the ARN when\nyou are working with a logical destination for cross-account delivery.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Logs::Transformer": { "MarkdownDocumentation": "`AWS::Logs::Transformer`\n\nCreates or updates a *log transformer* for a single log group. You\nuse log transformers to transform log events into a different format, making them easier\nfor you to process and analyze. You can also transform logs from different sources into\nstandardized formats that contains relevant, source-specific information.\nAfter you have created a transformer, CloudWatch Logs performs the transformations at\nthe time of log ingestion. You can then refer to the transformed versions of the logs\nduring operations such as querying with CloudWatch Logs Insights or creating metric\nfilters or subscription filers.\nYou can also use a transformer to copy metadata from metadata keys into the log events\nthemselves. This metadata can include log group name, log stream name, account ID and\nRegion.\nA transformer for a log group is a series of processors, where each processor applies\none type of transformation to the log events ingested into this log group. The\nprocessors work one after another, in the order that you list them, like a pipeline. For\nmore information about the available processors to use in a transformer, see [Processors that you can use](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-Processors).\nHaving log events in standardized format enables visibility across your applications\nfor your log analysis, reporting, and alarming needs. CloudWatch Logs provides\ntransformation for common log types with out-of-the-box transformation templates for\nmajor AWS log sources such as VPC flow logs, Lambda, and Amazon RDS. You\ncan use pre-built transformation templates or create custom transformation\npolicies.\nYou can create transformers only for the log groups in the Standard log class.\nYou can also set up a transformer at the account level. For more information, see\n[PutAccountPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html). If there is both a log-group level transformer created\nwith `PutTransformer` and an account-level transformer that could apply to\nthe same log group, the log group uses only the log-group level transformer. It ignores\nthe account-level transformer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-transformer.html", "Properties": { "TransformerConfig": { "MarkdownDocumentation": "`TransformerConfig`\n\nThis structure is an array that contains the configuration of this log transformer. A\nlog transformer is an array of processors, where each processor applies one type of\ntransformation to the log events that are ingested.\n*Required*: Yes\n*Type*: Array of [Processor](./aws-properties-logs-transformer-processor.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-transformer.html#cfn-logs-transformer-transformerconfig", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Processor", "DuplicatesAllowed": true }, "LogGroupIdentifier": { "MarkdownDocumentation": "`LogGroupIdentifier`\n\nSpecify either the name or ARN of the log group to create the transformer for.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w#+=/:,.@-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-transformer.html#cfn-logs-transformer-loggroupidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::LookoutVision::Project": { "MarkdownDocumentation": "`AWS::LookoutVision::Project`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutvision-project.html", "Properties": { "ProjectName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutvision-project.html#cfn-lookoutvision-project-projectname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutvision-project.html#Arn-fn::getatt" } } }, "AWS::M2::Application": { "MarkdownDocumentation": "`AWS::M2::Application`\n\nSpecifies a new application with given parameters. Requires an existing runtime\nenvironment and application definition file.\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", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application Amazon Resource Name (ARN), such as the\nfollowing:\n`{ \"Ref\": \u201cSampleApp\u201d }`\nReturns a value similar to the following:\n`arn:aws:m2:us-west-2:1234567890:app/y3ca6bhaife2bcvxar3lpivfou`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe identifier of a customer managed key.\n*Required*: No\n*Type*: String\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe application definition for a particular application. You can specify either inline\nJSON 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*: No\n*Type*: [Definition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-definition", "UpdateType": "Mutable", "Required": false, "Type": "Definition" }, "EngineType": { "MarkdownDocumentation": "`EngineType`\n\nThe type of the target platform for this application.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `microfocus | bluage...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "microfocus", "bluage" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-enginetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the role associated with the application.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-rolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Object of String\n*Pattern*: `^(?!aws:).+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ApplicationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApplicationArn`\n\nThe Amazon Resource Name (ARN) of the application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#ApplicationArn-fn::getatt" }, "ApplicationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApplicationId`\n\nThe identifier of the application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#ApplicationId-fn::getatt" } } }, "AWS::M2::Deployment": { "MarkdownDocumentation": "`AWS::M2::Deployment`\n\n###### Important\nAWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can\ncontinue to use the service as normal. For more information, see\n[AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html).\nCreates and starts a deployment to deploy an application into a runtime\nenvironment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html", "Properties": { "EnvironmentId": { "MarkdownDocumentation": "`EnvironmentId`\n\nThe unique identifier of the runtime environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\S{1,80}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-environmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplicationVersion": { "MarkdownDocumentation": "`ApplicationVersion`\n\nThe version of the application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-applicationversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ApplicationId": { "MarkdownDocumentation": "`ApplicationId`\n\nThe unique identifier of the application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\S{1,80}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-applicationid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#Status-fn::getatt" }, "DeploymentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeploymentId`\n\nThe unique identifier of the deployment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#DeploymentId-fn::getatt" } } }, "AWS::M2::Environment": { "MarkdownDocumentation": "`AWS::M2::Environment`\n\nSpecifies a runtime environment for a given runtime engine.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the environment Amazon Resource Name (ARN), such as the\nfollowing:\n`{ \"Ref\": \u201cSampleEnv\u201d }`\nReturns a value similar to the following:\n`arn:aws:m2:us-west-2:1234567890:env/y3ca6bhaife2bcvxar3lpivfou`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe identifier of a customer managed key.\n*Required*: No\n*Type*: String\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "HighAvailabilityConfig": { "MarkdownDocumentation": "`HighAvailabilityConfig`\n\n###### Important\nAWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can\ncontinue to use the service as normal. For more information, see\n[AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html).\nDefines the details of a high availability configuration.\n*Required*: No\n*Type*: [HighAvailabilityConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-highavailabilityconfig", "UpdateType": "Mutable", "Required": false, "Type": "HighAvailabilityConfig" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nConfigures the maintenance window that you want for the runtime environment. The maintenance window must have the format `ddd:hh24:mi-ddd:hh24:mi` and must be less than 24 hours. The following two examples are valid maintenance windows: `sun:23:45-mon:00:15` or `sat:01:00-sat:03:00`.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-preferredmaintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe list of security groups for the VPC associated with this runtime environment.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-securitygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe list of subnets associated with the VPC for this runtime environment.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-subnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nThe network type supported by the runtime environment.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | dual...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "dual" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-networktype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EngineType": { "MarkdownDocumentation": "`EngineType`\n\nThe target platform for the runtime environment.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `microfocus | bluage...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "microfocus", "bluage" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-enginetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-publiclyaccessible", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "InstanceType": { "MarkdownDocumentation": "`InstanceType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-instancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StorageConfigurations": { "MarkdownDocumentation": "`StorageConfigurations`\n\n###### Important\nAWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can\ncontinue to use the service as normal. For more information, see\n[AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html).\nDefines the storage configuration for a runtime environment.\n*Required*: No\n*Type*: Array of [StorageConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-storageconfigurations", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "StorageConfiguration", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Object of String\n*Pattern*: `^(?!aws:).+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "EnvironmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentId`\n\nThe unique identifier of the runtime environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#EnvironmentId-fn::getatt" }, "EnvironmentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentArn`\n\nThe Amazon Resource Name (ARN) of the runtime environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#EnvironmentArn-fn::getatt" } } }, "AWS::MSK::BatchScramSecret": { "MarkdownDocumentation": "`AWS::MSK::BatchScramSecret`\n\nRepresents a secret stored in the AWS Secrets Manager that can be used to authenticate with a cluster using a user name and a password.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the secret stored in the Secrets Manager.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html", "Properties": { "ClusterArn": { "MarkdownDocumentation": "`ClusterArn`\n\nThe Amazon Resource Name (ARN) that uniquely identifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html#cfn-msk-batchscramsecret-clusterarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecretArnList": { "MarkdownDocumentation": "`SecretArnList`\n\nList of Amazon Resource Name (ARN)s of Secrets Manager secrets.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html#cfn-msk-batchscramsecret-secretarnlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } } }, "AWS::MSK::Cluster": { "MarkdownDocumentation": "`AWS::MSK::Cluster`\n\nCreates a new MSK cluster.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the ARN of the created MSK cluster. For example, `arn:aws:kafka:us-east-1:123456789012:cluster/myCluster/abcd1234-abcd-dcba-4321-a1b2abcd9f9f-2`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html", "Properties": { "KafkaVersion": { "MarkdownDocumentation": "`KafkaVersion`\n\nThe version of Apache Kafka. You can use Amazon MSK to create clusters that use [supported Apache Kafka versions](https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-kafkaversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NumberOfBrokerNodes": { "MarkdownDocumentation": "`NumberOfBrokerNodes`\n\nThe number of broker nodes in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-numberofbrokernodes", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "Rebalancing": { "MarkdownDocumentation": "`Rebalancing`\n\nProperty description not available.\n*Required*: No\n*Type*: [Rebalancing](./aws-properties-msk-cluster-rebalancing.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-rebalancing", "UpdateType": "Mutable", "Required": false, "Type": "Rebalancing" }, "EncryptionInfo": { "MarkdownDocumentation": "`EncryptionInfo`\n\nIncludes all encryption-related information.\n*Required*: No\n*Type*: [EncryptionInfo](./aws-properties-msk-cluster-encryptioninfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-encryptioninfo", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionInfo" }, "OpenMonitoring": { "MarkdownDocumentation": "`OpenMonitoring`\n\nThe settings for open monitoring.\n*Required*: No\n*Type*: [OpenMonitoring](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-openmonitoring", "UpdateType": "Mutable", "Required": false, "Type": "OpenMonitoring" }, "StorageMode": { "MarkdownDocumentation": "`StorageMode`\n\nThis controls storage mode for supported storage tiers.\n*Required*: No\n*Type*: String\n*Allowed values*: `LOCAL | TIERED...`\n*Minimum*: `5`\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)", "RefReturnValue": "", "AllowedValues": [ "LOCAL", "TIERED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-storagemode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfigurationInfo": { "MarkdownDocumentation": "`ConfigurationInfo`\n\nRepresents the configuration that you want MSK to use for the cluster.\n*Required*: No\n*Type*: [ConfigurationInfo](./aws-properties-msk-cluster-configurationinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-configurationinfo", "UpdateType": "Mutable", "Required": false, "Type": "ConfigurationInfo" }, "BrokerNodeGroupInfo": { "MarkdownDocumentation": "`BrokerNodeGroupInfo`\n\nInformation about the broker nodes in the cluster.\n*Required*: Yes\n*Type*: [BrokerNodeGroupInfo](./aws-properties-msk-cluster-brokernodegroupinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-brokernodegroupinfo", "UpdateType": "Mutable", "Required": true, "Type": "BrokerNodeGroupInfo" }, "EnhancedMonitoring": { "MarkdownDocumentation": "`EnhancedMonitoring`\n\nSpecifies the level of monitoring for the MSK cluster.\n*Required*: No\n*Type*: String\n*Allowed values*: `DEFAULT | PER_BROKER | PER_...`\n*Minimum*: `7`\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)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "PER_BROKER", "PER_TOPIC_PER_BROKER", "PER_TOPIC_PER_PARTITION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-enhancedmonitoring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClientAuthentication": { "MarkdownDocumentation": "`ClientAuthentication`\n\nIncludes all client authentication related information.\n*Required*: No\n*Type*: [ClientAuthentication](./aws-properties-msk-cluster-clientauthentication.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clientauthentication", "UpdateType": "Mutable", "Required": false, "Type": "ClientAuthentication" }, "LoggingInfo": { "MarkdownDocumentation": "`LoggingInfo`\n\nLogging info details for the cluster.\n*Required*: No\n*Type*: [LoggingInfo](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-logginginfo", "UpdateType": "Mutable", "Required": false, "Type": "LoggingInfo" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key-value pairs) for the cluster.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "CurrentVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`CurrentVersion`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#CurrentVersion-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the MSK cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#Arn-fn::getatt" } } }, "AWS::MSK::ClusterPolicy": { "MarkdownDocumentation": "`AWS::MSK::ClusterPolicy`\n\nCreate or update cluster policy.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the cluster for the resource policy.\nFor Amazon MSK cluster policy `MyClusterPolicy`, `Ref` returns the cluster ARN for the resource policy whose logical ID is `MyClusterPolicy`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-clusterpolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nResource policy for the cluster. The maximum size supported for a resource-based policy document is 20 KB.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-clusterpolicy.html#cfn-msk-clusterpolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ClusterArn": { "MarkdownDocumentation": "`ClusterArn`\n\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:kafka:[\\w-]+:\\d+:cluster.*\\Z`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-clusterpolicy.html#cfn-msk-clusterpolicy-clusterarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CurrentVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`CurrentVersion`\n\nThe current version of the policy attached to the specified cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-clusterpolicy.html#CurrentVersion-fn::getatt" } } }, "AWS::MSK::Configuration": { "MarkdownDocumentation": "`AWS::MSK::Configuration`\n\nCreates a new MSK configuration. To see an example of how to use this operation, first save the following text to a file and name the file `config-file.txt`.\n```\nauto.create.topics.enable = true\nzookeeper.connection.timeout.ms = 1000\nlog.roll.ms = 604800000\n```\nNow run the following Python 3.6 script in the folder where you saved `config-file.txt`. This script uses the properties specified in `config-file.txt` to create a configuration named `SalesClusterConfiguration`. This configuration can work with Apache Kafka versions 1.1.1 and 2.1.0.\n```\nimport boto3\nclient = boto3.client('kafka')\nconfig_file = open('config-file.txt', 'r')\nserver_properties = config_file.read()\nresponse = client.create_configuration(\n Name='SalesClusterConfiguration',\n Description='The configuration to use on all sales clusters.',\n KafkaVersions=['1.1.1', '2.1.0'],\n ServerProperties=server_properties\n)\nprint(response)\n```\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic function, it returns the MSK configuration.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LatestRevision": { "MarkdownDocumentation": "`LatestRevision`\n\nLatest revision of the MSK configuration.\n*Required*: No\n*Type*: [LatestRevision](./aws-properties-msk-configuration-latestrevision.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-latestrevision", "UpdateType": "Mutable", "Required": false, "Type": "LatestRevision" }, "ServerProperties": { "MarkdownDocumentation": "`ServerProperties`\n\nContents of the `server.properties` file. When using the console, the SDK, or the AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-serverproperties", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KafkaVersionsList": { "MarkdownDocumentation": "`KafkaVersionsList`\n\nThe [versions of Apache Kafka](https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html) with which you can use this MSK configuration.\nWhen you update the `KafkaVersionsList` property, CloudFormation recreates a new configuration with the updated property before deleting the old configuration. Such an update requires a [resource replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement). To successfully update `KafkaVersionsList`, you must also update the `Name` property in the same operation.\nIf your configuration is attached with any clusters created using the AWS Management Console or AWS CLI, you'll need to manually delete the old configuration from the console after the update completes.\nFor more information, see [Can\u2019t update KafkaVersionsList in MSK configuration](https://docs.aws.amazon.com/msk/latest/developerguide/troubleshooting.html#troubleshoot-kafkaversionslist-cfn-update-failure) in the *Amazon MSK Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-kafkaversionslist", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "LatestRevision.Revision": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`LatestRevision.Revision`\n\nThe revision number.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#LatestRevision.Revision-fn::getatt" }, "LatestRevision.CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestRevision.CreationTime`\n\nThe time when the configuration revision was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#LatestRevision.CreationTime-fn::getatt" }, "LatestRevision.Description": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestRevision.Description`\n\nThe description of the configuration revision.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#LatestRevision.Description-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#Arn-fn::getatt" } } }, "AWS::MSK::Replicator": { "MarkdownDocumentation": "`AWS::MSK::Replicator`\n\nCreates the replicator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA summary description of the replicator.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServiceExecutionRoleArn": { "MarkdownDocumentation": "`ServiceExecutionRoleArn`\n\nThe ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn):iam:.*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-serviceexecutionrolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ReplicatorName": { "MarkdownDocumentation": "`ReplicatorName`\n\nThe name of the replicator. Alpha-numeric characters with '-' are allowed.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z][0-9A-Za-z-]{0,}$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-replicatorname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ReplicationInfoList": { "MarkdownDocumentation": "`ReplicationInfoList`\n\nA list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.\n*Required*: Yes\n*Type*: Array of [ReplicationInfo](./aws-properties-msk-replicator-replicationinfo.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-replicationinfolist", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ReplicationInfo", "DuplicatesAllowed": false }, "KafkaClusters": { "MarkdownDocumentation": "`KafkaClusters`\n\nKafka Clusters to use in setting up sources / targets for replication.\n*Required*: Yes\n*Type*: Array of [KafkaCluster](./aws-properties-msk-replicator-kafkacluster.html)\n*Minimum*: `2`\n*Maximum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-kafkaclusters", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "KafkaCluster", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nList of tags to attach to created Replicator.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-msk-replicator-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ReplicatorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReplicatorArn`\n\nAmazon Resource Name (ARN) for the created replicator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#ReplicatorArn-fn::getatt" }, "CurrentVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`CurrentVersion`\n\nThe current version number of the replicator.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#CurrentVersion-fn::getatt" } } }, "AWS::MSK::ServerlessCluster": { "MarkdownDocumentation": "`AWS::MSK::ServerlessCluster`\n\nSpecifies the properties required for creating a serverless cluster.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic function, it returns the ARN of the created MSK cluster.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html", "Properties": { "VpcConfigs": { "MarkdownDocumentation": "`VpcConfigs`\n\nVPC configuration information for the serverless cluster.\n*Required*: Yes\n*Type*: Array of [VpcConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#cfn-msk-serverlesscluster-vpcconfigs", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "VpcConfig", "DuplicatesAllowed": false }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#cfn-msk-serverlesscluster-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClientAuthentication": { "MarkdownDocumentation": "`ClientAuthentication`\n\nIncludes all client authentication related information.\n*Required*: Yes\n*Type*: [ClientAuthentication](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#cfn-msk-serverlesscluster-clientauthentication", "UpdateType": "Immutable", "Required": true, "Type": "ClientAuthentication" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key-value pairs) for the cluster.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#cfn-msk-serverlesscluster-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the MSK cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#Arn-fn::getatt" } } }, "AWS::MSK::VpcConnection": { "MarkdownDocumentation": "`AWS::MSK::VpcConnection`\n\nCreate remote VPC connection.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the VPC connection.\nFor Amazon MSK VPC connection `MyVpcConnection`, `Ref` returns the ARN of the VPC connection whose logical ID is `MyVpcConnection`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html", "Properties": { "SecurityGroups": { "MarkdownDocumentation": "`SecurityGroups`\n\nThe security groups to attach to the ENIs for the broker nodes.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-securitygroups", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TargetClusterArn": { "MarkdownDocumentation": "`TargetClusterArn`\n\nThe Amazon Resource Name (ARN) of the cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:kafka:[\\w-]+:\\d+:cluster.*\\Z`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-targetclusterarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClientSubnets": { "MarkdownDocumentation": "`ClientSubnets`\n\nThe list of subnets in the client VPC to connect to.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-clientsubnets", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe VPC ID of the remote client.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(vpc-)([a-z0-9]+)\\Z`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Authentication": { "MarkdownDocumentation": "`Authentication`\n\nThe type of private link authentication.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SASL_IAM | SASL_SCRAM | TLS...`\n*Minimum*: `3`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SASL_IAM", "SASL_SCRAM", "TLS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-authentication", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the VPC connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#Arn-fn::getatt" } } }, "AWS::MWAA::Environment": { "MarkdownDocumentation": "`AWS::MWAA::Environment`\n\nThe `AWS::MWAA::Environment` resource creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the environment details.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html", "Properties": { "AirflowConfigurationOptions": { "MarkdownDocumentation": "`AirflowConfigurationOptions`\n\nA 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*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowconfigurationoptions", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "PluginsS3Path": { "MarkdownDocumentation": "`PluginsS3Path`\n\nThe 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*Pattern*: `.*`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WorkerReplacementStrategy": { "MarkdownDocumentation": "`WorkerReplacementStrategy`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `FORCED | GRACEFUL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FORCED", "GRACEFUL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-workerreplacementstrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartupScriptS3Path": { "MarkdownDocumentation": "`StartupScriptS3Path`\n\nThe relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh`.\nAmazon MWAA runs the script as your environment starts, and before running the Apache Airflow process.\nYou can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see\n[Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html).\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of your Amazon MWAA environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z][0-9a-zA-Z\\-_]*$`\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe 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*Pattern*: `^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\n*Maximum*: `1224`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-executionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartupScriptS3ObjectVersion": { "MarkdownDocumentation": "`StartupScriptS3ObjectVersion`\n\nThe version of the startup shell script in your Amazon S3 bucket. You must specify the [version ID](https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) that Amazon S3 assigns to the file\nevery time you update the script.\nVersion IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:\n`3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo`\nFor more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html).\n*Required*: No\n*Type*: String\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3objectversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DagS3Path": { "MarkdownDocumentation": "`DagS3Path`\n\nThe 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*Pattern*: `.*`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-dags3path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoggingConfiguration": { "MarkdownDocumentation": "`LoggingConfiguration`\n\nThe Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs`, `SchedulerLogs`, `TaskLogs`, `WebserverLogs`, `WorkerLogs`.\n*Required*: No\n*Type*: [LoggingConfiguration](./aws-properties-mwaa-environment-loggingconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-loggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LoggingConfiguration" }, "WebserverAccessMode": { "MarkdownDocumentation": "`WebserverAccessMode`\n\nThe 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*Allowed values*: `PRIVATE_ONLY | PUBLIC_ONLY...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PRIVATE_ONLY", "PUBLIC_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-webserveraccessmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe VPC networking components used to secure and enable network traffic between the AWS resources for your environment. 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*: [NetworkConfiguration](./aws-properties-mwaa-environment-networkconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-networkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NetworkConfiguration" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nThe AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).\n*Required*: No\n*Type*: String\n*Pattern*: `^(((arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?key\\/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|(arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?alias/.+)$`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-kmskey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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).\nIf you specify new tags for an existing environment, the update requires service interruption before taking effect.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-tags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MaxWorkers": { "MarkdownDocumentation": "`MaxWorkers`\n\nThe maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the `MaxWorkers` field. For example, `20`. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in `MinWorkers`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxworkers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnvironmentClass": { "MarkdownDocumentation": "`EnvironmentClass`\n\nThe environment class type. Valid values: `mw1.micro`, `mw1.small`, `mw1.medium`, `mw1.large`, `mw1.1large`, and `mw1.2large`. 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*Minimum*: `1`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-environmentclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Schedulers": { "MarkdownDocumentation": "`Schedulers`\n\nThe number of schedulers that you want to run in your environment. Valid values:\n* **v2** - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.\n* **v1** - Accepts 1.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-schedulers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RequirementsS3Path": { "MarkdownDocumentation": "`RequirementsS3Path`\n\nThe 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*Pattern*: `.*`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3path", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinWorkers": { "MarkdownDocumentation": "`MinWorkers`\n\nThe minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the `MaxWorkers` field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the `MinWorkers` field. For example, `2`.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minworkers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AirflowVersion": { "MarkdownDocumentation": "`AirflowVersion`\n\nThe version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version.\nIf you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.\n*Allowed Values*: `2.7.2` | `2.8.1` | `2.9.2` | `2.10.1` | `2.10.3` | `3.0.6` (latest)\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-z.]+$`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RequirementsS3ObjectVersion": { "MarkdownDocumentation": "`RequirementsS3ObjectVersion`\n\nThe 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*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3objectversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceBucketArn": { "MarkdownDocumentation": "`SourceBucketArn`\n\nThe 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*Pattern*: `^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:s3:::[a-z0-9.\\-]+$`\n*Minimum*: `1`\n*Maximum*: `1224`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-sourcebucketarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WeeklyMaintenanceWindowStart": { "MarkdownDocumentation": "`WeeklyMaintenanceWindowStart`\n\nThe day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM`. For example: `TUE:03:30`. You can specify a start time in 30 minute increments only. Supported input includes the following:\n* MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\\\d|2[0-3]):(00|30)\n*Required*: No\n*Type*: String\n*Pattern*: `(MON|TUE|WED|THU|FRI|SAT|SUN):([01]\\d|2[0-3]):(00|30)`\n*Maximum*: `9`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-weeklymaintenancewindowstart", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PluginsS3ObjectVersion": { "MarkdownDocumentation": "`PluginsS3ObjectVersion`\n\nThe version of the plugins.zip file on your Amazon S3 bucket. 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*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3objectversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointManagement": { "MarkdownDocumentation": "`EndpointManagement`\n\nDefines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to `SERVICE`, Amazon MWAA will create and manage the required VPC endpoints in\nyour VPC. If set to `CUSTOMER`, you must create, and manage, the VPC endpoints in your VPC.\n*Required*: No\n*Type*: String\n*Allowed values*: `CUSTOMER | SERVICE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER", "SERVICE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-endpointmanagement", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaxWebservers": { "MarkdownDocumentation": "`MaxWebservers`\n\nThe maximum number of web servers that you want to run in your environment.\nAmazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers`\nwhen you interact with your Apache Airflow environment using Apache Airflow REST API, or\nthe Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS)\nrate, Amazon MWAA will increase the number of web servers up to the number set in `MaxWebserers`. As TPS rates decrease\nAmazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers`.\nValid values: For environments larger than mw1.micro, accepts values from\n`2` to `5`. Defaults to `2` for all environment\nsizes except mw1.micro, which defaults to `1`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxwebservers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MinWebservers": { "MarkdownDocumentation": "`MinWebservers`\n\nThe minimum number of web servers that you want to run in your environment.\nAmazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers`\nwhen you interact with your Apache Airflow environment using Apache Airflow REST API, or\nthe Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease,\nAmazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers`.\nValid values: For environments larger than mw1.micro, accepts values from\n`2` to `5`. Defaults to `2` for all environment\nsizes except mw1.micro, which defaults to `1`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minwebservers", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "LoggingConfiguration.TaskLogs.CloudWatchLogGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoggingConfiguration.TaskLogs.CloudWatchLogGroupArn`\n\nThe ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#LoggingConfiguration.TaskLogs.CloudWatchLogGroupArn-fn::getatt" }, "WebserverVpcEndpointService": { "PrimitiveType": "String", "MarkdownDocumentation": "`WebserverVpcEndpointService`\n\nThe VPC endpoint for the environment's web server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#WebserverVpcEndpointService-fn::getatt" }, "DatabaseVpcEndpointService": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatabaseVpcEndpointService`\n\nThe VPC endpoint for the environment's Amazon RDS database.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#DatabaseVpcEndpointService-fn::getatt" }, "CeleryExecutorQueue": { "PrimitiveType": "String", "MarkdownDocumentation": "`CeleryExecutorQueue`\n\nThe queue ARN for the environment's [Celery Executor](https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html). Amazon MWAA uses a Celery Executor\nto distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#CeleryExecutorQueue-fn::getatt" }, "LoggingConfiguration.WebserverLogs.CloudWatchLogGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoggingConfiguration.WebserverLogs.CloudWatchLogGroupArn`\n\nThe ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#LoggingConfiguration.WebserverLogs.CloudWatchLogGroupArn-fn::getatt" }, "LoggingConfiguration.DagProcessingLogs.CloudWatchLogGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoggingConfiguration.DagProcessingLogs.CloudWatchLogGroupArn`\n\nThe ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#LoggingConfiguration.DagProcessingLogs.CloudWatchLogGroupArn-fn::getatt" }, "WebserverUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`WebserverUrl`\n\nThe URL of your Apache Airflow UI.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#WebserverUrl-fn::getatt" }, "LoggingConfiguration.SchedulerLogs.CloudWatchLogGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoggingConfiguration.SchedulerLogs.CloudWatchLogGroupArn`\n\nThe ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#LoggingConfiguration.SchedulerLogs.CloudWatchLogGroupArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN for the Amazon MWAA environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#Arn-fn::getatt" }, "LoggingConfiguration.WorkerLogs.CloudWatchLogGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LoggingConfiguration.WorkerLogs.CloudWatchLogGroupArn`\n\nThe ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#LoggingConfiguration.WorkerLogs.CloudWatchLogGroupArn-fn::getatt" } } }, "AWS::Macie::AllowList": { "MarkdownDocumentation": "`AWS::Macie::AllowList`\n\nThe `AWS::Macie::AllowList` resource specifies an allow list. In Amazon Macie, an allow list defines specific text or a text pattern for Macie to ignore when it inspects data sources for sensitive data. If data\nmatches text or a text pattern in an allow list, Macie doesn\u2019t report the\ndata in sensitive data findings or sensitive data discovery results, even if the data\nmatches the criteria of a custom data identifier or a managed data identifier. You can\ncreate and use allow lists in all the AWS Regions where Macie is currently available except the Asia Pacific (Osaka) Region.\nMacie supports two types of allow lists:\n* **Predefined text** - For this type of list\n (`S3WordsList`), you create a line-delimited plaintext file that\n lists specific text to ignore, and you store the file in an Amazon Simple Storage Service (Amazon S3) bucket. You then configure settings\n for Macie to access the list in the bucket.\n \n This type of list typically contains specific words, phrases, and other kinds\n of character sequences that aren\u2019t sensitive, aren't likely to change, and don\u2019t\n necessarily adhere to a common pattern. If you use this type of list, Macie doesn't report occurrences of text that exactly match a\n complete entry in the list. Macie treats each entry in the list\n as a string literal value. Matches aren't case sensitive.\n* **Regular expression** - For this type of list\n (`Regex`), you specify a regular expression that defines a text\n pattern to ignore. Unlike an allow list with predefined text, you store the\n regex and all other list settings in Macie.\n \n This type of list is helpful if you want to specify text that isn\u2019t sensitive\n but varies or is likely to change while also adhering to a common pattern. If\n you use this type of list, Macie doesn't report occurrences of\n text that completely match the pattern defined by the list.\nFor more information, see [Defining sensitive data exceptions with\nallow lists](https://docs.aws.amazon.com/macie/latest/user/allow-lists.html) in the *Amazon Macie User\nGuide*.\nAn `AWS::Macie::Session` resource must exist for an AWS account before you can create an `AWS::Macie::AllowList`\nresource for the account. Use a [DependsOn\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is\ncreated before other Macie resources are created for an account. For\nexample, `\"DependsOn\": \"Session\"`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the `AllowList`. For example,\n`{ \"Ref\": \"AllowList\" }`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA custom description of the allow list. The description can contain 1-512\ncharacters.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Criteria": { "MarkdownDocumentation": "`Criteria`\n\nThe criteria that specify the text or text pattern to ignore. The criteria can be the\nlocation and name of an Amazon S3 object that lists specific text to ignore\n(`S3WordsList`), or a regular expression (`Regex`) that\ndefines a text pattern to ignore.\n*Required*: Yes\n*Type*: [Criteria](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-criteria", "UpdateType": "Mutable", "Required": true, "Type": "Criteria" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the allow list.\nFor more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-macie-allowlist-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the allow list, which indicates whether Amazon Macie\ncan access and use the list's criteria. If the list's criteria specify a regular\nexpression (`Regex`), this value is typically `OK`. Macie can compile the expression. If the list's criteria specify an Amazon S3 object (`S3WordsList`), possible values are:\n* `OK` - Macie can retrieve and parse the contents of\n the object.\n* `S3_OBJECT_ACCESS_DENIED` - Macie isn't allowed to\n access the object or the object is encrypted with a customer managed AWS KMS key that Macie isn't allowed to use. Check the\n bucket policy and other permissions settings for the bucket and the object. If\n the object is encrypted, also ensure that it's encrypted with a key that Macie is allowed to use.\n* `S3_OBJECT_EMPTY` - Macie can retrieve the object\n but the object doesn't contain any content. Ensure that the object contains the\n correct entries. Also ensure that the list's criteria specify the correct bucket\n and object names.\n* `S3_OBJECT_NOT_FOUND` - The object doesn't exist in Amazon S3. Ensure that the list's criteria specify the correct bucket and\n object names.\n* `S3_OBJECT_OVERSIZE` - Macie can retrieve the\n object. However, the object contains too many entries or its storage size\n exceeds the quota for an allow list. Try breaking the list into multiple files\n and ensure that each file doesn't exceed any quotas. Then configure list\n settings in Macie for each file.\n* `S3_THROTTLED` - Amazon S3 throttled the request to\n retrieve the object. Wait a few minutes and then try again.\n* `S3_USER_ACCESS_DENIED` - Amazon S3 denied the request to\n retrieve the object. If the specified object exists, you're not allowed to\n access it or it's encrypted with an AWS KMS key that you're not\n allowed to use. Work with your AWS administrator to ensure that\n the list's criteria specify the correct bucket and object names, and you have\n read access to the bucket and the object. If the object is encrypted, also\n ensure that it's encrypted with a key that you're allowed to use.\n* `UNKNOWN_ERROR` - A transient or internal error occurred when\n Macie attempted to retrieve or parse the object. Wait a few\n minutes and then try again. A list can also have this status if it's encrypted\n with a key that Amazon S3 and Macie can't access or\n use.\nFor more information, see [Allow list options and\nrequirements](https://docs.aws.amazon.com/macie/latest/user/allow-lists-options.html) in the *Amazon Macie User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#Status-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier for the allow list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the allow list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#Arn-fn::getatt" } } }, "AWS::Macie::CustomDataIdentifier": { "MarkdownDocumentation": "`AWS::Macie::CustomDataIdentifier`\n\nThe `AWS::Macie::CustomDataIdentifier` resource specifies a custom data\nidentifier. A *custom data identifier* is a set of custom criteria\nfor Amazon Macie to use when it inspects data sources for sensitive data.\nThe criteria consist of a regular expression (*regex*) that defines a\ntext pattern to match and, optionally, character sequences and a proximity rule that\nrefine the results. The character sequences can be:\n* *Keywords*, which are words or phrases that must be in\n proximity of text that matches the regex, or\n* *Ignore words*, which are words or phrases to exclude from\n the results.\nBy using custom data identifiers, you can supplement the managed data identifiers that\nMacie provides and detect sensitive data that reflects your\nparticular scenarios, intellectual property, or proprietary data. For more information,\nsee [Building custom data identifiers](https://docs.aws.amazon.com/macie/latest/user/custom-data-identifiers.html) in the *Amazon Macie\nUser Guide*.\nAn `AWS::Macie::Session` resource must exist for an AWS account before you can create an\n`AWS::Macie::CustomDataIdentifier` resource for the account. Use a [DependsOn\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is\ncreated before other Macie resources are created for an account. For\nexample, `\"DependsOn\": \"Session\"`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the `CustomDataIdentifier`. For\nexample, `{ \"Ref\": \"CustomDataIdentifier\" }`\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA custom description of the custom data identifier. The description can contain 1-512\ncharacters.\nAvoid including sensitive data in the description. Users of the account might be able\nto see the description, depending on the actions that they're allowed to perform in\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Keywords": { "MarkdownDocumentation": "`Keywords`\n\nAn array of character sequences (*keywords*), one of which must\nprecede and be in proximity (`MaximumMatchDistance`) of the regular\nexpression (`Regex`) to match.\nThe array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters.\nKeywords aren't case sensitive.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-keywords", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Regex": { "MarkdownDocumentation": "`Regex`\n\nThe regular expression (*regex*) that defines the text pattern to\nmatch. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-regex", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IgnoreWords": { "MarkdownDocumentation": "`IgnoreWords`\n\nAn array of character sequences (*ignore words*) to exclude from\nthe results. If text matches the regular expression (`Regex`) but it contains\na string in this array, Amazon Macie ignores the text and doesn't include it\nin the results.\nThe array can contain 1-10 ignore words. Each ignore word can contain 4-90 UTF-8\ncharacters. Ignore words are case sensitive.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-ignorewords", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the custom data identifier.\nFor more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-macie-customdataidentifier-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA custom name for the custom data identifier. The name can contain 1-128\ncharacters.\nAvoid including sensitive data in the name of a custom data identifier. Users of the\naccount might be able to see the name, depending on the actions that they're allowed to\nperform 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MaximumMatchDistance": { "MarkdownDocumentation": "`MaximumMatchDistance`\n\nThe maximum number of characters that can exist between the end of at least one\ncomplete character sequence specified by the `Keywords` array and the end of\ntext that matches the regular expression (`Regex`). If a complete keyword\nprecedes all the text that matches the regular expression and the keyword is within the\nspecified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-maximummatchdistance", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier for the custom data identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the custom data identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#Arn-fn::getatt" } } }, "AWS::Macie::FindingsFilter": { "MarkdownDocumentation": "`AWS::Macie::FindingsFilter`\n\nThe `AWS::Macie::FindingsFilter` resource specifies a findings filter. In Amazon Macie, a\n*findings filter*, also referred to as a *filter\nrule*, is a set of custom criteria that specifies which findings to\ninclude or exclude from the results of a query for findings. The criteria can help you\nidentify and focus on findings that have specific characteristics, such as severity,\ntype, or the name of an affected AWS resource. You can also configure a\nfindings filter to suppress (automatically archive) findings that match the filter's\ncriteria. For more information, see [Filtering Macie findings](https://docs.aws.amazon.com/macie/latest/user/findings-filter-overview.html) in\nthe *Amazon Macie User Guide*.\nAn `AWS::Macie::Session` resource must exist for an AWS account before you can create an\n`AWS::Macie::FindingsFilter` resource for the account. Use a [DependsOn\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is\ncreated before other Macie resources are created for an account. For\nexample, `\"DependsOn\": \"Session\"`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the `FindingsFilter`. For example,\n`{ \"Ref\": \"FindingsFilter\" }`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe action to perform on findings that match the filter criteria\n(`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*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)", "RefReturnValue": "", "AllowedValues": [ "ARCHIVE", "NOOP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-action", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA custom description of the findings filter. The description can contain 1-512\ncharacters.\nAvoid including sensitive data in the description. Users of the account might be able\nto see the description, depending on the actions that they're allowed to perform in\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Position": { "MarkdownDocumentation": "`Position`\n\nThe position of the findings filter in the list of saved filter rules on the Amazon Macie console. This value also determines the order in which the filter\nis applied to findings, relative to other filters that are also applied to\nfindings.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-position", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "FindingCriteria": { "MarkdownDocumentation": "`FindingCriteria`\n\nThe criteria to use to filter findings.\n*Required*: Yes\n*Type*: [FindingCriteria](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-findingcriteria", "UpdateType": "Mutable", "Required": true, "Type": "FindingCriteria" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the findings filter.\nFor more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-macie-findingsfilter-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier for the findings filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the findings filter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#Arn-fn::getatt" } } }, "AWS::Macie::Session": { "MarkdownDocumentation": "`AWS::Macie::Session`\n\nThe `AWS::Macie::Session` resource represents the Amazon Macie\nservice and certain configuration settings for an Amazon Macie account in a\nspecific AWS Region. It enables Macie to become\noperational for a specific account in a specific Region. An account can have only one\nsession in each Region.\nYou must create an `AWS::Macie::Session` resource for an account before you\ncan create other types of resources for the account. Use a [DependsOn\nattribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is\ncreated before other Macie resources are created for an account. For\nexample, `\"DependsOn\": \"Session\"`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the account ID for the AWS account in\nwhich the Amazon Macie session is created. For example, `{ \"Ref\":\n\"Session\" }`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-session.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe status of Amazon Macie for the account. Valid values are:\n`ENABLED`, start or resume Macie activities for the\naccount; and, `PAUSED`, suspend Macie activities for the\naccount.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | PAUSED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "PAUSED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-session.html#cfn-macie-session-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FindingPublishingFrequency": { "MarkdownDocumentation": "`FindingPublishingFrequency`\n\nSpecifies how often Amazon Macie publishes updates to policy findings for\nthe account. This includes publishing updates to AWS Security Hub CSPM 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*Allowed values*: `FIFTEEN_MINUTES | ONE_HOUR ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "FIFTEEN_MINUTES", "ONE_HOUR", "SIX_HOURS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-session.html#cfn-macie-session-findingpublishingfrequency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ServiceRole": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceRole`\n\nThe Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in\nAWS resources for the account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-session.html#ServiceRole-fn::getatt" }, "AwsAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AwsAccountId`\n\nThe account ID for the AWS account in which the Amazon Macie session is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-session.html#AwsAccountId-fn::getatt" }, "AutomatedDiscoveryStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutomatedDiscoveryStatus`\n\nThe status of automated sensitive data discovery for the account. Possible values are: `ENABLED`, perform automated sensitive\ndata discovery activities for the account; and, `DISABLED`, don't perform automated sensitive data discovery activities for the\naccount.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-session.html#AutomatedDiscoveryStatus-fn::getatt" } } }, "AWS::ManagedBlockchain::Member": { "MarkdownDocumentation": "`AWS::ManagedBlockchain::Member`\n\nCreates a member within a Managed Blockchain network.\nApplies only to Hyperledger Fabric.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the member ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html", "Attributes": { "MemberId": { "PrimitiveType": "String", "MarkdownDocumentation": "`MemberId`\n\nThe unique identifier of the member.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#MemberId-fn::getatt" }, "NetworkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkId`\n\nThe unique identifier of the network to which the member belongs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#NetworkId-fn::getatt" } }, "Properties": { "MemberConfiguration": { "Type": "MemberConfiguration", "Required": true, "MarkdownDocumentation": "`MemberConfiguration`\n\nConfiguration properties of the member.\n*Required*: Yes\n*Type*: [MemberConfiguration](./aws-properties-managedblockchain-member-memberconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#cfn-managedblockchain-member-memberconfiguration", "UpdateType": "Mutable" }, "NetworkConfiguration": { "Type": "NetworkConfiguration", "Required": false, "MarkdownDocumentation": "`NetworkConfiguration`\n\nConfiguration properties of the network to which the member belongs.\n*Required*: No\n*Type*: [NetworkConfiguration](./aws-properties-managedblockchain-member-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#cfn-managedblockchain-member-networkconfiguration", "UpdateType": "Mutable" }, "NetworkId": { "Required": false, "MarkdownDocumentation": "`NetworkId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#cfn-managedblockchain-member-networkid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "InvitationId": { "Required": false, "MarkdownDocumentation": "`InvitationId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html#cfn-managedblockchain-member-invitationid", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::MediaConnect::Bridge": { "MarkdownDocumentation": "`AWS::MediaConnect::Bridge`\n\nThe `AWS::MediaConnect::Bridge` resource defines a connection between your data center\u2019s gateway instances and the cloud. For each bridge, you specify the type of bridge, transport protocol to use, and details for any outputs and failover.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the bridge ARN. For example:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-east-1:111122223333:bridge:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballArenaIngress\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html", "Properties": { "SourceFailoverConfig": { "MarkdownDocumentation": "`SourceFailoverConfig`\n\nThe settings for source failover.\n*Required*: No\n*Type*: [FailoverConfig](./aws-properties-mediaconnect-bridge-failoverconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-sourcefailoverconfig", "UpdateType": "Mutable", "Required": false, "Type": "FailoverConfig" }, "IngressGatewayBridge": { "MarkdownDocumentation": "`IngressGatewayBridge`\n\nAn ingress bridge is a ground-to-cloud bridge. The content originates at your premises and\nis delivered to the cloud.\n*Required*: No\n*Type*: [IngressGatewayBridge](./aws-properties-mediaconnect-bridge-ingressgatewaybridge.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-ingressgatewaybridge", "UpdateType": "Mutable", "Required": false, "Type": "IngressGatewayBridge" }, "EgressGatewayBridge": { "MarkdownDocumentation": "`EgressGatewayBridge`\n\nAn egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.\n*Required*: No\n*Type*: [EgressGatewayBridge](./aws-properties-mediaconnect-bridge-egressgatewaybridge.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-egressgatewaybridge", "UpdateType": "Mutable", "Required": false, "Type": "EgressGatewayBridge" }, "Outputs": { "MarkdownDocumentation": "`Outputs`\n\nThe outputs that you want to add to this bridge.\n*Required*: No\n*Type*: Array of [BridgeOutput](./aws-properties-mediaconnect-bridge-bridgeoutput.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-outputs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BridgeOutput", "DuplicatesAllowed": true }, "PlacementArn": { "MarkdownDocumentation": "`PlacementArn`\n\nThe bridge placement Amazon Resource Number (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-placementarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Sources": { "MarkdownDocumentation": "`Sources`\n\nThe sources that you want to add to this bridge.\n*Required*: Yes\n*Type*: Array of [BridgeSource](./aws-properties-mediaconnect-bridge-bridgesource.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-sources", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "BridgeSource", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the bridge. This name can not be modified after the bridge 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "BridgeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`BridgeArn`\n\nThe Amazon Resource Name (ARN) of the bridge.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#BridgeArn-fn::getatt" }, "BridgeState": { "PrimitiveType": "String", "MarkdownDocumentation": "`BridgeState`\n\nThe current status of the bridge. Possible values are: ACTIVE or STANDBY.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#BridgeState-fn::getatt" } } }, "AWS::MediaConnect::BridgeOutput": { "MarkdownDocumentation": "`AWS::MediaConnect::BridgeOutput`\n\nAdds outputs to an existing bridge.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the bridge ARN and the bridge name. For example:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-east-1:111122223333:bridge:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballArenaIngress|Output:PrimaryOutput1\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html", "Properties": { "BridgeArn": { "MarkdownDocumentation": "`BridgeArn`\n\nThe Amazon Resource Name (ARN) of the bridge that you want to update.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-bridgearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NetworkOutput": { "MarkdownDocumentation": "`NetworkOutput`\n\nThe network output of the bridge. A network output is delivered to your premises.\n*Required*: Yes\n*Type*: [BridgeNetworkOutput](./aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-networkoutput", "UpdateType": "Mutable", "Required": true, "Type": "BridgeNetworkOutput" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe network output name. This name is used to reference the output and must be unique among outputs in this bridge.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaConnect::BridgeSource": { "MarkdownDocumentation": "`AWS::MediaConnect::BridgeSource`\n\nAdds sources to an existing bridge.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the bridge ARN and bridge name. For example:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-east-1:111122223333:bridge:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballArenaIngress|Source:PrimarySource1\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html", "Properties": { "NetworkSource": { "MarkdownDocumentation": "`NetworkSource`\n\nThe source of the network.\n*Required*: No\n*Type*: [BridgeNetworkSource](./aws-properties-mediaconnect-bridgesource-bridgenetworksource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-networksource", "UpdateType": "Mutable", "Required": false, "Type": "BridgeNetworkSource" }, "BridgeArn": { "MarkdownDocumentation": "`BridgeArn`\n\nThe ARN of the bridge feeding this flow.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-bridgearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FlowSource": { "MarkdownDocumentation": "`FlowSource`\n\nThe source of the flow.\n*Required*: No\n*Type*: [BridgeFlowSource](./aws-properties-mediaconnect-bridgesource-bridgeflowsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-flowsource", "UpdateType": "Mutable", "Required": false, "Type": "BridgeFlowSource" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaConnect::Flow": { "MarkdownDocumentation": "`AWS::MediaConnect::Flow`\n\nThe `AWS::MediaConnect::Flow` resource defines a connection between one or more video\nsources and one or more outputs. For each flow, you specify the transport protocol to\nuse, encryption information, and details for any outputs or entitlements that you want.\nAWS Elemental MediaConnect returns an ingest endpoint where you can\nsend your live video as a single unicast stream. The service replicates and distributes\nthe video to every output that you specify, whether inside or outside the AWS Cloud. You can also set up entitlements on a flow to allow other\nAWS accounts to access your content.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the flow ARN. For example:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html", "Properties": { "SourceMonitoringConfig": { "MarkdownDocumentation": "`SourceMonitoringConfig`\n\nThe settings for source monitoring.\n*Required*: No\n*Type*: [SourceMonitoringConfig](./aws-properties-mediaconnect-flow-sourcemonitoringconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-sourcemonitoringconfig", "UpdateType": "Mutable", "Required": false, "Type": "SourceMonitoringConfig" }, "SourceFailoverConfig": { "MarkdownDocumentation": "`SourceFailoverConfig`\n\nThe settings for source failover.\n*Required*: No\n*Type*: [FailoverConfig](./aws-properties-mediaconnect-flow-failoverconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-sourcefailoverconfig", "UpdateType": "Mutable", "Required": false, "Type": "FailoverConfig" }, "VpcInterfaces": { "MarkdownDocumentation": "`VpcInterfaces`\n\nThe VPC Interfaces for this flow.\n*Required*: No\n*Type*: Array of [VpcInterface](./aws-properties-mediaconnect-flow-vpcinterface.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-vpcinterfaces", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VpcInterface", "DuplicatesAllowed": true }, "MediaStreams": { "MarkdownDocumentation": "`MediaStreams`\n\nThe media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.\n*Required*: No\n*Type*: Array of [MediaStream](./aws-properties-mediaconnect-flow-mediastream.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-mediastreams", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MediaStream", "DuplicatesAllowed": true }, "NdiConfig": { "MarkdownDocumentation": "`NdiConfig`\n\nSpecifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.\n*Required*: No\n*Type*: [NdiConfig](./aws-properties-mediaconnect-flow-ndiconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-ndiconfig", "UpdateType": "Mutable", "Required": false, "Type": "NdiConfig" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Maintenance": { "MarkdownDocumentation": "`Maintenance`\n\nThe maintenance settings you want to use for the flow.\n*Required*: No\n*Type*: [Maintenance](./aws-properties-mediaconnect-flow-maintenance.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-maintenance", "UpdateType": "Mutable", "Required": false, "Type": "Maintenance" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe settings for the source that you want to use for the new flow.\n*Required*: Yes\n*Type*: [Source](./aws-properties-mediaconnect-flow-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-source", "UpdateType": "Mutable", "Required": true, "Type": "Source" }, "FlowSize": { "MarkdownDocumentation": "`FlowSize`\n\nDetermines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.\n*Required*: No\n*Type*: String\n*Allowed values*: `MEDIUM | LARGE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MEDIUM", "LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-flowsize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the flow.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "FlowAvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "`FlowAvailabilityZone`\n\nThe Availability Zone that the flow was created in. These options are limited to the\nAvailability Zones within the current AWS Region.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#FlowAvailabilityZone-fn::getatt" }, "Source.SourceIngestPort": { "PrimitiveType": "String", "MarkdownDocumentation": "`Source.SourceIngestPort`\n\nThe port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must\nbe set to 2088.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#Source.SourceIngestPort-fn::getatt" }, "Source.IngestIp": { "PrimitiveType": "String", "MarkdownDocumentation": "`Source.IngestIp`\n\nThe IP address that the flow listens on for incoming content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#Source.IngestIp-fn::getatt" }, "Source.SourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Source.SourceArn`\n\nThe ARN of the source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#Source.SourceArn-fn::getatt" }, "EgressIp": { "PrimitiveType": "String", "MarkdownDocumentation": "`EgressIp`\n\nThe IP address from which video will be sent to output destinations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#EgressIp-fn::getatt" }, "FlowArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FlowArn`\n\nThe Amazon Resource Name (ARN) of the flow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#FlowArn-fn::getatt" }, "FlowNdiMachineName": { "PrimitiveType": "String", "MarkdownDocumentation": "`FlowNdiMachineName`\n\nThis read-only value represents the automatically-generated NDI machine name that MediaConnect generated for this flow. These NDI machine names are only generated when you don't specify your own custom name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#FlowNdiMachineName-fn::getatt" } } }, "AWS::MediaConnect::FlowEntitlement": { "MarkdownDocumentation": "`AWS::MediaConnect::FlowEntitlement`\n\nThe `AWS::MediaConnect::FlowEntitlement` resource defines the permission that an AWS account grants to another AWS account to allow access\nto the content in a specific AWS Elemental MediaConnect flow. The\ncontent originator grants an entitlement to a specific AWS account (the\nsubscriber). When an entitlement is granted, the subscriber can create a flow using the\noriginator's flow as the source. Each flow can have up to 50 entitlements.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the entitlement ARN. For example:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html", "Properties": { "DataTransferSubscriberFeePercent": { "MarkdownDocumentation": "`DataTransferSubscriberFeePercent`\n\nThe percentage of the entitlement data transfer fee that you want the subscriber\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-datatransfersubscriberfeepercent", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the entitlement. This description appears only on the\nMediaConnect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nEncryption information.\n*Required*: No\n*Type*: [Encryption](./aws-properties-mediaconnect-flowentitlement-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-encryption", "UpdateType": "Mutable", "Required": false, "Type": "Encryption" }, "Subscribers": { "MarkdownDocumentation": "`Subscribers`\n\nThe AWS account IDs that you want to share your content with. The receiving\naccounts (subscribers) will be allowed to create their own flows using your content\nas the source.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-subscribers", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "FlowArn": { "MarkdownDocumentation": "`FlowArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-flowarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EntitlementStatus": { "MarkdownDocumentation": "`EntitlementStatus`\n\nAn indication of whether the new entitlement should be enabled or disabled as soon\nas it is created. If you don\u2019t specify the entitlementStatus field in your request,\nMediaConnect sets it to ENABLED.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-entitlementstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the entitlement. This value must be unique within the current\nflow.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#cfn-mediaconnect-flowentitlement-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "EntitlementArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`EntitlementArn`\n\nThe entitlement ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowentitlement.html#EntitlementArn-fn::getatt" } } }, "AWS::MediaConnect::FlowOutput": { "MarkdownDocumentation": "`AWS::MediaConnect::FlowOutput`\n\nThe `AWS::MediaConnect::FlowOutput` resource defines the destination address, protocol,\nand port that AWS Elemental MediaConnect sends the ingested video to. Each\nflow can have up to 50 outputs. An output can have the same protocol or a different\nprotocol from the source. The following protocols are supported: RIST, RTP, RTP-FEC,\nSRT-listener, SRT-caller, Zixi pull, and Zixi push. CDI and ST 2110 JPEG XS protocols are\nnot currently supported by AWS CloudFormation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the output ARN. For example:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYCOutput\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html", "Properties": { "Destination": { "MarkdownDocumentation": "`Destination`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-destination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SmoothingLatency": { "MarkdownDocumentation": "`SmoothingLatency`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-smoothinglatency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "StreamId": { "MarkdownDocumentation": "`StreamId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-streamid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the output. This description appears only on the MediaConnect console and will not be seen by the end 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NdiSpeedHqQuality": { "MarkdownDocumentation": "`NdiSpeedHqQuality`\n\nA quality setting for the NDI Speed HQ encoder.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-ndispeedhqquality", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port to use when content is distributed to this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RemoteId": { "MarkdownDocumentation": "`RemoteId`\n\nThe remote ID for the Zixi-pull 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-remoteid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MediaStreamOutputConfigurations": { "MarkdownDocumentation": "`MediaStreamOutputConfigurations`\n\nThe media streams that are associated with the output, and the parameters for those associations.\n*Required*: No\n*Type*: Array of [MediaStreamOutputConfiguration](./aws-properties-mediaconnect-flowoutput-mediastreamoutputconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-mediastreamoutputconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MediaStreamOutputConfiguration", "DuplicatesAllowed": true }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nThe type of key used for the encryption. If no `keyType` is provided, the\nservice will use the default setting (static-key). Allowable encryption types:\nstatic-key.\n*Required*: No\n*Type*: [Encryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-encryption", "UpdateType": "Mutable", "Required": false, "Type": "Encryption" }, "RouterIntegrationState": { "MarkdownDocumentation": "`RouterIntegrationState`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-routerintegrationstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputStatus": { "MarkdownDocumentation": "`OutputStatus`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-outputstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the bridge's output.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcInterfaceAttachment": { "MarkdownDocumentation": "`VpcInterfaceAttachment`\n\nThe name of the VPC interface attachment to use for this output.\n*Required*: No\n*Type*: [VpcInterfaceAttachment](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-vpcinterfaceattachment", "UpdateType": "Mutable", "Required": false, "Type": "VpcInterfaceAttachment" }, "MinLatency": { "MarkdownDocumentation": "`MinLatency`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-minlatency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RouterIntegrationTransitEncryption": { "MarkdownDocumentation": "`RouterIntegrationTransitEncryption`\n\nEncryption information.\n*Required*: No\n*Type*: [FlowTransitEncryption](./aws-properties-mediaconnect-flowoutput-flowtransitencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-routerintegrationtransitencryption", "UpdateType": "Mutable", "Required": false, "Type": "FlowTransitEncryption" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol to use for the output.\n###### Note\nAWS Elemental MediaConnect no longer supports the Fujitsu QoS\nprotocol. This reference is maintained for legacy purposes only.\n*Required*: No\n*Type*: String\n*Allowed values*: `zixi-push | rtp-fec | rtp |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "zixi-push", "rtp-fec", "rtp", "zixi-pull", "rist", "fujitsu-qos", "srt-listener", "srt-caller", "st2110-jpegxs", "cdi", "ndi-speed-hq" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FlowArn": { "MarkdownDocumentation": "`FlowArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-flowarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NdiProgramName": { "MarkdownDocumentation": "`NdiProgramName`\n\nA suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-ndiprogramname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxLatency": { "MarkdownDocumentation": "`MaxLatency`\n\nThe maximum latency in milliseconds. This parameter applies only to RIST-based and\nZixi-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-maxlatency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "CidrAllowList": { "MarkdownDocumentation": "`CidrAllowList`\n\nThe range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-cidrallowlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "OutputArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`OutputArn`\n\nThe ARN of the output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#OutputArn-fn::getatt" } } }, "AWS::MediaConnect::FlowSource": { "MarkdownDocumentation": "`AWS::MediaConnect::FlowSource`\n\nThe `AWS::MediaConnect::FlowSource` resource is usedt to add additional sources to an\nexisting flow. Adding an additional source requires Failover to be enabled. When you enable\nFailover, the additional source must use the same protocol as the existing source. A source\nis the external video content that includes configuration information (encryption and\nsource type) and a network address. Each flow has at least one source. A standard source\ncomes from a source other than another AWS Elemental MediaConnect flow,\nsuch as an on-premises encoder.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the source ARN. For example:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-east-1:111122223333:source:2-3aBC45dEF67hiJ89-c34de5fG678h:AwardsShowSource\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html", "Properties": { "StreamId": { "MarkdownDocumentation": "`StreamId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-streamid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the source. This value is not used or seen outside of the current MediaConnect 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SenderIpAddress": { "MarkdownDocumentation": "`SenderIpAddress`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-senderipaddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IngestPort": { "MarkdownDocumentation": "`IngestPort`\n\nThe port that the flow listens on for incoming content. If the protocol of the\nsource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-ingestport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SenderControlPort": { "MarkdownDocumentation": "`SenderControlPort`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sendercontrolport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Decryption": { "MarkdownDocumentation": "`Decryption`\n\nThe type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.\n*Required*: No\n*Type*: [Encryption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-decryption", "UpdateType": "Mutable", "Required": false, "Type": "Encryption" }, "GatewayBridgeSource": { "MarkdownDocumentation": "`GatewayBridgeSource`\n\nThe bridge's source.\n*Required*: No\n*Type*: [GatewayBridgeSource](./aws-properties-mediaconnect-flowsource-gatewaybridgesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-gatewaybridgesource", "UpdateType": "Mutable", "Required": false, "Type": "GatewayBridgeSource" }, "SourceListenerAddress": { "MarkdownDocumentation": "`SourceListenerAddress`\n\nSource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sourcelisteneraddress", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceListenerPort": { "MarkdownDocumentation": "`SourceListenerPort`\n\nSource 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sourcelistenerport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "WhitelistCidr": { "MarkdownDocumentation": "`WhitelistCidr`\n\nThe range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-whitelistcidr", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EntitlementArn": { "MarkdownDocumentation": "`EntitlementArn`\n\nThe ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-entitlementarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinLatency": { "MarkdownDocumentation": "`MinLatency`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-minlatency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VpcInterfaceName": { "MarkdownDocumentation": "`VpcInterfaceName`\n\nThe name of the VPC interface to use for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-vpcinterfacename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxBitrate": { "MarkdownDocumentation": "`MaxBitrate`\n\nThe smoothing max bitrate (in bps) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-maxbitrate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe protocol that the source uses to deliver the content to\nMediaConnect. Adding additional sources to an existing flow requires Failover to be\nenabled. When you enable Failover, the additional source must use the same protocol as\nthe existing source. Only the following protocols support failover: Zixi-push, RTP-FEC,\nRTP, RIST and SRT protocols.\nIf you use failover with SRT caller or listener,\nthe\u00a0`FailoverMode`\u00a0property must be set to\u00a0`FAILOVER`. The\n`FailoverMode` property\u00a0is found in\u00a0the `FailoverConfig`\nresource\u00a0of the same flow ARN you used for the source's `FlowArn`\u00a0property.\nSRT caller/listener does not support\u00a0merge\u00a0mode failover.\n*Required*: No\n*Type*: String\n*Allowed values*: `zixi-push | rtp-fec | rtp |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "zixi-push", "rtp-fec", "rtp", "rist", "srt-listener", "srt-caller" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-protocol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FlowArn": { "MarkdownDocumentation": "`FlowArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-flowarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxLatency": { "MarkdownDocumentation": "`MaxLatency`\n\nThe maximum latency in milliseconds. This parameter applies only to RIST-based and\nZixi-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-maxlatency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "IngestIp": { "PrimitiveType": "String", "MarkdownDocumentation": "`IngestIp`\n\nThe IP address that the flow listens on for incoming content.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#IngestIp-fn::getatt" }, "SourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceArn`\n\nThe ARN of the source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#SourceArn-fn::getatt" }, "SourceIngestPort": { "PrimitiveType": "String", "MarkdownDocumentation": "`SourceIngestPort`\n\nThe 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", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#SourceIngestPort-fn::getatt" } } }, "AWS::MediaConnect::FlowVpcInterface": { "MarkdownDocumentation": "`AWS::MediaConnect::FlowVpcInterface`\n\nThe `AWS::MediaConnect::FlowVpcInterface` resource is a connection between your AWS Elemental MediaConnect flow and a virtual private cloud (VPC) that you\ncreated using the Amazon Virtual Private Cloud service.\nTo avoid streaming your content over the public internet, you can add up to two VPC\ninterfaces to your flow and use those connections to transfer content between your VPC\nand MediaConnect.\nYou can update an existing flow to add a VPC interface. If you haven\u2019t created the\nflow yet, you must create the flow with a temporary standard source by doing the\nfollowing:\n1. Use CloudFormation to create a flow with a standard source that uses to the\n flow\u2019s public IP address.\n2. Use CloudFormation to create a VPC interface to add to this flow. This can\n also be done as part of the previous step.\n3. After CloudFormation has created the flow and the VPC interface, update the\n source to point to the VPC interface that you created.\n###### Important\nThe previous steps must be undone before the CloudFormation stack can be deleted. Because the source is manually updated in step 3, CloudFormation is not aware of this change. The source must be returned to a standard source before CloudFormation stack deletion.\n###### Note\nWhen configuring NDI outputs for your flow, define the VPC interface as a nested attribute within the `AWS::MediaConnect::Flow` resource. Do not use the top-level `AWS::MediaConnect::FlowVpcInterface` resource type to specify NDI configurations.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the flow ARN and the name of the VPC interface. For\nexample:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame|MyVPCInterface\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html", "Properties": { "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe subnet IDs that you want to use for your VPC interface. A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-subnetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "FlowArn": { "MarkdownDocumentation": "`FlowArn`\n\nThe Amazon Resource Name (ARN) of the flow.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-flowarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA virtual firewall to control inbound and outbound traffic.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-securitygroupids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the VPC interface. This name must be unique within the flow.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#cfn-mediaconnect-flowvpcinterface-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "NetworkInterfaceIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`NetworkInterfaceIds`\n\nThe IDs of the network interfaces that MediaConnect created in your account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowvpcinterface.html#NetworkInterfaceIds-fn::getatt" } } }, "AWS::MediaConnect::Gateway": { "MarkdownDocumentation": "`AWS::MediaConnect::Gateway`\n\nThe `AWS::MediaConnect::Gateway` resource is used to create a new gateway. AWS Elemental MediaConnect Gateway is a feature of MediaConnect that allows the deployment of on-premises resources for transporting live video to and from the AWS Cloud. MediaConnect Gateway allows you to contribute live video to the AWS Cloud from on-premises hardware, as well as distribute live video from the AWS Cloud to your local data center.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the gateway ARN. For example:\n`{ \"Ref\":\n\"arn:aws:mediaconnect:us-east-1:111122223333:gateway:1-23aBC45dEF67hiJ8-12AbC34DE5fG:WestOffice\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html", "Properties": { "Networks": { "MarkdownDocumentation": "`Networks`\n\nThe list of networks in the gateway.\n*Required*: Yes\n*Type*: Array of [GatewayNetwork](./aws-properties-mediaconnect-gateway-gatewaynetwork.html)\n*Minimum*: `1`\n*Maximum*: `4`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html#cfn-mediaconnect-gateway-networks", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "GatewayNetwork", "DuplicatesAllowed": true }, "EgressCidrBlocks": { "MarkdownDocumentation": "`EgressCidrBlocks`\n\nThe range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html#cfn-mediaconnect-gateway-egresscidrblocks", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the gateway. This name can not be modified after the gateway 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html#cfn-mediaconnect-gateway-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GatewayArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GatewayArn`\n\nThe Amazon Resource Name (ARN) of the gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html#GatewayArn-fn::getatt" }, "GatewayState": { "PrimitiveType": "String", "MarkdownDocumentation": "`GatewayState`\n\nThe current state of the gateway. Possible values are: CREATING, ACTIVE, UPDATING, ERROR, DELETING, DELETED.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-gateway.html#GatewayState-fn::getatt" } } }, "AWS::MediaConnect::RouterInput": { "MarkdownDocumentation": "`AWS::MediaConnect::RouterInput`\n\nThe `AWS::MediaConnect::RouterInput` resource Property description not available. for MediaConnect.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html", "Properties": { "RoutingScope": { "MarkdownDocumentation": "`RoutingScope`\n\nIndicates whether the router input is configured for Regional or global routing.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `REGIONAL | GLOBAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REGIONAL", "GLOBAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-routingscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TransitEncryption": { "MarkdownDocumentation": "`TransitEncryption`\n\nEncryption information.\n*Required*: No\n*Type*: [RouterInputTransitEncryption](./aws-properties-mediaconnect-routerinput-routerinputtransitencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-transitencryption", "UpdateType": "Mutable", "Required": false, "Type": "RouterInputTransitEncryption" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [RouterInputConfiguration](./aws-properties-mediaconnect-routerinput-routerinputconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-configuration", "UpdateType": "Mutable", "Required": true, "Type": "RouterInputConfiguration" }, "Tier": { "MarkdownDocumentation": "`Tier`\n\nThe tier level of the router input.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INPUT_100 | INPUT_50 | INPU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INPUT_100", "INPUT_50", "INPUT_20" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-tier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RegionName": { "MarkdownDocumentation": "`RegionName`\n\nThe AWS Region where the router input is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-regionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaximumBitrate": { "MarkdownDocumentation": "`MaximumBitrate`\n\nThe maximum bitrate for the router 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-maximumbitrate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone of the router input.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaintenanceConfiguration": { "MarkdownDocumentation": "`MaintenanceConfiguration`\n\nThe maintenance configuration settings applied to this router input.\n*Required*: No\n*Type*: [MaintenanceConfiguration](./aws-properties-mediaconnect-routerinput-maintenanceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-maintenanceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to tag and organize this router input.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediaconnect-routerinput-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the router input.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#cfn-mediaconnect-routerinput-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "InputType": { "PrimitiveType": "String", "MarkdownDocumentation": "`InputType`\n\nThe type of the router input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#InputType-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the router input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#State-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the router input was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#CreatedAt-fn::getatt" }, "IpAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpAddress`\n\nThe IP address of the router input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#IpAddress-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the router input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the router input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#Arn-fn::getatt" }, "RoutedOutputs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`RoutedOutputs`\n\nThe number of router outputs associated with the router input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#RoutedOutputs-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the router input was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#UpdatedAt-fn::getatt" }, "MaintenanceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`MaintenanceType`\n\nThe type of maintenance configuration applied to this router input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html#MaintenanceType-fn::getatt" } } }, "AWS::MediaConnect::RouterNetworkInterface": { "MarkdownDocumentation": "`AWS::MediaConnect::RouterNetworkInterface`\n\nThe `AWS::MediaConnect::RouterNetworkInterface` resource Property description not available. for MediaConnect.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [RouterNetworkInterfaceConfiguration](./aws-properties-mediaconnect-routernetworkinterface-routernetworkinterfaceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#cfn-mediaconnect-routernetworkinterface-configuration", "UpdateType": "Mutable", "Required": true, "Type": "RouterNetworkInterfaceConfiguration" }, "RegionName": { "MarkdownDocumentation": "`RegionName`\n\nThe AWS Region where the router network interface is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#cfn-mediaconnect-routernetworkinterface-regionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to tag and organize this router network interface.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediaconnect-routernetworkinterface-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#cfn-mediaconnect-routernetworkinterface-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the router network interface.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#cfn-mediaconnect-routernetworkinterface-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AssociatedInputCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AssociatedInputCount`\n\nThe number of router inputs associated with the network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#AssociatedInputCount-fn::getatt" }, "AssociatedOutputCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AssociatedOutputCount`\n\nThe number of router outputs associated with the network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#AssociatedOutputCount-fn::getatt" }, "NetworkInterfaceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkInterfaceType`\n\nThe type of the router network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#NetworkInterfaceType-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the router network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#State-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the router network interface was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the router network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the router network interface.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#Arn-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the router network interface was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routernetworkinterface.html#UpdatedAt-fn::getatt" } } }, "AWS::MediaConnect::RouterOutput": { "MarkdownDocumentation": "`AWS::MediaConnect::RouterOutput`\n\nThe `AWS::MediaConnect::RouterOutput` resource Property description not available. for MediaConnect.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html", "Properties": { "RoutingScope": { "MarkdownDocumentation": "`RoutingScope`\n\nIndicates whether the router output is configured for Regional or global routing.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `REGIONAL | GLOBAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "REGIONAL", "GLOBAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-routingscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [RouterOutputConfiguration](./aws-properties-mediaconnect-routeroutput-routeroutputconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-configuration", "UpdateType": "Mutable", "Required": true, "Type": "RouterOutputConfiguration" }, "Tier": { "MarkdownDocumentation": "`Tier`\n\nThe tier level of the router output.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OUTPUT_100 | OUTPUT_50 | OU...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "OUTPUT_100", "OUTPUT_50", "OUTPUT_20" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-tier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RegionName": { "MarkdownDocumentation": "`RegionName`\n\nThe AWS Region where the router output is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-regionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaximumBitrate": { "MarkdownDocumentation": "`MaximumBitrate`\n\nThe maximum bitrate for the router output.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-maximumbitrate", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone of the router output.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaintenanceConfiguration": { "MarkdownDocumentation": "`MaintenanceConfiguration`\n\nThe maintenance configuration settings applied to this router output.\n*Required*: No\n*Type*: [MaintenanceConfiguration](./aws-properties-mediaconnect-routeroutput-maintenanceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-maintenanceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to tag and organize this router output.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediaconnect-routeroutput-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the router output.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#cfn-mediaconnect-routeroutput-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe overall state of the router output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#State-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the router output was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#CreatedAt-fn::getatt" }, "IpAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpAddress`\n\nThe IP address of the router output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#IpAddress-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the router output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the router output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#Arn-fn::getatt" }, "RoutedState": { "PrimitiveType": "String", "MarkdownDocumentation": "`RoutedState`\n\nThe current state of the association between the router output and its input.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#RoutedState-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the router output was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#UpdatedAt-fn::getatt" }, "MaintenanceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`MaintenanceType`\n\nThe type of maintenance configuration applied to this router output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#MaintenanceType-fn::getatt" }, "OutputType": { "PrimitiveType": "String", "MarkdownDocumentation": "`OutputType`\n\nThe type of the router output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routeroutput.html#OutputType-fn::getatt" } } }, "AWS::MediaConvert::JobTemplate": { "MarkdownDocumentation": "`AWS::MediaConvert::JobTemplate`\n\nThe AWS::MediaConvert::JobTemplate resource is an AWS Elemental MediaConvert resource\ntype that you can use to generate transcoding jobs.\nWhen you declare this entity in your CloudFormation template, you pass in your\ntranscoding job settings in JSON or YAML format. This settings specification must be\nformed in a particular way that conforms to AWS Elemental MediaConvert job validation. For\nmore information about creating a job template model for the `SettingsJson`\nproperty, see the Remarks section later in this topic.\nFor information about job templates,\nsee [Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) in the *AWS Elemental MediaConvert User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::MediaConvert::JobTemplate`\nresource to the intrinsic `Ref` function, the function returns the name of\nthe job template, such as `Streaming stack DASH`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the job template, such as\n`arn:aws:mediaconvert:us-west-2:123456789012`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the job template, such as `Streaming stack DASH`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#Name-fn::getatt" } }, "Properties": { "Category": { "Required": false, "MarkdownDocumentation": "`Category`\n\nOptional. A category for the job template you are creating\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-category", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nOptional. A description of the job template you are creating.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AccelerationSettings": { "Type": "AccelerationSettings", "Required": false, "MarkdownDocumentation": "`AccelerationSettings`\n\nAccelerated transcoding can significantly speed up jobs with long, visually complex\ncontent. Outputs that use this feature incur pro-tier pricing. For information about\nfeature limitations, For more information, see [Job Limitations for Accelerated Transcoding in AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/job-requirements.html) in the *AWS Elemental MediaConvert User Guide*.\n*Required*: No\n*Type*: [AccelerationSettings](./aws-properties-mediaconvert-jobtemplate-accelerationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-accelerationsettings", "UpdateType": "Mutable" }, "Priority": { "Required": false, "MarkdownDocumentation": "`Priority`\n\nSpecify the relative priority for this job. In any given queue, the service begins\nprocessing the job with the highest value first. When more than one job has the same\npriority, the service begins processing the job that you submitted first. If you don't\nspecify a priority, the service uses the default value 0. Minimum: -50 Maximum:\n50\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-priority", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "StatusUpdateInterval": { "Required": false, "MarkdownDocumentation": "`StatusUpdateInterval`\n\nSpecify how often MediaConvert sends STATUS\\_UPDATE events to Amazon CloudWatch Events.\nSet the interval, in seconds, between status updates. MediaConvert sends an update at\nthis interval from the time the service begins processing your job to the time it\ncompletes the transcode or encounters an error.\nSpecify one of the following enums:\nSECONDS\\_10\nSECONDS\\_12\nSECONDS\\_15\nSECONDS\\_20\nSECONDS\\_30\nSECONDS\\_60\nSECONDS\\_120\nSECONDS\\_180\nSECONDS\\_240\nSECONDS\\_300\nSECONDS\\_360\nSECONDS\\_420\nSECONDS\\_480\nSECONDS\\_540\nSECONDS\\_600\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-statusupdateinterval", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SettingsJson": { "Required": true, "MarkdownDocumentation": "`SettingsJson`\n\nSpecify, in JSON format, the transcoding job settings for this job template. This\nspecification must conform to the AWS Elemental MediaConvert job validation. For\ninformation about forming this specification, see the Remarks section later in this\ntopic.\nFor more information about MediaConvert job templates, see [Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) in the\n*AWS Elemental MediaConvert 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-settingsjson", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Queue": { "Required": false, "MarkdownDocumentation": "`Queue`\n\nOptional. The queue that jobs created from this template are assigned to. Specify the\nAmazon Resource Name (ARN) of the queue. For example,\narn:aws:mediaconvert:us-west-2:505474453218:queues/Default. If you don't specify this,\njobs will go to the default 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-queue", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HopDestinations": { "Type": "List", "Required": false, "MarkdownDocumentation": "`HopDestinations`\n\nOptional. Configuration for a destination queue to which the job can hop once a\ncustomer-defined minimum wait time has passed. For more information, see [Setting Up Queue Hopping to Avoid Long Waits](https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-queue-hopping-to-avoid-long-waits.html) in the *AWS Elemental MediaConvert User Guide*.\n*Required*: No\n*Type*: Array of [HopDestination](./aws-properties-mediaconvert-jobtemplate-hopdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-hopdestinations", "ItemType": "HopDestination", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nName of the output 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-jobtemplate.html#cfn-mediaconvert-jobtemplate-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::MediaConvert::Preset": { "MarkdownDocumentation": "`AWS::MediaConvert::Preset`\n\nThe AWS::MediaConvert::Preset resource is an AWS Elemental MediaConvert resource type\nthat you can use to specify encoding settings for a single output in a transcoding\njob.\nWhen you declare this entity in your CloudFormation template, you pass in your\ntranscoding job settings in JSON or YAML format. This settings specification must be\nformed in a particular way that conforms to AWS Elemental MediaConvert job validation. For\nmore information about creating an output preset model for the `SettingsJson`\nproperty, see the Remarks section later in this topic.\nFor more information about output MediaConvert presets, see [Working\nwith AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) in the *AWS Elemental MediaConvert User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::MediaConvert::Preset` resource to\nthe intrinsic `Ref` function, the function returns the name of the output\npreset, such as `HEVC high res`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the output preset, such as\n`arn:aws:mediaconvert:us-west-2:123456789012`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the output preset, such as `HEVC high res`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#Name-fn::getatt" } }, "Properties": { "Category": { "Required": false, "MarkdownDocumentation": "`Category`\n\nThe new category for the preset, if you are changing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-category", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe new description for the preset, if you are changing 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "SettingsJson": { "Required": true, "MarkdownDocumentation": "`SettingsJson`\n\nSpecify, in JSON format, the transcoding job settings for this output preset. This\nspecification must conform to the AWS Elemental MediaConvert job validation. For\ninformation about forming this specification, see the Remarks section later in this\ntopic.\nFor more information about MediaConvert output presets, see [Working\nwith AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) in the *AWS Elemental MediaConvert 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-settingsjson", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the preset that you are\nmodifying.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.html#cfn-mediaconvert-preset-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::MediaConvert::Queue": { "MarkdownDocumentation": "`AWS::MediaConvert::Queue`\n\nThe AWS::MediaConvert::Queue resource is an AWS Elemental MediaConvert resource type\nthat you can use to manage the resources that are available to your account for parallel\nprocessing of jobs. For more information about queues, see [Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) in the *AWS Elemental MediaConvert User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of an `AWS::MediaConvert::Queue` resource to\nthe intrinsic `Ref` function, the function returns the name of the queue,\nsuch as `Queue 2`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the queue, such as\n`arn:aws:mediaconvert:us-west-2:123456789012`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the queue, such as `Queue 2`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#Name-fn::getatt" } }, "Properties": { "Status": { "Required": false, "MarkdownDocumentation": "`Status`\n\nInitial state of the queue. Queues can be either ACTIVE or PAUSED. If you create a\npaused queue, then jobs that you send to that queue won't begin.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-status", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nOptional. A description of the queue that you are creating.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "PricingPlan": { "Required": false, "MarkdownDocumentation": "`PricingPlan`\n\nWhen you use CloudFormation, you can create only on-demand queues. Therefore,\nalways set `PricingPlan` to the value \"ON\\_DEMAND\" when declaring an\nAWS::MediaConvert::Queue in your CloudFormation template.\nTo create a reserved queue, use the AWS Elemental MediaConvert console at\nhttps://console.aws.amazon.com/mediaconvert to set up a contract. For more information,\nsee [Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) in the *AWS Elemental MediaConvert 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-pricingplan", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "ConcurrentJobs": { "Required": false, "MarkdownDocumentation": "`ConcurrentJobs`\n\nSpecify the maximum number of jobs your queue can process concurrently. For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, specify the number of jobs you can process concurrently in your reservation plan instead.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-concurrentjobs", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe name of the queue that you are creating.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::MediaLive::Channel": { "MarkdownDocumentation": "`AWS::MediaLive::Channel`\n\nThe AWS::MediaLive::Channel resource is a MediaLive resource type that creates a\nchannel.\nA MediaLive channel ingests and transcodes (decodes and encodes) source content from\nthe inputs that are attached to that channel, and packages the new content into outputs.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the channel.\nFor example: `{ \"Ref\": \"myChannel\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the MediaLive channel. For example:\narn:aws:medialive:us-west-1:111122223333:medialive:channel:1234567\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#Arn-fn::getatt" }, "Inputs": { "PrimitiveItemType": "String", "Type": "List", "MarkdownDocumentation": "`Inputs`\n\nThe inputs that are attached to this channel. The inputs are identified by their IDs\n(not by their names or their ARNs).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#Inputs-fn::getatt" } }, "Properties": { "InputAttachments": { "Type": "List", "Required": false, "MarkdownDocumentation": "`InputAttachments`\n\nThe list of input attachments for the channel.\n*Required*: No\n*Type*: Array of [InputAttachment](./aws-properties-medialive-channel-inputattachment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-inputattachments", "ItemType": "InputAttachment", "UpdateType": "Mutable" }, "InputSpecification": { "Type": "InputSpecification", "Required": false, "MarkdownDocumentation": "`InputSpecification`\n\nThe input specification for this channel. It specifies the key characteristics of the\ninputs for this channel: the maximum bitrate, the resolution, and the codec.\n*Required*: No\n*Type*: [InputSpecification](./aws-properties-medialive-channel-inputspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-inputspecification", "UpdateType": "Mutable" }, "Destinations": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Destinations`\n\nThe settings that identify the destination for the outputs in this MediaLive output\npackage.\n*Required*: No\n*Type*: Array of [OutputDestination](./aws-properties-medialive-channel-outputdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-destinations", "ItemType": "OutputDestination", "UpdateType": "Mutable" }, "DryRun": { "Required": false, "MarkdownDocumentation": "`DryRun`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-dryrun", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Vpc": { "Type": "VpcOutputSettings", "Required": false, "MarkdownDocumentation": "`Vpc`\n\nSettings to enable VPC mode in the channel, so that the endpoints for all outputs are\nin your VPC.\n*Required*: No\n*Type*: [VpcOutputSettings](./aws-properties-medialive-channel-vpcoutputsettings.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-vpc", "UpdateType": "Immutable" }, "ChannelEngineVersion": { "Type": "ChannelEngineVersionRequest", "Required": false, "MarkdownDocumentation": "`ChannelEngineVersion`\n\nProperty description not available.\n*Required*: No\n*Type*: [ChannelEngineVersionRequest](./aws-properties-medialive-channel-channelengineversionrequest.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-channelengineversion", "UpdateType": "Mutable" }, "Maintenance": { "Type": "MaintenanceCreateSettings", "Required": false, "MarkdownDocumentation": "`Maintenance`\n\nMaintenance settings for this channel.\n*Required*: No\n*Type*: [MaintenanceCreateSettings](./aws-properties-medialive-channel-maintenancecreatesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-maintenance", "UpdateType": "Mutable" }, "LogLevel": { "Required": false, "MarkdownDocumentation": "`LogLevel`\n\nThe verbosity for logging activity for this channel. Charges for logging (which are\ngenerated through Amazon CloudWatch Logging) are higher for higher verbosities.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-loglevel", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RoleArn": { "Required": false, "MarkdownDocumentation": "`RoleArn`\n\nThe IAM role for MediaLive to assume when running this channel. The role is identified\nby its 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-rolearn", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nName of channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ChannelClass": { "Required": false, "MarkdownDocumentation": "`ChannelClass`\n\nThe class for this channel. For a channel with two pipelines, the class is STANDARD.\nFor a channel with one pipeline, the class is SINGLE\\_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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-channelclass", "PrimitiveType": "String", "UpdateType": "Mutable" }, "EncoderSettings": { "Type": "EncoderSettings", "Required": false, "MarkdownDocumentation": "`EncoderSettings`\n\nThe encoding configuration for the output content.\n*Required*: No\n*Type*: [EncoderSettings](./aws-properties-medialive-channel-encodersettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-encodersettings", "UpdateType": "Mutable" }, "AnywhereSettings": { "Type": "AnywhereSettings", "Required": false, "MarkdownDocumentation": "`AnywhereSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [AnywhereSettings](./aws-properties-medialive-channel-anywheresettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-anywheresettings", "UpdateType": "Mutable" }, "CdiInputSpecification": { "Type": "CdiInputSpecification", "Required": false, "MarkdownDocumentation": "`CdiInputSpecification`\n\nSpecification of CDI inputs for this channel.\n*Required*: No\n*Type*: [CdiInputSpecification](./aws-properties-medialive-channel-cdiinputspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-cdiinputspecification", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nA collection of tags for this channel. Each tag is a key-value pair.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" } } }, "AWS::MediaLive::ChannelPlacementGroup": { "MarkdownDocumentation": "`AWS::MediaLive::ChannelPlacementGroup`\n\nThe `AWS::MediaLive::ChannelPlacementGroup` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html", "Properties": { "ClusterId": { "MarkdownDocumentation": "`ClusterId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html#cfn-medialive-channelplacementgroup-clusterid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Nodes": { "MarkdownDocumentation": "`Nodes`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html#cfn-medialive-channelplacementgroup-nodes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: [Array](./aws-properties-medialive-channelplacementgroup-tags.html) of [Tags](./aws-properties-medialive-channelplacementgroup-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html#cfn-medialive-channelplacementgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tags", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html#cfn-medialive-channelplacementgroup-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html#State-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html#Arn-fn::getatt" }, "Channels": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Channels`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channelplacementgroup.html#Channels-fn::getatt" } } }, "AWS::MediaLive::CloudWatchAlarmTemplate": { "MarkdownDocumentation": "`AWS::MediaLive::CloudWatchAlarmTemplate`\n\nThe `AWS::MediaLive::CloudWatchAlarmTemplate` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html", "Properties": { "TargetResourceType": { "MarkdownDocumentation": "`TargetResourceType`\n\nThe resource type this template should dynamically generate CloudWatch metric alarms for.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLOUDFRONT_DISTRIBUTION | M...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLOUDFRONT_DISTRIBUTION", "MEDIALIVE_MULTIPLEX", "MEDIALIVE_CHANNEL", "MEDIALIVE_INPUT_DEVICE", "MEDIAPACKAGE_CHANNEL", "MEDIAPACKAGE_ORIGIN_ENDPOINT", "MEDIACONNECT_FLOW", "MEDIATAILOR_PLAYBACK_CONFIGURATION", "S3_BUCKET" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-targetresourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ComparisonOperator": { "MarkdownDocumentation": "`ComparisonOperator`\n\nThe comparison operator used to compare the specified statistic and the threshold.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GreaterThanOrEqualToThresho...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-comparisonoperator", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TreatMissingData": { "MarkdownDocumentation": "`TreatMissingData`\n\nSpecifies how missing data points are treated when evaluating the alarm's condition.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `notBreaching | breaching | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "notBreaching", "breaching", "ignore", "missing" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-treatmissingdata", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA resource's optional description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Period": { "MarkdownDocumentation": "`Period`\n\nThe period, in seconds, over which the specified statistic is applied.\n*Required*: Yes\n*Type*: Number\n*Minimum*: `10`\n*Maximum*: `86400`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-period", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "EvaluationPeriods": { "MarkdownDocumentation": "`EvaluationPeriods`\n\nThe number of periods over which data is compared to the specified threshold.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-evaluationperiods", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "GroupIdentifier": { "MarkdownDocumentation": "`GroupIdentifier`\n\nA cloudwatch alarm template group's identifier. Can be either be its id or current name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-groupidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA resource's name. Names must be unique within the scope of a resource type in a specific region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\s]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metric associated with the alarm. Must be compatible with targetResourceType.\n*Required*: Yes\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-metricname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Statistic": { "MarkdownDocumentation": "`Statistic`\n\nThe statistic to apply to the alarm's metric data.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SampleCount | Average | Sum...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-statistic", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatapointsToAlarm": { "MarkdownDocumentation": "`DatapointsToAlarm`\n\nThe number of datapoints within the evaluation period that must be breaching to trigger the alarm.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-datapointstoalarm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Threshold": { "MarkdownDocumentation": "`Threshold`\n\nThe threshold value to compare with the specified statistic.\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-threshold", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe date and time of latest resource modification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#ModifiedAt-fn::getatt" }, "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#Identifier-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time of resource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nA cloudwatch alarm template's id. Amazon Web Services provided templates have ids that start with `aws-`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nA cloudwatch alarm template's ARN (Amazon Resource Name)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#Arn-fn::getatt" }, "GroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupId`\n\nA CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with `aws-`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#GroupId-fn::getatt" } } }, "AWS::MediaLive::CloudWatchAlarmTemplateGroup": { "MarkdownDocumentation": "`AWS::MediaLive::CloudWatchAlarmTemplateGroup`\n\nThe `AWS::MediaLive::CloudWatchAlarmTemplateGroup` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA resource's optional description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html#cfn-medialive-cloudwatchalarmtemplategroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html#cfn-medialive-cloudwatchalarmtemplategroup-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA resource's name. Names must be unique within the scope of a resource type in a specific region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\s]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html#cfn-medialive-cloudwatchalarmtemplategroup-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe date and time of latest resource modification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html#ModifiedAt-fn::getatt" }, "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html#Identifier-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time of resource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nA CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with `aws-`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nA cloudwatch alarm template group's ARN (Amazon Resource Name)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplategroup.html#Arn-fn::getatt" } } }, "AWS::MediaLive::Cluster": { "MarkdownDocumentation": "`AWS::MediaLive::Cluster`\n\nThe `AWS::MediaLive::Cluster` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html", "Properties": { "NetworkSettings": { "MarkdownDocumentation": "`NetworkSettings`\n\nProperty description not available.\n*Required*: No\n*Type*: [ClusterNetworkSettings](./aws-properties-medialive-cluster-clusternetworksettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#cfn-medialive-cluster-networksettings", "UpdateType": "Mutable", "Required": false, "Type": "ClusterNetworkSettings" }, "InstanceRoleArn": { "MarkdownDocumentation": "`InstanceRoleArn`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:.+:iam:.+:role/.+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#cfn-medialive-cluster-instancerolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClusterType": { "MarkdownDocumentation": "`ClusterType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ON_PREMISES | OUTPOSTS_RACK...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ON_PREMISES", "OUTPOSTS_RACK", "OUTPOSTS_SERVER", "EC2" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#cfn-medialive-cluster-clustertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: [Array](./aws-properties-medialive-cluster-tags.html) of [Tags](./aws-properties-medialive-cluster-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#cfn-medialive-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tags", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#cfn-medialive-cluster-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#State-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#Arn-fn::getatt" }, "ChannelIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ChannelIds`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cluster.html#ChannelIds-fn::getatt" } } }, "AWS::MediaLive::EventBridgeRuleTemplate": { "MarkdownDocumentation": "`AWS::MediaLive::EventBridgeRuleTemplate`\n\nThe `AWS::MediaLive::EventBridgeRuleTemplate` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA resource's optional description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#cfn-medialive-eventbridgeruletemplate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventTargets": { "MarkdownDocumentation": "`EventTargets`\n\nThe destinations that will receive the event notifications.\n*Required*: No\n*Type*: Array of [EventBridgeRuleTemplateTarget](./aws-properties-medialive-eventbridgeruletemplate-eventbridgeruletemplatetarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#cfn-medialive-eventbridgeruletemplate-eventtargets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EventBridgeRuleTemplateTarget", "DuplicatesAllowed": true }, "EventType": { "MarkdownDocumentation": "`EventType`\n\nThe type of event to match with the rule.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MEDIALIVE_MULTIPLEX_ALERT |...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MEDIALIVE_MULTIPLEX_ALERT", "MEDIALIVE_MULTIPLEX_STATE_CHANGE", "MEDIALIVE_CHANNEL_ALERT", "MEDIALIVE_CHANNEL_INPUT_CHANGE", "MEDIALIVE_CHANNEL_STATE_CHANGE", "MEDIAPACKAGE_INPUT_NOTIFICATION", "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION", "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION", "SIGNAL_MAP_ACTIVE_ALARM", "MEDIACONNECT_ALERT", "MEDIACONNECT_SOURCE_HEALTH", "MEDIACONNECT_OUTPUT_HEALTH", "MEDIACONNECT_FLOW_STATUS_CHANGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#cfn-medialive-eventbridgeruletemplate-eventtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#cfn-medialive-eventbridgeruletemplate-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "GroupIdentifier": { "MarkdownDocumentation": "`GroupIdentifier`\n\nAn eventbridge rule template group's identifier. Can be either be its id or current name.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#cfn-medialive-eventbridgeruletemplate-groupidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA resource's name. Names must be unique within the scope of a resource type in a specific region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\s]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#cfn-medialive-eventbridgeruletemplate-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe date and time of latest resource modification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#ModifiedAt-fn::getatt" }, "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#Identifier-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time of resource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nAn eventbridge rule template's id. Amazon Web Services provided templates have ids that start with `aws-`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nTarget ARNs must be either an SNS topic or CloudWatch log group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#Arn-fn::getatt" }, "GroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupId`\n\nAn eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with `aws-`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplate.html#GroupId-fn::getatt" } } }, "AWS::MediaLive::EventBridgeRuleTemplateGroup": { "MarkdownDocumentation": "`AWS::MediaLive::EventBridgeRuleTemplateGroup`\n\nThe `AWS::MediaLive::EventBridgeRuleTemplateGroup` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA resource's optional description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html#cfn-medialive-eventbridgeruletemplategroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html#cfn-medialive-eventbridgeruletemplategroup-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA resource's name. Names must be unique within the scope of a resource type in a specific region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\s]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html#cfn-medialive-eventbridgeruletemplategroup-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe date and time of latest resource modification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html#ModifiedAt-fn::getatt" }, "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html#Identifier-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time of resource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nAn eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with `aws-`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nAn eventbridge rule template group's ARN (Amazon Resource Name)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-eventbridgeruletemplategroup.html#Arn-fn::getatt" } } }, "AWS::MediaLive::InputSecurityGroup": { "MarkdownDocumentation": "`AWS::MediaLive::InputSecurityGroup`\n\nThe AWS::MediaLive::InputSecurityGroup is a MediaLive resource type that creates an\ninput security group.\nA MediaLive input security group is associated with a MediaLive input. The input\nsecurity group is an \"allow list\" of IP addresses that controls whether an external IP\naddress can push content to the associated MediaLive input.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the input security group.\nFor example: `{ \"Ref\": \"myInputSecurityGroup\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-inputsecuritygroup.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the MediaLive input security group. For example:\narn:aws:medialive:us-west-1:111122223333:medialive:inputSecurityGroup:1234567\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-inputsecuritygroup.html#Arn-fn::getatt" } }, "Properties": { "WhitelistRules": { "Type": "List", "Required": false, "MarkdownDocumentation": "`WhitelistRules`\n\nThe list of IPv4 CIDR addresses to include in the input security group as \"allowed\"\naddresses.\n*Required*: No\n*Type*: Array of [InputWhitelistRuleCidr](./aws-properties-medialive-inputsecuritygroup-inputwhitelistrulecidr.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-inputsecuritygroup.html#cfn-medialive-inputsecuritygroup-whitelistrules", "ItemType": "InputWhitelistRuleCidr", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "`Tags`\n\nA collection of tags for this input security group. Each tag is a key-value\npair.\n*Required*: No\n*Type*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-inputsecuritygroup.html#cfn-medialive-inputsecuritygroup-tags", "PrimitiveType": "Json", "UpdateType": "Immutable" } } }, "AWS::MediaLive::Multiplex": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplex`\n\nThe multiplex object.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html", "Properties": { "MultiplexSettings": { "MarkdownDocumentation": "`MultiplexSettings`\n\nConfiguration for a multiplex event.\n*Required*: Yes\n*Type*: [MultiplexSettings](./aws-properties-medialive-multiplex-multiplexsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#cfn-medialive-multiplex-multiplexsettings", "UpdateType": "Mutable", "Required": true, "Type": "MultiplexSettings" }, "AvailabilityZones": { "MarkdownDocumentation": "`AvailabilityZones`\n\nA list of availability zones for the multiplex.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#cfn-medialive-multiplex-availabilityzones", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Destinations": { "MarkdownDocumentation": "`Destinations`\n\nA list of the multiplex output destinations.\n*Required*: No\n*Type*: Array of [MultiplexOutputDestination](./aws-properties-medialive-multiplex-multiplexoutputdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#cfn-medialive-multiplex-destinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MultiplexOutputDestination", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA collection of key-value pairs.\n*Required*: No\n*Type*: [Array](./aws-properties-medialive-multiplex-tags.html) of [Tags](./aws-properties-medialive-multiplex-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#cfn-medialive-multiplex-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tags", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the multiplex.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#cfn-medialive-multiplex-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the multiplex.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#State-fn::getatt" }, "ProgramCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ProgramCount`\n\nThe number of programs in the multiplex.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#ProgramCount-fn::getatt" }, "PipelinesRunningCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`PipelinesRunningCount`\n\nThe number of currently healthy pipelines.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#PipelinesRunningCount-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique id of the multiplex.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique arn of the multiplex.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplex.html#Arn-fn::getatt" } } }, "AWS::MediaLive::Multiplexprogram": { "MarkdownDocumentation": "`AWS::MediaLive::Multiplexprogram`\n\nThe `AWS::MediaLive::Multiplexprogram` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplexprogram.html", "Properties": { "MultiplexId": { "MarkdownDocumentation": "`MultiplexId`\n\nThe unique id of the multiplex.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplexprogram.html#cfn-medialive-multiplexprogram-multiplexid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PreferredChannelPipeline": { "MarkdownDocumentation": "`PreferredChannelPipeline`\n\nIndicates which pipeline is preferred by the multiplex for program ingest.\nIf set to \\\"PIPELINE\\_0\\\" or \\\"PIPELINE\\_1\\\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline,\nit will switch back once that ingest is healthy again. If set to \\\"CURRENTLY\\_ACTIVE\\\",\nit will not switch back to the other pipeline based on it recovering to a healthy state,\nit will only switch if the active pipeline becomes unhealthy.\n*Required*: No\n*Type*: String\n*Allowed values*: `CURRENTLY_ACTIVE | PIPELINE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CURRENTLY_ACTIVE", "PIPELINE_0", "PIPELINE_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplexprogram.html#cfn-medialive-multiplexprogram-preferredchannelpipeline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PacketIdentifiersMap": { "MarkdownDocumentation": "`PacketIdentifiersMap`\n\nProperty description not available.\n*Required*: No\n*Type*: [MultiplexProgramPacketIdentifiersMap](./aws-properties-medialive-multiplexprogram-multiplexprogrampacketidentifiersmap.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplexprogram.html#cfn-medialive-multiplexprogram-packetidentifiersmap", "UpdateType": "Mutable", "Required": false, "Type": "MultiplexProgramPacketIdentifiersMap" }, "PipelineDetails": { "MarkdownDocumentation": "`PipelineDetails`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [MultiplexProgramPipelineDetail](./aws-properties-medialive-multiplexprogram-multiplexprogrampipelinedetail.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplexprogram.html#cfn-medialive-multiplexprogram-pipelinedetails", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MultiplexProgramPipelineDetail", "DuplicatesAllowed": true }, "MultiplexProgramSettings": { "MarkdownDocumentation": "`MultiplexProgramSettings`\n\nMultiplex Program settings configuration.\n*Required*: No\n*Type*: [MultiplexProgramSettings](./aws-properties-medialive-multiplexprogram-multiplexprogramsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplexprogram.html#cfn-medialive-multiplexprogram-multiplexprogramsettings", "UpdateType": "Mutable", "Required": false, "Type": "MultiplexProgramSettings" }, "ProgramName": { "MarkdownDocumentation": "`ProgramName`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplexprogram.html#cfn-medialive-multiplexprogram-programname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ChannelId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ChannelId`\n\nThe unique ID of the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-multiplexprogram.html#ChannelId-fn::getatt" } } }, "AWS::MediaLive::Network": { "MarkdownDocumentation": "`AWS::MediaLive::Network`\n\nThe `AWS::MediaLive::Network` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html", "Properties": { "IpPools": { "MarkdownDocumentation": "`IpPools`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of [IpPool](./aws-properties-medialive-network-ippool.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html#cfn-medialive-network-ippools", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "IpPool", "DuplicatesAllowed": true }, "Routes": { "MarkdownDocumentation": "`Routes`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Route](./aws-properties-medialive-network-route.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html#cfn-medialive-network-routes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Route", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: [Array](./aws-properties-medialive-network-tags.html) of [Tags](./aws-properties-medialive-network-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html#cfn-medialive-network-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tags", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html#cfn-medialive-network-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AssociatedClusterIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`AssociatedClusterIds`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html#AssociatedClusterIds-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html#State-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-network.html#Arn-fn::getatt" } } }, "AWS::MediaLive::SdiSource": { "MarkdownDocumentation": "`AWS::MediaLive::SdiSource`\n\nThe `AWS::MediaLive::SdiSource` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SINGLE | QUAD...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE", "QUAD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html#cfn-medialive-sdisource-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Mode": { "MarkdownDocumentation": "`Mode`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `QUADRANT | INTERLEAVE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "QUADRANT", "INTERLEAVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html#cfn-medialive-sdisource-mode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: [Array](./aws-properties-medialive-sdisource-tags.html) of [Tags](./aws-properties-medialive-sdisource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html#cfn-medialive-sdisource-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tags", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html#cfn-medialive-sdisource-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html#State-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html#Arn-fn::getatt" }, "Inputs": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Inputs`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-sdisource.html#Inputs-fn::getatt" } } }, "AWS::MediaLive::SignalMap": { "MarkdownDocumentation": "`AWS::MediaLive::SignalMap`\n\nThe `AWS::MediaLive::SignalMap` resource Property description not available. for MediaLive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA resource's optional description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#cfn-medialive-signalmap-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventBridgeRuleTemplateGroupIdentifiers": { "MarkdownDocumentation": "`EventBridgeRuleTemplateGroupIdentifiers`\n\nAn eventbridge rule template group's identifier. Can be either be its id or current name.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#cfn-medialive-signalmap-eventbridgeruletemplategroupidentifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DiscoveryEntryPointArn": { "MarkdownDocumentation": "`DiscoveryEntryPointArn`\n\nA top-level supported Amazon Web Services resource ARN to discover a signal map from.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#cfn-medialive-signalmap-discoveryentrypointarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CloudWatchAlarmTemplateGroupIdentifiers": { "MarkdownDocumentation": "`CloudWatchAlarmTemplateGroupIdentifiers`\n\nA cloudwatch alarm template group's identifier. Can be either be its id or current name.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#cfn-medialive-signalmap-cloudwatchalarmtemplategroupidentifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ForceRediscovery": { "MarkdownDocumentation": "`ForceRediscovery`\n\nIf true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#cfn-medialive-signalmap-forcerediscovery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#cfn-medialive-signalmap-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA resource's name. Names must be unique within the scope of a resource type in a specific region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[^\\s]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#cfn-medialive-signalmap-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nA signal map's current status, which is dependent on its lifecycle actions or associated jobs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#Status-fn::getatt" }, "MonitorDeployment.ErrorMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#MonitorDeployment.ErrorMessage-fn::getatt" }, "CloudWatchAlarmTemplateGroupIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`CloudWatchAlarmTemplateGroupIds`\n\nAn alarm template group's id.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#CloudWatchAlarmTemplateGroupIds-fn::getatt" }, "LastSuccessfulMonitorDeployment.DetailsUri": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#LastSuccessfulMonitorDeployment.DetailsUri-fn::getatt" }, "LastDiscoveredAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastDiscoveredAt`\n\nThe date and time of latest discovery.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#LastDiscoveredAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time of resource creation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#CreatedAt-fn::getatt" }, "LastSuccessfulMonitorDeployment": { "Type": "SuccessfulMonitorDeployment", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#LastSuccessfulMonitorDeployment-fn::getatt" }, "EventBridgeRuleTemplateGroupIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`EventBridgeRuleTemplateGroupIds`\n\nAn eventbridge rule template group's id.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#EventBridgeRuleTemplateGroupIds-fn::getatt" }, "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe date and time of latest resource modification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#ModifiedAt-fn::getatt" }, "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#Identifier-fn::getatt" }, "MonitorDeployment.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#MonitorDeployment.Status-fn::getatt" }, "MediaResourceMap": { "Type": "Map", "ItemType": "MediaResource", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#MediaResourceMap-fn::getatt" }, "MonitorDeployment.DetailsUri": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#MonitorDeployment.DetailsUri-fn::getatt" }, "FailedMediaResourceMap": { "Type": "Map", "ItemType": "MediaResource", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#FailedMediaResourceMap-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nA signal map's id.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nA signal map's ARN (Amazon Resource Name)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#Arn-fn::getatt" }, "ErrorMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ErrorMessage`\n\nError message associated with a failed creation or failed update attempt of a signal map.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#ErrorMessage-fn::getatt" }, "MonitorChangesPendingDeployment": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`MonitorChangesPendingDeployment`\n\nIf true, there are pending monitor changes for this signal map that can be deployed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#MonitorChangesPendingDeployment-fn::getatt" }, "MonitorDeployment": { "Type": "MonitorDeployment", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#MonitorDeployment-fn::getatt" }, "LastSuccessfulMonitorDeployment.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-signalmap.html#LastSuccessfulMonitorDeployment.Status-fn::getatt" } } }, "AWS::MediaPackage::Asset": { "MarkdownDocumentation": "`AWS::MediaPackage::Asset`\n\nCreates an asset to ingest VOD content.\nAfter it's created, the asset starts ingesting content and generates playback URLs for the packaging configurations associated with it. When ingest is complete, downstream\ndevices use the appropriate URL to request VOD content from AWS Elemental MediaPackage.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the asset.\nFor example: `{ \"Ref\": \"myAsset\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html", "Properties": { "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#cfn-mediapackage-asset-sourcearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nUnique 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#cfn-mediapackage-asset-resourceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Id": { "MarkdownDocumentation": "`Id`\n\nUnique identifier that you assign to the asset.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#cfn-mediapackage-asset-id", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PackagingGroupId": { "MarkdownDocumentation": "`PackagingGroupId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#cfn-mediapackage-asset-packaginggroupid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EgressEndpoints": { "MarkdownDocumentation": "`EgressEndpoints`\n\nList of playback endpoints that are available for this asset.\n*Required*: No\n*Type*: Array of [EgressEndpoint](./aws-properties-mediapackage-asset-egressendpoint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#cfn-mediapackage-asset-egressendpoints", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EgressEndpoint", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the asset.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediapackage-asset-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#cfn-mediapackage-asset-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "SourceRoleArn": { "MarkdownDocumentation": "`SourceRoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#cfn-mediapackage-asset-sourcerolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the asset was initially submitted for ingest.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#CreatedAt-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the asset. You can get this from the response to any request to the asset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-asset.html#Arn-fn::getatt" } } }, "AWS::MediaPackage::Channel": { "MarkdownDocumentation": "`AWS::MediaPackage::Channel`\n\nCreates a channel to receive content.\nAfter it's created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might\noccur. Use these URLs to configure the outputs of your upstream encoder.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the channel.\nFor example: `{ \"Ref\": \"myChannel\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-channel.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nAny 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-channel.html#cfn-mediapackage-channel-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IngressAccessLogs": { "MarkdownDocumentation": "`IngressAccessLogs`\n\nConfigures ingress access logs.\n*Required*: No\n*Type*: [LogConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-channel.html#cfn-mediapackage-channel-ingressaccesslogs", "UpdateType": "Mutable", "Required": false, "Type": "LogConfiguration" }, "HlsIngest": { "MarkdownDocumentation": "`HlsIngest`\n\nThe input URL where the source stream should be sent.\n*Required*: No\n*Type*: [HlsIngest](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-channel.html#cfn-mediapackage-channel-hlsingest", "UpdateType": "Mutable", "Required": false, "Type": "HlsIngest" }, "Id": { "MarkdownDocumentation": "`Id`\n\nUnique identifier that you assign to the channel.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\A[0-9a-zA-Z-_]+\\Z`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-channel.html#cfn-mediapackage-channel-id", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EgressAccessLogs": { "MarkdownDocumentation": "`EgressAccessLogs`\n\nConfigures egress access logs.\n*Required*: No\n*Type*: [LogConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-channel.html#cfn-mediapackage-channel-egressaccesslogs", "UpdateType": "Mutable", "Required": false, "Type": "LogConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the channel.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediapackage-channel-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-channel.html#cfn-mediapackage-channel-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe channel's unique system-generated resource name, based on the AWS record.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-channel.html#Arn-fn::getatt" } } }, "AWS::MediaPackage::OriginEndpoint": { "MarkdownDocumentation": "`AWS::MediaPackage::OriginEndpoint`\n\nCreate an endpoint on an AWS Elemental MediaPackage channel.\nAn endpoint represents a single delivery point of a channel, and defines content output handling through various components, such as packaging protocols, DRM and encryption integration, and more.\nAfter it's created, an endpoint provides a fixed public URL. This URL remains the same\nthroughout the lifetime of the endpoint, regardless of any failures or upgrades that might occur. Integrate the URL with a downstream CDN (such as Amazon CloudFront) or playback\ndevice.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the origin endpoint.\nFor example: `{ \"Ref\": \"myOriginEndpoint\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html", "Properties": { "MssPackage": { "MarkdownDocumentation": "`MssPackage`\n\nParameters for Microsoft Smooth Streaming packaging.\n*Required*: No\n*Type*: [MssPackage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-msspackage", "UpdateType": "Mutable", "Required": false, "Type": "MssPackage" }, "Description": { "MarkdownDocumentation": "`Description`\n\nAny 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ChannelId": { "MarkdownDocumentation": "`ChannelId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-channelid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TimeDelaySeconds": { "MarkdownDocumentation": "`TimeDelaySeconds`\n\nMinimum 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-timedelayseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Origination": { "MarkdownDocumentation": "`Origination`\n\nControls 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\n [Live-to-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `ALLOW | DENY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-origination", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Authorization": { "MarkdownDocumentation": "`Authorization`\n\nParameters for CDN authorization.\n*Required*: No\n*Type*: [Authorization](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-authorization", "UpdateType": "Mutable", "Required": false, "Type": "Authorization" }, "ManifestName": { "MarkdownDocumentation": "`ManifestName`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-manifestname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CmafPackage": { "MarkdownDocumentation": "`CmafPackage`\n\nParameters for Common Media Application Format (CMAF) packaging.\n*Required*: No\n*Type*: [CmafPackage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-cmafpackage", "UpdateType": "Mutable", "Required": false, "Type": "CmafPackage" }, "Whitelist": { "MarkdownDocumentation": "`Whitelist`\n\nThe IP addresses that can access this endpoint.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-whitelist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Id": { "MarkdownDocumentation": "`Id`\n\nThe 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*Pattern*: `\\A[0-9a-zA-Z-_]+\\Z`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-id", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HlsPackage": { "MarkdownDocumentation": "`HlsPackage`\n\nParameters for Apple HLS packaging.\n*Required*: No\n*Type*: [HlsPackage](./aws-properties-mediapackage-originendpoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-hlspackage", "UpdateType": "Mutable", "Required": false, "Type": "HlsPackage" }, "DashPackage": { "MarkdownDocumentation": "`DashPackage`\n\nParameters for DASH packaging.\n*Required*: No\n*Type*: [DashPackage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-dashpackage", "UpdateType": "Mutable", "Required": false, "Type": "DashPackage" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the endpoint.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediapackage-originendpoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "StartoverWindowSeconds": { "MarkdownDocumentation": "`StartoverWindowSeconds`\n\nMaximum 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-startoverwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe endpoint's unique system-generated resource name, based on the AWS record.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#Arn-fn::getatt" }, "Url": { "PrimitiveType": "String", "MarkdownDocumentation": "`Url`\n\nURL for the key provider\u2019s key retrieval API endpoint. Must start with https://.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#Url-fn::getatt" } } }, "AWS::MediaPackage::PackagingConfiguration": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingConfiguration`\n\nCreates a packaging configuration in a packaging group.\nThe packaging configuration represents a single delivery point for an asset. It determines the format and setting for the egressing content. Specify only one package format per configuration, such as `HlsPackage`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the packaging configuration.\nFor example: `{ \"Ref\": \"myPackagingConfiguration\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html", "Properties": { "MssPackage": { "MarkdownDocumentation": "`MssPackage`\n\nParameters for Microsoft Smooth Streaming packaging.\n*Required*: No\n*Type*: [MssPackage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html#cfn-mediapackage-packagingconfiguration-msspackage", "UpdateType": "Mutable", "Required": false, "Type": "MssPackage" }, "CmafPackage": { "MarkdownDocumentation": "`CmafPackage`\n\nParameters for CMAF packaging.\n*Required*: No\n*Type*: [CmafPackage](./aws-properties-mediapackage-packagingconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html#cfn-mediapackage-packagingconfiguration-cmafpackage", "UpdateType": "Mutable", "Required": false, "Type": "CmafPackage" }, "Id": { "MarkdownDocumentation": "`Id`\n\nUnique 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html#cfn-mediapackage-packagingconfiguration-id", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HlsPackage": { "MarkdownDocumentation": "`HlsPackage`\n\nParameters for Apple HLS packaging.\n*Required*: No\n*Type*: [HlsPackage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html#cfn-mediapackage-packagingconfiguration-hlspackage", "UpdateType": "Mutable", "Required": false, "Type": "HlsPackage" }, "PackagingGroupId": { "MarkdownDocumentation": "`PackagingGroupId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html#cfn-mediapackage-packagingconfiguration-packaginggroupid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DashPackage": { "MarkdownDocumentation": "`DashPackage`\n\nParameters for DASH-ISO packaging.\n*Required*: No\n*Type*: [DashPackage](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html#cfn-mediapackage-packagingconfiguration-dashpackage", "UpdateType": "Mutable", "Required": false, "Type": "DashPackage" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the packaging configuration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediapackage-packagingconfiguration-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html#cfn-mediapackage-packagingconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the packaging configuration. You can get this from the response to any request to the packaging configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packagingconfiguration.html#Arn-fn::getatt" } } }, "AWS::MediaPackage::PackagingGroup": { "MarkdownDocumentation": "`AWS::MediaPackage::PackagingGroup`\n\nCreates a packaging group.\nThe packaging group holds one or more packaging configurations. When you create an asset, you specify the packaging group associated with the asset. The asset has playback endpoints for each packaging configuration within the group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the packaging group.\nFor example: `{ \"Ref\": \"myPackagingGroup\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packaginggroup.html", "Properties": { "Authorization": { "MarkdownDocumentation": "`Authorization`\n\nParameters for CDN authorization.\n*Required*: No\n*Type*: [Authorization](./aws-properties-mediapackage-packaginggroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packaginggroup.html#cfn-mediapackage-packaginggroup-authorization", "UpdateType": "Mutable", "Required": false, "Type": "Authorization" }, "Id": { "MarkdownDocumentation": "`Id`\n\nUnique identifier that you assign to the packaging group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\A[0-9a-zA-Z-_]+\\Z`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packaginggroup.html#cfn-mediapackage-packaginggroup-id", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EgressAccessLogs": { "MarkdownDocumentation": "`EgressAccessLogs`\n\nThe configuration parameters for egress access logging.\n*Required*: No\n*Type*: [LogConfiguration](./aws-properties-mediapackage-packaginggroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packaginggroup.html#cfn-mediapackage-packaginggroup-egressaccesslogs", "UpdateType": "Mutable", "Required": false, "Type": "LogConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the packaging group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediapackage-packaginggroup-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packaginggroup.html#cfn-mediapackage-packaginggroup-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nThe URL for the assets in the PackagingGroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packaginggroup.html#DomainName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the packaging group. You can get this from the response to any request to the packaging group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-packaginggroup.html#Arn-fn::getatt" } } }, "AWS::MediaPackageV2::Channel": { "MarkdownDocumentation": "`AWS::MediaPackageV2::Channel`\n\nCreates a channel to receive content.\nAfter it's created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`arn:aws:mediapackagev2:region:AccountId:ChannelGroup/ChannelGroupName/Channel/ChannelName`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html", "Properties": { "InputSwitchConfiguration": { "MarkdownDocumentation": "`InputSwitchConfiguration`\n\nThe configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.\n*Required*: No\n*Type*: [InputSwitchConfiguration](./aws-properties-mediapackagev2-channel-inputswitchconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-inputswitchconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InputSwitchConfiguration" }, "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe name of the channel.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-channelname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the channel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InputType": { "MarkdownDocumentation": "`InputType`\n\nThe input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.\nThe allowed values are:\n* `HLS` - The HLS streaming specification (which defines M3U8 manifests and TS segments).\n* `CMAF` - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).\n*Required*: No\n*Type*: String\n*Allowed values*: `HLS | CMAF`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "HLS", "CMAF" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-inputtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OutputHeaderConfiguration": { "MarkdownDocumentation": "`OutputHeaderConfiguration`\n\nThe settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.\n*Required*: No\n*Type*: [OutputHeaderConfiguration](./aws-properties-mediapackagev2-channel-outputheaderconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-outputheaderconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "OutputHeaderConfiguration" }, "ChannelGroupName": { "MarkdownDocumentation": "`ChannelGroupName`\n\nThe name of the channel group associated with the channel configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-channelgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediapackagev2-channel-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe timestamp of the modification of the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#ModifiedAt-fn::getatt" }, "IngestEndpoints": { "Type": "List", "ItemType": "IngestEndpoint", "MarkdownDocumentation": "`IngestEndpoints`\n\nThe ingest endpoints associated with the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#IngestEndpoints-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of the creation of the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#CreatedAt-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#Arn-fn::getatt" }, "IngestEndpointUrls": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`IngestEndpointUrls`\n\nThe ingest domain URL where the source stream should be sent.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#IngestEndpointUrls-fn::getatt" } } }, "AWS::MediaPackageV2::ChannelGroup": { "MarkdownDocumentation": "`AWS::MediaPackageV2::ChannelGroup`\n\nSpecifies the configuration for a MediaPackage V2 channel group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`arn:aws:mediapackagev2:region:AccountId:ChannelGroup/ChannelGroupName`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe configuration for a MediaPackage V2 channel group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#cfn-mediapackagev2-channelgroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ChannelGroupName": { "MarkdownDocumentation": "`ChannelGroupName`\n\nThe name of the channel group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#cfn-mediapackagev2-channelgroup-channelgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the channel group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediapackagev2-channelgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#cfn-mediapackagev2-channelgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe timestamp of the modification of the channel group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#ModifiedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of the creation of the channel group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#CreatedAt-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the channel group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#Arn-fn::getatt" }, "EgressDomain": { "PrimitiveType": "String", "MarkdownDocumentation": "`EgressDomain`\n\nThe egress domain of the channel group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelgroup.html#EgressDomain-fn::getatt" } } }, "AWS::MediaPackageV2::ChannelPolicy": { "MarkdownDocumentation": "`AWS::MediaPackageV2::ChannelPolicy`\n\nSpecifies the configuration parameters of a MediaPackage V2 channel policy.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`ChannelGroupName/ChannelName`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelpolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe policy associated with the channel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelpolicy.html#cfn-mediapackagev2-channelpolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe name of the channel associated with the channel policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelpolicy.html#cfn-mediapackagev2-channelpolicy-channelname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ChannelGroupName": { "MarkdownDocumentation": "`ChannelGroupName`\n\nThe name of the channel group associated with the channel policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channelpolicy.html#cfn-mediapackagev2-channelpolicy-channelgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaPackageV2::OriginEndpoint": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpoint`\n\nSpecifies the configuration parameters for a MediaPackage V2 origin endpoint.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`arn:aws:mediapackagev2:region:AccountId:ChannelGroup/ChannelGroupName/Channel/ChannelName/OriginEndpoint/OriginEndpointName`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html", "Properties": { "MssManifests": { "MarkdownDocumentation": "`MssManifests`\n\nA list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint. Each configuration represents a different MSS streaming option available from this endpoint.\n*Required*: No\n*Type*: Array of [MssManifestConfiguration](./aws-properties-mediapackagev2-originendpoint-mssmanifestconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-mssmanifests", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MssManifestConfiguration", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description associated with the origin endpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LowLatencyHlsManifests": { "MarkdownDocumentation": "`LowLatencyHlsManifests`\n\nThe low-latency HLS (LL-HLS) manifests associated with the origin endpoint.\n*Required*: No\n*Type*: Array of [LowLatencyHlsManifestConfiguration](./aws-properties-mediapackagev2-originendpoint-lowlatencyhlsmanifestconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifests", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LowLatencyHlsManifestConfiguration", "DuplicatesAllowed": true }, "ContainerType": { "MarkdownDocumentation": "`ContainerType`\n\nThe container type associated with the origin endpoint configuration.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `TS | CMAF | ISM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TS", "CMAF", "ISM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-containertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ForceEndpointErrorConfiguration": { "MarkdownDocumentation": "`ForceEndpointErrorConfiguration`\n\nThe failover settings for the endpoint.\n*Required*: No\n*Type*: [ForceEndpointErrorConfiguration](./aws-properties-mediapackagev2-originendpoint-forceendpointerrorconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-forceendpointerrorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ForceEndpointErrorConfiguration" }, "HlsManifests": { "MarkdownDocumentation": "`HlsManifests`\n\nThe HLS manifests associated with the origin endpoint configuration.\n*Required*: No\n*Type*: Array of [HlsManifestConfiguration](./aws-properties-mediapackagev2-originendpoint-hlsmanifestconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-hlsmanifests", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HlsManifestConfiguration", "DuplicatesAllowed": true }, "DashManifests": { "MarkdownDocumentation": "`DashManifests`\n\nA DASH manifest configuration.\n*Required*: No\n*Type*: Array of [DashManifestConfiguration](./aws-properties-mediapackagev2-originendpoint-dashmanifestconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-dashmanifests", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DashManifestConfiguration", "DuplicatesAllowed": true }, "Segment": { "MarkdownDocumentation": "`Segment`\n\nThe segment associated with the origin endpoint.\n*Required*: No\n*Type*: [Segment](./aws-properties-mediapackagev2-originendpoint-segment.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-segment", "UpdateType": "Mutable", "Required": false, "Type": "Segment" }, "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe channel name associated with the origin endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-channelname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OriginEndpointName": { "MarkdownDocumentation": "`OriginEndpointName`\n\nThe name of the origin endpoint associated with the origin endpoint configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-originendpointname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ChannelGroupName": { "MarkdownDocumentation": "`ChannelGroupName`\n\nThe name of the channel group associated with the origin endpoint configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-channelgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the origin endpoint.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediapackagev2-originendpoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "StartoverWindowSeconds": { "MarkdownDocumentation": "`StartoverWindowSeconds`\n\nThe size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.\n*Required*: No\n*Type*: Integer\n*Minimum*: `60`\n*Maximum*: `1209600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-startoverwindowseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "ModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModifiedAt`\n\nThe timestamp of the modification of the origin endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#ModifiedAt-fn::getatt" }, "LowLatencyHlsManifestUrls": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LowLatencyHlsManifestUrls`\n\nThe egress domain URL for stream delivery from MediaPackage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#LowLatencyHlsManifestUrls-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of the creation of the origin endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#CreatedAt-fn::getatt" }, "MssManifestUrls": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`MssManifestUrls`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#MssManifestUrls-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the origin endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#Arn-fn::getatt" }, "HlsManifestUrls": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`HlsManifestUrls`\n\nThe egress domain URL for stream delivery from MediaPackage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#HlsManifestUrls-fn::getatt" }, "DashManifestUrls": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`DashManifestUrls`\n\nThe egress domain URL for stream delivery from MediaPackage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#DashManifestUrls-fn::getatt" } } }, "AWS::MediaPackageV2::OriginEndpointPolicy": { "MarkdownDocumentation": "`AWS::MediaPackageV2::OriginEndpointPolicy`\n\nSpecifies the configuration parameters of a policy associated with a MediaPackage V2 origin endpoint.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`ChannelGroupName/ChannelName/OriginEndpointName`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe policy associated with the origin endpoint.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe channel name associated with the origin endpoint policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-channelname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OriginEndpointName": { "MarkdownDocumentation": "`OriginEndpointName`\n\nThe name of the origin endpoint associated with the origin endpoint policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-originendpointname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ChannelGroupName": { "MarkdownDocumentation": "`ChannelGroupName`\n\nThe name of the channel group associated with the origin endpoint policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-channelgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CdnAuthConfiguration": { "MarkdownDocumentation": "`CdnAuthConfiguration`\n\nThe settings to enable CDN authorization headers in MediaPackage.\n*Required*: No\n*Type*: [CdnAuthConfiguration](./aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpointpolicy.html#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CdnAuthConfiguration" } } }, "AWS::MediaTailor::Channel": { "MarkdownDocumentation": "`AWS::MediaTailor::Channel`\n\nThe configuration parameters for a channel. For information about MediaTailor channels, see [Working with channels](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) in the *MediaTailor User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html", "Properties": { "FillerSlate": { "MarkdownDocumentation": "`FillerSlate`\n\nThe slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the `LINEAR``PlaybackMode`. MediaTailor doesn't support filler slate for channels using the `LOOP``PlaybackMode`.\n*Required*: No\n*Type*: [SlateSource](./aws-properties-mediatailor-channel-slatesource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-fillerslate", "UpdateType": "Mutable", "Required": false, "Type": "SlateSource" }, "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe name of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-channelname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tier": { "MarkdownDocumentation": "`Tier`\n\nThe tier for this channel. STANDARD tier channels can contain live programs.\n*Required*: No\n*Type*: String\n*Allowed values*: `BASIC | STANDARD...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "BASIC", "STANDARD" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-tier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Audiences": { "MarkdownDocumentation": "`Audiences`\n\nThe list of audiences defined in channel.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-audiences", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Outputs": { "MarkdownDocumentation": "`Outputs`\n\nThe channel's output properties.\n*Required*: Yes\n*Type*: Array of [RequestOutputItem](./aws-properties-mediatailor-channel-requestoutputitem.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-outputs", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "RequestOutputItem", "DuplicatesAllowed": true }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe log configuration.\n*Required*: No\n*Type*: [LogConfigurationForChannel](./aws-properties-mediatailor-channel-logconfigurationforchannel.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogConfigurationForChannel" }, "PlaybackMode": { "MarkdownDocumentation": "`PlaybackMode`\n\nThe type of playback mode for this channel.\n`LINEAR` - Programs play back-to-back only once.\n`LOOP` - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LOOP | LINEAR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOOP", "LINEAR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-playbackmode", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediatailor-channel-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "TimeShiftConfiguration": { "MarkdownDocumentation": "`TimeShiftConfiguration`\n\nThe configuration for time-shifted viewing.\n*Required*: No\n*Type*: [TimeShiftConfiguration](./aws-properties-mediatailor-channel-timeshiftconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-timeshiftconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TimeShiftConfiguration" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#Arn-fn::getatt" } } }, "AWS::MediaTailor::ChannelPolicy": { "MarkdownDocumentation": "`AWS::MediaTailor::ChannelPolicy`\n\nSpecifies an IAM policy for the channel. IAM policies are used to control access to your channel.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe IAM policy for the channel. IAM policies are used to control access to your channel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html#cfn-mediatailor-channelpolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe name of the channel associated with this Channel Policy.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html#cfn-mediatailor-channelpolicy-channelname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::MediaTailor::LiveSource": { "MarkdownDocumentation": "`AWS::MediaTailor::LiveSource`\n\nLive source configuration parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html", "Properties": { "LiveSourceName": { "MarkdownDocumentation": "`LiveSourceName`\n\nThe name that's used to refer to a live 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-livesourcename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceLocationName": { "MarkdownDocumentation": "`SourceLocationName`\n\nThe name of the source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-sourcelocationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HttpPackageConfigurations": { "MarkdownDocumentation": "`HttpPackageConfigurations`\n\nThe HTTP package configurations for the live source.\n*Required*: Yes\n*Type*: Array of [HttpPackageConfiguration](./aws-properties-mediatailor-livesource-httppackageconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-httppackageconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HttpPackageConfiguration", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediatailor-livesource-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#Arn-fn::getatt" } } }, "AWS::MediaTailor::PlaybackConfiguration": { "MarkdownDocumentation": "`AWS::MediaTailor::PlaybackConfiguration`\n\nAdds a new playback configuration to AWS Elemental MediaTailor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html", "Properties": { "Bumper": { "MarkdownDocumentation": "`Bumper`\n\nThe configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).\n*Required*: No\n*Type*: [Bumper](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-bumper", "UpdateType": "Mutable", "Required": false, "Type": "Bumper" }, "DashConfiguration": { "MarkdownDocumentation": "`DashConfiguration`\n\nThe configuration for a DASH source.\n*Required*: No\n*Type*: [DashConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DashConfiguration" }, "InsertionMode": { "MarkdownDocumentation": "`InsertionMode`\n\nThe setting that controls whether players can use stitched or guided ad insertion. The default, `STITCHED_ONLY`, forces all player sessions to use stitched (server-side) ad insertion. Choosing `PLAYER_SELECT` allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.\n*Required*: No\n*Type*: String\n*Allowed values*: `STITCHED_ONLY | PLAYER_SELE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "STITCHED_ONLY", "PLAYER_SELECT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-insertionmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CdnConfiguration": { "MarkdownDocumentation": "`CdnConfiguration`\n\nThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.\n*Required*: No\n*Type*: [CdnConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CdnConfiguration" }, "ManifestProcessingRules": { "MarkdownDocumentation": "`ManifestProcessingRules`\n\nThe configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.\n*Required*: No\n*Type*: [ManifestProcessingRules](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-manifestprocessingrules", "UpdateType": "Mutable", "Required": false, "Type": "ManifestProcessingRules" }, "PersonalizationThresholdSeconds": { "MarkdownDocumentation": "`PersonalizationThresholdSeconds`\n\nDefines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to *ad replacement* in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see [Ad Behavior in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-personalizationthresholdseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "LivePreRollConfiguration": { "MarkdownDocumentation": "`LivePreRollConfiguration`\n\nThe configuration for pre-roll ad insertion.\n*Required*: No\n*Type*: [LivePreRollConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LivePreRollConfiguration" }, "HlsConfiguration": { "MarkdownDocumentation": "`HlsConfiguration`\n\nThe configuration for HLS content.\n*Required*: No\n*Type*: [HlsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-hlsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "HlsConfiguration" }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nDefines where AWS Elemental MediaTailor sends logs for the playback configuration.\n*Required*: No\n*Type*: [LogConfiguration](./aws-properties-mediatailor-playbackconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogConfiguration" }, "VideoContentSourceUrl": { "MarkdownDocumentation": "`VideoContentSourceUrl`\n\nThe URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-videocontentsourceurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AdDecisionServerConfiguration": { "MarkdownDocumentation": "`AdDecisionServerConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [AdDecisionServerConfiguration](./aws-properties-mediatailor-playbackconfiguration-addecisionserverconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AdDecisionServerConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe identifier for the playback configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TranscodeProfileName": { "MarkdownDocumentation": "`TranscodeProfileName`\n\nThe name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-transcodeprofilename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfigurationAliases": { "MarkdownDocumentation": "`ConfigurationAliases`\n\nThe 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*: Object\n*Pattern*: `player_params\\.\\w+\\Z`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-configurationaliases", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "Json" }, "AdDecisionServerUrl": { "MarkdownDocumentation": "`AdDecisionServerUrl`\n\nThe URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverurl", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AdConditioningConfiguration": { "MarkdownDocumentation": "`AdConditioningConfiguration`\n\nThe setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.\n*Required*: No\n*Type*: [AdConditioningConfiguration](./aws-properties-mediatailor-playbackconfiguration-adconditioningconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-adconditioningconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AdConditioningConfiguration" }, "SlateAdUrl": { "MarkdownDocumentation": "`SlateAdUrl`\n\nThe URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-slateadurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailSuppression": { "MarkdownDocumentation": "`AvailSuppression`\n\nThe configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).\n*Required*: No\n*Type*: [AvailSuppression](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-availsuppression", "UpdateType": "Mutable", "Required": false, "Type": "AvailSuppression" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediatailor-playbackconfiguration-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "HlsConfiguration.ManifestEndpointPrefix": { "PrimitiveType": "String", "MarkdownDocumentation": "`HlsConfiguration.ManifestEndpointPrefix`\n\nThe URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#HlsConfiguration.ManifestEndpointPrefix-fn::getatt" }, "SessionInitializationEndpointPrefix": { "PrimitiveType": "String", "MarkdownDocumentation": "`SessionInitializationEndpointPrefix`\n\nThe URL that the player uses to initialize a session that uses client-side reporting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#SessionInitializationEndpointPrefix-fn::getatt" }, "DashConfiguration.ManifestEndpointPrefix": { "PrimitiveType": "String", "MarkdownDocumentation": "`DashConfiguration.ManifestEndpointPrefix`\n\nThe URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#DashConfiguration.ManifestEndpointPrefix-fn::getatt" }, "PlaybackConfigurationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PlaybackConfigurationArn`\n\nThe Amazon Resource Name (ARN) for the playback configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#PlaybackConfigurationArn-fn::getatt" }, "PlaybackEndpointPrefix": { "PrimitiveType": "String", "MarkdownDocumentation": "`PlaybackEndpointPrefix`\n\nThe URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#PlaybackEndpointPrefix-fn::getatt" } } }, "AWS::MediaTailor::SourceLocation": { "MarkdownDocumentation": "`AWS::MediaTailor::SourceLocation`\n\nA source location is a container for sources. For more information about source locations, see [Working with source locations](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) in the *MediaTailor User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html", "Properties": { "SourceLocationName": { "MarkdownDocumentation": "`SourceLocationName`\n\nThe name of the source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-sourcelocationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DefaultSegmentDeliveryConfiguration": { "MarkdownDocumentation": "`DefaultSegmentDeliveryConfiguration`\n\nThe default segment delivery configuration.\n*Required*: No\n*Type*: [DefaultSegmentDeliveryConfiguration](./aws-properties-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSegmentDeliveryConfiguration" }, "SegmentDeliveryConfigurations": { "MarkdownDocumentation": "`SegmentDeliveryConfigurations`\n\nThe segment delivery configurations for the source location.\n*Required*: No\n*Type*: Array of [SegmentDeliveryConfiguration](./aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SegmentDeliveryConfiguration", "DuplicatesAllowed": true }, "HttpConfiguration": { "MarkdownDocumentation": "`HttpConfiguration`\n\nThe HTTP configuration for the source location.\n*Required*: Yes\n*Type*: [HttpConfiguration](./aws-properties-mediatailor-sourcelocation-httpconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-httpconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "HttpConfiguration" }, "AccessConfiguration": { "MarkdownDocumentation": "`AccessConfiguration`\n\nThe access configuration for the source location.\n*Required*: No\n*Type*: [AccessConfiguration](./aws-properties-mediatailor-sourcelocation-accessconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-accessconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AccessConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediatailor-sourcelocation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#Arn-fn::getatt" } } }, "AWS::MediaTailor::VodSource": { "MarkdownDocumentation": "`AWS::MediaTailor::VodSource`\n\nThe VOD source configuration parameters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html", "Properties": { "VodSourceName": { "MarkdownDocumentation": "`VodSourceName`\n\nThe name of the VOD 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-vodsourcename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceLocationName": { "MarkdownDocumentation": "`SourceLocationName`\n\nThe name of the source location that the VOD source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-sourcelocationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HttpPackageConfigurations": { "MarkdownDocumentation": "`HttpPackageConfigurations`\n\nThe HTTP package configurations for the VOD source.\n*Required*: Yes\n*Type*: Array of [HttpPackageConfiguration](./aws-properties-mediatailor-vodsource-httppackageconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-httppackageconfigurations", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "HttpPackageConfiguration", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-mediatailor-vodsource-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#Arn-fn::getatt" } } }, "AWS::MemoryDB::ACL": { "MarkdownDocumentation": "`AWS::MemoryDB::ACL`\n\nSpecifies an Access Control List. For more information, see [Authenticating users with Access\nContol Lists (ACLs)](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html", "Properties": { "ACLName": { "MarkdownDocumentation": "`ACLName`\n\nThe name of the Access Control List.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\\\-]*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html#cfn-memorydb-acl-aclname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UserNames": { "MarkdownDocumentation": "`UserNames`\n\nThe list of users that belong to the Access Control List.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html#cfn-memorydb-acl-usernames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-memorydb-acl-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html#cfn-memorydb-acl-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nIndicates ACL status.\n*Valid values*: `creating` | `active` |\n`modifying` | `deleting`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html#Status-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the Access Control List,\nsuch as `arn:aws:memorydb:us-east-1:123456789012:acl/my-acl`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html#Arn-fn::getatt" } } }, "AWS::MemoryDB::Cluster": { "MarkdownDocumentation": "`AWS::MemoryDB::Cluster`\n\nSpecifies a cluster. All nodes in the cluster run the same\nprotocol-compliant engine software.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html", "Properties": { "NumReplicasPerShard": { "MarkdownDocumentation": "`NumReplicasPerShard`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numreplicaspershard", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FinalSnapshotName": { "MarkdownDocumentation": "`FinalSnapshotName`\n\nThe user-supplied name of a final cluster snapshot. This is the unique\nname that identifies the snapshot. MemoryDB creates the snapshot, and then\ndeletes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-finalsnapshotname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ParameterGroupName": { "MarkdownDocumentation": "`ParameterGroupName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-parametergroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnapshotArns": { "MarkdownDocumentation": "`SnapshotArns`\n\nA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files\nstored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotarns", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port used by the cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-port", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ACLName": { "MarkdownDocumentation": "`ACLName`\n\nThe name of the Access Control List to associate with the cluster.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-aclname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SnapshotName": { "MarkdownDocumentation": "`SnapshotName`\n\nThe name of a snapshot from which to restore data into the new cluster.\nThe snapshot status changes to restoring while the new cluster is being\ncreated.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NumShards": { "MarkdownDocumentation": "`NumShards`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numshards", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TLSEnabled": { "MarkdownDocumentation": "`TLSEnabled`\n\nA flag to indicate if In-transit encryption is enabled.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tlsenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nThe IP address type for the cluster. Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.\n*Required*: No\n*Type*: String\n*Allowed values*: `ipv4 | ipv6 | dual_stack...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6", "dual_stack" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-networktype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\-]*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clustername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SnsTopicArn": { "MarkdownDocumentation": "`SnsTopicArn`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic,\nsuch as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe name of the engine 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engine", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-memorydb-cluster-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "MultiRegionClusterName": { "MarkdownDocumentation": "`MultiRegionClusterName`\n\nThe name of the multi-Region cluster that this cluster belongs 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-multiregionclustername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SnsTopicStatus": { "MarkdownDocumentation": "`SnsTopicStatus`\n\nThe SNS topic must be in Active status to receive notifications.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetGroupName": { "MarkdownDocumentation": "`SubnetGroupName`\n\nThe name of the subnet group used by 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-subnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AutoMinorVersionUpgrade": { "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nWhen set to true, the cluster will automatically receive minor engine\nversion 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-autominorversionupgrade", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of security group names to associate with this cluster.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ClusterEndpoint": { "MarkdownDocumentation": "`ClusterEndpoint`\n\nThe cluster's configuration endpoint.\n*Required*: No\n*Type*: [Endpoint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clusterendpoint", "UpdateType": "Mutable", "Required": false, "Type": "Endpoint" }, "SnapshotWindow": { "MarkdownDocumentation": "`SnapshotWindow`\n\nThe daily time range (in UTC) during which MemoryDB begins taking a daily\nsnapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotwindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnapshotRetentionLimit": { "MarkdownDocumentation": "`SnapshotRetentionLimit`\n\nThe number of days for which MemoryDB retains automatic snapshots before\ndeleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was\ntaken today is retained for 5 days before being deleted.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotretentionlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DataTiering": { "MarkdownDocumentation": "`DataTiering`\n\nEnables data tiering. Data tiering is only supported for clusters using the r6gd node type.\nThis parameter must be set 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*Allowed values*: `true | false...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "true", "false" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-datatiering", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NodeType": { "MarkdownDocumentation": "`NodeType`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-nodetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IpDiscovery": { "MarkdownDocumentation": "`IpDiscovery`\n\nThe mechanism that the cluster uses to discover IP addresses. Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.\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)", "RefReturnValue": "", "AllowedValues": [ "ipv4", "ipv6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-ipdiscovery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaintenanceWindow": { "MarkdownDocumentation": "`MaintenanceWindow`\n\nSpecifies the weekly time range during which maintenance on the cluster\nis performed. It is specified as a range in the format `ddd:hh24:mi-ddd:hh24:mi`\n(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-maintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the cluster. For example, 'available', 'updating' or 'creating'.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#Status-fn::getatt" }, "ClusterEndpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterEndpoint.Address`\n\nThe address of the cluster's configuration endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#ClusterEndpoint.Address-fn::getatt" }, "ClusterEndpoint.Port": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ClusterEndpoint.Port`\n\nThe port used by the cluster configuration endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#ClusterEndpoint.Port-fn::getatt" }, "ParameterGroupStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ParameterGroupStatus`\n\nThe status of the parameter group used by the cluster, for example\n`active` or `applying`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#ParameterGroupStatus-fn::getatt" }, "ARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ARN`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the cluster,\nsuch as `arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#ARN-fn::getatt" } } }, "AWS::MemoryDB::MultiRegionCluster": { "MarkdownDocumentation": "`AWS::MemoryDB::MultiRegionCluster`\n\nRepresents a multi-Region cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html", "Properties": { "MultiRegionParameterGroupName": { "MarkdownDocumentation": "`MultiRegionParameterGroupName`\n\nThe name of the multi-Region parameter group associated with 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-multiregionparametergroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the multi-Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe version of the engine used by the multi-Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-engineversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MultiRegionClusterNameSuffix": { "MarkdownDocumentation": "`MultiRegionClusterNameSuffix`\n\nA suffix to be added to the Multi-Region cluster name. Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with \"virxk\", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\-]*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-multiregionclusternamesuffix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TLSEnabled": { "MarkdownDocumentation": "`TLSEnabled`\n\nIndiciates if the multi-Region cluster is TLS enabled.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-tlsenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "NodeType": { "MarkdownDocumentation": "`NodeType`\n\nThe node type used by the multi-Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-nodetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "UpdateStrategy": { "MarkdownDocumentation": "`UpdateStrategy`\n\nThe strategy to use for the update operation. Supported values are \"coordinated\" or \"uncoordinated\".\n*Required*: No\n*Type*: String\n*Allowed values*: `COORDINATED | UNCOORDINATED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "COORDINATED", "UNCOORDINATED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-updatestrategy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe name of the engine used by the multi-Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-engine", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to be applied to the multi-Region cluster.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-memorydb-multiregioncluster-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "NumShards": { "MarkdownDocumentation": "`NumShards`\n\nThe number of shards in the multi-Region 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-numshards", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the multi-Region cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#Status-fn::getatt" }, "ARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ARN`\n\nThe Amazon Resource Name (ARN) of the multi-Region cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#ARN-fn::getatt" }, "MultiRegionClusterName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MultiRegionClusterName`\n\nThe name of the multi-Region cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#MultiRegionClusterName-fn::getatt" } } }, "AWS::MemoryDB::ParameterGroup": { "MarkdownDocumentation": "`AWS::MemoryDB::ParameterGroup`\n\nSpecifies a new MemoryDB parameter group. A parameter group is a collection of\nparameters and their values that are applied to all of the nodes in any cluster. For more information, see [Configuring engine parameters using\nparameter groups](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nReturns the detailed parameter list for the parameter group.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-parameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "ParameterGroupName": { "MarkdownDocumentation": "`ParameterGroupName`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-parametergroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Family": { "MarkdownDocumentation": "`Family`\n\nThe name of the parameter group family that this parameter group is compatible 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-family", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-memorydb-parametergroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ARN`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the parameter group,\nsuch as `arn:aws:memorydb:us-east-1:123456789012:parametergroup/my-parameter-group`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#ARN-fn::getatt" } } }, "AWS::MemoryDB::SubnetGroup": { "MarkdownDocumentation": "`AWS::MemoryDB::SubnetGroup`\n\nSpecifies a subnet group. A subnet group is a collection of subnets (typically private)\nthat you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC,\nyou must specify a subnet group. MemoryDB uses that subnet group to choose a\nsubnet and IP addresses within that subnet to associate with your nodes. For more\ninformation, see [Subnets and subnet\ngroups](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the subnet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetGroupName": { "MarkdownDocumentation": "`SubnetGroupName`\n\nThe name of the subnet group to be used for the cluster.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\-]*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of Amazon VPC subnet IDs for the subnet group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-memorydb-subnetgroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "SupportedNetworkTypes": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`SupportedNetworkTypes`\n\nThe network types supported by this subnet. Returns an array of strings that can include 'ipv4', 'ipv6', or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#SupportedNetworkTypes-fn::getatt" }, "ARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`ARN`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the subnet group,\nsuch as `arn:aws:memorydb:us-east-1:123456789012:subnetgroup/my-subnet-group`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#ARN-fn::getatt" } } }, "AWS::MemoryDB::User": { "MarkdownDocumentation": "`AWS::MemoryDB::User`\n\nSpecifies a MemoryDB user. For more information, see [Authenticating\nusers with Access Contol Lists (ACLs)](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html", "Properties": { "AuthenticationMode": { "MarkdownDocumentation": "`AuthenticationMode`\n\nDenotes whether the user requires a password to authenticate.\n**Example:**\n```\nmynewdbuser:\n Type: AWS::MemoryDB::User\n Properties: \n AccessString: on ~* &* +@all\n AuthenticationMode: \n Passwords: '1234567890123456'\n Type: password\n UserName: mynewdbuser\n \n AuthenticationMode:\n {\n \"Passwords\": [\"1234567890123456\"],\n \"Type\": \"Password\"\n }\n```\n*Required*: No\n*Type*: [AuthenticationMode](./aws-properties-memorydb-user-authenticationmode.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#cfn-memorydb-user-authenticationmode", "UpdateType": "Mutable", "Required": false, "Type": "AuthenticationMode" }, "UserName": { "MarkdownDocumentation": "`UserName`\n\nThe name of the user.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\\\-]*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#cfn-memorydb-user-username", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccessString": { "MarkdownDocumentation": "`AccessString`\n\nAccess permissions string used for this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#cfn-memorydb-user-accessstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-memorydb-user-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#cfn-memorydb-user-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nIndicates the user status.\n*Valid values*: `active` | `modifying` |\n`deleting`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#Status-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the user,\nsuch as `arn:aws:memorydb:us-east-1:123456789012:user/user1`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#Arn-fn::getatt" } } }, "AWS::Neptune::DBCluster": { "MarkdownDocumentation": "`AWS::Neptune::DBCluster`\n\nThe `AWS::Neptune::DBCluster` resource creates an Amazon Neptune DB cluster.\nNeptune is a fully managed graph database.\n###### Note\nCurrently, you can create this resource only in AWS Regions in which Amazon Neptune is\nsupported.\nIf no `DeletionPolicy` is set for `AWS::Neptune::DBCluster`\nresources, the default deletion behavior is that the entire volume will be deleted without a snapshot.\nTo retain a backup of the volume, the `DeletionPolicy` should be set to `Snapshot`.\nFor more information about how CloudFormation deletes resources,\nsee [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\nYou can use `AWS::Neptune::DBCluster.DeletionProtection` to help guard against\nunintended deletion of your DB cluster.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html", "Properties": { "StorageEncrypted": { "MarkdownDocumentation": "`StorageEncrypted`\n\nIndicates whether the DB cluster is encrypted.\nIf you specify the `KmsKeyId` property, then you must enable encryption and set this property to\n`true`.\nIf you enable the `StorageEncrypted` property but don't specify the `KmsKeyId` property, then the\ndefault KMS key is used. If you specify the `KmsKeyId` property, then that KMS key is used to encrypt the\ndatabase instances in the DB cluster.\nIf you specify the `SourceDBClusterIdentifier` property, and don't specify this property or disable it, the\nvalue is inherited from the source DB cluster. If the source DB cluster is encrypted, the `KmsKeyId` property from\nthe source cluster is used.\nIf you specify the `DBSnapshotIdentifier` and don't specify this property or disable it, the value is\ninherited from the snapshot and the specified `KmsKeyId` property from the snapshot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-storageencrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "RestoreToTime": { "MarkdownDocumentation": "`RestoreToTime`\n\nCreates a new DB cluster from a DB snapshot or DB cluster snapshot.\nIf a DB snapshot is specified, the target DB cluster is created from the source DB\nsnapshot with a default configuration and default security group.\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB\ncluster restore point with the same configuration as the original source DB cluster, except\nthat the new DB cluster is created with the default 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-restoretotime", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AssociatedRoles": { "MarkdownDocumentation": "`AssociatedRoles`\n\nProvides a list of the Amazon Identity and Access Management (IAM) roles that are associated\nwith the DB cluster. IAM roles that are associated with a DB cluster grant permission for the\nDB cluster to access other Amazon services on your behalf.\n*Required*: No\n*Type*: Array of [DBClusterRole](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-associatedroles", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DBClusterRole", "DuplicatesAllowed": false }, "SnapshotIdentifier": { "MarkdownDocumentation": "`SnapshotIdentifier`\n\nSpecifies the identifier for a DB cluster snapshot. Must match the identifier\nof an existing snapshot.\nAfter you restore a DB cluster using a `SnapshotIdentifier`,\nyou must specify the same `SnapshotIdentifier` for any future\nupdates to the DB cluster. When you specify this property for an update, the DB\ncluster is not restored from the snapshot again, and the data in the database is not\nchanged.\nHowever, if you don't specify the `SnapshotIdentifier`, an empty\nDB cluster is created, and the original DB cluster is deleted. If you specify a\nproperty that is different from the previous snapshot restore property, the DB\ncluster is restored from the snapshot specified by the `SnapshotIdentifier`,\nand the original DB cluster is deleted.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-snapshotidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DBClusterIdentifier": { "MarkdownDocumentation": "`DBClusterIdentifier`\n\nContains a user-supplied DB cluster identifier. This identifier is the unique key that\nidentifies a DB cluster.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PreferredBackupWindow": { "MarkdownDocumentation": "`PreferredBackupWindow`\n\nSpecifies the daily time range during which automated backups are created if automated\nbackups are enabled, as determined by the `BackupRetentionPeriod`.\nAn update may require some interruption.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredbackupwindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DBPort": { "MarkdownDocumentation": "`DBPort`\n\nThe port number on which the DB instances in the DB cluster accept connections.\nIf not specified, the default port used is `8182`.\n###### Note\nThe `Port` property will soon be deprecated. Please update existing templates to use\nthe new `DBPort` property that has the same functionality.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nProvides a list of VPC security groups that the DB cluster belongs to.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "CopyTagsToSnapshot": { "MarkdownDocumentation": "`CopyTagsToSnapshot`\n\n*If set to `true`, tags are copied to any snapshot of\nthe DB cluster that 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-copytagstosnapshot", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RestoreType": { "MarkdownDocumentation": "`RestoreType`\n\nCreates a new DB cluster from a DB snapshot or DB cluster snapshot.\nIf a DB snapshot is specified, the target DB cluster is created from the source DB\nsnapshot with a default configuration and default security group.\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB\ncluster restore point with the same configuration as the original source DB cluster, except\nthat the new DB cluster is created with the default 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-restoretype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to this cluster.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-neptune-dbcluster-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nIndicates the database 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster,\nsuch as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`. If you enable the\n`StorageEncrypted` property but don't specify this property, the default KMS key is used. If you specify\nthis property, you must set the `StorageEncrypted` property to `true`.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZones": { "MarkdownDocumentation": "`AvailabilityZones`\n\nProvides the list of EC2 Availability Zones that instances in the DB cluster can be\ncreated in.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-availabilityzones", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "ServerlessScalingConfiguration": { "MarkdownDocumentation": "`ServerlessScalingConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [ServerlessScalingConfiguration](./aws-properties-neptune-dbcluster-serverlessscalingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-serverlessscalingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ServerlessScalingConfiguration" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nSpecifies the weekly time range during which system maintenance can occur, in Universal\nCoordinated Time (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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredmaintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamAuthEnabled": { "MarkdownDocumentation": "`IamAuthEnabled`\n\nTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts\nis enabled, and 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-iamauthenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DBSubnetGroupName": { "MarkdownDocumentation": "`DBSubnetGroupName`\n\nSpecifies information on the subnet group associated with the DB cluster, including the\nname, description, and subnets in the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbsubnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeletionProtection": { "MarkdownDocumentation": "`DeletionProtection`\n\nIndicates whether or not the DB cluster has deletion protection\nenabled. The 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-deletionprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "UseLatestRestorableTime": { "MarkdownDocumentation": "`UseLatestRestorableTime`\n\nCreates a new DB cluster from a DB snapshot or DB cluster snapshot.\nIf a DB snapshot is specified, the target DB cluster is created from the source DB\nsnapshot with a default configuration and default security group.\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB\ncluster restore point with the same configuration as the original source DB cluster, except\nthat the new DB cluster is created with the default security group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-uselatestrestorabletime", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "SourceDBClusterIdentifier": { "MarkdownDocumentation": "`SourceDBClusterIdentifier`\n\nCreates a new DB cluster from a DB snapshot or DB cluster snapshot.\nIf a DB snapshot is specified, the target DB cluster is created from the source DB\nsnapshot with a default configuration and default security group.\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB\ncluster restore point with the same configuration as the original source DB cluster, except\nthat the new DB cluster is created with the default 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-sourcedbclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DBClusterParameterGroupName": { "MarkdownDocumentation": "`DBClusterParameterGroupName`\n\nProvides the name of the DB cluster parameter group.\nAn update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance)\nin the Amazon Neptune User Guide for more information.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusterparametergroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BackupRetentionPeriod": { "MarkdownDocumentation": "`BackupRetentionPeriod`\n\nSpecifies the number of days for which automatic DB snapshots are retained.\nAn update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-backupretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DBInstanceParameterGroupName": { "MarkdownDocumentation": "`DBInstanceParameterGroupName`\n\nThe name of the DB parameter group to apply to all instances of the DB cluster.\nUsed only in case of a major engine version upgrade request\nNote that when you apply a parameter group using `DBInstanceParameterGroupName`,\nparameter changes are applied immediately, not during the next maintenance window.\n###### Constraints\n* The DB parameter group must be in the same DB parameter group family\n as the target DB cluster version.\n* The `DBInstanceParameterGroupName` parameter is only\n valid for major engine version upgrades.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbinstanceparametergroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableCloudwatchLogsExports": { "MarkdownDocumentation": "`EnableCloudwatchLogsExports`\n\nSpecifies a list of log types that are enabled for export to CloudWatch Logs.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-enablecloudwatchlogsexports", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } }, "Attributes": { "ClusterResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterResourceId`\n\nThe resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`.\nThe cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#ClusterResourceId-fn::getatt" }, "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe connection endpoint for the DB cluster. For example:\n`mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#Endpoint-fn::getatt" }, "Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`Port`\n\nThe port number on which the DB instances in the DB cluster accept connections.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#Port-fn::getatt" }, "ReadEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReadEndpoint`\n\nThe reader endpoint for the DB cluster. For example:\n`mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#ReadEndpoint-fn::getatt" } } }, "AWS::Neptune::DBClusterParameterGroup": { "MarkdownDocumentation": "`AWS::Neptune::DBClusterParameterGroup`\n\nThe `AWS::Neptune::DBClusterParameterGroup` resource creates a new Amazon Neptune DB cluster parameter group.\n###### Note\nApplying a parameter group to a DB cluster might require\ninstances to reboot, resulting in a database outage while the instances reboot.\n###### Note\nIf you provide a custom `DBClusterParameterGroup` that you associate\nwith the `DBCluster`, it is best to specify an `EngineVersion`\nproperty in the `DBCluster`. That `EngineVersion` needs to\nbe compatible with the value of the `Family` property in the\n`DBClusterParameterGroup`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nProvides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe 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\nparameters 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-parameters", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Family": { "MarkdownDocumentation": "`Family`\n\nMust 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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-family", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that you want to attach to this parameter group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-neptune-dbclusterparametergroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nProvides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Neptune::DBInstance": { "MarkdownDocumentation": "`AWS::Neptune::DBInstance`\n\nThe `AWS::Neptune::DBInstance` type creates an Amazon Neptune DB instance.\n**Updating DB Instances**\nYou can set a deletion policy for your DB instance to control how CloudFormation handles the\ninstance when the stack is deleted. For Neptune DB instances, you can choose to\n*retain* the instance, to *delete* the\ninstance, or to *create a snapshot* of the instance. The default\nCloudFormation behavior depends on the `DBClusterIdentifier` property:\n* For `AWS::Neptune::DBInstance` resources that don't specify the\n `DBClusterIdentifier` property, CloudFormation saves a snapshot of the DB\n instance.\n* For `AWS::Neptune::DBInstance` resources that do specify the\n `DBClusterIdentifier` property, CloudFormation deletes the DB\n instance.\n**Deleting DB Instances**\n###### Important\nIf a DB instance is deleted or replaced during an update, CloudFormation deletes all automated\nsnapshots. However, it retains manual DB snapshots. During an update that requires\nreplacement, you can apply a stack policy to prevent DB instances from being replaced.\nWhen properties labeled *Update requires: Replacement* are updated,\nCloudFormation first creates a\nreplacement DB instance, changes references from other dependent resources to point to\nthe replacement DB instance, and finally deletes the old DB instance.\n###### Important\nWe highly recommend that you take a snapshot of the database before updating the\nstack. If you don't, you lose the data when CloudFormation replaces your DB instance. To\npreserve your data, perform the following procedure:\n1. Deactivate any applications that are using the DB instance so that there's\n no activity on the DB instance.\n2. Create a snapshot of the DB instance.\n3. If you want to restore your instance using a DB snapshot, modify the updated\n template with your DB instance changes and add the\n `DBSnapshotIdentifier` property with the ID of the DB snapshot\n that you want to use.\n4. Update the stack.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html", "Properties": { "DBParameterGroupName": { "MarkdownDocumentation": "`DBParameterGroupName`\n\nThe name of an existing DB parameter group or a reference to an\nAWS::Neptune::DBParameterGroup resource created in the template.\nIf any of the data members of the referenced parameter\ngroup are changed during an update, the DB instance might need to be restarted,\nwhich causes some interruption. If the parameter group contains static parameters,\nwhether they were changed or not, an update triggers a reboot.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbparametergroupname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DBInstanceClass": { "MarkdownDocumentation": "`DBInstanceClass`\n\nContains 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceclass", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AllowMajorVersionUpgrade": { "MarkdownDocumentation": "`AllowMajorVersionUpgrade`\n\nIndicates that major version upgrades are allowed. Changing this\nparameter doesn't result in an outage and the change is asynchronously\napplied as soon as possible. This parameter must be set to true when specifying\na value for the EngineVersion parameter that is a different major version than\nthe DB instance's current version.\n###### Warning\nWhen you change this parameter for an existing DB cluster, CloudFormation will replace your existing DB cluster\nwith a new, empty one that uses the engine version you 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-allowmajorversionupgrade", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DBClusterIdentifier": { "MarkdownDocumentation": "`DBClusterIdentifier`\n\nIf the DB instance is a member of a DB cluster, contains the name of the DB cluster that\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nSpecifies the weekly time range during which system maintenance can occur, in Universal\nCoordinated Time (UTC).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-preferredmaintenancewindow", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "AutoMinorVersionUpgrade": { "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nIndicates that minor version patches are applied automatically.\nWhen updating this property, some interruptions may occur.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-autominorversionupgrade", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "DBSubnetGroupName": { "MarkdownDocumentation": "`DBSubnetGroupName`\n\nA DB subnet group to associate with the DB instance. If you update this value,\nthe new subnet group must be a subnet group in a new virtual private cloud\n(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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsubnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nIndicates whether the DB instance is publicly accessible.\nWhen the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private\ncloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within\nthe same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is\nultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned\nto the DB cluster doesn't permit it.\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a\nprivate IP address.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-publiclyaccessible", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DBInstanceIdentifier": { "MarkdownDocumentation": "`DBInstanceIdentifier`\n\nContains a user-supplied database identifier. This identifier is the unique key that\nidentifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key-value pairs) for this DB instance.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-neptune-dbinstance-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe connection endpoint for the database. For example:\n`mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#Endpoint-fn::getatt" }, "Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`Port`\n\nThe port number on which the database accepts connections. For example:\n`8182`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#Port-fn::getatt" } } }, "AWS::Neptune::DBParameterGroup": { "MarkdownDocumentation": "`AWS::Neptune::DBParameterGroup`\n\n`AWS::Neptune::DBParameterGroup` creates a new DB parameter group.\nThis type can be declared in a template and referenced in the `DBParameterGroupName`\nparameter of `AWS::Neptune::DBInstance`.\n###### Note\nApplying a parameter group to a DB instance might require the\ninstance to reboot, resulting in a database outage for the duration of the reboot.\n###### Note\nIf you provide a custom `DBParameterGroup` that you associate\nwith `DBInstance`, it is best to specify an `EngineVersion`\nproperty in `DBCluster`. That `EngineVersion` needs to\nbe compatible with the value of the `Family` property in the\n`DBParameterGroup`.\nA DB parameter group is initially created with the default parameters for the database\nengine used by the DB instance. To provide custom values for any of the parameters, you must\nmodify the group after creating it using *ModifyDBParameterGroup*. Once\nyou've created a DB parameter group, you need to associate it with your DB instance using\n*ModifyDBInstance*. When you associate a new DB parameter group with a\nrunning DB instance, you need to reboot the DB instance without failover for the new DB\nparameter group and associated settings to take effect.\n###### Important\nAfter you create a DB parameter group, you should wait at least 5 minutes before\ncreating your first DB instance that uses that DB parameter group as the default parameter\ngroup. This allows Amazon Neptune to fully complete the create action before the parameter\ngroup is used as the default for a new DB instance. This is especially important for\nparameters that are critical when creating the default database for a DB instance, such as\nthe character set for the default database defined by the\n`character_set_database` parameter. You can use the *Parameter\nGroups* option of the Amazon Neptune console or the\n*DescribeDBParameters* command to verify that your DB parameter group has\nbeen created or modified.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nProvides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-description", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe 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\nyou have static parameters (whether they were changed or not), it triggers CloudFormation\nto 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-parameters", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Family": { "MarkdownDocumentation": "`Family`\n\nMust 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\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-family", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that you want to attach to this parameter group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-neptune-dbparametergroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nProvides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Neptune::DBSubnetGroup": { "MarkdownDocumentation": "`AWS::Neptune::DBSubnetGroup`\n\nThe `AWS::Neptune::DBSubnetGroup` type creates an Amazon Neptune\nDB subnet group. Subnet groups must contain at least two subnets in two different\nAvailability Zones in the same AWS Region.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html", "Properties": { "DBSubnetGroupName": { "MarkdownDocumentation": "`DBSubnetGroupName`\n\nThe name of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-dbsubnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DBSubnetGroupDescription": { "MarkdownDocumentation": "`DBSubnetGroupDescription`\n\nProvides the description of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-dbsubnetgroupdescription", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe Amazon EC2 subnet IDs for the DB subnet group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that you want to attach to the DB subnet group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-neptune-dbsubnetgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::Neptune::EventSubscription": { "MarkdownDocumentation": "`AWS::Neptune::EventSubscription`\n\nCreates an event notification subscription. This action requires a topic ARN (Amazon\nResource Name) created by either the Neptune console, the SNS console, or the SNS API. To\nobtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The\nARN is displayed in the SNS console.\nYou can specify the type of source (SourceType) you want to be notified of, provide a list\nof Neptune sources (SourceIds) that triggers the events, and provide a list of event\ncategories (EventCategories) for events you want to be notified of. For example, you can\nspecify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories\n= Availability, Backup.\nIf you specify both the SourceType and SourceIds, such as SourceType = db-instance and\nSourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the\nspecified source. If you specify a SourceType but do not specify a SourceIdentifier, you\nreceive notice of the events for that source type for all your Neptune sources. If you do not\nspecify either the SourceType nor the SourceIdentifier, you are notified of events generated\nfrom all Neptune sources belonging to your customer account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html", "Properties": { "SourceType": { "MarkdownDocumentation": "`SourceType`\n\nThe source type for the event notification subscription.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-sourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nA Boolean value indicating if the subscription is enabled. True indicates the subscription\nis 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EventCategories": { "MarkdownDocumentation": "`EventCategories`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-eventcategories", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SnsTopicArn": { "MarkdownDocumentation": "`SnsTopicArn`\n\nThe topic ARN of the event notification subscription.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-snstopicarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SubscriptionName": { "MarkdownDocumentation": "`SubscriptionName`\n\nProperty description not available.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-subscriptionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceIds": { "MarkdownDocumentation": "`SourceIds`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-sourceids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-neptune-eventsubscription-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::NeptuneGraph::Graph": { "MarkdownDocumentation": "`AWS::NeptuneGraph::Graph`\n\nThe `AWS::NeptuneGraph::Graph` resource creates an\nAmazon Neptune Analytics graph. Amazon Neptune Analytics\nis a memory-optimized graph database engine for analytics. For more information, see\n[Amazon Neptune Analytics](https://docs.aws.amazon.com/neptune-analytics/latest/userguide/what-is-neptune-analytics.html).\nYou can use `AWS::NeptuneGraph::Graph.DeletionProtection` to help guard against unintended\ndeletion of your graph.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the GraphId.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html", "Properties": { "PublicConnectivity": { "MarkdownDocumentation": "`PublicConnectivity`\n\nSpecifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\nWhen the graph is publicly available, its domain name system (DNS) endpoint resolves to the public IP address\nfrom the internet. When the graph isn't publicly available, you need to create a `PrivateGraphEndpoint` in a\ngiven VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.\nDefault: If not specified, the default value is false.\n###### Note\nIf enabling public connectivity for the first time, there will be a delay while it 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-publicconnectivity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "GraphName": { "MarkdownDocumentation": "`GraphName`\n\nThe graph name. For example: `my-graph-1`.\nThe name must contain from 1 to 63 letters, numbers, or hyphens, and its\nfirst character must be a letter. It cannot end with a hyphen or contain two\nconsecutive hyphens.\nIf you don't specify a graph name, a unique graph name is generated for you using the prefix `graph-for`,\nfollowed by a combination of `Stack Name` and a `UUID`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-graphname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ReplicaCount": { "MarkdownDocumentation": "`ReplicaCount`\n\nThe number of replicas in other AZs.\nDefault: If not specified, the default value is 1.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-replicacount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ProvisionedMemory": { "MarkdownDocumentation": "`ProvisionedMemory`\n\nThe provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.\nMin = 16\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-provisionedmemory", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "Integer" }, "DeletionProtection": { "MarkdownDocumentation": "`DeletionProtection`\n\nA value that indicates whether the graph has deletion protection enabled.\nThe graph 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-deletionprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VectorSearchConfiguration": { "MarkdownDocumentation": "`VectorSearchConfiguration`\n\nSpecifies the number of dimensions for vector embeddings that will be loaded into the graph.\nThe value is specified as `dimension=`value. Max = 65,535\n*Required*: No\n*Type*: [VectorSearchConfiguration](./aws-properties-neptunegraph-graph-vectorsearchconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-vectorsearchconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "VectorSearchConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAdds metadata tags to the new graph.\nThese tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-neptunegraph-graph-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#Endpoint-fn::getatt" }, "GraphArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GraphArn`\n\nThe ARN of the graph. For example: `arn:aws:neptune-graph:us-east-1:111122223333:graph/g-12a3bcdef4`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#GraphArn-fn::getatt" }, "GraphId": { "PrimitiveType": "String", "MarkdownDocumentation": "`GraphId`\n\nThe ID of the graph. For example: `g-12a3bcdef4`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#GraphId-fn::getatt" } } }, "AWS::NeptuneGraph::PrivateGraphEndpoint": { "MarkdownDocumentation": "`AWS::NeptuneGraph::PrivateGraphEndpoint`\n\nCreate a private graph endpoint to allow private access from to the graph from within\na VPC. You can attach security groups to the private graph endpoint.\n###### Note\nVPC endpoint charges apply.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the PrivateGraphEndpointIdentifier.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-privategraphendpoint.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe VPC in which the private graph endpoint needs 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-privategraphendpoint.html#cfn-neptunegraph-privategraphendpoint-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "GraphIdentifier": { "MarkdownDocumentation": "`GraphIdentifier`\n\nThe unique identifier of the Neptune Analytics graph.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-privategraphendpoint.html#cfn-neptunegraph-privategraphendpoint-graphidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nSecurity groups to be attached to the private graph endpoint..\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-privategraphendpoint.html#cfn-neptunegraph-privategraphendpoint-securitygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nSubnets in which private graph endpoint ENIs are created.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-privategraphendpoint.html#cfn-neptunegraph-privategraphendpoint-subnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "VpcEndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEndpointId`\n\nVPC endpoint that provides a private connection between the Graph and specified VPC. For example:\n`vpce-aabbaabbaabbaabba`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-privategraphendpoint.html#VpcEndpointId-fn::getatt" }, "PrivateGraphEndpointIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`PrivateGraphEndpointIdentifier`\n\nPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an\nunderscore separator. For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is\n`vpc-111122223333aabbc`, the generated PrivateGraphEndpointIdentifier will be\n`g-12a3bcdef4_vpc-111122223333aabbc`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-privategraphendpoint.html#PrivateGraphEndpointIdentifier-fn::getatt" } } }, "AWS::NetworkFirewall::Firewall": { "MarkdownDocumentation": "`AWS::NetworkFirewall::Firewall`\n\nUse the firewall to provide stateful, managed, network firewall and intrusion detection and prevention filtering for your VPCs in Amazon VPC.\nThe firewall defines the configuration settings for an AWS Network Firewall firewall. The settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the firewall. For example:\n`{ \"Ref\": \"arn:aws:network-firewall:us-east-1:012345678901:firewall/myFirewallName\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html", "Properties": { "FirewallPolicyArn": { "MarkdownDocumentation": "`FirewallPolicyArn`\n\nThe Amazon Resource Name (ARN) of the firewall policy.\nThe relationship of firewall to firewall policy is many to one. Each firewall requires\none firewall policy association, and you can use the same firewall policy for multiple\nfirewalls.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallpolicyarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the firewall.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubnetChangeProtection": { "MarkdownDocumentation": "`SubnetChangeProtection`\n\nA setting indicating whether the firewall is protected against changes to the subnet associations.\nUse this setting to protect against\naccidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-subnetchangeprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TransitGatewayId": { "MarkdownDocumentation": "`TransitGatewayId`\n\nThe unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.\n*Required*: No\n*Type*: String\n*Pattern*: `^tgw-[0-9a-z]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-transitgatewayid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneChangeProtection": { "MarkdownDocumentation": "`AvailabilityZoneChangeProtection`\n\nA setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to `TRUE`, you must first disable this protection before adding or removing Availability Zones.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-availabilityzonechangeprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FirewallName": { "MarkdownDocumentation": "`FirewallName`\n\nThe descriptive name of the firewall. You can't change the name of a firewall after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe 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*: No\n*Type*: String\n*Pattern*: `^vpc-[0-9a-f]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeleteProtection": { "MarkdownDocumentation": "`DeleteProtection`\n\nA flag indicating whether it is possible to delete the firewall. A setting of `TRUE` indicates\nthat the firewall is protected against deletion. Use this setting to protect against\naccidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-deleteprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FirewallPolicyChangeProtection": { "MarkdownDocumentation": "`FirewallPolicyChangeProtection`\n\nA setting indicating whether the firewall is protected against a change to the firewall policy association.\nUse this setting to protect against\naccidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallpolicychangeprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AvailabilityZoneMappings": { "MarkdownDocumentation": "`AvailabilityZoneMappings`\n\nThe Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.\n*Required*: No\n*Type*: Array of [AvailabilityZoneMapping](./aws-properties-networkfirewall-firewall-availabilityzonemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-availabilityzonemappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AvailabilityZoneMapping", "DuplicatesAllowed": false }, "EnabledAnalysisTypes": { "MarkdownDocumentation": "`EnabledAnalysisTypes`\n\nAn optional setting indicating the specific traffic analysis types to enable on the firewall.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-enabledanalysistypes", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-networkfirewall-firewall-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "SubnetMappings": { "MarkdownDocumentation": "`SubnetMappings`\n\nThe primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.\nThese subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.\nIn addition to these subnets, you can define other endpoints for the firewall in `VpcEndpointAssociation` resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.\n*Required*: No\n*Type*: Array of [SubnetMapping](./aws-properties-networkfirewall-firewall-subnetmapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-subnetmappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SubnetMapping", "DuplicatesAllowed": false } }, "Attributes": { "FirewallArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FirewallArn`\n\nThe Amazon Resource Name (ARN) of the firewall.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#FirewallArn-fn::getatt" }, "EndpointIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`EndpointIds`\n\nThe unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall. The subnets are not listed in any particular order. For example: `[\"us-west-2c:vpce-111122223333\", \"us-west-2a:vpce-987654321098\", \"us-west-2b:vpce-012345678901\"]`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#EndpointIds-fn::getatt" }, "FirewallId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FirewallId`\n\nThe name of the firewallresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#FirewallId-fn::getatt" }, "TransitGatewayAttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayAttachmentId`\n\nThe unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#TransitGatewayAttachmentId-fn::getatt" } } }, "AWS::NetworkFirewall::FirewallPolicy": { "MarkdownDocumentation": "`AWS::NetworkFirewall::FirewallPolicy`\n\nUse the firewall policy to define the stateless and stateful network traffic filtering behavior for your firewall. You can use one firewall policy for multiple firewalls.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the firewall policy. For example:\n`{ \"Ref\": \"arn:aws:network-firewall:us-east-1:012345678901:firewall-policy/myFirewallPolicyName\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the firewall policy.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FirewallPolicyName": { "MarkdownDocumentation": "`FirewallPolicyName`\n\nThe descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-networkfirewall-firewallpolicy-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "FirewallPolicy": { "MarkdownDocumentation": "`FirewallPolicy`\n\nThe traffic filtering behavior of a firewall policy, defined in a collection of stateless\nand stateful rule groups and other settings.\n*Required*: Yes\n*Type*: [FirewallPolicy](./aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy", "UpdateType": "Mutable", "Required": true, "Type": "FirewallPolicy" } }, "Attributes": { "FirewallPolicyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`FirewallPolicyArn`\n\nThe Amazon Resource Name (ARN) of the firewall policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#FirewallPolicyArn-fn::getatt" }, "FirewallPolicyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`FirewallPolicyId`\n\nThe unique ID of the firewall policy resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#FirewallPolicyId-fn::getatt" } } }, "AWS::NetworkFirewall::LoggingConfiguration": { "MarkdownDocumentation": "`AWS::NetworkFirewall::LoggingConfiguration`\n\nUse the logging configuration to define the destinations and logging options for an firewall.\nYou must change the logging configuration by changing one `LogDestinationConfig` setting at a time in your `LogDestinationConfigs`.\nYou can make only one of the following changes to your logging configuration resource:\n* Create a new log destination object by adding a single\n `LogDestinationConfig` array element to\n `LogDestinationConfigs`.\n* Delete a log destination object by removing a single\n `LogDestinationConfig` array element from\n `LogDestinationConfigs`.\n* Change the `LogDestination` setting in a single\n `LogDestinationConfig` array element.\nYou can't change the `LogDestinationType` or `LogType` in a\n`LogDestinationConfig`. To change these settings, delete the existing\n`LogDestinationConfig` object and create a new one, in two separate modifications.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the firewall that the logging configuration is associated with. For example:\n`{ \"Ref\": \"arn:aws:network-firewall:us-east-1:012345678901:firewall/myFirewallName\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html", "Properties": { "EnableMonitoringDashboard": { "MarkdownDocumentation": "`EnableMonitoringDashboard`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-enablemonitoringdashboard", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FirewallName": { "MarkdownDocumentation": "`FirewallName`\n\nThe name of the firewall that the logging configuration is associated with.\nYou can't change the firewall specification after you create the logging configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FirewallArn": { "MarkdownDocumentation": "`FirewallArn`\n\nThe Amazon Resource Name (ARN) of the firewallthat the logging configuration is associated with.\nYou can't change the firewall specification after you create the logging configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LoggingConfiguration": { "MarkdownDocumentation": "`LoggingConfiguration`\n\nDefines how AWS Network Firewall performs logging for a firewall.\n*Required*: Yes\n*Type*: [LoggingConfiguration](./aws-properties-networkfirewall-loggingconfiguration-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "LoggingConfiguration" } } }, "AWS::NetworkFirewall::RuleGroup": { "MarkdownDocumentation": "`AWS::NetworkFirewall::RuleGroup`\n\nUse the to define a reusable collection of stateless or stateful network traffic filtering rules.\nYou use rule groups in an firewall policy to specify the filtering behavior of an firewall.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the rule group. For example:\n`{ \"Ref\": \"arn:aws:network-firewall:us-east-1:012345678901:stateful-rulegroup/myStatefulRuleGroupName\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nIndicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `STATELESS | STATEFUL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "STATELESS", "STATEFUL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the rule group.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Capacity": { "MarkdownDocumentation": "`Capacity`\n\nThe maximum operating resources that this rule group can use. You can't change a rule group's capacity setting\nafter you create the rule group. When you update a rule group, you are limited to this capacity. When you reference a rule group\nfrom a firewall policy, Network Firewall reserves this capacity for the rule group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-capacity", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" }, "RuleGroupName": { "MarkdownDocumentation": "`RuleGroupName`\n\nThe descriptive name of the rule group. You can't change the name of a rule group after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SummaryConfiguration": { "MarkdownDocumentation": "`SummaryConfiguration`\n\nA complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by `DescribeRuleGroupSummary`.\n* The `RuleOptions` specified in `SummaryConfiguration`\n* Rule metadata organization preferences\n*Required*: No\n*Type*: [SummaryConfiguration](./aws-properties-networkfirewall-rulegroup-summaryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-summaryconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SummaryConfiguration" }, "RuleGroup": { "MarkdownDocumentation": "`RuleGroup`\n\nAn object that defines the rule group rules.\n*Required*: No\n*Type*: [RuleGroup](./aws-properties-networkfirewall-rulegroup-rulegroup.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup", "UpdateType": "Mutable", "Required": false, "Type": "RuleGroup" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-networkfirewall-rulegroup-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "RuleGroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleGroupId`\n\nThe unique ID of the rule group resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#RuleGroupId-fn::getatt" }, "RuleGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleGroupArn`\n\nThe Amazon Resource Name (ARN) of the rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#RuleGroupArn-fn::getatt" } } }, "AWS::NetworkFirewall::TLSInspectionConfiguration": { "MarkdownDocumentation": "`AWS::NetworkFirewall::TLSInspectionConfiguration`\n\nThe object that defines a TLS inspection configuration.\nAWS Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.\nTo use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS\ninspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the *AWS Network Firewall Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the TLS inspection configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TLSInspectionConfigurationName": { "MarkdownDocumentation": "`TLSInspectionConfigurationName`\n\nThe descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfigurationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe key:value pairs to associate with the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkfirewall-tlsinspectionconfiguration-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "TLSInspectionConfiguration": { "MarkdownDocumentation": "`TLSInspectionConfiguration`\n\nThe object that defines a TLS inspection configuration. AWS Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, AWS Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using AWS Certificate Manager, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the *AWS Network Firewall Developer Guide*.\n*Required*: Yes\n*Type*: [TLSInspectionConfiguration](./aws-properties-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "TLSInspectionConfiguration" } }, "Attributes": { "TLSInspectionConfigurationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TLSInspectionConfigurationId`\n\nA unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#TLSInspectionConfigurationId-fn::getatt" }, "TLSInspectionConfigurationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TLSInspectionConfigurationArn`\n\nThe Amazon Resource Name (ARN) of the TLS inspection configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#TLSInspectionConfigurationArn-fn::getatt" } } }, "AWS::NetworkFirewall::VpcEndpointAssociation": { "MarkdownDocumentation": "`AWS::NetworkFirewall::VpcEndpointAssociation`\n\nA VPC endpoint association defines a single subnet to use for a firewall endpoint for a `Firewall`.\nYou can define VPC endpoint associations only in the Availability Zones that already have\na subnet mapping defined in the `Firewall` resource.\n###### Note\nYou can retrieve the list of Availability Zones that are available for use by calling `DescribeFirewallMetadata`.\nTo manage firewall endpoints, first, in the `Firewall` specification, you specify a single VPC and one subnet\nfor each of the Availability Zones where you want to use the firewall. Then you can define additional endpoints as\nVPC endpoint associations.\nYou can use VPC endpoint associations to expand the protections of the firewall as follows:\n* **Protect multiple VPCs with a single firewall** - You can use the firewall to protect other VPCs, either in your account or in accounts where the firewall is shared. You can only specify Availability Zones that already have a firewall endpoint defined in the `Firewall` subnet mappings.\n* **Define multiple firewall endpoints for a VPC in an Availability Zone** - You can create additional firewall endpoints for the VPC that you have defined in the firewall, in any Availability Zone that already has an endpoint defined in the `Firewall` subnet mappings. You can create multiple VPC endpoint associations for any other VPC where you use the firewall.\nYou can use AWS Resource Access Manager to share a `Firewall` that you own with other accounts, which gives them the ability to use the firewall\nto create VPC endpoint associations. For information about sharing a firewall, see `PutResourcePolicy`\nin this guide and see\n[Sharing Network Firewall resources](https://docs.aws.amazon.com/network-firewall/latest/developerguide/sharing.html) in the *AWS Network Firewall Developer Guide*.\nThe status of the VPC endpoint association, which indicates whether it's ready to filter network traffic,\nis provided in the corresponding VPC endpoint association status. You can retrieve both\nthe association and its status by calling `DescribeVpcEndpointAssociation`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the firewall. For example:\n`{ \"Ref\": \"arn:aws:network-firewall:us-east-1:123456789012:vpc-endpoint-association/UUID\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html", "Properties": { "SubnetMapping": { "MarkdownDocumentation": "`SubnetMapping`\n\nThe ID for a subnet that's used in an association with a firewall. This is used in\n`CreateFirewall`, `AssociateSubnets`, and `CreateVpcEndpointAssociation`. AWS Network Firewall\ncreates an instance of the associated firewall in each subnet that you specify, to filter\ntraffic in the subnet's Availability Zone.\n*Required*: Yes\n*Type*: [SubnetMapping](./aws-properties-networkfirewall-vpcendpointassociation-subnetmapping.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html#cfn-networkfirewall-vpcendpointassociation-subnetmapping", "UpdateType": "Immutable", "Required": true, "Type": "SubnetMapping" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the VPC endpoint association.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html#cfn-networkfirewall-vpcendpointassociation-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe unique identifier of the VPC for the endpoint association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^vpc-[0-9a-f]+$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html#cfn-networkfirewall-vpcendpointassociation-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FirewallArn": { "MarkdownDocumentation": "`FirewallArn`\n\nThe Amazon Resource Name (ARN) of the firewall.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(arn:aws.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html#cfn-networkfirewall-vpcendpointassociation-firewallarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe key:value pairs to associate with the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkfirewall-vpcendpointassociation-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html#cfn-networkfirewall-vpcendpointassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "VpcEndpointAssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEndpointAssociationId`\n\nThe unique identifier of the VPC endpoint association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html#VpcEndpointAssociationId-fn::getatt" }, "EndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointId`\n\nThe unique ID of the firewall endpoint for the subnet that you attached to the firewall.For example: \"vpce-111122223333\"\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html#EndpointId-fn::getatt" }, "VpcEndpointAssociationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEndpointAssociationArn`\n\nThe Amazon Resource Name (ARN) of a VPC endpoint association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-vpcendpointassociation.html#VpcEndpointAssociationArn-fn::getatt" } } }, "AWS::NetworkManager::ConnectAttachment": { "MarkdownDocumentation": "`AWS::NetworkManager::ConnectAttachment`\n\nCreates a core network Connect attachment from a specified core network attachment.\nA core network Connect attachment is a GRE-based tunnel attachment that you can use to\nestablish a connection between a core network and an appliance. A core network Connect\nattachment uses an existing VPC attachment as the underlying transport mechanism.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `AttachmentId`. For example, `{ \"Ref: \"attachment-02767e74104a33690\" }`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html", "Properties": { "ProposedSegmentChange": { "MarkdownDocumentation": "`ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n*Required*: No\n*Type*: [ProposedSegmentChange](./aws-properties-networkmanager-connectattachment-proposedsegmentchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-proposedsegmentchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedSegmentChange" }, "Options": { "MarkdownDocumentation": "`Options`\n\nOptions for connecting an attachment.\n*Required*: Yes\n*Type*: [ConnectAttachmentOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-options", "UpdateType": "Immutable", "Required": true, "Type": "ConnectAttachmentOptions" }, "TransportAttachmentId": { "MarkdownDocumentation": "`TransportAttachmentId`\n\nThe ID of the transport attachment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^attachment-([0-9a-f]{8,17})$`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-transportattachmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CoreNetworkId": { "MarkdownDocumentation": "`CoreNetworkId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-corenetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n*Required*: No\n*Type*: [ProposedNetworkFunctionGroupChange](./aws-properties-networkmanager-connectattachment-proposednetworkfunctiongroupchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-proposednetworkfunctiongroupchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedNetworkFunctionGroupChange" }, "RoutingPolicyLabel": { "MarkdownDocumentation": "`RoutingPolicyLabel`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-routingpolicylabel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkFunctionGroupName": { "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe name of the network function group.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-networkfunctiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the Connect attachment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-connectattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "EdgeLocation": { "MarkdownDocumentation": "`EdgeLocation`\n\nThe Region where the edge is located.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#cfn-networkmanager-connectattachment-edgelocation", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nThe resource ARN for the Connect attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#ResourceArn-fn::getatt" }, "AttachmentType": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentType`\n\nThe type of attachment. This will be `CONNECT`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#AttachmentType-fn::getatt" }, "SegmentName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SegmentName`\n\nThe name of the Connect attachment's segment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#SegmentName-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the Connect attachment. This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#State-fn::getatt" }, "LastModificationErrors": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LastModificationErrors`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#LastModificationErrors-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the Connect attachment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#CreatedAt-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nThe ID of the Connect attachment owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#OwnerAccountId-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the Connect attachment was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#UpdatedAt-fn::getatt" }, "AttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentId`\n\nThe ID of the Connect attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#AttachmentId-fn::getatt" }, "CoreNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkArn`\n\nThe ARN of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#CoreNetworkArn-fn::getatt" }, "AttachmentPolicyRuleNumber": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe rule number associated with the attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectattachment.html#AttachmentPolicyRuleNumber-fn::getatt" } } }, "AWS::NetworkManager::ConnectPeer": { "MarkdownDocumentation": "`AWS::NetworkManager::ConnectPeer`\n\nCreates a core network Connect peer for a specified core network connect attachment between a core network and an appliance.\nThe peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ConnectPeerId`. For example, `{ \"Ref: \"connect-peer--041e25dbc928d7e61\" }`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html", "Properties": { "ConnectAttachmentId": { "MarkdownDocumentation": "`ConnectAttachmentId`\n\nThe ID of the attachment to connect.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^attachment-([0-9a-f]{8,17})$`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#cfn-networkmanager-connectpeer-connectattachmentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PeerAddress": { "MarkdownDocumentation": "`PeerAddress`\n\nThe IP address of the Connect peer.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#cfn-networkmanager-connectpeer-peeraddress", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SubnetArn": { "MarkdownDocumentation": "`SubnetArn`\n\nThe subnet ARN of the Connect peer.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\\/subnet-[0-9a-f]{8,17}$|^$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#cfn-networkmanager-connectpeer-subnetarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CoreNetworkAddress": { "MarkdownDocumentation": "`CoreNetworkAddress`\n\nThe IP address of a core network.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#cfn-networkmanager-connectpeer-corenetworkaddress", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BgpOptions": { "MarkdownDocumentation": "`BgpOptions`\n\nDescribes the BGP options.\n*Required*: No\n*Type*: [BgpOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#cfn-networkmanager-connectpeer-bgpoptions", "UpdateType": "Immutable", "Required": false, "Type": "BgpOptions" }, "InsideCidrBlocks": { "MarkdownDocumentation": "`InsideCidrBlocks`\n\nThe inside IP addresses used for a Connect peer configuration.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#cfn-networkmanager-connectpeer-insidecidrblocks", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value tags associated with the Connect peer.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-connectpeer-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#cfn-networkmanager-connectpeer-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Configuration.BgpConfigurations": { "Type": "List", "ItemType": "ConnectPeerBgpConfiguration", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#Configuration.BgpConfigurations-fn::getatt" }, "CoreNetworkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkId`\n\nThe core network ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#CoreNetworkId-fn::getatt" }, "Configuration.InsideCidrBlocks": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#Configuration.InsideCidrBlocks-fn::getatt" }, "Configuration": { "Type": "ConnectPeerConfiguration", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#Configuration-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the Connect peer. This will be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#State-fn::getatt" }, "LastModificationErrors": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LastModificationErrors`\n\nDescribes the error associated with the attachment request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#LastModificationErrors-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the Connect peer was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#CreatedAt-fn::getatt" }, "ConnectPeerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectPeerId`\n\nThe ID of the Connect peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#ConnectPeerId-fn::getatt" }, "Configuration.CoreNetworkAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#Configuration.CoreNetworkAddress-fn::getatt" }, "Configuration.Protocol": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#Configuration.Protocol-fn::getatt" }, "Configuration.PeerAddress": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#Configuration.PeerAddress-fn::getatt" }, "EdgeLocation": { "PrimitiveType": "String", "MarkdownDocumentation": "`EdgeLocation`\n\nThe Connect peer Regions where edges are located.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-connectpeer.html#EdgeLocation-fn::getatt" } } }, "AWS::NetworkManager::CoreNetwork": { "MarkdownDocumentation": "`AWS::NetworkManager::CoreNetwork`\n\nDescribes a core network.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the core network. For example, `{ \"Ref: \"core-network-060ea2740fe60fd38\" }`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html", "Properties": { "GlobalNetworkId": { "MarkdownDocumentation": "`GlobalNetworkId`\n\nThe ID of the global network that your core network is a part of.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#cfn-networkmanager-corenetwork-globalnetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of a core network.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#cfn-networkmanager-corenetwork-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nDescribes a core network policy. For more information, see [Core network policies](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#cfn-networkmanager-corenetwork-policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value tags associated with a core network.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-corenetwork-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#cfn-networkmanager-corenetwork-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CoreNetworkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkId`\n\nThe ID of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#CoreNetworkId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the core network. These states are: `CREATING` | `UPDATING` | `AVAILABLE` | `DELETING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#State-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the core network was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#CreatedAt-fn::getatt" }, "Segments": { "Type": "List", "ItemType": "CoreNetworkSegment", "MarkdownDocumentation": "`Segments`\n\nThe segments.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#Segments-fn::getatt" }, "NetworkFunctionGroups": { "Type": "List", "ItemType": "CoreNetworkNetworkFunctionGroup", "MarkdownDocumentation": "`NetworkFunctionGroups`\n\nThe network function groups associated with a core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#NetworkFunctionGroups-fn::getatt" }, "OwnerAccount": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccount`\n\nThe owner of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#OwnerAccount-fn::getatt" }, "Edges": { "Type": "List", "ItemType": "CoreNetworkEdge", "MarkdownDocumentation": "`Edges`\n\nThe edges.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#Edges-fn::getatt" }, "CoreNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkArn`\n\nThe ARN of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetwork.html#CoreNetworkArn-fn::getatt" } } }, "AWS::NetworkManager::CoreNetworkPrefixListAssociation": { "MarkdownDocumentation": "`AWS::NetworkManager::CoreNetworkPrefixListAssociation`\n\nThe `AWS::NetworkManager::CoreNetworkPrefixListAssociation` resource Property description not available. for NetworkManager.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetworkprefixlistassociation.html", "Properties": { "CoreNetworkId": { "MarkdownDocumentation": "`CoreNetworkId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetworkprefixlistassociation.html#cfn-networkmanager-corenetworkprefixlistassociation-corenetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PrefixListArn": { "MarkdownDocumentation": "`PrefixListArn`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[a-z0-9-]+:ec2:[a-z]+-[a-z]+-[0-9]:([0-9]{12}):prefix-list/pl-[a-z0-9]+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetworkprefixlistassociation.html#cfn-networkmanager-corenetworkprefixlistassociation-prefixlistarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PrefixListAlias": { "MarkdownDocumentation": "`PrefixListAlias`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-corenetworkprefixlistassociation.html#cfn-networkmanager-corenetworkprefixlistassociation-prefixlistalias", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkManager::CustomerGatewayAssociation": { "MarkdownDocumentation": "`AWS::NetworkManager::CustomerGatewayAssociation`\n\nSpecifies an association between a customer gateway, a device, and optionally, a link.\nIf you specify a link, it must be associated with the specified device. The customer\ngateway must be connected to a VPN attachment on a transit gateway that's registered in\nyour global network.\nYou cannot associate a customer gateway with more than one device and link.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the global network and the Amazon Resource Name\n(ARN) of the customer gateway. For example: `global-network-01231231231231231|arn:aws:ec2:eu-central-1:123456789012:customer-gateway/cgw-00112233aabbcc112`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-customergatewayassociation.html", "Properties": { "GlobalNetworkId": { "MarkdownDocumentation": "`GlobalNetworkId`\n\nThe ID of the global network.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-customergatewayassociation.html#cfn-networkmanager-customergatewayassociation-globalnetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeviceId": { "MarkdownDocumentation": "`DeviceId`\n\nThe ID of the device.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-customergatewayassociation.html#cfn-networkmanager-customergatewayassociation-deviceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CustomerGatewayArn": { "MarkdownDocumentation": "`CustomerGatewayArn`\n\nThe Amazon Resource Name (ARN) of the customer gateway.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-customergatewayassociation.html#cfn-networkmanager-customergatewayassociation-customergatewayarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LinkId": { "MarkdownDocumentation": "`LinkId`\n\nThe ID of the link.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-customergatewayassociation.html#cfn-networkmanager-customergatewayassociation-linkid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::NetworkManager::Device": { "MarkdownDocumentation": "`AWS::NetworkManager::Device`\n\nSpecifies a device.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IDs of the global network and device. For example: `global-network-01231231231231231|device-07f6fd08867abc123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html", "Properties": { "SiteId": { "MarkdownDocumentation": "`SiteId`\n\nThe site ID.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-siteid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AWSLocation": { "MarkdownDocumentation": "`AWSLocation`\n\nThe AWS location of the device.\n*Required*: No\n*Type*: [AWSLocation](./aws-properties-networkmanager-device-awslocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-awslocation", "UpdateType": "Mutable", "Required": false, "Type": "AWSLocation" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe device type.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the device.\nConstraints: Maximum length of 256 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GlobalNetworkId": { "MarkdownDocumentation": "`GlobalNetworkId`\n\nThe ID of the global network.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-globalnetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SerialNumber": { "MarkdownDocumentation": "`SerialNumber`\n\nThe serial number of the device.\nConstraints: Maximum length of 128 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-serialnumber", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Model": { "MarkdownDocumentation": "`Model`\n\nThe model of the device.\nConstraints: Maximum length of 128 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-model", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Vendor": { "MarkdownDocumentation": "`Vendor`\n\nThe vendor of the device.\nConstraints: Maximum length of 128 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-vendor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the device.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-device-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe site location.\n*Required*: No\n*Type*: [Location](./aws-properties-networkmanager-device-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-location", "UpdateType": "Mutable", "Required": false, "Type": "Location" } }, "Attributes": { "DeviceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeviceArn`\n\nThe ARN of the device. For example,\n`arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#DeviceArn-fn::getatt" }, "DeviceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeviceId`\n\nThe ID of the device. For example, `device-07f6fd08867abc123`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#DeviceId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the device.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#State-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time that the device was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#CreatedAt-fn::getatt" } } }, "AWS::NetworkManager::DirectConnectGatewayAttachment": { "MarkdownDocumentation": "`AWS::NetworkManager::DirectConnectGatewayAttachment`\n\nCreates an AWS Direct Connect gateway attachment\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html", "Properties": { "ProposedSegmentChange": { "MarkdownDocumentation": "`ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n*Required*: No\n*Type*: [ProposedSegmentChange](./aws-properties-networkmanager-directconnectgatewayattachment-proposedsegmentchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#cfn-networkmanager-directconnectgatewayattachment-proposedsegmentchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedSegmentChange" }, "CoreNetworkId": { "MarkdownDocumentation": "`CoreNetworkId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#cfn-networkmanager-directconnectgatewayattachment-corenetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n*Required*: No\n*Type*: [ProposedNetworkFunctionGroupChange](./aws-properties-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#cfn-networkmanager-directconnectgatewayattachment-proposednetworkfunctiongroupchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedNetworkFunctionGroupChange" }, "EdgeLocations": { "MarkdownDocumentation": "`EdgeLocations`\n\nProperty description not available.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#cfn-networkmanager-directconnectgatewayattachment-edgelocations", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DirectConnectGatewayArn": { "MarkdownDocumentation": "`DirectConnectGatewayArn`\n\nThe Direct Connect gateway attachment ARN.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[^:]{1,63}:directconnect::[^:]{0,63}:dx-gateway\\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#cfn-networkmanager-directconnectgatewayattachment-directconnectgatewayarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoutingPolicyLabel": { "MarkdownDocumentation": "`RoutingPolicyLabel`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#cfn-networkmanager-directconnectgatewayattachment-routingpolicylabel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-directconnectgatewayattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#cfn-networkmanager-directconnectgatewayattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#ResourceArn-fn::getatt" }, "AttachmentType": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentType`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#AttachmentType-fn::getatt" }, "SegmentName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SegmentName`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#SegmentName-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#State-fn::getatt" }, "LastModificationErrors": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LastModificationErrors`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#LastModificationErrors-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#CreatedAt-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#OwnerAccountId-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#UpdatedAt-fn::getatt" }, "AttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#AttachmentId-fn::getatt" }, "NetworkFunctionGroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe name of the network function group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#NetworkFunctionGroupName-fn::getatt" }, "CoreNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#CoreNetworkArn-fn::getatt" }, "AttachmentPolicyRuleNumber": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-directconnectgatewayattachment.html#AttachmentPolicyRuleNumber-fn::getatt" } } }, "AWS::NetworkManager::GlobalNetwork": { "MarkdownDocumentation": "`AWS::NetworkManager::GlobalNetwork`\n\nCreates a new, empty global network.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the global network. For example: `global-network-01231231231231231`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the global network.\nConstraints: Maximum length of 256 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html#cfn-networkmanager-globalnetwork-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "State": { "MarkdownDocumentation": "`State`\n\nThe state of the global network.\n*Required*: No\n*Type*: String\n*Allowed values*: `PENDING | AVAILABLE | DELET...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PENDING", "AVAILABLE", "DELETING", "UPDATING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html#cfn-networkmanager-globalnetwork-state", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CreatedAt": { "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the global network 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html#cfn-networkmanager-globalnetwork-createdat", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the global network.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-globalnetwork-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html#cfn-networkmanager-globalnetwork-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the global network. For example,\n`global-network-01231231231231231`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the global network. For example,\n`arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html#Arn-fn::getatt" } } }, "AWS::NetworkManager::Link": { "MarkdownDocumentation": "`AWS::NetworkManager::Link`\n\nSpecifies a link for a site.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IDs of the global network and link. For example: `global-network-01231231231231231|link-11112222aaaabbbb1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html", "Properties": { "SiteId": { "MarkdownDocumentation": "`SiteId`\n\nThe ID of the site.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#cfn-networkmanager-link-siteid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the link.\nConstraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#cfn-networkmanager-link-type", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GlobalNetworkId": { "MarkdownDocumentation": "`GlobalNetworkId`\n\nThe ID of the global network.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#cfn-networkmanager-link-globalnetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the link.\nConstraints: Maximum length of 256 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#cfn-networkmanager-link-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Bandwidth": { "MarkdownDocumentation": "`Bandwidth`\n\nThe bandwidth for the link.\n*Required*: Yes\n*Type*: [Bandwidth](./aws-properties-networkmanager-link-bandwidth.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#cfn-networkmanager-link-bandwidth", "UpdateType": "Mutable", "Required": true, "Type": "Bandwidth" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the link.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-link-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#cfn-networkmanager-link-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Provider": { "MarkdownDocumentation": "`Provider`\n\nThe provider of the link.\nConstraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#cfn-networkmanager-link-provider", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "LinkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LinkArn`\n\nThe ARN of the link. For example,\n`arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#LinkArn-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the link.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#State-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the link was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#CreatedAt-fn::getatt" }, "LinkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`LinkId`\n\nThe ID of the link. For example, `link-11112222aaaabbbb1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-link.html#LinkId-fn::getatt" } } }, "AWS::NetworkManager::LinkAssociation": { "MarkdownDocumentation": "`AWS::NetworkManager::LinkAssociation`\n\nDescribes the association between a device and a link.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IDs of the global network, device, and link. For example: `global-network-01231231231231231|device-07f6fd08867abc123|link-11112222aaaabbbb1`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-linkassociation.html", "Properties": { "GlobalNetworkId": { "MarkdownDocumentation": "`GlobalNetworkId`\n\nThe ID of the global network.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-linkassociation.html#cfn-networkmanager-linkassociation-globalnetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeviceId": { "MarkdownDocumentation": "`DeviceId`\n\nThe device ID for the link association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-linkassociation.html#cfn-networkmanager-linkassociation-deviceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LinkId": { "MarkdownDocumentation": "`LinkId`\n\nThe ID of the link.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-linkassociation.html#cfn-networkmanager-linkassociation-linkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkManager::Site": { "MarkdownDocumentation": "`AWS::NetworkManager::Site`\n\nCreates a new site in a global network.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the IDs of the global network and the site. For example: `global-network-01231231231231231|site-444555aaabbb11223`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of your site.\nConstraints: Maximum length of 256 characters.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#cfn-networkmanager-site-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "GlobalNetworkId": { "MarkdownDocumentation": "`GlobalNetworkId`\n\nThe ID of the global network.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#cfn-networkmanager-site-globalnetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the site.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-site-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#cfn-networkmanager-site-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Location": { "MarkdownDocumentation": "`Location`\n\nThe site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.\n* `Address`: The physical address of the site.\n* `Latitude`: The latitude of the site.\n* `Longitude`: The longitude of the site.\n*Required*: No\n*Type*: [Location](./aws-properties-networkmanager-site-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#cfn-networkmanager-site-location", "UpdateType": "Mutable", "Required": false, "Type": "Location" } }, "Attributes": { "SiteId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SiteId`\n\nThe ID of the site. For example, `site-444555aaabbb11223`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#SiteId-fn::getatt" }, "SiteArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SiteArn`\n\nThe ARN of the site. For example,\n`arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#SiteArn-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the site.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#State-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe time that the site was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html#CreatedAt-fn::getatt" } } }, "AWS::NetworkManager::SiteToSiteVpnAttachment": { "MarkdownDocumentation": "`AWS::NetworkManager::SiteToSiteVpnAttachment`\n\nCreates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `AttachmentId`. For example, `{ \"Ref: \"attachment-05467e74104d33861\" }`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html", "Properties": { "ProposedSegmentChange": { "MarkdownDocumentation": "`ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n*Required*: No\n*Type*: [ProposedSegmentChange](./aws-properties-networkmanager-sitetositevpnattachment-proposedsegmentchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#cfn-networkmanager-sitetositevpnattachment-proposedsegmentchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedSegmentChange" }, "CoreNetworkId": { "MarkdownDocumentation": "`CoreNetworkId`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#cfn-networkmanager-sitetositevpnattachment-corenetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n*Required*: No\n*Type*: [ProposedNetworkFunctionGroupChange](./aws-properties-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#cfn-networkmanager-sitetositevpnattachment-proposednetworkfunctiongroupchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedNetworkFunctionGroupChange" }, "VpnConnectionArn": { "MarkdownDocumentation": "`VpnConnectionArn`\n\nThe ARN of the site-to-site VPN attachment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\\/vpn-[0-9a-f]{8,17}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#cfn-networkmanager-sitetositevpnattachment-vpnconnectionarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoutingPolicyLabel": { "MarkdownDocumentation": "`RoutingPolicyLabel`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#cfn-networkmanager-sitetositevpnattachment-routingpolicylabel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkFunctionGroupName": { "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe name of the network function group.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#cfn-networkmanager-sitetositevpnattachment-networkfunctiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the Site-to-Site VPN attachment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-sitetositevpnattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#cfn-networkmanager-sitetositevpnattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nThe resource ARN for the site-to-site VPN attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#ResourceArn-fn::getatt" }, "AttachmentType": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentType`\n\nThe type of attachment. This will be `SITE_TO_SITE_VPN`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#AttachmentType-fn::getatt" }, "SegmentName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SegmentName`\n\nThe name of the site-to-site VPN attachment's segment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#SegmentName-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the site-to-site VPN attachment. This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#State-fn::getatt" }, "LastModificationErrors": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LastModificationErrors`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#LastModificationErrors-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the site-to-site VPN attachment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#CreatedAt-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nThe ID of the site-to-site VPN attachment owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#OwnerAccountId-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the site-to-site VPN attachment was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#UpdatedAt-fn::getatt" }, "AttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentId`\n\nThe ID of the site-to-site VPN attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#AttachmentId-fn::getatt" }, "CoreNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkArn`\n\nThe ARN of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#CoreNetworkArn-fn::getatt" }, "EdgeLocation": { "PrimitiveType": "String", "MarkdownDocumentation": "`EdgeLocation`\n\nThe Region where the core network edge is located.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#EdgeLocation-fn::getatt" }, "AttachmentPolicyRuleNumber": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe policy rule number associated with the attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-sitetositevpnattachment.html#AttachmentPolicyRuleNumber-fn::getatt" } } }, "AWS::NetworkManager::TransitGatewayPeering": { "MarkdownDocumentation": "`AWS::NetworkManager::TransitGatewayPeering`\n\nCreates a transit gateway peering connection.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `peeringId`. For example: `peering-01234ab1234a12a12`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html", "Properties": { "CoreNetworkId": { "MarkdownDocumentation": "`CoreNetworkId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#cfn-networkmanager-transitgatewaypeering-corenetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TransitGatewayArn": { "MarkdownDocumentation": "`TransitGatewayArn`\n\nThe ARN of the transit gateway.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#cfn-networkmanager-transitgatewaypeering-transitgatewayarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value tags associated with the peering.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-transitgatewaypeering-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#cfn-networkmanager-transitgatewaypeering-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nThe ARN of the resource peered to a core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#ResourceArn-fn::getatt" }, "PeeringType": { "PrimitiveType": "String", "MarkdownDocumentation": "`PeeringType`\n\nThe peering type. This will be `TRANSIT_GATEWAY`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#PeeringType-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe current state of the peer. This can be `CREATING` | `FAILED` | `AVAILABLE` | `DELETING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#State-fn::getatt" }, "LastModificationErrors": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LastModificationErrors`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#LastModificationErrors-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the core network peering was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#CreatedAt-fn::getatt" }, "PeeringId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PeeringId`\n\nThe ID of the peering.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#PeeringId-fn::getatt" }, "TransitGatewayPeeringAttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayPeeringAttachmentId`\n\nThe ID of the peering attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#TransitGatewayPeeringAttachmentId-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nThe ID of the account owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#OwnerAccountId-fn::getatt" }, "CoreNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkArn`\n\nThe ARN of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#CoreNetworkArn-fn::getatt" }, "EdgeLocation": { "PrimitiveType": "String", "MarkdownDocumentation": "`EdgeLocation`\n\nThe edge location for the peer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewaypeering.html#EdgeLocation-fn::getatt" } } }, "AWS::NetworkManager::TransitGatewayRegistration": { "MarkdownDocumentation": "`AWS::NetworkManager::TransitGatewayRegistration`\n\nRegisters a transit gateway in your global network. Not all Regions support transit\ngateways for global networks. For a list of the supported Regions, see [Region Availability](https://docs.aws.amazon.com/network-manager/latest/tgwnm/what-are-global-networks.html#nm-available-regions) in the *AWS Transit Gateways for Global\nNetworks User Guide*. The transit gateway can be in any of the supported\nAWS Regions, but it must be owned by the same AWS account that owns the global\nnetwork. You cannot register a transit gateway in more than one global network.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the global network and the ARN of the transit gateway. For example: `global-network-01231231231231231|arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayregistration.html", "Properties": { "GlobalNetworkId": { "MarkdownDocumentation": "`GlobalNetworkId`\n\nThe ID of the global network.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayregistration.html#cfn-networkmanager-transitgatewayregistration-globalnetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TransitGatewayArn": { "MarkdownDocumentation": "`TransitGatewayArn`\n\nThe Amazon Resource Name (ARN) of the transit gateway.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayregistration.html#cfn-networkmanager-transitgatewayregistration-transitgatewayarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::NetworkManager::TransitGatewayRouteTableAttachment": { "MarkdownDocumentation": "`AWS::NetworkManager::TransitGatewayRouteTableAttachment`\n\nCreates a transit gateway route table attachment.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the attachment ID of the transit gateway route table. For example: `attachment-12367e74104d31234`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html", "Properties": { "ProposedSegmentChange": { "MarkdownDocumentation": "`ProposedSegmentChange`\n\nThis property is read-only. Values can't be assigned to it.\n*Required*: No\n*Type*: [ProposedSegmentChange](./aws-properties-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#cfn-networkmanager-transitgatewayroutetableattachment-proposedsegmentchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedSegmentChange" }, "TransitGatewayRouteTableArn": { "MarkdownDocumentation": "`TransitGatewayRouteTableArn`\n\nThe ARN of the transit gateway attachment route table. For example, `\"TransitGatewayRouteTableArn\": \"arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456\"`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#cfn-networkmanager-transitgatewayroutetableattachment-transitgatewayroutetablearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n*Required*: No\n*Type*: [ProposedNetworkFunctionGroupChange](./aws-properties-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#cfn-networkmanager-transitgatewayroutetableattachment-proposednetworkfunctiongroupchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedNetworkFunctionGroupChange" }, "PeeringId": { "MarkdownDocumentation": "`PeeringId`\n\nThe ID of the transit gateway peering.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^peering-([0-9a-f]{8,17})$`\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#cfn-networkmanager-transitgatewayroutetableattachment-peeringid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoutingPolicyLabel": { "MarkdownDocumentation": "`RoutingPolicyLabel`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#cfn-networkmanager-transitgatewayroutetableattachment-routingpolicylabel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkFunctionGroupName": { "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe name of the network function group.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#cfn-networkmanager-transitgatewayroutetableattachment-networkfunctiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value pairs associated with the transit gateway route table attachment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-transitgatewayroutetableattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#cfn-networkmanager-transitgatewayroutetableattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "CoreNetworkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkId`\n\nThe ID of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#CoreNetworkId-fn::getatt" }, "AttachmentType": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentType`\n\nThe type of attachment. This will be `TRANSIT_GATEWAY_ROUTE_TABLE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#AttachmentType-fn::getatt" }, "SegmentName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SegmentName`\n\nThe name of the attachment's segment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#SegmentName-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the transit gateway route table attachment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#CreatedAt-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the transit gateway route table attachment was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#UpdatedAt-fn::getatt" }, "AttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentId`\n\nThe ID of the transit gateway route table attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#AttachmentId-fn::getatt" }, "CoreNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkArn`\n\nThe ARN of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#CoreNetworkArn-fn::getatt" }, "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nThe resource ARN for the transit gateway route table attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#ResourceArn-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the attachment. This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#State-fn::getatt" }, "LastModificationErrors": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LastModificationErrors`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#LastModificationErrors-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nThe ID of the transit gateway route table attachment owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#OwnerAccountId-fn::getatt" }, "EdgeLocation": { "PrimitiveType": "String", "MarkdownDocumentation": "`EdgeLocation`\n\nThe Region where the core network edge is located.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#EdgeLocation-fn::getatt" }, "AttachmentPolicyRuleNumber": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe policy rule number associated with the attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-transitgatewayroutetableattachment.html#AttachmentPolicyRuleNumber-fn::getatt" } } }, "AWS::NetworkManager::VpcAttachment": { "MarkdownDocumentation": "`AWS::NetworkManager::VpcAttachment`\n\nCreates a VPC attachment on an edge location of a core network.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `AttachmentId`. For example, `{ \"Ref: \"attachment-00067e74104d33769\" }`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html", "Properties": { "ProposedSegmentChange": { "MarkdownDocumentation": "`ProposedSegmentChange`\n\nDescribes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.\n*Required*: No\n*Type*: [ProposedSegmentChange](./aws-properties-networkmanager-vpcattachment-proposedsegmentchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#cfn-networkmanager-vpcattachment-proposedsegmentchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedSegmentChange" }, "SubnetArns": { "MarkdownDocumentation": "`SubnetArns`\n\nThe subnet ARNs.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#cfn-networkmanager-vpcattachment-subnetarns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Options": { "MarkdownDocumentation": "`Options`\n\nOptions for creating the VPC attachment.\n*Required*: No\n*Type*: [VpcOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#cfn-networkmanager-vpcattachment-options", "UpdateType": "Mutable", "Required": false, "Type": "VpcOptions" }, "CoreNetworkId": { "MarkdownDocumentation": "`CoreNetworkId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#cfn-networkmanager-vpcattachment-corenetworkid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProposedNetworkFunctionGroupChange": { "MarkdownDocumentation": "`ProposedNetworkFunctionGroupChange`\n\nDescribes proposed changes to a network function group.\n*Required*: No\n*Type*: [ProposedNetworkFunctionGroupChange](./aws-properties-networkmanager-vpcattachment-proposednetworkfunctiongroupchange.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#cfn-networkmanager-vpcattachment-proposednetworkfunctiongroupchange", "UpdateType": "Mutable", "Required": false, "Type": "ProposedNetworkFunctionGroupChange" }, "RoutingPolicyLabel": { "MarkdownDocumentation": "`RoutingPolicyLabel`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#cfn-networkmanager-vpcattachment-routingpolicylabel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcArn": { "MarkdownDocumentation": "`VpcArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#cfn-networkmanager-vpcattachment-vpcarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the VPC attachment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-networkmanager-vpcattachment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#cfn-networkmanager-vpcattachment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "AttachmentType": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentType`\n\nThe type of attachment. This will be `VPC`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#AttachmentType-fn::getatt" }, "SegmentName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SegmentName`\n\nThe name of the attachment's segment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#SegmentName-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp when the VPC attachment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#CreatedAt-fn::getatt" }, "UpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`UpdatedAt`\n\nThe timestamp when the VPC attachment was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#UpdatedAt-fn::getatt" }, "AttachmentId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AttachmentId`\n\nThe ID of the VPC attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#AttachmentId-fn::getatt" }, "NetworkFunctionGroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkFunctionGroupName`\n\nThe name of the network function group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#NetworkFunctionGroupName-fn::getatt" }, "CoreNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CoreNetworkArn`\n\nThe ARN of the core network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#CoreNetworkArn-fn::getatt" }, "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nThe resource ARN for the VPC attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#ResourceArn-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the attachment. This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#State-fn::getatt" }, "LastModificationErrors": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`LastModificationErrors`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#LastModificationErrors-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nThe ID of the VPC attachment owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#OwnerAccountId-fn::getatt" }, "EdgeLocation": { "PrimitiveType": "String", "MarkdownDocumentation": "`EdgeLocation`\n\nThe Region where the core network edge is located.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#EdgeLocation-fn::getatt" }, "AttachmentPolicyRuleNumber": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AttachmentPolicyRuleNumber`\n\nThe policy rule number associated with the attachment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-vpcattachment.html#AttachmentPolicyRuleNumber-fn::getatt" } } }, "AWS::NimbleStudio::Studio": { "MarkdownDocumentation": "`AWS::NimbleStudio::Studio`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html", "Properties": { "UserRoleArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-userrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StudioName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-studioname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AdminRoleArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-adminrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StudioEncryptionConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-studioencryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StudioEncryptionConfiguration" }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-tags", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "HomeRegion": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#HomeRegion-fn::getatt" }, "StudioUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#StudioUrl-fn::getatt" }, "SsoClientId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#SsoClientId-fn::getatt" }, "StudioId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#StudioId-fn::getatt" } } }, "AWS::ODB::CloudAutonomousVmCluster": { "MarkdownDocumentation": "`AWS::ODB::CloudAutonomousVmCluster`\n\nThe `AWS::ODB::CloudAutonomousVmCluster` resource creates an Autonomous VM cluster. An Autonomous VM cluster provides the infrastructure for running Autonomous Databases.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier of the Autonomous VM cluster. For example:\n`{ \"Ref\": \"myAutonomousVmCluster\" }`\nFor the Autonomous VM cluster `myAutonomousVmCluster`, `Ref` returns the unique identifier of the Autonomous VM cluster.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html", "Properties": { "CloudExadataInfrastructureId": { "MarkdownDocumentation": "`CloudExadataInfrastructureId`\n\nThe unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.\nRequired when creating an Autonomous VM cluster.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`\n*Minimum*: `6`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-cloudexadatainfrastructureid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LicenseModel": { "MarkdownDocumentation": "`LicenseModel`\n\nThe Oracle license model that applies to the Autonomous VM cluster. Valid values are `LICENSE_INCLUDED` or `BRING_YOUR_OWN_LICENSE`.\n*Required*: No\n*Type*: String\n*Allowed values*: `BRING_YOUR_OWN_LICENSE | LI...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-licensemodel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe user-provided description of the Autonomous VM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CpuCoreCountPerNode": { "MarkdownDocumentation": "`CpuCoreCountPerNode`\n\nThe number of CPU cores enabled per node in the Autonomous VM cluster.\nRequired when creating an Autonomous VM cluster.\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-cpucorecountpernode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MemoryPerOracleComputeUnitInGBs": { "MarkdownDocumentation": "`MemoryPerOracleComputeUnitInGBs`\n\nThe amount of memory allocated per Oracle Compute Unit, in GB.\nRequired when creating an Autonomous VM cluster.\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-memoryperoraclecomputeunitingbs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DbServers": { "MarkdownDocumentation": "`DbServers`\n\nThe list of database servers associated with the Autonomous VM cluster.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-dbservers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TotalContainerDatabases": { "MarkdownDocumentation": "`TotalContainerDatabases`\n\nThe total number of Autonomous Container Databases that can be created with the allocated local storage.\nRequired when creating an Autonomous VM cluster.\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-totalcontainerdatabases", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "TimeZone": { "MarkdownDocumentation": "`TimeZone`\n\nThe time zone of the Autonomous VM cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-timezone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AutonomousDataStorageSizeInTBs": { "MarkdownDocumentation": "`AutonomousDataStorageSizeInTBs`\n\nThe data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.\nRequired when creating an Autonomous VM cluster.\n*Required*: Conditional\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-autonomousdatastoragesizeintbs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "ScanListenerPortNonTls": { "MarkdownDocumentation": "`ScanListenerPortNonTls`\n\nThe SCAN listener port for non-TLS (TCP) protocol. The default is 1521.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1024`\n*Maximum*: `8999`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-scanlistenerportnontls", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "OdbNetworkId": { "MarkdownDocumentation": "`OdbNetworkId`\n\nThe unique identifier of the ODB network associated with this Autonomous VM cluster.\nRequired when creating an Autonomous VM cluster.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`\n*Minimum*: `6`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-odbnetworkid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IsMtlsEnabledVmCluster": { "MarkdownDocumentation": "`IsMtlsEnabledVmCluster`\n\nSpecifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-ismtlsenabledvmcluster", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the Autonomous VM cluster.\nRequired when creating an Autonomous VM cluster.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-displayname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ScanListenerPortTls": { "MarkdownDocumentation": "`ScanListenerPortTls`\n\nThe SCAN listener port for TLS (TCP) protocol. The default is 2484.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1024`\n*Maximum*: `8999`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-scanlistenerporttls", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "MaintenanceWindow": { "MarkdownDocumentation": "`MaintenanceWindow`\n\nThe scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.\n*Required*: No\n*Type*: [MaintenanceWindow](./aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-maintenancewindow", "UpdateType": "Immutable", "Required": false, "Type": "MaintenanceWindow" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the Autonomous Vm Cluster.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-odb-cloudautonomousvmcluster-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#cfn-odb-cloudautonomousvmcluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "DataStorageSizeInGBs": { "PrimitiveType": "Double", "MarkdownDocumentation": "`DataStorageSizeInGBs`\n\nThe total data storage allocated to the Autonomous VM cluster, in GB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#DataStorageSizeInGBs-fn::getatt" }, "Shape": { "PrimitiveType": "String", "MarkdownDocumentation": "`Shape`\n\nThe shape of the Exadata infrastructure for the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#Shape-fn::getatt" }, "OciUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciUrl`\n\nThe URL for accessing the OCI console page for this Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#OciUrl-fn::getatt" }, "MaxAcdsLowestScaledValue": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`MaxAcdsLowestScaledValue`\n\nThe minimum value to which you can scale down the maximum number of Autonomous CDBs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#MaxAcdsLowestScaledValue-fn::getatt" }, "ReservedCpus": { "PrimitiveType": "Double", "MarkdownDocumentation": "`ReservedCpus`\n\nThe number of CPU cores reserved for system operations and redundancy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#ReservedCpus-fn::getatt" }, "NonProvisionableAutonomousContainerDatabases": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`NonProvisionableAutonomousContainerDatabases`\n\nThe number of Autonomous CDBs that can't be provisioned because of resource constraints.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#NonProvisionableAutonomousContainerDatabases-fn::getatt" }, "DataStorageSizeInTBs": { "PrimitiveType": "Double", "MarkdownDocumentation": "`DataStorageSizeInTBs`\n\nThe total data storage allocated to the Autonomous VM cluster, in TB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#DataStorageSizeInTBs-fn::getatt" }, "ProvisionedCpus": { "PrimitiveType": "Double", "MarkdownDocumentation": "`ProvisionedCpus`\n\nThe number of CPU cores currently provisioned in the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#ProvisionedCpus-fn::getatt" }, "OciResourceAnchorName": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciResourceAnchorName`\n\nThe name of the OCI resource anchor associated with this Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#OciResourceAnchorName-fn::getatt" }, "ExadataStorageInTBsLowestScaledValue": { "PrimitiveType": "Double", "MarkdownDocumentation": "`ExadataStorageInTBsLowestScaledValue`\n\nThe minimum value to which you can scale down the Exadata storage, in TB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#ExadataStorageInTBsLowestScaledValue-fn::getatt" }, "ProvisionedAutonomousContainerDatabases": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ProvisionedAutonomousContainerDatabases`\n\nThe number of Autonomous CDBs currently provisioned in the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#ProvisionedAutonomousContainerDatabases-fn::getatt" }, "AutonomousDataStoragePercentage": { "PrimitiveType": "Double", "MarkdownDocumentation": "`AutonomousDataStoragePercentage`\n\nThe percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#AutonomousDataStoragePercentage-fn::getatt" }, "AvailableContainerDatabases": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AvailableContainerDatabases`\n\nThe number of Autonomous CDBs that you can create with the currently available storage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#AvailableContainerDatabases-fn::getatt" }, "CloudAutonomousVmClusterArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloudAutonomousVmClusterArn`\n\nThe Amazon Resource Name (ARN) for the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#CloudAutonomousVmClusterArn-fn::getatt" }, "AvailableAutonomousDataStorageSizeInTBs": { "PrimitiveType": "Double", "MarkdownDocumentation": "`AvailableAutonomousDataStorageSizeInTBs`\n\nThe available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#AvailableAutonomousDataStorageSizeInTBs-fn::getatt" }, "MemorySizeInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`MemorySizeInGBs`\n\nThe total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#MemorySizeInGBs-fn::getatt" }, "CpuCoreCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`CpuCoreCount`\n\nThe total number of CPU cores in the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#CpuCoreCount-fn::getatt" }, "NodeCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`NodeCount`\n\nThe number of database server nodes in the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#NodeCount-fn::getatt" }, "AvailableCpus": { "PrimitiveType": "Double", "MarkdownDocumentation": "`AvailableCpus`\n\nThe number of CPU cores available for allocation to Autonomous Databases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#AvailableCpus-fn::getatt" }, "Hostname": { "PrimitiveType": "String", "MarkdownDocumentation": "`Hostname`\n\nThe hostname for the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#Hostname-fn::getatt" }, "CpuPercentage": { "PrimitiveType": "Double", "MarkdownDocumentation": "`CpuPercentage`\n\nThe percentage of total CPU cores currently in use in the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#CpuPercentage-fn::getatt" }, "Ocid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Ocid`\n\nThe Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#Ocid-fn::getatt" }, "ReclaimableCpus": { "PrimitiveType": "Double", "MarkdownDocumentation": "`ReclaimableCpus`\n\nThe number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#ReclaimableCpus-fn::getatt" }, "ComputeModel": { "PrimitiveType": "String", "MarkdownDocumentation": "`ComputeModel`\n\nThe compute model of the Autonomous VM cluster: ECPU or OCPU.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#ComputeModel-fn::getatt" }, "ProvisionableAutonomousContainerDatabases": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ProvisionableAutonomousContainerDatabases`\n\nThe number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#ProvisionableAutonomousContainerDatabases-fn::getatt" }, "DbNodeStorageSizeInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`DbNodeStorageSizeInGBs`\n\nThe local node storage allocated to the Autonomous VM cluster, in gigabytes (GB).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#DbNodeStorageSizeInGBs-fn::getatt" }, "CloudAutonomousVmClusterId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloudAutonomousVmClusterId`\n\nThe unique identifier of the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#CloudAutonomousVmClusterId-fn::getatt" }, "Domain": { "PrimitiveType": "String", "MarkdownDocumentation": "`Domain`\n\nThe domain name for the Autonomous VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudautonomousvmcluster.html#Domain-fn::getatt" } } }, "AWS::ODB::CloudExadataInfrastructure": { "MarkdownDocumentation": "`AWS::ODB::CloudExadataInfrastructure`\n\nThe `AWS::ODB::CloudExadataInfrastructure` resource creates an Exadata infrastructure. An Exadata infrastructure provides the underlying compute and storage resources for Oracle Database workloads.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier of the Exadata infrastructure. For example:\n`{ \"Ref\": \"myExadataInfrastructure\" }`\nFor the Exadata infrastructure `myExadataInfrastructure`, `Ref` returns the unique identifier of the Exadata infrastructure.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html", "Properties": { "StorageServerType": { "MarkdownDocumentation": "`StorageServerType`\n\nThe storage server model type of the Exadata infrastructure. For the list of valid model names, use the `ListDbSystemShapes` operation.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\/.=-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-storageservertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DatabaseServerType": { "MarkdownDocumentation": "`DatabaseServerType`\n\nThe database server model type of the Exadata infrastructure. For the list of valid model names, use the `ListDbSystemShapes` operation.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\/.=-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-databaseservertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Shape": { "MarkdownDocumentation": "`Shape`\n\nThe model name of the Exadata infrastructure.\nRequired when creating an Exadata infrastructure.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\/.=-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-shape", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StorageCount": { "MarkdownDocumentation": "`StorageCount`\n\nThe number of storage servers that are activated for the Exadata infrastructure.\nRequired when creating an Exadata infrastructure.\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-storagecount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe user-friendly name for the Exadata infrastructure.\nRequired when creating an Exadata infrastructure.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-displayname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneId": { "MarkdownDocumentation": "`AvailabilityZoneId`\n\nThe AZ ID of the AZ where the Exadata infrastructure is located.\nRequired when creating an Exadata infrastructure. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the infrastructure.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-availabilityzoneid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CustomerContactsToSendToOCI": { "MarkdownDocumentation": "`CustomerContactsToSendToOCI`\n\nThe email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.\n*Required*: No\n*Type*: Array of [CustomerContact](./aws-properties-odb-cloudexadatainfrastructure-customercontact.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-customercontactstosendtooci", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "CustomerContact", "DuplicatesAllowed": true }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe name of the Availability Zone (AZ) where the Exadata infrastructure is located.\nRequired when creating an Exadata infrastructure. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the infrastructure.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaintenanceWindow": { "MarkdownDocumentation": "`MaintenanceWindow`\n\nThe scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.\n*Required*: No\n*Type*: [MaintenanceWindow](./aws-properties-odb-cloudexadatainfrastructure-maintenancewindow.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-maintenancewindow", "UpdateType": "Mutable", "Required": false, "Type": "MaintenanceWindow" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the Exadata Infrastructure.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-odb-cloudexadatainfrastructure-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ComputeCount": { "MarkdownDocumentation": "`ComputeCount`\n\nThe number of database servers for the Exadata infrastructure.\nRequired when creating an Exadata infrastructure.\n*Required*: Conditional\n*Type*: Integer\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#cfn-odb-cloudexadatainfrastructure-computecount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "CloudExadataInfrastructureId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloudExadataInfrastructureId`\n\nThe unique identifier for the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#CloudExadataInfrastructureId-fn::getatt" }, "MemorySizeInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`MemorySizeInGBs`\n\nThe amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#MemorySizeInGBs-fn::getatt" }, "CloudExadataInfrastructureArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloudExadataInfrastructureArn`\n\nThe Amazon Resource Name (ARN) for the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#CloudExadataInfrastructureArn-fn::getatt" }, "MaxDbNodeStorageSizeInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`MaxDbNodeStorageSizeInGBs`\n\nThe total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#MaxDbNodeStorageSizeInGBs-fn::getatt" }, "TotalStorageSizeInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`TotalStorageSizeInGBs`\n\nThe total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#TotalStorageSizeInGBs-fn::getatt" }, "OciUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciUrl`\n\nThe HTTPS link to the Exadata infrastructure in OCI.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#OciUrl-fn::getatt" }, "Ocid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Ocid`\n\nThe OCID of the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#Ocid-fn::getatt" }, "MaxMemoryInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`MaxMemoryInGBs`\n\nThe total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#MaxMemoryInGBs-fn::getatt" }, "StorageServerVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`StorageServerVersion`\n\nThe software version of the storage servers on the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#StorageServerVersion-fn::getatt" }, "DataStorageSizeInTBs": { "PrimitiveType": "Double", "MarkdownDocumentation": "`DataStorageSizeInTBs`\n\nThe size of the Exadata infrastructure's data disk group, in terabytes (TB).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#DataStorageSizeInTBs-fn::getatt" }, "MaxCpuCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`MaxCpuCount`\n\nThe total number of CPU cores available on the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#MaxCpuCount-fn::getatt" }, "MaxDataStorageInTBs": { "PrimitiveType": "Double", "MarkdownDocumentation": "`MaxDataStorageInTBs`\n\nThe total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#MaxDataStorageInTBs-fn::getatt" }, "DbServerVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`DbServerVersion`\n\nThe software version of the database servers (dom0) in the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#DbServerVersion-fn::getatt" }, "AdditionalStorageCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AdditionalStorageCount`\n\nThe number of storage servers requested for the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#AdditionalStorageCount-fn::getatt" }, "CpuCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`CpuCount`\n\nThe total number of CPU cores that are allocated to the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#CpuCount-fn::getatt" }, "OciResourceAnchorName": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciResourceAnchorName`\n\nThe name of the OCI resource anchor for the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#OciResourceAnchorName-fn::getatt" }, "ComputeModel": { "PrimitiveType": "String", "MarkdownDocumentation": "`ComputeModel`\n\nThe OCI model compute model used when you create or clone an instance: ECPU or OCPU. An\nECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores\nelastically allocated from a pool of compute and storage servers. An OCPU is a legacy\nphysical measure of compute resources. OCPUs are based on the physical core of a processor\nwith hyper-threading enabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#ComputeModel-fn::getatt" }, "DbNodeStorageSizeInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`DbNodeStorageSizeInGBs`\n\nThe size of the Exadata infrastructure's local node storage, in gigabytes (GB).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#DbNodeStorageSizeInGBs-fn::getatt" }, "ActivatedStorageCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ActivatedStorageCount`\n\nThe number of storage servers requested for the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#ActivatedStorageCount-fn::getatt" }, "DbServerIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`DbServerIds`\n\nThe list of database server identifiers for the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#DbServerIds-fn::getatt" }, "AvailableStorageSizeInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AvailableStorageSizeInGBs`\n\nThe amount of available storage, in gigabytes (GB), for the Exadata infrastructure.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudexadatainfrastructure.html#AvailableStorageSizeInGBs-fn::getatt" } } }, "AWS::ODB::CloudVmCluster": { "MarkdownDocumentation": "`AWS::ODB::CloudVmCluster`\n\nThe `AWS::ODB::CloudVmCluster` resource creates a VM cluster on the specified Exadata infrastructure in the Oracle Database. A VM cluster provides the compute resources for Oracle Database workloads.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier of the VM cluster. For example:\n`{ \"Ref\": \"myVmCluster\" }`\nFor the VM cluster `myVmCluster`, `Ref` returns the unique identifier of the VM cluster.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html", "Properties": { "CloudExadataInfrastructureId": { "MarkdownDocumentation": "`CloudExadataInfrastructureId`\n\nThe unique identifier of the Exadata infrastructure that this VM cluster belongs to.\nRequired when creating a VM cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-cloudexadatainfrastructureid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DataCollectionOptions": { "MarkdownDocumentation": "`DataCollectionOptions`\n\nThe set of diagnostic collection options enabled for the VM cluster.\n*Required*: No\n*Type*: [DataCollectionOptions](./aws-properties-odb-cloudvmcluster-datacollectionoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-datacollectionoptions", "UpdateType": "Immutable", "Required": false, "Type": "DataCollectionOptions" }, "LicenseModel": { "MarkdownDocumentation": "`LicenseModel`\n\nThe Oracle license model applied to the VM cluster.\n*Required*: No\n*Type*: String\n*Allowed values*: `BRING_YOUR_OWN_LICENSE | LI...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-licensemodel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MemorySizeInGBs": { "MarkdownDocumentation": "`MemorySizeInGBs`\n\nThe amount of memory, in gigabytes (GB), that's allocated for the VM cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-memorysizeingbs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "CpuCoreCount": { "MarkdownDocumentation": "`CpuCoreCount`\n\nThe number of CPU cores enabled on the VM cluster.\nRequired when creating a VM cluster.\n*Required*: Conditional\n*Type*: Integer\n*Minimum*: `0`\n*Maximum*: `368`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-cpucorecount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "SshPublicKeys": { "MarkdownDocumentation": "`SshPublicKeys`\n\nThe public key portion of one or more key pairs used for SSH access to the VM cluster.\nRequired when creating a VM cluster.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-sshpublickeys", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Hostname": { "MarkdownDocumentation": "`Hostname`\n\nThe host name for the VM cluster.\nRequired when creating a VM cluster.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$`\n*Minimum*: `1`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-hostname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SystemVersion": { "MarkdownDocumentation": "`SystemVersion`\n\nThe operating system version of the image chosen for the VM cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-systemversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DataStorageSizeInTBs": { "MarkdownDocumentation": "`DataStorageSizeInTBs`\n\nThe size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.\n*Required*: No\n*Type*: Number\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-datastoragesizeintbs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Double" }, "IsLocalBackupEnabled": { "MarkdownDocumentation": "`IsLocalBackupEnabled`\n\nSpecifies whether database backups to local Exadata storage are enabled for the VM 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-islocalbackupenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DbServers": { "MarkdownDocumentation": "`DbServers`\n\nThe list of database servers for the VM cluster.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-dbservers", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DbNodes": { "MarkdownDocumentation": "`DbNodes`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [DbNode](./aws-properties-odb-cloudvmcluster-dbnode.html)\n*Minimum*: `1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-dbnodes", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "DbNode", "DuplicatesAllowed": false }, "TimeZone": { "MarkdownDocumentation": "`TimeZone`\n\nThe time zone of the VM cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-timezone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IsSparseDiskgroupEnabled": { "MarkdownDocumentation": "`IsSparseDiskgroupEnabled`\n\nSpecifies whether the VM cluster is configured with a sparse disk group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-issparsediskgroupenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "GiVersion": { "MarkdownDocumentation": "`GiVersion`\n\nThe software version of the Oracle Grid Infrastructure (GI) for the VM cluster.\nRequired when creating a VM cluster.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-giversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OdbNetworkId": { "MarkdownDocumentation": "`OdbNetworkId`\n\nThe unique identifier of the ODB network for the VM cluster.\nRequired when creating a VM cluster.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`\n*Minimum*: `6`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-odbnetworkid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DbNodeStorageSizeInGBs": { "MarkdownDocumentation": "`DbNodeStorageSizeInGBs`\n\nThe amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-dbnodestoragesizeingbs", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe user-friendly name for the VM cluster.\nRequired when creating a VM cluster.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-displayname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the Grid Infrastructure (GI) cluster.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9-]*$`\n*Minimum*: `1`\n*Maximum*: `11`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-clustername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the Vm Cluster.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-odb-cloudvmcluster-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ScanListenerPortTcp": { "MarkdownDocumentation": "`ScanListenerPortTcp`\n\nThe port number for TCP connections to the single client access name (SCAN) listener.\nValid values: `1024\u20138999` with the following exceptions: `2484`,\n`6100`, `6200`, `7060`, `7070`,\n`7085`, and `7879`\nDefault: `1521`\n*Required*: No\n*Type*: Integer\n*Minimum*: `1024`\n*Maximum*: `8999`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#cfn-odb-cloudvmcluster-scanlistenerporttcp", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "ListenerPort": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`ListenerPort`\n\nThe port number configured for the listener on the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#ListenerPort-fn::getatt" }, "Shape": { "PrimitiveType": "String", "MarkdownDocumentation": "`Shape`\n\nThe hardware model name of the Exadata infrastructure that's running the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#Shape-fn::getatt" }, "NodeCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`NodeCount`\n\nThe number of nodes in the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#NodeCount-fn::getatt" }, "ScanDnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ScanDnsName`\n\nThe FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#ScanDnsName-fn::getatt" }, "VipIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`VipIds`\n\nThe virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#VipIds-fn::getatt" }, "OciUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciUrl`\n\nThe HTTPS link to the VM cluster in OCI.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#OciUrl-fn::getatt" }, "Ocid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Ocid`\n\nThe OCID of the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#Ocid-fn::getatt" }, "StorageSizeInGBs": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`StorageSizeInGBs`\n\nThe amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#StorageSizeInGBs-fn::getatt" }, "CloudVmClusterArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloudVmClusterArn`\n\nThe Amazon Resource Name (ARN) of the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#CloudVmClusterArn-fn::getatt" }, "CloudVmClusterId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CloudVmClusterId`\n\nThe unique identifier of the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#CloudVmClusterId-fn::getatt" }, "OciResourceAnchorName": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciResourceAnchorName`\n\nThe name of the OCI resource anchor for the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#OciResourceAnchorName-fn::getatt" }, "ComputeModel": { "PrimitiveType": "String", "MarkdownDocumentation": "`ComputeModel`\n\nThe OCI model compute model used when you create or clone an instance: ECPU or OCPU. An\nECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores\nelastically allocated from a pool of compute and storage servers. An OCPU is a legacy\nphysical measure of compute resources. OCPUs are based on the physical core of a processor\nwith hyper-threading enabled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#ComputeModel-fn::getatt" }, "DiskRedundancy": { "PrimitiveType": "String", "MarkdownDocumentation": "`DiskRedundancy`\n\nThe type of redundancy configured for the VM cluster. `NORMAL` is 2-way redundancy. `HIGH` is 3-way redundancy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#DiskRedundancy-fn::getatt" }, "ScanIpIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ScanIpIds`\n\nThe OCID of the SCAN IP addresses that are associated with the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#ScanIpIds-fn::getatt" }, "Domain": { "PrimitiveType": "String", "MarkdownDocumentation": "`Domain`\n\nThe domain of the VM cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-cloudvmcluster.html#Domain-fn::getatt" } } }, "AWS::ODB::OdbNetwork": { "MarkdownDocumentation": "`AWS::ODB::OdbNetwork`\n\nThe `AWS::ODB::OdbNetwork` resource creates an ODB network. An ODB network provides the networking foundation for Oracle Database resources.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier of the ODB network. For example:\n`{ \"Ref\": \"myOdbNetwork\" }`\nFor the ODB network `myOdbNetwork`, `Ref` returns the unique identifier of the ODB network.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html", "Properties": { "DefaultDnsPrefix": { "MarkdownDocumentation": "`DefaultDnsPrefix`\n\nThe DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-defaultdnsprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CustomDomainName": { "MarkdownDocumentation": "`CustomDomainName`\n\nThe domain name for the resources in the ODB network.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-customdomainname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ZeroEtlAccess": { "MarkdownDocumentation": "`ZeroEtlAccess`\n\nThe configuration for Zero-ETL access from the ODB network.\n*Required*: No\n*Type*: [String](./aws-properties-odb-odbnetwork-zeroetlaccess.html)\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-zeroetlaccess", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeleteAssociatedResources": { "MarkdownDocumentation": "`DeleteAssociatedResources`\n\nSpecifies whether to delete associated OCI networking resources along with the ODB network.\nRequired when creating an ODB network.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-deleteassociatedresources", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AvailabilityZoneId": { "MarkdownDocumentation": "`AvailabilityZoneId`\n\nThe AZ ID of the AZ where the ODB network is located.\nRequired when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-availabilityzoneid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe user-friendly name of the ODB network.\nRequired when creating an ODB network.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "S3PolicyDocument": { "MarkdownDocumentation": "`S3PolicyDocument`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-s3policydocument", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone (AZ) where the ODB network is located.\nRequired when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-availabilityzone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BackupSubnetCidr": { "MarkdownDocumentation": "`BackupSubnetCidr`\n\nThe CIDR range of the backup subnet in the ODB network.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-backupsubnetcidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClientSubnetCidr": { "MarkdownDocumentation": "`ClientSubnetCidr`\n\nThe CIDR range of the client subnet in the ODB network.\nRequired when creating an ODB network.\n*Required*: Conditional\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-clientsubnetcidr", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the Odb Network.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-odb-odbnetwork-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "S3Access": { "MarkdownDocumentation": "`S3Access`\n\nThe configuration for Amazon S3 access from the ODB network.\n*Required*: No\n*Type*: [String](./aws-properties-odb-odbnetwork-s3access.html)\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-s3access", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ManagedServices.ManagedServicesIpv4Cidrs": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ManagedServicesIpv4Cidrs-fn::getatt" }, "ManagedServices.ServiceNetworkEndpoint": { "Type": "ServiceNetworkEndpoint", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ServiceNetworkEndpoint-fn::getatt" }, "ManagedServices.S3Access": { "Type": "S3Access", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.S3Access-fn::getatt" }, "ManagedServices.S3Access.Ipv4Addresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.S3Access.Ipv4Addresses-fn::getatt" }, "ManagedServices.ZeroEtlAccess": { "Type": "ZeroEtlAccess", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ZeroEtlAccess-fn::getatt" }, "ManagedServices.ManagedS3BackupAccess.Ipv4Addresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ManagedS3BackupAccess.Ipv4Addresses-fn::getatt" }, "ManagedServices.S3Access.S3PolicyDocument": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.S3Access.S3PolicyDocument-fn::getatt" }, "OciVcnUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciVcnUrl`\n\nThe URL for the VCN that's associated with the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#OciVcnUrl-fn::getatt" }, "ManagedServices.ServiceNetworkEndpoint.VpcEndpointType": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ServiceNetworkEndpoint.VpcEndpointType-fn::getatt" }, "OdbNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`OdbNetworkArn`\n\nThe Amazon Resource Name (ARN) of the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#OdbNetworkArn-fn::getatt" }, "ManagedServices.ServiceNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ServiceNetworkArn-fn::getatt" }, "ManagedServices.ManagedS3BackupAccess.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ManagedS3BackupAccess.Status-fn::getatt" }, "OciNetworkAnchorId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciNetworkAnchorId`\n\nThe unique identifier of the OCI network anchor for the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#OciNetworkAnchorId-fn::getatt" }, "ManagedServices": { "Type": "ManagedServices", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices-fn::getatt" }, "OciResourceAnchorName": { "PrimitiveType": "String", "MarkdownDocumentation": "`OciResourceAnchorName`\n\nThe name of the OCI resource anchor that's associated with the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#OciResourceAnchorName-fn::getatt" }, "ManagedServices.S3Access.DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.S3Access.DomainName-fn::getatt" }, "ManagedServices.ServiceNetworkEndpoint.VpcEndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ServiceNetworkEndpoint.VpcEndpointId-fn::getatt" }, "ManagedServices.ZeroEtlAccess.Cidr": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ZeroEtlAccess.Cidr-fn::getatt" }, "OdbNetworkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OdbNetworkId`\n\nThe unique identifier of the ODB network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#OdbNetworkId-fn::getatt" }, "ManagedServices.ZeroEtlAccess.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ZeroEtlAccess.Status-fn::getatt" }, "ManagedServices.ResourceGatewayArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ResourceGatewayArn-fn::getatt" }, "ManagedServices.ManagedS3BackupAccess": { "Type": "ManagedS3BackupAccess", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.ManagedS3BackupAccess-fn::getatt" }, "ManagedServices.S3Access.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#ManagedServices.S3Access.Status-fn::getatt" } } }, "AWS::ODB::OdbPeeringConnection": { "MarkdownDocumentation": "`AWS::ODB::OdbPeeringConnection`\n\nCreates a peering connection between an ODB network and a VPC.\nA peering connection enables private connectivity between the networks for application-tier communication.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html", "Properties": { "AdditionalPeerNetworkCidrs": { "MarkdownDocumentation": "`AdditionalPeerNetworkCidrs`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#cfn-odb-odbpeeringconnection-additionalpeernetworkcidrs", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "OdbNetworkId": { "MarkdownDocumentation": "`OdbNetworkId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})$`\n*Minimum*: `6`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#cfn-odb-odbpeeringconnection-odbnetworkid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name of the ODB peering connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#cfn-odb-odbpeeringconnection-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PeerNetworkId": { "MarkdownDocumentation": "`PeerNetworkId`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})$`\n*Minimum*: `6`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#cfn-odb-odbpeeringconnection-peernetworkid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-odb-odbpeeringconnection-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#cfn-odb-odbpeeringconnection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "OdbPeeringConnectionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OdbPeeringConnectionId`\n\nThe unique identifier of the ODB peering connection. A sample ID is `odbpcx-abcdefgh12345678`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#OdbPeeringConnectionId-fn::getatt" }, "PeerNetworkCidrs": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`PeerNetworkCidrs`\n\nThe CIDR blocks associated with the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#PeerNetworkCidrs-fn::getatt" }, "OdbPeeringConnectionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`OdbPeeringConnectionArn`\n\nThe Amazon Resource Name (ARN) of the ODB peering connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#OdbPeeringConnectionArn-fn::getatt" }, "OdbNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`OdbNetworkArn`\n\nThe Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#OdbNetworkArn-fn::getatt" }, "PeerNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PeerNetworkArn`\n\nThe Amazon Resource Name (ARN) of the peer network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbpeeringconnection.html#PeerNetworkArn-fn::getatt" } } }, "AWS::OSIS::Pipeline": { "MarkdownDocumentation": "`AWS::OSIS::Pipeline`\n\nThe AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the resource name, such as `mystack-abc1d2efg3h4`. For more information\nabout using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html", "Properties": { "PipelineConfigurationBody": { "MarkdownDocumentation": "`PipelineConfigurationBody`\n\nThe Data Prepper pipeline configuration in YAML format.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-pipelineconfigurationbody", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "BufferOptions": { "MarkdownDocumentation": "`BufferOptions`\n\nOptions that specify the configuration of a persistent buffer.\nTo configure how OpenSearch Ingestion encrypts this data, set the `EncryptionAtRestOptions`. For more information, see [Persistent buffering](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/osis-features-overview.html#persistent-buffering).\n*Required*: No\n*Type*: [BufferOptions](./aws-properties-osis-pipeline-bufferoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-bufferoptions", "UpdateType": "Mutable", "Required": false, "Type": "BufferOptions" }, "PipelineRoleArn": { "MarkdownDocumentation": "`PipelineRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS\nresources.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b|aws\\-iso\\-e|aws\\-iso\\-f):iam::[0-9]+:role\\/.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-pipelinerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MinUnits": { "MarkdownDocumentation": "`MinUnits`\n\nThe minimum pipeline capacity, in Ingestion Compute Units (ICUs).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `384`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-minunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "PipelineName": { "MarkdownDocumentation": "`PipelineName`\n\nThe name of the pipeline.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\-]+`\n*Minimum*: `3`\n*Maximum*: `28`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-pipelinename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcOptions": { "MarkdownDocumentation": "`VpcOptions`\n\nOptions that specify the subnets and security groups for an OpenSearch Ingestion\nVPC endpoint.\n*Required*: No\n*Type*: [VpcOptions](./aws-properties-osis-pipeline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-vpcoptions", "UpdateType": "Mutable", "Required": false, "Type": "VpcOptions" }, "MaxUnits": { "MarkdownDocumentation": "`MaxUnits`\n\nThe maximum pipeline capacity, in Ingestion Compute Units (ICUs).\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `384`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-maxunits", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "LogPublishingOptions": { "MarkdownDocumentation": "`LogPublishingOptions`\n\nKey-value pairs that represent log publishing settings.\n*Required*: No\n*Type*: [LogPublishingOptions](./aws-properties-osis-pipeline-logpublishingoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-logpublishingoptions", "UpdateType": "Mutable", "Required": false, "Type": "LogPublishingOptions" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nProperty description not available.\n*Required*: No\n*Type*: [ResourcePolicy](./aws-properties-osis-pipeline-resourcepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-resourcepolicy", "UpdateType": "Mutable", "Required": false, "Type": "ResourcePolicy" }, "EncryptionAtRestOptions": { "MarkdownDocumentation": "`EncryptionAtRestOptions`\n\nOptions to control how OpenSearch encrypts buffer data.\n*Required*: No\n*Type*: [EncryptionAtRestOptions](./aws-properties-osis-pipeline-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-encryptionatrestoptions", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionAtRestOptions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nList of tags to add to the pipeline upon creation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-osis-pipeline-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "PipelineArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PipelineArn`\n\nThe Amazon Resource Name (ARN) of the pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#PipelineArn-fn::getatt" }, "VpcEndpoints": { "Type": "List", "ItemType": "VpcEndpoint", "MarkdownDocumentation": "`VpcEndpoints`\n\nThe VPC interface endpoints that have access to the pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#VpcEndpoints-fn::getatt" }, "IngestEndpointUrls": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`IngestEndpointUrls`\n\nA list of the ingestion endpoints for the pipeline that you can send data to. Currently,\nonly a single ingestion endpoint is supported for a pipeline. For example,\n`my-pipeline-123456789012.us-east-1.osis.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#IngestEndpointUrls-fn::getatt" }, "VpcEndpointService": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEndpointService`\n\nThe VPC endpoint service name for the pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#VpcEndpointService-fn::getatt" } } }, "AWS::Oam::Link": { "MarkdownDocumentation": "`AWS::Oam::Link`\n\nCreates a link between a source account and a sink that you have created in a monitoring account.\nBefore you create a link, you must create a sink in the monitoring account. The sink must have a sink policy\nthat permits the source account to link to it. You can grant permission to source accounts by granting permission\nto an entire organization, an organizational unit, or to individual accounts.\nFor more information, see\n[CreateSink](https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html) and\n[PutSinkPolicy](https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html).\nEach monitoring account can be linked to as many as 100,000 source accounts.\nEach source account can be linked to as many as five monitoring accounts.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the link. For example,\n`arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html", "Properties": { "SinkIdentifier": { "MarkdownDocumentation": "`SinkIdentifier`\n\nThe ARN of the sink in the monitoring account that you want to link to.\nYou can use [ListSinks](https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html) to\nfind the ARNs of sinks.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-sinkidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LabelTemplate": { "MarkdownDocumentation": "`LabelTemplate`\n\nSpecify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring\naccount.\nYou can include the following variables in your template:\n* `$AccountName` is the name of the account\n* `$AccountEmail` is a globally-unique email address, which includes the\n email domain, such as `mariagarcia@example.com`\n* `$AccountEmailNoDomain` is an email address without the domain name,\n such as `mariagarcia`\n###### Note\nIn the AWS GovCloud (US-East) and AWS GovCloud (US-West) Regions, the only supported option is to use custom labels, and the `$AccountName`, `$AccountEmail`,\nand `$AccountEmailNoDomain` variables\nall resolve as *account-id* instead of the specified variable.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-labeltemplate", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceTypes": { "MarkdownDocumentation": "`ResourceTypes`\n\nAn array of strings that define which types of data that the source account shares with the monitoring\naccount. Valid values are `AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor`.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-resourcetypes", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "LinkConfiguration": { "MarkdownDocumentation": "`LinkConfiguration`\n\nUse this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from\nthe source account to the monitoring account.\n*Required*: No\n*Type*: [LinkConfiguration](./aws-properties-oam-link-linkconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-linkconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LinkConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the link.\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^(?!aws:.*).{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Label": { "PrimitiveType": "String", "MarkdownDocumentation": "`Label`\n\nThe friendly human-readable name used to identify this source account when it is viewed from the monitoring\naccount. For example, `my-account1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#Label-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the link. For example, `arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#Arn-fn::getatt" } } }, "AWS::Oam::Sink": { "MarkdownDocumentation": "`AWS::Oam::Sink`\n\nCreates or updates a *sink* in the current account, so that it can be used as a\nmonitoring account in CloudWatch cross-account observability. A sink is a resource that represents an\nattachment point in a monitoring account, which source accounts can link to to be able to send observability data.\nAfter you create a sink, you must create a sink policy that allows source accounts to attach to it.\nFor more information, see [PutSinkPolicy](https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html).\nAn account can have one sink.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the link. For example,\n`arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe IAM policy that grants permissions to source accounts to link to this sink. The policy can grant permission\nin the following ways:\n* Include organization\n IDs or organization paths to permit all accounts in an organization\n* Include account IDs to permit the specified accounts\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#cfn-oam-sink-policy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to the sink.\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^(?!aws:.*).{1,128}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#cfn-oam-sink-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the sink.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#cfn-oam-sink-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the sink. For example, `arn:aws:oam:us-west-1:111111111111:sink:abcd1234-a123-456a-a12b-a123b456c789`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#Arn-fn::getatt" } } }, "AWS::ObservabilityAdmin::OrganizationCentralizationRule": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationCentralizationRule`\n\nDefines how telemetry data should be centralized across an AWS Organization, including\nsource and destination configurations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html", "Properties": { "Rule": { "MarkdownDocumentation": "`Rule`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [CentralizationRule](./aws-properties-observabilityadmin-organizationcentralizationrule-centralizationrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html#cfn-observabilityadmin-organizationcentralizationrule-rule", "UpdateType": "Mutable", "Required": true, "Type": "CentralizationRule" }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nThe name of the organization centralization rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html#cfn-observabilityadmin-organizationcentralizationrule-rulename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA key-value pair to filter resources based on tags associated with the resource. For\nmore information about tags, see [What are tags?](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html)\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-observabilityadmin-organizationcentralizationrule-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html#cfn-observabilityadmin-organizationcentralizationrule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "RuleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleArn`\n\nThe Amazon Resource Name (ARN) of the organization centralization rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationcentralizationrule.html#RuleArn-fn::getatt" } } }, "AWS::ObservabilityAdmin::OrganizationTelemetryRule": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::OrganizationTelemetryRule`\n\nRetrieves the details of a specific organization centralization rule. This operation can\nonly be called by the organization's management account or a delegated administrator\naccount.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html", "Properties": { "Rule": { "MarkdownDocumentation": "`Rule`\n\nThe name of the organization telemetry rule.\n*Required*: Yes\n*Type*: [TelemetryRule](./aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-rule", "UpdateType": "Mutable", "Required": true, "Type": "TelemetryRule" }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nThe name of the organization centralization rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-rulename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nLists all tags attached to the specified resource. Supports telemetry rule resources and\ntelemetry pipeline resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-observabilityadmin-organizationtelemetryrule-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "RuleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-organizationtelemetryrule.html#RuleArn-fn::getatt" } } }, "AWS::ObservabilityAdmin::S3TableIntegration": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::S3TableIntegration`\n\nCreates an integration between CloudWatch and S3 Tables for analytics. This integration enables\nquerying CloudWatch telemetry data using analytics engines like Amazon Athena, Amazon Redshift, and Apache\nSpark.\n", "RefReturnValue": "\nThe Amazon Resource Name (ARN) of the created S3 Table integration.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-s3tableintegration.html", "Properties": { "LogSources": { "MarkdownDocumentation": "`LogSources`\n\nA data source with an S3 Table integration for query access in the `logs` namespace.\n*Required*: No\n*Type*: Array of [LogSource](./aws-properties-observabilityadmin-s3tableintegration-logsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-s3tableintegration.html#cfn-observabilityadmin-s3tableintegration-logsources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LogSource", "DuplicatesAllowed": false }, "Encryption": { "MarkdownDocumentation": "`Encryption`\n\nDefines the encryption configuration for S3 Table integrations, including the encryption\nalgorithm and KMS key settings.\n*Required*: Yes\n*Type*: [EncryptionConfig](./aws-properties-observabilityadmin-s3tableintegration-encryptionconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-s3tableintegration.html#cfn-observabilityadmin-s3tableintegration-encryption", "UpdateType": "Immutable", "Required": true, "Type": "EncryptionConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that grants permissions for the S3 Table\nintegration to access necessary resources.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$`\n*Minimum*: `1`\n*Maximum*: `1011`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-s3tableintegration.html#cfn-observabilityadmin-s3tableintegration-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe key-value pairs to associate with the S3 Table integration resource for categorization\nand management purposes.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-observabilityadmin-s3tableintegration-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-s3tableintegration.html#cfn-observabilityadmin-s3tableintegration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the S3 Table integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-s3tableintegration.html#Arn-fn::getatt" } } }, "AWS::ObservabilityAdmin::TelemetryPipelines": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryPipelines`\n\nCreates a telemetry pipeline for processing and transforming telemetry data. The pipeline\ndefines how data flows from sources through processors to destinations, enabling data\ntransformation and delivering capabilities.\n", "RefReturnValue": "\nThe Amazon Resource Name (ARN) of the created telemetry pipeline.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html", "Properties": { "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe configuration that defines how the telemetry pipeline processes data, including\nsources, processors, and destinations. For more information, see the\n[Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Creating-pipelines.html).\n*Required*: Yes\n*Type*: [TelemetryPipelineConfiguration](./aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#cfn-observabilityadmin-telemetrypipelines-configuration", "UpdateType": "Mutable", "Required": true, "Type": "TelemetryPipelineConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe key-value pairs to associate with the telemetry pipeline resource for categorization\nand management purposes.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-observabilityadmin-telemetrypipelines-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#cfn-observabilityadmin-telemetrypipelines-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the telemetry pipeline to create. The name must be unique within your\naccount.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\-]+`\n*Minimum*: `3`\n*Maximum*: `28`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#cfn-observabilityadmin-telemetrypipelines-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the telemetry pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Status-fn::getatt" }, "Pipeline.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.Status-fn::getatt" }, "Pipeline.Tags": { "Type": "List", "ItemType": "Tag", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.Tags-fn::getatt" }, "Pipeline.LastUpdateTimeStamp": { "PrimitiveType": "Double", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.LastUpdateTimeStamp-fn::getatt" }, "Pipeline.Configuration": { "Type": "TelemetryPipelineConfiguration", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.Configuration-fn::getatt" }, "StatusReason": { "Type": "TelemetryPipelineStatusReason", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#StatusReason-fn::getatt" }, "Pipeline.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.Arn-fn::getatt" }, "StatusReason.Description": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#StatusReason.Description-fn::getatt" }, "Pipeline.StatusReason": { "Type": "TelemetryPipelineStatusReason", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.StatusReason-fn::getatt" }, "Pipeline": { "Type": "TelemetryPipeline", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline-fn::getatt" }, "Pipeline.Configuration.Body": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.Configuration.Body-fn::getatt" }, "Pipeline.Name": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.Name-fn::getatt" }, "Pipeline.CreatedTimeStamp": { "PrimitiveType": "Double", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.CreatedTimeStamp-fn::getatt" }, "PipelineIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`PipelineIdentifier`\n\nThe Amazon Resource Name (ARN) of the telemetry pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#PipelineIdentifier-fn::getatt" }, "Pipeline.StatusReason.Description": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Pipeline.StatusReason.Description-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the created telemetry pipeline.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#Arn-fn::getatt" } } }, "AWS::ObservabilityAdmin::TelemetryRule": { "MarkdownDocumentation": "`AWS::ObservabilityAdmin::TelemetryRule`\n\nCreates a telemetry rule that defines how telemetry should be configured for AWS\nresources in your account. The rule specifies which resources should have telemetry enabled\nand how that telemetry data should be collected based on resource type, telemetry type, and\nselection criteria.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html", "Properties": { "Rule": { "MarkdownDocumentation": "`Rule`\n\nRetrieves the details of a specific telemetry rule in your account.\n*Required*: Yes\n*Type*: [TelemetryRule](./aws-properties-observabilityadmin-telemetryrule-telemetryrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html#cfn-observabilityadmin-telemetryrule-rule", "UpdateType": "Mutable", "Required": true, "Type": "TelemetryRule" }, "RuleName": { "MarkdownDocumentation": "`RuleName`\n\nThe name of the telemetry rule.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html#cfn-observabilityadmin-telemetryrule-rulename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nLists all tags attached to the specified resource. Supports telemetry rule resources and\ntelemetry pipeline resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-observabilityadmin-telemetryrule-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html#cfn-observabilityadmin-telemetryrule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "RuleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleArn`\n\nThe Amazon Resource Name (ARN) of the telemetry rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html#RuleArn-fn::getatt" } } }, "AWS::OpenSearchServerless::AccessPolicy": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::AccessPolicy`\n\nCreates a data access policy for OpenSearch Serverless. Access policies limit access to collections\nand the resources within them, and allow a user to access that data irrespective of the\naccess mechanism or network source. For more information, see [Data\naccess control for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the name of the access policy. For more information\nabout using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe JSON policy document without any whitespaces.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `20480`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of access policy. Currently the only option is `data`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `data`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "data" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z][a-z0-9-]{2,31}$`\n*Minimum*: `3`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OpenSearchServerless::Collection": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::Collection`\n\nSpecifies an OpenSearch Serverless collection. For more information, see [Creating and\nmanaging Amazon OpenSearch Serverless collections](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html) in the *Amazon\nOpenSearch Service Developer Guide*.\n###### Important\nYou must create a matching [encryption\npolicy](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html) in order for a collection to be created successfully. You can specify\nthe policy resource within the same CloudFormation template as the collection resource\nif you use the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute. See [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#aws-resource-opensearchserverless-collection--examples) for a sample template. Otherwise the encryption policy must already\nexist before you create the collection.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the collection ID. For more information about using the\n`Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of collection. Possible values are `SEARCH`,\n`TIMESERIES`, and `VECTORSEARCH`. 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*Allowed values*: `SEARCH | TIMESERIES | VECTO...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SEARCH", "TIMESERIES", "VECTORSEARCH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the collection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StandbyReplicas": { "MarkdownDocumentation": "`StandbyReplicas`\n\nIndicates whether to use standby replicas for the collection. You can't update this\nproperty after the collection is already created. If you attempt to modify this property,\nthe collection continues to use the original value.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-standbyreplicas", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-opensearchserverless-collection-tag.html)\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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*Pattern*: `^[a-z][a-z0-9-]{2,31}$`\n*Minimum*: `3`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "KmsKeyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`KmsKeyArn`\n\nThe ARN of the AWS KMS key used to encrypt the collection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#KmsKeyArn-fn::getatt" }, "CollectionEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`CollectionEndpoint`\n\nCollection-specific endpoint used to submit index, search, and data upload requests to\nan OpenSearch Serverless collection. For example,\n`https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#CollectionEndpoint-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nA unique identifier for the collection. For example,\n`07tjusf2h91cunochc`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the collection. For example,\n`arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#Arn-fn::getatt" }, "DashboardEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`DashboardEndpoint`\n\nThe collection-specific endpoint used to access OpenSearch Dashboards. For example,\n`https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#DashboardEndpoint-fn::getatt" } } }, "AWS::OpenSearchServerless::Index": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::Index`\n\nAn OpenSearch Serverless index resource.\n", "RefReturnValue": "\nThe index name and the collection endpoint in the following format: index name|endpoint.\nHere's an example:\n1234TestIndex|12345678TestEndPoint.us-east-1.aoss.amazonaws.com.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html", "Properties": { "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the OpenSearch Serverless index.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?![_-])[a-z][a-z0-9_-]*$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-indexname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Mappings": { "MarkdownDocumentation": "`Mappings`\n\nIndex mappings for the OpenSearch Serverless index.\n*Required*: No\n*Type*: [Mappings](./aws-properties-opensearchserverless-index-mappings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-mappings", "UpdateType": "Mutable", "Required": false, "Type": "Mappings" }, "CollectionEndpoint": { "MarkdownDocumentation": "`CollectionEndpoint`\n\nThe endpoint for the collection.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-collectionendpoint", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Settings": { "MarkdownDocumentation": "`Settings`\n\nIndex settings for the OpenSearch Serverless index.\n*Required*: No\n*Type*: [IndexSettings](./aws-properties-opensearchserverless-index-indexsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-settings", "UpdateType": "Mutable", "Required": false, "Type": "IndexSettings" } }, "Attributes": { "Uuid": { "PrimitiveType": "String", "MarkdownDocumentation": "`Uuid`\n\nThe unique identifier for the index.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#Uuid-fn::getatt" } } }, "AWS::OpenSearchServerless::LifecyclePolicy": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::LifecyclePolicy`\n\nCreates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define\nthe number of days or hours to retain the data on an OpenSearch Serverless index. For more information,\nsee [Creating data lifecycle policies](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the type and name of the lifecycle policy. For more\ninformation about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe JSON policy document without any whitespaces.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `20480`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html#cfn-opensearchserverless-lifecyclepolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of lifecycle policy.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `retention`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "retention" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html#cfn-opensearchserverless-lifecyclepolicy-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the lifecycle policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html#cfn-opensearchserverless-lifecyclepolicy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the lifecycle policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z][a-z0-9-]+$`\n*Minimum*: `3`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html#cfn-opensearchserverless-lifecyclepolicy-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OpenSearchServerless::SecurityConfig": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::SecurityConfig`\n\nSpecifies a security configuration for OpenSearch Serverless. For more information, see [SAML\nauthentication for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the name of the ID of the security configuration. For\nmore information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of security configuration. Currently the only option is\n`saml`.\n*Required*: No\n*Type*: String\n*Allowed values*: `saml | iamidentitycenter | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "saml", "iamidentitycenter", "iamfederation" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-type", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the security configuration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SamlOptions": { "MarkdownDocumentation": "`SamlOptions`\n\nSAML options for the security configuration in the form of a key-value map.\n*Required*: No\n*Type*: [SamlConfigOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-samloptions", "UpdateType": "Mutable", "Required": false, "Type": "SamlConfigOptions" }, "IamFederationOptions": { "MarkdownDocumentation": "`IamFederationOptions`\n\nDescribes IAM federation options in the form of a key-value map. Contains\nconfiguration details about how OpenSearch Serverless integrates with external identity\nproviders through federation.\n*Required*: No\n*Type*: [IamFederationConfigOptions](./aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-iamfederationoptions", "UpdateType": "Mutable", "Required": false, "Type": "IamFederationConfigOptions" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the security configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z][a-z0-9-]{2,31}$`\n*Minimum*: `3`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IamIdentityCenterOptions": { "MarkdownDocumentation": "`IamIdentityCenterOptions`\n\nDescribes IAM Identity Center options in the form of a key-value map.\n*Required*: No\n*Type*: [IamIdentityCenterConfigOptions](./aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-iamidentitycenteroptions", "UpdateType": "Mutable", "Required": false, "Type": "IamIdentityCenterConfigOptions" } }, "Attributes": { "IamIdentityCenterOptions.ApplicationName": { "PrimitiveType": "String", "MarkdownDocumentation": "`IamIdentityCenterOptions.ApplicationName`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#IamIdentityCenterOptions.ApplicationName-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the security configuration. For example,\n`saml/123456789012/myprovider`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#Id-fn::getatt" }, "IamIdentityCenterOptions.ApplicationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IamIdentityCenterOptions.ApplicationArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#IamIdentityCenterOptions.ApplicationArn-fn::getatt" }, "IamIdentityCenterOptions.ApplicationDescription": { "PrimitiveType": "String", "MarkdownDocumentation": "`IamIdentityCenterOptions.ApplicationDescription`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#IamIdentityCenterOptions.ApplicationDescription-fn::getatt" } } }, "AWS::OpenSearchServerless::SecurityPolicy": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::SecurityPolicy`\n\nCreates an encryption or network policy to be used by one or more OpenSearch Serverless\ncollections.\nNetwork policies specify access to a collection and its OpenSearch Dashboards endpoint\nfrom public networks or specific VPC endpoints. For more information, see [Network access\nfor Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html).\nEncryption policies specify a KMS encryption key to assign to particular collections.\nFor more information, see [Encryption at\nrest for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the name of the security policy. For more information\nabout using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe JSON policy document without any whitespaces.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `20480`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of security policy. Can be either `encryption` or\n`network`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `encryption | network...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "encryption", "network" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the security policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z][a-z0-9-]{2,31}$`\n*Minimum*: `3`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::OpenSearchServerless::VpcEndpoint": { "MarkdownDocumentation": "`AWS::OpenSearchServerless::VpcEndpoint`\n\nCreates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see [Access\nAmazon OpenSearch Serverless using an interface endpoint](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref`\nfunction, `Ref` returns the endpoint ID. For more information about using the\n`Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC from which you access OpenSearch Serverless.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^vpc-[0-9a-z]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe unique identifiers of the security groups that define the ports, protocols, and\nsources for inbound traffic that you are authorizing into your endpoint.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `128 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe ID of the subnets from which you access OpenSearch Serverless.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `32 | 6`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z][a-z0-9-]{2,31}$`\n*Minimum*: `3`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of the endpoint. For example,\n`vpce-050f79086ee71ac05`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#Id-fn::getatt" } } }, "AWS::OpenSearchService::Application": { "MarkdownDocumentation": "`AWS::OpenSearchService::Application`\n\nCreates an OpenSearch UI application. For more information, see [Using the OpenSearch user interface in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html", "Properties": { "DataSources": { "MarkdownDocumentation": "`DataSources`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [DataSource](./aws-properties-opensearchservice-application-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-datasources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataSource", "DuplicatesAllowed": true }, "AppConfigs": { "MarkdownDocumentation": "`AppConfigs`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [AppConfig](./aws-properties-opensearchservice-application-appconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-appconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AppConfig", "DuplicatesAllowed": true }, "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint URL of an OpenSearch 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-endpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-opensearchservice-application-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "IamIdentityCenterOptions": { "MarkdownDocumentation": "`IamIdentityCenterOptions`\n\nSettings container for integrating IAM Identity Center with OpenSearch UI applications,\nwhich enables enabling secure user authentication and access control across multiple data\nsources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing\ncentralized user management.\n*Required*: No\n*Type*: [IamIdentityCenterOptions](./aws-properties-opensearchservice-application-iamidentitycenteroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-iamidentitycenteroptions", "UpdateType": "Mutable", "Required": false, "Type": "IamIdentityCenterOptions" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of an OpenSearch application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-z][a-z0-9\\-]+`\n*Minimum*: `3`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier of an OpenSearch application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in\n*Using AWS Identity and Access Management* for\nmore information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#Arn-fn::getatt" } } }, "AWS::OpenSearchService::Domain": { "MarkdownDocumentation": "`AWS::OpenSearchService::Domain`\n\nThe AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service\ndomain.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the resource name, such as `mystack-abc1d2efg3h4.` For more\ninformation about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html", "Properties": { "SkipShardMigrationWait": { "MarkdownDocumentation": "`SkipShardMigrationWait`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-skipshardmigrationwait", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe version of OpenSearch to use. The value must be in the format\n`OpenSearch_X.Y` or `Elasticsearch_X.Y`. If not specified, the latest version of OpenSearch is used. For\ninformation about the versions that OpenSearch Service supports, see [Supported\nversions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service\nDeveloper 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\n`EngineVersion` without interruption. When `EnableVersionUpgrade` is\nset to `false`, or is not specified, updating `EngineVersion` results in\n[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*Pattern*: `^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$`\n*Minimum*: `14`\n*Maximum*: `18`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SoftwareUpdateOptions": { "MarkdownDocumentation": "`SoftwareUpdateOptions`\n\nService software update options for the domain.\n*Required*: No\n*Type*: [SoftwareUpdateOptions](./aws-properties-opensearchservice-domain-softwareupdateoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-softwareupdateoptions", "UpdateType": "Mutable", "Required": false, "Type": "SoftwareUpdateOptions" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nA 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, CloudFormation generates a unique\nphysical ID and uses that ID for the domain name. For more information, see [Name\nType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\nRequired when creating a new domain.\n###### Important\nIf you specify a name, you can't perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must replace\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LogPublishingOptions": { "MarkdownDocumentation": "`LogPublishingOptions`\n\nAn object with one or more of the following keys: `SEARCH_SLOW_LOGS`,\n`ES_APPLICATION_LOGS`, `INDEX_SLOW_LOGS`, `AUDIT_LOGS`,\ndepending on the types of logs you want to publish. Each key needs a valid\n`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*: Object of [LogPublishingOption](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-logpublishingoptions", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "LogPublishingOption" }, "AIMLOptions": { "MarkdownDocumentation": "`AIMLOptions`\n\nContainer for parameters required to enable all machine learning features.\n*Required*: No\n*Type*: [AIMLOptions](./aws-properties-opensearchservice-domain-aimloptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-aimloptions", "UpdateType": "Mutable", "Required": false, "Type": "AIMLOptions" }, "SnapshotOptions": { "MarkdownDocumentation": "`SnapshotOptions`\n\n**DEPRECATED**. The automated snapshot configuration for the\nOpenSearch Service domain indexes.\n*Required*: No\n*Type*: [SnapshotOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-snapshotoptions", "UpdateType": "Mutable", "Required": false, "Type": "SnapshotOptions" }, "VPCOptions": { "MarkdownDocumentation": "`VPCOptions`\n\nThe virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more\ninformation, 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\nGuide*.\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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-vpcoptions", "UpdateType": "Mutable", "Required": false, "Type": "VPCOptions" }, "NodeToNodeEncryptionOptions": { "MarkdownDocumentation": "`NodeToNodeEncryptionOptions`\n\nSpecifies 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-nodetonodeencryptionoptions", "UpdateType": "Mutable", "Required": false, "Type": "NodeToNodeEncryptionOptions" }, "AccessPolicies": { "MarkdownDocumentation": "`AccessPolicies`\n\nAn AWS Identity and Access Management (IAM) policy document that specifies who can\naccess 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\nGuide*.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-accesspolicies", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DomainEndpointOptions": { "MarkdownDocumentation": "`DomainEndpointOptions`\n\nSpecifies 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainendpointoptions", "UpdateType": "Mutable", "Required": false, "Type": "DomainEndpointOptions" }, "CognitoOptions": { "MarkdownDocumentation": "`CognitoOptions`\n\nConfigures OpenSearch Service to use Amazon Cognito authentication for OpenSearch\nDashboards.\n*Required*: No\n*Type*: [CognitoOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-cognitooptions", "UpdateType": "Mutable", "Required": false, "Type": "CognitoOptions" }, "AdvancedOptions": { "MarkdownDocumentation": "`AdvancedOptions`\n\nAdditional options to specify for the OpenSearch Service domain. For more information, see\n[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*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedoptions", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "AdvancedSecurityOptions": { "MarkdownDocumentation": "`AdvancedSecurityOptions`\n\nSpecifies 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))\nand encryption at rest ([EncryptionAtRestOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html)).\nYou must also enable `EnforceHTTPS` within [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html),\nwhich requires HTTPS for all traffic to the domain.\n*Required*: No\n*Type*: [AdvancedSecurityOptionsInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedsecurityoptions", "UpdateType": "Mutable", "Required": false, "Type": "AdvancedSecurityOptionsInput" }, "IPAddressType": { "MarkdownDocumentation": "`IPAddressType`\n\nChoose either dual stack or IPv4 as your IP address type. Dual stack allows you to\nshare domain resources across IPv4 and IPv6 address types, and is the recommended\noption. If you set your IP address type to dual stack, you can't change your address\ntype 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-ipaddresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IdentityCenterOptions": { "MarkdownDocumentation": "`IdentityCenterOptions`\n\nConfiguration options for controlling IAM Identity Center integration within a\ndomain.\n*Required*: No\n*Type*: [IdentityCenterOptions](./aws-properties-opensearchservice-domain-identitycenteroptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-identitycenteroptions", "UpdateType": "Mutable", "Required": false, "Type": "IdentityCenterOptions" }, "EBSOptions": { "MarkdownDocumentation": "`EBSOptions`\n\nThe configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to\ndata 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\nGuide*.\n*Required*: No\n*Type*: [EBSOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-ebsoptions", "UpdateType": "Mutable", "Required": false, "Type": "EBSOptions" }, "EncryptionAtRestOptions": { "MarkdownDocumentation": "`EncryptionAtRestOptions`\n\nWhether the domain should encrypt data at rest, and if so, the AWS KMS key to\nuse. See [Encryption of data at rest for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html).\nIf no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template,\nthe domain is deleted and recreated in order to modify the property.\n*Required*: No\n*Type*: [EncryptionAtRestOptions](./aws-properties-opensearchservice-domain-encryptionatrestoptions.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-encryptionatrestoptions", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionAtRestOptions" }, "OffPeakWindowOptions": { "MarkdownDocumentation": "`OffPeakWindowOptions`\n\nOptions for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.\n*Required*: No\n*Type*: [OffPeakWindowOptions](./aws-properties-opensearchservice-domain-offpeakwindowoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-offpeakwindowoptions", "UpdateType": "Mutable", "Required": false, "Type": "OffPeakWindowOptions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key\u2013value pairs) to associate with the OpenSearch Service\ndomain.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-opensearchservice-domain-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "ClusterConfig": { "MarkdownDocumentation": "`ClusterConfig`\n\nContainer for the cluster configuration of a domain.\n*Required*: No\n*Type*: [ClusterConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-clusterconfig", "UpdateType": "Mutable", "Required": false, "Type": "ClusterConfig" } }, "Attributes": { "ServiceSoftwareOptions.OptionalDeployment": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions.OptionalDeployment-fn::getatt" }, "ServiceSoftwareOptions.Description": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions.Description-fn::getatt" }, "ServiceSoftwareOptions.UpdateStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions.UpdateStatus-fn::getatt" }, "ServiceSoftwareOptions.AutomatedUpdateDate": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions.AutomatedUpdateDate-fn::getatt" }, "ServiceSoftwareOptions.CurrentVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions.CurrentVersion-fn::getatt" }, "IdentityCenterOptions.IdentityStoreId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdentityCenterOptions.IdentityStoreId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#IdentityCenterOptions.IdentityStoreId-fn::getatt" }, "DomainEndpointV2": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainEndpointV2`\n\nIf `IPAddressType` to set to `dualstack`, a version 2 domain endpoint\nis provisioned. This endpoint functions like a normal endpoint, except that it works with both\nIPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#DomainEndpointV2-fn::getatt" }, "DomainEndpoints": { "Type": "Map", "PrimitiveItemType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#DomainEndpoints-fn::getatt" }, "DomainArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainArn`\n\nThe Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in\n*Using AWS Identity and Access Management* for\nmore information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#DomainArn-fn::getatt" }, "ServiceSoftwareOptions.UpdateAvailable": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions.UpdateAvailable-fn::getatt" }, "DomainEndpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainEndpoint`\n\nThe domain-specific endpoint used for requests to the OpenSearch APIs, such as\n`search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#DomainEndpoint-fn::getatt" }, "ServiceSoftwareOptions": { "Type": "ServiceSoftwareOptions", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions-fn::getatt" }, "AdvancedSecurityOptions.AnonymousAuthDisableDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`AdvancedSecurityOptions.AnonymousAuthDisableDate`\n\nDate and time when the migration period will be disabled. Only necessary when [enabling\nfine-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#AdvancedSecurityOptions.AnonymousAuthDisableDate-fn::getatt" }, "ServiceSoftwareOptions.NewVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions.NewVersion-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe resource ID. For example, `123456789012/my-domain`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the CloudFormation stack.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#Arn-fn::getatt" }, "IdentityCenterOptions.IdentityCenterApplicationARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdentityCenterOptions.IdentityCenterApplicationARN`\n\nThe Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in\n*Using AWS Identity and Access Management* for\nmore information.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#IdentityCenterOptions.IdentityCenterApplicationARN-fn::getatt" }, "ServiceSoftwareOptions.Cancellable": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#ServiceSoftwareOptions.Cancellable-fn::getatt" } } }, "AWS::OpsWorks::App": { "MarkdownDocumentation": "`AWS::OpsWorks::App`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html", "Properties": { "AppSource": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource", "Required": false, "Type": "Source", "UpdateType": "Mutable" }, "Attributes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "DataSources": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources", "DuplicatesAllowed": false, "ItemType": "DataSource", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Description": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Domains": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains", "DuplicatesAllowed": true, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "EnableSsl": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Environment": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment", "DuplicatesAllowed": true, "ItemType": "EnvironmentVariable", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Shortname": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "SslConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration", "Required": false, "Type": "SslConfiguration", "UpdateType": "Mutable" }, "StackId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Type": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::ElasticLoadBalancerAttachment": { "MarkdownDocumentation": "`AWS::OpsWorks::ElasticLoadBalancerAttachment`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html", "Properties": { "ElasticLoadBalancerName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html#cfn-opsworks-elbattachment-elbname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LayerId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html#cfn-opsworks-elbattachment-layerid", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Instance": { "Attributes": { "AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#AvailabilityZone-fn::getatt" }, "PrivateDnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#PrivateDnsName-fn::getatt" }, "PrivateIp": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#PrivateIp-fn::getatt" }, "PublicDnsName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#PublicDnsName-fn::getatt" }, "PublicIp": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#PublicIp-fn::getatt" } }, "MarkdownDocumentation": "`AWS::OpsWorks::Instance`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html", "Properties": { "AgentVersion": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-agentversion", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "AmiId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-amiid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Architecture": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-architecture", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "AutoScalingType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-autoscalingtype", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "AvailabilityZone": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-availabilityzone", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "BlockDeviceMappings": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-blockdevicemappings", "DuplicatesAllowed": false, "ItemType": "BlockDeviceMapping", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "EbsOptimized": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-ebsoptimized", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" }, "ElasticIps": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-elasticips", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Hostname": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-hostname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "InstallUpdatesOnBoot": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-installupdatesonboot", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "InstanceType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-instancetype", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "LayerIds": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-layerids", "DuplicatesAllowed": true, "PrimitiveItemType": "String", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "Os": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-os", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "RootDeviceType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-rootdevicetype", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "SshKeyName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-sshkeyname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "StackId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-stackid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "SubnetId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-subnetid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Tenancy": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-tenancy", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "TimeBasedAutoScaling": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-timebasedautoscaling", "Required": false, "Type": "TimeBasedAutoScaling", "UpdateType": "Immutable" }, "VirtualizationType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-virtualizationtype", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Volumes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-volumes", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Layer": { "MarkdownDocumentation": "`AWS::OpsWorks::Layer`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html", "Properties": { "Attributes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-attributes", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "AutoAssignElasticIps": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignelasticips", "PrimitiveType": "Boolean", "Required": true, "UpdateType": "Mutable" }, "AutoAssignPublicIps": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignpublicips", "PrimitiveType": "Boolean", "Required": true, "UpdateType": "Mutable" }, "CustomInstanceProfileArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-custominstanceprofilearn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "CustomJson": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customjson", "PrimitiveType": "Json", "Required": false, "UpdateType": "Mutable" }, "CustomRecipes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customrecipes", "Required": false, "Type": "Recipes", "UpdateType": "Mutable" }, "CustomSecurityGroupIds": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customsecuritygroupids", "DuplicatesAllowed": true, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "EnableAutoHealing": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-enableautohealing", "PrimitiveType": "Boolean", "Required": true, "UpdateType": "Mutable" }, "InstallUpdatesOnBoot": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-installupdatesonboot", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "LifecycleEventConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-lifecycleeventconfiguration", "Required": false, "Type": "LifecycleEventConfiguration", "UpdateType": "Mutable" }, "LoadBasedAutoScaling": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-loadbasedautoscaling", "Required": false, "Type": "LoadBasedAutoScaling", "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Packages": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-packages", "DuplicatesAllowed": true, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Shortname": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-shortname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "StackId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-stackid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "UseEbsOptimizedInstances": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-useebsoptimizedinstances", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "VolumeConfigurations": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-volumeconfigurations", "DuplicatesAllowed": true, "ItemType": "VolumeConfiguration", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Stack": { "MarkdownDocumentation": "`AWS::OpsWorks::Stack`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html", "Properties": { "AgentVersion": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-agentversion", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Attributes": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-attributes", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "Map", "UpdateType": "Mutable" }, "ChefConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-chefconfiguration", "Required": false, "Type": "ChefConfiguration", "UpdateType": "Mutable" }, "CloneAppIds": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-cloneappids", "DuplicatesAllowed": false, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Immutable" }, "ClonePermissions": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-clonepermissions", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Immutable" }, "ConfigurationManager": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-configmanager", "Required": false, "Type": "StackConfigurationManager", "UpdateType": "Mutable" }, "CustomCookbooksSource": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custcookbooksource", "Required": false, "Type": "Source", "UpdateType": "Mutable" }, "CustomJson": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custjson", "PrimitiveType": "Json", "Required": false, "UpdateType": "Mutable" }, "DefaultAvailabilityZone": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultaz", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DefaultInstanceProfileArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultinstanceprof", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "DefaultOs": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultos", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DefaultRootDeviceType": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultrootdevicetype", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DefaultSshKeyName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultsshkeyname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DefaultSubnetId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#defaultsubnet", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "EcsClusterArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-ecsclusterarn", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ElasticIps": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-elasticips", "DuplicatesAllowed": false, "ItemType": "ElasticIp", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "HostnameTheme": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-hostnametheme", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "RdsDbInstances": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-rdsdbinstances", "DuplicatesAllowed": false, "ItemType": "RdsDbInstance", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "ServiceRoleArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-servicerolearn", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "SourceStackId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-sourcestackid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "UseCustomCookbooks": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#usecustcookbooks", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "UseOpsworksSecurityGroups": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-useopsworkssecuritygroups", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "VpcId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-vpcid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" } } }, "AWS::OpsWorks::UserProfile": { "Attributes": { "SshUsername": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#SshUsername-fn::getatt" } }, "MarkdownDocumentation": "`AWS::OpsWorks::UserProfile`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html", "Properties": { "AllowSelfManagement": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-allowselfmanagement", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "IamUserArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-iamuserarn", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "SshPublicKey": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshpublickey", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "SshUsername": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshusername", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::OpsWorks::Volume": { "MarkdownDocumentation": "`AWS::OpsWorks::Volume`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html", "Properties": { "Ec2VolumeId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-ec2volumeid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "MountPoint": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-mountpoint", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-name", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "StackId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-stackid", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::Organizations::Account": { "MarkdownDocumentation": "`AWS::Organizations::Account`\n\nCreates an AWS account that is automatically a member of the\norganization whose credentials made the request.\nCloudFormation uses the [`CreateAccount`](https://docs.aws.amazon.com/organizations/latest/APIReference/API_CreateAccount.html) operation to create accounts. This is an\nasynchronous request that AWS performs in the background. Because\n`CreateAccount` operates asynchronously, it can return a successful\ncompletion message even though account initialization might still be in progress. You\nmight need to wait a few minutes before you can successfully access the account. To\ncheck the status of the request, do one of the following:\n* Use the `Id` value of the `CreateAccountStatus` response\n element from the `CreateAccount` operation to provide as a parameter\n to the [`DescribeCreateAccountStatus`](https://docs.aws.amazon.com/organizations/latest/APIReference/API_DescribeCreateAccountStatus.html) operation.\n* Check the CloudTrail log for the `CreateAccountResult` event. For\n information on using CloudTrail with AWS Organizations, see [Logging and monitoring in AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration) in the *AWS Organizations User Guide*.\nThe user who calls the API to create an account must have the\n`organizations:CreateAccount` permission. If you enabled all features in\nthe organization, AWS Organizations creates the required service-linked role named\n`AWSServiceRoleForOrganizations`. For more information, see [AWS Organizations and service-linked roles](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs) in the *AWS Organizations User Guide*.\nIf the request includes tags, then the requester must have the\n`organizations:TagResource` permission.\nAWS Organizations preconfigures the new member account with a role (named\n`OrganizationAccountAccessRole` by default) that grants users in the\nmanagement account administrator permissions in the new member account. Principals in\nthe management account can assume the role. AWS Organizations clones the company\nname and address information for the new account from the organization's management\naccount.\nFor more information about creating accounts, see [Creating a\nmember account in your organization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html) in the *AWS Organizations User Guide*.\nThis operation can be called only from the organization's management account.\n**Deleting Account resources**\nThe default `DeletionPolicy` for resource\n`AWS::Organizations::Account` is `Retain`. For more\ninformation about how CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n###### Important\n* If you include multiple accounts in a single template, you must use the\n `DependsOn` attribute on each account resource type so that\n the accounts are created sequentially. If you create multiple accounts at\n the same time, Organizations returns an error and the stack operation\n fails.\n* You can't modify the following list of `Account` resource\n parameters using CloudFormation updates.\n \n + AccountName\n + Email\n + RoleName\n \n If you attempt to update the listed parameters, CloudFormation\n will attempt the update, but you will receive an error message as those\n updates are not supported from an Organizations management account or a\n [registered delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) account. Both the update and\n the update roll-back will fail, so you must skip the account resource\n update. To update parameters `AccountName` and\n `Email`, you must sign in to the AWS Management Console as\n the AWS account root user. For more information, see [Update\n the AWS account name, email address, or password for the\n root user](https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-root-user.html) in the *AWS Account Management Reference\n Guide*.\n* When you create an account in an organization using the AWS Organizations console, API, or AWS CLI commands, we don't\n automatically collect the information required for the account to operate as\n a standalone account. That includes collecting the payment method and\n signing the end user license agreement (EULA). If you must remove an account\n from your organization later, you can do so only after you provide the\n missing information. For more information, see [Considerations before removing an account from an organization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html)\n in the *AWS Organizations User Guide*.\n* When you create an account in an organization using CloudFormation,\n you can't specify a value for the `CreateAccount` operation\n parameter `IamUserAccessToBilling`. The default value for\n parameter `IamUserAccessToBilling` is `ALLOW`, and\n IAM users and roles with the required permissions can\n access billing information for the new account.\n* If you get an exception that indicates `DescribeCreateAccountStatus\n returns IN_PROGRESS state before time out`. You must check the\n account creation status using the [`DescribeCreateAccountStatus`](https://docs.aws.amazon.com/organizations/latest/APIReference/API_DescribeCreateAccountStatus.html) operation. If the\n account state returns as `SUCCEEDED`, you can import the account\n into CloudFormation management using [`resource import`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html).\n* If you get an exception that indicates you have exceeded your account\n quota for the organization, you can request an increase by using the [Service Quotas console](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html).\n* If you get an exception that indicates the operation failed because your\n organization is still initializing, wait one hour and then try again. If the\n error persists, contact [AWS Support](https://console.aws.amazon.com/support/home#/).\n* We don't recommend that you use the `CreateAccount` operation\n to create multiple temporary accounts. You can close accounts using the\n [`CloseAccount`](https://docs.aws.amazon.com/organizations/latest/APIReference/API_CloseAccount.html) operation or from the AWS Organizations console in the organization's management account. For\n information on the requirements and process for closing an account, see\n [Closing a member account in your organization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) in the *AWS Organizations User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `AccountId`. For example:\n`123456789012`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html", "Properties": { "RoleName": { "MarkdownDocumentation": "`RoleName`\n\nThe name of an IAM role that AWS Organizations automatically preconfigures in the new member\naccount. This role trusts the management account, allowing users in the management\naccount to assume the role, as permitted by the management account administrator. The\nrole has administrator permissions in the new member account.\nIf you don't specify this parameter, the role name defaults to\n`OrganizationAccountAccessRole`.\nFor more information about how to use this role to access the member account, see the\nfollowing links:\n* [Creating the OrganizationAccountAccessRole in an invited member\n account](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 [IAM Tutorial:\n Delegate access across AWS accounts using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) in the\n *IAM User Guide*\nThe [regex pattern](http://wikipedia.org/wiki/regex) that\nis used to validate this parameter. The pattern can include uppercase\nletters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w+=,.@-]{1,64}`\n*Minimum*: `1`\n*Maximum*: `64`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#cfn-organizations-account-rolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Email": { "MarkdownDocumentation": "`Email`\n\nThe 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\nstandard internet email address.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[^\\s@]+@[^\\s@]+\\.[^\\s@]+`\n*Minimum*: `6`\n*Maximum*: `64`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#cfn-organizations-account-email", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ParentIds": { "MarkdownDocumentation": "`ParentIds`\n\nThe unique identifier (ID) of the root or organizational unit (OU) that you want to\ncreate the new account in. If you don't specify this parameter, the\n`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\nstring requires one of the following:\n* **Root** - A string that begins with \"r-\" followed\n by from 4 to 32 lowercase letters or digits.\n* **Organizational unit (OU)** - A string that begins\n with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the\n root that the OU is in). This string is followed by a second \"-\" dash and from 8\n to 32 additional lowercase letters or digits.\n*Required*: No\n*Type*: Array of String\n*Pattern*: `^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#cfn-organizations-account-parentids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that you want to attach to the newly created account. For each tag in\nthe list, you must specify both a tag key and a value. You can set the value to an empty\nstring, but you can't set it to `null`. For more information about tagging,\nsee [Tagging AWS Organizations\nresources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n###### Note\nIf any one of the tags is not valid or if you exceed the maximum allowed number of\ntags for an account, then the entire request fails and the account is not\ncreated.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-organizations-account-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#cfn-organizations-account-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AccountName": { "MarkdownDocumentation": "`AccountName`\n\nThe account name given to the account when it was created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\u0020-\\u007E]+`\n*Minimum*: `1`\n*Maximum*: `50`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#cfn-organizations-account-accountname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "JoinedMethod": { "PrimitiveType": "String", "MarkdownDocumentation": "`JoinedMethod`\n\nReturns the method by which the account joined the organization. For example:\n`INVITED | CREATED`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#JoinedMethod-fn::getatt" }, "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nReturns the status of the account in the organization. For example: `ACTIVE |\nSUSPENDED | PENDING_CLOSURE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#Status-fn::getatt" }, "JoinedTimestamp": { "PrimitiveType": "String", "MarkdownDocumentation": "`JoinedTimestamp`\n\nReturns the date the account became a part of the organization. For example:\n`2016-11-24T11:11:48-08:00`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#JoinedTimestamp-fn::getatt" }, "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nReturns the unique identifier (ID) of the account. For example:\n`123456789012`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#AccountId-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nEach state represents a specific phase in the account lifecycle. Use this information\nto manage account access, automate workflows, or trigger actions based on account state\nchanges.\nFor more information about account states and their implications, see [Monitor the state of your AWS accounts](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_account_state.html) in the\n*AWS Organizations User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#State-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the account. For example:\n`arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-account.html#Arn-fn::getatt" } } }, "AWS::Organizations::Organization": { "MarkdownDocumentation": "`AWS::Organizations::Organization`\n\nCreates an AWS organization. The account whose user is calling the\n[`CreateOrganization`](https://docs.aws.amazon.com/organizations/latest/APIReference/API_CreateOrganization.html) operation automatically becomes the\n[management account](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) of the new organization.\nThis operation must be called using credentials from the account that is to become the\nnew organization's management account. The principal must also have the [relevant IAM\npermissions](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_create.html).\n###### Important\n* If you delete an organization, you can't recover it. If you created any\n policies inside of the organization, they're also deleted and you can't\n recover them.\n* You can delete an organization only after you remove all member accounts\n from the organization. If you created some of your member accounts using\n AWS Organizations, you might be blocked from removing those\n accounts. You can remove a member account only if it has all the information\n that's required to operate as a standalone AWS account. For\n more information about how to provide that information and then remove the\n account, see [Leave an organization from your member account](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_leave-as-member.html) in the *AWS Organizations User Guide*.\n* If you closed a member account before you remove it from the organization,\n it enters a 'suspended' state for a period of time and you can't remove the\n account from the organization until it is finally closed. This can take up\n to 90 days and can prevent you from deleting the organization until all\n member accounts are completely closed.\nFor more information, see [Deleting an\norganization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_delete.html) in the *AWS Organizations User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `AccountId`. For example:\n`123456789012`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organization.html", "Properties": { "FeatureSet": { "MarkdownDocumentation": "`FeatureSet`\n\nSpecifies the feature set supported by the new organization. Each feature set supports\ndifferent levels of functionality.\n* `ALL`\u2013 In addition to all the features supported by the\n consolidated billing feature set, the management account gains access to\n advanced features that give you more control over accounts in your organization. For more information, see [All features](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all) in the *AWS Organizations User Guide*.\n* `CONSOLIDATED_BILLING`\u2013 All member accounts have their bills consolidated to and\n paid by the management account. For more information, see [Consolidated billing](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only) in the *AWS Organizations User Guide*.\n \n ###### Note\n \n The consolidated billing feature feature set isn't available for organizations in\n the AWS GovCloud (US) Region.\nIf you don't specify this property, the default value is `ALL`.\n*Required*: No\n*Type*: String\n*Allowed values*: `ALL | CONSOLIDATED_BILLING...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL", "CONSOLIDATED_BILLING" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organization.html#cfn-organizations-organization-featureset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "RootId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RootId`\n\nThe unique identifier (ID) for the root.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organization.html#RootId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier (ID) of an organization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organization.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of an organization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organization.html#Arn-fn::getatt" }, "ManagementAccountArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ManagementAccountArn`\n\nThe Amazon Resource Name (ARN) of the account that is designated as the management\naccount for the organization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organization.html#ManagementAccountArn-fn::getatt" }, "ManagementAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ManagementAccountId`\n\nThe unique identifier (ID) of the management account of an organization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organization.html#ManagementAccountId-fn::getatt" }, "ManagementAccountEmail": { "PrimitiveType": "String", "MarkdownDocumentation": "`ManagementAccountEmail`\n\nThe email address that is associated with the AWS account that is\ndesignated as the management account for the organization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organization.html#ManagementAccountEmail-fn::getatt" } } }, "AWS::Organizations::OrganizationalUnit": { "MarkdownDocumentation": "`AWS::Organizations::OrganizationalUnit`\n\nCreates an organizational unit (OU) within a root or parent OU. An OU is a container\nfor accounts that enables you to organize your accounts to apply policies according to\nyour business requirements. The number of levels deep that you can nest OUs is dependent\nupon the policy types enabled for that root. For service control policies, the limit is\nfive.\nFor more information about OUs, see [Managing organizational units (OUs)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) in the\n*AWS Organizations User Guide*.\nIf the request includes tags, then the requester must have the\n`organizations:TagResource` permission.\nYou can only call this operation from the management account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Id`. For example:\n`ou-examplerootid111-exampleouid111`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html", "Properties": { "ParentId": { "MarkdownDocumentation": "`ParentId`\n\nThe unique identifier (ID) of the parent root or OU that you want to create the new OU\nin.\n###### Important\nTo update the `ParentId` parameter value, you must first remove all\naccounts attached to the organizational unit (OU). OUs can't be moved within the\norganization with accounts still attached.\nThe [regex pattern](http://wikipedia.org/wiki/regex) for a parent ID\nstring requires one of the following:\n* **Root** - A string that begins with \"r-\" followed\n by from 4 to 32 lowercase letters or digits.\n* **Organizational unit (OU)** - A string that begins\n with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the\n root that the OU is in). This string is followed by a second \"-\" dash and from 8\n to 32 additional lowercase letters or digits.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$`\n*Maximum*: `100`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html#cfn-organizations-organizationalunit-parentid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that you want to attach to the newly created OU. For each tag in the\nlist, you must specify both a tag key and a value. You can set the value to an empty\nstring, but you can't set it to `null`. For more information about tagging,\nsee [Tagging AWS Organizations\nresources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n###### Note\nIf any one of the tags is not valid or if you exceed the allowed number of tags\nfor an OU, then the entire request fails and the OU is not created.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-organizations-organizationalunit-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html#cfn-organizations-organizationalunit-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe friendly name of this OU.\nThe [regex pattern](http://wikipedia.org/wiki/regex)\nthat is used to validate this parameter is a string of any of the characters in the ASCII\ncharacter range.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html#cfn-organizations-organizationalunit-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe unique identifier (ID) associated with this OU. For example:\n`ou-examplerootid111-exampleouid111`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of this OU. For example:\n`arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-organizationalunit.html#Arn-fn::getatt" } } }, "AWS::Organizations::Policy": { "MarkdownDocumentation": "`AWS::Organizations::Policy`\n\nCreates a policy of a specified type that you can attach to a root, an organizational\nunit (OU), or an individual AWS account.\nFor more information about policies and their use, see [Managing AWS Organizations\npolicies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html).\nIf the request includes tags, then the requester must have the\n`organizations:TagResource` permission.\nThis operation can be called only from the organization's management account or a member account designated as a delegated administrator.\n###### Note\nBefore you can create a policy of a given type, you must first [enable that policy type](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_enable-disable.html) in your organization.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Id`. For example:\n`p-examplepolicyid111`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of policy to create.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SERVICE_CONTROL_POLICY | AI...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SERVICE_CONTROL_POLICY", "AISERVICES_OPT_OUT_POLICY", "BACKUP_POLICY", "TAG_POLICY", "CHATBOT_POLICY", "RESOURCE_CONTROL_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY", "S3_POLICY", "INSPECTOR_POLICY", "BEDROCK_POLICY", "NETWORK_SECURITY_DIRECTOR_POLICY", "UPGRADE_ROLLOUT_POLICY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetIds": { "MarkdownDocumentation": "`TargetIds`\n\nList of unique identifiers (IDs) of the root, OU, or account that you want to attach\nthe 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)\noperations. If you don't specify this parameter, the policy is created but not attached\nto any organization resource.\nThe [regex pattern](http://wikipedia.org/wiki/regex) for a target ID\nstring requires one of the following:\n* **Root** - A string that begins with \"r-\" followed\n by from 4 to 32 lowercase letters or digits.\n* **Account** - A string that consists of exactly 12\n digits.\n* **Organizational unit (OU)** - A string that begins\n with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the\n root that the OU is in). This string is followed by a second \"-\" dash and from 8\n to 32 additional lowercase letters or digits.\n*Required*: No\n*Type*: Array of String\n*Pattern*: `^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-targetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Description": { "MarkdownDocumentation": "`Description`\n\nHuman readable description of the policy.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe policy text content. You can specify the policy content as a JSON object or a JSON\nstring.\n###### Important\nWhen you specify the policy content as a JSON string, you can't perform drift\ndetection on the CloudFormation stack. For this reason, we recommend\nspecifying the policy content as a JSON object instead.\nThe text that you supply must adhere to the rules of the policy type you specify in\nthe `Type` parameter. The following AWS Organizations quotas are enforced\nfor the maximum size of a policy document:\n* Service control policies: 5,120 characters\n* Resource control policies: 5,120 characters\n* Declarative policies: 10,000 characters\n* Backup policies: 10,000 characters\n* Tag policies: 10,000 characters\n* Chat applications policies: 10,000 characters\n* AI services opt-out policies: 2,500 characters\n* Security Hub policies: 10,000 characters\n* Amazon Inspector policies: 10,000 characters\n* Amazon Bedrock policies: 10,000 characters\n* Upgrade rollout 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\nUser Guide*.\n*Required*: Yes\n*Type*: Json\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `1`\n*Maximum*: `1000000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-content", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that you want to attach to the newly created policy. For each tag in\nthe list, you must specify both a tag key and a value. You can set the value to an empty\nstring, but you can't set it to `null`. For more information about tagging,\nsee [Tagging AWS Organizations\nresources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.\n###### Note\nIf any one of the tags is not valid or if you exceed the allowed number of tags\nfor a policy, then the entire request fails and the policy is not created.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-organizations-policy-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the policy.\nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to\nvalidate this parameter is a string of any of the characters in the ASCII character\nrange.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\s\\S]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nReturns the unique identifier (ID) of the policy. For example:\n`p-examplepolicyid111`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the policy. For example:\n`arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#Arn-fn::getatt" }, "AwsManaged": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`AwsManaged`\n\nReturns a boolean value that indicates whether the specified policy is an AWS managed\npolicy. If true, then you can attach the policy to roots, OUs, or accounts, but you\ncannot edit it. For example: `true | false`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#AwsManaged-fn::getatt" } } }, "AWS::Organizations::ResourcePolicy": { "MarkdownDocumentation": "`AWS::Organizations::ResourcePolicy`\n\nCreates or updates a resource-based delegation policy that can be used to delegate\npolicy management for AWS Organizations to specified member accounts to perform\npolicy actions that are by default available only to the management account.\nFor more information about delegated policy management, see [Delegated\nadministrator for AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_delegate_policies.html) in the *AWS Organizations User Guide*.\nYou can only call this operation from the organization's management account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Id`. For example:\n`rp-examplepolicyid111`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-resourcepolicy.html", "Properties": { "Content": { "MarkdownDocumentation": "`Content`\n\nThe policy text of the organization resource policy. You can specify the resource\npolicy content as a JSON object or a JSON string.\n###### Important\nWhen you specify the resource policy content as a JSON string, you can't perform\ndrift detection on the CloudFormation stack. For this reason, we recommend\nspecifying the resource policy content as a JSON object instead.\n*Required*: Yes\n*Type*: Json\n*Pattern*: `[\\s\\S]*`\n*Minimum*: `1`\n*Maximum*: `40000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-resourcepolicy.html#cfn-organizations-resourcepolicy-content", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags that you want to attach to the newly created resource policy. For each\ntag in the list, you must specify both a tag key and a value. You can set the value to\nan empty string, but you can't set it to `null`. For more information about\ntagging, see [Tagging AWS Organizations\nresources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the *AWS Organizations User\nGuide*.\n###### Note\nIf any one of the tags is not valid or if you exceed the allowed number of tags\nfor the resource policy, then the entire request fails and the resource policy is\nnot created.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-organizations-resourcepolicy-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-resourcepolicy.html#cfn-organizations-resourcepolicy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nReturns the unique identifier (ID) of the resource policy. For example:\n`rp-examplepolicyid111`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-resourcepolicy.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the policy. For example:\n`arn:aws:organizations::111111111111:resourcepolicy/o-exampleorgid/rp-examplepolicyid111`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-resourcepolicy.html#Arn-fn::getatt" } } }, "AWS::PCAConnectorAD::Connector": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Connector`\n\nCreates a connector between AWS Private CA and an Active Directory. You must specify the private CA,\ndirectory ID, and security groups.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-connector.html", "Properties": { "CertificateAuthorityArn": { "MarkdownDocumentation": "`CertificateAuthorityArn`\n\nThe Amazon Resource Name (ARN) of the certificate authority being used.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:acm-pca:[\\w-]+:[0-9]+:certificate-authority\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$`\n*Minimum*: `5`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-connector.html#cfn-pcaconnectorad-connector-certificateauthorityarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DirectoryId": { "MarkdownDocumentation": "`DirectoryId`\n\nThe identifier of the Active Directory.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-connector.html#cfn-pcaconnectorad-connector-directoryid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcInformation": { "MarkdownDocumentation": "`VpcInformation`\n\nInformation of the VPC and security group(s) used with the connector.\n*Required*: Yes\n*Type*: [VpcInformation](./aws-properties-pcaconnectorad-connector-vpcinformation.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-connector.html#cfn-pcaconnectorad-connector-vpcinformation", "UpdateType": "Immutable", "Required": true, "Type": "VpcInformation" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata assigned to a connector consisting of a key-value pair.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-connector.html#cfn-pcaconnectorad-connector-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "ConnectorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectorArn`\n\nThe Amazon Resource Name (ARN) that was returned when you called [CreateConnector](https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-connector.html#ConnectorArn-fn::getatt" } } }, "AWS::PCAConnectorAD::DirectoryRegistration": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::DirectoryRegistration`\n\nCreates a directory registration that authorizes communication between AWS Private CA and an\nActive Directory\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-directoryregistration.html", "Properties": { "DirectoryId": { "MarkdownDocumentation": "`DirectoryId`\n\nThe identifier of the Active Directory.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-directoryregistration.html#cfn-pcaconnectorad-directoryregistration-directoryid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata assigned to a directory registration consisting of a key-value pair.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-directoryregistration.html#cfn-pcaconnectorad-directoryregistration-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "DirectoryRegistrationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DirectoryRegistrationArn`\n\nThe Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration](https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) .\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-directoryregistration.html#DirectoryRegistrationArn-fn::getatt" } } }, "AWS::PCAConnectorAD::ServicePrincipalName": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::ServicePrincipalName`\n\nCreates a service principal name (SPN) for the service account in Active Directory. Kerberos\nauthentication uses SPNs to associate a service instance with a service sign-in\naccount.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-serviceprincipalname.html", "Properties": { "ConnectorArn": { "MarkdownDocumentation": "`ConnectorArn`\n\nThe Amazon Resource Name (ARN) that was returned when you called [CreateConnector.html](https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector(\\/[\\w-]+)$`\n*Minimum*: `5`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-serviceprincipalname.html#cfn-pcaconnectorad-serviceprincipalname-connectorarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DirectoryRegistrationArn": { "MarkdownDocumentation": "`DirectoryRegistrationArn`\n\nThe Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration](https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:directory-registration(\\/[\\w-]+)$`\n*Minimum*: `5`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-serviceprincipalname.html#cfn-pcaconnectorad-serviceprincipalname-directoryregistrationarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCAConnectorAD::Template": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::Template`\n\nCreates an Active Directory compatible certificate template. The connectors issues certificates\nusing these templates based on the requester\u2019s Active Directory group membership.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-template.html", "Properties": { "ConnectorArn": { "MarkdownDocumentation": "`ConnectorArn`\n\nThe Amazon Resource Name (ARN) that was returned when you called [CreateConnector](https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$`\n*Minimum*: `5`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-template.html#cfn-pcaconnectorad-template-connectorarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nTemplate configuration to define the information included in certificates. Define\ncertificate validity and renewal periods, certificate request handling and enrollment\noptions, key usage extensions, application policies, and cryptography settings.\n*Required*: Yes\n*Type*: [TemplateDefinition](./aws-properties-pcaconnectorad-template-templatedefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-template.html#cfn-pcaconnectorad-template-definition", "UpdateType": "Mutable", "Required": true, "Type": "TemplateDefinition" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata assigned to a template consisting of a key-value pair.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-template.html#cfn-pcaconnectorad-template-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the templates. Template names must be unique.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-template.html#cfn-pcaconnectorad-template-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ReenrollAllCertificateHolders": { "MarkdownDocumentation": "`ReenrollAllCertificateHolders`\n\nThis setting allows the major version of a template to be increased automatically. All\nmembers of Active Directory groups that are allowed to enroll with a template will\nreceive a new certificate issued using that template.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-template.html#cfn-pcaconnectorad-template-reenrollallcertificateholders", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "TemplateArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TemplateArn`\n\nThe Amazon Resource Name (ARN) that was returned when you called [CreateTemplate](https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) .\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-template.html#TemplateArn-fn::getatt" } } }, "AWS::PCAConnectorAD::TemplateGroupAccessControlEntry": { "MarkdownDocumentation": "`AWS::PCAConnectorAD::TemplateGroupAccessControlEntry`\n\nCreate a group access control entry. Allow or deny Active Directory groups from enrolling and/or\nautoenrolling with the template based on the group security identifiers (SIDs).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-templategroupaccesscontrolentry.html", "Properties": { "AccessRights": { "MarkdownDocumentation": "`AccessRights`\n\nPermissions to allow or deny an Active Directory group to enroll or autoenroll certificates issued\nagainst a template.\n*Required*: Yes\n*Type*: [AccessRights](./aws-properties-pcaconnectorad-templategroupaccesscontrolentry-accessrights.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-templategroupaccesscontrolentry.html#cfn-pcaconnectorad-templategroupaccesscontrolentry-accessrights", "UpdateType": "Mutable", "Required": true, "Type": "AccessRights" }, "TemplateArn": { "MarkdownDocumentation": "`TemplateArn`\n\nThe Amazon Resource Name (ARN) that was returned when you called [CreateTemplate](https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html).\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector(\\/[\\w-]+)\\/template(\\/[\\w-]+)$`\n*Minimum*: `5`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-templategroupaccesscontrolentry.html#cfn-pcaconnectorad-templategroupaccesscontrolentry-templatearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "GroupDisplayName": { "MarkdownDocumentation": "`GroupDisplayName`\n\nName of the Active Directory group. This name does not need to match the group name in Active Directory.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\x20-\\x7E]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-templategroupaccesscontrolentry.html#cfn-pcaconnectorad-templategroupaccesscontrolentry-groupdisplayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "GroupSecurityIdentifier": { "MarkdownDocumentation": "`GroupSecurityIdentifier`\n\nSecurity identifier (SID) of the group object from Active Directory. The SID starts with\n\"S-\".\n*Required*: No\n*Type*: String\n*Pattern*: `^S-[0-9]-([0-9]+-){1,14}[0-9]+$`\n*Minimum*: `7`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorad-templategroupaccesscontrolentry.html#cfn-pcaconnectorad-templategroupaccesscontrolentry-groupsecurityidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PCAConnectorSCEP::Challenge": { "MarkdownDocumentation": "`AWS::PCAConnectorSCEP::Challenge`\n\nFor general-purpose connectors. Creates a *challenge password* for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call [ListConnectors](https://docs.aws.amazon.com/pca-connector-scep/latest/APIReference/API_ListConnectors.html).\nTo create additional challenge passwords for the connector, call `CreateChallenge` again. We recommend frequently rotating your challenge passwords.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html", "Properties": { "ConnectorArn": { "MarkdownDocumentation": "`ConnectorArn`\n\nThe Amazon Resource Name (ARN) of the connector.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\\d*:\\d{12}:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$`\n*Minimum*: `5`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html#cfn-pcaconnectorscep-challenge-connectorarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html#cfn-pcaconnectorscep-challenge-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "ChallengeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ChallengeArn`\n\nThe Amazon Resource Name (ARN) of the challenge.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html#ChallengeArn-fn::getatt" } } }, "AWS::PCAConnectorSCEP::Connector": { "MarkdownDocumentation": "`AWS::PCAConnectorSCEP::Connector`\n\nConnector for SCEP is a service that links AWS Private Certificate Authority to your SCEP-enabled devices. The connector brokers the exchange of certificates from AWS Private CA to your SCEP-enabled devices and mobile device management systems. The connector is a complex type that contains the connector's configuration settings.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html", "Properties": { "CertificateAuthorityArn": { "MarkdownDocumentation": "`CertificateAuthorityArn`\n\nThe Amazon Resource Name (ARN) of the certificate authority associated with the connector.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[a-z]+)*:acm-pca:[a-z]+(-[a-z]+)+-[1-9]\\d*:\\d{12}:certificate-authority\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$`\n*Minimum*: `5`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-certificateauthorityarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MobileDeviceManagement": { "MarkdownDocumentation": "`MobileDeviceManagement`\n\nContains settings relevant to the mobile device management system that you chose for the connector. If you didn't configure `MobileDeviceManagement`, then the connector is for general-purpose use and this object is empty.\n*Required*: No\n*Type*: [MobileDeviceManagement](./aws-properties-pcaconnectorscep-connector-mobiledevicemanagement.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-mobiledevicemanagement", "UpdateType": "Immutable", "Required": false, "Type": "MobileDeviceManagement" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "ConnectorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectorArn`\n\nThe Amazon Resource Name (ARN) of the connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#ConnectorArn-fn::getatt" }, "OpenIdConfiguration.Audience": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#OpenIdConfiguration.Audience-fn::getatt" }, "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nThe connector type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#Type-fn::getatt" }, "OpenIdConfiguration.Issuer": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#OpenIdConfiguration.Issuer-fn::getatt" }, "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe connector's HTTPS public SCEP URL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#Endpoint-fn::getatt" }, "OpenIdConfiguration": { "Type": "OpenIdConfiguration", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#OpenIdConfiguration-fn::getatt" }, "OpenIdConfiguration.Subject": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#OpenIdConfiguration.Subject-fn::getatt" } } }, "AWS::PCS::Cluster": { "MarkdownDocumentation": "`AWS::PCS::Cluster`\n\nCreates an AWS PCS cluster resource. For more information, see\n[Creating a cluster\nin AWS Parallel Computing Service](https://docs.aws.amazon.com/pcs/latest/userguide/working-with_clusters_create.html) in the *AWS PCS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html", "Properties": { "Networking": { "MarkdownDocumentation": "`Networking`\n\nThe networking configuration for the cluster's control plane.\n*Required*: Yes\n*Type*: [Networking](./aws-properties-pcs-cluster-networking.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-networking", "UpdateType": "Immutable", "Required": true, "Type": "Networking" }, "Scheduler": { "MarkdownDocumentation": "`Scheduler`\n\nThe cluster management and job scheduling software associated with the cluster.\n*Required*: Yes\n*Type*: [Scheduler](./aws-properties-pcs-cluster-scheduler.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-scheduler", "UpdateType": "Immutable", "Required": true, "Type": "Scheduler" }, "Size": { "MarkdownDocumentation": "`Size`\n\nThe size of the cluster.\n* `SMALL`: 32 compute nodes and 256 jobs\n* `MEDIUM`: 512 compute nodes and 8192 jobs\n* `LARGE`: 2048 compute nodes and 16,384 jobs\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SMALL | MEDIUM | LARGE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SMALL", "MEDIUM", "LARGE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-size", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SlurmConfiguration": { "MarkdownDocumentation": "`SlurmConfiguration`\n\nAdditional options related to the Slurm scheduler.\n*Required*: No\n*Type*: [SlurmConfiguration](./aws-properties-pcs-cluster-slurmconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-slurmconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SlurmConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\n1 or more tags added to the resource. Each tag consists of a tag key and tag value. The\ntag value is optional and can be an empty string.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name that identifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Endpoints": { "Type": "List", "ItemType": "Endpoint", "MarkdownDocumentation": "`Endpoints`\n\nThe list of endpoints available for interaction with the scheduler.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#Endpoints-fn::getatt" }, "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe provisioning status of the cluster.\n###### Note\nThe provisioning status doesn't indicate the overall health of the cluster.\n\n###### Important\nThe resource enters the `SUSPENDING` and `SUSPENDED` states\nwhen the scheduler is beyond end of life and we have suspended the cluster. When in\nthese states, you can't use the cluster. The cluster controller is down and all compute\ninstances are terminated. The resources still count toward your service quotas. You can\ndelete a resource if its status is `SUSPENDED`. For more information, see\n[Frequently asked questions about Slurm versions in AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/slurm-versions_faq.html) in the\n*AWS PCS User Guide*.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#Status-fn::getatt" }, "ErrorInfo": { "Type": "List", "ItemType": "ErrorInfo", "MarkdownDocumentation": "`ErrorInfo`\n\nThe list of errors that occurred during cluster provisioning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#ErrorInfo-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe generated unique ID of the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique Amazon Resource Name (ARN) of the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#Arn-fn::getatt" } } }, "AWS::PCS::ComputeNodeGroup": { "MarkdownDocumentation": "`AWS::PCS::ComputeNodeGroup`\n\nCreates an AWS PCS compute node group resource. For more information, see\n[Creating a compute node group\nin AWS PCS](https://docs.aws.amazon.com/pcs/latest/userguide/working-with_cng_create.html) in the *AWS PCS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html", "Properties": { "ClusterId": { "MarkdownDocumentation": "`ClusterId`\n\nThe ID of the cluster of the compute node 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-clusterid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SpotOptions": { "MarkdownDocumentation": "`SpotOptions`\n\nAdditional configuration when you specify `SPOT` as the\n`purchaseOption` for the `CreateComputeNodeGroup` API\naction.\n*Required*: No\n*Type*: [SpotOptions](./aws-properties-pcs-computenodegroup-spotoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-spotoptions", "UpdateType": "Mutable", "Required": false, "Type": "SpotOptions" }, "SlurmConfiguration": { "MarkdownDocumentation": "`SlurmConfiguration`\n\nAdditional options related to the Slurm scheduler.\n*Required*: No\n*Type*: [SlurmConfiguration](./aws-properties-pcs-computenodegroup-slurmconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-slurmconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SlurmConfiguration" }, "ScalingConfiguration": { "MarkdownDocumentation": "`ScalingConfiguration`\n\nSpecifies the boundaries of the compute node group auto scaling.\n*Required*: Yes\n*Type*: [ScalingConfiguration](./aws-properties-pcs-computenodegroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-scalingconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ScalingConfiguration" }, "InstanceConfigs": { "MarkdownDocumentation": "`InstanceConfigs`\n\nA list of EC2 instance configurations that AWS PCS can provision in the compute node group.\n*Required*: Yes\n*Type*: Array of [InstanceConfig](./aws-properties-pcs-computenodegroup-instanceconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-instanceconfigs", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "InstanceConfig", "DuplicatesAllowed": true }, "PurchaseOption": { "MarkdownDocumentation": "`PurchaseOption`\n\nSpecifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand Instances, Spot Instances,\nand Amazon EC2 Capacity Blocks for ML. For more information, see [Amazon EC2 billing and purchasing options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html) in the *Amazon Elastic Compute Cloud User\nGuide*. For more information about AWS PCS support for\nCapacity Blocks, see [Using Amazon EC2 Capacity\nBlocks for ML with AWS PCS](https://docs.aws.amazon.com/pcs/latest/userguide/capacity-blocks.html)\nin the *AWS PCS User Guide*.\nIf you don't provide this option, it defaults to On-Demand.\n*Required*: No\n*Type*: String\n*Allowed values*: `ONDEMAND | SPOT | CAPACITY_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ONDEMAND", "SPOT", "CAPACITY_BLOCK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-purchaseoption", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomLaunchTemplate": { "MarkdownDocumentation": "`CustomLaunchTemplate`\n\nAn Amazon EC2 launch template AWS PCS uses to launch compute\nnodes.\n*Required*: Yes\n*Type*: [CustomLaunchTemplate](./aws-properties-pcs-computenodegroup-customlaunchtemplate.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-customlaunchtemplate", "UpdateType": "Mutable", "Required": true, "Type": "CustomLaunchTemplate" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe list of subnet IDs where instances are provisioned by the compute node group. The\nsubnets must be in the same VPC as the cluster.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\n1 or more tags added to the resource. Each tag consists of a tag key and tag value. The\ntag value is optional and can be an empty string.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name that identifies the compute 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AmiId": { "MarkdownDocumentation": "`AmiId`\n\nThe ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch\ninstances. If not provided, AWS PCS uses the AMI ID specified in the custom\nlaunch template.\n*Required*: No\n*Type*: String\n*Pattern*: `^ami-[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-amiid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamInstanceProfileArn": { "MarkdownDocumentation": "`IamInstanceProfileArn`\n\nThe Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when\nlaunching EC2 instances. The role contained in your instance profile must have the\n`pcs:RegisterComputeNodeGroupInstance` permission and the role name must\nstart with `AWSPCS` or must have the path `/aws-pcs/`. For more\ninformation, see [IAM instance profiles for\nAWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/security-instance-profiles.html) in the *AWS PCS User\nGuide*.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/.{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-iaminstanceprofilearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe provisioning status of the compute node group.\n###### Note\nThe provisioning status doesn't indicate the overall health of the compute node\ngroup.\n\n###### Important\nThe resource enters the `SUSPENDING` and `SUSPENDED` states\nwhen the scheduler is beyond end of life and we have suspended the cluster. When in\nthese states, you can't use the cluster. The cluster controller is down and all compute\ninstances are terminated. The resources still count toward your service quotas. You can\ndelete a resource if its status is `SUSPENDED`. For more information, see\n[Frequently asked questions about Slurm versions in AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/slurm-versions_faq.html) in the\n*AWS PCS User Guide*.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#Status-fn::getatt" }, "ErrorInfo": { "Type": "List", "ItemType": "ErrorInfo", "MarkdownDocumentation": "`ErrorInfo`\n\nThe list of errors that occurred during compute node group provisioning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#ErrorInfo-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe generated unique ID of the compute node group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique Amazon Resource Name (ARN) of the compute node group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#Arn-fn::getatt" } } }, "AWS::PCS::Queue": { "MarkdownDocumentation": "`AWS::PCS::Queue`\n\nCreates an AWS PCS queue resource. For more information, see\n[Creating a queue\nin AWS PCS](https://docs.aws.amazon.com/pcs/latest/userguide/working-with_queues_create.html) in the *AWS PCS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html", "Properties": { "ClusterId": { "MarkdownDocumentation": "`ClusterId`\n\nThe ID of the cluster of the queue.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-clusterid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ComputeNodeGroupConfigurations": { "MarkdownDocumentation": "`ComputeNodeGroupConfigurations`\n\nThe list of compute node group configurations associated with the queue. Queues assign\njobs to associated compute node groups.\n*Required*: No\n*Type*: Array of [ComputeNodeGroupConfiguration](./aws-properties-pcs-queue-computenodegroupconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-computenodegroupconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ComputeNodeGroupConfiguration", "DuplicatesAllowed": true }, "SlurmConfiguration": { "MarkdownDocumentation": "`SlurmConfiguration`\n\nAdditional options related to the Slurm scheduler.\n*Required*: No\n*Type*: [SlurmConfiguration](./aws-properties-pcs-queue-slurmconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-slurmconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SlurmConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\n1 or more tags added to the resource. Each tag consists of a tag key and tag value. The\ntag value is optional and can be an empty string.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name that identifies the queue.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe provisioning status of the queue.\n###### Note\nThe provisioning status doesn't indicate the overall health of the queue.\n\n###### Important\nThe resource enters the `SUSPENDING` and `SUSPENDED` states\nwhen the scheduler is beyond end of life and we have suspended the cluster. When in\nthese states, you can't use the cluster. The cluster controller is down and all compute\ninstances are terminated. The resources still count toward your service quotas. You can\ndelete a resource if its status is `SUSPENDED`. For more information, see\n[Frequently asked questions about Slurm versions in AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/slurm-versions_faq.html) in the\n*AWS PCS User Guide*.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#Status-fn::getatt" }, "ErrorInfo": { "Type": "List", "ItemType": "ErrorInfo", "MarkdownDocumentation": "`ErrorInfo`\n\nThe list of errors that occurred during queue provisioning.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#ErrorInfo-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe generated unique ID of the queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique Amazon Resource Name (ARN) of the queue.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#Arn-fn::getatt" } } }, "AWS::PaymentCryptography::Alias": { "MarkdownDocumentation": "`AWS::PaymentCryptography::Alias`\n\nCreates an *alias*, or a friendly name, for an AWS Payment Cryptography key. You can\nuse an alias to identify a key in the console and when you call cryptographic operations\nsuch as [EncryptData](https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_EncryptData.html) or [DecryptData](https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_DecryptData.html).\nYou can associate the alias with any key in the same AWS Region. Each\nalias is associated with only one key at a time, but a key can have multiple aliases. You\ncan't create an alias without a key. The alias must be unique in the account and AWS Region, but you can create another alias with the same name in a different\nAWS Region.\nTo change the key that's associated with the alias, call [UpdateAlias](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html).\nTo delete the alias, call [DeleteAlias](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html).\nThese operations don't affect the underlying key. To get the alias that you created, call\n[ListAliases](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html).\n**Cross-account use**: This operation can't be used across different AWS accounts.\n**Related operations:**\n* [DeleteAlias](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html)\n* [GetAlias](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html)\n* [ListAliases](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html)\n* [UpdateAlias](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-alias.html", "Properties": { "AliasName": { "MarkdownDocumentation": "`AliasName`\n\nA friendly name that you can use to refer to a key. The value must begin with\n`alias/`.\n###### Important\nDo not include confidential or sensitive information in this field. This field may be displayed in plaintext in AWS CloudTrail logs and other output.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^alias/[a-zA-Z0-9/_-]+$`\n*Minimum*: `7`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-alias.html#cfn-paymentcryptography-alias-aliasname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KeyArn": { "MarkdownDocumentation": "`KeyArn`\n\nThe `KeyARN` of the key associated with the alias.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$`\n*Minimum*: `70`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-alias.html#cfn-paymentcryptography-alias-keyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::PaymentCryptography::Key": { "MarkdownDocumentation": "`AWS::PaymentCryptography::Key`\n\nCreates an AWS Payment Cryptography key, a logical representation of a cryptographic key, that is\nunique in your account and AWS Region. You use keys for cryptographic\nfunctions such as encryption and decryption.\nIn addition to the key material used in cryptographic operations, an AWS Payment Cryptography key\nincludes metadata such as the key ARN, key usage, key origin, creation date, description,\nand key state.\nWhen you create a key, you specify both immutable and mutable data about the key. The\nimmutable data contains key attributes that define the scope and cryptographic operations\nthat you can perform using the key, for example key class (example:\n`SYMMETRIC_KEY`), key algorithm (example: `TDES_2KEY`), key usage\n(example: `TR31_P0_PIN_ENCRYPTION_KEY`) and key modes of use (example:\n`Encrypt`). AWS Payment Cryptography binds key attributes to keys using key blocks when you\nstore or export them. AWS Payment Cryptography stores the key contents wrapped and never stores or\ntransmits them in the clear.\nFor information about valid combinations of key attributes, see [Understanding key\nattributes](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) in the *AWS Payment Cryptography User Guide*. The mutable data\ncontained within a key includes usage timestamp and key deletion timestamp and can be\nmodified after creation.\nYou can use the `CreateKey` operation to generate an ECC (Elliptic Curve\nCryptography) key pair used for establishing an ECDH (Elliptic Curve Diffie-Hellman) key\nagreement between two parties. In the ECDH key agreement process, both parties generate\ntheir own ECC key pair with key usage K3 and exchange the public keys. Each party then use\ntheir private key, the received public key from the other party, and the key derivation\nparameters including key derivation function, hash algorithm, derivation data, and key\nalgorithm to derive a shared key.\nTo maintain the single-use principle of cryptographic keys in payments, ECDH derived\nkeys should not be used for multiple purposes, such as a\n`TR31_P0_PIN_ENCRYPTION_KEY` and\n`TR31_K1_KEY_BLOCK_PROTECTION_KEY`. When creating ECC key pairs in AWS Payment Cryptography\nyou can optionally set the `DeriveKeyUsage` parameter, which defines the key\nusage bound to the symmetric key that will be derived using the ECC key pair.\n**Cross-account use**: This operation can't be used across different AWS accounts.\n**Related operations:**\n* [DeleteKey](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html)\n* [GetKey](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html)\n* [ListKeys](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html", "Properties": { "DeriveKeyUsage": { "MarkdownDocumentation": "`DeriveKeyUsage`\n\nThe cryptographic usage of an ECDH derived key as de\ufb01ned in section A.5.2 of the TR-31\nspec.\n*Required*: No\n*Type*: String\n*Allowed values*: `TR31_B0_BASE_DERIVATION_KEY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS", "TR31_E1_EMV_MKEY_CONFIDENTIALITY", "TR31_E2_EMV_MKEY_INTEGRITY", "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS", "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION", "TR31_E6_EMV_MKEY_OTHER", "TR31_K0_KEY_ENCRYPTION_KEY", "TR31_K1_KEY_BLOCK_PROTECTION_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-derivekeyusage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Exportable": { "MarkdownDocumentation": "`Exportable`\n\nSpecifies whether the key is exportable. This data is immutable after the key is\ncreated.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-exportable", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Boolean" }, "ReplicationRegions": { "MarkdownDocumentation": "`ReplicationRegions`\n\nThe list of AWS Regions to remove from the key's replication configuration.\nThe key will no longer be available for cryptographic operations in these regions after\nremoval. Ensure no active operations depend on the key in these regions before\nremoval.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-replicationregions", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "KeyAttributes": { "MarkdownDocumentation": "`KeyAttributes`\n\nThe role of the key, the algorithm it supports, and the cryptographic operations allowed\nwith the key. This data is immutable after the key is created.\n*Required*: Yes\n*Type*: [KeyAttributes](./aws-properties-paymentcryptography-key-keyattributes.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-keyattributes", "UpdateType": "Mutable", "Required": true, "Type": "KeyAttributes" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies whether the key 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "KeyCheckValueAlgorithm": { "MarkdownDocumentation": "`KeyCheckValueAlgorithm`\n\nThe algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV). It is used to\nvalidate the key integrity.\nFor TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.\n*Required*: No\n*Type*: String\n*Allowed values*: `CMAC | ANSI_X9_24 | HMAC | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CMAC", "ANSI_X9_24", "HMAC", "SHA_1" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-keycheckvaluealgorithm", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-paymentcryptography-key-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#cfn-paymentcryptography-key-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "KeyIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`KeyIdentifier`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#KeyIdentifier-fn::getatt" }, "ReplicationStatus": { "Type": "Map", "ItemType": "ReplicationStatusType", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#ReplicationStatus-fn::getatt" }, "KeyState": { "PrimitiveType": "String", "MarkdownDocumentation": "`KeyState`\n\nThe state of key that is being created or deleted.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#KeyState-fn::getatt" }, "KeyOrigin": { "PrimitiveType": "String", "MarkdownDocumentation": "`KeyOrigin`\n\nThe source of the key material. For keys created within AWS Payment Cryptography, the value is\n`AWS_PAYMENT_CRYPTOGRAPHY`. For keys imported into AWS Payment Cryptography, the value is\n`EXTERNAL`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-paymentcryptography-key.html#KeyOrigin-fn::getatt" } } }, "AWS::Personalize::Dataset": { "MarkdownDocumentation": "`AWS::Personalize::Dataset`\n\nCreates an empty dataset and adds it to the specified dataset group.\nUse [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) to import your training data to a\ndataset.\nThere are 5 types of datasets:\n* Item interactions\n* Items\n* Users\n* Action interactions (you can't use CloudFormation to create an Action interactions dataset)\n* Actions (you can't use CloudFormation to create an Actions dataset)\nEach dataset type has an associated schema with required field types.\nOnly the `Item interactions` dataset is required in order to train a\nmodel (also referred to as creating a solution).\nA dataset can be in one of the following states:\n* CREATE PENDING > CREATE IN\\_PROGRESS > ACTIVE -or- CREATE\n FAILED\n* DELETE PENDING > DELETE IN\\_PROGRESS\nTo get the status of the dataset, call [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html).\n###### Related APIs\n* [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)\n* [ListDatasets](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html)\n* [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html)\n* [DeleteDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the resource.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html", "Properties": { "DatasetGroupArn": { "MarkdownDocumentation": "`DatasetGroupArn`\n\nThe Amazon Resource Name (ARN) of the dataset group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasetgrouparn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DatasetType": { "MarkdownDocumentation": "`DatasetType`\n\nOne of the following values:\n* Interactions\n* Items\n* Users\n###### Note\nYou can't use CloudFormation to create an Action Interactions or Actions dataset.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Interactions | Items | User...`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Interactions", "Items", "Users" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasettype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DatasetImportJob": { "MarkdownDocumentation": "`DatasetImportJob`\n\nDescribes a job that imports training data from a data source (Amazon S3 bucket) to an\nAmazon Personalize dataset. If you specify a dataset import job as part of a dataset, all\ndataset import job fields are required.\n*Required*: No\n*Type*: [DatasetImportJob](./aws-properties-personalize-dataset-datasetimportjob.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasetimportjob", "UpdateType": "Mutable", "Required": false, "Type": "DatasetImportJob" }, "SchemaArn": { "MarkdownDocumentation": "`SchemaArn`\n\nThe ARN of the associated schema.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-schemaarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the dataset.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\\-_]*`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DatasetArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatasetArn`\n\nThe Amazon Resource Name (ARN) of the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#DatasetArn-fn::getatt" } } }, "AWS::Personalize::DatasetGroup": { "MarkdownDocumentation": "`AWS::Personalize::DatasetGroup`\n\nA dataset group is a collection of related datasets (Item interactions,\nUsers, Items, Actions, Action interactions). You create a dataset group by calling [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html). You then create a dataset and add it to a\ndataset group by calling [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). The dataset group is used to create and train a\nsolution by calling [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html). A dataset group can contain only one of each\ntype of dataset.\nYou can specify an AWS Key Management Service (KMS) key to encrypt the datasets in\nthe group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the resource.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to\nencrypt the datasets.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe domain of a Domain dataset group.\n*Required*: No\n*Type*: String\n*Allowed values*: `ECOMMERCE | VIDEO_ON_DEMAND...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ECOMMERCE", "VIDEO_ON_DEMAND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-domain", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the AWS Identity and Access Management (IAM) role that has permissions to access\nthe AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also\nspecifying a KMS key.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-rolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the dataset group.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\\-_]*`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#cfn-personalize-datasetgroup-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DatasetGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DatasetGroupArn`\n\nThe Amazon Resource Name (ARN) of the dataset group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-datasetgroup.html#DatasetGroupArn-fn::getatt" } } }, "AWS::Personalize::Schema": { "MarkdownDocumentation": "`AWS::Personalize::Schema`\n\nCreates an Amazon Personalize schema from the specified schema string. The schema you create\nmust be in Avro JSON format.\nAmazon Personalize recognizes three schema variants. Each schema is associated with a dataset\ntype and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you\nprovide the domain of the Domain dataset group.\nYou specify a schema when you call [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).\nFor more information on schemas, see\n[Datasets and schemas](https://docs.aws.amazon.com/personalize/latest/dg/how-it-works-dataset-schema.html).\n###### Related APIs\n* [ListSchemas](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html)\n* [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html)\n* [DeleteSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the resource.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html", "Properties": { "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe schema.\n*Required*: Yes\n*Type*: String\n*Maximum*: `10000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html#cfn-personalize-schema-schema", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe domain of a schema that you created for a dataset in a Domain dataset group.\n*Required*: No\n*Type*: String\n*Allowed values*: `ECOMMERCE | VIDEO_ON_DEMAND...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ECOMMERCE", "VIDEO_ON_DEMAND" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html#cfn-personalize-schema-domain", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the schema.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\\-_]*`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html#cfn-personalize-schema-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "SchemaArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SchemaArn`\n\nThe Amazon Resource Name (ARN) of the schema.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html#SchemaArn-fn::getatt" } } }, "AWS::Personalize::Solution": { "MarkdownDocumentation": "`AWS::Personalize::Solution`\n\n###### Important\nBy default, all new solutions use automatic training. With automatic training, you incur training costs while\nyour solution is active. To avoid unnecessary costs, when you are finished you can\n[update the solution](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html) to turn off automatic training.\nFor information about training\ncosts, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).\nAn object that provides information about a solution. A solution includes the custom recipe, customized parameters, and\ntrained models (Solution Versions) that Amazon Personalize uses to generate recommendations.\nAfter you create a solution, you can\u2019t change its configuration. If you need to make changes, you can [clone the solution](https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html) with the Amazon Personalize console\nor create a new one.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the resource.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html", "Properties": { "PerformAutoML": { "MarkdownDocumentation": "`PerformAutoML`\n\n###### Important\nWe don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize\nrecipes. 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\nthe list specified in the solution configuration (`recipeArn` must not be specified).\nWhen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-performautoml", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "PerformHPO": { "MarkdownDocumentation": "`PerformHPO`\n\nWhether to perform hyperparameter optimization (HPO) on the chosen recipe. The\ndefault 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-performhpo", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EventType": { "MarkdownDocumentation": "`EventType`\n\nThe event type (for example, 'click' or 'like') that is used for training the model.\nIf no `eventType` is provided, Amazon Personalize uses all interactions for training with\nequal 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-eventtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DatasetGroupArn": { "MarkdownDocumentation": "`DatasetGroupArn`\n\nThe Amazon Resource Name (ARN) of the dataset group that provides the training data.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-datasetgrouparn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SolutionConfig": { "MarkdownDocumentation": "`SolutionConfig`\n\nDescribes the configuration properties for the solution.\n*Required*: No\n*Type*: [SolutionConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-solutionconfig", "UpdateType": "Immutable", "Required": false, "Type": "SolutionConfig" }, "RecipeArn": { "MarkdownDocumentation": "`RecipeArn`\n\nThe ARN of the recipe used to create the solution. This is required when\n`performAutoML` is false.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+`\n*Maximum*: `256`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-recipearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the solution.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\\-_]*`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "SolutionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SolutionArn`\n\nThe Amazon Resource Name (ARN) of the solution.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#SolutionArn-fn::getatt" } } }, "AWS::Pinpoint::InAppTemplate": { "MarkdownDocumentation": "`AWS::Pinpoint::InAppTemplate`\n\nCreates a message template that you can use to send in-app messages. A message\ntemplate is a set of content and settings that you can define, save, and reuse in\nmessages for any of your Amazon Pinpoint applications. The In-App channel is unavailable in AWS GovCloud (US).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html", "Properties": { "CustomConfig": { "MarkdownDocumentation": "`CustomConfig`\n\nCustom data, in the form of key-value pairs, that is included in an in-app messaging\npayload.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-customconfig", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Layout": { "MarkdownDocumentation": "`Layout`\n\nA string that determines the appearance of the in-app message. You can specify\none of the following:\n* `BOTTOM_BANNER` \u2013 a message that appears as a banner at the\n bottom of the page.\n* `TOP_BANNER` \u2013 a message that appears as a banner at the\n 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\n of the page.\n* `MIDDLE_BANNER` \u2013 a message that appears as a banner in the\n middle of the page.\n* `CAROUSEL` \u2013 a scrollable layout of up to five unique\n messages.\n*Required*: No\n*Type*: String\n*Allowed values*: `BOTTOM_BANNER | TOP_BANNER ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-layout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Content": { "MarkdownDocumentation": "`Content`\n\nAn object that contains information about the content of an in-app message,\nincluding its title and body text, text colors, background colors, images,\nbuttons, and behaviors.\n*Required*: No\n*Type*: Array of [InAppMessageContent](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-content", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InAppMessageContent", "DuplicatesAllowed": true }, "TemplateName": { "MarkdownDocumentation": "`TemplateName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-templatename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TemplateDescription": { "MarkdownDocumentation": "`TemplateDescription`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-templatedescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [`Tag`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-resource-tags.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-tags", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the message template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#Arn-fn::getatt" } } }, "AWS::Pipes::Pipe": { "MarkdownDocumentation": "`AWS::Pipes::Pipe`\n\nSpecifies a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.\n###### Note\nAs an aid to help you jumpstart developing CloudFormation templates, the EventBridge console\nenables you to create templates from the existing pipes in your account. For more information, see [Generate an\nCloudFormation template from EventBridge Pipes](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html) in the *Amazon EventBridge User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the pipe that was created by the\nrequest.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html", "Properties": { "Enrichment": { "MarkdownDocumentation": "`Enrichment`\n\nThe ARN of the enrichment resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-enrichment", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyIdentifier": { "MarkdownDocumentation": "`KmsKeyIdentifier`\n\nThe identifier of the AWS KMS\ncustomer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key\nAmazon Resource Name (ARN), KeyId, key alias, or key alias ARN.\nTo update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a\ndifferent customer managed key, specify a customer managed key identifier.\nTo update a pipe that is using a customer managed key to use the default AWS owned key, specify an empty string.\nFor more information, see [Managing keys](https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html) in the *AWS Key Management Service\nDeveloper Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-kmskeyidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the pipe.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TargetParameters": { "MarkdownDocumentation": "`TargetParameters`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-targetparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeTargetParameters" }, "LogConfiguration": { "MarkdownDocumentation": "`LogConfiguration`\n\nThe logging configuration settings for the pipe.\n*Required*: No\n*Type*: [PipeLogConfiguration](./aws-properties-pipes-pipe-pipelogconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-logconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PipeLogConfiguration" }, "EnrichmentParameters": { "MarkdownDocumentation": "`EnrichmentParameters`\n\nThe parameters required to set up enrichment on your pipe.\n*Required*: No\n*Type*: [PipeEnrichmentParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-enrichmentparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeEnrichmentParameters" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the role that allows the pipe to send data to the target.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe ARN of the source resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$`\n*Minimum*: `1`\n*Maximum*: `1600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-source", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the pipe.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\.\\-_A-Za-z0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Target": { "MarkdownDocumentation": "`Target`\n\nThe ARN of the target resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-target", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DesiredState": { "MarkdownDocumentation": "`DesiredState`\n\nThe state the pipe should be in.\n*Required*: No\n*Type*: String\n*Allowed values*: `RUNNING | STOPPED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "RUNNING", "STOPPED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-desiredstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceParameters": { "MarkdownDocumentation": "`SourceParameters`\n\nThe parameters required to set up a source for your pipe.\n*Required*: No\n*Type*: [PipeSourceParameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-sourceparameters", "UpdateType": "Mutable", "Required": false, "Type": "PipeSourceParameters" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value pairs to associate with the pipe.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "StateReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`StateReason`\n\nThe reason the pipe is in its current state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#StateReason-fn::getatt" }, "CurrentState": { "PrimitiveType": "String", "MarkdownDocumentation": "`CurrentState`\n\nThe state the pipe is in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#CurrentState-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time the pipe was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#CreationTime-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nWhen the pipe was last updated, in [ISO-8601 format](https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#LastModifiedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the pipe.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#Arn-fn::getatt" } } }, "AWS::Proton::EnvironmentAccountConnection": { "MarkdownDocumentation": "`AWS::Proton::EnvironmentAccountConnection`\n\nDetailed data of an AWS Proton environment account connection resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the environment account connection.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html", "Properties": { "EnvironmentName": { "MarkdownDocumentation": "`EnvironmentName`\n\nThe name of the environment that's associated with the environment account connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-environmentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComponentRoleArn": { "MarkdownDocumentation": "`ComponentRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated\nenvironment account. It determines the scope of infrastructure that a component can provision in the account.\nThe environment account connection must have a `componentRoleArn` to allow directly defined components to be associated with any\nenvironments running in the account.\nFor more information about components, see\n[AWS Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the\n*AWS Proton User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-componentrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManagementAccountId": { "MarkdownDocumentation": "`ManagementAccountId`\n\nThe ID of the management account that's connected to the environment account connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-managementaccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CodebuildRoleArn": { "MarkdownDocumentation": "`CodebuildRoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources\nusing CodeBuild-based provisioning in the associated environment account.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-codebuildrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentAccountId": { "MarkdownDocumentation": "`EnvironmentAccountId`\n\nThe environment account that's connected to the environment account connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-environmentaccountid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe IAM service role that's associated with the environment account connection.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional list of metadata items that you can associate with the AWS Proton environment account connection. A tag is a key-value pair.\nFor more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the\n*AWS Proton User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-proton-environmentaccountconnection-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nReturns the environment account connection status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#Status-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nReturns the environment account connection ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the environment account connection ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#Arn-fn::getatt" } } }, "AWS::Proton::EnvironmentTemplate": { "MarkdownDocumentation": "`AWS::Proton::EnvironmentTemplate`\n\nCreate an environment template for AWS Proton. For more information, see [Environment Templates](https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) in the *AWS Proton User Guide*.\nYou can create an environment template in one of the two following ways:\n* Register and publish a *standard* environment template that instructs AWS Proton to deploy and manage environment\n infrastructure.\n* Register and publish a *customer managed* environment template that connects AWS Proton to your existing provisioned\n infrastructure that you manage. AWS Proton*doesn't* manage your existing provisioned infrastructure. To create an environment\n template for customer provisioned and managed infrastructure, include the `provisioning` parameter and set the value to\n `CUSTOMER_MANAGED`. For more information, see [Register\n and publish an environment template](https://docs.aws.amazon.com/proton/latest/userguide/template-create.html) in the *AWS Proton User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the environment template.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the environment template.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe name of the environment template as displayed in the developer interface.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EncryptionKey": { "MarkdownDocumentation": "`EncryptionKey`\n\nThe customer provided encryption key for the environment template.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d{12}:([\\w+=,.@-]+[/:])*[\\w+=,.@-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-encryptionkey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Provisioning": { "MarkdownDocumentation": "`Provisioning`\n\nWhen included, indicates that the environment template is for customer provisioned and managed infrastructure.\n*Required*: No\n*Type*: String\n*Allowed values*: `CUSTOMER_MANAGED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER_MANAGED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-provisioning", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional list of metadata items that you can associate with the AWS Proton environment template. A tag is a key-value pair.\nFor more information, see [AWS Proton resources and tagging](https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the\n*AWS Proton User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-proton-environmenttemplate-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the environment template.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the environment template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#Arn-fn::getatt" } } }, "AWS::Proton::ServiceTemplate": { "MarkdownDocumentation": "`AWS::Proton::ServiceTemplate`\n\nCreate a service template. The administrator creates a service template to define\nstandardized infrastructure and an optional CI/CD service pipeline. Developers, in turn,\nselect the service template from AWS Proton. If the selected service template includes a\nservice pipeline definition, they provide a link to their source code repository. AWS Proton\nthen deploys and manages the infrastructure defined by the selected service template. For more\ninformation, see [AWS Proton templates](https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) in the *AWS Proton User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the service template.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the service template.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html#cfn-proton-servicetemplate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe service template name as displayed in the developer interface.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html#cfn-proton-servicetemplate-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PipelineProvisioning": { "MarkdownDocumentation": "`PipelineProvisioning`\n\nIf `pipelineProvisioning` is `true`, a service pipeline is included\nin the service template. Otherwise, a service pipeline *isn't* included in\nthe service template.\n*Required*: No\n*Type*: String\n*Allowed values*: `CUSTOMER_MANAGED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CUSTOMER_MANAGED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html#cfn-proton-servicetemplate-pipelineprovisioning", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EncryptionKey": { "MarkdownDocumentation": "`EncryptionKey`\n\nThe customer provided service template encryption key that's used to encrypt data.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d{12}:([\\w+=,.@-]+[/:])*[\\w+=,.@-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html#cfn-proton-servicetemplate-encryptionkey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn object that includes the template bundle S3 bucket path and name for the new version of\na service template.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-proton-servicetemplate-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html#cfn-proton-servicetemplate-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the service template.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html#cfn-proton-servicetemplate-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the service template ARN.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html#Arn-fn::getatt" } } }, "AWS::QLDB::Ledger": { "MarkdownDocumentation": "`AWS::QLDB::Ledger`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html", "Properties": { "PermissionsMode": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-permissionsmode", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DeletionProtection": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-deletionprotection", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "KmsKey": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-kmskey", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::QLDB::Stream": { "MarkdownDocumentation": "`AWS::QLDB::Stream`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html", "Properties": { "InclusiveStartTime": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-inclusivestarttime", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StreamName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-streamname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KinesisConfiguration": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-kinesisconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "KinesisConfiguration" }, "ExclusiveEndTime": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-exclusiveendtime", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LedgerName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-ledgername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#Arn-fn::getatt" } } }, "AWS::QuickSight::Analysis": { "MarkdownDocumentation": "`AWS::QuickSight::Analysis`\n\nCreates an analysis in Amazon QuickSight.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nStatus associated with the analysis.\n*Required*: No\n*Type*: String\n*Allowed values*: `CREATION_IN_PROGRESS | CREA...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "PENDING_UPDATE", "DELETED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameter names and override values that you want to use. An analysis can have\nany parameter type, and some parameters might accept multiple values.\n*Required*: No\n*Type*: [Parameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Parameters" }, "SourceEntity": { "MarkdownDocumentation": "`SourceEntity`\n\nA source entity to use for the analysis that you're creating. This metadata structure\ncontains details that describe a source template and one or more datasets.\nEither a `SourceEntity` or a `Definition` must be provided in\norder for the request to be valid.\n*Required*: No\n*Type*: [AnalysisSourceEntity](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-sourceentity", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisSourceEntity" }, "ThemeArn": { "MarkdownDocumentation": "`ThemeArn`\n\nThe ARN for the theme to apply to the analysis that you're creating. To see the theme\nin the Amazon Quick Sight 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-themearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nProperty description not available.\n*Required*: No\n*Type*: [AnalysisDefinition](./aws-properties-quicksight-analysis-analysisdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-definition", "UpdateType": "Mutable", "Required": false, "Type": "AnalysisDefinition" }, "ValidationStrategy": { "MarkdownDocumentation": "`ValidationStrategy`\n\nThe option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to `LENIENT`, validation is skipped for specific errors.\n*Required*: No\n*Type*: [ValidationStrategy](./aws-properties-quicksight-analysis-validationstrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-validationstrategy", "UpdateType": "Mutable", "Required": false, "Type": "ValidationStrategy" }, "FolderArns": { "MarkdownDocumentation": "`FolderArns`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-folderarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA descriptive name for the analysis that you're creating. This name displays for the\nanalysis in the Amazon Quick Sight console.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Errors": { "MarkdownDocumentation": "`Errors`\n\nErrors associated with the analysis.\n*Required*: No\n*Type*: Array of [AnalysisError](./aws-properties-quicksight-analysis-analysiserror.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-errors", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AnalysisError", "DuplicatesAllowed": true }, "AnalysisId": { "MarkdownDocumentation": "`AnalysisId`\n\nThe ID for the analysis that you're creating. This ID displays in the URL of the\nanalysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-analysisid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe ID of the AWS account where you are creating an analysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-awsaccountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nA structure that describes the principals and the resource-level permissions on an\nanalysis. You can use the `Permissions` structure to grant permissions by\nproviding a list of AWS Identity and Access Management (IAM) action information for each\nprincipal listed by Amazon Resource Name (ARN).\nTo specify no permissions, omit `Permissions`.\n*Required*: No\n*Type*: Array of [ResourcePermission](./aws-properties-quicksight-analysis-resourcepermission.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourcePermission", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nContains a map of the key-value pairs for the resource tag or tags assigned to the\nanalysis.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-analysis-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Sheets": { "MarkdownDocumentation": "`Sheets`\n\nA list of the associated sheets with the unique identifier and name of each sheet.\n*Required*: No\n*Type*: Array of [Sheet](./aws-properties-quicksight-analysis-sheet.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-sheets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Sheet", "DuplicatesAllowed": true } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time that the analysis was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#CreatedTime-fn::getatt" }, "DataSetArns": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`DataSetArns`\n\nThe ARNs of the datasets of the analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#DataSetArns-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe time that the analysis was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the analysis.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#Arn-fn::getatt" } } }, "AWS::QuickSight::CustomPermissions": { "MarkdownDocumentation": "`AWS::QuickSight::CustomPermissions`\n\nCreates a custom permissions profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html", "Properties": { "CustomPermissionsName": { "MarkdownDocumentation": "`CustomPermissionsName`\n\nThe name of the custom permissions profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9+=,.@_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#cfn-quicksight-custompermissions-custompermissionsname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Capabilities": { "MarkdownDocumentation": "`Capabilities`\n\nA set of actions in the custom permissions profile.\n*Required*: No\n*Type*: [Capabilities](./aws-properties-quicksight-custompermissions-capabilities.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#cfn-quicksight-custompermissions-capabilities", "UpdateType": "Mutable", "Required": false, "Type": "Capabilities" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe ID of the AWS account that contains the custom permission configuration that you want to update.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#cfn-quicksight-custompermissions-awsaccountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to associate with the custom permissions profile.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-custompermissions-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#cfn-quicksight-custompermissions-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the custom permissions profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#Arn-fn::getatt" } } }, "AWS::QuickSight::Dashboard": { "MarkdownDocumentation": "`AWS::QuickSight::Dashboard`\n\nCreates a dashboard from a template. To first create a template, see the `CreateTemplate` API\noperation.\nA dashboard is an entity in Quick Suite that identifies Quick Suite reports, created from\nanalyses. You can share Quick Suite dashboards. With the right permissions, you can create scheduled email\nreports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a\ndifferent AWS account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html", "Properties": { "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters for the creation of the dashboard, which you want to use to override\nthe default settings. A dashboard can have any type of parameters, and some parameters\nmight accept multiple values.\n*Required*: No\n*Type*: [Parameters](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-parameters", "UpdateType": "Mutable", "Required": false, "Type": "Parameters" }, "VersionDescription": { "MarkdownDocumentation": "`VersionDescription`\n\nA description for the first version of the dashboard being created.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-versiondescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceEntity": { "MarkdownDocumentation": "`SourceEntity`\n\nThe entity that you are using as a source when you create the dashboard. In `SourceEntity`, you\nspecify the type of object that you want to use. You can only create a dashboard from a template, so you use a\n`SourceTemplate` entity. If you need to create a dashboard from an analysis, first convert the analysis to\na template by using the `CreateTemplate` API operation. For `SourceTemplate`, specify the\nAmazon Resource Name (ARN) of the source template. The `SourceTemplate`ARN can contain any AWS account; and any QuickSight-supported AWS Region.\nUse the `DataSetReferences` entity within `SourceTemplate` to list the replacement\ndatasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.\n*Required*: No\n*Type*: [DashboardSourceEntity](./aws-properties-quicksight-dashboard-dashboardsourceentity.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-sourceentity", "UpdateType": "Mutable", "Required": false, "Type": "DashboardSourceEntity" }, "ThemeArn": { "MarkdownDocumentation": "`ThemeArn`\n\nThe Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\nyou add a value for this field, it overrides the value that is used in the source\nentity. The theme ARN must exist in the same AWS account where you create\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-themearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nProperty description not available.\n*Required*: No\n*Type*: [DashboardVersionDefinition](./aws-properties-quicksight-dashboard-dashboardversiondefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-definition", "UpdateType": "Mutable", "Required": false, "Type": "DashboardVersionDefinition" }, "ValidationStrategy": { "MarkdownDocumentation": "`ValidationStrategy`\n\nThe option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to `LENIENT`, validation is skipped for specific errors.\n*Required*: No\n*Type*: [ValidationStrategy](./aws-properties-quicksight-dashboard-validationstrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-validationstrategy", "UpdateType": "Mutable", "Required": false, "Type": "ValidationStrategy" }, "FolderArns": { "MarkdownDocumentation": "`FolderArns`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-folderarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DashboardId": { "MarkdownDocumentation": "`DashboardId`\n\nThe ID for the dashboard, also added to the IAM policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-dashboardid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LinkSharingConfiguration": { "MarkdownDocumentation": "`LinkSharingConfiguration`\n\nA structure that contains the link sharing configurations that you want to apply\noverrides to.\n*Required*: No\n*Type*: [LinkSharingConfiguration](./aws-properties-quicksight-dashboard-linksharingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-linksharingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LinkSharingConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe display name of the dashboard.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DashboardPublishOptions": { "MarkdownDocumentation": "`DashboardPublishOptions`\n\nOptions for publishing the dashboard when you create it:\n* `AvailabilityStatus` for `AdHocFilteringOption` - This\n status can be either `ENABLED` or `DISABLED`. When this is\n set to `DISABLED`, Amazon Quick Sight disables the left filter pane on\n the published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is `ENABLED` by default.\n* `AvailabilityStatus` for `ExportToCSVOption` - This\n status can be either `ENABLED` or `DISABLED`. The visual\n option to export data to .CSV format isn't enabled when this is set to\n `DISABLED`. This option is `ENABLED` by default.\n* `VisibilityState` for `SheetControlsOption` - This\n visibility state can be either `COLLAPSED` or `EXPANDED`.\n This option is `COLLAPSED` by default.\n* `AvailabilityStatus` for `QuickSuiteActionsOption` -\n This status can be either `ENABLED` or `DISABLED`.\n Features related to Actions in Amazon Quick Suite on dashboards are disabled\n when this is set to `DISABLED`. This option is `DISABLED`\n by default.\n* `AvailabilityStatus` for `ExecutiveSummaryOption` - This\n status can be either `ENABLED` or `DISABLED`. The option\n to build an executive summary is disabled when this is set to\n `DISABLED`. This option is `ENABLED` by\n default.\n* `AvailabilityStatus` for `DataStoriesSharingOption` -\n This status can be either `ENABLED` or `DISABLED`. The\n option to share a data story is disabled when this is set to\n `DISABLED`. This option is `ENABLED` by\n default.\n*Required*: No\n*Type*: [DashboardPublishOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-dashboardpublishoptions", "UpdateType": "Mutable", "Required": false, "Type": "DashboardPublishOptions" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe ID of the AWS account where you want to create the\ndashboard.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-awsaccountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nA structure that contains the permissions of the dashboard. You can use this structure\nfor granting permissions by providing a list of IAM action information\nfor each principal ARN.\nTo specify no permissions, omit the permissions list.\n*Required*: No\n*Type*: Array of [ResourcePermission](./aws-properties-quicksight-dashboard-resourcepermission.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourcePermission", "DuplicatesAllowed": true }, "LinkEntities": { "MarkdownDocumentation": "`LinkEntities`\n\nA list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `1024 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-linkentities", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nContains a map of the key-value pairs for the resource tag or tags assigned to the\ndashboard.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-dashboard-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#cfn-quicksight-dashboard-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Version.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.Status-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time this dashboard version was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe time that the dashboard was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#LastUpdatedTime-fn::getatt" }, "Version.VersionNumber": { "PrimitiveType": "Double", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.VersionNumber-fn::getatt" }, "Version.Sheets": { "Type": "List", "ItemType": "Sheet", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.Sheets-fn::getatt" }, "Version.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.Arn-fn::getatt" }, "Version.ThemeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.ThemeArn-fn::getatt" }, "Version.Errors": { "Type": "List", "ItemType": "DashboardError", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.Errors-fn::getatt" }, "Version.CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.CreatedTime-fn::getatt" }, "Version.Description": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.Description-fn::getatt" }, "LastPublishedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastPublishedTime`\n\nThe time that the dashboard was last published.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#LastPublishedTime-fn::getatt" }, "Version": { "Type": "DashboardVersion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version-fn::getatt" }, "Version.DataSetArns": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.DataSetArns-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the dashboard.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Arn-fn::getatt" }, "Version.SourceEntityArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html#Version.SourceEntityArn-fn::getatt" } } }, "AWS::QuickSight::DataSet": { "MarkdownDocumentation": "`AWS::QuickSight::DataSet`\n\nCreates a dataset. This operation doesn't support datasets that include uploaded files\nas a source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html", "Properties": { "PhysicalTableMap": { "MarkdownDocumentation": "`PhysicalTableMap`\n\nDeclares the physical tables that are available in the underlying data sources.\n*Required*: No\n*Type*: Object of [PhysicalTable](./aws-properties-quicksight-dataset-physicaltable.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-physicaltablemap", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "PhysicalTable" }, "FieldFolders": { "MarkdownDocumentation": "`FieldFolders`\n\nThe folder that contains fields and nested subfolders for your dataset.\n*Required*: No\n*Type*: Object of [FieldFolder](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-fieldfolders", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "FieldFolder" }, "SemanticModelConfiguration": { "MarkdownDocumentation": "`SemanticModelConfiguration`\n\nThe semantic model configuration associated with this dataset.\n*Required*: No\n*Type*: [SemanticModelConfiguration](./aws-properties-quicksight-dataset-semanticmodelconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-semanticmodelconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "SemanticModelConfiguration" }, "FolderArns": { "MarkdownDocumentation": "`FolderArns`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-folderarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DataSetId": { "MarkdownDocumentation": "`DataSetId`\n\nAn 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PerformanceConfiguration": { "MarkdownDocumentation": "`PerformanceConfiguration`\n\nThe performance optimization configuration of a dataset.\n*Required*: No\n*Type*: [PerformanceConfiguration](./aws-properties-quicksight-dataset-performanceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-performanceconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PerformanceConfiguration" }, "IngestionWaitPolicy": { "MarkdownDocumentation": "`IngestionWaitPolicy`\n\nThe wait policy to use when creating or updating a Dataset. The default is to wait for SPICE ingestion to finish\nwith timeout of 36 hours.\n*Required*: No\n*Type*: [IngestionWaitPolicy](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-ingestionwaitpolicy", "UpdateType": "Mutable", "Required": false, "Type": "IngestionWaitPolicy" }, "DataSetRefreshProperties": { "MarkdownDocumentation": "`DataSetRefreshProperties`\n\nThe refresh properties of a dataset.\n*Required*: No\n*Type*: [DataSetRefreshProperties](./aws-properties-quicksight-dataset-datasetrefreshproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetrefreshproperties", "UpdateType": "Mutable", "Required": false, "Type": "DataSetRefreshProperties" }, "ColumnLevelPermissionRules": { "MarkdownDocumentation": "`ColumnLevelPermissionRules`\n\nA set of one or more definitions of a `ColumnLevelPermissionRule` .\n*Required*: No\n*Type*: Array of [ColumnLevelPermissionRule](./aws-properties-quicksight-dataset-columnlevelpermissionrule.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columnlevelpermissionrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnLevelPermissionRule", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe display name for the dataset.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ColumnGroups": { "MarkdownDocumentation": "`ColumnGroups`\n\nGroupings of columns that work together in certain Amazon Quick Sight features.\nCurrently, only geospatial hierarchy is supported.\n*Required*: No\n*Type*: Array of [ColumnGroup](./aws-properties-quicksight-dataset-columngroup.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columngroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ColumnGroup", "DuplicatesAllowed": true }, "ImportMode": { "MarkdownDocumentation": "`ImportMode`\n\nIndicates whether you want to import the data into SPICE.\n*Required*: No\n*Type*: String\n*Allowed values*: `SPICE | DIRECT_QUERY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SPICE", "DIRECT_QUERY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-importmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatasetParameters": { "MarkdownDocumentation": "`DatasetParameters`\n\nThe parameters that are declared in a dataset.\n*Required*: No\n*Type*: Array of [DatasetParameter](./aws-properties-quicksight-dataset-datasetparameter.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DatasetParameter", "DuplicatesAllowed": true }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nA list of resource permissions on the dataset.\n*Required*: No\n*Type*: Array of [ResourcePermission](./aws-properties-quicksight-dataset-resourcepermission.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourcePermission", "DuplicatesAllowed": true }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe AWS account ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-awsaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DataSetUsageConfiguration": { "MarkdownDocumentation": "`DataSetUsageConfiguration`\n\nThe usage configuration to apply to child datasets that reference this dataset as a source.\n*Required*: No\n*Type*: [DataSetUsageConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetusageconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DataSetUsageConfiguration" }, "UseAs": { "MarkdownDocumentation": "`UseAs`\n\nThe usage of the dataset.\n*Required*: No\n*Type*: String\n*Allowed values*: `RLS_RULES`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "RLS_RULES" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-useas", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataPrepConfiguration": { "MarkdownDocumentation": "`DataPrepConfiguration`\n\nThe data preparation configuration associated with this dataset.\n*Required*: No\n*Type*: [DataPrepConfiguration](./aws-properties-quicksight-dataset-dataprepconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-dataprepconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DataPrepConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nContains a map of the key-value pairs for the resource tag or tags assigned to the\ndataset.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-dataset-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time this dataset version was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe time this dataset version was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#LastUpdatedTime-fn::getatt" }, "OutputColumns": { "Type": "List", "ItemType": "OutputColumn", "MarkdownDocumentation": "`OutputColumns`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#OutputColumns-fn::getatt" }, "ConsumedSpiceCapacityInBytes": { "PrimitiveType": "Double", "MarkdownDocumentation": "`ConsumedSpiceCapacityInBytes`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#ConsumedSpiceCapacityInBytes-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#Arn-fn::getatt" } } }, "AWS::QuickSight::DataSource": { "MarkdownDocumentation": "`AWS::QuickSight::DataSource`\n\nCreates a data source.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html", "Properties": { "ErrorInfo": { "MarkdownDocumentation": "`ErrorInfo`\n\nError information from the last update or the creation of the data source.\n*Required*: No\n*Type*: [DataSourceErrorInfo](./aws-properties-quicksight-datasource-datasourceerrorinfo.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-errorinfo", "UpdateType": "Mutable", "Required": false, "Type": "DataSourceErrorInfo" }, "FolderArns": { "MarkdownDocumentation": "`FolderArns`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-folderarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the data source.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataSourceParameters": { "MarkdownDocumentation": "`DataSourceParameters`\n\nThe parameters that Amazon Quick Sight uses to connect to your underlying\nsource.\n*Required*: No\n*Type*: [DataSourceParameters](./aws-properties-quicksight-datasource-datasourceparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceparameters", "UpdateType": "Mutable", "Required": false, "Type": "DataSourceParameters" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the data source. To return a list of all data sources, use\n`ListDataSources`.\nUse `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ADOBE_ANALYTICS | AMAZON_EL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "AMAZON_OPENSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "DATABRICKS", "DENODO", "DREMIO", "DYNAMODB", "SAPHANA", "DB2_AS400", "EXASOL", "FILE", "GITHUB", "INTERNATIONAL_DATA_CORPORATION", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "QBUSINESS", "REDSHIFT", "S3", "S3_TABLES", "S3_KNOWLEDGE_BASE", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SPICE", "SQLSERVER", "TERADATA", "TIMESTREAM", "TWITTER", "BIGQUERY", "GOOGLE_ANALYTICS", "TRINO", "STARBURST", "MONGO", "MONGO_ATLAS", "DOCUMENTDB", "APPFLOW", "IMPALA", "GLUE", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcConnectionProperties": { "MarkdownDocumentation": "`VpcConnectionProperties`\n\nUse this parameter only when you want Amazon Quick Sight to use a VPC connection when\nconnecting to your underlying source.\n*Required*: No\n*Type*: [VpcConnectionProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-vpcconnectionproperties", "UpdateType": "Mutable", "Required": false, "Type": "VpcConnectionProperties" }, "AlternateDataSourceParameters": { "MarkdownDocumentation": "`AlternateDataSourceParameters`\n\nA set of alternate data source parameters that you want to share for the credentials\nstored with this data source. The credentials are applied in tandem with the data source\nparameters when you copy a data source by using a create or update request. The API\noperation compares the `DataSourceParameters` structure that's in the request\nwith the structures in the `AlternateDataSourceParameters` allow list. If the\nstructures are an exact match, the request is allowed to use the credentials from this\nexisting data source. If the `AlternateDataSourceParameters` list is null,\nthe `Credentials` originally used with this `DataSourceParameters`\nare automatically allowed.\n*Required*: No\n*Type*: Array of [DataSourceParameters](./aws-properties-quicksight-datasource-datasourceparameters.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-alternatedatasourceparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DataSourceParameters", "DuplicatesAllowed": true }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe AWS account ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-awsaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nA list of resource permissions on the data source.\n*Required*: No\n*Type*: Array of [ResourcePermission](./aws-properties-quicksight-datasource-resourcepermission.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourcePermission", "DuplicatesAllowed": true }, "SslProperties": { "MarkdownDocumentation": "`SslProperties`\n\nSecure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to\nyour underlying source.\n*Required*: No\n*Type*: [SslProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-sslproperties", "UpdateType": "Mutable", "Required": false, "Type": "SslProperties" }, "Credentials": { "MarkdownDocumentation": "`Credentials`\n\nThe credentials Amazon Quick Sight that uses to connect to your underlying source.\nCurrently, only credentials based on user name and password are supported.\n*Required*: No\n*Type*: [DataSourceCredentials](./aws-properties-quicksight-datasource-datasourcecredentials.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-credentials", "UpdateType": "Mutable", "Required": false, "Type": "DataSourceCredentials" }, "DataSourceId": { "MarkdownDocumentation": "`DataSourceId`\n\nAn ID for the data source. This ID is unique per AWS Region for each\nAWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nContains a map of the key-value pairs for the resource tag or tags assigned to the\ndata source.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-datasource-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe HTTP status of the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#Status-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time that this data source was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe last time that this data source was updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the dataset.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#Arn-fn::getatt" } } }, "AWS::QuickSight::Folder": { "MarkdownDocumentation": "`AWS::QuickSight::Folder`\n\nCreates an empty shared folder.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html", "Properties": { "SharingModel": { "MarkdownDocumentation": "`SharingModel`\n\nThe sharing scope of the folder.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACCOUNT | NAMESPACE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ACCOUNT", "NAMESPACE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-sharingmodel", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe ID for the AWS account where you want to create the folder.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-awsaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nA structure that describes the principals and the resource-level permissions of a folder.\nTo specify no permissions, omit `Permissions`.\n*Required*: No\n*Type*: Array of [ResourcePermission](./aws-properties-quicksight-folder-resourcepermission.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourcePermission", "DuplicatesAllowed": true }, "FolderId": { "MarkdownDocumentation": "`FolderId`\n\nThe ID of the folder.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-folderid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ParentFolderArn": { "MarkdownDocumentation": "`ParentFolderArn`\n\nThe Amazon Resource Name (ARN) for the folder.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-parentfolderarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags for the folders that you want to apply overrides to.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-folder-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "FolderType": { "MarkdownDocumentation": "`FolderType`\n\nThe type of folder it is.\n*Required*: No\n*Type*: String\n*Allowed values*: `SHARED | RESTRICTED...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SHARED", "RESTRICTED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-foldertype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the folder.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time that the folder was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#CreatedTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe time that the folder was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the folder.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#Arn-fn::getatt" } } }, "AWS::QuickSight::RefreshSchedule": { "MarkdownDocumentation": "`AWS::QuickSight::RefreshSchedule`\n\nCreates a refresh schedule for a dataset in Quick Suite.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html", "Properties": { "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe refresh schedule of a dataset.\n*Required*: No\n*Type*: [RefreshScheduleMap](./aws-properties-quicksight-refreshschedule-refreshschedulemap.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html#cfn-quicksight-refreshschedule-schedule", "UpdateType": "Mutable", "Required": false, "Type": "RefreshScheduleMap" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe AWS account ID of the account that you are creating a schedule in.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html#cfn-quicksight-refreshschedule-awsaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DataSetId": { "MarkdownDocumentation": "`DataSetId`\n\nThe ID of the dataset that you are creating a refresh schedule 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html#cfn-quicksight-refreshschedule-datasetid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the refresh schedule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html#Arn-fn::getatt" } } }, "AWS::QuickSight::Template": { "MarkdownDocumentation": "`AWS::QuickSight::Template`\n\nCreates a template from an existing Quick Suite analysis or template. You can use the resulting template\nto create a dashboard.\nA *template* is an entity in Quick Suite that encapsulates the metadata required to\ncreate an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using\nplaceholders to replace the dataset associated with the analysis. You can use templates to create dashboards by\nreplacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis\nand template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html", "Properties": { "VersionDescription": { "MarkdownDocumentation": "`VersionDescription`\n\nA description of the current template version being created. This API operation creates the\nfirst version of the template. Every time `UpdateTemplate` is called, a new\nversion is created. Each version of the template maintains a description of the version\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-versiondescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceEntity": { "MarkdownDocumentation": "`SourceEntity`\n\nThe entity that you are using as a source when you create the template. In\n`SourceEntity`, you specify the type of object you're using as source:\n`SourceTemplate` for a template or `SourceAnalysis` for an\nanalysis. Both of these require an Amazon Resource Name (ARN). For\n`SourceTemplate`, specify the ARN of the source template. For\n`SourceAnalysis`, specify the ARN of the source analysis. The `SourceTemplate`\nARN can contain any AWS account and any Quick Sight-supported AWS Region.\nUse the `DataSetReferences` entity within `SourceTemplate` or\n`SourceAnalysis` to list the replacement datasets for the placeholders listed\nin the original. The schema in each dataset must match its placeholder.\nEither a `SourceEntity` or a `Definition` must be provided in\norder for the request to be valid.\n*Required*: No\n*Type*: [TemplateSourceEntity](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-sourceentity", "UpdateType": "Mutable", "Required": false, "Type": "TemplateSourceEntity" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nProperty description not available.\n*Required*: No\n*Type*: [TemplateVersionDefinition](./aws-properties-quicksight-template-templateversiondefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-definition", "UpdateType": "Mutable", "Required": false, "Type": "TemplateVersionDefinition" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon Quick Sight account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-awsaccountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nA list of resource permissions to be set on the template.\n*Required*: No\n*Type*: Array of [ResourcePermission](./aws-properties-quicksight-template-resourcepermission.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourcePermission", "DuplicatesAllowed": true }, "ValidationStrategy": { "MarkdownDocumentation": "`ValidationStrategy`\n\nThe option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to `LENIENT`, validation is skipped for specific errors.\n*Required*: No\n*Type*: [ValidationStrategy](./aws-properties-quicksight-template-validationstrategy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-validationstrategy", "UpdateType": "Mutable", "Required": false, "Type": "ValidationStrategy" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nContains a map of the key-value pairs for the resource tag or tags assigned to the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-template-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "TemplateId": { "MarkdownDocumentation": "`TemplateId`\n\nAn ID for the template that you want to create. This template is unique per AWS Region; in\neach AWS account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-templateid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Version.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.Status-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time this template was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#CreatedTime-fn::getatt" }, "Version.DataSetConfigurations": { "Type": "List", "ItemType": "DataSetConfiguration", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.DataSetConfigurations-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe time this template was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#LastUpdatedTime-fn::getatt" }, "Version.VersionNumber": { "PrimitiveType": "Double", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.VersionNumber-fn::getatt" }, "Version.Sheets": { "Type": "List", "ItemType": "Sheet", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.Sheets-fn::getatt" }, "Version.ThemeArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.ThemeArn-fn::getatt" }, "Version.Errors": { "Type": "List", "ItemType": "TemplateError", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.Errors-fn::getatt" }, "Version.CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.CreatedTime-fn::getatt" }, "Version.Description": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.Description-fn::getatt" }, "Version": { "Type": "TemplateVersion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Arn-fn::getatt" }, "Version.SourceEntityArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#Version.SourceEntityArn-fn::getatt" } } }, "AWS::QuickSight::Theme": { "MarkdownDocumentation": "`AWS::QuickSight::Theme`\n\nCreates a theme.\nA *theme* is set of configuration options for color and layout. Themes apply to analyses and\ndashboards. For more information, see [Using Themes in Amazon Quick Suite](https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the\n*Amazon Quick Suite User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html", "Properties": { "ThemeId": { "MarkdownDocumentation": "`ThemeId`\n\nAn ID for the theme that you want to create. The theme ID is unique per AWS Region in\neach AWS account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\n*Minimum*: `1`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-themeid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VersionDescription": { "MarkdownDocumentation": "`VersionDescription`\n\nA description of the first version of the theme that you're creating. Every time\n`UpdateTheme` is called, a new version is created. Each version of the\ntheme has a description of the version in the `VersionDescription`\nfield.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-versiondescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe theme configuration, which contains the theme display properties.\n*Required*: Yes\n*Type*: [ThemeConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-configuration", "UpdateType": "Mutable", "Required": true, "Type": "ThemeConfiguration" }, "BaseThemeId": { "MarkdownDocumentation": "`BaseThemeId`\n\nThe ID of the theme that a custom theme will inherit from. All themes inherit from one of\nthe starting themes defined by Amazon Quick Sight. For a list of the starting themes, use\n`ListThemes` or choose **Themes** from\nwithin an analysis.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-basethemeid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe ID of the AWS account where you want to store the new theme.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-awsaccountid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Permissions": { "MarkdownDocumentation": "`Permissions`\n\nA valid grouping of resource permissions to apply to the new theme.\n*Required*: No\n*Type*: Array of [ResourcePermission](./aws-properties-quicksight-theme-resourcepermission.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-permissions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourcePermission", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA map of the key-value pairs for the resource tag or tags that you want to add to the\nresource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-theme-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA display name for the theme.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Version.Configuration.Typography": { "Type": "Typography", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Configuration.Typography-fn::getatt" }, "Version.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Status-fn::getatt" }, "Version.BaseThemeId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.BaseThemeId-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time the theme was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#CreatedTime-fn::getatt" }, "Version.Configuration": { "Type": "ThemeConfiguration", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Configuration-fn::getatt" }, "Version.Configuration.DataColorPalette": { "Type": "DataColorPalette", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Configuration.DataColorPalette-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe time the theme was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#LastUpdatedTime-fn::getatt" }, "Version.Configuration.UIColorPalette": { "Type": "UIColorPalette", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Configuration.UIColorPalette-fn::getatt" }, "Version.VersionNumber": { "PrimitiveType": "Double", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.VersionNumber-fn::getatt" }, "Version.Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Arn-fn::getatt" }, "Version.Errors": { "Type": "List", "ItemType": "ThemeError", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Errors-fn::getatt" }, "Version.Description": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Description-fn::getatt" }, "Version.CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.CreatedTime-fn::getatt" }, "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nTheme type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Type-fn::getatt" }, "Version": { "Type": "ThemeVersion", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the theme.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Arn-fn::getatt" }, "Version.Configuration.Sheet": { "Type": "SheetStyle", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#Version.Configuration.Sheet-fn::getatt" } } }, "AWS::QuickSight::Topic": { "MarkdownDocumentation": "`AWS::QuickSight::Topic`\n\nCreates a new Q topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html", "Properties": { "CustomInstructions": { "MarkdownDocumentation": "`CustomInstructions`\n\nProperty description not available.\n*Required*: No\n*Type*: [CustomInstructions](./aws-properties-quicksight-topic-custominstructions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-custominstructions", "UpdateType": "Mutable", "Required": false, "Type": "CustomInstructions" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the topic.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DataSets": { "MarkdownDocumentation": "`DataSets`\n\nThe data sets that the topic is associated with.\n*Required*: No\n*Type*: Array of [DatasetMetadata](./aws-properties-quicksight-topic-datasetmetadata.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-datasets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DatasetMetadata", "DuplicatesAllowed": true }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe ID of the AWS account that you want to create a topic in.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-awsaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FolderArns": { "MarkdownDocumentation": "`FolderArns`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-folderarns", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TopicId": { "MarkdownDocumentation": "`TopicId`\n\nThe ID for the topic. This ID is unique per AWS Region for each AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9-_.\\\\+]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-topicid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UserExperienceVersion": { "MarkdownDocumentation": "`UserExperienceVersion`\n\nThe user experience version of the topic.\n*Required*: No\n*Type*: String\n*Allowed values*: `LEGACY | NEW_READER_EXPERIE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LEGACY", "NEW_READER_EXPERIENCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-userexperienceversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfigOptions": { "MarkdownDocumentation": "`ConfigOptions`\n\nConfiguration options for a `Topic`.\n*Required*: No\n*Type*: [TopicConfigOptions](./aws-properties-quicksight-topic-topicconfigoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-configoptions", "UpdateType": "Mutable", "Required": false, "Type": "TopicConfigOptions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-topic-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the topic.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#Arn-fn::getatt" } } }, "AWS::QuickSight::VPCConnection": { "MarkdownDocumentation": "`AWS::QuickSight::VPCConnection`\n\nCreates a new VPC connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html", "Properties": { "DnsResolvers": { "MarkdownDocumentation": "`DnsResolvers`\n\nA list of IP addresses of DNS resolver endpoints for the VPC connection.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-dnsresolvers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AvailabilityStatus": { "MarkdownDocumentation": "`AvailabilityStatus`\n\nThe availability status of the VPC connection.\n*Required*: No\n*Type*: String\n*Allowed values*: `AVAILABLE | UNAVAILABLE | P...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-availabilitystatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AwsAccountId": { "MarkdownDocumentation": "`AwsAccountId`\n\nThe AWS account ID of the account where you want to create a new VPC\nconnection.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]{12}$`\n*Minimum*: `12`\n*Maximum*: `12`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-awsaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VPCConnectionId": { "MarkdownDocumentation": "`VPCConnectionId`\n\nThe ID of the VPC connection that you're creating. This ID is a unique identifier for each AWS Region in an\nAWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\w\\-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-vpcconnectionid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe Amazon EC2 security group IDs associated with the VPC connection.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `255 | 16`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of subnet IDs for the VPC connection.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 2`\n*Maximum*: `255 | 15`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the\nIAM role associated with the VPC\nconnection.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-rolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA map of the key-value pairs for the resource tag or tags assigned to the VPC\nconnection.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-quicksight-vpcconnection-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe display name for the VPC connection.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#cfn-quicksight-vpcconnection-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe HTTP status of the request.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#Status-fn::getatt" }, "CreatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedTime`\n\nThe time that the VPC connection was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#CreatedTime-fn::getatt" }, "VPCId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VPCId`\n\nThe Amazon EC2 VPC ID associated with the VPC connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#VPCId-fn::getatt" }, "NetworkInterfaces": { "Type": "List", "ItemType": "NetworkInterface", "MarkdownDocumentation": "`NetworkInterfaces`\n\nA list of network interfaces.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#NetworkInterfaces-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe time that the VPC connection was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#LastUpdatedTime-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the VPC connection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-vpcconnection.html#Arn-fn::getatt" } } }, "AWS::RAM::Permission": { "MarkdownDocumentation": "`AWS::RAM::Permission`\n\nCreates a customer managed permission for a specified resource type that you can attach to resource shares.\nIt is created in the AWS Region in which you call the operation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the permission.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html", "Properties": { "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nSpecifies the name of the resource type that this customer managed permission applies\nto.\nThe format is `:` and is not case sensitive. For example, to specify an Amazon EC2 Subnet, you can\nuse the string `ec2:subnet`. To see the list of valid values for this\nparameter, query the [ListResourceTypes](https://docs.aws.amazon.com/ram/latest/APIReference/API_ListResourceTypes.html)\noperation.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html#cfn-ram-permission-resourcetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyTemplate": { "MarkdownDocumentation": "`PolicyTemplate`\n\nA string in JSON format string that contains the following elements of a\nresource-based policy:\n* **Effect**: must be set to\n `ALLOW`.\n* **Action**: specifies the actions that are\n allowed by this customer managed permission. The list must contain only actions that are supported by\n the specified resource type. For a list of all actions supported by each\n resource type, see [Actions, resources, and condition keys for AWS services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) in the\n *AWS Identity and Access Management User Guide*.\n* **Condition**: (optional) specifies conditional\n parameters that must evaluate to true when a user attempts an action for that\n action to be allowed. For more information about the Condition element, see\n [IAM\n policies: Condition element](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) in the *AWS Identity and Access Management User\n Guide*.\nThis template can't include either the `Resource` or\n`Principal` elements. Those are both filled in by AWS RAM when it instantiates\nthe resource-based policy on each resource shared using this managed permission. The\n`Resource` comes from the ARN of the specific resource that you are sharing.\nThe `Principal` comes from the list of identities added to the resource\nshare.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html#cfn-ram-permission-policytemplate", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Json" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies a list of one or more tag key and value pairs to attach to the\npermission.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ram-permission-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html#cfn-ram-permission-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nSpecifies the name of the customer managed permission. The name must be unique within the\nAWS Region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w.-]*`\n*Minimum*: `1`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html#cfn-ram-permission-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Version": { "PrimitiveType": "String", "MarkdownDocumentation": "`Version`\n\nThe version number for this version of the permission.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html#Version-fn::getatt" }, "PermissionType": { "PrimitiveType": "String", "MarkdownDocumentation": "`PermissionType`\n\nThe type of managed permission. This can be one of the following values:\n* **AWS\\_MANAGED\\_PERMISSION** \u2013 AWS\n created and manages this managed permission. You can associate it with your\n resource shares, but you can't modify it.\n* **CUSTOMER\\_MANAGED\\_PERMISSION** \u2013 You, or another\n principal in your account created this managed permission. You can associate it\n with your resource shares and create new versions that have different\n permissions.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html#PermissionType-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the new permission.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html#Arn-fn::getatt" }, "IsResourceTypeDefault": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsResourceTypeDefault`\n\nSpecifies whether this permission is the default for new resource shares that include\nresources of the associated resource type.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.html#IsResourceTypeDefault-fn::getatt" } } }, "AWS::RAM::ResourceShare": { "MarkdownDocumentation": "`AWS::RAM::ResourceShare`\n\nCreates a resource share. You can provide a list of the Amazon Resource Names (ARNs)\nfor the resources that you want to share, a list of principals you want to share the\nresources with, and the permissions to grant those principals.\n###### Note\nSharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any\npermissions or quotas that apply to the resource in the account that created\nit.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns The ID of the resource share.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html", "Properties": { "PermissionArns": { "MarkdownDocumentation": "`PermissionArns`\n\nSpecifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do\nnot specify an ARN for the permission, AWS RAM automatically attaches the default version\nof the permission for each resource type. You can associate only one permission with\neach resource type included in the resource share.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-permissionarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Principals": { "MarkdownDocumentation": "`Principals`\n\nSpecifies the principals to associate with the resource share. The possible values\nare:\n* An AWS account ID\n* An Amazon Resource Name (ARN) of an organization in AWS Organizations\n* An ARN of an organizational unit (OU) in AWS Organizations\n* An ARN of an IAM role\n* An ARN of an IAM user\n###### Note\nNot all resource types can be shared with IAM roles and users. For\nmore information, see the column **Can share with IAM roles and users** in the tables on [Shareable AWS resources](https://docs.aws.amazon.com/ram/latest/userguide/shareable.html) in the *AWS Resource Access Manager User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-principals", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AllowExternalPrincipals": { "MarkdownDocumentation": "`AllowExternalPrincipals`\n\nSpecifies whether principals outside your organization in AWS Organizations can be associated\nwith a resource share. A value of `true` lets you share with individual AWS accounts\nthat are *not* in your organization. A value of `false`\nonly has meaning if your account is a member of an AWS Organization. The default value\nis `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-allowexternalprincipals", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Sources": { "MarkdownDocumentation": "`Sources`\n\nSpecifies from which source accounts the service principal has access to the resources in this resource share.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-sources", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ResourceArns": { "MarkdownDocumentation": "`ResourceArns`\n\nSpecifies a list of one or more ARNs of the resources to associate with the\nresource share.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-resourcearns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies one or more tags to attach to the resource share itself. It doesn't attach the tags to\nthe resources associated with the resource share.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ram-resourceshare-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nSpecifies the name of the resource share.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the resource share.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#Status-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe date and time when the resource share was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#CreationTime-fn::getatt" }, "LastUpdatedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedTime`\n\nThe date and time when the resource share was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#LastUpdatedTime-fn::getatt" }, "OwningAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwningAccountId`\n\nThe ID of the AWS account that owns the resource share.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#OwningAccountId-fn::getatt" }, "FeatureSet": { "PrimitiveType": "String", "MarkdownDocumentation": "`FeatureSet`\n\nIndicates what features are available for this resource share. This parameter can have one of\nthe following values:\n* **STANDARD** \u2013 A resource share that supports all\n functionality. These resource shares are visible to all principals you share the resource share with.\n You can modify these resource shares in AWS RAM using the console or APIs. This resource share might\n have been created by AWS RAM, or it might have been **CREATED\\_FROM\\_POLICY** and then promoted.\n* **CREATED\\_FROM\\_POLICY** \u2013 The customer\n manually shared a resource by attaching a resource-based policy. That policy did\n not match any existing managed permissions, so AWS RAM created this customer managed permission automatically on the\n customer's behalf based on the attached policy document. This type of resource share\n is visible only to the AWS account that created it. You can't modify it in\n AWS RAM unless you promote it. For more information,\n see PromoteResourceShareCreatedFromPolicy.\n* **PROMOTING\\_TO\\_STANDARD** \u2013 This\n resource share was originally `CREATED_FROM_POLICY`, but the customer ran\n the PromoteResourceShareCreatedFromPolicy and that operation\n is still in progress. This value changes to `STANDARD` when\n complete.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#FeatureSet-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the resource share.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#Arn-fn::getatt" } } }, "AWS::RDS::CustomDBEngineVersion": { "MarkdownDocumentation": "`AWS::RDS::CustomDBEngineVersion`\n\nCreates a custom DB engine version (CEV).\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the resource name, such as `mystack-abc1d2efg3h4.` For more\ninformation about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nA value that indicates the status of a custom engine version (CEV).\n*Required*: No\n*Type*: String\n*Allowed values*: `available | inactive | inac...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "available", "inactive", "inactive-except-restore" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatabaseInstallationFilesS3BucketName": { "MarkdownDocumentation": "`DatabaseInstallationFilesS3BucketName`\n\nThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid\nbucket name is `my-custom-installation-files`.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3bucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description of your CEV.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe name of your CEV. The name format is `major version.customized_string`.\nFor example, a valid CEV name is `19.my_cev1`. This setting is required for RDS\nCustom for Oracle, but optional for Amazon RDS. The combination of `Engine`\nand `EngineVersion` is unique per customer per Region.\n*Constraints:* Minimum length is 1. Maximum length is 60.\n*Pattern:*`^[a-z0-9_.-]{1,60$`}\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `60`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engineversion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "KMSKeyId": { "MarkdownDocumentation": "`KMSKeyId`\n\nThe AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for\nRDS Custom, but optional for Amazon RDS.\nIf you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom.\nNo further action is necessary. If you don't already have a symmetric encryption KMS key in your account,\nfollow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service\nDeveloper Guide*.\nYou can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UseAwsProvidedLatestImage": { "MarkdownDocumentation": "`UseAwsProvidedLatestImage`\n\nSpecifies whether to use the latest service-provided Amazon Machine Image (AMI) for\nthe CEV. If you specify `UseAwsProvidedLatestImage`, you can't also specify\n`ImageId`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-useawsprovidedlatestimage", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ImageId": { "MarkdownDocumentation": "`ImageId`\n\nA value that indicates the ID of the AMI.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-imageid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DatabaseInstallationFilesS3Prefix": { "MarkdownDocumentation": "`DatabaseInstallationFilesS3Prefix`\n\nThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid\nbucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3prefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Manifest": { "MarkdownDocumentation": "`Manifest`\n\nThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3.\nSpecify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which\nthey are listed.\nThe following JSON fields are valid:\nMediaImportTemplateVersion\nVersion of the CEV manifest. The date is in the format `YYYY-MM-DD`.\n\ndatabaseInstallationFileNames\nOrdered list of installation files for the CEV.\n\nopatchFileNames\nOrdered list of OPatch installers used for the Oracle DB engine.\n\npsuRuPatchFileNames\nThe PSU and RU patches for this CEV.\n\nOtherPatchFileNames\nThe patches that are not in the list of PSU and RU patches.\nAmazon RDS applies these patches after applying the PSU and RU patches.\n\nFor more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `51000`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-manifest", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceCustomDbEngineVersionIdentifier": { "MarkdownDocumentation": "`SourceCustomDbEngineVersionIdentifier`\n\nThe ARN of a CEV to use as a source for creating a new CEV. You can specify a different\nAmazon Machine Imagine (AMI) by using either `Source` or\n`UseAwsProvidedLatestImage`. You can't specify a different JSON manifest\nwhen you specify `SourceCustomDbEngineVersionIdentifier`.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-sourcecustomdbengineversionidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe database engine to use for your custom engine version (CEV).\nValid values:\n* `custom-oracle-ee`\n* `custom-oracle-ee-cdb`\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `35`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engine", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags.\nFor more information, see [Tagging\nAmazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-customdbengineversion-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "DBEngineVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBEngineVersionArn`\n\nThe ARN of the custom engine version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#DBEngineVersionArn-fn::getatt" } } }, "AWS::RDS::DBCluster": { "MarkdownDocumentation": "`AWS::RDS::DBCluster`\n\nThe `AWS::RDS::DBCluster` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.\nFor more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.\nFor more information about creating a Multi-AZ DB cluster, see\n[Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html)\nin the *Amazon RDS User Guide*.\n###### Note\nYou can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are\nsupported.\n**Updating DB clusters**\nWhen properties labeled \"*Update requires:*[Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\" are updated, AWS CloudFormation first creates a replacement DB\ncluster, then changes references from other dependent resources to point to the\nreplacement DB cluster, and finally deletes the old DB cluster.\n###### Important\nWe highly recommend that you take a snapshot of the database before updating the\nstack. If you don't, you lose the data when AWS CloudFormation replaces your DB\ncluster. To preserve your data, perform the following procedure:\n1. Deactivate any applications that are using the DB cluster so that there's\n no activity on the DB instance.\n2. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).\n3. If you want to restore your DB cluster using a DB cluster snapshot, modify\n the updated template with your DB cluster changes and add the\n `SnapshotIdentifier` property with the ID of the DB cluster\n snapshot that you want to use.\n \n After you restore a DB cluster with a `SnapshotIdentifier`\n property, you must specify the same `SnapshotIdentifier` property\n for any future updates to the DB cluster. When you specify this property for\n an update, the DB cluster is not restored from the DB cluster snapshot\n again, and the data in the database is not changed. However, if you don't\n specify the `SnapshotIdentifier` property, an empty DB cluster is\n created, and the original DB cluster is deleted. If you specify a property\n that is different from the previous snapshot restore property, a new DB\n cluster is restored from the specified `SnapshotIdentifier`\n property, and the original DB cluster is deleted.\n4. Update the stack.\nCurrently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to\nany other properties when you specify one of the following properties: `PreferredBackupWindow`,\n`PreferredMaintenanceWindow`, and `Port`. This limitation doesn't apply to provisioned\nDB clusters.\nFor more information about updating other properties of this resource, see `[ModifyDBCluster](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBCluster.html)`. For more information about updating stacks, see\n[AWS\nCloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n**Deleting DB clusters**\nThe default `DeletionPolicy` for `AWS::RDS::DBCluster` resources\nis `Snapshot`. For more information about how AWS CloudFormation deletes\nresources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name (`DBClusterIdentifier`) of the DB cluster.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html", "Properties": { "DatabaseInsightsMode": { "MarkdownDocumentation": "`DatabaseInsightsMode`\n\nThe mode of Database Insights to enable for the DB cluster.\nIf you set this value to `advanced`, you must also set the `PerformanceInsightsEnabled`\nparameter to `true` and the `PerformanceInsightsRetentionPeriod` parameter to 465.\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | advanced...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "advanced" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databaseinsightsmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StorageEncrypted": { "MarkdownDocumentation": "`StorageEncrypted`\n\nIndicates 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\nvalue is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified\n`KmsKeyId` property is used.\nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted,\ndon't specify this property. The value is inherited from the snapshot, and the specified `KmsKeyId`\nproperty is used.\nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property\nto specify that the restored DB cluster is encrypted. Specify the `KmsKeyId` property for the KMS key\nto use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property\nor set it to `false`.\n###### Note\nIf you specify both the `StorageEncrypted` and\n`SnapshotIdentifier` properties without specifying the\n`KmsKeyId` property, then the restored DB cluster inherits the encryption\nsettings from the DB snapshot that provide.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DBSystemId": { "MarkdownDocumentation": "`DBSystemId`\n\nReserved 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsystemid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RestoreToTime": { "MarkdownDocumentation": "`RestoreToTime`\n\nThe date and time to restore the DB cluster to.\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* Must be specified if `UseLatestRestorableTime` parameter isn't provided\n* Can't be specified if the `UseLatestRestorableTime` parameter is enabled\n* Can't be specified if the `RestoreType` parameter is `copy-on-write`\nThis property must be used with `SourceDBClusterIdentifier` property. The resulting cluster will have the identifier\nthat matches the value of the `DBclusterIdentifier` property.\nExample: `2015-03-07T23:45:00Z`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretotime", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EngineMode": { "MarkdownDocumentation": "`EngineMode`\n\nThe DB engine mode of the DB cluster, either `provisioned` or `serverless`.\nThe `serverless` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the\n`provisioned` engine mode.\nFor information about limitations and requirements for Serverless DB clusters, see the\nfollowing sections in the *Amazon Aurora User Guide*:\n* [Limitations of Aurora\n Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)\n* [Requirements\n for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)\nValid for Cluster Type: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port number on which the DB instances in the DB cluster accept connections.\nDefault:\n* When `EngineMode` is `provisioned`, `3306`\n (for both Aurora MySQL and Aurora PostgreSQL)\n* When `EngineMode` is `serverless`:\n \n + `3306` when `Engine` is `aurora` or\n `aurora-mysql`\n + `5432` when `Engine` is\n `aurora-postgresql`\n###### Important\nThe `No interruption` on update behavior only applies to DB clusters. If you are updating a\nDB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port)\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DBClusterIdentifier": { "MarkdownDocumentation": "`DBClusterIdentifier`\n\nThe 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*Pattern*: `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MasterUserAuthenticationType": { "MarkdownDocumentation": "`MasterUserAuthenticationType`\n\nSpecifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.\nYou can specify one of the following values:\n* `password` - Use standard database authentication with a password.\n* `iam-db-auth` - Use IAM database authentication for the master user.\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\nThis option is only valid for RDS for MySQL, RDS for MariaDB, RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL engines.\n*Required*: No\n*Type*: String\n*Allowed values*: `password | iam-db-auth...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "password", "iam-db-auth" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserauthenticationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MonitoringInterval": { "MarkdownDocumentation": "`MonitoringInterval`\n\nThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off\ncollecting Enhanced Monitoring metrics, specify `0`.\nIf `MonitoringRoleArn` is specified, also set `MonitoringInterval`\nto a value other than `0`.\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\nValid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`\nDefault: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ReplicationSourceIdentifier": { "MarkdownDocumentation": "`ReplicationSourceIdentifier`\n\nThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\ncluster 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe name of the database engine to be used for this DB cluster.\nValid Values:\n* `aurora-mysql`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the DB cluster.\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-dbcluster-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe version number of the database engine to use.\nTo list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible)\nand version 3 (8.0-compatible), use the following command:\n`aws rds describe-db-engine-versions --engine aurora-mysql --query\n\"DBEngineVersions[].EngineVersion\"`\nYou can supply either `5.7` or `8.0` to use the default engine version for Aurora MySQL version 2 or\nversion 3, respectively.\nTo list all of the available engine versions for Aurora PostgreSQL, use\nthe following command:\n`aws rds describe-db-engine-versions --engine aurora-postgresql --query\n\"DBEngineVersions[].EngineVersion\"`\nTo list all of the available engine versions for RDS for MySQL, use the following command:\n`aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"`\nTo list all of the available engine versions for RDS for PostgreSQL, use the following command:\n`aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"`\n**Aurora MySQL**\nFor information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the\n*Amazon Aurora User Guide*.\n**Aurora PostgreSQL**\nFor information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the\n*Amazon Aurora User Guide*.\n**MySQL**\nFor information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.\n**PostgreSQL**\nFor information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StorageType": { "MarkdownDocumentation": "`StorageType`\n\nThe storage type to associate with the DB cluster.\nFor information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB\nclusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).\nThis setting is required to create a Multi-AZ DB cluster.\nWhen specified for a Multi-AZ DB cluster, a value for the `Iops` parameter is required.\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\nValid Values:\n* Aurora DB clusters - `aurora | aurora-iopt1`\n* Multi-AZ DB clusters - `io1 | io2 | gp3`\nDefault:\n* Aurora DB clusters - `aurora`\n* Multi-AZ DB clusters - `io1`\n###### Note\nWhen you create an Aurora DB cluster with the storage type set to `aurora-iopt1`, the storage type is returned\nin the response. The storage type isn't returned when you set it to `aurora`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) of the AWS KMS key that is\nused to encrypt the database instances in the DB cluster, such as\n`arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`.\nIf you enable the `StorageEncrypted` property but don't specify this\nproperty, the default KMS key is used. If you specify this property, you must set the\n`StorageEncrypted` property to `true`.\nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property\nvalue is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId`\nproperty is used.\nIf you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set `KmsKeyId` to a KMS key identifier that is valid in the destination AWS Region.\nThis KMS key is used to encrypt the read replica in that AWS Region.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServerlessV2ScalingConfiguration": { "MarkdownDocumentation": "`ServerlessV2ScalingConfiguration`\n\nThe scaling configuration of an Aurora Serverless V2 DB cluster.\nThis property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the `ScalingConfiguration` property.\nValid for: Aurora Serverless v2 DB clusters only\n*Required*: No\n*Type*: [ServerlessV2ScalingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ServerlessV2ScalingConfiguration" }, "DeleteAutomatedBackups": { "MarkdownDocumentation": "`DeleteAutomatedBackups`\n\nSpecifies whether to remove automated backups immediately after the DB\ncluster is deleted. This parameter isn't case-sensitive. The default is to remove\nautomated backups immediately after the DB cluster is deleted, unless the AWS Backup\npolicy specifies a point-in-time restore rule.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deleteautomatedbackups", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PerformanceInsightsRetentionPeriod": { "MarkdownDocumentation": "`PerformanceInsightsRetentionPeriod`\n\nThe number of days to retain Performance Insights data. When creating a DB cluster without enabling Performance Insights, you can't specify the parameter `PerformanceInsightsRetentionPeriod`.\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\nValid Values:\n* `7`\n* *month* \\* 31, where *month* is a number of months from 1-23.\n Examples: `93` (3 months \\* 31), `341` (11 months \\* 31), `589` (19 months \\* 31)\n* `731`\nDefault: `7` days\nIf you specify a retention period that isn't valid, such as `94`, Amazon RDS issues an error.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of your database. If you don't provide a name, then Amazon RDS won't create a\ndatabase in this DB cluster. For naming constraints, see [Naming\nConstraints](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnableLocalWriteForwarding": { "MarkdownDocumentation": "`EnableLocalWriteForwarding`\n\nSpecifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\ndefault, write operations aren't allowed on reader DB instances.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablelocalwriteforwarding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AutoMinorVersionUpgrade": { "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nSpecifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.\nBy default, minor engine upgrades are applied automatically.\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.\nFor more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades).\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DBSubnetGroupName": { "MarkdownDocumentation": "`DBSubnetGroupName`\n\nA 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\nspecify 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeletionProtection": { "MarkdownDocumentation": "`DeletionProtection`\n\nA value that indicates whether the DB cluster has deletion protection enabled.\nThe database can't be deleted when deletion protection is enabled. By default,\ndeletion 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AllocatedStorage": { "MarkdownDocumentation": "`AllocatedStorage`\n\nThe amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.\nValid for Cluster Type: Multi-AZ DB clusters only\nThis setting is required to create a Multi-AZ 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SourceDbClusterResourceId": { "MarkdownDocumentation": "`SourceDbClusterResourceId`\n\nThe resource ID of the source DB cluster from which to restore.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusterresourceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MasterUserPassword": { "MarkdownDocumentation": "`MasterUserPassword`\n\nThe master password for the DB instance.\n###### Note\nIf you specify the `SourceDBClusterIdentifier`, `SnapshotIdentifier`, or `GlobalClusterIdentifier`\nproperty, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB\ncluster 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterUserSecret": { "MarkdownDocumentation": "`MasterUserSecret`\n\nThe secret managed by RDS in AWS Secrets Manager for the master user password.\n###### Note\nWhen you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of\nreusing the secret specified in the `SecretArn` property. This ensures that\nthe restored DB cluster is securely managed with a dedicated secret. To maintain\nconsistent integration with your application, you might need to update resource\nconfigurations to reference the newly created secret.\nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\nin the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)\nin the *Amazon Aurora User Guide.*\n*Required*: No\n*Type*: [MasterUserSecret](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret", "UpdateType": "Mutable", "Required": false, "Type": "MasterUserSecret" }, "SourceDBClusterIdentifier": { "MarkdownDocumentation": "`SourceDBClusterIdentifier`\n\nWhen 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* Cannot be specified if `SourceDbClusterResourceId` is specified. You must specify either `SourceDBClusterIdentifier` or `SourceDbClusterResourceId`, but not both.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MasterUsername": { "MarkdownDocumentation": "`MasterUsername`\n\nThe name of the master user for the DB cluster.\n###### Note\nIf you specify the `SourceDBClusterIdentifier`, `SnapshotIdentifier`, or `GlobalClusterIdentifier`\nproperty, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB\ncluster for the global database cluster, respectively.\nValid for: Aurora DB clusters and Multi-AZ DB clusters\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z]{1}[a-zA-Z0-9_]*$`\n*Minimum*: `1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "ScalingConfiguration": { "MarkdownDocumentation": "`ScalingConfiguration`\n\nThe scaling\nconfiguration of an Aurora Serverless v1 DB cluster.\nThis property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the `ServerlessV2ScalingConfiguration` property.\nValid for: Aurora Serverless v1 DB clusters only\n*Required*: No\n*Type*: [ScalingConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ScalingConfiguration" }, "PerformanceInsightsKmsKeyId": { "MarkdownDocumentation": "`PerformanceInsightsKmsKeyId`\n\nThe 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\nuses your default KMS key. There is a default KMS key for your AWS account.\nYour AWS account has a different default KMS key for each AWS Region.\nValid for Cluster Type: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nSpecifies whether the DB cluster is publicly accessible.\nValid for Cluster Type: Multi-AZ DB clusters only\nWhen the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is controlled by its security group settings.\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.\nThe default behavior when `PubliclyAccessible` is not specified depends on whether a `DBSubnetGroup` is specified.\nIf `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to `true`.\nIf `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to `false` unless the value of `DBSubnetGroup` is `default`, in which case `PubliclyAccessible` defaults to `true`.\nIf `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup` is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nIndicates 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)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BacktrackWindow": { "MarkdownDocumentation": "`BacktrackWindow`\n\nThe target backtrack window, in seconds. To disable backtracking, set this value to\n`0`.\nValid for Cluster Type: Aurora MySQL DB clusters only\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*: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DBInstanceParameterGroupName": { "MarkdownDocumentation": "`DBInstanceParameterGroupName`\n\nThe name of the DB parameter group to apply to all instances of the DB cluster.\n###### Note\nWhen you apply a parameter group using the `DBInstanceParameterGroupName` parameter, the DB\ncluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than\nduring the next maintenance window.\nValid for Cluster Type: Aurora DB clusters only\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* The `DBInstanceParameterGroupName` parameter is valid in combination with the\n `AllowMajorVersionUpgrade` parameter for a major version upgrade 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnableGlobalWriteForwarding": { "MarkdownDocumentation": "`EnableGlobalWriteForwarding`\n\nSpecifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n(Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\nare secondary clusters in an Aurora global database.\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\nenabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\nthis cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\nprimary is demoted by a global cluster API operation, but it does nothing until then.\nValid for Cluster Type: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableglobalwriteforwarding", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MonitoringRoleArn": { "MarkdownDocumentation": "`MonitoringRoleArn`\n\nThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.\nAn example is `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role,\nsee [Setting\nup 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 Cluster Type: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssociatedRoles": { "MarkdownDocumentation": "`AssociatedRoles`\n\nProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.\nIAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\non your behalf.\nValid for: Aurora DB clusters and Multi-AZ DB clusters\n*Required*: No\n*Type*: Array of [DBClusterRole](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DBClusterRole", "DuplicatesAllowed": false }, "EnableHttpEndpoint": { "MarkdownDocumentation": "`EnableHttpEndpoint`\n\nSpecifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint\nisn't enabled.\nWhen enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running\nSQL queries on the DB cluster. You can also query your database\nfrom inside the RDS console with the RDS query editor.\nFor more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the\n*Amazon Aurora User Guide*.\nValid for Cluster Type: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SnapshotIdentifier": { "MarkdownDocumentation": "`SnapshotIdentifier`\n\nThe identifier for the DB snapshot or DB cluster snapshot to restore\nfrom.\nYou can use either the name or the Amazon Resource Name (ARN) to specify a DB\ncluster snapshot. However, you can use only the ARN to specify a DB snapshot.\nAfter you restore a DB cluster with a `SnapshotIdentifier` property, you\nmust specify the same `SnapshotIdentifier` property for any future updates to\nthe DB cluster. When you specify this property for an update, the DB cluster is not\nrestored from the snapshot again, and the data in the database is not changed. However,\nif you don't specify the `SnapshotIdentifier` property, an empty DB cluster\nis created, and the original DB cluster is deleted. If you specify a property that is\ndifferent from the previous snapshot restore property, a new DB cluster is restored from\nthe specified `SnapshotIdentifier` property, and the original DB cluster is\ndeleted.\nIf you specify the `SnapshotIdentifier` property to restore a DB cluster (as opposed to specifying it for DB cluster updates),\nthen 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClusterScalabilityType": { "MarkdownDocumentation": "`ClusterScalabilityType`\n\nSpecifies the scalability mode of the Aurora DB cluster. When set to `limitless`, the cluster operates as an Aurora Limitless Database,\nallowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to `standard` (the default), the cluster uses normal DB instance creation.\n**Important:** Automated backup retention isn't supported with Aurora Limitless Database clusters. If you set this property to `limitless`, you cannot set `DeleteAutomatedBackups` to `false`. To create a backup, use manual snapshots 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-clusterscalabilitytype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PreferredBackupWindow": { "MarkdownDocumentation": "`PreferredBackupWindow`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nThe 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.\nA `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6\nprotocols (`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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nA 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "CopyTagsToSnapshot": { "MarkdownDocumentation": "`CopyTagsToSnapshot`\n\nA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "GlobalClusterIdentifier": { "MarkdownDocumentation": "`GlobalClusterIdentifier`\n\nIf you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database\ncluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster,\nuse the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html)\nresource.\nIf you aren't configuring a global database cluster, don't specify this property.\n###### Note\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*Pattern*: `^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`\n*Minimum*: `0`\n*Maximum*: `63`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "RestoreType": { "MarkdownDocumentation": "`RestoreType`\n\nThe 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\n source DB cluster.\n* `copy-on-write` - The new DB cluster is restored as a clone of the\n source DB cluster.\nIf you don't specify a `RestoreType` value, then the new DB cluster is\nrestored 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DomainIAMRoleName": { "MarkdownDocumentation": "`DomainIAMRoleName`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EngineLifecycleSupport": { "MarkdownDocumentation": "`EngineLifecycleSupport`\n\nThe life cycle type for this DB cluster.\n###### Note\nBy default, this value is set to `open-source-rds-extended-support`, which enrolls your DB cluster into Amazon RDS Extended Support.\nAt the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case,\ncreating the DB cluster will fail if the DB major version is past its end of standard support date.\nYou can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support,\nyou can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:\n* Amazon Aurora - [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide*\n* Amazon RDS - [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\nValid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`\nDefault: `open-source-rds-extended-support`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginelifecyclesupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DBClusterInstanceClass": { "MarkdownDocumentation": "`DBClusterInstanceClass`\n\nThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6gd.xlarge`.\nNot 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 Cluster Type: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZones": { "MarkdownDocumentation": "`AvailabilityZones`\n\nA list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on\nAWS Regions and Availability Zones, see\n[Choosing the Regions and\nAvailability 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*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe 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\neach AWS Region, occurring on a random day of the week. To see the time\nblocks available, see [Maintaining an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User\nGuide.*\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated\nfor each DB instance in the Multi-AZ DB cluster.\nFor information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS\nUser Guide*.\nThis setting is required to create a Multi-AZ DB cluster.\nValid for Cluster Type: Multi-AZ DB clusters only\nConstraints:\n* Must be a multiple between .5 and 50 of the storage amount for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SourceRegion": { "MarkdownDocumentation": "`SourceRegion`\n\nThe AWS Region which contains the source DB cluster when replicating a DB cluster. For\nexample, `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UseLatestRestorableTime": { "MarkdownDocumentation": "`UseLatestRestorableTime`\n\nA value that indicates whether to restore the DB cluster to the latest restorable\nbackup time. By default, the DB cluster is not restored to the latest restorable backup\ntime.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ManageMasterUserPassword": { "MarkdownDocumentation": "`ManageMasterUserPassword`\n\nSpecifies 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)\nin the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)\nin the *Amazon Aurora User Guide.*\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\nConstraints:\n* Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword`\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EnableIAMDatabaseAuthentication": { "MarkdownDocumentation": "`EnableIAMDatabaseAuthentication`\n\nA value that indicates whether to enable mapping of AWS Identity and Access\nManagement (IAM) accounts to database accounts. By default, mapping is disabled.\nFor more information, see\n[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DBClusterParameterGroupName": { "MarkdownDocumentation": "`DBClusterParameterGroupName`\n\nThe name of the DB cluster parameter group to associate with this DB cluster.\n###### Important\nIf you apply a parameter group to an existing DB cluster, then its DB instances\nmight need to reboot. This can result in an outage while the DB instances are\nrebooting.\nIf you apply a change to parameter group associated with a stopped DB cluster,\nthen the update stack waits until the DB cluster is started.\nTo list all of the available DB cluster parameter group names, use the following\ncommand:\n`aws rds describe-db-cluster-parameter-groups --query\n\"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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PerformanceInsightsEnabled": { "MarkdownDocumentation": "`PerformanceInsightsEnabled`\n\nSpecifies 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 Cluster Type: 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BackupRetentionPeriod": { "MarkdownDocumentation": "`BackupRetentionPeriod`\n\nThe 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*Minimum*: `1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnableCloudwatchLogsExports": { "MarkdownDocumentation": "`EnableCloudwatchLogsExports`\n\nThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values\nin the list depend on the DB engine being used. For more information, see\n[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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false } }, "Attributes": { "Endpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.Address`\n\nThe connection endpoint for the DB cluster. For example:\n`mystack-mydbcluster-123456789012.us-east-2.rds.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#Endpoint.Address-fn::getatt" }, "Endpoint": { "Type": "Endpoint", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#Endpoint-fn::getatt" }, "DBClusterArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBClusterArn`\n\nThe Amazon Resource Name (ARN) for the DB cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#DBClusterArn-fn::getatt" }, "Endpoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.Port`\n\nThe port number that will accept connections on this DB cluster. For example:\n`3306`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#Endpoint.Port-fn::getatt" }, "ReadEndpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`ReadEndpoint.Address`\n\nThe reader endpoint for the DB cluster. For example:\n`mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#ReadEndpoint.Address-fn::getatt" }, "ReadEndpoint": { "Type": "ReadEndpoint", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#ReadEndpoint-fn::getatt" }, "StorageThroughput": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`StorageThroughput`\n\nThe storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.\nThis setting is only for non-Aurora Multi-AZ DB clusters.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#StorageThroughput-fn::getatt" }, "DBClusterResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBClusterResourceId`\n\nThe AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever\nthe KMS key for the DB cluster is accessed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#DBClusterResourceId-fn::getatt" }, "MasterUserSecret.SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MasterUserSecret.SecretArn`\n\nThe Amazon Resource Name (ARN) of the secret.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#MasterUserSecret.SecretArn-fn::getatt" } } }, "AWS::RDS::DBClusterParameterGroup": { "MarkdownDocumentation": "`AWS::RDS::DBClusterParameterGroup`\n\nThe `AWS::RDS::DBClusterParameterGroup` resource creates a new Amazon RDS\nDB cluster parameter group.\nFor information about configuring parameters for Amazon Aurora DB clusters, see\n[Working with parameter\ngroups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n###### Note\nIf you apply a parameter group to a DB cluster, then its DB instances might need\nto 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,\nthen the updated stack waits until the DB cluster is started.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the DB cluster parameter group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nProvides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-parameters", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Family": { "MarkdownDocumentation": "`Family`\n\nThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster\nparameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.\n**Aurora MySQL**\nExample: `aurora-mysql5.7`, `aurora-mysql8.0`\n**Aurora PostgreSQL**\nExample: `aurora-postgresql14`\n**RDS for MySQL**\nExample: `mysql8.0`\n**RDS for PostgreSQL**\nExample: `postgres13`\nTo list all of the available parameter group families for a DB engine, use the following command:\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine `\nFor example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql`\n###### Note\nThe output contains duplicates.\nThe following are the valid DB engine values:\n* `aurora-mysql`\n* `aurora-postgresql`\n* `mysql`\n* `postgres`\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DBClusterParameterGroupName": { "MarkdownDocumentation": "`DBClusterParameterGroupName`\n\nThe name of the DB cluster parameter group.\nConstraints:\n* Must not match the name of an existing DB cluster parameter group.\n###### Note\nThis value is stored as a lowercase string.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z]{1}(?:-?[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-dbclusterparametergroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the DB cluster parameter group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-dbclusterparametergroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::RDS::DBInstance": { "MarkdownDocumentation": "`AWS::RDS::DBInstance`\n\nThe `AWS::RDS::DBInstance` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance\nin an Aurora DB cluster.\nFor more information about creating an RDS DB instance, see [Creating an Amazon\nRDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.\nFor more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.\nIf you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance,\nAWS CloudFormation applies the changes in the template during the import operation.\n###### Important\nIf a DB instance is deleted or replaced during an update, AWS CloudFormation\ndeletes all automated snapshots. However, it retains manual DB snapshots. During an\nupdate that requires replacement, you can apply a stack policy to prevent DB\ninstances from being replaced. For more information, see [Prevent\nUpdates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).\n**Updating DB instances**\nWhen properties labeled \"*Update requires:*[Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\"\nare updated, AWS CloudFormation first creates a replacement DB\ninstance, then changes references from other dependent resources to point to the\nreplacement DB instance, and finally deletes the old DB instance.\n###### Important\nWe highly recommend that you take a snapshot of the database before updating the\nstack. If you don't, you lose the data when AWS CloudFormation replaces your DB\ninstance. To preserve your data, perform the following procedure:\n1. Deactivate any applications that are using the DB instance so that there's\n no activity on the DB instance.\n2. Create a snapshot of the DB instance. For more information, see [Creating a DB\n Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).\n3. If you want to restore your instance using a DB snapshot, modify the\n updated template with your DB instance changes and add the\n `DBSnapshotIdentifier` property with the ID of the DB\n snapshot that you want to use.\n \n After you restore a DB instance with a `DBSnapshotIdentifier`\n property, you can delete the `DBSnapshotIdentifier`\n property. When you specify this property for an update, the DB instance is not restored from the DB snapshot\n again, and the data in the database is not changed. However, if you don't\n specify the `DBSnapshotIdentifier` property, an empty DB instance\n is created, and the original DB instance is deleted. If you specify a\n property that is different from the previous snapshot restore property, a\n new DB instance is restored from the specified\n `DBSnapshotIdentifier` property, and the original DB instance\n is deleted.\n4. Update the stack.\nFor more information about updating other properties of this resource, see `[ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)`. For more information about updating stacks,\nsee [AWS\nCloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n**Deleting DB instances**\nFor DB instances that are part of an Aurora DB cluster, you can set a deletion policy\nfor your DB instance to control how AWS CloudFormation handles the DB instance when the\nstack is deleted. For Amazon RDS DB instances, you can choose to\n*retain* the DB instance, to *delete* the DB\ninstance, or to *create a snapshot* of the DB instance. The default\nAWS CloudFormation behavior depends on the `DBClusterIdentifier`\nproperty:\n1. For `AWS::RDS::DBInstance` resources that don't specify the\n `DBClusterIdentifier` property, AWS CloudFormation saves a\n snapshot of the DB instance.\n2. For `AWS::RDS::DBInstance` resources that do specify the\n `DBClusterIdentifier` property, AWS CloudFormation deletes the DB\n instance.\nFor more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DB instance name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html", "Properties": { "Timezone": { "MarkdownDocumentation": "`Timezone`\n\nThe time zone of the DB instance.\nThe time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and\n[RDS for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-timezone", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DatabaseInsightsMode": { "MarkdownDocumentation": "`DatabaseInsightsMode`\n\nThe mode of Database Insights to enable for the DB instance.\n###### Note\nAurora DB instances inherit this value from the DB cluster, so you can't change this value.\n*Required*: No\n*Type*: String\n*Allowed values*: `standard | advanced...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "standard", "advanced" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-databaseinsightsmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StorageEncrypted": { "MarkdownDocumentation": "`StorageEncrypted`\n\nA 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` or\n`SourceDbiResourceId` property, don't specify this property. The value is\ninherited from the source DB instance, and if the DB instance is encrypted, the specified\n`KmsKeyId` property is used.\nIf you specify the `SourceDBInstanceAutomatedBackupsArn` property, don't\nspecify this property. The value is inherited from the source DB instance automated backup.\nIf you specify `DBSnapshotIdentifier` property, don't specify this property.\nThe value is inherited from the snapshot.\n**Amazon Aurora**\nNot applicable. The encryption for DB instances is managed by\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storageencrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DBSystemId": { "MarkdownDocumentation": "`DBSystemId`\n\nThe Oracle system identifier (SID), which is the name of the Oracle database instance that\nmanages your database files. In this context, the term \"Oracle database instance\" refers exclusively\nto the system global area (SGA) and Oracle background processes. If you don't specify a SID,\nthe value defaults to `RDSCDB`. The Oracle SID is also the name of your CDB.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsystemid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port number on which the database accepts connections.\nThis setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.\nValid Values: `1150-65535`\nDefault:\n* RDS for Db2 - `50000`\n* RDS for MariaDB - `3306`\n* RDS for Microsoft SQL Server - `1433`\n* RDS for MySQL - `3306`\n* RDS for Oracle - `1521`\n* RDS for PostgreSQL - `5432`\nConstraints:\n* For RDS for Microsoft SQL Server, the value can't be `1234`, `1434`,\n `3260`, `3343`, `3389`, `47001`, or\n `49152-49156`.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d*$`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DBClusterIdentifier": { "MarkdownDocumentation": "`DBClusterIdentifier`\n\nThe identifier of the DB cluster that this DB instance will belong to.\nThis setting doesn't apply to RDS Custom 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StorageThroughput": { "MarkdownDocumentation": "`StorageThroughput`\n\nSpecifies the storage throughput value, in mebibyte per second (MiBps), 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storagethroughput", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AutomaticBackupReplicationRetentionPeriod": { "MarkdownDocumentation": "`AutomaticBackupReplicationRetentionPeriod`\n\nThe retention period for automated backups in a different AWS Region.\nUse this parameter to set a unique retention period that only applies to cross-Region\nautomated backups. To enable automated backups in a different Region, specify a positive\nvalue for the `AutomaticBackupReplicationRegion` parameter.\nIf not specified, this parameter defaults to the value of the `BackupRetentionPeriod` parameter. The maximum allowed value is 35.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-automaticbackupreplicationretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MasterUserAuthenticationType": { "MarkdownDocumentation": "`MasterUserAuthenticationType`\n\nSpecifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB instance.\nYou can specify one of the following values:\n* `password` - Use standard database authentication with a password.\n* `iam-db-auth` - Use IAM database authentication for the master user.\nThis option is only valid for RDS for MySQL, RDS for MariaDB, RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL engines.\n*Required*: No\n*Type*: String\n*Allowed values*: `password | iam-db-auth...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "password", "iam-db-auth" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masteruserauthenticationtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MonitoringInterval": { "MarkdownDocumentation": "`MonitoringInterval`\n\nThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for\nthe DB instance. To disable collection of Enhanced Monitoring metrics, specify `0`.\nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval`\nto a value other than `0`.\nThis setting doesn't apply to RDS Custom DB instances.\nValid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`\nDefault: `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-monitoringinterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DBParameterGroupName": { "MarkdownDocumentation": "`DBParameterGroupName`\n\nThe 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\ncommand:\n`aws rds describe-db-parameter-groups --query\n\"DBParameterGroups[].DBParameterGroupName\" --output text`\n###### Note\nIf any of the data members of the referenced parameter group are changed during an\nupdate, the DB instance might need to be restarted, which causes some interruption.\nIf the parameter group contains static parameters, whether they were changed or not,\nan update triggers a reboot.\nIf you don't specify a value for `DBParameterGroupName` property,\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbparametergroupname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "MultiAZ": { "MarkdownDocumentation": "`MultiAZ`\n\nSpecifies whether the DB instance is a Multi-AZ deployment. You can't set\nthe `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.\nThis setting doesn't apply to Amazon Aurora because the DB instance Availability Zones (AZs)\nare managed by the DB cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-multiaz", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "AutomaticBackupReplicationKmsKeyId": { "MarkdownDocumentation": "`AutomaticBackupReplicationKmsKeyId`\n\nThe AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\nAmazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region, for example,\n`arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-automaticbackupreplicationkmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the DB instance.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-dbinstance-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.\nThis property is required when creating a DB instance.\n###### Note\nYou can convert an Oracle database from the non-CDB architecture to the container\ndatabase (CDB) architecture by updating the `Engine` value in your templates\nfrom `oracle-ee` to `oracle-ee-cdb` or from\n`oracle-se2` to `oracle-se2-cdb`. Converting to the CDB\narchitecture requires an interruption.\nValid Values:\n* `aurora-mysql` (for Aurora MySQL DB instances)\n* `aurora-postgresql` (for Aurora PostgreSQL DB instances)\n* `custom-oracle-ee` (for RDS Custom for Oracle DB instances)\n* `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)\n* `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)\n* `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)\n* `custom-sqlserver-web` (for RDS Custom for SQL Server DB instances)\n* `db2-ae`\n* `db2-se`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-engine", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "PerformanceInsightsKMSKeyId": { "MarkdownDocumentation": "`PerformanceInsightsKMSKeyId`\n\nThe 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\nuses your default KMS key. There is a default KMS key for your AWS account.\nYour 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightskmskeyid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SourceDBInstanceIdentifier": { "MarkdownDocumentation": "`SourceDBInstanceIdentifier`\n\nIf you want to create a read replica DB instance, specify the ID of the source DB\ninstance. Each DB instance can have a limited number of read replicas. For more\ninformation, see [Working with Read\nReplicas](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\n[Naming constraints in\nAmazon 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\na read replica. If you remove the `SourceDBInstanceIdentifier` property from\nyour template and then update your stack, AWS CloudFormation promotes the\nread replica to a standalone DB instance.\nIf you specify the `UseLatestRestorableTime` or `RestoreTime`\nproperties in conjunction with the `SourceDBInstanceIdentifier` property, RDS\nrestores the DB instance to the requested point in time, thereby creating a new DB\ninstance.\n###### Important\n* If you specify a source DB instance that uses VPC security groups, we\n recommend that you specify the `VPCSecurityGroups` property. If\n you don't specify the property, the read replica inherits the value of the\n `VPCSecurityGroups` property from the source DB when you\n create the replica. However, if you update the stack, AWS CloudFormation\n reverts the replica's `VPCSecurityGroups` property to the default\n value because it's not defined in the stack's template. This change might\n cause unexpected issues.\n* Read replicas don't support deletion policies. AWS CloudFormation ignores\n any deletion policy that's associated with a read replica.\n* If you specify `SourceDBInstanceIdentifier`, don't specify the\n `DBSnapshotIdentifier` property. You can't create a read\n replica from a snapshot.\n* Don't set the `BackupRetentionPeriod`, `DBName`,\n `MasterUsername`, `MasterUserPassword`, and\n `PreferredBackupWindow` properties. The database attributes\n are inherited from the source DB instance, and backups are disabled for read\n replicas.\n* If the source DB instance is in a different region than the read replica,\n specify the source region in `SourceRegion`, and specify an ARN\n for a valid DB instance in `SourceDBInstanceIdentifier`. For more\n 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\n *Amazon RDS User Guide*.\n* For DB instances in Amazon Aurora clusters, don't specify this property.\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe 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\nAmazon 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\ninstance is managed by the DB cluster.\n**Db2**\nSee [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the\n*Amazon RDS User Guide.*\n**MariaDB**\nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the\n*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\n*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\n*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\n*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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StorageType": { "MarkdownDocumentation": "`StorageType`\n\nThe storage type to associate with the DB instance.\nIf you specify `io1`, `io2`, or `gp3`, you must also include a value for the\n`Iops` parameter.\nThis setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.\nValid Values: `gp2 | gp3 | io1 | io2 | standard`\nDefault: `io1`, if the `Iops` parameter is specified. Otherwise,\n`gp3`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storagetype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe ARN of the AWS KMS key that's used to encrypt\nthe DB instance, such as\n`arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`.\nIf you enable the StorageEncrypted property but don't specify this property, AWS\nCloudFormation uses the default KMS key. If you specify this property, you must set\nthe StorageEncrypted property to true.\nIf you specify the `SourceDBInstanceIdentifier` or\n`SourceDbiResourceId` property, don't specify this property. The value is\ninherited from the source DB instance, and if the DB instance is encrypted, the specified\n`KmsKeyId` property is used. However, if the source DB instance is in a\ndifferent AWS Region, you must specify a KMS key ID.\nIf you specify the `SourceDBInstanceAutomatedBackupsArn` property, don't\nspecify this property. The value is inherited from the source DB instance automated backup,\nand if the automated backup is encrypted, the specified `KmsKeyId` property is\nused.\nIf you create an encrypted read replica in a different AWS Region, then you must\nspecify a KMS key for the destination AWS Region. KMS encryption keys are specific to\nthe region that they're created in, and you can't use encryption keys from one region in\nanother region.\nIf you specify the `DBSnapshotIdentifier` property, don't specify this\nproperty. The `StorageEncrypted` property value is inherited from the snapshot.\nIf the DB instance is encrypted, the specified `KmsKeyId` property is also\ninherited from the snapshot.\nIf you specify `DBSecurityGroups`, AWS CloudFormation ignores this\nproperty. To specify both a security group and this property, you must use a VPC\nsecurity 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)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DBInstanceClass": { "MarkdownDocumentation": "`DBInstanceClass`\n\nThe compute and memory capacity of the DB instance, for example `db.m5.large`.\nNot 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\n[DB instance\nclasses](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or\n[Aurora\nDB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbinstanceclass", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeleteAutomatedBackups": { "MarkdownDocumentation": "`DeleteAutomatedBackups`\n\nA value that indicates whether to remove automated backups immediately after the DB\ninstance is deleted. This parameter isn't case-sensitive. The default is to remove\nautomated 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.\nManual 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deleteautomatedbackups", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PerformanceInsightsRetentionPeriod": { "MarkdownDocumentation": "`PerformanceInsightsRetentionPeriod`\n\nThe number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter `PerformanceInsightsRetentionPeriod`.\nThis setting doesn't apply to RDS Custom DB instances.\nValid Values:\n* `7`\n* *month* \\* 31, where *month* is a number of months from 1-23.\n Examples: `93` (3 months \\* 31), `341` (11 months \\* 31), `589` (19 months \\* 31)\n* `731`\nDefault: `7` days\nIf you specify a retention period that isn't valid, such as `94`, Amazon RDS returns an error.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone (AZ) where the database will be created. For information on\nAWS Regions and Availability Zones, see\n[Regions\nand Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).\nFor Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these\nAvailability 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.\nConstraints:\n* The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi-AZ deployment.\n* The specified Availability Zone must be in the same AWS Region as the current endpoint.\nExample: `us-east-1d`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-availabilityzone", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "OptionGroupName": { "MarkdownDocumentation": "`OptionGroupName`\n\nIndicates that the DB instance should be associated with the specified option\ngroup.\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be\nremoved from an option group. Also, that option group can't be removed from a DB\ninstance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-optiongroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnablePerformanceInsights": { "MarkdownDocumentation": "`EnablePerformanceInsights`\n\nSpecifies whether to enable Performance Insights for the DB instance. For more information, see\n[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 DB instances.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enableperformanceinsights", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DBSubnetGroupName": { "MarkdownDocumentation": "`DBSubnetGroupName`\n\nA DB subnet group to associate with the DB instance. If you update this value, the new\nsubnet group must be a subnet group in a new VPC.\nIf you don't specify a DB subnet group, RDS uses the default DB subnet group if one\nexists. If a default DB subnet group does not exist, and you don't specify a\n`DBSubnetGroupName`, the DB instance fails to launch.\nFor more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html)\nin the *Amazon RDS User Guide*.\nThis setting doesn't apply to Amazon Aurora DB instances. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsubnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AutoMinorVersionUpgrade": { "MarkdownDocumentation": "`AutoMinorVersionUpgrade`\n\nA value that indicates whether minor engine upgrades are applied automatically to the\nDB instance during the maintenance window. By default, minor engine upgrades are applied\nautomatically.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-autominorversionupgrade", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "DeletionProtection": { "MarkdownDocumentation": "`DeletionProtection`\n\nSpecifies whether the DB instance has deletion protection enabled.\nThe database can't be deleted when deletion protection is enabled. By default,\ndeletion protection isn't enabled. For more information, see\n[Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).\nThis setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster.\nFor more information, see `CreateDBCluster`. DB instances in a DB\ncluster 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deletionprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DBInstanceIdentifier": { "MarkdownDocumentation": "`DBInstanceIdentifier`\n\nA name for the DB instance. If you specify a name, AWS CloudFormation converts it to\nlowercase. If you don't specify a name, AWS CloudFormation generates a unique physical\nID and uses that ID for the DB instance. For more information, see [Name\nType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\nFor information about constraints that apply to DB instance identifiers, see\n[Naming constraints in\nAmazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n###### Important\nIf you specify a name, you can't perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must\nreplace the resource, specify a new name.\n*Required*: No\n*Type*: String\n*Pattern*: `^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbinstanceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AllocatedStorage": { "MarkdownDocumentation": "`AllocatedStorage`\n\nThe amount of storage in gibibytes (GiB) to be initially allocated for the database\ninstance.\n###### Note\nIf any value is set in the `Iops` parameter,\n`AllocatedStorage` must be at least 100 GiB, which corresponds to the\nminimum Iops value of 1,000. If you increase the `Iops` value (in 1,000\nIOPS increments), then you must also increase the `AllocatedStorage`\nvalue (in 100-GiB increments).\n**Amazon Aurora**\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your\ndatabase increases, though you are only charged for the space that you use in an Aurora cluster volume.\n**Db2**\nConstraints to the amount of storage for each storage type are the following:\n* General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.\n* Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.\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 \n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n* Provisioned IOPS storage (io1):\n \n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n* Magnetic storage (standard):\n \n + Enterprise and Standard editions: Must be an integer from 20 to 1024.\n + Web and Express editions: Must be an integer from 20 to 1024.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-allocatedstorage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterUserPassword": { "MarkdownDocumentation": "`MasterUserPassword`\n\nThe password for the master user. The password can include any printable ASCII\ncharacter except \"/\", \"\"\", or \"@\".\n**Amazon Aurora**\nNot applicable. The password for the master user is managed by the DB cluster.\n**RDS for Db2**\nMust contain from 8 to 255 characters.\n**RDS for MariaDB**\nConstraints: Must contain from 8 to 41 characters.\n**RDS for Microsoft SQL Server**\nConstraints: Must contain from 8 to 128 characters.\n**RDS for MySQL**\nConstraints: Must contain from 8 to 41 characters.\n**RDS for Oracle**\nConstraints: Must contain from 8 to 30 characters.\n**RDS for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masteruserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MasterUserSecret": { "MarkdownDocumentation": "`MasterUserSecret`\n\nThe 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)\nin the *Amazon RDS User Guide.*\n*Required*: No\n*Type*: [MasterUserSecret](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masterusersecret", "UpdateType": "Mutable", "Required": false, "Type": "MasterUserSecret" }, "NcharCharacterSetName": { "MarkdownDocumentation": "`NcharCharacterSetName`\n\nThe name of the NCHAR character set for the Oracle DB instance.\nThis setting doesn't apply to RDS Custom 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-ncharcharactersetname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceDBClusterIdentifier": { "MarkdownDocumentation": "`SourceDBClusterIdentifier`\n\nThe identifier of the Multi-AZ DB cluster that will act as the source for the read\nreplica. Each DB cluster can have up to 15 read replicas.\nConstraints:\n* Must be the identifier of an existing Multi-AZ DB cluster.\n* Can't be specified if the `SourceDBInstanceIdentifier` parameter is\n also specified.\n* The specified DB cluster must have automatic backups enabled, that is, its\n backup retention period must be greater than 0.\n* The source DB cluster must be in the same AWS Region as the read replica.\n Cross-Region replication isn't supported.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbclusteridentifier", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DBSecurityGroups": { "MarkdownDocumentation": "`DBSecurityGroups`\n\nA list of the DB security groups to assign to the DB instance. The list can include\nboth the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup\nresources created in the template.\nIf you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa.\nAlso, note that the DBSecurityGroups property exists only for backwards compatibility with older\nregions and is no longer recommended for providing security information to an RDS DB\ninstance. Instead, use VPCSecurityGroups.\n###### Important\nIf you specify this property, AWS CloudFormation sends only the following\nproperties (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\ngroup if you want to submit other properties, such as `StorageType`,\n`StorageEncrypted`, or `KmsKeyId`. If you're already using\nthe `DBSecurityGroups` property, you can't use these other properties by\nupdating your DB instance to use a VPC security group. You must recreate the DB\ninstance.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsecuritygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MasterUsername": { "MarkdownDocumentation": "`MasterUsername`\n\nThe master user name for the DB instance.\n###### Note\nIf you specify the `SourceDBInstanceIdentifier` or\n`DBSnapshotIdentifier` property, don't specify this property. The\nvalue is inherited from the source DB instance or snapshot.\nWhen migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.\n**Amazon Aurora**\nNot applicable. The name for the master user is managed by the DB cluster.\n**RDS for Db2**\nConstraints:\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**RDS for MariaDB**\nConstraints:\n* Must be 1 to 16 letters or numbers.\n* Can't be a reserved word for the chosen database engine.\n**RDS for Microsoft SQL Server**\nConstraints:\n* Must be 1 to 128 letters or numbers.\n* First character must be a letter.\n* Can't be a reserved word for the chosen database engine.\n**RDS for MySQL**\nConstraints:\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**RDS for Oracle**\nConstraints:\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**RDS for PostgreSQL**\nConstraints:\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*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]{0,127}$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masterusername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MaxAllocatedStorage": { "MarkdownDocumentation": "`MaxAllocatedStorage`\n\nThe 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\n[Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)\nin the *Amazon RDS User Guide*.\nThis setting doesn't apply to the following DB instances:\n* Amazon Aurora (Storage is managed by the DB cluster.)\n* 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-maxallocatedstorage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PromotionTier": { "MarkdownDocumentation": "`PromotionTier`\n\nThe order of priority in which an Aurora Replica is promoted to the primary instance\nafter a failure of the existing primary instance. For more information,\nsee [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.\nThis setting doesn't apply to RDS Custom DB instances.\nDefault: `1`\nValid Values: `0 - 15`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-promotiontier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nIndicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name,\nwhich 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\nthe [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-publiclyaccessible", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplyImmediately": { "MarkdownDocumentation": "`ApplyImmediately`\n\nSpecifies whether changes to the DB instance and any pending modifications are applied\nimmediately, regardless of the `PreferredMaintenanceWindow` setting. If set to\n`false`, changes are applied during the next maintenance window. Until RDS\napplies the changes, the DB instance remains in a drift state. As a result, the\nconfiguration doesn't fully reflect the requested modifications and temporarily diverges\nfrom the intended state.\nIn addition to the settings described in [Modifying a DB\ninstance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html), this property also determines whether the DB instance reboots when a\nstatic parameter is modified in the associated DB parameter group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-applyimmediately", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DomainFqdn": { "MarkdownDocumentation": "`DomainFqdn`\n\nThe fully qualified domain name (FQDN) of an Active Directory domain.\nConstraints:\n* Can't be longer than 64 characters.\nExample: `mymanagedADtest.mymanagedAD.mydomain`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainfqdn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CharacterSetName": { "MarkdownDocumentation": "`CharacterSetName`\n\nFor supported engines, indicates that the DB instance should be associated with the\nspecified character set.\n**Amazon Aurora**\nNot applicable. The character set is managed by the DB cluster. For more information,\nsee [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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-charactersetname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MonitoringRoleArn": { "MarkdownDocumentation": "`MonitoringRoleArn`\n\nThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\nexample, `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role,\nsee [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)\nin 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 DB 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-monitoringrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssociatedRoles": { "MarkdownDocumentation": "`AssociatedRoles`\n\nThe 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*: Array of [DBInstanceRole](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-associatedroles", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "DBInstanceRole", "DuplicatesAllowed": true }, "DomainOu": { "MarkdownDocumentation": "`DomainOu`\n\nThe Active Directory organizational unit for your DB instance to join.\nConstraints:\n* Must be in the distinguished name format.\n* Can't be longer than 64 characters.\nExample: `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainou", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DBClusterSnapshotIdentifier": { "MarkdownDocumentation": "`DBClusterSnapshotIdentifier`\n\nThe identifier for the Multi-AZ DB cluster snapshot to restore from.\nFor more information on Multi-AZ DB clusters, see [Multi-AZ DB\ncluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User\nGuide*.\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`\n must be the ARN of the shared snapshot.\n* Can't be the identifier of an Aurora 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclustersnapshotidentifier", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SourceDBInstanceAutomatedBackupsArn": { "MarkdownDocumentation": "`SourceDBInstanceAutomatedBackupsArn`\n\nThe Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,\n`arn:aws:rds:us-east-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbinstanceautomatedbackupsarn", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "ProcessorFeatures": { "MarkdownDocumentation": "`ProcessorFeatures`\n\nThe 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 Amazon Aurora or RDS Custom DB instances.\n*Required*: No\n*Type*: Array of [ProcessorFeature](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-processorfeatures", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ProcessorFeature", "DuplicatesAllowed": true }, "PreferredBackupWindow": { "MarkdownDocumentation": "`PreferredBackupWindow`\n\nThe daily time range during which automated backups are created if automated backups are enabled,\nusing 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\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-preferredbackupwindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RestoreTime": { "MarkdownDocumentation": "`RestoreTime`\n\nThe date and time to restore from. This parameter applies to point-in-time recovery. For more\ninformation, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html)\nin the in the *Amazon RDS User Guide*.\nConstraints:\n* Must be a time in Universal Coordinated Time (UTC) format.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-restoretime", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "CertificateRotationRestart": { "MarkdownDocumentation": "`CertificateRotationRestart`\n\nSpecifies whether the DB instance is restarted when you rotate your\nSSL/TLS certificate.\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate\nis not updated until the DB instance is restarted.\n###### Important\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\nDB engine to rotate your SSL/TLS certificate:\n* For more information about rotating your SSL/TLS certificate for RDS DB engines, see\n [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\n [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 DB instances.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-certificaterotationrestart", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nThe 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.\nA `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6\nprotocols (`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\n*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-networktype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DedicatedLogVolume": { "MarkdownDocumentation": "`DedicatedLogVolume`\n\nIndicates whether the DB instance has a dedicated log volume (DLV) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dedicatedlogvolume", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CopyTagsToSnapshot": { "MarkdownDocumentation": "`CopyTagsToSnapshot`\n\nSpecifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.\nThis setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-copytagstosnapshot", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DomainIAMRoleName": { "MarkdownDocumentation": "`DomainIAMRoleName`\n\nThe name of the IAM role to use when making API calls to the Directory Service.\nThis setting doesn't apply to the following DB instances:\n* Amazon Aurora (The domain is managed by the DB cluster.)\n* 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainiamrolename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ReplicaMode": { "MarkdownDocumentation": "`ReplicaMode`\n\nThe open mode of an Oracle read replica.\nFor more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-replicamode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EngineLifecycleSupport": { "MarkdownDocumentation": "`EngineLifecycleSupport`\n\nThe life cycle type for this DB instance.\n###### Note\nBy default, this value is set to `open-source-rds-extended-support`, which enrolls your DB instance into Amazon RDS Extended Support.\nAt the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case,\ncreating the DB instance will fail if the DB major version is past its end of standard support date.\nThis setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.\nYou can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support,\nyou can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.\nValid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`\nDefault: `open-source-rds-extended-support`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enginelifecyclesupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LicenseModel": { "MarkdownDocumentation": "`LicenseModel`\n\nLicense model information for this DB instance.\nValid Values:\n* Aurora MySQL - `general-public-license`\n* Aurora PostgreSQL - `postgresql-license`\n* RDS for Db2 - `bring-your-own-license`. For more information about RDS for Db2 licensing, see\n in the\n *Amazon RDS User Guide.*\n* RDS for MariaDB - `general-public-license`\n* RDS for Microsoft SQL Server - `license-included`\n* RDS for MySQL - `general-public-license`\n* RDS for Oracle - `bring-your-own-license` or `license-included`\n* RDS for PostgreSQL - `postgresql-license`\n###### Note\nIf you've specified `DBSecurityGroups` and then you update the license\nmodel, AWS CloudFormation replaces the underlying DB instance. This will incur some\ninterruptions 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-licensemodel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainDnsIps": { "MarkdownDocumentation": "`DomainDnsIps`\n\nThe IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.\nConstraints:\n* Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.\nExample: `123.124.125.126,234.235.236.237`\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domaindnsips", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe weekly time range during which system maintenance can occur, in Universal\nCoordinated 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\neach AWS Region, occurring on a random day of the week. To see the time blocks\navailable, see [Maintaining a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the\n*Amazon RDS User Guide.*\n###### Note\nThis property applies when AWS CloudFormation initially creates the DB instance.\nIf you use AWS CloudFormation to update the DB instance, those updates are applied\nimmediately.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-preferredmaintenancewindow", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Iops": { "MarkdownDocumentation": "`Iops`\n\nThe number of I/O operations per second (IOPS) that the database provisions. The value\nmust be equal to or greater than 1000.\nIf you specify this property, you must follow the range of allowed ratios of your\nrequested IOPS rate to the amount of storage that you allocate (IOPS to allocated\nstorage). For example, you can provision an Oracle database instance with 1000 IOPS and\n200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio\nof 10:1). For more information, see [Amazon RDS\nProvisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS\nUser Guide*.\n###### Note\nIf you specify `io1` for the `StorageType` property, then\nyou must also specify the `Iops` property.\nConstraints:\n* For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.\n* For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-iops", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SourceRegion": { "MarkdownDocumentation": "`SourceRegion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourceregion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BackupTarget": { "MarkdownDocumentation": "`BackupTarget`\n\nThe location for storing automated backups and manual snapshots.\nValid Values:\n* `local` (Dedicated Local Zone)\n* `outposts` (AWS Outposts)\n* `region` (AWS Region)\nDefault: `region`\nFor more information, see [Working\nwith Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-backuptarget", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "UseLatestRestorableTime": { "MarkdownDocumentation": "`UseLatestRestorableTime`\n\nSpecifies whether the DB instance is restored from the latest backup time. By default, the DB instance\nisn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more\ninformation, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html)\nin the in the *Amazon RDS User Guide*.\nConstraints:\n* 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-uselatestrestorabletime", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Boolean" }, "CACertificateIdentifier": { "MarkdownDocumentation": "`CACertificateIdentifier`\n\nThe identifier of the CA certificate for this DB instance.\nFor more information, see [Using SSL/TLS to encrypt a connection to a DB\ninstance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and\n[Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora\nUser 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-cacertificateidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ManageMasterUserPassword": { "MarkdownDocumentation": "`ManageMasterUserPassword`\n\nSpecifies 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)\nin the *Amazon RDS User Guide.*\nConstraints:\n* Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword`\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-managemasteruserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SourceDbiResourceId": { "MarkdownDocumentation": "`SourceDbiResourceId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbiresourceid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DomainAuthSecretArn": { "MarkdownDocumentation": "`DomainAuthSecretArn`\n\nThe ARN for the Secrets Manager secret with the credentials for the user joining the domain.\nExample: `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainauthsecretarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VPCSecurityGroups": { "MarkdownDocumentation": "`VPCSecurityGroups`\n\nA list of the VPC security group IDs to assign to the DB instance. The list can\ninclude 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.\nIf you set `VPCSecurityGroups`, you must not set [`DBSecurityGroups`](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.\n###### Important\nYou can migrate a DB instance in your stack from an RDS DB security group to a VPC\nsecurity group, but keep the following in mind:\n* You can't revert to using an RDS security group after you establish a VPC\n security group membership.\n* When you migrate your DB instance to VPC security groups, if your stack\n update rolls back because the DB instance update fails or because an update\n fails in another AWS CloudFormation resource, the rollback fails because it\n can't revert to an RDS security group.\n* To use the properties that are available when you use a VPC security\n group, you must recreate the DB instance. If you don't, AWS CloudFormation\n submits only the property values that are listed in the [`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\nwhen 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\nthe DB cluster. If specified, the setting must match the DB cluster setting.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-vpcsecuritygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "AutomaticBackupReplicationRegion": { "MarkdownDocumentation": "`AutomaticBackupReplicationRegion`\n\nThe AWS Region associated with the automated backup.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-automaticbackupreplicationregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllowMajorVersionUpgrade": { "MarkdownDocumentation": "`AllowMajorVersionUpgrade`\n\nA value that indicates whether major version upgrades are allowed. Changing this\nparameter doesn't result in an outage and the change is asynchronously applied as soon\nas possible.\nConstraints: Major version upgrades must be allowed when specifying a value for the\n`EngineVersion` parameter that is a different major version than the DB\ninstance'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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-allowmajorversionupgrade", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DBName": { "MarkdownDocumentation": "`DBName`\n\nThe meaning of this parameter differs according to the database engine you use.\n###### Important\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**Db2**\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.\nConstraints:\n* Must contain 1 to 64 letters or numbers.\n* Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n* Can't be a word reserved by the specified database engine.\n**MySQL**\nThe name of the database to create when the DB instance is created. If this parameter\nis 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\nis 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\nis not specified, the default `postgres` database is created in the DB instance.\nConstraints:\n* Must begin with a letter. Subsequent characters can be\n 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\n`null`, the default value `ORCL` is used. You can't specify\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnableIAMDatabaseAuthentication": { "MarkdownDocumentation": "`EnableIAMDatabaseAuthentication`\n\nA value that indicates whether to enable mapping of AWS Identity and Access\nManagement (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.\nFor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enableiamdatabaseauthentication", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "BackupRetentionPeriod": { "MarkdownDocumentation": "`BackupRetentionPeriod`\n\nThe number of days for which automated backups are retained. Setting this parameter to\na positive number enables backups. Setting this parameter to 0 disables automated\nbackups.\n**Amazon Aurora**\nNot applicable. The retention period for automated backups is managed by the DB\ncluster.\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*Minimum*: `0`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-backupretentionperiod", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "Integer" }, "CustomIAMInstanceProfile": { "MarkdownDocumentation": "`CustomIAMInstanceProfile`\n\nThe instance profile associated with the underlying Amazon EC2 instance of an\nRDS Custom DB instance.\nThis setting is required for RDS Custom.\nConstraints:\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\n[Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-customiaminstanceprofile", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DBSnapshotIdentifier": { "MarkdownDocumentation": "`DBSnapshotIdentifier`\n\nThe name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the\nDB instance. If you're restoring from a shared manual DB snapshot, you must specify the\nARN of the snapshot.\nBy specifying this property, you can create a DB instance from the specified DB\nsnapshot. If the `DBSnapshotIdentifier` property is an empty string or the\n`AWS::RDS::DBInstance` declaration has no\n`DBSnapshotIdentifier` property, AWS CloudFormation creates a new\ndatabase. If the property contains a value (other than an empty string), AWS\nCloudFormation creates a database from the specified snapshot. If a snapshot with the\nspecified name doesn't exist, AWS CloudFormation can't create the database and it rolls\nback the stack.\nSome DB instance properties aren't valid when you restore from a snapshot, such as the\n`MasterUsername` and `MasterUserPassword` properties, and the\npoint-in-time recovery properties `RestoreTime` and\n`UseLatestRestorableTime`. For information about the properties that you can\nspecify, see the [`RestoreDBInstanceFromDBSnapshot`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) action in the *Amazon\nRDS API Reference*.\nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you\nmust specify the same `DBSnapshotIdentifier` property for any future updates\nto the DB instance. When you specify this property for an update, the DB instance is not\nrestored from the DB snapshot again, and the data in the database is not changed.\nHowever, if you don't specify the `DBSnapshotIdentifier` property, an empty\nDB instance is created, and the original DB instance is deleted. If you specify a\nproperty that is different from the previous snapshot restore property, a new DB\ninstance is restored from the specified `DBSnapshotIdentifier` property, and\nthe 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),\nthen don't specify the following properties:\n* `CharacterSetName`\n* `DBClusterIdentifier`\n* `DBName`\n* `KmsKeyId`\n* `MasterUsername`\n* `MasterUserPassword`\n* `PromotionTier`\n* `SourceDBInstanceIdentifier`\n* `SourceRegion`\n* `StorageEncrypted` (for an unencrypted 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsnapshotidentifier", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "EnableCloudwatchLogsExports": { "MarkdownDocumentation": "`EnableCloudwatchLogsExports`\n\nThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values\nin the list depend on the DB engine being used. For more information, see\n[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\nService User Guide*.\n**Amazon Aurora**\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.\n**Db2**\nValid values: `diag.log`, `notify.log`\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`, `oemagent`\n**PostgreSQL**\nValid values: `postgresql`, `upgrade`\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "UseDefaultProcessorFeatures": { "MarkdownDocumentation": "`UseDefaultProcessorFeatures`\n\nSpecifies whether the DB instance class of the DB instance uses its default\nprocessor features.\nThis setting doesn't apply to RDS Custom DB instances.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-usedefaultprocessorfeatures", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "DBSystemId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBSystemId`\n\nThe Oracle system ID (Oracle SID) for a container database (CDB).\nThe Oracle SID is also the name of the CDB.\nThis setting is valid for RDS Custom only.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#DBSystemId-fn::getatt" }, "StatusInfos": { "Type": "List", "ItemType": "DBInstanceStatusInfo", "MarkdownDocumentation": "`StatusInfos`\n\nThe status of a read replica. If the DB instance isn't a read replica, the value is blank.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#StatusInfos-fn::getatt" }, "ListenerEndpoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`ListenerEndpoint.Port`\n\nThe port number on which the database accepts connections.\nThis setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.\nValid Values: `1150-65535`\nDefault:\n* RDS for Db2 - `50000`\n* RDS for MariaDB - `3306`\n* RDS for Microsoft SQL Server - `1433`\n* RDS for MySQL - `3306`\n* RDS for Oracle - `1521`\n* RDS for PostgreSQL - `5432`\nConstraints:\n* For RDS for Microsoft SQL Server, the value can't be `1234`, `1434`,\n `3260`, `3343`, `3389`, `47001`, or\n `49152-49156`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#ListenerEndpoint.Port-fn::getatt" }, "ListenerEndpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`ListenerEndpoint.Address`\n\nThe connection endpoint for the database. For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#ListenerEndpoint.Address-fn::getatt" }, "InstanceCreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`InstanceCreateTime`\n\nThe date and time when the DB instance was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#InstanceCreateTime-fn::getatt" }, "CertificateDetails": { "Type": "CertificateDetails", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#CertificateDetails-fn::getatt" }, "AutomaticRestartTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutomaticRestartTime`\n\nThe time when a stopped DB instance is restarted automatically.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#AutomaticRestartTime-fn::getatt" }, "Endpoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.Port`\n\nThe port number on which the database accepts connections. For example:\n`3306`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#Endpoint.Port-fn::getatt" }, "DbiResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DbiResourceId`\n\nThe AWS Region-unique, immutable identifier for the DB instance.\nThis identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#DbiResourceId-fn::getatt" }, "MasterUserSecret.SecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MasterUserSecret.SecretArn`\n\nThe Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the `Fn::GetAtt`\nintrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#MasterUserSecret.SecretArn-fn::getatt" }, "ReadReplicaDBClusterIdentifiers": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ReadReplicaDBClusterIdentifiers`\n\nThe identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#ReadReplicaDBClusterIdentifiers-fn::getatt" }, "ResumeFullAutomationModeTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResumeFullAutomationModeTime`\n\nThe number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.\nThe minimum value is 60 (default). The maximum value is 1,440.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#ResumeFullAutomationModeTime-fn::getatt" }, "DBInstanceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBInstanceArn`\n\nThe Amazon Resource Name (ARN) for the DB instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#DBInstanceArn-fn::getatt" }, "Endpoint": { "Type": "Endpoint", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#Endpoint-fn::getatt" }, "CertificateDetails.ValidTill": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateDetails.ValidTill`\n\nThe expiration date of the DB instance\u2019s server certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#CertificateDetails.ValidTill-fn::getatt" }, "CertificateDetails.CAIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateDetails.CAIdentifier`\n\nThe CA identifier of the CA certificate used for the DB instance's server certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#CertificateDetails.CAIdentifier-fn::getatt" }, "LatestRestorableTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LatestRestorableTime`\n\nThe latest time to which a database in this DB instance can be restored with point-in-time restore.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#LatestRestorableTime-fn::getatt" }, "ListenerEndpoint.HostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ListenerEndpoint.HostedZoneId`\n\nThe ID of the hosted zone in that is associated with the database endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#ListenerEndpoint.HostedZoneId-fn::getatt" }, "IsStorageConfigUpgradeAvailable": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsStorageConfigUpgradeAvailable`\n\nIndicates whether an upgrade is recommended for the storage file system configuration on the DB instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#IsStorageConfigUpgradeAvailable-fn::getatt" }, "Endpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.Address`\n\nThe connection endpoint for the database. For example:\n`mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`\nFor Aurora Serverless DB clusters, the connection endpoint only applies to the DB cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#Endpoint.Address-fn::getatt" }, "DBInstanceStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBInstanceStatus`\n\nThe current state of this DB instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#DBInstanceStatus-fn::getatt" }, "ReadReplicaDBInstanceIdentifiers": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ReadReplicaDBInstanceIdentifiers`\n\nThe identifiers of the read replicas associated with this DB instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#ReadReplicaDBInstanceIdentifiers-fn::getatt" }, "PercentProgress": { "PrimitiveType": "String", "MarkdownDocumentation": "`PercentProgress`\n\nThe progress of the storage optimization operation as a percentage.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#PercentProgress-fn::getatt" }, "ListenerEndpoint": { "Type": "Endpoint", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#ListenerEndpoint-fn::getatt" }, "SecondaryAvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "`SecondaryAvailabilityZone`\n\nIf present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#SecondaryAvailabilityZone-fn::getatt" }, "Endpoint.HostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.HostedZoneId`\n\nThe ID that Amazon Route 53 assigns when you create a hosted zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#Endpoint.HostedZoneId-fn::getatt" } } }, "AWS::RDS::DBParameterGroup": { "MarkdownDocumentation": "`AWS::RDS::DBParameterGroup`\n\nThe `AWS::RDS::DBParameterGroup` resource creates a custom parameter group\nfor an RDS database family.\nThis type can be declared in a template and referenced in the\n`DBParameterGroupName` property of an `[AWS::RDS::DBInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html)` resource.\nFor information about configuring parameters for Amazon RDS DB instances, see\n[Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)\nin the *Amazon RDS User Guide*.\nFor information about configuring parameters for Amazon Aurora DB instances, see\n[Working with parameter\ngroups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n###### Note\nApplying a parameter group to a DB instance may require the DB instance to reboot,\nresulting in a database outage for the duration of the reboot.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the DB parameter group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html", "Properties": { "DBParameterGroupName": { "MarkdownDocumentation": "`DBParameterGroupName`\n\nThe 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.\n###### Note\nThis value is stored as a lowercase string.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z]{1}(?:-?[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-dbparametergroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nProvides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nA mapping of parameter names and values for the parameter update. You must specify at\nleast one parameter name and value.\nFor more information about parameter groups, see [Working with\nparameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working\nwith parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the\n*Amazon Aurora User Guide*.\n###### Note\nAWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default\napply 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-parameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Family": { "MarkdownDocumentation": "`Family`\n\nThe 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 database engine and engine version compatible with that DB parameter group family.\nTo list all of the available parameter group families for a DB engine, use the following command:\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine `\nFor example, to list all of the available parameter group families for the MySQL DB engine, use the following command:\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql`\n###### Note\nThe output contains duplicates.\nThe following are the valid DB engine values:\n* `aurora-mysql`\n* `aurora-postgresql`\n* `db2-ae`\n* `db2-se`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the DB parameter group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-dbparametergroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "DBParameterGroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBParameterGroupName`\n\nThe name of the DB parameter group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#DBParameterGroupName-fn::getatt" } } }, "AWS::RDS::DBProxy": { "MarkdownDocumentation": "`AWS::RDS::DBProxy`\n\nThe `AWS::RDS::DBProxy` resource creates or updates a DB proxy.\nFor information about RDS Proxy for Amazon RDS, see [Managing Connections with Amazon\nRDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html) in the *Amazon RDS User Guide*.\nFor information about RDS Proxy for Amazon Aurora, see [Managing Connections with\nAmazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html) in the *Amazon Aurora User Guide*.\n###### Note\nLimitations apply to RDS Proxy, including DB engine version limitations and AWS\nRegion limitations.\nFor information about limitations that apply to RDS Proxy for Amazon RDS, see\n[Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon RDS User Guide*.\nFor information about that apply to RDS Proxy for Amazon Aurora, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon Aurora User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the DB proxy.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html", "Properties": { "DBProxyName": { "MarkdownDocumentation": "`DBProxyName`\n\nThe 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*Pattern*: `[0-z]*`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-dbproxyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DebugLogging": { "MarkdownDocumentation": "`DebugLogging`\n\nSpecifies whether the proxy logs detailed connection and query information.\nWhen you enable `DebugLogging`, the proxy captures connection details\nand connection pool behavior from your queries. Debug logging increases CloudWatch costs\nand can impact proxy performance. Enable this option only when you need\nto troubleshoot connection or performance issues.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-debuglogging", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VpcSubnetIds": { "MarkdownDocumentation": "`VpcSubnetIds`\n\nOne or more VPC subnet IDs to associate with the new proxy.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsubnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RequireTLS": { "MarkdownDocumentation": "`RequireTLS`\n\nSpecifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\nBy 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-requiretls", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IdleClientTimeout": { "MarkdownDocumentation": "`IdleClientTimeout`\n\nThe number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-idleclienttimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "TargetConnectionNetworkType": { "MarkdownDocumentation": "`TargetConnectionNetworkType`\n\nThe network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.\nValid values:\n* `IPV4` - The proxy connects to the database using IPv4 only.\n* `IPV6` - The proxy connects to the database using IPv6 only.\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)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-targetconnectionnetworktype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DefaultAuthScheme": { "MarkdownDocumentation": "`DefaultAuthScheme`\n\nThe default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.\nValid values are `NONE` and `IAM_AUTH`.\nWhen set to `IAM_AUTH`, the proxy uses end-to-end IAM authentication to connect to the database.\n*Required*: No\n*Type*: String\n*Allowed values*: `IAM_AUTH | NONE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IAM_AUTH", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-defaultauthscheme", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nOne or more VPC security group IDs to associate with the new proxy.\nIf you plan to update the resource, don't specify VPC security groups in a shared VPC.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Auth": { "MarkdownDocumentation": "`Auth`\n\nThe authorization mechanism that the proxy uses.\n*Required*: No\n*Type*: Array of [AuthFormat](./aws-properties-rds-dbproxy-authformat.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-auth", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AuthFormat", "DuplicatesAllowed": true }, "EngineFamily": { "MarkdownDocumentation": "`EngineFamily`\n\nThe kinds of databases that the proxy can connect to.\nThis value determines which database network protocol the proxy recognizes when it interprets\nnetwork traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`.\nFor Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`. For RDS for Microsoft SQL Server, specify\n`SQLSERVER`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MYSQL | POSTGRESQL | SQLSER...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "MYSQL", "POSTGRESQL", "SQLSERVER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-enginefamily", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.\n*Required*: No\n*Type*: Array of [TagFormat](./aws-properties-rds-dbproxy-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagFormat", "DuplicatesAllowed": true }, "EndpointNetworkType": { "MarkdownDocumentation": "`EndpointNetworkType`\n\nThe network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.\nValid values:\n* `IPV4` - The proxy endpoint supports IPv4 only.\n* `IPV6` - The proxy endpoint supports IPv6 only.\n* `DUAL` - The proxy endpoint supports both IPv4 and IPv6.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | IPV6 | DUAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6", "DUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-endpointnetworktype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\nconnection string for a database client application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#Endpoint-fn::getatt" }, "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe VPC ID to associate with the DB proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#VpcId-fn::getatt" }, "DBProxyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBProxyArn`\n\nThe Amazon Resource Name (ARN) for the proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#DBProxyArn-fn::getatt" } } }, "AWS::RDS::DBProxyEndpoint": { "MarkdownDocumentation": "`AWS::RDS::DBProxyEndpoint`\n\nThe `AWS::RDS::DBProxyEndpoint` resource creates or updates a DB proxy endpoint. You can use custom proxy endpoints to access a proxy through a different\nVPC than the proxy's default VPC.\nFor more information about RDS Proxy, see\n[AWS::RDS::DBProxy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the DB proxy endpoint.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html", "Properties": { "DBProxyEndpointName": { "MarkdownDocumentation": "`DBProxyEndpointName`\n\nThe name of the DB proxy endpoint to create.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-z]*`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-dbproxyendpointname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DBProxyName": { "MarkdownDocumentation": "`DBProxyName`\n\nThe name of the DB proxy associated with the DB proxy endpoint that you create.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-z]*`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-dbproxyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetRole": { "MarkdownDocumentation": "`TargetRole`\n\nA value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.\n*Required*: No\n*Type*: String\n*Allowed values*: `READ_WRITE | READ_ONLY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "READ_WRITE", "READ_ONLY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-targetrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nThe VPC security group IDs for the DB proxy endpoint that you create. You can\nspecify a different set of security group IDs than for the original DB proxy.\nThe default is the default security group for the VPC.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "VpcSubnetIds": { "MarkdownDocumentation": "`VpcSubnetIds`\n\nThe VPC subnet IDs for the DB proxy endpoint that you create. You can specify a\ndifferent set of subnet IDs than for the original DB proxy.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `2`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-vpcsubnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.\n*Required*: No\n*Type*: Array of [TagFormat](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagFormat", "DuplicatesAllowed": true }, "EndpointNetworkType": { "MarkdownDocumentation": "`EndpointNetworkType`\n\nThe network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.\nValid values:\n* `IPV4` - The proxy endpoint supports IPv4 only.\n* `IPV6` - The proxy endpoint supports IPv6 only.\n* `DUAL` - The proxy endpoint supports both IPv4 and IPv6.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | IPV6 | DUAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6", "DUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-endpointnetworktype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "DBProxyEndpointArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBProxyEndpointArn`\n\nThe Amazon Resource Name (ARN) for the DB proxy endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#DBProxyEndpointArn-fn::getatt" }, "IsDefault": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`IsDefault`\n\nIndicates whether this endpoint is the default endpoint for the associated DB proxy.\nDefault DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\nDB proxy can be either read/write or read-only.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#IsDefault-fn::getatt" }, "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nProvides the VPC ID of the DB proxy endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#VpcId-fn::getatt" }, "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\nconnection string for a database client application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#Endpoint-fn::getatt" } } }, "AWS::RDS::DBProxyTargetGroup": { "MarkdownDocumentation": "`AWS::RDS::DBProxyTargetGroup`\n\nThe `AWS::RDS::DBProxyTargetGroup` resource represents a set of RDS DB\ninstances, Aurora DB clusters, or both that a proxy can connect to. Currently, each\ntarget group is associated with exactly one RDS DB instance or Aurora DB cluster.\nThis data type is used as a response element in the\n`DescribeDBProxyTargetGroups` action.\nFor information about RDS Proxy for Amazon RDS, see [Managing Connections with Amazon\nRDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html) in the *Amazon RDS User Guide*.\nFor information about RDS Proxy for Amazon Aurora, see [Managing Connections with\nAmazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html) in the *Amazon Aurora User Guide*.\nFor a sample template that creates a DB proxy and registers a DB instance, see\n[Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#aws-resource-rds-dbproxy--examples) in AWS::RDS::DBProxy.\n###### Note\nLimitations apply to RDS Proxy, including DB engine version limitations and AWS\nRegion limitations.\nFor information about limitations that apply to RDS Proxy for Amazon RDS, see\n[Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon RDS User Guide*.\nFor information about that apply to RDS Proxy for Amazon Aurora, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon Aurora User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the target group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html", "Properties": { "DBProxyName": { "MarkdownDocumentation": "`DBProxyName`\n\nThe identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[A-z][0-z]*`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbproxyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DBInstanceIdentifiers": { "MarkdownDocumentation": "`DBInstanceIdentifiers`\n\nOne or more DB instance identifiers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbinstanceidentifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TargetGroupName": { "MarkdownDocumentation": "`TargetGroupName`\n\nThe identifier for the target group.\n###### Note\nCurrently, this property must be set to `default`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `default`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "default" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-targetgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ConnectionPoolConfigurationInfo": { "MarkdownDocumentation": "`ConnectionPoolConfigurationInfo`\n\nDisplays the settings that control the size and behavior of the connection pool associated with a `DBProxyTarget`.\n*Required*: No\n*Type*: [ConnectionPoolConfigurationInfoFormat](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfo", "UpdateType": "Mutable", "Required": false, "Type": "ConnectionPoolConfigurationInfoFormat" }, "DBClusterIdentifiers": { "MarkdownDocumentation": "`DBClusterIdentifiers`\n\nOne or more DB cluster identifiers.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbclusteridentifiers", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "TargetGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TargetGroupArn`\n\nThe Amazon Resource Name (ARN) representing the target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#TargetGroupArn-fn::getatt" } } }, "AWS::RDS::DBSecurityGroup": { "MarkdownDocumentation": "`AWS::RDS::DBSecurityGroup`\n\nThe `AWS::RDS::DBSecurityGroup` resource creates or updates an Amazon RDS\nDB security group.\n###### Note\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that\nyou migrate as soon as possible. For more information, see [Migrate from EC2-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the\n*Amazon EC2 User Guide*, the blog [EC2-Classic Networking is Retiring \u2013\nHere\u2019s How to Prepare](https://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and [Moving a DB instance not in a VPC\ninto a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html", "Properties": { "DBSecurityGroupIngress": { "MarkdownDocumentation": "`DBSecurityGroupIngress`\n\nIngress rules to be applied to the DB security group.\n*Required*: Yes\n*Type*: Array of [Ingress](./aws-properties-rds-dbsecuritygroup-ingress.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-dbsecuritygroupingress", "DuplicatesAllowed": false, "ItemType": "Ingress", "Required": true, "Type": "List", "UpdateType": "Mutable" }, "EC2VpcId": { "MarkdownDocumentation": "`EC2VpcId`\n\nThe identifier of an Amazon virtual private cloud (VPC). This property indicates the VPC that this DB security\ngroup belongs to.\n###### Important\nThis property is included for backwards compatibility and is no longer recommended for providing security information to an RDS\nDB 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-ec2vpcid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "GroupDescription": { "MarkdownDocumentation": "`GroupDescription`\n\nProvides 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-groupdescription", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\nFor more information, see\n[Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or\n[Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-dbsecuritygroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::RDS::DBSecurityGroupIngress": { "MarkdownDocumentation": "`AWS::RDS::DBSecurityGroupIngress`\n\nThe `AWS::RDS::DBSecurityGroupIngress` resource enables ingress to a DB\nsecurity group using one of two forms of authorization. First, you can add EC2 or VPC\nsecurity groups to the DB security group if the application using the database is\nrunning on EC2 or VPC instances. Second, IP ranges are available if the application\naccessing your database is running on the Internet.\nThis type supports updates. For more information about updating stacks, see [AWS\nCloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\nFor details about the settings for DB security group ingress, see [AuthorizeDBSecurityGroupIngress](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthorizeDBSecurityGroupIngress.html).\n###### Note\nEC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that\nyou migrate as soon as possible. For more information, see [Migrate from EC2-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the\n*Amazon EC2 User Guide*, the blog [EC2-Classic Networking is Retiring \u2013\nHere\u2019s How to Prepare](https://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and [Moving a DB instance not in a VPC\ninto a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html", "Properties": { "CIDRIP": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-cidrip", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "DBSecurityGroupName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-dbsecuritygroupname", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "EC2SecurityGroupId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "EC2SecurityGroupName": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "EC2SecurityGroupOwnerId": { "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupownerid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::RDS::DBShardGroup": { "MarkdownDocumentation": "`AWS::RDS::DBShardGroup`\n\nCreates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.\nValid for: Aurora DB clusters only\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name (`DBClusterIdentifier`) of the DB cluster.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html", "Properties": { "DBClusterIdentifier": { "MarkdownDocumentation": "`DBClusterIdentifier`\n\nThe name of the primary DB cluster for the DB shard group.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-dbclusteridentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ComputeRedundancy": { "MarkdownDocumentation": "`ComputeRedundancy`\n\nSpecifies whether to create standby standby DB data access shard for the DB shard group.\nValid values are the following:\n* 0 - Creates a DB shard group without a standby DB data access shard. This is the default value.\n* 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ).\n* 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-computeredundancy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DBShardGroupIdentifier": { "MarkdownDocumentation": "`DBShardGroupIdentifier`\n\nThe name of the DB shard group.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-dbshardgroupidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nSpecifies whether the DB shard group is publicly accessible.\nWhen the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from\nwithin the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC.\nAccess to the DB shard group is ultimately controlled by the security group it uses.\nThat public access is not permitted if the security group assigned to the DB shard group doesn't permit it.\nWhen the DB shard group isn't publicly accessible, it is an internal DB shard group 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 shard group is private.\n* If the default VPC in the target Region has an internet gateway attached to it, the DB shard group 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 shard group is private.\n* If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-publiclyaccessible", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MaxACU": { "MarkdownDocumentation": "`MaxACU`\n\nThe maximum capacity of the DB shard group in Aurora capacity units (ACUs).\n*Required*: Yes\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-maxacu", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "MinACU": { "MarkdownDocumentation": "`MinACU`\n\nThe minimum capacity of the DB shard group in Aurora capacity units (ACUs).\n*Required*: No\n*Type*: Number\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-minacu", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-dbshardgroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThis data type represents the information you need to connect to an Amazon RDS DB instance.\nThis data type is used as a response element in the following actions:\n* `CreateDBInstance`\n* `DescribeDBInstances`\n* `DeleteDBInstance`\nFor the data structure that represents Amazon Aurora DB cluster endpoints,\nsee `DBClusterEndpoint`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#Endpoint-fn::getatt" }, "DBShardGroupResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DBShardGroupResourceId`\n\nThe AWS Region-unique, immutable identifier for the DB shard group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#DBShardGroupResourceId-fn::getatt" } } }, "AWS::RDS::DBSubnetGroup": { "MarkdownDocumentation": "`AWS::RDS::DBSubnetGroup`\n\nThe `AWS::RDS::DBSubnetGroup` resource creates a database subnet group.\nSubnet groups must contain at least two subnets in two different Availability Zones in\nthe same region.\nFor more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the DB subnet group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html", "Properties": { "DBSubnetGroupName": { "MarkdownDocumentation": "`DBSubnetGroupName`\n\nThe name for the DB subnet group. This value is stored as a lowercase string.\nConstraints:\n* Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.\n* Must not be default.\n* First character must be a letter.\nExample: `mydbsubnetgroup`\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DBSubnetGroupDescription": { "MarkdownDocumentation": "`DBSubnetGroupDescription`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupdescription", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe EC2 Subnet IDs for the DB subnet group.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the DB subnet group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-dbsubnetgroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::RDS::EventSubscription": { "MarkdownDocumentation": "`AWS::RDS::EventSubscription`\n\nThe `AWS::RDS::EventSubscription` resource allows you to receive\nnotifications for Amazon Relational Database Service events through the Amazon Simple\nNotification Service (Amazon SNS). For more information, see [Using Amazon RDS Event\nNotification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the RDS event subscription.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html", "Properties": { "SourceType": { "MarkdownDocumentation": "`SourceType`\n\nThe type of source that is generating the events. For example, if you want to be\nnotified of events generated by a DB instance, you set this parameter to\n`db-instance`. For RDS Proxy events, specify `db-proxy`. If this value isn't specified, all events are\nreturned.\nValid Values: `db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "EventCategories": { "MarkdownDocumentation": "`EventCategories`\n\nA list of event categories for a particular source type (`SourceType`)\nthat 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 [*Amazon RDS User Guide*](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the\n[*Amazon Aurora User Guide*](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html).\nYou can also see this list by using the `DescribeEventCategories` operation.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-eventcategories", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SubscriptionName": { "MarkdownDocumentation": "`SubscriptionName`\n\nThe name of the subscription.\nConstraints: The name must be less than 255 characters.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-subscriptionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SnsTopicArn": { "MarkdownDocumentation": "`SnsTopicArn`\n\nThe Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS\nautomatically creates the ARN when you create a topic and subscribe to it.\n###### Note\nRDS doesn't support FIFO (first in, first out) topics. For more information, see\n[Message\nordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple\nNotification 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-snstopicarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceIds": { "MarkdownDocumentation": "`SourceIds`\n\nThe list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response.\nAn 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 `SourceIds` are 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* If the source type is an RDS Proxy, a `DBProxyName` value must be supplied.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional array of key-value pairs to apply to this subscription.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-eventsubscription-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::RDS::GlobalCluster": { "MarkdownDocumentation": "`AWS::RDS::GlobalCluster`\n\nThe `AWS::RDS::GlobalCluster` resource creates or updates an Amazon Aurora global database\nspread across multiple AWS Regions.\nThe global database contains a single primary cluster with read-write capability,\nand a read-only secondary cluster that receives\ndata from the primary cluster through high-speed replication\nperformed by the Aurora storage subsystem.\nYou can create a global database that is initially empty, and then\nadd a primary cluster and a secondary cluster to it.\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", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the global database cluster.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html", "Properties": { "EngineLifecycleSupport": { "MarkdownDocumentation": "`EngineLifecycleSupport`\n\nThe life cycle type for this global database cluster.\n###### Note\nBy default, this value is set to `open-source-rds-extended-support`, which enrolls your global cluster into Amazon RDS Extended Support.\nAt the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case,\ncreating the global cluster will fail if the DB major version is past its end of standard support date.\nThis setting only applies to Aurora PostgreSQL-based global databases.\nYou can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support,\nyou can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide*.\nValid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`\nDefault: `open-source-rds-extended-support`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-enginelifecyclesupport", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StorageEncrypted": { "MarkdownDocumentation": "`StorageEncrypted`\n\nSpecifies whether to enable storage encryption for the new global database cluster.\nConstraints:\n* Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the setting from the source 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-storageencrypted", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "EngineVersion": { "MarkdownDocumentation": "`EngineVersion`\n\nThe engine version to use for this global database cluster.\nConstraints:\n* Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the engine version 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engineversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SourceDBClusterIdentifier": { "MarkdownDocumentation": "`SourceDBClusterIdentifier`\n\nThe Amazon Resource Name (ARN) to use as the primary cluster of the global database.\nIf you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:\n* `DatabaseName`\n* `Engine`\n* `EngineVersion`\n* `StorageEncrypted`\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z]{1}(?:-?[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-sourcedbclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DeletionProtection": { "MarkdownDocumentation": "`DeletionProtection`\n\nSpecifies whether to enable deletion protection for the new global database cluster.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-deletionprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "GlobalClusterIdentifier": { "MarkdownDocumentation": "`GlobalClusterIdentifier`\n\nThe cluster identifier for this global database cluster. This parameter is stored as a lowercase string.\n*Required*: Conditional\n*Type*: String\n*Pattern*: `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-globalclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Engine": { "MarkdownDocumentation": "`Engine`\n\nThe database engine to use for this global database cluster.\nValid Values: `aurora-mysql | aurora-postgresql`\nConstraints:\n* Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.\n*Required*: Conditional\n*Type*: String\n*Allowed values*: `aurora | aurora-mysql | aur...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "aurora", "aurora-mysql", "aurora-postgresql" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engine", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\nFor more information, see\n[Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or\n[Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-globalcluster-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "GlobalEndpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#GlobalEndpoint.Address-fn::getatt" }, "GlobalEndpoint": { "Type": "GlobalEndpoint", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#GlobalEndpoint-fn::getatt" } } }, "AWS::RDS::Integration": { "MarkdownDocumentation": "`AWS::RDS::Integration`\n\nA zero-ETL integration with Amazon Redshift.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the integration.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html", "Properties": { "DataFilter": { "MarkdownDocumentation": "`DataFilter`\n\nData filters for the integration. These filters determine which tables\nfrom the source database are sent to the target Amazon Redshift data warehouse.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_ \"\\\\\\-$,*.:?+\\/]*`\n*Minimum*: `1`\n*Maximum*: `25600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-datafilter", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IntegrationName": { "MarkdownDocumentation": "`IntegrationName`\n\nThe name of the integration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-integrationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the integration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KMSKeyId": { "MarkdownDocumentation": "`KMSKeyId`\n\nThe AWS Key Management System (AWS KMS) key identifier for the key to use to\nencrypt the integration. If you don't specify an encryption key, RDS uses a default\nAWS owned 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe Amazon Resource Name (ARN) of the database to use as the source for\nreplication.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:aws[a-z\\-]*:rds(-[a-z]*)?:[a-z0-9\\-]*:[0-9]*:(cluster|db):[a-z][a-z0-9]*(-[a-z0-9]+)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-sourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe ARN of the Redshift data warehouse to use as the target for replication.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-targetarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AdditionalEncryptionContext": { "MarkdownDocumentation": "`AdditionalEncryptionContext`\n\nAn optional set of non-secret key\u2013value pairs that contains additional contextual\ninformation about the data. For more information, see [Encryption\ncontext](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the *AWS Key Management Service Developer\nGuide*.\nYou can only include this parameter if you specify the `KMSKeyId` parameter.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\s\\S]*$`\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-additionalencryptioncontext", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn optional array of key-value pairs to apply to this integration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-integration-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "IntegrationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IntegrationArn`\n\nThe ARN of the integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#IntegrationArn-fn::getatt" }, "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe time when the integration was created, in Universal Coordinated Time\n(UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#CreateTime-fn::getatt" } } }, "AWS::RDS::OptionGroup": { "MarkdownDocumentation": "`AWS::RDS::OptionGroup`\n\nThe `AWS::RDS::OptionGroup` resource creates or updates an option group, to enable and\nconfigure features that are specific to a particular DB engine.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the option group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html", "Properties": { "OptionGroupDescription": { "MarkdownDocumentation": "`OptionGroupDescription`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OptionGroupName": { "MarkdownDocumentation": "`OptionGroupName`\n\nThe 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.\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OptionConfigurations": { "MarkdownDocumentation": "`OptionConfigurations`\n\nA list of all available options for an option group.\n*Required*: Conditional\n*Type*: Array of [OptionConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OptionConfiguration", "DuplicatesAllowed": true }, "MajorEngineVersion": { "MarkdownDocumentation": "`MajorEngineVersion`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EngineName": { "MarkdownDocumentation": "`EngineName`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to assign to the option group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rds-optiongroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::RUM::AppMonitor": { "MarkdownDocumentation": "`AWS::RUM::AppMonitor`\n\nCreates a CloudWatch RUM app monitor, which you can use to collect telemetry data from your application\nand send it to CloudWatch RUM. The data includes performance and reliability information such as\npage load time, client-side errors,\nand user behavior.\nAfter you create an app monitor, sign in to the CloudWatch RUM console to get\nthe JavaScript code snippet to add to your web application. For more information, see\n[How do I find a code snippet\nthat I've already generated?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the app monitor.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html", "Properties": { "CustomEvents": { "MarkdownDocumentation": "`CustomEvents`\n\nSpecifies whether this app monitor allows the web client to define and send custom events. If you omit\nthis parameter, custom events are `DISABLED`.\n*Required*: No\n*Type*: [CustomEvents](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-customevents", "UpdateType": "Mutable", "Required": false, "Type": "CustomEvents" }, "Platform": { "MarkdownDocumentation": "`Platform`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `Web | Android | iOS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "Web", "Android", "iOS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-platform", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CwLogEnabled": { "MarkdownDocumentation": "`CwLogEnabled`\n\nData collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether\nCloudWatch RUM\nsends a copy of this telemetry data to Amazon CloudWatch Logs\nin your account. This enables you to keep the telemetry data for more than 30 days, but it does incur\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-cwlogenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nUse this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can\nhave one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see [Using resource-based policies with CloudWatch RUM](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-policies.html).\n*Required*: No\n*Type*: [ResourcePolicy](./aws-properties-rum-appmonitor-resourcepolicy.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-resourcepolicy", "UpdateType": "Mutable", "Required": false, "Type": "ResourcePolicy" }, "DomainList": { "MarkdownDocumentation": "`DomainList`\n\nList the domain names for which your application has administrative authority. This parameter or the `Domain` parameter is required.\nYou can have a minimum of 1 and a maximum of 5 `Domain` under `DomainList`. Each `Domain` must be a minimum length of 1 and a maximum of 253 characters.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1 | 1`\n*Maximum*: `253 | 5`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-domainlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DeobfuscationConfiguration": { "MarkdownDocumentation": "`DeobfuscationConfiguration`\n\nA structure that contains the configuration for how an app monitor can deobfuscate stack traces.\n*Required*: No\n*Type*: [DeobfuscationConfiguration](./aws-properties-rum-appmonitor-deobfuscationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-deobfuscationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "DeobfuscationConfiguration" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nThe top-level internet domain name for which your application has administrative authority. This parameter or the `DomainList` parameter is required.\n*Required*: No\n*Type*: String\n*Pattern*: `^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\\.\\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\\*\\.)(?![-.])([A-Za-z0-9-\\.\\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-domain", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AppMonitorConfiguration": { "MarkdownDocumentation": "`AppMonitorConfiguration`\n\nA structure that contains much of the configuration data for the app monitor. If you are using\nAmazon Cognito for authorization, you must include this structure in your request, and it\nmust include the ID of the\nAmazon Cognito identity pool to use for authorization. If you don't\ninclude `AppMonitorConfiguration`, you must set up your own\nauthorization method. For more information, see\n[Authorize your application\nto 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-appmonitorconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AppMonitorConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAssigns one or more tags (key-value pairs) to the app monitor.\nTags can help you organize and categorize your resources. You can also use them to scope user\npermissions by granting a user\npermission 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 app monitor.\nFor more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rum-appmonitor-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the app monitor. This parameter is required.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the app monitor, such as\n`123456ab-1234-4ca9-9d2f-a1b2c3456789`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#Id-fn::getatt" } } }, "AWS::Rbin::Rule": { "MarkdownDocumentation": "`AWS::Rbin::Rule`\n\nCreates a Recycle Bin retention rule. You can create two types of retention rules:\n* **Tag-level retention rules** - These retention rules use\n resource tags to identify the resources to protect. For each retention rule, you specify one or\n more tag key and value pairs. Resources (of the specified type) that have at least one of these\n tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this\n type of retention rule to protect specific resources in your account based on their tags.\n* **Region-level retention rules** - These retention rules,\n by default, apply to all of the resources (of the specified type) in the Region, even if the\n resources are not tagged. However, you can specify exclusion tags to exclude resources that have\n specific tags. Use this type of retention rule to protect all resources of a specific type in a\n Region.\nFor more information, see [Create Recycle Bin retention rules](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin.html) in the *Amazon EBS User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the retention rule.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe state of the retention rule. Only retention rules that are in the `available`\nstate retain resources.\n*Required*: No\n*Type*: String\n*Pattern*: `pending|available`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe retention rule description.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ResourceTags": { "MarkdownDocumentation": "`ResourceTags`\n\n[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a\ntag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that\nhave one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have\nany of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.\nYou can add the same tag key and value pair to a maximum or five retention rules.\nTo create a Region-level retention rule, omit this parameter. A Region-level retention rule\ndoes not have any resource tags specified. It retains all deleted resources of the specified\nresource type in the Region in which the rule is created, even if the resources are not tagged.\n*Required*: No\n*Type*: Array of [ResourceTag](./aws-properties-rbin-rule-resourcetag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceTag", "DuplicatesAllowed": false }, "LockConfiguration": { "MarkdownDocumentation": "`LockConfiguration`\n\nInformation about the retention rule lock configuration.\n*Required*: No\n*Type*: [UnlockDelay](./aws-properties-rbin-rule-unlockdelay.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-lockconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "UnlockDelay" }, "ExcludeResourceTags": { "MarkdownDocumentation": "`ExcludeResourceTags`\n\n[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded,\nor ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule\nupon deletion.\nYou can't specify exclusion tags for tag-level retention rules.\n*Required*: No\n*Type*: Array of [ResourceTag](./aws-properties-rbin-rule-resourcetag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-excluderesourcetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceTag", "DuplicatesAllowed": false }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe resource type to be retained by the retention rule. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs\nare supported.\n* To retain EBS volumes, specify `EBS_VOLUME`.\n* To retain EBS snapshots, specify `EBS_SNAPSHOT`\n* To retain EBS-backed AMIs, specify `EC2_IMAGE`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `EBS_SNAPSHOT | EC2_IMAGE | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "EBS_SNAPSHOT", "EC2_IMAGE", "EBS_VOLUME" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RetentionPeriod": { "MarkdownDocumentation": "`RetentionPeriod`\n\nInformation about the retention period for which the retention rule is to\nretain resources.\n*Required*: Yes\n*Type*: [RetentionPeriod](./aws-properties-rbin-rule-retentionperiod.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-retentionperiod", "UpdateType": "Mutable", "Required": true, "Type": "RetentionPeriod" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nInformation about the tags to assign to the retention rule.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rbin-rule-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Identifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`Identifier`\n\nThe unique ID of the retention rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#Identifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the retention rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#Arn-fn::getatt" }, "LockState": { "PrimitiveType": "String", "MarkdownDocumentation": "`LockState`\n\n[Region-level retention rules only] The lock state for the retention rule.\n* `locked` - The retention rule is locked and can't be modified or deleted.\n* `pending_unlock` - The retention rule has been unlocked but it is still within\n the unlock delay period. The retention rule can be modified or deleted only after the unlock\n delay period has expired.\n* `unlocked` - The retention rule is unlocked and it can be modified or deleted by\n any user with the required permissions.\n* `null` - The retention rule has never been locked. Once a retention rule has\n been locked, it can transition between the `locked` and `unlocked` states\n only; it can never transition back to `null`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#LockState-fn::getatt" } } }, "AWS::Redshift::Cluster": { "MarkdownDocumentation": "`AWS::Redshift::Cluster`\n\nSpecifies a cluster. A *cluster* is a fully managed data warehouse\nthat consists of a set of compute nodes.\nTo create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet\ngroup name. The cluster subnet group identifies the subnets of your VPC that Amazon\nRedshift uses when creating the cluster. For more information about managing clusters,\ngo to [Amazon Redshift Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the *Amazon Redshift Cluster\nManagement Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myCluster\" }`\nFor the Amazon Redshift cluster `myCluster`, `Ref` returns the\nname of the cluster.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html", "Properties": { "RevisionTarget": { "MarkdownDocumentation": "`RevisionTarget`\n\nDescribes a `RevisionTarget` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-revisiontarget", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutomatedSnapshotRetentionPeriod": { "MarkdownDocumentation": "`AutomatedSnapshotRetentionPeriod`\n\nThe number of days that automated snapshots are retained. If the value is 0, automated\nsnapshots are disabled. Even if automated snapshots are disabled, you can still create\nmanual snapshots when you want with [CreateClusterSnapshot](https://docs.aws.amazon.com/redshift/latest/APIReference/API_CreateClusterSnapshot.html) in the *Amazon Redshift API\nReference*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-automatedsnapshotretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Encrypted": { "MarkdownDocumentation": "`Encrypted`\n\nIf `true`, the data in the cluster is encrypted at rest.\nIf you set the value on this parameter to `false`, the request will fail.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-encrypted", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe port number on which the cluster accepts incoming connections.\nThe cluster is accessible only via the JDBC and ODBC connection strings. Part of\nthe connection string requires the port on which the cluster will listen for incoming\nconnections.\nDefault: `5439`\nValid Values:\n* For clusters with ra3 nodes - Select a port within the ranges `5431-5455` or `8191-8215`. (If you have an existing cluster\n with ra3 nodes, it isn't required that you change the port to these ranges.)\n* For clusters with dc2 nodes - Select a port within the range `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "NumberOfNodes": { "MarkdownDocumentation": "`NumberOfNodes`\n\nThe number of compute nodes in the cluster. This parameter is required when the\n**ClusterType** parameter is specified as\n`multi-node`.\nFor information about determining how many nodes you need, go to [Working with\nClusters](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\na multi-node cluster, you must specify the number of nodes that you want in the\ncluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-numberofnodes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DestinationRegion": { "MarkdownDocumentation": "`DestinationRegion`\n\nThe destination region that snapshots are automatically copied to when cross-region\nsnapshot 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-destinationregion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllowVersionUpgrade": { "MarkdownDocumentation": "`AllowVersionUpgrade`\n\nIf `true`, major version upgrades can be applied during the maintenance\nwindow 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\nthe service automatically apply upgrades during the maintenance window to the Amazon Redshift\nengine 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-allowversionupgrade", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe connection endpoint.\n*Required*: No\n*Type*: [Endpoint](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-endpoint", "UpdateType": "Mutable", "Required": false, "Type": "Endpoint" }, "NamespaceResourcePolicy": { "MarkdownDocumentation": "`NamespaceResourcePolicy`\n\nThe policy that is attached to a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-namespaceresourcepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MaintenanceTrackName": { "MarkdownDocumentation": "`MaintenanceTrackName`\n\nAn optional parameter for the name of the maintenance track for the cluster. If you\ndon't provide a maintenance track name, the cluster is assigned to the\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-maintenancetrackname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OwnerAccount": { "MarkdownDocumentation": "`OwnerAccount`\n\nThe AWS account used to create or copy the snapshot. Required if you are\nrestoring 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-owneraccount", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MultiAZ": { "MarkdownDocumentation": "`MultiAZ`\n\nA boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-multiaz", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tag instances.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshift-cluster-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "SnapshotClusterIdentifier": { "MarkdownDocumentation": "`SnapshotClusterIdentifier`\n\nThe name of the cluster the source snapshot was created from. This parameter is\nrequired if your user or role has a policy containing a snapshot resource element that\nspecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotclusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IamRoles": { "MarkdownDocumentation": "`IamRoles`\n\nA list of AWS Identity and Access Management (IAM) roles that can be used by the\ncluster to access other AWS services. You must supply the IAM roles in their Amazon\nResource Name (ARN) format.\nThe maximum number of IAM roles that you can associate is subject to a quota.\nFor more information, go to [Quotas and limits](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html)\nin the *Amazon Redshift Cluster Management Guide*.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-iamroles", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe AWS Key Management Service (KMS) key ID of the encryption key that you want to\nuse to encrypt data in the cluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnapshotCopyManual": { "MarkdownDocumentation": "`SnapshotCopyManual`\n\nIndicates whether to apply the snapshot retention period to newly copied manual\nsnapshots 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopymanual", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ManageMasterPassword": { "MarkdownDocumentation": "`ManageMasterPassword`\n\nIf `true`, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.\nYou can't use `MasterUserPassword` if `ManageMasterPassword` is true.\nIf `ManageMasterPassword` is false or not set, Amazon Redshift uses\n`MasterUserPassword` for the admin user account's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-managemasterpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "AvailabilityZone": { "MarkdownDocumentation": "`AvailabilityZone`\n\nThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the\ncluster. For example, if you have several EC2 instances running in a specific\nAvailability Zone, then you might want the cluster to be provisioned in the same zone in\norder to decrease network latency.\nDefault: A random, system-chosen Availability Zone in the region that is specified\nby the endpoint.\nExample: `us-east-2d`\nConstraint: The specified Availability Zone must be in the same region as the\ncurrent 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzone", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterSecurityGroups": { "MarkdownDocumentation": "`ClusterSecurityGroups`\n\nA list of security groups to be associated with this cluster.\nDefault: The default cluster security group for Amazon Redshift.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersecuritygroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ClusterIdentifier": { "MarkdownDocumentation": "`ClusterIdentifier`\n\nA unique identifier for the cluster. You use this identifier to refer to the\ncluster for any subsequent cluster operations such as deleting or modifying. The\nidentifier also appears in the Amazon Redshift console.\nConstraints:\n* Must contain from 1 to 63 alphanumeric characters or hyphens.\n* Alphabetic characters must be lowercase.\n* First character must be a letter.\n* Cannot end with a hyphen or contain two consecutive hyphens.\n* Must be unique for all clusters within an AWS account.\nExample: `myexamplecluster`\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusteridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "MasterUserPassword": { "MarkdownDocumentation": "`MasterUserPassword`\n\nThe password associated with the admin user account for the cluster that is being\ncreated.\nYou can't use `MasterUserPassword` if `ManageMasterPassword` is `true`.\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 `'`\n (single quote), `\"` (double quote), `\\`, `/`, or `@`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masteruserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterSubnetGroupName": { "MarkdownDocumentation": "`ClusterSubnetGroupName`\n\nThe name of a cluster subnet group to be associated with this cluster.\nIf this parameter is not provided the resulting cluster will be deployed outside\nvirtual private cloud (VPC).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersubnetgroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "LoggingProperties": { "MarkdownDocumentation": "`LoggingProperties`\n\nSpecifies logging information, such as queries and connection attempts, for the\nspecified Amazon Redshift cluster.\n*Required*: No\n*Type*: [LoggingProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-loggingproperties", "UpdateType": "Mutable", "Required": false, "Type": "LoggingProperties" }, "DeferMaintenance": { "MarkdownDocumentation": "`DeferMaintenance`\n\nA Boolean indicating whether to enable the deferred maintenance window.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NodeType": { "MarkdownDocumentation": "`NodeType`\n\nThe node type to be provisioned for the cluster. For information about node types,\ngo to [Working with\nClusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) in the *Amazon Redshift Cluster Management Guide*.\nValid Values:\n`dc2.large` | `dc2.8xlarge` |\n`ra3.large` | `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "MasterUsername": { "MarkdownDocumentation": "`MasterUsername`\n\nThe user name associated with the admin user account for the cluster that is being\ncreated.\nConstraints:\n* Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be\n `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\n 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*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterusername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nIf `true`, the cluster can be accessed from a public network.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ManualSnapshotRetentionPeriod": { "MarkdownDocumentation": "`ManualSnapshotRetentionPeriod`\n\nThe default number of days to retain a manual snapshot. If the value is -1, the\nsnapshot is retained indefinitely. This setting doesn't change the retention period\nof 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-manualsnapshotretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "ResourceAction": { "MarkdownDocumentation": "`ResourceAction`\n\nThe Amazon Redshift operation to be performed. Supported operations are `pause-cluster`,\n`resume-cluster`, and `failover-primary-compute`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-resourceaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HsmClientCertificateIdentifier": { "MarkdownDocumentation": "`HsmClientCertificateIdentifier`\n\nSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to\nretrieve 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmclientcertificateidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ElasticIp": { "MarkdownDocumentation": "`ElasticIp`\n\nThe Elastic IP (EIP) address for the cluster.\nConstraints: The cluster must be provisioned in EC2-VPC and publicly-accessible\nthrough an Internet gateway. Don't specify the Elastic IP address for a publicly accessible\ncluster with availability zone relocation turned on. For more information about provisioning clusters in\nEC2-VPC, go to [Supported\nPlatforms 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-elasticip", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneRelocationStatus": { "MarkdownDocumentation": "`AvailabilityZoneRelocationStatus`\n\nDescribes the status of the Availability Zone relocation operation.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocationstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AquaConfigurationStatus": { "MarkdownDocumentation": "`AquaConfigurationStatus`\n\nThis 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*: `enabled | disabled | auto...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "enabled", "disabled", "auto" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-aquaconfigurationstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnapshotIdentifier": { "MarkdownDocumentation": "`SnapshotIdentifier`\n\nThe name of the snapshot from which to create the new cluster. This parameter isn't\ncase 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AvailabilityZoneRelocation": { "MarkdownDocumentation": "`AvailabilityZoneRelocation`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SnapshotCopyGrantName": { "MarkdownDocumentation": "`SnapshotCopyGrantName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopygrantname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EnhancedVpcRouting": { "MarkdownDocumentation": "`EnhancedVpcRouting`\n\nAn option that specifies whether to create the cluster with enhanced VPC routing\nenabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\nVPC. For more information, see [Enhanced VPC Routing](https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-enhancedvpcrouting", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ClusterParameterGroupName": { "MarkdownDocumentation": "`ClusterParameterGroupName`\n\nThe name of the parameter group to be associated with this cluster.\nDefault: The default Amazon Redshift cluster parameter group. For information about the\ndefault parameter group, go to [Working with Amazon\nRedshift Parameter Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)\nConstraints:\n* Must be 1 to 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterparametergroupname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeferMaintenanceEndTime": { "MarkdownDocumentation": "`DeferMaintenanceEndTime`\n\nA timestamp for the end of the time period when we defer maintenance.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceendtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RotateEncryptionKey": { "MarkdownDocumentation": "`RotateEncryptionKey`\n\nRotates the encryption keys for a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-rotateencryptionkey", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nA list of Virtual Private Cloud (VPC) security groups to be associated with the\ncluster.\nDefault: The default VPC security group is associated with the cluster.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ClusterVersion": { "MarkdownDocumentation": "`ClusterVersion`\n\nThe version of the Amazon Redshift engine software that you want to deploy on the\ncluster.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HsmConfigurationIdentifier": { "MarkdownDocumentation": "`HsmConfigurationIdentifier`\n\nSpecifies the name of the HSM configuration that contains the information the\nAmazon 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmconfigurationidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreferredMaintenanceWindow": { "MarkdownDocumentation": "`PreferredMaintenanceWindow`\n\nThe weekly time range (in UTC) during which automated cluster maintenance can\noccur.\nFormat: `ddd:hh24:mi-ddd:hh24:mi`\nDefault: A 30-minute window selected at random from an 8-hour block of time per\nregion, occurring on a random day of the week. For more information about the time\nblocks 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-preferredmaintenancewindow", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeferMaintenanceStartTime": { "MarkdownDocumentation": "`DeferMaintenanceStartTime`\n\nA timestamp indicating the start time for the deferred maintenance 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenancestarttime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ClusterType": { "MarkdownDocumentation": "`ClusterType`\n\nThe type of the cluster. When cluster type is specified as\n* `single-node`, the **NumberOfNodes**\n parameter is not required.\n* `multi-node`, the **NumberOfNodes**\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustertype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Classic": { "MarkdownDocumentation": "`Classic`\n\nA boolean value indicating whether the resize operation is using the classic resize\nprocess. If you don't provide this parameter or set the value to\n`false`, the resize type is elastic.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-classic", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "MasterPasswordSecretKmsKeyId": { "MarkdownDocumentation": "`MasterPasswordSecretKmsKeyId`\n\nThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.\nYou can only use this parameter if `ManageMasterPassword` is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterpasswordsecretkmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeferMaintenanceDuration": { "MarkdownDocumentation": "`DeferMaintenanceDuration`\n\nAn integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time.\nThe duration must be 45 days or less.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceduration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DBName": { "MarkdownDocumentation": "`DBName`\n\nThe 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\nwith a SQL client and use SQL commands to create a database. For more information, go to\n[Create\na 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\n can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-dbname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SnapshotCopyRetentionPeriod": { "MarkdownDocumentation": "`SnapshotCopyRetentionPeriod`\n\nThe number of days to retain automated snapshots in the destination AWS Region\nafter 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\ndestination AWS Region, Amazon Redshift deletes any existing automated snapshots that were\ncopied to the destination AWS Region and that fall outside of the new retention\nperiod.\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\nhave the new retention period.\nIf you specify the value of -1 newly copied manual snapshots are retained\nindefinitely.\nConstraints: The number of days must be either -1 or an integer between 1 and 3,653\nfor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopyretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "MasterPasswordSecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MasterPasswordSecretArn`\n\nThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#MasterPasswordSecretArn-fn::getatt" }, "Endpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.Address`\n\nThe connection endpoint for the Amazon Redshift cluster. For example:\n`examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#Endpoint.Address-fn::getatt" }, "Endpoint.Port": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint.Port`\n\nThe port number on which the Amazon Redshift cluster accepts connections. For\nexample: `5439`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#Endpoint.Port-fn::getatt" }, "ClusterNamespaceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterNamespaceArn`\n\nThe namespace Amazon Resource Name (ARN) of the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#ClusterNamespaceArn-fn::getatt" }, "DeferMaintenanceIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`DeferMaintenanceIdentifier`\n\nA unique identifier for the maintenance window.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#DeferMaintenanceIdentifier-fn::getatt" } } }, "AWS::Redshift::ClusterParameterGroup": { "MarkdownDocumentation": "`AWS::Redshift::ClusterParameterGroup`\n\nDescribes a parameter group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myClusterParameterGroup\" }`\nFor the Amazon Redshift cluster parameter group\n`myClusterParameterGroup`, `Ref` returns the name of the cluster\nparameter group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-description", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nAn array of parameters to be modified. A maximum of 20 parameters can be modified\nin a single request.\nFor each parameter to be modified, you must supply at least the parameter name and\nparameter value; other name-value pairs of the parameter are optional.\nFor the workload management (WLM) configuration, you must supply all the name-value\npairs in the wlm\\_json\\_configuration parameter.\n*Required*: No\n*Type*: Array of [Parameter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Parameter", "DuplicatesAllowed": true }, "ParameterGroupName": { "MarkdownDocumentation": "`ParameterGroupName`\n\nThe name of the cluster parameter group.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ParameterGroupFamily": { "MarkdownDocumentation": "`ParameterGroupFamily`\n\nThe name of the cluster parameter group family that this cluster parameter group is\ncompatible with. You can create a custom parameter group and then associate your cluster with it. For more information, see\n[Amazon Redshift parameter groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupfamily", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of tags for the cluster parameter group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshift-clusterparametergroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::Redshift::ClusterSecurityGroup": { "MarkdownDocumentation": "`AWS::Redshift::ClusterSecurityGroup`\n\nSpecifies a new Amazon Redshift security group. You use security groups to control\naccess to non-VPC clusters.\nFor information about managing security groups, go to [Amazon Redshift\nCluster Security Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) in the *Amazon Redshift Cluster\nManagement Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myClusterSecurityGroup\" }`\nFor the Amazon Redshift cluster security group `myClusterSecurityGroup`,\nRef returns the name of the cluster security group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the security 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html#cfn-redshift-clustersecuritygroup-description", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies an arbitrary set of tags (key\u2013value pairs) to associate with this security\ngroup. Use tags to manage your resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshift-clustersecuritygroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html#cfn-redshift-clustersecuritygroup-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::Redshift::ClusterSecurityGroupIngress": { "MarkdownDocumentation": "`AWS::Redshift::ClusterSecurityGroupIngress`\n\nAdds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether\nthe application accessing your cluster is running on the Internet or an Amazon EC2\ninstance, you can authorize inbound access to either a Classless Interdomain Routing\n(CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as\nmany as 20 ingress rules to an Amazon Redshift security group.\nIf you authorize access to an Amazon EC2 security group, specify\n*EC2SecurityGroupName* and\n*EC2SecurityGroupOwnerId*. The Amazon EC2 security group and\nAmazon Redshift cluster must be in the same AWS Region.\nIf you authorize access to a CIDR/IP address range, specify\n*CIDRIP*. For an overview of CIDR blocks, see the Wikipedia\narticle on [Classless Inter-Domain Routing](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\nYou must also associate the security group with a cluster so that clients running\non these IP addresses or the EC2 instance are authorized to connect to the cluster. For\ninformation about managing security groups, go to [Working with Security\nGroups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) in the *Amazon Redshift Cluster Management Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html", "Properties": { "CIDRIP": { "MarkdownDocumentation": "`CIDRIP`\n\nThe IP range to be added the Amazon Redshift security group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-cidrip", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "ClusterSecurityGroupName": { "MarkdownDocumentation": "`ClusterSecurityGroupName`\n\nThe name of the security group to which the ingress rule is added.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-clustersecuritygroupname", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "EC2SecurityGroupName": { "MarkdownDocumentation": "`EC2SecurityGroupName`\n\nThe EC2 security group to be added the Amazon Redshift security group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-ec2securitygroupname", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "EC2SecurityGroupOwnerId": { "MarkdownDocumentation": "`EC2SecurityGroupOwnerId`\n\nThe AWS account number of the owner of the security group specified by\nthe *EC2SecurityGroupName* parameter. The AWS Access\nKey ID is not an acceptable value.\nExample: `111122223333`\nConditional. If you specify the `EC2SecurityGroupName` property, you must\nspecify this property.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-ec2securitygroupownerid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" } } }, "AWS::Redshift::ClusterSubnetGroup": { "MarkdownDocumentation": "`AWS::Redshift::ClusterSubnetGroup`\n\nSpecifies an Amazon Redshift subnet group. You must provide a list of one or more\nsubnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating\nAmazon Redshift subnet group.\nFor information about subnet groups, go to [Amazon Redshift\nCluster Subnet Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html) in the *Amazon Redshift Cluster Management\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myClusterSubnetGroup\" }`\nFor the Amazon Redshift subnet group `myClusterSubnetGroup`, Ref returns\nthe name of the cluster subnet group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the subnet group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-description", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nAn array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single\nrequest.\n*Required*: Yes\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-subnetids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies an arbitrary set of tags (key\u2013value pairs) to associate with this subnet\ngroup. Use tags to manage your resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshift-clustersubnetgroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ClusterSubnetGroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterSubnetGroupName`\n\nThe name of the cluster subnet group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#ClusterSubnetGroupName-fn::getatt" } } }, "AWS::Redshift::EndpointAccess": { "MarkdownDocumentation": "`AWS::Redshift::EndpointAccess`\n\nCreates a Redshift-managed VPC endpoint.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html", "Properties": { "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nThe name of the endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#cfn-redshift-endpointaccess-endpointname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nThe security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#cfn-redshift-endpointaccess-vpcsecuritygroupids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ResourceOwner": { "MarkdownDocumentation": "`ResourceOwner`\n\nThe AWS account ID of the owner of the cluster.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#cfn-redshift-endpointaccess-resourceowner", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SubnetGroupName": { "MarkdownDocumentation": "`SubnetGroupName`\n\nThe subnet group name where Amazon Redshift chooses to deploy the endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=^[a-zA-Z0-9-]+$).{1,255}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#cfn-redshift-endpointaccess-subnetgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ClusterIdentifier": { "MarkdownDocumentation": "`ClusterIdentifier`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#cfn-redshift-endpointaccess-clusteridentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "EndpointStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointStatus`\n\nThe status of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#EndpointStatus-fn::getatt" }, "VpcEndpoint": { "Type": "VpcEndpoint", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#VpcEndpoint-fn::getatt" }, "Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`Address`\n\nThe DNS address of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#Address-fn::getatt" }, "Port": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Port`\n\nThe port number on which the cluster accepts incoming connections.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#Port-fn::getatt" }, "EndpointCreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointCreateTime`\n\nThe time (UTC) that the endpoint was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#EndpointCreateTime-fn::getatt" }, "VpcEndpoint.VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEndpoint.VpcId`\n\nThe VPC identifier that the endpoint is associated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#VpcEndpoint.VpcId-fn::getatt" }, "VpcEndpoint.NetworkInterfaces": { "Type": "List", "ItemType": "NetworkInterface", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#VpcEndpoint.NetworkInterfaces-fn::getatt" }, "VpcSecurityGroups": { "Type": "List", "ItemType": "VpcSecurityGroup", "MarkdownDocumentation": "`VpcSecurityGroups`\n\nThe security groups associated with the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#VpcSecurityGroups-fn::getatt" }, "VpcEndpoint.VpcEndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcEndpoint.VpcEndpointId`\n\nThe connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html#VpcEndpoint.VpcEndpointId-fn::getatt" } } }, "AWS::Redshift::EndpointAuthorization": { "MarkdownDocumentation": "`AWS::Redshift::EndpointAuthorization`\n\nDescribes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html", "Properties": { "Account": { "MarkdownDocumentation": "`Account`\n\nThe AWS account ID of either the cluster owner (grantor) or grantee.\nIf `Grantee` parameter is true, then the `Account` value is of the grantor.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#cfn-redshift-endpointauthorization-account", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Force": { "MarkdownDocumentation": "`Force`\n\nIndicates whether to force the revoke action.\nIf 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#cfn-redshift-endpointauthorization-force", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "VpcIds": { "MarkdownDocumentation": "`VpcIds`\n\nThe virtual private cloud (VPC) identifiers to grant access to.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#cfn-redshift-endpointauthorization-vpcids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ClusterIdentifier": { "MarkdownDocumentation": "`ClusterIdentifier`\n\nThe cluster identifier.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#cfn-redshift-endpointauthorization-clusteridentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the authorization action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#Status-fn::getatt" }, "Grantee": { "PrimitiveType": "String", "MarkdownDocumentation": "`Grantee`\n\nThe AWS account ID of the grantee of the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#Grantee-fn::getatt" }, "Grantor": { "PrimitiveType": "String", "MarkdownDocumentation": "`Grantor`\n\nThe AWS account ID of the cluster owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#Grantor-fn::getatt" }, "EndpointCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`EndpointCount`\n\nThe number of Redshift-managed VPC endpoints created for the authorization.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#EndpointCount-fn::getatt" }, "AuthorizeTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`AuthorizeTime`\n\nThe time (UTC) when the authorization was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#AuthorizeTime-fn::getatt" }, "AllowedVPCs": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`AllowedVPCs`\n\nThe VPCs allowed access to the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#AllowedVPCs-fn::getatt" }, "AllowedAllVPCs": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`AllowedAllVPCs`\n\nIndicates whether all VPCs in the grantee account are allowed access to the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#AllowedAllVPCs-fn::getatt" }, "ClusterStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterStatus`\n\nThe status of the cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointauthorization.html#ClusterStatus-fn::getatt" } } }, "AWS::Redshift::EventSubscription": { "MarkdownDocumentation": "`AWS::Redshift::EventSubscription`\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"mySubscriptionName\" }`\nFor the Amazon Redshift`EventSubscription`, Ref returns the name of the subscription.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html", "Properties": { "SourceType": { "MarkdownDocumentation": "`SourceType`\n\nThe type of source that will be generating the events. For example, if you want to\nbe notified of events generated by a cluster, you would set this parameter to cluster.\nIf this value is not specified, events are returned for all Amazon Redshift objects in your\nAWS account. You must specify a source type in order to specify source IDs.\nValid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.\n*Required*: No\n*Type*: String\n*Allowed values*: `cluster | cluster-parameter...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "cluster", "cluster-parameter-group", "cluster-security-group", "cluster-snapshot", "scheduled-action" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-sourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EventCategories": { "MarkdownDocumentation": "`EventCategories`\n\nSpecifies the Amazon Redshift event categories to be published by the event notification\nsubscription.\nValues: configuration, management, monitoring, security, pending\n*Required*: No\n*Type*: Array of String\n*Allowed values*: `configuration | management ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "configuration", "management", "monitoring", "security", "pending" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-eventcategories", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nA boolean value; set to `true` to activate the subscription, and set to\n`false` to create the subscription but not activate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Severity": { "MarkdownDocumentation": "`Severity`\n\nSpecifies the Amazon Redshift event severity to be published by the event notification\nsubscription.\nValues: ERROR, INFO\n*Required*: No\n*Type*: String\n*Allowed values*: `ERROR | INFO...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ERROR", "INFO" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-severity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SubscriptionName": { "MarkdownDocumentation": "`SubscriptionName`\n\nThe name of the event subscription to be created.\nConstraints:\n* Cannot be null, empty, or blank.\n* Must contain from 1 to 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*: Yes\n*Type*: String\n*Pattern*: `^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-subscriptionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SourceIds": { "MarkdownDocumentation": "`SourceIds`\n\nA list of one or more identifiers of Amazon Redshift source objects. All of the objects\nmust be of the same type as was specified in the source type parameter. The event\nsubscription will return only events generated by the specified objects. If not\nspecified, then events are returned for all objects within the source type\nspecified.\nExample: my-cluster-1, my-cluster-2\nExample: my-snapshot-20131010\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-sourceids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SnsTopicArn": { "MarkdownDocumentation": "`SnsTopicArn`\n\nThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event\nnotifications. The ARN is created by Amazon SNS when you create a topic and subscribe to\nit.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-snstopicarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tag instances.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshift-eventsubscription-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the Amazon Redshift event notification subscription.\nConstraints:\n* Can be one of the following: active | no-permission |\n topic-not-exist\n* The status \"no-permission\" indicates that Amazon Redshift no longer has\n permission to post to the Amazon SNS topic. The status \"topic-not-exist\"\n indicates that the topic was deleted after the subscription was\n created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#Status-fn::getatt" }, "CustSubscriptionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CustSubscriptionId`\n\nThe name of the Amazon Redshift event notification subscription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#CustSubscriptionId-fn::getatt" }, "EventCategoriesList": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`EventCategoriesList`\n\nThe list of Amazon Redshift event categories specified in the event notification\nsubscription.\nValues: Configuration, Management, Monitoring, Security, Pending\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#EventCategoriesList-fn::getatt" }, "SourceIdsList": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`SourceIdsList`\n\nA list of the sources that publish events to the Amazon Redshift event notification\nsubscription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#SourceIdsList-fn::getatt" }, "SubscriptionCreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`SubscriptionCreationTime`\n\nThe date and time the Amazon Redshift event notification subscription was\ncreated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#SubscriptionCreationTime-fn::getatt" }, "CustomerAwsId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CustomerAwsId`\n\nThe AWS account associated with the Amazon Redshift event notification\nsubscription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#CustomerAwsId-fn::getatt" } } }, "AWS::Redshift::Integration": { "MarkdownDocumentation": "`AWS::Redshift::Integration`\n\nDescribes a zero-ETL or S3 integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html", "Properties": { "IntegrationName": { "MarkdownDocumentation": "`IntegrationName`\n\nThe name of the integration.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html#cfn-redshift-integration-integrationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KMSKeyId": { "MarkdownDocumentation": "`KMSKeyId`\n\nThe AWS Key Management Service (AWS KMS) key identifier for the key used to encrypt the integration.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html#cfn-redshift-integration-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SourceArn": { "MarkdownDocumentation": "`SourceArn`\n\nThe Amazon Resource Name (ARN) of the database used as the source for replication.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html#cfn-redshift-integration-sourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetArn": { "MarkdownDocumentation": "`TargetArn`\n\nThe Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html#cfn-redshift-integration-targetarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AdditionalEncryptionContext": { "MarkdownDocumentation": "`AdditionalEncryptionContext`\n\nThe encryption context for the integration. For more information, see\n[Encryption context](https://docs.aws.amazon.com/) in the *AWS Key Management Service Developer Guide*.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[\\s\\S]*$`\n*Minimum*: `0`\n*Maximum*: `131072`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html#cfn-redshift-integration-additionalencryptioncontext", "UpdateType": "Immutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of tags associated with the integration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshift-integration-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html#cfn-redshift-integration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "IntegrationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IntegrationArn`\n\nThe Amazon Resource Name (ARN) of the integration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html#IntegrationArn-fn::getatt" }, "CreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreateTime`\n\nThe time (UTC) when the integration was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-integration.html#CreateTime-fn::getatt" } } }, "AWS::Redshift::ScheduledAction": { "MarkdownDocumentation": "`AWS::Redshift::ScheduledAction`\n\nCreates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action.\nFor example, you can create a schedule of when to run the `ResizeCluster` API operation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n`{ \"Ref\": \"myScheduledActionName\" }`\nFor the Amazon Redshift`ScheduledActionName`, Ref returns the name of the scheduled action.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html", "Properties": { "ScheduledActionDescription": { "MarkdownDocumentation": "`ScheduledActionDescription`\n\nThe description of the scheduled action.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-scheduledactiondescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ScheduledActionName": { "MarkdownDocumentation": "`ScheduledActionName`\n\nThe name of the scheduled action.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-scheduledactionname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EndTime": { "MarkdownDocumentation": "`EndTime`\n\nThe end time in UTC when the schedule is no longer active. After this time, the scheduled action does not 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-endtime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe schedule for a one-time (at format) or recurring (cron format) scheduled action.\nSchedule invocations must be separated by at least one hour.\nFormat of at expressions is \"`at(yyyy-mm-ddThh:mm:ss)`\". For example, \"`at(2016-03-04T17:27:00)`\".\nFormat of cron expressions is \"`cron(Minutes Hours Day-of-month Month Day-of-week Year)`\".\nFor example, \"`cron(0 10 ? * MON *)`\". For more information, see\n[Cron Expressions](https://docs.aws.amazon.com//AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions)\nin the *Amazon CloudWatch Events User 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-schedule", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IamRole": { "MarkdownDocumentation": "`IamRole`\n\nThe IAM role to assume to run the scheduled action.\nThis IAM role must have permission to run the Amazon Redshift API operation in the scheduled action.\nThis IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.\nFor more information about the IAM role to use with the Amazon Redshift scheduler, see\n[Using Identity-Based Policies for Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-iamrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe start time in UTC when the schedule is active. Before this time, the scheduled action does not 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-starttime", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enable": { "MarkdownDocumentation": "`Enable`\n\nIf true, the schedule is enabled. If false, the scheduled action does not trigger.\nFor more information about `state` of the scheduled action, see [AWS::Redshift::ScheduledAction](./aws-resource-redshift-scheduledaction.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-enable", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "TargetAction": { "MarkdownDocumentation": "`TargetAction`\n\nA JSON format string of the Amazon Redshift API operation with input parameters.\n\"`{\\\"ResizeCluster\\\":{\\\"NodeType\\\":\\\"ra3.4xlarge\\\",\\\"ClusterIdentifier\\\":\\\"my-test-cluster\\\",\\\"NumberOfNodes\\\":3}}`\".\n*Required*: No\n*Type*: [ScheduledActionType](./aws-properties-redshift-scheduledaction-scheduledactiontype.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-targetaction", "UpdateType": "Mutable", "Required": false, "Type": "ScheduledActionType" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the scheduled action. For example, `DISABLED`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#State-fn::getatt" }, "NextInvocations": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`NextInvocations`\n\nList of times when the scheduled action will run.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#NextInvocations-fn::getatt" } } }, "AWS::RedshiftServerless::Namespace": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Namespace`\n\nA collection of database objects and users.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the NamespaceName, such as `sample-namespace.` For more\ninformation about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html", "Properties": { "ManageAdminPassword": { "MarkdownDocumentation": "`ManageAdminPassword`\n\nIf true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use `AdminUserPassword` if `ManageAdminPassword` is true. If `ManageAdminPassword` is `false` or not set, Amazon Redshift uses `AdminUserPassword` for the admin user account's 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-manageadminpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IamRoles": { "MarkdownDocumentation": "`IamRoles`\n\nA list of IAM roles to associate with the namespace.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-iamroles", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SnapshotCopyConfigurations": { "MarkdownDocumentation": "`SnapshotCopyConfigurations`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [SnapshotCopyConfiguration](./aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-snapshotcopyconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "SnapshotCopyConfiguration", "DuplicatesAllowed": true }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FinalSnapshotName": { "MarkdownDocumentation": "`FinalSnapshotName`\n\nThe name of the snapshot to be created before the namespace is deleted.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-z][a-z0-9]*(-[a-z0-9]+)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-finalsnapshotname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FinalSnapshotRetentionPeriod": { "MarkdownDocumentation": "`FinalSnapshotRetentionPeriod`\n\nHow long to retain the final snapshot.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-finalsnapshotretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "AdminUserPassword": { "MarkdownDocumentation": "`AdminUserPassword`\n\nThe password of the administrator for the primary database created in the namespace.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[^\\x00-\\x20\\x22\\x27\\x2f\\x40\\x5c\\x7f-\\uffff]+`\n*Minimum*: `8`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-adminuserpassword", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdminPasswordSecretKmsKeyId": { "MarkdownDocumentation": "`AdminPasswordSecretKmsKeyId`\n\nThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if `ManageAdminPassword` is `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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-adminpasswordsecretkmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultIamRoleArn": { "MarkdownDocumentation": "`DefaultIamRoleArn`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-defaultiamrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AdminUsername": { "MarkdownDocumentation": "`AdminUsername`\n\nThe username of the administrator for the primary database created in the namespace.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-adminusername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NamespaceName": { "MarkdownDocumentation": "`NamespaceName`\n\nThe name of the namespace.\nMust be between 3-64 alphanumeric characters in lowercase,\nand it cannot be a reserved word. A list of reserved words can be found\nin [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*Pattern*: `^[a-z0-9-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-namespacename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NamespaceResourcePolicy": { "MarkdownDocumentation": "`NamespaceResourcePolicy`\n\nThe resource policy that will be attached to the namespace.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-namespaceresourcepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "RedshiftIdcApplicationArn": { "MarkdownDocumentation": "`RedshiftIdcApplicationArn`\n\nThe ARN for the Redshift application that integrates with IAM Identity Center.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-redshiftidcapplicationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DbName": { "MarkdownDocumentation": "`DbName`\n\nThe name of the primary database created in the namespace.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z][a-zA-Z_0-9+.@-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-dbname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe map of the key-value pairs used to tag the namespace.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshiftserverless-namespace-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "LogExports": { "MarkdownDocumentation": "`LogExports`\n\nThe types of logs the namespace can export.\nAvailable export types are `userlog`, `connectionlog`, and `useractivitylog`.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-logexports", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "Namespace.LogExports": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Namespace.LogExports`\n\nThe types of logs the namespace can export. Available export types are\n`User log`, `Connection log`, and `User activity log`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.LogExports-fn::getatt" }, "Namespace.CreationDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.CreationDate`\n\nThe date of when the namespace was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.CreationDate-fn::getatt" }, "Namespace.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.Status`\n\nThe status of the namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.Status-fn::getatt" }, "Namespace": { "Type": "Namespace", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace-fn::getatt" }, "Namespace.NamespaceName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.NamespaceName`\n\nThe name of the namespace.\nMust be between 3-64 alphanumeric characters in lowercase,\nand it cannot be a reserved word. A list of reserved words can be found\nin [Reserved Words](https://docs.aws.amazon.com//redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.NamespaceName-fn::getatt" }, "Namespace.AdminPasswordSecretKmsKeyId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.AdminPasswordSecretKmsKeyId-fn::getatt" }, "Namespace.AdminUsername": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.AdminUsername`\n\nThe username of the administrator for the first database created in the namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.AdminUsername-fn::getatt" }, "Namespace.KmsKeyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.KmsKeyId`\n\nThe ID of the AWS Key Management Service key used to encrypt your data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.KmsKeyId-fn::getatt" }, "Namespace.DbName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.DbName`\n\nThe name of the first database created in the namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.DbName-fn::getatt" }, "Namespace.IamRoles": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Namespace.IamRoles`\n\nA list of IAM roles to associate with the namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.IamRoles-fn::getatt" }, "Namespace.NamespaceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.NamespaceArn`\n\nThe Amazon Resource Name (ARN) associated with a namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.NamespaceArn-fn::getatt" }, "Namespace.NamespaceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.NamespaceId`\n\nThe unique identifier of a namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.NamespaceId-fn::getatt" }, "Namespace.DefaultIamRoleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace.DefaultIamRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.DefaultIamRoleArn-fn::getatt" }, "Namespace.AdminPasswordSecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#Namespace.AdminPasswordSecretArn-fn::getatt" } } }, "AWS::RedshiftServerless::Snapshot": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Snapshot`\n\nA snapshot object that contains databases.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html", "Properties": { "NamespaceName": { "MarkdownDocumentation": "`NamespaceName`\n\nThe name of the namepsace.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?=^[a-z0-9-]+$).{3,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#cfn-redshiftserverless-snapshot-namespacename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RetentionPeriod": { "MarkdownDocumentation": "`RetentionPeriod`\n\nThe retention period of the snapshot created by the scheduled action.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#cfn-redshiftserverless-snapshot-retentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SnapshotName": { "MarkdownDocumentation": "`SnapshotName`\n\nThe name of the snapshot.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=^[a-z0-9-]+$).{3,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#cfn-redshiftserverless-snapshot-snapshotname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of [Tag objects](https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) to associate with the snapshot.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshiftserverless-snapshot-tag.html)\n*Minimum*: `0`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#cfn-redshiftserverless-snapshot-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Snapshot": { "Type": "Snapshot", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot-fn::getatt" }, "Snapshot.SnapshotCreateTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.SnapshotCreateTime`\n\nThe timestamp of when the snapshot was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.SnapshotCreateTime-fn::getatt" }, "Snapshot.RetentionPeriod": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Snapshot.RetentionPeriod`\n\nThe retention period of the snapshot created by the scheduled action.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.RetentionPeriod-fn::getatt" }, "Snapshot.NamespaceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.NamespaceArn`\n\nThe Amazon Resource Name (ARN) of the namespace the snapshot was created from.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.NamespaceArn-fn::getatt" }, "Snapshot.NamespaceName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.NamespaceName`\n\nThe name of the namepsace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.NamespaceName-fn::getatt" }, "Snapshot.OwnerAccount": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.OwnerAccount`\n\nThe owner AWS; account of the snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.OwnerAccount-fn::getatt" }, "Snapshot.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.Status`\n\nThe status of the snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.Status-fn::getatt" }, "OwnerAccount": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccount`\n\nThe owner AWS; account of the snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#OwnerAccount-fn::getatt" }, "Snapshot.AdminUsername": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.AdminUsername`\n\nThe username of the database within a snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.AdminUsername-fn::getatt" }, "Snapshot.SnapshotArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.SnapshotArn`\n\nThe Amazon Resource Name (ARN) of the snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.SnapshotArn-fn::getatt" }, "Snapshot.SnapshotName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.SnapshotName`\n\nThe name of the snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.SnapshotName-fn::getatt" }, "Snapshot.KmsKeyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`Snapshot.KmsKeyId`\n\nThe unique identifier of the KMS key used to encrypt the snapshot.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html#Snapshot.KmsKeyId-fn::getatt" } } }, "AWS::RedshiftServerless::Workgroup": { "MarkdownDocumentation": "`AWS::RedshiftServerless::Workgroup`\n\nThe collection of compute resources in Amazon Redshift Serverless.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the WorkgroupName, such as `sample-workgroup.` For more\ninformation about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html", "Properties": { "SnapshotArn": { "MarkdownDocumentation": "`SnapshotArn`\n\nThe Amazon Resource Name (ARN) of the snapshot to restore 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-snapshotarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SnapshotOwnerAccount": { "MarkdownDocumentation": "`SnapshotOwnerAccount`\n\nThe Amazon Web Services account that owns the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-snapshotowneraccount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215.\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RecoveryPointId": { "MarkdownDocumentation": "`RecoveryPointId`\n\nThe recovery point id to restore 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-recoverypointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WorkgroupName": { "MarkdownDocumentation": "`WorkgroupName`\n\nThe name of the workgroup.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?=^[a-z0-9-]+$).{3,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-workgroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BaseCapacity": { "MarkdownDocumentation": "`BaseCapacity`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-basecapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "EnhancedVpcRouting": { "MarkdownDocumentation": "`EnhancedVpcRouting`\n\nThe value that specifies whether to enable enhanced virtual\nprivate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-enhancedvpcrouting", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Workgroup": { "MarkdownDocumentation": "`Workgroup`\n\nThe collection of computing resources from which an endpoint is created.\n*Required*: No\n*Type*: [Workgroup](./aws-properties-redshiftserverless-workgroup-workgroup.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-workgroup", "UpdateType": "Mutable", "Required": false, "Type": "Workgroup" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nA list of security group IDs to associate with the workgroup.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 1`\n*Maximum*: `255 | 32`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nA list of subnet IDs the workgroup is associated with.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0 | 1`\n*Maximum*: `255 | 32`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "SnapshotName": { "MarkdownDocumentation": "`SnapshotName`\n\nThe snapshot name to restore 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-snapshotname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NamespaceName": { "MarkdownDocumentation": "`NamespaceName`\n\nThe namespace the workgroup is associated with.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?=^[a-z0-9-]+$).{3,64}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-namespacename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConfigParameters": { "MarkdownDocumentation": "`ConfigParameters`\n\nThe key of the parameter. The options are `auto_mv`, `datestyle`, `enable_case_sensitive_identifier`,\n`enable_user_activity_logging`, `query_group`, `search_path`, `require_ssl`, `use_fips_ssl`,\nand query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see\n[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*: Array of [ConfigParameter](./aws-properties-redshiftserverless-workgroup-configparameter.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConfigParameter", "DuplicatesAllowed": false }, "TrackName": { "MarkdownDocumentation": "`TrackName`\n\nAn optional parameter for the name of the track for the workgroup. If you don't provide\na track name, the workgroup is assigned to the current track.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-trackname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nA value that specifies whether the workgroup\ncan 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-publiclyaccessible", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PricePerformanceTarget": { "MarkdownDocumentation": "`PricePerformanceTarget`\n\nAn object that represents the price performance target settings for the workgroup.\n*Required*: No\n*Type*: [PerformanceTarget](./aws-properties-redshiftserverless-workgroup-performancetarget.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-priceperformancetarget", "UpdateType": "Mutable", "Required": false, "Type": "PerformanceTarget" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe map of the key-value pairs used to tag the workgroup.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-redshiftserverless-workgroup-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "MaxCapacity": { "MarkdownDocumentation": "`MaxCapacity`\n\nThe maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-maxcapacity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" } }, "Attributes": { "Workgroup.Endpoint.Port": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Workgroup.Endpoint.Port`\n\nThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215.\nThe default is 5439.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.Endpoint.Port-fn::getatt" }, "Workgroup.SecurityGroupIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Workgroup.SecurityGroupIds`\n\nAn array of security group IDs to associate with the workgroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.SecurityGroupIds-fn::getatt" }, "Workgroup.CreationDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`Workgroup.CreationDate`\n\nThe creation date of the workgroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.CreationDate-fn::getatt" }, "Workgroup.PubliclyAccessible": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`Workgroup.PubliclyAccessible`\n\nA value that specifies whether the workgroup can be accessible from a public network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.PubliclyAccessible-fn::getatt" }, "Workgroup.WorkgroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Workgroup.WorkgroupArn`\n\nThe Amazon Resource Name (ARN) that links to the workgroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.WorkgroupArn-fn::getatt" }, "Workgroup.WorkgroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Workgroup.WorkgroupName`\n\nThe name of the workgroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.WorkgroupName-fn::getatt" }, "Workgroup.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Workgroup.Status`\n\nThe status of the workgroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.Status-fn::getatt" }, "Workgroup.MaxCapacity": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Workgroup.MaxCapacity`\n\nThe maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.MaxCapacity-fn::getatt" }, "Workgroup.BaseCapacity": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Workgroup.BaseCapacity`\n\nThe base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.BaseCapacity-fn::getatt" }, "Workgroup.EnhancedVpcRouting": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`Workgroup.EnhancedVpcRouting`\n\nThe value that specifies whether to enable enhanced virtual\nprivate cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.EnhancedVpcRouting-fn::getatt" }, "Workgroup.TrackName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Workgroup.TrackName`\n\nAn optional parameter for the name of the track for the workgroup. If you don't provide\na track name, the workgroup is assigned to the current track.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.TrackName-fn::getatt" }, "Workgroup.WorkgroupId": { "PrimitiveType": "String", "MarkdownDocumentation": "`Workgroup.WorkgroupId`\n\nThe unique identifier of the workgroup.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.WorkgroupId-fn::getatt" }, "Workgroup.NamespaceName": { "PrimitiveType": "String", "MarkdownDocumentation": "`Workgroup.NamespaceName`\n\nThe namespace the workgroup is associated with.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.NamespaceName-fn::getatt" }, "Workgroup.Endpoint.Address": { "PrimitiveType": "String", "MarkdownDocumentation": "`Workgroup.Endpoint.Address`\n\nThe DNS address of the VPC endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.Endpoint.Address-fn::getatt" }, "Workgroup.SubnetIds": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`Workgroup.SubnetIds`\n\nAn array of subnet IDs the workgroup is associated with.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#Workgroup.SubnetIds-fn::getatt" } } }, "AWS::RefactorSpaces::Application": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Application`\n\n###### Note\nAWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).\nCreates an AWS Migration Hub Refactor Spaces application. The account that owns the environment also owns the\napplications created inside the environment, regardless of the account that creates the\napplication. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and\nNetwork Load Balancer for the application proxy inside your account.\nIn environments created with a [CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) of `NONE` you need to configure\n [VPC to VPC connectivity](https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html) between your service VPC and the application proxy VPC to\nroute traffic through the application proxy to a service with a private URL endpoint. For more\ninformation, see [Create an application](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-application.html) in the *Refactor Spaces User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a composite ID following this format:\n`|`, for example,\n`env-1234654123|app-1234654123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html", "Properties": { "EnvironmentIdentifier": { "MarkdownDocumentation": "`EnvironmentIdentifier`\n\nThe unique identifier of the environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^env-([0-9A-Za-z]{10}$)`\n*Minimum*: `14`\n*Maximum*: `14`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#cfn-refactorspaces-application-environmentidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the virtual private cloud (VPC).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$`\n*Minimum*: `12`\n*Maximum*: `21`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#cfn-refactorspaces-application-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApiGatewayProxy": { "MarkdownDocumentation": "`ApiGatewayProxy`\n\nThe endpoint URL of the Amazon API Gateway proxy.\n*Required*: No\n*Type*: [ApiGatewayProxyInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#cfn-refactorspaces-application-apigatewayproxy", "UpdateType": "Immutable", "Required": false, "Type": "ApiGatewayProxyInput" }, "ProxyType": { "MarkdownDocumentation": "`ProxyType`\n\nThe proxy type of the proxy created within the application.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `API_GATEWAY...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "API_GATEWAY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#cfn-refactorspaces-application-proxytype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the application.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-refactorspaces-application-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#cfn-refactorspaces-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#cfn-refactorspaces-application-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "NlbArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`NlbArn`\n\nThe Amazon Resource Name (ARN) of the Network Load Balancer.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#NlbArn-fn::getatt" }, "ProxyUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProxyUrl`\n\nThe endpoint URL of the Amazon API Gateway proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#ProxyUrl-fn::getatt" }, "NlbName": { "PrimitiveType": "String", "MarkdownDocumentation": "`NlbName`\n\nThe name of the Network Load Balancer configured by the API Gateway proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#NlbName-fn::getatt" }, "StageName": { "PrimitiveType": "String", "MarkdownDocumentation": "`StageName`\n\nThe name of the API Gateway stage. The name defaults to `prod`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#StageName-fn::getatt" }, "ApiGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApiGatewayId`\n\nThe resource ID of the API Gateway for the proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#ApiGatewayId-fn::getatt" }, "VpcLinkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcLinkId`\n\nThe `VpcLink` ID of the API Gateway proxy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#VpcLinkId-fn::getatt" }, "ApplicationIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApplicationIdentifier`\n\nThe unique identifier of the application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#ApplicationIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html#Arn-fn::getatt" } } }, "AWS::RefactorSpaces::Environment": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Environment`\n\n###### Note\nAWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).\nCreates an AWS Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all\nRefactor Spaces applications, services, and routes created within the environment. They are referred\nto as the *environment owner*. The environment owner has cross-account\nvisibility and control of Refactor Spaces resources that are added to the environment by other\naccounts that the environment is shared with.\nWhen creating an environment with a [CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) of `TRANSIT_GATEWAY`, Refactor Spaces\nprovisions a transit gateway to enable services in VPCs to communicate directly across\naccounts. If [CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) is `NONE`, Refactor Spaces does not create\na transit gateway and you must use your network infrastructure to route traffic to services\nwith private URL endpoints.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the environment, for example,\n`env-1234654123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-environment.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the environment.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_\\s\\.\\!\\*\\#\\@\\']+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-environment.html#cfn-refactorspaces-environment-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "NetworkFabricType": { "MarkdownDocumentation": "`NetworkFabricType`\n\nThe network fabric type of the environment.\n*Required*: No\n*Type*: String\n*Allowed values*: `TRANSIT_GATEWAY | NONE...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "TRANSIT_GATEWAY", "NONE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-environment.html#cfn-refactorspaces-environment-networkfabrictype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the environment.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-refactorspaces-environment-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-environment.html#cfn-refactorspaces-environment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the environment.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-environment.html#cfn-refactorspaces-environment-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "TransitGatewayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TransitGatewayId`\n\nThe ID of the AWS Transit Gateway set up by the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-environment.html#TransitGatewayId-fn::getatt" }, "EnvironmentIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`EnvironmentIdentifier`\n\nThe unique identifier of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-environment.html#EnvironmentIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-environment.html#Arn-fn::getatt" } } }, "AWS::RefactorSpaces::Route": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Route`\n\nCreates an AWS Migration Hub Refactor Spaces route. The account owner of\nthe service resource is always the environment owner, regardless of which account creates the\nroute. Routes target a service in the application. If an application does not have any routes,\nthen the first route must be created as a `DEFAULT``RouteType`.\nWhen created, the default route defaults to an active state so state is not a required\ninput. However, like all other state values the state of the default route can be updated\nafter creation, but only when all other routes are also inactive. Conversely, no route can be\nactive without the default route also being active.\n###### Note\nIn the `AWS::RefactorSpaces::Route` resource, you can only update the\n`ActivationState` property, which resides under the `UriPathRoute`\nand `DefaultRoute` properties. All other properties associated with the\n`AWS::RefactorSpaces::Route` cannot be updated, even though the property\ndescription might indicate otherwise. Updating all other properties will result in the\nreplacement of Route.\nWhen you create a route, Refactor Spaces configures the Amazon API Gateway to send\ntraffic to the target service as follows:\n* **URL Endpoints**\n \n If the service has a URL endpoint, and the endpoint resolves to a private IP address,\n Refactor Spaces routes traffic using the API Gateway VPC link. If a service\n endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public\n internet. Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed\n certificates are supported. Private Certificate Authorities (CAs) are permitted only if\n the CA's domain is also publicly resolvable.\n \n Refactor Spaces automatically resolves the public Domain Name System (DNS) names that\n are set in `CreateService:UrlEndpoint` when you create a service. The DNS names\n resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60\n seconds. This periodic DNS resolution ensures that the route configuration remains\n up-to-date.\n \n **One-time health check**\n \n A one-time health check is performed on the service when either the route is updated\n from inactive to active, or when it is created with an active state. If the health check\n fails, the route transitions the route state to `FAILED`, an error code of\n `SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE` is provided, and no traffic is sent\n to the service.\n \n For private URLs, a target group is created on the Network Load Balancer and the load\n balancer target group runs default target health checks. By default, the health check is\n run against the service endpoint URL. Optionally, the health check can be performed\n against a different protocol, port, and/or path using the [CreateService:UrlEndpoint](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateService.html#migrationhubrefactorspaces-CreateService-request-UrlEndpoint) parameter. All other health check settings for the\n load balancer use the default values described in the [Health\n checks for your target groups](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html) in the *ELB\n guide*. The health check is considered successful if at least one target\n within the target group transitions to a healthy state.\n* **AWS Lambda function endpoints**\n \n If the service has an AWS Lambda function endpoint, then Refactor Spaces\n configures the Lambda function's resource policy to allow the application's\n API Gateway to invoke the function.\n \n The Lambda function state is checked. If the function is not active, the\n function configuration is updated so that Lambda resources are provisioned. If\n the Lambda state is `Failed`, then the route creation fails. For\n more information, see the [GetFunctionConfiguration's State response parameter](https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State) in the *AWS Lambda Developer Guide*.\n \n A check is performed to determine that a Lambda function with the specified ARN\n exists. If it does not exist, the health check fails. For public URLs, a connection is\n opened to the public endpoint. If the URL is not reachable, the health check fails.\n**Environments without a network bridge**\nWhen you create environments without a network bridge ([CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) is `NONE)` and you use your own\nnetworking infrastructure, you need to configure [VPC to VPC connectivity](https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html) between your network and the application proxy VPC. Route\ncreation from the application proxy to service endpoints will fail if your network is not\nconfigured to connect to the application proxy VPC. For more information, see [Create\na route](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-role.html) in the *Refactor Spaces User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a composite ID following this format:\n`||`, for example,\n`env-1234654123|app-1234654123|rte-1234654123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html", "Properties": { "UriPathRoute": { "MarkdownDocumentation": "`UriPathRoute`\n\nThe configuration for the URI path route type.\n*Required*: No\n*Type*: [UriPathRouteInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-uripathroute", "UpdateType": "Mutable", "Required": false, "Type": "UriPathRouteInput" }, "EnvironmentIdentifier": { "MarkdownDocumentation": "`EnvironmentIdentifier`\n\nThe unique identifier of the environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^env-([0-9A-Za-z]{10}$)`\n*Minimum*: `14`\n*Maximum*: `14`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-environmentidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RouteType": { "MarkdownDocumentation": "`RouteType`\n\nThe route type of the route.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DEFAULT | URI_PATH...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "DEFAULT", "URI_PATH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-routetype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DefaultRoute": { "MarkdownDocumentation": "`DefaultRoute`\n\nConfiguration for the default route type.\n*Required*: No\n*Type*: [DefaultRouteInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-defaultroute", "UpdateType": "Mutable", "Required": false, "Type": "DefaultRouteInput" }, "ServiceIdentifier": { "MarkdownDocumentation": "`ServiceIdentifier`\n\nThe unique identifier of the service.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^svc-([0-9A-Za-z]{10}$)`\n*Minimum*: `14`\n*Maximum*: `14`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-serviceidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplicationIdentifier": { "MarkdownDocumentation": "`ApplicationIdentifier`\n\nThe unique identifier of the application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^app-([0-9A-Za-z]{10}$)`\n*Minimum*: `14`\n*Maximum*: `14`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-applicationidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the route.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-refactorspaces-route-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "RouteIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`RouteIdentifier`\n\nThe unique identifier of the route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#RouteIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the route.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#Arn-fn::getatt" }, "PathResourceToId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PathResourceToId`\n\nA mapping of Amazon API Gateway path resources to resource IDs.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#PathResourceToId-fn::getatt" } } }, "AWS::RefactorSpaces::Service": { "MarkdownDocumentation": "`AWS::RefactorSpaces::Service`\n\n###### Note\nAWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).\nCreates an AWS Migration Hub Refactor Spaces service. The account owner of the service is always the\nenvironment owner, regardless of which account in the environment creates the service.\nServices have either a URL endpoint in a virtual private cloud (VPC), or a Lambda\nfunction endpoint.\n###### Important\nIf an AWS resource is launched in a service VPC, and you want it to be\naccessible to all of an environment\u2019s services with VPCs and routes, apply the\n`RefactorSpacesSecurityGroup` to the resource. Alternatively, to add more\ncross-account constraints, apply your own security group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a composite ID following this format:\n`||`. For example,\n`env-1234654123|app-1234654123|svc-1234654123`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html", "Properties": { "LambdaEndpoint": { "MarkdownDocumentation": "`LambdaEndpoint`\n\nA summary of the configuration for the AWS Lambda endpoint type.\n*Required*: No\n*Type*: [LambdaEndpointInput](./aws-properties-refactorspaces-service-lambdaendpointinput.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-lambdaendpoint", "UpdateType": "Immutable", "Required": false, "Type": "LambdaEndpointInput" }, "UrlEndpoint": { "MarkdownDocumentation": "`UrlEndpoint`\n\nThe summary of the configuration for the URL endpoint type.\n*Required*: No\n*Type*: [UrlEndpointInput](./aws-properties-refactorspaces-service-urlendpointinput.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-urlendpoint", "UpdateType": "Immutable", "Required": false, "Type": "UrlEndpointInput" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the service.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_\\s\\.\\!\\*\\#\\@\\']+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EnvironmentIdentifier": { "MarkdownDocumentation": "`EnvironmentIdentifier`\n\nThe unique identifier of the environment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^env-([0-9A-Za-z]{10}$)`\n*Minimum*: `14`\n*Maximum*: `14`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-environmentidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the virtual private cloud (VPC).\n*Required*: No\n*Type*: String\n*Pattern*: `^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$`\n*Minimum*: `12`\n*Maximum*: `21`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-vpcid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EndpointType": { "MarkdownDocumentation": "`EndpointType`\n\nThe endpoint type of the service.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LAMBDA | URL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "LAMBDA", "URL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-endpointtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplicationIdentifier": { "MarkdownDocumentation": "`ApplicationIdentifier`\n\nThe unique identifier of the application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^app-([0-9A-Za-z]{10}$)`\n*Minimum*: `14`\n*Maximum*: `14`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-applicationidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags assigned to the service.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-refactorspaces-service-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the service.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ServiceIdentifier": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceIdentifier`\n\nThe unique identifier of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#ServiceIdentifier-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#Arn-fn::getatt" } } }, "AWS::Rekognition::Collection": { "MarkdownDocumentation": "`AWS::Rekognition::Collection`\n\nThe `AWS::Rekognition::Collection` type creates a server-side container called a collection. You can use a collection\nto store information about detected faces and search for known faces in images, stored videos, and streaming videos.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns\nthe collection ID. For example:\n`{ \"Ref\": \"MyCollection\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-collection.html", "Properties": { "CollectionId": { "MarkdownDocumentation": "`CollectionId`\n\nID for the collection that you are creating.\n*Required*: Yes\n*Type*: String\n*Pattern*: `\\A[a-zA-Z0-9_\\.\\-]+$`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-collection.html#cfn-rekognition-collection-collectionid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA set of tags (key-value pairs) that you want to attach to the collection.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rekognition-collection-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-collection.html#cfn-rekognition-collection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name of the collection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-collection.html#Arn-fn::getatt" } } }, "AWS::Rekognition::Project": { "MarkdownDocumentation": "`AWS::Rekognition::Project`\n\nThe `AWS::Rekognition::Project` type creates an Amazon Rekognition Custom Labels\nproject. A project is a group of resources needed to create and manage versions of an\nAmazon Rekognition Custom Labels model.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns\nthe project name. For example:\n`{ \"Ref\": \"CircuitBoardProject\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-project.html", "Properties": { "ProjectName": { "MarkdownDocumentation": "`ProjectName`\n\nThe name of the project to create.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9_\\-]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-project.html#cfn-rekognition-project-projectname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rekognition-project-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-project.html#cfn-rekognition-project-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name of the project.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-project.html#Arn-fn::getatt" } } }, "AWS::Rekognition::StreamProcessor": { "MarkdownDocumentation": "`AWS::Rekognition::StreamProcessor`\n\nThe `AWS::Rekognition::StreamProcessor` type creates a stream processor used to detect\nand recognize faces or to detect connected home\nlabels in a streaming video. Amazon Rekognition Video is a consumer of live video from\nAmazon Kinesis Video Streams. There are two different settings for stream processors in\nAmazon Rekognition, one for detecting faces and one for connected home features.\nIf you are creating a stream processor for detecting faces, you provide a\nKinesis video stream (input) and a Kinesis data stream (output). You also specify the face\nrecognition criteria in FaceSearchSettings. For example, the collection containing faces\nthat you want to recognize.\nIf you are creating a stream processor for detection of connected home labels, you\nprovide a Kinesis video stream for input, and for output an Amazon S3 bucket and an Amazon SNS topic. You\ncan also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You\nspecify what you want to detect in ConnectedHomeSettings, such as people, packages, and\npets.\nYou can also specify where in the frame you want Amazon Rekognition to monitor with\nBoundingBoxRegionsOfInterest and PolygonRegionsOfInterest. The Name is used to manage the\nstream processor and it is the identifier for the stream processor. The\n`AWS::Rekognition::StreamProcessor` resource creates a stream processor in\nthe same Region where you create the Amazon CloudFormation stack.\nFor more information, see [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns\nthe name of the stream processor. For example:\n`{ \"Ref\": \"MyStreamProcessor\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html", "Properties": { "S3Destination": { "MarkdownDocumentation": "`S3Destination`\n\nThe Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.\nFor more information, see the S3Destination section of [StreamProcessorOutput](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorOutput).\n*Required*: No\n*Type*: [S3Destination](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-s3destination", "UpdateType": "Immutable", "Required": false, "Type": "S3Destination" }, "DataSharingPreference": { "MarkdownDocumentation": "`DataSharingPreference`\n\nAllows you to opt in or opt out to share data with Rekognition to improve model performance.\nYou 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.\nFor more information, see [StreamProcessorDataSharingPreference](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorDataSharingPreference).\n*Required*: No\n*Type*: [DataSharingPreference](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-datasharingpreference", "UpdateType": "Immutable", "Required": false, "Type": "DataSharingPreference" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe identifier for your Amazon Key Management Service key (Amazon KMS key). Optional parameter for connected home stream processors\nused to encrypt results and data published to your Amazon S3 bucket.\nFor 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FaceSearchSettings": { "MarkdownDocumentation": "`FaceSearchSettings`\n\nThe input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor.\nFor 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-facesearchsettings", "UpdateType": "Immutable", "Required": false, "Type": "FaceSearchSettings" }, "PolygonRegionsOfInterest": { "MarkdownDocumentation": "`PolygonRegionsOfInterest`\n\nA set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects.\nEach entry of the set contains a polygon denoting a region of interest on the screen. Each polygon is an ordered\nlist of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects.\nFor more information, see the Polygon field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest).\n*Required*: No\n*Type*: Array of Array\n*Minimum*: `0`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-polygonregionsofinterest", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Json" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions to the Kinesis stream.\nIt also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a connected home stream processor.\nThis is required for both face search and connected home stream processors.\nFor 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*Pattern*: `arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe Name attribute specifies the name of the stream processor and it must be within the\nconstraints described in the Name section of [StreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessor).\nIf 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*Pattern*: `[a-zA-Z0-9_.\\-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ConnectedHomeSettings": { "MarkdownDocumentation": "`ConnectedHomeSettings`\n\nConnected home settings to use on a streaming video. You can use a stream processor for connected home features and select\nwhat you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for\neach object class specified. For more information,\nsee the ConnectedHome section of [StreamProcessorSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorSettings).\n*Required*: No\n*Type*: [ConnectedHomeSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-connectedhomesettings", "UpdateType": "Immutable", "Required": false, "Type": "ConnectedHomeSettings" }, "NotificationChannel": { "MarkdownDocumentation": "`NotificationChannel`\n\nThe Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.\nAmazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream.\nAmazon Rekognition also publishes an end-of-session notification with a summary when the stream processing session is complete.\nFor more information, see [StreamProcessorNotificationChannel](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorNotificationChannel).\n*Required*: No\n*Type*: [NotificationChannel](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-notificationchannel", "UpdateType": "Immutable", "Required": false, "Type": "NotificationChannel" }, "KinesisVideoStream": { "MarkdownDocumentation": "`KinesisVideoStream`\n\nThe Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor. For more information,\nsee [KinesisVideoStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisVideoStream).\n*Required*: Yes\n*Type*: [KinesisVideoStream](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-kinesisvideostream", "UpdateType": "Immutable", "Required": true, "Type": "KinesisVideoStream" }, "BoundingBoxRegionsOfInterest": { "MarkdownDocumentation": "`BoundingBoxRegionsOfInterest`\n\nList of BoundingBox objects, each of which denotes a region of interest on screen.\nFor more information, see the BoundingBox field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest).\n*Required*: No\n*Type*: Array of [BoundingBox](./aws-properties-rekognition-streamprocessor-boundingbox.html)\n*Minimum*: `0`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-boundingboxregionsofinterest", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "BoundingBox", "DuplicatesAllowed": false }, "KinesisDataStream": { "MarkdownDocumentation": "`KinesisDataStream`\n\nAmazon Rekognition's Video Stream Processor takes a Kinesis video stream as input. This is the Amazon Kinesis Data Streams instance\nto which the Amazon Rekognition stream processor streams the analysis results.\nThis must be created within the constraints specified at\n[KinesisDataStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisDataStream).\n*Required*: No\n*Type*: [KinesisDataStream](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-kinesisdatastream", "UpdateType": "Immutable", "Required": false, "Type": "KinesisDataStream" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA set of tags (key-value pairs) that you want to attach to the stream processor.\nFor more information, see the Tags section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rekognition-streamprocessor-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#cfn-rekognition-streamprocessor-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nCurrent status of the Amazon Rekognition stream processor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#Status-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nAmazon Resource Name for the newly created stream processor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#Arn-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nDetailed status message about the stream processor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rekognition-streamprocessor.html#StatusMessage-fn::getatt" } } }, "AWS::ResilienceHub::App": { "MarkdownDocumentation": "`AWS::ResilienceHub::App`\n\nCreates an AWS Resilience Hub application. An AWS Resilience Hub application is a\ncollection of AWS resources structured to prevent and recover AWS application disruptions. To describe a AWS Resilience Hub application, you provide an\napplication name, resources from one or more AWS CloudFormation stacks, AWS Resource Groups, Terraform state files, AppRegistry applications, and an appropriate\nresiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information\nabout the number of resources supported per application, see [Service\nquotas](https://docs.aws.amazon.com/general/latest/gr/resiliencehub.html#limits_resiliencehub).\nAfter you create an AWS Resilience Hub application, you publish it so that you can run\na resiliency assessment on it. You can then use recommendations from the assessment to improve\nresiliency by running another assessment, comparing results, and then iterating the process\nuntil you achieve your goals for recovery time objective (RTO) and recovery point objective\n(RPO).\n", "RefReturnValue": "\nThe returned Amazon Resource Name (ARN) for the applcation.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nOptional description for an 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AppTemplateBody": { "MarkdownDocumentation": "`AppTemplateBody`\n\nA JSON string that provides information about your application structure. To learn more\nabout the `appTemplateBody` template, see the sample template in [Sample appTemplateBody template](https://docs.aws.amazon.com//resilience-hub/latest/APIReference/API_PutDraftAppVersionTemplate.html#API_PutDraftAppVersionTemplate_Examples).\nThe `appTemplateBody` JSON string has the following structure:\n* **`resources`**\n \n The list of logical resources that needs to be included in the AWS Resilience Hub application.\n \n Type: Array\n \n ###### Note\n \n Don't add the resources that you want to exclude.\n \n Each `resources` array item includes the following fields:\n \n + *`logicalResourceId`*\n \n The logical identifier of the resource.\n \n Type: Object\n \n Each `logicalResourceId` object includes the following fields:\n \n - `identifier`\n \n Identifier of the resource.\n \n Type: String\n - `logicalStackName`\n \n Name of the AWS CloudFormation stack this resource belongs to.\n \n Type: String\n - `resourceGroupName`\n \n Name of the resource group this resource belongs to.\n \n Type: String\n - `terraformSourceName`\n \n Name of the Terraform S3 state file this resource belongs to.\n \n Type: String\n - `eksSourceName`\n \n Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.\n \n ###### Note\n \n This parameter accepts values in \"eks-cluster/namespace\" format.\n \n Type: String\n + *`type`*\n \n The type of resource.\n \n Type: string\n + *`name`*\n \n Name of the resource.\n \n Type: String\n + `additionalInfo`\n \n Additional configuration parameters for an AWS Resilience Hub application.\n If you want to implement `additionalInfo` through the AWS Resilience Hub console rather than using an API call, see\n [Configure the application configuration parameters](https://docs.aws.amazon.com//resilience-hub/latest/userguide/app-config-param.html).\n \n ###### Note\n \n Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.\n \n Key: `\"failover-regions\"`\n \n Value: `\"[{\"region\":\"\", \"accounts\":[{\"id\":\"\"}]}]\"`\n* **`appComponents`**\n \n The list of Application Components (AppComponent) that this resource belongs to. If an AppComponent is not part of the AWS Resilience Hub application, it will be added.\n \n Type: Array\n \n Each `appComponents` array item includes the following fields:\n \n + `name`\n \n Name of the AppComponent.\n \n Type: String\n + `type`\n \n The type of AppComponent. For more information about the types of AppComponent, see [Grouping resources in an AppComponent](https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html).\n \n Type: String\n + `resourceNames`\n \n The list of included resources that are assigned to the AppComponent.\n \n Type: Array of strings\n + `additionalInfo`\n \n Additional configuration parameters for an AWS Resilience Hub application.\n If you want to implement `additionalInfo` through the AWS Resilience Hub console rather than using an API call, see\n [Configure the application configuration parameters](https://docs.aws.amazon.com//resilience-hub/latest/userguide/app-config-param.html).\n \n ###### Note\n \n Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.\n \n Key: `\"failover-regions\"`\n \n Value: `\"[{\"region\":\"\", \"accounts\":[{\"id\":\"\"}]}]\"`\n* **`excludedResources`**\n \n The list of logical resource identifiers to be excluded from the application.\n \n Type: Array\n \n ###### Note\n \n Don't add the resources that you want to include.\n \n Each `excludedResources` array item includes the following fields:\n \n + *`logicalResourceIds`*\n \n The logical identifier of the resource.\n \n Type: Object\n \n ###### Note\n \n You can configure only one of the following fields:\n \n - `logicalStackName`\n - `resourceGroupName`\n - `terraformSourceName`\n - `eksSourceName`\n \n Each `logicalResourceIds` object includes the following fields:\n \n - `identifier`\n \n The identifier of the resource.\n \n Type: String\n - `logicalStackName`\n \n Name of the AWS CloudFormation stack this resource belongs to.\n \n Type: String\n - `resourceGroupName`\n \n Name of the resource group this resource belongs to.\n \n Type: String\n - `terraformSourceName`\n \n Name of the Terraform S3 state file this resource belongs to.\n \n Type: String\n - `eksSourceName`\n \n Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.\n \n ###### Note\n \n This parameter accepts values in \"eks-cluster/namespace\" format.\n \n Type: String\n* **`version`**\n \n The AWS Resilience Hub application version.\n* `additionalInfo`\n \n Additional configuration parameters for an AWS Resilience Hub application.\n If you want to implement `additionalInfo` through the AWS Resilience Hub console rather than using an API call, see\n [Configure the application configuration parameters](https://docs.aws.amazon.com//resilience-hub/latest/userguide/app-config-param.html).\n \n ###### Note\n \n Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.\n \n Key: `\"failover-regions\"`\n \n Value: `\"[{\"region\":\"\", \"accounts\":[{\"id\":\"\"}]}]\"`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\s:,-\\.'\\/{}\\[\\]:\"]+$`\n*Minimum*: `0`\n*Maximum*: `409600`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-apptemplatebody", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AppAssessmentSchedule": { "MarkdownDocumentation": "`AppAssessmentSchedule`\n\nAssessment execution schedule with 'Daily' or 'Disabled' values.\n*Required*: No\n*Type*: String\n*Allowed values*: `Disabled | Daily...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Disabled", "Daily" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-appassessmentschedule", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PermissionModel": { "MarkdownDocumentation": "`PermissionModel`\n\nDefines the roles and credentials that AWS Resilience Hub would use while creating the\napplication, importing its resources, and running an assessment.\n*Required*: No\n*Type*: [PermissionModel](./aws-properties-resiliencehub-app-permissionmodel.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-permissionmodel", "UpdateType": "Mutable", "Required": false, "Type": "PermissionModel" }, "ResourceMappings": { "MarkdownDocumentation": "`ResourceMappings`\n\nAn array of `ResourceMapping` objects.\n*Required*: Yes\n*Type*: Array of [ResourceMapping](./aws-properties-resiliencehub-app-resourcemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-resourcemappings", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ResourceMapping", "DuplicatesAllowed": true }, "EventSubscriptions": { "MarkdownDocumentation": "`EventSubscriptions`\n\nThe list of events you would like to subscribe and get notification for. Currently,\nAWS Resilience Hub supports notifications only for **Drift\ndetected** and **Scheduled assessment failure**\nevents.\n*Required*: No\n*Type*: Array of [EventSubscription](./aws-properties-resiliencehub-app-eventsubscription.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-eventsubscriptions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EventSubscription", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags assigned to the resource. A tag is a label that you assign to an AWS resource.\nEach tag consists of a key/value pair.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,128}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName for 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResiliencyPolicyArn": { "MarkdownDocumentation": "`ResiliencyPolicyArn`\n\nThe Amazon Resource Name (ARN) of the resiliency policy.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-resiliencypolicyarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "AppArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AppArn`\n\nThe Amazon Resource Name (ARN) of the applcation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#AppArn-fn::getatt" }, "DriftStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`DriftStatus`\n\nIndicates if compliance drifts (deviations) were detected while running an assessment for\nyour application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#DriftStatus-fn::getatt" } } }, "AWS::ResilienceHub::ResiliencyPolicy": { "MarkdownDocumentation": "`AWS::ResilienceHub::ResiliencyPolicy`\n\nDefines a resiliency policy.\n###### Note\nAWS Resilience Hub allows you to provide a value of zero for `rtoInSecs`\nand `rpoInSecs` of your resiliency policy. But, while assessing your application,\nthe lowest possible assessment result is near zero. Hence, if you provide value zero for\n`rtoInSecs` and `rpoInSecs`, the estimated workload RTO and\nestimated workload RPO result will be near zero and the **Compliance\nstatus** for your application will be set to **Policy\nbreached**.\n", "RefReturnValue": "\nThe returned Amazon Resource Name (ARN) for the resiliency policy.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe resiliency policy.\n*Required*: Yes\n*Type*: [PolicyMap](./aws-properties-resiliencehub-resiliencypolicy-policymap.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-policy", "UpdateType": "Mutable", "Required": true, "Type": "PolicyMap" }, "PolicyDescription": { "MarkdownDocumentation": "`PolicyDescription`\n\nDescription of the resiliency policy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-policydescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tier": { "MarkdownDocumentation": "`Tier`\n\nThe tier for this resiliency policy, ranging from the highest severity\n(`MissionCritical`) to lowest (`NonCritical`).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `MissionCritical | Critical ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "MissionCritical", "Critical", "Important", "CoreServices", "NonCritical" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-tier", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the policy\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-policyname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataLocationConstraint": { "MarkdownDocumentation": "`DataLocationConstraint`\n\nSpecifies a high-level geographical location constraint for where your resilience policy\ndata can be stored.\n*Required*: No\n*Type*: String\n*Allowed values*: `AnyLocation | SameContinent...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AnyLocation", "SameContinent", "SameCountry" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-datalocationconstraint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags assigned to the resource. A tag is a label that you assign to an AWS resource.\nEach tag consists of a key/value pair.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `.{1,128}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "PolicyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyArn`\n\nAmazon Resource Name (ARN) of the resiliency policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#PolicyArn-fn::getatt" } } }, "AWS::ResourceExplorer2::DefaultViewAssociation": { "MarkdownDocumentation": "`AWS::ResourceExplorer2::DefaultViewAssociation`\n\nSets the specified view as the default for the AWS Region in which\nyou call this operation. If a user makes a search query that doesn't explicitly specify\nthe view to use, Resource Explorer chooses this default view automatically for searches\nperformed in this AWS Region.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the identity of the principal that the view is now\nassociated with in the specified AWS Region. For example:\n`123456789012`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-defaultviewassociation.html", "Properties": { "ViewArn": { "MarkdownDocumentation": "`ViewArn`\n\nThe ARN of the view to set as the default for the AWS Region and\nAWS account in which you call this operation. The specified view\nmust 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-defaultviewassociation.html#cfn-resourceexplorer2-defaultviewassociation-viewarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AssociatedAwsPrincipal": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociatedAwsPrincipal`\n\nThe unique identifier of the principal for which the specified view was made the\ndefault for the AWS Region that contains the view. For example:\n`123456789012`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-defaultviewassociation.html#AssociatedAwsPrincipal-fn::getatt" } } }, "AWS::ResourceExplorer2::Index": { "MarkdownDocumentation": "`AWS::ResourceExplorer2::Index`\n\nTurns on Resource Explorer in the AWS Region in which you called this\noperation by creating an index. Resource Explorer begins discovering the resources in\nthis Region and stores the details about the resources in the index so that they can be\nqueried by using the [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html)\noperation.\nYou can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index\nthat returns search results from all AWS Regions in the AWS account.\nFor more details about what happens when you turn on Resource Explorer in an AWS Region, see [Turning on\nResource Explorer to index your resources in an AWS Region](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html)\nin the *AWS Resource Explorer User Guide.*\nIf this is the first AWS Region in which you've created an index for\nResource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and\npopulate the index.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the new index. For example:\n`arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nSpecifies the type of the index in this Region. For information about the aggregator\nindex and how it differs from a local index, see [Turning on\ncross-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*: `LOCAL | AGGREGATOR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "LOCAL", "AGGREGATOR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#cfn-resourceexplorer2-index-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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\nindex.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#cfn-resourceexplorer2-index-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the new index for the AWS Region. For example:\n`arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#Arn-fn::getatt" }, "IndexState": { "PrimitiveType": "String", "MarkdownDocumentation": "`IndexState`\n\nIndicates the current state of the index. For example:\n`CREATING`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#IndexState-fn::getatt" } } }, "AWS::ResourceExplorer2::View": { "MarkdownDocumentation": "`AWS::ResourceExplorer2::View`\n\nCreates a view that users can query by using the [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html)\noperation. Results from queries that you make using this view include only resources\nthat match the view's `Filters`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the new view. For example:\n`arn:aws:resource-explorer-2:us-east-1:123456789012:view/CFNStackView2/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html", "Properties": { "Filters": { "MarkdownDocumentation": "`Filters`\n\nAn array of strings that include search keywords, prefixes, and operators that filter\nthe results that are returned for queries made using this view. When you use this view\nin a [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html)\noperation, the filter string is combined with the search's `QueryString`\nparameter using a logical `AND` operator.\nFor information about the supported syntax, see [Search query\nreference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS\nResource Explorer User Guide*.\n###### Important\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\n`region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the\nletters `us` and are *not* tagged with a key\n`Stage` that has the value `prod`.\n*Required*: No\n*Type*: [SearchFilter](./aws-properties-resourceexplorer2-view-searchfilter.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-filters", "UpdateType": "Mutable", "Required": false, "Type": "SearchFilter" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nThe root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-scope", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IncludedProperties": { "MarkdownDocumentation": "`IncludedProperties`\n\nA list of fields that provide additional information about the view.\n*Required*: No\n*Type*: Array of [IncludedProperty](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-includedproperties", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IncludedProperty", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTag key and value pairs that are attached to the view.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ViewName": { "MarkdownDocumentation": "`ViewName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-viewname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ViewArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ViewArn`\n\nThe ARN of the new view. For example:\n`arn:aws:resource-explorer-2:us-east-1:123456789012:view/MyView/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#ViewArn-fn::getatt" } } }, "AWS::ResourceGroups::Group": { "MarkdownDocumentation": "`AWS::ResourceGroups::Group`\n\nCreates a resource group with the specified name and description. You can optionally\ninclude either a resource query or a service configuration. For more information about\nconstructing a resource query, see [Build queries and groups in\nAWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/getting_started-query.html) in the *AWS Resource Groups User Guide*. For more information\nabout service-linked groups and service configurations, see [Service configurations for Resource Groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html).\n**Minimum permissions**\nTo run this command, you must have the following permissions:\n* `resource-groups:CreateGroup`\n", "RefReturnValue": "\nThe name of the new resource group.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the resource group.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nThe service configuration currently associated with the resource group and in effect\nfor the members of the resource group. A `Configuration` consists of one or\nmore `ConfigurationItem` entries. For information about service\nconfigurations for resource groups and how to construct them, see [Service\nconfigurations for resource groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups\nUser Guide*.\n###### Note\nYou can include either a `Configuration` or a\n`ResourceQuery`, but not both.\n*Required*: Conditional\n*Type*: Array of [ConfigurationItem](./aws-properties-resourcegroups-group-configurationitem.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-configuration", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ConfigurationItem", "DuplicatesAllowed": true }, "ResourceQuery": { "MarkdownDocumentation": "`ResourceQuery`\n\nThe resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group. For more\ninformation about queries and how to construct them, see [Build queries and groups in\nAWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/gettingstarted-query.html) in the *AWS Resource Groups User\nGuide*\n###### Note\n* You can include either a `ResourceQuery` or a\n `Configuration`, but not both.\n* You can specify the group's membership either by using a\n `ResourceQuery` or by using a list of `Resources`,\n but not both.\n*Required*: Conditional\n*Type*: [ResourceQuery](./aws-properties-resourcegroups-group-resourcequery.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-resourcequery", "UpdateType": "Mutable", "Required": false, "Type": "ResourceQuery" }, "Resources": { "MarkdownDocumentation": "`Resources`\n\nA list of the Amazon Resource Names (ARNs) of AWS resources that you\nwant to add to the specified group.\n###### Note\n* You can specify the group membership either by using a list of\n `Resources` or by using a `ResourceQuery`, but not\n both.\n* You can include a `Resources` property only if you also specify\n a `Configuration` property.\n*Required*: Conditional\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-resources", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tag key and value pairs that are attached to the resource group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-resourcegroups-group-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a resource group. The name must be unique within the AWS\nRegion in which you create the resource. To create multiple resource groups based on the\nsame CloudFormation stack, you must generate unique names for each.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the new resource group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#Arn-fn::getatt" } } }, "AWS::ResourceGroups::TagSyncTask": { "MarkdownDocumentation": "`AWS::ResourceGroups::TagSyncTask`\n\nOnboards and syncs resources tagged with a specific tag key-value pair to an application.\n**Minimum permissions**\nTo run this command, you must have the following permissions:\n* `resource-groups:StartTagSyncTask`\n* `resource-groups:CreateGroup`\n* `iam:PassRole` for the role you provide to create a tag-sync task\n", "RefReturnValue": "\nThe `TaskArn`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html", "Properties": { "Group": { "MarkdownDocumentation": "`Group`\n\nThe Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.\n*Required*: Yes\n*Type*: String\n*Pattern*: `([a-zA-Z0-9_\\\\.-]{1,150}/[a-z0-9]{26})|(arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\\\.-]{1,150}/[a-z0-9]{26})`\n*Minimum*: `12`\n*Maximum*: `1600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-group", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TagKey": { "MarkdownDocumentation": "`TagKey`\n\nThe tag key.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-tagkey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TagValue": { "MarkdownDocumentation": "`TagValue`\n\nThe tag value.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-tagvalue", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GroupName": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupName`\n\nThe name of the application group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#GroupName-fn::getatt" }, "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the tag-sync task.\nValid values include:\n* `ACTIVE` - The tag-sync task is actively managing resources in\n the application by adding or removing the `awsApplication` tag from resources\n when they are tagged or untagged with the specified tag key-value pair.\n* `ERROR` - The tag-sync task is not actively managing resources\n in the application. Review the `ErrorMessage` for more information about\n resolving the error.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#Status-fn::getatt" }, "GroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupArn`\n\nThe Amazon resource name (ARN) of the application group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#GroupArn-fn::getatt" }, "TaskArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TaskArn`\n\nThe Amazon resource name (ARN) of the tag-sync task.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#TaskArn-fn::getatt" } } }, "AWS::RoboMaker::Fleet": { "MarkdownDocumentation": "`AWS::RoboMaker::Fleet`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html", "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#Arn-fn::getatt" } }, "Properties": { "Tags": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#cfn-robomaker-fleet-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#cfn-robomaker-fleet-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::RoboMaker::Robot": { "MarkdownDocumentation": "`AWS::RoboMaker::Robot`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html", "Properties": { "Fleet": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-fleet", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Architecture": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-architecture", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GreengrassGroupId": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-greengrassgroupid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robot.html#cfn-robomaker-robot-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::RoboMaker::RobotApplication": { "MarkdownDocumentation": "`AWS::RoboMaker::RobotApplication`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html", "Attributes": { "CurrentRevisionId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#CurrentRevisionId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#Arn-fn::getatt" } }, "Properties": { "CurrentRevisionId": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-currentrevisionid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RobotSoftwareSuite": { "Type": "RobotSoftwareSuite", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-robotsoftwaresuite", "UpdateType": "Immutable" }, "Sources": { "Type": "List", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-sources", "ItemType": "SourceConfig", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplication.html#cfn-robomaker-robotapplication-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::RoboMaker::RobotApplicationVersion": { "MarkdownDocumentation": "`AWS::RoboMaker::RobotApplicationVersion`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplicationversion.html", "Properties": { "CurrentRevisionId": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplicationversion.html#cfn-robomaker-robotapplicationversion-currentrevisionid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Application": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-robotapplicationversion.html#cfn-robomaker-robotapplicationversion-application", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::RoboMaker::SimulationApplication": { "MarkdownDocumentation": "`AWS::RoboMaker::SimulationApplication`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html", "Attributes": { "CurrentRevisionId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#CurrentRevisionId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#Arn-fn::getatt" } }, "Properties": { "RenderingEngine": { "Type": "RenderingEngine", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-renderingengine", "UpdateType": "Immutable" }, "SimulationSoftwareSuite": { "Type": "SimulationSoftwareSuite", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-simulationsoftwaresuite", "UpdateType": "Immutable" }, "CurrentRevisionId": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-currentrevisionid", "PrimitiveType": "String", "UpdateType": "Mutable" }, "RobotSoftwareSuite": { "Type": "RobotSoftwareSuite", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-robotsoftwaresuite", "UpdateType": "Immutable" }, "Sources": { "Type": "List", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-sources", "ItemType": "SourceConfig", "UpdateType": "Mutable" }, "Tags": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-tags", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplication.html#cfn-robomaker-simulationapplication-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::RoboMaker::SimulationApplicationVersion": { "MarkdownDocumentation": "`AWS::RoboMaker::SimulationApplicationVersion`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplicationversion.html", "Properties": { "CurrentRevisionId": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplicationversion.html#cfn-robomaker-simulationapplicationversion-currentrevisionid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Application": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-simulationapplicationversion.html#cfn-robomaker-simulationapplicationversion-application", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::RolesAnywhere::CRL": { "MarkdownDocumentation": "`AWS::RolesAnywhere::CRL`\n\nThe `AWS::RolesAnywhere::CRL` resource Property description not available. for RolesAnywhere.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`CrlId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-crl.html", "Properties": { "TrustAnchorArn": { "MarkdownDocumentation": "`TrustAnchorArn`\n\nThe ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(-[^:]+)?:rolesanywhere(:.*){2}(:trust-anchor.*)$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-crl.html#cfn-rolesanywhere-crl-trustanchorarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nSpecifies 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-crl.html#cfn-rolesanywhere-crl-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "CrlData": { "MarkdownDocumentation": "`CrlData`\n\nThe x509 v3 specified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-crl.html#cfn-rolesanywhere-crl-crldata", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to attach to the certificate revocation list (CRL).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rolesanywhere-crl-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-crl.html#cfn-rolesanywhere-crl-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the certificate revocation list (CRL).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[ a-zA-Z0-9-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-crl.html#cfn-rolesanywhere-crl-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "CrlId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CrlId`\n\nThe unique primary identifier of the Crl\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-crl.html#CrlId-fn::getatt" } } }, "AWS::RolesAnywhere::Profile": { "MarkdownDocumentation": "`AWS::RolesAnywhere::Profile`\n\nCreates a Profile.\n", "RefReturnValue": "\nThe name of the Profile\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html", "Properties": { "ManagedPolicyArns": { "MarkdownDocumentation": "`ManagedPolicyArns`\n\nA list of managed policy ARNs. Managed policies identified by this list will be applied to the vended session credentials.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-managedpolicyarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RequireInstanceProperties": { "MarkdownDocumentation": "`RequireInstanceProperties`\n\nSpecifies whether instance properties are required in CreateSession requests with this profile.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-requireinstanceproperties", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleArns": { "MarkdownDocumentation": "`RoleArns`\n\nA list of IAM role ARNs that can be assumed when this profile is specified in a CreateSession request.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-rolearns", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AcceptRoleSessionName": { "MarkdownDocumentation": "`AcceptRoleSessionName`\n\nUsed to determine if a custom role session name will be accepted in a temporary credential 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-acceptrolesessionname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SessionPolicy": { "MarkdownDocumentation": "`SessionPolicy`\n\nA session policy that will applied 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-sessionpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AttributeMappings": { "MarkdownDocumentation": "`AttributeMappings`\n\nA mapping applied to the authenticating end-entity certificate.\n*Required*: No\n*Type*: Array of [AttributeMapping](./aws-properties-rolesanywhere-profile-attributemapping.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-attributemappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AttributeMapping", "DuplicatesAllowed": true }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nThe enabled status of the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DurationSeconds": { "MarkdownDocumentation": "`DurationSeconds`\n\nThe number of seconds vended session credentials will be valid for\n*Required*: No\n*Type*: Number\n*Minimum*: `900`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-durationseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of Tags.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rolesanywhere-profile-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe customer specified name of the resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[ a-zA-Z0-9-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#cfn-rolesanywhere-profile-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ProfileId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProfileId`\n\nThe unique primary identifier of the Profile\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#ProfileId-fn::getatt" }, "ProfileArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProfileArn`\n\nThe ARN of the profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-profile.html#ProfileArn-fn::getatt" } } }, "AWS::RolesAnywhere::TrustAnchor": { "MarkdownDocumentation": "`AWS::RolesAnywhere::TrustAnchor`\n\nCreates a TrustAnchor.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`TrustAnchorId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html", "Properties": { "NotificationSettings": { "MarkdownDocumentation": "`NotificationSettings`\n\nA list of notification settings to be associated to the trust anchor.\n*Required*: No\n*Type*: Array of [NotificationSetting](./aws-properties-rolesanywhere-trustanchor-notificationsetting.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html#cfn-rolesanywhere-trustanchor-notificationsettings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "NotificationSetting", "DuplicatesAllowed": true }, "Enabled": { "MarkdownDocumentation": "`Enabled`\n\nIndicates 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html#cfn-rolesanywhere-trustanchor-enabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Source": { "MarkdownDocumentation": "`Source`\n\nThe trust anchor type and its related certificate data.\n*Required*: Yes\n*Type*: [Source](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html#cfn-rolesanywhere-trustanchor-source", "UpdateType": "Mutable", "Required": true, "Type": "Source" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to attach to the trust anchor.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-rolesanywhere-trustanchor-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html#cfn-rolesanywhere-trustanchor-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the trust anchor.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[ a-zA-Z0-9-_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html#cfn-rolesanywhere-trustanchor-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "TrustAnchorArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrustAnchorArn`\n\nThe ARN of the trust anchor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html#TrustAnchorArn-fn::getatt" }, "TrustAnchorId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrustAnchorId`\n\nThe unique identifier of the trust anchor.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rolesanywhere-trustanchor.html#TrustAnchorId-fn::getatt" } } }, "AWS::Route53::CidrCollection": { "MarkdownDocumentation": "`AWS::Route53::CidrCollection`\n\nCreates a CIDR collection in the current AWS account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `CidrCollection` ID.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html", "Properties": { "Locations": { "MarkdownDocumentation": "`Locations`\n\nA complex type that contains information about the list of CIDR locations.\n*Required*: No\n*Type*: Array of [Location](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-locations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Location", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of a CIDR collection.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#cfn-route53-cidrcollection-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe UUID of the CIDR collection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\n\"The Amazon resource name (ARN) to uniquely identify the AWS resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-cidrcollection.html#Arn-fn::getatt" } } }, "AWS::Route53::DNSSEC": { "MarkdownDocumentation": "`AWS::Route53::DNSSEC`\n\nThe `AWS::Route53::DNSSEC` resource is used to enable DNSSEC signing in a hosted zone.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the hosted zone ID. For example:\n`{ \"Ref\": \"Z00001111A1ABCaaABC11\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html", "Properties": { "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nA unique string (ID) that is used to identify a hosted zone. For example: `Z00001111A1ABCaaABC11`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z0-9]{1,32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-dnssec.html#cfn-route53-dnssec-hostedzoneid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53::HealthCheck": { "MarkdownDocumentation": "`AWS::Route53::HealthCheck`\n\nThe `AWS::Route53::HealthCheck` resource is a Route 53 resource type that contains settings for\na Route 53 health check.\nFor information about associating health checks with records, see\n[HealthCheckId](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId)\nin\n[ChangeResourceRecordSets](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html).\n###### Note\nYou can't create a health check with simple routing.\n**ELB Load Balancers**\nIf you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the\nEC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a\nsimilar function to a Route 53 health check.\n**Private Hosted Zones**\nYou can associate health checks with failover records in a private hosted zone. Note the following:\n* Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must\n assign a public IP address to the instance in the VPC.\n* You can configure a health checker to check the health of an external resource that the instance relies on, such as a\n database server.\n* You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the\n state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 `StatusCheckFailed` metric,\n add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating\n CloudWatch metrics and alarms by using the CloudWatch console, see the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the health check ID, such as `e0a123b4-4dba-4650-935e-example`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html", "Properties": { "HealthCheckConfig": { "MarkdownDocumentation": "`HealthCheckConfig`\n\nA complex type that contains detailed information about one health check.\nFor the values to enter for `HealthCheckConfig`, see\n[HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html)\n*Required*: Yes\n*Type*: [HealthCheckConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig", "UpdateType": "Mutable", "Required": true, "Type": "HealthCheckConfig" }, "HealthCheckTags": { "MarkdownDocumentation": "`HealthCheckTags`\n\nThe `HealthCheckTags` property describes key-value pairs that are associated with an `AWS::Route53::HealthCheck` resource.\n*Required*: No\n*Type*: Array of [HealthCheckTag](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HealthCheckTag", "DuplicatesAllowed": false } }, "Attributes": { "HealthCheckId": { "PrimitiveType": "String", "MarkdownDocumentation": "`HealthCheckId`\n\nThe identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#HealthCheckId-fn::getatt" } } }, "AWS::Route53::HostedZone": { "MarkdownDocumentation": "`AWS::Route53::HostedZone`\n\nCreates a new public or private hosted zone. You create records in a public hosted\nzone to define how you want to route traffic on the internet for a domain, such as\nexample.com, and its subdomains (apex.example.com, acme.example.com). You create records\nin a private hosted zone to define how you want to route traffic for a domain and its\nsubdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).\n###### Important\nYou can't convert a public hosted zone to a private hosted zone or vice versa.\nInstead, you must create a new hosted zone with the same name and create new\nresource record sets.\nFor more information about charges for hosted zones, see [Amazon Route\u00a053 Pricing](https://aws.amazon.com/route53/pricing/).\nNote the following:\n* You can't create a hosted zone for a top-level domain (TLD) such as\n .com.\n* If your domain is registered with a registrar other than Route\u00a053,\n you must update the name servers with your registrar to make Route 53 the DNS\n service for the domain. For more information, see [Migrating DNS Service\n for an Existing Domain to Amazon Route\u00a053](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the\n *Amazon Route 53 Developer Guide*.\nWhen you submit a `CreateHostedZone` request, the initial status of the\nhosted zone is `PENDING`. For public hosted zones, this means that the NS and\nSOA records are not yet available on all Route\u00a053 DNS servers. When the NS and\nSOA records are available, the status of the zone changes to `INSYNC`.\nThe `CreateHostedZone` request requires the caller to have an\n`ec2:DescribeVpcs` permission.\n###### Note\nWhen creating private hosted zones, the Amazon VPC must belong to the same\npartition where the hosted zone is created. A partition is a group of AWS Regions. Each AWS account is scoped to one\npartition.\nThe following are the supported partitions:\n* `aws` - AWS Regions\n* `aws-cn` - China Regions\n* `aws-us-gov` - AWS GovCloud (US) Region\nFor more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)\nin the *AWS General Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the hosted zone ID, such as `Z23ABC4XYZL05B`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html", "Properties": { "HostedZoneTags": { "MarkdownDocumentation": "`HostedZoneTags`\n\nAdds, edits, or deletes tags for a health check or a hosted zone.\nFor information about using tags for cost allocation, see [Using Cost Allocation\nTags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *AWS Billing and Cost Management User Guide*.\n*Required*: No\n*Type*: Array of [HostedZoneTag](./aws-properties-route53-hostedzone-hostedzonetag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HostedZoneTag", "DuplicatesAllowed": false }, "VPCs": { "MarkdownDocumentation": "`VPCs`\n\n*Private hosted zones:* A complex type that contains information about the VPCs that are\nassociated with the specified hosted zone.\n###### Note\nFor public hosted zones, omit `VPCs`, `VPCId`, and `VPCRegion`.\n*Required*: No\n*Type*: Array of [VPC](./aws-properties-route53-hostedzone-vpc.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VPC", "DuplicatesAllowed": false }, "HostedZoneFeatures": { "MarkdownDocumentation": "`HostedZoneFeatures`\n\nThe features configuration for the hosted zone, including accelerated recovery settings and status information.\n*Required*: No\n*Type*: [HostedZoneFeatures](./aws-properties-route53-hostedzone-hostedzonefeatures.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonefeatures", "UpdateType": "Mutable", "Required": false, "Type": "HostedZoneFeatures" }, "HostedZoneConfig": { "MarkdownDocumentation": "`HostedZoneConfig`\n\nA complex type that contains an optional comment.\nIf you don't want to specify a comment, omit the `HostedZoneConfig` and `Comment` elements.\n*Required*: No\n*Type*: [HostedZoneConfig](./aws-properties-route53-hostedzone-hostedzoneconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig", "UpdateType": "Mutable", "Required": false, "Type": "HostedZoneConfig" }, "QueryLoggingConfig": { "MarkdownDocumentation": "`QueryLoggingConfig`\n\nCreates a configuration for DNS query logging. After you create a query logging\nconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\nlog group.\nDNS query logs contain information about the queries that Route 53 receives for a\nspecified public hosted zone, such as the following:\n* Route 53 edge location that responded to the DNS query\n* Domain or subdomain that was requested\n* DNS record type, such as A or AAAA\n* DNS response code, such as `NoError` or\n `ServFail`\nLog Group and Resource Policy\nBefore you create a query logging configuration, perform the following\noperations.\n###### Note\nIf you create a query logging configuration using the Route 53\nconsole, Route 53 performs these operations automatically.\n\n1. Create a CloudWatch Logs log group, and make note of the ARN,\n which you specify when you create a query logging configuration.\n Note the following:\n \n * You must create the log group in the us-east-1\n region.\n * You must use the same AWS account to create\n the log group and the hosted zone that you want to configure\n query logging for.\n * When you create log groups for query logging, we recommend\n that you use a consistent prefix, for example:\n \n `/aws/route53/hosted zone\n name`\n \n In the next step, you'll create a resource policy, which\n controls access to one or more log groups and the associated\n AWS resources, such as Route 53 hosted\n zones. There's a limit on the number of resource policies\n that you can create, so we recommend that you use a\n consistent prefix so you can use the same resource policy\n for all the log groups that you create for query\n logging.\n2. Create a CloudWatch Logs resource policy, and give it the\n permissions that Route 53 needs to create log streams and to send\n query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1\n region. For the value of `Resource`,\n specify the ARN for the log group that you created in the previous\n step. To use the same resource policy for all the CloudWatch Logs\n log groups that you created for query logging configurations,\n replace the hosted zone name with `*`, for\n example:\n \n `arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*`\n \n To avoid the confused deputy problem, a security issue where an\n entity without a permission for an action can coerce a\n more-privileged entity to perform it, you can optionally limit the\n permissions that a service has to a resource in a resource-based\n policy by supplying the following values:\n \n * For `aws:SourceArn`, supply the hosted zone ARN\n used in creating the query logging configuration. For\n example, `aws:SourceArn:\n arn:aws:route53:::hostedzone/hosted zone\n ID`.\n * For `aws:SourceAccount`, supply the account ID\n for the account that creates the query logging\n configuration. For example,\n `aws:SourceAccount:111111111111`.\n \n For more information, see [The confused\n deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) in the *AWS\n IAM User Guide*.\n \n ###### Note\n \n You can't use the CloudWatch console to create or edit a\n resource policy. You must use the CloudWatch API, one of the\n AWS SDKs, or the AWS CLI.\n\nLog Streams and Edge Locations\nWhen Route 53 finishes creating the configuration for DNS query logging,\nit does the following:\n* Creates a log stream for an edge location the first time that the\n edge location responds to DNS queries for the specified hosted zone.\n That log stream is used to log all queries that Route 53 responds to\n for that edge location.\n* Begins to send query logs to the applicable log stream.\nThe name of each log stream is in the following format:\n`hosted zone ID/edge location\ncode`\nThe edge location code is a three-letter code and an arbitrarily assigned\nnumber, for example, DFW3. The three-letter code typically corresponds with\nthe International Air Transport Association airport code for an airport near\nthe edge location. (These abbreviations might change in the future.) For a\nlist of edge locations, see \"The Route 53 Global Network\" on the [Route 53 Product Details](https://aws.amazon.com/route53/details/)\npage.\n\nQueries That Are Logged\nQuery logs contain only the queries that DNS resolvers forward to Route\n53. If a DNS resolver has already cached the response to a query (such as\nthe IP address for a load balancer for example.com), the resolver will\ncontinue to return the cached response. It doesn't forward another query to\nRoute 53 until the TTL for the corresponding resource record set expires.\nDepending on how many DNS queries are submitted for a resource record set,\nand depending on the TTL for that resource record set, query logs might\ncontain information about only one query out of every several thousand\nqueries that are submitted to DNS. For more information about how DNS works,\nsee [Routing\nInternet Traffic to Your Website or Web Application](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) in the\n*Amazon Route 53 Developer Guide*.\n\nLog File Format\nFor a list of the values in each query log and the format of each value,\nsee [Logging DNS\nQueries](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in the *Amazon Route 53 Developer\nGuide*.\n\nPricing\nFor information about charges for query logs, see [Amazon CloudWatch Pricing](https://aws.amazon.com/cloudwatch/pricing/).\n\nHow to Stop Logging\nIf you want Route 53 to stop sending query logs to CloudWatch Logs, delete\nthe query logging configuration. For more information, see [DeleteQueryLoggingConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html).\n\n*Required*: No\n*Type*: [QueryLoggingConfig](./aws-properties-route53-hostedzone-queryloggingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig", "UpdateType": "Mutable", "Required": false, "Type": "QueryLoggingConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the domain. Specify a fully qualified domain name, for example, *www.example.com*.\nThe trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats\n*www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.\nIf you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name\nis registered with a registrar other than Route 53, change the name servers for your domain to the set of `NameServers` that\nare returned by the `Fn::GetAtt` intrinsic function.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID that Amazon Route 53 assigned to the hosted zone when you created it.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#Id-fn::getatt" }, "NameServers": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`NameServers`\n\nReturns the set of name servers for the specific hosted zone. For example: `ns1.example.com`.\nThis attribute is not supported for private hosted zones.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#NameServers-fn::getatt" } } }, "AWS::Route53::KeySigningKey": { "MarkdownDocumentation": "`AWS::Route53::KeySigningKey`\n\nThe `AWS::Route53::KeySigningKey` resource creates a new key-signing key (KSK) in a hosted zone. The hosted zone ID is passed as a\nparameter in the KSK properties. You can specify the properties of this KSK using the `Name`, `Status`, and\n`KeyManagementServiceArn` properties of the resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a identifier that is based on both the hosted zone ID and the KSK name properties. For example:\n`{ \"Ref\": \"Z00001111A1ABCaaABC11|KSK1\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nA 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.\n\nINACTIVE\nThe KSK is not being used for signing.\n\nDELETING\nThe KSK is in the process of being deleted.\n\nACTION\\_NEEDED\nThere is a problem with the KSK that requires you to take action to\nresolve. For example, the customer managed key might have been deleted,\nor the permissions for the customer managed key might have been\nchanged.\n\nINTERNAL\\_FAILURE\nThere was an error during a request. Before you can continue to work with\nDNSSEC signing, including actions that involve this KSK, you must correct\nthe problem. For example, you may need to activate or deactivate the\nKSK.\n\n*Required*: Yes\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)", "RefReturnValue": "", "AllowedValues": [ "ACTIVE", "INACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-status", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "KeyManagementServiceArn": { "MarkdownDocumentation": "`KeyManagementServiceArn`\n\nThe Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service (AWS KMS ). The `KeyManagementServiceArn` must be unique for each key-signing key (KSK) in a single hosted zone. For example: `arn:aws:kms:us-east-1:111122223333:key/111a2222-a11b-1ab1-2ab2-1ab21a2b3a111`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-keymanagementservicearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nThe unique string (ID) that is used to identify a hosted zone. For example: `Z00001111A1ABCaaABC11`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z0-9]{1,32}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-hostedzoneid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA string used to identify a key-signing key (KSK). `Name` can include\nnumbers, letters, and underscores (\\_). `Name` must be unique for each\nkey-signing key in the same hosted zone.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Route53::RecordSet": { "MarkdownDocumentation": "`AWS::Route53::RecordSet`\n\nInformation about the record that you want to create.\nThe `AWS::Route53::RecordSet` type can be used as a standalone resource or as an embedded property in the\n`AWS::Route53::RecordSetGroup` type. Note that some `AWS::Route53::RecordSet` properties are valid\nonly when used within `AWS::Route53::RecordSetGroup`.\nFor more information, see [ChangeResourceRecordSets](https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html)\nin the *Amazon Route 53 API Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html", "Properties": { "AliasTarget": { "MarkdownDocumentation": "`AliasTarget`\n\n*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that\nyou want to route traffic to.\nIf you're creating resource records sets for a private hosted zone, note the\nfollowing:\n* You can't create an alias resource record set in a private hosted zone to\n route traffic to a CloudFront distribution.\n* For information about creating failover resource record sets in a private\n 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\n *Amazon Route 53 Developer Guide*.\n*Required*: No\n*Type*: [AliasTarget](./aws-properties-route53-recordset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget", "Required": false, "Type": "AliasTarget", "UpdateType": "Mutable" }, "CidrRoutingConfig": { "MarkdownDocumentation": "`CidrRoutingConfig`\n\nThe object that is specified in resource record set object when you are linking a\nresource record set to a CIDR location.\nA `LocationName` with an asterisk \u201c\\*\u201d can be used to create a default CIDR\nrecord. `CollectionId` is still required for default record.\n*Required*: No\n*Type*: [CidrRoutingConfig](./aws-properties-route53-recordset-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-cidrroutingconfig", "Required": false, "Type": "CidrRoutingConfig", "UpdateType": "Mutable" }, "Comment": { "MarkdownDocumentation": "`Comment`\n\n*Optional:* Any comments you want to include about a change batch\nrequest.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Failover": { "MarkdownDocumentation": "`Failover`\n\n*Failover resource record sets only:* To configure failover, you\nadd the `Failover` element to two resource record sets. For one resource\nrecord set, you specify `PRIMARY` as the value for `Failover`; for\nthe other resource record set, you specify `SECONDARY`. In addition, you\ninclude the `HealthCheckId` element and specify the health check that you\nwant Amazon Route 53 to perform for each resource record set.\nExcept where noted, the following failover behaviors assume that you have included the\n`HealthCheckId` element in both resource record sets:\n* When the primary resource record set is healthy, Route 53 responds to DNS\n queries with the applicable value from the primary resource record set\n regardless of the health of the secondary resource record set.\n* When the primary resource record set is unhealthy and the secondary resource\n record set is healthy, Route 53 responds to DNS queries with the applicable\n value from the secondary resource record set.\n* When the secondary resource record set is unhealthy, Route 53 responds to DNS\n queries with the applicable value from the primary resource record set\n regardless of the health of the primary resource record set.\n* If you omit the `HealthCheckId` element for the secondary resource\n record set, and if the primary resource record set is unhealthy, Route 53 always\n responds to DNS queries with the applicable value from the secondary resource\n record set. This is true regardless of the health of the associated\n endpoint.\nYou can't create non-failover resource record sets that have the same values for the\n`Name` and `Type` elements as failover resource record\nsets.\nFor failover alias resource record sets, you must also include the\n`EvaluateTargetHealth` element and set the value to true.\nFor more information about configuring failover for Route 53, see the following topics\nin the *Amazon Route 53 Developer Guide*:\n* [Route 53 Health Checks\n 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)", "RefReturnValue": "", "AllowedValues": [ "PRIMARY", "SECONDARY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "GeoLocation": { "MarkdownDocumentation": "`GeoLocation`\n\n*Geolocation resource record sets only:* A complex type that lets you\ncontrol how Amazon Route 53 responds to DNS queries based on the geographic origin of\nthe query. For example, if you want all queries from Africa to be routed to a web server\nwith an IP address of `192.0.2.111`, create a resource record set with a\n`Type` of `A` and a `ContinentCode` of\n`AF`.\nIf you create separate resource record sets for overlapping geographic regions (for\nexample, one resource record set for a continent and one for a country on the same\ncontinent), priority goes to the smallest geographic region. This allows you to route\nmost queries for a continent to one resource and to route queries for a country on that\ncontinent to a different resource.\nYou can't create two geolocation resource record sets that specify the same geographic\nlocation.\nThe value `*` in the `CountryCode` element matches all\ngeographic locations that aren't specified in other geolocation resource record sets\nthat have the same values for the `Name` and `Type`\nelements.\n###### Important\nGeolocation works by mapping IP addresses to locations. However, some IP addresses\naren't mapped to geographic locations, so even if you create geolocation resource\nrecord sets that cover all seven continents, Route 53 will receive some DNS queries\nfrom locations that it can't identify. We recommend that you create a resource\nrecord set for which the value of `CountryCode` is `*`. Two\ngroups of queries are routed to the resource that you specify in this record:\nqueries that come from locations for which you haven't created geolocation resource\nrecord sets and queries from IP addresses that aren't mapped to a location. If you\ndon't create a `*` resource record set, Route 53 returns a \"no answer\"\nresponse for queries from those locations.\nYou can't create non-geolocation resource record sets that have the same values for\nthe `Name` and `Type` elements as geolocation resource record\nsets.\n*Required*: No\n*Type*: [GeoLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation", "Required": false, "Type": "GeoLocation", "UpdateType": "Mutable" }, "GeoProximityLocation": { "MarkdownDocumentation": "`GeoProximityLocation`\n\n *GeoproximityLocation resource record sets only:* A complex type that lets you control how\nRoute\u00a053 responds to DNS queries based on the geographic origin of the\nquery and your resources.\n*Required*: No\n*Type*: [GeoProximityLocation](./aws-properties-route53-recordset-geoproximitylocation.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geoproximitylocation", "Required": false, "Type": "GeoProximityLocation", "UpdateType": "Mutable" }, "HealthCheckId": { "MarkdownDocumentation": "`HealthCheckId`\n\nIf you want Amazon Route 53 to return this resource record set in response to a DNS\nquery only when the status of a health check is healthy, include the\n`HealthCheckId` element and specify the ID of the applicable health\ncheck.\nRoute 53 determines whether a resource record set is healthy based on one of the\nfollowing:\n* By periodically sending a request to the endpoint that is specified in the\n health check\n* By aggregating the status of a specified group of health checks (calculated\n health checks)\n* By determining the current state of a CloudWatch alarm (CloudWatch metric\n health checks)\n###### Important\nRoute 53 doesn't check the health of the endpoint that is specified in the\nresource record set, for example, the endpoint specified by the IP address in the\n`Value` element. When you add a `HealthCheckId` element to\na resource record set, Route 53 checks the health of the endpoint that you specified\nin the health check.\nFor more information, see the following topics in the *Amazon Route 53\nDeveloper Guide*:\n* [How Amazon Route 53 Determines Whether an Endpoint Is\n Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)\n* [Route 53 Health Checks\n 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\nchoosing between two or more resource record sets to respond to a DNS query, and you\nwant Route 53 to base the choice in part on the status of a health check. Configuring\nhealth checks makes sense only in the following configurations:\n* **Non-alias resource record sets**: You're\n checking the health of a group of non-alias resource record sets that have the\n same routing policy, name, and type (such as multiple weighted records named\n www.example.com with a type of A) and you specify health check IDs for all the\n resource record sets.\n \n If the health check status for a resource record set is healthy, Route 53\n includes the record among the records that it responds to DNS queries\n with.\n \n If the health check status for a resource record set is unhealthy, Route 53\n stops responding to DNS queries using the value for that resource record\n set.\n \n If the health check status for all resource record sets in the group is\n unhealthy, Route 53 considers all resource record sets in the group healthy and\n responds to DNS queries accordingly.\n* **Alias resource record sets**: You specify the\n following settings:\n \n + You set `EvaluateTargetHealth` to true for an alias\n resource record set in a group of resource record sets that have the\n same routing policy, name, and type (such as multiple weighted records\n named www.example.com with a type of A).\n + You configure the alias resource record set to route traffic to a\n non-alias resource record set in the same hosted zone.\n + You specify a health check ID for the non-alias resource record set.\n \n If the health check status is healthy, Route 53 considers the alias resource\n record set to be healthy and includes the alias record among the records that it\n responds to DNS queries with.\n \n If the health check status is unhealthy, Route 53 stops responding to DNS\n queries using the alias resource record set.\n \n ###### Note\n \n The alias resource record set can also route traffic to a\n *group* of non-alias resource record sets that have\n the same routing policy, name, and type. In that configuration, associate\n health checks with all of the resource record sets in the group of non-alias\n resource record sets.\n**Geolocation Routing**\nFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\na resource record set for the larger, associated geographic region. For example, suppose\nyou have resource record sets for a state in the United States, for the entire United\nStates, for North America, and a resource record set that has `*` for\n`CountryCode` is `*`, which applies to all locations. If the\nendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\nresource record sets in the following order until it finds a resource record set for\nwhich the endpoint is healthy:\n* The United States\n* North America\n* The default resource record set\n**Specifying the Health Check Endpoint by Domain\nName**\nIf your health checks specify the endpoint only by domain name, we recommend that you\ncreate a separate health check for each endpoint. For example, create a health check for\neach `HTTP` server that is serving content for `www.example.com`.\nFor the value of `FullyQualifiedDomainName`, specify the domain name of the\nserver (such as `us-east-2-www.example.com`), not the name of the resource\nrecord sets (`www.example.com`).\n###### Important\nHealth check results will be unpredictable if you do the following:\n* Create a health check that has the same value for\n `FullyQualifiedDomainName` as the name of a resource record\n set.\n* Associate that health check with the resource record set.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nThe 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\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "HostedZoneName": { "MarkdownDocumentation": "`HostedZoneName`\n\nThe 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\nthe `HostedZoneName`.\nWhen you create a stack using an AWS::Route53::RecordSet that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone\nwhose name matches the HostedZoneName. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one\nhosted 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\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "MultiValueAnswer": { "MarkdownDocumentation": "`MultiValueAnswer`\n\n*Multivalue answer resource record sets only*: To route traffic\napproximately randomly to multiple resources, such as web servers, create one multivalue\nanswer record for each resource and specify `true` for\n`MultiValueAnswer`. Note the following:\n* If you associate a health check with a multivalue answer resource record set,\n Amazon Route 53 responds to DNS queries with the corresponding IP address only\n when the health check is healthy.\n* If you don't associate a health check with a multivalue answer record, Route\n 53 always considers the record to be healthy.\n* Route 53 responds to DNS queries with up to eight healthy records; if you have\n eight or fewer healthy records, Route 53 responds to all DNS queries with all\n the healthy records.\n* If you have more than eight healthy records, Route 53 responds to different\n DNS resolvers with different combinations of healthy records.\n* When all records are unhealthy, Route 53 responds to DNS queries with up to\n eight unhealthy records.\n* If a resource becomes unavailable after a resolver caches a response, client\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the record that you want to create, update, or delete.\nEnter a fully qualified domain name, for example, `www.example.com`. You\ncan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\nassumes that the domain name that you specify is fully qualified. This means that Route\n53 treats `www.example.com` (without a trailing dot) and\n`www.example.com.` (with a trailing dot) as identical.\nFor information about how to specify characters other than `a-z`,\n`0-9`, and `-` (hyphen) and how to specify internationalized\ndomain names, see [DNS Domain Name\nFormat](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,\nfor example, `*.example.com`. Note the following:\n* The \\* must replace the entire label. For example, you can't specify\n `*prod.example.com` or `prod*.example.com`.\n* The \\* can't replace any of the middle labels, for example,\n marketing.\\*.example.com.\n* If you include \\* in any position other than the leftmost label in a domain\n name, DNS treats it as an \\* character (ASCII 42), not as a wildcard.\n \n ###### Important\n \n You can't use the \\* wildcard for resource records sets that have a type of\n NS.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Region": { "MarkdownDocumentation": "`Region`\n\n*Latency-based resource record sets only:* The Amazon EC2 Region\nwhere you created the resource that this resource record set refers to. The resource\ntypically is an AWS resource, such as an EC2 instance or an ELB load\nbalancer, and is referred to by an IP address or a DNS domain name, depending on the\nrecord type.\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you\nhave created latency resource record sets, Route 53 selects the latency resource record\nset that has the lowest latency between the end user and the associated Amazon EC2\nRegion. Route 53 then returns the value that is associated with the selected resource\nrecord set.\nNote the following:\n* You can only specify one `ResourceRecord` per latency resource\n record set.\n* You can only create one latency resource record set for each Amazon EC2\n Region.\n* You aren't required to create latency resource record sets for all Amazon EC2\n Regions. Route 53 will choose the region with the best latency from among the\n regions that you create latency resource record sets for.\n* You can't create non-latency resource record sets that have the same values\n for the `Name` and `Type` elements as latency resource\n record sets.\n*Required*: No\n*Type*: String\n*Allowed values*: `us-east-1 | us-east-2 | us-...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-central-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "eu-north-1", "sa-east-1", "cn-north-1", "cn-northwest-1", "ap-east-1", "me-south-1", "me-central-1", "ap-south-1", "ap-south-2", "af-south-1", "eu-south-1", "eu-south-2", "ap-southeast-4", "il-central-1", "ca-west-1", "ap-southeast-5", "mx-central-1", "ap-southeast-7", "us-gov-east-1", "us-gov-west-1", "ap-east-2", "ap-southeast-6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "ResourceRecords": { "MarkdownDocumentation": "`ResourceRecords`\n\nOne or more values that correspond with the value that you specified for the `Type` property. For example, if you specified\n`A` for `Type`, you specify one or more IP addresses in IPv4 format for `ResourceRecords`.\nFor information about the format of values for each record type, see\n[Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html)\nin 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords", "DuplicatesAllowed": true, "PrimitiveItemType": "String", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "SetIdentifier": { "MarkdownDocumentation": "`SetIdentifier`\n\n*Resource record sets that have a routing policy other than\nsimple:* An identifier that differentiates among multiple resource record\nsets that have the same combination of name and type, such as multiple weighted resource\nrecord sets named acme.example.com that have a type of A. In a group of resource record\nsets that have the same name and type, the value of `SetIdentifier` must be\nunique for each resource record set.\nFor information about routing policies, see [Choosing a Routing\nPolicy](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "TTL": { "MarkdownDocumentation": "`TTL`\n\nThe 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\n `TTL`. Amazon Route 53 uses the value of `TTL` for the\n alias target.\n* If you're associating this resource record set with a health check (if you're\n adding a `HealthCheckId` element), we recommend that you specify a\n `TTL` of 60 seconds or less so clients respond quickly to changes\n in health status.\n* All of the resource record sets in a group of weighted resource record sets\n must have the same value for `TTL`.\n* If a group of weighted resource record sets includes one or more weighted\n alias resource record sets for which the alias target is an ELB load balancer,\n we recommend that you specify a `TTL` of 60 seconds for all of the\n non-alias weighted resource record sets that have the same name and type. Values\n other than 60 seconds (the TTL for load balancers) will change the effect of the\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe DNS record type. For information about different record types and how data is\nencoded for them, see [Supported DNS Resource\nRecord Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer\nGuide*.\nValid values for basic resource record sets: `A` | `AAAA` |\n`CAA` | `CNAME` | `DS` |`MX` |\n`NAPTR` | `NS` | `PTR` | `SOA` |\n`SPF` | `SRV` | `TXT`| `TLSA`| `SSHFP`| `SVCB`| `HTTPS`\nValues for weighted, latency, geolocation, and failover resource record sets: `A`\n| `AAAA` | `CAA` | `CNAME` | `MX` |\n`NAPTR` | `PTR` | `SPF` | `SRV` |\n`TXT`| `TLSA`| `SSHFP`| `SVCB`|\n`HTTPS`. When creating a group of weighted, latency, geolocation, or\nfailover resource record sets, specify the same value for all of the resource record\nsets in the group.\nValid values for multivalue answer resource record sets: `A` |\n`AAAA` | `MX` | `NAPTR` | `PTR` |\n`SPF` | `SRV` | `TXT`| `CAA`| `TLSA`| `SSHFP`| `SVCB`| `HTTPS`\n###### Note\nSPF records were formerly used to verify the identity of the sender of email\nmessages. However, we no longer recommend that you create resource record sets for\nwhich the value of `Type` is `SPF`. RFC 7208, *Sender\nPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n1*, has been updated to say, \"...[I]ts existence and mechanism defined\nin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\nlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n7208, see section 14.1, [The SPF DNS Record Type](http://tools.ietf.org/html/rfc7208#section-14.1).\nValues for alias resource record sets:\n* **Amazon API Gateway custom regional APIs and\n edge-optimized APIs:**\n `A`\n* **CloudFront distributions:**\n `A`\n \n If IPv6 is enabled for the distribution, create two resource record sets to\n route traffic to your distribution, one with a value of `A` and one\n with a value of `AAAA`.\n* **Amazon API Gateway environment that has a regionalized\n subdomain**: `A`\n* **ELB load balancers:**`A` | `AAAA`\n* **Amazon S3 buckets:**\n `A`\n* **Amazon Virtual Private Cloud interface VPC\n endpoints**\n `A`\n* **Another resource record set in this hosted\n zone:** Specify the type of the resource record set that you're\n creating the alias for. All values are supported except `NS` and\n `SOA`.\n \n ###### Note\n \n If you're creating an alias record that has the same name as the hosted\n zone (known as the zone apex), you can't route traffic to a record for which\n the value of `Type` is `CNAME`. This is because the\n alias record must have the same type as the record you're routing traffic\n to, and creating a CNAME record for the zone apex isn't supported even for\n an alias record.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SOA | A | TXT | NS | CNAME ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "NAPTR", "PTR", "SRV", "SPF", "AAAA", "CAA", "DS", "TLSA", "SSHFP", "SVCB", "HTTPS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type", "PrimitiveType": "String", "Required": true, "UpdateType": "Mutable" }, "Weight": { "MarkdownDocumentation": "`Weight`\n\n*Weighted resource record sets only:* Among resource record sets\nthat have the same combination of DNS name and type, a value that determines the\nproportion of DNS queries that Amazon Route 53 responds to using the current resource\nrecord set. Route 53 calculates the sum of the weights for the resource record sets that\nhave the same combination of DNS name and type. Route 53 then responds to queries based\non 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\n weighted resource record set.\n* You can only specify one `ResourceRecord` per weighted resource\n record set.\n* You can't create latency, failover, or geolocation resource record sets that\n have the same values for the `Name` and `Type` elements as\n weighted resource record sets.\n* You can create a maximum of 100 weighted resource record sets that have the\n same values for the `Name` and `Type` elements.\n* For weighted (but not weighted alias) resource record sets, if you set\n `Weight` to `0` for a resource record set, Route 53\n never responds to queries with the applicable value for that resource record\n set. However, if you set `Weight` to `0` for all resource\n record sets that have the same combination of DNS name and type, traffic is\n routed to all resources with equal probability.\n \n The effect of setting `Weight` to `0` is different when\n you associate health checks with weighted resource record sets. For more\n information, see [Options for Configuring Route 53 Active-Active and Active-Passive\n Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) in the *Amazon Route 53 Developer\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight", "PrimitiveType": "Integer", "Required": false, "UpdateType": "Mutable" } } }, "AWS::Route53::RecordSetGroup": { "MarkdownDocumentation": "`AWS::Route53::RecordSetGroup`\n\nA complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in,\nand values for the records that you want to create.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the record set group, for example, `MyRecordSetGroup`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html", "Properties": { "Comment": { "MarkdownDocumentation": "`Comment`\n\n*Optional:* Any comments you want to include about a change batch\nrequest.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" }, "HostedZoneId": { "MarkdownDocumentation": "`HostedZoneId`\n\nThe 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\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "HostedZoneName": { "MarkdownDocumentation": "`HostedZoneName`\n\nThe 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\nof the `HostedZoneName`.\nWhen you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName`,\nAWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName`. If AWS CloudFormation\ncan't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name,\nAWS CloudFormation will not create the stack.\nSpecify either `HostedZoneName` or `HostedZoneId`, but not both. If you have multiple hosted zones\nwith 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename", "PrimitiveType": "String", "Required": false, "UpdateType": "Immutable" }, "RecordSets": { "MarkdownDocumentation": "`RecordSets`\n\nA complex type that contains one `RecordSet` element for each record that you want to create.\n*Required*: No\n*Type*: Array of [RecordSet](./aws-properties-route53-recordsetgroup-recordset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets", "DuplicatesAllowed": false, "ItemType": "RecordSet", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::Route53Profiles::Profile": { "MarkdownDocumentation": "`AWS::Route53Profiles::Profile`\n\nA complex type that includes settings for a Route 53 Profile.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`Profile` ID for the profile, such as `rp-9e6daa461example`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profile.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of the tag keys and values that you want to associate with the profile.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53profiles-profile-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profile.html#cfn-route53profiles-profile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the Profile.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profile.html#cfn-route53profiles-profile-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ShareStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ShareStatus`\n\nSharing status for the Profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profile.html#ShareStatus-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nID of the Profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profile.html#Id-fn::getatt" }, "ClientToken": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClientToken`\n\nThe `ClientToken` value that was assigned when the Profile was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profile.html#ClientToken-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the Profile.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profile.html#Arn-fn::getatt" } } }, "AWS::Route53Profiles::ProfileAssociation": { "MarkdownDocumentation": "`AWS::Route53Profiles::ProfileAssociation`\n\nAn association between a Route 53 Profile and a VPC.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`ProfileAssociation` ID for the profile association to a VPC, such as `rpassoc-a6d96d8cexample4`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileassociation.html", "Properties": { "ProfileId": { "MarkdownDocumentation": "`ProfileId`\n\nID of the Profile.\nUpdate to this property requires update to the `ResourceId` property as well,\nbecause you can only associate one Profile per VPC. For more information, see [Route 53\nProfiles](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/profiles.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileassociation.html#cfn-route53profiles-profileassociation-profileid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the VPC.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileassociation.html#cfn-route53profiles-profileassociation-resourceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Arn": { "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the profile association to a 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileassociation.html#cfn-route53profiles-profileassociation-arn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53profiles-profileassociation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileassociation.html#cfn-route53profiles-profileassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the Profile association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileassociation.html#cfn-route53profiles-profileassociation-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nID of the Profile association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileassociation.html#Id-fn::getatt" } } }, "AWS::Route53Profiles::ProfileResourceAssociation": { "MarkdownDocumentation": "`AWS::Route53Profiles::ProfileResourceAssociation`\n\nThe association between a Route 53 Profile and resources.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`ProfileResourceAssociation` ID for the profile resource association, such as `rpr-001ba2563f9example6`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileresourceassociation.html", "Properties": { "ProfileId": { "MarkdownDocumentation": "`ProfileId`\n\nProfile ID of the Profile that the resources are associated with.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileresourceassociation.html#cfn-route53profiles-profileresourceassociation-profileid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the resource association.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileresourceassociation.html#cfn-route53profiles-profileresourceassociation-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceProperties": { "MarkdownDocumentation": "`ResourceProperties`\n\nIf the DNS resource is a DNS Firewall rule group, this indicates the priority.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileresourceassociation.html#cfn-route53profiles-profileresourceassociation-resourceproperties", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the Profile resource association.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileresourceassociation.html#cfn-route53profiles-profileresourceassociation-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ResourceType": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceType`\n\nResource type, such as a private hosted zone, interface VPC endpoint, or DNS Firewall rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileresourceassociation.html#ResourceType-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nID of the Profile resource association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53profiles-profileresourceassociation.html#Id-fn::getatt" } } }, "AWS::Route53Resolver::FirewallDomainList": { "MarkdownDocumentation": "`AWS::Route53Resolver::FirewallDomainList`\n\nHigh-level information about a list of firewall domains for use in a [AWS::Route53Resolver::FirewallRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-rule.html). This is returned by [GetFirewallDomainList](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetFirewallDomainList.html).\nTo retrieve the domains that are defined for this domain list, call\n[ListFirewallDomains](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListFirewallDomains.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `FirewallDomainList` object.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html", "Properties": { "Domains": { "MarkdownDocumentation": "`Domains`\n\nA list of the domain lists that you have defined.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#cfn-route53resolver-firewalldomainlist-domains", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "DomainFileUrl": { "MarkdownDocumentation": "`DomainFileUrl`\n\nThe fully qualified URL or URI of the file stored in Amazon Simple Storage Service\n(Amazon S3) that contains the list of domains to import.\nThe file must be in an S3 bucket that's in the same Region\nas your DNS Firewall. The file must be a text file and must contain a single domain per line.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#cfn-route53resolver-firewalldomainlist-domainfileurl", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of the tag keys and values that you want to associate with the domain list.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53resolver-firewalldomainlist-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#cfn-route53resolver-firewalldomainlist-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the domain list.\n*Required*: No\n*Type*: String\n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#cfn-route53resolver-firewalldomainlist-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the domain list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#Status-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#CreationTime-fn::getatt" }, "ManagedOwnerName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ManagedOwnerName`\n\nThe owner of the list, used only for lists that are not managed by you.\nFor example, the managed domain list\n`AWSManagedDomainsMalwareDomainList` has\nthe managed owner name `Route 53 Resolver DNS Firewall`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#ManagedOwnerName-fn::getatt" }, "ModificationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModificationTime`\n\nThe date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#ModificationTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the domain list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the firewall domain list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#Arn-fn::getatt" }, "CreatorRequestId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatorRequestId`\n\nA unique string defined by you to identify the request. This allows you to\nretry failed requests without the risk of running the operation twice. This can be any\nunique string, for example, a timestamp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#CreatorRequestId-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nAdditional information about the status of the list, if available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#StatusMessage-fn::getatt" }, "DomainCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`DomainCount`\n\nThe number of domain names that are specified in the domain list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewalldomainlist.html#DomainCount-fn::getatt" } } }, "AWS::Route53Resolver::FirewallRuleGroup": { "MarkdownDocumentation": "`AWS::Route53Resolver::FirewallRuleGroup`\n\nHigh-level information for a firewall rule group. A firewall\nrule group is a collection of rules that DNS Firewall uses to filter DNS network traffic for a VPC. To retrieve the rules for the rule group, call\n[ListFirewallRules](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListFirewallRules.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returnsthe `FirewallRuleGroupId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html", "Properties": { "FirewallRules": { "MarkdownDocumentation": "`FirewallRules`\n\nA list of the rules that you have defined.\n*Required*: No\n*Type*: Array of [FirewallRule](./aws-properties-route53resolver-firewallrulegroup-firewallrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#cfn-route53resolver-firewallrulegroup-firewallrules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FirewallRule", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of the tag keys and values that you want to associate with the rule group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53resolver-firewallrulegroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#cfn-route53resolver-firewallrulegroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule group.\n*Required*: No\n*Type*: String\n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#cfn-route53resolver-firewallrulegroup-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "RuleCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`RuleCount`\n\nThe number of rules in the rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#RuleCount-fn::getatt" }, "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the domain list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#Status-fn::getatt" }, "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe AWS account ID for the account that created the rule group. When a rule group is\nshared with your account, this is the account that has shared the rule group with you.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#OwnerId-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#CreationTime-fn::getatt" }, "ShareStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ShareStatus`\n\nWhether the rule group is shared with other AWS accounts, or was shared with the current account by\nanother AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#ShareStatus-fn::getatt" }, "ModificationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModificationTime`\n\nThe date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#ModificationTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN (Amazon Resource Name) of the rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#Arn-fn::getatt" }, "CreatorRequestId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatorRequestId`\n\nA unique string defined by you to identify the request. This allows you to\nretry failed requests without the risk of running the operation twice. This can be any\nunique string, for example, a timestamp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#CreatorRequestId-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nAdditional information about the status of the rule group, if available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroup.html#StatusMessage-fn::getatt" } } }, "AWS::Route53Resolver::FirewallRuleGroupAssociation": { "MarkdownDocumentation": "`AWS::Route53Resolver::FirewallRuleGroupAssociation`\n\nAn association between a firewall rule group and a VPC, which enables DNS filtering for\nthe VPC.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `FirewallRuleGroupAssociation` ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html", "Properties": { "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe unique identifier of the VPC that is associated with the rule group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#cfn-route53resolver-firewallrulegroupassociation-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FirewallRuleGroupId": { "MarkdownDocumentation": "`FirewallRuleGroupId`\n\nThe unique identifier of the firewall rule group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#cfn-route53resolver-firewallrulegroupassociation-firewallrulegroupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall\nfilters VPC traffic starting from rule group with the lowest numeric priority setting.\nYou must specify a unique priority for each rule group that you associate with a single VPC.\nTo make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on.\nYou can change the priority setting for a rule group association after you create it.\nThe allowed values for `Priority` are between 100 and 9900 (excluding 100 and 9900).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#cfn-route53resolver-firewallrulegroupassociation-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "MutationProtection": { "MarkdownDocumentation": "`MutationProtection`\n\nIf enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#cfn-route53resolver-firewallrulegroupassociation-mutationprotection", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of the tag keys and values that you want to associate with the rule group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53resolver-firewallrulegroupassociation-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#cfn-route53resolver-firewallrulegroupassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the association.\n*Required*: No\n*Type*: String\n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#cfn-route53resolver-firewallrulegroupassociation-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#Status-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe date and time that the association was created, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#CreationTime-fn::getatt" }, "ManagedOwnerName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ManagedOwnerName`\n\nThe owner of the association, used only for associations that are not managed by\nyou. If you use AWS Firewall Manager to manage your firewallls from DNS Firewall, then\nthis reports Firewall Manager as the managed owner.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#ManagedOwnerName-fn::getatt" }, "ModificationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModificationTime`\n\nThe date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#ModificationTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe identifier for the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the firewall rule group association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#Arn-fn::getatt" }, "CreatorRequestId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatorRequestId`\n\nA unique string defined by you to identify the request. This allows you to\nretry failed requests without the risk of running the operation twice. This can be any\nunique string, for example, a timestamp.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#CreatorRequestId-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nAdditional information about the status of the response, if available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-firewallrulegroupassociation.html#StatusMessage-fn::getatt" } } }, "AWS::Route53Resolver::OutpostResolver": { "MarkdownDocumentation": "`AWS::Route53Resolver::OutpostResolver`\n\nCreates a Amazon Route\u00a053 Resolver on an Outpost.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns returns the `Id` of the Outpost Resolver.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html", "Properties": { "InstanceCount": { "MarkdownDocumentation": "`InstanceCount`\n\nAmazon EC2 instance count for the Resolver on the Outpost.\n*Required*: No\n*Type*: Integer\n*Minimum*: `4`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#cfn-route53resolver-outpostresolver-instancecount", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "OutpostArn": { "MarkdownDocumentation": "`OutpostArn`\n\nThe ARN (Amazon Resource Name) for the Outpost.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#cfn-route53resolver-outpostresolver-outpostarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PreferredInstanceType": { "MarkdownDocumentation": "`PreferredInstanceType`\n\nThe Amazon EC2 instance type. If you specify this, you must also specify a value for the `OutpostArn`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#cfn-route53resolver-outpostresolver-preferredinstancetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA key value pair that helps you identify a Route\u00a053 Resolver.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53resolver-outpostresolver-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#cfn-route53resolver-outpostresolver-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nName of the Resolver.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#cfn-route53resolver-outpostresolver-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nStatus of the Resolver.\nValid Values: CREATING | OPERATIONAL | UPDATING | DELETING | ACTION\\_NEEDED | FAILED\\_CREATION | FAILED\\_DELETION.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#Status-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#CreationTime-fn::getatt" }, "ModificationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModificationTime`\n\nThe date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#ModificationTime-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the Resolver on Outpost.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN (Amazon Resource Name) for the Resolver on an Outpost.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#Arn-fn::getatt" }, "CreatorRequestId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatorRequestId`\n\nA unique string that identifies the request that created the Resolver endpoint.\nThe `CreatorRequestId` allows failed requests to be retried without the risk of running the operation twice.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#CreatorRequestId-fn::getatt" }, "StatusMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`StatusMessage`\n\nA detailed description of the Resolver.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-outpostresolver.html#StatusMessage-fn::getatt" } } }, "AWS::Route53Resolver::ResolverConfig": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverConfig`\n\nA complex type that contains information about a Resolver configuration for a VPC.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ResolverConfiguration` ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverconfig.html", "Properties": { "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the Amazon Virtual Private Cloud VPC or a Route 53 Profile that you're configuring Resolver for.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverconfig.html#cfn-route53resolver-resolverconfig-resourceid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AutodefinedReverseFlag": { "MarkdownDocumentation": "`AutodefinedReverseFlag`\n\nRepresents the desired status of `AutodefinedReverse`. The only supported value on creation is `DISABLE`.\nDeletion of this resource will return `AutodefinedReverse` to its default value of `ENABLED`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `DISABLE`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "DISABLE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverconfig.html#cfn-route53resolver-resolverconfig-autodefinedreverseflag", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe owner account ID of the Amazon Virtual Private Cloud VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverconfig.html#OwnerId-fn::getatt" }, "AutodefinedReverse": { "PrimitiveType": "String", "MarkdownDocumentation": "`AutodefinedReverse`\n\nThe status of whether or not the Route\u00a053 Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverconfig.html#AutodefinedReverse-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nID for the Route\u00a053 Resolver configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverconfig.html#Id-fn::getatt" } } }, "AWS::Route53Resolver::ResolverDNSSECConfig": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverDNSSECConfig`\n\nThe `AWS::Route53Resolver::ResolverDNSSECConfig` resource is a complex type that contains information about a configuration for DNSSEC validation.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID. For example:\n`{ \"Ref\": \"rdsc-689d45d1ae623bf3\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverdnssecconfig.html", "Properties": { "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the virtual private cloud (VPC) that you're configuring the DNSSEC validation status for.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverdnssecconfig.html#cfn-route53resolver-resolverdnssecconfig-resourceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ValidationStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ValidationStatus`\n\nThe current status of this `ResolverDNSSECConfig` resource. For example: `Enabled`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverdnssecconfig.html#ValidationStatus-fn::getatt" }, "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe AWS account of the owner. For example: `111122223333`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverdnssecconfig.html#OwnerId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe primary identifier of this `ResolverDNSSECConfig` resource. For example: `rdsc-689d45d1ae623bf3`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverdnssecconfig.html#Id-fn::getatt" } } }, "AWS::Route53Resolver::ResolverEndpoint": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverEndpoint`\n\nCreates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:\n* An *inbound Resolver endpoint* forwards DNS queries to the DNS service for a VPC\n from your network.\n* An *outbound Resolver endpoint* forwards DNS queries from the DNS service for a VPC\n to your network.\n###### Important\n* You cannot update `ResolverEndpointType` and `IpAddresses` in the same request.\n* When you update a dual-stack IP address, you must update both IP addresses. You can\u2019t update only an IPv4 or IPv6 and keep an existing IP address.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ResolverEndpoint` object.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html", "Properties": { "IpAddresses": { "MarkdownDocumentation": "`IpAddresses`\n\nThe subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward\nDNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.\n###### Note\nEven though the minimum is 1, Route\u00a053 requires that you create at least two.\n*Required*: Yes\n*Type*: Array of [IpAddressRequest](./aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html)\n*Minimum*: `2`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-ipaddresses", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "IpAddressRequest", "DuplicatesAllowed": true }, "Protocols": { "MarkdownDocumentation": "`Protocols`\n\nProtocols used for the endpoint. DoH-FIPS is applicable for a default inbound endpoints only.\nFor an inbound endpoint you can apply the protocols as follows:\n* Do53 and DoH in combination.\n* Do53 and DoH-FIPS in combination.\n* Do53 alone.\n* DoH alone.\n* DoH-FIPS alone.\n* None, which is treated as Do53.\nFor a delegation inbound endpoint you can use Do53 only.\nFor an outbound endpoint you can apply the protocols as follows:\n* Do53 and DoH in combination.\n* Do53 alone.\n* DoH alone.\n* None, which is treated as Do53.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-protocols", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "TargetNameServerMetricsEnabled": { "MarkdownDocumentation": "`TargetNameServerMetricsEnabled`\n\nIndicates whether target name server metrics are enabled for the outbound Resolver endpoint.\nWhen enabled, one-minute granular metrics are published in CloudWatch for each target name server associated with this endpoint.\nWhen disabled, these metrics are not published. This feature is not supported for inbound Resolver 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-targetnameservermetricsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RniEnhancedMetricsEnabled": { "MarkdownDocumentation": "`RniEnhancedMetricsEnabled`\n\nIndicates whether RNI enhanced metrics are enabled for the Resolver endpoint.\nWhen enabled, one-minute granular metrics are published in CloudWatch for each RNI associated with this endpoint.\nWhen disabled, these metrics are not published.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-rnienhancedmetricsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "OutpostArn": { "MarkdownDocumentation": "`OutpostArn`\n\nThe ARN (Amazon Resource Name) for the Outpost.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-outpostarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PreferredInstanceType": { "MarkdownDocumentation": "`PreferredInstanceType`\n\nThe Amazon EC2 instance type.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-preferredinstancetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResolverEndpointType": { "MarkdownDocumentation": "`ResolverEndpointType`\n\nThe Resolver endpoint IP address type.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV6 | IPV4 | DUALSTACK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPV6", "IPV4", "DUALSTACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-resolverendpointtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Direction": { "MarkdownDocumentation": "`Direction`\n\nIndicates 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* `INBOUND_DELEGATION`: Resolver delegates queries to Route 53 private hosted zones from your network.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INBOUND | OUTBOUND | INBOUN...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "INBOUND", "OUTBOUND", "INBOUND_DELEGATION" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-direction", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules\n(for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access.\nFor 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*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-securitygroupids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nRoute 53 Resolver doesn't support updating tags through CloudFormation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53resolver-resolverendpoint-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ResolverEndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResolverEndpointId`\n\nThe ID of the resolver endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#ResolverEndpointId-fn::getatt" }, "IpAddressCount": { "PrimitiveType": "String", "MarkdownDocumentation": "`IpAddressCount`\n\nThe number of IP addresses that the resolver endpoint can use for DNS queries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#IpAddressCount-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the resolver endpoint, such as\n`arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#Arn-fn::getatt" }, "Direction": { "PrimitiveType": "String", "MarkdownDocumentation": "`Direction`\n\nIndicates whether the resolver endpoint allows inbound or outbound DNS queries.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#Direction-fn::getatt" }, "HostVPCId": { "PrimitiveType": "String", "MarkdownDocumentation": "`HostVPCId`\n\nThe ID of the VPC that you want to create the resolver endpoint in.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#HostVPCId-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name that you assigned to the resolver endpoint when you created the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#Name-fn::getatt" } } }, "AWS::Route53Resolver::ResolverQueryLoggingConfig": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverQueryLoggingConfig`\n\nThe AWS::Route53Resolver::ResolverQueryLoggingConfig resource is a complex type that contains settings for one query logging configuration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the resource that contains settings for one query logging configuration.\nFor example: `{ \"Ref\": \"rqlc-1111222233334444\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html", "Properties": { "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nThe ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or\na Kinesis Data Firehose delivery stream.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `600`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#cfn-route53resolver-resolverqueryloggingconfig-destinationarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53resolver-resolverqueryloggingconfig-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#cfn-route53resolver-resolverqueryloggingconfig-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the query logging configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#cfn-route53resolver-resolverqueryloggingconfig-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the specified query logging configuration. Valid values include the following:\n* `CREATING`: Resolver is creating the query logging configuration.\n* `CREATED`: The query logging configuration was successfully created.\n Resolver is logging queries that originate in the specified VPC.\n* `DELETING`: Resolver is deleting this query logging configuration.\n* `FAILED`: Resolver can't deliver logs to the location that is specified in the query logging configuration.\n Here are two common causes:\n \n + The specified destination (for example, an Amazon S3 bucket) was deleted.\n + Permissions don't allow sending logs to the destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#Status-fn::getatt" }, "OwnerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerId`\n\nThe AWS account ID for the account that created the query logging configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#OwnerId-fn::getatt" }, "AssociationCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`AssociationCount`\n\nThe number of VPCs that are associated with the query logging configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#AssociationCount-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#CreationTime-fn::getatt" }, "ShareStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ShareStatus`\n\nAn indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another\nAWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#ShareStatus-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID for the query logging configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the query logging configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#Arn-fn::getatt" }, "CreatorRequestId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatorRequestId`\n\nA unique string that identifies the request that created the query logging configuration. The `CreatorRequestId` allows failed requests\nto be retried without the risk of running the operation twice.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfig.html#CreatorRequestId-fn::getatt" } } }, "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation`\n\nThe AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation resource is a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the configuration for DNS query logging.\nFor example: `{ \"Ref\": \"rqlca-1111222233334444\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfigassociation.html", "Properties": { "ResourceId": { "MarkdownDocumentation": "`ResourceId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfigassociation.html#cfn-route53resolver-resolverqueryloggingconfigassociation-resourceid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResolverQueryLogConfigId": { "MarkdownDocumentation": "`ResolverQueryLogConfigId`\n\nThe ID of the query logging configuration that a VPC is associated with.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfigassociation.html#cfn-route53resolver-resolverqueryloggingconfigassociation-resolverquerylogconfigid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the specified query logging association. Valid values include the following:\n* `CREATING`: Resolver is creating an association between an Amazon Virtual Private Cloud (Amazon VPC) and a query logging configuration.\n* `CREATED`: The association between an Amazon VPC and a query logging configuration\n was successfully created. Resolver is logging queries that originate in the specified VPC.\n* `DELETING`: Resolver is deleting this query logging association.\n* `FAILED`: Resolver either couldn't create or couldn't delete the query logging association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfigassociation.html#Status-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfigassociation.html#CreationTime-fn::getatt" }, "Error": { "PrimitiveType": "String", "MarkdownDocumentation": "`Error`\n\nIf the value of `Status` is `FAILED`, the value of\n`Error` indicates the cause:\n* `DESTINATION_NOT_FOUND`: The specified destination (for example, an Amazon S3 bucket) was deleted.\n* `ACCESS_DENIED`: Permissions don't allow sending logs to the destination.\nIf the value of `Status` is a value other than `FAILED`, `Error` is null.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfigassociation.html#Error-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the query logging association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfigassociation.html#Id-fn::getatt" }, "ErrorMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ErrorMessage`\n\nContains additional information about the error. If the value or `Error` is null, the value of `ErrorMessage` is also\nnull.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverqueryloggingconfigassociation.html#ErrorMessage-fn::getatt" } } }, "AWS::Route53Resolver::ResolverRule": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverRule`\n\nFor DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through,\none domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ResolverRule` object, which contains detailed information\nabout the rule.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html", "Properties": { "ResolverEndpointId": { "MarkdownDocumentation": "`ResolverEndpointId`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-resolverendpointid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nDNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`. If a query matches\nmultiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name\n(www.example.com).\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-domainname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "RuleType": { "MarkdownDocumentation": "`RuleType`\n\nWhen you want to forward DNS queries for specified domain name to resolvers on your network, specify `FORWARD` or `DELEGATE`.\nIf a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains\nthe most specific domain name (www.example.com).\nWhen you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for\na 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`\nfor `RuleType`. To then have Resolver process queries for apex.example.com, you create a rule and specify\n`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 | SYSTEM | RECURSIV...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "FORWARD", "SYSTEM", "RECURSIVE", "DELEGATE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-ruletype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DelegationRecord": { "MarkdownDocumentation": "`DelegationRecord`\n\nDNS queries with delegation records that point to this domain name are forwarded to resolvers on your network.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-delegationrecord", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags help organize and categorize your Resolver rules. Each tag consists of a key and an optional value, both of which you define.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-route53resolver-resolverrule-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "TargetIps": { "MarkdownDocumentation": "`TargetIps`\n\nAn array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically,\nthese are the IP addresses of DNS resolvers on your network.\n*Required*: No\n*Type*: Array of [TargetAddress](./aws-properties-route53resolver-resolverrule-targetaddress.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-targetips", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TargetAddress", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the Resolver rule, which you specified when you created the Resolver rule.\nThe name can be up to 64 characters long and can contain letters (a-z, A-Z), numbers (0-9), hyphens (-), underscores (\\_), and spaces. The name cannot consist of only numbers.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ResolverEndpointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResolverEndpointId`\n\nThe ID of the outbound endpoint that the rule is associated with, such as `rslvr-out-fdc049932dexample`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#ResolverEndpointId-fn::getatt" }, "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nDNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps.\nIf a query matches multiple resolver rules (example.com and www.example.com), the query is routed\nusing the resolver rule that contains the most specific domain name (www.example.com).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#DomainName-fn::getatt" }, "ResolverRuleId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResolverRuleId`\n\nWhen the value of `RuleType` is `FORWARD`, the ID that Resolver assigned to the resolver rule\nwhen you created it, such as `rslvr-rr-5328a0899aexample`. This value isn't applicable when `RuleType`\nis `SYSTEM`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#ResolverRuleId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the resolver rule, such as `arn:aws:route53resolver:us-east-1:123456789012:resolver-rule/resolver-rule-a1bzhi`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#Arn-fn::getatt" }, "TargetIps": { "Type": "List", "ItemType": "TargetAddress", "MarkdownDocumentation": "`TargetIps`\n\nWhen the value of `RuleType` is `FORWARD`, the IP addresses that the outbound endpoint forwards\nDNS queries to, typically the IP addresses for DNS resolvers on your network. This value isn't applicable when\n`RuleType` is `SYSTEM`.\n`TargetIps` is available only when the value of `RuleType` is `FORWARD`.\nYou should not provide `TargetIps` when the `RuleType` is `DELEGATE`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#TargetIps-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nA friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#Name-fn::getatt" } } }, "AWS::Route53Resolver::ResolverRuleAssociation": { "MarkdownDocumentation": "`AWS::Route53Resolver::ResolverRuleAssociation`\n\nIn the response to an\n[AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html),\n[DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html),\nor\n[ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html)\nrequest, provides information about an association between a resolver rule and a VPC. The association determines which\nDNS queries that originate in the VPC are forwarded to your network.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ResolverRuleAssociationId`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html", "Properties": { "VPCId": { "MarkdownDocumentation": "`VPCId`\n\nThe ID of the VPC that you associated the Resolver rule with.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-vpcid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResolverRuleId": { "MarkdownDocumentation": "`ResolverRuleId`\n\nThe ID of the Resolver rule that you associated with the VPC that is specified by `VPCId`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-resolverruleid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of an association between a Resolver rule and a VPC.\nThe name can be up to 64 characters long and can contain letters (a-z, A-Z), numbers (0-9), hyphens (-), underscores (\\_), and spaces. The name cannot consist of only numbers.\n*Required*: No\n*Type*: String\n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#cfn-route53resolver-resolverruleassociation-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "VPCId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VPCId`\n\nThe ID of the VPC that you associated the resolver rule with, such as `vpc-03cf94c75cexample`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#VPCId-fn::getatt" }, "ResolverRuleId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResolverRuleId`\n\nThe ID of the resolver rule that you associated with the VPC that is specified by `VPCId`,\nsuch as `rslvr-rr-5328a0899example`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#ResolverRuleId-fn::getatt" }, "ResolverRuleAssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResolverRuleAssociationId`\n\nThe ID of the resolver rule association that you want to get information about,\nsuch as `rslvr-rrassoc-97242eaf88example`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#ResolverRuleAssociationId-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of an association between a resolver rule and a VPC, such as `test.example.com in beta VPC`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html#Name-fn::getatt" } } }, "AWS::S3::AccessGrant": { "MarkdownDocumentation": "`AWS::S3::AccessGrant`\n\nThe `AWS::S3::AccessGrant` resource creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the [AWS::S3::AccessGrantsInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html). You must also have registered at least one S3 data location in your S3 Access Grants instance using [AWS::S3::AccessGrantsLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html).\nPermissions\nYou must have the `s3:CreateAccessGrant` permission to use this resource.\n\nAdditional Permissions\nFor any directory identity - `sso:DescribeInstance` and `sso:DescribeApplication`\nFor directory users - `identitystore:DescribeUser`\nFor directory groups - `identitystore:DescribeGroup`\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns some information about your access grant.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html", "Properties": { "Grantee": { "MarkdownDocumentation": "`Grantee`\n\nThe user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to AWSIAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.\n*Required*: Yes\n*Type*: [Grantee](./aws-properties-s3-accessgrant-grantee.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#cfn-s3-accessgrant-grantee", "UpdateType": "Mutable", "Required": true, "Type": "Grantee" }, "AccessGrantsLocationConfiguration": { "MarkdownDocumentation": "`AccessGrantsLocationConfiguration`\n\nThe configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the `S3SubPrefix` field. The grant scope is the result of appending the subprefix to the location scope of the registered location.\n*Required*: No\n*Type*: [AccessGrantsLocationConfiguration](./aws-properties-s3-accessgrant-accessgrantslocationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#cfn-s3-accessgrant-accessgrantslocationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AccessGrantsLocationConfiguration" }, "ApplicationArn": { "MarkdownDocumentation": "`ApplicationArn`\n\nThe Amazon Resource Name (ARN) of an AWSIAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#cfn-s3-accessgrant-applicationarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Permission": { "MarkdownDocumentation": "`Permission`\n\nThe type of access that you are granting to your S3 data, which can be set to one of the following values:\n* `READ` \u2013 Grant read-only access to the S3 data.\n* `WRITE` \u2013 Grant write-only access to the S3 data.\n* `READWRITE` \u2013 Grant both read and write access to the S3 data.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `READ | WRITE | READWRITE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "READ", "WRITE", "READWRITE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#cfn-s3-accessgrant-permission", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "S3PrefixType": { "MarkdownDocumentation": "`S3PrefixType`\n\nThe type of `S3SubPrefix`. The only possible value is `Object`. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.\n*Required*: No\n*Type*: String\n*Allowed values*: `Object`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "Object" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#cfn-s3-accessgrant-s3prefixtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe AWS resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-accessgrant-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#cfn-s3-accessgrant-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "AccessGrantsLocationId": { "MarkdownDocumentation": "`AccessGrantsLocationId`\n\nThe ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID `default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#cfn-s3-accessgrant-accessgrantslocationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "GrantScope": { "PrimitiveType": "String", "MarkdownDocumentation": "`GrantScope`\n\nThe S3 path of the data to which you are granting access. It is the result of appending the `Subprefix` to the location scope.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#GrantScope-fn::getatt" }, "AccessGrantId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccessGrantId`\n\nThe ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#AccessGrantId-fn::getatt" }, "AccessGrantArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccessGrantArn`\n\nThe ARN of the access grant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.html#AccessGrantArn-fn::getatt" } } }, "AWS::S3::AccessGrantsInstance": { "MarkdownDocumentation": "`AWS::S3::AccessGrantsInstance`\n\nThe `AWS::S3::AccessGrantInstance` resource creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account.\nPermissions\nYou must have the `s3:CreateAccessGrantsInstance` permission to use this resource.\n\nAdditional Permissions\nTo associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the `sso:DescribeInstance`, `sso:CreateApplication`, `sso:PutApplicationGrant`, and `sso:PutApplicationAuthenticationMethod` permissions.\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns some information about your S3 Access Grants instance.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html", "Properties": { "IdentityCenterArn": { "MarkdownDocumentation": "`IdentityCenterArn`\n\nIf you would like to associate your S3 Access Grants instance with an AWSIAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the AWSIAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html#cfn-s3-accessgrantsinstance-identitycenterarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe AWS resource tags that you are adding to the S3 Access Grants instance. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-accessgrantsinstance-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html#cfn-s3-accessgrantsinstance-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "AccessGrantsInstanceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccessGrantsInstanceArn`\n\nThe ARN of the S3 Access Grants instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html#AccessGrantsInstanceArn-fn::getatt" }, "AccessGrantsInstanceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccessGrantsInstanceId`\n\nThe ID of the S3 Access Grants instance. The ID is `default`. You can have one S3 Access Grants instance per Region per account.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html#AccessGrantsInstanceId-fn::getatt" } } }, "AWS::S3::AccessGrantsLocation": { "MarkdownDocumentation": "`AWS::S3::AccessGrantsLocation`\n\nThe `AWS::S3::AccessGrantsLocation` resource creates the S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:\n* The default S3 location `s3://`\n* A bucket - `S3://`\n* A bucket and prefix - `S3:///`\nWhen you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role [using a policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-location.html). S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.\nPermissions\nYou must have the `s3:CreateAccessGrantsLocation` permission to use this resource.\n\nAdditional Permissions\nYou must also have the following permission for the specified IAM role: `iam:PassRole`\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns some information about the S3 data location.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html", "Properties": { "LocationScope": { "MarkdownDocumentation": "`LocationScope`\n\nThe S3 URI path to the location that you are registering. The location scope can be the default S3 location `s3://`, the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the `engineering/` prefix or object key names that start with the `marketing/campaigns/` prefix.\n*Required*: Yes\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-locationscope", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IamRoleArn": { "MarkdownDocumentation": "`IamRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-iamrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe AWS resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-accessgrantslocation-tag.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "AccessGrantsLocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccessGrantsLocationArn`\n\nThe ARN of the location you are registering.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#AccessGrantsLocationArn-fn::getatt" }, "AccessGrantsLocationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccessGrantsLocationId`\n\nThe ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID `default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#AccessGrantsLocationId-fn::getatt" } } }, "AWS::S3::AccessPoint": { "MarkdownDocumentation": "`AWS::S3::AccessPoint`\n\nThe AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access\nbuckets.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the access point name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-policy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`PublicAccessBlockConfiguration`\n\nThe PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You\ncan enable the configuration options in any combination. For more information about when\nAmazon 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](./aws-properties-s3-accesspoint-publicaccessblockconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-publicaccessblockconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PublicAccessBlockConfiguration" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the bucket associated with this access point.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BucketAccountId": { "MarkdownDocumentation": "`BucketAccountId`\n\nThe AWS account ID associated with the S3 bucket associated with this\naccess point.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucketaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nThe Virtual Private Cloud (VPC) configuration for this access point, if one exists.\n*Required*: No\n*Type*: [VpcConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-vpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tags that you can apply to access points. Tags are key-value pairs of metadata used to categorize your access points and control access. For more information, see [Using tags for attribute-based access control (ABAC)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#using-tags-for-abac).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-accesspoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of this access point. If you don't specify a name, AWS CloudFormation\ngenerates a unique ID and uses that ID for the access point name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$`\n*Minimum*: `3`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Alias": { "PrimitiveType": "String", "MarkdownDocumentation": "`Alias`\n\nThe alias for this access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#Alias-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThis property contains the details of the ARN for the access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#Arn-fn::getatt" }, "NetworkOrigin": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkOrigin`\n\nIndicates whether this access point allows access from the internet. If\n`VpcConfiguration` is specified for this access point, then\n`NetworkOrigin` is `VPC`, and the access point doesn't allow access\nfrom the internet. Otherwise, `NetworkOrigin` is `Internet`, and the\naccess point allows access from the internet, subject to the access point and bucket access\npolicies.\n*Allowed values*: `VPC` | `Internet...`", "RefReturnValue": "", "AllowedValues": [ "VPC`", "`Internet" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#NetworkOrigin-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of this access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#Name-fn::getatt" } } }, "AWS::S3::Bucket": { "MarkdownDocumentation": "`AWS::S3::Bucket`\n\nThe `AWS::S3::Bucket` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.\nTo control how AWS CloudFormation handles the bucket when the stack is\ndeleted, you can set a deletion policy for your bucket. You can choose to\n*retain* the bucket or to *delete* the bucket. For\nmore information, see [DeletionPolicy\nAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n###### Important\nYou can only delete empty buckets. Deletion fails for buckets that have contents.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the bucket name.\nExample: `amzn-s3-demo-bucket`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html", "Properties": { "InventoryConfigurations": { "MarkdownDocumentation": "`InventoryConfigurations`\n\nSpecifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket\ninventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.\n*Required*: No\n*Type*: Array of [InventoryConfiguration](./aws-properties-s3-bucket-inventoryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-inventoryconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "InventoryConfiguration", "DuplicatesAllowed": false }, "BucketEncryption": { "MarkdownDocumentation": "`BucketEncryption`\n\nSpecifies default encryption for a bucket using server-side encryption with Amazon\nS3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For\ninformation about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3\nBuckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.\n*Required*: No\n*Type*: [BucketEncryption](./aws-properties-s3-bucket-bucketencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-bucketencryption", "UpdateType": "Mutable", "Required": false, "Type": "BucketEncryption" }, "WebsiteConfiguration": { "MarkdownDocumentation": "`WebsiteConfiguration`\n\nInformation used to configure the bucket as a static website. For more information, see\n[Hosting Websites\non Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).\n*Required*: No\n*Type*: [WebsiteConfiguration](./aws-properties-s3-bucket-websiteconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-websiteconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "WebsiteConfiguration" }, "NotificationConfiguration": { "MarkdownDocumentation": "`NotificationConfiguration`\n\nConfiguration that defines how Amazon S3 handles bucket notifications.\n*Required*: No\n*Type*: [NotificationConfiguration](./aws-properties-s3-bucket-notificationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-notificationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "NotificationConfiguration" }, "LifecycleConfiguration": { "MarkdownDocumentation": "`LifecycleConfiguration`\n\nSpecifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see\n[Object Lifecycle\nManagement](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.\n*Required*: No\n*Type*: [LifecycleConfiguration](./aws-properties-s3-bucket-lifecycleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-lifecycleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LifecycleConfiguration" }, "VersioningConfiguration": { "MarkdownDocumentation": "`VersioningConfiguration`\n\nEnables multiple versions of all objects in this bucket. You might enable versioning to\nprevent objects from being deleted or overwritten by mistake or to archive objects so that you\ncan retrieve previous versions of them.\n###### Note\nWhen you enable versioning on a bucket for the first time, it might take a short\namount of time for the change to be fully propagated. We recommend that you wait for 15\nminutes after enabling versioning before issuing write operations\n(`PUT`\nor\n`DELETE`)\non objects in the bucket.\n*Required*: No\n*Type*: [VersioningConfiguration](./aws-properties-s3-bucket-versioningconfiguration.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-versioningconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "VersioningConfiguration" }, "MetricsConfigurations": { "MarkdownDocumentation": "`MetricsConfigurations`\n\nSpecifies a metrics configuration for the CloudWatch request metrics (specified by the metrics\nconfiguration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that\nthis is a full replacement of the existing metrics configuration. If you don't include the elements you\nwant to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).\n*Required*: No\n*Type*: Array of [MetricsConfiguration](./aws-properties-s3-bucket-metricsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-metricsconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "MetricsConfiguration", "DuplicatesAllowed": false }, "AccessControl": { "MarkdownDocumentation": "`AccessControl`\n\n###### Important\nThis is a legacy property, and it is not recommended for most use cases. A majority of\nmodern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you\nkeep ACLs disabled. For more information, see [Controlling object\nownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.\nA canned access control list (ACL) that grants predefined permissions to the bucket. For\nmore information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the\n*Amazon S3 User Guide*.\nS3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy\nwith any value other than Private. Use cases requiring ACLs are uncommon.\nThe majority of access control configurations can be successfully and more easily\nachieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3\nServer Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the\n*Amazon S3 User Guide*.\n*Required*: No\n*Type*: String\n*Allowed values*: `AuthenticatedRead | AwsExec...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AuthenticatedRead", "AwsExecRead", "BucketOwnerFullControl", "BucketOwnerRead", "LogDeliveryWrite", "Private", "PublicRead", "PublicReadWrite" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-accesscontrol", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MetadataTableConfiguration": { "MarkdownDocumentation": "`MetadataTableConfiguration`\n\nThe metadata table configuration of an Amazon S3 general purpose bucket.\n*Required*: No\n*Type*: [MetadataTableConfiguration](./aws-properties-s3-bucket-metadatatableconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-metadatatableconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MetadataTableConfiguration" }, "IntelligentTieringConfigurations": { "MarkdownDocumentation": "`IntelligentTieringConfigurations`\n\nDefines how Amazon S3 handles Intelligent-Tiering storage.\n*Required*: No\n*Type*: Array of [IntelligentTieringConfiguration](./aws-properties-s3-bucket-intelligenttieringconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-intelligenttieringconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "IntelligentTieringConfiguration", "DuplicatesAllowed": false }, "AnalyticsConfigurations": { "MarkdownDocumentation": "`AnalyticsConfigurations`\n\nSpecifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.\n*Required*: No\n*Type*: Array of [AnalyticsConfiguration](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-analyticsconfigurations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AnalyticsConfiguration", "DuplicatesAllowed": false }, "AbacStatus": { "MarkdownDocumentation": "`AbacStatus`\n\nThe ABAC status of the general purpose bucket. When ABAC is enabled for the general purpose bucket, you can use tags to manage access to the general purpose buckets as well as for cost tracking purposes. When ABAC is disabled for the general purpose buckets, you can only use tags for cost tracking purposes. For more information, see [Using tags with S3 general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html).\n*Required*: No\n*Type*: String\n*Allowed values*: `Enabled | Disabled...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Enabled", "Disabled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-abacstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccelerateConfiguration": { "MarkdownDocumentation": "`AccelerateConfiguration`\n\nConfigures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer\nAcceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.\n*Required*: No\n*Type*: [AccelerateConfiguration](./aws-properties-s3-bucket-accelerateconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-accelerateconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "AccelerateConfiguration" }, "PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`PublicAccessBlockConfiguration`\n\nConfiguration that defines how Amazon S3 handles public access.\n*Required*: No\n*Type*: [PublicAccessBlockConfiguration](./aws-properties-s3-bucket-publicaccessblockconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-publicaccessblockconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PublicAccessBlockConfiguration" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nA name for the bucket. If you don't specify a name, AWS CloudFormation\ngenerates a unique ID and uses that ID for the bucket name. The bucket name must contain only\nlowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket\nrestrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon\nS3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) in the *Amazon S3 User Guide*.\n###### Important\nIf you specify a name, you can't perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you need to\nreplace 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-bucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CorsConfiguration": { "MarkdownDocumentation": "`CorsConfiguration`\n\nDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information,\nsee [Enabling Cross-Origin Resource\nSharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.\n*Required*: No\n*Type*: [CorsConfiguration](./aws-properties-s3-bucket-corsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-corsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "CorsConfiguration" }, "OwnershipControls": { "MarkdownDocumentation": "`OwnershipControls`\n\nConfiguration that defines how Amazon S3 handles Object Ownership rules.\n*Required*: No\n*Type*: [OwnershipControls](./aws-properties-s3-bucket-ownershipcontrols.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-ownershipcontrols", "UpdateType": "Mutable", "Required": false, "Type": "OwnershipControls" }, "ObjectLockConfiguration": { "MarkdownDocumentation": "`ObjectLockConfiguration`\n\n###### Note\nThis operation is not supported for directory buckets.\nPlaces an Object Lock configuration on the specified bucket. The rule specified in the Object Lock\nconfiguration will be applied by default to every new object placed in the specified bucket. For more\ninformation, see [Locking\nObjects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).\n###### Note\n* The `DefaultRetention` settings require both a mode and a period.\n* The `DefaultRetention` period can be either `Days` or `Years`\n but you must select one. You cannot specify `Days` and `Years` at the same\n time.\n* You can enable Object Lock for new or existing buckets. For more information, see [Configuring\n Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).\n###### Important\nYou must URL encode any signed header values that contain spaces. For example, if your header value is `my file.txt`, containing two spaces after `my`, you must URL encode this value to `my%20%20file.txt`.\n*Required*: No\n*Type*: [ObjectLockConfiguration](./aws-properties-s3-bucket-objectlockconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-objectlockconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ObjectLockConfiguration" }, "ObjectLockEnabled": { "MarkdownDocumentation": "`ObjectLockEnabled`\n\nIndicates whether this bucket has an Object Lock configuration enabled. Enable\n`ObjectLockEnabled` when you apply `ObjectLockConfiguration` to a\nbucket.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-objectlockenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "LoggingConfiguration": { "MarkdownDocumentation": "`LoggingConfiguration`\n\nSettings that define where logs are stored.\n*Required*: No\n*Type*: [LoggingConfiguration](./aws-properties-s3-bucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-loggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LoggingConfiguration" }, "MetadataConfiguration": { "MarkdownDocumentation": "`MetadataConfiguration`\n\nThe S3 Metadata configuration for a general purpose bucket.\n*Required*: No\n*Type*: [MetadataConfiguration](./aws-properties-s3-bucket-metadataconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-metadataconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MetadataConfiguration" }, "ReplicationConfiguration": { "MarkdownDocumentation": "`ReplicationConfiguration`\n\nConfiguration for replicating objects in an S3 bucket. To enable replication, you must\nalso enable versioning by using the `VersioningConfiguration` property.\nAmazon S3 can store replicated objects in a single destination bucket or multiple\ndestination buckets. The destination bucket or buckets must already exist.\n*Required*: No\n*Type*: [ReplicationConfiguration](./aws-properties-s3-bucket-replicationconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-replicationconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ReplicationConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn arbitrary set of tags (key-value pairs) for this S3 bucket.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-bucket-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "MetadataTableConfiguration.S3TablesDestination.TableArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MetadataTableConfiguration.S3TablesDestination.TableArn`\n\nThe Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket.\nExample: `arn:aws:s3tables:region:account-id:bucket/amzn-s3-demo-bucket/table/1234567890abcdef0`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataTableConfiguration.S3TablesDestination.TableArn-fn::getatt" }, "MetadataConfiguration.Destination.TableBucketType": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataConfiguration.Destination.TableBucketType-fn::getatt" }, "DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainName`\n\nReturns the IPv4 DNS name of the specified bucket.\nExample: `DOC-EXAMPLE-BUCKET.s3.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#DomainName-fn::getatt" }, "MetadataConfiguration.JournalTableConfiguration.TableName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MetadataConfiguration.JournalTableConfiguration.TableName`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataConfiguration.JournalTableConfiguration.TableName-fn::getatt" }, "WebsiteURL": { "PrimitiveType": "String", "MarkdownDocumentation": "`WebsiteURL`\n\nReturns the Amazon S3 website endpoint for the specified bucket.\nExample (IPv4): `http://DOC-EXAMPLE-BUCKET.s3-website.us-east-2.amazonaws.com`\nExample (IPv6):\n`http://DOC-EXAMPLE-BUCKET.s3.dualstack.us-east-2.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#WebsiteURL-fn::getatt" }, "DualStackDomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DualStackDomainName`\n\nReturns the IPv6 DNS name of the specified bucket.\nExample: `DOC-EXAMPLE-BUCKET.s3.dualstack.us-east-2.amazonaws.com`\nFor more information about dual-stack endpoints, see [Using Amazon S3 Dual-Stack\nEndpoints](https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#DualStackDomainName-fn::getatt" }, "MetadataConfiguration.JournalTableConfiguration.TableArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MetadataConfiguration.JournalTableConfiguration.TableArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataConfiguration.JournalTableConfiguration.TableArn-fn::getatt" }, "MetadataTableConfiguration.S3TablesDestination.TableNamespace": { "PrimitiveType": "String", "MarkdownDocumentation": "`MetadataTableConfiguration.S3TablesDestination.TableNamespace`\n\nThe table bucket namespace for the metadata table in the specified bucket's metadata table configuration. This value is always `aws_s3_metadata`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataTableConfiguration.S3TablesDestination.TableNamespace-fn::getatt" }, "MetadataConfiguration.Destination.TableNamespace": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataConfiguration.Destination.TableNamespace-fn::getatt" }, "RegionalDomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`RegionalDomainName`\n\nReturns the regional domain name of the specified bucket.\nExample: `DOC-EXAMPLE-BUCKET.s3.us-east-2.amazonaws.com`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#RegionalDomainName-fn::getatt" }, "MetadataConfiguration.Destination.TableBucketArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataConfiguration.Destination.TableBucketArn-fn::getatt" }, "MetadataConfiguration.InventoryTableConfiguration.TableArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`MetadataConfiguration.InventoryTableConfiguration.TableArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataConfiguration.InventoryTableConfiguration.TableArn-fn::getatt" }, "MetadataConfiguration.Destination": { "Type": "MetadataDestination", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataConfiguration.Destination-fn::getatt" }, "MetadataConfiguration.InventoryTableConfiguration.TableName": { "PrimitiveType": "String", "MarkdownDocumentation": "`MetadataConfiguration.InventoryTableConfiguration.TableName`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#MetadataConfiguration.InventoryTableConfiguration.TableName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the specified bucket.\nExample: `arn:aws:s3:::DOC-EXAMPLE-BUCKET`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#Arn-fn::getatt" } } }, "AWS::S3::BucketPolicy": { "MarkdownDocumentation": "`AWS::S3::BucketPolicy`\n\nApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity\nother than the root user of the AWS account that owns the bucket, the calling\nidentity must have the `PutBucketPolicy` permissions on the specified bucket and\nbelong to the bucket owner's account in order to use this operation.\nIf you don't have `PutBucketPolicy` permissions, Amazon S3 returns a `403\nAccess Denied` error. If you have the correct permissions, but you're not using an\nidentity that belongs to the bucket owner's account, Amazon S3 returns a `405 Method Not\nAllowed` error.\n###### Important\nAs a security precaution, the root user of the AWS account that owns a\nbucket can always use this operation, even if the policy explicitly denies the root user the\nability to perform this action.\nWhen using the `AWS::S3::BucketPolicy` resource,\nyou can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or `us-east-1` Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.\n###### Important\nIf the [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) is not specified or set to `Delete`,\nthe bucket policy will be removed when the stack is deleted. If set to `Retain`, the bucket policy will be preserved even after the stack is deleted.\nFor example, a CloudFormation stack in `us-east-1` can use the `AWS::S3::BucketPolicy` resource to manage the bucket policy for an S3 bucket in `us-west-2`.\nThe retention or removal of the bucket policy during the stack deletion is determined by the `DeletionPolicy` attribute specified in the stack template.\nFor more information, see [Bucket policy\nexamples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).\nThe following operations are related to `PutBucketPolicy`:\n* [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n* [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html#cfn-s3-bucketpolicy-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA policy document containing permissions to add to the specified bucket. In IAM, you must\nprovide policy documents in JSON format. However, in CloudFormation you can provide the policy\nin JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to\nIAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Access Policy Language\nOverview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html#cfn-s3-bucketpolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::S3::MultiRegionAccessPoint": { "MarkdownDocumentation": "`AWS::S3::MultiRegionAccessPoint`\n\nThe `AWS::S3::MultiRegionAccessPoint` resource creates an Amazon S3\nMulti-Region Access Point. To learn more about Multi-Region Access Points, see [Multi-Region Access Points in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPoints.html) in the in the *Amazon S3 User\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the Multi-Region Access Point.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html", "Properties": { "PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`PublicAccessBlockConfiguration`\n\nThe PublicAccessBlock configuration that you want to apply to this Multi-Region Access\nPoint. You can enable the configuration options in any combination. For more information about\nwhen Amazon S3 considers an 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](./aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "PublicAccessBlockConfiguration" }, "Regions": { "MarkdownDocumentation": "`Regions`\n\nA collection of the Regions and buckets associated with the Multi-Region Access\nPoint.\n*Required*: Yes\n*Type*: Array of [Region](./aws-properties-s3-multiregionaccesspoint-region.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#cfn-s3-multiregionaccesspoint-regions", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "Region", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Multi-Region Access Point.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$`\n*Minimum*: `3`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#cfn-s3-multiregionaccesspoint-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Alias": { "PrimitiveType": "String", "MarkdownDocumentation": "`Alias`\n\nThe alias for the Multi-Region Access Point. For more information about the distinction\nbetween the name and the alias of an Multi-Region Access Point, see [Managing Multi-Region Access Points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) in the *Amazon S3 User\nGuide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#Alias-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe timestamp of when the Multi-Region Access Point is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#CreatedAt-fn::getatt" } } }, "AWS::S3::MultiRegionAccessPointPolicy": { "MarkdownDocumentation": "`AWS::S3::MultiRegionAccessPointPolicy`\n\nApplies an Amazon S3 access policy to an Amazon S3 Multi-Region Access Point.\nIt is not possible to delete an access policy for a Multi-Region Access Point from the\nCloudFormation template. When you attempt to delete the policy, CloudFormation updates the\npolicy using `DeletionPolicy:Retain` and `UpdateReplacePolicy:Retain`.\nCloudFormation updates the policy to only allow access to the account that created the\nbucket.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the Multi-Region Access Point.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html#cfn-s3-multiregionaccesspointpolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "MrapName": { "MarkdownDocumentation": "`MrapName`\n\nThe name of the Multi-Region Access Point.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$`\n*Minimum*: `3`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html#cfn-s3-multiregionaccesspointpolicy-mrapname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "PolicyStatus.IsPublic": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html#PolicyStatus.IsPublic-fn::getatt" }, "PolicyStatus": { "Type": "PolicyStatus", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html#PolicyStatus-fn::getatt" } } }, "AWS::S3::StorageLens": { "MarkdownDocumentation": "`AWS::S3::StorageLens`\n\nThe AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the S3 Storage Lens configuration Id, such as\n`your-storage-lens-configuration-id`. For more information about using the Ref\nfunction, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html", "Properties": { "StorageLensConfiguration": { "MarkdownDocumentation": "`StorageLensConfiguration`\n\nThis resource contains the details Amazon S3 Storage Lens configuration.\n*Required*: Yes\n*Type*: [StorageLensConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#cfn-s3-storagelens-storagelensconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "StorageLensConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA set of tags (key\u2013value pairs) to associate with the Storage Lens configuration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-storagelens-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#cfn-s3-storagelens-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "StorageLensConfiguration.StorageLensArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`StorageLensConfiguration.StorageLensArn`\n\nThis property contains the details of the ARN of the S3 Storage Lens configuration. This\nproperty is read-only.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#StorageLensConfiguration.StorageLensArn-fn::getatt" } } }, "AWS::S3::StorageLensGroup": { "MarkdownDocumentation": "`AWS::S3::StorageLensGroup`\n\nThe `AWS::S3::StorageLensGroup` resource creates an S3 Storage Lens group. A\nStorage Lens group is a custom grouping of objects that include filters for prefixes,\nsuffixes, object tags, object size, or object age. You can create an S3 Storage Lens group\nthat includes a single filter or multiple filter conditions. To specify multiple filter\nconditions, you use `AND` or `OR` logical operators. For more\ninformation about S3 Storage Lens groups, see [Working with S3 Storage Lens groups](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups-overview.html).\n", "RefReturnValue": "\nWhen the logical ID of this resource is provided to the Ref intrinsic function, Ref\nreturns the S3 Storage Lens group name. For more information about using the Ref function, see\n[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelensgroup.html", "Properties": { "Filter": { "MarkdownDocumentation": "`Filter`\n\nThis property contains the criteria for the Storage Lens group data that is\ndisplayed\n*Required*: Yes\n*Type*: [Filter](./aws-properties-s3-storagelensgroup-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelensgroup.html#cfn-s3-storagelensgroup-filter", "UpdateType": "Mutable", "Required": true, "Type": "Filter" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThis property contains the AWS resource tags that you're adding to your Storage Lens\ngroup. This parameter is optional.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3-storagelensgroup-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelensgroup.html#cfn-s3-storagelensgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThis property contains the Storage Lens group name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9\\-_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelensgroup.html#cfn-s3-storagelensgroup-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "StorageLensGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`StorageLensGroupArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelensgroup.html#StorageLensGroupArn-fn::getatt" } } }, "AWS::S3Express::AccessPoint": { "MarkdownDocumentation": "`AWS::S3Express::AccessPoint`\n\nAccess points simplify managing data access at scale for shared datasets in Amazon S3.\nAccess points are unique hostnames you create to enforce distinct permissions and network controls\nfor all requests made through an access point. You can create hundreds of access points per bucket,\neach with a distinct name and permissions customized for each application. Each access point works\nin conjunction with the bucket policy that is attached to the underlying bucket. For more information, see [Managing access to shared datasets in directory buckets with access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe access point policy associated with the specified 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#cfn-s3express-accesspoint-policy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "PublicAccessBlockConfiguration": { "MarkdownDocumentation": "`PublicAccessBlockConfiguration`\n\nPublic access is blocked by default to access points for directory buckets.\n*Required*: No\n*Type*: [PublicAccessBlockConfiguration](./aws-properties-s3express-accesspoint-publicaccessblockconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#cfn-s3express-accesspoint-publicaccessblockconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "PublicAccessBlockConfiguration" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nYou can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.\nFor more information, see [Manage the scope of your access points for directory buckets.](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets-manage-scope.html)\n*Required*: No\n*Type*: [Scope](./aws-properties-s3express-accesspoint-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#cfn-s3express-accesspoint-scope", "UpdateType": "Mutable", "Required": false, "Type": "Scope" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the bucket that you want to associate the access point with.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#cfn-s3express-accesspoint-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BucketAccountId": { "MarkdownDocumentation": "`BucketAccountId`\n\nThe AWS account ID that owns the bucket associated with this access point.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d{12}$`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#cfn-s3express-accesspoint-bucketaccountid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nIf you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).\n*Required*: No\n*Type*: [VpcConfiguration](./aws-properties-s3express-accesspoint-vpcconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#cfn-s3express-accesspoint-vpcconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tags that you can apply to access points. Tags are key-value pairs of metadata used to categorize your access points and control access. For more information, see [Using tags for attribute-based access control (ABAC)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#using-tags-for-abac).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3express-accesspoint-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#cfn-s3express-accesspoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nAn access point name consists of a base name you provide, followed by the zoneID (AWS Local Zone) followed by the prefix `--xa-s3`. For example, accesspointname--zoneID--xa-s3.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$`\n*Minimum*: `3`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#cfn-s3express-accesspoint-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#Arn-fn::getatt" }, "NetworkOrigin": { "PrimitiveType": "String", "MarkdownDocumentation": "`NetworkOrigin`\n\nThe network configuration of the access point.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-accesspoint.html#NetworkOrigin-fn::getatt" } } }, "AWS::S3Express::BucketPolicy": { "MarkdownDocumentation": "`AWS::S3Express::BucketPolicy`\n\nThe `AWS::S3Express::BucketPolicy` resource defines an Amazon S3 bucket policy to an Amazon S3 directory bucket.\nPermissions\nIf you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must both have\nthe required permissions on the specified bucket and belong to the bucket owner's\naccount in order to use this operation. For more information about directory\nbucket policies and permissions, see [AWS Identity and Access Management (IAM) for S3 Express One\nZone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html) in the *Amazon S3 User Guide*.\n###### Important\nTo ensure that bucket owners don't inadvertently lock themselves out of\ntheir own buckets, the root principal in a bucket owner's AWS account can perform the `GetBucketPolicy`,\n`PutBucketPolicy`, and `DeleteBucketPolicy` API\nactions, even if their bucket policy explicitly denies the root principal's\naccess. Bucket owner root principals can only be blocked from performing these\nAPI actions by VPC endpoint policies and AWS Organizations\npolicies.\nThe required permissions for CloudFormation to use are based on the operations\nthat are performed on the stack.\n* Create\n \n + s3express:GetBucketPolicy\n + s3express:PutBucketPolicy\n* Read\n \n + s3express:GetBucketPolicy\n* Update\n \n + s3express:GetBucketPolicy\n + s3express:PutBucketPolicy\n* Delete\n \n + s3express:GetBucketPolicy\n + s3express:DeleteBucketPolicy\n* List\n \n + s3express:GetBucketPolicy\n + s3express:ListAllMyDirectoryBuckets\n\nFor more information about example bucket policies, see [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html) in the *Amazon S3 User\nGuide*.\nThe following operations are related to\n`AWS::S3Express::BucketPolicy`:\n* [PutBucketPolicy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html)\n* [GetBucketPolicy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html)\n* [DeleteBucketPolicy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html)\n* [ListDirectoryBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListDirectoryBuckets.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-bucketpolicy.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the S3 directory 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-bucketpolicy.html#cfn-s3express-bucketpolicy-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA policy document containing permissions to add to the specified bucket. In IAM, you\nmust provide policy documents in JSON format. However, in CloudFormation you can provide\nthe policy in JSON or YAML format because CloudFormation converts YAML to JSON before\nsubmitting it to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Policies and Permissions in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User\nGuide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-bucketpolicy.html#cfn-s3express-bucketpolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::S3Express::DirectoryBucket": { "MarkdownDocumentation": "`AWS::S3Express::DirectoryBucket`\n\nThe `AWS::S3Express::DirectoryBucket` resource defines an Amazon S3 directory\nbucket in the same AWS Region where you create the AWS\nCloudFormation stack.\nTo control how AWS CloudFormation handles the bucket when the stack is\ndeleted, you can set a deletion policy for your bucket. You can choose to\n*retain* the bucket or to *delete* the bucket. For\nmore information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n###### Important\nYou can only delete empty buckets. Deletion fails for buckets that have\ncontents.\nPermissions\nThe required permissions for CloudFormation to use are based on the operations\nthat are performed on the stack.\n* Create\n \n + s3express:CreateBucket\n + s3express:ListAllMyDirectoryBuckets\n* Read\n \n + s3express:ListAllMyDirectoryBuckets\n + ec2:DescribeAvailabilityZones\n* Delete\n \n + s3express:DeleteBucket\n + s3express:ListAllMyDirectoryBuckets\n* List\n \n + s3express:ListAllMyDirectoryBuckets\n* PutBucketEncryption\n \n + s3express:PutEncryptionConfiguration\n + To set a directory bucket default encryption with SSE-KMS, you must\n also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM\n identity-based policies and AWS KMS key policies for\n the target AWS KMS key.\n* GetBucketEncryption\n \n + s3express:GetBucketEncryption\n* DeleteBucketEncryption\n \n + s3express:PutEncryptionConfiguration\n\nThe following operations are related to\n`AWS::S3Express::DirectoryBucket`:\n* [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)\n* [ListDirectoryBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListDirectoryBuckets.html)\n* [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the bucket name.\nExample: `bucket_base_name--usw2-az1--x-s3`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html", "Properties": { "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nA name for the bucket. The bucket name must contain only\nlowercase letters, numbers, and hyphens (-).\nA directory bucket name must be unique in the chosen Zone (Availability Zone or Local Zone). The bucket name must also follow the format `bucket_base_name--zone_id--x-s3`\n(for example, `bucket_base_name--usw2-az1--x-s3`). If you don't specify a name, AWS CloudFormation\ngenerates a unique ID and uses that ID for the bucket name.\nFor information about bucket naming restrictions,\nsee [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html)\nin the *Amazon S3 User Guide*.\n###### Important\nIf you specify a name, you can't perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you need to\nreplace the resource, specify a new name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-bucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BucketEncryption": { "MarkdownDocumentation": "`BucketEncryption`\n\nSpecifies default encryption for a bucket using server-side encryption with Amazon S3\nmanaged keys (SSE-S3) or AWS KMS keys (SSE-KMS). For information about\ndefault encryption for directory buckets, see [Setting and monitoring\ndefault encryption for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html) in the *Amazon S3 User\nGuide*.\n*Required*: No\n*Type*: [BucketEncryption](./aws-properties-s3express-directorybucket-bucketencryption.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-bucketencryption", "UpdateType": "Mutable", "Required": false, "Type": "BucketEncryption" }, "DataRedundancy": { "MarkdownDocumentation": "`DataRedundancy`\n\nThe number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SingleAvailabilityZone | Si...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SingleAvailabilityZone", "SingleLocalZone" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-dataredundancy", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LifecycleConfiguration": { "MarkdownDocumentation": "`LifecycleConfiguration`\n\nContainer for lifecycle rules. You can add as many as 1000 rules.\nFor more information see, [Creating and managing a lifecycle configuration for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-lifecycle.html ) in the\n*Amazon S3 User Guide*.\n*Required*: No\n*Type*: [LifecycleConfiguration](./aws-properties-s3express-directorybucket-lifecycleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-lifecycleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LifecycleConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tags that you can apply to the S3 directory bucket. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access. For more information, see [Using tags with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3express-directorybucket-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "LocationName": { "MarkdownDocumentation": "`LocationName`\n\nThe name of the location where the bucket will be created.\nFor directory buckets, the name of the location is the Zone ID of the Availability Zone (AZ) or Local Zone (LZ) where\nthe bucket will be created. An example AZ ID value is `usw2-az1`.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#cfn-s3express-directorybucket-locationname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AvailabilityZoneName": { "PrimitiveType": "String", "MarkdownDocumentation": "`AvailabilityZoneName`\n\nReturns the code for the Availability Zone or the Local Zone where the directory bucket was created.\nExample value for an Availability Zone code: *us-east-1f*\n###### Note\nAn Availability Zone code might not represent the same physical location for\ndifferent AWS accounts. For more information, see [Availability Zones and Regions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Endpoints.html) in the *Amazon S3 User\nGuide*.\n\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#AvailabilityZoneName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the specified bucket.\nExample:\n`arn:aws:s3express:us-west-2:account_id:bucket/bucket_base_name--usw2-az1--x-s3`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html#Arn-fn::getatt" } } }, "AWS::S3ObjectLambda::AccessPoint": { "MarkdownDocumentation": "`AWS::S3ObjectLambda::AccessPoint`\n\nThe `AWS::S3ObjectLambda::AccessPoint` resource specifies an Object Lambda\nAccess Point used to access a bucket.\n", "RefReturnValue": "\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html", "Properties": { "ObjectLambdaConfiguration": { "MarkdownDocumentation": "`ObjectLambdaConfiguration`\n\nA configuration used when creating an Object Lambda Access Point.\n*Required*: Yes\n*Type*: [ObjectLambdaConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#cfn-s3objectlambda-accesspoint-objectlambdaconfiguration", "UpdateType": "Mutable", "Required": true, "Type": "ObjectLambdaConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of this access point.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$`\n*Minimum*: `3`\n*Maximum*: `45`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#cfn-s3objectlambda-accesspoint-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "CreationDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationDate`\n\nThe date and time when the specified Object\nLambda Access Point was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#CreationDate-fn::getatt" }, "PublicAccessBlockConfiguration": { "Type": "PublicAccessBlockConfiguration", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#PublicAccessBlockConfiguration-fn::getatt" }, "PublicAccessBlockConfiguration.BlockPublicAcls": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#PublicAccessBlockConfiguration.BlockPublicAcls-fn::getatt" }, "Alias": { "Type": "Alias", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#Alias-fn::getatt" }, "Alias.Value": { "PrimitiveType": "String", "MarkdownDocumentation": "`Alias.Value`\n\nThe alias name value of the Object Lambda Access Point. For example: `myolap-1a4n8yjrb3kda96f67zwrwiiuse1a--ol-s3`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#Alias.Value-fn::getatt" }, "PublicAccessBlockConfiguration.IgnorePublicAcls": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#PublicAccessBlockConfiguration.IgnorePublicAcls-fn::getatt" }, "PublicAccessBlockConfiguration.RestrictPublicBuckets": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#PublicAccessBlockConfiguration.RestrictPublicBuckets-fn::getatt" }, "PublicAccessBlockConfiguration.BlockPublicPolicy": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#PublicAccessBlockConfiguration.BlockPublicPolicy-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nSpecifies the ARN for the Object Lambda Access\nPoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#Arn-fn::getatt" }, "Alias.Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Alias.Status`\n\nThe status of the Object Lambda Access Point alias. Valid Values: `PROVISIONING` | `READY`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html#Alias.Status-fn::getatt" } } }, "AWS::S3ObjectLambda::AccessPointPolicy": { "MarkdownDocumentation": "`AWS::S3ObjectLambda::AccessPointPolicy`\n\nThe `AWS::S3ObjectLambda::AccessPointPolicy` resource specifies the Object\nLambda Access Point resource policy document.\n", "RefReturnValue": "\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspointpolicy.html", "Properties": { "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nObject Lambda Access Point resource policy document.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspointpolicy.html#cfn-s3objectlambda-accesspointpolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ObjectLambdaAccessPoint": { "MarkdownDocumentation": "`ObjectLambdaAccessPoint`\n\nAn access point with an attached AWS Lambda function used to access transformed data from an Amazon S3\nbucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$`\n*Minimum*: `3`\n*Maximum*: `45`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspointpolicy.html#cfn-s3objectlambda-accesspointpolicy-objectlambdaaccesspoint", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3Outposts::AccessPoint": { "MarkdownDocumentation": "`AWS::S3Outposts::AccessPoint`\n\nThe AWS::S3Outposts::AccessPoint resource specifies an access point and associates it with\nthe specified Amazon S3 on Outposts bucket. For more information, see [Managing data access\nwith Amazon S3 access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html).\n###### Note\nS3 on Outposts supports only VPC-style access points.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the access point ARN.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-accesspoint.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-accesspoint.html#cfn-s3outposts-accesspoint-policy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe Amazon Resource Name (ARN) of the S3 on Outposts bucket that is associated with this\naccess point.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/bucket\\/[^:]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-accesspoint.html#cfn-s3outposts-accesspoint-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "VpcConfiguration": { "MarkdownDocumentation": "`VpcConfiguration`\n\nThe virtual private cloud (VPC) configuration for this access point, if one exists.\n*Required*: Yes\n*Type*: [VpcConfiguration](./aws-properties-s3outposts-accesspoint-vpcconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-accesspoint.html#cfn-s3outposts-accesspoint-vpcconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "VpcConfiguration" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of this access point.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9]([a-z0-9\\\\-]*[a-z0-9])?$`\n*Minimum*: `3`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-accesspoint.html#cfn-s3outposts-accesspoint-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThis resource contains the details of the S3 on Outposts bucket access point ARN. This\nresource is read-only.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-accesspoint.html#Arn-fn::getatt" } } }, "AWS::S3Outposts::Bucket": { "MarkdownDocumentation": "`AWS::S3Outposts::Bucket`\n\nThe AWS::S3Outposts::Bucket resource specifies a new Amazon S3 on Outposts bucket.\nTo create an S3 on Outposts bucket, you must have S3 on Outposts capacity provisioned on your Outpost.\nFor more information, see [Using Amazon S3 on Outposts](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html).\nS3 on Outposts buckets support the following:\n* Tags\n* Lifecycle configuration rules for deleting expired objects\nFor a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts,\nsee [Amazon S3 on Outposts Restrictions and Limitations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the S3 on Outposts bucket Amazon Resource Name (ARN).\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html", "Properties": { "OutpostId": { "MarkdownDocumentation": "`OutpostId`\n\nThe ID of the Outpost of the specified bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(op-[a-f0-9]{17}|\\d{12}|ec2)$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-outpostid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nA name for the S3 on Outposts bucket. If you don't specify a name, AWS CloudFormation generates a\nunique ID and uses that ID for the bucket name.\nThe bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-)\nand must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html).\nFor more information, see [Bucket\nnaming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules).\n###### Important\nIf you specify a name, you can't perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you need to\nreplace the resource, specify a new name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-bucketname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LifecycleConfiguration": { "MarkdownDocumentation": "`LifecycleConfiguration`\n\nCreates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing\nlifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects\nafter a certain period of time and abort incomplete multipart uploads.\n*Required*: No\n*Type*: [LifecycleConfiguration](./aws-properties-s3outposts-bucket-lifecycleconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-lifecycleconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LifecycleConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSets the tags for an S3 on Outposts bucket. For more information, see [Using Amazon S3 on Outposts](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html).\nUse tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your\nAWS account bill with tag key values included. Then, to see the cost of combined resources, organize your\nbilling information according to resources with the same tag key values. For example, you can tag several\nresources with a specific application name, and then organize your billing information to see the total cost\nof that application across several services. For more information, see\n[Cost allocation and\ntags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html).\n###### Note\nWithin a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites\nthe old value. For more information, see [Using cost allocation and bucket tags](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html).\nTo use this resource, you must have permissions to perform the\n`s3-outposts:PutBucketTagging`. The S3 on Outposts bucket owner has this\npermission by default and can grant this permission to others. For more information about\npermissions, see [Permissions\nRelated to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and [Managing access permissions to your Amazon S3 resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3outposts-bucket-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the specified bucket.\nExample: `arn:aws:s3Outposts:::DOC-EXAMPLE-BUCKET`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#Arn-fn::getatt" } } }, "AWS::S3Outposts::BucketPolicy": { "MarkdownDocumentation": "`AWS::S3Outposts::BucketPolicy`\n\nThis resource applies a bucket policy to an Amazon S3 on Outposts bucket.\nIf you are using an identity other than the root user of the AWS account\nthat owns the S3 on Outposts bucket, the calling identity must have\nthe `s3-outposts:PutBucketPolicy` permissions on the specified\nOutposts bucket and belong to the bucket owner's account in order to use\nthis resource.\nIf you don't have `s3-outposts:PutBucketPolicy` permissions,\nS3 on Outposts returns a `403 Access Denied` error.\n###### Important\nThe root user of the AWS account that owns an Outposts bucket can\n*always* use this resource, even if the policy explicitly denies the\nroot user the ability to perform actions on this resource.\nFor more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and\n[Access Policy Language Overview](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the S3 on Outposts bucket Amazon Resource Name (ARN).\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucketpolicy.html", "Properties": { "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the Amazon S3 Outposts bucket to which the policy applies.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/bucket\\/[^:]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucketpolicy.html#cfn-s3outposts-bucketpolicy-bucket", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA policy document containing permissions to add to the specified bucket. In IAM, you must\nprovide policy documents in JSON format. However, in CloudFormation, you can provide the\npolicy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting\nit to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Access Policy Language\nOverview](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucketpolicy.html#cfn-s3outposts-bucketpolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::S3Outposts::Endpoint": { "MarkdownDocumentation": "`AWS::S3Outposts::Endpoint`\n\nThis AWS::S3Outposts::Endpoint resource specifies an endpoint and associates it with the specified Outpost.\nAmazon S3 on Outposts access points simplify managing data access at scale for shared\ndatasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to S3 on Outposts buckets\nso that you can perform actions within your virtual private cloud (VPC). For more information,\nsee [Accessing S3 on Outposts using VPC-only access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html).\n###### Note\nIt can take up to 5 minutes for this resource to be created.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) for the endpoint.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html", "Properties": { "OutpostId": { "MarkdownDocumentation": "`OutpostId`\n\nThe ID of the Outpost.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(op-[a-f0-9]{17}|\\d{12}|ec2)$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-outpostid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SecurityGroupId": { "MarkdownDocumentation": "`SecurityGroupId`\n\nThe ID of the security group used for the endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^sg-([0-9a-f]{8}|[0-9a-f]{17})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-securitygroupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FailedReason": { "MarkdownDocumentation": "`FailedReason`\n\nThe failure reason, if any, for a create or delete endpoint operation.\n*Required*: No\n*Type*: [FailedReason](./aws-properties-s3outposts-endpoint-failedreason.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-failedreason", "UpdateType": "Mutable", "Required": false, "Type": "FailedReason" }, "SubnetId": { "MarkdownDocumentation": "`SubnetId`\n\nThe ID of the subnet used for the endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^subnet-([0-9a-f]{8}|[0-9a-f]{17})$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-subnetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccessType": { "MarkdownDocumentation": "`AccessType`\n\nThe container for the type of connectivity used to access the Amazon S3 on Outposts\nendpoint. To use the Amazon VPC, choose `Private`. To use the endpoint\nwith an on-premises network, choose `CustomerOwnedIp`. If you choose\n`CustomerOwnedIp`, you must also provide the customer-owned IP address pool (CoIP\npool).\n###### Note\n`Private` is the default access type value.\n*Required*: No\n*Type*: String\n*Allowed values*: `CustomerOwnedIp | Private...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CustomerOwnedIp", "Private" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-accesstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CustomerOwnedIpv4Pool": { "MarkdownDocumentation": "`CustomerOwnedIpv4Pool`\n\nThe ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses\nare allocated from this pool for the endpoint.\n*Required*: No\n*Type*: String\n*Pattern*: `^ipv4pool-coip-([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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-customerownedipv4pool", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#Status-fn::getatt" }, "NetworkInterfaces": { "Type": "List", "ItemType": "NetworkInterface", "MarkdownDocumentation": "`NetworkInterfaces`\n\nThe network interface of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#NetworkInterfaces-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time the endpoint was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#CreationTime-fn::getatt" }, "CidrBlock": { "PrimitiveType": "String", "MarkdownDocumentation": "`CidrBlock`\n\nThe VPC CIDR block committed by this endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#CidrBlock-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN of the endpoint.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#Arn-fn::getatt" } } }, "AWS::S3Tables::Namespace": { "MarkdownDocumentation": "`AWS::S3Tables::Namespace`\n\nCreates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see [Create a namespace](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace-create.html) in the *Amazon Simple Storage Service User Guide*.\nPermissions\nYou must have the `s3tables:CreateNamespace` permission to use this operation.\n\nAWS Cloud Development Kit (AWS CDK)\nTo use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:\n* NPM: `npm i @aws-cdk/aws-s3tables-alpha`\n* Yarn:`yarn add @aws-cdk/aws-s3tables-alpha`\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the namespace name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-namespace.html", "Properties": { "TableBucketARN": { "MarkdownDocumentation": "`TableBucketARN`\n\nThe Amazon Resource Name (ARN) of the table bucket to create the namespace in.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-namespace.html#cfn-s3tables-namespace-tablebucketarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe name of the namespace.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-namespace.html#cfn-s3tables-namespace-namespace", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::S3Tables::Table": { "MarkdownDocumentation": "`AWS::S3Tables::Table`\n\nCreates a new table associated with the given namespace in a table bucket. For more information, see [Creating an Amazon S3 table](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-create.html) in the *Amazon Simple Storage Service User Guide*.\nPermissions\n* You must have the `s3tables:CreateTable` permission to use this operation.\n* If you use this operation with the optional `metadata` request parameter you must have the `s3tables:PutTableData` permission.\n* If you use this operation with the optional `encryptionConfiguration` request parameter you must have the `s3tables:PutTableEncryption` permission.\n###### Note\nAdditionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see [Permissions requirements for S3 Tables SSE-KMS encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html).\n\nAWS Cloud Development Kit (AWS CDK)\nTo use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:\n* NPM: `npm i @aws-cdk/aws-s3tables-alpha`\n* Yarn:`yarn add @aws-cdk/aws-s3tables-alpha`\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the table name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html", "Properties": { "WithoutMetadata": { "MarkdownDocumentation": "`WithoutMetadata`\n\nIndicates that you don't want to specify a schema for the table. This property is mutually exclusive to `IcebergMetadata`, and its only possible value is `Yes`.\n*Required*: No\n*Type*: String\n*Allowed values*: `Yes`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "Yes" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-withoutmetadata", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StorageClassConfiguration": { "MarkdownDocumentation": "`StorageClassConfiguration`\n\nThe configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.\n*Required*: No\n*Type*: [StorageClassConfiguration](./aws-properties-s3tables-table-storageclassconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-storageclassconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "StorageClassConfiguration" }, "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name for the table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[0-9a-z_]*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablename", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TableBucketARN": { "MarkdownDocumentation": "`TableBucketARN`\n\nThe Amazon Resource Name (ARN) of the table bucket to create the table in.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablebucketarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OpenTableFormat": { "MarkdownDocumentation": "`OpenTableFormat`\n\nThe format of the table.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ICEBERG`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ICEBERG" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-opentableformat", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IcebergMetadata": { "MarkdownDocumentation": "`IcebergMetadata`\n\nContains details about the metadata for an Iceberg table.\n*Required*: No\n*Type*: [IcebergMetadata](./aws-properties-s3tables-table-icebergmetadata.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-icebergmetadata", "UpdateType": "Immutable", "Required": false, "Type": "IcebergMetadata" }, "Compaction": { "MarkdownDocumentation": "`Compaction`\n\nContains details about the compaction settings for an Iceberg table.\n*Required*: No\n*Type*: [Compaction](./aws-properties-s3tables-table-compaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-compaction", "UpdateType": "Mutable", "Required": false, "Type": "Compaction" }, "Namespace": { "MarkdownDocumentation": "`Namespace`\n\nThe name of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-namespace", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "SnapshotManagement": { "MarkdownDocumentation": "`SnapshotManagement`\n\nContains details about the Iceberg snapshot management settings for the table.\n*Required*: No\n*Type*: [SnapshotManagement](./aws-properties-s3tables-table-snapshotmanagement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-snapshotmanagement", "UpdateType": "Mutable", "Required": false, "Type": "SnapshotManagement" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3tables-table-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "VersionToken": { "PrimitiveType": "String", "MarkdownDocumentation": "`VersionToken`\n\nThe version token of the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#VersionToken-fn::getatt" }, "TableARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`TableARN`\n\nThe Amazon Resource Name (ARN) of the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#TableARN-fn::getatt" }, "WarehouseLocation": { "PrimitiveType": "String", "MarkdownDocumentation": "`WarehouseLocation`\n\nThe warehouse location of the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#WarehouseLocation-fn::getatt" } } }, "AWS::S3Tables::TableBucket": { "MarkdownDocumentation": "`AWS::S3Tables::TableBucket`\n\nCreates a table bucket. For more information, see [Creating a table bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-create.html) in the *Amazon Simple Storage Service User Guide*.\nPermissions\n* You must have the `s3tables:CreateTableBucket` permission to use this operation.\n* If you use this operation with the optional `encryptionConfiguration` parameter you must have the `s3tables:PutTableBucketEncryption` permission.\n\nAWS Cloud Development Kit (AWS CDK)\nTo use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:\n* NPM: `npm i @aws-cdk/aws-s3tables-alpha`\n* Yarn:`yarn add @aws-cdk/aws-s3tables-alpha`\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the table bucket name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html", "Properties": { "TableBucketName": { "MarkdownDocumentation": "`TableBucketName`\n\nThe name for the table bucket.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-tablebucketname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StorageClassConfiguration": { "MarkdownDocumentation": "`StorageClassConfiguration`\n\nThe configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.\n*Required*: No\n*Type*: [StorageClassConfiguration](./aws-properties-s3tables-tablebucket-storageclassconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-storageclassconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "StorageClassConfiguration" }, "MetricsConfiguration": { "MarkdownDocumentation": "`MetricsConfiguration`\n\nProperty description not available.\n*Required*: No\n*Type*: [MetricsConfiguration](./aws-properties-s3tables-tablebucket-metricsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-metricsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "MetricsConfiguration" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nConfiguration specifying how data should be encrypted. This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-s3tables-tablebucket-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfiguration" }, "UnreferencedFileRemoval": { "MarkdownDocumentation": "`UnreferencedFileRemoval`\n\nThe unreferenced file removal settings for your table bucket. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. For more information, see the [*Amazon S3 User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html).\n*Required*: No\n*Type*: [UnreferencedFileRemoval](./aws-properties-s3tables-tablebucket-unreferencedfileremoval.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-unreferencedfileremoval", "UpdateType": "Mutable", "Required": false, "Type": "UnreferencedFileRemoval" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-s3tables-tablebucket-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "TableBucketARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`TableBucketARN`\n\nThe Amazon Resource Name (ARN) of the table bucket.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#TableBucketARN-fn::getatt" } } }, "AWS::S3Tables::TableBucketPolicy": { "MarkdownDocumentation": "`AWS::S3Tables::TableBucketPolicy`\n\nCreates a new maintenance configuration or replaces an existing table bucket policy for a\ntable bucket. For more information, see [Adding a table bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-add) in the *Amazon Simple Storage Service User Guide*.\nPermissions\nYou must have the `s3tables:PutTableBucketPolicy` permission to use this operation.\n\nAWS Cloud Development Kit (AWS CDK)\nTo use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:\n* NPM: `npm i @aws-cdk/aws-s3tables-alpha`\n* Yarn:`yarn add @aws-cdk/aws-s3tables-alpha`\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns some information about your table bucket policy.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucketpolicy.html", "Properties": { "TableBucketARN": { "MarkdownDocumentation": "`TableBucketARN`\n\nThe Amazon Resource Name (ARN) of the table bucket.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucketpolicy.html#cfn-s3tables-tablebucketpolicy-tablebucketarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nThe bucket policy JSON for the table bucket.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucketpolicy.html#cfn-s3tables-tablebucketpolicy-resourcepolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::S3Tables::TablePolicy": { "MarkdownDocumentation": "`AWS::S3Tables::TablePolicy`\n\nCreates a new maintenance configuration or replaces an existing table policy for a table. For more information, see [Adding a table policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-add) in the *Amazon Simple Storage Service User Guide*.\nPermissions\nYou must have the `s3tables:PutTablePolicy` permission to use this operation.\n\nAWS Cloud Development Kit (AWS CDK)\nTo use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:\n* NPM: `npm i @aws-cdk/aws-s3tables-alpha`\n* Yarn:`yarn add @aws-cdk/aws-s3tables-alpha`\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns some information about your table policy.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html", "Properties": { "TableARN": { "MarkdownDocumentation": "`TableARN`\n\nThe Amazon Resource Name (ARN) of the table.\n*Required*: Yes\n*Type*: String\n*Pattern*: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html#cfn-s3tables-tablepolicy-tablearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourcePolicy": { "MarkdownDocumentation": "`ResourcePolicy`\n\nThe `JSON` that defines the policy.\n*Required*: Yes\n*Type*: Json\n*Minimum*: `1`\n*Maximum*: `20480`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html#cfn-s3tables-tablepolicy-resourcepolicy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } }, "Attributes": { "TableName": { "PrimitiveType": "String", "MarkdownDocumentation": "`TableName`\n\nThe name of the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html#TableName-fn::getatt" }, "TableBucketARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`TableBucketARN`\n\nThe Amazon Resource Name (ARN) of the table bucket that contains the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html#TableBucketARN-fn::getatt" }, "Namespace": { "PrimitiveType": "String", "MarkdownDocumentation": "`Namespace`\n\nThe namespace to associated with the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html#Namespace-fn::getatt" } } }, "AWS::S3Vectors::Index": { "MarkdownDocumentation": "`AWS::S3Vectors::Index`\n\nThe `AWS::S3Vectors::Index` resource defines a vector index within an Amazon S3 vector bucket. For more information, see [Creating a vector index in a vector bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-create-index.html) in the *Amazon Simple Storage Service User Guide*.\nYou must specify either `VectorBucketName` or `VectorBucketArn` to identify the bucket that contains the index.\nTo control how AWS CloudFormation handles the vector index when the stack is deleted, you can set a deletion policy for your index. You can choose to *retain* the index or to *delete* the index. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\nPermissions\nThe required permissions for CloudFormation to use are based on the operations that are performed on the stack.\n* Create\n \n + s3vectors:CreateIndex\n + s3vectors:GetIndex\n* Read\n \n + s3vectors:GetIndex\n* Delete\n \n + s3vectors:DeleteIndex\n + s3vectors:GetIndex\n* List\n \n + s3vectors:ListIndexes\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the index ARN.\nExample: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html", "Properties": { "DistanceMetric": { "MarkdownDocumentation": "`DistanceMetric`\n\nThe distance metric to be used for similarity search. Valid values are:\n* `cosine` - Measures the cosine of the angle between two vectors.\n* `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `cosine | euclidean...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "cosine", "euclidean" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-distancemetric", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IndexName": { "MarkdownDocumentation": "`IndexName`\n\nThe name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.\nIf you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.\n###### Important\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 need to replace the resource, specify a new name.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-indexname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VectorBucketArn": { "MarkdownDocumentation": "`VectorBucketArn`\n\nThe Amazon Resource Name (ARN) of the vector bucket that contains the vector index.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-vectorbucketarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VectorBucketName": { "MarkdownDocumentation": "`VectorBucketName`\n\nThe name of the vector bucket that contains the vector index.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-vectorbucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-s3vectors-index-encryptionconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-encryptionconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EncryptionConfiguration" }, "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `float32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "float32" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-datatype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MetadataConfiguration": { "MarkdownDocumentation": "`MetadataConfiguration`\n\nThe metadata configuration for the vector index.\n*Required*: No\n*Type*: [MetadataConfiguration](./aws-properties-s3vectors-index-metadataconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-metadataconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "MetadataConfiguration" }, "Dimension": { "MarkdownDocumentation": "`Dimension`\n\nThe dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.\nThe dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.\n*Required*: Yes\n*Type*: Integer\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-dimension", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "Integer" } }, "Attributes": { "IndexArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IndexArn`\n\nReturns the Amazon Resource Name (ARN) of the specified index.\nExample: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#IndexArn-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nReturns the date and time when the vector index was created.\nExample: `2024-12-21T10:30:00Z`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#CreationTime-fn::getatt" } } }, "AWS::S3Vectors::VectorBucket": { "MarkdownDocumentation": "`AWS::S3Vectors::VectorBucket`\n\nDefines an Amazon S3 vector bucket in the same AWS Region where you create the AWS CloudFormation stack.\nVector buckets are specialized storage containers designed for storing and managing vector data used in machine learning and AI applications. They provide optimized storage and retrieval capabilities for high-dimensional vector data.\nTo control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n###### Important\nYou can only delete empty vector buckets. Deletion fails for buckets that have contents.\nPermissions\nThe required permissions for CloudFormation to use are based on the operations that are performed on the stack.\n* Create\n \n + s3vectors:CreateVectorBucket\n + s3vectors:GetVectorBucket\n + kms:GenerateDataKey (if using KMS encryption)\n* Read\n \n + s3vectors:GetVectorBucket\n + kms:GenerateDataKey (if using KMS encryption)\n* Delete\n \n + s3vectors:DeleteVectorBucket\n + s3vectors:GetVectorBucket\n + kms:GenerateDataKey (if using KMS encryption)\n* List\n \n + s3vectors:ListVectorBuckets\n + kms:GenerateDataKey (if using KMS encryption)\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the vector bucket name.\nExample: `amzn-s3-demo-vector-bucket`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html", "Properties": { "VectorBucketName": { "MarkdownDocumentation": "`VectorBucketName`\n\nA name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.\nThe bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.\n###### Important\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 need to replace the resource, specify a new name.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#cfn-s3vectors-vectorbucket-vectorbucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nThe encryption configuration for the vector bucket.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#cfn-s3vectors-vectorbucket-encryptionconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EncryptionConfiguration" } }, "Attributes": { "VectorBucketArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`VectorBucketArn`\n\nReturns the Amazon Resource Name (ARN) of the specified vector bucket.\nExample: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#VectorBucketArn-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nReturns the date and time when the vector bucket was created.\nExample: `2024-12-21T10:30:00Z`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#CreationTime-fn::getatt" } } }, "AWS::S3Vectors::VectorBucketPolicy": { "MarkdownDocumentation": "`AWS::S3Vectors::VectorBucketPolicy`\n\nThe `AWS::S3Vectors::VectorBucketPolicy` resource defines an Amazon S3 vector bucket policy to control access to an Amazon S3 vector bucket.\nVector bucket policies are written in JSON and allow you to grant or deny permissions across all (or a subset of) objects within a vector bucket.\nYou must specify either `VectorBucketName` or `VectorBucketArn` to identify the target bucket.\nTo control how AWS CloudFormation handles the vector bucket policy when the stack is deleted, you can set a deletion policy for your policy. You can choose to *retain* the policy or to *delete* the policy. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\nPermissions\nThe required permissions for CloudFormation to use are based on the operations that are performed on the stack.\n* Create\n \n + s3vectors:GetVectorBucketPolicy\n + s3vectors:PutVectorBucketPolicy\n* Read\n \n + s3vectors:GetVectorBucketPolicy\n* Update\n \n + s3vectors:GetVectorBucketPolicy\n + s3vectors:PutVectorBucketPolicy\n* Delete\n \n + s3vectors:GetVectorBucketPolicy\n + s3vectors:DeleteVectorBucketPolicy\n* List\n \n + s3vectors:GetVectorBucketPolicy\n + s3vectors:ListVectorBuckets\n\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the vector bucket ARN.\nExample: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nA policy document containing permissions to add to the specified vector bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "VectorBucketArn": { "MarkdownDocumentation": "`VectorBucketArn`\n\nThe Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-vectorbucketarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VectorBucketName": { "MarkdownDocumentation": "`VectorBucketName`\n\nThe name of the S3 vector bucket to which the policy applies.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucketpolicy.html#cfn-s3vectors-vectorbucketpolicy-vectorbucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SDB::Domain": { "MarkdownDocumentation": "`AWS::SDB::Domain`\n\nUse the `AWS::SDB::Domain` resource to declare a SimpleDB domain.\nWhen you specify `AWS::SDB::Domain` as an argument in a `Ref` function,\nAWS CloudFormation returns the value of the `DomainName`.\n###### Important\nThe `AWS::SDB::Domain` resource does not allow any updates, including\nmetadata updates.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simpledb.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nInformation 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simpledb.html#cfn-sdb-domain-description", "PrimitiveType": "String", "Required": false, "UpdateType": "Mutable" } } }, "AWS::SES::ConfigurationSet": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSet`\n\nConfiguration sets let you create groups of rules that you can apply to the emails you\nsend using Amazon SES. For more information about using configuration sets, see [Using Amazon\nSES Configuration Sets](https://docs.aws.amazon.com/ses/latest/dg/using-configuration-sets.html) in the [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/).\n###### Note\n**Required permissions:**\nTo apply any of the resource options, you will need to have the corresponding\nAWS Identity and Access Management (IAM) SES API v2\npermissions:\n* `ses:GetConfigurationSet`\n \n + (This permission is replacing the v1\n *ses:DescribeConfigurationSet* permission\n which will not work with these v2 resource options.)\n* `ses:PutConfigurationSetDeliveryOptions`\n* `ses:PutConfigurationSetReputationOptions`\n* `ses:PutConfigurationSetSendingOptions`\n* `ses:PutConfigurationSetSuppressionOptions`\n* `ses:PutConfigurationSetTrackingOptions`\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html", "Properties": { "SendingOptions": { "MarkdownDocumentation": "`SendingOptions`\n\nAn object that defines whether or not Amazon SES can send email that you send using the\nconfiguration set.\n*Required*: No\n*Type*: [SendingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-sendingoptions", "UpdateType": "Mutable", "Required": false, "Type": "SendingOptions" }, "SuppressionOptions": { "MarkdownDocumentation": "`SuppressionOptions`\n\nAn object that contains information about the suppression list preferences for your\naccount.\n*Required*: No\n*Type*: [SuppressionOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-suppressionoptions", "UpdateType": "Mutable", "Required": false, "Type": "SuppressionOptions" }, "TrackingOptions": { "MarkdownDocumentation": "`TrackingOptions`\n\nAn object that defines the open and click tracking options for emails that you send\nusing the configuration set.\n*Required*: No\n*Type*: [TrackingOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-trackingoptions", "UpdateType": "Mutable", "Required": false, "Type": "TrackingOptions" }, "ReputationOptions": { "MarkdownDocumentation": "`ReputationOptions`\n\nAn object that defines whether or not Amazon SES collects reputation metrics for the emails\nthat you send that use the configuration set.\n*Required*: No\n*Type*: [ReputationOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-reputationoptions", "UpdateType": "Mutable", "Required": false, "Type": "ReputationOptions" }, "VdmOptions": { "MarkdownDocumentation": "`VdmOptions`\n\nThe Virtual Deliverability Manager (VDM) options that apply to the configuration\nset.\n*Required*: No\n*Type*: [VdmOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-vdmoptions", "UpdateType": "Mutable", "Required": false, "Type": "VdmOptions" }, "DeliveryOptions": { "MarkdownDocumentation": "`DeliveryOptions`\n\nSpecifies the name of the dedicated IP pool to associate with the configuration set\nand whether messages that use the configuration set are required to use Transport Layer\nSecurity (TLS).\n*Required*: No\n*Type*: [DeliveryOptions](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-deliveryoptions", "UpdateType": "Mutable", "Required": false, "Type": "DeliveryOptions" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of objects that define the tags (keys and values) that are associated with\nthe configuration set.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-configurationset-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the configuration set. The name must meet the following\nrequirements:\n* Contain only letters (a-z, A-Z), numbers (0-9), underscores (\\_), or dashes\n (-).\n* Contain 64 characters or fewer.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SES::ConfigurationSetEventDestination": { "MarkdownDocumentation": "`AWS::SES::ConfigurationSetEventDestination`\n\nSpecifies a configuration set event destination. *Events* include\nmessage sends, deliveries, opens, clicks, bounces, and complaints. *Event\ndestinations* are places that you can send information about these events\nto. For example, you can send event data to Amazon SNS to receive notifications when you\nreceive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream\ndata to Amazon S3 for long-term storage.\nA single configuration set can include more than one event destination.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html", "Properties": { "ConfigurationSetName": { "MarkdownDocumentation": "`ConfigurationSetName`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-configurationsetname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EventDestination": { "MarkdownDocumentation": "`EventDestination`\n\nAn object that defines the event destination.\n*Required*: Yes\n*Type*: [EventDestination](./aws-properties-ses-configurationseteventdestination-eventdestination.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-eventdestination", "UpdateType": "Mutable", "Required": true, "Type": "EventDestination" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#Id-fn::getatt" } } }, "AWS::SES::ContactList": { "MarkdownDocumentation": "`AWS::SES::ContactList`\n\nA list that contains contacts that have subscribed to a particular topic or\ntopics.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic Ref function, Ref\nreturns the resource name. For example:\n`{ \"Ref\" : \"ContactListName\" }`\nFor the Amazon SES ContactList, `Ref` returns the name of the contact\nlist.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of what the contact list is about.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html#cfn-ses-contactlist-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Topics": { "MarkdownDocumentation": "`Topics`\n\nAn interest group, theme, or label within a list. A contact list can have multiple\ntopics.\n*Required*: No\n*Type*: Array of [Topic](./aws-properties-ses-contactlist-topic.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html#cfn-ses-contactlist-topics", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Topic", "DuplicatesAllowed": true }, "ContactListName": { "MarkdownDocumentation": "`ContactListName`\n\nThe name of the contact list.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html#cfn-ses-contactlist-contactlistname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with a contact list.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-contactlist-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html#cfn-ses-contactlist-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::SES::DedicatedIpPool": { "MarkdownDocumentation": "`AWS::SES::DedicatedIpPool`\n\nCreate a new pool of dedicated IP addresses. A pool can include one or more dedicated\nIP addresses that are associated with your AWS account. You can\nassociate a pool with a configuration set. When you send an email that uses that\nconfiguration set, the message is sent from one of the addresses in the associated\npool.\n###### Important\nYou can't delete dedicated IP pools that have a `STANDARD` scaling mode\nwith one or more dedicated IP addresses. This constraint doesn't apply to dedicated\nIP pools that have a `MANAGED` scaling mode.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-dedicatedippool.html", "Properties": { "PoolName": { "MarkdownDocumentation": "`PoolName`\n\nThe name of the dedicated IP pool that the IP address is associated with.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-z0-9_-]{0,64}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-dedicatedippool.html#cfn-ses-dedicatedippool-poolname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ScalingMode": { "MarkdownDocumentation": "`ScalingMode`\n\nThe type of scaling mode.\nThe following options are available:\n* `STANDARD` - The customer controls which IPs are part of the\n dedicated IP pool.\n* `MANAGED` - The reputation and number of IPs are automatically\n managed by Amazon SES.\nThe `STANDARD` option is selected by default if no value is\nspecified.\n###### Note\nUpdating *ScalingMode* doesn't require a replacement if you're\nupdating its value from `STANDARD` to `MANAGED`. However,\nupdating *ScalingMode* from `MANAGED` to\n`STANDARD` is not supported.\n*Required*: No\n*Type*: String\n*Pattern*: `^(STANDARD|MANAGED)$`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-dedicatedippool.html#cfn-ses-dedicatedippool-scalingmode", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn object that defines the tags (keys and values) that you want to associate with the\npool.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-dedicatedippool-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-dedicatedippool.html#cfn-ses-dedicatedippool-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::SES::EmailIdentity": { "MarkdownDocumentation": "`AWS::SES::EmailIdentity`\n\nSpecifies an identity for using within SES. An identity is an email address or domain\nthat you use when you send email. Before you can use an identity to send email, you\nfirst have to verify it. By verifying an identity, you demonstrate that you're the owner\nof the identity, and that you've given Amazon SES API v2 permission to send email from\nthe identity.\nWhen you verify an email address, SES sends an email to the address. Your email\naddress is verified as soon as you follow the link in the verification email. When you\nverify a domain without specifying the `DkimSigningAttributes` properties, OR\nonly the `NextSigningKeyLength` property of\n`DkimSigningAttributes`, this resource provides a set of CNAME token\nnames and values (*DkimDNSTokenName1*,\n*DkimDNSTokenValue1*, *DkimDNSTokenName2*,\n*DkimDNSTokenValue2*, *DkimDNSTokenName3*,\n*DkimDNSTokenValue3*) as outputs. You can then add these to the\nDNS configuration for your domain. Your domain is verified when Amazon SES detects these\nrecords in the DNS configuration for your domain. This verification method is known as\nEasy DKIM.\nAlternatively, you can perform the verification process by providing your own\npublic-private key pair. This verification method is known as Bring Your Own DKIM\n(BYODKIM). To use BYODKIM, your resource must include `DkimSigningAttributes`\nproperties `DomainSigningSelector` and `DomainSigningPrivateKey`.\nWhen you specify this object, you provide a selector\n(`DomainSigningSelector`) (a component of the DNS record name that identifies\nthe public key to use for DKIM authentication) and a private key\n(`DomainSigningPrivateKey`).\nAdditionally, you can associate an existing configuration set with the email identity\nthat you're verifying.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html", "Properties": { "ConfigurationSetAttributes": { "MarkdownDocumentation": "`ConfigurationSetAttributes`\n\nUsed to associate a configuration set with an email identity.\n*Required*: No\n*Type*: [ConfigurationSetAttributes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-configurationsetattributes", "UpdateType": "Mutable", "Required": false, "Type": "ConfigurationSetAttributes" }, "EmailIdentity": { "MarkdownDocumentation": "`EmailIdentity`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-emailidentity", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DkimSigningAttributes": { "MarkdownDocumentation": "`DkimSigningAttributes`\n\nIf your request includes this object, Amazon SES configures the identity to use Bring Your\nOwn DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be\nused for [Easy\nDKIM](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html).\nYou can only specify this object if the email identity is a domain, as opposed to an\naddress.\n*Required*: No\n*Type*: [DkimSigningAttributes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimsigningattributes", "UpdateType": "Mutable", "Required": false, "Type": "DkimSigningAttributes" }, "DkimAttributes": { "MarkdownDocumentation": "`DkimAttributes`\n\nAn object that contains information about the DKIM attributes for the identity.\n*Required*: No\n*Type*: [DkimAttributes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimattributes", "UpdateType": "Mutable", "Required": false, "Type": "DkimAttributes" }, "FeedbackAttributes": { "MarkdownDocumentation": "`FeedbackAttributes`\n\nUsed to enable or disable feedback forwarding for an identity.\n*Required*: No\n*Type*: [FeedbackAttributes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-feedbackattributes", "UpdateType": "Mutable", "Required": false, "Type": "FeedbackAttributes" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of objects that define the tags (keys and values) to associate with the email\nidentity.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-emailidentity-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "MailFromAttributes": { "MarkdownDocumentation": "`MailFromAttributes`\n\nUsed to enable or disable the custom Mail-From domain configuration for an email\nidentity.\n*Required*: No\n*Type*: [MailFromAttributes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-mailfromattributes", "UpdateType": "Mutable", "Required": false, "Type": "MailFromAttributes" } }, "Attributes": { "DkimDNSTokenValue1": { "PrimitiveType": "String", "MarkdownDocumentation": "`DkimDNSTokenValue1`\n\nThe record value for the first token that you have to add to the DNS configuration for\nyour domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#DkimDNSTokenValue1-fn::getatt" }, "DkimDNSTokenName2": { "PrimitiveType": "String", "MarkdownDocumentation": "`DkimDNSTokenName2`\n\nThe host name for the second token that you have to add to the DNS configuration for\nyour domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#DkimDNSTokenName2-fn::getatt" }, "DkimDNSTokenName3": { "PrimitiveType": "String", "MarkdownDocumentation": "`DkimDNSTokenName3`\n\nThe host name for the third token that you have to add to the DNS configuration for\nyour domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#DkimDNSTokenName3-fn::getatt" }, "DkimDNSTokenName1": { "PrimitiveType": "String", "MarkdownDocumentation": "`DkimDNSTokenName1`\n\nThe host name for the first token that you have to add to the DNS configuration for\nyour domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#DkimDNSTokenName1-fn::getatt" }, "DkimDNSTokenValue2": { "PrimitiveType": "String", "MarkdownDocumentation": "`DkimDNSTokenValue2`\n\nThe record value for the second token that you have to add to the DNS configuration\nfor your domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#DkimDNSTokenValue2-fn::getatt" }, "DkimDNSTokenValue3": { "PrimitiveType": "String", "MarkdownDocumentation": "`DkimDNSTokenValue3`\n\nThe record value for the third token that you have to add to the DNS configuration for\nyour domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#DkimDNSTokenValue3-fn::getatt" } } }, "AWS::SES::MailManagerAddonInstance": { "MarkdownDocumentation": "`AWS::SES::MailManagerAddonInstance`\n\nCreates an Add On instance for the subscription indicated in the request. The\nresulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddoninstance.html", "Properties": { "AddonSubscriptionId": { "MarkdownDocumentation": "`AddonSubscriptionId`\n\nThe subscription ID for the instance.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^as-[a-zA-Z0-9]{1,64}$`\n*Minimum*: `4`\n*Maximum*: `67`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddoninstance.html#cfn-ses-mailmanageraddoninstance-addonsubscriptionid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-mailmanageraddoninstance-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddoninstance.html#cfn-ses-mailmanageraddoninstance-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "AddonInstanceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AddonInstanceId`\n\nThe unique ID of the Add On instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddoninstance.html#AddonInstanceId-fn::getatt" }, "AddonName": { "PrimitiveType": "String", "MarkdownDocumentation": "`AddonName`\n\nThe name of the Add On for the instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddoninstance.html#AddonName-fn::getatt" }, "AddonInstanceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AddonInstanceArn`\n\nThe Amazon Resource Name (ARN) of the Add On instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddoninstance.html#AddonInstanceArn-fn::getatt" } } }, "AWS::SES::MailManagerAddonSubscription": { "MarkdownDocumentation": "`AWS::SES::MailManagerAddonSubscription`\n\nCreates a subscription for an Add On representing the acceptance of its terms of use\nand additional pricing. The subscription can then be used to create an instance for use\nin rule sets or traffic policies.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddonsubscription.html", "Properties": { "AddonName": { "MarkdownDocumentation": "`AddonName`\n\nThe name of the Add On to subscribe to. You can only have one subscription for each\nAdd On name.\nValid Values: `TRENDMICRO_VSAPI | SPAMHAUS_DBL | ABUSIX_MAIL_INTELLIGENCE |\nVADE_ADVANCED_EMAIL_SECURITY`\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddonsubscription.html#cfn-ses-mailmanageraddonsubscription-addonname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-mailmanageraddonsubscription-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddonsubscription.html#cfn-ses-mailmanageraddonsubscription-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "AddonSubscriptionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AddonSubscriptionId`\n\nThe unique ID of the Add On subscription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddonsubscription.html#AddonSubscriptionId-fn::getatt" }, "AddonSubscriptionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AddonSubscriptionArn`\n\nThe Amazon Resource Name (ARN) of the Add On subscription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddonsubscription.html#AddonSubscriptionArn-fn::getatt" } } }, "AWS::SES::MailManagerAddressList": { "MarkdownDocumentation": "`AWS::SES::MailManagerAddressList`\n\nThe structure representing the address lists and address list attribute that will be used in evaluation of boolean expression.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ID, such as\n*al-3qlenopx5xw66ewlx3phx7jz*.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddresslist.html", "Properties": { "AddressListName": { "MarkdownDocumentation": "`AddressListName`\n\nA user-friendly name for the address list.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddresslist.html#cfn-ses-mailmanageraddresslist-addresslistname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-mailmanageraddresslist-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddresslist.html#cfn-ses-mailmanageraddresslist-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "AddressListArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AddressListArn`\n\nThe Amazon Resource Name (ARN) of the address list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddresslist.html#AddressListArn-fn::getatt" }, "AddressListId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AddressListId`\n\nThe identifier of the address list.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageraddresslist.html#AddressListId-fn::getatt" } } }, "AWS::SES::MailManagerArchive": { "MarkdownDocumentation": "`AWS::SES::MailManagerArchive`\n\nCreates a new email archive resource for storing and retaining emails.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerarchive.html", "Properties": { "KmsKeyArn": { "MarkdownDocumentation": "`KmsKeyArn`\n\nThe Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerarchive.html#cfn-ses-mailmanagerarchive-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ArchiveName": { "MarkdownDocumentation": "`ArchiveName`\n\nA unique name for the new archive.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerarchive.html#cfn-ses-mailmanagerarchive-archivename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Retention": { "MarkdownDocumentation": "`Retention`\n\nThe period for retaining emails in the archive before automatic deletion.\n*Required*: No\n*Type*: [ArchiveRetention](./aws-properties-ses-mailmanagerarchive-archiveretention.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerarchive.html#cfn-ses-mailmanagerarchive-retention", "UpdateType": "Mutable", "Required": false, "Type": "ArchiveRetention" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-mailmanagerarchive-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerarchive.html#cfn-ses-mailmanagerarchive-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ArchiveId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ArchiveId`\n\nThe unique identifier of the archive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerarchive.html#ArchiveId-fn::getatt" }, "ArchiveArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ArchiveArn`\n\nThe Amazon Resource Name (ARN) of the archive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerarchive.html#ArchiveArn-fn::getatt" }, "ArchiveState": { "PrimitiveType": "String", "MarkdownDocumentation": "`ArchiveState`\n\nThe current state of the archive:\n* `ACTIVE` \u2013 The archive is ready and available for use.\n* `PENDING_DELETION` \u2013 The archive has been marked for deletion\n and will be permanently deleted in 30 days. No further modifications can be made\n in this state.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerarchive.html#ArchiveState-fn::getatt" } } }, "AWS::SES::MailManagerIngressPoint": { "MarkdownDocumentation": "`AWS::SES::MailManagerIngressPoint`\n\nResource to provision an ingress endpoint for receiving email. An ingress endpoint\nserves as the entry point for incoming emails, allowing you to define how emails are\nreceived and processed within your AWS environment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html", "Properties": { "RuleSetId": { "MarkdownDocumentation": "`RuleSetId`\n\nThe identifier of an existing rule set that you attach to an ingress endpoint\nresource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#cfn-ses-mailmanageringresspoint-rulesetid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the ingress endpoint to create.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `OPEN | AUTH...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "OPEN", "AUTH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#cfn-ses-mailmanageringresspoint-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TrafficPolicyId": { "MarkdownDocumentation": "`TrafficPolicyId`\n\nThe identifier of an existing traffic policy that you attach to an ingress endpoint\nresource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#cfn-ses-mailmanageringresspoint-trafficpolicyid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "IngressPointName": { "MarkdownDocumentation": "`IngressPointName`\n\nA user friendly name for an ingress endpoint resource.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#cfn-ses-mailmanageringresspoint-ingresspointname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusToUpdate": { "MarkdownDocumentation": "`StatusToUpdate`\n\nThe update status of an ingress endpoint.\n*Required*: No\n*Type*: String\n*Allowed values*: `ACTIVE | CLOSED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ACTIVE", "CLOSED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#cfn-ses-mailmanageringresspoint-statustoupdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NetworkConfiguration": { "MarkdownDocumentation": "`NetworkConfiguration`\n\nThe network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.\n*Required*: No\n*Type*: [NetworkConfiguration](./aws-properties-ses-mailmanageringresspoint-networkconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#cfn-ses-mailmanageringresspoint-networkconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "NetworkConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-mailmanageringresspoint-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#cfn-ses-mailmanageringresspoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "IngressPointConfiguration": { "MarkdownDocumentation": "`IngressPointConfiguration`\n\nThe configuration of the ingress endpoint resource.\n*Required*: No\n*Type*: [IngressPointConfiguration](./aws-properties-ses-mailmanageringresspoint-ingresspointconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#cfn-ses-mailmanageringresspoint-ingresspointconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "IngressPointConfiguration" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the ingress endpoint resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#Status-fn::getatt" }, "ARecord": { "PrimitiveType": "String", "MarkdownDocumentation": "`ARecord`\n\nThe DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#ARecord-fn::getatt" }, "IngressPointId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IngressPointId`\n\nThe identifier of the ingress endpoint resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#IngressPointId-fn::getatt" }, "IngressPointArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IngressPointArn`\n\nThe Amazon Resource Name (ARN) of the ingress endpoint resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html#IngressPointArn-fn::getatt" } } }, "AWS::SES::MailManagerRelay": { "MarkdownDocumentation": "`AWS::SES::MailManagerRelay`\n\nResource to create an SMTP relay, which can be used within a Mail Manager rule set to\nforward incoming emails to defined relay destinations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html", "Properties": { "Authentication": { "MarkdownDocumentation": "`Authentication`\n\nAuthentication for the relay destination server\u2014specify the secretARN where\nthe SMTP credentials are stored.\n*Required*: Yes\n*Type*: [RelayAuthentication](./aws-properties-ses-mailmanagerrelay-relayauthentication.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html#cfn-ses-mailmanagerrelay-authentication", "UpdateType": "Mutable", "Required": true, "Type": "RelayAuthentication" }, "ServerName": { "MarkdownDocumentation": "`ServerName`\n\nThe destination relay server address.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-\\.]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html#cfn-ses-mailmanagerrelay-servername", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RelayName": { "MarkdownDocumentation": "`RelayName`\n\nThe unique relay name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html#cfn-ses-mailmanagerrelay-relayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerPort": { "MarkdownDocumentation": "`ServerPort`\n\nThe destination relay server port.\n*Required*: Yes\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html#cfn-ses-mailmanagerrelay-serverport", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Double" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-mailmanagerrelay-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html#cfn-ses-mailmanagerrelay-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "RelayId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RelayId`\n\nThe unique relay identifier.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html#RelayId-fn::getatt" }, "RelayArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RelayArn`\n\nThe Amazon Resource Name (ARN) of the relay.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html#RelayArn-fn::getatt" } } }, "AWS::SES::MailManagerRuleSet": { "MarkdownDocumentation": "`AWS::SES::MailManagerRuleSet`\n\nResource to create a rule set for a Mail Manager ingress endpoint which contains a\nlist of rules that are evaluated sequentially for each email.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html", "Properties": { "RuleSetName": { "MarkdownDocumentation": "`RuleSetName`\n\nA user-friendly name for the rule set.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html#cfn-ses-mailmanagerruleset-rulesetname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nConditional rules that are evaluated for determining actions on email.\n*Required*: Yes\n*Type*: Array of [Rule](./aws-properties-ses-mailmanagerruleset-rule.html)\n*Minimum*: `0`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html#cfn-ses-mailmanagerruleset-rules", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-mailmanagerruleset-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html#cfn-ses-mailmanagerruleset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "RuleSetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleSetId`\n\nThe identifier of the rule set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html#RuleSetId-fn::getatt" }, "RuleSetArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleSetArn`\n\nThe Amazon Resource Name (ARN) of the rule set resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html#RuleSetArn-fn::getatt" } } }, "AWS::SES::MailManagerTrafficPolicy": { "MarkdownDocumentation": "`AWS::SES::MailManagerTrafficPolicy`\n\nResource to create a traffic policy for a Mail Manager ingress endpoint which contains\npolicy statements used to evaluate whether incoming emails should be allowed or\ndenied.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagertrafficpolicy.html", "Properties": { "DefaultAction": { "MarkdownDocumentation": "`DefaultAction`\n\nDefault action instructs the tra\ufb03c policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALLOW | DENY...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALLOW", "DENY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagertrafficpolicy.html#cfn-ses-mailmanagertrafficpolicy-defaultaction", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyStatements": { "MarkdownDocumentation": "`PolicyStatements`\n\nConditional statements for filtering email traffic.\n*Required*: Yes\n*Type*: Array of [PolicyStatement](./aws-properties-ses-mailmanagertrafficpolicy-policystatement.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagertrafficpolicy.html#cfn-ses-mailmanagertrafficpolicy-policystatements", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "PolicyStatement", "DuplicatesAllowed": true }, "TrafficPolicyName": { "MarkdownDocumentation": "`TrafficPolicyName`\n\nThe name of the policy.\nThe policy name cannot exceed 64 characters and can only include alphanumeric\ncharacters, dashes, and underscores.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_\\-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagertrafficpolicy.html#cfn-ses-mailmanagertrafficpolicy-trafficpolicyname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxMessageSizeBytes": { "MarkdownDocumentation": "`MaxMessageSizeBytes`\n\nThe maximum message size in bytes of email which is allowed in by this traffic\npolicy\u2014anything larger will be blocked.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagertrafficpolicy.html#cfn-ses-mailmanagertrafficpolicy-maxmessagesizebytes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-mailmanagertrafficpolicy-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagertrafficpolicy.html#cfn-ses-mailmanagertrafficpolicy-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "TrafficPolicyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrafficPolicyId`\n\nThe identifier of the traffic policy resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagertrafficpolicy.html#TrafficPolicyId-fn::getatt" }, "TrafficPolicyArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrafficPolicyArn`\n\nThe Amazon Resource Name (ARN) of the traffic policy resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagertrafficpolicy.html#TrafficPolicyArn-fn::getatt" } } }, "AWS::SES::MultiRegionEndpoint": { "MarkdownDocumentation": "`AWS::SES::MultiRegionEndpoint`\n\nCreates a multi-region endpoint (global-endpoint).\nThe primary region is going to be the AWS-Region where the operation is executed.\nThe secondary region has to be provided in request's parameters.\nFrom the data flow standpoint there is no difference between primary\nand secondary regions - sending traffic will be split equally between the two.\nThe primary region is the region where the resource has been created and where it can be managed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-multiregionendpoint.html", "Properties": { "Details": { "MarkdownDocumentation": "`Details`\n\nContains details of a multi-region endpoint (global-endpoint) being created.\n*Required*: Yes\n*Type*: [Details](./aws-properties-ses-multiregionendpoint-details.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-multiregionendpoint.html#cfn-ses-multiregionendpoint-details", "UpdateType": "Immutable", "Required": true, "Type": "Details" }, "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nThe name of the multi-region endpoint (global-endpoint).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-multiregionendpoint.html#cfn-ses-multiregionendpoint-endpointname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of objects that define the tags (keys and values) to associate with the multi-region endpoint (global-endpoint).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-multiregionendpoint-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-multiregionendpoint.html#cfn-ses-multiregionendpoint-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } } }, "AWS::SES::ReceiptFilter": { "MarkdownDocumentation": "`AWS::SES::ReceiptFilter`\n\nSpecify a new IP address filter. You use IP address filters when you receive email\nwith Amazon SES.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptfilter.html", "Properties": { "Filter": { "Type": "Filter", "Required": true, "MarkdownDocumentation": "`Filter`\n\nA data structure that describes the IP address filter to create, which consists of a\nname, an IP address range, and whether to allow or block mail from it.\n*Required*: Yes\n*Type*: [Filter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptfilter.html#cfn-ses-receiptfilter-filter", "UpdateType": "Immutable" } } }, "AWS::SES::ReceiptRule": { "MarkdownDocumentation": "`AWS::SES::ReceiptRule`\n\nSpecifies a receipt rule.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html", "Properties": { "After": { "Required": false, "MarkdownDocumentation": "`After`\n\nThe name of an existing rule after which the new rule is placed. If this parameter is\nnull, the new rule is inserted at the beginning of the rule 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-after", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Rule": { "Type": "Rule", "Required": true, "MarkdownDocumentation": "`Rule`\n\nA data structure that contains the specified rule's name, actions, recipients,\ndomains, enabled status, scan status, and TLS policy.\n*Required*: Yes\n*Type*: [Rule](./aws-properties-ses-receiptrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rule", "UpdateType": "Mutable" }, "RuleSetName": { "Required": true, "MarkdownDocumentation": "`RuleSetName`\n\nThe name of the rule set where the receipt rule is added.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rulesetname", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SES::ReceiptRuleSet": { "MarkdownDocumentation": "`AWS::SES::ReceiptRuleSet`\n\nCreates an empty receipt rule set.\nFor information about setting up receipt rule sets, see the [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules).\nYou can execute this operation no more than once per second.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html", "Properties": { "RuleSetName": { "Required": false, "MarkdownDocumentation": "`RuleSetName`\n\nThe name of the receipt rule set to make active. Setting this value to null disables\nall email receiving.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html#cfn-ses-receiptruleset-rulesetname", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::SES::Template": { "MarkdownDocumentation": "`AWS::SES::Template`\n\nSpecifies an email template. Email templates enable you to send personalized email to\none or more destinations in a single API operation.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html", "Properties": { "Template": { "MarkdownDocumentation": "`Template`\n\nThe content of the email, composed of a subject line and either an HTML part or a\ntext-only part.\n*Required*: No\n*Type*: [Template](./aws-properties-ses-template-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html#cfn-ses-template-template", "UpdateType": "Mutable", "Required": false, "Type": "Template" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html#Id-fn::getatt" } } }, "AWS::SES::Tenant": { "MarkdownDocumentation": "`AWS::SES::Tenant`\n\nCreate a tenant.\n*Tenants* are logical containers that group related SES resources together.\nEach tenant can have its own set of resources like email identities, configuration sets,\nand templates, along with reputation metrics and sending status. This helps isolate and manage\nemail sending for different customers or business units within your Amazon SES API v2 account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-tenant.html", "Properties": { "ResourceAssociations": { "MarkdownDocumentation": "`ResourceAssociations`\n\nThe list of resources to associate with the tenant.\n*Required*: No\n*Type*: Array of [ResourceAssociation](./aws-properties-ses-tenant-resourceassociation.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-tenant.html#cfn-ses-tenant-resourceassociations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ResourceAssociation", "DuplicatesAllowed": true }, "TenantName": { "MarkdownDocumentation": "`TenantName`\n\nThe name of a tenant. The name can contain up to 64 alphanumeric characters, including\nletters, numbers, hyphens (-) and underscores (\\_) only.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\-_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-tenant.html#cfn-ses-tenant-tenantname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of objects that define the tags (keys and values) associated with the tenant.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ses-tenant-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-tenant.html#cfn-ses-tenant-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the tenant.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-tenant.html#Arn-fn::getatt" } } }, "AWS::SES::VdmAttributes": { "MarkdownDocumentation": "`AWS::SES::VdmAttributes`\n\nThe Virtual Deliverability Manager (VDM) attributes that apply to your Amazon SES account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-vdmattributes.html", "Properties": { "DashboardAttributes": { "MarkdownDocumentation": "`DashboardAttributes`\n\nSpecifies additional settings for your VDM configuration as applicable to the\nDashboard.\n*Required*: No\n*Type*: [DashboardAttributes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-vdmattributes.html#cfn-ses-vdmattributes-dashboardattributes", "UpdateType": "Mutable", "Required": false, "Type": "DashboardAttributes" }, "GuardianAttributes": { "MarkdownDocumentation": "`GuardianAttributes`\n\nSpecifies additional settings for your VDM configuration as applicable to the\nGuardian.\n*Required*: No\n*Type*: [GuardianAttributes](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-vdmattributes.html#cfn-ses-vdmattributes-guardianattributes", "UpdateType": "Mutable", "Required": false, "Type": "GuardianAttributes" } }, "Attributes": { "VdmAttributesResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VdmAttributesResourceId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-vdmattributes.html#VdmAttributesResourceId-fn::getatt" } } }, "AWS::SMSVOICE::ConfigurationSet": { "MarkdownDocumentation": "`AWS::SMSVOICE::ConfigurationSet`\n\nCreates a new configuration set. After you create the configuration set, you can add\none or more event destinations to it.\nA configuration set is a set of rules that you apply to the SMS and voice messages\nthat you send.\nWhen you send a message, you can optionally specify a single configuration set.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`ConfigurationSetName`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html", "Properties": { "EventDestinations": { "MarkdownDocumentation": "`EventDestinations`\n\nAn array of EventDestination objects that describe any events to log and where to log\nthem.\n*Required*: No\n*Type*: Array of [EventDestination](./aws-properties-smsvoice-configurationset-eventdestination.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-eventdestinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "EventDestination", "DuplicatesAllowed": true }, "MessageFeedbackEnabled": { "MarkdownDocumentation": "`MessageFeedbackEnabled`\n\nSet to true to enable feedback for the 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-messagefeedbackenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ConfigurationSetName": { "MarkdownDocumentation": "`ConfigurationSetName`\n\nThe name of the ConfigurationSet.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-configurationsetname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DefaultSenderId": { "MarkdownDocumentation": "`DefaultSenderId`\n\nThe default sender ID used by the ConfigurationSet.\n*Required*: No\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-defaultsenderid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProtectConfigurationId": { "MarkdownDocumentation": "`ProtectConfigurationId`\n\nThe unique identifier for the protect configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_:/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-protectconfigurationid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key and value pair tags that's associated with the new configuration set.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-smsvoice-configurationset-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the ConfigurationSet.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#Arn-fn::getatt" } } }, "AWS::SMSVOICE::OptOutList": { "MarkdownDocumentation": "`AWS::SMSVOICE::OptOutList`\n\nCreates a new opt-out list.\nIf the opt-out list name already exists, an error is returned.\nAn opt-out list is a list of phone numbers that are opted out, meaning you can't send\nSMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for\nthe phone number is added to the opt-out list. In addition to STOP, your recipients can\nuse any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported\nopt-out keywords, see [SMS opt out](https://docs.aws.amazon.com/sms-voice/latest/userguide/opt-out-list-keywords.html) in the AWS End User Messaging SMS User Guide.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`OptOutListName`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html", "Properties": { "OptOutListName": { "MarkdownDocumentation": "`OptOutListName`\n\nThe name of the OptOutList.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html#cfn-smsvoice-optoutlist-optoutlistname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tags (key and value pairs) to associate with the new OptOutList.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-smsvoice-optoutlist-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html#cfn-smsvoice-optoutlist-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) for the `OptOutList`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html#Arn-fn::getatt" } } }, "AWS::SMSVOICE::PhoneNumber": { "MarkdownDocumentation": "`AWS::SMSVOICE::PhoneNumber`\n\nRequest an origination phone number for use in your account. For more information on\nphone number request see [Request a phone number](https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-request.html) in the *AWS End User Messaging SMS\nUser Guide*.\n###### Note\nRegistering phone numbers is not supported by AWS CloudFormation. You can import phone numbers and sender IDs that are automatically provisioned at registration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`PhoneNumberId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html", "Properties": { "OptOutListName": { "MarkdownDocumentation": "`OptOutListName`\n\nThe name of the OptOutList associated with the phone number.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_:/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optoutlistname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelfManagedOptOutsEnabled": { "MarkdownDocumentation": "`SelfManagedOptOutsEnabled`\n\nWhen set to false and an end recipient sends a message that begins with HELP or STOP to\none of your dedicated numbers, AWS End User Messaging SMS automatically replies with a\ncustomizable message and adds the end recipient to the OptOutList. When set to true\nyou're responsible for responding to HELP and STOP requests. You're also responsible for\ntracking and honoring opt-out request. For more information see [Self-managed opt-outs](https://docs.aws.amazon.com/sms-voice/latest/userguide/opt-out-list-self-managed.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-selfmanagedoptoutsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NumberType": { "MarkdownDocumentation": "`NumberType`\n\nThe type of phone number to request.\n###### Note\nThe `ShortCode` number type is not supported in AWS CloudFormation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `LONG_CODE | TOLL_FREE | TEN...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "LONG_CODE", "TOLL_FREE", "TEN_DLC", "SIMULATOR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbertype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TwoWay": { "MarkdownDocumentation": "`TwoWay`\n\nDescribes the two-way SMS configuration for a phone number. For more information, see\n[Two-way SMS messaging](https://docs.aws.amazon.com/sms-voice/latest/userguide/two-way-sms.html) in the AWS End User Messaging SMS User Guide.\n*Required*: No\n*Type*: [TwoWay](./aws-properties-smsvoice-phonenumber-twoway.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-twoway", "UpdateType": "Mutable", "Required": false, "Type": "TwoWay" }, "NumberCapabilities": { "MarkdownDocumentation": "`NumberCapabilities`\n\nIndicates if the phone number will be used for text messages, voice messages, or both.\n*Required*: Yes\n*Type*: Array of String\n*Allowed values*: `SMS | VOICE | MMS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SMS", "VOICE", "MMS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbercapabilities", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "MandatoryKeywords": { "MarkdownDocumentation": "`MandatoryKeywords`\n\nCreates or updates a `MandatoryKeyword` configuration on an origination phone number For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n*Required*: Yes\n*Type*: [MandatoryKeywords](./aws-properties-smsvoice-phonenumber-mandatorykeywords.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-mandatorykeywords", "UpdateType": "Mutable", "Required": true, "Type": "MandatoryKeywords" }, "OptionalKeywords": { "MarkdownDocumentation": "`OptionalKeywords`\n\nA keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that\nan end user can send to your number to elicit a response, such as an informational message or a special offer. When your number\nreceives a message that begins with a keyword, AWS End User Messaging SMS responds with a customizable message. Optional keywords are differentiated from\nmandatory keywords. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n*Required*: No\n*Type*: Array of [OptionalKeyword](./aws-properties-smsvoice-phonenumber-optionalkeyword.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optionalkeywords", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OptionalKeyword", "DuplicatesAllowed": false }, "DeletionProtectionEnabled": { "MarkdownDocumentation": "`DeletionProtectionEnabled`\n\nBy default this is set to false. When set to true the phone number can't be\ndeleted.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-deletionprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IsoCountryCode": { "MarkdownDocumentation": "`IsoCountryCode`\n\nThe two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z]{2}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-isocountrycode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tags (key and value pairs) to associate with the requested phone number.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-smsvoice-phonenumber-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "PhoneNumber": { "PrimitiveType": "String", "MarkdownDocumentation": "`PhoneNumber`\n\nThe phone number in E.164 format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#PhoneNumber-fn::getatt" }, "PhoneNumberId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PhoneNumberId`\n\nThe unique identifier for the phone number.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#PhoneNumberId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe `PhoneNumber`'s Amazon Resource Name (ARN)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#Arn-fn::getatt" } } }, "AWS::SMSVOICE::Pool": { "MarkdownDocumentation": "`AWS::SMSVOICE::Pool`\n\nCreates a new pool and associates the specified origination identity to the pool. A\npool can include one or more phone numbers and SenderIds that are associated with your\nAWS account.\nThe new pool inherits its configuration from the specified origination identity. This\nincludes keywords, message type, opt-out list, two-way configuration, and self-managed\nopt-out configuration. Deletion protection isn't inherited from the origination identity\nand defaults to false.\nIf the origination identity is a phone number and is already associated with another\npool, an error is returned. A sender ID can be associated with multiple pools.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`PoolId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html", "Properties": { "OptOutListName": { "MarkdownDocumentation": "`OptOutListName`\n\nThe name of the OptOutList associated with the pool.\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9_:/-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-optoutlistname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SelfManagedOptOutsEnabled": { "MarkdownDocumentation": "`SelfManagedOptOutsEnabled`\n\nWhen set to false, an end recipient sends a message that begins with HELP or STOP to\none of your dedicated numbers, AWS End User Messaging SMS automatically replies with a\ncustomizable message and adds the end recipient to the OptOutList. When set to true\nyou're responsible for responding to HELP and STOP requests. You're also responsible for\ntracking and honoring opt-out requests. For more information see [Self-managed opt-outs](https://docs.aws.amazon.com//pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-selfmanagedoptoutsenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "SharedRoutesEnabled": { "MarkdownDocumentation": "`SharedRoutesEnabled`\n\nAllows you to enable shared routes on your pool.\nBy default, this is set to `False`. If you set this value to\n`True`, your messages are sent using phone numbers or sender IDs\n(depending on the country) that are shared with other users. In some\ncountries, such as the United States, senders aren't allowed to use shared routes and\nmust use a dedicated phone number or short code.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-sharedroutesenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "OriginationIdentities": { "MarkdownDocumentation": "`OriginationIdentities`\n\nThe list of origination identities to apply to the pool, either `PhoneNumberArn` or\n`SenderIdArn`. For more information, see [Registrations](https://docs.aws.amazon.com/sms-voice/latest/userguide/registrations.html)\nin the AWS End User Messaging SMS User Guide.\n###### Important\nIf you are using a shared AWS End User Messaging SMS resource then you must use the full Amazon Resource Name (ARN).\n*Required*: Yes\n*Type*: Array of String\n*Maximum*: `256`\n*Minimum*: `20 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-originationidentities", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "TwoWay": { "MarkdownDocumentation": "`TwoWay`\n\nDescribes the two-way SMS configuration for a phone number. For more information, see\n[Two-way SMS messaging](https://docs.aws.amazon.com/sms-voice/latest/userguide/two-way-sms.html) in the AWS End User Messaging SMS User Guide.\n*Required*: No\n*Type*: [TwoWay](./aws-properties-smsvoice-pool-twoway.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-twoway", "UpdateType": "Mutable", "Required": false, "Type": "TwoWay" }, "MandatoryKeywords": { "MarkdownDocumentation": "`MandatoryKeywords`\n\nCreates or updates the pool's `MandatoryKeyword` configuration. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n*Required*: Yes\n*Type*: [MandatoryKeywords](./aws-properties-smsvoice-pool-mandatorykeywords.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-mandatorykeywords", "UpdateType": "Mutable", "Required": true, "Type": "MandatoryKeywords" }, "OptionalKeywords": { "MarkdownDocumentation": "`OptionalKeywords`\n\nSpecifies any optional keywords to associate with the pool. For more information, see\n[Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the AWS End User Messaging SMS User Guide.\n*Required*: No\n*Type*: Array of [OptionalKeyword](./aws-properties-smsvoice-pool-optionalkeyword.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-optionalkeywords", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "OptionalKeyword", "DuplicatesAllowed": false }, "DeletionProtectionEnabled": { "MarkdownDocumentation": "`DeletionProtectionEnabled`\n\nWhen set to true the pool can't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-deletionprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tags (key and value pairs) associated with the pool.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-smsvoice-pool-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "PoolId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PoolId`\n\nThe unique identifier for the pool.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#PoolId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name of the `Pool`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#Arn-fn::getatt" } } }, "AWS::SMSVOICE::ProtectConfiguration": { "MarkdownDocumentation": "`AWS::SMSVOICE::ProtectConfiguration`\n\nCreate a new protect configuration. By default all country rule sets for each capability are set to `ALLOW`.\nA protect configurations name is stored as a Tag with the key set to `Name` and value as the name of the protect configuration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`ProtectConfigurationId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-protectconfiguration.html", "Properties": { "CountryRuleSet": { "MarkdownDocumentation": "`CountryRuleSet`\n\nThe set of `CountryRules` you specify to control which countries AWS End User Messaging SMS can send your messages to.\n*Required*: No\n*Type*: [CountryRuleSet](./aws-properties-smsvoice-protectconfiguration-countryruleset.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-protectconfiguration.html#cfn-smsvoice-protectconfiguration-countryruleset", "UpdateType": "Mutable", "Required": false, "Type": "CountryRuleSet" }, "DeletionProtectionEnabled": { "MarkdownDocumentation": "`DeletionProtectionEnabled`\n\nThe status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-protectconfiguration.html#cfn-smsvoice-protectconfiguration-deletionprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key and value pair tags that are associated with the resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-smsvoice-protectconfiguration-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-protectconfiguration.html#cfn-smsvoice-protectconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the protect configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-protectconfiguration.html#Arn-fn::getatt" }, "ProtectConfigurationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProtectConfigurationId`\n\nThe unique identifier for the protect configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-protectconfiguration.html#ProtectConfigurationId-fn::getatt" } } }, "AWS::SMSVOICE::ResourcePolicy": { "MarkdownDocumentation": "`AWS::SMSVOICE::ResourcePolicy`\n\nAttaches a resource-based policy to a AWS End User Messaging SMS resource(phone number, sender Id, phone poll, or opt-out list) that is used for\nsharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about\nresource-based policies, see [Working with shared resources](https://docs.aws.amazon.com/sms-voice/latest/userguide/shared-resources.html) in the *AWS End User Messaging SMS User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns\n`ResourceArn`\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-resourcepolicy.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the AWS End User Messaging SMS resource attached to the resource-based policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:\\S+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-resourcepolicy.html#cfn-smsvoice-resourcepolicy-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe JSON formatted resource-based policy to attach.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-resourcepolicy.html#cfn-smsvoice-resourcepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::SMSVOICE::SenderId": { "MarkdownDocumentation": "`AWS::SMSVOICE::SenderId`\n\nRequest a new sender ID that doesn't require registration.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`IsoCountryCode|SenderId`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-senderid.html", "Properties": { "SenderId": { "MarkdownDocumentation": "`SenderId`\n\nThe sender ID string to request.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-senderid.html#cfn-smsvoice-senderid-senderid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeletionProtectionEnabled": { "MarkdownDocumentation": "`DeletionProtectionEnabled`\n\nBy default this is set to false. When set to true the sender ID can't 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-senderid.html#cfn-smsvoice-senderid-deletionprotectionenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "IsoCountryCode": { "MarkdownDocumentation": "`IsoCountryCode`\n\nThe two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Z]{2}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-senderid.html#cfn-smsvoice-senderid-isocountrycode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of tags (key and value pairs) to associate with the sender ID.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-smsvoice-senderid-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-senderid.html#cfn-smsvoice-senderid-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name of the `SenderId`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-senderid.html#Arn-fn::getatt" } } }, "AWS::SNS::Subscription": { "MarkdownDocumentation": "`AWS::SNS::Subscription`\n\nThe `AWS::SNS::Subscription` resource subscribes an endpoint to an Amazon SNS topic. For a subscription to be created, the owner of the endpoint must`\nconfirm the subscription.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the subscription's logical name. This attribute allows you to\nreference the logical name of the subscription resource within the CloudFormation\ntemplate.\nFor example, if you have a subscription resource named 'MySubscription', you can use\n'!Ref MySubscription' to refer to its logical name in other parts of the CloudFormation\ntemplate.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html", "Properties": { "ReplayPolicy": { "MarkdownDocumentation": "`ReplayPolicy`\n\nSpecifies whether Amazon SNS resends the notification to the subscription when a\nmessage's attribute changes.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-replaypolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "RawMessageDelivery": { "MarkdownDocumentation": "`RawMessageDelivery`\n\nWhen set to `true`, enables raw message delivery. Raw messages don't contain\nany JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more\ninformation, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Endpoint": { "MarkdownDocumentation": "`Endpoint`\n\nThe subscription's endpoint. The endpoint value depends on the protocol that you\nspecify. 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-endpoint", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "FilterPolicy": { "MarkdownDocumentation": "`FilterPolicy`\n\nThe filter policy JSON assigned to the subscription. Enables the subscriber to filter\nout 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TopicArn": { "MarkdownDocumentation": "`TopicArn`\n\nThe ARN of the topic to subscribe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-topicarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "RedrivePolicy": { "MarkdownDocumentation": "`RedrivePolicy`\n\nWhen specified, sends undeliverable messages to the specified Amazon SQS\ndead-letter queue. Messages that can't be delivered due to client errors (for example, when\nthe subscribed endpoint is unreachable) or server errors (for example, when the service\nthat powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue\nfor further analysis or reprocessing.\nFor more information about the redrive policy and dead-letter queues, see [Amazon\nSQS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DeliveryPolicy": { "MarkdownDocumentation": "`DeliveryPolicy`\n\nThe delivery policy JSON assigned to the subscription. Enables the subscriber to define\nthe message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the\ntopic. 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)\nin 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "Region": { "MarkdownDocumentation": "`Region`\n\nFor cross-region subscriptions, the region in which the topic resides.\nIf no region is specified, CloudFormation uses the region of the caller as the\ndefault.\nIf you perform an update operation that only updates the `Region` property of\na `AWS::SNS::Subscription` resource, that operation will fail unless you are\neither:\n* Updating the `Region` from `NULL` to the caller\n region.\n* Updating the `Region` from the caller region to\n `NULL`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "SubscriptionRoleArn": { "MarkdownDocumentation": "`SubscriptionRoleArn`\n\nThis property applies only to Amazon Data Firehose delivery stream subscriptions.\nSpecify the ARN of the IAM role that has the following:\n* Permission to write to the Amazon Data Firehose delivery stream\n* Amazon SNS listed as a trusted entity\nSpecifying a valid ARN for this attribute is required for Firehose delivery\nstream subscriptions. For more information, see [Fanout to Amazon Data Firehose\ndelivery streams](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the *Amazon SNS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FilterPolicyScope": { "MarkdownDocumentation": "`FilterPolicyScope`\n\nThis attribute lets you choose the filtering scope by using one of the following string\nvalue types:\n* `MessageAttributes` (default) - The filter is applied on the message\n attributes.\n* `MessageBody` - The filter is applied on the message body.\n###### Note\n`Null` is not a valid value for `FilterPolicyScope`. To delete a\nfilter policy, delete the `FilterPolicy` property but keep\n`FilterPolicyScope` property as 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe subscription's protocol. For more information, see the `Protocol`\nparameter 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-protocol", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the subscription created by the `AWS::SNS::Subscription`\nresource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#Arn-fn::getatt" } } }, "AWS::SNS::Topic": { "MarkdownDocumentation": "`AWS::SNS::Topic`\n\nThe `AWS::SNS::Topic` resource creates a topic to which notifications can be\npublished.\n###### Note\nOne account can create a maximum of 100,000 standard topics and 1,000 FIFO topics.\nFor more information, see [Amazon SNS endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *AWS General Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the topic ARN, for example:\n`arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html", "Properties": { "KmsMasterKeyId": { "MarkdownDocumentation": "`KmsMasterKeyId`\n\nThe ID of an AWS managed customer master key (CMK) for Amazon SNS\nor 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\nmore 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-kmsmasterkeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TracingConfig": { "MarkdownDocumentation": "`TracingConfig`\n\nTracing mode of an Amazon SNS topic. By default `TracingConfig` is\nset to `PassThrough`, and the topic passes through the tracing header it\nreceives from an Amazon SNS publisher to its subscriptions. If set to\n`Active`, Amazon SNS will vend X-Ray segment data to topic owner\naccount if the sampled flag in the tracing header is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tracingconfig", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FifoTopic": { "MarkdownDocumentation": "`FifoTopic`\n\nSet 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-fifotopic", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "DataProtectionPolicy": { "MarkdownDocumentation": "`DataProtectionPolicy`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-dataprotectionpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TopicName": { "MarkdownDocumentation": "`TopicName`\n\nThe name of the topic you want to create. Topic names must include only uppercase and\nlowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256\ncharacters long. FIFO topic names must end with `.fifo`.\nIf you don't specify a name, CloudFormation generates a unique physical ID and uses\nthat ID for the topic name. For more information, see [Name\ntype](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n###### Important\nIf you specify a name, you can't perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must\nreplace 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-topicname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SignatureVersion": { "MarkdownDocumentation": "`SignatureVersion`\n\nThe signature version corresponds to the hashing algorithm used while creating the\nsignature of the notifications, subscription confirmations, or unsubscribe confirmation\nmessages sent by Amazon SNS. By default, `SignatureVersion` is set to\n`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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-signatureversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DeliveryStatusLogging": { "MarkdownDocumentation": "`DeliveryStatusLogging`\n\nThe `DeliveryStatusLogging` configuration enables you to log the delivery\nstatus of messages sent from your Amazon SNS topic to subscribed endpoints with the\nfollowing supported delivery protocols:\n* HTTP\n* Amazon Kinesis Data Firehose\n* AWS Lambda\n* Platform application endpoint\n* Amazon Simple Queue Service\nOnce configured, log entries are sent to Amazon CloudWatch Logs.\n*Required*: No\n*Type*: Array of [LoggingConfig](./aws-properties-sns-topic-loggingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-deliverystatuslogging", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LoggingConfig", "DuplicatesAllowed": false }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe display name to use for an Amazon SNS topic with SMS subscriptions. The\ndisplay name must be maximum 100 characters long, including hyphens (-), underscores (\\_),\nspaces, 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentBasedDeduplication": { "MarkdownDocumentation": "`ContentBasedDeduplication`\n\n`ContentBasedDeduplication` enables deduplication of messages based on their\ncontent for FIFO topics. By default, this property is set to false. If you create a FIFO\ntopic with `ContentBasedDeduplication` set to false, you must provide a\n`MessageDeduplicationId` for each `Publish` action. When set to\ntrue, Amazon SNS automatically generates a `MessageDeduplicationId`\nusing a SHA-256 hash of the message body (excluding message attributes). You can optionally\noverride this generated value by specifying a `MessageDeduplicationId` in the\n`Publish` action. Note that this property only applies to FIFO topics; using\nit with standard topics will cause the creation to 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-contentbaseddeduplication", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Subscription": { "MarkdownDocumentation": "`Subscription`\n\nThe Amazon SNS subscriptions (endpoints) for this topic.\n###### Important\nIf you specify the `Subscription` property in the\n`AWS::SNS::Topic` resource and it creates an associated subscription\nresource, the associated subscription is not deleted when the\n`AWS::SNS::Topic` resource is deleted.\n*Required*: No\n*Type*: [Array](./aws-properties-sns-topic-subscription.html) of [Subscription](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-subscription", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Subscription", "DuplicatesAllowed": true }, "FifoThroughputScope": { "MarkdownDocumentation": "`FifoThroughputScope`\n\nSpecifies the throughput quota and deduplication behavior to apply for the FIFO topic.\nValid values are `Topic` or `MessageGroup`.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-fifothroughputscope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of tags to add to a new topic.\n###### Note\nTo be able to tag a topic on creation, you must have the\n`sns:CreateTopic` and `sns:TagResource`\npermissions.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sns-topic-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ArchivePolicy": { "MarkdownDocumentation": "`ArchivePolicy`\n\nThe `ArchivePolicy` determines the number of days Amazon SNS retains\nmessages in FIFO topics. You can set a retention period ranging from 1 to 365 days. This\nproperty is only applicable to FIFO topics; attempting to use it with standard topics will\nresult in a creation failure.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-archivepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" } }, "Attributes": { "TopicArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TopicArn`\n\nReturns the ARN of an Amazon SNS topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#TopicArn-fn::getatt" }, "TopicName": { "PrimitiveType": "String", "MarkdownDocumentation": "`TopicName`\n\nReturns the name of an Amazon SNS topic.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#TopicName-fn::getatt" } } }, "AWS::SNS::TopicInlinePolicy": { "MarkdownDocumentation": "`AWS::SNS::TopicInlinePolicy`\n\nThe `AWS::SNS::TopicInlinePolicy` resource associates one Amazon SNS\ntopic with one policy.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the topic for which the policy was added.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicinlinepolicy.html", "Properties": { "TopicArn": { "MarkdownDocumentation": "`TopicArn`\n\nThe Amazon Resource Name (ARN) of the topic to which you want to add the policy.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicinlinepolicy.html#cfn-sns-topicinlinepolicy-topicarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA policy document that contains permissions to add to the specified Amazon SNS\ntopic.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicinlinepolicy.html#cfn-sns-topicinlinepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } } }, "AWS::SNS::TopicPolicy": { "MarkdownDocumentation": "`AWS::SNS::TopicPolicy`\n\nThe `AWS::SNS::TopicPolicy` resource associates Amazon SNS topics\nwith a policy. For an example snippet, see [Declaring\nan Amazon SNS policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *CloudFormation User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html", "Properties": { "Topics": { "MarkdownDocumentation": "`Topics`\n\nThe Amazon Resource Names (ARN) of the topics to which you want to add the policy. You\ncan use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html)` resource.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html#cfn-sns-topicpolicy-topics", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html#cfn-sns-topicpolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe provider-assigned unique ID for this managed resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html#Id-fn::getatt" } } }, "AWS::SQS::Queue": { "MarkdownDocumentation": "`AWS::SQS::Queue`\n\nThe `AWS::SQS::Queue` resource creates an Amazon SQS standard or FIFO\nqueue.\nKeep the following caveats in mind:\n* If you don't specify the `FifoQueue` property, Amazon SQS creates a\n standard queue.\n \n ###### Note\n \n You can't change the queue type after you create it and you can't convert an\n existing standard queue into a FIFO queue. You must either create a new FIFO queue for\n your application or delete your existing standard queue and recreate it as a FIFO queue.\n For more information, see [Moving\n from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Amazon SQS Developer Guide*.\n* If you don't provide a value for a property, the queue is created with the default\n value for the property.\n* If you delete a queue, you must wait at least 60 seconds before creating a queue with\n the same name.\n* To successfully create a new queue, you must provide a queue name that adheres to the\n [limits related\n to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.\nFor more information about creating FIFO (first-in-first-out) queues, see [Creating an Amazon SQS queue (CloudFormation)](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/create-queue-cloudformation.html) in the *Amazon SQS Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the queue URL. For example:\n`{ \"Ref\": \"https://sqs.us-east-2.amazonaws.com/123456789012/ab1-MyQueue-A2BCDEF3GHI4\"\n}`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html", "Properties": { "ReceiveMessageWaitTimeSeconds": { "MarkdownDocumentation": "`ReceiveMessageWaitTimeSeconds`\n\nSpecifies the duration, in seconds, that the ReceiveMessage action call waits until a\nmessage is in the queue in order to include it in the response, rather than returning an empty\nresponse if a message isn't yet available. You can specify an integer from 1 to 20. Short\npolling is used as the default or when you specify 0 for this property. For more information,\nsee [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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-receivemessagewaittimeseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "FifoThroughputLimit": { "MarkdownDocumentation": "`FifoThroughputLimit`\n\nFor high throughput for FIFO queues, specifies whether the FIFO queue throughput quota\napplies to the entire queue or per message group. Valid values are `perQueue` and\n`perMessageGroupId`.\nTo enable high throughput for a FIFO queue, set this attribute to\n`perMessageGroupId`*and* set the `DeduplicationScope` attribute to\n`messageGroup`. If you set these attributes to anything other than these values,\nnormal throughput is in effect and deduplication occurs as specified. For more information,\nsee [High\nthroughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to\nmessages](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifothroughputlimit", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "KmsMasterKeyId": { "MarkdownDocumentation": "`KmsMasterKeyId`\n\nThe ID of an AWS Key Management Service (KMS) for Amazon SQS, or a\ncustom KMS. To use the AWS managed KMS for Amazon SQS, specify a\n(default) alias ARN, alias name (for example `alias/aws/sqs`), key ARN, or key ID.\nFor 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)\n 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 [Security best practices for AWS Key Management Service](https://docs.aws.amazon.com/kms/latest/developerguide/best-practices.html) in the *AWS Key Management 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsmasterkeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "FifoQueue": { "MarkdownDocumentation": "`FifoQueue`\n\nIf set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue. For more information, see [Amazon SQS FIFO\nqueues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifoqueue", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "MaximumMessageSize": { "MarkdownDocumentation": "`MaximumMessageSize`\n\nThe limit of how many bytes that a message can contain before Amazon SQS rejects\nit. You can specify an integer from 1,024 bytes (1 KiB) to 1,048,576 bytes (1 MiB).\nDefault: 1,048,576 bytes (1 MiB).\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-maximummessagesize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "VisibilityTimeout": { "MarkdownDocumentation": "`VisibilityTimeout`\n\nThe length of time during which a message will be unavailable after a message is delivered\nfrom the queue. This blocks other components from receiving the same message and gives the\ninitial 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\ntimeout](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-visibilitytimeout", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "KmsDataKeyReusePeriodSeconds": { "MarkdownDocumentation": "`KmsDataKeyReusePeriodSeconds`\n\nThe length of time in seconds for which Amazon SQS can reuse a data key to encrypt\nor decrypt messages before calling AWS KMS again. The value must be an integer\nbetween 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).\n###### Note\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsdatakeyreuseperiodseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RedriveAllowPolicy": { "MarkdownDocumentation": "`RedriveAllowPolicy`\n\nThe string that includes the parameters for the permissions for the dead-letter queue\nredrive permission and which source queues can specify dead-letter queues as a JSON object.\nThe parameters are as follows:\n* `redrivePermission`: The permission type that defines which source queues can\n specify the current queue as the dead-letter queue. Valid values are:\n \n + `allowAll`: (Default) Any source queues in this AWS\n 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\n queue.\n + `byQueue`: Only queues specified by the `sourceQueueArns`\n parameter can specify this queue as the dead-letter queue.\n* `sourceQueueArns`: The Amazon Resource Names (ARN)s of the source queues that\n can specify this queue as the dead-letter queue and redrive messages. You can specify this\n parameter only when the `redrivePermission` parameter is set to\n `byQueue`. You can specify up to 10 source queue ARNs. To allow more than 10\n source queues to specify dead-letter queues, set the `redrivePermission`\n 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redriveallowpolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "SqsManagedSseEnabled": { "MarkdownDocumentation": "`SqsManagedSseEnabled`\n\nEnables server-side queue encryption using SQS owned encryption keys. Only one server-side\nencryption 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)). When `SqsManagedSseEnabled` is not defined,\n`SSE-SQS` encryption is 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-sqsmanagedsseenabled", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DelaySeconds": { "MarkdownDocumentation": "`DelaySeconds`\n\nThe time in seconds for which the delivery of all messages in the queue is delayed. You\ncan specify an integer value of `0` to `900` (15 minutes). The default\nvalue 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-delayseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RedrivePolicy": { "MarkdownDocumentation": "`RedrivePolicy`\n\nThe string that includes the parameters for the dead-letter queue functionality of the\nsource queue as a JSON object. The parameters are as follows:\n* `deadLetterTargetArn`: The Amazon Resource Name (ARN) of the dead-letter queue\n to which Amazon SQS moves messages after the value of\n `maxReceiveCount` is exceeded.\n* `maxReceiveCount`: The number of times a message is received by a consumer of\n the source queue before being moved to the dead-letter queue. When the\n `ReceiveCount` for a message exceeds the `maxReceiveCount` for a\n queue, Amazon SQS moves the message to the dead-letter-queue.\n###### Note\nThe dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\ndead-letter queue of a standard queue must also be a standard queue.\n*JSON*\n`{ \"deadLetterTargetArn\" : String, \"maxReceiveCount\" :\nInteger }`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redrivepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "MessageRetentionPeriod": { "MarkdownDocumentation": "`MessageRetentionPeriod`\n\nThe number of seconds that Amazon SQS retains a message. You can specify an\ninteger value from `60` seconds (1 minute) to `1,209,600` seconds (14\ndays). 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-messageretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DeduplicationScope": { "MarkdownDocumentation": "`DeduplicationScope`\n\nFor high throughput for FIFO queues, specifies whether message deduplication occurs at the\nmessage group or queue level. Valid values are `messageGroup` and\n`queue`.\nTo enable high throughput for a FIFO queue, set this attribute to\n`messageGroup`*and* set the `FifoThroughputLimit` attribute to\n`perMessageGroupId`. If you set these attributes to anything other than these\nvalues, normal throughput is in effect and deduplication occurs as specified. For more\ninformation, see [High\nthroughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to\nmessages](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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-deduplicationscope", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ContentBasedDeduplication": { "MarkdownDocumentation": "`ContentBasedDeduplication`\n\nFor first-in-first-out (FIFO) queues, specifies whether to enable content-based\ndeduplication. During the deduplication interval, Amazon SQS treats messages that are\nsent with identical content as duplicates and delivers only one copy of the message. For more\ninformation, see the `ContentBasedDeduplication` attribute for the `[CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html)` action in the *Amazon SQS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-contentbaseddeduplication", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "QueueName": { "MarkdownDocumentation": "`QueueName`\n\nA name for the queue. To create a FIFO queue, the name of your FIFO queue must end with\nthe `.fifo` suffix. For more information, see [Amazon SQS FIFO\nqueues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html) in the *Amazon SQS Developer Guide*.\nIf you don't specify a name, CloudFormation generates a unique physical ID and uses\nthat 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 *CloudFormation User Guide*.\n###### Important\nIf you specify a name, you can't perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must replace\nthe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-queuename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags that you attach to this queue. For more information, see [Resource\ntag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *CloudFormation User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sqs-queue-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the Amazon Resource Name (ARN) of the queue. For example:\n`arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#Arn-fn::getatt" }, "QueueName": { "PrimitiveType": "String", "MarkdownDocumentation": "`QueueName`\n\nReturns the queue name. For example: `mystack-myqueue-1VF9BKQH5BJVI`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#QueueName-fn::getatt" }, "QueueUrl": { "PrimitiveType": "String", "MarkdownDocumentation": "`QueueUrl`\n\nReturns the URLs of the queues from the policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#QueueUrl-fn::getatt" } } }, "AWS::SQS::QueueInlinePolicy": { "MarkdownDocumentation": "`AWS::SQS::QueueInlinePolicy`\n\nThe `AWS::SQS::QueueInlinePolicy` resource associates one Amazon SQS\nqueue with one policy.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns returns the URL of the Amazon SQS queue.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queueinlinepolicy.html", "Properties": { "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA policy document that contains the permissions for the specified Amazon SQS\nqueues. For more information about Amazon SQS policies, see [Using\ncustom policies with the Amazon SQS access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Amazon SQS Developer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queueinlinepolicy.html#cfn-sqs-queueinlinepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Queue": { "MarkdownDocumentation": "`Queue`\n\nThe URLs of the queues to which you want to add the policy. You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queueinlinepolicy.html#cfn-sqs-queueinlinepolicy-queue", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SQS::QueuePolicy": { "MarkdownDocumentation": "`AWS::SQS::QueuePolicy`\n\nThe `AWS::SQS::QueuePolicy` type applies a policy to Amazon SQS queues.\nFor an example snippet, see [Declaring an\nAmazon SQS policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy) in the *CloudFormation User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queuepolicy.html", "Properties": { "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nA policy document that contains the permissions for the specified Amazon SQS\nqueues. For more information about Amazon SQS policies, see [Using\ncustom policies with the Amazon SQS access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Amazon SQS Developer 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queuepolicy.html#cfn-sqs-queuepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "Queues": { "MarkdownDocumentation": "`Queues`\n\nThe URLs of the queues to which you want to add the policy. You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html)` resource.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queuepolicy.html#cfn-sqs-queuepolicy-queues", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe provider-assigned unique ID for this managed resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queuepolicy.html#Id-fn::getatt" } } }, "AWS::SSM::Association": { "MarkdownDocumentation": "`AWS::SSM::Association`\n\nThe `AWS::SSM::Association` resource creates a State Manager association\nfor your managed instances. A State Manager association defines the state that you want\nto maintain on your instances. For example, an association can specify that anti-virus\nsoftware must be installed and running on your instances, or that certain ports must be\nclosed. For static targets, the association specifies a schedule for when the\nconfiguration is reapplied. For dynamic targets, such as an AWS Resource Groups or an\nAWS Auto Scaling Group, State Manager applies the configuration when new\ninstances are added to the group. The association also specifies actions to take when\napplying the configuration. For example, an association for anti-virus software might\nrun once a day. If the software is not installed, then State Manager installs it. If the\nsoftware is installed, but the service is not running, then the association might\ninstruct State Manager to start the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html", "Properties": { "AssociationName": { "MarkdownDocumentation": "`AssociationName`\n\nSpecify a descriptive name for the association.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CalendarNames": { "MarkdownDocumentation": "`CalendarNames`\n\nThe names or Amazon Resource Names (ARNs) of the Change Calendar type documents your\nassociations are gated under. The associations only run when that Change Calendar is open. For\nmore information, see [AWS Systems Manager Change\nCalendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the *AWS Systems Manager User Guide*.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ScheduleExpression": { "MarkdownDocumentation": "`ScheduleExpression`\n\nA cron expression that specifies a schedule when the association runs. The schedule runs in\nCoordinated 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MaxErrors": { "MarkdownDocumentation": "`MaxErrors`\n\nThe number of errors that are allowed before the system stops sending requests to run the\nassociation on additional targets. You can specify either an absolute number of errors, for\nexample 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\nthe system stops sending requests when the fourth error is received. If you specify 0, then the\nsystem stops sending requests after the first error is returned. If you run an association on 50\nmanaged nodes and set `MaxError` to 10%, then the system stops sending the request\nwhen the sixth error is received.\nExecutions that are already running an association when `MaxErrors` is reached\nare allowed to complete, but some of these executions may fail as well. If you need to ensure\nthat there won't be more than max-errors failed executions, set `MaxConcurrency` to 1\nso that executions proceed one at a time.\n*Required*: No\n*Type*: String\n*Pattern*: `^([1-9][0-9]{0,6}|[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Parameters": { "MarkdownDocumentation": "`Parameters`\n\nThe parameters for the runtime configuration of the document.\n*Required*: No\n*Type*: Array of String\n*Pattern*: `.{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "InstanceId": { "MarkdownDocumentation": "`InstanceId`\n\n###### Note\n`InstanceId` has been deprecated. To specify an instance ID for an\nassociation, use the `Targets` parameter. If you use the parameter\n`InstanceId`, you cannot use the parameters\n`AssociationName`, `DocumentVersion`,\n`MaxErrors`, `MaxConcurrency`,\n`OutputLocation`, or `ScheduleExpression`. To use these\nparameters, you must use the `Targets` parameter.\nNote that in some examples later in this page, `InstanceIds` is used as\nthe tag-key name in a `Targets` filter. `InstanceId` is not\nused as a parameter.\nThe ID of the instance that the SSM document is associated with. You must specify the\n`InstanceId` or `Targets` property.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WaitForSuccessTimeoutSeconds": { "MarkdownDocumentation": "`WaitForSuccessTimeoutSeconds`\n\nThe number of seconds the service should wait for the association status to show\n\"Success\" before proceeding with the stack execution. If the association status doesn't\nshow \"Success\" after the specified number of seconds, then stack creation fails.\n###### Important\nWhen you specify a value for the `WaitForSuccessTimeoutSeconds`, [drift\ndetection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) for your CloudFormation stack\u2019s configuration might yield\ninaccurate results. If drift detection is important in your scenario, we recommend\nthat you don\u2019t include `WaitForSuccessTimeoutSeconds` in your\ntemplate.\n*Required*: No\n*Type*: Integer\n*Minimum*: `15`\n*Maximum*: `172800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MaxConcurrency": { "MarkdownDocumentation": "`MaxConcurrency`\n\nThe maximum number of targets allowed to run the association at the same time. You can\nspecify a number, for example 10, or a percentage of the target set, for example 10%. The default\nvalue 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\n`MaxConcurrency` associations, the association is allowed to run. During the next\nassociation interval, the new managed node will process its association within the limit\nspecified for `MaxConcurrency`.\n*Required*: No\n*Type*: String\n*Pattern*: `^([1-9][0-9]{0,6}|[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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ComplianceSeverity": { "MarkdownDocumentation": "`ComplianceSeverity`\n\nThe severity level that is assigned to the association.\n*Required*: No\n*Type*: String\n*Allowed values*: `CRITICAL | HIGH | MEDIUM | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe targets for the association. You must specify the `InstanceId` or\n`Targets` property. You can target all instances in an AWS account by specifying t he `InstanceIds` key with a value of\n`*`.\nSupported formats include the following.\n* `Key=InstanceIds,Values=,,`\n* `Key=tag-key,Values=,`\nTo view a JSON and a YAML example that targets all instances, see \"Create an\nassociation for all managed instances in an AWS account\" on the\nExamples page.\n*Required*: Conditional\n*Type*: Array of [Target](./aws-properties-ssm-association-target.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Target", "DuplicatesAllowed": true }, "SyncCompliance": { "MarkdownDocumentation": "`SyncCompliance`\n\nThe mode for generating association compliance. You can specify `AUTO` or\n`MANUAL`. In `AUTO` mode, the system uses the status of the\nassociation execution to determine the compliance status. If the association execution\nruns successfully, then the association is `COMPLIANT`. If the association\nexecution doesn't run successfully, the association is\n`NON-COMPLIANT`.\nIn `MANUAL` mode, you must specify the `AssociationId` as a\nparameter for the `PutComplianceItems` API action. In this case, compliance\ndata is not managed by State Manager. It is managed by your direct call to the\n`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)", "RefReturnValue": "", "AllowedValues": [ "AUTO", "MANUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputLocation": { "MarkdownDocumentation": "`OutputLocation`\n\nAn Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output\ndetails of the request.\n*Required*: No\n*Type*: [InstanceAssociationOutputLocation](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation", "UpdateType": "Mutable", "Required": false, "Type": "InstanceAssociationOutputLocation" }, "ScheduleOffset": { "MarkdownDocumentation": "`ScheduleOffset`\n\nNumber 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the SSM document that contains the configuration information for the\ninstance. You can specify `Command` or `Automation` documents. The\ndocuments can be AWS-predefined documents, documents you created, or a\ndocument that is shared with you from another account. For SSM documents that are shared\nwith you from other AWS accounts, you must specify the complete SSM\ndocument ARN, in the following format:\n`arn:partition:ssm:region:account-id:document/document-name`\nFor example:\n`arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`\nFor AWS-predefined documents and SSM documents you created in your\naccount, 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,200}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ApplyOnlyAtCronInterval": { "MarkdownDocumentation": "`ApplyOnlyAtCronInterval`\n\nBy default, when you create a new association, the system runs it immediately after it\nis created and then according to the schedule you specified. Specify this option if you\ndon't want an association to run immediately after you create it. This parameter is not\nsupported for rate expressions.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DocumentVersion": { "MarkdownDocumentation": "`DocumentVersion`\n\nThe version of the SSM document to associate with the target.\n###### Important\nNote the following important information.\n* State Manager doesn't support running associations that use a new version\n of a document if that document is shared from another account. State Manager\n always runs the `default` version of a document if shared from\n another account, even though the Systems Manager console shows that a\n new version was processed. If you want to run an association using a new\n version of a document shared form another account, you must set the document\n version to `default`.\n* `DocumentVersion` is not valid for documents owned by AWS, such as `AWS-RunPatchBaseline` or\n `AWS-UpdateSSMAgent`. If you specify\n `DocumentVersion` for an AWS document, the\n system returns the following error: \"Error occurred during operation\n 'CreateAssociation'.\" (RequestToken: , HandlerErrorCode:\n GeneralServiceException).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AutomationTargetParameterName": { "MarkdownDocumentation": "`AutomationTargetParameterName`\n\nChoose the parameter that will define how your automation will branch out. This target\nis required for associations that use an Automation runbook and target resources by\nusing rate controls. Automation is a tool in AWS Systems Manager.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "AssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationId`\n\nThe association ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#AssociationId-fn::getatt" } } }, "AWS::SSM::Document": { "MarkdownDocumentation": "`AWS::SSM::Document`\n\nThe `AWS::SSM::Document` resource creates a Systems Manager (SSM)\ndocument in AWS Systems Manager. This document defines the actions that Systems Manager performs on your AWS resources.\n###### Note\nThis resource does not support CloudFormation drift detection.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Systems Manager document name, such as\n`MyNewSSMDocument`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html", "Properties": { "DocumentFormat": { "MarkdownDocumentation": "`DocumentFormat`\n\nSpecify the document format for the request. `JSON` is the default\nformat.\n*Required*: No\n*Type*: String\n*Allowed values*: `YAML | JSON | TEXT...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "YAML", "JSON", "TEXT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "Requires": { "MarkdownDocumentation": "`Requires`\n\nA list of SSM documents required by a document. This parameter is used exclusively by\nAWS AppConfig. When a user creates an AWS AppConfig configuration in an SSM document, the user must also\nspecify a required document for validation purposes. In this case, an\n`ApplicationConfiguration` document requires an\n`ApplicationConfigurationSchema` document for validation purposes. For more\ninformation, see [What is AWS AppConfig?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the\n*AWS AppConfig User Guide*.\n*Required*: No\n*Type*: Array of [DocumentRequires](./aws-properties-ssm-document-documentrequires.html)\n*Minimum*: `1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "DocumentRequires", "DuplicatesAllowed": true }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe content for the new SSM document in JSON or YAML. For more information about the\nschemas for SSM document content, see [SSM document\nschema features and examples](https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html) in the *AWS Systems Manager User\nGuide*.\n###### Note\nThis parameter also supports `String` data types.\n*Required*: Yes\n*Type*: Json\n*Minimum*: `1`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "Json" }, "TargetType": { "MarkdownDocumentation": "`TargetType`\n\nSpecify a target type to define the kinds of resources the document can run on. For\nexample, to run a document on EC2 instances, specify the following value:\n`/AWS::EC2::Instance`. If you specify a value of '/' the document can run\non all types of resources. If you don't specify a value, the document can't run on any\nresources. 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\n*AWS CloudFormation User Guide*.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\/[\\w\\.\\-\\:\\/]*$`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DocumentType": { "MarkdownDocumentation": "`DocumentType`\n\nThe type of document to create.\n*Required*: No\n*Type*: String\n*Allowed values*: `ApplicationConfiguration | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "ApplicationConfiguration", "ApplicationConfigurationSchema", "Automation", "Automation.ChangeTemplate", "AutoApprovalPolicy", "ChangeCalendar", "CloudFormation", "Command", "DeploymentStrategy", "ManualApprovalPolicy", "Package", "Policy", "ProblemAnalysis", "ProblemAnalysisTemplate", "Session" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VersionName": { "MarkdownDocumentation": "`VersionName`\n\nAn optional field specifying the version of the artifact you are creating with the document.\nFor example, `Release12.1`. This value is unique across all versions of a document,\nand can't be changed.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-.]{1,128}$`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "UpdateMethod": { "MarkdownDocumentation": "`UpdateMethod`\n\nIf the document resource you specify in your template already exists, this parameter\ndetermines whether a new version of the existing document is created, or the existing\ndocument is replaced. `Replace` is the default method. If you specify\n`NewVersion` for the `UpdateMethod` parameter, and the\n`Name` of the document does not match an existing resource, a new\ndocument is created. When you specify `NewVersion`, the default version of\nthe document is changed to the newly created version.\n*Required*: No\n*Type*: String\n*Allowed values*: `Replace | NewVersion...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Replace", "NewVersion" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Attachments": { "MarkdownDocumentation": "`Attachments`\n\nA list of key-value pairs that describe attachments to a version of a document.\n*Required*: No\n*Type*: Array of [AttachmentsSource](./aws-properties-ssm-document-attachmentssource.html)\n*Minimum*: `0`\n*Maximum*: `20`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments", "UpdateType": "Conditional", "Required": false, "Type": "List", "ItemType": "AttachmentsSource", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAWS CloudFormation resource tags to apply to the document. Use tags to help you\nidentify and categorize resources.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ssm-document-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA name for the SSM document.\n###### Important\nYou can't use the following strings as document name prefixes. These are reserved by AWS\nfor use as document name prefixes:\n* `aws`\n* `amazon`\n* `amzn`\n* `AWSEC2`\n* `AWSConfigRemediation`\n* `AWSSupport`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::MaintenanceWindow": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindow`\n\nThe `AWS::SSM::MaintenanceWindow` resource represents general information\nabout a maintenance window for AWS Systems Manager. Maintenance windows let you\ndefine a schedule for when to perform potentially disruptive actions on your instances,\nsuch as patching an operating system (OS), updating drivers, or installing software.\nEach maintenance window has a schedule, a duration, a set of registered targets, and a\nset of registered tasks.\nFor more information, see [Systems Manager Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-maintenance.html) in the *AWS Systems Manager User Guide* and [CreateMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateMaintenanceWindow.html) in the *AWS Systems Manager API\nReference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the maintenance window ID, such as\n`mw-abcde1234567890yz`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html", "Properties": { "StartDate": { "Required": false, "MarkdownDocumentation": "`StartDate`\n\nThe date and time, in ISO-8601 Extended format, for when the maintenance window is\nscheduled to become active. `StartDate` allows you to delay activation of the\nmaintenance window until the specified future 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA description of the maintenance window.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "AllowUnassociatedTargets": { "Required": true, "MarkdownDocumentation": "`AllowUnassociatedTargets`\n\nEnables a maintenance window task to run on managed instances, even if you have not\nregistered those instances as targets. If enabled, then you must specify the\nunregistered instances (by instance ID) when you register a task with the maintenance\nwindow.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Cutoff": { "Required": true, "MarkdownDocumentation": "`Cutoff`\n\nThe number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling\nnew tasks for execution.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "Schedule": { "Required": true, "MarkdownDocumentation": "`Schedule`\n\nThe schedule of the maintenance window in the form of a cron or rate expression.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Duration": { "Required": true, "MarkdownDocumentation": "`Duration`\n\nThe duration of the maintenance window in hours.\n*Required*: Yes\n*Type*: Integer\n*Minimum*: `1`\n*Maximum*: `24`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "ScheduleOffset": { "Required": false, "MarkdownDocumentation": "`ScheduleOffset`\n\nThe number of days to wait to run a maintenance window after the scheduled cron expression\ndate and time.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "EndDate": { "Required": false, "MarkdownDocumentation": "`EndDate`\n\nThe date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\nto become 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you assign to a resource in the form of an arbitrary set of\ntags (key-value pairs). Tags enable you to categorize a resource in different ways, such\nas by purpose, owner, or environment. For example, you might want to tag a maintenance\nwindow to identify the type of tasks it will run, the types of targets, and the\nenvironment it will run in.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ssm-maintenancewindow-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name of the maintenance window.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name", "PrimitiveType": "String", "UpdateType": "Mutable" }, "ScheduleTimezone": { "Required": false, "MarkdownDocumentation": "`ScheduleTimezone`\n\nThe time zone that the scheduled maintenance window executions are based on, in Internet\nAssigned Numbers Authority (IANA) 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone", "PrimitiveType": "String", "UpdateType": "Mutable" } } }, "AWS::SSM::MaintenanceWindowTarget": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTarget`\n\nThe `AWS::SSM::MaintenanceWindowTarget` resource registers a target with a\nmaintenance window for AWS Systems Manager. For more information, see [RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTargetWithMaintenanceWindow.html) in the *AWS Systems Manager API Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the maintenance window target ID, such as\n`12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html", "Properties": { "OwnerInformation": { "MarkdownDocumentation": "`OwnerInformation`\n\nA user-provided value that will be included in any Amazon CloudWatch Events events that are\nraised while running tasks for these targets in this maintenance window.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description for the target.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "WindowId": { "MarkdownDocumentation": "`WindowId`\n\nThe ID of the maintenance window to register the target with.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^mw-[0-9a-f]{17}$`\n*Minimum*: `20`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe type of target that is being registered with the maintenance window.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `INSTANCE | RESOURCE_GROUP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "INSTANCE", "RESOURCE_GROUP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe targets to register with the maintenance window. In other words, the instances to\nrun commands on when the maintenance window runs.\nYou must specify targets by using the `WindowTargetIds` parameter.\n*Required*: Yes\n*Type*: [Array](./aws-properties-ssm-maintenancewindowtarget-targets.html) of [Targets](./aws-properties-ssm-maintenancewindowtarget-targets.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "Targets", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the maintenance window target.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "WindowTargetId": { "PrimitiveType": "String", "MarkdownDocumentation": "`WindowTargetId`\n\nThe ID of the target.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#WindowTargetId-fn::getatt" } } }, "AWS::SSM::MaintenanceWindowTask": { "MarkdownDocumentation": "`AWS::SSM::MaintenanceWindowTask`\n\nThe `AWS::SSM::MaintenanceWindowTask` resource defines information about a\ntask for an AWS Systems Manager maintenance window. For more information, see\n[RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTaskWithMaintenanceWindow.html) in the *AWS Systems Manager\nAPI Reference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the maintenance window task ID, such as\n`12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html", "Properties": { "MaxErrors": { "MarkdownDocumentation": "`MaxErrors`\n\nThe maximum number of errors allowed before this task stops being scheduled.\n###### Note\nAlthough this element is listed as \"Required: No\", a value can be omitted only when you are\nregistering or updating a [targetless\ntask](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\noption. Instead, the system inserts a placeholder value of `1`. This value doesn't\naffect the running of your task.\n*Required*: No\n*Type*: String\n*Pattern*: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServiceRoleArn": { "MarkdownDocumentation": "`ServiceRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM service role for\nAWS Systems Manager to assume when running a maintenance window task. If you do not specify a\nservice role ARN, Systems Manager uses a service-linked role in your account. If no\nappropriate service-linked role for Systems Manager exists in your account, it is created when\nyou run `RegisterTaskWithMaintenanceWindow`.\nHowever, for an improved security posture, we strongly recommend creating a custom\npolicy and custom service role for running your maintenance window tasks. The policy\ncan be crafted to provide only the permissions needed for your particular\nmaintenance window tasks. For more information, see [Setting up Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html) in the in the\n*AWS Systems Manager 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority of the task in the maintenance window. The lower the number, the higher the\npriority. Tasks that have the same priority are scheduled in parallel.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "MaxConcurrency": { "MarkdownDocumentation": "`MaxConcurrency`\n\nThe maximum number of targets this task can be run for, in parallel.\n###### Note\nAlthough this element is listed as \"Required: No\", a value can be omitted only when you are\nregistering or updating a [targetless\ntask](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\noption. Instead, the system inserts a placeholder value of `1`. This value doesn't\naffect the running of your task.\n*Required*: No\n*Type*: String\n*Pattern*: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nThe targets, either instances or window target IDs.\n* Specify instances using `Key=InstanceIds,Values=instanceid1,instanceid2`.\n* Specify window target IDs using `Key=WindowTargetIds,Values=window-target-id-1,window-target-id-2`.\n*Required*: No\n*Type*: Array of [Target](./aws-properties-ssm-maintenancewindowtask-target.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Target", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe task name.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TaskArn": { "MarkdownDocumentation": "`TaskArn`\n\nThe resource that the task uses during execution.\nFor `RUN_COMMAND` and `AUTOMATION` task types,\n`TaskArn` is the SSM document name or Amazon Resource Name (ARN).\nFor `LAMBDA` tasks, `TaskArn` is the function name or\nARN.\nFor `STEP_FUNCTIONS` tasks, `TaskArn` is the state machine\nARN.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TaskInvocationParameters": { "MarkdownDocumentation": "`TaskInvocationParameters`\n\nThe parameters to pass to the task when it runs. Populate only the fields that match\nthe task type. All other fields should be empty.\n###### Important\nWhen you update a maintenance window task that has options specified in\n`TaskInvocationParameters`, you must provide again all the\n`TaskInvocationParameters` values that you want to retain. The values\nyou do not specify again are removed. For example, suppose that when you registered\na Run Command task, you specified `TaskInvocationParameters` values for\n`Comment`, `NotificationConfig`, and\n`OutputS3BucketName`. If you update the maintenance window task and\nspecify only a different `OutputS3BucketName` value, the values for\n`Comment` and `NotificationConfig` are removed.\n*Required*: No\n*Type*: [TaskInvocationParameters](./aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters", "UpdateType": "Mutable", "Required": false, "Type": "TaskInvocationParameters" }, "WindowId": { "MarkdownDocumentation": "`WindowId`\n\nThe ID of the maintenance window where the task is registered.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^mw-[0-9a-f]{17}$`\n*Minimum*: `20`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TaskParameters": { "MarkdownDocumentation": "`TaskParameters`\n\n###### Note\n`TaskParameters` has been deprecated. To specify parameters to pass to\na task when it runs, instead use the `Parameters` option in the\n`TaskInvocationParameters` structure. For information about how\nSystems Manager handles these options for the supported maintenance window\ntask types, see [MaintenanceWindowTaskInvocationParameters](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html).\nThe parameters to pass to the task when it runs.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "TaskType": { "MarkdownDocumentation": "`TaskType`\n\nThe type of task. Valid values: `RUN_COMMAND`, `AUTOMATION`,\n`LAMBDA`, `STEP_FUNCTIONS`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `RUN_COMMAND | AUTOMATION | ...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "RUN_COMMAND", "AUTOMATION", "STEP_FUNCTIONS", "LAMBDA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CutoffBehavior": { "MarkdownDocumentation": "`CutoffBehavior`\n\nThe specification for whether tasks should continue to run after the cutoff time specified\nin the maintenance windows is reached.\n*Required*: No\n*Type*: String\n*Allowed values*: `CONTINUE_TASK | CANCEL_TASK...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CONTINUE_TASK", "CANCEL_TASK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoggingInfo": { "MarkdownDocumentation": "`LoggingInfo`\n\n###### Note\n`LoggingInfo` has been deprecated. To specify an Amazon S3\nbucket to contain logs for Run Command tasks, instead use the\n`OutputS3BucketName` and `OutputS3KeyPrefix` options in\nthe `TaskInvocationParameters` structure. For information about how\nSystems Manager handles these options for the supported maintenance window\ntask types, see [AWS::SSM::MaintenanceWindowTask\nMaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html).\nInformation about an Amazon S3 bucket to write Run Command task-level logs\nto.\n*Required*: No\n*Type*: [LoggingInfo](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo", "UpdateType": "Mutable", "Required": false, "Type": "LoggingInfo" } }, "Attributes": { "WindowTaskId": { "PrimitiveType": "String", "MarkdownDocumentation": "`WindowTaskId`\n\nThe task ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#WindowTaskId-fn::getatt" } } }, "AWS::SSM::Parameter": { "MarkdownDocumentation": "`AWS::SSM::Parameter`\n\nThe `AWS::SSM::Parameter` resource creates an SSM parameter in AWS Systems Manager Parameter Store.\n###### Note\nTo create an SSM parameter, you must have the AWS Identity and Access Management (IAM) permissions `ssm:PutParameter` and\n`ssm:AddTagsToResource`. On stack creation, AWS CloudFormation\nadds the following three tags to the parameter:\n`aws:cloudformation:stack-name`,\n`aws:cloudformation:logical-id`, and\n`aws:cloudformation:stack-id`, in addition to any custom tags you\nspecify.\nTo add, update, or remove tags during stack update, you must have IAM permissions for both `ssm:AddTagsToResource` and\n`ssm:RemoveTagsFromResource`. For more information, see [Managing access using policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *AWS Systems Manager User Guide*.\nFor information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the\n*AWS Systems Manager User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *AWS Systems Manager API\nReference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the SSM parameter. For example,\n`ssm-myparameter-ABCNPH3XCAO6`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of parameter.\n###### Note\nParameters of type `SecureString` are not supported by AWS CloudFormation.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `String | StringList...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "String", "StringList" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nInformation about the parameter.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Policies": { "MarkdownDocumentation": "`Policies`\n\nInformation about the policies assigned to a parameter.\n[Assigning parameter\npolicies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *AWS Systems Manager 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllowedPattern": { "MarkdownDocumentation": "`AllowedPattern`\n\nA regular expression used to validate the parameter value. For example, for\n`String` types with values restricted to numbers, you can specify the\nfollowing: `AllowedPattern=^\\d+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tier": { "MarkdownDocumentation": "`Tier`\n\nThe parameter tier.\n*Required*: No\n*Type*: String\n*Allowed values*: `Standard | Advanced | Intel...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Standard", "Advanced", "Intelligent-Tiering" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Value": { "MarkdownDocumentation": "`Value`\n\nThe parameter value.\n###### Note\nIf type is `StringList`, the system returns a comma-separated string with no\nspaces between commas in the `Value` 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DataType": { "MarkdownDocumentation": "`DataType`\n\nThe data type of the parameter, such as `text` or `aws:ec2:image`. The\ndefault is `text`.\n*Required*: No\n*Type*: String\n*Allowed values*: `text | aws:ec2:image...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "text", "aws:ec2:image" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you assign to a resource in the form of an arbitrary set of\ntags (key-value pairs). Tags enable you to categorize a resource in different ways, such\nas by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the\nenvironment, or the type of configuration data referenced by the parameter.\n*Required*: No\n*Type*: Object of String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the parameter.\n###### Note\nThe reported maximum length of 2048 characters for a parameter name includes 1037\ncharacters that are reserved for internal use by Systems Manager. The maximum\nlength for a parameter name that you specify is 1011 characters.\nThis count of 1011 characters includes the characters in the ARN that precede the\nname you specify. This ARN length will vary depending on your partition and Region.\nFor example, the following 45 characters count toward the 1011 character maximum for\na parameter created in the US East (Ohio) Region:\n`arn:aws:ssm:us-east-2:111122223333:parameter/`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nReturns the type of the parameter. Valid values are `String` or\n`StringList`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#Type-fn::getatt" }, "Value": { "PrimitiveType": "String", "MarkdownDocumentation": "`Value`\n\nReturns the value of the parameter.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#Value-fn::getatt" } } }, "AWS::SSM::PatchBaseline": { "MarkdownDocumentation": "`AWS::SSM::PatchBaseline`\n\nThe `AWS::SSM::PatchBaseline` resource defines the basic information for an\nAWS Systems Manager patch baseline. A patch baseline defines which patches are\napproved for installation on your instances.\nFor more information, see [CreatePatchBaseline](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreatePatchBaseline.html) in the *AWS Systems Manager API\nReference*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the patch baseline ID, such as\n`pb-abcde1234567890yz`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html", "Properties": { "OperatingSystem": { "MarkdownDocumentation": "`OperatingSystem`\n\nDefines the operating system the patch baseline applies to. The default value is\n`WINDOWS`.\n*Required*: No\n*Type*: String\n*Allowed values*: `WINDOWS | AMAZON_LINUX | AM...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "AMAZON_LINUX_2022", "AMAZON_LINUX_2023", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS", "ORACLE_LINUX", "DEBIAN", "MACOS", "RASPBIAN", "ROCKY_LINUX", "ALMA_LINUX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApprovalRules": { "MarkdownDocumentation": "`ApprovalRules`\n\nA set of rules used to include patches in the baseline.\n*Required*: No\n*Type*: [RuleGroup](./aws-properties-ssm-patchbaseline-rulegroup.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules", "UpdateType": "Mutable", "Required": false, "Type": "RuleGroup" }, "Sources": { "MarkdownDocumentation": "`Sources`\n\nInformation about the patches to use to update the managed nodes, including target operating\nsystems and source repositories. Applies to Linux managed nodes only.\n*Required*: No\n*Type*: Array of [PatchSource](./aws-properties-ssm-patchbaseline-patchsource.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "PatchSource", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the patch baseline.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "RejectedPatches": { "MarkdownDocumentation": "`RejectedPatches`\n\nA list of explicitly rejected patches for the baseline.\nFor information about accepted formats for lists of approved patches and rejected patches,\nsee [Package\nname 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*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `100 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ApprovedPatches": { "MarkdownDocumentation": "`ApprovedPatches`\n\nA list of explicitly approved patches for the baseline.\nFor information about accepted formats for lists of approved patches and rejected patches,\nsee [Package\nname 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*: Array of String\n*Minimum*: `1 | 0`\n*Maximum*: `100 | 50`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RejectedPatchesAction": { "MarkdownDocumentation": "`RejectedPatchesAction`\n\nThe action for Patch Manager to take on patches included in the\n`RejectedPackages` list.\nALLOW\\_AS\\_DEPENDENCY\n**Linux and macOS**: A package in the rejected patches list\nis installed only if it is a dependency of another package. It is considered compliant with\nthe patch baseline, and its status is reported as `INSTALLED_OTHER`. This is the\ndefault action if no option is specified.\n**Windows Server**: Windows Server doesn't support the\nconcept of package dependencies. If a package in the rejected patches list and already\ninstalled on the node, its status is reported as `INSTALLED_OTHER`. Any package not\nalready installed on the node is skipped. This is the default action if no option is\nspecified.\n\nBLOCK\n**All OSs**: Packages in the rejected patches list, and\npackages that include them as dependencies, aren't installed by Patch Manager under any\ncircumstances.\nState value assignment for patch compliance:\n* If a package was installed before it was added to the rejected patches list, or is\n installed outside of Patch Manager afterward, it's considered noncompliant with the patch\n baseline and its status is reported as `INSTALLED_REJECTED`.\n* If an update attempts to install a dependency package that is now rejected by the\n baseline, when previous versions of the package were not rejected, the package being updated\n is reported as `MISSING` for `SCAN` operations and as\n `FAILED` for `INSTALL` operations.\n\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)", "RefReturnValue": "", "AllowedValues": [ "ALLOW_AS_DEPENDENCY", "BLOCK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PatchGroups": { "MarkdownDocumentation": "`PatchGroups`\n\nThe name of the patch group to be registered with the patch baseline.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ApprovedPatchesComplianceLevel": { "MarkdownDocumentation": "`ApprovedPatchesComplianceLevel`\n\nDefines the compliance level for approved patches. When an approved patch is reported as\nmissing, this value describes the severity of the compliance violation. The default value is\n`UNSPECIFIED`.\n*Required*: No\n*Type*: String\n*Allowed values*: `CRITICAL | HIGH | MEDIUM | ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFORMATIONAL", "UNSPECIFIED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AvailableSecurityUpdatesComplianceStatus": { "MarkdownDocumentation": "`AvailableSecurityUpdatesComplianceStatus`\n\nIndicates the status you want to assign to security patches that are available but not\napproved because they don't meet the installation criteria specified in the patch\nbaseline.\nExample scenario: Security patches that you might want installed can be skipped if you have\nspecified a long period to wait after a patch is released before installation. If an update to\nthe patch is released during your specified waiting period, the waiting period for installing the\npatch starts over. If the waiting period is too long, multiple versions of the patch could be\nreleased but never installed.\nSupported for Windows Server managed nodes only.\n*Required*: No\n*Type*: String\n*Allowed values*: `NON_COMPLIANT | COMPLIANT...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NON_COMPLIANT", "COMPLIANT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-availablesecurityupdatescompliancestatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApprovedPatchesEnableNonSecurity": { "MarkdownDocumentation": "`ApprovedPatchesEnableNonSecurity`\n\nIndicates whether the list of approved patches includes non-security updates that should be\napplied to the managed nodes. The default value is `false`. Applies to Linux managed\nnodes 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DefaultBaseline": { "MarkdownDocumentation": "`DefaultBaseline`\n\nIndicates whether this is the default baseline. AWS Systems Manager supports creating multiple default\npatch baselines. For example, you can create a default patch baseline for each operating\nsystem.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-defaultbaseline", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "GlobalFilters": { "MarkdownDocumentation": "`GlobalFilters`\n\nA set of global filters used to include patches in the baseline.\n###### Important\nThe `GlobalFilters` parameter can be configured only by using the AWS CLI or an AWS SDK. It can't be configured from the Patch Manager\nconsole, and its value isn't displayed in the console.\n*Required*: No\n*Type*: [PatchFilterGroup](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters", "UpdateType": "Mutable", "Required": false, "Type": "PatchFilterGroup" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOptional metadata that you assign to a resource. Tags enable you to categorize a\nresource in different ways, such as by purpose, owner, or environment. For example, you\nmight want to tag a patch baseline to identify the severity level of patches it\nspecifies and the operating system family it applies to.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ssm-patchbaseline-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#Id-fn::getatt" } } }, "AWS::SSM::ResourceDataSync": { "MarkdownDocumentation": "`AWS::SSM::ResourceDataSync`\n\nThe `AWS::SSM::ResourceDataSync` resource creates, updates, or deletes a\nresource data sync for AWS Systems Manager. A resource data sync helps you view\ndata from multiple sources in a single location. Systems Manager offers two types\nof resource data sync: `SyncToDestination` and\n`SyncFromSource`.\nYou can configure Systems Manager Inventory to use the\n`SyncToDestination` type to synchronize Inventory data from multiple\nAWS Regions to a single Amazon S3 bucket.\nYou can configure Systems Manager Explorer to use the `SyncFromSource` type to\nsynchronize operational work items (OpsItems) and operational data (OpsData) from\nmultiple AWS Regions. This type can synchronize OpsItems and OpsData\nfrom multiple AWS accounts and Regions or from an\n`EntireOrganization` by using AWS Organizations.\nA resource data sync is an asynchronous operation that returns immediately. After a\nsuccessful initial sync is completed, the system continuously syncs data.\nBy default, data is not encrypted in Amazon S3. We strongly recommend that\nyou enable encryption in Amazon S3 to ensure secure data storage. We also\nrecommend that you secure access to the Amazon S3 bucket by creating a\nrestrictive bucket policy.\nFor more information, see [Configuring Inventory Collection](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync) and [Setting Up\nSystems Manager Explorer to Display Data from Multiple Accounts and Regions](https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html)\nin the *AWS Systems Manager User Guide*.\n###### Important\nThe following *Syntax* section shows all fields that are\nsupported for a resource data sync. The *Examples* section below\nshows the recommended way to specify configurations for each sync type. Refer to the\n*Examples* section when you create your resource data\nsync.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the resource data sync, such as\n`TestResourceDataSync`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html", "Properties": { "S3Destination": { "MarkdownDocumentation": "`S3Destination`\n\nConfiguration information for the target S3 bucket.\n*Required*: No\n*Type*: [S3Destination](./aws-properties-ssm-resourcedatasync-s3destination.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination", "UpdateType": "Immutable", "Required": false, "Type": "S3Destination" }, "KMSKeyArn": { "MarkdownDocumentation": "`KMSKeyArn`\n\nThe Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3. You can use a KMS key to encrypt inventory data in Amazon S3.\nYou must specify a key that exist in the same AWS Region as the\ndestination Amazon S3 bucket.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\n*Maximum*: `512`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SyncSource": { "MarkdownDocumentation": "`SyncSource`\n\nInformation about the source where the data was synchronized.\n*Required*: No\n*Type*: [SyncSource](./aws-properties-ssm-resourcedatasync-syncsource.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource", "UpdateType": "Mutable", "Required": false, "Type": "SyncSource" }, "BucketName": { "MarkdownDocumentation": "`BucketName`\n\nThe name of the S3 bucket where the aggregated data is stored.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BucketRegion": { "MarkdownDocumentation": "`BucketRegion`\n\nThe AWS Region with the S3 bucket targeted by the resource data sync.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SyncFormat": { "MarkdownDocumentation": "`SyncFormat`\n\nA supported sync format. The following format is currently supported: JsonSerDe\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SyncName": { "MarkdownDocumentation": "`SyncName`\n\nA name for the resource data sync.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "SyncType": { "MarkdownDocumentation": "`SyncType`\n\nThe type of resource data sync. If `SyncType` is `SyncToDestination`,\nthen the resource data sync synchronizes data to an S3 bucket. If the `SyncType` is\n`SyncFromSource` then the resource data sync synchronizes data from AWS Organizations or from\nmultiple AWS Regions.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "BucketPrefix": { "MarkdownDocumentation": "`BucketPrefix`\n\nAn Amazon S3 prefix for the bucket.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::SSM::ResourcePolicy": { "MarkdownDocumentation": "`AWS::SSM::ResourcePolicy`\n\nCreates or updates a Systems Manager resource policy. A resource policy helps you\nto define the IAM entity (for example, an AWS account)\nthat can manage your Systems Manager resources. Currently, `OpsItemGroup`\nis the only resource that supports Systems Manager resource policies. The resource\npolicy for `OpsItemGroup` enables AWS accounts to view and\ninteract with OpsCenter operational work items (OpsItems). OpsCenter is a tool in\nSystems Manager.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the resource to which you want to attach a\npolicy.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "PolicyHash": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyHash`\n\nID of the current policy version. The hash helps to prevent a situation where multiple\nusers attempt to overwrite a policy. You must provide this hash and the policy ID when\nupdating or deleting a policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#PolicyHash-fn::getatt" }, "PolicyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyId`\n\nID of the current policy version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#PolicyId-fn::getatt" } } }, "AWS::SSMContacts::Contact": { "MarkdownDocumentation": "`AWS::SSMContacts::Contact`\n\nThe `AWS::SSMContacts::Contact` resource specifies a contact or escalation\nplan. Incident Manager contacts are a subset of actions and data types that you\ncan use for managing responder engagement and interaction.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the resource.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of contact.\n* `PERSONAL`: A single, individual contact.\n* `ESCALATION`: An escalation plan.\n* `ONCALL_SCHEDULE`: An on-call schedule.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `PERSONAL | ESCALATION | ONC...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "PERSONAL", "ESCALATION", "ONCALL_SCHEDULE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nThe unique and identifiable alias of the contact or escalation plan.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-z0-9_\\-\\.]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-alias", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe full name of the contact or escalation plan.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_\\-\\s]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-displayname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Plan": { "MarkdownDocumentation": "`Plan`\n\nA list of stages. A contact has an engagement plan with stages that contact specified\ncontact channels. An escalation plan uses stages that contact specified contacts.\n*Required*: No\n*Type*: Array of [Stage](./aws-properties-ssmcontacts-contact-stage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-plan", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Stage", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ssmcontacts-contact-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `Contact` resource, such as\n`arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#Arn-fn::getatt" } } }, "AWS::SSMContacts::ContactChannel": { "MarkdownDocumentation": "`AWS::SSMContacts::ContactChannel`\n\nThe `AWS::SSMContacts::ContactChannel` resource specifies a contact channel\nas the method that Incident Manager uses to engage your contact.\n###### Note\n**Template example**: We recommend creating all Incident Manager`Contacts` resources using a single AWS CloudFormation template. For a\ndemonstration, see the examples for [AWS::SSMContacts::Contacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the resource, such as\n`arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/contactalias/cec1bb12-34f5-6789-a1ee-e1ca2345d6f7`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html", "Properties": { "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe name of the contact channel.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z 0-9_\\-+'&\\uD83C-\\uDBFF\\uDC00-\\uDFFF\\u2000-\\u3300]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-channelname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ChannelAddress": { "MarkdownDocumentation": "`ChannelAddress`\n\nThe details that Incident Manager uses when trying to engage the contact channel.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-channeladdress", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContactId": { "MarkdownDocumentation": "`ContactId`\n\nThe Amazon Resource Name (ARN) of the contact you are adding the contact channel\nto.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-contactid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ChannelType": { "MarkdownDocumentation": "`ChannelType`\n\nThe type of the contact channel. Incident Manager supports three contact methods:\n* SMS\n* VOICE\n* EMAIL\n*Required*: No\n*Type*: String\n*Allowed values*: `SMS | VOICE | EMAIL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "SMS", "VOICE", "EMAIL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-channeltype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DeferActivation": { "MarkdownDocumentation": "`DeferActivation`\n\nIf you want to activate the channel at a later time, you can choose to defer activation.\nIncident Manager can't engage your contact channel until it has been activated.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-deferactivation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `ContactChannel` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#Arn-fn::getatt" } } }, "AWS::SSMContacts::Plan": { "MarkdownDocumentation": "`AWS::SSMContacts::Plan`\n\nInformation about the stages and on-call rotation teams associated with an escalation\nplan or engagement plan.\n###### Note\n**Template example**: We recommend creating all Incident Manager`Contacts` resources using a single AWS CloudFormation template. For a\ndemonstration, see the examples for [AWS::SSMContacts::Contacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html", "Properties": { "RotationIds": { "MarkdownDocumentation": "`RotationIds`\n\nThe Amazon Resource Names (ARNs) of the on-call rotations associated with the\nplan.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-rotationids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Stages": { "MarkdownDocumentation": "`Stages`\n\nA list of stages that the escalation plan or engagement plan uses to engage contacts and\ncontact methods.\n*Required*: No\n*Type*: Array of [Stage](./aws-properties-ssmcontacts-plan-stage.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-stages", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Stage", "DuplicatesAllowed": true }, "ContactId": { "MarkdownDocumentation": "`ContactId`\n\nThe Amazon Resource Name (ARN) of the contact.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-contactid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `Plan` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#Arn-fn::getatt" } } }, "AWS::SSMContacts::Rotation": { "MarkdownDocumentation": "`AWS::SSMContacts::Rotation`\n\nSpecifies a rotation in an on-call schedule.\n###### Note\n**Template example**: We recommend creating all Incident Manager`Contacts` resources using a single AWS CloudFormation template. For a\ndemonstration, see the examples for [AWS::SSMContacts::Contacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html", "Properties": { "Recurrence": { "MarkdownDocumentation": "`Recurrence`\n\nInformation about the rule that specifies when shift team members rotate.\n*Required*: Yes\n*Type*: [RecurrenceSettings](./aws-properties-ssmcontacts-rotation-recurrencesettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-recurrence", "UpdateType": "Mutable", "Required": true, "Type": "RecurrenceSettings" }, "TimeZoneId": { "MarkdownDocumentation": "`TimeZoneId`\n\nThe time zone to base the rotation\u2019s activity on, in Internet Assigned Numbers Authority\n(IANA) format. For example: \"America/Los\\_Angeles\", \"UTC\", or \"Asia/Seoul\". For more\ninformation, see the [Time Zone\nDatabase](https://www.iana.org/time-zones) on the IANA website.\n###### Note\nDesignators for time zones that don\u2019t support Daylight Savings Time rules, such as\nPacific Standard Time (PST), are not supported.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[:a-zA-Z0-9_\\-\\s\\.\\\\/]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-timezoneid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "StartTime": { "MarkdownDocumentation": "`StartTime`\n\nThe date and time the rotation goes into effect.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-starttime", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nOptional metadata to assign to the rotation. Tags enable you to categorize a resource in\ndifferent ways, such as by purpose, owner, or environment. For more information, see [Tagging\nIncident Manager resources](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) in the *Incident Manager User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ssmcontacts-rotation-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for the rotation.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ContactIds": { "MarkdownDocumentation": "`ContactIds`\n\nThe Amazon Resource Names (ARNs) of the contacts to add to the rotation.\n###### Note\nOnly the `PERSONAL` contact type is supported. The contact types\n`ESCALATION` and `ONCALL_SCHEDULE` are not supported for this\noperation.\nThe order in which you list the contacts is their shift order in the rotation\nschedule.\n*Required*: Yes\n*Type*: Array of String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-contactids", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the `Rotation` resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#Arn-fn::getatt" } } }, "AWS::SSMGuiConnect::Preferences": { "MarkdownDocumentation": "`AWS::SSMGuiConnect::Preferences`\n\nSpecify new or changed connection recording preferences for\nyour AWS Systems Manager GUI Connect connections.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmguiconnect-preferences.html", "Properties": { "ConnectionRecordingPreferences": { "MarkdownDocumentation": "`ConnectionRecordingPreferences`\n\nThe set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.\n*Required*: No\n*Type*: [ConnectionRecordingPreferences](./aws-properties-ssmguiconnect-preferences-connectionrecordingpreferences.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmguiconnect-preferences.html#cfn-ssmguiconnect-preferences-connectionrecordingpreferences", "UpdateType": "Mutable", "Required": false, "Type": "ConnectionRecordingPreferences" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe primary identifier for the AWS CloudFormation resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmguiconnect-preferences.html#AccountId-fn::getatt" } } }, "AWS::SSMIncidents::ReplicationSet": { "MarkdownDocumentation": "`AWS::SSMIncidents::ReplicationSet`\n\nThe `AWS::SSMIncidents::ReplicationSet` resource specifies a set of AWS Regions\nthat Incident Manager data is replicated to and the AWS Key Management Service (AWS KMS\nkey used to encrypt the data.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-replicationset.html", "Properties": { "Regions": { "MarkdownDocumentation": "`Regions`\n\nSpecifies the Regions of the replication set.\n*Required*: Yes\n*Type*: Array of [ReplicationRegion](./aws-properties-ssmincidents-replicationset-replicationregion.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-replicationset.html#cfn-ssmincidents-replicationset-regions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ReplicationRegion", "DuplicatesAllowed": false }, "DeletionProtected": { "MarkdownDocumentation": "`DeletionProtected`\n\nDetermines if the replication set deletion protection is enabled or not. If deletion\nprotection 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-replicationset.html#cfn-ssmincidents-replicationset-deletionprotected", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags to add to the replication set.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-ssmincidents-replicationset-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-replicationset.html#cfn-ssmincidents-replicationset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-replicationset.html#Arn-fn::getatt" } } }, "AWS::SSMIncidents::ResponsePlan": { "MarkdownDocumentation": "`AWS::SSMIncidents::ResponsePlan`\n\nThe `AWS::SSMIncidents::ResponsePlan` resource specifies the details of the\nresponse plan that are used when creating an incident.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html", "Properties": { "ChatChannel": { "MarkdownDocumentation": "`ChatChannel`\n\nThe Amazon Q Developer in chat applications chat channel used for collaboration during an\nincident.\n*Required*: No\n*Type*: [ChatChannel](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-chatchannel", "UpdateType": "Mutable", "Required": false, "Type": "ChatChannel" }, "Integrations": { "MarkdownDocumentation": "`Integrations`\n\nInformation about third-party services integrated into the response plan.\n*Required*: No\n*Type*: Array of [Integration](./aws-properties-ssmincidents-responseplan-integration.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-integrations", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Integration", "DuplicatesAllowed": false }, "Actions": { "MarkdownDocumentation": "`Actions`\n\nThe actions that the response plan starts at the beginning of an incident.\n*Required*: No\n*Type*: Array of [Action](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-actions", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Action", "DuplicatesAllowed": false }, "DisplayName": { "MarkdownDocumentation": "`DisplayName`\n\nThe human readable name of the response plan.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-displayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "IncidentTemplate": { "MarkdownDocumentation": "`IncidentTemplate`\n\nDetails used to create an incident when using this response plan.\n*Required*: Yes\n*Type*: [IncidentTemplate](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-incidenttemplate", "UpdateType": "Mutable", "Required": true, "Type": "IncidentTemplate" }, "Engagements": { "MarkdownDocumentation": "`Engagements`\n\nThe Amazon Resource Name (ARN) for the contacts and escalation plans that the response\nplan engages during an incident.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-engagements", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-ssmincidents-responseplan-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the response plan.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#Arn-fn::getatt" } } }, "AWS::SSMQuickSetup::ConfigurationManager": { "MarkdownDocumentation": "`AWS::SSMQuickSetup::ConfigurationManager`\n\nCreates a Quick Setup configuration manager resource. This object is a collection of\ndesired state configurations for multiple configuration definitions and summaries\ndescribing the deployments of those definitions.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the configuration manager.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^.{0,512}$`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#cfn-ssmquicksetup-configurationmanager-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ConfigurationDefinitions": { "MarkdownDocumentation": "`ConfigurationDefinitions`\n\nThe definition of the Quick Setup configuration that the configuration manager\ndeploys.\n*Required*: Yes\n*Type*: Array of [ConfigurationDefinition](./aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#cfn-ssmquicksetup-configurationmanager-configurationdefinitions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ConfigurationDefinition", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs of metadata to assign to the configuration manager.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[A-Za-z0-9 +=@_\\/:.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#cfn-ssmquicksetup-configurationmanager-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the configuration\n*Required*: No\n*Type*: String\n*Pattern*: `^[ A-Za-z0-9_-]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#cfn-ssmquicksetup-configurationmanager-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "LastModifiedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedAt`\n\nThe datetime stamp when the configuration manager was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#LastModifiedAt-fn::getatt" }, "StatusSummaries": { "Type": "List", "ItemType": "StatusSummary", "MarkdownDocumentation": "`StatusSummaries`\n\nSummaries of the state of the configuration manager. These summaries include an\naggregate of the statuses from the configuration definition associated with the\nconfiguration manager. This includes deployment statuses, association statuses,\ndrift statuses, health checks, and more.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#StatusSummaries-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe datetime stamp when the configuration manager was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#CreatedAt-fn::getatt" }, "ManagerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ManagerArn`\n\nThe ARN of the Quick Setup configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#ManagerArn-fn::getatt" } } }, "AWS::SSMQuickSetup::LifecycleAutomation": { "MarkdownDocumentation": "`AWS::SSMQuickSetup::LifecycleAutomation`\n\nCreates a lifecycle automation resource that executes SSM Automation documents during CloudFormation stack operations. This resource replaces inline AWS Lambda custom resources and provides a managed way to handle lifecycle events in Quick Setup configurations.\n", "RefReturnValue": "\nReturns the AssociationId of the lifecycle automation resource, which is the same as the association ID of the underlying Systems Manager association.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html", "Properties": { "AutomationParameters": { "MarkdownDocumentation": "`AutomationParameters`\n\nA map of key-value parameters passed to the Automation document during execution. Each parameter name maps to a list of values, even for single values. Parameters can include configuration-specific values for your automation workflow.\n*Required*: Yes\n*Type*: Object of Array\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html#cfn-ssmquicksetup-lifecycleautomation-automationparameters", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "AutomationDocument": { "MarkdownDocumentation": "`AutomationDocument`\n\nThe name of the SSM Automation document to execute in response to CloudFormation lifecycle events (CREATE, UPDATE, DELETE).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\S+$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html#cfn-ssmquicksetup-lifecycleautomation-automationdocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags applied to the underlying SSM Association created by this resource. Tags help identify and organize automation executions.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^[A-Za-z0-9 +=@_\\/:.-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html#cfn-ssmquicksetup-lifecycleautomation-tags", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "ResourceKey": { "MarkdownDocumentation": "`ResourceKey`\n\nA unique identifier used for generating the SSM Association name. This ensures uniqueness when multiple lifecycle automation resources exist in the same stack.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html#cfn-ssmquicksetup-lifecycleautomation-resourcekey", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AssociationId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AssociationId`\n\nReturns the ID of the SSM Association created to manage the automation document execution lifecycle.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html#AssociationId-fn::getatt" } } }, "AWS::SSO::Application": { "MarkdownDocumentation": "`AWS::SSO::Application`\n\nCreates an OAuth 2.0 customer managed application in IAM Identity Center for the given\napplication provider.\n###### Note\nThis API does not support creating SAML 2.0 customer managed applications or AWS\nmanaged applications. To learn how to create an AWS managed application, see the\napplication user guide. You can create a SAML 2.0 customer managed application in\nthe AWS Management Console only. See [Setting\nup customer managed SAML 2.0 applications](https://docs.aws.amazon.com/singlesignon/latest/userguide/customermanagedapps-saml2-setup.html). For more information on these\napplication types, see [AWS managed\napplications](https://docs.aws.amazon.com/singlesignon/latest/userguide/awsapps.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a generated ID, combined by all fields with the delimiter\n`|`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe current status of the application in this instance of IAM Identity Center.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ApplicationProviderArn": { "MarkdownDocumentation": "`ApplicationProviderArn`\n\nThe ARN of the application provider for this application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-applicationproviderarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PortalOptions": { "MarkdownDocumentation": "`PortalOptions`\n\nA structure that describes the options for the access portal associated with this\napplication.\n*Required*: No\n*Type*: [PortalOptionsConfiguration](./aws-properties-sso-application-portaloptionsconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-portaloptions", "UpdateType": "Mutable", "Required": false, "Type": "PortalOptionsConfiguration" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the application.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceArn": { "MarkdownDocumentation": "`InstanceArn`\n\nThe ARN of the instance of IAM Identity Center that is configured with this application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-instancearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies tags to be attached to the application.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sso-application-tag.html)\n*Maximum*: `75`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w+=,.@-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ApplicationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ApplicationArn`\n\nThe ARN of the application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#ApplicationArn-fn::getatt" } } }, "AWS::SSO::ApplicationAssignment": { "MarkdownDocumentation": "`AWS::SSO::ApplicationAssignment`\n\nA structure that describes an assignment of a principal to an application.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a generated ID, combined by all fields with the delimiter\n`|`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-applicationassignment.html", "Properties": { "ApplicationArn": { "MarkdownDocumentation": "`ApplicationArn`\n\nThe ARN of the application that has principals assigned.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-applicationassignment.html#cfn-sso-applicationassignment-applicationarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PrincipalId": { "MarkdownDocumentation": "`PrincipalId`\n\nThe unique identifier of the principal assigned to the application.\n*Required*: Yes\n*Type*: String\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*Minimum*: `1`\n*Maximum*: `47`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-applicationassignment.html#cfn-sso-applicationassignment-principalid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PrincipalType": { "MarkdownDocumentation": "`PrincipalType`\n\nThe type of the principal assigned to the application.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `USER | GROUP...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "USER", "GROUP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-applicationassignment.html#cfn-sso-applicationassignment-principaltype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSO::Assignment": { "MarkdownDocumentation": "`AWS::SSO::Assignment`\n\nAssigns access to a Principal for a specified AWS account using a\nspecified permission set.\n###### Note\nThe term *principal* here refers to a user or group that is\ndefined in IAM Identity Center.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a generated ID, combined by all fields with the delimiter\n`|`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html", "Properties": { "PrincipalId": { "MarkdownDocumentation": "`PrincipalId`\n\nAn 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*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*Minimum*: `1`\n*Maximum*: `47`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-principalid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InstanceArn": { "MarkdownDocumentation": "`InstanceArn`\n\nThe ARN of the IAM Identity Center instance under which the operation will be executed.\nFor more information about ARNs, see [Amazon Resource Names (ARNs) and\nAWS 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*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-instancearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetType": { "MarkdownDocumentation": "`TargetType`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "AWS_ACCOUNT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-targettype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PermissionSetArn": { "MarkdownDocumentation": "`PermissionSetArn`\n\nThe ARN of the permission set.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-permissionsetarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PrincipalType": { "MarkdownDocumentation": "`PrincipalType`\n\nThe entity type for which the assignment will be created.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `USER | GROUP...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "USER", "GROUP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-principaltype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "TargetId": { "MarkdownDocumentation": "`TargetId`\n\nTargetID is an AWS account identifier, (For example, 123456789012).\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-targetid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::SSO::Instance": { "MarkdownDocumentation": "`AWS::SSO::Instance`\n\nCreates an instance of IAM Identity Center for a standalone AWS account that is not\nmanaged by AWS Organizations or a member AWS account in an organization. You can create only\none instance per account and across all AWS Regions.\nThe CreateInstance request is rejected if the following apply:\n* The instance is created within the organization management account.\n* An instance already exists in the same account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a generated ID, combined by all fields with the delimiter\n`|`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html", "Properties": { "Tags": { "MarkdownDocumentation": "`Tags`\n\nSpecifies tags to be attached to the instance of IAM Identity Center.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sso-instance-tag.html)\n*Maximum*: `75`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#cfn-sso-instance-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the Identity Center instance.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w+=,.@-]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#cfn-sso-instance-name", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of this Identity Center instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#Status-fn::getatt" }, "InstanceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`InstanceArn`\n\nThe ARN of the Identity Center instance under which the operation will be executed.\nFor more information about ARNs, see [Amazon Resource\nNames (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#InstanceArn-fn::getatt" }, "IdentityStoreId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdentityStoreId`\n\nThe identifier of the identity store that is connected to the Identity Center\ninstance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#IdentityStoreId-fn::getatt" }, "OwnerAccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`OwnerAccountId`\n\nThe AWS account ID number of the owner of the Identity Center instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#OwnerAccountId-fn::getatt" } } }, "AWS::SSO::InstanceAccessControlAttributeConfiguration": { "MarkdownDocumentation": "`AWS::SSO::InstanceAccessControlAttributeConfiguration`\n\nEnables the attribute-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC\nconfiguration during the enabling process. For more information about ABAC, see [Attribute-Based\nAccess Control](https://docs.aws.amazon.com//singlesignon/latest/userguide/abac.html) in the *IAM Identity Center User Guide*.\n###### Note\nThe `InstanceAccessControlAttributeConfiguration` property has been\ndeprecated but is still supported for backwards compatibility purposes. We recommend\nthat you use the `AccessControlAttributes` property instead.\n", "RefReturnValue": "\nSpecifies the IAM Identity Center identity store attributes to add to your ABAC\nconfiguration. When using an external identity provider as an identity source, you can pass\nattributes through the SAML assertion. Doing so provides an alternative to configuring\nattributes from the IAM Identity Center identity store. If a SAML assertion passes any of\nthese attributes, IAM Identity Center will replace the attribute value with the value from\nthe IAM Identity Center identity store.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instanceaccesscontrolattributeconfiguration.html", "Properties": { "InstanceArn": { "MarkdownDocumentation": "`InstanceArn`\n\nThe ARN of the IAM Identity Center instance under which the operation will be\nexecuted.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instanceaccesscontrolattributeconfiguration.html#cfn-sso-instanceaccesscontrolattributeconfiguration-instancearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AccessControlAttributes": { "MarkdownDocumentation": "`AccessControlAttributes`\n\nLists the attributes that are configured for ABAC in the specified IAM Identity Center\ninstance.\n*Required*: No\n*Type*: Array of [AccessControlAttribute](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instanceaccesscontrolattributeconfiguration.html#cfn-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributes", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AccessControlAttribute", "DuplicatesAllowed": true } } }, "AWS::SSO::PermissionSet": { "MarkdownDocumentation": "`AWS::SSO::PermissionSet`\n\nSpecifies a permission set within a specified IAM Identity Center instance.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a generated ID, such as\n`permission-arn|sso-instance-arn`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html", "Properties": { "RelayStateType": { "MarkdownDocumentation": "`RelayStateType`\n\nUsed to redirect users within the application during the federation authentication\nprocess.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9&$@#\\/%?=~\\-_'"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+`\n*Minimum*: `1`\n*Maximum*: `240`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-relaystatetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CustomerManagedPolicyReferences": { "MarkdownDocumentation": "`CustomerManagedPolicyReferences`\n\nSpecifies the names and paths of the customer managed policies that you have attached\nto your permission set.\n*Required*: No\n*Type*: Array of [CustomerManagedPolicyReference](./aws-properties-sso-permissionset-customermanagedpolicyreference.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-customermanagedpolicyreferences", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "CustomerManagedPolicyReference", "DuplicatesAllowed": true }, "SessionDuration": { "MarkdownDocumentation": "`SessionDuration`\n\nThe length of time that the application user sessions are valid for in the ISO-8601\nstandard.\n*Required*: No\n*Type*: String\n*Pattern*: `^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-sessionduration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the [AWS::SSO::PermissionSet](./aws-resource-sso-permissionset.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*`\n*Minimum*: `1`\n*Maximum*: `700`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceArn": { "MarkdownDocumentation": "`InstanceArn`\n\nThe ARN of the IAM Identity Center instance under which the operation will be executed.\nFor more information about ARNs, see [Amazon Resource Names (ARNs) and\nAWS 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*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`\n*Minimum*: `10`\n*Maximum*: `1224`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-instancearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "InlinePolicy": { "MarkdownDocumentation": "`InlinePolicy`\n\nThe inline policy that is attached to the permission set.\n###### Note\nFor `Length Constraints`, if a valid ARN is provided for a permission\nset, it is possible for an empty inline policy to be returned.\n*Required*: No\n*Type*: Json\n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+`\n*Minimum*: `1`\n*Maximum*: `32768`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-inlinepolicy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "ManagedPolicies": { "MarkdownDocumentation": "`ManagedPolicies`\n\nA structure that stores a list of managed policy ARNs that describe the associated AWS managed policy.\n*Required*: No\n*Type*: Array 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-managedpolicies", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to attach to the new [AWS::SSO::PermissionSet](./aws-resource-sso-permissionset.html).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sso-permissionset-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the permission set.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PermissionsBoundary": { "MarkdownDocumentation": "`PermissionsBoundary`\n\nSpecifies the configuration of the AWS managed or customer managed policy that you\nwant to set as a permissions boundary. Specify either\n`CustomerManagedPolicyReference` to use the name and path of a customer\nmanaged policy, or `ManagedPolicyArn` to use the ARN of an AWS managed\npolicy. A permissions boundary represents the maximum permissions that any policy can\ngrant your role. For more information, see [Permissions boundaries\nfor IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.\n###### Important\nPolicies used as permissions boundaries don't provide permissions. You must also\nattach an IAM policy to the role. To learn how the effective permissions for a\nrole are evaluated, see [IAM JSON\npolicy evaluation logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User\nGuide*.\n*Required*: No\n*Type*: [PermissionsBoundary](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-permissionsboundary", "UpdateType": "Mutable", "Required": false, "Type": "PermissionsBoundary" } }, "Attributes": { "PermissionSetArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`PermissionSetArn`\n\nThe permission set ARN of the permission set, such as\n`arn:aws:sso:::permissionSet/ins-instanceid/ps-permissionsetid`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#PermissionSetArn-fn::getatt" } } }, "AWS::SageMaker::App": { "MarkdownDocumentation": "`AWS::SageMaker::App`\n\nCreates a running app for the specified UserProfile. This operation is automatically\ninvoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel\nconfigurations are selected by the user. A user may have multiple Apps active\nsimultaneously.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the app type, app name, Domain ID, and user profile\nname.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html", "Properties": { "RecoveryMode": { "MarkdownDocumentation": "`RecoveryMode`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-recoverymode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "DomainId": { "MarkdownDocumentation": "`DomainId`\n\nThe domain ID.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-domainid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceSpec": { "MarkdownDocumentation": "`ResourceSpec`\n\nSpecifies the ARNs of a SageMaker image and SageMaker image version, and the instance\ntype that the version runs on.\n*Required*: No\n*Type*: [ResourceSpec](./aws-properties-sagemaker-app-resourcespec.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-resourcespec", "UpdateType": "Immutable", "Required": false, "Type": "ResourceSpec" }, "AppType": { "MarkdownDocumentation": "`AppType`\n\nThe type of app.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `JupyterServer | KernelGatew...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "JupyterServer", "KernelGateway", "RStudioServerPro", "RSessionGateway", "Canvas" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-apptype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-sagemaker-app-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "UserProfileName": { "MarkdownDocumentation": "`UserProfileName`\n\nThe user profile name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-userprofilename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AppName": { "MarkdownDocumentation": "`AppName`\n\nThe name of the app.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-appname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AppArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AppArn`\n\nThe Amazon Resource Name (ARN) of the app, such as\n`arn:aws:sagemaker:us-west-2:account-id:app/my-app-name`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#AppArn-fn::getatt" }, "BuiltInLifecycleConfigArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`BuiltInLifecycleConfigArn`\n\nThe lifecycle configuration that runs before the default lifecycle configuration. It can\noverride changes made in the default lifecycle configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#BuiltInLifecycleConfigArn-fn::getatt" } } }, "AWS::SageMaker::AppImageConfig": { "MarkdownDocumentation": "`AWS::SageMaker::AppImageConfig`\n\nCreates a configuration for running a SageMaker AI image as a KernelGateway app. The\nconfiguration specifies the Amazon Elastic File System storage volume on the image, and a list of the\nkernels in the image.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the AppImageConfig.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html", "Properties": { "KernelGatewayImageConfig": { "MarkdownDocumentation": "`KernelGatewayImageConfig`\n\nThe configuration for the file system and kernels in the SageMaker AI image.\n*Required*: No\n*Type*: [KernelGatewayImageConfig](./aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig", "UpdateType": "Mutable", "Required": false, "Type": "KernelGatewayImageConfig" }, "CodeEditorAppImageConfig": { "MarkdownDocumentation": "`CodeEditorAppImageConfig`\n\nThe configuration for the file system and the runtime,\nsuch as the environment variables and entry point.\n*Required*: No\n*Type*: [CodeEditorAppImageConfig](./aws-properties-sagemaker-appimageconfig-codeeditorappimageconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-codeeditorappimageconfig", "UpdateType": "Mutable", "Required": false, "Type": "CodeEditorAppImageConfig" }, "AppImageConfigName": { "MarkdownDocumentation": "`AppImageConfigName`\n\nThe name of the AppImageConfig. Must be unique to your account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-appimageconfigname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "JupyterLabAppImageConfig": { "MarkdownDocumentation": "`JupyterLabAppImageConfig`\n\nThe configuration for the file system and the runtime, such as the environment variables and entry point.\n*Required*: No\n*Type*: [JupyterLabAppImageConfig](./aws-properties-sagemaker-appimageconfig-jupyterlabappimageconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-jupyterlabappimageconfig", "UpdateType": "Mutable", "Required": false, "Type": "JupyterLabAppImageConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-sagemaker-appimageconfig-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "AppImageConfigArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`AppImageConfigArn`\n\nThe Amazon Resource Name (ARN) of the AppImageConfig, such as\n`arn:aws:sagemaker:us-west-2:account-id:app-image-config/my-app-image-config-name`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#AppImageConfigArn-fn::getatt" } } }, "AWS::SageMaker::Cluster": { "MarkdownDocumentation": "`AWS::SageMaker::Cluster`\n\nCreates an Amazon SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and\nmanaging persistent clusters for developing large machine learning models, such as large\nlanguage models (LLMs) and diffusion models. To learn more, see [Amazon SageMaker HyperPod](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod.html) in the\n*Amazon SageMaker Developer Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html", "Properties": { "VpcConfig": { "MarkdownDocumentation": "`VpcConfig`\n\nSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources\nhave access to. You can control access to and from your resources by configuring a VPC.\nFor more information, see [Give SageMaker Access to\nResources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-sagemaker-cluster-vpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-vpcconfig", "UpdateType": "Immutable", "Required": false, "Type": "VpcConfig" }, "NodeRecovery": { "MarkdownDocumentation": "`NodeRecovery`\n\nSpecifies whether to enable or disable the automatic node recovery feature of SageMaker\nHyperPod. Available values are `Automatic` for enabling and `None`\nfor disabling.\n*Required*: No\n*Type*: String\n*Allowed values*: `Automatic | None...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Automatic", "None" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-noderecovery", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NodeProvisioningMode": { "MarkdownDocumentation": "`NodeProvisioningMode`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `Continuous`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "Continuous" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-nodeprovisioningmode", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InstanceGroups": { "MarkdownDocumentation": "`InstanceGroups`\n\nThe instance groups of the SageMaker HyperPod cluster. To delete an instance group,\nremove it from the array.\n*Required*: No\n*Type*: Array of [ClusterInstanceGroup](./aws-properties-sagemaker-cluster-clusterinstancegroup.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-instancegroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ClusterInstanceGroup", "DuplicatesAllowed": true }, "RestrictedInstanceGroups": { "MarkdownDocumentation": "`RestrictedInstanceGroups`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [ClusterRestrictedInstanceGroup](./aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-restrictedinstancegroups", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "ClusterRestrictedInstanceGroup", "DuplicatesAllowed": true }, "ClusterName": { "MarkdownDocumentation": "`ClusterName`\n\nThe name of the SageMaker HyperPod cluster.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-clustername", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Orchestrator": { "MarkdownDocumentation": "`Orchestrator`\n\nThe orchestrator type for the SageMaker HyperPod cluster. Currently, `'eks'`\nis the only available option.\n*Required*: No\n*Type*: [Orchestrator](./aws-properties-sagemaker-cluster-orchestrator.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-orchestrator", "UpdateType": "Immutable", "Required": false, "Type": "Orchestrator" }, "AutoScaling": { "MarkdownDocumentation": "`AutoScaling`\n\nProperty description not available.\n*Required*: No\n*Type*: [ClusterAutoScalingConfig](./aws-properties-sagemaker-cluster-clusterautoscalingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-autoscaling", "UpdateType": "Mutable", "Required": false, "Type": "ClusterAutoScalingConfig" }, "ClusterRole": { "MarkdownDocumentation": "`ClusterRole`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-clusterrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA tag object that consists of a key and an optional value, used to manage metadata\nfor SageMaker AWS resources.\nYou can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\nbatch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\nendpoints. For more information on adding tags to SageMaker resources, see [AddTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\nFor more information on adding metadata to your AWS resources with\ntagging, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for\nmanaging AWS resources with tagging, see [Tagging\nBest Practices: Implement an Effective AWS Resource Tagging\nStrategy](https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-cluster-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "TieredStorageConfig": { "MarkdownDocumentation": "`TieredStorageConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [TieredStorageConfig](./aws-properties-sagemaker-cluster-tieredstorageconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tieredstorageconfig", "UpdateType": "Mutable", "Required": false, "Type": "TieredStorageConfig" } }, "Attributes": { "ClusterArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterArn`\n\nThe Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#ClusterArn-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time when the SageMaker HyperPod cluster is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#CreationTime-fn::getatt" }, "FailureMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`FailureMessage`\n\nThe failure message of the SageMaker HyperPod cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#FailureMessage-fn::getatt" }, "ClusterStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`ClusterStatus`\n\nThe status of the SageMaker HyperPod cluster.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#ClusterStatus-fn::getatt" } } }, "AWS::SageMaker::CodeRepository": { "MarkdownDocumentation": "`AWS::SageMaker::CodeRepository`\n\nCreates a Git repository as a resource in your SageMaker AI account. You can\nassociate the repository with notebook instances so that you can use Git source control\nfor the notebooks you create. The Git repository is a resource in your SageMaker AI\naccount, so it can be associated with more than one notebook instance, and it persists\nindependently from the lifecycle of any notebook instances it is associated with.\nThe repository can be hosted either in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)\nor in any other Git repository.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the code repository.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html", "Attributes": { "CodeRepositoryName": { "PrimitiveType": "String", "MarkdownDocumentation": "`CodeRepositoryName`\n\nThe name of the code repository, such as `myCodeRepo`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#CodeRepositoryName-fn::getatt" } }, "Properties": { "CodeRepositoryName": { "Required": false, "MarkdownDocumentation": "`CodeRepositoryName`\n\nThe name of the Git repository.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-coderepositoryname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "GitConfig": { "Type": "GitConfig", "Required": true, "MarkdownDocumentation": "`GitConfig`\n\nConfiguration details for the Git repository, including the URL where it is located\nand the ARN of the AWS Secrets Manager secret that contains the\ncredentials used to access the repository.\n*Required*: Yes\n*Type*: [GitConfig](./aws-properties-sagemaker-coderepository-gitconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-gitconfig", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nList of tags for Code Repository.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-coderepository-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::SageMaker::DataQualityJobDefinition": { "MarkdownDocumentation": "`AWS::SageMaker::DataQualityJobDefinition`\n\nCreates a definition for a job that monitors data quality and drift. For information\nabout model monitor, see [Amazon SageMaker AI Model\nMonitor](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the job\ndefinition.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html", "Properties": { "DataQualityJobInput": { "MarkdownDocumentation": "`DataQualityJobInput`\n\nA list of inputs for the monitoring job. Currently endpoints are supported as monitoring\ninputs.\n*Required*: Yes\n*Type*: [DataQualityJobInput](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjobinput", "UpdateType": "Immutable", "Required": true, "Type": "DataQualityJobInput" }, "DataQualityAppSpecification": { "MarkdownDocumentation": "`DataQualityAppSpecification`\n\nSpecifies the container that runs the monitoring job.\n*Required*: Yes\n*Type*: [DataQualityAppSpecification](./aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification", "UpdateType": "Immutable", "Required": true, "Type": "DataQualityAppSpecification" }, "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-endpointname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StoppingCondition": { "MarkdownDocumentation": "`StoppingCondition`\n\nA time limit for how long the monitoring job is allowed to run before stopping.\n*Required*: No\n*Type*: [StoppingCondition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-stoppingcondition", "UpdateType": "Immutable", "Required": false, "Type": "StoppingCondition" }, "JobDefinitionName": { "MarkdownDocumentation": "`JobDefinitionName`\n\nThe name for the monitoring job definition.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-jobdefinitionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "JobResources": { "MarkdownDocumentation": "`JobResources`\n\nIdentifies the resources to deploy for a monitoring job.\n*Required*: Yes\n*Type*: [MonitoringResources](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-jobresources", "UpdateType": "Immutable", "Required": true, "Type": "MonitoringResources" }, "NetworkConfig": { "MarkdownDocumentation": "`NetworkConfig`\n\nSpecifies networking configuration for the monitoring job.\n*Required*: No\n*Type*: [NetworkConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig", "UpdateType": "Immutable", "Required": false, "Type": "NetworkConfig" }, "DataQualityJobOutputConfig": { "MarkdownDocumentation": "`DataQualityJobOutputConfig`\n\nThe output configuration for monitoring jobs.\n*Required*: Yes\n*Type*: [MonitoringOutputConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjoboutputconfig", "UpdateType": "Immutable", "Required": true, "Type": "MonitoringOutputConfig" }, "DataQualityBaselineConfig": { "MarkdownDocumentation": "`DataQualityBaselineConfig`\n\nConfigures the constraints and baselines for the monitoring job.\n*Required*: No\n*Type*: [DataQualityBaselineConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig", "UpdateType": "Immutable", "Required": false, "Type": "DataQualityBaselineConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\nperform tasks on your behalf.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-sagemaker-dataqualityjobdefinition-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "JobDefinitionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`JobDefinitionArn`\n\nThe Amazon Resource Name (ARN) of the job definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#JobDefinitionArn-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time when the job definition was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#CreationTime-fn::getatt" } } }, "AWS::SageMaker::Device": { "MarkdownDocumentation": "`AWS::SageMaker::Device`\n\nThe `AWS::SageMaker::Device` resource is an Amazon SageMaker resource type\nthat allows you to register your Devices against an existing SageMaker Edge Manager\nDeviceFleet. Each device must be listed individually in the CFN specification.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DeviceFleetName.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html", "Properties": { "DeviceFleetName": { "MarkdownDocumentation": "`DeviceFleetName`\n\nThe name of the fleet the device belongs to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html#cfn-sagemaker-device-devicefleetname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Device": { "MarkdownDocumentation": "`Device`\n\nEdge device you want to create.\n*Required*: No\n*Type*: [Device](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html#cfn-sagemaker-device-device", "UpdateType": "Mutable", "Required": false, "Type": "Device" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs that contain metadata to help you categorize and organize\nyour devices. Each tag consists of a key and a value, both of which you define.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-device-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html#cfn-sagemaker-device-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::SageMaker::DeviceFleet": { "MarkdownDocumentation": "`AWS::SageMaker::DeviceFleet`\n\nThe `AWS::SageMaker::DeviceFleet` resource is an Amazon SageMaker resource\ntype that allows you to create a DeviceFleet that manages your SageMaker Edge Manager\nDevices. You must register your devices against the `DeviceFleet`\nseparately.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DeviceFleetName.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html", "Properties": { "DeviceFleetName": { "MarkdownDocumentation": "`DeviceFleetName`\n\nName of the device fleet.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-devicefleetname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the fleet.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\S\\s]+`\n*Minimum*: `0`\n*Maximum*: `800`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "OutputConfig": { "MarkdownDocumentation": "`OutputConfig`\n\nThe output configuration for storing sample data collected by the fleet.\n*Required*: Yes\n*Type*: [EdgeOutputConfig](./aws-properties-sagemaker-devicefleet-edgeoutputconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-outputconfig", "UpdateType": "Mutable", "Required": true, "Type": "EdgeOutputConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) that has access to AWS Internet of\nThings (IoT).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs that contain metadata to help you categorize and organize\nyour device fleets. Each tag consists of a key and a value, both of which you\ndefine.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-devicefleet-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } } }, "AWS::SageMaker::Domain": { "MarkdownDocumentation": "`AWS::SageMaker::Domain`\n\nCreates a `Domain`. A domain consists of an associated Amazon Elastic File System\nvolume, a list of authorized users, and a variety of security, application, policy, and\nAmazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files\nand other artifacts with each other.\n**EFS storage**\nWhen a domain is created, an EFS volume is created for use by all of the users within the\ndomain. Each user receives a private home directory within the EFS volume for notebooks, Git\nrepositories, and data files.\nSageMaker AI uses the AWS Key Management Service (AWS\nKMS) to encrypt the EFS volume attached to the domain with an AWS managed key\nby default. For more control, you can specify a customer managed key. For more information,\nsee [Protect Data\nat Rest Using Encryption](https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html).\n**VPC configuration**\nAll traffic between the domain and the Amazon EFS volume is through the specified\nVPC and subnets. For other traffic, you can specify the `AppNetworkAccessType`\nparameter. `AppNetworkAccessType` corresponds to the network access type that you\nchoose when you onboard to the domain. The following options are available:\n* `PublicInternetOnly` - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker AI, which allows internet access. This is the default value.\n* `VpcOnly` - All traffic is through the specified VPC and subnets. Internet\n access is disabled by default. To allow internet access, you must specify a NAT\n gateway.\n \n When internet access is disabled, you won't be able to run a Amazon SageMaker AI\n Studio notebook or to train or host models unless your VPC has an interface endpoint to\n the SageMaker AI API and runtime or a NAT gateway and your security groups allow\n outbound connections.\n###### Important\nNFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\nin order to launch a Amazon SageMaker AI Studio app successfully.\nFor more information, see [Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Domain ID, such as `d-xxxxxxxxxxxx`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html", "Properties": { "AppNetworkAccessType": { "MarkdownDocumentation": "`AppNetworkAccessType`\n\nSpecifies the VPC used for non-EFS traffic. The default value is\n`PublicInternetOnly`.\n* `PublicInternetOnly` - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access\n* `VpcOnly` - All Studio traffic is through the specified VPC and\n subnets\n*Valid Values*: `PublicInternetOnly | VpcOnly`\n*Required*: No\n*Type*: String\n*Allowed values*: `PublicInternetOnly | VpcOnl...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PublicInternetOnly", "VpcOnly" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-appnetworkaccesstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultSpaceSettings": { "MarkdownDocumentation": "`DefaultSpaceSettings`\n\nThe default settings for shared spaces that users create in the domain.\nSageMaker applies these settings only to shared spaces. It doesn't apply them to private\nspaces.\n*Required*: No\n*Type*: [DefaultSpaceSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultspacesettings", "UpdateType": "Mutable", "Required": false, "Type": "DefaultSpaceSettings" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nSageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain\nwith an AWS managed customer master key (CMK) by default. For more\ncontrol, specify a customer managed CMK.\n*Length Constraints*: Maximum length of 2048.\n*Pattern*: `.*`\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcId": { "MarkdownDocumentation": "`VpcId`\n\nThe ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for\ncommunication.\n*Length Constraints*: Maximum length of 32.\n*Pattern*: `[-0-9a-zA-Z]+`\n*Required*: No\n*Type*: String\n*Pattern*: `[-0-9a-zA-Z]+`\n*Maximum*: `32`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-vpcid", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "AppSecurityGroupManagement": { "MarkdownDocumentation": "`AppSecurityGroupManagement`\n\nThe entity that creates and manages the required security groups for inter-app\ncommunication in `VpcOnly` mode. Required when\n`CreateDomain.AppNetworkAccessType` is `VpcOnly` and\n`DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is\nprovided. If setting up the domain for use with RStudio, this value must be set to\n`Service`.\n*Allowed Values*: `Service` | `Customer`\n*Required*: No\n*Type*: String\n*Allowed values*: `Service | Customer...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Service", "Customer" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-appsecuritygroupmanagement", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DefaultUserSettings": { "MarkdownDocumentation": "`DefaultUserSettings`\n\nThe default user settings.\n*Required*: Yes\n*Type*: [UserSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultusersettings", "UpdateType": "Mutable", "Required": true, "Type": "UserSettings" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe 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\nitems.\n*Pattern*: `[-0-9a-zA-Z]+`\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `32 | 16`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-subnetids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "AuthMode": { "MarkdownDocumentation": "`AuthMode`\n\nThe mode of authentication that members use to access the Domain.\n*Valid Values*: `SSO | IAM`\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SSO | IAM`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "SSO", "IAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-authmode", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags to associated with the Domain. Each tag consists of a key and an optional value.\nTag 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\nDomain.\n*Array members*: Minimum number of 0 items. Maximum number of 50\nitems.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-domain-tag.html)\n*Minimum*: `0`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "DomainSettings": { "MarkdownDocumentation": "`DomainSettings`\n\nA collection of settings that apply to the `SageMaker Domain`. These settings\nare specified through the `CreateDomain` API call.\n*Required*: No\n*Type*: [DomainSettings](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-domainsettings", "UpdateType": "Mutable", "Required": false, "Type": "DomainSettings" }, "TagPropagation": { "MarkdownDocumentation": "`TagPropagation`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-tagpropagation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "HomeEfsFileSystemId": { "PrimitiveType": "String", "MarkdownDocumentation": "`HomeEfsFileSystemId`\n\nThe ID of the Amazon Elastic File System (EFS) managed by this Domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#HomeEfsFileSystemId-fn::getatt" }, "DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainId`\n\nThe Domain ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#DomainId-fn::getatt" }, "SecurityGroupIdForDomainBoundary": { "PrimitiveType": "String", "MarkdownDocumentation": "`SecurityGroupIdForDomainBoundary`\n\nThe ID of the security group that authorizes traffic between the\n`RSessionGateway` apps and the `RStudioServerPro` app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#SecurityGroupIdForDomainBoundary-fn::getatt" }, "SingleSignOnManagedApplicationInstanceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SingleSignOnManagedApplicationInstanceId`\n\nThe IAM Identity Center managed application instance ID.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#SingleSignOnManagedApplicationInstanceId-fn::getatt" }, "SingleSignOnApplicationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SingleSignOnApplicationArn`\n\nThe ARN of the application managed by SageMaker in IAM Identity Center. This value is\nonly returned for domains created after October 1, 2023.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#SingleSignOnApplicationArn-fn::getatt" }, "DomainArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`DomainArn`\n\nThe Amazon Resource Name (ARN) of the Domain, such as\n`arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#DomainArn-fn::getatt" }, "Url": { "PrimitiveType": "String", "MarkdownDocumentation": "`Url`\n\nThe URL for the Domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#Url-fn::getatt" } } }, "AWS::SageMaker::Endpoint": { "MarkdownDocumentation": "`AWS::SageMaker::Endpoint`\n\nUse the `AWS::SageMaker::Endpoint` resource to create an endpoint using the\nspecified configuration in the request. Amazon SageMaker uses the endpoint to provision\nresources and deploy models. You create the endpoint configuration with the [AWS::SageMaker::EndpointConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource. For more information, see [Deploy a Model\non Amazon SageMaker Hosting Services](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html) in the *Amazon SageMaker Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the endpoint, such as\n`arn:aws:sagemaker:us-west-2:012345678901:endpoint/myendpoint`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html", "Attributes": { "EndpointName": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointName`\n\nThe name of the endpoint, such as `MyEndpoint`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#EndpointName-fn::getatt" } }, "Properties": { "RetainAllVariantProperties": { "Required": false, "MarkdownDocumentation": "`RetainAllVariantProperties`\n\nWhen updating endpoint resources, enables or disables the retention of variant\nproperties, such as the instance count or the variant weight. To retain the variant\nproperties of an endpoint when updating it, set `RetainAllVariantProperties` to\n`true`. To use the variant properties specified in a new\n`EndpointConfig` call when updating an endpoint, set\n`RetainAllVariantProperties` to `false`. Use this property only\nwhen updating endpoint resources, not when creating new endpoint resources.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-retainallvariantproperties", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "EndpointName": { "Required": false, "MarkdownDocumentation": "`EndpointName`\n\nThe name of the endpoint. The name must be unique within an AWS\nRegion in your AWS account. The name is case-insensitive in\n`CreateEndpoint`, but the case is preserved and must be matched in .\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `0`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-endpointname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ExcludeRetainedVariantProperties": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ExcludeRetainedVariantProperties`\n\nWhen you are updating endpoint resources with [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) whose value is set to `true`,\n`ExcludeRetainedVariantProperties` specifies the list of type [VariantProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html) to override with the values provided by\n`EndpointConfig`. If you don't specify a value for\n`ExcludeAllVariantProperties`, no variant properties are overridden. Don't\nuse this property when creating new endpoint resources or when\n`RetainAllVariantProperties` is set to `false`.\n*Required*: No\n*Type*: Array of [VariantProperty](./aws-properties-sagemaker-endpoint-variantproperty.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-excluderetainedvariantproperties", "ItemType": "VariantProperty", "UpdateType": "Mutable" }, "EndpointConfigName": { "Required": true, "MarkdownDocumentation": "`EndpointConfigName`\n\nThe name of the [AWS::SageMaker::EndpointConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource that specifies the configuration for\nthe endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-endpointconfigname", "PrimitiveType": "String", "UpdateType": "Mutable" }, "DeploymentConfig": { "Type": "DeploymentConfig", "Required": false, "MarkdownDocumentation": "`DeploymentConfig`\n\nThe deployment configuration for an endpoint, which contains the desired deployment\nstrategy and rollback configurations.\n*Required*: No\n*Type*: [DeploymentConfig](./aws-properties-sagemaker-endpoint-deploymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-deploymentconfig", "UpdateType": "Mutable" }, "RetainDeploymentConfig": { "Required": false, "MarkdownDocumentation": "`RetainDeploymentConfig`\n\nSpecifies whether to reuse the last deployment configuration. The default value is\nfalse (the configuration is not reused).\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-retaindeploymentconfig", "PrimitiveType": "Boolean", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to apply to this resource.\nFor more information, see [Resource\nTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost\nAllocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the *AWS Billing and Cost Management User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-endpoint-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::SageMaker::EndpointConfig": { "MarkdownDocumentation": "`AWS::SageMaker::EndpointConfig`\n\nThe `AWS::SageMaker::EndpointConfig` resource creates a configuration for\nan Amazon SageMaker endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) in\nthe *SageMaker Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the endpoint configuration,\nsuch as\n`arn:aws:sagemaker:us-west-2:01234567>8901:endpoint-config/myendpointconfig`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html", "Attributes": { "EndpointConfigName": { "PrimitiveType": "String", "MarkdownDocumentation": "`EndpointConfigName`\n\nThe name of the endpoint configuration, such as\n`MyEndpointConfiguration`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#EndpointConfigName-fn::getatt" } }, "Properties": { "ShadowProductionVariants": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ShadowProductionVariants`\n\nArray of `ProductionVariant` objects. There is one for each model that you\nwant to host at this endpoint in shadow mode with production traffic replicated from the\nmodel specified on `ProductionVariants`. If you use this field, you can only\nspecify one variant for `ProductionVariants` and one variant for\n`ShadowProductionVariants`.\n*Required*: No\n*Type*: Array of [ProductionVariant](./aws-properties-sagemaker-endpointconfig-productionvariant.html)\n*Minimum*: `1`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-shadowproductionvariants", "ItemType": "ProductionVariant", "UpdateType": "Immutable" }, "DataCaptureConfig": { "Type": "DataCaptureConfig", "Required": false, "MarkdownDocumentation": "`DataCaptureConfig`\n\nSpecifies how to capture endpoint data for model monitor. The data capture configuration\napplies to all production variants hosted at the endpoint.\n*Required*: No\n*Type*: [DataCaptureConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig", "UpdateType": "Immutable" }, "ExecutionRoleArn": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-executionrolearn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "EnableNetworkIsolation": { "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-enablenetworkisolation", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "ProductionVariants": { "Type": "List", "Required": true, "MarkdownDocumentation": "`ProductionVariants`\n\nA list of `ProductionVariant` objects, one for each model that you want to\nhost at this endpoint.\n*Required*: Yes\n*Type*: Array of [ProductionVariant](./aws-properties-sagemaker-endpointconfig-productionvariant.html)\n*Minimum*: `1`\n*Maximum*: `10`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-productionvariants", "ItemType": "ProductionVariant", "UpdateType": "Immutable" }, "KmsKeyId": { "Required": false, "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon Resource Name (ARN) of an AWS Key Management Service key\nthat Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute\ninstance that hosts the endpoint.\n* Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n* Key ARN:\n `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\n`CreateEndpoint`, `UpdateEndpoint` requests. For more information,\nrefer to the AWS Key Management Service section [Using Key\nPolicies in AWS KMS](https://docs.aws.amazon.com//kms/latest/developerguide/key-policies.html) \n###### Note\nCertain Nitro-based instances include local storage, dependent on the instance type.\nLocal storage volumes are encrypted using a hardware module on the instance. You can't\nrequest a `KmsKeyId` when using an instance type with local storage. If any\nof the models that you specify in the `ProductionVariants` parameter use\nnitro-based instances with local storage, do not specify a value for the\n`KmsKeyId` parameter. If you specify a value for `KmsKeyId`\nwhen using any nitro-based instances with local storage, the call to\n`CreateEndpointConfig` fails.\nFor a list of instance types that support local instance storage, see [Instance\nStore Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes).\nFor more information about local instance storage encryption, see [SSD\nInstance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html).\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9:/_-]*`\n*Minimum*: `0`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-kmskeyid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "AsyncInferenceConfig": { "Type": "AsyncInferenceConfig", "Required": false, "MarkdownDocumentation": "`AsyncInferenceConfig`\n\nSpecifies configuration for how an endpoint performs asynchronous inference.\n*Required*: No\n*Type*: [AsyncInferenceConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceconfig", "UpdateType": "Immutable" }, "VpcConfig": { "Type": "VpcConfig", "Required": false, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-vpcconfig", "UpdateType": "Immutable" }, "EndpointConfigName": { "Required": false, "MarkdownDocumentation": "`EndpointConfigName`\n\nThe name of the endpoint configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`\n*Minimum*: `0`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-endpointconfigname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ExplainerConfig": { "Type": "ExplainerConfig", "Required": false, "MarkdownDocumentation": "`ExplainerConfig`\n\nA parameter to activate explainers.\n*Required*: No\n*Type*: [ExplainerConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-explainerconfig", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to apply to this resource.\nFor more information, see [Resource\nTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost\nAllocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what).\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-endpointconfig-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::SageMaker::FeatureGroup": { "MarkdownDocumentation": "`AWS::SageMaker::FeatureGroup`\n\nCreate a new `FeatureGroup`. A `FeatureGroup` is a group of\n`Features` defined in the `FeatureStore` to describe a\n`Record`.\nThe `FeatureGroup` defines the schema and features contained in the\nFeatureGroup. A `FeatureGroup` definition is composed of a list of\n`Features`, a `RecordIdentifierFeatureName`, an\n`EventTimeFeatureName` and configurations for its `OnlineStore`\nand `OfflineStore`. Check [AWS service quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to see the `FeatureGroup`s quota\nfor your AWS account.\n###### Important\nYou must include at least one of `OnlineStoreConfig` and\n`OfflineStoreConfig` to create a `FeatureGroup`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `FeatureGroupName` of the feature group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html", "Properties": { "ThroughputConfig": { "MarkdownDocumentation": "`ThroughputConfig`\n\nUsed to set feature group throughput configuration. There are two modes:\n`ON_DEMAND` and `PROVISIONED`. With on-demand mode, you are\ncharged for data reads and writes that your application performs on your feature group. You\ndo not need to specify read and write throughput because Feature Store accommodates your\nworkloads as they ramp up and down. You can switch a feature group to on-demand only once\nin a 24 hour period. With provisioned throughput mode, you specify the read and write\ncapacity per second that you expect your application to require, and you are billed based\non those limits. Exceeding provisioned throughput will result in your requests being\nthrottled.\nNote: `PROVISIONED` throughput mode is supported only for feature groups that\nare offline-only, or use the [`Standard`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) tier online store.\n*Required*: No\n*Type*: [ThroughputConfig](./aws-properties-sagemaker-featuregroup-throughputconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-throughputconfig", "UpdateType": "Mutable", "Required": false, "Type": "ThroughputConfig" }, "Description": { "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OfflineStoreConfig": { "MarkdownDocumentation": "`OfflineStoreConfig`\n\nThe configuration of an `OfflineStore`.\n*Required*: No\n*Type*: [OfflineStoreConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-offlinestoreconfig", "UpdateType": "Immutable", "Required": false, "Type": "OfflineStoreConfig" }, "FeatureDefinitions": { "MarkdownDocumentation": "`FeatureDefinitions`\n\nA list of `Feature`s. Each `Feature` must include a\n`FeatureName` and a `FeatureType`.\nValid `FeatureType`s are `Integral`, `Fractional` and\n`String`.\n`FeatureName`s cannot be any of the following: `is_deleted`,\n`write_time`, `api_invocation_time`.\nYou can create up to 2,500 `FeatureDefinition`s per\n`FeatureGroup`.\n*Required*: Yes\n*Type*: Array of [FeatureDefinition](./aws-properties-sagemaker-featuregroup-featuredefinition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuredefinitions", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "FeatureDefinition", "DuplicatesAllowed": true }, "RecordIdentifierFeatureName": { "MarkdownDocumentation": "`RecordIdentifierFeatureName`\n\nThe name of the `Feature` whose value uniquely identifies a\n`Record` defined in the `FeatureGroup``FeatureDefinitions`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-recordidentifierfeaturename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EventTimeFeatureName": { "MarkdownDocumentation": "`EventTimeFeatureName`\n\nThe name of the feature that stores the `EventTime` of a Record in a\n`FeatureGroup`.\nA `EventTime` is point in time when a new event occurs that corresponds to\nthe creation or update of a `Record` in `FeatureGroup`. All\n`Records` in the `FeatureGroup` must have a corresponding\n`EventTime`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-eventtimefeaturename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "FeatureGroupName": { "MarkdownDocumentation": "`FeatureGroupName`\n\nThe name of the `FeatureGroup`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuregroupname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "OnlineStoreConfig": { "MarkdownDocumentation": "`OnlineStoreConfig`\n\nThe configuration of an `OnlineStore`.\n*Required*: No\n*Type*: [OnlineStoreConfig](./aws-properties-sagemaker-featuregroup-onlinestoreconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-onlinestoreconfig", "UpdateType": "Mutable", "Required": false, "Type": "OnlineStoreConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM execution role used to create the feature\ngroup.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-rolearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nTags used to define a `FeatureGroup`.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-featuregroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "FeatureGroupStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`FeatureGroupStatus`\n\nA `FeatureGroup` status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#FeatureGroupStatus-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time a `FeatureGroup` was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#CreationTime-fn::getatt" } } }, "AWS::SageMaker::Image": { "MarkdownDocumentation": "`AWS::SageMaker::Image`\n\nCreates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image\nversion represents a container image stored in Amazon ECR. For more information, see\n[Bring your own SageMaker AI image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ImageArn.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html", "Properties": { "ImageName": { "MarkdownDocumentation": "`ImageName`\n\nThe name of the Image. Must be unique by region in your account.\n*Length Constraints*: Minimum length of 1. Maximum length of 63.\n*Pattern*: `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ImageDisplayName": { "MarkdownDocumentation": "`ImageDisplayName`\n\nThe display name of the image.\n*Length Constraints*: Minimum length of 1. Maximum length of 128.\n*Pattern*: `^\\S(.*\\S)?$`\n*Required*: No\n*Type*: String\n*Pattern*: `^[A-Za-z0-9 -_]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedisplayname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ImageRoleArn": { "MarkdownDocumentation": "`ImageRoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform\ntasks on your behalf.\n*Length Constraints*: Minimum length of 20. Maximum length of\n2048.\n*Pattern*:\n`^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagerolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ImageDescription": { "MarkdownDocumentation": "`ImageDescription`\n\nThe description of the image.\n*Required*: No\n*Type*: String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedescription", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to apply to this resource.\n*Array Members*: Minimum number of 0 items. Maximum number of 50\nitems.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-image-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ImageArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ImageArn`\n\nThe Amazon Resource Name (ARN) of the image.\n*Type*: String\n*Length Constraints*: Maximum length of 256.\n*Pattern*:\n`^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#ImageArn-fn::getatt" } } }, "AWS::SageMaker::ImageVersion": { "MarkdownDocumentation": "`AWS::SageMaker::ImageVersion`\n\nCreates a version of the SageMaker image specified by `ImageName`. The\nversion represents the Amazon Container Registry (ECR) container image specified by\n`BaseImage`.\n###### Note\nYou can use the `DependsOn` attribute to specify that the creation of a\nspecific resource follows another. You can use it for the following use cases. For more\ninformation, see [`DependsOn` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).\n1. `DependsOn` can be used to establish a parent/child relationship\nbetween `ImageVersion` and `Image` where the\n`ImageVersion``DependsOn`the `Image`.\n2. `DependsOn` can be used to establish order among\n`ImageVersion`s within the same `Image` namespace. For example,\nif ImageVersionB `DependsOn` ImageVersionA and both share the same parent\n`Image`, then ImageVersionA is version N and ImageVersionB is N+1.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ImageVersionArn.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html", "Properties": { "ImageName": { "MarkdownDocumentation": "`ImageName`\n\nThe name of the parent image.\n*Length Constraints*: Minimum length of 1. Maximum length of 63.\n*Pattern*: `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[A-Za-z0-9]([-.]?[A-Za-z0-9])*$`\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-imagename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Horovod": { "MarkdownDocumentation": "`Horovod`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-horovod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "Processor": { "MarkdownDocumentation": "`Processor`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `CPU | GPU`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "AllowedValues": [ "CPU", "GPU" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-processor", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "JobType": { "MarkdownDocumentation": "`JobType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `TRAINING | INFERENCE | NOTE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "TRAINING", "INFERENCE", "NOTEBOOK_KERNEL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-jobtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Alias": { "MarkdownDocumentation": "`Alias`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `(?!^[.-])^([a-zA-Z0-9-_.]+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-alias", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProgrammingLang": { "MarkdownDocumentation": "`ProgrammingLang`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-programminglang", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VendorGuidance": { "MarkdownDocumentation": "`VendorGuidance`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `NOT_PROVIDED | STABLE | TO_...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NOT_PROVIDED", "STABLE", "TO_BE_ARCHIVED", "ARCHIVED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-vendorguidance", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "MLFramework": { "MarkdownDocumentation": "`MLFramework`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-mlframework", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Aliases": { "MarkdownDocumentation": "`Aliases`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-aliases", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ReleaseNotes": { "MarkdownDocumentation": "`ReleaseNotes`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-releasenotes", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseImage": { "MarkdownDocumentation": "`BaseImage`\n\nThe container image that the SageMaker image version is based on.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-baseimage", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ImageVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ImageVersionArn`\n\nThe Amazon Resource Name (ARN) of the image version.\n*Type*: String\n*Length Constraints*: Maximum length of 256.\n*Pattern*:\n`^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#ImageVersionArn-fn::getatt" }, "Version": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Version`\n\nThe version of the image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#Version-fn::getatt" }, "ContainerImage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ContainerImage`\n\nThe URI of the container image version referenced by ImageVersion.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#ContainerImage-fn::getatt" }, "ImageArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ImageArn`\n\nThe Amazon Resource Name (ARN) of the parent Image.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#ImageArn-fn::getatt" } } }, "AWS::SageMaker::InferenceComponent": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceComponent`\n\nCreates an inference component, which is a SageMaker AI hosting object that you can\nuse to deploy a model to an endpoint. In the inference component settings, you specify the\nmodel, the endpoint, and how the model utilizes the resources that the endpoint hosts. You\ncan optimize resource utilization by tailoring how the required CPU cores, accelerators,\nand memory are allocated. You can deploy multiple inference components to an endpoint,\nwhere each inference component contains one model and the resource utilization needs for\nthat individual model. After you deploy an inference component, you can directly invoke the\nassociated model when you use the InvokeEndpoint API action.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the inference\ncomponent.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html", "Properties": { "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nThe name of the endpoint that hosts the inference component.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VariantName": { "MarkdownDocumentation": "`VariantName`\n\nThe name of the production variant that hosts the inference component.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-variantname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "InferenceComponentName": { "MarkdownDocumentation": "`InferenceComponentName`\n\nThe name of the inference component.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-inferencecomponentname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Specification": { "MarkdownDocumentation": "`Specification`\n\nProperty description not available.\n*Required*: Yes\n*Type*: [InferenceComponentSpecification](./aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification", "UpdateType": "Mutable", "Required": true, "Type": "InferenceComponentSpecification" }, "RuntimeConfig": { "MarkdownDocumentation": "`RuntimeConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [InferenceComponentRuntimeConfig](./aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig", "UpdateType": "Mutable", "Required": false, "Type": "InferenceComponentRuntimeConfig" }, "DeploymentConfig": { "MarkdownDocumentation": "`DeploymentConfig`\n\nThe deployment configuration for an endpoint, which contains the desired deployment\nstrategy and rollback configurations.\n*Required*: No\n*Type*: [InferenceComponentDeploymentConfig](./aws-properties-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-deploymentconfig", "UpdateType": "Mutable", "Required": false, "Type": "InferenceComponentDeploymentConfig" }, "EndpointArn": { "MarkdownDocumentation": "`EndpointArn`\n\nThe Amazon Resource Name (ARN) of the endpoint that hosts the inference component.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointarn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-inferencecomponent-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Specification.Container.DeployedImage.ResolutionTime": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#Specification.Container.DeployedImage.ResolutionTime-fn::getatt" }, "InferenceComponentStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "`InferenceComponentStatus`\n\nThe status of the inference component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#InferenceComponentStatus-fn::getatt" }, "FailureReason": { "PrimitiveType": "String", "MarkdownDocumentation": "`FailureReason`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#FailureReason-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time when the inference component was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#CreationTime-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe time when the inference component was last updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#LastModifiedTime-fn::getatt" }, "InferenceComponentArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`InferenceComponentArn`\n\nThe Amazon Resource Name (ARN) of the inference component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#InferenceComponentArn-fn::getatt" }, "Specification.Container.DeployedImage.ResolvedImage": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#Specification.Container.DeployedImage.ResolvedImage-fn::getatt" }, "RuntimeConfig.CurrentCopyCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`RuntimeConfig.CurrentCopyCount`\n\nThe number of runtime copies of the model container that are currently deployed.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#RuntimeConfig.CurrentCopyCount-fn::getatt" }, "RuntimeConfig.DesiredCopyCount": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`RuntimeConfig.DesiredCopyCount`\n\nThe number of runtime copies of the model container that you requested to deploy with\nthe inference component.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#RuntimeConfig.DesiredCopyCount-fn::getatt" }, "Specification.Container.DeployedImage": { "Type": "DeployedImage", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#Specification.Container.DeployedImage-fn::getatt" }, "Specification.Container.DeployedImage.SpecifiedImage": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#Specification.Container.DeployedImage.SpecifiedImage-fn::getatt" } } }, "AWS::SageMaker::InferenceExperiment": { "MarkdownDocumentation": "`AWS::SageMaker::InferenceExperiment`\n\nCreates an inference experiment using the configurations specified in the request.\nUse this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For\nmore information about inference experiments, see [Shadow tests](https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html).\nAmazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based\non your specified configuration.\nWhile the experiment is in progress or after it has concluded, you can view metrics that compare your model\nvariants. For more information, see [View, monitor, and edit shadow tests](https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests-view-monitor-edit.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the inference experiment.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html", "Properties": { "DataStorageConfig": { "MarkdownDocumentation": "`DataStorageConfig`\n\nThe Amazon S3 location and configuration for storing inference request and response data.\n*Required*: No\n*Type*: [DataStorageConfig](./aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-datastorageconfig", "UpdateType": "Mutable", "Required": false, "Type": "DataStorageConfig" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe description of the inference experiment.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "StatusReason": { "MarkdownDocumentation": "`StatusReason`\n\nThe error message for the inference experiment status result.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-statusreason", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ModelVariants": { "MarkdownDocumentation": "`ModelVariants`\n\nAn array of `ModelVariantConfigSummary` objects. There is one for each variant in the inference\nexperiment. Each `ModelVariantConfigSummary` object in the array describes the infrastructure\nconfiguration for deploying the corresponding variant.\n*Required*: Yes\n*Type*: Array of [ModelVariantConfig](./aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-modelvariants", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "ModelVariantConfig", "DuplicatesAllowed": true }, "ShadowModeConfig": { "MarkdownDocumentation": "`ShadowModeConfig`\n\nThe configuration of `ShadowMode` inference experiment type, which shows the production variant\nthat takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the\ninference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.\n*Required*: No\n*Type*: [ShadowModeConfig](./aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig", "UpdateType": "Mutable", "Required": false, "Type": "ShadowModeConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\nAmazon SageMaker Inference endpoints for model deployment.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the inference experiment.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `120`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of the inference experiment.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ShadowMode`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "ShadowMode" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nThe name of the endpoint.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-endpointname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DesiredState": { "MarkdownDocumentation": "`DesiredState`\n\nThe desired state of the experiment after stopping. The possible states are the following:\n* `Completed`: The experiment completed successfully\n* `Cancelled`: The experiment was canceled\n*Required*: No\n*Type*: String\n*Allowed values*: `Running | Completed | Cance...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Running", "Completed", "Cancelled" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-desiredstate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nThe duration for which the inference experiment ran or will run.\nThe maximum duration that you can set for an inference experiment is 30 days.\n*Required*: No\n*Type*: [InferenceExperimentSchedule](./aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-schedule", "UpdateType": "Mutable", "Required": false, "Type": "InferenceExperimentSchedule" }, "KmsKey": { "MarkdownDocumentation": "`KmsKey`\n\nThe AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3\nserver-side encryption.\n*Required*: No\n*Type*: String\n*Pattern*: `.*`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-kmskey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-sagemaker-inferenceexperiment-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the inference experiment. The following are the possible statuses for an inference\nexperiment:\n* `Creating` - Amazon SageMaker is creating your experiment.\n* `Created` - Amazon SageMaker has finished the creation of your experiment and will begin the\n experiment at the scheduled time.\n* `Updating` - When you make changes to your experiment, your experiment shows as updating.\n* `Starting` - Amazon SageMaker is beginning your experiment.\n* `Running` - Your experiment is in progress.\n* `Stopping` - Amazon SageMaker is stopping your experiment.\n* `Completed` - Your experiment has completed.\n* `Cancelled` - When you conclude your experiment early using the [StopInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) API, or if any operation fails with an unexpected error, it shows\n as cancelled.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#Status-fn::getatt" }, "EndpointMetadata.EndpointConfigName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#EndpointMetadata.EndpointConfigName-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe timestamp at which the inference experiment was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#CreationTime-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedTime`\n\nThe timestamp at which you last modified the inference experiment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#LastModifiedTime-fn::getatt" }, "EndpointMetadata.EndpointName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#EndpointMetadata.EndpointName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe ARN for your inference experiment.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#Arn-fn::getatt" }, "EndpointMetadata.EndpointStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#EndpointMetadata.EndpointStatus-fn::getatt" }, "EndpointMetadata": { "Type": "EndpointMetadata", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#EndpointMetadata-fn::getatt" } } }, "AWS::SageMaker::MlflowTrackingServer": { "MarkdownDocumentation": "`AWS::SageMaker::MlflowTrackingServer`\n\nCreates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact\nstore. For more information, see [Create an MLflow Tracking\nServer](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html", "Properties": { "TrackingServerName": { "MarkdownDocumentation": "`TrackingServerName`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-trackingservername", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "MlflowVersion": { "MarkdownDocumentation": "`MlflowVersion`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^\\d+(\\.\\d+)+$`\n*Minimum*: `1`\n*Maximum*: `32`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-mlflowversion", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "WeeklyMaintenanceWindowStart": { "MarkdownDocumentation": "`WeeklyMaintenanceWindowStart`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$`\n*Maximum*: `9`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-weeklymaintenancewindowstart", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TrackingServerSize": { "MarkdownDocumentation": "`TrackingServerSize`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `Small | Medium | Large...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Small", "Medium", "Large" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-trackingserversize", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ArtifactStoreUri": { "MarkdownDocumentation": "`ArtifactStoreUri`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^s3:\\/\\/([^\\/]+)\\/?(.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-artifactstoreuri", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AutomaticModelRegistration": { "MarkdownDocumentation": "`AutomaticModelRegistration`\n\nProperty 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-automaticmodelregistration", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nProperty description not available.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role\\/?[a-zA-Z_0-9+=,.@\\-_\\/]+$`\n*Minimum*: `20`\n*Maximum*: `2048`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-rolearn", "UpdateType": "Conditional", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-mlflowtrackingserver-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "TrackingServerArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`TrackingServerArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#TrackingServerArn-fn::getatt" } } }, "AWS::SageMaker::Model": { "MarkdownDocumentation": "`AWS::SageMaker::Model`\n\nThe `AWS::SageMaker::Model` resource to create a model to host at an Amazon\nSageMaker endpoint. For more information, see [Deploying a Model on Amazon\nSageMaker Hosting Services](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html) in the *Amazon SageMaker Developer\nGuide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the model, such as\n`arn:aws:sagemaker:us-west-2:012345678901:model/mymodel`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html", "Attributes": { "ModelName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModelName`\n\nThe name of the model, such as `MyModel`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#ModelName-fn::getatt" } }, "Properties": { "ExecutionRoleArn": { "Required": false, "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\nartifacts and docker image for deployment on ML compute instances or for batch transform\njobs. Deploying on ML compute instances is part of model hosting. For more information,\nsee [SageMaker\nRoles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\n###### Note\nTo be able to pass this role to SageMaker, the caller of this API must have the\n`iam:PassRole` permission.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-executionrolearn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "EnableNetworkIsolation": { "Required": false, "MarkdownDocumentation": "`EnableNetworkIsolation`\n\nIsolates the model container. No inbound or outbound network calls can be made to or\nfrom the model container.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-enablenetworkisolation", "PrimitiveType": "Boolean", "UpdateType": "Immutable" }, "PrimaryContainer": { "Type": "ContainerDefinition", "Required": false, "MarkdownDocumentation": "`PrimaryContainer`\n\nThe location of the primary docker image containing inference code, associated\nartifacts, and custom environment map that the inference code uses when the model is\ndeployed for predictions.\n*Required*: No\n*Type*: [ContainerDefinition](./aws-properties-sagemaker-model-containerdefinition.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-primarycontainer", "UpdateType": "Immutable" }, "ModelName": { "Required": false, "MarkdownDocumentation": "`ModelName`\n\nThe name of the new model.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?`\n*Minimum*: `0`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-modelname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "VpcConfig": { "Type": "VpcConfig", "Required": false, "MarkdownDocumentation": "`VpcConfig`\n\nA [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) object that specifies the VPC that you want your model to connect to.\nControl access to and from your model container by configuring the VPC.\n`VpcConfig` is used in hosting services and in batch transform. For more\ninformation, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch\nTransform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html).\n*Required*: No\n*Type*: [VpcConfig](./aws-properties-sagemaker-model-vpcconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-vpcconfig", "UpdateType": "Immutable" }, "Containers": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Containers`\n\nSpecifies the containers in the inference pipeline.\n*Required*: No\n*Type*: Array of [ContainerDefinition](./aws-properties-sagemaker-model-containerdefinition.html)\n*Minimum*: `0`\n*Maximum*: `15`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-containers", "ItemType": "ContainerDefinition", "UpdateType": "Immutable" }, "InferenceExecutionConfig": { "Type": "InferenceExecutionConfig", "Required": false, "MarkdownDocumentation": "`InferenceExecutionConfig`\n\nSpecifies details of how containers in a multi-container endpoint are called.\n*Required*: No\n*Type*: [InferenceExecutionConfig](./aws-properties-sagemaker-model-inferenceexecutionconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-inferenceexecutionconfig", "UpdateType": "Immutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to apply to this resource.\nFor more information, see [Resource\nTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost\nAllocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the *AWS Billing and Cost Management User Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-model-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-tags", "ItemType": "Tag", "UpdateType": "Mutable" } } }, "AWS::SageMaker::ModelBiasJobDefinition": { "MarkdownDocumentation": "`AWS::SageMaker::ModelBiasJobDefinition`\n\nCreates the definition for a model bias job.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the job\ndefinition.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html", "Properties": { "ModelBiasJobInput": { "MarkdownDocumentation": "`ModelBiasJobInput`\n\nInputs for the model bias job.\n*Required*: Yes\n*Type*: [ModelBiasJobInput](./aws-properties-sagemaker-modelbiasjobdefinition-modelbiasjobinput.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasjobinput", "UpdateType": "Immutable", "Required": true, "Type": "ModelBiasJobInput" }, "ModelBiasJobOutputConfig": { "MarkdownDocumentation": "`ModelBiasJobOutputConfig`\n\nThe output configuration for monitoring jobs.\n*Required*: Yes\n*Type*: [MonitoringOutputConfig](./aws-properties-sagemaker-modelbiasjobdefinition-monitoringoutputconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasjoboutputconfig", "UpdateType": "Immutable", "Required": true, "Type": "MonitoringOutputConfig" }, "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-endpointname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StoppingCondition": { "MarkdownDocumentation": "`StoppingCondition`\n\nA time limit for how long the monitoring job is allowed to run before stopping.\n*Required*: No\n*Type*: [StoppingCondition](./aws-properties-sagemaker-modelbiasjobdefinition-stoppingcondition.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-stoppingcondition", "UpdateType": "Immutable", "Required": false, "Type": "StoppingCondition" }, "JobDefinitionName": { "MarkdownDocumentation": "`JobDefinitionName`\n\nThe name of the bias job definition. The name must be unique within an AWS Region in the AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-jobdefinitionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "JobResources": { "MarkdownDocumentation": "`JobResources`\n\nIdentifies the resources to deploy for a monitoring job.\n*Required*: Yes\n*Type*: [MonitoringResources](./aws-properties-sagemaker-modelbiasjobdefinition-monitoringresources.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-jobresources", "UpdateType": "Immutable", "Required": true, "Type": "MonitoringResources" }, "NetworkConfig": { "MarkdownDocumentation": "`NetworkConfig`\n\nNetworking options for a model bias job.\n*Required*: No\n*Type*: [NetworkConfig](./aws-properties-sagemaker-modelbiasjobdefinition-networkconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-networkconfig", "UpdateType": "Immutable", "Required": false, "Type": "NetworkConfig" }, "ModelBiasBaselineConfig": { "MarkdownDocumentation": "`ModelBiasBaselineConfig`\n\nThe baseline configuration for a model bias job.\n*Required*: No\n*Type*: [ModelBiasBaselineConfig](./aws-properties-sagemaker-modelbiasjobdefinition-modelbiasbaselineconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasbaselineconfig", "UpdateType": "Immutable", "Required": false, "Type": "ModelBiasBaselineConfig" }, "ModelBiasAppSpecification": { "MarkdownDocumentation": "`ModelBiasAppSpecification`\n\nConfigures the model bias job to run a specified Docker container image.\n*Required*: Yes\n*Type*: [ModelBiasAppSpecification](./aws-properties-sagemaker-modelbiasjobdefinition-modelbiasappspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasappspecification", "UpdateType": "Immutable", "Required": true, "Type": "ModelBiasAppSpecification" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\nperform tasks on your behalf.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-sagemaker-modelbiasjobdefinition-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "JobDefinitionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`JobDefinitionArn`\n\nThe Amazon Resource Name (ARN) of the job definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#JobDefinitionArn-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time when the job definition was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#CreationTime-fn::getatt" } } }, "AWS::SageMaker::ModelCard": { "MarkdownDocumentation": "`AWS::SageMaker::ModelCard`\n\nCreates an Amazon SageMaker Model Card.\nFor information about how to use model cards, see [Amazon SageMaker Model Card](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the model card name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html", "Properties": { "LastModifiedBy": { "MarkdownDocumentation": "`LastModifiedBy`\n\nProperty description not available.\n*Required*: No\n*Type*: [UserContext](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-lastmodifiedby", "UpdateType": "Mutable", "Required": false, "Type": "UserContext" }, "ModelCardName": { "MarkdownDocumentation": "`ModelCardName`\n\nThe unique name of the model card.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ModelCardStatus": { "MarkdownDocumentation": "`ModelCardStatus`\n\nThe 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\n card, but it can still be exported.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `Draft | PendingReview | App...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Draft", "PendingReview", "Approved", "Archived" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "CreatedBy": { "MarkdownDocumentation": "`CreatedBy`\n\nInformation 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-createdby", "UpdateType": "Mutable", "Required": false, "Type": "UserContext" }, "SecurityConfig": { "MarkdownDocumentation": "`SecurityConfig`\n\nThe security configuration used to protect model card data.\n*Required*: No\n*Type*: [SecurityConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-securityconfig", "UpdateType": "Immutable", "Required": false, "Type": "SecurityConfig" }, "Content": { "MarkdownDocumentation": "`Content`\n\nThe content of the model card. Content uses the [model card JSON\nschema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema).\n*Required*: Yes\n*Type*: [Content](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-content", "UpdateType": "Mutable", "Required": true, "Type": "Content" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs used to manage metadata for the model card.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-modelcard-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "LastModifiedBy.UserProfileArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastModifiedBy.UserProfileArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#LastModifiedBy.UserProfileArn-fn::getatt" }, "CreatedBy.DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedBy.DomainId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#CreatedBy.DomainId-fn::getatt" }, "ModelCardArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ModelCardArn`\n\nThe Amazon Resource Number (ARN) of the model card. For example,\n`arn:aws:sagemaker:us-west-2:012345678901:modelcard/examplemodelcard`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#ModelCardArn-fn::getatt" }, "CreatedBy.UserProfileName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#CreatedBy.UserProfileName-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#CreationTime-fn::getatt" }, "LastModifiedTime": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#LastModifiedTime-fn::getatt" }, "LastModifiedBy.DomainId": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#LastModifiedBy.DomainId-fn::getatt" }, "ModelCardVersion": { "PrimitiveType": "Integer", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#ModelCardVersion-fn::getatt" }, "ModelCardProcessingStatus": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#ModelCardProcessingStatus-fn::getatt" }, "LastModifiedBy.UserProfileName": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#LastModifiedBy.UserProfileName-fn::getatt" }, "CreatedBy.UserProfileArn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#CreatedBy.UserProfileArn-fn::getatt" } } }, "AWS::SageMaker::ModelExplainabilityJobDefinition": { "MarkdownDocumentation": "`AWS::SageMaker::ModelExplainabilityJobDefinition`\n\nCreates the definition for a model explainability job.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the job\ndefinition.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html", "Properties": { "ModelExplainabilityJobOutputConfig": { "MarkdownDocumentation": "`ModelExplainabilityJobOutputConfig`\n\nThe output configuration for monitoring jobs.\n*Required*: Yes\n*Type*: [MonitoringOutputConfig](./aws-properties-sagemaker-modelexplainabilityjobdefinition-monitoringoutputconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjoboutputconfig", "UpdateType": "Immutable", "Required": true, "Type": "MonitoringOutputConfig" }, "EndpointName": { "MarkdownDocumentation": "`EndpointName`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StoppingCondition": { "MarkdownDocumentation": "`StoppingCondition`\n\nA time limit for how long the monitoring job is allowed to run before stopping.\n*Required*: No\n*Type*: [StoppingCondition](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-stoppingcondition", "UpdateType": "Immutable", "Required": false, "Type": "StoppingCondition" }, "ModelExplainabilityBaselineConfig": { "MarkdownDocumentation": "`ModelExplainabilityBaselineConfig`\n\nThe baseline configuration for a model explainability job.\n*Required*: No\n*Type*: [ModelExplainabilityBaselineConfig](./aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig", "UpdateType": "Immutable", "Required": false, "Type": "ModelExplainabilityBaselineConfig" }, "JobDefinitionName": { "MarkdownDocumentation": "`JobDefinitionName`\n\nThe name of the model explainability job definition. The name must be unique within an\nAWS Region in the AWS account.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-jobdefinitionname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "JobResources": { "MarkdownDocumentation": "`JobResources`\n\nIdentifies the resources to deploy for a monitoring job.\n*Required*: Yes\n*Type*: [MonitoringResources](./aws-properties-sagemaker-modelexplainabilityjobdefinition-monitoringresources.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-jobresources", "UpdateType": "Immutable", "Required": true, "Type": "MonitoringResources" }, "NetworkConfig": { "MarkdownDocumentation": "`NetworkConfig`\n\nNetworking options for a model explainability job.\n*Required*: No\n*Type*: [NetworkConfig](./aws-properties-sagemaker-modelexplainabilityjobdefinition-networkconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-networkconfig", "UpdateType": "Immutable", "Required": false, "Type": "NetworkConfig" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to\nperform tasks on your behalf.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ModelExplainabilityJobInput": { "MarkdownDocumentation": "`ModelExplainabilityJobInput`\n\nInputs for the model explainability job.\n*Required*: Yes\n*Type*: [ModelExplainabilityJobInput](./aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput", "UpdateType": "Immutable", "Required": true, "Type": "ModelExplainabilityJobInput" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn 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*: Array of [Tag](./aws-properties-sagemaker-modelexplainabilityjobdefinition-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-tags", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ModelExplainabilityAppSpecification": { "MarkdownDocumentation": "`ModelExplainabilityAppSpecification`\n\nConfigures the model explainability job to run a specified Docker container\nimage.\n*Required*: Yes\n*Type*: [ModelExplainabilityAppSpecification](./aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification", "UpdateType": "Immutable", "Required": true, "Type": "ModelExplainabilityAppSpecification" } }, "Attributes": { "JobDefinitionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`JobDefinitionArn`\n\nThe Amazon Resource Name (ARN) of the job definition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#JobDefinitionArn-fn::getatt" }, "CreationTime": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreationTime`\n\nThe time when the job definition was created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#CreationTime-fn::getatt" } } }, "AWS::SageMaker::ModelPackage": { "MarkdownDocumentation": "`AWS::SageMaker::ModelPackage`\n\nA container for your trained model that can be deployed for SageMaker inference. This can\ninclude inference code, artifacts, and metadata. The model package type can be one of\nthe following.\n* Versioned model: A part of a model package group in Model Registry.\n* Unversioned model: Not part of a model package group and used in AWS Marketplace.\nFor more information, see [`CreateModelPackage`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModelPackage.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the model package\ngroup.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html", "Properties": { "DriftCheckBaselines": { "MarkdownDocumentation": "`DriftCheckBaselines`\n\nRepresents the drift check baselines that can be used when the model monitor is set\nusing the model package.\n*Required*: No\n*Type*: [DriftCheckBaselines](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-driftcheckbaselines", "UpdateType": "Immutable", "Required": false, "Type": "DriftCheckBaselines" }, "ModelMetrics": { "MarkdownDocumentation": "`ModelMetrics`\n\nMetrics for the model.\n*Required*: No\n*Type*: [ModelMetrics](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelmetrics", "UpdateType": "Immutable", "Required": false, "Type": "ModelMetrics" }, "Task": { "MarkdownDocumentation": "`Task`\n\nThe machine learning task your model package accomplishes. Common machine learning\ntasks 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-task", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CustomerMetadataProperties": { "MarkdownDocumentation": "`CustomerMetadataProperties`\n\nThe metadata properties for the model package.\n*Required*: No\n*Type*: Object of String\n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-customermetadataproperties", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "String" }, "SourceUri": { "MarkdownDocumentation": "`SourceUri`\n\nThe URI of the source for the model package.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{N}\\p{P}]{0,1024}`\n*Minimum*: `0`\n*Maximum*: `1024`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-sourceuri", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "ModelApprovalStatus": { "MarkdownDocumentation": "`ModelApprovalStatus`\n\nThe 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\n approval.\n*Required*: No\n*Type*: String\n*Allowed values*: `Approved | Rejected | Pendi...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "Approved", "Rejected", "PendingManualApproval" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelapprovalstatus", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ModelPackageVersion": { "MarkdownDocumentation": "`ModelPackageVersion`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackageversion", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "MetadataProperties": { "MarkdownDocumentation": "`MetadataProperties`\n\nMetadata properties of the tracking entity, trial, or trial component.\n*Required*: No\n*Type*: [MetadataProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-metadataproperties", "UpdateType": "Immutable", "Required": false, "Type": "MetadataProperties" }, "SourceAlgorithmSpecification": { "MarkdownDocumentation": "`SourceAlgorithmSpecification`\n\nA list of algorithms that were used to create a model package.\n*Required*: No\n*Type*: [SourceAlgorithmSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-sourcealgorithmspecification", "UpdateType": "Immutable", "Required": false, "Type": "SourceAlgorithmSpecification" }, "ModelPackageStatusDetails": { "MarkdownDocumentation": "`ModelPackageStatusDetails`\n\nSpecifies the validation and image scan statuses of the model package.\n*Required*: No\n*Type*: [ModelPackageStatusDetails](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagestatusdetails", "UpdateType": "Mutable", "Required": false, "Type": "ModelPackageStatusDetails" }, "ModelPackageDescription": { "MarkdownDocumentation": "`ModelPackageDescription`\n\nThe description of the model package.\n*Required*: No\n*Type*: String\n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagedescription", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AdditionalInferenceSpecificationsToAdd": { "MarkdownDocumentation": "`AdditionalInferenceSpecificationsToAdd`\n\nAn array of additional Inference Specification objects to be added to the existing\narray. The total number of additional Inference Specification objects cannot exceed 15.\nEach additional Inference Specification object specifies artifacts based on this model\npackage that can be used on inference endpoints. Generally used with SageMaker Neo to store\nthe compiled artifacts.\n*Required*: No\n*Type*: Array of [AdditionalInferenceSpecificationDefinition](./aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-additionalinferencespecificationstoadd", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "AdditionalInferenceSpecificationDefinition", "DuplicatesAllowed": true }, "SecurityConfig": { "MarkdownDocumentation": "`SecurityConfig`\n\nProperty description not available.\n*Required*: No\n*Type*: [SecurityConfig](./aws-properties-sagemaker-modelpackage-securityconfig.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-securityconfig", "UpdateType": "Immutable", "Required": false, "Type": "SecurityConfig" }, "InferenceSpecification": { "MarkdownDocumentation": "`InferenceSpecification`\n\nDefines how to perform inference generation after a training job is run.\n*Required*: No\n*Type*: [InferenceSpecification](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-inferencespecification", "UpdateType": "Immutable", "Required": false, "Type": "InferenceSpecification" }, "SamplePayloadUrl": { "MarkdownDocumentation": "`SamplePayloadUrl`\n\nThe Amazon Simple Storage Service path where the sample payload are stored. This path must point to a\nsingle gzip compressed tar archive (.tar.gz suffix).\n*Required*: No\n*Type*: String\n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`\n*Maximum*: `1024`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-samplepayloadurl", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA 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\nReference Guide*.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-sagemaker-modelpackage-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "CertifyForMarketplace": { "MarkdownDocumentation": "`CertifyForMarketplace`\n\nWhether the model package is to be certified to be listed on AWS\nMarketplace. For information about listing model packages on AWS\nMarketplace, see [List Your Algorithm or Model\nPackage 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-certifyformarketplace", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ModelPackageGroupName": { "MarkdownDocumentation": "`ModelPackageGroupName`\n\nThe model group to which the model belongs.\n*Required*: No\n*Type*: String\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})(?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\n `ServiceId` must include settings for an `A`\n record, an `AAAA` record, or both.\n* In the service that is specified by `ServiceId`, the value of\n `RoutingPolicy` must be `WEIGHTED`.\n* If the service that is specified by `ServiceId` includes\n `HealthCheckConfig` settings, AWS Cloud Map will\n create the health check, but it won't associate the health check with the\n alias record.\n* Auto naming currently doesn't support creating alias records that route\n traffic to AWS resources other than ELB load\n balancers.\n* If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify\n values for any of the `AWS_INSTANCE` attributes.\n\nAWS\\_EC2\\_INSTANCE\\_ID\n*HTTP namespaces only.* The Amazon EC2 instance ID for the\ninstance. The `AWS_INSTANCE_IPV4` attribute contains the primary\nprivate 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\n`AWS_EC2_INSTANCE_ID` attribute is specified, the only other\nattribute that can be specified is `AWS_INIT_HEALTH_STATUS`. After the\nresource has been created, the `AWS_INSTANCE_IPV4` attribute contains\nthe primary private IPv4 address.\n\nAWS\\_INIT\\_HEALTH\\_STATUS\nIf the service configuration includes `HealthCheckCustomConfig`,\nwhen 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\n`AWS_INIT_HEALTH_STATUS` to specify the initial status of the custom\nhealth check, `HEALTHY` or `UNHEALTHY`. If you don't specify\na value for `AWS_INIT_HEALTH_STATUS`, the initial status is\n`HEALTHY`. This attribute can only be used when creating resources\nand will not be seen on existing resources.\n\nAWS\\_INSTANCE\\_CNAME\nIf the service configuration includes a `CNAME` record, the domain\nname that you want Route\u00a053 to return in response to DNS queries, for example,\n`example.com`.\nThis value is required if the service specified by `ServiceId`\nincludes settings for an `CNAME` record.\n\nAWS\\_INSTANCE\\_IPV4\nIf the service configuration includes an `A` record, the IPv4\naddress that you want Route\u00a053 to return in response to DNS queries, for example,\n`192.0.2.44`.\nThis value is required if the service specified by `ServiceId`\nincludes settings for an `A` record. If the service includes settings\nfor an `SRV` record, you must specify a value for\n`AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.\n\nAWS\\_INSTANCE\\_IPV6\nIf the service configuration includes an `AAAA` record, the IPv6\naddress that you want Route\u00a053 to return in response to DNS queries, for example,\n`2001:0db8:85a3:0000:0000:abcd:0001:2345`.\nThis value is required if the service specified by `ServiceId`\nincludes settings for an `AAAA` record. If the service includes\nsettings for an `SRV` record, you must specify a value for\n`AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.\n\nAWS\\_INSTANCE\\_PORT\nIf the service includes an `SRV` record, the value that you want\nRoute\u00a053 to return for the port.\nIf the service includes `HealthCheckConfig`, the port on the\nendpoint that you want Route\u00a053 to send requests to.\nThis value is required if you specified settings for an `SRV` record\nor a Route\u00a053 health check when you created the service.\n\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceattributes", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "InstanceId": { "Required": false, "MarkdownDocumentation": "`InstanceId`\n\nAn 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\n `SRV` record, the value of `InstanceId` is automatically included as\n part of the value for the `SRV` record. For more information, see [DnsRecord >\n 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\n you register by using the same service.\n* If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud Map\n updates the existing DNS records, if any. If there's also an existing health check, AWS Cloud Map\n deletes the old health check and creates a new one.\n \n ###### Note\n \n The health check isn't deleted immediately, so it will still appear for a while if you\n submit a `ListHealthChecks` request, for example.\n###### Note\nDo not include sensitive information in `InstanceId` if the namespace is\ndiscoverable by public DNS queries and any `Type` member of `DnsRecord`\nfor the service contains `SRV` because the `InstanceId` is discoverable by\npublic DNS queries.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z_/:.@-]+$`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "ServiceId": { "Required": true, "MarkdownDocumentation": "`ServiceId`\n\nThe ID or Amazon Resource Name (ARN) of the service that you want to use for settings for the instance. For\nservices created in a shared namespace, specify the service ARN. For more information about\nshared namespaces, see [Cross-account AWS Cloud Map namespace sharing](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) in the\n*AWS Cloud Map Developer Guide*.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-serviceid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::ServiceDiscovery::PrivateDnsNamespace": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::PrivateDnsNamespace`\n\nCreates a private namespace based on DNS, which is visible only inside a specified Amazon\nVPC. The namespace defines your service naming scheme. For example, if you name your namespace\n`example.com` and name your service `backend`, the resulting DNS name for\nthe service is `backend.example.com`. Service instances that are registered using a\nprivate DNS namespace can be discovered using either a `DiscoverInstances` request or\nusing DNS. For the current quota on the number of namespaces that you can create using the same\nAWS account, see [AWS Cloud Map quotas](https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the\n*AWS Cloud Map Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the value of `Id` for the namespace, such as\n`ns-e4anhexample0004`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html", "Attributes": { "HostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`HostedZoneId`\n\nThe ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\nnamespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#HostedZoneId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the private namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the private namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#Arn-fn::getatt" } }, "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Vpc": { "Required": true, "MarkdownDocumentation": "`Vpc`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-vpc", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Properties": { "Type": "Properties", "Required": false, "MarkdownDocumentation": "`Properties`\n\nProperties for the\nprivate DNS namespace.\n*Required*: No\n*Type*: [Properties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-properties", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags for the namespace. Each tag consists of a key and an optional value, both of\nwhich you define. Tag keys can have a maximum character length of 128 characters, and tag\nvalues can have a maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-servicediscovery-privatednsnamespace-tag.html)\n*Minimum*: `0`\n*Maximum*: `200`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name that you want to assign to this namespace. When you create a private DNS namespace,\nAWS Cloud Map automatically creates an Amazon Route\u00a053 private hosted zone that has the same name as the\nnamespace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!arn:)[!-~]{1,253}$`\n*Maximum*: `253`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::ServiceDiscovery::PublicDnsNamespace": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::PublicDnsNamespace`\n\nCreates a public namespace based on DNS, which is visible on the internet. The namespace\ndefines your service naming scheme. For example, if you name your namespace\n`example.com` and name your service `backend`, the resulting DNS name for\nthe service is `backend.example.com`. You can discover instances that were registered\nwith a public DNS namespace by using either a `DiscoverInstances` request or using\nDNS. For the current quota on the number of namespaces that you can create using the same AWS account, see [AWS Cloud Map quotas](https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the\n*AWS Cloud Map Developer Guide*.\n###### Important\nThe `CreatePublicDnsNamespace` API operation is not supported in the AWS GovCloud (US) Regions.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the value of `Id` for the namespace, such as\n`ns-e4anhexample0004`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html", "Attributes": { "HostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`HostedZoneId`\n\nThe ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\nnamespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#HostedZoneId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the public namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the public namespace.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#Arn-fn::getatt" } }, "Properties": { "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nA 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#cfn-servicediscovery-publicdnsnamespace-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "Properties": { "Type": "Properties", "Required": false, "MarkdownDocumentation": "`Properties`\n\nProperties for the\npublic DNS namespace.\n*Required*: No\n*Type*: [Properties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#cfn-servicediscovery-publicdnsnamespace-properties", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags for the namespace. Each tag consists of a key and an optional value, both of\nwhich you define. Tag keys can have a maximum character length of 128 characters, and tag\nvalues can have a maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-servicediscovery-publicdnsnamespace-tag.html)\n*Minimum*: `0`\n*Maximum*: `200`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#cfn-servicediscovery-publicdnsnamespace-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name that you want to assign to this namespace.\n###### Note\nDo not include sensitive information in the name. The name is publicly available using DNS\nqueries.\n*Required*: Yes\n*Type*: String\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*Maximum*: `253`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#cfn-servicediscovery-publicdnsnamespace-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::ServiceDiscovery::Service": { "MarkdownDocumentation": "`AWS::ServiceDiscovery::Service`\n\nA complex type that contains information about the specified service.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the value of `Id` for the service, such as\n`srv-e4anhexample0004`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html", "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name that you assigned to the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#Name-fn::getatt" } }, "Properties": { "Type": { "Required": false, "MarkdownDocumentation": "`Type`\n\nIf present, specifies that the service instances are only discoverable using the\n`DiscoverInstances` API operation. No DNS records is registered for the service\ninstances. The only valid value is `HTTP`.\n*Required*: No\n*Type*: String\n*Allowed values*: `HTTP`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "HTTP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-type", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Description": { "Required": false, "MarkdownDocumentation": "`Description`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-description", "PrimitiveType": "String", "UpdateType": "Mutable" }, "HealthCheckCustomConfig": { "Type": "HealthCheckCustomConfig", "Required": false, "MarkdownDocumentation": "`HealthCheckCustomConfig`\n\nA complex type that contains information about an optional custom health check.\n###### Important\nIf you specify a health check configuration, you can specify either\n`HealthCheckCustomConfig` or `HealthCheckConfig` but not both.\n*Required*: No\n*Type*: [HealthCheckCustomConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-healthcheckcustomconfig", "UpdateType": "Immutable" }, "DnsConfig": { "Type": "DnsConfig", "Required": false, "MarkdownDocumentation": "`DnsConfig`\n\nA complex type that contains information about the Route\u00a053 DNS records that you want\nAWS Cloud Map to create when you register an instance.\n###### Important\nThe record types of a service can only be changed by deleting the service and recreating it\nwith a new `Dnsconfig`.\n*Required*: No\n*Type*: [DnsConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-dnsconfig", "UpdateType": "Mutable" }, "ServiceAttributes": { "Required": false, "MarkdownDocumentation": "`ServiceAttributes`\n\nA complex type that contains information about attributes associated with a specific\nservice.\n*Required*: No\n*Type*: Json\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-serviceattributes", "PrimitiveType": "Json", "UpdateType": "Mutable" }, "NamespaceId": { "Required": false, "MarkdownDocumentation": "`NamespaceId`\n\nThe ID or Amazon Resource Name (ARN) of the namespace that you want to use to create the service. For\nnamespaces shared with your AWS account, specify the namespace ARN. For more information\nabout shared namespaces, see [Cross-account AWS Cloud Map namespace sharing](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) in the\n*AWS Cloud Map Developer Guide*.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-namespaceid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "HealthCheckConfig": { "Type": "HealthCheckConfig", "Required": false, "MarkdownDocumentation": "`HealthCheckConfig`\n\n*Public DNS and HTTP namespaces only.* A complex type that contains\nsettings for an optional health check. If you specify settings for a health check, AWS Cloud Map\nassociates the health check with the records that you specify in `DnsConfig`.\nFor information about the charges for health checks, see [Amazon Route\u00a053 Pricing](https://aws.amazon.com/route53/pricing/).\n*Required*: No\n*Type*: [HealthCheckConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-healthcheckconfig", "UpdateType": "Mutable" }, "Tags": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Tags`\n\nThe tags for the service. Each tag consists of a key and an optional value, both of\nwhich you define. Tag keys can have a maximum character length of 128 characters, and tag\nvalues can have a maximum length of 256 characters.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-servicediscovery-service-tag.html)\n*Minimum*: `0`\n*Maximum*: `200`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-tags", "ItemType": "Tag", "UpdateType": "Mutable" }, "Name": { "Required": false, "MarkdownDocumentation": "`Name`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::Shield::DRTAccess": { "MarkdownDocumentation": "`AWS::Shield::DRTAccess`\n\nProvides permissions for the AWS Shield Advanced Shield response team (SRT) to access\nyour account and your resource protections, to help you mitigate potential distributed denial of service (DDoS) attacks.\n**Configure `AWS::Shield::DRTAccess` for one account**\nTo configure this resource through CloudFormation, you must be subscribed to AWS Shield Advanced. You can subscribe\nthrough the [Shield Advanced console](https://console.aws.amazon.com/wafv2/shieldv2#/) and through\nthe APIs. For more information, see\n[Subscribe to AWS Shield Advanced](https://docs.aws.amazon.com/waf/latest/developerguide/enable-ddos-prem.html).\nSee example templates for Shield Advanced in CloudFormation at [aws-samples/aws-shield-advanced-examples](https://github.com/aws-samples/aws-shield-advanced-examples).\n**Configure Shield Advanced using AWS CloudFormation and AWS Firewall Manager**\nYou might be able to use Firewall Manager with AWS CloudFormation to configure Shield Advanced across multiple accounts and protected resources. To do this, your accounts must be part of an organization in AWS Organizations. You can use Firewall Manager to configure Shield Advanced protections for any resource types except for Amazon Route\u00a053 or AWS Global Accelerator.\nFor an example of this, see the one-click configuration guidance published by the AWS technical community at\n[One-click deployment of Shield Advanced](https://youtu.be/LCA3FwMk_QE).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the account that submitted the template.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-drtaccess.html", "Properties": { "LogBucketList": { "MarkdownDocumentation": "`LogBucketList`\n\nAuthorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.\nUse this to share information with the SRT that's not available in AWS WAF logs.\nTo use the services of the SRT, you must be subscribed to the [Business Support plan](https://aws.amazon.com/premiumsupport/business-support/) or the [Enterprise Support plan](https://aws.amazon.com/premiumsupport/enterprise-support/).\n*Required*: No\n*Type*: Array of String\n*Minimum*: `3 | 0`\n*Maximum*: `63 | 10`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-drtaccess.html#cfn-shield-drtaccess-logbucketlist", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nAuthorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and logs and to create or update AWS WAF rules and web ACLs.\nYou can associate only one `RoleArn` with your subscription. If you submit this update for an account that already has an associated role, the new `RoleArn` will replace the existing `RoleArn`.\nThis change requires the following:\n* You must be subscribed to the [Business Support plan](https://aws.amazon.com/premiumsupport/business-support/) or the [Enterprise Support plan](https://aws.amazon.com/premiumsupport/enterprise-support/).\n* The `AWSShieldDRTAccessPolicy` managed policy must be attached to the role that you specify in the request.\n You can access this policy in the IAM console at\n [AWSShieldDRTAccessPolicy](https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy).\n For information, see [Adding and removing IAM identity permissions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html).\n* The role must trust the service principal `drt.shield.amazonaws.com`. For information, see [IAM JSON policy elements: Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html).\nThe SRT will have access only to your AWS WAF and Shield resources. By submitting this request, you provide permissions to the SRT\nto inspect your AWS WAF and Shield configuration and logs, and to create and update AWS WAF rules and web ACLs on your behalf.\nThe SRT takes these actions only if explicitly authorized by you.\n*Required*: Yes\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-drtaccess.html#cfn-shield-drtaccess-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe ID of the account that submitted the template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-drtaccess.html#AccountId-fn::getatt" } } }, "AWS::Shield::ProactiveEngagement": { "MarkdownDocumentation": "`AWS::Shield::ProactiveEngagement`\n\nAuthorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.\nTo enable proactive engagement, you must be subscribed to the [Business Support plan](https://aws.amazon.com/premiumsupport/business-support/) or the [Enterprise Support plan](https://aws.amazon.com/premiumsupport/enterprise-support/).\n**Configure `AWS::Shield::ProactiveEngagement` for one account**\nTo configure this resource through CloudFormation, you must be subscribed to AWS Shield Advanced. You can subscribe\nthrough the [Shield Advanced console](https://console.aws.amazon.com/wafv2/shieldv2#/) and through\nthe APIs. For more information, see\n[Subscribe to AWS Shield Advanced](https://docs.aws.amazon.com/waf/latest/developerguide/enable-ddos-prem.html).\nSee example templates for Shield Advanced in CloudFormation at [aws-samples/aws-shield-advanced-examples](https://github.com/aws-samples/aws-shield-advanced-examples).\n**Configure Shield Advanced using AWS CloudFormation and AWS Firewall Manager**\nYou might be able to use Firewall Manager with AWS CloudFormation to configure Shield Advanced across multiple accounts and protected resources. To do this, your accounts must be part of an organization in AWS Organizations. You can use Firewall Manager to configure Shield Advanced protections for any resource types except for Amazon Route\u00a053 or AWS Global Accelerator.\nFor an example of this, see the one-click configuration guidance published by the AWS technical community at\n[One-click deployment of Shield Advanced](https://youtu.be/LCA3FwMk_QE).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the account that submitted the template.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-proactiveengagement.html", "Properties": { "ProactiveEngagementStatus": { "MarkdownDocumentation": "`ProactiveEngagementStatus`\n\nSpecifies whether proactive engagement is enabled or disabled.\nValid values:\n`ENABLED` - The Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.\n`DISABLED` - The SRT will not proactively notify contacts about escalations or to initiate proactive customer support.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-proactiveengagement.html#cfn-shield-proactiveengagement-proactiveengagementstatus", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EmergencyContactList": { "MarkdownDocumentation": "`EmergencyContactList`\n\nThe list of email addresses and phone numbers that the Shield Response Team (SRT) can use to\ncontact you for escalations to the SRT and to initiate proactive customer support, plus any relevant notes.\nTo enable proactive engagement, the contact list must include at least one phone number.\nIf you provide more than one contact, in the notes, indicate the circumstances under which each contact should be used. Include primary and secondary contact designations, and provide the hours of availability and time zones for each contact.\nExample contact notes:\n* This is a hotline that's staffed 24x7x365. Please work with the responding analyst and they will get the appropriate person on the call.\n* Please contact the secondary phone number if the hotline doesn't respond within 5 minutes.\n*Required*: Yes\n*Type*: Array of [EmergencyContact](./aws-properties-shield-proactiveengagement-emergencycontact.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-proactiveengagement.html#cfn-shield-proactiveengagement-emergencycontactlist", "UpdateType": "Mutable", "Required": true, "Type": "List", "ItemType": "EmergencyContact", "DuplicatesAllowed": true } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nThe ID of the account that submitted the template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-proactiveengagement.html#AccountId-fn::getatt" } } }, "AWS::Shield::Protection": { "MarkdownDocumentation": "`AWS::Shield::Protection`\n\nEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route\u00a053 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.\n**Configure a single `AWS::Shield::Protection`**\nUse this protection to protect a single resource at a time.\nTo configure this Shield Advanced protection through CloudFormation, you must be subscribed to Shield Advanced. You can subscribe\nthrough the [Shield Advanced console](https://console.aws.amazon.com/wafv2/shieldv2#/) and through\nthe APIs. For more information, see\n[Subscribe to AWS Shield Advanced](https://docs.aws.amazon.com/waf/latest/developerguide/enable-ddos-prem.html).\nSee example templates for Shield Advanced in CloudFormation at [aws-samples/aws-shield-advanced-examples](https://github.com/aws-samples/aws-shield-advanced-examples).\n**Configure Shield Advanced using AWS CloudFormation and AWS Firewall Manager**\nYou might be able to use Firewall Manager with AWS CloudFormation to configure Shield Advanced across multiple accounts and protected resources. To do this, your accounts must be part of an organization in AWS Organizations. You can use Firewall Manager to configure Shield Advanced protections for any resource types except for Amazon Route\u00a053 or AWS Global Accelerator.\nFor an example of this, see the one-click configuration guidance published by the AWS technical community at\n[One-click deployment of Shield Advanced](https://youtu.be/LCA3FwMk_QE).\n**Configure multiple protections through the Shield Advanced console**\nYou can add protection to multiple resources at once through the [Shield Advanced console](https://console.aws.amazon.com/wafv2/shieldv2#/).\nFor more information see\n[Getting Started with AWS Shield Advanced](https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html)\nand [Managing resource protections in AWS Shield Advanced](https://docs.aws.amazon.com/waf/latest/developerguide/ddos-manage-protected-resources.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN (Amazon Resource Name) of the protection.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protection.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe ARN (Amazon Resource Name) of the AWS resource that is protected.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protection.html#cfn-shield-protection-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HealthCheckArns": { "MarkdownDocumentation": "`HealthCheckArns`\n\nThe ARN (Amazon Resource Name) of the health check to associate with the protection. Health-based detection provides improved responsiveness and accuracy in attack detection and mitigation.\nYou can use this option with any resource type except for Route\u00a053 hosted zones.\nFor more information, see [Configuring health-based detection using health checks](https://docs.aws.amazon.com/waf/latest/developerguide/ddos-advanced-health-checks.html) in the *AWS Shield Advanced Developer Guide*.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `2048 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protection.html#cfn-shield-protection-healthcheckarns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ApplicationLayerAutomaticResponseConfiguration": { "MarkdownDocumentation": "`ApplicationLayerAutomaticResponseConfiguration`\n\nThe automatic application layer DDoS mitigation settings for the protection.\nThis configuration determines whether Shield Advanced automatically\nmanages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.\nIf you use CloudFormation to manage the web ACLs that you use with Shield Advanced automatic mitigation, see the additional guidance\nabout web ACL management in the `AWS::WAFv2::WebACL` resource description.\n*Required*: No\n*Type*: [ApplicationLayerAutomaticResponseConfiguration](./aws-properties-shield-protection-applicationlayerautomaticresponseconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protection.html#cfn-shield-protection-applicationlayerautomaticresponseconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationLayerAutomaticResponseConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey: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.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-shield-protection-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protection.html#cfn-shield-protection-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the protection. For example, `My CloudFront distributions`.\n###### Note\nIf you change the name of an existing protection, Shield Advanced deletes the\nprotection and replaces it with a new one. While this is happening, the protection isn't available on the AWS resource.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[ a-zA-Z0-9_\\.\\-]*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protection.html#cfn-shield-protection-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "ProtectionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProtectionArn`\n\nThe ARN (Amazon Resource Name) of the new protection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protection.html#ProtectionArn-fn::getatt" }, "ProtectionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProtectionId`\n\nThe ID of the new protection.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protection.html#ProtectionId-fn::getatt" } } }, "AWS::Shield::ProtectionGroup": { "MarkdownDocumentation": "`AWS::Shield::ProtectionGroup`\n\nCreates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.\nTo configure this resource through CloudFormation, you must be subscribed to AWS Shield Advanced. You can subscribe\nthrough the [Shield Advanced console](https://console.aws.amazon.com/wafv2/shieldv2#/) and through\nthe APIs. For more information, see\n[Subscribe to AWS Shield Advanced](https://docs.aws.amazon.com/waf/latest/developerguide/enable-ddos-prem.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN (Amazon Resource Name) of the protection group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html", "Properties": { "Aggregation": { "MarkdownDocumentation": "`Aggregation`\n\nDefines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.\n* `Sum` - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.\n* `Mean` - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.\n* `Max` - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SUM | MEAN | MAX...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SUM", "MEAN", "MAX" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-aggregation", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Pattern": { "MarkdownDocumentation": "`Pattern`\n\nThe criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `ALL | ARBITRARY | BY_RESOUR...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ALL", "ARBITRARY", "BY_RESOURCE_TYPE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-pattern", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProtectionGroupId": { "MarkdownDocumentation": "`ProtectionGroupId`\n\nThe name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9\\-]*`\n*Minimum*: `1`\n*Maximum*: `36`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-protectiongroupid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ResourceType": { "MarkdownDocumentation": "`ResourceType`\n\nThe resource type to include in the protection group. All protected resources of this type are included in the protection group.\nYou must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.\n*Required*: No\n*Type*: String\n*Allowed values*: `CLOUDFRONT_DISTRIBUTION | R...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "CLOUDFRONT_DISTRIBUTION", "ROUTE_53_HOSTED_ZONE", "ELASTIC_IP_ALLOCATION", "CLASSIC_LOAD_BALANCER", "APPLICATION_LOAD_BALANCER", "GLOBAL_ACCELERATOR" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-resourcetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Members": { "MarkdownDocumentation": "`Members`\n\nThe ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `2048 | 10000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-members", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey: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.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-shield-protectiongroup-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ProtectionGroupArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProtectionGroupArn`\n\nThe ARN (Amazon Resource Name) of the new protection group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#ProtectionGroupArn-fn::getatt" } } }, "AWS::Signer::ProfilePermission": { "MarkdownDocumentation": "`AWS::Signer::ProfilePermission`\n\nAdds cross-account permissions to a signing profile.\n", "RefReturnValue": "\nThe StatementId and ProfileName in the form StatementId|ProfileName\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nThe AWS Signer action permitted as part of cross-account\npermissions.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-action", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "StatementId": { "MarkdownDocumentation": "`StatementId`\n\nA unique identifier for the cross-account permission statement.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-statementid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProfileName": { "MarkdownDocumentation": "`ProfileName`\n\nThe human-readable name of the signing profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z_]{2,64}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-profilename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Principal": { "MarkdownDocumentation": "`Principal`\n\nThe AWS principal receiving cross-account permissions. This\nmay be an IAM role or another AWS 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-principal", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProfileVersion": { "MarkdownDocumentation": "`ProfileVersion`\n\nThe version of the signing profile.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9a-zA-Z]{10}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-profileversion", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } } }, "AWS::Signer::SigningProfile": { "MarkdownDocumentation": "`AWS::Signer::SigningProfile`\n\nCreates a signing profile. A signing profile is a code-signing template that can be used to\ncarry out a pre-defined signing job.\n", "RefReturnValue": "\nThe signing profile ARN.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html", "Properties": { "SignatureValidityPeriod": { "MarkdownDocumentation": "`SignatureValidityPeriod`\n\nThe validity period override for any signature generated using this signing\nprofile. If unspecified, the default is 135 months.\n*Required*: No\n*Type*: [SignatureValidityPeriod](./aws-properties-signer-signingprofile-signaturevalidityperiod.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-signaturevalidityperiod", "UpdateType": "Immutable", "Required": false, "Type": "SignatureValidityPeriod" }, "PlatformId": { "MarkdownDocumentation": "`PlatformId`\n\nThe ID of a platform that is available for use by a signing profile.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `AWSLambda-SHA384-ECDSA | No...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "AWSLambda-SHA384-ECDSA", "Notation-OCI-SHA384-ECDSA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-platformid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of tags associated with the signing profile.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-signer-signingprofile-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ProfileVersionArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProfileVersionArn`\n\nThe signing profile ARN, including the profile version.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#ProfileVersionArn-fn::getatt" }, "ProfileName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProfileName`\n\nThe name of the signing profile created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#ProfileName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the signing profile created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#Arn-fn::getatt" }, "ProfileVersion": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProfileVersion`\n\nThe version of the signing profile created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#ProfileVersion-fn::getatt" } } }, "AWS::SimSpaceWeaver::Simulation": { "MarkdownDocumentation": "`AWS::SimSpaceWeaver::Simulation`\n\nUse the `AWS::SimSpaceWeaver::Simulation` resource to specify\na simulation that CloudFormation starts in the AWS Cloud, in\nyour AWS account. In the resource properties section of your template,\nprovide the name of an existing IAM role\nconfigured with the proper permissions, and the name of an existing Amazon S3 bucket.\nYour account must have permissions to read the Amazon S3 bucket.\nThe Amazon S3 bucket must contain a valid schema. The schema must refer to\nsimulation assets that are already uploaded to the AWS Cloud. For more information,\nsee the [detailed tutorial](https://docs.aws.amazon.com/simspaceweaver/latest/userguide/getting-started_detailed.html) in the *AWSSimSpace Weaver User Guide*.\nSpecify a `SnapshotS3Location` to start a simulation from a snapshot instead of from\na schema. When you start a simulation from a snapshot, SimSpace Weaver initializes the entity\ndata in the State Fabric with data saved in the snapshot, starts the spatial and service apps that\nwere running when the snapshot was created, and restores the clock to the appropriate tick. Your app\nzip files must be in the same location in Amazon S3 as they were in for the original simulation.\nYou must start any custom apps separately. For more information about snapshots, see\n[Snapshots](https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html)\nin the *AWSSimSpace Weaver User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the `Simulation`. For example,\n`MyTestSimulation_22-12-15_12_00_00`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html", "Properties": { "SchemaS3Location": { "MarkdownDocumentation": "`SchemaS3Location`\n\nThe location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\nFor more information about Amazon S3, see the\n[*Amazon Simple Storage Service User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html).\nProvide a `SchemaS3Location` to start your simulation from a schema.\nIf you provide a `SchemaS3Location` then you can't provide a `SnapshotS3Location`.\n*Required*: No\n*Type*: [S3Location](./aws-properties-simspaceweaver-simulation-s3location.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-schemas3location", "UpdateType": "Immutable", "Required": false, "Type": "S3Location" }, "SnapshotS3Location": { "MarkdownDocumentation": "`SnapshotS3Location`\n\nThe location of the snapshot in Amazon Simple Storage Service (Amazon S3).\nFor more information about Amazon S3, see the\n[*Amazon Simple Storage Service User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html).\nProvide a `SnapshotS3Location` to start your simulation from a snapshot.\nIf you provide a `SnapshotS3Location` then you can't provide a `SchemaS3Location`.\n*Required*: No\n*Type*: [S3Location](./aws-properties-simspaceweaver-simulation-s3location.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-snapshots3location", "UpdateType": "Immutable", "Required": false, "Type": "S3Location" }, "MaximumDuration": { "MarkdownDocumentation": "`MaximumDuration`\n\nThe maximum running time of the simulation,\nspecified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation\nstops when it reaches this limit. The maximum value is `14D`, or its equivalent in the\nother units. The default value is `14D`. A value equivalent to `0` makes the\nsimulation immediately transition to `STOPPING` as soon as it reaches `STARTED`.\n*Required*: No\n*Type*: String\n*Minimum*: `2`\n*Maximum*: `6`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-maximumduration", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role\nthat the simulation assumes to perform actions.\nFor more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)\nin the *AWS General Reference*.\nFor more information about IAM roles,\nsee [IAM\nroles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *AWS Identity and Access Management 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-rolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the simulation.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_\\-]{1,2048}$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "DescribePayload": { "PrimitiveType": "String", "MarkdownDocumentation": "`DescribePayload`\n\nThe JSON blob that the [DescribeSimulation](https://docs.aws.amazon.com/simspaceweaver/latest/APIReference/API_DescribeSimulation.html) action returns.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#DescribePayload-fn::getatt" } } }, "AWS::StepFunctions::Activity": { "MarkdownDocumentation": "`AWS::StepFunctions::Activity`\n\nAn activity is a task that you write in any programming language and host on any machine\nthat has access to AWS Step Functions. Activities must poll Step Functions using the\n`GetActivityTask` API action and respond using `SendTask*` API\nactions. This function makes Step Functions aware of your activity and returns\nan identifier for use in a state machine and when polling from the activity.\nFor information about creating an activity, see [Creating an\nActivity State Machine](https://docs.aws.amazon.com/step-functions/latest/dg/tutorial-creating-activity-state-machine.html) in the *AWS Step Functions Developer\nGuide* and [CreateActivity](https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateActivity.html)\nin the *AWS Step Functions API Reference*.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic\nfunction, `Ref` returns the ARN of the created activity. For example:\n`{ \"Ref\": \"MyActivity\" }`\nReturns a value similar to the following:\n`arn:aws:states:us-east-1:111122223333:activity:myActivity`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html", "Properties": { "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nEncryption configuration for the activity.\nActivity configuration is immutable, and resource names must be unique. To set customer managed keys for encryption, you must create a **new Activity**. If you attempt to change the configuration in your CFN template for an existing activity, you will receive an `ActivityAlreadyExists` exception.\nTo update your activity to include customer managed keys, set a new activity name within your CloudFormation template.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-stepfunctions-activity-encryptionconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-encryptionconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "EncryptionConfiguration" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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*: Array of [TagsEntry](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagsEntry", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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`, `U+FFFE-FFFF`)\n* surrogates (`U+D800-DFFF`)\n* invalid characters ( `U+10FFFF`)\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*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nReturns the name of the activity. For example:\n`{ \"Fn::GetAtt\": [\"MyActivity\", \"Name\"] }`\nReturns a value similar to the following:\n`myActivity`\nFor more information about using `Fn::GetAtt`, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#Name-fn::getatt" } } }, "AWS::StepFunctions::StateMachine": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachine`\n\nProvisions a state machine. A state machine consists of a collection of states that can\ndo work (`Task` states), determine to which states to transition next\n(`Choice` states), stop an execution with an error (`Fail`\nstates), and so on. State machines are specified using a JSON-based, structured\nlanguage.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the Ref intrinsic function, Ref\nreturns the ARN of the created state machine. For example:\n`{ \"Ref\": \"MyStateMachine\" }`\nReturns a value similar to the following:\n`arn:aws:states:us-east-1:111122223333:stateMachine:HelloWorld-StateMachine`\nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html", "Properties": { "EncryptionConfiguration": { "MarkdownDocumentation": "`EncryptionConfiguration`\n\nEncryption configuration for the state machine.\n*Required*: No\n*Type*: [EncryptionConfiguration](./aws-properties-stepfunctions-statemachine-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-encryptionconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "EncryptionConfiguration" }, "DefinitionString": { "MarkdownDocumentation": "`DefinitionString`\n\nThe 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*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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionstring", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LoggingConfiguration": { "MarkdownDocumentation": "`LoggingConfiguration`\n\nDefines what execution history events are logged and where they are logged.\n###### Note\nBy default, the `level` is set to `OFF`. For more information\nsee [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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LoggingConfiguration" }, "DefinitionSubstitutions": { "MarkdownDocumentation": "`DefinitionSubstitutions`\n\nA map (string to string) that specifies the mappings for placeholder variables in the\nstate machine definition. This enables the customer to inject values obtained at runtime,\nfor example from intrinsic functions, in the state machine definition. Variables can be\ntemplate parameter names, resource logical IDs, resource attributes, or a variable in a\nkey-value map.\nSubstitutions must follow the syntax: `${key_name}` or `${variable_1,variable_2,...}`.\n*Required*: No\n*Type*: Object\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions", "UpdateType": "Mutable", "Required": false, "Type": "Map", "PrimitiveItemType": "Json" }, "Definition": { "MarkdownDocumentation": "`Definition`\n\nThe 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\nmatch the format of your CloudFormationtemplate 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definition", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Json" }, "DefinitionS3Location": { "MarkdownDocumentation": "`DefinitionS3Location`\n\nThe 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location", "UpdateType": "Mutable", "Required": false, "Type": "S3Location" }, "StateMachineName": { "MarkdownDocumentation": "`StateMachineName`\n\nThe 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`)\n###### Important\nIf you specify a name, you cannot perform updates that require replacement of this\nresource. You can perform updates that require no or some interruption. If you must\nreplace the resource, specify a new name.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RoleArn": { "MarkdownDocumentation": "`RoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role to use for this state machine.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe 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*: Array of [TagsEntry](./aws-properties-stepfunctions-statemachine-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "TagsEntry", "DuplicatesAllowed": true }, "StateMachineType": { "MarkdownDocumentation": "`StateMachineType`\n\nDetermines whether a `STANDARD` or `EXPRESS` state machine is\ncreated. The default is `STANDARD`. You cannot update the `type` of a\nstate machine once it has been created. For more information on `STANDARD` and\n`EXPRESS` workflows, see [Standard Versus Express\nWorkflows](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-standard-vs-express.html) in the AWS Step Functions Developer Guide.\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | EXPRESS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "EXPRESS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TracingConfiguration": { "MarkdownDocumentation": "`TracingConfiguration`\n\nSelects whether or not the state machine's AWS X-Ray tracing is enabled.\n*Required*: No\n*Type*: [TracingConfiguration](./aws-properties-stepfunctions-statemachine-tracingconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "TracingConfiguration" } }, "Attributes": { "StateMachineRevisionId": { "PrimitiveType": "String", "MarkdownDocumentation": "`StateMachineRevisionId`\n\nIdentifier for a state machine revision, which is an immutable, read-only snapshot of a state machine\u2019s definition and configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#StateMachineRevisionId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nReturns the name of the state machine. For example:\n`{ \"Fn::GetAtt\": [\"MyStateMachine\", \"Name\"] }`\nReturns the name of your state machine:\n`HelloWorld-StateMachine`\nIf you did not specify the name it will be similar to the following:\n`MyStateMachine-1234abcdefgh`\nFor more information about using `Fn::GetAtt`, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#Name-fn::getatt" } } }, "AWS::StepFunctions::StateMachineAlias": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachineAlias`\n\nRepresents a state machine [alias](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html). An alias routes traffic to one or two versions of the same state machine.\nYou can create up to 100 aliases for each state machine.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic\nfunction, `Ref` returns the ARN of the created state machine alias. For example,\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description of the state machine alias.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RoutingConfiguration": { "MarkdownDocumentation": "`RoutingConfiguration`\n\nThe routing configuration of an alias. Routing configuration splits [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) requests between one or two versions of the same state machine.\nUse `RoutingConfiguration` if you want to explicitly set the alias [weights](https://docs.aws.amazon.com/step-functions/latest/apireference/API_RoutingConfigurationListItem.html#StepFunctions-Type-RoutingConfigurationListItem-weight). Weight is the percentage of traffic you want to route to a state machine version.\n###### Note\n`RoutingConfiguration` and `DeploymentPreference` are mutually exclusive properties. You must define only one of these properties.\n*Required*: No\n*Type*: Array of [RoutingConfigurationVersion](./aws-properties-stepfunctions-statemachinealias-routingconfigurationversion.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-routingconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "RoutingConfigurationVersion", "DuplicatesAllowed": false }, "DeploymentPreference": { "MarkdownDocumentation": "`DeploymentPreference`\n\nThe settings that enable gradual state machine deployments. These settings include [Alarms](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-alarms), [Interval](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-interval), [Percentage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-percentage), [StateMachineVersionArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-statemachineversionarn), and [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-type).\nCloudFormation\nautomatically shifts traffic from the version an alias currently points to, to a new state machine version that you specify.\n###### Note\n`RoutingConfiguration` and `DeploymentPreference` are mutually exclusive properties. You must define only one of these properties.\nBased on the type of deployment you want to perform, you can specify one of the following settings:\n* `LINEAR` - Shifts traffic to the new version in equal increments with an equal number of minutes between each increment.\n \n For example, if you specify the increment percent as `20` with an interval of `600` minutes, this deployment increases traffic by 20 percent every 600 minutes until the new version receives 100 percent of the traffic.\n This deployment immediately rolls back the new version if any\n Amazon CloudWatch\n alarms are triggered.\n* `ALL_AT_ONCE` - Shifts 100 percent of traffic to the new version immediately.\n CloudFormation\n monitors the new version and rolls it back automatically to the previous version if any\n CloudWatch\n alarms are triggered.\n* `CANARY` - Shifts traffic in two increments.\n \n In the first increment, a small percentage of traffic, for example, 10 percent is shifted to the new version. In the second increment, before a specified time interval in seconds gets over, the remaining traffic is shifted to the new version. The shift to the new version for the remaining traffic takes place only if no\n CloudWatch\n alarms are triggered during the specified time interval.\n*Required*: No\n*Type*: [DeploymentPreference](./aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-deploymentpreference", "UpdateType": "Mutable", "Required": false, "Type": "DeploymentPreference" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the state machine alias. If you don't provide a name, it uses an automatically generated name based on the logical ID.\n*Required*: No\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `80`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the state machine alias. For example, `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:PROD`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#Arn-fn::getatt" } } }, "AWS::StepFunctions::StateMachineVersion": { "MarkdownDocumentation": "`AWS::StepFunctions::StateMachineVersion`\n\nRepresents a state machine [version](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html). A published version uses the latest state machine [*revision*](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html). A revision is an immutable, read-only snapshot of a state machine\u2019s definition and configuration.\nYou can publish up to 1000 versions for each state machine.\n###### Important\nBefore you delete a version, make sure that version's ARN isn't being referenced in any long-running workflows or application code outside of the stack.\n", "RefReturnValue": "\nWhen you provide the logical ID of this resource to the `Ref` intrinsic\nfunction, `Ref` returns the ARN of the published state machine version. For example, `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1.`\nFor more information about using `Ref`, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachineversion.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nAn optional description of the state machine version.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachineversion.html#cfn-stepfunctions-statemachineversion-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StateMachineRevisionId": { "MarkdownDocumentation": "`StateMachineRevisionId`\n\nIdentifier for a state machine revision, which is an immutable, read-only snapshot of a state machine\u2019s definition and configuration.\nOnly publish the state machine version if the current state machine's revision ID matches the specified ID. Use this option to avoid publishing a version if the state machine has changed since you last updated it.\nTo specify the initial state machine revision, set the value as `INITIAL`.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachineversion.html#cfn-stepfunctions-statemachineversion-statemachinerevisionid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "StateMachineArn": { "MarkdownDocumentation": "`StateMachineArn`\n\nThe Amazon Resource Name (ARN) of the state machine.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachineversion.html#cfn-stepfunctions-statemachineversion-statemachinearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nReturns the ARN of the state machine version. For example, `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachineversion.html#Arn-fn::getatt" } } }, "AWS::SupportApp::AccountAlias": { "MarkdownDocumentation": "`AWS::SupportApp::AccountAlias`\n\nYou can use the `AWS::SupportApp::AccountAlias` resource to specify your\nAWS account when you configure the AWS Support App in\nSlack. Your alias name appears on the AWS Support App page in the Support Center Console and in messages from the AWS Support App. You\ncan use this alias to identify the account you've configured with the AWS Support App.\nFor more information, see [AWS Support App in Slack](https://docs.aws.amazon.com/awssupport/latest/user/aws-support-app-for-slack.html) in the *AWS Support User Guide*.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-accountalias.html", "Properties": { "AccountAlias": { "MarkdownDocumentation": "`AccountAlias`\n\nAn alias or short name for an AWS account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w\\- ]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-accountalias.html#cfn-supportapp-accountalias-accountalias", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "AccountAliasResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountAliasResourceId`\n\nThe `AccountAlias` resource type has an attribute\n`AccountAliasResourceId`. You can use this attribute to identify the\nresource.\nThe `AccountAliasResourceId` will be\n`AccountAlias_for_accountId`. In this example,\n`AccountAlias_for_` is the prefix and `accountId` is your\nAWS account number, such as\n`AccountAlias_for_123456789012`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-accountalias.html#AccountAliasResourceId-fn::getatt" } } }, "AWS::SupportApp::SlackChannelConfiguration": { "MarkdownDocumentation": "`AWS::SupportApp::SlackChannelConfiguration`\n\nYou can use the `AWS::SupportApp::SlackChannelConfiguration` resource to\nspecify your AWS account when you configure the AWS Support App. This resource includes the following information:\n* The Slack channel name and ID\n* The team ID in Slack\n* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role\n* Whether you want the AWS Support App to notify you when your support\n cases are created, updated, resolved, or reopened\n* The case severity that you want to get notified for\nFor more information, see the following topics in the *AWS Support User Guide*:\n* [AWS Support App in Slack](https://docs.aws.amazon.com/awssupport/latest/user/aws-support-app-for-slack.html)\n* [Creating AWS Support App in Slack resources with AWS CloudFormation](https://docs.aws.amazon.com/awssupport/latest/user/creating-resources-with-cloudformation.html)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html", "Properties": { "ChannelName": { "MarkdownDocumentation": "`ChannelName`\n\nThe channel name in Slack. This is the channel where you invite the AWS Support App.\n*Required*: No\n*Type*: String\n*Pattern*: `^.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html#cfn-supportapp-slackchannelconfiguration-channelname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "NotifyOnAddCorrespondenceToCase": { "MarkdownDocumentation": "`NotifyOnAddCorrespondenceToCase`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html#cfn-supportapp-slackchannelconfiguration-notifyonaddcorrespondencetocase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ChannelRoleArn": { "MarkdownDocumentation": "`ChannelRoleArn`\n\nThe Amazon Resource Name (ARN) of the IAM role for this Slack channel\nconfiguration. 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*Pattern*: `^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role\\/(.+)$`\n*Minimum*: `31`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html#cfn-supportapp-slackchannelconfiguration-channelrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "NotifyOnResolveCase": { "MarkdownDocumentation": "`NotifyOnResolveCase`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html#cfn-supportapp-slackchannelconfiguration-notifyonresolvecase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "NotifyOnCaseSeverity": { "MarkdownDocumentation": "`NotifyOnCaseSeverity`\n\nThe case severity for your support cases that you want to receive notifications. You\ncan specify `none`, `all`, or `high`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `none | all | high...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "none", "all", "high" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html#cfn-supportapp-slackchannelconfiguration-notifyoncaseseverity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "TeamId": { "MarkdownDocumentation": "`TeamId`\n\nThe team ID in Slack. This ID uniquely identifies a Slack workspace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html#cfn-supportapp-slackchannelconfiguration-teamid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ChannelId": { "MarkdownDocumentation": "`ChannelId`\n\nThe channel ID in Slack. This ID identifies a channel within a Slack workspace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html#cfn-supportapp-slackchannelconfiguration-channelid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NotifyOnCreateOrReopenCase": { "MarkdownDocumentation": "`NotifyOnCreateOrReopenCase`\n\nWhether 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackchannelconfiguration.html#cfn-supportapp-slackchannelconfiguration-notifyoncreateorreopencase", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } } }, "AWS::SupportApp::SlackWorkspaceConfiguration": { "MarkdownDocumentation": "`AWS::SupportApp::SlackWorkspaceConfiguration`\n\nYou can use the `AWS::SupportApp::SlackWorkspaceConfiguration` resource to\nspecify your Slack workspace configuration. This resource configures your AWS account so that you can use the specified Slack workspace in the\nAWS Support App. This resource includes the following information:\n* The team ID for the Slack workspace\n* The version ID of the resource to use with AWS CloudFormation\nFor more information, see the following topics in the *AWS Support User Guide*:\n* [AWS Support App in Slack](https://docs.aws.amazon.com/awssupport/latest/user/aws-support-app-for-slack.html)\n* [Creating AWS Support App in Slack resources with AWS CloudFormation](https://docs.aws.amazon.com/awssupport/latest/user/creating-resources-with-cloudformation.html)\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Slack workspace, such as\n`T012ABCDEFG`.\nFor the AWS Support App Slack workspace configuration, `Ref`\nreturns the value of the Slack workspace ID.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackworkspaceconfiguration.html", "Properties": { "VersionId": { "MarkdownDocumentation": "`VersionId`\n\nAn identifier used to update an existing Slack workspace configuration in AWS CloudFormation, such as `100`.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9]+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackworkspaceconfiguration.html#cfn-supportapp-slackworkspaceconfiguration-versionid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "TeamId": { "MarkdownDocumentation": "`TeamId`\n\nThe team ID in Slack. This ID uniquely identifies a Slack workspace, such as\n`T012ABCDEFG`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportapp-slackworkspaceconfiguration.html#cfn-supportapp-slackworkspaceconfiguration-teamid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::Synthetics::Canary": { "MarkdownDocumentation": "`AWS::Synthetics::Canary`\n\nCreates or updates a canary. Canaries are scripts that monitor your endpoints and APIs from the\noutside-in. Canaries help you check the availability and latency of your web services and\ntroubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and\nmetrics. You can set up a canary to run continuously or just once.\nCanaries are automated scripts that run at specified intervals against an endpoint. They include Python\nor Node.js code to create a Lambda function. This code needs to be packaged in a certain way, depending\non the language. For more information, see [Writing a canary script](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html).\nTo create canaries, you must have the `CloudWatchSyntheticsFullAccess` policy.\nIf you are creating a new IAM role for the canary, you also need the\nthe `iam:CreateRole`, `iam:CreatePolicy` and\n`iam:AttachRolePolicy` permissions. For more information, see [Necessary\nRoles and Permissions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles).\nDo not include secrets or proprietary information in your canary names. The canary name\nmakes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in\noutbound calls over the internet. For more information, see [Security\nConsiderations for Synthetics Canaries](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the canary, such as `MyCanary`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html", "Properties": { "BrowserConfigs": { "MarkdownDocumentation": "`BrowserConfigs`\n\nA structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both `CHROME` and `FIREFOX` browsers.\n###### Note\nIf not specified, `browserConfigs` defaults to Chrome.\n*Required*: No\n*Type*: Array of [BrowserConfig](./aws-properties-synthetics-canary-browserconfig.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-browserconfigs", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "BrowserConfig", "DuplicatesAllowed": true }, "VisualReferences": { "MarkdownDocumentation": "`VisualReferences`\n\nA list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.\n`syn-nodejs-puppeteer-11.0` and above, and `syn-nodejs-playwright-3.0` and above, only supports `visualReferences`. `visualReference` field is not supported.\nVersions older than `syn-nodejs-puppeteer-11.0` supports both `visualReference` and `visualReferences` for backward compatibility. It is recommended to use `visualReferences`\nfor consistency and future compatibility.\n*Required*: No\n*Type*: Array of [VisualReference](./aws-properties-synthetics-canary-visualreference.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-visualreferences", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "VisualReference", "DuplicatesAllowed": true }, "ArtifactConfig": { "MarkdownDocumentation": "`ArtifactConfig`\n\nA structure that contains the configuration for canary artifacts, including\nthe encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.\n*Required*: No\n*Type*: [ArtifactConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifactconfig", "UpdateType": "Mutable", "Required": false, "Type": "ArtifactConfig" }, "SuccessRetentionPeriod": { "MarkdownDocumentation": "`SuccessRetentionPeriod`\n\nThe number of days to retain data about successful runs of this canary. If you omit\nthis field, the default of 31 days is used. The valid range is 1 to 455 days.\nThis setting affects the range of information returned by [GetCanaryRuns](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html), as well as\nthe range of information displayed in the Synthetics console.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-successretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "RuntimeVersion": { "MarkdownDocumentation": "`RuntimeVersion`\n\nSpecifies the runtime version to use for the canary. For more information about\nruntime versions, see [Canary Runtime Versions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runtimeversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "VPCConfig": { "MarkdownDocumentation": "`VPCConfig`\n\nIf this canary is to test an endpoint in a VPC, this structure contains\ninformation about the subnet and security groups of the VPC endpoint.\nFor more information, see [Running a Canary in a VPC](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).\n*Required*: No\n*Type*: [VPCConfig](./aws-properties-synthetics-canary-vpcconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-vpcconfig", "UpdateType": "Mutable", "Required": false, "Type": "VPCConfig" }, "RunConfig": { "MarkdownDocumentation": "`RunConfig`\n\nA structure that contains input information for a canary run. If you omit\nthis structure, the\nfrequency of the canary is used as canary's timeout value, up to a maximum of 900 seconds.\n*Required*: No\n*Type*: [RunConfig](./aws-properties-synthetics-canary-runconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runconfig", "UpdateType": "Mutable", "Required": false, "Type": "RunConfig" }, "DryRunAndUpdate": { "MarkdownDocumentation": "`DryRunAndUpdate`\n\nSpecifies whether to perform a dry run before updating the canary. If set to `true`, CloudFormation will execute a dry run to validate the changes before applying them to the canary.\nIf the dry run succeeds, the canary will be updated with the changes. If the dry run fails, the CloudFormation deployment will fail with the dry run\u2019s failure reason.\nIf set to `false` or omitted, the canary will be updated directly without first performing a dry run. The default value is `false`.\nFor more information, see [Performing safe canary updates](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/performing-safe-canary-upgrades.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-dryrunandupdate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "FailureRetentionPeriod": { "MarkdownDocumentation": "`FailureRetentionPeriod`\n\nThe number of days to retain data about failed runs of this canary. If you omit\nthis field, the default of 31 days is used. The valid range is 1 to 455 days.\nThis setting affects the range of information returned by [GetCanaryRuns](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html), as well as\nthe range of information displayed in the Synthetics console.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-failureretentionperiod", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Code": { "MarkdownDocumentation": "`Code`\n\nUse this structure to input your script code for the canary. This structure contains the\nLambda handler with the location where the canary should start running the script. If the\nscript is stored in an S3 bucket, the bucket name, key, and version are also included. If\nthe script is passed into the canary directly, the script code is contained in the value\nof `Script`.\n*Required*: Yes\n*Type*: [Code](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-code", "UpdateType": "Mutable", "Required": true, "Type": "Code" }, "ResourcesToReplicateTags": { "MarkdownDocumentation": "`ResourcesToReplicateTags`\n\nTo have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this property with the value `lambda-function`. If\nyou do this, CloudWatch Synthetics will keep the tags of the canary and the Lambda function synchronized. Any future changes you make to the canary's tags will also be applied to the function.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-resourcestoreplicatetags", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name for this canary. Be sure to give it a descriptive name\nthat distinguishes it from other canaries in your account.\nDo not include secrets or proprietary information in your canary names. The canary name\nmakes up part of the canary ARN, and the ARN is included in outbound calls over the\ninternet. For more information, see [Security\nConsiderations for Synthetics Canaries](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html).\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[0-9a-z_\\-]{1,255}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ProvisionedResourceCleanup": { "MarkdownDocumentation": "`ProvisionedResourceCleanup`\n\nSpecifies whether to also delete the Lambda functions and layers used by this canary\nwhen the canary is deleted. If it is `AUTOMATIC`, the Lambda functions and layers will be deleted\nwhen the canary is deleted.\nIf the value of this parameter is `OFF`, then the value of the `DeleteLambda` parameter\nof the [DeleteCanary](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html) operation\ndetermines whether the Lambda functions and layers will be deleted.\n*Required*: No\n*Type*: String\n*Allowed values*: `AUTOMATIC | OFF...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "AUTOMATIC", "OFF" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-provisionedresourcecleanup", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ExecutionRoleArn": { "MarkdownDocumentation": "`ExecutionRoleArn`\n\nThe ARN of the IAM role to be used to run the canary. This role must already exist,\nand must include `lambda.amazonaws.com` as a principal in the trust\npolicy. 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*Pattern*: `arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Schedule": { "MarkdownDocumentation": "`Schedule`\n\nA structure that contains information about how often the canary is to run, and when\nthese runs are to stop.\n*Required*: Yes\n*Type*: [Schedule](./aws-properties-synthetics-canary-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-schedule", "UpdateType": "Mutable", "Required": true, "Type": "Schedule" }, "ArtifactS3Location": { "MarkdownDocumentation": "`ArtifactS3Location`\n\nThe location in Amazon S3 where Synthetics stores artifacts from the runs of this\ncanary. Artifacts include the log file, screenshots, and HAR files.\nSpecify the full location path, including `s3://` at the beginning\nof the path.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(s3|S3)://`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifacts3location", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value pairs that are associated with the canary.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-synthetics-canary-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "StartCanaryAfterCreation": { "MarkdownDocumentation": "`StartCanaryAfterCreation`\n\nSpecify TRUE to have the canary start making runs immediately after it is created.\nA canary that you create using CloudFormation can't be used to monitor the\nCloudFormation stack that creates the canary or to roll back that stack if there is a failure.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-startcanaryaftercreation", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" } }, "Attributes": { "Code.SourceLocationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Code.SourceLocationArn`\n\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the Lambda layer where Synthetics stores the canary script code.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#Code.SourceLocationArn-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the canary. For example, `RUNNING`.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#State-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the canary.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#Id-fn::getatt" } } }, "AWS::Synthetics::Group": { "MarkdownDocumentation": "`AWS::Synthetics::Group`\n\nCreates or updates a group which you can use to associate canaries with\neach other, including cross-Region canaries. Using groups can help you with managing\nand automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.\nGroups are global resources. When you create a group, it is replicated across all AWS Regions, and you\ncan add canaries from any Region to it, and view it in any Region. Although the group ARN format\nreflects the Region name where it was created, a group is not constrained to any Region. This\nmeans that you can put canaries from multiple Regions into the same group, and then use that\ngroup to view and manage all of those canaries in a single view.\nEach group can contain as many as 10 canaries. You can have as many as 20 groups in your account.\nAny single canary can be a member of up to 10 groups.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the group.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html", "Properties": { "ResourceArns": { "MarkdownDocumentation": "`ResourceArns`\n\nThe ARNs of the canaries that\nyou want to associate with this group.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-resourcearns", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value pairs that are associated with the\ngroup.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-synthetics-group-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nA 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*Pattern*: `^[0-9a-z_\\-]{1,64}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe Id of the group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#Id-fn::getatt" } } }, "AWS::SystemsManagerSAP::Application": { "MarkdownDocumentation": "`AWS::SystemsManagerSAP::Application`\n\nAn SAP application registered with AWS Systems Manager for\nSAP.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a unique identifier for this resource.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html", "Properties": { "Instances": { "MarkdownDocumentation": "`Instances`\n\nThe Amazon EC2 instances on which your SAP application is running.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-instances", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ApplicationType": { "MarkdownDocumentation": "`ApplicationType`\n\nThe type of the application.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HANA | SAP_ABAP...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "HANA", "SAP_ABAP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-applicationtype", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "DatabaseArn": { "MarkdownDocumentation": "`DatabaseArn`\n\nThe Amazon Resource Name (ARN) of the database.\n*Required*: No\n*Type*: String\n*Pattern*: `^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\\/.+$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-databasearn", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SapInstanceNumber": { "MarkdownDocumentation": "`SapInstanceNumber`\n\nThe SAP instance number of the application.\n*Required*: No\n*Type*: String\n*Pattern*: `[0-9]{2}`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-sapinstancenumber", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ApplicationId": { "MarkdownDocumentation": "`ApplicationId`\n\nThe ID of the application.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w\\d\\.-]{1,60}`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-applicationid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Credentials": { "MarkdownDocumentation": "`Credentials`\n\nThe credentials of the SAP application.\n*Required*: No\n*Type*: Array of [Credential](./aws-properties-systemsmanagersap-application-credential.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-credentials", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "Credential", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags on the application.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-systemsmanagersap-application-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "ComponentsInfo": { "MarkdownDocumentation": "`ComponentsInfo`\n\nProperty description not available.\n*Required*: No\n*Type*: Array of [ComponentInfo](./aws-properties-systemsmanagersap-application-componentinfo.html)\n*Minimum*: `1`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-componentsinfo", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "ComponentInfo", "DuplicatesAllowed": true }, "Sid": { "MarkdownDocumentation": "`Sid`\n\nThe System ID of the application.\n*Required*: No\n*Type*: String\n*Pattern*: `[A-Z][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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#cfn-systemsmanagersap-application-sid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name of the SAP application.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-systemsmanagersap-application.html#Arn-fn::getatt" } } }, "AWS::Timestream::Database": { "MarkdownDocumentation": "`AWS::Timestream::Database`\n\nCreates a new Timestream database. If the AWS KMS key is not\nspecified, the database will be encrypted with a Timestream managed AWS KMS key located in your account. Refer to [AWS managed\nAWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) for more info. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See\n[code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html) for\ndetails.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the database name `DATABASE_NAME`.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-database.html", "Properties": { "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe identifier of the AWS KMS key used to encrypt the data stored in the\ndatabase.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-database.html#cfn-timestream-database-kmskeyid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the Timestream database.\n*Length Constraints*: Minimum length of 3 bytes. Maximum length of 256\nbytes.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]{3,256}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-database.html#cfn-timestream-database-databasename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to the database.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-timestream-database-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-database.html#cfn-timestream-database-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe `arn` of the database.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-database.html#Arn-fn::getatt" } } }, "AWS::Timestream::InfluxDBInstance": { "MarkdownDocumentation": "`AWS::Timestream::InfluxDBInstance`\n\nA DB instance is an isolated database environment running in the cloud. It is the basic building block of Amazon Timestream for InfluxDB. A DB instance can contain multiple user-created databases (or organizations and buckets for the case of InfluxDb 2.x databases), and can be accessed using the same client tools and applications you might use to access a standalone self-managed InfluxDB instance.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html", "Properties": { "DbParameterGroupIdentifier": { "MarkdownDocumentation": "`DbParameterGroupIdentifier`\n\nThe name or id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\n*Minimum*: `3`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbparametergroupidentifier", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Organization": { "MarkdownDocumentation": "`Organization`\n\nThe name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-organization", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Port": { "MarkdownDocumentation": "`Port`\n\nProperty description not available.\n*Required*: No\n*Type*: Integer\n*Minimum*: `1024`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-port", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "DbInstanceType": { "MarkdownDocumentation": "`DbInstanceType`\n\nThe Timestream for InfluxDB DB instance type to run on.\n*Required*: No\n*Type*: String\n*Allowed values*: `db.influx.medium | db.influ...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge", "db.influx.24xlarge" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbinstancetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "VpcSubnetIds": { "MarkdownDocumentation": "`VpcSubnetIds`\n\nA list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `3`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-vpcsubnetids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DeploymentType": { "MarkdownDocumentation": "`DeploymentType`\n\nSpecifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.\n*Required*: No\n*Type*: String\n*Allowed values*: `SINGLE_AZ | WITH_MULTIAZ_ST...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SINGLE_AZ", "WITH_MULTIAZ_STANDBY" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-deploymenttype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AllocatedStorage": { "MarkdownDocumentation": "`AllocatedStorage`\n\nThe amount of storage to allocate for your DB storage type in GiB (gibibytes).\n*Required*: No\n*Type*: Integer\n*Minimum*: `20`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-allocatedstorage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$`\n*Minimum*: `3`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DbStorageType": { "MarkdownDocumentation": "`DbStorageType`\n\nThe Timestream for InfluxDB DB storage type to read and write InfluxDB data.\nYou can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:\n* Influx IO Included 3000 IOPS\n* Influx IO Included 12000 IOPS\n* Influx IO Included 16000 IOPS\n*Required*: No\n*Type*: String\n*Allowed values*: `InfluxIOIncludedT1 | Influx...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbstoragetype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "LogDeliveryConfiguration": { "MarkdownDocumentation": "`LogDeliveryConfiguration`\n\nConfiguration for sending InfluxDB engine logs to a specified S3 bucket.\n*Required*: No\n*Type*: [LogDeliveryConfiguration](./aws-properties-timestream-influxdbinstance-logdeliveryconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-logdeliveryconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "LogDeliveryConfiguration" }, "Username": { "MarkdownDocumentation": "`Username`\n\nThe username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-username", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Bucket": { "MarkdownDocumentation": "`Bucket`\n\nThe name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.\n*Required*: No\n*Type*: String\n*Pattern*: `^[^_][^\"]*$`\n*Minimum*: `2`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-bucket", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcSecurityGroupIds": { "MarkdownDocumentation": "`VpcSecurityGroupIds`\n\nA list of VPC security group IDs to associate with the DB instance.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\n*Maximum*: `5`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-vpcsecuritygroupids", "UpdateType": "Immutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "NetworkType": { "MarkdownDocumentation": "`NetworkType`\n\nProperty description not available.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | DUAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "DUAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-networktype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PubliclyAccessible": { "MarkdownDocumentation": "`PubliclyAccessible`\n\nConfigures the DB instance with a public IP to facilitate access.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-publiclyaccessible", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to associate with the DB instance.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-timestream-influxdbinstance-tag.html)\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Password": { "MarkdownDocumentation": "`Password`\n\nThe password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon SecretManager in your account.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9]+$`\n*Minimum*: `8`\n*Maximum*: `64`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-password", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the DB instance.\nValid Values: `CREATING` | `AVAILABLE` | `DELETING` | `MODIFYING` | `UPDATING` | `DELETED` | `FAILED`\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#Status-fn::getatt" }, "Endpoint": { "PrimitiveType": "String", "MarkdownDocumentation": "`Endpoint`\n\nThe endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#Endpoint-fn::getatt" }, "InfluxAuthParametersSecretArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`InfluxAuthParametersSecretArn`\n\nThe Amazon Resource Name (ARN) of the Amazon Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#InfluxAuthParametersSecretArn-fn::getatt" }, "AvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "`AvailabilityZone`\n\nThe Availability Zone in which the DB instance resides.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#AvailabilityZone-fn::getatt" }, "SecondaryAvailabilityZone": { "PrimitiveType": "String", "MarkdownDocumentation": "`SecondaryAvailabilityZone`\n\nDescribes an Availability Zone in which the InfluxDB instance is located\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#SecondaryAvailabilityZone-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nA service-generated unique identifier\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the DB instance\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#Arn-fn::getatt" } } }, "AWS::Timestream::ScheduledQuery": { "MarkdownDocumentation": "`AWS::Timestream::ScheduledQuery`\n\nCreate a scheduled query that will be run on your behalf at the configured schedule.\nTimestream assumes the execution role provided as part of the\n`ScheduledQueryExecutionRoleArn` parameter to run the query. You can use the\n`NotificationConfiguration` parameter to configure notification for your\nscheduled query operations.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the scheduled query ARN.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html", "Properties": { "ScheduledQueryExecutionRoleArn": { "MarkdownDocumentation": "`ScheduledQueryExecutionRoleArn`\n\nThe ARN for the IAM role that Timestream will assume when running the scheduled query.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduledqueryexecutionrolearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ErrorReportConfiguration": { "MarkdownDocumentation": "`ErrorReportConfiguration`\n\nConfiguration for error reporting. Error reports will be generated when a problem is\nencountered when writing the query results.\n*Required*: Yes\n*Type*: [ErrorReportConfiguration](./aws-properties-timestream-scheduledquery-errorreportconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-errorreportconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "ErrorReportConfiguration" }, "ScheduleConfiguration": { "MarkdownDocumentation": "`ScheduleConfiguration`\n\nSchedule configuration.\n*Required*: Yes\n*Type*: [ScheduleConfiguration](./aws-properties-timestream-scheduledquery-scheduleconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduleconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "ScheduleConfiguration" }, "TargetConfiguration": { "MarkdownDocumentation": "`TargetConfiguration`\n\nScheduled query target store configuration.\n*Required*: No\n*Type*: [TargetConfiguration](./aws-properties-timestream-scheduledquery-targetconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-targetconfiguration", "UpdateType": "Immutable", "Required": false, "Type": "TargetConfiguration" }, "KmsKeyId": { "MarkdownDocumentation": "`KmsKeyId`\n\nThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon\nKMS key is not specified, the scheduled query resource will be encrypted with a Timestream\nowned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN.\nWhen using an alias name, prefix the name with *alias/*\nIf ErrorReportConfiguration uses `SSE_KMS` as encryption type, the same\nKmsKeyId is used to encrypt the error report at rest.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-kmskeyid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "QueryString": { "MarkdownDocumentation": "`QueryString`\n\nThe query string to run. Parameter names can be specified in the query string\n`@` character followed by an identifier. The named Parameter\n`@scheduled_runtime` is reserved and can be used in the query to get the time at\nwhich the query is scheduled to run.\nThe timestamp calculated according to the ScheduleConfiguration parameter, will be the\nvalue of `@scheduled_runtime` paramater for each query run. For example, consider\nan instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the\n`@scheduled_runtime` parameter is initialized to the timestamp 2021-12-01\n00:00:00 when invoking the query.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `262144`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-querystring", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "NotificationConfiguration": { "MarkdownDocumentation": "`NotificationConfiguration`\n\nNotification configuration for the scheduled query. A notification is sent by Timestream\nwhen a query run finishes, when the state is updated or when you delete it.\n*Required*: Yes\n*Type*: [NotificationConfiguration](./aws-properties-timestream-scheduledquery-notificationconfiguration.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-notificationconfiguration", "UpdateType": "Immutable", "Required": true, "Type": "NotificationConfiguration" }, "ScheduledQueryName": { "MarkdownDocumentation": "`ScheduledQueryName`\n\nA name for the query. Scheduled query names must be unique within each Region.\n*Required*: No\n*Type*: String\n*Pattern*: `[a-zA-Z0-9_.-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduledqueryname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ClientToken": { "MarkdownDocumentation": "`ClientToken`\n\nUsing a ClientToken makes the call to CreateScheduledQuery idempotent, in other words,\nmaking the same request repeatedly will produce the same result. Making multiple identical\nCreateScheduledQuery requests has the same effect as making a single request.\n* If CreateScheduledQuery is called without a `ClientToken`, the Query SDK\n generates a `ClientToken` on your behalf.\n* After 8 hours, any request with the same `ClientToken` is treated as a new\n request.\n*Required*: No\n*Type*: String\n*Minimum*: `32`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-clienttoken", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA list of key-value pairs to label the scheduled query.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-timestream-scheduledquery-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "SQScheduleConfiguration": { "PrimitiveType": "String", "MarkdownDocumentation": "`SQScheduleConfiguration`\n\nThe scheduled query schedule configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#SQScheduleConfiguration-fn::getatt" }, "SQNotificationConfiguration": { "PrimitiveType": "String", "MarkdownDocumentation": "`SQNotificationConfiguration`\n\nThe scheduled query notification configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#SQNotificationConfiguration-fn::getatt" }, "SQErrorReportConfiguration": { "PrimitiveType": "String", "MarkdownDocumentation": "`SQErrorReportConfiguration`\n\nThe scheduled query error reporting configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#SQErrorReportConfiguration-fn::getatt" }, "SQKmsKeyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`SQKmsKeyId`\n\nThe KMS key used to encrypt the query resource, if a customer managed KMS key was\nprovided.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#SQKmsKeyId-fn::getatt" }, "SQQueryString": { "PrimitiveType": "String", "MarkdownDocumentation": "`SQQueryString`\n\nThe scheduled query string..\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#SQQueryString-fn::getatt" }, "SQTargetConfiguration": { "PrimitiveType": "String", "MarkdownDocumentation": "`SQTargetConfiguration`\n\nThe configuration for query output.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#SQTargetConfiguration-fn::getatt" }, "SQName": { "PrimitiveType": "String", "MarkdownDocumentation": "`SQName`\n\nThe scheduled query name.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#SQName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe `ARN` of the scheduled query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#Arn-fn::getatt" }, "SQScheduledQueryExecutionRoleArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`SQScheduledQueryExecutionRoleArn`\n\nThe ARN of the IAM role that will be used by Timestream to run the query.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#SQScheduledQueryExecutionRoleArn-fn::getatt" } } }, "AWS::Timestream::Table": { "MarkdownDocumentation": "`AWS::Timestream::Table`\n\nThe CreateTable operation adds a new table to an existing database in your account. In an\nAWS account, table names must be at least unique within each Region if they\nare in the same database. You may have identical table names in the same Region if the tables\nare in separate databases. While creating the table, you must specify the table name, database\nname, and the retention properties. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See\n[code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html)\nfor details.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the table name `TABLE_NAME` in the form\n`DATABASE_NAME|TABLE_NAME`. `DATABASE_NAME` is the name of the Timestream database that the table is contained in.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html", "Properties": { "TableName": { "MarkdownDocumentation": "`TableName`\n\nThe name of the Timestream table.\n*Length Constraints*: Minimum length of 3 bytes. Maximum length of 256\nbytes.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]{3,256}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-tablename", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "RetentionProperties": { "MarkdownDocumentation": "`RetentionProperties`\n\nThe retention duration for the memory store and magnetic store. This object has the\nfollowing attributes:\n* *MemoryStoreRetentionPeriodInHours*: Retention duration for memory\n store, in hours.\n* *MagneticStoreRetentionPeriodInDays*: Retention duration for\n magnetic store, in days.\nBoth attributes are of type `string`. Both attributes are **required** when `RetentionProperties` is specified.\nSee the following examples:\n**JSON**\n```\n{\n \"Type\" : AWS::Timestream::Table\", \n \"Properties\" : {\n \"DatabaseName\" : \"TestDatabase\", \n \"TableName\" : \"TestTable\", \n \"RetentionProperties\" : {\n \"MemoryStoreRetentionPeriodInHours\": \"24\",\n \"MagneticStoreRetentionPeriodInDays\": \"7\"\n }\n } \n}\n```\n**YAML**\n```\nType: AWS::Timestream::Table\nDependsOn: TestDatabase\nProperties:\n TableName: \"TestTable\"\n DatabaseName: \"TestDatabase\"\n RetentionProperties:\n MemoryStoreRetentionPeriodInHours: \"24\"\n MagneticStoreRetentionPeriodInDays: \"7\"\n```\n*Required*: No\n*Type*: [RetentionProperties](./aws-properties-timestream-table-retentionproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-retentionproperties", "UpdateType": "Mutable", "Required": false, "Type": "RetentionProperties" }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nThe schema of the table.\n*Required*: No\n*Type*: [Schema](./aws-properties-timestream-table-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-schema", "UpdateType": "Mutable", "Required": false, "Type": "Schema" }, "DatabaseName": { "MarkdownDocumentation": "`DatabaseName`\n\nThe name of the Timestream database that contains this table.\n*Length Constraints*: Minimum length of 3 bytes. Maximum length of 256\nbytes.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9_.-]{3,256}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-databasename", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags to add to the table\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-timestream-table-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "MagneticStoreWriteProperties": { "MarkdownDocumentation": "`MagneticStoreWriteProperties`\n\nContains properties to set on the table when enabling magnetic store writes.\nThis object has the following attributes:\n* *EnableMagneticStoreWrites*: A `boolean` flag to enable\n magnetic store writes.\n* *MagneticStoreRejectedDataLocation*: The location to write error\n reports for records rejected, asynchronously, during magnetic store writes. Only\n `S3Configuration` objects are allowed. The `S3Configuration`\n object has the following attributes:\n \n + *BucketName*: The name of the S3 bucket.\n + *EncryptionOption*: The encryption option for the S3 location.\n Valid values are S3 server-side encryption with an S3 managed key\n (`SSE_S3`) or AWS managed key (`SSE_KMS`).\n + *KmsKeyId*: The AWS KMS key ID to use when\n encrypting with an AWS managed key.\n + *ObjectKeyPrefix*: The prefix to use option for the objects\n stored in S3.\n \n Both `BucketName` and `EncryptionOption` are **required** when `S3Configuration` is specified. If you\n specify `SSE_KMS` as your `EncryptionOption` then\n `KmsKeyId` is **required**.\n`EnableMagneticStoreWrites` attribute is **required**\nwhen `MagneticStoreWriteProperties` is specified.\n`MagneticStoreRejectedDataLocation` attribute is **required** when `EnableMagneticStoreWrites` is set to\n`true`.\nSee the following examples:\n**JSON**\n```\n{\n \"Type\" : AWS::Timestream::Table\", \n \"Properties\":{\n \"DatabaseName\":\"TestDatabase\",\n \"TableName\":\"TestTable\",\n \"MagneticStoreWriteProperties\":{\n \"EnableMagneticStoreWrites\":true,\n \"MagneticStoreRejectedDataLocation\":{\n \"S3Configuration\":{\n \"BucketName\":\"amzn-s3-demo-bucket\",\n \"EncryptionOption\":\"SSE_KMS\",\n \"KmsKeyId\":\"1234abcd-12ab-34cd-56ef-1234567890ab\",\n \"ObjectKeyPrefix\":\"prefix\"\n }\n }\n }\n }\n}\n```\n**YAML**\n```\nType: AWS::Timestream::Table\nDependsOn: TestDatabase\nProperties:\n TableName: \"TestTable\"\n DatabaseName: \"TestDatabase\"\n MagneticStoreWriteProperties:\n EnableMagneticStoreWrites: true\n MagneticStoreRejectedDataLocation:\n S3Configuration:\n BucketName: \"amzn-s3-demo-bucket\"\n EncryptionOption: \"SSE_KMS\"\n KmsKeyId: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n ObjectKeyPrefix: \"prefix\"\n```\n*Required*: No\n*Type*: [MagneticStoreWriteProperties](./aws-properties-timestream-table-magneticstorewriteproperties.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-magneticstorewriteproperties", "UpdateType": "Mutable", "Required": false, "Type": "MagneticStoreWriteProperties" } }, "Attributes": { "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe `arn` of the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#Arn-fn::getatt" }, "Name": { "PrimitiveType": "String", "MarkdownDocumentation": "`Name`\n\nThe name of the table.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#Name-fn::getatt" } } }, "AWS::Transfer::Agreement": { "MarkdownDocumentation": "`AWS::Transfer::Agreement`\n\nCreates an agreement. An agreement is a bilateral trading partner agreement, or\npartnership, between an AWS Transfer Family server and an AS2 process. The agreement defines the\nfile and message transfer relationship between the server and the AS2 process. To define\nan agreement, Transfer Family combines a server, local profile, partner profile, certificate, and\nother attributes.\nThe partner is identified with the `PartnerProfileId`, and the AS2 process\nis identified with the `LocalProfileId`.\n###### Note\nSpecify *either*`BaseDirectory` or `CustomDirectories`, but not both.\nSpecifying both causes the command to fail.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html", "Properties": { "Status": { "MarkdownDocumentation": "`Status`\n\nThe current status of the agreement, either `ACTIVE` or\n`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)", "RefReturnValue": "", "AllowedValues": [ "ACTIVE", "INACTIVE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-status", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe name or short description that's used to identify the agreement.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0021-\\u007E]+$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "BaseDirectory": { "MarkdownDocumentation": "`BaseDirectory`\n\nThe landing directory (folder) for files that are transferred by using the AS2\nprotocol.\n*Required*: No\n*Type*: String\n*Pattern*: `^(|/.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-basedirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerId": { "MarkdownDocumentation": "`ServerId`\n\nA system-assigned unique identifier for a server instance. This identifier indicates\nthe specific server that the agreement uses.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^s-([0-9a-f]{17})$`\n*Minimum*: `19`\n*Maximum*: `19`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-serverid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CustomDirectories": { "MarkdownDocumentation": "`CustomDirectories`\n\nA `CustomDirectoriesType` structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.\n* Failed files\n* MDN files\n* Payload files\n* Status files\n* Temporary files\n*Required*: No\n*Type*: [CustomDirectories](./aws-properties-transfer-agreement-customdirectories.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-customdirectories", "UpdateType": "Mutable", "Required": false, "Type": "CustomDirectories" }, "AccessRole": { "MarkdownDocumentation": "`AccessRole`\n\nConnectors are used to send files using either the AS2 or SFTP protocol. For the access role,\nprovide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use.\n**For AS2 connectors**\nWith AS2, you can send files by calling `StartFileTransfer` and specifying the\nfile paths in the request parameter, `SendFilePaths`. We use the file\u2019s parent\ndirectory (for example, for `--send-file-paths /bucket/dir/file.txt`, parent\ndirectory is `/bucket/dir/`) to temporarily store a processed AS2 message file,\nstore the MDN when we receive them from the partner, and write a final JSON file containing\nrelevant metadata of the transmission. So, the `AccessRole` needs to provide read\nand write access to the parent directory of the file location used in the\n`StartFileTransfer` request. Additionally, you need to provide read and write\naccess to the parent directory of the files that you intend to send with\n`StartFileTransfer`.\nIf you are using Basic authentication for your AS2 connector, the access role requires the\n`secretsmanager:GetSecretValue` permission for the secret. If the secret is encrypted using\na customer-managed key instead of the AWS managed key in Secrets Manager, then the role also\nneeds the `kms:Decrypt` permission for that key.\n**For SFTP connectors**\nMake sure that the access role provides\nread and write access to the parent directory of the file location\nthat's used in the `StartFileTransfer` request.\nAdditionally, make sure that the role provides\n`secretsmanager:GetSecretValue` permission to AWS Secrets Manager.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*role/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-accessrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PartnerProfileId": { "MarkdownDocumentation": "`PartnerProfileId`\n\nA unique identifier for the partner profile used in the agreement.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^p-([0-9a-f]{17})$`\n*Minimum*: `19`\n*Maximum*: `19`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-partnerprofileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "LocalProfileId": { "MarkdownDocumentation": "`LocalProfileId`\n\nA unique identifier for the AS2 local profile.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^p-([0-9a-f]{17})$`\n*Minimum*: `19`\n*Maximum*: `19`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-localprofileid", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EnforceMessageSigning": { "MarkdownDocumentation": "`EnforceMessageSigning`\n\nDetermines whether or not unsigned messages from your trading partners will be accepted.\n* `ENABLED`: Transfer Family rejects unsigned messages from your trading partner.\n* `DISABLED` (default value): Transfer Family accepts unsigned messages from your trading partner.\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-enforcemessagesigning", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PreserveFilename": { "MarkdownDocumentation": "`PreserveFilename`\n\nDetermines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload\nfilename when saving it.\n* `ENABLED`: the filename provided by your trading parter is preserved when the file is saved.\n* `DISABLED` (default value): when Transfer Family saves the file, the filename is adjusted, as\n described in [File names and locations](https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2).\n*Required*: No\n*Type*: String\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-preservefilename", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to group and search for agreements.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-transfer-agreement-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "AgreementId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AgreementId`\n\nThe unique identifier for the AS2 agreement, returned after the API call\nsucceeds.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#AgreementId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#Arn-fn::getatt" } } }, "AWS::Transfer::Certificate": { "MarkdownDocumentation": "`AWS::Transfer::Certificate`\n\nImports the signing and encryption certificates that you need to create local (AS2)\nprofiles and partner profiles.\nYou can import both the certificate and its chain in the `Certificate`\nparameter.\nAfter importing a certificate, AWS Transfer Family automatically creates a Amazon CloudWatch metric called `DaysUntilExpiry` that tracks the number of\ndays until the certificate expires. The metric is based on the `InactiveDate`\nparameter and is published daily in the `AWS/Transfer` namespace.\n###### Important\nIt can take up to a full day after importing a certificate for Transfer Family\nto emit the `DaysUntilExpiry` metric to your account.\n###### Note\nIf you use the `Certificate` parameter to upload both the certificate\nand its chain, don't use the `CertificateChain` parameter.\n**CloudWatch monitoring**\nThe `DaysUntilExpiry` metric includes the following specifications:\n* **Units:** Count (days)\n* **Dimensions:**`CertificateId` (always present), `Description` (if\n provided during certificate import)\n* **Statistics:** Minimum, Maximum, Average\n* **Frequency:** Published daily\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `certificateId` , such as\n`cert-1c698edce1654f869` .\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html", "Properties": { "InactiveDate": { "MarkdownDocumentation": "`InactiveDate`\n\nAn optional date that specifies when the certificate becomes inactive. If you do not specify a value, `InactiveDate` takes the same value as\n`NotAfterDate`, which is specified by the CA.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-inactivedate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Usage": { "MarkdownDocumentation": "`Usage`\n\nSpecifies how this certificate is used. It can be used in the following ways:\n* `SIGNING`: For signing AS2 messages\n* `ENCRYPTION`: For encrypting AS2 messages\n* `TLS`: For securing AS2 communications sent over HTTPS\n*Required*: Yes\n*Type*: String\n*Allowed values*: `SIGNING | ENCRYPTION | TLS...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SIGNING", "ENCRYPTION", "TLS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-usage", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PrivateKey": { "MarkdownDocumentation": "`PrivateKey`\n\nThe file that contains the private key for the certificate that's being\nimported.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\t\\n\\r\\u0020-\\u00FF]+$`\n*Minimum*: `1`\n*Maximum*: `16384`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-privatekey", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Description": { "MarkdownDocumentation": "`Description`\n\nThe name or description that's used to identity the certificate.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\u0021-\\u007E]+$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "CertificateChain": { "MarkdownDocumentation": "`CertificateChain`\n\nThe list of certificates that make up the chain for the certificate.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\t\\n\\r\\u0020-\\u00FF]+$`\n*Minimum*: `1`\n*Maximum*: `2097152`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-certificatechain", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ActiveDate": { "MarkdownDocumentation": "`ActiveDate`\n\nAn optional date that specifies when the certificate becomes active. If you do not specify a value, `ActiveDate` takes the same value as\n`NotBeforeDate`, which is specified by the CA.\n*Required*: No\n*Type*: String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-activedate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to group and search for certificates.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-transfer-certificate-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Certificate": { "MarkdownDocumentation": "`Certificate`\n\nThe file name for the certificate.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\t\\n\\r\\u0020-\\u00FF]+$`\n*Minimum*: `1`\n*Maximum*: `16384`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-certificate", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe certificate can be either `ACTIVE` , `PENDING_ROTATION` ,\nor `INACTIVE` . `PENDING_ROTATION` means that this certificate\nwill replace the current certificate when it expires.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#Status-fn::getatt" }, "Type": { "PrimitiveType": "String", "MarkdownDocumentation": "`Type`\n\nIf a private key has been specified for the certificate, its type is\n`CERTIFICATE_WITH_PRIVATE_KEY` . If there is no private key, the type is\n`CERTIFICATE` .\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#Type-fn::getatt" }, "Serial": { "PrimitiveType": "String", "MarkdownDocumentation": "`Serial`\n\nThe serial number for the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#Serial-fn::getatt" }, "CertificateId": { "PrimitiveType": "String", "MarkdownDocumentation": "`CertificateId`\n\nAn array of identifiers for the imported certificates. You use this identifier for\nworking with profiles and partner profiles.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#CertificateId-fn::getatt" }, "NotBeforeDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`NotBeforeDate`\n\nThe earliest date that the certificate is valid.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#NotBeforeDate-fn::getatt" }, "NotAfterDate": { "PrimitiveType": "String", "MarkdownDocumentation": "`NotAfterDate`\n\nThe final date that the certificate is valid.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#NotAfterDate-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe unique Amazon Resource Name (ARN) for the certificate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#Arn-fn::getatt" } } }, "AWS::Transfer::Connector": { "MarkdownDocumentation": "`AWS::Transfer::Connector`\n\nCreates the connector, which captures the parameters for a connection for the AS2 or\nSFTP protocol. For AS2, the connector is required for sending files to an externally\nhosted AS2 server. For SFTP, the connector is required when sending files to an SFTP\nserver or receiving files from an SFTP server. For more details about connectors, see\n[Configure AS2\nconnectors](https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html) and [Create SFTP\nconnectors](https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html).\n###### Note\nYou must specify exactly one configuration object: either for AS2\n(`As2Config`) or SFTP (`SftpConfig`).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html", "Properties": { "As2Config": { "MarkdownDocumentation": "`As2Config`\n\nA structure that contains the parameters for an AS2 connector object.\n*Required*: No\n*Type*: [As2Config](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-as2config", "UpdateType": "Mutable", "Required": false, "Type": "As2Config" }, "LoggingRole": { "MarkdownDocumentation": "`LoggingRole`\n\nThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn\non CloudWatch logging for Amazon S3 events. When set, you can view connector\nactivity in your CloudWatch logs.\n*Required*: No\n*Type*: String\n*Pattern*: `arn:.*role/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-loggingrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AccessRole": { "MarkdownDocumentation": "`AccessRole`\n\nConnectors are used to send files using either the AS2 or SFTP protocol. For the access role,\nprovide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use.\n**For AS2 connectors**\nWith AS2, you can send files by calling `StartFileTransfer` and specifying the\nfile paths in the request parameter, `SendFilePaths`. We use the file\u2019s parent\ndirectory (for example, for `--send-file-paths /bucket/dir/file.txt`, parent\ndirectory is `/bucket/dir/`) to temporarily store a processed AS2 message file,\nstore the MDN when we receive them from the partner, and write a final JSON file containing\nrelevant metadata of the transmission. So, the `AccessRole` needs to provide read\nand write access to the parent directory of the file location used in the\n`StartFileTransfer` request. Additionally, you need to provide read and write\naccess to the parent directory of the files that you intend to send with\n`StartFileTransfer`.\nIf you are using Basic authentication for your AS2 connector, the access role requires the\n`secretsmanager:GetSecretValue` permission for the secret. If the secret is encrypted using\na customer-managed key instead of the AWS managed key in Secrets Manager, then the role also\nneeds the `kms:Decrypt` permission for that key.\n**For SFTP connectors**\nMake sure that the access role provides\nread and write access to the parent directory of the file location\nthat's used in the `StartFileTransfer` request.\nAdditionally, make sure that the role provides\n`secretsmanager:GetSecretValue` permission to AWS Secrets Manager.\n*Required*: Yes\n*Type*: String\n*Pattern*: `arn:.*role/.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-accessrole", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "EgressType": { "MarkdownDocumentation": "`EgressType`\n\nType of egress configuration for the connector. SERVICE\\_MANAGED uses Transfer Family\nmanaged NAT gateways, while VPC\\_LATTICE routes traffic through customer VPCs using VPC\nLattice.\n*Required*: No\n*Type*: String\n*Allowed values*: `SERVICE_MANAGED | VPC_LATTI...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SERVICE_MANAGED", "VPC_LATTICE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-egresstype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EgressConfig": { "MarkdownDocumentation": "`EgressConfig`\n\nCurrent egress configuration of the connector, showing how traffic is routed to the\nSFTP server. Contains VPC Lattice settings when using VPC\\_LATTICE egress type.\nWhen using the VPC\\_LATTICE egress type, AWS Transfer Family uses a managed Service\nNetwork to simplify the resource sharing process.\n*Required*: No\n*Type*: [ConnectorEgressConfig](./aws-properties-transfer-connector-connectoregressconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-egressconfig", "UpdateType": "Mutable", "Required": false, "Type": "ConnectorEgressConfig" }, "SecurityPolicyName": { "MarkdownDocumentation": "`SecurityPolicyName`\n\nThe text name of the security policy for the specified connector.\n*Required*: No\n*Type*: String\n*Pattern*: `TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-securitypolicyname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SftpConfig": { "MarkdownDocumentation": "`SftpConfig`\n\nA structure that contains the parameters for an SFTP connector object.\n*Required*: No\n*Type*: [SftpConfig](./aws-properties-transfer-connector-sftpconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-sftpconfig", "UpdateType": "Mutable", "Required": false, "Type": "SftpConfig" }, "Url": { "MarkdownDocumentation": "`Url`\n\nThe URL of the partner's AS2 or SFTP endpoint.\nWhen creating AS2 connectors or service-managed SFTP connectors\n(connectors without egress configuration), you must provide a URL to\nspecify the remote server endpoint. For VPC Lattice type connectors,\nthe URL must be null.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-url", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to group and search for connectors.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-transfer-connector-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nCurrent status of the connector. PENDING indicates creation/update in progress, ACTIVE\nmeans ready for operations, and ERRORED indicates a failure requiring attention.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#Status-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#Arn-fn::getatt" }, "ErrorMessage": { "PrimitiveType": "String", "MarkdownDocumentation": "`ErrorMessage`\n\nError message providing details when the connector is in ERRORED status. Contains\ninformation to help troubleshoot connector creation or operation failures.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#ErrorMessage-fn::getatt" }, "ServiceManagedEgressIpAddresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`ServiceManagedEgressIpAddresses`\n\nThe list of egress IP addresses of this connector. These IP addresses are assigned\nautomatically when you create the connector.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#ServiceManagedEgressIpAddresses-fn::getatt" }, "ConnectorId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ConnectorId`\n\nThe service-assigned ID of the connector that is created.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#ConnectorId-fn::getatt" } } }, "AWS::Transfer::Profile": { "MarkdownDocumentation": "`AWS::Transfer::Profile`\n\nCreates the local or partner profile to use for AS2 transfers.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html", "Properties": { "As2Id": { "MarkdownDocumentation": "`As2Id`\n\nThe `As2Id` is the *AS2-name*, as defined in the\n[RFC 4130](https://datatracker.ietf.org/doc/html/rfc4130). For inbound transfers, this is the `AS2-From` header for the AS2 messages\nsent from the partner. For outbound connectors, this is the `AS2-To` header for the\nAS2 messages sent to the partner using the `StartFileTransfer` API operation. This ID cannot include spaces.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\u0020-\\u007E\\s]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html#cfn-transfer-profile-as2id", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "ProfileType": { "MarkdownDocumentation": "`ProfileType`\n\nIndicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles.\nIf 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)", "RefReturnValue": "", "AllowedValues": [ "LOCAL", "PARTNER" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html#cfn-transfer-profile-profiletype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "CertificateIds": { "MarkdownDocumentation": "`CertificateIds`\n\nAn array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html#cfn-transfer-profile-certificateids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to group and search for profiles.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-transfer-profile-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html#cfn-transfer-profile-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ProfileId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ProfileId`\n\nThe unique identifier for the AS2 profile, returned after the API call\nsucceeds.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html#ProfileId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name associated with the profile, in the form\n`arn:aws:transfer:region:account-id:profile/profile-id/` .\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html#Arn-fn::getatt" } } }, "AWS::Transfer::Server": { "MarkdownDocumentation": "`AWS::Transfer::Server`\n\nInstantiates an auto-scaling virtual server based on the selected file transfer\nprotocol in AWS. When you make updates to your file transfer protocol-enabled server\nor when you work with users, use the service-generated `ServerId` property\nthat is assigned to the newly created server.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the server ARN, such as\n`arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef` .\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nSpecifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint. The default value is `IPV4`.\n###### Important\nThe `IpAddressType` parameter has the following limitations:\n* It cannot be changed while the server is online. You must stop the server before modifying this parameter.\n* It cannot be updated to `DUALSTACK` if the server has `AddressAllocationIds` specified.\n###### Note\nWhen using `DUALSTACK` as the `IpAddressType`, you cannot set the `AddressAllocationIds` parameter for the [EndpointDetails](https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html) for the server.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | DUALSTACK...`\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "DUALSTACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-ipaddresstype", "UpdateType": "Conditional", "Required": false, "PrimitiveType": "String" }, "LoggingRole": { "MarkdownDocumentation": "`LoggingRole`\n\nThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn\non Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in\nyour CloudWatch logs.\n*Required*: No\n*Type*: String\n*Pattern*: `^(|arn:.*role/\\S+)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-loggingrole", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Protocols": { "MarkdownDocumentation": "`Protocols`\n\nSpecifies the file transfer protocol or protocols over which your file transfer\nprotocol client can connect to your server's endpoint. The available protocols\nare:\n* `SFTP` (Secure Shell (SSH) File Transfer Protocol): File transfer\n over SSH\n* `FTPS` (File Transfer Protocol Secure): File transfer with TLS\n encryption\n* `FTP` (File Transfer Protocol): Unencrypted file transfer\n* `AS2` (Applicability Statement 2): used for transporting structured\n business-to-business data\n###### Note\n* If you select `FTPS` , you must choose a certificate stored in\n AWS Certificate Manager (ACM) which is used to identify your server when\n clients connect to it over FTPS.\n* If `Protocol` includes either `FTP` or\n `FTPS` , then the `EndpointType` must be\n `VPC` and the `IdentityProviderType` must be\n either `AWS_DIRECTORY_SERVICE` , `AWS_LAMBDA` , or\n `API_GATEWAY` .\n* If `Protocol` includes `FTP` , then\n `AddressAllocationIds` cannot be associated.\n* If `Protocol` is set only to `SFTP` , the\n `EndpointType` can be set to `PUBLIC` and the\n `IdentityProviderType` can be set any of the supported\n identity types: `SERVICE_MANAGED` ,\n `AWS_DIRECTORY_SERVICE` , `AWS_LAMBDA` , or\n `API_GATEWAY` .\n* If `Protocol` includes `AS2` , then the\n `EndpointType` must be `VPC` , and domain must be\n Amazon S3.\nThe `Protocols` parameter is an array of strings.\n*Allowed values* : One or more of `SFTP` ,\n`FTPS` , `FTP` , `AS2`\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-protocols", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "IdentityProviderDetails": { "MarkdownDocumentation": "`IdentityProviderDetails`\n\nRequired when `IdentityProviderType` is set to\n`AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA` or\n`API_GATEWAY`. Accepts an array containing all of the information\nrequired to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a\ncustomer-supplied authentication API, including the API Gateway URL. Cannot be specified\nwhen `IdentityProviderType` is set to `SERVICE_MANAGED`.\n*Required*: No\n*Type*: [IdentityProviderDetails](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-identityproviderdetails", "UpdateType": "Mutable", "Required": false, "Type": "IdentityProviderDetails" }, "EndpointDetails": { "MarkdownDocumentation": "`EndpointDetails`\n\nThe virtual private cloud (VPC) endpoint settings that are configured for your server.\nWhen you host your endpoint within your VPC, you can make your endpoint accessible only to resources\nwithin your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over\nthe internet. Your VPC's default security groups are automatically assigned to your\nendpoint.\n*Required*: No\n*Type*: [EndpointDetails](./aws-properties-transfer-server-endpointdetails.html)\n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointdetails", "UpdateType": "Conditional", "Required": false, "Type": "EndpointDetails" }, "StructuredLogDestinations": { "MarkdownDocumentation": "`StructuredLogDestinations`\n\nSpecifies the log groups to which your server logs are sent.\nTo specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:\n`arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*`\nFor example, `arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*`\nIf you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty\nvalue for this parameter in an `update-server` call. For example:\n`update-server --server-id s-1234567890abcdef0 --structured-log-destinations`\n*Required*: No\n*Type*: Array of String\n*Minimum*: `20 | 0`\n*Maximum*: `1600 | 1`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-structuredlogdestinations", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "PreAuthenticationLoginBanner": { "MarkdownDocumentation": "`PreAuthenticationLoginBanner`\n\nSpecifies a string to display when users connect to a server. This string is displayed before the user authenticates.\nFor 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,\nor in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\nsystem personnel.`\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\x09-\\x0D\\x20-\\x7E]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-preauthenticationloginbanner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "PostAuthenticationLoginBanner": { "MarkdownDocumentation": "`PostAuthenticationLoginBanner`\n\nSpecifies a string to display when users connect to a server. This string is displayed after the user authenticates.\n###### Note\nThe SFTP protocol does not support post-authentication display banners.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\x09-\\x0D\\x20-\\x7E]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-postauthenticationloginbanner", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "EndpointType": { "MarkdownDocumentation": "`EndpointType`\n\nThe type of endpoint that you want your server to use. You can choose to make your\nserver's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an\nendpoint that is hosted in a VPC, you can restrict access to your server and resources\nonly within your VPC or choose to make it internet facing by attaching Elastic IP\naddresses directly to it.\n###### Note\nAfter May 19, 2021, you won't be able to create a server using\n`EndpointType=VPC_ENDPOINT` in your AWS account if\nyour account hasn't already done so before May 19, 2021. If you have already created\nservers with `EndpointType=VPC_ENDPOINT` in your AWS account on or before May 19, 2021, you will not be affected. After this date, use\n`EndpointType` = `VPC` .\nFor more information, see [Discontinuing the use of VPC\\_ENDPOINT](https://docs.aws.amazon.com//transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint) .\nIt is recommended that you use `VPC` as the `EndpointType`\n. With this endpoint type, you have the option to directly associate up to three\nElastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC\nsecurity groups to restrict traffic by the client's public IP address. This is not\npossible with `EndpointType` set to `VPC_ENDPOINT` .\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)", "RefReturnValue": "", "AllowedValues": [ "PUBLIC", "VPC", "VPC_ENDPOINT" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "SecurityPolicyName": { "MarkdownDocumentation": "`SecurityPolicyName`\n\nSpecifies the name of the security policy for the server.\n*Required*: No\n*Type*: String\n*Pattern*: `^TransferSecurityPolicy-.+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-securitypolicyname", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ProtocolDetails": { "MarkdownDocumentation": "`ProtocolDetails`\n\nThe protocol settings that are configured for your server.\n* To indicate passive mode (for FTP and FTPS protocols), use the\n `PassiveIp` parameter. Enter a single dotted-quad IPv4 address,\n 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\n `SETSTAT` command on a file that you are uploading to an Amazon\n S3 bucket, use the `SetStatOption` parameter. To have the AWS Transfer Family server ignore the `SETSTAT` command and upload\n files without needing to make any changes to your SFTP client, set the value to\n `ENABLE_NO_OP` . If you set the `SetStatOption`\n parameter to `ENABLE_NO_OP` , Transfer Family generates a log entry\n to Amazon CloudWatch Logs, so that you can determine when the client is making a\n `SETSTAT` call.\n* To determine whether your AWS Transfer Family server resumes recent,\n negotiated sessions through a unique session ID, use the\n `TlsSessionResumptionMode` parameter.\n* `As2Transports` indicates the transport method for the AS2\n messages. Currently, only HTTP is supported.\n \n The `Protocols` parameter is an array of strings.\n \n *Allowed values* : One or more of `SFTP` ,\n `FTPS` , `FTP` , `AS2`\n*Required*: No\n*Type*: [ProtocolDetails](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-protocoldetails", "UpdateType": "Mutable", "Required": false, "Type": "ProtocolDetails" }, "S3StorageOptions": { "MarkdownDocumentation": "`S3StorageOptions`\n\nSpecifies whether or not performance for your Amazon S3 directories is optimized.\n* If using the console, this is enabled by default.\n* If using the API or CLI, this is disabled by default.\nBy default, home directory mappings have a `TYPE` of `DIRECTORY`. If you enable this option, you would then need to explicitly set the `HomeDirectoryMapEntry``Type` to `FILE` if you want a mapping to have a file target.\n*Required*: No\n*Type*: [S3StorageOptions](./aws-properties-transfer-server-s3storageoptions.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-s3storageoptions", "UpdateType": "Mutable", "Required": false, "Type": "S3StorageOptions" }, "WorkflowDetails": { "MarkdownDocumentation": "`WorkflowDetails`\n\nSpecifies the workflow ID for the workflow to assign and the execution role that's\nused for executing the workflow.\nIn addition to a workflow to execute when a file is uploaded completely,\n`WorkflowDetails` can also contain a workflow ID (and execution role) for\na workflow to execute on partial upload. A partial upload occurs when a file is open\nwhen the session disconnects.\n*Required*: No\n*Type*: [WorkflowDetails](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-workflowdetails", "UpdateType": "Mutable", "Required": false, "Type": "WorkflowDetails" }, "Domain": { "MarkdownDocumentation": "`Domain`\n\nSpecifies the domain of the storage system that is used for file transfers. There are\ntwo domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File\nSystem (Amazon EFS). The default value is S3.\n*Required*: No\n*Type*: String\n*Allowed values*: `S3 | EFS`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "S3", "EFS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-domain", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "IdentityProviderType": { "MarkdownDocumentation": "`IdentityProviderType`\n\nThe mode of authentication for a server. The default value is\n`SERVICE_MANAGED`, which allows you to store and access user credentials within\nthe AWS Transfer Family service.\nUse `AWS_DIRECTORY_SERVICE` to provide access to\nActive Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your\non-premises environment or in AWS using AD Connector. This option also requires you to\nprovide a Directory ID by using the `IdentityProviderDetails` parameter.\nUse the `API_GATEWAY` value to integrate with an identity provider of your choosing. The\n`API_GATEWAY` setting requires you to provide an Amazon API Gateway endpoint URL to call\nfor authentication by using the `IdentityProviderDetails` parameter.\nUse the `AWS_LAMBDA` value to directly use an AWS Lambda function as your identity provider.\nIf you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter\nfor the `IdentityProviderDetails` data type.\n*Required*: No\n*Type*: String\n*Allowed values*: `SERVICE_MANAGED | API_GATEW...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SERVICE_MANAGED", "API_GATEWAY", "AWS_DIRECTORY_SERVICE", "AWS_LAMBDA" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-identityprovidertype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to group and search for servers.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-transfer-server-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Certificate": { "MarkdownDocumentation": "`Certificate`\n\nThe Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when\n`Protocols` is set to `FTPS`.\nTo request a new public certificate, see [Request a public\ncertificate](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\nACM](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\na private certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html) in the *AWS Certificate Manager User\nGuide*.\nCertificates with the following cryptographic algorithms and key sizes are\nsupported:\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)\n###### Note\nThe certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or\nIP address specified and information about the issuer.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-certificate", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "ServerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServerId`\n\nSpecifies the unique system-assigned identifier for a server that you\ninstantiate.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#ServerId-fn::getatt" }, "As2ServiceManagedEgressIpAddresses": { "Type": "List", "PrimitiveItemType": "String", "MarkdownDocumentation": "`As2ServiceManagedEgressIpAddresses`\n\nThe list of egress IP addresses of this server. These IP addresses are only relevant\nfor servers that use the AS2 protocol. They are used for sending asynchronous\nMDNs.\nThese IP addresses are assigned automatically when you create an AS2 server.\nAdditionally, if you update an existing server and add the AS2 protocol, static IP\naddresses are assigned as well.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#As2ServiceManagedEgressIpAddresses-fn::getatt" }, "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe condition of the server that was described. A value of\n`ONLINE` indicates that the server can accept jobs and transfer files. A\n`State` value of `OFFLINE` means that the server cannot perform file\ntransfer operations.\nThe states of `STARTING` and `STOPPING` indicate that the server is\nin an intermediate state, either not fully able to respond, or not fully offline. The values\nof `START_FAILED` or `STOP_FAILED` can indicate an error\ncondition.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#State-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nSpecifies the unique Amazon Resource Name (ARN) of the server.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#Arn-fn::getatt" } } }, "AWS::Transfer::User": { "MarkdownDocumentation": "`AWS::Transfer::User`\n\nThe `AWS::Transfer::User` resource creates a user and associates them with\nan existing server. You can only create and associate users with servers that have the\n`IdentityProviderType` set to `SERVICE_MANAGED` . Using\nparameters for `CreateUser` , you can specify the user name, set the home\ndirectory, store the user's public key, and assign the user's AWS\nIdentity and Access Management (IAM) role. You can also optionally add a session policy,\nand assign metadata with tags that can be used to group and search for users.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the username, such as `transfer_user` .\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nA session policy for your user so you can use the same IAM role across multiple\nusers. This policy restricts user access to portions of their Amazon S3 bucket.\nVariables that you can use inside this policy include `${Transfer:UserName}`\n, `${Transfer:HomeDirectory}` , and `${Transfer:HomeBucket}` .\n###### Note\nFor session policies, AWS Transfer Family stores the policy as a JSON blob,\ninstead of the Amazon Resource Name (ARN) of the policy. You save the policy as a\nJSON blob and pass it in the `Policy` argument.\nFor an example of a session policy, see [Example session\npolicy](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\n*AWS Security Token Service API Reference* .\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-policy", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Role": { "MarkdownDocumentation": "`Role`\n\nThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3\nbucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users\nwhen transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust\nrelationship that allows the server to access your resources when servicing your users' transfer requests.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn:.*role/\\S+$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-role", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "HomeDirectory": { "MarkdownDocumentation": "`HomeDirectory`\n\nThe 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###### Note\nYou can use the `HomeDirectory` parameter for `HomeDirectoryType` when it is set to either `PATH` or `LOGICAL`.\n*Required*: No\n*Type*: String\n*Pattern*: `^(|/.*)$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectory", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "HomeDirectoryType": { "MarkdownDocumentation": "`HomeDirectoryType`\n\nThe type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\nIf you set it to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer\nprotocol clients. If you set it to `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for\nhow you want to make Amazon S3 or Amazon EFS paths visible to your users.\n###### Note\nIf `HomeDirectoryType` is `LOGICAL`, you must provide mappings,\nusing the `HomeDirectoryMappings` parameter. If, on the other hand,\n`HomeDirectoryType` is `PATH`, you provide an absolute path\nusing the `HomeDirectory` parameter. You cannot have both\n`HomeDirectory` and `HomeDirectoryMappings` in your\ntemplate.\n*Required*: No\n*Type*: String\n*Allowed values*: `PATH | LOGICAL...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "PATH", "LOGICAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ServerId": { "MarkdownDocumentation": "`ServerId`\n\nA system-assigned unique identifier for a server instance. This is the specific server\nthat you added your user to.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^s-([0-9a-f]{17})$`\n*Minimum*: `19`\n*Maximum*: `19`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-serverid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "UserName": { "MarkdownDocumentation": "`UserName`\n\nA unique string that identifies a user and is associated with a `ServerId`.\nThis user name must be a minimum of 3 and a maximum of 100 characters long. The\nfollowing are valid characters: a-z, A-Z, 0-9, underscore '\\_', hyphen\n'-', period '.', and at sign '@'. The user name can't\nstart with a hyphen, period, or at sign.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[\\w][\\w@.-]{2,99}$`\n*Minimum*: `3`\n*Maximum*: `100`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-username", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "HomeDirectoryMappings": { "MarkdownDocumentation": "`HomeDirectoryMappings`\n\nLogical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\nbe visible to your user and how you want to make them visible. You must specify the\n`Entry` and `Target` pair, where `Entry` shows how the path\nis made visible and `Target` is the actual Amazon S3 or Amazon EFS path. If you\nonly specify a target, it is displayed as is. You also must ensure that your AWS Identity and Access Management (IAM)\nrole provides access to paths in `Target`. This value\ncan be set only when `HomeDirectoryType` is set to\n*LOGICAL*.\nThe following is an `Entry` and `Target` pair example.\n`[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" }\n]`\nIn most cases, you can use this value instead of the session policy to lock your user\ndown to the designated home directory (\"`chroot`\"). To do this, you can set\n`Entry` to `/` and set `Target` to the value the\nuser should see for their home directory when they log in.\nThe following is an `Entry` and `Target` pair example for `chroot`.\n`[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]`\n*Required*: No\n*Type*: Array of [HomeDirectoryMapEntry](./aws-properties-transfer-user-homedirectorymapentry.html)\n*Minimum*: `1`\n*Maximum*: `50000`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorymappings", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "HomeDirectoryMapEntry", "DuplicatesAllowed": true }, "PosixProfile": { "MarkdownDocumentation": "`PosixProfile`\n\nSpecifies the full POSIX identity, including user ID (`Uid`), group ID\n(`Gid`), and any secondary groups IDs (`SecondaryGids`), that\ncontrols your users' access to your Amazon Elastic File System (Amazon EFS) file\nsystems. The POSIX permissions that are set on files and directories in your file system\ndetermine the level of access your users get when transferring files into and out of\nyour Amazon EFS file systems.\n*Required*: No\n*Type*: [PosixProfile](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-posixprofile", "UpdateType": "Mutable", "Required": false, "Type": "PosixProfile" }, "SshPublicKeys": { "MarkdownDocumentation": "`SshPublicKeys`\n\nSpecifies the public key portion of the Secure Shell (SSH) keys stored for the\ndescribed user.\n###### Note\nTo delete the public key body, set its value to zero keys, as shown here:\n`SshPublicKeys: []`\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-sshpublickeys", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to group and search for users. Tags are metadata\nattached to users for any purpose.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-transfer-user-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "ServerId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServerId`\n\nThe ID of the server to which the user is attached.\nAn example `ServerId` is `s-01234567890abcdef` .\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#ServerId-fn::getatt" }, "UserName": { "PrimitiveType": "String", "MarkdownDocumentation": "`UserName`\n\nA unique string that identifies a Transfer Family user account associated with a\nserver.\nAn example `UserName` is `transfer-user-1` .\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#UserName-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name associated with the user, in the form `arn:aws:transfer:region: account-id :user/\nserver-id / username` .\nAn example of a user ARN is:\n`arn:aws:transfer:us-east-1:123456789012:user/user1` .\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#Arn-fn::getatt" } } }, "AWS::Transfer::WebApp": { "MarkdownDocumentation": "`AWS::Transfer::WebApp`\n\nCreates a web app based on specified parameters, and returns the ID for the new web\napp. You can configure the web app to be publicly accessible or hosted within a VPC.\nFor more information about using VPC endpoints with AWS Transfer Family, see [Create a Transfer Family web app in a VPC](https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the web app ARN, such as\n`arn:aws:transfer:us-east-2:123456789012:webapp/webapp-01234567890abcdef`\n.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html", "Properties": { "WebAppCustomization": { "MarkdownDocumentation": "`WebAppCustomization`\n\nA structure that contains the customization fields for the web app. You can provide a\ntitle, logo, and icon to customize the appearance of your web app.\n*Required*: No\n*Type*: [WebAppCustomization](./aws-properties-transfer-webapp-webappcustomization.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-webappcustomization", "UpdateType": "Mutable", "Required": false, "Type": "WebAppCustomization" }, "IdentityProviderDetails": { "MarkdownDocumentation": "`IdentityProviderDetails`\n\nYou can provide a structure that contains the details for the identity provider to use\nwith your web app.\nFor more details about this parameter, see [Configure your identity\nprovider for Transfer Family web apps](https://docs.aws.amazon.com//transfer/latest/userguide/webapp-identity-center.html).\n*Required*: Yes\n*Type*: [IdentityProviderDetails](./aws-properties-transfer-webapp-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-identityproviderdetails", "UpdateType": "Mutable", "Required": true, "Type": "IdentityProviderDetails" }, "WebAppUnits": { "MarkdownDocumentation": "`WebAppUnits`\n\nA union that contains the value for number of concurrent connections or the user\nsessions on your web app.\n*Required*: No\n*Type*: [WebAppUnits](./aws-properties-transfer-webapp-webappunits.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-webappunits", "UpdateType": "Mutable", "Required": false, "Type": "WebAppUnits" }, "WebAppEndpointPolicy": { "MarkdownDocumentation": "`WebAppEndpointPolicy`\n\nSetting for the type of endpoint policy for the web app. The default value is\n`STANDARD`.\nIf your web app was created in an AWS GovCloud (US) Region, the value of this\nparameter can be `FIPS`, which indicates the web app endpoint is\nFIPS-compliant.\n*Required*: No\n*Type*: String\n*Allowed values*: `STANDARD | FIPS...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "STANDARD", "FIPS" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-webappendpointpolicy", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to group and search for web apps. Tags are metadata\nattached to web apps for any purpose.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-transfer-webapp-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "AccessEndpoint": { "MarkdownDocumentation": "`AccessEndpoint`\n\nThe `AccessEndpoint` is the URL that you provide to your users for them to\ninteract with the Transfer Family web app. You can specify a custom URL or use the default\nvalue.\nBefore you enter a custom URL for this parameter, follow the steps described in [Update\nyour access endpoint with a custom URL](https://docs.aws.amazon.com//transfer/latest/userguide/webapp-customize.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#cfn-transfer-webapp-accessendpoint", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "WebAppId": { "PrimitiveType": "String", "MarkdownDocumentation": "`WebAppId`\n\nThe unique identifier for the web app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#WebAppId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the web app.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#Arn-fn::getatt" }, "IdentityProviderDetails.ApplicationArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdentityProviderDetails.ApplicationArn`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-webapp.html#IdentityProviderDetails.ApplicationArn-fn::getatt" } } }, "AWS::Transfer::Workflow": { "MarkdownDocumentation": "`AWS::Transfer::Workflow`\n\nAllows you to create a workflow with specified steps and step details the workflow\ninvokes after file transfer completes. After creating a workflow, you can associate the\nworkflow created with any transfer servers by specifying the\n`workflow-details` field in `CreateServer` and\n`UpdateServer` operations.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html", "Properties": { "Steps": { "MarkdownDocumentation": "`Steps`\n\nSpecifies the details for the steps that are in the specified workflow.\n*Required*: Yes\n*Type*: Array of [WorkflowStep](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#cfn-transfer-workflow-steps", "UpdateType": "Immutable", "Required": true, "Type": "List", "ItemType": "WorkflowStep", "DuplicatesAllowed": false }, "Description": { "MarkdownDocumentation": "`Description`\n\nSpecifies the text description for the workflow.\n*Required*: No\n*Type*: String\n*Pattern*: `^[\\w\\- ]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#cfn-transfer-workflow-description", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "OnExceptionSteps": { "MarkdownDocumentation": "`OnExceptionSteps`\n\nSpecifies the steps (actions) to take if errors are encountered during execution of the workflow.\n*Required*: No\n*Type*: Array of [WorkflowStep](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#cfn-transfer-workflow-onexceptionsteps", "UpdateType": "Immutable", "Required": false, "Type": "List", "ItemType": "WorkflowStep", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey-value pairs that can be used to group and search for workflows. Tags are metadata\nattached to workflows for any purpose.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-transfer-workflow-tag.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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#cfn-transfer-workflow-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "WorkflowId": { "PrimitiveType": "String", "MarkdownDocumentation": "`WorkflowId`\n\nA unique identifier for a workflow.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#WorkflowId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html#Arn-fn::getatt" } } }, "AWS::VerifiedPermissions::IdentitySource": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::IdentitySource`\n\nCreates or updates a reference to Amazon Cognito as an external identity\nprovider.\nIf you are creating a new identity source, then you must specify a\n`Configuration`. If you are updating an existing identity source, then\nyou must specify an `UpdateConfiguration`.\nAfter you create an identity source, you can use the identities provided by the IdP as\nproxies for the principal in authorization queries that use the [IsAuthorizedWithToken](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) operation. These identities take the form of tokens\nthat contain claims about the user, such as IDs, attributes and group memberships.\nAmazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens\nresults in the same Cedar principal. Verified Permissions automatically translates the\ninformation about the identities into the standard Cedar attributes that can be\nevaluated by your policies. Because the Amazon Cognito identity and access tokens\ncan contain different information, the tokens you choose to use determine the attributes\nthat are available to access in the Cedar principal from your policies.\nAmazon Cognito Identity is not available in all of the same AWS Regions as Amazon Verified Permissions. Because of this, the\n`AWS::VerifiedPermissions::IdentitySource` type is not available to\ncreate from CloudFormation in Regions where Amazon Cognito Identity is not\ncurrently available. Users can still create\n`AWS::VerifiedPermissions::IdentitySource` in those Regions, but only\nfrom the AWS CLI, Amazon Verified Permissions SDK, or from the AWS console.\n###### Note\nTo reference a user from this identity source in your Cedar policies, use the\nfollowing syntax.\n*IdentityType::\"|*\nWhere `IdentityType` is the string that you provide to the\n`PrincipalEntityType` parameter for this operation. The\n`CognitoUserPoolId` and `CognitoClientId` are defined by\nthe Amazon Cognito user pool.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique id of the new identity source. For\nexample:\n`{ \"Ref\": \"ISEXAMPLEabcdefg111111\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html", "Properties": { "PrincipalEntityType": { "MarkdownDocumentation": "`PrincipalEntityType`\n\nSpecifies the namespace and data type of the principals generated for identities\nauthenticated by the new identity source.\n*Required*: No\n*Type*: String\n*Pattern*: `^.*$`\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html#cfn-verifiedpermissions-identitysource-principalentitytype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Configuration": { "MarkdownDocumentation": "`Configuration`\n\nContains configuration information used when creating a new identity source.\n*Required*: Yes\n*Type*: [IdentitySourceConfiguration](./aws-properties-verifiedpermissions-identitysource-identitysourceconfiguration.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html#cfn-verifiedpermissions-identitysource-configuration", "UpdateType": "Mutable", "Required": true, "Type": "IdentitySourceConfiguration" }, "PolicyStoreId": { "MarkdownDocumentation": "`PolicyStoreId`\n\nSpecifies the ID of the policy store in which you want to store this identity source. Only policies and\nrequests made using this policy store can reference identities from the identity provider\nconfigured in the new identity source.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html#cfn-verifiedpermissions-identitysource-policystoreid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "IdentitySourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`IdentitySourceId`\n\nThe unique ID of the new or updated identity store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html#IdentitySourceId-fn::getatt" } } }, "AWS::VerifiedPermissions::Policy": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::Policy`\n\nCreates or updates a Cedar policy and saves it in the specified policy store. You can\ncreate either a static policy or a policy linked to a policy template.\nYou can directly update only static policies. To update a template-linked policy, you\nmust update its linked policy template instead.\n* To create a static policy, in the `Definition` include a\n `Static` element that includes the Cedar policy text in the\n `Statement` element.\n* To create a policy that is dynamically linked to a policy template, in the\n `Definition` include a `Templatelinked` element that\n specifies the policy template ID and the principal and resource to associate\n with this policy. If the policy template is ever updated, any policies linked to\n the policy template automatically use the updated template.\n###### Note\n* If policy validation is enabled in the policy store, then updating a\n static policy causes Verified Permissions to validate the policy against the\n schema in the policy store. If the updated static policy doesn't pass\n validation, the operation fails and the update isn't stored.\n* When you edit a static policy, You can change only certain elements of a\n static policy:\n \n + The action referenced by the policy.\n + A condition clause, such as when and unless.\n \n You can't change these elements of a static policy:\n \n + Changing a policy from a static policy to a template-linked\n policy.\n + Changing the effect of a static policy from permit or forbid.\n + The principal referenced by a static policy.\n + The resource referenced by a static policy.\n* To update a template-linked policy, you must update the template instead.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique id of the new or updated policy. For\nexample:\n`{ \"Ref\": \"SPEXAMPLEabcdefg111111\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policy.html", "Properties": { "Definition": { "MarkdownDocumentation": "`Definition`\n\nSpecifies the policy type and content to use for the new or updated policy. The\ndefinition structure must include either a `Static` or a\n`TemplateLinked` element.\n*Required*: Yes\n*Type*: [PolicyDefinition](./aws-properties-verifiedpermissions-policy-policydefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policy.html#cfn-verifiedpermissions-policy-definition", "UpdateType": "Mutable", "Required": true, "Type": "PolicyDefinition" }, "PolicyStoreId": { "MarkdownDocumentation": "`PolicyStoreId`\n\nSpecifies the `PolicyStoreId` of the policy store you want to store the policy\nin.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policy.html#cfn-verifiedpermissions-policy-policystoreid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "PolicyType": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyType`\n\nThe type of the policy. This is one of the following values:\n* Static\n* TemplateLinked\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policy.html#PolicyType-fn::getatt" }, "PolicyId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyId`\n\nThe unique ID of the new or updated policy.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policy.html#PolicyId-fn::getatt" } } }, "AWS::VerifiedPermissions::PolicyStore": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::PolicyStore`\n\nCreates a policy store. A policy store is a container for policy resources. You can\ncreate a separate policy store for each of your applications.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique id of the new or updated policy store. For\nexample:\n`{ \"Ref\": \"PSEXAMPLEabcdefg111111\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nDescriptive text that you can provide to help with identification\nof the current policy store.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "ValidationSettings": { "MarkdownDocumentation": "`ValidationSettings`\n\nSpecifies the validation setting for this policy store.\nCurrently, the only valid and required value is `Mode`.\n###### Important\nWe recommend that you turn on `STRICT` mode only after you define a\nschema. If a schema doesn't exist, then `STRICT` mode causes any policy\nto fail validation, and Verified Permissions rejects the policy. You can turn off validation by\nusing the [UpdatePolicyStore](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore). Then, when you have a schema defined, use [UpdatePolicyStore](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore) again to turn validation back on.\n*Required*: Yes\n*Type*: [ValidationSettings](./aws-properties-verifiedpermissions-policystore-validationsettings.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-validationsettings", "UpdateType": "Mutable", "Required": true, "Type": "ValidationSettings" }, "Schema": { "MarkdownDocumentation": "`Schema`\n\nCreates or updates the policy schema in a policy store. Cedar can use the schema to\nvalidate any Cedar policies and policy templates submitted to the policy store. Any\nchanges to the schema validate only policies and templates submitted after the schema\nchange. Existing policies and templates are not re-evaluated against the changed schema.\nIf you later update a policy, then it is evaluated against the new schema at that\ntime.\n*Required*: No\n*Type*: [SchemaDefinition](./aws-properties-verifiedpermissions-policystore-schemadefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-schema", "UpdateType": "Mutable", "Required": false, "Type": "SchemaDefinition" }, "DeletionProtection": { "MarkdownDocumentation": "`DeletionProtection`\n\nSpecifies whether the policy store can be deleted. If enabled, the policy store can't\nbe deleted.\nThe default state is `DISABLED`.\n*Required*: No\n*Type*: [DeletionProtection](./aws-properties-verifiedpermissions-policystore-deletionprotection.html)\n*Allowed values*: `ENABLED | DISABLED...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "ENABLED", "DISABLED" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-deletionprotection", "UpdateType": "Mutable", "Required": false, "Type": "DeletionProtection" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe list of key-value pairs to associate with the policy store.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-verifiedpermissions-policystore-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "PolicyStoreId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyStoreId`\n\nThe unique ID of the new or updated policy store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#PolicyStoreId-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe [Amazon Resource Name (ARN)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) of the new or updated policy store.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#Arn-fn::getatt" } } }, "AWS::VerifiedPermissions::PolicyTemplate": { "MarkdownDocumentation": "`AWS::VerifiedPermissions::PolicyTemplate`\n\nCreates a policy template. A template can use placeholders for the principal and\nresource. A template must be instantiated into a policy by associating it with specific\nprincipals and resources to use for the placeholders. That instantiated policy can then\nbe considered in authorization decisions. The instantiated policy works identically to\nany other policy, except that it is dynamically linked to the template. If the template\nchanges, then any policies that are linked to that template are immediately updated as\nwell.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique id of the policy store followed by '|' and the\nunique id of the new or updated policy template. For example:\n`{ \"Ref\": \"POLICYSTOREabcde111111|POLICYTEMPLATEab111111\" }`\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policytemplate.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nThe description to attach to the new or updated policy template.\n*Required*: No\n*Type*: String\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policytemplate.html#cfn-verifiedpermissions-policytemplate-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Statement": { "MarkdownDocumentation": "`Statement`\n\nSpecifies the content that you want to use for the new policy template, written in the Cedar\npolicy language.\n*Required*: Yes\n*Type*: String\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policytemplate.html#cfn-verifiedpermissions-policytemplate-statement", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "PolicyStoreId": { "MarkdownDocumentation": "`PolicyStoreId`\n\nThe unique identifier of the policy store that contains the template.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9-]*$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policytemplate.html#cfn-verifiedpermissions-policytemplate-policystoreid", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "PolicyTemplateId": { "PrimitiveType": "String", "MarkdownDocumentation": "`PolicyTemplateId`\n\nThe unique identifier of the new or modified policy template.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policytemplate.html#PolicyTemplateId-fn::getatt" } } }, "AWS::VpcLattice::AccessLogSubscription": { "MarkdownDocumentation": "`AWS::VpcLattice::AccessLogSubscription`\n\nEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner\ncan use the access logs to audit the services in the network. The service network owner can only\nsee access logs from clients and services that are associated with their service network. Access\nlog entries represent traffic originated from VPCs associated with that network. For more\ninformation, see [Access logs](https://docs.aws.amazon.com/vpc-lattice/latest/ug/monitoring-access-logs.html) in the\n*Amazon VPC Lattice User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the access log\nsubscription.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html", "Properties": { "ResourceIdentifier": { "MarkdownDocumentation": "`ResourceIdentifier`\n\nThe ID or ARN of the service network or service.\n*Required*: No\n*Type*: String\n*Pattern*: `^((((sn)|(svc)|(rcfg))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(resourceconfiguration/rcfg)|(service/svc))-[0-9a-z]{17}))$`\n*Minimum*: `17`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#cfn-vpclattice-accesslogsubscription-resourceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServiceNetworkLogType": { "MarkdownDocumentation": "`ServiceNetworkLogType`\n\nLog type of the service network.\n*Required*: No\n*Type*: String\n*Allowed values*: `SERVICE | RESOURCE...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "SERVICE", "RESOURCE" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#cfn-vpclattice-accesslogsubscription-servicenetworklogtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "DestinationArn": { "MarkdownDocumentation": "`DestinationArn`\n\nThe Amazon Resource Name (ARN) of the destination. The supported destination types are\nCloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#cfn-vpclattice-accesslogsubscription-destinationarn", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the access log subscription.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-accesslogsubscription-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#cfn-vpclattice-accesslogsubscription-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "ResourceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the access log subscription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#ResourceArn-fn::getatt" }, "ResourceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ResourceId`\n\nThe ID of the service network or service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#ResourceId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the access log subscription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the access log subscription.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#Arn-fn::getatt" } } }, "AWS::VpcLattice::AuthPolicy": { "MarkdownDocumentation": "`AWS::VpcLattice::AuthPolicy`\n\nCreates or updates the auth policy. The policy string in JSON must not contain newlines or\nblank lines.\nFor more information, see [Auth policies](https://docs.aws.amazon.com/vpc-lattice/latest/ug/auth-policies.html) in the *Amazon VPC\nLattice User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the auth policy.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-authpolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe auth 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-authpolicy.html#cfn-vpclattice-authpolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ResourceIdentifier": { "MarkdownDocumentation": "`ResourceIdentifier`\n\nThe ID or ARN of the service network or service for which the policy is created.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$`\n*Minimum*: `17`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-authpolicy.html#cfn-vpclattice-authpolicy-resourceidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "State": { "PrimitiveType": "String", "MarkdownDocumentation": "`State`\n\nThe state of the auth policy. The auth policy is only active when the auth type is set to\n`AWS_IAM`. If you provide a policy, then authentication and\nauthorization decisions are made based on this policy and the client's IAM policy. If the auth\ntype is `NONE`, then any auth policy you provide will remain inactive.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-authpolicy.html#State-fn::getatt" } } }, "AWS::VpcLattice::DomainVerification": { "MarkdownDocumentation": "`AWS::VpcLattice::DomainVerification`\n\nA domain name verification is an entity that allows you to prove your ownership of a given domain. When you create a domain verification using CloudFormation, use a waiter to make sure the domain verification is complete before you create a service network resource association, a VPC endpoint, or a service network VPC association with this domain.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html", "Properties": { "DomainName": { "MarkdownDocumentation": "`DomainName`\n\nThe domain name being verified.\n*Required*: Yes\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html#cfn-vpclattice-domainverification-domainname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags associated with the domain verification.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-domainverification-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html#cfn-vpclattice-domainverification-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe current status of the domain verification process.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html#Status-fn::getatt" }, "TxtMethodConfig": { "Type": "TxtMethodConfig", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html#TxtMethodConfig-fn::getatt" }, "TxtMethodConfig.name": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html#TxtMethodConfig.name-fn::getatt" }, "TxtMethodConfig.value": { "PrimitiveType": "String", "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html#TxtMethodConfig.value-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the domain verification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the domain verification.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-domainverification.html#Arn-fn::getatt" } } }, "AWS::VpcLattice::Listener": { "MarkdownDocumentation": "`AWS::VpcLattice::Listener`\n\nCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must\nadd one or more listeners. A listener is a process that checks for connection requests to your\nservices. For more information, see [Listeners](https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html) in the\n*Amazon VPC Lattice User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the listener.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html", "Properties": { "DefaultAction": { "MarkdownDocumentation": "`DefaultAction`\n\nThe action for the default rule. Each listener has a default rule. The default rule is used\nif no other rules match.\n*Required*: Yes\n*Type*: [DefaultAction](./aws-properties-vpclattice-listener-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-defaultaction", "UpdateType": "Mutable", "Required": true, "Type": "DefaultAction" }, "Port": { "MarkdownDocumentation": "`Port`\n\nThe listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For\nHTTPS, the default is 443.\n*Required*: No\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-port", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Integer" }, "ServiceIdentifier": { "MarkdownDocumentation": "`ServiceIdentifier`\n\nThe ID or ARN of the service.\n*Required*: No\n*Type*: String\n*Pattern*: `^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$`\n*Minimum*: `21`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-serviceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Protocol": { "MarkdownDocumentation": "`Protocol`\n\nThe listener protocol.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `HTTP | HTTPS | TLS_PASSTHRO...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "HTTP", "HTTPS", "TLS_PASSTHROUGH" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-protocol", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the listener.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-listener-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the listener. A listener name must be unique within a service. The valid\ncharacters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last\ncharacter, or immediately after another hyphen.\nIf you don't specify a name, CloudFormation generates one. However, if\nyou specify a name, and later want to replace the resource, you must specify a new\nname.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#Id-fn::getatt" }, "ServiceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceArn`\n\nThe Amazon Resource Name (ARN) of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#ServiceArn-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#Arn-fn::getatt" }, "ServiceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceId`\n\nThe ID of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#ServiceId-fn::getatt" } } }, "AWS::VpcLattice::ResourceConfiguration": { "MarkdownDocumentation": "`AWS::VpcLattice::ResourceConfiguration`\n\nCreates a resource configuration. A resource configuration defines a specific resource. You\ncan associate a resource configuration with a service network or a VPC endpoint.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the resource\nconfiguration.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html", "Properties": { "CustomDomainName": { "MarkdownDocumentation": "`CustomDomainName`\n\nThe custom domain name.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-customdomainname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "PortRanges": { "MarkdownDocumentation": "`PortRanges`\n\n(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource\nconfiguration (for example: 1-65535). You can separate port ranges using commas (for example:\n1,2,22-30).\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-portranges", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "ResourceConfigurationDefinition": { "MarkdownDocumentation": "`ResourceConfigurationDefinition`\n\nIdentifies the resource configuration in one of the following ways:\n* **Amazon Resource Name (ARN)** - Supported resource-types\n that are provisioned by AWS services, such as RDS databases, can be identified\n by their ARN.\n* **Domain name** - Any domain name that is publicly\n resolvable.\n* **IP address** - For IPv4 and IPv6, only IP addresses in the\n VPC are supported.\n*Required*: No\n*Type*: [ResourceConfigurationDefinition](./aws-properties-vpclattice-resourceconfiguration-resourceconfigurationdefinition.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-resourceconfigurationdefinition", "UpdateType": "Mutable", "Required": false, "Type": "ResourceConfigurationDefinition" }, "GroupDomain": { "MarkdownDocumentation": "`GroupDomain`\n\n(GROUP) The group domain for a group resource configuration. Any domains that you create for the child resource are subdomains of the group domain. Child resources inherit the verification status of the domain.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-groupdomain", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceConfigurationAuthType": { "MarkdownDocumentation": "`ResourceConfigurationAuthType`\n\nThe auth type for the resource configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AWS_IAM...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AWS_IAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-resourceconfigurationauthtype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceConfigurationGroupId": { "MarkdownDocumentation": "`ResourceConfigurationGroupId`\n\nThe ID of the group resource configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^rcfg-[0-9a-z]{17}$`\n*Minimum*: `22`\n*Maximum*: `22`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-resourceconfigurationgroupid", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the resource configuration.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!rcfg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$`\n*Minimum*: `3`\n*Maximum*: `40`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-name", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "AllowAssociationToSharableServiceNetwork": { "MarkdownDocumentation": "`AllowAssociationToSharableServiceNetwork`\n\nSpecifies whether the resource configuration can be associated with a sharable service\nnetwork.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-allowassociationtosharableservicenetwork", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "ProtocolType": { "MarkdownDocumentation": "`ProtocolType`\n\n(SINGLE, GROUP) The protocol accepted by the resource configuration.\n*Required*: No\n*Type*: String\n*Allowed values*: `TCP`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "TCP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-protocoltype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceConfigurationType": { "MarkdownDocumentation": "`ResourceConfigurationType`\n\nThe type of resource configuration. A resource configuration can be one of the following\ntypes:\n* **SINGLE** - A single resource.\n* **GROUP** - A group of resources. You must create a group\n resource configuration before you create a child resource configuration.\n* **CHILD** - A single resource that is part of a group\n resource configuration.\n* **ARN** - An AWS resource.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `GROUP | CHILD | SINGLE | AR...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "GROUP", "CHILD", "SINGLE", "ARN" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-resourceconfigurationtype", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "DomainVerificationId": { "MarkdownDocumentation": "`DomainVerificationId`\n\nThe domain verification ID.\n*Required*: No\n*Type*: String\n*Pattern*: `^dv-[a-fA-F0-9]{17}$`\n*Minimum*: `20`\n*Maximum*: `20`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-domainverificationid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ResourceGatewayId": { "MarkdownDocumentation": "`ResourceGatewayId`\n\nThe ID of the resource gateway.\n*Required*: No\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-resourcegatewayid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the resource configuration.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-resourceconfiguration-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#cfn-vpclattice-resourceconfiguration-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the resource configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the resource configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourceconfiguration.html#Arn-fn::getatt" } } }, "AWS::VpcLattice::ResourceGateway": { "MarkdownDocumentation": "`AWS::VpcLattice::ResourceGateway`\n\nA resource gateway is a point of ingress into the VPC where a resource resides. It spans\nmultiple Availability Zones. For your resource to be accessible from all Availability Zones, you\nshould create your resource gateways to span as many Availability Zones as possible. A VPC can\nhave multiple resource gateways.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the resource gateway.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html", "Properties": { "IpAddressType": { "MarkdownDocumentation": "`IpAddressType`\n\nThe type of IP address used by the resource gateway.\n*Required*: No\n*Type*: String\n*Allowed values*: `IPV4 | IPV6 | DUALSTACK...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6", "DUALSTACK" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#cfn-vpclattice-resourcegateway-ipaddresstype", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "VpcIdentifier": { "MarkdownDocumentation": "`VpcIdentifier`\n\nThe ID of the VPC for the resource gateway.\n*Required*: Yes\n*Type*: String\n*Minimum*: `5`\n*Maximum*: `50`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#cfn-vpclattice-resourcegateway-vpcidentifier", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Ipv4AddressesPerEni": { "MarkdownDocumentation": "`Ipv4AddressesPerEni`\n\nThe number of IPv4 addresses in each ENI for the resource gateway.\n*Required*: No\n*Type*: Integer\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#cfn-vpclattice-resourcegateway-ipv4addressespereni", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Integer" }, "SubnetIds": { "MarkdownDocumentation": "`SubnetIds`\n\nThe IDs of the VPC subnets for the resource gateway.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#cfn-vpclattice-resourcegateway-subnetids", "UpdateType": "Immutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the security groups applied to the resource gateway.\n*Required*: No\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#cfn-vpclattice-resourcegateway-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the resource gateway.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-resourcegateway-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#cfn-vpclattice-resourcegateway-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the resource gateway.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(?!rgw-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$`\n*Minimum*: `3`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#cfn-vpclattice-resourcegateway-name", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the resource gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the resource gateway.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcegateway.html#Arn-fn::getatt" } } }, "AWS::VpcLattice::ResourcePolicy": { "MarkdownDocumentation": "`AWS::VpcLattice::ResourcePolicy`\n\nRetrieves information about the specified resource policy. The resource policy is an IAM\npolicy created on behalf of the resource owner when they share a resource.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the resource policy.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcepolicy.html", "Properties": { "Policy": { "MarkdownDocumentation": "`Policy`\n\nThe Amazon Resource Name (ARN) of the service network or 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcepolicy.html#cfn-vpclattice-resourcepolicy-policy", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Json" }, "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nAn IAM policy.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc)|(resourceconfiguration/rcfg))-[0-9a-z]{17}$`\n*Minimum*: `20`\n*Maximum*: `200`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcepolicy.html#cfn-vpclattice-resourcepolicy-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::VpcLattice::Rule": { "MarkdownDocumentation": "`AWS::VpcLattice::Rule`\n\nCreates a listener rule. Each listener has a default rule for checking connection requests,\nbut you can define additional rules. Each rule consists of a priority, one or more actions, and\none or more conditions. For more information, see [Listener rules](https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules) in the\n*Amazon VPC Lattice User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the rule.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html", "Properties": { "Action": { "MarkdownDocumentation": "`Action`\n\nDescribes the action for a rule.\n*Required*: Yes\n*Type*: [Action](./aws-properties-vpclattice-rule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-action", "UpdateType": "Mutable", "Required": true, "Type": "Action" }, "Priority": { "MarkdownDocumentation": "`Priority`\n\nThe priority assigned to the rule. Each rule for a specific listener must have a unique\npriority. The lower the priority number the higher the priority.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-priority", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "ServiceIdentifier": { "MarkdownDocumentation": "`ServiceIdentifier`\n\nThe ID or ARN of the service.\n*Required*: No\n*Type*: String\n*Pattern*: `^((svc-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-serviceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ListenerIdentifier": { "MarkdownDocumentation": "`ListenerIdentifier`\n\nThe ID or ARN of the listener.\n*Required*: No\n*Type*: String\n*Pattern*: `^((listener-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-listeneridentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the rule.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-rule-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Match": { "MarkdownDocumentation": "`Match`\n\nThe rule match.\n*Required*: Yes\n*Type*: [Match](./aws-properties-vpclattice-rule-match.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-match", "UpdateType": "Mutable", "Required": true, "Type": "Match" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the rule. The name must be unique within the listener. The valid characters\nare a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or\nimmediately after another hyphen.\nIf you don't specify a name, CloudFormation generates one. However, if\nyou specify a name, and later want to replace the resource, you must specify a new\nname.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the listener.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the rule.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#Arn-fn::getatt" } } }, "AWS::VpcLattice::Service": { "MarkdownDocumentation": "`AWS::VpcLattice::Service`\n\nCreates a service. A service is any software application that can run on instances\ncontainers, or serverless functions within an account or virtual private cloud (VPC).\nFor more information, see [Services](https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html) in the\n*Amazon VPC Lattice User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the service.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html", "Properties": { "DnsEntry": { "MarkdownDocumentation": "`DnsEntry`\n\nDescribes the DNS information of the service. This field is read-only.\n*Required*: No\n*Type*: [DnsEntry](./aws-properties-vpclattice-service-dnsentry.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-dnsentry", "UpdateType": "Mutable", "Required": false, "Type": "DnsEntry" }, "CustomDomainName": { "MarkdownDocumentation": "`CustomDomainName`\n\nThe custom domain name of the service.\n*Required*: No\n*Type*: String\n*Minimum*: `3`\n*Maximum*: `255`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-customdomainname", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nThe type of IAM policy.\n* `NONE`: The resource does not use an IAM policy. This is the default.\n* `AWS_IAM`: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AWS_IAM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AWS_IAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-authtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the service.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-service-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the service. The name must be unique within the account. The valid characters\nare a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or\nimmediately after another hyphen.\nIf you don't specify a name, CloudFormation generates one. However, if\nyou specify a name, and later want to replace the resource, you must specify a new\nname.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$`\n*Minimum*: `3`\n*Maximum*: `40`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "CertificateArn": { "MarkdownDocumentation": "`CertificateArn`\n\nThe Amazon Resource Name (ARN) of the certificate.\n*Required*: No\n*Type*: String\n*Pattern*: `^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:certificate/[0-9a-z-]+)?$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-certificatearn", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#Status-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe date and time that the service was last updated, specified in ISO-8601 format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#LastUpdatedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the service was created, specified in ISO-8601 format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#CreatedAt-fn::getatt" }, "DnsEntry.HostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DnsEntry.HostedZoneId`\n\nThe ID of the hosted zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#DnsEntry.HostedZoneId-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#Arn-fn::getatt" }, "DnsEntry.DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DnsEntry.DomainName`\n\nThe domain name of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#DnsEntry.DomainName-fn::getatt" } } }, "AWS::VpcLattice::ServiceNetwork": { "MarkdownDocumentation": "`AWS::VpcLattice::ServiceNetwork`\n\nCreates a service network. A service network is a logical boundary for a collection of\nservices. You can associate services and VPCs with a service network.\nFor more information, see [Service networks](https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html) in the\n*Amazon VPC Lattice User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the service network.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html", "Properties": { "SharingConfig": { "MarkdownDocumentation": "`SharingConfig`\n\nSpecify if the service network should be enabled for sharing.\n*Required*: No\n*Type*: [SharingConfig](./aws-properties-vpclattice-servicenetwork-sharingconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#cfn-vpclattice-servicenetwork-sharingconfig", "UpdateType": "Mutable", "Required": false, "Type": "SharingConfig" }, "AuthType": { "MarkdownDocumentation": "`AuthType`\n\nThe type of IAM policy.\n* `NONE`: The resource does not use an IAM policy. This is the default.\n* `AWS_IAM`: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.\n*Required*: No\n*Type*: String\n*Allowed values*: `NONE | AWS_IAM...`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RefReturnValue": "", "AllowedValues": [ "NONE", "AWS_IAM" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#cfn-vpclattice-servicenetwork-authtype", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the service network.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-servicenetwork-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#cfn-vpclattice-servicenetwork-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the service network. The name must be unique to the account. The valid\ncharacters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last\ncharacter, or immediately after another hyphen.\nIf you don't specify a name, CloudFormation generates one. However, if\nyou specify a name, and later want to replace the resource, you must specify a new\nname.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$`\n*Minimum*: `3`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#cfn-vpclattice-servicenetwork-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe date and time of the last update, specified in ISO-8601 format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#LastUpdatedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the service network was created, specified in ISO-8601\nformat.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the service network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the service network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#Arn-fn::getatt" } } }, "AWS::VpcLattice::ServiceNetworkResourceAssociation": { "MarkdownDocumentation": "`AWS::VpcLattice::ServiceNetworkResourceAssociation`\n\nAssociates the specified service network with the specified resource configuration. This\nallows the resource configuration to receive connections through the service network, including\nthrough a service network VPC endpoint.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the association.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkresourceassociation.html", "Properties": { "PrivateDnsEnabled": { "MarkdownDocumentation": "`PrivateDnsEnabled`\n\nIndicates if private DNS is enabled for the service network resource association.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkresourceassociation.html#cfn-vpclattice-servicenetworkresourceassociation-privatednsenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ResourceConfigurationId": { "MarkdownDocumentation": "`ResourceConfigurationId`\n\nThe ID of the resource configuration associated with the service network.\n*Required*: No\n*Type*: String\n*Pattern*: `^rcfg-[0-9a-z]{17}$`\n*Minimum*: `17`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkresourceassociation.html#cfn-vpclattice-servicenetworkresourceassociation-resourceconfigurationid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "ServiceNetworkId": { "MarkdownDocumentation": "`ServiceNetworkId`\n\nThe ID of the service network associated with the resource configuration.\n*Required*: No\n*Type*: String\n*Pattern*: `^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$`\n*Minimum*: `3`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkresourceassociation.html#cfn-vpclattice-servicenetworkresourceassociation-servicenetworkid", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nA key-value pair to associate with a resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-servicenetworkresourceassociation-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkresourceassociation.html#cfn-vpclattice-servicenetworkresourceassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the association between the service network and resource configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkresourceassociation.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkresourceassociation.html#Arn-fn::getatt" } } }, "AWS::VpcLattice::ServiceNetworkServiceAssociation": { "MarkdownDocumentation": "`AWS::VpcLattice::ServiceNetworkServiceAssociation`\n\nAssociates the specified service with the specified service network. For more information,\nsee [Manage service associations](https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-network-associations.html#service-network-service-associations) in the *Amazon VPC Lattice User Guide*.\nYou can't use this operation if the service and service network are already associated or if\nthere is a disassociation or deletion in progress. If the association fails, you can retry the\noperation by deleting the association and recreating it.\nYou cannot associate a service and service network that are shared with a caller. The caller\nmust own either the service or the service network.\nAs a result of this operation, the association is created in the service network account and\nthe association owner account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the association.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html", "Properties": { "ServiceNetworkIdentifier": { "MarkdownDocumentation": "`ServiceNetworkIdentifier`\n\nThe ID or ARN of the service network. You must use an ARN if the resources are in different\naccounts.\n*Required*: No\n*Type*: String\n*Pattern*: `^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#cfn-vpclattice-servicenetworkserviceassociation-servicenetworkidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DnsEntry": { "MarkdownDocumentation": "`DnsEntry`\n\nThe DNS information of the service.\n*Required*: No\n*Type*: [DnsEntry](./aws-properties-vpclattice-servicenetworkserviceassociation-dnsentry.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#cfn-vpclattice-servicenetworkserviceassociation-dnsentry", "UpdateType": "Mutable", "Required": false, "Type": "DnsEntry" }, "ServiceIdentifier": { "MarkdownDocumentation": "`ServiceIdentifier`\n\nThe ID or ARN of the service.\n*Required*: No\n*Type*: String\n*Pattern*: `^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#cfn-vpclattice-servicenetworkserviceassociation-serviceidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the association.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-servicenetworkserviceassociation-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#cfn-vpclattice-servicenetworkserviceassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the association between the service network and the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#Status-fn::getatt" }, "ServiceNetworkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceNetworkId`\n\nThe ID of the service network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#ServiceNetworkId-fn::getatt" }, "ServiceName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceName`\n\nThe name of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#ServiceName-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the association was created, specified in ISO-8601 format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#CreatedAt-fn::getatt" }, "DnsEntry.HostedZoneId": { "PrimitiveType": "String", "MarkdownDocumentation": "`DnsEntry.HostedZoneId`\n\nThe ID of the hosted zone.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#DnsEntry.HostedZoneId-fn::getatt" }, "ServiceNetworkName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceNetworkName`\n\nThe name of the service network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#ServiceNetworkName-fn::getatt" }, "ServiceArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceArn`\n\nThe Amazon Resource Name (ARN) of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#ServiceArn-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the of the association between the service network and the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the association between the service network and the\nservice.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#Arn-fn::getatt" }, "DnsEntry.DomainName": { "PrimitiveType": "String", "MarkdownDocumentation": "`DnsEntry.DomainName`\n\nThe domain name of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#DnsEntry.DomainName-fn::getatt" }, "ServiceNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceNetworkArn`\n\nThe Amazon Resource Name (ARN) of the service network\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#ServiceNetworkArn-fn::getatt" }, "ServiceId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceId`\n\nThe ID of the service.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkserviceassociation.html#ServiceId-fn::getatt" } } }, "AWS::VpcLattice::ServiceNetworkVpcAssociation": { "MarkdownDocumentation": "`AWS::VpcLattice::ServiceNetworkVpcAssociation`\n\nAssociates a VPC with a service network. When you associate a VPC with the service network,\nit enables all the resources within that VPC to be clients and communicate with other services in\nthe service network. For more information, see [Manage VPC associations](https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-network-associations.html#service-network-vpc-associations) in the *Amazon VPC Lattice User Guide*.\nYou can't use this operation if there is a disassociation in progress. If the association\nfails, retry by deleting the association and recreating it.\nAs a result of this operation, the association gets created in the service network account\nand the VPC owner account.\nIf you add a security group to the service network and VPC association, the association must\ncontinue to always have at least one security group. You can add or edit security groups at any\ntime. However, to remove all security groups, you must first delete the association and recreate\nit without security groups.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the association.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html", "Properties": { "PrivateDnsEnabled": { "MarkdownDocumentation": "`PrivateDnsEnabled`\n\nIndicates if private DNS is enabled for the service network VPC association.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#cfn-vpclattice-servicenetworkvpcassociation-privatednsenabled", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "Boolean" }, "ServiceNetworkIdentifier": { "MarkdownDocumentation": "`ServiceNetworkIdentifier`\n\nThe ID or ARN of the service network. You must use an ARN if the resources are in different\naccounts.\n*Required*: No\n*Type*: String\n*Pattern*: `^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#cfn-vpclattice-servicenetworkvpcassociation-servicenetworkidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "DnsOptions": { "MarkdownDocumentation": "`DnsOptions`\n\nThe DNS options for the service network VPC association.\n*Required*: No\n*Type*: [DnsOptions](./aws-properties-vpclattice-servicenetworkvpcassociation-dnsoptions.html)\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#cfn-vpclattice-servicenetworkvpcassociation-dnsoptions", "UpdateType": "Immutable", "Required": false, "Type": "DnsOptions" }, "VpcIdentifier": { "MarkdownDocumentation": "`VpcIdentifier`\n\nThe ID of the VPC.\n*Required*: No\n*Type*: String\n*Pattern*: `^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$`\n*Minimum*: `5`\n*Maximum*: `2048`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#cfn-vpclattice-servicenetworkvpcassociation-vpcidentifier", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "SecurityGroupIds": { "MarkdownDocumentation": "`SecurityGroupIds`\n\nThe IDs of the security groups. Security groups aren't added by default. You can add a\nsecurity group to apply network level controls to control which resources in a VPC are allowed to\naccess the service network and its services. For more information, see [Control traffic to\nresources using security groups](https://docs.aws.amazon.com//vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC User\nGuide*.\n*Required*: No\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#cfn-vpclattice-servicenetworkvpcassociation-securitygroupids", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": false }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the association.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-servicenetworkvpcassociation-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#cfn-vpclattice-servicenetworkvpcassociation-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe status of the association.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#Status-fn::getatt" }, "VpcId": { "PrimitiveType": "String", "MarkdownDocumentation": "`VpcId`\n\nThe ID of the VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#VpcId-fn::getatt" }, "ServiceNetworkId": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceNetworkId`\n\nThe ID of the service network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#ServiceNetworkId-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the association was created, specified in ISO-8601 format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#CreatedAt-fn::getatt" }, "ServiceNetworkName": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceNetworkName`\n\nThe name of the service network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#ServiceNetworkName-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the specified association between the service network and the VPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the association between the service network and the\nVPC.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#Arn-fn::getatt" }, "ServiceNetworkArn": { "PrimitiveType": "String", "MarkdownDocumentation": "`ServiceNetworkArn`\n\nThe Amazon Resource Name (ARN) of the service network.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetworkvpcassociation.html#ServiceNetworkArn-fn::getatt" } } }, "AWS::VpcLattice::TargetGroup": { "MarkdownDocumentation": "`AWS::VpcLattice::TargetGroup`\n\nCreates a target group. A target group is a collection of targets, or compute resources,\nthat run your application or service. A target group can only be used by a single service.\nFor more information, see [Target groups](https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-groups.html) in the\n*Amazon VPC Lattice User Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the target group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html", "Properties": { "Type": { "MarkdownDocumentation": "`Type`\n\nThe type of target group.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IP | LAMBDA | INSTANCE | AL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "IP", "LAMBDA", "INSTANCE", "ALB" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-type", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Config": { "MarkdownDocumentation": "`Config`\n\nThe target group configuration.\n*Required*: No\n*Type*: [TargetGroupConfig](./aws-properties-vpclattice-targetgroup-targetgroupconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-config", "UpdateType": "Mutable", "Required": false, "Type": "TargetGroupConfig" }, "Targets": { "MarkdownDocumentation": "`Targets`\n\nDescribes a target.\n*Required*: No\n*Type*: Array of [Target](./aws-properties-vpclattice-targetgroup-target.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-targets", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Target", "DuplicatesAllowed": true }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the target group.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-vpclattice-targetgroup-tag.html)\n*Minimum*: `0`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": false }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the target group. The name must be unique within the account. The valid\ncharacters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last\ncharacter, or immediately after another hyphen.\nIf you don't specify a name, CloudFormation generates one. However, if\nyou specify a name, and later want to replace the resource, you must specify a new\nname.\n*Required*: No\n*Type*: String\n*Pattern*: `^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$`\n*Minimum*: `3`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Status": { "PrimitiveType": "String", "MarkdownDocumentation": "`Status`\n\nThe operation's status. You can retry the operation if the status is\n`CREATE_FAILED`. However, if you retry it while the status is\n`CREATE_IN_PROGRESS`, there is no change in the status.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#Status-fn::getatt" }, "LastUpdatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`LastUpdatedAt`\n\nThe date and time that the target group was last updated, specified in ISO-8601\nformat.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#LastUpdatedAt-fn::getatt" }, "CreatedAt": { "PrimitiveType": "String", "MarkdownDocumentation": "`CreatedAt`\n\nThe date and time that the target group was created, specified in ISO-8601 format.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#CreatedAt-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the target group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#Arn-fn::getatt" } } }, "AWS::WAF::ByteMatchSet": { "MarkdownDocumentation": "`AWS::WAF::ByteMatchSet`\n\n###### Note\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nThe `AWS::WAF::ByteMatchSet` resource creates an AWS WAF`ByteMatchSet` that identifies a part of a web request that you want to inspect.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html", "Properties": { "ByteMatchTuples": { "MarkdownDocumentation": "`ByteMatchTuples`\n\nSpecifies 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*: Array of [ByteMatchTuple](./aws-properties-waf-bytematchset-bytematchtuple.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html#cfn-waf-bytematchset-bytematchtuples", "DuplicatesAllowed": false, "ItemType": "ByteMatchTuple", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the `ByteMatchSet`. You can't change `Name` after you create a `ByteMatchSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html#cfn-waf-bytematchset-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::WAF::IPSet": { "MarkdownDocumentation": "`AWS::WAF::IPSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nContains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.\nTo specify an individual IP address, you specify the four-part IP address followed by a\n`/32`, for example, 192.0.2.0/32. To block a range of IP addresses, you can\nspecify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or\n/128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry [Classless\nInter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html", "Properties": { "IPSetDescriptors": { "MarkdownDocumentation": "`IPSetDescriptors`\n\nThe IP address type (`IPV4` or `IPV6`) and the IP address range (in CIDR notation) that web requests originate from.\nIf the `WebACL` is associated with an Amazon CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.\n*Required*: No\n*Type*: Array of [IPSetDescriptor](./aws-properties-waf-ipset-ipsetdescriptor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html#cfn-waf-ipset-ipsetdescriptors", "DuplicatesAllowed": false, "ItemType": "IPSetDescriptor", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the `IPSet`. You can't change the name of an `IPSet` after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html#cfn-waf-ipset-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" } } }, "AWS::WAF::Rule": { "MarkdownDocumentation": "`AWS::WAF::Rule`\n\n###### Note\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA combination of `ByteMatchSet`, `IPSet`, and/or `SqlInjectionMatchSet` objects that identify the web requests that you\nwant to allow, block, or count. For example, you might create a `Rule` that includes the following predicates:\n* An `IPSet` that causes AWS WAF to search for web requests that originate from the IP address `192.0.2.44`\n* A `ByteMatchSet` that causes AWS WAF to search for web requests for which the value of the `User-Agent`\n header is `BadBot`.\nTo match the settings in this `Rule`, a request must originate from `192.0.2.44` AND include a `User-Agent`\nheader for which the value is `BadBot`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html", "Properties": { "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metrics for this `Rule`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\nwhitespace or metric names reserved for AWS WAF, including \"All\" and \"Default\\_Action.\" You can't change `MetricName` after you create the `Rule`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-metricname", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe friendly name or description for the `Rule`. You can't change the name of a `Rule` after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Predicates": { "MarkdownDocumentation": "`Predicates`\n\nThe `Predicates` object contains one `Predicate` element for each `ByteMatchSet`, `IPSet`, or\n`SqlInjectionMatchSet` object that you want to include in a `Rule`.\n*Required*: No\n*Type*: Array of [Predicate](./aws-properties-waf-rule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-predicates", "DuplicatesAllowed": false, "ItemType": "Predicate", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::WAF::SizeConstraintSet": { "MarkdownDocumentation": "`AWS::WAF::SizeConstraintSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA complex type that contains `SizeConstraint` objects, which specify the parts of web requests that you\nwant AWS WAF to inspect the size of. If a `SizeConstraintSet` contains more than one `SizeConstraint`\nobject, a request only needs to match one constraint to be considered a match.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name, if any, of the `SizeConstraintSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html#cfn-waf-sizeconstraintset-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "SizeConstraints": { "MarkdownDocumentation": "`SizeConstraints`\n\nThe size constraint and the part of the web request to check.\n*Required*: Yes\n*Type*: Array of [SizeConstraint](./aws-properties-waf-sizeconstraintset-sizeconstraint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html#cfn-waf-sizeconstraintset-sizeconstraints", "DuplicatesAllowed": false, "ItemType": "SizeConstraint", "Required": true, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::WAF::SqlInjectionMatchSet": { "MarkdownDocumentation": "`AWS::WAF::SqlInjectionMatchSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA complex type that contains `SqlInjectionMatchTuple` objects, which specify the parts of web requests that you\nwant AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a\n`SqlInjectionMatchSet` contains more than one `SqlInjectionMatchTuple` object, a request needs to\ninclude snippets of SQL code in only one of the specified parts of the request to be considered a match.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name, if any, of the `SqlInjectionMatchSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html#cfn-waf-sqlinjectionmatchset-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "SqlInjectionMatchTuples": { "MarkdownDocumentation": "`SqlInjectionMatchTuples`\n\nSpecifies the parts of web requests that you want to inspect for snippets of malicious SQL code.\n*Required*: No\n*Type*: Array of [SqlInjectionMatchTuple](./aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuple.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples", "DuplicatesAllowed": false, "ItemType": "SqlInjectionMatchTuple", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::WAF::WebACL": { "MarkdownDocumentation": "`AWS::WAF::WebACL`\n\n###### Note\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nContains the `Rules` that identify the requests that you want to allow, block, or count. In a `WebACL`, you also specify a\ndefault action (`ALLOW` or `BLOCK`), and the action for each `Rule` that you add to a\n`WebACL`, for example, block requests from specified IP addresses or block requests from specified referrers.\nYou also associate the `WebACL` with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter.\nIf you add more than one `Rule` to a `WebACL`, a request needs to match only one of the specifications\nto be allowed, blocked, or counted.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html", "Properties": { "DefaultAction": { "MarkdownDocumentation": "`DefaultAction`\n\nThe action to perform if none of the `Rules` contained in the `WebACL` match. The action is specified by the\n`WafAction` object.\n*Required*: Yes\n*Type*: [WafAction](./aws-properties-waf-webacl-wafaction.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-defaultaction", "Required": true, "Type": "WafAction", "UpdateType": "Mutable" }, "MetricName": { "MarkdownDocumentation": "`MetricName`\n\nThe name of the metrics for this `WebACL`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\nwhitespace or metric names reserved for AWS WAF, including \"All\" and \"Default\\_Action.\" You can't change `MetricName` after you create the `WebACL`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-metricname", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Name": { "MarkdownDocumentation": "`Name`\n\nA friendly name or description of the `WebACL`. You can't change the name of a `WebACL` after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nAn array that contains the action for each `Rule` in a `WebACL`, the priority of the `Rule`,\nand the ID of the `Rule`.\n*Required*: No\n*Type*: Array of [ActivatedRule](./aws-properties-waf-webacl-activatedrule.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-rules", "DuplicatesAllowed": false, "ItemType": "ActivatedRule", "Required": false, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::WAF::XssMatchSet": { "MarkdownDocumentation": "`AWS::WAF::XssMatchSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA complex type that contains `XssMatchTuple` objects, which specify the parts of web requests that you\nwant AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a\n`XssMatchSet` contains more than one `XssMatchTuple` object, a request needs to\ninclude cross-site scripting attacks in only one of the specified parts of the request to be considered a match.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html", "Properties": { "Name": { "MarkdownDocumentation": "`Name`\n\nThe name, if any, of the `XssMatchSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html#cfn-waf-xssmatchset-name", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "XssMatchTuples": { "MarkdownDocumentation": "`XssMatchTuples`\n\nSpecifies the parts of web requests that you want to inspect for cross-site scripting attacks.\n*Required*: Yes\n*Type*: Array of [XssMatchTuple](./aws-properties-waf-xssmatchset-xssmatchtuple.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html#cfn-waf-xssmatchset-xssmatchtuples", "DuplicatesAllowed": false, "ItemType": "XssMatchTuple", "Required": true, "Type": "List", "UpdateType": "Mutable" } } }, "AWS::WAFRegional::ByteMatchSet": { "MarkdownDocumentation": "`AWS::WAFRegional::ByteMatchSet`\n\n###### Note\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nThe `AWS::WAFRegional::ByteMatchSet` resource creates an AWS WAF`ByteMatchSet` that identifies a part of a web request that you want to inspect.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html", "Properties": { "ByteMatchTuples": { "Type": "List", "Required": false, "MarkdownDocumentation": "`ByteMatchTuples`\n\nSpecifies 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*: Array of [ByteMatchTuple](./aws-properties-wafregional-bytematchset-bytematchtuple.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html#cfn-wafregional-bytematchset-bytematchtuples", "ItemType": "ByteMatchTuple", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA friendly name or description of the `ByteMatchSet`. You can't change `Name` after you create a `ByteMatchSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html#cfn-wafregional-bytematchset-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::GeoMatchSet": { "MarkdownDocumentation": "`AWS::WAFRegional::GeoMatchSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nContains one or more countries that AWS WAF will search for.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-geomatchset.html", "Properties": { "GeoMatchConstraints": { "Type": "List", "Required": false, "MarkdownDocumentation": "`GeoMatchConstraints`\n\nAn array of `GeoMatchConstraint` objects, which contain the country that you want AWS WAF to search for.\n*Required*: No\n*Type*: Array of [GeoMatchConstraint](./aws-properties-wafregional-geomatchset-geomatchconstraint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-geomatchset.html#cfn-wafregional-geomatchset-geomatchconstraints", "ItemType": "GeoMatchConstraint", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA friendly name or description of the [AWS::WAFRegional::GeoMatchSet](./aws-resource-wafregional-geomatchset.html). You can't change the name of an `GeoMatchSet` after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-geomatchset.html#cfn-wafregional-geomatchset-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::IPSet": { "MarkdownDocumentation": "`AWS::WAFRegional::IPSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nContains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.\nTo specify an individual IP address, you specify the four-part IP address followed by a\n`/32`, for example, 192.0.2.0/32. To block a range of IP addresses, you can\nspecify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or\n/128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry [Classless\nInter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html", "Properties": { "IPSetDescriptors": { "Type": "List", "Required": false, "MarkdownDocumentation": "`IPSetDescriptors`\n\nThe IP address type (`IPV4` or `IPV6`) and the IP address range (in CIDR notation) that web requests originate from.\n*Required*: No\n*Type*: Array of [IPSetDescriptor](./aws-properties-wafregional-ipset-ipsetdescriptor.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html#cfn-wafregional-ipset-ipsetdescriptors", "ItemType": "IPSetDescriptor", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA friendly name or description of the `IPSet`. You can't change the name of an `IPSet` after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html#cfn-wafregional-ipset-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::RateBasedRule": { "MarkdownDocumentation": "`AWS::WAFRegional::RateBasedRule`\n\n###### Note\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA `RateBasedRule` is identical to a regular `Rule`, with\none addition: a `RateBasedRule` counts the number of requests that arrive from a\nspecified IP address every five minutes. For example, based on recent requests that you've\nseen from an attacker, you might create a `RateBasedRule` that includes the\nfollowing conditions:\n* The requests come from 192.0.2.44.\n* They contain the value `BadBot` in the `User-Agent`\n header.\nIn the rule, you also define the rate limit as 15,000.\nRequests that meet both of these conditions and exceed 15,000 requests every five\nminutes trigger the rule's action (block or count), which is defined in the web\nACL.\nNote you can only create rate-based rules using an CloudFormation template. To add the rate-based rules created through CloudFormation to a web ACL, use the AWS WAF console, API, or command line interface (CLI). For more information, see\n[UpdateWebACL](https://docs.aws.amazon.com/waf/latest/APIReference/API_regional_UpdateWebACL.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html", "Properties": { "MetricName": { "Required": true, "MarkdownDocumentation": "`MetricName`\n\nA name for the metrics for a `RateBasedRule`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\nwhitespace or metric names reserved for AWS WAF, including \"All\" and \"Default\\_Action.\" You can't change the name of the metric after you create the\n`RateBasedRule`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-metricname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "RateLimit": { "Required": true, "MarkdownDocumentation": "`RateLimit`\n\nThe maximum number of requests, which have an identical value in the field specified\nby the `RateKey`, allowed in a five-minute period. If the number of requests\nexceeds the `RateLimit` and the other predicates specified in the rule are also\nmet, AWS WAF triggers the action that is specified for this rule.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-ratelimit", "PrimitiveType": "Integer", "UpdateType": "Mutable" }, "MatchPredicates": { "Type": "List", "Required": false, "MarkdownDocumentation": "`MatchPredicates`\n\nThe `Predicates` object contains one `Predicate` element for\neach `ByteMatchSet`, `IPSet`, or `SqlInjectionMatchSet>` object that you want to include in a\n`RateBasedRule`.\n*Required*: No\n*Type*: Array of [Predicate](./aws-properties-wafregional-ratebasedrule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-matchpredicates", "ItemType": "Predicate", "UpdateType": "Mutable" }, "RateKey": { "Required": true, "MarkdownDocumentation": "`RateKey`\n\nThe field that AWS WAF uses to determine if requests are likely arriving from single\nsource and thus subject to rate monitoring. The only valid value for `RateKey`\nis `IP`. `IP` indicates that requests arriving from the same IP\naddress are subject to the `RateLimit` that is specified in the\n`RateBasedRule`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `IP`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "AllowedValues": [ "IP" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-ratekey", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA friendly name or description for a `RateBasedRule`. You can't change the\nname of a `RateBasedRule` after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::RegexPatternSet": { "MarkdownDocumentation": "`AWS::WAFRegional::RegexPatternSet`\n\nThe `RegexPatternSet` specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. You can then configure AWS WAF to reject those requests.\nNote that you can only create regex pattern sets using a CloudFormation template. To add the regex pattern sets created through CloudFormation to a RegexMatchSet, use the AWS WAF console, API, or command line interface (CLI). For more information, see\n[UpdateRegexMatchSet](https://docs.aws.amazon.com/waf/latest/APIReference/API_regional_UpdateRegexMatchSet.html).\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-regexpatternset.html", "Properties": { "RegexPatternStrings": { "PrimitiveItemType": "String", "Type": "List", "Required": true, "MarkdownDocumentation": "`RegexPatternStrings`\n\nSpecifies the regular expression (regex) patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-regexpatternset.html#cfn-wafregional-regexpatternset-regexpatternstrings", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA friendly name or description of the [AWS::WAFRegional::RegexPatternSet](./aws-resource-wafregional-regexpatternset.html). You can't change `Name` after you create a `RegexPatternSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-regexpatternset.html#cfn-wafregional-regexpatternset-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::Rule": { "MarkdownDocumentation": "`AWS::WAFRegional::Rule`\n\n###### Note\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA combination of `ByteMatchSet`, `IPSet`, and/or `SqlInjectionMatchSet` objects that identify the web requests that you\nwant to allow, block, or count. For example, you might create a `Rule` that includes the following predicates:\n* An `IPSet` that causes AWS WAF to search for web requests that originate from the IP address `192.0.2.44`\n* A `ByteMatchSet` that causes AWS WAF to search for web requests for which the value of the `User-Agent`\n header is `BadBot`.\nTo match the settings in this `Rule`, a request must originate from `192.0.2.44` AND include a `User-Agent`\nheader for which the value is `BadBot`.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html", "Properties": { "MetricName": { "Required": true, "MarkdownDocumentation": "`MetricName`\n\nA name for the metrics for this `Rule`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\nwhitespace or metric names reserved for AWS WAF, including \"All\" and \"Default\\_Action.\" You can't change `MetricName` after you create the `Rule`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-metricname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "Predicates": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Predicates`\n\nThe `Predicates` object contains one `Predicate` element for each `ByteMatchSet`, `IPSet`, or\n`SqlInjectionMatchSet` object that you want to include in a `Rule`.\n*Required*: No\n*Type*: Array of [Predicate](./aws-properties-wafregional-rule-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-predicates", "ItemType": "Predicate", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe friendly name or description for the `Rule`. You can't change the name of a `Rule` after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::SizeConstraintSet": { "MarkdownDocumentation": "`AWS::WAFRegional::SizeConstraintSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA complex type that contains `SizeConstraint` objects, which specify the parts of web requests that you\nwant AWS WAF to inspect the size of. If a `SizeConstraintSet` contains more than one `SizeConstraint`\nobject, a request only needs to match one constraint to be considered a match.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html", "Properties": { "SizeConstraints": { "Type": "List", "Required": false, "MarkdownDocumentation": "`SizeConstraints`\n\nThe size constraint and the part of the web request to check.\n*Required*: No\n*Type*: Array of [SizeConstraint](./aws-properties-wafregional-sizeconstraintset-sizeconstraint.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html#cfn-wafregional-sizeconstraintset-sizeconstraints", "ItemType": "SizeConstraint", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name, if any, of the `SizeConstraintSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html#cfn-wafregional-sizeconstraintset-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::SqlInjectionMatchSet": { "MarkdownDocumentation": "`AWS::WAFRegional::SqlInjectionMatchSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA complex type that contains `SqlInjectionMatchTuple` objects, which specify the parts of web requests that you\nwant AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a\n`SqlInjectionMatchSet` contains more than one `SqlInjectionMatchTuple` object, a request needs to\ninclude snippets of SQL code in only one of the specified parts of the request to be considered a match.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html", "Properties": { "SqlInjectionMatchTuples": { "Type": "List", "Required": false, "MarkdownDocumentation": "`SqlInjectionMatchTuples`\n\nSpecifies the parts of web requests that you want to inspect for snippets of malicious SQL code.\n*Required*: No\n*Type*: Array of [SqlInjectionMatchTuple](./aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuples", "ItemType": "SqlInjectionMatchTuple", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name, if any, of the `SqlInjectionMatchSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html#cfn-wafregional-sqlinjectionmatchset-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::WebACL": { "MarkdownDocumentation": "`AWS::WAFRegional::WebACL`\n\n###### Note\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nContains the `Rules` that identify the requests that you want to allow, block, or count. In a `WebACL`, you also specify a\ndefault action (`ALLOW` or `BLOCK`), and the action for each `Rule` that you add to a\n`WebACL`, for example, block requests from specified IP addresses or block requests from specified referrers.\nIf you add more than one `Rule` to a `WebACL`, a request needs to match only one of the specifications\nto be allowed, blocked, or counted.\nTo identify the requests that you want AWS WAF to filter, you associate the `WebACL` with an API Gateway API or an Application Load Balancer.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html", "Properties": { "MetricName": { "Required": true, "MarkdownDocumentation": "`MetricName`\n\nA name for the metrics for this `WebACL`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\nwhitespace or metric names reserved for AWS WAF, including \"All\" and \"Default\\_Action.\" You can't change `MetricName` after you create the `WebACL`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-metricname", "PrimitiveType": "String", "UpdateType": "Immutable" }, "DefaultAction": { "Type": "Action", "Required": true, "MarkdownDocumentation": "`DefaultAction`\n\nThe action to perform if none of the `Rules` contained in the `WebACL` match. The action is specified by the\n`WafAction` object.\n*Required*: Yes\n*Type*: [Action](./aws-properties-wafregional-webacl-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-defaultaction", "UpdateType": "Mutable" }, "Rules": { "Type": "List", "Required": false, "MarkdownDocumentation": "`Rules`\n\nAn array that contains the action for each `Rule` in a `WebACL`, the priority of the `Rule`,\nand the ID of the `Rule`.\n*Required*: No\n*Type*: Array of [Rule](./aws-properties-wafregional-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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-rules", "ItemType": "Rule", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nA friendly name or description of the `WebACL`. You can't change the name of a `WebACL` after you create it.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::WebACLAssociation": { "MarkdownDocumentation": "`AWS::WAFRegional::WebACLAssociation`\n\n###### Note\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nThe AWS::WAFRegional::WebACLAssociation resource associates an AWS WAF Regional web access control group (ACL) with a resource.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html", "Properties": { "ResourceArn": { "Required": true, "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the resource to protect with the web ACL.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html#cfn-wafregional-webaclassociation-resourcearn", "PrimitiveType": "String", "UpdateType": "Immutable" }, "WebACLId": { "Required": true, "MarkdownDocumentation": "`WebACLId`\n\nA unique identifier (ID) for the web ACL.\n*Required*: Yes\n*Type*: String\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html#cfn-wafregional-webaclassociation-webaclid", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFRegional::XssMatchSet": { "MarkdownDocumentation": "`AWS::WAFRegional::XssMatchSet`\n\n###### Note\nAWS WAF Classic support will end on September 30, 2025.\nThis is **AWS WAF Classic** documentation. For\nmore information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.\n**For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.\nA complex type that contains `XssMatchTuple` objects, which specify the parts of web requests that you\nwant AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a\n`XssMatchSet` contains more than one `XssMatchTuple` object, a request needs to\ninclude cross-site scripting attacks in only one of the specified parts of the request to be considered a match.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html", "Properties": { "XssMatchTuples": { "Type": "List", "Required": false, "MarkdownDocumentation": "`XssMatchTuples`\n\nSpecifies the parts of web requests that you want to inspect for cross-site scripting attacks.\n*Required*: No\n*Type*: Array of [XssMatchTuple](./aws-properties-wafregional-xssmatchset-xssmatchtuple.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html#cfn-wafregional-xssmatchset-xssmatchtuples", "ItemType": "XssMatchTuple", "UpdateType": "Mutable" }, "Name": { "Required": true, "MarkdownDocumentation": "`Name`\n\nThe name, if any, of the `XssMatchSet`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html#cfn-wafregional-xssmatchset-name", "PrimitiveType": "String", "UpdateType": "Immutable" } } }, "AWS::WAFv2::IPSet": { "MarkdownDocumentation": "`AWS::WAFv2::IPSet`\n\n###### Note\nThis is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For\ninformation, including how to migrate your AWS WAF resources from the\nprior release, see the [AWS WAF developer guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\nUse an AWS::WAFv2::IPSet to identify web requests that originate from specific IP\naddresses or ranges of IP addresses. For example, if you're receiving a lot of requests\nfrom a ranges of IP addresses, you can configure AWS WAF to block them\nusing an IP set that lists those IP addresses.\nYou use an IP set by providing its Amazon Resource Name (ARN) to the rule statement\n`IPSetReferenceStatement`, when you add a rule to a rule group or web ACL.\n", "RefReturnValue": "\nThe `Ref` for the resource, containing the resource name, physical ID, and\nscope, formatted as follows: `name|id|scope`.\nFor example:\n`my-webacl-name|1234a1a-a1b1-12a1-abcd-a123b123456|REGIONAL`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html", "Properties": { "Addresses": { "MarkdownDocumentation": "`Addresses`\n\nContains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests. 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* For requests that originated from the IP address 192.0.2.44, specify `192.0.2.44/32`.\n* For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify\n `192.0.2.0/24`.\n* For 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* For 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*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-addresses", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the IP set that helps with identification.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nSpecifies whether this is for an Amazon CloudFront distribution or for a regional\napplication. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are `CLOUDFRONT` and\n`REGIONAL`.\n###### Note\nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East (N.\nVirginia) Region, `us-east-1`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLOUDFRONT | REGIONAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CLOUDFRONT", "REGIONAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-scope", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "IPAddressVersion": { "MarkdownDocumentation": "`IPAddressVersion`\n\nThe 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)", "RefReturnValue": "", "AllowedValues": [ "IPV4", "IPV6" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-ipaddressversion", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey:value pairs associated with an AWS resource. The key:value pair can\nbe anything you define. Typically, the tag key represents a category (such as\n\"environment\") and the tag value represents a specific value within that category (such as\n\"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource.\n###### Note\nTo modify tags on existing resources, use the AWS WAF APIs or\ncommand line interface. With AWS CloudFormation, you can only add tags to AWS WAF resources during resource creation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-wafv2-ipset-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the IP set. You cannot change the name of an `IPSet` after you create it.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_-]{1,128}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the IP set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the IP set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#Arn-fn::getatt" } } }, "AWS::WAFv2::LoggingConfiguration": { "MarkdownDocumentation": "`AWS::WAFv2::LoggingConfiguration`\n\nDefines an association between logging destinations and a web ACL resource, for logging\nfrom AWS WAF. As part of the association, you can specify parts of the standard logging\nfields to keep out of the logs and you can specify filters so that you log only a subset of\nthe logging records.\nIf you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs.\n###### Note\nYou can define one logging destination per web ACL.\nYou can access information about the traffic that AWS WAF inspects using the following\nsteps:\n1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.\n \n The name that you give the destination must start with `aws-waf-logs-`. Depending on the type of destination, you might need to configure additional settings or permissions.\n \n For configuration requirements and pricing information for each destination type, see\n [Logging web ACL traffic](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html)\n in the *AWS WAF Developer Guide*.\n2. Associate your logging destination to your web ACL using a\n `PutLoggingConfiguration` request.\nWhen you successfully enable logging using a `PutLoggingConfiguration`\nrequest, AWS WAF creates an additional role or policy that is required to write\nlogs to the logging destination. For an Amazon CloudWatch Logs log group, AWS WAF creates a resource policy on the log group.\nFor an Amazon S3 bucket, AWS WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, AWS WAF creates a service-linked role.\nFor additional information about web ACL logging, see\n[Logging web ACL traffic information](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html)\nin the *AWS WAF Developer Guide*.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the web ACL.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe Amazon Resource Name (ARN) of the web ACL that you want to associate with\n`LogDestinationConfigs`.\n*Required*: Yes\n*Type*: String\n*Pattern*: `.*\\S.*`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "LogDestinationConfigs": { "MarkdownDocumentation": "`LogDestinationConfigs`\n\nThe logging destination configuration that you want to associate with the web\nACL.\n###### Note\nYou can associate one logging destination to a web ACL.\n*Required*: Yes\n*Type*: Array of 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-logdestinationconfigs", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "RedactedFields": { "MarkdownDocumentation": "`RedactedFields`\n\nThe parts of the request that you want to keep out of the logs.\nFor example, if you\nredact the `SingleHeader` field, the `HEADER` field in the logs will\nbe `REDACTED` for all rules that use the `SingleHeader``FieldToMatch` setting.\nIf you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs.\nRedaction applies only to the component that's specified in the rule's `FieldToMatch` setting, so the `SingleHeader` redaction\ndoesn't apply to rules that use the `Headers``FieldToMatch`.\n###### Note\nYou can specify only the following fields for redaction: `UriPath`,\n`QueryString`, `SingleHeader`, and `Method`.\n\n###### Note\nThis setting has no impact on request sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration\nor by configuring data protection for the web ACL.\n*Required*: No\n*Type*: Array of [FieldToMatch](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-redactedfields", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "FieldToMatch", "DuplicatesAllowed": true }, "LoggingFilter": { "MarkdownDocumentation": "`LoggingFilter`\n\nFiltering that specifies which web requests are kept in the logs and which are dropped.\nYou can filter on the rule action and on the web request labels that were applied by\nmatching rules during web ACL evaluation.\n*Required*: No\n*Type*: [LoggingFilter](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-loggingfilter", "UpdateType": "Mutable", "Required": false, "Type": "LoggingFilter" } }, "Attributes": { "ManagedByFirewallManager": { "PrimitiveType": "Boolean", "MarkdownDocumentation": "`ManagedByFirewallManager`\n\nIndicates whether the logging configuration was created by AWS Firewall Manager, as\npart of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#ManagedByFirewallManager-fn::getatt" } } }, "AWS::WAFv2::RegexPatternSet": { "MarkdownDocumentation": "`AWS::WAFv2::RegexPatternSet`\n\n###### Note\nThis is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For\ninformation, including how to migrate your AWS WAF resources from the\nprior release, see the [AWS WAF developer guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\nUse an AWS::WAFv2::RegexPatternSet to have AWS WAF inspect a web\nrequest component for a specific set of regular expression patterns.\nYou use a regex pattern set by providing its Amazon Resource Name (ARN) to the rule\nstatement `RegexPatternSetReferenceStatement`, when you add a rule to a rule\ngroup or web ACL.\n", "RefReturnValue": "\nThe `Ref` for the resource, containing the resource name, physical ID, and\nscope, formatted as follows: `name|id|scope`.\nFor example:\n`my-webacl-name|1234a1a-a1b1-12a1-abcd-a123b123456|REGIONAL`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the set that helps with identification.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "RegularExpressionList": { "MarkdownDocumentation": "`RegularExpressionList`\n\nThe regular expression patterns in the set.\n*Required*: Yes\n*Type*: Array of String\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-regularexpressionlist", "UpdateType": "Mutable", "Required": true, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nSpecifies whether this is for an Amazon CloudFront distribution or for a regional\napplication. For an AWS Amplify application, use `CLOUDFRONT`.\nA regional application can be an Application Load Balancer (ALB), an Amazon API Gateway\nREST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool,\nan AWS App Runner service, or an AWS Verified Access instance. Valid Values are\n`CLOUDFRONT` and `REGIONAL`.\n###### Note\nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East (N.\nVirginia) Region, `us-east-1`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLOUDFRONT | REGIONAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CLOUDFRONT", "REGIONAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-scope", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey:value pairs associated with an AWS resource. The key:value pair can\nbe anything you define. Typically, the tag key represents a category (such as\n\"environment\") and the tag value represents a specific value within that category (such as\n\"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource.\n###### Note\nTo modify tags on existing resources, use the AWS WAF APIs or\ncommand line interface. With AWS CloudFormation, you can only add tags to AWS WAF resources during resource creation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-wafv2-regexpatternset-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe name of the set. You cannot change the name after you create the set.\n*Required*: No\n*Type*: String\n*Pattern*: `^[0-9A-Za-z_-]{1,128}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#cfn-wafv2-regexpatternset-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the regex pattern set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the regex pattern set.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html#Arn-fn::getatt" } } }, "AWS::WAFv2::RuleGroup": { "MarkdownDocumentation": "`AWS::WAFv2::RuleGroup`\n\n###### Note\nThis is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For\ninformation, including how to migrate your AWS WAF resources from the\nprior release, see the [AWS WAF developer guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\nUse an AWS::WAFv2::RuleGroup to define a collection of rules for inspecting and\ncontrolling web requests. You use a rule group in an [AWS::WAFv2::WebACL](./aws-resource-wafv2-webacl.html) by providing\nits Amazon Resource Name (ARN) to the rule statement\n`RuleGroupReferenceStatement`, when you add rules to the web ACL.\nWhen you create a rule group, you define an immutable capacity limit. If you update a\nrule group, you must stay within the capacity. This allows others to reuse the rule group\nwith confidence in its capacity requirements.\n", "RefReturnValue": "\nThe `Ref` for the resource, containing the resource name, physical ID, and\nscope, formatted as follows: `name|id|scope`.\nFor example:\n`my-webacl-name|1234a1a-a1b1-12a1-abcd-a123b123456|REGIONAL`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the rule group that helps with identification.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nSpecifies whether this is for an Amazon CloudFront distribution or for a regional\napplication. For an AWS Amplify application, use `CLOUDFRONT`.\nA regional application can be an Application Load Balancer (ALB), an Amazon API Gateway\nREST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool,\nan AWS App Runner service, or an AWS Verified Access instance. Valid Values are\n`CLOUDFRONT` and `REGIONAL`.\n###### Note\nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East (N.\nVirginia) Region, `us-east-1`.\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLOUDFRONT | REGIONAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CLOUDFRONT", "REGIONAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-scope", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "Capacity": { "MarkdownDocumentation": "`Capacity`\n\nThe 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\ncreation. When you add or modify the rules in a rule group, AWS WAF enforces\nthis limit.\nAWS WAF uses WCUs to calculate and control the operating resources that are\nused to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity\ndifferently for each rule type, to reflect the relative cost of each rule. Simple rules\nthat cost little to run use fewer WCUs than more complex rules that use more processing\npower. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU\nusage when they use a rule group. The WCU limit for web ACLs is 1,500.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-capacity", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "Integer" }, "AvailableLabels": { "MarkdownDocumentation": "`AvailableLabels`\n\nThe labels that one or more rules in this rule group add to matching web requests. These\nlabels are defined in the `RuleLabels` for a `Rule`.\n*Required*: No\n*Type*: Array of [LabelSummary](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-availablelabels", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LabelSummary", "DuplicatesAllowed": true }, "CustomResponseBodies": { "MarkdownDocumentation": "`CustomResponseBodies`\n\nA 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,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\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)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: Object of [CustomResponseBody](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-customresponsebodies", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "CustomResponseBody" }, "ConsumedLabels": { "MarkdownDocumentation": "`ConsumedLabels`\n\nThe 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*: Array of [LabelSummary](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-consumedlabels", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "LabelSummary", "DuplicatesAllowed": true }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe rule statements used to identify the web requests that you want to allow, block, or\ncount. Each rule includes one top-level statement that AWS WAF uses to\nidentify matching web requests, and parameters that govern how AWS WAF\nhandles them.\n*Required*: No\n*Type*: Array of [Rule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-rules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true }, "VisibilityConfig": { "MarkdownDocumentation": "`VisibilityConfig`\n\nDefines and enables Amazon CloudWatch metrics and web request sample collection.\n*Required*: Yes\n*Type*: [VisibilityConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-visibilityconfig", "UpdateType": "Mutable", "Required": true, "Type": "VisibilityConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey:value pairs associated with an AWS resource. The key:value pair can\nbe anything you define. Typically, the tag key represents a category (such as\n\"environment\") and the tag value represents a specific value within that category (such as\n\"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource.\n###### Note\nTo modify tags on existing resources, use the AWS WAF APIs or\ncommand line interface. With AWS CloudFormation, you can only add tags to AWS WAF resources during resource creation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-wafv2-rulegroup-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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*Pattern*: `^[0-9A-Za-z_-]{1,128}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" } }, "Attributes": { "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the rule group.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#Arn-fn::getatt" }, "LabelNamespace": { "PrimitiveType": "String", "MarkdownDocumentation": "`LabelNamespace`\n\nThe label namespace prefix for this rule group. All labels added by rules in this rule\ngroup have this prefix.\nThe syntax for the label namespace prefix for a rule group is the following:\n`awswaf::rule group::`\nWhen a rule with a label matches a web request, AWS WAF adds the fully\nqualified label to the request. A fully qualified label is made up of the label namespace\nfrom the rule group or web ACL where the rule is defined and the label from the rule,\nseparated by a colon.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#LabelNamespace-fn::getatt" } } }, "AWS::WAFv2::WebACL": { "MarkdownDocumentation": "`AWS::WAFv2::WebACL`\n\n###### Note\nThis is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For\ninformation, including how to migrate your AWS WAF resources from the\nprior release, see the [AWS WAF developer guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\nUse an AWS::WAFv2::WebACL to define a collection of rules to use to inspect and\ncontrol web requests. Each rule in a web ACL has a statement that defines what to look for\nin web requests and an action that AWS WAF applies to requests that match\nthe statement. In the web ACL, you assign a default action to take (allow, block) for any\nrequest that doesn't match any of the rules.\nThe rules in a web ACL can be a combination of explicitly defined rules and rule groups\nthat you reference from the web ACL. The rule groups can be rule groups that you manage or\nrule groups that are managed by others.\nYou can associate a web ACL with one or more AWS resources to protect.\nThe resources can be an Amazon CloudFront distribution, an Amazon API Gateway\nREST API, an Application Load Balancer, an AWS AppSync GraphQL API , an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.\nFor more information, see [Web access control lists (web ACLs)](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl.html)\nin the *AWS WAF developer guide*.\n**Web ACLs used in AWS Shield Advanced automatic application\nlayer DDoS mitigation**\nIf you use Shield Advanced automatic application layer DDoS mitigation, the web\nACLs that you use with automatic mitigation have a rule group rule whose name starts with\n`ShieldMitigationRuleGroup`. This rule is used for automatic mitigations and\nit's managed for you in the web ACL by Shield Advanced and AWS WAF. You'll see the rule listed among the web ACL rules when you view the web ACL through\nthe AWS WAF interfaces.\nWhen you manage the web ACL through CloudFormation interfaces, you won't see the\nShield Advanced rule. CloudFormation doesn't include this type of rule in\nthe stack drift status between the actual configuration of the web ACL and your web ACL\ntemplate.\nDon't add the Shield Advanced rule group rule to your web ACL template. The rule\nshouldn't be in your template. When you update the web ACL template in a stack, the Shield Advanced rule is maintained for you by AWS WAF in the resulting\nweb ACL.\nFor more information, see [Shield Advanced\nautomatic application layer DDoS mitigation](https://docs.aws.amazon.com/waf/latest/developerguide/ddos-automatic-app-layer-response.html) in the *AWS Shield Advanced developer guide*.\n", "RefReturnValue": "\nThe `Ref` for the resource, containing the resource name, physical ID, and\nscope, formatted as follows: `name|id|scope`.\nFor example:\n`my-webacl-name|1234a1a-a1b1-12a1-abcd-a123b123456|REGIONAL`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html", "Properties": { "Description": { "MarkdownDocumentation": "`Description`\n\nA description of the web ACL that helps with identification.\n*Required*: No\n*Type*: String\n*Pattern*: `^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-description", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "AssociationConfig": { "MarkdownDocumentation": "`AssociationConfig`\n\nSpecifies custom configurations for the associations between the web ACL and protected resources.\nUse this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can\ncustomize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).\n###### Note\nYou are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [AWS WAF Pricing](https://aws.amazon.com/waf/pricing/).\nFor Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).\n*Required*: No\n*Type*: [AssociationConfig](./aws-properties-wafv2-webacl-associationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-associationconfig", "UpdateType": "Mutable", "Required": false, "Type": "AssociationConfig" }, "ChallengeConfig": { "MarkdownDocumentation": "`ChallengeConfig`\n\nSpecifies how AWS WAF should handle challenge evaluations for rules that\ndon't have their own `ChallengeConfig` settings. If you don't specify this,\nAWS WAF uses its default settings for `ChallengeConfig`.\n*Required*: No\n*Type*: [ChallengeConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-challengeconfig", "UpdateType": "Mutable", "Required": false, "Type": "ChallengeConfig" }, "DataProtectionConfig": { "MarkdownDocumentation": "`DataProtectionConfig`\n\nSpecifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.\nThe data protection that you configure for the web ACL alters the data that's available for any other data collection activity,\nincluding your AWS WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.\n*Required*: No\n*Type*: [DataProtectionConfig](./aws-properties-wafv2-webacl-dataprotectionconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-dataprotectionconfig", "UpdateType": "Mutable", "Required": false, "Type": "DataProtectionConfig" }, "OnSourceDDoSProtectionConfig": { "MarkdownDocumentation": "`OnSourceDDoSProtectionConfig`\n\nConfigures the level of DDoS protection that applies to web ACLs associated with Application Load Balancers.\n*Required*: No\n*Type*: [OnSourceDDoSProtectionConfig](./aws-properties-wafv2-webacl-onsourceddosprotectionconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-onsourceddosprotectionconfig", "UpdateType": "Mutable", "Required": false, "Type": "OnSourceDDoSProtectionConfig" }, "Rules": { "MarkdownDocumentation": "`Rules`\n\nThe rule statements used to identify the web requests that you want to manage. Each rule\nincludes one top-level statement that AWS WAF uses to identify matching web\nrequests, and parameters that govern how AWS WAF handles them.\n*Required*: No\n*Type*: Array of [Rule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-rules", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Rule", "DuplicatesAllowed": true }, "VisibilityConfig": { "MarkdownDocumentation": "`VisibilityConfig`\n\nDefines and enables Amazon CloudWatch metrics and web request sample collection.\n*Required*: Yes\n*Type*: [VisibilityConfig](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-visibilityconfig", "UpdateType": "Mutable", "Required": true, "Type": "VisibilityConfig" }, "Name": { "MarkdownDocumentation": "`Name`\n\nThe 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*Pattern*: `^[0-9A-Za-z_-]{1,128}$`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-name", "UpdateType": "Immutable", "Required": false, "PrimitiveType": "String" }, "TokenDomains": { "MarkdownDocumentation": "`TokenDomains`\n\nSpecifies the domains that AWS WAF should accept in a web request token.\nThis enables the use of tokens across multiple protected websites. When AWS WAF\nprovides a token, it uses the domain of the AWS resource that the web ACL is\nprotecting. If you don't specify a list of token domains, AWS WAF accepts tokens\nonly for the domain of the protected resource. With a token domain list, AWS WAF\naccepts the resource's host domain plus all domains in the token domain list, including\ntheir prefixed subdomains.\n*Required*: No\n*Type*: Array of String\n*Minimum*: `1`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-tokendomains", "UpdateType": "Mutable", "Required": false, "Type": "List", "PrimitiveItemType": "String", "DuplicatesAllowed": true }, "DefaultAction": { "MarkdownDocumentation": "`DefaultAction`\n\nThe action to perform if none of the `Rules` contained in the `WebACL` match.\n*Required*: Yes\n*Type*: [DefaultAction](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-defaultaction", "UpdateType": "Mutable", "Required": true, "Type": "DefaultAction" }, "Scope": { "MarkdownDocumentation": "`Scope`\n\nSpecifies whether this is for an Amazon CloudFront distribution or for a regional\napplication. For an AWS Amplify application, use `CLOUDFRONT`.\nA regional application can be an Application Load Balancer (ALB), an Amazon API Gateway\nREST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool,\nan AWS App Runner service, or an AWS Verified Access instance. Valid Values are\n`CLOUDFRONT` and `REGIONAL`.\n###### Note\nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East (N.\nVirginia) Region, `us-east-1`.\nFor information about how to define the association of the web ACL with your resource,\nsee [AWS::WAFv2::WebACLAssociation](./aws-resource-wafv2-webaclassociation.html).\n*Required*: Yes\n*Type*: String\n*Allowed values*: `CLOUDFRONT | REGIONAL...`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RefReturnValue": "", "AllowedValues": [ "CLOUDFRONT", "REGIONAL" ], "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-scope", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "ApplicationConfig": { "MarkdownDocumentation": "`ApplicationConfig`\n\nReturns a list of `ApplicationAttribute`s.\n*Required*: No\n*Type*: [ApplicationConfig](./aws-properties-wafv2-webacl-applicationconfig.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-applicationconfig", "UpdateType": "Mutable", "Required": false, "Type": "ApplicationConfig" }, "CustomResponseBodies": { "MarkdownDocumentation": "`CustomResponseBodies`\n\nA 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,\nsee [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)\nin the *AWS WAF Developer Guide*.\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)\nin the *AWS WAF Developer Guide*.\n*Required*: No\n*Type*: Object of [CustomResponseBody](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-customresponsebodies", "UpdateType": "Mutable", "Required": false, "Type": "Map", "ItemType": "CustomResponseBody" }, "CaptchaConfig": { "MarkdownDocumentation": "`CaptchaConfig`\n\nSpecifies 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](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-captchaconfig", "UpdateType": "Mutable", "Required": false, "Type": "CaptchaConfig" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nKey:value pairs associated with an AWS resource. The key:value pair can\nbe anything you define. Typically, the tag key represents a category (such as\n\"environment\") and the tag value represents a specific value within that category (such as\n\"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource.\n###### Note\nTo modify tags on existing resources, use the AWS WAF APIs or\ncommand line interface. With AWS CloudFormation, you can only add tags to AWS WAF resources during resource creation.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-wafv2-webacl-tag.html)\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "Capacity": { "PrimitiveType": "Integer", "MarkdownDocumentation": "`Capacity`\n\nThe web ACL capacity units (WCUs) currently being used by this web ACL.\nAWS WAF uses WCUs to calculate and control the operating resources that\nare used to run your rules, rule groups, and web ACLs. AWS WAF calculates\ncapacity differently for each rule type, to reflect the relative cost of each rule. Simple\nrules that cost little to run use fewer WCUs than more complex rules that use more\nprocessing power. Rule group capacity is fixed at creation, which helps users plan their\nweb ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#Capacity-fn::getatt" }, "Id": { "PrimitiveType": "String", "MarkdownDocumentation": "`Id`\n\nThe ID of the web ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#Id-fn::getatt" }, "Arn": { "PrimitiveType": "String", "MarkdownDocumentation": "`Arn`\n\nThe Amazon Resource Name (ARN) of the web ACL.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#Arn-fn::getatt" }, "LabelNamespace": { "PrimitiveType": "String", "MarkdownDocumentation": "`LabelNamespace`\n\nThe label namespace prefix for this web ACL. All labels added by rules in this web ACL\nhave this prefix.\nThe syntax for the label namespace prefix for a web ACL is the following:\n`awswaf::webacl::`\nWhen a rule with a label matches a web request, AWS WAF adds the fully\nqualified label to the request. A fully qualified label is made up of the label namespace\nfrom the rule group or web ACL where the rule is defined and the label from the rule,\nseparated by a colon.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#LabelNamespace-fn::getatt" } } }, "AWS::WAFv2::WebACLAssociation": { "MarkdownDocumentation": "`AWS::WAFv2::WebACLAssociation`\n\n###### Note\nThis is the latest version of **AWS WAF**, named AWS WAFV2, released in November, 2019. For\ninformation, including how to migrate your AWS WAF resources from the\nprior release, see the [AWS WAF developer guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).\nUse a web ACL association to define an association between a web ACL and a regional\napplication resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync\nGraphQL API, an Amazon Cognito user pool, an AWS App Runner service,\nan AWS Amplify application, or an AWS Verified Access instance.\nFor Amazon CloudFront, don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution,\nprovide the Amazon Resource Name (ARN) of the [AWS::WAFv2::WebACL](./aws-resource-wafv2-webacl.html) to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN.\nFor information, see [AWS::CloudFront::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html).\n**Required permissions for customer-managed IAM\npolicies**\nThis call requires permissions that are specific to the protected resource type. For\ndetails, see [Permissions for AssociateWebACL](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-AssociateWebACL) in the *AWS WAF Developer Guide*.\n**Temporary inconsistencies during updates**\nWhen you create or change a web ACL or other AWS WAF resources, the\nchanges take a small amount of time to propagate to all areas where the resources are\nstored. The propagation time can be from a few seconds to a number of minutes.\nThe following are examples of the temporary inconsistencies that you might notice during\nchange propagation:\n* After you create a web ACL, if you try to associate it with a resource, you might\n get an exception indicating that the web ACL is unavailable.\n* After you add a rule group to a web ACL, the new rule group rules might be in\n effect in one area where the web ACL is used and not in another.\n* After you change a rule action setting, you might see the old action in some\n places and the new action in others.\n* After you add an IP address to an IP set that is in use in a blocking rule, the\n new address might be blocked in one area while still allowed in another.\n", "RefReturnValue": "\nThe `Ref` for the resource, containing the resource name, physical ID, and\nscope, formatted as follows: `name|id|scope`.\nFor example:\n`my-webacl-name|1234a1a-a1b1-12a1-abcd-a123b123456|REGIONAL`.\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html", "Properties": { "ResourceArn": { "MarkdownDocumentation": "`ResourceArn`\n\nThe 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:\n `arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id`\n* For an Amazon API Gateway REST API:\n `arn:partition:apigateway:region::/restapis/api-id/stages/stage-name`\n* For an AWS AppSync GraphQL API:\n `arn:partition:appsync:region:account-id:apis/GraphQLApiId`\n* For an Amazon Cognito user pool:\n `arn:partition:cognito-idp:region:account-id:userpool/user-pool-id`\n* For an AWS App Runner service:\n `arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id`\n* For an AWS Verified Access instance:\n `arn:partition:ec2:region:account-id:verified-access-instance/instance-id`\n* For an AWS Amplify instance:\n `arn:partition:amplify:region:account-id:apps/app-id`\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html#cfn-wafv2-webaclassociation-resourcearn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "WebACLArn": { "MarkdownDocumentation": "`WebACLArn`\n\nThe Amazon Resource Name (ARN) of the web ACL that you want to associate with the\nresource.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html#cfn-wafv2-webaclassociation-webaclarn", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::WorkSpaces::Workspace": { "MarkdownDocumentation": "`AWS::WorkSpaces::Workspace`\n\nThe `AWS::WorkSpaces::Workspace` resource specifies a WorkSpace.\nUpdates are not supported for the `BundleId`,\n`RootVolumeEncryptionEnabled`, `UserVolumeEncryptionEnabled`, or\n`VolumeEncryptionKey` properties. To update these properties, you must also\nupdate a property that triggers a replacement, such as the `UserName`\nproperty.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html", "Properties": { "BundleId": { "MarkdownDocumentation": "`BundleId`\n\nThe identifier of the bundle for the WorkSpace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^wsb-[0-9a-z]{8,63}$`\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-bundleid", "PrimitiveType": "String", "Required": true, "UpdateType": "Conditional" }, "DirectoryId": { "MarkdownDocumentation": "`DirectoryId`\n\nThe identifier of the Directory Service directory for the WorkSpace.\n*Required*: Yes\n*Type*: String\n*Pattern*: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)`\n*Minimum*: `10`\n*Maximum*: `65`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-directoryid", "PrimitiveType": "String", "Required": true, "UpdateType": "Conditional" }, "RootVolumeEncryptionEnabled": { "MarkdownDocumentation": "`RootVolumeEncryptionEnabled`\n\nIndicates whether the data stored on the root volume is encrypted.\n*Required*: No\n*Type*: Boolean\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-rootvolumeencryptionenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Conditional" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nThe tags for the WorkSpace.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-workspaces-workspace-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-tags", "DuplicatesAllowed": true, "ItemType": "Tag", "Required": false, "Type": "List", "UpdateType": "Mutable" }, "UserName": { "MarkdownDocumentation": "`UserName`\n\nThe user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `63`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-username", "PrimitiveType": "String", "Required": true, "UpdateType": "Immutable" }, "UserVolumeEncryptionEnabled": { "MarkdownDocumentation": "`UserVolumeEncryptionEnabled`\n\nIndicates whether the data stored on the user volume is encrypted.\n*Required*: No\n*Type*: Boolean\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-uservolumeencryptionenabled", "PrimitiveType": "Boolean", "Required": false, "UpdateType": "Conditional" }, "VolumeEncryptionKey": { "MarkdownDocumentation": "`VolumeEncryptionKey`\n\nThe symmetric AWS KMS key used to encrypt data stored on your WorkSpace.\nAmazon WorkSpaces does not support asymmetric KMS keys.\n*Required*: No\n*Type*: String\n*Update requires*: Updates are not supported.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-volumeencryptionkey", "PrimitiveType": "String", "Required": false, "UpdateType": "Conditional" }, "WorkspaceProperties": { "MarkdownDocumentation": "`WorkspaceProperties`\n\nThe WorkSpace properties.\n*Required*: No\n*Type*: [WorkspaceProperties](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-workspaceproperties", "Required": false, "Type": "WorkspaceProperties", "UpdateType": "Mutable" } } }, "AWS::XRay::Group": { "MarkdownDocumentation": "`AWS::XRay::Group`\n\nUse the `AWS::XRay::Group` resource to specify a group with a name and a filter expression.\nGroups enable the collection of traces that match the filter expression, can be used to filter service graphs and traces, and to supply Amazon CloudWatch metrics.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the group.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html", "Properties": { "GroupName": { "MarkdownDocumentation": "`GroupName`\n\nThe unique case-sensitive name of the group.\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-groupname", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" }, "InsightsConfiguration": { "MarkdownDocumentation": "`InsightsConfiguration`\n\nThe structure containing configurations related to insights.\n* The InsightsEnabled boolean can be set to true to enable insights for the\n group or false to disable insights for the group.\n* The NotificationsEnabled boolean can be set to true to enable insights\n notifications through Amazon EventBridge for the group.\n*Required*: No\n*Type*: [InsightsConfiguration](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-insightsconfiguration", "UpdateType": "Mutable", "Required": false, "Type": "InsightsConfiguration" }, "FilterExpression": { "MarkdownDocumentation": "`FilterExpression`\n\nThe 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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-filterexpression", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "String" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-xray-group-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "GroupARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`GroupARN`\n\nThe group ARN that was created or updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#GroupARN-fn::getatt" } } }, "AWS::XRay::ResourcePolicy": { "MarkdownDocumentation": "`AWS::XRay::ResourcePolicy`\n\nUse `AWS::XRay::ResourcePolicy` to specify an X-Ray resource-based policy,\nwhich grants one or more AWS services and accounts permissions\nto access X-Ray. Each resource-based policy is associated with a\nspecific AWS account.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the policy name.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html", "Properties": { "BypassPolicyLockoutCheck": { "MarkdownDocumentation": "`BypassPolicyLockoutCheck`\n\nA flag to indicate whether to bypass the resource-based policy lockout safety check.\n*Required*: No\n*Type*: Boolean\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-bypasspolicylockoutcheck", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Boolean" }, "PolicyName": { "MarkdownDocumentation": "`PolicyName`\n\nThe name of the resource-based policy. Must be unique within a specific AWS account.\n*Required*: Yes\n*Type*: String\n*Pattern*: `[\\w+=,.@-]+`\n*Minimum*: `1`\n*Maximum*: `128`\n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policyname", "UpdateType": "Immutable", "Required": true, "PrimitiveType": "String" }, "PolicyDocument": { "MarkdownDocumentation": "`PolicyDocument`\n\nThe resource-based policy document, which can be up to 5kb in size.\n*Required*: Yes\n*Type*: String\n*Minimum*: `1`\n*Maximum*: `5120`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policydocument", "UpdateType": "Mutable", "Required": true, "PrimitiveType": "String" } } }, "AWS::XRay::SamplingRule": { "MarkdownDocumentation": "`AWS::XRay::SamplingRule`\n\nUse the `AWS::XRay::SamplingRule` resource to specify a sampling rule, which controls sampling behavior for instrumented applications.\nInclude a `SamplingRule` entity to create or update a sampling rule.\n###### Note\n`SamplingRule.Version` can only be set when creating a sampling rule. Updating the version\nwill cause the update to fail.\nServices retrieve rules with [GetSamplingRules](https://docs.aws.amazon.com//xray/latest/api/API_GetSamplingRules.html), and evaluate each rule in ascending\norder of *priority* for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service\nreports back to X-Ray with [GetSamplingTargets](https://docs.aws.amazon.com//xray/latest/api/API_GetSamplingTargets.html) to get updated versions of\neach in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.\n", "RefReturnValue": "\nWhen you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the sampling rule.\nFor more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).\n", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html", "Properties": { "SamplingRule": { "MarkdownDocumentation": "`SamplingRule`\n\nThe sampling rule to be created or updated.\n*Required*: No\n*Type*: [SamplingRule](./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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-samplingrule", "UpdateType": "Mutable", "Required": false, "Type": "SamplingRule" }, "Tags": { "MarkdownDocumentation": "`Tags`\n\nAn array of key-value pairs to apply to this resource.\n*Required*: No\n*Type*: Array of [Tag](./aws-properties-xray-samplingrule-tag.html)\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#cfn-xray-samplingrule-tags", "UpdateType": "Mutable", "Required": false, "Type": "List", "ItemType": "Tag", "DuplicatesAllowed": true } }, "Attributes": { "RuleARN": { "PrimitiveType": "String", "MarkdownDocumentation": "`RuleARN`\n\nThe sampling rule ARN that was created or updated.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.html#RuleARN-fn::getatt" } } }, "AWS::XRay::TransactionSearchConfig": { "MarkdownDocumentation": "`AWS::XRay::TransactionSearchConfig`\n\nThe `AWS::XRay::TransactionSearchConfig` resource Property description not available. for XRay.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-transactionsearchconfig.html", "Properties": { "IndexingPercentage": { "MarkdownDocumentation": "`IndexingPercentage`\n\nProperty description not available.\n*Required*: No\n*Type*: Number\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)\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-transactionsearchconfig.html#cfn-xray-transactionsearchconfig-indexingpercentage", "UpdateType": "Mutable", "Required": false, "PrimitiveType": "Double" } }, "Attributes": { "AccountId": { "PrimitiveType": "String", "MarkdownDocumentation": "`AccountId`\n\nProperty description not available.\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-transactionsearchconfig.html#AccountId-fn::getatt" } } }, "Alexa::ASK::Skill": { "MarkdownDocumentation": "`Alexa::ASK::Skill`\n\nThe `Alexa::ASK::Skill` resource creates an Alexa skill that enables\ncustomers to access new abilities. For more information about developing a skill, see\nthe [Build Skills with the Alexa Skills Kit developer documentation](https://developer.amazon.com/docs/ask-overviews/build-skills-with-the-alexa-skills-kit.html).\n", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html", "Properties": { "AuthenticationConfiguration": { "Type": "AuthenticationConfiguration", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-authenticationconfiguration", "UpdateType": "Mutable" }, "VendorId": { "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-vendorid", "PrimitiveType": "String", "UpdateType": "Immutable" }, "SkillPackage": { "Type": "SkillPackage", "Required": true, "MarkdownDocumentation": "", "RefReturnValue": "", "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-skillpackage", "UpdateType": "Mutable" } } } }, "ResourceSpecificationVersion": "229.0.0", "parse_success_ratio": 0.9706 }